diff options
40 files changed, 13819 insertions, 9215 deletions
diff --git a/CHANGELOG.txt b/CHANGELOG.txt index fbb118b..2c60fb8 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -1,2739 +1,2739 @@ -AsciiDoc ChangeLog
-==================
-
-:website: http://www.methods.co.nz/asciidoc/
-
-
-Version 8.6.4 (2010-02-20)
---------------------------
-.Additions and changes
-- Added text foreground and background color along with text size CSS
- styles for XHTML outputs, see {website}userguide.html#X96[].
-- Vim syntax highlighter: highlight macros that start with an
- attribute reference (a common idiom).
-- Vim syntax highlighter: highlight attribute references in macro
- attribute lists.
-- Attribute entries can be used to set configuration markup templates.
-- Double-width East Asian characters in titles now correctly match the
- title underline widths. Submitted by Changjian Gao (see
- http://groups.google.com/group/asciidoc/browse_thread/thread/77f28b0dfe60d262).
-- Implemented {website}manpage.html[asciidoc(1)] filter commands, see:
- http://groups.google.com/group/asciidoc/browse_thread/thread/40c64cd33ee1905c
-- User's home directory now calculated in a platform independent
- manner.
-- Added double-quote characters to French language file. Patch
- contributed Yves-Alexis Perez, see:
- http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940
-- Vim Syntax highlighter: Highlight closing OpenBlocks which
- immediately follow a literal paragraph.
-- Changed UNIX `/dev/null` to OS independent `os.devnull` in filters
- code. Suggested by Henrik Maier:
- http://groups.google.com/group/asciidoc/browse_thread/thread/5ac8e8ea895147e9
-- Vim syntax highlighter: Single and double quoted text now highlights
- correctly when preceded by an attributes list.
-- Added Ukrainian language file (`lang-uk.conf`). Added double-quote
- characters to Russian language file.conf). Patches contributed by
- Lavruschenko Oleksandr, see
- http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940
-- Single and double quote characters are now set using the `{lsquo}`,
- `{rsquo}`, `{ldquo}` and `{rdquo}` attributes. This makes is easy to
- customise language specific quotes. See:
- http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940
-- Implemented 'conf-files' attribute to allow configuration files to
- be specified in the source document. Suggested by Lex Trotman, see:
- http://groups.google.com/group/asciidoc/browse_thread/thread/b11066a828ab45b9
-
-.Bug fixes
-- *FIXED*: Auto-generated section title ids are now Unicode aware.
-- *FIXED*: Setting 'quotes' configuration entries using document
- attribute entries failed if the attribute entry was not in the
- document header. See:
- http://groups.google.com/group/asciidoc/browse_thread/thread/a1dd0562dee8b939
-- *FIXED*: If the input and output file names were different then the
- output file name was incorrectly used to synthesize 'docinfo' file
- names. Reported by Christian Zuckschwerdt.
-- *FIXED*: An error can occur when more than one consecutive quotes
- are defined as a blank string. Reported by Peggy Russell.
-- *FIXED*: Encoding error in automatically generated author initials.
- Patch submitted by Xin Wang. See:
- http://groups.google.com/group/asciidoc/browse_thread/thread/f44615dca0b834e9
-
-
-Version 8.6.3 (2010-11-14)
---------------------------
-.Additions and changes
-- Added and 'unbreakable' option to bulleted and numbered lists
- (thanks to Henrik Maier for this patch).
-- Added `ifeval::[]` system macro (thanks to Henrik Maier for
- suggesting this feature).
-- The image 'scale' attribute sets the DocBook 'imagedata' element
- 'scale' attribute. Patch submitted by Henrik Maier.
-- DocBook 'preface', 'colophon' and 'dedication' style section titles
- now work. Based on patch submitted by Henrik Maier.
-- 'a2x': Do not inject xsltproc parameters if they were specified on
- the command-line (parameter double-ups generate xsltproc 'Global
- parameter already defined' errors).
-- 'a2x': Refactored xsltproc parameter injection.
-- 'a2x': articles chunked at section level by default.
-- 'attributes', 'titles' and 'specialcharacters' sections are now read
- from the local `asciidoc.conf` file before the header is parsed.
- This fixes a regression problem. See
- http://groups.google.com/group/asciidoc/browse_thread/thread/1b3f88f1f8118ab3
-- Document header attributes take precedence over configuration file
- attributes.
-- Refactored 'music', 'graphviz' and 'latex' filter configurations.
-- Refactored source filter configuration and added literal paragraph
- source style.
-- Separated paragraph styles from paragraph syntax -- any style can be
- applied to any syntax.
-- Added 'listing' and 'quote' paragraph styles.
-- Renamed paragraph 'default' style to 'normal'.
-- Updated `--help` option text.
-- 'a2x': The `asciidoc_opts`, `dblatex_opts`, `fop_opts` and
- `xsltproc_opts` command-line options can be specified multiple
- times. This makes embedding multiple 'a2x' options in document
- headers easier to manage and less error prone.
-- Added ASCIIMathML and LaTeXMathML support to slidy backend.
-- Pass the 'encoding' attribute to the Pygments source highlight
- filter command.
-- 'a2x': HTML Help `.hhk` file named after AsciiDoc source file.
-- 'a2x': Added `--xsl-file` option to allow custom XSL stylesheets to
- be specified.
-- Make builds the man pages. Patch submitted by Sebastian Pipping. See
- http://groups.google.com/group/asciidoc/browse_thread/thread/c21c2902c29bae64
-
-.Bug fixes
-- *FIXED*: Sometimes double backquotes were misinterpreted as inline
- literal macros. See:
- http://groups.google.com/group/asciidoc/browse_thread/thread/f510ea82a88aaee8
-- *FIXED*: Regression in 8.6.2: command-line attributes were not
- available to the global asciidoc.conf.
-- *FIXED*: Postponed document title substitutions until backend conf
- files have been loaded (8.6.2 regression). See
- http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8
-- *FIXED*: The XSL Stylesheets customizations were preventing chapter
- and section level TOCs from being generated when using XSL
- Stylesheets via 'a2x'. See
- http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8
-- *FIXED*: ``UnicodeDecodeError: \'ascii' codec can't decode byte''
- error. This error is due to a limitation in the Python HTMLParser
- module, see: http://bugs.python.org/issue3932
-- *FIXED*: Broken `--no-conf` option (8.6.2 regression).
-- *FIXED*: Regression in 8.6.2: configuration attribute entries set in
- the document header may cause a 'FAILED: incomplete configuration
- files' error.
-- *FIXED*: 'html4': corrected self closed meta tags.
-- *FIXED*: 'a2x' regression in 8.6.2: HTML Help `.hhp` file name had
- reverted to default name instead of the AsciiDoc source file name.
- See:
- http://groups.google.com/group/asciidoc/browse_thread/thread/dedc961b23e9ac56
-- *FIXED*: Attributes in man page title caused it to be dropped
- resulting in invalid DocBook output.
-- *FIXED*: `make uninstall` now deletes the `asciidoc.1` and `a2x.1`
- man pages.
-
-
-Version 8.6.2 (2010-10-03)
---------------------------
-.Additions and changes
-- 'docbook45': Enclosed bibliographic lists in a 'bibliodiv' -- you
- can now include block titles with bibliographic lists.
-- Added optional 'keywords', 'description' and 'title' document header
- meta-data attributes to HTML backends for SEO.
-- AttributeEntry values can span multiple lines with a ' +' line
- continuation.
-- Added 'slidy' backend (based on Phillip Lord's slidy backend
- https://phillordbio-asciidoc-fixes.googlecode.com/hg/).
-- Implemented 'OpenBlock' 'partintro' style for book part
- introductions.
-- Comment lines substitute special characters only.
-- Backend specific global configuration files (all except
- `asciidoc.conf`) are loaded *after* the header has been parsed --
- virtually any attribute can now be specified in the document header.
-- 'xhtml11': Volnitsky theme: allow bulleted lists to have intervening
- children.
-- 'xhtml11': refactored CSS font-family rules to start of file.
-- 'xhtml11': list bullets colored gray.
-- 'ifdef' and 'ifndef' system block macros accept multiple attribute
- names: multiple names separated by commas are 'ored'; multiple
- attribute names separated by pluses are 'anded'.
-- 'xhtml11': Volnitsky theme: set max-width on labeled lists.
-- Vim syntax highlighter: Entities inside quoted text are now
- highlighted.
-- Added 'role' and 'id' attributes to HTML outputs generated by
- 'OpenBlocks'.
-- Allow floating titles to generate 'h1' (level 0) titles in HTML
- outputs.
-- Added a 'start' attribute to numbered lists to set the start number.
- See:
- http://groups.google.com/group/asciidoc/browse_thread/thread/c14a4c3b1e4f6dc5
-- Added two more docinfo attributes 'docinfo1' and 'docinfo2' to allow
- and control inclusion of a shared docinfo file. See
- http://groups.google.com/group/asciidoc/browse_thread/thread/c948697943432e24
-- Vim syntax highlighter highlights multi-name conditional attributes.
-- LaTeX backend patch submitted by Andreas Hermann Braml (see
- http://groups.google.com/group/asciidoc/browse_thread/thread/1c415fc4540ce5e5).
-- Implemented 'backend aliases'; renamed `docbook.conf` to
- `docbook45.conf` and aliased 'docbook45' backend to 'docbook';
- aliased 'xhtml11' to 'html'.
-
-.Bug fixes
-- *FIXED*: Filter commands located in filter directories local to the
- source document that where not in the search 'PATH' where not found.
-- *FIXED*: Volnitsky theme: Verseblock font set normal instead of
- monospaced.
-- *FIXED*: 'xhtml11': Callout icons were not rendered as Data URIs
- when 'icons' and 'data-uri' attributes were specified.
-- *FIXED*: Long standing bug: nested include macros did not restore
- the parent document 'infile' and 'indir' attributes. See:
- http://groups.google.com/group/asciidoc/browse_thread/thread/8712a95e95a292a7
-- *FIXED*: 'html4': set preamble ID anchor.
-- *FIXED*: 'xhtml11': dropped unusable 'id' and 'role' attributes from
- preamble template.
-- *FIXED*: Bug in multi-name conditional attributes e.g. `{x,y#}`
- fails if x or y is undefined.
-- *FIXED*: latex filter not being installed by Makefile. Thanks to
- Grant Edwards for this patch. See
- http://groups.google.com/group/asciidoc/browse_thread/thread/c4427a3902d130a8
-- *FIXED*: 'a2x': Long-standing bug in a2x which always passes
- `--string-param navig.graphics 0` to 'xsltproc', regardless of
- whether icons are enabled or not. Reported by Michael Wild:
- http://groups.google.com/group/asciidoc/browse_thread/thread/59a610068e4acb58
-
-
-Version 8.6.1 (2010-08-22)
---------------------------
-.Additions and changes
-- 'a2x': `--resource-dir` option renamed to `--resource`.
-- 'a2x': `--resource` option accepts both file and directory names.
-- 'a2x': Added `-m,--resource-manifest` option.
-- Added Vim syntax highlighting for quote attribute lists.
-- Load 'asciidoc.conf' from all configuration directories before any
- other configuration files. This ensures that attributes used for
- conditional inclusion are set before backend configuration files are
- processed. Previously if you wanted to control global conf file
- inclusion your only choice was to modify the global 'asciidoc.conf'
- file.
-- AsciiDoc 'Quote element' attributes have been simplified and
- generalized -- positional color and size attributes and named 'role'
- attribute have been replaced by a single positional attribute.
-
-.Bug fixes
-- *FIXED*: 'testasciidoc.py': `BACKEND` command argument was being
- ignored.
-- *FIXED*: Broken 'docinfo' file functionality in 'html4' and
- 'xhtml11' backends (previously the docinfo file was included in
- the 'body' instead of the 'header').
-
-Regression issues
-~~~~~~~~~~~~~~~~~
-This release breaks compatibility with quoted element positional color
-and size attributes (HTML backends). To revert to the deprecated quote
-behavior define the 'deprecated-quotes' attribute in the global
-`asciidoc.conf` file or on the command-line. For a more detailed
-explanation of the rationale behind this change see
-http://groups.google.com/group/asciidoc/browse_thread/thread/b22603bfb879418c.
-
-
-Version 8.6.0 (2010-08-16)
---------------------------
-.Additions and changes
-- The AsciiDoc distribution can now be built ``out of the box''
- from the distribution tarball or the Mercurial repository
- (provided you have the requisite build applications installed).
-- The global configuration files directory is ignored by both
- 'asciidoc' and 'a2x' if AsciiDoc configuration files are installed
- in the same directory as the asciidoc executable. This change
- allows both a system wide copy and multiple local copies of AsciiDoc
- to coexist on the same host PC.
-- CSS 'quirks' mode is no longer the default 'xhtml11' output
- (http://groups.google.com/group/asciidoc/browse_thread/thread/1c02d27d49221aa2).
-- Relaxed anchor ID name syntax
- (http://groups.google.com/group/asciidoc/browse_thread/thread/5f3e825c74ed30c).
-- Added document files: `doc/epub-notes.txt`,
- `doc/publishing-ebooks-with-asciidoc.txt`.
-- 'a2x': If all other resource locations are exhausted then recursively
- search directories named 'images' and 'stylesheets' in the
- 'asciidoc' configuration files directory.
-- 'a2x': options can also be set in the AsciiDoc source file. If the
- source file contains a line beginning with '// a2x:' then the
- remainder of the line will be treated as a2x command-line options.
-- Added dblatex table-width processing instruction -- tables generated
- by dblatex now observe the AsciiDoc table width as a percentage
- (thanks to Gustav Broberg for suggesting this enhancement).
-- 'a2x': Don't exit if the `--epubcheck` option is set and 'epubcheck'
- is missing, issue warning and continue.
-- Added a global 'plaintext' attribute for dealing with large amounts
- of imported text.
-- The author name format has been relaxed, if the the author does not
- match the formal specification then it is assigned to the
- 'firstname' attribute (previously asciidoc exited with an error
- message).
-- FAQ and documentation updates.
-- Refactored chunked.xsl and epub.xsl files.
-- Exchanged article.epub for more relevant book.epub on website.
-- Put asciidoc.epub User Guide on website.
-- 'a2x': Chunking EPUB and HTML outputs set to a per chapter basis and
- the first chapter is separate from preceding contents.
-- Changed dates format in example article and books to suppress EPUB
- validation error.
-- Added 'style' and 'role' CSS classes to xhtml11 section templates.
-- Added the 'role' element to xhtml11 backend block templates.
-- Suppressed md5 module deprecation warning from music and Graphviz filters.
-- Pygments (http://pygments.org/) option added to source code
- highlight filter. Based on Pygments source code filter written by
- David Hajage
- (http://groups.google.com/group/asciidoc/browse_thread/thread/d8d042f5a3021369/8934ebbb8cb7144b).
-- xhtml11: Added a new theme (volnitsky). Written and contributed by
- Leonid V. Volnitsky.
-- xhtml11: Set body element class name to document type.
-- Added refentryinfo element and contents (including revdate) to man
- page DocBook output. Man pages are now dated using the revdate
- attribute value if it has been defined. Based on patch supplied by
- Rainer Muller
- http://groups.google.com/group/asciidoc/browse_frm/thread/319e5cd94493e330/3fcb83fab067af42.
-- Added `{template:...}` system attribute.
-- Table of contents attribute 'toc' can now be specified in the
- document header.
-- Reimplemented music and latex filter -m option functionality when
- the input is stdin using MD5 checksums.
-- Added 'latex' filter.
-- Added auto file name generation to image generating filters
- (latex,music, graphviz).
-- Added `counter2` and `set2` system attributes (to implement image
- auto file name generation).
-- Undefined attribute in filter command generates error but does not
- exit.
-- Attribute substitution proceeds from start line to end line
- (previously was in reverse order which was really confusing).
-- Tidied up music filter code:
- * Format option is optional and default to 'abc' unless Lilypond
- notation detected.
- * The -m option does not apply to stdin input.
-- Added paragraph styles to music and graphviz filters.
-- Documented dynamic template names. 753: Graphviz filter can now
- generate SVG format images. Patch submitted by Elmo Todurov, see:
- http://groups.google.com/group/asciidoc/browse_frm/thread/fe9b33d8f5f1e0af
- The xhtml11 SVG Graphviz template marked EXPERIMENTAL. No SVG
- support for other backends.
-- AsciiDoc template names can now contain embedded attribute
- references.
-- Added 'legalnotice' tag to `doc/article-docinfo.xml` example.
-- xhtml11 backend: Callouts and callout lists display callout icons
- when the 'icons' attribute is defined. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/8eda3ea812968854
-- Document attribute names are case insensitive everywhere, this makes using
-attribute entries more consistent e.g. previously :VERS: had to be refered to
-with {vers} ({VERS} did not work).
-- Hungarian translation of footer-text (submitted by Miklos Vajna).
- See
- http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72#
-- asciidocapi.py 0.1.2: Can now load AsciiDoc script named asciidoc.
- See
- http://groups.google.com/group/asciidoc/browse_frm/thread/66e7b59d12cd2f91
- Based on patch submitted by Phillip Lord.
-- German translation of footer-text (submitted by Simon Ruderich). See
- http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72
-- Pushed HTML footer text into language conf files with the
- introduction of a [footer-text] configuration file template section.
- See
- http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72
-
-.Bug fixes
-- *FIXED*: Sometimes multiple double quoted text elements in the same
- paragraph were mistakenly seen as starting with an inline literal.
- See
- http://groups.google.com/group/asciidoc/browse_frm/thread/219c86ae25b79a21
-- *FIXED*: 'localtime' and 'doctime' attributes calculated incorrect
- daylight saving / non daylight saving timezones and consequently so
- did HTML footers. Patch submitted by Slawomir Testowy. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/af652507caf6cec9
-- *FIXED*: Missing selector for 'List of examples' title in DocBook
- CSS file. Patch submitted by Laurent Laville. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/3f96900f7fbf5620
-- *FIXED*: Broken accents in lang-hu.conf. See:
- http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72
-- *FIXED*: DocBook XSL generated HTML callout lists are properly
- aligned. Submitted by Lionel Orry. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/2ff802547b6a75ea
-- *FIXED*: Filter execution now occurs prior to filter markup template
- substitution to ensure image data URI encoding happens after image
- generation (see
- http://groups.google.com/group/asciidoc/browse_thread/thread/14e8fcb289a135b).
-- *FIXED*: The section numbers no longer increment when the 'numbered'
- attribute is undefined (see
- http://groups.google.com/group/asciidoc/browse_thread/thread/faa36e9e5c7da019/d24cab3fe363e58d).
-
-
-Version 8.5.3 (2010-01-18)
---------------------------
-.Additions and changes
-- a2x: Added a2x configuration file options ASCIIDOC_OPTS,
- DBLATEX_OPTS, FOP_OPTS, XSLTPROC_OPTS (appended to same-named
- command-line options). See
- http://groups.google.com/group/asciidoc/browse_frm/thread/ac4b9bfa2116db28
-- Dropped `.hgignore` from the repository. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea
-- Don't pass verbose options to asciidoc table filter so that
- asciidocapi messages are not discarded. See:
- http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea
-- Added `./tests/data/lang-pt-BR-test.txt` file to the repository.
-- xhtml11: Verse block and verse paragraph content enveloped in a
- 'pre' tag (instead of a 'div') so it renders better in text-only
- browsers. See:
- http://groups.google.com/group/asciidoc/browse_frm/thread/1b6b66adb24e710
-- User Guide: Clarified Passthrough Blocks (suggested by Simon
- Ruderich).
-- FAQ: 'How can I include lines of dashes inside a listing block?'
-- FAQ errata and updates (submitted by Simon Ruderich).
-- User Guide errata.
-- Simplified 'asciidoc-toc' processing instruction and included lists
- of figures, tables, examples and equations in books (i.e. revert to
- pre-8.5.0 behavior).
-- Attempted to have dblatex recognise the 'asciidoc-toc' processing
- instruction but couldn't get it to work.
-- Added 'notitle' attribute to allow the document title to be hidden.
-
-
-.Bug fixes
-- *FIXED*: Regression: system attribute escaping did not work.
-- *FIXED*: Website: broken image links in chunked User Guide.
-
-
-Version 8.5.2 (2009-12-07)
---------------------------
-.Additions and changes
-- Updated example article and book documents with the recommended
- explicit section name syntax (see the 'Special section titles
- vs. explicit template names' sidebar in the AsciiDoc 'User Guide').
-- Added Italian language configuration file (contributed by Fabio
- Inguaggiato).
-- Added 'header' table style. See:
- http://groups.google.com/group/asciidoc/browse_frm/thread/a23fea28394c8ca9
-- Pass 'icons', 'data-uri', 'imagesdir', 'iconsdir' attributes to
- 'asciidoc' table style filter so that images are rendered in table
- cells.
-- Pass 'trace' and 'verbose' attributes to 'asciidoc' table style
- filter so diagnostic information is printed from table cell source.
-- The 'eval' system attribute can be nested inside other system
- attributes.
-- HTML outputs: Table and figure caption punctuation set to more usual
- syntax.
-- docbook backend: footnotes can now contain embedded images. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/50b28f6941de111a
-- CSS tweaks so that tables processed by DocBook XSL Stylesheets have
- the default asciidoc xhtml11 backend styling. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/dfe5204d5b2c9685
-- Block titles take precedence over section titles to avoid titled
- delimited blocks being mistaken for two line section titles (see
- http://groups.google.com/group/asciidoc/browse_frm/thread/f0b6f9989f828c3).
-- Section title trace displays level and title text.
-- FAQ additions.
-- Added `{zwsp}` (zero width space) attribute.
-- Undefined paragraph styles are reported (previously threw a runtime
- error).
-- Eliminated empty preamble generation.
-- Floating titles now processed in all contexts.
-- Implemented auto-lettered appendix names and updated example
- documents.
-- Section numbering can be disabled in HTML outputs with a
- ':numbered!:' AttributeEntry.
-- xhtml11: Nicer default quote block styling.
-- Exclude floating titles from xhtml11 table of contents. Patch
- submitted by Mark Burton (see
- http://groups.google.com/group/asciidoc/browse_frm/thread/14aefc1cb6bd85f5).
-- Enhanced `doc/article-docinfo.xml` example docinfo file.
-- Vim syntax highlighter improvements.
-
-.Bug fixes
-- *FIXED*: Absolute 'imagesdir' and 'iconsdir' attribute path names
- do not work with the xhtml11 data-uri encoding. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6
-- *FIXED*: Regression issue with inline data-uri images. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6
-- *FIXED*: An unexpected error occurred when processing a table
- containing CSV data if the 'cols' attribute was not explicitly
- specified. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/4b0f364b477ec165
-
-
-Version 8.5.1 (2009-10-31)
---------------------------
-.Additions and changes
-- If an AsciiDoc document file begins with a UTF-8 BOM (byte order
- mark) then it is passed transparently through to the output file.
- The BOM is stripped from included files. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/e5e61823ff4203cd
-- Added AsciiDoc 'role' attribute to quoted text. Sets 'class'
- attribute in HTML outputs; 'role' attribute in DocBook outputs. See:
- http://groups.google.com/group/asciidoc/browse_frm/thread/2aa3e5711d243045
-- Conditional attribute syntax extended: they now accept multiple ORed
- or ANDed attribute names.
-- The 'xhtml11' backend dynamically processes footnotes using
- JavaScript.
-- Tidied up and namespaced 'xhtml11' JavaScript.
-- Superceded `javascripts/toc.js` with `javascripts/asciidoc-xhtml11.js`.
-- Added 'disable-javascript' attribute ('xhtml11' backend).
-- Styled HTML footnotes.
-- Added links to HTML footnote refs.
-- Added title attribute to inline image macros to display popup
- ``tooltip'' (HTML outputs only).
-- Single-quoted attribute values are substituted in block macros (just
- like the AttributeList element).
-- For consistency changed underscores to dashes in attribute names.
- Public attributes with underscores retained for compatibility.
-- Added Brazilian Portuguese language configuration file (contributed
- by Thiago Farina).
-- Added 'leveloffset' attribute to make it easier to combine
- documents.
-
-.Bug fixes
-- *FIXED:* a2x: `--dblatex-opts` is now processed last so
- `asciidoc-dblatex.xsl` params can be overridden. Patch submitted by
- Mark Fernandes (see
- http://groups.google.com/group/asciidoc/browse_frm/thread/5215c99dcc865e7d).
-- *FIXED:* An error occurred if a directory in current path with same
- name as executable.
-
-Regression issues
-~~~~~~~~~~~~~~~~~
-There's been quite a bit of tiding up to the xhtml11 JavaScript. The
-most obvious change is that the toc.js script has been superceded by
-asciidoc-xhtml11.js so if you're linking you'll need get a copy of
-the new file from the distribution javascripts directory.
-
-If you use customised xhtml11 configuration file `[header]` and
-`[footer]` sections and you want them to use the new footnotes feature
-then you've got a bit more work to do:
-
-. The onload event expression changed.
-. The new `<div id="content">...</div>` div envelopes document
- content.
-. You need to add `<div id="footnotes">...</div>` div to the
- `[footnotes]` section for footnotes to work.
-. Drop the `ifdef::toc[]` macro that surround JavaScript inclusion.
-
-Take a look at the [header] and [footer] changes in the xhtml11.conf
-diff to see what's going on:
-http://hg.sharesource.org/asciidoc/diff/55a5999bfd04/xhtml11.conf
-
-
-Version 8.5.0 (2009-10-04)
---------------------------
-.Additions and changes
-- Implemented a 'float' attribute for tables and block images (HTML
- outputs only).
-- Added `unfloat::[]` block macro to cancel floating.
-- Added table 'align' attribute to (HTML outputs only).
-- The image 'align' attribute now works with HTML backends.
-- Renamed table cell 'align' attribute to 'halign' so it doesn't clash
- with the new table 'align' attribute.
-- Added 'breakable' and 'unbreakable' options to AsciiDoc example and
- block image elements.
-- `[miscellaneous]` section entries now update properly when set from
- a document 'AttributeEntry'.
-- `[miscellaneous]` section `pagewidth` entry accepts fractional
- values.
-- Fractional column widths are now calculated correctly when using
- fractional 'pageunits' (DocBook tables).
-- Use DocBook XSL table width processing instructions.
-- asciidoc 'KeyboardInterrupt' exits with error code 1.
-- Added 'set' system attribute to allow attributes to be set from
- configuration file templates.
-- Allow constrained quotes to be bounded on the left by a colons and
- semicolons, see
- http://groups.google.com/group/asciidoc/browse_frm/thread/b276a927fdc87995
-- Titled listing and literal blocks (DocBook outputs) no longer default
- to examples. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd
-- Updated language file table, figure and example captions to
- accommodate new auto-numbering in html4 and xhtml11 backends.
-- Titled source highlight filter listings generated by docbook backend
- are now rendered as examples. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd
-- Implemented 'counter' system attribute.
-- Use 'counter' system attributes to number titled tables and block
- images in HTML backends.
-- Added program name suffix to console messages.
-- Added substitution to the 'AttributeEntry' passthrough syntax, this
- replaces the now unnecessary 'attributeentry-subs' attribute.
-- Allow passthrough inline macro syntax to be used in
- 'AttributeEntrys'.
-- Reinstated 8.4.4 default 'lang' attribute behavior. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/d29924043e21cb6a.
-- Added 'max-width' attribute to the 'xhtml11' backend to set maximum
- display width. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/74d9a542b79ccd50.
-- Added 'a2x.py', a rewritten and much enhanced version of the old
- 'a2x' bash script.
-- The new 'a2x' can output EPUB formatted documents.
-- Added `--safe` option and deprecated `--unsafe` option. Patch
- submitted by Todd Zullinger. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/ea3a8ea399ae5d2a
- and
- http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5
-- Added 'CHECK' and 'TEST' todo highlight words to Vim syntax
- highlighter.
-- Line breaks, page breaks, and horizontal rulers are now processed by
- dblatex, thanks to a patch submitted by Mark Fernandes
- (http://groups.google.com/group/asciidoc/browse_frm/thread/a254cf949ea7c6c5).
-- Allow footnote macros hard up against the preceding word so the
- rendered footnote mark can be placed against the noted text without
- an intervening space (patch submitted by Stas Bushuev,
- http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5).
-- Normalized path in `safe_filename` function (submitted by Todd
- Zullinger,
- http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5).
-- The Asciidoc 'numbered' and 'toc' attributes cause DocBook outputs
- to include `asciidoc-numbered` and `asciidoc-toc` processing
- instructions, these are used by DocBook XSL to include section
- numbering and table of contents (like Asciidoc HTML backends). For
- backward compatibility both 'numbered' and 'toc' attributes are
- defined by default when the 'docbook' backend is used. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/1badad21ff9447ac.
-- 'data-uri' attribute is now evaluated dynamically and can be set in
- document body (previously could only be set from command-line).
-- Added 'sys3' and 'eval3' system attributes to passthrough generated
- output, this fixes the data-uri inline image problem:
- http://groups.google.com/group/asciidoc/browse_frm/thread/a42db6bc54c2c537.
-- Missing language file generates a warning instead of an error.
-- Updated Spanish language file (updates contributed by Gustavo Andrés
- Gómez Farhat).
-
-.Bug fixes
-- *FIXED:* Options in an 'AttributeList' option attribute are merged
- with (rather than replace) configuration file options.
-- *FIXED:* Comment blocks and comment block macros no longer consume
- preceding block titles and attribute lists.
-- *FIXED:* `examples/website/layout1.conf` and
- `examples/website/layout2.conf` TOC problem. Submitted by Mark
- (burtoogle). See
- http://groups.google.com/group/asciidoc/browse_frm/thread/b9c63be67dd1d11c
-- *FIXED:* Only the first occurrence of passthrough macro was
- substituted. Patch submitted by Peter Johnson. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/1269dc2feb1a482c
-- *FIXED:* asciidoc now runs on Jython 2.5.0.
-- *FIXED:* Wordpress margins and pads in a number of block
- elements
- (http://groups.google.com/group/asciidoc/browse_frm/thread/36ff073c79cbc20a).
-
-Regression issues
-~~~~~~~~~~~~~~~~~
-- Tables generated by 'dblatex' occupy 100% of the available space
- regardless of the 'width' attribute setting. To restore width
- behavior change the 'pageunits' miscellaneous parameter to 'pt'. You
- can do this from the command-line with the `-a pageunits=pt` option.
- See {website}userguide.html#X89[DocBook table widths].
-
-
-Version 8.4.5 (2009-05-24)
---------------------------
-.Additions and changes
-- Added manpage 'Name' and 'Synopsis' section title customization to languages
- configuration files.
-- Synopsis manpage section no longer mandatory.
-- Section markup templates can be specified by setting the title's
- first positional attribute or 'template' attribute.
-- The article and book document header can now include a revision
- remark.
-- A 'role' attribute can now be applied to block elements. This adds
- the 'role' attribute to DocBook elements. Patch submitted by
- http://groups.google.com/group/asciidoc/browse_thread/thread/62278a054188a038[Noah
- Slater]).
-- Renamed 'revision' and 'date' attributes to more sensible and consistent
- 'revnumber' and 'revdate' (old names deprecated but still
- recognized).
-- Moved backend specific attributes to Appendix H in User Guide.
-- Renamed and generalized the docbook backend revision history
- inclusion mechanism to 'docinfo' to reflect the use of all article
- or book information elements. The old revision history names still
- work but have been deprecated.
-- Refactored docbook.conf headers.
-- Moved line break replacement from `[replacements]` to
- `[replacements2]` so the replacement occurs after the mailto macro.
- This fixes bug
- http://groups.google.com/group/asciidoc/browse_thread/thread/4bdcdfb0af773e2
-- The typewriter to punctuation apostrophe replacement can be escaped
- with a backslash.
-- Graphviz filter outputs images to 'imagesdir' if it is defined.
-- Made the block image macro generic so that it can be used for filter
- outputs. As a result Music and Graphviz filters:
- * Have been greatly simplified.
- * Honor the 'data-uri' attribute.
- * 'html4' outputs no longer generate W3C validation warning.
-- The 'iconsdir' attribute no longer requires a trailing directory
- separator character.
-- Removed borders around linked html4 images.
-- Added 'html4' specific HTML output for music filter.
-- 'a2x': Added `--unsafe` option (shortcut for
- `--asciidoc-opts=--unsafe`).
-- 'a2x': The FOP executable can now be named `fop` (this is the
- default name in some distributions).
-- Attributes are now substituted in the system macro attribute list.
-- If the output is set to stdout (i.e. no output directory is defined)
- then Music and Graphviz filters will output included images to the
- source file directory.
-- Added 'name' directive to 'testasciidoc'.
-- Added lots of 'testasciidoc' new tests.
-- Moved language specific configuration parameters into `lang-en.conf`
- file.
-- 'lang' attribute entry can be specified in the AsciiDoc source file
- (preceding the header).
-- Removed cruft from A-A-P scripts and documented them.
-- Added German language config file (`lang-de.conf`) contributed by
- Michael Wild.
-- Added French language config file (`lang-fr.conf`) contributed by
- Yves-Alexis Perez.
-- Added Russian language config file (`lang-ru.conf`) contributed by
- Artem Zolochevskiy.
-- Added Hungarian language config file (`lang-hu.conf`) contributed by
- Miklos Vajna.
-
-.Bug fixes
-- *FIXED:* Multiple manpage names are now handled correctly when
- generating DocBook output, each name now generates a separate
- DocBook `<refname>` element. See
- http://groups.google.com/group/asciidoc/browse_thread/thread/c93bb4db025225d8
-- *FIXED:* A problem that caused AttributeEntries preceding the header
- to be overwritten when the language conf file loaded.
-- *FIXED:* Possible inline macro name ambiguity e.g. link matches olink.
-- *FIXED:* The documented macro definition deletion behavior had been
- broken for a long time.
-- *FIXED:* Email addresses not recognized when followed by a period
- character.
-- *FIXED:* Hyphens in mailto macros can delimit nested addresses e.g.
- \bloggs@mail was processed inside
- \mailto:joe-bloggs@mail-server.com[Mail].
-- *FIXED:* User name in FTP URI generated incorrect FTP link. See
- http://groups.google.com/group/asciidoc/browse_thread/thread/1d796a9c9ddb2855
-- *FIXED:* Source highlighter now works with Wordpress backend (see
- http://groups.google.com/group/asciidoc/browse_thread/thread/6d8c716748b109e3).
-
-[[X2]]
-Regression issues
-~~~~~~~~~~~~~~~~~
-. A colon following the date in the AsciiDoc header is treated as a
- revision remark delimiter -- this could be an issue if you have used
- a colon in the header date.
-
-
-Version 8.4.4 (2009-04-26)
---------------------------
-.Additions and changes
-- Added table column and row spanning.
-- Table styles can now be applied per cell.
-- Vertical cell alignment can be applied to columns and individual
- cells.
-- Added table 'align' attribute to set horizontal alignment for entire
- table.
-- Included Geoff Eddy's update of the experimental LaTeX backend.
-- A new attribute named 'trace' controls the output of diagnostic
- information. If the 'trace' attribute is defined then
- element-by-element diagnostic messages detailing output markup
- generation are printed to stderr.
-- Added 'literal' paragraph style (allows 'literal' style to be
- applied to normal paragraphs).
-- Deleted unused `replacements2` from `xhtml11.conf`.
-- Added `replacements2` to default substitutions.
-- 'testasciidoc.py': messages to 'stdout', only diffs to 'stderr'.
-- Added transparency to `smallnew.png` image.
-
-.Bug fixes
-- All combinations of leading comments and attribute entries at the
- start of a document are now skipped correctly.
-- *FIXED:* `./configure` doesn't support `--docdir` as expected (patch
- submitted by Artem Zolochevskiy)
-- *FIXED:* Constrained quotes were incorrectly matched across line
- boundaries e.g. the string `+\nabc+` incorrectly matched a monospace
- quote.
-
-
-Version 8.4.3 (2009-04-13)
---------------------------
-.Additions and changes
-- DocBook outputs default to DocBook version 4.5 doctype (previously
- 4.2).
-- Configuration file `[specialsections]` definitions can be undefined
- by setting their configuration entry values blank.
-- The Makefile 'install' target depends on the 'all' target to ensure
- pre-install patches are applied.
-- 'testasciidoc.py' now emits user friendly messages if:
- . the configuration file is missing.
- . an illegal backend is specified.
- . an illegal test number is specified.
-
-.Bug fixes
-- Fixed
- http://groups.google.com/group/asciidoc/browse_thread/thread/fd27add515597c06[missing
- template section] error.
-- The 'testasciidoc.py' `--force` option no longer deletes test data
- files that were not specified.
-- Dropped second quotes substitution in table cells -- it had
- effectively disabled quote escaping in table cells.
-
-
-Version 8.4.2 (2009-03-19)
---------------------------
-.Additions and changes
-- Added {website}testasciidoc.html[testasciidoc], a tool to verify
- AsciiDoc conformance.
-- A warning is issued if nested inline passthroughs are encountered.
-- 'asciidocapi': setting an attribute value to `None` will undefine
- (delete) the attribute (this in addition to the `name!` attribute
- name format that the `asciidoc(1)` command uses).
-
-.Bug fixes
-
-
-Version 8.4.1 (2009-03-10)
---------------------------
-.Additions and changes
-- AsciiDoc now has a {website}asciidocapi.html[Python API]. The
- following minimal example compiles `mydoc.txt` to `mydoc.html`:
-+
-[source,python]
--------------------------------------------------------------------------------
-from asciidocapi import AsciiDocAPI asciidoc = AsciiDocAPI()
-asciidoc.execute('mydoc.txt')
--------------------------------------------------------------------------------
-
-- Backtick quoting for monospaced text is now implemented as an
- 'inline literal' passthrough. This makes more sense since monospace
- text is usually intended to be rendered literally. See
- <<X2,Regression issues>> below for the impact this may have on
- existing documents. Here are some examples that would previously
- have had to be escaped:
-
- The `++i` and `++j` auto-increments.
- Paths `~/.vim` and `~/docs`.
- The `__init__` method.
- The `{id}` attribute.
-
-- Added `--doctest` option to `asciidoc(1)` command.
-- Added an optional second argument to 'BlockId' element, this sets
- the `{reftext}` attribute which in turn is used to set the `xreflabel`
- attribute in DocBook elements.
-- Added lists to `--help` syntax summary.
-- `{infile}` and `{indir}` attributes reflect the current input file
- (previously always referred to the root document).
-- `{docfile}` (new) and `{docdir}` (previously deprecated) attributes
- refer to the root document specified on the `asciidoc(1)`
- command-line.
-- Vim syntax highlighter improvements.
-- Syntax summary command (`asciidoc -h syntax`) additions.
-- Admonition icons now have transparent backgrounds.
-- Changed yellow W3C badges to blue ones in page footers.
-
-.Bug fixes
-- Dropped `asciidoc(1)` broken undocumented `--profile` option.
-- Em dash replacement now recognized at start of block.
-
-Regression issues
-~~~~~~~~~~~~~~~~~
-Replacing backtick quoting with the 'inline literal' passthrough
-raises two regression scenarios for existing documents:
-
-1. You have escaped the expansion of enclosed inline elements, for
- example: `\{id}`. You would need to delete the backslashes: `{id}`
- (if you don't the backslashes will be printed). Mostly it's just a
- case of interactively finding and replacing of all occurrences of
- `\.
-
-2. There are enclosed inline elements, for example: `some *bold*
- monospaced`. You would need to switch to plus character monospace
- quoting: `+some *bold* monospaced+` (if you don't the enclosed
- elements won't be expanded).
-
-If your existing documents include these cases and you don't want to
-upgrade then use the `-a no-inline-literal` command-line option,
-alternatively put this in `~/.asciidoc/asciidoc.conf`:
-
- [attributes]
- no-inline-literal=
-
-
-Version 8.3.5 (2009-02-02)
---------------------------
-.Additions and changes
-- Cached compiled regular expression delimiters (speed up 'User
- Manual' compilation by 250%).
-- Created distinct list definitions for each numbered list style to
- allow nesting of all styles.
-- Roman numbers in numbered lists are followed by a closing
- parenthesis instead of a period to eliminate 'i', 'v', 'x' item
- ambiguity with respect to alpha numbered list items.
-- Added `**`, `***`, `****`, `*****`
- bulleted lists.
-- Added `...`, `....`, `.....` implicit numbered
- lists.
-- Added `:::`, `::::` labeled lists.
-- Updated User Guide for new list syntaxes.
-- Optimized paragraph and list termination detection with separate
- precompiled regular expressions for performance and to prevent
- reaching Python 100 named group limit.
-- Updated Vim syntax highlighter for new list syntaxes.
-- Allow `template::[]` macros in conf file entries sections (not just
- in template sections).
-- Dropped unused `[listdef-numbered2]` conf file sections.
-- Renamed 'ListBlock' to more appropriate 'OpenBlock'.
-- Implemented single-line versions of `ifdef::[]` and `ifndef::[]`
- macros.
-- 'html4' backend styling:
- * Underlined admonition captions.
- * Added side border to Example Blocks.
-- 'xhtml11' backend styling:
- * Dropped right hand margin from all but quote and verse blocks.
- * html4 backend: corrected over-sized width of caption in admonition
- block.
-
-.Bug fixes
-- Fixed broken numbered list nesting.
-
-Compatibility issues
-~~~~~~~~~~~~~~~~~~~~
-The roman numbered list parenthesis syntax is incompatible with the
-potentially ambiguous roman period syntax introduced in 8.3.2.
-
-
-Version 8.3.4 (2009-01-20)
---------------------------
-.Additions and changes
-- Implemented a title 'float' style. A floating title (or bridgehead)
- is rendered just like a normal section but is not formally
- associated with a text body and is not part of the regular section
- hierarchy so the normal ordering rules do not apply.
-- Implemented inline comment macro so comment lines can now appear
- inside block elements.
-- Comment lines are sent to the output if the 'showcomments' attribute
- is defined (comment blocks are never sent to the output).
-- Single quoting attribute values in 'AttributeList' elements causes
- them to be substituted like normal inline text (without single
- quoting only attribute substitution is performed).
-- Rewrote list item processing (was very crufty). List continuation
- and list blocks now work as expected. Updated and clarified list
- documentation in User Guide.
-- The 'revision' attribute now recognizes the RCS $Id$ marker format.
-- An RCS $Id$ marker formatted revision line in the header does not
- need to be preceded by an author line.
-- If an RCS $Id$ formatted revision is specified and the author name
- has not already been set then the author name in the $Id$ marker
- will be used.
-- Updated Gouichi Iisaka's Graphviz filter to version 1.1.3.
-- Added 'autowidth' table attribute option for (X)HTML outputs.
-- DocBook backend now puts 'orgname' optional attribute in DocBook
- header.
-- Deprecated undocumented 'companyname' attribute in favor of
- DocBook's 'corpname'.
-- Removed explicit closing backslash from HTML4 self-closing tags to
- comply with WC3 recommendation.
-
-.Bug fixes
-- Fixed 8.3.3 regression whereby adjacent lists with the same syntax
- but different list styles were incorrectly treated as a single list.
-
-
-Version 8.3.3 (2009-01-02)
---------------------------
-This release supersedes 8.3.2.
-
-.Bug fixes
-- The broken and confusing numeration and numeration2 numbered list
- attributes have been dropped, use the style attribute instead.
-
-
-Version 8.3.2 (2009-01-01)
---------------------------
-.Additions and changes
-- Added Gouichi Iisaka's Graphviz filter to distribution.
-- The 'SidebarBlock' element can now be rendered with an 'abstract'
- style.
-- Reorganized filters into a separate subdirectory for each filter.
-- Updated `Makefile.in` and `MANIFEST` files to reflect new filters
- organization.
-- Added 'listing' style to 'LiteralBlock' element so listings with
- nested listing blocks can be rendered as a listing block.
-- Changed example 'code' filter to use preferred 'ListingBlock' syntax
- (the old `~` delimited filter syntax is no longer used).
-- Implemented 'enumeration' and 'enumeration2' numbered list
- attributes for specifying the list numbering style ('arabic',
- 'loweralpha', 'upperalpha', 'lowerroman' and 'upperroman').
-- AsciiDoc now recognizes 'upperalpha', 'lowerroman' and 'upperroman'
- numbers in `listdef-numbered2` numbered lists and sets the number
- style based on the style of the first numbered list item
- (alternative to setting 'enumeration2' attribute).
-- Updated `formatlistpat` definition in `.vimrc` example in User
- Guide.
-- You can now backslash escape system block macros.
-- Added 'Pychart' FAQ.
-- Drop paragraph 'text' and list 'text', 'index' and 'label' match
- groups from attributes -- they are included in the element's text
- and we don't want them processed a second time as attributes.
-- Changed comment line block macro to a passthrough block macro to
- ensure no substitutions.
-- A 'subslist' no longer has to be appended to a 'PassthroughBlock'
- macro definition, if omitted no substitutions are performed.
-- Code tidy up: replaced deprecated `<>` operator with `!=`.
-- Removed unused linuxdoc code.
-- Code tidy ups: dropped old types module reference; replaced
- `has_key()` with preferred `in` operator.
-
-.Bug fixes
-- Old syntax source highlight filter regression: special characters
- where not escaped in DocBook outputs.
-
-
-Version 8.3.1 (2008-12-14)
---------------------------
-.Additions and changes
-- Replaced the `install.sh` script with Ben Walton's updated autoconf
- scripts -- see {website}INSTALL.html[INSTALL] for details.
-- Added a generalized 'AttributeEntry' syntax to allow arbitrary
- configuration file entries to be set from within an AsciiDoc
- document (suggested by Henrik Maier).
-- Listing delimited blocks in DocBook outputs now support IDs; IDs of
- titled Listing and Literal delimited blocks have been moved to the
- enclosing DocBook example tag (thanks to Vijay Kumar for this
- patch).
-- Replaced vertical typewriter apostrophe with punctuation apostrophe
- (thanks to Noah Slater).
-
-.Bug fixes
-- Regression: Excluding double-quotes from unquoted attribute values
- resulted in backward incompatibility, double-quotes in unquoted
- attribute values has been reinstated.
-- Regression: Text like `&...;` was sometimes mistaken for an entity
- reference -- tightened up entity reference matching.
-
-
-Version 8.3.0 (2008-11-29)
---------------------------
-.Additions and changes
-- {website}newtables.html[AsciiDoc new tables] is a complete redesign
- of the tables syntax and generation. The new syntax and features are
- a huge improvement over the old tables. The old tables syntax has
- been deprecated but is currently still processed.
-- {website}newlists.html[Lists can now be styled] like other block
- elements. This allows a single list syntax for 'glossary', 'qanda'
- (Question and Answer) and 'bibliography' lists instead of having to
- remember a different syntax for each type.
-- Inline passthroughs macros have been improved and block passthrough
- macros added. Attribute substitution can be optionally specified
- when the macro is called.
-- The passthrough block has a fully transparent passthrough delimited
- block block style called 'pass'.
-- The 'asciimath' and 'latexmath'
- {website}userguide.html#X77[passthrough macros] along with
- 'asciimath' and 'latexmath' {website}userguide.html#X76[passthrough
- blocks] provide a (backend dependent) mechanism for rendering
- mathematical formulas. There are {website}latexmath.pdf[LaTeX Math],
- {website}asciimathml.html[AsciiMathML] and
- {website}latexmathml.html[LaTeXMathML] examples on the AsciiDoc
- website.
-- Reimplemented and cleaned up filter processing based on a patch
- submitted by Kelly Anderson. Uses the newer subprocess module
- instead of the deprecated popen2 module. Now works in Win32 command
- shell.
-- Addition FAQs, more documentation updates.
-- Arbitrary HTML/XML entities can be entered in AsciiDoc source.
-- Did away with the need for the `shaded-literallayout.patch` (thanks
- to Henrik Maier for this patch).
-- Implemented 'page break' block macro.
-- Added 'line breaks' and 'ruler' processing instructions to DocBook
- outputs (thanks to Henrik Maier for this patch).
-- Added 'deg' (degree) and 'wj' (word joiner) entity attributes
- (thanks to Henrik Maier).
-- Tweaked DocBook 'indexterm2' macro to avoid white space preceding
- the term when used in table cells (thanks to Henrik Maier for this
- patch).
-- Title elements now process the 'options' attribute like other block
- elements.
-- Added `single quoted' element.
-- Spaces on both sides of a -- em-dash are translated to thin space
- characters.
-- Improved detection and reporting of malformed attribute lists.
-- The list 'compact' style is now a list option.
-- Added 'strong' labeled list option which makes the labels bold (HTML
- outputs only).
-- Dropped unsupported 'linuxdoc' backend.
-- Dropped deprecated 'xhtml-deprecated' (version 6) backend.
-- Added 'breakable' and 'unbreakable' attribute options to tables to
- control table breaking across page boundaries (DocBook XSL/FO
- outputs). By and in collaboration with Henrik Maier.
-- Added 'pgwide' attribute option to tables to table, block image,
- horizontal labeled lists. Specifies that the element should be
- rendered across the full text width of the page irrespective of the
- current indentation (DocBook XSL/FO outputs). Thanks to Henrik Maier
- for this patch.
-- Vim syntax highlighter: spaces before/after bullets no longer
- highlighted (which is ugly if using a theme that highlights with
- underlines). Thanks to Donald Chai for this patch.
-- Added `a2x(1)` `--fop` option.
-- Added `a2x(1)` `--no-xmllint` option.
-- Highlighted labelled list terms with the navy color in XHTML
- outputs.
-- Use `w3m(1)` as default `a2x(1)` text format generator (fallback to
- `lynx(1)`).
-- Changed callout formats in html4 and xhtml11 outputs to angle
- brackets to match source highlighter rendering.
-- Macros now inject user defined `<optionname>-option` attributes into
- markup.
-- Added IRC URLs to AsciiDoc inline macros.
-- Added `depth` attribute to `include::[]` system macro.
-- Added 'footnoteref' inline macro.
-- Added 'stylesheet' XHTML attribute to specify additional custom CSS
- stylesheet.
-- If a paragraph style is specified it will be added to the XHTML
- 'class' attribute and DocBook 'role' attribute.
-- Replacements can be set in a document using the reserved
- AttributeEntry name 'replacement'.
-- The prefix for auto-generated section name IDs can be set with the
- 'idprefix' attribute.
-
-.Bug fixes
-- Escaped quote skipped over leading and trailing quote instead of
- just the leading quote.
-- Fixed bug that was causing false negative safe mode warnings (patch
- submitted by Julien Palmas).
-- Placed priority of AttributeEntry, AttributeList and BlockTitle
- above Title. This ensures an AttributeEntry, AttributeList or
- BlockTitle followed by a same length leading ListingBlock delimiter
- is not mistaken for a two-line title.
-- Vim syntax highlighter: fixed multi-line quoted text.
-- Contstrained quote termination after non-space character enforced.
-- Vim syntax highlighter: unterminated quoted text is no longer
- highlighted.
-- Vim syntax highlighter: passthroughs now exactly match AsciiDoc
- semantics.
-- Vim syntax highlighter: escaped quoted text, attribute references
- and inline macros are not highlighted.
-- Vim syntax highlighter: TODO's highlighted in CommentBlocks (thanks
- to Scott Wall); non-greedy pass:[$$...$$].
-- Vim syntax highlighter: Comment lines mistaken for vertical list
- labels (thanks to Scott Wall).
-- Vim syntax highlighter: Single unmatched $$ mistakenly highlighted
- remaining text (patch contributed by Scott Wall).
-- Callouts now work in source highlighted listing generated by
- dblatex.
-- Fixed exception that occured if undefined attribute was present in
- filter command.
-- AttributeList block can now follow a paragraph without intervening
- blank line.
-- The include macro tabsize attribute is no longer propagated to
- nested includes.
-
-.Omissions
-The following features were implemented but then but removed from this
-release:
-
-- 'pi', 'cdata' and 'comment' passthrough macros and passthrough block
- styles (creeping featurism, use 'pass' macros instead).
-- Generic 'tag' inline macro (creeping featurism, use 'pass' macros
- instead).
-
-
-[[X1]]
-Compatibility issues
-~~~~~~~~~~~~~~~~~~~~
-Version 8.3.0 has a number of backward incompatibilities with respect
-to the previous 8.2.7 release:
-
-- The old table syntax is still processed but a 'DEPRECATED' warning
- is issued.
-- Entity references have to be escaped with a backslash.
-- You have to explicitly precede horizontal style labeled lists with
- the `[horizontal]` style attribute -- by default all labeled lists
- are rendered vertically.
-- The list 'compact' style has been dropped and is now a list option
- (use `options="compact"` in attribute lists).
-- AsciiDoc version 6 sytnax no longer supported.
-- Linuxdoc been removed from the distribution.
-- The unsupported experimental 'latex' backend has not been tested on
- this release.
-- The introduction of single-quote quoting requires that double-quote
- quoting is escaped with two backslashes.
-
-
-Version 8.2.7 (2008-07-04)
---------------------------
-.Additions and changes
-- Added `dvi`, `ps` and `tex` output format options to a2x(1).
-- Added `--dblatex` option to a2x(1) so `dblatex(1)` can be used to
- generate PDFs.
-- Added custom `dblatex(1)` configuration files (in distribution
- `./dblatex` directory) that are used by a2x(1).
-- `dblatex(1)` is now used to generate the distributed PDF version of
- the AsciiDoc User Guide.
-- If you don't need a customized the link caption you can enter the
- 'http', 'https', 'ftp', 'file' URLs and email addresses without any
- special macro syntax -- you get the links by just cutting and
- pasting URLs and emails addresses. This also makes it easier to open
- links directly form AsciiDoc source ( most editors allow you to open
- URLs directly). The Vim syntax highlighter has been updated to
- reflect these changes.
-- Highlighted source code paragraphs have been implemented -- it's a
- much more convenient way to enter short code examples (see
- http://www.methods.co.nz/asciidoc/source-highlight-filter.html[the
- online docs]).
-- The source highlighter and music filter syntax has changed -- they
- now used the ListingBlock syntax customized with 'source' and
- 'music' style attribute values. This follows the Paragraph styling
- convention introduced by the source paragraph (previous item) and is
- easier to read. The old syntax still works but has been deprecated.
-- QuoteBlocks now have a 'verse' style -- you no longer have to nest a
- 'verse' LiteralBlock inside a QuoteBlock for verses. The 'verse'
- style on the LiteralBlock has been deprecated (still works though)
- and the 'style' attribute is positional attribute 1, pushing
- 'attribution' and 'citetitle' attributes to the right (you'll need
- to insert a 'quote' attribute into your existing QuoteBlocks).
-- It is no up to the DocBook processor to highlight source code syntax
- in `<programlisting>` elements rather than GNU Highlighter -- this
- is the correct way to handle it, plus `dblatex(1)` makes a much
- better job.
-- 'scaledwidth' and 'align' attributes have been added to the 'image'
- macro. They apply to DocBook outputs (specifically for PDF
- documents). 'scaledwidth' sets the image size as a percent of the
- available page width; 'align' applies 'left', 'center' or 'right'
- horizontal image justification.
-- Added a2x(1) `--fop-opts=FOP_OPTS` option (patch submitted by Miklos
- Vajna).
-- Added a2x(1) `--dblatex-opts=DBLATEX_OPTS` option.
-- Added Mikhail Yakshin's FOP 0.95 patch which fixes a long-standing
- `fo.xsl` problem and allows PDF's to be generated with FOP 0.95
- (previously had to use FOP 0.20.5).
-- The User Guide has been updated and outdated FOP configuration and
- installation sections removed.
-
-.Bug fixes
-- Fixed `stylesheets/xhtml11-manpage.css` not being included when
- 'linkcss' attribute was used.
-- Configuration file `*-style` attributes are now dumped correctly.
-- Fixed 'FAILED: malformed section entry' LaTeX backend error.
-
-See the also the https://sharesource.org/hg/asciidoc/[AsciiDoc
-repository changelog].
-
-
-Version 8.2.6 (2008-04-29)
---------------------------
-.Additions and changes
-- Enhancements to the Vim AsciiDoc syntax highlighter, for example,
- quoted text is now highlighted in titles and macro captions.
-- If you define the `data-uri` intrinsic attribute images referenced
- by 'image' macros will be embedded in XHTML using the
- http://en.wikipedia.org/wiki/Data:_URI_scheme[data: URI scheme].
- *NOTE*: Microsoft browser support for the 'data: URI scheme' is
- currently limited to MSIE 8 beta 1.
-- Added `toc-title` attribute to allow custom table of contents
- titles.
-- Added references to Alex Efros's AsciiDoc Cheatsheet to AsciiDoc
- website.
-- `asciidoc(1)` and `a2x(1)` man pages formatted to conform to
- `man-pages(7)` recommendations.
-- Old code-filter syntax (pre-8.1.0) is no longer recognized so that
- malformed two-line level 2 titles are no longer confused with
- 'code-filter' block delimiters.
-- Added -> <- => <= arrow replacements from the Arrows block of
- Unicode.
-- Added DocBook refentry lang attribute -- patch contributed by
- VMiklos.
-- AttributeEntry names can now be numeric (``named macro targets'').
-- Hide Table of Contents title if Table of Contents empty -- patch
- contributed by Alex Efros.
-- Various XHTML CSS tweaks.
-- Code cleanup:
- * Replaced `realpath()` with Python 2.2 `os.path.realpath()` library
- function.
- * Replaced old string library functions with string methods.
- * Use file generators instead of `readlines()`.
- * Renamed entities that shadowed builtins.
- * Standardized string quoting.
- * Dropped `readlines()` function.
-
-.Bug fixes
-- Fixed broken CSS for decimal ordered lists nested in alpha ordered
- list, thanks to Alex Efros.
-- A missing closing block delimiter now reports the opening delimiter
- line number instead of the end of file line number.
-- Fixed an error generated by the asciidoc `-e` option when there are
- no block definitions -- patch contributed by Alejandro Mery.
-- Handle both `\r\n` (as well as `\n`) line separators that may be
- returned by `{sys}` attribute evaluation.
-- Numbered attribute names no longer interfere with positional
- attribute list values.
-
-
-Version 8.2.5 (2007-11-18)
---------------------------
-.Additions and changes
-
-.Bug fixes
-- Fixed exception thrown by illegal command-line arguments.
-- Rolled back the 'with' warning bug fix introduced in 8.2.4 -- it was
- incompatible with Python <2.5.
-
-
-Version 8.2.4 (2007-11-10)
---------------------------
-.Additions and changes
-- You can now use the `lang` attribute to set the DocBook language
- attribute.
-- Attribute values can now contain attribute references.
-- If the `lang` attribute is defined then configuration files named
- like `lang-<lang>.conf` will be loaded automatically.
-- The help file name `help-<lang>.conf` is based on the AsciiDoc
- `lang` attribute, defaults to `help.conf` (English).
-- Admonition, figure and table captions have been factored into a
- predefined set of `caption_*` attributes. They only apply to
- directly generated (X)HTML outputs (DocBook stylesheets generate
- their own language specific captions based on the `lang` attribute).
-- Dropped platform dependent `doc/asciidoc.chm` file from
- distribution documentation formats.
-
-.Bug fixes
-- The spurious warning 'with will become a reserved keyword
- in Python 2.6' has been suppressed.
-
-
-Version 8.2.3 (2007-09-12)
---------------------------
-.Additions and changes
-- Added VMiklos's 'permalink' patch for auto-generated section IDs
- (enabled by default by the `sectids` attribute).
-- Added http://www.methods.co.nz/asciidoc/faq.html[FAQ] to website.
-- Changed format of \{localdate} attribute to ISO 8601 (`%Y-%m-%d`).
-- Added `abc2ly --beams=None` option to make `music2png.py` conform to
- ABC's notion of beams.
-- XHTML level 2 section headings are now styled with an underlining
- border.
-- XHTML links to AsciiDoc title elements are now implemented with
- title ID attributes (previously separate `<a>` element targets were
- generated.
-- Multi-word first, middle and last names can be entered in the header
- author line using the underscore as a word separator.
-- The nested inline macros restriction has now been lifted, for
- example you can now include links and inline images inside
- footnotes.
-- Help topic names can be shortened (so long as they are not
- ambiguous). For example `asciidoc -hm` will print the AsciiDoc man
- page.
-- Added `{two_colons}` and `{two_semicolons}` attributes for
- escaping labeled list ambiguity.
-- If quirks mode is disabled the XHTML Mime Type is set to the
- recommended `application/xhtml+xml` (rather than `text/html`).
-
-.Bug fixes
-- Author information is now correctly set when using attribute entries
- in the header instead of an author line (previously the 'author'
- attribute was not being calculated correctly and there were
- attribute substitution problems).
-
-
-Version 8.2.2 (2007-07-22)
---------------------------
-.Additions and changes
-- http://www.maths.nottingham.ac.uk/personal/drw/lm.html[LaTeXMathML]
- capability has been added for users who are more familiar with or
- prefer LaTeX math formulas to the
- http://www.methods.co.nz/asciidoc/asciimathml.html[ASCIIMathML]
- notation (thanks to Arthur Sakellariou for the patch).
-- The 'source highlight' and 'code' filters now process embedded
- callouts.
-- Added an `--attribute=ATTRIBUTE` option to `a2x(1)` for passing
- attribute values to asciidoc(1) (a shortcut for `--asciidoc-opts="-a
- ATTRIBUTE"`).
-- Image block and inline macros prepend optional `{imagesdir}`
- attribute to image link targets.
-
-
-.Bug fixes
-- Fixed an assertion error that occurred when a configuration file
- containing an `include::[]` macro was loaded using the
- `--conf-file` option and the configuration file name did not
- include an explicit directory path -- patch submitted by Dmitry
- Potapov.
-- Asciidoc titles are only converted to lower case if all characters
- are upper case otherwise case is left unchanged -- patch submitted
- by Dmitry Potapov.
-- Added a missing check that input is not stdin before loading
- configuration files from the document directory -- patch submitted
- by Dmitry Potapov.
-- Attribute list items must evaluate to strings, numbers or None
- (previously it was possible to evaluate to other object types which
- resulted in surprising attribute values).
-- If an AsciiDoc document has no title an empty XHTML 1.1 'title'
- element is created -- previously the 'title' element was dropped
- which resulted in invalid XHTML 1.1.
-- The Vim syntax file no longer highlights escaped callouts.
-- The Vim syntax highlighter now correctly highlights Double-dollar
- passthroughs when they enclose dollar delimited ASCIIMathML and
- LaTeXMathML formulas.
-
-
-Version 8.2.1 (2007-04-06)
---------------------------
-.Additions and changes
-- A number of improvements have been made to the Vim syntax
- highlighter, for example the word C++ is no longer mistaken for the
- start of an unconstrained monospace quote.
-- Labeled list definitions have been tightened -- a list label can no
- longer containing trailing spaces. The following example is no
- longer recognized as a valid list label:
-
- Lorum ipsum ::
-+
-This change implements the originally intended behavior (as per the
-AsciiDoc documentation and examples) so there should be very few
-compatibility issues.
-
-.Bug fixes
-
-
-Version 8.2.0 (2007-04-04)
---------------------------
-.Additions and changes
-- A Vim syntax file is now included in the AsciiDoc distribution
- (inspired by Felix Obenhuber's `asciidoc.vim` script). You can find
- it (along with a Vim filetype detection script in the distribution
- `./vim/` directory (the scripts are installed automatically by the
- AsciiDoc installer `./install.sh`). See 'Appendix J' of the
- 'AsciiDoc User Guide' for details.
-- Added 'toclevel' attribute (1..4) which sets the number of title
- levels reported in the table of contents. Defaults to 2 and must be
- used with the 'toc' attribute. Example usage:
-
- $ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt
-
-- Added a `listindex` attribute which is the current list item index
- (1..). If this attribute appears outside a list its value is the
- number of items in the most recently closed list.
-- The single line titles syntax now accepts trailing suffixes -- this
- syntax matches the title line syntax of a number of popular Wiki
- markups.
-- If a QuoteBlock has no attribution or citetitle then the DocBook
- `<attribution>` element is not generated (previously generated empty
- `<attribution>` element).
-- If the text of a labeled list item is blank then no `texttag` is
- written.
-- An end of line backslash performs line continuation for horizontal
- labeled list items.
-- The Revision line now accommodates Subversion `$Id` markers (in
- addition to CVS and RCS markers). Thanks to Tiago Sturmer Daitx for
- this patch.
-- Implemented `a2x(1)` option `--skip-asciidoc` which allows `a2x(1)`
- to convert DocBook XML files not derived from AsciiDoc sources.
-- If `a2x(1) --doctype` option is not specified it defaults to
- `manpage` if `--format=manpage` else defaults to `article`
- (previously `--doctype` always defaulted to `article`).
-- Added an 'External Resources' section to the
- http://www.methods.co.nz/asciidoc/index.html[AsciiDoc home page].
-
-.Bug fixes
-
-
-Version 8.1.0 (2006-10-22)
---------------------------
-.Additions and changes
-- AsciiDoc generated XHTML documents now display a table of contents
- if the 'toc' attribute is defined (JavaScript needs to be enabled
- for this to work). Thanks to Troy Hanson who contributed this
- feature based on a JavaScript by Mihai Bazon. I've simplified things
- somewhat to match Docbook XSL Stylesheets style, see Troy's
- http://tpl.sourceforge.net/userguide.html[tpl User Guide] for a
- fancier layout. Use the `-a toc -a numbered` command-line options to
- produce a number table of contents.
-- A http://www.methods.co.nz/asciidoc/music-filter.html[music filter]
- is included in the distribution `./filters/` directory. It
- translates music in http://lilypond.org/[LilyPond] or
- http://abcnotation.org.uk/[ABC] notation to standard classical
- notation in the form of a trimmed PNG image which is inserted into
- the AsciiDoc output document.
-- Incorporated Paul Melis's Win32 filter patch. This workaround
- allows AsciiDoc to run filters under Windows.
-- Added `uninstall.sh` script.
-- Rather than proliferate a confusing number of filter block
- delimiters the following convention has been adopted: delimiters
- belonging to DelimitedBlock filters distributed with AsciiDoc will
- consist of a word (normally a noun identifying the block content)
- followed by four or more tilde characters. This has necessitated
- changing existing filter delimiters (the old delimiters still work
- but may be deprecated in future versions):
-
- * The example code filter block delimiter is now the word `code`
- followed by four or more tilde characters.
- * The source highlight filter block delimiter is now the word
- `source` followed by four or more tilde characters.
-
-- Conditionally redefined subscript and superscripting so they use the
- old replacements mechanism when asciidoc7compatible is defined
- rather than the asciidoc 8 default unconstrained quoting (patch for
- affected files attached).
-- Moved the source highlight filter from `./examples/` to `./filter/`.
-- Added `{verbose}` intrinsic attribute (useful for passing verbose
- flag to filters).
-- Added `{outdir}` intrinsic attribute.
-- Renamed `{docdir}` intrinsic attribute to unambiguous `{indir}`
- (`{docdir}` still works but may be removed in future release).
-- If `asciidoc(1)` outputs to stdout then intrinsic attribute
- `{docname}` is extracted from the input file name.
-
-
-Version 8.0.0 (2006-08-27)
---------------------------
-*********************************************************************
-This is a major release because changes to quoting and index entry
-handling may break existing documents (see 'Additions and changes'
-below and 'Appendix A: Migration Notes' in the AsciiDoc User Guide).
-
-Please report any problems you encounter.
-
-mailto:srackham@gmail.com['Stuart Rackham']
-*********************************************************************
-
-.Additions and changes
-- Quoting can can occur within words (based on patch submitted by
- Benjamin Klum). See the 'Unconstrained Quotes' sub-section in the
- User Guide.
-
-- The underline and plus characters can be used as alternatives to the
- existing apostrophe and backtick quote characters. They are arguably
- better choices than the apostrophe and backtick as they are not
- confused with punctuation.
-
-- The syntax for index entry macros have have been deprecated from
- `+...+` and `++...++` to `((...))` and `(((...)))` respectively.
- Rationale:
- * Bracketing is consistent other with `[[...]]` and `<<...>>`
- reference macros.
- * To easily confused with triple plus passthroughs.
- * To make way for the new monospace quoting.
-
-- Superscripts and subscripts are implemented as constrained quotes so
- they can now be escaped with a leading backslash and prefixed with
- with an attribute list.
-
-- An experimental LaTeX backend has been written by Benjamin Klum (a
- number additions in this release are to accommodate the LaTeX
- backend).
-- `include` macro file names now expand environment variables and
- tilde expansions.
-- A configuration file `[quotes]` entry can be undefined by setting to
- a blank value.
-- Added `callto` inline macro for Skype 'callto' links.
-- Added `colnumber` attribute for table data markup.
-- A leading comment block or comment lines are now skipped (previously
- a document had to start with either attribute entries or a document
- Title).
-- Experimental `rows` attribute (number of source lines in table)
- available in table markup templates (used by experimental LaTeX
- backend).
-- Included install shell script written by mailto:jlm@ofb.net[Jacob
- Mandelson] for installing the tarball distribution.
-- Added INSTALL documentation file.
-- Added 'replacements2' substitution options -- a second replacements
- section.
-- Added the ability to redefine 'normal' and 'verbatim' substitutions
- with `subsnormal` and `subsverbatim` entries in configuration file
- `[miscellaneous]` section.
-- By default `AttributeEntry` values are substituted for
- `specialcharacters` and `attributes`, if you want a different
- AttributeEntry substitution set the `attributeentry-subs` attribute.
-- The `name` in `name=value` configuration file entries can now end
- with a backslash, just escape the trailing backslash with a
- backslash. For example:
-
- abc\\=xyz
-+
-Results in `name=abc\` and `value=xyz` -- previously this would have
-escaped the `=` character.
-
-- A blank configuration file section deletes any preceding section
- with the same name (applies to non-markup template sections).
-- A command-line attribute value with a `@` suffix does not override
- existing document and configuration file attributes (normally
- command-line attributes have precedence over document and
- configuration file attributes).
-- `localtime` attribute is now encoded from the native system encoding
- to the output encoding. Patch submitted by
- mailto:m_pupil@yahoo.com.cn[FKtPp] -- here's his description of the
- problem:
-+
-``I am a Chinese user of AsciiDoc and I find that when I use UTF-8
-(the default encoding) to write asciidoc documents in Windows platform
-the resulting html footer line will get screwed. It was caused by a
-localized tzname that was always encoded in the windows native
-encoding, which in my case is 'cp936'.''
-
-- a2x(1) can generate Open Document Text files using
- http://open.comsultia.com/docbook2odf/[docbook2odf]. Currently
- `docbook2odf(1)` only processes a subset of DocBook, unimplemented
- elements are skipped.
-- The a2x(1) format option defaults to `xhtml` (previously a format
- had to be specified explicitly).
-- The `-d, \--doctype=DOCTYPE` option has been added to a2x(1) which
- is a shortcut for `--asciidoc-options="--doctype=DOCTYPE"`.
-- Replaced a2x(1) `--no-icons` and `--no-copy` options with their
- negated equivalents: `--icons` and `--copy` respectively. The
- default behavior has also changed: copying and use of icons is
- disabled by default. Rationale:
- * To make the default behavior more consistent since use of icons
- and CSS stylesheets does not apply to all formats.
- * To make the default behavior less surprising (the creation of icon
- and stylesheet output files must now be explicit).
-
-- a2x(1) has been bumped from version 0.1.1 to version 1.0.0.
-
-
-.Bug fixes
-- Removed duplicate `./doc/a2x.1.txt` from distribution tarball.
-- Documentation errata.
-- Attribute replacement is no longer performed twice in Titles and
- AttributeEntrys.
-- a2x(1) skipped asciidoc(1) execution when rerun with different
- `--asciidoc-options` options, it now always executes asciidoc(1).
- The problem was that previously asciidoc(1) was executed only if the
- output file was missing or older than the source file.
-
-
-Version 7.1.2 (2006-03-07)
---------------------------
-.Additions and changes
-- Support for
- http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML]
- has been added. See 'Appendix I: ASCIIMathML Support' in the User
- Guide and the examples at
- http://www.methods.co.nz/asciidoc/asciimath.html.
-- You can now prefix quoted text with inline attributes lists. You
- can use this to set font size and color (XHTML and HTML outputs).
-- Added `##...##` quoting -- it does nothing -- it's purpose is to
- allow inline attributes to be applied to normal text.
-- An 'inline passthrough' mechanism has been implemented.
-- Configuration file comment lines can be escaped with a backslash --
- this is to allows the inclusion of configuration lines that start
- with a hash character.
-- The `scriptsdir` attribute can be used to specify the name of the
- directory containing linked JavaScripts (see the
- link:userguide.html#X33[User Guide] for details.
-- The BackendBlock has been renamed PassthroughBlock for consistency
- with the new inline passthrough naming.
-- `a2x(1)` now works with the older `bash(1)` version 2.05b. Patch
- submitted by mailto:francis@daoine.org[Francis Daly].
-- Content included by the `include1::[]` system macro is no longer
- subject to attribute substitution so that ambiguities no longer
- arise when used to include CSS or JavaScript files.
-
-
-Version 7.1.1 (2006-02-24)
---------------------------
-.Additions and changes
-- The `caption` attribute can be used to customize admonition captions
- as well as image, table and example block element title prefixes
- (`xhtml11` and `html4` backends).
-- You can now override the default icon image using the `icon`
- attribute to specify the path of the linked image (xhtml11 and html4
- backends only).
-- The deprecated `imagesdir` attribute is no longer recognized (use
- `iconsdir` instead).
-- Added 'Appendix H: Using AsciiDoc with non-English Languages' to the
- AsciiDoc User Guide.
-- Added 'Admonition Icons and Captions' subsection to the User Guide
- explaining how to customize Admonition elements.
-
-.Bug fixes
-- `a2x(1)` failed when configuration files were installed in the
- global `/etc/asciidoc/` directory -- it was only searching the
- directory containing the asciidoc executable (thanks to Christian
- Wiese for finding and submitting a patch this bug).
-- The html4 backend admonition caption now correctly displays the
- admonition `caption` attribute (previously displayed the `style`
- attribute).
-
-
-Version 7.1.0 (2006-01-13)
---------------------------
-.Additions and changes
-- `a2x(1)` toolchain wrapper utility. This overcomes the biggest
- hurdle for new users which seems to be assembling and using a
- working DocBook XML toolchain. With `a2x(1)` you can generate XHTML
- (chunked and unchunked), PDF, man page, HTML Help and text file
- outputs from an AsciiDoc input file with a single command. All you
- need to install (in addition to AsciiDoc) is xsltproc(1), DocBook XSL
- Stylesheets and optionally FOP (if you want PDF) or lynx(1) (if you
- want text).
-- Block titles can now start with any non-space character (previously
- where not allowed to start with `.~-_` characters).
-- `./stylesheets/docbook.css` renamed to
- `./stylesheets/docbook-xsl.css` to clarify its function.
-- Renamed `./docbook-xsl/manpages.xsl` to `./docbook-xsl/manpage.xsl`
- for consistency.
-- Admonition and navigation icons moved to `./images/icons/` to
- clarify usage and conform with a2x(1) usage.
-- Renamed xhtml11 intrinsic attribute `imagesdir` to `iconsdir` to
- keep vocab consistent and changed default value to `./images/icons`
- (previously `./images`). `imagesdir` attribute still accepted but
- deprecated.
-- Unused image files have been weeded out of the distribution.
-- Packager notes (appendix B) have been updated to reflect the needs
- of `a2x(1)`.
-
-IMPORTANT: The renaming of the xhtml11 backend `imagesdir` intrinsic
-attribute and it's new default value introduces a backward
-compatibility issue: if you use the `icons` attribute you will need to
-either move your icons to the new default `./images/icons` location or
-include an `--attribute{nbsp}iconsdir="your_icons_path"` option in
-your asciidoc commands.
-
-.Bug fixes
-- Backslash line continuation is now observed in verbatim paragraphs.
-- Fixed errors generated by example
- `./examples/website/build-website.sh` script.
-
-
-Version 7.0.4 (2005-12-08)
---------------------------
-.Additions and changes
-- Added ternary conditional attributes
- `{<name>@<regexp>:<value1>[:<value2>]}` and
- `{<name>$<regexp>:<value1>[:<value2>]}`.
-- Safety violations now generate errors (they previously generated
- warnings).
-- asciidoc(1) now defaults to safe mode, consequently the
- `[miscellaneous]` safe mode entry and `--safe` command-line option
- are no longer necessary (though for backward compatibility
- asciidoc(1) still accepts the `--safe` option).
-- Backend Blocks are now flagged unsafe (they could be used to include
- arbitrary and hence potentially unsafe output content).
-- Filters are no longer considered unsafe. There's not much point in
- insisting on filter safety since the installation of an unsafe
- filter would require the introduction of new or modified
- configuration files -- if your application configurations can be
- compromised you're in all sorts of trouble (safe mode protects
- against unsafe input files not unsafe configuration). As with all
- filters, before installing, you should verify that they can't be
- coerced into generating malicious output or exposing sensitive
- information.
-
-.Bug fixes
-- Fixed a lot of glaring grammatical and factual errors in the User
- Guide.
-
-
-Version 7.0.3 (2005-12-01)
---------------------------
-.Additions and changes
-- Added `--safe` and `--unsafe` command-line options -- AsciiDoc can
- now be executed in a 'safe mode' which disallows the execution of
- arbitrary code or the inclusion of arbitrary files (see
- link:userguide.html#X39[Appendix C in the AsciiDoc User Guide]).
-- Included link:source-highlight-filter.html[source-highlight filter]
- in the distribution `./examples/source-highlight-filter/` directory
- (based on filter submitted by mailto:trolocsis@gmail.com[Ryan
- Phillips]).
-- Included the DocBook XSL Stylesheets 1.69.1 customizations used to
- generate the distributed AsciiDoc documentation (read the
- `asciidoc-docbook-xsl.txt` file in the distribution `./docbook-xsl/`
- directory).
-- AsciiDoc DocBook XSL Stylesheet drivers moved from `./doc/` to
- `./docbook-xsl/`.
-- Modified `./doc/manpages.xsl` so only URL content is displayed in
- manpages.
-
-.Bug fixes
-- Explicitly set table CSS border style (`xhtml11` backend) to `solid`
- because default border styles vary from browser to browser.
-
-
-Version 7.0.2 (2005-08-28)
---------------------------
-.Additions and changes
-- There are now long versions of all AsciiDoc options.
-- If the `--backend` is not specified it defaults to `xhtml11`.
-- Added CSS simulated frames layout to the examples website (see
- `./examples/website/layout2/README-website.txt`). This layout does
- not work with IE6 and the original tables based layout is still the
- default.
-- Support page added to AsciiDoc website.
-
-.Bug fixes
-- Invalid options are now trapped gracefully.
-- Documentation errata.
-
-
-Version 7.0.1 (2005-06-24)
---------------------------
-.Additions and changes
-- Reverted to use of `strong`, `em`, `tt` XHTML tags -- they're more
- obvious and no less correct than `span` tags, besides, the generated
- file sizes are smaller (the 'User Guide' was 11% smaller).
-- Table title rendered with `caption` tag rather than a separate
- `div`.
-- The AsciiDoc 'stylesdir' attribute (if specified) is now recognized
- when searching for embedded stylesheets (previously only searched
- default `./stylesheets` directory).
-- Default charset encoding changed from ISO-8859-1 to UTF-8 -- it's
- less language specific and displays most common languages.
-- `template::[]` macros now expand in all configuration file sections
- previously only in markup template sections.
-- Cleaned up example website layout CSS and configuration
- (presentation has not been changed).
-- Refactored `xhtml11.conf` configuration file.
-- Set consistent and sensible permissions on distributed files.
-- White space is now stripped from DSV formatted table cell data.
-- `class="tableblock"` attribute added to tables generated by
- `xhtml-deprecated-css.conf` to assist CSS.
-
-.Bug fixes
-- Illegal character set encoder (specified by the AsciiDoc `encoding`
- attribute) and character data are trapped gracefully.
-- AsciiDoc table 'format' attribute in table attribute lists were not
- recognized.
-- The nested horizontal labeled list example in the 'AsciiDoc User
- Guide' has been dropped -- it generated invalid DocBook markup.
-
-
-Version 7.0.0 (2005-06-06)
---------------------------
-***************************************************
-This is a major release with many code and
-documentation changes.
-Please report any problems you encounter.
-
-mailto:srackham@gmail.com['Stuart Rackham']
-***************************************************
-
-.Additions and changes
-- A new 'xhtml11' backend generates XHTML 1.1 with integrated CSS2
- replacing the previous 'xhtml', 'css', and 'css-embedded' backends.
-- The CSS stylesheets have finally been rewritten.
-- The asciidoc(1) command help now includes user
- link:userguide.html#X36[customizable help] topics. When asciidoc is
- invoked with the `--help` option the command argument is
- interpreted as a help topic.
-- The previous example website has been replaced by the actual
- AsciiDoc website (see `./examples/website/`.
-- XHTML generation options now controlled by the following attributes:
- 'badges', 'linkcss', 'icons', 'numbered', 'quirks', 'theme',
- 'stylesdir', 'imagesdir' (see the link:userguide.html#X33[User
- Guide] for details.
-- By default HTML and XHTML are output as stand-alone documents (no
- embedded CSS and no linked admonition icon images).
-- Documents encoded with the UTF-8 Unicode character set are now
- processed thanks to a patch supplied by
- mailto:viktor@rbg.informatik.tu-darmstadt.de[Viktor Vasilev].
-- The `-a ^name` command-line syntax to undefine an attribute has been
- deprecated in favor of the `-a name!` syntax.
-- AttributeEntry syntax addition: `:name!:` to undefine `name` attribute.
-- Added `template` system block macro to allow the inclusion of one
- configuration file template section within another.
-- A 'verse' style attribute can now be applied to literal paragraphs
- and blocks to reproduce line breaks and white space from the source
- document.
-- Replacements and Special Words can now be escaped with leading
- backslashes.
-- Replacements are now processed in configuration file order (previous
- ordering was indeterminate).
-- System macros can now be used in the base `asciidoc.conf`
- configuration file.
-- Deprecated features that emitted warnings in prior versions are no
- longer tolerated.
-- The `eval` system attribute expression evaluates to `False` the
- attribute is undefined, if it evaluates to `True` the result is an
- empty string.
-- The Paragraph and DelimitedBlock 'presubs' parameter can be aliased
- as 'subs'.
-- Added 'verbatim' substitutions option.
-- Renamed 'List Continuation Block' to 'List Block' and renamed the
- 'listcontinuation' option to 'list'.
-- Deprecated 'default' substitutions option (use 'normal' instead).
-- The 'section-numbers' section numbering attribute has be renamed
- 'numbered'.
-- Dropped the '\#UNDER CONSTRUCTION#' block macro.
-- Rewrote Paragraph and DelimitedBlock handlers adding a
- link:userguide.html#X23[styles] configuration entry.
-
-.Bug fixes
-- Included files are no longer read inside conditionally excluded
- content.
-- Manpage command names containing dashes (in the manpage NAME
- section) were misinterpreted as the spaced dash command name/purpose
- separator. Bug report and patch supplied by
- mailto:david@dgreaves.com[David Greaves].
-- Unexpected error following malformed author line error.
-
-
-Version 6.0.3 (2005-04-20)
---------------------------
-.Additions and changes
-- Special characters are now substituted in AttributeEntry element
- values.
-- Spaced and unspaced em dashes are now recognized (previously only
- spaced em dashes were recognized).
-- Replaced the table 'noborders' option with richer 'frame' and 'grid'
- attributes.
-- The `duplicate macro` warning message now only occurs when the
- verbose (`-v`) option is enabled.
-- Single lines starting with two forward slashes hard up against the
- left margin are treated as comments and are not processed.
-- Renamed 'section' delimited block option to 'sectionbody' to more
- accurately reflect it's role.
-- Added a List Continuation block -- a specialized delimited block
- that is functionally equivalent to the List Item Continuation
- feature except that the list contained within the block does not
- require explicit '+' list item continuation lines.
-- Dropped deprecated `<u>` tags from generated HTML.
-- Literal Block delimiters must now consist of at least four points
- (previously three) to avoid lone ellipsis ambiguity.
-
-.Bug fixes
-- Some system attribute evaluation failures caused unexpected
- exceptions to occur.
-
-
-Version 6.0.2 (2005-03-30)
---------------------------
-.Additions and changes
-- Three new 'system' block macros have been added -- `eval`, `sys` and
- `sys2` which are the block macro equivalents to the same named
- system attributes.
-- 'Intrinsic' macros have been renamed 'system' macros along with
- 'action' attributes which have been renamed 'system' attributes:
- * To reflect their common (though contextually different) behavior.
- * To avoid confusion with 'intrinsic attributes'.
-
-.Bug fixes
-- Asciidoc now searches in `/etc/asciidoc/filters` for filters.
-
-
-Version 6.0.1 (2005-03-06)
---------------------------
-.Additions and changes
-- A global configuration file location `/etc/asciidoc` has been added
- and is now processed before all other locations (patch supplied by
- mailto:stone@debian.org[Fredrik Steen]).
-- Recoded `tempfile.mktemp()` and other artifacts that are no longer
- necessary or desirable (patches supplied by
- mailto:stone@debian.org[Fredrik Steen]).
-- Added BUGS file to the distribution.
-
-.Bug fixes
-- Illegal comment syntax in `css-embedded-stylesheet.conf` resulted in
- illegal CSS in files generated by the `css-embedded` backend.
-
-
-Version 6.0.0 (2005-01-28)
---------------------------
-***************************************************
-This release has had some fairly major code and
-documentation changes. Please report any problems
-you encounter.
-
-mailto:srackham@gmail.com['Stuart Rackham']
-***************************************************
-
-A lot of new stuff. A new major version number -- some regression
-incompatibility (hopefully mitigated by 'deprecated' warnings).
-
-Went mad trying to rein in the current feature anarchy -- established
-a unified notion of document attributes. Attempted to introduce a
-consistent vocabulary -- renamed many poorly or inconsistently named
-entities.
-
-Actually, deprecated syntax is still processed correctly in almost all
-cases. One source of incompatibility that may arise if you have
-customized CSS stylesheets is the change of AsciiDoc CSS class names
-(see below). I guess the moral is if you've done a lot of
-configuration file customization and are happy with version 5 then you
-may want to stay put.
-
-NOTE: This version requires Python 2.3 or better to run.
-
-.Additions and changes
-- 'Glossary entries' have been renamed 'attributes'. This eliminates
- confusion with the accepted meaning of glossary.
-- An `AttributeEntry` block element has been added so that document
- attributes can be assigned from within an AsciiDoc document.
-- The `AttributeList` block element has been added which is a more
- general solution than the (now deprecated) DelimitedBlock arguments.
-- An BlockId element has been added for setting block element anchor
- (link target) IDs.
-- Quoted text can now span multiple lines (thanks to James Bowlin for
- this patch).
-- Inline macros can now span multiple lines.
-- \``double backtick / apostrophe'' quotes generate ``curly quotes''.
-- A warning is now emitted for out of order list item (applies to
- explicitly enumerated numbered list items).
-- Added `include` action attribute.
-- A line of three or more apostrophes generates an HTML horizontal
- ruler (`<hr/>` tag). You will get a warning if processed with
- non-HTML backend.
-- An `{imagesdir}` attribute specifies image file location for images
- referenced in configuration files when generating HTML (the default
- location is `images`).
-- An `{stylesdir}` attribute specifies the location of CSS
- stylesheets when generating styled HTML (the default location for
- configured markup is `.`).
-- The use of the (often inappropriately named) `{caption}` attribute
- list entry has been deprecated, use `{0}` instead.
-- New 'ExampleBlock' delimited block along with associated variants
- Note, Tip, Warning, Caution and Important.
-- The `docbook.conf` file now facilitates the optional inclusion of a
- DocBook revision history file.
-- To better reflect their purpose the following block elements have
- been renamed: `VerbatimBlock` to `ListingBlock`; `IndentedBlock` to
- `LiteralBlock`; `IndentedParagraph` to `LiteralParagraph`;
- `CustomBlock` to `BackendBlock`; `SimpleSection` to `SectionBody`.
- Any corresponding CSS class names have also been changed which could
- result in backward incompatibility in customized stylesheets.
-- Swapped plain DocBook admonition icons for Jimmac's DocBook icons
- (http://jimmac.musichall.cz/ikony.php3). The original plain icons
- have been moved to `./images/plain`.
-- Renamed `html` backend to `xhtml` to better reflect it's function
- (former `html-4` backend renamed to `html`).
-- A new inline anchor macro syntax `[[[<id>]]]` is available, it
- displays `[<id>]` at the anchor location and is for anchoring
- bibliography list entries.
-- An optional 'single-line titles' syntax can be used.
-- Tweaks to distributed CSS stylesheets and FOP `fo.xsl` customization
- file.
-- 'List Item Continuation' has been implemented which allows
- additional block elements to be included in list items by separating
- them from the preceding list item element with a line containing a
- single plus character.
-- A new 'Horizontal Labeled List' list type has been added. Generates
- two column list -- the first column contains the list element
- labels, the second contains the element text. Same syntax as
- `Vertical Labeled Lists` except the double colon label suffix is
- followed by the start of the list item text.
-
-.Bug fixes
-- Fixed broken backslash line continuation.
-- Labeled list end tags were not undergoing attribute substitution.
-- Documents without any author information now generate legitimate
- DocBook (previously if the author line was not included in the
- document header then an empty (illegal) DocBook `author` element was
- generated).
-- Multiple spaces in filter command arguments were replaced by a
- single space. The `./examples/asciidoc2text/asciidoc2text.sh` script
- now indents text correctly.
-
-
-Version 5.1.1 (2004-10-10)
---------------------------
-*15-December-2004: Interim update:* Updated `asciidoc.py` to fix
-broken `join_lines` function -- no other changes.
-
-- PDF documentation is now produced from DocBook XML using XSLTLib and
- FOP. Previously we processed DocBook SGML with `jw(1)` (which used
- Dvips to convert DVI files to PDF). FOP has come a long way in the
- last 12 months and produces very acceptable PDF under both Linux and
- Windows.
-- Sections detailing how to install and use the DocBook XSL
- Stylesheets, xsltproc, FOP toolchain and the AsciiDoc XSLT drivers
- have been added to the User Guide.
-- The PDF output from the he example article template has been
- included in the distribution (`./doc/article.pdf`).
-- Special characters are emitted using decimal Unicode character codes
- (previously used named character entities which cannot be assumed
- included in non-HTML documents).
-- Added registered trademark (R) to `[replacements]`.
-- CSS stylesheet tweaks.
-- Admonitions (Note, Tip, Important, Warning, Caution) include icons
- when generating css output.
-
-
-Version 5.1.0 (2004-09-18)
---------------------------
-- Callouts have been implemented (see the 'Callouts' section of the
- AsciiDoc User Guide for details).
-- Added XSL drivers for generating XHTML, chunked XHTML and HTML Help
- from DocBook XML using XSL stylesheets and xsltproc(1).
-- Added CSS stylesheet for HTML generated from DocBook XML using XSL
- stylesheets.
-- Distribution contains HTML Help formatted User Guide
- (`./doc/asciidoc.chm`), the User Guide tells you how it's generated.
-- Images referred to by distributed stylesheets are now located in the
- `./images` subdirectory (previously located in `.`).
-- Filters path names are now handled properly under Cygwin.
-- The usual documentation and examples additions, updates and
- polishing.
-
-
-Version 5.0.9 (2004-09-09)
---------------------------
-- The convention of using a `.asc` file extension for AsciiDoc files
- has been dropped in favor of the familiar `.txt` extension. It makes
- more sense in that AsciiDoc is a text presentation format and
- because `.asc` clashed with the same extension used by other
- applications. It's only a naming convention -- you don't have to
- switch if you don't want to.
-- Changed the subscript formatting character from underline to tilde
- since underscores in file names are reasonably common (especially in
- link and image macros).
-- An alternative syntax for the index term inline macro has been
- added: `++<primary>,<secondary>,<tertiary>++`.
-- Index terms that have secondary and tertiary entries now
- additionally generate separate index terms for the secondary and
- tertiary entries.
-- A `+<primary>+` index term inline macro has been added which
- displays the term in the primary text flow.
-- Added alternative variable list definition using double semi-colon
- terminator as opposed to the standard double colon terminator so
- variable lists can be nested to two levels.
-- Footnotes now appear on a separate line in HTML and Linuxdoc
- outputs.
-- Python version compatibility is checked at startup.
-- Preface and appendix section titles in multi-part Book documents are
- meant to be out of sequence -- warnings are no longer emitted when
- outputting HTML.
-- Empty section warnings have been replaced by error messages and are
- emitted only if invalid markup would result.
-- Missing macro sections or invalid macro name warnings are only
- generated at startup if the `-v` (verbose) option is set. Otherwise
- they are deferred until a matching macro is encountered in the input
- file.
-- Missing or invalid table definition warnings are only generated at
- startup if the `-v` (verbose) option is set. Otherwise they are
- deferred until a matching table is encountered in the input file.
-- AsciiDoc now makes more of an effort to continue in the face of
- errors.
-- Fixed broken `./examples/website/main.aap` script.
-- Converted distribution text files DOS text format as a sop to
- Windows users with challenged text editors.
-- Documentation additions and corrections.
-
-
-Version 5.0.8 (2004-05-15)
---------------------------
-- Spurious 'out of sequence' level 2 warnings no longer appear when
- processing 'book' document multi-part book top level Preface and
- Appendix sub-sections since they are (correctly) out of sequence.
-- A warning is no longer emitted for empty Index sections since this
- is normal when generating DocBook outputs.
-- Fixed: `[quotes]` configuration file entries where not being
- overridden by downstream configuration file entries.
-- Footnote text is now output enclosed in square brackets in HTML
- documents.
-- Added superscripts and subscripts to the standard PRS configuration
- files.
-- Adjusted CSS stylesheets so list titles don't have so much space
- between title and first list item (broken in IE6 due to poor CSS
- compliance). Lessened sidebar title top margin.
-
-
-Version 5.0.7 (2004-04-22)
---------------------------
-- The version 5.0.6 README incorrectly stated that AsciiDoc would run
- under Python 2.0, in fact it requires Python 2.1 or better. The
- README has been corrected.
-- Documented techniques for combining and splitting AsciiDoc documents
- and processing the combined and split parts (see the 'Tips and
- Tricks' section of the User Guide).
-- An example of marking up superscripts and subscripts is documented
- in the 'Tips and Tricks' section of the User Guide (the example
- configuration file is in the AsciiDoc `examples` directory).
-- Added ellipsis to shipped `[replacements]`; three periods output an
- ellipsis entity.
-- Removed unused 'SectionClose' class.
-- The AsciiDoc 'Preamble' element is output as a DocBook 'Preface'
- when processed as a 'book' document type (in older AsciiDoc versions
- a warning was issued and processing stopped).
-- Fixed a quoting anomaly: quoted text can no longer begin or end with
- with white space.
-
-
-Version 5.0.6 (2004-03-07)
---------------------------
-- New 'image' macro implements optional image scaling and linking and
- works in both inline and block contexts. The 'image' macro obsolesces
- the existing 'graphic' block macro and 'icon' inline macro.
-- Macro substitution section names now have `-inlinemacro` and
- `-blockmacro` suffixes to resolve context ambiguity, make their
- purpose clearer and relieve section namespace congestion.
-- Header derived glossary entries can now be overridden from the
- command-line.
-- Special character substitution is now performed on AuthorLine
- derived author names.
-- A macro or block argument called 'options' can be used as a shortcut
- for a list named arguments with zero length string values.
-- Tables can be output without borders using the `options="noborders"`
- argument.
-- Table data lines that do not immediately follow a table section
- underline can now be blank. This allows CSV data with embedded blank
- lines to be processed correctly.
-- Blank DSV format table data lines are silently skipped.
-- Tightened up on enforcement of configuration file section names to
- reduce the possibility of section content being seen as a section
- header line.
-- Section titles can be optionally suffixed with title arguments
- enclosed in double square brackets.
-- A replacement has been added to `asciidoc.conf` to replace inline
- double dashes with the `—` entity.
-- Changed the `.UNDER-CONSTRUCTION.` macro syntax to
- `#UNDER-CONSTRUCTION#` so it is not mistaken for a BlockTitle.
- Similarly changed the `.NEW.` replacement with
- `#NEW#`.
-- `#NEW#` and `#UNDER-CONSTRUCTION#` macros are now
- included in the DocBook backend.
-- Replaced shipped `smallnew.gif` with `smallnew.png`.
-- Documentation tidy ups.
-
-
-Version 5.0.5 (2004-02-25)
---------------------------
-- Fixed the disappearing paragraph titles problem that was caused by
- Inline macros (incorrectly) processing BlockTitles.
-- Tightened AuthorLine validation. Previously invalid email addresses
- and embedded special characters in the AuthorLine resulted in
- invalid output markup.
-
-
-Version 5.0.4 (2004-02-09)
---------------------------
-- Reinstated missing `infile`, `outfile`, `filetype` and
- `filetype-<filetype>` glossary entries.
-- As of version 5.0.3 asciidoc(1) now requires Python 2.0 or greater,
- this has now been documented.
-
-
-Version 5.0.3 (2004-01-23)
---------------------------
-- Fixed problem that caused any filters directory file containing
- `.conf` (not just those with the `.conf` extension) from being
- loaded.
-- All `[miscellaneous]` configuration file entries can now be
- referenced like glossary entries (they are now processed internally
- as glossary entries).
-- The output file line terminator (previously hardwired to `\r\n` is
- now set using the `newline` entry in the configuration file
- `[miscellaneous]` section.
-- The misspelt `blocktitles` configuration file entry name has been
- corrected (to `blocktitle`).
-- An `{empty}` glossary entry has been added to the default
- configuration which is useful for outputting trailing blank lines
- from configuration file substitution sections.
-
-
-Version 5.0.2 (2003-12-18)
---------------------------
-- New (alternative) 'anchor' and 'xref' macro syntax (old syntax still
- valid).
-- DocBook `mediaobject` and `inlinemediaobject` tags are generated in
- place of `graphic` and `inlinegraphic` tags by the AsciiDoc
- `graphic` and `icon` macros. If a macro argument is specified it is
- the alternative text output if the target document format does not
- support the specified graphic file format.
-- Dropped the LinuxDoc left and right square bracket special character
- substitutions as they interfered with macro substitution.
-- Documentation updates and corrections.
-
-
-Version 5.0.1 (2003-12-09)
---------------------------
-- Fixed problem with anchor tag when generating CSS styled HTML.
-
-
-Version 5.0 (2003-12-08)
-------------------------
-***************************************************
-This release has had some fairly major code and
-documentation changes. Please report any problems
-you encounter.
-
-mailto:srackham@gmail.com['Stuart Rackham']
-***************************************************
-
-- AsciiDoc can now produce a full-blown multi-part DocBook book
- including dedication, abstract, preface, colophon, glossary,
- appendix, bibliography and book part elements using the new
- `specialsections` configuration file section.
-- All Section element children (Paragraph, DelimitedBlock, List,
- Table, BlockMacro) can now be titled using the BlockTitle element.
- A BlockTitle element is a single line containing a title and
- beginning with a period.
-- The `index` and `backmatter` macros have been dropped, superseded by
- `specialsections`.
-- The AsciiDoc 'Preface' element has been renamed 'Preamble' (to avoid
- confusion with the DocBook book preface element).
-- Out of sequence titles are now tolerated with a warning. This allows
- book document level 0 sections to be processed.
-- An 'anchor' inline macro has been added for document link target
- creation.
-- 'Note', 'Tip', 'Important' and 'Warning' paragraph types have been
- added to support the corresponding DocBook elements.
-- Title substitution is now performed in SidebarBlock titles.
-- DocBook graphics now output as `figure` and `informalfigure`
- elements rather than `mediaobjects`. This ensures numbered figures
- and a lists of figures are produced by the DocBook toolchain.
-- You can now escape block argument lines by appending a backslash.
- Alternatively, if you embed arguments in the delimiter line AsciiDoc
- does not check for an arguments line.
-- The default DocBook backend file extension has been changed from
- `.docbook` to `.xml` (`.sgml` for the 'docbook-sgml' backend).
-- Warnings are output by default (previously they only printed when
- verbose option enabled).
-- A Question and Answer variable list definition has been added to the
- shipped configuration files, primarily to create DocBook `qanda`
- DocBook elements.
-- Fixed broken code-filter `-b linuxdoc` option. The asciidoc.asc User
- Guide can now be processed by linuxdoc(1) (although tables are
- dropped because LinuxDoc does not implement tables).
-
-.Compatibility issues:
-1. Table titles are no longer in the arguments line, use the new
- BlockTitles.
-2. Graphic titles are no longer in the 'graphic' block macro caption,
- use the new BlockTitles.
-3. The code-filter title must be placed in a preceding BlockTitle.
-4. SidebarBlock titles must be placed in a preceding BlockTitle.
-5. The DelimitedBlock option 'sidebar' has been renamed to 'section'.
-6. The default DocBook backend file extension has been changed from
-`.docbook` to `.xml` (`.sgml` for the 'docbook-sgml' backend).
-
-
-Version 4.2 (2003-11-26)
-------------------------
-- The default HTML output is now XHTML 1.0 markup. To output the
- former HTML 4 markup specify the `html-4` backend.
-- The default DocBook output is now DocBook XML. To output the former
- DocBook SGML specify the `docbook-sgml` backend. The associated
- `docbook-sgml.conf` file illustrates how to support minor DTD
- variations. Examples of using the `xmlto(1)` command for DocBook
- conversion have been added to the User Guide.
-- Glossary entries set using the command-line -g option can now be
- referenced in configuration files.
-- Configuration dumps (`-c` command-line option) no longer output
- redundant undefined glossary entries.
-- DelimitedBlock arguments can now be specified in a separate arguments
- line immediately following the leading delimiter line, This is in
- preference to the existing delimiter embedded arguments. Reasons:
- * The syntax is in keeping with the Tables arguments syntax.
- * It's easier to enter and implements line continuation.
-- A new QuoteBlock DelimitedBlock definition has been added to the
- distribution configuration files.
-- The table arguments lines can be continued using the backslash line
- continuation character.
-- Added new calculated glossary reference type `{<name>%<value>}`.
-- Double-quote characters can now appear in unquoted positional
- arguments.
-
-
-Version 4.1 (2003-11-13)
-------------------------
-- Added DSV (Delimiter Separated Values) tables format.
-- `{eval:<expr>}` glossary references drop the containing line if
- `<expr>` evaluates to `None`.
-- Block, Table and Macro arguments can now be positional (quoted or
- unquoted).
-- Vocabulary change: DelimitedBlock, Table and Macro 'attributes' are
- now referred to as 'arguments'. This makes more sense in light of the
- extended syntax and avoids confusion with backend markup tag
- attributes.
-- 'tablewidth' table ruler parameter can now be expressed in percent
- units (0..100). If between 0 and 1 then the original fractional unit
- measure is applied.
-- The use of quoting for generating footnotes and index entries has
- been dropped in favor of 'footnote' and 'indexterm' inline macros.
-- 'backmatter' inline macro included in distribution.
-- Fixed: CSS styled HTML tables are now fully XHTML 1.0 conformant.
-- Fixed: 'tablewidth' was processed incorrectly when passed as table
- argument.
-- Fixed: Glossary references like `{x=\{y}}` were one character off
- if \{x] was defined and `{y}` was not.
-
-
-Version 4.0 (2003-11-08)
-------------------------
-***************************************************
-This release has had some fairly major code and
-documentation changes. Please report any problems
-you encounter.
-
-'Stuart Rackham'
-***************************************************
-
-- Added tables to AsciiDoc.
-- Added two special 'subs' options: 'default' specifies the default
- substitution options and 'none' specifies no substitution. These
- options can only appear singly.
-- Line continuation using a trailing backslash character is available
- in Paragraphs, ListItems, Tables.
-- The left and right quotes for quoted text can now be specified
- separately.
-- Shipped configuration files implement footnotes (only useful for
- DocBook output) using \[[]] quoting.
-- Shipped configuration files implement index terms (only useful for
- DocBook and LinuxDoc output) using \(()) quoting.
-- The shipped 'html' backend configuration now emits valid 'HTML 4.01
- Transitional'.
-- Added new calculated glossary reference types `{<name>!<value>}`
- and `{<name>#<value>}`.
-- The DelimitedBlock 'params' option has been dropped in favor of the
- new 'block attributes' mechanism. If you have customized block
- params options you may need to adjust source files to use the
- 'block attributes' syntax. The example code filter has been updated
- to reflect these changes.
-- The code filter now has a `-t tabsize` option.
-- Replaced `-w` option with `-v` (verbose) option. The warnings option
- was just to confusing.
-- Named attributes can now be specified in macro calls.
-- The 'tabsize' attribute is recognized in the built-in `include`
- macros. A tabsize of zero suppresses tab expansion.
-- The configuration file `[options]` section has been split into
- `[miscellaneous]` and `[titles]`. If you have customized any of
- these settings you will need to adjust the affected configuration
- files.
-- Configuration file `[miscellaneous]` entries can now also be set
- using the command-line `-g` option.
-- Fixed: error that occurred when attempting to use zero length
- configuration and source files.
-- Fixed: blocking filter halt problem.
-- Fixed: inline macro escape prefix problem.
-- Fixed: missing macros from configuration dump problem.
-- Fixed: named macros were dumped incorrectly.
-- Many documentation changes/additions/corrections.
-
-
-Version 3.2.2 (2003-10-26)
---------------------------
-- Added `-n` option (synonym for `-g section-numbers`).
-- Dropped the processing commentary (hey, this is Unix).
-- Added new calculated glossary reference type `{<name>?<value>}`.
- `<name>` is the glossary entry name and `<value>` is the text
- substituted if the glossary entry is defined. `<value>` can only
- contain literal text (no glossary references allowed).
-- Added `asciidoc2text` to distribution `examples/asciidoc2text`
- directory (converts AsciiDoc source to text file with section
- numbering).
-- Fixed incorrect nesting of Simple lists inside Variable lists.
-- List definitions have been modified so that list items can be
- indented. This allows a more intuitive indentation of nested lists
- in AsciiDoc source.
-- Lists must be separated from preceding paragraphs by a blank line.
- This is to avoid paragraph lines being mistaken for list items.
-- Corrected asciidoc man page documentation error: the`-f` option does
- *not* search relative to source document directory for the
- configuration file.
-- Minor updates to various distribution `.conf` files.
-- Included `badges.conf` in `examples` directory.
-- `css-embedded-stylesheet.conf` now supports footer badges.
-- The default in-line element processing order has been changed:
- Glossary References are now processed before Inline Macros. This
- allows glossary expansions to occur inside macro references.
-- Glossary entries are now allowed in Author and Revision lines.
-- Default List `subs` options and Paragraph `presubs` options are
- assigned the following default value if not specified:
-
- specialcharacters,quotes,specialwords,replacements,glossary,macros
-
-- Documentation changes/additions/corrections.
-
-
-Version 3.2 (2003-05-26)
-------------------------
-- Added a `-s` command-line option to suppress the output of
- `[header]` and `[footer]` sections.
-- Article document headers are no longer mandatory: this allows
- AsciiDoc to process arbitrary chunks of text. When used in
- conjunction with the new `-s` command-line option corresponding
- chunks of backend markup can be generated.
-- AsciiDoc now emits a warning message and continues when an out of
- sequence section title is detected (previously it failed and
- halted). This allows document sections to be processed separately.
-- Optional 'presubs' and 'postsubs' entries have been added to
- 'DelimitedBlock' and 'Paragraph' definitions. As a consequence
- substitution options are no longer legal in 'options' entries.
-- 'presubs' and 'postsubs' substitutions are processed in the order
- the options are specified (rather than the fixed 'options' order of
- previous versions).
-- ./filters subdirectories are automatically searched for filter
- commands.
-- A 'title-subs' configuration option specifies the substitutions
- performed on document Header and Section titles.
-- A 'subs' entry in now included in List configuration file
- definitions that specified substitutions performed on list entry
- text.
-- Configuration files are auto-loaded from ./filters subdirectories.
-- Added example code filter (see ./examples/filters).
-- Bug fix: if section was empty you may have got erroneous 'missing
- tag "paragraph"' error.
-- Internal code tidy up.
-
-
-Version 3.1 (2003-05-18)
-------------------------
-- In version 3.0 a `[macros]` section entry of the form 'name' was
- equivalent to 'name='. An entry of the form 'name' now undefines the
- entry (to bring it in line with the behavior of other special
- sections).
-- Paragraphs have now been generalized (in the same way as Lists and
- DelimitedBlocks).
-- The 'indentsize' option has been dropped as as consequence of
- paragraph generalization.
-- Pipe | characters can be included in substituted tag and
- substitution section text using the \{brvbar} (broken vertical bar)
- glossary reference.
-- Removed the restriction requiring substitution section text
- placeholders | to be on a separate line.
-- Added an `-e` asciidoc(1) command option that excludes implicit
- configuration files (used in conjunction with `-c` generated
- configuration files).
-- Version 3.0 documentation has undergone a considerable cleanup.
-- The dumping of quoted section entries (see `-c` option) now works
- correctly.
-- The format of special section entries has been made consistent:
- `name` undefines the entry; `name=` sets the entry value to a blank
- string; `name=value` sets the entry value to `value`.
-- As a consequence of the previous change the caret prefix is no
- longer used in glossary configuration file entries (although it is
- still used when undefining an entry using the `-g` command-line
- option).
-
-
-Version 3.0 (2003-05-13)
-------------------------
-This version is the culmination of work begun in the 2.x releases
-whereby fixed policy has been replaced by extensible mechanisms.
-
-- Added `-c` command-line option to dump a composite asciidoc(1)
- configuration file to stdout.
-- Lists and Delimited Blocks are now defined by a set of configuration
- file parameter sections. The user can modify the default
- definitions or add new ones.
-- Block content can now be processed through external filters.
-- The default behavior for Custom Blocks is to perform glossary
- substitution (previously there was no substitution inside Custom
- Blocks).
-- The old 2.x style macros have been reimplemented; as with Lists and
- Delimited Blocks there syntax and behavior can be configured by the
- user. The default macro syntax remains the same but the semantics
- are now (hopefully) a bit more intelligible.
-- Block and Builtin macros use :: delimiter instead of the 2.x single
- colon delimit (to distinguish them from inline macros). The 2.x
- syntax is still supported for backward compatibility.
-- Nested lists are now supported and IndentedParagraphs can be
- included in list items.
-- Conditional source inclusion can be specified using built in `ifdef`,
- `ifndef` and `endif` macros.
-- The new conditional source inclusion feature has been used to reduce
- the number of default configuration files down to one per backend.
-- A change of name: 2.x 'Substitutions' are now called 'Replacements'
- and the 2.x `[substitutions]` configuration file section is now
- called `[replacements]` (the old name is still recognized for
- backward compatibility).
-- The line break is now implemented as a 'Replacements' substitution.
-- Inline 'icon' macro for inline images has been added to default
- configuration files.
-
-Version 2.2 (2003-04-07)
-------------------------
-- The `master.conf` configuration file name has been deprecated in
- favor of `asciidoc.conf`.
-- The standard configuration files set is now loaded from the
- `.asciidoc` folder in the users home directory (if it exists) and
- then from the source document directory. Configuration files that
- don't exist are silently skipped.
-- Configuration files named like the source file will be automatically
- loaded if they are found in the source file directory. For example
- if the source file is `mydoc.asc` and the `-b html` option is used
- then asciidoc(1) will look for `mydoc.conf` and `mydoc-html.conf` in
- that order.
-- The characters used to quote formatted text can be configured and
- extended by the user (see the master.conf [quotes] section).
-- Quoted text can now be escaped by prefixing a backslash character to
- the leading quote.
-- The double single-quote '' strong text quote has been deprecated in
- favor of an asterisk * character.
-- Added \{eval:expression}, \{sys:command} and \{sys2:command}
- glossary reference actions.
-- Trailing brace characters `}` are now allowed inside glossary
- references provided they are escaped with a backslash character.
-- Glossary entries can now be escaped by prefixing a backslash
- character to the leading brace character (use this in preference to
- placing the backslash inside the brace).
-- The output macro has been deprecated (use the new include1 macro
- inside a CustomBlock).
-- The default document type is `article` (asciidoc no longer attempts
- to guess).
-- Files included within DelimitedBlocks are not searched for block
- termination underlines. This ensures the entire file is part of the
- DelimitedBlock.
-- `include` macros can now be used in configuration files.
-- Corrected \{infile} and \{outfile} glossary entry documentation.
-- File inclusion is now limited to a depth of 5 to catch recursion
- loops.
-- Inline tags have been deprecated, they're not necessary and they
- immediately make the source document backend specific. Use
- CustomBlocks or Substitutions instead.
-
-Version 2.1 (2003-03-17)
-------------------------
-- Added section auto numbering `{sectnum}` glossary entry
- (auto-numbering function contributed by Ludovico Magnocavallo).
-- asciidoc(1) now correctly returns non-zero exit status if an error
- occurs.
-- An AsciiDoc example website has been included in the AsciiDoc
- distribution `examples/website` directory.
-- NOTE: The `asciidoc` wrapper script included in the 2.0 distribution
- has been dropped, if you've symlinked or aliased to `asciidoc` you'll
- need to change them to point directly to `asciidoc.py` instead.
-- An RCS $Id$ marker can be used as the document header revision line
- (based on a patch submitted by Ludovico Magnocavallo).
-- In addition to the `name=value` glossary entry format two new ones
- have been introduced: `name` (the default value is set to an empty
- string) and `^name` (the glossary entry is undefined).
-- The `-q` command-line option has been deprecated and the `-w level`
- command-line option added. +
- NOTE: By default skipped substitution warnings are now suppressed.
-- If a configuration file specified with the `-f` command-line option
- is not found relative to the current working directory then the
- search is repeated relative to the asciidoc(1) directory. This
- allows global configuration files to be used.
-- Added `{infile}`, `{outfile}` predefined glossary entries.
-- Added `under-construction` macro to HTML article configuration
- files.
-- Deprecated `{asciidoc_version}` glossary entry in favor of
- `{asciidoc-version}` (to it consistent with other entries).
-
-Version 2.0 (2003-02-24)
-------------------------
-- The emphasized, strong and monospaced words options have been
- generalized with the introduction of macro based 'special words'
- lists.
-- Glossary references can now appear in both the document and macro
- bodies.
-- All output files use `crlf` line termination (previously used UNIX
- `lf` (newline) termination).
-- Added [substitutions] section which implements arbitrary regular
- expression based substitutions.
-- An optional `master.conf` configuration file can be used for entries
- that are not backend or document type specific.
-- Special character definitions moved from the code to the new
- [special_characters] configuration file section.
-- Configuration file glossary added.
-- Command-line -g glossary entry added.
-- A new 'book' document type has been implemented for the 'docbook'
- backend. It outputs DocBook 'book' documents.
-- A major internal change has been the implementation of parametrized
- user definable 'macros'. Internally most document elements are now
- processed as macros.
-- Configuration file macro variables can be specified with default
- values (literals or other macro variables).
-- An attempt has been made to tighten up the vocabulary used to
- describe the AsciiDoc document syntax.
-- The term abstract has been replaced by the more general term
- 'preface' and a new preface section introduced into article
- configuration files (replacing the synopsis sections).
-- Any section elements can now be put in the document preface
- (previous versions only allowed paragraphs).
-- AsciiDoc Blocks have been unified and their behavior can be user
- defined and parametrized.
-- An 'output' inclusion allows an external file to be written directly
- to the backend output file.
-- A new CustomBlock has been added. Default behavior is to insert the
- enveloped AsciiDoc source lines directly into the output file.
-- A 'line break' tag can be inserted by terminating a line with a '+'
- character (only really useful for HTML backends).
-- An fourth section level has been introduced.
-- The SidebarBlock delimiter line characters have been changed. The
- deprecated underline is still accepted.
-- Levels 2 and 3 title underline characters have been changed. The
- deprecated underlines are still accepted.
-- Lines with backend specific inline tags can be inserted into
- AsciiDoc source files.
-- Single words enveloped by underscores are no longer emphasized. This
- feature was deprecated as it is redundant (use single quotes
- instead) and was being applied to file names with underscores.
-- A `-q` quiet option has been added to suppress warning messages.
-- Badge images sourced locally.
-- Added 'author' and 'author-mail' meta tags to HTML configuration
- files.
-
-Version 1.5 (2003-01-08)
-------------------------
-- Implemented sidebar document elements.
-- Explicit checks for user specified configuration files and input
- file (rather than throwing exception).
-
-Version 1.4 (2003-01-04)
-------------------------
-- New configuration file options 'emphasizedwords' and 'strongwords'.
- These allow the definition of words that will always be emphasized
- or rendered in a strong font without inline formatting.
-- Document and section titles are no long subject to inline
- formatting.
-- Multiple configuration files can be overlaid in a single command.
-- Configuration file tags and options entries can now be overridden on
- an entry by entry basis (previously the entire section was
- overloaded).
-- Configuration file tags and options entries are now cached this has
- resulted in around 37% performance improvement over version 1.3.
-- Variable lists can now contain multiple terms per list item.
-- Placeholder paragraph eliminated from empty sections that contain
- subsections.
-- Added \{asciidoc_version} substitution variable.
-- More documentation additions and tidy ups.
-
-Version 1.3 (2003-01-01)
-------------------------
-- A new 'strong' text formatting convention has been implemented:
- Word phrases enclosed in pairs of single quote characters (acute
- accents) are rendered in a strong font (usually bold).
-- Paragraphs can now be followed immediately by Simple lists and
- Ordered lists without an intervening blank line.
-- A user specified configuration file (`asciidoc(1)` -f option)
- overlays the default configuration file rather than replacing it.
- Custom configuration files need only contain those sections
- that have been customized.
-- Comment Block delimiters have been relaxed slightly. They must start
- with three forward slashes /// but the remainder can contain any
- characters, this allows comments to be embedded in the delimiter line.
-- Leading non-digit characters preceding revision number are now
- ignored.
-- Set default indentsize [option] from 2 to documented default value
- of zero in HTML backend html-article.conf and html-manpage.conf
- files.
-- Fixed error that occurred when taking input from stdin without
- explicitly specifying a document type.
-- Restored file name and line number error message information.
-- Changed deprecated -t option to -d in asciidoc --help and usage
- command output.
-- CSS styles tweaking.
-- Code, configuration file and documentation tidy ups.
-
-Version 1.2 (2002-12-28)
-------------------------
-- Implemented 'include' URL to allow file inclusion.
-- `fileextension` configuration file [option] renamed to more sensible
- `outfilesuffix` (`fileextension` still accepted by this version but
- will be dropped in future).
-- Improved error reporting.
-- CSS backends generate valid XHTML.
-- New `css-embedded` backend generates HTML with embedded stylesheets
- (use the `css` backend for linked stylesheets). The css-embedded
- backend output contains no linked images so the generated html files
- are completely self contained.
-- Bug fixes.
-
-Version 1.1 (2002-12-03)
-------------------------
-- Added css (cascading style sheets) backend
-- Implemented IndentedBlock document element.
-- Tabsize command-line option has been deprecated in
- favor of configuration file.
-- Default indent width changed to zero.
-- Added \{localdate} and \{localtime} substitution variables.
-- Added optional [options] configuration file section with
- fileextension, tabsize and indentsize options.
-- Implemented \{authorinitials} substitution variable.
-- Added https link type.
-- Corrected [graphic] substitution from \{title} to \{caption}
- in linuxdoc-article.conf configuration file.
-- Fixed error that occurred when '==' title underline was
- used.
-
-Version 1.0 (2002-11-25)
-------------------------
-First AsciiDoc public release along with AsciiDoc web site
-(http://www.methods.co.nz/asciidoc/) and SourceForge.net project registration
-(https://sourceforge.net/projects/asciidoc/[]).
-
-// vim: set syntax=asciidoc:
+AsciiDoc ChangeLog +================== + +:website: http://www.methods.co.nz/asciidoc/ + + +Version 8.6.4 (2010-02-20) +-------------------------- +.Additions and changes +- Added text foreground and background color along with text size CSS + styles for XHTML outputs, see {website}userguide.html#X96[]. +- Vim syntax highlighter: highlight macros that start with an + attribute reference (a common idiom). +- Vim syntax highlighter: highlight attribute references in macro + attribute lists. +- Attribute entries can be used to set configuration markup templates. +- Double-width East Asian characters in titles now correctly match the + title underline widths. Submitted by Changjian Gao (see + http://groups.google.com/group/asciidoc/browse_thread/thread/77f28b0dfe60d262). +- Implemented {website}manpage.html[asciidoc(1)] filter commands, see: + http://groups.google.com/group/asciidoc/browse_thread/thread/40c64cd33ee1905c +- User's home directory now calculated in a platform independent + manner. +- Added double-quote characters to French language file. Patch + contributed Yves-Alexis Perez, see: + http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 +- Vim Syntax highlighter: Highlight closing OpenBlocks which + immediately follow a literal paragraph. +- Changed UNIX `/dev/null` to OS independent `os.devnull` in filters + code. Suggested by Henrik Maier: + http://groups.google.com/group/asciidoc/browse_thread/thread/5ac8e8ea895147e9 +- Vim syntax highlighter: Single and double quoted text now highlights + correctly when preceded by an attributes list. +- Added Ukrainian language file (`lang-uk.conf`). Added double-quote + characters to Russian language file.conf). Patches contributed by + Lavruschenko Oleksandr, see + http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 +- Single and double quote characters are now set using the `{lsquo}`, + `{rsquo}`, `{ldquo}` and `{rdquo}` attributes. This makes is easy to + customise language specific quotes. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 +- Implemented 'conf-files' attribute to allow configuration files to + be specified in the source document. Suggested by Lex Trotman, see: + http://groups.google.com/group/asciidoc/browse_thread/thread/b11066a828ab45b9 + +.Bug fixes +- *FIXED*: Auto-generated section title ids are now Unicode aware. +- *FIXED*: Setting 'quotes' configuration entries using document + attribute entries failed if the attribute entry was not in the + document header. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/a1dd0562dee8b939 +- *FIXED*: If the input and output file names were different then the + output file name was incorrectly used to synthesize 'docinfo' file + names. Reported by Christian Zuckschwerdt. +- *FIXED*: An error can occur when more than one consecutive quotes + are defined as a blank string. Reported by Peggy Russell. +- *FIXED*: Encoding error in automatically generated author initials. + Patch submitted by Xin Wang. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/f44615dca0b834e9 + + +Version 8.6.3 (2010-11-14) +-------------------------- +.Additions and changes +- Added and 'unbreakable' option to bulleted and numbered lists + (thanks to Henrik Maier for this patch). +- Added `ifeval::[]` system macro (thanks to Henrik Maier for + suggesting this feature). +- The image 'scale' attribute sets the DocBook 'imagedata' element + 'scale' attribute. Patch submitted by Henrik Maier. +- DocBook 'preface', 'colophon' and 'dedication' style section titles + now work. Based on patch submitted by Henrik Maier. +- 'a2x': Do not inject xsltproc parameters if they were specified on + the command-line (parameter double-ups generate xsltproc 'Global + parameter already defined' errors). +- 'a2x': Refactored xsltproc parameter injection. +- 'a2x': articles chunked at section level by default. +- 'attributes', 'titles' and 'specialcharacters' sections are now read + from the local `asciidoc.conf` file before the header is parsed. + This fixes a regression problem. See + http://groups.google.com/group/asciidoc/browse_thread/thread/1b3f88f1f8118ab3 +- Document header attributes take precedence over configuration file + attributes. +- Refactored 'music', 'graphviz' and 'latex' filter configurations. +- Refactored source filter configuration and added literal paragraph + source style. +- Separated paragraph styles from paragraph syntax -- any style can be + applied to any syntax. +- Added 'listing' and 'quote' paragraph styles. +- Renamed paragraph 'default' style to 'normal'. +- Updated `--help` option text. +- 'a2x': The `asciidoc_opts`, `dblatex_opts`, `fop_opts` and + `xsltproc_opts` command-line options can be specified multiple + times. This makes embedding multiple 'a2x' options in document + headers easier to manage and less error prone. +- Added ASCIIMathML and LaTeXMathML support to slidy backend. +- Pass the 'encoding' attribute to the Pygments source highlight + filter command. +- 'a2x': HTML Help `.hhk` file named after AsciiDoc source file. +- 'a2x': Added `--xsl-file` option to allow custom XSL stylesheets to + be specified. +- Make builds the man pages. Patch submitted by Sebastian Pipping. See + http://groups.google.com/group/asciidoc/browse_thread/thread/c21c2902c29bae64 + +.Bug fixes +- *FIXED*: Sometimes double backquotes were misinterpreted as inline + literal macros. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/f510ea82a88aaee8 +- *FIXED*: Regression in 8.6.2: command-line attributes were not + available to the global asciidoc.conf. +- *FIXED*: Postponed document title substitutions until backend conf + files have been loaded (8.6.2 regression). See + http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8 +- *FIXED*: The XSL Stylesheets customizations were preventing chapter + and section level TOCs from being generated when using XSL + Stylesheets via 'a2x'. See + http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8 +- *FIXED*: ``UnicodeDecodeError: \'ascii' codec can't decode byte'' + error. This error is due to a limitation in the Python HTMLParser + module, see: http://bugs.python.org/issue3932 +- *FIXED*: Broken `--no-conf` option (8.6.2 regression). +- *FIXED*: Regression in 8.6.2: configuration attribute entries set in + the document header may cause a 'FAILED: incomplete configuration + files' error. +- *FIXED*: 'html4': corrected self closed meta tags. +- *FIXED*: 'a2x' regression in 8.6.2: HTML Help `.hhp` file name had + reverted to default name instead of the AsciiDoc source file name. + See: + http://groups.google.com/group/asciidoc/browse_thread/thread/dedc961b23e9ac56 +- *FIXED*: Attributes in man page title caused it to be dropped + resulting in invalid DocBook output. +- *FIXED*: `make uninstall` now deletes the `asciidoc.1` and `a2x.1` + man pages. + + +Version 8.6.2 (2010-10-03) +-------------------------- +.Additions and changes +- 'docbook45': Enclosed bibliographic lists in a 'bibliodiv' -- you + can now include block titles with bibliographic lists. +- Added optional 'keywords', 'description' and 'title' document header + meta-data attributes to HTML backends for SEO. +- AttributeEntry values can span multiple lines with a ' +' line + continuation. +- Added 'slidy' backend (based on Phillip Lord's slidy backend + https://phillordbio-asciidoc-fixes.googlecode.com/hg/). +- Implemented 'OpenBlock' 'partintro' style for book part + introductions. +- Comment lines substitute special characters only. +- Backend specific global configuration files (all except + `asciidoc.conf`) are loaded *after* the header has been parsed -- + virtually any attribute can now be specified in the document header. +- 'xhtml11': Volnitsky theme: allow bulleted lists to have intervening + children. +- 'xhtml11': refactored CSS font-family rules to start of file. +- 'xhtml11': list bullets colored gray. +- 'ifdef' and 'ifndef' system block macros accept multiple attribute + names: multiple names separated by commas are 'ored'; multiple + attribute names separated by pluses are 'anded'. +- 'xhtml11': Volnitsky theme: set max-width on labeled lists. +- Vim syntax highlighter: Entities inside quoted text are now + highlighted. +- Added 'role' and 'id' attributes to HTML outputs generated by + 'OpenBlocks'. +- Allow floating titles to generate 'h1' (level 0) titles in HTML + outputs. +- Added a 'start' attribute to numbered lists to set the start number. + See: + http://groups.google.com/group/asciidoc/browse_thread/thread/c14a4c3b1e4f6dc5 +- Added two more docinfo attributes 'docinfo1' and 'docinfo2' to allow + and control inclusion of a shared docinfo file. See + http://groups.google.com/group/asciidoc/browse_thread/thread/c948697943432e24 +- Vim syntax highlighter highlights multi-name conditional attributes. +- LaTeX backend patch submitted by Andreas Hermann Braml (see + http://groups.google.com/group/asciidoc/browse_thread/thread/1c415fc4540ce5e5). +- Implemented 'backend aliases'; renamed `docbook.conf` to + `docbook45.conf` and aliased 'docbook45' backend to 'docbook'; + aliased 'xhtml11' to 'html'. + +.Bug fixes +- *FIXED*: Filter commands located in filter directories local to the + source document that where not in the search 'PATH' where not found. +- *FIXED*: Volnitsky theme: Verseblock font set normal instead of + monospaced. +- *FIXED*: 'xhtml11': Callout icons were not rendered as Data URIs + when 'icons' and 'data-uri' attributes were specified. +- *FIXED*: Long standing bug: nested include macros did not restore + the parent document 'infile' and 'indir' attributes. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/8712a95e95a292a7 +- *FIXED*: 'html4': set preamble ID anchor. +- *FIXED*: 'xhtml11': dropped unusable 'id' and 'role' attributes from + preamble template. +- *FIXED*: Bug in multi-name conditional attributes e.g. `{x,y#}` + fails if x or y is undefined. +- *FIXED*: latex filter not being installed by Makefile. Thanks to + Grant Edwards for this patch. See + http://groups.google.com/group/asciidoc/browse_thread/thread/c4427a3902d130a8 +- *FIXED*: 'a2x': Long-standing bug in a2x which always passes + `--string-param navig.graphics 0` to 'xsltproc', regardless of + whether icons are enabled or not. Reported by Michael Wild: + http://groups.google.com/group/asciidoc/browse_thread/thread/59a610068e4acb58 + + +Version 8.6.1 (2010-08-22) +-------------------------- +.Additions and changes +- 'a2x': `--resource-dir` option renamed to `--resource`. +- 'a2x': `--resource` option accepts both file and directory names. +- 'a2x': Added `-m,--resource-manifest` option. +- Added Vim syntax highlighting for quote attribute lists. +- Load 'asciidoc.conf' from all configuration directories before any + other configuration files. This ensures that attributes used for + conditional inclusion are set before backend configuration files are + processed. Previously if you wanted to control global conf file + inclusion your only choice was to modify the global 'asciidoc.conf' + file. +- AsciiDoc 'Quote element' attributes have been simplified and + generalized -- positional color and size attributes and named 'role' + attribute have been replaced by a single positional attribute. + +.Bug fixes +- *FIXED*: 'testasciidoc.py': `BACKEND` command argument was being + ignored. +- *FIXED*: Broken 'docinfo' file functionality in 'html4' and + 'xhtml11' backends (previously the docinfo file was included in + the 'body' instead of the 'header'). + +Regression issues +~~~~~~~~~~~~~~~~~ +This release breaks compatibility with quoted element positional color +and size attributes (HTML backends). To revert to the deprecated quote +behavior define the 'deprecated-quotes' attribute in the global +`asciidoc.conf` file or on the command-line. For a more detailed +explanation of the rationale behind this change see +http://groups.google.com/group/asciidoc/browse_thread/thread/b22603bfb879418c. + + +Version 8.6.0 (2010-08-16) +-------------------------- +.Additions and changes +- The AsciiDoc distribution can now be built ``out of the box'' + from the distribution tarball or the Mercurial repository + (provided you have the requisite build applications installed). +- The global configuration files directory is ignored by both + 'asciidoc' and 'a2x' if AsciiDoc configuration files are installed + in the same directory as the asciidoc executable. This change + allows both a system wide copy and multiple local copies of AsciiDoc + to coexist on the same host PC. +- CSS 'quirks' mode is no longer the default 'xhtml11' output + (http://groups.google.com/group/asciidoc/browse_thread/thread/1c02d27d49221aa2). +- Relaxed anchor ID name syntax + (http://groups.google.com/group/asciidoc/browse_thread/thread/5f3e825c74ed30c). +- Added document files: `doc/epub-notes.txt`, + `doc/publishing-ebooks-with-asciidoc.txt`. +- 'a2x': If all other resource locations are exhausted then recursively + search directories named 'images' and 'stylesheets' in the + 'asciidoc' configuration files directory. +- 'a2x': options can also be set in the AsciiDoc source file. If the + source file contains a line beginning with '// a2x:' then the + remainder of the line will be treated as a2x command-line options. +- Added dblatex table-width processing instruction -- tables generated + by dblatex now observe the AsciiDoc table width as a percentage + (thanks to Gustav Broberg for suggesting this enhancement). +- 'a2x': Don't exit if the `--epubcheck` option is set and 'epubcheck' + is missing, issue warning and continue. +- Added a global 'plaintext' attribute for dealing with large amounts + of imported text. +- The author name format has been relaxed, if the the author does not + match the formal specification then it is assigned to the + 'firstname' attribute (previously asciidoc exited with an error + message). +- FAQ and documentation updates. +- Refactored chunked.xsl and epub.xsl files. +- Exchanged article.epub for more relevant book.epub on website. +- Put asciidoc.epub User Guide on website. +- 'a2x': Chunking EPUB and HTML outputs set to a per chapter basis and + the first chapter is separate from preceding contents. +- Changed dates format in example article and books to suppress EPUB + validation error. +- Added 'style' and 'role' CSS classes to xhtml11 section templates. +- Added the 'role' element to xhtml11 backend block templates. +- Suppressed md5 module deprecation warning from music and Graphviz filters. +- Pygments (http://pygments.org/) option added to source code + highlight filter. Based on Pygments source code filter written by + David Hajage + (http://groups.google.com/group/asciidoc/browse_thread/thread/d8d042f5a3021369/8934ebbb8cb7144b). +- xhtml11: Added a new theme (volnitsky). Written and contributed by + Leonid V. Volnitsky. +- xhtml11: Set body element class name to document type. +- Added refentryinfo element and contents (including revdate) to man + page DocBook output. Man pages are now dated using the revdate + attribute value if it has been defined. Based on patch supplied by + Rainer Muller + http://groups.google.com/group/asciidoc/browse_frm/thread/319e5cd94493e330/3fcb83fab067af42. +- Added `{template:...}` system attribute. +- Table of contents attribute 'toc' can now be specified in the + document header. +- Reimplemented music and latex filter -m option functionality when + the input is stdin using MD5 checksums. +- Added 'latex' filter. +- Added auto file name generation to image generating filters + (latex,music, graphviz). +- Added `counter2` and `set2` system attributes (to implement image + auto file name generation). +- Undefined attribute in filter command generates error but does not + exit. +- Attribute substitution proceeds from start line to end line + (previously was in reverse order which was really confusing). +- Tidied up music filter code: + * Format option is optional and default to 'abc' unless Lilypond + notation detected. + * The -m option does not apply to stdin input. +- Added paragraph styles to music and graphviz filters. +- Documented dynamic template names. 753: Graphviz filter can now + generate SVG format images. Patch submitted by Elmo Todurov, see: + http://groups.google.com/group/asciidoc/browse_frm/thread/fe9b33d8f5f1e0af + The xhtml11 SVG Graphviz template marked EXPERIMENTAL. No SVG + support for other backends. +- AsciiDoc template names can now contain embedded attribute + references. +- Added 'legalnotice' tag to `doc/article-docinfo.xml` example. +- xhtml11 backend: Callouts and callout lists display callout icons + when the 'icons' attribute is defined. See + http://groups.google.com/group/asciidoc/browse_frm/thread/8eda3ea812968854 +- Document attribute names are case insensitive everywhere, this makes using +attribute entries more consistent e.g. previously :VERS: had to be refered to +with {vers} ({VERS} did not work). +- Hungarian translation of footer-text (submitted by Miklos Vajna). + See + http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72# +- asciidocapi.py 0.1.2: Can now load AsciiDoc script named asciidoc. + See + http://groups.google.com/group/asciidoc/browse_frm/thread/66e7b59d12cd2f91 + Based on patch submitted by Phillip Lord. +- German translation of footer-text (submitted by Simon Ruderich). See + http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 +- Pushed HTML footer text into language conf files with the + introduction of a [footer-text] configuration file template section. + See + http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 + +.Bug fixes +- *FIXED*: Sometimes multiple double quoted text elements in the same + paragraph were mistakenly seen as starting with an inline literal. + See + http://groups.google.com/group/asciidoc/browse_frm/thread/219c86ae25b79a21 +- *FIXED*: 'localtime' and 'doctime' attributes calculated incorrect + daylight saving / non daylight saving timezones and consequently so + did HTML footers. Patch submitted by Slawomir Testowy. See + http://groups.google.com/group/asciidoc/browse_frm/thread/af652507caf6cec9 +- *FIXED*: Missing selector for 'List of examples' title in DocBook + CSS file. Patch submitted by Laurent Laville. See + http://groups.google.com/group/asciidoc/browse_frm/thread/3f96900f7fbf5620 +- *FIXED*: Broken accents in lang-hu.conf. See: + http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 +- *FIXED*: DocBook XSL generated HTML callout lists are properly + aligned. Submitted by Lionel Orry. See + http://groups.google.com/group/asciidoc/browse_frm/thread/2ff802547b6a75ea +- *FIXED*: Filter execution now occurs prior to filter markup template + substitution to ensure image data URI encoding happens after image + generation (see + http://groups.google.com/group/asciidoc/browse_thread/thread/14e8fcb289a135b). +- *FIXED*: The section numbers no longer increment when the 'numbered' + attribute is undefined (see + http://groups.google.com/group/asciidoc/browse_thread/thread/faa36e9e5c7da019/d24cab3fe363e58d). + + +Version 8.5.3 (2010-01-18) +-------------------------- +.Additions and changes +- a2x: Added a2x configuration file options ASCIIDOC_OPTS, + DBLATEX_OPTS, FOP_OPTS, XSLTPROC_OPTS (appended to same-named + command-line options). See + http://groups.google.com/group/asciidoc/browse_frm/thread/ac4b9bfa2116db28 +- Dropped `.hgignore` from the repository. See + http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea +- Don't pass verbose options to asciidoc table filter so that + asciidocapi messages are not discarded. See: + http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea +- Added `./tests/data/lang-pt-BR-test.txt` file to the repository. +- xhtml11: Verse block and verse paragraph content enveloped in a + 'pre' tag (instead of a 'div') so it renders better in text-only + browsers. See: + http://groups.google.com/group/asciidoc/browse_frm/thread/1b6b66adb24e710 +- User Guide: Clarified Passthrough Blocks (suggested by Simon + Ruderich). +- FAQ: 'How can I include lines of dashes inside a listing block?' +- FAQ errata and updates (submitted by Simon Ruderich). +- User Guide errata. +- Simplified 'asciidoc-toc' processing instruction and included lists + of figures, tables, examples and equations in books (i.e. revert to + pre-8.5.0 behavior). +- Attempted to have dblatex recognise the 'asciidoc-toc' processing + instruction but couldn't get it to work. +- Added 'notitle' attribute to allow the document title to be hidden. + + +.Bug fixes +- *FIXED*: Regression: system attribute escaping did not work. +- *FIXED*: Website: broken image links in chunked User Guide. + + +Version 8.5.2 (2009-12-07) +-------------------------- +.Additions and changes +- Updated example article and book documents with the recommended + explicit section name syntax (see the 'Special section titles + vs. explicit template names' sidebar in the AsciiDoc 'User Guide'). +- Added Italian language configuration file (contributed by Fabio + Inguaggiato). +- Added 'header' table style. See: + http://groups.google.com/group/asciidoc/browse_frm/thread/a23fea28394c8ca9 +- Pass 'icons', 'data-uri', 'imagesdir', 'iconsdir' attributes to + 'asciidoc' table style filter so that images are rendered in table + cells. +- Pass 'trace' and 'verbose' attributes to 'asciidoc' table style + filter so diagnostic information is printed from table cell source. +- The 'eval' system attribute can be nested inside other system + attributes. +- HTML outputs: Table and figure caption punctuation set to more usual + syntax. +- docbook backend: footnotes can now contain embedded images. See + http://groups.google.com/group/asciidoc/browse_frm/thread/50b28f6941de111a +- CSS tweaks so that tables processed by DocBook XSL Stylesheets have + the default asciidoc xhtml11 backend styling. See + http://groups.google.com/group/asciidoc/browse_frm/thread/dfe5204d5b2c9685 +- Block titles take precedence over section titles to avoid titled + delimited blocks being mistaken for two line section titles (see + http://groups.google.com/group/asciidoc/browse_frm/thread/f0b6f9989f828c3). +- Section title trace displays level and title text. +- FAQ additions. +- Added `{zwsp}` (zero width space) attribute. +- Undefined paragraph styles are reported (previously threw a runtime + error). +- Eliminated empty preamble generation. +- Floating titles now processed in all contexts. +- Implemented auto-lettered appendix names and updated example + documents. +- Section numbering can be disabled in HTML outputs with a + ':numbered!:' AttributeEntry. +- xhtml11: Nicer default quote block styling. +- Exclude floating titles from xhtml11 table of contents. Patch + submitted by Mark Burton (see + http://groups.google.com/group/asciidoc/browse_frm/thread/14aefc1cb6bd85f5). +- Enhanced `doc/article-docinfo.xml` example docinfo file. +- Vim syntax highlighter improvements. + +.Bug fixes +- *FIXED*: Absolute 'imagesdir' and 'iconsdir' attribute path names + do not work with the xhtml11 data-uri encoding. See + http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6 +- *FIXED*: Regression issue with inline data-uri images. See + http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6 +- *FIXED*: An unexpected error occurred when processing a table + containing CSV data if the 'cols' attribute was not explicitly + specified. See + http://groups.google.com/group/asciidoc/browse_frm/thread/4b0f364b477ec165 + + +Version 8.5.1 (2009-10-31) +-------------------------- +.Additions and changes +- If an AsciiDoc document file begins with a UTF-8 BOM (byte order + mark) then it is passed transparently through to the output file. + The BOM is stripped from included files. See + http://groups.google.com/group/asciidoc/browse_frm/thread/e5e61823ff4203cd +- Added AsciiDoc 'role' attribute to quoted text. Sets 'class' + attribute in HTML outputs; 'role' attribute in DocBook outputs. See: + http://groups.google.com/group/asciidoc/browse_frm/thread/2aa3e5711d243045 +- Conditional attribute syntax extended: they now accept multiple ORed + or ANDed attribute names. +- The 'xhtml11' backend dynamically processes footnotes using + JavaScript. +- Tidied up and namespaced 'xhtml11' JavaScript. +- Superceded `javascripts/toc.js` with `javascripts/asciidoc-xhtml11.js`. +- Added 'disable-javascript' attribute ('xhtml11' backend). +- Styled HTML footnotes. +- Added links to HTML footnote refs. +- Added title attribute to inline image macros to display popup + ``tooltip'' (HTML outputs only). +- Single-quoted attribute values are substituted in block macros (just + like the AttributeList element). +- For consistency changed underscores to dashes in attribute names. + Public attributes with underscores retained for compatibility. +- Added Brazilian Portuguese language configuration file (contributed + by Thiago Farina). +- Added 'leveloffset' attribute to make it easier to combine + documents. + +.Bug fixes +- *FIXED:* a2x: `--dblatex-opts` is now processed last so + `asciidoc-dblatex.xsl` params can be overridden. Patch submitted by + Mark Fernandes (see + http://groups.google.com/group/asciidoc/browse_frm/thread/5215c99dcc865e7d). +- *FIXED:* An error occurred if a directory in current path with same + name as executable. + +Regression issues +~~~~~~~~~~~~~~~~~ +There's been quite a bit of tiding up to the xhtml11 JavaScript. The +most obvious change is that the toc.js script has been superceded by +asciidoc-xhtml11.js so if you're linking you'll need get a copy of +the new file from the distribution javascripts directory. + +If you use customised xhtml11 configuration file `[header]` and +`[footer]` sections and you want them to use the new footnotes feature +then you've got a bit more work to do: + +. The onload event expression changed. +. The new `<div id="content">...</div>` div envelopes document + content. +. You need to add `<div id="footnotes">...</div>` div to the + `[footnotes]` section for footnotes to work. +. Drop the `ifdef::toc[]` macro that surround JavaScript inclusion. + +Take a look at the [header] and [footer] changes in the xhtml11.conf +diff to see what's going on: +http://hg.sharesource.org/asciidoc/diff/55a5999bfd04/xhtml11.conf + + +Version 8.5.0 (2009-10-04) +-------------------------- +.Additions and changes +- Implemented a 'float' attribute for tables and block images (HTML + outputs only). +- Added `unfloat::[]` block macro to cancel floating. +- Added table 'align' attribute to (HTML outputs only). +- The image 'align' attribute now works with HTML backends. +- Renamed table cell 'align' attribute to 'halign' so it doesn't clash + with the new table 'align' attribute. +- Added 'breakable' and 'unbreakable' options to AsciiDoc example and + block image elements. +- `[miscellaneous]` section entries now update properly when set from + a document 'AttributeEntry'. +- `[miscellaneous]` section `pagewidth` entry accepts fractional + values. +- Fractional column widths are now calculated correctly when using + fractional 'pageunits' (DocBook tables). +- Use DocBook XSL table width processing instructions. +- asciidoc 'KeyboardInterrupt' exits with error code 1. +- Added 'set' system attribute to allow attributes to be set from + configuration file templates. +- Allow constrained quotes to be bounded on the left by a colons and + semicolons, see + http://groups.google.com/group/asciidoc/browse_frm/thread/b276a927fdc87995 +- Titled listing and literal blocks (DocBook outputs) no longer default + to examples. See + http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd +- Updated language file table, figure and example captions to + accommodate new auto-numbering in html4 and xhtml11 backends. +- Titled source highlight filter listings generated by docbook backend + are now rendered as examples. See + http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd +- Implemented 'counter' system attribute. +- Use 'counter' system attributes to number titled tables and block + images in HTML backends. +- Added program name suffix to console messages. +- Added substitution to the 'AttributeEntry' passthrough syntax, this + replaces the now unnecessary 'attributeentry-subs' attribute. +- Allow passthrough inline macro syntax to be used in + 'AttributeEntrys'. +- Reinstated 8.4.4 default 'lang' attribute behavior. See + http://groups.google.com/group/asciidoc/browse_frm/thread/d29924043e21cb6a. +- Added 'max-width' attribute to the 'xhtml11' backend to set maximum + display width. See + http://groups.google.com/group/asciidoc/browse_frm/thread/74d9a542b79ccd50. +- Added 'a2x.py', a rewritten and much enhanced version of the old + 'a2x' bash script. +- The new 'a2x' can output EPUB formatted documents. +- Added `--safe` option and deprecated `--unsafe` option. Patch + submitted by Todd Zullinger. See + http://groups.google.com/group/asciidoc/browse_frm/thread/ea3a8ea399ae5d2a + and + http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5 +- Added 'CHECK' and 'TEST' todo highlight words to Vim syntax + highlighter. +- Line breaks, page breaks, and horizontal rulers are now processed by + dblatex, thanks to a patch submitted by Mark Fernandes + (http://groups.google.com/group/asciidoc/browse_frm/thread/a254cf949ea7c6c5). +- Allow footnote macros hard up against the preceding word so the + rendered footnote mark can be placed against the noted text without + an intervening space (patch submitted by Stas Bushuev, + http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5). +- Normalized path in `safe_filename` function (submitted by Todd + Zullinger, + http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5). +- The Asciidoc 'numbered' and 'toc' attributes cause DocBook outputs + to include `asciidoc-numbered` and `asciidoc-toc` processing + instructions, these are used by DocBook XSL to include section + numbering and table of contents (like Asciidoc HTML backends). For + backward compatibility both 'numbered' and 'toc' attributes are + defined by default when the 'docbook' backend is used. See + http://groups.google.com/group/asciidoc/browse_frm/thread/1badad21ff9447ac. +- 'data-uri' attribute is now evaluated dynamically and can be set in + document body (previously could only be set from command-line). +- Added 'sys3' and 'eval3' system attributes to passthrough generated + output, this fixes the data-uri inline image problem: + http://groups.google.com/group/asciidoc/browse_frm/thread/a42db6bc54c2c537. +- Missing language file generates a warning instead of an error. +- Updated Spanish language file (updates contributed by Gustavo Andrés + Gómez Farhat). + +.Bug fixes +- *FIXED:* Options in an 'AttributeList' option attribute are merged + with (rather than replace) configuration file options. +- *FIXED:* Comment blocks and comment block macros no longer consume + preceding block titles and attribute lists. +- *FIXED:* `examples/website/layout1.conf` and + `examples/website/layout2.conf` TOC problem. Submitted by Mark + (burtoogle). See + http://groups.google.com/group/asciidoc/browse_frm/thread/b9c63be67dd1d11c +- *FIXED:* Only the first occurrence of passthrough macro was + substituted. Patch submitted by Peter Johnson. See + http://groups.google.com/group/asciidoc/browse_frm/thread/1269dc2feb1a482c +- *FIXED:* asciidoc now runs on Jython 2.5.0. +- *FIXED:* Wordpress margins and pads in a number of block + elements + (http://groups.google.com/group/asciidoc/browse_frm/thread/36ff073c79cbc20a). + +Regression issues +~~~~~~~~~~~~~~~~~ +- Tables generated by 'dblatex' occupy 100% of the available space + regardless of the 'width' attribute setting. To restore width + behavior change the 'pageunits' miscellaneous parameter to 'pt'. You + can do this from the command-line with the `-a pageunits=pt` option. + See {website}userguide.html#X89[DocBook table widths]. + + +Version 8.4.5 (2009-05-24) +-------------------------- +.Additions and changes +- Added manpage 'Name' and 'Synopsis' section title customization to languages + configuration files. +- Synopsis manpage section no longer mandatory. +- Section markup templates can be specified by setting the title's + first positional attribute or 'template' attribute. +- The article and book document header can now include a revision + remark. +- A 'role' attribute can now be applied to block elements. This adds + the 'role' attribute to DocBook elements. Patch submitted by + http://groups.google.com/group/asciidoc/browse_thread/thread/62278a054188a038[Noah + Slater]). +- Renamed 'revision' and 'date' attributes to more sensible and consistent + 'revnumber' and 'revdate' (old names deprecated but still + recognized). +- Moved backend specific attributes to Appendix H in User Guide. +- Renamed and generalized the docbook backend revision history + inclusion mechanism to 'docinfo' to reflect the use of all article + or book information elements. The old revision history names still + work but have been deprecated. +- Refactored docbook.conf headers. +- Moved line break replacement from `[replacements]` to + `[replacements2]` so the replacement occurs after the mailto macro. + This fixes bug + http://groups.google.com/group/asciidoc/browse_thread/thread/4bdcdfb0af773e2 +- The typewriter to punctuation apostrophe replacement can be escaped + with a backslash. +- Graphviz filter outputs images to 'imagesdir' if it is defined. +- Made the block image macro generic so that it can be used for filter + outputs. As a result Music and Graphviz filters: + * Have been greatly simplified. + * Honor the 'data-uri' attribute. + * 'html4' outputs no longer generate W3C validation warning. +- The 'iconsdir' attribute no longer requires a trailing directory + separator character. +- Removed borders around linked html4 images. +- Added 'html4' specific HTML output for music filter. +- 'a2x': Added `--unsafe` option (shortcut for + `--asciidoc-opts=--unsafe`). +- 'a2x': The FOP executable can now be named `fop` (this is the + default name in some distributions). +- Attributes are now substituted in the system macro attribute list. +- If the output is set to stdout (i.e. no output directory is defined) + then Music and Graphviz filters will output included images to the + source file directory. +- Added 'name' directive to 'testasciidoc'. +- Added lots of 'testasciidoc' new tests. +- Moved language specific configuration parameters into `lang-en.conf` + file. +- 'lang' attribute entry can be specified in the AsciiDoc source file + (preceding the header). +- Removed cruft from A-A-P scripts and documented them. +- Added German language config file (`lang-de.conf`) contributed by + Michael Wild. +- Added French language config file (`lang-fr.conf`) contributed by + Yves-Alexis Perez. +- Added Russian language config file (`lang-ru.conf`) contributed by + Artem Zolochevskiy. +- Added Hungarian language config file (`lang-hu.conf`) contributed by + Miklos Vajna. + +.Bug fixes +- *FIXED:* Multiple manpage names are now handled correctly when + generating DocBook output, each name now generates a separate + DocBook `<refname>` element. See + http://groups.google.com/group/asciidoc/browse_thread/thread/c93bb4db025225d8 +- *FIXED:* A problem that caused AttributeEntries preceding the header + to be overwritten when the language conf file loaded. +- *FIXED:* Possible inline macro name ambiguity e.g. link matches olink. +- *FIXED:* The documented macro definition deletion behavior had been + broken for a long time. +- *FIXED:* Email addresses not recognized when followed by a period + character. +- *FIXED:* Hyphens in mailto macros can delimit nested addresses e.g. + \bloggs@mail was processed inside + \mailto:joe-bloggs@mail-server.com[Mail]. +- *FIXED:* User name in FTP URI generated incorrect FTP link. See + http://groups.google.com/group/asciidoc/browse_thread/thread/1d796a9c9ddb2855 +- *FIXED:* Source highlighter now works with Wordpress backend (see + http://groups.google.com/group/asciidoc/browse_thread/thread/6d8c716748b109e3). + +[[X2]] +Regression issues +~~~~~~~~~~~~~~~~~ +. A colon following the date in the AsciiDoc header is treated as a + revision remark delimiter -- this could be an issue if you have used + a colon in the header date. + + +Version 8.4.4 (2009-04-26) +-------------------------- +.Additions and changes +- Added table column and row spanning. +- Table styles can now be applied per cell. +- Vertical cell alignment can be applied to columns and individual + cells. +- Added table 'align' attribute to set horizontal alignment for entire + table. +- Included Geoff Eddy's update of the experimental LaTeX backend. +- A new attribute named 'trace' controls the output of diagnostic + information. If the 'trace' attribute is defined then + element-by-element diagnostic messages detailing output markup + generation are printed to stderr. +- Added 'literal' paragraph style (allows 'literal' style to be + applied to normal paragraphs). +- Deleted unused `replacements2` from `xhtml11.conf`. +- Added `replacements2` to default substitutions. +- 'testasciidoc.py': messages to 'stdout', only diffs to 'stderr'. +- Added transparency to `smallnew.png` image. + +.Bug fixes +- All combinations of leading comments and attribute entries at the + start of a document are now skipped correctly. +- *FIXED:* `./configure` doesn't support `--docdir` as expected (patch + submitted by Artem Zolochevskiy) +- *FIXED:* Constrained quotes were incorrectly matched across line + boundaries e.g. the string `+\nabc+` incorrectly matched a monospace + quote. + + +Version 8.4.3 (2009-04-13) +-------------------------- +.Additions and changes +- DocBook outputs default to DocBook version 4.5 doctype (previously + 4.2). +- Configuration file `[specialsections]` definitions can be undefined + by setting their configuration entry values blank. +- The Makefile 'install' target depends on the 'all' target to ensure + pre-install patches are applied. +- 'testasciidoc.py' now emits user friendly messages if: + . the configuration file is missing. + . an illegal backend is specified. + . an illegal test number is specified. + +.Bug fixes +- Fixed + http://groups.google.com/group/asciidoc/browse_thread/thread/fd27add515597c06[missing + template section] error. +- The 'testasciidoc.py' `--force` option no longer deletes test data + files that were not specified. +- Dropped second quotes substitution in table cells -- it had + effectively disabled quote escaping in table cells. + + +Version 8.4.2 (2009-03-19) +-------------------------- +.Additions and changes +- Added {website}testasciidoc.html[testasciidoc], a tool to verify + AsciiDoc conformance. +- A warning is issued if nested inline passthroughs are encountered. +- 'asciidocapi': setting an attribute value to `None` will undefine + (delete) the attribute (this in addition to the `name!` attribute + name format that the `asciidoc(1)` command uses). + +.Bug fixes + + +Version 8.4.1 (2009-03-10) +-------------------------- +.Additions and changes +- AsciiDoc now has a {website}asciidocapi.html[Python API]. The + following minimal example compiles `mydoc.txt` to `mydoc.html`: ++ +[source,python] +------------------------------------------------------------------------------- +from asciidocapi import AsciiDocAPI asciidoc = AsciiDocAPI() +asciidoc.execute('mydoc.txt') +------------------------------------------------------------------------------- + +- Backtick quoting for monospaced text is now implemented as an + 'inline literal' passthrough. This makes more sense since monospace + text is usually intended to be rendered literally. See + <<X2,Regression issues>> below for the impact this may have on + existing documents. Here are some examples that would previously + have had to be escaped: + + The `++i` and `++j` auto-increments. + Paths `~/.vim` and `~/docs`. + The `__init__` method. + The `{id}` attribute. + +- Added `--doctest` option to `asciidoc(1)` command. +- Added an optional second argument to 'BlockId' element, this sets + the `{reftext}` attribute which in turn is used to set the `xreflabel` + attribute in DocBook elements. +- Added lists to `--help` syntax summary. +- `{infile}` and `{indir}` attributes reflect the current input file + (previously always referred to the root document). +- `{docfile}` (new) and `{docdir}` (previously deprecated) attributes + refer to the root document specified on the `asciidoc(1)` + command-line. +- Vim syntax highlighter improvements. +- Syntax summary command (`asciidoc -h syntax`) additions. +- Admonition icons now have transparent backgrounds. +- Changed yellow W3C badges to blue ones in page footers. + +.Bug fixes +- Dropped `asciidoc(1)` broken undocumented `--profile` option. +- Em dash replacement now recognized at start of block. + +Regression issues +~~~~~~~~~~~~~~~~~ +Replacing backtick quoting with the 'inline literal' passthrough +raises two regression scenarios for existing documents: + +1. You have escaped the expansion of enclosed inline elements, for + example: `\{id}`. You would need to delete the backslashes: `{id}` + (if you don't the backslashes will be printed). Mostly it's just a + case of interactively finding and replacing of all occurrences of + `\. + +2. There are enclosed inline elements, for example: `some *bold* + monospaced`. You would need to switch to plus character monospace + quoting: `+some *bold* monospaced+` (if you don't the enclosed + elements won't be expanded). + +If your existing documents include these cases and you don't want to +upgrade then use the `-a no-inline-literal` command-line option, +alternatively put this in `~/.asciidoc/asciidoc.conf`: + + [attributes] + no-inline-literal= + + +Version 8.3.5 (2009-02-02) +-------------------------- +.Additions and changes +- Cached compiled regular expression delimiters (speed up 'User + Manual' compilation by 250%). +- Created distinct list definitions for each numbered list style to + allow nesting of all styles. +- Roman numbers in numbered lists are followed by a closing + parenthesis instead of a period to eliminate 'i', 'v', 'x' item + ambiguity with respect to alpha numbered list items. +- Added `**`, `***`, `****`, `*****` + bulleted lists. +- Added `...`, `....`, `.....` implicit numbered + lists. +- Added `:::`, `::::` labeled lists. +- Updated User Guide for new list syntaxes. +- Optimized paragraph and list termination detection with separate + precompiled regular expressions for performance and to prevent + reaching Python 100 named group limit. +- Updated Vim syntax highlighter for new list syntaxes. +- Allow `template::[]` macros in conf file entries sections (not just + in template sections). +- Dropped unused `[listdef-numbered2]` conf file sections. +- Renamed 'ListBlock' to more appropriate 'OpenBlock'. +- Implemented single-line versions of `ifdef::[]` and `ifndef::[]` + macros. +- 'html4' backend styling: + * Underlined admonition captions. + * Added side border to Example Blocks. +- 'xhtml11' backend styling: + * Dropped right hand margin from all but quote and verse blocks. + * html4 backend: corrected over-sized width of caption in admonition + block. + +.Bug fixes +- Fixed broken numbered list nesting. + +Compatibility issues +~~~~~~~~~~~~~~~~~~~~ +The roman numbered list parenthesis syntax is incompatible with the +potentially ambiguous roman period syntax introduced in 8.3.2. + + +Version 8.3.4 (2009-01-20) +-------------------------- +.Additions and changes +- Implemented a title 'float' style. A floating title (or bridgehead) + is rendered just like a normal section but is not formally + associated with a text body and is not part of the regular section + hierarchy so the normal ordering rules do not apply. +- Implemented inline comment macro so comment lines can now appear + inside block elements. +- Comment lines are sent to the output if the 'showcomments' attribute + is defined (comment blocks are never sent to the output). +- Single quoting attribute values in 'AttributeList' elements causes + them to be substituted like normal inline text (without single + quoting only attribute substitution is performed). +- Rewrote list item processing (was very crufty). List continuation + and list blocks now work as expected. Updated and clarified list + documentation in User Guide. +- The 'revision' attribute now recognizes the RCS $Id$ marker format. +- An RCS $Id$ marker formatted revision line in the header does not + need to be preceded by an author line. +- If an RCS $Id$ formatted revision is specified and the author name + has not already been set then the author name in the $Id$ marker + will be used. +- Updated Gouichi Iisaka's Graphviz filter to version 1.1.3. +- Added 'autowidth' table attribute option for (X)HTML outputs. +- DocBook backend now puts 'orgname' optional attribute in DocBook + header. +- Deprecated undocumented 'companyname' attribute in favor of + DocBook's 'corpname'. +- Removed explicit closing backslash from HTML4 self-closing tags to + comply with WC3 recommendation. + +.Bug fixes +- Fixed 8.3.3 regression whereby adjacent lists with the same syntax + but different list styles were incorrectly treated as a single list. + + +Version 8.3.3 (2009-01-02) +-------------------------- +This release supersedes 8.3.2. + +.Bug fixes +- The broken and confusing numeration and numeration2 numbered list + attributes have been dropped, use the style attribute instead. + + +Version 8.3.2 (2009-01-01) +-------------------------- +.Additions and changes +- Added Gouichi Iisaka's Graphviz filter to distribution. +- The 'SidebarBlock' element can now be rendered with an 'abstract' + style. +- Reorganized filters into a separate subdirectory for each filter. +- Updated `Makefile.in` and `MANIFEST` files to reflect new filters + organization. +- Added 'listing' style to 'LiteralBlock' element so listings with + nested listing blocks can be rendered as a listing block. +- Changed example 'code' filter to use preferred 'ListingBlock' syntax + (the old `~` delimited filter syntax is no longer used). +- Implemented 'enumeration' and 'enumeration2' numbered list + attributes for specifying the list numbering style ('arabic', + 'loweralpha', 'upperalpha', 'lowerroman' and 'upperroman'). +- AsciiDoc now recognizes 'upperalpha', 'lowerroman' and 'upperroman' + numbers in `listdef-numbered2` numbered lists and sets the number + style based on the style of the first numbered list item + (alternative to setting 'enumeration2' attribute). +- Updated `formatlistpat` definition in `.vimrc` example in User + Guide. +- You can now backslash escape system block macros. +- Added 'Pychart' FAQ. +- Drop paragraph 'text' and list 'text', 'index' and 'label' match + groups from attributes -- they are included in the element's text + and we don't want them processed a second time as attributes. +- Changed comment line block macro to a passthrough block macro to + ensure no substitutions. +- A 'subslist' no longer has to be appended to a 'PassthroughBlock' + macro definition, if omitted no substitutions are performed. +- Code tidy up: replaced deprecated `<>` operator with `!=`. +- Removed unused linuxdoc code. +- Code tidy ups: dropped old types module reference; replaced + `has_key()` with preferred `in` operator. + +.Bug fixes +- Old syntax source highlight filter regression: special characters + where not escaped in DocBook outputs. + + +Version 8.3.1 (2008-12-14) +-------------------------- +.Additions and changes +- Replaced the `install.sh` script with Ben Walton's updated autoconf + scripts -- see {website}INSTALL.html[INSTALL] for details. +- Added a generalized 'AttributeEntry' syntax to allow arbitrary + configuration file entries to be set from within an AsciiDoc + document (suggested by Henrik Maier). +- Listing delimited blocks in DocBook outputs now support IDs; IDs of + titled Listing and Literal delimited blocks have been moved to the + enclosing DocBook example tag (thanks to Vijay Kumar for this + patch). +- Replaced vertical typewriter apostrophe with punctuation apostrophe + (thanks to Noah Slater). + +.Bug fixes +- Regression: Excluding double-quotes from unquoted attribute values + resulted in backward incompatibility, double-quotes in unquoted + attribute values has been reinstated. +- Regression: Text like `&...;` was sometimes mistaken for an entity + reference -- tightened up entity reference matching. + + +Version 8.3.0 (2008-11-29) +-------------------------- +.Additions and changes +- {website}newtables.html[AsciiDoc new tables] is a complete redesign + of the tables syntax and generation. The new syntax and features are + a huge improvement over the old tables. The old tables syntax has + been deprecated but is currently still processed. +- {website}newlists.html[Lists can now be styled] like other block + elements. This allows a single list syntax for 'glossary', 'qanda' + (Question and Answer) and 'bibliography' lists instead of having to + remember a different syntax for each type. +- Inline passthroughs macros have been improved and block passthrough + macros added. Attribute substitution can be optionally specified + when the macro is called. +- The passthrough block has a fully transparent passthrough delimited + block block style called 'pass'. +- The 'asciimath' and 'latexmath' + {website}userguide.html#X77[passthrough macros] along with + 'asciimath' and 'latexmath' {website}userguide.html#X76[passthrough + blocks] provide a (backend dependent) mechanism for rendering + mathematical formulas. There are {website}latexmath.pdf[LaTeX Math], + {website}asciimathml.html[AsciiMathML] and + {website}latexmathml.html[LaTeXMathML] examples on the AsciiDoc + website. +- Reimplemented and cleaned up filter processing based on a patch + submitted by Kelly Anderson. Uses the newer subprocess module + instead of the deprecated popen2 module. Now works in Win32 command + shell. +- Addition FAQs, more documentation updates. +- Arbitrary HTML/XML entities can be entered in AsciiDoc source. +- Did away with the need for the `shaded-literallayout.patch` (thanks + to Henrik Maier for this patch). +- Implemented 'page break' block macro. +- Added 'line breaks' and 'ruler' processing instructions to DocBook + outputs (thanks to Henrik Maier for this patch). +- Added 'deg' (degree) and 'wj' (word joiner) entity attributes + (thanks to Henrik Maier). +- Tweaked DocBook 'indexterm2' macro to avoid white space preceding + the term when used in table cells (thanks to Henrik Maier for this + patch). +- Title elements now process the 'options' attribute like other block + elements. +- Added `single quoted' element. +- Spaces on both sides of a -- em-dash are translated to thin space + characters. +- Improved detection and reporting of malformed attribute lists. +- The list 'compact' style is now a list option. +- Added 'strong' labeled list option which makes the labels bold (HTML + outputs only). +- Dropped unsupported 'linuxdoc' backend. +- Dropped deprecated 'xhtml-deprecated' (version 6) backend. +- Added 'breakable' and 'unbreakable' attribute options to tables to + control table breaking across page boundaries (DocBook XSL/FO + outputs). By and in collaboration with Henrik Maier. +- Added 'pgwide' attribute option to tables to table, block image, + horizontal labeled lists. Specifies that the element should be + rendered across the full text width of the page irrespective of the + current indentation (DocBook XSL/FO outputs). Thanks to Henrik Maier + for this patch. +- Vim syntax highlighter: spaces before/after bullets no longer + highlighted (which is ugly if using a theme that highlights with + underlines). Thanks to Donald Chai for this patch. +- Added `a2x(1)` `--fop` option. +- Added `a2x(1)` `--no-xmllint` option. +- Highlighted labelled list terms with the navy color in XHTML + outputs. +- Use `w3m(1)` as default `a2x(1)` text format generator (fallback to + `lynx(1)`). +- Changed callout formats in html4 and xhtml11 outputs to angle + brackets to match source highlighter rendering. +- Macros now inject user defined `<optionname>-option` attributes into + markup. +- Added IRC URLs to AsciiDoc inline macros. +- Added `depth` attribute to `include::[]` system macro. +- Added 'footnoteref' inline macro. +- Added 'stylesheet' XHTML attribute to specify additional custom CSS + stylesheet. +- If a paragraph style is specified it will be added to the XHTML + 'class' attribute and DocBook 'role' attribute. +- Replacements can be set in a document using the reserved + AttributeEntry name 'replacement'. +- The prefix for auto-generated section name IDs can be set with the + 'idprefix' attribute. + +.Bug fixes +- Escaped quote skipped over leading and trailing quote instead of + just the leading quote. +- Fixed bug that was causing false negative safe mode warnings (patch + submitted by Julien Palmas). +- Placed priority of AttributeEntry, AttributeList and BlockTitle + above Title. This ensures an AttributeEntry, AttributeList or + BlockTitle followed by a same length leading ListingBlock delimiter + is not mistaken for a two-line title. +- Vim syntax highlighter: fixed multi-line quoted text. +- Contstrained quote termination after non-space character enforced. +- Vim syntax highlighter: unterminated quoted text is no longer + highlighted. +- Vim syntax highlighter: passthroughs now exactly match AsciiDoc + semantics. +- Vim syntax highlighter: escaped quoted text, attribute references + and inline macros are not highlighted. +- Vim syntax highlighter: TODO's highlighted in CommentBlocks (thanks + to Scott Wall); non-greedy pass:[$$...$$]. +- Vim syntax highlighter: Comment lines mistaken for vertical list + labels (thanks to Scott Wall). +- Vim syntax highlighter: Single unmatched $$ mistakenly highlighted + remaining text (patch contributed by Scott Wall). +- Callouts now work in source highlighted listing generated by + dblatex. +- Fixed exception that occured if undefined attribute was present in + filter command. +- AttributeList block can now follow a paragraph without intervening + blank line. +- The include macro tabsize attribute is no longer propagated to + nested includes. + +.Omissions +The following features were implemented but then but removed from this +release: + +- 'pi', 'cdata' and 'comment' passthrough macros and passthrough block + styles (creeping featurism, use 'pass' macros instead). +- Generic 'tag' inline macro (creeping featurism, use 'pass' macros + instead). + + +[[X1]] +Compatibility issues +~~~~~~~~~~~~~~~~~~~~ +Version 8.3.0 has a number of backward incompatibilities with respect +to the previous 8.2.7 release: + +- The old table syntax is still processed but a 'DEPRECATED' warning + is issued. +- Entity references have to be escaped with a backslash. +- You have to explicitly precede horizontal style labeled lists with + the `[horizontal]` style attribute -- by default all labeled lists + are rendered vertically. +- The list 'compact' style has been dropped and is now a list option + (use `options="compact"` in attribute lists). +- AsciiDoc version 6 sytnax no longer supported. +- Linuxdoc been removed from the distribution. +- The unsupported experimental 'latex' backend has not been tested on + this release. +- The introduction of single-quote quoting requires that double-quote + quoting is escaped with two backslashes. + + +Version 8.2.7 (2008-07-04) +-------------------------- +.Additions and changes +- Added `dvi`, `ps` and `tex` output format options to a2x(1). +- Added `--dblatex` option to a2x(1) so `dblatex(1)` can be used to + generate PDFs. +- Added custom `dblatex(1)` configuration files (in distribution + `./dblatex` directory) that are used by a2x(1). +- `dblatex(1)` is now used to generate the distributed PDF version of + the AsciiDoc User Guide. +- If you don't need a customized the link caption you can enter the + 'http', 'https', 'ftp', 'file' URLs and email addresses without any + special macro syntax -- you get the links by just cutting and + pasting URLs and emails addresses. This also makes it easier to open + links directly form AsciiDoc source ( most editors allow you to open + URLs directly). The Vim syntax highlighter has been updated to + reflect these changes. +- Highlighted source code paragraphs have been implemented -- it's a + much more convenient way to enter short code examples (see + http://www.methods.co.nz/asciidoc/source-highlight-filter.html[the + online docs]). +- The source highlighter and music filter syntax has changed -- they + now used the ListingBlock syntax customized with 'source' and + 'music' style attribute values. This follows the Paragraph styling + convention introduced by the source paragraph (previous item) and is + easier to read. The old syntax still works but has been deprecated. +- QuoteBlocks now have a 'verse' style -- you no longer have to nest a + 'verse' LiteralBlock inside a QuoteBlock for verses. The 'verse' + style on the LiteralBlock has been deprecated (still works though) + and the 'style' attribute is positional attribute 1, pushing + 'attribution' and 'citetitle' attributes to the right (you'll need + to insert a 'quote' attribute into your existing QuoteBlocks). +- It is no up to the DocBook processor to highlight source code syntax + in `<programlisting>` elements rather than GNU Highlighter -- this + is the correct way to handle it, plus `dblatex(1)` makes a much + better job. +- 'scaledwidth' and 'align' attributes have been added to the 'image' + macro. They apply to DocBook outputs (specifically for PDF + documents). 'scaledwidth' sets the image size as a percent of the + available page width; 'align' applies 'left', 'center' or 'right' + horizontal image justification. +- Added a2x(1) `--fop-opts=FOP_OPTS` option (patch submitted by Miklos + Vajna). +- Added a2x(1) `--dblatex-opts=DBLATEX_OPTS` option. +- Added Mikhail Yakshin's FOP 0.95 patch which fixes a long-standing + `fo.xsl` problem and allows PDF's to be generated with FOP 0.95 + (previously had to use FOP 0.20.5). +- The User Guide has been updated and outdated FOP configuration and + installation sections removed. + +.Bug fixes +- Fixed `stylesheets/xhtml11-manpage.css` not being included when + 'linkcss' attribute was used. +- Configuration file `*-style` attributes are now dumped correctly. +- Fixed 'FAILED: malformed section entry' LaTeX backend error. + +See the also the https://sharesource.org/hg/asciidoc/[AsciiDoc +repository changelog]. + + +Version 8.2.6 (2008-04-29) +-------------------------- +.Additions and changes +- Enhancements to the Vim AsciiDoc syntax highlighter, for example, + quoted text is now highlighted in titles and macro captions. +- If you define the `data-uri` intrinsic attribute images referenced + by 'image' macros will be embedded in XHTML using the + http://en.wikipedia.org/wiki/Data:_URI_scheme[data: URI scheme]. + *NOTE*: Microsoft browser support for the 'data: URI scheme' is + currently limited to MSIE 8 beta 1. +- Added `toc-title` attribute to allow custom table of contents + titles. +- Added references to Alex Efros's AsciiDoc Cheatsheet to AsciiDoc + website. +- `asciidoc(1)` and `a2x(1)` man pages formatted to conform to + `man-pages(7)` recommendations. +- Old code-filter syntax (pre-8.1.0) is no longer recognized so that + malformed two-line level 2 titles are no longer confused with + 'code-filter' block delimiters. +- Added -> <- => <= arrow replacements from the Arrows block of + Unicode. +- Added DocBook refentry lang attribute -- patch contributed by + VMiklos. +- AttributeEntry names can now be numeric (``named macro targets''). +- Hide Table of Contents title if Table of Contents empty -- patch + contributed by Alex Efros. +- Various XHTML CSS tweaks. +- Code cleanup: + * Replaced `realpath()` with Python 2.2 `os.path.realpath()` library + function. + * Replaced old string library functions with string methods. + * Use file generators instead of `readlines()`. + * Renamed entities that shadowed builtins. + * Standardized string quoting. + * Dropped `readlines()` function. + +.Bug fixes +- Fixed broken CSS for decimal ordered lists nested in alpha ordered + list, thanks to Alex Efros. +- A missing closing block delimiter now reports the opening delimiter + line number instead of the end of file line number. +- Fixed an error generated by the asciidoc `-e` option when there are + no block definitions -- patch contributed by Alejandro Mery. +- Handle both `\r\n` (as well as `\n`) line separators that may be + returned by `{sys}` attribute evaluation. +- Numbered attribute names no longer interfere with positional + attribute list values. + + +Version 8.2.5 (2007-11-18) +-------------------------- +.Additions and changes + +.Bug fixes +- Fixed exception thrown by illegal command-line arguments. +- Rolled back the 'with' warning bug fix introduced in 8.2.4 -- it was + incompatible with Python <2.5. + + +Version 8.2.4 (2007-11-10) +-------------------------- +.Additions and changes +- You can now use the `lang` attribute to set the DocBook language + attribute. +- Attribute values can now contain attribute references. +- If the `lang` attribute is defined then configuration files named + like `lang-<lang>.conf` will be loaded automatically. +- The help file name `help-<lang>.conf` is based on the AsciiDoc + `lang` attribute, defaults to `help.conf` (English). +- Admonition, figure and table captions have been factored into a + predefined set of `caption_*` attributes. They only apply to + directly generated (X)HTML outputs (DocBook stylesheets generate + their own language specific captions based on the `lang` attribute). +- Dropped platform dependent `doc/asciidoc.chm` file from + distribution documentation formats. + +.Bug fixes +- The spurious warning 'with will become a reserved keyword + in Python 2.6' has been suppressed. + + +Version 8.2.3 (2007-09-12) +-------------------------- +.Additions and changes +- Added VMiklos's 'permalink' patch for auto-generated section IDs + (enabled by default by the `sectids` attribute). +- Added http://www.methods.co.nz/asciidoc/faq.html[FAQ] to website. +- Changed format of \{localdate} attribute to ISO 8601 (`%Y-%m-%d`). +- Added `abc2ly --beams=None` option to make `music2png.py` conform to + ABC's notion of beams. +- XHTML level 2 section headings are now styled with an underlining + border. +- XHTML links to AsciiDoc title elements are now implemented with + title ID attributes (previously separate `<a>` element targets were + generated. +- Multi-word first, middle and last names can be entered in the header + author line using the underscore as a word separator. +- The nested inline macros restriction has now been lifted, for + example you can now include links and inline images inside + footnotes. +- Help topic names can be shortened (so long as they are not + ambiguous). For example `asciidoc -hm` will print the AsciiDoc man + page. +- Added `{two_colons}` and `{two_semicolons}` attributes for + escaping labeled list ambiguity. +- If quirks mode is disabled the XHTML Mime Type is set to the + recommended `application/xhtml+xml` (rather than `text/html`). + +.Bug fixes +- Author information is now correctly set when using attribute entries + in the header instead of an author line (previously the 'author' + attribute was not being calculated correctly and there were + attribute substitution problems). + + +Version 8.2.2 (2007-07-22) +-------------------------- +.Additions and changes +- http://www.maths.nottingham.ac.uk/personal/drw/lm.html[LaTeXMathML] + capability has been added for users who are more familiar with or + prefer LaTeX math formulas to the + http://www.methods.co.nz/asciidoc/asciimathml.html[ASCIIMathML] + notation (thanks to Arthur Sakellariou for the patch). +- The 'source highlight' and 'code' filters now process embedded + callouts. +- Added an `--attribute=ATTRIBUTE` option to `a2x(1)` for passing + attribute values to asciidoc(1) (a shortcut for `--asciidoc-opts="-a + ATTRIBUTE"`). +- Image block and inline macros prepend optional `{imagesdir}` + attribute to image link targets. + + +.Bug fixes +- Fixed an assertion error that occurred when a configuration file + containing an `include::[]` macro was loaded using the + `--conf-file` option and the configuration file name did not + include an explicit directory path -- patch submitted by Dmitry + Potapov. +- Asciidoc titles are only converted to lower case if all characters + are upper case otherwise case is left unchanged -- patch submitted + by Dmitry Potapov. +- Added a missing check that input is not stdin before loading + configuration files from the document directory -- patch submitted + by Dmitry Potapov. +- Attribute list items must evaluate to strings, numbers or None + (previously it was possible to evaluate to other object types which + resulted in surprising attribute values). +- If an AsciiDoc document has no title an empty XHTML 1.1 'title' + element is created -- previously the 'title' element was dropped + which resulted in invalid XHTML 1.1. +- The Vim syntax file no longer highlights escaped callouts. +- The Vim syntax highlighter now correctly highlights Double-dollar + passthroughs when they enclose dollar delimited ASCIIMathML and + LaTeXMathML formulas. + + +Version 8.2.1 (2007-04-06) +-------------------------- +.Additions and changes +- A number of improvements have been made to the Vim syntax + highlighter, for example the word C++ is no longer mistaken for the + start of an unconstrained monospace quote. +- Labeled list definitions have been tightened -- a list label can no + longer containing trailing spaces. The following example is no + longer recognized as a valid list label: + + Lorum ipsum :: ++ +This change implements the originally intended behavior (as per the +AsciiDoc documentation and examples) so there should be very few +compatibility issues. + +.Bug fixes + + +Version 8.2.0 (2007-04-04) +-------------------------- +.Additions and changes +- A Vim syntax file is now included in the AsciiDoc distribution + (inspired by Felix Obenhuber's `asciidoc.vim` script). You can find + it (along with a Vim filetype detection script in the distribution + `./vim/` directory (the scripts are installed automatically by the + AsciiDoc installer `./install.sh`). See 'Appendix J' of the + 'AsciiDoc User Guide' for details. +- Added 'toclevel' attribute (1..4) which sets the number of title + levels reported in the table of contents. Defaults to 2 and must be + used with the 'toc' attribute. Example usage: + + $ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt + +- Added a `listindex` attribute which is the current list item index + (1..). If this attribute appears outside a list its value is the + number of items in the most recently closed list. +- The single line titles syntax now accepts trailing suffixes -- this + syntax matches the title line syntax of a number of popular Wiki + markups. +- If a QuoteBlock has no attribution or citetitle then the DocBook + `<attribution>` element is not generated (previously generated empty + `<attribution>` element). +- If the text of a labeled list item is blank then no `texttag` is + written. +- An end of line backslash performs line continuation for horizontal + labeled list items. +- The Revision line now accommodates Subversion `$Id` markers (in + addition to CVS and RCS markers). Thanks to Tiago Sturmer Daitx for + this patch. +- Implemented `a2x(1)` option `--skip-asciidoc` which allows `a2x(1)` + to convert DocBook XML files not derived from AsciiDoc sources. +- If `a2x(1) --doctype` option is not specified it defaults to + `manpage` if `--format=manpage` else defaults to `article` + (previously `--doctype` always defaulted to `article`). +- Added an 'External Resources' section to the + http://www.methods.co.nz/asciidoc/index.html[AsciiDoc home page]. + +.Bug fixes + + +Version 8.1.0 (2006-10-22) +-------------------------- +.Additions and changes +- AsciiDoc generated XHTML documents now display a table of contents + if the 'toc' attribute is defined (JavaScript needs to be enabled + for this to work). Thanks to Troy Hanson who contributed this + feature based on a JavaScript by Mihai Bazon. I've simplified things + somewhat to match Docbook XSL Stylesheets style, see Troy's + http://tpl.sourceforge.net/userguide.html[tpl User Guide] for a + fancier layout. Use the `-a toc -a numbered` command-line options to + produce a number table of contents. +- A http://www.methods.co.nz/asciidoc/music-filter.html[music filter] + is included in the distribution `./filters/` directory. It + translates music in http://lilypond.org/[LilyPond] or + http://abcnotation.org.uk/[ABC] notation to standard classical + notation in the form of a trimmed PNG image which is inserted into + the AsciiDoc output document. +- Incorporated Paul Melis's Win32 filter patch. This workaround + allows AsciiDoc to run filters under Windows. +- Added `uninstall.sh` script. +- Rather than proliferate a confusing number of filter block + delimiters the following convention has been adopted: delimiters + belonging to DelimitedBlock filters distributed with AsciiDoc will + consist of a word (normally a noun identifying the block content) + followed by four or more tilde characters. This has necessitated + changing existing filter delimiters (the old delimiters still work + but may be deprecated in future versions): + + * The example code filter block delimiter is now the word `code` + followed by four or more tilde characters. + * The source highlight filter block delimiter is now the word + `source` followed by four or more tilde characters. + +- Conditionally redefined subscript and superscripting so they use the + old replacements mechanism when asciidoc7compatible is defined + rather than the asciidoc 8 default unconstrained quoting (patch for + affected files attached). +- Moved the source highlight filter from `./examples/` to `./filter/`. +- Added `{verbose}` intrinsic attribute (useful for passing verbose + flag to filters). +- Added `{outdir}` intrinsic attribute. +- Renamed `{docdir}` intrinsic attribute to unambiguous `{indir}` + (`{docdir}` still works but may be removed in future release). +- If `asciidoc(1)` outputs to stdout then intrinsic attribute + `{docname}` is extracted from the input file name. + + +Version 8.0.0 (2006-08-27) +-------------------------- +********************************************************************* +This is a major release because changes to quoting and index entry +handling may break existing documents (see 'Additions and changes' +below and 'Appendix A: Migration Notes' in the AsciiDoc User Guide). + +Please report any problems you encounter. + +mailto:srackham@gmail.com['Stuart Rackham'] +********************************************************************* + +.Additions and changes +- Quoting can can occur within words (based on patch submitted by + Benjamin Klum). See the 'Unconstrained Quotes' sub-section in the + User Guide. + +- The underline and plus characters can be used as alternatives to the + existing apostrophe and backtick quote characters. They are arguably + better choices than the apostrophe and backtick as they are not + confused with punctuation. + +- The syntax for index entry macros have have been deprecated from + `+...+` and `++...++` to `((...))` and `(((...)))` respectively. + Rationale: + * Bracketing is consistent other with `[[...]]` and `<<...>>` + reference macros. + * To easily confused with triple plus passthroughs. + * To make way for the new monospace quoting. + +- Superscripts and subscripts are implemented as constrained quotes so + they can now be escaped with a leading backslash and prefixed with + with an attribute list. + +- An experimental LaTeX backend has been written by Benjamin Klum (a + number additions in this release are to accommodate the LaTeX + backend). +- `include` macro file names now expand environment variables and + tilde expansions. +- A configuration file `[quotes]` entry can be undefined by setting to + a blank value. +- Added `callto` inline macro for Skype 'callto' links. +- Added `colnumber` attribute for table data markup. +- A leading comment block or comment lines are now skipped (previously + a document had to start with either attribute entries or a document + Title). +- Experimental `rows` attribute (number of source lines in table) + available in table markup templates (used by experimental LaTeX + backend). +- Included install shell script written by mailto:jlm@ofb.net[Jacob + Mandelson] for installing the tarball distribution. +- Added INSTALL documentation file. +- Added 'replacements2' substitution options -- a second replacements + section. +- Added the ability to redefine 'normal' and 'verbatim' substitutions + with `subsnormal` and `subsverbatim` entries in configuration file + `[miscellaneous]` section. +- By default `AttributeEntry` values are substituted for + `specialcharacters` and `attributes`, if you want a different + AttributeEntry substitution set the `attributeentry-subs` attribute. +- The `name` in `name=value` configuration file entries can now end + with a backslash, just escape the trailing backslash with a + backslash. For example: + + abc\\=xyz ++ +Results in `name=abc\` and `value=xyz` -- previously this would have +escaped the `=` character. + +- A blank configuration file section deletes any preceding section + with the same name (applies to non-markup template sections). +- A command-line attribute value with a `@` suffix does not override + existing document and configuration file attributes (normally + command-line attributes have precedence over document and + configuration file attributes). +- `localtime` attribute is now encoded from the native system encoding + to the output encoding. Patch submitted by + mailto:m_pupil@yahoo.com.cn[FKtPp] -- here's his description of the + problem: ++ +``I am a Chinese user of AsciiDoc and I find that when I use UTF-8 +(the default encoding) to write asciidoc documents in Windows platform +the resulting html footer line will get screwed. It was caused by a +localized tzname that was always encoded in the windows native +encoding, which in my case is 'cp936'.'' + +- a2x(1) can generate Open Document Text files using + http://open.comsultia.com/docbook2odf/[docbook2odf]. Currently + `docbook2odf(1)` only processes a subset of DocBook, unimplemented + elements are skipped. +- The a2x(1) format option defaults to `xhtml` (previously a format + had to be specified explicitly). +- The `-d, \--doctype=DOCTYPE` option has been added to a2x(1) which + is a shortcut for `--asciidoc-options="--doctype=DOCTYPE"`. +- Replaced a2x(1) `--no-icons` and `--no-copy` options with their + negated equivalents: `--icons` and `--copy` respectively. The + default behavior has also changed: copying and use of icons is + disabled by default. Rationale: + * To make the default behavior more consistent since use of icons + and CSS stylesheets does not apply to all formats. + * To make the default behavior less surprising (the creation of icon + and stylesheet output files must now be explicit). + +- a2x(1) has been bumped from version 0.1.1 to version 1.0.0. + + +.Bug fixes +- Removed duplicate `./doc/a2x.1.txt` from distribution tarball. +- Documentation errata. +- Attribute replacement is no longer performed twice in Titles and + AttributeEntrys. +- a2x(1) skipped asciidoc(1) execution when rerun with different + `--asciidoc-options` options, it now always executes asciidoc(1). + The problem was that previously asciidoc(1) was executed only if the + output file was missing or older than the source file. + + +Version 7.1.2 (2006-03-07) +-------------------------- +.Additions and changes +- Support for + http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML] + has been added. See 'Appendix I: ASCIIMathML Support' in the User + Guide and the examples at + http://www.methods.co.nz/asciidoc/asciimath.html. +- You can now prefix quoted text with inline attributes lists. You + can use this to set font size and color (XHTML and HTML outputs). +- Added `##...##` quoting -- it does nothing -- it's purpose is to + allow inline attributes to be applied to normal text. +- An 'inline passthrough' mechanism has been implemented. +- Configuration file comment lines can be escaped with a backslash -- + this is to allows the inclusion of configuration lines that start + with a hash character. +- The `scriptsdir` attribute can be used to specify the name of the + directory containing linked JavaScripts (see the + link:userguide.html#X33[User Guide] for details. +- The BackendBlock has been renamed PassthroughBlock for consistency + with the new inline passthrough naming. +- `a2x(1)` now works with the older `bash(1)` version 2.05b. Patch + submitted by mailto:francis@daoine.org[Francis Daly]. +- Content included by the `include1::[]` system macro is no longer + subject to attribute substitution so that ambiguities no longer + arise when used to include CSS or JavaScript files. + + +Version 7.1.1 (2006-02-24) +-------------------------- +.Additions and changes +- The `caption` attribute can be used to customize admonition captions + as well as image, table and example block element title prefixes + (`xhtml11` and `html4` backends). +- You can now override the default icon image using the `icon` + attribute to specify the path of the linked image (xhtml11 and html4 + backends only). +- The deprecated `imagesdir` attribute is no longer recognized (use + `iconsdir` instead). +- Added 'Appendix H: Using AsciiDoc with non-English Languages' to the + AsciiDoc User Guide. +- Added 'Admonition Icons and Captions' subsection to the User Guide + explaining how to customize Admonition elements. + +.Bug fixes +- `a2x(1)` failed when configuration files were installed in the + global `/etc/asciidoc/` directory -- it was only searching the + directory containing the asciidoc executable (thanks to Christian + Wiese for finding and submitting a patch this bug). +- The html4 backend admonition caption now correctly displays the + admonition `caption` attribute (previously displayed the `style` + attribute). + + +Version 7.1.0 (2006-01-13) +-------------------------- +.Additions and changes +- `a2x(1)` toolchain wrapper utility. This overcomes the biggest + hurdle for new users which seems to be assembling and using a + working DocBook XML toolchain. With `a2x(1)` you can generate XHTML + (chunked and unchunked), PDF, man page, HTML Help and text file + outputs from an AsciiDoc input file with a single command. All you + need to install (in addition to AsciiDoc) is xsltproc(1), DocBook XSL + Stylesheets and optionally FOP (if you want PDF) or lynx(1) (if you + want text). +- Block titles can now start with any non-space character (previously + where not allowed to start with `.~-_` characters). +- `./stylesheets/docbook.css` renamed to + `./stylesheets/docbook-xsl.css` to clarify its function. +- Renamed `./docbook-xsl/manpages.xsl` to `./docbook-xsl/manpage.xsl` + for consistency. +- Admonition and navigation icons moved to `./images/icons/` to + clarify usage and conform with a2x(1) usage. +- Renamed xhtml11 intrinsic attribute `imagesdir` to `iconsdir` to + keep vocab consistent and changed default value to `./images/icons` + (previously `./images`). `imagesdir` attribute still accepted but + deprecated. +- Unused image files have been weeded out of the distribution. +- Packager notes (appendix B) have been updated to reflect the needs + of `a2x(1)`. + +IMPORTANT: The renaming of the xhtml11 backend `imagesdir` intrinsic +attribute and it's new default value introduces a backward +compatibility issue: if you use the `icons` attribute you will need to +either move your icons to the new default `./images/icons` location or +include an `--attribute{nbsp}iconsdir="your_icons_path"` option in +your asciidoc commands. + +.Bug fixes +- Backslash line continuation is now observed in verbatim paragraphs. +- Fixed errors generated by example + `./examples/website/build-website.sh` script. + + +Version 7.0.4 (2005-12-08) +-------------------------- +.Additions and changes +- Added ternary conditional attributes + `{<name>@<regexp>:<value1>[:<value2>]}` and + `{<name>$<regexp>:<value1>[:<value2>]}`. +- Safety violations now generate errors (they previously generated + warnings). +- asciidoc(1) now defaults to safe mode, consequently the + `[miscellaneous]` safe mode entry and `--safe` command-line option + are no longer necessary (though for backward compatibility + asciidoc(1) still accepts the `--safe` option). +- Backend Blocks are now flagged unsafe (they could be used to include + arbitrary and hence potentially unsafe output content). +- Filters are no longer considered unsafe. There's not much point in + insisting on filter safety since the installation of an unsafe + filter would require the introduction of new or modified + configuration files -- if your application configurations can be + compromised you're in all sorts of trouble (safe mode protects + against unsafe input files not unsafe configuration). As with all + filters, before installing, you should verify that they can't be + coerced into generating malicious output or exposing sensitive + information. + +.Bug fixes +- Fixed a lot of glaring grammatical and factual errors in the User + Guide. + + +Version 7.0.3 (2005-12-01) +-------------------------- +.Additions and changes +- Added `--safe` and `--unsafe` command-line options -- AsciiDoc can + now be executed in a 'safe mode' which disallows the execution of + arbitrary code or the inclusion of arbitrary files (see + link:userguide.html#X39[Appendix C in the AsciiDoc User Guide]). +- Included link:source-highlight-filter.html[source-highlight filter] + in the distribution `./examples/source-highlight-filter/` directory + (based on filter submitted by mailto:trolocsis@gmail.com[Ryan + Phillips]). +- Included the DocBook XSL Stylesheets 1.69.1 customizations used to + generate the distributed AsciiDoc documentation (read the + `asciidoc-docbook-xsl.txt` file in the distribution `./docbook-xsl/` + directory). +- AsciiDoc DocBook XSL Stylesheet drivers moved from `./doc/` to + `./docbook-xsl/`. +- Modified `./doc/manpages.xsl` so only URL content is displayed in + manpages. + +.Bug fixes +- Explicitly set table CSS border style (`xhtml11` backend) to `solid` + because default border styles vary from browser to browser. + + +Version 7.0.2 (2005-08-28) +-------------------------- +.Additions and changes +- There are now long versions of all AsciiDoc options. +- If the `--backend` is not specified it defaults to `xhtml11`. +- Added CSS simulated frames layout to the examples website (see + `./examples/website/layout2/README-website.txt`). This layout does + not work with IE6 and the original tables based layout is still the + default. +- Support page added to AsciiDoc website. + +.Bug fixes +- Invalid options are now trapped gracefully. +- Documentation errata. + + +Version 7.0.1 (2005-06-24) +-------------------------- +.Additions and changes +- Reverted to use of `strong`, `em`, `tt` XHTML tags -- they're more + obvious and no less correct than `span` tags, besides, the generated + file sizes are smaller (the 'User Guide' was 11% smaller). +- Table title rendered with `caption` tag rather than a separate + `div`. +- The AsciiDoc 'stylesdir' attribute (if specified) is now recognized + when searching for embedded stylesheets (previously only searched + default `./stylesheets` directory). +- Default charset encoding changed from ISO-8859-1 to UTF-8 -- it's + less language specific and displays most common languages. +- `template::[]` macros now expand in all configuration file sections + previously only in markup template sections. +- Cleaned up example website layout CSS and configuration + (presentation has not been changed). +- Refactored `xhtml11.conf` configuration file. +- Set consistent and sensible permissions on distributed files. +- White space is now stripped from DSV formatted table cell data. +- `class="tableblock"` attribute added to tables generated by + `xhtml-deprecated-css.conf` to assist CSS. + +.Bug fixes +- Illegal character set encoder (specified by the AsciiDoc `encoding` + attribute) and character data are trapped gracefully. +- AsciiDoc table 'format' attribute in table attribute lists were not + recognized. +- The nested horizontal labeled list example in the 'AsciiDoc User + Guide' has been dropped -- it generated invalid DocBook markup. + + +Version 7.0.0 (2005-06-06) +-------------------------- +*************************************************** +This is a major release with many code and +documentation changes. +Please report any problems you encounter. + +mailto:srackham@gmail.com['Stuart Rackham'] +*************************************************** + +.Additions and changes +- A new 'xhtml11' backend generates XHTML 1.1 with integrated CSS2 + replacing the previous 'xhtml', 'css', and 'css-embedded' backends. +- The CSS stylesheets have finally been rewritten. +- The asciidoc(1) command help now includes user + link:userguide.html#X36[customizable help] topics. When asciidoc is + invoked with the `--help` option the command argument is + interpreted as a help topic. +- The previous example website has been replaced by the actual + AsciiDoc website (see `./examples/website/`. +- XHTML generation options now controlled by the following attributes: + 'badges', 'linkcss', 'icons', 'numbered', 'quirks', 'theme', + 'stylesdir', 'imagesdir' (see the link:userguide.html#X33[User + Guide] for details. +- By default HTML and XHTML are output as stand-alone documents (no + embedded CSS and no linked admonition icon images). +- Documents encoded with the UTF-8 Unicode character set are now + processed thanks to a patch supplied by + mailto:viktor@rbg.informatik.tu-darmstadt.de[Viktor Vasilev]. +- The `-a ^name` command-line syntax to undefine an attribute has been + deprecated in favor of the `-a name!` syntax. +- AttributeEntry syntax addition: `:name!:` to undefine `name` attribute. +- Added `template` system block macro to allow the inclusion of one + configuration file template section within another. +- A 'verse' style attribute can now be applied to literal paragraphs + and blocks to reproduce line breaks and white space from the source + document. +- Replacements and Special Words can now be escaped with leading + backslashes. +- Replacements are now processed in configuration file order (previous + ordering was indeterminate). +- System macros can now be used in the base `asciidoc.conf` + configuration file. +- Deprecated features that emitted warnings in prior versions are no + longer tolerated. +- The `eval` system attribute expression evaluates to `False` the + attribute is undefined, if it evaluates to `True` the result is an + empty string. +- The Paragraph and DelimitedBlock 'presubs' parameter can be aliased + as 'subs'. +- Added 'verbatim' substitutions option. +- Renamed 'List Continuation Block' to 'List Block' and renamed the + 'listcontinuation' option to 'list'. +- Deprecated 'default' substitutions option (use 'normal' instead). +- The 'section-numbers' section numbering attribute has be renamed + 'numbered'. +- Dropped the '\#UNDER CONSTRUCTION#' block macro. +- Rewrote Paragraph and DelimitedBlock handlers adding a + link:userguide.html#X23[styles] configuration entry. + +.Bug fixes +- Included files are no longer read inside conditionally excluded + content. +- Manpage command names containing dashes (in the manpage NAME + section) were misinterpreted as the spaced dash command name/purpose + separator. Bug report and patch supplied by + mailto:david@dgreaves.com[David Greaves]. +- Unexpected error following malformed author line error. + + +Version 6.0.3 (2005-04-20) +-------------------------- +.Additions and changes +- Special characters are now substituted in AttributeEntry element + values. +- Spaced and unspaced em dashes are now recognized (previously only + spaced em dashes were recognized). +- Replaced the table 'noborders' option with richer 'frame' and 'grid' + attributes. +- The `duplicate macro` warning message now only occurs when the + verbose (`-v`) option is enabled. +- Single lines starting with two forward slashes hard up against the + left margin are treated as comments and are not processed. +- Renamed 'section' delimited block option to 'sectionbody' to more + accurately reflect it's role. +- Added a List Continuation block -- a specialized delimited block + that is functionally equivalent to the List Item Continuation + feature except that the list contained within the block does not + require explicit '+' list item continuation lines. +- Dropped deprecated `<u>` tags from generated HTML. +- Literal Block delimiters must now consist of at least four points + (previously three) to avoid lone ellipsis ambiguity. + +.Bug fixes +- Some system attribute evaluation failures caused unexpected + exceptions to occur. + + +Version 6.0.2 (2005-03-30) +-------------------------- +.Additions and changes +- Three new 'system' block macros have been added -- `eval`, `sys` and + `sys2` which are the block macro equivalents to the same named + system attributes. +- 'Intrinsic' macros have been renamed 'system' macros along with + 'action' attributes which have been renamed 'system' attributes: + * To reflect their common (though contextually different) behavior. + * To avoid confusion with 'intrinsic attributes'. + +.Bug fixes +- Asciidoc now searches in `/etc/asciidoc/filters` for filters. + + +Version 6.0.1 (2005-03-06) +-------------------------- +.Additions and changes +- A global configuration file location `/etc/asciidoc` has been added + and is now processed before all other locations (patch supplied by + mailto:stone@debian.org[Fredrik Steen]). +- Recoded `tempfile.mktemp()` and other artifacts that are no longer + necessary or desirable (patches supplied by + mailto:stone@debian.org[Fredrik Steen]). +- Added BUGS file to the distribution. + +.Bug fixes +- Illegal comment syntax in `css-embedded-stylesheet.conf` resulted in + illegal CSS in files generated by the `css-embedded` backend. + + +Version 6.0.0 (2005-01-28) +-------------------------- +*************************************************** +This release has had some fairly major code and +documentation changes. Please report any problems +you encounter. + +mailto:srackham@gmail.com['Stuart Rackham'] +*************************************************** + +A lot of new stuff. A new major version number -- some regression +incompatibility (hopefully mitigated by 'deprecated' warnings). + +Went mad trying to rein in the current feature anarchy -- established +a unified notion of document attributes. Attempted to introduce a +consistent vocabulary -- renamed many poorly or inconsistently named +entities. + +Actually, deprecated syntax is still processed correctly in almost all +cases. One source of incompatibility that may arise if you have +customized CSS stylesheets is the change of AsciiDoc CSS class names +(see below). I guess the moral is if you've done a lot of +configuration file customization and are happy with version 5 then you +may want to stay put. + +NOTE: This version requires Python 2.3 or better to run. + +.Additions and changes +- 'Glossary entries' have been renamed 'attributes'. This eliminates + confusion with the accepted meaning of glossary. +- An `AttributeEntry` block element has been added so that document + attributes can be assigned from within an AsciiDoc document. +- The `AttributeList` block element has been added which is a more + general solution than the (now deprecated) DelimitedBlock arguments. +- An BlockId element has been added for setting block element anchor + (link target) IDs. +- Quoted text can now span multiple lines (thanks to James Bowlin for + this patch). +- Inline macros can now span multiple lines. +- \``double backtick / apostrophe'' quotes generate ``curly quotes''. +- A warning is now emitted for out of order list item (applies to + explicitly enumerated numbered list items). +- Added `include` action attribute. +- A line of three or more apostrophes generates an HTML horizontal + ruler (`<hr/>` tag). You will get a warning if processed with + non-HTML backend. +- An `{imagesdir}` attribute specifies image file location for images + referenced in configuration files when generating HTML (the default + location is `images`). +- An `{stylesdir}` attribute specifies the location of CSS + stylesheets when generating styled HTML (the default location for + configured markup is `.`). +- The use of the (often inappropriately named) `{caption}` attribute + list entry has been deprecated, use `{0}` instead. +- New 'ExampleBlock' delimited block along with associated variants + Note, Tip, Warning, Caution and Important. +- The `docbook.conf` file now facilitates the optional inclusion of a + DocBook revision history file. +- To better reflect their purpose the following block elements have + been renamed: `VerbatimBlock` to `ListingBlock`; `IndentedBlock` to + `LiteralBlock`; `IndentedParagraph` to `LiteralParagraph`; + `CustomBlock` to `BackendBlock`; `SimpleSection` to `SectionBody`. + Any corresponding CSS class names have also been changed which could + result in backward incompatibility in customized stylesheets. +- Swapped plain DocBook admonition icons for Jimmac's DocBook icons + (http://jimmac.musichall.cz/ikony.php3). The original plain icons + have been moved to `./images/plain`. +- Renamed `html` backend to `xhtml` to better reflect it's function + (former `html-4` backend renamed to `html`). +- A new inline anchor macro syntax `[[[<id>]]]` is available, it + displays `[<id>]` at the anchor location and is for anchoring + bibliography list entries. +- An optional 'single-line titles' syntax can be used. +- Tweaks to distributed CSS stylesheets and FOP `fo.xsl` customization + file. +- 'List Item Continuation' has been implemented which allows + additional block elements to be included in list items by separating + them from the preceding list item element with a line containing a + single plus character. +- A new 'Horizontal Labeled List' list type has been added. Generates + two column list -- the first column contains the list element + labels, the second contains the element text. Same syntax as + `Vertical Labeled Lists` except the double colon label suffix is + followed by the start of the list item text. + +.Bug fixes +- Fixed broken backslash line continuation. +- Labeled list end tags were not undergoing attribute substitution. +- Documents without any author information now generate legitimate + DocBook (previously if the author line was not included in the + document header then an empty (illegal) DocBook `author` element was + generated). +- Multiple spaces in filter command arguments were replaced by a + single space. The `./examples/asciidoc2text/asciidoc2text.sh` script + now indents text correctly. + + +Version 5.1.1 (2004-10-10) +-------------------------- +*15-December-2004: Interim update:* Updated `asciidoc.py` to fix +broken `join_lines` function -- no other changes. + +- PDF documentation is now produced from DocBook XML using XSLTLib and + FOP. Previously we processed DocBook SGML with `jw(1)` (which used + Dvips to convert DVI files to PDF). FOP has come a long way in the + last 12 months and produces very acceptable PDF under both Linux and + Windows. +- Sections detailing how to install and use the DocBook XSL + Stylesheets, xsltproc, FOP toolchain and the AsciiDoc XSLT drivers + have been added to the User Guide. +- The PDF output from the he example article template has been + included in the distribution (`./doc/article.pdf`). +- Special characters are emitted using decimal Unicode character codes + (previously used named character entities which cannot be assumed + included in non-HTML documents). +- Added registered trademark (R) to `[replacements]`. +- CSS stylesheet tweaks. +- Admonitions (Note, Tip, Important, Warning, Caution) include icons + when generating css output. + + +Version 5.1.0 (2004-09-18) +-------------------------- +- Callouts have been implemented (see the 'Callouts' section of the + AsciiDoc User Guide for details). +- Added XSL drivers for generating XHTML, chunked XHTML and HTML Help + from DocBook XML using XSL stylesheets and xsltproc(1). +- Added CSS stylesheet for HTML generated from DocBook XML using XSL + stylesheets. +- Distribution contains HTML Help formatted User Guide + (`./doc/asciidoc.chm`), the User Guide tells you how it's generated. +- Images referred to by distributed stylesheets are now located in the + `./images` subdirectory (previously located in `.`). +- Filters path names are now handled properly under Cygwin. +- The usual documentation and examples additions, updates and + polishing. + + +Version 5.0.9 (2004-09-09) +-------------------------- +- The convention of using a `.asc` file extension for AsciiDoc files + has been dropped in favor of the familiar `.txt` extension. It makes + more sense in that AsciiDoc is a text presentation format and + because `.asc` clashed with the same extension used by other + applications. It's only a naming convention -- you don't have to + switch if you don't want to. +- Changed the subscript formatting character from underline to tilde + since underscores in file names are reasonably common (especially in + link and image macros). +- An alternative syntax for the index term inline macro has been + added: `++<primary>,<secondary>,<tertiary>++`. +- Index terms that have secondary and tertiary entries now + additionally generate separate index terms for the secondary and + tertiary entries. +- A `+<primary>+` index term inline macro has been added which + displays the term in the primary text flow. +- Added alternative variable list definition using double semi-colon + terminator as opposed to the standard double colon terminator so + variable lists can be nested to two levels. +- Footnotes now appear on a separate line in HTML and Linuxdoc + outputs. +- Python version compatibility is checked at startup. +- Preface and appendix section titles in multi-part Book documents are + meant to be out of sequence -- warnings are no longer emitted when + outputting HTML. +- Empty section warnings have been replaced by error messages and are + emitted only if invalid markup would result. +- Missing macro sections or invalid macro name warnings are only + generated at startup if the `-v` (verbose) option is set. Otherwise + they are deferred until a matching macro is encountered in the input + file. +- Missing or invalid table definition warnings are only generated at + startup if the `-v` (verbose) option is set. Otherwise they are + deferred until a matching table is encountered in the input file. +- AsciiDoc now makes more of an effort to continue in the face of + errors. +- Fixed broken `./examples/website/main.aap` script. +- Converted distribution text files DOS text format as a sop to + Windows users with challenged text editors. +- Documentation additions and corrections. + + +Version 5.0.8 (2004-05-15) +-------------------------- +- Spurious 'out of sequence' level 2 warnings no longer appear when + processing 'book' document multi-part book top level Preface and + Appendix sub-sections since they are (correctly) out of sequence. +- A warning is no longer emitted for empty Index sections since this + is normal when generating DocBook outputs. +- Fixed: `[quotes]` configuration file entries where not being + overridden by downstream configuration file entries. +- Footnote text is now output enclosed in square brackets in HTML + documents. +- Added superscripts and subscripts to the standard PRS configuration + files. +- Adjusted CSS stylesheets so list titles don't have so much space + between title and first list item (broken in IE6 due to poor CSS + compliance). Lessened sidebar title top margin. + + +Version 5.0.7 (2004-04-22) +-------------------------- +- The version 5.0.6 README incorrectly stated that AsciiDoc would run + under Python 2.0, in fact it requires Python 2.1 or better. The + README has been corrected. +- Documented techniques for combining and splitting AsciiDoc documents + and processing the combined and split parts (see the 'Tips and + Tricks' section of the User Guide). +- An example of marking up superscripts and subscripts is documented + in the 'Tips and Tricks' section of the User Guide (the example + configuration file is in the AsciiDoc `examples` directory). +- Added ellipsis to shipped `[replacements]`; three periods output an + ellipsis entity. +- Removed unused 'SectionClose' class. +- The AsciiDoc 'Preamble' element is output as a DocBook 'Preface' + when processed as a 'book' document type (in older AsciiDoc versions + a warning was issued and processing stopped). +- Fixed a quoting anomaly: quoted text can no longer begin or end with + with white space. + + +Version 5.0.6 (2004-03-07) +-------------------------- +- New 'image' macro implements optional image scaling and linking and + works in both inline and block contexts. The 'image' macro obsolesces + the existing 'graphic' block macro and 'icon' inline macro. +- Macro substitution section names now have `-inlinemacro` and + `-blockmacro` suffixes to resolve context ambiguity, make their + purpose clearer and relieve section namespace congestion. +- Header derived glossary entries can now be overridden from the + command-line. +- Special character substitution is now performed on AuthorLine + derived author names. +- A macro or block argument called 'options' can be used as a shortcut + for a list named arguments with zero length string values. +- Tables can be output without borders using the `options="noborders"` + argument. +- Table data lines that do not immediately follow a table section + underline can now be blank. This allows CSV data with embedded blank + lines to be processed correctly. +- Blank DSV format table data lines are silently skipped. +- Tightened up on enforcement of configuration file section names to + reduce the possibility of section content being seen as a section + header line. +- Section titles can be optionally suffixed with title arguments + enclosed in double square brackets. +- A replacement has been added to `asciidoc.conf` to replace inline + double dashes with the `—` entity. +- Changed the `.UNDER-CONSTRUCTION.` macro syntax to + `#UNDER-CONSTRUCTION#` so it is not mistaken for a BlockTitle. + Similarly changed the `.NEW.` replacement with + `#NEW#`. +- `#NEW#` and `#UNDER-CONSTRUCTION#` macros are now + included in the DocBook backend. +- Replaced shipped `smallnew.gif` with `smallnew.png`. +- Documentation tidy ups. + + +Version 5.0.5 (2004-02-25) +-------------------------- +- Fixed the disappearing paragraph titles problem that was caused by + Inline macros (incorrectly) processing BlockTitles. +- Tightened AuthorLine validation. Previously invalid email addresses + and embedded special characters in the AuthorLine resulted in + invalid output markup. + + +Version 5.0.4 (2004-02-09) +-------------------------- +- Reinstated missing `infile`, `outfile`, `filetype` and + `filetype-<filetype>` glossary entries. +- As of version 5.0.3 asciidoc(1) now requires Python 2.0 or greater, + this has now been documented. + + +Version 5.0.3 (2004-01-23) +-------------------------- +- Fixed problem that caused any filters directory file containing + `.conf` (not just those with the `.conf` extension) from being + loaded. +- All `[miscellaneous]` configuration file entries can now be + referenced like glossary entries (they are now processed internally + as glossary entries). +- The output file line terminator (previously hardwired to `\r\n` is + now set using the `newline` entry in the configuration file + `[miscellaneous]` section. +- The misspelt `blocktitles` configuration file entry name has been + corrected (to `blocktitle`). +- An `{empty}` glossary entry has been added to the default + configuration which is useful for outputting trailing blank lines + from configuration file substitution sections. + + +Version 5.0.2 (2003-12-18) +-------------------------- +- New (alternative) 'anchor' and 'xref' macro syntax (old syntax still + valid). +- DocBook `mediaobject` and `inlinemediaobject` tags are generated in + place of `graphic` and `inlinegraphic` tags by the AsciiDoc + `graphic` and `icon` macros. If a macro argument is specified it is + the alternative text output if the target document format does not + support the specified graphic file format. +- Dropped the LinuxDoc left and right square bracket special character + substitutions as they interfered with macro substitution. +- Documentation updates and corrections. + + +Version 5.0.1 (2003-12-09) +-------------------------- +- Fixed problem with anchor tag when generating CSS styled HTML. + + +Version 5.0 (2003-12-08) +------------------------ +*************************************************** +This release has had some fairly major code and +documentation changes. Please report any problems +you encounter. + +mailto:srackham@gmail.com['Stuart Rackham'] +*************************************************** + +- AsciiDoc can now produce a full-blown multi-part DocBook book + including dedication, abstract, preface, colophon, glossary, + appendix, bibliography and book part elements using the new + `specialsections` configuration file section. +- All Section element children (Paragraph, DelimitedBlock, List, + Table, BlockMacro) can now be titled using the BlockTitle element. + A BlockTitle element is a single line containing a title and + beginning with a period. +- The `index` and `backmatter` macros have been dropped, superseded by + `specialsections`. +- The AsciiDoc 'Preface' element has been renamed 'Preamble' (to avoid + confusion with the DocBook book preface element). +- Out of sequence titles are now tolerated with a warning. This allows + book document level 0 sections to be processed. +- An 'anchor' inline macro has been added for document link target + creation. +- 'Note', 'Tip', 'Important' and 'Warning' paragraph types have been + added to support the corresponding DocBook elements. +- Title substitution is now performed in SidebarBlock titles. +- DocBook graphics now output as `figure` and `informalfigure` + elements rather than `mediaobjects`. This ensures numbered figures + and a lists of figures are produced by the DocBook toolchain. +- You can now escape block argument lines by appending a backslash. + Alternatively, if you embed arguments in the delimiter line AsciiDoc + does not check for an arguments line. +- The default DocBook backend file extension has been changed from + `.docbook` to `.xml` (`.sgml` for the 'docbook-sgml' backend). +- Warnings are output by default (previously they only printed when + verbose option enabled). +- A Question and Answer variable list definition has been added to the + shipped configuration files, primarily to create DocBook `qanda` + DocBook elements. +- Fixed broken code-filter `-b linuxdoc` option. The asciidoc.asc User + Guide can now be processed by linuxdoc(1) (although tables are + dropped because LinuxDoc does not implement tables). + +.Compatibility issues: +1. Table titles are no longer in the arguments line, use the new + BlockTitles. +2. Graphic titles are no longer in the 'graphic' block macro caption, + use the new BlockTitles. +3. The code-filter title must be placed in a preceding BlockTitle. +4. SidebarBlock titles must be placed in a preceding BlockTitle. +5. The DelimitedBlock option 'sidebar' has been renamed to 'section'. +6. The default DocBook backend file extension has been changed from +`.docbook` to `.xml` (`.sgml` for the 'docbook-sgml' backend). + + +Version 4.2 (2003-11-26) +------------------------ +- The default HTML output is now XHTML 1.0 markup. To output the + former HTML 4 markup specify the `html-4` backend. +- The default DocBook output is now DocBook XML. To output the former + DocBook SGML specify the `docbook-sgml` backend. The associated + `docbook-sgml.conf` file illustrates how to support minor DTD + variations. Examples of using the `xmlto(1)` command for DocBook + conversion have been added to the User Guide. +- Glossary entries set using the command-line -g option can now be + referenced in configuration files. +- Configuration dumps (`-c` command-line option) no longer output + redundant undefined glossary entries. +- DelimitedBlock arguments can now be specified in a separate arguments + line immediately following the leading delimiter line, This is in + preference to the existing delimiter embedded arguments. Reasons: + * The syntax is in keeping with the Tables arguments syntax. + * It's easier to enter and implements line continuation. +- A new QuoteBlock DelimitedBlock definition has been added to the + distribution configuration files. +- The table arguments lines can be continued using the backslash line + continuation character. +- Added new calculated glossary reference type `{<name>%<value>}`. +- Double-quote characters can now appear in unquoted positional + arguments. + + +Version 4.1 (2003-11-13) +------------------------ +- Added DSV (Delimiter Separated Values) tables format. +- `{eval:<expr>}` glossary references drop the containing line if + `<expr>` evaluates to `None`. +- Block, Table and Macro arguments can now be positional (quoted or + unquoted). +- Vocabulary change: DelimitedBlock, Table and Macro 'attributes' are + now referred to as 'arguments'. This makes more sense in light of the + extended syntax and avoids confusion with backend markup tag + attributes. +- 'tablewidth' table ruler parameter can now be expressed in percent + units (0..100). If between 0 and 1 then the original fractional unit + measure is applied. +- The use of quoting for generating footnotes and index entries has + been dropped in favor of 'footnote' and 'indexterm' inline macros. +- 'backmatter' inline macro included in distribution. +- Fixed: CSS styled HTML tables are now fully XHTML 1.0 conformant. +- Fixed: 'tablewidth' was processed incorrectly when passed as table + argument. +- Fixed: Glossary references like `{x=\{y}}` were one character off + if \{x] was defined and `{y}` was not. + + +Version 4.0 (2003-11-08) +------------------------ +*************************************************** +This release has had some fairly major code and +documentation changes. Please report any problems +you encounter. + +'Stuart Rackham' +*************************************************** + +- Added tables to AsciiDoc. +- Added two special 'subs' options: 'default' specifies the default + substitution options and 'none' specifies no substitution. These + options can only appear singly. +- Line continuation using a trailing backslash character is available + in Paragraphs, ListItems, Tables. +- The left and right quotes for quoted text can now be specified + separately. +- Shipped configuration files implement footnotes (only useful for + DocBook output) using \[[]] quoting. +- Shipped configuration files implement index terms (only useful for + DocBook and LinuxDoc output) using \(()) quoting. +- The shipped 'html' backend configuration now emits valid 'HTML 4.01 + Transitional'. +- Added new calculated glossary reference types `{<name>!<value>}` + and `{<name>#<value>}`. +- The DelimitedBlock 'params' option has been dropped in favor of the + new 'block attributes' mechanism. If you have customized block + params options you may need to adjust source files to use the + 'block attributes' syntax. The example code filter has been updated + to reflect these changes. +- The code filter now has a `-t tabsize` option. +- Replaced `-w` option with `-v` (verbose) option. The warnings option + was just to confusing. +- Named attributes can now be specified in macro calls. +- The 'tabsize' attribute is recognized in the built-in `include` + macros. A tabsize of zero suppresses tab expansion. +- The configuration file `[options]` section has been split into + `[miscellaneous]` and `[titles]`. If you have customized any of + these settings you will need to adjust the affected configuration + files. +- Configuration file `[miscellaneous]` entries can now also be set + using the command-line `-g` option. +- Fixed: error that occurred when attempting to use zero length + configuration and source files. +- Fixed: blocking filter halt problem. +- Fixed: inline macro escape prefix problem. +- Fixed: missing macros from configuration dump problem. +- Fixed: named macros were dumped incorrectly. +- Many documentation changes/additions/corrections. + + +Version 3.2.2 (2003-10-26) +-------------------------- +- Added `-n` option (synonym for `-g section-numbers`). +- Dropped the processing commentary (hey, this is Unix). +- Added new calculated glossary reference type `{<name>?<value>}`. + `<name>` is the glossary entry name and `<value>` is the text + substituted if the glossary entry is defined. `<value>` can only + contain literal text (no glossary references allowed). +- Added `asciidoc2text` to distribution `examples/asciidoc2text` + directory (converts AsciiDoc source to text file with section + numbering). +- Fixed incorrect nesting of Simple lists inside Variable lists. +- List definitions have been modified so that list items can be + indented. This allows a more intuitive indentation of nested lists + in AsciiDoc source. +- Lists must be separated from preceding paragraphs by a blank line. + This is to avoid paragraph lines being mistaken for list items. +- Corrected asciidoc man page documentation error: the`-f` option does + *not* search relative to source document directory for the + configuration file. +- Minor updates to various distribution `.conf` files. +- Included `badges.conf` in `examples` directory. +- `css-embedded-stylesheet.conf` now supports footer badges. +- The default in-line element processing order has been changed: + Glossary References are now processed before Inline Macros. This + allows glossary expansions to occur inside macro references. +- Glossary entries are now allowed in Author and Revision lines. +- Default List `subs` options and Paragraph `presubs` options are + assigned the following default value if not specified: + + specialcharacters,quotes,specialwords,replacements,glossary,macros + +- Documentation changes/additions/corrections. + + +Version 3.2 (2003-05-26) +------------------------ +- Added a `-s` command-line option to suppress the output of + `[header]` and `[footer]` sections. +- Article document headers are no longer mandatory: this allows + AsciiDoc to process arbitrary chunks of text. When used in + conjunction with the new `-s` command-line option corresponding + chunks of backend markup can be generated. +- AsciiDoc now emits a warning message and continues when an out of + sequence section title is detected (previously it failed and + halted). This allows document sections to be processed separately. +- Optional 'presubs' and 'postsubs' entries have been added to + 'DelimitedBlock' and 'Paragraph' definitions. As a consequence + substitution options are no longer legal in 'options' entries. +- 'presubs' and 'postsubs' substitutions are processed in the order + the options are specified (rather than the fixed 'options' order of + previous versions). +- ./filters subdirectories are automatically searched for filter + commands. +- A 'title-subs' configuration option specifies the substitutions + performed on document Header and Section titles. +- A 'subs' entry in now included in List configuration file + definitions that specified substitutions performed on list entry + text. +- Configuration files are auto-loaded from ./filters subdirectories. +- Added example code filter (see ./examples/filters). +- Bug fix: if section was empty you may have got erroneous 'missing + tag "paragraph"' error. +- Internal code tidy up. + + +Version 3.1 (2003-05-18) +------------------------ +- In version 3.0 a `[macros]` section entry of the form 'name' was + equivalent to 'name='. An entry of the form 'name' now undefines the + entry (to bring it in line with the behavior of other special + sections). +- Paragraphs have now been generalized (in the same way as Lists and + DelimitedBlocks). +- The 'indentsize' option has been dropped as as consequence of + paragraph generalization. +- Pipe | characters can be included in substituted tag and + substitution section text using the \{brvbar} (broken vertical bar) + glossary reference. +- Removed the restriction requiring substitution section text + placeholders | to be on a separate line. +- Added an `-e` asciidoc(1) command option that excludes implicit + configuration files (used in conjunction with `-c` generated + configuration files). +- Version 3.0 documentation has undergone a considerable cleanup. +- The dumping of quoted section entries (see `-c` option) now works + correctly. +- The format of special section entries has been made consistent: + `name` undefines the entry; `name=` sets the entry value to a blank + string; `name=value` sets the entry value to `value`. +- As a consequence of the previous change the caret prefix is no + longer used in glossary configuration file entries (although it is + still used when undefining an entry using the `-g` command-line + option). + + +Version 3.0 (2003-05-13) +------------------------ +This version is the culmination of work begun in the 2.x releases +whereby fixed policy has been replaced by extensible mechanisms. + +- Added `-c` command-line option to dump a composite asciidoc(1) + configuration file to stdout. +- Lists and Delimited Blocks are now defined by a set of configuration + file parameter sections. The user can modify the default + definitions or add new ones. +- Block content can now be processed through external filters. +- The default behavior for Custom Blocks is to perform glossary + substitution (previously there was no substitution inside Custom + Blocks). +- The old 2.x style macros have been reimplemented; as with Lists and + Delimited Blocks there syntax and behavior can be configured by the + user. The default macro syntax remains the same but the semantics + are now (hopefully) a bit more intelligible. +- Block and Builtin macros use :: delimiter instead of the 2.x single + colon delimit (to distinguish them from inline macros). The 2.x + syntax is still supported for backward compatibility. +- Nested lists are now supported and IndentedParagraphs can be + included in list items. +- Conditional source inclusion can be specified using built in `ifdef`, + `ifndef` and `endif` macros. +- The new conditional source inclusion feature has been used to reduce + the number of default configuration files down to one per backend. +- A change of name: 2.x 'Substitutions' are now called 'Replacements' + and the 2.x `[substitutions]` configuration file section is now + called `[replacements]` (the old name is still recognized for + backward compatibility). +- The line break is now implemented as a 'Replacements' substitution. +- Inline 'icon' macro for inline images has been added to default + configuration files. + +Version 2.2 (2003-04-07) +------------------------ +- The `master.conf` configuration file name has been deprecated in + favor of `asciidoc.conf`. +- The standard configuration files set is now loaded from the + `.asciidoc` folder in the users home directory (if it exists) and + then from the source document directory. Configuration files that + don't exist are silently skipped. +- Configuration files named like the source file will be automatically + loaded if they are found in the source file directory. For example + if the source file is `mydoc.asc` and the `-b html` option is used + then asciidoc(1) will look for `mydoc.conf` and `mydoc-html.conf` in + that order. +- The characters used to quote formatted text can be configured and + extended by the user (see the master.conf [quotes] section). +- Quoted text can now be escaped by prefixing a backslash character to + the leading quote. +- The double single-quote '' strong text quote has been deprecated in + favor of an asterisk * character. +- Added \{eval:expression}, \{sys:command} and \{sys2:command} + glossary reference actions. +- Trailing brace characters `}` are now allowed inside glossary + references provided they are escaped with a backslash character. +- Glossary entries can now be escaped by prefixing a backslash + character to the leading brace character (use this in preference to + placing the backslash inside the brace). +- The output macro has been deprecated (use the new include1 macro + inside a CustomBlock). +- The default document type is `article` (asciidoc no longer attempts + to guess). +- Files included within DelimitedBlocks are not searched for block + termination underlines. This ensures the entire file is part of the + DelimitedBlock. +- `include` macros can now be used in configuration files. +- Corrected \{infile} and \{outfile} glossary entry documentation. +- File inclusion is now limited to a depth of 5 to catch recursion + loops. +- Inline tags have been deprecated, they're not necessary and they + immediately make the source document backend specific. Use + CustomBlocks or Substitutions instead. + +Version 2.1 (2003-03-17) +------------------------ +- Added section auto numbering `{sectnum}` glossary entry + (auto-numbering function contributed by Ludovico Magnocavallo). +- asciidoc(1) now correctly returns non-zero exit status if an error + occurs. +- An AsciiDoc example website has been included in the AsciiDoc + distribution `examples/website` directory. +- NOTE: The `asciidoc` wrapper script included in the 2.0 distribution + has been dropped, if you've symlinked or aliased to `asciidoc` you'll + need to change them to point directly to `asciidoc.py` instead. +- An RCS $Id$ marker can be used as the document header revision line + (based on a patch submitted by Ludovico Magnocavallo). +- In addition to the `name=value` glossary entry format two new ones + have been introduced: `name` (the default value is set to an empty + string) and `^name` (the glossary entry is undefined). +- The `-q` command-line option has been deprecated and the `-w level` + command-line option added. + + NOTE: By default skipped substitution warnings are now suppressed. +- If a configuration file specified with the `-f` command-line option + is not found relative to the current working directory then the + search is repeated relative to the asciidoc(1) directory. This + allows global configuration files to be used. +- Added `{infile}`, `{outfile}` predefined glossary entries. +- Added `under-construction` macro to HTML article configuration + files. +- Deprecated `{asciidoc_version}` glossary entry in favor of + `{asciidoc-version}` (to it consistent with other entries). + +Version 2.0 (2003-02-24) +------------------------ +- The emphasized, strong and monospaced words options have been + generalized with the introduction of macro based 'special words' + lists. +- Glossary references can now appear in both the document and macro + bodies. +- All output files use `crlf` line termination (previously used UNIX + `lf` (newline) termination). +- Added [substitutions] section which implements arbitrary regular + expression based substitutions. +- An optional `master.conf` configuration file can be used for entries + that are not backend or document type specific. +- Special character definitions moved from the code to the new + [special_characters] configuration file section. +- Configuration file glossary added. +- Command-line -g glossary entry added. +- A new 'book' document type has been implemented for the 'docbook' + backend. It outputs DocBook 'book' documents. +- A major internal change has been the implementation of parametrized + user definable 'macros'. Internally most document elements are now + processed as macros. +- Configuration file macro variables can be specified with default + values (literals or other macro variables). +- An attempt has been made to tighten up the vocabulary used to + describe the AsciiDoc document syntax. +- The term abstract has been replaced by the more general term + 'preface' and a new preface section introduced into article + configuration files (replacing the synopsis sections). +- Any section elements can now be put in the document preface + (previous versions only allowed paragraphs). +- AsciiDoc Blocks have been unified and their behavior can be user + defined and parametrized. +- An 'output' inclusion allows an external file to be written directly + to the backend output file. +- A new CustomBlock has been added. Default behavior is to insert the + enveloped AsciiDoc source lines directly into the output file. +- A 'line break' tag can be inserted by terminating a line with a '+' + character (only really useful for HTML backends). +- An fourth section level has been introduced. +- The SidebarBlock delimiter line characters have been changed. The + deprecated underline is still accepted. +- Levels 2 and 3 title underline characters have been changed. The + deprecated underlines are still accepted. +- Lines with backend specific inline tags can be inserted into + AsciiDoc source files. +- Single words enveloped by underscores are no longer emphasized. This + feature was deprecated as it is redundant (use single quotes + instead) and was being applied to file names with underscores. +- A `-q` quiet option has been added to suppress warning messages. +- Badge images sourced locally. +- Added 'author' and 'author-mail' meta tags to HTML configuration + files. + +Version 1.5 (2003-01-08) +------------------------ +- Implemented sidebar document elements. +- Explicit checks for user specified configuration files and input + file (rather than throwing exception). + +Version 1.4 (2003-01-04) +------------------------ +- New configuration file options 'emphasizedwords' and 'strongwords'. + These allow the definition of words that will always be emphasized + or rendered in a strong font without inline formatting. +- Document and section titles are no long subject to inline + formatting. +- Multiple configuration files can be overlaid in a single command. +- Configuration file tags and options entries can now be overridden on + an entry by entry basis (previously the entire section was + overloaded). +- Configuration file tags and options entries are now cached this has + resulted in around 37% performance improvement over version 1.3. +- Variable lists can now contain multiple terms per list item. +- Placeholder paragraph eliminated from empty sections that contain + subsections. +- Added \{asciidoc_version} substitution variable. +- More documentation additions and tidy ups. + +Version 1.3 (2003-01-01) +------------------------ +- A new 'strong' text formatting convention has been implemented: + Word phrases enclosed in pairs of single quote characters (acute + accents) are rendered in a strong font (usually bold). +- Paragraphs can now be followed immediately by Simple lists and + Ordered lists without an intervening blank line. +- A user specified configuration file (`asciidoc(1)` -f option) + overlays the default configuration file rather than replacing it. + Custom configuration files need only contain those sections + that have been customized. +- Comment Block delimiters have been relaxed slightly. They must start + with three forward slashes /// but the remainder can contain any + characters, this allows comments to be embedded in the delimiter line. +- Leading non-digit characters preceding revision number are now + ignored. +- Set default indentsize [option] from 2 to documented default value + of zero in HTML backend html-article.conf and html-manpage.conf + files. +- Fixed error that occurred when taking input from stdin without + explicitly specifying a document type. +- Restored file name and line number error message information. +- Changed deprecated -t option to -d in asciidoc --help and usage + command output. +- CSS styles tweaking. +- Code, configuration file and documentation tidy ups. + +Version 1.2 (2002-12-28) +------------------------ +- Implemented 'include' URL to allow file inclusion. +- `fileextension` configuration file [option] renamed to more sensible + `outfilesuffix` (`fileextension` still accepted by this version but + will be dropped in future). +- Improved error reporting. +- CSS backends generate valid XHTML. +- New `css-embedded` backend generates HTML with embedded stylesheets + (use the `css` backend for linked stylesheets). The css-embedded + backend output contains no linked images so the generated html files + are completely self contained. +- Bug fixes. + +Version 1.1 (2002-12-03) +------------------------ +- Added css (cascading style sheets) backend +- Implemented IndentedBlock document element. +- Tabsize command-line option has been deprecated in + favor of configuration file. +- Default indent width changed to zero. +- Added \{localdate} and \{localtime} substitution variables. +- Added optional [options] configuration file section with + fileextension, tabsize and indentsize options. +- Implemented \{authorinitials} substitution variable. +- Added https link type. +- Corrected [graphic] substitution from \{title} to \{caption} + in linuxdoc-article.conf configuration file. +- Fixed error that occurred when '==' title underline was + used. + +Version 1.0 (2002-11-25) +------------------------ +First AsciiDoc public release along with AsciiDoc web site +(http://www.methods.co.nz/asciidoc/) and SourceForge.net project registration +(https://sourceforge.net/projects/asciidoc/[]). + +// vim: set syntax=asciidoc: @@ -1,339 +1,339 @@ - GNU GENERAL PUBLIC LICENSE
- Version 2, June 1991
-
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
- 675 Mass Ave, Cambridge, MA 02139, USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
- Preamble
-
- The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-License is intended to guarantee your freedom to share and change free
-software--to make sure the software is free for all its users. This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it. (Some other Free Software Foundation software is covered by
-the GNU Library General Public License instead.) You can apply it to
-your programs, too.
-
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
-
- To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
-
- For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
-you have. You must make sure that they, too, receive or can get the
-source code. And you must show them these terms so they know their
-rights.
-
- We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
-
- Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software. If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
-
- Finally, any free program is threatened constantly by software
-patents. We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary. To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at all.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
- GNU GENERAL PUBLIC LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
- 0. This License applies to any program or other work which contains
-a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License. The "Program", below,
-refers to any such program or work, and a "work based on the Program"
-means either the Program or any derivative work under copyright law:
-that is to say, a work containing the Program or a portion of it,
-either verbatim or with modifications and/or translated into another
-language. (Hereinafter, translation is included without limitation in
-the term "modification".) Each licensee is addressed as "you".
-
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
-
- 1. You may copy and distribute verbatim copies of the Program's
-source code as you receive it, in any medium, provided that you
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a fee.
-
- 2. You may modify your copy or copies of the Program or any portion
-of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
- a) You must cause the modified files to carry prominent notices
- stating that you changed the files and the date of any change.
-
- b) You must cause any work that you distribute or publish, that in
- whole or in part contains or is derived from the Program or any
- part thereof, to be licensed as a whole at no charge to all third
- parties under the terms of this License.
-
- c) If the modified program normally reads commands interactively
- when run, you must cause it, when started running for such
- interactive use in the most ordinary way, to print or display an
- announcement including an appropriate copyright notice and a
- notice that there is no warranty (or else, saying that you provide
- a warranty) and that users may redistribute the program under
- these conditions, and telling the user how to view a copy of this
- License. (Exception: if the Program itself is interactive but
- does not normally print such an announcement, your work based on
- the Program is not required to print an announcement.)
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
-
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
- 3. You may copy and distribute the Program (or a work based on it,
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
-
- a) Accompany it with the complete corresponding machine-readable
- source code, which must be distributed under the terms of Sections
- 1 and 2 above on a medium customarily used for software interchange; or,
-
- b) Accompany it with a written offer, valid for at least three
- years, to give any third party, for a charge no more than your
- cost of physically performing source distribution, a complete
- machine-readable copy of the corresponding source code, to be
- distributed under the terms of Sections 1 and 2 above on a medium
- customarily used for software interchange; or,
-
- c) Accompany it with the information you received as to the offer
- to distribute corresponding source code. (This alternative is
- allowed only for noncommercial distribution and only if you
- received the program in object code or executable form with such
- an offer, in accord with Subsection b above.)
-
-The source code for a work means the preferred form of the work for
-making modifications to it. For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable. However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-If distribution of executable or object code is made by offering
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
- 4. You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License. Any attempt
-otherwise to copy, modify, sublicense or distribute the Program is
-void, and will automatically terminate your rights under this License.
-However, parties who have received copies, or rights, from you under
-this License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
- 5. You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or
-distribute the Program or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
-
- 6. Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions. You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
-this License.
-
- 7. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Program at all. For example, if a patent
-license would not permit royalty-free redistribution of the Program by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
-
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices. Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
- 8. If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded. In such case, this License incorporates
-the limitation as if written in the body of this License.
-
- 9. The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Program
-specifies a version number of this License which applies to it and "any
-later version", you have the option of following the terms and conditions
-either of that version or of any later version published by the Free
-Software Foundation. If the Program does not specify a version number of
-this License, you may choose any version ever published by the Free Software
-Foundation.
-
- 10. If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author
-to ask for permission. For software which is copyrighted by the Free
-Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this. Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
-
- NO WARRANTY
-
- 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
-
- 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
-
- END OF TERMS AND CONDITIONS
-
- Appendix: How to Apply These Terms to Your New Programs
-
- If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
- <one line to give the program's name and a brief idea of what it does.>
- Copyright (C) 19yy <name of author>
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
-
- Gnomovision version 69, Copyright (C) 19yy name of author
- Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
- This is free software, and you are welcome to redistribute it
- under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License. Of course, the commands you use may
-be called something other than `show w' and `show c'; they could even be
-mouse-clicks or menu items--whatever suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary. Here is a sample; alter the names:
-
- Yoyodyne, Inc., hereby disclaims all copyright interest in the program
- `Gnomovision' (which makes passes at compilers) written by James Hacker.
-
- <signature of Ty Coon>, 1 April 1989
- Ty Coon, President of Vice
-
-This General Public License does not permit incorporating your program into
-proprietary programs. If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library. If this is what you want to do, use the GNU Library General
-Public License instead of this License.
+ GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 675 Mass Ave, Cambridge, MA 02139, USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) 19yy <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19yy name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. @@ -1,18 +1,18 @@ -Copyright (C) 2000-2007 Stuart Rackham
-
-Email: srackham@gmail.com
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or (at
-your option) any later version.
-
-This program is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-USA.
+Copyright (C) 2000-2007 Stuart Rackham + +Email: srackham@gmail.com + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or (at +your option) any later version. + +This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, +USA. @@ -1,35 +1,35 @@ -AsciiDoc README File
-====================
-
-Prerequisites
--------------
-AsciiDoc is written in Python so you need a Python interpreter
-(version 2.4 or later) to execute asciidoc(1). Python is installed by
-default in most Linux distributions. You can download Python from the
-official Python website http://www.python.org.
-
-
-Obtaining AsciiDoc
-------------------
-Documentation and installation instructions are on the AsciiDoc
-website http://www.methods.co.nz/asciidoc/
-
-
-Tools
------
-Current AsciiDoc version tested on Xubuntu Linux 10.04 with:
-
-- Python 2.6.5
-- DocBook XSL Stylesheets 1.75.2
-- xsltproc (libxml 20706, libxslt 10126 and libexslt 815).
-- w3m 0.5.2
-- dblatex 0.3
-- FOP 0.95
-- A-A-P 1.091
-
-
-COPYING
--------
-Copyright (C) 2002-2010 Stuart Rackham. Free use of this software
-is granted under the terms of the GNU General Public License (GPL).
-
+AsciiDoc README File +==================== + +Prerequisites +------------- +AsciiDoc is written in Python so you need a Python interpreter +(version 2.4 or later) to execute asciidoc(1). Python is installed by +default in most Linux distributions. You can download Python from the +official Python website http://www.python.org. + + +Obtaining AsciiDoc +------------------ +Documentation and installation instructions are on the AsciiDoc +website http://www.methods.co.nz/asciidoc/ + + +Tools +----- +Current AsciiDoc version tested on Xubuntu Linux 10.04 with: + +- Python 2.6.5 +- DocBook XSL Stylesheets 1.75.2 +- xsltproc (libxml 20706, libxslt 10126 and libexslt 815). +- w3m 0.5.2 +- dblatex 0.3 +- FOP 0.95 +- A-A-P 1.091 + + +COPYING +------- +Copyright (C) 2002-2010 Stuart Rackham. Free use of this software +is granted under the terms of the GNU General Public License (GPL). + diff --git a/asciidoc.conf b/asciidoc.conf index 6c299e2..3521644 100644 --- a/asciidoc.conf +++ b/asciidoc.conf @@ -1,610 +1,610 @@ -#
-# asciidoc.conf
-#
-# Asciidoc global configuration file.
-# Contains backend independent configuration settings that are applied to all
-# AsciiDoc documents.
-#
-
-[miscellaneous]
-tabsize=8
-textwidth=70
-newline=\r\n
-
-[attributes]
-backend-alias-html=xhtml11
-backend-alias-docbook=docbook45
-toclevels=2
-sectids=
-iconsdir=./images/icons
-encoding=UTF-8
-# Uncomment to use xhtml11 quirks mode CSS.
-#quirks=
-# Uncomment to use the Pygments source highlighter instead of GNU highlighter.
-#pygments=
-# Uncomment to use deprecated quote attributes.
-#deprecated-quotes=
-empty=
-# Attribute and AttributeList element patterns.
-attributeentry-pattern=^:(?P<attrname>\w[^.]*?)(\.(?P<attrname2>.*?))?:(\s+(?P<attrvalue>.*))?$
-attributelist-pattern=(?u)(^\[\[(?P<id>[\w_:][\w_:.-]*)(,(?P<reftext>.*?))?\]\]$)|(^\[(?P<attrlist>.*)\]$)
-# Substitution attributes for escaping AsciiDoc processing.
-amp=&
-lt=<
-gt=>
-brvbar=|
-nbsp= 
-zwsp=​
-wj=⁠
-deg=°
-backslash=\
-two-colons=::
-two-semicolons=;;
-# DEPRECATED: underscore attribute names.
-two_colons=::
-two_semicolons=;;
-# Left and right single and double quote characters.
-# See http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks
-lsquo=‘
-rsquo=’
-ldquo=“
-rdquo=”
-
-[titles]
-subs=specialcharacters,quotes,replacements,macros,attributes,replacements2
-# Double-line title pattern and underlines.
-sectiontitle=^(?P<title>.*?)$
-underlines="==","--","~~","^^","++"
-# Single-line title patterns.
-sect0=^= +(?P<title>[\S].*?)( +=)?$
-sect1=^== +(?P<title>[\S].*?)( +==)?$
-sect2=^=== +(?P<title>[\S].*?)( +===)?$
-sect3=^==== +(?P<title>[\S].*?)( +====)?$
-sect4=^===== +(?P<title>[\S].*?)( +=====)?$
-blocktitle=^\.(?P<title>([^.\s].*)|(\.[^.\s].*))$
-
-[specialcharacters]
-&=&
-<=<
->=>
-
-[quotes]
-# The order is important, quotes are processed in conf file order.
-**=#strong
-*=strong
-``|''=doublequoted
-'=emphasis
-`|'=singlequoted
-ifdef::no-inline-literal[]
-`=monospaced
-endif::no-inline-literal[]
-# +++ and $$ quoting is applied to the +++ and $$ inline passthrough
-# macros to allow quoted attributes to be used.
-# This trick only works with inline passthrough macros.
-+++=#unquoted
-$$=#unquoted
-++=#monospaced
-+=monospaced
-__=#emphasis
-_=emphasis
-\##=#unquoted
-\#=unquoted
-^=#superscript
-~=#subscript
-
-[specialwords]
-emphasizedwords=
-strongwords=
-monospacedwords=
-
-[replacements]
-# Replacements performed in order of configuration file entry. The first entry
-# of each replacement pair performs the (non-escaped) replacement, the second
-# strips the backslash from the escaped replacement.
-
-# (C) Copyright (entity reference ©)
-(?<!\\)\(C\)=©
-\\\(C\)=(C)
-
-# (R) registered trade mark (entity reference ®
-(?<!\\)\(R\)=®
-\\\(R\)=(R)
-
-# (TM) Trademark (entity reference ™)
-(?<!\\)\(TM\)=™
-\\\(TM\)=(TM)
-
-# -- Spaced and unspaced em dashes (entity reference —).
-# Space on both sides is translated to thin space characters.
-(^-- )=— 
-(\n-- )|( -- )|( --\n)= — 
-(\w)--(\w)=\1—\2
-\\--(?!-)=--
-
-# Replace vertical typewriter apostrophe with punctuation apostrophe.
-(\w)'(\w)=\1’\2
-(\w)\\'(\w)=\1'\2
-
-# ... Ellipsis (entity reference …)
-(?<!\\)\.\.\.=…
-\\\.\.\.=...
-
-# Arrows from the Arrows block of Unicode.
-# -> right arrow
-(?<!\\)->=→
-\\->=->
-# => right double arrow
-(?<!\\)\=>=⇒
-\\\=>==>
-# <- left arrow
-(?<!\\)<-=←
-\\<-=<-
-# <= left double arrow
-(?<!\\)<\==⇐
-\\<\==<=
-
-# Arbitrary entity references.
-(?<!\\)&([:_#a-zA-Z][:_.\-\w]*?;)=&\1
-\\(&[:_#a-zA-Z][:_.\-\w]*?;)=\1
-
-#-----------
-# Paragraphs
-#-----------
-[paradef-default]
-delimiter=(?s)(?P<text>\S.*)
-posattrs=style
-style=normal
-template::[paragraph-styles]
-
-[paradef-literal]
-delimiter=(?s)(?P<text>\s+.*)
-options=listelement
-posattrs=style
-style=literal
-template::[paragraph-styles]
-
-[paradef-admonition]
-delimiter=(?s)^\s*(?P<style>NOTE|TIP|IMPORTANT|WARNING|CAUTION):\s+(?P<text>.+)
-template::[paragraph-styles]
-
-[paragraph-styles]
-normal-style=template="paragraph"
-verse-style=template="verseparagraph",posattrs=["style","attribution","citetitle"]
-quote-style=template="quoteparagraph",posattrs=["style","attribution","citetitle"]
-literal-style=template="literalparagraph",subs=["verbatim"]
-listing-style=template="listingparagraph",subs=["verbatim"]
-NOTE-style=template="admonitionparagraph",name="note",caption="{note-caption}"
-TIP-style=template="admonitionparagraph",name="tip",caption="{tip-caption}"
-IMPORTANT-style=template="admonitionparagraph",name="important",caption="{important-caption}"
-WARNING-style=template="admonitionparagraph",name="warning",caption="{warning-caption}"
-CAUTION-style=template="admonitionparagraph",name="caution",caption="{caution-caption}"
-
-[literalparagraph]
-template::[literalblock]
-
-[verseparagraph]
-template::[verseblock]
-
-[quoteparagraph]
-template::[quoteblock]
-
-[listingparagraph]
-template::[listingblock]
-
-[macros]
-#--------------
-# Inline macros
-#--------------
-# Backslash prefix required for escape processing.
-# (?s) re flag for line spanning.
-
-# Macros using default syntax.
-(?su)(?<!\w)[\\]?(?P<name>http|https|ftp|file|irc|mailto|callto|image|link|anchor|xref|indexterm):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
-
-# These URL types don't require any special attribute list formatting.
-(?su)(?<!\S)[\\]?(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])=
-# Allow a leading parenthesis and square bracket.
-(?su)(?<\=[([])[\\]?(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])=
-# Allow <> brackets.
-(?su)[\\]?<(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])>=
-
-# Email addresses don't require special attribute list formatting.
-# The before ">: and after "< character exclusions stop multiple substitution.
-(?su)(?<![">:\w._/-])[\\]?(?P<target>\w[\w._-]*@[\w._-]*\w)(?!["<\w_-])=mailto
-
-# Allow footnote macros hard up against the preceding word so the footnote mark
-# can be placed against the noted text without an intervening space
-# (http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5).
-(?su)[\\]?(?P<name>footnote|footnoteref):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
-
-# Anchor: [[[id]]]. Bibliographic anchor.
-(?su)[\\]?\[\[\[(?P<attrlist>[\w_:][\w_:.-]*?)\]\]\]=anchor3
-# Anchor: [[id,xreflabel]]
-(?su)[\\]?\[\[(?P<attrlist>[\w"_:].*?)\]\]=anchor2
-# Link: <<id,text>>
-(?su)[\\]?<<(?P<attrlist>[\w"_:].*?)>>=xref2
-
-ifdef::asciidoc7compatible[]
-# Index term: ++primary,secondary,tertiary++
-(?su)(?<!\S)[\\]?\+\+(?P<attrlist>[^+].*?)\+\+(?!\+)=indexterm
-# Index term: +primary+
-# Follows ++...++ macro otherwise it will match them.
-(?<!\S)[\\]?\+(?P<attrlist>[^\s\+][^+].*?)\+(?!\+)=indexterm2
-endif::asciidoc7compatible[]
-
-ifndef::asciidoc7compatible[]
-# Index term: (((primary,secondary,tertiary)))
-(?su)(?<!\()[\\]?\(\(\((?P<attrlist>[^(].*?)\)\)\)(?!\))=indexterm
-# Index term: ((primary))
-# Follows (((...))) macro otherwise it will match them.
-(?<!\()[\\]?\(\((?P<attrlist>[^\s\(][^(].*?)\)\)(?!\))=indexterm2
-endif::asciidoc7compatible[]
-
-# Callout
-[\\]?<(?P<index>\d+)>=callout
-
-# Passthrough macros.
-(?su)[\\]?(?P<name>pass):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[]
-
-# Triple-plus and double-dollar inline passthroughs.
-(?su)[\\]?\+\+\+(?P<passtext>.*?)\+\+\+=pass[]
-(?su)[\\]?\$\$(?P<passtext>.*?)\$\$=pass[specialcharacters]
-
-# Inline literal.
-ifndef::no-inline-literal[]
-(?su)(?<![`\w])([\\]?`(?P<passtext>[^`\s]|[^`\s].*?\S)`)(?![`\w])=literal[specialcharacters]
-endif::no-inline-literal[]
-
-# Inline comment.
-(?mu)^[\\]?//(?P<passtext>[^/].*|)$=comment[specialcharacters]
-
-# Default (catchall) inline macro is not implemented so there is no ambiguity
-# with previous definition that could result in double substitution of escaped
-# references.
-#(?su)[\\]?(?P<name>\w(\w|-)*?):(?P<target>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=
-
-#-------------
-# Block macros
-#-------------
-# Macros using default syntax.
-(?u)^(?P<name>image|unfloat)::(?P<target>\S*?)(\[(?P<attrlist>.*?)\])$=#
-
-# Passthrough macros.
-(?u)^(?P<name>pass)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=#
-
-^'{3,}$=#ruler
-^<{3,}$=#pagebreak
-^//(?P<passtext>[^/].*|)$=#comment[specialcharacters]
-
-[unfloat-blockmacro]
-# Implemented in HTML backends.
-
-#-----------------
-# Delimited blocks
-#-----------------
-[blockdef-comment]
-delimiter=^/{4,}$
-options=skip
-
-[blockdef-sidebar]
-delimiter=^\*{4,}$
-template=sidebarblock
-options=sectionbody
-posattrs=style
-# DEPRECATED: Use Openblock instead.
-abstract-style=template="abstractblock"
-
-[blockdef-open]
-# A block without opening or closing tags.
-delimiter=^--$
-template=openblock
-options=sectionbody
-posattrs=style
-abstract-style=template="abstractblock"
-partintro-style=template="partintroblock"
-
-[blockdef-pass]
-delimiter=^\+{4,}$
-template=passblock
-# Default subs choosen for backward compatibility.
-subs=attributes,macros
-posattrs=style
-pass-style=template="passblock",subs=[]
-
-[blockdef-listing]
-delimiter=^-{4,}$
-template=listingblock
-subs=verbatim
-posattrs=style
-
-[blockdef-literal]
-delimiter=^\.{4,}$
-template=literalblock
-subs=verbatim
-posattrs=style
-listing-style=template="listingblock"
-# DEPRECATED: Use verse style on quote blocks instead.
-verse-style=template="verseblock",subs="normal"
-
-[blockdef-quote]
-delimiter=^_{4,}$
-subs=normal
-style=quote
-posattrs=style,attribution,citetitle
-quote-style=template="quoteblock",options=("sectionbody",)
-verse-style=template="verseblock"
-
-[blockdef-example]
-delimiter=^={4,}$
-template=exampleblock
-options=sectionbody
-posattrs=style
-NOTE-style=template="admonitionblock",name="note",caption="{note-caption}"
-TIP-style=template="admonitionblock",name="tip",caption="{tip-caption}"
-IMPORTANT-style=template="admonitionblock",name="important",caption="{important-caption}"
-WARNING-style=template="admonitionblock",name="warning",caption="{warning-caption}"
-CAUTION-style=template="admonitionblock",name="caution",caption="{caution-caption}"
-
-# For use by custom filters.
-# DEPRECATED: No longer used, a styled listing block (blockdef-listing) is preferable.
-[blockdef-filter]
-delimiter=^~{4,}$
-template=listingblock
-subs=none
-posattrs=style
-
-#-------
-# Lists
-#-------
-[listdef-bulleted]
-# - bullets.
-delimiter=^\s*- +(?P<text>.+)$
-posattrs=style
-type=bulleted
-tags=bulleted
-callout-style=tags="callout"
-bibliography-style=tags="bibliography"
-
-[listdef-bulleted1]
-# * bullets.
-template::[listdef-bulleted]
-delimiter=^\s*\* +(?P<text>.+)$
-
-[listdef-bulleted2]
-# ** bullets.
-template::[listdef-bulleted]
-delimiter=^\s*\*{2} +(?P<text>.+)$
-
-[listdef-bulleted3]
-# *** bullets.
-template::[listdef-bulleted]
-delimiter=^\s*\*{3} +(?P<text>.+)$
-
-[listdef-bulleted4]
-# **** bullets.
-template::[listdef-bulleted]
-delimiter=^\s*\*{4} +(?P<text>.+)$
-
-[listdef-bulleted5]
-# ***** bullets.
-template::[listdef-bulleted]
-delimiter=^\s*\*{5} +(?P<text>.+)$
-
-[listdef-arabic]
-# Arabic numbering.
-delimiter=^\s*(?P<index>\d+\.) +(?P<text>.+)$
-posattrs=style
-type=numbered
-tags=numbered
-style=arabic
-
-[listdef-loweralpha]
-# Lower alpha numbering.
-template::[listdef-arabic]
-delimiter=^\s*(?P<index>[a-z]\.) +(?P<text>.+)$
-style=loweralpha
-
-[listdef-upperalpha]
-# Upper alpha numbering.
-template::[listdef-arabic]
-delimiter=^\s*(?P<index>[A-Z]\.) +(?P<text>.+)$
-style=upperalpha
-
-[listdef-lowerroman]
-# Lower roman numbering.
-template::[listdef-arabic]
-delimiter=^\s*(?P<index>[ivx]+\)) +(?P<text>.+)$
-style=lowerroman
-
-[listdef-upperroman]
-# Upper roman numbering.
-template::[listdef-arabic]
-delimiter=^\s*(?P<index>[IVX]+\)) +(?P<text>.+)$
-style=upperroman
-
-[listdef-numbered1]
-# . numbering.
-template::[listdef-arabic]
-delimiter=^\s*\. +(?P<text>.+)$
-
-[listdef-numbered2]
-# .. numbering.
-template::[listdef-loweralpha]
-delimiter=^\s*\.{2} +(?P<text>.+)$
-
-[listdef-numbered3]
-# ... numbering.
-template::[listdef-lowerroman]
-delimiter=^\s*\.{3} +(?P<text>.+)$
-
-[listdef-numbered4]
-# .... numbering.
-template::[listdef-upperalpha]
-delimiter=^\s*\.{4} +(?P<text>.+)$
-
-[listdef-numbered5]
-# ..... numbering.
-template::[listdef-upperroman]
-delimiter=^\s*\.{5} +(?P<text>.+)$
-
-[listdef-labeled]
-# label:: item.
-delimiter=^\s*(?P<label>.*[^:])::(\s+(?P<text>.+))?$
-posattrs=style
-type=labeled
-tags=labeled
-vertical-style=tags="labeled"
-horizontal-style=tags="horizontal"
-glossary-style=tags="glossary"
-qanda-style=tags="qanda"
-
-[listdef-labeled2]
-# label;; item.
-template::[listdef-labeled]
-delimiter=^\s*(?P<label>.*[^;]);;(\s+(?P<text>.+))?$
-
-[listdef-labeled3]
-# label::: item.
-template::[listdef-labeled]
-delimiter=^\s*(?P<label>.*[^:]):{3}(\s+(?P<text>.+))?$
-
-[listdef-labeled4]
-# label:::: item.
-template::[listdef-labeled]
-delimiter=^\s*(?P<label>.*[^:]):{4}(\s+(?P<text>.+))?$
-
-[listdef-callout]
-posattrs=style
-delimiter=^<?(?P<index>\d*>) +(?P<text>.+)$
-type=callout
-tags=callout
-style=arabic
-
-# DEPRECATED: Old list syntax.
-[listdef-qanda]
-posattrs=style
-delimiter=^\s*(?P<label>.*\S)\?\?$
-type=labeled
-tags=qanda
-
-# DEPRECATED: Old list syntax.
-[listdef-bibliography]
-posattrs=style
-delimiter=^\+ +(?P<text>.+)$
-type=bulleted
-tags=bibliography
-
-# DEPRECATED: Old list syntax.
-[listdef-glossary]
-delimiter=^(?P<label>.*\S):-$
-posattrs=style
-type=labeled
-tags=glossary
-
-#-------
-# Tables
-#-------
-[tabledef-default]
-delimiter=^\|={3,}$
-posattrs=style
-template=table
-default-style=tags="default"
-verse-style=tags="verse"
-literal-style=tags="literal",subs=["specialcharacters"]
-emphasis-style=tags="emphasis"
-strong-style=tags="strong"
-monospaced-style=tags="monospaced"
-header-style=tags="header"
-asciidoc-style=tags="asciidoc",subs=[],filter='python "{asciidoc-file}" -b {backend}{icons? -a icons -a "iconsdir={iconsdir}"}{imagesdir? -a "imagesdir={imagesdir}"}{data-uri? -a data-uri} -a "indir={indir}"{trace? -a "trace={trace}"} -s -'
-
-[tabledef-nested]
-# Same as [tabledef-default] but with different delimiter and separator.
-delimiter=^!={3,}$
-separator=((?<!\S)((?P<span>[\d.]+)(?P<op>[*+]))?(?P<align>[<\^>.]{,3})?(?P<style>[a-z])?)?!
-posattrs=style
-template=table
-verse-style=tags="verse"
-literal-style=tags="literal",subs=["specialcharacters"]
-emphasis-style=tags="emphasis"
-strong-style=tags="strong"
-monospaced-style=tags="monospaced"
-header-style=tags="header"
-asciidoc-style=tags="asciidoc",subs=[],filter='python "{asciidoc-file}" -b {backend} -s -'
-
-#----------------------------------------
-# Common block and macro markup templates
-#----------------------------------------
-[comment-inlinemacro]
-# Outputs nothing.
-
-[comment-blockmacro]
-# Outputs nothing.
-
-[pass-blockmacro]
-{passtext}
-
-[pass-inlinemacro]
-template::[pass-blockmacro]
-
-[passblock]
-|
-
-[filter-image-blockmacro]
-# Synthesize missing target attribute for filter generated file names.
-# The tag split | ensures missing target file names are auto-generated
-# before the filter is executed, the remainder (the [image-blockmacro])
-# is excuted after the filter to ensure data URI encoding comes after
-# the image is created.
-{target%}{counter2:target-number}
-{target%}{set2:target:{docname}__{target-number}.png}
-|
-template::[image-blockmacro]
-
-#----------------------------------
-# Default special section templates
-#----------------------------------
-[abstract]
-template::[sect1]
-
-[colophon]
-template::[sect1]
-
-[dedication]
-template::[sect1]
-
-[preface]
-template::[sect1]
-
-[appendix]
-template::[sect1]
-
-[glossary]
-template::[sect1]
-
-[bibliography]
-template::[sect1]
-
-[index]
-template::[sect1]
-
-[synopsis]
-template::[sect1]
-
-#--------------------------------------------------------------------
-# Deprecated old table definitions.
-#
-
-[old_tabledef-default]
-fillchar=-
-format=fixed
-
-[old_tabledef-csv]
-fillchar=~
-format=csv
-
-[old_tabledef-dsv]
-fillchar=_
-format=dsv
-
-# End of deprecated old table definitions.
-#--------------------------------------------------------------------
+# +# asciidoc.conf +# +# Asciidoc global configuration file. +# Contains backend independent configuration settings that are applied to all +# AsciiDoc documents. +# + +[miscellaneous] +tabsize=8 +textwidth=70 +newline=\r\n + +[attributes] +backend-alias-html=xhtml11 +backend-alias-docbook=docbook45 +toclevels=2 +sectids= +iconsdir=./images/icons +encoding=UTF-8 +# Uncomment to use xhtml11 quirks mode CSS. +#quirks= +# Uncomment to use the Pygments source highlighter instead of GNU highlighter. +#pygments= +# Uncomment to use deprecated quote attributes. +#deprecated-quotes= +empty= +# Attribute and AttributeList element patterns. +attributeentry-pattern=^:(?P<attrname>\w[^.]*?)(\.(?P<attrname2>.*?))?:(\s+(?P<attrvalue>.*))?$ +attributelist-pattern=(?u)(^\[\[(?P<id>[\w_:][\w_:.-]*)(,(?P<reftext>.*?))?\]\]$)|(^\[(?P<attrlist>.*)\]$) +# Substitution attributes for escaping AsciiDoc processing. +amp=& +lt=< +gt=> +brvbar=| +nbsp=  +zwsp=​ +wj=⁠ +deg=° +backslash=\ +two-colons=:: +two-semicolons=;; +# DEPRECATED: underscore attribute names. +two_colons=:: +two_semicolons=;; +# Left and right single and double quote characters. +# See http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks +lsquo=‘ +rsquo=’ +ldquo=“ +rdquo=” + +[titles] +subs=specialcharacters,quotes,replacements,macros,attributes,replacements2 +# Double-line title pattern and underlines. +sectiontitle=^(?P<title>.*?)$ +underlines="==","--","~~","^^","++" +# Single-line title patterns. +sect0=^= +(?P<title>[\S].*?)( +=)?$ +sect1=^== +(?P<title>[\S].*?)( +==)?$ +sect2=^=== +(?P<title>[\S].*?)( +===)?$ +sect3=^==== +(?P<title>[\S].*?)( +====)?$ +sect4=^===== +(?P<title>[\S].*?)( +=====)?$ +blocktitle=^\.(?P<title>([^.\s].*)|(\.[^.\s].*))$ + +[specialcharacters] +&=& +<=< +>=> + +[quotes] +# The order is important, quotes are processed in conf file order. +**=#strong +*=strong +``|''=doublequoted +'=emphasis +`|'=singlequoted +ifdef::no-inline-literal[] +`=monospaced +endif::no-inline-literal[] +# +++ and $$ quoting is applied to the +++ and $$ inline passthrough +# macros to allow quoted attributes to be used. +# This trick only works with inline passthrough macros. ++++=#unquoted +$$=#unquoted +++=#monospaced ++=monospaced +__=#emphasis +_=emphasis +\##=#unquoted +\#=unquoted +^=#superscript +~=#subscript + +[specialwords] +emphasizedwords= +strongwords= +monospacedwords= + +[replacements] +# Replacements performed in order of configuration file entry. The first entry +# of each replacement pair performs the (non-escaped) replacement, the second +# strips the backslash from the escaped replacement. + +# (C) Copyright (entity reference ©) +(?<!\\)\(C\)=© +\\\(C\)=(C) + +# (R) registered trade mark (entity reference ® +(?<!\\)\(R\)=® +\\\(R\)=(R) + +# (TM) Trademark (entity reference ™) +(?<!\\)\(TM\)=™ +\\\(TM\)=(TM) + +# -- Spaced and unspaced em dashes (entity reference —). +# Space on both sides is translated to thin space characters. +(^-- )=—  +(\n-- )|( -- )|( --\n)= —  +(\w)--(\w)=\1—\2 +\\--(?!-)=-- + +# Replace vertical typewriter apostrophe with punctuation apostrophe. +(\w)'(\w)=\1’\2 +(\w)\\'(\w)=\1'\2 + +# ... Ellipsis (entity reference …) +(?<!\\)\.\.\.=… +\\\.\.\.=... + +# Arrows from the Arrows block of Unicode. +# -> right arrow +(?<!\\)->=→ +\\->=-> +# => right double arrow +(?<!\\)\=>=⇒ +\\\=>==> +# <- left arrow +(?<!\\)<-=← +\\<-=<- +# <= left double arrow +(?<!\\)<\==⇐ +\\<\==<= + +# Arbitrary entity references. +(?<!\\)&([:_#a-zA-Z][:_.\-\w]*?;)=&\1 +\\(&[:_#a-zA-Z][:_.\-\w]*?;)=\1 + +#----------- +# Paragraphs +#----------- +[paradef-default] +delimiter=(?s)(?P<text>\S.*) +posattrs=style +style=normal +template::[paragraph-styles] + +[paradef-literal] +delimiter=(?s)(?P<text>\s+.*) +options=listelement +posattrs=style +style=literal +template::[paragraph-styles] + +[paradef-admonition] +delimiter=(?s)^\s*(?P<style>NOTE|TIP|IMPORTANT|WARNING|CAUTION):\s+(?P<text>.+) +template::[paragraph-styles] + +[paragraph-styles] +normal-style=template="paragraph" +verse-style=template="verseparagraph",posattrs=["style","attribution","citetitle"] +quote-style=template="quoteparagraph",posattrs=["style","attribution","citetitle"] +literal-style=template="literalparagraph",subs=["verbatim"] +listing-style=template="listingparagraph",subs=["verbatim"] +NOTE-style=template="admonitionparagraph",name="note",caption="{note-caption}" +TIP-style=template="admonitionparagraph",name="tip",caption="{tip-caption}" +IMPORTANT-style=template="admonitionparagraph",name="important",caption="{important-caption}" +WARNING-style=template="admonitionparagraph",name="warning",caption="{warning-caption}" +CAUTION-style=template="admonitionparagraph",name="caution",caption="{caution-caption}" + +[literalparagraph] +template::[literalblock] + +[verseparagraph] +template::[verseblock] + +[quoteparagraph] +template::[quoteblock] + +[listingparagraph] +template::[listingblock] + +[macros] +#-------------- +# Inline macros +#-------------- +# Backslash prefix required for escape processing. +# (?s) re flag for line spanning. + +# Macros using default syntax. +(?su)(?<!\w)[\\]?(?P<name>http|https|ftp|file|irc|mailto|callto|image|link|anchor|xref|indexterm):(?P<target>\S*?)\[(?P<attrlist>.*?)\]= + +# These URL types don't require any special attribute list formatting. +(?su)(?<!\S)[\\]?(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])= +# Allow a leading parenthesis and square bracket. +(?su)(?<\=[([])[\\]?(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])= +# Allow <> brackets. +(?su)[\\]?<(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])>= + +# Email addresses don't require special attribute list formatting. +# The before ">: and after "< character exclusions stop multiple substitution. +(?su)(?<![">:\w._/-])[\\]?(?P<target>\w[\w._-]*@[\w._-]*\w)(?!["<\w_-])=mailto + +# Allow footnote macros hard up against the preceding word so the footnote mark +# can be placed against the noted text without an intervening space +# (http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5). +(?su)[\\]?(?P<name>footnote|footnoteref):(?P<target>\S*?)\[(?P<attrlist>.*?)\]= + +# Anchor: [[[id]]]. Bibliographic anchor. +(?su)[\\]?\[\[\[(?P<attrlist>[\w_:][\w_:.-]*?)\]\]\]=anchor3 +# Anchor: [[id,xreflabel]] +(?su)[\\]?\[\[(?P<attrlist>[\w"_:].*?)\]\]=anchor2 +# Link: <<id,text>> +(?su)[\\]?<<(?P<attrlist>[\w"_:].*?)>>=xref2 + +ifdef::asciidoc7compatible[] +# Index term: ++primary,secondary,tertiary++ +(?su)(?<!\S)[\\]?\+\+(?P<attrlist>[^+].*?)\+\+(?!\+)=indexterm +# Index term: +primary+ +# Follows ++...++ macro otherwise it will match them. +(?<!\S)[\\]?\+(?P<attrlist>[^\s\+][^+].*?)\+(?!\+)=indexterm2 +endif::asciidoc7compatible[] + +ifndef::asciidoc7compatible[] +# Index term: (((primary,secondary,tertiary))) +(?su)(?<!\()[\\]?\(\(\((?P<attrlist>[^(].*?)\)\)\)(?!\))=indexterm +# Index term: ((primary)) +# Follows (((...))) macro otherwise it will match them. +(?<!\()[\\]?\(\((?P<attrlist>[^\s\(][^(].*?)\)\)(?!\))=indexterm2 +endif::asciidoc7compatible[] + +# Callout +[\\]?<(?P<index>\d+)>=callout + +# Passthrough macros. +(?su)[\\]?(?P<name>pass):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[] + +# Triple-plus and double-dollar inline passthroughs. +(?su)[\\]?\+\+\+(?P<passtext>.*?)\+\+\+=pass[] +(?su)[\\]?\$\$(?P<passtext>.*?)\$\$=pass[specialcharacters] + +# Inline literal. +ifndef::no-inline-literal[] +(?su)(?<![`\w])([\\]?`(?P<passtext>[^`\s]|[^`\s].*?\S)`)(?![`\w])=literal[specialcharacters] +endif::no-inline-literal[] + +# Inline comment. +(?mu)^[\\]?//(?P<passtext>[^/].*|)$=comment[specialcharacters] + +# Default (catchall) inline macro is not implemented so there is no ambiguity +# with previous definition that could result in double substitution of escaped +# references. +#(?su)[\\]?(?P<name>\w(\w|-)*?):(?P<target>\S*?)\[(?P<passtext>.*?)(?<!\\)\]= + +#------------- +# Block macros +#------------- +# Macros using default syntax. +(?u)^(?P<name>image|unfloat)::(?P<target>\S*?)(\[(?P<attrlist>.*?)\])$=# + +# Passthrough macros. +(?u)^(?P<name>pass)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=# + +^'{3,}$=#ruler +^<{3,}$=#pagebreak +^//(?P<passtext>[^/].*|)$=#comment[specialcharacters] + +[unfloat-blockmacro] +# Implemented in HTML backends. + +#----------------- +# Delimited blocks +#----------------- +[blockdef-comment] +delimiter=^/{4,}$ +options=skip + +[blockdef-sidebar] +delimiter=^\*{4,}$ +template=sidebarblock +options=sectionbody +posattrs=style +# DEPRECATED: Use Openblock instead. +abstract-style=template="abstractblock" + +[blockdef-open] +# A block without opening or closing tags. +delimiter=^--$ +template=openblock +options=sectionbody +posattrs=style +abstract-style=template="abstractblock" +partintro-style=template="partintroblock" + +[blockdef-pass] +delimiter=^\+{4,}$ +template=passblock +# Default subs choosen for backward compatibility. +subs=attributes,macros +posattrs=style +pass-style=template="passblock",subs=[] + +[blockdef-listing] +delimiter=^-{4,}$ +template=listingblock +subs=verbatim +posattrs=style + +[blockdef-literal] +delimiter=^\.{4,}$ +template=literalblock +subs=verbatim +posattrs=style +listing-style=template="listingblock" +# DEPRECATED: Use verse style on quote blocks instead. +verse-style=template="verseblock",subs="normal" + +[blockdef-quote] +delimiter=^_{4,}$ +subs=normal +style=quote +posattrs=style,attribution,citetitle +quote-style=template="quoteblock",options=("sectionbody",) +verse-style=template="verseblock" + +[blockdef-example] +delimiter=^={4,}$ +template=exampleblock +options=sectionbody +posattrs=style +NOTE-style=template="admonitionblock",name="note",caption="{note-caption}" +TIP-style=template="admonitionblock",name="tip",caption="{tip-caption}" +IMPORTANT-style=template="admonitionblock",name="important",caption="{important-caption}" +WARNING-style=template="admonitionblock",name="warning",caption="{warning-caption}" +CAUTION-style=template="admonitionblock",name="caution",caption="{caution-caption}" + +# For use by custom filters. +# DEPRECATED: No longer used, a styled listing block (blockdef-listing) is preferable. +[blockdef-filter] +delimiter=^~{4,}$ +template=listingblock +subs=none +posattrs=style + +#------- +# Lists +#------- +[listdef-bulleted] +# - bullets. +delimiter=^\s*- +(?P<text>.+)$ +posattrs=style +type=bulleted +tags=bulleted +callout-style=tags="callout" +bibliography-style=tags="bibliography" + +[listdef-bulleted1] +# * bullets. +template::[listdef-bulleted] +delimiter=^\s*\* +(?P<text>.+)$ + +[listdef-bulleted2] +# ** bullets. +template::[listdef-bulleted] +delimiter=^\s*\*{2} +(?P<text>.+)$ + +[listdef-bulleted3] +# *** bullets. +template::[listdef-bulleted] +delimiter=^\s*\*{3} +(?P<text>.+)$ + +[listdef-bulleted4] +# **** bullets. +template::[listdef-bulleted] +delimiter=^\s*\*{4} +(?P<text>.+)$ + +[listdef-bulleted5] +# ***** bullets. +template::[listdef-bulleted] +delimiter=^\s*\*{5} +(?P<text>.+)$ + +[listdef-arabic] +# Arabic numbering. +delimiter=^\s*(?P<index>\d+\.) +(?P<text>.+)$ +posattrs=style +type=numbered +tags=numbered +style=arabic + +[listdef-loweralpha] +# Lower alpha numbering. +template::[listdef-arabic] +delimiter=^\s*(?P<index>[a-z]\.) +(?P<text>.+)$ +style=loweralpha + +[listdef-upperalpha] +# Upper alpha numbering. +template::[listdef-arabic] +delimiter=^\s*(?P<index>[A-Z]\.) +(?P<text>.+)$ +style=upperalpha + +[listdef-lowerroman] +# Lower roman numbering. +template::[listdef-arabic] +delimiter=^\s*(?P<index>[ivx]+\)) +(?P<text>.+)$ +style=lowerroman + +[listdef-upperroman] +# Upper roman numbering. +template::[listdef-arabic] +delimiter=^\s*(?P<index>[IVX]+\)) +(?P<text>.+)$ +style=upperroman + +[listdef-numbered1] +# . numbering. +template::[listdef-arabic] +delimiter=^\s*\. +(?P<text>.+)$ + +[listdef-numbered2] +# .. numbering. +template::[listdef-loweralpha] +delimiter=^\s*\.{2} +(?P<text>.+)$ + +[listdef-numbered3] +# ... numbering. +template::[listdef-lowerroman] +delimiter=^\s*\.{3} +(?P<text>.+)$ + +[listdef-numbered4] +# .... numbering. +template::[listdef-upperalpha] +delimiter=^\s*\.{4} +(?P<text>.+)$ + +[listdef-numbered5] +# ..... numbering. +template::[listdef-upperroman] +delimiter=^\s*\.{5} +(?P<text>.+)$ + +[listdef-labeled] +# label:: item. +delimiter=^\s*(?P<label>.*[^:])::(\s+(?P<text>.+))?$ +posattrs=style +type=labeled +tags=labeled +vertical-style=tags="labeled" +horizontal-style=tags="horizontal" +glossary-style=tags="glossary" +qanda-style=tags="qanda" + +[listdef-labeled2] +# label;; item. +template::[listdef-labeled] +delimiter=^\s*(?P<label>.*[^;]);;(\s+(?P<text>.+))?$ + +[listdef-labeled3] +# label::: item. +template::[listdef-labeled] +delimiter=^\s*(?P<label>.*[^:]):{3}(\s+(?P<text>.+))?$ + +[listdef-labeled4] +# label:::: item. +template::[listdef-labeled] +delimiter=^\s*(?P<label>.*[^:]):{4}(\s+(?P<text>.+))?$ + +[listdef-callout] +posattrs=style +delimiter=^<?(?P<index>\d*>) +(?P<text>.+)$ +type=callout +tags=callout +style=arabic + +# DEPRECATED: Old list syntax. +[listdef-qanda] +posattrs=style +delimiter=^\s*(?P<label>.*\S)\?\?$ +type=labeled +tags=qanda + +# DEPRECATED: Old list syntax. +[listdef-bibliography] +posattrs=style +delimiter=^\+ +(?P<text>.+)$ +type=bulleted +tags=bibliography + +# DEPRECATED: Old list syntax. +[listdef-glossary] +delimiter=^(?P<label>.*\S):-$ +posattrs=style +type=labeled +tags=glossary + +#------- +# Tables +#------- +[tabledef-default] +delimiter=^\|={3,}$ +posattrs=style +template=table +default-style=tags="default" +verse-style=tags="verse" +literal-style=tags="literal",subs=["specialcharacters"] +emphasis-style=tags="emphasis" +strong-style=tags="strong" +monospaced-style=tags="monospaced" +header-style=tags="header" +asciidoc-style=tags="asciidoc",subs=[],filter='python "{asciidoc-file}" -b {backend}{icons? -a icons -a "iconsdir={iconsdir}"}{imagesdir? -a "imagesdir={imagesdir}"}{data-uri? -a data-uri} -a "indir={indir}"{trace? -a "trace={trace}"} -s -' + +[tabledef-nested] +# Same as [tabledef-default] but with different delimiter and separator. +delimiter=^!={3,}$ +separator=((?<!\S)((?P<span>[\d.]+)(?P<op>[*+]))?(?P<align>[<\^>.]{,3})?(?P<style>[a-z])?)?! +posattrs=style +template=table +verse-style=tags="verse" +literal-style=tags="literal",subs=["specialcharacters"] +emphasis-style=tags="emphasis" +strong-style=tags="strong" +monospaced-style=tags="monospaced" +header-style=tags="header" +asciidoc-style=tags="asciidoc",subs=[],filter='python "{asciidoc-file}" -b {backend} -s -' + +#---------------------------------------- +# Common block and macro markup templates +#---------------------------------------- +[comment-inlinemacro] +# Outputs nothing. + +[comment-blockmacro] +# Outputs nothing. + +[pass-blockmacro] +{passtext} + +[pass-inlinemacro] +template::[pass-blockmacro] + +[passblock] +| + +[filter-image-blockmacro] +# Synthesize missing target attribute for filter generated file names. +# The tag split | ensures missing target file names are auto-generated +# before the filter is executed, the remainder (the [image-blockmacro]) +# is excuted after the filter to ensure data URI encoding comes after +# the image is created. +{target%}{counter2:target-number} +{target%}{set2:target:{docname}__{target-number}.png} +| +template::[image-blockmacro] + +#---------------------------------- +# Default special section templates +#---------------------------------- +[abstract] +template::[sect1] + +[colophon] +template::[sect1] + +[dedication] +template::[sect1] + +[preface] +template::[sect1] + +[appendix] +template::[sect1] + +[glossary] +template::[sect1] + +[bibliography] +template::[sect1] + +[index] +template::[sect1] + +[synopsis] +template::[sect1] + +#-------------------------------------------------------------------- +# Deprecated old table definitions. +# + +[old_tabledef-default] +fillchar=- +format=fixed + +[old_tabledef-csv] +fillchar=~ +format=csv + +[old_tabledef-dsv] +fillchar=_ +format=dsv + +# End of deprecated old table definitions. +#-------------------------------------------------------------------- diff --git a/doc/article.txt b/doc/article.txt index 04c98b1..9a9cc50 100644 --- a/doc/article.txt +++ b/doc/article.txt @@ -1,139 +1,139 @@ -The Article Title
-=================
-Author's Name <authors@email.address>
-v1.0, 2003-12
-
-
-This is the optional preamble (an untitled section body). Useful for
-writing simple sectionless documents consisting only of a preamble.
-
-NOTE: The abstract, preface, appendix, bibliography, glossary and
-index section titles are significant ('specialsections').
-
-
-:numbered!:
-[abstract]
-Example Abstract
-----------------
-The optional abstract (one or more paragraphs) goes here.
-
-This document is an AsciiDoc article skeleton containing briefly
-annotated element placeholders plus a couple of example index entries
-and footnotes.
-
-:numbered:
-
-The First Section
------------------
-Article sections start at level 1 and can be nested up to four levels
-deep.
-footnote:[An example footnote.]
-indexterm:[Example index entry]
-
-And now for something completely different: ((monkeys)), lions and
-tigers (Bengal and Siberian) using the alternative syntax index
-entries.
-(((Big cats,Lions)))
-(((Big cats,Tigers,Bengal Tiger)))
-(((Big cats,Tigers,Siberian Tiger)))
-Note that multi-entry terms generate separate index entries.
-
-Here are a couple of image examples: an image:images/smallnew.png[]
-example inline image followed by an example block image:
-
-.Tiger block image
-image::images/tiger.png[Tiger image]
-
-Followed by an example table:
-
-.An example table
-[width="60%",options="header"]
-|==============================================
-| Option | Description
-| -a 'USER GROUP' | Add 'USER' to 'GROUP'.
-| -R 'GROUP' | Disables access to 'GROUP'.
-|==============================================
-
-.An example example
-===============================================
-Lorum ipum...
-===============================================
-
-[[X1]]
-Sub-section with Anchor
-~~~~~~~~~~~~~~~~~~~~~~~
-Sub-section at level 2.
-
-A Nested Sub-section
-^^^^^^^^^^^^^^^^^^^^
-Sub-section at level 3.
-
-Yet another nested Sub-section
-++++++++++++++++++++++++++++++
-Sub-section at level 4.
-
-This is the maximum sub-section depth supported by the distributed
-AsciiDoc configuration.
-footnote:[A second example footnote.]
-
-
-The Second Section
-------------------
-Article sections are at level 1 and can contain sub-sections nested up
-to four deep.
-
-An example link to anchor at start of the <<X1,first sub-section>>.
-indexterm:[Second example index entry]
-
-An example link to a bibliography entry <<taoup>>.
-
-
-:numbered!:
-
-[appendix]
-Example Appendix
-----------------
-AsciiDoc article appendices are just just article sections with
-'specialsection' titles.
-
-Appendix Sub-section
-~~~~~~~~~~~~~~~~~~~~
-Appendix sub-section at level 2.
-
-
-[bibliography]
-Example Bibliography
---------------------
-The bibliography list is a style of AsciiDoc bulleted list.
-
-[bibliography]
-- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix
- Programming'. Addison-Wesley. ISBN 0-13-142901-9.
-- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner.
- 'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999.
- ISBN 1-56592-580-7.
-
-
-[glossary]
-Example Glossary
-----------------
-Glossaries are optional. Glossaries entries are an example of a style
-of AsciiDoc labeled lists.
-
-[glossary]
-A glossary term::
- The corresponding (indented) definition.
-
-A second glossary term::
- The corresponding (indented) definition.
-
-
-ifdef::backend-docbook[]
-[index]
-Example Index
--------------
-////////////////////////////////////////////////////////////////
-The index is normally left completely empty, it's contents being
-generated automatically by the DocBook toolchain.
-////////////////////////////////////////////////////////////////
-endif::backend-docbook[]
+The Article Title +================= +Author's Name <authors@email.address> +v1.0, 2003-12 + + +This is the optional preamble (an untitled section body). Useful for +writing simple sectionless documents consisting only of a preamble. + +NOTE: The abstract, preface, appendix, bibliography, glossary and +index section titles are significant ('specialsections'). + + +:numbered!: +[abstract] +Example Abstract +---------------- +The optional abstract (one or more paragraphs) goes here. + +This document is an AsciiDoc article skeleton containing briefly +annotated element placeholders plus a couple of example index entries +and footnotes. + +:numbered: + +The First Section +----------------- +Article sections start at level 1 and can be nested up to four levels +deep. +footnote:[An example footnote.] +indexterm:[Example index entry] + +And now for something completely different: ((monkeys)), lions and +tigers (Bengal and Siberian) using the alternative syntax index +entries. +(((Big cats,Lions))) +(((Big cats,Tigers,Bengal Tiger))) +(((Big cats,Tigers,Siberian Tiger))) +Note that multi-entry terms generate separate index entries. + +Here are a couple of image examples: an image:images/smallnew.png[] +example inline image followed by an example block image: + +.Tiger block image +image::images/tiger.png[Tiger image] + +Followed by an example table: + +.An example table +[width="60%",options="header"] +|============================================== +| Option | Description +| -a 'USER GROUP' | Add 'USER' to 'GROUP'. +| -R 'GROUP' | Disables access to 'GROUP'. +|============================================== + +.An example example +=============================================== +Lorum ipum... +=============================================== + +[[X1]] +Sub-section with Anchor +~~~~~~~~~~~~~~~~~~~~~~~ +Sub-section at level 2. + +A Nested Sub-section +^^^^^^^^^^^^^^^^^^^^ +Sub-section at level 3. + +Yet another nested Sub-section +++++++++++++++++++++++++++++++ +Sub-section at level 4. + +This is the maximum sub-section depth supported by the distributed +AsciiDoc configuration. +footnote:[A second example footnote.] + + +The Second Section +------------------ +Article sections are at level 1 and can contain sub-sections nested up +to four deep. + +An example link to anchor at start of the <<X1,first sub-section>>. +indexterm:[Second example index entry] + +An example link to a bibliography entry <<taoup>>. + + +:numbered!: + +[appendix] +Example Appendix +---------------- +AsciiDoc article appendices are just just article sections with +'specialsection' titles. + +Appendix Sub-section +~~~~~~~~~~~~~~~~~~~~ +Appendix sub-section at level 2. + + +[bibliography] +Example Bibliography +-------------------- +The bibliography list is a style of AsciiDoc bulleted list. + +[bibliography] +- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix + Programming'. Addison-Wesley. ISBN 0-13-142901-9. +- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner. + 'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999. + ISBN 1-56592-580-7. + + +[glossary] +Example Glossary +---------------- +Glossaries are optional. Glossaries entries are an example of a style +of AsciiDoc labeled lists. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +ifdef::backend-docbook[] +[index] +Example Index +------------- +//////////////////////////////////////////////////////////////// +The index is normally left completely empty, it's contents being +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// +endif::backend-docbook[] diff --git a/doc/asciidoc.1.txt b/doc/asciidoc.1.txt index 43ffaf6..652a756 100644 --- a/doc/asciidoc.1.txt +++ b/doc/asciidoc.1.txt @@ -1,171 +1,171 @@ -ASCIIDOC(1)
-===========
-:doctype: manpage
-
-
-NAME
-----
-asciidoc - converts an AsciiDoc text file to HTML or DocBook
-
-
-SYNOPSIS
---------
-*asciidoc* ['OPTIONS'] 'FILE'
-
-
-DESCRIPTION
------------
-The asciidoc(1) command translates the AsciiDoc text file 'FILE' to
-DocBook or HTML. If 'FILE' is '-' then the standard input is used.
-
-
-OPTIONS
--------
-*-a, --attribute*='ATTRIBUTE'::
- Define or delete document attribute. 'ATTRIBUTE' is formatted like
- 'NAME=VALUE'. Command-line attributes take precedence over
- document and configuration file attributes. Alternate acceptable
- forms are 'NAME' (the 'VALUE' defaults to an empty string);
- 'NAME!' (delete the 'NAME' attribute); 'NAME@' (do not override
- document or configuration file attributes). Values containing
- spaces should be enclosed in double-quote characters. This option
- may be specified more than once. A special attribute named
- 'trace' controls the output of diagnostic information.
-
-*-b, --backend*='BACKEND'::
- Backend output file format: 'docbook45', 'xhtml11', 'html4',
- 'wordpress' or 'latex' (the 'latex' backend is experimental).
- You can also the backend alias names 'html' (aliased to 'xhtml11')
- or 'docbook' (aliased to 'docbook45').
- Defaults to 'html'.
-
-*-f, --conf-file*='CONF_FILE'::
- Use configuration file 'CONF_FILE'.Configuration files processed
- in command-line order (after implicit configuration files). This
- option may be specified more than once.
-
-*--doctest*::
- Run Python doctests in 'asciidoc' module.
-
-*-d, --doctype*='DOCTYPE'::
- Document type: 'article', 'manpage' or 'book'. The 'book' document
- type is only supported by the 'docbook' backend. Default document
- type is 'article'.
-
-*-c, --dump-conf*::
- Dump configuration to stdout.
-
-*--filter*::
- Manage asciidoc(1) filters (see <<X1,*FILTER COMMANDS*>>).
-
-*-h, --help*[='TOPIC']::
- Print help TOPIC. *--help*='topics' will print a list of help
- topics, *--help*='syntax' summarizes AsciiDoc syntax,
- *--help*='manpage' prints the AsciiDoc manpage.
-
-*-e, --no-conf*::
- Exclude implicitly loaded configuration files except for those
- named like the input file ('infile.conf' and
- 'infile-backend.conf').
-
-*-s, --no-header-footer*::
- Suppress document header and footer output.
-
-*-o, --out-file*='OUT_FILE'::
- Write output to file 'OUT_FILE'. Defaults to the base name of
- input file with 'backend' extension. If the input is stdin then
- the outfile defaults to stdout. If 'OUT_FILE' is '-' then the
- standard output is used.
-
-*-n, --section-numbers*::
- Auto-number HTML article section titles. Synonym for *-a
- numbered*.
-
-*--safe*::
- Enable safe mode. Safe mode is disabled by default. AsciiDoc
- 'safe mode' skips potentially dangerous scripted sections in
- AsciiDoc source files.
-
-*-v, --verbose*::
- Verbosely print processing information and configuration file
- checks to stderr.
-
-*--version*::
- Print program version number.
-
-
-[[X1]]
-FILTER COMMANDS
----------------
-The *--filter* option is used to install, remove and list AsciiDoc
-filter plugins. Filter commands syntax:
-
- asciidoc --filter install ZIP_FILE [FILTERS_DIR]
- asciidoc --filter remove FILTER_NAME [FILTERS_DIR]
- asciidoc --filter list
-
-Where:
-
-*FILTER_NAME*::
- A unique filter name containing only alphanumeric or underscore
- characters.
-
-*ZIP_FILE*::
- A Zip file containing filter resources, the name must start with the
- filter name e.g. `my_filter-1.0.zip` packages filter `my_filter`.
-
-*FILTERS_DIR*::
- The directory containing installed filters. Each filter is contained
- in its own separate subdirectory which has the same name as the
- filter.
- *FILTERS_DIR* defaults to the `.asciidoc/filters` directory in the
- user's home directory.
-
-The filter commands perform as follows:
-
-*install*::
- Create a subdirectory in *FILTERS_DIR* with the same name as the
- filter then extract the *ZIP_FILE* into it.
-
-*remove*::
- Delete the *FILTER_NAME* filter subdirectory and all its contents from
- the *FILTERS_DIR*.
-
-*list*::
- List the names and locations of all installed filters (including
- standard filters installed in the global configuration directory).
-
-
-EXIT STATUS
------------
-*0*::
- Success
-
-*1*::
- Failure (syntax or usage error; configuration error; document
- processing failure; unexpected error).
-
-
-BUGS
-----
-See the AsciiDoc distribution BUGS file.
-
-
-AUTHOR
-------
-AsciiDoc was originally written by Stuart Rackham. Many people have
-contributed to it.
-
-
-RESOURCES
----------
-SourceForge: <http://sourceforge.net/projects/asciidoc/>
-
-Main web site: <http://www.methods.co.nz/asciidoc/>
-
-
-COPYING
--------
-Copyright \(C) 2002-2010 Stuart Rackham. Free use of this software is
-granted under the terms of the GNU General Public License (GPL).
-
+ASCIIDOC(1) +=========== +:doctype: manpage + + +NAME +---- +asciidoc - converts an AsciiDoc text file to HTML or DocBook + + +SYNOPSIS +-------- +*asciidoc* ['OPTIONS'] 'FILE' + + +DESCRIPTION +----------- +The asciidoc(1) command translates the AsciiDoc text file 'FILE' to +DocBook or HTML. If 'FILE' is '-' then the standard input is used. + + +OPTIONS +------- +*-a, --attribute*='ATTRIBUTE':: + Define or delete document attribute. 'ATTRIBUTE' is formatted like + 'NAME=VALUE'. Command-line attributes take precedence over + document and configuration file attributes. Alternate acceptable + forms are 'NAME' (the 'VALUE' defaults to an empty string); + 'NAME!' (delete the 'NAME' attribute); 'NAME@' (do not override + document or configuration file attributes). Values containing + spaces should be enclosed in double-quote characters. This option + may be specified more than once. A special attribute named + 'trace' controls the output of diagnostic information. + +*-b, --backend*='BACKEND':: + Backend output file format: 'docbook45', 'xhtml11', 'html4', + 'wordpress' or 'latex' (the 'latex' backend is experimental). + You can also the backend alias names 'html' (aliased to 'xhtml11') + or 'docbook' (aliased to 'docbook45'). + Defaults to 'html'. + +*-f, --conf-file*='CONF_FILE':: + Use configuration file 'CONF_FILE'.Configuration files processed + in command-line order (after implicit configuration files). This + option may be specified more than once. + +*--doctest*:: + Run Python doctests in 'asciidoc' module. + +*-d, --doctype*='DOCTYPE':: + Document type: 'article', 'manpage' or 'book'. The 'book' document + type is only supported by the 'docbook' backend. Default document + type is 'article'. + +*-c, --dump-conf*:: + Dump configuration to stdout. + +*--filter*:: + Manage asciidoc(1) filters (see <<X1,*FILTER COMMANDS*>>). + +*-h, --help*[='TOPIC']:: + Print help TOPIC. *--help*='topics' will print a list of help + topics, *--help*='syntax' summarizes AsciiDoc syntax, + *--help*='manpage' prints the AsciiDoc manpage. + +*-e, --no-conf*:: + Exclude implicitly loaded configuration files except for those + named like the input file ('infile.conf' and + 'infile-backend.conf'). + +*-s, --no-header-footer*:: + Suppress document header and footer output. + +*-o, --out-file*='OUT_FILE':: + Write output to file 'OUT_FILE'. Defaults to the base name of + input file with 'backend' extension. If the input is stdin then + the outfile defaults to stdout. If 'OUT_FILE' is '-' then the + standard output is used. + +*-n, --section-numbers*:: + Auto-number HTML article section titles. Synonym for *-a + numbered*. + +*--safe*:: + Enable safe mode. Safe mode is disabled by default. AsciiDoc + 'safe mode' skips potentially dangerous scripted sections in + AsciiDoc source files. + +*-v, --verbose*:: + Verbosely print processing information and configuration file + checks to stderr. + +*--version*:: + Print program version number. + + +[[X1]] +FILTER COMMANDS +--------------- +The *--filter* option is used to install, remove and list AsciiDoc +filter plugins. Filter commands syntax: + + asciidoc --filter install ZIP_FILE [FILTERS_DIR] + asciidoc --filter remove FILTER_NAME [FILTERS_DIR] + asciidoc --filter list + +Where: + +*FILTER_NAME*:: + A unique filter name containing only alphanumeric or underscore + characters. + +*ZIP_FILE*:: + A Zip file containing filter resources, the name must start with the + filter name e.g. `my_filter-1.0.zip` packages filter `my_filter`. + +*FILTERS_DIR*:: + The directory containing installed filters. Each filter is contained + in its own separate subdirectory which has the same name as the + filter. + *FILTERS_DIR* defaults to the `.asciidoc/filters` directory in the + user's home directory. + +The filter commands perform as follows: + +*install*:: + Create a subdirectory in *FILTERS_DIR* with the same name as the + filter then extract the *ZIP_FILE* into it. + +*remove*:: + Delete the *FILTER_NAME* filter subdirectory and all its contents from + the *FILTERS_DIR*. + +*list*:: + List the names and locations of all installed filters (including + standard filters installed in the global configuration directory). + + +EXIT STATUS +----------- +*0*:: + Success + +*1*:: + Failure (syntax or usage error; configuration error; document + processing failure; unexpected error). + + +BUGS +---- +See the AsciiDoc distribution BUGS file. + + +AUTHOR +------ +AsciiDoc was originally written by Stuart Rackham. Many people have +contributed to it. + + +RESOURCES +--------- +SourceForge: <http://sourceforge.net/projects/asciidoc/> + +Main web site: <http://www.methods.co.nz/asciidoc/> + + +COPYING +------- +Copyright \(C) 2002-2010 Stuart Rackham. Free use of this software is +granted under the terms of the GNU General Public License (GPL). + diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf index 5803d86..e073341 100644 --- a/doc/asciidoc.conf +++ b/doc/asciidoc.conf @@ -1,7 +1,7 @@ -#
-# Customization for AsciiDoc documentation.
-#
-[specialwords]
-ifndef::doctype-manpage[]
-monospacedwords=(?u)\\?\basciidoc\(1\) (?u)\\?\ba2x\(1\)
-endif::doctype-manpage[]
+# +# Customization for AsciiDoc documentation. +# +[specialwords] +ifndef::doctype-manpage[] +monospacedwords=(?u)\\?\basciidoc\(1\) (?u)\\?\ba2x\(1\) +endif::doctype-manpage[] diff --git a/doc/book-multi.txt b/doc/book-multi.txt index 7893883..61d5ad3 100644 --- a/doc/book-multi.txt +++ b/doc/book-multi.txt @@ -1,181 +1,181 @@ -Multi-Part Book Title Goes Here
-===============================
-Author's Name
-v1.0, 2003-12
-:doctype: book
-
-
-[dedication]
-Example Dedication
-==================
-The optional dedication goes here.
-
-This document is an AsciiDoc multi-part book skeleton containing
-briefly annotated element placeholders plus a couple of example index
-entries and footnotes. Books are normally used to generate DocBook
-markup and the preface, appendix, bibliography, glossary and index
-section titles are significant ('specialsections').
-
-NOTE: Multi-part books differ from all other AsciiDoc document formats
-in that top level sections (dedication, preface, book parts,
-appendices, bibliography, glossary, index) must be level zero headings
-(not level one).
-
-
-[preface]
-Example Preface
-================
-The optional book preface goes here at section level zero.
-
-Preface Sub-section
-~~~~~~~~~~~~~~~~~~~
-NOTE: Preface and appendix subsections start out of sequence at level
-2 (level 1 is skipped). This only applies to multi-part book
-documents.
-
-
-
-The First Part of the Book
-==========================
-
-[partintro]
-.Optional part introduction title
---
-Optional part introduction goes here.
---
-
-The First Chapter
------------------
-Chapters can be grouped by preceeding them with a level 0 Book Part
-title.
-
-Book chapters are at level 1 and can contain sub-sections nested up to
-three deep.
-footnote:[An example footnote.]
-indexterm:[Example index entry]
-
-It's also worth noting that a book part can have it's own preface,
-bibliography, glossary and index. Chapters can have their own
-bibliography, glossary and index.
-
-And now for something completely different: ((monkeys)), lions and
-tigers (Bengal and Siberian) using the alternative syntax index
-entries.
-(((Big cats,Lions)))
-(((Big cats,Tigers,Bengal Tiger)))
-(((Big cats,Tigers,Siberian Tiger)))
-Note that multi-entry terms generate separate index entries.
-
-Here are a couple of image examples: an image:images/smallnew.png[]
-example inline image followed by an example block image:
-
-.Tiger block image
-image::images/tiger.png[Tiger image]
-
-Followed by an example table:
-
-.An example table
-[width="60%",options="header"]
-|==============================================
-| Option | Description
-| -a 'USER GROUP' | Add 'USER' to 'GROUP'.
-| -R 'GROUP' | Disables access to 'GROUP'.
-|==============================================
-
-.An example example
-===============================================
-Lorum ipum...
-===============================================
-
-[[X1]]
-Sub-section with Anchor
-~~~~~~~~~~~~~~~~~~~~~~~
-Sub-section at level 2.
-
-Chapter Sub-section
-^^^^^^^^^^^^^^^^^^^
-Sub-section at level 3.
-
-Chapter Sub-section
-+++++++++++++++++++
-Sub-section at level 4.
-
-This is the maximum sub-section depth supported by the distributed
-AsciiDoc configuration.
-footnote:[A second example footnote.]
-
-
-The Second Chapter
-------------------
-An example link to anchor at start of the <<X1,first sub-section>>.
-indexterm:[Second example index entry]
-
-An example link to a bibliography entry <<taoup>>.
-
-
-
-The Second Part of the Book
-===========================
-
-The First Chapter of the Second Part
-------------------------------------
-Chapters grouped into book parts are at level 1 and can contain
-sub-sections.
-
-
-
-:numbered!:
-
-[appendix]
-Example Appendix
-================
-One or more optional appendixes go here at section level zero.
-
-Appendix Sub-section
-~~~~~~~~~~~~~~~~~~~
-NOTE: Preface and appendix subsections start out of sequence at level
-2 (level 1 is skipped). This only applies to multi-part book
-documents.
-
-
-
-[bibliography]
-Example Bibliography
-====================
-The bibliography list is a style of AsciiDoc bulleted list.
-
-[bibliography]
-- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix
- Programming'. Addison-Wesley. ISBN 0-13-142901-9.
-- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner.
- 'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999.
- ISBN 1-56592-580-7.
-
-
-[glossary]
-Example Glossary
-================
-Glossaries are optional. Glossaries entries are an example of a style
-of AsciiDoc labeled lists.
-
-[glossary]
-A glossary term::
- The corresponding (indented) definition.
-
-A second glossary term::
- The corresponding (indented) definition.
-
-
-[colophon]
-Example Colophon
-================
-Text at the end of a book describing facts about its production.
-
-
-[index]
-Example Index
-=============
-////////////////////////////////////////////////////////////////
-The index is normally left completely empty, it's contents are
-generated automatically by the DocBook toolchain.
-////////////////////////////////////////////////////////////////
+Multi-Part Book Title Goes Here +=============================== +Author's Name +v1.0, 2003-12 +:doctype: book + + +[dedication] +Example Dedication +================== +The optional dedication goes here. + +This document is an AsciiDoc multi-part book skeleton containing +briefly annotated element placeholders plus a couple of example index +entries and footnotes. Books are normally used to generate DocBook +markup and the preface, appendix, bibliography, glossary and index +section titles are significant ('specialsections'). + +NOTE: Multi-part books differ from all other AsciiDoc document formats +in that top level sections (dedication, preface, book parts, +appendices, bibliography, glossary, index) must be level zero headings +(not level one). + + +[preface] +Example Preface +================ +The optional book preface goes here at section level zero. + +Preface Sub-section +~~~~~~~~~~~~~~~~~~~ +NOTE: Preface and appendix subsections start out of sequence at level +2 (level 1 is skipped). This only applies to multi-part book +documents. + + + +The First Part of the Book +========================== + +[partintro] +.Optional part introduction title +-- +Optional part introduction goes here. +-- + +The First Chapter +----------------- +Chapters can be grouped by preceeding them with a level 0 Book Part +title. + +Book chapters are at level 1 and can contain sub-sections nested up to +three deep. +footnote:[An example footnote.] +indexterm:[Example index entry] + +It's also worth noting that a book part can have it's own preface, +bibliography, glossary and index. Chapters can have their own +bibliography, glossary and index. + +And now for something completely different: ((monkeys)), lions and +tigers (Bengal and Siberian) using the alternative syntax index +entries. +(((Big cats,Lions))) +(((Big cats,Tigers,Bengal Tiger))) +(((Big cats,Tigers,Siberian Tiger))) +Note that multi-entry terms generate separate index entries. + +Here are a couple of image examples: an image:images/smallnew.png[] +example inline image followed by an example block image: + +.Tiger block image +image::images/tiger.png[Tiger image] + +Followed by an example table: + +.An example table +[width="60%",options="header"] +|============================================== +| Option | Description +| -a 'USER GROUP' | Add 'USER' to 'GROUP'. +| -R 'GROUP' | Disables access to 'GROUP'. +|============================================== + +.An example example +=============================================== +Lorum ipum... +=============================================== + +[[X1]] +Sub-section with Anchor +~~~~~~~~~~~~~~~~~~~~~~~ +Sub-section at level 2. + +Chapter Sub-section +^^^^^^^^^^^^^^^^^^^ +Sub-section at level 3. + +Chapter Sub-section ++++++++++++++++++++ +Sub-section at level 4. + +This is the maximum sub-section depth supported by the distributed +AsciiDoc configuration. +footnote:[A second example footnote.] + + +The Second Chapter +------------------ +An example link to anchor at start of the <<X1,first sub-section>>. +indexterm:[Second example index entry] + +An example link to a bibliography entry <<taoup>>. + + + +The Second Part of the Book +=========================== + +The First Chapter of the Second Part +------------------------------------ +Chapters grouped into book parts are at level 1 and can contain +sub-sections. + + + +:numbered!: + +[appendix] +Example Appendix +================ +One or more optional appendixes go here at section level zero. + +Appendix Sub-section +~~~~~~~~~~~~~~~~~~~ +NOTE: Preface and appendix subsections start out of sequence at level +2 (level 1 is skipped). This only applies to multi-part book +documents. + + + +[bibliography] +Example Bibliography +==================== +The bibliography list is a style of AsciiDoc bulleted list. + +[bibliography] +- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix + Programming'. Addison-Wesley. ISBN 0-13-142901-9. +- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner. + 'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999. + ISBN 1-56592-580-7. + + +[glossary] +Example Glossary +================ +Glossaries are optional. Glossaries entries are an example of a style +of AsciiDoc labeled lists. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +[colophon] +Example Colophon +================ +Text at the end of a book describing facts about its production. + + +[index] +Example Index +============= +//////////////////////////////////////////////////////////////// +The index is normally left completely empty, it's contents are +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// diff --git a/doc/book.txt b/doc/book.txt index 166bfda..7579851 100644 --- a/doc/book.txt +++ b/doc/book.txt @@ -1,156 +1,156 @@ -Book Title Goes Here
-====================
-Author's Name
-v1.0, 2003-12
-:doctype: book
-
-
-[dedication]
-Example Dedication
-------------------
-Optional dedication.
-
-This document is an AsciiDoc book skeleton containing briefly
-annotated example elements plus a couple of example index entries and
-footnotes.
-
-Books are normally used to generate DocBook markup and the titles of
-the preface, appendix, bibliography, glossary and index sections are
-significant ('specialsections').
-
-
-[preface]
-Example Preface
----------------
-Optional preface.
-
-Preface Sub-section
-~~~~~~~~~~~~~~~~~~~
-Preface sub-section body.
-
-
-The First Chapter
------------------
-Chapters can contain sub-sections nested up to three deep.
-footnote:[An example footnote.]
-indexterm:[Example index entry]
-
-Chapters can have their own bibliography, glossary and index.
-
-And now for something completely different: ((monkeys)), lions and
-tigers (Bengal and Siberian) using the alternative syntax index
-entries.
-(((Big cats,Lions)))
-(((Big cats,Tigers,Bengal Tiger)))
-(((Big cats,Tigers,Siberian Tiger)))
-Note that multi-entry terms generate separate index entries.
-
-Here are a couple of image examples: an image:images/smallnew.png[]
-example inline image followed by an example block image:
-
-.Tiger block image
-image::images/tiger.png[Tiger image]
-
-Followed by an example table:
-
-.An example table
-[width="60%",options="header"]
-|==============================================
-| Option | Description
-| -a 'USER GROUP' | Add 'USER' to 'GROUP'.
-| -R 'GROUP' | Disables access to 'GROUP'.
-|==============================================
-
-.An example example
-===============================================
-Lorum ipum...
-===============================================
-
-[[X1]]
-Sub-section with Anchor
-~~~~~~~~~~~~~~~~~~~~~~~
-Sub-section at level 2.
-
-Chapter Sub-section
-^^^^^^^^^^^^^^^^^^^
-Sub-section at level 3.
-
-Chapter Sub-section
-+++++++++++++++++++
-Sub-section at level 4.
-
-This is the maximum sub-section depth supported by the distributed
-AsciiDoc configuration.
-footnote:[A second example footnote.]
-
-
-The Second Chapter
-------------------
-An example link to anchor at start of the <<X1,first sub-section>>.
-indexterm:[Second example index entry]
-
-An example link to a bibliography entry <<taoup>>.
-
-
-The Third Chapter
------------------
-Book chapters are at level 1 and can contain sub-sections.
-
-
-:numbered!:
-
-[appendix]
-Example Appendix
-----------------
-One or more optional appendixes go here at section level 1.
-
-Appendix Sub-section
-~~~~~~~~~~~~~~~~~~~
-Sub-section body.
-
-
-[bibliography]
-Example Bibliography
---------------------
-The bibliography list is a style of AsciiDoc bulleted list.
-
-[bibliography]
-.Books
-- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix
- Programming'. Addison-Wesley. ISBN 0-13-142901-9.
-- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner.
- 'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999.
- ISBN 1-56592-580-7.
-
-[bibliography]
-.Articles
-- [[[abc2003]]] Gall Anonim. 'An article', Whatever. 2003.
-
-
-[glossary]
-Example Glossary
-----------------
-Glossaries are optional. Glossaries entries are an example of a style
-of AsciiDoc labeled lists.
-
-[glossary]
-A glossary term::
- The corresponding (indented) definition.
-
-A second glossary term::
- The corresponding (indented) definition.
-
-
-[colophon]
-Example Colophon
-----------------
-Text at the end of a book describing facts about its production.
-
-
-[index]
-Example Index
--------------
-////////////////////////////////////////////////////////////////
-The index is normally left completely empty, it's contents being
-generated automatically by the DocBook toolchain.
-////////////////////////////////////////////////////////////////
+Book Title Goes Here +==================== +Author's Name +v1.0, 2003-12 +:doctype: book + + +[dedication] +Example Dedication +------------------ +Optional dedication. + +This document is an AsciiDoc book skeleton containing briefly +annotated example elements plus a couple of example index entries and +footnotes. + +Books are normally used to generate DocBook markup and the titles of +the preface, appendix, bibliography, glossary and index sections are +significant ('specialsections'). + + +[preface] +Example Preface +--------------- +Optional preface. + +Preface Sub-section +~~~~~~~~~~~~~~~~~~~ +Preface sub-section body. + + +The First Chapter +----------------- +Chapters can contain sub-sections nested up to three deep. +footnote:[An example footnote.] +indexterm:[Example index entry] + +Chapters can have their own bibliography, glossary and index. + +And now for something completely different: ((monkeys)), lions and +tigers (Bengal and Siberian) using the alternative syntax index +entries. +(((Big cats,Lions))) +(((Big cats,Tigers,Bengal Tiger))) +(((Big cats,Tigers,Siberian Tiger))) +Note that multi-entry terms generate separate index entries. + +Here are a couple of image examples: an image:images/smallnew.png[] +example inline image followed by an example block image: + +.Tiger block image +image::images/tiger.png[Tiger image] + +Followed by an example table: + +.An example table +[width="60%",options="header"] +|============================================== +| Option | Description +| -a 'USER GROUP' | Add 'USER' to 'GROUP'. +| -R 'GROUP' | Disables access to 'GROUP'. +|============================================== + +.An example example +=============================================== +Lorum ipum... +=============================================== + +[[X1]] +Sub-section with Anchor +~~~~~~~~~~~~~~~~~~~~~~~ +Sub-section at level 2. + +Chapter Sub-section +^^^^^^^^^^^^^^^^^^^ +Sub-section at level 3. + +Chapter Sub-section ++++++++++++++++++++ +Sub-section at level 4. + +This is the maximum sub-section depth supported by the distributed +AsciiDoc configuration. +footnote:[A second example footnote.] + + +The Second Chapter +------------------ +An example link to anchor at start of the <<X1,first sub-section>>. +indexterm:[Second example index entry] + +An example link to a bibliography entry <<taoup>>. + + +The Third Chapter +----------------- +Book chapters are at level 1 and can contain sub-sections. + + +:numbered!: + +[appendix] +Example Appendix +---------------- +One or more optional appendixes go here at section level 1. + +Appendix Sub-section +~~~~~~~~~~~~~~~~~~~ +Sub-section body. + + +[bibliography] +Example Bibliography +-------------------- +The bibliography list is a style of AsciiDoc bulleted list. + +[bibliography] +.Books +- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix + Programming'. Addison-Wesley. ISBN 0-13-142901-9. +- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner. + 'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999. + ISBN 1-56592-580-7. + +[bibliography] +.Articles +- [[[abc2003]]] Gall Anonim. 'An article', Whatever. 2003. + + +[glossary] +Example Glossary +---------------- +Glossaries are optional. Glossaries entries are an example of a style +of AsciiDoc labeled lists. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +[colophon] +Example Colophon +---------------- +Text at the end of a book describing facts about its production. + + +[index] +Example Index +------------- +//////////////////////////////////////////////////////////////// +The index is normally left completely empty, it's contents being +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// diff --git a/doc/customers.csv b/doc/customers.csv index 40ceffc..01f862a 100644 --- a/doc/customers.csv +++ b/doc/customers.csv @@ -1,18 +1,18 @@ -"AROUT","Around the Horn","Thomas Hardy","120 Hanover Sq.
-London","(171) 555-7788"
-"BERGS","Berglunds snabbkop","Christina Berglund","Berguvsvagen 8
-Lulea","0921-12 34 65"
-"BLAUS","Blauer See Delikatessen","Hanna Moos","Forsterstr. 57
-Mannheim","0621-08460"
-"BLONP","Blondel pere et fils","Frederique Citeaux","24, place Kleber
-Strasbourg","88.60.15.31"
-"BOLID","Bolido Comidas preparadas","Martin Sommer","C/ Araquil, 67
-Madrid","(91) 555 22 82"
-"BONAP","Bon app'","Laurence Lebihan","12, rue des Bouchers
-Marseille","91.24.45.40"
-"BOTTM","Bottom-Dollar Markets","Elizabeth Lincoln","23 Tsawassen Blvd.
-Tsawassen","(604) 555-4729"
-"BSBEV","B's Beverages","Victoria Ashworth","Fauntleroy Circus
-London","(171) 555-1212"
-"CACTU","Cactus Comidas para llevar","Patricio Simpson","Cerrito 333
-Buenos Aires","(1) 135-5555"
+"AROUT","Around the Horn","Thomas Hardy","120 Hanover Sq. +London","(171) 555-7788" +"BERGS","Berglunds snabbkop","Christina Berglund","Berguvsvagen 8 +Lulea","0921-12 34 65" +"BLAUS","Blauer See Delikatessen","Hanna Moos","Forsterstr. 57 +Mannheim","0621-08460" +"BLONP","Blondel pere et fils","Frederique Citeaux","24, place Kleber +Strasbourg","88.60.15.31" +"BOLID","Bolido Comidas preparadas","Martin Sommer","C/ Araquil, 67 +Madrid","(91) 555 22 82" +"BONAP","Bon app'","Laurence Lebihan","12, rue des Bouchers +Marseille","91.24.45.40" +"BOTTM","Bottom-Dollar Markets","Elizabeth Lincoln","23 Tsawassen Blvd. +Tsawassen","(604) 555-4729" +"BSBEV","B's Beverages","Victoria Ashworth","Fauntleroy Circus +London","(171) 555-1212" +"CACTU","Cactus Comidas para llevar","Patricio Simpson","Cerrito 333 +Buenos Aires","(1) 135-5555" diff --git a/doc/docbook-xsl.css b/doc/docbook-xsl.css index c1cd3b9..69a597e 120000..100644 --- a/doc/docbook-xsl.css +++ b/doc/docbook-xsl.css @@ -1 +1,323 @@ -../stylesheets/docbook-xsl.css
\ No newline at end of file +/* + CSS stylesheet for XHTML produced by DocBook XSL stylesheets. + Tested with XSL stylesheets 1.61.2, 1.67.2 +*/ + +span.strong { + font-weight: bold; +} + +body blockquote { + margin-top: .75em; + line-height: 1.5; + margin-bottom: .75em; +} + +html body { + margin: 1em 5% 1em 5%; + line-height: 1.2; +} + +body div { + margin: 0; +} + +h1, h2, h3, h4, h5, h6 +{ + color: #527bbd; + font-family: tahoma, verdana, sans-serif; +} + +div.toc p:first-child, +div.list-of-figures p:first-child, +div.list-of-tables p:first-child, +div.list-of-examples p:first-child, +div.example p.title, +div.sidebar p.title +{ + font-weight: bold; + color: #527bbd; + font-family: tahoma, verdana, sans-serif; + margin-bottom: 0.2em; +} + +body h1 { + margin: .0em 0 0 -4%; + line-height: 1.3; + border-bottom: 2px solid silver; +} + +body h2 { + margin: 0.5em 0 0 -4%; + line-height: 1.3; + border-bottom: 2px solid silver; +} + +body h3 { + margin: .8em 0 0 -3%; + line-height: 1.3; +} + +body h4 { + margin: .8em 0 0 -3%; + line-height: 1.3; +} + +body h5 { + margin: .8em 0 0 -2%; + line-height: 1.3; +} + +body h6 { + margin: .8em 0 0 -1%; + line-height: 1.3; +} + +body hr { + border: none; /* Broken on IE6 */ +} +div.footnotes hr { + border: 1px solid silver; +} + +div.navheader th, div.navheader td, div.navfooter td { + font-family: sans-serif; + font-size: 0.9em; + font-weight: bold; + color: #527bbd; +} +div.navheader img, div.navfooter img { + border-style: none; +} +div.navheader a, div.navfooter a { + font-weight: normal; +} +div.navfooter hr { + border: 1px solid silver; +} + +body td { + line-height: 1.2 +} + +body th { + line-height: 1.2; +} + +ol { + line-height: 1.2; +} + +ul, body dir, body menu { + line-height: 1.2; +} + +html { + margin: 0; + padding: 0; +} + +body h1, body h2, body h3, body h4, body h5, body h6 { + margin-left: 0 +} + +body pre { + margin: 0.5em 10% 0.5em 1em; + line-height: 1.0; + color: navy; +} + +tt.literal, code.literal { + color: navy; +} + +.programlisting, .screen { + border: 1px solid silver; + background: #f4f4f4; + margin: 0.5em 10% 0.5em 0; + padding: 0.5em 1em; +} + +div.sidebar { + background: #ffffee; + margin: 1.0em 10% 0.5em 0; + padding: 0.5em 1em; + border: 1px solid silver; +} +div.sidebar * { padding: 0; } +div.sidebar div { margin: 0; } +div.sidebar p.title { + margin-top: 0.5em; + margin-bottom: 0.2em; +} + +div.bibliomixed { + margin: 0.5em 5% 0.5em 1em; +} + +div.glossary dt { + font-weight: bold; +} +div.glossary dd p { + margin-top: 0.2em; +} + +dl { + margin: .8em 0; + line-height: 1.2; +} + +dt { + margin-top: 0.5em; +} + +dt span.term { + font-style: normal; + color: navy; +} + +div.variablelist dd p { + margin-top: 0; +} + +div.itemizedlist li, div.orderedlist li { + margin-left: -0.8em; + margin-top: 0.5em; +} + +ul, ol { + list-style-position: outside; +} + +div.sidebar ul, div.sidebar ol { + margin-left: 2.8em; +} + +div.itemizedlist p.title, +div.orderedlist p.title, +div.variablelist p.title +{ + margin-bottom: -0.8em; +} + +div.revhistory table { + border-collapse: collapse; + border: none; +} +div.revhistory th { + border: none; + color: #527bbd; + font-family: tahoma, verdana, sans-serif; +} +div.revhistory td { + border: 1px solid silver; +} + +/* Keep TOC and index lines close together. */ +div.toc dl, div.toc dt, +div.list-of-figures dl, div.list-of-figures dt, +div.list-of-tables dl, div.list-of-tables dt, +div.indexdiv dl, div.indexdiv dt +{ + line-height: normal; + margin-top: 0; + margin-bottom: 0; +} + +/* + Table styling does not work because of overriding attributes in + generated HTML. +*/ +div.table table, +div.informaltable table +{ + margin-left: 0; + margin-right: 5%; + margin-bottom: 0.8em; +} +div.informaltable table +{ + margin-top: 0.4em +} +div.table thead, +div.table tfoot, +div.table tbody, +div.informaltable thead, +div.informaltable tfoot, +div.informaltable tbody +{ + /* No effect in IE6. */ + border-top: 3px solid #527bbd; + border-bottom: 3px solid #527bbd; +} +div.table thead, div.table tfoot, +div.informaltable thead, div.informaltable tfoot +{ + font-weight: bold; +} + +div.mediaobject img { + margin-bottom: 0.8em; +} +div.figure p.title, +div.table p.title +{ + margin-top: 1em; + margin-bottom: 0.4em; +} + +div.calloutlist p +{ + margin-top: 0em; + margin-bottom: 0.4em; +} + +a img { + border-style: none; +} + +@media print { + div.navheader, div.navfooter { display: none; } +} + +span.aqua { color: aqua; } +span.black { color: black; } +span.blue { color: blue; } +span.fuchsia { color: fuchsia; } +span.gray { color: gray; } +span.green { color: green; } +span.lime { color: lime; } +span.maroon { color: maroon; } +span.navy { color: navy; } +span.olive { color: olive; } +span.purple { color: purple; } +span.red { color: red; } +span.silver { color: silver; } +span.teal { color: teal; } +span.white { color: white; } +span.yellow { color: yellow; } + +span.aqua-background { background: aqua; } +span.black-background { background: black; } +span.blue-background { background: blue; } +span.fuchsia-background { background: fuchsia; } +span.gray-background { background: gray; } +span.green-background { background: green; } +span.lime-background { background: lime; } +span.maroon-background { background: maroon; } +span.navy-background { background: navy; } +span.olive-background { background: olive; } +span.purple-background { background: purple; } +span.red-background { background: red; } +span.silver-background { background: silver; } +span.teal-background { background: teal; } +span.white-background { background: white; } +span.yellow-background { background: yellow; } + +span.big { font-size: 2em; } +span.small { font-size: 0.6em; } + +span.underline { text-decoration: underline; } +span.overline { text-decoration: overline; } +span.line-through { text-decoration: line-through; } +span.blink { text-decoration: blink; } diff --git a/doc/faq.txt b/doc/faq.txt index 0ef38b6..4f7595b 100644 --- a/doc/faq.txt +++ b/doc/faq.txt @@ -1,1133 +1,1133 @@ -AsciiDoc Frequently Asked Questions
-===================================
-
-
-[NOTE]
-======
-- New FAQs are normally added at the top of this document.
-- The FAQ may be updated between AsciiDoc releases so some of the
- newer FAQs may apply to the trunk and not the current release.
-======
-
-[[X5]]
-== How can I include embedded fonts in an EPUB document
-This is a two step process:
-
-1. Declare the font files and their use in your document's CSS
- stylesheet. For example:
-+
-[listing]
-.........................................
-@font-face {
- font-family : LiberationSerif-Regular;
- font-weight : normal;
- font-style: normal;
- src : url(LiberationSerif-Regular.ttf);
-}
-
-body {
- font-family: LiberationSerif-Regular, serif;
-}
-.........................................
-
-2. Declare the the font file as resource when you use `a2x(1)` to
- compile the EPUB. For example:
-
- a2x -f epub -d book --epubcheck --stylesheet epubtest.css --resource .ttf=application/x-font-ttf --resource LiberationSerif-Regular.ttf epubtest.txt
-
-[NOTE]
-======
-- Requires AsciiDoc 8.6.5 or better.
-- The True Type Font mimetype had to be declared explicitly with the
- `--resource .ttf=application/x-font-ttf` option because it wasn't
- registered on my Linux system.
-- In the above example the font file is in the same directory as the
- AsciiDoc source file and is installed to the same relative location
- in the EPUB archive OEBPS directory -- if your font file resides in
- a different location you'll need to adjust the `--resource` option
- accordingly (see the 'RESOURCES' section in the `a2x(1)` man page
- for details).
-- The URL value of the CSS 'src' property is set to the destination
- font file relative the the CSS file.
-- The `--resource` option allows you to inject any file (not just font
- files) into the EPUB output document.
-- Using the CSS '@font-face' rule is a complex subject and is outside
- the scope of the FAQ.
-- Many EPUB readers do not process embedded fonts.
-======
-
-
-== What's the difference between + quoted text and ` quoted monospaced text?
-`+` (plus) quoted text is implemented as an AsciiDoc 'quotes' whereas
-+`+ (grave accent or backtick) quoted text is implemented as an
-AsciiDoc 'inline literal' passthrough macro. The semantics are
-different:
-
-1. Inline passthrough macros are processed before any other inline
- substitutions e.g. all of the following line will be processed as a
- single inline passthrough and rendered as monospaced text (which is
- not the intended result):
-+
---
- `single quoted text' and `monospaced quoted text`
-
-This line works as expected:
-
- `single quoted text' and +monospaced quoted text+
---
-
-2. Backtick quoted text is rendered literally i.e. no substitutions
- are performed on the enclosed text. Here are some examples that
- would have to be escaped if plus quoting were used (<<X4,see
- also>>):
-
- The `++i` and `++j` auto-increments.
- Paths `~/.vim` and `~/docs`.
- The `__init__` method.
- The `{id}` attribute.
-
-
-== Why is the generated HTML title element text invalid?
-Probably because your document title contains formatting that has
-generated HTML title markup. You can resolve this by explicitly
-defining the 'title' attribute in your document's header.
-
-
-== AsciiDoc sometimes generates invalid output markup, why?
-AsciiDoc is backend agnostic, the 'asciidoc' command has no knowledge
-of the syntax or structure of the backend format that it generates.
-Output document validation (syntactic and structural) should be
-performed separately by external validation tools. For example,
-AsciiDoc's 'a2x' toolchain command automatically performs validation
-checks using 'xmllint'.
-
-
-== The AsciiDoc toclevels attribute does not work with DocBook outputs, why?
-DocBook has no provision for specifying table of contents levels but
-you can set the TOC level further down the toolchain by passing the
-DocBook XSL Stylesheets
-http://docbook.sourceforge.net/release/xsl/current/doc/html/toc.section.depth.html[toc.section.depth]
-parameter to 'dblatex' (using the `--param` option) or 'xsltproc'
-(using the `--stringparam` option). For example to show only chapter
-titles in the TOC of a 'book' document set 'toc.section.depth' to '0'.
-Increment the 'toc.section.depth' value to show more sub-section
-titles. If you are using 'a2x' you can set the options in the source
-file, for example:
-
- // a2x: --xsltproc-opts "--stringparam toc.section.depth 0"
- // a2x: --dblatex-opts "--param toc.section.depth=0"
-
-If the document is of type 'article' use the value '1' to show only
-top level section titles in the TOC, use the value '2' for two levels
-etc.
-
-
-== How can I include chapter and section tables of contents?
-DocBook outputs processed by DocBook XSL Stylesheets (either manually
-or via 'a2x') can generate additional separate section and chapter
-tables of contents using combinations of the
-http://www.sagehill.net/docbookxsl/TOCcontrol.html[TOC parameters].
-Here are some examples using combinations of the
-`generate.section.toc.level` and `toc.section.depth` DocBook XSL
-Stylesheets parameters:
-
-[cols="2*l,4",width="90%",frame="topbot",options="header"]
-|======================================================
-|generate.section.toc.level |toc.section.depth |
-|1 |
-|Single level book chapter TOCs or article section TOCs
-
-|1 | 3
-|Article section TOCs with two levels
-
-|1 | 2
-|Book chapter TOCs with two levels
-|======================================================
-
-
-== How can I customize the appearance of XHTML and EPUB documents generated by a2x?
-You can customize the appearance of an EPUB document with CSS. See
-the link:publishing-ebooks-with-asciidoc.html[Sherlock Holmes eBook
-example] on the AsciiDoc website.
-
-
-== DocBook has many elements for document meta-data -- how can I use them from AsciiDoc?
-The 'docinfo', 'docinfo1' and 'docinfo2' attributes allow you include
-link:userguide.html#X97[document information files] containing DocBook
-XML into the header of the output file.
-
-
-== Do element titles automatically generate link captions?
-If you go the DocBook route then yes -- just omit the caption from the
-AsciiDoc 'xref' (`<<...>>`) macro. Both dblatex and DocBook XSL will
-use the target element's title text. Examples:
-
-[listing]
-..................................................................
-[[X1]]
-Section One
------------
-Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas
-ultrices justo porttitor augue. Vestibulum pretium. Donec porta
-
-See also <<X3>> (this link displays the text 'A titled paragraph').
-
-[id="X2",reftext="2nd section"]
-Section Two
------------
-See also <<X1>> (this link displays the text 'Section One').
-
-[[X3]]
-.A titled paragraph
-Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
-
-See also <<X2>> (this link displays the text '2nd section').
-..................................................................
-
-The AsciiDoc 'reftext' attribute has been used to explicitly set the
-link text to '2nd section' for 'Section Two'.
-
-
-== Can I define my own table styles?
-In addition to the built-in styles you can define your own. This
-example (for the 'xhtml11' backend) defines a table style called 'red'
-which sets the background cell color to red. First put the definition
-in a configuration file:
-
-[listing]
-.........................................
-[tabledef-default]
-red-style=tags="red"
-
-[tabletags-red]
-bodydata=<td style="background-color:red;">|</td>
-.........................................
-
-Now you can use the style name to style cells or columns (in this
-example we use an unambiguous shortened abbreviation 'r'):
-
-[listing]
-.........................................
-|==================================
-|Normal cell r|Red cell
-|==================================
-.........................................
-
-
-== How can I add highlighted editorial comments to an AsciiDoc document?
-Both block and inline link:userguide.html#X25[comment lines] are
-displayed on the output if the 'showcomments' attribute is defined.
-Example:
-
-[listing]
-.........................................
-:showcomments:
-// A block comment line.
-
-Qui in magna commodo, est labitur dolorum an. Est ne magna primis
-// An inline comment line.
-adolescens.
-.........................................
-
-Is rendered as:
-
-:showcomments:
-// A block comment line.
-
-Qui in magna commodo, est labitur dolorum an. Est ne magna primis
-// An inline comment line.
-adolescens.
-
-NOTE: link:userguide.html#X26[Comment blocks] are never displayed.
-
-
-== What is the preferred file name extension for AsciiDoc files?
-The `.txt` http://en.wikipedia.org/wiki/Text_file[text file] extension
-is preferred, but it's just a convention and it's not enforced by the
-software.
-
-AsciiDoc source files are human readable
-http://en.wikipedia.org/wiki/Plain_text[plain text] files which is
-what the `.txt` extension is for. All text editors recognize and open
-files with a `.txt` extension. The `.txt` extension is universally
-recognized and unambiguous -- you are not left asking questions like
-``What on earth is this file with the funny extension?'', ``How do I
-open it?'' and ``Is it safe to open?''.
-
-
-== How can I generate numbered bibliographic entries?
-If your outputs are DocBook generated then adding the following inline
-macro to a custom configuration file will result in auto-incrementing
-bibliography entry numbers (instead of displaying the bibliographic
-identifiers):
-
- [anchor3-inlinemacro]
- <anchor id="{1}" xreflabel="[{counter:bibliography1}]"/>[{counter:bibliography2}]
-
-This FAQ submitted by Bela Hausmann.
-
-
-== How can I include lines of dashes inside a listing block?
-A line of four or more dashes will be mistaken for the ListingBlock
-terminator, one way round this problem is to use a LiteralBlock styled
-as a listing block. For example:
-
- [listing]
- ...........................
- Lorum ipsum
- -----------
- ...........................
-
-
-== How can I customize PDF files generated by dblatex?
-
-There are a number of dblatex XSL parameters that can be used to
-customize PDF output. You can set them globally in the AsciiDoc
-`./dblatex/asciidoc-dblatex.xsl` configuration file or you can also
-pass them on the a2x(1) command-line. Here are some examples:
-
-The
-http://dblatex.sourceforge.net/doc/manual/latex.output.revhistory.html[latex.output.revhistory]
-parameter is used to suppress the revision history:
-
- a2x -f pdf --dblatex-opts "-P latex.output.revhistory=0" doc/article.txt
-
-The
-http://dblatex.sourceforge.net/doc/manual/doc.layout.html[doc.layout]
-parameter is used to include the cover page and document body (i.e. excludes
-table of contents and index), the
-http://dblatex.sourceforge.net/doc/manual/doc.publisher.show.html[doc.publisher.show]
-parameter is used to exclude the cover page logo:
-
- a2x -f pdf --dblatex-opts " -P doc.layout=\"coverpage mainmatter\" -P doc.publisher.show=0" doc/article.txt
-
-See also the
-http://dblatex.sourceforge.net/doc/manual/sec-params.html[dblatex XSL
-parameter reference].
-
-
-== How can I add lists of figures and tables to PDFs created by dblatex?
-Set the
-http://dblatex.sourceforge.net/doc/sec-custom.html[doc.lot.show XSL
-parameter] -- you can set it using the dblatex `--param` command-line
-option, for example:
-
- $ a2x --dblatex-opts="--param=doc.lot.show=figure,table" doc/article.txt
-
-
-== How can I stop the document title being displayed?
-You could simply omit the document title, but this will result in a
-blank 'title' element in HTML outputs. If you want the HTML 'title'
-element to contain the document title then define the 'notitle'
-attribute (this will just suppress displaying the title), for example:
-
- My document title
- =================
- :no title:
-
-
-== Why am I having trouble getting nested macros to work?
-The following example expands the 'image' inline macro, but the
-expansion contains double-quote characters which confuses the ensuing
-'footnoteref' macro expansion:
-
- footnoteref:["F1","A footnote, with an image image:smallnew.png[]"]
-
-The solution is to use unquoted attribute values, replacing embedded
-commas with the comma character entity (`,`):
-
- footnoteref:[F1,A footnote, with an image image:smallnew.png[]]
-
-Similarly, you can embed double-quote characters in unquoted attribute
-values using the `"` character entity.
-
-
-== Why am I getting DocBook validation errors?
-Not all valid AsciiDoc source generates valid DocBook, for example
-'special sections' (abstract, preface, colophon, dedication,
-bibliography, glossary, appendix, index, synopsis) have different
-DocBook schema's to normal document sections. For example, a paragraph
-is illegal in a bibliography.
-
-Don't forget if your document is a book you need to specify the
-asciidoc `-d book` command option, if you don't an article DocBook
-document will be generated, possibly containing book specific
-sections, resulting in validation errors.
-
-
-== How can I disable special section titles?
-For example, you want to use 'References' as a normal section name but
-AsciiDoc is auto-magically generating a DocBook 'bibliography'
-section. All you need to do is explicitly specify the section template
-name, for example:
-
- [sect1]
- References
- ----------
-
-
-== How can I insert XML processing instructions into output documents?
-Use an inline or block passthrough macros. This example inserts
-`<?dblatex bgcolor="#cceeff"?>` into the DocBook output generated by
-AsciiDoc:
-
- pass::[<?dblatex bgcolor="#cceeff"?>]
-
-NOTE: XML processing instructions are specific to the application that
-processes the XML (the previous `dblatex` processing instruction is
-recognized by `dblatex(1)` when it processes the DocBook XML generated
-by Asciidoc).
-
-
-[[X4]]
-== How do I prevent double-quoted text being mistaken for an inline literal?
-Mixing doubled-quoted text with inline literal passthroughs can
-produce undesired results, for example, all of the following line is
-interpreted as an inline literal passthrough:
-
- ``XXX'' `YYY`
-
-In this case the solution is to use monospace quoting instead of the
-inline literal:
-
- ``XXX'' +YYY+
-
-Use the +\pass:[]+ macro if it's necessary to suppress
-substitutions in the monospaced text, for example:
-
- ``XXX'' +pass:[don't `quote` me]+
-
-
-== How can I generate a single HTML document file containing images and CSS styles?
-With the advent of Internet Explorer 8 all major web browsers now
-support the
-http://en.wikipedia.org/wiki/Data:_URI_scheme[data URI scheme] for
-embedded images. The AsciiDoc 'xhtml11' backend supports the data URI
-scheme for embedded images and by default it embeds the CSS
-stylesheet. For example the following command will generate a single
-`article.html` file containing embedded images, admonition icons and the CSS
-stylesheet:
-
- $ asciidoc -a data-uri -a icons article.txt
-
-
-== Are there any tools to help me understand what's going on inside AsciiDoc?
-
-AsciiDoc has a built-in trace mechanism which is controlled by the
-'trace' attribute; there is also the `--verbose` command-line option.
-These features are detailed in
-http://www.methods.co.nz/asciidoc/userguide.html#X82[Appendix G of the
-User Guide].
-
-
-== One-liner ifdef::[]'s are disproportionately verbose can they shortened?
-
-This is the response to a question posted on the AsciiDoc discussion
-list, it illustrates a number of useful techniques. The question arose
-because the source highlight filter language identifier for the C++
-language is `c++` when generating PDFs via dblatex (LaTeX listings
-package) or `cpp` when generating HTML (GNU source-highlight).
-
-Using straight `ifdef::[]` block macros we have:
-
-[listing]
-.........................................
-\ifdef::basebackend-docbook[]
-[source,c++]
-\endif::basebackend-docbook[]
-\ifdef::basebackend-html[]
-[source,cpp]
-\endif::basebackend-html[]
------------------------------------------
-class FooParser {
-public:
- virtual void startDocument() = 0;
- virtual void endDocument() = 0;
-};
------------------------------------------
-.........................................
-
-
-This can be shortened using the short form of the `ifdef::[]` macro:
-
-[listing]
-.........................................
-\ifdef::basebackend-docbook[[source,c++]]
-\ifdef::basebackend-html[[source,cpp]]
------------------------------------------
-class FooParser {
-public:
- virtual void startDocument() = 0;
- virtual void endDocument() = 0;
-};
------------------------------------------
-.........................................
-
-
-Using a conditional attribute instead of the `ifdef::[]` macro is even
-shorter:
-
-[listing]
-.........................................
-[source,{basebackend@docbook:c++:cpp}]
------------------------------------------
-class FooParser {
-public:
- virtual void startDocument() = 0;
- virtual void endDocument() = 0;
-};
------------------------------------------
-.........................................
-
-
-If you have a number of listings it makes sense to factor the
-conditional attribute to a normal attribute:
-
-[listing]
-.........................................
-:cpp: {basebackend@docbook:c++:cpp}
-
-[source,{cpp}]
------------------------------------------
-class FooParser {
-public:
- virtual void startDocument() = 0;
- virtual void endDocument() = 0;
-};
------------------------------------------
-.........................................
-
-
-Even shorter, set the default source highlight filter `language`
-attribute so you don't have to specify it every time:
-
-[listing]
-.........................................
-:language: {basebackend@docbook:c++:cpp}
-
-[source]
------------------------------------------
-class FooParser {
-public:
- virtual void startDocument() = 0;
- virtual void endDocument() = 0;
-};
------------------------------------------
-.........................................
-
-
-== Some of my inline passthroughs are not passed through, why?
-
-Most likely the passthrough encloses another passthrough with a higher
-precedence. For example trying to render this +\pass:[]+ with this
-+\`\pass:[]`+ results in a blank string because the +\pass:[]+
-passthrough evaluates first, instead use monospaced quoting and escape
-the passthrough i.e. ++ \+\\pass:[]+ ++
-
-
-== How can I place an anchor (link target) on a list item?
-
-You can't use a 'BlockId' block element inside a list but you can use
-the syntactically identical 'anchor' inline macro. For example:
-
----------------------
-one:: Item one.
-[[X2]]two:: Item two.
-three:: Item three.
----------------------
-
-This *will not* work:
-
----------------------
-one:: Item one.
-[[X2]]
-two:: Item two.
-three:: Item three.
----------------------
-
-
-== How can I stop lists from nesting?
-
-If you place two lists with different syntax hard up against each
-other then the second list will be nested in the first. If you don't
-want the second list to be nested separate them with a comment line
-block macro. For example:
-
--------------------
-1. List 1.
-2. List 1.
-
-//
-a. List 2.
-b. List 2.
--------------------
-
-
-== Is it possible to include charts in AsciiDoc documents?
-
-There are a number of programs available that generate presentation
-charts from textual specification, for example
-http://home.gna.org/pychart/[Pychart] is a library for writing chart
-scripts in Python. Here's an example from the 'Pychart' documentation:
-
-.barchart.py
----------------------------------------------------------------------
-#
-# Example bar chart (from Pychart documentation http://home.gna.org/pychart/).
-#
-from pychart import *
-theme.get_options()
-
-data = [(10, 20, 30, 5), (20, 65, 33, 5), (30, 55, 30, 5), (40, 45, 51, 7),
- (50, 25, 27, 3), (60, 75, 30, 5), (70, 80, 42, 5), (80, 62, 32, 5),
- (90, 42, 39, 5), (100, 32, 39, 4)]
-
-# The attribute y_coord=... tells that the Y axis values
-# should be taken from samples.
-# In this example, Y values will be [40,50,60,70,80].
-ar = area.T(y_coord = category_coord.T(data[3:8], 0),
- x_grid_style=line_style.gray50_dash1,
- x_grid_interval=20, x_range = (0,100),
- x_axis=axis.X(label="X label"),
- y_axis=axis.Y(label="Y label"),
- bg_style = fill_style.gray90,
- border_line_style = line_style.default,
- legend = legend.T(loc=(80,10)))
-
-# Below call sets the default attributes for all bar plots.
-chart_object.set_defaults(bar_plot.T, direction="horizontal", data=data)
-
-# Attribute cluster=(0,3) tells that you are going to draw three bar
-# plots side by side. The plot labeled "foo" will the leftmost (i.e.,
-# 0th out of 3). Attribute hcol tells the column from which to
-# retrive sample values from. It defaults to one.
-ar.add_plot(bar_plot.T(label="foo", cluster=(0,3)))
-ar.add_plot(bar_plot.T(label="bar", hcol=2, cluster=(1,3)))
-ar.add_plot(bar_plot.T(label="baz", hcol=3, cluster=(2,3)))
-ar.draw()
----------------------------------------------------------------------
-
-To execute the script and include the generated chart image in your
-document add the following lines to the AsciiDoc source:
-
----------------------------------------------------------------------
-// Generate chart image file.
-\sys2::[python "{indir}/barchart.py" --format=png --output="{outdir}/barchart.png" --scale=2]
-
-// Display chart image file.
-image::barchart.png[]
----------------------------------------------------------------------
-
-[NOTE]
-=====================================================================
-- The `barchart.py` script is located in the same directory as the
- AsciiDoc source file (`{indir}`).
-- The generated chart image file (`barchart.png`) is written to the
- same directory as the output file (`{outdir}`).
-=====================================================================
-
-== How can I render indented paragraphs?
-
-To unconditionally indent all paragraphs add the following line to the
-`xhtml11.css` stylesheet (or a custom stylesheet).
-
----------------------------------------------------------------------
-div.paragraph p {text-indent: 3em;}
----------------------------------------------------------------------
-
-This will restyle the entire document by indenting all paragraphs
-which is normally what you want to do (mixed paragraph styles produce
-ugly documents).
-
-To selectively indent paragraphs you could either create an 'indented'
-paragraph style from scratch or use the 'role' attribute.
-
-[float]
-==== Create an indented paragraph style
-Define an 'indented' paragraph style, for example, by putting this in
-a configuration file:
-
----------------------------------------------------------------------
-[paradef-default]
-indented-style=template="indentedparagraph"
-
-[indentedparagraph]
-<div class="paragraph"{id? id="{id}"} style="text-indent:3em;">{title?<div class="title">{title}</div>}<p>
-|
-</p></div>
----------------------------------------------------------------------
-
-Now apply the 'indented' style to normal paragraphs, for example:
-
----------------------------------------------------------------------
-[indented]
-Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas
-ultrices justo porttitor augue. Vestibulum pretium. Donec porta
-vestibulum mi. Aliquam pede. Aenean lobortis lorem et lacus. Sed
-lacinia. Vivamus at lectus.
----------------------------------------------------------------------
-
-[float]
-==== Use the role attribute
-Add the following line to the `xhtml11.css` stylesheet (or a custom
-stylesheet).
-
----------------------------------------------------------------------
-div.paragraph.indented p {text-indent: 3em;}
----------------------------------------------------------------------
-
-Apply the 'role' attribute to indented paragraphs, for example:
-
----------------------------------------------------------------------
-[role="indented"]
-Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas
-ultrices justo porttitor augue. Vestibulum pretium. Donec porta
-vestibulum mi. Aliquam pede. Aenean lobortis lorem et lacus. Sed
-lacinia. Vivamus at lectus.
----------------------------------------------------------------------
-
-NOTE: This FAQ applies to XHTML output not DocBook. To achieve the
-same results with DocBook use the 'role' attribute and customize the
-DocBook XSL stylesheets to indent paragraphs with the `simpara`
-element `role="indented"` attribute.
-
-
-== Is there a way to set default image height and width attributes?
-
-You can set the 'height' and 'width' attributes globally in your
-document with Attribute Entries or from the command-line using the
-`--attribute` option. In the following example images that don't
-explicitly set the 'height' and 'width' values will be 350 by 250
-pixels.
-
----------------------------------------------------------------------
-:height: 250
-:width: 350
-
-image:images/tiger.png[]
----------------------------------------------------------------------
-
-NOTE: Setting the global 'width' attribute will also set the default
-table width and you will need to explicitly set table widths.
-
-== How can I place a backslash character in front of an attribute reference without escaping the reference?
-
-Use the predefined `{backslash}` attribute reference instead of an
-actual backslash, for example if the `{projectname}` attribute has
-the value `foobar` then:
-
- d:\data{backslash}{projectname}
-
-would be rendered as:
-
- d:\data\foobar
-
-== How can I escape AsciiDoc markup?
-
-Most AsciiDoc inline elements can be suppressed by preceding them with
-a backslash character. These elements include:
-
-- Attribute references.
-- Text formatting.
-- Quoting,
-- Macros.
-- Replacements.
-- Special words.
-- Table cell separators.
-
-But there are exceptions -- see the next question.
-
-
-== Some elements can't be escaped with a single backslash
-
-There are a number of exceptions to the usual single backslash rule
--- mostly relating to URL macros that have two syntaxes or quoting
-ambiguity. Here are some non-standard escape examples:
-
-[cols="l,v",width="40%",frame="topbot",options="header"]
-|========================================
-|AsciiDoc | Renders
-
-2*|
-\srackham@methods.co.nz
-<\srackham@methods.co.nz>
-\mailto:[\srackham@methods.co.nz]
-
-2*|
-\http://www.foo1.co.nz
-\\http://www.foobar.com[]
-\\http://www.foobar.com[Foobar Limited]
-
-2*|
-A C\++ Library for C++
-\\``double-quotes''
-\*\*F**ile Open\...
-|========================================
-
-The source of this problem is ambiguity across substitution types --
-the first match unescapes allowing the second to substitute. A
-work-around for difficult cases is to side-step the problem using the
-+\pass:[]+ passthrough inline macro.
-
-NOTE: Escaping is unnecessary inside 'inline literal passthroughs'
-(backtick quoted text).
-
-
-== How can I escape a list?
-Here's how to handle situations where the first line of a paragraph is
-mistaken for a list item.
-
-[float]
-==== Numbered and bulleted lists
-Precede the bullet or index of the first list item with an `{empty}`
-attribute, for example:
-
- {empty}- Qui in magna commodo est labitur dolorum an. Est ne magna
- primis adolescens.
-
-The predefined `{empty}` attribute is replaced by an empty string and
-ensures the first line is not mistaken for a bulleted list item.
-
-[float]
-==== Labeled lists
-Two colons or semicolons in a paragraph may be confused with a labeled
-list entry. Use the predefined `{two-colons}` and `{two-semicolons}`
-attributes to suppress this behavior, for example:
-
- Qui in magna commodo{two-colons} est labitur dolorum an. Est ne
- magna primis adolescens.
-
-Will be rendered as:
-
-Qui in magna commodo{two-colons} est labitur dolorum an. Est ne
-magna primis adolescens.
-
-
-== How can I set default list and tables styles?
-
-You can set the element's 'style' entry in a global or custom
-configuration file.
-
-This example this will horizontally style all labeled lists that don't
-have an explicit style attribute:
-
-----------------------------------
-[listdef-labeled]
-style=horizontal
-
-[listdef-labeled2]
-style=horizontal
-----------------------------------
-
-This example will put a top and bottom border on all tables that don't
-already have an explicit style attribute:
-
-----------------------------------
-[tabledef-default]
-style=topbot
-topbot-style=frame="topbot"
-----------------------------------
-
-Alternatively you can set the configuration entries from inside your
-document, the above examples are equivalent to:
-
-----------------------------------
-:listdef-labeled.style: horizontal
-:listdef-labeled2.style: horizontal
-
-:tabledef-default.topbot-style: frame="topbot"
-:tabledef-default.style: topbot
-----------------------------------
-
-
-== Why do I get a filter non-zero exit code error?
-
-An error was returned when AsciiDoc tried to execute an external
-filter command. The most common reason for this is that the filter
-command could not be found by the command shell. To figure out what
-the problem is run AsciiDoc with the `--verbose` option to determine
-the command that is failing and then try to run the command manually
-from the command-line.
-
-
-== Are there any DocBook viewers?
-
-http://live.gnome.org/Yelp[Yelp], the GNOME help viewer, does a
-creditable job of displaying DocBook XML files directly.
-
-
-== Can you create ODF documents using AsciiDoc?
-
-The easiest and highest fidelity method I've seen is to generate
-HTML from AsciiDoc then paste it from your browser (we use Firefox)
-into OpenOffice Writer.
-
-- I found that that there is better fidelity pasting HTML generated by
- the 'html4' backend instead of the default 'xhtml11' backend.
-- Don't paste AsciiDoc tables of contents, OpenOffice Writer (I was
- using version 2.3) hangs when saving. This may be something to do
- with the embedded JavaScript but I haven't looked closely at it, I
- may even be wrong about this.
-
-This tip was contributed by Bernard Amade.
-
-
-== How can I suppress cell separators in included table data files?
-
-Use the `{include:}` system attribute instead of the `include::[]`
-macro (the former is not expanded until after the table data has been
-parsed into cells, whereas the latter is included before the table is
-processed.
-
-
-== How can I preserve paragraph line boundaries?
-
-Apply the The 'verse' paragraph style, the rendered text preserves
-line boundaries and is useful for lyrics and poems. For example:
-
----------------------------------------------------------------------
-[verse]
-Consul *necessitatibus* per id,
-consetetur, eu pro everti postulant
-homero verear ea mea, qui.
----------------------------------------------------------------------
-
-Alternatively, if you are generating PDF files, you can use line
-breaks. For example:
-
----------------------------------------------------------------------
-Consul *necessitatibus* per id, +
-consetetur, eu pro everti postulant +
-homero verear ea mea, qui.
----------------------------------------------------------------------
-
-
-== How can I include non-breaking space characters?
-
-Use the non-breaking space character entity reference ` ` (see
-the next question). You could also use the predefined `{nbsp}`
-attribute reference.
-
-
-== Can I include HTML and XML character entity references in my document?
-
-Yes, just enter the reference in your document. For example `β`
-will print a Greek small beta character β
-
-
-[[X1]]
-== How do I include spaces in URLs?
-
-URL inline macro targets (addresses) cannot contain white space
-characters. If you need spaces encode them as `%20`. For example:
-
- image:large%20image.png[]
- http://www.foo.bar.com/an%20example%20document.html
-
-
-== How can I get AsciiDoc to assign the correct DocBook language attribute?
-
-Set the AsciiDoc 'lang' attribute to the appropriate language code.
-For example:
-
- $ a2x -a lang=es doc/article.txt
-
-This will ensure that downstream DocBook processing will generate the
-correct language specific document headings (things like table of
-contents, revision history, figure and table captions, admonition
-captions).
-
-
-== How can I turn off table and image title numbering?
-For HTML outputs set the 'caption' attribute to an empty string,
-either globally:
-
--------------------------
-:caption:
--------------------------
-
-or on an element by element basis, for example:
-
--------------------------
-.Tiger
-[caption=""]
-image::images/tiger.png[]
--------------------------
-
-
-== How can I assign multiple author names?
-
-A quick way to do this is put both authors in a single first name, for
-example:
-
----------------------------------------
-My Document
-===========
-:Author: Bill_and_Ben_the_Flowerpot_Men
-:Author Initials: BB & BC
----------------------------------------
-
-asciidoc(1) replaces the underscores with spaces.
-
-If you are generating DocBook then a more flexible approach is to
-create a 'docinfo' file containing a DocBook 'authorgroup' element
-(search the 'User Guide' for 'docinfo' for more details).
-
-
-== How can I selectively disable a quoted text substitution?
-
-Omitting the tag name will disable quoting. For example, if you don't
-want superscripts or subscripts then put the following in a custom
-configuration file or edit the global `asciidoc.conf` configuration
-file:
-
--------------------
-[quotes]
-^=
-~=
--------------------
-
-Alternatively you can set the configuration entries from within your
-document, the above examples are equivalent to:
-
--------------------
-:quotes.^:
-:quotes.~:
--------------------
-
-
-== How can I customize the \{localdate} format?
-
-The default format for the `{localdate}` attribute is the ISO 8601
-`yyyy-mm-dd` format. You can change this format by explicitly setting
-the `{localdate}` attribute. For example by setting it using the
-asciidoc(1) `-a` command-line option:
-
- $ asciidoc -a localdate=`date +%d-%m-%Y` mydoc.txt
-
-You could also set it by adding an Attribute Entry to your source
-document, for example:
-
- :localdate: {sys: date +%Y-%m-%d}
-
-
-== Why doesn't AsciiDoc support strike through text?
-
-DocBook does not have provision for strike through text and one of the
-AsciiDoc design goals is that AsciiDoc markup should strive to be
-applicable to all output formats.
-
-Strike through is normally used to mark deleted text -- a more
-comprehensive way to manage document revisions is to use a version
-control system such as Subversion. You can also use the AsciiDoc
-'CommentLines' and 'CommentBlocks' to retain revised text in the
-source document.
-
-If you really need strike through text for (X)HTML outputs then adding
-the following to a configuration file will allow you to quote strike
-through text with hyphen characters:
-
----------------------------------------------------------------------
- ifdef::basebackend-html[]
-
- [quotes]
- -=strikethrough
-
- [tags]
- strikethrough=<del>|</del>
-
- endif::basebackend-html[]
----------------------------------------------------------------------
-
-
-== Where can I find examples of commands used to build output documents?
-
-The User Guide has some. You could also look at `./doc/main.aap` and
-`./examples/website/main.aap` in the AsciiDoc distribution, they have
-all the commands used to build the AsciiDoc documentation and the
-AsciiDoc website (even if you don't use A-A-P you'll still find it
-useful).
-
-
-== Why have you used the DocBook <simpara> element instead of <para>?
-
-`<simpara>` is really the same as `<para>` except it can't contain
-block elements -- this matches, more closely, the AsciiDoc paragraph
-semantics.
-
-
-== How can I format text inside a listing block?
-
-By default only 'specialcharacters' and 'callouts' are substituted in
-listing blocks; you can add quotes substitutions by explicitly setting
-the block 'subs' attribute, for example:
-
-[listing]
-..........................................
-[subs="quotes"]
-------------------------------------------
-$ ls *-al*
-------------------------------------------
-..........................................
-
-The `-al` will rendered bold. Note that:
-
-- You would need to explicitly escape text you didn't want quoted.
-- Don't do this in source code listing blocks because it modifies the
- source code which confuses the syntax highlighter.
-- This only works if your DocBook processor recognizes DocBook
- `<emphasis>` elements inside `<screen>` elements.
-
-Alternative, if the lines are contiguous, you could use the 'literal'
-paragraph style:
-
-------------------------------------------
-["literal",subs="quotes"]
-$ ls *-al*
-------------------------------------------
-
-
-== Why doesn't the include1::[] macro work?
-
-Internally the `include1` macro is translated to the `include1` system
-attribute which means it must be evaluated in a region where attribute
-substitution is enabled. `include1` won't work, for example, in a
-ListingBlock (unless attribute substitution is enabled). `include1`
-is intended for use in configuration files, use the `include` macro
-and set the attribute `depth=1` instead, for example:
-
-[listing]
-................................................
-------------------------------------------------
-\include::blogpost_media_processing.txt[depth=1]
-------------------------------------------------
-................................................
-
-
-== How can I make the mailto macro work with multiple email addresses?
-
-For the AsciiDoc 'mailto' macro to work with multiple email addresses
-(as per RFC2368) you need to URL encode the '@' characters (replace
-them with '%40'), if you don't the individual addresses will be
-rendered as separate links. You also need to <<X1,replace spaces with
-'%20'>>.
-
-For example, the following call won't work:
-
- mailto:jb@foobar.com,jd@acme.co.nz?subject=New foofoo release[New foofoo release]
-
-Use this instead:
-
- mailto:jb%40foobar.com,jd%40acme.co.nz?subject=New%20foofoo%20release[New foofoo release]
-
-
-== How can a replacement have a trailing backslash?
-Quote the entry name -- this nonsensical example replaces `x\` with
-`y`:
-
- "x\\"=y
-
-If quoting were omitted the equals character (separating the
-entry name `x` from the value `y`) would be escaped.
-
-
+AsciiDoc Frequently Asked Questions +=================================== + + +[NOTE] +====== +- New FAQs are normally added at the top of this document. +- The FAQ may be updated between AsciiDoc releases so some of the + newer FAQs may apply to the trunk and not the current release. +====== + +[[X5]] +== How can I include embedded fonts in an EPUB document +This is a two step process: + +1. Declare the font files and their use in your document's CSS + stylesheet. For example: ++ +[listing] +......................................... +@font-face { + font-family : LiberationSerif-Regular; + font-weight : normal; + font-style: normal; + src : url(LiberationSerif-Regular.ttf); +} + +body { + font-family: LiberationSerif-Regular, serif; +} +......................................... + +2. Declare the the font file as resource when you use `a2x(1)` to + compile the EPUB. For example: + + a2x -f epub -d book --epubcheck --stylesheet epubtest.css --resource .ttf=application/x-font-ttf --resource LiberationSerif-Regular.ttf epubtest.txt + +[NOTE] +====== +- Requires AsciiDoc 8.6.5 or better. +- The True Type Font mimetype had to be declared explicitly with the + `--resource .ttf=application/x-font-ttf` option because it wasn't + registered on my Linux system. +- In the above example the font file is in the same directory as the + AsciiDoc source file and is installed to the same relative location + in the EPUB archive OEBPS directory -- if your font file resides in + a different location you'll need to adjust the `--resource` option + accordingly (see the 'RESOURCES' section in the `a2x(1)` man page + for details). +- The URL value of the CSS 'src' property is set to the destination + font file relative the the CSS file. +- The `--resource` option allows you to inject any file (not just font + files) into the EPUB output document. +- Using the CSS '@font-face' rule is a complex subject and is outside + the scope of the FAQ. +- Many EPUB readers do not process embedded fonts. +====== + + +== What's the difference between + quoted text and ` quoted monospaced text? +`+` (plus) quoted text is implemented as an AsciiDoc 'quotes' whereas ++`+ (grave accent or backtick) quoted text is implemented as an +AsciiDoc 'inline literal' passthrough macro. The semantics are +different: + +1. Inline passthrough macros are processed before any other inline + substitutions e.g. all of the following line will be processed as a + single inline passthrough and rendered as monospaced text (which is + not the intended result): ++ +-- + `single quoted text' and `monospaced quoted text` + +This line works as expected: + + `single quoted text' and +monospaced quoted text+ +-- + +2. Backtick quoted text is rendered literally i.e. no substitutions + are performed on the enclosed text. Here are some examples that + would have to be escaped if plus quoting were used (<<X4,see + also>>): + + The `++i` and `++j` auto-increments. + Paths `~/.vim` and `~/docs`. + The `__init__` method. + The `{id}` attribute. + + +== Why is the generated HTML title element text invalid? +Probably because your document title contains formatting that has +generated HTML title markup. You can resolve this by explicitly +defining the 'title' attribute in your document's header. + + +== AsciiDoc sometimes generates invalid output markup, why? +AsciiDoc is backend agnostic, the 'asciidoc' command has no knowledge +of the syntax or structure of the backend format that it generates. +Output document validation (syntactic and structural) should be +performed separately by external validation tools. For example, +AsciiDoc's 'a2x' toolchain command automatically performs validation +checks using 'xmllint'. + + +== The AsciiDoc toclevels attribute does not work with DocBook outputs, why? +DocBook has no provision for specifying table of contents levels but +you can set the TOC level further down the toolchain by passing the +DocBook XSL Stylesheets +http://docbook.sourceforge.net/release/xsl/current/doc/html/toc.section.depth.html[toc.section.depth] +parameter to 'dblatex' (using the `--param` option) or 'xsltproc' +(using the `--stringparam` option). For example to show only chapter +titles in the TOC of a 'book' document set 'toc.section.depth' to '0'. +Increment the 'toc.section.depth' value to show more sub-section +titles. If you are using 'a2x' you can set the options in the source +file, for example: + + // a2x: --xsltproc-opts "--stringparam toc.section.depth 0" + // a2x: --dblatex-opts "--param toc.section.depth=0" + +If the document is of type 'article' use the value '1' to show only +top level section titles in the TOC, use the value '2' for two levels +etc. + + +== How can I include chapter and section tables of contents? +DocBook outputs processed by DocBook XSL Stylesheets (either manually +or via 'a2x') can generate additional separate section and chapter +tables of contents using combinations of the +http://www.sagehill.net/docbookxsl/TOCcontrol.html[TOC parameters]. +Here are some examples using combinations of the +`generate.section.toc.level` and `toc.section.depth` DocBook XSL +Stylesheets parameters: + +[cols="2*l,4",width="90%",frame="topbot",options="header"] +|====================================================== +|generate.section.toc.level |toc.section.depth | +|1 | +|Single level book chapter TOCs or article section TOCs + +|1 | 3 +|Article section TOCs with two levels + +|1 | 2 +|Book chapter TOCs with two levels +|====================================================== + + +== How can I customize the appearance of XHTML and EPUB documents generated by a2x? +You can customize the appearance of an EPUB document with CSS. See +the link:publishing-ebooks-with-asciidoc.html[Sherlock Holmes eBook +example] on the AsciiDoc website. + + +== DocBook has many elements for document meta-data -- how can I use them from AsciiDoc? +The 'docinfo', 'docinfo1' and 'docinfo2' attributes allow you include +link:userguide.html#X97[document information files] containing DocBook +XML into the header of the output file. + + +== Do element titles automatically generate link captions? +If you go the DocBook route then yes -- just omit the caption from the +AsciiDoc 'xref' (`<<...>>`) macro. Both dblatex and DocBook XSL will +use the target element's title text. Examples: + +[listing] +.................................................................. +[[X1]] +Section One +----------- +Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas +ultrices justo porttitor augue. Vestibulum pretium. Donec porta + +See also <<X3>> (this link displays the text 'A titled paragraph'). + +[id="X2",reftext="2nd section"] +Section Two +----------- +See also <<X1>> (this link displays the text 'Section One'). + +[[X3]] +.A titled paragraph +Lorem ipsum dolor sit amet, consectetuer adipiscing elit. + +See also <<X2>> (this link displays the text '2nd section'). +.................................................................. + +The AsciiDoc 'reftext' attribute has been used to explicitly set the +link text to '2nd section' for 'Section Two'. + + +== Can I define my own table styles? +In addition to the built-in styles you can define your own. This +example (for the 'xhtml11' backend) defines a table style called 'red' +which sets the background cell color to red. First put the definition +in a configuration file: + +[listing] +......................................... +[tabledef-default] +red-style=tags="red" + +[tabletags-red] +bodydata=<td style="background-color:red;">|</td> +......................................... + +Now you can use the style name to style cells or columns (in this +example we use an unambiguous shortened abbreviation 'r'): + +[listing] +......................................... +|================================== +|Normal cell r|Red cell +|================================== +......................................... + + +== How can I add highlighted editorial comments to an AsciiDoc document? +Both block and inline link:userguide.html#X25[comment lines] are +displayed on the output if the 'showcomments' attribute is defined. +Example: + +[listing] +......................................... +:showcomments: +// A block comment line. + +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +// An inline comment line. +adolescens. +......................................... + +Is rendered as: + +:showcomments: +// A block comment line. + +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +// An inline comment line. +adolescens. + +NOTE: link:userguide.html#X26[Comment blocks] are never displayed. + + +== What is the preferred file name extension for AsciiDoc files? +The `.txt` http://en.wikipedia.org/wiki/Text_file[text file] extension +is preferred, but it's just a convention and it's not enforced by the +software. + +AsciiDoc source files are human readable +http://en.wikipedia.org/wiki/Plain_text[plain text] files which is +what the `.txt` extension is for. All text editors recognize and open +files with a `.txt` extension. The `.txt` extension is universally +recognized and unambiguous -- you are not left asking questions like +``What on earth is this file with the funny extension?'', ``How do I +open it?'' and ``Is it safe to open?''. + + +== How can I generate numbered bibliographic entries? +If your outputs are DocBook generated then adding the following inline +macro to a custom configuration file will result in auto-incrementing +bibliography entry numbers (instead of displaying the bibliographic +identifiers): + + [anchor3-inlinemacro] + <anchor id="{1}" xreflabel="[{counter:bibliography1}]"/>[{counter:bibliography2}] + +This FAQ submitted by Bela Hausmann. + + +== How can I include lines of dashes inside a listing block? +A line of four or more dashes will be mistaken for the ListingBlock +terminator, one way round this problem is to use a LiteralBlock styled +as a listing block. For example: + + [listing] + ........................... + Lorum ipsum + ----------- + ........................... + + +== How can I customize PDF files generated by dblatex? + +There are a number of dblatex XSL parameters that can be used to +customize PDF output. You can set them globally in the AsciiDoc +`./dblatex/asciidoc-dblatex.xsl` configuration file or you can also +pass them on the a2x(1) command-line. Here are some examples: + +The +http://dblatex.sourceforge.net/doc/manual/latex.output.revhistory.html[latex.output.revhistory] +parameter is used to suppress the revision history: + + a2x -f pdf --dblatex-opts "-P latex.output.revhistory=0" doc/article.txt + +The +http://dblatex.sourceforge.net/doc/manual/doc.layout.html[doc.layout] +parameter is used to include the cover page and document body (i.e. excludes +table of contents and index), the +http://dblatex.sourceforge.net/doc/manual/doc.publisher.show.html[doc.publisher.show] +parameter is used to exclude the cover page logo: + + a2x -f pdf --dblatex-opts " -P doc.layout=\"coverpage mainmatter\" -P doc.publisher.show=0" doc/article.txt + +See also the +http://dblatex.sourceforge.net/doc/manual/sec-params.html[dblatex XSL +parameter reference]. + + +== How can I add lists of figures and tables to PDFs created by dblatex? +Set the +http://dblatex.sourceforge.net/doc/sec-custom.html[doc.lot.show XSL +parameter] -- you can set it using the dblatex `--param` command-line +option, for example: + + $ a2x --dblatex-opts="--param=doc.lot.show=figure,table" doc/article.txt + + +== How can I stop the document title being displayed? +You could simply omit the document title, but this will result in a +blank 'title' element in HTML outputs. If you want the HTML 'title' +element to contain the document title then define the 'notitle' +attribute (this will just suppress displaying the title), for example: + + My document title + ================= + :no title: + + +== Why am I having trouble getting nested macros to work? +The following example expands the 'image' inline macro, but the +expansion contains double-quote characters which confuses the ensuing +'footnoteref' macro expansion: + + footnoteref:["F1","A footnote, with an image image:smallnew.png[]"] + +The solution is to use unquoted attribute values, replacing embedded +commas with the comma character entity (`,`): + + footnoteref:[F1,A footnote, with an image image:smallnew.png[]] + +Similarly, you can embed double-quote characters in unquoted attribute +values using the `"` character entity. + + +== Why am I getting DocBook validation errors? +Not all valid AsciiDoc source generates valid DocBook, for example +'special sections' (abstract, preface, colophon, dedication, +bibliography, glossary, appendix, index, synopsis) have different +DocBook schema's to normal document sections. For example, a paragraph +is illegal in a bibliography. + +Don't forget if your document is a book you need to specify the +asciidoc `-d book` command option, if you don't an article DocBook +document will be generated, possibly containing book specific +sections, resulting in validation errors. + + +== How can I disable special section titles? +For example, you want to use 'References' as a normal section name but +AsciiDoc is auto-magically generating a DocBook 'bibliography' +section. All you need to do is explicitly specify the section template +name, for example: + + [sect1] + References + ---------- + + +== How can I insert XML processing instructions into output documents? +Use an inline or block passthrough macros. This example inserts +`<?dblatex bgcolor="#cceeff"?>` into the DocBook output generated by +AsciiDoc: + + pass::[<?dblatex bgcolor="#cceeff"?>] + +NOTE: XML processing instructions are specific to the application that +processes the XML (the previous `dblatex` processing instruction is +recognized by `dblatex(1)` when it processes the DocBook XML generated +by Asciidoc). + + +[[X4]] +== How do I prevent double-quoted text being mistaken for an inline literal? +Mixing doubled-quoted text with inline literal passthroughs can +produce undesired results, for example, all of the following line is +interpreted as an inline literal passthrough: + + ``XXX'' `YYY` + +In this case the solution is to use monospace quoting instead of the +inline literal: + + ``XXX'' +YYY+ + +Use the +\pass:[]+ macro if it's necessary to suppress +substitutions in the monospaced text, for example: + + ``XXX'' +pass:[don't `quote` me]+ + + +== How can I generate a single HTML document file containing images and CSS styles? +With the advent of Internet Explorer 8 all major web browsers now +support the +http://en.wikipedia.org/wiki/Data:_URI_scheme[data URI scheme] for +embedded images. The AsciiDoc 'xhtml11' backend supports the data URI +scheme for embedded images and by default it embeds the CSS +stylesheet. For example the following command will generate a single +`article.html` file containing embedded images, admonition icons and the CSS +stylesheet: + + $ asciidoc -a data-uri -a icons article.txt + + +== Are there any tools to help me understand what's going on inside AsciiDoc? + +AsciiDoc has a built-in trace mechanism which is controlled by the +'trace' attribute; there is also the `--verbose` command-line option. +These features are detailed in +http://www.methods.co.nz/asciidoc/userguide.html#X82[Appendix G of the +User Guide]. + + +== One-liner ifdef::[]'s are disproportionately verbose can they shortened? + +This is the response to a question posted on the AsciiDoc discussion +list, it illustrates a number of useful techniques. The question arose +because the source highlight filter language identifier for the C++ +language is `c++` when generating PDFs via dblatex (LaTeX listings +package) or `cpp` when generating HTML (GNU source-highlight). + +Using straight `ifdef::[]` block macros we have: + +[listing] +......................................... +\ifdef::basebackend-docbook[] +[source,c++] +\endif::basebackend-docbook[] +\ifdef::basebackend-html[] +[source,cpp] +\endif::basebackend-html[] +----------------------------------------- +class FooParser { +public: + virtual void startDocument() = 0; + virtual void endDocument() = 0; +}; +----------------------------------------- +......................................... + + +This can be shortened using the short form of the `ifdef::[]` macro: + +[listing] +......................................... +\ifdef::basebackend-docbook[[source,c++]] +\ifdef::basebackend-html[[source,cpp]] +----------------------------------------- +class FooParser { +public: + virtual void startDocument() = 0; + virtual void endDocument() = 0; +}; +----------------------------------------- +......................................... + + +Using a conditional attribute instead of the `ifdef::[]` macro is even +shorter: + +[listing] +......................................... +[source,{basebackend@docbook:c++:cpp}] +----------------------------------------- +class FooParser { +public: + virtual void startDocument() = 0; + virtual void endDocument() = 0; +}; +----------------------------------------- +......................................... + + +If you have a number of listings it makes sense to factor the +conditional attribute to a normal attribute: + +[listing] +......................................... +:cpp: {basebackend@docbook:c++:cpp} + +[source,{cpp}] +----------------------------------------- +class FooParser { +public: + virtual void startDocument() = 0; + virtual void endDocument() = 0; +}; +----------------------------------------- +......................................... + + +Even shorter, set the default source highlight filter `language` +attribute so you don't have to specify it every time: + +[listing] +......................................... +:language: {basebackend@docbook:c++:cpp} + +[source] +----------------------------------------- +class FooParser { +public: + virtual void startDocument() = 0; + virtual void endDocument() = 0; +}; +----------------------------------------- +......................................... + + +== Some of my inline passthroughs are not passed through, why? + +Most likely the passthrough encloses another passthrough with a higher +precedence. For example trying to render this +\pass:[]+ with this ++\`\pass:[]`+ results in a blank string because the +\pass:[]+ +passthrough evaluates first, instead use monospaced quoting and escape +the passthrough i.e. ++ \+\\pass:[]+ ++ + + +== How can I place an anchor (link target) on a list item? + +You can't use a 'BlockId' block element inside a list but you can use +the syntactically identical 'anchor' inline macro. For example: + +--------------------- +one:: Item one. +[[X2]]two:: Item two. +three:: Item three. +--------------------- + +This *will not* work: + +--------------------- +one:: Item one. +[[X2]] +two:: Item two. +three:: Item three. +--------------------- + + +== How can I stop lists from nesting? + +If you place two lists with different syntax hard up against each +other then the second list will be nested in the first. If you don't +want the second list to be nested separate them with a comment line +block macro. For example: + +------------------- +1. List 1. +2. List 1. + +// +a. List 2. +b. List 2. +------------------- + + +== Is it possible to include charts in AsciiDoc documents? + +There are a number of programs available that generate presentation +charts from textual specification, for example +http://home.gna.org/pychart/[Pychart] is a library for writing chart +scripts in Python. Here's an example from the 'Pychart' documentation: + +.barchart.py +--------------------------------------------------------------------- +# +# Example bar chart (from Pychart documentation http://home.gna.org/pychart/). +# +from pychart import * +theme.get_options() + +data = [(10, 20, 30, 5), (20, 65, 33, 5), (30, 55, 30, 5), (40, 45, 51, 7), + (50, 25, 27, 3), (60, 75, 30, 5), (70, 80, 42, 5), (80, 62, 32, 5), + (90, 42, 39, 5), (100, 32, 39, 4)] + +# The attribute y_coord=... tells that the Y axis values +# should be taken from samples. +# In this example, Y values will be [40,50,60,70,80]. +ar = area.T(y_coord = category_coord.T(data[3:8], 0), + x_grid_style=line_style.gray50_dash1, + x_grid_interval=20, x_range = (0,100), + x_axis=axis.X(label="X label"), + y_axis=axis.Y(label="Y label"), + bg_style = fill_style.gray90, + border_line_style = line_style.default, + legend = legend.T(loc=(80,10))) + +# Below call sets the default attributes for all bar plots. +chart_object.set_defaults(bar_plot.T, direction="horizontal", data=data) + +# Attribute cluster=(0,3) tells that you are going to draw three bar +# plots side by side. The plot labeled "foo" will the leftmost (i.e., +# 0th out of 3). Attribute hcol tells the column from which to +# retrive sample values from. It defaults to one. +ar.add_plot(bar_plot.T(label="foo", cluster=(0,3))) +ar.add_plot(bar_plot.T(label="bar", hcol=2, cluster=(1,3))) +ar.add_plot(bar_plot.T(label="baz", hcol=3, cluster=(2,3))) +ar.draw() +--------------------------------------------------------------------- + +To execute the script and include the generated chart image in your +document add the following lines to the AsciiDoc source: + +--------------------------------------------------------------------- +// Generate chart image file. +\sys2::[python "{indir}/barchart.py" --format=png --output="{outdir}/barchart.png" --scale=2] + +// Display chart image file. +image::barchart.png[] +--------------------------------------------------------------------- + +[NOTE] +===================================================================== +- The `barchart.py` script is located in the same directory as the + AsciiDoc source file (`{indir}`). +- The generated chart image file (`barchart.png`) is written to the + same directory as the output file (`{outdir}`). +===================================================================== + +== How can I render indented paragraphs? + +To unconditionally indent all paragraphs add the following line to the +`xhtml11.css` stylesheet (or a custom stylesheet). + +--------------------------------------------------------------------- +div.paragraph p {text-indent: 3em;} +--------------------------------------------------------------------- + +This will restyle the entire document by indenting all paragraphs +which is normally what you want to do (mixed paragraph styles produce +ugly documents). + +To selectively indent paragraphs you could either create an 'indented' +paragraph style from scratch or use the 'role' attribute. + +[float] +==== Create an indented paragraph style +Define an 'indented' paragraph style, for example, by putting this in +a configuration file: + +--------------------------------------------------------------------- +[paradef-default] +indented-style=template="indentedparagraph" + +[indentedparagraph] +<div class="paragraph"{id? id="{id}"} style="text-indent:3em;">{title?<div class="title">{title}</div>}<p> +| +</p></div> +--------------------------------------------------------------------- + +Now apply the 'indented' style to normal paragraphs, for example: + +--------------------------------------------------------------------- +[indented] +Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas +ultrices justo porttitor augue. Vestibulum pretium. Donec porta +vestibulum mi. Aliquam pede. Aenean lobortis lorem et lacus. Sed +lacinia. Vivamus at lectus. +--------------------------------------------------------------------- + +[float] +==== Use the role attribute +Add the following line to the `xhtml11.css` stylesheet (or a custom +stylesheet). + +--------------------------------------------------------------------- +div.paragraph.indented p {text-indent: 3em;} +--------------------------------------------------------------------- + +Apply the 'role' attribute to indented paragraphs, for example: + +--------------------------------------------------------------------- +[role="indented"] +Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas +ultrices justo porttitor augue. Vestibulum pretium. Donec porta +vestibulum mi. Aliquam pede. Aenean lobortis lorem et lacus. Sed +lacinia. Vivamus at lectus. +--------------------------------------------------------------------- + +NOTE: This FAQ applies to XHTML output not DocBook. To achieve the +same results with DocBook use the 'role' attribute and customize the +DocBook XSL stylesheets to indent paragraphs with the `simpara` +element `role="indented"` attribute. + + +== Is there a way to set default image height and width attributes? + +You can set the 'height' and 'width' attributes globally in your +document with Attribute Entries or from the command-line using the +`--attribute` option. In the following example images that don't +explicitly set the 'height' and 'width' values will be 350 by 250 +pixels. + +--------------------------------------------------------------------- +:height: 250 +:width: 350 + +image:images/tiger.png[] +--------------------------------------------------------------------- + +NOTE: Setting the global 'width' attribute will also set the default +table width and you will need to explicitly set table widths. + +== How can I place a backslash character in front of an attribute reference without escaping the reference? + +Use the predefined `{backslash}` attribute reference instead of an +actual backslash, for example if the `{projectname}` attribute has +the value `foobar` then: + + d:\data{backslash}{projectname} + +would be rendered as: + + d:\data\foobar + +== How can I escape AsciiDoc markup? + +Most AsciiDoc inline elements can be suppressed by preceding them with +a backslash character. These elements include: + +- Attribute references. +- Text formatting. +- Quoting, +- Macros. +- Replacements. +- Special words. +- Table cell separators. + +But there are exceptions -- see the next question. + + +== Some elements can't be escaped with a single backslash + +There are a number of exceptions to the usual single backslash rule +-- mostly relating to URL macros that have two syntaxes or quoting +ambiguity. Here are some non-standard escape examples: + +[cols="l,v",width="40%",frame="topbot",options="header"] +|======================================== +|AsciiDoc | Renders + +2*| +\srackham@methods.co.nz +<\srackham@methods.co.nz> +\mailto:[\srackham@methods.co.nz] + +2*| +\http://www.foo1.co.nz +\\http://www.foobar.com[] +\\http://www.foobar.com[Foobar Limited] + +2*| +A C\++ Library for C++ +\\``double-quotes'' +\*\*F**ile Open\... +|======================================== + +The source of this problem is ambiguity across substitution types -- +the first match unescapes allowing the second to substitute. A +work-around for difficult cases is to side-step the problem using the ++\pass:[]+ passthrough inline macro. + +NOTE: Escaping is unnecessary inside 'inline literal passthroughs' +(backtick quoted text). + + +== How can I escape a list? +Here's how to handle situations where the first line of a paragraph is +mistaken for a list item. + +[float] +==== Numbered and bulleted lists +Precede the bullet or index of the first list item with an `{empty}` +attribute, for example: + + {empty}- Qui in magna commodo est labitur dolorum an. Est ne magna + primis adolescens. + +The predefined `{empty}` attribute is replaced by an empty string and +ensures the first line is not mistaken for a bulleted list item. + +[float] +==== Labeled lists +Two colons or semicolons in a paragraph may be confused with a labeled +list entry. Use the predefined `{two-colons}` and `{two-semicolons}` +attributes to suppress this behavior, for example: + + Qui in magna commodo{two-colons} est labitur dolorum an. Est ne + magna primis adolescens. + +Will be rendered as: + +Qui in magna commodo{two-colons} est labitur dolorum an. Est ne +magna primis adolescens. + + +== How can I set default list and tables styles? + +You can set the element's 'style' entry in a global or custom +configuration file. + +This example this will horizontally style all labeled lists that don't +have an explicit style attribute: + +---------------------------------- +[listdef-labeled] +style=horizontal + +[listdef-labeled2] +style=horizontal +---------------------------------- + +This example will put a top and bottom border on all tables that don't +already have an explicit style attribute: + +---------------------------------- +[tabledef-default] +style=topbot +topbot-style=frame="topbot" +---------------------------------- + +Alternatively you can set the configuration entries from inside your +document, the above examples are equivalent to: + +---------------------------------- +:listdef-labeled.style: horizontal +:listdef-labeled2.style: horizontal + +:tabledef-default.topbot-style: frame="topbot" +:tabledef-default.style: topbot +---------------------------------- + + +== Why do I get a filter non-zero exit code error? + +An error was returned when AsciiDoc tried to execute an external +filter command. The most common reason for this is that the filter +command could not be found by the command shell. To figure out what +the problem is run AsciiDoc with the `--verbose` option to determine +the command that is failing and then try to run the command manually +from the command-line. + + +== Are there any DocBook viewers? + +http://live.gnome.org/Yelp[Yelp], the GNOME help viewer, does a +creditable job of displaying DocBook XML files directly. + + +== Can you create ODF documents using AsciiDoc? + +The easiest and highest fidelity method I've seen is to generate +HTML from AsciiDoc then paste it from your browser (we use Firefox) +into OpenOffice Writer. + +- I found that that there is better fidelity pasting HTML generated by + the 'html4' backend instead of the default 'xhtml11' backend. +- Don't paste AsciiDoc tables of contents, OpenOffice Writer (I was + using version 2.3) hangs when saving. This may be something to do + with the embedded JavaScript but I haven't looked closely at it, I + may even be wrong about this. + +This tip was contributed by Bernard Amade. + + +== How can I suppress cell separators in included table data files? + +Use the `{include:}` system attribute instead of the `include::[]` +macro (the former is not expanded until after the table data has been +parsed into cells, whereas the latter is included before the table is +processed. + + +== How can I preserve paragraph line boundaries? + +Apply the The 'verse' paragraph style, the rendered text preserves +line boundaries and is useful for lyrics and poems. For example: + +--------------------------------------------------------------------- +[verse] +Consul *necessitatibus* per id, +consetetur, eu pro everti postulant +homero verear ea mea, qui. +--------------------------------------------------------------------- + +Alternatively, if you are generating PDF files, you can use line +breaks. For example: + +--------------------------------------------------------------------- +Consul *necessitatibus* per id, + +consetetur, eu pro everti postulant + +homero verear ea mea, qui. +--------------------------------------------------------------------- + + +== How can I include non-breaking space characters? + +Use the non-breaking space character entity reference ` ` (see +the next question). You could also use the predefined `{nbsp}` +attribute reference. + + +== Can I include HTML and XML character entity references in my document? + +Yes, just enter the reference in your document. For example `β` +will print a Greek small beta character β + + +[[X1]] +== How do I include spaces in URLs? + +URL inline macro targets (addresses) cannot contain white space +characters. If you need spaces encode them as `%20`. For example: + + image:large%20image.png[] + http://www.foo.bar.com/an%20example%20document.html + + +== How can I get AsciiDoc to assign the correct DocBook language attribute? + +Set the AsciiDoc 'lang' attribute to the appropriate language code. +For example: + + $ a2x -a lang=es doc/article.txt + +This will ensure that downstream DocBook processing will generate the +correct language specific document headings (things like table of +contents, revision history, figure and table captions, admonition +captions). + + +== How can I turn off table and image title numbering? +For HTML outputs set the 'caption' attribute to an empty string, +either globally: + +------------------------- +:caption: +------------------------- + +or on an element by element basis, for example: + +------------------------- +.Tiger +[caption=""] +image::images/tiger.png[] +------------------------- + + +== How can I assign multiple author names? + +A quick way to do this is put both authors in a single first name, for +example: + +--------------------------------------- +My Document +=========== +:Author: Bill_and_Ben_the_Flowerpot_Men +:Author Initials: BB & BC +--------------------------------------- + +asciidoc(1) replaces the underscores with spaces. + +If you are generating DocBook then a more flexible approach is to +create a 'docinfo' file containing a DocBook 'authorgroup' element +(search the 'User Guide' for 'docinfo' for more details). + + +== How can I selectively disable a quoted text substitution? + +Omitting the tag name will disable quoting. For example, if you don't +want superscripts or subscripts then put the following in a custom +configuration file or edit the global `asciidoc.conf` configuration +file: + +------------------- +[quotes] +^= +~= +------------------- + +Alternatively you can set the configuration entries from within your +document, the above examples are equivalent to: + +------------------- +:quotes.^: +:quotes.~: +------------------- + + +== How can I customize the \{localdate} format? + +The default format for the `{localdate}` attribute is the ISO 8601 +`yyyy-mm-dd` format. You can change this format by explicitly setting +the `{localdate}` attribute. For example by setting it using the +asciidoc(1) `-a` command-line option: + + $ asciidoc -a localdate=`date +%d-%m-%Y` mydoc.txt + +You could also set it by adding an Attribute Entry to your source +document, for example: + + :localdate: {sys: date +%Y-%m-%d} + + +== Why doesn't AsciiDoc support strike through text? + +DocBook does not have provision for strike through text and one of the +AsciiDoc design goals is that AsciiDoc markup should strive to be +applicable to all output formats. + +Strike through is normally used to mark deleted text -- a more +comprehensive way to manage document revisions is to use a version +control system such as Subversion. You can also use the AsciiDoc +'CommentLines' and 'CommentBlocks' to retain revised text in the +source document. + +If you really need strike through text for (X)HTML outputs then adding +the following to a configuration file will allow you to quote strike +through text with hyphen characters: + +--------------------------------------------------------------------- + ifdef::basebackend-html[] + + [quotes] + -=strikethrough + + [tags] + strikethrough=<del>|</del> + + endif::basebackend-html[] +--------------------------------------------------------------------- + + +== Where can I find examples of commands used to build output documents? + +The User Guide has some. You could also look at `./doc/main.aap` and +`./examples/website/main.aap` in the AsciiDoc distribution, they have +all the commands used to build the AsciiDoc documentation and the +AsciiDoc website (even if you don't use A-A-P you'll still find it +useful). + + +== Why have you used the DocBook <simpara> element instead of <para>? + +`<simpara>` is really the same as `<para>` except it can't contain +block elements -- this matches, more closely, the AsciiDoc paragraph +semantics. + + +== How can I format text inside a listing block? + +By default only 'specialcharacters' and 'callouts' are substituted in +listing blocks; you can add quotes substitutions by explicitly setting +the block 'subs' attribute, for example: + +[listing] +.......................................... +[subs="quotes"] +------------------------------------------ +$ ls *-al* +------------------------------------------ +.......................................... + +The `-al` will rendered bold. Note that: + +- You would need to explicitly escape text you didn't want quoted. +- Don't do this in source code listing blocks because it modifies the + source code which confuses the syntax highlighter. +- This only works if your DocBook processor recognizes DocBook + `<emphasis>` elements inside `<screen>` elements. + +Alternative, if the lines are contiguous, you could use the 'literal' +paragraph style: + +------------------------------------------ +["literal",subs="quotes"] +$ ls *-al* +------------------------------------------ + + +== Why doesn't the include1::[] macro work? + +Internally the `include1` macro is translated to the `include1` system +attribute which means it must be evaluated in a region where attribute +substitution is enabled. `include1` won't work, for example, in a +ListingBlock (unless attribute substitution is enabled). `include1` +is intended for use in configuration files, use the `include` macro +and set the attribute `depth=1` instead, for example: + +[listing] +................................................ +------------------------------------------------ +\include::blogpost_media_processing.txt[depth=1] +------------------------------------------------ +................................................ + + +== How can I make the mailto macro work with multiple email addresses? + +For the AsciiDoc 'mailto' macro to work with multiple email addresses +(as per RFC2368) you need to URL encode the '@' characters (replace +them with '%40'), if you don't the individual addresses will be +rendered as separate links. You also need to <<X1,replace spaces with +'%20'>>. + +For example, the following call won't work: + + mailto:jb@foobar.com,jd@acme.co.nz?subject=New foofoo release[New foofoo release] + +Use this instead: + + mailto:jb%40foobar.com,jd%40acme.co.nz?subject=New%20foofoo%20release[New foofoo release] + + +== How can a replacement have a trailing backslash? +Quote the entry name -- this nonsensical example replaces `x\` with +`y`: + + "x\\"=y + +If quoting were omitted the equals character (separating the +entry name `x` from the value `y`) would be escaped. + + diff --git a/doc/latex-backend.txt b/doc/latex-backend.txt index a090555..32d87df 100644 --- a/doc/latex-backend.txt +++ b/doc/latex-backend.txt @@ -1,192 +1,192 @@ -LaTeX backend for Asciidoc
-==========================
-Benjamin Klum <benjamin.klum@gmail.com>
-v1.0, June 2006
-
-== Introduction
-
-
-LaTeX backend is a configuration file for Stuart Rackham's http://www.methods.co.nz/asciidoc/[Asciidoc]. It generates high-level LaTeX markup from Asciidoc documents. LaTeX is a document preparation system for TeX which in turn is a popular typesetting system. It is well known for producing excellently typesetted high quality printouts, especially suited for scientific text.
-
-== Tutorial
-Getting a ready-to-print document from an Asciidoc document using the LaTeX backend involves at least two steps:
-
-1. Conversion of the Asciidoc document into a LaTeX document (this is done by Asciidoc using the LaTeX backend)
-2. Conversion of the LaTeX document into a PDF document (this is done by the TeX system)
-
-Try to create a PDF document from the Asciidoc document `article.txt` which resides in the `doc` directory of Asciidoc:
-
-.. Make a copy of `article.txt` in a directory of your choice, let's call it `latex-test`.
-.. Make sure that all images referenced in `article.txt` exist in `latex-test`. Brute force approach: Copy the whole `images` directory from Asciidoc directory into `latex-test`.
-.. Change directory to `latex-test` and type following commands:
-+
- asciidoc --unsafe --backend=latex article.txt
- pdflatex article.tex
-+
-.. Now there should be a file `article.pdf` in the `latex-test` directory.
-
-[IMPORTANT]
-==============================
-- Asciidoc has to be started in 'unsafe mode' when using LaTeX backend.
-- Note that some special LaTeX packages are necessary, see <<packageRequirements,here>>.
-==============================
-
-== General notes
-
-=== Quality of LaTeX output
-High-level LaTeX is not very straightforward to generate. Therefore there's no guarantee that the generated output is valid and compiles successfully. At all, this backend should be considered as rather experimental. You should have been already in touch with LaTeX in order to use the backend effectively because LaTeX compilation errors can be really nasty.
-
-Nevertheless good results can be achieved by using LaTeX backend. Try for example to compile Stuart Rackham's Asciidoc documentation, a rather large document. It should compile without problems. However, the code filter might have to be reconfigured for the code filter example to work.
-
-=== Configuration file customization
-Like every other Asciidoc backend the LaTeX backend can be customized easily to fit the user's needs. Actually it is very important to have this option since LaTeX doesn't have a companion language like CSS which allows to put styling information in a separate file. Read more about the LaTeX backend configuration file <<configurationFile,here>>.
-
-=== Output optimization
-The LaTeX output is optimized for creating PDF documents using 'pdflatex'.
-
-[[unicodeSupport]]
-=== Unicode support
-Unfortunately TeX/LaTeX does not have native unicode support. The package 'ucs' adds elementary unicode support by introducing UTF-8 input encoding recognition and by defining lookup tables which contain the corresponding LaTeX commands for unicode characters. But these lookup tables are far from being complete. When a unicode character is found which is not defined in the lookup tables an error is raised by the TeX/LaTeX compiler. Note that TeX/LaTeX compilation errors caused by missing unicode character definitions are not fatal, that means the result is probably readable but undefined unicode characters are replaced with `[U+...]`. You may (de)activate the recognition of escaped unicode characters. See the <<latex-recognize-escaped-unicode>> backend option.
-
-== Backend specific features
-
-=== Special sections
-
-LaTeX backend supports the following special sections and replaces them with corresponding LaTeX commands or environments:
-
-- Abstract (only for document type 'article')
-- Dedication (only for document type 'book')
-- Index
-- Bibliography (only when the attribute 'latex-use-bibliography-environment' is set)
-- Appendix
-- Contents
-
-[[internalCrossReferences]]
-=== Internal cross references
-
-Macros for internal cross references have been extended by the attribute 'style'.
-
- xref:<id>[<caption>, style=<style>]
-
-or
-
- <<<id>,<caption>,<style>>>
-
-
-The additional attribute 'style' can have following values:
-
-page::
-Let's LaTeX print the page number of the referenced anchor.
-
-ref::
-Let's LaTeX print the number of the section, subsection, figure, table or theorem the referenced anchor resides.
-
-autoref::
-Let's LaTeX print the number of the section, subsection, figure, table or theorem the referenced anchor resides preceded with a contextual label.
-
-cite::
-Let's LaTeX interprete this reference as a reference to a bibliography entry. If the attribute 'latex-use-bibliography-environment' is set, references with 'cite' style as well as their corresponding bibliography anchors are presented as automatically generated numbers.
-
-If the 'style' attribute is not set the reference is printed the common way.
-
-
-=== Options
-LaTeX document generation is influenced by the following attributes:
-
-latex-table-rowlimit::
-The maximum number of rows for typesetting tables using the 'tabular' environment. If a table has more rows than 'latex-table-rowlimit', 'longtable' environment is used instead of 'tabular' environment. 'longtable' environment supports tables spanning over several pages.
-
-latex-use-bibliography-environment::
-If 'latex-use-bibliography-environment' is defined, 'thebibliography' environment is used for the bibliography section. As a result bibliography entries are automatically numbered. Note that this works only if the bibliography section contains exclusively bibliography list items which start with a bibliography entry ([[[...]]]). Otherwise a TeX/LaTeX compilation error will occur. In order to display bibliography references correctly their 'style' attribute must be set to 'cite'. For more information see <<internalCrossReferences,Internal cross references>>.
-
-latex-indent-paragraphs::
-If 'latex-indent-paragraphs' is defined, the first line of paragraphs will be indented. By default LaTeX backend prevents paragraph indentation and prints paragraphs with preceding vertical space.
-
-[[latex-recognize-escaped-unicode]] latex-recognize-escaped-unicode::
-If 'latex-recognize-escaped-unicode' is defined, escaped unicode
-characters (e.g. `\$${amp}#960;$$` or `\$${amp}#x3C0;$$`) will be recognized. This can lead to LaTeX compilation errors since LaTeX unicode support is only rudimentary. For more information see <<unicodeSupport, Unicode support>>.
-
-latex-use-custom-list-items::
-If 'latex-use-custom-list-items' is defined, lists will be bulleted or enumerated the way you have typed them in the original Asciidoc document. That means, `*` turns into a circle bullet, `-` turns into a dash, `.` turns into a number and `..` turns into a letter. Otherwise LaTeX will use different bullets and enumeration characters depending on the level of nesting.
-
-latex-use-colored-tables::
-If 'latex-use-colored-tables' is defined, tables will be printed colored.
-
-latex-use-running-title-headings::
-If 'latex-use-running-title-headings' is defined, 'pagestyle' will be set to 'headings' which results in running titles in the head.
-
-latex-use-colored-sidebar-blocks::
-If 'latex-use-colored-sidebar-blocks' is defined, sidebar block content will be put in a color box instead of being indented by a vertical bar.
-
-icons::
-Link admonition paragraph and admonition block icon images and badge images. By default icons is undefined and text is used in place of icon images.
-
-encoding::
-Set the input and output document character set encoding. Currently `ISO-8859-1` and `UTF-8` are supported.
-
-== Requirements
-
-=== General
-
-The following software is necessary for using the LaTeX backend:
-
-- An up-to-date version of http://www.methods.co.nz/asciidoc/[Asciidoc]
-- An up-to-date TeX distribution, e.g.:
- * http://www.miktex.org/[MiKTeX] for Windows
- * http://www.tug.org/tetex/[teTeX] for Linux
-
-[[packageRequirements]]
-=== TeX/LaTeX Package requirements
-
-LaTeX backend makes use of some LaTeX specialities which don't belong to a minimal TeX/LaTeX distribution. However, I took special care not to employ exotic packages. Hence the following packages should be available in most package repositories. The table is not complete yet because I don't know the package names for all TeX distributions.
-
-[cols="4*,4",options="header"]
-|====================================================================
-|Speciality | MiKTeX package name | teTeX package name | TeX Live package name | Description
-|KOMA-Script | koma-script | | | LaTeX backend uses the document classes 'scrartcl' and 'scrbook' as well as some other specialities defined in the 'KOMA-Script' package, e.g. the commands `\addmargin{}` and `\minisec{}`.
-|xcolor.sty | xcolor | | | Used to produce colored boxes and tables.
-|colortbl.sty | colortbl | | | Used to produce colored tables.
-|type1ec.sty | cm-super | | | Enables high quality fonts for PDF output.
-|hyperref.sty | hyperref | | | Extensive support for hypertext in PDF documents.
-|enumerate.sty | tools | | | When 'latex-use-custom-list-items' is defined this package is used for determining the enumeration character.
-|graphicx.sty | graphics | | | Used for including images.
-|longtable.sty | tools | | | Enables page spanning tables.
-|ucs.sty | unicode | | | Enables support for unicode characters.
-|textcomp | ltxbase | | | Used for printing various symbols like arrows. Should be already installed.
-|alltt | ltxbase | | | Used in literal-like blocks for retaining line and whitespace formatting. Should be already installed.
-|listings.sty | listings | | | Used for listing blocks.
-|====================================================================
-
-[[configurationFile]]
-== About the LaTeX backend configuration file
-An important note for people who want to adapt the LaTeX backend configuration file to their own needs:
-
-LaTeX markup has a lot of special characters, most importantly ``, `{`, `}`. In order to make things less complicated, I changed the default substitution order (see entry 'subsnormal' in the `[miscellaneous]` section). In contrast to the backends 'docbook' and 'xhtml11', the 'specialcharacters' substitution is applied very late. As a result all special characters produced by 'quotes', 'specialwords', 'replacements', 'attributes' and 'macros' become escaped at the end. If you don't want special characters in the corresponding sections to get escaped, you've to use following symbols instead of the special characters.
-
-- `\$$!..backslash..!$$` instead of ``
-- `\$$!..braceleft..!$$` instead of `{`
-- `\$$!..braceright..!$$` instead of `}`
-
-
-For more special characters take a look in the `[replacements2]` sections. `[replacements2]` section is responsible for replacing the symbols with their corresponding special characters.
-
-
-== Ideas
-
-=== Code listing block
-
-For creating highlighted code listings I suggest the use of http://www.andre-simon.de/[Highlight] or http://www.gnu.org/software/src-highlite/[GNU Source Highlight]. Both are suited for use as Asciidoc filters.
-
-== Known Bugs
-
-- Sometimes LaTeX backend handles things differently from the default backends
-- A lot of little bugs
-
-== Todo List
-
-- Remove bugs
-- Support for 'grid' attribute in tables
-- Better looking tables
-- Option for squeezing output (smaller lists)
-- Support for different languages (That would be a nice feature for Asciidoc in general)
-- Option for switching titlepage on and off
+LaTeX backend for Asciidoc +========================== +Benjamin Klum <benjamin.klum@gmail.com> +v1.0, June 2006 + +== Introduction + + +LaTeX backend is a configuration file for Stuart Rackham's http://www.methods.co.nz/asciidoc/[Asciidoc]. It generates high-level LaTeX markup from Asciidoc documents. LaTeX is a document preparation system for TeX which in turn is a popular typesetting system. It is well known for producing excellently typesetted high quality printouts, especially suited for scientific text. + +== Tutorial +Getting a ready-to-print document from an Asciidoc document using the LaTeX backend involves at least two steps: + +1. Conversion of the Asciidoc document into a LaTeX document (this is done by Asciidoc using the LaTeX backend) +2. Conversion of the LaTeX document into a PDF document (this is done by the TeX system) + +Try to create a PDF document from the Asciidoc document `article.txt` which resides in the `doc` directory of Asciidoc: + +.. Make a copy of `article.txt` in a directory of your choice, let's call it `latex-test`. +.. Make sure that all images referenced in `article.txt` exist in `latex-test`. Brute force approach: Copy the whole `images` directory from Asciidoc directory into `latex-test`. +.. Change directory to `latex-test` and type following commands: ++ + asciidoc --unsafe --backend=latex article.txt + pdflatex article.tex ++ +.. Now there should be a file `article.pdf` in the `latex-test` directory. + +[IMPORTANT] +============================== +- Asciidoc has to be started in 'unsafe mode' when using LaTeX backend. +- Note that some special LaTeX packages are necessary, see <<packageRequirements,here>>. +============================== + +== General notes + +=== Quality of LaTeX output +High-level LaTeX is not very straightforward to generate. Therefore there's no guarantee that the generated output is valid and compiles successfully. At all, this backend should be considered as rather experimental. You should have been already in touch with LaTeX in order to use the backend effectively because LaTeX compilation errors can be really nasty. + +Nevertheless good results can be achieved by using LaTeX backend. Try for example to compile Stuart Rackham's Asciidoc documentation, a rather large document. It should compile without problems. However, the code filter might have to be reconfigured for the code filter example to work. + +=== Configuration file customization +Like every other Asciidoc backend the LaTeX backend can be customized easily to fit the user's needs. Actually it is very important to have this option since LaTeX doesn't have a companion language like CSS which allows to put styling information in a separate file. Read more about the LaTeX backend configuration file <<configurationFile,here>>. + +=== Output optimization +The LaTeX output is optimized for creating PDF documents using 'pdflatex'. + +[[unicodeSupport]] +=== Unicode support +Unfortunately TeX/LaTeX does not have native unicode support. The package 'ucs' adds elementary unicode support by introducing UTF-8 input encoding recognition and by defining lookup tables which contain the corresponding LaTeX commands for unicode characters. But these lookup tables are far from being complete. When a unicode character is found which is not defined in the lookup tables an error is raised by the TeX/LaTeX compiler. Note that TeX/LaTeX compilation errors caused by missing unicode character definitions are not fatal, that means the result is probably readable but undefined unicode characters are replaced with `[U+...]`. You may (de)activate the recognition of escaped unicode characters. See the <<latex-recognize-escaped-unicode>> backend option. + +== Backend specific features + +=== Special sections + +LaTeX backend supports the following special sections and replaces them with corresponding LaTeX commands or environments: + +- Abstract (only for document type 'article') +- Dedication (only for document type 'book') +- Index +- Bibliography (only when the attribute 'latex-use-bibliography-environment' is set) +- Appendix +- Contents + +[[internalCrossReferences]] +=== Internal cross references + +Macros for internal cross references have been extended by the attribute 'style'. + + xref:<id>[<caption>, style=<style>] + +or + + <<<id>,<caption>,<style>>> + + +The additional attribute 'style' can have following values: + +page:: +Let's LaTeX print the page number of the referenced anchor. + +ref:: +Let's LaTeX print the number of the section, subsection, figure, table or theorem the referenced anchor resides. + +autoref:: +Let's LaTeX print the number of the section, subsection, figure, table or theorem the referenced anchor resides preceded with a contextual label. + +cite:: +Let's LaTeX interprete this reference as a reference to a bibliography entry. If the attribute 'latex-use-bibliography-environment' is set, references with 'cite' style as well as their corresponding bibliography anchors are presented as automatically generated numbers. + +If the 'style' attribute is not set the reference is printed the common way. + + +=== Options +LaTeX document generation is influenced by the following attributes: + +latex-table-rowlimit:: +The maximum number of rows for typesetting tables using the 'tabular' environment. If a table has more rows than 'latex-table-rowlimit', 'longtable' environment is used instead of 'tabular' environment. 'longtable' environment supports tables spanning over several pages. + +latex-use-bibliography-environment:: +If 'latex-use-bibliography-environment' is defined, 'thebibliography' environment is used for the bibliography section. As a result bibliography entries are automatically numbered. Note that this works only if the bibliography section contains exclusively bibliography list items which start with a bibliography entry ([[[...]]]). Otherwise a TeX/LaTeX compilation error will occur. In order to display bibliography references correctly their 'style' attribute must be set to 'cite'. For more information see <<internalCrossReferences,Internal cross references>>. + +latex-indent-paragraphs:: +If 'latex-indent-paragraphs' is defined, the first line of paragraphs will be indented. By default LaTeX backend prevents paragraph indentation and prints paragraphs with preceding vertical space. + +[[latex-recognize-escaped-unicode]] latex-recognize-escaped-unicode:: +If 'latex-recognize-escaped-unicode' is defined, escaped unicode +characters (e.g. `\$${amp}#960;$$` or `\$${amp}#x3C0;$$`) will be recognized. This can lead to LaTeX compilation errors since LaTeX unicode support is only rudimentary. For more information see <<unicodeSupport, Unicode support>>. + +latex-use-custom-list-items:: +If 'latex-use-custom-list-items' is defined, lists will be bulleted or enumerated the way you have typed them in the original Asciidoc document. That means, `*` turns into a circle bullet, `-` turns into a dash, `.` turns into a number and `..` turns into a letter. Otherwise LaTeX will use different bullets and enumeration characters depending on the level of nesting. + +latex-use-colored-tables:: +If 'latex-use-colored-tables' is defined, tables will be printed colored. + +latex-use-running-title-headings:: +If 'latex-use-running-title-headings' is defined, 'pagestyle' will be set to 'headings' which results in running titles in the head. + +latex-use-colored-sidebar-blocks:: +If 'latex-use-colored-sidebar-blocks' is defined, sidebar block content will be put in a color box instead of being indented by a vertical bar. + +icons:: +Link admonition paragraph and admonition block icon images and badge images. By default icons is undefined and text is used in place of icon images. + +encoding:: +Set the input and output document character set encoding. Currently `ISO-8859-1` and `UTF-8` are supported. + +== Requirements + +=== General + +The following software is necessary for using the LaTeX backend: + +- An up-to-date version of http://www.methods.co.nz/asciidoc/[Asciidoc] +- An up-to-date TeX distribution, e.g.: + * http://www.miktex.org/[MiKTeX] for Windows + * http://www.tug.org/tetex/[teTeX] for Linux + +[[packageRequirements]] +=== TeX/LaTeX Package requirements + +LaTeX backend makes use of some LaTeX specialities which don't belong to a minimal TeX/LaTeX distribution. However, I took special care not to employ exotic packages. Hence the following packages should be available in most package repositories. The table is not complete yet because I don't know the package names for all TeX distributions. + +[cols="4*,4",options="header"] +|==================================================================== +|Speciality | MiKTeX package name | teTeX package name | TeX Live package name | Description +|KOMA-Script | koma-script | | | LaTeX backend uses the document classes 'scrartcl' and 'scrbook' as well as some other specialities defined in the 'KOMA-Script' package, e.g. the commands `\addmargin{}` and `\minisec{}`. +|xcolor.sty | xcolor | | | Used to produce colored boxes and tables. +|colortbl.sty | colortbl | | | Used to produce colored tables. +|type1ec.sty | cm-super | | | Enables high quality fonts for PDF output. +|hyperref.sty | hyperref | | | Extensive support for hypertext in PDF documents. +|enumerate.sty | tools | | | When 'latex-use-custom-list-items' is defined this package is used for determining the enumeration character. +|graphicx.sty | graphics | | | Used for including images. +|longtable.sty | tools | | | Enables page spanning tables. +|ucs.sty | unicode | | | Enables support for unicode characters. +|textcomp | ltxbase | | | Used for printing various symbols like arrows. Should be already installed. +|alltt | ltxbase | | | Used in literal-like blocks for retaining line and whitespace formatting. Should be already installed. +|listings.sty | listings | | | Used for listing blocks. +|==================================================================== + +[[configurationFile]] +== About the LaTeX backend configuration file +An important note for people who want to adapt the LaTeX backend configuration file to their own needs: + +LaTeX markup has a lot of special characters, most importantly ``, `{`, `}`. In order to make things less complicated, I changed the default substitution order (see entry 'subsnormal' in the `[miscellaneous]` section). In contrast to the backends 'docbook' and 'xhtml11', the 'specialcharacters' substitution is applied very late. As a result all special characters produced by 'quotes', 'specialwords', 'replacements', 'attributes' and 'macros' become escaped at the end. If you don't want special characters in the corresponding sections to get escaped, you've to use following symbols instead of the special characters. + +- `\$$!..backslash..!$$` instead of `` +- `\$$!..braceleft..!$$` instead of `{` +- `\$$!..braceright..!$$` instead of `}` + + +For more special characters take a look in the `[replacements2]` sections. `[replacements2]` section is responsible for replacing the symbols with their corresponding special characters. + + +== Ideas + +=== Code listing block + +For creating highlighted code listings I suggest the use of http://www.andre-simon.de/[Highlight] or http://www.gnu.org/software/src-highlite/[GNU Source Highlight]. Both are suited for use as Asciidoc filters. + +== Known Bugs + +- Sometimes LaTeX backend handles things differently from the default backends +- A lot of little bugs + +== Todo List + +- Remove bugs +- Support for 'grid' attribute in tables +- Better looking tables +- Option for squeezing output (smaller lists) +- Support for different languages (That would be a nice feature for Asciidoc in general) +- Option for switching titlepage on and off diff --git a/doc/main.aap b/doc/main.aap index 9d24cd6..0bb2443 100644 --- a/doc/main.aap +++ b/doc/main.aap @@ -1,229 +1,229 @@ -#####################################################################
-#
-# A-A-P file for making AsciiDoc distribution documentation.
-# (you can obtain A-A-P from http://www.a-a-p.org)
-#
-# Stuart Rackham <srackham@gmail.com>
-#####################################################################
-
-:execute ../common.aap
-
-ASCIIDOC = python ../asciidoc.py -a revnumber=$(VERS)@ -a revdate="$(DATE)@"
-A2X = python ../a2x.py
-
-:syseval which fop | :assign FOP
-@if not _no.FOP:
- :syseval which fop.sh | :assign FOP
-:syseval which lynx | :assign LYNX # Converts HTML to text.
-:syseval which xmllint | :assign XMLLINT # Validates XML.
-:syseval which dblatex | :assign DBLATEX # Converts DocBook XML to PDF.
-:syseval which aspell | :assign ASPELL
-:syseval which xsltproc | :assign XSLTPROC
-
-ROOT = asciidoc asciidoc.1
-INFILES = $*(ROOT).txt
-CHUNK_DIR = ./asciidoc.chunked
-HTMLHELP_DIR = ./asciidoc.htmlhelp
-HTMLHELP_FILE = asciidoc
-
-OUTFILES = $*(ROOT).html $*(ROOT).css.html $*(ROOT).css-embedded.html \
- asciidoc.pdf asciidoc.1.man a2x.1.man \
- article.html book.html book-multi.html asciidoc.xml asciidoc.1.xml \
- ../BUGS ../CHANGELOG ../README ../INSTALL \
- latex-backend.html \
- $HTMLHELP_DIR/index.html \
- $CHUNK_DIR/index.html \
- article.pdf \
- latexmath.pdf \
- latex-filter.pdf \
- source-highlight-filter.pdf \
- music-filter.pdf \
- book.epub \
- article-standalone.html
-
-TEST_FILES = $*(ROOT).css-embedded.html
- article.css-embedded.html book.css-embedded.html \
- article.xml book.xml book-multi.xml asciidoc.xml asciidoc.1.xml \
- asciidoc.1.html a2x.1.xml music-filter.xml \
- book.epub asciidoc.epub \
-
-
-#####################################################################
-# Filetype build rules.
-#####################################################################
-
-:rule %.epub : %.txt
- :sys $A2X -f epub -d book --epubcheck --icons $source
-
-:rule %.text : %.txt
- # Convert AsciiDoc to HTML then use lynx(1) to convert HTML to text.
- @if not _no.LYNX:
- :print WARNING: lynx(1) unavailable: skipping $target file generation
- @else:
- opt = -f ../text.conf
- @if source_list[0] == 'asciidoc.1.txt':
- opt += -d manpage
- @else:
- opt += -n
- :sys $ASCIIDOC $opt -b html4 -o - $source | \
- lynx -dump -stdin > $target
-
-:rule %.css.html : %.txt
- opt =
- @if source_list[0] == 'asciidoc.1.txt':
- opt += -d manpage
- @else:
- opt += -n
- opt += -a toc -a toclevels=2 -a scriptsdir=../javascripts
- :sys $ASCIIDOC $opt -b xhtml11 -a linkcss -a icons -a stylesdir=../stylesheets -o $target $(source[0])
- @if _no.XMLLINT:
- :sys $XMLLINT --nonet --noout --valid $target
- @else:
- :print WARNING: xmllint(1) unavailable: skipping validation
-
-:rule %.css-embedded.html : %.txt
- opt =
- @if source_list[0] == 'asciidoc.1.txt':
- opt += -d manpage
- @else:
- opt += -n
- opt += -a toc -a toclevels=2
- :sys $ASCIIDOC -b xhtml11 $opt -o $target $(source[0])
- @if _no.XMLLINT:
- :sys $XMLLINT --nonet --noout --valid $target
- @else:
- :print WARNING: xmllint(1) unavailable: skipping validation
-
-:rule %.xml : %.txt
- opt =
- @if source_list[0] in ('asciidoc.1.txt','a2x.1.txt'):
- opt += -d manpage
- @else:
- opt += -n
- @if source_list[0] == 'asciidoc.txt' or source_list[0].startswith('book'):
- opt += -d book
- :sys $ASCIIDOC $opt -b docbook $(source[0])
- @if _no.XMLLINT:
- :sys $XMLLINT --nonet --noout --valid $target
- @else:
- :print WARNING: xmllint(1) unavailable: skipping validation
-
-:rule %.sgml : %.txt
- opt =
- @if source_list[0] in ('asciidoc.1.txt','a2x.1.txt'):
- opt += -d manpage
- @if source_list[0] == 'asciidoc.txt' or source_list[0].startswith('book'):
- opt += -d book
- :sys $ASCIIDOC $opt -b docbook-sgml $(source[0])
-
-:rule %.html: %.xml
- :sys $XSLTPROC --nonet --stringparam admon.textlabel 0 --stringparam html.stylesheet ./docbook-xsl.css ../docbook-xsl/xhtml.xsl $source >$target
-
-:rule %.man : %.xml
- :sys $XSLTPROC --nonet ../docbook-xsl/manpage.xsl $source
- :sys touch $target # Dummy target.
-
-:rule %.fo: %.xml
- :sys $XSLTPROC --nonet --stringparam admon.textlabel 0 ../docbook-xsl/fo.xsl $source >$target
-
-# This kludge forces the User Guide and LaTeX related PDFs to be generated
-# using dblatex so we include a dblatex example in the distribution.
-@if _no.DBLATEX:
- asciidoc.pdf: asciidoc.txt
- :sys $ASCIIDOC -b docbook $(source[0])
- :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target asciidoc.xml
- latexmath.pdf: latexmath.xml
- :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target $source
- latex-filter.pdf: latex-filter.xml
- :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target $source
-
-# Force the Source Highlighter PDF to be generated using dblatex
-# because dblatex has builtin source code highlighting.
-@if _no.DBLATEX:
- source-highlight-filter.pdf: source-highlight-filter.xml
- :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target $source
-
-@if _no.FOP:
- :rule %.pdf: %.fo
- :sys $FOP $source $target
-@elif _no.DBLATEX:
- # Fall back to dblatex if no FOP.
- :rule %.pdf: %.xml
- :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target $source
-@else:
- :rule %.pdf:
- :print WARNING: PDF processor unavailable: skipping $target file generation
-
-
-#####################################################################
-# Explicit file generation (cases that don't fit the rules).
-#####################################################################
-
-article-standalone.html: article.txt
- :sys $ASCIIDOC -a data-uri -a icons -a toc -a max-width=55em -o $target $source
-
-asciidoc.1.html: asciidoc.1.txt
- :sys $ASCIIDOC -d manpage -b html4 $source
- @if _no.XMLLINT:
- :sys $XMLLINT --nonet --noout --valid --html $target
- @else:
- :print WARNING: xmllint(1) unavailable: skipping validation
-
-# User Guide 'chunked' into linked HTML pages.
-$CHUNK_DIR/index.html: asciidoc.txt
- :sys $A2X -fchunked -dbook --icons -D ./ asciidoc.txt
-
-# HTML Help formatted User Guide.
-$HTMLHELP_DIR/index.html: asciidoc.xml
- :sys $A2X -fhtmlhelp -dbook --icons -D ./ asciidoc.txt
-
-../BUGS: ../BUGS.text
- # Make BUGS.text and copy to BUGS.
- :copy ../BUGS.text ../BUGS
-
-../CHANGELOG: ../CHANGELOG.text
- # Make CHANGELOG.text and copy to CHANGELOG.
- :copy ../CHANGELOG.text ../CHANGELOG
-
-../README: ../README.text
- # Make README.text and copy to README.
- :copy ../README.text ../README
-
-../INSTALL: ../INSTALL.text
- # Make INSTALL.text and copy to INSTALL.
- :copy ../INSTALL.text ../INSTALL
-
-asciimathml.html: asciimathml.txt
- :sys $ASCIIDOC -a asciimath $source
- # No xmllint(1) checking -- fails on embedded JavaScript.
-
-latexmathml.html: latexmathml.txt
- :sys $ASCIIDOC -a latexmath $source
- # No xmllint(1) checking -- fails on embedded JavaScript.
-
-
-#####################################################################
-# Build commands.
-#####################################################################
-
-all: $OUTFILES
-
-clean:
- :del {f} $OUTFILES $TEST_FILES
- :del {f} *.bak # Remove aspell backups.
-
-spell: $INFILES ../CHANGELOG.txt ../README.txt ../BUGS.txt ../INSTALL.txt \
- a2x.1.txt faq.txt asciidocapi.txt testasciidoc.txt \
- epub-notes.txt publishing-ebooks-with-asciidoc.txt \
- source-highlight-filter.txt \
- slidy.txt slidy-example.txt
- # Interactively spell check all files.
- @for s in source_list:
- :sys {i} $ASPELL check -p ./asciidoc.dict $s
-
-clean_testfiles:
- :del {f} $TEST_FILES
- :del {f} music*.png # Force Lilypond to run.
-
-test: clean_testfiles $TEST_FILES
- # Force generation and validation of .html and Docbook (.xml) files.
+##################################################################### +# +# A-A-P file for making AsciiDoc distribution documentation. +# (you can obtain A-A-P from http://www.a-a-p.org) +# +# Stuart Rackham <srackham@gmail.com> +##################################################################### + +:execute ../common.aap + +ASCIIDOC = python ../asciidoc.py -a revnumber=$(VERS)@ -a revdate="$(DATE)@" +A2X = python ../a2x.py + +:syseval which fop | :assign FOP +@if not _no.FOP: + :syseval which fop.sh | :assign FOP +:syseval which lynx | :assign LYNX # Converts HTML to text. +:syseval which xmllint | :assign XMLLINT # Validates XML. +:syseval which dblatex | :assign DBLATEX # Converts DocBook XML to PDF. +:syseval which aspell | :assign ASPELL +:syseval which xsltproc | :assign XSLTPROC + +ROOT = asciidoc asciidoc.1 +INFILES = $*(ROOT).txt +CHUNK_DIR = ./asciidoc.chunked +HTMLHELP_DIR = ./asciidoc.htmlhelp +HTMLHELP_FILE = asciidoc + +OUTFILES = $*(ROOT).html $*(ROOT).css.html $*(ROOT).css-embedded.html \ + asciidoc.pdf asciidoc.1.man a2x.1.man \ + article.html book.html book-multi.html asciidoc.xml asciidoc.1.xml \ + ../BUGS ../CHANGELOG ../README ../INSTALL \ + latex-backend.html \ + $HTMLHELP_DIR/index.html \ + $CHUNK_DIR/index.html \ + article.pdf \ + latexmath.pdf \ + latex-filter.pdf \ + source-highlight-filter.pdf \ + music-filter.pdf \ + book.epub \ + article-standalone.html + +TEST_FILES = $*(ROOT).css-embedded.html + article.css-embedded.html book.css-embedded.html \ + article.xml book.xml book-multi.xml asciidoc.xml asciidoc.1.xml \ + asciidoc.1.html a2x.1.xml music-filter.xml \ + book.epub asciidoc.epub \ + + +##################################################################### +# Filetype build rules. +##################################################################### + +:rule %.epub : %.txt + :sys $A2X -f epub -d book --epubcheck --icons $source + +:rule %.text : %.txt + # Convert AsciiDoc to HTML then use lynx(1) to convert HTML to text. + @if not _no.LYNX: + :print WARNING: lynx(1) unavailable: skipping $target file generation + @else: + opt = -f ../text.conf + @if source_list[0] == 'asciidoc.1.txt': + opt += -d manpage + @else: + opt += -n + :sys $ASCIIDOC $opt -b html4 -o - $source | \ + lynx -dump -stdin > $target + +:rule %.css.html : %.txt + opt = + @if source_list[0] == 'asciidoc.1.txt': + opt += -d manpage + @else: + opt += -n + opt += -a toc -a toclevels=2 -a scriptsdir=../javascripts + :sys $ASCIIDOC $opt -b xhtml11 -a linkcss -a icons -a stylesdir=../stylesheets -o $target $(source[0]) + @if _no.XMLLINT: + :sys $XMLLINT --nonet --noout --valid $target + @else: + :print WARNING: xmllint(1) unavailable: skipping validation + +:rule %.css-embedded.html : %.txt + opt = + @if source_list[0] == 'asciidoc.1.txt': + opt += -d manpage + @else: + opt += -n + opt += -a toc -a toclevels=2 + :sys $ASCIIDOC -b xhtml11 $opt -o $target $(source[0]) + @if _no.XMLLINT: + :sys $XMLLINT --nonet --noout --valid $target + @else: + :print WARNING: xmllint(1) unavailable: skipping validation + +:rule %.xml : %.txt + opt = + @if source_list[0] in ('asciidoc.1.txt','a2x.1.txt'): + opt += -d manpage + @else: + opt += -n + @if source_list[0] == 'asciidoc.txt' or source_list[0].startswith('book'): + opt += -d book + :sys $ASCIIDOC $opt -b docbook $(source[0]) + @if _no.XMLLINT: + :sys $XMLLINT --nonet --noout --valid $target + @else: + :print WARNING: xmllint(1) unavailable: skipping validation + +:rule %.sgml : %.txt + opt = + @if source_list[0] in ('asciidoc.1.txt','a2x.1.txt'): + opt += -d manpage + @if source_list[0] == 'asciidoc.txt' or source_list[0].startswith('book'): + opt += -d book + :sys $ASCIIDOC $opt -b docbook-sgml $(source[0]) + +:rule %.html: %.xml + :sys $XSLTPROC --nonet --stringparam admon.textlabel 0 --stringparam html.stylesheet ./docbook-xsl.css ../docbook-xsl/xhtml.xsl $source >$target + +:rule %.man : %.xml + :sys $XSLTPROC --nonet ../docbook-xsl/manpage.xsl $source + :sys touch $target # Dummy target. + +:rule %.fo: %.xml + :sys $XSLTPROC --nonet --stringparam admon.textlabel 0 ../docbook-xsl/fo.xsl $source >$target + +# This kludge forces the User Guide and LaTeX related PDFs to be generated +# using dblatex so we include a dblatex example in the distribution. +@if _no.DBLATEX: + asciidoc.pdf: asciidoc.txt + :sys $ASCIIDOC -b docbook $(source[0]) + :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target asciidoc.xml + latexmath.pdf: latexmath.xml + :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target $source + latex-filter.pdf: latex-filter.xml + :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target $source + +# Force the Source Highlighter PDF to be generated using dblatex +# because dblatex has builtin source code highlighting. +@if _no.DBLATEX: + source-highlight-filter.pdf: source-highlight-filter.xml + :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target $source + +@if _no.FOP: + :rule %.pdf: %.fo + :sys $FOP $source $target +@elif _no.DBLATEX: + # Fall back to dblatex if no FOP. + :rule %.pdf: %.xml + :sys $DBLATEX -p ../dblatex/asciidoc-dblatex.xsl -s ../dblatex/asciidoc-dblatex.sty -o $target $source +@else: + :rule %.pdf: + :print WARNING: PDF processor unavailable: skipping $target file generation + + +##################################################################### +# Explicit file generation (cases that don't fit the rules). +##################################################################### + +article-standalone.html: article.txt + :sys $ASCIIDOC -a data-uri -a icons -a toc -a max-width=55em -o $target $source + +asciidoc.1.html: asciidoc.1.txt + :sys $ASCIIDOC -d manpage -b html4 $source + @if _no.XMLLINT: + :sys $XMLLINT --nonet --noout --valid --html $target + @else: + :print WARNING: xmllint(1) unavailable: skipping validation + +# User Guide 'chunked' into linked HTML pages. +$CHUNK_DIR/index.html: asciidoc.txt + :sys $A2X -fchunked -dbook --icons -D ./ asciidoc.txt + +# HTML Help formatted User Guide. +$HTMLHELP_DIR/index.html: asciidoc.xml + :sys $A2X -fhtmlhelp -dbook --icons -D ./ asciidoc.txt + +../BUGS: ../BUGS.text + # Make BUGS.text and copy to BUGS. + :copy ../BUGS.text ../BUGS + +../CHANGELOG: ../CHANGELOG.text + # Make CHANGELOG.text and copy to CHANGELOG. + :copy ../CHANGELOG.text ../CHANGELOG + +../README: ../README.text + # Make README.text and copy to README. + :copy ../README.text ../README + +../INSTALL: ../INSTALL.text + # Make INSTALL.text and copy to INSTALL. + :copy ../INSTALL.text ../INSTALL + +asciimathml.html: asciimathml.txt + :sys $ASCIIDOC -a asciimath $source + # No xmllint(1) checking -- fails on embedded JavaScript. + +latexmathml.html: latexmathml.txt + :sys $ASCIIDOC -a latexmath $source + # No xmllint(1) checking -- fails on embedded JavaScript. + + +##################################################################### +# Build commands. +##################################################################### + +all: $OUTFILES + +clean: + :del {f} $OUTFILES $TEST_FILES + :del {f} *.bak # Remove aspell backups. + +spell: $INFILES ../CHANGELOG.txt ../README.txt ../BUGS.txt ../INSTALL.txt \ + a2x.1.txt faq.txt asciidocapi.txt testasciidoc.txt \ + epub-notes.txt publishing-ebooks-with-asciidoc.txt \ + source-highlight-filter.txt \ + slidy.txt slidy-example.txt + # Interactively spell check all files. + @for s in source_list: + :sys {i} $ASPELL check -p ./asciidoc.dict $s + +clean_testfiles: + :del {f} $TEST_FILES + :del {f} music*.png # Force Lilypond to run. + +test: clean_testfiles $TEST_FILES + # Force generation and validation of .html and Docbook (.xml) files. diff --git a/docbook-xsl/chunked.xsl b/docbook-xsl/chunked.xsl index 940bec2..aafcca0 100644 --- a/docbook-xsl/chunked.xsl +++ b/docbook-xsl/chunked.xsl @@ -1,17 +1,17 @@ -<!--
- Generates chunked XHTML documents from DocBook XML source using DocBook XSL
- stylesheets.
-
- NOTE: The URL reference to the current DocBook XSL stylesheets is
- rewritten to point to the copy on the local disk drive by the XML catalog
- rewrite directives so it doesn't need to go out to the Internet for the
- stylesheets. This means you don't need to edit the <xsl:import> elements on
- a machine by machine basis.
--->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
-<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/chunk.xsl"/>
-<xsl:import href="common.xsl"/>
-<xsl:param name="navig.graphics.path">images/icons/</xsl:param>
-<xsl:param name="admon.graphics.path">images/icons/</xsl:param>
-<xsl:param name="callout.graphics.path" select="'images/icons/callouts/'"/>
-</xsl:stylesheet>
+<!-- + Generates chunked XHTML documents from DocBook XML source using DocBook XSL + stylesheets. + + NOTE: The URL reference to the current DocBook XSL stylesheets is + rewritten to point to the copy on the local disk drive by the XML catalog + rewrite directives so it doesn't need to go out to the Internet for the + stylesheets. This means you don't need to edit the <xsl:import> elements on + a machine by machine basis. +--> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/chunk.xsl"/> +<xsl:import href="common.xsl"/> +<xsl:param name="navig.graphics.path">images/icons/</xsl:param> +<xsl:param name="admon.graphics.path">images/icons/</xsl:param> +<xsl:param name="callout.graphics.path" select="'images/icons/callouts/'"/> +</xsl:stylesheet> diff --git a/docbook-xsl/common.xsl b/docbook-xsl/common.xsl index b83deeb..2e5cbc2 100644 --- a/docbook-xsl/common.xsl +++ b/docbook-xsl/common.xsl @@ -1,106 +1,106 @@ -<!--
- Inlcuded in xhtml.xsl, xhtml.chunked.xsl, htmlhelp.xsl.
- Contains common XSL stylesheets parameters.
- Output documents styled by docbook.css.
--->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
-<xsl:param name="html.stylesheet" select="'docbook-xsl.css'"/>
-
-<xsl:param name="htmlhelp.chm" select="'htmlhelp.chm'"/>
-<xsl:param name="htmlhelp.hhc.section.depth" select="5"/>
-
-<xsl:param name="section.autolabel">
- <xsl:choose>
- <xsl:when test="/processing-instruction('asciidoc-numbered')">1</xsl:when>
- <xsl:otherwise>0</xsl:otherwise>
- </xsl:choose>
-</xsl:param>
-
-<xsl:param name="suppress.navigation" select="0"/>
-<xsl:param name="navig.graphics.extension" select="'.png'"/>
-<xsl:param name="navig.graphics" select="0"/>
-<xsl:param name="navig.graphics.path">images/icons/</xsl:param>
-<xsl:param name="navig.showtitles">0</xsl:param>
-
-<xsl:param name="shade.verbatim" select="0"/>
-<xsl:attribute-set name="shade.verbatim.style">
- <xsl:attribute name="border">0</xsl:attribute>
- <xsl:attribute name="background-color">#E0E0E0</xsl:attribute>
-</xsl:attribute-set>
-
-<xsl:param name="admon.graphics" select="1"/>
-<xsl:param name="admon.graphics.path">images/icons/</xsl:param>
-<xsl:param name="admon.graphics.extension" select="'.png'"/>
-<xsl:param name="admon.style">
- <xsl:text>margin-left: 0; margin-right: 10%;</xsl:text>
-</xsl:param>
-<xsl:param name="admon.textlabel" select="1"/>
-
-<xsl:param name="callout.defaultcolumn" select="'60'"/>
-<xsl:param name="callout.graphics.extension" select="'.png'"/>
-<xsl:param name="callout.graphics" select="'1'"/>
-<xsl:param name="callout.graphics.number.limit" select="'10'"/>
-<xsl:param name="callout.graphics.path" select="'images/icons/callouts/'"/>
-<xsl:param name="callout.list.table" select="'1'"/>
-
-<!-- This does not seem to work. -->
-<xsl:param name="section.autolabel.max.depth" select="2"/>
-
-<xsl:param name="chunk.first.sections" select="1"/>
-<xsl:param name="chunk.section.depth" select="1"/>
-<xsl:param name="chunk.quietly" select="0"/>
-<xsl:param name="chunk.toc" select="''"/>
-<xsl:param name="chunk.tocs.and.lots" select="0"/>
-
-<xsl:param name="html.cellpadding" select="'4px'"/>
-<xsl:param name="html.cellspacing" select="''"/>
-
-<xsl:param name="table.borders.with.css" select="1"/>
-<xsl:param name="table.cell.border.color" select="'#527bbd'"/>
-
-<xsl:param name="table.cell.border.style" select="'solid'"/>
-<xsl:param name="table.cell.border.thickness" select="'1px'"/>
-<xsl:param name="table.footnote.number.format" select="'a'"/>
-<xsl:param name="table.footnote.number.symbols" select="''"/>
-<xsl:param name="table.frame.border.color" select="'#527bbd'"/>
-<xsl:param name="table.frame.border.style" select="'solid'"/>
-<xsl:param name="table.frame.border.thickness" select="'3px'"/>
-<xsl:param name="tablecolumns.extension" select="'1'"/>
-
-<xsl:param name="highlight.source" select="1"/>
-
-<xsl:param name="section.label.includes.component.label" select="1"/>
-
-<!--
- Table of contents inserted by <?asciidoc-toc?> processing instruction.
--->
-<xsl:param name="generate.toc">
- <xsl:choose>
- <xsl:when test="/processing-instruction('asciidoc-toc')">
-article toc,title
-book toc,title,figure,table,example,equation
- <!-- The only way I could find that suppressed book chapter TOCs -->
- <xsl:if test="$generate.section.toc.level != 0">
-chapter toc,title
-part toc,title
-preface toc,title
-qandadiv toc
-qandaset toc
-reference toc,title
-sect1 toc
-sect2 toc
-sect3 toc
-sect4 toc
-sect5 toc
-section toc
-set toc,title
- </xsl:if>
- </xsl:when>
- <xsl:otherwise>
-article nop
-book nop
- </xsl:otherwise>
- </xsl:choose>
-</xsl:param>
-
-</xsl:stylesheet>
+<!-- + Inlcuded in xhtml.xsl, xhtml.chunked.xsl, htmlhelp.xsl. + Contains common XSL stylesheets parameters. + Output documents styled by docbook.css. +--> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> +<xsl:param name="html.stylesheet" select="'docbook-xsl.css'"/> + +<xsl:param name="htmlhelp.chm" select="'htmlhelp.chm'"/> +<xsl:param name="htmlhelp.hhc.section.depth" select="5"/> + +<xsl:param name="section.autolabel"> + <xsl:choose> + <xsl:when test="/processing-instruction('asciidoc-numbered')">1</xsl:when> + <xsl:otherwise>0</xsl:otherwise> + </xsl:choose> +</xsl:param> + +<xsl:param name="suppress.navigation" select="0"/> +<xsl:param name="navig.graphics.extension" select="'.png'"/> +<xsl:param name="navig.graphics" select="0"/> +<xsl:param name="navig.graphics.path">images/icons/</xsl:param> +<xsl:param name="navig.showtitles">0</xsl:param> + +<xsl:param name="shade.verbatim" select="0"/> +<xsl:attribute-set name="shade.verbatim.style"> + <xsl:attribute name="border">0</xsl:attribute> + <xsl:attribute name="background-color">#E0E0E0</xsl:attribute> +</xsl:attribute-set> + +<xsl:param name="admon.graphics" select="1"/> +<xsl:param name="admon.graphics.path">images/icons/</xsl:param> +<xsl:param name="admon.graphics.extension" select="'.png'"/> +<xsl:param name="admon.style"> + <xsl:text>margin-left: 0; margin-right: 10%;</xsl:text> +</xsl:param> +<xsl:param name="admon.textlabel" select="1"/> + +<xsl:param name="callout.defaultcolumn" select="'60'"/> +<xsl:param name="callout.graphics.extension" select="'.png'"/> +<xsl:param name="callout.graphics" select="'1'"/> +<xsl:param name="callout.graphics.number.limit" select="'10'"/> +<xsl:param name="callout.graphics.path" select="'images/icons/callouts/'"/> +<xsl:param name="callout.list.table" select="'1'"/> + +<!-- This does not seem to work. --> +<xsl:param name="section.autolabel.max.depth" select="2"/> + +<xsl:param name="chunk.first.sections" select="1"/> +<xsl:param name="chunk.section.depth" select="1"/> +<xsl:param name="chunk.quietly" select="0"/> +<xsl:param name="chunk.toc" select="''"/> +<xsl:param name="chunk.tocs.and.lots" select="0"/> + +<xsl:param name="html.cellpadding" select="'4px'"/> +<xsl:param name="html.cellspacing" select="''"/> + +<xsl:param name="table.borders.with.css" select="1"/> +<xsl:param name="table.cell.border.color" select="'#527bbd'"/> + +<xsl:param name="table.cell.border.style" select="'solid'"/> +<xsl:param name="table.cell.border.thickness" select="'1px'"/> +<xsl:param name="table.footnote.number.format" select="'a'"/> +<xsl:param name="table.footnote.number.symbols" select="''"/> +<xsl:param name="table.frame.border.color" select="'#527bbd'"/> +<xsl:param name="table.frame.border.style" select="'solid'"/> +<xsl:param name="table.frame.border.thickness" select="'3px'"/> +<xsl:param name="tablecolumns.extension" select="'1'"/> + +<xsl:param name="highlight.source" select="1"/> + +<xsl:param name="section.label.includes.component.label" select="1"/> + +<!-- + Table of contents inserted by <?asciidoc-toc?> processing instruction. +--> +<xsl:param name="generate.toc"> + <xsl:choose> + <xsl:when test="/processing-instruction('asciidoc-toc')"> +article toc,title +book toc,title,figure,table,example,equation + <!-- The only way I could find that suppressed book chapter TOCs --> + <xsl:if test="$generate.section.toc.level != 0"> +chapter toc,title +part toc,title +preface toc,title +qandadiv toc +qandaset toc +reference toc,title +sect1 toc +sect2 toc +sect3 toc +sect4 toc +sect5 toc +section toc +set toc,title + </xsl:if> + </xsl:when> + <xsl:otherwise> +article nop +book nop + </xsl:otherwise> + </xsl:choose> +</xsl:param> + +</xsl:stylesheet> diff --git a/docbook-xsl/epub.xsl b/docbook-xsl/epub.xsl index ad22134..b15748d 100644 --- a/docbook-xsl/epub.xsl +++ b/docbook-xsl/epub.xsl @@ -1,35 +1,35 @@ -<!--
- Generates EPUB XHTML documents from DocBook XML source using DocBook XSL
- stylesheets.
-
- NOTE: The URL reference to the current DocBook XSL stylesheets is
- rewritten to point to the copy on the local disk drive by the XML catalog
- rewrite directives so it doesn't need to go out to the Internet for the
- stylesheets. This means you don't need to edit the <xsl:import> elements on
- a machine by machine basis.
--->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
- <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/epub/docbook.xsl"/>
-<xsl:import href="common.xsl"/>
-
-<!--
-DocBook XSL 1.75.2: Nav headers are invalid XHTML (table width element).
-Suppressed by default in Docbook XSL 1.76.1 epub.xsl.
--->
-<xsl:param name="suppress.navigation" select="1"/>
-
-<!--
-DocBook XLS 1.75.2 doesn't handle TOCs
--->
-<xsl:param name="generate.toc">
- <xsl:choose>
- <xsl:when test="/article">
-/article nop
- </xsl:when>
- <xsl:when test="/book">
-/book nop
- </xsl:when>
- </xsl:choose>
-</xsl:param>
-
-</xsl:stylesheet>
+<!-- + Generates EPUB XHTML documents from DocBook XML source using DocBook XSL + stylesheets. + + NOTE: The URL reference to the current DocBook XSL stylesheets is + rewritten to point to the copy on the local disk drive by the XML catalog + rewrite directives so it doesn't need to go out to the Internet for the + stylesheets. This means you don't need to edit the <xsl:import> elements on + a machine by machine basis. +--> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> + <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/epub/docbook.xsl"/> +<xsl:import href="common.xsl"/> + +<!-- +DocBook XSL 1.75.2: Nav headers are invalid XHTML (table width element). +Suppressed by default in Docbook XSL 1.76.1 epub.xsl. +--> +<xsl:param name="suppress.navigation" select="1"/> + +<!-- +DocBook XLS 1.75.2 doesn't handle TOCs +--> +<xsl:param name="generate.toc"> + <xsl:choose> + <xsl:when test="/article"> +/article nop + </xsl:when> + <xsl:when test="/book"> +/book nop + </xsl:when> + </xsl:choose> +</xsl:param> + +</xsl:stylesheet> diff --git a/docbook-xsl/htmlhelp.xsl b/docbook-xsl/htmlhelp.xsl index 1aaf4cd..f064c0c 100644 --- a/docbook-xsl/htmlhelp.xsl +++ b/docbook-xsl/htmlhelp.xsl @@ -1,16 +1,16 @@ -<!--
- Generates chunked HTML Help HTML documents from DocBook XML source using
- DocBook XSL stylesheets.
-
- NOTE: The URL reference to the current DocBook XSL stylesheets is
- rewritten to point to the copy on the local disk drive by the XML catalog
- rewrite directives so it doesn't need to go out to the Internet for the
- stylesheets. This means you don't need to edit the <xsl:import> elements on
- a machine by machine basis.
--->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
-<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl"/>
-<xsl:import href="common.xsl"/>
-<xsl:param name="htmlhelp.hhp" select="'asciidoc.hhp'"/>
-<xsl:param name="suppress.navigation" select="1"/>
-</xsl:stylesheet>
+<!-- + Generates chunked HTML Help HTML documents from DocBook XML source using + DocBook XSL stylesheets. + + NOTE: The URL reference to the current DocBook XSL stylesheets is + rewritten to point to the copy on the local disk drive by the XML catalog + rewrite directives so it doesn't need to go out to the Internet for the + stylesheets. This means you don't need to edit the <xsl:import> elements on + a machine by machine basis. +--> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl"/> +<xsl:import href="common.xsl"/> +<xsl:param name="htmlhelp.hhp" select="'asciidoc.hhp'"/> +<xsl:param name="suppress.navigation" select="1"/> +</xsl:stylesheet> diff --git a/docbook-xsl/manpage.xsl b/docbook-xsl/manpage.xsl index 0422666..b5201a5 100644 --- a/docbook-xsl/manpage.xsl +++ b/docbook-xsl/manpage.xsl @@ -1,31 +1,31 @@ -<!--
- Generates single roff manpage document from DocBook XML source using DocBook
- XSL stylesheets.
-
- NOTE: The URL reference to the current DocBook XSL stylesheets is
- rewritten to point to the copy on the local disk drive by the XML catalog
- rewrite directives so it doesn't need to go out to the Internet for the
- stylesheets. This means you don't need to edit the <xsl:import> elements on
- a machine by machine basis.
--->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
-<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"/>
-<xsl:import href="common.xsl"/>
-
-<!-- Only render the link text -->
-<xsl:template match="ulink">
- <xsl:variable name="content">
- <xsl:apply-templates/>
- </xsl:variable>
- <xsl:value-of select="$content"/>
-</xsl:template>
-
-<!-- Don't automatically generate the REFERENCES section -->
-<xsl:template name="endnotes.list">
-</xsl:template>
-<!-- Next entry for backward compatibility with old docbook-xsl versions -->
-<xsl:template name="format.links.list">
-</xsl:template>
-
-</xsl:stylesheet>
-
+<!-- + Generates single roff manpage document from DocBook XML source using DocBook + XSL stylesheets. + + NOTE: The URL reference to the current DocBook XSL stylesheets is + rewritten to point to the copy on the local disk drive by the XML catalog + rewrite directives so it doesn't need to go out to the Internet for the + stylesheets. This means you don't need to edit the <xsl:import> elements on + a machine by machine basis. +--> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"/> +<xsl:import href="common.xsl"/> + +<!-- Only render the link text --> +<xsl:template match="ulink"> + <xsl:variable name="content"> + <xsl:apply-templates/> + </xsl:variable> + <xsl:value-of select="$content"/> +</xsl:template> + +<!-- Don't automatically generate the REFERENCES section --> +<xsl:template name="endnotes.list"> +</xsl:template> +<!-- Next entry for backward compatibility with old docbook-xsl versions --> +<xsl:template name="format.links.list"> +</xsl:template> + +</xsl:stylesheet> + diff --git a/docbook-xsl/xhtml.xsl b/docbook-xsl/xhtml.xsl index b5413b7..cdfe27f 100644 --- a/docbook-xsl/xhtml.xsl +++ b/docbook-xsl/xhtml.xsl @@ -1,14 +1,14 @@ -<!--
- Generates single XHTML document from DocBook XML source using DocBook XSL
- stylesheets.
-
- NOTE: The URL reference to the current DocBook XSL stylesheets is
- rewritten to point to the copy on the local disk drive by the XML catalog
- rewrite directives so it doesn't need to go out to the Internet for the
- stylesheets. This means you don't need to edit the <xsl:import> elements on
- a machine by machine basis.
--->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
-<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"/>
-<xsl:import href="common.xsl"/>
-</xsl:stylesheet>
+<!-- + Generates single XHTML document from DocBook XML source using DocBook XSL + stylesheets. + + NOTE: The URL reference to the current DocBook XSL stylesheets is + rewritten to point to the copy on the local disk drive by the XML catalog + rewrite directives so it doesn't need to go out to the Internet for the + stylesheets. This means you don't need to edit the <xsl:import> elements on + a machine by machine basis. +--> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> +<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"/> +<xsl:import href="common.xsl"/> +</xsl:stylesheet> diff --git a/docbook45.conf b/docbook45.conf index a119246..89e7f5c 100644 --- a/docbook45.conf +++ b/docbook45.conf @@ -1,759 +1,759 @@ -#
-# docbook45.conf
-#
-# Asciidoc DocBook 4.5 configuration file.
-#
-
-[miscellaneous]
-outfilesuffix=.xml
-# Printable page width and units.
-# Used to calculate DocBook CALS tables absolute column and table widths.
-pagewidth=425
-pageunits=*
-
-[attributes]
-basebackend=docbook
-basebackend-docbook=
-basebackend-docbook45=
-# For backward compatibility (docbook backend was renamed to docbook45 at 8.6.2)
-backend-docbook=
-# toc and numbered are set to maintain original default behavior.
-toc=
-numbered=
-
-[replacements2]
-# Line break markup. Custom processing instruction in fo.xsl.
-(?m)^(.*)\s\+$=\1<?asciidoc-br?>
-
-[replacements]
-ifdef::asciidoc7compatible[]
-# Superscripts.
-\^(.+?)\^=<superscript>\1</superscript>
-# Subscripts.
-~(.+?)~=<subscript>\1</subscript>
-endif::asciidoc7compatible[]
-
-[ruler-blockmacro]
-# Uses custom processing instructions in fo.xsl and asciidoc-dblatex.xsl.
-<simpara><?asciidoc-hr?></simpara>
-
-[pagebreak-blockmacro]
-# Uses custom processing instructions in fo.xsl and asciidoc-dblatex.xsl.
-<simpara><?asciidoc-pagebreak?></simpara>
-
-[blockdef-pass]
-latexmath-style=template="latexmathblock",subs=[]
-
-[macros]
-# math macros.
-(?su)[\\]?(?P<name>latexmath):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[]
-(?u)^(?P<name>latexmath)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=#[]
-
-[latexmath-inlinemacro]
-<inlineequation>
-<alt><![CDATA[{passtext}]]></alt>
-<inlinemediaobject><textobject><phrase></phrase></textobject></inlinemediaobject>
-</inlineequation>
-
-[latexmath-blockmacro]
-<informalequation>
-<alt><![CDATA[{passtext}]]></alt>
-<mediaobject><textobject><phrase></phrase></textobject></mediaobject>
-</informalequation>
-
-[latexmathblock]
-<equation{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title>
-{title%}<informalequation{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<alt><![CDATA[|]]></alt>
-<mediaobject><textobject><phrase></phrase></textobject></mediaobject>
-{title#}</equation>
-{title%}</informalequation>
-
-[image-inlinemacro]
-<inlinemediaobject>
- <imageobject>
- <imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? contentwidth="{width}"}{height? contentdepth="{height}"}{scale? scale="{scale}"}/>
- </imageobject>
- <textobject><phrase>{alt={target}}</phrase></textobject>
-</inlinemediaobject>
-
-[image-blockmacro]
-<figure{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{pgwide-option? pgwide="1"}><title>{title}</title>
-{title%}<informalfigure{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{pgwide-option?<?dbfo pgwide="1"?>}
-# DocBook XSL Stylesheets custom processing instructions.
-<?dbfo keep-together="{breakable-option#auto}"?>
-<?dbfo keep-together="{unbreakable-option#always}"?>
-<mediaobject>
- <imageobject>
- <imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? contentwidth="{width}"}{height? contentdepth="{height}"}{scale? scale="{scale}"}{scaledwidth? width="{scaledwidth}" scalefit="1"}{align? align="{align}"}/>
- </imageobject>
- <textobject><phrase>{alt={target}}</phrase></textobject>
-</mediaobject>
-{title#}</figure>
-{title%}</informalfigure>
-
-[indexterm-inlinemacro]
-# Index term.
-# Generate separate index entries for primary, secondary and tertiary
-# descriptions.
-# Primary only.
-{2%}<indexterm>
-{2%} <primary>{1}</primary>
-{2%}</indexterm>
-# Primary and secondary.
-{2#}{3%}<indexterm>
-{2#}{3%} <primary>{1}</primary><secondary>{2}</secondary>
-{2#}{3%}</indexterm>
-{2#}{3%}<indexterm>
-{2#}{3%} <primary>{2}</primary>
-{2#}{3%}</indexterm>
-# Primary, secondary and tertiary.
-{3#}<indexterm>
- <primary>{1}</primary><secondary>{2}</secondary><tertiary>{3}</tertiary>
-{3#}</indexterm>
-{3#}<indexterm>
- <primary>{2}</primary><secondary>{3}</secondary>
-{3#}</indexterm>
-{3#}<indexterm>
- <primary>{3}</primary>
-{3#}</indexterm>
-
-[indexterm2-inlinemacro]
-# Index term.
-# Single entry index term that is visible in the primary text flow.
-<indexterm><primary>{1}</primary></indexterm>{1}
-
-[footnote-inlinemacro]
-# Footnote.
-<footnote><simpara>{0}</simpara></footnote>
-
-[footnoteref-inlinemacro]
-# Footnote reference.
-{2#}<footnote id="{1}"><simpara>{2}</simpara></footnote>
-{2%}<footnoteref linkend="{1}" />
-
-[callout-inlinemacro]
-# Callout.
-<co id="{coid}"/>
-
-# List tags.
-[listtags-bulleted]
-list=<itemizedlist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{compact-option? spacing="compact"}>{unbreakable-option? <?dbfo keep-together="{unbreakable-option#always}"?>}{title?<title>{title}</title>}|</itemizedlist>
-item=<listitem>|</listitem>
-text=<simpara>|</simpara>
-
-[listtags-numbered]
-list=<orderedlist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} numeration="{style}"{compact-option? spacing="compact"}>{unbreakable-option? <?dbfo keep-together="{unbreakable-option#always}"?>}{title?<title>{title}</title>}{start?<?dbfo start="{start}"?><?dbhtml start="{start}"?>}|</orderedlist>
-item=<listitem>|</listitem>
-text=<simpara>|</simpara>
-
-[listtags-labeled]
-list=<variablelist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</variablelist>
-entry=<varlistentry>|</varlistentry>
-label=
-term=<term>|</term>
-item=<listitem>|</listitem>
-text=<simpara>|</simpara>
-
-[listtags-horizontal]
-# Horizontal labeled list (implemented with two column table).
-# Hardwired column widths to 30%,70% because the current crop of PDF
-# generators do not auto calculate column widths.
- list=<{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{style? tabstyle="{style}"}{pgwide-option? pgwide="1"} frame="none" colsep="0" rowsep="0">{title?<title>{title}</title>}<tgroup cols="2"><colspec colwidth="{labelwidth=15}*"/><colspec colwidth="{itemwidth=85}*"/><tbody valign="top">|</tbody></tgroup><{title?/table}{title!/informaltable}>
-entry=<row>|</row>
-label=<entry>|</entry>
-term=<simpara>|</simpara>
-item=<entry>|</entry>
-text=<simpara>|</simpara>
-
-[listtags-callout]
-list=<calloutlist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</calloutlist>
-item=<callout arearefs="{coids}">|</callout>
-text=<para>|</para>
-
-[listtags-qanda]
-list=<qandaset{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</qandaset>
-entry=<qandaentry>|</qandaentry>
-label=<question>|</question>
-term=<simpara>|</simpara>
-item=<answer>|</answer>
-text=<simpara>|</simpara>
-
-[listtags-bibliography]
-list=<bibliodiv{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</bibliodiv>
-item=<bibliomixed>|</bibliomixed>
-text=<bibliomisc>|</bibliomisc>
-
-[listtags-glossary]
-list=
-entry=<glossentry>|</glossentry>
-label=
-term=<glossterm>|</glossterm>
-item=<glossdef>|</glossdef>
-text=<simpara>|</simpara>
-
-[tags]
-# Quoted text
-emphasis=<emphasis>{1?<phrase role="{1}">}|{1?</phrase>}</emphasis>
-strong=<emphasis role="strong">{1?<phrase role="{1}">}|{1?</phrase>}</emphasis>
-monospaced=<literal>{1?<phrase role="{1}">}|{1?</phrase>}</literal>
-singlequoted={lsquo}{1?<phrase role="{1}">}|{1?</phrase>}{rsquo}
-doublequoted={ldquo}{1?<phrase role="{1}">}|{1?</phrase>}{rdquo}
-unquoted={1?<phrase role="{1}">}|{1?</phrase>}
-subscript=<subscript>{1?<phrase role="{1}">}|{1?</phrase>}</subscript>
-superscript=<superscript>{1?<phrase role="{1}">}|{1?</phrase>}</superscript>
-
-ifdef::deprecated-quotes[]
-# Override with deprecated quote attributes.
-emphasis={role?<phrase role="{role}">}<emphasis>|</emphasis>{role?</phrase>}
-strong={role?<phrase role="{role}">}<emphasis role="strong">|</emphasis>{role?</phrase>}
-monospaced={role?<phrase role="{role}">}<literal>|</literal>{role?</phrase>}
-singlequoted={role?<phrase role="{role}">}{amp}#8216;|{amp}#8217;{role?</phrase>}
-doublequoted={role?<phrase role="{role}">}{amp}#8220;|{amp}#8221;{role?</phrase>}
-unquoted={role?<phrase role="{role}">}|{role?</phrase>}
-subscript={role?<phrase role="{role}">}<subscript>|</subscript>{role?</phrase>}
-superscript={role?<phrase role="{role}">}<superscript>|</superscript>{role?</phrase>}
-endif::deprecated-quotes[]
-
-# Inline macros
-[http-inlinemacro]
-<ulink url="{name}:{target}">{0={name}:{target}}</ulink>
-[https-inlinemacro]
-<ulink url="{name}:{target}">{0={name}:{target}}</ulink>
-[ftp-inlinemacro]
-<ulink url="{name}:{target}">{0={name}:{target}}</ulink>
-[file-inlinemacro]
-<ulink url="{name}:{target}">{0={name}:{target}}</ulink>
-[irc-inlinemacro]
-<ulink url="{name}:{target}">{0={name}:{target}}</ulink>
-[mailto-inlinemacro]
-<ulink url="mailto:{target}">{0={target}}</ulink>
-[callto-inlinemacro]
-<ulink url="{name}:{target}">{0={target}}</ulink>
-[link-inlinemacro]
-<ulink url="{target}">{0={target}}</ulink>
-# anchor:id[text]
-[anchor-inlinemacro]
-<anchor id="{target}" xreflabel="{0=[{target}]}"/>
-# [[id,text]]
-[anchor2-inlinemacro]
-<anchor id="{1}" xreflabel="{2=[{1}]}"/>
-# [[[id]]]
-[anchor3-inlinemacro]
-<anchor id="{1}" xreflabel="[{1}]"/>[{1}]
-# xref:id[text]
-[xref-inlinemacro]
-<link linkend="{target}">{0}</link>
-{2%}<xref linkend="{target}"/>
-# <<id,text>>
-[xref2-inlinemacro]
-<link linkend="{1}">{2}</link>
-{2%}<xref linkend="{1}"/>
-# // comment line
-[comment-inlinemacro]
-{showcomments#}<remark>{passtext}</remark>
-
-[comment-blockmacro]
-{showcomments#}<remark>{passtext}</remark>
-
-[literal-inlinemacro]
-# Inline literal.
-<literal>{passtext}</literal>
-
-# Special word macros
-[emphasizedwords]
-<emphasis>{words}</emphasis>
-[monospacedwords]
-<literal>{words}</literal>
-[strongwords]
-<emphasis role="strong">{words}</emphasis>
-
-# Paragraph substitution.
-[paragraph]
-<formalpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title><para>
-{title%}<simpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-|
-{title%}</simpara>
-{title#}</para></formalpara>
-{empty}
-
-[admonitionparagraph]
-<{name}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><simpara>|</simpara></{name}>
-
-# Delimited blocks.
-[literalblock]
-<formalpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title><para>
-{title#}<literallayout class="monospaced">
-{title%}<literallayout{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} class="monospaced">
-|
-</literallayout>
-{title#}</para></formalpara>
-
-[listingblock]
-<formalpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title><para>
-{title#}<screen>
-{title%}<screen{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-|
-</screen>
-{title#}</para></formalpara>
-
-[sidebarblock]
-<sidebar{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</sidebar>
-
-[abstractblock]
-<abstract{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</abstract>
-
-[openblock]
-|
-
-[partintroblock]
-<partintro{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</partintro>
-
-[quote-header]
-# Common quote and verse element template.
-<blockquote{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-# Include attribution only if either {attribution} or {citetitle} is defined.
-{attribution#}<attribution>
-{attribution%}{citetitle#}<attribution>
-{attribution}
-<citetitle>{citetitle}</citetitle>
-{attribution#}</attribution>
-{attribution%}{citetitle#}</attribution>
-
-[quoteblock]
-template::[quote-header]
-|
-</blockquote>
-
-[verseblock]
-template::[quote-header]
-<literallayout>
-|
-</literallayout>
-</blockquote>
-
-[quoteparagraph]
-template::[quote-header]
-<simpara>
-|
-</simpara>
-</blockquote>
-
-[exampleblock]
-<{title?example}{title!informalexample}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-# DocBook XSL Stylesheets custom processing instructions.
-<?dbfo keep-together="{breakable-option#auto}"?>
-<?dbfo keep-together="{unbreakable-option#always}"?>
-<title>{title}</title>
-|
-</{title?example}{title!informalexample}>
-
-[admonitionblock]
-<{name}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</{name}>
-
-# Tables.
-[tabletags-default]
-colspec=<colspec colname="col_{colnumber}" colwidth="{width!{colpcwidth}*}{width?{colabswidth}{pageunits}}"/>
-bodyrow=<row>|</row>
-headdata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}>|</entry>
-bodydata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}>|</entry>
-paragraph=<simpara>|</simpara>
-
-[tabletags-emphasis]
-paragraph=<simpara><emphasis>|</emphasis></simpara>
-
-[tabletags-header]
-paragraph=<simpara><emphasis role="strong">|</emphasis></simpara>
-
-[tabletags-strong]
-paragraph=<simpara><emphasis role="strong">|</emphasis></simpara>
-
-[tabletags-monospaced]
-paragraph=<simpara><literal>|</literal></simpara>
-
-[tabletags-verse]
-bodydata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}><literallayout>|</literallayout></entry>
-paragraph=
-
-[tabletags-literal]
-bodydata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}><literallayout class="monospaced">|</literallayout></entry>
-paragraph=
-
-[tabletags-asciidoc]
-paragraph=
-
-[table]
-<{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{pgwide-option? pgwide="1"}
-frame="{frame=all}"
-{grid%rowsep="1" colsep="1"}
-rowsep="{grid@none|cols:0:1}" colsep="{grid@none|rows:0:1}"
->
-<title>{title}</title>
-# DocBook XSL Stylesheets custom processing instructions.
-<?dbhtml table-width="{width}"?>
-<?dbfo table-width="{width}"?>
-<?dblatex table-width="{width}"?>
-<?dbfo keep-together="{breakable-option#auto}"?>
-<?dbfo keep-together="{unbreakable-option#always}"?>
-<tgroup cols="{colcount}">
-{colspecs}
-{headrows#}<thead>
-{headrows}
-{headrows#}</thead>
-{footrows#}<tfoot>
-{footrows}
-{footrows#}</tfoot>
-<tbody>
-{bodyrows}
-</tbody>
-</tgroup>
-</{title?table}{title!informaltable}>
-
-#--------------------------------------------------------------------
-# Deprecated old table definitions.
-#
-
-[old_tabledef-default]
-template=old_table
-colspec=<colspec colwidth="{colwidth}{pageunits}" align="{colalign}"/>
-bodyrow=<row>|</row>
-bodydata=<entry>|</entry>
-
-[old_table]
-<{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} pgwide="0"
-frame="{frame=topbot}"
-{grid%rowsep="0" colsep="0"}
-rowsep="{grid@none|cols:0:1}" colsep="{grid@none|rows:0:1}"
->
-<title>{title}</title>
-<tgroup cols="{cols}">
-{colspecs}
-{headrows#}<thead>
-{headrows}
-{headrows#}</thead>
-{footrows#}<tfoot>
-{footrows}
-{footrows#}</tfoot>
-<tbody>
-{bodyrows}
-</tbody>
-</tgroup>
-</{title?table}{title!informaltable}>
-
-# End of deprecated old table definitions.
-#--------------------------------------------------------------------
-
-# Special sections.
-[preface]
-<preface{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title=}</title>
-|
-</preface>
-
-[index]
-<index{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</index>
-
-[bibliography]
-<bibliography{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</bibliography>
-
-[glossary]
-<glossary{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</glossary>
-
-[appendix]
-<appendix{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</appendix>
-
-[floatingtitle]
-<bridgehead{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} renderas="sect{level}">{title}</bridgehead>
-
-
-[header-declarations]
-<?xml version="1.0" encoding="{encoding}"?>
-<!DOCTYPE {doctype-article?article}{doctype-book?book}{doctype-manpage?refentry} PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-{toc#}<?asciidoc-toc?>
-{numbered#}<?asciidoc-numbered?>
-
-[docinfo]
-{notitle%} <title>{doctitle}</title>
- <date>{revdate}</date>
-# To ensure valid articleinfo/bookinfo when there is no AsciiDoc header.
- {doctitle%}{revdate%}<date>{docdate}</date>
- {authored#}<author>
- <firstname>{firstname}</firstname>
- <othername>{middlename}</othername>
- <surname>{lastname}</surname>
- <email>{email}</email>
- {authored#}</author>
- <authorinitials>{authorinitials}</authorinitials>
-<revhistory><revision>{revnumber?<revnumber>{revnumber}</revnumber>}<date>{revdate}</date>{authorinitials?<authorinitials>{authorinitials}</authorinitials>}{revremark?<revremark>{revremark}</revremark>}</revision></revhistory>
-{docinfo1,docinfo2#}{include:{docdir}/docinfo.xml}
-{docinfo,docinfo2#}{include:{docdir}/{docname}-docinfo.xml}
-# DEPRECATED: Use docinfo.
-{revisionhistory#}{include:{docdir}/{docname}-revhistory.xml}
-# DEPRECATED: Use orgname in preference to companyname.
-<orgname>{companyname}</orgname>
-# DEPRECATED: Use orgname in preference to corpname.
-<orgname>{corpname}</orgname>
-<orgname>{orgname}</orgname>
-
-#-------------------------
-# article document type
-#-------------------------
-ifdef::doctype-article[]
-
-[header]
-template::[header-declarations]
-
-<article lang="{lang=en}">
-<articleinfo>
-template::[docinfo]
-</articleinfo>
-
-[footer]
-</article>
-
-[preamble]
-# Untitled elements between header and first section title.
-|
-
-[abstract]
-<abstract{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-|
-</abstract>
-
-[sect1]
-<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</section>
-
-[sect2]
-<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</section>
-
-[sect3]
-<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</section>
-
-[sect4]
-<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</section>
-
-endif::doctype-article[]
-
-#-------------------------
-# manpage document type
-#-------------------------
-ifdef::doctype-manpage[]
-
-[replacements]
-# The roff format does not substitute special characters so just print them as
-# text.
-\(C\)=(C)
-\(TM\)=(TM)
-
-[header]
-template::[header-declarations]
-<refentry lang="{lang=en}">
-<refentryinfo>
-template::[docinfo]
-</refentryinfo>
-<refmeta>
-<refentrytitle>{mantitle}</refentrytitle>
-<manvolnum>{manvolnum}</manvolnum>
-# Default source and manual to suppress DocBook XSL warnings.
-<refmiscinfo class="source">{mansource= }</refmiscinfo>
-<refmiscinfo class="manual">{manmanual= }</refmiscinfo>
-<refmiscinfo class="version">{manversion={revnumber}}</refmiscinfo>
-</refmeta>
-<refnamediv>
- <refname>{manname1}</refname>
- <refname>{manname2}</refname>
- <refname>{manname3}</refname>
- <refname>{manname4}</refname>
- <refname>{manname5}</refname>
- <refname>{manname6}</refname>
- <refname>{manname7}</refname>
- <refname>{manname8}</refname>
- <refname>{manname9}</refname>
- <refpurpose>{manpurpose}</refpurpose>
-</refnamediv>
-
-[footer]
-</refentry>
-
-# Section macros
-[synopsis]
-<refsynopsisdiv{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-|
-</refsynopsisdiv>
-
-[sect1]
-<refsect1{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</refsect1>
-
-[sect2]
-<refsect2{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</refsect2>
-
-[sect3]
-<refsect3{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</refsect3>
-
-endif::doctype-manpage[]
-
-#-------------------------
-# book document type
-#-------------------------
-ifdef::doctype-book[]
-
-[header]
-template::[header-declarations]
-
-<book lang="{lang=en}">
-<bookinfo>
-template::[docinfo]
-</bookinfo>
-
-[footer]
-</book>
-
-[preamble]
-# Preamble is not allowed in DocBook book so wrap it in a preface.
-<preface{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title=}</title>
-|
-</preface>
-
-[dedication]
-<dedication{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</dedication>
-
-[colophon]
-<colophon{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</colophon>
-
-[sect0]
-<part{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</part>
-
-[sect1]
-<chapter{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</chapter>
-
-[sect2]
-<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</section>
-
-[sect3]
-<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</section>
-
-[sect4]
-<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>
-<title>{title}</title>
-|
-</section>
-
-endif::doctype-book[]
-
-ifdef::sgml[]
-#
-# Optional DocBook SGML.
-#
-# Most of the differences between DocBook XML and DocBook SGML boils
-# down to the empty element syntax: SGML does not like the XML empty
-# element <.../> syntax, use <...> instead.
-#
-[miscellaneous]
-outfilesuffix=.sgml
-
-[header-declarations]
-<!DOCTYPE {doctype-article?article}{doctype-book?book}{doctype-manpage?refentry} PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
-
-[tabledef-default]
-colspec=<colspec colwidth="{colabswidth}{pageunits}" align="{colalign}">
-
-[image-inlinemacro]
-<inlinemediaobject>
- <imageobject>
- <imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? width="{width}"}{height? depth="{height}"}>
- </imageobject>
- <textobject><phrase>{alt={target}}</phrase></textobject>
-</inlinemediaobject>
-
-[image-blockmacro]
-<figure><title>{title}</title>
-{title%}<informalfigure>
-<mediaobject>
- <imageobject>
- <imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? width="{width}"}{height? depth="{height}"}>
- </imageobject>
- <textobject><phrase>{alt={target}}</phrase></textobject>
-</mediaobject>
-{title#}</figure>
-{title%}</informalfigure>
-
-# Inline macros
-[xref-inlinemacro]
-<link linkend="{target}">{0}</link>
-{2%}<xref linkend="{target}">
-[xref2-inlinemacro]
-# <<id,text>>
-<link linkend="{1}">{2}</link>
-{2%}<xref linkend="{1}">
-[anchor-inlinemacro]
-<anchor id="{target}" xreflabel="{0=[{target}]}">
-[anchor2-inlinemacro]
-# [[id,text]]
-<anchor id="{1}" xreflabel="{2=[{1}]}">
-
-endif::sgml[]
+# +# docbook45.conf +# +# Asciidoc DocBook 4.5 configuration file. +# + +[miscellaneous] +outfilesuffix=.xml +# Printable page width and units. +# Used to calculate DocBook CALS tables absolute column and table widths. +pagewidth=425 +pageunits=* + +[attributes] +basebackend=docbook +basebackend-docbook= +basebackend-docbook45= +# For backward compatibility (docbook backend was renamed to docbook45 at 8.6.2) +backend-docbook= +# toc and numbered are set to maintain original default behavior. +toc= +numbered= + +[replacements2] +# Line break markup. Custom processing instruction in fo.xsl. +(?m)^(.*)\s\+$=\1<?asciidoc-br?> + +[replacements] +ifdef::asciidoc7compatible[] +# Superscripts. +\^(.+?)\^=<superscript>\1</superscript> +# Subscripts. +~(.+?)~=<subscript>\1</subscript> +endif::asciidoc7compatible[] + +[ruler-blockmacro] +# Uses custom processing instructions in fo.xsl and asciidoc-dblatex.xsl. +<simpara><?asciidoc-hr?></simpara> + +[pagebreak-blockmacro] +# Uses custom processing instructions in fo.xsl and asciidoc-dblatex.xsl. +<simpara><?asciidoc-pagebreak?></simpara> + +[blockdef-pass] +latexmath-style=template="latexmathblock",subs=[] + +[macros] +# math macros. +(?su)[\\]?(?P<name>latexmath):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[] +(?u)^(?P<name>latexmath)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=#[] + +[latexmath-inlinemacro] +<inlineequation> +<alt><![CDATA[{passtext}]]></alt> +<inlinemediaobject><textobject><phrase></phrase></textobject></inlinemediaobject> +</inlineequation> + +[latexmath-blockmacro] +<informalequation> +<alt><![CDATA[{passtext}]]></alt> +<mediaobject><textobject><phrase></phrase></textobject></mediaobject> +</informalequation> + +[latexmathblock] +<equation{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title> +{title%}<informalequation{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<alt><![CDATA[|]]></alt> +<mediaobject><textobject><phrase></phrase></textobject></mediaobject> +{title#}</equation> +{title%}</informalequation> + +[image-inlinemacro] +<inlinemediaobject> + <imageobject> + <imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? contentwidth="{width}"}{height? contentdepth="{height}"}{scale? scale="{scale}"}/> + </imageobject> + <textobject><phrase>{alt={target}}</phrase></textobject> +</inlinemediaobject> + +[image-blockmacro] +<figure{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{pgwide-option? pgwide="1"}><title>{title}</title> +{title%}<informalfigure{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{pgwide-option?<?dbfo pgwide="1"?>} +# DocBook XSL Stylesheets custom processing instructions. +<?dbfo keep-together="{breakable-option#auto}"?> +<?dbfo keep-together="{unbreakable-option#always}"?> +<mediaobject> + <imageobject> + <imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? contentwidth="{width}"}{height? contentdepth="{height}"}{scale? scale="{scale}"}{scaledwidth? width="{scaledwidth}" scalefit="1"}{align? align="{align}"}/> + </imageobject> + <textobject><phrase>{alt={target}}</phrase></textobject> +</mediaobject> +{title#}</figure> +{title%}</informalfigure> + +[indexterm-inlinemacro] +# Index term. +# Generate separate index entries for primary, secondary and tertiary +# descriptions. +# Primary only. +{2%}<indexterm> +{2%} <primary>{1}</primary> +{2%}</indexterm> +# Primary and secondary. +{2#}{3%}<indexterm> +{2#}{3%} <primary>{1}</primary><secondary>{2}</secondary> +{2#}{3%}</indexterm> +{2#}{3%}<indexterm> +{2#}{3%} <primary>{2}</primary> +{2#}{3%}</indexterm> +# Primary, secondary and tertiary. +{3#}<indexterm> + <primary>{1}</primary><secondary>{2}</secondary><tertiary>{3}</tertiary> +{3#}</indexterm> +{3#}<indexterm> + <primary>{2}</primary><secondary>{3}</secondary> +{3#}</indexterm> +{3#}<indexterm> + <primary>{3}</primary> +{3#}</indexterm> + +[indexterm2-inlinemacro] +# Index term. +# Single entry index term that is visible in the primary text flow. +<indexterm><primary>{1}</primary></indexterm>{1} + +[footnote-inlinemacro] +# Footnote. +<footnote><simpara>{0}</simpara></footnote> + +[footnoteref-inlinemacro] +# Footnote reference. +{2#}<footnote id="{1}"><simpara>{2}</simpara></footnote> +{2%}<footnoteref linkend="{1}" /> + +[callout-inlinemacro] +# Callout. +<co id="{coid}"/> + +# List tags. +[listtags-bulleted] +list=<itemizedlist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{compact-option? spacing="compact"}>{unbreakable-option? <?dbfo keep-together="{unbreakable-option#always}"?>}{title?<title>{title}</title>}|</itemizedlist> +item=<listitem>|</listitem> +text=<simpara>|</simpara> + +[listtags-numbered] +list=<orderedlist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} numeration="{style}"{compact-option? spacing="compact"}>{unbreakable-option? <?dbfo keep-together="{unbreakable-option#always}"?>}{title?<title>{title}</title>}{start?<?dbfo start="{start}"?><?dbhtml start="{start}"?>}|</orderedlist> +item=<listitem>|</listitem> +text=<simpara>|</simpara> + +[listtags-labeled] +list=<variablelist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</variablelist> +entry=<varlistentry>|</varlistentry> +label= +term=<term>|</term> +item=<listitem>|</listitem> +text=<simpara>|</simpara> + +[listtags-horizontal] +# Horizontal labeled list (implemented with two column table). +# Hardwired column widths to 30%,70% because the current crop of PDF +# generators do not auto calculate column widths. + list=<{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{style? tabstyle="{style}"}{pgwide-option? pgwide="1"} frame="none" colsep="0" rowsep="0">{title?<title>{title}</title>}<tgroup cols="2"><colspec colwidth="{labelwidth=15}*"/><colspec colwidth="{itemwidth=85}*"/><tbody valign="top">|</tbody></tgroup><{title?/table}{title!/informaltable}> +entry=<row>|</row> +label=<entry>|</entry> +term=<simpara>|</simpara> +item=<entry>|</entry> +text=<simpara>|</simpara> + +[listtags-callout] +list=<calloutlist{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</calloutlist> +item=<callout arearefs="{coids}">|</callout> +text=<para>|</para> + +[listtags-qanda] +list=<qandaset{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</qandaset> +entry=<qandaentry>|</qandaentry> +label=<question>|</question> +term=<simpara>|</simpara> +item=<answer>|</answer> +text=<simpara>|</simpara> + +[listtags-bibliography] +list=<bibliodiv{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}>{title?<title>{title}</title>}|</bibliodiv> +item=<bibliomixed>|</bibliomixed> +text=<bibliomisc>|</bibliomisc> + +[listtags-glossary] +list= +entry=<glossentry>|</glossentry> +label= +term=<glossterm>|</glossterm> +item=<glossdef>|</glossdef> +text=<simpara>|</simpara> + +[tags] +# Quoted text +emphasis=<emphasis>{1?<phrase role="{1}">}|{1?</phrase>}</emphasis> +strong=<emphasis role="strong">{1?<phrase role="{1}">}|{1?</phrase>}</emphasis> +monospaced=<literal>{1?<phrase role="{1}">}|{1?</phrase>}</literal> +singlequoted={lsquo}{1?<phrase role="{1}">}|{1?</phrase>}{rsquo} +doublequoted={ldquo}{1?<phrase role="{1}">}|{1?</phrase>}{rdquo} +unquoted={1?<phrase role="{1}">}|{1?</phrase>} +subscript=<subscript>{1?<phrase role="{1}">}|{1?</phrase>}</subscript> +superscript=<superscript>{1?<phrase role="{1}">}|{1?</phrase>}</superscript> + +ifdef::deprecated-quotes[] +# Override with deprecated quote attributes. +emphasis={role?<phrase role="{role}">}<emphasis>|</emphasis>{role?</phrase>} +strong={role?<phrase role="{role}">}<emphasis role="strong">|</emphasis>{role?</phrase>} +monospaced={role?<phrase role="{role}">}<literal>|</literal>{role?</phrase>} +singlequoted={role?<phrase role="{role}">}{amp}#8216;|{amp}#8217;{role?</phrase>} +doublequoted={role?<phrase role="{role}">}{amp}#8220;|{amp}#8221;{role?</phrase>} +unquoted={role?<phrase role="{role}">}|{role?</phrase>} +subscript={role?<phrase role="{role}">}<subscript>|</subscript>{role?</phrase>} +superscript={role?<phrase role="{role}">}<superscript>|</superscript>{role?</phrase>} +endif::deprecated-quotes[] + +# Inline macros +[http-inlinemacro] +<ulink url="{name}:{target}">{0={name}:{target}}</ulink> +[https-inlinemacro] +<ulink url="{name}:{target}">{0={name}:{target}}</ulink> +[ftp-inlinemacro] +<ulink url="{name}:{target}">{0={name}:{target}}</ulink> +[file-inlinemacro] +<ulink url="{name}:{target}">{0={name}:{target}}</ulink> +[irc-inlinemacro] +<ulink url="{name}:{target}">{0={name}:{target}}</ulink> +[mailto-inlinemacro] +<ulink url="mailto:{target}">{0={target}}</ulink> +[callto-inlinemacro] +<ulink url="{name}:{target}">{0={target}}</ulink> +[link-inlinemacro] +<ulink url="{target}">{0={target}}</ulink> +# anchor:id[text] +[anchor-inlinemacro] +<anchor id="{target}" xreflabel="{0=[{target}]}"/> +# [[id,text]] +[anchor2-inlinemacro] +<anchor id="{1}" xreflabel="{2=[{1}]}"/> +# [[[id]]] +[anchor3-inlinemacro] +<anchor id="{1}" xreflabel="[{1}]"/>[{1}] +# xref:id[text] +[xref-inlinemacro] +<link linkend="{target}">{0}</link> +{2%}<xref linkend="{target}"/> +# <<id,text>> +[xref2-inlinemacro] +<link linkend="{1}">{2}</link> +{2%}<xref linkend="{1}"/> +# // comment line +[comment-inlinemacro] +{showcomments#}<remark>{passtext}</remark> + +[comment-blockmacro] +{showcomments#}<remark>{passtext}</remark> + +[literal-inlinemacro] +# Inline literal. +<literal>{passtext}</literal> + +# Special word macros +[emphasizedwords] +<emphasis>{words}</emphasis> +[monospacedwords] +<literal>{words}</literal> +[strongwords] +<emphasis role="strong">{words}</emphasis> + +# Paragraph substitution. +[paragraph] +<formalpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title><para> +{title%}<simpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +| +{title%}</simpara> +{title#}</para></formalpara> +{empty} + +[admonitionparagraph] +<{name}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><simpara>|</simpara></{name}> + +# Delimited blocks. +[literalblock] +<formalpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title><para> +{title#}<literallayout class="monospaced"> +{title%}<literallayout{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} class="monospaced"> +| +</literallayout> +{title#}</para></formalpara> + +[listingblock] +<formalpara{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}><title>{title}</title><para> +{title#}<screen> +{title%}<screen{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +| +</screen> +{title#}</para></formalpara> + +[sidebarblock] +<sidebar{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</sidebar> + +[abstractblock] +<abstract{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</abstract> + +[openblock] +| + +[partintroblock] +<partintro{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</partintro> + +[quote-header] +# Common quote and verse element template. +<blockquote{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +# Include attribution only if either {attribution} or {citetitle} is defined. +{attribution#}<attribution> +{attribution%}{citetitle#}<attribution> +{attribution} +<citetitle>{citetitle}</citetitle> +{attribution#}</attribution> +{attribution%}{citetitle#}</attribution> + +[quoteblock] +template::[quote-header] +| +</blockquote> + +[verseblock] +template::[quote-header] +<literallayout> +| +</literallayout> +</blockquote> + +[quoteparagraph] +template::[quote-header] +<simpara> +| +</simpara> +</blockquote> + +[exampleblock] +<{title?example}{title!informalexample}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +# DocBook XSL Stylesheets custom processing instructions. +<?dbfo keep-together="{breakable-option#auto}"?> +<?dbfo keep-together="{unbreakable-option#always}"?> +<title>{title}</title> +| +</{title?example}{title!informalexample}> + +[admonitionblock] +<{name}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</{name}> + +# Tables. +[tabletags-default] +colspec=<colspec colname="col_{colnumber}" colwidth="{width!{colpcwidth}*}{width?{colabswidth}{pageunits}}"/> +bodyrow=<row>|</row> +headdata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}>|</entry> +bodydata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}>|</entry> +paragraph=<simpara>|</simpara> + +[tabletags-emphasis] +paragraph=<simpara><emphasis>|</emphasis></simpara> + +[tabletags-header] +paragraph=<simpara><emphasis role="strong">|</emphasis></simpara> + +[tabletags-strong] +paragraph=<simpara><emphasis role="strong">|</emphasis></simpara> + +[tabletags-monospaced] +paragraph=<simpara><literal>|</literal></simpara> + +[tabletags-verse] +bodydata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}><literallayout>|</literallayout></entry> +paragraph= + +[tabletags-literal] +bodydata=<entry align="{halign}" valign="{valign}"{colspan@1:: namest="col_{colstart}" nameend="col_{colend}"}{morerows@0:: morerows="{morerows}"}><literallayout class="monospaced">|</literallayout></entry> +paragraph= + +[tabletags-asciidoc] +paragraph= + +[table] +<{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}{pgwide-option? pgwide="1"} +frame="{frame=all}" +{grid%rowsep="1" colsep="1"} +rowsep="{grid@none|cols:0:1}" colsep="{grid@none|rows:0:1}" +> +<title>{title}</title> +# DocBook XSL Stylesheets custom processing instructions. +<?dbhtml table-width="{width}"?> +<?dbfo table-width="{width}"?> +<?dblatex table-width="{width}"?> +<?dbfo keep-together="{breakable-option#auto}"?> +<?dbfo keep-together="{unbreakable-option#always}"?> +<tgroup cols="{colcount}"> +{colspecs} +{headrows#}<thead> +{headrows} +{headrows#}</thead> +{footrows#}<tfoot> +{footrows} +{footrows#}</tfoot> +<tbody> +{bodyrows} +</tbody> +</tgroup> +</{title?table}{title!informaltable}> + +#-------------------------------------------------------------------- +# Deprecated old table definitions. +# + +[old_tabledef-default] +template=old_table +colspec=<colspec colwidth="{colwidth}{pageunits}" align="{colalign}"/> +bodyrow=<row>|</row> +bodydata=<entry>|</entry> + +[old_table] +<{title?table}{title!informaltable}{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} pgwide="0" +frame="{frame=topbot}" +{grid%rowsep="0" colsep="0"} +rowsep="{grid@none|cols:0:1}" colsep="{grid@none|rows:0:1}" +> +<title>{title}</title> +<tgroup cols="{cols}"> +{colspecs} +{headrows#}<thead> +{headrows} +{headrows#}</thead> +{footrows#}<tfoot> +{footrows} +{footrows#}</tfoot> +<tbody> +{bodyrows} +</tbody> +</tgroup> +</{title?table}{title!informaltable}> + +# End of deprecated old table definitions. +#-------------------------------------------------------------------- + +# Special sections. +[preface] +<preface{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title=}</title> +| +</preface> + +[index] +<index{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</index> + +[bibliography] +<bibliography{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</bibliography> + +[glossary] +<glossary{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</glossary> + +[appendix] +<appendix{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</appendix> + +[floatingtitle] +<bridgehead{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"} renderas="sect{level}">{title}</bridgehead> + + +[header-declarations] +<?xml version="1.0" encoding="{encoding}"?> +<!DOCTYPE {doctype-article?article}{doctype-book?book}{doctype-manpage?refentry} PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +{toc#}<?asciidoc-toc?> +{numbered#}<?asciidoc-numbered?> + +[docinfo] +{notitle%} <title>{doctitle}</title> + <date>{revdate}</date> +# To ensure valid articleinfo/bookinfo when there is no AsciiDoc header. + {doctitle%}{revdate%}<date>{docdate}</date> + {authored#}<author> + <firstname>{firstname}</firstname> + <othername>{middlename}</othername> + <surname>{lastname}</surname> + <email>{email}</email> + {authored#}</author> + <authorinitials>{authorinitials}</authorinitials> +<revhistory><revision>{revnumber?<revnumber>{revnumber}</revnumber>}<date>{revdate}</date>{authorinitials?<authorinitials>{authorinitials}</authorinitials>}{revremark?<revremark>{revremark}</revremark>}</revision></revhistory> +{docinfo1,docinfo2#}{include:{docdir}/docinfo.xml} +{docinfo,docinfo2#}{include:{docdir}/{docname}-docinfo.xml} +# DEPRECATED: Use docinfo. +{revisionhistory#}{include:{docdir}/{docname}-revhistory.xml} +# DEPRECATED: Use orgname in preference to companyname. +<orgname>{companyname}</orgname> +# DEPRECATED: Use orgname in preference to corpname. +<orgname>{corpname}</orgname> +<orgname>{orgname}</orgname> + +#------------------------- +# article document type +#------------------------- +ifdef::doctype-article[] + +[header] +template::[header-declarations] + +<article lang="{lang=en}"> +<articleinfo> +template::[docinfo] +</articleinfo> + +[footer] +</article> + +[preamble] +# Untitled elements between header and first section title. +| + +[abstract] +<abstract{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +| +</abstract> + +[sect1] +<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</section> + +[sect2] +<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</section> + +[sect3] +<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</section> + +[sect4] +<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</section> + +endif::doctype-article[] + +#------------------------- +# manpage document type +#------------------------- +ifdef::doctype-manpage[] + +[replacements] +# The roff format does not substitute special characters so just print them as +# text. +\(C\)=(C) +\(TM\)=(TM) + +[header] +template::[header-declarations] +<refentry lang="{lang=en}"> +<refentryinfo> +template::[docinfo] +</refentryinfo> +<refmeta> +<refentrytitle>{mantitle}</refentrytitle> +<manvolnum>{manvolnum}</manvolnum> +# Default source and manual to suppress DocBook XSL warnings. +<refmiscinfo class="source">{mansource= }</refmiscinfo> +<refmiscinfo class="manual">{manmanual= }</refmiscinfo> +<refmiscinfo class="version">{manversion={revnumber}}</refmiscinfo> +</refmeta> +<refnamediv> + <refname>{manname1}</refname> + <refname>{manname2}</refname> + <refname>{manname3}</refname> + <refname>{manname4}</refname> + <refname>{manname5}</refname> + <refname>{manname6}</refname> + <refname>{manname7}</refname> + <refname>{manname8}</refname> + <refname>{manname9}</refname> + <refpurpose>{manpurpose}</refpurpose> +</refnamediv> + +[footer] +</refentry> + +# Section macros +[synopsis] +<refsynopsisdiv{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +| +</refsynopsisdiv> + +[sect1] +<refsect1{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</refsect1> + +[sect2] +<refsect2{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</refsect2> + +[sect3] +<refsect3{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</refsect3> + +endif::doctype-manpage[] + +#------------------------- +# book document type +#------------------------- +ifdef::doctype-book[] + +[header] +template::[header-declarations] + +<book lang="{lang=en}"> +<bookinfo> +template::[docinfo] +</bookinfo> + +[footer] +</book> + +[preamble] +# Preamble is not allowed in DocBook book so wrap it in a preface. +<preface{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title=}</title> +| +</preface> + +[dedication] +<dedication{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</dedication> + +[colophon] +<colophon{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</colophon> + +[sect0] +<part{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</part> + +[sect1] +<chapter{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</chapter> + +[sect2] +<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</section> + +[sect3] +<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</section> + +[sect4] +<section{id? id="{id}"}{role? role="{role}"}{reftext? xreflabel="{reftext}"}> +<title>{title}</title> +| +</section> + +endif::doctype-book[] + +ifdef::sgml[] +# +# Optional DocBook SGML. +# +# Most of the differences between DocBook XML and DocBook SGML boils +# down to the empty element syntax: SGML does not like the XML empty +# element <.../> syntax, use <...> instead. +# +[miscellaneous] +outfilesuffix=.sgml + +[header-declarations] +<!DOCTYPE {doctype-article?article}{doctype-book?book}{doctype-manpage?refentry} PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> + +[tabledef-default] +colspec=<colspec colwidth="{colabswidth}{pageunits}" align="{colalign}"> + +[image-inlinemacro] +<inlinemediaobject> + <imageobject> + <imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? width="{width}"}{height? depth="{height}"}> + </imageobject> + <textobject><phrase>{alt={target}}</phrase></textobject> +</inlinemediaobject> + +[image-blockmacro] +<figure><title>{title}</title> +{title%}<informalfigure> +<mediaobject> + <imageobject> + <imagedata fileref="{imagesdir=}{imagesdir?/}{target}"{width? width="{width}"}{height? depth="{height}"}> + </imageobject> + <textobject><phrase>{alt={target}}</phrase></textobject> +</mediaobject> +{title#}</figure> +{title%}</informalfigure> + +# Inline macros +[xref-inlinemacro] +<link linkend="{target}">{0}</link> +{2%}<xref linkend="{target}"> +[xref2-inlinemacro] +# <<id,text>> +<link linkend="{1}">{2}</link> +{2%}<xref linkend="{1}"> +[anchor-inlinemacro] +<anchor id="{target}" xreflabel="{0=[{target}]}"> +[anchor2-inlinemacro] +# [[id,text]] +<anchor id="{1}" xreflabel="{2=[{1}]}"> + +endif::sgml[] diff --git a/examples/website/CHANGELOG.txt b/examples/website/CHANGELOG.txt index e7697d8..2c60fb8 120000..100644 --- a/examples/website/CHANGELOG.txt +++ b/examples/website/CHANGELOG.txt @@ -1 +1,2739 @@ -../../CHANGELOG.txt
\ No newline at end of file +AsciiDoc ChangeLog +================== + +:website: http://www.methods.co.nz/asciidoc/ + + +Version 8.6.4 (2010-02-20) +-------------------------- +.Additions and changes +- Added text foreground and background color along with text size CSS + styles for XHTML outputs, see {website}userguide.html#X96[]. +- Vim syntax highlighter: highlight macros that start with an + attribute reference (a common idiom). +- Vim syntax highlighter: highlight attribute references in macro + attribute lists. +- Attribute entries can be used to set configuration markup templates. +- Double-width East Asian characters in titles now correctly match the + title underline widths. Submitted by Changjian Gao (see + http://groups.google.com/group/asciidoc/browse_thread/thread/77f28b0dfe60d262). +- Implemented {website}manpage.html[asciidoc(1)] filter commands, see: + http://groups.google.com/group/asciidoc/browse_thread/thread/40c64cd33ee1905c +- User's home directory now calculated in a platform independent + manner. +- Added double-quote characters to French language file. Patch + contributed Yves-Alexis Perez, see: + http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 +- Vim Syntax highlighter: Highlight closing OpenBlocks which + immediately follow a literal paragraph. +- Changed UNIX `/dev/null` to OS independent `os.devnull` in filters + code. Suggested by Henrik Maier: + http://groups.google.com/group/asciidoc/browse_thread/thread/5ac8e8ea895147e9 +- Vim syntax highlighter: Single and double quoted text now highlights + correctly when preceded by an attributes list. +- Added Ukrainian language file (`lang-uk.conf`). Added double-quote + characters to Russian language file.conf). Patches contributed by + Lavruschenko Oleksandr, see + http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 +- Single and double quote characters are now set using the `{lsquo}`, + `{rsquo}`, `{ldquo}` and `{rdquo}` attributes. This makes is easy to + customise language specific quotes. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 +- Implemented 'conf-files' attribute to allow configuration files to + be specified in the source document. Suggested by Lex Trotman, see: + http://groups.google.com/group/asciidoc/browse_thread/thread/b11066a828ab45b9 + +.Bug fixes +- *FIXED*: Auto-generated section title ids are now Unicode aware. +- *FIXED*: Setting 'quotes' configuration entries using document + attribute entries failed if the attribute entry was not in the + document header. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/a1dd0562dee8b939 +- *FIXED*: If the input and output file names were different then the + output file name was incorrectly used to synthesize 'docinfo' file + names. Reported by Christian Zuckschwerdt. +- *FIXED*: An error can occur when more than one consecutive quotes + are defined as a blank string. Reported by Peggy Russell. +- *FIXED*: Encoding error in automatically generated author initials. + Patch submitted by Xin Wang. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/f44615dca0b834e9 + + +Version 8.6.3 (2010-11-14) +-------------------------- +.Additions and changes +- Added and 'unbreakable' option to bulleted and numbered lists + (thanks to Henrik Maier for this patch). +- Added `ifeval::[]` system macro (thanks to Henrik Maier for + suggesting this feature). +- The image 'scale' attribute sets the DocBook 'imagedata' element + 'scale' attribute. Patch submitted by Henrik Maier. +- DocBook 'preface', 'colophon' and 'dedication' style section titles + now work. Based on patch submitted by Henrik Maier. +- 'a2x': Do not inject xsltproc parameters if they were specified on + the command-line (parameter double-ups generate xsltproc 'Global + parameter already defined' errors). +- 'a2x': Refactored xsltproc parameter injection. +- 'a2x': articles chunked at section level by default. +- 'attributes', 'titles' and 'specialcharacters' sections are now read + from the local `asciidoc.conf` file before the header is parsed. + This fixes a regression problem. See + http://groups.google.com/group/asciidoc/browse_thread/thread/1b3f88f1f8118ab3 +- Document header attributes take precedence over configuration file + attributes. +- Refactored 'music', 'graphviz' and 'latex' filter configurations. +- Refactored source filter configuration and added literal paragraph + source style. +- Separated paragraph styles from paragraph syntax -- any style can be + applied to any syntax. +- Added 'listing' and 'quote' paragraph styles. +- Renamed paragraph 'default' style to 'normal'. +- Updated `--help` option text. +- 'a2x': The `asciidoc_opts`, `dblatex_opts`, `fop_opts` and + `xsltproc_opts` command-line options can be specified multiple + times. This makes embedding multiple 'a2x' options in document + headers easier to manage and less error prone. +- Added ASCIIMathML and LaTeXMathML support to slidy backend. +- Pass the 'encoding' attribute to the Pygments source highlight + filter command. +- 'a2x': HTML Help `.hhk` file named after AsciiDoc source file. +- 'a2x': Added `--xsl-file` option to allow custom XSL stylesheets to + be specified. +- Make builds the man pages. Patch submitted by Sebastian Pipping. See + http://groups.google.com/group/asciidoc/browse_thread/thread/c21c2902c29bae64 + +.Bug fixes +- *FIXED*: Sometimes double backquotes were misinterpreted as inline + literal macros. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/f510ea82a88aaee8 +- *FIXED*: Regression in 8.6.2: command-line attributes were not + available to the global asciidoc.conf. +- *FIXED*: Postponed document title substitutions until backend conf + files have been loaded (8.6.2 regression). See + http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8 +- *FIXED*: The XSL Stylesheets customizations were preventing chapter + and section level TOCs from being generated when using XSL + Stylesheets via 'a2x'. See + http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8 +- *FIXED*: ``UnicodeDecodeError: \'ascii' codec can't decode byte'' + error. This error is due to a limitation in the Python HTMLParser + module, see: http://bugs.python.org/issue3932 +- *FIXED*: Broken `--no-conf` option (8.6.2 regression). +- *FIXED*: Regression in 8.6.2: configuration attribute entries set in + the document header may cause a 'FAILED: incomplete configuration + files' error. +- *FIXED*: 'html4': corrected self closed meta tags. +- *FIXED*: 'a2x' regression in 8.6.2: HTML Help `.hhp` file name had + reverted to default name instead of the AsciiDoc source file name. + See: + http://groups.google.com/group/asciidoc/browse_thread/thread/dedc961b23e9ac56 +- *FIXED*: Attributes in man page title caused it to be dropped + resulting in invalid DocBook output. +- *FIXED*: `make uninstall` now deletes the `asciidoc.1` and `a2x.1` + man pages. + + +Version 8.6.2 (2010-10-03) +-------------------------- +.Additions and changes +- 'docbook45': Enclosed bibliographic lists in a 'bibliodiv' -- you + can now include block titles with bibliographic lists. +- Added optional 'keywords', 'description' and 'title' document header + meta-data attributes to HTML backends for SEO. +- AttributeEntry values can span multiple lines with a ' +' line + continuation. +- Added 'slidy' backend (based on Phillip Lord's slidy backend + https://phillordbio-asciidoc-fixes.googlecode.com/hg/). +- Implemented 'OpenBlock' 'partintro' style for book part + introductions. +- Comment lines substitute special characters only. +- Backend specific global configuration files (all except + `asciidoc.conf`) are loaded *after* the header has been parsed -- + virtually any attribute can now be specified in the document header. +- 'xhtml11': Volnitsky theme: allow bulleted lists to have intervening + children. +- 'xhtml11': refactored CSS font-family rules to start of file. +- 'xhtml11': list bullets colored gray. +- 'ifdef' and 'ifndef' system block macros accept multiple attribute + names: multiple names separated by commas are 'ored'; multiple + attribute names separated by pluses are 'anded'. +- 'xhtml11': Volnitsky theme: set max-width on labeled lists. +- Vim syntax highlighter: Entities inside quoted text are now + highlighted. +- Added 'role' and 'id' attributes to HTML outputs generated by + 'OpenBlocks'. +- Allow floating titles to generate 'h1' (level 0) titles in HTML + outputs. +- Added a 'start' attribute to numbered lists to set the start number. + See: + http://groups.google.com/group/asciidoc/browse_thread/thread/c14a4c3b1e4f6dc5 +- Added two more docinfo attributes 'docinfo1' and 'docinfo2' to allow + and control inclusion of a shared docinfo file. See + http://groups.google.com/group/asciidoc/browse_thread/thread/c948697943432e24 +- Vim syntax highlighter highlights multi-name conditional attributes. +- LaTeX backend patch submitted by Andreas Hermann Braml (see + http://groups.google.com/group/asciidoc/browse_thread/thread/1c415fc4540ce5e5). +- Implemented 'backend aliases'; renamed `docbook.conf` to + `docbook45.conf` and aliased 'docbook45' backend to 'docbook'; + aliased 'xhtml11' to 'html'. + +.Bug fixes +- *FIXED*: Filter commands located in filter directories local to the + source document that where not in the search 'PATH' where not found. +- *FIXED*: Volnitsky theme: Verseblock font set normal instead of + monospaced. +- *FIXED*: 'xhtml11': Callout icons were not rendered as Data URIs + when 'icons' and 'data-uri' attributes were specified. +- *FIXED*: Long standing bug: nested include macros did not restore + the parent document 'infile' and 'indir' attributes. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/8712a95e95a292a7 +- *FIXED*: 'html4': set preamble ID anchor. +- *FIXED*: 'xhtml11': dropped unusable 'id' and 'role' attributes from + preamble template. +- *FIXED*: Bug in multi-name conditional attributes e.g. `{x,y#}` + fails if x or y is undefined. +- *FIXED*: latex filter not being installed by Makefile. Thanks to + Grant Edwards for this patch. See + http://groups.google.com/group/asciidoc/browse_thread/thread/c4427a3902d130a8 +- *FIXED*: 'a2x': Long-standing bug in a2x which always passes + `--string-param navig.graphics 0` to 'xsltproc', regardless of + whether icons are enabled or not. Reported by Michael Wild: + http://groups.google.com/group/asciidoc/browse_thread/thread/59a610068e4acb58 + + +Version 8.6.1 (2010-08-22) +-------------------------- +.Additions and changes +- 'a2x': `--resource-dir` option renamed to `--resource`. +- 'a2x': `--resource` option accepts both file and directory names. +- 'a2x': Added `-m,--resource-manifest` option. +- Added Vim syntax highlighting for quote attribute lists. +- Load 'asciidoc.conf' from all configuration directories before any + other configuration files. This ensures that attributes used for + conditional inclusion are set before backend configuration files are + processed. Previously if you wanted to control global conf file + inclusion your only choice was to modify the global 'asciidoc.conf' + file. +- AsciiDoc 'Quote element' attributes have been simplified and + generalized -- positional color and size attributes and named 'role' + attribute have been replaced by a single positional attribute. + +.Bug fixes +- *FIXED*: 'testasciidoc.py': `BACKEND` command argument was being + ignored. +- *FIXED*: Broken 'docinfo' file functionality in 'html4' and + 'xhtml11' backends (previously the docinfo file was included in + the 'body' instead of the 'header'). + +Regression issues +~~~~~~~~~~~~~~~~~ +This release breaks compatibility with quoted element positional color +and size attributes (HTML backends). To revert to the deprecated quote +behavior define the 'deprecated-quotes' attribute in the global +`asciidoc.conf` file or on the command-line. For a more detailed +explanation of the rationale behind this change see +http://groups.google.com/group/asciidoc/browse_thread/thread/b22603bfb879418c. + + +Version 8.6.0 (2010-08-16) +-------------------------- +.Additions and changes +- The AsciiDoc distribution can now be built ``out of the box'' + from the distribution tarball or the Mercurial repository + (provided you have the requisite build applications installed). +- The global configuration files directory is ignored by both + 'asciidoc' and 'a2x' if AsciiDoc configuration files are installed + in the same directory as the asciidoc executable. This change + allows both a system wide copy and multiple local copies of AsciiDoc + to coexist on the same host PC. +- CSS 'quirks' mode is no longer the default 'xhtml11' output + (http://groups.google.com/group/asciidoc/browse_thread/thread/1c02d27d49221aa2). +- Relaxed anchor ID name syntax + (http://groups.google.com/group/asciidoc/browse_thread/thread/5f3e825c74ed30c). +- Added document files: `doc/epub-notes.txt`, + `doc/publishing-ebooks-with-asciidoc.txt`. +- 'a2x': If all other resource locations are exhausted then recursively + search directories named 'images' and 'stylesheets' in the + 'asciidoc' configuration files directory. +- 'a2x': options can also be set in the AsciiDoc source file. If the + source file contains a line beginning with '// a2x:' then the + remainder of the line will be treated as a2x command-line options. +- Added dblatex table-width processing instruction -- tables generated + by dblatex now observe the AsciiDoc table width as a percentage + (thanks to Gustav Broberg for suggesting this enhancement). +- 'a2x': Don't exit if the `--epubcheck` option is set and 'epubcheck' + is missing, issue warning and continue. +- Added a global 'plaintext' attribute for dealing with large amounts + of imported text. +- The author name format has been relaxed, if the the author does not + match the formal specification then it is assigned to the + 'firstname' attribute (previously asciidoc exited with an error + message). +- FAQ and documentation updates. +- Refactored chunked.xsl and epub.xsl files. +- Exchanged article.epub for more relevant book.epub on website. +- Put asciidoc.epub User Guide on website. +- 'a2x': Chunking EPUB and HTML outputs set to a per chapter basis and + the first chapter is separate from preceding contents. +- Changed dates format in example article and books to suppress EPUB + validation error. +- Added 'style' and 'role' CSS classes to xhtml11 section templates. +- Added the 'role' element to xhtml11 backend block templates. +- Suppressed md5 module deprecation warning from music and Graphviz filters. +- Pygments (http://pygments.org/) option added to source code + highlight filter. Based on Pygments source code filter written by + David Hajage + (http://groups.google.com/group/asciidoc/browse_thread/thread/d8d042f5a3021369/8934ebbb8cb7144b). +- xhtml11: Added a new theme (volnitsky). Written and contributed by + Leonid V. Volnitsky. +- xhtml11: Set body element class name to document type. +- Added refentryinfo element and contents (including revdate) to man + page DocBook output. Man pages are now dated using the revdate + attribute value if it has been defined. Based on patch supplied by + Rainer Muller + http://groups.google.com/group/asciidoc/browse_frm/thread/319e5cd94493e330/3fcb83fab067af42. +- Added `{template:...}` system attribute. +- Table of contents attribute 'toc' can now be specified in the + document header. +- Reimplemented music and latex filter -m option functionality when + the input is stdin using MD5 checksums. +- Added 'latex' filter. +- Added auto file name generation to image generating filters + (latex,music, graphviz). +- Added `counter2` and `set2` system attributes (to implement image + auto file name generation). +- Undefined attribute in filter command generates error but does not + exit. +- Attribute substitution proceeds from start line to end line + (previously was in reverse order which was really confusing). +- Tidied up music filter code: + * Format option is optional and default to 'abc' unless Lilypond + notation detected. + * The -m option does not apply to stdin input. +- Added paragraph styles to music and graphviz filters. +- Documented dynamic template names. 753: Graphviz filter can now + generate SVG format images. Patch submitted by Elmo Todurov, see: + http://groups.google.com/group/asciidoc/browse_frm/thread/fe9b33d8f5f1e0af + The xhtml11 SVG Graphviz template marked EXPERIMENTAL. No SVG + support for other backends. +- AsciiDoc template names can now contain embedded attribute + references. +- Added 'legalnotice' tag to `doc/article-docinfo.xml` example. +- xhtml11 backend: Callouts and callout lists display callout icons + when the 'icons' attribute is defined. See + http://groups.google.com/group/asciidoc/browse_frm/thread/8eda3ea812968854 +- Document attribute names are case insensitive everywhere, this makes using +attribute entries more consistent e.g. previously :VERS: had to be refered to +with {vers} ({VERS} did not work). +- Hungarian translation of footer-text (submitted by Miklos Vajna). + See + http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72# +- asciidocapi.py 0.1.2: Can now load AsciiDoc script named asciidoc. + See + http://groups.google.com/group/asciidoc/browse_frm/thread/66e7b59d12cd2f91 + Based on patch submitted by Phillip Lord. +- German translation of footer-text (submitted by Simon Ruderich). See + http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 +- Pushed HTML footer text into language conf files with the + introduction of a [footer-text] configuration file template section. + See + http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 + +.Bug fixes +- *FIXED*: Sometimes multiple double quoted text elements in the same + paragraph were mistakenly seen as starting with an inline literal. + See + http://groups.google.com/group/asciidoc/browse_frm/thread/219c86ae25b79a21 +- *FIXED*: 'localtime' and 'doctime' attributes calculated incorrect + daylight saving / non daylight saving timezones and consequently so + did HTML footers. Patch submitted by Slawomir Testowy. See + http://groups.google.com/group/asciidoc/browse_frm/thread/af652507caf6cec9 +- *FIXED*: Missing selector for 'List of examples' title in DocBook + CSS file. Patch submitted by Laurent Laville. See + http://groups.google.com/group/asciidoc/browse_frm/thread/3f96900f7fbf5620 +- *FIXED*: Broken accents in lang-hu.conf. See: + http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 +- *FIXED*: DocBook XSL generated HTML callout lists are properly + aligned. Submitted by Lionel Orry. See + http://groups.google.com/group/asciidoc/browse_frm/thread/2ff802547b6a75ea +- *FIXED*: Filter execution now occurs prior to filter markup template + substitution to ensure image data URI encoding happens after image + generation (see + http://groups.google.com/group/asciidoc/browse_thread/thread/14e8fcb289a135b). +- *FIXED*: The section numbers no longer increment when the 'numbered' + attribute is undefined (see + http://groups.google.com/group/asciidoc/browse_thread/thread/faa36e9e5c7da019/d24cab3fe363e58d). + + +Version 8.5.3 (2010-01-18) +-------------------------- +.Additions and changes +- a2x: Added a2x configuration file options ASCIIDOC_OPTS, + DBLATEX_OPTS, FOP_OPTS, XSLTPROC_OPTS (appended to same-named + command-line options). See + http://groups.google.com/group/asciidoc/browse_frm/thread/ac4b9bfa2116db28 +- Dropped `.hgignore` from the repository. See + http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea +- Don't pass verbose options to asciidoc table filter so that + asciidocapi messages are not discarded. See: + http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea +- Added `./tests/data/lang-pt-BR-test.txt` file to the repository. +- xhtml11: Verse block and verse paragraph content enveloped in a + 'pre' tag (instead of a 'div') so it renders better in text-only + browsers. See: + http://groups.google.com/group/asciidoc/browse_frm/thread/1b6b66adb24e710 +- User Guide: Clarified Passthrough Blocks (suggested by Simon + Ruderich). +- FAQ: 'How can I include lines of dashes inside a listing block?' +- FAQ errata and updates (submitted by Simon Ruderich). +- User Guide errata. +- Simplified 'asciidoc-toc' processing instruction and included lists + of figures, tables, examples and equations in books (i.e. revert to + pre-8.5.0 behavior). +- Attempted to have dblatex recognise the 'asciidoc-toc' processing + instruction but couldn't get it to work. +- Added 'notitle' attribute to allow the document title to be hidden. + + +.Bug fixes +- *FIXED*: Regression: system attribute escaping did not work. +- *FIXED*: Website: broken image links in chunked User Guide. + + +Version 8.5.2 (2009-12-07) +-------------------------- +.Additions and changes +- Updated example article and book documents with the recommended + explicit section name syntax (see the 'Special section titles + vs. explicit template names' sidebar in the AsciiDoc 'User Guide'). +- Added Italian language configuration file (contributed by Fabio + Inguaggiato). +- Added 'header' table style. See: + http://groups.google.com/group/asciidoc/browse_frm/thread/a23fea28394c8ca9 +- Pass 'icons', 'data-uri', 'imagesdir', 'iconsdir' attributes to + 'asciidoc' table style filter so that images are rendered in table + cells. +- Pass 'trace' and 'verbose' attributes to 'asciidoc' table style + filter so diagnostic information is printed from table cell source. +- The 'eval' system attribute can be nested inside other system + attributes. +- HTML outputs: Table and figure caption punctuation set to more usual + syntax. +- docbook backend: footnotes can now contain embedded images. See + http://groups.google.com/group/asciidoc/browse_frm/thread/50b28f6941de111a +- CSS tweaks so that tables processed by DocBook XSL Stylesheets have + the default asciidoc xhtml11 backend styling. See + http://groups.google.com/group/asciidoc/browse_frm/thread/dfe5204d5b2c9685 +- Block titles take precedence over section titles to avoid titled + delimited blocks being mistaken for two line section titles (see + http://groups.google.com/group/asciidoc/browse_frm/thread/f0b6f9989f828c3). +- Section title trace displays level and title text. +- FAQ additions. +- Added `{zwsp}` (zero width space) attribute. +- Undefined paragraph styles are reported (previously threw a runtime + error). +- Eliminated empty preamble generation. +- Floating titles now processed in all contexts. +- Implemented auto-lettered appendix names and updated example + documents. +- Section numbering can be disabled in HTML outputs with a + ':numbered!:' AttributeEntry. +- xhtml11: Nicer default quote block styling. +- Exclude floating titles from xhtml11 table of contents. Patch + submitted by Mark Burton (see + http://groups.google.com/group/asciidoc/browse_frm/thread/14aefc1cb6bd85f5). +- Enhanced `doc/article-docinfo.xml` example docinfo file. +- Vim syntax highlighter improvements. + +.Bug fixes +- *FIXED*: Absolute 'imagesdir' and 'iconsdir' attribute path names + do not work with the xhtml11 data-uri encoding. See + http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6 +- *FIXED*: Regression issue with inline data-uri images. See + http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6 +- *FIXED*: An unexpected error occurred when processing a table + containing CSV data if the 'cols' attribute was not explicitly + specified. See + http://groups.google.com/group/asciidoc/browse_frm/thread/4b0f364b477ec165 + + +Version 8.5.1 (2009-10-31) +-------------------------- +.Additions and changes +- If an AsciiDoc document file begins with a UTF-8 BOM (byte order + mark) then it is passed transparently through to the output file. + The BOM is stripped from included files. See + http://groups.google.com/group/asciidoc/browse_frm/thread/e5e61823ff4203cd +- Added AsciiDoc 'role' attribute to quoted text. Sets 'class' + attribute in HTML outputs; 'role' attribute in DocBook outputs. See: + http://groups.google.com/group/asciidoc/browse_frm/thread/2aa3e5711d243045 +- Conditional attribute syntax extended: they now accept multiple ORed + or ANDed attribute names. +- The 'xhtml11' backend dynamically processes footnotes using + JavaScript. +- Tidied up and namespaced 'xhtml11' JavaScript. +- Superceded `javascripts/toc.js` with `javascripts/asciidoc-xhtml11.js`. +- Added 'disable-javascript' attribute ('xhtml11' backend). +- Styled HTML footnotes. +- Added links to HTML footnote refs. +- Added title attribute to inline image macros to display popup + ``tooltip'' (HTML outputs only). +- Single-quoted attribute values are substituted in block macros (just + like the AttributeList element). +- For consistency changed underscores to dashes in attribute names. + Public attributes with underscores retained for compatibility. +- Added Brazilian Portuguese language configuration file (contributed + by Thiago Farina). +- Added 'leveloffset' attribute to make it easier to combine + documents. + +.Bug fixes +- *FIXED:* a2x: `--dblatex-opts` is now processed last so + `asciidoc-dblatex.xsl` params can be overridden. Patch submitted by + Mark Fernandes (see + http://groups.google.com/group/asciidoc/browse_frm/thread/5215c99dcc865e7d). +- *FIXED:* An error occurred if a directory in current path with same + name as executable. + +Regression issues +~~~~~~~~~~~~~~~~~ +There's been quite a bit of tiding up to the xhtml11 JavaScript. The +most obvious change is that the toc.js script has been superceded by +asciidoc-xhtml11.js so if you're linking you'll need get a copy of +the new file from the distribution javascripts directory. + +If you use customised xhtml11 configuration file `[header]` and +`[footer]` sections and you want them to use the new footnotes feature +then you've got a bit more work to do: + +. The onload event expression changed. +. The new `<div id="content">...</div>` div envelopes document + content. +. You need to add `<div id="footnotes">...</div>` div to the + `[footnotes]` section for footnotes to work. +. Drop the `ifdef::toc[]` macro that surround JavaScript inclusion. + +Take a look at the [header] and [footer] changes in the xhtml11.conf +diff to see what's going on: +http://hg.sharesource.org/asciidoc/diff/55a5999bfd04/xhtml11.conf + + +Version 8.5.0 (2009-10-04) +-------------------------- +.Additions and changes +- Implemented a 'float' attribute for tables and block images (HTML + outputs only). +- Added `unfloat::[]` block macro to cancel floating. +- Added table 'align' attribute to (HTML outputs only). +- The image 'align' attribute now works with HTML backends. +- Renamed table cell 'align' attribute to 'halign' so it doesn't clash + with the new table 'align' attribute. +- Added 'breakable' and 'unbreakable' options to AsciiDoc example and + block image elements. +- `[miscellaneous]` section entries now update properly when set from + a document 'AttributeEntry'. +- `[miscellaneous]` section `pagewidth` entry accepts fractional + values. +- Fractional column widths are now calculated correctly when using + fractional 'pageunits' (DocBook tables). +- Use DocBook XSL table width processing instructions. +- asciidoc 'KeyboardInterrupt' exits with error code 1. +- Added 'set' system attribute to allow attributes to be set from + configuration file templates. +- Allow constrained quotes to be bounded on the left by a colons and + semicolons, see + http://groups.google.com/group/asciidoc/browse_frm/thread/b276a927fdc87995 +- Titled listing and literal blocks (DocBook outputs) no longer default + to examples. See + http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd +- Updated language file table, figure and example captions to + accommodate new auto-numbering in html4 and xhtml11 backends. +- Titled source highlight filter listings generated by docbook backend + are now rendered as examples. See + http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd +- Implemented 'counter' system attribute. +- Use 'counter' system attributes to number titled tables and block + images in HTML backends. +- Added program name suffix to console messages. +- Added substitution to the 'AttributeEntry' passthrough syntax, this + replaces the now unnecessary 'attributeentry-subs' attribute. +- Allow passthrough inline macro syntax to be used in + 'AttributeEntrys'. +- Reinstated 8.4.4 default 'lang' attribute behavior. See + http://groups.google.com/group/asciidoc/browse_frm/thread/d29924043e21cb6a. +- Added 'max-width' attribute to the 'xhtml11' backend to set maximum + display width. See + http://groups.google.com/group/asciidoc/browse_frm/thread/74d9a542b79ccd50. +- Added 'a2x.py', a rewritten and much enhanced version of the old + 'a2x' bash script. +- The new 'a2x' can output EPUB formatted documents. +- Added `--safe` option and deprecated `--unsafe` option. Patch + submitted by Todd Zullinger. See + http://groups.google.com/group/asciidoc/browse_frm/thread/ea3a8ea399ae5d2a + and + http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5 +- Added 'CHECK' and 'TEST' todo highlight words to Vim syntax + highlighter. +- Line breaks, page breaks, and horizontal rulers are now processed by + dblatex, thanks to a patch submitted by Mark Fernandes + (http://groups.google.com/group/asciidoc/browse_frm/thread/a254cf949ea7c6c5). +- Allow footnote macros hard up against the preceding word so the + rendered footnote mark can be placed against the noted text without + an intervening space (patch submitted by Stas Bushuev, + http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5). +- Normalized path in `safe_filename` function (submitted by Todd + Zullinger, + http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5). +- The Asciidoc 'numbered' and 'toc' attributes cause DocBook outputs + to include `asciidoc-numbered` and `asciidoc-toc` processing + instructions, these are used by DocBook XSL to include section + numbering and table of contents (like Asciidoc HTML backends). For + backward compatibility both 'numbered' and 'toc' attributes are + defined by default when the 'docbook' backend is used. See + http://groups.google.com/group/asciidoc/browse_frm/thread/1badad21ff9447ac. +- 'data-uri' attribute is now evaluated dynamically and can be set in + document body (previously could only be set from command-line). +- Added 'sys3' and 'eval3' system attributes to passthrough generated + output, this fixes the data-uri inline image problem: + http://groups.google.com/group/asciidoc/browse_frm/thread/a42db6bc54c2c537. +- Missing language file generates a warning instead of an error. +- Updated Spanish language file (updates contributed by Gustavo Andrés + Gómez Farhat). + +.Bug fixes +- *FIXED:* Options in an 'AttributeList' option attribute are merged + with (rather than replace) configuration file options. +- *FIXED:* Comment blocks and comment block macros no longer consume + preceding block titles and attribute lists. +- *FIXED:* `examples/website/layout1.conf` and + `examples/website/layout2.conf` TOC problem. Submitted by Mark + (burtoogle). See + http://groups.google.com/group/asciidoc/browse_frm/thread/b9c63be67dd1d11c +- *FIXED:* Only the first occurrence of passthrough macro was + substituted. Patch submitted by Peter Johnson. See + http://groups.google.com/group/asciidoc/browse_frm/thread/1269dc2feb1a482c +- *FIXED:* asciidoc now runs on Jython 2.5.0. +- *FIXED:* Wordpress margins and pads in a number of block + elements + (http://groups.google.com/group/asciidoc/browse_frm/thread/36ff073c79cbc20a). + +Regression issues +~~~~~~~~~~~~~~~~~ +- Tables generated by 'dblatex' occupy 100% of the available space + regardless of the 'width' attribute setting. To restore width + behavior change the 'pageunits' miscellaneous parameter to 'pt'. You + can do this from the command-line with the `-a pageunits=pt` option. + See {website}userguide.html#X89[DocBook table widths]. + + +Version 8.4.5 (2009-05-24) +-------------------------- +.Additions and changes +- Added manpage 'Name' and 'Synopsis' section title customization to languages + configuration files. +- Synopsis manpage section no longer mandatory. +- Section markup templates can be specified by setting the title's + first positional attribute or 'template' attribute. +- The article and book document header can now include a revision + remark. +- A 'role' attribute can now be applied to block elements. This adds + the 'role' attribute to DocBook elements. Patch submitted by + http://groups.google.com/group/asciidoc/browse_thread/thread/62278a054188a038[Noah + Slater]). +- Renamed 'revision' and 'date' attributes to more sensible and consistent + 'revnumber' and 'revdate' (old names deprecated but still + recognized). +- Moved backend specific attributes to Appendix H in User Guide. +- Renamed and generalized the docbook backend revision history + inclusion mechanism to 'docinfo' to reflect the use of all article + or book information elements. The old revision history names still + work but have been deprecated. +- Refactored docbook.conf headers. +- Moved line break replacement from `[replacements]` to + `[replacements2]` so the replacement occurs after the mailto macro. + This fixes bug + http://groups.google.com/group/asciidoc/browse_thread/thread/4bdcdfb0af773e2 +- The typewriter to punctuation apostrophe replacement can be escaped + with a backslash. +- Graphviz filter outputs images to 'imagesdir' if it is defined. +- Made the block image macro generic so that it can be used for filter + outputs. As a result Music and Graphviz filters: + * Have been greatly simplified. + * Honor the 'data-uri' attribute. + * 'html4' outputs no longer generate W3C validation warning. +- The 'iconsdir' attribute no longer requires a trailing directory + separator character. +- Removed borders around linked html4 images. +- Added 'html4' specific HTML output for music filter. +- 'a2x': Added `--unsafe` option (shortcut for + `--asciidoc-opts=--unsafe`). +- 'a2x': The FOP executable can now be named `fop` (this is the + default name in some distributions). +- Attributes are now substituted in the system macro attribute list. +- If the output is set to stdout (i.e. no output directory is defined) + then Music and Graphviz filters will output included images to the + source file directory. +- Added 'name' directive to 'testasciidoc'. +- Added lots of 'testasciidoc' new tests. +- Moved language specific configuration parameters into `lang-en.conf` + file. +- 'lang' attribute entry can be specified in the AsciiDoc source file + (preceding the header). +- Removed cruft from A-A-P scripts and documented them. +- Added German language config file (`lang-de.conf`) contributed by + Michael Wild. +- Added French language config file (`lang-fr.conf`) contributed by + Yves-Alexis Perez. +- Added Russian language config file (`lang-ru.conf`) contributed by + Artem Zolochevskiy. +- Added Hungarian language config file (`lang-hu.conf`) contributed by + Miklos Vajna. + +.Bug fixes +- *FIXED:* Multiple manpage names are now handled correctly when + generating DocBook output, each name now generates a separate + DocBook `<refname>` element. See + http://groups.google.com/group/asciidoc/browse_thread/thread/c93bb4db025225d8 +- *FIXED:* A problem that caused AttributeEntries preceding the header + to be overwritten when the language conf file loaded. +- *FIXED:* Possible inline macro name ambiguity e.g. link matches olink. +- *FIXED:* The documented macro definition deletion behavior had been + broken for a long time. +- *FIXED:* Email addresses not recognized when followed by a period + character. +- *FIXED:* Hyphens in mailto macros can delimit nested addresses e.g. + \bloggs@mail was processed inside + \mailto:joe-bloggs@mail-server.com[Mail]. +- *FIXED:* User name in FTP URI generated incorrect FTP link. See + http://groups.google.com/group/asciidoc/browse_thread/thread/1d796a9c9ddb2855 +- *FIXED:* Source highlighter now works with Wordpress backend (see + http://groups.google.com/group/asciidoc/browse_thread/thread/6d8c716748b109e3). + +[[X2]] +Regression issues +~~~~~~~~~~~~~~~~~ +. A colon following the date in the AsciiDoc header is treated as a + revision remark delimiter -- this could be an issue if you have used + a colon in the header date. + + +Version 8.4.4 (2009-04-26) +-------------------------- +.Additions and changes +- Added table column and row spanning. +- Table styles can now be applied per cell. +- Vertical cell alignment can be applied to columns and individual + cells. +- Added table 'align' attribute to set horizontal alignment for entire + table. +- Included Geoff Eddy's update of the experimental LaTeX backend. +- A new attribute named 'trace' controls the output of diagnostic + information. If the 'trace' attribute is defined then + element-by-element diagnostic messages detailing output markup + generation are printed to stderr. +- Added 'literal' paragraph style (allows 'literal' style to be + applied to normal paragraphs). +- Deleted unused `replacements2` from `xhtml11.conf`. +- Added `replacements2` to default substitutions. +- 'testasciidoc.py': messages to 'stdout', only diffs to 'stderr'. +- Added transparency to `smallnew.png` image. + +.Bug fixes +- All combinations of leading comments and attribute entries at the + start of a document are now skipped correctly. +- *FIXED:* `./configure` doesn't support `--docdir` as expected (patch + submitted by Artem Zolochevskiy) +- *FIXED:* Constrained quotes were incorrectly matched across line + boundaries e.g. the string `+\nabc+` incorrectly matched a monospace + quote. + + +Version 8.4.3 (2009-04-13) +-------------------------- +.Additions and changes +- DocBook outputs default to DocBook version 4.5 doctype (previously + 4.2). +- Configuration file `[specialsections]` definitions can be undefined + by setting their configuration entry values blank. +- The Makefile 'install' target depends on the 'all' target to ensure + pre-install patches are applied. +- 'testasciidoc.py' now emits user friendly messages if: + . the configuration file is missing. + . an illegal backend is specified. + . an illegal test number is specified. + +.Bug fixes +- Fixed + http://groups.google.com/group/asciidoc/browse_thread/thread/fd27add515597c06[missing + template section] error. +- The 'testasciidoc.py' `--force` option no longer deletes test data + files that were not specified. +- Dropped second quotes substitution in table cells -- it had + effectively disabled quote escaping in table cells. + + +Version 8.4.2 (2009-03-19) +-------------------------- +.Additions and changes +- Added {website}testasciidoc.html[testasciidoc], a tool to verify + AsciiDoc conformance. +- A warning is issued if nested inline passthroughs are encountered. +- 'asciidocapi': setting an attribute value to `None` will undefine + (delete) the attribute (this in addition to the `name!` attribute + name format that the `asciidoc(1)` command uses). + +.Bug fixes + + +Version 8.4.1 (2009-03-10) +-------------------------- +.Additions and changes +- AsciiDoc now has a {website}asciidocapi.html[Python API]. The + following minimal example compiles `mydoc.txt` to `mydoc.html`: ++ +[source,python] +------------------------------------------------------------------------------- +from asciidocapi import AsciiDocAPI asciidoc = AsciiDocAPI() +asciidoc.execute('mydoc.txt') +------------------------------------------------------------------------------- + +- Backtick quoting for monospaced text is now implemented as an + 'inline literal' passthrough. This makes more sense since monospace + text is usually intended to be rendered literally. See + <<X2,Regression issues>> below for the impact this may have on + existing documents. Here are some examples that would previously + have had to be escaped: + + The `++i` and `++j` auto-increments. + Paths `~/.vim` and `~/docs`. + The `__init__` method. + The `{id}` attribute. + +- Added `--doctest` option to `asciidoc(1)` command. +- Added an optional second argument to 'BlockId' element, this sets + the `{reftext}` attribute which in turn is used to set the `xreflabel` + attribute in DocBook elements. +- Added lists to `--help` syntax summary. +- `{infile}` and `{indir}` attributes reflect the current input file + (previously always referred to the root document). +- `{docfile}` (new) and `{docdir}` (previously deprecated) attributes + refer to the root document specified on the `asciidoc(1)` + command-line. +- Vim syntax highlighter improvements. +- Syntax summary command (`asciidoc -h syntax`) additions. +- Admonition icons now have transparent backgrounds. +- Changed yellow W3C badges to blue ones in page footers. + +.Bug fixes +- Dropped `asciidoc(1)` broken undocumented `--profile` option. +- Em dash replacement now recognized at start of block. + +Regression issues +~~~~~~~~~~~~~~~~~ +Replacing backtick quoting with the 'inline literal' passthrough +raises two regression scenarios for existing documents: + +1. You have escaped the expansion of enclosed inline elements, for + example: `\{id}`. You would need to delete the backslashes: `{id}` + (if you don't the backslashes will be printed). Mostly it's just a + case of interactively finding and replacing of all occurrences of + `\. + +2. There are enclosed inline elements, for example: `some *bold* + monospaced`. You would need to switch to plus character monospace + quoting: `+some *bold* monospaced+` (if you don't the enclosed + elements won't be expanded). + +If your existing documents include these cases and you don't want to +upgrade then use the `-a no-inline-literal` command-line option, +alternatively put this in `~/.asciidoc/asciidoc.conf`: + + [attributes] + no-inline-literal= + + +Version 8.3.5 (2009-02-02) +-------------------------- +.Additions and changes +- Cached compiled regular expression delimiters (speed up 'User + Manual' compilation by 250%). +- Created distinct list definitions for each numbered list style to + allow nesting of all styles. +- Roman numbers in numbered lists are followed by a closing + parenthesis instead of a period to eliminate 'i', 'v', 'x' item + ambiguity with respect to alpha numbered list items. +- Added `**`, `***`, `****`, `*****` + bulleted lists. +- Added `...`, `....`, `.....` implicit numbered + lists. +- Added `:::`, `::::` labeled lists. +- Updated User Guide for new list syntaxes. +- Optimized paragraph and list termination detection with separate + precompiled regular expressions for performance and to prevent + reaching Python 100 named group limit. +- Updated Vim syntax highlighter for new list syntaxes. +- Allow `template::[]` macros in conf file entries sections (not just + in template sections). +- Dropped unused `[listdef-numbered2]` conf file sections. +- Renamed 'ListBlock' to more appropriate 'OpenBlock'. +- Implemented single-line versions of `ifdef::[]` and `ifndef::[]` + macros. +- 'html4' backend styling: + * Underlined admonition captions. + * Added side border to Example Blocks. +- 'xhtml11' backend styling: + * Dropped right hand margin from all but quote and verse blocks. + * html4 backend: corrected over-sized width of caption in admonition + block. + +.Bug fixes +- Fixed broken numbered list nesting. + +Compatibility issues +~~~~~~~~~~~~~~~~~~~~ +The roman numbered list parenthesis syntax is incompatible with the +potentially ambiguous roman period syntax introduced in 8.3.2. + + +Version 8.3.4 (2009-01-20) +-------------------------- +.Additions and changes +- Implemented a title 'float' style. A floating title (or bridgehead) + is rendered just like a normal section but is not formally + associated with a text body and is not part of the regular section + hierarchy so the normal ordering rules do not apply. +- Implemented inline comment macro so comment lines can now appear + inside block elements. +- Comment lines are sent to the output if the 'showcomments' attribute + is defined (comment blocks are never sent to the output). +- Single quoting attribute values in 'AttributeList' elements causes + them to be substituted like normal inline text (without single + quoting only attribute substitution is performed). +- Rewrote list item processing (was very crufty). List continuation + and list blocks now work as expected. Updated and clarified list + documentation in User Guide. +- The 'revision' attribute now recognizes the RCS $Id$ marker format. +- An RCS $Id$ marker formatted revision line in the header does not + need to be preceded by an author line. +- If an RCS $Id$ formatted revision is specified and the author name + has not already been set then the author name in the $Id$ marker + will be used. +- Updated Gouichi Iisaka's Graphviz filter to version 1.1.3. +- Added 'autowidth' table attribute option for (X)HTML outputs. +- DocBook backend now puts 'orgname' optional attribute in DocBook + header. +- Deprecated undocumented 'companyname' attribute in favor of + DocBook's 'corpname'. +- Removed explicit closing backslash from HTML4 self-closing tags to + comply with WC3 recommendation. + +.Bug fixes +- Fixed 8.3.3 regression whereby adjacent lists with the same syntax + but different list styles were incorrectly treated as a single list. + + +Version 8.3.3 (2009-01-02) +-------------------------- +This release supersedes 8.3.2. + +.Bug fixes +- The broken and confusing numeration and numeration2 numbered list + attributes have been dropped, use the style attribute instead. + + +Version 8.3.2 (2009-01-01) +-------------------------- +.Additions and changes +- Added Gouichi Iisaka's Graphviz filter to distribution. +- The 'SidebarBlock' element can now be rendered with an 'abstract' + style. +- Reorganized filters into a separate subdirectory for each filter. +- Updated `Makefile.in` and `MANIFEST` files to reflect new filters + organization. +- Added 'listing' style to 'LiteralBlock' element so listings with + nested listing blocks can be rendered as a listing block. +- Changed example 'code' filter to use preferred 'ListingBlock' syntax + (the old `~` delimited filter syntax is no longer used). +- Implemented 'enumeration' and 'enumeration2' numbered list + attributes for specifying the list numbering style ('arabic', + 'loweralpha', 'upperalpha', 'lowerroman' and 'upperroman'). +- AsciiDoc now recognizes 'upperalpha', 'lowerroman' and 'upperroman' + numbers in `listdef-numbered2` numbered lists and sets the number + style based on the style of the first numbered list item + (alternative to setting 'enumeration2' attribute). +- Updated `formatlistpat` definition in `.vimrc` example in User + Guide. +- You can now backslash escape system block macros. +- Added 'Pychart' FAQ. +- Drop paragraph 'text' and list 'text', 'index' and 'label' match + groups from attributes -- they are included in the element's text + and we don't want them processed a second time as attributes. +- Changed comment line block macro to a passthrough block macro to + ensure no substitutions. +- A 'subslist' no longer has to be appended to a 'PassthroughBlock' + macro definition, if omitted no substitutions are performed. +- Code tidy up: replaced deprecated `<>` operator with `!=`. +- Removed unused linuxdoc code. +- Code tidy ups: dropped old types module reference; replaced + `has_key()` with preferred `in` operator. + +.Bug fixes +- Old syntax source highlight filter regression: special characters + where not escaped in DocBook outputs. + + +Version 8.3.1 (2008-12-14) +-------------------------- +.Additions and changes +- Replaced the `install.sh` script with Ben Walton's updated autoconf + scripts -- see {website}INSTALL.html[INSTALL] for details. +- Added a generalized 'AttributeEntry' syntax to allow arbitrary + configuration file entries to be set from within an AsciiDoc + document (suggested by Henrik Maier). +- Listing delimited blocks in DocBook outputs now support IDs; IDs of + titled Listing and Literal delimited blocks have been moved to the + enclosing DocBook example tag (thanks to Vijay Kumar for this + patch). +- Replaced vertical typewriter apostrophe with punctuation apostrophe + (thanks to Noah Slater). + +.Bug fixes +- Regression: Excluding double-quotes from unquoted attribute values + resulted in backward incompatibility, double-quotes in unquoted + attribute values has been reinstated. +- Regression: Text like `&...;` was sometimes mistaken for an entity + reference -- tightened up entity reference matching. + + +Version 8.3.0 (2008-11-29) +-------------------------- +.Additions and changes +- {website}newtables.html[AsciiDoc new tables] is a complete redesign + of the tables syntax and generation. The new syntax and features are + a huge improvement over the old tables. The old tables syntax has + been deprecated but is currently still processed. +- {website}newlists.html[Lists can now be styled] like other block + elements. This allows a single list syntax for 'glossary', 'qanda' + (Question and Answer) and 'bibliography' lists instead of having to + remember a different syntax for each type. +- Inline passthroughs macros have been improved and block passthrough + macros added. Attribute substitution can be optionally specified + when the macro is called. +- The passthrough block has a fully transparent passthrough delimited + block block style called 'pass'. +- The 'asciimath' and 'latexmath' + {website}userguide.html#X77[passthrough macros] along with + 'asciimath' and 'latexmath' {website}userguide.html#X76[passthrough + blocks] provide a (backend dependent) mechanism for rendering + mathematical formulas. There are {website}latexmath.pdf[LaTeX Math], + {website}asciimathml.html[AsciiMathML] and + {website}latexmathml.html[LaTeXMathML] examples on the AsciiDoc + website. +- Reimplemented and cleaned up filter processing based on a patch + submitted by Kelly Anderson. Uses the newer subprocess module + instead of the deprecated popen2 module. Now works in Win32 command + shell. +- Addition FAQs, more documentation updates. +- Arbitrary HTML/XML entities can be entered in AsciiDoc source. +- Did away with the need for the `shaded-literallayout.patch` (thanks + to Henrik Maier for this patch). +- Implemented 'page break' block macro. +- Added 'line breaks' and 'ruler' processing instructions to DocBook + outputs (thanks to Henrik Maier for this patch). +- Added 'deg' (degree) and 'wj' (word joiner) entity attributes + (thanks to Henrik Maier). +- Tweaked DocBook 'indexterm2' macro to avoid white space preceding + the term when used in table cells (thanks to Henrik Maier for this + patch). +- Title elements now process the 'options' attribute like other block + elements. +- Added `single quoted' element. +- Spaces on both sides of a -- em-dash are translated to thin space + characters. +- Improved detection and reporting of malformed attribute lists. +- The list 'compact' style is now a list option. +- Added 'strong' labeled list option which makes the labels bold (HTML + outputs only). +- Dropped unsupported 'linuxdoc' backend. +- Dropped deprecated 'xhtml-deprecated' (version 6) backend. +- Added 'breakable' and 'unbreakable' attribute options to tables to + control table breaking across page boundaries (DocBook XSL/FO + outputs). By and in collaboration with Henrik Maier. +- Added 'pgwide' attribute option to tables to table, block image, + horizontal labeled lists. Specifies that the element should be + rendered across the full text width of the page irrespective of the + current indentation (DocBook XSL/FO outputs). Thanks to Henrik Maier + for this patch. +- Vim syntax highlighter: spaces before/after bullets no longer + highlighted (which is ugly if using a theme that highlights with + underlines). Thanks to Donald Chai for this patch. +- Added `a2x(1)` `--fop` option. +- Added `a2x(1)` `--no-xmllint` option. +- Highlighted labelled list terms with the navy color in XHTML + outputs. +- Use `w3m(1)` as default `a2x(1)` text format generator (fallback to + `lynx(1)`). +- Changed callout formats in html4 and xhtml11 outputs to angle + brackets to match source highlighter rendering. +- Macros now inject user defined `<optionname>-option` attributes into + markup. +- Added IRC URLs to AsciiDoc inline macros. +- Added `depth` attribute to `include::[]` system macro. +- Added 'footnoteref' inline macro. +- Added 'stylesheet' XHTML attribute to specify additional custom CSS + stylesheet. +- If a paragraph style is specified it will be added to the XHTML + 'class' attribute and DocBook 'role' attribute. +- Replacements can be set in a document using the reserved + AttributeEntry name 'replacement'. +- The prefix for auto-generated section name IDs can be set with the + 'idprefix' attribute. + +.Bug fixes +- Escaped quote skipped over leading and trailing quote instead of + just the leading quote. +- Fixed bug that was causing false negative safe mode warnings (patch + submitted by Julien Palmas). +- Placed priority of AttributeEntry, AttributeList and BlockTitle + above Title. This ensures an AttributeEntry, AttributeList or + BlockTitle followed by a same length leading ListingBlock delimiter + is not mistaken for a two-line title. +- Vim syntax highlighter: fixed multi-line quoted text. +- Contstrained quote termination after non-space character enforced. +- Vim syntax highlighter: unterminated quoted text is no longer + highlighted. +- Vim syntax highlighter: passthroughs now exactly match AsciiDoc + semantics. +- Vim syntax highlighter: escaped quoted text, attribute references + and inline macros are not highlighted. +- Vim syntax highlighter: TODO's highlighted in CommentBlocks (thanks + to Scott Wall); non-greedy pass:[$$...$$]. +- Vim syntax highlighter: Comment lines mistaken for vertical list + labels (thanks to Scott Wall). +- Vim syntax highlighter: Single unmatched $$ mistakenly highlighted + remaining text (patch contributed by Scott Wall). +- Callouts now work in source highlighted listing generated by + dblatex. +- Fixed exception that occured if undefined attribute was present in + filter command. +- AttributeList block can now follow a paragraph without intervening + blank line. +- The include macro tabsize attribute is no longer propagated to + nested includes. + +.Omissions +The following features were implemented but then but removed from this +release: + +- 'pi', 'cdata' and 'comment' passthrough macros and passthrough block + styles (creeping featurism, use 'pass' macros instead). +- Generic 'tag' inline macro (creeping featurism, use 'pass' macros + instead). + + +[[X1]] +Compatibility issues +~~~~~~~~~~~~~~~~~~~~ +Version 8.3.0 has a number of backward incompatibilities with respect +to the previous 8.2.7 release: + +- The old table syntax is still processed but a 'DEPRECATED' warning + is issued. +- Entity references have to be escaped with a backslash. +- You have to explicitly precede horizontal style labeled lists with + the `[horizontal]` style attribute -- by default all labeled lists + are rendered vertically. +- The list 'compact' style has been dropped and is now a list option + (use `options="compact"` in attribute lists). +- AsciiDoc version 6 sytnax no longer supported. +- Linuxdoc been removed from the distribution. +- The unsupported experimental 'latex' backend has not been tested on + this release. +- The introduction of single-quote quoting requires that double-quote + quoting is escaped with two backslashes. + + +Version 8.2.7 (2008-07-04) +-------------------------- +.Additions and changes +- Added `dvi`, `ps` and `tex` output format options to a2x(1). +- Added `--dblatex` option to a2x(1) so `dblatex(1)` can be used to + generate PDFs. +- Added custom `dblatex(1)` configuration files (in distribution + `./dblatex` directory) that are used by a2x(1). +- `dblatex(1)` is now used to generate the distributed PDF version of + the AsciiDoc User Guide. +- If you don't need a customized the link caption you can enter the + 'http', 'https', 'ftp', 'file' URLs and email addresses without any + special macro syntax -- you get the links by just cutting and + pasting URLs and emails addresses. This also makes it easier to open + links directly form AsciiDoc source ( most editors allow you to open + URLs directly). The Vim syntax highlighter has been updated to + reflect these changes. +- Highlighted source code paragraphs have been implemented -- it's a + much more convenient way to enter short code examples (see + http://www.methods.co.nz/asciidoc/source-highlight-filter.html[the + online docs]). +- The source highlighter and music filter syntax has changed -- they + now used the ListingBlock syntax customized with 'source' and + 'music' style attribute values. This follows the Paragraph styling + convention introduced by the source paragraph (previous item) and is + easier to read. The old syntax still works but has been deprecated. +- QuoteBlocks now have a 'verse' style -- you no longer have to nest a + 'verse' LiteralBlock inside a QuoteBlock for verses. The 'verse' + style on the LiteralBlock has been deprecated (still works though) + and the 'style' attribute is positional attribute 1, pushing + 'attribution' and 'citetitle' attributes to the right (you'll need + to insert a 'quote' attribute into your existing QuoteBlocks). +- It is no up to the DocBook processor to highlight source code syntax + in `<programlisting>` elements rather than GNU Highlighter -- this + is the correct way to handle it, plus `dblatex(1)` makes a much + better job. +- 'scaledwidth' and 'align' attributes have been added to the 'image' + macro. They apply to DocBook outputs (specifically for PDF + documents). 'scaledwidth' sets the image size as a percent of the + available page width; 'align' applies 'left', 'center' or 'right' + horizontal image justification. +- Added a2x(1) `--fop-opts=FOP_OPTS` option (patch submitted by Miklos + Vajna). +- Added a2x(1) `--dblatex-opts=DBLATEX_OPTS` option. +- Added Mikhail Yakshin's FOP 0.95 patch which fixes a long-standing + `fo.xsl` problem and allows PDF's to be generated with FOP 0.95 + (previously had to use FOP 0.20.5). +- The User Guide has been updated and outdated FOP configuration and + installation sections removed. + +.Bug fixes +- Fixed `stylesheets/xhtml11-manpage.css` not being included when + 'linkcss' attribute was used. +- Configuration file `*-style` attributes are now dumped correctly. +- Fixed 'FAILED: malformed section entry' LaTeX backend error. + +See the also the https://sharesource.org/hg/asciidoc/[AsciiDoc +repository changelog]. + + +Version 8.2.6 (2008-04-29) +-------------------------- +.Additions and changes +- Enhancements to the Vim AsciiDoc syntax highlighter, for example, + quoted text is now highlighted in titles and macro captions. +- If you define the `data-uri` intrinsic attribute images referenced + by 'image' macros will be embedded in XHTML using the + http://en.wikipedia.org/wiki/Data:_URI_scheme[data: URI scheme]. + *NOTE*: Microsoft browser support for the 'data: URI scheme' is + currently limited to MSIE 8 beta 1. +- Added `toc-title` attribute to allow custom table of contents + titles. +- Added references to Alex Efros's AsciiDoc Cheatsheet to AsciiDoc + website. +- `asciidoc(1)` and `a2x(1)` man pages formatted to conform to + `man-pages(7)` recommendations. +- Old code-filter syntax (pre-8.1.0) is no longer recognized so that + malformed two-line level 2 titles are no longer confused with + 'code-filter' block delimiters. +- Added -> <- => <= arrow replacements from the Arrows block of + Unicode. +- Added DocBook refentry lang attribute -- patch contributed by + VMiklos. +- AttributeEntry names can now be numeric (``named macro targets''). +- Hide Table of Contents title if Table of Contents empty -- patch + contributed by Alex Efros. +- Various XHTML CSS tweaks. +- Code cleanup: + * Replaced `realpath()` with Python 2.2 `os.path.realpath()` library + function. + * Replaced old string library functions with string methods. + * Use file generators instead of `readlines()`. + * Renamed entities that shadowed builtins. + * Standardized string quoting. + * Dropped `readlines()` function. + +.Bug fixes +- Fixed broken CSS for decimal ordered lists nested in alpha ordered + list, thanks to Alex Efros. +- A missing closing block delimiter now reports the opening delimiter + line number instead of the end of file line number. +- Fixed an error generated by the asciidoc `-e` option when there are + no block definitions -- patch contributed by Alejandro Mery. +- Handle both `\r\n` (as well as `\n`) line separators that may be + returned by `{sys}` attribute evaluation. +- Numbered attribute names no longer interfere with positional + attribute list values. + + +Version 8.2.5 (2007-11-18) +-------------------------- +.Additions and changes + +.Bug fixes +- Fixed exception thrown by illegal command-line arguments. +- Rolled back the 'with' warning bug fix introduced in 8.2.4 -- it was + incompatible with Python <2.5. + + +Version 8.2.4 (2007-11-10) +-------------------------- +.Additions and changes +- You can now use the `lang` attribute to set the DocBook language + attribute. +- Attribute values can now contain attribute references. +- If the `lang` attribute is defined then configuration files named + like `lang-<lang>.conf` will be loaded automatically. +- The help file name `help-<lang>.conf` is based on the AsciiDoc + `lang` attribute, defaults to `help.conf` (English). +- Admonition, figure and table captions have been factored into a + predefined set of `caption_*` attributes. They only apply to + directly generated (X)HTML outputs (DocBook stylesheets generate + their own language specific captions based on the `lang` attribute). +- Dropped platform dependent `doc/asciidoc.chm` file from + distribution documentation formats. + +.Bug fixes +- The spurious warning 'with will become a reserved keyword + in Python 2.6' has been suppressed. + + +Version 8.2.3 (2007-09-12) +-------------------------- +.Additions and changes +- Added VMiklos's 'permalink' patch for auto-generated section IDs + (enabled by default by the `sectids` attribute). +- Added http://www.methods.co.nz/asciidoc/faq.html[FAQ] to website. +- Changed format of \{localdate} attribute to ISO 8601 (`%Y-%m-%d`). +- Added `abc2ly --beams=None` option to make `music2png.py` conform to + ABC's notion of beams. +- XHTML level 2 section headings are now styled with an underlining + border. +- XHTML links to AsciiDoc title elements are now implemented with + title ID attributes (previously separate `<a>` element targets were + generated. +- Multi-word first, middle and last names can be entered in the header + author line using the underscore as a word separator. +- The nested inline macros restriction has now been lifted, for + example you can now include links and inline images inside + footnotes. +- Help topic names can be shortened (so long as they are not + ambiguous). For example `asciidoc -hm` will print the AsciiDoc man + page. +- Added `{two_colons}` and `{two_semicolons}` attributes for + escaping labeled list ambiguity. +- If quirks mode is disabled the XHTML Mime Type is set to the + recommended `application/xhtml+xml` (rather than `text/html`). + +.Bug fixes +- Author information is now correctly set when using attribute entries + in the header instead of an author line (previously the 'author' + attribute was not being calculated correctly and there were + attribute substitution problems). + + +Version 8.2.2 (2007-07-22) +-------------------------- +.Additions and changes +- http://www.maths.nottingham.ac.uk/personal/drw/lm.html[LaTeXMathML] + capability has been added for users who are more familiar with or + prefer LaTeX math formulas to the + http://www.methods.co.nz/asciidoc/asciimathml.html[ASCIIMathML] + notation (thanks to Arthur Sakellariou for the patch). +- The 'source highlight' and 'code' filters now process embedded + callouts. +- Added an `--attribute=ATTRIBUTE` option to `a2x(1)` for passing + attribute values to asciidoc(1) (a shortcut for `--asciidoc-opts="-a + ATTRIBUTE"`). +- Image block and inline macros prepend optional `{imagesdir}` + attribute to image link targets. + + +.Bug fixes +- Fixed an assertion error that occurred when a configuration file + containing an `include::[]` macro was loaded using the + `--conf-file` option and the configuration file name did not + include an explicit directory path -- patch submitted by Dmitry + Potapov. +- Asciidoc titles are only converted to lower case if all characters + are upper case otherwise case is left unchanged -- patch submitted + by Dmitry Potapov. +- Added a missing check that input is not stdin before loading + configuration files from the document directory -- patch submitted + by Dmitry Potapov. +- Attribute list items must evaluate to strings, numbers or None + (previously it was possible to evaluate to other object types which + resulted in surprising attribute values). +- If an AsciiDoc document has no title an empty XHTML 1.1 'title' + element is created -- previously the 'title' element was dropped + which resulted in invalid XHTML 1.1. +- The Vim syntax file no longer highlights escaped callouts. +- The Vim syntax highlighter now correctly highlights Double-dollar + passthroughs when they enclose dollar delimited ASCIIMathML and + LaTeXMathML formulas. + + +Version 8.2.1 (2007-04-06) +-------------------------- +.Additions and changes +- A number of improvements have been made to the Vim syntax + highlighter, for example the word C++ is no longer mistaken for the + start of an unconstrained monospace quote. +- Labeled list definitions have been tightened -- a list label can no + longer containing trailing spaces. The following example is no + longer recognized as a valid list label: + + Lorum ipsum :: ++ +This change implements the originally intended behavior (as per the +AsciiDoc documentation and examples) so there should be very few +compatibility issues. + +.Bug fixes + + +Version 8.2.0 (2007-04-04) +-------------------------- +.Additions and changes +- A Vim syntax file is now included in the AsciiDoc distribution + (inspired by Felix Obenhuber's `asciidoc.vim` script). You can find + it (along with a Vim filetype detection script in the distribution + `./vim/` directory (the scripts are installed automatically by the + AsciiDoc installer `./install.sh`). See 'Appendix J' of the + 'AsciiDoc User Guide' for details. +- Added 'toclevel' attribute (1..4) which sets the number of title + levels reported in the table of contents. Defaults to 2 and must be + used with the 'toc' attribute. Example usage: + + $ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt + +- Added a `listindex` attribute which is the current list item index + (1..). If this attribute appears outside a list its value is the + number of items in the most recently closed list. +- The single line titles syntax now accepts trailing suffixes -- this + syntax matches the title line syntax of a number of popular Wiki + markups. +- If a QuoteBlock has no attribution or citetitle then the DocBook + `<attribution>` element is not generated (previously generated empty + `<attribution>` element). +- If the text of a labeled list item is blank then no `texttag` is + written. +- An end of line backslash performs line continuation for horizontal + labeled list items. +- The Revision line now accommodates Subversion `$Id` markers (in + addition to CVS and RCS markers). Thanks to Tiago Sturmer Daitx for + this patch. +- Implemented `a2x(1)` option `--skip-asciidoc` which allows `a2x(1)` + to convert DocBook XML files not derived from AsciiDoc sources. +- If `a2x(1) --doctype` option is not specified it defaults to + `manpage` if `--format=manpage` else defaults to `article` + (previously `--doctype` always defaulted to `article`). +- Added an 'External Resources' section to the + http://www.methods.co.nz/asciidoc/index.html[AsciiDoc home page]. + +.Bug fixes + + +Version 8.1.0 (2006-10-22) +-------------------------- +.Additions and changes +- AsciiDoc generated XHTML documents now display a table of contents + if the 'toc' attribute is defined (JavaScript needs to be enabled + for this to work). Thanks to Troy Hanson who contributed this + feature based on a JavaScript by Mihai Bazon. I've simplified things + somewhat to match Docbook XSL Stylesheets style, see Troy's + http://tpl.sourceforge.net/userguide.html[tpl User Guide] for a + fancier layout. Use the `-a toc -a numbered` command-line options to + produce a number table of contents. +- A http://www.methods.co.nz/asciidoc/music-filter.html[music filter] + is included in the distribution `./filters/` directory. It + translates music in http://lilypond.org/[LilyPond] or + http://abcnotation.org.uk/[ABC] notation to standard classical + notation in the form of a trimmed PNG image which is inserted into + the AsciiDoc output document. +- Incorporated Paul Melis's Win32 filter patch. This workaround + allows AsciiDoc to run filters under Windows. +- Added `uninstall.sh` script. +- Rather than proliferate a confusing number of filter block + delimiters the following convention has been adopted: delimiters + belonging to DelimitedBlock filters distributed with AsciiDoc will + consist of a word (normally a noun identifying the block content) + followed by four or more tilde characters. This has necessitated + changing existing filter delimiters (the old delimiters still work + but may be deprecated in future versions): + + * The example code filter block delimiter is now the word `code` + followed by four or more tilde characters. + * The source highlight filter block delimiter is now the word + `source` followed by four or more tilde characters. + +- Conditionally redefined subscript and superscripting so they use the + old replacements mechanism when asciidoc7compatible is defined + rather than the asciidoc 8 default unconstrained quoting (patch for + affected files attached). +- Moved the source highlight filter from `./examples/` to `./filter/`. +- Added `{verbose}` intrinsic attribute (useful for passing verbose + flag to filters). +- Added `{outdir}` intrinsic attribute. +- Renamed `{docdir}` intrinsic attribute to unambiguous `{indir}` + (`{docdir}` still works but may be removed in future release). +- If `asciidoc(1)` outputs to stdout then intrinsic attribute + `{docname}` is extracted from the input file name. + + +Version 8.0.0 (2006-08-27) +-------------------------- +********************************************************************* +This is a major release because changes to quoting and index entry +handling may break existing documents (see 'Additions and changes' +below and 'Appendix A: Migration Notes' in the AsciiDoc User Guide). + +Please report any problems you encounter. + +mailto:srackham@gmail.com['Stuart Rackham'] +********************************************************************* + +.Additions and changes +- Quoting can can occur within words (based on patch submitted by + Benjamin Klum). See the 'Unconstrained Quotes' sub-section in the + User Guide. + +- The underline and plus characters can be used as alternatives to the + existing apostrophe and backtick quote characters. They are arguably + better choices than the apostrophe and backtick as they are not + confused with punctuation. + +- The syntax for index entry macros have have been deprecated from + `+...+` and `++...++` to `((...))` and `(((...)))` respectively. + Rationale: + * Bracketing is consistent other with `[[...]]` and `<<...>>` + reference macros. + * To easily confused with triple plus passthroughs. + * To make way for the new monospace quoting. + +- Superscripts and subscripts are implemented as constrained quotes so + they can now be escaped with a leading backslash and prefixed with + with an attribute list. + +- An experimental LaTeX backend has been written by Benjamin Klum (a + number additions in this release are to accommodate the LaTeX + backend). +- `include` macro file names now expand environment variables and + tilde expansions. +- A configuration file `[quotes]` entry can be undefined by setting to + a blank value. +- Added `callto` inline macro for Skype 'callto' links. +- Added `colnumber` attribute for table data markup. +- A leading comment block or comment lines are now skipped (previously + a document had to start with either attribute entries or a document + Title). +- Experimental `rows` attribute (number of source lines in table) + available in table markup templates (used by experimental LaTeX + backend). +- Included install shell script written by mailto:jlm@ofb.net[Jacob + Mandelson] for installing the tarball distribution. +- Added INSTALL documentation file. +- Added 'replacements2' substitution options -- a second replacements + section. +- Added the ability to redefine 'normal' and 'verbatim' substitutions + with `subsnormal` and `subsverbatim` entries in configuration file + `[miscellaneous]` section. +- By default `AttributeEntry` values are substituted for + `specialcharacters` and `attributes`, if you want a different + AttributeEntry substitution set the `attributeentry-subs` attribute. +- The `name` in `name=value` configuration file entries can now end + with a backslash, just escape the trailing backslash with a + backslash. For example: + + abc\\=xyz ++ +Results in `name=abc\` and `value=xyz` -- previously this would have +escaped the `=` character. + +- A blank configuration file section deletes any preceding section + with the same name (applies to non-markup template sections). +- A command-line attribute value with a `@` suffix does not override + existing document and configuration file attributes (normally + command-line attributes have precedence over document and + configuration file attributes). +- `localtime` attribute is now encoded from the native system encoding + to the output encoding. Patch submitted by + mailto:m_pupil@yahoo.com.cn[FKtPp] -- here's his description of the + problem: ++ +``I am a Chinese user of AsciiDoc and I find that when I use UTF-8 +(the default encoding) to write asciidoc documents in Windows platform +the resulting html footer line will get screwed. It was caused by a +localized tzname that was always encoded in the windows native +encoding, which in my case is 'cp936'.'' + +- a2x(1) can generate Open Document Text files using + http://open.comsultia.com/docbook2odf/[docbook2odf]. Currently + `docbook2odf(1)` only processes a subset of DocBook, unimplemented + elements are skipped. +- The a2x(1) format option defaults to `xhtml` (previously a format + had to be specified explicitly). +- The `-d, \--doctype=DOCTYPE` option has been added to a2x(1) which + is a shortcut for `--asciidoc-options="--doctype=DOCTYPE"`. +- Replaced a2x(1) `--no-icons` and `--no-copy` options with their + negated equivalents: `--icons` and `--copy` respectively. The + default behavior has also changed: copying and use of icons is + disabled by default. Rationale: + * To make the default behavior more consistent since use of icons + and CSS stylesheets does not apply to all formats. + * To make the default behavior less surprising (the creation of icon + and stylesheet output files must now be explicit). + +- a2x(1) has been bumped from version 0.1.1 to version 1.0.0. + + +.Bug fixes +- Removed duplicate `./doc/a2x.1.txt` from distribution tarball. +- Documentation errata. +- Attribute replacement is no longer performed twice in Titles and + AttributeEntrys. +- a2x(1) skipped asciidoc(1) execution when rerun with different + `--asciidoc-options` options, it now always executes asciidoc(1). + The problem was that previously asciidoc(1) was executed only if the + output file was missing or older than the source file. + + +Version 7.1.2 (2006-03-07) +-------------------------- +.Additions and changes +- Support for + http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML] + has been added. See 'Appendix I: ASCIIMathML Support' in the User + Guide and the examples at + http://www.methods.co.nz/asciidoc/asciimath.html. +- You can now prefix quoted text with inline attributes lists. You + can use this to set font size and color (XHTML and HTML outputs). +- Added `##...##` quoting -- it does nothing -- it's purpose is to + allow inline attributes to be applied to normal text. +- An 'inline passthrough' mechanism has been implemented. +- Configuration file comment lines can be escaped with a backslash -- + this is to allows the inclusion of configuration lines that start + with a hash character. +- The `scriptsdir` attribute can be used to specify the name of the + directory containing linked JavaScripts (see the + link:userguide.html#X33[User Guide] for details. +- The BackendBlock has been renamed PassthroughBlock for consistency + with the new inline passthrough naming. +- `a2x(1)` now works with the older `bash(1)` version 2.05b. Patch + submitted by mailto:francis@daoine.org[Francis Daly]. +- Content included by the `include1::[]` system macro is no longer + subject to attribute substitution so that ambiguities no longer + arise when used to include CSS or JavaScript files. + + +Version 7.1.1 (2006-02-24) +-------------------------- +.Additions and changes +- The `caption` attribute can be used to customize admonition captions + as well as image, table and example block element title prefixes + (`xhtml11` and `html4` backends). +- You can now override the default icon image using the `icon` + attribute to specify the path of the linked image (xhtml11 and html4 + backends only). +- The deprecated `imagesdir` attribute is no longer recognized (use + `iconsdir` instead). +- Added 'Appendix H: Using AsciiDoc with non-English Languages' to the + AsciiDoc User Guide. +- Added 'Admonition Icons and Captions' subsection to the User Guide + explaining how to customize Admonition elements. + +.Bug fixes +- `a2x(1)` failed when configuration files were installed in the + global `/etc/asciidoc/` directory -- it was only searching the + directory containing the asciidoc executable (thanks to Christian + Wiese for finding and submitting a patch this bug). +- The html4 backend admonition caption now correctly displays the + admonition `caption` attribute (previously displayed the `style` + attribute). + + +Version 7.1.0 (2006-01-13) +-------------------------- +.Additions and changes +- `a2x(1)` toolchain wrapper utility. This overcomes the biggest + hurdle for new users which seems to be assembling and using a + working DocBook XML toolchain. With `a2x(1)` you can generate XHTML + (chunked and unchunked), PDF, man page, HTML Help and text file + outputs from an AsciiDoc input file with a single command. All you + need to install (in addition to AsciiDoc) is xsltproc(1), DocBook XSL + Stylesheets and optionally FOP (if you want PDF) or lynx(1) (if you + want text). +- Block titles can now start with any non-space character (previously + where not allowed to start with `.~-_` characters). +- `./stylesheets/docbook.css` renamed to + `./stylesheets/docbook-xsl.css` to clarify its function. +- Renamed `./docbook-xsl/manpages.xsl` to `./docbook-xsl/manpage.xsl` + for consistency. +- Admonition and navigation icons moved to `./images/icons/` to + clarify usage and conform with a2x(1) usage. +- Renamed xhtml11 intrinsic attribute `imagesdir` to `iconsdir` to + keep vocab consistent and changed default value to `./images/icons` + (previously `./images`). `imagesdir` attribute still accepted but + deprecated. +- Unused image files have been weeded out of the distribution. +- Packager notes (appendix B) have been updated to reflect the needs + of `a2x(1)`. + +IMPORTANT: The renaming of the xhtml11 backend `imagesdir` intrinsic +attribute and it's new default value introduces a backward +compatibility issue: if you use the `icons` attribute you will need to +either move your icons to the new default `./images/icons` location or +include an `--attribute{nbsp}iconsdir="your_icons_path"` option in +your asciidoc commands. + +.Bug fixes +- Backslash line continuation is now observed in verbatim paragraphs. +- Fixed errors generated by example + `./examples/website/build-website.sh` script. + + +Version 7.0.4 (2005-12-08) +-------------------------- +.Additions and changes +- Added ternary conditional attributes + `{<name>@<regexp>:<value1>[:<value2>]}` and + `{<name>$<regexp>:<value1>[:<value2>]}`. +- Safety violations now generate errors (they previously generated + warnings). +- asciidoc(1) now defaults to safe mode, consequently the + `[miscellaneous]` safe mode entry and `--safe` command-line option + are no longer necessary (though for backward compatibility + asciidoc(1) still accepts the `--safe` option). +- Backend Blocks are now flagged unsafe (they could be used to include + arbitrary and hence potentially unsafe output content). +- Filters are no longer considered unsafe. There's not much point in + insisting on filter safety since the installation of an unsafe + filter would require the introduction of new or modified + configuration files -- if your application configurations can be + compromised you're in all sorts of trouble (safe mode protects + against unsafe input files not unsafe configuration). As with all + filters, before installing, you should verify that they can't be + coerced into generating malicious output or exposing sensitive + information. + +.Bug fixes +- Fixed a lot of glaring grammatical and factual errors in the User + Guide. + + +Version 7.0.3 (2005-12-01) +-------------------------- +.Additions and changes +- Added `--safe` and `--unsafe` command-line options -- AsciiDoc can + now be executed in a 'safe mode' which disallows the execution of + arbitrary code or the inclusion of arbitrary files (see + link:userguide.html#X39[Appendix C in the AsciiDoc User Guide]). +- Included link:source-highlight-filter.html[source-highlight filter] + in the distribution `./examples/source-highlight-filter/` directory + (based on filter submitted by mailto:trolocsis@gmail.com[Ryan + Phillips]). +- Included the DocBook XSL Stylesheets 1.69.1 customizations used to + generate the distributed AsciiDoc documentation (read the + `asciidoc-docbook-xsl.txt` file in the distribution `./docbook-xsl/` + directory). +- AsciiDoc DocBook XSL Stylesheet drivers moved from `./doc/` to + `./docbook-xsl/`. +- Modified `./doc/manpages.xsl` so only URL content is displayed in + manpages. + +.Bug fixes +- Explicitly set table CSS border style (`xhtml11` backend) to `solid` + because default border styles vary from browser to browser. + + +Version 7.0.2 (2005-08-28) +-------------------------- +.Additions and changes +- There are now long versions of all AsciiDoc options. +- If the `--backend` is not specified it defaults to `xhtml11`. +- Added CSS simulated frames layout to the examples website (see + `./examples/website/layout2/README-website.txt`). This layout does + not work with IE6 and the original tables based layout is still the + default. +- Support page added to AsciiDoc website. + +.Bug fixes +- Invalid options are now trapped gracefully. +- Documentation errata. + + +Version 7.0.1 (2005-06-24) +-------------------------- +.Additions and changes +- Reverted to use of `strong`, `em`, `tt` XHTML tags -- they're more + obvious and no less correct than `span` tags, besides, the generated + file sizes are smaller (the 'User Guide' was 11% smaller). +- Table title rendered with `caption` tag rather than a separate + `div`. +- The AsciiDoc 'stylesdir' attribute (if specified) is now recognized + when searching for embedded stylesheets (previously only searched + default `./stylesheets` directory). +- Default charset encoding changed from ISO-8859-1 to UTF-8 -- it's + less language specific and displays most common languages. +- `template::[]` macros now expand in all configuration file sections + previously only in markup template sections. +- Cleaned up example website layout CSS and configuration + (presentation has not been changed). +- Refactored `xhtml11.conf` configuration file. +- Set consistent and sensible permissions on distributed files. +- White space is now stripped from DSV formatted table cell data. +- `class="tableblock"` attribute added to tables generated by + `xhtml-deprecated-css.conf` to assist CSS. + +.Bug fixes +- Illegal character set encoder (specified by the AsciiDoc `encoding` + attribute) and character data are trapped gracefully. +- AsciiDoc table 'format' attribute in table attribute lists were not + recognized. +- The nested horizontal labeled list example in the 'AsciiDoc User + Guide' has been dropped -- it generated invalid DocBook markup. + + +Version 7.0.0 (2005-06-06) +-------------------------- +*************************************************** +This is a major release with many code and +documentation changes. +Please report any problems you encounter. + +mailto:srackham@gmail.com['Stuart Rackham'] +*************************************************** + +.Additions and changes +- A new 'xhtml11' backend generates XHTML 1.1 with integrated CSS2 + replacing the previous 'xhtml', 'css', and 'css-embedded' backends. +- The CSS stylesheets have finally been rewritten. +- The asciidoc(1) command help now includes user + link:userguide.html#X36[customizable help] topics. When asciidoc is + invoked with the `--help` option the command argument is + interpreted as a help topic. +- The previous example website has been replaced by the actual + AsciiDoc website (see `./examples/website/`. +- XHTML generation options now controlled by the following attributes: + 'badges', 'linkcss', 'icons', 'numbered', 'quirks', 'theme', + 'stylesdir', 'imagesdir' (see the link:userguide.html#X33[User + Guide] for details. +- By default HTML and XHTML are output as stand-alone documents (no + embedded CSS and no linked admonition icon images). +- Documents encoded with the UTF-8 Unicode character set are now + processed thanks to a patch supplied by + mailto:viktor@rbg.informatik.tu-darmstadt.de[Viktor Vasilev]. +- The `-a ^name` command-line syntax to undefine an attribute has been + deprecated in favor of the `-a name!` syntax. +- AttributeEntry syntax addition: `:name!:` to undefine `name` attribute. +- Added `template` system block macro to allow the inclusion of one + configuration file template section within another. +- A 'verse' style attribute can now be applied to literal paragraphs + and blocks to reproduce line breaks and white space from the source + document. +- Replacements and Special Words can now be escaped with leading + backslashes. +- Replacements are now processed in configuration file order (previous + ordering was indeterminate). +- System macros can now be used in the base `asciidoc.conf` + configuration file. +- Deprecated features that emitted warnings in prior versions are no + longer tolerated. +- The `eval` system attribute expression evaluates to `False` the + attribute is undefined, if it evaluates to `True` the result is an + empty string. +- The Paragraph and DelimitedBlock 'presubs' parameter can be aliased + as 'subs'. +- Added 'verbatim' substitutions option. +- Renamed 'List Continuation Block' to 'List Block' and renamed the + 'listcontinuation' option to 'list'. +- Deprecated 'default' substitutions option (use 'normal' instead). +- The 'section-numbers' section numbering attribute has be renamed + 'numbered'. +- Dropped the '\#UNDER CONSTRUCTION#' block macro. +- Rewrote Paragraph and DelimitedBlock handlers adding a + link:userguide.html#X23[styles] configuration entry. + +.Bug fixes +- Included files are no longer read inside conditionally excluded + content. +- Manpage command names containing dashes (in the manpage NAME + section) were misinterpreted as the spaced dash command name/purpose + separator. Bug report and patch supplied by + mailto:david@dgreaves.com[David Greaves]. +- Unexpected error following malformed author line error. + + +Version 6.0.3 (2005-04-20) +-------------------------- +.Additions and changes +- Special characters are now substituted in AttributeEntry element + values. +- Spaced and unspaced em dashes are now recognized (previously only + spaced em dashes were recognized). +- Replaced the table 'noborders' option with richer 'frame' and 'grid' + attributes. +- The `duplicate macro` warning message now only occurs when the + verbose (`-v`) option is enabled. +- Single lines starting with two forward slashes hard up against the + left margin are treated as comments and are not processed. +- Renamed 'section' delimited block option to 'sectionbody' to more + accurately reflect it's role. +- Added a List Continuation block -- a specialized delimited block + that is functionally equivalent to the List Item Continuation + feature except that the list contained within the block does not + require explicit '+' list item continuation lines. +- Dropped deprecated `<u>` tags from generated HTML. +- Literal Block delimiters must now consist of at least four points + (previously three) to avoid lone ellipsis ambiguity. + +.Bug fixes +- Some system attribute evaluation failures caused unexpected + exceptions to occur. + + +Version 6.0.2 (2005-03-30) +-------------------------- +.Additions and changes +- Three new 'system' block macros have been added -- `eval`, `sys` and + `sys2` which are the block macro equivalents to the same named + system attributes. +- 'Intrinsic' macros have been renamed 'system' macros along with + 'action' attributes which have been renamed 'system' attributes: + * To reflect their common (though contextually different) behavior. + * To avoid confusion with 'intrinsic attributes'. + +.Bug fixes +- Asciidoc now searches in `/etc/asciidoc/filters` for filters. + + +Version 6.0.1 (2005-03-06) +-------------------------- +.Additions and changes +- A global configuration file location `/etc/asciidoc` has been added + and is now processed before all other locations (patch supplied by + mailto:stone@debian.org[Fredrik Steen]). +- Recoded `tempfile.mktemp()` and other artifacts that are no longer + necessary or desirable (patches supplied by + mailto:stone@debian.org[Fredrik Steen]). +- Added BUGS file to the distribution. + +.Bug fixes +- Illegal comment syntax in `css-embedded-stylesheet.conf` resulted in + illegal CSS in files generated by the `css-embedded` backend. + + +Version 6.0.0 (2005-01-28) +-------------------------- +*************************************************** +This release has had some fairly major code and +documentation changes. Please report any problems +you encounter. + +mailto:srackham@gmail.com['Stuart Rackham'] +*************************************************** + +A lot of new stuff. A new major version number -- some regression +incompatibility (hopefully mitigated by 'deprecated' warnings). + +Went mad trying to rein in the current feature anarchy -- established +a unified notion of document attributes. Attempted to introduce a +consistent vocabulary -- renamed many poorly or inconsistently named +entities. + +Actually, deprecated syntax is still processed correctly in almost all +cases. One source of incompatibility that may arise if you have +customized CSS stylesheets is the change of AsciiDoc CSS class names +(see below). I guess the moral is if you've done a lot of +configuration file customization and are happy with version 5 then you +may want to stay put. + +NOTE: This version requires Python 2.3 or better to run. + +.Additions and changes +- 'Glossary entries' have been renamed 'attributes'. This eliminates + confusion with the accepted meaning of glossary. +- An `AttributeEntry` block element has been added so that document + attributes can be assigned from within an AsciiDoc document. +- The `AttributeList` block element has been added which is a more + general solution than the (now deprecated) DelimitedBlock arguments. +- An BlockId element has been added for setting block element anchor + (link target) IDs. +- Quoted text can now span multiple lines (thanks to James Bowlin for + this patch). +- Inline macros can now span multiple lines. +- \``double backtick / apostrophe'' quotes generate ``curly quotes''. +- A warning is now emitted for out of order list item (applies to + explicitly enumerated numbered list items). +- Added `include` action attribute. +- A line of three or more apostrophes generates an HTML horizontal + ruler (`<hr/>` tag). You will get a warning if processed with + non-HTML backend. +- An `{imagesdir}` attribute specifies image file location for images + referenced in configuration files when generating HTML (the default + location is `images`). +- An `{stylesdir}` attribute specifies the location of CSS + stylesheets when generating styled HTML (the default location for + configured markup is `.`). +- The use of the (often inappropriately named) `{caption}` attribute + list entry has been deprecated, use `{0}` instead. +- New 'ExampleBlock' delimited block along with associated variants + Note, Tip, Warning, Caution and Important. +- The `docbook.conf` file now facilitates the optional inclusion of a + DocBook revision history file. +- To better reflect their purpose the following block elements have + been renamed: `VerbatimBlock` to `ListingBlock`; `IndentedBlock` to + `LiteralBlock`; `IndentedParagraph` to `LiteralParagraph`; + `CustomBlock` to `BackendBlock`; `SimpleSection` to `SectionBody`. + Any corresponding CSS class names have also been changed which could + result in backward incompatibility in customized stylesheets. +- Swapped plain DocBook admonition icons for Jimmac's DocBook icons + (http://jimmac.musichall.cz/ikony.php3). The original plain icons + have been moved to `./images/plain`. +- Renamed `html` backend to `xhtml` to better reflect it's function + (former `html-4` backend renamed to `html`). +- A new inline anchor macro syntax `[[[<id>]]]` is available, it + displays `[<id>]` at the anchor location and is for anchoring + bibliography list entries. +- An optional 'single-line titles' syntax can be used. +- Tweaks to distributed CSS stylesheets and FOP `fo.xsl` customization + file. +- 'List Item Continuation' has been implemented which allows + additional block elements to be included in list items by separating + them from the preceding list item element with a line containing a + single plus character. +- A new 'Horizontal Labeled List' list type has been added. Generates + two column list -- the first column contains the list element + labels, the second contains the element text. Same syntax as + `Vertical Labeled Lists` except the double colon label suffix is + followed by the start of the list item text. + +.Bug fixes +- Fixed broken backslash line continuation. +- Labeled list end tags were not undergoing attribute substitution. +- Documents without any author information now generate legitimate + DocBook (previously if the author line was not included in the + document header then an empty (illegal) DocBook `author` element was + generated). +- Multiple spaces in filter command arguments were replaced by a + single space. The `./examples/asciidoc2text/asciidoc2text.sh` script + now indents text correctly. + + +Version 5.1.1 (2004-10-10) +-------------------------- +*15-December-2004: Interim update:* Updated `asciidoc.py` to fix +broken `join_lines` function -- no other changes. + +- PDF documentation is now produced from DocBook XML using XSLTLib and + FOP. Previously we processed DocBook SGML with `jw(1)` (which used + Dvips to convert DVI files to PDF). FOP has come a long way in the + last 12 months and produces very acceptable PDF under both Linux and + Windows. +- Sections detailing how to install and use the DocBook XSL + Stylesheets, xsltproc, FOP toolchain and the AsciiDoc XSLT drivers + have been added to the User Guide. +- The PDF output from the he example article template has been + included in the distribution (`./doc/article.pdf`). +- Special characters are emitted using decimal Unicode character codes + (previously used named character entities which cannot be assumed + included in non-HTML documents). +- Added registered trademark (R) to `[replacements]`. +- CSS stylesheet tweaks. +- Admonitions (Note, Tip, Important, Warning, Caution) include icons + when generating css output. + + +Version 5.1.0 (2004-09-18) +-------------------------- +- Callouts have been implemented (see the 'Callouts' section of the + AsciiDoc User Guide for details). +- Added XSL drivers for generating XHTML, chunked XHTML and HTML Help + from DocBook XML using XSL stylesheets and xsltproc(1). +- Added CSS stylesheet for HTML generated from DocBook XML using XSL + stylesheets. +- Distribution contains HTML Help formatted User Guide + (`./doc/asciidoc.chm`), the User Guide tells you how it's generated. +- Images referred to by distributed stylesheets are now located in the + `./images` subdirectory (previously located in `.`). +- Filters path names are now handled properly under Cygwin. +- The usual documentation and examples additions, updates and + polishing. + + +Version 5.0.9 (2004-09-09) +-------------------------- +- The convention of using a `.asc` file extension for AsciiDoc files + has been dropped in favor of the familiar `.txt` extension. It makes + more sense in that AsciiDoc is a text presentation format and + because `.asc` clashed with the same extension used by other + applications. It's only a naming convention -- you don't have to + switch if you don't want to. +- Changed the subscript formatting character from underline to tilde + since underscores in file names are reasonably common (especially in + link and image macros). +- An alternative syntax for the index term inline macro has been + added: `++<primary>,<secondary>,<tertiary>++`. +- Index terms that have secondary and tertiary entries now + additionally generate separate index terms for the secondary and + tertiary entries. +- A `+<primary>+` index term inline macro has been added which + displays the term in the primary text flow. +- Added alternative variable list definition using double semi-colon + terminator as opposed to the standard double colon terminator so + variable lists can be nested to two levels. +- Footnotes now appear on a separate line in HTML and Linuxdoc + outputs. +- Python version compatibility is checked at startup. +- Preface and appendix section titles in multi-part Book documents are + meant to be out of sequence -- warnings are no longer emitted when + outputting HTML. +- Empty section warnings have been replaced by error messages and are + emitted only if invalid markup would result. +- Missing macro sections or invalid macro name warnings are only + generated at startup if the `-v` (verbose) option is set. Otherwise + they are deferred until a matching macro is encountered in the input + file. +- Missing or invalid table definition warnings are only generated at + startup if the `-v` (verbose) option is set. Otherwise they are + deferred until a matching table is encountered in the input file. +- AsciiDoc now makes more of an effort to continue in the face of + errors. +- Fixed broken `./examples/website/main.aap` script. +- Converted distribution text files DOS text format as a sop to + Windows users with challenged text editors. +- Documentation additions and corrections. + + +Version 5.0.8 (2004-05-15) +-------------------------- +- Spurious 'out of sequence' level 2 warnings no longer appear when + processing 'book' document multi-part book top level Preface and + Appendix sub-sections since they are (correctly) out of sequence. +- A warning is no longer emitted for empty Index sections since this + is normal when generating DocBook outputs. +- Fixed: `[quotes]` configuration file entries where not being + overridden by downstream configuration file entries. +- Footnote text is now output enclosed in square brackets in HTML + documents. +- Added superscripts and subscripts to the standard PRS configuration + files. +- Adjusted CSS stylesheets so list titles don't have so much space + between title and first list item (broken in IE6 due to poor CSS + compliance). Lessened sidebar title top margin. + + +Version 5.0.7 (2004-04-22) +-------------------------- +- The version 5.0.6 README incorrectly stated that AsciiDoc would run + under Python 2.0, in fact it requires Python 2.1 or better. The + README has been corrected. +- Documented techniques for combining and splitting AsciiDoc documents + and processing the combined and split parts (see the 'Tips and + Tricks' section of the User Guide). +- An example of marking up superscripts and subscripts is documented + in the 'Tips and Tricks' section of the User Guide (the example + configuration file is in the AsciiDoc `examples` directory). +- Added ellipsis to shipped `[replacements]`; three periods output an + ellipsis entity. +- Removed unused 'SectionClose' class. +- The AsciiDoc 'Preamble' element is output as a DocBook 'Preface' + when processed as a 'book' document type (in older AsciiDoc versions + a warning was issued and processing stopped). +- Fixed a quoting anomaly: quoted text can no longer begin or end with + with white space. + + +Version 5.0.6 (2004-03-07) +-------------------------- +- New 'image' macro implements optional image scaling and linking and + works in both inline and block contexts. The 'image' macro obsolesces + the existing 'graphic' block macro and 'icon' inline macro. +- Macro substitution section names now have `-inlinemacro` and + `-blockmacro` suffixes to resolve context ambiguity, make their + purpose clearer and relieve section namespace congestion. +- Header derived glossary entries can now be overridden from the + command-line. +- Special character substitution is now performed on AuthorLine + derived author names. +- A macro or block argument called 'options' can be used as a shortcut + for a list named arguments with zero length string values. +- Tables can be output without borders using the `options="noborders"` + argument. +- Table data lines that do not immediately follow a table section + underline can now be blank. This allows CSV data with embedded blank + lines to be processed correctly. +- Blank DSV format table data lines are silently skipped. +- Tightened up on enforcement of configuration file section names to + reduce the possibility of section content being seen as a section + header line. +- Section titles can be optionally suffixed with title arguments + enclosed in double square brackets. +- A replacement has been added to `asciidoc.conf` to replace inline + double dashes with the `—` entity. +- Changed the `.UNDER-CONSTRUCTION.` macro syntax to + `#UNDER-CONSTRUCTION#` so it is not mistaken for a BlockTitle. + Similarly changed the `.NEW.` replacement with + `#NEW#`. +- `#NEW#` and `#UNDER-CONSTRUCTION#` macros are now + included in the DocBook backend. +- Replaced shipped `smallnew.gif` with `smallnew.png`. +- Documentation tidy ups. + + +Version 5.0.5 (2004-02-25) +-------------------------- +- Fixed the disappearing paragraph titles problem that was caused by + Inline macros (incorrectly) processing BlockTitles. +- Tightened AuthorLine validation. Previously invalid email addresses + and embedded special characters in the AuthorLine resulted in + invalid output markup. + + +Version 5.0.4 (2004-02-09) +-------------------------- +- Reinstated missing `infile`, `outfile`, `filetype` and + `filetype-<filetype>` glossary entries. +- As of version 5.0.3 asciidoc(1) now requires Python 2.0 or greater, + this has now been documented. + + +Version 5.0.3 (2004-01-23) +-------------------------- +- Fixed problem that caused any filters directory file containing + `.conf` (not just those with the `.conf` extension) from being + loaded. +- All `[miscellaneous]` configuration file entries can now be + referenced like glossary entries (they are now processed internally + as glossary entries). +- The output file line terminator (previously hardwired to `\r\n` is + now set using the `newline` entry in the configuration file + `[miscellaneous]` section. +- The misspelt `blocktitles` configuration file entry name has been + corrected (to `blocktitle`). +- An `{empty}` glossary entry has been added to the default + configuration which is useful for outputting trailing blank lines + from configuration file substitution sections. + + +Version 5.0.2 (2003-12-18) +-------------------------- +- New (alternative) 'anchor' and 'xref' macro syntax (old syntax still + valid). +- DocBook `mediaobject` and `inlinemediaobject` tags are generated in + place of `graphic` and `inlinegraphic` tags by the AsciiDoc + `graphic` and `icon` macros. If a macro argument is specified it is + the alternative text output if the target document format does not + support the specified graphic file format. +- Dropped the LinuxDoc left and right square bracket special character + substitutions as they interfered with macro substitution. +- Documentation updates and corrections. + + +Version 5.0.1 (2003-12-09) +-------------------------- +- Fixed problem with anchor tag when generating CSS styled HTML. + + +Version 5.0 (2003-12-08) +------------------------ +*************************************************** +This release has had some fairly major code and +documentation changes. Please report any problems +you encounter. + +mailto:srackham@gmail.com['Stuart Rackham'] +*************************************************** + +- AsciiDoc can now produce a full-blown multi-part DocBook book + including dedication, abstract, preface, colophon, glossary, + appendix, bibliography and book part elements using the new + `specialsections` configuration file section. +- All Section element children (Paragraph, DelimitedBlock, List, + Table, BlockMacro) can now be titled using the BlockTitle element. + A BlockTitle element is a single line containing a title and + beginning with a period. +- The `index` and `backmatter` macros have been dropped, superseded by + `specialsections`. +- The AsciiDoc 'Preface' element has been renamed 'Preamble' (to avoid + confusion with the DocBook book preface element). +- Out of sequence titles are now tolerated with a warning. This allows + book document level 0 sections to be processed. +- An 'anchor' inline macro has been added for document link target + creation. +- 'Note', 'Tip', 'Important' and 'Warning' paragraph types have been + added to support the corresponding DocBook elements. +- Title substitution is now performed in SidebarBlock titles. +- DocBook graphics now output as `figure` and `informalfigure` + elements rather than `mediaobjects`. This ensures numbered figures + and a lists of figures are produced by the DocBook toolchain. +- You can now escape block argument lines by appending a backslash. + Alternatively, if you embed arguments in the delimiter line AsciiDoc + does not check for an arguments line. +- The default DocBook backend file extension has been changed from + `.docbook` to `.xml` (`.sgml` for the 'docbook-sgml' backend). +- Warnings are output by default (previously they only printed when + verbose option enabled). +- A Question and Answer variable list definition has been added to the + shipped configuration files, primarily to create DocBook `qanda` + DocBook elements. +- Fixed broken code-filter `-b linuxdoc` option. The asciidoc.asc User + Guide can now be processed by linuxdoc(1) (although tables are + dropped because LinuxDoc does not implement tables). + +.Compatibility issues: +1. Table titles are no longer in the arguments line, use the new + BlockTitles. +2. Graphic titles are no longer in the 'graphic' block macro caption, + use the new BlockTitles. +3. The code-filter title must be placed in a preceding BlockTitle. +4. SidebarBlock titles must be placed in a preceding BlockTitle. +5. The DelimitedBlock option 'sidebar' has been renamed to 'section'. +6. The default DocBook backend file extension has been changed from +`.docbook` to `.xml` (`.sgml` for the 'docbook-sgml' backend). + + +Version 4.2 (2003-11-26) +------------------------ +- The default HTML output is now XHTML 1.0 markup. To output the + former HTML 4 markup specify the `html-4` backend. +- The default DocBook output is now DocBook XML. To output the former + DocBook SGML specify the `docbook-sgml` backend. The associated + `docbook-sgml.conf` file illustrates how to support minor DTD + variations. Examples of using the `xmlto(1)` command for DocBook + conversion have been added to the User Guide. +- Glossary entries set using the command-line -g option can now be + referenced in configuration files. +- Configuration dumps (`-c` command-line option) no longer output + redundant undefined glossary entries. +- DelimitedBlock arguments can now be specified in a separate arguments + line immediately following the leading delimiter line, This is in + preference to the existing delimiter embedded arguments. Reasons: + * The syntax is in keeping with the Tables arguments syntax. + * It's easier to enter and implements line continuation. +- A new QuoteBlock DelimitedBlock definition has been added to the + distribution configuration files. +- The table arguments lines can be continued using the backslash line + continuation character. +- Added new calculated glossary reference type `{<name>%<value>}`. +- Double-quote characters can now appear in unquoted positional + arguments. + + +Version 4.1 (2003-11-13) +------------------------ +- Added DSV (Delimiter Separated Values) tables format. +- `{eval:<expr>}` glossary references drop the containing line if + `<expr>` evaluates to `None`. +- Block, Table and Macro arguments can now be positional (quoted or + unquoted). +- Vocabulary change: DelimitedBlock, Table and Macro 'attributes' are + now referred to as 'arguments'. This makes more sense in light of the + extended syntax and avoids confusion with backend markup tag + attributes. +- 'tablewidth' table ruler parameter can now be expressed in percent + units (0..100). If between 0 and 1 then the original fractional unit + measure is applied. +- The use of quoting for generating footnotes and index entries has + been dropped in favor of 'footnote' and 'indexterm' inline macros. +- 'backmatter' inline macro included in distribution. +- Fixed: CSS styled HTML tables are now fully XHTML 1.0 conformant. +- Fixed: 'tablewidth' was processed incorrectly when passed as table + argument. +- Fixed: Glossary references like `{x=\{y}}` were one character off + if \{x] was defined and `{y}` was not. + + +Version 4.0 (2003-11-08) +------------------------ +*************************************************** +This release has had some fairly major code and +documentation changes. Please report any problems +you encounter. + +'Stuart Rackham' +*************************************************** + +- Added tables to AsciiDoc. +- Added two special 'subs' options: 'default' specifies the default + substitution options and 'none' specifies no substitution. These + options can only appear singly. +- Line continuation using a trailing backslash character is available + in Paragraphs, ListItems, Tables. +- The left and right quotes for quoted text can now be specified + separately. +- Shipped configuration files implement footnotes (only useful for + DocBook output) using \[[]] quoting. +- Shipped configuration files implement index terms (only useful for + DocBook and LinuxDoc output) using \(()) quoting. +- The shipped 'html' backend configuration now emits valid 'HTML 4.01 + Transitional'. +- Added new calculated glossary reference types `{<name>!<value>}` + and `{<name>#<value>}`. +- The DelimitedBlock 'params' option has been dropped in favor of the + new 'block attributes' mechanism. If you have customized block + params options you may need to adjust source files to use the + 'block attributes' syntax. The example code filter has been updated + to reflect these changes. +- The code filter now has a `-t tabsize` option. +- Replaced `-w` option with `-v` (verbose) option. The warnings option + was just to confusing. +- Named attributes can now be specified in macro calls. +- The 'tabsize' attribute is recognized in the built-in `include` + macros. A tabsize of zero suppresses tab expansion. +- The configuration file `[options]` section has been split into + `[miscellaneous]` and `[titles]`. If you have customized any of + these settings you will need to adjust the affected configuration + files. +- Configuration file `[miscellaneous]` entries can now also be set + using the command-line `-g` option. +- Fixed: error that occurred when attempting to use zero length + configuration and source files. +- Fixed: blocking filter halt problem. +- Fixed: inline macro escape prefix problem. +- Fixed: missing macros from configuration dump problem. +- Fixed: named macros were dumped incorrectly. +- Many documentation changes/additions/corrections. + + +Version 3.2.2 (2003-10-26) +-------------------------- +- Added `-n` option (synonym for `-g section-numbers`). +- Dropped the processing commentary (hey, this is Unix). +- Added new calculated glossary reference type `{<name>?<value>}`. + `<name>` is the glossary entry name and `<value>` is the text + substituted if the glossary entry is defined. `<value>` can only + contain literal text (no glossary references allowed). +- Added `asciidoc2text` to distribution `examples/asciidoc2text` + directory (converts AsciiDoc source to text file with section + numbering). +- Fixed incorrect nesting of Simple lists inside Variable lists. +- List definitions have been modified so that list items can be + indented. This allows a more intuitive indentation of nested lists + in AsciiDoc source. +- Lists must be separated from preceding paragraphs by a blank line. + This is to avoid paragraph lines being mistaken for list items. +- Corrected asciidoc man page documentation error: the`-f` option does + *not* search relative to source document directory for the + configuration file. +- Minor updates to various distribution `.conf` files. +- Included `badges.conf` in `examples` directory. +- `css-embedded-stylesheet.conf` now supports footer badges. +- The default in-line element processing order has been changed: + Glossary References are now processed before Inline Macros. This + allows glossary expansions to occur inside macro references. +- Glossary entries are now allowed in Author and Revision lines. +- Default List `subs` options and Paragraph `presubs` options are + assigned the following default value if not specified: + + specialcharacters,quotes,specialwords,replacements,glossary,macros + +- Documentation changes/additions/corrections. + + +Version 3.2 (2003-05-26) +------------------------ +- Added a `-s` command-line option to suppress the output of + `[header]` and `[footer]` sections. +- Article document headers are no longer mandatory: this allows + AsciiDoc to process arbitrary chunks of text. When used in + conjunction with the new `-s` command-line option corresponding + chunks of backend markup can be generated. +- AsciiDoc now emits a warning message and continues when an out of + sequence section title is detected (previously it failed and + halted). This allows document sections to be processed separately. +- Optional 'presubs' and 'postsubs' entries have been added to + 'DelimitedBlock' and 'Paragraph' definitions. As a consequence + substitution options are no longer legal in 'options' entries. +- 'presubs' and 'postsubs' substitutions are processed in the order + the options are specified (rather than the fixed 'options' order of + previous versions). +- ./filters subdirectories are automatically searched for filter + commands. +- A 'title-subs' configuration option specifies the substitutions + performed on document Header and Section titles. +- A 'subs' entry in now included in List configuration file + definitions that specified substitutions performed on list entry + text. +- Configuration files are auto-loaded from ./filters subdirectories. +- Added example code filter (see ./examples/filters). +- Bug fix: if section was empty you may have got erroneous 'missing + tag "paragraph"' error. +- Internal code tidy up. + + +Version 3.1 (2003-05-18) +------------------------ +- In version 3.0 a `[macros]` section entry of the form 'name' was + equivalent to 'name='. An entry of the form 'name' now undefines the + entry (to bring it in line with the behavior of other special + sections). +- Paragraphs have now been generalized (in the same way as Lists and + DelimitedBlocks). +- The 'indentsize' option has been dropped as as consequence of + paragraph generalization. +- Pipe | characters can be included in substituted tag and + substitution section text using the \{brvbar} (broken vertical bar) + glossary reference. +- Removed the restriction requiring substitution section text + placeholders | to be on a separate line. +- Added an `-e` asciidoc(1) command option that excludes implicit + configuration files (used in conjunction with `-c` generated + configuration files). +- Version 3.0 documentation has undergone a considerable cleanup. +- The dumping of quoted section entries (see `-c` option) now works + correctly. +- The format of special section entries has been made consistent: + `name` undefines the entry; `name=` sets the entry value to a blank + string; `name=value` sets the entry value to `value`. +- As a consequence of the previous change the caret prefix is no + longer used in glossary configuration file entries (although it is + still used when undefining an entry using the `-g` command-line + option). + + +Version 3.0 (2003-05-13) +------------------------ +This version is the culmination of work begun in the 2.x releases +whereby fixed policy has been replaced by extensible mechanisms. + +- Added `-c` command-line option to dump a composite asciidoc(1) + configuration file to stdout. +- Lists and Delimited Blocks are now defined by a set of configuration + file parameter sections. The user can modify the default + definitions or add new ones. +- Block content can now be processed through external filters. +- The default behavior for Custom Blocks is to perform glossary + substitution (previously there was no substitution inside Custom + Blocks). +- The old 2.x style macros have been reimplemented; as with Lists and + Delimited Blocks there syntax and behavior can be configured by the + user. The default macro syntax remains the same but the semantics + are now (hopefully) a bit more intelligible. +- Block and Builtin macros use :: delimiter instead of the 2.x single + colon delimit (to distinguish them from inline macros). The 2.x + syntax is still supported for backward compatibility. +- Nested lists are now supported and IndentedParagraphs can be + included in list items. +- Conditional source inclusion can be specified using built in `ifdef`, + `ifndef` and `endif` macros. +- The new conditional source inclusion feature has been used to reduce + the number of default configuration files down to one per backend. +- A change of name: 2.x 'Substitutions' are now called 'Replacements' + and the 2.x `[substitutions]` configuration file section is now + called `[replacements]` (the old name is still recognized for + backward compatibility). +- The line break is now implemented as a 'Replacements' substitution. +- Inline 'icon' macro for inline images has been added to default + configuration files. + +Version 2.2 (2003-04-07) +------------------------ +- The `master.conf` configuration file name has been deprecated in + favor of `asciidoc.conf`. +- The standard configuration files set is now loaded from the + `.asciidoc` folder in the users home directory (if it exists) and + then from the source document directory. Configuration files that + don't exist are silently skipped. +- Configuration files named like the source file will be automatically + loaded if they are found in the source file directory. For example + if the source file is `mydoc.asc` and the `-b html` option is used + then asciidoc(1) will look for `mydoc.conf` and `mydoc-html.conf` in + that order. +- The characters used to quote formatted text can be configured and + extended by the user (see the master.conf [quotes] section). +- Quoted text can now be escaped by prefixing a backslash character to + the leading quote. +- The double single-quote '' strong text quote has been deprecated in + favor of an asterisk * character. +- Added \{eval:expression}, \{sys:command} and \{sys2:command} + glossary reference actions. +- Trailing brace characters `}` are now allowed inside glossary + references provided they are escaped with a backslash character. +- Glossary entries can now be escaped by prefixing a backslash + character to the leading brace character (use this in preference to + placing the backslash inside the brace). +- The output macro has been deprecated (use the new include1 macro + inside a CustomBlock). +- The default document type is `article` (asciidoc no longer attempts + to guess). +- Files included within DelimitedBlocks are not searched for block + termination underlines. This ensures the entire file is part of the + DelimitedBlock. +- `include` macros can now be used in configuration files. +- Corrected \{infile} and \{outfile} glossary entry documentation. +- File inclusion is now limited to a depth of 5 to catch recursion + loops. +- Inline tags have been deprecated, they're not necessary and they + immediately make the source document backend specific. Use + CustomBlocks or Substitutions instead. + +Version 2.1 (2003-03-17) +------------------------ +- Added section auto numbering `{sectnum}` glossary entry + (auto-numbering function contributed by Ludovico Magnocavallo). +- asciidoc(1) now correctly returns non-zero exit status if an error + occurs. +- An AsciiDoc example website has been included in the AsciiDoc + distribution `examples/website` directory. +- NOTE: The `asciidoc` wrapper script included in the 2.0 distribution + has been dropped, if you've symlinked or aliased to `asciidoc` you'll + need to change them to point directly to `asciidoc.py` instead. +- An RCS $Id$ marker can be used as the document header revision line + (based on a patch submitted by Ludovico Magnocavallo). +- In addition to the `name=value` glossary entry format two new ones + have been introduced: `name` (the default value is set to an empty + string) and `^name` (the glossary entry is undefined). +- The `-q` command-line option has been deprecated and the `-w level` + command-line option added. + + NOTE: By default skipped substitution warnings are now suppressed. +- If a configuration file specified with the `-f` command-line option + is not found relative to the current working directory then the + search is repeated relative to the asciidoc(1) directory. This + allows global configuration files to be used. +- Added `{infile}`, `{outfile}` predefined glossary entries. +- Added `under-construction` macro to HTML article configuration + files. +- Deprecated `{asciidoc_version}` glossary entry in favor of + `{asciidoc-version}` (to it consistent with other entries). + +Version 2.0 (2003-02-24) +------------------------ +- The emphasized, strong and monospaced words options have been + generalized with the introduction of macro based 'special words' + lists. +- Glossary references can now appear in both the document and macro + bodies. +- All output files use `crlf` line termination (previously used UNIX + `lf` (newline) termination). +- Added [substitutions] section which implements arbitrary regular + expression based substitutions. +- An optional `master.conf` configuration file can be used for entries + that are not backend or document type specific. +- Special character definitions moved from the code to the new + [special_characters] configuration file section. +- Configuration file glossary added. +- Command-line -g glossary entry added. +- A new 'book' document type has been implemented for the 'docbook' + backend. It outputs DocBook 'book' documents. +- A major internal change has been the implementation of parametrized + user definable 'macros'. Internally most document elements are now + processed as macros. +- Configuration file macro variables can be specified with default + values (literals or other macro variables). +- An attempt has been made to tighten up the vocabulary used to + describe the AsciiDoc document syntax. +- The term abstract has been replaced by the more general term + 'preface' and a new preface section introduced into article + configuration files (replacing the synopsis sections). +- Any section elements can now be put in the document preface + (previous versions only allowed paragraphs). +- AsciiDoc Blocks have been unified and their behavior can be user + defined and parametrized. +- An 'output' inclusion allows an external file to be written directly + to the backend output file. +- A new CustomBlock has been added. Default behavior is to insert the + enveloped AsciiDoc source lines directly into the output file. +- A 'line break' tag can be inserted by terminating a line with a '+' + character (only really useful for HTML backends). +- An fourth section level has been introduced. +- The SidebarBlock delimiter line characters have been changed. The + deprecated underline is still accepted. +- Levels 2 and 3 title underline characters have been changed. The + deprecated underlines are still accepted. +- Lines with backend specific inline tags can be inserted into + AsciiDoc source files. +- Single words enveloped by underscores are no longer emphasized. This + feature was deprecated as it is redundant (use single quotes + instead) and was being applied to file names with underscores. +- A `-q` quiet option has been added to suppress warning messages. +- Badge images sourced locally. +- Added 'author' and 'author-mail' meta tags to HTML configuration + files. + +Version 1.5 (2003-01-08) +------------------------ +- Implemented sidebar document elements. +- Explicit checks for user specified configuration files and input + file (rather than throwing exception). + +Version 1.4 (2003-01-04) +------------------------ +- New configuration file options 'emphasizedwords' and 'strongwords'. + These allow the definition of words that will always be emphasized + or rendered in a strong font without inline formatting. +- Document and section titles are no long subject to inline + formatting. +- Multiple configuration files can be overlaid in a single command. +- Configuration file tags and options entries can now be overridden on + an entry by entry basis (previously the entire section was + overloaded). +- Configuration file tags and options entries are now cached this has + resulted in around 37% performance improvement over version 1.3. +- Variable lists can now contain multiple terms per list item. +- Placeholder paragraph eliminated from empty sections that contain + subsections. +- Added \{asciidoc_version} substitution variable. +- More documentation additions and tidy ups. + +Version 1.3 (2003-01-01) +------------------------ +- A new 'strong' text formatting convention has been implemented: + Word phrases enclosed in pairs of single quote characters (acute + accents) are rendered in a strong font (usually bold). +- Paragraphs can now be followed immediately by Simple lists and + Ordered lists without an intervening blank line. +- A user specified configuration file (`asciidoc(1)` -f option) + overlays the default configuration file rather than replacing it. + Custom configuration files need only contain those sections + that have been customized. +- Comment Block delimiters have been relaxed slightly. They must start + with three forward slashes /// but the remainder can contain any + characters, this allows comments to be embedded in the delimiter line. +- Leading non-digit characters preceding revision number are now + ignored. +- Set default indentsize [option] from 2 to documented default value + of zero in HTML backend html-article.conf and html-manpage.conf + files. +- Fixed error that occurred when taking input from stdin without + explicitly specifying a document type. +- Restored file name and line number error message information. +- Changed deprecated -t option to -d in asciidoc --help and usage + command output. +- CSS styles tweaking. +- Code, configuration file and documentation tidy ups. + +Version 1.2 (2002-12-28) +------------------------ +- Implemented 'include' URL to allow file inclusion. +- `fileextension` configuration file [option] renamed to more sensible + `outfilesuffix` (`fileextension` still accepted by this version but + will be dropped in future). +- Improved error reporting. +- CSS backends generate valid XHTML. +- New `css-embedded` backend generates HTML with embedded stylesheets + (use the `css` backend for linked stylesheets). The css-embedded + backend output contains no linked images so the generated html files + are completely self contained. +- Bug fixes. + +Version 1.1 (2002-12-03) +------------------------ +- Added css (cascading style sheets) backend +- Implemented IndentedBlock document element. +- Tabsize command-line option has been deprecated in + favor of configuration file. +- Default indent width changed to zero. +- Added \{localdate} and \{localtime} substitution variables. +- Added optional [options] configuration file section with + fileextension, tabsize and indentsize options. +- Implemented \{authorinitials} substitution variable. +- Added https link type. +- Corrected [graphic] substitution from \{title} to \{caption} + in linuxdoc-article.conf configuration file. +- Fixed error that occurred when '==' title underline was + used. + +Version 1.0 (2002-11-25) +------------------------ +First AsciiDoc public release along with AsciiDoc web site +(http://www.methods.co.nz/asciidoc/) and SourceForge.net project registration +(https://sourceforge.net/projects/asciidoc/[]). + +// vim: set syntax=asciidoc: diff --git a/examples/website/README.txt b/examples/website/README.txt index 9f5b20d..06c888c 120000..100644 --- a/examples/website/README.txt +++ b/examples/website/README.txt @@ -1 +1,35 @@ -../../README.txt
\ No newline at end of file +AsciiDoc README File +==================== + +Prerequisites +------------- +AsciiDoc is written in Python so you need a Python interpreter +(version 2.4 or later) to execute asciidoc(1). Python is installed by +default in most Linux distributions. You can download Python from the +official Python website http://www.python.org. + + +Obtaining AsciiDoc +------------------ +Documentation and installation instructions are on the AsciiDoc +website http://www.methods.co.nz/asciidoc/ + + +Tools +----- +Current AsciiDoc version tested on Xubuntu Linux 10.04 with: + +- Python 2.6.5 +- DocBook XSL Stylesheets 1.75.2 +- xsltproc (libxml 20706, libxslt 10126 and libexslt 815). +- w3m 0.5.2 +- dblatex 0.3 +- FOP 0.95 +- A-A-P 1.091 + + +COPYING +------- +Copyright (C) 2002-2010 Stuart Rackham. Free use of this software +is granted under the terms of the GNU General Public License (GPL). + diff --git a/examples/website/customers.csv b/examples/website/customers.csv index 5e8a33c..01f862a 120000..100644 --- a/examples/website/customers.csv +++ b/examples/website/customers.csv @@ -1 +1,18 @@ -../../doc/customers.csv
\ No newline at end of file +"AROUT","Around the Horn","Thomas Hardy","120 Hanover Sq. +London","(171) 555-7788" +"BERGS","Berglunds snabbkop","Christina Berglund","Berguvsvagen 8 +Lulea","0921-12 34 65" +"BLAUS","Blauer See Delikatessen","Hanna Moos","Forsterstr. 57 +Mannheim","0621-08460" +"BLONP","Blondel pere et fils","Frederique Citeaux","24, place Kleber +Strasbourg","88.60.15.31" +"BOLID","Bolido Comidas preparadas","Martin Sommer","C/ Araquil, 67 +Madrid","(91) 555 22 82" +"BONAP","Bon app'","Laurence Lebihan","12, rue des Bouchers +Marseille","91.24.45.40" +"BOTTM","Bottom-Dollar Markets","Elizabeth Lincoln","23 Tsawassen Blvd. +Tsawassen","(604) 555-4729" +"BSBEV","B's Beverages","Victoria Ashworth","Fauntleroy Circus +London","(171) 555-1212" +"CACTU","Cactus Comidas para llevar","Patricio Simpson","Cerrito 333 +Buenos Aires","(1) 135-5555" diff --git a/examples/website/faq.txt b/examples/website/faq.txt index 257ca12..4f7595b 120000..100644 --- a/examples/website/faq.txt +++ b/examples/website/faq.txt @@ -1 +1,1133 @@ -../../doc/faq.txt
\ No newline at end of file +AsciiDoc Frequently Asked Questions +=================================== + + +[NOTE] +====== +- New FAQs are normally added at the top of this document. +- The FAQ may be updated between AsciiDoc releases so some of the + newer FAQs may apply to the trunk and not the current release. +====== + +[[X5]] +== How can I include embedded fonts in an EPUB document +This is a two step process: + +1. Declare the font files and their use in your document's CSS + stylesheet. For example: ++ +[listing] +......................................... +@font-face { + font-family : LiberationSerif-Regular; + font-weight : normal; + font-style: normal; + src : url(LiberationSerif-Regular.ttf); +} + +body { + font-family: LiberationSerif-Regular, serif; +} +......................................... + +2. Declare the the font file as resource when you use `a2x(1)` to + compile the EPUB. For example: + + a2x -f epub -d book --epubcheck --stylesheet epubtest.css --resource .ttf=application/x-font-ttf --resource LiberationSerif-Regular.ttf epubtest.txt + +[NOTE] +====== +- Requires AsciiDoc 8.6.5 or better. +- The True Type Font mimetype had to be declared explicitly with the + `--resource .ttf=application/x-font-ttf` option because it wasn't + registered on my Linux system. +- In the above example the font file is in the same directory as the + AsciiDoc source file and is installed to the same relative location + in the EPUB archive OEBPS directory -- if your font file resides in + a different location you'll need to adjust the `--resource` option + accordingly (see the 'RESOURCES' section in the `a2x(1)` man page + for details). +- The URL value of the CSS 'src' property is set to the destination + font file relative the the CSS file. +- The `--resource` option allows you to inject any file (not just font + files) into the EPUB output document. +- Using the CSS '@font-face' rule is a complex subject and is outside + the scope of the FAQ. +- Many EPUB readers do not process embedded fonts. +====== + + +== What's the difference between + quoted text and ` quoted monospaced text? +`+` (plus) quoted text is implemented as an AsciiDoc 'quotes' whereas ++`+ (grave accent or backtick) quoted text is implemented as an +AsciiDoc 'inline literal' passthrough macro. The semantics are +different: + +1. Inline passthrough macros are processed before any other inline + substitutions e.g. all of the following line will be processed as a + single inline passthrough and rendered as monospaced text (which is + not the intended result): ++ +-- + `single quoted text' and `monospaced quoted text` + +This line works as expected: + + `single quoted text' and +monospaced quoted text+ +-- + +2. Backtick quoted text is rendered literally i.e. no substitutions + are performed on the enclosed text. Here are some examples that + would have to be escaped if plus quoting were used (<<X4,see + also>>): + + The `++i` and `++j` auto-increments. + Paths `~/.vim` and `~/docs`. + The `__init__` method. + The `{id}` attribute. + + +== Why is the generated HTML title element text invalid? +Probably because your document title contains formatting that has +generated HTML title markup. You can resolve this by explicitly +defining the 'title' attribute in your document's header. + + +== AsciiDoc sometimes generates invalid output markup, why? +AsciiDoc is backend agnostic, the 'asciidoc' command has no knowledge +of the syntax or structure of the backend format that it generates. +Output document validation (syntactic and structural) should be +performed separately by external validation tools. For example, +AsciiDoc's 'a2x' toolchain command automatically performs validation +checks using 'xmllint'. + + +== The AsciiDoc toclevels attribute does not work with DocBook outputs, why? +DocBook has no provision for specifying table of contents levels but +you can set the TOC level further down the toolchain by passing the +DocBook XSL Stylesheets +http://docbook.sourceforge.net/release/xsl/current/doc/html/toc.section.depth.html[toc.section.depth] +parameter to 'dblatex' (using the `--param` option) or 'xsltproc' +(using the `--stringparam` option). For example to show only chapter +titles in the TOC of a 'book' document set 'toc.section.depth' to '0'. +Increment the 'toc.section.depth' value to show more sub-section +titles. If you are using 'a2x' you can set the options in the source +file, for example: + + // a2x: --xsltproc-opts "--stringparam toc.section.depth 0" + // a2x: --dblatex-opts "--param toc.section.depth=0" + +If the document is of type 'article' use the value '1' to show only +top level section titles in the TOC, use the value '2' for two levels +etc. + + +== How can I include chapter and section tables of contents? +DocBook outputs processed by DocBook XSL Stylesheets (either manually +or via 'a2x') can generate additional separate section and chapter +tables of contents using combinations of the +http://www.sagehill.net/docbookxsl/TOCcontrol.html[TOC parameters]. +Here are some examples using combinations of the +`generate.section.toc.level` and `toc.section.depth` DocBook XSL +Stylesheets parameters: + +[cols="2*l,4",width="90%",frame="topbot",options="header"] +|====================================================== +|generate.section.toc.level |toc.section.depth | +|1 | +|Single level book chapter TOCs or article section TOCs + +|1 | 3 +|Article section TOCs with two levels + +|1 | 2 +|Book chapter TOCs with two levels +|====================================================== + + +== How can I customize the appearance of XHTML and EPUB documents generated by a2x? +You can customize the appearance of an EPUB document with CSS. See +the link:publishing-ebooks-with-asciidoc.html[Sherlock Holmes eBook +example] on the AsciiDoc website. + + +== DocBook has many elements for document meta-data -- how can I use them from AsciiDoc? +The 'docinfo', 'docinfo1' and 'docinfo2' attributes allow you include +link:userguide.html#X97[document information files] containing DocBook +XML into the header of the output file. + + +== Do element titles automatically generate link captions? +If you go the DocBook route then yes -- just omit the caption from the +AsciiDoc 'xref' (`<<...>>`) macro. Both dblatex and DocBook XSL will +use the target element's title text. Examples: + +[listing] +.................................................................. +[[X1]] +Section One +----------- +Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas +ultrices justo porttitor augue. Vestibulum pretium. Donec porta + +See also <<X3>> (this link displays the text 'A titled paragraph'). + +[id="X2",reftext="2nd section"] +Section Two +----------- +See also <<X1>> (this link displays the text 'Section One'). + +[[X3]] +.A titled paragraph +Lorem ipsum dolor sit amet, consectetuer adipiscing elit. + +See also <<X2>> (this link displays the text '2nd section'). +.................................................................. + +The AsciiDoc 'reftext' attribute has been used to explicitly set the +link text to '2nd section' for 'Section Two'. + + +== Can I define my own table styles? +In addition to the built-in styles you can define your own. This +example (for the 'xhtml11' backend) defines a table style called 'red' +which sets the background cell color to red. First put the definition +in a configuration file: + +[listing] +......................................... +[tabledef-default] +red-style=tags="red" + +[tabletags-red] +bodydata=<td style="background-color:red;">|</td> +......................................... + +Now you can use the style name to style cells or columns (in this +example we use an unambiguous shortened abbreviation 'r'): + +[listing] +......................................... +|================================== +|Normal cell r|Red cell +|================================== +......................................... + + +== How can I add highlighted editorial comments to an AsciiDoc document? +Both block and inline link:userguide.html#X25[comment lines] are +displayed on the output if the 'showcomments' attribute is defined. +Example: + +[listing] +......................................... +:showcomments: +// A block comment line. + +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +// An inline comment line. +adolescens. +......................................... + +Is rendered as: + +:showcomments: +// A block comment line. + +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +// An inline comment line. +adolescens. + +NOTE: link:userguide.html#X26[Comment blocks] are never displayed. + + +== What is the preferred file name extension for AsciiDoc files? +The `.txt` http://en.wikipedia.org/wiki/Text_file[text file] extension +is preferred, but it's just a convention and it's not enforced by the +software. + +AsciiDoc source files are human readable +http://en.wikipedia.org/wiki/Plain_text[plain text] files which is +what the `.txt` extension is for. All text editors recognize and open +files with a `.txt` extension. The `.txt` extension is universally +recognized and unambiguous -- you are not left asking questions like +``What on earth is this file with the funny extension?'', ``How do I +open it?'' and ``Is it safe to open?''. + + +== How can I generate numbered bibliographic entries? +If your outputs are DocBook generated then adding the following inline +macro to a custom configuration file will result in auto-incrementing +bibliography entry numbers (instead of displaying the bibliographic +identifiers): + + [anchor3-inlinemacro] + <anchor id="{1}" xreflabel="[{counter:bibliography1}]"/>[{counter:bibliography2}] + +This FAQ submitted by Bela Hausmann. + + +== How can I include lines of dashes inside a listing block? +A line of four or more dashes will be mistaken for the ListingBlock +terminator, one way round this problem is to use a LiteralBlock styled +as a listing block. For example: + + [listing] + ........................... + Lorum ipsum + ----------- + ........................... + + +== How can I customize PDF files generated by dblatex? + +There are a number of dblatex XSL parameters that can be used to +customize PDF output. You can set them globally in the AsciiDoc +`./dblatex/asciidoc-dblatex.xsl` configuration file or you can also +pass them on the a2x(1) command-line. Here are some examples: + +The +http://dblatex.sourceforge.net/doc/manual/latex.output.revhistory.html[latex.output.revhistory] +parameter is used to suppress the revision history: + + a2x -f pdf --dblatex-opts "-P latex.output.revhistory=0" doc/article.txt + +The +http://dblatex.sourceforge.net/doc/manual/doc.layout.html[doc.layout] +parameter is used to include the cover page and document body (i.e. excludes +table of contents and index), the +http://dblatex.sourceforge.net/doc/manual/doc.publisher.show.html[doc.publisher.show] +parameter is used to exclude the cover page logo: + + a2x -f pdf --dblatex-opts " -P doc.layout=\"coverpage mainmatter\" -P doc.publisher.show=0" doc/article.txt + +See also the +http://dblatex.sourceforge.net/doc/manual/sec-params.html[dblatex XSL +parameter reference]. + + +== How can I add lists of figures and tables to PDFs created by dblatex? +Set the +http://dblatex.sourceforge.net/doc/sec-custom.html[doc.lot.show XSL +parameter] -- you can set it using the dblatex `--param` command-line +option, for example: + + $ a2x --dblatex-opts="--param=doc.lot.show=figure,table" doc/article.txt + + +== How can I stop the document title being displayed? +You could simply omit the document title, but this will result in a +blank 'title' element in HTML outputs. If you want the HTML 'title' +element to contain the document title then define the 'notitle' +attribute (this will just suppress displaying the title), for example: + + My document title + ================= + :no title: + + +== Why am I having trouble getting nested macros to work? +The following example expands the 'image' inline macro, but the +expansion contains double-quote characters which confuses the ensuing +'footnoteref' macro expansion: + + footnoteref:["F1","A footnote, with an image image:smallnew.png[]"] + +The solution is to use unquoted attribute values, replacing embedded +commas with the comma character entity (`,`): + + footnoteref:[F1,A footnote, with an image image:smallnew.png[]] + +Similarly, you can embed double-quote characters in unquoted attribute +values using the `"` character entity. + + +== Why am I getting DocBook validation errors? +Not all valid AsciiDoc source generates valid DocBook, for example +'special sections' (abstract, preface, colophon, dedication, +bibliography, glossary, appendix, index, synopsis) have different +DocBook schema's to normal document sections. For example, a paragraph +is illegal in a bibliography. + +Don't forget if your document is a book you need to specify the +asciidoc `-d book` command option, if you don't an article DocBook +document will be generated, possibly containing book specific +sections, resulting in validation errors. + + +== How can I disable special section titles? +For example, you want to use 'References' as a normal section name but +AsciiDoc is auto-magically generating a DocBook 'bibliography' +section. All you need to do is explicitly specify the section template +name, for example: + + [sect1] + References + ---------- + + +== How can I insert XML processing instructions into output documents? +Use an inline or block passthrough macros. This example inserts +`<?dblatex bgcolor="#cceeff"?>` into the DocBook output generated by +AsciiDoc: + + pass::[<?dblatex bgcolor="#cceeff"?>] + +NOTE: XML processing instructions are specific to the application that +processes the XML (the previous `dblatex` processing instruction is +recognized by `dblatex(1)` when it processes the DocBook XML generated +by Asciidoc). + + +[[X4]] +== How do I prevent double-quoted text being mistaken for an inline literal? +Mixing doubled-quoted text with inline literal passthroughs can +produce undesired results, for example, all of the following line is +interpreted as an inline literal passthrough: + + ``XXX'' `YYY` + +In this case the solution is to use monospace quoting instead of the +inline literal: + + ``XXX'' +YYY+ + +Use the +\pass:[]+ macro if it's necessary to suppress +substitutions in the monospaced text, for example: + + ``XXX'' +pass:[don't `quote` me]+ + + +== How can I generate a single HTML document file containing images and CSS styles? +With the advent of Internet Explorer 8 all major web browsers now +support the +http://en.wikipedia.org/wiki/Data:_URI_scheme[data URI scheme] for +embedded images. The AsciiDoc 'xhtml11' backend supports the data URI +scheme for embedded images and by default it embeds the CSS +stylesheet. For example the following command will generate a single +`article.html` file containing embedded images, admonition icons and the CSS +stylesheet: + + $ asciidoc -a data-uri -a icons article.txt + + +== Are there any tools to help me understand what's going on inside AsciiDoc? + +AsciiDoc has a built-in trace mechanism which is controlled by the +'trace' attribute; there is also the `--verbose` command-line option. +These features are detailed in +http://www.methods.co.nz/asciidoc/userguide.html#X82[Appendix G of the +User Guide]. + + +== One-liner ifdef::[]'s are disproportionately verbose can they shortened? + +This is the response to a question posted on the AsciiDoc discussion +list, it illustrates a number of useful techniques. The question arose +because the source highlight filter language identifier for the C++ +language is `c++` when generating PDFs via dblatex (LaTeX listings +package) or `cpp` when generating HTML (GNU source-highlight). + +Using straight `ifdef::[]` block macros we have: + +[listing] +......................................... +\ifdef::basebackend-docbook[] +[source,c++] +\endif::basebackend-docbook[] +\ifdef::basebackend-html[] +[source,cpp] +\endif::basebackend-html[] +----------------------------------------- +class FooParser { +public: + virtual void startDocument() = 0; + virtual void endDocument() = 0; +}; +----------------------------------------- +......................................... + + +This can be shortened using the short form of the `ifdef::[]` macro: + +[listing] +......................................... +\ifdef::basebackend-docbook[[source,c++]] +\ifdef::basebackend-html[[source,cpp]] +----------------------------------------- +class FooParser { +public: + virtual void startDocument() = 0; + virtual void endDocument() = 0; +}; +----------------------------------------- +......................................... + + +Using a conditional attribute instead of the `ifdef::[]` macro is even +shorter: + +[listing] +......................................... +[source,{basebackend@docbook:c++:cpp}] +----------------------------------------- +class FooParser { +public: + virtual void startDocument() = 0; + virtual void endDocument() = 0; +}; +----------------------------------------- +......................................... + + +If you have a number of listings it makes sense to factor the +conditional attribute to a normal attribute: + +[listing] +......................................... +:cpp: {basebackend@docbook:c++:cpp} + +[source,{cpp}] +----------------------------------------- +class FooParser { +public: + virtual void startDocument() = 0; + virtual void endDocument() = 0; +}; +----------------------------------------- +......................................... + + +Even shorter, set the default source highlight filter `language` +attribute so you don't have to specify it every time: + +[listing] +......................................... +:language: {basebackend@docbook:c++:cpp} + +[source] +----------------------------------------- +class FooParser { +public: + virtual void startDocument() = 0; + virtual void endDocument() = 0; +}; +----------------------------------------- +......................................... + + +== Some of my inline passthroughs are not passed through, why? + +Most likely the passthrough encloses another passthrough with a higher +precedence. For example trying to render this +\pass:[]+ with this ++\`\pass:[]`+ results in a blank string because the +\pass:[]+ +passthrough evaluates first, instead use monospaced quoting and escape +the passthrough i.e. ++ \+\\pass:[]+ ++ + + +== How can I place an anchor (link target) on a list item? + +You can't use a 'BlockId' block element inside a list but you can use +the syntactically identical 'anchor' inline macro. For example: + +--------------------- +one:: Item one. +[[X2]]two:: Item two. +three:: Item three. +--------------------- + +This *will not* work: + +--------------------- +one:: Item one. +[[X2]] +two:: Item two. +three:: Item three. +--------------------- + + +== How can I stop lists from nesting? + +If you place two lists with different syntax hard up against each +other then the second list will be nested in the first. If you don't +want the second list to be nested separate them with a comment line +block macro. For example: + +------------------- +1. List 1. +2. List 1. + +// +a. List 2. +b. List 2. +------------------- + + +== Is it possible to include charts in AsciiDoc documents? + +There are a number of programs available that generate presentation +charts from textual specification, for example +http://home.gna.org/pychart/[Pychart] is a library for writing chart +scripts in Python. Here's an example from the 'Pychart' documentation: + +.barchart.py +--------------------------------------------------------------------- +# +# Example bar chart (from Pychart documentation http://home.gna.org/pychart/). +# +from pychart import * +theme.get_options() + +data = [(10, 20, 30, 5), (20, 65, 33, 5), (30, 55, 30, 5), (40, 45, 51, 7), + (50, 25, 27, 3), (60, 75, 30, 5), (70, 80, 42, 5), (80, 62, 32, 5), + (90, 42, 39, 5), (100, 32, 39, 4)] + +# The attribute y_coord=... tells that the Y axis values +# should be taken from samples. +# In this example, Y values will be [40,50,60,70,80]. +ar = area.T(y_coord = category_coord.T(data[3:8], 0), + x_grid_style=line_style.gray50_dash1, + x_grid_interval=20, x_range = (0,100), + x_axis=axis.X(label="X label"), + y_axis=axis.Y(label="Y label"), + bg_style = fill_style.gray90, + border_line_style = line_style.default, + legend = legend.T(loc=(80,10))) + +# Below call sets the default attributes for all bar plots. +chart_object.set_defaults(bar_plot.T, direction="horizontal", data=data) + +# Attribute cluster=(0,3) tells that you are going to draw three bar +# plots side by side. The plot labeled "foo" will the leftmost (i.e., +# 0th out of 3). Attribute hcol tells the column from which to +# retrive sample values from. It defaults to one. +ar.add_plot(bar_plot.T(label="foo", cluster=(0,3))) +ar.add_plot(bar_plot.T(label="bar", hcol=2, cluster=(1,3))) +ar.add_plot(bar_plot.T(label="baz", hcol=3, cluster=(2,3))) +ar.draw() +--------------------------------------------------------------------- + +To execute the script and include the generated chart image in your +document add the following lines to the AsciiDoc source: + +--------------------------------------------------------------------- +// Generate chart image file. +\sys2::[python "{indir}/barchart.py" --format=png --output="{outdir}/barchart.png" --scale=2] + +// Display chart image file. +image::barchart.png[] +--------------------------------------------------------------------- + +[NOTE] +===================================================================== +- The `barchart.py` script is located in the same directory as the + AsciiDoc source file (`{indir}`). +- The generated chart image file (`barchart.png`) is written to the + same directory as the output file (`{outdir}`). +===================================================================== + +== How can I render indented paragraphs? + +To unconditionally indent all paragraphs add the following line to the +`xhtml11.css` stylesheet (or a custom stylesheet). + +--------------------------------------------------------------------- +div.paragraph p {text-indent: 3em;} +--------------------------------------------------------------------- + +This will restyle the entire document by indenting all paragraphs +which is normally what you want to do (mixed paragraph styles produce +ugly documents). + +To selectively indent paragraphs you could either create an 'indented' +paragraph style from scratch or use the 'role' attribute. + +[float] +==== Create an indented paragraph style +Define an 'indented' paragraph style, for example, by putting this in +a configuration file: + +--------------------------------------------------------------------- +[paradef-default] +indented-style=template="indentedparagraph" + +[indentedparagraph] +<div class="paragraph"{id? id="{id}"} style="text-indent:3em;">{title?<div class="title">{title}</div>}<p> +| +</p></div> +--------------------------------------------------------------------- + +Now apply the 'indented' style to normal paragraphs, for example: + +--------------------------------------------------------------------- +[indented] +Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas +ultrices justo porttitor augue. Vestibulum pretium. Donec porta +vestibulum mi. Aliquam pede. Aenean lobortis lorem et lacus. Sed +lacinia. Vivamus at lectus. +--------------------------------------------------------------------- + +[float] +==== Use the role attribute +Add the following line to the `xhtml11.css` stylesheet (or a custom +stylesheet). + +--------------------------------------------------------------------- +div.paragraph.indented p {text-indent: 3em;} +--------------------------------------------------------------------- + +Apply the 'role' attribute to indented paragraphs, for example: + +--------------------------------------------------------------------- +[role="indented"] +Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas +ultrices justo porttitor augue. Vestibulum pretium. Donec porta +vestibulum mi. Aliquam pede. Aenean lobortis lorem et lacus. Sed +lacinia. Vivamus at lectus. +--------------------------------------------------------------------- + +NOTE: This FAQ applies to XHTML output not DocBook. To achieve the +same results with DocBook use the 'role' attribute and customize the +DocBook XSL stylesheets to indent paragraphs with the `simpara` +element `role="indented"` attribute. + + +== Is there a way to set default image height and width attributes? + +You can set the 'height' and 'width' attributes globally in your +document with Attribute Entries or from the command-line using the +`--attribute` option. In the following example images that don't +explicitly set the 'height' and 'width' values will be 350 by 250 +pixels. + +--------------------------------------------------------------------- +:height: 250 +:width: 350 + +image:images/tiger.png[] +--------------------------------------------------------------------- + +NOTE: Setting the global 'width' attribute will also set the default +table width and you will need to explicitly set table widths. + +== How can I place a backslash character in front of an attribute reference without escaping the reference? + +Use the predefined `{backslash}` attribute reference instead of an +actual backslash, for example if the `{projectname}` attribute has +the value `foobar` then: + + d:\data{backslash}{projectname} + +would be rendered as: + + d:\data\foobar + +== How can I escape AsciiDoc markup? + +Most AsciiDoc inline elements can be suppressed by preceding them with +a backslash character. These elements include: + +- Attribute references. +- Text formatting. +- Quoting, +- Macros. +- Replacements. +- Special words. +- Table cell separators. + +But there are exceptions -- see the next question. + + +== Some elements can't be escaped with a single backslash + +There are a number of exceptions to the usual single backslash rule +-- mostly relating to URL macros that have two syntaxes or quoting +ambiguity. Here are some non-standard escape examples: + +[cols="l,v",width="40%",frame="topbot",options="header"] +|======================================== +|AsciiDoc | Renders + +2*| +\srackham@methods.co.nz +<\srackham@methods.co.nz> +\mailto:[\srackham@methods.co.nz] + +2*| +\http://www.foo1.co.nz +\\http://www.foobar.com[] +\\http://www.foobar.com[Foobar Limited] + +2*| +A C\++ Library for C++ +\\``double-quotes'' +\*\*F**ile Open\... +|======================================== + +The source of this problem is ambiguity across substitution types -- +the first match unescapes allowing the second to substitute. A +work-around for difficult cases is to side-step the problem using the ++\pass:[]+ passthrough inline macro. + +NOTE: Escaping is unnecessary inside 'inline literal passthroughs' +(backtick quoted text). + + +== How can I escape a list? +Here's how to handle situations where the first line of a paragraph is +mistaken for a list item. + +[float] +==== Numbered and bulleted lists +Precede the bullet or index of the first list item with an `{empty}` +attribute, for example: + + {empty}- Qui in magna commodo est labitur dolorum an. Est ne magna + primis adolescens. + +The predefined `{empty}` attribute is replaced by an empty string and +ensures the first line is not mistaken for a bulleted list item. + +[float] +==== Labeled lists +Two colons or semicolons in a paragraph may be confused with a labeled +list entry. Use the predefined `{two-colons}` and `{two-semicolons}` +attributes to suppress this behavior, for example: + + Qui in magna commodo{two-colons} est labitur dolorum an. Est ne + magna primis adolescens. + +Will be rendered as: + +Qui in magna commodo{two-colons} est labitur dolorum an. Est ne +magna primis adolescens. + + +== How can I set default list and tables styles? + +You can set the element's 'style' entry in a global or custom +configuration file. + +This example this will horizontally style all labeled lists that don't +have an explicit style attribute: + +---------------------------------- +[listdef-labeled] +style=horizontal + +[listdef-labeled2] +style=horizontal +---------------------------------- + +This example will put a top and bottom border on all tables that don't +already have an explicit style attribute: + +---------------------------------- +[tabledef-default] +style=topbot +topbot-style=frame="topbot" +---------------------------------- + +Alternatively you can set the configuration entries from inside your +document, the above examples are equivalent to: + +---------------------------------- +:listdef-labeled.style: horizontal +:listdef-labeled2.style: horizontal + +:tabledef-default.topbot-style: frame="topbot" +:tabledef-default.style: topbot +---------------------------------- + + +== Why do I get a filter non-zero exit code error? + +An error was returned when AsciiDoc tried to execute an external +filter command. The most common reason for this is that the filter +command could not be found by the command shell. To figure out what +the problem is run AsciiDoc with the `--verbose` option to determine +the command that is failing and then try to run the command manually +from the command-line. + + +== Are there any DocBook viewers? + +http://live.gnome.org/Yelp[Yelp], the GNOME help viewer, does a +creditable job of displaying DocBook XML files directly. + + +== Can you create ODF documents using AsciiDoc? + +The easiest and highest fidelity method I've seen is to generate +HTML from AsciiDoc then paste it from your browser (we use Firefox) +into OpenOffice Writer. + +- I found that that there is better fidelity pasting HTML generated by + the 'html4' backend instead of the default 'xhtml11' backend. +- Don't paste AsciiDoc tables of contents, OpenOffice Writer (I was + using version 2.3) hangs when saving. This may be something to do + with the embedded JavaScript but I haven't looked closely at it, I + may even be wrong about this. + +This tip was contributed by Bernard Amade. + + +== How can I suppress cell separators in included table data files? + +Use the `{include:}` system attribute instead of the `include::[]` +macro (the former is not expanded until after the table data has been +parsed into cells, whereas the latter is included before the table is +processed. + + +== How can I preserve paragraph line boundaries? + +Apply the The 'verse' paragraph style, the rendered text preserves +line boundaries and is useful for lyrics and poems. For example: + +--------------------------------------------------------------------- +[verse] +Consul *necessitatibus* per id, +consetetur, eu pro everti postulant +homero verear ea mea, qui. +--------------------------------------------------------------------- + +Alternatively, if you are generating PDF files, you can use line +breaks. For example: + +--------------------------------------------------------------------- +Consul *necessitatibus* per id, + +consetetur, eu pro everti postulant + +homero verear ea mea, qui. +--------------------------------------------------------------------- + + +== How can I include non-breaking space characters? + +Use the non-breaking space character entity reference ` ` (see +the next question). You could also use the predefined `{nbsp}` +attribute reference. + + +== Can I include HTML and XML character entity references in my document? + +Yes, just enter the reference in your document. For example `β` +will print a Greek small beta character β + + +[[X1]] +== How do I include spaces in URLs? + +URL inline macro targets (addresses) cannot contain white space +characters. If you need spaces encode them as `%20`. For example: + + image:large%20image.png[] + http://www.foo.bar.com/an%20example%20document.html + + +== How can I get AsciiDoc to assign the correct DocBook language attribute? + +Set the AsciiDoc 'lang' attribute to the appropriate language code. +For example: + + $ a2x -a lang=es doc/article.txt + +This will ensure that downstream DocBook processing will generate the +correct language specific document headings (things like table of +contents, revision history, figure and table captions, admonition +captions). + + +== How can I turn off table and image title numbering? +For HTML outputs set the 'caption' attribute to an empty string, +either globally: + +------------------------- +:caption: +------------------------- + +or on an element by element basis, for example: + +------------------------- +.Tiger +[caption=""] +image::images/tiger.png[] +------------------------- + + +== How can I assign multiple author names? + +A quick way to do this is put both authors in a single first name, for +example: + +--------------------------------------- +My Document +=========== +:Author: Bill_and_Ben_the_Flowerpot_Men +:Author Initials: BB & BC +--------------------------------------- + +asciidoc(1) replaces the underscores with spaces. + +If you are generating DocBook then a more flexible approach is to +create a 'docinfo' file containing a DocBook 'authorgroup' element +(search the 'User Guide' for 'docinfo' for more details). + + +== How can I selectively disable a quoted text substitution? + +Omitting the tag name will disable quoting. For example, if you don't +want superscripts or subscripts then put the following in a custom +configuration file or edit the global `asciidoc.conf` configuration +file: + +------------------- +[quotes] +^= +~= +------------------- + +Alternatively you can set the configuration entries from within your +document, the above examples are equivalent to: + +------------------- +:quotes.^: +:quotes.~: +------------------- + + +== How can I customize the \{localdate} format? + +The default format for the `{localdate}` attribute is the ISO 8601 +`yyyy-mm-dd` format. You can change this format by explicitly setting +the `{localdate}` attribute. For example by setting it using the +asciidoc(1) `-a` command-line option: + + $ asciidoc -a localdate=`date +%d-%m-%Y` mydoc.txt + +You could also set it by adding an Attribute Entry to your source +document, for example: + + :localdate: {sys: date +%Y-%m-%d} + + +== Why doesn't AsciiDoc support strike through text? + +DocBook does not have provision for strike through text and one of the +AsciiDoc design goals is that AsciiDoc markup should strive to be +applicable to all output formats. + +Strike through is normally used to mark deleted text -- a more +comprehensive way to manage document revisions is to use a version +control system such as Subversion. You can also use the AsciiDoc +'CommentLines' and 'CommentBlocks' to retain revised text in the +source document. + +If you really need strike through text for (X)HTML outputs then adding +the following to a configuration file will allow you to quote strike +through text with hyphen characters: + +--------------------------------------------------------------------- + ifdef::basebackend-html[] + + [quotes] + -=strikethrough + + [tags] + strikethrough=<del>|</del> + + endif::basebackend-html[] +--------------------------------------------------------------------- + + +== Where can I find examples of commands used to build output documents? + +The User Guide has some. You could also look at `./doc/main.aap` and +`./examples/website/main.aap` in the AsciiDoc distribution, they have +all the commands used to build the AsciiDoc documentation and the +AsciiDoc website (even if you don't use A-A-P you'll still find it +useful). + + +== Why have you used the DocBook <simpara> element instead of <para>? + +`<simpara>` is really the same as `<para>` except it can't contain +block elements -- this matches, more closely, the AsciiDoc paragraph +semantics. + + +== How can I format text inside a listing block? + +By default only 'specialcharacters' and 'callouts' are substituted in +listing blocks; you can add quotes substitutions by explicitly setting +the block 'subs' attribute, for example: + +[listing] +.......................................... +[subs="quotes"] +------------------------------------------ +$ ls *-al* +------------------------------------------ +.......................................... + +The `-al` will rendered bold. Note that: + +- You would need to explicitly escape text you didn't want quoted. +- Don't do this in source code listing blocks because it modifies the + source code which confuses the syntax highlighter. +- This only works if your DocBook processor recognizes DocBook + `<emphasis>` elements inside `<screen>` elements. + +Alternative, if the lines are contiguous, you could use the 'literal' +paragraph style: + +------------------------------------------ +["literal",subs="quotes"] +$ ls *-al* +------------------------------------------ + + +== Why doesn't the include1::[] macro work? + +Internally the `include1` macro is translated to the `include1` system +attribute which means it must be evaluated in a region where attribute +substitution is enabled. `include1` won't work, for example, in a +ListingBlock (unless attribute substitution is enabled). `include1` +is intended for use in configuration files, use the `include` macro +and set the attribute `depth=1` instead, for example: + +[listing] +................................................ +------------------------------------------------ +\include::blogpost_media_processing.txt[depth=1] +------------------------------------------------ +................................................ + + +== How can I make the mailto macro work with multiple email addresses? + +For the AsciiDoc 'mailto' macro to work with multiple email addresses +(as per RFC2368) you need to URL encode the '@' characters (replace +them with '%40'), if you don't the individual addresses will be +rendered as separate links. You also need to <<X1,replace spaces with +'%20'>>. + +For example, the following call won't work: + + mailto:jb@foobar.com,jd@acme.co.nz?subject=New foofoo release[New foofoo release] + +Use this instead: + + mailto:jb%40foobar.com,jd%40acme.co.nz?subject=New%20foofoo%20release[New foofoo release] + + +== How can a replacement have a trailing backslash? +Quote the entry name -- this nonsensical example replaces `x\` with +`y`: + + "x\\"=y + +If quoting were omitted the equals character (separating the +entry name `x` from the value `y`) would be escaped. + + diff --git a/examples/website/index.txt b/examples/website/index.txt index 1969a1a..87aa73a 100644 --- a/examples/website/index.txt +++ b/examples/website/index.txt @@ -1,458 +1,458 @@ -AsciiDoc Home Page
-==================
-// Web page meta data.
-:keywords: AsciiDoc, DocBook, EPUB, PDF, ebooks, slideshow, slidy, man page
-:description: AsciiDoc is a text document format for writing notes, +
- documentation, articles, books, ebooks, slideshows, +
- web pages, man pages and blogs. AsciiDoc files can be +
- translated to many formats including HTML, PDF, EPUB, +
- man page.
-
-
-.{revdate}: AsciiDoc {revnumber} Released
-************************************************************************
-link:filters.html[Filter plugins] have been formalised and
-`asciidoc(1)` commands to install, remove and list filter plugins have
-been implemented. The remainder of this release contains mostly minor
-additions plus a number of bug fixes.
-
-Read the link:CHANGELOG.html[CHANGELOG] for a full list of all
-additions, changes and bug fixes. Changes are documented in the
-updated link:userguide.html[User Guide]. See the
-link:INSTALL.html[Installation page] for downloads and and
-installation instructions.
-
-'Stuart Rackham'
-************************************************************************
-
-Introduction
-------------
-{description}
-
-AsciiDoc is highly configurable: both the AsciiDoc source file syntax
-and the backend output markups (which can be almost any type of
-SGML/XML markup) can be customized and extended by the user.
-
-TIP: The pages you are reading were written using AsciiDoc, to view
-the corresponding AsciiDoc source click on the *Page Source* menu item
-in the left hand margin.
-
-
-Overview and Examples
----------------------
-You write an AsciiDoc document the same way you would write a
-normal text document, there are no markup tags or weird format
-notations. AsciiDoc files are designed to be viewed, edited and
-printed directly or translated to other presentation formats using
-the asciidoc(1) command.
-
-The asciidoc(1) command translates AsciiDoc files to HTML, XHTML and
-DocBook markups. DocBook can be post-processed to presentation
-formats such as HTML, PDF, EPUB, DVI, LaTeX, roff, and Postscript
-using readily available Open Source tools.
-
-Example Articles
-~~~~~~~~~~~~~~~~
-- This XHTML version of the
- link:asciidoc.css-embedded.html[AsciiDoc User Guide]
- was generated by AsciiDoc from
- link:asciidoc.txt[this AsciiDoc file].
-
-- Here's the link:asciidoc.html[same document] created by first
- generating DocBook markup using AsciiDoc and then converting the
- DocBook markup to HTML using 'DocBook XSL Stylesheets'.
-
-- The User Guide again, this time a
- link:chunked/index.html[chunked version].
-
-- AsciiDoc generated this link:article-standalone.html[stand-alone
- HTML file] containing embedded CSS, JavaScript and images from this
- link:article.txt[AsciiDoc article template] with this command:
-
- asciidoc -a data-uri -a icons -a toc -a max-width=55em article.txt
-
-- The same link:article.txt[AsciiDoc article template] produced
- this link:article.html[HTML file] and this
- link:article.pdf[PDF file] via DocBook markup generated by AsciiDoc.
-
-[[X7]]
-Example Books
-~~~~~~~~~~~~~
-AsciiDoc markup supports all the standard DocBook frontmatter and
-backmatter sections (dedication, preface, bibliography, glossary,
-index, colophon) plus footnotes and index entries.
-
-- This link:book.txt[AsciiDoc book] produced link:book.html[this HTML
- file] using the 'DocBook XSL Stylesheets'.
-- The link:asciidoc.pdf[PDF formatted AsciiDoc User Guide] was
- generated from asciidoc(1) DocBook output.
-- The link:asciidoc.epub[EPUB formatted AsciiDoc User Guide] was
- generated using link:a2x.1.html[a2x].
-- This link:book.epub[EPUB formatted book skeleton] was generated
- using link:a2x.1.html[a2x].
-- This link:book-multi.txt[multi-part AsciiDoc book] produced
- link:book-multi.html[this HTML file] using the 'DocBook XSL
- Stylesheets'.
-
-Example UNIX Man Pages
-~~~~~~~~~~~~~~~~~~~~~~
-HTML formatted AsciiDoc man pages
-link:asciidoc.1.css-embedded.html[with stylesheets] and
-link:asciidoc.1.html[without stylesheets] were generated by AsciiDoc
-from link:asciidoc.1.txt[this file].
-
-This link:asciidoc.1[roff formatted man page] was generated from
-asciidoc(1) DocBook output using `xsltproc(1)` and DocBook XSL
-Stylesheets.
-
-[[X8]]
-Example Slideshows
-~~~~~~~~~~~~~~~~~~
-The http://www.w3.org/Talks/Tools/Slidy2/[Slidy] backend generates
-HTML slideshows that can be viewed in any web browser. What's nice is
-that you can create completely self contained slideshows including
-embedded images.
-
-- Here is the link:slidy.html[slidy backend documentation] slideshow
- and here is it's link:slidy.txt[AsciiDoc source].
-- An link:slidy-example.html[example slidy slideshow] and the
- link:slidy-example.txt[AsciiDoc source].
-
-Example Web Site
-~~~~~~~~~~~~~~~~
-The link:README-website.html[AsciiDoc website] is included in the
-AsciiDoc distribution (in `./examples/website/`) as example website
-built using AsciiDoc. See `./examples/website/README-website.txt`.
-
-More examples
-~~~~~~~~~~~~~
-- See below: <<X6,'Documents written using AsciiDoc'>>.
-- Example link:newtables.html[Tables].
-
-
-eBook Publication
------------------
-The two most popular open eBook formats are
-http://en.wikipedia.org/wiki/EPUB[EPUB] and PDF.
-The AsciiDoc link:a2x.1.html[a2x] toolchain wrapper makes it easy to
-link:publishing-ebooks-with-asciidoc.html[publish EPUB and PDF eBooks
-with AsciiDoc]. See also <<X7,example books>> and
-link:epub-notes.html[AsciiDoc EPUB Notes]).
-
-
-Blogpost weblog client
-----------------------
-http://srackham.wordpress.com/blogpost-readme/[blogpost] is a
-command-line weblog client for publishing AsciiDoc documents to
-http://wordpress.org/[WordPress] blog hosts. It creates and updates
-weblog posts and pages directly from AsciiDoc source documents.
-
-
-[[X3]]
-Mathematical Formulae
----------------------
-You can include mathematical formulae in AsciiDoc XHTML documents using
-link:asciimathml.html[ASCIIMathML] or link:latexmathml.html[LaTeXMathML]
-notation.
-
-The link:latex-filter.html[AsciiDoc LaTeX filter] translates LaTeX
-source to a PNG image that is automatically inserted into the AsciiDoc
-output documents.
-
-AsciiDoc also has 'latexmath' macros for DocBook outputs -- they are
-documented in link:latexmath.pdf[this PDF file] and can be used in
-AsciiDoc documents processed by `dblatex(1)`.
-
-
-Editor Support
---------------
-- An AsciiDoc syntax highlighter for the Vim text editor is included in the
- AsciiDoc distribution (see 'Appendix F' of the 'AsciiDoc User Guide' for
- details).
-+
-.Syntax highlighter screenshot
-image::images/highlighter.png[height=400,caption="",link="images/highlighter.png"]
-
-- Dag Wieers has implemented an alternative Vim syntax file for
- AsciiDoc which can be found here
- http://svn.rpmforge.net/svn/trunk/tools/asciidoc-vim/.
-- David Avsajanishvili has written a source highlighter for AsciiDoc
- files for http://projects.gnome.org/gtksourceview/[GtkSourceView]
- (used by http://projects.gnome.org/gedit/[gedit] and a number of
- other applications). The project is hosted here:
- https://launchpad.net/asciidoc-gtk-highlight
-- Florian Kaufman has written
- http://code.google.com/p/sensorflo-emacs/source/browse/trunk/adoc-mode.el[adoc-mode.el]
- -- a major-mode for editing asciidoc files in Emacs.
-- The http://xpt.sourceforge.net/[*Nix Power Tools project] has
- released an http://xpt.sourceforge.net/tools/doc-mode/[AsciiDoc
- syntax highlighter for Emacs].
-- Terrence Brannon has written
- http://github.com/metaperl/asciidoc-el[AsciiDoc functions for
- Emacs].
-- Christian Zuckschwerdt has written a
- https://github.com/zuckschwerdt/asciidoc.tmbundle[TextMate bundle]
- for AsciiDoc.
-
-
-Try AsciiDoc on the Web
------------------------
-Andrew Koster has written a Web based application to interactively
-convert and display AsciiDoc source:
-http://andrewk.webfactional.com/asciidoc.php
-
-
-[[X2]]
-External Resources and Applications
------------------------------------
-Here are resources that I know of, if you know of more drop me a line
-and I'll add them to the list.
-
-- Check the link:INSTALL.html#X2[installation page] for packaged versions
- of AsciiDoc.
-- Alex Efros has written an HTML formatted
- http://powerman.name/doc/asciidoc[AsciiDoc Cheatsheet] using
- Asciidoc.
-- Thomas Berker has written an
- http://liksom.info/blog/?q=node/114[AsciiDoc Cheatsheet] in Open
- Document and PDF formats.
-- The http://www.wikimatrix.org/[WikiMatrix] website has an excellent
- http://www.wikimatrix.org/syntax.php[web page] that compares the
- various Wiki markup syntaxes. An interesting attempt at Wiki markup
- standardization is http://www.wikicreole.org/[CREOLE].
-- Franck Pommereau has written
- http://www.univ-paris12.fr/lacl/pommereau/soft/asciidoctest.html[Asciidoctest],
- a program that doctests snippets of Python code within your Asciidoc
- documents.
-- The http://remips.sourceforge.net/[ReMIPS] project website has been
- built using AsciiDoc.
-- Here are some link:asciidoc-docbook-xsl.html[DocBook XSL Stylesheets
- Notes].
-- Karl Mowatt-Wilson has developed an http://ikiwiki.info/[ikiwiki]
- plugin for AsciiDoc which he uses to render
- http://mowson.org/karl[his website]. The plugin is available
- http://www.mowson.org/karl/colophon/[here] and there is some
- discussion of the ikiwiki integration
- http://ikiwiki.info/users/KarlMW/discussion/[here].
-- Glenn Eychaner has
- http://groups.google.com/group/asciidoc/browse_thread/thread/bf04b55628efe214[reworked
- the Asciidoc plugin for ikiwiki] that was created by Karl Mowson,
- the source can be downloaded from
- http://dl.dropbox.com/u/11256359/asciidoc.pm
-- David Hajage has written an AsciiDoc package for the
- http://www.r-project.org/[R Project] (R is a free software
- environment for statistical computing). 'ascii' is available on
- 'CRAN' (just run `install.package("ascii")` from R). Briefly,
- 'ascii' replaces R results in AsciiDoc document with AsciiDoc
- markup. More information and examples here:
- http://eusebe.github.com/ascii/.
-- Pascal Rapaz has written a Python script to automate AsciiDoc
- website generation. You can find it at
- http://www.rapazp.ch/opensource/tools/asciidoc.html.
-- Jared Henley has written
- http://jared.henley.id.au/software/awb/documentation.html[AsciiDoc
- Website Builder]. 'AsciiDoc Website Builder' (awb) is a python
- program that automates the building of of a website written in
- AsciiDoc. All you need to write is the AsciiDoc source plus a few
- simple configuration files.
-- Brad Adkins has written
- http://dbixjcl.org/jcl/asciidocgen/asciidocgen.html[AsciiDocGen], a
- web site generation and deployment tool that allows you write your
- web site content in AsciiDoc. The
- http://dbixjcl.org/jcl/asciidocgen/asciidocgen.html[AsciiDocGen web
- site] is managed using 'AsciiDocGen'.
-- Filippo Negroni has developed a set of tools to facilitate 'literate
- programming' using AsciiDoc. The set of tools is called
- http://eweb.sourceforge.net/[eWEB].
-- http://vanderwijk.info/2009/4/23/full-text-based-document-generation-using-asciidoc-and-ditaa[Ivo's
- blog] describes a http://ditaa.sourceforge.net/[ditaa] filter for
- AsciiDoc which converts http://en.wikipedia.org/wiki/ASCII_art[ASCII
- art] into graphics.
-- http://github.com/github/gollum[Gollum] is a git-powered wiki, it
- supports various formats, including AsciiDoc.
-- Gregory Romé has written an
- http://github.com/gpr/redmine_asciidoc_formatter[AsciiDoc plugin]
- for the http://www.redmine.org/[Redmine] project management
- application.
-- Paul Hsu has started a
- http://github.com/paulhsu/AsciiDoc.CHT.userguide[Chinese translation
- of the AsciiDoc User Guide].
-- Dag Wieers has written
- http://dag.wieers.com/home-made/unoconv/[UNOCONV]. 'UNOCONV' can
- export AsciiDoc outputs to OpenOffice export formats.
-- Ed Keith has written http://codeextactor.berlios.de/[Code
- Extractor], it extracts code snippets from source code files and
- inserts them into AsciiDoc documents.
-- The http://csrp.iut-blagnac.fr/jmiwebsite/home/[JMI website] hosts
- a number of extras for AsciiDoc and Slidy written by Jean-Michel
- Inglebert.
-
-Please let me know if any of these links need updating.
-
-
-[[X6]]
-Documents written using AsciiDoc
---------------------------------
-Here are some documents I know of, if you know of more drop me a line
-and I'll add them to the list.
-
-- The book http://oreilly.com/catalog/9781449397296[Programming iOS 4]
- by Matt Neuburg was written using AsciiDoc. Matt has
- http://www.apeth.net/matt/iosbooktoolchain.html[written an article]
- describing how he used AsciiDoc and other tools to write the book.
-
-- The book
- http://oreilly.com/catalog/9780596155957/index.html[Programming
- Scala] by Dean Wampler and Alex Payne (O'Reilly) was
- http://groups.google.com/group/asciidoc/browse_frm/thread/449f1199343f0e27[written
- using Asciidoc].
-
-- The http://www.ncfaculty.net/dogle/fishR/index.html[fishR] website
- has a number of
- http://www.ncfaculty.net/dogle/fishR/bookex/AIFFD/AIFFD.html[book
- examples] written using AsciiDoc.
-
-- The Neo4j graph database project uses Asciidoc, and the output is
- published here: http://docs.neo4j.org/. The build process includes
- live tested source code snippets and is described
- http://groups.google.com/group/asciidoc/browse_thread/thread/49d570062fd3ff52[here].
-
-- http://frugalware.org/[Frugalware Linux] uses AsciiDoc for
- http://frugalware.org/docs[documentation].
-- http://www.cherokee-project.com/doc/[Cherokee documentation].
-
-- Henrik Maier produced this professional User manual using AsciiDoc:
- http://www.proconx.com/gcpmg/UMGCPMG-0801.pdf.
-
-- Henrik also produced this folded single page brochure format
- example: http://www.proconx.com/gcpmg/IGGCPMG-0801-up.pdf.
-+
-See this
-http://groups.google.com/group/asciidoc/browse_thread/thread/16ab5a06864b934f[AsciiDoc
-discussion group thread] for details.
-
-- The
- http://www.kernel.org/pub/software/scm/git/docs/user-manual.html[Git
- User's Manual].
-- 'Git Magic' +
- http://www-cs-students.stanford.edu/~blynn/gitmagic/ +
- http://github.com/blynn/gitmagic/tree/1e5780f658962f8f9b01638059b27275cfda095c
-- 'CouchDB: The Definitive Guide' +
- http://books.couchdb.org/relax/ +
- http://groups.google.com/group/asciidoc/browse_thread/thread/a60f67cbbaf862aa/d214bf7fa2d538c4?lnk=gst&q=book#d214bf7fa2d538c4
-- 'Ramaze Manual' +
- http://book.ramaze.net/ +
- http://github.com/manveru/ramaze-book/tree/master
-- Some documentation about git by Nico Schottelius (in German)
- http://nico.schotteli.us/papers/linux/git-firmen/.
-- The http://www.netpromi.com/kirbybase_ruby.html[KirbyBase for Ruby]
- database management system manual.
-- The http://xpt.sourceforge.net/[*Nix Power Tools project] uses
- AsciiDoc for documentation.
-- The http://www.wesnoth.org/[Battle for Wesnoth] project uses
- AsciiDoc for its http://www.wesnoth.org/wiki/WesnothManual[Manual]
- in a number of different languages.
-- Troy Hanson uses AsciiDoc to generate user guides for the
- http://tpl.sourceforge.net/[tpl] and
- http://uthash.sourceforge.net/[uthash] projects (the HTML versions
- have a customised contents sidebar).
-- http://volnitsky.com/[Leonid Volnitsky's site] is generated using
- AsciiDoc and includes Leonid's matplotlib filter.
-- http://www.weechat.org/[WeeChat] uses AsciiDoc for
- http://www.weechat.org/doc[project documentation].
-- http://www.clansuite.com/[Clansuite] uses AsciiDoc for
- http://www.clansuite.com/documentation/[project documentation].
-- The http://fc-solve.berlios.de/[Freecell Solver program] uses
- AsciiDoc for its
- http://fc-solve.berlios.de/docs/#distributed-docs[distributed
- documentation].
-- Eric Raymond's http://gpsd.berlios.de/AIVDM.html[AIVDM/AIVDO
- protocol decoding] documentation is written using AsciiDoc.
-- Dwight Schauer has written an http://lxc.teegra.net/[LXC HOWTO] in
- AsciiDoc.
-- The http://www.rowetel.com/ucasterisk/[Free Telephony Project]
- website is generated using AsciiDoc.
-- Warren Block has http://www.wonkity.com/~wblock/docs/[posted a
- number of articles written using AsciiDoc].
-- The http://code.google.com/p/waf/[Waf project's] 'Waf Book' is
- written using AsciiDoc, there is an
- http://waf.googlecode.com/svn/docs/wafbook/single.html[HTML] and a
- http://waf.googlecode.com/svn/docs/wafbook/waf.pdf[PDF] version.
-- The http://www.diffkit.org/[DiffKit] project's documentation and
- website have been written using Asciidoc.
-- The http://www.networkupstools.org[Network UPS Tools] project
- http://www.networkupstools.org/documentation.html[documentation] is
- an example of a large documentation project written using AsciiDoc.
-- http://www.archlinux.org/pacman/[Pacman], the
- http://www.archlinux.org/[Arch Linux] package manager, has been
- documented using AsciiDoc.
-
-Please let me know if any of these links need updating.
-
-
-DocBook 5.0 Backend
--------------------
-Shlomi Fish has begun work on a DocBook 5.0 `docbook50.conf` backend
-configuration file, you can find it
-http://bitbucket.org/shlomif/asciidoc[here]. See also:
-http://groups.google.com/group/asciidoc/browse_thread/thread/4386c7cc053d51a9
-
-
-[[X1]]
-LaTeX Backend
--------------
-An experimental LaTeX backend was written for AsciiDoc in 2006 by
-Benjamin Klum. Benjamin did a superhuman job (I admit it, I didn't
-think this was doable due to AsciiDoc's SGML/XML bias). Owning to to
-other commitments, Benjamin was unable to maintain this backend.
-Here's link:latex-backend.html[Benjamin's original documentation].
-Incompatibilities introduced after AsciiDoc 8.2.7 broke the LaTeX
-backend.
-
-In 2009 Geoff Eddy stepped up and updated the LaTeX backend, thanks to
-Geoff's efforts it now works with AsciiDoc 8.4.3. Geoff's updated
-`latex.conf` file shipped with AsciiDoc version 8.4.4. The backend
-still has limitations and remains experimental (see
-link:latex-bugs.html[Geoff's notes]).
-
-It's probably also worth pointing out that LaTeX output can be
-generated by passing AsciiDoc generated DocBook through `dblatex(1)`.
-
-
-Patches and bug reports
------------------------
-Patches and bug reports are are encouraged, but please try to follow
-these guidelines:
-
-- Post bug reports and patches to the
- http://groups.google.com/group/asciidoc[asciidoc discussion list],
- this keeps things transparent and gives everyone a chance to
- comment.
-- The email subject line should be a specific and concise topic
- summary. Commonly accepted subject line prefixes such as '[ANN]',
- '[PATCH]' and '[SOLVED]' are good.
-
-=== Bug reports
-- When reporting problems please illustrate the problem with the
- smallest possible example that replicates the issue (and please test
- your example before posting). This technique will also help to
- eliminate red herrings prior to posting.
-- Paste the commands that you executed along with any relevant
- outputs.
-- Include the version of AsciiDoc and the platform you're running it
- on.
-- If you can program please consider writing a patch to fix the
- problem.
-
-=== Patches
-- Keep patches small and atomic (one issue per patch) -- no patch
- bombs.
-- If possible test your patch against the current trunk.
-- If your patch adds or modifies functionality include a short example
- that illustrates the changes.
-- Send patches in `diff -u` format, inline inside the mail message is
- usually best; if it is a very long patch then send it as an
- attachment.
-- Include documentation updates if you're up to it; otherwise insert
- 'TODO' comments at relevant places in the documentation.
-
+AsciiDoc Home Page +================== +// Web page meta data. +:keywords: AsciiDoc, DocBook, EPUB, PDF, ebooks, slideshow, slidy, man page +:description: AsciiDoc is a text document format for writing notes, + + documentation, articles, books, ebooks, slideshows, + + web pages, man pages and blogs. AsciiDoc files can be + + translated to many formats including HTML, PDF, EPUB, + + man page. + + +.{revdate}: AsciiDoc {revnumber} Released +************************************************************************ +link:filters.html[Filter plugins] have been formalised and +`asciidoc(1)` commands to install, remove and list filter plugins have +been implemented. The remainder of this release contains mostly minor +additions plus a number of bug fixes. + +Read the link:CHANGELOG.html[CHANGELOG] for a full list of all +additions, changes and bug fixes. Changes are documented in the +updated link:userguide.html[User Guide]. See the +link:INSTALL.html[Installation page] for downloads and and +installation instructions. + +'Stuart Rackham' +************************************************************************ + +Introduction +------------ +{description} + +AsciiDoc is highly configurable: both the AsciiDoc source file syntax +and the backend output markups (which can be almost any type of +SGML/XML markup) can be customized and extended by the user. + +TIP: The pages you are reading were written using AsciiDoc, to view +the corresponding AsciiDoc source click on the *Page Source* menu item +in the left hand margin. + + +Overview and Examples +--------------------- +You write an AsciiDoc document the same way you would write a +normal text document, there are no markup tags or weird format +notations. AsciiDoc files are designed to be viewed, edited and +printed directly or translated to other presentation formats using +the asciidoc(1) command. + +The asciidoc(1) command translates AsciiDoc files to HTML, XHTML and +DocBook markups. DocBook can be post-processed to presentation +formats such as HTML, PDF, EPUB, DVI, LaTeX, roff, and Postscript +using readily available Open Source tools. + +Example Articles +~~~~~~~~~~~~~~~~ +- This XHTML version of the + link:asciidoc.css-embedded.html[AsciiDoc User Guide] + was generated by AsciiDoc from + link:asciidoc.txt[this AsciiDoc file]. + +- Here's the link:asciidoc.html[same document] created by first + generating DocBook markup using AsciiDoc and then converting the + DocBook markup to HTML using 'DocBook XSL Stylesheets'. + +- The User Guide again, this time a + link:chunked/index.html[chunked version]. + +- AsciiDoc generated this link:article-standalone.html[stand-alone + HTML file] containing embedded CSS, JavaScript and images from this + link:article.txt[AsciiDoc article template] with this command: + + asciidoc -a data-uri -a icons -a toc -a max-width=55em article.txt + +- The same link:article.txt[AsciiDoc article template] produced + this link:article.html[HTML file] and this + link:article.pdf[PDF file] via DocBook markup generated by AsciiDoc. + +[[X7]] +Example Books +~~~~~~~~~~~~~ +AsciiDoc markup supports all the standard DocBook frontmatter and +backmatter sections (dedication, preface, bibliography, glossary, +index, colophon) plus footnotes and index entries. + +- This link:book.txt[AsciiDoc book] produced link:book.html[this HTML + file] using the 'DocBook XSL Stylesheets'. +- The link:asciidoc.pdf[PDF formatted AsciiDoc User Guide] was + generated from asciidoc(1) DocBook output. +- The link:asciidoc.epub[EPUB formatted AsciiDoc User Guide] was + generated using link:a2x.1.html[a2x]. +- This link:book.epub[EPUB formatted book skeleton] was generated + using link:a2x.1.html[a2x]. +- This link:book-multi.txt[multi-part AsciiDoc book] produced + link:book-multi.html[this HTML file] using the 'DocBook XSL + Stylesheets'. + +Example UNIX Man Pages +~~~~~~~~~~~~~~~~~~~~~~ +HTML formatted AsciiDoc man pages +link:asciidoc.1.css-embedded.html[with stylesheets] and +link:asciidoc.1.html[without stylesheets] were generated by AsciiDoc +from link:asciidoc.1.txt[this file]. + +This link:asciidoc.1[roff formatted man page] was generated from +asciidoc(1) DocBook output using `xsltproc(1)` and DocBook XSL +Stylesheets. + +[[X8]] +Example Slideshows +~~~~~~~~~~~~~~~~~~ +The http://www.w3.org/Talks/Tools/Slidy2/[Slidy] backend generates +HTML slideshows that can be viewed in any web browser. What's nice is +that you can create completely self contained slideshows including +embedded images. + +- Here is the link:slidy.html[slidy backend documentation] slideshow + and here is it's link:slidy.txt[AsciiDoc source]. +- An link:slidy-example.html[example slidy slideshow] and the + link:slidy-example.txt[AsciiDoc source]. + +Example Web Site +~~~~~~~~~~~~~~~~ +The link:README-website.html[AsciiDoc website] is included in the +AsciiDoc distribution (in `./examples/website/`) as example website +built using AsciiDoc. See `./examples/website/README-website.txt`. + +More examples +~~~~~~~~~~~~~ +- See below: <<X6,'Documents written using AsciiDoc'>>. +- Example link:newtables.html[Tables]. + + +eBook Publication +----------------- +The two most popular open eBook formats are +http://en.wikipedia.org/wiki/EPUB[EPUB] and PDF. +The AsciiDoc link:a2x.1.html[a2x] toolchain wrapper makes it easy to +link:publishing-ebooks-with-asciidoc.html[publish EPUB and PDF eBooks +with AsciiDoc]. See also <<X7,example books>> and +link:epub-notes.html[AsciiDoc EPUB Notes]). + + +Blogpost weblog client +---------------------- +http://srackham.wordpress.com/blogpost-readme/[blogpost] is a +command-line weblog client for publishing AsciiDoc documents to +http://wordpress.org/[WordPress] blog hosts. It creates and updates +weblog posts and pages directly from AsciiDoc source documents. + + +[[X3]] +Mathematical Formulae +--------------------- +You can include mathematical formulae in AsciiDoc XHTML documents using +link:asciimathml.html[ASCIIMathML] or link:latexmathml.html[LaTeXMathML] +notation. + +The link:latex-filter.html[AsciiDoc LaTeX filter] translates LaTeX +source to a PNG image that is automatically inserted into the AsciiDoc +output documents. + +AsciiDoc also has 'latexmath' macros for DocBook outputs -- they are +documented in link:latexmath.pdf[this PDF file] and can be used in +AsciiDoc documents processed by `dblatex(1)`. + + +Editor Support +-------------- +- An AsciiDoc syntax highlighter for the Vim text editor is included in the + AsciiDoc distribution (see 'Appendix F' of the 'AsciiDoc User Guide' for + details). ++ +.Syntax highlighter screenshot +image::images/highlighter.png[height=400,caption="",link="images/highlighter.png"] + +- Dag Wieers has implemented an alternative Vim syntax file for + AsciiDoc which can be found here + http://svn.rpmforge.net/svn/trunk/tools/asciidoc-vim/. +- David Avsajanishvili has written a source highlighter for AsciiDoc + files for http://projects.gnome.org/gtksourceview/[GtkSourceView] + (used by http://projects.gnome.org/gedit/[gedit] and a number of + other applications). The project is hosted here: + https://launchpad.net/asciidoc-gtk-highlight +- Florian Kaufman has written + http://code.google.com/p/sensorflo-emacs/source/browse/trunk/adoc-mode.el[adoc-mode.el] + -- a major-mode for editing asciidoc files in Emacs. +- The http://xpt.sourceforge.net/[*Nix Power Tools project] has + released an http://xpt.sourceforge.net/tools/doc-mode/[AsciiDoc + syntax highlighter for Emacs]. +- Terrence Brannon has written + http://github.com/metaperl/asciidoc-el[AsciiDoc functions for + Emacs]. +- Christian Zuckschwerdt has written a + https://github.com/zuckschwerdt/asciidoc.tmbundle[TextMate bundle] + for AsciiDoc. + + +Try AsciiDoc on the Web +----------------------- +Andrew Koster has written a Web based application to interactively +convert and display AsciiDoc source: +http://andrewk.webfactional.com/asciidoc.php + + +[[X2]] +External Resources and Applications +----------------------------------- +Here are resources that I know of, if you know of more drop me a line +and I'll add them to the list. + +- Check the link:INSTALL.html#X2[installation page] for packaged versions + of AsciiDoc. +- Alex Efros has written an HTML formatted + http://powerman.name/doc/asciidoc[AsciiDoc Cheatsheet] using + Asciidoc. +- Thomas Berker has written an + http://liksom.info/blog/?q=node/114[AsciiDoc Cheatsheet] in Open + Document and PDF formats. +- The http://www.wikimatrix.org/[WikiMatrix] website has an excellent + http://www.wikimatrix.org/syntax.php[web page] that compares the + various Wiki markup syntaxes. An interesting attempt at Wiki markup + standardization is http://www.wikicreole.org/[CREOLE]. +- Franck Pommereau has written + http://www.univ-paris12.fr/lacl/pommereau/soft/asciidoctest.html[Asciidoctest], + a program that doctests snippets of Python code within your Asciidoc + documents. +- The http://remips.sourceforge.net/[ReMIPS] project website has been + built using AsciiDoc. +- Here are some link:asciidoc-docbook-xsl.html[DocBook XSL Stylesheets + Notes]. +- Karl Mowatt-Wilson has developed an http://ikiwiki.info/[ikiwiki] + plugin for AsciiDoc which he uses to render + http://mowson.org/karl[his website]. The plugin is available + http://www.mowson.org/karl/colophon/[here] and there is some + discussion of the ikiwiki integration + http://ikiwiki.info/users/KarlMW/discussion/[here]. +- Glenn Eychaner has + http://groups.google.com/group/asciidoc/browse_thread/thread/bf04b55628efe214[reworked + the Asciidoc plugin for ikiwiki] that was created by Karl Mowson, + the source can be downloaded from + http://dl.dropbox.com/u/11256359/asciidoc.pm +- David Hajage has written an AsciiDoc package for the + http://www.r-project.org/[R Project] (R is a free software + environment for statistical computing). 'ascii' is available on + 'CRAN' (just run `install.package("ascii")` from R). Briefly, + 'ascii' replaces R results in AsciiDoc document with AsciiDoc + markup. More information and examples here: + http://eusebe.github.com/ascii/. +- Pascal Rapaz has written a Python script to automate AsciiDoc + website generation. You can find it at + http://www.rapazp.ch/opensource/tools/asciidoc.html. +- Jared Henley has written + http://jared.henley.id.au/software/awb/documentation.html[AsciiDoc + Website Builder]. 'AsciiDoc Website Builder' (awb) is a python + program that automates the building of of a website written in + AsciiDoc. All you need to write is the AsciiDoc source plus a few + simple configuration files. +- Brad Adkins has written + http://dbixjcl.org/jcl/asciidocgen/asciidocgen.html[AsciiDocGen], a + web site generation and deployment tool that allows you write your + web site content in AsciiDoc. The + http://dbixjcl.org/jcl/asciidocgen/asciidocgen.html[AsciiDocGen web + site] is managed using 'AsciiDocGen'. +- Filippo Negroni has developed a set of tools to facilitate 'literate + programming' using AsciiDoc. The set of tools is called + http://eweb.sourceforge.net/[eWEB]. +- http://vanderwijk.info/2009/4/23/full-text-based-document-generation-using-asciidoc-and-ditaa[Ivo's + blog] describes a http://ditaa.sourceforge.net/[ditaa] filter for + AsciiDoc which converts http://en.wikipedia.org/wiki/ASCII_art[ASCII + art] into graphics. +- http://github.com/github/gollum[Gollum] is a git-powered wiki, it + supports various formats, including AsciiDoc. +- Gregory Romé has written an + http://github.com/gpr/redmine_asciidoc_formatter[AsciiDoc plugin] + for the http://www.redmine.org/[Redmine] project management + application. +- Paul Hsu has started a + http://github.com/paulhsu/AsciiDoc.CHT.userguide[Chinese translation + of the AsciiDoc User Guide]. +- Dag Wieers has written + http://dag.wieers.com/home-made/unoconv/[UNOCONV]. 'UNOCONV' can + export AsciiDoc outputs to OpenOffice export formats. +- Ed Keith has written http://codeextactor.berlios.de/[Code + Extractor], it extracts code snippets from source code files and + inserts them into AsciiDoc documents. +- The http://csrp.iut-blagnac.fr/jmiwebsite/home/[JMI website] hosts + a number of extras for AsciiDoc and Slidy written by Jean-Michel + Inglebert. + +Please let me know if any of these links need updating. + + +[[X6]] +Documents written using AsciiDoc +-------------------------------- +Here are some documents I know of, if you know of more drop me a line +and I'll add them to the list. + +- The book http://oreilly.com/catalog/9781449397296[Programming iOS 4] + by Matt Neuburg was written using AsciiDoc. Matt has + http://www.apeth.net/matt/iosbooktoolchain.html[written an article] + describing how he used AsciiDoc and other tools to write the book. + +- The book + http://oreilly.com/catalog/9780596155957/index.html[Programming + Scala] by Dean Wampler and Alex Payne (O'Reilly) was + http://groups.google.com/group/asciidoc/browse_frm/thread/449f1199343f0e27[written + using Asciidoc]. + +- The http://www.ncfaculty.net/dogle/fishR/index.html[fishR] website + has a number of + http://www.ncfaculty.net/dogle/fishR/bookex/AIFFD/AIFFD.html[book + examples] written using AsciiDoc. + +- The Neo4j graph database project uses Asciidoc, and the output is + published here: http://docs.neo4j.org/. The build process includes + live tested source code snippets and is described + http://groups.google.com/group/asciidoc/browse_thread/thread/49d570062fd3ff52[here]. + +- http://frugalware.org/[Frugalware Linux] uses AsciiDoc for + http://frugalware.org/docs[documentation]. +- http://www.cherokee-project.com/doc/[Cherokee documentation]. + +- Henrik Maier produced this professional User manual using AsciiDoc: + http://www.proconx.com/gcpmg/UMGCPMG-0801.pdf. + +- Henrik also produced this folded single page brochure format + example: http://www.proconx.com/gcpmg/IGGCPMG-0801-up.pdf. ++ +See this +http://groups.google.com/group/asciidoc/browse_thread/thread/16ab5a06864b934f[AsciiDoc +discussion group thread] for details. + +- The + http://www.kernel.org/pub/software/scm/git/docs/user-manual.html[Git + User's Manual]. +- 'Git Magic' + + http://www-cs-students.stanford.edu/~blynn/gitmagic/ + + http://github.com/blynn/gitmagic/tree/1e5780f658962f8f9b01638059b27275cfda095c +- 'CouchDB: The Definitive Guide' + + http://books.couchdb.org/relax/ + + http://groups.google.com/group/asciidoc/browse_thread/thread/a60f67cbbaf862aa/d214bf7fa2d538c4?lnk=gst&q=book#d214bf7fa2d538c4 +- 'Ramaze Manual' + + http://book.ramaze.net/ + + http://github.com/manveru/ramaze-book/tree/master +- Some documentation about git by Nico Schottelius (in German) + http://nico.schotteli.us/papers/linux/git-firmen/. +- The http://www.netpromi.com/kirbybase_ruby.html[KirbyBase for Ruby] + database management system manual. +- The http://xpt.sourceforge.net/[*Nix Power Tools project] uses + AsciiDoc for documentation. +- The http://www.wesnoth.org/[Battle for Wesnoth] project uses + AsciiDoc for its http://www.wesnoth.org/wiki/WesnothManual[Manual] + in a number of different languages. +- Troy Hanson uses AsciiDoc to generate user guides for the + http://tpl.sourceforge.net/[tpl] and + http://uthash.sourceforge.net/[uthash] projects (the HTML versions + have a customised contents sidebar). +- http://volnitsky.com/[Leonid Volnitsky's site] is generated using + AsciiDoc and includes Leonid's matplotlib filter. +- http://www.weechat.org/[WeeChat] uses AsciiDoc for + http://www.weechat.org/doc[project documentation]. +- http://www.clansuite.com/[Clansuite] uses AsciiDoc for + http://www.clansuite.com/documentation/[project documentation]. +- The http://fc-solve.berlios.de/[Freecell Solver program] uses + AsciiDoc for its + http://fc-solve.berlios.de/docs/#distributed-docs[distributed + documentation]. +- Eric Raymond's http://gpsd.berlios.de/AIVDM.html[AIVDM/AIVDO + protocol decoding] documentation is written using AsciiDoc. +- Dwight Schauer has written an http://lxc.teegra.net/[LXC HOWTO] in + AsciiDoc. +- The http://www.rowetel.com/ucasterisk/[Free Telephony Project] + website is generated using AsciiDoc. +- Warren Block has http://www.wonkity.com/~wblock/docs/[posted a + number of articles written using AsciiDoc]. +- The http://code.google.com/p/waf/[Waf project's] 'Waf Book' is + written using AsciiDoc, there is an + http://waf.googlecode.com/svn/docs/wafbook/single.html[HTML] and a + http://waf.googlecode.com/svn/docs/wafbook/waf.pdf[PDF] version. +- The http://www.diffkit.org/[DiffKit] project's documentation and + website have been written using Asciidoc. +- The http://www.networkupstools.org[Network UPS Tools] project + http://www.networkupstools.org/documentation.html[documentation] is + an example of a large documentation project written using AsciiDoc. +- http://www.archlinux.org/pacman/[Pacman], the + http://www.archlinux.org/[Arch Linux] package manager, has been + documented using AsciiDoc. + +Please let me know if any of these links need updating. + + +DocBook 5.0 Backend +------------------- +Shlomi Fish has begun work on a DocBook 5.0 `docbook50.conf` backend +configuration file, you can find it +http://bitbucket.org/shlomif/asciidoc[here]. See also: +http://groups.google.com/group/asciidoc/browse_thread/thread/4386c7cc053d51a9 + + +[[X1]] +LaTeX Backend +------------- +An experimental LaTeX backend was written for AsciiDoc in 2006 by +Benjamin Klum. Benjamin did a superhuman job (I admit it, I didn't +think this was doable due to AsciiDoc's SGML/XML bias). Owning to to +other commitments, Benjamin was unable to maintain this backend. +Here's link:latex-backend.html[Benjamin's original documentation]. +Incompatibilities introduced after AsciiDoc 8.2.7 broke the LaTeX +backend. + +In 2009 Geoff Eddy stepped up and updated the LaTeX backend, thanks to +Geoff's efforts it now works with AsciiDoc 8.4.3. Geoff's updated +`latex.conf` file shipped with AsciiDoc version 8.4.4. The backend +still has limitations and remains experimental (see +link:latex-bugs.html[Geoff's notes]). + +It's probably also worth pointing out that LaTeX output can be +generated by passing AsciiDoc generated DocBook through `dblatex(1)`. + + +Patches and bug reports +----------------------- +Patches and bug reports are are encouraged, but please try to follow +these guidelines: + +- Post bug reports and patches to the + http://groups.google.com/group/asciidoc[asciidoc discussion list], + this keeps things transparent and gives everyone a chance to + comment. +- The email subject line should be a specific and concise topic + summary. Commonly accepted subject line prefixes such as '[ANN]', + '[PATCH]' and '[SOLVED]' are good. + +=== Bug reports +- When reporting problems please illustrate the problem with the + smallest possible example that replicates the issue (and please test + your example before posting). This technique will also help to + eliminate red herrings prior to posting. +- Paste the commands that you executed along with any relevant + outputs. +- Include the version of AsciiDoc and the platform you're running it + on. +- If you can program please consider writing a patch to fix the + problem. + +=== Patches +- Keep patches small and atomic (one issue per patch) -- no patch + bombs. +- If possible test your patch against the current trunk. +- If your patch adds or modifies functionality include a short example + that illustrates the changes. +- Send patches in `diff -u` format, inline inside the mail message is + usually best; if it is a very long patch then send it as an + attachment. +- Include documentation updates if you're up to it; otherwise insert + 'TODO' comments at relevant places in the documentation. + diff --git a/examples/website/latex-backend.txt b/examples/website/latex-backend.txt index 91275e3..32d87df 120000..100644 --- a/examples/website/latex-backend.txt +++ b/examples/website/latex-backend.txt @@ -1 +1,192 @@ -../../doc/latex-backend.txt
\ No newline at end of file +LaTeX backend for Asciidoc +========================== +Benjamin Klum <benjamin.klum@gmail.com> +v1.0, June 2006 + +== Introduction + + +LaTeX backend is a configuration file for Stuart Rackham's http://www.methods.co.nz/asciidoc/[Asciidoc]. It generates high-level LaTeX markup from Asciidoc documents. LaTeX is a document preparation system for TeX which in turn is a popular typesetting system. It is well known for producing excellently typesetted high quality printouts, especially suited for scientific text. + +== Tutorial +Getting a ready-to-print document from an Asciidoc document using the LaTeX backend involves at least two steps: + +1. Conversion of the Asciidoc document into a LaTeX document (this is done by Asciidoc using the LaTeX backend) +2. Conversion of the LaTeX document into a PDF document (this is done by the TeX system) + +Try to create a PDF document from the Asciidoc document `article.txt` which resides in the `doc` directory of Asciidoc: + +.. Make a copy of `article.txt` in a directory of your choice, let's call it `latex-test`. +.. Make sure that all images referenced in `article.txt` exist in `latex-test`. Brute force approach: Copy the whole `images` directory from Asciidoc directory into `latex-test`. +.. Change directory to `latex-test` and type following commands: ++ + asciidoc --unsafe --backend=latex article.txt + pdflatex article.tex ++ +.. Now there should be a file `article.pdf` in the `latex-test` directory. + +[IMPORTANT] +============================== +- Asciidoc has to be started in 'unsafe mode' when using LaTeX backend. +- Note that some special LaTeX packages are necessary, see <<packageRequirements,here>>. +============================== + +== General notes + +=== Quality of LaTeX output +High-level LaTeX is not very straightforward to generate. Therefore there's no guarantee that the generated output is valid and compiles successfully. At all, this backend should be considered as rather experimental. You should have been already in touch with LaTeX in order to use the backend effectively because LaTeX compilation errors can be really nasty. + +Nevertheless good results can be achieved by using LaTeX backend. Try for example to compile Stuart Rackham's Asciidoc documentation, a rather large document. It should compile without problems. However, the code filter might have to be reconfigured for the code filter example to work. + +=== Configuration file customization +Like every other Asciidoc backend the LaTeX backend can be customized easily to fit the user's needs. Actually it is very important to have this option since LaTeX doesn't have a companion language like CSS which allows to put styling information in a separate file. Read more about the LaTeX backend configuration file <<configurationFile,here>>. + +=== Output optimization +The LaTeX output is optimized for creating PDF documents using 'pdflatex'. + +[[unicodeSupport]] +=== Unicode support +Unfortunately TeX/LaTeX does not have native unicode support. The package 'ucs' adds elementary unicode support by introducing UTF-8 input encoding recognition and by defining lookup tables which contain the corresponding LaTeX commands for unicode characters. But these lookup tables are far from being complete. When a unicode character is found which is not defined in the lookup tables an error is raised by the TeX/LaTeX compiler. Note that TeX/LaTeX compilation errors caused by missing unicode character definitions are not fatal, that means the result is probably readable but undefined unicode characters are replaced with `[U+...]`. You may (de)activate the recognition of escaped unicode characters. See the <<latex-recognize-escaped-unicode>> backend option. + +== Backend specific features + +=== Special sections + +LaTeX backend supports the following special sections and replaces them with corresponding LaTeX commands or environments: + +- Abstract (only for document type 'article') +- Dedication (only for document type 'book') +- Index +- Bibliography (only when the attribute 'latex-use-bibliography-environment' is set) +- Appendix +- Contents + +[[internalCrossReferences]] +=== Internal cross references + +Macros for internal cross references have been extended by the attribute 'style'. + + xref:<id>[<caption>, style=<style>] + +or + + <<<id>,<caption>,<style>>> + + +The additional attribute 'style' can have following values: + +page:: +Let's LaTeX print the page number of the referenced anchor. + +ref:: +Let's LaTeX print the number of the section, subsection, figure, table or theorem the referenced anchor resides. + +autoref:: +Let's LaTeX print the number of the section, subsection, figure, table or theorem the referenced anchor resides preceded with a contextual label. + +cite:: +Let's LaTeX interprete this reference as a reference to a bibliography entry. If the attribute 'latex-use-bibliography-environment' is set, references with 'cite' style as well as their corresponding bibliography anchors are presented as automatically generated numbers. + +If the 'style' attribute is not set the reference is printed the common way. + + +=== Options +LaTeX document generation is influenced by the following attributes: + +latex-table-rowlimit:: +The maximum number of rows for typesetting tables using the 'tabular' environment. If a table has more rows than 'latex-table-rowlimit', 'longtable' environment is used instead of 'tabular' environment. 'longtable' environment supports tables spanning over several pages. + +latex-use-bibliography-environment:: +If 'latex-use-bibliography-environment' is defined, 'thebibliography' environment is used for the bibliography section. As a result bibliography entries are automatically numbered. Note that this works only if the bibliography section contains exclusively bibliography list items which start with a bibliography entry ([[[...]]]). Otherwise a TeX/LaTeX compilation error will occur. In order to display bibliography references correctly their 'style' attribute must be set to 'cite'. For more information see <<internalCrossReferences,Internal cross references>>. + +latex-indent-paragraphs:: +If 'latex-indent-paragraphs' is defined, the first line of paragraphs will be indented. By default LaTeX backend prevents paragraph indentation and prints paragraphs with preceding vertical space. + +[[latex-recognize-escaped-unicode]] latex-recognize-escaped-unicode:: +If 'latex-recognize-escaped-unicode' is defined, escaped unicode +characters (e.g. `\$${amp}#960;$$` or `\$${amp}#x3C0;$$`) will be recognized. This can lead to LaTeX compilation errors since LaTeX unicode support is only rudimentary. For more information see <<unicodeSupport, Unicode support>>. + +latex-use-custom-list-items:: +If 'latex-use-custom-list-items' is defined, lists will be bulleted or enumerated the way you have typed them in the original Asciidoc document. That means, `*` turns into a circle bullet, `-` turns into a dash, `.` turns into a number and `..` turns into a letter. Otherwise LaTeX will use different bullets and enumeration characters depending on the level of nesting. + +latex-use-colored-tables:: +If 'latex-use-colored-tables' is defined, tables will be printed colored. + +latex-use-running-title-headings:: +If 'latex-use-running-title-headings' is defined, 'pagestyle' will be set to 'headings' which results in running titles in the head. + +latex-use-colored-sidebar-blocks:: +If 'latex-use-colored-sidebar-blocks' is defined, sidebar block content will be put in a color box instead of being indented by a vertical bar. + +icons:: +Link admonition paragraph and admonition block icon images and badge images. By default icons is undefined and text is used in place of icon images. + +encoding:: +Set the input and output document character set encoding. Currently `ISO-8859-1` and `UTF-8` are supported. + +== Requirements + +=== General + +The following software is necessary for using the LaTeX backend: + +- An up-to-date version of http://www.methods.co.nz/asciidoc/[Asciidoc] +- An up-to-date TeX distribution, e.g.: + * http://www.miktex.org/[MiKTeX] for Windows + * http://www.tug.org/tetex/[teTeX] for Linux + +[[packageRequirements]] +=== TeX/LaTeX Package requirements + +LaTeX backend makes use of some LaTeX specialities which don't belong to a minimal TeX/LaTeX distribution. However, I took special care not to employ exotic packages. Hence the following packages should be available in most package repositories. The table is not complete yet because I don't know the package names for all TeX distributions. + +[cols="4*,4",options="header"] +|==================================================================== +|Speciality | MiKTeX package name | teTeX package name | TeX Live package name | Description +|KOMA-Script | koma-script | | | LaTeX backend uses the document classes 'scrartcl' and 'scrbook' as well as some other specialities defined in the 'KOMA-Script' package, e.g. the commands `\addmargin{}` and `\minisec{}`. +|xcolor.sty | xcolor | | | Used to produce colored boxes and tables. +|colortbl.sty | colortbl | | | Used to produce colored tables. +|type1ec.sty | cm-super | | | Enables high quality fonts for PDF output. +|hyperref.sty | hyperref | | | Extensive support for hypertext in PDF documents. +|enumerate.sty | tools | | | When 'latex-use-custom-list-items' is defined this package is used for determining the enumeration character. +|graphicx.sty | graphics | | | Used for including images. +|longtable.sty | tools | | | Enables page spanning tables. +|ucs.sty | unicode | | | Enables support for unicode characters. +|textcomp | ltxbase | | | Used for printing various symbols like arrows. Should be already installed. +|alltt | ltxbase | | | Used in literal-like blocks for retaining line and whitespace formatting. Should be already installed. +|listings.sty | listings | | | Used for listing blocks. +|==================================================================== + +[[configurationFile]] +== About the LaTeX backend configuration file +An important note for people who want to adapt the LaTeX backend configuration file to their own needs: + +LaTeX markup has a lot of special characters, most importantly ``, `{`, `}`. In order to make things less complicated, I changed the default substitution order (see entry 'subsnormal' in the `[miscellaneous]` section). In contrast to the backends 'docbook' and 'xhtml11', the 'specialcharacters' substitution is applied very late. As a result all special characters produced by 'quotes', 'specialwords', 'replacements', 'attributes' and 'macros' become escaped at the end. If you don't want special characters in the corresponding sections to get escaped, you've to use following symbols instead of the special characters. + +- `\$$!..backslash..!$$` instead of `` +- `\$$!..braceleft..!$$` instead of `{` +- `\$$!..braceright..!$$` instead of `}` + + +For more special characters take a look in the `[replacements2]` sections. `[replacements2]` section is responsible for replacing the symbols with their corresponding special characters. + + +== Ideas + +=== Code listing block + +For creating highlighted code listings I suggest the use of http://www.andre-simon.de/[Highlight] or http://www.gnu.org/software/src-highlite/[GNU Source Highlight]. Both are suited for use as Asciidoc filters. + +== Known Bugs + +- Sometimes LaTeX backend handles things differently from the default backends +- A lot of little bugs + +== Todo List + +- Remove bugs +- Support for 'grid' attribute in tables +- Better looking tables +- Option for squeezing output (smaller lists) +- Support for different languages (That would be a nice feature for Asciidoc in general) +- Option for switching titlepage on and off diff --git a/examples/website/manpage.txt b/examples/website/manpage.txt index e45b347..652a756 120000..100644 --- a/examples/website/manpage.txt +++ b/examples/website/manpage.txt @@ -1 +1,171 @@ -../../doc/asciidoc.1.txt
\ No newline at end of file +ASCIIDOC(1) +=========== +:doctype: manpage + + +NAME +---- +asciidoc - converts an AsciiDoc text file to HTML or DocBook + + +SYNOPSIS +-------- +*asciidoc* ['OPTIONS'] 'FILE' + + +DESCRIPTION +----------- +The asciidoc(1) command translates the AsciiDoc text file 'FILE' to +DocBook or HTML. If 'FILE' is '-' then the standard input is used. + + +OPTIONS +------- +*-a, --attribute*='ATTRIBUTE':: + Define or delete document attribute. 'ATTRIBUTE' is formatted like + 'NAME=VALUE'. Command-line attributes take precedence over + document and configuration file attributes. Alternate acceptable + forms are 'NAME' (the 'VALUE' defaults to an empty string); + 'NAME!' (delete the 'NAME' attribute); 'NAME@' (do not override + document or configuration file attributes). Values containing + spaces should be enclosed in double-quote characters. This option + may be specified more than once. A special attribute named + 'trace' controls the output of diagnostic information. + +*-b, --backend*='BACKEND':: + Backend output file format: 'docbook45', 'xhtml11', 'html4', + 'wordpress' or 'latex' (the 'latex' backend is experimental). + You can also the backend alias names 'html' (aliased to 'xhtml11') + or 'docbook' (aliased to 'docbook45'). + Defaults to 'html'. + +*-f, --conf-file*='CONF_FILE':: + Use configuration file 'CONF_FILE'.Configuration files processed + in command-line order (after implicit configuration files). This + option may be specified more than once. + +*--doctest*:: + Run Python doctests in 'asciidoc' module. + +*-d, --doctype*='DOCTYPE':: + Document type: 'article', 'manpage' or 'book'. The 'book' document + type is only supported by the 'docbook' backend. Default document + type is 'article'. + +*-c, --dump-conf*:: + Dump configuration to stdout. + +*--filter*:: + Manage asciidoc(1) filters (see <<X1,*FILTER COMMANDS*>>). + +*-h, --help*[='TOPIC']:: + Print help TOPIC. *--help*='topics' will print a list of help + topics, *--help*='syntax' summarizes AsciiDoc syntax, + *--help*='manpage' prints the AsciiDoc manpage. + +*-e, --no-conf*:: + Exclude implicitly loaded configuration files except for those + named like the input file ('infile.conf' and + 'infile-backend.conf'). + +*-s, --no-header-footer*:: + Suppress document header and footer output. + +*-o, --out-file*='OUT_FILE':: + Write output to file 'OUT_FILE'. Defaults to the base name of + input file with 'backend' extension. If the input is stdin then + the outfile defaults to stdout. If 'OUT_FILE' is '-' then the + standard output is used. + +*-n, --section-numbers*:: + Auto-number HTML article section titles. Synonym for *-a + numbered*. + +*--safe*:: + Enable safe mode. Safe mode is disabled by default. AsciiDoc + 'safe mode' skips potentially dangerous scripted sections in + AsciiDoc source files. + +*-v, --verbose*:: + Verbosely print processing information and configuration file + checks to stderr. + +*--version*:: + Print program version number. + + +[[X1]] +FILTER COMMANDS +--------------- +The *--filter* option is used to install, remove and list AsciiDoc +filter plugins. Filter commands syntax: + + asciidoc --filter install ZIP_FILE [FILTERS_DIR] + asciidoc --filter remove FILTER_NAME [FILTERS_DIR] + asciidoc --filter list + +Where: + +*FILTER_NAME*:: + A unique filter name containing only alphanumeric or underscore + characters. + +*ZIP_FILE*:: + A Zip file containing filter resources, the name must start with the + filter name e.g. `my_filter-1.0.zip` packages filter `my_filter`. + +*FILTERS_DIR*:: + The directory containing installed filters. Each filter is contained + in its own separate subdirectory which has the same name as the + filter. + *FILTERS_DIR* defaults to the `.asciidoc/filters` directory in the + user's home directory. + +The filter commands perform as follows: + +*install*:: + Create a subdirectory in *FILTERS_DIR* with the same name as the + filter then extract the *ZIP_FILE* into it. + +*remove*:: + Delete the *FILTER_NAME* filter subdirectory and all its contents from + the *FILTERS_DIR*. + +*list*:: + List the names and locations of all installed filters (including + standard filters installed in the global configuration directory). + + +EXIT STATUS +----------- +*0*:: + Success + +*1*:: + Failure (syntax or usage error; configuration error; document + processing failure; unexpected error). + + +BUGS +---- +See the AsciiDoc distribution BUGS file. + + +AUTHOR +------ +AsciiDoc was originally written by Stuart Rackham. Many people have +contributed to it. + + +RESOURCES +--------- +SourceForge: <http://sourceforge.net/projects/asciidoc/> + +Main web site: <http://www.methods.co.nz/asciidoc/> + + +COPYING +------- +Copyright \(C) 2002-2010 Stuart Rackham. Free use of this software is +granted under the terms of the GNU General Public License (GPL). + diff --git a/filters/code/code-filter-readme.txt b/filters/code/code-filter-readme.txt index ddc4a08..2a35f86 100644 --- a/filters/code/code-filter-readme.txt +++ b/filters/code/code-filter-readme.txt @@ -1,37 +1,37 @@ -AsciiDoc Code Filter
-====================
-
-This simple minded filter highlights source code keywords and
-comments.
-
-NOTE: The filter is 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 highlighter use the 'source highlighter filter.
-
-
-Files
------
-code-filter.py::
- The filter Python script.
-code-filter.conf::
- The AsciiDoc filter configuration file.
-code-filter-test.txt::
- Short AsciiDoc document to test the filter.
-
-
-Installation
-------------
-The code filter is installed in the distribution `filters` directory
-as part of the standard AsciiDoc install.
-
-Test it on the `code-filter-test.txt` file:
-
- $ asciidoc -v code-filter-test.txt
- $ firefox code-filter-test.txt &
-
-
-Help
-----
-Execute the filter with the help option:
-
- $ ./code-filter.py --help
+AsciiDoc Code Filter +==================== + +This simple minded filter highlights source code keywords and +comments. + +NOTE: The filter is 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 highlighter use the 'source highlighter filter. + + +Files +----- +code-filter.py:: + The filter Python script. +code-filter.conf:: + The AsciiDoc filter configuration file. +code-filter-test.txt:: + Short AsciiDoc document to test the filter. + + +Installation +------------ +The code filter is installed in the distribution `filters` directory +as part of the standard AsciiDoc install. + +Test it on the `code-filter-test.txt` file: + + $ asciidoc -v code-filter-test.txt + $ firefox code-filter-test.txt & + + +Help +---- +Execute the filter with the help option: + + $ ./code-filter.py --help diff --git a/filters/code/code-filter-test.txt b/filters/code/code-filter-test.txt index c2c2907..c9e8192 100644 --- a/filters/code/code-filter-test.txt +++ b/filters/code/code-filter-test.txt @@ -1,15 +1,15 @@ -Code Filter Test
-================
-
-[python]
-code~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-''' 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
-code~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Code Filter Test +================ + +[python] +code~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +''' 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 +code~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/filters/code/code-filter.conf b/filters/code/code-filter.conf index 91563e1..5cdab96 100644 --- a/filters/code/code-filter.conf +++ b/filters/code/code-filter.conf @@ -1,8 +1,8 @@ -#
-# AsciiDoc code filter configuration file.
-#
-# Documented in code-filter-readme.txt
-#
-
-[blockdef-listing]
-code-style=template="listingblock",presubs=(),postsubs=("callouts",),posattrs=("style","language"),filter="code-filter.py -b {basebackend} -l {language}"
+# +# AsciiDoc code filter configuration file. +# +# Documented in code-filter-readme.txt +# + +[blockdef-listing] +code-style=template="listingblock",presubs=(),postsubs=("callouts",),posattrs=("style","language"),filter="code-filter.py -b {basebackend} -l {language}" @@ -1,505 +1,505 @@ -#
-# html4.conf
-#
-# Asciidoc HTML 4.01 configuration file.
-#
-
-[miscellaneous]
-outfilesuffix=.html
-
-[attributes]
-basebackend=html
-basebackend-html=
-basebackend-html4=
-
-[replacements2]
-# Line break.
-(?m)^(.*)\s\+$=\1<br>
-
-[replacements]
-ifdef::asciidoc7compatible[]
-# Superscripts.
-\^(.+?)\^=<sup>\1</sup>
-# Subscripts.
-~(.+?)~=<sub>\1</sub>
-endif::asciidoc7compatible[]
-
-[ruler-blockmacro]
-<hr>
-
-[pagebreak-blockmacro]
-<div style="page-break-after:always"></div>
-
-[pi-blockmacro]
-<?{target}{0? {0}}?>
-
-[pi-inlinemacro]
-template::[pi-blockmacro]
-
-[image-inlinemacro]
-<a href="{link}"{role? class="{role}"}>
-# src attribute must be first attribute for blogpost compatibility.
-<img src="{imagesdir=}{imagesdir?/}{target}" style="border-width: 0;" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}{title? title="{title}"}>
-{link#}</a>
-
-[image-blockmacro]
-<div{align? align="{align}"}{role? class="{role}"}{float? style="float:{float};"}>
-<a name="{id}"></a>
-<a href="{link}">
-<img src="{imagesdir=}{imagesdir?/}{target}" style="border-width: 0;" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}>
-{link#}</a>
-<p><b>{caption={figure-caption} {counter:figure-number}. }</b>{title}</p>
-</div>
-
-[unfloat-blockmacro]
-<br clear="all">
-
-[indexterm-inlinemacro]
-# Index term.
-{empty}
-
-[indexterm2-inlinemacro]
-# Index term.
-# Single entry index term that is visible in the primary text flow.
-{1}
-
-[footnote-inlinemacro]
-# footnote:[<text>].
-<br><i>[{0}]</i><br>
-
-[footnoteref-inlinemacro]
-# footnoteref:[<id>], create reference to footnote.
-{2%}<br><i><a href="#_footnote_{1}">[{1}]</a></i><br>
-# footnoteref:[<id>,<text>], create footnote with ID.
-{2#}<br><i><a name="_footnote_{1}">[{2}]</a></i><br>
-
-[callout-inlinemacro]
-# Callout.
-<b><{index}></b>
-
-# Comment line macros.
-[comment-inlinemacro]
-{showcomments#}<br><span style="background:yellow;">{passtext}</span><br>
-
-[comment-blockmacro]
-{showcomments#}<p><span style="background:yellow;">{passtext}</span></p>
-
-[literal-inlinemacro]
-# Inline literal.
-<tt>{passtext}</tt>
-
-# List tags.
-[listtags-bulleted]
-list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<ul>|</ul>
-item=<li>|</li>
-text=<p>|</p>
-
-[listtags-numbered]
-list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<ol type="{style@arabic:1}{style@loweralpha:a}{style@upperalpha:A}{style@lowerroman:i}{style@upperroman:I}"{start? start="{start}"}{role? class="{role}"}>|</ol>
-item=<li>|</li>
-text=<p>|</p>
-
-[listtags-labeled]
-list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<dl{role? class="{role}"}>|</dl>
-entry=
-label=
-term=<dt>{strong-option?<strong>}|{strong-option?</strong>}</dt>
-item=<dd>|</dd>
-text=<p>|</p>
-
-[listtags-horizontal]
-list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<table cellpadding="4"{role? class="{role}"}>|</table>
-entry=<tr valign="top">|</tr>
-label=<td{labelwidth? width="{labelwidth}%"}>{strong-option?<strong>}|{strong-option?</strong>}</td>
-term=|<br>
-item=<td{itemwidth? width="{itemwidth}%"}>|</td>
-text=<p>|</p>
-
-[listtags-callout]
-list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<ol{role? class="{role}"}>|</ol>
-item=<li>|</li>
-text=<p>|</p>
-
-[listtags-qanda]
-list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<ol{role? class="{role}"}>|</ol>
-entry=<li>|</li>
-label=
-term=<p><em>|</em></p>
-item=
-text=<p>|</p>
-
-[listtags-glossary]
-list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<dl{role? class="{role}"}>|</dl>
-entry=
-label=
-term=<dt>|</dt>
-item=<dd>|</dd>
-text=<p>|</p>
-
-[listtags-bibliography]
-list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<ul{role? class="{role}"}>|</ul>
-item=<li>|</li>
-text=<p>|</p>
-
-[tags]
-# Quoted text.
-emphasis=<em>{1?<span class="{1}">}|{1?</span>}</em>
-strong=<strong>{1?<span class="{1}">}|{1?</span>}</strong>
-monospaced=<tt>{1?<span class="{1}">}|{1?</span>}</tt>
-singlequoted={lsquo}{1?<span class="{1}">}|{1?</span>}{rsquo}
-doublequoted={ldquo}{1?<span class="{1}">}|{1?</span>}{rdquo}
-unquoted={1?<span class="{1}">}|{1?</span>}
-superscript=<sup>{1?<span class="{1}">}|{1?</span>}</sup>
-subscript=<sub>{1?<span class="{1}">}|{1?</span>}</sub>
-
-ifdef::deprecated-quotes[]
-# Override with deprecated quote attributes.
-emphasis={role?<span class="{role}">}<em{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</em>{role?</span>}
-strong={role?<span class="{role}">}<strong{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</strong>{role?</span>}
-monospaced={role?<span class="{role}">}<tt{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</tt>{role?</span>}
-singlequoted={role?<span class="{role}">}{1,2,3?<span style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?">}{amp}#8216;|{amp}#8217;{1,2,3?</span>}{role?</span>}
-doublequoted={role?<span class="{role}">}{1,2,3?<span style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?">}{amp}#8220;|{amp}#8221;{1,2,3?</span>}{role?</span>}
-unquoted={role?<span class="{role}">}{1,2,3?<span style="{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}">}|{1,2,3?</span>}{role?</span>}
-superscript={role?<span class="{role}">}<sup{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</sup>{role?</span>}
-subscript={role?<span class="{role}">}<sub{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</sub>{role?</span>}
-endif::deprecated-quotes[]
-
-# Inline macros
-[http-inlinemacro]
-<a href="{name}:{target}">{0={name}:{target}}</a>
-[https-inlinemacro]
-<a href="{name}:{target}">{0={name}:{target}}</a>
-[ftp-inlinemacro]
-<a href="{name}:{target}">{0={name}:{target}}</a>
-[file-inlinemacro]
-<a href="{name}:{target}">{0={name}:{target}}</a>
-[irc-inlinemacro]
-<a href="{name}:{target}">{0={name}:{target}}</a>
-[mailto-inlinemacro]
-<a href="mailto:{target}">{0={target}}</a>
-[callto-inlinemacro]
-<a href="{name}:{target}">{0={target}}</a>
-[link-inlinemacro]
-<a href="{target}">{0={target}}</a>
-# anchor:id[text]
-[anchor-inlinemacro]
-<a name="{target}"></a>
-# [[id,text]]
-[anchor2-inlinemacro]
-<a name="{1}"></a>
-# [[[id]]]
-[anchor3-inlinemacro]
-<a name="{1}"></a>[{1}]
-# xref:id[text]
-[xref-inlinemacro]
-<a href="#{target}">{0=[{target}]}</a>
-# <<id,text>>
-[xref2-inlinemacro]
-<a href="#{1}">{2=[{1}]}</a>
-
-# Special word substitution.
-[emphasizedwords]
-<em>{words}</em>
-[monospacedwords]
-<tt>{words}</tt>
-[strongwords]
-<strong>{words}</strong>
-
-# Paragraph substitution.
-[paragraph]
-<p{role? class="{role}"}>{id?<a name="{id}"></a>}{title?<b>{title}</b><br>}
-|
-</p>
-
-[admonitionparagraph]
-template::[admonitionblock]
-
-# Delimited blocks.
-[passthroughblock]
-|
-
-[listingblock]
-<a name="{id}"></a>
-<p><b>{title}</b></p>
-<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"{role? class="{role}"}><tr><td>
-<pre>
-|
-</pre>
-</td></tr></table>
-
-[literalblock]
-<a name="{id}"></a>
-<p><b>{title}</b></p>
-<pre{role? class="{role}"}>
-|
-</pre>
-
-[sidebarblock]
-<a name="{id}"></a>
-<table frame="border" bgcolor="#ffffee" width="100%" cellpadding="15"{role? class="{role}"}>
-<tr><td>
-<p><em>{title}</em></p>
-|
-</td></tr></table>
-
-[openblock]
-<div{id? id="{id}"}{role? class="{role}"}>
-<p><b>{title}</b></p>
-|
-</div>
-
-[partintroblock]
-template::[openblock]
-
-[abstractblock]
-template::[quoteblock]
-
-[quoteblock]
-<a name="{id}"></a>
-<blockquote{role? class="{role}"}>
-<p><b>{title}</b></p>
-|
-<p align="right">
-<em>{citetitle}</em>{attribution?<br>}
-— {attribution}
-</p>
-</blockquote>
-
-[verseblock]
-<a name="{id}"></a>
-<blockquote{role? class="{role}"}>
-<p><b>{title}</b></p>
-# Font inheritance broken in IE6.
-<pre style="font-family: inherit;">
-|
-</pre>
-<p align="left">
-<em>{citetitle}</em>{attribution?<br>}
-— {attribution}
-</p>
-</blockquote>
-
-[exampleblock]
-<a name="{id}"></a>
-<p><b>{caption={example-caption} {counter:example-number}. }</b>{title}</p>
-<table frame="border" width="100%" cellpadding="15"{role? class="{role}"}>
-<tr><td style="border-left: 2px solid silver;">
-|
-</td></tr></table>
-
-[admonitionblock]
-<a name="{id}"></a>
-<table frame="void" cellpadding="8"{role? class="{role}"}>
-<tr valign="top"><td><p><b><u>{caption}</u></b></p></td>
-<td style="border-left: 1px solid silver;">
-<p><b>{title}</b></p>
-|
-</td></tr></table>
-
-[mathblock]
-# Here to suppress missing block warning (html4 does not include math
-# JavaScripts).
-<a name="{id}"></a>
-<p><b>{title}</b></p>
-<div{role? class="{role}"}>
-|
-</div>
-
-# Tables.
-[tabletags-default]
-bodyrow=<tr>|</tr>
-headdata=<th {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}"{autowidth-option! width="{colpcwidth}%"} valign="{valign}">|</th>
-footdata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}"{autowidth-option! width="{colpcwidth}%"} style="font-weight:bold" valign="{valign}">|</td>
-bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}"{autowidth-option! width="{colpcwidth}%"} valign="{valign}">|</td>
-paragraph=<p>|</p>
-
-[tabletags-header]
-paragraph=<p><strong>|</strong></p>
-
-[tabletags-emphasis]
-paragraph=<p><em>|</em></p>
-
-[tabletags-strong]
-paragraph=<p><strong>|</strong></p>
-
-[tabletags-monospaced]
-paragraph=<p><tt>|</tt></p>
-
-[tabletags-verse]
-bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}"{autowidth-option! width="{colpcwidth}%"} valign="{valign}"><pre style="font-family: inherit;">|</pre></td>
-paragraph=
-
-[tabletags-literal]
-bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}"{autowidth-option! width="{colpcwidth}%"} valign="{valign}"><pre><tt>|</tt></pre></td>
-paragraph=
-
-[tabletags-asciidoc]
-bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}"{autowidth-option! width="{colpcwidth}%"} valign="{valign}"><div>|</div></td>
-paragraph=
-
-[table]
-<div{align? align="{align}"}{role? class="{role}"}>
-<a name="{id}"></a>
-<table rules="{grid=all}"
-style="float:{float};"
-{autowidth-option%}width="{tablepcwidth}%"
-{autowidth-option#}{width#width="{tablepcwidth}%"}
-frame="{frame%border}"
-frame="{frame@topbot:hsides}{frame@all:border}{frame@none:void}{frame@sides:vsides}"
-cellspacing="0" cellpadding="4">
-<caption><b>{caption={table-caption} {counter:table-number}. }</b>{title}</caption>
-{headrows#}<thead>
-{headrows}
-{headrows#}</thead>
-{footrows#}<tfoot>
-{footrows}
-{footrows#}</tfoot>
-<tbody>
-{bodyrows}
-</tbody>
-</table>
-</div>
-
-#--------------------------------------------------------------------
-# Deprecated old table definitions.
-#
-
-[miscellaneous]
-# Screen width in pixels.
-pagewidth=800
-pageunits=
-
-[old_tabledef-default]
-template=old_table
-bodyrow=<tr>|</tr>
-headdata=<th align="{colalign}" width="{colwidth}{pageunits}">|</th>
-footdata=<td align="{colalign}" width="{colwidth}{pageunits}"><strong>|</strong></td>
-bodydata=<td align="{colalign}" width="{colwidth}{pageunits}" valign="top">|</td>
-
-[old_table]
-<p><b>{caption={table-caption}}</b>{title}</p>
-<a name="{id}"></a>
-<table rules="{grid=none}"
-frame="{frame%hsides}"
-frame="{frame@topbot:hsides}{frame@all:border}{frame@none:void}{frame@sides:vsides}"
-cellspacing="0" cellpadding="4">
-{headrows#}<thead>
-{headrows}
-{headrows#}</thead>
-{footrows#}<tfoot>
-{footrows}
-{footrows#}</tfoot>
-<tbody>
-{bodyrows}
-</tbody>
-</table>
-
-# End of deprecated old table definitions.
-#--------------------------------------------------------------------
-
-[floatingtitle]
-<h{level@1:2}{level@2:3}{level@3:4}{level@4:5}>{id?<a name="{id}"></a>}{title}</h{level@1:2}{level@2:3}{level@3:4}{level@4:5}>
-
-[preamble]
-# Untitled elements between header and first section title.
-<a name="preamble"></a>
-|
-
-[sect0]
-{doctype-manpage%}<hr>
-<h1>{id?<a name="{id}"></a>}{title}</h1>
-|
-
-[sect1]
-{doctype-manpage%}<hr>
-<h2{role? class="{role}"}>{id?<a name="{id}"></a>}{numbered?{sectnum} }{title}</h2>
-|
-
-[sect2]
-<h3{role? class="{role}"}>{id?<a name="{id}"></a>}{numbered?{sectnum} }{title}</h3>
-|
-
-[sect3]
-<h4{role? class="{role}"}>{id?<a name="{id}"></a>}{numbered?{sectnum} }{title}</h4>
-|
-
-[sect4]
-<h5{role? class="{role}"}>{id?<a name="{id}"></a>}{title}</h5>
-|
-
-[appendix]
-<hr>
-<h2{role? class="{role}"}>{id?<a name="{id}"></a>}{numbered?{sectnum} }{appendix-caption} {counter:appendix-number:A}: {title}</h2>
-|
-
-[footer]
-<p></p>
-<p></p>
-<hr><p><small>
-template::[footer-text]
-</small></p>
-</body>
-</html>
-
-[header-declarations]
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset={encoding}">
-<meta name="generator" content="AsciiDoc {asciidoc-version}">
-<meta name="description" content="{description}">
-<meta name="keywords" content="{keywords}">
-<title>{title}</title>
-{title%}<title>{doctitle=}</title>
-{docinfo1,docinfo2#}{include:{docdir}/docinfo.html}
-{docinfo,docinfo2#}{include:{docdir}/{docname}-docinfo.html}
-</head>
-
-#--------------------------------
-# article and book document types
-#--------------------------------
-ifndef::doctype-manpage[]
-
-[header]
-template::[header-declarations]
-<body>
-{notitle%}<h1>{doctitle}</h1>
-{doctitle#}<p>
-{doctitle#}<strong>{author}</strong><br>
-{doctitle#}<tt><<a href="mailto:{email}">{email}</a>></tt><br>
-{doctitle#}version {revnumber}{revdate?,}
-{doctitle#}{revdate}
-{doctitle#}<br>{revremark}
-{doctitle#}</p>
-
-endif::doctype-manpage[]
-
-#-------------------------
-# manpage document type
-#-------------------------
-ifdef::doctype-manpage[]
-
-[tags]
-# This is more inline with man page convention.
-emphasis=<b>|</b>
-vlistterm=<dt><b>|</b></dt>
-
-[header]
-template::[header-declarations]
-<body>
-<hr>
-<h1>
- {doctitle} Manual Page
-</h1>
-<hr>
-
-[name]
-<h2>{manname-title}</h2>
-<p>{manname} -
- {manpurpose}
-</p>
-
-[synopsis]
-template::[sect1]
-
-endif::doctype-manpage[]
+# +# html4.conf +# +# Asciidoc HTML 4.01 configuration file. +# + +[miscellaneous] +outfilesuffix=.html + +[attributes] +basebackend=html +basebackend-html= +basebackend-html4= + +[replacements2] +# Line break. +(?m)^(.*)\s\+$=\1<br> + +[replacements] +ifdef::asciidoc7compatible[] +# Superscripts. +\^(.+?)\^=<sup>\1</sup> +# Subscripts. +~(.+?)~=<sub>\1</sub> +endif::asciidoc7compatible[] + +[ruler-blockmacro] +<hr> + +[pagebreak-blockmacro] +<div style="page-break-after:always"></div> + +[pi-blockmacro] +<?{target}{0? {0}}?> + +[pi-inlinemacro] +template::[pi-blockmacro] + +[image-inlinemacro] +<a href="{link}"{role? class="{role}"}> +# src attribute must be first attribute for blogpost compatibility. +<img src="{imagesdir=}{imagesdir?/}{target}" style="border-width: 0;" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}{title? title="{title}"}> +{link#}</a> + +[image-blockmacro] +<div{align? align="{align}"}{role? class="{role}"}{float? style="float:{float};"}> +<a name="{id}"></a> +<a href="{link}"> +<img src="{imagesdir=}{imagesdir?/}{target}" style="border-width: 0;" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}> +{link#}</a> +<p><b>{caption={figure-caption} {counter:figure-number}. }</b>{title}</p> +</div> + +[unfloat-blockmacro] +<br clear="all"> + +[indexterm-inlinemacro] +# Index term. +{empty} + +[indexterm2-inlinemacro] +# Index term. +# Single entry index term that is visible in the primary text flow. +{1} + +[footnote-inlinemacro] +# footnote:[<text>]. +<br><i>[{0}]</i><br> + +[footnoteref-inlinemacro] +# footnoteref:[<id>], create reference to footnote. +{2%}<br><i><a href="#_footnote_{1}">[{1}]</a></i><br> +# footnoteref:[<id>,<text>], create footnote with ID. +{2#}<br><i><a name="_footnote_{1}">[{2}]</a></i><br> + +[callout-inlinemacro] +# Callout. +<b><{index}></b> + +# Comment line macros. +[comment-inlinemacro] +{showcomments#}<br><span style="background:yellow;">{passtext}</span><br> + +[comment-blockmacro] +{showcomments#}<p><span style="background:yellow;">{passtext}</span></p> + +[literal-inlinemacro] +# Inline literal. +<tt>{passtext}</tt> + +# List tags. +[listtags-bulleted] +list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<ul>|</ul> +item=<li>|</li> +text=<p>|</p> + +[listtags-numbered] +list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<ol type="{style@arabic:1}{style@loweralpha:a}{style@upperalpha:A}{style@lowerroman:i}{style@upperroman:I}"{start? start="{start}"}{role? class="{role}"}>|</ol> +item=<li>|</li> +text=<p>|</p> + +[listtags-labeled] +list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<dl{role? class="{role}"}>|</dl> +entry= +label= +term=<dt>{strong-option?<strong>}|{strong-option?</strong>}</dt> +item=<dd>|</dd> +text=<p>|</p> + +[listtags-horizontal] +list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<table cellpadding="4"{role? class="{role}"}>|</table> +entry=<tr valign="top">|</tr> +label=<td{labelwidth? width="{labelwidth}%"}>{strong-option?<strong>}|{strong-option?</strong>}</td> +term=|<br> +item=<td{itemwidth? width="{itemwidth}%"}>|</td> +text=<p>|</p> + +[listtags-callout] +list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<ol{role? class="{role}"}>|</ol> +item=<li>|</li> +text=<p>|</p> + +[listtags-qanda] +list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<ol{role? class="{role}"}>|</ol> +entry=<li>|</li> +label= +term=<p><em>|</em></p> +item= +text=<p>|</p> + +[listtags-glossary] +list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<dl{role? class="{role}"}>|</dl> +entry= +label= +term=<dt>|</dt> +item=<dd>|</dd> +text=<p>|</p> + +[listtags-bibliography] +list={id?<a name="{id}"></a>}{title?<p><b>{title}</b></p>}<ul{role? class="{role}"}>|</ul> +item=<li>|</li> +text=<p>|</p> + +[tags] +# Quoted text. +emphasis=<em>{1?<span class="{1}">}|{1?</span>}</em> +strong=<strong>{1?<span class="{1}">}|{1?</span>}</strong> +monospaced=<tt>{1?<span class="{1}">}|{1?</span>}</tt> +singlequoted={lsquo}{1?<span class="{1}">}|{1?</span>}{rsquo} +doublequoted={ldquo}{1?<span class="{1}">}|{1?</span>}{rdquo} +unquoted={1?<span class="{1}">}|{1?</span>} +superscript=<sup>{1?<span class="{1}">}|{1?</span>}</sup> +subscript=<sub>{1?<span class="{1}">}|{1?</span>}</sub> + +ifdef::deprecated-quotes[] +# Override with deprecated quote attributes. +emphasis={role?<span class="{role}">}<em{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</em>{role?</span>} +strong={role?<span class="{role}">}<strong{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</strong>{role?</span>} +monospaced={role?<span class="{role}">}<tt{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</tt>{role?</span>} +singlequoted={role?<span class="{role}">}{1,2,3?<span style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?">}{amp}#8216;|{amp}#8217;{1,2,3?</span>}{role?</span>} +doublequoted={role?<span class="{role}">}{1,2,3?<span style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?">}{amp}#8220;|{amp}#8221;{1,2,3?</span>}{role?</span>} +unquoted={role?<span class="{role}">}{1,2,3?<span style="{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}">}|{1,2,3?</span>}{role?</span>} +superscript={role?<span class="{role}">}<sup{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</sup>{role?</span>} +subscript={role?<span class="{role}">}<sub{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</sub>{role?</span>} +endif::deprecated-quotes[] + +# Inline macros +[http-inlinemacro] +<a href="{name}:{target}">{0={name}:{target}}</a> +[https-inlinemacro] +<a href="{name}:{target}">{0={name}:{target}}</a> +[ftp-inlinemacro] +<a href="{name}:{target}">{0={name}:{target}}</a> +[file-inlinemacro] +<a href="{name}:{target}">{0={name}:{target}}</a> +[irc-inlinemacro] +<a href="{name}:{target}">{0={name}:{target}}</a> +[mailto-inlinemacro] +<a href="mailto:{target}">{0={target}}</a> +[callto-inlinemacro] +<a href="{name}:{target}">{0={target}}</a> +[link-inlinemacro] +<a href="{target}">{0={target}}</a> +# anchor:id[text] +[anchor-inlinemacro] +<a name="{target}"></a> +# [[id,text]] +[anchor2-inlinemacro] +<a name="{1}"></a> +# [[[id]]] +[anchor3-inlinemacro] +<a name="{1}"></a>[{1}] +# xref:id[text] +[xref-inlinemacro] +<a href="#{target}">{0=[{target}]}</a> +# <<id,text>> +[xref2-inlinemacro] +<a href="#{1}">{2=[{1}]}</a> + +# Special word substitution. +[emphasizedwords] +<em>{words}</em> +[monospacedwords] +<tt>{words}</tt> +[strongwords] +<strong>{words}</strong> + +# Paragraph substitution. +[paragraph] +<p{role? class="{role}"}>{id?<a name="{id}"></a>}{title?<b>{title}</b><br>} +| +</p> + +[admonitionparagraph] +template::[admonitionblock] + +# Delimited blocks. +[passthroughblock] +| + +[listingblock] +<a name="{id}"></a> +<p><b>{title}</b></p> +<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"{role? class="{role}"}><tr><td> +<pre> +| +</pre> +</td></tr></table> + +[literalblock] +<a name="{id}"></a> +<p><b>{title}</b></p> +<pre{role? class="{role}"}> +| +</pre> + +[sidebarblock] +<a name="{id}"></a> +<table frame="border" bgcolor="#ffffee" width="100%" cellpadding="15"{role? class="{role}"}> +<tr><td> +<p><em>{title}</em></p> +| +</td></tr></table> + +[openblock] +<div{id? id="{id}"}{role? class="{role}"}> +<p><b>{title}</b></p> +| +</div> + +[partintroblock] +template::[openblock] + +[abstractblock] +template::[quoteblock] + +[quoteblock] +<a name="{id}"></a> +<blockquote{role? class="{role}"}> +<p><b>{title}</b></p> +| +<p align="right"> +<em>{citetitle}</em>{attribution?<br>} +— {attribution} +</p> +</blockquote> + +[verseblock] +<a name="{id}"></a> +<blockquote{role? class="{role}"}> +<p><b>{title}</b></p> +# Font inheritance broken in IE6. +<pre style="font-family: inherit;"> +| +</pre> +<p align="left"> +<em>{citetitle}</em>{attribution?<br>} +— {attribution} +</p> +</blockquote> + +[exampleblock] +<a name="{id}"></a> +<p><b>{caption={example-caption} {counter:example-number}. }</b>{title}</p> +<table frame="border" width="100%" cellpadding="15"{role? class="{role}"}> +<tr><td style="border-left: 2px solid silver;"> +| +</td></tr></table> + +[admonitionblock] +<a name="{id}"></a> +<table frame="void" cellpadding="8"{role? class="{role}"}> +<tr valign="top"><td><p><b><u>{caption}</u></b></p></td> +<td style="border-left: 1px solid silver;"> +<p><b>{title}</b></p> +| +</td></tr></table> + +[mathblock] +# Here to suppress missing block warning (html4 does not include math +# JavaScripts). +<a name="{id}"></a> +<p><b>{title}</b></p> +<div{role? class="{role}"}> +| +</div> + +# Tables. +[tabletags-default] +bodyrow=<tr>|</tr> +headdata=<th {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}"{autowidth-option! width="{colpcwidth}%"} valign="{valign}">|</th> +footdata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}"{autowidth-option! width="{colpcwidth}%"} style="font-weight:bold" valign="{valign}">|</td> +bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}"{autowidth-option! width="{colpcwidth}%"} valign="{valign}">|</td> +paragraph=<p>|</p> + +[tabletags-header] +paragraph=<p><strong>|</strong></p> + +[tabletags-emphasis] +paragraph=<p><em>|</em></p> + +[tabletags-strong] +paragraph=<p><strong>|</strong></p> + +[tabletags-monospaced] +paragraph=<p><tt>|</tt></p> + +[tabletags-verse] +bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}"{autowidth-option! width="{colpcwidth}%"} valign="{valign}"><pre style="font-family: inherit;">|</pre></td> +paragraph= + +[tabletags-literal] +bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}"{autowidth-option! width="{colpcwidth}%"} valign="{valign}"><pre><tt>|</tt></pre></td> +paragraph= + +[tabletags-asciidoc] +bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}"{autowidth-option! width="{colpcwidth}%"} valign="{valign}"><div>|</div></td> +paragraph= + +[table] +<div{align? align="{align}"}{role? class="{role}"}> +<a name="{id}"></a> +<table rules="{grid=all}" +style="float:{float};" +{autowidth-option%}width="{tablepcwidth}%" +{autowidth-option#}{width#width="{tablepcwidth}%"} +frame="{frame%border}" +frame="{frame@topbot:hsides}{frame@all:border}{frame@none:void}{frame@sides:vsides}" +cellspacing="0" cellpadding="4"> +<caption><b>{caption={table-caption} {counter:table-number}. }</b>{title}</caption> +{headrows#}<thead> +{headrows} +{headrows#}</thead> +{footrows#}<tfoot> +{footrows} +{footrows#}</tfoot> +<tbody> +{bodyrows} +</tbody> +</table> +</div> + +#-------------------------------------------------------------------- +# Deprecated old table definitions. +# + +[miscellaneous] +# Screen width in pixels. +pagewidth=800 +pageunits= + +[old_tabledef-default] +template=old_table +bodyrow=<tr>|</tr> +headdata=<th align="{colalign}" width="{colwidth}{pageunits}">|</th> +footdata=<td align="{colalign}" width="{colwidth}{pageunits}"><strong>|</strong></td> +bodydata=<td align="{colalign}" width="{colwidth}{pageunits}" valign="top">|</td> + +[old_table] +<p><b>{caption={table-caption}}</b>{title}</p> +<a name="{id}"></a> +<table rules="{grid=none}" +frame="{frame%hsides}" +frame="{frame@topbot:hsides}{frame@all:border}{frame@none:void}{frame@sides:vsides}" +cellspacing="0" cellpadding="4"> +{headrows#}<thead> +{headrows} +{headrows#}</thead> +{footrows#}<tfoot> +{footrows} +{footrows#}</tfoot> +<tbody> +{bodyrows} +</tbody> +</table> + +# End of deprecated old table definitions. +#-------------------------------------------------------------------- + +[floatingtitle] +<h{level@1:2}{level@2:3}{level@3:4}{level@4:5}>{id?<a name="{id}"></a>}{title}</h{level@1:2}{level@2:3}{level@3:4}{level@4:5}> + +[preamble] +# Untitled elements between header and first section title. +<a name="preamble"></a> +| + +[sect0] +{doctype-manpage%}<hr> +<h1>{id?<a name="{id}"></a>}{title}</h1> +| + +[sect1] +{doctype-manpage%}<hr> +<h2{role? class="{role}"}>{id?<a name="{id}"></a>}{numbered?{sectnum} }{title}</h2> +| + +[sect2] +<h3{role? class="{role}"}>{id?<a name="{id}"></a>}{numbered?{sectnum} }{title}</h3> +| + +[sect3] +<h4{role? class="{role}"}>{id?<a name="{id}"></a>}{numbered?{sectnum} }{title}</h4> +| + +[sect4] +<h5{role? class="{role}"}>{id?<a name="{id}"></a>}{title}</h5> +| + +[appendix] +<hr> +<h2{role? class="{role}"}>{id?<a name="{id}"></a>}{numbered?{sectnum} }{appendix-caption} {counter:appendix-number:A}: {title}</h2> +| + +[footer] +<p></p> +<p></p> +<hr><p><small> +template::[footer-text] +</small></p> +</body> +</html> + +[header-declarations] +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset={encoding}"> +<meta name="generator" content="AsciiDoc {asciidoc-version}"> +<meta name="description" content="{description}"> +<meta name="keywords" content="{keywords}"> +<title>{title}</title> +{title%}<title>{doctitle=}</title> +{docinfo1,docinfo2#}{include:{docdir}/docinfo.html} +{docinfo,docinfo2#}{include:{docdir}/{docname}-docinfo.html} +</head> + +#-------------------------------- +# article and book document types +#-------------------------------- +ifndef::doctype-manpage[] + +[header] +template::[header-declarations] +<body> +{notitle%}<h1>{doctitle}</h1> +{doctitle#}<p> +{doctitle#}<strong>{author}</strong><br> +{doctitle#}<tt><<a href="mailto:{email}">{email}</a>></tt><br> +{doctitle#}version {revnumber}{revdate?,} +{doctitle#}{revdate} +{doctitle#}<br>{revremark} +{doctitle#}</p> + +endif::doctype-manpage[] + +#------------------------- +# manpage document type +#------------------------- +ifdef::doctype-manpage[] + +[tags] +# This is more inline with man page convention. +emphasis=<b>|</b> +vlistterm=<dt><b>|</b></dt> + +[header] +template::[header-declarations] +<body> +<hr> +<h1> + {doctitle} Manual Page +</h1> +<hr> + +[name] +<h2>{manname-title}</h2> +<p>{manname} - + {manpurpose} +</p> + +[synopsis] +template::[sect1] + +endif::doctype-manpage[] diff --git a/lang-nl.conf b/lang-nl.conf index 5feb814..5d582f2 100644 --- a/lang-nl.conf +++ b/lang-nl.conf @@ -1,57 +1,57 @@ -#
-# AsciiDoc Dutch language configuration file.
-# Originally written by Dag Wieërs
-#
-
-[attributes]
-# Left and right single and double quote characters.
-lsquo=‚
-rsquo=‘
-ldquo=„
-rdquo=“
-
-# Captions, used by (X)HTML backends.
-# Captions on RHS are displayed in outputs.
-ifdef::basebackend-html[]
-
-caution-caption=Let op
-important-caption=Belangrijk
-note-caption=Opmerking
-tip-caption=Tip
-warning-caption=Waarschuwing
-figure-caption=Figuur
-table-caption=Tabel
-example-caption=Voorbeeld
-toc-title=Inhoudsopgave
-appendix-caption=Bijlage
-# Man page NAME section title.
-manname-title=NAME
-
-[footer-text]
-Versie {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>}
-Laatst bijgewerkt {docdate} {doctime}
-
-endif::basebackend-html[]
-
-
-[specialsections]
-# DocBook special sections.
-# The regular expression on LHS is matched against source titles.
-ifdef::basebackend-docbook[]
-
-ifdef::doctype-article[]
-^Samenvatting$=abstract
-endif::doctype-article[]
-
-ifdef::doctype-book[]
-^Colofon$=colophon
-^Opdracht$=dedication
-^Voorwoord$=preface
-endif::doctype-book[]
-
-^Register$=index
-^Literatuurlijst$=bibliography
-^Woordenlijst$=glossary
-^Bijlage [A-Z][:.](?P<title>.*)$=appendix
-
-endif::basebackend-docbook[]
+# +# AsciiDoc Dutch language configuration file. +# Originally written by Dag Wieërs +# + +[attributes] +# Left and right single and double quote characters. +lsquo=‚ +rsquo=‘ +ldquo=„ +rdquo=“ + +# Captions, used by (X)HTML backends. +# Captions on RHS are displayed in outputs. +ifdef::basebackend-html[] + +caution-caption=Let op +important-caption=Belangrijk +note-caption=Opmerking +tip-caption=Tip +warning-caption=Waarschuwing +figure-caption=Figuur +table-caption=Tabel +example-caption=Voorbeeld +toc-title=Inhoudsopgave +appendix-caption=Bijlage +# Man page NAME section title. +manname-title=NAME + +[footer-text] +Versie {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>} +Laatst bijgewerkt {docdate} {doctime} + +endif::basebackend-html[] + + +[specialsections] +# DocBook special sections. +# The regular expression on LHS is matched against source titles. +ifdef::basebackend-docbook[] + +ifdef::doctype-article[] +^Samenvatting$=abstract +endif::doctype-article[] + +ifdef::doctype-book[] +^Colofon$=colophon +^Opdracht$=dedication +^Voorwoord$=preface +endif::doctype-book[] + +^Register$=index +^Literatuurlijst$=bibliography +^Woordenlijst$=glossary +^Bijlage [A-Z][:.](?P<title>.*)$=appendix + +endif::basebackend-docbook[] diff --git a/stylesheets/docbook-xsl.css b/stylesheets/docbook-xsl.css index bcc3524..69a597e 100644 --- a/stylesheets/docbook-xsl.css +++ b/stylesheets/docbook-xsl.css @@ -1,323 +1,323 @@ -/*
- CSS stylesheet for XHTML produced by DocBook XSL stylesheets.
- Tested with XSL stylesheets 1.61.2, 1.67.2
-*/
-
-span.strong {
- font-weight: bold;
-}
-
-body blockquote {
- margin-top: .75em;
- line-height: 1.5;
- margin-bottom: .75em;
-}
-
-html body {
- margin: 1em 5% 1em 5%;
- line-height: 1.2;
-}
-
-body div {
- margin: 0;
-}
-
-h1, h2, h3, h4, h5, h6
-{
- color: #527bbd;
- font-family: tahoma, verdana, sans-serif;
-}
-
-div.toc p:first-child,
-div.list-of-figures p:first-child,
-div.list-of-tables p:first-child,
-div.list-of-examples p:first-child,
-div.example p.title,
-div.sidebar p.title
-{
- font-weight: bold;
- color: #527bbd;
- font-family: tahoma, verdana, sans-serif;
- margin-bottom: 0.2em;
-}
-
-body h1 {
- margin: .0em 0 0 -4%;
- line-height: 1.3;
- border-bottom: 2px solid silver;
-}
-
-body h2 {
- margin: 0.5em 0 0 -4%;
- line-height: 1.3;
- border-bottom: 2px solid silver;
-}
-
-body h3 {
- margin: .8em 0 0 -3%;
- line-height: 1.3;
-}
-
-body h4 {
- margin: .8em 0 0 -3%;
- line-height: 1.3;
-}
-
-body h5 {
- margin: .8em 0 0 -2%;
- line-height: 1.3;
-}
-
-body h6 {
- margin: .8em 0 0 -1%;
- line-height: 1.3;
-}
-
-body hr {
- border: none; /* Broken on IE6 */
-}
-div.footnotes hr {
- border: 1px solid silver;
-}
-
-div.navheader th, div.navheader td, div.navfooter td {
- font-family: sans-serif;
- font-size: 0.9em;
- font-weight: bold;
- color: #527bbd;
-}
-div.navheader img, div.navfooter img {
- border-style: none;
-}
-div.navheader a, div.navfooter a {
- font-weight: normal;
-}
-div.navfooter hr {
- border: 1px solid silver;
-}
-
-body td {
- line-height: 1.2
-}
-
-body th {
- line-height: 1.2;
-}
-
-ol {
- line-height: 1.2;
-}
-
-ul, body dir, body menu {
- line-height: 1.2;
-}
-
-html {
- margin: 0;
- padding: 0;
-}
-
-body h1, body h2, body h3, body h4, body h5, body h6 {
- margin-left: 0
-}
-
-body pre {
- margin: 0.5em 10% 0.5em 1em;
- line-height: 1.0;
- color: navy;
-}
-
-tt.literal, code.literal {
- color: navy;
-}
-
-.programlisting, .screen {
- border: 1px solid silver;
- background: #f4f4f4;
- margin: 0.5em 10% 0.5em 0;
- padding: 0.5em 1em;
-}
-
-div.sidebar {
- background: #ffffee;
- margin: 1.0em 10% 0.5em 0;
- padding: 0.5em 1em;
- border: 1px solid silver;
-}
-div.sidebar * { padding: 0; }
-div.sidebar div { margin: 0; }
-div.sidebar p.title {
- margin-top: 0.5em;
- margin-bottom: 0.2em;
-}
-
-div.bibliomixed {
- margin: 0.5em 5% 0.5em 1em;
-}
-
-div.glossary dt {
- font-weight: bold;
-}
-div.glossary dd p {
- margin-top: 0.2em;
-}
-
-dl {
- margin: .8em 0;
- line-height: 1.2;
-}
-
-dt {
- margin-top: 0.5em;
-}
-
-dt span.term {
- font-style: normal;
- color: navy;
-}
-
-div.variablelist dd p {
- margin-top: 0;
-}
-
-div.itemizedlist li, div.orderedlist li {
- margin-left: -0.8em;
- margin-top: 0.5em;
-}
-
-ul, ol {
- list-style-position: outside;
-}
-
-div.sidebar ul, div.sidebar ol {
- margin-left: 2.8em;
-}
-
-div.itemizedlist p.title,
-div.orderedlist p.title,
-div.variablelist p.title
-{
- margin-bottom: -0.8em;
-}
-
-div.revhistory table {
- border-collapse: collapse;
- border: none;
-}
-div.revhistory th {
- border: none;
- color: #527bbd;
- font-family: tahoma, verdana, sans-serif;
-}
-div.revhistory td {
- border: 1px solid silver;
-}
-
-/* Keep TOC and index lines close together. */
-div.toc dl, div.toc dt,
-div.list-of-figures dl, div.list-of-figures dt,
-div.list-of-tables dl, div.list-of-tables dt,
-div.indexdiv dl, div.indexdiv dt
-{
- line-height: normal;
- margin-top: 0;
- margin-bottom: 0;
-}
-
-/*
- Table styling does not work because of overriding attributes in
- generated HTML.
-*/
-div.table table,
-div.informaltable table
-{
- margin-left: 0;
- margin-right: 5%;
- margin-bottom: 0.8em;
-}
-div.informaltable table
-{
- margin-top: 0.4em
-}
-div.table thead,
-div.table tfoot,
-div.table tbody,
-div.informaltable thead,
-div.informaltable tfoot,
-div.informaltable tbody
-{
- /* No effect in IE6. */
- border-top: 3px solid #527bbd;
- border-bottom: 3px solid #527bbd;
-}
-div.table thead, div.table tfoot,
-div.informaltable thead, div.informaltable tfoot
-{
- font-weight: bold;
-}
-
-div.mediaobject img {
- margin-bottom: 0.8em;
-}
-div.figure p.title,
-div.table p.title
-{
- margin-top: 1em;
- margin-bottom: 0.4em;
-}
-
-div.calloutlist p
-{
- margin-top: 0em;
- margin-bottom: 0.4em;
-}
-
-a img {
- border-style: none;
-}
-
-@media print {
- div.navheader, div.navfooter { display: none; }
-}
-
-span.aqua { color: aqua; }
-span.black { color: black; }
-span.blue { color: blue; }
-span.fuchsia { color: fuchsia; }
-span.gray { color: gray; }
-span.green { color: green; }
-span.lime { color: lime; }
-span.maroon { color: maroon; }
-span.navy { color: navy; }
-span.olive { color: olive; }
-span.purple { color: purple; }
-span.red { color: red; }
-span.silver { color: silver; }
-span.teal { color: teal; }
-span.white { color: white; }
-span.yellow { color: yellow; }
-
-span.aqua-background { background: aqua; }
-span.black-background { background: black; }
-span.blue-background { background: blue; }
-span.fuchsia-background { background: fuchsia; }
-span.gray-background { background: gray; }
-span.green-background { background: green; }
-span.lime-background { background: lime; }
-span.maroon-background { background: maroon; }
-span.navy-background { background: navy; }
-span.olive-background { background: olive; }
-span.purple-background { background: purple; }
-span.red-background { background: red; }
-span.silver-background { background: silver; }
-span.teal-background { background: teal; }
-span.white-background { background: white; }
-span.yellow-background { background: yellow; }
-
-span.big { font-size: 2em; }
-span.small { font-size: 0.6em; }
-
-span.underline { text-decoration: underline; }
-span.overline { text-decoration: overline; }
-span.line-through { text-decoration: line-through; }
-span.blink { text-decoration: blink; }
+/* + CSS stylesheet for XHTML produced by DocBook XSL stylesheets. + Tested with XSL stylesheets 1.61.2, 1.67.2 +*/ + +span.strong { + font-weight: bold; +} + +body blockquote { + margin-top: .75em; + line-height: 1.5; + margin-bottom: .75em; +} + +html body { + margin: 1em 5% 1em 5%; + line-height: 1.2; +} + +body div { + margin: 0; +} + +h1, h2, h3, h4, h5, h6 +{ + color: #527bbd; + font-family: tahoma, verdana, sans-serif; +} + +div.toc p:first-child, +div.list-of-figures p:first-child, +div.list-of-tables p:first-child, +div.list-of-examples p:first-child, +div.example p.title, +div.sidebar p.title +{ + font-weight: bold; + color: #527bbd; + font-family: tahoma, verdana, sans-serif; + margin-bottom: 0.2em; +} + +body h1 { + margin: .0em 0 0 -4%; + line-height: 1.3; + border-bottom: 2px solid silver; +} + +body h2 { + margin: 0.5em 0 0 -4%; + line-height: 1.3; + border-bottom: 2px solid silver; +} + +body h3 { + margin: .8em 0 0 -3%; + line-height: 1.3; +} + +body h4 { + margin: .8em 0 0 -3%; + line-height: 1.3; +} + +body h5 { + margin: .8em 0 0 -2%; + line-height: 1.3; +} + +body h6 { + margin: .8em 0 0 -1%; + line-height: 1.3; +} + +body hr { + border: none; /* Broken on IE6 */ +} +div.footnotes hr { + border: 1px solid silver; +} + +div.navheader th, div.navheader td, div.navfooter td { + font-family: sans-serif; + font-size: 0.9em; + font-weight: bold; + color: #527bbd; +} +div.navheader img, div.navfooter img { + border-style: none; +} +div.navheader a, div.navfooter a { + font-weight: normal; +} +div.navfooter hr { + border: 1px solid silver; +} + +body td { + line-height: 1.2 +} + +body th { + line-height: 1.2; +} + +ol { + line-height: 1.2; +} + +ul, body dir, body menu { + line-height: 1.2; +} + +html { + margin: 0; + padding: 0; +} + +body h1, body h2, body h3, body h4, body h5, body h6 { + margin-left: 0 +} + +body pre { + margin: 0.5em 10% 0.5em 1em; + line-height: 1.0; + color: navy; +} + +tt.literal, code.literal { + color: navy; +} + +.programlisting, .screen { + border: 1px solid silver; + background: #f4f4f4; + margin: 0.5em 10% 0.5em 0; + padding: 0.5em 1em; +} + +div.sidebar { + background: #ffffee; + margin: 1.0em 10% 0.5em 0; + padding: 0.5em 1em; + border: 1px solid silver; +} +div.sidebar * { padding: 0; } +div.sidebar div { margin: 0; } +div.sidebar p.title { + margin-top: 0.5em; + margin-bottom: 0.2em; +} + +div.bibliomixed { + margin: 0.5em 5% 0.5em 1em; +} + +div.glossary dt { + font-weight: bold; +} +div.glossary dd p { + margin-top: 0.2em; +} + +dl { + margin: .8em 0; + line-height: 1.2; +} + +dt { + margin-top: 0.5em; +} + +dt span.term { + font-style: normal; + color: navy; +} + +div.variablelist dd p { + margin-top: 0; +} + +div.itemizedlist li, div.orderedlist li { + margin-left: -0.8em; + margin-top: 0.5em; +} + +ul, ol { + list-style-position: outside; +} + +div.sidebar ul, div.sidebar ol { + margin-left: 2.8em; +} + +div.itemizedlist p.title, +div.orderedlist p.title, +div.variablelist p.title +{ + margin-bottom: -0.8em; +} + +div.revhistory table { + border-collapse: collapse; + border: none; +} +div.revhistory th { + border: none; + color: #527bbd; + font-family: tahoma, verdana, sans-serif; +} +div.revhistory td { + border: 1px solid silver; +} + +/* Keep TOC and index lines close together. */ +div.toc dl, div.toc dt, +div.list-of-figures dl, div.list-of-figures dt, +div.list-of-tables dl, div.list-of-tables dt, +div.indexdiv dl, div.indexdiv dt +{ + line-height: normal; + margin-top: 0; + margin-bottom: 0; +} + +/* + Table styling does not work because of overriding attributes in + generated HTML. +*/ +div.table table, +div.informaltable table +{ + margin-left: 0; + margin-right: 5%; + margin-bottom: 0.8em; +} +div.informaltable table +{ + margin-top: 0.4em +} +div.table thead, +div.table tfoot, +div.table tbody, +div.informaltable thead, +div.informaltable tfoot, +div.informaltable tbody +{ + /* No effect in IE6. */ + border-top: 3px solid #527bbd; + border-bottom: 3px solid #527bbd; +} +div.table thead, div.table tfoot, +div.informaltable thead, div.informaltable tfoot +{ + font-weight: bold; +} + +div.mediaobject img { + margin-bottom: 0.8em; +} +div.figure p.title, +div.table p.title +{ + margin-top: 1em; + margin-bottom: 0.4em; +} + +div.calloutlist p +{ + margin-top: 0em; + margin-bottom: 0.4em; +} + +a img { + border-style: none; +} + +@media print { + div.navheader, div.navfooter { display: none; } +} + +span.aqua { color: aqua; } +span.black { color: black; } +span.blue { color: blue; } +span.fuchsia { color: fuchsia; } +span.gray { color: gray; } +span.green { color: green; } +span.lime { color: lime; } +span.maroon { color: maroon; } +span.navy { color: navy; } +span.olive { color: olive; } +span.purple { color: purple; } +span.red { color: red; } +span.silver { color: silver; } +span.teal { color: teal; } +span.white { color: white; } +span.yellow { color: yellow; } + +span.aqua-background { background: aqua; } +span.black-background { background: black; } +span.blue-background { background: blue; } +span.fuchsia-background { background: fuchsia; } +span.gray-background { background: gray; } +span.green-background { background: green; } +span.lime-background { background: lime; } +span.maroon-background { background: maroon; } +span.navy-background { background: navy; } +span.olive-background { background: olive; } +span.purple-background { background: purple; } +span.red-background { background: red; } +span.silver-background { background: silver; } +span.teal-background { background: teal; } +span.white-background { background: white; } +span.yellow-background { background: yellow; } + +span.big { font-size: 2em; } +span.small { font-size: 0.6em; } + +span.underline { text-decoration: underline; } +span.overline { text-decoration: overline; } +span.line-through { text-decoration: line-through; } +span.blink { text-decoration: blink; } diff --git a/tests/data/lang-nl-test.txt b/tests/data/lang-nl-test.txt index fa4b4e7..7e6e823 100644 --- a/tests/data/lang-nl-test.txt +++ b/tests/data/lang-nl-test.txt @@ -1,94 +1,94 @@ -// Test for lang-nl.conf language file.
-:lang: nl
-
-= Languages Test
-:revnumber: v1.0
-:revdate: 2003-12-21
-
-ifdef::doctype-article[]
-== Samenvatting
-Bijzonder 'abstract' sectie.
-
-endif::doctype-article[]
-
-
-ifdef::doctype-book[]
-== Opdracht
-Bijzonder 'dedication' sectie.
-
-
-== Voorwoord
-Bijzonder 'preface' sectie.
-
-
-== Colofon
-Bijzonder 'colophon' sectie.
-
-endif::doctype-book[]
-
-
-== Het Eerste Hoofdstuk
-=== Vermaningen
-Vertaal ze niet in the broncode -- ze worden vanzelf vertaald in het
-output bestand
-
-NOTE: Lorum ipsum.
-
-TIP: Lorum ipsum.
-
-WARNING: Lorum ipsum.
-
-CAUTION: Lorum ipsum.
-
-IMPORTANT: Lorum ipsum.
-
-.Tiger
-image::../../images/tiger.png[Tiger image]
-
-Gevolgd door een voorbeeld tabel:
-
-.Table
-[width="60%",options="header"]
-|==============================================
-| Optie | Beschrijving
-| -a 'USER GROUP' | Voeg 'USER' toe aan 'GROUP'.
-| -R 'GROUP' | Schakel toegang uit tot 'GROUP'.
-|==============================================
-
-En nu iets totaal anders: ((apen)), leeuwen en tijgers.
-
-
-== Bijlage A: Voorbeeld Bijlage
-Bijzonder 'appendix' sectie.
-
-
-== Literatuurlijst
-Bijzonder 'bibliography' sectie.
-
-[bibliography]
-- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix
- Programming'. Addison-Wesley. ISBN 0-13-142901-9.
-- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner.
- 'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999.
- ISBN 1-56592-580-7.
-
-
-== Woordenlijst
-Bijzonder 'glossary' sectie.
-
-[glossary]
-Een woordenlijst term::
- De bijhorende (ingesprongen) definitie.
-
-Een tweede term::
- De bijhorende (ingesprongen) definitie.
-
-
-ifdef::basebackend-docbook[]
-== Register
-////////////////////////////////////////////////////////////////
-Bijzonder 'index' sectie.
-Het register wordt normaal leeg gehouden, de inhoud wordt
-automatisch gegenereerd door de DocBook hulpmiddelen.
-////////////////////////////////////////////////////////////////
-endif::basebackend-docbook[]
+// Test for lang-nl.conf language file. +:lang: nl + += Languages Test +:revnumber: v1.0 +:revdate: 2003-12-21 + +ifdef::doctype-article[] +== Samenvatting +Bijzonder 'abstract' sectie. + +endif::doctype-article[] + + +ifdef::doctype-book[] +== Opdracht +Bijzonder 'dedication' sectie. + + +== Voorwoord +Bijzonder 'preface' sectie. + + +== Colofon +Bijzonder 'colophon' sectie. + +endif::doctype-book[] + + +== Het Eerste Hoofdstuk +=== Vermaningen +Vertaal ze niet in the broncode -- ze worden vanzelf vertaald in het +output bestand + +NOTE: Lorum ipsum. + +TIP: Lorum ipsum. + +WARNING: Lorum ipsum. + +CAUTION: Lorum ipsum. + +IMPORTANT: Lorum ipsum. + +.Tiger +image::../../images/tiger.png[Tiger image] + +Gevolgd door een voorbeeld tabel: + +.Table +[width="60%",options="header"] +|============================================== +| Optie | Beschrijving +| -a 'USER GROUP' | Voeg 'USER' toe aan 'GROUP'. +| -R 'GROUP' | Schakel toegang uit tot 'GROUP'. +|============================================== + +En nu iets totaal anders: ((apen)), leeuwen en tijgers. + + +== Bijlage A: Voorbeeld Bijlage +Bijzonder 'appendix' sectie. + + +== Literatuurlijst +Bijzonder 'bibliography' sectie. + +[bibliography] +- [[[taoup]]] Eric Steven Raymond. 'The Art of Unix + Programming'. Addison-Wesley. ISBN 0-13-142901-9. +- [[[walsh-muellner]]] Norman Walsh & Leonard Muellner. + 'DocBook - The Definitive Guide'. O'Reilly & Associates. 1999. + ISBN 1-56592-580-7. + + +== Woordenlijst +Bijzonder 'glossary' sectie. + +[glossary] +Een woordenlijst term:: + De bijhorende (ingesprongen) definitie. + +Een tweede term:: + De bijhorende (ingesprongen) definitie. + + +ifdef::basebackend-docbook[] +== Register +//////////////////////////////////////////////////////////////// +Bijzonder 'index' sectie. +Het register wordt normaal leeg gehouden, de inhoud wordt +automatisch gegenereerd door de DocBook hulpmiddelen. +//////////////////////////////////////////////////////////////// +endif::basebackend-docbook[] diff --git a/tests/data/utf8-bom-test.txt b/tests/data/utf8-bom-test.txt index 2b76fd0..03aae22 100644 --- a/tests/data/utf8-bom-test.txt +++ b/tests/data/utf8-bom-test.txt @@ -1,9 +1,9 @@ -UTF-8 BOM Test
-==============
-
-Include file with UTF-8 BOM:
-
-:leveloffset: 1
-include::{docfile}[depth=1]
-
-Lorum ipsum...
+UTF-8 BOM Test +============== + +Include file with UTF-8 BOM: + +:leveloffset: 1 +include::{docfile}[depth=1] + +Lorum ipsum... @@ -1,16 +1,16 @@ -# text.conf
-# Used by the AsciiDoc a2x(1) toolchain wrapper utility.
-# Filters to add leading blank line and margin indent to verbatim
-# block elements so lynx(1) generated text output looks nicer.
-
-[paradef-default]
-verse-style=template="verseparagraph",filter="echo; echo; sed 's/^/ /'"
-
-[paradef-literal]
-filter=echo; echo; sed 's/^/ /'
-
-[blockdef-listing]
-filter=echo; sed 's/^/ /'
-
-[blockdef-literal]
-filter=echo; sed 's/^/ /'
+# text.conf +# Used by the AsciiDoc a2x(1) toolchain wrapper utility. +# Filters to add leading blank line and margin indent to verbatim +# block elements so lynx(1) generated text output looks nicer. + +[paradef-default] +verse-style=template="verseparagraph",filter="echo; echo; sed 's/^/ /'" + +[paradef-literal] +filter=echo; echo; sed 's/^/ /' + +[blockdef-listing] +filter=echo; sed 's/^/ /' + +[blockdef-literal] +filter=echo; sed 's/^/ /' diff --git a/xhtml11-quirks.conf b/xhtml11-quirks.conf index 22eeb3c..bbdd3f0 100644 --- a/xhtml11-quirks.conf +++ b/xhtml11-quirks.conf @@ -1,61 +1,61 @@ -#
-# xhtml11-quirks.conf
-#
-# Workarounds for IE6's broken # and incomplete CSS2.
-#
-
-[image-blockmacro]
-<div class="imageblock{style? {style}}{role? {role}}"{id? id="{id}"}{align? style="text-align:{align};"}{float? style="float:{float};"}>
-<div class="content">
-<a class="image" href="{link}">
-{data-uri%}<img src="{imagesdir=}{imagesdir?/}{target}" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"} />
-{data-uri#}<img alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"} src="data:image/{eval:os.path.splitext('{target}')[1][1:]};base64,
-{data-uri#}{sys:python -uc "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join("{indir={outdir}}","{imagesdir=}","{target}")}"}" />
-{link#}</a>
-</div>
-<div class="image-title">{caption={figure-caption} {counter:figure-number}: }{title}</div>
-</div>
-
-[sidebarblock]
-<div class="sidebarblock{role? {role}}"{id? id="{id}"}>
-<div class="sidebar-content">
-<div class="sidebar-title">{title}</div>
-|
-</div></div>
-
-[quoteblock]
-<div class="quoteblock{role? {role}}"{id? id="{id}"}>
-<div class="title">{title}</div>
-<div class="quoteblock-content">
-|
-</div>
-<div class="quoteblock-attribution">
-<em>{citetitle}</em><br />
-— {attribution}
-</div></div>
-
-[verseblock]
-<div class="verseblock{role? {role}}"{id? id="{id}"}>
-<div class="title">{title}</div>
-<pre class="verseblock-content">
-|
-</pre>
-<div class="verseblock-attribution">
-<em>{citetitle}</em><br />
-— {attribution}
-</div></div>
-
-[exampleblock]
-<div class="exampleblock{role? {role}}"{id? id="{id}"}>
-<div class="title">{caption={example-caption} {counter:example-number}: }{title}</div>
-<div class="exampleblock-content">
-|
-</div></div>
-
-[sect2]
-<div class="sect2{style? {style}}{role? {role}}">
-# The <div> is because the IE6 adjacent-sibling CSS selector is broken.
-<h3{id? id="{id}"}>{numbered?{sectnum} }{title}</h3><div style="clear:left"></div>
-|
-</div>
-
+# +# xhtml11-quirks.conf +# +# Workarounds for IE6's broken # and incomplete CSS2. +# + +[image-blockmacro] +<div class="imageblock{style? {style}}{role? {role}}"{id? id="{id}"}{align? style="text-align:{align};"}{float? style="float:{float};"}> +<div class="content"> +<a class="image" href="{link}"> +{data-uri%}<img src="{imagesdir=}{imagesdir?/}{target}" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"} /> +{data-uri#}<img alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"} src="data:image/{eval:os.path.splitext('{target}')[1][1:]};base64, +{data-uri#}{sys:python -uc "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join("{indir={outdir}}","{imagesdir=}","{target}")}"}" /> +{link#}</a> +</div> +<div class="image-title">{caption={figure-caption} {counter:figure-number}: }{title}</div> +</div> + +[sidebarblock] +<div class="sidebarblock{role? {role}}"{id? id="{id}"}> +<div class="sidebar-content"> +<div class="sidebar-title">{title}</div> +| +</div></div> + +[quoteblock] +<div class="quoteblock{role? {role}}"{id? id="{id}"}> +<div class="title">{title}</div> +<div class="quoteblock-content"> +| +</div> +<div class="quoteblock-attribution"> +<em>{citetitle}</em><br /> +— {attribution} +</div></div> + +[verseblock] +<div class="verseblock{role? {role}}"{id? id="{id}"}> +<div class="title">{title}</div> +<pre class="verseblock-content"> +| +</pre> +<div class="verseblock-attribution"> +<em>{citetitle}</em><br /> +— {attribution} +</div></div> + +[exampleblock] +<div class="exampleblock{role? {role}}"{id? id="{id}"}> +<div class="title">{caption={example-caption} {counter:example-number}: }{title}</div> +<div class="exampleblock-content"> +| +</div></div> + +[sect2] +<div class="sect2{style? {style}}{role? {role}}"> +# The <div> is because the IE6 adjacent-sibling CSS selector is broken. +<h3{id? id="{id}"}>{numbered?{sectnum} }{title}</h3><div style="clear:left"></div> +| +</div> + diff --git a/xhtml11.conf b/xhtml11.conf index 558fb65..c92ca56 100644 --- a/xhtml11.conf +++ b/xhtml11.conf @@ -1,680 +1,680 @@ -#
-# xhtml11.conf
-#
-# Asciidoc configuration file.
-# xhtml11 backend, generates XHTML 1.1 conformant markup.
-#
-
-[miscellaneous]
-outfilesuffix=.html
-
-[attributes]
-basebackend=html
-basebackend-html=
-basebackend-xhtml11=
-
-[replacements2]
-# Line break.
-(?m)^(.*)\s\+$=\1<br />
-
-[replacements]
-ifdef::asciidoc7compatible[]
-# Superscripts.
-\^(.+?)\^=<sup>\1</sup>
-# Subscripts.
-~(.+?)~=<sub>\1</sub>
-endif::asciidoc7compatible[]
-
-[ruler-blockmacro]
-<hr />
-
-[pagebreak-blockmacro]
-<div style="page-break-after:always"></div>
-
-[blockdef-pass]
-asciimath-style=template="asciimathblock",subs=[]
-latexmath-style=template="latexmathblock",subs=[]
-
-[macros]
-# math macros.
-# Special characters are escaped in HTML math markup.
-(?su)[\\]?(?P<name>asciimath|latexmath):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[specialcharacters]
-(?u)^(?P<name>asciimath|latexmath)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=#[specialcharacters]
-
-[asciimath-inlinemacro]
-`{passtext}`
-
-[asciimath-blockmacro]
-<div class="mathblock{role? {role}}"{id? id="{id}"}>
-<div class="content">
-<div class="title">{title}</div>
-`{passtext}`
-</div></div>
-
-[asciimathblock]
-<div class="mathblock{role? {role}}"{id? id="{id}"}>
-<div class="content">
-<div class="title">{title}</div>
-`|`
-</div></div>
-
-[latexmath-inlinemacro]
-{passtext}
-
-[latexmath-blockmacro]
-<div class="mathblock{role? {role}}"{id? id="{id}"}>
-<div class="content">
-<div class="title">{title}</div>
-{passtext}
-</div></div>
-
-[latexmathblock]
-<div class="mathblock{role? {role}}"{id? id="{id}"}>
-<div class="content">
-<div class="title">{title}</div>
-|
-</div></div>
-
-[image-inlinemacro]
-<span class="image{role? {role}}">
-<a class="image" href="{link}">
-{data-uri%}<img src="{imagesdir=}{imagesdir?/}{target}" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}{title? title="{title}"} />
-{data-uri#}<img alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}{title? title="{title}"} src="data:image/{eval:os.path.splitext('{target}')[1][1:]};base64,
-{data-uri#}{sys3:python -uc "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join("{indir={outdir}}","{imagesdir=}","{target}")}"}" />
-{link#}</a>
-</span>
-
-[image-blockmacro]
-<div class="imageblock{style? {style}}{role? {role}}"{id? id="{id}"}{align? style="text-align:{align};"}{float? style="float:{float};"}>
-<div class="content">
-<a class="image" href="{link}">
-{data-uri%}<img src="{imagesdir=}{imagesdir?/}{target}" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"} />
-{data-uri#}<img alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"} src="data:image/{eval:os.path.splitext('{target}')[1][1:]};base64,
-{data-uri#}{sys:python -uc "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join("{indir={outdir}}","{imagesdir=}","{target}")}"}" />
-{link#}</a>
-</div>
-<div class="title">{caption={figure-caption} {counter:figure-number}. }{title}</div>
-</div>
-
-[unfloat-blockmacro]
-<div style="clear:both;"></div>
-
-[indexterm-inlinemacro]
-# Index term.
-{empty}
-
-[indexterm2-inlinemacro]
-# Index term.
-# Single entry index term that is visible in the primary text flow.
-{1}
-
-[footnote-inlinemacro]
-# footnote:[<text>].
-<span class="footnote"><br />[{0}]<br /></span>
-
-[footnoteref-inlinemacro]
-# footnoteref:[<id>], create reference to footnote.
-{2%}<span class="footnoteref"><br /><a href="#_footnote_{1}">[{1}]</a><br /></span>
-# footnoteref:[<id>,<text>], create footnote with ID.
-{2#}<span class="footnote" id="_footnote_{1}"><br />[{2}]<br /></span>
-
-[callout-inlinemacro]
-ifndef::icons[]
-<b><{index}></b>
-endif::icons[]
-ifdef::icons[]
-ifndef::data-uri[]
-<img src="{icon={iconsdir}/callouts/{index}.png}" alt="{index}" />
-endif::data-uri[]
-ifdef::data-uri[]
-<img alt="{index}" src="data:image/png;base64,
-{sys:python -uc "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join("{indir={outdir}}","{icon={iconsdir}/callouts/{index}.png}")}"}" />
-endif::data-uri[]
-endif::icons[]
-
-# Comment line macros.
-[comment-inlinemacro]
-{showcomments#}<br /><span class="comment">{passtext}</span><br />
-
-[comment-blockmacro]
-{showcomments#}<p><span class="comment">{passtext}</span></p>
-
-[literal-inlinemacro]
-# Inline literal.
-<tt>{passtext}</tt>
-
-# List tags.
-[listtags-bulleted]
-list=<div class="ulist{style? {style}}{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ul>|</ul></div>
-item=<li>|</li>
-text=<p>|</p>
-
-[listtags-numbered]
-# The start attribute is not valid XHTML 1.1 but all browsers support it.
-list=<div class="olist{style? {style}}{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ol class="{style}"{start? start="{start}"}>|</ol></div>
-item=<li>|</li>
-text=<p>|</p>
-
-[listtags-labeled]
-list=<div class="dlist{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<dl>|</dl></div>
-entry=
-label=
-term=<dt class="hdlist1{strong-option? strong}">|</dt>
-item=<dd>|</dd>
-text=<p>|</p>
-
-[listtags-horizontal]
-list=<div class="hdlist{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<table>{labelwidth?<col width="{labelwidth}%" />}{itemwidth?<col width="{itemwidth}%" />}|</table></div>
-label=<td class="hdlist1{strong-option? strong}">|</td>
-term=|<br />
-entry=<tr>|</tr>
-item=<td class="hdlist2">|</td>
-text=<p style="margin-top: 0;">|</p>
-
-[listtags-qanda]
-list=<div class="qlist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ol>|</ol></div>
-entry=<li>|</li>
-label=
-term=<p><em>|</em></p>
-item=
-text=<p>|</p>
-
-[listtags-callout]
-ifndef::icons[]
-list=<div class="colist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ol>|</ol></div>
-item=<li>|</li>
-text=<p>|</p>
-endif::icons[]
-ifdef::icons[]
-list=<div class="colist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<table>|</table></div>
-ifndef::data-uri[]
-item=<tr><td><img src="{iconsdir}/callouts/{listindex}.png" alt="{listindex}" /></td><td>|</td></tr>
-endif::data-uri[]
-ifdef::data-uri[]
-item=<tr><td><img alt="{listindex}" src="data:image/png;base64, {sys:python -uc "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join("{indir={outdir}}","{icon={iconsdir}/callouts/{listindex}.png}")}"}" /></td><td>|</td></tr>
-endif::data-uri[]
-text=|
-endif::icons[]
-
-[listtags-glossary]
-list=<div class="dlist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<dl>|</dl></div>
-label=
-entry=
-term=<dt>|</dt>
-item=<dd>|</dd>
-text=<p>|</p>
-
-[listtags-bibliography]
-list=<div class="ulist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ul>|</ul></div>
-item=<li>|</li>
-text=<p>|</p>
-
-[tags]
-# Quoted text.
-emphasis=<em>{1?<span class="{1}">}|{1?</span>}</em>
-strong=<strong>{1?<span class="{1}">}|{1?</span>}</strong>
-monospaced=<tt>{1?<span class="{1}">}|{1?</span>}</tt>
-singlequoted={lsquo}{1?<span class="{1}">}|{1?</span>}{rsquo}
-doublequoted={ldquo}{1?<span class="{1}">}|{1?</span>}{rdquo}
-unquoted={1?<span class="{1}">}|{1?</span>}
-superscript=<sup>{1?<span class="{1}">}|{1?</span>}</sup>
-subscript=<sub>{1?<span class="{1}">}|{1?</span>}</sub>
-
-ifdef::deprecated-quotes[]
-# Override with deprecated quote attributes.
-emphasis={role?<span class="{role}">}<em{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</em>{role?</span>}
-strong={role?<span class="{role}">}<strong{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</strong>{role?</span>}
-monospaced={role?<span class="{role}">}<tt{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</tt>{role?</span>}
-singlequoted={role?<span class="{role}">}{1,2,3?<span style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?">}{amp}#8216;|{amp}#8217;{1,2,3?</span>}{role?</span>}
-doublequoted={role?<span class="{role}">}{1,2,3?<span style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?">}{amp}#8220;|{amp}#8221;{1,2,3?</span>}{role?</span>}
-unquoted={role?<span class="{role}">}{1,2,3?<span style="{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}">}|{1,2,3?</span>}{role?</span>}
-superscript={role?<span class="{role}">}<sup{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</sup>{role?</span>}
-subscript={role?<span class="{role}">}<sub{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</sub>{role?</span>}
-endif::deprecated-quotes[]
-
-# Inline macros
-[http-inlinemacro]
-<a href="{name}:{target}">{0={name}:{target}}</a>
-[https-inlinemacro]
-<a href="{name}:{target}">{0={name}:{target}}</a>
-[ftp-inlinemacro]
-<a href="{name}:{target}">{0={name}:{target}}</a>
-[file-inlinemacro]
-<a href="{name}:{target}">{0={name}:{target}}</a>
-[irc-inlinemacro]
-<a href="{name}:{target}">{0={name}:{target}}</a>
-[mailto-inlinemacro]
-<a href="mailto:{target}">{0={target}}</a>
-[link-inlinemacro]
-<a href="{target}">{0={target}}</a>
-[callto-inlinemacro]
-<a href="{name}:{target}">{0={target}}</a>
-# anchor:id[text]
-[anchor-inlinemacro]
-<a id="{target}"></a>
-# [[id,text]]
-[anchor2-inlinemacro]
-<a id="{1}"></a>
-# [[[id]]]
-[anchor3-inlinemacro]
-<a id="{1}"></a>[{1}]
-# xref:id[text]
-[xref-inlinemacro]
-<a href="#{target}">{0=[{target}]}</a>
-# <<id,text>>
-[xref2-inlinemacro]
-<a href="#{1}">{2=[{1}]}</a>
-
-# Special word substitution.
-[emphasizedwords]
-<em>{words}</em>
-[monospacedwords]
-<tt>{words}</tt>
-[strongwords]
-<strong>{words}</strong>
-
-# Paragraph substitution.
-[paragraph]
-<div class="paragraph{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<p>
-|
-</p></div>
-
-[admonitionparagraph]
-template::[admonitionblock]
-
-# Delimited blocks.
-[listingblock]
-<div class="listingblock{role? {role}}"{id? id="{id}"}>
-<div class="title">{caption=}{title}</div>
-<div class="content">
-<pre><tt>
-|
-</tt></pre>
-</div></div>
-
-[literalblock]
-<div class="literalblock{role? {role}}"{id? id="{id}"}>
-<div class="title">{title}</div>
-<div class="content">
-<pre><tt>
-|
-</tt></pre>
-</div></div>
-
-[sidebarblock]
-<div class="sidebarblock{role? {role}}"{id? id="{id}"}>
-<div class="content">
-<div class="title">{title}</div>
-|
-</div></div>
-
-[openblock]
-<div class="openblock{role? {role}}"{id? id="{id}"}>
-<div class="title">{title}</div>
-<div class="content">
-|
-</div></div>
-
-[partintroblock]
-template::[openblock]
-
-[abstractblock]
-template::[quoteblock]
-
-[quoteblock]
-<div class="quoteblock{role? {role}}"{id? id="{id}"}>
-<div class="title">{title}</div>
-<div class="content">
-|
-</div>
-<div class="attribution">
-<em>{citetitle}</em>{attribution?<br />}
-— {attribution}
-</div></div>
-
-[verseblock]
-<div class="verseblock{role? {role}}"{id? id="{id}"}>
-<div class="title">{title}</div>
-<pre class="content">
-|
-</pre>
-<div class="attribution">
-<em>{citetitle}</em>{attribution?<br />}
-— {attribution}
-</div></div>
-
-[exampleblock]
-<div class="exampleblock{role? {role}}"{id? id="{id}"}>
-<div class="title">{caption={example-caption} {counter:example-number}. }{title}</div>
-<div class="content">
-|
-</div></div>
-
-[admonitionblock]
-<div class="admonitionblock{role? {role}}"{id? id="{id}"}>
-<table><tr>
-<td class="icon">
-{data-uri%}{icons#}<img src="{icon={iconsdir}/{name}.png}" alt="{caption}" />
-{data-uri#}{icons#}<img alt="{caption}" src="data:image/png;base64,
-{data-uri#}{icons#}{sys:python -uc "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join("{indir={outdir}}","{icon={iconsdir}/{name}.png}")}"}" />
-{icons%}<div class="title">{caption}</div>
-</td>
-<td class="content">
-<div class="title">{title}</div>
-|
-</td>
-</tr></table>
-</div>
-
-# Tables.
-[tabletags-default]
-colspec=<col{autowidth-option! width="{colpcwidth}%"} />
-bodyrow=<tr>|</tr>
-headdata=<th {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}" valign="{valign}">|</th>
-bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}" valign="{valign}">|</td>
-paragraph=<p class="table">|</p>
-
-[tabletags-header]
-paragraph=<p class="table header">|</p>
-
-[tabletags-emphasis]
-paragraph=<p class="table"><em>|</em></p>
-
-[tabletags-strong]
-paragraph=<p class="table"><strong>|</strong></p>
-
-[tabletags-monospaced]
-paragraph=<p class="table"><tt>|</tt></p>
-
-[tabletags-verse]
-bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}" valign="{valign}"><div class="verse">|</div></td>
-paragraph=
-
-[tabletags-literal]
-bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}" valign="{valign}"><div class="literal"><pre><tt>|</tt></pre></div></td>
-paragraph=
-
-[tabletags-asciidoc]
-bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}" valign="{valign}"><div>|</div></td>
-paragraph=
-
-[table]
-<div class="tableblock{role? {role}}"{id? id="{id}"}>
-<table rules="{grid=all}"
-style="margin-left:{align@left:0}{align@center|right:auto}; margin-right:{align@left|center:auto}{align@right:0};"
-style="float:{float};"
-{autowidth-option%}width="{tablepcwidth}%"
-{autowidth-option#}{width#width="{tablepcwidth}%"}
-frame="{frame%border}"
-frame="{frame@topbot:hsides}{frame@all:border}{frame@none:void}{frame@sides:vsides}"
-cellspacing="0" cellpadding="4">
-<caption class="title">{caption={table-caption} {counter:table-number}. }{title}</caption>
-{colspecs}
-{headrows#}<thead>
-{headrows}
-{headrows#}</thead>
-{footrows#}<tfoot>
-{footrows}
-{footrows#}</tfoot>
-<tbody>
-{bodyrows}
-</tbody>
-</table>
-</div>
-
-#--------------------------------------------------------------------
-# Deprecated old table definitions.
-#
-
-[miscellaneous]
-# Screen width in pixels.
-pagewidth=800
-pageunits=
-
-[old_tabledef-default]
-template=old_table
-colspec=<col width="{colwidth}{pageunits}" />
-bodyrow=<tr>|</tr>
-headdata=<th align="{colalign}">|</th>
-footdata=<td align="{colalign}">|</td>
-bodydata=<td align="{colalign}">|</td>
-
-[old_table]
-<div class="tableblock"{id? id="{id}"}>
-<table rules="{grid=none}"
-frame="{frame%hsides}"
-frame="{frame@topbot:hsides}{frame@all:border}{frame@none:void}{frame@sides:vsides}"
-cellspacing="0" cellpadding="4">
-<caption class="title">{caption={table-caption}}{title}</caption>
-{colspecs}
-{headrows#}<thead>
-{headrows}
-{headrows#}</thead>
-{footrows#}<tfoot>
-{footrows}
-{footrows#}</tfoot>
-<tbody valign="top">
-{bodyrows}
-</tbody>
-</table>
-</div>
-
-# End of deprecated old table definitions.
-#--------------------------------------------------------------------
-
-[floatingtitle]
-<h{level@0:1}{level@1:2}{level@2:3}{level@3:4}{level@4:5}{id? id="{id}"} class="float">{title}</h{level@0:1}{level@1:2}{level@2:3}{level@3:4}{level@4:5}>
-
-[preamble]
-# Untitled elements between header and first section title.
-<div id="preamble">
-<div class="sectionbody">
-|
-</div>
-</div>
-
-# Document sections.
-[sect0]
-<h1{id? id="{id}"}>{title}</h1>
-|
-
-[sect1]
-<div class="sect1{style? {style}}{role? {role}}">
-<h2{id? id="{id}"}>{numbered?{sectnum} }{title}</h2>
-<div class="sectionbody">
-|
-</div>
-</div>
-
-[sect2]
-<div class="sect2{style? {style}}{role? {role}}">
-<h3{id? id="{id}"}>{numbered?{sectnum} }{title}</h3>
-|
-</div>
-
-[sect3]
-<div class="sect3{style? {style}}{role? {role}}">
-<h4{id? id="{id}"}>{numbered?{sectnum} }{title}</h4>
-|
-</div>
-
-[sect4]
-<div class="sect4{style? {style}}{role? {role}}">
-<h5{id? id="{id}"}>{title}</h5>
-|
-</div>
-
-[appendix]
-<div class="sect1{style? {style}}{role? {role}}">
-<h2{id? id="{id}"}>{numbered?{sectnum} }{appendix-caption} {counter:appendix-number:A}: {title}</h2>
-<div class="sectionbody">
-|
-</div>
-</div>
-
-[toc]
-<div id="toc">
- <div id="toctitle">{toc-title}</div>
- <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
-</div>
-
-[header]
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
- "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{lang=en}">
-<head>
-<meta http-equiv="Content-Type" content="{quirks=application/xhtml+xml}{quirks?text/html}; charset={encoding}" />
-<meta name="generator" content="AsciiDoc {asciidoc-version}" />
-<meta name="description" content="{description}" />
-<meta name="keywords" content="{keywords}" />
-<title>{title}</title>
-{title%}<title>{doctitle=}</title>
-ifdef::linkcss[]
-<link rel="stylesheet" href="{stylesdir=.}/{theme={backend}}.css" type="text/css" />
-{doctype-manpage}<link rel="stylesheet" href="{stylesdir=.}/{theme={backend}}-manpage.css" type="text/css" />
-ifdef::quirks[]
-<link rel="stylesheet" href="{stylesdir=.}/{theme={backend}}-quirks.css" type="text/css" />
-endif::quirks[]
-<link rel="stylesheet" href="{stylesdir=.}/{stylesheet}" type="text/css" />
-ifdef::pygments[<link rel="stylesheet" href="{stylesdir=.}/pygments.css" type="text/css" />]
-endif::linkcss[]
-ifndef::linkcss[]
-<style type="text/css">
-include1::{stylesdir=./stylesheets}/{theme={backend}}.css[]
-ifdef::doctype-manpage[]
-include1::{stylesdir=./stylesheets}/{theme={backend}}-manpage.css[]
-endif::doctype-manpage[]
-ifdef::quirks[]
-include1::{stylesdir=./stylesheets}/{theme={backend}}-quirks.css[]
-endif::quirks[]
-include1::{stylesheet}[]
-ifdef::pygments[]
-include1::{stylesdir=./stylesheets}/pygments.css[]
-endif::pygments[]
-</style>
-endif::linkcss[]
-ifndef::disable-javascript[]
-ifdef::linkcss[]
-<script type="text/javascript">
-# Escape as CDATA to pass validators.
-/*<![CDATA[*/
-window.onload = function()\{asciidoc.footnotes();{toc? asciidoc.toc({toclevels});}\}
-/*]]>*/
-</script>
-<script type="text/javascript" src="{scriptsdir=.}/asciidoc-xhtml11.js"></script>
-endif::linkcss[]
-ifndef::linkcss[]
-<script type="text/javascript">
-# Escape as CDATA to pass validators.
-/*<![CDATA[*/
-window.onload = function()\{asciidoc.footnotes();{toc? asciidoc.toc({toclevels});}\}
-include1::{scriptsdir=./javascripts}/asciidoc-xhtml11.js[]
-/*]]>*/
-</script>
-endif::linkcss[]
-endif::disable-javascript[]
-ifdef::asciimath[]
-ifdef::linkcss[]
-<script type="text/javascript" src="{scriptsdir=.}/ASCIIMathML.js"></script>
-endif::linkcss[]
-ifndef::linkcss[]
-<script type="text/javascript">
-# Escape as CDATA to pass validators.
-/*<![CDATA[*/
-include1::{scriptsdir=./javascripts}/ASCIIMathML.js[]
-/*]]>*/
-</script>
-endif::linkcss[]
-endif::asciimath[]
-ifdef::latexmath[]
-ifdef::linkcss[]
-<script type="text/javascript" src="{scriptsdir=.}/LaTeXMathML.js"></script>
-endif::linkcss[]
-ifndef::linkcss[]
-<script type="text/javascript">
-# Escape as CDATA to pass validators.
-/*<![CDATA[*/
-include1::{scriptsdir=./javascripts}/LaTeXMathML.js[]
-/*]]>*/
-</script>
-endif::linkcss[]
-endif::latexmath[]
-{docinfo1,docinfo2#}{include:{docdir}/docinfo.html}
-{docinfo,docinfo2#}{include:{docdir}/{docname}-docinfo.html}
-</head>
-<body class="{doctype}"{max-width? style="max-width:{max-width}"}>
-# Article, book header.
-ifndef::doctype-manpage[]
-<div id="header">
-ifndef::notitle[<h1>{doctitle}</h1>]
-ifdef::doctitle[]
-<span id="author">{author}</span><br />
-<span id="email"><tt><<a href="mailto:{email}">{email}</a>></tt></span><br />
-<span id="revnumber">version {revnumber}{revdate?,}</span>
-<span id="revdate">{revdate}</span>
-<br /><span id="revremark">{revremark}</span>
-endif::doctitle[]
-ifdef::toc[{template:toc}]
-</div>
-endif::doctype-manpage[]
-# Man page header.
-ifdef::doctype-manpage[]
-<div id="header">
-<h1>
-{doctitle} Manual Page
-</h1>
-ifdef::toc[{template:toc}]
-<h2>{manname-title}</h2>
-<div class="sectionbody">
-<p>{manname} -
- {manpurpose}
-</p>
-</div>
-</div>
-endif::doctype-manpage[]
-<div id="content">
-
-[footer]
-</div>
-{disable-javascript%<div id="footnotes"><hr /></div>}
-<div id="footer">
-<div id="footer-text">
-template::[footer-text]
-</div>
-ifdef::badges[]
-<div id="footer-badges">
-ifndef::icons[]
-Valid <a href="http://validator.w3.org/check?uri=referer">XHTML</a>
-and <a href="http://jigsaw.w3.org/css-validator/check/referer">CSS</a>.
-endif::icons[]
-ifdef::icons[]
-<a href="http://validator.w3.org/check?uri=referer">
- <img style="border:0;width:88px;height:31px"
- src="http://www.w3.org/Icons/valid-xhtml11-blue"
- alt="Valid XHTML 1.1" height="31" width="88" />
-</a>
-<a href="http://jigsaw.w3.org/css-validator/">
- <img style="border:0;width:88px;height:31px"
- src="http://jigsaw.w3.org/css-validator/images/vcss-blue"
- alt="Valid CSS!" />
-</a>
-<a href="http://www.mozilla.org/products/firefox/">
- <img style="border:none; width:110px; height:32px;"
- src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif"
- alt="Get Firefox!" />
-</a>
-endif::icons[]
-</div>
-endif::badges[]
-</div>
-</body>
-</html>
-
-ifdef::doctype-manpage[]
-[synopsis]
-template::[sect1]
-endif::doctype-manpage[]
-
-ifdef::quirks[]
-include::{backend}-quirks.conf[]
-endif::quirks[]
+# +# xhtml11.conf +# +# Asciidoc configuration file. +# xhtml11 backend, generates XHTML 1.1 conformant markup. +# + +[miscellaneous] +outfilesuffix=.html + +[attributes] +basebackend=html +basebackend-html= +basebackend-xhtml11= + +[replacements2] +# Line break. +(?m)^(.*)\s\+$=\1<br /> + +[replacements] +ifdef::asciidoc7compatible[] +# Superscripts. +\^(.+?)\^=<sup>\1</sup> +# Subscripts. +~(.+?)~=<sub>\1</sub> +endif::asciidoc7compatible[] + +[ruler-blockmacro] +<hr /> + +[pagebreak-blockmacro] +<div style="page-break-after:always"></div> + +[blockdef-pass] +asciimath-style=template="asciimathblock",subs=[] +latexmath-style=template="latexmathblock",subs=[] + +[macros] +# math macros. +# Special characters are escaped in HTML math markup. +(?su)[\\]?(?P<name>asciimath|latexmath):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[specialcharacters] +(?u)^(?P<name>asciimath|latexmath)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=#[specialcharacters] + +[asciimath-inlinemacro] +`{passtext}` + +[asciimath-blockmacro] +<div class="mathblock{role? {role}}"{id? id="{id}"}> +<div class="content"> +<div class="title">{title}</div> +`{passtext}` +</div></div> + +[asciimathblock] +<div class="mathblock{role? {role}}"{id? id="{id}"}> +<div class="content"> +<div class="title">{title}</div> +`|` +</div></div> + +[latexmath-inlinemacro] +{passtext} + +[latexmath-blockmacro] +<div class="mathblock{role? {role}}"{id? id="{id}"}> +<div class="content"> +<div class="title">{title}</div> +{passtext} +</div></div> + +[latexmathblock] +<div class="mathblock{role? {role}}"{id? id="{id}"}> +<div class="content"> +<div class="title">{title}</div> +| +</div></div> + +[image-inlinemacro] +<span class="image{role? {role}}"> +<a class="image" href="{link}"> +{data-uri%}<img src="{imagesdir=}{imagesdir?/}{target}" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}{title? title="{title}"} /> +{data-uri#}<img alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"}{title? title="{title}"} src="data:image/{eval:os.path.splitext('{target}')[1][1:]};base64, +{data-uri#}{sys3:python -uc "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join("{indir={outdir}}","{imagesdir=}","{target}")}"}" /> +{link#}</a> +</span> + +[image-blockmacro] +<div class="imageblock{style? {style}}{role? {role}}"{id? id="{id}"}{align? style="text-align:{align};"}{float? style="float:{float};"}> +<div class="content"> +<a class="image" href="{link}"> +{data-uri%}<img src="{imagesdir=}{imagesdir?/}{target}" alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"} /> +{data-uri#}<img alt="{alt={target}}"{width? width="{width}"}{height? height="{height}"} src="data:image/{eval:os.path.splitext('{target}')[1][1:]};base64, +{data-uri#}{sys:python -uc "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join("{indir={outdir}}","{imagesdir=}","{target}")}"}" /> +{link#}</a> +</div> +<div class="title">{caption={figure-caption} {counter:figure-number}. }{title}</div> +</div> + +[unfloat-blockmacro] +<div style="clear:both;"></div> + +[indexterm-inlinemacro] +# Index term. +{empty} + +[indexterm2-inlinemacro] +# Index term. +# Single entry index term that is visible in the primary text flow. +{1} + +[footnote-inlinemacro] +# footnote:[<text>]. +<span class="footnote"><br />[{0}]<br /></span> + +[footnoteref-inlinemacro] +# footnoteref:[<id>], create reference to footnote. +{2%}<span class="footnoteref"><br /><a href="#_footnote_{1}">[{1}]</a><br /></span> +# footnoteref:[<id>,<text>], create footnote with ID. +{2#}<span class="footnote" id="_footnote_{1}"><br />[{2}]<br /></span> + +[callout-inlinemacro] +ifndef::icons[] +<b><{index}></b> +endif::icons[] +ifdef::icons[] +ifndef::data-uri[] +<img src="{icon={iconsdir}/callouts/{index}.png}" alt="{index}" /> +endif::data-uri[] +ifdef::data-uri[] +<img alt="{index}" src="data:image/png;base64, +{sys:python -uc "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join("{indir={outdir}}","{icon={iconsdir}/callouts/{index}.png}")}"}" /> +endif::data-uri[] +endif::icons[] + +# Comment line macros. +[comment-inlinemacro] +{showcomments#}<br /><span class="comment">{passtext}</span><br /> + +[comment-blockmacro] +{showcomments#}<p><span class="comment">{passtext}</span></p> + +[literal-inlinemacro] +# Inline literal. +<tt>{passtext}</tt> + +# List tags. +[listtags-bulleted] +list=<div class="ulist{style? {style}}{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ul>|</ul></div> +item=<li>|</li> +text=<p>|</p> + +[listtags-numbered] +# The start attribute is not valid XHTML 1.1 but all browsers support it. +list=<div class="olist{style? {style}}{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ol class="{style}"{start? start="{start}"}>|</ol></div> +item=<li>|</li> +text=<p>|</p> + +[listtags-labeled] +list=<div class="dlist{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<dl>|</dl></div> +entry= +label= +term=<dt class="hdlist1{strong-option? strong}">|</dt> +item=<dd>|</dd> +text=<p>|</p> + +[listtags-horizontal] +list=<div class="hdlist{compact-option? compact}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<table>{labelwidth?<col width="{labelwidth}%" />}{itemwidth?<col width="{itemwidth}%" />}|</table></div> +label=<td class="hdlist1{strong-option? strong}">|</td> +term=|<br /> +entry=<tr>|</tr> +item=<td class="hdlist2">|</td> +text=<p style="margin-top: 0;">|</p> + +[listtags-qanda] +list=<div class="qlist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ol>|</ol></div> +entry=<li>|</li> +label= +term=<p><em>|</em></p> +item= +text=<p>|</p> + +[listtags-callout] +ifndef::icons[] +list=<div class="colist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ol>|</ol></div> +item=<li>|</li> +text=<p>|</p> +endif::icons[] +ifdef::icons[] +list=<div class="colist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<table>|</table></div> +ifndef::data-uri[] +item=<tr><td><img src="{iconsdir}/callouts/{listindex}.png" alt="{listindex}" /></td><td>|</td></tr> +endif::data-uri[] +ifdef::data-uri[] +item=<tr><td><img alt="{listindex}" src="data:image/png;base64, {sys:python -uc "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join("{indir={outdir}}","{icon={iconsdir}/callouts/{listindex}.png}")}"}" /></td><td>|</td></tr> +endif::data-uri[] +text=| +endif::icons[] + +[listtags-glossary] +list=<div class="dlist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<dl>|</dl></div> +label= +entry= +term=<dt>|</dt> +item=<dd>|</dd> +text=<p>|</p> + +[listtags-bibliography] +list=<div class="ulist{style? {style}}{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<ul>|</ul></div> +item=<li>|</li> +text=<p>|</p> + +[tags] +# Quoted text. +emphasis=<em>{1?<span class="{1}">}|{1?</span>}</em> +strong=<strong>{1?<span class="{1}">}|{1?</span>}</strong> +monospaced=<tt>{1?<span class="{1}">}|{1?</span>}</tt> +singlequoted={lsquo}{1?<span class="{1}">}|{1?</span>}{rsquo} +doublequoted={ldquo}{1?<span class="{1}">}|{1?</span>}{rdquo} +unquoted={1?<span class="{1}">}|{1?</span>} +superscript=<sup>{1?<span class="{1}">}|{1?</span>}</sup> +subscript=<sub>{1?<span class="{1}">}|{1?</span>}</sub> + +ifdef::deprecated-quotes[] +# Override with deprecated quote attributes. +emphasis={role?<span class="{role}">}<em{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</em>{role?</span>} +strong={role?<span class="{role}">}<strong{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</strong>{role?</span>} +monospaced={role?<span class="{role}">}<tt{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</tt>{role?</span>} +singlequoted={role?<span class="{role}">}{1,2,3?<span style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?">}{amp}#8216;|{amp}#8217;{1,2,3?</span>}{role?</span>} +doublequoted={role?<span class="{role}">}{1,2,3?<span style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?">}{amp}#8220;|{amp}#8221;{1,2,3?</span>}{role?</span>} +unquoted={role?<span class="{role}">}{1,2,3?<span style="{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}">}|{1,2,3?</span>}{role?</span>} +superscript={role?<span class="{role}">}<sup{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</sup>{role?</span>} +subscript={role?<span class="{role}">}<sub{1,2,3? style="}{1?color:{1};}{2?background-color:{2};}{3?font-size:{3}em;}{1,2,3?"}>|</sub>{role?</span>} +endif::deprecated-quotes[] + +# Inline macros +[http-inlinemacro] +<a href="{name}:{target}">{0={name}:{target}}</a> +[https-inlinemacro] +<a href="{name}:{target}">{0={name}:{target}}</a> +[ftp-inlinemacro] +<a href="{name}:{target}">{0={name}:{target}}</a> +[file-inlinemacro] +<a href="{name}:{target}">{0={name}:{target}}</a> +[irc-inlinemacro] +<a href="{name}:{target}">{0={name}:{target}}</a> +[mailto-inlinemacro] +<a href="mailto:{target}">{0={target}}</a> +[link-inlinemacro] +<a href="{target}">{0={target}}</a> +[callto-inlinemacro] +<a href="{name}:{target}">{0={target}}</a> +# anchor:id[text] +[anchor-inlinemacro] +<a id="{target}"></a> +# [[id,text]] +[anchor2-inlinemacro] +<a id="{1}"></a> +# [[[id]]] +[anchor3-inlinemacro] +<a id="{1}"></a>[{1}] +# xref:id[text] +[xref-inlinemacro] +<a href="#{target}">{0=[{target}]}</a> +# <<id,text>> +[xref2-inlinemacro] +<a href="#{1}">{2=[{1}]}</a> + +# Special word substitution. +[emphasizedwords] +<em>{words}</em> +[monospacedwords] +<tt>{words}</tt> +[strongwords] +<strong>{words}</strong> + +# Paragraph substitution. +[paragraph] +<div class="paragraph{role? {role}}"{id? id="{id}"}>{title?<div class="title">{title}</div>}<p> +| +</p></div> + +[admonitionparagraph] +template::[admonitionblock] + +# Delimited blocks. +[listingblock] +<div class="listingblock{role? {role}}"{id? id="{id}"}> +<div class="title">{caption=}{title}</div> +<div class="content"> +<pre><tt> +| +</tt></pre> +</div></div> + +[literalblock] +<div class="literalblock{role? {role}}"{id? id="{id}"}> +<div class="title">{title}</div> +<div class="content"> +<pre><tt> +| +</tt></pre> +</div></div> + +[sidebarblock] +<div class="sidebarblock{role? {role}}"{id? id="{id}"}> +<div class="content"> +<div class="title">{title}</div> +| +</div></div> + +[openblock] +<div class="openblock{role? {role}}"{id? id="{id}"}> +<div class="title">{title}</div> +<div class="content"> +| +</div></div> + +[partintroblock] +template::[openblock] + +[abstractblock] +template::[quoteblock] + +[quoteblock] +<div class="quoteblock{role? {role}}"{id? id="{id}"}> +<div class="title">{title}</div> +<div class="content"> +| +</div> +<div class="attribution"> +<em>{citetitle}</em>{attribution?<br />} +— {attribution} +</div></div> + +[verseblock] +<div class="verseblock{role? {role}}"{id? id="{id}"}> +<div class="title">{title}</div> +<pre class="content"> +| +</pre> +<div class="attribution"> +<em>{citetitle}</em>{attribution?<br />} +— {attribution} +</div></div> + +[exampleblock] +<div class="exampleblock{role? {role}}"{id? id="{id}"}> +<div class="title">{caption={example-caption} {counter:example-number}. }{title}</div> +<div class="content"> +| +</div></div> + +[admonitionblock] +<div class="admonitionblock{role? {role}}"{id? id="{id}"}> +<table><tr> +<td class="icon"> +{data-uri%}{icons#}<img src="{icon={iconsdir}/{name}.png}" alt="{caption}" /> +{data-uri#}{icons#}<img alt="{caption}" src="data:image/png;base64, +{data-uri#}{icons#}{sys:python -uc "import base64,sys; base64.encode(sys.stdin,sys.stdout)" < "{eval:os.path.join("{indir={outdir}}","{icon={iconsdir}/{name}.png}")}"}" /> +{icons%}<div class="title">{caption}</div> +</td> +<td class="content"> +<div class="title">{title}</div> +| +</td> +</tr></table> +</div> + +# Tables. +[tabletags-default] +colspec=<col{autowidth-option! width="{colpcwidth}%"} /> +bodyrow=<tr>|</tr> +headdata=<th {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}" valign="{valign}">|</th> +bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}" valign="{valign}">|</td> +paragraph=<p class="table">|</p> + +[tabletags-header] +paragraph=<p class="table header">|</p> + +[tabletags-emphasis] +paragraph=<p class="table"><em>|</em></p> + +[tabletags-strong] +paragraph=<p class="table"><strong>|</strong></p> + +[tabletags-monospaced] +paragraph=<p class="table"><tt>|</tt></p> + +[tabletags-verse] +bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}" valign="{valign}"><div class="verse">|</div></td> +paragraph= + +[tabletags-literal] +bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}" valign="{valign}"><div class="literal"><pre><tt>|</tt></pre></div></td> +paragraph= + +[tabletags-asciidoc] +bodydata=<td {colspan@1::colspan="{colspan}" }{rowspan@1::rowspan="{rowspan}" }align="{halign}" valign="{valign}"><div>|</div></td> +paragraph= + +[table] +<div class="tableblock{role? {role}}"{id? id="{id}"}> +<table rules="{grid=all}" +style="margin-left:{align@left:0}{align@center|right:auto}; margin-right:{align@left|center:auto}{align@right:0};" +style="float:{float};" +{autowidth-option%}width="{tablepcwidth}%" +{autowidth-option#}{width#width="{tablepcwidth}%"} +frame="{frame%border}" +frame="{frame@topbot:hsides}{frame@all:border}{frame@none:void}{frame@sides:vsides}" +cellspacing="0" cellpadding="4"> +<caption class="title">{caption={table-caption} {counter:table-number}. }{title}</caption> +{colspecs} +{headrows#}<thead> +{headrows} +{headrows#}</thead> +{footrows#}<tfoot> +{footrows} +{footrows#}</tfoot> +<tbody> +{bodyrows} +</tbody> +</table> +</div> + +#-------------------------------------------------------------------- +# Deprecated old table definitions. +# + +[miscellaneous] +# Screen width in pixels. +pagewidth=800 +pageunits= + +[old_tabledef-default] +template=old_table +colspec=<col width="{colwidth}{pageunits}" /> +bodyrow=<tr>|</tr> +headdata=<th align="{colalign}">|</th> +footdata=<td align="{colalign}">|</td> +bodydata=<td align="{colalign}">|</td> + +[old_table] +<div class="tableblock"{id? id="{id}"}> +<table rules="{grid=none}" +frame="{frame%hsides}" +frame="{frame@topbot:hsides}{frame@all:border}{frame@none:void}{frame@sides:vsides}" +cellspacing="0" cellpadding="4"> +<caption class="title">{caption={table-caption}}{title}</caption> +{colspecs} +{headrows#}<thead> +{headrows} +{headrows#}</thead> +{footrows#}<tfoot> +{footrows} +{footrows#}</tfoot> +<tbody valign="top"> +{bodyrows} +</tbody> +</table> +</div> + +# End of deprecated old table definitions. +#-------------------------------------------------------------------- + +[floatingtitle] +<h{level@0:1}{level@1:2}{level@2:3}{level@3:4}{level@4:5}{id? id="{id}"} class="float">{title}</h{level@0:1}{level@1:2}{level@2:3}{level@3:4}{level@4:5}> + +[preamble] +# Untitled elements between header and first section title. +<div id="preamble"> +<div class="sectionbody"> +| +</div> +</div> + +# Document sections. +[sect0] +<h1{id? id="{id}"}>{title}</h1> +| + +[sect1] +<div class="sect1{style? {style}}{role? {role}}"> +<h2{id? id="{id}"}>{numbered?{sectnum} }{title}</h2> +<div class="sectionbody"> +| +</div> +</div> + +[sect2] +<div class="sect2{style? {style}}{role? {role}}"> +<h3{id? id="{id}"}>{numbered?{sectnum} }{title}</h3> +| +</div> + +[sect3] +<div class="sect3{style? {style}}{role? {role}}"> +<h4{id? id="{id}"}>{numbered?{sectnum} }{title}</h4> +| +</div> + +[sect4] +<div class="sect4{style? {style}}{role? {role}}"> +<h5{id? id="{id}"}>{title}</h5> +| +</div> + +[appendix] +<div class="sect1{style? {style}}{role? {role}}"> +<h2{id? id="{id}"}>{numbered?{sectnum} }{appendix-caption} {counter:appendix-number:A}: {title}</h2> +<div class="sectionbody"> +| +</div> +</div> + +[toc] +<div id="toc"> + <div id="toctitle">{toc-title}</div> + <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript> +</div> + +[header] +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" + "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{lang=en}"> +<head> +<meta http-equiv="Content-Type" content="{quirks=application/xhtml+xml}{quirks?text/html}; charset={encoding}" /> +<meta name="generator" content="AsciiDoc {asciidoc-version}" /> +<meta name="description" content="{description}" /> +<meta name="keywords" content="{keywords}" /> +<title>{title}</title> +{title%}<title>{doctitle=}</title> +ifdef::linkcss[] +<link rel="stylesheet" href="{stylesdir=.}/{theme={backend}}.css" type="text/css" /> +{doctype-manpage}<link rel="stylesheet" href="{stylesdir=.}/{theme={backend}}-manpage.css" type="text/css" /> +ifdef::quirks[] +<link rel="stylesheet" href="{stylesdir=.}/{theme={backend}}-quirks.css" type="text/css" /> +endif::quirks[] +<link rel="stylesheet" href="{stylesdir=.}/{stylesheet}" type="text/css" /> +ifdef::pygments[<link rel="stylesheet" href="{stylesdir=.}/pygments.css" type="text/css" />] +endif::linkcss[] +ifndef::linkcss[] +<style type="text/css"> +include1::{stylesdir=./stylesheets}/{theme={backend}}.css[] +ifdef::doctype-manpage[] +include1::{stylesdir=./stylesheets}/{theme={backend}}-manpage.css[] +endif::doctype-manpage[] +ifdef::quirks[] +include1::{stylesdir=./stylesheets}/{theme={backend}}-quirks.css[] +endif::quirks[] +include1::{stylesheet}[] +ifdef::pygments[] +include1::{stylesdir=./stylesheets}/pygments.css[] +endif::pygments[] +</style> +endif::linkcss[] +ifndef::disable-javascript[] +ifdef::linkcss[] +<script type="text/javascript"> +# Escape as CDATA to pass validators. +/*<![CDATA[*/ +window.onload = function()\{asciidoc.footnotes();{toc? asciidoc.toc({toclevels});}\} +/*]]>*/ +</script> +<script type="text/javascript" src="{scriptsdir=.}/asciidoc-xhtml11.js"></script> +endif::linkcss[] +ifndef::linkcss[] +<script type="text/javascript"> +# Escape as CDATA to pass validators. +/*<![CDATA[*/ +window.onload = function()\{asciidoc.footnotes();{toc? asciidoc.toc({toclevels});}\} +include1::{scriptsdir=./javascripts}/asciidoc-xhtml11.js[] +/*]]>*/ +</script> +endif::linkcss[] +endif::disable-javascript[] +ifdef::asciimath[] +ifdef::linkcss[] +<script type="text/javascript" src="{scriptsdir=.}/ASCIIMathML.js"></script> +endif::linkcss[] +ifndef::linkcss[] +<script type="text/javascript"> +# Escape as CDATA to pass validators. +/*<![CDATA[*/ +include1::{scriptsdir=./javascripts}/ASCIIMathML.js[] +/*]]>*/ +</script> +endif::linkcss[] +endif::asciimath[] +ifdef::latexmath[] +ifdef::linkcss[] +<script type="text/javascript" src="{scriptsdir=.}/LaTeXMathML.js"></script> +endif::linkcss[] +ifndef::linkcss[] +<script type="text/javascript"> +# Escape as CDATA to pass validators. +/*<![CDATA[*/ +include1::{scriptsdir=./javascripts}/LaTeXMathML.js[] +/*]]>*/ +</script> +endif::linkcss[] +endif::latexmath[] +{docinfo1,docinfo2#}{include:{docdir}/docinfo.html} +{docinfo,docinfo2#}{include:{docdir}/{docname}-docinfo.html} +</head> +<body class="{doctype}"{max-width? style="max-width:{max-width}"}> +# Article, book header. +ifndef::doctype-manpage[] +<div id="header"> +ifndef::notitle[<h1>{doctitle}</h1>] +ifdef::doctitle[] +<span id="author">{author}</span><br /> +<span id="email"><tt><<a href="mailto:{email}">{email}</a>></tt></span><br /> +<span id="revnumber">version {revnumber}{revdate?,}</span> +<span id="revdate">{revdate}</span> +<br /><span id="revremark">{revremark}</span> +endif::doctitle[] +ifdef::toc[{template:toc}] +</div> +endif::doctype-manpage[] +# Man page header. +ifdef::doctype-manpage[] +<div id="header"> +<h1> +{doctitle} Manual Page +</h1> +ifdef::toc[{template:toc}] +<h2>{manname-title}</h2> +<div class="sectionbody"> +<p>{manname} - + {manpurpose} +</p> +</div> +</div> +endif::doctype-manpage[] +<div id="content"> + +[footer] +</div> +{disable-javascript%<div id="footnotes"><hr /></div>} +<div id="footer"> +<div id="footer-text"> +template::[footer-text] +</div> +ifdef::badges[] +<div id="footer-badges"> +ifndef::icons[] +Valid <a href="http://validator.w3.org/check?uri=referer">XHTML</a> +and <a href="http://jigsaw.w3.org/css-validator/check/referer">CSS</a>. +endif::icons[] +ifdef::icons[] +<a href="http://validator.w3.org/check?uri=referer"> + <img style="border:0;width:88px;height:31px" + src="http://www.w3.org/Icons/valid-xhtml11-blue" + alt="Valid XHTML 1.1" height="31" width="88" /> +</a> +<a href="http://jigsaw.w3.org/css-validator/"> + <img style="border:0;width:88px;height:31px" + src="http://jigsaw.w3.org/css-validator/images/vcss-blue" + alt="Valid CSS!" /> +</a> +<a href="http://www.mozilla.org/products/firefox/"> + <img style="border:none; width:110px; height:32px;" + src="http://www.spreadfirefox.com/community/images/affiliates/Buttons/110x32/safer.gif" + alt="Get Firefox!" /> +</a> +endif::icons[] +</div> +endif::badges[] +</div> +</body> +</html> + +ifdef::doctype-manpage[] +[synopsis] +template::[sect1] +endif::doctype-manpage[] + +ifdef::quirks[] +include::{backend}-quirks.conf[] +endif::quirks[] |