TUFLOW Wiki Format Guide: Difference between revisions
Content deleted Content added
Chris Huxley (talk | contribs) |
Chris Huxley (talk | contribs) |
||
| (35 intermediate revisions by 2 users not shown) | |||
Line 1:
== User Advice (Comments)==▼
Refer to [[Tutorial_M09 | Tutorial Module 09]] as a worked example of these format requirements.
Advice is writing in italics. <br>▼
== Moving a Page ==
:''Note: Running a multiple domain model without a valid multiple domain licence (i.e. in Tutorial Mode) can only be achieved using TUFLOW Build 2016-03-AD or newer.''<br>▼
Use the "Move" option left of the search panel on the top right of the page. After moving the page by renaming it, check for any redirects within the Wiki and update the redirect links to the new page name.<br>
== New Page Titles ==
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 with "Arc"
# [[Arc_Create_Projection | Create a projection file for TUFLOW]]
# [[Arc_Toolbar_Customization | Toolbar customization]]
# [[Arc_Creating_a_Grid_from_Points | Create a grid from points]]
# [[Arc_Export_Raster_to_asc | Convert raster to .asc format for direct read in TUFLOW]]
# [[Arc_Export_Raster_to_flt | Convert raster to .flt format for direct read in TUFLOW]]
Arc_Create_Projection | Create a projection file for TUFLOW<br>
Arc_Toolbar_Customization | Toolbar customization<br>
Arc_Creating_a_Grid_from_Points | Create a grid from points<br>
Arc_Export_Raster_to_asc | Convert raster to .asc format for direct read in TUFLOW<br>
Arc_Export_Raster_to_flt | Convert raster to .flt format for direct read in TUFLOW<br>
<br>
The same principles should apply to figures names (jpg, png, etc.)
== Bullet Point Lists==
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 18 ⟶ 38:
</ol>
: ":" example...
== TUFLOW File References ==
Line 26 ⟶ 47:
:''Note: This also applies to section headings.''
* Control file acronyms are upper case: TCF, TGC, TBC
* Use colour formats for
:<font color="green"><tt>! Comment bla bla
:<font color="blue"><tt>Command </tt></font> <font color="red"><tt>== </tt></font> <tt><something></tt> <br>
▲== User Advice (Comments)==
▲:''Note: Running a multiple domain model without a valid multiple domain licence (i.e. in Tutorial Mode) can only be achieved using TUFLOW Build 2016-03-AD or newer.''<br>
:''Tip 1: Bla bla bla.''<br>
== Language ==
Use succinct language for action steps: For example:
* Firstly, lets begin by opening '''M01_5m_002.tgc''' in your preferred text editor. Please save the file as '''M09_2D2D_5m_001.tgc'''.
becomes.<br>
* Open '''M01_5m_002.tgc''' in your text editor. Save the file as '''M09_2D2D_5m_001.tgc'''
More verbose language can be used for discussion paragraphs.
==Section Headings==
* Every word within a section heading MUST start with a capital letter.<br>
* Make the section headings as succinct as possible.<br>
* Do NOT use acronyms as a Section Heading (For example, use "TUFLOW Geometry Control File (TGC)" instead of "TCG")
==Section Links ==
* Link to succinct Section Headings (i.e. not including words preceding the target link).<br>
: (For example, "As [[Tutorial_M01#Reviewing_Model_Performance | discussed in Module 1]]" is incorrect and should be amended to "As discussed in <u>[[Tutorial_M01#Reviewing_Model_Performance | Module 1]]</u>")
* Links should be underlined (eg. <u>[[Tutorial_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>
| |||