pgsrc/Help%2FTextFormattingRules

   1 Date: Tue,  2 Apr 2013 15:43:51 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0)
   3 Content-Type: application/x-phpwiki;
   4   pagename=Help%2FTextFormattingRules;
   5   flags=PAGE_LOCKED;
   6   markup=2;
   7   charset=UTF-8
   8 Content-Transfer-Encoding: binary
   9
  10 <<CreateToc with_toclink||=1 position=right >>
  11
  12 == Synopsis ==
  13
  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]]
  31
  32 More explanations: [[Help:TextFormattingRules]]
  33
  34 == Character Formatting ==
  35
  36 === Emphasis ===
  37
  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:
  42
  43 // this
  44
  45 will not work//
  46
  47 === Monospace ===
  48
  49 Monospace text is made using two hashes:
  50
  51 {{{
  52 This sentence contains ##monospace text##.
  53 }}}
  54
  55 This sentence contains ##monospace text##.
  56
  57 === Superscript ===
  58
  59 Superscript text is made using two carets:
  60
  61 {{{
  62 The XX^^th^^ century.
  63 }}}
  64
  65 The XX^^th^^ century.
  66
  67 === Subscript ===
  68
  69 Subscript text is made using two commas:
  70
  71 {{{
  72 Water is H,,2,,O.
  73 }}}
  74
  75 Water is H,,2,,O.
  76
  77 === Fonts ===
  78
  79 There's no syntax for font tags.
  80
  81 === Color Text ===
  82
  83 Is it possible to write text in color.
  84
  85 {{{
  86 %color=green% green text %% and back to normal
  87 }}}
  88 will give:
  89 %%%
  90 %color=green% green text %% and back to normal
  91
  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.
  94
  95 Allowed colors are:
  96 * an HTML color number (# followed by 3 or 6 digits),
  97 * the following predefined color names:
  98 {| class="bordered"
  99 |-
 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 %%
 110 |-
 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 %%
 121 |-
 122 | %color=purple% purple %%
 123 | %color=red% red %%
 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 %%
 132 |}
 133
 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.
 135
 136 === Escape Character ===
 137
 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
 145
 146 === Special Characters ===
 147
 148 All special non-whitespace HTML characters are displayed as-is. Exceptions below.
 149
 150 == Paragraphs ==
 151
 152 * Don't indent paragraphs
 153 * Words wrap and fill as needed
 154 * Use blank lines as separators
 155 * Four or more minus signs make a horizontal rule
 156 * "##~\~\##", "##~%%%##" or "##~<br>##" makes a linebreak (in headings and lists too)
 157
 158 == Lists ==
 159
 160 === Unordered lists ===
 161
 162 Recommended syntax (Wikicreole):
 163 * asterisk for first level
 164 * double asterisk for second level, etc.
 165
 166 Be sure to **put a space after the asterisk**.
 167
 168 You can also use indented asterisk for second level (indent at least two spaces).
 169
 170 === Ordered lists ===
 171
 172 Recommended syntax (Wikicreole):
 173 * ##~### for first level
 174 * double ##~### for second level, etc.
 175
 176 Be sure to **put a space after the hash sign**.
 177
 178 You can also use indented ##~### for second level (indent at least two spaces).
 179
 180 === Definition lists ===
 181
 182 {{{
 183 Term:
 184   definition
 185 }}}
 186
 187 gives
 188
 189 Term:
 190   definition
 191
 192 === Remark ===
 193
 194 Items may contain multiple paragraphs and other multi-lined content, just indent the items
 195
 196 == Headings ==
 197
 198 === Wikicreole syntax (recommended) ===
 199
 200 * '~=~=' at the start of a line makes a large heading (h2)
 201 * '~=~=~=' at the start of a line makes a medium heading (h3)
 202 * '~=~=~=~=' at the start of a line makes a small heading (h4)
 203 * '~=~=~=~=~=' at the start of a line makes a smaller heading (h5)
 204 * '~=~=~=~=~=~=' at the start of a line makes a tiny heading (h6)
 205
 206 === Classic Phpwiki syntax ===
 207
 208 * '##!!!##' at the start of a line makes a large heading (h2)
 209 * '##!!##' at the start of a line makes a medium heading (h3)
 210 * '##!##' at the start of a line makes a small heading (h4)
 211
 212 == Preformatted text ==
 213
 214 Place the preformatted text between three opening curly brackets and three closing curly brackets:
 215
 216 <verbatim>
 217 {{{
 218 Preformatted text. ~WikiLinks do not work.
 219 }}}
 220 </verbatim>
 221
 222 gives
 223
 224 {{{
 225 Preformatted text. WikiLinks do not work.
 226 }}}
 227
 228 If you want Wiki interaction, place preformatted lines inside ##~<pre>##:
 229
 230 {{{
 231 <pre>
 232 Preformatted text. WikiLinks still work.
 233 </pre>
 234 }}}
 235
 236 gives
 237
 238 <pre>
 239 Preformatted text. WikiLinks still work.
 240 </pre>
 241
 242 == Indented Paragraphs ==
 243
 244 Two or more whitespaces signal indented text. Indents may be nested.
 245
 246     This is an indented block of text.
 247
 248       This block is even more indented.
 249
 250 E-mail style block-quoting is supported as well:
 251 {{{
 252 > This is block-quoted text.
 253 }}}
 254 renders as
 255
 256 > This is block-quoted text.
 257
 258 == References ==
 259
 260 * Hyperlinks to other pages within the Wiki are made by placing the
 261   page name in double square brackets: [[this is a page link]].
 262   Single brackets or WikiWords will also work.
 263 * Hyperlinks to external pages are done like this: [[http://www.wcsb.org/]]
 264 * You can name the links by providing a name, a pipe (##|##) and then the hyperlink or pagename:
 265   [[http://phpwiki.sourceforge.net/|PhpWiki home page]], [[HomePage|the front page]]
 266 * You can suppress linking to URIs by preceding the word with a '##~~##', e.g. ~NotLinkedAsWikiName, ~http~://not.linked.to/
 267 * Also, the old way of linking URL's is still supported: precede URLs
 268   with "##~http:##", "##~ftp:##" or "##~mailto:##" to
 269   create links automatically as in: http://c2.com/
 270 * URLs ending with ##.png##, ##.gif##, or ##.jpg## are inlined if in square brackets, by themselves:
 271   [[http://phpwiki.svn.sourceforge.net/viewvc/phpwiki/trunk/themes/default/images/png.png]]
 272 * In-page #[[hyperlinks]] are made by placing a named anchor and referring to the anchor in a hyperlink:
 273 ** Named anchors:
 274 *** ##~#~[~[foo]]##: An anchor around the text "foo" with id "foo".
 275 *** ##~#~[~[|foo]]##: An empty anchor with id "foo".
 276 *** ##~#~[~[howdy|foo]]##: An anchor around the text "howdy" with id "foo".
 277 ** References to name anchors are made thusly:\\##~[~[~#hyperlinks]]##, ##~[~[~OtherPage#foo]]##, ##~[~[~OtherPage#foo|named]]##.
 278 * Semantic links are named links like: is_a::WikiPage and attributes like size:-4000.
 279 * A pagelink within square brackets starting with ":" is not backlinked.
 280
 281 == Images ==
 282
 283 An inline image is created with curly brackets.
 284 An alternate text can be put after a pipe. If there is none, an empty alternate text will be created.
 285
 286 {{{
 287 {{myimage.png}}
 288 {{myimage.png|this is the alt text for my image}}
 289 [[some link|{{myimage.png}}]] - if you click on the image, will goto "some link"
 290 [[some link|{{myimage.png|alt text}}]] - same with alternative
 291 [[http://example.com/|{{myimage.png}}]] - same as above: picture links to url
 292 [[http://example.com/|{{myimage.png|alt text}}]] - same with alternative
 293 }}}
 294
 295 == Tables ==
 296
 297 === Wikicreole tables ===
 298
 299 All cells are separated by single pipes.
 300 Leading spaces are permitted before the first cell of a row and trailing spaces are permitted at the end of a line.
 301 The ending pipe is optional.
 302
 303 You can embed links, bold, italics, line breaks, and nowiki in table cells.
 304
 305 Equal sign directly following pipe defines a header.
 306 Headers can be arranged horizontally or vertically.
 307
 308 {{{
 309 |=Heading Col 1 |=Heading Col 2         |
 310 |Cell 1.1       |Two lines\\in Cell 1.2 |
 311 |Cell 2.1       |Cell 2.2               |
 312 }}}
 313
 314 will give:
 315
 316 |=Heading Col 1 |=Heading Col 2         |
 317 |Cell 1.1       |Two lines\\in Cell 1.2 |
 318 |Cell 2.1       |Cell 2.2               |
 319
 320 === Mediawiki tables ===
 321
 322 See [[Help:MediawikiTablePlugin]].
 323
 324 === Definition list style tables ===
 325
 326 Definition list style tables are written just like definition lists,
 327 except that you replace the trailing colon on the term with a "pipe" (##|##).
 328
 329 {{{
 330 Term 1 |
 331    Definition 1 begins here.
 332    Term 1.1 |
 333       Definition 1.1
 334    Term 1.2 |
 335       Definition 1.2
 336    This is part of definition 1.
 337 Term 2 |
 338    Here's definition 2.
 339 }}}
 340
 341 will give:
 342
 343 Term 1 |
 344    Definition 1 begins here.
 345    Term 1.1 |
 346       Definition 1.1
 347    Term 1.2 |
 348       Definition 1.2
 349    This is part of definition 1.
 350 Term 2 |
 351    Here's definition 2.
 352
 353 == HTML Mark-Up Language ==
 354
 355 * Some in-line markup is allowed through the use of HTML tags:
 356   <b>b</b>, <big>big</big>, <i>i</i>, <small>small</small>,
 357   <tt>tt</tt>, <em>em</em>, <strong>strong</strong>,
 358   <abbr>abbr</abbr>, <acronym>acronym</acronym>, <cite>cite</cite>,
 359   <code>code</code>, <dfn>dfn</dfn>, <kbd>kbd</kbd>,
 360   <samp>samp</samp>, <var>var</var>, <sup>sup</sup> and <sub>sub</sub>
 361 * < and > are themselves
 362 * The & characters will not work
 363
 364 == Creating various kinds of special links ==
 365
 366 See [[Help:MagicPhpWikiURLs]] for gory details on how to write various kind
 367 of wiki maintenance and other special links.
 368
 369 == Inserting plugins ==
 370
 371 Several plugins permit embedding additional functionality to Wiki pages. For example,
 372 {{{
 373 <<BackLinks page=HomePage info=hits>>
 374 }}}
 375 gives
 376 <<BackLinks page=HomePage info=hits>>
 377
 378 For more information on plugins see [[Help:WikiPlugin]], and [[PluginManager]] for a list of all plugins.
 379
 380 <noinclude>
 381 ----
 382 [[PhpWikiDocumentation]]
 383 </noinclude>