1= Sample Page for Wiki Markup =
2
3
4== General Notes ==
5
6The markup uses the Creole ([[http://www.wikicreole.org]]) style.
7
8All text is entered as plain text, and will be converted to HTML entities as
9necessary.  This means that {{{<}}}, {{{>}}}, {{{&}}}, and so on are converted
10for you (except in special situations where the characters are Wiki markup; the
11Wiki is generally smart enough to know when to convert and when not to).
12
13To add a single line break, insert a double backslash {{{\\}}}.\\
14Just hit "return" twice to make a paragraph break.
15
16
17== Inline Formatting ==
18
19| {{{//emphasis text//}}}                    | //emphasis text// |
20| {{{**strong text**}}}                      | **strong text** |
21| {{{//**emphasis and strong**//}}}          | //**emphasis and strong**// |
22| {{{__underline text__}}}                   | __underline text__ |
23| {{{{{{teletype text}}}}}}                  | {{{teletype text}}} |
24| {{{,,subscript,, text}}}                   | ,,subscript,, text |
25| {{{^^superscript^^ text}}}                 | ^^superscript^^ text |
26
27
28== Literal Text ==
29
30If you don't want the wiki to parse some text, enclose it in triple curly
31braces, or prefix the markup with a tilde.
32
33{{{
34This //text// gets **parsed**.
35
36{{{This //text// does not get **parsed**.}}}
37
38This ~//text// does not get ~**parsed**.
39}}}
40
41This //text// gets **parsed**.
42
43{{{This //text// does not get **parsed**.}}}
44
45This ~//text// does not get ~**parsed**.
46
47
48== Headings ==
49
50You can make various levels of heading by putting plus-signs before the text
51(all on its own line):
52
53{{{
54=== Level 3 Heading ===
55==== Level 4 Heading ====
56===== Level 5 Heading =====
57====== Level 6 Heading ======
58}}}
59
60=== Level 3 Heading ===
61==== Level 4 Heading ====
62===== Level 5 Heading =====
63====== Level 6 Heading ======
64
65
66== Text Alignment ==
67
68You can center align paragraphs by starting it with an equal sign.
69
70{{{
71! Center aligned text
72}}}
73
74! Center aligned text
75
76
77== Horizontal Rules ==
78
79Use four dashes ({{{----}}}) to create a horizontal rule.
80
81----
82
83
84== Lists ==
85
86
87=== Bullet Lists ===
88
89You can create bullet lists by starting a paragraph with one or more asterisks.
90
91{{{
92* Bullet one
93* Bullet two
94}}}
95
96* Bullet one
97* Bullet two
98
99
100=== Numbered Lists ===
101
102Similarly, you can create numbered lists by starting a paragraph with one or
103more hashes.
104
105{{{
106# Numero uno
107# Number two
108}}}
109
110# Numero uno
111# Number two
112
113
114=== Definition Lists ===
115
116You can create a definition (description) list with the following syntax:
117
118{{{
119: Item 1 : Something
120: Item 2 : Something else
121}}}
122
123: Item 1 : Something
124: Item 2 : Something else
125
126
127== Block Quotes ==
128
129You can mark a blockquote by starting a line with one or more '>' characters,
130followed by a space and the text to be quoted.
131
132{{{
133This is normal text here.
134
135> Indent me! The quick brown fox jumps over the lazy dog. Now this the time for all good men to come to the aid of their country. Notice how we can continue the block-quote in the same "paragraph" by using a backslash at the end of the line.
136>
137> Another block, leading to...
138>> Second level of indenting.  This second is indented even more than the previous one.
139
140Back to normal text.
141}}}
142
143This is normal text here.
144
145> Indent me! The quick brown fox jumps over the lazy dog. Now this the time for all good men to come to the aid of their country. Notice how we can continue the block-quote in the same "paragraph" by using a backslash at the end of the line.
146>
147> Another block, leading to...
148>> Second level of indenting.  This second is indented even more than the previous one.
149
150Back to normal text.
151
152
153== Links and Images ==
154
155
156=== Wiki Links ===
157
158You can create page links by putting the name in brackets.
159
160{{{
161[[Wiki/Page]]
162}}}
163
164[[Wiki/Page]]
165
166You can also use this format to create a "described" or "labeled" link or to
167add an anchor target.
168
169{{{
170[[Wiki/Page#anchor|Descriptive text for the link.]]
171}}}
172
173[[Wiki/Page#anchor|Descriptive text for the link.]]
174
175
176=== URLs ===
177
178Create a remote link simply by typing its URL: http://www.horde.org/.
179
180You can have a described-reference:
181{{{
182[[http://www.horde.org|Horde]]
183}}}
184[[http://www.horde.org|Horde]]
185
186//Rendering of described URLs is broken as of Text_Wiki 1.2.1.//
187
188
189=== Images ===
190
191You can put a picture in a page with {{{{{foo.jpg}}}}}. You can use any file
192type, but most browsers only support GIF, JPEG, and PNG formats. The filename
193can either be a relative reference (in which case the wiki looks for a file
194attached to the current page - or a different wiki page if the file name is
195prefixed with a page name, e.g. {{{{{SomePage:foo.jpg}}}}}), an absolute
196reference which begins with a slash (in which case the wiki uses it to retrieve
197a file relative to the web server's root), or a full, external URL.
198
199An "alt" attribute can follow the image filename or URL like so: {{{{{foo.jpg|A
200Foo JPEG"}}}}}.
201
202
203== Application Content ==
204
205=== Application Blocks ===
206
207Content from other Horde applications provided by portal blocks can be embedded
208into a page using {{{[[block]]}}} tags.
209
210To include Horde's moon phases block for example:
211
212{{{
213[[block horde/Moon phase=next hemisphere=northern]]
214}}}
215
216[[block horde/Moon phase=next hemisphere=northern]]
217
218=== Application Links ===
219
220Links to other Horde applications is supported if those applications support
221API links. The Wiki itself supports such an API to link to individual wiki
222pages:
223
224{{{
225[[link Link to some other wiki page|wiki/show page=Wiki/Page]]
226}}}
227
228[[link Link to some other wiki page|wiki/show page=Wiki/Page]]
229
230
231== Tables ==
232
233You can create tables using vertical bars:
234
235{{{
236|= Heading one |= Heading two |
237| cell one | cell two |
238| big ol' | line |
239| cell four | cell five |
240| cell six | here's a very long cell |
241}}}
242
243|= Heading one |= Heading two |
244| cell one | cell two |
245| big ol' | line |
246| cell four | cell five |
247| cell six | here's a very long cell |
248