]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - pgsrc/Help%2FWikicreole
No underscore for private function
[SourceForge/phpwiki.git] / pgsrc / Help%2FWikicreole
1 Date: Tue,  4 Jan 2011 12:37:33 +0000
2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0)
3 Content-Type: application/x-phpwiki;
4   pagename=Help%2FWikicreole;
5   flags=PAGE_LOCKED%2CEXTERNAL_PAGE;
6   markup=2;
7   charset=UTF-8
8 Content-Transfer-Encoding: binary
9
10 <<CreateToc jshide||=0 with_toclink||=1 position=right with_counter=1 >>
11
12 Phpwiki allows you to use the Wikicreole syntax to edit your wiki pages.
13
14 We have implemented most of Wikicreole 1.0 and Wikicreole 1.0 additions. What is implemented is described below.
15
16 Complete information about Wikicreole can be found at: http://www.wikicreole.org/
17
18 == Cheat Sheet from Wikicreole web site ==
19
20 [[http://www.wikicreole.org/attach/CheatSheet/creole_cheat_sheet.png]]
21
22 == Text formatting ==
23
24 === Bold ===
25
26 Bold text is made using two stars:
27
28 {{{
29 This sentence contains **words in bold**.
30 }}}
31
32 This sentence contains **words in bold**.
33
34 === Italics ===
35
36 Italics text is made using two slashes:
37
38 {{{
39 This sentence contains //words in italics//.
40 }}}
41
42 This sentence contains //words in italics//.
43
44 === Underline ===
45
46 Underline text is made using two underscores:
47
48 {{{
49 This sentence contains __underlined text__.
50 }}}
51
52 This sentence contains __underlined text__.
53
54 === Monospace ===
55
56 Monospace text is made using two hashes:
57
58 {{{
59 This sentence contains ##monospace text##.
60 }}}
61
62 This sentence contains ##monospace text##.
63
64 === Superscript ===
65
66 Superscript text is made using two carets:
67
68 {{{
69 The XX^^th^^ century.
70 }}}
71
72 The XX^^th^^ century.
73
74 === Subscript ===
75
76 Subscript text is made using two commas:
77
78 {{{
79 Water is H,,2,,O.
80 }}}
81
82 Water is H,,2,,O.
83
84 == Headers ==
85
86 Headers start on a new line with two or more equal signs (up to six) followed the header text.
87
88 Optional equal signs can be put at the end of the line (to be compatible with Mediawiki syntax). They are ignored.
89
90 The content of the headers is parsed, allowing for instance to use subscript and superscript text. (The header content parsing is optional in Wikicreole.)
91
92 <pre>
93 ~== First level of header (h2 in HTML) ==
94 ~=== Second level of header (h3 in HTML) ===
95 ~==== Third level of header (h4 in HTML)
96 </pre>
97
98 == Links ==
99
100 === Simple link ===
101
102 {{{
103 This is a [[link]].
104 }}}
105
106 This is a [[link]].
107
108 === Link with alternate text ===
109
110 {{{
111 This is a [[link|link with alternate text]].
112 }}}
113
114 This is a [[link|link with alternate text]].
115
116 === External link (URL) ===
117
118 {{{
119 [[http://www.wikicreole.org]]
120 }}}
121
122 [[http://www.wikicreole.org]]
123
124 === Raw external link (URL) ===
125
126 {{{
127 http://www.wikicreole.org
128 }}}
129
130 http://www.wikicreole.org
131
132 === External link with alternate text ===
133
134 {{{
135 [[http://www.wikicreole.org|Visit the Wikicreole website]]
136 }}}
137
138 [[http://www.wikicreole.org|Visit the Wikicreole website]]
139
140 == Paragraphs ==
141
142 Paragraphs are made of text separated by a blank line.
143
144 == Line breaks ==
145
146 A line break is made with two backslashes.
147
148 {{{
149 This is the first line,\\and this is the second.
150 }}}
151
152 This is the first line,\\and this is the second.
153
154 == Lists ==
155
156 === Unordered lists ===
157
158 {{{
159 * Item 1
160 * Item 2
161 ** Item 2.1
162 ** Item 2.2
163 * Item 3
164 }}}
165
166 * Item 1
167 * Item 2
168 ** Item 2.1
169 ** Item 2.2
170 * Item 3
171
172 === Ordered lists ===
173
174 {{{
175 # Item 1
176 # Item 2
177 ## Item 2.1
178 ## Item 2.2
179 # Item 3
180 }}}
181
182 # Item 1
183 # Item 2
184 ## Item 2.1
185 ## Item 2.2
186 # Item 3
187
188 == Horizontal rule ==
189
190 A horizontal rule is made with four hyphens (or more)
191
192 {{{
193 ----
194 }}}
195
196 ----
197
198 == Images ==
199
200 A inline image is created with curly brackets.
201 An alternate text can be put after a pipe. If there is none, an empty alternate text will be created.
202
203 {{{
204 {{myimage.png}}
205 }}}
206
207 {{{
208 {{myimage.png|this is my image}}
209 }}}
210
211 == Tables ==
212
213 All cells are separated by single pipes. Leading spaces are permitted before the first cell of a row and trailing spaces are permitted at the end of a line. The ending pipe is optional. You can embed links, bold, italics, line breaks, and nowiki in table cells. Equal sign directly following pipe defines a header. Headers can be arranged horizontally or vertically.
214
215 {{{
216 |=Heading Col 1 |=Heading Col 2         |
217 |Cell 1.1       |Two lines\\in Cell 1.2 |
218 |Cell 2.1       |Cell 2.2               |
219 }}}
220
221 |=Heading Col 1 |=Heading Col 2         |
222 |Cell 1.1       |Two lines\\in Cell 1.2 |
223 |Cell 2.1       |Cell 2.2               |
224
225 == Nowiki ==
226
227 Between three opening curly brackets and three closing curly brackets, no wiki markup is interpreted.
228
229 {{{
230 //This// does **not** get [[formatted]]
231 }}}
232
233 {{{
234 Some examples of markup are: {{{** <i>this</i> ** }}}
235 }}}
236
237 Some examples of markup are: {{{** <i>this</i> ** }}}
238
239 == Escape character ==
240
241 The escape character is the tilde.
242
243 It escapes the character immediately following it.
244
245 It disables the automatic conversion of the URL immediately following it.
246
247 It disables camel case in the word following it.
248
249 {{{
250 ~http://www.foo.com/
251 }}}
252
253 ~http://www.foo.com/
254
255 {{{
256 ~CamelCaseLink
257 }}}
258
259 ~CamelCaseLink
260
261 == Plugins ==
262
263 Plugins use double angle brackets.
264
265 {{{
266 <<CurrentTime format="date">>
267 }}}
268
269 <<CurrentTime format="date">>
270
271 <noinclude>
272 ----
273 [[PhpWikiDocumentation]]
274 </noinclude>