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/ar01s28.html DELETED Viewed

@@ -1,237 +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>Block Element Definitions</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="ar01s27.html" title="Intrinsic Attributes" /><link rel="next" href="ar01s29.html" title="Filters" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Block Element Definitions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s27.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s29.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="X73"></a>Block Element Definitions</h2></div></div></div><p>The syntax and behavior of Paragraph, DelimitedBlock, List and Table
-block elements is determined by block definitions contained in
-<a class="link" href="ar01s22.html" title="Configuration Files">AsciiDoc configuration file</a> sections.</p><p>Each definition consists of a section title followed by one or more
-section entries. Each entry defines a block parameter controlling some
-aspect of the block’s behavior. Here’s an example:</p><pre class="screen">[blockdef-listing]
-delimiter=^-{4,}$
-template=listingblock
-presubs=specialcharacters,callouts</pre><p>AsciiDoc Paragraph, DelimitedBlock, List and Table block elements
-share a common subset of configuration file parameters:</p><div class="variablelist"><dl><dt><span class="term">
-delimiter
-</span></dt><dd>
-  A Python regular expression that matches the first line of a block
-  element — in the case of DelimitedBlocks and Tables it also matches
-  the last line.
-</dd><dt><span class="term">
-template
-</span></dt><dd>
-  The name of the configuration file markup template section that will
-  envelope the block contents. The pipe (<span class="emphasis"><em>|</em></span>) character is substituted
-  for the block contents. List elements use a set of (list specific)
-  tag parameters instead of a single template. The template name can
-  contain attribute references allowing dynamic template selection a
-  the time of template substitution.
-</dd><dt><span class="term">
-options
-</span></dt><dd>
-  A comma delimited list of element specific option names. In addition
-  to being used internally, options are available during markup tag
-  and template substitution as attributes with an empty string value
-  named like <code class="literal">&lt;option&gt;-option</code> (where <code class="literal">&lt;option&gt;</code> is the option name).
-  See <a class="link" href="apf.html" title="F. Attribute Options">attribute options</a> for a complete list of available
-  options.
-</dd><dt><span class="term">
-subs, presubs, postsubs
-</span></dt><dd><div class="itemizedlist"><ul type="disc"><li>
-<span class="emphasis"><em>presubs</em></span> and <span class="emphasis"><em>postsubs</em></span> are lists of comma separated substitutions that are
-    performed on the block contents. <span class="emphasis"><em>presubs</em></span> is applied first,
-    <span class="emphasis"><em>postsubs</em></span> (if specified) second.
-</li><li>
-<span class="emphasis"><em>subs</em></span> is an alias for <span class="emphasis"><em>presubs</em></span>.
-</li><li>
-If a <span class="emphasis"><em>filter</em></span> is allowed (Paragraphs, DelimitedBlocks and Tables)
-    and has been specified then <span class="emphasis"><em>presubs</em></span> and <span class="emphasis"><em>postsubs</em></span> substitutions
-    are performed before and after the filter is run respectively.
-</li><li>
-Allowed values: <span class="emphasis"><em>specialcharacters</em></span>, <span class="emphasis"><em>quotes</em></span>, <span class="emphasis"><em>specialwords</em></span>,
-    <span class="emphasis"><em>replacements</em></span>, <span class="emphasis"><em>macros</em></span>, <span class="emphasis"><em>attributes</em></span>, <span class="emphasis"><em>callouts</em></span>.
-</li><li><p>
-The following composite values are also allowed:
-</p><div class="variablelist"><dl><dt><span class="term">
-<span class="emphasis"><em>none</em></span>
-</span></dt><dd>
-        No substitutions.
-</dd><dt><span class="term">
-<span class="emphasis"><em>normal</em></span>
-</span></dt><dd>
-        The following substitutions:
-        <span class="emphasis"><em>specialcharacters</em></span>,<span class="emphasis"><em>quotes</em></span>,<span class="emphasis"><em>attributes</em></span>,<span class="emphasis"><em>specialwords</em></span>,
-        <span class="emphasis"><em>replacements</em></span>,<span class="emphasis"><em>macros</em></span>.
-</dd><dt><span class="term">
-<span class="emphasis"><em>verbatim</em></span>
-</span></dt><dd>
-        <span class="emphasis"><em>specialcharacters</em></span> and <span class="emphasis"><em>callouts</em></span> substitutions.
-</dd></dl></div></li><li>
-<span class="emphasis"><em>normal</em></span> and <span class="emphasis"><em>verbatim</em></span> substitutions can be redefined by with
-    <code class="literal">subsnormal</code> and <code class="literal">subsverbatim</code> entries in a configuration file
-    <code class="literal">[miscellaneous]</code> section.
-</li><li>
-The substitutions are processed in the order in which they are
-    listed and can appear more than once.
-</li></ul></div></dd><dt><span class="term">
-filter
-</span></dt><dd>
-  This optional entry specifies an executable shell command for
-  processing block content (Paragraphs, DelimitedBlocks and Tables).
-  The filter command can contain attribute references.
-</dd><dt><span class="term">
-posattrs
-</span></dt><dd><p>
-  Optional comma separated list of positional attribute names. This
-  list maps positional attributes (in the block’s <a class="link" href="ar01s25.html" title="Attribute Lists">attribute   list</a>) to named block attributes. The following example, from the
-  QuoteBlock definition, maps the first and section positional
-  attributes:
-</p><pre class="literallayout">posattrs=attribution,citetitle</pre></dd><dt><span class="term">
-style
-</span></dt><dd>
-  This optional parameter specifies the default style name.
-</dd><dt><span class="term">
-&lt;stylename&gt;-style
-</span></dt><dd>
-  Optional style definition (see <a class="link" href="ar01s28.html#X23" title="Styles">Styles</a> below).
-</dd></dl></div><p>The following block parameters behave like document attributes and can
-be set in block attribute lists and style definitions: <span class="emphasis"><em>template</em></span>,
-<span class="emphasis"><em>options</em></span>, <span class="emphasis"><em>subs</em></span>, <span class="emphasis"><em>presubs</em></span>, <span class="emphasis"><em>postsubs</em></span>, <span class="emphasis"><em>filter</em></span>.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X23"></a>Styles</h3></div></div></div><p>A style is a set of block attributes bundled as a single named
-attribute. The following example defines a style named <span class="emphasis"><em>verbatim</em></span>:</p><pre class="literallayout">verbatim-style=template="literalblock",subs="verbatim"</pre><div class="itemizedlist"><ul type="disc"><li>
-All style parameter names must be suffixed with <code class="literal">-style</code> and the
-  style parameter value is in the form of a list of <a class="link" href="ar01s25.html" title="Attribute Lists">named   attributes</a>.
-</li><li>
-Multi-item style attributes (<span class="emphasis"><em>subs</em></span>,<span class="emphasis"><em>presubs</em></span>,<span class="emphasis"><em>postsubs</em></span>,<span class="emphasis"><em>posattrs</em></span>)
-  must be specified using Python tuple syntax rather than a simple
-  list of values as they in separate entries e.g.
-  <code class="literal">postsubs=("callouts",)</code> not <code class="literal">postsubs="callouts"</code>.
-</li></ul></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_paragraphs_2"></a>Paragraphs</h3></div></div></div><p>Paragraph translation is controlled by <code class="literal">[paradef-*]</code> configuration
-file section entries. Users can define new types of paragraphs and
-modify the behavior of existing types by editing AsciiDoc
-configuration files.</p><p>Here is the shipped Default paragraph definition:</p><pre class="screen">[paradef-default]
-delimiter=(?P&lt;text&gt;\S.*)
-template=paragraph</pre><p>The normal paragraph definition has a couple of special properties:</p><div class="orderedlist"><ol type="1"><li>
-It must exist and be defined in a configuration file section named
-   <code class="literal">[paradef-default]</code>.
-</li><li>
-Irrespective of its position in the configuration files default
-   paragraph document matches are attempted only after trying all
-   other paragraph types.
-</li></ol></div><p>Paragraph specific block parameter notes:</p><div class="variablelist"><dl><dt><span class="term">
-delimiter
-</span></dt><dd>
-  This regular expression must contain the named group <span class="emphasis"><em>text</em></span> which
-  matches the text on the first line.  Paragraphs are terminated by a
-  blank line, the end of file, or the start of a DelimitedBlock.
-</dd><dt><span class="term">
-options
-</span></dt><dd>
-  The <span class="emphasis"><em>listelement</em></span> option specifies that paragraphs of this type will
-  automatically be considered part of immediately preceding list
-  items.
-</dd></dl></div><div class="orderedlist"><p class="title"><b>Paragraph processing proceeds as follows:</b></p><ol type="1"><li>
-The paragraph text is aligned to the left margin.
-</li><li>
-Optional <span class="emphasis"><em>presubs</em></span> inline substitutions are performed on the
-   paragraph text.
-</li><li>
-If a filter command is specified it is executed and the paragraph
-   text piped to its standard input; the filter output replaces the
-   paragraph text.
-</li><li>
-Optional <span class="emphasis"><em>postsubs</em></span> inline substitutions are performed on the
-   paragraph text.
-</li><li>
-The paragraph text is enveloped by the paragraph’s markup template
-   and written to the output file.
-</li></ol></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_delimited_blocks_2"></a>Delimited Blocks</h3></div></div></div><p>DelimitedBlock <span class="emphasis"><em>options</em></span> values are:</p><div class="variablelist"><dl><dt><span class="term">
-sectionbody
-</span></dt><dd>
-    The block contents are processed as a SectionBody.
-</dd><dt><span class="term">
-skip
-</span></dt><dd>
-    The block is treated as a comment (see <a class="link" href="ar01s13.html#X26" title="Comment Blocks">CommentBlocks</a>).
-</dd></dl></div><p><span class="emphasis"><em>presubs</em></span>, <span class="emphasis"><em>postsubs</em></span> and <span class="emphasis"><em>filter</em></span> entries are ignored when
-<span class="emphasis"><em>sectionbody</em></span> or <span class="emphasis"><em>skip</em></span> options are set.</p><p>DelimitedBlock processing proceeds as follows:</p><div class="orderedlist"><ol type="1"><li>
-Optional <span class="emphasis"><em>presubs</em></span> substitutions are performed on the block
-   contents.
-</li><li>
-If a filter is specified it is executed and the block’s contents
-   piped to its standard input. The filter output replaces the block
-   contents.
-</li><li>
-Optional <span class="emphasis"><em>postsubs</em></span> substitutions are performed on the block
-   contents.
-</li><li>
-The block contents is enveloped by the block’s markup template and
-   written to the output file.
-</li></ol></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>Attribute expansion is performed on the block filter command
-before it is executed, this is useful for passing arguments to the
-filter.</p></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_lists"></a>Lists</h3></div></div></div><p>List behavior and syntax is determined by <code class="literal">[listdef-*]</code> configuration
-file sections. The user can change existing list behavior and add new
-list types by editing configuration files.</p><p>List specific block definition notes:</p><div class="variablelist"><dl><dt><span class="term">
-type
-</span></dt><dd>
-  This is either <span class="emphasis"><em>bulleted</em></span>,<span class="emphasis"><em>numbered</em></span>,<span class="emphasis"><em>labeled</em></span> or <span class="emphasis"><em>callout</em></span>.
-</dd><dt><span class="term">
-delimiter
-</span></dt><dd>
-  A Python regular expression that matches the first line of a
-  list element entry. This expression can contain the named groups
-  <span class="emphasis"><em>text</em></span> (bulleted groups), <span class="emphasis"><em>index</em></span> and <span class="emphasis"><em>text</em></span> (numbered lists),
-  <span class="emphasis"><em>label</em></span> and <span class="emphasis"><em>text</em></span> (labeled lists).
-</dd><dt><span class="term">
-tags
-</span></dt><dd>
-  The <code class="literal">&lt;name&gt;</code> of the <code class="literal">[listtags-&lt;name&gt;]</code> configuration file section
-  containing list markup tag definitions.  The tag entries (<span class="emphasis"><em>list</em></span>,
-  <span class="emphasis"><em>entry</em></span>, <span class="emphasis"><em>label</em></span>, <span class="emphasis"><em>term</em></span>, <span class="emphasis"><em>text</em></span>) map the AsciiDoc list structure to
-  backend markup; see the <span class="emphasis"><em>listtags</em></span> sections in the AsciiDoc
-  distributed backend <code class="literal">.conf</code> configuration files for examples.
-</dd></dl></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_tables_2"></a>Tables</h3></div></div></div><p>Table behavior and syntax is determined by <code class="literal">[tabledef-*]</code> and
-<code class="literal">[tabletags-*]</code> configuration file sections. The user can change
-existing table behavior and add new table types by editing
-configuration files.  The following <code class="literal">[tabledef-*]</code> section entries
-generate table output markup elements:</p><div class="variablelist"><dl><dt><span class="term">
-colspec
-</span></dt><dd>
-  The table <span class="emphasis"><em>colspec</em></span> tag definition.
-</dd><dt><span class="term">
-headrow, footrow, bodyrow
-</span></dt><dd>
-  Table header, footer and body row tag definitions. <span class="emphasis"><em>headrow</em></span> and
-  <span class="emphasis"><em>footrow</em></span> table definition entries default to <span class="emphasis"><em>bodyrow</em></span> if
-  they are undefined.
-</dd><dt><span class="term">
-headdata, footdata, bodydata
-</span></dt><dd>
-  Table header, footer and body data tag definitions. <span class="emphasis"><em>headdata</em></span> and
-  <span class="emphasis"><em>footdata</em></span> table definition entries default to <span class="emphasis"><em>bodydata</em></span> if they
-  are undefined.
-</dd><dt><span class="term">
-paragraph
-</span></dt><dd>
-  If the <span class="emphasis"><em>paragraph</em></span> tag is specified then blank lines in the cell
-  data are treated as paragraph delimiters and marked up using this
-  tag.
-</dd></dl></div><p><a id="X4"></a>Table behavior is also influenced by the following <code class="literal">[miscellaneous]</code>
-configuration file entries:</p><div class="variablelist"><dl><dt><span class="term">
-pagewidth
-</span></dt><dd>
-  This integer value is the printable width of the output media. See
-  <a class="link" href="ar01s19.html#X69" title="Table attributes">table attributes</a>.
-</dd><dt><span class="term">
-pageunits
-</span></dt><dd>
-  The units of width in output markup width attribute values.
-</dd></dl></div><div class="itemizedlist"><p class="title"><b>Table definition behavior</b></p><ul type="disc"><li>
-The output markup generation is specifically designed to work with
-  the HTML and CALS (DocBook) table models, but should be adaptable to
-  most XML table schema.
-</li><li>
-Table definitions can be “mixed in” from multiple cascading
-  configuration files.
-</li><li>
-New table definitions inherit the default table and table tags
-  definitions (<code class="literal">[tabledef-default]</code> and <code class="literal">[tabletags-default]</code>) so you
-  only need to override those conf file entries that require
-  modification.
-</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="ar01s27.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s29.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Intrinsic Attributes </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Filters</td></tr></table></div></body></html>

data/example/output/ar01s29.html DELETED Viewed

@@ -1,68 +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>Filters</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="ar01s28.html" title="Block Element Definitions" /><link rel="next" href="ar01s30.html" title="Converting DocBook to other file formats" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Filters</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s28.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s30.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="X59"></a>Filters</h2></div></div></div><p>Filters are external shell commands used to process Paragraph,
-DelimitedBlock and Table content and are specified in the
-corresponding configuration file definitions.</p><p>There’s nothing special about the filters, they’re just standard UNIX
-filters: they read text from the standard input, process it, and write
-to the standard output.</p><p>Attribute substitution is performed on the filter command prior to
-execution — attributes can be used to pass parameters from the
-AsciiDoc source document to the filter.</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>Filters can potentially generate unsafe output. Before
-installing a filter you should verify that it is from a trusted
-source.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_filter_search_paths"></a>Filter Search Paths</h3></div></div></div><p>If the filter command does not specify a directory path then
-asciidoc(1) searches for the command:</p><div class="itemizedlist"><ul type="disc"><li>
-First it looks in the user’s <code class="literal">$HOME/.asciidoc/filters</code> directory.
-</li><li>
-Next the global filters directory (usually <code class="literal">/etc/asciidoc/filters</code>
-  or <code class="literal">/usr/local/etc/asciidoc</code>) directory is searched.
-</li><li>
-Then it looks in the asciidoc(1) <code class="literal">./filters</code> directory.
-</li><li>
-Finally it relies on the executing shell to search the environment
-  search path (<code class="literal">$PATH</code>).
-</li></ul></div><p>Sub-directories are also included in the searches — standard practice
-is to install each filter in it’s own sub-directory with the same name
-as the filter’s style definition. For example the music filter’s style
-name is <span class="emphasis"><em>music</em></span> so it’s configuration and filter files are stored in
-the <code class="literal">filters/music</code> directory.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_filter_configuration_files"></a>Filter Configuration Files</h3></div></div></div><p>Filters are normally accompanied by a configuration file containing a
-Paragraph or DelimitedBlock definition along with corresponding markup
-templates.</p><p>While it is possible to create new Paragraph or DelimitedBlock
-definitions the preferred way to implement a filter is to add a
-<a class="link" href="ar01s28.html#X23" title="Styles">style</a> to the existing Paragraph and ListingBlock definitions
-(all filters shipped with AsciiDoc use this technique). The filter is
-applied to the paragraph or delimited block by preceding it with an
-attribute list: the first positional attribute is the style name,
-remaining attributes are normally filter specific parameters.</p><p>asciidoc(1) auto-loads all <code class="literal">.conf</code> files found in the filter search
-paths (see previous section).</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X56"></a>Code Filter</h3></div></div></div><p>AsciiDoc comes with a toy filter for highlighting source code keywords
-and comments.  See also the <code class="literal">./filters/code/code-filter-readme.txt</code>
-file.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This filter primarily to demonstrate how to write a filter — it’s much to simplistic to be passed off as a code syntax highlighter.
-If you want a full featured multi-language highlighter use the
-<a class="link" href="ar01s29.html#X57" title="Source Code Highlighter Filter">Source Code Highlighter Filter</a>.</p></div><pre class="screen">.Code filter example
-[code,python]
-----------------------------------------------
-''' A multi-line
-    comment.'''
-def sub_word(mo):
-    ''' Single line comment.'''
-    word = mo.group('word')   # Inline comment
-    if word in keywords[language]:
-        return quote + word + quote
-    else:
-        return word
-----------------------------------------------</pre><p>Outputs:</p><p><b>Code filter example. </b>
-</p><pre class="screen"><span class="emphasis"><em>''' A multi-line</em></span>
-<span class="emphasis"><em>    comment.'''</em></span>
-<span class="strong"><strong>def</strong></span> sub_word(mo):
-<span class="emphasis"><em>    ''' Single line comment.'''</em></span>
-    word = mo.group('word')   <span class="emphasis"><em># Inline comment</em></span>
-    <span class="strong"><strong>if</strong></span> word <span class="strong"><strong>in</strong></span> keywords[language]:
-        <span class="strong"><strong>return</strong></span> quote + word + quote
-    <span class="strong"><strong>else</strong></span>:
-        <span class="strong"><strong>return</strong></span> word</pre><p>
-</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X57"></a>Source Code Highlighter Filter</h3></div></div></div><p>A
-<a class="ulink" href="http://www.methods.co.nz/asciidoc/source-highlight-filter.html" target="_top">source code highlighter filter</a>
-can be found in the AsciiDoc distribution <code class="literal">./filters</code> directory.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X58"></a>Music Filter</h3></div></div></div><p>A <a class="ulink" href="http://www.methods.co.nz/asciidoc/music-filter.html" target="_top">music filter</a> is included in the
-distribution <code class="literal">./filters</code> directory. It translates music in
-<a class="ulink" href="http://lilypond.org/" target="_top">LilyPond</a> or <a class="ulink" href="http://abcnotation.org.uk/" target="_top">ABC</a>
-notation to standard Western classical notation in the form of a
-trimmed PNG image which is automatically inserted into the output
-document.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s28.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s30.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Block Element Definitions </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Converting DocBook to other file formats</td></tr></table></div></body></html>

data/example/output/ar01s30.html DELETED Viewed

@@ -1,154 +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>Converting DocBook to other file formats</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="ar01s29.html" title="Filters" /><link rel="next" href="ar01s31.html" title="Generating Plain Text Files" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Converting DocBook to other file formats</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s29.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s31.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="X12"></a>Converting DocBook to other file formats</h2></div></div></div><p>DocBook files are validated, parsed and translated various
-presentation file formats using a combination of applications
-collectively called a DocBook <span class="emphasis"><em>tool chain</em></span>. The function of a tool
-chain is to read the DocBook markup (produced by AsciiDoc) and
-transform it to a presentation format (for example HTML, PDF, HTML
-Help, EPUB, DVI, PostScript, LaTeX).</p><p>A wide range of user output format requirements coupled with a choice
-of available tools and stylesheets results in many valid tool chain
-combinations.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X43"></a>a2x Toolchain Wrapper</h3></div></div></div><p>One of the biggest hurdles for new users is installing, configuring
-and using a DocBook XML toolchain. <code class="literal">a2x(1)</code> can help — it’s a
-toolchain wrapper command that will generate XHTML (chunked and
-unchunked), PDF, EPUB, DVI, PS, LaTeX, man page, HTML Help and text
-file outputs from an AsciiDoc text file.  <code class="literal">a2x(1)</code> does all the grunt
-work associated with generating and sequencing the toolchain commands
-and managing intermediate and output files.  <code class="literal">a2x(1)</code> also optionally
-deploys admonition and navigation icons and a CSS stylesheet. See the
-<code class="literal">a2x(1)</code> man page for more details. In addition to <code class="literal">asciidoc(1)</code> you
-also need <a class="link" href="ar01s30.html#X40">xsltproc(1)</a>, <a class="link" href="ar01s30.html#X13">DocBook XSL Stylesheets</a> and
-optionally: <a class="link" href="ar01s30.html#X31">dblatex</a> or <a class="link" href="ar01s30.html#X14">FOP</a> (to generate PDF);
-<code class="literal">w3m(1)</code> or <code class="literal">lynx(1)</code> (to generate text).</p><p>The following examples generate <code class="literal">doc/source-highlight-filter.pdf</code> from
-the AsciiDoc <code class="literal">doc/source-highlight-filter.txt</code> source file. The first
-example uses <code class="literal">dblatex(1)</code> (the default PDF generator) the second
-example forces FOP to be used:</p><pre class="literallayout">$ a2x -f pdf doc/source-highlight-filter.txt
-$ a2x -f pdf --fop doc/source-highlight-filter.txt</pre><p>See the <code class="literal">a2x(1)</code> man page for details.</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>Use the <code class="literal">--verbose</code> command-line option to view executed
-toolchain commands.</p></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_html_generation"></a>HTML generation</h3></div></div></div><p>AsciiDoc produces nicely styled HTML directly without requiring a
-DocBook toolchain but there are also advantages in going the DocBook
-route:</p><div class="itemizedlist"><ul type="disc"><li>
-HTML from DocBook can optionally include automatically generated
-  indexes, tables of contents, footnotes, lists of figures and tables.
-</li><li>
-DocBook toolchains can also (optionally) generate separate (chunked)
-  linked HTML pages for each document section.
-</li><li>
-Toolchain processing performs link and document validity checks.
-</li><li>
-If the DocBook <span class="emphasis"><em>lang</em></span> attribute is set then things like table of
-  contents, figure and table captions and admonition captions will be
-  output in the specified language (setting the AsciiDoc <span class="emphasis"><em>lang</em></span>
-  attribute sets the DocBook <span class="emphasis"><em>lang</em></span> attribute).
-</li></ul></div><p>On the other hand, HTML output directly from AsciiDoc is much faster,
-is easily customized and can be used in situations where there is no
-suitable DocBook toolchain (for example, see 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="_pdf_generation"></a>PDF generation</h3></div></div></div><p>There are two commonly used tools to generate PDFs from DocBook,
-<a class="link" href="ar01s30.html#X31">dblatex</a> and <a class="link" href="ar01s30.html#X14">FOP</a>.</p><div class="itemizedlist"><p class="title"><b>dblatex or FOP?</b></p><ul type="disc"><li>
-<span class="emphasis"><em>dblatex</em></span> is easier to install, there’s zero configuration
-  required and no Java VM to install — it just works out of the box.
-</li><li>
-<span class="emphasis"><em>dblatex</em></span> source code highlighting and numbering is superb.
-</li><li>
-<span class="emphasis"><em>dblatex</em></span> is easier to use as it converts DocBook directly to PDF
-  whereas before using <span class="emphasis"><em>FOP</em></span> you have to convert DocBook to XML-FO
-  using <a class="link" href="ar01s30.html#X13">DocBook XSL Stylesheets</a>.
-</li><li>
-<span class="emphasis"><em>FOP</em></span> is more feature complete (for example, callouts are processed
-  inside literal layouts) and arguably produces nicer looking output.
-</li></ul></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_html_help_generation"></a>HTML Help generation</h3></div></div></div><div class="orderedlist"><ol type="1"><li>
-Convert DocBook XML documents to HTML Help compiler source files
-  using <a class="link" href="ar01s30.html#X13">DocBook XSL Stylesheets</a> and <a class="link" href="ar01s30.html#X40">xsltproc(1)</a>.
-</li><li>
-Convert the HTML Help source (<code class="literal">.hhp</code> and <code class="literal">.html</code>) files to HTML Help
-  (<code class="literal">.chm</code>) files using the <a class="link" href="ar01s30.html#X67">Microsoft HTML Help Compiler</a>.
-</li></ol></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_toolchain_components_summary"></a>Toolchain components summary</h3></div></div></div><div class="variablelist"><dl><dt><span class="term">
-AsciiDoc
-</span></dt><dd>
-    Converts AsciiDoc (<code class="literal">.txt</code>) files to DocBook XML (<code class="literal">.xml</code>) files.
-</dd><dt><span class="term">
-<a id="X13"></a><a class="ulink" href="http://docbook.sourceforge.net/projects/xsl/" target="_top">DocBook XSL Stylesheets</a>
-</span></dt><dd>
-  These are a set of XSL stylesheets containing rules for converting
-  DocBook XML documents to HTML, XSL-FO, manpage and HTML Help files.
-  The stylesheets are used in conjunction with an XML parser such as
-  <a class="link" href="ar01s30.html#X40">xsltproc(1)</a>.
-</dd><dt><span class="term">
-<a id="X40"></a><a class="ulink" href="http://www.xmlsoft.org" target="_top">xsltproc</a>
-</span></dt><dd>
-  An XML parser for applying XSLT stylesheets (in our case the
-  <a class="link" href="ar01s30.html#X13">DocBook XSL Stylesheets</a>) to XML documents.
-</dd><dt><span class="term">
-<a id="X31"></a><a class="ulink" href="http://dblatex.sourceforge.net/" target="_top">dblatex</a>
-</span></dt><dd>
-  Generates PDF, DVI, PostScript and LaTeX formats directly from
-  DocBook source via the intermediate LaTeX typesetting language —   uses <a class="link" href="ar01s30.html#X13">DocBook XSL Stylesheets</a>, <a class="link" href="ar01s30.html#X40">xsltproc(1)</a> and
-  <code class="literal">latex(1)</code>.
-</dd><dt><span class="term">
-<a id="X14"></a><a class="ulink" href="http://xml.apache.org/fop/" target="_top">FOP</a>
-</span></dt><dd>
-  The Apache Formatting Objects Processor converts XSL-FO (<code class="literal">.fo</code>)
-  files to PDF files.  The XSL-FO files are generated from DocBook
-  source files using <a class="link" href="ar01s30.html#X13">DocBook XSL Stylesheets</a> and
-  <a class="link" href="ar01s30.html#X40">xsltproc(1)</a>.
-</dd><dt><span class="term">
-<a id="X67"></a>Microsoft Help Compiler
-</span></dt><dd>
-  The Microsoft HTML Help Compiler (<code class="literal">hhc.exe</code>) is a command-line tool
-  that converts HTML Help source files to a single HTML Help (<code class="literal">.chm</code>)
-  file. It runs on MS Windows platforms and can be downloaded from
-  <a class="ulink" href="http://www.microsoft.com" target="_top">http://www.microsoft.com</a>.
-</dd></dl></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_asciidoc_dblatex_configuration_files"></a>AsciiDoc dblatex configuration files</h3></div></div></div><p>The AsciiDoc distribution <code class="literal">./dblatex</code> directory contains
-<code class="literal">asciidoc-dblatex.xsl</code> (customized XSL parameter settings) and
-<code class="literal">asciidoc-dblatex.sty</code> (customized LaTeX settings). These are examples
-of optional <a class="link" href="ar01s30.html#X31">dblatex</a> output customization and are used by
-<a class="link" href="ar01s30.html#X43" title="a2x Toolchain Wrapper">a2x(1)</a>.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_asciidoc_docbook_xsl_stylesheets_drivers"></a>AsciiDoc DocBook XSL Stylesheets drivers</h3></div></div></div><p>You will have noticed that the distributed HTML and HTML Help
-documentation files (for example <code class="literal">./doc/asciidoc.html</code>) are not the
-plain outputs produced using the default <span class="emphasis"><em>DocBook XSL Stylesheets</em></span>
-configuration.  This is because they have been processed using
-customized DocBook XSL Stylesheets along with (in the case of HTML
-outputs) the custom <code class="literal">./stylesheets/docbook.css</code> CSS stylesheet.</p><p>You’ll find the customized DocBook XSL drivers along with additional
-documentation in the distribution <code class="literal">./docbook-xsl</code> directory. The
-examples that follow are executed from the distribution documentation
-(<code class="literal">./doc</code>) directory. These drivers are also used by <a class="link" href="ar01s30.html#X43" title="a2x Toolchain Wrapper">a2x(1)</a>.</p><div class="variablelist"><dl><dt><span class="term">
-<code class="literal">common.xsl</code>
-</span></dt><dd>
-    Shared driver parameters.  This file is not used directly but is
-    included in all the following drivers.
-</dd><dt><span class="term">
-<code class="literal">chunked.xsl</code>
-</span></dt><dd><p>
-    Generate chunked XHTML (separate HTML pages for each document
-    section) in the <code class="literal">./doc/chunked</code> directory. For example:
-</p><pre class="literallayout">$ python ../asciidoc.py -b docbook asciidoc.txt
-$ xsltproc --nonet ../docbook-xsl/chunked.xsl asciidoc.xml</pre></dd><dt><span class="term">
-<code class="literal">epub.xsl</code>
-</span></dt><dd>
-    Used by <a class="link" href="ar01s30.html#X43" title="a2x Toolchain Wrapper">a2x(1)</a> to generate EPUB formatted documents.
-</dd><dt><span class="term">
-<code class="literal">fo.xsl</code>
-</span></dt><dd><p>
-    Generate XSL Formatting Object (<code class="literal">.fo</code>) files for subsequent PDF
-    file generation using FOP. For example:
-</p><pre class="literallayout">$ python ../asciidoc.py -b docbook article.txt
-$ xsltproc --nonet ../docbook-xsl/fo.xsl article.xml &gt; article.fo
-$ fop article.fo article.pdf</pre></dd><dt><span class="term">
-<code class="literal">htmlhelp.xsl</code>
-</span></dt><dd><p>
-    Generate Microsoft HTML Help source files for the MS HTML Help
-    Compiler in the <code class="literal">./doc/htmlhelp</code> directory. This example is run on
-    MS Windows from a Cygwin shell prompt:
-</p><pre class="literallayout">$ python ../asciidoc.py -b docbook asciidoc.txt
-$ xsltproc --nonet ../docbook-xsl/htmlhelp.xsl asciidoc.xml
-$ c:/Program\ Files/HTML\ Help\ Workshop/hhc.exe htmlhelp.hhp</pre></dd><dt><span class="term">
-<code class="literal">manpage.xsl</code>
-</span></dt><dd><p>
-    Generate a <code class="literal">roff(1)</code> format UNIX man page from a DocBook XML
-    <span class="emphasis"><em>refentry</em></span> document. This example generates an <code class="literal">asciidoc.1</code> man
-    page file:
-</p><pre class="literallayout">$ python ../asciidoc.py -d manpage -b docbook asciidoc.1.txt
-$ xsltproc --nonet ../docbook-xsl/manpage.xsl asciidoc.1.xml</pre></dd><dt><span class="term">
-<code class="literal">xhtml.xsl</code>
-</span></dt><dd><p>
-    Convert a DocBook XML file to a single XHTML file. For example:
-</p><pre class="literallayout">$ python ../asciidoc.py -b docbook asciidoc.txt
-$ xsltproc --nonet ../docbook-xsl/xhtml.xsl asciidoc.xml &gt; asciidoc.html</pre></dd></dl></div><p>If you want to see how the complete documentation set is processed
-take a look at the A-A-P script <code class="literal">./doc/main.aap</code>.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s29.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s31.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Filters </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Generating Plain Text Files</td></tr></table></div></body></html>