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.

Table of Contents General Style Document Structure Headings Heading Sub-heading Sub2-heading Paragraphs Lists Preformatted paragraphs Text Decorations Italic Text Bold Text Monospaced Text

General Style

Look at the pages of the Users Guide and get a feeling of how they are structured and where which formatting technique is employed.

Document Structure

This wiki uses the MediaWiki syntax. Some basic formatting is taught here.

Headings

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 ====

Heading

Sub-heading

Sub²-heading

Each Heading is included in the Contents box that is placed at the top of the page.

Paragraphs

As with HTML newlines within a paragraph are ignored. To start a new paragraph, two newlines may be used.

 Followed by another one.

This is a single paragraph written on two lines. Followed by another one.

Lists

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 sub²-lists

1. This is a
2. numbered
3. list

List items are indented according to the number of asterisks or hash marks at the beginning of the line.

Preformatted paragraphs

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.

This i s preformatted t e x t. I can have as many spaces as I want.

Text Decorations

Italic Text

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 change the current working directory, use the command cd ''directory''.

Bold Text

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'''.

The compiled object code will be put into the file main.o.

Monospaced Text

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>.

To get a list of all files in a directory with their meta-data, use ls -l.