]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - pgsrc/Help%2FOldTextFormattingRules
Help pages: required arguments
[SourceForge/phpwiki.git] / pgsrc / Help%2FOldTextFormattingRules
1 Date: Fri, 10 Sep 2010 13:46:13 +0000
2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0RC1)
3 X-Rcs-Id: $Id$
4 Content-Type: application/x-phpwiki;
5   pagename=Help%2FOldTextFormattingRules;
6   flags=PAGE_LOCKED%2CEXTERNAL_PAGE;
7   markup=2;
8   charset=UTF-8
9 Content-Transfer-Encoding: binary
10
11 ! Synopsis
12 [Help:OldTextFormattingRules] <br>
13 <strong>Emphasis:</strong> '<strong></strong>' for <em>italics</em>, _<em></em>~_ for <strong>bold</strong>, '<strong></strong>'_<em></em>~_ for <em><strong>both</strong></em>.%%%
14 <strong>Lists:</strong> * for bullet lists, # for numbered lists, <em><strong>;</strong> term <strong>~:</strong> definition</em> for definition lists.%%%
15 <strong>References:</strong> ~JoinCapitalizedWords or use square brackets for a ~[page link] or URL ~[~http~://cool.wiki.int/~].%%%
16 <strong>Footnotes:</strong> Use ~[1],~[2],~[3],...%%%
17 <strong>Preventing linking:</strong> Prefix with "~!": ~!~DoNotHyperlink, name links like ~[~[text | URL] (double up on the "[").%%%
18 <strong>Misc:</strong> "~!", "~!~!", "~!~!~!" make headings, "%%<em></em>%" makes a linebreak, "-<em></em>-<em></em>-<em></em>-" makes a horizontal rule.%%%
19 <strong>Tables:</strong> »|« as first char, »|« for more columns, »|>« align right, »|<« align left, »|^« centered (default), »||« span columns, »|v« span rows
20
21 ! Paragraphs
22
23 * Don't indent paragraphs
24 * Words wrap and fill as needed
25 * Use blank lines as separators
26 * Four or more minus signs make a horizontal rule
27 * %%<em></em>% makes a linebreak (in headings and lists too)
28
29 ! Lists
30
31 * asterisk for first level
32      * asterisk-asterisk for second level, etc.
33 * Use * for bullet lists, # for numbered lists (mix at will)
34 * semicolon-term-colon-definition for definition lists:
35 ;term here:definition here, as in the <DL><DT><DD> list
36 * One line for each item
37 * Other leading whitespace signals preformatted text, changes font.
38
39 ! Headings
40
41 * '~!' at the start of a line makes a small heading
42 * '~!~!' at the start of a line makes a medium heading
43 * '~!~!~!' at the start of a line makes a large heading
44
45 ! Fonts
46
47 * Indent with one or more spaces to use a monospace font:
48
49 <pre>
50  This is in monospace
51 </pre>
52 This is not
53
54 !Indented Paragraphs
55
56 * semicolon-colon -- works like <BLOCKQUOTE>
57
58 ;:this is an indented block of text
59
60 ! Emphasis
61
62 * Use doubled single-quotes ('<strong></strong>') for emphasis (usually <em>italics</em>)
63 * Use doubled underscores (_<em></em>_) for strong emphasis (usually <strong>bold</strong>)
64 * Mix them at will: <strong><em>bold italics</em></strong>
65 * <em>Emphasis</em> can be used <em>multiple</em> times within a line, but <em>cannot</em> cross line boundaries:
66
67 ''this
68 will not work''
69
70 ! References
71 * 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)
72 * Hyperlinks to external pages are done like this: [http://www.wcsb.org/]
73 * 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]
74 * You can suppress linking to old-style references and URIs by preceding the word with a '~!', e.g. ~NotLinkedAsWikiName, ~http://not.linked.to/
75 * You can create footnotes by using ~[1], ~[2], ~[3], ... like this here #[|ftnt_ref_1]<sup>~[[1|#ftnt_1]~]</sup>. See footnote for counterpart.  (If the ~[ is in the first column, it is a footnote <em>definition</em> rather than a footnote <em>reference</em> #[|ftnt_ref_1]<sup>~[[1|#ftnt_1]~]</sup>.)
76 * 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/
77 * 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]
78 * Semantic links are named links like: is_a::WikiPage and attributes like size:-4000.
79 * A pagelink within square brackets starting with ":" is not backlinked.
80
81 ! Tables
82
83 * Simple tables are available.  A table row is introduced by a <strong>|</strong> in the first column.  It is best described by example:
84 <pre>
85       ||  _<em></em>_Name_<em></em>~_               |v _<em></em>_Cost_<em></em>~_   |v _<em></em>_Notes_<em></em>~_
86       | _<em></em>_First_<em></em>~_   | _<em></em>_Last_<em></em>~_
87       |> Jeff       |< Dairiki   |^  Cheap     |< Not worth it
88       |> Marco      |< Polo      | Cheaper     |< Not available
89 </pre>
90 ;:will generate
91 <?plugin OldStyleTable
92 ||  <strong>Name</strong>               |v <strong>Cost</strong>   |v <strong>Notes</strong>
93 | <strong>First</strong>   | <strong>Last</strong>
94 |> Jeff       |< Dairiki   |^  Cheap     |< Not worth it
95 |> Marco      |< Polo      | Cheaper     |< Not available
96 ?>
97
98 ;:Note that multiple <strong>|</strong>'s lead to spanned columns, and <strong>v</strong>'s can be used to span rows.  A <strong>></strong> generates a right justified column, <strong><</strong> a left justified column and <strong>^</strong> a centered column (which is the default.)
99 ;:With the new [Help:TextFormatingsRules] tables are only supported with the [Help:OldStyleTablePlugin].
100
101 ! HTML Mark-Up Language
102
103 * Don't bother
104 * < and > are themselves
105 * The & characters will not work
106 * 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.
107
108 ! Footnotes
109
110 #[|ftnt_1]~[[1|#ftnt_ref_1]~]  By using ~[1] a second time (in the first column) the footnote itself is <em>defined</em>.  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 <em>after</em> the footnote <em>definition</em> will not be linked to.)
111
112 <noinclude>
113 ----
114 [[PhpWikiDocumentation]]
115 </noinclude>