← Back to branch summary

~ubuntu-branches/ubuntu/hoary/moodle/hoary

« back to all changes in this revision

Viewing changes to lang/en/help/wiki/howtowiki.html

  • Committer: Bazaar Package Importer
  • Author(s): Isaac Clerencia
  • Date: 2004-12-29 00:49:52 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20041229004952-gliyqzpj2w3e7clx
Tags: 1.4.3-1
http://bugs.debian.org/285842
http://bugs.debian.org/285842
* Urgency high as upstream release fixes several security bugs
* New upstream release
* Write database creation errors and warn the user about it, 
closes: #285842, #285842

Show diffs side-by-side

added added

removed removed

Lines of Context:
lang/en/help/wiki/howtowiki.html
 
1
<h2>How To Wiki</h2>
 
2
 
 
3
<p>
 
4
 
 
5
Moodle's wiki is based on
 
6
 
 
7
<a href="http://erfurtwiki.sourceforge.net/?id=ErfurtWiki" target="_blank">ErfurtWiki</a>,
 
8
 
 
9
which is an implementation of the 
 
10
 
 
11
<a href="http://c2.com/cgi/wiki?WikiWikiWeb" target="_blank">WikiWikiWeb</a>
 
12
 
 
13
hypertext system. It allows simple collaborative editing and creation of web pages.</p>
 
14
 
 
15
<p>
 
16
 
 
17
<ul>
 
18
 
 
19
<li>learn how to <a href="#createpages">CreatePages</a></li>
 
20
 
 
21
<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>
 
22
 
 
23
<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>
 
24
 
 
25
<li>SearchPages or go to the list of NewestPages</li>
 
26
 
 
27
<li>there are also lists of the MostVisitedPages, MostOftenChangedPages and recently UpdatedPages</li>
 
28
 
 
29
</ul>
 
30
 
 
31
</p>
 
32
 
 
33
<p>
 
34
 
 
35
<a name="createpages"></a><b>Create Pages</b>:<br />
 
36
 
 
37
You create a page by naming it in the text of an existing page. A wiki page is named using
 
38
 
 
39
<a href="#camelcase">CamelCase</a> or by enclosing it in square brackets ( [] ).</p>
 
40
 
 
41
<p>
 
42
 
 
43
For example:
 
44
 
 
45
<ul>
 
46
 
 
47
<li>MyWikiPage (Camel Case)</li>
 
48
 
 
49
<li>[My Wiki Page] (enclosed in square brackets)</li>
 
50
 
 
51
</ul></p>
 
52
 
 
53
<p>
 
54
 
 
55
Text that has been given a wiki page name will have a '?' after it. Clicking on the '?', will
 
56
 
 
57
enter edit mode for that page. Enter your text, save and you have a new wiki page.</p>
 
58
 
 
59
<p><a name="wikimarkup"></a><b>Wiki Markup</b>:<br />
 
60
 
 
61
Each page inside a Wiki can be edited easily, using wiki markup.
 
62
 
 
63
</p>
 
64
 
 
65
<h4> Paragraphs</h4>
 
66
 
 
67
  <ul type="circle">
 
68
 
 
69
  <li> separate paragraphs inside the text with empty lines</li>
 
70
 
 
71
  <li> use three percent signs %%<em></em>% to enforce a line break</li>
 
72
 
 
73
  <li> if you prepend text with spaces or tabs it will get indented  </li>
 
74
 
 
75
  </ul>
 
76
 
 
77
 
 
78
 
 
79
<h4> !! Headlines</h4>
 
80
 
 
81
  <ul type="circle">
 
82
 
 
83
  <li> use an exclamation mark ! at the beginning of a line to create a small headline</li>
 
84
 
 
85
  <li> !! for medium</li>
 
86
 
 
87
  <li> !!! for large headlines  </li>
 
88
 
 
89
  </ul>
 
90
 
 
91
 
 
92
 
 
93
<h4> text style</h4>
 
94
 
 
95
  <ul type="circle">
 
96
 
 
97
  <li> if you want to <em>emphasize text</em> enclose it in two single-quotes '' (usually looks italic)</li>
 
98
 
 
99
  <li> <strong>text gets bold</strong> with two underscores __ (or if enclosed with two asterisks **)</li>
 
100
 
 
101
  <li> to make <big>text big</big> enclose it in hash characters ##</li>
 
102
 
 
103
  <li> you can get <small> smaller text </small> using "��" likewise</li>
 
104
 
 
105
  <li> a <tt>typewrite like font</tt> will be used if you enclose text in two equal == signs  </li>
 
106
 
 
107
  </ul>
 
108
 
 
109
 
 
110
 
 
111
<h4> Lists</h4>
 
112
 
 
113
 
 
114
 
 
115
  <ul type="circle">
 
116
 
 
117
  <li> start a line with an asterisk * to begin a list</li>
 
118
 
 
119
  <li> use # instead for numerated lists
 
120
 
 
121
    <ol>
 
122
 
 
123
    <li> you can create sublists</li>
 
124
 
 
125
    <li> subsequent list points should start with the same mix of * and #    </li>
 
126
 
 
127
    </ol>
 
128
 
 
129
  </li>
 
130
 
 
131
  </ul>
 
132
 
 
133
 
 
134
 
 
135
<h4> HyperLinks</h4>
 
136
 
 
137
 
 
138
 
 
139
  <ul type="circle">
 
140
 
 
141
  <li> just enter a CamelCase WikiWord inside your text to create a new HyperLink</li>
 
142
 
 
143
  <li> or, enclose some <b>words in square brackets</b> to create a HyperLink</li>
 
144
 
 
145
  <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>
 
146
 
 
147
  <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
 
148
 
 
149
    <ul type="circle">
 
150
 
 
151
    <li> [title | http://example.com]</li>
 
152
 
 
153
    <li> [WikiWord "title"] or ["title for" WikiLink]    </li>
 
154
 
 
155
    </ul>
 
156
 
 
157
  </li>
 
158
 
 
159
  <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
 
160
 
 
161
    <ul type="circle">
 
162
 
 
163
    <li> !NoHyperLink, ~NoHyperLink</li>
 
164
 
 
165
    <li> ![no hyperlink], !!http://nolink.org/    </li>
 
166
 
 
167
    </ul>
 
168
 
 
169
  </li>
 
170
 
 
171
  </ul>
 
172
 
 
173
 
 
174
 
 
175
<h4> Tables with |</h4>
 
176
 
 
177
<table cellpadding="2" border="1" cellspacing="0">
 
178
 
 
179
<tr>
 
180
 
 
181
<td> just enclose </td>
 
182
 
 
183
<td> things with the dash </td>
 
184
 
 
185
<td> character </td>
 
186
 
 
187
</tr><tr>
 
188
 
 
189
<td> to build a </td>
 
190
 
 
191
<td> table structure  </td>
 
192
 
 
193
</tr><tr>
 
194
 
 
195
<td> browsers usually </td>
 
196
 
 
197
<td> leave out the missing </td>
 
198
 
 
199
<td> cells </td>
 
200
 
 
201
</tr>
 
202
 
 
203
</table>
 
204
 
 
205
 
 
206
 
 
207
 
 
208
 
 
209
<p>
 
210
 
 
211
Please always put an empty line before and after a table, so it stands out from other text in its own paragraph.
 
212
 
 
213
</p>
 
214
 
 
215
 
 
216
 
 
217
<h4> Pictures</h4>
 
218
 
 
219
 
 
220
 
 
221
  <ul type="circle">
 
222
 
 
223
  <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>
 
224
 
 
225
  <li> alternatively you could use the ImageUploading function</li>
 
226
 
 
227
  </ul>
 
228
 
 
229
 
 
230
 
 
231
<h4>Further readings</h4>
 
232
 
 
233
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.
 
234
 
 
235
 
 
236
 
 
237
<p>
 
238
 
 
239
<a name="camelcase"></a><b>Camel Case</b>:<br />
 
240
 
 
241
CamelCase describes what WikiWords look like. Multiple words, joined together without
 
242
 
 
243
spaces, separated by changes in case. The uppercase and
 
244
 
 
245
lowercase letters show up like the humps of camels.</p>
 
246
 
 
247
<p>
 
248
 
 
249
This linking scheme is often also called BumpyText.</p>
 
250
 
 
251
<p>
 
252
 
 
253
While language purists hate Wikis for that naming scheme, it is very common in the 
 
254
 
 
255
computing world and well known to most programmers.</p>
 
256
 
 
257
 
 
258
 
 
259
 
 
260