Wiki Team/Guide/Formatting

From Sugar Labs
< Wiki Team‎ | Guide
Revision as of 09:31, 16 May 2008 by Eric Myers (talk | contribs) (summary of wiki formatting)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

For a quick overview of wiki markup see the Wiki Quickie!

Text will show up just as you type it (provided you begin it in the first column). Multiple spaces are compressed, and line endings are ignored (except blank lines).

Use a blank line to start a new paragraph. Multiple blank lines add more vertical space.

Wiki markup code is supposed to be simple and easy to learn. You can also use most HTML markup, if you prefer it, except for links.


Use these to change fonts:

Description You type You get
Italic text ''italic'' italic
Bold text '''bold''' bold
Bold and italic '''''bold & italic''''' bold & italic
Fixed-width <tt>fixed width font </tt> fixed width font
underscore <u>underscored text</u> underscored text


It is often useful to divide articles into sections and subsections. The following markup can be used. You must begin these on a new line.

Heading You type You get HTML tags
level 1 ==Section heading==

Section heading

level 2 ===Subsection heading===

Subsection heading

level 3 ====Sub-sub section heading====

Sub-sub section heading

level 4 =====Sub-sub-sub section heading=====
Sub-sub-sub section heading

An article with four or more headings will automatically create a table of contents. Using HTML heading tags also creates proper section headings and a table of contents entry.


Wiki markup makes lists fairly easy:

List type You type: You get:
Bullet list

* one
* two
* three
** three and one-third
** three and two-thirds

  • one
  • two
  • three
    • three and one-third
    • three and two-thirds
Numbered list

# one
# two<br>spanning several lines<br>
without breaking the numbering
# three
## three point one
## three point two

  1. one
  2. two
    spanning several lines
    without breaking the numbering
  3. three
    1. three point one
    2. three point two
Mixture of bulleted
and numbered lists

# one
# two
#* two point one
#* two point two

  1. one
  2. two
    • two point one
    • two point two
Definition list

:item 1
:item 2

item 1
item 2
  • HTML lists are also allowed
  • Blank lines should be avoided, they break list numbering and sub-list. Use <br> instead.


Linking is covered in a separate page: Help:Links

Code Examples

Text which does not begin in the first column will be shown indented, in a fixed width font. This is appropriate for showing computer code or command examples, such as this famous little program:

    printf("Hello, World!\n");


Tables are covered in a separate page: Help:Tables

See Also