git-scribe 0.0.4 → 0.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (151) hide show
  1. data/.gitignore +1 -0
  2. data/Rakefile +31 -0
  3. data/SPEC.asciidoc +126 -0
  4. data/TODO.txt +29 -0
  5. data/bin/git-scribe +2 -1
  6. data/docbook-xsl/.CatalogManager.properties.example +61 -0
  7. data/docbook-xsl/.urilist +1 -0
  8. data/git-scribe.gemspec +32 -0
  9. data/lib/git-scribe.rb +21 -315
  10. data/lib/git-scribe/check.rb +60 -0
  11. data/lib/git-scribe/cli.rb +84 -0
  12. data/lib/git-scribe/generate.rb +222 -0
  13. data/lib/git-scribe/init.rb +16 -0
  14. data/lib/git-scribe/version.rb +3 -0
  15. data/template/.gitignore +1 -0
  16. data/template/.gitscribe +5 -0
  17. data/test/check_test.rb +12 -0
  18. data/test/gen_test.rb +78 -0
  19. data/test/init_test.rb +36 -0
  20. data/test/test_helper.rb +44 -0
  21. metadata +49 -161
  22. data/example/book/big.asc +0 -5604
  23. data/example/book/holmes.asc +0 -12983
  24. data/example/output/META-INF/container.xml +0 -6
  25. data/example/output/OEBPS/ar01s02.html +0 -15
  26. data/example/output/OEBPS/ar01s03.html +0 -3
  27. data/example/output/OEBPS/content.opf +0 -21
  28. data/example/output/OEBPS/index.html +0 -5
  29. data/example/output/OEBPS/toc.ncx +0 -37
  30. data/example/output/a_case_of_identity.html +0 -725
  31. data/example/output/a_example_appendix.html +0 -63
  32. data/example/output/a_migration_notes.html +0 -95
  33. data/example/output/apa.html +0 -20
  34. data/example/output/apb.html +0 -6
  35. data/example/output/apc.html +0 -24
  36. data/example/output/apd.html +0 -30
  37. data/example/output/ape.html +0 -26
  38. data/example/output/apf.html +0 -9
  39. data/example/output/apg.html +0 -42
  40. data/example/output/aph.html +0 -89
  41. data/example/output/ar01s02.html +0 -12
  42. data/example/output/ar01s03.html +0 -34
  43. data/example/output/ar01s04.html +0 -77
  44. data/example/output/ar01s05.html +0 -272
  45. data/example/output/ar01s06.html +0 -35
  46. data/example/output/ar01s07.html +0 -105
  47. data/example/output/ar01s08.html +0 -33
  48. data/example/output/ar01s09.html +0 -12
  49. data/example/output/ar01s10.html +0 -14
  50. data/example/output/ar01s11.html +0 -34
  51. data/example/output/ar01s12.html +0 -63
  52. data/example/output/ar01s13.html +0 -156
  53. data/example/output/ar01s14.html +0 -330
  54. data/example/output/ar01s15.html +0 -22
  55. data/example/output/ar01s16.html +0 -27
  56. data/example/output/ar01s17.html +0 -94
  57. data/example/output/ar01s18.html +0 -359
  58. data/example/output/ar01s19.html +0 -373
  59. data/example/output/ar01s20.html +0 -27
  60. data/example/output/ar01s21.html +0 -33
  61. data/example/output/ar01s22.html +0 -351
  62. data/example/output/ar01s23.html +0 -21
  63. data/example/output/ar01s24.html +0 -69
  64. data/example/output/ar01s25.html +0 -60
  65. data/example/output/ar01s26.html +0 -217
  66. data/example/output/ar01s27.html +0 -88
  67. data/example/output/ar01s28.html +0 -237
  68. data/example/output/ar01s29.html +0 -68
  69. data/example/output/ar01s30.html +0 -154
  70. data/example/output/ar01s31.html +0 -6
  71. data/example/output/ar01s32.html +0 -22
  72. data/example/output/ar01s33.html +0 -209
  73. data/example/output/asciidoc_backends.html +0 -190
  74. data/example/output/asciidoc_document_types.html +0 -131
  75. data/example/output/attribute_entries.html +0 -185
  76. data/example/output/attribute_lists.html +0 -157
  77. data/example/output/attribute_references.html +0 -414
  78. data/example/output/attributelist_element.html +0 -143
  79. data/example/output/b_packager_notes.html +0 -68
  80. data/example/output/bi01.html +0 -18
  81. data/example/output/big.asc +0 -5604
  82. data/example/output/block_element_definitions.html +0 -448
  83. data/example/output/block_titles.html +0 -83
  84. data/example/output/blockid_element.html +0 -80
  85. data/example/output/book.asc +0 -5604
  86. data/example/output/book.epub +0 -0
  87. data/example/output/book.fo +0 -3788
  88. data/example/output/book.html +0 -8793
  89. data/example/output/book.xml +0 -8265
  90. data/example/output/c_asciidoc_safe_mode.html +0 -105
  91. data/example/output/callouts.html +0 -214
  92. data/example/output/catalog +0 -10
  93. data/example/output/colophon.html +0 -397
  94. data/example/output/configuration_files.html +0 -672
  95. data/example/output/converting_docbook_to_other_file_formats.html +0 -324
  96. data/example/output/d_using_asciidoc_with_non-english_languages.html +0 -107
  97. data/example/output/delimited_blocks.html +0 -455
  98. data/example/output/document_attributes.html +0 -95
  99. data/example/output/document_processing.html +0 -116
  100. data/example/output/document_structure.html +0 -493
  101. data/example/output/e_vim_syntax_highlighter.html +0 -111
  102. data/example/output/example_bibliography.html +0 -82
  103. data/example/output/example_colophon.html +0 -58
  104. data/example/output/example_glossary.html +0 -73
  105. data/example/output/example_index.html +0 -108
  106. data/example/output/f_attribute_options.html +0 -129
  107. data/example/output/filters.html +0 -179
  108. data/example/output/footnotes.html +0 -103
  109. data/example/output/g_diagnostics.html +0 -148
  110. data/example/output/generating_plain_text_files.html +0 -68
  111. data/example/output/getting_started.html +0 -87
  112. data/example/output/glossary.html +0 -95
  113. data/example/output/go01.html +0 -24
  114. data/example/output/h_backend_attributes.html +0 -308
  115. data/example/output/help_commands.html +0 -96
  116. data/example/output/holmes.asc +0 -12983
  117. data/example/output/image/octocat_professor.png +0 -0
  118. data/example/output/include/hello.c +0 -10
  119. data/example/output/index.html +0 -656
  120. data/example/output/indexes.html +0 -104
  121. data/example/output/intrinsic_attributes.html +0 -165
  122. data/example/output/ix01.html +0 -3
  123. data/example/output/lists.html +0 -666
  124. data/example/output/macros.html +0 -737
  125. data/example/output/manpage_documents.html +0 -124
  126. data/example/output/master.css +0 -281
  127. data/example/output/mathematical_formulas.html +0 -125
  128. data/example/output/page.html +0 -60
  129. data/example/output/paragraphs.html +0 -192
  130. data/example/output/pr01.html +0 -3
  131. data/example/output/source_code_highlighting.html +0 -59
  132. data/example/output/stylesheets/handbookish-quirks.css +0 -0
  133. data/example/output/stylesheets/handbookish.css +0 -233
  134. data/example/output/tables.html +0 -797
  135. data/example/output/text_formatting.html +0 -273
  136. data/example/output/the_adventure_of_the_beryl_coronet.html +0 -968
  137. data/example/output/the_adventure_of_the_blue_carbuncle.html +0 -825
  138. data/example/output/the_adventure_of_the_copper_beeches.html +0 -998
  139. data/example/output/the_adventure_of_the_engineer_s_thumb.html +0 -851
  140. data/example/output/the_adventure_of_the_noble_bachelor.html +0 -861
  141. data/example/output/the_adventure_of_the_speckled_band.html +0 -1015
  142. data/example/output/the_boscombe_valley_mystery.html +0 -974
  143. data/example/output/the_first_chapter.html +0 -110
  144. data/example/output/the_five_orange_pips.html +0 -776
  145. data/example/output/the_man_with_the_twisted_lip.html +0 -946
  146. data/example/output/the_red-headed_league.html +0 -950
  147. data/example/output/the_second_chapter.html +0 -95
  148. data/example/output/the_third_chapter.html +0 -58
  149. data/example/output/tips_and_tricks.html +0 -452
  150. data/example/output/title.html +0 -120
  151. data/example/output/titles.html +0 -126
data/example/output/getting_started.html DELETED
@@ -1,87 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
- <html xmlns="http://www.w3.org/1999/xhtml">
3
- <head>
4
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5
- <link rel="stylesheet" href="master.css" type="text/css" />
6
- <title>Getting Started</title>
7
- </head>
8
-
9
- <body>
10
- <div class="nav" id="navheader">
11
- <table width="100%">
12
- <tr><td width="33%" align="left">
13
-
14
- <a href="title.html">Prev</a><br/>
15
- Introduction
16
-
17
- </td><td width="33%" align="center">
18
-
19
- <a href="index.html">Home</a><br/>
20
- <strong>AsciiDoc User Guide</strong>
21
-
22
- </td><td width="33%" align="right">
23
-
24
- <a href="asciidoc_document_types.html">Next</a><br/>
25
- AsciiDoc Document Types
26
-
27
- </td></tr>
28
- </table>
29
- </div>
30
-
31
- <hr/>
32
-
33
- <div class="content">
34
- <div class="section" lang="en" xml:lang="en">
35
- <div class="titlepage"><div><div><h2 class="title" style="clear: both">
36
- <a id="X6"></a>Getting Started</h2></div></div></div>
37
- <div class="section" lang="en" xml:lang="en">
38
- <div class="titlepage"><div><div><h3 class="title">
39
- <a id="_installing_asciidoc"></a>Installing AsciiDoc</h3></div></div></div>
40
- <p>See the <code class="literal">README</code> and <code class="literal">INSTALL</code> files for install prerequisites and
41
- procedures. Packagers take a look at <a class="link" href="b_packager_notes.html" title="B. Packager Notes">Packager Notes</a>.</p>
42
- </div>
43
- <div class="section" lang="en" xml:lang="en">
44
- <div class="titlepage"><div><div><h3 class="title">
45
- <a id="X11"></a>Example AsciiDoc Documents</h3></div></div></div>
46
- <p>The best way to quickly get a feel for AsciiDoc is to view the
47
- AsciiDoc web site and/or distributed examples:</p>
48
- <div class="itemizedlist"><ul type="disc">
49
- <li>
50
- Take a look at the linked examples on the AsciiDoc web site home
51
- page <a class="ulink" href="http://www.methods.co.nz/asciidoc/" target="_top">http://www.methods.co.nz/asciidoc/</a>. Press the <span class="emphasis"><em>Page Source</em></span> sidebar menu item to view
52
- corresponding AsciiDoc source.
53
- </li>
54
- <li>
55
- Read the <code class="literal">*.txt</code> source files in the distribution <code class="literal">./doc</code> directory
56
- along with the corresponding HTML and DocBook XML files.
57
- </li>
58
- </ul></div>
59
- </div>
60
- </div>
61
-
62
- </div>
63
-
64
- <hr/>
65
-
66
- <div class="nav" id="navfooter">
67
- <table width="100%">
68
- <tr><td width="33%" align="left">
69
-
70
- <a href="title.html">Prev</a><br/>
71
- Introduction
72
-
73
- </td><td width="33%" align="center">
74
-
75
- <a href="index.html">Home</a><br/>
76
- AsciiDoc User Guide
77
-
78
- </td><td width="33%" align="right">
79
-
80
- <a href="asciidoc_document_types.html">Next</a><br/>
81
- AsciiDoc Document Types
82
-
83
- </td></tr>
84
- </table>
85
- </div>
86
- </body>
87
- </html>
data/example/output/glossary.html DELETED
@@ -1,95 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
- <html xmlns="http://www.w3.org/1999/xhtml">
3
- <head>
4
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5
- <link rel="stylesheet" href="master.css" type="text/css" />
6
- <title>Glossary</title>
7
- </head>
8
-
9
- <body>
10
- <div class="nav" id="navheader">
11
- <table width="100%">
12
- <tr><td width="33%" align="left">
13
-
14
- <a href="tips_and_tricks.html">Prev</a><br/>
15
- Tips and Tricks
16
-
17
- </td><td width="33%" align="center">
18
-
19
- <a href="index.html">Home</a><br/>
20
- <strong>AsciiDoc User Guide</strong>
21
-
22
- </td><td width="33%" align="right">
23
-
24
- <a href="a_migration_notes.html">Next</a><br/>
25
- A. Migration Notes
26
-
27
- </td></tr>
28
- </table>
29
- </div>
30
-
31
- <hr/>
32
-
33
- <div class="content">
34
- <div class="glossary">
35
- <div class="titlepage"><div><div><h2 class="title">
36
- <a id="_glossary"></a>Glossary</h2></div></div></div>
37
- <dl>
38
- <dt>
39
- <a id="X8"></a> Block element
40
- </dt>
41
- <dd><p>
42
- An AsciiDoc block element is a document entity composed of one or
43
- more whole lines of text.
44
- </p></dd>
45
- <dt>
46
- <a id="X34"></a> Inline element
47
- </dt>
48
- <dd><p>
49
- AsciiDoc inline elements occur within block element textual
50
- content, they perform formatting and substitution tasks.
51
- </p></dd>
52
- <dt>
53
- Formal element
54
- </dt>
55
- <dd><p>
56
- An AsciiDoc block element that has a BlockTitle. Formal elements
57
- are normally listed in front or back matter, for example lists of
58
- tables, examples and figures.
59
- </p></dd>
60
- <dt>
61
- Verbatim element
62
- </dt>
63
- <dd><p>
64
- The word verbatim indicates that white space and line breaks in
65
- the source document are to be preserved in the output document.
66
- </p></dd>
67
- </dl>
68
- </div>
69
-
70
- </div>
71
-
72
- <hr/>
73
-
74
- <div class="nav" id="navfooter">
75
- <table width="100%">
76
- <tr><td width="33%" align="left">
77
-
78
- <a href="tips_and_tricks.html">Prev</a><br/>
79
- Tips and Tricks
80
-
81
- </td><td width="33%" align="center">
82
-
83
- <a href="index.html">Home</a><br/>
84
- AsciiDoc User Guide
85
-
86
- </td><td width="33%" align="right">
87
-
88
- <a href="a_migration_notes.html">Next</a><br/>
89
- A. Migration Notes
90
-
91
- </td></tr>
92
- </table>
93
- </div>
94
- </body>
95
- </html>
data/example/output/go01.html DELETED
@@ -1,24 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Glossary</title><link rel="stylesheet" href="stylesheets/handbookish.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.74.1" /><link rel="home" href="index.html" title="AsciiDoc User Guide" /><link rel="up" href="index.html" title="AsciiDoc User Guide" /><link rel="prev" href="ar01s33.html" title="Tips and Tricks" /><link rel="next" href="apa.html" title="A. Migration Notes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Glossary</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s33.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apa.html">Next</a></td></tr></table><hr /></div><div class="glossary"><div class="titlepage"><div><div><h2 class="title"><a id="_glossary"></a>Glossary</h2></div></div></div><dl><dt>
4
- <a id="X8"></a> Block element
5
- </dt><dd><p>
6
- An AsciiDoc block element is a document entity composed of one or
7
- more whole lines of text.
8
- </p></dd><dt>
9
- <a id="X34"></a> Inline element
10
- </dt><dd><p>
11
- AsciiDoc inline elements occur within block element textual
12
- content, they perform formatting and substitution tasks.
13
- </p></dd><dt>
14
- Formal element
15
- </dt><dd><p>
16
- An AsciiDoc block element that has a BlockTitle. Formal elements
17
- are normally listed in front or back matter, for example lists of
18
- tables, examples and figures.
19
- </p></dd><dt>
20
- Verbatim element
21
- </dt><dd><p>
22
- The word verbatim indicates that white space and line breaks in
23
- the source document are to be preserved in the output document.
24
- </p></dd></dl></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s33.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apa.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Tips and Tricks </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> A. Migration Notes</td></tr></table></div></body></html>
data/example/output/h_backend_attributes.html DELETED
@@ -1,308 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
- <html xmlns="http://www.w3.org/1999/xhtml">
3
- <head>
4
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5
- <link rel="stylesheet" href="master.css" type="text/css" />
6
- <title>H. Backend Attributes</title>
7
- </head>
8
-
9
- <body>
10
- <div class="nav" id="navheader">
11
- <table width="100%">
12
- <tr><td width="33%" align="left">
13
-
14
- <a href="g_diagnostics.html">Prev</a><br/>
15
- G. Diagnostics
16
-
17
- </td><td width="33%" align="center">
18
-
19
- <a href="index.html">Home</a><br/>
20
- <strong>AsciiDoc User Guide</strong>
21
-
22
- </td><td width="33%" align="right">
23
-
24
- </td></tr>
25
- </table>
26
- </div>
27
-
28
- <hr/>
29
-
30
- <div class="content">
31
- <div class="appendix" lang="en" xml:lang="en">
32
- <div class="titlepage"><div><div><h2 class="title">
33
- <a id="X88"></a>H. Backend Attributes</h2></div></div></div>
34
- <p>This table contains a list of optional attributes that influence the
35
- generated outputs.</p>
36
- <div class="informaltable"><table border="1">
37
- <colgroup>
38
- <col>
39
- <col>
40
- <col>
41
- </colgroup>
42
- <thead><tr>
43
- <th align="left" valign="top">Name </th>
44
- <th align="left" valign="top">Backends </th>
45
- <th align="left" valign="top">Description</th>
46
- </tr></thead>
47
- <tbody>
48
- <tr>
49
- <td align="left" valign="top"><p><span class="emphasis"><em>badges</em></span></p></td>
50
- <td align="left" valign="top"><p>xhtml11</p></td>
51
- <td align="left" valign="top">
52
- <p>Link badges (<span class="emphasis"><em>XHTML 1.1</em></span>, <span class="emphasis"><em>CSS</em></span> and <span class="emphasis"><em>Get Firefox!</em></span>) in document
53
- footers. By default badges are omitted (<span class="emphasis"><em>badges</em></span> is undefined).</p>
54
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
55
- <h3 class="title">Note</h3>
56
- <p>The path names of images, icons and scripts are relative path
57
- names to the output document not the source document.</p>
58
- </div>
59
- </td>
60
- </tr>
61
- <tr>
62
- <td align="left" valign="top"><p><span class="emphasis"><em>data-uri</em></span></p></td>
63
- <td align="left" valign="top"><p>xhtml11</p></td>
64
- <td align="left" valign="top"><p>Embed images using the <a class="link" href="macros.html#X66" title="Embedding images in XHTML documents">data: uri scheme</a>.</p></td>
65
- </tr>
66
- <tr>
67
- <td align="left" valign="top"><p><span class="emphasis"><em>disable-javascript</em></span></p></td>
68
- <td align="left" valign="top"><p>xhtml11</p></td>
69
- <td align="left" valign="top"><p>If the <code class="literal">disable-javascript</code> attribute is defined the <code class="literal">asciidoc.js</code>
70
- JavaScript is not embedded or linked to the output document. By
71
- default AsciiDoc automatically embeds or links the <code class="literal">asciidoc.js</code>
72
- JavaScript to the <span class="emphasis"><em>xhtml11</em></span> output document. The script dynamically
73
- generates <a class="link" href="h_backend_attributes.html#X91">table of contents</a> and <a class="link" href="footnotes.html" title="Footnotes">footnotes</a>.</p></td>
74
- </tr>
75
- <tr>
76
- <td align="left" valign="top"><p><span class="emphasis"><em><a id="X97"></a> docinfo, docinfo1, docinfo2</em></span></p></td>
77
- <td align="left" valign="top"><p>All backends</p></td>
78
- <td align="left" valign="top">
79
- <p>These three attributes control which <a class="link" href="document_structure.html#X87" title="Additional document header information">document information files</a> will be included in the the header of the output file:</p>
80
- <div class="variablelist"><dl>
81
- <dt><span class="term">
82
- docinfo
83
- </span></dt>
84
- <dd>
85
- Include <code class="literal">&lt;filename&gt;-docinfo.&lt;ext&gt;</code>
86
- </dd>
87
- <dt><span class="term">
88
- docinfo1
89
- </span></dt>
90
- <dd>
91
- Include <code class="literal">docinfo.&lt;ext&gt;</code>
92
- </dd>
93
- <dt><span class="term">
94
- docinfo2
95
- </span></dt>
96
- <dd>
97
- Include <code class="literal">docinfo.&lt;ext&gt;</code> and <code class="literal">&lt;filename&gt;-docinfo.&lt;ext&gt;</code>
98
- </dd>
99
- </dl></div>
100
- <p>Where <code class="literal">&lt;filename&gt;</code> is the file name of (sans extension) of the
101
- AsciiDoc input file and <code class="literal">&lt;ext&gt;</code> is <code class="literal">.html</code> for HTML outputs or <code class="literal">.xml</code>
102
- for DocBook outputs. The following example will include the
103
- <code class="literal">mydoc-docinfo.xml</code> docinfo file in the DocBook <code class="literal">mydoc.xml</code> output
104
- file:</p>
105
- <pre class="literallayout">$ asciidoc -a docinfo -b docbook mydoc.txt</pre>
106
- <p>This next example will include <code class="literal">docinfo.html</code> and <code class="literal">mydoc-docinfo.html</code>
107
- docinfo files in the HTML output file:</p>
108
- <pre class="literallayout">$ asciidoc -a docinfo2 -b html4 mydoc.txt</pre>
109
- </td>
110
- </tr>
111
- <tr>
112
- <td align="left" valign="top"><p><span class="emphasis"><em><a id="X54"></a>encoding</em></span></p></td>
113
- <td align="left" valign="top"><p>html4, xhtml11, docbook</p></td>
114
- <td align="left" valign="top">
115
- <p>Set the input and output document character set encoding. For example
116
- the <code class="literal">--attribute encoding=ISO-8859-1</code> command-line option will set the
117
- character set encoding to <code class="literal">ISO-8859-1</code>.</p>
118
- <div class="itemizedlist"><ul type="disc">
119
- <li>
120
- The default encoding is UTF-8.
121
- </li>
122
- <li>
123
- This attribute specifies the character set in the output document.
124
- </li>
125
- <li>
126
- The encoding name must correspond to a Python codec name or alias.
127
- </li>
128
- <li>
129
- <p>
130
- The <span class="emphasis"><em>encoding</em></span> attribute can be set using an AttributeEntry inside
131
- the document header. For example:
132
- </p>
133
- <pre class="literallayout">:encoding: ISO-8859-1</pre>
134
- </li>
135
- </ul></div>
136
- </td>
137
- </tr>
138
- <tr>
139
- <td align="left" valign="top"><p><span class="emphasis"><em><a id="X45"></a>icons</em></span></p></td>
140
- <td align="left" valign="top"><p>xhtml11</p></td>
141
- <td align="left" valign="top"><p>Link admonition paragraph and admonition block icon images and badge
142
- images. By default <span class="emphasis"><em>icons</em></span> is undefined and text is used in place of
143
- icon images.</p></td>
144
- </tr>
145
- <tr>
146
- <td align="left" valign="top"><p><span class="emphasis"><em><a id="X44"></a>iconsdir</em></span></p></td>
147
- <td align="left" valign="top"><p>html4, xhtml11, docbook</p></td>
148
- <td align="left" valign="top"><p>The name of the directory containing linked admonition and navigation
149
- icons. Defaults to <code class="literal">./images/icons</code>.</p></td>
150
- </tr>
151
- <tr>
152
- <td align="left" valign="top"><p><span class="emphasis"><em>imagesdir</em></span></p></td>
153
- <td align="left" valign="top"><p>html4, xhtml11, docbook</p></td>
154
- <td align="left" valign="top"><p>If this attribute is defined it is prepended to the target image file
155
- name paths in inline and block image macros.</p></td>
156
- </tr>
157
- <tr>
158
- <td align="left" valign="top"><p><span class="emphasis"><em>keywords, description, title</em></span></p></td>
159
- <td align="left" valign="top"><p>html4, xhtml11</p></td>
160
- <td align="left" valign="top"><p>The <span class="emphasis"><em>keywords</em></span> and <span class="emphasis"><em>description</em></span> attributes set the correspondingly
161
- named HTML meta tag contents; the <span class="emphasis"><em>title</em></span> attribute sets the HTML
162
- title tag contents. Their principle use is for SEO (Search Engine
163
- Optimisation). All three are optional, but if they are used they must
164
- appear in the document header (or on the command-line). If <span class="emphasis"><em>title</em></span> is
165
- not specified the AsciiDoc document title is used.</p></td>
166
- </tr>
167
- <tr>
168
- <td align="left" valign="top"><p><span class="emphasis"><em>linkcss</em></span></p></td>
169
- <td align="left" valign="top"><p>xhtml11</p></td>
170
- <td align="left" valign="top"><p>Link CSS stylesheets and JavaScripts (see the <span class="emphasis"><em>stylesdir</em></span> and
171
- <span class="emphasis"><em>scriptsdir</em></span> attributes below). By default <span class="emphasis"><em>linkcss</em></span> is undefined in
172
- which case stylesheets and scripts are automatically embedded in the
173
- output document.</p></td>
174
- </tr>
175
- <tr>
176
- <td align="left" valign="top"><p><span class="emphasis"><em>max-width</em></span></p></td>
177
- <td align="left" valign="top"><p>xhtml11</p></td>
178
- <td align="left" valign="top"><p>Set the document maximum display width (sets the <span class="emphasis"><em>body</em></span> element CSS
179
- <span class="emphasis"><em>max-width</em></span> property).</p></td>
180
- </tr>
181
- <tr>
182
- <td align="left" valign="top"><p><span class="emphasis"><em>numbered</em></span></p></td>
183
- <td align="left" valign="top"><p>html4, xhtml11, docbook (XSL Stylesheets)</p></td>
184
- <td align="left" valign="top"><p>Adds section numbers to section titles. The <span class="emphasis"><em>docbook</em></span> backend ignores
185
- <span class="emphasis"><em>numbered</em></span> attribute entries after the document header.</p></td>
186
- </tr>
187
- <tr>
188
- <td align="left" valign="top"><p><span class="emphasis"><em>plaintext</em></span></p></td>
189
- <td align="left" valign="top"><p>All backends</p></td>
190
- <td align="left" valign="top"><p>If this global attribute is defined all inline substitutions are
191
- suppressed and block indents are retained. This option is useful when
192
- dealing with large amounts of imported plain text.</p></td>
193
- </tr>
194
- <tr>
195
- <td align="left" valign="top"><p><span class="emphasis"><em>quirks</em></span></p></td>
196
- <td align="left" valign="top"><p>xhtml11</p></td>
197
- <td align="left" valign="top"><p>Include the <code class="literal">xhtml11-quirks.css</code> <a class="link" href="asciidoc_backends.html#X35" title="XHTML Stylesheets">stylesheet</a> to work around IE6
198
- browser incompatibilities.</p></td>
199
- </tr>
200
- <tr>
201
- <td align="left" valign="top"><p><span class="emphasis"><em>revremark</em></span></p></td>
202
- <td align="left" valign="top"><p>docbook</p></td>
203
- <td align="left" valign="top"><p>A short summary of changes in this document revision. Must be defined
204
- prior to the first document section. The document also needs to be
205
- dated to output this attribute.</p></td>
206
- </tr>
207
- <tr>
208
- <td align="left" valign="top"><p><span class="emphasis"><em>scriptsdir</em></span></p></td>
209
- <td align="left" valign="top"><p>xhtml11</p></td>
210
- <td align="left" valign="top"><p>The name of the directory containing linked JavaScripts. Defaults to
211
- <code class="literal">.</code> (the same directory as the linking document).</p></td>
212
- </tr>
213
- <tr>
214
- <td align="left" valign="top"><p><span class="emphasis"><em>sgml</em></span></p></td>
215
- <td align="left" valign="top"><p>docbook45</p></td>
216
- <td align="left" valign="top"><p>The <code class="literal">--backend=docbook45</code> command-line option produces DocBook 4.5
217
- XML. You can produce the older DocBook SGML format using the
218
- <code class="literal">--attribute sgml</code> command-line option.</p></td>
219
- </tr>
220
- <tr>
221
- <td align="left" valign="top"><p><span class="emphasis"><em>stylesdir</em></span></p></td>
222
- <td align="left" valign="top"><p>xhtml11</p></td>
223
- <td align="left" valign="top"><p>The name of the directory containing linked stylesheets. Defaults to
224
- <code class="literal">.</code> (the same directory as the linking document).</p></td>
225
- </tr>
226
- <tr>
227
- <td align="left" valign="top"><p><span class="emphasis"><em>stylesheet</em></span></p></td>
228
- <td align="left" valign="top"><p>xhtml11</p></td>
229
- <td align="left" valign="top"><p>The file name of an optional additional CSS stylesheet. If you are
230
- embedding the stylesheet specify the actual file location; if you are
231
- linking CSS specify the file name relative to the directory specified
232
- by the <span class="emphasis"><em>stylesdir</em></span> attribute.</p></td>
233
- </tr>
234
- <tr>
235
- <td align="left" valign="top"><p><span class="emphasis"><em>theme</em></span></p></td>
236
- <td align="left" valign="top"><p>xhtml11</p></td>
237
- <td align="left" valign="top"><p>Use alternative stylesheets (see <a class="link" href="asciidoc_backends.html#X35" title="XHTML Stylesheets">Stylesheets</a>).</p></td>
238
- </tr>
239
- <tr>
240
- <td align="left" valign="top"><p><span class="emphasis"><em><a id="X91"></a>toc</em></span></p></td>
241
- <td align="left" valign="top"><p>xhtml11, docbook (XSL Stylesheets)</p></td>
242
- <td align="left" valign="top">
243
- <p>Adds a table of contents to the start of an article or book document.
244
- The <code class="literal">toc</code> attribute can be specified using the <code class="literal">--attribute toc</code>
245
- command-line option or a <code class="literal">:toc:</code> attribute entry in the document
246
- header. The <span class="emphasis"><em>toc</em></span> attribute is defined by default when the <span class="emphasis"><em>docbook</em></span>
247
- backend is used. To disable table of contents generation undefine the
248
- <span class="emphasis"><em>toc</em></span> attribute by putting a <code class="literal">:toc!:</code> attribute entry in the document
249
- header or from the command-line with an <code class="literal">--attribute toc!</code> option.</p>
250
- <p><span class="strong"><strong>xhtml11 backend</strong></span></p>
251
- <div class="itemizedlist"><ul type="disc">
252
- <li>
253
- JavaScript needs to be enabled in your browser.
254
- </li>
255
- <li>
256
- <p>
257
- The following example generates a numbered table of contents using a
258
- JavaScript embedded in the <code class="literal">mydoc.html</code> output document (to link the
259
- script to the output document use the <span class="emphasis"><em>linkcss</em></span> and <span class="emphasis"><em>scriptsdir</em></span>
260
- attributes):
261
- </p>
262
- <pre class="literallayout">$ asciidoc -a toc -a numbered mydoc.txt</pre>
263
- </li>
264
- </ul></div>
265
- </td>
266
- </tr>
267
- <tr>
268
- <td align="left" valign="top"><p><span class="emphasis"><em>toc-title</em></span></p></td>
269
- <td align="left" valign="top"><p>xhtml11</p></td>
270
- <td align="left" valign="top"><p>Sets the table of contents title (defaults to <span class="emphasis"><em>Table of Contents</em></span>).</p></td>
271
- </tr>
272
- <tr>
273
- <td align="left" valign="top"><p><span class="emphasis"><em>toclevels</em></span></p></td>
274
- <td align="left" valign="top"><p>xhtml11</p></td>
275
- <td align="left" valign="top">
276
- <p>Sets the number of title levels (1..4) reported in the table of
277
- contents (see the <span class="emphasis"><em>toc</em></span> attribute above). Defaults to 2 and must be
278
- used with the <span class="emphasis"><em>toc</em></span> attribute. Example usage:</p>
279
- <pre class="literallayout">$ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt</pre>
280
- </td>
281
- </tr>
282
- </tbody>
283
- </table></div>
284
- </div>
285
-
286
- </div>
287
-
288
- <hr/>
289
-
290
- <div class="nav" id="navfooter">
291
- <table width="100%">
292
- <tr><td width="33%" align="left">
293
-
294
- <a href="g_diagnostics.html">Prev</a><br/>
295
- G. Diagnostics
296
-
297
- </td><td width="33%" align="center">
298
-
299
- <a href="index.html">Home</a><br/>
300
- AsciiDoc User Guide
301
-
302
- </td><td width="33%" align="right">
303
-
304
- </td></tr>
305
- </table>
306
- </div>
307
- </body>
308
- </html>