Attachment 'HelpOnMoinWikiSyntax.txt'
Download 1 *********************
2 HelpOnMoinWikiSyntax
3 *********************
4 This page aims to introduce the most important elements of <MoinMoin.txt>'''s
5 syntax at a glance, showing first the markup verbatim and then how it is
6 rendered by the wiki engine. Additionally, you'll find links to the relative
7 help pages. Please note that some of the features depend on your configuration.
8
9 Inhaltsverzeichnis
10
11
12 1. Headings and table of contents
13
14 2. Text Formatting
15
16 3. Hyperlinks
17
18 1. Internal Links
19
20 2. External Links
21
22 3. Avoid or Limit Automatic Linking
23
24 4. Drawings
25
26 1. TWikiDraw
27
28 2. AnyWikiDraw
29
30 5. Blockquotes and Indentations
31
32 6. Lists
33
34 1. Unordered Lists
35
36 2. Ordered Lists
37
38 1. with Numbers
39
40 2. with Roman Numbers
41
42 3. with Letters
43
44 3. Definition Lists
45
46 7. Horizontal Rules
47
48 8. Tables
49
50 1. Tables
51
52 2. Cell Width
53
54 3. Spanning Rows and Columns
55
56 4. Alignment of Cell Contents
57
58 5. Coloured Table Cells
59
60 6. HTML-like Options for Tables
61
62 9. Macros and Variables
63
64 1. Macros
65
66 2. Variables
67
68 10. Smileys and Icons
69
70 11. Parsers
71
72 1. Verbatim Display
73
74 2. Syntax Highlighting
75
76 3. Using the wiki parser with css classes
77
78 12. Admonitions
79
80 13. Comments
81
82 Headings and table of contents
83 ==============================
84
85 /*see:* <HelpOnHeadlines.txt>/
86
87 ---%<-------------------------------------------------------------------------
88 Table of contents:
89 <<TableOfContents()>>
90
91 Table of contents (up to 2nd level headings only):
92 <<TableOfContents(2)>>
93
94 = heading 1st level =
95 == heading 2nd level ==
96 === heading 3rd level ===
97 ==== heading 4th level ====
98 ===== heading 5th level =====
99 ====== no heading 6th level ======
100 ---%<-------------------------------------------------------------------------
101
102 Table of contents:
103 Inhaltsverzeichnis
104
105
106 1. heading 1st level
107
108 1. heading 2nd level
109
110 1. heading 3rd level
111
112 1. heading 4th level
113
114 1. heading 5th level
115
116 2. no heading 6th level
117
118 Table of contents (up to 2nd level headings only):
119 Inhaltsverzeichnis
120
121
122 1. heading 1st level
123
124 1. heading 2nd level
125
126 heading 1st level
127 =================
128
129 heading 2nd level
130 -----------------
131
132 heading 3rd level
133 -----------------
134
135 heading 4th level
136 -----------------
137
138 heading 5th level
139 -----------------
140
141 no heading 6th level
142 --------------------
143
144 Text Formatting
145 ===============
146
147 /*see:* <HelpOnFormatting.txt>/
148 +-----------------+--------------+
149 | *Markup* | *Result* |
150 +-----------------+--------------+
151 | '''italic''' | /italic/ |
152 +-----------------+--------------+
153 | ''''bold'''' | *bold* |
154 +-----------------+--------------+
155 | '`monospace`' | 'monospace' |
156 +-----------------+--------------+
157 | '{{{code}}}' | 'code' |
158 +-----------------+--------------+
159 | '__underline__' | _underline_ |
160 +-----------------+--------------+
161 | '^super^script' | ^superscript |
162 +-----------------+--------------+
163 | ',,sub,,script' | _sub_script |
164 +-----------------+--------------+
165 | '~-smaller-~' | smaller |
166 +-----------------+--------------+
167 | '~+larger+~' | larger |
168 +-----------------+--------------+
169 | '--(stroke)--' | __stroke__ |
170 +-----------------+--------------+
171
172 Hyperlinks
173 ==========
174
175 /*see:* <HelpOnLinking.txt>/
176
177 Internal Links
178 --------------
179
180 +---------------------------------------+-------------------------------------+
181 | *Markup* | *Result* |
182 +---------------------------------------+-------------------------------------+
183 | 'FrontPage' | <FrontPage.txt> |
184 +---------------------------------------+-------------------------------------+
185 | '[[FrontPage]]' | <FrontPage.txt> |
186 +---------------------------------------+-------------------------------------+
187 | 'HelpOnEditing/SubPages' | <HelpOnEditing.SubPages.txt> |
188 +---------------------------------------+-------------------------------------+
189 | '/SubPage' | </SubPage> |
190 | | [HelpOnMoinWikiSyntax.SubPage.txt] |
191 +---------------------------------------+-------------------------------------+
192 | '../SiblingPage' | <../SiblingPage> [SiblingPage.txt] |
193 +---------------------------------------+-------------------------------------+
194 | '[[FrontPage|named link]]' | <named link> [FrontPage.txt] |
195 +---------------------------------------+-------------------------------------+
196 | '[[#anchorname]]' | <#anchorname> |
197 | | [HelpOnMoinWikiSyntax.txt] |
198 +---------------------------------------+-------------------------------------+
199 | '[[#anchorname|description]]' | <description> |
200 | | [HelpOnMoinWikiSyntax.txt] |
201 +---------------------------------------+-------------------------------------+
202 | '[[PageName#anchorname]]' | <PageName#anchorname> [PageName.txt]|
203 +---------------------------------------+-------------------------------------+
204 | '[[PageName#anchorname|description]]' | <description> [PageName.txt] |
205 +---------------------------------------+-------------------------------------+
206 | '[[attachment:filename.txt]]' | [attachment:filename.txt] |
207 +---------------------------------------+-------------------------------------+
208
209 External Links
210 --------------
211
212 +---------------------------------------------------------------+-----------------------------------------------------------------------------+
213 | *Markup* | *Result* |
214 +---------------------------------------------------------------+-----------------------------------------------------------------------------+
215 | 'http://moinmo.in/' | http://moinmo.in/ |
216 +---------------------------------------------------------------+-----------------------------------------------------------------------------+
217 | '[[http://moinmo.in/]]' | http://moinmo.in/ |
218 +---------------------------------------------------------------+-----------------------------------------------------------------------------+
219 | '[[http://moinmo.in/|MoinMoin Wiki]]' | MoinMoin Wiki [http://moinmo.in/] |
220 +---------------------------------------------------------------+-----------------------------------------------------------------------------+
221 | '[[http://static.moinmo.in/logos/moinmoin.png]]' | http://static.moinmo.in/logos/moinmoin.png |
222 +---------------------------------------------------------------+-----------------------------------------------------------------------------+
223 | '{{http://static.moinmo.in/logos/moinmoin.png}}' | http://static.moinmo.in/logos/moinmoin.png |
224 | | [http://static.moinmo.in/logos/moinmoin.png] |
225 +---------------------------------------------------------------+-----------------------------------------------------------------------------+
226 | '[[http://static.moinmo.in/logos/moinmoin.png|moinmoin.png]]' | moinmoin.png [http://static.moinmo.in/logos/moinmoin.png] |
227 +---------------------------------------------------------------+-----------------------------------------------------------------------------+
228 | 'MeatBall:InterWiki' | InterWiki [MeatBall:InterWiki] |
229 +---------------------------------------------------------------+-----------------------------------------------------------------------------+
230 | '[MeatBall:InterWiki|InterWiki page on MeatBall]]' | InterWiki page on MeatBall [MeatBall:InterWiki] |
231 +---------------------------------------------------------------+-----------------------------------------------------------------------------+
232 | '[[file://///server/share/filename%20with%20spaces.txt|link to| link to file filename with spaces.txt |
233 | filename.txt]]' | [file://///servername/share/full/path/to/file/filename%20with%20spaces.txt] |
234 +---------------------------------------------------------------+-----------------------------------------------------------------------------+
235 | 'user@example.com' | user@example.com |
236 +---------------------------------------------------------------+-----------------------------------------------------------------------------+
237
238 Avoid or Limit Automatic Linking
239 --------------------------------
240
241 +----------------------------------------+----------------------------------+
242 | *Markup* | *Result* |
243 +----------------------------------------+----------------------------------+
244 | 'Wiki''''''Name' | Wiki**Name |
245 +----------------------------------------+----------------------------------+
246 | 'Wiki''Name' | Wiki''Name |
247 +----------------------------------------+----------------------------------+
248 | '!WikiName' | WikiName |
249 +----------------------------------------+----------------------------------+
250 | 'WikiName''''''s' | <WikiName.txt>**s |
251 +----------------------------------------+----------------------------------+
252 | 'WikiName``s' | <WikiName.txt>''s |
253 +----------------------------------------+----------------------------------+
254 | 'http://www.example.com' | 'http://www.example.com' |
255 +----------------------------------------+----------------------------------+
256 | '[[http://www.example.com/]]notlinked' | http://www.example.com/notlinked |
257 +----------------------------------------+----------------------------------+
258
259 Drawings
260 ========
261
262 /*see:* <HelpOnDrawings.txt>/
263
264 TWikiDraw
265 ---------
266
267 * [drawing:myexample.tdraw]
268
269 AnyWikiDraw
270 -----------
271
272 * [drawing:myexample.adraw]
273
274 Blockquotes and Indentations
275 ============================
276
277 ---%<-------------------------------------------------------------------------
278 indented text
279 text indented to the 2nd level
280 ---%<-------------------------------------------------------------------------
281
282 * indented text
283 * text indented to the 2nd level
284
285 Lists
286 =====
287
288 /*see:* <HelpOnLists.txt>/
289
290 Unordered Lists
291 ---------------
292
293 ---%<-------------------------------------------------------------------------
294 * item 1
295
296 * item 2 (preceding white space)
297 * item 2.1
298 * item 2.1.1
299 * item 3
300 . item 3.1 (bulletless)
301 . item 4 (bulletless)
302 * item 4.1
303 . item 4.1.1 (bulletless)
304 ---%<-------------------------------------------------------------------------
305
306 * item 1
307 * item 2 (preceding white space)
308 * item 2.1
309 * item 2.1.1
310 * item 3
311 * item 3.1 (bulletless)
312 * item 4 (bulletless)
313 * item 4.1
314 * item 4.1.1 (bulletless)
315
316 Ordered Lists
317 -------------
318
319 with Numbers
320 ------------
321
322 ---%<-------------------------------------------------------------------------
323 1. item 1
324 1. item 1.1
325 1. item 1.2
326 1. item 2
327 ---%<-------------------------------------------------------------------------
328
329 1. item 1
330 1. item 1.1
331 2. item 1.2
332 2. item 2
333
334 with Roman Numbers
335 ------------------
336
337 ---%<-------------------------------------------------------------------------
338 I. item 1
339 i. item 1.1
340 i. item 1.2
341 I. item 2
342 ---%<-------------------------------------------------------------------------
343
344 1. item 1
345 1. item 1.1
346 2. item 1.2
347 2. item 2
348
349 with Letters
350 ------------
351
352 ---%<-------------------------------------------------------------------------
353 A. item A
354 a. item A. a)
355 a. item A. b)
356 A. item B
357 ---%<-------------------------------------------------------------------------
358
359 1. item A
360 1. item A. a)
361 2. item A. b)
362 2. item B
363
364 Definition Lists
365 ----------------
366
367 ---%<-------------------------------------------------------------------------
368 term:: definition
369 object::
370 :: description 1
371 :: description 2
372 ---%<-------------------------------------------------------------------------
373
374 term:
375 definition
376
377 object:
378
379 :
380 description 1
381
382 :
383 description 2
384
385 Horizontal Rules
386 ================
387
388 /*see:* <HelpOnRules.txt>/
389
390 ---%<-------------------------------------------------------------------------
391 ----
392 -----
393 ------
394 -------
395 --------
396 ---------
397 ----------
398 ---%<-------------------------------------------------------------------------
399
400 -------------------------------------------------------------------------------
401
402 -------------------------------------------------------------------------------
403
404 -------------------------------------------------------------------------------
405
406 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
407
408 ===============================================================================
409
410 *******************************************************************************
411
412 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
413
414 Tables
415 ======
416
417 /*see:* <HelpOnTables.txt>/
418
419 Tables
420 ------
421
422 ---%<-------------------------------------------------------------------------
423 ||'''A'''||'''B'''||'''C'''||
424 ||1 ||2 ||3 ||
425 ---%<-------------------------------------------------------------------------
426
427 +-----+-----+-----+
428 | *A* | *B* | *C* |
429 +-----+-----+-----+
430 | 1 | 2 | 3 |
431 +-----+-----+-----+
432
433 Cell Width
434 ----------
435
436 ---%<-------------------------------------------------------------------------
437 ||minimal width ||<99%>maximal width ||
438 ---%<-------------------------------------------------------------------------
439
440 +---------------+---------------+
441 | minimal width | maximal width |
442 +---------------+---------------+
443
444 Spanning Rows and Columns
445 -------------------------
446
447 ---%<-------------------------------------------------------------------------
448 ||<|2> cell spanning 2 rows ||cell in the 2nd column ||
449 ||cell in the 2nd column of the 2nd row ||
450 ||<-2> cell spanning 2 columns ||
451 ||||use empty cells as a shorthand ||
452 ---%<-------------------------------------------------------------------------
453
454 +---------------------------------------+------------------------+
455 | cell spanning 2 rows | cell in the 2nd column |
456 +---------------------------------------+------------------------+
457 | cell in the 2nd column of the 2nd row |
458 +---------------------------------------+------------------------+
459 | cell spanning 2 columns |
460 +---------------------------------------+------------------------+
461 | use empty cells as a shorthand |
462 +---------------------------------------+------------------------+
463
464 Alignment of Cell Contents
465 --------------------------
466
467 ---%<-------------------------------------------------------------------------
468 ||<^|3> top (combined) ||<:99%> center (combined) ||<v|3> bottom (combined) ||
469 ||<)> right ||
470 ||<(> left ||
471 ---%<-------------------------------------------------------------------------
472
473 +----------------+-------------------+-------------------+
474 | top (combined) | center (combined) | bottom (combined) |
475 +----------------+-------------------+-------------------+
476 | right |
477 +----------------+-------------------+-------------------+
478 | left |
479 +----------------+-------------------+-------------------+
480
481 Coloured Table Cells
482 --------------------
483
484 ---%<-------------------------------------------------------------------------
485 ||<#0000FF> blue ||<#00FF00> green ||<#FF0000> red ||
486 ||<#00FFFF> cyan ||<#FF00FF> magenta ||<#FFFF00> yellow ||
487 ---%<-------------------------------------------------------------------------
488
489 +------+---------+--------+
490 | blue | green | red |
491 +------+---------+--------+
492 | cyan | magenta | yellow |
493 +------+---------+--------+
494
495 HTML-like Options for Tables
496 ----------------------------
497
498 ---%<-------------------------------------------------------------------------
499 ||A ||<rowspan="2"> like <|2> ||
500 ||<bgcolor="#00FF00"> like <#00FF00> ||
501 ||<colspan="2"> like <-2>||
502 ---%<-------------------------------------------------------------------------
503
504 +----------------+-----------+
505 | A | like <|2> |
506 +----------------+-----------+
507 | like <#00FF00> |
508 +----------------+-----------+
509 | like <-2> |
510 +----------------+-----------+
511
512 Macros and Variables
513 ====================
514
515 Macros
516 ------
517
518 /*see:* <HelpOnMacros.txt>/
519
520 * '<<Anchor(anchorname)>>' inserts a link anchor 'anchorname'
521 * '<<BR>>' inserts a hard line break
522 * '<<FootNote(Note)>>' inserts a footnote saying 'Note'
523 * '<<Include(HelpOnMacros/Include)>>' inserts the contents of the page
524 'HelpOnMacros/Include' inline
525 * '<<MailTo(user AT example DOT com)>>' obfuscates the email address
526 'user@example.com' to users not logged in
527
528 Variables
529 ---------
530
531 /*see:* <HelpOnVariables.txt>/
532
533 * '@''SIG''@' inserts your login name and timestamp of modification
534 * '@''TIME''@' inserts date and time of modification
535
536 Smileys and Icons
537 =================
538
539 ':(':(':)':)'B)'B)':))':))';)';)'/!\'/!\'<!>'<!>'(!)'(!)':-?':-?':\':\'>:>'>:>'|)'|)':-(':-(':-)':-)'B-)'B-)':-))':-))';-)';-)'|-)'|-)'(./)'(./)'{OK}'{OK}'{X}'{X}'{i}'{i}'{1}'{1}'{2}'{2}'{3}'{3}'{*}'{*}'{o}'{o}
540 NotationAnzeigeNotationAnzeigeNotationAnzeigeNotationAnzeige/*see:* <HelpOnSmileys.txt>/ 'X-('X-(':D':D '<:('<:(':o':o
541 +----+----+----+----+----+----+----+----+----+----+----+
542 | ** | ** | ** | ** | ** | ** | ** | ** | ** | ** | ** |
543 +----+----+----+----+----+----+----+----+----+----+----+
544 | | | | | | | | | | | |
545 +----+----+----+----+----+----+----+----+----+----+----+
546 | | | | | | | | | | | |
547 +----+----+----+----+----+----+----+----+----+----+----+
548 | | | | | | | | | | | |
549 +----+----+----+----+----+----+----+----+----+----+----+
550 | | | | | | | | | | | |
551 +----+----+----+----+----+----+----+----+----+----+----+
552 | | | | | | | | | | | |
553 +----+----+----+----+----+----+----+----+----+----+----+
554 | | | | | | | | | | | |
555 +----+----+----+----+----+----+----+----+----+----+----+
556 | | | | | | | | | | | |
557 +----+----+----+----+----+----+----+----+----+----+----+
558 | | | | | | | | | | | |
559 +----+----+----+----+----+----+----+----+----+----+----+
560
561 Parsers
562 =======
563
564 /*see:* <HelpOnParsers.txt>/
565
566 Verbatim Display
567 ----------------
568
569 ---%<-------------------------------------------------------------------------
570 {{{
571 def hello():
572 print "Hello World!"
573 }}}
574 ---%<-------------------------------------------------------------------------
575
576 ---%<-------------------------------------------------------------------------
577 def hello():
578 print "Hello World!"
579 ---%<-------------------------------------------------------------------------
580
581 Syntax Highlighting
582 -------------------
583
584 ---%<-------------------------------------------------------------------------
585 {{{#!highlight python
586 def hello():
587 print "Hello World!"
588 }}}
589 ---%<-------------------------------------------------------------------------
590
591 ---CodeArea-------------------------------------------------------------------
592 def hello(): 1
593 print "Hello World!" 2
594 ---CodeArea-------------------------------------------------------------------
595
596 Using the wiki parser with css classes
597 --------------------------------------
598
599 ---%<-------------------------------------------------------------------------
600 {{{#!wiki red/solid
601 This is wiki markup in a '''div''' with __css__ `class="red solid"`.
602 }}}
603 ---%<-------------------------------------------------------------------------
604
605 This is wiki markup in a *div* with _css_ 'class="red solid"'.
606
607 Admonitions
608 ===========
609
610 /*see:* <HelpOnAdmonitions.txt>/
611
612 ---%<-------------------------------------------------------------------------
613 {{{#!wiki caution
614 '''Don't overuse admonitions'''
615
616 Admonitions should be used with care. A page riddled with admonitions will look
617 restless and will be harder to follow than a page where admonitions are used
618 sparingly.
619 }}}
620 ---%<-------------------------------------------------------------------------
621
622 *Don't overuse admonitions*
623
624 Admonitions should be used with care. A page riddled with admonitions will look
625 restless and will be harder to follow than a page where admonitions are used
626 sparingly.
627
628 Comments
629 ========
630
631 /*see:* <HelpOnComments.txt>/
632
633 ---%<-------------------------------------------------------------------------
634 Click on "Comments" in edit bar to toggle the /* comments */ visibility.
635 ---%<-------------------------------------------------------------------------
636
637 Click on "Comments" in edit bar to toggle the comments visibility.
638
639 ---%<-------------------------------------------------------------------------
640 {{{#!wiki comment/dotted
641 This is a wiki parser section with class "comment dotted" (see HelpOnParsers).
642
643 Its visibility gets toggled the same way.
644 }}}
645 ---%<-------------------------------------------------------------------------
646
647 This is a wiki parser section with class "comment dotted" (see
648 <HelpOnParsers.txt>).
649
650 Its visibility gets toggled the same way.
Attached Files
To refer to attachments on a page, use attachment:filename, as shown below in the list of files. Do NOT use the URL of the [get] link, since this is subject to change and can break easily.You are not allowed to attach a file to this page.