Wiki syntax: Difference between revisions

From IMAGE
Jump to navigation Jump to search
m (Text replace - "CO<sub>2</sub>" to "CO<sub>2</sub> ")
 
(78 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Help wiki syntax ==
The default wiki editor, available in edit mode, contains a number of edit functions in buttons above the free text window. In this wiki you will add a lot of content via forms. The buttons will not function in a form and consequently you will have to add style code manually. Remember to use style codes only when necessary. Use headers to divide your text in sections and use them in a hierarchy without gaps, e.g use 'h2' style syntax with subsections in for example 'h3' style syntax.
===Semantic wiki manual===
Entry to smw manual:
[http://semantic-mediawiki.org/wiki/Help:Introduction_to_Semantic_MediaWiki smw help]


== Help wiki general ==
===Styling syntax===
In the following table the standard styling syntax is summarized.


== Help wiki syntax ==
{| class="wikitable"
The default wiki editor, available in edit mode, contains a number of edit functions in buttons above the free text window. In this wiki you will add a lot of content via forms. The buttons won't function in a form,and consequently you will have to add style code manually. Remember to use style codes only when necessary. Use headers to divide your text in sections and use them in a hierarchy without gaps, e.g use 'h2' with subs in 'h3' etc. and continue with 'h2'. Below is the list of standard styling syntax:
!Style element!!Syntax!!Shows as
* headers:  <nowiki>== header 2 ==</nowiki>;  <nowiki>=== header 3 ===</nowiki>
|-
|rowspan="2"|Headers
|<nowiki>== header 2 ==</nowiki>
|<h2> header 2 </h2>
|-
|<nowiki>=== header 3 ===</nowiki>
|<h3> header 3 </h3>
|-
|Bulleted list
|<nowiki>* bullet 1</nowiki><br><nowiki>* bullet 2</nowiki><br><nowiki>** nested bullet</nowiki>
|<ul><li>bullet 1</li><li>bullet 2</li><ul><li>nested bullet</li></ul></ul>
|-
|Ordered list
|<nowiki># first item</nowiki><br><nowiki>#second item</nowiki><br><nowiki>## nested item</nowiki><br><nowiki>##* nested bullet</nowiki>
| <ol><li>first item</li><li>second item</li><ol><li>nested item 1</li><ul><li>nested bullet</li></ul></ol></ol>
|-
|Indentation
|<nowiki>: indent </nowiki>
| &nbsp;&nbsp;&nbsp;indent
|-
|Change text style
|<nowiki>'''Bold text''' (3 single quotes)</nowiki><br><nowiki>''Italic text'' (2 single quotes)</nowiki>
| <b>Bold text</b><br><i>Italic text</i>
|}
To start a new paragraph insert a blank line in the text.
 
For detailed info see http://www.mediawiki.org/wiki/Help:Formatting
 
===Symbol syntax===
In the following table some symbol syntax is summarized.


{| class="wikitable"
!Symbol!!Syntax!!Shows as
|-
|Superscript
| km<nowiki><sup>2</sup></nowiki>
| km<sup>2</sup>
|-
|Subscript
| CO<nowiki><sub>2</sub></nowiki>
| CO<sub>2</sub>
|-
|Degrees Celsius
|&amp;<nowiki>deg;</nowiki>
| &deg;
|-
| lambda
|&amp;<nowiki>lambda;</nowiki>
|&lambda;
|-
|}
For more symbols, see the following link: http://www.mediawiki.org/wiki/Help:Formatting


===How to make headers===
===Link syntax===
<pre>
In the following table the standard link syntax is summarized.
== header 2 ==
=== header 3 ===
</pre>
will show as
==header 2==
===header 3===


===How to make lists===
{| class="wikitable"
!Link type!!Syntax!!Shows as
|-
|rowspan="2"|Internal link to another page in the wiki
|<nowiki>[[Welcome to IMAGE 3.0 Documentation]]</nowiki>
| [[Welcome to IMAGE 3.0 Documentation]]
|-
|<nowiki>[[Welcome to IMAGE 3.0 Documentation| Home page IMAGE wiki]]</nowiki>
|[[Welcome to IMAGE 3.0 Documentation| Home page IMAGE wiki]]
|-
|rowspan="2"|External link
|<nowiki>http://www.pbl.nl</nowiki>
| http://www.pbl.nl
|-
|<nowiki>[http://www.pbl.nl Home page PBL]</nowiki>
| [http://www.pbl.nl Home page PBL]
|}
For  detailed info see: http://www.mediawiki.org/wiki/Help:Links


== Help pictures/images/files ==
== Help pictures/images/files ==
http://www.mediawiki.org/wiki/Help:Images


== help tables ==
== Help 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.
== Publication process ==
There is an internal PBL wiki and an external wiki. The external wiki is a subset of the internal wiki and is meant to be viewed by webusers. The implementation will be probably ([[DiscussionItems#Maintenance|discussion item]])  by installing one wiki inside the firewall and one wiki outside the firewall. The external wiki will be filled by an import of pages from the internal wiki and periodically updated.
* Internal wiki:  This  wiki is visible for PBL persons and external people that can login (?). To all these people in principle all contentpages are visible. However there will be a difference between viewers, writers and administrators, with more options available in this sequence. Viewers can view and discuss; writers will have an extended menu with functions to add content and may edit pages; administrators can change the structure and maintain user rights and use other maintenance functions.
* External wiki: This is the publishable part of the internal wiki and will be accessible for the outside world via a PBL URL.
=== How to handle changes ===
There are several situations with different solutions:
#Minor text change, may be a correction or enhancement: Enter the changes in the wiki.
#Small adaptations to model components or substantial rewriting of a description: Use the hasStatus property (publishable/ on hold) in the forms. Pages with an status 'on hold' will not be published to the external wiki, that is the wiki as seen by the world outside PBL. You have time to enter the changges and have some checks, on the content and redactional, on the change.
# Substantial change resulting in a new version: When making a substantial change to your model by adding a submodule or changing the conceptual model, you can document (and discuss) this change in the namespace 'Next'. This namespace is part of the wiki, but does not influence the content of the so called 'Main' namespace. You can implement the change and document it in the wiki. When the changed model/component is taken in production (new version number of module and framework...), the new description of the component must be copied from the 'Next' namespace to the 'Main' namespace. See the following paragraph for the procedure.


==== Create new version of an existing component ====
For detailed info see: http://www.mediawiki.org/wiki/Help:Tables
Steps for creation:
#Copy existing component page 'ComponentX' to the page Next:ComponentX
#Edit Next:ComponentX and adjust the used template to NextComponentTemplate2 (how?)
Now you have a component in the Next-namespace which you can edit without consequences for the existing wiki. All created links (infobox, inputs/outputs, asumptions, policy interventions,…) will be located in the namespace 'Next'


Steps for publishing, this is an action for the 'gardener':
[[Category:Help]]
# Copy all pages in the "Main' namespace to the 'Previous' namespace (or only changed component and how ?)
# Copy all pages from the 'Next' namespace concerning the new version into the 'Main' (how)
This way we wiil have an active documenation of the previous, current and next version of the IMAGE framework

Latest revision as of 10:30, 1 July 2014

Help wiki syntax

The default wiki editor, available in edit mode, contains a number of edit functions in buttons above the free text window. In this wiki you will add a lot of content via forms. The buttons will not function in a form and consequently you will have to add style code manually. Remember to use style codes only when necessary. Use headers to divide your text in sections and use them in a hierarchy without gaps, e.g use 'h2' style syntax with subsections in for example 'h3' style syntax.

Semantic wiki manual

Entry to smw manual: smw help

Styling syntax

In the following table the standard styling syntax is summarized.

Style element Syntax Shows as
Headers == header 2 ==

header 2

=== header 3 ===

header 3

Bulleted list * bullet 1
* bullet 2
** nested bullet
  • bullet 1
  • bullet 2
    • nested bullet
Ordered list # first item
#second item
## nested item
##* nested bullet
  1. first item
  2. second item
    1. nested item 1
      • nested bullet
Indentation : indent    indent
Change text style '''Bold text''' (3 single quotes)
''Italic text'' (2 single quotes) 		Bold text
Italic text

To start a new paragraph insert a blank line in the text.

For detailed info see http://www.mediawiki.org/wiki/Help:Formatting

Symbol syntax

In the following table some symbol syntax is summarized.

Symbol Syntax Shows as
Superscript km<sup>2</sup> km2
Subscript CO<sub>2</sub> CO2
Degrees Celsius &deg; °
lambda &lambda; λ

For more symbols, see the following link: http://www.mediawiki.org/wiki/Help:Formatting

Link syntax

In the following table the standard link syntax is summarized.

Link type Syntax Shows as
Internal link to another page in the wiki [[Welcome to IMAGE 3.0 Documentation]] Welcome to IMAGE 3.0 Documentation
[[Welcome to IMAGE 3.0 Documentation| Home page IMAGE wiki]] Home page IMAGE wiki
External link http://www.pbl.nl http://www.pbl.nl
[http://www.pbl.nl Home page PBL] Home page PBL

For detailed info see: http://www.mediawiki.org/wiki/Help:Links

Help pictures/images/files

http://www.mediawiki.org/wiki/Help:Images

Help 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

Retrieved from "https://models.pbl.nl/index.php?title=Wiki_syntax&oldid=25140"