web commit by JoshTriplett: Add implementation possibilities.

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

diff --git a/doc/helponformatting.mdwn b/doc/helponformatting.mdwn
index 545148e864323492e0edef0e75e3727018423513..8c6483275f8e262910a963993e886dbc53215d16 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,30 @@ 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:
+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,7 +57,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


@@ -51,4 +70,7 @@ To link to any other web page, or to an email address, you can just put the url
 
 ----
 
 
 ----
 

-This style of text formatting is called [[MarkDown]].
+You can also use [[PreProcessorDirective]]s to do additional cool stuff.
+
+Also, if the smiley plugin is enabled in your wiki, you can insert
+[[smileys]] and some other useful symbols.