]> git.proxmox.com Git - pve-docs.git/blob - asciidoc/mediawiki.conf
mediawiki.conf: use h5 for paragraph titles
[pve-docs.git] / asciidoc / mediawiki.conf
1 #
2 # html5.conf
3 #
4 # Asciidoc configuration file.
5 # html5 backend.
6 #
7
8 [miscellaneous]
9 outfilesuffix=.html
10
11 [attributes]
12 basebackend=html
13 basebackend-html=
14 basebackend-html5=
15 basebackend-mediawiki=
16
17 [replacements2]
18 # Line break.
19 (?m)^(.*)\s\+$=\1<br>
20
21 [replacements]
22 ifdef::asciidoc7compatible[]
23 # Superscripts.
24 \^(.+?)\^=<sup>\1</sup>
25 # Subscripts.
26 ~(.+?)~=<sub>\1</sub>
27 endif::asciidoc7compatible[]
28
29 [ruler-blockmacro]
30 <hr>
31
32 [pagebreak-blockmacro]
33 <div style="page-break-after:always"></div>
34
35 [blockdef-pass]
36 asciimath-style=template="asciimathblock",subs=()
37 latexmath-style=template="latexmathblock",subs=()
38
39 [macros]
40 (?u)^(?P<name>audio|video)::(?P<target>\S*?)(\[(?P<attrlist>.*?)\])$=#
41 # math macros.
42 # Special characters are escaped in HTML math markup.
43 (?su)[\\]?(?P<name>asciimath|latexmath):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[specialcharacters]
44 (?u)^(?P<name>asciimath|latexmath)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=#[specialcharacters]
45
46 [asciimath-inlinemacro]
47 `{passtext}`
48
49 [asciimath-blockmacro]
50 <div class="mathblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
51 <div class="content">
52 <div class="title">{title}</div>
53 `{passtext}`
54 </div></div>
55
56 [asciimathblock]
57 <div class="mathblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
58 <div class="content">
59 <div class="title">{title}</div>
60 `|`
61 </div></div>
62
63 [latexmath-inlinemacro]
64 {passtext}
65
66 [latexmath-blockmacro]
67 <div class="mathblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
68 <div class="content">
69 <div class="title">{title}</div>
70 {passtext}
71 </div></div>
72
73 [latexmathblock]
74 <div class="mathblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
75 <div class="content">
76 <div class="title">{title}</div>
77 |
78 </div></div>
79
80 [image-inlinemacro]
81 <span class="image{role? {role}}">
82 <a class="image" href="{link}">
83 {data-uri%}<img src="{imagesdir=}{imagesdir?/}{target}" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}{title? title="{title}"}>
84 {data-uri#}<img alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}{title? title="{title}"}
85 {data-uri#}{sys:"{python}" -u -c "import mimetypes,base64,sys; print 'src=\"data:'+mimetypes.guess_type(r'{target}')[0]+';base64,'; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join(r"{indir={outdir}}",r"{imagesdir=}",r"{target}")}"}">
86 {link#}</a>
87 </span>
88
89 [image-blockmacro]
90 <div class="imageblock{style? {style}}{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}{align? style="text-align:{align};"}{float? style="float:{float};"}>
91 <div class="content">
92 <a class="image" href="{link}">
93 {data-uri%}<img src="{imagesdir=}{imagesdir?/}{target}" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}>
94 {data-uri#}<img alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}
95 {data-uri#}{sys:"{python}" -u -c "import mimetypes,base64,sys; print 'src=\"data:'+mimetypes.guess_type(r'{target}')[0]+';base64,'; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join(r"{indir={outdir}}",r"{imagesdir=}",r"{target}")}"}">
96 {link#}</a>
97 </div>
98 <div class="title">{caption={figure-caption} {counter:figure-number}. }{title}</div>
99 </div>
100
101 [audio-blockmacro]
102 <div class="audioblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
103 <div class="title">{caption=}{title}</div>
104 <div class="content">
105 <audio src="{imagesdir=}{imagesdir?/}{target}"{autoplay-option? autoplay}{nocontrols-option! controls}{loop-option? loop}>
106 Your browser does not support the audio tag.
107 </audio>
108 </div></div>
109
110 [video-blockmacro]
111 <div class="videoblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
112 <div class="title">{caption=}{title}</div>
113 <div class="content">
114 <video src="{imagesdir=}{imagesdir?/}{target}"{width? width="{width}"}{height? height="{height}"}{poster? poster="{poster}"}{autoplay-option? autoplay}{nocontrols-option! controls}{loop-option? loop}>
115 Your browser does not support the video tag.
116 </video>
117 </div></div>
118
119 [unfloat-blockmacro]
120 <div style="clear:both;"></div>
121
122 [toc-blockmacro]
123 template::[toc]
124
125 [indexterm-inlinemacro]
126 # Index term.
127 {empty}
128
129 [indexterm2-inlinemacro]
130 # Index term.
131 # Single entry index term that is visible in the primary text flow.
132 {1}
133
134 [footnote-inlinemacro]
135 # footnote:[<text>].
136 <span class="footnote"><br>[{0}]<br></span>
137
138 [footnoteref-inlinemacro]
139 # footnoteref:[<id>], create reference to footnote.
140 {2%}<span class="footnoteref"><br><a href="#_footnote_{1}">[{1}]</a><br></span>
141 # footnoteref:[<id>,<text>], create footnote with ID.
142 {2#}<span class="footnote" id="_footnote_{1}"><br>[{2}]<br></span>
143
144 [callout-inlinemacro]
145 ifndef::icons[]
146 <b>&lt;{index}&gt;</b>
147 endif::icons[]
148 ifdef::icons[]
149 ifndef::data-uri[]
150 <img src="{icon={iconsdir}/callouts/{index}.png}" alt="{index}">
151 endif::data-uri[]
152 ifdef::data-uri[]
153 <img alt="{index}" src="data:image/png;base64,
154 {sys:"{python}" -u -c "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join(r"{indir={outdir}}",r"{icon={iconsdir}/callouts/{index}.png}")}"}">
155 endif::data-uri[]
156 endif::icons[]
157
158 # Comment line macros.
159 [comment-inlinemacro]
160 {showcomments#}<br><span class="comment">{passtext}</span><br>
161
162 [comment-blockmacro]
163 {showcomments#}<p><span class="comment">{passtext}</span></p>
164
165 [literal-inlinemacro]
166 # Inline literal.
167 <span class="monospaced">{passtext}</span>
168
169 # List tags.
170 [listtags-bulleted]
171 list=<div class="ulist{style? {style}}{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ul>|</ul></div>
172 item=<li>|</li>
173 text=<p>|</p>
174
175 [listtags-numbered]
176 # The start attribute is not valid XHTML 1.1 but all browsers support it.
177 list=<div class="olist{style? {style}}{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ol class="{style}"{start? start="{start}"}>|</ol></div>
178 item=<li>|</li>
179 text=<p>|</p>
180
181 [listtags-labeled]
182 list=<div class="dlist{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<dl>|</dl></div>
183 entry=
184 label=
185 term=<dt class="hdlist1{strong-option? strong}">|</dt>
186 item=<dd>|</dd>
187 text=<p>|</p>
188
189 [listtags-horizontal]
190 list=<div class="hdlist{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<table>{labelwidth?<col width="{labelwidth}%">}{itemwidth?<col width="{itemwidth}%">}|</table></div>
191 label=<td class="hdlist1{strong-option? strong}">|</td>
192 term=|<br>
193 entry=<tr>|</tr>
194 item=<td class="hdlist2">|</td>
195 text=<p style="margin-top: 0;">|</p>
196
197 [listtags-qanda]
198 list=<div class="qlist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ol>|</ol></div>
199 entry=<li>|</li>
200 label=
201 term=<p><em>|</em></p>
202 item=
203 text=<p>|</p>
204
205 [listtags-callout]
206 ifndef::icons[]
207 list=<div class="colist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ol>|</ol></div>
208 item=<li>|</li>
209 text=<p>|</p>
210 endif::icons[]
211 ifdef::icons[]
212 list=<div class="colist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<table>|</table></div>
213 ifndef::data-uri[]
214 item=<tr><td><img src="{iconsdir}/callouts/{listindex}.png" alt="{listindex}"></td><td>|</td></tr>
215 endif::data-uri[]
216 ifdef::data-uri[]
217 item=<tr><td><img alt="{listindex}" src="data:image/png;base64, {sys:"{python}" -u -c "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join(r"{indir={outdir}}",r"{icon={iconsdir}/callouts/{listindex}.png}")}"}"></td><td>|</td></tr>
218 endif::data-uri[]
219 text=|
220 endif::icons[]
221
222 [listtags-glossary]
223 list=<div class="dlist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<dl>|</dl></div>
224 label=
225 entry=
226 term=<dt>|</dt>
227 item=<dd>|</dd>
228 text=<p>|</p>
229
230 [listtags-bibliography]
231 list=<div class="ulist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ul>|</ul></div>
232 item=<li>|</li>
233 text=<p>|</p>
234
235 [tags]
236 # Quoted text.
237 emphasis=<em>{1?<span class="{1}">}|{1?</span>}</em>
238 strong=<strong>{1?<span class="{1}">}|{1?</span>}</strong>
239 monospaced=<span class="monospaced{1? {1}}">|</span>
240 singlequoted={lsquo}{1?<span class="{1}">}|{1?</span>}{rsquo}
241 doublequoted={ldquo}{1?<span class="{1}">}|{1?</span>}{rdquo}
242 unquoted={1?<span class="{1}">}|{1?</span>}
243 superscript=<sup>{1?<span class="{1}">}|{1?</span>}</sup>
244 subscript=<sub>{1?<span class="{1}">}|{1?</span>}</sub>
245
246 ifdef::deprecated-quotes[]
247 # Override with deprecated quote attributes.
248 emphasis={role?<span class="{role}">}<em{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</em>{role?</span>}
249 strong={role?<span class="{role}">}<strong{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</strong>{role?</span>}
250 monospaced=<span class="monospaced{role? {role}}"{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</span>
251 singlequoted={role?<span class="{role}">}{1,2,3?<span style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?">}{amp}#8216;|{amp}#8217;{1,2,3?</span>}{role?</span>}
252 doublequoted={role?<span class="{role}">}{1,2,3?<span style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?">}{amp}#8220;|{amp}#8221;{1,2,3?</span>}{role?</span>}
253 unquoted={role?<span class="{role}">}{1,2,3?<span style="{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}">}|{1,2,3?</span>}{role?</span>}
254 superscript={role?<span class="{role}">}<sup{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</sup>{role?</span>}
255 subscript={role?<span class="{role}">}<sub{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</sub>{role?</span>}
256 endif::deprecated-quotes[]
257
258 # Inline macros
259 [http-inlinemacro]
260 <a href="{name}:{target}">{0={name}:{target}}</a>
261 [https-inlinemacro]
262 <a href="{name}:{target}">{0={name}:{target}}</a>
263 [ftp-inlinemacro]
264 <a href="{name}:{target}">{0={name}:{target}}</a>
265 [file-inlinemacro]
266 <a href="{name}:{target}">{0={name}:{target}}</a>
267 [irc-inlinemacro]
268 <a href="{name}:{target}">{0={name}:{target}}</a>
269 [mailto-inlinemacro]
270 <a href="mailto:{target}">{0={target}}</a>
271 [link-inlinemacro]
272 <a href="{target}">{0={target}}</a>
273 [callto-inlinemacro]
274 <a href="{name}:{target}">{0={target}}</a>
275 # anchor:id[text]
276 [anchor-inlinemacro]
277 <a id="{target}"></a>
278 # [[id,text]]
279 [anchor2-inlinemacro]
280 <a id="{1}"></a>
281 # [[[id]]]
282 [anchor3-inlinemacro]
283 <a id="{1}"></a>[{1}]
284 # xref:id[text]
285 [xref-inlinemacro]
286 <a href="#{target}">{0=[{target}]}</a>
287 # <<id,text>>
288 [xref2-inlinemacro]
289 <a href="#{1}">{2=[{1}]}</a>
290
291 # Special word substitution.
292 [emphasizedwords]
293 <em>{words}</em>
294 [monospacedwords]
295 <span class="monospaced">{words}</span>
296 [strongwords]
297 <strong>{words}</strong>
298
299 # Paragraph substitution.
300 [paragraph]
301 <div class="paragraph{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>{title?<div class="title"><h5>{title}</h5></div>}<p>
302 |
303 </p></div>
304
305 [admonitionparagraph]
306 template::[admonitionblock]
307
308 # Delimited blocks.
309 [listingblock]
310 <div class="listingblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
311 <div class="title">{caption=}{title}</div>
312 <div class="content monospaced">
313 <pre>
314 |
315 </pre>
316 </div></div>
317
318 [literalblock]
319 <div class="literalblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
320 <div class="title">{title}</div>
321 <div class="content monospaced">
322 <pre>
323 |
324 </pre>
325 </div></div>
326
327 [sidebarblock]
328 <div class="sidebarblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
329 <div class="content">
330 <div class="title">{title}</div>
331 |
332 </div></div>
333
334 [openblock]
335 <div class="openblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
336 <div class="title">{title}</div>
337 <div class="content">
338 |
339 </div></div>
340
341 [partintroblock]
342 template::[openblock]
343
344 [abstractblock]
345 template::[quoteblock]
346
347 [quoteblock]
348 <div class="quoteblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
349 <div class="title">{title}</div>
350 <div class="content">
351 |
352 </div>
353 <div class="attribution">
354 <em>{citetitle}</em>{attribution?<br>}
355 &#8212; {attribution}
356 </div></div>
357
358 [verseblock]
359 <div class="verseblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
360 <div class="title">{title}</div>
361 <pre class="content">
362 |
363 </pre>
364 <div class="attribution">
365 <em>{citetitle}</em>{attribution?<br>}
366 &#8212; {attribution}
367 </div></div>
368
369 [exampleblock]
370 <div class="exampleblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
371 <div class="title">{caption={example-caption} {counter:example-number}. }{title}</div>
372 <div class="content">
373 |
374 </div></div>
375
376 [admonitionblock]
377 <div class="admonitionblock{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}>
378 <table><tr>
379 <td class="icon">
380 {data-uri%}{icons#}<img src="{icon={iconsdir}/{name}.png}" alt="{caption}">
381 {data-uri#}{icons#}<img alt="{caption}" src="data:image/png;base64,
382 {data-uri#}{icons#}{sys:"{python}" -u -c "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join(r"{indir={outdir}}",r"{icon={iconsdir}/{name}.png}")}"}">
383 {icons%}<div class="title">{caption}</div>
384 </td>
385 <td class="content">
386 <div class="title">{title}</div>
387 |
388 </td>
389 </tr></table>
390 </div>
391
392 # Tables.
393 [tabletags-default]
394 colspec=<col{autowidth-option! style="width:{colpcwidth}%;"}>
395 bodyrow=<tr>|</tr>
396 headdata=<th class="tableblock halign-{halign=left} valign-{valign=top}" {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }>|</th>
397 bodydata=<td class="tableblock halign-{halign=left} valign-{valign=top}" {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }>|</td>
398 paragraph=<p class="tableblock">|</p>
399
400 [tabletags-header]
401 paragraph=<p class="tableblock header">|</p>
402
403 [tabletags-emphasis]
404 paragraph=<p class="tableblock"><em>|</em></p>
405
406 [tabletags-strong]
407 paragraph=<p class="tableblock"><strong>|</strong></p>
408
409 [tabletags-monospaced]
410 paragraph=<p class="tableblock monospaced">|</p>
411
412 [tabletags-verse]
413 bodydata=<td class="tableblock halign-{halign=left} valign-{valign=top}" {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }><div class="verse">|</div></td>
414 paragraph=
415
416 [tabletags-literal]
417 bodydata=<td class="tableblock halign-{halign=left} valign-{valign=top}" {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }><div class="literal monospaced"><pre>|</pre></div></td>
418 paragraph=
419
420 [tabletags-asciidoc]
421 bodydata=<td class="tableblock halign-{halign=left} valign-{valign=top}" {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }><div>|</div></td>
422 paragraph=
423
424 [table]
425 <table class="tableblock frame-{frame=all} grid-{grid=all}{role? {role}}{unbreakable-option? unbreakable}"{id? id="{id}"}
426 style="
427 margin-left:{align@left:0}{align@center|right:auto}; margin-right:{align@left|center:auto}{align@right:0};
428 float:{float};
429 {autowidth-option%}width:{tablepcwidth}%;
430 {autowidth-option#}{width#style=width:{tablepcwidth}%;}
431 ">
432 <caption class="title">{caption={table-caption} {counter:table-number}. }{title}</caption>
433 {colspecs}
434 {headrows#}<thead>
435 {headrows}
436 {headrows#}</thead>
437 {footrows#}<tfoot>
438 {footrows}
439 {footrows#}</tfoot>
440 <tbody>
441 {bodyrows}
442 </tbody>
443 </table>
444
445 #--------------------------------------------------------------------
446 # Deprecated old table definitions.
447 #
448
449 [miscellaneous]
450 # Screen width in pixels.
451 pagewidth=800
452 pageunits=px
453
454 [old_tabledef-default]
455 template=old_table
456 colspec=<col style="width:{colwidth}{pageunits};" />
457 bodyrow=<tr>|</tr>
458 headdata=<th class="tableblock halign-{colalign=left}">|</th>
459 footdata=<td class="tableblock halign-{colalign=left}">|</td>
460 bodydata=<td class="tableblock halign-{colalign=left}">|</td>
461
462 [old_table]
463 <table class="tableblock frame-{frame=all} grid-{grid=all}"{id? id="{id}"}>
464 <caption class="title">{caption={table-caption}}{title}</caption>
465 {colspecs}
466 {headrows#}<thead>
467 {headrows}
468 {headrows#}</thead>
469 {footrows#}<tfoot>
470 {footrows}
471 {footrows#}</tfoot>
472 <tbody style="vertical-align:top;">
473 {bodyrows}
474 </tbody>
475 </table>
476
477 # End of deprecated old table definitions.
478 #--------------------------------------------------------------------
479
480 [floatingtitle]
481 <h{level@0:1}{level@1:2}{level@2:3}{level@3:4}{level@4:5}{id? id="{id}"} class="float">{title}</h{level@0:1}{level@1:2}{level@2:3}{level@3:4}{level@4:5}>
482
483 [preamble]
484 # Untitled elements between header and first section title.
485 <div id="preamble">
486 <div class="sectionbody">
487 |
488 </div>
489 </div>
490
491 # Document sections.
492 [sect0]
493 <h1{id? id="{id}"}>{title}</h1>
494 |
495
496 [sect1]
497 <div class="sect1{style? {style}}{role? {role}}">
498 <h2{id? id="{id}"}>{numbered?{sectnum} }{title}</h2>
499 <div class="sectionbody">
500 |
501 </div>
502 </div>
503
504 [sect2]
505 <div class="sect2{style? {style}}{role? {role}}">
506 <h3{id? id="{id}"}>{numbered?{sectnum} }{title}</h3>
507 |
508 </div>
509
510 [sect3]
511 <div class="sect3{style? {style}}{role? {role}}">
512 <h4{id? id="{id}"}>{numbered?{sectnum} }{title}</h4>
513 |
514 </div>
515
516 [sect4]
517 <div class="sect4{style? {style}}{role? {role}}">
518 <h5{id? id="{id}"}>{title}</h5>
519 |
520 </div>
521
522 [appendix]
523 <div class="sect1{style? {style}}{role? {role}}">
524 <h2{id? id="{id}"}>{numbered?{sectnum} }{appendix-caption} {counter:appendix-number:A}: {title}</h2>
525 <div class="sectionbody">
526 |
527 </div>
528 </div>
529
530 [toc]
531 <div id="toc">
532 <div id="toctitle">{toc-title}</div>
533 <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
534 </div>
535
536 [header]
537 <!-- HEADER -->
538
539 [footer]
540 <!-- FOOTER -->
541
542 [footer-date]
543 # Default footer date is document modification time
544 ifeval::["{footer-style=default}"!="revdate"]
545 {docdate} {doctime}
546 endif::[]
547 # If set to "revdate", it'll be set to the revision date
548 ifeval::["{footer-style=default}"=="revdate"]
549 {revdate}
550 endif::[]
551
552 ifdef::doctype-manpage[]
553 [synopsis]
554 template::[sect1]
555 endif::doctype-manpage[]
556