Help:Formatting
From PixieWiki
The most important rules are very simple:
- Empty lines separate paragraphs.
- Paragraphs may span several lines.
- Paragraphs begin in column 1.
With these three simple rules, you can already start writing text.
Contents |
[edit] Local Links
Local pages are linked using various link patterns.
Words in double square brackets are links to local pages. These square brackets will not be rendered if the page exists, since this links to a local page.
[[FormattingRules]]
Result:
The display can be altered such that a more descriptive text is shown;
FormattingRules
Result:
[[FormattingRules|These are the formatting rules]]
[edit] URLs
Plain URLs get hyperlinked.
Example:
http://www.george-graphics.co.uk/
Result:
http://www.george-graphics.co.uk/
Plain URLs ending in an image suffix will inline the image.
Example:
http://www.george-graphics.co.uk/pixiewiki/Pixie_backdrop.jpg
Result:
http://www.george-graphics.co.uk/pixiewiki/Pixie_backdrop.jpg
Plain URLs in square brackets turn into numbered links, looking like footnotes.
Example:
[[http://www.george-graphics.co.uk/]]
Result:
[[1]]
Plain URLs plus some text in square brackets result in the text being linked to the URL. The square brackets will remain visible in order to distinguish these links from links to local pages.
Example:
[[http://www.george-graphics.co.uk/ george-graphics site]]
Result:
[edit] Bullet List
List items start with one or more asterisks (*). The number of asterisks indicates the indentation level. An empty line ends the list.
Example:
* One item * Another item ** One More
Result:
- One item
- Another item
- One More
[edit] Numbered List
Numbered list items start with one or more hashes (#). The number of hashes indicates the indentation level. An empty line ends the list.
Example:
# One item # Another item ## One More
Result:
- One item
- Another item
- One More
[edit] Definition List
Definition lists start with a semicolon (;), and a colon (:) between term and definition. The number of semicolons indicates the indentation level. An empty line ends the list.
Example:
;foo: a generic placeholder ;bar: a generic placeholder ;;baz: a variation
Result:
- foo
- a generic placeholder
- bar
- a generic placeholder
- baz
- a variation
[edit] Tables
Table rows start with a vertical bar (|), with two vertical bars between cells (||). Headings begin with an exclamation mark (!) and are separated by two (!!). Rows are separated by a bar and a hyphen (|-). The table starts with ({|) and ends with (|}). Sound complicated? Start by copying the one below, which also has a nice style attached to it. Then expand from there.
Example:
{| class="wikitable"
|-
! Heading !! another !! a third
|-
| item || item2 || item3
|-
| b item || b item2 || b item3
|-
|}
Result:
| Heading | another | a third |
|---|---|---|
| item | item2 | item3 |
| b item | b item2 | b item3 |
[edit] Indented Paragraphs
Indented paragraphs start with one or more colons (:). The number of colons indicates the indentation level. An empty line ends the indented paragraph.
Example:
: One item : Another item :: One More
Result:
- One item
- Another item
- One More
[edit] Headings
Headings are enclosed in equal signs (=) on a line of their own. You can use up to six equal signs to produce headers of level one to six. Level one is the most important one, and should not be used because the page title already uses a level one heading. Using two or three equal signs is recommended (== like this ==).
Example:
=== Heading 3 === ==== Heading 4 ====
Result:
[edit] Heading 3
[edit] Heading 4
[edit] Horizontal line
Four or more consecutive hyphens on a line of their own (----) are replaced with a horizontal line.
Example:
----
Result:
[edit] Source code
Lines starting with spaces are shown using a fixed width font with whitespace preserved. I suggest to use uniform indentation of four spaces.
Example:
foo bar
Result:
foo bar
[edit] Traditional wiki markup
Two and three apostrophes are used for emphasis and strong emphasis.
Example:
''two apostrophes''' and ''three apostrophes'''
Result:
two apostrophes and three apostrophes
[edit] HTML tags
Some HTML tags are also allowed. These tags are used exactly like HTML tags.
Example:
<b>this will be bold</b>
Result:
this will be bold
Supported tags without extra configuration:
- em
- Emphasis (usually italics)
- i
- Italics
- strong
- Strong (usually bold)
- b
- Bold
- tt
- Teletype (usually monospaced)
[edit] Disable Text Formatting Rules
The following tags will disable text formatting rules:
- nowiki
- disable text formatting rules
- code
- monospaced font, but allow text formatting rules
- pre
- monospaced fonts, no line wrapping, disable text formatting rules
Example:
<nowiki>[[foo]]</nowiki>
Result:
[[foo]]
[edit] Images
The syntax for displaying an image is:
[[Image:{name}|{type}|{location}|{size}|{caption}]]
Only [[Image:{name}]] is required. The other details are optional and can be placed in any order.
- Type
- 'thumb' / 'thumbnail' or 'frame'. Causes image to be displayed with specific formatting (see below).
- Location
- 'right', 'left', 'center' or 'none'. Determines placement of the image on the page.
- Size
- {width}px (e.g. 50px), scales the image to the given width, keeping its aspect ratio.
- Caption
- Any element which cannot be identified as one of the above is assumed to be caption text.
[edit] See Also
There is additional information on MediaWiki's site at [[2]]
