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