RubyGems - git-scribe - Versions diffs - 0.0.4 → 0.0.5 - Mend

git-scribe 0.0.4 → 0.0.5

Files changed (151) hide show

data/.gitignore +1 -0
data/Rakefile +31 -0
data/SPEC.asciidoc +126 -0
data/TODO.txt +29 -0
data/bin/git-scribe +2 -1
data/docbook-xsl/.CatalogManager.properties.example +61 -0
data/docbook-xsl/.urilist +1 -0
data/git-scribe.gemspec +32 -0
data/lib/git-scribe.rb +21 -315
data/lib/git-scribe/check.rb +60 -0
data/lib/git-scribe/cli.rb +84 -0
data/lib/git-scribe/generate.rb +222 -0
data/lib/git-scribe/init.rb +16 -0
data/lib/git-scribe/version.rb +3 -0
data/template/.gitignore +1 -0
data/template/.gitscribe +5 -0
data/test/check_test.rb +12 -0
data/test/gen_test.rb +78 -0
data/test/init_test.rb +36 -0
data/test/test_helper.rb +44 -0
metadata +49 -161
data/example/book/big.asc +0 -5604
data/example/book/holmes.asc +0 -12983
data/example/output/META-INF/container.xml +0 -6
data/example/output/OEBPS/ar01s02.html +0 -15
data/example/output/OEBPS/ar01s03.html +0 -3
data/example/output/OEBPS/content.opf +0 -21
data/example/output/OEBPS/index.html +0 -5
data/example/output/OEBPS/toc.ncx +0 -37
data/example/output/a_case_of_identity.html +0 -725
data/example/output/a_example_appendix.html +0 -63
data/example/output/a_migration_notes.html +0 -95
data/example/output/apa.html +0 -20
data/example/output/apb.html +0 -6
data/example/output/apc.html +0 -24
data/example/output/apd.html +0 -30
data/example/output/ape.html +0 -26
data/example/output/apf.html +0 -9
data/example/output/apg.html +0 -42
data/example/output/aph.html +0 -89
data/example/output/ar01s02.html +0 -12
data/example/output/ar01s03.html +0 -34
data/example/output/ar01s04.html +0 -77
data/example/output/ar01s05.html +0 -272
data/example/output/ar01s06.html +0 -35
data/example/output/ar01s07.html +0 -105
data/example/output/ar01s08.html +0 -33
data/example/output/ar01s09.html +0 -12
data/example/output/ar01s10.html +0 -14
data/example/output/ar01s11.html +0 -34
data/example/output/ar01s12.html +0 -63
data/example/output/ar01s13.html +0 -156
data/example/output/ar01s14.html +0 -330
data/example/output/ar01s15.html +0 -22
data/example/output/ar01s16.html +0 -27
data/example/output/ar01s17.html +0 -94
data/example/output/ar01s18.html +0 -359
data/example/output/ar01s19.html +0 -373
data/example/output/ar01s20.html +0 -27
data/example/output/ar01s21.html +0 -33
data/example/output/ar01s22.html +0 -351
data/example/output/ar01s23.html +0 -21
data/example/output/ar01s24.html +0 -69
data/example/output/ar01s25.html +0 -60
data/example/output/ar01s26.html +0 -217
data/example/output/ar01s27.html +0 -88
data/example/output/ar01s28.html +0 -237
data/example/output/ar01s29.html +0 -68
data/example/output/ar01s30.html +0 -154
data/example/output/ar01s31.html +0 -6
data/example/output/ar01s32.html +0 -22
data/example/output/ar01s33.html +0 -209
data/example/output/asciidoc_backends.html +0 -190
data/example/output/asciidoc_document_types.html +0 -131
data/example/output/attribute_entries.html +0 -185
data/example/output/attribute_lists.html +0 -157
data/example/output/attribute_references.html +0 -414
data/example/output/attributelist_element.html +0 -143
data/example/output/b_packager_notes.html +0 -68
data/example/output/bi01.html +0 -18
data/example/output/big.asc +0 -5604
data/example/output/block_element_definitions.html +0 -448
data/example/output/block_titles.html +0 -83
data/example/output/blockid_element.html +0 -80
data/example/output/book.asc +0 -5604
data/example/output/book.epub +0 -0
data/example/output/book.fo +0 -3788
data/example/output/book.html +0 -8793
data/example/output/book.xml +0 -8265
data/example/output/c_asciidoc_safe_mode.html +0 -105
data/example/output/callouts.html +0 -214
data/example/output/catalog +0 -10
data/example/output/colophon.html +0 -397
data/example/output/configuration_files.html +0 -672
data/example/output/converting_docbook_to_other_file_formats.html +0 -324
data/example/output/d_using_asciidoc_with_non-english_languages.html +0 -107
data/example/output/delimited_blocks.html +0 -455
data/example/output/document_attributes.html +0 -95
data/example/output/document_processing.html +0 -116
data/example/output/document_structure.html +0 -493
data/example/output/e_vim_syntax_highlighter.html +0 -111
data/example/output/example_bibliography.html +0 -82
data/example/output/example_colophon.html +0 -58
data/example/output/example_glossary.html +0 -73
data/example/output/example_index.html +0 -108
data/example/output/f_attribute_options.html +0 -129
data/example/output/filters.html +0 -179
data/example/output/footnotes.html +0 -103
data/example/output/g_diagnostics.html +0 -148
data/example/output/generating_plain_text_files.html +0 -68
data/example/output/getting_started.html +0 -87
data/example/output/glossary.html +0 -95
data/example/output/go01.html +0 -24
data/example/output/h_backend_attributes.html +0 -308
data/example/output/help_commands.html +0 -96
data/example/output/holmes.asc +0 -12983
data/example/output/image/octocat_professor.png +0 -0
data/example/output/include/hello.c +0 -10
data/example/output/index.html +0 -656
data/example/output/indexes.html +0 -104
data/example/output/intrinsic_attributes.html +0 -165
data/example/output/ix01.html +0 -3
data/example/output/lists.html +0 -666
data/example/output/macros.html +0 -737
data/example/output/manpage_documents.html +0 -124
data/example/output/master.css +0 -281
data/example/output/mathematical_formulas.html +0 -125
data/example/output/page.html +0 -60
data/example/output/paragraphs.html +0 -192
data/example/output/pr01.html +0 -3
data/example/output/source_code_highlighting.html +0 -59
data/example/output/stylesheets/handbookish-quirks.css +0 -0
data/example/output/stylesheets/handbookish.css +0 -233
data/example/output/tables.html +0 -797
data/example/output/text_formatting.html +0 -273
data/example/output/the_adventure_of_the_beryl_coronet.html +0 -968
data/example/output/the_adventure_of_the_blue_carbuncle.html +0 -825
data/example/output/the_adventure_of_the_copper_beeches.html +0 -998
data/example/output/the_adventure_of_the_engineer_s_thumb.html +0 -851
data/example/output/the_adventure_of_the_noble_bachelor.html +0 -861
data/example/output/the_adventure_of_the_speckled_band.html +0 -1015
data/example/output/the_boscombe_valley_mystery.html +0 -974
data/example/output/the_first_chapter.html +0 -110
data/example/output/the_five_orange_pips.html +0 -776
data/example/output/the_man_with_the_twisted_lip.html +0 -946
data/example/output/the_red-headed_league.html +0 -950
data/example/output/the_second_chapter.html +0 -95
data/example/output/the_third_chapter.html +0 -58
data/example/output/tips_and_tricks.html +0 -452
data/example/output/title.html +0 -120
data/example/output/titles.html +0 -126

data/example/output/a_example_appendix.html DELETED Viewed

@@ -1,63 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-    <link rel="stylesheet" href="stylesheets/handbookish.css" type="text/css" />
-    <title>Page A. Example Appendix</title>
-  </head>
-  <body>
-    <table width="100%">
-      <tr><td width="33%" align="left">
-         <a href="the_third_chapter.html">Prev</a><br/>
-         The Third Chapter
-      </td><td width="33%" align="center">
-         <a href="index.html">Home</a><br/>
-      </td><td width="33%" align="right">
-          <a href="example_bibliography.html">Next</a><br/>
-          Example Bibliography
-      </td></tr>
-    </table>
-    <hr/>
-    <div class="appendix" lang="en" xml:lang="en">
-<div class="titlepage"><div><div><h2 class="title">
-<a id="_example_appendix"></a>A. Example Appendix</h2></div></div></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><h3 class="title">
-<a id="_appendix_sub_section"></a>Appendix Sub-section</h3></div></div></div>
-<p>Sub-section body.</p>
-</div>
-</div>
-    <hr/>
-    <table width="100%">
-      <tr><td width="33%" align="left">
-         <a href="the_third_chapter.html">Prev</a><br/>
-         The Third Chapter
-      </td><td width="33%" align="center">
-         <a href="index.html">Home</a><br/>
-      </td><td width="33%" align="right">
-          <a href="example_bibliography.html">Next</a><br/>
-          Example Bibliography
-      </td></tr>
-    </table>
-  </body>
-</html>

data/example/output/a_migration_notes.html DELETED Viewed

@@ -1,95 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-    <link rel="stylesheet" href="master.css" type="text/css" />
-    <title>A. Migration Notes</title>
-  </head>
-  <body>
-    <div class="nav" id="navheader">
-    <table width="100%">
-      <tr><td width="33%" align="left">
-         <a href="glossary.html">Prev</a><br/>
-         Glossary
-      </td><td width="33%" align="center">
-         <a href="index.html">Home</a><br/>
-         <strong>AsciiDoc User Guide</strong>
-      </td><td width="33%" align="right">
-          <a href="b_packager_notes.html">Next</a><br/>
-          B. Packager Notes
-      </td></tr>
-    </table>
-    </div>
-    <hr/>
-    <div class="content">
-      <div class="appendix" lang="en" xml:lang="en">
-<div class="titlepage"><div><div><h2 class="title">
-<a id="_migration_notes"></a>A. Migration Notes</h2></div></div></div>
-<div class="section" lang="en" xml:lang="en">
-<div class="titlepage"><div><div><h3 class="title">
-<a id="X53"></a>Version 7 to version 8</h3></div></div></div>
-<div class="itemizedlist"><ul type="disc">
-<li>
-A new set of quotes has been introduced which may match inline text
-  in existing documents — if they do you’ll need to escape the
-  matched text with backslashes.
-</li>
-<li>
-The index entry inline macro syntax has changed — if your documents
-  include indexes you may need to edit them.
-</li>
-<li>
-Replaced a2x(1) <code class="literal">--no-icons</code> and <code class="literal">--no-copy</code> options with their
-  negated equivalents: <code class="literal">--icons</code> and <code class="literal">--copy</code> respectively. The
-  default behavior has also changed — the use of icons and copying of
-  icon and CSS files must be specified explicitly with the <code class="literal">--icons</code>
-  and <code class="literal">--copy</code> options.
-</li>
-</ul></div>
-<p>The rationale for the changes can be found in the AsciiDoc
-<code class="literal">CHANGELOG</code>.</p>
-<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
-<h3 class="title">Note</h3>
-<p>If you want to disable unconstrained quotes, the new alternative
-constrained quotes syntax and the new index entry syntax then you can
-define the attribute <code class="literal">asciidoc7compatible</code> (for example by using the
-<code class="literal">-a asciidoc7compatible</code> command-line option).</p>
-</div>
-</div>
-</div>
-    </div>
-    <hr/>
-    <div class="nav" id="navfooter">
-    <table width="100%">
-      <tr><td width="33%" align="left">
-         <a href="glossary.html">Prev</a><br/>
-         Glossary
-      </td><td width="33%" align="center">
-         <a href="index.html">Home</a><br/>
-         AsciiDoc User Guide
-      </td><td width="33%" align="right">
-          <a href="b_packager_notes.html">Next</a><br/>
-          B. Packager Notes
-      </td></tr>
-    </table>
-    </div>
-  </body>
-</html>

data/example/output/apa.html DELETED Viewed

@@ -1,20 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>A. Migration Notes</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="go01.html" title="Glossary" /><link rel="next" href="apb.html" title="B. Packager Notes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">A. Migration Notes</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="go01.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apb.html">Next</a></td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_migration_notes"></a>A. Migration Notes</h2></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X53"></a>Version 7 to version 8</h3></div></div></div><div class="itemizedlist"><ul type="disc"><li>
-A new set of quotes has been introduced which may match inline text
-  in existing documents — if they do you’ll need to escape the
-  matched text with backslashes.
-</li><li>
-The index entry inline macro syntax has changed — if your documents
-  include indexes you may need to edit them.
-</li><li>
-Replaced a2x(1) <code class="literal">--no-icons</code> and <code class="literal">--no-copy</code> options with their
-  negated equivalents: <code class="literal">--icons</code> and <code class="literal">--copy</code> respectively. The
-  default behavior has also changed — the use of icons and copying of
-  icon and CSS files must be specified explicitly with the <code class="literal">--icons</code>
-  and <code class="literal">--copy</code> options.
-</li></ul></div><p>The rationale for the changes can be found in the AsciiDoc
-<code class="literal">CHANGELOG</code>.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>If you want to disable unconstrained quotes, the new alternative
-constrained quotes syntax and the new index entry syntax then you can
-define the attribute <code class="literal">asciidoc7compatible</code> (for example by using the
-<code class="literal">-a asciidoc7compatible</code> command-line option).</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="go01.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apb.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Glossary </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> B. Packager Notes</td></tr></table></div></body></html>

data/example/output/apb.html DELETED Viewed

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>B. Packager Notes</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="apa.html" title="A. Migration Notes" /><link rel="next" href="apc.html" title="C. AsciiDoc Safe Mode" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">B. Packager Notes</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="apa.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apc.html">Next</a></td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="X38"></a>B. Packager Notes</h2></div></div></div><p>Read the <code class="literal">README</code> and <code class="literal">INSTALL</code> files (in the distribution root
-directory) for install prerequisites and procedures.  The distribution
-<code class="literal">Makefile.in</code> (used by <code class="literal">configure</code> to generate the <code class="literal">Makefile</code>) is the
-canonical installation procedure.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apa.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apc.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">A. Migration Notes </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> C. AsciiDoc Safe Mode</td></tr></table></div></body></html>

data/example/output/apc.html DELETED Viewed

@@ -1,24 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>C. AsciiDoc Safe Mode</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="apb.html" title="B. Packager Notes" /><link rel="next" href="apd.html" title="D. Using AsciiDoc with non-English Languages" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">C. AsciiDoc Safe Mode</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="apb.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apd.html">Next</a></td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="X39"></a>C. AsciiDoc Safe Mode</h2></div></div></div><p>AsciiDoc <span class="emphasis"><em>safe mode</em></span> skips potentially dangerous scripted sections in
-AsciiDoc source files by inhibiting the execution of arbitrary code or
-the inclusion of arbitrary files.</p><p>The safe mode is disabled by default, it can be enabled with the
-asciidoc(1) <code class="literal">--safe</code> command-line option.</p><div class="itemizedlist"><p class="title"><b>Safe mode constraints</b></p><ul type="disc"><li>
-<code class="literal">eval</code>, <code class="literal">sys</code> and <code class="literal">sys2</code> executable attributes and block macros are
-  not executed.
-</li><li>
-<code class="literal">include::&lt;filename&gt;[]</code> and <code class="literal">include1::&lt;filename&gt;[]</code> block macro
-  files must reside inside the parent file’s directory.
-</li><li>
-<code class="literal">{include:&lt;filename&gt;}</code> executable attribute files must reside
-  inside the source document directory.
-</li><li>
-Passthrough Blocks are dropped.
-</li></ul></div><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>The safe mode is not designed to protect against unsafe AsciiDoc
-configuration files. Be especially careful when:</p><div class="orderedlist"><ol type="1"><li>
-Implementing filters.
-</li><li>
-Implementing elements that don’t escape special characters.
-</li><li>
-Accepting configuration files from untrusted sources.
-</li></ol></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apb.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apd.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">B. Packager Notes </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> D. Using AsciiDoc with non-English Languages</td></tr></table></div></body></html>

data/example/output/apd.html DELETED Viewed

@@ -1,30 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>D. Using AsciiDoc with non-English Languages</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="apc.html" title="C. AsciiDoc Safe Mode" /><link rel="next" href="ape.html" title="E. Vim Syntax Highlighter" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">D. Using AsciiDoc with non-English Languages</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="apc.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ape.html">Next</a></td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_using_asciidoc_with_non_english_languages"></a>D. Using AsciiDoc with non-English Languages</h2></div></div></div><p>AsciiDoc can process UTF-8 character sets but there are some things
-you need to be aware of:</p><div class="itemizedlist"><ul type="disc"><li><p>
-If you are generating output documents using a DocBook toolchain
-  then you should set the AsciiDoc <code class="literal">lang</code> attribute to the appropriate
-  language (it defaults to <code class="literal">en</code> (English)). This will ensure things
-  like table of contents, figure and table captions and admonition
-  captions are output in the specified language.  For example:
-</p><pre class="literallayout">$ a2x -a lang=es doc/article.txt</pre></li><li><p>
-If you are outputting HTML directly from asciidoc(1) you’ll
-  need to set the various <code class="literal">*_caption</code> attributes to match your target
-  language (see the list of captions and titles in the <code class="literal">[attributes]</code>
-  section of the distribution <code class="literal">lang-*.conf</code> files). The easiest way is
-  to create a language <code class="literal">.conf</code> file (see the AsciiDoc’s <code class="literal">lang-en.conf</code>
-  file).
-</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>You still use the <span class="emphasis"><em>NOTE</em></span>, <span class="emphasis"><em>CAUTION</em></span>, <span class="emphasis"><em>TIP</em></span>, <span class="emphasis"><em>WARNING</em></span>,
-<span class="emphasis"><em>IMPORTANT</em></span> captions in the AsciiDoc source, they get translated in
-the HTML output file.</p></div></li><li>
-asciidoc(1) automatically loads configuration files named like
-  <code class="literal">lang-&lt;lang&gt;.conf</code> where <code class="literal">&lt;lang&gt;</code> is a two letter language code that
-  matches the current AsciiDoc <code class="literal">lang</code> attribute. See also
-  <a class="link" href="ar01s22.html#X27" title="Configuration File Names and Locations">Configuration File Names and Locations</a>.
-</li><li>
-Some character sets display double-width characters (for example
-  Japanese). As far as <a class="link" href="ar01s08.html" title="Titles">title underlines</a> are concerned they
-  should be treated as single character.  If you think this looks
-  untidy so you may prefer to use the <a class="link" href="ar01s08.html#X46" title="One line titles">single line title</a>
-  format.
-</li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apc.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ape.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">C. AsciiDoc Safe Mode </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> E. Vim Syntax Highlighter</td></tr></table></div></body></html>

data/example/output/ape.html DELETED Viewed

@@ -1,26 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>E. Vim Syntax Highlighter</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="apd.html" title="D. Using AsciiDoc with non-English Languages" /><link rel="next" href="apf.html" title="F. Attribute Options" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">E. Vim Syntax Highlighter</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="apd.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apf.html">Next</a></td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="_vim_syntax_highlighter"></a>E. Vim Syntax Highlighter</h2></div></div></div><p>Syntax highlighting is incredibly useful, in addition to making
-reading AsciiDoc documents much easier syntax highlighting also helps
-you catch AsciiDoc syntax errors as you write your documents.</p><p>The AsciiDoc <code class="literal">./vim/</code> distribution directory contains Vim syntax
-highlighter and filetype detection scripts for AsciiDoc.  Syntax
-highlighting makes it much easier to spot AsciiDoc syntax errors.</p><p>If Vim is installed on your system the AsciiDoc installer
-(<code class="literal">install.sh</code>) will automatically install the vim scripts in the Vim
-global configuration directory (<code class="literal">/etc/vim</code>).</p><p>You can also turn on syntax highlighting by adding the following line
-to the end of you AsciiDoc source files:</p><pre class="literallayout">// vim: set syntax=asciidoc:</pre><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>Bold fonts are often easier to read, use the Vim <code class="literal">:set
-background=dark</code> command to set bold bright fonts.</p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>There are a number of alternative syntax highlighters for
-various editors listed on the <a class="ulink" href="http://www.methods.co.nz/asciidoc/" target="_top">AsciiDoc website</a>.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_limitations"></a>Limitations</h3></div></div></div><p>The current implementation does a reasonable job but on occasions gets
-things wrong:</p><div class="itemizedlist"><ul type="disc"><li>
-Nested quoted text formatting is highlighted according to the outer
-  format.
-</li><li>
-If a closing Example Block delimiter is sometimes mistaken for a
-  title underline. A workaround is to insert a blank line before the
-  closing delimiter.
-</li><li>
-Lines within a paragraph starting with equals characters may be
-  highlighted as single-line titles.
-</li><li>
-Lines within a paragraph beginning with a period may be highlighted
-  as block titles.
-</li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apd.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apf.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">D. Using AsciiDoc with non-English Languages </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> F. Attribute Options</td></tr></table></div></body></html>

data/example/output/apf.html DELETED Viewed

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>F. Attribute Options</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="ape.html" title="E. Vim Syntax Highlighter" /><link rel="next" href="apg.html" title="G. Diagnostics" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">F. Attribute Options</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ape.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="apg.html">Next</a></td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="X74"></a>F. Attribute Options</h2></div></div></div><p>Here is the list of predefined <a class="link" href="ar01s25.html#X75" title="Options attribute">attribute list options</a>:</p><div class="informaltable"><table border="1"><colgroup><col /><col /><col /><col /></colgroup><thead><tr><th align="left" valign="top">Option</th><th align="left" valign="top">Backends</th><th align="left" valign="top">AsciiDoc Elements</th><th align="left" valign="top">Description</th></tr></thead><tbody><tr><td align="left" valign="top"><p><span class="emphasis"><em>autowidth</em></span></p></td><td align="left" valign="top"><p>xhtml11,html4</p></td><td align="left" valign="top"><p>table</p></td><td align="left" valign="top"><p>The column widths are determined by the browser, not the AsciiDoc
-<span class="emphasis"><em>cols</em></span> attribute. If there is no <span class="emphasis"><em>width</em></span> attribute the table width is
-also left up to the browser.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>breakable, unbreakable</em></span></p></td><td align="left" valign="top"><p>docbook (XSL/FO)</p></td><td align="left" valign="top"><p>table, example, block image</p></td><td align="left" valign="top"><p>The <span class="emphasis"><em>breakable</em></span> options allows block elements to break across page
-boundaries; <span class="emphasis"><em>unbreakable</em></span> attempts to keep the block element together
-on a single page. If neither option is specified the default XSL
-stylesheet behavior prevails.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>compact</em></span></p></td><td align="left" valign="top"><p>docbook, xhtml11</p></td><td align="left" valign="top"><p>bulleted list, numbered list</p></td><td align="left" valign="top"><p>Minimizes vertical space in the list</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>footer</em></span></p></td><td align="left" valign="top"><p>docbook, xhtml11, html4</p></td><td align="left" valign="top"><p>table</p></td><td align="left" valign="top"><p>The last row of the table is rendered as a footer.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>header</em></span></p></td><td align="left" valign="top"><p>docbook, xhtml11, html4</p></td><td align="left" valign="top"><p>table</p></td><td align="left" valign="top"><p>The first row of the table is rendered as a header.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>pgwide</em></span></p></td><td align="left" valign="top"><p>docbook (XSL/FO)</p></td><td align="left" valign="top"><p>table, block image, horizontal labeled list</p></td><td align="left" valign="top"><p>Specifies that the element should be rendered across the full text
-width of the page irrespective of the current indentation.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>strong</em></span></p></td><td align="left" valign="top"><p>xhtml11,html4</p></td><td align="left" valign="top"><p>labeled lists</p></td><td align="left" valign="top"><p>Emboldens label text.</p></td></tr></tbody></table></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ape.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="apg.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">E. Vim Syntax Highlighter </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> G. Diagnostics</td></tr></table></div></body></html>

data/example/output/apg.html DELETED Viewed

@@ -1,42 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>G. Diagnostics</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="apf.html" title="F. Attribute Options" /><link rel="next" href="aph.html" title="H. Backend Attributes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">G. Diagnostics</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="apf.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="aph.html">Next</a></td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="X82"></a>G. Diagnostics</h2></div></div></div><p>The <code class="literal">asciidoc(1)</code> <code class="literal">--verbose</code> command-line option prints additional
-information to stderr: files processed, filters processed, warnings,
-system attribute evaluation.</p><p>A special attribute named <span class="emphasis"><em>trace</em></span> controls the output of diagnostic
-information. If the <span class="emphasis"><em>trace</em></span> attribute is defined then
-element-by-element diagnostic messages detailing output markup
-generation are printed to stderr. The <span class="emphasis"><em>trace</em></span> attribute can be set on
-the command-line or from within the document using <a class="link" href="ar01s24.html" title="Attribute Entries">Attribute Entries</a> (the latter allows tracing to be confined to specific
-portions of the document).</p><div class="itemizedlist"><ul type="disc"><li>
-Trace messages consist of a descriptive name followed by the related
-  markup.
-</li><li>
-The trace message is only printed if the <span class="emphasis"><em>trace</em></span> attribute value
-  matches the start of the trace name. The <span class="emphasis"><em>trace</em></span> attribute value can
-  be any Python regular expression.
-</li><li>
-A blank trace value matches all trace names and all trace messages
-  will be printed (this can result in large amounts of output if
-  applied to the whole document).
-</li><li><p>
-In the case of inline substitutions:
-</p><div class="itemizedlist"><ul type="circle"><li>
-The text before and after the substitution are printed delineated
-    by <code class="literal">&lt;&lt;&lt;</code> and <code class="literal">&gt;&gt;&gt;</code> delimiters.
-</li><li>
-The message is only printed if a substitution is made.
-</li><li>
-The <span class="emphasis"><em>subs</em></span> trace value is an alias for all inline substitutions.
-</li></ul></div></li></ul></div><p>Command-line examples:</p><div class="orderedlist"><ol type="1"><li><p>
-Trace the entire document.
-</p><pre class="literallayout">$ asciidoc -a trace mydoc.txt</pre></li><li><p>
-Trace messages whose names start with <code class="literal">quotes</code> or <code class="literal">macros</code>:
-</p><pre class="literallayout">$ asciidoc -a 'trace=quotes|macros'  mydoc.txt</pre></li><li><p>
-Print the first line of all trace messages:
-</p><pre class="literallayout">$ asciidoc -a trace mydoc.txt 2&gt;&amp;1 | grep ^TRACE:</pre></li></ol></div><p>Attribute Entry examples:</p><div class="orderedlist"><ol type="1"><li><p>
-Begin printing all trace messages:
-</p><pre class="literallayout">:trace:</pre></li><li><p>
-Print only matched trace messages:
-</p><pre class="literallayout">:trace: quotes|macros</pre></li><li><p>
-Turn trace messages off:
-</p><pre class="literallayout">:trace!:</pre></li></ol></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apf.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="aph.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">F. Attribute Options </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> H. Backend Attributes</td></tr></table></div></body></html>

data/example/output/aph.html DELETED Viewed

@@ -1,89 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>H. Backend Attributes</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="apg.html" title="G. Diagnostics" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">H. Backend Attributes</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="apg.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> </td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="X88"></a>H. Backend Attributes</h2></div></div></div><p>This table contains a list of optional attributes that influence the
-generated outputs.</p><div class="informaltable"><table border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th align="left" valign="top">Name </th><th align="left" valign="top">Backends </th><th align="left" valign="top">Description</th></tr></thead><tbody><tr><td align="left" valign="top"><p><span class="emphasis"><em>badges</em></span></p></td><td align="left" valign="top"><p>xhtml11</p></td><td align="left" valign="top"><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
-footers. By default badges are omitted (<span class="emphasis"><em>badges</em></span> is undefined).</p>
-<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The path names of images, icons and scripts are relative path
-names to the output document not the source document.</p></div></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>data-uri</em></span></p></td><td align="left" valign="top"><p>xhtml11</p></td><td align="left" valign="top"><p>Embed images using the <a class="link" href="ar01s18.html#X66" title="Embedding images in XHTML documents">data: uri scheme</a>.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>disable-javascript</em></span></p></td><td align="left" valign="top"><p>xhtml11</p></td><td align="left" valign="top"><p>If the <code class="literal">disable-javascript</code> attribute is defined the <code class="literal">asciidoc.js</code>
-JavaScript is not embedded or linked to the output document.  By
-default AsciiDoc automatically embeds or links the <code class="literal">asciidoc.js</code>
-JavaScript to the <span class="emphasis"><em>xhtml11</em></span> output document. The script dynamically
-generates <a class="link" href="aph.html#X91">table of contents</a> and <a class="link" href="ar01s15.html" title="Footnotes">footnotes</a>.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em><a id="X97"></a> docinfo, docinfo1, docinfo2</em></span></p></td><td align="left" valign="top"><p>All backends</p></td><td align="left" valign="top"><p>These three attributes control which <a class="link" href="ar01s05.html#X87" title="Additional document header information">document information files</a> will be included in the the header of the output file:</p>
-<div class="variablelist"><dl><dt><span class="term">
-docinfo
-</span></dt><dd>
-Include <code class="literal">&lt;filename&gt;-docinfo.&lt;ext&gt;</code>
-</dd><dt><span class="term">
-docinfo1
-</span></dt><dd>
-Include <code class="literal">docinfo.&lt;ext&gt;</code>
-</dd><dt><span class="term">
-docinfo2
-</span></dt><dd>
-Include <code class="literal">docinfo.&lt;ext&gt;</code> and <code class="literal">&lt;filename&gt;-docinfo.&lt;ext&gt;</code>
-</dd></dl></div>
-<p>Where <code class="literal">&lt;filename&gt;</code> is the file name of (sans extension) of the
-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>
-for DocBook outputs. The following example will include the
-<code class="literal">mydoc-docinfo.xml</code> docinfo file in the DocBook <code class="literal">mydoc.xml</code> output
-file:</p>
-<pre class="literallayout">$ asciidoc -a docinfo -b docbook mydoc.txt</pre>
-<p>This next example will include <code class="literal">docinfo.html</code> and <code class="literal">mydoc-docinfo.html</code>
-docinfo files in the HTML output file:</p>
-<pre class="literallayout">$ asciidoc -a docinfo2 -b html4 mydoc.txt</pre></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em><a id="X54"></a>encoding</em></span></p></td><td align="left" valign="top"><p>html4, xhtml11, docbook</p></td><td align="left" valign="top"><p>Set the input and output document character set encoding. For example
-the <code class="literal">--attribute encoding=ISO-8859-1</code> command-line option will set the
-character set encoding to <code class="literal">ISO-8859-1</code>.</p>
-<div class="itemizedlist"><ul type="disc"><li>
-The default encoding is UTF-8.
-</li><li>
-This attribute specifies the character set in the output document.
-</li><li>
-The encoding name must correspond to a Python codec name or alias.
-</li><li><p>
-The <span class="emphasis"><em>encoding</em></span> attribute can be set using an AttributeEntry inside
-  the document header. For example:
-</p><pre class="literallayout">:encoding: ISO-8859-1</pre></li></ul></div></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em><a id="X45"></a>icons</em></span></p></td><td align="left" valign="top"><p>xhtml11</p></td><td align="left" valign="top"><p>Link admonition paragraph and admonition block icon images and badge
-images. By default <span class="emphasis"><em>icons</em></span> is undefined and text is used in place of
-icon images.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em><a id="X44"></a>iconsdir</em></span></p></td><td align="left" valign="top"><p>html4, xhtml11, docbook</p></td><td align="left" valign="top"><p>The name of the directory containing linked admonition and navigation
-icons. Defaults to <code class="literal">./images/icons</code>.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>imagesdir</em></span></p></td><td align="left" valign="top"><p>html4, xhtml11, docbook</p></td><td align="left" valign="top"><p>If this attribute is defined it is prepended to the target image file
-name paths in inline and block image macros.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>keywords, description, title</em></span></p></td><td align="left" valign="top"><p>html4, xhtml11</p></td><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
-named HTML meta tag contents; the <span class="emphasis"><em>title</em></span> attribute sets the HTML
-title tag contents.  Their principle use is for SEO (Search Engine
-Optimisation).  All three are optional, but if they are used they must
-appear in the document header (or on the command-line). If <span class="emphasis"><em>title</em></span> is
-not specified the AsciiDoc document title is used.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>linkcss</em></span></p></td><td align="left" valign="top"><p>xhtml11</p></td><td align="left" valign="top"><p>Link CSS stylesheets and JavaScripts (see the <span class="emphasis"><em>stylesdir</em></span> and
-<span class="emphasis"><em>scriptsdir</em></span> attributes below). By default <span class="emphasis"><em>linkcss</em></span> is undefined in
-which case stylesheets and scripts are automatically embedded in the
-output document.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>max-width</em></span></p></td><td align="left" valign="top"><p>xhtml11</p></td><td align="left" valign="top"><p>Set the document maximum display width (sets the <span class="emphasis"><em>body</em></span> element CSS
-<span class="emphasis"><em>max-width</em></span> property).</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>numbered</em></span></p></td><td align="left" valign="top"><p>html4, xhtml11, docbook (XSL Stylesheets)</p></td><td align="left" valign="top"><p>Adds section numbers to section titles. The <span class="emphasis"><em>docbook</em></span> backend ignores
-<span class="emphasis"><em>numbered</em></span> attribute entries after the document header.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>plaintext</em></span></p></td><td align="left" valign="top"><p>All backends</p></td><td align="left" valign="top"><p>If this global attribute is defined all inline substitutions are
-suppressed and block indents are retained.  This option is useful when
-dealing with large amounts of imported plain text.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>quirks</em></span></p></td><td align="left" valign="top"><p>xhtml11</p></td><td align="left" valign="top"><p>Include the <code class="literal">xhtml11-quirks.css</code> <a class="link" href="ar01s04.html#X35" title="XHTML Stylesheets">stylesheet</a> to work around IE6
-browser incompatibilities.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>revremark</em></span></p></td><td align="left" valign="top"><p>docbook</p></td><td align="left" valign="top"><p>A short summary of changes in this document revision. Must be defined
-prior to the first document section. The document also needs to be
-dated to output this attribute.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>scriptsdir</em></span></p></td><td align="left" valign="top"><p>xhtml11</p></td><td align="left" valign="top"><p>The name of the directory containing linked JavaScripts. Defaults to
-<code class="literal">.</code> (the same directory as the linking document).</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>sgml</em></span></p></td><td align="left" valign="top"><p>docbook45</p></td><td align="left" valign="top"><p>The <code class="literal">--backend=docbook45</code> command-line option produces DocBook 4.5
-XML.  You can produce the older DocBook SGML format using the
-<code class="literal">--attribute sgml</code> command-line option.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>stylesdir</em></span></p></td><td align="left" valign="top"><p>xhtml11</p></td><td align="left" valign="top"><p>The name of the directory containing linked stylesheets. Defaults to
-<code class="literal">.</code> (the same directory as the linking document).</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>stylesheet</em></span></p></td><td align="left" valign="top"><p>xhtml11</p></td><td align="left" valign="top"><p>The file name of an optional additional CSS stylesheet. If you are
-embedding the stylesheet specify the actual file location; if you are
-linking CSS specify the file name relative to the directory specified
-by the <span class="emphasis"><em>stylesdir</em></span> attribute.</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>theme</em></span></p></td><td align="left" valign="top"><p>xhtml11</p></td><td align="left" valign="top"><p>Use alternative stylesheets (see <a class="link" href="ar01s04.html#X35" title="XHTML Stylesheets">Stylesheets</a>).</p></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em><a id="X91"></a>toc</em></span></p></td><td align="left" valign="top"><p>xhtml11, docbook (XSL Stylesheets)</p></td><td align="left" valign="top"><p>Adds a table of contents to the start of an article or book document.
-The <code class="literal">toc</code> attribute can be specified using the <code class="literal">--attribute toc</code>
-command-line option or a <code class="literal">:toc:</code> attribute entry in the document
-header. The <span class="emphasis"><em>toc</em></span> attribute is defined by default when the <span class="emphasis"><em>docbook</em></span>
-backend is used. To disable table of contents generation undefine the
-<span class="emphasis"><em>toc</em></span> attribute by putting a <code class="literal">:toc!:</code> attribute entry in the document
-header or from the command-line with an <code class="literal">--attribute toc!</code> option.</p>
-<p><span class="strong"><strong>xhtml11 backend</strong></span></p>
-<div class="itemizedlist"><ul type="disc"><li>
-JavaScript needs to be enabled in your browser.
-</li><li><p>
-The following example generates a numbered table of contents using a
-  JavaScript embedded in the <code class="literal">mydoc.html</code> output document (to link the
-  script to the output document use the <span class="emphasis"><em>linkcss</em></span> and <span class="emphasis"><em>scriptsdir</em></span>
-  attributes):
-</p><pre class="literallayout">$ asciidoc -a toc -a numbered mydoc.txt</pre></li></ul></div></td></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>toc-title</em></span></p></td><td align="left" valign="top"><p>xhtml11</p></td><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></tr><tr><td align="left" valign="top"><p><span class="emphasis"><em>toclevels</em></span></p></td><td align="left" valign="top"><p>xhtml11</p></td><td align="left" valign="top"><p>Sets the number of title levels (1..4) reported in the table of
-contents (see the <span class="emphasis"><em>toc</em></span> attribute above). Defaults to 2 and must be
-used with the <span class="emphasis"><em>toc</em></span> attribute. Example usage:</p>
-<pre class="literallayout">$ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt</pre></td></tr></tbody></table></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="apg.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">G. Diagnostics </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>

data/example/output/ar01s02.html DELETED Viewed

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Getting Started</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="index.html" title="AsciiDoc User Guide" /><link rel="next" href="ar01s03.html" title="AsciiDoc Document Types" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Getting Started</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s03.html">Next</a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="X6"></a>Getting Started</h2></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_installing_asciidoc"></a>Installing AsciiDoc</h3></div></div></div><p>See the <code class="literal">README</code> and <code class="literal">INSTALL</code> files for install prerequisites and
-procedures. Packagers take a look at <a class="link" href="apb.html" title="B. Packager Notes">Packager Notes</a>.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X11"></a>Example AsciiDoc Documents</h3></div></div></div><p>The best way to quickly get a feel for AsciiDoc is to view the
-AsciiDoc web site and/or distributed examples:</p><div class="itemizedlist"><ul type="disc"><li>
-Take a look at the linked examples on the AsciiDoc web site home
-  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
-  corresponding AsciiDoc source.
-</li><li>
-Read the <code class="literal">*.txt</code> source files in the distribution <code class="literal">./doc</code> directory
-  along with the corresponding HTML and DocBook XML files.
-</li></ul></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">AsciiDoc User Guide </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> AsciiDoc Document Types</td></tr></table></div></body></html>

data/example/output/ar01s03.html DELETED Viewed

@@ -1,34 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>AsciiDoc Document Types</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="ar01s02.html" title="Getting Started" /><link rel="next" href="ar01s04.html" title="AsciiDoc Backends" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">AsciiDoc Document Types</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s02.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s04.html">Next</a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_asciidoc_document_types"></a>AsciiDoc Document Types</h2></div></div></div><p>There are three types of AsciiDoc documents: article, book and
-manpage. All document types share the same AsciiDoc format with some
-minor variations. If you are familiar with DocBook you will have
-noticed that AsciiDoc document types correspond to the same-named
-DocBook document types).</p><p>Use the asciidoc(1) <code class="literal">-d</code> (<code class="literal">--doctype</code>) option to specify the AsciiDoc
-document type — the default document type is <span class="emphasis"><em>article</em></span>.</p><p>By convention the <code class="literal">.txt</code> file extension is used for AsciiDoc document
-source files.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_article"></a>article</h3></div></div></div><p>Used for short documents, articles and general documentation.  See the
-AsciiDoc distribution <code class="literal">./doc/article.txt</code> example.</p><p>AsciiDoc defines standard DocBook article frontmatter and backmatter
-<a class="link" href="ar01s05.html#X93" title="Section markup templates">section markup templates</a> (appendix, abstract, bibliography,
-glossary, index).</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_book"></a>book</h3></div></div></div><p>Books share the same format as articles, with the following
-differences:</p><div class="itemizedlist"><ul type="disc"><li>
-The part titles in multi-part books are <a class="link" href="ar01s08.html" title="Titles">top level titles</a>
-  (same level as book title).
-</li><li>
-Some sections are book specific e.g. preface and colophon.
-</li></ul></div><p>Book documents will normally be used to produce DocBook output since
-DocBook processors can automatically generate footnotes, table of
-contents, list of tables, list of figures, list of examples and
-indexes.</p><p>AsciiDoc defines standard DocBook book frontmatter and backmatter
-<a class="link" href="ar01s05.html#X93" title="Section markup templates">section markup templates</a> (appendix, dedication, preface,
-bibliography, glossary, index, colophon).</p><div class="variablelist"><p class="title"><b>Example book documents</b></p><dl><dt><span class="term">
-Book
-</span></dt><dd>
-  The <code class="literal">./doc/book.txt</code> file in the AsciiDoc distribution.
-</dd><dt><span class="term">
-Multi-part book
-</span></dt><dd>
-  The <code class="literal">./doc/book-multi.txt</code> file in the AsciiDoc distribution.
-</dd></dl></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_manpage"></a>manpage</h3></div></div></div><p>Used to generate roff format UNIX manual pages.  AsciiDoc manpage
-documents observe special header title and section naming conventions — see the <a class="link" href="ar01s20.html" title="Manpage Documents">Manpage Documents</a> section for details.</p><p>AsciiDoc defines the <span class="emphasis"><em>synopsis</em></span> <a class="link" href="ar01s05.html#X93" title="Section markup templates">section markup template</a> to
-generate the DocBook <code class="literal">refsynopsisdiv</code> section.</p><p>See also the asciidoc(1) man page source (<code class="literal">./doc/asciidoc.1.txt</code>) from
-the AsciiDoc distribution.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s02.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s04.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Getting Started </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> AsciiDoc Backends</td></tr></table></div></body></html>