doc/ikiwiki/formatting.mdwn

   1 [[!meta title="Formatting wiki pages"]]
   2 [[!meta robots="noindex, follow"]]
   3
   4 Text on this wiki is, by default, written in a form very close to how you
   5 might write text for an email message. This style of text formatting is
   6 called [[MarkDown]], and it works like this:
   7
   8 Leave blank lines between paragraphs.
   9
  10 You can *\*emphasise\** or **\*\*strongly emphasise\*\*** text by placing it
  11 in single or double asterisks.
  12
  13 -----
  14 **Open-source software** may be developed in a *collaborative* public manner.
  15 ---
  16 To create a list, start each line with an asterisk:
  17
  18 * "* this is my list"
  19 * "* another item"
  20
  21 To make a numbered list, start each line with a number (any number will
  22 do) followed by a period:
  23
  24 1. "1. first line"
  25 2. "2. second line"
  26 2. "2. third line"
  27
  28 To create a header, start a line with one or more `#` characters followed
  29 by a space and the header text. The number of `#` characters controls the
  30 size of the header:
  31
  32 # # h1
  33 ## ## h2
  34 ### ### h3
  35 #### #### h4
  36 ##### ##### h5
  37 ###### ###### h6
  38
  39 To create a horizontal rule, just write three or more dashes or stars on
  40 their own line:
  41
  42 ----
  43
  44 To quote someone, prefix the quote with ">":
  45
  46 > To be or not to be,
  47 > that is the question.
  48
  49 To write a code block, indent each line with a tab or 4 spaces:
  50
  51         10 PRINT "Hello, world!"
  52         20 GOTO 10
  53
  54 To link to an url or email address, you can just put the
  55 url in angle brackets: <<http://ikiwiki.info>>, or you can use the
  56 form \[link text\]\(url\)
  57
  58 ----
  59
  60 In addition to basic html formatting using [[MarkDown]], this wiki lets
  61 you use the following additional features:
  62
  63 * To link to another page on the wiki, place the page's name inside double
  64   square brackets. So you would use `\[[WikiLink]]` to link to [[WikiLink]].
  65
  66 [[!if test="enabled(smiley) and smileys" then="""
  67 * Insert [[smileys]] and some other useful symbols. :-)
  68 """]]
  69
  70 [[!if test="enabled(shortcut) and shortcuts" then="""
  71 * Use [[shortcuts]] to link to common resources.
  72
  73         \[[!wikipedia War\_of\_1812]]
  74 """]]
  75
  76 [[!if test="enabled(template) and templates" then="""
  77 * Create and fill out [[templates]] for repeated chunks of
  78   parameterized wiki text.
  79 """]]
  80
  81 * Insert various [[directives|directive]] onto a page to perform useful
  82   actions.
  83 [[!if test="enabled(toc) or enabled(meta) or enabled(inline)" then="""
  84   For example, you can:
  85 """]]
  86
  87 [[!if test="enabled(toc)" then="""
  88   * Add a table of contents to a page:
  89
  90         \[[!toc]]
  91 """]]
  92
  93
  94 [[!if test="enabled(meta)" then="""
  95   * Change the title of a page:
  96
  97         \[[!meta title="full page title"]]
  98 """]]
  99
 100 [[!if test="enabled(inline)" then="""
 101   * Create a blog by inlining a set of pages:
 102
 103         \[[!inline pages="blog/*"]]
 104 """]]
 105
 106 [[!if test="enabled(listdirectives)" then="""
 107   Full list of [[directives|directive]] enabled for this wiki:
 108   [[!listdirectives ]]
 109 """]]