HowTo
Create headers
On a regular base add an appropriate header.
| Style element | Syntax |
|---|---|
| Headers | == header 2 == |
| === header 3 === | |
| ==== header 4 ==== |
Make sure you always use the headers in this order, e.g. header 2, followed by header 3 and 4 if necessary.
Create lists
| Style element | Syntax | Shows as |
|---|---|---|
| Bulleted list | * bullet 1 * bullet 2 ** nested bullet |
|
| Ordered list | # first item #second item ## nested item ##* nested bullet |
|
Close an item with a ; when short, and with a . when a full sentence. In the latter case start with a capital.
Create footnotes
Surround a footnote with <ref> ''footnote text'' </ref> tags and add a <references/> tag at the end of the page . The footnote text between the ref tags will be displayed there. Footnote reference and footnote link to each other.
Create/Edit references
There are two ways of displaying all the references in the wiki.
- In Overviews => 'All references' you can find all references in a table form.
- In Browse data => 'Browse the IMAGE model' has a list of references with filter options.
You can navigate to a reference by clicking on the reference and then edit it by clicking on the edit-tab in the wiki-bar.
If you want to add a new reference, use Useful forms =>'Add references'. In this entry to the reference-form you need to provide a name. This name has the following convention:
- One author: <author name>, <space><year>
- Two authors: <author name> and <author name>, <space><year>
- More authors: <first author name> et al., <space><year>
Create an acronym
For each page: Link the first occurrence of an acronym in your text, e.g OECD, to its description by writing OECD as follows: [[HasAcronym::OECD]]. If the acronym already exists the link will take you to the description, otherwise clicking the red link (that will appear on the page after saving) will take you to the acronym form. Here you can enter the description.
Only the first occurrence of an acronym on a page needs to be linked to its description.
Add formulas
Each formula is named as follows: Formula<number>_<Component code>. In this name the <number> is the same as the number of the formula used in the chapter. You can look up the component code in the component code overview: Help => Component code overview.
Remove the number of your formula in the text and insert the following: {{FormulaTemplate|<Formula name>}}
Add a figure
All flowcharts, baseline figures, policy intervention figures have been uploaded and are already annotated. For additional figures do the following: On the menu bar click Useful forms=>Add figure. This will open an entry to the figure form. Give the figure page a meaningful name and go to the form.
Add tables
Avoid tables! They are cumbersome and most likely too detailed. Do not use them to layout your text, it is against the accessability guidelines and most of the the time there is an alternative solution for the problem. In case of a data table which is necessary for the text, consider a picture of this data table.
For detailed info see: http://www.mediawiki.org/wiki/Help:Tables
Link to references
Put the reference, for example (Stehfest et al., 2012) in between two square brackets, like: ( [[ Stehfest et al., 2012 ]] ) . If a red link appears, go to Browse data => 'Browse the IMAGE model' and search for the right reference. Use this new citation name to put in the brackets.
Link to chapters
Search for the corresponding component-page by going to Overview => Conceptual framework components. Use this page-name instead of the chapter-name and put in two square brackets, like: [[ Energy Conversion ]] .
Dealing with in text reference to figures
Replace the figure code, such as 'Figure 4.1.1.1' to a descriptive name, for example:
- see the flowchart on the right
- see the figure on the left
When dealing with [samengevoegde] figures, indicate the position by number.
Edit an input-parameter
Click on the parameter name in the left column of the table. Go to Edit-tab on the wiki-bar of the parameter page. Fill in/check all fields of this form except 'Dimension' and 'Label'.
Edit an output-variable
Click on the variable name in the left column of the table. Go to Edit-tab on the wiki-bar of the variable page. Fill in/check all fields of this form except 'Dimension' and 'Label'.