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

@@ -1,21 +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>Document 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="ar01s22.html" title="Configuration Files" /><link rel="next" href="ar01s24.html" title="Attribute Entries" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Document Attributes</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s22.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s24.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="_document_attributes"></a>Document Attributes</h2></div></div></div><p>A document attribute is comprised of a <span class="emphasis"><em>name</em></span> and a textual <span class="emphasis"><em>value</em></span>
-and is used for textual substitution in AsciiDoc documents and
-configuration files. An attribute reference (an attribute name
-enclosed in braces) is replaced by the corresponding attribute
-value. Attribute names are case insensitive and can only contain
-alphanumeric, dash and underscore characters.</p><p>There are four sources of document attributes (from highest to lowest
-precedence):</p><div class="itemizedlist"><ul type="disc"><li>
-Command-line attributes.
-</li><li>
-AttributeEntry, AttributeList, Macro and BlockId elements.
-</li><li>
-Configuration file <code class="literal">[attributes]</code> sections.
-</li><li>
-Intrinsic attributes.
-</li></ul></div><p>Within each of these divisions the last processed entry takes
-precedence.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>If an attribute is not defined then the line containing the
-attribute reference is dropped. This property is used extensively in
-AsciiDoc configuration files to facilitate conditional markup
-generation.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s22.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s24.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Configuration Files </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Attribute Entries</td></tr></table></div></body></html>

data/example/output/ar01s24.html DELETED Viewed

@@ -1,69 +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>Attribute Entries</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="ar01s23.html" title="Document Attributes" /><link rel="next" href="ar01s25.html" title="Attribute Lists" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Attribute Entries</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s23.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s25.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="X18"></a>Attribute Entries</h2></div></div></div><p>The <code class="literal">AttributeEntry</code> block element allows document attributes to be
-assigned within an AsciiDoc document. Attribute entries are added to
-the global document attributes dictionary. The attribute name/value
-syntax is a single line like:</p><pre class="literallayout">:&lt;name&gt;: &lt;value&gt;</pre><p>For example:</p><pre class="literallayout">:Author Initials: JB</pre><p>This will set an attribute reference <code class="literal">{authorinitials}</code> to the value
-<span class="emphasis"><em>JB</em></span> in the current document.</p><p>To delete (undefine) an attribute use the following syntax:</p><pre class="literallayout">:&lt;name&gt;!:</pre><div class="itemizedlist"><p class="title"><b>AttributeEntry behavior</b></p><ul type="disc"><li>
-The attribute entry line begins with colon — no white space allowed
-  in left margin.
-</li><li>
-AsciiDoc converts the <code class="literal">&lt;name&gt;</code> to a legal attribute name (lower
-  case, alphanumeric, dash and underscore characters only — all other
-  characters deleted). This allows more human friendly text to be
-  used.
-</li><li>
-Leading and trailing white space is stripped from the <code class="literal">&lt;value&gt;</code>.
-</li><li><p>
-Lines ending in a space followed by a plus character are continued
-  to the next line, for example:
-</p><pre class="literallayout">:description: AsciiDoc is a text document format for writing notes, +
-              documentation, articles, books, slideshows, web pages +
-              and man pages.</pre></li><li>
-If the <code class="literal">&lt;value&gt;</code> is blank then the corresponding attribute value is
-  set to an empty string.
-</li><li>
-Attribute references contained in the entry <code class="literal">&lt;value&gt;</code> will be
-  expanded.
-</li><li>
-By default AttributeEntry values are substituted for
-  <code class="literal">specialcharacters</code> and <code class="literal">attributes</code> (see above), if you want to
-  change or disable AttributeEntry substitution use the <a class="link" href="ar01s18.html#X77" title="Passthrough macros">   inline macro</a> syntax.
-</li><li>
-Attribute entries in the document Header are available for header
-  markup template substitution.
-</li><li>
-Attribute elements override configuration file and intrinsic
-  attributes but do not override command-line attributes.
-</li></ul></div><p>Here are some more attribute entry examples:</p><pre class="screen">AsciiDoc User Manual
-====================
-:author:    Stuart Rackham
-:email:     srackham@gmail.com
-:revdate:   April 23, 2004
-:revnumber: 5.1.1</pre><p>Which creates these attributes:</p><pre class="literallayout">{author}, {firstname}, {lastname}, {authorinitials}, {email},
-{revdate}, {revnumber}</pre><p>The previous example is equivalent to this <a class="link" href="ar01s05.html#X95" title="Header">document header</a>:</p><pre class="screen">AsciiDoc User Manual
-====================
-Stuart Rackham &lt;srackham@gmail.com&gt;
-5.1.1, April 23, 2004</pre><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_setting_configuration_entries"></a>Setting configuration entries</h3></div></div></div><p>A variant of the Attribute Entry syntax allows configuration file
-entries to be set from within an AsciiDoc document:</p><pre class="literallayout">:&lt;section_name&gt;.&lt;entry_name&gt;: &lt;entry_value&gt;</pre><p>Where <code class="literal">&lt;section_name&gt;</code> is the configuration section name,
-<code class="literal">&lt;entry_name&gt;</code> is the name of the entry and <code class="literal">&lt;entry_value&gt;</code> is the
-optional entry value. This example sets the default labeled list style
-to <span class="emphasis"><em>horizontal</em></span>:</p><pre class="literallayout">:listdef-labeled.style: horizontal</pre><p>It is exactly equivalent to a configuration file containing:</p><pre class="literallayout">[listdef-labeled]
-style=horizontal</pre><p>No substitution is performed on configuration file attribute entries
-and they cannot be undefined.</p><div class="sidebar"><a id="X62"></a><p class="title"><b>Attribute entries promote clarity and eliminate repetition</b></p><p>URLs and file names in AsciiDoc macros are often quite long — they
-break paragraph flow and readability suffers.  The problem is
-compounded by redundancy if the same name is used repeatedly.
-Attribute entries can be used to make your documents easier to read
-and write, here are some examples:</p><pre class="literallayout">:1:         http://freshmeat.net/projects/asciidoc/
-:homepage:  http://methods.co.nz/asciidoc/[AsciiDoc home page]
-:new:       image:./images/smallnew.png[]
-:footnote1: footnote:[A meaningless latin term]</pre><pre class="literallayout">Using previously defined attributes: See the {1}[Freshmeat summary]
-or the {homepage} for something new {new}. Lorem ispum {footnote1}.</pre><div class="itemizedlist"><p class="title"><b>Note</b></p><ul type="disc"><li>
-The attribute entry definition must precede it’s usage.
-</li><li>
-You are not limited to URLs or file names, entire macro calls or
-  arbitrary lines of text can be abbreviated.
-</li><li>
-Shared attributes entries could be grouped into a separate file and
-  <a class="link" href="ar01s18.html#X63" title="Include Macros">included</a> in multiple documents.
-</li></ul></div></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s23.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s25.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Document Attributes </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Attribute Lists</td></tr></table></div></body></html>

data/example/output/ar01s25.html DELETED Viewed

@@ -1,60 +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>Attribute Lists</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="ar01s24.html" title="Attribute Entries" /><link rel="next" href="ar01s26.html" title="Attribute References" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Attribute Lists</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s24.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s26.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="X21"></a>Attribute Lists</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li>
-An attribute list is a comma separated list of attribute values.
-</li><li>
-The entire list is enclosed in square brackets.
-</li><li>
-Attribute lists are used to pass parameters to macros, blocks (using
-  the <a class="link" href="ar01s11.html" title="AttributeList Element">AttributeList element</a>) and inline quotes.
-</li></ul></div><p>The list consists of zero or more positional attribute values followed
-by zero or more named attribute values.  Here are three examples: a
-single unquoted positional attribute; three unquoted positional
-attribute values; one positional attribute followed by two named
-attributes; the unquoted attribute value in the final example contains
-comma (<code class="literal">&amp;#44;</code>) and double-quote (<code class="literal">&amp;#34;</code>) character entities:</p><pre class="literallayout">[Hello]
-[quote, Bertrand Russell, The World of Mathematics (1956)]
-["22 times", backcolor="#0e0e0e", options="noborders,wide"]
-[A footnote&amp;#44; &amp;#34;with an image&amp;#34; image:smallnew.png[]]</pre><div class="itemizedlist"><p class="title"><b>Attribute list behavior</b></p><ul type="disc"><li>
-If one or more attribute values contains a comma the all string
-  values must be quoted (enclosed in double quotation mark
-  characters).
-</li><li>
-If the list contains any named or quoted attributes then all string
-  attribute values must be quoted.
-</li><li>
-To include a double quotation mark (") character in a quoted
-  attribute value the the quotation mark must be escaped with a
-  backslash.
-</li><li>
-List attributes take precedence over existing attributes.
-</li><li>
-List attributes can only be referenced in configuration file markup
-  templates and tags, they are not available elsewhere in the
-  document.
-</li><li>
-Setting a named attribute to <code class="literal">None</code> undefines the attribute.
-</li><li>
-Positional attributes are referred to as <code class="literal">{1}</code>,<code class="literal">{2}</code>,<code class="literal">{3}</code>,…
-</li><li>
-Attribute <code class="literal">{0}</code> refers to the entire list (excluding the enclosing
-  square brackets).
-</li><li>
-Named attribute names cannot contain dash characters.
-</li></ul></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X75"></a>Options attribute</h3></div></div></div><p>If the attribute list contains an attribute named <code class="literal">options</code> it is
-processed as a comma separated list of option names:</p><div class="itemizedlist"><ul type="disc"><li>
-Each name generates an attribute named like <code class="literal">&lt;option&gt;-option</code> (where
-  <code class="literal">&lt;option&gt;</code> is the option name) with an empty string value.  For
-  example <code class="literal">[options="opt1,opt2,opt3"]</code> is equivalent to setting the
-  following three attributes
-  <code class="literal">[opt1-option="",opt2-option="",opt2-option=""]</code>.
-</li><li>
-If you define a an option attribute globally (for example with an
-  <a class="link" href="ar01s24.html" title="Attribute Entries">attribute entry</a>) then it will apply to all elements in the
-  document.
-</li><li>
-AsciiDoc implements a number of predefined options which are listed
-  in the <a class="link" href="apf.html" title="F. Attribute Options">Attribute Options appendix</a>.
-</li></ul></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_macro_attribute_lists"></a>Macro Attribute lists</h3></div></div></div><p>Macros calls are suffixed with an attribute list. The list may be
-empty but it cannot be omitted. List entries are used to pass
-attribute values to macro markup templates.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s24.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s26.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Attribute Entries </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Attribute References</td></tr></table></div></body></html>

data/example/output/ar01s26.html DELETED Viewed

@@ -1,217 +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>Attribute References</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="ar01s25.html" title="Attribute Lists" /><link rel="next" href="ar01s27.html" title="Intrinsic Attributes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Attribute References</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s25.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s27.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="_attribute_references"></a>Attribute References</h2></div></div></div><p>An attribute reference is an attribute name (possibly followed by an
-additional parameters) enclosed in curly braces.  When an attribute
-reference is encountered it is evaluated and replaced by its
-corresponding text value.  If the attribute is undefined the line
-containing the attribute is dropped.</p><p>There are three types of attribute reference: <span class="emphasis"><em>Simple</em></span>, <span class="emphasis"><em>Conditional</em></span>
-and <span class="emphasis"><em>System</em></span>.</p><div class="itemizedlist"><p class="title"><b>Attribute reference evaluation</b></p><ul type="disc"><li>
-You can suppress attribute reference expansion by placing a
-  backslash character immediately in front of the opening brace
-  character.
-</li><li>
-By default attribute references are not expanded in
-  <span class="emphasis"><em>LiteralParagraphs</em></span>, <span class="emphasis"><em>ListingBlocks</em></span> or <span class="emphasis"><em>LiteralBlocks</em></span>.
-</li><li>
-Attribute substitution proceeds line by line in reverse line order.
-</li><li>
-Attribute reference evaluation is performed in the following order:
-  <span class="emphasis"><em>Simple</em></span> then <span class="emphasis"><em>Conditional</em></span> and finally <span class="emphasis"><em>System</em></span>.
-</li></ul></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_simple_attributes_references"></a>Simple Attributes References</h3></div></div></div><p>Simple attribute references take the form <code class="literal">{&lt;name&gt;}</code>. If the
-attribute name is defined its text value is substituted otherwise the
-line containing the reference is dropped from the output.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="_conditional_attribute_references"></a>Conditional Attribute References</h3></div></div></div><p>Additional parameters are used in conjunction with attribute names to
-calculate a substitution value. Conditional attribute references take
-the following forms:</p><div class="variablelist"><dl><dt><span class="term">
-<code class="literal">{&lt;names&gt;=&lt;value&gt;}</code>
-</span></dt><dd>
-        <code class="literal">&lt;value&gt;</code> is substituted if the attribute <code class="literal">&lt;names&gt;</code> is
-        undefined otherwise its value is substituted. <code class="literal">&lt;value&gt;</code> can
-        contain simple attribute references.
-</dd><dt><span class="term">
-<code class="literal">{&lt;names&gt;?&lt;value&gt;}</code>
-</span></dt><dd>
-        <code class="literal">&lt;value&gt;</code> is substituted if the attribute <code class="literal">&lt;names&gt;</code> is defined
-        otherwise an empty string is substituted.  <code class="literal">&lt;value&gt;</code> can
-        contain simple attribute references.
-</dd><dt><span class="term">
-<code class="literal">{&lt;names&gt;!&lt;value&gt;}</code>
-</span></dt><dd>
-        <code class="literal">&lt;value&gt;</code> is substituted if the attribute <code class="literal">&lt;names&gt;</code> is
-        undefined otherwise an empty string is substituted.  <code class="literal">&lt;value&gt;</code>
-        can contain simple attribute references.
-</dd><dt><span class="term">
-<code class="literal">{&lt;names&gt;#&lt;value&gt;}</code>
-</span></dt><dd>
-        <code class="literal">&lt;value&gt;</code> is substituted if the attribute <code class="literal">&lt;names&gt;</code> is defined
-        otherwise the undefined attribute entry causes the containing
-        line to be dropped.  <code class="literal">&lt;value&gt;</code> can contain simple attribute
-        references.
-</dd><dt><span class="term">
-<code class="literal">{&lt;names&gt;%&lt;value&gt;}</code>
-</span></dt><dd>
-        <code class="literal">&lt;value&gt;</code> is substituted if the attribute <code class="literal">&lt;names&gt;</code> is not
-        defined otherwise the containing line is dropped.  <code class="literal">&lt;value&gt;</code>
-        can contain simple attribute references.
-</dd><dt><span class="term">
-<code class="literal">{&lt;names&gt;@&lt;regexp&gt;:&lt;value1&gt;[:&lt;value2&gt;]}</code>
-</span></dt><dd>
-        <code class="literal">&lt;value1&gt;</code> is substituted if the value of attribute <code class="literal">&lt;names&gt;</code>
-        matches the regular expression <code class="literal">&lt;regexp&gt;</code> otherwise <code class="literal">&lt;value2&gt;</code>
-        is substituted. If attribute <code class="literal">&lt;names&gt;</code> is not defined the
-        containing line is dropped. If <code class="literal">&lt;value2&gt;</code> is omitted an empty
-        string is assumed. The values and the regular expression can
-        contain simple attribute references.  To embed colons in the
-        values or the regular expression escape them with backslashes.
-</dd><dt><span class="term">
-<code class="literal">{&lt;names&gt;$&lt;regexp&gt;:&lt;value1&gt;[:&lt;value2&gt;]}</code>
-</span></dt><dd><p>
-        Same behavior as the previous ternary attribute except for
-        the following cases:
-</p><div class="variablelist"><dl><dt><span class="term">
-<code class="literal">{&lt;names&gt;$&lt;regexp&gt;:&lt;value&gt;}</code>
-</span></dt><dd>
-                Substitutes <code class="literal">&lt;value&gt;</code> if <code class="literal">&lt;names&gt;</code> matches <code class="literal">&lt;regexp&gt;</code>
-                otherwise the result is undefined and the containing
-                line is dropped.
-</dd><dt><span class="term">
-<code class="literal">{&lt;names&gt;$&lt;regexp&gt;::&lt;value&gt;}</code>
-</span></dt><dd>
-                Substitutes <code class="literal">&lt;value&gt;</code> if <code class="literal">&lt;names&gt;</code> does not match
-                <code class="literal">&lt;regexp&gt;</code> otherwise the result is undefined and the
-                containing line is dropped.
-</dd></dl></div></dd></dl></div><p>The attribute <code class="literal">&lt;names&gt;</code> parameter normally consists of a single
-attribute name but it can be any one of the following:</p><div class="itemizedlist"><ul type="disc"><li>
-A single attribute name which evaluates to the attributes value.
-</li><li>
-Multiple <span class="emphasis"><em>,</em></span> separated attribute names which evaluates to an empty
-  string if one or more of the attributes is defined, otherwise it’s
-  value is undefined.
-</li><li>
-Multiple <span class="emphasis"><em>+</em></span> separated attribute names which evaluates to an empty
-  string if all of the attributes are defined, otherwise it’s value is
-  undefined.
-</li></ul></div><p>Conditional attributes with single attribute names are evaluated first
-so they can be used inside the multi-attribute conditional <code class="literal">&lt;value&gt;</code>.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="_conditional_attribute_examples"></a>Conditional attribute examples</h4></div></div></div><p>Conditional attributes are mainly used in AsciiDoc configuration
-files — see the distribution <code class="literal">.conf</code> files for examples.</p><div class="variablelist"><dl><dt><span class="term">
-Attribute equality test
-</span></dt><dd><p>
-  If <code class="literal">{backend}</code> is <code class="literal">docbook45</code> or <code class="literal">xhtml11</code> the example evaluates to
-  “DocBook 4.5 or XHTML 1.1 backend” otherwise it evaluates to “some
-  other backend”:
-</p><pre class="literallayout">{backend@docbook45|xhtml11:DocBook 4.5 or XHTML 1.1 backend:some other backend}</pre></dd><dt><span class="term">
-Attribute value map
-</span></dt><dd><p>
-  This example maps the <code class="literal">frame</code> attribute values [<code class="literal">topbot</code>, <code class="literal">all</code>,
-  <code class="literal">none</code>, <code class="literal">sides</code>] to [<code class="literal">hsides</code>, <code class="literal">border</code>, <code class="literal">void</code>, <code class="literal">vsides</code>]:
-</p><pre class="literallayout">{frame@topbot:hsides}{frame@all:border}{frame@none:void}{frame@sides:vsides}</pre></dd></dl></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="X24"></a>System Attribute References</h3></div></div></div><p>System attribute references generate the attribute text value by
-executing a predefined action that is parametrized by one or more
-arguments. The syntax is <code class="literal">{&lt;action&gt;:&lt;arguments&gt;}</code>.</p><div class="variablelist"><dl><dt><span class="term">
-<code class="literal">{counter:&lt;attrname&gt;[:&lt;seed&gt;]}</code>
-</span></dt><dd><p>
-        Increments the document attribute (if the attribute is
-        undefined it is set to <code class="literal">1</code>). Returns the new attribute value.
-</p><div class="itemizedlist"><ul type="disc"><li>
-Counters generate global (document wide) attributes.
-</li><li>
-The optional <code class="literal">&lt;seed&gt;</code> specifies the counter’s initial value;
-          it can be a number or a single letter; defaults to <span class="emphasis"><em>1</em></span>.
-</li><li>
-<code class="literal">&lt;seed&gt;</code> can contain simple and conditional attribute
-          references.
-</li><li>
-The <span class="emphasis"><em>counter</em></span> system attribute will not be executed if the
-          containing line is dropped by the prior evaluation of an
-          undefined attribute.
-</li></ul></div></dd><dt><span class="term">
-<code class="literal">{counter2:&lt;attrname&gt;[:&lt;seed&gt;]}</code>
-</span></dt><dd>
-        Same as <code class="literal">counter</code> except the it always returns a blank string.
-</dd><dt><span class="term">
-<code class="literal">{eval:&lt;expression&gt;}</code>
-</span></dt><dd><p>
-        Substitutes the result of the Python <code class="literal">&lt;expression&gt;</code>.
-</p><div class="itemizedlist"><ul type="disc"><li>
-If <code class="literal">&lt;expression&gt;</code> evaluates to <code class="literal">None</code> or <code class="literal">False</code> the
-          reference is deemed undefined and the line containing the
-          reference is dropped from the output.
-</li><li>
-If the expression evaluates to <code class="literal">True</code> the attribute
-          evaluates to an empty string.
-</li><li>
-<code class="literal">&lt;expression&gt;</code> can contain simple and conditional attribute
-          references.
-</li><li>
-The <span class="emphasis"><em>eval</em></span> system attribute can be nested inside other
-          system attributes.
-</li></ul></div></dd><dt><span class="term">
-<code class="literal">{eval3:&lt;command&gt;}</code>
-</span></dt><dd>
-        Passthrough version of <code class="literal">{eval:&lt;expression&gt;}</code> — the generated
-        output is written directly to the output without any further
-        substitutions.
-</dd><dt><span class="term">
-<code class="literal">{include:&lt;filename&gt;}</code>
-</span></dt><dd><p>
-        Substitutes contents of the file named <code class="literal">&lt;filename&gt;</code>.
-</p><div class="itemizedlist"><ul type="disc"><li>
-The included file is read at the time of attribute
-          substitution.
-</li><li>
-If the file does not exist a warning is emitted and the line
-          containing the reference is dropped from the output file.
-</li><li>
-Tabs are expanded based on the current <span class="emphasis"><em>tabsize</em></span> attribute
-          value.
-</li></ul></div></dd><dt><span class="term">
-<code class="literal">{set:&lt;attrname&gt;[!][:&lt;value&gt;]}</code>
-</span></dt><dd><p>
-        Sets or unsets document attribute. Normally only used in
-        configuration file markup templates (use
-        <a class="link" href="ar01s24.html" title="Attribute Entries">AttributeEntries</a> in AsciiDoc documents).
-</p><div class="itemizedlist"><ul type="disc"><li>
-If the attribute name is followed by an exclamation mark
-          the attribute becomes undefined.
-</li><li>
-If <code class="literal">&lt;value&gt;</code> is omitted the attribute is set to a blank
-          string.
-</li><li>
-<code class="literal">&lt;value&gt;</code> can contain simple and conditional attribute
-          references.
-</li><li>
-Returns a blank string unless the attribute is undefined in
-          which case the return value is undefined and the enclosing
-          line will be dropped.
-</li></ul></div></dd><dt><span class="term">
-<code class="literal">{set2:&lt;attrname&gt;[!][:&lt;value&gt;]}</code>
-</span></dt><dd>
-        Same as <code class="literal">set</code> except that the attribute scope is local to the
-        template.
-</dd><dt><span class="term">
-<code class="literal">{sys:&lt;command&gt;}</code>
-</span></dt><dd>
-        Substitutes the stdout generated by the execution of the shell
-        <code class="literal">&lt;command&gt;</code>.
-</dd><dt><span class="term">
-<code class="literal">{sys2:&lt;command&gt;}</code>
-</span></dt><dd>
-        Substitutes the stdout and stderr generated by the execution
-        of the shell <code class="literal">&lt;command&gt;</code>.
-</dd><dt><span class="term">
-<code class="literal">{sys3:&lt;command&gt;}</code>
-</span></dt><dd>
-        Passthrough version of <code class="literal">{sys:&lt;command&gt;}</code> — the generated
-        output is written directly to the output without any further
-        substitutions.
-</dd><dt><span class="term">
-<code class="literal">{template:&lt;template&gt;}</code>
-</span></dt><dd>
-        Substitutes the contents of the configuration file section
-        named <code class="literal">&lt;template&gt;</code>. Attribute references contained in the
-        template are substituted.
-</dd></dl></div><div class="itemizedlist"><p class="title"><b>System reference behavior</b></p><ul type="disc"><li>
-System attribute arguments can contain non-system attribute
-  references.
-</li><li>
-Closing brace characters inside system attribute arguments must be
-  escaped with a backslash.
-</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="ar01s25.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s27.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Attribute Lists </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Intrinsic Attributes</td></tr></table></div></body></html>

data/example/output/ar01s27.html DELETED Viewed

@@ -1,88 +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>Intrinsic 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="ar01s26.html" title="Attribute References" /><link rel="next" href="ar01s28.html" title="Block Element Definitions" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Intrinsic Attributes</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s26.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s28.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="X60"></a>Intrinsic Attributes</h2></div></div></div><p>Intrinsic attributes are simple attributes that are created
-automatically from: AsciiDoc document header parameters; asciidoc(1)
-command-line arguments; attributes defined in the default
-configuration files; the execution context.  Here’s the list of
-predefined intrinsic attributes:</p><pre class="literallayout">{amp}                 ampersand (&amp;) character entity
-{asciidoc-dir}        the asciidoc(1) application directory
-{asciidoc-file}       the full path name of the asciidoc(1) script
-{asciidoc-version}    the version of asciidoc(1)
-{author}              author's full name
-{authored}            empty string '' if {author} or {email} defined,
-{authorinitials}      author initials (from document header)
-{backend-&lt;backend&gt;}   empty string ''
-{&lt;backend&gt;-&lt;doctype&gt;} empty string ''
-{backend}             document backend specified by `-b` option
-{backslash}           backslash character
-{basebackend-&lt;base&gt;}  empty string ''
-{basebackend}         html or docbook
-{brvbar}              broken vertical bar (|) character
-{revdate}             document revision date (from document header)
-{docdate}             document last modified date
-{doctime}             document last modified time
-{docname}             document file name without extension
-{docfile}             document file name  (note 5)
-{docdir}              document input directory name  (note 5)
-{doctitle}            document title (from document header)
-{doctype-&lt;doctype&gt;}   empty string ''
-{doctype}             document type specified by `-d` option
-{email}               author's email address (from document header)
-{empty}               empty string ''
-{encoding}            specifies input and output encoding
-{filetype-&lt;fileext&gt;}  empty string ''
-{filetype}            output file name file extension
-{firstname}           author first name (from document header)
-{gt}                  greater than (&gt;) character entity
-{id}                  running block id generated by BlockId elements
-{indir}               input file directory name (note 2,5)
-{infile}              input file name (note 2,5)
-{lastname}            author last name (from document header)
-{level}               title level 1..4 (in section titles)
-{listindex}           the list index (1..) of the most recent list item
-{localdate}           the current date
-{localtime}           the current time
-{lt}                  less than (&lt;) character entity
-{manname}             manpage name (defined in NAME section)
-{manpurpose}          manpage (defined in NAME section)
-{mantitle}            document title minus the manpage volume number
-{manvolnum}           manpage volume number (1..8) (from document header)
-{middlename}          author middle name (from document header)
-{nbsp}                non-breaking space character entity
-{notitle}             do not display the document title
-{outdir}              document output directory name (note 2)
-{outfile}             output file name (note 2)
-{reftext}             running block xreflabel generated by BlockId elements
-{revnumber}           document revision number (from document header)
-{sectnum}             formatted section number (in section titles)
-{showcomments}        send comment lines to the output
-{title}               section title (in titled elements)
-{two-colons}          Two colon characters
-{two-semicolons}      Two semicolon characters
-{user-dir}            the ~/.asciidoc directory (if it exists)
-{verbose}             defined as '' if --verbose command option specified
-{zwsp}                Zero-width space character entity</pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><div class="orderedlist"><ol type="1"><li>
-Intrinsic attributes are global so avoid defining custom attributes
-   with the same names.
-</li><li>
-<code class="literal">{outfile}</code>, <code class="literal">{outdir}</code>, <code class="literal">{infile}</code>, <code class="literal">{indir}</code> attributes are
-   effectively read-only (you can set them but it won’t affect the
-   input or output file paths).
-</li><li>
-See also the <a class="link" href="aph.html" title="H. Backend Attributes">Backend Attributes</a> section for attributes
-    that relate to AsciiDoc XHTML file generation.
-</li><li>
-The entries that translate to blank strings are designed to be used
-   for conditional text inclusion. You can also use the <code class="literal">ifdef</code>,
-   <code class="literal">ifndef</code> and <code class="literal">endif</code> System macros for conditional inclusion.
-   <sup>[<a id="id36128467" href="#ftn.id36128467" class="footnote">4</a>]</sup>
-</li><li>
-<code class="literal">{docfile}</code> and <code class="literal">{docdir}</code> refer to root document specified on
-   the asciidoc(1) command-line; <code class="literal">{infile}</code> and <code class="literal">{indir}</code> refer to
-   the current input file which may be the root document or an
-   included file. When the input is being read from the standard
-   input (<code class="literal">stdin</code>) these attributes are undefined.
-</li></ol></div></div><div class="footnotes"><br /><hr width="100" align="left" /><div class="footnote"><p><sup>[<a id="ftn.id36128467" href="#id36128467" class="simpara">4</a>] </sup>Conditional inclusion using <code class="literal">ifdef</code> and <code class="literal">ifndef</code> macros
-   differs from attribute conditional inclusion in that the former
-   occurs when the file is read while the latter occurs when the
-   contents are written.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s26.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s28.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Attribute References </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Block Element Definitions</td></tr></table></div></body></html>