TUFLOW Wiki Format Guide: Difference between revisions

Content deleted Content added
No edit summary
 
(8 intermediate revisions by 2 users not shown)
Line 1:
 
Refer to [[Tutorial_Module09Tutorial_M09 | Tutorial Module 09]] as a worked example of these format requirements.
== Moving a Page ==
DO NOT rename page links!<br>
Line 8:
The behind the scenes link should include a prefix relating the higher level topic, followed by a succinct description of the section purpose. <br>
 
For example, for the ArcGIS page, all second level links are prefixed witwith "Arc"
# [[Arc_Create_Projection | Create a projection file for TUFLOW]]
# [[Arc_Toolbar_Customization | Toolbar customization]]
Line 25:
View this section in "preview" mode to see the appropriate Wiki syntax.
 
<ol>
* Item A
* Item B
* etc <br>
</ol>
 
Numbered lists are indented
Line 47 ⟶ 49:
* Use colour formats for syntax text:
:<font color="green"><tt>! Comment bla bla</tt></font><br>
:<font color="blue"><tt>Command </tt></font> <font color="red"><tt>== </tt></font> <tt><something></tt> <br>
 
== User Advice (Comments)==
Line 69 ⟶ 71:
==Section Links ==
* Link to succinct Section Headings (i.e. not including words preceding the target link).<br>
: (For example, "As [[Tutorial_Module01Tutorial_M01#Reviewing_Model_Performance | discussed in Module 1]]" is incorrect and should be amended to "As discussed in <u>[[Tutorial_Module01Tutorial_M01#Reviewing_Model_Performance | Module 1]]</u>")
 
* Links should be underlined (eg. <u>[[Tutorial_Module01Tutorial_M01#Reviewing_Model_Performance | Module 1]])</u>
* If it is a link to another section within the Wiki, code the link directly (use an internal hyperlink like: <u>[[UltraEdit_Tips | UltraEdit_Tips]])</u> ). Don't use the full website path (https://wiki.tuflow.com/index.php?title=UltraEdit_Tips)
 
==Additional==
For further help on the wiki syntax please refer to the <u>[[Help:Editing | Editing Help page]]</u>