Formatting Style
This page describes how documentation pages in this Wiki should be formatted to create a consistent look and feel. Alongside, examples on how to use Wiki syntax to do this are provided.
Look at the pages of the Users Guide and get a feeling of how they are structured and where which formatting technique is employed.
This wiki uses the MediaWiki syntax. Some basic formatting is taught here.
Stucturing a page is easy with Titles as sub-title. A line that begins with at least two consecutive equal signs (=) an ends with the same amount of equal signs.
== Heading == === Sub-heading === ==== Sub<sup>2</sup>-heading ====
Each Heading is included in the Contents box that is placed at the top of the page.
As with HTML newlines within a paragraph are ignored. To start a new paragraph, two newlines may be used.
Followed by another one.
Lists are created by beginning a line with an asterisk (*) for a bullet list or a hash mark (#) for a numbered list.
# This is a # numbered # list
- This gives a
- list with bullets
- and sub-lists
- and sub2-lists
- and sub-lists
- This is a
- numbered
- list
List items are indented according to the number of asterisks or hash marks at the beginning of the line.
For code listings and console interaction preformatted paragraphs are your friend. Consecutive lines that start with a space character ( ) are logically and visually grouped into a block of preformatted text where whitespace is preserved and wiki formatting commands are not interpreted.
I can have as many spaces as I want.
To write a word or paragraph in oblique letters, enclose them by two pairs of apostrophes (''). Italic text may be used to highlight examplatory information that should be replaced by the user with actual information.
To change the current working directory, use the command <tt>cd ''directory''</tt>.
To write a word or paragraph in bold letters, enclose them by two tripples of apostrophes ('''). Bold text may be used to highlight certain important pieces of information.
The compiled object code will be put into the file '''main.o'''.
To write a word or paragraph in monospaced letters, enclose them by <tt> and </tt> tags. Monospaced text may be used to write code examples or console interaction within prosaic text.
To get a list of all files in a directory with their meta-data, use <tt>ls -l</tt>.