X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/f430ad4390de2c6fe8ba2996caa4eb35bca59dab..cfdba3c70815bed12e106a2f749624040a9aa27d:/doc/helponformatting.mdwn?ds=sidebyside diff --git a/doc/helponformatting.mdwn b/doc/helponformatting.mdwn index 77eb3f964..4e8760c6b 100644 --- a/doc/helponformatting.mdwn +++ b/doc/helponformatting.mdwn @@ -1,4 +1,4 @@ -# Help on formatting text +[[meta title="Help on formatting wiki pages"]] 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 @@ -32,19 +32,6 @@ size of the header: ##### ##### h5 ###### ###### h6 -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: @@ -60,18 +47,48 @@ 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 -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 +To link to an url or email address, you can just put the url in angle brackets: <>, or you can use the form \[link text\]\(url\) ---- -You can also use [[PreProcessorDirective]]s to do additional cool stuff. +In addition to basic html formatting using [[MarkDown]], this wiki lets +you use the following additional features: + +* 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]]. + +[[if test="enabled(smiley) and smileys" then=""" +* Insert [[smileys]] and some other useful symbols. :-) +"""]] + +[[if test="enabled(shortcut) and shortcuts" then=""" +* Use [[shortcuts]] to link to common resources. + + \[[wikipedia War\_of\_1812]] +"""]] + +[[if test="enabled(toc)" then=""" +* Add a table of contents to a page: + + \[[toc ]] +"""]] + + +[[if test="enabled(meta)" then=""" +* Change the title of a page: + + \[[meta title="full page title"]] +"""]] + +[[if test="enabled(inline) and blog" then=""" +* Create a [[blog]] by inlining a set of pages: + + \[[inline pages="blog/*"]] +"""]] -[[if test="enabled(smiley)" then=""" -Also, because this wiki has the smiley plugin enabled, you can -insert [[smileys]] and some other useful symbols. +[[if test="enabled(template) and templates" then=""" +* Create and fill out [[templates]] for repeated chunks of + parameterized wiki text. """]]