X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/7b4600df3f8b8c2112a8df6c018d64f04db1ebe8..f430ad4390de2c6fe8ba2996caa4eb35bca59dab:/doc/helponformatting.mdwn?ds=sidebyside diff --git a/doc/helponformatting.mdwn b/doc/helponformatting.mdwn index 4ef41d16f..77eb3f964 100644 --- 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. @@ -24,12 +25,28 @@ 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: +# # 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 2 +--------- +--------- +--------- + +To create a horizontal rule, just write three or more dashes or stars on +their own line: ---- @@ -38,7 +55,7 @@ To quote someone, prefix the quote with ">": > 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 @@ -46,14 +63,15 @@ 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 any other web page, or to an email address, you can just put the url in angle brackets: <>, 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: <>, 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. -This style of text formatting is called [[MarkDown]]. +[[if test="enabled(smiley)" then=""" +Also, because this wiki has the smiley plugin enabled, you can +insert [[smileys]] and some other useful symbols. +"""]]