pgsrc/TextFormattingRules

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