pgsrc/Help%2FTextFormattingRules

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