Penguin
Recent Changes
Blame: TextFormattingRules
EditPageHistoryDiffInfoLikePages
Annotated edit history of TextFormattingRules version 9, including all changes. View license author blame.
Rev Author # Line
2 PerryLorier 1 ! Synopsis
9 WikiAdmin 2 TextFormattingRules
3 <br> __Emphasis:__ ~'' for ''italics'', ~__ for __bold__, ~''~__ for ''__both__'', ~<tt> for <tt>fixed width</tt>.
4 <br> __Lists:__ * for bullet lists, # for numbered lists, ''Term<b>:</b>~<newline> definition'' for definition lists.
5 <br> __Preformatted text:__ Enclose text in <tt>~<pre>~</pre></tt> or <tt>~<verbatim>~</verbatim></tt>.
6 <br> __Indented text:__ Indent the paragraph with whitespaces.
7 <br> __References:__ ~JoinCapitalizedWords or use square brackets for a <tt>~[page link]</tt> or URL <tt>~[~http://cool.wiki.int/]</tt>.
8 <br> __Preventing linking:__ Prefix with "<tt>~~</tt>": <tt>~~~DoNotHyperlink</tt>, name links like <tt>~[text | URL]</tt>.
9 <br> __Footnotes:__ You can't do in the new markup language.
10 <br> __Misc:__ "<tt>!</tt>", "<tt>!!</tt>", "<tt>!!!</tt>" make headings, "<tt>~%%%</tt>" or "<tt>~<br></tt>" makes a linebreak, "<tt>~----</tt>" makes a horizontal rule.
11 <br> __Allowed HTML tags:__ <b>b</b> <big>big</big> <i>i</i> <small>small</small> <tt>tt</tt> <em>em</em> <strong>strong</strong> <abbr>abbr</abbr> <acronym>acronym</acronym> <cite>cite</cite> <code>code</code> <dfn>dfn</dfn> <kbd>kbd</kbd> <samp>samp</samp> <var>var</var> <sup>sup</sup> <sub>sub</sub>
1 The PhpWiki programming team 12
2 PerryLorier 13 ----
9 WikiAdmin 14
15 !!! Character formatting
16
17 * All special non-whitespace HTML characters are displayed as-is.
18 * The tilde <tt>~~</tt> is the ''Escape Character''
19 * A single tilde before a link ('~~~http://foo.bar', '~~~WikiWord') prevents linking. => ~http://foo.bar, ~WikiWord
20 * You can use tildes in the middle of ~WikiWord~~s to prevent them from being linked as a whole. => WikiWord~s
21 * Similarly, a tilde can be used to cancel the effect of markup ('~~~__', '~~~<tt>'). => ~__, ~<tt>
22 * A tilde also cancels a following tilde, so any two tildes in a row ('~~~~') get rendered as a single tilde. => ~~
23 * The exception is within [URL]s ('~http://foo.bar/~~baz'), where a single tilde renders as itself. => http://foo.bar/~baz
24 * A single tilde '~~' followed by nothing gets rendered as a single tilde. => ~
25
26 !!! Paragraphs
1 The PhpWiki programming team 27
2 PerryLorier 28 * Don't indent paragraphs
29 * Words wrap and fill as needed
30 * Use blank lines as separators
31 * Four or more minus signs make a horizontal rule
9 WikiAdmin 32 * <tt>~%%%</tt> or <tt>~<br></tt> makes a linebreak (in headings and lists too)
1 The PhpWiki programming team 33
9 WikiAdmin 34 !!! Lists
1 The PhpWiki programming team 35
2 PerryLorier 36 * asterisk for first level
9 WikiAdmin 37 * indented asterisk (indent at least two spaces) for second level, etc.
38 * Use <tt>~*</tt>, <tt>-</tt>, <tt>+</tt> or <tt>o</tt> for bullet lists, <tt>#</tt> for numbered lists (mix at will)
39 * Definition lists:
40 <pre>
41 Term:
42 definition
43 </pre>
44 gives
2 PerryLorier 45
9 WikiAdmin 46 Term:
47 definition
2 PerryLorier 48
9 WikiAdmin 49 as in the <tt><DL><DT><DD></tt> list
2 PerryLorier 50
9 WikiAdmin 51 * Items may contain multiple paragraphs and other multi-lined content,
52 just indent the items. This includes <tt>~<pre></tt> and <tt>~<verbatim></tt> text!
2 PerryLorier 53
9 WikiAdmin 54 !!! Headings
2 PerryLorier 55
9 WikiAdmin 56 * '<tt>!</tt>' at the start of a line makes a small heading
57 * '<tt>!!</tt>' at the start of a line makes a medium heading
58 * '<tt>!!!</tt>' at the start of a line makes a large heading
2 PerryLorier 59
8 The PhpWiki programming team 60
9 WikiAdmin 61 !!! Preformatted text
2 PerryLorier 62
9 WikiAdmin 63 * Place preformatted lines inside <tt>~<pre></tt>:
64 <verbatim>
65 <pre>
66 Preformatted text. WikiLinks still work.
67 </pre>
68 </verbatim>
69 gives
70 <pre>
71 Preformatted text. WikiLinks still work.
72 </pre>
73 * If you want text with no Wiki interaction, use the <tt>~<verbatim></tt> tag:
74 <pre>
75 <verbatim>
76 Preformatted text. ~WikiLinks do not work.
77 </verbatim>
78 </pre>
79 gives
80 <verbatim>
81 Preformatted text. WikiLinks do not work.
82 </verbatim>
2 PerryLorier 83
9 WikiAdmin 84 !!! Indented Paragraphs
2 PerryLorier 85
9 WikiAdmin 86 * Two or more whitespaces signal indented text. Indents may be nested.
87
88 This is an indented block of text.
89
90 This block is even more indented.
91
92 * E-mail style block-quoting is supported as well:
93 <pre>
94 > This is block-quoted text.
95 </pre>
96 renders as
97
98 > This is block-quoted text.
99
100 !!! Emphasis
101
102 * Use doubled single-quotes (<tt>~''</tt>) for emphasis (usually ''italics'')
103 * Use doubled underscores (<tt>~__</tt>) for strong emphasis (usually __bold__)
2 PerryLorier 104 * Mix them at will: __''bold italics''__
105 * ''Emphasis'' can be used ''multiple'' times within a line, but ''cannot'' cross line boundaries:
106
9 WikiAdmin 107 ''this
3 AristotlePagaltzis 108
9 WikiAdmin 109 will not work''
110
111 !!! References
112
113 * Hyperlinks to other pages within the Wiki are made using WikiWord~s (preferred) or by placing the page name in square brackets: [this is a page link] (discouraged)
2 PerryLorier 114 * Hyperlinks to external pages are done like this: [http://www.wcsb.org/]
9 WikiAdmin 115 * You can name the links by providing a name, a vertical bar "<tt>|</tt>" and then the [URL] or pagename: [PhpWiki home page | http://phpwiki.sourceforge.net/] — [the front page | HomePage]
116 * You can suppress linking to WikiWord~s and plain [URL]s by preceding the word with a '<tt>~~</tt>', e.g. ~NotLinkedAsWikiName, ~http://not.linked.to/
117 * Also, the old way of linking [URL]s is still supported: any text starting with "<tt>http:</tt>", "<tt>ftp:</tt>" or "<tt>mailto:</tt>" will be linked to automatically, as in: http://c2.com/
118 * [URL]s ending with <tt>.png</tt>, <tt>.gif</tt>, or <tt>.jpg</tt> are inlined if in square brackets, by themselves:
119 <br> [http://phpwiki.sourceforge.net/demo/themes/default/images/png.png]
2 PerryLorier 120
9 WikiAdmin 121 !!! Tables
2 PerryLorier 122
9 WikiAdmin 123 Old-style tables are supported through the OldStyleTablePlugin — at the WlugWiki we prefer you use that.
2 PerryLorier 124
9 WikiAdmin 125 Definition list style tables are written just like definition lists, except that you replace the trailing colon on the term with a vertical bar "<tt>|</tt>".
2 PerryLorier 126
9 WikiAdmin 127 <pre>
128 Term 1 |
129 Definition 1 begins here.
130 Term 1.1 |
131 Definition 1.1
132 Term 1.2 |
133 Definition 1.2
134 This is part of definition 1.
135 Term 2 |
136 Here's definition 2.
137 </pre>
4 AristotlePagaltzis 138
9 WikiAdmin 139 results in:''''
2 PerryLorier 140
9 WikiAdmin 141 Term 1 |
142 Definition 1 begins here.
143 Term 1.1 |
144 Definition 1.1
145 Term 1.2 |
146 Definition 1.2
147 This is part of definition 1.
148 Term 2 |
149 Here's definition 2.
150
151 !!! [HTML] MarkupLanguage
152
153 * Some in-line markup is allowed through the use of [HTML] tags: <b>b</b>, <big>big</big>, <i>i</i>, <small>small</small>, <tt>tt</tt>, <em>em</em>, <strong>strong</strong>, <abbr>abbr</abbr>, <acronym>acronym</acronym>, <cite>cite</cite>, <code>code</code>, <dfn>dfn</dfn>, <kbd>kbd</kbd>, <samp>samp</samp>, <var>var</var>, <sup>sup</sup> and <sub>sub</sub>
2 PerryLorier 154 * < and > are themselves
155 * The & characters will not work
8 The PhpWiki programming team 156
9 WikiAdmin 157 !!! Creating various kinds of special links
158
159 See [MagicPhpWikiURLs] for gory details on how to write various kind of wiki maintenance and other special links.
160
161 !!! Inserting plugins
162
163 Several plugins permit embedding additional functionality to Wiki pages. For example,
164
165 <verbatim>
166 <?plugin BackLinks page=HomePage info=hits ?>
167 </verbatim>
2 PerryLorier 168
9 WikiAdmin 169 gives
3 AristotlePagaltzis 170
9 WikiAdmin 171 <?plugin BackLinks page=HomePage info=hits ?>
4 AristotlePagaltzis 172
9 WikiAdmin 173 For more information on plugins, see WikiPlugin.
4 AristotlePagaltzis 174
8 The PhpWiki programming team 175 ----
1 The PhpWiki programming team 176 PhpWikiDocumentation

PHP Warning

lib/blame.php:177: Warning: Invalid argument supplied for foreach() (...repeated 9 times)