TUFLOW Wiki Format Guide

Refer to Tutorial Module 09 as a worked example of these format requirements.

Moving a Page

DO NOT rename page links!
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.

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.

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

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.

Item A
Item B
etc

Numbered lists are indented

Item A
Item B
etc

Manual indent syntax

":" example...

TUFLOW File References

TUFLOW is always uppercase (i.e. TUFLOW, not tuflow)
TUFLOW GIS input and simulation file names should be bold: model\gis\2d_code_M01_001.mif and M01_5m_002.tcf
Define acronyms before using them in each page: TUFLOW Geometry Control File (TGC), TUFLOW Boundary Control File (TBC).

Note: This also applies to section headings.

Control file acronyms are upper case: TCF, TGC, TBC
Use colour formats for syntax text:

! Comment bla bla

Command == <something>

User Advice (Comments)

Advice is written in italics.

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.

Tip 1: Bla bla bla.

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.

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.
Make the section headings as succinct as possible.
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).

(For example, "As discussed in Module 1" is incorrect and should be amended to "As discussed in Module 1")

Links should be underlined (eg. Module 1)
If it is a link to another section within the Wiki, code the link directly (use an internal hyperlink like: UltraEdit_Tips) ). 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 Editing Help page