pgsrc/TextFormattingRules

   1 Date: Thu, 28 Mar 2002 14:57:00 -0500
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.2-jeffs-hacks)
   3 X-Rcs-Id: $Id: TextFormattingRules,v 1.29 2002-11-25 19:44:03 dairiki Exp $
   4 Content-Type: application/x-phpwiki;
   5   pagename=TextFormattingRules;
   6   flags=PAGE_LOCKED;
   7   markup=2;
   8   charset=iso-8859-1
   9 Content-Transfer-Encoding: binary
  10
  11 ! Synopsis
  12 TextFormattingRules
  13
  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<b>:</b>~<new-line> definition_ for definition lists.%%%
  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>.%%%
  23 *Preventing linking:* Prefix with "<tt>~~</tt>":
  24 <tt>~~~DoNotHyperlink</tt>, name links like <tt>~[text | URL]</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 <abbr>abbr</abbr> <acronym>acronym</acronym> <cite>cite</cite>
  31 <code>code</code> <dfn>dfn</dfn> <kbd>kbd</kbd> <samp>samp</samp>
  32 <var>var</var> <sup>sup</sup> <sub>sub</sub>
  33
  34 ----
  35
  36 !!! Paragraphs
  37
  38 * Don't indent paragraphs
  39 * Words wrap and fill as needed
  40 * Use blank lines as separators
  41 * Four or more minus signs make a horizontal rule
  42 * =~%%%= or =~<br>= makes a linebreak (in headings and lists too)
  43
  44
  45 !!! Lists
  46
  47 * asterisk for first level
  48   * indented asterisk (indent at least two spaces) for second level, etc.
  49 * Use <tt>~*</tt>, <tt>-</tt>, <tt>+</tt> or <tt>o</tt> for bullet
  50   lists, <tt>#</tt> for numbered lists (mix at will)
  51 * Definition lists:
  52   <pre>
  53   Term:
  54     definition
  55   </pre>
  56   gives
  57   Term:
  58     definition
  59   as in the =<DL><DT><DD>= list
  60 * Items may contain multiple paragraphs and other multi-lined content,
  61   just indent the items
  62
  63
  64 !!! Headings
  65
  66 * '=!=' at the start of a line makes a small heading
  67 * '=!!=' at the start of a line makes a medium heading
  68 * '=!!!=' at the start of a line makes a large heading
  69
  70
  71 !!! Preformatted text
  72
  73 * Place preformatted lines inside =~<pre>=:
  74   <verbatim>
  75   <pre>
  76   Preformatted text. WikiLinks still work.
  77   </pre>
  78   </verbatim>
  79   gives
  80   <pre>
  81   Preformatted text. WikiLinks still work.
  82   </pre>
  83 * If you want text with no Wiki interaction, use the =~<verbatim>= tag:
  84   <pre>
  85   <verbatim>
  86   Preformatted text. ~WikiLinks do not work.
  87   </verbatim>
  88   </pre>
  89   gives
  90   <verbatim>
  91   Preformatted text. WikiLinks do not work.
  92   </verbatim>
  93
  94
  95 !!!Indented Paragraphs
  96
  97 * Two or more whitespaces signal indented text. Indents may be nested.
  98
  99     This is an indented block of text.
 100
 101       This block is even more indented.
 102
 103 * E-mail style block-quoting is supported as well:
 104   <pre>
 105   > This is block-quoted text.
 106   </pre>
 107   renders as
 108
 109   > This is block-quoted text.
 110
 111
 112 !!! Emphasis
 113
 114 * Use an underscore (<tt>~_</tt>) for emphasis (usually _italics_)
 115 * Use an asterisk (<tt>~*</tt>) for strong emphasis (usually *bold*)
 116 * Mix them at will: *_bold italics_*
 117 * _Emphasis_ can be used _multiple_ times within a paragraph, but
 118   _cannot_ cross paragraph boundaries:
 119
 120   _this
 121
 122   will not work_
 123
 124 !!! References
 125
 126 * Hyperlinks to other pages within the Wiki are made by placing the
 127   page name in square brackets: [this is a page link] or
 128   UsingWikiWords (preferred)
 129 * Hyperlinks to external pages are done like this:
 130   [http://www.wcsb.org/]
 131 * You can name the links by providing a name, a bar (|) and then the
 132   hyperlink or pagename:
 133   [PhpWiki home page | http://phpwiki.sourceforge.net/] ---
 134   [the front page | HomePage]
 135 * You can suppress linking to old-style references and URIs by
 136   preceding the word with a '<tt>~~</tt>', e.g. ~NotLinkedAsWikiName,
 137   ~http://not.linked.to/
 138 * Also, the old way of linking URL's is still supported: precede URLs
 139   with "<tt>http:</tt>", "<tt>ftp:</tt>" or "<tt>mailto:</tt>" to
 140   create links automatically as in: http://c2.com/
 141 * URLs ending with =.png=, =.gif=, or =.jpg= are inlined if in square
 142   brackets, by themselves:
 143   [http://phpwiki.sourceforge.net/demo/themes/default/images/png.png]
 144 * In-page #[hyperlinks] are made by placing a named anchor and
 145   referring to the anchor in a hyperlink:
 146   * Named anchors:
 147     * <tt>~#~[foo]</tt>: An anchor around the text "foo" with id
 148       "foo".
 149     * <tt>~#~[|foo]</tt>: An empty anchor with id "foo".
 150     * <tt>~#~[howdy|foo]</tt>: An anchor around the text "howdy" with
 151       id "foo".
 152   * References to name anchors are made thusly:%%%
 153     <tt>~[~#[#hyperlinks]]</tt>, <tt>~[~OtherPage#foo]</tt>,
 154     <tt>~[named|~OtherPage#foo]</tt>.
 155
 156
 157 !!! Tables
 158
 159 * Definition list style tables are written just like definition lists,
 160   except that you replace the trailing colon on the term with a "pipe"
 161   (<tt>|</tt>).
 162
 163   <pre>
 164   Term 1 |
 165      Definition 1 begins here.
 166      Term 1.1 |
 167         Definition 1.1
 168      Term 1.2 |
 169         Definition 1.2
 170      This is part of definition 1.
 171   Term 2 |
 172      Here's definition 2.
 173   </pre>
 174
 175   Term 1 |
 176      Definition 1 begins here.
 177      Term 1.1 |
 178         Definition 1.1
 179      Term 1.2 |
 180         Definition 1.2
 181      This is part of definition 1.
 182   Term 2 |
 183      Here's definition 2.
 184
 185 * Old-style tables are supported through the OldStyleTablePlugin:
 186
 187 !!! HTML Mark-Up Language
 188
 189 * Some in-line markup is allowed through the use of HTML tags:
 190   <b>b</b>, <big>big</big>, <i>i</i>, <small>small</small>,
 191   <tt>tt</tt>, <em>em</em>, <strong>strong</strong>,
 192   <abbr>abbr</abbr>, <acronym>acronym</acronym>, <cite>cite</cite>,
 193   <code>code</code>, <dfn>dfn</dfn>, <kbd>kbd</kbd>,
 194   <samp>samp</samp>, <var>var</var>, <sup>sup</sup> and <sub>sub</sub>
 195 * < and > are themselves
 196 * The & characters will not work
 197
 198 !!! Creating various kinds of special links
 199
 200 * See [MagicPhpWikiURLs] for gory details on how to write various kind
 201   of wiki maintenance and other special links.
 202
 203 !!! Inserting plugins
 204
 205 * Several plugins permit embedding additional functionality to Wiki
 206   pages. For example,
 207   <verbatim>
 208   <?plugin BackLinks page=HomePage info=hits ?>
 209   </verbatim>
 210   gives
 211   <?plugin BackLinks page=HomePage info=hits ?>
 212
 213 * For more information on plugins, see WikiPlugin.
 214
 215 ----
 216
 217 PhpWikiDocumentation