FooBarWidget-mizuho 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (175) hide show
  1. data/LICENSE.txt +20 -0
  2. data/README.markdown +68 -0
  3. data/Rakefile +9 -0
  4. data/asciidoc/BUGS +34 -0
  5. data/asciidoc/BUGS.txt +28 -0
  6. data/asciidoc/CHANGELOG +1585 -0
  7. data/asciidoc/CHANGELOG.txt +1595 -0
  8. data/asciidoc/COPYING +339 -0
  9. data/asciidoc/COPYRIGHT +18 -0
  10. data/asciidoc/INSTALL +82 -0
  11. data/asciidoc/INSTALL.txt +71 -0
  12. data/asciidoc/README +46 -0
  13. data/asciidoc/README.txt +36 -0
  14. data/asciidoc/a2x +641 -0
  15. data/asciidoc/asciidoc.conf +404 -0
  16. data/asciidoc/asciidoc.py +4255 -0
  17. data/asciidoc/common.aap +9 -0
  18. data/asciidoc/dblatex/asciidoc-dblatex.sty +18 -0
  19. data/asciidoc/dblatex/asciidoc-dblatex.xsl +17 -0
  20. data/asciidoc/dblatex/dblatex-readme.txt +22 -0
  21. data/asciidoc/doc/a2x.1 +246 -0
  22. data/asciidoc/doc/a2x.1.txt +195 -0
  23. data/asciidoc/doc/article.css-embedded.html +579 -0
  24. data/asciidoc/doc/article.html +62 -0
  25. data/asciidoc/doc/article.pdf +0 -0
  26. data/asciidoc/doc/article.txt +124 -0
  27. data/asciidoc/doc/asciidoc-revhistory.xml +27 -0
  28. data/asciidoc/doc/asciidoc.1 +161 -0
  29. data/asciidoc/doc/asciidoc.1.css-embedded.html +562 -0
  30. data/asciidoc/doc/asciidoc.1.css.html +212 -0
  31. data/asciidoc/doc/asciidoc.1.html +190 -0
  32. data/asciidoc/doc/asciidoc.1.txt +118 -0
  33. data/asciidoc/doc/asciidoc.conf +8 -0
  34. data/asciidoc/doc/asciidoc.css-embedded.html +7954 -0
  35. data/asciidoc/doc/asciidoc.css.html +7553 -0
  36. data/asciidoc/doc/asciidoc.dict +673 -0
  37. data/asciidoc/doc/asciidoc.html +3502 -0
  38. data/asciidoc/doc/asciidoc.txt +4757 -0
  39. data/asciidoc/doc/asciimath.txt +47 -0
  40. data/asciidoc/doc/book-multi.css-embedded.html +575 -0
  41. data/asciidoc/doc/book-multi.html +72 -0
  42. data/asciidoc/doc/book-multi.txt +159 -0
  43. data/asciidoc/doc/book.css-embedded.html +585 -0
  44. data/asciidoc/doc/book.html +60 -0
  45. data/asciidoc/doc/book.txt +133 -0
  46. data/asciidoc/doc/customers.csv +18 -0
  47. data/asciidoc/doc/faq.txt +262 -0
  48. data/asciidoc/doc/latex-backend.html +224 -0
  49. data/asciidoc/doc/latex-backend.txt +193 -0
  50. data/asciidoc/doc/latexmath.txt +35 -0
  51. data/asciidoc/doc/main.aap +293 -0
  52. data/asciidoc/doc/music-filter.html +513 -0
  53. data/asciidoc/doc/music-filter.pdf +0 -0
  54. data/asciidoc/doc/music-filter.txt +158 -0
  55. data/asciidoc/doc/source-highlight-filter.html +183 -0
  56. data/asciidoc/doc/source-highlight-filter.pdf +0 -0
  57. data/asciidoc/doc/source-highlight-filter.txt +174 -0
  58. data/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt +71 -0
  59. data/asciidoc/docbook-xsl/chunked.xsl +19 -0
  60. data/asciidoc/docbook-xsl/common.xsl +67 -0
  61. data/asciidoc/docbook-xsl/fo.xsl +117 -0
  62. data/asciidoc/docbook-xsl/htmlhelp.xsl +17 -0
  63. data/asciidoc/docbook-xsl/manpage.xsl +28 -0
  64. data/asciidoc/docbook-xsl/shaded-literallayout.patch +32 -0
  65. data/asciidoc/docbook-xsl/xhtml.xsl +14 -0
  66. data/asciidoc/docbook.conf +606 -0
  67. data/asciidoc/examples/website/CHANGELOG.html +3828 -0
  68. data/asciidoc/examples/website/INSTALL.html +163 -0
  69. data/asciidoc/examples/website/README-website.html +129 -0
  70. data/asciidoc/examples/website/README-website.txt +29 -0
  71. data/asciidoc/examples/website/README.html +125 -0
  72. data/asciidoc/examples/website/a2x.1.html +395 -0
  73. data/asciidoc/examples/website/asciidoc-docbook-xsl.html +165 -0
  74. data/asciidoc/examples/website/asciimath.html +157 -0
  75. data/asciidoc/examples/website/build-website.sh +25 -0
  76. data/asciidoc/examples/website/downloads.html +219 -0
  77. data/asciidoc/examples/website/downloads.txt +98 -0
  78. data/asciidoc/examples/website/faq.html +372 -0
  79. data/asciidoc/examples/website/index.html +398 -0
  80. data/asciidoc/examples/website/index.txt +222 -0
  81. data/asciidoc/examples/website/latex-backend.html +640 -0
  82. data/asciidoc/examples/website/latexmath.html +119 -0
  83. data/asciidoc/examples/website/layout1.conf +161 -0
  84. data/asciidoc/examples/website/layout1.css +65 -0
  85. data/asciidoc/examples/website/layout2.conf +158 -0
  86. data/asciidoc/examples/website/layout2.css +93 -0
  87. data/asciidoc/examples/website/manpage.html +266 -0
  88. data/asciidoc/examples/website/music-filter.html +242 -0
  89. data/asciidoc/examples/website/music1.abc +12 -0
  90. data/asciidoc/examples/website/music1.png +0 -0
  91. data/asciidoc/examples/website/music2.ly +9 -0
  92. data/asciidoc/examples/website/music2.png +0 -0
  93. data/asciidoc/examples/website/source-highlight-filter.html +251 -0
  94. data/asciidoc/examples/website/support.html +78 -0
  95. data/asciidoc/examples/website/support.txt +5 -0
  96. data/asciidoc/examples/website/userguide.html +7597 -0
  97. data/asciidoc/examples/website/version9.html +143 -0
  98. data/asciidoc/examples/website/version9.txt +48 -0
  99. data/asciidoc/filters/code-filter-readme.txt +37 -0
  100. data/asciidoc/filters/code-filter-test-c++.txt +7 -0
  101. data/asciidoc/filters/code-filter-test.txt +15 -0
  102. data/asciidoc/filters/code-filter.conf +8 -0
  103. data/asciidoc/filters/code-filter.py +239 -0
  104. data/asciidoc/filters/music-filter-test.txt +40 -0
  105. data/asciidoc/filters/music-filter.conf +40 -0
  106. data/asciidoc/filters/music2png.py +189 -0
  107. data/asciidoc/filters/source-highlight-filter-test.txt +19 -0
  108. data/asciidoc/filters/source-highlight-filter.conf +100 -0
  109. data/asciidoc/help.conf +213 -0
  110. data/asciidoc/html4.conf +363 -0
  111. data/asciidoc/images/highlighter.png +0 -0
  112. data/asciidoc/images/icons/README +5 -0
  113. data/asciidoc/images/icons/callouts/1.png +0 -0
  114. data/asciidoc/images/icons/callouts/10.png +0 -0
  115. data/asciidoc/images/icons/callouts/11.png +0 -0
  116. data/asciidoc/images/icons/callouts/12.png +0 -0
  117. data/asciidoc/images/icons/callouts/13.png +0 -0
  118. data/asciidoc/images/icons/callouts/14.png +0 -0
  119. data/asciidoc/images/icons/callouts/15.png +0 -0
  120. data/asciidoc/images/icons/callouts/2.png +0 -0
  121. data/asciidoc/images/icons/callouts/3.png +0 -0
  122. data/asciidoc/images/icons/callouts/4.png +0 -0
  123. data/asciidoc/images/icons/callouts/5.png +0 -0
  124. data/asciidoc/images/icons/callouts/6.png +0 -0
  125. data/asciidoc/images/icons/callouts/7.png +0 -0
  126. data/asciidoc/images/icons/callouts/8.png +0 -0
  127. data/asciidoc/images/icons/callouts/9.png +0 -0
  128. data/asciidoc/images/icons/caution.png +0 -0
  129. data/asciidoc/images/icons/example.png +0 -0
  130. data/asciidoc/images/icons/home.png +0 -0
  131. data/asciidoc/images/icons/important.png +0 -0
  132. data/asciidoc/images/icons/next.png +0 -0
  133. data/asciidoc/images/icons/note.png +0 -0
  134. data/asciidoc/images/icons/prev.png +0 -0
  135. data/asciidoc/images/icons/tip.png +0 -0
  136. data/asciidoc/images/icons/up.png +0 -0
  137. data/asciidoc/images/icons/warning.png +0 -0
  138. data/asciidoc/images/smallnew.png +0 -0
  139. data/asciidoc/images/tiger.png +0 -0
  140. data/asciidoc/install.sh +55 -0
  141. data/asciidoc/javascripts/ASCIIMathML.js +938 -0
  142. data/asciidoc/javascripts/LaTeXMathML.js +1223 -0
  143. data/asciidoc/javascripts/toc.js +69 -0
  144. data/asciidoc/lang-es.conf +15 -0
  145. data/asciidoc/latex.conf +663 -0
  146. data/asciidoc/linuxdoc.conf +285 -0
  147. data/asciidoc/math.conf +50 -0
  148. data/asciidoc/stylesheets/docbook-xsl.css +271 -0
  149. data/asciidoc/stylesheets/xhtml-deprecated-manpage.css +21 -0
  150. data/asciidoc/stylesheets/xhtml-deprecated.css +247 -0
  151. data/asciidoc/stylesheets/xhtml11-manpage.css +18 -0
  152. data/asciidoc/stylesheets/xhtml11-quirks.css +49 -0
  153. data/asciidoc/stylesheets/xhtml11.css +284 -0
  154. data/asciidoc/t.conf +20 -0
  155. data/asciidoc/text.conf +16 -0
  156. data/asciidoc/vim/ftdetect/asciidoc_filetype.vim +53 -0
  157. data/asciidoc/vim/syntax/asciidoc.vim +139 -0
  158. data/asciidoc/xhtml-deprecated-css.conf +235 -0
  159. data/asciidoc/xhtml-deprecated.conf +351 -0
  160. data/asciidoc/xhtml11-quirks.conf +57 -0
  161. data/asciidoc/xhtml11.conf +514 -0
  162. data/bin/mizuho +40 -0
  163. data/lib/mizuho/chapter.rb +54 -0
  164. data/lib/mizuho/generator.rb +106 -0
  165. data/lib/mizuho/heading.rb +46 -0
  166. data/lib/mizuho/parser.rb +99 -0
  167. data/lib/mizuho/template.rb +50 -0
  168. data/mizuho.gemspec +34 -0
  169. data/templates/asciidoc.css +358 -0
  170. data/templates/asciidoc.html.erb +86 -0
  171. data/templates/manualsonrails.css +165 -0
  172. data/templates/manualsonrails.html.erb +97 -0
  173. data/test/parser_spec.rb +190 -0
  174. data/test/spec_helper.rb +43 -0
  175. metadata +234 -0
@@ -0,0 +1,395 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6
+ <meta name="generator" content="AsciiDoc 8.2.7" />
7
+ <link rel="stylesheet" href="./xhtml11.css" type="text/css" />
8
+ <link rel="stylesheet" href="./xhtml11-manpage.css" type="text/css" />
9
+ <link rel="stylesheet" href="./xhtml11-quirks.css" type="text/css" />
10
+ <link rel="stylesheet" href="./layout1.css" type="text/css" />
11
+ <script type="text/javascript">
12
+ /*<![CDATA[*/
13
+ window.onload = function(){generateToc(1)}
14
+ /*]]>*/
15
+ </script>
16
+ <script type="text/javascript" src="./toc.js"></script>
17
+ <title>A2X(1)</title>
18
+ </head>
19
+ <body>
20
+ <div id="layout-banner">
21
+ <div id="layout-title">AsciiDoc</div>
22
+ <div id="layout-description">Text based document generation</div>
23
+ </div>
24
+ <table>
25
+ <tr valign="top">
26
+ <td id="layout-menu">
27
+ <div>&#187;<a href="index.html">Home</a></div>
28
+ <div>&#187;<a href="manpage.html">Man&nbsp;Page</a></div>
29
+ <div>&#187;<a href="userguide.html">User&nbsp;Guide</a></div>
30
+ <div>&#187;<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
31
+ <div>&#187;<a href="a2x.1.html">a2x</a></div>
32
+ <div>&#187;<a href="README.html">README</a></div>
33
+ <div>&#187;<a href="CHANGELOG.html">ChangeLog</a></div>
34
+ <div>&#187;<a href="INSTALL.html">Installation</a></div>
35
+ <div>&#187;<a href="downloads.html">Downloads</a></div>
36
+ <div>&#187;<a href="faq.html">FAQ</a></div>
37
+ <div>&#187;<a href="support.html">Support</a></div>
38
+ <div id="page-source">&#187;<a href="a2x.1.txt">Page&nbsp;Source</a></div>
39
+ </td>
40
+ <td>
41
+ <div id="layout-content">
42
+ <div id="header">
43
+ <h1>
44
+ A2X(1) Manual Page
45
+ </h1>
46
+ <div id="toc">
47
+ <div id="toctitle">Table of Contents</div>
48
+ <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
49
+ </div>
50
+ <h2>NAME</h2>
51
+ <div class="sectionbody">
52
+ <p>a2x -
53
+ convert Asciidoc text file to PDF, XHTML, HTML Help, manpage or plain text
54
+ </p>
55
+ </div>
56
+ </div>
57
+ <h2>SYNOPSIS</h2>
58
+ <div class="sectionbody">
59
+ <div class="para"><p><strong>a2x</strong> [<em>OPTIONS</em>] <em>FILE</em></p></div>
60
+ </div>
61
+ <h2 id="_description">DESCRIPTION</h2>
62
+ <div class="sectionbody">
63
+ <div class="para"><p>A DocBook toolchain wrapper script that translates an <em>AsciiDoc</em> text
64
+ file <em>FILE</em> to PDF, DVI, PS, LaTeX, XHTML (single page or chunked),
65
+ man page, HTML Help or plain text formats. PDF, XHTML, man page and
66
+ HTML Help formats are are generated using the <tt>asciidoc(1)</tt>,
67
+ xsltproc(1), DocBook XSL Stylesheets, dblatex (or FOP) toolchain.
68
+ Plain text is produced by passing <tt>asciidoc(1)</tt> generated HTML through
69
+ lynx(1). The htmlhelp format option generates .hhp, .hhc and .html
70
+ files suitable for compilation to an HTML Help .chm file.</p></div>
71
+ </div>
72
+ <h2 id="_options">OPTIONS</h2>
73
+ <div class="sectionbody">
74
+ <div class="vlist"><dl>
75
+ <dt>
76
+ <strong>-a, --attribute</strong>=<em>ATTRIBUTE</em>
77
+ </dt>
78
+ <dd>
79
+ <p>
80
+ Set <tt>asciidoc(1)</tt> attribute value (shortcut for <strong>--asciidoc-opts</strong>=<em>"-a
81
+ ATTRIBUTE"</em> option). This option may be specified more than once.
82
+ </p>
83
+ </dd>
84
+ <dt>
85
+ <strong>--asciidoc-opts</strong>=<em>ASCIIDOC_OPTS</em>
86
+ </dt>
87
+ <dd>
88
+ <p>
89
+ Additional <tt>asciidoc(1)</tt> options. This option may be specified more
90
+ than once.
91
+ </p>
92
+ </dd>
93
+ <dt>
94
+ <strong>--copy</strong>
95
+ </dt>
96
+ <dd>
97
+ <p>
98
+ Copy distributed docbook-xsl CSS stylesheet admonition and
99
+ navigation icons to their respective destinations. Applies to
100
+ <em>xhtml</em>, <em>chunked</em>, <em>htmlhelp</em> formats. The default behavior is to
101
+ suppress copying.
102
+ </p>
103
+ </dd>
104
+ <dt>
105
+ <strong>-D, --destination-dir</strong>=<em>PATH</em>
106
+ </dt>
107
+ <dd>
108
+ <p>
109
+ Output directory. Defaults to source <em>FILE</em> directory.
110
+ </p>
111
+ </dd>
112
+ <dt>
113
+ <strong>-d, --doctype</strong>=<em>DOCTYPE</em>
114
+ </dt>
115
+ <dd>
116
+ <p>
117
+ DocBook document type: <em>article</em>, <em>manpage</em> or <em>book</em>. Default
118
+ document type is <em>article</em> unless the format is <em>manpage</em> (in which
119
+ case it defaults to <em>manpage</em>).
120
+ </p>
121
+ </dd>
122
+ <dt>
123
+ <strong>-f, --format</strong>=<em>FORMAT</em>
124
+ </dt>
125
+ <dd>
126
+ <p>
127
+ Output format: <em>chunked</em>, <em>dvi</em>, <em>htmlhelp</em>, <em>manpage</em>, <em>pdf</em>, <em>ps</em>,
128
+ <em>tex</em>, <em>text</em> or <em>xhtml</em>.
129
+ </p>
130
+ </dd>
131
+ <dt>
132
+ <strong>-h, --help</strong>
133
+ </dt>
134
+ <dd>
135
+ <p>
136
+ Print command-line syntax and program options to stdout.
137
+ </p>
138
+ </dd>
139
+ <dt>
140
+ <strong>--icons</strong>
141
+ </dt>
142
+ <dd>
143
+ <p>
144
+ Use admonition or navigation icon images in output documents. The
145
+ default behavior is to use text in place of icons.
146
+ </p>
147
+ </dd>
148
+ <dt>
149
+ <strong>--icons-dir</strong>=<em>PATH</em>
150
+ </dt>
151
+ <dd>
152
+ <p>
153
+ A path (relative to destination HTML files) containing admonition
154
+ and navigation icons. Defaults to <em>./images/icons/</em>.
155
+ Applies to <em>xhtml</em>, <em>chunked</em>, <em>htmlhelp</em> formats.
156
+ </p>
157
+ </dd>
158
+ <dt>
159
+ <strong>-n, --dry-run</strong>
160
+ </dt>
161
+ <dd>
162
+ <p>
163
+ Don't do anything just print what would have been done.
164
+ </p>
165
+ </dd>
166
+ <dt>
167
+ <strong>-s, --skip-asciidoc</strong>
168
+ </dt>
169
+ <dd>
170
+ <p>
171
+ Skip asciidoc execution. This is useful for converting DocBook XML
172
+ files not derived from <em>AsciiDoc</em> sources. Ignored if --format*=<em>text</em>.
173
+ </p>
174
+ </dd>
175
+ <dt>
176
+ <strong>--stylesheet</strong>=<em>PATH</em>
177
+ </dt>
178
+ <dd>
179
+ <p>
180
+ A path (relative to destination HTML files) specifying the
181
+ docbook-xsl CSS stylesheet file. Defaults to <em>./docbook-xsl.css</em>.
182
+ Applies to <em>xhtml</em>, <em>chunked</em>, <em>htmlhelp</em> formats.
183
+ </p>
184
+ </dd>
185
+ <dt>
186
+ <strong>-v, --verbose</strong>
187
+ </dt>
188
+ <dd>
189
+ <p>
190
+ Print operational details to stderr.
191
+ A second <strong>-v</strong> option applies the verbose option to toolchain commands.
192
+ </p>
193
+ </dd>
194
+ <dt>
195
+ <strong>--version</strong>
196
+ </dt>
197
+ <dd>
198
+ <p>
199
+ Print program version to stdout.
200
+ </p>
201
+ </dd>
202
+ <dt>
203
+ <strong>--xsltproc-opts</strong>=<em>XSLTPROC_OPTS</em>
204
+ </dt>
205
+ <dd>
206
+ <p>
207
+ Additional xsltproc(1) options. This option may be specified more
208
+ than once.
209
+ </p>
210
+ </dd>
211
+ <dt>
212
+ <strong>--fop-opts</strong>=<em>FOP_OPTS</em>
213
+ </dt>
214
+ <dd>
215
+ <p>
216
+ Additional fop options. This option may be specified more than
217
+ once. If this option is specified fop is used to generate PDFs.
218
+ </p>
219
+ </dd>
220
+ <dt>
221
+ <strong>--dblatex-opts</strong>=<em>DBLATEX_OPTS</em>
222
+ </dt>
223
+ <dd>
224
+ <p>
225
+ Additional dblatex options. This option may be specified more than once.
226
+ </p>
227
+ </dd>
228
+ </dl></div>
229
+ </div>
230
+ <h2 id="_output_files">OUTPUT FILES</h2>
231
+ <div class="sectionbody">
232
+ <div class="para"><p>Output files are written to the directory specified by the
233
+ <strong>--destination-dir</strong> option. If no <strong>--destination-dir</strong> option is set
234
+ output files are written to the source FILE directory.</p></div>
235
+ <div class="para"><p>Output files have the same name as the source <em>FILE</em> but with an
236
+ appropriate file name extension: .html for <em>xhtml</em>; .hhp for
237
+ <em>htmlhelp</em>; .pdf for <em>pdf</em>; .text for <em>text</em>. By convention manpages
238
+ have no .man extension (man page section number only). Chunked HTML
239
+ directory names have a .chunked extension; chunked HTML Help directory
240
+ names have a .htmlhelp extension.</p></div>
241
+ <div class="para"><p>Same named existing files are overwritten.</p></div>
242
+ <div class="para"><p>Intermediate output files are written to the source <em>FILE</em> directory
243
+ and are not automatically deleted.</p></div>
244
+ <div class="para"><p>Intermediate DocBook XML files generated by <em>AsciiDoc</em> are only
245
+ regenerated if out of date with respect to the <em>AsciiDoc</em> source <em>FILE</em>.</p></div>
246
+ <div class="para"><p>In addition to generating HTML files the <em>xhtml</em>, <em>chunked</em> and
247
+ <em>htmlhelp</em> formats copy the DocBook XSL stylesheet plus admonition and
248
+ navigation icons distributed with <em>AsciiDoc</em> to their respective
249
+ destination locations. Existing stylesheets and icons are only copied
250
+ if they are newer than the destination files or if the destination
251
+ files are missing.</p></div>
252
+ <div class="para"><p>The <em>xhtml</em> format generates a single XHTML output page. The
253
+ <em>chunked</em> format writes multiple per-section HTML pages to a chunked
254
+ directory in the destination directory. The chunked directory has the
255
+ same name as the source <em>FILE</em> name plus a .chunked extension.</p></div>
256
+ </div>
257
+ <h2 id="_examples">EXAMPLES</h2>
258
+ <div class="sectionbody">
259
+ <div class="vlist"><dl>
260
+ <dt>
261
+ <tt>a2x -f pdf doc/source-highlight-filter.txt</tt>
262
+ </dt>
263
+ <dd>
264
+ <p>
265
+ Generates doc/source-highlight-filter.pdf file.
266
+ </p>
267
+ </dd>
268
+ <dt>
269
+ <tt>a2x -f chunked -D ../webpages guide.txt</tt>
270
+ </dt>
271
+ <dd>
272
+ <p>
273
+ Creates chunked directory <tt>../webpages/guide.chunked</tt> containing
274
+ chunked HTML files. Also copies <tt>docbook-xsl.css</tt> stylesheet to the
275
+ <tt>../webpages/guide.chunked</tt> directory plus admonition and navigation
276
+ icons to the <tt>../webpages/guide.chunked/images/icons</tt> directory.
277
+ </p>
278
+ </dd>
279
+ </dl></div>
280
+ </div>
281
+ <h2 id="_requisites">REQUISITES</h2>
282
+ <div class="sectionbody">
283
+ <div class="para"><p>This script runs under the bash(1) shell and requires the following
284
+ programs (which may or may not be prepackaged with your Linux
285
+ distribution):</p></div>
286
+ <div class="vlist"><dl>
287
+ <dt>
288
+ Asciidoc
289
+ </dt>
290
+ <dd>
291
+ <p>
292
+ <a href="http://www.methods.co.nz/asciidoc/">http://www.methods.co.nz/asciidoc/</a>
293
+ </p>
294
+ </dd>
295
+ <dt>
296
+ xsltproc
297
+ </dt>
298
+ <dd>
299
+ <p>
300
+ <a href="http://xmlsoft.org/XSLT/">http://xmlsoft.org/XSLT/</a>
301
+ </p>
302
+ </dd>
303
+ <dt>
304
+ DocBook XSL Stylesheets
305
+ </dt>
306
+ <dd>
307
+ <p>
308
+ <a href="http://docbook.sourceforge.net/projects/xsl/">http://docbook.sourceforge.net/projects/xsl/</a>
309
+ </p>
310
+ </dd>
311
+ <dt>
312
+ dblatex (for PDF, DVI, PostScript and LaTeX file generation)
313
+ </dt>
314
+ <dd>
315
+ <p>
316
+ <a href="http://dblatex.sourceforge.net/">http://dblatex.sourceforge.net/</a>
317
+ </p>
318
+ </dd>
319
+ <dt>
320
+ FOP (alternative PDF file generation)
321
+ </dt>
322
+ <dd>
323
+ <p>
324
+ <a href="http://xmlgraphics.apache.org/fop/">http://xmlgraphics.apache.org/fop/</a>
325
+ </p>
326
+ </dd>
327
+ <dt>
328
+ Lynx (for text file generation)
329
+ </dt>
330
+ <dd>
331
+ <p>
332
+ <a href="http://lynx.isc.org/">http://lynx.isc.org/</a>
333
+ </p>
334
+ </dd>
335
+ </dl></div>
336
+ <div class="para"><p>See also the latest README file.</p></div>
337
+ </div>
338
+ <h2 id="_bugs">BUGS</h2>
339
+ <div class="sectionbody">
340
+ <div class="ilist"><ul>
341
+ <li>
342
+ <p>
343
+ The odt output format is undocumented and experimental.
344
+ </p>
345
+ </li>
346
+ <li>
347
+ <p>
348
+ See also the <em>AsciiDoc</em> distribution BUGS file.
349
+ </p>
350
+ </li>
351
+ </ul></div>
352
+ </div>
353
+ <h2 id="_author">AUTHOR</h2>
354
+ <div class="sectionbody">
355
+ <div class="para"><p>Written by Stuart Rackham, &lt;<a href="mailto:srackham@gmail.com">srackham@gmail.com</a>&gt;</p></div>
356
+ </div>
357
+ <h2 id="_resources">RESOURCES</h2>
358
+ <div class="sectionbody">
359
+ <div class="para"><p>SourceForge: <a href="http://sourceforge.net/projects/asciidoc/">http://sourceforge.net/projects/asciidoc/</a></p></div>
360
+ <div class="para"><p>Main web site: <a href="http://www.methods.co.nz/asciidoc/">http://www.methods.co.nz/asciidoc/</a></p></div>
361
+ </div>
362
+ <h2 id="_copying">COPYING</h2>
363
+ <div class="sectionbody">
364
+ <div class="para"><p>Copyright (C) 2002-2008 Stuart Rackham. Free use of this software is
365
+ granted under the terms of the GNU General Public License (GPL).</p></div>
366
+ </div>
367
+ <div id="footer">
368
+ <div id="footer-text">
369
+ Version 8.2.7<br />
370
+ Last updated 2008-07-04 23:48:05 NZDT
371
+ </div>
372
+ <div id="footer-badges">
373
+ <a href="http://validator.w3.org/check?uri=referer">
374
+ <img style="border:none; width:88px; height:31px;"
375
+ src="http://www.w3.org/Icons/valid-xhtml11"
376
+ alt="Valid XHTML 1.1!" />
377
+ </a>
378
+ <a href="http://jigsaw.w3.org/css-validator/check/referer">
379
+ <img style="border:none; width:88px; height:31px;"
380
+ src="http://jigsaw.w3.org/css-validator/images/vcss"
381
+ alt="Valid CSS!" />
382
+ </a>
383
+ <a href="http://www.mozilla.org/products/firefox/">
384
+ <img style="border:none; width:110px; height:32px;"
385
+ src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif"
386
+ alt="Get Firefox!" />
387
+ </a>
388
+ </div>
389
+ </div>
390
+ </div>
391
+ </td>
392
+ </tr>
393
+ </table>
394
+ </body>
395
+ </html>
@@ -0,0 +1,165 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6
+ <meta name="generator" content="AsciiDoc 8.2.7" />
7
+ <link rel="stylesheet" href="./xhtml11.css" type="text/css" />
8
+ <link rel="stylesheet" href="./xhtml11-quirks.css" type="text/css" />
9
+ <link rel="stylesheet" href="./layout1.css" type="text/css" />
10
+ <title>AsciiDoc DocBook XSL Stylesheets Notes</title>
11
+ </head>
12
+ <body>
13
+ <div id="layout-banner">
14
+ <div id="layout-title">AsciiDoc</div>
15
+ <div id="layout-description">Text based document generation</div>
16
+ </div>
17
+ <table>
18
+ <tr valign="top">
19
+ <td id="layout-menu">
20
+ <div>&#187;<a href="index.html">Home</a></div>
21
+ <div>&#187;<a href="manpage.html">Man&nbsp;Page</a></div>
22
+ <div>&#187;<a href="userguide.html">User&nbsp;Guide</a></div>
23
+ <div>&#187;<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
24
+ <div>&#187;<a href="a2x.1.html">a2x</a></div>
25
+ <div>&#187;<a href="README.html">README</a></div>
26
+ <div>&#187;<a href="CHANGELOG.html">ChangeLog</a></div>
27
+ <div>&#187;<a href="INSTALL.html">Installation</a></div>
28
+ <div>&#187;<a href="downloads.html">Downloads</a></div>
29
+ <div>&#187;<a href="faq.html">FAQ</a></div>
30
+ <div>&#187;<a href="support.html">Support</a></div>
31
+ <div id="page-source">&#187;<a href="asciidoc-docbook-xsl.txt">Page&nbsp;Source</a></div>
32
+ </td>
33
+ <td>
34
+ <div id="layout-content">
35
+ <div id="header">
36
+ <h1>AsciiDoc DocBook XSL Stylesheets Notes</h1>
37
+ </div>
38
+ <div id="preamble">
39
+ <div class="sectionbody">
40
+ <div class="para"><p>PDF generation from <em>AsciiDoc</em> generated DocBook using FOP plus DocBook XSL
41
+ Stylesheets.</p></div>
42
+ <div class="ilist"><ul>
43
+ <li>
44
+ <p>
45
+ FOP 0.95beta.
46
+ </p>
47
+ </li>
48
+ <li>
49
+ <p>
50
+ DocBook XSL Stylesheets version 1.72.0.
51
+ </p>
52
+ </li>
53
+ </ul></div>
54
+ <div class="para"><p>Output file customisation is achieved by tweaking the DocBook XSL
55
+ stylesheets. I've tried to keep customization to a minimum and
56
+ confine it to the separate XSL driver files in the distribution
57
+ <tt>./docbook-xsl/</tt> directory (see the User Guide for details).</p></div>
58
+ <div class="para"><p>To polish some rough edges I've written some patches for the DocBook
59
+ XSL stylesheets &#8212; you don't need them but they're documented below
60
+ and included in the distribution <tt>./docbook-xsl/</tt> directory.</p></div>
61
+ </div>
62
+ </div>
63
+ <h2 id="_manually_upgrading_debian_to_the_latest_docbook_xsl_stylesheets">Manually upgrading Debian to the latest DocBook XSL stylesheets</h2>
64
+ <div class="sectionbody">
65
+ <div class="para"><p>The DocBook XSL Stylesheets distribution is just a directory full of
66
+ text files and you can switch between releases by changing the
67
+ directory name in the system XML catalog.</p></div>
68
+ <div class="para"><p>To upgrade to the latest docbook-xsl stylesheets without having to
69
+ wait for the Debian <tt>docbook-xsl</tt> package:</p></div>
70
+ <div class="ilist"><ul>
71
+ <li>
72
+ <p>
73
+ Download the latest docbook-xsl tarball from
74
+ <a href="http://sourceforge.net/projects/docbook/">http://sourceforge.net/projects/docbook/</a>.
75
+ </p>
76
+ </li>
77
+ <li>
78
+ <p>
79
+ Unzip the tarball to <tt>/usr/share/xml/docbook/stylesheet/</tt>:
80
+ </p>
81
+ <div class="literalblock">
82
+ <div class="content">
83
+ <pre><tt>$ cd /usr/share/xml/docbook/stylesheet
84
+ $ sudo tar -xzf /tmp/docbook-xsl-1.72.0.tar.gz</tt></pre>
85
+ </div></div>
86
+ </li>
87
+ <li>
88
+ <p>
89
+ Edit <tt>/etc/xml/docbook-xsl.xml</tt> catalog and replace occurences of
90
+ the current stylesheets directory with the new one (in our example
91
+ it would be <tt>/usr/share/xml/docbook/stylesheet/docbook-xsl-1.72.0</tt>.
92
+ </p>
93
+ <div class="literalblock">
94
+ <div class="content">
95
+ <pre><tt>$ cd /etc/xml/
96
+ $ sudo cp -p docbook-xsl.xml docbook-xsl.xml.ORIG
97
+ $ sudo vi docbook-xsl.xml</tt></pre>
98
+ </div></div>
99
+ </li>
100
+ <li>
101
+ <p>
102
+ Apply optional patches (see below).
103
+ </p>
104
+ </li>
105
+ </ul></div>
106
+ </div>
107
+ <h2 id="_patches_to_docbook_xsl_stylesheets">Patches to DocBook XSL Stylesheets</h2>
108
+ <div class="sectionbody">
109
+ <div class="admonitionblock">
110
+ <table><tr>
111
+ <td class="icon">
112
+ <img src="./images/icons/note.png" alt="Note" />
113
+ </td>
114
+ <td class="content">You'll find the patch files in the <em>AsciiDoc</em> distribution archive
115
+ <tt>./docbook-xsl/</tt> directory.</td>
116
+ </tr></table>
117
+ </div>
118
+ <h3 id="_shade_literal_block_patch">Shade Literal Block Patch</h3><div style="clear:left"></div>
119
+ <div class="para"><p>The processing expectation for <em>AsciiDoc</em> LiteralBlocks and
120
+ LiteralParagraphs is that they are not shaded. The
121
+ <tt>shaded-literallayout.patch</tt> was devised to allow AciiDoc Listing
122
+ blocks to be shaded while leaving Literal paragraphs and Literal
123
+ blocks unshaded (the default DocBook XSL Stylesheets behavior is to
124
+ shade all verbatim elements).</p></div>
125
+ <div class="para"><p>The patch implements a <tt>shade.literallayout</tt> XSL parameter so that
126
+ shading in literal elements could be disabled while other verbatim
127
+ elements are left shaded (by setting the XSL <tt>shade.verbatim</tt>
128
+ parameter).</p></div>
129
+ <div class="para"><p>The relevant patch file is <tt>shaded-literallayout.patch</tt> and it can be
130
+ applied from the DocBook XSL Stylesheets directory:</p></div>
131
+ <div class="literalblock">
132
+ <div class="content">
133
+ <pre><tt>$ cd /usr/share/xml/docbook/stylesheet/docbook-xsl-1.72.0
134
+ $ sudo patch -p0 &lt; /tmp/shaded-literallayout.patch</tt></pre>
135
+ </div></div>
136
+ </div>
137
+ <div id="footer">
138
+ <div id="footer-text">
139
+ Version 8.2.7<br />
140
+ Last updated 2008-07-04 23:29:16 NZDT
141
+ </div>
142
+ <div id="footer-badges">
143
+ <a href="http://validator.w3.org/check?uri=referer">
144
+ <img style="border:none; width:88px; height:31px;"
145
+ src="http://www.w3.org/Icons/valid-xhtml11"
146
+ alt="Valid XHTML 1.1!" />
147
+ </a>
148
+ <a href="http://jigsaw.w3.org/css-validator/check/referer">
149
+ <img style="border:none; width:88px; height:31px;"
150
+ src="http://jigsaw.w3.org/css-validator/images/vcss"
151
+ alt="Valid CSS!" />
152
+ </a>
153
+ <a href="http://www.mozilla.org/products/firefox/">
154
+ <img style="border:none; width:110px; height:32px;"
155
+ src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif"
156
+ alt="Get Firefox!" />
157
+ </a>
158
+ </div>
159
+ </div>
160
+ </div>
161
+ </td>
162
+ </tr>
163
+ </table>
164
+ </body>
165
+ </html>