Help - WikiMarkup Reference

Modified on 2011/12/18 21:40 by krucker Categorized as Uncategorized
==Text Formatting==

<table class="generic">
<tr class="tableheader">
<th>WikiMarkup</th><th>Output</th><th>Notes</th>
</tr>
<tr class="tablerow">
<td>{{<nowiki>'''bold'''</nowiki>}}</td><td>'''bold'''</td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>''italic''</nowiki>}}</td><td>''italic''</td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>__underlined__</nowiki>}}</td><td>__underlined__</td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>--strike-through--</nowiki>}}</td><td>--strike-through--</td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>{{inline code - monospace font}}</nowiki>}}</td><td>{{inline code - monospace font}}</td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>@@block code - [WikiMarkup] is ignored@@</nowiki>}}</td><td>@@block code - [WikiMarkup] is ignored@@</td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>----</nowiki>}}</td><td><h1 class="separator">&nbsp;</h1></td><td>Horizontal ruler</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>[MainPage|MainPage]</nowiki>}} or {{<nowiki>[MainPage|my link]</nowiki>}}</td><td>[MainPage|MainPage] or [MainPage|my link]</td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>[++Dev.MainPage]</nowiki>}} or {{<nowiki>[++Dev.MainPage|my link in another namespace]</nowiki>}} or {{<nowiki>[++MainPage|root]</nowiki>}}</td><td>[++Dev.MainPage] or [++Dev.MainPage|my link in another namespace] or [++MainPage|root]</td><td>Add {{++}} to the link for linking to another namespace, including the root</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>[http://www.screwturn.eu]</nowiki>}} or {{<nowiki>[http://www.screwturn.eu|ScrewTurn Wiki]</nowiki>}}</td><td>[http://www.screwturn.eu] or [http://www.screwturn.eu|ScrewTurn Wiki]</td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>[email@server.com]</nowiki>}} or {{<nowiki>[email@server.com|contact us]</nowiki>}}</td><td>[email@server.com] or [email@server.com|contact us]</td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>[c:Help.Wiki]</nowiki>}} or {{<nowiki>[c:Help.Wiki|Pages of category 'Wiki']</nowiki>}}</td><td>[c:Help.Wiki] or [c:Help.Wiki|Pages of category 'Wiki']</td><td>Links to a category</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>==Title==</nowiki>}}</td><td><h1 class="separator">Title</h1></td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>===Sub-Title===</nowiki>}}</td><td><h2 class="separator">Sub-Title</h2></td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>====Sub-Sub-Title====</nowiki>}}</td><td><h3 class="separator">Sub-Sub-Title</h3></td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>=====Sub-Sub-Sub-Title=====</nowiki>}}</td><td><h4 class="separator">Sub-Sub-Sub-Title</h4></td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{&#123;t:PageToTransclude&#125;}}</td><td>&nbsp;</td><td>Displays the content of ''PageToTransclude'' from the same namespace, in-place</td>
</tr>
<tr class="tablerow">
<td>{{&#123;t:OtherNS.PageToTransclude&#125;}}</td><td>&nbsp;</td><td>Displays the content of ''PageToTransclude'' from namespace ''OtherNS'', in-place (prepend page name with {{++}} to transclude a page from the ''root'' namespace)</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>>>> PageName</nowiki>}}</td><td>&nbsp;</td><td>Redirects to {{PageName}} in the current namespace</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>>>> Namespace.PageName</nowiki>}}</td><td>&nbsp;</td><td>Redirects to {{Namespace.PageName}}</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>>>> ++PageName</nowiki>}}</td><td>&nbsp;</td><td>Redirects to {{PageName}} in the ''root'' namespace</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>&#126;&#126;&#126;&#126;</nowiki>}}</td><td>§§(Dario Solera,2009/11/10 10:01:03)§§</td><td>Adds a signature for the user who made the change</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>(((Boxed)))</nowiki>}}</td><td>(((Boxed)))</td><td>Wraps content in a box</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>: Indentation</nowiki>}}</td><td>
: Indentation
</td><td>Each ':' sign at the beginning of a line indents content one level</td>
</tr>
</table>

==Lists==
You can create an unordered or ordered lists using {{*}} and {{#}} characters, for example:

<table class="generic">
<tr class="tableheader">
<th>WikiMarkup</th><th>Output</th><th>Notes</th>
</tr>
<tr class="tablerow">
<td>@@* List element
* Another element,
which continues on a new line
* A third element

@@</td><td>
* List element
* Another element,
which continues on a new line
* A third element

</td><td>Always keep an empty line after a list</td></tr>
<tr class="tablerow">
<td>@@# List element
# Another element,
which continues on a new line
# A third element

@@</td><td>
# List element
# Another element,
which continues on a new line
# A third element

</td><td>Always keep an empty line after a list</td></tr>
<tr class="tablerow">
<td>@@* List element
*# Sub-element,
which continues on a new line
*# Still a sub-list
* A third element

@@</td><td>
* List element
*# Sub-element,
which continues on a new line
*# Still a sub-list
* A third element

</td><td>You can combine {{*}} and {{#}}</td></tr>
</table>

==Tables==
You can create tables using a simple markup. Please refer to the dedicated section [Tables|Help - Table Formatting] for details.


==File Links and Pictures==

<table class="generictable">
<tr class="tableheader">
<th>WikiMarkup</th><th>Output</th><th>Notes</th>
</tr>
<tr class="tablerow">
<td>{{<nowiki>[{UP}/v3Site/Grass.png|download image]</nowiki>}}</td><td>[{UP}/v3Site/Grass.png|download image]</td><td>&nbsp;</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>[{UP(Help.WikiMarkup)}SamplePicture.jpg|download attachment]</nowiki>}}</td><td>[{UP(Help.WikiMarkup)}SamplePicture.jpg|download attachment]</td><td>{{Help.WikiMarkup}} is the full name of this page and the ''SamplePicture.jpg'' file is an attachment of this page</td>
</tr>
</table>

===Displaying Pictures===
[imageright|Sample Picture Caption|{UP(Help.WikiMarkup)}SamplePicture-Small.jpg|{UP(Help.WikiMarkup)}SamplePicture.jpg]
{{<nowiki>[imageright|Sample Picture Caption|{UP(Help.WikiMarkup)}SamplePicture-Small.jpg|{UP(Help.WikiMarkup)}SamplePicture.jpg]</nowiki>}} generates:

{{imageleft}} aligns the image on the left; {{imageauto}} sets no alignment; {{image}} produces no border nor caption.

The caption is optional, as well as the link ({{<nowiki>{UP(Help.WikiMarkup)}SamplePicture.jpg</nowiki>}} in the example above). The link can be any type of link (page, URL, email, file/attachment, etc.).

==Special Tags==
All Special Tags are ''case insensitive''.

<table class="generictable">
<tr class="tableheader">
<th>WikiMarkup</th><th>Output</th><th>Notes</th>
</tr>
<tr class="tablerow">
<td>{{<nowiki>{WikiTitle}</nowiki>}}</td><td>{WikiTitle}</td><td>Title of this wiki</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>{Top}</nowiki>}}</td><td>{top}</td><td>Link to the top of the page</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>{TOC}</nowiki>}}</td><td>&nbsp;</td><td>Table of Contents of the current page</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>{ThemePath}</nowiki>}}</td><td>{ThemePath}</td><td>Path of the current theme</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>{RSSPage}</nowiki>}}</td><td>{RSSPage}</td><td>URL of the RSS Page</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>{WikiVersion}</nowiki>}}</td><td>{WikiVersion}</td><td>Version of ScrewTurn Wiki</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>{MainURL}</nowiki>}}</td><td>{MainURL}</td><td>URL of the wiki</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>{PageCount}</nowiki>}}</td><td>{PageCount}</td><td>Number of pages in the current namespace</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>{PageCount(*)}</nowiki>}}</td><td>{PageCount(*)}</td><td>Number of pages in the entire wiki</td>
</tr>
<tr class="tablerow">
<td>{{&#0123;Username&#0125;}}</td><td>{Username}</td><td>Username of the current user, if any</td>
</tr>
<tr class="tablerow">
<td>{{&#0123;LoginLogout&#0125;}}</td><td>{LoginLogout}</td><td>Login/Logout link, according to the current session</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>{Cloud}</nowiki>}}</td><td>{Cloud}</td><td>Page categories cloud</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>&#0123;PageName&#0125;</nowiki>}}</td><td>{PageName}</td><td>Name of the current page</td>
</tr>
<tr class="tablerow">
<td>{{&#0123;Namespace&#0125;}}</td><td>{Namespace}</td><td>Current namespace</td>
</tr>
<tr class="tablerow">
<td>{{&#0123;NamespaceDropDown&#0125;}}</td><td>{NamespaceDropDown}</td><td>Drop-down list of namespaces</td>
</tr>
<tr class="tablerow">
<td>{{<nowiki>{NamespaceList}</nowiki>}}</td><td>{NamespaceList}</td><td>List of namespaces</td>
</tr>
<tr class="tablerow">
<td>{{&#0123;Orphans&#0125;}}</td><td>{Orphans}</td><td>List of pages that have no incoming links</td>
</tr>
<tr class="tablerow">
<td>{{&#0123;Wanted&#0125;}}</td><td>{Wanted}</td><td>Lists of pages that need to be created</td>
</tr>
<tr class="tablerow">
<td>{{&#0123;Incoming&#0125;}}</td><td>{Incoming}</td><td>List of pages that link the current page</td>
</tr>
<tr class="tablerow">
<td>{{&#0123;Outgoing&#0125;}}</td><td>{Outgoing}</td><td>List of pages linked in the current page</td>
</tr>
<tr class="tablerow">
<td>{{&#0123;RecentChanges&#0125;}}</td><td>{RecentChanges}</td><td>List of recent changes made in the current namespace</td>
</tr>
<tr class="tablerow">
<td>{{&#0123;RecentChanges(*)&#0125;}}</td><td>{RecentChanges(*)}</td><td>List of recent changes made in the entire wiki</td>
</tr>
</table>

==Escaping Content==
There are two ways to escape content that is usually interpreted by the ''WikiMarkup'' formatter.

This will simply ignore any ''WikiMarkup'' wrapped in it:

{{&lt;nowiki&gt;<nowiki>[this would be a link]</nowiki>&lt;/nowiki&gt;}} results in <nowiki>[this would be a link]</nowiki>

This will escape all special characters, so they are displayed on the screen:

{{&lt;esc&gt;<esc><b>some HTML</b></esc>&lt;/esc&gt;}} results in <esc><b>some HTML</b></esc>

This will ignore any new-line wrapped in it:

{{{{&lt;nobr&gt;some content

and then some more&lt;/nobr&gt;}}}}

results in

some content and then some more
Meta Keywords:
Meta Description:
Change Comment:
	Welcome Guest, • Login
Wiki Home \| VintageMachinery.org Home \| OWWM.org Home \| Donate	Search the Wiki: »