TUFLOW Wiki Format Guide

Bullet Point Lists

View this section in "preview" mode to see the appropriate Wiki syntax.

• Item A
• Item B
• etc
  

Numbered lists are indented

1. Item A
2. Item B
3. 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")