Help:Editing: Difference between revisions

Help page
(fixed nowiki breaks and book sources link)
mNo edit summary
Line 1: Line 1:
To edit pages in this wiki you must [[Special:UserLogin&type=signup|create a user account]] and log in.
Once you are logged in with your username you can edit any page of this wiki.
This page explains the syntax you may use to format.
== Getting started ==
== Getting started ==
* [http://meta.wikimedia.org/wiki/Help:Contents MediaWiki User's Guide]
* [http://meta.wikimedia.org/wiki/Help:Contents MediaWiki User's Guide]
Line 19: Line 23:
'''This is just a short help. Find the full version [http://www.mediawiki.org/w/index.php?title=Help:Formatting here].'''
'''This is just a short help. Find the full version [http://www.mediawiki.org/w/index.php?title=Help:Formatting here].'''


You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equation marks which have a special function in the wiki, sometimes depending on their position. For example, to format a word in ''italic'', you include it in two single quotes like <tt><nowiki>''this''</nowiki></tt>
You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equation marks which have a special function in the wiki, sometimes depending on their position. For example, to format a word in ''italic'', you include it in two single quotes like <tt>
<nowiki>''this''</nowiki> </tt>


{| align="center" {{Prettytable}}
{| align="center" {{Prettytable}}
Line 30: Line 35:
|-
|-
|Italic text
|Italic text
|<tt><nowiki>''italic''</nowiki> </tt>
|<tt>
<nowiki>''italic''</nowiki>   </tt>
|''italic''
|''italic''
|-
|-
| Bold text
| Bold text
|<tt><nowiki>'''bold'''</nowiki> </tt>
|<tt>
<nowiki>'''bold'''</nowiki>   </tt>
|'''bold'''
|'''bold'''
|-
|-
| Bold and italic
| Bold and italic
|<tt><nowiki>'''''bold & italic'''''</nowiki> </tt>
|<tt>
<nowiki>'''''bold & italic'''''</nowiki>   </tt>
|'''''bold & italic'''''
|'''''bold & italic'''''
|-
|-
|Escape wiki markup
|Escape wiki markup
|<tt><nowiki></nowiki>  
|<tt>
<nowiki>no "markup"</nowiki>  
<nowiki></nowiki>
<nowiki>no ''markup''</nowiki>
 
<nowiki>no "markup"</nowiki>
 
<nowiki>no ''markup''</nowiki>  
|-
|-
|Fixed width text
|Fixed width text
|<nowiki><tt>Fixed width text</tt></nowiki>
|
<nowiki><tt>Fixed width text</tt></nowiki>  
|<tt>Fixed width text</tt>
|<tt>Fixed width text</tt>
|-
|-
Line 54: Line 66:
| Indent text
| Indent text
|
|
<tt><nowiki>:Single indent</nowiki> </tt><br />
<tt>
<tt><nowiki>::Double indent</nowiki> </tt><br />
<nowiki>:Single indent</nowiki>   </tt><br />
<tt><nowiki>:::::Multiple indent</nowiki> </tt>
<tt>
<nowiki>::Double indent</nowiki>   </tt><br />
<tt>
<nowiki>:::::Multiple indent</nowiki>   </tt>
|
|
:Single indent
:Single indent
Line 66: Line 81:
different levels <ref>An article with four or more headings will automatically create a [http://en.wikipedia.org/wiki/Wikipedia:Section#Table_of_contents_.28TOC.29 table of contents].</ref>
different levels <ref>An article with four or more headings will automatically create a [http://en.wikipedia.org/wiki/Wikipedia:Section#Table_of_contents_.28TOC.29 table of contents].</ref>
|
|
<tt><nowiki>=level 1=</nowiki> </tt><ref>Use of a level 1 heading is '''''highly discouraged''''' as it appears with the same formatting and size as the page title, which can be confusing.</ref><br />
<tt>
<tt><nowiki>==level 2==</nowiki> </tt><br />
<nowiki>=level 1=</nowiki>   </tt><ref>Use of a level 1 heading is '''''highly discouraged''''' as it appears with the same formatting and size as the page title, which can be confusing.</ref><br />
<tt><nowiki>===level 3===</nowiki> </tt><br />
<tt>
<tt><nowiki>====level 4====</nowiki> </tt><br />
<nowiki>==level 2==</nowiki>   </tt><br />
<tt><nowiki>=====level 5=====</nowiki> </tt><br />
<tt>
<tt><nowiki>======level 6======</nowiki> </tt>
<nowiki>===level 3===</nowiki>   </tt><br />
<tt>
<nowiki>====level 4====</nowiki>   </tt><br />
<tt>
<nowiki>=====level 5=====</nowiki>   </tt><br />
<tt>
<nowiki>======level 6======</nowiki>   </tt>
|
|
<!-- little hack to prevent TOC viewing -->
<!-- little hack to prevent TOC viewing -->
Line 82: Line 103:
|-
|-
|Horizontal rule
|Horizontal rule
|<tt><nowiki>----</nowiki> </tt>
|<tt>
<nowiki>----</nowiki>   </tt>
| ----
| ----
|-
|-
Line 103: Line 125:
&#35; one<br />
&#35; one<br />
&#35; two
&#35; two
<nowiki><br></nowiki> spanning several lines
 
<nowiki><br></nowiki> without breaking the numbering<br />
<nowiki><br></nowiki>   spanning several lines
 
<nowiki><br></nowiki>   without breaking the numbering<br />
&#35; three<br />
&#35; three<br />
&#35;&#35; three point one<br />
&#35;&#35; three point one<br />
Line 149: Line 173:
|Preformatted text with no indentation
|Preformatted text with no indentation
|
|
&nbsp;<nowiki><pre> some preformatted text with no indentation </pre></nowiki>
&nbsp;
<nowiki><pre> some preformatted text with no indentation </pre></nowiki>  
|
|
<pre>
<pre>
Line 162: Line 187:
text text text text text text text text text text text text
text text text text text text text text text text text text


<nowiki><blockquote>  quote quote quote quote quote quote </blockquote></nowiki>
 
<nowiki><blockquote>  quote quote quote quote quote quote </blockquote></nowiki>  


text text text text text text text text text text text text
text text text text text text text text text text text text
Line 176: Line 202:
|-
|-
|Comment
|Comment
|<tt><nowiki><!--This is comment--></nowiki> </tt>
|<tt>
<nowiki><!--This is comment--></nowiki>   </tt>
|<!--This is comment-->
|<!--This is comment-->
|  
|  
Line 194: Line 221:
Show all references so far:
Show all references so far:
|
|
<tt><nowiki>Cite<ref>Annotation</ref></nowiki> </tt> (see above @Headline)<br/>
<tt>
<tt><nowiki><references/></nowiki> </tt> (See above)
<nowiki>Cite<ref>Annotation</ref></nowiki>   </tt> (see above @Headline)<br/>
<tt>
<nowiki><references/></nowiki>   </tt> (See above)
|-
|-
|Categories
|Categories
Line 202: Line 231:
Link to Category:
Link to Category:
|
|
<tt><nowiki>[[Category:MyCategory]]</nowiki> </tt><br/>
<tt>
<tt><nowiki>[[:Category:MyCategory]]</nowiki> </tt>
<nowiki>[[Category:MyCategory]]</nowiki>   </tt><br/>
<tt>
<nowiki>[[:Category:MyCategory]]</nowiki>   </tt>
|-
|-
|Templates
|Templates
Line 209: Line 240:
Import Template:
Import Template:
|
|
<tt><nowiki>{{Template:MyTemplate}}</nowiki> </tt>
<tt>
<nowiki>{{Template:MyTemplate}}</nowiki>   </tt>
|}
|}


Line 216: Line 248:


== Paragraphs ==
== Paragraphs ==
MediaWiki ignores normal line breaks. To start a new paragraph, leave an empty line. You can also start a new line with the HTML tags <tt><nowiki><br> or <br/></nowiki> </tt>.
MediaWiki ignores normal line breaks. To start a new paragraph, leave an empty line. You can also start a new line with the HTML tags <tt>
<nowiki><br> or <br/></nowiki>   </tt>.




== HTML & Sourcecode ==
== HTML & Sourcecode ==
Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <tt><nowiki><div></nowiki> </tt>, <tt><nowiki><span></nowiki> </tt> and <tt><nowiki><font></nowiki> </tt>.
Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <tt>
<nowiki><div></nowiki>   </tt>, <tt>
<nowiki><span></nowiki>   </tt> and <tt>
<nowiki><font></nowiki>   </tt>.


If you want to use <tt><nowiki><code></nowiki> </tt>, you should definitely use <tt>&lt;source&gt;</tt> instead! It supports Syntax Coloring. You can also specify a language, eg. <tt>&lt;source lang="c" line start="55" highlight="4"&gt;</tt> :
If you want to use <tt>
<nowiki><code></nowiki>   </tt>, you should definitely use <tt>&lt;source&gt;</tt> instead! It supports Syntax Coloring. You can also specify a language, eg. <tt>&lt;source lang="c" line start="55" highlight="4"&gt;</tt> :


<source lang="c" line start="55" highlight="4">
<source lang="c" line start="55" highlight="4">
Line 247: Line 284:


{|align="left" {{Prettytable}}
{|align="left" {{Prettytable}}
|<nowiki>{|</nowiki>    
|
<nowiki>{|</nowiki>    
|table start
|table start
|-
|-
|<nowiki>|+</nowiki>    
|
<nowiki>|+</nowiki>    
|table caption, optional; only between  table start and first table row
|table caption, optional; only between  table start and first table row
|-
|-
|<nowiki>|-</nowiki>    
|
<nowiki>|-</nowiki>    
|table row, optional on first row -- wiki engine assumes the first row
|table row, optional on first row -- wiki engine assumes the first row
|-
|-
|<nowiki>!</nowiki>    
|
<nowiki>!</nowiki>      
|table header cell, optional. Consecutive table header cells may be added on same line separated by double marks (<tt>!!</tt>) or start on new lines, each with its own single mark (<tt>!</tt>).
|table header cell, optional. Consecutive table header cells may be added on same line separated by double marks (<tt>!!</tt>) or start on new lines, each with its own single mark (<tt>!</tt>).
|-  
|-  
|<nowiki>|</nowiki>    
|
|table data cell, required! Consecutive table data cells may be added on same line separated by double marks (<tt><nowiki>||</nowiki></tt>) or start on new lines, each with its own single mark (<tt><nowiki>|</nowiki>     </tt>).
<nowiki>|</nowiki>    
|table data cell, required! Consecutive table data cells may be added on same line separated by double marks (<tt>
<nowiki>||</nowiki> </tt>) or start on new lines, each with its own single mark (<tt>
<nowiki>|</nowiki>     </tt>).
|-
|-
|<nowiki>|}</nowiki>    
|
<nowiki>|}</nowiki>    
|table end
|table end
|}
|}

Revision as of 16:12, 25 May 2010

To edit pages in this wiki you must create a user account and log in. Once you are logged in with your username you can edit any page of this wiki. This page explains the syntax you may use to format.

Getting started

Editing & MediaWiki Syntax

Please see further down on this page and also refer to:

For Administrators of this wiki


Quick Help

Text formatting markup

This is just a short help. Find the full version here.

You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equation marks which have a special function in the wiki, sometimes depending on their position. For example, to format a word in italic, you include it in two single quotes like ''this''

Description You type You get
applies anywhere
Italic text

''italic''

italic
Bold text

'''bold'''

bold
Bold and italic

'''''bold & italic'''''

bold & italic
Escape wiki markup

no "markup"

no ''markup''

Fixed width text

<tt>Fixed width text</tt>

Fixed width text
only at the beginning of the line
Indent text

:Single indent
::Double indent
:::::Multiple indent

Single indent
Double indent
Multiple indent

Headings of
different levels [1]

=level 1= [2]
==level 2==
===level 3===
====level 4====
=====level 5=====
======level 6======

Level 1

Level 2

Level 3
Level 4
Level 5
Level 6

Horizontal rule

----

----
Bullet list

* one
* two
* three
** three and one-third
** three and two-thirds

  • one
  • two
  • three
    • three and one-third
    • three and two-thirds
Numbered list

# one
# two

<br> spanning several lines

<br> without breaking the numbering
# three
## three point one
## three point two

  1. one
  2. two
    spanning several lines
    without breaking the numbering
  3. three
    1. three point one
    2. three point two
Mixture of bulleted
and numbered lists

# one
# two
#* two point one
#* two point two

  1. one
  2. two
    • two point one
    • two point two
Definition list

;Definition
:item 1
:item 2

Definition
item 1
item 2
Preformatted text

  preformatted text is done with
  a space at the
  beginning of the line

preformatted text is done with
a space at the 
beginning of the line
Preformatted text with no indentation

  <pre> some preformatted text with no indentation </pre>

some preformatted
text with no indentation
Blockquotes

Body
text text text text text text text text text text text text text text text text text text text text text text text text


<blockquote> quote quote quote quote quote quote </blockquote>

text text text text text text text text text text text text

Body
text text text text text text text text text text text text text text text text text text text text text text text text

quote quote quote quote quote quote

text text text text text text text text text text text text

Comment

<!--This is comment-->

  1. An article with four or more headings will automatically create a table of contents.
  2. Use of a level 1 heading is highly discouraged as it appears with the same formatting and size as the page title, which can be confusing.



Categories, References, Templates

References, Cites

Add Reference/Annotation:
Show all references so far:

Cite<ref>Annotation</ref> (see above @Headline)
<references/> (See above)

Categories

Add Page to Category:
Link to Category:

[[Category:MyCategory]]
[[:Category:MyCategory]]

Templates

Import Template:

{{Template:MyTemplate}}



Paragraphs

MediaWiki ignores normal line breaks. To start a new paragraph, leave an empty line. You can also start a new line with the HTML tags <br> or <br/> .


HTML & Sourcecode

Some HTML tags are allowed in MediaWiki, for example <div> , <span> and <font> .

If you want to use <code> , you should definitely use <source> instead! It supports Syntax Coloring. You can also specify a language, eg. <source lang="c" line start="55" highlight="4"> :

// Global variable
int x = 7;

int myFunction(int a) {
    // Local variable
    int b = 8;
    return (a + b);
}


Please see the MediaWiki GeSHi Page for detailed information to use some of the parameters:

  • lang="xyz": defines the language, eg. "c", "php", ...
  • line: show line numbering
  • line start="55": first line is labeled #55
  • hilight="4: hilights line #4


Tables

{|

table start

|+

table caption, optional; only between table start and first table row

|-

table row, optional on first row -- wiki engine assumes the first row

!

table header cell, optional. Consecutive table header cells may be added on same line separated by double marks (!!) or start on new lines, each with its own single mark (!).

|

table data cell, required! Consecutive table data cells may be added on same line separated by double marks (

|| ) or start on new lines, each with its own single mark ( | ).

|}

table end

For advanced Table editing see http://www.mediawiki.org/wiki/Help:Tables and http://meta.wikimedia.org/wiki/Help:Table


Extensions (PlugIns)

Please see Help:Extensions on how to add:

  • Audio
  • Image Galleries
  • Flash
  • Maps
  • Video



Other formatting

Beyond the text formatting markup shown above, here are some other formatting references: