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