Skip to main content
The NCI Community Hub will be retiring in May 2024. For more information please visit the NCIHub Retirement Page:https://ncihub.cancer.gov/groups/ncihubshutdown/overview
close

Help: Wiki Formatting

Version
by (unknown)
Version 2
by (unknown)

Deletions or items before changed

Additions or items after changed

1 -
 
+
= Wiki Formatting =
2 +
3 +
Wiki markup is a core feature for Topic pages, tightly integrating all the other parts of Trac into a flexible and powerful whole.
4 +
5 +
This site has a built in small and powerful wiki rendering engine. This wiki engine implements an ever growing subset of the commands from other popular Wikis, especially [http://moinmoin.wikiwikiweb.de/ MoinMoin].
6 +
7 +
This page demonstrates the formatting syntax available anywhere [Help:WikiFormatting Wiki Formatting] is allowed.
8 +
9 +
== Font Styles ==
10 +
11 +
The pages supports the following font styles:
12 +
{{{
13 +
* '''bold''', '''!''' can be bold too''', and '''! '''
14 +
* ''italic''
15 +
* '''''bold italic'''''
16 +
* __underline__
17 +
* {{{monospace}}} or `monospace`
18 +
* ~~strike-through~~
19 +
* ^superscript^
20 +
* ,,subscript,,
21 +
}}}
22 +
23 +
Display:
24 +
* '''bold''', '''!''' can be bold too''', and '''! '''
25 +
* ''italic''
26 +
* '''''bold italic'''''
27 +
* __underline__
28 +
* {{{monospace}}} or `monospace`
29 +
* ~~strike-through~~
30 +
* ^superscript^
31 +
* ,,subscript,,
32 +
33 +
Notes:
34 +
* `{{{...}}}` and {{{`...`}}} commands not only select a monospace font, but also treat their content as verbatim text, meaning that no further wiki processing is done on this text.
35 +
* ` ! ` tells wiki parser to not take the following characters as wiki format, so pay attention to put a space after !, e.g. when ending bold.
36 +
37 +
== Headings ==
38 +
39 +
You can create heading by starting a line with one up to five ''equal'' characters ("=") followed by a single space and the headline text. The line should end with a space followed by the same number of ''='' characters. The heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.
40 +
41 +
Example:
42 +
{{{
43 +
= Heading =
44 +
== Subheading ==
45 +
=== About ''this'' ===
46 +
=== Explicit id === #using-explicit-id-in-heading
47 +
}}}
48 +
49 +
Display:
50 +
= Heading =
51 +
== Subheading ==
52 +
=== About ''this'' ===
53 +
=== Explicit id === #using-explicit-id-in-heading
54 +
55 +
== Paragraphs ==
56 +
57 +
A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
58 +
59 +
A forced line break can also be inserted, using:
60 +
{{{
61 +
Line 1[[BR]]Line 2
62 +
}}}
63 +
Display:
64 +
65 +
Line 1[[BR]]Line 2
66 +
67 +
== Lists ==
68 +
69 +
The wiki supports both ordered/numbered and unordered lists.
70 +
71 +
'''NOTE:''' The first character of a list item must be a space: " * text"
72 +
73 +
Example:
74 +
{{{
75 +
* Item 1
76 +
* Item 1.1
77 +
* Item 2
78 +
79 +
# Item 1
80 +
# Item 1.a
81 +
# Item 1.b
82 +
# Item 1.b.i
83 +
# Item 1.b.ii
84 +
# Item 2
85 +
}}}
86 +
87 +
Display:
88 +
* Item 1
89 +
* Item 1.1
90 +
* Item 2
91 +
92 +
# Item 1
93 +
# Item 1.a
94 +
# Item 1.b
95 +
# Item 1.b.i
96 +
# Item 1.b.ii
97 +
# Item 2
98 +
99 +
Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph.
100 +
101 +
== Definition Lists ==
102 +
103 +
The wiki also supports definition lists. Definition terms ''must'' start with '''one''' space " " and end with double colons. Definitions must be on the line immediately following the term and start with '''three''' spaces.
104 +
105 +
Example:
106 +
{{{
107 +
A line with no beginning spaces.
108 +
109 +
llama::
110 +
some kind of mammal, with hair
111 +
ppython::
112 +
some kind of reptile, without hair
113 +
(can you spot the typo?)
114 +
}}}
115 +
116 +
Display:
117 +
118 +
A line with no spaces.
119 +
llama::
120 +
some kind of mammal, with hair
121 +
ppython::
122 +
some kind of reptile, without hair
123 +
(can you spot the typo?)
124 +
125 +
== Preformatted Text ==
126 +
127 +
Block containing preformatted text are suitable for source code snippets, notes and examples. Use three ''curly braces'' wrapped around the text to define a block quote. The curly braces need to be on a separate line.
128 +
129 +
Example:
130 +
{{{
131 +
{{{
132 +
def HelloWorld():
133 +
print "Hello World"
134 +
}}}
135 +
}}}
136 +
137 +
Display:
138 +
{{{
139 +
def HelloWorld():
140 +
print "Hello World"
141 +
}}}
142 +
143 +
== Blockquotes ==
144 +
145 +
In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
146 +
147 +
Example:
148 +
{{{
149 +
This text is a quote from someone else.
150 +
}}}
151 +
152 +
Display:
153 +
This text is a quote from someone else.
154 +
155 +
156 +
Simple tables can be created like this:
157 +
{{{
158 +
||Cell 1||Cell 2||Cell 3||
159 +
||Cell 4||Cell 5||Cell 6||
160 +
}}}
161 +
162 +
Display:
163 +
164 +
||Cell 1||Cell 2||Cell 3||
165 +
||Cell 4||Cell 5||Cell 6||
166 +
167 +
Cell headings can be specified by wrapping the content in a pair of '=' characters. Note that the '=' characters have to stick to the cell separators, like this:
168 +
{{{
169 +
|| ||= stable =||= latest =||
170 +
||= 0.10 =|| 0.10.5 || 0.10.6dev||
171 +
||= 0.11 =|| 0.11.6 || 0.11.7dev||
172 +
}}}
173 +
174 +
Display:
175 +
176 +
|| ||= stable =||= latest =||
177 +
||= 0.10 =|| 0.10.5 || 0.10.6dev||
178 +
||= 0.11 =|| 0.11.6 || 0.11.7dev||
179 +
180 +
Finally, specifying an empty cell means that the next non empty cell will span the empty cells. For example:
181 +
182 +
{{{
183 +
|| 1 || 2 || 3 ||
184 +
|||| 1-2 || 3 ||
185 +
|| 1 |||| 2-3 ||
186 +
|||||| 1-2-3 ||
187 +
}}}
188 +
189 +
Display:
190 +
191 +
|| 1 || 2 || 3 ||
192 +
|||| 1-2 || 3 ||
193 +
|| 1 |||| 2-3 ||
194 +
|||||| 1-2-3 ||
195 +
196 +
To explicitly align content:
197 +
{{{
198 +
||= attribute list =||= longer column =||
199 +
||<. align left || longer text ||
200 +
||>. align right || longer text ||
201 +
||=. center || longer text ||
202 +
||<>. justify || longer text ||
203 +
||^. valign top || longer[[br]]text ||
204 +
||~. bottom || longer[[br]]text ||
205 +
}}}
206 +
207 +
Display:
208 +
209 +
||= attribute list =||= longer column =||
210 +
||<. align left || longer text ||
211 +
||>. align right || longer text ||
212 +
||=. center || longer text ||
213 +
||<>. justify || longer text ||
214 +
||^. valign top || longer[[br]]text ||
215 +
||~. bottom || longer[[br]]text ||
216 +
217 +
Note that if the content of a cell "sticks" to one side of the cell and only one, then the text will be aligned on that side. Explicit alignment (above) will override this. Example:
218 +
219 +
{{{
220 +
||=Text =||= Numbers =||
221 +
||left align || 1.0||
222 +
|| right align|| 4.5||
223 +
|| default alignment || 2.5||
224 +
||default|| 2.5||
225 +
|| default || 2.5||
226 +
|| default || 2.5||
227 +
||<. left align|| 4.5||
228 +
}}}
229 +
230 +
||=Text =||= Numbers =||
231 +
||left align || 1.0||
232 +
|| right align|| 4.5||
233 +
|| default alignment || 2.5||
234 +
||default|| 2.5||
235 +
|| default || 2.5||
236 +
|| default || 2.5||
237 +
||<. left align|| 4.5||
238 +
239 +
== Links ==
240 +
241 +
Hyperlinks are automatically created for [Help:WikiPageNames Wiki Page Names] and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
242 +
243 +
Example:
244 +
{{{
245 +
MainPage, http://www.edgewall.com/, !NotAlink
246 +
}}}
247 +
248 +
Display:
249 +
MainPage, http://www.edgewall.com/, !NotAlink
250 +
251 +
Links can be given a more descriptive title by writing the link followed by a space and a title and all this inside square brackets. If the descriptive title is omitted, then the explicit prefix is discarded, unless the link is an external link. This can be useful for wiki pages not adhering to the [Help:WikiPageNames Wiki Page Names] convention.
252 +
253 +
Example:
254 +
{{{
255 +
* [http://www.edgewall.com/ Edgewall Software]
256 +
* [MainPage Main Page]
257 +
* [Help:WikiMacros]
258 +
}}}
259 +
260 +
Display:
261 +
* [http://www.edgewall.com/ Edgewall Software]
262 +
* [MainPage Main Page]
263 +
* [Help:WikiMacros]
264 +
265 +
== Setting Anchors ==
266 +
267 +
An anchor, or more correctly speaking, an anchor name can be added explicitly at any place in the Wiki page, in order to uniquely identify a position in the document:
268 +
269 +
{{{
270 +
[=#point1]
271 +
}}}
272 +
273 +
It's also very close to the syntax for the corresponding link to that anchor:
274 +
275 +
{{{
276 +
[#point1]
277 +
}}}
278 +
279 +
Example usage:
280 +
281 +
{{{
282 +
[#point2 jump to the second point]
283 +
284 +
...
285 +
286 +
Point2: [=#point2] Jump here
287 +
}}}
288 +
289 +
[#point2 jump to the second point]
290 +
291 +
...
292 +
293 +
Point2: [=#point2] Jump here
294 +
295 +
== Escaping Links and Wiki Page Names ==
296 +
297 +
You may avoid making hyperlinks out of !WikiLinks by preceding an expression with a single "!" (exclamation mark).
298 +
299 +
Example:
300 +
{{{
301 +
!NoHyperLink
302 +
!#42 is not a link
303 +
}}}
304 +
305 +
Display:
306 +
!NoHyperLink
307 +
!#42 is not a link
308 +
309 +
== Images ==
310 +
311 +
The simplest way to include an image is to upload it as attachment to the current page, and put the filename in a macro call like `[[Image(picture.gif)]]`.
312 +
313 +
In addition to the current page, it is possible to refer to other resources:
314 +
315 +
* `[[Image(picture.gif)]]` (simplest)
316 +
* `[[Image(picture.gif, 120px)]]` (give it a specific width)
317 +
* `[[Image(picture.gif, right)]]` (align by keyword)
318 +
* `[[Image(picture.gif, nolink)]]` (unlinked)
319 +
* `[[Image(picture.gif, align=right)]]` (align by attribute)
320 +
321 +
See [Help:WikiMacros Help: Wiki Macros] for further documentation on the `[[Image()]]` macro.
322 +
323 +
== Macros ==
324 +
325 +
Macros are ''custom functions'' to insert dynamic content in a page.
326 +
327 +
Example:
328 +
{{{
329 +
[[Timestamp]]
330 +
}}}
331 +
332 +
Display:
333 +
[[Timestamp]]
334 +
335 +
See [Help:WikiMacros Wiki Macros] for more information, and a list of installed macros.
336 +
337 +
== Miscellaneous ==
338 +
339 +
Four or more dashes will be replaced by a horizontal line.
340 +
341 +
Example:
342 +
{{{
343 +
----
344 +
}}}
345 +
346 +
Display:
347 +
----