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