##// END OF EJS Templates
tests: modify minirst test input to new format...
Simon Heimberg -
r19996:52b43758 stable
parent child Browse files
Show More
@@ -1,245 +1,246 b''
1 from pprint import pprint
1 from pprint import pprint
2 from mercurial import minirst
2 from mercurial import minirst
3
3
4 def debugformat(text, form, **kwargs):
4 def debugformat(text, form, **kwargs):
5 if form == 'html':
5 if form == 'html':
6 print "html format:"
6 print "html format:"
7 out = minirst.format(text, style=form, **kwargs)
7 out = minirst.format(text, style=form, **kwargs)
8 else:
8 else:
9 print "%d column format:" % form
9 print "%d column format:" % form
10 out = minirst.format(text, width=form, **kwargs)
10 out = minirst.format(text, width=form, **kwargs)
11
11
12 print "-" * 70
12 print "-" * 70
13 if type(out) == tuple:
13 if type(out) == tuple:
14 print out[0][:-1]
14 print out[0][:-1]
15 print "-" * 70
15 print "-" * 70
16 pprint(out[1])
16 pprint(out[1])
17 else:
17 else:
18 print out[:-1]
18 print out[:-1]
19 print "-" * 70
19 print "-" * 70
20 print
20 print
21
21
22 def debugformats(title, text, **kwargs):
22 def debugformats(title, text, **kwargs):
23 print "== %s ==" % title
23 print "== %s ==" % title
24 debugformat(text, 60, **kwargs)
24 debugformat(text, 60, **kwargs)
25 debugformat(text, 30, **kwargs)
25 debugformat(text, 30, **kwargs)
26 debugformat(text, 'html', **kwargs)
26 debugformat(text, 'html', **kwargs)
27
27
28 paragraphs = """
28 paragraphs = """
29 This is some text in the first paragraph.
29 This is some text in the first paragraph.
30
30
31 A small indented paragraph.
31 A small indented paragraph.
32 It is followed by some lines
32 It is followed by some lines
33 containing random whitespace.
33 containing random whitespace.
34 \n \n \nThe third and final paragraph.
34 \n \n \nThe third and final paragraph.
35 """
35 """
36
36
37 debugformats('paragraphs', paragraphs)
37 debugformats('paragraphs', paragraphs)
38
38
39 definitions = """
39 definitions = """
40 A Term
40 A Term
41 Definition. The indented
41 Definition. The indented
42 lines make up the definition.
42 lines make up the definition.
43 Another Term
43 Another Term
44 Another definition. The final line in the
44 Another definition. The final line in the
45 definition determines the indentation, so
45 definition determines the indentation, so
46 this will be indented with four spaces.
46 this will be indented with four spaces.
47
47
48 A Nested/Indented Term
48 A Nested/Indented Term
49 Definition.
49 Definition.
50 """
50 """
51
51
52 debugformats('definitions', definitions)
52 debugformats('definitions', definitions)
53
53
54 literals = r"""
54 literals = r"""
55 The fully minimized form is the most
55 The fully minimized form is the most
56 convenient form::
56 convenient form::
57
57
58 Hello
58 Hello
59 literal
59 literal
60 world
60 world
61
61
62 In the partially minimized form a paragraph
62 In the partially minimized form a paragraph
63 simply ends with space-double-colon. ::
63 simply ends with space-double-colon. ::
64
64
65 ////////////////////////////////////////
65 ////////////////////////////////////////
66 long un-wrapped line in a literal block
66 long un-wrapped line in a literal block
67 \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
67 \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
68
68
69 ::
69 ::
70
70
71 This literal block is started with '::',
71 This literal block is started with '::',
72 the so-called expanded form. The paragraph
72 the so-called expanded form. The paragraph
73 with '::' disappears in the final output.
73 with '::' disappears in the final output.
74 """
74 """
75
75
76 debugformats('literals', literals)
76 debugformats('literals', literals)
77
77
78 lists = """
78 lists = """
79 - This is the first list item.
79 - This is the first list item.
80
80
81 Second paragraph in the first list item.
81 Second paragraph in the first list item.
82
82
83 - List items need not be separated
83 - List items need not be separated
84 by a blank line.
84 by a blank line.
85 - And will be rendered without
85 - And will be rendered without
86 one in any case.
86 one in any case.
87
87
88 We can have indented lists:
88 We can have indented lists:
89
89
90 - This is an indented list item
90 - This is an indented list item
91
91
92 - Another indented list item::
92 - Another indented list item::
93
93
94 - A literal block in the middle
94 - A literal block in the middle
95 of an indented list.
95 of an indented list.
96
96
97 (The above is not a list item since we are in the literal block.)
97 (The above is not a list item since we are in the literal block.)
98
98
99 ::
99 ::
100
100
101 Literal block with no indentation (apart from
101 Literal block with no indentation (apart from
102 the two spaces added to all literal blocks).
102 the two spaces added to all literal blocks).
103
103
104 1. This is an enumerated list (first item).
104 1. This is an enumerated list (first item).
105 2. Continuing with the second item.
105 2. Continuing with the second item.
106
106
107 (1) foo
107 (1) foo
108 (2) bar
108 (2) bar
109
109
110 1) Another
110 1) Another
111 2) List
111 2) List
112
112
113 Line blocks are also a form of list:
113 Line blocks are also a form of list:
114
114
115 | This is the first line.
115 | This is the first line.
116 The line continues here.
116 The line continues here.
117 | This is the second line.
117 | This is the second line.
118 """
118 """
119
119
120 debugformats('lists', lists)
120 debugformats('lists', lists)
121
121
122 options = """
122 options = """
123 There is support for simple option lists,
123 There is support for simple option lists,
124 but only with long options:
124 but only with long options:
125
125
126 -X, --exclude filter an option with a short and long option with an argument
126 -X, --exclude filter an option with a short and long option with an argument
127 -I, --include an option with both a short option and a long option
127 -I, --include an option with both a short option and a long option
128 --all Output all.
128 --all Output all.
129 --both Output both (this description is
129 --both Output both (this description is
130 quite long).
130 quite long).
131 --long Output all day long.
131 --long Output all day long.
132
132
133 --par This option has two paragraphs in its description.
133 --par This option has two paragraphs in its description.
134 This is the first.
134 This is the first.
135
135
136 This is the second. Blank lines may be omitted between
136 This is the second. Blank lines may be omitted between
137 options (as above) or left in (as here).
137 options (as above) or left in (as here).
138
138
139
139
140 The next paragraph looks like an option list, but lacks the two-space
140 The next paragraph looks like an option list, but lacks the two-space
141 marker after the option. It is treated as a normal paragraph:
141 marker after the option. It is treated as a normal paragraph:
142
142
143 --foo bar baz
143 --foo bar baz
144 """
144 """
145
145
146 debugformats('options', options)
146 debugformats('options', options)
147
147
148 fields = """
148 fields = """
149 :a: First item.
149 :a: First item.
150 :ab: Second item. Indentation and wrapping
150 :ab: Second item. Indentation and wrapping
151 is handled automatically.
151 is handled automatically.
152
152
153 Next list:
153 Next list:
154
154
155 :small: The larger key below triggers full indentation here.
155 :small: The larger key below triggers full indentation here.
156 :much too large: This key is big enough to get its own line.
156 :much too large: This key is big enough to get its own line.
157 """
157 """
158
158
159 debugformats('fields', fields)
159 debugformats('fields', fields)
160
160
161 containers = """
161 containers = """
162 Normal output.
162 Normal output.
163
163
164 .. container:: debug
164 .. container:: debug
165
165
166 Initial debug output.
166 Initial debug output.
167
167
168 .. container:: verbose
168 .. container:: verbose
169
169
170 Verbose output.
170 Verbose output.
171
171
172 .. container:: debug
172 .. container:: debug
173
173
174 Debug output.
174 Debug output.
175 """
175 """
176
176
177 debugformats('containers (normal)', containers)
177 debugformats('containers (normal)', containers)
178 debugformats('containers (verbose)', containers, keep=['verbose'])
178 debugformats('containers (verbose)', containers, keep=['verbose'])
179 debugformats('containers (debug)', containers, keep=['debug'])
179 debugformats('containers (debug)', containers, keep=['debug'])
180 debugformats('containers (verbose debug)', containers,
180 debugformats('containers (verbose debug)', containers,
181 keep=['verbose', 'debug'])
181 keep=['verbose', 'debug'])
182
182
183 roles = """Please see :hg:`add`."""
183 roles = """Please see :hg:`add`."""
184 debugformats('roles', roles)
184 debugformats('roles', roles)
185
185
186
186
187 sections = """
187 sections = """
188 Title
188 Title
189 =====
189 =====
190
190
191 Section
191 Section
192 -------
192 -------
193
193
194 Subsection
194 Subsection
195 ''''''''''
195 ''''''''''
196
196
197 Markup: ``foo`` and :hg:`help`
197 Markup: ``foo`` and :hg:`help`
198 ------------------------------
198 ------------------------------
199 """
199 """
200 debugformats('sections', sections)
200 debugformats('sections', sections)
201
201
202
202
203 admonitions = """
203 admonitions = """
204 .. note::
204 .. note::
205
205 This is a note
206 This is a note
206
207
207 - Bullet 1
208 - Bullet 1
208 - Bullet 2
209 - Bullet 2
209
210
210 .. warning:: This is a warning Second
211 .. warning:: This is a warning Second
211 input line of warning
212 input line of warning
212
213
213 .. danger::
214 .. danger::
214 This is danger
215 This is danger
215 """
216 """
216
217
217 debugformats('admonitions', admonitions)
218 debugformats('admonitions', admonitions)
218
219
219 comments = """
220 comments = """
220 Some text.
221 Some text.
221
222
222 .. A comment
223 .. A comment
223
224
224 .. An indented comment
225 .. An indented comment
225
226
226 Some indented text.
227 Some indented text.
227
228
228 ..
229 ..
229
230
230 Empty comment above
231 Empty comment above
231 """
232 """
232
233
233 debugformats('comments', comments)
234 debugformats('comments', comments)
234
235
235
236
236 data = [['a', 'b', 'c'],
237 data = [['a', 'b', 'c'],
237 ['1', '2', '3'],
238 ['1', '2', '3'],
238 ['foo', 'bar', 'baz this list is very very very long man']]
239 ['foo', 'bar', 'baz this list is very very very long man']]
239
240
240 rst = minirst.maketable(data, 2, True)
241 rst = minirst.maketable(data, 2, True)
241 table = ''.join(rst)
242 table = ''.join(rst)
242
243
243 print table
244 print table
244
245
245 debugformats('table', table)
246 debugformats('table', table)
@@ -1,772 +1,775 b''
1 == paragraphs ==
1 == paragraphs ==
2 60 column format:
2 60 column format:
3 ----------------------------------------------------------------------
3 ----------------------------------------------------------------------
4 This is some text in the first paragraph.
4 This is some text in the first paragraph.
5
5
6 A small indented paragraph. It is followed by some lines
6 A small indented paragraph. It is followed by some lines
7 containing random whitespace.
7 containing random whitespace.
8
8
9 The third and final paragraph.
9 The third and final paragraph.
10 ----------------------------------------------------------------------
10 ----------------------------------------------------------------------
11
11
12 30 column format:
12 30 column format:
13 ----------------------------------------------------------------------
13 ----------------------------------------------------------------------
14 This is some text in the first
14 This is some text in the first
15 paragraph.
15 paragraph.
16
16
17 A small indented paragraph.
17 A small indented paragraph.
18 It is followed by some lines
18 It is followed by some lines
19 containing random
19 containing random
20 whitespace.
20 whitespace.
21
21
22 The third and final paragraph.
22 The third and final paragraph.
23 ----------------------------------------------------------------------
23 ----------------------------------------------------------------------
24
24
25 html format:
25 html format:
26 ----------------------------------------------------------------------
26 ----------------------------------------------------------------------
27 <p>
27 <p>
28 This is some text in the first paragraph.
28 This is some text in the first paragraph.
29 </p>
29 </p>
30 <p>
30 <p>
31 A small indented paragraph.
31 A small indented paragraph.
32 It is followed by some lines
32 It is followed by some lines
33 containing random whitespace.
33 containing random whitespace.
34 </p>
34 </p>
35 <p>
35 <p>
36 The third and final paragraph.
36 The third and final paragraph.
37 </p>
37 </p>
38 ----------------------------------------------------------------------
38 ----------------------------------------------------------------------
39
39
40 == definitions ==
40 == definitions ==
41 60 column format:
41 60 column format:
42 ----------------------------------------------------------------------
42 ----------------------------------------------------------------------
43 A Term
43 A Term
44 Definition. The indented lines make up the definition.
44 Definition. The indented lines make up the definition.
45
45
46 Another Term
46 Another Term
47 Another definition. The final line in the definition
47 Another definition. The final line in the definition
48 determines the indentation, so this will be indented
48 determines the indentation, so this will be indented
49 with four spaces.
49 with four spaces.
50
50
51 A Nested/Indented Term
51 A Nested/Indented Term
52 Definition.
52 Definition.
53 ----------------------------------------------------------------------
53 ----------------------------------------------------------------------
54
54
55 30 column format:
55 30 column format:
56 ----------------------------------------------------------------------
56 ----------------------------------------------------------------------
57 A Term
57 A Term
58 Definition. The indented
58 Definition. The indented
59 lines make up the
59 lines make up the
60 definition.
60 definition.
61
61
62 Another Term
62 Another Term
63 Another definition. The
63 Another definition. The
64 final line in the
64 final line in the
65 definition determines the
65 definition determines the
66 indentation, so this will
66 indentation, so this will
67 be indented with four
67 be indented with four
68 spaces.
68 spaces.
69
69
70 A Nested/Indented Term
70 A Nested/Indented Term
71 Definition.
71 Definition.
72 ----------------------------------------------------------------------
72 ----------------------------------------------------------------------
73
73
74 html format:
74 html format:
75 ----------------------------------------------------------------------
75 ----------------------------------------------------------------------
76 <dl>
76 <dl>
77 <dt>A Term
77 <dt>A Term
78 <dd>Definition. The indented lines make up the definition.
78 <dd>Definition. The indented lines make up the definition.
79 <dt>Another Term
79 <dt>Another Term
80 <dd>Another definition. The final line in the definition determines the indentation, so this will be indented with four spaces.
80 <dd>Another definition. The final line in the definition determines the indentation, so this will be indented with four spaces.
81 <dt>A Nested/Indented Term
81 <dt>A Nested/Indented Term
82 <dd>Definition.
82 <dd>Definition.
83 </dl>
83 </dl>
84 ----------------------------------------------------------------------
84 ----------------------------------------------------------------------
85
85
86 == literals ==
86 == literals ==
87 60 column format:
87 60 column format:
88 ----------------------------------------------------------------------
88 ----------------------------------------------------------------------
89 The fully minimized form is the most convenient form:
89 The fully minimized form is the most convenient form:
90
90
91 Hello
91 Hello
92 literal
92 literal
93 world
93 world
94
94
95 In the partially minimized form a paragraph simply ends with
95 In the partially minimized form a paragraph simply ends with
96 space-double-colon.
96 space-double-colon.
97
97
98 ////////////////////////////////////////
98 ////////////////////////////////////////
99 long un-wrapped line in a literal block
99 long un-wrapped line in a literal block
100 \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
100 \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
101
101
102 This literal block is started with '::',
102 This literal block is started with '::',
103 the so-called expanded form. The paragraph
103 the so-called expanded form. The paragraph
104 with '::' disappears in the final output.
104 with '::' disappears in the final output.
105 ----------------------------------------------------------------------
105 ----------------------------------------------------------------------
106
106
107 30 column format:
107 30 column format:
108 ----------------------------------------------------------------------
108 ----------------------------------------------------------------------
109 The fully minimized form is
109 The fully minimized form is
110 the most convenient form:
110 the most convenient form:
111
111
112 Hello
112 Hello
113 literal
113 literal
114 world
114 world
115
115
116 In the partially minimized
116 In the partially minimized
117 form a paragraph simply ends
117 form a paragraph simply ends
118 with space-double-colon.
118 with space-double-colon.
119
119
120 ////////////////////////////////////////
120 ////////////////////////////////////////
121 long un-wrapped line in a literal block
121 long un-wrapped line in a literal block
122 \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
122 \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
123
123
124 This literal block is started with '::',
124 This literal block is started with '::',
125 the so-called expanded form. The paragraph
125 the so-called expanded form. The paragraph
126 with '::' disappears in the final output.
126 with '::' disappears in the final output.
127 ----------------------------------------------------------------------
127 ----------------------------------------------------------------------
128
128
129 html format:
129 html format:
130 ----------------------------------------------------------------------
130 ----------------------------------------------------------------------
131 <p>
131 <p>
132 The fully minimized form is the most
132 The fully minimized form is the most
133 convenient form:
133 convenient form:
134 </p>
134 </p>
135 <pre>
135 <pre>
136 Hello
136 Hello
137 literal
137 literal
138 world
138 world
139 </pre>
139 </pre>
140 <p>
140 <p>
141 In the partially minimized form a paragraph
141 In the partially minimized form a paragraph
142 simply ends with space-double-colon.
142 simply ends with space-double-colon.
143 </p>
143 </p>
144 <pre>
144 <pre>
145 ////////////////////////////////////////
145 ////////////////////////////////////////
146 long un-wrapped line in a literal block
146 long un-wrapped line in a literal block
147 \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
147 \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
148 </pre>
148 </pre>
149 <pre>
149 <pre>
150 This literal block is started with '::',
150 This literal block is started with '::',
151 the so-called expanded form. The paragraph
151 the so-called expanded form. The paragraph
152 with '::' disappears in the final output.
152 with '::' disappears in the final output.
153 </pre>
153 </pre>
154 ----------------------------------------------------------------------
154 ----------------------------------------------------------------------
155
155
156 == lists ==
156 == lists ==
157 60 column format:
157 60 column format:
158 ----------------------------------------------------------------------
158 ----------------------------------------------------------------------
159 - This is the first list item.
159 - This is the first list item.
160
160
161 Second paragraph in the first list item.
161 Second paragraph in the first list item.
162
162
163 - List items need not be separated by a blank line.
163 - List items need not be separated by a blank line.
164 - And will be rendered without one in any case.
164 - And will be rendered without one in any case.
165
165
166 We can have indented lists:
166 We can have indented lists:
167
167
168 - This is an indented list item
168 - This is an indented list item
169 - Another indented list item:
169 - Another indented list item:
170
170
171 - A literal block in the middle
171 - A literal block in the middle
172 of an indented list.
172 of an indented list.
173
173
174 (The above is not a list item since we are in the literal block.)
174 (The above is not a list item since we are in the literal block.)
175
175
176 Literal block with no indentation (apart from
176 Literal block with no indentation (apart from
177 the two spaces added to all literal blocks).
177 the two spaces added to all literal blocks).
178
178
179 1. This is an enumerated list (first item).
179 1. This is an enumerated list (first item).
180 2. Continuing with the second item.
180 2. Continuing with the second item.
181 (1) foo
181 (1) foo
182 (2) bar
182 (2) bar
183 1) Another
183 1) Another
184 2) List
184 2) List
185
185
186 Line blocks are also a form of list:
186 Line blocks are also a form of list:
187
187
188 This is the first line. The line continues here.
188 This is the first line. The line continues here.
189 This is the second line.
189 This is the second line.
190 ----------------------------------------------------------------------
190 ----------------------------------------------------------------------
191
191
192 30 column format:
192 30 column format:
193 ----------------------------------------------------------------------
193 ----------------------------------------------------------------------
194 - This is the first list item.
194 - This is the first list item.
195
195
196 Second paragraph in the
196 Second paragraph in the
197 first list item.
197 first list item.
198
198
199 - List items need not be
199 - List items need not be
200 separated by a blank line.
200 separated by a blank line.
201 - And will be rendered without
201 - And will be rendered without
202 one in any case.
202 one in any case.
203
203
204 We can have indented lists:
204 We can have indented lists:
205
205
206 - This is an indented list
206 - This is an indented list
207 item
207 item
208 - Another indented list
208 - Another indented list
209 item:
209 item:
210
210
211 - A literal block in the middle
211 - A literal block in the middle
212 of an indented list.
212 of an indented list.
213
213
214 (The above is not a list item since we are in the literal block.)
214 (The above is not a list item since we are in the literal block.)
215
215
216 Literal block with no indentation (apart from
216 Literal block with no indentation (apart from
217 the two spaces added to all literal blocks).
217 the two spaces added to all literal blocks).
218
218
219 1. This is an enumerated list
219 1. This is an enumerated list
220 (first item).
220 (first item).
221 2. Continuing with the second
221 2. Continuing with the second
222 item.
222 item.
223 (1) foo
223 (1) foo
224 (2) bar
224 (2) bar
225 1) Another
225 1) Another
226 2) List
226 2) List
227
227
228 Line blocks are also a form of
228 Line blocks are also a form of
229 list:
229 list:
230
230
231 This is the first line. The
231 This is the first line. The
232 line continues here.
232 line continues here.
233 This is the second line.
233 This is the second line.
234 ----------------------------------------------------------------------
234 ----------------------------------------------------------------------
235
235
236 html format:
236 html format:
237 ----------------------------------------------------------------------
237 ----------------------------------------------------------------------
238 <ul>
238 <ul>
239 <li> This is the first list item.
239 <li> This is the first list item.
240 <p>
240 <p>
241 Second paragraph in the first list item.
241 Second paragraph in the first list item.
242 </p>
242 </p>
243 <li> List items need not be separated by a blank line.
243 <li> List items need not be separated by a blank line.
244 <li> And will be rendered without one in any case.
244 <li> And will be rendered without one in any case.
245 </ul>
245 </ul>
246 <p>
246 <p>
247 We can have indented lists:
247 We can have indented lists:
248 </p>
248 </p>
249 <ul>
249 <ul>
250 <li> This is an indented list item
250 <li> This is an indented list item
251 <li> Another indented list item:
251 <li> Another indented list item:
252 <pre>
252 <pre>
253 - A literal block in the middle
253 - A literal block in the middle
254 of an indented list.
254 of an indented list.
255 </pre>
255 </pre>
256 <pre>
256 <pre>
257 (The above is not a list item since we are in the literal block.)
257 (The above is not a list item since we are in the literal block.)
258 </pre>
258 </pre>
259 </ul>
259 </ul>
260 <pre>
260 <pre>
261 Literal block with no indentation (apart from
261 Literal block with no indentation (apart from
262 the two spaces added to all literal blocks).
262 the two spaces added to all literal blocks).
263 </pre>
263 </pre>
264 <ol>
264 <ol>
265 <li> This is an enumerated list (first item).
265 <li> This is an enumerated list (first item).
266 <li> Continuing with the second item.
266 <li> Continuing with the second item.
267 <li> foo
267 <li> foo
268 <li> bar
268 <li> bar
269 <li> Another
269 <li> Another
270 <li> List
270 <li> List
271 </ol>
271 </ol>
272 <p>
272 <p>
273 Line blocks are also a form of list:
273 Line blocks are also a form of list:
274 </p>
274 </p>
275 <ol>
275 <ol>
276 <li> This is the first line. The line continues here.
276 <li> This is the first line. The line continues here.
277 <li> This is the second line.
277 <li> This is the second line.
278 </ol>
278 </ol>
279 ----------------------------------------------------------------------
279 ----------------------------------------------------------------------
280
280
281 == options ==
281 == options ==
282 60 column format:
282 60 column format:
283 ----------------------------------------------------------------------
283 ----------------------------------------------------------------------
284 There is support for simple option lists, but only with long
284 There is support for simple option lists, but only with long
285 options:
285 options:
286
286
287 -X --exclude filter an option with a short and long option
287 -X --exclude filter an option with a short and long option
288 with an argument
288 with an argument
289 -I --include an option with both a short option and
289 -I --include an option with both a short option and
290 a long option
290 a long option
291 --all Output all.
291 --all Output all.
292 --both Output both (this description is quite
292 --both Output both (this description is quite
293 long).
293 long).
294 --long Output all day long.
294 --long Output all day long.
295 --par This option has two paragraphs in its
295 --par This option has two paragraphs in its
296 description. This is the first.
296 description. This is the first.
297
297
298 This is the second. Blank lines may
298 This is the second. Blank lines may
299 be omitted between options (as above)
299 be omitted between options (as above)
300 or left in (as here).
300 or left in (as here).
301
301
302 The next paragraph looks like an option list, but lacks the
302 The next paragraph looks like an option list, but lacks the
303 two-space marker after the option. It is treated as a normal
303 two-space marker after the option. It is treated as a normal
304 paragraph:
304 paragraph:
305
305
306 --foo bar baz
306 --foo bar baz
307 ----------------------------------------------------------------------
307 ----------------------------------------------------------------------
308
308
309 30 column format:
309 30 column format:
310 ----------------------------------------------------------------------
310 ----------------------------------------------------------------------
311 There is support for simple
311 There is support for simple
312 option lists, but only with
312 option lists, but only with
313 long options:
313 long options:
314
314
315 -X --exclude filter an
315 -X --exclude filter an
316 option
316 option
317 with a
317 with a
318 short
318 short
319 and
319 and
320 long
320 long
321 option
321 option
322 with an
322 with an
323 argumen
323 argumen
324 t
324 t
325 -I --include an
325 -I --include an
326 option
326 option
327 with
327 with
328 both a
328 both a
329 short
329 short
330 option
330 option
331 and a
331 and a
332 long
332 long
333 option
333 option
334 --all Output
334 --all Output
335 all.
335 all.
336 --both Output
336 --both Output
337 both
337 both
338 (this d
338 (this d
339 escript
339 escript
340 ion is
340 ion is
341 quite
341 quite
342 long).
342 long).
343 --long Output
343 --long Output
344 all day
344 all day
345 long.
345 long.
346 --par This
346 --par This
347 option
347 option
348 has two
348 has two
349 paragra
349 paragra
350 phs in
350 phs in
351 its des
351 its des
352 criptio
352 criptio
353 n. This
353 n. This
354 is the
354 is the
355 first.
355 first.
356
356
357 This is
357 This is
358 the
358 the
359 second.
359 second.
360 Blank
360 Blank
361 lines
361 lines
362 may be
362 may be
363 omitted
363 omitted
364 between
364 between
365 options
365 options
366 (as
366 (as
367 above)
367 above)
368 or left
368 or left
369 in (as
369 in (as
370 here).
370 here).
371
371
372 The next paragraph looks like
372 The next paragraph looks like
373 an option list, but lacks the
373 an option list, but lacks the
374 two-space marker after the
374 two-space marker after the
375 option. It is treated as a
375 option. It is treated as a
376 normal paragraph:
376 normal paragraph:
377
377
378 --foo bar baz
378 --foo bar baz
379 ----------------------------------------------------------------------
379 ----------------------------------------------------------------------
380
380
381 html format:
381 html format:
382 ----------------------------------------------------------------------
382 ----------------------------------------------------------------------
383 <p>
383 <p>
384 There is support for simple option lists,
384 There is support for simple option lists,
385 but only with long options:
385 but only with long options:
386 </p>
386 </p>
387 <dl>
387 <dl>
388 <dt>-X --exclude filter
388 <dt>-X --exclude filter
389 <dd>an option with a short and long option with an argument
389 <dd>an option with a short and long option with an argument
390 <dt>-I --include
390 <dt>-I --include
391 <dd>an option with both a short option and a long option
391 <dd>an option with both a short option and a long option
392 <dt> --all
392 <dt> --all
393 <dd>Output all.
393 <dd>Output all.
394 <dt> --both
394 <dt> --both
395 <dd>Output both (this description is quite long).
395 <dd>Output both (this description is quite long).
396 <dt> --long
396 <dt> --long
397 <dd>Output all day long.
397 <dd>Output all day long.
398 <dt> --par
398 <dt> --par
399 <dd>This option has two paragraphs in its description. This is the first.
399 <dd>This option has two paragraphs in its description. This is the first.
400 <p>
400 <p>
401 This is the second. Blank lines may be omitted between
401 This is the second. Blank lines may be omitted between
402 options (as above) or left in (as here).
402 options (as above) or left in (as here).
403 </p>
403 </p>
404 </dl>
404 </dl>
405 <p>
405 <p>
406 The next paragraph looks like an option list, but lacks the two-space
406 The next paragraph looks like an option list, but lacks the two-space
407 marker after the option. It is treated as a normal paragraph:
407 marker after the option. It is treated as a normal paragraph:
408 </p>
408 </p>
409 <p>
409 <p>
410 --foo bar baz
410 --foo bar baz
411 </p>
411 </p>
412 ----------------------------------------------------------------------
412 ----------------------------------------------------------------------
413
413
414 == fields ==
414 == fields ==
415 60 column format:
415 60 column format:
416 ----------------------------------------------------------------------
416 ----------------------------------------------------------------------
417 a First item.
417 a First item.
418 ab Second item. Indentation and wrapping is
418 ab Second item. Indentation and wrapping is
419 handled automatically.
419 handled automatically.
420
420
421 Next list:
421 Next list:
422
422
423 small The larger key below triggers full indentation
423 small The larger key below triggers full indentation
424 here.
424 here.
425 much too large
425 much too large
426 This key is big enough to get its own line.
426 This key is big enough to get its own line.
427 ----------------------------------------------------------------------
427 ----------------------------------------------------------------------
428
428
429 30 column format:
429 30 column format:
430 ----------------------------------------------------------------------
430 ----------------------------------------------------------------------
431 a First item.
431 a First item.
432 ab Second item.
432 ab Second item.
433 Indentation and
433 Indentation and
434 wrapping is
434 wrapping is
435 handled
435 handled
436 automatically.
436 automatically.
437
437
438 Next list:
438 Next list:
439
439
440 small The larger key
440 small The larger key
441 below triggers
441 below triggers
442 full indentation
442 full indentation
443 here.
443 here.
444 much too large
444 much too large
445 This key is big
445 This key is big
446 enough to get
446 enough to get
447 its own line.
447 its own line.
448 ----------------------------------------------------------------------
448 ----------------------------------------------------------------------
449
449
450 html format:
450 html format:
451 ----------------------------------------------------------------------
451 ----------------------------------------------------------------------
452 <dl>
452 <dl>
453 <dt>a
453 <dt>a
454 <dd>First item.
454 <dd>First item.
455 <dt>ab
455 <dt>ab
456 <dd>Second item. Indentation and wrapping is handled automatically.
456 <dd>Second item. Indentation and wrapping is handled automatically.
457 </dl>
457 </dl>
458 <p>
458 <p>
459 Next list:
459 Next list:
460 </p>
460 </p>
461 <dl>
461 <dl>
462 <dt>small
462 <dt>small
463 <dd>The larger key below triggers full indentation here.
463 <dd>The larger key below triggers full indentation here.
464 <dt>much too large
464 <dt>much too large
465 <dd>This key is big enough to get its own line.
465 <dd>This key is big enough to get its own line.
466 </dl>
466 </dl>
467 ----------------------------------------------------------------------
467 ----------------------------------------------------------------------
468
468
469 == containers (normal) ==
469 == containers (normal) ==
470 60 column format:
470 60 column format:
471 ----------------------------------------------------------------------
471 ----------------------------------------------------------------------
472 Normal output.
472 Normal output.
473 ----------------------------------------------------------------------
473 ----------------------------------------------------------------------
474
474
475 30 column format:
475 30 column format:
476 ----------------------------------------------------------------------
476 ----------------------------------------------------------------------
477 Normal output.
477 Normal output.
478 ----------------------------------------------------------------------
478 ----------------------------------------------------------------------
479
479
480 html format:
480 html format:
481 ----------------------------------------------------------------------
481 ----------------------------------------------------------------------
482 <p>
482 <p>
483 Normal output.
483 Normal output.
484 </p>
484 </p>
485 ----------------------------------------------------------------------
485 ----------------------------------------------------------------------
486
486
487 == containers (verbose) ==
487 == containers (verbose) ==
488 60 column format:
488 60 column format:
489 ----------------------------------------------------------------------
489 ----------------------------------------------------------------------
490 Normal output.
490 Normal output.
491
491
492 Verbose output.
492 Verbose output.
493 ----------------------------------------------------------------------
493 ----------------------------------------------------------------------
494 ['debug', 'debug']
494 ['debug', 'debug']
495 ----------------------------------------------------------------------
495 ----------------------------------------------------------------------
496
496
497 30 column format:
497 30 column format:
498 ----------------------------------------------------------------------
498 ----------------------------------------------------------------------
499 Normal output.
499 Normal output.
500
500
501 Verbose output.
501 Verbose output.
502 ----------------------------------------------------------------------
502 ----------------------------------------------------------------------
503 ['debug', 'debug']
503 ['debug', 'debug']
504 ----------------------------------------------------------------------
504 ----------------------------------------------------------------------
505
505
506 html format:
506 html format:
507 ----------------------------------------------------------------------
507 ----------------------------------------------------------------------
508 <p>
508 <p>
509 Normal output.
509 Normal output.
510 </p>
510 </p>
511 <p>
511 <p>
512 Verbose output.
512 Verbose output.
513 </p>
513 </p>
514 ----------------------------------------------------------------------
514 ----------------------------------------------------------------------
515 ['debug', 'debug']
515 ['debug', 'debug']
516 ----------------------------------------------------------------------
516 ----------------------------------------------------------------------
517
517
518 == containers (debug) ==
518 == containers (debug) ==
519 60 column format:
519 60 column format:
520 ----------------------------------------------------------------------
520 ----------------------------------------------------------------------
521 Normal output.
521 Normal output.
522
522
523 Initial debug output.
523 Initial debug output.
524 ----------------------------------------------------------------------
524 ----------------------------------------------------------------------
525 ['verbose']
525 ['verbose']
526 ----------------------------------------------------------------------
526 ----------------------------------------------------------------------
527
527
528 30 column format:
528 30 column format:
529 ----------------------------------------------------------------------
529 ----------------------------------------------------------------------
530 Normal output.
530 Normal output.
531
531
532 Initial debug output.
532 Initial debug output.
533 ----------------------------------------------------------------------
533 ----------------------------------------------------------------------
534 ['verbose']
534 ['verbose']
535 ----------------------------------------------------------------------
535 ----------------------------------------------------------------------
536
536
537 html format:
537 html format:
538 ----------------------------------------------------------------------
538 ----------------------------------------------------------------------
539 <p>
539 <p>
540 Normal output.
540 Normal output.
541 </p>
541 </p>
542 <p>
542 <p>
543 Initial debug output.
543 Initial debug output.
544 </p>
544 </p>
545 ----------------------------------------------------------------------
545 ----------------------------------------------------------------------
546 ['verbose']
546 ['verbose']
547 ----------------------------------------------------------------------
547 ----------------------------------------------------------------------
548
548
549 == containers (verbose debug) ==
549 == containers (verbose debug) ==
550 60 column format:
550 60 column format:
551 ----------------------------------------------------------------------
551 ----------------------------------------------------------------------
552 Normal output.
552 Normal output.
553
553
554 Initial debug output.
554 Initial debug output.
555
555
556 Verbose output.
556 Verbose output.
557
557
558 Debug output.
558 Debug output.
559 ----------------------------------------------------------------------
559 ----------------------------------------------------------------------
560 []
560 []
561 ----------------------------------------------------------------------
561 ----------------------------------------------------------------------
562
562
563 30 column format:
563 30 column format:
564 ----------------------------------------------------------------------
564 ----------------------------------------------------------------------
565 Normal output.
565 Normal output.
566
566
567 Initial debug output.
567 Initial debug output.
568
568
569 Verbose output.
569 Verbose output.
570
570
571 Debug output.
571 Debug output.
572 ----------------------------------------------------------------------
572 ----------------------------------------------------------------------
573 []
573 []
574 ----------------------------------------------------------------------
574 ----------------------------------------------------------------------
575
575
576 html format:
576 html format:
577 ----------------------------------------------------------------------
577 ----------------------------------------------------------------------
578 <p>
578 <p>
579 Normal output.
579 Normal output.
580 </p>
580 </p>
581 <p>
581 <p>
582 Initial debug output.
582 Initial debug output.
583 </p>
583 </p>
584 <p>
584 <p>
585 Verbose output.
585 Verbose output.
586 </p>
586 </p>
587 <p>
587 <p>
588 Debug output.
588 Debug output.
589 </p>
589 </p>
590 ----------------------------------------------------------------------
590 ----------------------------------------------------------------------
591 []
591 []
592 ----------------------------------------------------------------------
592 ----------------------------------------------------------------------
593
593
594 == roles ==
594 == roles ==
595 60 column format:
595 60 column format:
596 ----------------------------------------------------------------------
596 ----------------------------------------------------------------------
597 Please see "hg add".
597 Please see "hg add".
598 ----------------------------------------------------------------------
598 ----------------------------------------------------------------------
599
599
600 30 column format:
600 30 column format:
601 ----------------------------------------------------------------------
601 ----------------------------------------------------------------------
602 Please see "hg add".
602 Please see "hg add".
603 ----------------------------------------------------------------------
603 ----------------------------------------------------------------------
604
604
605 html format:
605 html format:
606 ----------------------------------------------------------------------
606 ----------------------------------------------------------------------
607 <p>
607 <p>
608 Please see &quot;hg add&quot;.
608 Please see &quot;hg add&quot;.
609 </p>
609 </p>
610 ----------------------------------------------------------------------
610 ----------------------------------------------------------------------
611
611
612 == sections ==
612 == sections ==
613 60 column format:
613 60 column format:
614 ----------------------------------------------------------------------
614 ----------------------------------------------------------------------
615 Title
615 Title
616 =====
616 =====
617
617
618 Section
618 Section
619 -------
619 -------
620
620
621 Subsection
621 Subsection
622 ''''''''''
622 ''''''''''
623
623
624 Markup: "foo" and "hg help"
624 Markup: "foo" and "hg help"
625 ---------------------------
625 ---------------------------
626 ----------------------------------------------------------------------
626 ----------------------------------------------------------------------
627
627
628 30 column format:
628 30 column format:
629 ----------------------------------------------------------------------
629 ----------------------------------------------------------------------
630 Title
630 Title
631 =====
631 =====
632
632
633 Section
633 Section
634 -------
634 -------
635
635
636 Subsection
636 Subsection
637 ''''''''''
637 ''''''''''
638
638
639 Markup: "foo" and "hg help"
639 Markup: "foo" and "hg help"
640 ---------------------------
640 ---------------------------
641 ----------------------------------------------------------------------
641 ----------------------------------------------------------------------
642
642
643 html format:
643 html format:
644 ----------------------------------------------------------------------
644 ----------------------------------------------------------------------
645 <h1>Title</h1>
645 <h1>Title</h1>
646 <h2>Section</h2>
646 <h2>Section</h2>
647 <h3>Subsection</h3>
647 <h3>Subsection</h3>
648 <h2>Markup: &quot;foo&quot; and &quot;hg help&quot;</h2>
648 <h2>Markup: &quot;foo&quot; and &quot;hg help&quot;</h2>
649 ----------------------------------------------------------------------
649 ----------------------------------------------------------------------
650
650
651 == admonitions ==
651 == admonitions ==
652 60 column format:
652 60 column format:
653 ----------------------------------------------------------------------
653 ----------------------------------------------------------------------
654 Note:
654 Note:
655 This is a note
655 This is a note
656
656
657 - Bullet 1
657 - Bullet 1
658 - Bullet 2
658 - Bullet 2
659
659
660 Warning!
660 Warning!
661 This is a warning Second input line of warning
661 This is a warning Second input line of warning
662
662
663 !Danger!
663 !Danger!
664 This is danger
664 This is danger
665 ----------------------------------------------------------------------
665 ----------------------------------------------------------------------
666
666
667 30 column format:
667 30 column format:
668 ----------------------------------------------------------------------
668 ----------------------------------------------------------------------
669 Note:
669 Note:
670 This is a note
670 This is a note
671
671
672 - Bullet 1
672 - Bullet 1
673 - Bullet 2
673 - Bullet 2
674
674
675 Warning!
675 Warning!
676 This is a warning Second
676 This is a warning Second
677 input line of warning
677 input line of warning
678
678
679 !Danger!
679 !Danger!
680 This is danger
680 This is danger
681 ----------------------------------------------------------------------
681 ----------------------------------------------------------------------
682
682
683 html format:
683 html format:
684 ----------------------------------------------------------------------
684 ----------------------------------------------------------------------
685 <p>
685 <p>
686 <b>Note:</b> This is a note
686 <b>Note:</b>
687 </p>
688 <p>
689 This is a note
687 </p>
690 </p>
688 <ul>
691 <ul>
689 <li> Bullet 1
692 <li> Bullet 1
690 <li> Bullet 2
693 <li> Bullet 2
691 </ul>
694 </ul>
692 <p>
695 <p>
693 <b>Warning!</b> This is a warning Second input line of warning
696 <b>Warning!</b> This is a warning Second input line of warning
694 </p>
697 </p>
695 <p>
698 <p>
696 <b>!Danger!</b> This is danger
699 <b>!Danger!</b> This is danger
697 </p>
700 </p>
698 ----------------------------------------------------------------------
701 ----------------------------------------------------------------------
699
702
700 == comments ==
703 == comments ==
701 60 column format:
704 60 column format:
702 ----------------------------------------------------------------------
705 ----------------------------------------------------------------------
703 Some text.
706 Some text.
704
707
705 Some indented text.
708 Some indented text.
706
709
707 Empty comment above
710 Empty comment above
708 ----------------------------------------------------------------------
711 ----------------------------------------------------------------------
709
712
710 30 column format:
713 30 column format:
711 ----------------------------------------------------------------------
714 ----------------------------------------------------------------------
712 Some text.
715 Some text.
713
716
714 Some indented text.
717 Some indented text.
715
718
716 Empty comment above
719 Empty comment above
717 ----------------------------------------------------------------------
720 ----------------------------------------------------------------------
718
721
719 html format:
722 html format:
720 ----------------------------------------------------------------------
723 ----------------------------------------------------------------------
721 <p>
724 <p>
722 Some text.
725 Some text.
723 </p>
726 </p>
724 <p>
727 <p>
725 Some indented text.
728 Some indented text.
726 </p>
729 </p>
727 <p>
730 <p>
728 Empty comment above
731 Empty comment above
729 </p>
732 </p>
730 ----------------------------------------------------------------------
733 ----------------------------------------------------------------------
731
734
732 === === ========================================
735 === === ========================================
733 a b c
736 a b c
734 === === ========================================
737 === === ========================================
735 1 2 3
738 1 2 3
736 foo bar baz this list is very very very long man
739 foo bar baz this list is very very very long man
737 === === ========================================
740 === === ========================================
738
741
739 == table ==
742 == table ==
740 60 column format:
743 60 column format:
741 ----------------------------------------------------------------------
744 ----------------------------------------------------------------------
742 a b c
745 a b c
743 ------------------------------------------------
746 ------------------------------------------------
744 1 2 3
747 1 2 3
745 foo bar baz this list is very very very long man
748 foo bar baz this list is very very very long man
746 ----------------------------------------------------------------------
749 ----------------------------------------------------------------------
747
750
748 30 column format:
751 30 column format:
749 ----------------------------------------------------------------------
752 ----------------------------------------------------------------------
750 a b c
753 a b c
751 ------------------------------
754 ------------------------------
752 1 2 3
755 1 2 3
753 foo bar baz this list is
756 foo bar baz this list is
754 very very very long
757 very very very long
755 man
758 man
756 ----------------------------------------------------------------------
759 ----------------------------------------------------------------------
757
760
758 html format:
761 html format:
759 ----------------------------------------------------------------------
762 ----------------------------------------------------------------------
760 <table>
763 <table>
761 <tr><td>a</td>
764 <tr><td>a</td>
762 <td>b</td>
765 <td>b</td>
763 <td>c</td></tr>
766 <td>c</td></tr>
764 <tr><td>1</td>
767 <tr><td>1</td>
765 <td>2</td>
768 <td>2</td>
766 <td>3</td></tr>
769 <td>3</td></tr>
767 <tr><td>foo</td>
770 <tr><td>foo</td>
768 <td>bar</td>
771 <td>bar</td>
769 <td>baz this list is very very very long man</td></tr>
772 <td>baz this list is very very very long man</td></tr>
770 </table>
773 </table>
771 ----------------------------------------------------------------------
774 ----------------------------------------------------------------------
772
775
General Comments 0
You need to be logged in to leave comments. Login now