Help:Editing: Difference between revisions

Content deleted Content added
Created page with '== Cheat Sheet For TUFLOW Wiki == For dot point use an asterix by typing: <pre>'* Dot Point'</pre> Displays as: * Dot Point For control file commands us true type font for exam...'
 
 
(19 intermediate revisions by 3 users not shown)
Line 1:
== Cheat Sheet For TUFLOW Wiki ==
 
=== TUFLOW commands ===
For control file commands use a green true type font for example:
 
<pre><font color="blue"><tt>Read Materials File </tt></font> <font color="red"><tt>==</tt></font><tt> ..\model\materials.csv</tt></pre>
displays as:
 
<font color="blue"><tt>Read Materials File </tt></font> <font color="red"><tt>==</tt></font><tt> ..\model\materials.csv</tt><br>
 
Or with comment at the end:
<pre><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></pre>
 
Displays as:
<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>
 
Inclusion of vertical bar use
<nowiki><nowiki>|</nowiki></nowiki>
Which displays as: <nowiki>|</nowiki><br>
 
=== Text Size ===
<font size = 18>Bigger Text</font>
 
=== Dot Points ===
For dot point use an asterix by typing:
<pre>'* Dot Point'</pre>
Displays as:
* Dot Point
 
=== Internal Links ===
For control file commands us true type font for example:
Double square brackets - Page Name - display text - End Bracket:<br>
<pre>'<tt>Read GIS Network</tt>'</pre>
<pre>[[TUFLOW_Message_1012|Message 1012]]</pre>
displays as:
<tt>Read GIS Network</tt>
 
=== External Links ===
Website Links: [http://www.tuflow.com See this Website link]<br>
Syntax square bracket - link location - space - display text end square bracket, see below:
 
<pre>[http://www.link_here.com display text]</pre><br>
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 <code><nowiki>''this''</nowiki></code>.
Becomes [http://www.link_here.com display text]
 
<pre>contact <font color="blue"><u>support@tuflow.com</u></font></pre>
contact <font color="blue"><u>support@tuflow.com</u></font>
 
=== 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:<br>
<pre>[[File:CrossHair Cell Selection.jpg]]</pre>
This shows the image at original resolution, to resize use:<br>
<pre>[[File:CrossHair Cell Selection.jpg|500px]]</pre>
 
Gives the following image:
 
[[File:CrossHair Cell Selection.jpg|500px]]
 
For more info on images see [http://www.mediawiki.org/wiki/Help:Images MediaWiki Image Help]
 
=== Tables ===
{| class="wikitable"
! Column 1 Label
! width=40% | Column 2 Label
! width=40% | Column 3 Label
|-
|A1|| B1 || C1
|-
|A2|| B2 || C2
|}
 
Was created using:
<pre>
{| class="wikitable"
! Column 1 Label
! width=40% | Column 2 Label
! width=40% | Column 3 Label
|-
|A1|| B1 || C1
|-
|A2|| B2 || C2
|}
</pre>
For more see [http://www.mediawiki.org/wiki/Help:Tables 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 <code><nowiki>''this''</nowiki></code>.
 
See table below for more wiki syntax
 
{| class="wikitable"
Line 84 ⟶ 154:
----
Text below
|-
|Ordered list
|
<pre>
<li> First </li>
<li> Second </li>
<li> Third </li>
<li> Fourth </li>
</pre>
|
<li>First </li>
<li>Second </li>
<li>Third </li>
<li>Fourth </li>
|-
| Bullet list
Line 104 ⟶ 188:
*** But jumping levels creates empty space.
Any other start ends the list.
|-
| Numbering
|
<pre><ol>
<li> First Instruction </li>
<li> Second Instruction </li>
<li> Third Instruction </li>
<li> Fourth Instruction </li>
</ol> </pre>
|
<ol>
<li> First Instruction </li>
<li> Second Instruction </li>
<li> Third Instruction </li>
<li> Fourth Instruction </li>
</ol>
|-
| Numbered list
Line 130 ⟶ 230:
### But jumping levels creates empty space.
# Blank lines
 
# end the list and start another.
Any other start also
Line 219 ⟶ 318:
== 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 <code>&lt;br /></code>.
For a break line use
<pre>
TUFLOW<br> Model<br>
</pre>
Displays as:<br>
Tuflow<br> Model <br>
 
== HTML tags ==
Line 301 ⟶ 406:
<pre> Text is '''preformatted''' and
''markups'' '''''cannot''''' be done</pre>
</pre>
|-
| '''Customized''' preformatted text
Line 320 ⟶ 424:
</pre>
|}
 
== HTML symbols ==
An HTML symbol entity is a sequence of characters that produces one particular character. For example, <code>&amp;rarr;</code> produces a right arrow "<code>&rarr;</code>" and <code>&amp;mdash;</code> produces an em dash "<code>&mdash;</code>". 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:
 
:<tt>&amp;copy;</tt>&nbsp;&rarr; '''&copy;'''
:<tt>&amp;delta;</tt>&nbsp;&rarr; '''&delta;'''
 
and to prevent the parser from interpreting and displaying HTML tags and symbols:
 
:<tt>&amp;amp;euro;</tt>&nbsp;&rarr; '''<tt>&amp;euro;</tt>'''
:<tt>&amp;euro;</tt>&nbsp;&rarr; '''&euro;'''
 
:<tt>&amp;lt;span style="color:green;">Green&amp;lt;/span></tt>&nbsp;&rarr; '''<tt>&lt;span style="color:green;">Green&lt;/span></tt>'''
:<tt>&lt;span style="color:green;">Green&lt;/span></tt>&nbsp;&rarr; '''<span style="color:green;">Green</span>'''
 
 
== 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