|
1
|
<h2>Wiki Formatting Rule Summary</h2> |
|
2
|
|
|
3
|
<ol> |
|
4
|
<li> Blank lines are paragraph breaks |
|
5
|
<li> Bullets are "*" surrounded by two spaces at the beginning of a line |
|
6
|
<li> Enumeration items are "#" or a digit and a "." surrounded by two |
|
7
|
spaces at the beginning of a line |
|
8
|
<li> Indented paragraphs begin with a tab or two spaces |
|
9
|
<li> Hyperlinks in square brackets: |
|
10
|
"<b>[</b><i>target</i><b>]</b>" |
|
11
|
or "<b>[</b><i>target</i><b>|</b><i>label</i><b>]</b>" |
|
12
|
or "<b><</b><i>URL</i><b>></b>" |
|
13
|
+<li> Hyperlinks in angle brackets: "<b><</b><i>URL</i><b>></b>" |
|
14
|
+<li> Markdown-style hyperlinks: |
|
15
|
+ "<b>[</b><i>label</i><b>](</b><i>target</i><b>)</b>" |
|
16
|
<li> Most ordinary HTML works |
|
17
|
+<li> Fonts: "<b>*</b><i>italic</i><b>*</b>", |
|
18
|
+ "<b>**</b><i>bold</i><b>**</b>", |
|
19
|
+ "<b>`</b><i>teletype</i><b>`</b>". |
|
20
|
+<li> Backslash escapes: <b>\< \[ \* \_  |
|
21
|
+ \> \\</b> <i>and so forth....</i> |
|
22
|
<li> <verbatim> and <nowiki> |
|
23
|
</ol> |
|
24
|
|
|
25
|
<h2>Formatting Rule Details</h2> |
|
26
|
|
|
27
|
<ol> |
|
28
|
<li> <p><b>Paragraphs.</b> |
|
29
|
Any sequence of one or more blank lines forms a paragraph break. |
|
30
|
Centered or right-justified paragraphs are not supported by wiki markup, |
|
31
|
but you can do these things if you need them using HTML. |
|
32
|
|
|
33
|
<li> <p><b>Bullet Lists.</b> |
|
34
|
A bullet list item is a line that begins with a single "*" character |
|
35
|
surrounded on both sides by two or more spaces or by a tab. |
|
36
|
Only a single level of bullet list is supported by wiki. |
|
37
|
For nested lists, use HTML. |
|
38
|
|
|
39
|
<li> <p><b>Enumeration Lists.</b> |
|
40
|
An enumeration list item is a line that begins with a single "#" |
|
41
|
character surrounded on both sides by two or more spaces or by a tab. |
|
42
|
Or it can be a number and a "." (ex: "5.") surrounded on both sides |
|
43
|
by two spaces or a tab. |
|
44
|
Only a single level of enumeration list is supported by wiki. |
|
45
|
For nested lists or for enumerations that count using letters or |
|
46
|
roman numerals, use HTML. |
|
47
|
|
|
48
|
<li> <p><b>Indented Paragraphs.</b> |
|
49
|
Any paragraph that begins with two or more spaces or a tab and which |
|
50
|
is not a bullet or enumeration list item is rendered indented. |
|
51
|
Only a single level of indentation is supported by wiki. |
|
52
|
Use HTML for deeper indentation. |
|
53
|
|
|
54
|
<li> <p><b>Hyperlinks.</b> |
|
55
|
Text within square brackets ("[...]") becomes a |
|
56
|
hyperlink. The target can be a wiki page name, the artifact ID of |
|
57
|
a check-in or ticket, the name of an image, a URL, or an |
|
58
|
[#intermap|interwiki link] of the form |
|
59
|
"<i>Tag</i><b>:</b><i>PageName</i>". |
|
60
|
By default, the target is displayed as the text of the hyperlink. |
|
61
|
But you can specify alternative text after the target name |
|
62
|
separated by a "|" character. |
|
63
|
You can also link to internal anchor names using |
|
64
|
[#anchor-name], providing you have added the necessary |
|
65
|
"<a name='anchor-name'></a>" tag to your wiki page. |
|
66
|
|
|
67
|
+<li> <p><b>Auto-links</b> |
|
68
|
+ A URL that begins with "http://" or "https://" and that is |
|
69
|
+ enclosed in <...> functions as a hyperlink. |
|
70
|
+ |
|
71
|
+ |
|
72
|
+<li> <p><b>Markdown-style hyperlinks</b> |
|
73
|
+ Links of the form |
|
74
|
+ "<b>[</b><i>display-text</i><b>](</b><i>target</i><b>)</b>" |
|
75
|
+ show "<i>display-text</i>" on screen and make it a hyperlin |
|
76
|
+ to "<i>target</i>". |
|
77
|
|
|
78
|
<li> <p><b>HTML.</b> |
|
79
|
The following standard HTML elements may be used: |
|
80
|
<a> <address> <article> <aside> <b> |
|
81
|
<big> <blockquote> <br> <center> <cite> |
|
82
|
<code> <col> <colgroup> <dd> |
|
83
|
<del> <dfn> |
|
84
|
<div> <dl> <dt> <em> <font> <footer> |
|
85
|
<ins> |
|
86
|
<h1> <h2> <h3> <h4> <h5> <h6> |
|
87
|
<header> <hr> <i> <img> <kbd> <li> |
|
88
|
<nav> <nobr> <nowiki> <ol> <p> <pre> |
|
89
|
<s> <samp> <section> <small> <span> |
|
90
|
<strike> <strong> <sub> <sup> <table> |
|
91
|
<tbody> <td> <tfoot> <th> <thead> |
|
92
|
<title> <tr> <tt> <u> <ul> <var> |
|
93
|
<verbatim>. There are two non-standard elements available: |
|
94
|
<verbatim> and <nowiki>. No other elements are allowed. |
|
95
|
All attributes are checked and only a few benign attributes are |
|
96
|
allowed on each element. In particular, any attributes that specify |
|
97
|
javascript or CSS are elided. |
|
98
|
|
|
99
|
+<li> <p><b>Font Markup.</b> |
|
100
|
+ Text enclosed within "<tt>*...*</tt>" or "<tt>_..._</tt>" is |
|
101
|
+ emphasized (italic font). Text within "<tt>**...**</tt>" or |
|
102
|
+ "<tt>__...__</tt>" gets strong emphasis (bold font). |
|
103
|
+ Text within "<tt>`...`</tt>" is rendered literally using a |
|
104
|
+ constant-width font. Special characters (ex: "<" or "[") within |
|
105
|
+ "<tt>`...`</tt>" lose their special meaning and are rendered |
|
106
|
+ literally. |
|
107
|
+ |
|
108
|
+<li> <p><b>Backslash escapes.</b> |
|
109
|
+ A backslash followed by any other character is rendered as just |
|
110
|
+ the other character. The character that follows the backslash |
|
111
|
+ loses any special meaning it might have had otherwise. This is |
|
112
|
+ useful for escaping markup for literal display. |
|
113
|
|
|
114
|
<li> <p><b>Special Markup.</b> |
|
115
|
The <nowiki> tag disables all wiki formatting rules through |
|
116
|
the matching </nowiki> element. The <verbatim> tag works |
|
117
|
like <pre> with the addition that it also disables all wiki |
|
118
|
and HTML markup through the matching </verbatim>. |
|
119
|
Text within |
|
120
|
<tt><verbatim type="pikchr">...</verbatim></tt> |
|
121
|
is formatted using <a href="https://pikchr.org/home">Pikchr</a>. |
|
122
|
</ol> |
|
123
|
|
|
124
|
<a name="intermap"></a> |
|
125
|
<h2>Interwiki Tag [/intermap|Map]</h2> |
|
126
|
|