Help:Editing
Cheat Sheet For TUFLOW Wiki
For dot point use an asterix by typing:
'* Dot Point'
Displays as:
- Dot Point
For control file commands us true type font for example:
'<tt>Read GIS Network</tt>'
displays as: Read GIS Network
You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equal signs 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 pairs of single quotes like ''this''
.
Text formatting markup
Description | You type | You get |
---|---|---|
character (inline) formatting – applies anywhere | ||
Italic text | ''italic'' |
italic |
Bold text | '''bold''' |
bold |
Bold and italic | '''''bold & italic''''' |
bold & italic |
Escape wiki markup | <nowiki>no ''markup''</nowiki> |
no ''markup'' |
section formatting – only at the beginning of the line | ||
Headings of different levels | == Level 2 == === Level 3 === ==== Level 4 ==== ===== Level 5 ===== ====== Level 6 ====== |
Level 2Level 3Level 4Level 5Level 6 |
Horizontal rule | Text above ---- Text below |
Text above Text below |
Bullet list |
* Start each line * with an [[Wikipedia:asterisk|asterisk]] (*). ** More asterisks gives deeper *** and deeper levels. * Line breaks<br />don't break levels. *** But jumping levels creates empty space. Any other start ends the list. |
Any other start ends the list. |
Numbered list |
# Start each line # with a [[Wikipedia:Number_sign|number sign]] (#). ## More number signs gives deeper ### and deeper ### levels. # Line breaks<br />don't break levels. ### But jumping levels creates empty space. # Blank lines # end the list and start another. Any other start also ends the list. |
Any other start also ends the list. |
Definition list | ;item 1 : definition 1 ;item 2 : definition 2-1 : definition 2-2 |
|
Adopting definition list to indent text | : Single indent :: Double indent ::::: Multiple indent |
|
Mixture of different types of list |
# one # two #* two point one #* two point two # three #; three item one #: three def one # four #: four def one #: this looks like a continuation #: and is often used #: instead<br />of <nowiki><br /></nowiki> # five ## five sub 1 ### five sub 1 sub 1 ## five sub 2 |
|
Preformatted textTemplate:Anchor | Start each line with a space. Text is '''preformatted''' and ''markups'' '''''can''''' be done |
Start each line with a space. Text is preformatted and markups can be done |
Paragraphs
MediaWiki ignores single line breaks. To start a new paragraph, leave an empty line. You can force a line break within a paragraph with the HTML tags <br />
.
HTML tags
Some HTML tags are allowed in MediaWiki, for example <code>
, <div>
, <span>
and <font>
. These apply anywhere you insert them.
Description | You type | You get |
---|---|---|
Underline | <u>Underline</u> |
Underline |
Strikethrough | <del>Strikethrough</del> or <s>Strikethrough</s> |
or
|
Fixed width text | <code>Source code</code> or <tt>Fixed width text</tt> |
or Fixed width text |
Blockquotes | text above text above <blockquote>blockquote</blockquote> text below text below |
text above text above
text below text below |
Comment | <!-- This is a comment --> Comments are only visible in the edit window. |
Comments are only visible in the edit window. |
Completely preformatted text | <pre> Text is '''preformatted''' and ''markups'' '''''cannot''''' be done</pre> |
Text is '''preformatted''' and ''markups'' '''''cannot''''' be done |
Customized preformatted text | <pre style="color:red"> Text is '''preformatted''' with a style and ''markups'' '''''cannot''''' be done </pre> |
Text is '''preformatted''' with a style and ''markups'' '''''cannot''''' be done |
HTML symbols
An HTML symbol entity is a sequence of characters that produces one particular character. For example, →
produces a right arrow "→
" and —
produces an em dash "—
". HTML symbol entities are allowed in MediaWiki and are sometimes used in advanced editing for two main reasons: to insert characters not normally available on keyboards:
- © → ©
- δ → δ
and to prevent the parser from interpreting and displaying HTML tags and symbols:
- &euro; → €
- € → €
- <span style="color:green;">Green</span> → <span style="color:green;">Green</span>
- <span style="color:green;">Green</span> → Green
Other formatting
Beyond the text formatting markup shown above, here are some other formatting references:
- Media Wiki Formatting Help|http://www.mediawiki.org/wiki/Help:Formatting