Wiki Formatting Guide

1.Wikies, the Easy Way
2.PRE-Format
2.Page-Brake by Printing
2.Paragraphs
3.Headings
4.Chapter Heading Type 1
4.1Section Heading Type 2
5.Lists
5.1Itemized Lists
5.2Ordinated Lists
6.Footnotes
6.1Preventing Footnotes
7.Tables
8.Rulers
9.Text Formatting
10.Images
10.1Aligned Images
11.Auto Replacement
11.1Mail Addresses
11.2External Links
12.New Wikis
13.Table of Content Generation
14.Meta Data Generation
14.1Keywords

Pre...formatet

Use _ (underline)

_My first paragraph starts
_with three lines of text
_which become one in html.

This looks like:

My first paragraph starts
with three lines of text
which become one in html.

Use #- to start and end for Pre...formatet

#-
a ds ds fsdfas
ads fadsf sd a
a ds ds fsdfas
ads fadsf sd a
#-

This looks like:

a ds ds fsdfas
ads fadsf sd  a
a ds ds fsdfas
ads fadsf sd  a

Page-Brake by Printing

Use -_-_

For a Pagebrake by printing the page use -_-_ and the browser make a pagebrake by printing the document. This have no resultat by make a pdf with the implementet pdf generator (its not a print, its a convert).)

Paragraphs

A new paragraph is started by inserting an empty line after the last text block.

 My first paragraph starts
 with three lines of text
 which become one in html.

 My second paragraph starts now.
 ...

This looks like:

My first paragraph starts with three lines of text which become one in html.

My second paragraph starts now. ...

Headings

Headings are done by inserting minus characters at the beginning of line.

 - Chapter Heading Type 1
 -- Section Heading Type 2
 --- Subsection Heading Type 3

This looks like:

Chapter Heading Type 1

Section Heading Type 2

Subsection Heading Type 3

Lists

Itemized or numbered lists can be done by indenting the line by two spaces and inserting a star * or a 1 before the text. Several rows of indentation are possible.

Itemized Lists

   * Item 1 in itemized list
   * Item 2 in itemized list
     * Item 1 in itemized list beyond Item 2
       * Item 1 in itemized list beyond Item 1 beyond Item 2
     * Item 2 in itemized list beyond Item 2
   * Item 3 in itemized list beyond Item 2

• Item 1 in itemized list
• Item 2 in itemized list
  • Item 1 in itemized list beyond Item 2
    • Item 1 in itemized list beyond Item 1 beyond Item 2
  • Item 2 in itemized list beyond Item 2
• Item 3 in itemized list beyond Item 2

Ordinated Lists

   1 Item 1 in numbered list
   1 Item 2 in numbered list
     1 Item 1 in numbered list beyond Item 2
       1 Item 1 in numbered list beyond Item 1 beyond Item 2
     1 Item 2 in numbered list beyond Item 2
   1 Item 3 in numbered list beyond Item 2

1. Item 1 in numbered list
2. Item 2 in numbered list
   1. Item 1 in numbered list beyond Item 2
      1. Item 1 in numbered list beyond Item 1 beyond Item 2
   2. Item 2 in numbered list beyond Item 2
3. Item 3 in numbered list beyond Item 2

Footnotes

Many texts require footnotes for references to other documents or short explanations. This is easily done by surrounding the footnote text with sqare brackets.

 To be or not to be [This is the question]. Questions. Questions.

This looks like:

To be or not to be ¹¹: This is the question. Questions. Questions.

Preventing Footnotes

Using square brackets causes the Wiki SH to make a footnote. If this is, for some reason, not wanted, the footnoting can temporarily turned off by doubling the square brackets.

 This is a [Footnote]. This is a text with [[square brackets]]

This looks like:

This is a ²²: Footnote. This is a text with [square brackets]

Tables

Simple tables can be created using pipe characters to seperate each table cell. The first row of the table is automatically rendered as the table header row. Only ortogonal tables can be created.

 | Column 1 Header       | Column 2 Header       | Column 3 Header |
 | content               | content               | content         |
 | content               | content               | content         |
 | content               | content               | content         |
 | content               | content               | content         |

This looks like:

Rulers

Horizontal rulers are created if four minus characters appear at the beginning of line.

 Text before the ruler
 ----
 Text beyond

This looks like the ruler below:

Text Formatting

Text can be formatted easily by surrounding the word with quotes.

 '''This is bold text'''
 ''This is italian text''

Looks like This is bold text and This is italian text.

Images

By typing a complete url which points to an image file with PNG, GIF or JPG extension the image is loaded directly into the page.

 http://www.wasduwillst.de/freebsd.gif

That looks like (not me by the way):

For nicer placement of images there are three other ways to embed images. The centered image get's an own paragraph and will not be surrounded by text. This is useful for thesis works. The left- and right aligned images embed themselves into the floating text.

Aligned Images

 s-http://www.wasduwillst.de/freebsd.gif
 c-http://www.wasduwillst.de/freebsd.gif
 l-http://www.wasduwillst.de/freebsd.gif
 r-http://www.wasduwillst.de/freebsd.gif

This looks like:

Below is a centered image. Below is a centered image. Below is a centered image. Below is a centered image. Below is a centered image. Below is a centered image. Below is a centered image. Below is a centered image. Below is a centered image. Below is a centered image. Below is a centered image. Below is a centered image. ³³: This is the centered image Here comes some text. Here comes some text. Here comes some text. Here comes some text. Here comes some text. Here comes some text. Below and left aligned is an image. Below and left aligned is an image. Below and left aligned is an image. Below and left aligned is an image. Below and left aligned is an image. Below and left aligned is an image. ⁴⁴: This is the left aligned image Here comes the right aligned image. Here comes the right aligned image. Here comes the right aligned image. Here comes the right aligned image. ⁵⁵: This is the right aligned image Here comes the right aligned image. Here comes the right aligned image. Here comes the right aligned image. Here comes the right aligned image. Here comes the right aligned image. Here comes the right aligned image. Here comes the right aligned image. Here comes the right aligned image. Here comes the right aligned image. Here comes the right aligned image. ⁵⁵: This is the right aligned image Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px Here comes the right smal thumbnail it is always 250px

Auto Replacement

Mail Addresses

 mailto:you@somehost.org 

The mailto links will be replaced by a robot hidden secure mailto link that appears like: you ^AT somehost.org

External Links

 http://www.google.com

Ftp and Http links will be replaced by an external link, that pops up a new window when clicking it. Example: http://www.google.com

New Wikis

To create new Wiki pages capitalized words have to be joined.

Example:

Step 1: A Wiki page named `What is Wiki' shall be linked. It already exists and can be linked by joining the words.

 WhatIsWiki

This looks like:

Step 2: A new Wiki page named `My New Wiki' shall be created. Joining the three words results in a new Edit link.

 MyNewWiki

This looks like:

Clicking on it leads to the Create new Wiki page. By the way in this case the edit feature is only accessible for registered users.

Table of Content Generation

It is often reasonable for large documents to have a table of contents. The collects all level one and two headers, generates targets for them and a table of content. To show it in the document just insert the following tag. The text before the colon is inserted as a header for the table of content. The following example generates a TOC for this document:

 [My Table of Contents:TOC]

This looks like:

My Table of Contents