Author guidelines - Revision history

Rineke Oostenrijk at 15:21, 17 November 2021

2021-11-17T15:21:52Z

← Older revision		Revision as of 17:21, 17 November 2021
Line 197:		Line 197:
	==Input reference card==		==Input reference card==

	The reference card can be filled- in through the following [[Reference_card_input\|link]], The result of this action are the reference card - <model> pages displayed on the left panel. Each field in the reference card has a specific id and to compare models input data you can use the [[~~Special:RunQuery/Model_Feature_Compare_Form\|~~Model comparison]] tool. A selection of the reference card information is displayed on your model documentation pages in the right panel and in the table on the [[IAMC_wiki\|IAMC Wiki]] introduction page.		The reference card can be filled- in through the following [[Reference_card_input\|link]], The result of this action are the reference card - <model> pages displayed on the left panel. Each field in the reference card has a specific id and to compare models input data you can use the [[Model comparison]] tool. A selection of the reference card information is displayed on your model documentation pages in the right panel and in the table on the [[IAMC_wiki\|IAMC Wiki]] introduction page.

	==Citation Management==		==Citation Management==

Rineke Oostenrijk: /* Visual editor */

2020-05-13T08:59:36Z

Visual editor

← Older revision		Revision as of 10:59, 13 May 2020
Line 11:		Line 11:
	=== Visual editor ===		=== Visual editor ===
	This is a so called ''what you see is what you get'' (WYSIWYG) editor. After clicking the ''edit'' tab on top of the page the editor loads the page content and displays your text in final format as well as generated text. Generated text consists of the ' ''infobox'' ' template and if applicable the' ''not yet published'' ' warning template on top of the page. '''Don't edit these template texts!'''		This is a so called ''what you see is what you get'' (WYSIWYG) editor. After clicking the ''edit'' tab on top of the page the editor loads the page content and displays your text in final format as well as generated text. Generated text consists of the ' ''infobox'' ' template and if applicable the' ''not yet published'' ' warning template on top of the page. '''Don't edit these template texts!'''
	* '''First edit'': '''''If the documentation page is new then start editing by moving the mouse alongside the l''<nowiki/>''eft margin from the title down. The mouse cursor will change into a hand and the text '+ insert paragraph' will appear on the first and the third line. Left mouse click on the third line - the cursor should change into a blinking pipe - then start typing. The new paragraph should be '''below''' the ''<nowiki/>'not yet published'' ' warning box on top of the page.		* '''First edit'': '''''If the documentation page is new then start editing by moving the mouse alongside the l''<nowiki/>''eft margin from the title down. The mouse cursor will change into a hand and the text '<nowiki/>''+ insert paragraph''<nowiki/>' will appear on the first and the third line. Left mouse click on the third line - the cursor should change into a blinking pipe - then start typing. The new paragraph should be '''below''' the ''<nowiki/>'not yet published'' ' warning box on top of the page.
	* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.		* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.
	* '''Styling and edit functions''': You can enter text and format the style with the functions in the toolbar at the top of the page.		* '''Styling and edit functions''': You can enter text and format the style with the functions in the toolbar at the top of the page.

Rineke Oostenrijk: /* Visual editor */

2020-05-13T08:58:41Z

Visual editor

← Older revision		Revision as of 10:58, 13 May 2020
Line 10:		Line 10:

	=== Visual editor ===		=== Visual editor ===
	This is a so called ''what you see is what you get'' (WYSIWYG) editor. ~~The~~ editor loads the page content and displays your text in final format as well as generated text. Generated text consists of the ' ''infobox'' ' template and if applicable the' ''not yet published'' ' warning template on top of the page. '''Don't edit these template texts!'''		This is a so called ''what you see is what you get'' (WYSIWYG) editor. After clicking the ''edit'' tab on top of the page the editor loads the page content and displays your text in final format as well as generated text. Generated text consists of the ' ''infobox'' ' template and if applicable the' ''not yet published'' ' warning template on top of the page. '''Don't edit these template texts!'''
	* '''First edit'': '''''If the documentation page is new then start editing by ~~inserting~~ a paragraph '''below''' the ''<nowiki/>'not yet published'' ' warning box on top of the page~~, just place the cursor below the box~~.		* '''First edit'': '''''If the documentation page is new then start editing by moving the mouse alongside the l''<nowiki/>''eft margin from the title down. The mouse cursor will change into a hand and the text '+ insert paragraph' will appear on the first and the third line. Left mouse click on the third line - the cursor should change into a blinking pipe - then start typing. The new paragraph should be '''below''' the ''<nowiki/>'not yet published'' ' warning box on top of the page.
	* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.		* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.
	* '''Styling and edit functions''': You can enter text and format the style with the functions in the toolbar at the top of the page.		* '''Styling and edit functions''': You can enter text and format the style with the functions in the toolbar at the top of the page.

Rineke Oostenrijk: /* Visual editor */

2020-05-13T08:47:35Z

Visual editor

← Older revision		Revision as of 10:47, 13 May 2020
Line 11:		Line 11:
	=== Visual editor ===		=== Visual editor ===
	This is a so called ''what you see is what you get'' (WYSIWYG) editor. The editor loads the page content and displays your text in final format as well as generated text. Generated text consists of the ' ''infobox'' ' template and if applicable the' ''not yet published'' ' warning template on top of the page. '''Don't edit these template texts!'''		This is a so called ''what you see is what you get'' (WYSIWYG) editor. The editor loads the page content and displays your text in final format as well as generated text. Generated text consists of the ' ''infobox'' ' template and if applicable the' ''not yet published'' ' warning template on top of the page. '''Don't edit these template texts!'''
			* '''First edit'': '''''If the documentation page is new then start editing by inserting a paragraph '''below''' the ''<nowiki/>'not yet published'' ' warning box on top of the page, just place the cursor below the box.
	* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.		* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.
	* '''First edit'': '''''If the documentation page is new then start editing by inserting a paragraph '''below''' the ''<nowiki/>'not yet published'' ' warning box on top of the page, just place the cursor below the box.
	* '''Styling and edit functions''': You can enter text and format the style with the functions in the toolbar at the top of the page.		* '''Styling and edit functions''': You can enter text and format the style with the functions in the toolbar at the top of the page.
	* '''Word copy''': Text and tables from a Word document can be copied and paste directly, style and table definitions will be preserved.		* '''Word copy''': Text and tables from a Word document can be copied and paste directly, style and table definitions will be preserved.

Rineke Oostenrijk at 08:20, 13 May 2020

2020-05-13T08:20:12Z

← Older revision		Revision as of 10:20, 13 May 2020
Line 12:		Line 12:
	This is a so called ''what you see is what you get'' (WYSIWYG) editor. The editor loads the page content and displays your text in final format as well as generated text. Generated text consists of the ' ''infobox'' ' template and if applicable the' ''not yet published'' ' warning template on top of the page. '''Don't edit these template texts!'''		This is a so called ''what you see is what you get'' (WYSIWYG) editor. The editor loads the page content and displays your text in final format as well as generated text. Generated text consists of the ' ''infobox'' ' template and if applicable the' ''not yet published'' ' warning template on top of the page. '''Don't edit these template texts!'''
	* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.		* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.
	* '''First edit''': If the documentation page is new then start editing by inserting a paragraph '''below''' the '''not yet published'' ' warning box on top of the page, just place the cursor below the box.		* '''First edit'': '''''If the documentation page is new then start editing by inserting a paragraph '''below''' the ''<nowiki/>'not yet published'' ' warning box on top of the page, just place the cursor below the box.
	* '''Styling and edit functions''': You can enter text and format the style with the functions in the toolbar at the top of the page.		* '''Styling and edit functions''': You can enter text and format the style with the functions in the toolbar at the top of the page.
	* '''Word copy''': Text and tables from a Word document can be copied and paste directly, style and table definitions will be preserved.		* '''Word copy''': Text and tables from a Word document can be copied and paste directly, style and table definitions will be preserved.

Rineke Oostenrijk: /* Edit text */

2020-05-13T08:18:40Z

Edit text

← Older revision		Revision as of 10:18, 13 May 2020
Line 12:		Line 12:
	This is a so called ''what you see is what you get'' (WYSIWYG) editor. The editor loads the page content and displays your text in final format as well as generated text. Generated text consists of the ' ''infobox'' ' template and if applicable the' ''not yet published'' ' warning template on top of the page. '''Don't edit these template texts!'''		This is a so called ''what you see is what you get'' (WYSIWYG) editor. The editor loads the page content and displays your text in final format as well as generated text. Generated text consists of the ' ''infobox'' ' template and if applicable the' ''not yet published'' ' warning template on top of the page. '''Don't edit these template texts!'''
	* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.		* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.
	* '''First edit'''; If the documentation page is new then start editing by inserting a paragraph '''below''' the '''not yet published'' ' ~~warnong~~ box on top of the page, just place the cursor below the box.		* '''First edit''': If the documentation page is new then start editing by inserting a paragraph '''below''' the '''not yet published'' ' warning box on top of the page, just place the cursor below the box.
	* '''Styling and edit functions''': You can enter text and format the style with the functions in the toolbar at the top of the page.		* '''Styling and edit functions''': You can enter text and format the style with the functions in the toolbar at the top of the page.
	* '''Word copy''': Text and tables from a Word document can be copied and paste directly, style and table definitions will be preserved.		* '''Word copy''': Text and tables from a Word document can be copied and paste directly, style and table definitions will be preserved.

Rineke Oostenrijk: /* Visual editor */

2020-05-12T09:32:07Z

Visual editor

← Older revision		Revision as of 11:32, 12 May 2020
Line 10:		Line 10:

	=== Visual editor ===		=== Visual editor ===
	This is a so called ''what you see is what you get'' (WYSIWYG) editor. The editor loads the page content and displays your text in final format as well as generated text. Generated text consists of the ' ''infobox'' ' template and if applicable the' ''not yet published'' ' warning template on top of ~~teh~~ page. '''Don't edit these template texts!'''		This is a so called ''what you see is what you get'' (WYSIWYG) editor. The editor loads the page content and displays your text in final format as well as generated text. Generated text consists of the ' ''infobox'' ' template and if applicable the' ''not yet published'' ' warning template on top of the page. '''Don't edit these template texts!'''
	* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.		* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.
	* '''First edit'''; If the documentation page is new then start editing by inserting a paragraph '''below''' the '''not yet published'' ' warnong box on top of the page, just place the cursor below the box.		* '''First edit'''; If the documentation page is new then start editing by inserting a paragraph '''below''' the '''not yet published'' ' warnong box on top of the page, just place the cursor below the box.

Rineke Oostenrijk: /* Visual editor */

2020-05-12T09:31:25Z

Visual editor

← Older revision		Revision as of 11:31, 12 May 2020
Line 10:		Line 10:

	=== Visual editor ===		=== Visual editor ===
	This is a ~~socalled~~ ''what you see is what you get'' (WYSIWYG) editor. The editor loads the page content and displays generated text ~~such as~~ the ' ''infobox'' ' and ' ''not yet published'' ' warning. '''Don't edit these template texts!'''		This is a so called ''what you see is what you get'' (WYSIWYG) editor. The editor loads the page content and displays your text in final format as well as generated text. Generated text consists of the ' ''infobox'' ' template and if applicable the' ''not yet published'' ' warning template on top of teh page. '''Don't edit these template texts!'''
	* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.		* '''Help''': An extensive help function is available at the [[mediawikiwiki:Help:VisualEditor/User_guide\|user guide]] of the Visual editor.
	* '''First edit'''; If the documentation page is new then start editing by inserting a paragraph '''below''' the '~~Warning~~' box, just place the cursor below the box.		* '''First edit'''; If the documentation page is new then start editing by inserting a paragraph '''below''' the '''not yet published'' ' warnong box on top of the page, just place the cursor below the box.
	* '''Styling and edit functions''': You can enter text and format the style with the functions in the toolbar at the top of the page.		* '''Styling and edit functions''': You can enter text and format the style with the functions in the toolbar at the top of the page.
	* '''Word copy''': Text and tables from a Word document can be copied and paste directly, style and table definitions will be preserved.		* '''Word copy''': Text and tables from a Word document can be copied and paste directly, style and table definitions will be preserved.
Line 22:		Line 22:
	More tips and tricks on text editing can be found through the following Wiki help pages:		More tips and tricks on text editing can be found through the following Wiki help pages:
	* [https://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup help page to format text]		* [https://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup help page to format text]
	* [https://www.mediawiki.org/wiki/Help:Lists Creating lists through ~~bulletpoints~~ or headings]		* [https://www.mediawiki.org/wiki/Help:Lists Creating lists through bullet points or headings]
	* [https://en.wikipedia.org/wiki/Help:Cheatsheet ~~Cheatsheet~~ containing some basic commands]		* [https://en.wikipedia.org/wiki/Help:Cheatsheet Cheat sheet containing some basic commands]
	* [https://www.mediawiki.org/wiki/Help:Links Overview of different types of way to place a link]		* [https://www.mediawiki.org/wiki/Help:Links Overview of different types of way to place a link]

Line 201:		Line 201:
	==Citation Management==		==Citation Management==

	To place a reference to journal paper, book or other literature in your text the following steps need do be performed:		To place a reference to journal paper, book or other literature in your text the following steps need do be performed in the '''wiki-editor''' (''edit source'').

	# Look up references in a format that can be recognized by the semantic cite extention that we use in this platform. More information about semantic cite can be found [https://www.semantic-mediawiki.org/wiki/Extension:Semantic_Cite here]. There are two easy options:		# Look up references in a format that can be recognized by the semantic cite extention that we use in this platform. More information about semantic cite can be found [https://www.semantic-mediawiki.org/wiki/Extension:Semantic_Cite here]. There are two easy options:
Line 257:		Line 257:
	# The page is not in the main branch of the documentation tree (Model scope and methods;Socio-economic drivers; Macro-economy; Energy; Land-use; Emissions; Climate; Non-climate sustainability dimension; Appendices; References)		# The page is not in the main branch of the documentation tree (Model scope and methods;Socio-economic drivers; Macro-economy; Energy; Land-use; Emissions; Climate; Non-climate sustainability dimension; Appendices; References)
	# The page is a leaf in the documentation tree and not a node.		# The page is a leaf in the documentation tree and not a node.
			The menu option More=>Delete will delete the page after confirmation.

	You can recreate a page via Editor tools=>[[Model setup \|Model pages setup]]. '''Do not use Internet explorer for this action!'''.		You can recreate a page via Editor tools=>[[Model setup \|Model pages setup]]. '''Do not use Internet explorer for this action!'''.
Line 271:		Line 272:

	==Troubleshooting==		==Troubleshooting==
	If you have come across issues during the editing process that you have solved, please describe your solutions here.		If you have come across issues during the editing process that you have solved, please describe your solutions here. If you are not able to solve your problem, then contact us via an email to [mailto://iamc@pbl.nl iamc@pbl.nl]

	===Overlap of figure and Model documentation box===		===Overlap of figure and Model documentation box===
	To force the placement of a figure beneath the Model Documentation box add the following line in your text:		To force the placement of a figure beneath the Model Documentation box add the following line in your text:
	<~~pre~~><div style="clear:both"> </div></~~pre~~>
			<code><nowiki><div style="clear:both"> </div></nowiki></code>

	===Citation not displayed correctly===		===Citation not displayed correctly===
Line 285:		Line 287:
	===Forced spacings===		===Forced spacings===

	In some model documentation pages originally the paragraphs were forced by using the <~~pre~~><br></br></~~pre~~> ~~commands~~. These are recognized by the current Media Wiki, however results in sometimes strange display of the text. Please remove ~~the~~ these statements and if you want to seperate paragraphs just use the enter key.		In some model documentation pages originally the paragraphs were forced by using the tags

			<code><nowiki><br></nowiki><nowiki></br></nowiki></code>

			visible in the wiki-editor. These are recognized by the current Media Wiki, however results in sometimes strange display of the text. Please remove these statements and if you want to seperate paragraphs just use the enter key.

	===Copying of Tables===		===Copying of Tables===

Mathijs Harmsen at 17:30, 7 May 2020

2020-05-07T17:30:17Z

← Older revision		Revision as of 19:30, 7 May 2020
Line 67:		Line 67:
	Tables may be created by using copy/paste from Word or by using the Toolbar => Insert => Table function. A pasted table does not copy the styling, except bold and italic. You can adapt a table by clicking on a cell. An arrow sign will appear. Click this sign and column /row edit functions will popup. Double click on a cell to edit the content.		Tables may be created by using copy/paste from Word or by using the Toolbar => Insert => Table function. A pasted table does not copy the styling, except bold and italic. You can adapt a table by clicking on a cell. An arrow sign will appear. Click this sign and column /row edit functions will popup. Double click on a cell to edit the content.

	Clicking on a cell also gives access to the Table => Properties dialog, where you can give your table a caption; give it the wikitable style; make it sortable and/or make it collapsible. On this platform we use the wikitable styling. The table below has ~~set~~ all the mentioned properties.		Clicking on a cell also gives access to the Table => Properties dialog, where you can give your table a caption; give it the wikitable style; make it sortable and/or make it collapsible. On this platform we use the wikitable styling. The table below has all the mentioned properties set.

	{\| class="wikitable sortable mw-collapsible"		{\| class="wikitable sortable mw-collapsible"
Line 86:		Line 86:
	\|four		\|four
	\|}		\|}
	For tables we also use cross references to number the tables on the page, and link to the table in text. In order to do so the tables must have a table id and a caption - similar to the figure cross references. <!-- COLUMN HEADINGS -->		For tables we also use cross references to number the tables on the page, and to link to the table in text. In order to do so, the tables must have a table id and a caption - similar to the figure cross references. <!-- COLUMN HEADINGS -->

	Note that the cross reference only works if the table has a caption. To refer in the text to the table you can place a link to the tables id. Here it is important that the id is unique. See the section about cross referencing.<!-- COLUMN HEADINGS -->		Note that the cross reference only works if the table has a caption. To refer in the text to the table you can place a link to the tables id. Here it is important that the id is unique. See the section about cross referencing.<!-- COLUMN HEADINGS -->
Line 197:		Line 197:
	==Input reference card==		==Input reference card==

	The reference card can be filled in through the following [[Reference_card_input\|link]], The result of this action are the reference card - <model> pages displayed on the left panel. Each field in the reference card has a specific id and to compare models input data you can use the [[Special:RunQuery/Model_Feature_Compare_Form\|Model comparison]] tool. A selection of the reference card information is displayed on your model documentation pages in the right panel and in the table on the [[IAMC_wiki\|IAMC Wiki]] introduction page.		The reference card can be filled- in through the following [[Reference_card_input\|link]], The result of this action are the reference card - <model> pages displayed on the left panel. Each field in the reference card has a specific id and to compare models input data you can use the [[Special:RunQuery/Model_Feature_Compare_Form\|Model comparison]] tool. A selection of the reference card information is displayed on your model documentation pages in the right panel and in the table on the [[IAMC_wiki\|IAMC Wiki]] introduction page.

	==Citation Management==		==Citation Management==
Line 207:		Line 207:
	#* Collect reference information in bibtext format.		#* Collect reference information in bibtext format.

	Here is an example of ~~how~~ this could look like:		Here is an example of what this could look like:
	<pre>		<pre>
	{{#scite:		{{#scite:
Line 250:		Line 250:
	More information of the Citation Manager can be found [https://github.com/SemanticMediaWiki/SemanticCite/tree/master/docs here]		More information of the Citation Manager can be found [https://github.com/SemanticMediaWiki/SemanticCite/tree/master/docs here]

	==Empty documentation pages, deletion and ~~recreation~~==		==Empty documentation pages, deletion and re-creation==

	In order to facilitate model comparability, the sections and sub-sections are standardized for all models, and therefore all models need to be documented within a similar set of sections (the sections are presented in the table of contents in the text box on the right-hand side of each model page). Not all models have the same scope, and therefore not all pages will be filled by all models.		In order to facilitate model comparability, the sections and sub-sections are standardized for all models, and therefore all models need to be documented within a similar set of sections (the sections are presented in the table of contents in the text box on the right-hand side of each model page). Not all models have the same scope, and therefore not all pages will be filled by all models.

Mathijs Harmsen at 17:10, 7 May 2020

2020-05-07T17:10:44Z

← Older revision		Revision as of 19:10, 7 May 2020
Line 26:		Line 26:
	* [https://www.mediawiki.org/wiki/Help:Links Overview of different types of way to place a link]		* [https://www.mediawiki.org/wiki/Help:Links Overview of different types of way to place a link]

	==Footnotes==		==Footnotes==

	Footnotes can be added to the text in the Visual editor (''edit'' tab). Type the footnote text in the text field or reuse an existing footnote. In this example a group is used.		Footnotes can be added to the text in the Visual editor (''edit'' -> ''cite'' tab). Type the footnote text in the text field or reuse an existing footnote. In this example a group is used.

	{\| style="border:none; text-align:left; padding:0.3em;"		{\| style="border:none; text-align:left; padding:0.3em;"
	\|-<!-- COLUMN HEADINGS -->		\|-<!-- COLUMN HEADINGS -->
	\| style="background:#E6F2FF; padding:0.3em; text-align:center;" \|'''~~You~~ click and enter'''		\| style="background:#E6F2FF; padding:0.3em; text-align:center;" \|Y'''ou click and enter'''
	\| style="background:#E6F2FF; padding:0.3em; text-align:center;" \|'''You get'''		\| style="background:#E6F2FF; padding:0.3em; text-align:center;" \|'''You get'''
	\|-		\|-