Author guidelines: Difference between revisions

From IAMC-Documentation
Jump to navigation Jump to search
No edit summary
No edit summary
Line 37: Line 37:
|-<!-- 5TH ROW -->
|-<!-- 5TH ROW -->
|
|
<tt><nowiki>===header===</nowiki></tt>
<tt><nowiki>Text before
----
Text after</nowiki></tt>
|
|
===header===
Text before
----
Text after
|-<!-- 6TH ROW -->
|-<!-- 6TH ROW -->
|
|

Revision as of 14:36, 28 July 2016

Edit text

To insert or edit text use the Edit or Edit with form tabs on the top of the page. To see how your edits are displayed save the page and navigate back the read tab.

The edit tab contains some build in functions to format text, such as style or linking to internal or external webpages.

More tips and tricks on text editing can be found through the following wiki help pages:

A few basic examples to get started are:

You type You get
''italic'' italic

'''bold'''

bold

'''''bold italic'''''

bold italic

SO<sub>4</sub><sup>2-</sup>

SO42-

Text before ---- Text after

Text before


Text after

*bullet

  • bullet

[[Model_Documentation_-_IMAGE|Model_Documentation of IMAGE]]

Model_Documentation of IMAGE

header

Headings are created using sequences of "=" characters, placed before the heading title and after the heading title, on the same line. The level of headings is determined by the number of "=" characters.

Examples:


Level Example
2. ==Plants==
3. ===Plants===
4. ====Plants====


Citation Management

To add a reference to journal paper, book or other literature to your text the following steps need do be performed:

  1. Look up references in format that can be recognized by the Semantic Cit extention that we use in this platform. More information about semantic cite can be found here. There are two easy options:
    • Use the Citation Websearch function in the left panel.
    • Collect reference information in bibtext format

Here is an example of how this could look like:

REF.PNG

  1. The first line, folowing |references=, indicates the key of the reference, to which you can refer to in your text. It is important you specify a key that is unique. For example by starting the key with your model name
  2. The second line, following |type=, indicates the type of reference. In this wiki we have specified 5 reference types, namely journal, book, report, bookchapter and website. If your reference does not fall under one of these categroziation you can specify yourself how the reference is displayed, by adding an extra line with |citation text=
  3. Add the collected reference description to the reference page of your model, for example the reference of IMAGE
  4. Add the reference key to the top row of the page after |references=. This will display your reference on the References page.
  5. Insert the key in text of the model documentation page where you insert the reference by using [[CiteRef::Referencekey]].

The reference is indicated by a footnote, for example typing [[CiteRef::van vuuren2013a]] is displayed as van vuuren2013a.

More information of the Citation Manager can be found here

Figures

  1. Upload figure by using the upload file link on the left side
  2. In the text you can refer to the figure by linking to the File page e.g. [[File:Desert.png|800px|thumb|Desert]]
  3. In this platform we use the thumb option to display the Figures caption

More information on Figure formatting can be found here

Tables

More information on Table formatting can be found here

Equations

We use a latex style equation writer. Equations can be inserted in the text as followed:

<math style="font-size: 1.5em;"> \dfrac{k}{k-1} = 0.5</math>

More information on formatting equations can be found here


Cross Reference

Model Information

Model information can be filled in through the following form.



Note

Wikitext contains all the features required to follow Wikipedia's formatting conventions. However, its formatting capabilities are limited. If you want to have more control of the formatting, such as using colors, text and paragraph styles, and page layout you can use HTML. HTML is the language used to format web pages in the Internet. It is more powerful than wikitext, but it's also more complex and harder to use.