]> git.mjollnir.org Git - moodle.git/commitdiff
Added HowToWiki help file.
authormchurch <mchurch>
Wed, 2 Jun 2004 21:29:26 +0000 (21:29 +0000)
committermchurch <mchurch>
Wed, 2 Jun 2004 21:29:26 +0000 (21:29 +0000)
lang/en/help/wiki/howtowiki.html [new file with mode: 0755]

diff --git a/lang/en/help/wiki/howtowiki.html b/lang/en/help/wiki/howtowiki.html
new file mode 100755 (executable)
index 0000000..df70d08
--- /dev/null
@@ -0,0 +1,121 @@
+<h2>How To Wiki</h2>\r
+<p>\r
+Moodle's wiki is based on\r
+<a href="http://erfurtwiki.sourceforge.net/?id=ErfurtWiki" target="_blank">ErfurtWiki</a>,\r
+which is an implementation of the \r
+<a href="http://c2.com/cgi/wiki?WikiWikiWeb" target="_blank">WikiWikiWeb</a>\r
+hypertext system. It allows simple collaborative editing and creation of web pages.</p>\r
+<p>\r
+<ul>\r
+<li>learn how to <a href="#createpages">CreatePages</a></li>\r
+<li>just click on <img src="pix/t/edit.gif"> or select "Edit this page" from the drop down menu to change the contents of a page</li>\r
+<li>you can format your pages wth <a href="#wikimarkup">Wiki Markup</a>, or with HTML (if the wiki has been given that option)</li>\r
+<li>SearchPages or go to the list of NewestPages</li>\r
+<li>there are also lists of the MostVisitedPages, MostOftenChangedPages and recently UpdatedPages</li>\r
+</ul>\r
+</p>\r
+<p>\r
+<a name="createpages"></a><b>Create Pages</b>:<br />\r
+You create a page by naming it in the text of an existing page. A wiki page is named using\r
+<a href="#camelcase">CamelCase</a> or by enclosing it in square brackets ( [] ).</p>\r
+<p>\r
+For example:\r
+<ul>\r
+<li>MyWikiPage (Camel Case)</li>\r
+<li>[My Wiki Page] (enclosed in square brackets)</li>\r
+</ul></p>\r
+<p>\r
+Text that has been given a wiki page name will have a '?' after it. Clicking on the '?', will\r
+enter edit mode for that page. Enter your text, save and you have a new wiki page.</p>\r
+<p><a name="wikimarkup"></a><b>Wiki Markup</b>:<br />\r
+Each page inside a Wiki can be edited easily, using wiki markup.\r
+</p>\r
+<h4> Paragraphs</h4>\r
+  <ul type="circle">\r
+  <li> separate paragraphs inside the text with empty lines</li>\r
+  <li> use three percent signs %%<em></em>% to enforce a line break</li>\r
+  <li> if you prepend text with spaces or tabs it will get indented  </li>\r
+  </ul>\r
+\r
+<h4> !! Headlines</h4>\r
+  <ul type="circle">\r
+  <li> use an exclamation mark ! at the beginning of a line to create a small headline</li>\r
+  <li> !! for medium</li>\r
+  <li> !!! for large headlines  </li>\r
+  </ul>\r
+\r
+<h4> text style</h4>\r
+  <ul type="circle">\r
+  <li> if you want to <em>emphasize text</em> enclose it in two single-quotes '' (usually looks italic)</li>\r
+  <li> <strong>text gets bold</strong> with two underscores __ (or if enclosed with two asterisks **)</li>\r
+  <li> to make <big>text big</big> enclose it in hash characters ##</li>\r
+  <li> you can get <small> smaller text </small> using "ยตยต" likewise</li>\r
+  <li> a <tt>typewrite like font</tt> will be used if you enclose text in two equal == signs  </li>\r
+  </ul>\r
+\r
+<h4> Lists</h4>\r
+\r
+  <ul type="circle">\r
+  <li> start a line with an asterisk * to begin a list</li>\r
+  <li> use # instead for numerated lists\r
+    <ol>\r
+    <li> you can create sublists</li>\r
+    <li> subsequent list points should start with the same mix of * and #    </li>\r
+    </ol>\r
+  </li>\r
+  </ul>\r
+\r
+<h4> HyperLinks</h4>\r
+\r
+  <ul type="circle">\r
+  <li> just enter a CamelCase WikiWord inside your text to create a new HyperLink</li>\r
+  <li> or, enclose some <b>words in square brackets</b> to create a HyperLink</li>\r
+  <li> any valid internet address (starting with <a href="http://">http://</a>) like http://www.example.com/ inside the text will be made clickable automagically</li>\r
+  <li> enclose a www address or a WikiLink inside square brackets [<a href="http://www.moodle.org/">Moodle</a>] and assign it a neat title using quotation marks or the | character\r
+    <ul type="circle">\r
+    <li> [title | http://example.com]</li>\r
+    <li> [WikiWord "title"] or ["title for" WikiLink]    </li>\r
+    </ul>\r
+  </li>\r
+  <li> if you don't want a WikiWord or a !http://www-address (or [anything] inside square brackets) to become a HyperLink then just prepend it with a exclamation mark or a tilde\r
+    <ul type="circle">\r
+    <li> !NoHyperLink, ~NoHyperLink</li>\r
+    <li> ![no hyperlink], !!http://nolink.org/    </li>\r
+    </ul>\r
+  </li>\r
+  </ul>\r
+\r
+<h4> Tables with |</h4>\r
+<table cellpadding="2" border="1" cellspacing="0">\r
+<tr>\r
+<td> just enclose </td>\r
+<td> things with the dash </td>\r
+<td> character </td>\r
+</tr><tr>\r
+<td> to build a </td>\r
+<td> table structure  </td>\r
+</tr><tr>\r
+<td> browsers usually </td>\r
+<td> leave out the missing </td>\r
+<td> cells </td>\r
+</tr>\r
+</table>\r
+\r
+\r
+<p>\r
+Please always put an empty line before and after a table, so it stands out from other text in its own paragraph.\r
+</p>\r
+\r
+<h4> Pictures</h4>\r
+\r
+  <ul type="circle">\r
+  <li> to include an image into a page enclose its absolute www-address in square brackets, like [http://www.example.com/pics/image.png] </li>\r
+  <li> alternatively you could use the ImageUploading function</li>\r
+  </ul>\r
+\r
+<h4> More markup</h4>\r
+\r
+<p>\r
+Please see the page about ExtendedWikiMarkup</a>, if you'd like to know a bit\r
+more about available markup.\r
+</p>
\ No newline at end of file