Naming conventions
Jump to navigation
Jump to search
General
- Capitalise only the first word of a title/header/type/component, e.g. Computer models and not Computer Models
- Use British English spelling (check! we use the s instead of z in words like organisation (UK), but color (US) instead of colour)
Page names for system pages: Categories, Templates, Properties, Forms
Use CamelCase and no spaces in all 'system' pages. End names for Templates and Forms with 'Template' , 'Form' respectively.
- Templates: name should end with Template. Templates for category pages should be named after the category. Give other templates a functional name, e.g. include Style, View, Test, etc.
- Forms: name should end with Form. Forms for category pages should be named after the category.
- Properties: use the Has... and Is... etc convention. Be specific.
- Categories: try to find a meaningful name for the type of pages for this category. The structure is based on categories and users use Categories to navigate (e.g. Browse data)
Page names for content pages: Namespace Main
- Put spaces between words
- Only capitalise the first word, e.g 'Energy demand' and not EnergyDemand
Overviews
- In the drop down menu of 'Overviews' only write the name of the overview, e.g. 'Overviews => Computer models' and not 'Overviews => Computer models overview'.
- On the overview page itself, add 'overviews' at the end of the page name, e.g. 'Computer models overview' and not 'Overview computer models'
Models
Computer models should have 'model' behind the name, e.g. 'FAIR' becomes 'FAIR model'.
Applications
The applications should start with the abbreviation, then the full name, then the year in parentheses. For example: GEO3 Global Environmental Outlook (2003)
Figures
- Flowchart
Flowchart <component code>
- Baseline figure
Baseline figure <component code>
- Policy intervention figure
Policy intervention figure <component code>
- Driver figure
Driver figure <component code>
- Other
<meaningfull name> <component code>
Databases
Databases should have 'database' behind the name, e.g. FAOSTAT' becomes 'FAOSTAT database'.
References
- Auteur name conventions in the bibliography:
- < Last name>,<space><Initials> (e.g. 'John Mark McCartney' becomes 'McCartney, J.M.')
- < last name preposition><space><Last name>, <space><Initials> (e.g. 'Jan van Egmond' becomes 'van Egmond, J.')
- < Institution name abbreviation> (e.g. UNEP, not United Nations Environment Programme)
- Publisher:
- < Publisher >
- < Fullname of Institution >
- Inline citations:
- One author: <Author name>, <space><year>
- Two authors: <Author name> and <author name>, <space><year>
- More authors: <First author name> et al., <space><year>
Where <Author name> is the Last name of the author and starts with a capital, regardless if it is preposition :
- <Author name> = <Capitalised last name> (e.g. Boer)
- <Author name> = <Capitalised preposition> <space> <uncapitalised last name> (e.g. Van gogh)
Variables
- Drivers are external model variables that are used for the core models.
- Parameters are variables that are rather static and mostly used as input for one model component.
- Model variables are variables that are calculated by a model or impact component and are used as input for another model component.
- Model variables, end-indicator are variables that are calculated by a model or impact component and are final output.
- External model variables are variables that originates from external models (or databases) and are mostly used in the impact components.
- Historical variables are variables that are historical, such as 'Wet days'
Table headers
- Variable
- Is used in / Is output of (not: used in, output of)
- Description
Units
- Energie en vermogen: alles in J en W, uiteraard met standaard prefixes M, G, P, EJ en k, M, G, TW (NB: let op hoofd/kleine letters bij die prefixes)
- Inkomen en afgeleide intensiteiten: € of $, met suffix voor het bijbehorende jaar en de toevoeging ppp of mer waar relevant; €/cap of € per capita?;
- Landcover en landgebruik: million km2 of M km2
- Yields en land-inputs: ton/ha en kg/ha
- Emissiefactoren: afhankelijk van de driver in de noemer: g of kg of ton / eenheid driver. Dat laatste kan van alles zijn: een MJ of GJ energiedrager, een ha land, een ton product, een koe, etc.
- Emissies: kton, Mton of Gton
- Consumptie/productie voedsel: million ton of Mton totaal en kg/cap, ton/cap of ton per capita?. Waar van toepassing kan ook: g/day per capita (bijv. eiwit of vetten consumptie) en kcal/day per capita.
- C of CO2 en C of CO2-equivalent emissies: als je vooral denkt in termen van de atmosfeer dan is CO2 logisch en gangbaar, denk je aan bomen en bodems dan juist C. Ik stel voor om niet te kiezen, maar voor emissies naar de lucht altijd CO2 (-equivalent) te gebruiken. En alleen C gebruiken als het gaat het om stocks en fluxen van biomassa, bodems en oceanen Dus ook voor NPP en NEP?.