basewiki/helponformatting.mdwn

   1 # Help on formatting text
   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
  33 To create a horizontal rule, just write three or more dashes on their own
  34 line:
  35
  36 ----
  37
  38 To quote someone, prefix the quote with ">":
  39
  40 > To be or not to be,
  41 > that is the question.
  42
  43 To write a code block, indent each line with a tab or 4 spaces:
  44
  45         10 PRINT "Hello, world!"
  46         20 GOTO 10
  47
  48 To link to another page on the wiki, place the page's name inside double
  49 square brackets, so you would use `\[[WikiLink]]` to link to [[WikiLink]].
  50
  51 To link to any other web page, or to an email address, you can just put the url in angle brackets: <<http://ikiwiki.kitenet.net>>, or you can use the form
  52 \[link text\]\(url\)
  53
  54 ----
  55
  56 Advanced users can use [[PreProcessorDirective]]s to do additional cool
  57 stuff.
  58
  59 Also, if the smiley plugin is enabled in your wiki, you can insert
  60 [[smileys]] and some other useful symbols.