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