pgsrc/OldTextFormattingRules

   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: OldTextFormattingRules,v 1.4 2004-03-14 16:34:22 rurban Exp $
   4 Content-Type: application/x-phpwiki;
   5   pagename=OldTextFormattingRules;
   6   pgsrc_version="2 $Revision: 1.4 $";
   7   flags=PAGE_LOCKED;
   8   charset=iso-8859-1
   9 Content-Transfer-Encoding: binary
  10
  11 <?plugin CreateToc jshide||=1 with_toclink||=1 ?>
  12 ----
  13 ! Synopsis
  14 OldTextFormattingRules%%%
  15 __Emphasis:__ '____' for ''italics'', _''''_ for __bold__, '____'_''''_ for ''__both__''.%%%
  16 __Lists:__ * for bullet lists, # for numbered lists, ''__;__ term __:__ definition'' for definition lists.%%%
  17 __References:__ !JoinCapitalizedWords or use square brackets for a [[page link] or URL [[!http://cool.wiki.int/].%%%
  18 __Footnotes:__ Use [[1],[[2],[[3],...%%%
  19 __Preventing linking:__ Prefix with "!": !!DoNotHyperlink, name links like [[[[text | URL] (double up on the "[").%%%
  20 __Misc:__ "!", "!!", "!!!" make headings, "%%''''%" makes a linebreak, "-''''-''''-''''-" makes a horizontal rule.
  21 __Tables:__ »|« as first char, »|« for more columns, »|>« align right, »|<« align left, »|^« centered (default), »||« span columns, »|v« span rows
  22
  23 ----
  24 ! Paragraphs
  25
  26 * Don't indent paragraphs
  27 * Words wrap and fill as needed
  28 * Use blank lines as separators
  29 * Four or more minus signs make a horizontal rule
  30 * %%''''% makes a linebreak (in headings and lists too)
  31
  32
  33 ! Lists
  34
  35 * asterisk for first level
  36 ** asterisk-asterisk for second level, etc.
  37 * Use * for bullet lists, # for numbered lists (mix at will)
  38 * semicolon-term-colon-definition for definition lists:
  39 ;term here:definition here, as in the <DL><DT><DD> list
  40 * One line for each item
  41 * Other leading whitespace signals preformatted text, changes font.
  42
  43 ! Headings
  44
  45 * '!' at the start of a line makes a small heading
  46 * '!!' at the start of a line makes a medium heading
  47 * '!!!' at the start of a line makes a large heading
  48
  49 ! Fonts
  50
  51 * Indent with one or more spaces to use a monospace font:
  52
  53  This is in monospace
  54 This is not
  55
  56 !Indented Paragraphs
  57
  58 * semicolon-colon -- works like <BLOCKQUOTE>
  59
  60 ;: this is an indented block of text
  61
  62 ! Emphasis
  63
  64 * Use doubled single-quotes ('____') for emphasis (usually ''italics'')
  65 * Use doubled underscores (_''''_) for strong emphasis (usually __bold__)
  66 * Mix them at will: __''bold italics''__
  67 * ''Emphasis'' can be used ''multiple'' times within a line, but ''cannot'' cross line boundaries:
  68
  69 ''this
  70 will not work''
  71
  72 ! References
  73 * Hyperlinks to other pages within the Wiki are made by placing the page name in square brackets: [this is a page link] or UsingWikiWords (preferred)
  74 * Hyperlinks to external pages are done like this: [http://www.wcsb.org/]
  75 * You can name the links by providing a name, a bar (|) and then the hyperlink or pagename: [PhpWiki home page | http://phpwiki.sourceforge.net/]  - [the front page | HomePage]
  76 * You can suppress linking to old-style references and URIs by preceding the word with a '!', e.g. !NotLinkedAsWikiName, !http://not.linked.to/
  77 * You can create footnotes by using [[1], [[2], [[3], ... like this here [1]. See footnote for counterpart.  (If the [[ is in the first column, it is a footnote ''definition'' rather than a footnote ''reference'' [1].)
  78 * Also, the old way of linking URL's is still supported: precede URLs with "http:", "ftp:" or "mailto:" to create links automatically as in: http://c2.com/
  79 * URLs ending with .png, .gif, or .jpg are inlined if in square brackets, by themselves: [http://phpwiki.sourceforge.net/demo/themes/default/images/png.png]
  80
  81 ! Tables
  82
  83 * Simple tables are available.  A table row is introduced by a __|__ in the first column.  It is best described by example:
  84       ||  _''''_Name_''''_               |v _''''_Cost_''''_   |v _''''_Notes_''''_
  85       | _''''_First_''''_   | _''''_Last_''''_
  86       |> Jeff       |< Dairiki   |^  Cheap     |< Not worth it
  87       |> Marco      |< Polo      | Cheaper     |< Not available
  88 ;: will generate
  89 ||  __Name__               |v __Cost__   |v __Notes__
  90 | __First__   | __Last__
  91 |> Jeff       |< Dairiki   |^  Cheap     |< Not worth it
  92 |> Marco      |< Polo      | Cheaper     |< Not available
  93
  94 ;: Note that multiple __|__'s lead to spanned columns, and __v__'s can be used to span rows.  A __>__ generates a right justified column, __<__ a left justified column and __^__ a centered column (which is the default.)
  95 ;: With the new TextFormatingsRules tables are only supported with the OldStyleTablePlugin.
  96
  97
  98 ! HTML Mark-Up Language
  99
 100 * Don't bother
 101 * < and > are themselves
 102 * The & characters will not work
 103 * If you really must use HTML, your system administrator can enable this feature. Start each line with a bar (|). Note that this feature is disabled by default.
 104
 105 ! More detail than you want to know
 106
 107 See [MagicPhpWikiURLs] for gory details on how to write various kind of wiki maintainance links. (''deprecated'')
 108
 109 -----
 110
 111 ! Footnotes:
 112
 113 [1] By using [[1] a second time (in the first column) the footnote itself is ''defined''.  You may refer to a footnote as many times as you want, but you may only define it once on the page.  Note the the [[1] in the footnote links back to the first reference, if there are multiple references there will be +'s after the [[1] which will link to the other references.  (References which come ''after'' the footnote ''definition'' will not be linked to.)
 114 ----
 115 PhpWikiDocumentation