Help:Editing

From Tuflow
Jump to: navigation, search

Cheat Sheet For TUFLOW Wiki

TUFLOW commands

For control file commands use a green true type font for example:

<font color="blue"><tt>Read Materials File </tt></font> <font color="red"><tt>==</tt></font><tt> ..\model\materials.csv</tt>

displays as:

Read Materials File == ..\model\materials.csv

Or with comment at the end:

<font color="blue"><tt>Start Time </tt></font> <font color="red"><tt>==</tt></font><tt> 0</tt><font color="grey"><tt>    ! Start Simulation a 0 hours</tt></font><br>

Displays as: Start Time == 0  ! Start Simulation a 0 hours

Inclusion of vertical bar use <nowiki>|</nowiki> Which displays as: |

Dot Points

For dot point use an asterix by typing:

* Dot Point

Displays as:

  • Dot Point

Internal Links

Double square brackets - Page Name - display text - End Bracket:

[[TUFLOW_Message_1012|Message 1012]]

External Links

Forum Links: See this Forum Post
Syntax square bracket - link location - space - display text end square bracket, see below:

[http://www.link_here.com display text]

Becomes display text

contact <font color="blue"><u>support@tuflow.com</u></font>

contact support@tuflow.com

Images

Images need to be uploaded through the Upload File option in the left navigation page. For example I have uploaded a file called: CrossHair Cell Selection.jpg

This file can be embedded in a page using an internal file link:

[[File:CrossHair Cell Selection.jpg]]

This shows the image at original resolution, to resize use:

[[File:CrossHair Cell Selection.jpg|500px]]

Gives the following image:

CrossHair Cell Selection.jpg

For more info on images see MediaWiki Image Help

Tables

Column 1 Label Column 2 Label Column 3 Label
A1 B1 C1
A2 B2 C2

Was created using:

{| class="wikitable"
! Column 1 Label
! width=40% | Column 2 Label
! width=40% | Column 3 Label
|-
|A1|| B1 || C1
|-
|A2|| B2 || C2
|}

For more see MediaWiki Tables Help.

Text formatting markup

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''.

See table below for more wiki syntax

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 ======

Template:Note

Level 2

Level 3

Level 4

Level 5
Level 6
Horizontal rule
Text above
----
Text below

Text above


Text below

Ordered list
<li> First </li>
<li> Second </li>
<li> Third </li>
<li> Fourth </li>
  • First
  • Second
  • Third
  • Fourth
  • 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.
    
    • Start each line
    • with an asterisk (*).
      • More asterisks gives deeper
        • and deeper levels.
    • Line breaks
      don't break levels.
        • But jumping levels creates empty space.

    Any other start ends the list.

    Numbering
    <ol> 
    <li> First Instruction </li>
    <li> Second Instruction </li>
    <li> Third Instruction </li>
    <li> Fourth Instruction </li>
    </ol> 
    1. First Instruction
    2. Second Instruction
    3. Third Instruction
    4. Fourth Instruction
    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.
    
    1. Start each line
    2. with a number sign (#).
      1. More number signs gives deeper
        1. and deeper
        2. levels.
    3. Line breaks
      don't break levels.
        1. But jumping levels creates empty space.
    4. Blank lines
    5. end the list and start another.

    Any other start also ends the list.

    Definition list
    ;item 1
    : definition 1
    ;item 2
    : definition 2-1
    : definition 2-2
    
    item 1
    definition 1
    item 2
    definition 2-1
    definition 2-2
    Adopting definition list to indent text
    : Single indent
    :: Double indent
    ::::: Multiple indent
    

    Template:Note

    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
    

    Template:Note

    1. one
    2. two
      • two point one
      • two point two
    3. three
      three item one
      three def one
    4. four
      four def one
      this looks like a continuation
      and is often used
      instead
      of <br />
    5. five
      1. five sub 1
        1. five sub 1 sub 1
      2. five sub 2
    Preformatted textTemplate:Anchor
     Start each line with a space.
     Text is '''preformatted''' and
     ''markups'' '''''can''''' be done
    

    Template:Note

    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 />. For a break line use

    TUFLOW<br> Model<br>
    

    Displays as:
    Tuflow
    Model

    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>
    

    Strikethrough

    or

    Strikethrough

    Fixed width text
    <code>Source code</code>
    
    or
    
    <tt>Fixed width text</tt>
    

    Source code

    or

    Fixed width text

    Blockquotes
    text above
    text above
    <blockquote>blockquote</blockquote>
    text below
    text below
    

    text above text above

    blockquote

    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>
    

    Template:Note

     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>
    

    Template:Note

    Text is '''preformatted'''
    with a style and
    ''markups'' '''''cannot''''' be done