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