FooBarWidget-mizuho 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE.txt +20 -0
- data/README.markdown +68 -0
- data/Rakefile +9 -0
- data/asciidoc/BUGS +34 -0
- data/asciidoc/BUGS.txt +28 -0
- data/asciidoc/CHANGELOG +1585 -0
- data/asciidoc/CHANGELOG.txt +1595 -0
- data/asciidoc/COPYING +339 -0
- data/asciidoc/COPYRIGHT +18 -0
- data/asciidoc/INSTALL +82 -0
- data/asciidoc/INSTALL.txt +71 -0
- data/asciidoc/README +46 -0
- data/asciidoc/README.txt +36 -0
- data/asciidoc/a2x +641 -0
- data/asciidoc/asciidoc.conf +404 -0
- data/asciidoc/asciidoc.py +4255 -0
- data/asciidoc/common.aap +9 -0
- data/asciidoc/dblatex/asciidoc-dblatex.sty +18 -0
- data/asciidoc/dblatex/asciidoc-dblatex.xsl +17 -0
- data/asciidoc/dblatex/dblatex-readme.txt +22 -0
- data/asciidoc/doc/a2x.1 +246 -0
- data/asciidoc/doc/a2x.1.txt +195 -0
- data/asciidoc/doc/article.css-embedded.html +579 -0
- data/asciidoc/doc/article.html +62 -0
- data/asciidoc/doc/article.pdf +0 -0
- data/asciidoc/doc/article.txt +124 -0
- data/asciidoc/doc/asciidoc-revhistory.xml +27 -0
- data/asciidoc/doc/asciidoc.1 +161 -0
- data/asciidoc/doc/asciidoc.1.css-embedded.html +562 -0
- data/asciidoc/doc/asciidoc.1.css.html +212 -0
- data/asciidoc/doc/asciidoc.1.html +190 -0
- data/asciidoc/doc/asciidoc.1.txt +118 -0
- data/asciidoc/doc/asciidoc.conf +8 -0
- data/asciidoc/doc/asciidoc.css-embedded.html +7954 -0
- data/asciidoc/doc/asciidoc.css.html +7553 -0
- data/asciidoc/doc/asciidoc.dict +673 -0
- data/asciidoc/doc/asciidoc.html +3502 -0
- data/asciidoc/doc/asciidoc.txt +4757 -0
- data/asciidoc/doc/asciimath.txt +47 -0
- data/asciidoc/doc/book-multi.css-embedded.html +575 -0
- data/asciidoc/doc/book-multi.html +72 -0
- data/asciidoc/doc/book-multi.txt +159 -0
- data/asciidoc/doc/book.css-embedded.html +585 -0
- data/asciidoc/doc/book.html +60 -0
- data/asciidoc/doc/book.txt +133 -0
- data/asciidoc/doc/customers.csv +18 -0
- data/asciidoc/doc/faq.txt +262 -0
- data/asciidoc/doc/latex-backend.html +224 -0
- data/asciidoc/doc/latex-backend.txt +193 -0
- data/asciidoc/doc/latexmath.txt +35 -0
- data/asciidoc/doc/main.aap +293 -0
- data/asciidoc/doc/music-filter.html +513 -0
- data/asciidoc/doc/music-filter.pdf +0 -0
- data/asciidoc/doc/music-filter.txt +158 -0
- data/asciidoc/doc/source-highlight-filter.html +183 -0
- data/asciidoc/doc/source-highlight-filter.pdf +0 -0
- data/asciidoc/doc/source-highlight-filter.txt +174 -0
- data/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt +71 -0
- data/asciidoc/docbook-xsl/chunked.xsl +19 -0
- data/asciidoc/docbook-xsl/common.xsl +67 -0
- data/asciidoc/docbook-xsl/fo.xsl +117 -0
- data/asciidoc/docbook-xsl/htmlhelp.xsl +17 -0
- data/asciidoc/docbook-xsl/manpage.xsl +28 -0
- data/asciidoc/docbook-xsl/shaded-literallayout.patch +32 -0
- data/asciidoc/docbook-xsl/xhtml.xsl +14 -0
- data/asciidoc/docbook.conf +606 -0
- data/asciidoc/examples/website/CHANGELOG.html +3828 -0
- data/asciidoc/examples/website/INSTALL.html +163 -0
- data/asciidoc/examples/website/README-website.html +129 -0
- data/asciidoc/examples/website/README-website.txt +29 -0
- data/asciidoc/examples/website/README.html +125 -0
- data/asciidoc/examples/website/a2x.1.html +395 -0
- data/asciidoc/examples/website/asciidoc-docbook-xsl.html +165 -0
- data/asciidoc/examples/website/asciimath.html +157 -0
- data/asciidoc/examples/website/build-website.sh +25 -0
- data/asciidoc/examples/website/downloads.html +219 -0
- data/asciidoc/examples/website/downloads.txt +98 -0
- data/asciidoc/examples/website/faq.html +372 -0
- data/asciidoc/examples/website/index.html +398 -0
- data/asciidoc/examples/website/index.txt +222 -0
- data/asciidoc/examples/website/latex-backend.html +640 -0
- data/asciidoc/examples/website/latexmath.html +119 -0
- data/asciidoc/examples/website/layout1.conf +161 -0
- data/asciidoc/examples/website/layout1.css +65 -0
- data/asciidoc/examples/website/layout2.conf +158 -0
- data/asciidoc/examples/website/layout2.css +93 -0
- data/asciidoc/examples/website/manpage.html +266 -0
- data/asciidoc/examples/website/music-filter.html +242 -0
- data/asciidoc/examples/website/music1.abc +12 -0
- data/asciidoc/examples/website/music1.png +0 -0
- data/asciidoc/examples/website/music2.ly +9 -0
- data/asciidoc/examples/website/music2.png +0 -0
- data/asciidoc/examples/website/source-highlight-filter.html +251 -0
- data/asciidoc/examples/website/support.html +78 -0
- data/asciidoc/examples/website/support.txt +5 -0
- data/asciidoc/examples/website/userguide.html +7597 -0
- data/asciidoc/examples/website/version9.html +143 -0
- data/asciidoc/examples/website/version9.txt +48 -0
- data/asciidoc/filters/code-filter-readme.txt +37 -0
- data/asciidoc/filters/code-filter-test-c++.txt +7 -0
- data/asciidoc/filters/code-filter-test.txt +15 -0
- data/asciidoc/filters/code-filter.conf +8 -0
- data/asciidoc/filters/code-filter.py +239 -0
- data/asciidoc/filters/music-filter-test.txt +40 -0
- data/asciidoc/filters/music-filter.conf +40 -0
- data/asciidoc/filters/music2png.py +189 -0
- data/asciidoc/filters/source-highlight-filter-test.txt +19 -0
- data/asciidoc/filters/source-highlight-filter.conf +100 -0
- data/asciidoc/help.conf +213 -0
- data/asciidoc/html4.conf +363 -0
- data/asciidoc/images/highlighter.png +0 -0
- data/asciidoc/images/icons/README +5 -0
- data/asciidoc/images/icons/callouts/1.png +0 -0
- data/asciidoc/images/icons/callouts/10.png +0 -0
- data/asciidoc/images/icons/callouts/11.png +0 -0
- data/asciidoc/images/icons/callouts/12.png +0 -0
- data/asciidoc/images/icons/callouts/13.png +0 -0
- data/asciidoc/images/icons/callouts/14.png +0 -0
- data/asciidoc/images/icons/callouts/15.png +0 -0
- data/asciidoc/images/icons/callouts/2.png +0 -0
- data/asciidoc/images/icons/callouts/3.png +0 -0
- data/asciidoc/images/icons/callouts/4.png +0 -0
- data/asciidoc/images/icons/callouts/5.png +0 -0
- data/asciidoc/images/icons/callouts/6.png +0 -0
- data/asciidoc/images/icons/callouts/7.png +0 -0
- data/asciidoc/images/icons/callouts/8.png +0 -0
- data/asciidoc/images/icons/callouts/9.png +0 -0
- data/asciidoc/images/icons/caution.png +0 -0
- data/asciidoc/images/icons/example.png +0 -0
- data/asciidoc/images/icons/home.png +0 -0
- data/asciidoc/images/icons/important.png +0 -0
- data/asciidoc/images/icons/next.png +0 -0
- data/asciidoc/images/icons/note.png +0 -0
- data/asciidoc/images/icons/prev.png +0 -0
- data/asciidoc/images/icons/tip.png +0 -0
- data/asciidoc/images/icons/up.png +0 -0
- data/asciidoc/images/icons/warning.png +0 -0
- data/asciidoc/images/smallnew.png +0 -0
- data/asciidoc/images/tiger.png +0 -0
- data/asciidoc/install.sh +55 -0
- data/asciidoc/javascripts/ASCIIMathML.js +938 -0
- data/asciidoc/javascripts/LaTeXMathML.js +1223 -0
- data/asciidoc/javascripts/toc.js +69 -0
- data/asciidoc/lang-es.conf +15 -0
- data/asciidoc/latex.conf +663 -0
- data/asciidoc/linuxdoc.conf +285 -0
- data/asciidoc/math.conf +50 -0
- data/asciidoc/stylesheets/docbook-xsl.css +271 -0
- data/asciidoc/stylesheets/xhtml-deprecated-manpage.css +21 -0
- data/asciidoc/stylesheets/xhtml-deprecated.css +247 -0
- data/asciidoc/stylesheets/xhtml11-manpage.css +18 -0
- data/asciidoc/stylesheets/xhtml11-quirks.css +49 -0
- data/asciidoc/stylesheets/xhtml11.css +284 -0
- data/asciidoc/t.conf +20 -0
- data/asciidoc/text.conf +16 -0
- data/asciidoc/vim/ftdetect/asciidoc_filetype.vim +53 -0
- data/asciidoc/vim/syntax/asciidoc.vim +139 -0
- data/asciidoc/xhtml-deprecated-css.conf +235 -0
- data/asciidoc/xhtml-deprecated.conf +351 -0
- data/asciidoc/xhtml11-quirks.conf +57 -0
- data/asciidoc/xhtml11.conf +514 -0
- data/bin/mizuho +40 -0
- data/lib/mizuho/chapter.rb +54 -0
- data/lib/mizuho/generator.rb +106 -0
- data/lib/mizuho/heading.rb +46 -0
- data/lib/mizuho/parser.rb +99 -0
- data/lib/mizuho/template.rb +50 -0
- data/mizuho.gemspec +34 -0
- data/templates/asciidoc.css +358 -0
- data/templates/asciidoc.html.erb +86 -0
- data/templates/manualsonrails.css +165 -0
- data/templates/manualsonrails.html.erb +97 -0
- data/test/parser_spec.rb +190 -0
- data/test/spec_helper.rb +43 -0
- metadata +234 -0
@@ -0,0 +1,60 @@
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
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>Book Title Goes Here</title><link rel="stylesheet" href="./docbook-xsl.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.72.0" /></head><body><div class="book" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="id2433890"></a>Book Title Goes Here</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Author's</span> <span class="surname">Name</span></h3></div></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="3"><b>Revision History</b></th></tr><tr><td align="left">Revision 1.0</td><td align="left">Dec 2003</td><td align="left">AN</td></tr></table></div></div></div><hr /></div><div class="dedication" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_dedication"></a>Dedication</h2></div></div></div><p>Optional dedication.</p><p>This document is an <span class="emphasis"><em>AsciiDoc</em></span> book skeleton containing briefly
|
4
|
+
annotated example elements plus a couple of example index entries and
|
5
|
+
footnotes.</p><p>Books are normally used to generate DocBook markup and the titles of
|
6
|
+
the preface, appendix, bibliography, glossary and index sections are
|
7
|
+
significant (<span class="emphasis"><em>specialsections</em></span>).</p></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="preface"><a href="#_preface">Preface</a></span></dt><dd><dl><dt><span class="section"><a href="#_preface_sub_section">1. Preface Sub-section</a></span></dt></dl></dd><dt><span class="chapter"><a href="#_the_first_chapter">1. The First Chapter</a></span></dt><dd><dl><dt><span class="section"><a href="#X1">1.1. Sub-section with Anchor</a></span></dt><dd><dl><dt><span class="section"><a href="#_chapter_sub_section">1.1.1. Chapter Sub-section</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#_the_second_chapter">2. The Second Chapter</a></span></dt><dt><span class="chapter"><a href="#_the_third_chapter">3. The Third Chapter</a></span></dt><dt><span class="appendix"><a href="#_example_appendix">A. Example Appendix</a></span></dt><dd><dl><dt><span class="section"><a href="#_appendix_sub_section">A.1. Appendix Sub-section</a></span></dt></dl></dd><dt><span class="bibliography"><a href="#_bibliography">Bibliography</a></span></dt><dt><span class="glossary"><a href="#_glossary">Glossary</a></span></dt><dt><span class="index"><a href="#_index">Index</a></span></dt></dl></div><div class="list-of-figures"><p><b>List of Figures</b></p><dl><dt>1.1. <a href="#id2488208">Tiger block image</a></dt></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>1.1. <a href="#id2488284">An example table</a></dt></dl></div><div class="preface" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_preface"></a>Preface</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#_preface_sub_section">1. Preface Sub-section</a></span></dt></dl></div><p>Optional preface.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_preface_sub_section"></a>1. Preface Sub-section</h2></div></div></div><p>Preface sub-section body.</p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_the_first_chapter"></a>Chapter 1. The First Chapter</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#X1">1.1. Sub-section with Anchor</a></span></dt><dd><dl><dt><span class="section"><a href="#_chapter_sub_section">1.1.1. Chapter Sub-section</a></span></dt></dl></dd></dl></div><p>Chapters can contain sub-sections nested up to three deep.
|
8
|
+
<sup>[<a id="id2488063" href="#ftn.id2488063">1</a>]</sup>
|
9
|
+
<a id="id2488068" class="indexterm"></a></p><p>Chapters can have their own bibliography, glossary and index.</p><p>And now for something completely different: <a id="id2488084" class="indexterm"></a>
|
10
|
+
monkeys, lions and
|
11
|
+
tigers (Bengal and Siberian) using the alternative syntax index
|
12
|
+
entries.
|
13
|
+
<a id="id2488096" class="indexterm"></a>
|
14
|
+
<a id="id2488107" class="indexterm"></a>
|
15
|
+
<a id="id2488116" class="indexterm"></a>
|
16
|
+
<a id="id2488130" class="indexterm"></a>
|
17
|
+
<a id="id2488141" class="indexterm"></a>
|
18
|
+
<a id="id2488150" class="indexterm"></a>
|
19
|
+
<a id="id2488164" class="indexterm"></a>
|
20
|
+
<a id="id2488176" class="indexterm"></a>
|
21
|
+
Note that multi-entry terms generate separate index entries.</p><p>Here are a couple of image examples: an <span class="inlinemediaobject"><img src="images/smallnew.png" alt="images/smallnew.png" /></span>
|
22
|
+
example inline image followed by an example block image:</p><div class="figure"><a id="id2488208"></a><p class="title"><b>Figure 1.1. Tiger block image</b></p><div class="figure-contents"><div class="mediaobject"><img src="images/tiger.png" alt="Tiger image" /></div></div></div><br class="figure-break" /><p>Followed by an example table:</p><div class="table"><a id="id2488284"></a><p class="title"><b>Table 1.1. An example table</b></p><div class="table-contents"><table summary="An example table" cellpadding="4px" border="0" style="border-collapse: collapse;border-top: 2px solid #527bbd; border-bottom: 2px solid #527bbd; "><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th style="" align="left">
|
23
|
+
Option
|
24
|
+
</th><th style="" align="left">
|
25
|
+
Description
|
26
|
+
</th></tr></thead><tbody><tr><td style="" align="left">
|
27
|
+
-a <span class="emphasis"><em>USER GROUP</em></span>
|
28
|
+
</td><td style="" align="left">
|
29
|
+
Add <span class="emphasis"><em>USER</em></span> to <span class="emphasis"><em>GROUP</em></span>.
|
30
|
+
</td></tr><tr><td style="" align="left">
|
31
|
+
-R <span class="emphasis"><em>GROUP</em></span>
|
32
|
+
</td><td style="" align="left">
|
33
|
+
Disables access to <span class="emphasis"><em>GROUP</em></span>.
|
34
|
+
</td></tr></tbody></table></div></div><br class="table-break" /><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X1"></a>1.1. Sub-section with Anchor</h2></div></div></div><p>Sub-section at level 2.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_chapter_sub_section"></a>1.1.1. Chapter Sub-section</h3></div></div></div><p>Sub-section at level 3.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="_chapter_sub_section_2"></a>1.1.1.1. Chapter Sub-section</h4></div></div></div><p>Sub-section at level 4.</p><p>This is the maximum sub-section depth supported by the distributed
|
35
|
+
<span class="emphasis"><em>AsciiDoc</em></span> configuration.
|
36
|
+
<sup>[<a id="id2488422" href="#ftn.id2488422">2</a>]</sup></p></div></div></div><div class="footnotes"><br /><hr width="100" align="left" /><div class="footnote"><p><sup>[<a id="ftn.id2488063" href="#id2488063">1</a>] </sup>An example footnote.</p></div><div class="footnote"><p><sup>[<a id="ftn.id2488422" href="#id2488422">2</a>] </sup>A second example footnote.</p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_the_second_chapter"></a>Chapter 2. The Second Chapter</h2></div></div></div><p>An example link to anchor at start of the <a href="#X1" title="1.1. Sub-section with Anchor">first sub-section</a>.
|
37
|
+
<a id="id2488554" class="indexterm"></a></p><p>An example link to a bibliography entry <a href="#taoup">[taoup]</a>.</p></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_the_third_chapter"></a>Chapter 3. The Third Chapter</h2></div></div></div><p>Book chapters are at level 1 and can contain sub-sections.</p></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_example_appendix"></a>Appendix A. Example Appendix</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#_appendix_sub_section">A.1. Appendix Sub-section</a></span></dt></dl></div><p>One or more optional appendixes go here at section level 1.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_appendix_sub_section"></a>A.1. Appendix Sub-section</h2></div></div></div><p>Sub-section body.</p></div></div><div class="bibliography"><div class="titlepage"><div><div><h2 class="title"><a id="_bibliography"></a>Bibliography</h2></div></div></div><p>The bibliography list is an example of an <span class="emphasis"><em>AsciiDoc</em></span> SimpleList, the
|
38
|
+
<span class="emphasis"><em>AsciiDoc</em></span> source list items are bulleted with a <code class="literal">+</code> character. The
|
39
|
+
first entry in this example has an anchor.</p><div class="bibliomixed"><a id="id2488885"></a><p class="bibliomixed">
|
40
|
+
<span class="bibliomisc">
|
41
|
+
<a id="taoup"></a>[taoup] Eric Steven Raymond. <span class="emphasis"><em>The Art of Unix Programming</em></span>.
|
42
|
+
Addison-Wesley. ISBN 0-13-142901-9.
|
43
|
+
</span>
|
44
|
+
</p></div><div class="bibliomixed"><a id="id2488904"></a><p class="bibliomixed">
|
45
|
+
<span class="bibliomisc">
|
46
|
+
<a id="walsh-muellner"></a>[walsh-muellner] Norman Walsh & Leonard Muellner.
|
47
|
+
<span class="emphasis"><em>DocBook - The Definative Guide</em></span>. O'Reilly & Associates. 199.
|
48
|
+
ISBN 1-56592-580-7.
|
49
|
+
</span>
|
50
|
+
</p></div></div><div class="glossary"><div class="titlepage"><div><div><h2 class="title"><a id="_glossary"></a>Glossary</h2></div></div></div><p>Glossaries are optional. Glossaries are an example of an <span class="emphasis"><em>AsciiDoc</em></span>
|
51
|
+
VariableList, the <span class="emphasis"><em>AsciiDoc</em></span> glossary entry terms are terminated
|
52
|
+
by the <code class="literal">:-</code> characters.</p><dl><dt>
|
53
|
+
A glossary term
|
54
|
+
</dt><dd><p>
|
55
|
+
The corresponding (indented) definition.
|
56
|
+
</p></dd><dt>
|
57
|
+
A second glossary term
|
58
|
+
</dt><dd><p>
|
59
|
+
The corresponding (indented) definition.
|
60
|
+
</p></dd></dl></div><div class="index"><div class="titlepage"><div><div><h2 class="title"><a id="_index"></a>Index</h2></div></div></div><div class="index"><div class="indexdiv"><h3>B</h3><dl><dt>Bengal Tiger, <a href="#_the_first_chapter">The First Chapter</a></dt><dt>Big cats</dt><dd><dl><dt>Lions, <a href="#_the_first_chapter">The First Chapter</a></dt><dt>Tigers</dt><dd><dl><dt>Bengal Tiger, <a href="#_the_first_chapter">The First Chapter</a></dt><dt>Siberian Tiger, <a href="#_the_first_chapter">The First Chapter</a></dt></dl></dd></dl></dd></dl></div><div class="indexdiv"><h3>E</h3><dl><dt>Example index entry, <a href="#_the_first_chapter">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>L</h3><dl><dt>Lions, <a href="#_the_first_chapter">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>M</h3><dl><dt>monkeys, <a href="#_the_first_chapter">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>S</h3><dl><dt>Second example index entry, <a href="#_the_second_chapter">The Second Chapter</a></dt><dt>Siberian Tiger, <a href="#_the_first_chapter">The First Chapter</a></dt></dl></div><div class="indexdiv"><h3>T</h3><dl><dt>Tigers</dt><dd><dl><dt>Bengal Tiger, <a href="#_the_first_chapter">The First Chapter</a></dt><dt>Siberian Tiger, <a href="#_the_first_chapter">The First Chapter</a></dt></dl></dd></dl></div></div></div></div></body></html>
|
@@ -0,0 +1,133 @@
|
|
1
|
+
Book Title Goes Here
|
2
|
+
====================
|
3
|
+
Author's Name
|
4
|
+
v1.0, Dec 2003
|
5
|
+
|
6
|
+
|
7
|
+
Dedication
|
8
|
+
----------
|
9
|
+
Optional dedication.
|
10
|
+
|
11
|
+
This document is an AsciiDoc book skeleton containing briefly
|
12
|
+
annotated example elements plus a couple of example index entries and
|
13
|
+
footnotes.
|
14
|
+
|
15
|
+
Books are normally used to generate DocBook markup and the titles of
|
16
|
+
the preface, appendix, bibliography, glossary and index sections are
|
17
|
+
significant ('specialsections').
|
18
|
+
|
19
|
+
|
20
|
+
Preface
|
21
|
+
-------
|
22
|
+
Optional preface.
|
23
|
+
|
24
|
+
Preface Sub-section
|
25
|
+
~~~~~~~~~~~~~~~~~~~
|
26
|
+
Preface sub-section body.
|
27
|
+
|
28
|
+
|
29
|
+
The First Chapter
|
30
|
+
-----------------
|
31
|
+
Chapters can contain sub-sections nested up to three deep.
|
32
|
+
footnote:[An example footnote.]
|
33
|
+
indexterm:[Example index entry]
|
34
|
+
|
35
|
+
Chapters can have their own bibliography, glossary and index.
|
36
|
+
|
37
|
+
And now for something completely different: ((monkeys)), lions and
|
38
|
+
tigers (Bengal and Siberian) using the alternative syntax index
|
39
|
+
entries.
|
40
|
+
(((Big cats,Lions)))
|
41
|
+
(((Big cats,Tigers,Bengal Tiger)))
|
42
|
+
(((Big cats,Tigers,Siberian Tiger)))
|
43
|
+
Note that multi-entry terms generate separate index entries.
|
44
|
+
|
45
|
+
Here are a couple of image examples: an image:images/smallnew.png[]
|
46
|
+
example inline image followed by an example block image:
|
47
|
+
|
48
|
+
.Tiger block image
|
49
|
+
image::images/tiger.png[Tiger image]
|
50
|
+
|
51
|
+
Followed by an example table:
|
52
|
+
|
53
|
+
.An example table
|
54
|
+
`-----------------`--------------------------
|
55
|
+
Option Description
|
56
|
+
---------------------------------------------
|
57
|
+
-a 'USER GROUP' Add 'USER' to 'GROUP'.
|
58
|
+
-R 'GROUP' Disables access to 'GROUP'.
|
59
|
+
---------------------------------------------
|
60
|
+
|
61
|
+
[[X1]]
|
62
|
+
Sub-section with Anchor
|
63
|
+
~~~~~~~~~~~~~~~~~~~~~~~
|
64
|
+
Sub-section at level 2.
|
65
|
+
|
66
|
+
Chapter Sub-section
|
67
|
+
^^^^^^^^^^^^^^^^^^^
|
68
|
+
Sub-section at level 3.
|
69
|
+
|
70
|
+
Chapter Sub-section
|
71
|
+
+++++++++++++++++++
|
72
|
+
Sub-section at level 4.
|
73
|
+
|
74
|
+
This is the maximum sub-section depth supported by the distributed
|
75
|
+
AsciiDoc configuration.
|
76
|
+
footnote:[A second example footnote.]
|
77
|
+
|
78
|
+
|
79
|
+
The Second Chapter
|
80
|
+
------------------
|
81
|
+
An example link to anchor at start of the <<X1,first sub-section>>.
|
82
|
+
indexterm:[Second example index entry]
|
83
|
+
|
84
|
+
An example link to a bibliography entry <<taoup>>.
|
85
|
+
|
86
|
+
|
87
|
+
The Third Chapter
|
88
|
+
-----------------
|
89
|
+
Book chapters are at level 1 and can contain sub-sections.
|
90
|
+
|
91
|
+
|
92
|
+
Appendix A: Example Appendix
|
93
|
+
----------------------------
|
94
|
+
One or more optional appendixes go here at section level 1.
|
95
|
+
|
96
|
+
Appendix Sub-section
|
97
|
+
~~~~~~~~~~~~~~~~~~~
|
98
|
+
Sub-section body.
|
99
|
+
|
100
|
+
|
101
|
+
Bibliography
|
102
|
+
------------
|
103
|
+
The bibliography list is an example of an AsciiDoc SimpleList, the
|
104
|
+
AsciiDoc source list items are bulleted with a `+` character. The
|
105
|
+
first entry in this example has an anchor.
|
106
|
+
|
107
|
+
+ [[[taoup]]] Eric Steven Raymond. 'The Art of Unix Programming'.
|
108
|
+
Addison-Wesley. ISBN 0-13-142901-9.
|
109
|
+
|
110
|
+
+ [[[walsh-muellner]]] Norman Walsh & Leonard Muellner.
|
111
|
+
'DocBook - The Definative Guide'. O'Reilly & Associates. 199.
|
112
|
+
ISBN 1-56592-580-7.
|
113
|
+
|
114
|
+
|
115
|
+
Glossary
|
116
|
+
--------
|
117
|
+
Glossaries are optional. Glossaries are an example of an AsciiDoc
|
118
|
+
VariableList, the AsciiDoc glossary entry terms are terminated
|
119
|
+
by the `:-` characters.
|
120
|
+
|
121
|
+
A glossary term:-
|
122
|
+
The corresponding (indented) definition.
|
123
|
+
|
124
|
+
A second glossary term:-
|
125
|
+
The corresponding (indented) definition.
|
126
|
+
|
127
|
+
|
128
|
+
Index
|
129
|
+
-----
|
130
|
+
////////////////////////////////////////////////////////////////
|
131
|
+
The index is normally left completely empty, it's contents being
|
132
|
+
generated automatically by the DocBook toolchain.
|
133
|
+
////////////////////////////////////////////////////////////////
|
@@ -0,0 +1,18 @@
|
|
1
|
+
"AROUT","Around the Horn","Thomas Hardy","120 Hanover Sq.
|
2
|
+
London","(171) 555-7788"
|
3
|
+
"BERGS","Berglunds snabbkop","Christina Berglund","Berguvsvagen 8
|
4
|
+
Lulea","0921-12 34 65"
|
5
|
+
"BLAUS","Blauer See Delikatessen","Hanna Moos","Forsterstr. 57
|
6
|
+
Mannheim","0621-08460"
|
7
|
+
"BLONP","Blondel pere et fils","Frederique Citeaux","24, place Kleber
|
8
|
+
Strasbourg","88.60.15.31"
|
9
|
+
"BOLID","Bolido Comidas preparadas","Martin Sommer","C/ Araquil, 67
|
10
|
+
Madrid","(91) 555 22 82"
|
11
|
+
"BONAP","Bon app'","Laurence Lebihan","12, rue des Bouchers
|
12
|
+
Marseille","91.24.45.40"
|
13
|
+
"BOTTM","Bottom-Dollar Markets","Elizabeth Lincoln","23 Tsawassen Blvd.
|
14
|
+
Tsawassen","(604) 555-4729"
|
15
|
+
"BSBEV","B's Beverages","Victoria Ashworth","Fauntleroy Circus
|
16
|
+
London","(171) 555-1212"
|
17
|
+
"CACTU","Cactus Comidas para llevar","Patricio Simpson","Cerrito 333
|
18
|
+
Buenos Aires","(1) 135-5555"
|
@@ -0,0 +1,262 @@
|
|
1
|
+
AsciiDoc Frequently Asked Questions
|
2
|
+
===================================
|
3
|
+
|
4
|
+
An embryonic AsciiDoc FAQ.
|
5
|
+
|
6
|
+
|
7
|
+
== How can I preserve paragraph line boundaries?
|
8
|
+
|
9
|
+
Apply the The 'verse' paragraph style, the rendered text preserves
|
10
|
+
line boundaries and is useful for lyrics and poems. For example:
|
11
|
+
|
12
|
+
---------------------------------------------------------------------
|
13
|
+
[verse]
|
14
|
+
Consul *necessitatibus* per id,
|
15
|
+
consetetur, eu pro everti postulant
|
16
|
+
homero verear ea mea, qui.
|
17
|
+
---------------------------------------------------------------------
|
18
|
+
|
19
|
+
|
20
|
+
== How can I include non-breaking space characters?
|
21
|
+
|
22
|
+
The predefined `\{nbsp}` attribute reference will be replaced by a
|
23
|
+
non-breaking space character.
|
24
|
+
|
25
|
+
|
26
|
+
== How do I include spaces in URL addresses?
|
27
|
+
|
28
|
+
URL inline macro targets (addresses) cannot contain white space
|
29
|
+
characters. If you need spaces encode them as `%20`. For example:
|
30
|
+
|
31
|
+
image:large%20image.png[]
|
32
|
+
http://www.foo.bar.com/an%20example%20document.html
|
33
|
+
|
34
|
+
|
35
|
+
== How can I get AsciiDoc to assign the correct DocBook language attribute?
|
36
|
+
|
37
|
+
Set the AsciiDoc 'lang' attribute to the appropriate language code.
|
38
|
+
For example:
|
39
|
+
|
40
|
+
$ a2x -a lang=es doc/article.txt
|
41
|
+
|
42
|
+
This will ensure that downstream DocBook processing will generate the
|
43
|
+
correct language specific document headings (things like table of
|
44
|
+
contents, revision history, figure and table captions, admonition
|
45
|
+
captions).
|
46
|
+
|
47
|
+
|
48
|
+
== Why does AsciiDoc give me a ``malformed author'' error?
|
49
|
+
|
50
|
+
This is normally because there are more than three names (up to three
|
51
|
+
are expected: first name, middle name and last name). For example,
|
52
|
+
this author line would result in an error:
|
53
|
+
|
54
|
+
Vincent Willem van Gogh
|
55
|
+
|
56
|
+
You can enter multi-word first, middle and last names in the author
|
57
|
+
line using the underscore as a word separator. For example:
|
58
|
+
|
59
|
+
Vincent Willem van_Gogh
|
60
|
+
|
61
|
+
You could also resolve the problem by replacing the author line with
|
62
|
+
explicit attribute entries:
|
63
|
+
|
64
|
+
:First name: Vincent
|
65
|
+
:Middle name: Willem
|
66
|
+
:Last name: Van Gogh
|
67
|
+
|
68
|
+
|
69
|
+
== How can I assign multiple author names?
|
70
|
+
|
71
|
+
A quick way to do this is put both authors in a single first name, for
|
72
|
+
example:
|
73
|
+
|
74
|
+
My Document
|
75
|
+
===========
|
76
|
+
:Author: Bill_and_Ben_the_Flowerpot_Men
|
77
|
+
:Author Initials: BB & BC
|
78
|
+
|
79
|
+
asciidoc(1) replaces the underscores with spaces.
|
80
|
+
|
81
|
+
The longer, but semantically correct way, is to override the
|
82
|
+
`[header]` configuration file section in a document specific `.conf`
|
83
|
+
file. For example if your document is `mydoc.txt` then a file called
|
84
|
+
`mydoc.conf` in the document directory would be picked up
|
85
|
+
automatically by asciidoc(1). Copy and paste the default
|
86
|
+
`docbook.conf` file `[header]` to `mydoc.conf` and modify the author
|
87
|
+
related markup:
|
88
|
+
|
89
|
+
[header]
|
90
|
+
:
|
91
|
+
<authorgroup>...
|
92
|
+
:
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
== How can I escape AsciiDoc markup?
|
97
|
+
|
98
|
+
Most AsciiDoc inline elements can be suppressed by preceding them with
|
99
|
+
a backslash character. These elements include:
|
100
|
+
|
101
|
+
- Attribute references.
|
102
|
+
- Text formatting.
|
103
|
+
- Quoting,
|
104
|
+
- 'URLs', 'image' and 'link' macros.
|
105
|
+
- Replacements.
|
106
|
+
- Special words.
|
107
|
+
|
108
|
+
In some cases you may need to escape both left and right quotes (see
|
109
|
+
the 'AsciiDoc User Guide').
|
110
|
+
|
111
|
+
|
112
|
+
== How can I escape a labeled list entry?
|
113
|
+
|
114
|
+
Two colons or semicolons in a paragraph may be confused with a labeled
|
115
|
+
list entry. Use the predefined `\{two_colons}` and `\{two_semicolons}`
|
116
|
+
to suppress this behavior, for example:
|
117
|
+
|
118
|
+
Qui in magna commodo{two_colons} est labitur dolorum an. Est ne
|
119
|
+
magna primis adolescens.
|
120
|
+
|
121
|
+
Will be rendered as:
|
122
|
+
|
123
|
+
Qui in magna commodo{two_colons} est labitur dolorum an. Est ne
|
124
|
+
magna primis adolescens.
|
125
|
+
|
126
|
+
|
127
|
+
== How can I disable a quoted text substitution?
|
128
|
+
|
129
|
+
Omitting the tag will disable quoting. For example, if you don't want
|
130
|
+
superscripts or subscripts then put the following in a custom
|
131
|
+
configuration file or edit the global `asciidoc.conf` configuration
|
132
|
+
file:
|
133
|
+
|
134
|
+
---------------------------------------------------------------------
|
135
|
+
[quotes]
|
136
|
+
^=
|
137
|
+
~=
|
138
|
+
---------------------------------------------------------------------
|
139
|
+
|
140
|
+
|
141
|
+
== I have a paragraph containing some funky URLs, is there a way to suppress AsciiDoc substitutions in the URL address?
|
142
|
+
|
143
|
+
You can selectively choose which substitutions to perform by setting
|
144
|
+
the 'subs' attribute at the start of a block. For example:
|
145
|
+
|
146
|
+
---------------------------------------------------------------------
|
147
|
+
[subs="macros"]
|
148
|
+
~subscripts~ and ^superscripts^ quotes won't be substituted.
|
149
|
+
Nor will the non-alphanumeric characters in the following URL:
|
150
|
+
http://host/~user/file#_anchor_tag_str_
|
151
|
+
---------------------------------------------------------------------
|
152
|
+
|
153
|
+
|
154
|
+
== How can I customize the \{localdate} format?
|
155
|
+
|
156
|
+
The default format for the `\{localdate}` attribute is the ISO 8601
|
157
|
+
`yyyy-mm-dd` format. You can change this format by explicitly setting
|
158
|
+
the `\{localdate}` attribute. For example by setting it using the
|
159
|
+
asciidoc(1) `-a` command-line option:
|
160
|
+
|
161
|
+
$ asciidoc -a localdate=`date +%d-%d-%Y` mydoc.txt
|
162
|
+
|
163
|
+
You could also set it by adding an Attribute Entry to your souce
|
164
|
+
document, for example:
|
165
|
+
|
166
|
+
:localdate: {sys: date +%Y-%m-%d}
|
167
|
+
|
168
|
+
Since it's set using an executable attribute you'll also need to
|
169
|
+
include the `--unsafe` option when you run asciidoc).
|
170
|
+
|
171
|
+
|
172
|
+
== Why doesn't AsciiDoc support strike through text?
|
173
|
+
|
174
|
+
The reason it's not in the distribution is that DocBook does not have
|
175
|
+
provision for strike through text and one of the AsciiDoc design goals
|
176
|
+
is that AsciiDoc markup should be applicable to all output formats.
|
177
|
+
|
178
|
+
Strike through is normally used to mark deleted text -- a more
|
179
|
+
comprehensive way to manage document revisions is to use a version
|
180
|
+
control system such as Subversion. You can also use the AsciiDoc
|
181
|
+
'CommentLines' and 'CommentBlocks' to retain revised text in the
|
182
|
+
source document.
|
183
|
+
|
184
|
+
If you really need strike through text for (X)HTML outputs then adding
|
185
|
+
the following to a configuration file will allow you to quote strike
|
186
|
+
through text with hyphen characters:
|
187
|
+
|
188
|
+
---------------------------------------------------------------------
|
189
|
+
ifdef::basebackend-html[]
|
190
|
+
|
191
|
+
[quotes]
|
192
|
+
-=strikethrough
|
193
|
+
|
194
|
+
[tags]
|
195
|
+
strikethrough=<span style="text-decoration: line-through;">|</span>
|
196
|
+
|
197
|
+
endif::basebackend-html[]
|
198
|
+
---------------------------------------------------------------------
|
199
|
+
|
200
|
+
|
201
|
+
== Where can I find examples of commands used to build output documents?
|
202
|
+
|
203
|
+
The User Guide has some. You could also look at `./doc/main.aap` in
|
204
|
+
the AsciiDoc distribution, it has all the commands used to build the
|
205
|
+
AsciiDoc documentation (even if you don't use A-A-P you'll still find
|
206
|
+
it useful).
|
207
|
+
|
208
|
+
|
209
|
+
== How can I place a backslash character in front of an attribute reference without escaping the reference?
|
210
|
+
|
211
|
+
Use the predefined `\{backslash}` attribute reference instead of an
|
212
|
+
actual backslash, for example if the `\{projectname}` attribute has
|
213
|
+
the value `foobar` then:
|
214
|
+
|
215
|
+
d:\data{backslash}{projectname}
|
216
|
+
|
217
|
+
would be rendered as:
|
218
|
+
|
219
|
+
d:\data\foobar
|
220
|
+
|
221
|
+
|
222
|
+
== Why have you used the DocBook <simpara> element instead of <para>?
|
223
|
+
|
224
|
+
`<simpara>` is really the same as `<para>` except it can't contain
|
225
|
+
block elements -- this matched, more closely, the AsciiDoc paragraph
|
226
|
+
semantics.
|
227
|
+
|
228
|
+
|
229
|
+
== How can I format text inside a listting block?
|
230
|
+
|
231
|
+
By default only 'specialcharacters' and 'callouts' are substituted in
|
232
|
+
listing blocks; you can add quotes substitutions by explicitly setting
|
233
|
+
the block 'subs' attribute, for example:
|
234
|
+
|
235
|
+
[subs="specialcharacters,callouts,quotes"]
|
236
|
+
------------------------------------------
|
237
|
+
$ ls *-al*
|
238
|
+
------------------------------------------
|
239
|
+
|
240
|
+
The `-al` will rendered bold. Note that:
|
241
|
+
|
242
|
+
- You would need to explicitly escape text you didn't want quoted.
|
243
|
+
- Don't do this in source code listing blocks because it modifies the
|
244
|
+
source code which confuses the syntax highlighter.
|
245
|
+
- This only works if your DocBook processor recognizes DocBook
|
246
|
+
`<emphasis>` elements inside `<screen>` elements.
|
247
|
+
|
248
|
+
|
249
|
+
== Why doesn't the \include1::[] macro work?
|
250
|
+
|
251
|
+
Internally the `include1` macro is translated to the `include1` system
|
252
|
+
attribute which means it must be evaluated in a region where attribute
|
253
|
+
substitution is enabled. For example, if you want to evaluate it
|
254
|
+
inside a listing block you will need to enable attribute substitution
|
255
|
+
inside the block, for example:
|
256
|
+
|
257
|
+
[subs="attributes"]
|
258
|
+
-----------------------------------------
|
259
|
+
include1::blogpost_media_processing.txt[]
|
260
|
+
-----------------------------------------
|
261
|
+
|
262
|
+
Or, preferably, use the `include` block macro instead.
|