Page Styles
Table of Contents
- Each page starts with a table of contents
Headings
At top of a page heading 1 or 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 3 follows heading 2, not heading 4 follows heading 2
Ordered and unordered Lists
- Text lines should be grouped in unordered lists where applicable
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 is not being used for markup except in headings, i.e. page headings, table headings etc.
- Understrike is not being used.
- Subscript is not being used.
- Superscript is used exclusively for footnotes.
Strikethroughis used to invalidate specific terms or sentences.- Font colors are not being used except for rare cases of error messages. A wiki article is targeted at structured content not at layout.
Character Styles
- Uppercase letters
- Uppercase letters are used exclusively when technically required, e.g. for environment variables.
- Uppercase letters sholuld not be used for emphasis, e.g. do not use "WITHOUT WARRANTY".
Spelling
- Use of dashes
- Dashes are rarely used in English, therefore they should not be "imported" from German.
- Use of comma
- Commas are rarely used in English, therefore they should not be "imported" from German.
- Writing in one word or multiple words
- German rules for writing in one word would not apply for English, therefore use "job chain" instead of "jobchain"