← Back to branch summary

~ubuntu-branches/ubuntu/natty/moin/natty-updates

« back to all changes in this revision

Viewing changes to wiki/underlay/pages/HelpOnMoinWikiSyntax/revisions/00000001

  • Committer: Bazaar Package Importer
  • Author(s): Jonas Smedegaard
  • Date: 2008-06-22 21:17:13 UTC
  • mfrom: (0.9.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080622211713-fpo2zrq3s5dfecxg
Tags: 1.7.0-3
Simplify /etc/moin/wikilist format: "USER URL" (drop unneeded middle
CONFIG_DIR that was wrongly advertised as DATA_DIR).  Make
moin-mass-migrate handle both formats and warn about deprecation of
the old one.

Show diffs side-by-side

added added

removed removed

Lines of Context:
wiki/underlay/pages/HelpOnMoinWikiSyntax/revisions/00000001
 
1
## Please edit system and help pages ONLY in the master wiki!
 
2
## For more information, please see MoinMoin:MoinDev/Translation.
 
3
## page was renamed from SyntaxReference
 
4
##master-page:Unknown-Page
 
5
##master-date:Unknown-Date
 
6
#acl -All:write Default
 
7
#format wiki
 
8
#language en
 
9
 
 
10
This page aims to introduce the most important elements of MoinMoin``'s syntax at a glance, showing first the markup verbatim and then how it is rendered by the wiki engine. Additionally, you'll find links to the relative help pages. Please note that some of the features depend on your configuration.
 
11
 
 
12
= Table of Contents =
 
13
{{{
 
14
'''Contents''' (up to the 2nd level)
 
15
<<TableOfContents(2)>>
 
16
}}}
 
17
'''Contents''' (up to the 2nd level)
 
18
<<TableOfContents(2)>>
 
19
 
 
20
= Headings =
 
21
'''''see:''' HelpOnHeadlines''
 
22
{{{
 
23
= heading 1st level =
 
24
== heading 2nd level ==
 
25
=== heading 3rd level ===
 
26
==== heading 4th level ====
 
27
===== heading 5th level =====
 
28
}}}
 
29
= heading 1st level =
 
30
== heading 2nd level ==
 
31
=== heading 3rd level ===
 
32
==== heading 4th level ====
 
33
===== heading 5th level =====
 
34
 
 
35
= Text Formatting =
 
36
'''''see:''' HelpOnFormatting''
 
37
{{{{
 
38
 * ''emphasized (italics)''
 
39
 * '''boldface'''
 
40
 * '''''bold italics'''''
 
41
 * `monospace`
 
42
 * {{{source code}}}
 
43
 * __underline__
 
44
 * ,,sub,,script
 
45
 * ^super^script
 
46
 * ~-smaller-~
 
47
 * ~+larger+~
 
48
 * --(strike through)--
 
49
}}}}
 
50
 * ''emphasized (italics)''
 
51
 * '''boldface'''
 
52
 * '''''bold italics'''''
 
53
 * `monospace`
 
54
 * {{{source code}}}
 
55
 * __underline__
 
56
 * ,,sub,,script
 
57
 * ^super^script
 
58
 * ~-smaller-~
 
59
 * ~+larger+~
 
60
 * --(strike through)--
 
61
 
 
62
= Hyperlinks =
 
63
'''''see:''' HelpOnLinking''
 
64
== Internal Links ==
 
65
{{{
 
66
 * FrontPage
 
67
 * [[FrontPage]]
 
68
 * HelpOnEditing/SubPages
 
69
 * /SubPage
 
70
 * ../SiblingPage
 
71
 * [[FrontPage|named link]]
 
72
 * [[#anchorname]]
 
73
 * [[#anchorname|description]]
 
74
 * [[PageName#anchorname]]
 
75
 * [[PageName#anchorname|description]]
 
76
 * [[attachment:filename.txt]]
 
77
}}}
 
78
 * FrontPage
 
79
 * [[FrontPage]]
 
80
 * HelpOnEditing/SubPages
 
81
 * /SubPage
 
82
 * ../SiblingPage
 
83
 * [[FrontPage|named link]]
 
84
 * [[#anchorname]]
 
85
 * [[#anchorname|description]]
 
86
 * [[PageName#anchorname]]
 
87
 * [[PageName#anchorname|description]]
 
88
 * [[attachment:filename.txt]]
 
89
 
 
90
== External Links ==
 
91
{{{
 
92
 * http://moinmo.in/
 
93
 * [[http://moinmo.in/]]
 
94
 * [[http://moinmo.in/|MoinMoin Wiki]]
 
95
 * [[http://static.moinmo.in/logos/moinmoin.png]]
 
96
 * {{http://static.moinmo.in/logos/moinmoin.png}}
 
97
 * [[http://static.moinmo.in/logos/moinmoin.png|moinmoin.png]]
 
98
 * MeatBall:InterWiki
 
99
 * [[MeatBall:InterWiki|InterWiki page on MeatBall]]
 
100
 * [[file://///servername/share/full/path/to/file/filename%20with%20spaces.txt|link to file filename with spaces.txt]]
 
101
 * user@example.com
 
102
}}}
 
103
 * http://moinmo.in/
 
104
 * [[http://moinmo.in/]]
 
105
 * [[http://moinmo.in/|MoinMoin Wiki]]
 
106
 * [[http://static.moinmo.in/logos/moinmoin.png]]
 
107
 * {{http://static.moinmo.in/logos/moinmoin.png}}
 
108
 * [[http://static.moinmo.in/logos/moinmoin.png|moinmoin.png]]
 
109
 * MeatBall:InterWiki
 
110
 * [[MeatBall:InterWiki|InterWiki page on MeatBall]]
 
111
 * [[file://///servername/share/full/path/to/file/filename%20with%20spaces.txt|link to file filename with spaces.txt]]
 
112
 * user@example.com
 
113
 
 
114
== Avoid or Limit Automatic Linking ==
 
115
{{{
 
116
 * Wiki''''''Name
 
117
 * Wiki``Name
 
118
 * !WikiName
 
119
 * WikiName''''''s
 
120
 * WikiName``s
 
121
 * `http://www.example.com`
 
122
 * [[http://www.example.com/]]notlinked
 
123
}}}
 
124
 * Wiki''''''Name
 
125
 * Wiki``Name
 
126
 * !WikiName
 
127
 * WikiName''''''s
 
128
 * WikiName``s
 
129
 * `http://www.example.com`
 
130
 * [[http://www.example.com/]]notlinked
 
131
 
 
132
= Drawings =
 
133
 {{drawing:myexample}}
 
134
 
 
135
= Blockquotes and Indentations =
 
136
{{{
 
137
 indented text
 
138
  text indented to the 2nd level
 
139
}}}
 
140
 indented text
 
141
  text indented to the 2nd level
 
142
 
 
143
= Lists =
 
144
'''''see:''' HelpOnLists''
 
145
== Unordered Lists ==
 
146
{{{
 
147
 * item 1
 
148
 
 
149
 * item 2 (preceding white space)
 
150
  * item 2.1
 
151
   * item 2.1.1
 
152
 * item 3
 
153
  . item 3.1 (bulletless)
 
154
 . item 4 (bulletless)
 
155
  * item 4.1
 
156
   . item 4.1.1 (bulletless)
 
157
}}}
 
158
 * item 1
 
159
 
 
160
 * item 2 (preceding white space)
 
161
  * item 2.1
 
162
   * item 2.1.1
 
163
 * item 3
 
164
  . item 3.1 (bulletless)
 
165
 . item 4 (bulletless)
 
166
  * item 4.1
 
167
   . item 4.1.1 (bulletless)
 
168
 
 
169
== Ordered Lists ==
 
170
=== with Numbers ===
 
171
{{{
 
172
 1. item 1
 
173
   1. item 1.1
 
174
   1. item 1.2
 
175
 1. item 2
 
176
}}}
 
177
 1. item 1
 
178
   1. item 1.1
 
179
   1. item 1.2
 
180
 1. item 2
 
181
 
 
182
=== with Roman Numbers ===
 
183
{{{
 
184
 I. item 1
 
185
   i. item 1.1
 
186
   i. item 1.2
 
187
 I. item 2
 
188
}}}
 
189
 I. item 1
 
190
   i. item 1.1
 
191
   i. item 1.2
 
192
 I. item 2
 
193
 
 
194
=== with Letters ===
 
195
{{{
 
196
 A. item A
 
197
   a. item A. a)
 
198
   a. item A. b)
 
199
 A. item B
 
200
}}}
 
201
 A. item A
 
202
   a. item A. a)
 
203
   a. item A. b)
 
204
 A. item B
 
205
 
 
206
== Definition Lists ==
 
207
{{{
 
208
 term:: definition
 
209
 object::
 
210
 :: description 1
 
211
 :: description 2
 
212
}}}
 
213
 term:: definition
 
214
 object::
 
215
 :: description 1
 
216
 :: description 2
 
217
 
 
218
= Horizontal Rules =
 
219
'''''see:''' HelpOnRules''
 
220
{{{
 
221
----
 
222
-----
 
223
------
 
224
-------
 
225
--------
 
226
---------
 
227
----------
 
228
}}}
 
229
----
 
230
-----
 
231
------
 
232
-------
 
233
--------
 
234
---------
 
235
----------
 
236
 
 
237
= Tables =
 
238
'''''see:''' HelpOnTables''
 
239
== Tables ==
 
240
{{{
 
241
||'''A'''||'''B'''||'''C'''||
 
242
||1      ||2      ||3      ||
 
243
}}}
 
244
||'''A'''||'''B'''||'''C'''||
 
245
||1      ||2      ||3      ||
 
246
 
 
247
== Cell Width ==
 
248
{{{
 
249
||minimal width ||<99%>maximal width ||
 
250
}}}
 
251
||minimal width ||<99%>maximal width ||
 
252
 
 
253
== Spanning Rows and Columns  ==
 
254
{{{
 
255
||<|2> cell spanning 2 rows ||cell in the 2nd column ||
 
256
||cell in the 2nd column of the 2nd row ||
 
257
||<-2> cell spanning 2 columns ||
 
258
||||use empty cells as a shorthand ||
 
259
}}}
 
260
||<|2> cell spanning 2 rows ||cell in the 2nd column ||
 
261
||cell in the 2nd column of the 2nd row ||
 
262
||<-2> cell spanning 2 columns ||
 
263
||||use empty cells as a shorthand ||
 
264
 
 
265
== Alignment of Cell Contents ==
 
266
{{{
 
267
||<^|3> top (combined) ||<:99%> center (combined) ||<v|3> bottom (combined) ||
 
268
||<)> right ||
 
269
||<(> left ||
 
270
}}}
 
271
||<^|3> top (combined) ||<:99%> center (combined) ||<v|3> bottom (combined) ||
 
272
||<)> right ||
 
273
||<(> left ||
 
274
 
 
275
== Coloured Table Cells ==
 
276
{{{
 
277
||<#0000FF> blue ||<#00FF00> green    ||<#FF0000> red    ||
 
278
||<#00FFFF> cyan ||<#FF00FF> magenta  ||<#FFFF00> yellow ||
 
279
}}}
 
280
||<#0000FF> blue ||<#00FF00> green    ||<#FF0000> red    ||
 
281
||<#00FFFF> cyan ||<#FF00FF> magenta  ||<#FFFF00> yellow ||
 
282
 
 
283
== HTML-like Options for Tables ==
 
284
{{{
 
285
||A ||<rowspan="2"> like <|2> ||
 
286
||<bgcolor="#00FF00"> like <#00FF00> ||
 
287
||<colspan="2"> like <-2>||
 
288
}}}
 
289
||A ||<rowspan="2"> like <|2> ||
 
290
||<bgcolor="#00FF00"> like <#00FF00> ||
 
291
||<colspan="2"> like <-2>||
 
292
 
 
293
= Macros and Variables =
 
294
== Macros ==
 
295
'''''see:''' HelpOnMacros''
 
296
 * `<<Anchor(anchorname)>>` inserts a link anchor `anchorname`
 
297
 * `<<BR>>` inserts a hard line break
 
298
 * `<<FootNote(Note)>>` inserts a footnote saying `Note`
 
299
 * `<<Include(HelpOnMacros/Include)>>` inserts the contents of the page `HelpOnMacros/Include` inline
 
300
 * `<<MailTo(user AT example DOT com)>>` obfuscates the email address `user@example.com` to users not logged in
 
301
 
 
302
== Variables ==
 
303
'''''see:''' HelpOnVariables''
 
304
 * `@``SIG``@` inserts your login name and timestamp of modification
 
305
 * `@``TIME``@` inserts date and time of modification
 
306
 
 
307
= Smileys and Icons =
 
308
'''''see:''' HelpOnSmileys''
 
309
<<ShowSmileys>>
 
310
 
 
311
= Parsers =
 
312
'''''see:''' HelpOnParsers''
 
313
== Verbatim Display ==
 
314
{{{{
 
315
{{{
 
316
def hello():
 
317
    print "Hello World!"
 
318
}}}
 
319
}}}}
 
320
 
 
321
{{{
 
322
def hello():
 
323
    print "Hello World!"
 
324
}}}
 
325
 
 
326
== Syntax Highlighting ==
 
327
{{{{
 
328
{{{#!python
 
329
def hello():
 
330
    print "Hello World!"
 
331
}}}
 
332
}}}}
 
333
 
 
334
{{{#!python
 
335
def hello():
 
336
    print "Hello World!"
 
337
}}}
 
338
 
 
339
== Using the wiki parser with css classes ==
 
340
{{{{
 
341
{{{#!wiki red/solid
 
342
This is wiki markup in a '''div''' with __css__ `class="red solid"`.
 
343
}}}
 
344
}}}}
 
345
 
 
346
{{{#!wiki red/solid
 
347
This is wiki markup in a '''div''' with __css__ `class="red solid"`.
 
348
}}}
 
349
 
 
350
= Admonitions =
 
351
'''''see:''' HelpOnAdmonitions''
 
352
 
 
353
{{{{
 
354
{{{#!wiki caution
 
355
'''Don't overuse admonitions'''
 
356
 
 
357
Admonitions should be used with care. A page riddled with admonitions will look restless and will be harder to follow then a page where admonitions are used sparingly.
 
358
}}}
 
359
}}}}
 
360
 
 
361
{{{#!wiki caution
 
362
'''Don't overuse admonitions'''
 
363
 
 
364
Admonitions should be used with care. A page riddled with admonitions will look restless and will be harder to follow then a page where admonitions are used sparingly.
 
365
}}}
 
366
 
 
367
 
 
368
= Comments =
 
369
'''''see:''' HelpOnComments''
 
370
 
 
371
{{{
 
372
Click on "Comments" in edit bar to toggle the /* comments */ visibility.
 
373
}}}
 
374
 
 
375
Click on "Comments" in edit bar to toggle the /* comments */ visibility.
 
376
 
 
377
{{{{
 
378
{{{#!wiki comment/dotted
 
379
This is a wiki parser section with class "comment dotted" (see HelpOnParsers).
 
380
 
 
381
Its visibility gets toggled the same way.
 
382
}}}
 
383
}}}}
 
384
 
 
385
{{{#!wiki comment/dotted
 
386
This is a wiki parser section with class "comment dotted" (see HelpOnParsers).
 
387
 
 
388
Its visibility gets toggled the same way.
 
389
}}}