Wiki development: Difference between revisions

From Norcpm
No edit summary
No edit summary
Line 32: Line 32:
* ''Internal link to a page'': To link to another page use double [ ] around the name of the page. Optionally, you can specify an alternative link title by adding | followed by the alternative text.   
* ''Internal link to a page'': To link to another page use double [ ] around the name of the page. Optionally, you can specify an alternative link title by adding | followed by the alternative text.   
* ''Internal link to a section'': As above, but after the page name add # followed by the name of the section. For example <pre> [[NorCPM User Manual - beta#Running the model|Instructions for running NorCPM]]</pre>   
* ''Internal link to a section'': As above, but after the page name add # followed by the name of the section. For example <pre> [[NorCPM User Manual - beta#Running the model|Instructions for running NorCPM]]</pre>   
* ''External link'': To link to an external page use double [ ] around the URL of the external page. Optionally, you can specify an alternative link title by adding | followed by the alternative text. For example <pre>[https://wiki.met.no/noresm/start NorESM wiki|NorESM wiki]</pre>   
* ''External link'': To link to an external page use single [ ] around the URL of the external page. Optionally, you can specify an alternative link title by adding | followed by the alternative text. For example <pre>[https://wiki.met.no/noresm/start NorESM wiki|NorESM wiki]</pre>   
* ''Comments'': To comment (i.e., hide) text use <pre><!-- some hidden text --></pre>
* ''Comments'': To comment (i.e., hide) text use <pre><!-- some hidden text --></pre>

Revision as of 16:22, 22 September 2014

Guidelines for this wiki:

  • The official wiki pages should be complete and fully functional at all times (i.e., clean of stubs, broken links, etc). If your edits are too comprehensive to be done in a single session then please do your edits first on a development page (this one has "- beta" in its name, create it if it does not exist) and then copy and paste to the official page once the content is complete.
  • Do not delete any content from other people without consulting them. The wiki has a discussion feature which can be used for this purpose.

Examples for model wikis:

Examples for model homepages:

Wiki-media resources:

Tips for wiki-development:

  • Creating a new page: Put the title of the new page in the search field. If the field does not exist you will get the option to create it.
  • Deleting and renaming pages: Next to the search field at the top of the page is a downward pointing arrow. If you move the mouse pointer over the arrow a scroll menu will appear with the options to delete or move (i.e., rename) the wiki page. If you move a page, you will have the option set up a re-direct from the old page name (this option is activated by default). Please deactivate the re-direct option if the re-direct is not needed (e.g., if you have created a new page and you want to rename it shortly after, i.e. before anyone knows of its existence)
  • Formatting: Use two times ' around italic text and three times ' around bold text.
  • Lists: Start the line with * in the first column, followed by a single space and then the text to be listed.
  • Creating sections and subsections: Use == around the title of top-level sections and === etc. around the title of subsections.
  • Internal link to a page: To link to another page use double [ ] around the name of the page. Optionally, you can specify an alternative link title by adding | followed by the alternative text.
  • Internal link to a section: As above, but after the page name add # followed by the name of the section. For example
     [[NorCPM User Manual - beta#Running the model|Instructions for running NorCPM]]
  • External link: To link to an external page use single [ ] around the URL of the external page. Optionally, you can specify an alternative link title by adding | followed by the alternative text. For example
    [https://wiki.met.no/noresm/start NorESM wiki|NorESM wiki]
  • Comments: To comment (i.e., hide) text use
    <!-- some hidden text -->