doc/ikiwiki/formatting.mdwn

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