Merge commit 'catalyst/MOODLE_19_STABLE' into mdl19-linuxchix
[moodle-linuxchix.git] / lang / en_utf8 / help / wiki / wikiusage.html
blob0fd90ca8d0818f060d80ac649250c5fd31ec28f2
1 <h1>Wiki Usage</h1>
3 <p>
4 Wiki is a platform for working together on constructing web pages. The principles are simple.
5 </p>
7 <ul>
8 <li>A text is written and saved.</li>
9 <li>Later, another person may read that text and think of some additions or
10 corrections that could be made. They choose "Edit" and make their changes to the page. </li>
11 <li>After saving their new version, it is available globally.</li>
12 </ul>
14 <p>With a wiki, it is also easily possible to add a page or link to existing pages.</p>
17 <ul>
18 <li>A link is created by a WikiWord. This is one word with at least two capital letters. If a page with this name already exist, it will be linked automatically, if not, it will be displayed with a question mark.</li>
19 <li>Clicking on this question mark, will start a new blank page with that name, ready to edit.</li>
20 </ul>
23 <h3 class="center">Wiki formatting rules</h3>
26 <h4> Paragraphs</h4>
27 <ul>
28 <li> separate paragraphs inside the text with empty lines</li>
29 <li> use three percent signs %%% to enforce a line break</li>
30 <li> if you prepend text with spaces or tabs it will get indented </li>
31 </ul>
33 <h4> !! Headlines</h4>
35 <ul type="circle">
36 <li> use an exclamation mark ! at the beginning of a line to create a small headline</li>
38 <li> !! for medium</li>
39 <li> !!! for large headlines </li>
40 </ul>
42 <h4>Text style</h4>
44 <ul>
46 <li> if you want to <em>emphasize text</em> enclose it in two single-quotes '' (usually looks italic)</li>
47 <li> <strong>text gets bold</strong> with two underscores __ (or if enclosed with two asterisks **)</li>
48 <li> to make <big>text big</big> enclose it in hash characters ##</li>
50 <li> you can get <small> smaller text </small> using "ยตยต" likewise</li>
51 <li> a <tt>typewrite like font</tt> will be used if you enclose text in two equal == signs </li>
52 </ul>
54 <h4>Lists</h4>
56 <ul>
57 <li> start a line with an asterisk * to begin a list</li>
58 <li> use # instead for numerated lists
59 <ol>
60 <li> you can create sublists</li>
62 <li> subsequent list points should start with the same mix of * and # </li>
63 </ol>
64 </li>
65 </ul>
67 <h4> HyperLinks</h4>
69 <ul>
71 <li> just enter a WikiWord inside your text to create a new hyper link</li>
72 <li> enclose some words in [square brackets] to create a HyperLink inside the WikiWikiWeb which is not made up of a valid WikiWord</li>
74 <li> any valid internet address (starting with http:/) like http://www.example.com/ inside the text will be made clickable automatically</li>
75 <li> enclose a www address or a WikiLink inside square brackets and assign it a neat title using quotation marks or the | character
76 <ul>
77 <li> [title | http://example.com]</li>
79 <li> [WikiWord "title"] or ["title for" WikiLink] </li>
80 </ul>
81 </li>
82 <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
83 <ul>
84 <li> !NoHyperLink, ~NoHyperLink</li>
85 <li> ![no hyperlink], !http://nolink.org/ </li>
87 </ul>
88 </li>
89 </ul>
91 <h4> Tables with |</h4>
92 | just enclose | things with the dash | character | <br />
93 | to build a | table structure | <br />
94 | browsers usually | leave out the missing | cells | <br />
97 <p>
98 Please always put an empty line before and after a table, so it stands out from other text in its own paragraph.
99 </p>
101 <h4> Pictures</h4>
103 <ul>
105 <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>
106 <li> alternatively you could use the image uploading function.</li>
107 </ul>
109 <h4>Further readings</h4>
112 There are more possibilities for Wiki mark-up. Please consult the <a href="http://erfurtwiki.sourceforge.net" target="_new">Erfurt Wiki Homepage</a> for more information.
113 </p>