tag some potential candidates for the Google Summer of Code

[ikiwiki.git] / doc / helponformatting.mdwn

diff --git a/doc/helponformatting.mdwn b/doc/helponformatting.mdwn
index 2238fcbfefc4a664c9637f6ed657b5d0d1bcd01b..862e66561f59a991692a4c220bdc6b6fc02a74ad 100644 (file)
--- a/doc/helponformatting.mdwn
+++ b/doc/helponformatting.mdwn
@@ -1,7 +1,8 @@
-## Help on formatting text
+# Help on formatting text

 
 

-Text on this wiki is written in a form very close to how you might write
-text for an email message.
+Text on this wiki is, by default, written in a form very close to how you
+might write text for an email message. This style of text formatting is
+called [[MarkDown]], and it works like this:

 
 Leave blank lines between paragraphs.
 
 
 Leave blank lines between paragraphs.
 


@@ -10,26 +11,44 @@ in single or double asterisks.
 
 To create a list, start each line with an asterisk:
 
 
 To create a list, start each line with an asterisk:
 

-* \* this is my list
-* \* another item
+* "* this is my list"
+* "* another item"

 
 To make a numbered list, start each line with a number (any number will
 do) followed by a period:
 
 
 To make a numbered list, start each line with a number (any number will
 do) followed by a period:
 

-1. 1\. first line
-2. 2\. second line
-2. 2\. third line
+1. "1. first line"
+2. "2. second line"
+2. "2. third line"

 
 To create a header, start a line with one or more `#` characters followed
 by a space and the header text. The number of `#` characters controls the
 size of the header:
 
 
 To create a header, start a line with one or more `#` characters followed
 by a space and the header text. The number of `#` characters controls the
 size of the header:
 

-## h2
-### h3
-#### h4
+# # h1
+## ## h2
+### ### h3
+#### #### h4
+##### ##### h5
+###### ###### h6

 
 

-To create a horizontal rule, just write three or more dashes on their own
-line:
+You can also make the first two levels of heading by underlining text with
+equals or dash:
+
+heading 1
+=========
+
+    heading 1
+    =========
+
+heading 2
+---------
+
+    heading 2
+    ---------
+
+To create a horizontal rule, just write three or more dashes or stars on
+their own line:

 
 ----
 
 
 ----
 


@@ -38,18 +57,23 @@ To quote someone, prefix the quote with ">":
 > To be or not to be,
 > that is the question.
 
 > To be or not to be,
 > that is the question.
 

-To write a code block, indent each line with a tab:
+To write a code block, indent each line with a tab or 4 spaces:

 
        10 PRINT "Hello, world!"
        20 GOTO 10
 
 To link to another page on the wiki, place the page's name inside double
 
        10 PRINT "Hello, world!"
        20 GOTO 10
 
 To link to another page on the wiki, place the page's name inside double

-square brackets to create a [[[[WikiLink]]]].
+square brackets, so you would use `\[[WikiLink]]` to link to [[WikiLink]].

 
 

-To link to any other web page, you can just put the url in angle brackets:
-<<http://ikiwiki.kitenet.net>>, or you can use the form
-\[link text\]\(url\)
+To link to any other web page, or to an email address, you can just put the
+url in angle brackets: <<http://ikiwiki.info>>, or you can use the
+form \[link text\]\(url\)

 
 ----
 
 
 ----
 

-This style of text formatting is called [[MarkDown]].
+You can also use [[PreProcessorDirective]]s to do additional cool stuff.
+
+[[if test="enabled(smiley)"  then="""
+Also, because this wiki has the smiley plugin enabled, you can
+insert [[smileys]] and some other useful symbols.
+"""]]