User Tools

Site Tools


wiki_help:syntax

Formatting Syntax

SHIFTWiki supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing the Edit this page button at the top or bottom of the page. If you want to try something, just use the playground page.

Basic text formatting

SHIFTWiki supports bold, italic, underlined and monospaced texts. Of course you can combine all these.

SHIFTWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
Of course you can **__//''combine''//__** all these.

You can use subscript and superscript, too.

You can use <sub>subscript</sub> and <sup>superscript</sup>, too.

You can mark something as deleted as well.

You can mark something as <del>deleted</del> as well.

Paragraphs are created from blank lines. If you want to force a newline without a paragraph, you can use two backslashes followed by a whitespace or the end of line.

This is some text with some linebreaks
Note that the two backslashes are only recognized at the end of a line
or followed by
a whitespace \\this happens without it.

This is some text with some linebreaks\\ Note that the
two backslashes are only recognized at the end of a line\\
or followed by\\ a whitespace \\this happens without it.

You should use forced newlines only if really needed.

SHIFTWiki supports multiple ways of creating links.

External

External links are recognized automagically: http://www.shift2bikes.org or simply www.shift2bikes.org - You can set Linknames, too: This Link points to SHIFT. Email addresses like this one: webteam [at] shift2bikes [dot] org are recognized, too.

DokuWiki supports multiple ways of creating links. External links are recognized
automagically: http://www.shift2bikes.org or simply www.shift2bikes.org - You can set
Linknames, too: [[http://www.shift2bikes.org|This Link points to SHIFT]]. Email
addresses like this one: <webteam@shift2bikes.org> are recognized, too.

Internal

Internal links are created by using square brackets. You can either just give a playground or use an additional Title Text. Wiki pagenames are converted to lowercase automatically, special characters are not allowed.

Internal links are created by using square brackets. You can either just give
a [[playground:allplayzone]] or use an additional [[playground:playground|AllPlayZone]]. Wiki pagenames
are converted to lowercase automatically, special chars are not allowed.

You can use playground by using a colon in the pagename.

You can use [[playground:playground]] by using a colon in the pagename.

For details about namespaces see namespaces.

Linking to a specific section is possible, too. Just add the section name behind a hash character. This links to this Section.

This links to [[syntax#internal|this Section]].

Notes:

  • Links to existing pages are shown in a different style from nonexisting ones.
  • When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.

You can also use an image to link to another internal or external page by combining the syntax for links and images (see below) like this:

[[http://shift2bikes.org|{{wiki_help:shiftlogo_heart.jpg}}]]

shiftlogo_heart.jpg

Please note: The image formatting is the only formatting syntax accepted in link names.

The whole image and link syntax is supported (including image resizing, internal and external images and URLs and interwiki links).

Footnotes

You can add footnotes 1) by using double parentheses.

You can add footnotes ((This is a footnote)) by using double parentheses.

Sectioning

You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically – this can be disabled by including the string ~~NOTOC~~ in the document.

Headline Level 3

Headline Level 4

Headline Level 5
==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==

By using four or more dashes, you can make a horizontal line:


Images and other files

You can include external and internal wiki:images with curly brackets. Optionally you can specify the size of them.

Real size: shiftlogo_hand.jpg

Resize to given width: shiftlogo_hand.jpg

Resize to given width and height: shiftlogo_hand.jpg

Resized external image:

Real size:                        {{wiki_help:shiftlogo_hand.jpg}}
Resize to given width:            {{wiki_help:shiftlogo_hand.jpg?50}}
Resize to given width and height: {{wiki_help:shiftlogo_hand.jpg?102x35}}
Resized external image:           {{http://www.php.net/images/php.gif?200x50}}

By using left or right whitespaces you can choose the alignment.

shiftlogo_hand.jpg

shiftlogo_hand.jpg

shiftlogo_hand.jpg

{{ wiki_help:shiftlogo_hand.jpg}}
{{wiki_help:shiftlogo_hand.jpg }}
{{ wiki_help:shiftlogo_hand.jpg }}

Of course, you can add a title (displayed as a tooltip by most browsers), too.

This is the caption

{{ wiki_help:shiftlogo_hand.jpg |This is the caption}}

If you specify a filename (external or internal) that is not an image (gif, jpeg, png), then it will be displayed as a link instead.

For linking an image to another page see Image Links above.

Lists

Ordered and unordered lists are supported. To create a list item, indent your text by two spaces and use a * for unordered lists or a - for ordered ones.

  • This is a list
  • The second item
    • You may have different levels
  • Another item
  1. The same list but ordered
  2. Another item
    1. Just use indention for deeper levels
  3. That's it
  * This is a list
  * The second item
    * You may have different levels
  * Another item

  - The same list but ordered
  - Another item
    - Just use indention for deeper levels
  - That's it

Smileys

SHIFTWiki converts commonly used emoticons to their graphical equivalents. Here is an overview of Smileys.

  • 8-) 8-)
  • 8-O 8-O
  • :-( :-(
  • :-) :-)
  • =) =)
  • :-/ :-/
  • :-\ :-\
  • :-? :-?
  • :-D :-D
  • :-P :-P
  • :-O :-O
  • :-X :-X
  • :-| :-|
  • ;-) ;-)
  • ^_^ ^_^
  • :?: :?:
  • :!: :!:
  • LOL LOL
  • FIXME FIXME
  • DELETEME DELETEME

Typography

SHIFTWiki can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought 'It's a wonderful world'…”

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a wonderful world'..."

Quoting

Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

I think we should do it

No we shouldn't
Well, I say we should
Really?
Yes!
Then lets do it!

Tables

You can create tables with some simple syntax like in the examples below.

Heading 1 Heading 2 Heading 3
Row 1 Col 1 Row 1 Col 2 Row 1 Col 3
Row 2 Col 1 some colspan (note the double pipe)
Row 3 Col 1 Row 2 Col 2 Row 2 Col 3

Table rows have to start and end with a | for normal rows or a ^ for headers.

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
| Row 2 Col 1    | some colspan (note the double pipe) ||
| Row 3 Col 1    | Row 2 Col 2     | Row 2 Col 3        |

To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!

Vertical tableheaders are possible, too.

Heading 1 Heading 2
Heading 3 Row 1 Col 2 Row 1 Col 3
Heading 4 no colspan this time
Heading 5 Row 2 Col 2 Row 2 Col 3

As you can see, it's the cell separator before a cell which decides about the formatting:

|              ^ Heading 1            ^ Heading 2          ^
^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
^ Heading 4    | no colspan this time |                    |
^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |

Note: Vertical spans (rowspan) are not possible.

You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.

Table with alignment
right center left
left right center
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

This is how it looks in the source:

^           Table with alignment           ^^^
|         right|    center    |left          |
|left          |         right|    center    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Non-parsed Blocks

You can include non-parsed blocks into your documents by either indenting them by at least two spaces (as used in the above examples) or by using the tags <code> or <file>.

This is preformatted code all spaces are preserved: like              <-this
This is pretty much the same, but you could use it to show that you quoted a file.  

To let the parser ignore an area completely (ie. do no formatting on it), enclose the area either with nowiki tags or even simpler, with double percent signs %%.

1) This is a footnote
wiki_help/syntax.txt · Last modified: 07 Sep 2015 06:49pm (external edit)