...
- Each page starts with a table of contents should mote more than two headings be used in that page.
...
At the top of a page the styles for heading Heading 1 or heading Heading 2 are used
- Headings are used in strict descending order
- headings are not used for layout reasons but for better structure of the page content
- a heading Heading 3 follows heading Heading 2, not: heading Heading 4 follows heading Heading 2
Ordered and
...
Unordered Lists
- Text should be grouped in unordered lists where applicable
- Such grouping is not intended for better layout but for a better structure of the presentation
- Try to group your thoughts accordingly, add hierarchies.
Element Styles
Markup
| Group | Element | Style | Example | Explanation |
|---|---|---|---|---|
| General | file name | italic | factory.ini | Paths for file names should start from an absolute directory that is usually specified by an environment variable, e.g. use $SCHEDULER_DATA/config/factory.ini instead of ./config/factory.ini. |
| environment variable | uppercase italic | $SCHEDULER_HOME | Environment variables are stated with a leading $ as used for Unix systems | |
| command line | italic | ./setup.sh | ||
| Parameters | parameter name | italic | command | |
| parameter value | monospace | select sysdate from dual | ||
| Code | any | monospace | var myNum = 25; | Code should be used with the Code Macro |
Bold should not be used for markup except in headings, i.e. page headings, table headings etc.
- Understrike should not be used.
- Subscript should not be used.
- Superscript is used exclusively for footnotes.
Strikethroughis used to invalidate specific terms or sentences.- Font colors are not used except for rare cases of error messages. A wiki article is targeted at structured content not at layout.
...