web commit by http://adam.shand.net/

[git.ikiwiki.info.git] / doc / helponformatting.mdwn

diff --git a/doc/helponformatting.mdwn b/doc/helponformatting.mdwn
index 4ef41d16fcb15b71437d86c21941a76bef76da00..6c0cc9df860466c49066dbc5958e244f9a79298c 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.
 


@@ -24,12 +25,15 @@ 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:
 
 by a space and the header text. The number of `#` characters controls the
 size of the header:
 

+# # h1

 ## ## h2
 ### ### h3
 #### #### h4
 ## ## h2
 ### ### h3
 #### #### h4

+##### ##### h5
+###### ###### h6

 
 

-To create a horizontal rule, just write three or more dashes on their own
-line:
+To create a horizontal rule, just write three or more dashes or stars on
+their own line:

 
 ----
 
 
 ----
 


@@ -38,7 +42,7 @@ 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
 
        10 PRINT "Hello, world!"
        20 GOTO 10


@@ -46,14 +50,30 @@ To write a code block, indent each line with a tab:
 To link to another page on the wiki, place the page's name inside double
 square brackets, so you would use `\[[WikiLink]]` to link to [[WikiLink]].
 
 To link to another page on the wiki, place the page's name inside double
 square brackets, so you would use `\[[WikiLink]]` to link to [[WikiLink]].
 

-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
-\[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\)

 
 ----
 
 
 ----
 

-Advanced users can use [[PostProcessorDirective]]s to do additional cool
-stuff.
+You can also use [[PreProcessorDirective]]s to do additional cool stuff.

 
 

-----
+[[if test="enabled(inline)" then="""
+This wiki has the inline plugin enabled, so you can create a [[blog]] on any
+page.
+"""]]
+
+[[if test="enabled(smiley)" then="""
+This wiki has the smiley plugin enabled, so you can insert [[smileys]] and some
+other useful symbols.
+"""]]
+
+[[if test="enabled(shortcut)" then="""
+This wiki has the shortcut plugin enabled, so you can use [[shortcuts]] to link
+to common resources.
+"""]]

 
 

-This style of text formatting is called [[MarkDown]].
+[[if test="enabled(template)" then="""
+This wiki has the template plugin enabled, so you can create and use
+[[templates]] for repeated chunks of parameterized wiki text.
+"""]]