Support

Support Options

Submit a Support Ticket

 
You are here: Home » Topics » Help: Wiki Formatting » Compare

Help: Wiki Formatting

Version 3
by Rajesh Thyagarajan
Version 8
by Sam Wilson

Deletions or items before changed

Additions or items after changed

1 -
=== Wiki Formatting is a shorthand html notation: ===
+
= Wiki Formatting =
2
3 -
{{{= H1 =}}}
+
Wiki markup is a core feature for Topic pages, tightly integrating all the other parts of Trac into a flexible and powerful whole.
4 -
= Heading Level 1 =
+
5 -
{{{= H2 =}}}
+
6 -
== Heading Level 2 ==
+
7 -
{{{ '''Bold Text''' }}} '''Bold text'''
+
8
9 -
{{{ ''Italic Text'' }}}''Italic text''
+
NEEShub 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://moinmo.in/MoinMoinWiki MoinMoin].
10
11 -
{{{ __Underlined Text__ }}} __Underlined Text__
+
This page demonstrates the formatting syntax available anywhere [Help:WikiFormatting Wiki Formatting] is allowed.
12
13 -
{{{ ^Superscript Text^ }}} ^Superscript Text^
+
== Font Styles ==
14
15 -
{{{ ,,Subscript Text,, }}} ,,Subscript Text,,
+
The pages supports the following font styles:
16
17 -
{{{ --Strikethrough Text-- }}} ~~Strikethrough Text~~
+
{{{
18 +
* '''bold''', '''!''' can be bold too''', and '''! '''
19 +
* ''italic''
20 +
* '''''bold italic'''''
21 +
* __underline__
22 +
* {{{monospace}}} or `monospace`
23 +
* ~~strike-through~~
24 +
* ^superscript^
25 +
* ,,subscript,,
26 +
}}}
27
28 -
{{{<}}}math{{{>}}} Math ML formula {{{<}}}/math{{{>}}} Math ML Formula
+
Display:
29
30 +
* '''bold''', '''!''' can be bold too''', and '''! '''
31 +
* ''italic''
32 +
* '''''bold italic'''''
33 +
* __underline__
34 +
* {{{monospace}}} or `monospace`
35 +
* ~~strike-through~~
36 +
* ^superscript^
37 +
* ,,subscript,,
38
39 -
Create tables using vertical bars: {{{ || }}} cell {{{ || }}} cell {{{ || }}}
+
Notes:
40
41 -
||cell1||cell2||
+
* `{{{...}}}` 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.
42 -
||cell3||cell4||
+
* ` ! ` 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.
43
44 -
{{{ ---- }}} Horizontal Line
+
== Headings ==
45 +
46 +
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.
47 +
48 +
Example:
49 +
50 +
{{{
51 +
= Heading =
52 +
== Subheading ==
53 +
=== About ''this'' ===
54 +
=== Explicit id === #using-explicit-id-in-heading
55 +
}}}
56 +
57 +
Display:
58 +
59 +
= Heading =
60 +
== Subheading ==
61 +
=== About ''this'' ===
62 +
=== Explicit id === #using-explicit-id-in-heading
63 +
64 +
== Paragraphs ==
65 +
66 +
A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
67 +
68 +
A forced line break can also be inserted, using:
69 +
70 +
{{{
71 +
Line 1[[BR]]Line 2
72 +
}}}
73 +
74 +
Display:
75 +
76 +
Line 1[[BR]]Line 2
77 +
78 +
== Lists ==
79 +
80 +
The wiki supports both ordered/numbered and unordered lists. Note that a space is required before the initial asterisk or number sign.
81 +
82 +
Example:
83 +
84 +
{{{
85 +
* Item 1
86 +
* Item 1.1
87 +
* Item 2
88 +
89 +
# Item 1
90 +
# Item 1.a
91 +
# Item 1.b
92 +
# Item 1.b.i
93 +
# Item 1.b.ii
94 +
# Item 2
95 +
}}}
96 +
97 +
Display:
98 +
99 +
* Item 1
100 +
* Item 1.1
101 +
* Item 2
102 +
103 +
# Item 1
104 +
# Item 1.a
105 +
# Item 1.b
106 +
# Item 1.b.i
107 +
# Item 1.b.ii
108 +
# Item 2
109 +
110 +
Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph.
111 +
112 +
== Definition Lists ==
113 +
114 +
The wiki also supports definition lists.
115 +
116 +
Example:
117 +
118 +
{{{
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 +
126 +
Display:
127 +
128 +
llama::
129 +
some kind of mammal, with hair
130 +
ppython::
131 +
some kind of reptile, without hair
132 +
(can you spot the typo?)
133 +
134 +
135 +
Note that you need a space in front of the defined term.
136 +
137 +
== Preformatted Text ==
138 +
139 +
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.
140 +
141 +
Example:
142 +
143 +
{{{
144 +
{{{
145 +
def HelloWorld():
146 +
print "Hello World"
147 +
}}}
148 +
}}}
149 +
150 +
Display:
151 +
152 +
{{{
153 +
def HelloWorld():
154 +
print "Hello World"
155 +
}}}
156 +
157 +
Note that this type of formatting can also be used to display html with minor changes in the syntax.
158 +
See [Help:WikiHtml] for details.
159 +
160 +
== Tables ==
161 +
162 +
Simple tables can be created like this:
163 +
164 +
{{{
165 +
||Cell 1||Cell 2||Cell 3||
166 +
||Cell 4||Cell 5||Cell 6||
167 +
}}}
168 +
169 +
Display:
170 +
171 +
||Cell 1||Cell 2||Cell 3||
172 +
||Cell 4||Cell 5||Cell 6||
173 +
174 +
175 +
== Links ==
176 +
177 +
Hyperlinks are automatically created for WikiPageNames (words with capital letters in the middle) and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
178 +
179 +
Example:
180 +
181 +
{{{
182 +
MainPage, http://www.edgewall.com/, !NotAlink
183 +
}}}
184 +
185 +
Display:
186 +
187 +
MainPage, http://www.edgewall.com/, !NotAlink
188 +
189 +
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 WikiPageNames convention.
190 +
191 +
Example:
192 +
193 +
{{{
194 +
* [http://www.edgewall.com/ Edgewall Software]
195 +
* [MainPage Main Page]
196 +
* [Help:WikiMacros]
197 +
}}}
198 +
199 +
Display:
200 +
201 +
* [http://www.edgewall.com/ Edgewall Software]
202 +
* [MainPage Main Page]
203 +
* [Help:WikiMacros]
204 +
205 +
== Escaping Links and WikiPageNames ==
206 +
207 +
You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).
208 +
209 +
Example:
210 +
211 +
{{{
212 +
!NoHyperLink
213 +
}}}
214 +
215 +
Display:
216 +
217 +
!NoHyperLink
218 +
219 +
== Images ==
220 +
221 +
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)]]`.
222 +
223 +
In addition to the current page, it is possible to refer to other resources:
224 +
225 +
* `[[Image(picture.gif)]]` (simplest)
226 +
* `[[Image(picture.gif, 120px)]]` (give it a specific width)
227 +
* `[[Image(picture.gif, align-right)]]` (add the CSS class "align-right" to the image)
228 +
* `[[Image(picture.gif, nolink)]]` (unlinked)
229 +
* `[[Image(picture.gif, align=right)]]` (align by attribute)
230 +
231 +
See [Help:WikiMacros Help: Wiki Macros] for further documentation on the `[[Image()]]` macro.
232 +
233 +
== Macros ==
234 +
235 +
Macros are ''custom functions'' to insert dynamic content in a page.
236 +
237 +
Example:
238 +
239 +
{{{
240 +
[[Timestamp]]
241 +
}}}
242 +
243 +
Display:
244 +
245 +
[[Timestamp]]
246 +
247 +
See [Help:WikiMacros Wiki Macros] for more information, and a list of installed macros.
248 +
249 +
== Miscellaneous ==
250 +
251 +
Four or more dashes will be replaced by a horizontal line.
252 +
253 +
Example:
254 +
255 +
{{{
256 +
----
257 +
}}}
258 +
259 +
Display:
260
261 ----