← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/moin/gutsy

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sivan Greenberg
  • Date: 2006-07-09 19:28:02 UTC
  • Revision ID: james.westby@ubuntu.com-20060709192802-oaeuvt4v3e9300uj
Tags: 1.5.3-1ubuntu1
* Merge new debian version.
* Reapply Ubuntu changes:
    + debian/rules:
      - Comment out usage of control.ubuntu.in (doesn't fit!).
    + debian/control.in:
      - Dropped python2.3 binary package.
    + debian/control:
      - Dropped python2.3 binary, again.
      - Dropped python2.3-dev from Build-Depends-Indep.
    + debian/patches/001-attachment-xss-fix.patch:
      - Dropped this patch. It's now in upstream's distribution.

Show diffs side-by-side

added added

removed removed

Lines of Context:
wiki/underlay/pages/SyntaxReference/revisions/00000001
5
5
#acl MoinPagesEditorGroup:read,write,delete,revert All:read
6
6
#format wiki
7
7
#language en
8
 
#pragma section-numbers off
9
 
 
10
 
{{{
11
 
#pragma section-numbers off
12
 
#acl All:admin,read,write,delete,revert
13
 
#language en
14
 
}}}
15
 
 
16
 
This page tries to use each supported markup element at least once.
17
 
 
18
 
{{{
19
 
'''Index'''
20
 
[[TableOfContents(2)]]
21
 
}}}
22
 
'''Index'''
23
 
 
24
 
[[TableOfContents(2)]]
25
 
 
26
 
{{{
27
 
= Headers =
28
 
== Header 2 ==
29
 
=== Header 3 ===
30
 
==== Header 4 ====
31
 
===== Header 5 =====
32
 
}}}
33
 
= Headers =
34
 
== Header 2 ==
35
 
=== Header 3 ===
36
 
==== Header 4 ====
37
 
===== Header 5 =====
38
 
 
39
 
= Font styles =
40
 
{{{
41
 
Normal text, ''emphasized'', '''strong''', __underline__, ,,subscript,,, ^superscript^, `typewriter` and {{{typewriter}}}, --(stroke)--.
42
 
}}}
43
 
 
44
 
Normal text, ''emphasized'', '''strong''', __underline__, ,,subscript,,, ^superscript^, `typewriter` and {{{typewriter}}}, --(stroke)--.
45
 
 
46
 
== Syntax Highlighting ==
47
 
{{{
48
 
 {{{#!python
49
 
# python code
50
 
print code.colorize("abc", 1 + 1)
51
 
} } }
52
 
}}}
53
 
/!\ Remove spaces in "`} } }`" at last line
54
 
 {{{#!python
55
 
# python code
56
 
print code.colorize("abc", 1 + 1)
57
 
}}}
58
 
 
59
 
= Smileys =
60
 
[[ShowSmileys]]
 
8
 
 
9
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.
 
10
 
 
11
= Table of Contents =
 
12
{{{
 
13
'''Contents''' (up to the 2nd level)
 
14
[[TableOfContents(2)]]
 
15
}}}
 
16
'''Contents''' (up to the 2nd level)
 
17
[[TableOfContents(2)]]
 
18
 
 
19
= Headings =
 
20
'''''see:''' HelpOnHeadlines''
 
21
{{{
 
22
= heading 1st level =
 
23
== heading 2nd level ==
 
24
=== heading 3rd level ===
 
25
==== heading 4th level ====
 
26
===== heading 5th level =====
 
27
}}}
 
28
= heading 1st level =
 
29
== heading 2nd level ==
 
30
=== heading 3rd level ===
 
31
==== heading 4th level ====
 
32
===== heading 5th level =====
 
33
 
 
34
= Text Formatting =
 
35
'''''see:''' HelpOnFormatting''
 
36
{{{
 
37
 * ''emphasized (italics)''
 
38
 * '''boldface'''
 
39
 * '''''bold italics'''''
 
40
 * `monospace`
 
41
 * {{{source code}}}
 
42
 * __underline__
 
43
 * ,,sub,,script
 
44
 * ^super^script
 
45
 * ~-smaller-~
 
46
 * ~+larger+~
 
47
 * --(strike through)--
 
48
}}}
 
49
 * ''emphasized (italics)''
 
50
 * '''boldface'''
 
51
 * '''''bold italics'''''
 
52
 * `monospace`
 
53
 * {{{source code}}}
 
54
 * __underline__
 
55
 * ,,sub,,script
 
56
 * ^super^script
 
57
 * ~-smaller-~
 
58
 * ~+larger+~
 
59
 * --(strike through)--
61
60
 
62
61
= Hyperlinks =
63
 
== Internal ==
64
 
{{{
65
 
 * MoinMoin
66
 
 * MoinMoin/TextFormatting
67
 
 * MoinMoin/InstallDocs
68
 
 * ../InstallDocs
69
 
 * /SubPage
70
 
 * Self:InterWiki
71
 
}}}
72
 
 * MoinMoin
73
 
 * MoinMoin/TextFormatting
74
 
 * MoinMoin/InstallDocs
75
 
 * ../InstallDocs
76
 
 * /SubPage
77
 
 * Self:InterWiki
78
 
 
79
 
{{{
80
 
[#anchorname Anchor Link]
81
 
}}}
82
 
[#anchorname Anchor Link]
83
 
 
84
 
== External ==
85
 
{{{
86
 
 * http://moinmoin.wikiwikiweb.de/
87
 
 * [http://moinmoin.wikiwikiweb.de/]
88
 
 * [http://moinmoin.wikiwikiweb.de/ MoinMoin Wiki]
89
 
 * [http://moinmoin.wikiwikiweb.de/wiki/common/moinmoin.png]
90
 
 * http://moinmoin.wikiwikiweb.de/wiki/common/moinmoin.png
91
 
 * [http://moinmoin.wikiwikiweb.de/wiki/common/moinmoin.png moinmoin.png]
92
 
 * MeatBall:InterWiki
93
 
 * wiki:MeatBall/InterWiki
94
 
 * [wiki:MeatBall/InterWiki]
95
 
 * [wiki:MeatBall/InterWiki InterWiki page on MeatBall]
96
 
 * [file://///servername/share/full/path/to/file/filename%20with%20spaces.txt Click here to read filename with spaces.txt]
97
 
 * user@example.com
98
 
}}}
99
 
 * http://moinmoin.wikiwikiweb.de/
100
 
 * [http://moinmoin.wikiwikiweb.de/]
101
 
 * [http://moinmoin.wikiwikiweb.de/ MoinMoin Wiki]
102
 
 * [http://moinmoin.wikiwikiweb.de/wiki/common/moinmoin.png]
103
 
 * http://moinmoin.wikiwikiweb.de/wiki/common/moinmoin.png
104
 
 * [http://moinmoin.wikiwikiweb.de/wiki/common/moinmoin.png moinmoin.png]
105
 
 * MeatBall:InterWiki
106
 
 * wiki:MeatBall/InterWiki
107
 
 * [wiki:MeatBall/InterWiki]
108
 
 * [wiki:MeatBall/InterWiki InterWiki page on MeatBall]
109
 
 * [file://///servername/share/full/path/to/file/filename%20with%20spaces.txt Click here to read filename with spaces.txt]
110
 
 * user@example.com
111
 
== Escaping WikiNames ==
112
 
{{{
113
 
Wiki''''''Name
114
 
Wiki``Name
115
 
!WikiName
116
 
}}}
117
 
Wiki''''''Name
118
 
Wiki``Name
119
 
!WikiName
120
 
 
121
 
/!\ The third way is valid only when the configuration option `bang_meta` is set to true. Refer HelpOnLinking for details.
122
 
 
123
 
= Blockquote =
124
 
{{{
125
 
 This is indented
126
 
  Even more
127
 
}}}
128
 
 This is indented
129
 
  Even more
130
 
 
131
 
= Bullet list =
132
 
{{{
133
 
 * item 1
134
 
 
135
 
 * item 2, with gap
136
 
 * item 3
137
 
   * item 3.1
138
 
}}}
139
 
 * item 1
140
 
 
141
 
 * item 2, with gap
142
 
 * item 3
143
 
   * item 3.1
144
 
= Numbered list =
145
 
{{{
146
 
 1. item 1
147
 
   i. item 1
148
 
   i. item 2
149
 
}}}
150
 
 1. item 1
151
 
   i. item 1
152
 
   i. item 2
153
 
{{{
154
 
 1. item 2
155
 
   a. item 1
156
 
   a. item 2
157
 
}}}
158
 
 1. item 2
159
 
   a. item 1
160
 
   a. item 2
161
 
= Descriptions + Definitions =
162
 
{{{
163
 
 Term:: Description
164
 
 Label:: Definition
165
 
}}}
166
 
 Term:: Description
167
 
 Label:: Definition
168
 
= Code display =
169
 
{{{
170
 
 {{{
171
 
line 1
172
 
    indented 4 characters
173
 
} } }
174
 
}}}
175
 
/!\ Remove spaces in "`} } }`" at last line
176
 
 {{{
177
 
line 1
178
 
    indented 4 characters
179
 
}}}
 
62
'''''see:''' HelpOnLinking''
 
63
== Internal Links ==
 
64
{{{
 
65
 * FrontPage
 
66
 * ["FrontPage"]
 
67
 * HelpOnEditing/SubPages
 
68
 * /SubPage
 
69
 * ../SiblingPage
 
70
 * [:FrontPage:named link]
 
71
 * [#anchorname]
 
72
 * [#anchorname description]
 
73
 * [wiki:Self:PageName#anchorname]
 
74
 * [wiki:Self:PageName#anchorname description]
 
75
 * attachment:filename.txt
 
76
}}}
 
77
 * FrontPage
 
78
 * ["FrontPage"]
 
79
 * HelpOnEditing/SubPages
 
80
 * /SubPage
 
81
 * ../SiblingPage
 
82
 * [:FrontPage:named link]
 
83
 * [#anchorname]
 
84
 * [#anchorname description]
 
85
 * [wiki:Self:PageName#anchorname]
 
86
 * [wiki:Self:PageName#anchorname description]
 
87
 * attachment:filename.txt
 
88
 
 
89
== External Links ==
 
90
{{{
 
91
 * http://moinmoin.wikiwikiweb.de/
 
92
 * [http://moinmoin.wikiwikiweb.de/]
 
93
 * [http://moinmoin.wikiwikiweb.de/ MoinMoin Wiki]
 
94
 * [http://moinmoin.wikiwikiweb.de/wiki/moinmoin.png]
 
95
 * http://moinmoin.wikiwikiweb.de/wiki/moinmoin.png
 
96
 * [http://moinmoin.wikiwikiweb.de/wiki/moinmoin.png moinmoin.png]
 
97
 * MeatBall:InterWiki
 
98
 * wiki:MeatBall/InterWiki
 
99
 * [wiki:MeatBall/InterWiki]
 
100
 * [wiki:MeatBall/InterWiki InterWiki page on MeatBall]
 
101
 * [file://///servername/share/full/path/to/file/filename%20with%20spaces.txt link to file filename with spaces.txt]
 
102
 * user@example.com
 
103
}}}
 
104
 * http://moinmoin.wikiwikiweb.de/
 
105
 * [http://moinmoin.wikiwikiweb.de/]
 
106
 * [http://moinmoin.wikiwikiweb.de/ MoinMoin Wiki]
 
107
 * [http://moinmoin.wikiwikiweb.de/wiki/moinmoin.png]
 
108
 * http://moinmoin.wikiwikiweb.de/wiki/moinmoin.png
 
109
 * [http://moinmoin.wikiwikiweb.de/wiki/moinmoin.png moinmoin.png]
 
110
 * MeatBall:InterWiki
 
111
 * wiki:MeatBall/InterWiki
 
112
 * [wiki:MeatBall/InterWiki]
 
113
 * [wiki:MeatBall/InterWiki InterWiki page on MeatBall]
 
114
 * [file://///servername/share/full/path/to/file/filename%20with%20spaces.txt link to file filename with spaces.txt]
 
115
 * user@example.com
 
116
 
 
117
== Avoid or Limit Automatical Linking ==
 
118
{{{
 
119
 * Wiki''''''Name
 
120
 * Wiki``Name
 
121
 * !WikiName
 
122
 * WikiName''''''s
 
123
 * WikiName``s
 
124
 * `http://www.example.com`
 
125
}}}
 
126
 * Wiki''''''Name
 
127
 * Wiki``Name
 
128
 * !WikiName
 
129
 * WikiName''''''s
 
130
 * WikiName``s
 
131
 * `http://www.example.com`
 
132
 
 
133
= Blockquotes and Indentions =
 
134
{{{
 
135
 indented text
 
136
  text indented to the 2nd level
 
137
}}}
 
138
 indented text
 
139
  text indented to the 2nd level
 
140
 
 
141
= Lists =
 
142
'''''see:''' HelpOnLists''
 
143
== Unordered Lists ==
 
144
{{{
 
145
 * item 1
 
146
 
 
147
 * item 2 (preceding white space)
 
148
  * item 2.1
 
149
   * item 2.1.1
 
150
 * item 3
 
151
  . item 3.1 (bulletless)
 
152
 . item 4 (bulletless)
 
153
  * item 4.1
 
154
   . item 4.1.1 (bulletless)
 
155
}}}
 
156
 * item 1
 
157
 
 
158
 * item 2 (preceding white space)
 
159
  * item 2.1
 
160
   * item 2.1.1
 
161
 * item 3
 
162
  . item 3.1 (bulletless)
 
163
 . item 4 (bulletless)
 
164
  * item 4.1
 
165
   . item 4.1.1 (bulletless)
 
166
 
 
167
== Ordered Lists ==
 
168
=== with Numbers ===
 
169
{{{
 
170
 1. item 1
 
171
   1. item 1.1
 
172
   1. item 1.2
 
173
 1. item 2
 
174
}}}
 
175
 1. item 1
 
176
   1. item 1.1
 
177
   1. item 1.2
 
178
 1. item 2
 
179
 
 
180
=== with Roman Numbers ===
 
181
{{{
 
182
 I. item 1
 
183
   i. item 1.1
 
184
   i. item 1.2
 
185
 I. item 2
 
186
}}}
 
187
 I. item 1
 
188
   i. item 1.1
 
189
   i. item 1.2
 
190
 I. item 2
 
191
 
 
192
=== with Letters ===
 
193
{{{
 
194
 A. item A
 
195
   a. item A. a)
 
196
   a. item A. b)
 
197
 A. item B
 
198
}}}
 
199
 A. item A
 
200
   a. item A. a)
 
201
   a. item A. b)
 
202
 A. item B
 
203
 
 
204
== Definition Lists ==
 
205
{{{
 
206
 term:: definition
 
207
 object:: description 1
 
208
 :: description 2
 
209
 Action Items::
 
210
 :: First Item
 
211
 :: Second Item
 
212
}}}
 
213
 term:: definition
 
214
 object:: description 1
 
215
 :: description 2
 
216
 Action Items::
 
217
 :: First Item
 
218
 :: Second Item
 
219
 
 
220
= Horizontal Rules =
 
221
'''''see:''' HelpOnRules''
 
222
{{{
 
223
----
 
224
-----
 
225
------
 
226
-------
 
227
--------
 
228
---------
 
229
----------
 
230
}}}
 
231
----
 
232
-----
 
233
------
 
234
-------
 
235
--------
 
236
---------
 
237
----------
180
238
 
181
239
= Tables =
182
 
== General table layout and HTML like options ==
183
 
{{{
184
 
 ||||||<tablewidth="80%">'''Heading'''||
185
 
 ||cell 1||cell2||cell 3||
186
 
 ||<rowspan=2> spanning rows||||<bgcolor="#AAAAFF"> spanning 2 columns||
187
 
 ||<rowbgcolor="#FFFFAA">cell2||cell 3||
188
 
}}}
189
 
 ||||||<tablewidth="80%">'''Heading'''||
190
 
 ||cell 1||cell2||cell 3||
191
 
 ||<rowspan=2> spanning rows||||<bgcolor="#AAAAFF"> spanning 2 columns||
192
 
 ||<rowbgcolor="#FFFFAA">cell2||cell 3||
193
 
 
194
 
== Cell width ==
195
 
{{{
196
 
 || narrow ||<:99%> wide ||
197
 
}}}
198
 
 || narrow ||<:99%> wide ||
199
 
 
200
 
== Spanning rows and columns ==
201
 
{{{
202
 
 ||<|2> 2 rows || row 1 ||
203
 
 || row 2 ||
204
 
 ||<-2> row 3 over 2 columns ||
205
 
}}}
206
 
 ||<|2> 2 rows || row 1 ||
207
 
 || row 2 ||
208
 
 ||<-2> row 3 over 2 columns ||
209
 
 
210
 
== Alignment ==
211
 
{{{
212
 
 ||<(> left ||<^|3> top ||<v|3> bottom ||
213
 
 ||<:> centered ||
214
 
 ||<)> right ||
215
 
}}}
216
 
 ||<(> left ||<^|3> top ||<v|3> bottom ||
217
 
 ||<:> centered ||
218
 
 ||<)> right ||
219
 
 
220
 
== Colors ==
221
 
{{{
222
 
 ||<#FF8080> red ||<#80FF80> green ||<#8080FF> blue ||
223
 
}}}
224
 
 ||<#FF8080> red ||<#80FF80> green ||<#8080FF> blue ||
225
 
 
226
 
== CSV Tables ==
227
 
 
228
 
=== Data separated by semicolons and hide column 2 ===
229
 
{{{
230
 
 {{{#!CSV -2
231
 
Col1;Col2;Col3;Col4
232
 
1;2;3;4
233
 
a;b;c;d
234
 
} } }
235
 
}}}
236
 
/!\ Remove spaces in "`} } }`" at last line
237
 
 {{{#!CSV -2
238
 
Col1;Col2;Col3;Col4
239
 
1;2;3;4
240
 
a;b;c;d
241
 
}}}
242
 
 
243
 
=== Data separated by commas ===
244
 
{{{
245
 
 {{{#!CSV ,
246
 
Col1,Col2,Col3,Col4
247
 
1,2,3,4
248
 
a,b,c,d
249
 
} } }
250
 
}}}
251
 
/!\ Remove spaces in "`} } }`" at last line
252
 
 {{{#!CSV ,
253
 
Col1,Col2,Col3,Col4
254
 
1,2,3,4
255
 
a,b,c,d
256
 
}}}
257
 
 
258
 
= Rules =
259
 
{{{
260
 
--- (not a rule)
261
 
----
262
 
-----
263
 
------
264
 
-------
265
 
--------
266
 
---------
267
 
----------
268
 
-------------------------------------------- (not thicker than 10)
269
 
}}}
270
 
--- (not a rule)
271
 
----
272
 
-----
273
 
------
274
 
-------
275
 
--------
276
 
---------
277
 
----------
278
 
-------------------------------------------- (not thicker than 10)
279
 
 
280
 
= Macros =
281
 
{{{
282
 
[[Anchor(anchorname)]] <=(no display)
283
 
'''[[PageCount]]''' pages
284
 
[[RandomPage]]
285
 
}}}
286
 
[[Anchor(anchorname)]] <=(no display)
287
 
'''[[PageCount]]''' pages
288
 
[[RandomPage]]
 
240
'''''see:''' HelpOnTables''
 
241
== Tables ==
 
242
{{{
 
243
||'''A'''||'''B'''||'''C'''||
 
244
||1      ||2      ||3      ||
 
245
}}}
 
246
||'''A'''||'''B'''||'''C'''||
 
247
||1      ||2      ||3      ||
 
248
 
 
249
== Cell Width ==
 
250
{{{
 
251
||minimal width ||<99%>maximal width ||
 
252
}}}
 
253
||minimal width ||<99%>maximal width ||
 
254
 
 
255
== Spanning Rows and Columns  ==
 
256
{{{
 
257
||<|2> cell spanning 2 rows ||cell in the 2nd column ||
 
258
||cell in the 2nd column of the 2nd row ||
 
259
||<-2> cell spanning 2 columns ||
 
260
||||use empty cells as a shorthand ||
 
261
}}}
 
262
||<|2> cell spanning 2 rows ||cell in the 2nd column ||
 
263
||cell in the 2nd column of the 2nd row ||
 
264
||<-2> cell spanning 2 columns ||
 
265
||||use empty cells as a shorthand ||
 
266
 
 
267
== Alignment of Cell Contents ==
 
268
{{{
 
269
||<^|3> top (combined) ||<:99%> center (combined) ||<v|3> bottom (combined) ||
 
270
||<)> right ||
 
271
||<(> left ||
 
272
}}}
 
273
||<^|3> top (combined) ||<:99%> center (combined) ||<v|3> bottom (combined) ||
 
274
||<)> right ||
 
275
||<(> left ||
 
276
 
 
277
== Coulored Table Cells ==
 
278
{{{
 
279
||<#0000FF> blue ||<#00FF00> green    ||<#FF0000> red    ||
 
280
||<#00FFFF> cyan ||<#FF00FF> magenta  ||<#FFFF00> yellow ||
 
281
}}}
 
282
||<#0000FF> blue ||<#00FF00> green    ||<#FF0000> red    ||
 
283
||<#00FFFF> cyan ||<#FF00FF> magenta  ||<#FFFF00> yellow ||
 
284
 
 
285
== HTML-like Options for Tables ==
 
286
{{{
 
287
||A ||<rowspan="2"> like <|2> ||
 
288
||<bgcolor="#00FF00"> like <#00FF00> ||
 
289
||<colspan="2"> like <-2>||
 
290
}}}
 
291
||A ||<rowspan="2"> like <|2> ||
 
292
||<bgcolor="#00FF00"> like <#00FF00> ||
 
293
||<colspan="2"> like <-2>||
 
294
 
 
295
= Macros and Variables =
 
296
== Macros ==
 
297
'''''see:''' HelpOnMacros''
 
298
 * `[[Anchor(anchorname)]]` inserts a link anchor `anchorname`
 
299
 * `[[BR]]` inserts a hard line break
 
300
 * `[[FootNote(Note)]]` inserts a footnote saying `Note`
 
301
 * `[[Include(HelpOnMacros/Include)]]` inserts the contents of the page `HelpOnMacros/Include` inline
 
302
 * `[[MailTo(user AT example DOT com)]]` obfuscates the email address `user@example.com` to users not logged in
 
303
 
 
304
== Variables ==
 
305
'''''see:''' HelpOnVariables''
 
306
 * `@``SIG``@` inserts your login name and timestamp of modification
 
307
 * `@``TIME``@` inserts date and time of modification
 
308
 
 
309
= Smileys and Icons =
 
310
'''''see:''' HelpOnSmileys''
 
311
[[ShowSmileys]]
 
312
 
 
313
= Source code =
 
314
'''''see:''' HelpOnParsers''
 
315
== Verbatim Display ==
 
316
{{{
 
317
{ { {
 
318
def hello():
 
319
    print "Hello World!"
 
320
} } }
 
321
}}}
 
322
/!\ Remove spaces between "`{ { {`" and "`} } }`".
 
323
{{{
 
324
def hello():
 
325
    print "Hello World!"
 
326
}}}
 
327
 
 
328
== Syntax Highlighting ==
 
329
{{{
 
330
{ { {#!python
 
331
def hello():
 
332
    print "Hello World!"
 
333
} } }
 
334
}}}
 
335
/!\ Remove spaces between "`{ { {`" and "`} } }`".
 
336
{{{#!python
 
337
def hello():
 
338
    print "Hello World!"
 
339
}}}