pgsrc/Help%2FTextFormattingRules

   1 Date: Wed, 28 May 2008 19:07:35 +0200
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
   3 Content-Type: application/x-phpwiki;
   4   pagename=Help%2FTextFormattingRules;
   5   flags=PAGE_LOCKED;
   6   markup=2;
   7   charset=iso-8859-1
   8 Content-Transfer-Encoding: binary
   9
  10 <?plugin CreateToc jshide||=1 with_toclink||=1 ?>
  11 ----
  12 ! Synopsis
  13 Help:TextFormattingRules <br>
  14 *Emphasis:* <tt>~_</tt> for _italics_, <tt>~*</tt> for *bold*,
  15 <tt>~_~*</tt> for _*both*_, <tt>~=</tt> for =fixed width=.%%%
  16 *Lists:* <tt>~*</tt> for bullet lists, <tt>#</tt> for numbered lists,
  17 _Term~:~<new-line> definition_ for definition lists.<br>
  18 *Preformatted text:* Enclose text in <tt>~<pre>~</pre></tt> or
  19 <tt>~<verbatim>~</verbatim></tt>.%%%
  20 *Indented text:* Indent the paragraph with whitespaces.%%%
  21 *References:* ~JoinCapitalizedWords or use square brackets for a
  22 <tt>~[page link]</tt> or URL <tt>~[~http~://cool.wiki.int/~]</tt>.<br>
  23 *Preventing linking:* Prefix with "<tt>~~</tt>":
  24 <tt>~~~DoNotHyperlink</tt>, name links like <tt>~[text | URL or pagename~]</tt>.%%%
  25 *Misc:* "<tt>!</tt>", "<tt>!!</tt>", "<tt>!!!</tt>" make headings,
  26 "<tt>~%%%</tt>" or "<tt>~<br></tt>" makes a linebreak,
  27 "<tt>~----</tt>" makes a horizontal rule.%%%
  28 *Allowed HTML tags:* <b>b</b> <big>big</big> <i>i</i>
  29 <small>small</small> <tt>tt</tt> <em>em</em> <strong>strong</strong>
  30 <s>s</s> <strike>strike</strike>
  31 <abbr>abbr</abbr> <acronym>acronym</acronym> <cite>cite</cite>
  32 <code>code</code> <dfn>dfn</dfn> <kbd>kbd</kbd> <samp>samp</samp>
  33 <var>var</var> <sup>sup</sup> <sub>sub</sub>
  34
  35 ----
  36
  37 !!! Character Formatting
  38
  39 * All special non-whitespace HTML characters are displayed as-is. Exceptions below.
  40 * See [Emphasis|Help:TextFormattingRules#Emphasis].
  41 * There's no syntax for font tags or color attributes.
  42 * The tilde '~~' is the _Escape Character_:
  43 ** A single tilde '~~' followed by nothing gets rendered as a single tilde. => ~
  44 ** Two tilde '~~~~' get rendered as a single tilde. => ~~
  45 ** A single tilde before a link ('~~http~:~/~/foo.bar') prevents linking.
  46    => ~http://foo.bar
  47 ** Two tildes before a link ('~~~~http~:~/~/foo.bar') produce a tilde
  48    followed by the hyperlinked URL.
  49    => ~~http://foo.bar
  50 ** A tilde inside an URL gets removed, unless it's formatted inside
  51    ~[ ~] brackets.
  52    Two tildes inside an URL (without brackets) become a single tilde.
  53    => [http://foo.bar/~user] or http://foo.bar/~~user
  54 * Special non-ascii or non-latin characters are printed as-is only if supported
  55   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. %%%
  56   E.g. These japanese euc-jp chars '&#12363;&#12425; &#26032;&#35215;&#12506;&#12540;&#12472;' on this =<?plugin SystemInfo CHARSET?>= wiki.
  57   And with the plugin: <?plugin RawHtml &#12363;&#12425; &#26032;&#35215;&#12506;&#12540;&#12472; ?> %%%
  58   And this is how it should look: [http://phpwiki.sourceforge.net/demo/images/chars-releasenotes-japanese.png]
  59
  60 !!! Paragraphs
  61
  62 * Don't indent paragraphs
  63 * Words wrap and fill as needed
  64 * Use blank lines as separators
  65 * Four or more minus signs make a horizontal rule
  66 * =~%%%= or =~<br>= makes a linebreak (in headings and lists too)
  67
  68
  69 !!! Lists
  70
  71 * asterisk for first level
  72   * indented asterisk (indent at least two spaces) for second level, etc.
  73 * Use <tt>~*</tt>, <tt>-</tt>, <tt>+</tt> or <tt>o</tt> for bullet
  74   lists, <tt>#</tt> for numbered lists (mix at will)
  75 * Definition lists:
  76   <pre>
  77   Term:
  78     definition
  79   </pre>
  80   gives
  81   Term:
  82     definition
  83   as in the =<DL><DT><DD>= list
  84 * Items may contain multiple paragraphs and other multi-lined content,
  85   just indent the items
  86
  87
  88 !!! Headings
  89
  90 * '=!=' at the start of a line makes a small heading
  91 * '=!!=' at the start of a line makes a medium heading
  92 * '=!!!=' at the start of a line makes a large heading
  93
  94
  95 !!! Preformatted text
  96
  97 * Place preformatted lines inside =~<pre>=:
  98   <verbatim>
  99   <pre>
 100   Preformatted text. WikiLinks still work.
 101   </pre>
 102   </verbatim>
 103   gives
 104   <pre>
 105   Preformatted text. WikiLinks still work.
 106   </pre>
 107 * If you want text with no Wiki interaction, use the =~<verbatim>= tag:
 108   <pre>
 109   <verbatim>
 110   Preformatted text. ~WikiLinks do not work.
 111   </verbatim>
 112   </pre>
 113   gives
 114   <verbatim>
 115   Preformatted text. WikiLinks do not work.
 116   </verbatim>
 117
 118
 119 !!!Indented Paragraphs
 120
 121 * Two or more whitespaces signal indented text. Indents may be nested.
 122
 123     This is an indented block of text.
 124
 125       This block is even more indented.
 126
 127 * E-mail style block-quoting is supported as well:
 128   <pre>
 129   > This is block-quoted text.
 130   </pre>
 131   renders as
 132
 133   > This is block-quoted text.
 134
 135
 136 !!! Emphasis
 137
 138 * Use an underscore (<tt>~_</tt>) for emphasis (usually _italics_)
 139 * Use an asterisk (<tt>~*</tt>) for strong emphasis (usually *bold*)
 140 * Mix them at will: *_bold italics_*
 141 * _Emphasis_ can be used _multiple_ times within a paragraph, but
 142   _cannot_ cross paragraph boundaries:
 143
 144   _this
 145
 146   will not work_
 147
 148 !!! References
 149
 150 * Hyperlinks to other pages within the Wiki are made by placing the
 151   page name in square brackets: [this is a page link] or
 152   UsingWikiWords (preferred)
 153 * Hyperlinks to external pages are done like this:
 154   [http://www.wcsb.org/]
 155 * You can name the links by providing a name, a bar (|) and then the
 156   hyperlink or pagename:
 157   [PhpWiki home page | http://phpwiki.sourceforge.net/] ---
 158   [the front page | HomePage]
 159 * You can suppress linking to old-style references and URIs by
 160   preceding the word with a '<tt>~~</tt>', e.g. ~NotLinkedAsWikiName,
 161   ~http~://not.linked.to/
 162 * Also, the old way of linking URL's is still supported: precede URLs
 163   with "<tt>http:</tt>", "<tt>ftp:</tt>" or "<tt>mailto:</tt>" to
 164   create links automatically as in: http://c2.com/
 165 * URLs ending with =.png=, =.gif=, or =.jpg= are inlined if in square
 166   brackets, by themselves:
 167   [http://phpwiki.sourceforge.net/demo/themes/default/images/png.png]
 168 * In-page #[hyperlinks] are made by placing a named anchor and
 169   referring to the anchor in a hyperlink:
 170   * Named anchors:
 171     * <tt>~#~[foo]</tt>: An anchor around the text "foo" with id
 172       "foo".
 173     * <tt>~#~[|foo]</tt>: An empty anchor with id "foo".
 174     * <tt>~#~[howdy|foo]</tt>: An anchor around the text "howdy" with
 175       id "foo".
 176   * References to name anchors are made thusly:%%%
 177     <tt>~[~#[#hyperlinks]]</tt>, <tt>~[~OtherPage#foo]</tt>,
 178     <tt>~[named|~OtherPage#foo]</tt>.
 179 * Semantic links are named links like: is_a::WikiPage and attributes like
 180   size:-4000.
 181 * A pagelink within square brackets starting with ":" is not backlinked.
 182
 183 !!! Tables
 184
 185 * Definition list style tables are written just like definition lists,
 186   except that you replace the trailing colon on the term with a "pipe"
 187   (<tt>|</tt>).
 188
 189   <pre>
 190   Term 1 |
 191      Definition 1 begins here.
 192      Term 1.1 |
 193         Definition 1.1
 194      Term 1.2 |
 195         Definition 1.2
 196      This is part of definition 1.
 197   Term 2 |
 198      Here's definition 2.
 199   </pre>
 200
 201   Term 1 |
 202      Definition 1 begins here.
 203      Term 1.1 |
 204         Definition 1.1
 205      Term 1.2 |
 206         Definition 1.2
 207      This is part of definition 1.
 208   Term 2 |
 209      Here's definition 2.
 210
 211 * Old-style tables are supported through the Help:OldStyleTablePlugin
 212
 213 !!! HTML Mark-Up Language
 214
 215 * Some in-line markup is allowed through the use of HTML tags:
 216   <b>b</b>, <big>big</big>, <i>i</i>, <small>small</small>,
 217   <tt>tt</tt>, <em>em</em>, <strong>strong</strong>,
 218   <abbr>abbr</abbr>, <acronym>acronym</acronym>, <cite>cite</cite>,
 219   <code>code</code>, <dfn>dfn</dfn>, <kbd>kbd</kbd>,
 220   <samp>samp</samp>, <var>var</var>, <sup>sup</sup> and <sub>sub</sub>
 221 * < and > are themselves
 222 * The & characters will not work
 223
 224 !!! Creating various kinds of special links
 225
 226 * See [Help:MagicPhpWikiURLs] for gory details on how to write various kind
 227   of wiki maintenance and other special links.
 228
 229 !!! Inserting plugins
 230
 231 * Several plugins permit embedding additional functionality to Wiki
 232   pages. For example,
 233   <verbatim>
 234   <?plugin BackLinks page=HomePage info=hits ?>
 235   </verbatim>
 236   gives
 237   <?plugin BackLinks page=HomePage info=hits ?>
 238
 239 * For more information on plugins see [WikiPlugin|Help:WikiPlugin], and [PluginManager] for a list of all
 240   plugins.
 241
 242 ----
 243
 244 [PhpWikiDocumentation]