Help: Wiki Formatting

Search

Search pages

Wiki

Tools

Version 2
by (unknown)
Version 3
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.
+
Wiki markup is a core feature for Wiki pages, tightly integrating all the other parts of Trac into a flexible and powerful whole.
4
5 -
nanoHUB 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].
+
The HUB development team 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 Example:
72 {{{
73 * Item 1
74 * Item 1.1
75 * Item 2
76
77 # Item 1
78 # Item 1.a
79 # Item 1.b
80 # Item 1.b.i
81 # Item 1.b.ii
82 # Item 2
83 }}}
84
85 Display:
86 * Item 1
87 * Item 1.1
88 * Item 2
89
90 # Item 1
91 # Item 1.a
92 # Item 1.b
93 # Item 1.b.i
94 # Item 1.b.ii
95 # Item 2
96
97 Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph.
98
99 == Definition Lists ==
100
101 The wiki also supports definition lists.
102
103 Example:
104 {{{
105 llama::
106 some kind of mammal, with hair
107 ppython::
108 some kind of reptile, without hair
109 (can you spot the typo?)
110 }}}
111
112 Display:
113 llama::
114 some kind of mammal, with hair
115 ppython::
116 some kind of reptile, without hair
117 (can you spot the typo?)
118
119 == Preformatted Text ==
120
121 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.
122
123 Example:
124 {{{
125 {{{
126 def HelloWorld():
127 print "Hello World"
128 }}}
129 }}}
130
131 Display:
132 {{{
133 def HelloWorld():
134 print "Hello World"
135 }}}
136
137 == Blockquotes ==
138
139 In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
140
141 Example:
142 {{{
143 This text is a quote from someone else.
144 }}}
145
146 Display:
147 This text is a quote from someone else.
148
149 == Tables ==
150
151 Simple tables can be created like this:
152 {{{
153 ||Cell 1||Cell 2||Cell 3||
154 ||Cell 4||Cell 5||Cell 6||
155 }}}
156
157 Display:
158
159 ||Cell 1||Cell 2||Cell 3||
160 ||Cell 4||Cell 5||Cell 6||
161
162 == Links ==
163
164 Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
165
166 Example:
167 {{{
168 MainPage, http://www.edgewall.com/, !NotAlink
169 }}}
170
171 Display:
172 MainPage, http://www.edgewall.com/, !NotAlink
173
174 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.
175
176 Example:
177 {{{
178 * [http://www.edgewall.com/ Edgewall Software]
179 * [MainPage Main Page]
180 * [Help:WikiMacros]
181 }}}
182
183 Display:
184 * [http://www.edgewall.com/ Edgewall Software]
185 * [MainPage Main Page]
186 * [Help:WikiMacros]
187
188 == Escaping Links and WikiPageNames ==
189
190 You may avoid making hyperlinks out of !TracLinks by preceding an expression with a single "!" (exclamation mark).
191
192 Example:
193 {{{
194 !NoHyperLink
195 !#42 is not a link
196 }}}
197
198 Display:
199 !NoHyperLink
200 !#42 is not a link
201
202 == Images ==
203
204 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)]]`.
205
206 In addition to the current page, it is possible to refer to other resources:
207
208 * `[[Image(picture.gif)]]` (simplest)
209 * `[[Image(picture.gif, 120px)]]` (give it a specific width)
210 * `[[Image(picture.gif, right)]]` (align by keyword)
211 * `[[Image(picture.gif, nolink)]]` (unlinked)
212 * `[[Image(picture.gif, align=right)]]` (align by attribute)
213
214 See [Help:WikiMacros Help: Wiki Macros] for further documentation on the `[[Image()]]` macro.
215
216 == Macros ==
217
218 Macros are ''custom functions'' to insert dynamic content in a page.
219
220 Example:
221 {{{
222 [[Timestamp]]
223 }}}
224
225 Display:
226 [[Timestamp]]
227
228 See [Help:WikiMacros Wiki Macros] for more information, and a list of installed macros.
229
230 == Miscellaneous ==
231
232 Four or more dashes will be replaced by a horizontal line.
233
234 Example:
235 {{{
236 ----
237 }}}
238
239 Display:
240 ----