pgsrc/TextFormattingRules

   1 ! Paragraphs
   2
   3
   4
   5 * Don't indent paragraphs
   6
   7 * Words wrap and fill as needed
   8
   9 * Use blank lines as separators
  10
  11 * Four or more minus signs make a horizontal rule
  12
  13 * %%''''% makes a linebreak (in headings and lists too)
  14
  15
  16
  17
  18
  19 ! Lists
  20
  21
  22
  23 * asterisk for first level
  24
  25 ** asterisk-asterisk for second level, etc.
  26
  27 * Use * for bullet lists, # for numbered lists (mix at will)
  28
  29 * semicolon-term-colon-definition for definition lists:
  30
  31 ;term here:definition here, as in the <DL><DT><DD> list
  32
  33 * One line for each item
  34
  35 * Other leading whitespace signals preformatted text, changes font.
  36
  37
  38
  39 ! Headings
  40
  41
  42
  43 * '!' at the start of a line makes a small heading
  44
  45 * '!!' at the start of a line makes a medium heading
  46
  47 * '!!!' at the start of a line makes a large heading
  48
  49
  50
  51 ! Fonts
  52
  53
  54
  55 * Indent with one or more spaces to use a monospace font:
  56
  57
  58
  59  This is in monospace
  60
  61 This is not
  62
  63
  64
  65 !Indented Paragraphs
  66
  67
  68
  69 * semicolon-colon -- works like <BLOCKQUOTE>
  70
  71
  72
  73 ;: this is an indented block of text
  74
  75
  76
  77 ! Emphasis
  78
  79
  80
  81 * Use doubled single-quotes ('____') for emphasis (usually ''italics'')
  82
  83 * Use doubled underscores (_''''_) for strong emphasis (usually __bold__)
  84
  85 * Mix them at will: __''bold italics''__
  86
  87 * ''Emphasis'' can be used ''multiple'' times within a line, but ''cannot'' cross line boundaries:
  88
  89
  90
  91 ''this
  92
  93 will not work''
  94
  95
  96
  97 ! References
  98
  99 * 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)
 100
 101 * Hyperlinks to external pages are done like this: [http://www.wcsb.org/]
 102
 103 * 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]
 104
 105 * You can suppress linking to old-style references and URIs by preceding the word with a '!', e.g. !NotLinkedAsWikiName, !http://not.linked.to/
 106
 107 * 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].)
 108
 109 * 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/
 110
 111 * URLs ending with .png, .gif, or .jpg are inlined if in square brackets, by themselves: [http://phpwiki.sourceforge.net/phpwiki/images/png.png]
 112 * Provide alternate text for inlined images using a bar(|) [Burn all GIFs!|http://phpwiki.sourceforge.net/phpwiki/images/png.png]
 113
 114
 115
 116
 117 ! Tables
 118
 119
 120
 121 * Simple tables are available.  A table row is introduced by a __|__ in the first column.  It is best described by example:
 122
 123       ||  _''''_Name_''''_               |v _''''_Cost_''''_   |v _''''_Notes_''''_
 124
 125       | _''''_First_''''_   | _''''_Last_''''_
 126
 127       |> Jeff       |< Dairiki   |^  Cheap     |< Not worth it
 128
 129       |> Marco      |< Polo      | Cheaper     |< Not available
 130
 131 ;: will generate
 132
 133 ||  __Name__               |v __Cost__   |v __Notes__
 134
 135 | __First__   | __Last__
 136
 137 |> Jeff       |< Dairiki   |^  Cheap     |< Not worth it
 138
 139 |> Marco      |< Polo      | Cheaper     |< Not available
 140
 141
 142
 143 ;: 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.)
 144
 145
 146
 147
 148
 149 ! HTML Mark-Up Language
 150
 151
 152
 153 * Don't bother
 154
 155 * < and > are themselves
 156
 157 * The & characters will not work
 158
 159 * 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.
 160
 161
 162
 163 ! More detail than you want to know
 164
 165
 166
 167 See [MagicPhpWikiURLs] for gory details on how to write
 168
 169 various kind of wiki maintainance links.
 170
 171
 172
 173 -----
 174
 175
 176
 177 Footnotes:
 178
 179
 180
 181 [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.)
 182