| ↩︎ | ↖︎ | ↑︎ | ↘︎ | ↪︎ |
The term closure refers to the need to terminate a tag's effect on intervening content. As described in 2. Markup Fundamentals the closure is a vertical bar followed by white-space, or two Vbars if not followed by white-space. Annotated closure using |! is also available. In these tables required means exactly that, none resulting in an error if tried, and implied that the tag contains all the markup data required in itself (often with a parameter).
Highlight | |||
|---|---|---|---|
| Description | Syntax | Example | Reference |
| bold text | |*...| | bold text | 2.2 Text Highlight |
| center text | |><...| | center text | |
| italicise text | |/...| | italicised text | |
| monospace text | |=...| | monospaced text | |
| no-wrap text | |>>...| | this text will not wrap no matter what! | |
| strike text | |-...| | strike text | |
| underline text | |_...| | underlined text | |
| special class text | |'class=...| | wasDOC | |
Pagination | |||
| Description | Syntax | Closure | Reference |
| paragraph * | |^<white-space> | none | 2.3 Breaks |
| new line | |^- | none | |
| new page | |page| | none | |
| new page when printed | |ppage| | none | |
| end of document | |epage| | none | |
*
Paragraphs will take a trailing (plus) symbol to indent.
Quick Reference Blocks | |||
Blocks | |||
| Description | Syntax | Closure | Reference |
| text as written | |asis| | |||| (four on a line by themselves) | 2.4 Blocks |
| some text as a block | |block| | required | |
| code example | |code| | required | |
| example | |example| | required | |
| inline text | |inline| | required | |
| monospace pre-formatted | |mono| | required | |
| obvious note | |note| | required | |
| proportional pre-formatted | |prop| | required | |
| quoted text | |quote| | required | |
All will take additional styling (see ‘Explicit Styling’ in 2.2 Text Highlight)
Quick Reference Lists | |||
Lists | |||
| Description | Syntax | Closure | Reference |
| simple | |simple| | required | 2.6 Lists |
| |sl| | required | ||
| numeric | |number| | required | |
| |ol| | required | ||
| bulleted | |bullet| | required | |
| |ul| | required | ||
| item | |item| | none | |
| |li| | none | ||
| |& | none | ||
All will take additional styling (see ‘Explicit Styling’ in 2.2 Text Highlight)
Quick Reference Tables | |||
Tables | |||
| Description | Syntax | Closure | Reference |
| begin table | |table| | required | 3. Tables |
| |tabular| | required | ||
| begin row | |~ | none | |
| |tr| | none | ||
| |row| | none | ||
| header cell | |:| | none | |
| |th| | none | ||
| |head| | none | ||
| data cell | |.| | none | |
| |td| | none | ||
| |data| | none | ||
All will take additional styling (see ‘Explicit Styling’ in 2.2 Text Highlight)
Quick Reference Links | |||
Links | |||
| Description | Syntax | Closure | Reference |
| external resource | |link|https://host/path| | implied | 4. Links |
| external with description | |link|https://host/path|\ A link to WASD| | implied | |
| external in new page | |link%|https://host/path| | implied | |
| internal reference | |link|Document Style| | implied | |
| to equivalent fragment | |link|#documentstyle| | implied | |
| to another document | |link|../doc_two/\ #Somewhere Inside It|\ This is another document| | implied | |
| another in new page | |link%|../doc_two/\ #Somewhere Inside It|\ This is another document| | implied
Quick Reference Various | |
Various | |||
| Description | Syntax | Closure | Reference |
| text as-is | |=...| | required | 2.8 |" and |asis| |
| insert data | |insert|keyword=| | implied | 2.7 Insertion |
| |insert|spawn=DCL command| | implied | 2.7.1 Spawned Command | |
| insert image | |image|image URI/L | implied | 2.10 Images |
| draw box diagram | |draw| | required | 2.11 Box Drawing |
| comment line | |// | none | 7.1 Control
Quick Reference Control |
Control | |||
| Description | Syntax | Closure | Reference |
| break source | |break| | implied | |
| exit document processing | |exit| | implied | |
| tag stack | |insight!| | implied | 7.3 Document Insights |
| text and HTML reveal | |insight@| | implied | |
| only when printed | |print| | implied | |
| omit when printed | |noprint| | implied
Quick Reference Settings | |
Settings | |||
| Description | Syntax | Closure | Reference |
| document in major sections | |set|chunked=-1| | implied | ‘Settings’ in 7.1 Control |
| |set|chunked=0| | |||
| |set|chunked=1| | |||
| index of content columns | |set|idx=cols=integer| | implied | 6.4 Document Index |
| |set|idx=collate=| | |||
| informational content | |set|insight=integer| | implied | 7.3 Document Insights |
| localization | |set|locale=string| | implied | |
| navigation arrows | |set|navigate=0| | implied | |
| |set|navigate=1| | |||
| |set|navigate=2| | |||
| default note heading | |set|note=Attention!| | implied | |
| pagination | |set|paginate=1| | implied | |
| dynamic review period | |set|review=number| | implied | |
| document as if static | |set|static=1| | implied | |
| set default table margin | |set|table=flag| | implied | |
| explicit document title | |set|title=This Is The Title| | implied | |
| table of content columns | |set|toc=cols=integer| | implied | 6.1 Primary TOC |
| table of content format | |set|toc=format=string| | ||
| secondary TOC | |set|toc2=1| | implied | 6.2 Secondary TOC |
| |set|toc2=2| | |||
| |set|toc2=cols=| | |||
| set a FLAG value | |set|AFLAG=integer| | implied | 7.2 FLAGs |
| |set|AFLAG=string| | |||
| ↩︎ | ↖︎ | ↑︎ | ↘︎ | ↪︎ |