pgsrc/Help%2FTextFormattingRules

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