Difference between revisions of "TUFLOW Wiki Format Guide"
Jump to navigation
Jump to search
Chris Huxley (talk | contribs) |
Chris Huxley (talk | contribs) |
||
| Line 22: | Line 22: | ||
:''Note: This also applies to section headings.'' | :''Note: This also applies to section headings.'' | ||
* Control file acronyms are upper case: TCF, TGC, TBC | * Control file acronyms are upper case: TCF, TGC, TBC | ||
| − | * Use colour formats for | + | * Use colour formats for syntax text: |
:<font color="green"><tt>! Comment bla bla</tt></font><br> | :<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> | :<font color="blue"><tt>Command </tt></font> <font color="red"><tt>== </tt></font><tt><something></tt><br> | ||
Revision as of 10:25, 14 November 2016
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.