1 Date: Thu, 9 Dec 2010 14:51:45 +0000
2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0)
3 Content-Type: application/x-phpwiki;
4 pagename=Help%2FTextFormattingRules;
8 Content-Transfer-Encoding: binary
10 <<CreateToc with_toclink||=1 position=right >>
14 **Emphasis:** ##~/~/## for //italics//, ##~*~*## for **bold**, ##~*~*~/~/...~/~/~*~*## for **//both//**, ##~#~### for ##fixed width##. \\
15 **Lists:** ##~*## for bullet lists, ##~### for numbered lists; use multiple ##~*## or ##~### for nested lists. \\
16 **Headings:** "##~=~=##", "##~=~=~=##", "##~=~=~=~=##", etc. make headings. \\
17 **Preformatted text:** Enclose text in ##~{~{~{...~}~}~}## or ##~<pre>~</pre>##. \\
18 **Indented text:** Indent the paragraph with whitespaces. \\
19 **References:** use double square brackets for a ##~[~[page link~]~]## or URL ##~[~[~http:~//cool.wiki.int/~]~]##. \\
20 **References:** use pipe ##~|## to name the links: ##~[~[page link~|some text~]~]## or ##~[~[~http:~//cool.wiki.int/~|some text~]~]##. \\
21 **Preventing linking:** Prefix with "##~~##": ##~~~DoNotHyperlink##. \\
22 **Misc:** "##~\~\##" makes a linebreak, "##~----##" makes a horizontal rule. \\
23 **Allowed HTML tags:** <b>b</b> <big>big</big> <i>i</i>
24 <small>small</small> ##tt## <em>em</em> <strong>strong</strong>
25 <s>s</s> <strike>strike</strike>
26 <abbr>abbr</abbr> <acronym>acronym</acronym> <cite>cite</cite>
27 <code>code</code> <dfn>dfn</dfn> <kbd>kbd</kbd> <samp>samp</samp>
28 <var>var</var> <sup>sup</sup> <sub>sub</sub> \\
29 **More:** [[Help:TextFormattingRules#Tables|tables]], [[Help:TextFormattingRules#Images|images]],
30 [[Help:CreateTocPlugin|table of contents]], [[Help:TextFormattingRules#Inserting_plugins|plugins]]
32 More explanations: [[Help:TextFormattingRules]]
34 == Character Formatting ==
38 * Use a double slash (##~/~/##) for emphasis (usually //italics//)
39 * Use a double asterisk (##~*~*##) for strong emphasis (usually **bold**)
40 * Mix them at will: **//bold italics//**
41 * //Emphasis// can be used //multiple// times within a paragraph, but **cannot** cross paragraph boundaries:
49 Monospace text is made using two hashes:
52 This sentence contains ##monospace text##.
55 This sentence contains ##monospace text##.
59 Superscript text is made using two carets:
69 Subscript text is made using two commas:
79 There's no syntax for font tags.
83 Is it possible to write text in color.
86 %color=green% green text %% and back to normal
90 %color=green% green text %% and back to normal
92 The easiest way to do it is to use the COLOR button in the Edit Toolbar.
93 The text will be in green by default. You can then change the color.
96 * an HTML color number (# followed by 3 or 6 digits),
97 * the following predefined color names:
100 | %color=aqua% aqua %%
101 | bgcolor="#565c5e" | %color=beige% beige %%
102 | %color=black% black %%
103 | %color=blue% blue %%
104 | %color=brown% brown %%
105 | %color=chocolate% chocolate %%
106 | %color=cyan% cyan %%
107 | %color=fuchsia% fuchsia %%
108 | %color=gold% gold %%
109 | %color=gray% gray %%
111 | %color=green% green %%
112 | bgcolor="#565c5e" | %color=ivory% ivory %%
113 | %color=indigo% indigo %%
114 | %color=lime% lime %%
115 | %color=magenta% magenta %%
116 | %color=maroon% maroon %%
117 | %color=navy% navy %%
118 | %color=olive% olive %%
119 | %color=orange% orange %%
120 | %color=pink% pink %%
122 | %color=purple% purple %%
124 | %color=salmon% salmon %%
125 | %color=silver% silver %%
126 | bgcolor="#565c5e" | %color=snow% snow %%
127 | %color=teal% teal %%
128 | %color=turquoise% turquoise %%
129 | %color=violet% violet %%
130 | bgcolor="#565c5e" | %color=white% white %%
131 | %color=yellow% yellow %%
134 Note: you can put the headers in color, but only if you do not have a table of content. For now, the table of content is incompatible with color headers.
136 === Escape Character ===
138 The tilde '~~' is the //Escape Character//:
139 * A single tilde '~~' followed by nothing gets rendered as a single tilde. => ~
140 * Two tilde '~~~~' get rendered as a single tilde. => ~~
141 * A single tilde before a link ('~~http~:~/~/foo.bar') prevents linking. => ~http://foo.bar
142 * Two tildes before a link ('~~~~http~:~/~/foo.bar') produce a tilde followed by the hyperlinked URL. => ~~http://foo.bar
143 * A tilde inside an URL gets removed, unless it's formatted inside square brackets.
144 * Two tildes inside an URL (without brackets) become a single tilde. => [[http://foo.bar/~user]] or http://foo.bar/~~user
146 === Special Characters ===
148 All special non-whitespace HTML characters are displayed as-is. Exceptions below.
150 Special non-ASCII or non-latin characters are printed as-is only if supported
151 by the native wiki CHARSET. Add such characters on a non-supported CHARSET with the [[Help:RawHtmlPlugin]] if it is enabled by the Admin and e.g. the ##&#num;## syntax.
153 E.g. These Japanese chars 'から 新規ページ'
154 on this <<SystemInfo CHARSET>> wiki.
156 And with the plugin: <<RawHtml から 新規ページ>>
158 And this is how it should look: [[http://phpwiki.sourceforge.net/demo/images/chars-releasenotes-japanese.png]]
162 * Don't indent paragraphs
163 * Words wrap and fill as needed
164 * Use blank lines as separators
165 * Four or more minus signs make a horizontal rule
166 * "##~\~\##", "##~%%%##" or "##~<br>##" makes a linebreak (in headings and lists too)
170 === Unordered lists ===
172 Recommended syntax (Wikicreole):
173 * asterisk for first level
174 * double asterisk for second level, etc.
176 Be sure to **put a space after the asterisk**.
178 You can also use indented asterisk for second level (indent at least two spaces).
180 === Ordered lists ===
182 Recommended syntax (Wikicreole):
183 * ##~### for first level
184 * double ##~### for second level, etc.
186 Be sure to **put a space after the hash sign**.
188 You can also use indented ##~### for second level (indent at least two spaces).
190 === Definition lists ===
204 Items may contain multiple paragraphs and other multi-lined content, just indent the items
208 === Wikicreole syntax (recommended) ===
210 * '~=~=' at the start of a line makes a large heading (h2)
211 * '~=~=~=' at the start of a line makes a medium heading (h3)
212 * '~=~=~=~=' at the start of a line makes a small heading (h4)
213 * '~=~=~=~=~=' at the start of a line makes a smaller heading (h5)
214 * '~=~=~=~=~=~=' at the start of a line makes a tiny heading (h6)
216 === Classic Phpwiki syntax ===
218 * '##!!!##' at the start of a line makes a large heading (h2)
219 * '##!!##' at the start of a line makes a medium heading (h3)
220 * '##!##' at the start of a line makes a small heading (h4)
222 == Preformatted text ==
224 Place the preformatted text between three opening curly brackets and three closing curly brackets:
228 Preformatted text. ~WikiLinks do not work.
235 Preformatted text. WikiLinks do not work.
238 If you want Wiki interaction, place preformatted lines inside ##~<pre>##:
242 Preformatted text. WikiLinks still work.
249 Preformatted text. WikiLinks still work.
252 == Indented Paragraphs ==
254 Two or more whitespaces signal indented text. Indents may be nested.
256 This is an indented block of text.
258 This block is even more indented.
260 E-mail style block-quoting is supported as well:
262 > This is block-quoted text.
266 > This is block-quoted text.
270 * Hyperlinks to other pages within the Wiki are made by placing the
271 page name in double square brackets: [[this is a page link]].
272 Single brackets or WikiWords will also work.
273 * Hyperlinks to external pages are done like this: [[http://www.wcsb.org/]]
274 * You can name the links by providing a name, a pipe (##|##) and then the hyperlink or pagename:
275 [[http://phpwiki.sourceforge.net/|PhpWiki home page]], [[HomePage|the front page]]
276 * You can suppress linking to URIs by preceding the word with a '##~~##', e.g. ~NotLinkedAsWikiName, ~http~://not.linked.to/
277 * Also, the old way of linking URL's is still supported: precede URLs
278 with "##~http:##", "##~ftp:##" or "##~mailto:##" to
279 create links automatically as in: http://c2.com/
280 * URLs ending with ##.png##, ##.gif##, or ##.jpg## are inlined if in square brackets, by themselves:
281 [[http://phpwiki.sourceforge.net/demo/themes/default/images/png.png]]
282 * In-page #[[hyperlinks]] are made by placing a named anchor and referring to the anchor in a hyperlink:
284 *** ##~#~[~[foo]]##: An anchor around the text "foo" with id "foo".
285 *** ##~#~[~[|foo]]##: An empty anchor with id "foo".
286 *** ##~#~[~[howdy|foo]]##: An anchor around the text "howdy" with id "foo".
287 ** References to name anchors are made thusly:\\##~[~[~#hyperlinks]]##, ##~[~[~OtherPage#foo]]##, ##~[~[~OtherPage#foo|named]]##.
288 * Semantic links are named links like: is_a::WikiPage and attributes like size:-4000.
289 * A pagelink within square brackets starting with ":" is not backlinked.
293 An inline image is created with curly brackets.
294 An alternate text can be put after a pipe. If there is none, an empty alternate text will be created.
298 {{myimage.png|this is the alt text for my image}}
299 [[some link|{{myimage.png}}]] - if you click on the image, will goto "some link"
300 [[some link|{{myimage.png|alt text}}]] - same with alternative
301 [[http://example.com/|{{myimage.png}}]] - same as above: picture links to url
302 [[http://example.com/|{{myimage.png|alt text}}]] - same with alternative
307 === Wikicreole tables ===
309 All cells are separated by single pipes.
310 Leading spaces are permitted before the first cell of a row and trailing spaces are permitted at the end of a line.
311 The ending pipe is optional.
313 You can embed links, bold, italics, line breaks, and nowiki in table cells.
315 Equal sign directly following pipe defines a header.
316 Headers can be arranged horizontally or vertically.
319 |=Heading Col 1 |=Heading Col 2 |
320 |Cell 1.1 |Two lines\\in Cell 1.2 |
321 |Cell 2.1 |Cell 2.2 |
326 |=Heading Col 1 |=Heading Col 2 |
327 |Cell 1.1 |Two lines\\in Cell 1.2 |
328 |Cell 2.1 |Cell 2.2 |
330 === Mediawiki tables ===
332 See [[Help:MediawikiTablePlugin]].
334 === Definition list style tables ===
336 Definition list style tables are written just like definition lists,
337 except that you replace the trailing colon on the term with a "pipe" (##|##).
341 Definition 1 begins here.
346 This is part of definition 1.
354 Definition 1 begins here.
359 This is part of definition 1.
363 == HTML Mark-Up Language ==
365 * Some in-line markup is allowed through the use of HTML tags:
366 <b>b</b>, <big>big</big>, <i>i</i>, <small>small</small>,
367 <tt>tt</tt>, <em>em</em>, <strong>strong</strong>,
368 <abbr>abbr</abbr>, <acronym>acronym</acronym>, <cite>cite</cite>,
369 <code>code</code>, <dfn>dfn</dfn>, <kbd>kbd</kbd>,
370 <samp>samp</samp>, <var>var</var>, <sup>sup</sup> and <sub>sub</sub>
371 * < and > are themselves
372 * The & characters will not work
374 == Creating various kinds of special links ==
376 See [[Help:MagicPhpWikiURLs]] for gory details on how to write various kind
377 of wiki maintenance and other special links.
379 == Inserting plugins ==
381 Several plugins permit embedding additional functionality to Wiki pages. For example,
383 <<BackLinks page=HomePage info=hits>>
386 <<BackLinks page=HomePage info=hits>>
388 For more information on plugins see [[Help:WikiPlugin]], and [[PluginManager]] for a list of all plugins.
392 [[PhpWikiDocumentation]]