From 0464153b36015012c5a2ff14d6d3f65fe04f476b Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Sun, 3 Mar 2013 15:58:11 +1100 Subject: Change asciidoc to the 8.6.4 release package because Windows was broken. --- source-builder/sb/asciidoc/BUGS | 27 + source-builder/sb/asciidoc/BUGS.txt | 20 + source-builder/sb/asciidoc/CHANGELOG | 3291 +++++++++++ source-builder/sb/asciidoc/CHANGELOG.txt | 3128 ++++++++++ source-builder/sb/asciidoc/COPYING | 339 ++ source-builder/sb/asciidoc/INSTALL | 235 + source-builder/sb/asciidoc/INSTALL.txt | 227 + source-builder/sb/asciidoc/MANIFEST | 90 + source-builder/sb/asciidoc/Makefile.in | 185 + source-builder/sb/asciidoc/README | 45 + source-builder/sb/asciidoc/README.txt | 35 + source-builder/sb/asciidoc/a2x.py | 960 ++++ source-builder/sb/asciidoc/asciidoc.conf | 3 +- source-builder/sb/asciidoc/asciidoc.py | 19 +- source-builder/sb/asciidoc/asciidocapi.py | 257 + source-builder/sb/asciidoc/configure | 3033 ++++++++++ source-builder/sb/asciidoc/configure.ac | 11 + .../sb/asciidoc/dblatex/asciidoc-dblatex.sty | 20 + .../sb/asciidoc/dblatex/asciidoc-dblatex.xsl | 74 + .../sb/asciidoc/dblatex/dblatex-readme.txt | 39 + source-builder/sb/asciidoc/doc/a2x.1 | 744 +++ source-builder/sb/asciidoc/doc/a2x.1.txt | 358 ++ source-builder/sb/asciidoc/doc/article-docinfo.xml | 87 + source-builder/sb/asciidoc/doc/article.pdf | Bin 0 -> 37949 bytes source-builder/sb/asciidoc/doc/article.txt | 139 + source-builder/sb/asciidoc/doc/asciidoc.1 | 310 + source-builder/sb/asciidoc/doc/asciidoc.1.txt | 197 + source-builder/sb/asciidoc/doc/asciidoc.conf | 7 + source-builder/sb/asciidoc/doc/asciidoc.dict | 1085 ++++ source-builder/sb/asciidoc/doc/asciidoc.txt | 6038 ++++++++++++++++++++ source-builder/sb/asciidoc/doc/asciidocapi.txt | 189 + source-builder/sb/asciidoc/doc/asciimathml.txt | 61 + source-builder/sb/asciidoc/doc/book-multi.txt | 181 + source-builder/sb/asciidoc/doc/book.epub | Bin 0 -> 17614 bytes source-builder/sb/asciidoc/doc/book.txt | 156 + source-builder/sb/asciidoc/doc/customers.csv | 18 + source-builder/sb/asciidoc/doc/epub-notes.txt | 210 + source-builder/sb/asciidoc/doc/faq.txt | 1358 +++++ source-builder/sb/asciidoc/doc/images/icons/README | 5 + .../sb/asciidoc/doc/images/icons/callouts/1.png | Bin 0 -> 329 bytes .../sb/asciidoc/doc/images/icons/callouts/10.png | Bin 0 -> 361 bytes .../sb/asciidoc/doc/images/icons/callouts/11.png | Bin 0 -> 565 bytes .../sb/asciidoc/doc/images/icons/callouts/12.png | Bin 0 -> 617 bytes .../sb/asciidoc/doc/images/icons/callouts/13.png | Bin 0 -> 623 bytes .../sb/asciidoc/doc/images/icons/callouts/14.png | Bin 0 -> 411 bytes .../sb/asciidoc/doc/images/icons/callouts/15.png | Bin 0 -> 640 bytes .../sb/asciidoc/doc/images/icons/callouts/2.png | Bin 0 -> 353 bytes .../sb/asciidoc/doc/images/icons/callouts/3.png | Bin 0 -> 350 bytes .../sb/asciidoc/doc/images/icons/callouts/4.png | Bin 0 -> 345 bytes .../sb/asciidoc/doc/images/icons/callouts/5.png | Bin 0 -> 348 bytes .../sb/asciidoc/doc/images/icons/callouts/6.png | Bin 0 -> 355 bytes .../sb/asciidoc/doc/images/icons/callouts/7.png | Bin 0 -> 344 bytes .../sb/asciidoc/doc/images/icons/callouts/8.png | Bin 0 -> 357 bytes .../sb/asciidoc/doc/images/icons/callouts/9.png | Bin 0 -> 357 bytes .../sb/asciidoc/doc/images/icons/caution.png | Bin 0 -> 2734 bytes .../sb/asciidoc/doc/images/icons/example.png | Bin 0 -> 2599 bytes .../sb/asciidoc/doc/images/icons/home.png | Bin 0 -> 1340 bytes .../sb/asciidoc/doc/images/icons/important.png | Bin 0 -> 2980 bytes .../sb/asciidoc/doc/images/icons/next.png | Bin 0 -> 1302 bytes .../sb/asciidoc/doc/images/icons/note.png | Bin 0 -> 2494 bytes .../sb/asciidoc/doc/images/icons/prev.png | Bin 0 -> 1348 bytes .../sb/asciidoc/doc/images/icons/tip.png | Bin 0 -> 2718 bytes source-builder/sb/asciidoc/doc/images/icons/up.png | Bin 0 -> 1320 bytes .../sb/asciidoc/doc/images/icons/warning.png | Bin 0 -> 3214 bytes source-builder/sb/asciidoc/doc/images/smallnew.png | Bin 0 -> 292 bytes source-builder/sb/asciidoc/doc/images/tiger.png | Bin 0 -> 6515 bytes source-builder/sb/asciidoc/doc/latex-backend.txt | 192 + source-builder/sb/asciidoc/doc/latex-bugs.txt | 134 + source-builder/sb/asciidoc/doc/latex-filter.pdf | Bin 0 -> 100587 bytes source-builder/sb/asciidoc/doc/latex-filter.txt | 196 + source-builder/sb/asciidoc/doc/latexmath.txt | 121 + source-builder/sb/asciidoc/doc/latexmathml.txt | 41 + source-builder/sb/asciidoc/doc/main.aap | 233 + source-builder/sb/asciidoc/doc/music-filter.pdf | Bin 0 -> 36491 bytes source-builder/sb/asciidoc/doc/music-filter.txt | 148 + .../doc/publishing-ebooks-with-asciidoc.txt | 398 ++ source-builder/sb/asciidoc/doc/slidy-example.txt | 167 + source-builder/sb/asciidoc/doc/slidy.txt | 113 + .../sb/asciidoc/doc/source-highlight-filter.pdf | Bin 0 -> 127428 bytes .../sb/asciidoc/doc/source-highlight-filter.txt | 270 + source-builder/sb/asciidoc/doc/testasciidoc.txt | 231 + .../asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt | 65 + source-builder/sb/asciidoc/docbook-xsl/chunked.xsl | 17 + source-builder/sb/asciidoc/docbook-xsl/common.xsl | 106 + source-builder/sb/asciidoc/docbook-xsl/epub.xsl | 35 + source-builder/sb/asciidoc/docbook-xsl/fo.xsl | 152 + .../sb/asciidoc/docbook-xsl/htmlhelp.xsl | 16 + source-builder/sb/asciidoc/docbook-xsl/manpage.xsl | 31 + source-builder/sb/asciidoc/docbook-xsl/text.xsl | 55 + source-builder/sb/asciidoc/docbook-xsl/xhtml.xsl | 14 + source-builder/sb/asciidoc/docbook45.conf | 802 +++ .../sb/asciidoc/examples/website/ASCIIMathML.js | 938 +++ .../sb/asciidoc/examples/website/CHANGELOG.txt | 3128 ++++++++++ .../sb/asciidoc/examples/website/INSTALL.txt | 227 + .../sb/asciidoc/examples/website/LaTeXMathML.js | 1223 ++++ .../asciidoc/examples/website/README-website.txt | 29 + .../sb/asciidoc/examples/website/README.txt | 35 + .../sb/asciidoc/examples/website/a2x.1.txt | 358 ++ .../examples/website/asciidoc-docbook-xsl.txt | 65 + .../examples/website/asciidoc-graphviz-sample.txt | 170 + .../sb/asciidoc/examples/website/asciidoc.css | 525 ++ .../sb/asciidoc/examples/website/asciidoc.js | 189 + .../sb/asciidoc/examples/website/asciidocapi.txt | 189 + .../sb/asciidoc/examples/website/asciimathml.txt | 61 + .../sb/asciidoc/examples/website/build-website.sh | 25 + .../sb/asciidoc/examples/website/customers.csv | 18 + .../sb/asciidoc/examples/website/epub-notes.txt | 210 + .../sb/asciidoc/examples/website/faq.txt | 1358 +++++ .../examples/website/images/highlighter.png | Bin 0 -> 128142 bytes .../asciidoc/examples/website/images/icons/README | 5 + .../examples/website/images/icons/callouts/1.png | Bin 0 -> 329 bytes .../examples/website/images/icons/callouts/10.png | Bin 0 -> 361 bytes .../examples/website/images/icons/callouts/11.png | Bin 0 -> 565 bytes .../examples/website/images/icons/callouts/12.png | Bin 0 -> 617 bytes .../examples/website/images/icons/callouts/13.png | Bin 0 -> 623 bytes .../examples/website/images/icons/callouts/14.png | Bin 0 -> 411 bytes .../examples/website/images/icons/callouts/15.png | Bin 0 -> 640 bytes .../examples/website/images/icons/callouts/2.png | Bin 0 -> 353 bytes .../examples/website/images/icons/callouts/3.png | Bin 0 -> 350 bytes .../examples/website/images/icons/callouts/4.png | Bin 0 -> 345 bytes .../examples/website/images/icons/callouts/5.png | Bin 0 -> 348 bytes .../examples/website/images/icons/callouts/6.png | Bin 0 -> 355 bytes .../examples/website/images/icons/callouts/7.png | Bin 0 -> 344 bytes .../examples/website/images/icons/callouts/8.png | Bin 0 -> 357 bytes .../examples/website/images/icons/callouts/9.png | Bin 0 -> 357 bytes .../examples/website/images/icons/caution.png | Bin 0 -> 2734 bytes .../examples/website/images/icons/example.png | Bin 0 -> 2599 bytes .../examples/website/images/icons/home.png | Bin 0 -> 1340 bytes .../examples/website/images/icons/important.png | Bin 0 -> 2980 bytes .../examples/website/images/icons/next.png | Bin 0 -> 1302 bytes .../examples/website/images/icons/note.png | Bin 0 -> 2494 bytes .../examples/website/images/icons/prev.png | Bin 0 -> 1348 bytes .../asciidoc/examples/website/images/icons/tip.png | Bin 0 -> 2718 bytes .../asciidoc/examples/website/images/icons/up.png | Bin 0 -> 1320 bytes .../examples/website/images/icons/warning.png | Bin 0 -> 3214 bytes .../asciidoc/examples/website/images/smallnew.png | Bin 0 -> 292 bytes .../sb/asciidoc/examples/website/images/tiger.png | Bin 0 -> 6515 bytes .../sb/asciidoc/examples/website/index.txt | 510 ++ .../sb/asciidoc/examples/website/latex-backend.txt | 192 + .../sb/asciidoc/examples/website/latex-bugs.txt | 134 + .../sb/asciidoc/examples/website/latex-filter.txt | 196 + .../sb/asciidoc/examples/website/latexmathml.txt | 41 + .../sb/asciidoc/examples/website/layout1.conf | 153 + .../sb/asciidoc/examples/website/layout1.css | 65 + .../sb/asciidoc/examples/website/layout2.conf | 153 + .../sb/asciidoc/examples/website/layout2.css | 83 + .../sb/asciidoc/examples/website/main.aap | 159 + .../sb/asciidoc/examples/website/manpage.txt | 197 + .../sb/asciidoc/examples/website/music-filter.txt | 148 + .../sb/asciidoc/examples/website/newlists.txt | 40 + .../sb/asciidoc/examples/website/newtables.txt | 743 +++ .../sb/asciidoc/examples/website/plugins.txt | 91 + .../website/publishing-ebooks-with-asciidoc.txt | 398 ++ .../sb/asciidoc/examples/website/slidy-example.txt | 167 + .../sb/asciidoc/examples/website/slidy.txt | 113 + .../examples/website/source-highlight-filter.txt | 270 + .../sb/asciidoc/examples/website/support.txt | 5 + .../sb/asciidoc/examples/website/testasciidoc.txt | 231 + .../sb/asciidoc/examples/website/userguide.txt | 6038 ++++++++++++++++++++ .../sb/asciidoc/examples/website/version83.txt | 37 + .../asciidoc/examples/website/xhtml11-quirks.css | 43 + .../sb/asciidoc/filters/code/code-filter.py | 2 +- source-builder/sb/asciidoc/help.conf | 2 +- source-builder/sb/asciidoc/html4.conf | 39 +- source-builder/sb/asciidoc/html5.conf | 19 +- source-builder/sb/asciidoc/install-sh | 201 + source-builder/sb/asciidoc/lang-cs.conf | 55 - source-builder/sb/asciidoc/lang-pt-BR.conf | 58 + source-builder/sb/asciidoc/lang-ro.conf | 59 - source-builder/sb/asciidoc/latex.conf | 700 +++ source-builder/sb/asciidoc/main.aap | 77 + source-builder/sb/asciidoc/slidy.conf | 150 + .../sb/asciidoc/stylesheets/asciidoc.css | 6 +- .../sb/asciidoc/stylesheets/pygments.css | 64 +- source-builder/sb/asciidoc/tests/asciidocapi.py | 257 + .../sb/asciidoc/tests/data/deprecated-quotes.txt | 12 + .../sb/asciidoc/tests/data/filters-test.txt | 90 + .../sb/asciidoc/tests/data/lang-de-man-test.txt | 21 + .../sb/asciidoc/tests/data/lang-de-test.txt | 106 + .../sb/asciidoc/tests/data/lang-en-man-test.txt | 21 + .../sb/asciidoc/tests/data/lang-en-test.txt | 114 + .../sb/asciidoc/tests/data/lang-es-man-test.txt | 21 + .../sb/asciidoc/tests/data/lang-es-test.txt | 106 + .../sb/asciidoc/tests/data/lang-fr-man-test.txt | 21 + .../sb/asciidoc/tests/data/lang-fr-test.txt | 106 + .../sb/asciidoc/tests/data/lang-hu-man-test.txt | 21 + .../sb/asciidoc/tests/data/lang-hu-test.txt | 106 + .../sb/asciidoc/tests/data/lang-it-man-test.txt | 21 + .../sb/asciidoc/tests/data/lang-it-test.txt | 106 + .../sb/asciidoc/tests/data/lang-nl-man-test.txt | 21 + .../sb/asciidoc/tests/data/lang-nl-test.txt | 94 + .../sb/asciidoc/tests/data/lang-pt-BR-man-test.txt | 21 + .../sb/asciidoc/tests/data/lang-pt-BR-test.txt | 106 + .../sb/asciidoc/tests/data/lang-ru-man-test.txt | 21 + .../sb/asciidoc/tests/data/lang-ru-test.txt | 106 + .../sb/asciidoc/tests/data/lang-uk-man-test.txt | 21 + .../sb/asciidoc/tests/data/lang-uk-test.txt | 106 + .../sb/asciidoc/tests/data/oldtables.txt | 64 + .../sb/asciidoc/tests/data/open-block-test.txt | 117 + .../sb/asciidoc/tests/data/rcs-id-marker-test.txt | 6 + .../sb/asciidoc/tests/data/testcases.conf | 12 + .../sb/asciidoc/tests/data/testcases.txt | 786 +++ .../sb/asciidoc/tests/data/utf8-bom-test.txt | 9 + .../sb/asciidoc/tests/data/utf8-examples.txt | 217 + source-builder/sb/asciidoc/tests/testasciidoc.conf | 652 +++ source-builder/sb/asciidoc/tests/testasciidoc.py | 420 ++ source-builder/sb/asciidoc/text.conf | 16 + source-builder/sb/asciidoc/themes/flask/flask.css | 597 ++ .../sb/asciidoc/themes/volnitsky/volnitsky.css | 435 ++ .../sb/asciidoc/vim/ftdetect/asciidoc_filetype.vim | 53 + source-builder/sb/asciidoc/vim/syntax/asciidoc.vim | 173 + source-builder/sb/asciidoc/wordpress.conf | 88 + source-builder/sb/asciidoc/xhtml11.conf | 8 +- 213 files changed, 52186 insertions(+), 202 deletions(-) create mode 100644 source-builder/sb/asciidoc/BUGS create mode 100644 source-builder/sb/asciidoc/BUGS.txt create mode 100644 source-builder/sb/asciidoc/CHANGELOG create mode 100644 source-builder/sb/asciidoc/CHANGELOG.txt create mode 100644 source-builder/sb/asciidoc/COPYING create mode 100644 source-builder/sb/asciidoc/INSTALL create mode 100644 source-builder/sb/asciidoc/INSTALL.txt create mode 100644 source-builder/sb/asciidoc/MANIFEST create mode 100644 source-builder/sb/asciidoc/Makefile.in create mode 100644 source-builder/sb/asciidoc/README create mode 100644 source-builder/sb/asciidoc/README.txt create mode 100755 source-builder/sb/asciidoc/a2x.py create mode 100644 source-builder/sb/asciidoc/asciidocapi.py create mode 100755 source-builder/sb/asciidoc/configure create mode 100644 source-builder/sb/asciidoc/configure.ac create mode 100644 source-builder/sb/asciidoc/dblatex/asciidoc-dblatex.sty create mode 100644 source-builder/sb/asciidoc/dblatex/asciidoc-dblatex.xsl create mode 100644 source-builder/sb/asciidoc/dblatex/dblatex-readme.txt create mode 100644 source-builder/sb/asciidoc/doc/a2x.1 create mode 100644 source-builder/sb/asciidoc/doc/a2x.1.txt create mode 100644 source-builder/sb/asciidoc/doc/article-docinfo.xml create mode 100644 source-builder/sb/asciidoc/doc/article.pdf create mode 100644 source-builder/sb/asciidoc/doc/article.txt create mode 100644 source-builder/sb/asciidoc/doc/asciidoc.1 create mode 100644 source-builder/sb/asciidoc/doc/asciidoc.1.txt create mode 100644 source-builder/sb/asciidoc/doc/asciidoc.conf create mode 100644 source-builder/sb/asciidoc/doc/asciidoc.dict create mode 100644 source-builder/sb/asciidoc/doc/asciidoc.txt create mode 100644 source-builder/sb/asciidoc/doc/asciidocapi.txt create mode 100644 source-builder/sb/asciidoc/doc/asciimathml.txt create mode 100644 source-builder/sb/asciidoc/doc/book-multi.txt create mode 100644 source-builder/sb/asciidoc/doc/book.epub create mode 100644 source-builder/sb/asciidoc/doc/book.txt create mode 100644 source-builder/sb/asciidoc/doc/customers.csv create mode 100644 source-builder/sb/asciidoc/doc/epub-notes.txt create mode 100644 source-builder/sb/asciidoc/doc/faq.txt create mode 100644 source-builder/sb/asciidoc/doc/images/icons/README create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/1.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/10.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/11.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/12.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/13.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/14.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/15.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/2.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/3.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/4.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/5.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/6.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/7.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/8.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/callouts/9.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/caution.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/example.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/home.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/important.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/next.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/note.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/prev.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/tip.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/up.png create mode 100644 source-builder/sb/asciidoc/doc/images/icons/warning.png create mode 100644 source-builder/sb/asciidoc/doc/images/smallnew.png create mode 100644 source-builder/sb/asciidoc/doc/images/tiger.png create mode 100644 source-builder/sb/asciidoc/doc/latex-backend.txt create mode 100644 source-builder/sb/asciidoc/doc/latex-bugs.txt create mode 100644 source-builder/sb/asciidoc/doc/latex-filter.pdf create mode 100644 source-builder/sb/asciidoc/doc/latex-filter.txt create mode 100644 source-builder/sb/asciidoc/doc/latexmath.txt create mode 100644 source-builder/sb/asciidoc/doc/latexmathml.txt create mode 100644 source-builder/sb/asciidoc/doc/main.aap create mode 100644 source-builder/sb/asciidoc/doc/music-filter.pdf create mode 100644 source-builder/sb/asciidoc/doc/music-filter.txt create mode 100644 source-builder/sb/asciidoc/doc/publishing-ebooks-with-asciidoc.txt create mode 100644 source-builder/sb/asciidoc/doc/slidy-example.txt create mode 100644 source-builder/sb/asciidoc/doc/slidy.txt create mode 100644 source-builder/sb/asciidoc/doc/source-highlight-filter.pdf create mode 100644 source-builder/sb/asciidoc/doc/source-highlight-filter.txt create mode 100644 source-builder/sb/asciidoc/doc/testasciidoc.txt create mode 100644 source-builder/sb/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt create mode 100644 source-builder/sb/asciidoc/docbook-xsl/chunked.xsl create mode 100644 source-builder/sb/asciidoc/docbook-xsl/common.xsl create mode 100644 source-builder/sb/asciidoc/docbook-xsl/epub.xsl create mode 100644 source-builder/sb/asciidoc/docbook-xsl/fo.xsl create mode 100644 source-builder/sb/asciidoc/docbook-xsl/htmlhelp.xsl create mode 100644 source-builder/sb/asciidoc/docbook-xsl/manpage.xsl create mode 100644 source-builder/sb/asciidoc/docbook-xsl/text.xsl create mode 100644 source-builder/sb/asciidoc/docbook-xsl/xhtml.xsl create mode 100644 source-builder/sb/asciidoc/docbook45.conf create mode 100644 source-builder/sb/asciidoc/examples/website/ASCIIMathML.js create mode 100644 source-builder/sb/asciidoc/examples/website/CHANGELOG.txt create mode 100644 source-builder/sb/asciidoc/examples/website/INSTALL.txt create mode 100644 source-builder/sb/asciidoc/examples/website/LaTeXMathML.js create mode 100644 source-builder/sb/asciidoc/examples/website/README-website.txt create mode 100644 source-builder/sb/asciidoc/examples/website/README.txt create mode 100644 source-builder/sb/asciidoc/examples/website/a2x.1.txt create mode 100644 source-builder/sb/asciidoc/examples/website/asciidoc-docbook-xsl.txt create mode 100644 source-builder/sb/asciidoc/examples/website/asciidoc-graphviz-sample.txt create mode 100644 source-builder/sb/asciidoc/examples/website/asciidoc.css create mode 100644 source-builder/sb/asciidoc/examples/website/asciidoc.js create mode 100644 source-builder/sb/asciidoc/examples/website/asciidocapi.txt create mode 100644 source-builder/sb/asciidoc/examples/website/asciimathml.txt create mode 100755 source-builder/sb/asciidoc/examples/website/build-website.sh create mode 100644 source-builder/sb/asciidoc/examples/website/customers.csv create mode 100644 source-builder/sb/asciidoc/examples/website/epub-notes.txt create mode 100644 source-builder/sb/asciidoc/examples/website/faq.txt create mode 100644 source-builder/sb/asciidoc/examples/website/images/highlighter.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/README create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/1.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/10.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/11.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/12.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/13.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/14.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/15.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/2.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/3.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/4.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/5.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/6.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/7.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/8.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/callouts/9.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/caution.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/example.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/home.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/important.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/next.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/note.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/prev.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/tip.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/up.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/icons/warning.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/smallnew.png create mode 100644 source-builder/sb/asciidoc/examples/website/images/tiger.png create mode 100644 source-builder/sb/asciidoc/examples/website/index.txt create mode 100644 source-builder/sb/asciidoc/examples/website/latex-backend.txt create mode 100644 source-builder/sb/asciidoc/examples/website/latex-bugs.txt create mode 100644 source-builder/sb/asciidoc/examples/website/latex-filter.txt create mode 100644 source-builder/sb/asciidoc/examples/website/latexmathml.txt create mode 100644 source-builder/sb/asciidoc/examples/website/layout1.conf create mode 100644 source-builder/sb/asciidoc/examples/website/layout1.css create mode 100644 source-builder/sb/asciidoc/examples/website/layout2.conf create mode 100644 source-builder/sb/asciidoc/examples/website/layout2.css create mode 100644 source-builder/sb/asciidoc/examples/website/main.aap create mode 100644 source-builder/sb/asciidoc/examples/website/manpage.txt create mode 100644 source-builder/sb/asciidoc/examples/website/music-filter.txt create mode 100644 source-builder/sb/asciidoc/examples/website/newlists.txt create mode 100644 source-builder/sb/asciidoc/examples/website/newtables.txt create mode 100644 source-builder/sb/asciidoc/examples/website/plugins.txt create mode 100644 source-builder/sb/asciidoc/examples/website/publishing-ebooks-with-asciidoc.txt create mode 100644 source-builder/sb/asciidoc/examples/website/slidy-example.txt create mode 100644 source-builder/sb/asciidoc/examples/website/slidy.txt create mode 100644 source-builder/sb/asciidoc/examples/website/source-highlight-filter.txt create mode 100644 source-builder/sb/asciidoc/examples/website/support.txt create mode 100644 source-builder/sb/asciidoc/examples/website/testasciidoc.txt create mode 100644 source-builder/sb/asciidoc/examples/website/userguide.txt create mode 100644 source-builder/sb/asciidoc/examples/website/version83.txt create mode 100644 source-builder/sb/asciidoc/examples/website/xhtml11-quirks.css create mode 100755 source-builder/sb/asciidoc/install-sh delete mode 100644 source-builder/sb/asciidoc/lang-cs.conf create mode 100644 source-builder/sb/asciidoc/lang-pt-BR.conf delete mode 100644 source-builder/sb/asciidoc/lang-ro.conf create mode 100644 source-builder/sb/asciidoc/latex.conf create mode 100644 source-builder/sb/asciidoc/main.aap create mode 100644 source-builder/sb/asciidoc/slidy.conf create mode 100644 source-builder/sb/asciidoc/tests/asciidocapi.py create mode 100644 source-builder/sb/asciidoc/tests/data/deprecated-quotes.txt create mode 100644 source-builder/sb/asciidoc/tests/data/filters-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-de-man-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-de-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-en-man-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-en-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-es-man-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-es-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-fr-man-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-fr-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-hu-man-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-hu-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-it-man-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-it-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-nl-man-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-nl-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-pt-BR-man-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-pt-BR-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-ru-man-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-ru-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-uk-man-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/lang-uk-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/oldtables.txt create mode 100644 source-builder/sb/asciidoc/tests/data/open-block-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/rcs-id-marker-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/testcases.conf create mode 100644 source-builder/sb/asciidoc/tests/data/testcases.txt create mode 100644 source-builder/sb/asciidoc/tests/data/utf8-bom-test.txt create mode 100644 source-builder/sb/asciidoc/tests/data/utf8-examples.txt create mode 100644 source-builder/sb/asciidoc/tests/testasciidoc.conf create mode 100755 source-builder/sb/asciidoc/tests/testasciidoc.py create mode 100644 source-builder/sb/asciidoc/text.conf create mode 100644 source-builder/sb/asciidoc/themes/flask/flask.css create mode 100644 source-builder/sb/asciidoc/themes/volnitsky/volnitsky.css create mode 100644 source-builder/sb/asciidoc/vim/ftdetect/asciidoc_filetype.vim create mode 100644 source-builder/sb/asciidoc/vim/syntax/asciidoc.vim create mode 100644 source-builder/sb/asciidoc/wordpress.conf (limited to 'source-builder') diff --git a/source-builder/sb/asciidoc/BUGS b/source-builder/sb/asciidoc/BUGS new file mode 100644 index 0000000..8e17177 --- /dev/null +++ b/source-builder/sb/asciidoc/BUGS @@ -0,0 +1,27 @@ + Bugs and Known Problems + + version 8.6.8, 17 July 2012 + __________________________________________________________________ + +1. AsciiDoc + + * A benign warning with will become a reserved keyword in Python 2.6 + sometimes occurs when using Python 2.5 — it’s harmless and will + disappear with Python 3. + * Reported line numbers in diagnostic messages are sometimes wrong. + * Attribute references in macro attribute lists can’t be unescaped + (with the exception of attribute list entry {0}). + * Section numbering is incorrect when outputting HTML from a + multi-part book type document. This is not a biggy since multi-part + books are generally processed to DocBook. + * A row of apostrophes in an inline context throws AsciiDoc into an + endless loop. The problem seems to be in the input file Reader. + __________________________________________________________________ + +2. dblatex + + See ./dblatex/dblatex-readme.txt. + __________________________________________________________________ + + Version 8.6.8 + Last updated 2011-11-10 09:23:10 NZDT diff --git a/source-builder/sb/asciidoc/BUGS.txt b/source-builder/sb/asciidoc/BUGS.txt new file mode 100644 index 0000000..b74c1a2 --- /dev/null +++ b/source-builder/sb/asciidoc/BUGS.txt @@ -0,0 +1,20 @@ +Bugs and Known Problems +======================= + +AsciiDoc +-------- +- A benign warning 'with will become a reserved keyword + in Python 2.6' sometimes occurs when using Python 2.5 -- it's + harmless and will disappear with Python 3. +- Reported line numbers in diagnostic messages are sometimes wrong. +- Attribute references in macro attribute lists can't be unescaped + (with the exception of attribute list entry `{0}`). +- Section numbering is incorrect when outputting HTML from a + multi-part book type document. This is not a biggy since multi-part + books are generally processed to DocBook. +- A row of apostrophes in an inline context throws AsciiDoc into an + endless loop. The problem seems to be in the input file 'Reader'. + +dblatex +------- +See `./dblatex/dblatex-readme.txt`. diff --git a/source-builder/sb/asciidoc/CHANGELOG b/source-builder/sb/asciidoc/CHANGELOG new file mode 100644 index 0000000..8d260e5 --- /dev/null +++ b/source-builder/sb/asciidoc/CHANGELOG @@ -0,0 +1,3291 @@ + AsciiDoc ChangeLog + + version 8.6.8, 17 July 2012 + __________________________________________________________________ + +1. Version 8.6.8 (2012-07-17) + + Release highlights + Added full complement of styles to Open Blocks and Normal Paragraphs — + those with a minimalist bent could construct virtually any document + using just Title, Normal Paragraph and Open Block syntaxes. + + Other additions and changes + * Increased default maximum include depth from 5 to 10. + * Emit warning if maximum include depth is exceeded. + * Suppress repeated console messages. + * Music filter: removed --beams=None option from abc2ly invocation + because it is broken on LilyPond 2.14 (Ubuntu 12.04). + * Replaced obsolete tag with in HTML backends. + * Allow configuration attribute entries to create a new section + (previously you could only modify existing sections). See: + [1]discussion list. + * Documented {wj} (word-joiner) attribute and updated FAQ. See: + [2]discussion list. + * FAQ: Added How can I place a footnote immediately following quoted + text? See [3]discussion list. + * Added Greek language configuration file. Contributed by Michael + Dourmousoglou. See [4]discussion list. + * FAQ: Added Using roles to select fonts for PDF. Submitted by Lex + Trotman and based on solution by Antonio Borneo. See: [5]discussion + list. + * Apply same monospaced font size to all monospaced text. + * Changed 0 number padding to spaces in numbered GNU source-highlight + outputs. + * Allow highlight source highlighter to use python for Python + {language} name. r1142: Update the AsciiDoc source filter to allow + the use of the highlight source code highlighter. See [6]discussion + list. + + Note + The pygments attribute has been deprecated in favor of the new + source-highlighter attribute. + * Vim syntax highlighter: Don’t confuse trailing open block delimiter + with section underline. + * Added skip option to paragraphs (c.f. Delimited Block skip option). + + Bug fixes + * FIXED: latex, music and graphviz filters: When the filter output + image is data-uri encoded write it to the indir (instead of the + outdir) so that encoder can find it. See [7]discussion list. + * FIXED: Escape the ] character inside inline macros. See + [8]discussion list. + * FIXED: source highlighter filter: Pass role attribute to HTML + backends. + * FIXED: source highlight filter: docbook backend: role attribute was + not passed to listings without a title. Patch submitted by Lex + Trotman. See [9]discussion list. + * FIXED: music2png.py: FOPException: Raster ByteInterleavedRaster + error (FOP 1.0, ImageMagick 6.6.9-7). + __________________________________________________________________ + +2. Version 8.6.7 (2012-03-17) + + Release highlights + No major enhancements but quite a few bug fixes which, among other + things, fixes Jython compatibility and improves Windows compatibility. + + All additions and changes + * Vim syntax highlighter: highlight entity refs in macro arguments. + * Added files with .asciidoc extension to Vim file type detection. + [10]Patch submitted by Dag Wiers. + * Added replacement3 substitution to enable [11]ODT whitespace + processing. + * Added unbreakable option to XHTML and HTML 5 backends. + * Implemented toc::[] block macro and toc-placement attribute for + HTML backends to allow the Table of Contents placement to be set + manually by the author. + * Added FAQs: How can I control page breaks when printing HTML + outputs? and Is it possible to reposition the Table of Contents in + HTML outputs?. + * Added --backend and --backend-opts options to the a2x command to + allow a2x to use backend plugin code extensions. [12]Patch + submitted by Lex Trotman. + * Added [13]args block attribute to source highlight blocks to allow + arbitrary parameters to be passed to the source highlighters. + * If the ascii-ids attribute is defined then non-ascii characters in + auto-generated IDs [14]are replaced by their nearest ascii + equivalents (to work around DocBook processor limitations). + * Added global blockname attribute which is dynamically updated to + identify the current block. See [15]discussion list. + * xhtml11, html5 backends: Include book part TOC entries for + multi-part books. Patch submitted by Loïc Paillotin. + * Removed code filter example from the AsciiDoc User Guide so that + backends implemented as external plugins can compile the manual. + See [16]discussion list. + * If the delimited block skip option is set then do not consume block + title and attributes. This makes it possible for the comment + delimited blocks to use an attribute list (previously the comment + delimited block was hardwired to skip preceding attributes and + titles). See [17]discussion list. + * Added backend-confdir intrinsic attribute. + + Bug fixes + * FIXED: slidy backend: broken stylesheet attribute. [18]Patch + submitted by Micheal Hackett. + * FIXED: Restored [19]missing themes to zip file distribution + archive. + * FIXED: Grammatical error in error messages. [20]Patch submitted by + Dag Wieers. + * FIXED: Use configured normal substitution in preference to the + default one. + * FIXED: The eval block macro would execute multiple times if it + evaluated to None. + * FIXED: Duplicated entries in TOC of large document. [21]Patch + submitted by Sebastien Helleu. + * FIXED: Python 2.4 backward [22]incompatibility. + * FIXED: 8.6.6 regression broke Jython compatibility. See + [23]discussion list. + * FIXED: Leaky file handles in a2x and music and latex filters which + created incompatibility problems for Jython. + * FIXED: All Python filters are executed with the same Python + interpreter that executes the asciidoc parent (previously filters + were hardwired to execute the python interpreter). This prevents + [24]Python mix-ups. + * FIXED: Microsoft Windows shelled command-line truncation that + caused shelled commands to fail e.g. the data-uri attribute + failure. + __________________________________________________________________ + +3. Version 8.6.6 (2011-09-04) + + Release highlights + * The AsciiDoc plugin architecture has been enhanced, unified and + extended: + + Plugin commands have been added to the asciidoc(1) --backend + option. + + An asciidoc(1) --theme option has been implemented to specify + a theme and to manage theme plugins. + + A plugin build command (for creating plugins) added. + + build, install, list and remove plugin commands are all + recognized by asciidoc(1) --backend, --filter and --theme + options. + * A security update by Kenny MacDermid removes the use of eval() on + untrusted input (to disallow code malicious execution). + + All additions and changes + * xhtml11, html5: Made verse and quote block text darker to print + legibly in Google Chrome browser. + * Added plugin build command for plugin file creation. + * Merged --help plugins back to --help manpage so it matches the + asciidoc(1) manpage. + * The --filter command-line option can specify the name of filters + that will be unconditionally loaded. + * If a filter directory contains a file named __noautoload__ then the + filter is not automatically loaded (you can used the --filter + command-line option to override this behavior). + * tests: Add Italian language tests. Patch submitted by Simon + Ruderich. See: + [25]http://groups.google.com/group/asciidoc/browse_thread/thread/5e + 2e6f4dd740d51a + * tests: Add tests for localized man pages. Patch submitted by Simon + Ruderich. See: + [26]http://groups.google.com/group/asciidoc/browse_thread/thread/5e + 2e6f4dd740d51a + * If the section name is prefixed with a + character then the section + contents is appended to the contents of an already existing + same-named section (the default behavior is to replace the the + section). + * If a configuration file section named docinfo is loaded then it + will be included in the document header. Typically the docinfo + section name will be prefixed with a + character so that it is + appended to (rather than replace) other docinfo sections. + * Added {sp} intrinsic attribute for single space character. See + [27]http://groups.google.com/group/asciidoc/browse_thread/thread/a8 + 39aa01db0765d2 + * Fixed TOC and footnotes generator. Patch submitted by Will. See + [28]http://groups.google.com/group/asciidoc/browse_thread/thread/73 + 4ac5afed736987 + * The asciidoc-confdir attribute is set to the asciidoc executable + directory if it contains global configuration files i.e. a local + asciidoc installation. + * asciidoc now throws an error instead of just a warning of the + backend configuration file is not found. + * latex filter: write MD5 file after successful PNG file generation. + Always delete temp files irrespective of outcome. + * Added truecolor option to LaTeX filter. Patch submitted by Michel + Krämer. See: + [29]http://groups.google.com/group/asciidoc/browse_thread/thread/64 + 36788a10561851 + * Unit test for table column specifiers with merged cells. Patch + submitted by Simon Ruderich. See: + [30]http://groups.google.com/group/asciidoc/browse_thread/thread/c9 + 238380a1f2507a + * Added verbose message for ifeval::[] macro evaluation. + * Added test case for ifeval::[] evaluation. + * Security update to remove the use of eval() on untrusted input (to + disallow code malicious execution). Patch submitted by Kenny + MacDermid. + * Changed web site layout from table to CSS based. See + [31]http://groups.google.com/group/asciidoc/browse_thread/thread/ec + 8e8481eb0e27b0/d1c035092b5bb7a4?lnk=gst&q=caption+option#d1c035092b + 5bb7a4 + * a2x: Pass --format option value to asciidoc as a2x-format + attribute. Patch submitted by Lex Trotman + ([32]http://groups.google.com/group/asciidoc/browse_thread/thread/3 + e177b84bc133ca9/659796dfadad30ea?lnk=gst&q=a2x+format#659796dfadad3 + 0ea). + * Added two FAQs submitted by Lex Trotman. See: + [33]http://groups.google.com/group/asciidoc/browse_thread/thread/16 + d3fb9672a408e7 + * html5,xhtml11: Implemented themes directory structure. + * html5,xhtml11: Implemented asciidoc --theme management option + (install, list, build and remove commands). + * html5,xhtml11: A theme can now optionally include a JavaScript file + .js + * html5,xhtml11: If the data-uri attribute is defined then icons from + the theme icons directory (if they exist) will be embedded in the + generated document. + * Added optional warnings argument to include macros. + * The asciidoc --verbose option now prints file inclusion messages. + * xhtml11, html5: Remove necessity for separate manpage CSS files. + * Added css-signature attribute to tests. + * Add css-signature attribute to set a CSS signature for the + document. Patch submitted by Peg Russell, see: + [34]http://groups.google.com/group/asciidoc/browse_thread/thread/ba + cbf8aeb8ad6a3a + * White background for toc2 TOC viewport so that horizontally + scrolled content does not obscure the the TOC. Patch submitted by + Lionel Orry, see: + [35]http://code.google.com/p/asciidoc/issues/detail?id=8 + + Bug fixes + * FIXED: Plugin install command: Delete backend directory is install + fails. + * FIXED: Plugin install command: Fixed bug extracting binary files on + Windows (reported by Jean-Michel Inglebert). + * FIXED: tests: Skip blank sections in testasciidoc.conf test + configuration file instead of throwing an exception (reported by + Jean-Michel Inglebert). + * FIXED: If a plugin Zip file does not contain file permissions + (probably because it was created under Windows) then install it + using the default permissions. + * FIXED: Fixed missing quote in preceding LaTeX filter patch. Fix + submitted by Simon Ruderich. See: + [36]http://groups.google.com/group/asciidoc/browse_thread/thread/64 + 36788a10561851 + * FIXED: Some path attributes were processed as escaped Python + strings which could result in corrupted path names with backslash + separated Windows path names. Reported by Will. See: + [37]http://groups.google.com/group/asciidoc/browse_thread/thread/e8 + f3938bcb4c8bb4/44d13113a35738ef + * FIXED: Vertically spanned table cells resulted in incorrect column + styles being applied to some cells. Reported by Will: + [38]http://groups.google.com/group/asciidoc/browse_thread/thread/c9 + 238380a1f2507a/9afc4559d51e1dbd + * FIXED: LaTeX backend: fixed bad escapes. Patch submitted by Mark + McCurry: + [39]http://groups.google.com/group/asciidoc/browse_thread/thread/8c + 111f1046b33691/158a944cf4d5ff0d?lnk=gst&q=latex+escapes#158a944cf4d + 5ff0d + * FIXED: When using slidy backend, display of characters with accents + is wrong because of meta http-equiv line missing. Reported by + Fabrice Flore-Thebault. See: + [40]http://groups.google.com/group/asciidoc/browse_thread/thread/ea + f25f21d1da180a + __________________________________________________________________ + +4. Version 8.6.5 (2011-05-20) + + Release highlights + * The addition of an html5 backend to generate HTML 5 output. Apart + from the inclusion of audio and video block macros the html5 + backend is functionally identical to the xhtml11 backend. + * A new flask theme for xhtml11 and html5 backends inspired by the + [41]Flask website styling (see toc2 example in the next item + below). + * The new toc2 attribute generates a table of contents in the left + hand margin (xhtml11 and html5 backends). [42]This example was + generated using the following command: + asciidoc -b html5 -a icons -a toc2 -a theme=flask article.txt + * a2x(1) now has a flexible mechanism for copying arbitrary resource + files to HTML based outputs — this is very handy for generating + EPUB files with embedded fonts and other resources. + + The a2x(1) --resource option can be used to inject any file + into EPUB output documents e.g. CSS resources such as fonts + and background images. + + Explicitly specified resources are added to the EPUB OPF + manifest automatically. + + You can explicitly specify file extension MIME types. + + The enhanced resource processing works around a couple of + DocBook XSL bugs (see [43]EPUB Notes). + + All additions and changes + * A new flask theme for xhtml11 and html5 backends. A shameless + knock-off of the [44]Flask website styling. + * Added HTML 5 article with toc2 table of contents to the example on + the AsciiDoc website home page. + * Added filters and topics help topics. Fixed documentation errors in + help text. Patch submitted by Lionel Orry, see: + [45]http://groups.google.com/group/asciidoc/browse_thread/thread/9d + a9d48a6461ff14 + * Pass parent configuration files, command-line attributes and header + attributes to table asciidoc filters. Based on patch submitted by + Simon Ruderich, see: + [46]http://groups.google.com/group/asciidoc/browse_thread/thread/5c + 792cbb395b753b + * Allow a title attribute entry in the document header so that HTML + backends can set the title element separately from the displayed + document title (the doctitle attribute). + * Pass lang attribute to asciidoc table style filter. Patch submitted + by Simon Ruderich, see: + [47]http://groups.google.com/group/asciidoc/browse_thread/thread/e2 + 100b7cb29283ce + * xhtml11,html5: Added toc2 attribute which generates a scrollable + table of contents in the left hand margin. Based on customized CSS + written by Suraj Kurapati, see + [48]http://groups.google.com/group/asciidoc/browse_thread/thread/c5 + e30ee5555877f5 + * Added asciidoc-confdir intrinsic attribute which expands to the + global conf directory. + * Documented that you can specify multiple CSS files with the a2x(1) + --stylesheet command option. See: + [49]http://groups.google.com/group/asciidoc/browse_thread/thread/ba + f3218551d05a05 + * Improved xhtml11 backend’s table of contents generation latency. + Patch submitted by Hongli Lai. See: + [50]http://groups.google.com/group/asciidoc/browse_thread/thread/5a + 7fe64fbfd65ad + * Added html5 backend. + * For consistency converted all DOS formatted configuration and text + files to UNIX format. + * html4: Added ability to use role attribute with most block + elements. Patch contributed by Simon Ruderich. See + [51]http://groups.google.com/group/asciidoc/browse_thread/thread/56 + 20ba634fdb030a + * Added Dutch language configuration file and accompanying test file + (contributed by Dag Wieers, see + [52]http://groups.google.com/group/asciidoc/browse_thread/thread/f9 + 69b9ce987d7f5d). + * Configuration files are loaded in two passes when the -e + command-line option is used (the same behavior as when the -e + option is not used). Patch submitted by haad. See + [53]http://groups.google.com/group/asciidoc/browse_thread/thread/cd + 0f47495fd04181 and + [54]http://code.google.com/p/asciidoc/issues/detail?id=6&q=label%3A + Priority-Medium + * Documented how to include embedded fonts in an EPUB document. + * a2x: Added .= resource specifier syntax. + * a2x: Enable admonition icons in example EPUBs. + * a2x: allow environment variables and tilde home directories in + resource manifest files. + * a2x: don’t process non-existent resource directories. + * a2x: assume resource option is a directory if the name ends with a + directory separator. + * a2x: Added a new syntax to the --resource option specifier which + allows the destination path to be specified. + * a2x: Copy resources referenced in the OPF and resources referenced + by the generated HTML (in theory DocBook XSL should ensure they are + identical but this is not always the case e.g. + [55]http://sourceforge.net/tracker/?func=detail&atid=373747&aid=285 + 4075&group_id=21935). + * Drop border from callout list image links. + * html4: Moved manpage NAME section out of header so that the name + section is rendered when the asciidoc(1) --no-header-footer option + is specified (so that manpages processed blogpost include the NAME + section). + * Vim syntax highlighter: TODO markers now appear in list items and + literal paragraphs and blocks. + * Constrained quotes can now be bounded on the left by a } character. + See: + [56]http://groups.google.com/group/asciidoc/browse_thread/thread/b2 + 4cc3362f35b801 + * Added text-decoration roles (underline, overline, line-through, + blink) for xhtml11 and html5 outputs. + + Bug fixes + * FIXED: epubcheck 1.1 previously issued a warning for files not + registered in the manifest (epubcheck 1.0.5 did not). This resulted + in a problem compiling the adventures-of-sherlock-holmes.txt + example (the underline.png resource was not in the manifest). + __________________________________________________________________ + +5. Version 8.6.4 (2011-02-20) + + Additions and changes + * Added text foreground and background color along with text size CSS + styles for XHTML outputs, see + [57]http://www.methods.co.nz/asciidoc/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 + [58]http://groups.google.com/group/asciidoc/browse_thread/thread/77 + f28b0dfe60d262). + * Implemented [59]asciidoc(1) filter commands, see: + [60]http://groups.google.com/group/asciidoc/browse_thread/thread/40 + c64cd33ee1905c + * 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: + [61]http://groups.google.com/group/asciidoc/browse_thread/thread/e1 + 5282f072413940 + * 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: + [62]http://groups.google.com/group/asciidoc/browse_thread/thread/5a + c8e8ea895147e9 + * 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 + [63]http://groups.google.com/group/asciidoc/browse_thread/thread/e1 + 5282f072413940 + * 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: + [64]http://groups.google.com/group/asciidoc/browse_thread/thread/e1 + 5282f072413940 + * Implemented conf-files attribute to allow configuration files to be + specified in the source document. Suggested by Lex Trotman, see: + [65]http://groups.google.com/group/asciidoc/browse_thread/thread/b1 + 1066a828ab45b9 + + 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: + [66]http://groups.google.com/group/asciidoc/browse_thread/thread/a1 + dd0562dee8b939 + * 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: + [67]http://groups.google.com/group/asciidoc/browse_thread/thread/f4 + 4615dca0b834e9 + __________________________________________________________________ + +6. 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 + [68]http://groups.google.com/group/asciidoc/browse_thread/thread/1b + 3f88f1f8118ab3 + * 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 + [69]http://groups.google.com/group/asciidoc/browse_thread/thread/c2 + 1c2902c29bae64 + + Bug fixes + * FIXED: Sometimes double backquotes were misinterpreted as inline + literal macros. See: + [70]http://groups.google.com/group/asciidoc/browse_thread/thread/f5 + 10ea82a88aaee8 + * 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 + [71]http://groups.google.com/group/asciidoc/browse_thread/thread/42 + b63ce90c2563b8 + * FIXED: The XSL Stylesheets customizations were preventing chapter + and section level TOCs from being generated when using XSL + Stylesheets via a2x. See + [72]http://groups.google.com/group/asciidoc/browse_thread/thread/42 + b63ce90c2563b8 + * FIXED: “UnicodeDecodeError: 'ascii' codec can’t decode byte” error. + This error is due to a limitation in the Python HTMLParser module, + see: [73]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: + [74]http://groups.google.com/group/asciidoc/browse_thread/thread/de + dc961b23e9ac56 + * 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. + __________________________________________________________________ + +7. 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 + [75]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: + [76]http://groups.google.com/group/asciidoc/browse_thread/thread/c1 + 4a4c3b1e4f6dc5 + * Added two more docinfo attributes docinfo1 and docinfo2 to allow + and control inclusion of a shared docinfo file. See + [77]http://groups.google.com/group/asciidoc/browse_thread/thread/c9 + 48697943432e24 + * Vim syntax highlighter highlights multi-name conditional + attributes. + * LaTeX backend patch submitted by Andreas Hermann Braml (see + [78]http://groups.google.com/group/asciidoc/browse_thread/thread/1c + 415fc4540ce5e5). + * 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: + [79]http://groups.google.com/group/asciidoc/browse_thread/thread/87 + 12a95e95a292a7 + * 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 + [80]http://groups.google.com/group/asciidoc/browse_thread/thread/c4 + 427a3902d130a8 + * 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: + [81]http://groups.google.com/group/asciidoc/browse_thread/thread/59 + a610068e4acb58 + __________________________________________________________________ + +8. 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). + + 8.1. 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 + [82]http://groups.google.com/group/asciidoc/browse_thread/thread/b22603 + bfb879418c. + __________________________________________________________________ + +9. 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 + ([83]http://groups.google.com/group/asciidoc/browse_thread/thread/1 + c02d27d49221aa2). + * Relaxed anchor ID name syntax + ([84]http://groups.google.com/group/asciidoc/browse_thread/thread/5 + f3e825c74ed30c). + * 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 ([85]http://pygments.org/) option added to source code + highlight filter. Based on Pygments source code filter written by + David Hajage + ([86]http://groups.google.com/group/asciidoc/browse_thread/thread/d + 8d042f5a3021369/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 + [87]http://groups.google.com/group/asciidoc/browse_frm/thread/319e5 + cd94493e330/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: + [88]http://groups.google.com/group/asciidoc/browse_frm/thread/fe9b3 + 3d8f5f1e0af 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 + [89]http://groups.google.com/group/asciidoc/browse_frm/thread/8eda3 + ea812968854 + * Document attribute names are case insensitive everywhere, this + makes using attribute entries more consistent e.g. previously + :VERS: had to be refered to + * Hungarian translation of footer-text (submitted by Miklos Vajna). + See + [90]http://groups.google.com/group/asciidoc/browse_frm/thread/7174c + b7598993c72# + * asciidocapi.py 0.1.2: Can now load AsciiDoc script named asciidoc. + See + [91]http://groups.google.com/group/asciidoc/browse_frm/thread/66e7b + 59d12cd2f91 Based on patch submitted by Phillip Lord. + * German translation of footer-text (submitted by Simon Ruderich). + See + [92]http://groups.google.com/group/asciidoc/browse_frm/thread/7174c + b7598993c72 + * Pushed HTML footer text into language conf files with the + introduction of a [footer-text] configuration file template + section. See + [93]http://groups.google.com/group/asciidoc/browse_frm/thread/7174c + b7598993c72 + + Bug fixes + * FIXED: Sometimes multiple double quoted text elements in the same + paragraph were mistakenly seen as starting with an inline literal. + See + [94]http://groups.google.com/group/asciidoc/browse_frm/thread/219c8 + 6ae25b79a21 + * 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 + [95]http://groups.google.com/group/asciidoc/browse_frm/thread/af652 + 507caf6cec9 + * FIXED: Missing selector for List of examples title in DocBook CSS + file. Patch submitted by Laurent Laville. See + [96]http://groups.google.com/group/asciidoc/browse_frm/thread/3f969 + 00f7fbf5620 + * FIXED: Broken accents in lang-hu.conf. See: + [97]http://groups.google.com/group/asciidoc/browse_frm/thread/7174c + b7598993c72 + * FIXED: DocBook XSL generated HTML callout lists are properly + aligned. Submitted by Lionel Orry. See + [98]http://groups.google.com/group/asciidoc/browse_frm/thread/2ff80 + 2547b6a75ea + * FIXED: Filter execution now occurs prior to filter markup template + substitution to ensure image data URI encoding happens after image + generation (see + [99]http://groups.google.com/group/asciidoc/browse_thread/thread/14 + e8fcb289a135b). + * FIXED: The section numbers no longer increment when the numbered + attribute is undefined (see + [100]http://groups.google.com/group/asciidoc/browse_thread/thread/f + aa36e9e5c7da019/d24cab3fe363e58d). + __________________________________________________________________ + +10. 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 + [101]http://groups.google.com/group/asciidoc/browse_frm/thread/ac4b + 9bfa2116db28 + * Dropped .hgignore from the repository. See + [102]http://groups.google.com/group/asciidoc/browse_frm/thread/c17a + bd175778f5ea + * Don’t pass verbose options to asciidoc table filter so that + asciidocapi messages are not discarded. See: + [103]http://groups.google.com/group/asciidoc/browse_frm/thread/c17a + bd175778f5ea + * 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: + [104]http://groups.google.com/group/asciidoc/browse_frm/thread/1b6b + 66adb24e710 + * 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. + __________________________________________________________________ + +11. 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: + [105]http://groups.google.com/group/asciidoc/browse_frm/thread/a23f + ea28394c8ca9 + * 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 + [106]http://groups.google.com/group/asciidoc/browse_frm/thread/50b2 + 8f6941de111a + * CSS tweaks so that tables processed by DocBook XSL Stylesheets have + the default asciidoc xhtml11 backend styling. See + [107]http://groups.google.com/group/asciidoc/browse_frm/thread/dfe5 + 204d5b2c9685 + * Block titles take precedence over section titles to avoid titled + delimited blocks being mistaken for two line section titles (see + [108]http://groups.google.com/group/asciidoc/browse_frm/thread/f0b6 + f9989f828c3). + * 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 + [109]http://groups.google.com/group/asciidoc/browse_frm/thread/14ae + fc1cb6bd85f5). + * 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 + [110]http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b + 7694bbc82a6 + * FIXED: Regression issue with inline data-uri images. See + [111]http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b + 7694bbc82a6 + * FIXED: An unexpected error occurred when processing a table + containing CSV data if the cols attribute was not explicitly + specified. See + [112]http://groups.google.com/group/asciidoc/browse_frm/thread/4b0f + 364b477ec165 + __________________________________________________________________ + +12. 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 + [113]http://groups.google.com/group/asciidoc/browse_frm/thread/e5e6 + 1823ff4203cd + * Added AsciiDoc role attribute to quoted text. Sets class attribute + in HTML outputs; role attribute in DocBook outputs. See: + [114]http://groups.google.com/group/asciidoc/browse_frm/thread/2aa3 + e5711d243045 + * 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 + [115]http://groups.google.com/group/asciidoc/browse_frm/thread/5215 + c99dcc865e7d). + * FIXED: An error occurred if a directory in current path with same + name as executable. + + 12.1. 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: + 1. The onload event expression changed. + 2. The new
...
div envelopes document content. + 3. You need to add
...
div to the + [footnotes] section for footnotes to work. + 4. 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: + [116]http://hg.sharesource.org/asciidoc/diff/55a5999bfd04/xhtml11.conf + __________________________________________________________________ + +13. 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 + [117]http://groups.google.com/group/asciidoc/browse_frm/thread/b276 + a927fdc87995 + * Titled listing and literal blocks (DocBook outputs) no longer + default to examples. See + [118]http://groups.google.com/group/asciidoc/browse_frm/thread/f4df + 7c9eec01a9bd + * 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 + [119]http://groups.google.com/group/asciidoc/browse_frm/thread/f4df + 7c9eec01a9bd + * 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 + [120]http://groups.google.com/group/asciidoc/browse_frm/thread/d299 + 24043e21cb6a. + * Added max-width attribute to the xhtml11 backend to set maximum + display width. See + [121]http://groups.google.com/group/asciidoc/browse_frm/thread/74d9 + a542b79ccd50. + * 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 + [122]http://groups.google.com/group/asciidoc/browse_frm/thread/ea3a + 8ea399ae5d2a and + [123]http://groups.google.com/group/asciidoc/browse_frm/thread/69b3 + 183fdab7c6a5 + * 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 + ([124]http://groups.google.com/group/asciidoc/browse_frm/thread/a25 + 4cf949ea7c6c5). + * 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, + [125]http://groups.google.com/group/asciidoc/browse_frm/thread/e1dc + b7ee0efc17b5). + * Normalized path in safe_filename function (submitted by Todd + Zullinger, + [126]http://groups.google.com/group/asciidoc/browse_frm/thread/69b3 + 183fdab7c6a5). + * 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 + [127]http://groups.google.com/group/asciidoc/browse_frm/thread/1bad + ad21ff9447ac. + * 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: + [128]http://groups.google.com/group/asciidoc/browse_frm/thread/a42d + b6bc54c2c537. + * 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 + [129]http://groups.google.com/group/asciidoc/browse_frm/thread/b9c6 + 3be67dd1d11c + * FIXED: Only the first occurrence of passthrough macro was + substituted. Patch submitted by Peter Johnson. See + [130]http://groups.google.com/group/asciidoc/browse_frm/thread/1269 + dc2feb1a482c + * FIXED: asciidoc now runs on Jython 2.5.0. + * FIXED: Wordpress margins and pads in a number of block elements + ([131]http://groups.google.com/group/asciidoc/browse_frm/thread/36f + f073c79cbc20a). + + 13.1. 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 [132]DocBook table widths. + __________________________________________________________________ + +14. 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 + [133]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 + [134]http://groups.google.com/group/asciidoc/browse_thread/thread/4 + bdcdfb0af773e2 + * 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 element. See + [135]http://groups.google.com/group/asciidoc/browse_thread/thread/c + 93bb4db025225d8 + * 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 + [136]http://groups.google.com/group/asciidoc/browse_thread/thread/1 + d796a9c9ddb2855 + * FIXED: Source highlighter now works with Wordpress backend (see + [137]http://groups.google.com/group/asciidoc/browse_thread/thread/6 + d8c716748b109e3). + + 14.1. Regression issues + + 1. 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. + __________________________________________________________________ + +15. 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. + __________________________________________________________________ + +16. 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: + 1. the configuration file is missing. + 2. an illegal backend is specified. + 3. an illegal test number is specified. + + Bug fixes + * Fixed [138]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. + __________________________________________________________________ + +17. Version 8.4.2 (2009-03-19) + + Additions and changes + * Added [139]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). + __________________________________________________________________ + +18. Version 8.4.1 (2009-03-10) + + Additions and changes + * AsciiDoc now has a [140]Python API. The following minimal example + compiles mydoc.txt to mydoc.html: + + 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 + [141]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. + + 18.1. 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= + __________________________________________________________________ + +19. 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. + + 19.1. Compatibility issues + + The roman numbered list parenthesis syntax is incompatible with the + potentially ambiguous roman period syntax introduced in 8.3.2. + __________________________________________________________________ + +20. 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. + __________________________________________________________________ + +21. 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. + __________________________________________________________________ + +22. 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. + __________________________________________________________________ + +23. Version 8.3.1 (2008-12-14) + + Additions and changes + * Replaced the install.sh script with Ben Walton’s updated autoconf + scripts — see [142]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. + __________________________________________________________________ + +24. Version 8.3.0 (2008-11-29) + + Additions and changes + * [143]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. + * [144]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 [145]passthrough macros along with + asciimath and latexmath [146]passthrough blocks provide a (backend + dependent) mechanism for rendering mathematical formulas. There are + [147]LaTeX Math, [148]AsciiMathML and [149]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 -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 $$...$$. + * 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). + + 24.1. 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. + __________________________________________________________________ + +25. 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 [150]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 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 [151]AsciiDoc repository changelog. + __________________________________________________________________ + +26. 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 [152]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. + __________________________________________________________________ + +27. Version 8.2.5 (2007-11-18) + + 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. + __________________________________________________________________ + +28. 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-.conf will be loaded automatically. + * The help file name help-.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. + __________________________________________________________________ + +29. 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 [153]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 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). + __________________________________________________________________ + +30. Version 8.2.2 (2007-07-22) + + Additions and changes + * [154]LaTeXMathML capability has been added for users who are more + familiar with or prefer LaTeX math formulas to the [155]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. + __________________________________________________________________ + +31. 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. + __________________________________________________________________ + +32. 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 + element is not generated (previously generated empty + 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 [156]AsciiDoc home page. + __________________________________________________________________ + +33. 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 + [157]tpl User Guide for a fancier layout. Use the -a toc -a + numbered command-line options to produce a number table of + contents. + * A [158]music filter is included in the distribution ./filters/ + directory. It translates music in [159]LilyPond or [160]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. + __________________________________________________________________ + +34. 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. + + [161]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 [162]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 [163]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 + [164]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. + __________________________________________________________________ + +35. Version 7.1.2 (2006-03-07) + + Additions and changes + * Support for [165]ASCIIMathML has been added. See Appendix I: + ASCIIMathML Support in the User Guide and the examples at + [166]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 [167]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 [168]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. + __________________________________________________________________ + +36. 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). + __________________________________________________________________ + +37. 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. + __________________________________________________________________ + +38. Version 7.0.4 (2005-12-08) + + Additions and changes + * Added ternary conditional attributes + {@:[:]} and + {$:[:]}. + * 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. + __________________________________________________________________ + +39. 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 + [169]Appendix C in the AsciiDoc User Guide). + * Included [170]source-highlight filter in the distribution + ./examples/source-highlight-filter/ directory (based on filter + submitted by [171]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. + __________________________________________________________________ + +40. 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. + __________________________________________________________________ + +41. 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. + __________________________________________________________________ + +42. Version 7.0.0 (2005-06-06) + + This is a major release with many code and documentation changes. + Please report any problems you encounter. + + [172]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 [173]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 [174]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 [175]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 [176]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 [177]David + Greaves. + * Unexpected error following malformed author line error. + __________________________________________________________________ + +43. 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 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. + __________________________________________________________________ + +44. 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. + __________________________________________________________________ + +45. 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 + [178]Fredrik Steen). + * Recoded tempfile.mktemp() and other artifacts that are no longer + necessary or desirable (patches supplied by [179]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. + __________________________________________________________________ + +46. Version 6.0.0 (2005-01-28) + + This release has had some fairly major code and documentation changes. + Please report any problems you encounter. + + [180]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 (
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 + ([181]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 [[[]]] is available, it + displays [] 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. + __________________________________________________________________ + +47. 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 ® to [replacements]. + * CSS stylesheet tweaks. + * Admonitions (Note, Tip, Important, Warning, Caution) include icons + when generating css output. + __________________________________________________________________ + +48. 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. + __________________________________________________________________ + +49. 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: ++,,++. + * Index terms that have secondary and tertiary entries now + additionally generate separate index terms for the secondary and + tertiary entries. + * A ++ 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. + __________________________________________________________________ + +50. 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. + __________________________________________________________________ + +51. 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. + __________________________________________________________________ + +52. 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. + __________________________________________________________________ + +53. 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. + __________________________________________________________________ + +54. Version 5.0.4 (2004-02-09) + + * Reinstated missing infile, outfile, filetype and + filetype- glossary entries. + * As of version 5.0.3 asciidoc(1) now requires Python 2.0 or greater, + this has now been documented. + __________________________________________________________________ + +55. 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. + __________________________________________________________________ + +56. 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. + __________________________________________________________________ + +57. Version 5.0.1 (2003-12-09) + + * Fixed problem with anchor tag when generating CSS styled HTML. + __________________________________________________________________ + +58. Version 5.0 (2003-12-08) + + This release has had some fairly major code and documentation changes. + Please report any problems you encounter. + + [182]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). + __________________________________________________________________ + +59. 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 {%}. + * Double-quote characters can now appear in unquoted positional + arguments. + __________________________________________________________________ + +60. Version 4.1 (2003-11-13) + + * Added DSV (Delimiter Separated Values) tables format. + * {eval:} glossary references drop the containing line if + 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. + __________________________________________________________________ + +61. 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 {!} and + {#}. + * 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. + __________________________________________________________________ + +62. 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 {?}. + is the glossary entry name and is the text + substituted if the glossary entry is defined. 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. + __________________________________________________________________ + +63. 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. + __________________________________________________________________ + +64. 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). + __________________________________________________________________ + +65. 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. + __________________________________________________________________ + +66. 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. + __________________________________________________________________ + +67. 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). + __________________________________________________________________ + +68. 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. + __________________________________________________________________ + +69. Version 1.5 (2003-01-08) + + * Implemented sidebar document elements. + * Explicit checks for user specified configuration files and input + file (rather than throwing exception). + __________________________________________________________________ + +70. 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. + __________________________________________________________________ + +71. 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. + __________________________________________________________________ + +72. 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. + __________________________________________________________________ + +73. 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. + __________________________________________________________________ + +74. Version 1.0 (2002-11-25) + + First AsciiDoc public release along with AsciiDoc web site + ([183]http://www.methods.co.nz/asciidoc/) and SourceForge.net project + registration ([184]https://sourceforge.net/projects/asciidoc/). + __________________________________________________________________ + + Version 8.6.8 + Last updated 2012-07-17 07:24:10 NZST + +References + + 1. https://groups.google.com/group/asciidoc/browse_thread/thread/7be28e9714f249c7 + 2. https://groups.google.com/group/asciidoc/browse_thread/thread/961a957ab5872ebf + 3. https://groups.google.com/group/asciidoc/browse_thread/thread/961a957ab5872ebf + 4. https://groups.google.com/group/asciidoc/browse_thread/thread/9e79d8494ef8d870 + 5. https://groups.google.com/group/asciidoc/browse_frm/thread/64b071bb21de9cf0 + 6. https://groups.google.com/group/asciidoc/browse_frm/thread/e045c9986c71d72a + 7. https://groups.google.com/group/asciidoc/browse_thread/thread/f5174f450a61f14b + 8. https://groups.google.com/group/asciidoc/browse_thread/thread/db3b734a6931cb74 + 9. https://groups.google.com/group/asciidoc/browse_thread/thread/13c9ee97930342b3 + 10. http://groups.google.com/group/asciidoc/browse_thread/thread/a9762e21ec0cc244/5d3a4ebf20e6847e + 11. http://groups.google.com/group/asciidoc/browse_thread/thread/843d7d3d671006fb/25628e14c829db3f + 12. http://groups.google.com/group/asciidoc/browse_thread/thread/b8e93740b7cd0e1d/b5e0b83fe37ae31a + 13. http://groups.google.com/group/asciidoc/browse_thread/thread/3d06b0105dfbb780/8c60eb7a62f522e4 + 14. http://groups.google.com/group/asciidoc/browse_thread/thread/33e99b78e2472122 + 15. http://groups.google.com/group/asciidoc/browse_thread/thread/8200e29815c40f72 + 16. http://groups.google.com/group/asciidoc/browse_thread/thread/849e5ea91f43adf2 + 17. http://groups.google.com/group/asciidoc/browse_thread/thread/e92a75abcc382701 + 18. http://groups.google.com/group/asciidoc/browse_thread/thread/58d0843ae4345afd + 19. http://groups.google.com/group/asciidoc/browse_thread/thread/b0e69e393b6f9f20/47a2c7586f9e40c6?lnk=gst&q=themes+tarball#47a2c7586f9e40c6 + 20. http://groups.google.com/group/asciidoc/browse_thread/thread/b9d705c6b6b39f59/1e120483dafca109 + 21. http://groups.google.com/group/asciidoc/browse_thread/thread/103445ab9d95cb0c + 22. http://code.google.com/p/asciidoc/issues/detail?id=9 + 23. http://groups.google.com/group/asciidoc/browse_thread/thread/4608b77ec289f6c4 + 24. http://groups.google.com/group/asciidoc/browse_thread/thread/14e8fcb289a135b/3af3b4e57b827c78?lnk=gst&q=archlinux#3af3b4e57b827c78 + 25. http://groups.google.com/group/asciidoc/browse_thread/thread/5e2e6f4dd740d51a + 26. http://groups.google.com/group/asciidoc/browse_thread/thread/5e2e6f4dd740d51a + 27. http://groups.google.com/group/asciidoc/browse_thread/thread/a839aa01db0765d2 + 28. http://groups.google.com/group/asciidoc/browse_thread/thread/734ac5afed736987 + 29. http://groups.google.com/group/asciidoc/browse_thread/thread/6436788a10561851 + 30. http://groups.google.com/group/asciidoc/browse_thread/thread/c9238380a1f2507a + 31. http://groups.google.com/group/asciidoc/browse_thread/thread/ec8e8481eb0e27b0/d1c035092b5bb7a4?lnk=gst&q=caption+option#d1c035092b5bb7a4 + 32. http://groups.google.com/group/asciidoc/browse_thread/thread/3e177b84bc133ca9/659796dfadad30ea?lnk=gst&q=a2x+format#659796dfadad30ea + 33. http://groups.google.com/group/asciidoc/browse_thread/thread/16d3fb9672a408e7 + 34. http://groups.google.com/group/asciidoc/browse_thread/thread/bacbf8aeb8ad6a3a + 35. http://code.google.com/p/asciidoc/issues/detail?id=8 + 36. http://groups.google.com/group/asciidoc/browse_thread/thread/6436788a10561851 + 37. http://groups.google.com/group/asciidoc/browse_thread/thread/e8f3938bcb4c8bb4/44d13113a35738ef + 38. http://groups.google.com/group/asciidoc/browse_thread/thread/c9238380a1f2507a/9afc4559d51e1dbd + 39. http://groups.google.com/group/asciidoc/browse_thread/thread/8c111f1046b33691/158a944cf4d5ff0d?lnk=gst&q=latex+escapes#158a944cf4d5ff0d + 40. http://groups.google.com/group/asciidoc/browse_thread/thread/eaf25f21d1da180a + 41. http://flask.pocoo.org/docs/ + 42. file://localhost/tmp/lynxXXXXrCQLhm/article-html5-toc2.html + 43. file://localhost/tmp/lynxXXXXrCQLhm/epub-notes.html + 44. http://flask.pocoo.org/docs/ + 45. http://groups.google.com/group/asciidoc/browse_thread/thread/9da9d48a6461ff14 + 46. http://groups.google.com/group/asciidoc/browse_thread/thread/5c792cbb395b753b + 47. http://groups.google.com/group/asciidoc/browse_thread/thread/e2100b7cb29283ce + 48. http://groups.google.com/group/asciidoc/browse_thread/thread/c5e30ee5555877f5 + 49. http://groups.google.com/group/asciidoc/browse_thread/thread/baf3218551d05a05 + 50. http://groups.google.com/group/asciidoc/browse_thread/thread/5a7fe64fbfd65ad + 51. http://groups.google.com/group/asciidoc/browse_thread/thread/5620ba634fdb030a + 52. http://groups.google.com/group/asciidoc/browse_thread/thread/f969b9ce987d7f5d + 53. http://groups.google.com/group/asciidoc/browse_thread/thread/cd0f47495fd04181 + 54. http://code.google.com/p/asciidoc/issues/detail?id=6&q=label%3APriority-Medium + 55. http://sourceforge.net/tracker/?func=detail&atid=373747&aid=2854075&group_id=21935 + 56. http://groups.google.com/group/asciidoc/browse_thread/thread/b24cc3362f35b801 + 57. http://www.methods.co.nz/asciidoc/userguide.html#X96 + 58. http://groups.google.com/group/asciidoc/browse_thread/thread/77f28b0dfe60d262 + 59. http://www.methods.co.nz/asciidoc/manpage.html + 60. http://groups.google.com/group/asciidoc/browse_thread/thread/40c64cd33ee1905c + 61. http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 + 62. http://groups.google.com/group/asciidoc/browse_thread/thread/5ac8e8ea895147e9 + 63. http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 + 64. http://groups.google.com/group/asciidoc/browse_thread/thread/e15282f072413940 + 65. http://groups.google.com/group/asciidoc/browse_thread/thread/b11066a828ab45b9 + 66. http://groups.google.com/group/asciidoc/browse_thread/thread/a1dd0562dee8b939 + 67. http://groups.google.com/group/asciidoc/browse_thread/thread/f44615dca0b834e9 + 68. http://groups.google.com/group/asciidoc/browse_thread/thread/1b3f88f1f8118ab3 + 69. http://groups.google.com/group/asciidoc/browse_thread/thread/c21c2902c29bae64 + 70. http://groups.google.com/group/asciidoc/browse_thread/thread/f510ea82a88aaee8 + 71. http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8 + 72. http://groups.google.com/group/asciidoc/browse_thread/thread/42b63ce90c2563b8 + 73. http://bugs.python.org/issue3932 + 74. http://groups.google.com/group/asciidoc/browse_thread/thread/dedc961b23e9ac56 + 75. https://phillordbio-asciidoc-fixes.googlecode.com/hg/ + 76. http://groups.google.com/group/asciidoc/browse_thread/thread/c14a4c3b1e4f6dc5 + 77. http://groups.google.com/group/asciidoc/browse_thread/thread/c948697943432e24 + 78. http://groups.google.com/group/asciidoc/browse_thread/thread/1c415fc4540ce5e5 + 79. http://groups.google.com/group/asciidoc/browse_thread/thread/8712a95e95a292a7 + 80. http://groups.google.com/group/asciidoc/browse_thread/thread/c4427a3902d130a8 + 81. http://groups.google.com/group/asciidoc/browse_thread/thread/59a610068e4acb58 + 82. http://groups.google.com/group/asciidoc/browse_thread/thread/b22603bfb879418c + 83. http://groups.google.com/group/asciidoc/browse_thread/thread/1c02d27d49221aa2 + 84. http://groups.google.com/group/asciidoc/browse_thread/thread/5f3e825c74ed30c + 85. http://pygments.org/ + 86. http://groups.google.com/group/asciidoc/browse_thread/thread/d8d042f5a3021369/8934ebbb8cb7144b + 87. http://groups.google.com/group/asciidoc/browse_frm/thread/319e5cd94493e330/3fcb83fab067af42 + 88. http://groups.google.com/group/asciidoc/browse_frm/thread/fe9b33d8f5f1e0af + 89. http://groups.google.com/group/asciidoc/browse_frm/thread/8eda3ea812968854 + 90. http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 + 91. http://groups.google.com/group/asciidoc/browse_frm/thread/66e7b59d12cd2f91 + 92. http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 + 93. http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 + 94. http://groups.google.com/group/asciidoc/browse_frm/thread/219c86ae25b79a21 + 95. http://groups.google.com/group/asciidoc/browse_frm/thread/af652507caf6cec9 + 96. http://groups.google.com/group/asciidoc/browse_frm/thread/3f96900f7fbf5620 + 97. http://groups.google.com/group/asciidoc/browse_frm/thread/7174cb7598993c72 + 98. http://groups.google.com/group/asciidoc/browse_frm/thread/2ff802547b6a75ea + 99. http://groups.google.com/group/asciidoc/browse_thread/thread/14e8fcb289a135b + 100. http://groups.google.com/group/asciidoc/browse_thread/thread/faa36e9e5c7da019/d24cab3fe363e58d + 101. http://groups.google.com/group/asciidoc/browse_frm/thread/ac4b9bfa2116db28 + 102. http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea + 103. http://groups.google.com/group/asciidoc/browse_frm/thread/c17abd175778f5ea + 104. http://groups.google.com/group/asciidoc/browse_frm/thread/1b6b66adb24e710 + 105. http://groups.google.com/group/asciidoc/browse_frm/thread/a23fea28394c8ca9 + 106. http://groups.google.com/group/asciidoc/browse_frm/thread/50b28f6941de111a + 107. http://groups.google.com/group/asciidoc/browse_frm/thread/dfe5204d5b2c9685 + 108. http://groups.google.com/group/asciidoc/browse_frm/thread/f0b6f9989f828c3 + 109. http://groups.google.com/group/asciidoc/browse_frm/thread/14aefc1cb6bd85f5 + 110. http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6 + 111. http://groups.google.com/group/asciidoc/browse_frm/thread/cb8b7694bbc82a6 + 112. http://groups.google.com/group/asciidoc/browse_frm/thread/4b0f364b477ec165 + 113. http://groups.google.com/group/asciidoc/browse_frm/thread/e5e61823ff4203cd + 114. http://groups.google.com/group/asciidoc/browse_frm/thread/2aa3e5711d243045 + 115. http://groups.google.com/group/asciidoc/browse_frm/thread/5215c99dcc865e7d + 116. http://hg.sharesource.org/asciidoc/diff/55a5999bfd04/xhtml11.conf + 117. http://groups.google.com/group/asciidoc/browse_frm/thread/b276a927fdc87995 + 118. http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd + 119. http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd + 120. http://groups.google.com/group/asciidoc/browse_frm/thread/d29924043e21cb6a + 121. http://groups.google.com/group/asciidoc/browse_frm/thread/74d9a542b79ccd50 + 122. http://groups.google.com/group/asciidoc/browse_frm/thread/ea3a8ea399ae5d2a + 123. http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5 + 124. http://groups.google.com/group/asciidoc/browse_frm/thread/a254cf949ea7c6c5 + 125. http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5 + 126. http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5 + 127. http://groups.google.com/group/asciidoc/browse_frm/thread/1badad21ff9447ac + 128. http://groups.google.com/group/asciidoc/browse_frm/thread/a42db6bc54c2c537 + 129. http://groups.google.com/group/asciidoc/browse_frm/thread/b9c63be67dd1d11c + 130. http://groups.google.com/group/asciidoc/browse_frm/thread/1269dc2feb1a482c + 131. http://groups.google.com/group/asciidoc/browse_frm/thread/36ff073c79cbc20a + 132. http://www.methods.co.nz/asciidoc/userguide.html#X89 + 133. http://groups.google.com/group/asciidoc/browse_thread/thread/62278a054188a038 + 134. http://groups.google.com/group/asciidoc/browse_thread/thread/4bdcdfb0af773e2 + 135. http://groups.google.com/group/asciidoc/browse_thread/thread/c93bb4db025225d8 + 136. http://groups.google.com/group/asciidoc/browse_thread/thread/1d796a9c9ddb2855 + 137. http://groups.google.com/group/asciidoc/browse_thread/thread/6d8c716748b109e3 + 138. http://groups.google.com/group/asciidoc/browse_thread/thread/fd27add515597c06 + 139. http://www.methods.co.nz/asciidoc/testasciidoc.html + 140. http://www.methods.co.nz/asciidoc/asciidocapi.html + 141. file://localhost/tmp/lynxXXXXrCQLhm/L12417-6257TMP.html#X2 + 142. http://www.methods.co.nz/asciidoc/INSTALL.html + 143. http://www.methods.co.nz/asciidoc/newtables.html + 144. http://www.methods.co.nz/asciidoc/newlists.html + 145. http://www.methods.co.nz/asciidoc/userguide.html#X77 + 146. http://www.methods.co.nz/asciidoc/userguide.html#X76 + 147. http://www.methods.co.nz/asciidoc/latexmath.pdf + 148. http://www.methods.co.nz/asciidoc/asciimathml.html + 149. http://www.methods.co.nz/asciidoc/latexmathml.html + 150. http://www.methods.co.nz/asciidoc/source-highlight-filter.html + 151. https://sharesource.org/hg/asciidoc/ + 152. http://en.wikipedia.org/wiki/Data:_URI_scheme + 153. http://www.methods.co.nz/asciidoc/faq.html + 154. http://www.maths.nottingham.ac.uk/personal/drw/lm.html + 155. http://www.methods.co.nz/asciidoc/asciimathml.html + 156. http://www.methods.co.nz/asciidoc/index.html + 157. http://tpl.sourceforge.net/userguide.html + 158. http://www.methods.co.nz/asciidoc/music-filter.html + 159. http://lilypond.org/ + 160. http://abcnotation.org.uk/ + 161. mailto:srackham@gmail.com + 162. mailto:jlm@ofb.net + 163. mailto:m_pupil@yahoo.com.cn + 164. http://open.comsultia.com/docbook2odf/ + 165. http://www1.chapman.edu/~jipsen/mathml/asciimath.html + 166. http://www.methods.co.nz/asciidoc/asciimath.html + 167. file://localhost/tmp/lynxXXXXrCQLhm/userguide.html#X33 + 168. mailto:francis@daoine.org + 169. file://localhost/tmp/lynxXXXXrCQLhm/userguide.html#X39 + 170. file://localhost/tmp/lynxXXXXrCQLhm/source-highlight-filter.html + 171. mailto:trolocsis@gmail.com + 172. mailto:srackham@gmail.com + 173. file://localhost/tmp/lynxXXXXrCQLhm/userguide.html#X36 + 174. file://localhost/tmp/lynxXXXXrCQLhm/userguide.html#X33 + 175. mailto:viktor@rbg.informatik.tu-darmstadt.de + 176. file://localhost/tmp/lynxXXXXrCQLhm/userguide.html#X23 + 177. mailto:david@dgreaves.com + 178. mailto:stone@debian.org + 179. mailto:stone@debian.org + 180. mailto:srackham@gmail.com + 181. http://jimmac.musichall.cz/ikony.php3 + 182. mailto:srackham@gmail.com + 183. http://www.methods.co.nz/asciidoc/ + 184. https://sourceforge.net/projects/asciidoc/ diff --git a/source-builder/sb/asciidoc/CHANGELOG.txt b/source-builder/sb/asciidoc/CHANGELOG.txt new file mode 100644 index 0000000..5b01600 --- /dev/null +++ b/source-builder/sb/asciidoc/CHANGELOG.txt @@ -0,0 +1,3128 @@ +AsciiDoc ChangeLog +================== + +:website: http://www.methods.co.nz/asciidoc/ + + +Version 8.6.8 (2012-07-17) +-------------------------- +.Release highlights +Added full complement of styles to 'Open Blocks' and 'Normal +Paragraphs' -- those with a minimalist bent could construct virtually +any document using just Title, Normal Paragraph and Open Block +syntaxes. + +.Other additions and changes +- Increased default maximum include depth from 5 to 10. +- Emit warning if maximum include depth is exceeded. +- Suppress repeated console messages. +- Music filter: removed '--beams=None' option from abc2ly invocation + because it is broken on LilyPond 2.14 (Ubuntu 12.04). +- Replaced obsolete '' tag with '' in HTML backends. +- Allow configuration attribute entries to create a new section + (previously you could only modify existing sections). See: + https://groups.google.com/group/asciidoc/browse_thread/thread/7be28e9714f249c7[discussion + list]. +- Documented `{wj}` (word-joiner) attribute and updated FAQ. See: + https://groups.google.com/group/asciidoc/browse_thread/thread/961a957ab5872ebf[discussion + list]. +- FAQ: Added 'How can I place a footnote immediately following quoted + text?' See + https://groups.google.com/group/asciidoc/browse_thread/thread/961a957ab5872ebf[discussion + list]. +- Added Greek language configuration file. Contributed by Michael + Dourmousoglou. See + https://groups.google.com/group/asciidoc/browse_thread/thread/9e79d8494ef8d870[discussion + list]. +- FAQ: Added 'Using roles to select fonts for PDF'. Submitted by Lex + Trotman and based on solution by Antonio Borneo. See: + https://groups.google.com/group/asciidoc/browse_frm/thread/64b071bb21de9cf0[discussion + list]. +- Apply same monospaced font size to all monospaced text. +- Changed '0' number padding to spaces in numbered GNU + source-highlight outputs. +- Allow 'highlight' source highlighter to use 'python' for Python + `{language}` name. r1142: Update the AsciiDoc 'source' filter to + allow the use of the 'highlight' source code highlighter. See + https://groups.google.com/group/asciidoc/browse_frm/thread/e045c9986c71d72a[discussion + list]. ++ +NOTE: The 'pygments' attribute has been deprecated in favor of the new +'source-highlighter' attribute. + +- Vim syntax highlighter: Don't confuse trailing open block delimiter + with section underline. +- Added 'skip' option to paragraphs (c.f. Delimited Block 'skip' + option). + +.Bug fixes +- *FIXED*: latex, music and graphviz filters: When the filter output + image is data-uri encoded write it to the indir (instead of the + outdir) so that encoder can find it. See + https://groups.google.com/group/asciidoc/browse_thread/thread/f5174f450a61f14b[discussion + list]. +- *FIXED*: Escape the ']' character inside inline macros. See + https://groups.google.com/group/asciidoc/browse_thread/thread/db3b734a6931cb74[discussion + list]. +- *FIXED*: source highlighter filter: Pass 'role' attribute to HTML + backends. +- *FIXED*: source highlight filter: docbook backend: 'role' attribute + was not passed to listings without a title. Patch submitted by Lex + Trotman. See + https://groups.google.com/group/asciidoc/browse_thread/thread/13c9ee97930342b3[discussion + list]. +- *FIXED*: music2png.py: 'FOPException: Raster ByteInterleavedRaster' + error (FOP 1.0, ImageMagick 6.6.9-7). + + + +Version 8.6.7 (2012-03-17) +-------------------------- +.Release highlights +No major enhancements but quite a few bug fixes which, among other +things, fixes Jython compatibility and improves Windows compatibility. + +.All additions and changes +- Vim syntax highlighter: highlight entity refs in macro arguments. +- Added files with `.asciidoc` extension to Vim file type detection. + http://groups.google.com/group/asciidoc/browse_thread/thread/a9762e21ec0cc244/5d3a4ebf20e6847e[Patch] + submitted by Dag Wiers. +- Added 'replacement3' substitution to enable + http://groups.google.com/group/asciidoc/browse_thread/thread/843d7d3d671006fb/25628e14c829db3f[ODT + whitespace processing]. +- Added 'unbreakable' option to XHTML and HTML 5 backends. +- Implemented toc::[] block macro and 'toc-placement' attribute for + HTML backends to allow the Table of Contents placement to be set + manually by the author. +- Added FAQs: 'How can I control page breaks when printing HTML + outputs?' and 'Is it possible to reposition the Table of Contents + in HTML outputs?'. +- Added `--backend` and `--backend-opts` options to the 'a2x' command + to allow 'a2x' to use backend plugin code extensions. + http://groups.google.com/group/asciidoc/browse_thread/thread/b8e93740b7cd0e1d/b5e0b83fe37ae31a[Patch] + submitted by Lex Trotman. +- Added + http://groups.google.com/group/asciidoc/browse_thread/thread/3d06b0105dfbb780/8c60eb7a62f522e4[args + block attribute] to source highlight blocks to allow arbitrary + parameters to be passed to the source highlighters. +- If the 'ascii-ids' attribute is defined then non-ascii characters in + auto-generated IDs + http://groups.google.com/group/asciidoc/browse_thread/thread/33e99b78e2472122[are + replaced] by their nearest ascii equivalents (to work around DocBook + processor limitations). +- Added global 'blockname' attribute which is dynamically updated to + identify the current block. See + http://groups.google.com/group/asciidoc/browse_thread/thread/8200e29815c40f72[discussion + list]. +- 'xhtml11', 'html5' backends: Include book part TOC entries for + multi-part books. Patch submitted by Loïc Paillotin. +- Removed code filter example from the AsciiDoc User Guide so that + backends implemented as external plugins can compile the manual. See + http://groups.google.com/group/asciidoc/browse_thread/thread/849e5ea91f43adf2[discussion + list]. +- If the delimited block 'skip' option is set then do not consume + block title and attributes. This makes it possible for the comment + delimited blocks to use an attribute list (previously the comment + delimited block was hardwired to skip preceding attributes and + titles). See + http://groups.google.com/group/asciidoc/browse_thread/thread/e92a75abcc382701[discussion + list]. +- Added `backend-confdir` intrinsic attribute. + +.Bug fixes +- *FIXED*: slidy backend: broken 'stylesheet' attribute. + http://groups.google.com/group/asciidoc/browse_thread/thread/58d0843ae4345afd[Patch] + submitted by Micheal Hackett. +- *FIXED*: Restored + http://groups.google.com/group/asciidoc/browse_thread/thread/b0e69e393b6f9f20/47a2c7586f9e40c6?lnk=gst&q=themes+tarball#47a2c7586f9e40c6[missing + themes] to zip file distribution archive. +- *FIXED*: Grammatical error in error messages. + http://groups.google.com/group/asciidoc/browse_thread/thread/b9d705c6b6b39f59/1e120483dafca109[Patch] + submitted by Dag Wieers. +- *FIXED*: Use configured normal substitution in preference to the + default one. +- *FIXED*: The 'eval' block macro would execute multiple times if it + evaluated to 'None'. +- *FIXED*: Duplicated entries in TOC of large document. + http://groups.google.com/group/asciidoc/browse_thread/thread/103445ab9d95cb0c[Patch] + submitted by Sebastien Helleu. +- *FIXED*: Python 2.4 backward + http://code.google.com/p/asciidoc/issues/detail?id=9[incompatibility]. +- *FIXED*: 8.6.6 regression broke Jython compatibility. See + http://groups.google.com/group/asciidoc/browse_thread/thread/4608b77ec289f6c4[discussion + list]. +- *FIXED*: Leaky file handles in a2x and music and latex filters which + created incompatibility problems for Jython. +- *FIXED*: All Python filters are executed with the same Python + interpreter that executes the asciidoc parent (previously filters + were hardwired to execute the 'python' interpreter). This prevents + http://groups.google.com/group/asciidoc/browse_thread/thread/14e8fcb289a135b/3af3b4e57b827c78?lnk=gst&q=archlinux#3af3b4e57b827c78[Python + mix-ups]. +- *FIXED*: Microsoft Windows shelled command-line truncation that + caused shelled commands to fail e.g. the 'data-uri' attribute + failure. + + +Version 8.6.6 (2011-09-04) +-------------------------- +.Release highlights +- The AsciiDoc plugin architecture has been enhanced, unified and + extended: + * Plugin commands have been added to the asciidoc(1) `--backend` + option. + * An asciidoc(1) `--theme` option has been implemented to specify a + theme and to manage theme plugins. + * A plugin 'build' command (for creating plugins) added. + * 'build', 'install', 'list' and 'remove' plugin commands are all + recognized by asciidoc(1) `--backend`, `--filter` and `--theme` + options. +- A security update by Kenny MacDermid removes the use of `eval()` on + untrusted input (to disallow code malicious execution). + +.All additions and changes +- 'xhtml11', 'html5': Made verse and quote block text darker to print + legibly in Google Chrome browser. +- Added plugin 'build' command for plugin file creation. +- Merged `--help plugins` back to `--help manpage` so it matches the + asciidoc(1) manpage. +- The `--filter` command-line option can specify the name of filters + that will be unconditionally loaded. +- If a filter directory contains a file named `__noautoload__` then + the filter is not automatically loaded (you can used the `--filter` + command-line option to override this behavior). +- tests: Add Italian language tests. Patch submitted by Simon + Ruderich. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/5e2e6f4dd740d51a +- tests: Add tests for localized man pages. Patch submitted by Simon + Ruderich. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/5e2e6f4dd740d51a +- If the section name is prefixed with a '+' character then the + section contents is appended to the contents of an already existing + same-named section (the default behavior is to replace the the + section). +- If a configuration file section named 'docinfo' is loaded then it + will be included in the document header. Typically the 'docinfo' + section name will be prefixed with a '+' character so that it is + appended to (rather than replace) other 'docinfo' sections. +- Added `{sp}` intrinsic attribute for single space character. See + http://groups.google.com/group/asciidoc/browse_thread/thread/a839aa01db0765d2 +- Fixed TOC and footnotes generator. Patch submitted by Will. See + http://groups.google.com/group/asciidoc/browse_thread/thread/734ac5afed736987 +- The `asciidoc-confdir` attribute is set to the asciidoc executable + directory if it contains global configuration files i.e. a local + asciidoc installation. +- asciidoc now throws an error instead of just a warning of the + backend configuration file is not found. +- latex filter: write MD5 file after successful PNG file generation. + Always delete temp files irrespective of outcome. +- Added truecolor option to LaTeX filter. Patch submitted by Michel + Krämer. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/6436788a10561851 +- Unit test for table column specifiers with merged cells. Patch + submitted by Simon Ruderich. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/c9238380a1f2507a +- Added verbose message for `ifeval::[]` macro evaluation. +- Added test case for `ifeval::[]` evaluation. +- Security update to remove the use of `eval()` on untrusted input (to + disallow code malicious execution). Patch submitted by Kenny + MacDermid. +- Changed web site layout from table to CSS based. See + http://groups.google.com/group/asciidoc/browse_thread/thread/ec8e8481eb0e27b0/d1c035092b5bb7a4?lnk=gst&q=caption+option#d1c035092b5bb7a4 +- a2x: Pass `--format` option value to asciidoc as 'a2x-format' + attribute. Patch submitted by Lex Trotman + (http://groups.google.com/group/asciidoc/browse_thread/thread/3e177b84bc133ca9/659796dfadad30ea?lnk=gst&q=a2x+format#659796dfadad30ea). +- Added two FAQs submitted by Lex Trotman. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/16d3fb9672a408e7 +- html5,xhtml11: Implemented themes directory structure. +- html5,xhtml11: Implemented asciidoc `--theme` management option + (install, list, build and remove commands). +- html5,xhtml11: A theme can now optionally include a JavaScript file + `.js` +- html5,xhtml11: If the 'data-uri' attribute is defined then icons + from the theme icons directory (if they exist) will be embedded in + the generated document. +- Added optional 'warnings' argument to include macros. +- The asciidoc `--verbose` option now prints file inclusion messages. +- xhtml11, html5: Remove necessity for separate manpage CSS files. +- Added 'css-signature' attribute to tests. +- Add 'css-signature' attribute to set a CSS signature for the + document. Patch submitted by Peg Russell, see: + http://groups.google.com/group/asciidoc/browse_thread/thread/bacbf8aeb8ad6a3a +- White background for toc2 TOC viewport so that horizontally scrolled + content does not obscure the the TOC. Patch submitted by Lionel + Orry, see: http://code.google.com/p/asciidoc/issues/detail?id=8 + +.Bug fixes +- *FIXED*: Plugin install command: Delete backend directory is install + fails. +- *FIXED*: Plugin install command: Fixed bug extracting binary files + on Windows (reported by Jean-Michel Inglebert). +- *FIXED*: tests: Skip blank sections in testasciidoc.conf test + configuration file instead of throwing an exception (reported by + Jean-Michel Inglebert). +- *FIXED*: If a plugin Zip file does not contain file permissions + (probably because it was created under Windows) then install it + using the default permissions. +- *FIXED*: Fixed missing quote in preceding LaTeX filter patch. Fix + submitted by Simon Ruderich. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/6436788a10561851 +- *FIXED*: Some path attributes were processed as escaped Python + strings which could result in corrupted path names with backslash + separated Windows path names. Reported by Will. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/e8f3938bcb4c8bb4/44d13113a35738ef +- *FIXED*: Vertically spanned table cells resulted in incorrect column + styles being applied to some cells. Reported by Will: + http://groups.google.com/group/asciidoc/browse_thread/thread/c9238380a1f2507a/9afc4559d51e1dbd +- *FIXED*: LaTeX backend: fixed bad escapes. Patch submitted by Mark + McCurry: + http://groups.google.com/group/asciidoc/browse_thread/thread/8c111f1046b33691/158a944cf4d5ff0d?lnk=gst&q=latex+escapes#158a944cf4d5ff0d +- *FIXED*: When using slidy backend, display of characters with + accents is wrong because of 'meta http-equiv' line missing. Reported + by Fabrice Flore-Thebault. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/eaf25f21d1da180a + + +Version 8.6.5 (2011-05-20) +-------------------------- +.Release highlights +- The addition of an 'html5' backend to generate HTML 5 output. Apart + from the inclusion of 'audio' and 'video' block macros the 'html5' + backend is functionally identical to the 'xhtml11' backend. + +- A new 'flask' theme for 'xhtml11' and 'html5' backends inspired by + the http://flask.pocoo.org/docs/[Flask website] styling (see 'toc2' + example in the next item below). + +- The new 'toc2' attribute generates a table of contents in + the left hand margin ('xhtml11' and 'html5' backends). + link:article-html5-toc2.html[This example] was generated using + the following command: + + asciidoc -b html5 -a icons -a toc2 -a theme=flask article.txt + +- `a2x(1)` now has a flexible mechanism for copying arbitrary + resource files to HTML based outputs -- this is very handy for + generating EPUB files with embedded fonts and other resources. + + * The `a2x(1)` `--resource` option can be used to inject any file + into EPUB output documents e.g. CSS resources such as fonts and + background images. + * Explicitly specified resources are added to the EPUB OPF manifest + automatically. + * You can explicitly specify file extension MIME types. + * The enhanced resource processing works around a couple of DocBook + XSL bugs (see link:epub-notes.html[EPUB Notes]). + +.All additions and changes +- A new 'flask' theme for 'xhtml11' and 'html5' backends. A shameless + knock-off of the http://flask.pocoo.org/docs/[Flask website] + styling. +- Added HTML 5 article with 'toc2' table of contents to the example on + the AsciiDoc website home page. +- Added 'filters' and 'topics' help topics. Fixed documentation + errors in help text. Patch submitted by Lionel Orry, see: + http://groups.google.com/group/asciidoc/browse_thread/thread/9da9d48a6461ff14 +- Pass parent configuration files, command-line attributes and header + attributes to table asciidoc filters. Based on patch submitted by + Simon Ruderich, see: + http://groups.google.com/group/asciidoc/browse_thread/thread/5c792cbb395b753b +- Allow a 'title' attribute entry in the document header so that HTML + backends can set the 'title' element separately from the displayed + document title (the 'doctitle' attribute). +- Pass 'lang' attribute to 'asciidoc' table style filter. Patch + submitted by Simon Ruderich, see: + http://groups.google.com/group/asciidoc/browse_thread/thread/e2100b7cb29283ce +- xhtml11,html5: Added 'toc2' attribute which generates a scrollable + table of contents in the left hand margin. Based on customized CSS + written by Suraj Kurapati, see + http://groups.google.com/group/asciidoc/browse_thread/thread/c5e30ee5555877f5 +- Added 'asciidoc-confdir' intrinsic attribute which expands to the + global conf directory. +- Documented that you can specify multiple CSS files with the a2x(1) + `--stylesheet` command option. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/baf3218551d05a05 +- Improved xhtml11 backend's table of contents generation latency. + Patch submitted by Hongli Lai. See: + http://groups.google.com/group/asciidoc/browse_thread/thread/5a7fe64fbfd65ad +- Added html5 backend. +- For consistency converted all DOS formatted configuration and text + files to UNIX format. +- html4: Added ability to use 'role' attribute with most block + elements. Patch contributed by Simon Ruderich. See + http://groups.google.com/group/asciidoc/browse_thread/thread/5620ba634fdb030a +- Added Dutch language configuration file and accompanying test file + (contributed by Dag Wieers, see + http://groups.google.com/group/asciidoc/browse_thread/thread/f969b9ce987d7f5d). +- Configuration files are loaded in two passes when the -e + command-line option is used (the same behavior as when the -e option + is not used). Patch submitted by haad. See + http://groups.google.com/group/asciidoc/browse_thread/thread/cd0f47495fd04181 + and + http://code.google.com/p/asciidoc/issues/detail?id=6&q=label%3APriority-Medium +- Documented how to include embedded fonts in an EPUB document. +- a2x: Added `.=` resource specifier syntax. +- a2x: Enable admonition icons in example EPUBs. +- a2x: allow environment variables and tilde home directories in + resource manifest files. +- a2x: don't process non-existent resource directories. +- a2x: assume resource option is a directory if the name ends with a + directory separator. +- a2x: Added a new syntax to the `--resource` option specifier which + allows the destination path to be specified. +- a2x: Copy resources referenced in the OPF and resources referenced + by the generated HTML (in theory DocBook XSL should ensure they are + identical but this is not always the case e.g. + http://sourceforge.net/tracker/?func=detail&atid=373747&aid=2854075&group_id=21935). +- Drop border from callout list image links. +- html4: Moved manpage NAME section out of header so that the name + section is rendered when the asciidoc(1) `--no-header-footer` option + is specified (so that manpages processed blogpost include the NAME + section). +- Vim syntax highlighter: TODO markers now appear in list items and + literal paragraphs and blocks. +- Constrained quotes can now be bounded on the left by a } character. + See: + http://groups.google.com/group/asciidoc/browse_thread/thread/b24cc3362f35b801 +- Added text-decoration roles (underline, overline, line-through, + blink) for xhtml11 and html5 outputs. + +.Bug fixes +- *FIXED*: epubcheck 1.1 previously issued a warning for files not + registered in the manifest (epubcheck 1.0.5 did not). This resulted + in a problem compiling the adventures-of-sherlock-holmes.txt example + (the `underline.png` resource was not in the manifest). + + +Version 8.6.4 (2011-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 envelopes document + content. +. You need to add `
...
` 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 `` 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 + <> 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 `-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 `` 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-.conf` will be loaded automatically. +- The help file name `help-.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 `
` 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 + `` element is not generated (previously generated empty + `` 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 + `{@:[:]}` and + `{$:[:]}`. +- 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 `` 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 (`
` 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 `[[[]]]` is available, it + displays `[]` 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: `++,,++`. +- Index terms that have secondary and tertiary entries now + additionally generate separate index terms for the secondary and + tertiary entries. +- A `++` 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-` 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 `{%}`. +- Double-quote characters can now appear in unquoted positional + arguments. + + +Version 4.1 (2003-11-13) +------------------------ +- Added DSV (Delimiter Separated Values) tables format. +- `{eval:}` glossary references drop the containing line if + `` 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 `{!}` + and `{#}`. +- 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 `{?}`. + `` is the glossary entry name and `` is the text + substituted if the glossary entry is defined. `` 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/source-builder/sb/asciidoc/COPYING b/source-builder/sb/asciidoc/COPYING new file mode 100644 index 0000000..a43ea21 --- /dev/null +++ b/source-builder/sb/asciidoc/COPYING @@ -0,0 +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. + + + Copyright (C) 19yy + + 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. + + , 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. diff --git a/source-builder/sb/asciidoc/INSTALL b/source-builder/sb/asciidoc/INSTALL new file mode 100644 index 0000000..cfca794 --- /dev/null +++ b/source-builder/sb/asciidoc/INSTALL @@ -0,0 +1,235 @@ + AsciiDoc Installation + + version 8.6.8, 17 July 2012 + + Note + The current version of AsciiDoc requires Python 2.4 or newer to run. If + you don’t already have an up-to-date version of Python installed it can + be downloaded from the official Python website + [1]http://www.python.org/. + __________________________________________________________________ + +1. Prerequisites + + See the [2]README page. + __________________________________________________________________ + +2. Installing from the Mercurial repository + + The AsciiDoc [3]Mercurial repository is hosted by [4]Google Code. To + browse the repository go to + [5]http://code.google.com/p/asciidoc/source/browse/. You can install + AsciiDoc from the repository if you don’t have an up to date packaged + version or want to get the latest version from the trunk: + * Make sure you have [6]Mercurial installed, you can check with: + $ hg --version + * Go to the directory you want to install AsciiDoc into and download + the repository. This example gets the 8.6.8 tagged release: + $ cd ~/bin + $ hg clone -r 8.6.8 https://asciidoc.googlecode.com/hg/ asciidoc-8.6.8 + + You now have two choices: you can run asciidoc locally from your + repository or you can use autoconf(1) and make(1) to perform a + system-wide install. + + 2.1. Running asciidoc from your local copy + + Create a symlink to the AsciiDoc script in a search PATH directory so + it’s easy to execute asciidoc from the command-line, for example: + $ ln -s ~/bin/asciidoc-8.6.8/asciidoc.py ~/bin/asciidoc + $ ln -s ~/bin/asciidoc-8.6.8/a2x.py ~/bin/a2x + + Use the Mercurial pull command to update your local AsciiDoc + repository. + + 2.2. Installing asciidoc for all users + + Create configure using autoconf(1); use configure to create the + Makefile; run make(1); build the man pages; install: + + $ autoconf + $ ./configure + $ make + $ sudo make install + + To uninstall: + + $ sudo make uninstall + __________________________________________________________________ + +3. Distribution tarball installation + + The distribution source tarballs can be downloaded from the SourceForge + [7]http://sourceforge.net/projects/asciidoc/. + + Note + Unless you are [8]installing on Microsoft Windows you should use the + tarball and not the zip file to install the the distribution (the + tarball contains symlinks). + + If your flavor or UNIX or Linux does not have a packaged AsciiDoc + distribution or if you prefer to install the latest AsciiDoc version + from source use the configure shell script in the tarball root + directory. + + The autoconf(1) generated configure script creates a make file that is + tailored for your system. To install: + $ tar -xzf asciidoc-8.6.8.tar.gz + $ cd asciidoc-8.6.8 + $ ./configure + $ sudo make install + + To install the documentation: + $ sudo make docs + + To uninstall AsciiDoc: + $ sudo make uninstall + + If Vim is installed on your system the AsciiDoc Vim syntax highlighter + and filetype detection scripts will be install in the global Vim + configuration file directory (asciidoc.vim in the syntax directory and + asciidoc_filetype.vim in the ftdetect directory). + __________________________________________________________________ + +4. Microsoft Windows installation + + AsciiDoc is developed and tested on Linux but there seem to be quite a + few people using it on Windows. To install AsciiDoc on Windows unzip + the distribution Zip file contents: + $ unzip asciidoc-8.6.8.zip + + This will create the folder asciidoc-8.6.8 containing the asciidoc.py + and a2x.py executables along with configuration files and + documentation. + + To generate DocBook based outputs (e.g. PDFs) you will also need a + working DocBook toolchain. Installing and configuring a DocBook + toolchain on Windows can be a challenge — this blog post explains + [9]How to Create Handsome PDF Documents Without Frustration using + [10]Cygwin, [11]dblatex and AsciiDoc. + __________________________________________________________________ + +5. Testing your installation + + Test out asciidoc by changing to the AsciiDoc application directory and + convert the User Guide document (./doc/asciidoc.txt) to XHTML + (./doc/asciidoc.html): + $ python asciidoc.py doc/asciidoc.txt + + [12]testasciidoc offers a more extensive set of conformance tests, + though you do need to create the test data before running the tests + (this in itself is a good post-install test): + $ python ./tests/testasciidoc.py update + + Now you can run the tests by executing this command: + $ python ./tests/testasciidoc.py run + + A full battery of tests can be run from the main.aap script in the + distribution root directory: + $ aap test + __________________________________________________________________ + +6. Building the distribution + + The AsciiDoc distribution is built using [13]A-A-P (a software build + system written by Bram Moolenaar). The AsciiDoc A-A-P scripts are: + + ./main.aap + Builds the distribution tarball and zip files, documentation and + example website. + + ./doc/main.aap + Builds distribution documentation. + + ./examples/website/main.aap + Builds AsciiDoc website. + + ./common.aap + Included in all scripts. + + To build the distribution tarball and zip files, documentation and + example website run A-A-P from the distribution root directory: + $ aap + __________________________________________________________________ + +7. Prepackaged AsciiDoc installation + + The following platform specific AsciiDoc packages are available: + + Debian GNU/Linux + If you use Debian or a Debian based distribution there’s an + [14]AsciiDoc Debian package available. Thanks to [15]Fredrik + Steen who built and maintains the Debian AsciiDoc package. + + Gentoo Linux + If you use Gentoo Linux there’s a [16]Gentoo AsciiDoc package + available. Thanks to [17]Brandon Philips for writing the ebuild. + + Fedora Linux + With help from Terje Røsten, Chris Wright added asciidoc to + Fedora Extras which is available in the default installation. To + install asciidoc execute the following command: + + $ yum install asciidoc + + Slackware Linux + John Calixto has created a Slackware package for AsciiDoc which + can be downloaded from [18]http://linuxpackages.net/. + + Ark Linux + [19]Bernhard Rosenkraenzer added AsciiDoc to Ark Linux — the + package is available from the Ark Linux repository at + [20]http://arklinux.osuosl.org/dockyard-devel/, so Ark Linux + users should just run apt-get install asciidoc. + + T2 Linux + [21]Christian Wiese added AsciiDoc to the [22]T2 Linux + repository at + [23]http://svn.exactcode.de/t2/trunk/package/textproc/asciidoc/. + To build and install the package on a T2 system, run + ./scripts/Emerge-Pkg asciidoc from within your T2 source + directory (default: /usr/src/t2-src). + + Red Hat Enterprise Linux, Fedora and CentOS packages + Dag Wieers has built AsciiDoc RPMs for a number of Red Hat based + distributions, they can be downloaded from + [24]http://dag.wieers.com/rpm/packages/asciidoc/. + + CSW Package for Sun Solaris + Ben Walton has created a CSW package for AsciiDoc, you can find + it here: [25]http://opencsw.org/packages/asciidoc. + + See also [26]Packager Notes in the AsciiDoc User Guide. + __________________________________________________________________ + + Version 8.6.8 + Last updated 2010-11-15 08:44:54 NZDT + +References + + 1. http://www.python.org/ + 2. file://localhost/tmp/lynxXXXXr4pa6e/README.html + 3. http://www.selenic.com/mercurial/ + 4. http://code.google.com/ + 5. http://code.google.com/p/asciidoc/source/browse/ + 6. http://www.selenic.com/mercurial/ + 7. http://sourceforge.net/projects/asciidoc/ + 8. file://localhost/tmp/lynxXXXXr4pa6e/L12440-2561TMP.html#X3 + 9. http://blog.rainwebs.net/2010/02/25/how-to-create-handsome-pdf-documents-without-frustration/ + 10. http://www.cygwin.com/ + 11. http://dblatex.sourceforge.net/ + 12. file://localhost/tmp/lynxXXXXr4pa6e/testasciidoc.html + 13. http://www.a-a-p.org/ + 14. http://packages.debian.org/asciidoc + 15. mailto:stone@debian.org + 16. http://packages.gentoo.org/package/app-text/asciidoc + 17. mailto:brandon@ifup.org + 18. http://linuxpackages.net/ + 19. mailto:bero@arklinux.org + 20. http://arklinux.osuosl.org/dockyard-devel/ + 21. mailto:cw@ixplanet.de + 22. http://www.t2-project.org/ + 23. http://svn.exactcode.de/t2/trunk/package/textproc/asciidoc/ + 24. http://dag.wieers.com/rpm/packages/asciidoc/ + 25. http://opencsw.org/packages/asciidoc + 26. file://localhost/tmp/lynxXXXXr4pa6e/userguide.html#X38 diff --git a/source-builder/sb/asciidoc/INSTALL.txt b/source-builder/sb/asciidoc/INSTALL.txt new file mode 100644 index 0000000..eb07ddd --- /dev/null +++ b/source-builder/sb/asciidoc/INSTALL.txt @@ -0,0 +1,227 @@ +AsciiDoc Installation +===================== + +NOTE: The current version of AsciiDoc requires *Python 2.4 or newer* +to run. If you don't already have an up-to-date version of Python +installed it can be downloaded from the official Python website +http://www.python.org/. + + +Prerequisites +------------- +See the link:README.html[README] page. + + +Installing from the Mercurial repository +---------------------------------------- +The AsciiDoc http://www.selenic.com/mercurial/[Mercurial] repository +is hosted by http://code.google.com/[Google Code]. +To browse the repository go to +http://code.google.com/p/asciidoc/source/browse/. +You can install AsciiDoc from the repository if you don't have an up to +date packaged version or want to get the latest version from the trunk: + +- Make sure you have http://www.selenic.com/mercurial/[Mercurial] + installed, you can check with: + + $ hg --version + +- Go to the directory you want to install AsciiDoc into and download + the repository. This example gets the {revnumber} tagged release: + +[subs="attributes"] + $ cd ~/bin + $ hg clone -r {revnumber} https://asciidoc.googlecode.com/hg/ asciidoc-{revnumber} + +You now have two choices: you can run asciidoc locally from your +repository or you can use 'autoconf(1)' and 'make(1)' to perform a +system-wide install. + +Running asciidoc from your local copy +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Create a symlink to the AsciiDoc script in a search `PATH` directory +so it's easy to execute `asciidoc` from the command-line, for example: + +[subs="attributes"] + $ ln -s ~/bin/asciidoc-{revnumber}/asciidoc.py ~/bin/asciidoc + $ ln -s ~/bin/asciidoc-{revnumber}/a2x.py ~/bin/a2x + +Use the Mercurial `pull` command to update your local AsciiDoc repository. + +Installing asciidoc for all users +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Create `configure` using 'autoconf(1)'; use `configure` to create the +`Makefile`; run 'make(1)'; build the man pages; install: + +--------------------------------------------- +$ autoconf +$ ./configure +$ make +$ sudo make install +--------------------------------------------- + +To uninstall: + +--------------------------------------------- +$ sudo make uninstall +--------------------------------------------- + + +[[X1]] +Distribution tarball installation +--------------------------------- +The distribution source tarballs can be downloaded from the +SourceForge http://sourceforge.net/projects/asciidoc/. + +NOTE: Unless you are <> you should +use the tarball and not the zip file to install the the distribution +(the tarball contains symlinks). + +If your flavor or UNIX or Linux does not have a packaged AsciiDoc +distribution or if you prefer to install the latest AsciiDoc version +from source use the `configure` shell script in the tarball root +directory. + +The `autoconf(1)` generated `configure` script creates a make file +that is tailored for your system. To install: + +[subs="attributes"] + $ tar -xzf asciidoc-{revnumber}.tar.gz + $ cd asciidoc-{revnumber} + $ ./configure + $ sudo make install + +To install the documentation: + + $ sudo make docs + +To uninstall AsciiDoc: + + $ sudo make uninstall + +If Vim is installed on your system the AsciiDoc Vim syntax highlighter +and filetype detection scripts will be install in the global Vim +configuration file directory (`asciidoc.vim` in the `syntax` directory +and `asciidoc_filetype.vim` in the `ftdetect` directory). + + +[[X3]] +Microsoft Windows installation +------------------------------ +AsciiDoc is developed and tested on Linux but there seem to be quite a +few people using it on Windows. To install AsciiDoc on Windows unzip +the distribution Zip file contents: + +[subs="attributes"] + $ unzip asciidoc-{revnumber}.zip + +This will create the folder +asciidoc-{revnumber}+ containing the +`asciidoc.py` and `a2x.py` executables along with configuration files +and documentation. + +To generate DocBook based outputs (e.g. PDFs) you will also need a +working DocBook toolchain. Installing and configuring a DocBook +toolchain on Windows can be a challenge -- this blog post explains +http://blog.rainwebs.net/2010/02/25/how-to-create-handsome-pdf-documents-without-frustration/[How +to Create Handsome PDF Documents Without Frustration] using +http://www.cygwin.com/[Cygwin], +http://dblatex.sourceforge.net/[dblatex] and AsciiDoc. + + +Testing your installation +------------------------- +Test out asciidoc by changing to the AsciiDoc application directory +and convert the User Guide document (`./doc/asciidoc.txt`) to XHTML +(`./doc/asciidoc.html`): + + $ python asciidoc.py doc/asciidoc.txt + +link:testasciidoc.html[testasciidoc] offers a more extensive set of +conformance tests, though you do need to create the test data before +running the tests (this in itself is a good post-install test): + + $ python ./tests/testasciidoc.py update + +Now you can run the tests by executing this command: + + $ python ./tests/testasciidoc.py run + +A full battery of tests can be run from the `main.aap` script in the +distribution root directory: + + $ aap test + + +Building the distribution +------------------------- +The AsciiDoc distribution is built using http://www.a-a-p.org/[A-A-P] +(a software build system written by Bram Moolenaar). The AsciiDoc +A-A-P scripts are: + +`./main.aap`:: Builds the distribution tarball and zip files, +documentation and example website. +`./doc/main.aap`:: Builds distribution documentation. +`./examples/website/main.aap`:: Builds AsciiDoc website. +`./common.aap`:: Included in all scripts. + +To build the distribution tarball and zip files, documentation and +example website run A-A-P from the distribution root directory: + + $ aap + + +[[X2]] +Prepackaged AsciiDoc installation +--------------------------------- +The following platform specific AsciiDoc packages are available: + +*Debian GNU/Linux*:: + If you use Debian or a Debian based distribution there's an + http://packages.debian.org/asciidoc[AsciiDoc Debian package] + available. Thanks to mailto:stone@debian.org[Fredrik Steen] who + built and maintains the Debian AsciiDoc package. + +*Gentoo Linux*:: + If you use Gentoo Linux there's a + http://packages.gentoo.org/package/app-text/asciidoc[Gentoo AsciiDoc + package] available. Thanks to mailto:brandon@ifup.org[Brandon + Philips] for writing the ebuild. + +*Fedora Linux*:: + With help from Terje Røsten, Chris Wright added asciidoc to Fedora + Extras which is available in the default installation. To install + asciidoc execute the following command: + + $ yum install asciidoc + +*Slackware Linux*:: + John Calixto has created a Slackware package for AsciiDoc which can + be downloaded from http://linuxpackages.net/. + +*Ark Linux*:: + mailto:bero@arklinux.org[Bernhard Rosenkraenzer] added AsciiDoc to + Ark Linux -- the package is available from the Ark Linux repository + at http://arklinux.osuosl.org/dockyard-devel/, so Ark Linux users + should just run `apt-get install asciidoc`. + +*T2 Linux*:: + mailto:cw@ixplanet.de[Christian Wiese] added AsciiDoc to the + http://www.t2-project.org/[T2 Linux] repository at + http://svn.exactcode.de/t2/trunk/package/textproc/asciidoc/. To + build and install the package on a T2 system, run + `./scripts/Emerge-Pkg asciidoc` from within your T2 source directory + (default: `/usr/src/t2-src`). + +*Red Hat Enterprise Linux, Fedora and CentOS packages*:: + Dag Wieers has built AsciiDoc RPMs for a number of Red Hat based + distributions, they can be downloaded from + http://dag.wieers.com/rpm/packages/asciidoc/. + +*CSW Package for Sun Solaris*:: + Ben Walton has created a CSW package for AsciiDoc, you can find it + here: http://opencsw.org/packages/asciidoc. + +See also link:userguide.html#X38[Packager Notes] in the 'AsciiDoc User +Guide'. + + diff --git a/source-builder/sb/asciidoc/MANIFEST b/source-builder/sb/asciidoc/MANIFEST new file mode 100644 index 0000000..68eebb4 --- /dev/null +++ b/source-builder/sb/asciidoc/MANIFEST @@ -0,0 +1,90 @@ +a2x.py +asciidoc.py +asciidocapi.py +BUGS +BUGS.txt +MANIFEST +main.aap +common.aap +CHANGELOG +CHANGELOG.txt +asciidoc.conf +docbook45.conf +help.conf +html4.conf +html5.conf +lang-*.conf +latex.conf +slidy.conf +text.conf +wordpress.conf +xhtml11.conf +xhtml11-quirks.conf +COPYING +COPYRIGHT +dblatex/asciidoc-dblatex.sty +dblatex/asciidoc-dblatex.xsl +dblatex/dblatex-readme.txt +doc/a2x.1 +doc/book.epub +doc/asciidoc.1 +doc/asciidoc.conf +doc/article-docinfo.xml +doc/customers.csv +doc/images/ +doc/main.aap +doc/article.pdf +doc/latex-filter.pdf +doc/music-filter.pdf +doc/source-highlight-filter.pdf +doc/*.txt +doc/asciidoc.dict +docbook-xsl/*.txt +docbook-xsl/*.xsl +examples/website/main.aap +examples/website/build-website.sh +examples/website/*.css +examples/website/*.js +examples/website/customers.csv +examples/website/images/ +examples/website/layout?.conf +examples/website/*.txt +filters/code/code-filter.conf +filters/code/code-filter.py +filters/code/code-filter-readme.txt +filters/code/code-filter-test.txt +filters/latex/latex2png.py +filters/latex/latex-filter.conf +filters/music/music-filter.conf +filters/music/music2png.py +filters/music/music-filter-test.txt +filters/source/source-highlight-filter.conf +filters/source/source-highlight-filter-test.txt +filters/graphviz/graphviz-filter.conf +filters/graphviz/graphviz2png.py +filters/graphviz/asciidoc-graphviz-sample.txt +images/icons/callouts/*.png +images/icons/*.png +images/icons/README +images/smallnew.png +images/tiger.png +images/highlighter.png +INSTALL +INSTALL.txt +configure +configure.ac +Makefile.in +install-sh +javascripts/*.js +README +README.txt +stylesheets/*.css +tests/testasciidoc.py +tests/testasciidoc.conf +tests/asciidocapi.py +tests/data/*.conf +tests/data/*.txt +themes/flask/*.css +themes/volnitsky/*.css +vim/syntax/asciidoc.vim +vim/ftdetect/asciidoc_filetype.vim diff --git a/source-builder/sb/asciidoc/Makefile.in b/source-builder/sb/asciidoc/Makefile.in new file mode 100644 index 0000000..d8672c3 --- /dev/null +++ b/source-builder/sb/asciidoc/Makefile.in @@ -0,0 +1,185 @@ +# +# Make file to install/uninstall AsciiDoc +# + +.NOTPARALLEL: + +INSTALL = @INSTALL@ +INSTALL_PROG = @INSTALL_PROGRAM@ +INSTALL_DATA = @INSTALL_DATA@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +SED = @SED@ + +prefix = @prefix@ +exec_prefix = @exec_prefix@ +bindir = @bindir@ +datadir = @datadir@ +docdir = @docdir@ +sysconfdir = @sysconfdir@ +datarootdir = @datarootdir@ +mandir=@mandir@ +srcdir = @srcdir@ + +VPATH = @srcdir@ + +ASCIIDOCCONF = $(sysconfdir)/asciidoc + +prog = asciidoc.py a2x.py +progdir = $(bindir) + +vimdir = @sysconfdir@/vim + +manp = $(patsubst %1.txt,%1,$(wildcard doc/*.1.txt)) +manpdir = $(mandir)/man1 + +conf = $(wildcard *.conf) +confdir = $(ASCIIDOCCONF) + +filtersdir = $(ASCIIDOCCONF)/filters + +codefilter = filters/code/code-filter.py +codefilterdir = $(filtersdir)/code +codefilterconf = filters/code/code-filter.conf +codefilterconfdir = $(filtersdir)/code + +graphvizfilter = filters/graphviz/graphviz2png.py +graphvizfilterdir = $(filtersdir)/graphviz +graphvizfilterconf = filters/graphviz/graphviz-filter.conf +graphvizfilterconfdir = $(filtersdir)/graphviz + +musicfilter = filters/music/music2png.py +musicfilterdir = $(filtersdir)/music +musicfilterconf = filters/music/music-filter.conf +musicfilterconfdir = $(filtersdir)/music + +sourcefilterconf = filters/source/source-highlight-filter.conf +sourcefilterconfdir = $(filtersdir)/source + +latexfilter = filters/latex/latex2png.py +latexfilterdir = $(filtersdir)/latex +latexfilterconf = filters/latex/latex-filter.conf +latexfilterconfdir = $(filtersdir)/latex + +themesdir = $(ASCIIDOCCONF)/themes + +flasktheme = themes/flask/flask.css +flaskthemedir = $(themesdir)/flask + +volnitskytheme = themes/volnitsky/volnitsky.css +volnitskythemedir = $(themesdir)/volnitsky + +docbook = $(wildcard docbook-xsl/*.xsl) +docbookdir = $(ASCIIDOCCONF)/docbook-xsl + +dblatex = $(wildcard dblatex/*.xsl) $(wildcard dblatex/*.sty) +dblatexdir = $(ASCIIDOCCONF)/dblatex + +css = $(wildcard stylesheets/*.css) +cssdir = $(ASCIIDOCCONF)/stylesheets + +js = $(wildcard javascripts/*.js) +jsdir = $(ASCIIDOCCONF)/javascripts + +callouts = $(wildcard images/icons/callouts/*) +calloutsdir = $(ASCIIDOCCONF)/images/icons/callouts + +icons = $(wildcard images/icons/*.png) images/icons/README +iconsdir = $(ASCIIDOCCONF)/images/icons + +doc = $(wildcard README*) $(wildcard BUGS*) $(wildcard INSTALL*) $(wildcard CHANGELOG*) + +DATATARGETS = manp conf docbook dblatex css js callouts icons codefilterconf musicfilterconf sourcefilterconf graphvizfilterconf latexfilterconf flasktheme volnitskytheme +PROGTARGETS = prog codefilter musicfilter graphvizfilter latexfilter +TARGETS = $(DATATARGETS) $(PROGTARGETS) doc + +INSTDIRS = $(TARGETS:%=%dir) + +.PHONY: $(TARGETS) + +all: build + +# create directories used during the install +$(INSTDIRS): + $(INSTALL) -d $(DESTDIR)/$($@) + +$(PROGTARGETS): % : %dir + $(INSTALL_PROG) $($@) $(DESTDIR)/$($<)/ + +$(DATATARGETS): % : %dir + $(INSTALL_DATA) $($@) $(DESTDIR)/$($<)/ + +$(manp): %.1 : %.1.txt + python a2x.py -f manpage $< + +docs: + $(INSTALL) -d $(DESTDIR)/$(docdir) + $(INSTALL_DATA) $(doc) $(DESTDIR)/$(docdir) + $(INSTALL) -d $(DESTDIR)/$(docdir)/docbook-xsl + $(INSTALL_DATA) docbook-xsl/asciidoc-docbook-xsl.txt $(DESTDIR)/$(docdir)/docbook-xsl + $(INSTALL) -d $(DESTDIR)/$(docdir)/dblatex + $(INSTALL_DATA) dblatex/dblatex-readme.txt $(DESTDIR)/$(docdir)/dblatex + $(INSTALL) -d $(DESTDIR)/$(docdir)/stylesheets + $(INSTALL_DATA) $(css) $(DESTDIR)/$(docdir)/stylesheets + $(INSTALL) -d $(DESTDIR)/$(docdir)/javascripts + $(INSTALL_DATA) $(js) $(DESTDIR)/$(docdir)/javascripts + $(INSTALL) -d $(DESTDIR)/$(docdir)/images + ( cd images && \ + cp -R * $(DESTDIR)/$(docdir)/images ) + $(INSTALL) -d $(DESTDIR)/$(docdir)/doc + ( cd doc && \ + cp -R * $(DESTDIR)/$(docdir)/doc ) + $(INSTALL) -d $(DESTDIR)/$(docdir)/examples/website + ( cd examples/website && \ + cp -R * $(DESTDIR)/$(docdir)/examples/website ) + +progsymlink: + (cd $(DESTDIR)/$(progdir); ln -sf asciidoc.py asciidoc) + (cd $(DESTDIR)/$(progdir); ln -sf a2x.py a2x) + +fixconfpath: + @for f in $(prog); do \ + echo "Fixing CONF_DIR in $$f"; \ + $(SED) "s#^CONF_DIR = '.*'#CONF_DIR = '$(ASCIIDOCCONF)'#" $$f > $$f.out; \ + mv $$f.out $$f; \ + chmod +x $$f; \ + done + +install-vim: + @for d in $(DESTDIR)/$(vimdir) /etc/vim; do \ + if ! test -d $$d; then continue; fi ; \ + echo "installing Vim files in $$d" ; \ + $(INSTALL) -d $$d/syntax ; \ + $(INSTALL_DATA) vim/syntax/asciidoc.vim $$d/syntax ; \ + $(INSTALL) -d $$d/ftdetect ; \ + $(INSTALL_DATA) vim/ftdetect/asciidoc_filetype.vim $$d/ftdetect ; \ + done + +uninstall-vim: + @for d in $(DESTDIR)/$(vimdir) /etc/vim; do \ + if ! test -d $$d; then continue; fi ; \ + echo "uninstalling Vim files in $$d" ; \ + rm -f $$d/syntax/asciidoc.vim ; \ + rm -f $$d/ftdetect/asciidoc_filetype.vim ; \ + done + + +build: fixconfpath $(manp) + + +install: all $(PROGTARGETS) $(DATATARGETS) progsymlink install-vim + +uninstall: uninstall-vim + rm -f $(DESTDIR)/$(progdir)/asciidoc + rm -f $(DESTDIR)/$(progdir)/asciidoc.py + rm -f $(DESTDIR)/$(progdir)/a2x + rm -f $(DESTDIR)/$(progdir)/a2x.py + rm -f $(DESTDIR)/$(manpdir)/asciidoc.1 + rm -f $(DESTDIR)/$(manpdir)/a2x.1 + rm -rf $(DESTDIR)/$(confdir) + rm -rf $(DESTDIR)/$(docdir) + +clean: + rm -f $(manp) + +test: + @echo "Nothing to see here...Move along." diff --git a/source-builder/sb/asciidoc/README b/source-builder/sb/asciidoc/README new file mode 100644 index 0000000..9e5857b --- /dev/null +++ b/source-builder/sb/asciidoc/README @@ -0,0 +1,45 @@ + AsciiDoc README File + + version 8.6.8, 17 July 2012 + __________________________________________________________________ + +1. 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 [1]http://www.python.org. + __________________________________________________________________ + +2. Obtaining AsciiDoc + + Documentation and installation instructions are on the AsciiDoc website + [2]http://www.methods.co.nz/asciidoc/ + __________________________________________________________________ + +3. Tools + + Current AsciiDoc version tested on Xubuntu Linux 10.04 with: + * Python 2.6.5 + * DocBook XSL Stylesheets 1.76.1 + * xsltproc (libxml 20706, libxslt 10126 and libexslt 815). + * w3m 0.5.2 + * dblatex 0.3 + * FOP 0.95 + * A-A-P 1.091 + __________________________________________________________________ + +4. Copying + + Copyright © 2002-2011 Stuart Rackham. Free use of this software is + granted under the terms of the GNU General Public License version 2 + (GPLv2). + __________________________________________________________________ + + Version 8.6.8 + Last updated 2011-05-04 18:47:58 NZST + +References + + 1. http://www.python.org/ + 2. http://www.methods.co.nz/asciidoc/ diff --git a/source-builder/sb/asciidoc/README.txt b/source-builder/sb/asciidoc/README.txt new file mode 100644 index 0000000..b53c714 --- /dev/null +++ b/source-builder/sb/asciidoc/README.txt @@ -0,0 +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.76.1 +- 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-2011 Stuart Rackham. Free use of this software is +granted under the terms of the GNU General Public License version 2 +(GPLv2). diff --git a/source-builder/sb/asciidoc/a2x.py b/source-builder/sb/asciidoc/a2x.py new file mode 100755 index 0000000..1b192a2 --- /dev/null +++ b/source-builder/sb/asciidoc/a2x.py @@ -0,0 +1,960 @@ +#!/usr/bin/env python +''' +a2x - A toolchain manager for AsciiDoc (converts Asciidoc text files to other + file formats) + +Copyright: Stuart Rackham (c) 2009 +License: MIT +Email: srackham@gmail.com + +''' + +import os +import fnmatch +import HTMLParser +import re +import shutil +import subprocess +import sys +import traceback +import urlparse +import zipfile +import xml.dom.minidom +import mimetypes + +PROG = os.path.basename(os.path.splitext(__file__)[0]) +VERSION = '8.6.8' + +# AsciiDoc global configuration file directory. +# NOTE: CONF_DIR is "fixed up" by Makefile -- don't rename or change syntax. +CONF_DIR = '/etc/asciidoc' + + +###################################################################### +# Default configuration file parameters. +###################################################################### + +# Optional environment variable dictionary passed to +# executing programs. If set to None the existing +# environment is used. +ENV = None + +# External executables. +ASCIIDOC = 'asciidoc' +XSLTPROC = 'xsltproc' +DBLATEX = 'dblatex' # pdf generation. +FOP = 'fop' # pdf generation (--fop option). +W3M = 'w3m' # text generation. +LYNX = 'lynx' # text generation (if no w3m). +XMLLINT = 'xmllint' # Set to '' to disable. +EPUBCHECK = 'epubcheck' # Set to '' to disable. +# External executable default options. +ASCIIDOC_OPTS = '' +DBLATEX_OPTS = '' +FOP_OPTS = '' +XSLTPROC_OPTS = '' +BACKEND_OPTS = '' + +###################################################################### +# End of configuration file parameters. +###################################################################### + + +##################################################################### +# Utility functions +##################################################################### + +OPTIONS = None # These functions read verbose and dry_run command options. + +def errmsg(msg): + sys.stderr.write('%s: %s\n' % (PROG,msg)) + +def warning(msg): + errmsg('WARNING: %s' % msg) + +def infomsg(msg): + print '%s: %s' % (PROG,msg) + +def die(msg, exit_code=1): + errmsg('ERROR: %s' % msg) + sys.exit(exit_code) + +def trace(): + """Print traceback to stderr.""" + errmsg('-'*60) + traceback.print_exc(file=sys.stderr) + errmsg('-'*60) + +def verbose(msg): + if OPTIONS.verbose or OPTIONS.dry_run: + infomsg(msg) + +class AttrDict(dict): + """ + Like a dictionary except values can be accessed as attributes i.e. obj.foo + can be used in addition to obj['foo']. + If self._default has been set then it will be returned if a non-existant + attribute is accessed (instead of raising an AttributeError). + """ + def __getattr__(self, key): + try: + return self[key] + except KeyError, k: + if self.has_key('_default'): + return self['_default'] + else: + raise AttributeError, k + def __setattr__(self, key, value): + self[key] = value + def __delattr__(self, key): + try: del self[key] + except KeyError, k: raise AttributeError, k + def __repr__(self): + return '' + def __getstate__(self): + return dict(self) + def __setstate__(self,value): + for k,v in value.items(): self[k]=v + +def isexecutable(file_name): + return os.path.isfile(file_name) and os.access(file_name, os.X_OK) + +def find_executable(file_name): + ''' + Search for executable file_name in the system PATH. + Return full path name or None if not found. + ''' + def _find_executable(file_name): + if os.path.split(file_name)[0] != '': + # file_name includes directory so don't search path. + if not isexecutable(file_name): + return None + else: + return file_name + for p in os.environ.get('PATH', os.defpath).split(os.pathsep): + f = os.path.join(p, file_name) + if isexecutable(f): + return os.path.realpath(f) + return None + if os.name == 'nt' and os.path.splitext(file_name)[1] == '': + for ext in ('.cmd','.bat','.exe'): + result = _find_executable(file_name + ext) + if result: break + else: + result = _find_executable(file_name) + return result + +def write_file(filename, data, mode='w'): + f = open(filename, mode) + try: + f.write(data) + finally: + f.close() + +def read_file(filename, mode='r'): + f = open(filename, mode) + try: + return f.read() + finally: + f.close() + +def shell_cd(path): + verbose('chdir %s' % path) + if not OPTIONS.dry_run: + os.chdir(path) + +def shell_makedirs(path): + if os.path.isdir(path): + return + verbose('creating %s' % path) + if not OPTIONS.dry_run: + os.makedirs(path) + +def shell_copy(src, dst): + verbose('copying "%s" to "%s"' % (src,dst)) + if not OPTIONS.dry_run: + shutil.copy(src, dst) + +def shell_rm(path): + if not os.path.exists(path): + return + verbose('deleting %s' % path) + if not OPTIONS.dry_run: + os.unlink(path) + +def shell_rmtree(path): + if not os.path.isdir(path): + return + verbose('deleting %s' % path) + if not OPTIONS.dry_run: + shutil.rmtree(path) + +def shell(cmd, raise_error=True): + ''' + Execute command cmd in shell and return tuple + (stdoutdata, stderrdata, returncode). + If raise_error is True then a non-zero return terminates the application. + ''' + if os.name == 'nt': + # TODO: this is probably unnecessary, see: + # http://groups.google.com/group/asciidoc/browse_frm/thread/9442ee0c419f1242 + # Windows doesn't like running scripts directly so explicitly + # specify python interpreter. + # Extract first (quoted or unquoted) argument. + mo = re.match(r'^\s*"\s*(?P[^"]+)\s*"', cmd) + if not mo: + mo = re.match(r'^\s*(?P[^ ]+)', cmd) + if mo.group('arg0').endswith('.py'): + cmd = 'python ' + cmd + # Remove redundant quoting -- this is not just cosmetic, + # quoting seems to dramatically decrease the allowed command + # length in Windows XP. + cmd = re.sub(r'"([^ ]+?)"', r'\1', cmd) + verbose('executing: %s' % cmd) + if OPTIONS.dry_run: + return + stdout = stderr = subprocess.PIPE + try: + popen = subprocess.Popen(cmd, stdout=stdout, stderr=stderr, + shell=True, env=ENV) + except OSError, e: + die('failed: %s: %s' % (cmd, e)) + stdoutdata, stderrdata = popen.communicate() + if OPTIONS.verbose: + print stdoutdata + print stderrdata + if popen.returncode != 0 and raise_error: + die('%s returned non-zero exit status %d' % (cmd, popen.returncode)) + return (stdoutdata, stderrdata, popen.returncode) + +def find_resources(files, tagname, attrname, filter=None): + ''' + Search all files and return a list of local URIs from attrname attribute + values in tagname tags. + Handles HTML open and XHTML closed tags. + Non-local URIs are skipped. + files can be a file name or a list of file names. + The filter function takes a dictionary of tag attributes and returns True if + the URI is to be included. + ''' + class FindResources(HTMLParser.HTMLParser): + # Nested parser class shares locals with enclosing function. + def handle_startendtag(self, tag, attrs): + self.handle_starttag(tag, attrs) + def handle_starttag(self, tag, attrs): + attrs = dict(attrs) + if tag == tagname and (filter is None or filter(attrs)): + # Accept only local URIs. + uri = urlparse.urlparse(attrs[attrname]) + if uri[0] in ('','file') and not uri[1] and uri[2]: + result.append(uri[2]) + if isinstance(files, str): + files = [files] + result = [] + for filename in files: + verbose('finding resources in: %s' % filename) + if OPTIONS.dry_run: + continue + parser = FindResources() + # HTMLParser has problems with non-ASCII strings. + # See http://bugs.python.org/issue3932 + contents = read_file(filename) + mo = re.search(r'\A<\?xml.* encoding="(.*?)"', contents) + if mo: + encoding = mo.group(1) + parser.feed(contents.decode(encoding)) + else: + parser.feed(contents) + parser.close() + result = list(set(result)) # Drop duplicate values. + result.sort() + return result + +# NOT USED. +def copy_files(files, src_dir, dst_dir): + ''' + Copy list of relative file names from src_dir to dst_dir. + ''' + for filename in files: + filename = os.path.normpath(filename) + if os.path.isabs(filename): + continue + src = os.path.join(src_dir, filename) + dst = os.path.join(dst_dir, filename) + if not os.path.exists(dst): + if not os.path.isfile(src): + warning('missing file: %s' % src) + continue + dstdir = os.path.dirname(dst) + shell_makedirs(dstdir) + shell_copy(src, dst) + +def find_files(path, pattern): + ''' + Return list of file names matching pattern in directory path. + ''' + result = [] + for (p,dirs,files) in os.walk(path): + for f in files: + if fnmatch.fnmatch(f, pattern): + result.append(os.path.normpath(os.path.join(p,f))) + return result + +def exec_xsltproc(xsl_file, xml_file, dst_dir, opts = ''): + cwd = os.getcwd() + shell_cd(dst_dir) + try: + shell('"%s" %s "%s" "%s"' % (XSLTPROC, opts, xsl_file, xml_file)) + finally: + shell_cd(cwd) + +def get_source_options(asciidoc_file): + ''' + Look for a2x command options in AsciiDoc source file. + Limitation: options cannot contain double-quote characters. + ''' + def parse_options(): + # Parse options to result sequence. + inquotes = False + opt = '' + for c in options: + if c == '"': + if inquotes: + result.append(opt) + opt = '' + inquotes = False + else: + inquotes = True + elif c == ' ': + if inquotes: + opt += c + elif opt: + result.append(opt) + opt = '' + else: + opt += c + if opt: + result.append(opt) + + result = [] + if os.path.isfile(asciidoc_file): + options = '' + f = open(asciidoc_file) + try: + for line in f: + mo = re.search(r'^//\s*a2x:', line) + if mo: + options += ' ' + line[mo.end():].strip() + finally: + f.close() + parse_options() + return result + + +##################################################################### +# Application class +##################################################################### + +class A2X(AttrDict): + ''' + a2x options and conversion functions. + ''' + + def execute(self): + ''' + Process a2x command. + ''' + self.process_options() + # Append configuration file options. + self.asciidoc_opts += ' ' + ASCIIDOC_OPTS + self.dblatex_opts += ' ' + DBLATEX_OPTS + self.fop_opts += ' ' + FOP_OPTS + self.xsltproc_opts += ' ' + XSLTPROC_OPTS + self.backend_opts += ' ' + BACKEND_OPTS + # Execute to_* functions. + if self.backend: + self.to_backend() + else: + self.__getattribute__('to_'+self.format)() + if not (self.keep_artifacts or self.format == 'docbook' or self.skip_asciidoc): + shell_rm(self.dst_path('.xml')) + + def load_conf(self): + ''' + Load a2x configuration file from default locations and --conf-file + option. + ''' + global ASCIIDOC + CONF_FILE = 'a2x.conf' + a2xdir = os.path.dirname(os.path.realpath(__file__)) + conf_files = [] + # From a2x.py directory. + conf_files.append(os.path.join(a2xdir, CONF_FILE)) + # If the asciidoc executable and conf files are in the a2x directory + # then use the local copy of asciidoc and skip the global a2x conf. + asciidoc = os.path.join(a2xdir, 'asciidoc.py') + asciidoc_conf = os.path.join(a2xdir, 'asciidoc.conf') + if os.path.isfile(asciidoc) and os.path.isfile(asciidoc_conf): + self.asciidoc = asciidoc + else: + self.asciidoc = None + # From global conf directory. + conf_files.append(os.path.join(CONF_DIR, CONF_FILE)) + # From $HOME directory. + home_dir = os.environ.get('HOME') + if home_dir is not None: + conf_files.append(os.path.join(home_dir, '.asciidoc', CONF_FILE)) + # If asciidoc is not local to a2x then search the PATH. + if not self.asciidoc: + self.asciidoc = find_executable(ASCIIDOC) + if not self.asciidoc: + die('unable to find asciidoc: %s' % ASCIIDOC) + # From backend plugin directory. + if self.backend is not None: + stdout = shell(self.asciidoc + ' --backend list')[0] + backends = [(i, os.path.split(i)[1]) for i in stdout.splitlines()] + backend_dir = [i[0] for i in backends if i[1] == self.backend] + if len(backend_dir) == 0: + die('missing %s backend' % self.backend) + if len(backend_dir) > 1: + die('more than one %s backend' % self.backend) + verbose('found %s backend directory: %s' % + (self.backend, backend_dir[0])) + conf_files.append(os.path.join(backend_dir[0], 'a2x-backend.py')) + # From --conf-file option. + if self.conf_file is not None: + if not os.path.isfile(self.conf_file): + die('missing configuration file: %s' % self.conf_file) + conf_files.append(self.conf_file) + # From --xsl-file option. + if self.xsl_file is not None: + if not os.path.isfile(self.xsl_file): + die('missing XSL file: %s' % self.xsl_file) + self.xsl_file = os.path.abspath(self.xsl_file) + # Load ordered files. + for f in conf_files: + if os.path.isfile(f): + verbose('loading configuration file: %s' % f) + execfile(f, globals()) + + def process_options(self): + ''' + Validate and command options and set defaults. + ''' + if not os.path.isfile(self.asciidoc_file): + die('missing SOURCE_FILE: %s' % self.asciidoc_file) + self.asciidoc_file = os.path.abspath(self.asciidoc_file) + if not self.destination_dir: + self.destination_dir = os.path.dirname(self.asciidoc_file) + else: + if not os.path.isdir(self.destination_dir): + die('missing --destination-dir: %s' % self.destination_dir) + self.destination_dir = os.path.abspath(self.destination_dir) + self.resource_dirs = [] + self.resource_files = [] + if self.resource_manifest: + if not os.path.isfile(self.resource_manifest): + die('missing --resource-manifest: %s' % self.resource_manifest) + f = open(self.resource_manifest) + try: + for r in f: + self.resources.append(r.strip()) + finally: + f.close() + for r in self.resources: + r = os.path.expanduser(r) + r = os.path.expandvars(r) + if r.endswith('/') or r.endswith('\\'): + if os.path.isdir(r): + self.resource_dirs.append(r) + else: + die('missing resource directory: %s' % r) + elif os.path.isdir(r): + self.resource_dirs.append(r) + elif r.startswith('.') and '=' in r: + ext, mimetype = r.split('=') + mimetypes.add_type(mimetype, ext) + else: + self.resource_files.append(r) + for p in (os.path.dirname(self.asciidoc), CONF_DIR): + for d in ('images','stylesheets'): + d = os.path.join(p,d) + if os.path.isdir(d): + self.resource_dirs.append(d) + verbose('resource files: %s' % self.resource_files) + verbose('resource directories: %s' % self.resource_dirs) + if not self.doctype and self.format == 'manpage': + self.doctype = 'manpage' + if self.doctype: + self.asciidoc_opts += ' --doctype %s' % self.doctype + for attr in self.attributes: + self.asciidoc_opts += ' --attribute "%s"' % attr +# self.xsltproc_opts += ' --nonet' + if self.verbose: + self.asciidoc_opts += ' --verbose' + self.dblatex_opts += ' -V' + if self.icons or self.icons_dir: + params = [ + 'callout.graphics 1', + 'navig.graphics 1', + 'admon.textlabel 0', + 'admon.graphics 1', + ] + if self.icons_dir: + params += [ + 'admon.graphics.path "%s/"' % self.icons_dir, + 'callout.graphics.path "%s/callouts/"' % self.icons_dir, + 'navig.graphics.path "%s/"' % self.icons_dir, + ] + else: + params = [ + 'callout.graphics 0', + 'navig.graphics 0', + 'admon.textlabel 1', + 'admon.graphics 0', + ] + if self.stylesheet: + params += ['html.stylesheet "%s"' % self.stylesheet] + if self.format == 'htmlhelp': + params += ['htmlhelp.chm "%s"' % self.basename('.chm'), + 'htmlhelp.hhp "%s"' % self.basename('.hhp'), + 'htmlhelp.hhk "%s"' % self.basename('.hhk'), + 'htmlhelp.hhc "%s"' % self.basename('.hhc')] + if self.doctype == 'book': + params += ['toc.section.depth 1'] + # Books are chunked at chapter level. + params += ['chunk.section.depth 0'] + for o in params: + if o.split()[0]+' ' not in self.xsltproc_opts: + self.xsltproc_opts += ' --stringparam ' + o + if self.fop_opts: + self.fop = True + if os.path.splitext(self.asciidoc_file)[1].lower() == '.xml': + self.skip_asciidoc = True + else: + self.skip_asciidoc = False + + def dst_path(self, ext): + ''' + Return name of file or directory in the destination directory with + the same name as the asciidoc source file but with extension ext. + ''' + return os.path.join(self.destination_dir, self.basename(ext)) + + def basename(self, ext): + ''' + Return the base name of the asciidoc source file but with extension + ext. + ''' + return os.path.basename(os.path.splitext(self.asciidoc_file)[0]) + ext + + def asciidoc_conf_file(self, path): + ''' + Return full path name of file in asciidoc configuration files directory. + Search first the directory containing the asciidoc executable then + the global configuration file directory. + ''' + f = os.path.join(os.path.dirname(self.asciidoc), path) + if not os.path.isfile(f): + f = os.path.join(CONF_DIR, path) + if not os.path.isfile(f): + die('missing configuration file: %s' % f) + return os.path.normpath(f) + + def xsl_stylesheet(self, file_name=None): + ''' + Return full path name of file in asciidoc docbook-xsl configuration + directory. + If an XSL file was specified with the --xsl-file option then it is + returned. + ''' + if self.xsl_file is not None: + return self.xsl_file + if not file_name: + file_name = self.format + '.xsl' + return self.asciidoc_conf_file(os.path.join('docbook-xsl', file_name)) + + def copy_resources(self, html_files, src_dir, dst_dir, resources=[]): + ''' + Search html_files for images and CSS resource URIs (html_files can be a + list of file names or a single file name). + Copy them from the src_dir to the dst_dir. + If not found in src_dir then recursively search all specified + resource directories. + Optional additional resources files can be passed in the resources list. + ''' + resources = resources[:] + resources += find_resources(html_files, 'link', 'href', + lambda attrs: attrs.get('type') == 'text/css') + resources += find_resources(html_files, 'img', 'src') + resources += self.resource_files + resources = list(set(resources)) # Drop duplicates. + resources.sort() + for f in resources: + if '=' in f: + src, dst = f.split('=') + if not dst: + dst = src + else: + src = dst = f + src = os.path.normpath(src) + dst = os.path.normpath(dst) + if os.path.isabs(dst): + die('absolute resource file name: %s' % dst) + if dst.startswith(os.pardir): + die('resource file outside destination directory: %s' % dst) + src = os.path.join(src_dir, src) + dst = os.path.join(dst_dir, dst) + if not os.path.isfile(src): + for d in self.resource_dirs: + d = os.path.join(src_dir, d) + found = find_files(d, os.path.basename(src)) + if found: + src = found[0] + break + else: + if not os.path.isfile(dst): + die('missing resource: %s' % src) + continue + # Arrive here if resource file has been found. + if os.path.normpath(src) != os.path.normpath(dst): + dstdir = os.path.dirname(dst) + shell_makedirs(dstdir) + shell_copy(src, dst) + + def to_backend(self): + ''' + Convert AsciiDoc source file to a backend output file using the global + 'to_' function (loaded from backend plugin a2x-backend.py + file). + Executes the global function in an A2X class instance context. + ''' + eval('to_%s(self)' % self.backend) + + def to_docbook(self): + ''' + Use asciidoc to convert asciidoc_file to DocBook. + args is a string containing additional asciidoc arguments. + ''' + docbook_file = self.dst_path('.xml') + if self.skip_asciidoc: + if not os.path.isfile(docbook_file): + die('missing docbook file: %s' % docbook_file) + return + shell('"%s" --backend docbook -a "a2x-format=%s" %s --out-file "%s" "%s"' % + (self.asciidoc, self.format, self.asciidoc_opts, docbook_file, self.asciidoc_file)) + if not self.no_xmllint and XMLLINT: + shell('"%s" --nonet --noout --valid "%s"' % (XMLLINT, docbook_file)) + + def to_xhtml(self): + self.to_docbook() + docbook_file = self.dst_path('.xml') + xhtml_file = self.dst_path('.html') + opts = '%s --output "%s"' % (self.xsltproc_opts, xhtml_file) + exec_xsltproc(self.xsl_stylesheet(), docbook_file, self.destination_dir, opts) + src_dir = os.path.dirname(self.asciidoc_file) + self.copy_resources(xhtml_file, src_dir, self.destination_dir) + + def to_manpage(self): + self.to_docbook() + docbook_file = self.dst_path('.xml') + opts = self.xsltproc_opts + exec_xsltproc(self.xsl_stylesheet(), docbook_file, self.destination_dir, opts) + + def to_pdf(self): + if self.fop: + self.exec_fop() + else: + self.exec_dblatex() + + def exec_fop(self): + self.to_docbook() + docbook_file = self.dst_path('.xml') + xsl = self.xsl_stylesheet('fo.xsl') + fo = self.dst_path('.fo') + pdf = self.dst_path('.pdf') + opts = '%s --output "%s"' % (self.xsltproc_opts, fo) + exec_xsltproc(xsl, docbook_file, self.destination_dir, opts) + shell('"%s" %s -fo "%s" -pdf "%s"' % (FOP, self.fop_opts, fo, pdf)) + if not self.keep_artifacts: + shell_rm(fo) + + def exec_dblatex(self): + self.to_docbook() + docbook_file = self.dst_path('.xml') + xsl = self.asciidoc_conf_file(os.path.join('dblatex','asciidoc-dblatex.xsl')) + sty = self.asciidoc_conf_file(os.path.join('dblatex','asciidoc-dblatex.sty')) + shell('"%s" -t %s -p "%s" -s "%s" %s "%s"' % + (DBLATEX, self.format, xsl, sty, self.dblatex_opts, docbook_file)) + + def to_dvi(self): + self.exec_dblatex() + + def to_ps(self): + self.exec_dblatex() + + def to_tex(self): + self.exec_dblatex() + + def to_htmlhelp(self): + self.to_chunked() + + def to_chunked(self): + self.to_docbook() + docbook_file = self.dst_path('.xml') + opts = self.xsltproc_opts + xsl_file = self.xsl_stylesheet() + if self.format == 'chunked': + dst_dir = self.dst_path('.chunked') + elif self.format == 'htmlhelp': + dst_dir = self.dst_path('.htmlhelp') + if not 'base.dir ' in opts: + opts += ' --stringparam base.dir "%s/"' % os.path.basename(dst_dir) + # Create content. + shell_rmtree(dst_dir) + shell_makedirs(dst_dir) + exec_xsltproc(xsl_file, docbook_file, self.destination_dir, opts) + html_files = find_files(dst_dir, '*.html') + src_dir = os.path.dirname(self.asciidoc_file) + self.copy_resources(html_files, src_dir, dst_dir) + + def update_epub_manifest(self, opf_file): + ''' + Scan the OEBPS directory for any files that have not been registered in + the OPF manifest then add them to the manifest. + ''' + opf_dir = os.path.dirname(opf_file) + resource_files = [] + for (p,dirs,files) in os.walk(os.path.dirname(opf_file)): + for f in files: + f = os.path.join(p,f) + if os.path.isfile(f): + assert f.startswith(opf_dir) + f = '.' + f[len(opf_dir):] + f = os.path.normpath(f) + if f not in ['content.opf']: + resource_files.append(f) + opf = xml.dom.minidom.parseString(read_file(opf_file)) + manifest_files = [] + manifest = opf.getElementsByTagName('manifest')[0] + for el in manifest.getElementsByTagName('item'): + f = el.getAttribute('href') + f = os.path.normpath(f) + manifest_files.append(f) + count = 0 + for f in resource_files: + if f not in manifest_files: + count += 1 + verbose('adding to manifest: %s' % f) + item = opf.createElement('item') + item.setAttribute('href', f.replace(os.path.sep, '/')) + item.setAttribute('id', 'a2x-%d' % count) + mimetype = mimetypes.guess_type(f)[0] + if mimetype is None: + die('unknown mimetype: %s' % f) + item.setAttribute('media-type', mimetype) + manifest.appendChild(item) + if count > 0: + write_file(opf_file, opf.toxml()) + + def to_epub(self): + self.to_docbook() + xsl_file = self.xsl_stylesheet() + docbook_file = self.dst_path('.xml') + epub_file = self.dst_path('.epub') + build_dir = epub_file + '.d' + shell_rmtree(build_dir) + shell_makedirs(build_dir) + # Create content. + exec_xsltproc(xsl_file, docbook_file, build_dir, self.xsltproc_opts) + # Copy resources referenced in the OPF and resources referenced by the + # generated HTML (in theory DocBook XSL should ensure they are + # identical but this is not always the case). + src_dir = os.path.dirname(self.asciidoc_file) + dst_dir = os.path.join(build_dir, 'OEBPS') + opf_file = os.path.join(dst_dir, 'content.opf') + opf_resources = find_resources(opf_file, 'item', 'href') + html_files = find_files(dst_dir, '*.html') + self.copy_resources(html_files, src_dir, dst_dir, opf_resources) + # Register any unregistered resources. + self.update_epub_manifest(opf_file) + # Build epub archive. + cwd = os.getcwd() + shell_cd(build_dir) + try: + if not self.dry_run: + zip = zipfile.ZipFile(epub_file, 'w') + try: + # Create and add uncompressed mimetype file. + verbose('archiving: mimetype') + write_file('mimetype', 'application/epub+zip') + zip.write('mimetype', compress_type=zipfile.ZIP_STORED) + # Compress all remaining files. + for (p,dirs,files) in os.walk('.'): + for f in files: + f = os.path.normpath(os.path.join(p,f)) + if f != 'mimetype': + verbose('archiving: %s' % f) + zip.write(f, compress_type=zipfile.ZIP_DEFLATED) + finally: + zip.close() + verbose('created archive: %s' % epub_file) + finally: + shell_cd(cwd) + if not self.keep_artifacts: + shell_rmtree(build_dir) + if self.epubcheck and EPUBCHECK: + if not find_executable(EPUBCHECK): + warning('epubcheck skipped: unable to find executable: %s' % EPUBCHECK) + else: + shell('"%s" "%s"' % (EPUBCHECK, epub_file)) + + def to_text(self): + text_file = self.dst_path('.text') + html_file = self.dst_path('.text.html') + if self.lynx: + shell('"%s" %s --conf-file "%s" -b html4 -a "a2x-format=%s" -o "%s" "%s"' % + (self.asciidoc, self.asciidoc_opts, self.asciidoc_conf_file('text.conf'), + self.format, html_file, self.asciidoc_file)) + shell('"%s" -dump "%s" > "%s"' % + (LYNX, html_file, text_file)) + else: + # Use w3m(1). + self.to_docbook() + docbook_file = self.dst_path('.xml') + opts = '%s --output "%s"' % (self.xsltproc_opts, html_file) + exec_xsltproc(self.xsl_stylesheet(), docbook_file, + self.destination_dir, opts) + shell('"%s" -cols 70 -dump -T text/html -no-graph "%s" > "%s"' % + (W3M, html_file, text_file)) + if not self.keep_artifacts: + shell_rm(html_file) + + +##################################################################### +# Script main line. +##################################################################### + +if __name__ == '__main__': + description = '''A toolchain manager for AsciiDoc (converts Asciidoc text files to other file formats)''' + from optparse import OptionParser + parser = OptionParser(usage='usage: %prog [OPTIONS] SOURCE_FILE', + version='%s %s' % (PROG,VERSION), + description=description) + parser.add_option('-a', '--attribute', + action='append', dest='attributes', default=[], metavar='ATTRIBUTE', + help='set asciidoc attribute value') + parser.add_option('--asciidoc-opts', + action='append', dest='asciidoc_opts', default=[], + metavar='ASCIIDOC_OPTS', help='asciidoc options') + #DEPRECATED + parser.add_option('--copy', + action='store_true', dest='copy', default=False, + help='DEPRECATED: does nothing') + parser.add_option('--conf-file', + dest='conf_file', default=None, metavar='CONF_FILE', + help='configuration file') + parser.add_option('-D', '--destination-dir', + action='store', dest='destination_dir', default=None, metavar='PATH', + help='output directory (defaults to SOURCE_FILE directory)') + parser.add_option('-d','--doctype', + action='store', dest='doctype', metavar='DOCTYPE', + choices=('article','manpage','book'), + help='article, manpage, book') + parser.add_option('-b','--backend', + action='store', dest='backend', metavar='BACKEND', + help='name of backend plugin') + parser.add_option('--epubcheck', + action='store_true', dest='epubcheck', default=False, + help='check EPUB output with epubcheck') + parser.add_option('-f','--format', + action='store', dest='format', metavar='FORMAT', default = 'pdf', + choices=('chunked','epub','htmlhelp','manpage','pdf', 'text', + 'xhtml','dvi','ps','tex','docbook'), + help='chunked, epub, htmlhelp, manpage, pdf, text, xhtml, dvi, ps, tex, docbook') + parser.add_option('--icons', + action='store_true', dest='icons', default=False, + help='use admonition, callout and navigation icons') + parser.add_option('--icons-dir', + action='store', dest='icons_dir', + default=None, metavar='PATH', + help='admonition and navigation icon directory') + parser.add_option('-k', '--keep-artifacts', + action='store_true', dest='keep_artifacts', default=False, + help='do not delete temporary build files') + parser.add_option('--lynx', + action='store_true', dest='lynx', default=False, + help='use lynx to generate text files') + parser.add_option('-L', '--no-xmllint', + action='store_true', dest='no_xmllint', default=False, + help='do not check asciidoc output with xmllint') + parser.add_option('-n','--dry-run', + action='store_true', dest='dry_run', default=False, + help='just print the commands that would have been executed') + parser.add_option('-r','--resource', + action='append', dest='resources', default=[], + metavar='PATH', + help='resource file or directory containing resource files') + parser.add_option('-m', '--resource-manifest', + action='store', dest='resource_manifest', default=None, metavar='FILE', + help='read resources from FILE') + #DEPRECATED + parser.add_option('--resource-dir', + action='append', dest='resources', default=[], + metavar='PATH', + help='DEPRECATED: use --resource') + #DEPRECATED + parser.add_option('-s','--skip-asciidoc', + action='store_true', dest='skip_asciidoc', default=False, + help='DEPRECATED: redundant') + parser.add_option('--stylesheet', + action='store', dest='stylesheet', default=None, + metavar='STYLESHEET', + help='HTML CSS stylesheet file name') + #DEPRECATED + parser.add_option('--safe', + action='store_true', dest='safe', default=False, + help='DEPRECATED: does nothing') + parser.add_option('--dblatex-opts', + action='append', dest='dblatex_opts', default=[], + metavar='DBLATEX_OPTS', help='dblatex options') + parser.add_option('--backend-opts', + action='append', dest='backend_opts', default=[], + metavar='BACKEND_OPTS', help='backend plugin options') + parser.add_option('--fop', + action='store_true', dest='fop', default=False, + help='use FOP to generate PDF files') + parser.add_option('--fop-opts', + action='append', dest='fop_opts', default=[], + metavar='FOP_OPTS', help='options for FOP pdf generation') + parser.add_option('--xsltproc-opts', + action='append', dest='xsltproc_opts', default=[], + metavar='XSLTPROC_OPTS', help='xsltproc options for XSL stylesheets') + parser.add_option('--xsl-file', + action='store', dest='xsl_file', metavar='XSL_FILE', + help='custom XSL stylesheet') + parser.add_option('-v', '--verbose', + action='count', dest='verbose', default=0, + help='increase verbosity') + if len(sys.argv) == 1: + parser.parse_args(['--help']) + source_options = get_source_options(sys.argv[-1]) + argv = source_options + sys.argv[1:] + opts, args = parser.parse_args(argv) + if len(args) != 1: + parser.error('incorrect number of arguments') + opts.asciidoc_opts = ' '.join(opts.asciidoc_opts) + opts.dblatex_opts = ' '.join(opts.dblatex_opts) + opts.fop_opts = ' '.join(opts.fop_opts) + opts.xsltproc_opts = ' '.join(opts.xsltproc_opts) + opts.backend_opts = ' '.join(opts.backend_opts) + opts = eval(str(opts)) # Convert optparse.Values to dict. + a2x = A2X(opts) + OPTIONS = a2x # verbose and dry_run used by utility functions. + verbose('args: %r' % argv) + a2x.asciidoc_file = args[0] + try: + a2x.load_conf() + a2x.execute() + except KeyboardInterrupt: + exit(1) diff --git a/source-builder/sb/asciidoc/asciidoc.conf b/source-builder/sb/asciidoc/asciidoc.conf index cb9fb5b..fab1a22 100644 --- a/source-builder/sb/asciidoc/asciidoc.conf +++ b/source-builder/sb/asciidoc/asciidoc.conf @@ -42,7 +42,6 @@ deg=° backslash=\ two-colons=:: two-semicolons=;; -plus=+ # DEPRECATED: underscore attribute names. two_colons=:: two_semicolons=;; @@ -220,7 +219,7 @@ template::[partintroblock] # (?s) re flag for line spanning. # Macros using default syntax. -(?su)(?http|https|ftp|file|irc|mailto|callto|image|link|anchor|xref|indexterm|indexterm2):(?P\S*?)\[(?P.*?)(?http|https|ftp|file|irc|mailto|callto|image|link|anchor|xref|indexterm):(?P\S*?)\[(?P.*?)(?http|https|ftp|file|irc):(?P//[^\s<>]*[\w/])= diff --git a/source-builder/sb/asciidoc/asciidoc.py b/source-builder/sb/asciidoc/asciidoc.py index 6128173..8c68895 100755 --- a/source-builder/sb/asciidoc/asciidoc.py +++ b/source-builder/sb/asciidoc/asciidoc.py @@ -3632,8 +3632,6 @@ class Table(AbstractBlock): # (the tab character does not appear elsewhere since it is expanded on # input) which are replaced after template attribute substitution. headrows = footrows = bodyrows = None - for option in self.parameters.options: - self.attributes[option+'-option'] = '' if self.rows and 'header' in self.parameters.options: headrows = self.subs_rows(self.rows[0:1],'header') self.attributes['headrows'] = '\x07headrows\x07' @@ -4809,17 +4807,18 @@ class Config: def load_miscellaneous(self,d): """Set miscellaneous configuration entries from dictionary 'd'.""" - def set_if_int_ge(name, d, min_value): + def set_if_int_gt_zero(name, d): if name in d: try: val = int(d[name]) - if not val >= min_value: - raise ValueError, "not >= " + str(min_value) - setattr(self, name, val) + if not val > 0: + raise ValueError, "not > 0" + if val > 0: + setattr(self, name, val) except ValueError: raise EAsciiDoc, 'illegal [miscellaneous] %s entry' % name - set_if_int_ge('tabsize', d, 0) - set_if_int_ge('textwidth', d, 1) # DEPRECATED: Old tables only. + set_if_int_gt_zero('tabsize', d) + set_if_int_gt_zero('textwidth', d) # DEPRECATED: Old tables only. if 'pagewidth' in d: try: @@ -6000,10 +5999,6 @@ def asciidoc(backend, doctype, confiles, infile, outfile, options): # Document header attributes override conf file attributes. document.attributes.update(AttributeEntry.attributes) document.update_attributes() - # Set the default embedded icons directory. - if 'data-uri' in document.attributes and not os.path.isdir(document.attributes['iconsdir']): - document.attributes['iconsdir'] = os.path.join( - document.attributes['asciidoc-confdir'], 'images/icons') # Configuration is fully loaded. config.expand_all_templates() # Check configuration for consistency. diff --git a/source-builder/sb/asciidoc/asciidocapi.py b/source-builder/sb/asciidoc/asciidocapi.py new file mode 100644 index 0000000..dcdf262 --- /dev/null +++ b/source-builder/sb/asciidoc/asciidocapi.py @@ -0,0 +1,257 @@ +#!/usr/bin/env python +""" +asciidocapi - AsciiDoc API wrapper class. + +The AsciiDocAPI class provides an API for executing asciidoc. Minimal example +compiles `mydoc.txt` to `mydoc.html`: + + import asciidocapi + asciidoc = asciidocapi.AsciiDocAPI() + asciidoc.execute('mydoc.txt') + +- Full documentation in asciidocapi.txt. +- See the doctests below for more examples. + +Doctests: + +1. Check execution: + + >>> import StringIO + >>> infile = StringIO.StringIO('Hello *{author}*') + >>> outfile = StringIO.StringIO() + >>> asciidoc = AsciiDocAPI() + >>> asciidoc.options('--no-header-footer') + >>> asciidoc.attributes['author'] = 'Joe Bloggs' + >>> asciidoc.execute(infile, outfile, backend='html4') + >>> print outfile.getvalue() +

Hello Joe Bloggs

+ + >>> asciidoc.attributes['author'] = 'Bill Smith' + >>> infile = StringIO.StringIO('Hello _{author}_') + >>> outfile = StringIO.StringIO() + >>> asciidoc.execute(infile, outfile, backend='docbook') + >>> print outfile.getvalue() + Hello Bill Smith + +2. Check error handling: + + >>> import StringIO + >>> asciidoc = AsciiDocAPI() + >>> infile = StringIO.StringIO('---------') + >>> outfile = StringIO.StringIO() + >>> asciidoc.execute(infile, outfile) + Traceback (most recent call last): + File "", line 1, in + File "asciidocapi.py", line 189, in execute + raise AsciiDocError(self.messages[-1]) + AsciiDocError: ERROR: : line 1: [blockdef-listing] missing closing delimiter + + +Copyright (C) 2009 Stuart Rackham. Free use of this software is granted +under the terms of the GNU General Public License (GPL). + +""" + +import sys,os,re,imp + +API_VERSION = '0.1.2' +MIN_ASCIIDOC_VERSION = '8.4.1' # Minimum acceptable AsciiDoc version. + + +def find_in_path(fname, path=None): + """ + Find file fname in paths. Return None if not found. + """ + if path is None: + path = os.environ.get('PATH', '') + for dir in path.split(os.pathsep): + fpath = os.path.join(dir, fname) + if os.path.isfile(fpath): + return fpath + else: + return None + + +class AsciiDocError(Exception): + pass + + +class Options(object): + """ + Stores asciidoc(1) command options. + """ + def __init__(self, values=[]): + self.values = values[:] + def __call__(self, name, value=None): + """Shortcut for append method.""" + self.append(name, value) + def append(self, name, value=None): + if type(value) in (int,float): + value = str(value) + self.values.append((name,value)) + + +class Version(object): + """ + Parse and compare AsciiDoc version numbers. Instance attributes: + + string: String version number '.[.][suffix]'. + major: Integer major version number. + minor: Integer minor version number. + micro: Integer micro version number. + suffix: Suffix (begins with non-numeric character) is ignored when + comparing. + + Doctest examples: + + >>> Version('8.2.5') < Version('8.3 beta 1') + True + >>> Version('8.3.0') == Version('8.3. beta 1') + True + >>> Version('8.2.0') < Version('8.20') + True + >>> Version('8.20').major + 8 + >>> Version('8.20').minor + 20 + >>> Version('8.20').micro + 0 + >>> Version('8.20').suffix + '' + >>> Version('8.20 beta 1').suffix + 'beta 1' + + """ + def __init__(self, version): + self.string = version + reo = re.match(r'^(\d+)\.(\d+)(\.(\d+))?\s*(.*?)\s*$', self.string) + if not reo: + raise ValueError('invalid version number: %s' % self.string) + groups = reo.groups() + self.major = int(groups[0]) + self.minor = int(groups[1]) + self.micro = int(groups[3] or '0') + self.suffix = groups[4] or '' + def __cmp__(self, other): + result = cmp(self.major, other.major) + if result == 0: + result = cmp(self.minor, other.minor) + if result == 0: + result = cmp(self.micro, other.micro) + return result + + +class AsciiDocAPI(object): + """ + AsciiDoc API class. + """ + def __init__(self, asciidoc_py=None): + """ + Locate and import asciidoc.py. + Initialize instance attributes. + """ + self.options = Options() + self.attributes = {} + self.messages = [] + # Search for the asciidoc command file. + # Try ASCIIDOC_PY environment variable first. + cmd = os.environ.get('ASCIIDOC_PY') + if cmd: + if not os.path.isfile(cmd): + raise AsciiDocError('missing ASCIIDOC_PY file: %s' % cmd) + elif asciidoc_py: + # Next try path specified by caller. + cmd = asciidoc_py + if not os.path.isfile(cmd): + raise AsciiDocError('missing file: %s' % cmd) + else: + # Try shell search paths. + for fname in ['asciidoc.py','asciidoc.pyc','asciidoc']: + cmd = find_in_path(fname) + if cmd: break + else: + # Finally try current working directory. + for cmd in ['asciidoc.py','asciidoc.pyc','asciidoc']: + if os.path.isfile(cmd): break + else: + raise AsciiDocError('failed to locate asciidoc') + self.cmd = os.path.realpath(cmd) + self.__import_asciidoc() + + def __import_asciidoc(self, reload=False): + ''' + Import asciidoc module (script or compiled .pyc). + See + http://groups.google.com/group/asciidoc/browse_frm/thread/66e7b59d12cd2f91 + for an explanation of why a seemingly straight-forward job turned out + quite complicated. + ''' + if os.path.splitext(self.cmd)[1] in ['.py','.pyc']: + sys.path.insert(0, os.path.dirname(self.cmd)) + try: + try: + if reload: + import __builtin__ # Because reload() is shadowed. + __builtin__.reload(self.asciidoc) + else: + import asciidoc + self.asciidoc = asciidoc + except ImportError: + raise AsciiDocError('failed to import ' + self.cmd) + finally: + del sys.path[0] + else: + # The import statement can only handle .py or .pyc files, have to + # use imp.load_source() for scripts with other names. + try: + imp.load_source('asciidoc', self.cmd) + import asciidoc + self.asciidoc = asciidoc + except ImportError: + raise AsciiDocError('failed to import ' + self.cmd) + if Version(self.asciidoc.VERSION) < Version(MIN_ASCIIDOC_VERSION): + raise AsciiDocError( + 'asciidocapi %s requires asciidoc %s or better' + % (API_VERSION, MIN_ASCIIDOC_VERSION)) + + def execute(self, infile, outfile=None, backend=None): + """ + Compile infile to outfile using backend format. + infile can outfile can be file path strings or file like objects. + """ + self.messages = [] + opts = Options(self.options.values) + if outfile is not None: + opts('--out-file', outfile) + if backend is not None: + opts('--backend', backend) + for k,v in self.attributes.items(): + if v == '' or k[-1] in '!@': + s = k + elif v is None: # A None value undefines the attribute. + s = k + '!' + else: + s = '%s=%s' % (k,v) + opts('--attribute', s) + args = [infile] + # The AsciiDoc command was designed to process source text then + # exit, there are globals and statics in asciidoc.py that have + # to be reinitialized before each run -- hence the reload. + self.__import_asciidoc(reload=True) + try: + try: + self.asciidoc.execute(self.cmd, opts.values, args) + finally: + self.messages = self.asciidoc.messages[:] + except SystemExit, e: + if e.code: + raise AsciiDocError(self.messages[-1]) + + +if __name__ == "__main__": + """ + Run module doctests. + """ + import doctest + options = doctest.NORMALIZE_WHITESPACE + doctest.ELLIPSIS + doctest.testmod(optionflags=options) diff --git a/source-builder/sb/asciidoc/configure b/source-builder/sb/asciidoc/configure new file mode 100755 index 0000000..4c61b21 --- /dev/null +++ b/source-builder/sb/asciidoc/configure @@ -0,0 +1,3033 @@ +#! /bin/sh +# Guess values for system-dependent variables and create Makefiles. +# Generated by GNU Autoconf 2.68 for asciidoc 8.6.8. +# +# +# Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, +# 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software +# Foundation, Inc. +# +# +# This configure script is free software; the Free Software Foundation +# gives unlimited permission to copy, distribute and modify it. +## -------------------- ## +## M4sh Initialization. ## +## -------------------- ## + +# Be more Bourne compatible +DUALCASE=1; export DUALCASE # for MKS sh +if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then : + emulate sh + NULLCMD=: + # Pre-4.2 versions of Zsh do word splitting on ${1+"$@"}, which + # is contrary to our usage. Disable this feature. + alias -g '${1+"$@"}'='"$@"' + setopt NO_GLOB_SUBST +else + case `(set -o) 2>/dev/null` in #( + *posix*) : + set -o posix ;; #( + *) : + ;; +esac +fi + + +as_nl=' +' +export as_nl +# Printing a long string crashes Solaris 7 /usr/bin/printf. +as_echo='\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\' +as_echo=$as_echo$as_echo$as_echo$as_echo$as_echo +as_echo=$as_echo$as_echo$as_echo$as_echo$as_echo$as_echo +# Prefer a ksh shell builtin over an external printf program on Solaris, +# but without wasting forks for bash or zsh. +if test -z "$BASH_VERSION$ZSH_VERSION" \ + && (test "X`print -r -- $as_echo`" = "X$as_echo") 2>/dev/null; then + as_echo='print -r --' + as_echo_n='print -rn --' +elif (test "X`printf %s $as_echo`" = "X$as_echo") 2>/dev/null; then + as_echo='printf %s\n' + as_echo_n='printf %s' +else + if test "X`(/usr/ucb/echo -n -n $as_echo) 2>/dev/null`" = "X-n $as_echo"; then + as_echo_body='eval /usr/ucb/echo -n "$1$as_nl"' + as_echo_n='/usr/ucb/echo -n' + else + as_echo_body='eval expr "X$1" : "X\\(.*\\)"' + as_echo_n_body='eval + arg=$1; + case $arg in #( + *"$as_nl"*) + expr "X$arg" : "X\\(.*\\)$as_nl"; + arg=`expr "X$arg" : ".*$as_nl\\(.*\\)"`;; + esac; + expr "X$arg" : "X\\(.*\\)" | tr -d "$as_nl" + ' + export as_echo_n_body + as_echo_n='sh -c $as_echo_n_body as_echo' + fi + export as_echo_body + as_echo='sh -c $as_echo_body as_echo' +fi + +# The user is always right. +if test "${PATH_SEPARATOR+set}" != set; then + PATH_SEPARATOR=: + (PATH='/bin;/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 && { + (PATH='/bin:/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 || + PATH_SEPARATOR=';' + } +fi + + +# IFS +# We need space, tab and new line, in precisely that order. Quoting is +# there to prevent editors from complaining about space-tab. +# (If _AS_PATH_WALK were called with IFS unset, it would disable word +# splitting by setting IFS to empty value.) +IFS=" "" $as_nl" + +# Find who we are. Look in the path if we contain no directory separator. +as_myself= +case $0 in #(( + *[\\/]* ) as_myself=$0 ;; + *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + test -r "$as_dir/$0" && as_myself=$as_dir/$0 && break + done +IFS=$as_save_IFS + + ;; +esac +# We did not find ourselves, most probably we were run as `sh COMMAND' +# in which case we are not to be found in the path. +if test "x$as_myself" = x; then + as_myself=$0 +fi +if test ! -f "$as_myself"; then + $as_echo "$as_myself: error: cannot find myself; rerun with an absolute file name" >&2 + exit 1 +fi + +# Unset variables that we do not need and which cause bugs (e.g. in +# pre-3.0 UWIN ksh). But do not cause bugs in bash 2.01; the "|| exit 1" +# suppresses any "Segmentation fault" message there. '((' could +# trigger a bug in pdksh 5.2.14. +for as_var in BASH_ENV ENV MAIL MAILPATH +do eval test x\${$as_var+set} = xset \ + && ( (unset $as_var) || exit 1) >/dev/null 2>&1 && unset $as_var || : +done +PS1='$ ' +PS2='> ' +PS4='+ ' + +# NLS nuisances. +LC_ALL=C +export LC_ALL +LANGUAGE=C +export LANGUAGE + +# CDPATH. +(unset CDPATH) >/dev/null 2>&1 && unset CDPATH + +if test "x$CONFIG_SHELL" = x; then + as_bourne_compatible="if test -n \"\${ZSH_VERSION+set}\" && (emulate sh) >/dev/null 2>&1; then : + emulate sh + NULLCMD=: + # Pre-4.2 versions of Zsh do word splitting on \${1+\"\$@\"}, which + # is contrary to our usage. Disable this feature. + alias -g '\${1+\"\$@\"}'='\"\$@\"' + setopt NO_GLOB_SUBST +else + case \`(set -o) 2>/dev/null\` in #( + *posix*) : + set -o posix ;; #( + *) : + ;; +esac +fi +" + as_required="as_fn_return () { (exit \$1); } +as_fn_success () { as_fn_return 0; } +as_fn_failure () { as_fn_return 1; } +as_fn_ret_success () { return 0; } +as_fn_ret_failure () { return 1; } + +exitcode=0 +as_fn_success || { exitcode=1; echo as_fn_success failed.; } +as_fn_failure && { exitcode=1; echo as_fn_failure succeeded.; } +as_fn_ret_success || { exitcode=1; echo as_fn_ret_success failed.; } +as_fn_ret_failure && { exitcode=1; echo as_fn_ret_failure succeeded.; } +if ( set x; as_fn_ret_success y && test x = \"\$1\" ); then : + +else + exitcode=1; echo positional parameters were not saved. +fi +test x\$exitcode = x0 || exit 1" + as_suggested=" as_lineno_1=";as_suggested=$as_suggested$LINENO;as_suggested=$as_suggested" as_lineno_1a=\$LINENO + as_lineno_2=";as_suggested=$as_suggested$LINENO;as_suggested=$as_suggested" as_lineno_2a=\$LINENO + eval 'test \"x\$as_lineno_1'\$as_run'\" != \"x\$as_lineno_2'\$as_run'\" && + test \"x\`expr \$as_lineno_1'\$as_run' + 1\`\" = \"x\$as_lineno_2'\$as_run'\"' || exit 1 +test \$(( 1 + 1 )) = 2 || exit 1" + if (eval "$as_required") 2>/dev/null; then : + as_have_required=yes +else + as_have_required=no +fi + if test x$as_have_required = xyes && (eval "$as_suggested") 2>/dev/null; then : + +else + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +as_found=false +for as_dir in /bin$PATH_SEPARATOR/usr/bin$PATH_SEPARATOR$PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + as_found=: + case $as_dir in #( + /*) + for as_base in sh bash ksh sh5; do + # Try only shells that exist, to save several forks. + as_shell=$as_dir/$as_base + if { test -f "$as_shell" || test -f "$as_shell.exe"; } && + { $as_echo "$as_bourne_compatible""$as_required" | as_run=a "$as_shell"; } 2>/dev/null; then : + CONFIG_SHELL=$as_shell as_have_required=yes + if { $as_echo "$as_bourne_compatible""$as_suggested" | as_run=a "$as_shell"; } 2>/dev/null; then : + break 2 +fi +fi + done;; + esac + as_found=false +done +$as_found || { if { test -f "$SHELL" || test -f "$SHELL.exe"; } && + { $as_echo "$as_bourne_compatible""$as_required" | as_run=a "$SHELL"; } 2>/dev/null; then : + CONFIG_SHELL=$SHELL as_have_required=yes +fi; } +IFS=$as_save_IFS + + + if test "x$CONFIG_SHELL" != x; then : + # We cannot yet assume a decent shell, so we have to provide a + # neutralization value for shells without unset; and this also + # works around shells that cannot unset nonexistent variables. + # Preserve -v and -x to the replacement shell. + BASH_ENV=/dev/null + ENV=/dev/null + (unset BASH_ENV) >/dev/null 2>&1 && unset BASH_ENV ENV + export CONFIG_SHELL + case $- in # (((( + *v*x* | *x*v* ) as_opts=-vx ;; + *v* ) as_opts=-v ;; + *x* ) as_opts=-x ;; + * ) as_opts= ;; + esac + exec "$CONFIG_SHELL" $as_opts "$as_myself" ${1+"$@"} +fi + + if test x$as_have_required = xno; then : + $as_echo "$0: This script requires a shell more modern than all" + $as_echo "$0: the shells that I found on your system." + if test x${ZSH_VERSION+set} = xset ; then + $as_echo "$0: In particular, zsh $ZSH_VERSION has bugs and should" + $as_echo "$0: be upgraded to zsh 4.3.4 or later." + else + $as_echo "$0: Please tell bug-autoconf@gnu.org about your system, +$0: including any error possibly output before this +$0: message. Then install a modern shell, or manually run +$0: the script under such a shell if you do have one." + fi + exit 1 +fi +fi +fi +SHELL=${CONFIG_SHELL-/bin/sh} +export SHELL +# Unset more variables known to interfere with behavior of common tools. +CLICOLOR_FORCE= GREP_OPTIONS= +unset CLICOLOR_FORCE GREP_OPTIONS + +## --------------------- ## +## M4sh Shell Functions. ## +## --------------------- ## +# as_fn_unset VAR +# --------------- +# Portably unset VAR. +as_fn_unset () +{ + { eval $1=; unset $1;} +} +as_unset=as_fn_unset + +# as_fn_set_status STATUS +# ----------------------- +# Set $? to STATUS, without forking. +as_fn_set_status () +{ + return $1 +} # as_fn_set_status + +# as_fn_exit STATUS +# ----------------- +# Exit the shell with STATUS, even in a "trap 0" or "set -e" context. +as_fn_exit () +{ + set +e + as_fn_set_status $1 + exit $1 +} # as_fn_exit + +# as_fn_mkdir_p +# ------------- +# Create "$as_dir" as a directory, including parents if necessary. +as_fn_mkdir_p () +{ + + case $as_dir in #( + -*) as_dir=./$as_dir;; + esac + test -d "$as_dir" || eval $as_mkdir_p || { + as_dirs= + while :; do + case $as_dir in #( + *\'*) as_qdir=`$as_echo "$as_dir" | sed "s/'/'\\\\\\\\''/g"`;; #'( + *) as_qdir=$as_dir;; + esac + as_dirs="'$as_qdir' $as_dirs" + as_dir=`$as_dirname -- "$as_dir" || +$as_expr X"$as_dir" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ + X"$as_dir" : 'X\(//\)[^/]' \| \ + X"$as_dir" : 'X\(//\)$' \| \ + X"$as_dir" : 'X\(/\)' \| . 2>/dev/null || +$as_echo X"$as_dir" | + sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ + s//\1/ + q + } + /^X\(\/\/\)[^/].*/{ + s//\1/ + q + } + /^X\(\/\/\)$/{ + s//\1/ + q + } + /^X\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + test -d "$as_dir" && break + done + test -z "$as_dirs" || eval "mkdir $as_dirs" + } || test -d "$as_dir" || as_fn_error $? "cannot create directory $as_dir" + + +} # as_fn_mkdir_p +# as_fn_append VAR VALUE +# ---------------------- +# Append the text in VALUE to the end of the definition contained in VAR. Take +# advantage of any shell optimizations that allow amortized linear growth over +# repeated appends, instead of the typical quadratic growth present in naive +# implementations. +if (eval "as_var=1; as_var+=2; test x\$as_var = x12") 2>/dev/null; then : + eval 'as_fn_append () + { + eval $1+=\$2 + }' +else + as_fn_append () + { + eval $1=\$$1\$2 + } +fi # as_fn_append + +# as_fn_arith ARG... +# ------------------ +# Perform arithmetic evaluation on the ARGs, and store the result in the +# global $as_val. Take advantage of shells that can avoid forks. The arguments +# must be portable across $(()) and expr. +if (eval "test \$(( 1 + 1 )) = 2") 2>/dev/null; then : + eval 'as_fn_arith () + { + as_val=$(( $* )) + }' +else + as_fn_arith () + { + as_val=`expr "$@" || test $? -eq 1` + } +fi # as_fn_arith + + +# as_fn_error STATUS ERROR [LINENO LOG_FD] +# ---------------------------------------- +# Output "`basename $0`: error: ERROR" to stderr. If LINENO and LOG_FD are +# provided, also output the error to LOG_FD, referencing LINENO. Then exit the +# script with STATUS, using 1 if that was 0. +as_fn_error () +{ + as_status=$1; test $as_status -eq 0 && as_status=1 + if test "$4"; then + as_lineno=${as_lineno-"$3"} as_lineno_stack=as_lineno_stack=$as_lineno_stack + $as_echo "$as_me:${as_lineno-$LINENO}: error: $2" >&$4 + fi + $as_echo "$as_me: error: $2" >&2 + as_fn_exit $as_status +} # as_fn_error + +if expr a : '\(a\)' >/dev/null 2>&1 && + test "X`expr 00001 : '.*\(...\)'`" = X001; then + as_expr=expr +else + as_expr=false +fi + +if (basename -- /) >/dev/null 2>&1 && test "X`basename -- / 2>&1`" = "X/"; then + as_basename=basename +else + as_basename=false +fi + +if (as_dir=`dirname -- /` && test "X$as_dir" = X/) >/dev/null 2>&1; then + as_dirname=dirname +else + as_dirname=false +fi + +as_me=`$as_basename -- "$0" || +$as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ + X"$0" : 'X\(//\)$' \| \ + X"$0" : 'X\(/\)' \| . 2>/dev/null || +$as_echo X/"$0" | + sed '/^.*\/\([^/][^/]*\)\/*$/{ + s//\1/ + q + } + /^X\/\(\/\/\)$/{ + s//\1/ + q + } + /^X\/\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + +# Avoid depending upon Character Ranges. +as_cr_letters='abcdefghijklmnopqrstuvwxyz' +as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' +as_cr_Letters=$as_cr_letters$as_cr_LETTERS +as_cr_digits='0123456789' +as_cr_alnum=$as_cr_Letters$as_cr_digits + + + as_lineno_1=$LINENO as_lineno_1a=$LINENO + as_lineno_2=$LINENO as_lineno_2a=$LINENO + eval 'test "x$as_lineno_1'$as_run'" != "x$as_lineno_2'$as_run'" && + test "x`expr $as_lineno_1'$as_run' + 1`" = "x$as_lineno_2'$as_run'"' || { + # Blame Lee E. McMahon (1931-1989) for sed's syntax. :-) + sed -n ' + p + /[$]LINENO/= + ' <$as_myself | + sed ' + s/[$]LINENO.*/&-/ + t lineno + b + :lineno + N + :loop + s/[$]LINENO\([^'$as_cr_alnum'_].*\n\)\(.*\)/\2\1\2/ + t loop + s/-\n.*// + ' >$as_me.lineno && + chmod +x "$as_me.lineno" || + { $as_echo "$as_me: error: cannot create $as_me.lineno; rerun with a POSIX shell" >&2; as_fn_exit 1; } + + # Don't try to exec as it changes $[0], causing all sort of problems + # (the dirname of $[0] is not the place where we might find the + # original and so on. Autoconf is especially sensitive to this). + . "./$as_me.lineno" + # Exit status is that of the last command. + exit +} + +ECHO_C= ECHO_N= ECHO_T= +case `echo -n x` in #((((( +-n*) + case `echo 'xy\c'` in + *c*) ECHO_T=' ';; # ECHO_T is single tab character. + xy) ECHO_C='\c';; + *) echo `echo ksh88 bug on AIX 6.1` > /dev/null + ECHO_T=' ';; + esac;; +*) + ECHO_N='-n';; +esac + +rm -f conf$$ conf$$.exe conf$$.file +if test -d conf$$.dir; then + rm -f conf$$.dir/conf$$.file +else + rm -f conf$$.dir + mkdir conf$$.dir 2>/dev/null +fi +if (echo >conf$$.file) 2>/dev/null; then + if ln -s conf$$.file conf$$ 2>/dev/null; then + as_ln_s='ln -s' + # ... but there are two gotchas: + # 1) On MSYS, both `ln -s file dir' and `ln file dir' fail. + # 2) DJGPP < 2.04 has no symlinks; `ln -s' creates a wrapper executable. + # In both cases, we have to default to `cp -p'. + ln -s conf$$.file conf$$.dir 2>/dev/null && test ! -f conf$$.exe || + as_ln_s='cp -p' + elif ln conf$$.file conf$$ 2>/dev/null; then + as_ln_s=ln + else + as_ln_s='cp -p' + fi +else + as_ln_s='cp -p' +fi +rm -f conf$$ conf$$.exe conf$$.dir/conf$$.file conf$$.file +rmdir conf$$.dir 2>/dev/null + +if mkdir -p . 2>/dev/null; then + as_mkdir_p='mkdir -p "$as_dir"' +else + test -d ./-p && rmdir ./-p + as_mkdir_p=false +fi + +if test -x / >/dev/null 2>&1; then + as_test_x='test -x' +else + if ls -dL / >/dev/null 2>&1; then + as_ls_L_option=L + else + as_ls_L_option= + fi + as_test_x=' + eval sh -c '\'' + if test -d "$1"; then + test -d "$1/."; + else + case $1 in #( + -*)set "./$1";; + esac; + case `ls -ld'$as_ls_L_option' "$1" 2>/dev/null` in #(( + ???[sx]*):;;*)false;;esac;fi + '\'' sh + ' +fi +as_executable_p=$as_test_x + +# Sed expression to map a string onto a valid CPP name. +as_tr_cpp="eval sed 'y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g'" + +# Sed expression to map a string onto a valid variable name. +as_tr_sh="eval sed 'y%*+%pp%;s%[^_$as_cr_alnum]%_%g'" + + +test -n "$DJDIR" || exec 7<&0 &1 + +# Name of the host. +# hostname on some systems (SVR3.2, old GNU/Linux) returns a bogus exit status, +# so uname gets run too. +ac_hostname=`(hostname || uname -n) 2>/dev/null | sed 1q` + +# +# Initializations. +# +ac_default_prefix=/usr/local +ac_clean_files= +ac_config_libobj_dir=. +LIBOBJS= +cross_compiling=no +subdirs= +MFLAGS= +MAKEFLAGS= + +# Identity of this package. +PACKAGE_NAME='asciidoc' +PACKAGE_TARNAME='asciidoc' +PACKAGE_VERSION='8.6.8' +PACKAGE_STRING='asciidoc 8.6.8' +PACKAGE_BUGREPORT='' +PACKAGE_URL='' + +ac_subst_vars='LTLIBOBJS +LIBOBJS +INSTALL_DATA +INSTALL_SCRIPT +INSTALL_PROGRAM +LN_S +SED +target_alias +host_alias +build_alias +LIBS +ECHO_T +ECHO_N +ECHO_C +DEFS +mandir +localedir +libdir +psdir +pdfdir +dvidir +htmldir +infodir +docdir +oldincludedir +includedir +localstatedir +sharedstatedir +sysconfdir +datadir +datarootdir +libexecdir +sbindir +bindir +program_transform_name +prefix +exec_prefix +PACKAGE_URL +PACKAGE_BUGREPORT +PACKAGE_STRING +PACKAGE_VERSION +PACKAGE_TARNAME +PACKAGE_NAME +PATH_SEPARATOR +SHELL' +ac_subst_files='' +ac_user_opts=' +enable_option_checking +' + ac_precious_vars='build_alias +host_alias +target_alias' + + +# Initialize some variables set by options. +ac_init_help= +ac_init_version=false +ac_unrecognized_opts= +ac_unrecognized_sep= +# The variables have the same names as the options, with +# dashes changed to underlines. +cache_file=/dev/null +exec_prefix=NONE +no_create= +no_recursion= +prefix=NONE +program_prefix=NONE +program_suffix=NONE +program_transform_name=s,x,x, +silent= +site= +srcdir= +verbose= +x_includes=NONE +x_libraries=NONE + +# Installation directory options. +# These are left unexpanded so users can "make install exec_prefix=/foo" +# and all the variables that are supposed to be based on exec_prefix +# by default will actually change. +# Use braces instead of parens because sh, perl, etc. also accept them. +# (The list follows the same order as the GNU Coding Standards.) +bindir='${exec_prefix}/bin' +sbindir='${exec_prefix}/sbin' +libexecdir='${exec_prefix}/libexec' +datarootdir='${prefix}/share' +datadir='${datarootdir}' +sysconfdir='${prefix}/etc' +sharedstatedir='${prefix}/com' +localstatedir='${prefix}/var' +includedir='${prefix}/include' +oldincludedir='/usr/include' +docdir='${datarootdir}/doc/${PACKAGE_TARNAME}' +infodir='${datarootdir}/info' +htmldir='${docdir}' +dvidir='${docdir}' +pdfdir='${docdir}' +psdir='${docdir}' +libdir='${exec_prefix}/lib' +localedir='${datarootdir}/locale' +mandir='${datarootdir}/man' + +ac_prev= +ac_dashdash= +for ac_option +do + # If the previous option needs an argument, assign it. + if test -n "$ac_prev"; then + eval $ac_prev=\$ac_option + ac_prev= + continue + fi + + case $ac_option in + *=?*) ac_optarg=`expr "X$ac_option" : '[^=]*=\(.*\)'` ;; + *=) ac_optarg= ;; + *) ac_optarg=yes ;; + esac + + # Accept the important Cygnus configure options, so we can diagnose typos. + + case $ac_dashdash$ac_option in + --) + ac_dashdash=yes ;; + + -bindir | --bindir | --bindi | --bind | --bin | --bi) + ac_prev=bindir ;; + -bindir=* | --bindir=* | --bindi=* | --bind=* | --bin=* | --bi=*) + bindir=$ac_optarg ;; + + -build | --build | --buil | --bui | --bu) + ac_prev=build_alias ;; + -build=* | --build=* | --buil=* | --bui=* | --bu=*) + build_alias=$ac_optarg ;; + + -cache-file | --cache-file | --cache-fil | --cache-fi \ + | --cache-f | --cache- | --cache | --cach | --cac | --ca | --c) + ac_prev=cache_file ;; + -cache-file=* | --cache-file=* | --cache-fil=* | --cache-fi=* \ + | --cache-f=* | --cache-=* | --cache=* | --cach=* | --cac=* | --ca=* | --c=*) + cache_file=$ac_optarg ;; + + --config-cache | -C) + cache_file=config.cache ;; + + -datadir | --datadir | --datadi | --datad) + ac_prev=datadir ;; + -datadir=* | --datadir=* | --datadi=* | --datad=*) + datadir=$ac_optarg ;; + + -datarootdir | --datarootdir | --datarootdi | --datarootd | --dataroot \ + | --dataroo | --dataro | --datar) + ac_prev=datarootdir ;; + -datarootdir=* | --datarootdir=* | --datarootdi=* | --datarootd=* \ + | --dataroot=* | --dataroo=* | --dataro=* | --datar=*) + datarootdir=$ac_optarg ;; + + -disable-* | --disable-*) + ac_useropt=`expr "x$ac_option" : 'x-*disable-\(.*\)'` + # Reject names that are not valid shell variable names. + expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && + as_fn_error $? "invalid feature name: $ac_useropt" + ac_useropt_orig=$ac_useropt + ac_useropt=`$as_echo "$ac_useropt" | sed 's/[-+.]/_/g'` + case $ac_user_opts in + *" +"enable_$ac_useropt" +"*) ;; + *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--disable-$ac_useropt_orig" + ac_unrecognized_sep=', ';; + esac + eval enable_$ac_useropt=no ;; + + -docdir | --docdir | --docdi | --doc | --do) + ac_prev=docdir ;; + -docdir=* | --docdir=* | --docdi=* | --doc=* | --do=*) + docdir=$ac_optarg ;; + + -dvidir | --dvidir | --dvidi | --dvid | --dvi | --dv) + ac_prev=dvidir ;; + -dvidir=* | --dvidir=* | --dvidi=* | --dvid=* | --dvi=* | --dv=*) + dvidir=$ac_optarg ;; + + -enable-* | --enable-*) + ac_useropt=`expr "x$ac_option" : 'x-*enable-\([^=]*\)'` + # Reject names that are not valid shell variable names. + expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && + as_fn_error $? "invalid feature name: $ac_useropt" + ac_useropt_orig=$ac_useropt + ac_useropt=`$as_echo "$ac_useropt" | sed 's/[-+.]/_/g'` + case $ac_user_opts in + *" +"enable_$ac_useropt" +"*) ;; + *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--enable-$ac_useropt_orig" + ac_unrecognized_sep=', ';; + esac + eval enable_$ac_useropt=\$ac_optarg ;; + + -exec-prefix | --exec_prefix | --exec-prefix | --exec-prefi \ + | --exec-pref | --exec-pre | --exec-pr | --exec-p | --exec- \ + | --exec | --exe | --ex) + ac_prev=exec_prefix ;; + -exec-prefix=* | --exec_prefix=* | --exec-prefix=* | --exec-prefi=* \ + | --exec-pref=* | --exec-pre=* | --exec-pr=* | --exec-p=* | --exec-=* \ + | --exec=* | --exe=* | --ex=*) + exec_prefix=$ac_optarg ;; + + -gas | --gas | --ga | --g) + # Obsolete; use --with-gas. + with_gas=yes ;; + + -help | --help | --hel | --he | -h) + ac_init_help=long ;; + -help=r* | --help=r* | --hel=r* | --he=r* | -hr*) + ac_init_help=recursive ;; + -help=s* | --help=s* | --hel=s* | --he=s* | -hs*) + ac_init_help=short ;; + + -host | --host | --hos | --ho) + ac_prev=host_alias ;; + -host=* | --host=* | --hos=* | --ho=*) + host_alias=$ac_optarg ;; + + -htmldir | --htmldir | --htmldi | --htmld | --html | --htm | --ht) + ac_prev=htmldir ;; + -htmldir=* | --htmldir=* | --htmldi=* | --htmld=* | --html=* | --htm=* \ + | --ht=*) + htmldir=$ac_optarg ;; + + -includedir | --includedir | --includedi | --included | --include \ + | --includ | --inclu | --incl | --inc) + ac_prev=includedir ;; + -includedir=* | --includedir=* | --includedi=* | --included=* | --include=* \ + | --includ=* | --inclu=* | --incl=* | --inc=*) + includedir=$ac_optarg ;; + + -infodir | --infodir | --infodi | --infod | --info | --inf) + ac_prev=infodir ;; + -infodir=* | --infodir=* | --infodi=* | --infod=* | --info=* | --inf=*) + infodir=$ac_optarg ;; + + -libdir | --libdir | --libdi | --libd) + ac_prev=libdir ;; + -libdir=* | --libdir=* | --libdi=* | --libd=*) + libdir=$ac_optarg ;; + + -libexecdir | --libexecdir | --libexecdi | --libexecd | --libexec \ + | --libexe | --libex | --libe) + ac_prev=libexecdir ;; + -libexecdir=* | --libexecdir=* | --libexecdi=* | --libexecd=* | --libexec=* \ + | --libexe=* | --libex=* | --libe=*) + libexecdir=$ac_optarg ;; + + -localedir | --localedir | --localedi | --localed | --locale) + ac_prev=localedir ;; + -localedir=* | --localedir=* | --localedi=* | --localed=* | --locale=*) + localedir=$ac_optarg ;; + + -localstatedir | --localstatedir | --localstatedi | --localstated \ + | --localstate | --localstat | --localsta | --localst | --locals) + ac_prev=localstatedir ;; + -localstatedir=* | --localstatedir=* | --localstatedi=* | --localstated=* \ + | --localstate=* | --localstat=* | --localsta=* | --localst=* | --locals=*) + localstatedir=$ac_optarg ;; + + -mandir | --mandir | --mandi | --mand | --man | --ma | --m) + ac_prev=mandir ;; + -mandir=* | --mandir=* | --mandi=* | --mand=* | --man=* | --ma=* | --m=*) + mandir=$ac_optarg ;; + + -nfp | --nfp | --nf) + # Obsolete; use --without-fp. + with_fp=no ;; + + -no-create | --no-create | --no-creat | --no-crea | --no-cre \ + | --no-cr | --no-c | -n) + no_create=yes ;; + + -no-recursion | --no-recursion | --no-recursio | --no-recursi \ + | --no-recurs | --no-recur | --no-recu | --no-rec | --no-re | --no-r) + no_recursion=yes ;; + + -oldincludedir | --oldincludedir | --oldincludedi | --oldincluded \ + | --oldinclude | --oldinclud | --oldinclu | --oldincl | --oldinc \ + | --oldin | --oldi | --old | --ol | --o) + ac_prev=oldincludedir ;; + -oldincludedir=* | --oldincludedir=* | --oldincludedi=* | --oldincluded=* \ + | --oldinclude=* | --oldinclud=* | --oldinclu=* | --oldincl=* | --oldinc=* \ + | --oldin=* | --oldi=* | --old=* | --ol=* | --o=*) + oldincludedir=$ac_optarg ;; + + -prefix | --prefix | --prefi | --pref | --pre | --pr | --p) + ac_prev=prefix ;; + -prefix=* | --prefix=* | --prefi=* | --pref=* | --pre=* | --pr=* | --p=*) + prefix=$ac_optarg ;; + + -program-prefix | --program-prefix | --program-prefi | --program-pref \ + | --program-pre | --program-pr | --program-p) + ac_prev=program_prefix ;; + -program-prefix=* | --program-prefix=* | --program-prefi=* \ + | --program-pref=* | --program-pre=* | --program-pr=* | --program-p=*) + program_prefix=$ac_optarg ;; + + -program-suffix | --program-suffix | --program-suffi | --program-suff \ + | --program-suf | --program-su | --program-s) + ac_prev=program_suffix ;; + -program-suffix=* | --program-suffix=* | --program-suffi=* \ + | --program-suff=* | --program-suf=* | --program-su=* | --program-s=*) + program_suffix=$ac_optarg ;; + + -program-transform-name | --program-transform-name \ + | --program-transform-nam | --program-transform-na \ + | --program-transform-n | --program-transform- \ + | --program-transform | --program-transfor \ + | --program-transfo | --program-transf \ + | --program-trans | --program-tran \ + | --progr-tra | --program-tr | --program-t) + ac_prev=program_transform_name ;; + -program-transform-name=* | --program-transform-name=* \ + | --program-transform-nam=* | --program-transform-na=* \ + | --program-transform-n=* | --program-transform-=* \ + | --program-transform=* | --program-transfor=* \ + | --program-transfo=* | --program-transf=* \ + | --program-trans=* | --program-tran=* \ + | --progr-tra=* | --program-tr=* | --program-t=*) + program_transform_name=$ac_optarg ;; + + -pdfdir | --pdfdir | --pdfdi | --pdfd | --pdf | --pd) + ac_prev=pdfdir ;; + -pdfdir=* | --pdfdir=* | --pdfdi=* | --pdfd=* | --pdf=* | --pd=*) + pdfdir=$ac_optarg ;; + + -psdir | --psdir | --psdi | --psd | --ps) + ac_prev=psdir ;; + -psdir=* | --psdir=* | --psdi=* | --psd=* | --ps=*) + psdir=$ac_optarg ;; + + -q | -quiet | --quiet | --quie | --qui | --qu | --q \ + | -silent | --silent | --silen | --sile | --sil) + silent=yes ;; + + -sbindir | --sbindir | --sbindi | --sbind | --sbin | --sbi | --sb) + ac_prev=sbindir ;; + -sbindir=* | --sbindir=* | --sbindi=* | --sbind=* | --sbin=* \ + | --sbi=* | --sb=*) + sbindir=$ac_optarg ;; + + -sharedstatedir | --sharedstatedir | --sharedstatedi \ + | --sharedstated | --sharedstate | --sharedstat | --sharedsta \ + | --sharedst | --shareds | --shared | --share | --shar \ + | --sha | --sh) + ac_prev=sharedstatedir ;; + -sharedstatedir=* | --sharedstatedir=* | --sharedstatedi=* \ + | --sharedstated=* | --sharedstate=* | --sharedstat=* | --sharedsta=* \ + | --sharedst=* | --shareds=* | --shared=* | --share=* | --shar=* \ + | --sha=* | --sh=*) + sharedstatedir=$ac_optarg ;; + + -site | --site | --sit) + ac_prev=site ;; + -site=* | --site=* | --sit=*) + site=$ac_optarg ;; + + -srcdir | --srcdir | --srcdi | --srcd | --src | --sr) + ac_prev=srcdir ;; + -srcdir=* | --srcdir=* | --srcdi=* | --srcd=* | --src=* | --sr=*) + srcdir=$ac_optarg ;; + + -sysconfdir | --sysconfdir | --sysconfdi | --sysconfd | --sysconf \ + | --syscon | --sysco | --sysc | --sys | --sy) + ac_prev=sysconfdir ;; + -sysconfdir=* | --sysconfdir=* | --sysconfdi=* | --sysconfd=* | --sysconf=* \ + | --syscon=* | --sysco=* | --sysc=* | --sys=* | --sy=*) + sysconfdir=$ac_optarg ;; + + -target | --target | --targe | --targ | --tar | --ta | --t) + ac_prev=target_alias ;; + -target=* | --target=* | --targe=* | --targ=* | --tar=* | --ta=* | --t=*) + target_alias=$ac_optarg ;; + + -v | -verbose | --verbose | --verbos | --verbo | --verb) + verbose=yes ;; + + -version | --version | --versio | --versi | --vers | -V) + ac_init_version=: ;; + + -with-* | --with-*) + ac_useropt=`expr "x$ac_option" : 'x-*with-\([^=]*\)'` + # Reject names that are not valid shell variable names. + expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && + as_fn_error $? "invalid package name: $ac_useropt" + ac_useropt_orig=$ac_useropt + ac_useropt=`$as_echo "$ac_useropt" | sed 's/[-+.]/_/g'` + case $ac_user_opts in + *" +"with_$ac_useropt" +"*) ;; + *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--with-$ac_useropt_orig" + ac_unrecognized_sep=', ';; + esac + eval with_$ac_useropt=\$ac_optarg ;; + + -without-* | --without-*) + ac_useropt=`expr "x$ac_option" : 'x-*without-\(.*\)'` + # Reject names that are not valid shell variable names. + expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && + as_fn_error $? "invalid package name: $ac_useropt" + ac_useropt_orig=$ac_useropt + ac_useropt=`$as_echo "$ac_useropt" | sed 's/[-+.]/_/g'` + case $ac_user_opts in + *" +"with_$ac_useropt" +"*) ;; + *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--without-$ac_useropt_orig" + ac_unrecognized_sep=', ';; + esac + eval with_$ac_useropt=no ;; + + --x) + # Obsolete; use --with-x. + with_x=yes ;; + + -x-includes | --x-includes | --x-include | --x-includ | --x-inclu \ + | --x-incl | --x-inc | --x-in | --x-i) + ac_prev=x_includes ;; + -x-includes=* | --x-includes=* | --x-include=* | --x-includ=* | --x-inclu=* \ + | --x-incl=* | --x-inc=* | --x-in=* | --x-i=*) + x_includes=$ac_optarg ;; + + -x-libraries | --x-libraries | --x-librarie | --x-librari \ + | --x-librar | --x-libra | --x-libr | --x-lib | --x-li | --x-l) + ac_prev=x_libraries ;; + -x-libraries=* | --x-libraries=* | --x-librarie=* | --x-librari=* \ + | --x-librar=* | --x-libra=* | --x-libr=* | --x-lib=* | --x-li=* | --x-l=*) + x_libraries=$ac_optarg ;; + + -*) as_fn_error $? "unrecognized option: \`$ac_option' +Try \`$0 --help' for more information" + ;; + + *=*) + ac_envvar=`expr "x$ac_option" : 'x\([^=]*\)='` + # Reject names that are not valid shell variable names. + case $ac_envvar in #( + '' | [0-9]* | *[!_$as_cr_alnum]* ) + as_fn_error $? "invalid variable name: \`$ac_envvar'" ;; + esac + eval $ac_envvar=\$ac_optarg + export $ac_envvar ;; + + *) + # FIXME: should be removed in autoconf 3.0. + $as_echo "$as_me: WARNING: you should use --build, --host, --target" >&2 + expr "x$ac_option" : ".*[^-._$as_cr_alnum]" >/dev/null && + $as_echo "$as_me: WARNING: invalid host type: $ac_option" >&2 + : "${build_alias=$ac_option} ${host_alias=$ac_option} ${target_alias=$ac_option}" + ;; + + esac +done + +if test -n "$ac_prev"; then + ac_option=--`echo $ac_prev | sed 's/_/-/g'` + as_fn_error $? "missing argument to $ac_option" +fi + +if test -n "$ac_unrecognized_opts"; then + case $enable_option_checking in + no) ;; + fatal) as_fn_error $? "unrecognized options: $ac_unrecognized_opts" ;; + *) $as_echo "$as_me: WARNING: unrecognized options: $ac_unrecognized_opts" >&2 ;; + esac +fi + +# Check all directory arguments for consistency. +for ac_var in exec_prefix prefix bindir sbindir libexecdir datarootdir \ + datadir sysconfdir sharedstatedir localstatedir includedir \ + oldincludedir docdir infodir htmldir dvidir pdfdir psdir \ + libdir localedir mandir +do + eval ac_val=\$$ac_var + # Remove trailing slashes. + case $ac_val in + */ ) + ac_val=`expr "X$ac_val" : 'X\(.*[^/]\)' \| "X$ac_val" : 'X\(.*\)'` + eval $ac_var=\$ac_val;; + esac + # Be sure to have absolute directory names. + case $ac_val in + [\\/$]* | ?:[\\/]* ) continue;; + NONE | '' ) case $ac_var in *prefix ) continue;; esac;; + esac + as_fn_error $? "expected an absolute directory name for --$ac_var: $ac_val" +done + +# There might be people who depend on the old broken behavior: `$host' +# used to hold the argument of --host etc. +# FIXME: To remove some day. +build=$build_alias +host=$host_alias +target=$target_alias + +# FIXME: To remove some day. +if test "x$host_alias" != x; then + if test "x$build_alias" = x; then + cross_compiling=maybe + $as_echo "$as_me: WARNING: if you wanted to set the --build type, don't use --host. + If a cross compiler is detected then cross compile mode will be used" >&2 + elif test "x$build_alias" != "x$host_alias"; then + cross_compiling=yes + fi +fi + +ac_tool_prefix= +test -n "$host_alias" && ac_tool_prefix=$host_alias- + +test "$silent" = yes && exec 6>/dev/null + + +ac_pwd=`pwd` && test -n "$ac_pwd" && +ac_ls_di=`ls -di .` && +ac_pwd_ls_di=`cd "$ac_pwd" && ls -di .` || + as_fn_error $? "working directory cannot be determined" +test "X$ac_ls_di" = "X$ac_pwd_ls_di" || + as_fn_error $? "pwd does not report name of working directory" + + +# Find the source files, if location was not specified. +if test -z "$srcdir"; then + ac_srcdir_defaulted=yes + # Try the directory containing this script, then the parent directory. + ac_confdir=`$as_dirname -- "$as_myself" || +$as_expr X"$as_myself" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ + X"$as_myself" : 'X\(//\)[^/]' \| \ + X"$as_myself" : 'X\(//\)$' \| \ + X"$as_myself" : 'X\(/\)' \| . 2>/dev/null || +$as_echo X"$as_myself" | + sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ + s//\1/ + q + } + /^X\(\/\/\)[^/].*/{ + s//\1/ + q + } + /^X\(\/\/\)$/{ + s//\1/ + q + } + /^X\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + srcdir=$ac_confdir + if test ! -r "$srcdir/$ac_unique_file"; then + srcdir=.. + fi +else + ac_srcdir_defaulted=no +fi +if test ! -r "$srcdir/$ac_unique_file"; then + test "$ac_srcdir_defaulted" = yes && srcdir="$ac_confdir or .." + as_fn_error $? "cannot find sources ($ac_unique_file) in $srcdir" +fi +ac_msg="sources are in $srcdir, but \`cd $srcdir' does not work" +ac_abs_confdir=`( + cd "$srcdir" && test -r "./$ac_unique_file" || as_fn_error $? "$ac_msg" + pwd)` +# When building in place, set srcdir=. +if test "$ac_abs_confdir" = "$ac_pwd"; then + srcdir=. +fi +# Remove unnecessary trailing slashes from srcdir. +# Double slashes in file names in object file debugging info +# mess up M-x gdb in Emacs. +case $srcdir in +*/) srcdir=`expr "X$srcdir" : 'X\(.*[^/]\)' \| "X$srcdir" : 'X\(.*\)'`;; +esac +for ac_var in $ac_precious_vars; do + eval ac_env_${ac_var}_set=\${${ac_var}+set} + eval ac_env_${ac_var}_value=\$${ac_var} + eval ac_cv_env_${ac_var}_set=\${${ac_var}+set} + eval ac_cv_env_${ac_var}_value=\$${ac_var} +done + +# +# Report the --help message. +# +if test "$ac_init_help" = "long"; then + # Omit some internal or obsolete options to make the list less imposing. + # This message is too long to be a string in the A/UX 3.1 sh. + cat <<_ACEOF +\`configure' configures asciidoc 8.6.8 to adapt to many kinds of systems. + +Usage: $0 [OPTION]... [VAR=VALUE]... + +To assign environment variables (e.g., CC, CFLAGS...), specify them as +VAR=VALUE. See below for descriptions of some of the useful variables. + +Defaults for the options are specified in brackets. + +Configuration: + -h, --help display this help and exit + --help=short display options specific to this package + --help=recursive display the short help of all the included packages + -V, --version display version information and exit + -q, --quiet, --silent do not print \`checking ...' messages + --cache-file=FILE cache test results in FILE [disabled] + -C, --config-cache alias for \`--cache-file=config.cache' + -n, --no-create do not create output files + --srcdir=DIR find the sources in DIR [configure dir or \`..'] + +Installation directories: + --prefix=PREFIX install architecture-independent files in PREFIX + [$ac_default_prefix] + --exec-prefix=EPREFIX install architecture-dependent files in EPREFIX + [PREFIX] + +By default, \`make install' will install all the files in +\`$ac_default_prefix/bin', \`$ac_default_prefix/lib' etc. You can specify +an installation prefix other than \`$ac_default_prefix' using \`--prefix', +for instance \`--prefix=\$HOME'. + +For better control, use the options below. + +Fine tuning of the installation directories: + --bindir=DIR user executables [EPREFIX/bin] + --sbindir=DIR system admin executables [EPREFIX/sbin] + --libexecdir=DIR program executables [EPREFIX/libexec] + --sysconfdir=DIR read-only single-machine data [PREFIX/etc] + --sharedstatedir=DIR modifiable architecture-independent data [PREFIX/com] + --localstatedir=DIR modifiable single-machine data [PREFIX/var] + --libdir=DIR object code libraries [EPREFIX/lib] + --includedir=DIR C header files [PREFIX/include] + --oldincludedir=DIR C header files for non-gcc [/usr/include] + --datarootdir=DIR read-only arch.-independent data root [PREFIX/share] + --datadir=DIR read-only architecture-independent data [DATAROOTDIR] + --infodir=DIR info documentation [DATAROOTDIR/info] + --localedir=DIR locale-dependent data [DATAROOTDIR/locale] + --mandir=DIR man documentation [DATAROOTDIR/man] + --docdir=DIR documentation root [DATAROOTDIR/doc/asciidoc] + --htmldir=DIR html documentation [DOCDIR] + --dvidir=DIR dvi documentation [DOCDIR] + --pdfdir=DIR pdf documentation [DOCDIR] + --psdir=DIR ps documentation [DOCDIR] +_ACEOF + + cat <<\_ACEOF +_ACEOF +fi + +if test -n "$ac_init_help"; then + case $ac_init_help in + short | recursive ) echo "Configuration of asciidoc 8.6.8:";; + esac + cat <<\_ACEOF + +Report bugs to the package provider. +_ACEOF +ac_status=$? +fi + +if test "$ac_init_help" = "recursive"; then + # If there are subdirs, report their specific --help. + for ac_dir in : $ac_subdirs_all; do test "x$ac_dir" = x: && continue + test -d "$ac_dir" || + { cd "$srcdir" && ac_pwd=`pwd` && srcdir=. && test -d "$ac_dir"; } || + continue + ac_builddir=. + +case "$ac_dir" in +.) ac_dir_suffix= ac_top_builddir_sub=. ac_top_build_prefix= ;; +*) + ac_dir_suffix=/`$as_echo "$ac_dir" | sed 's|^\.[\\/]||'` + # A ".." for each directory in $ac_dir_suffix. + ac_top_builddir_sub=`$as_echo "$ac_dir_suffix" | sed 's|/[^\\/]*|/..|g;s|/||'` + case $ac_top_builddir_sub in + "") ac_top_builddir_sub=. ac_top_build_prefix= ;; + *) ac_top_build_prefix=$ac_top_builddir_sub/ ;; + esac ;; +esac +ac_abs_top_builddir=$ac_pwd +ac_abs_builddir=$ac_pwd$ac_dir_suffix +# for backward compatibility: +ac_top_builddir=$ac_top_build_prefix + +case $srcdir in + .) # We are building in place. + ac_srcdir=. + ac_top_srcdir=$ac_top_builddir_sub + ac_abs_top_srcdir=$ac_pwd ;; + [\\/]* | ?:[\\/]* ) # Absolute name. + ac_srcdir=$srcdir$ac_dir_suffix; + ac_top_srcdir=$srcdir + ac_abs_top_srcdir=$srcdir ;; + *) # Relative name. + ac_srcdir=$ac_top_build_prefix$srcdir$ac_dir_suffix + ac_top_srcdir=$ac_top_build_prefix$srcdir + ac_abs_top_srcdir=$ac_pwd/$srcdir ;; +esac +ac_abs_srcdir=$ac_abs_top_srcdir$ac_dir_suffix + + cd "$ac_dir" || { ac_status=$?; continue; } + # Check for guested configure. + if test -f "$ac_srcdir/configure.gnu"; then + echo && + $SHELL "$ac_srcdir/configure.gnu" --help=recursive + elif test -f "$ac_srcdir/configure"; then + echo && + $SHELL "$ac_srcdir/configure" --help=recursive + else + $as_echo "$as_me: WARNING: no configuration information is in $ac_dir" >&2 + fi || ac_status=$? + cd "$ac_pwd" || { ac_status=$?; break; } + done +fi + +test -n "$ac_init_help" && exit $ac_status +if $ac_init_version; then + cat <<\_ACEOF +asciidoc configure 8.6.8 +generated by GNU Autoconf 2.68 + +Copyright (C) 2010 Free Software Foundation, Inc. +This configure script is free software; the Free Software Foundation +gives unlimited permission to copy, distribute and modify it. +_ACEOF + exit +fi + +## ------------------------ ## +## Autoconf initialization. ## +## ------------------------ ## +cat >config.log <<_ACEOF +This file contains any messages produced by compilers while +running configure, to aid debugging if configure makes a mistake. + +It was created by asciidoc $as_me 8.6.8, which was +generated by GNU Autoconf 2.68. Invocation command line was + + $ $0 $@ + +_ACEOF +exec 5>>config.log +{ +cat <<_ASUNAME +## --------- ## +## Platform. ## +## --------- ## + +hostname = `(hostname || uname -n) 2>/dev/null | sed 1q` +uname -m = `(uname -m) 2>/dev/null || echo unknown` +uname -r = `(uname -r) 2>/dev/null || echo unknown` +uname -s = `(uname -s) 2>/dev/null || echo unknown` +uname -v = `(uname -v) 2>/dev/null || echo unknown` + +/usr/bin/uname -p = `(/usr/bin/uname -p) 2>/dev/null || echo unknown` +/bin/uname -X = `(/bin/uname -X) 2>/dev/null || echo unknown` + +/bin/arch = `(/bin/arch) 2>/dev/null || echo unknown` +/usr/bin/arch -k = `(/usr/bin/arch -k) 2>/dev/null || echo unknown` +/usr/convex/getsysinfo = `(/usr/convex/getsysinfo) 2>/dev/null || echo unknown` +/usr/bin/hostinfo = `(/usr/bin/hostinfo) 2>/dev/null || echo unknown` +/bin/machine = `(/bin/machine) 2>/dev/null || echo unknown` +/usr/bin/oslevel = `(/usr/bin/oslevel) 2>/dev/null || echo unknown` +/bin/universe = `(/bin/universe) 2>/dev/null || echo unknown` + +_ASUNAME + +as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + $as_echo "PATH: $as_dir" + done +IFS=$as_save_IFS + +} >&5 + +cat >&5 <<_ACEOF + + +## ----------- ## +## Core tests. ## +## ----------- ## + +_ACEOF + + +# Keep a trace of the command line. +# Strip out --no-create and --no-recursion so they do not pile up. +# Strip out --silent because we don't want to record it for future runs. +# Also quote any args containing shell meta-characters. +# Make two passes to allow for proper duplicate-argument suppression. +ac_configure_args= +ac_configure_args0= +ac_configure_args1= +ac_must_keep_next=false +for ac_pass in 1 2 +do + for ac_arg + do + case $ac_arg in + -no-create | --no-c* | -n | -no-recursion | --no-r*) continue ;; + -q | -quiet | --quiet | --quie | --qui | --qu | --q \ + | -silent | --silent | --silen | --sile | --sil) + continue ;; + *\'*) + ac_arg=`$as_echo "$ac_arg" | sed "s/'/'\\\\\\\\''/g"` ;; + esac + case $ac_pass in + 1) as_fn_append ac_configure_args0 " '$ac_arg'" ;; + 2) + as_fn_append ac_configure_args1 " '$ac_arg'" + if test $ac_must_keep_next = true; then + ac_must_keep_next=false # Got value, back to normal. + else + case $ac_arg in + *=* | --config-cache | -C | -disable-* | --disable-* \ + | -enable-* | --enable-* | -gas | --g* | -nfp | --nf* \ + | -q | -quiet | --q* | -silent | --sil* | -v | -verb* \ + | -with-* | --with-* | -without-* | --without-* | --x) + case "$ac_configure_args0 " in + "$ac_configure_args1"*" '$ac_arg' "* ) continue ;; + esac + ;; + -* ) ac_must_keep_next=true ;; + esac + fi + as_fn_append ac_configure_args " '$ac_arg'" + ;; + esac + done +done +{ ac_configure_args0=; unset ac_configure_args0;} +{ ac_configure_args1=; unset ac_configure_args1;} + +# When interrupted or exit'd, cleanup temporary files, and complete +# config.log. We remove comments because anyway the quotes in there +# would cause problems or look ugly. +# WARNING: Use '\'' to represent an apostrophe within the trap. +# WARNING: Do not start the trap code with a newline, due to a FreeBSD 4.0 bug. +trap 'exit_status=$? + # Save into config.log some information that might help in debugging. + { + echo + + $as_echo "## ---------------- ## +## Cache variables. ## +## ---------------- ##" + echo + # The following way of writing the cache mishandles newlines in values, +( + for ac_var in `(set) 2>&1 | sed -n '\''s/^\([a-zA-Z_][a-zA-Z0-9_]*\)=.*/\1/p'\''`; do + eval ac_val=\$$ac_var + case $ac_val in #( + *${as_nl}*) + case $ac_var in #( + *_cv_*) { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: cache variable $ac_var contains a newline" >&5 +$as_echo "$as_me: WARNING: cache variable $ac_var contains a newline" >&2;} ;; + esac + case $ac_var in #( + _ | IFS | as_nl) ;; #( + BASH_ARGV | BASH_SOURCE) eval $ac_var= ;; #( + *) { eval $ac_var=; unset $ac_var;} ;; + esac ;; + esac + done + (set) 2>&1 | + case $as_nl`(ac_space='\'' '\''; set) 2>&1` in #( + *${as_nl}ac_space=\ *) + sed -n \ + "s/'\''/'\''\\\\'\'''\''/g; + s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='\''\\2'\''/p" + ;; #( + *) + sed -n "/^[_$as_cr_alnum]*_cv_[_$as_cr_alnum]*=/p" + ;; + esac | + sort +) + echo + + $as_echo "## ----------------- ## +## Output variables. ## +## ----------------- ##" + echo + for ac_var in $ac_subst_vars + do + eval ac_val=\$$ac_var + case $ac_val in + *\'\''*) ac_val=`$as_echo "$ac_val" | sed "s/'\''/'\''\\\\\\\\'\'''\''/g"`;; + esac + $as_echo "$ac_var='\''$ac_val'\''" + done | sort + echo + + if test -n "$ac_subst_files"; then + $as_echo "## ------------------- ## +## File substitutions. ## +## ------------------- ##" + echo + for ac_var in $ac_subst_files + do + eval ac_val=\$$ac_var + case $ac_val in + *\'\''*) ac_val=`$as_echo "$ac_val" | sed "s/'\''/'\''\\\\\\\\'\'''\''/g"`;; + esac + $as_echo "$ac_var='\''$ac_val'\''" + done | sort + echo + fi + + if test -s confdefs.h; then + $as_echo "## ----------- ## +## confdefs.h. ## +## ----------- ##" + echo + cat confdefs.h + echo + fi + test "$ac_signal" != 0 && + $as_echo "$as_me: caught signal $ac_signal" + $as_echo "$as_me: exit $exit_status" + } >&5 + rm -f core *.core core.conftest.* && + rm -f -r conftest* confdefs* conf$$* $ac_clean_files && + exit $exit_status +' 0 +for ac_signal in 1 2 13 15; do + trap 'ac_signal='$ac_signal'; as_fn_exit 1' $ac_signal +done +ac_signal=0 + +# confdefs.h avoids OS command line length limits that DEFS can exceed. +rm -f -r conftest* confdefs.h + +$as_echo "/* confdefs.h */" > confdefs.h + +# Predefined preprocessor variables. + +cat >>confdefs.h <<_ACEOF +#define PACKAGE_NAME "$PACKAGE_NAME" +_ACEOF + +cat >>confdefs.h <<_ACEOF +#define PACKAGE_TARNAME "$PACKAGE_TARNAME" +_ACEOF + +cat >>confdefs.h <<_ACEOF +#define PACKAGE_VERSION "$PACKAGE_VERSION" +_ACEOF + +cat >>confdefs.h <<_ACEOF +#define PACKAGE_STRING "$PACKAGE_STRING" +_ACEOF + +cat >>confdefs.h <<_ACEOF +#define PACKAGE_BUGREPORT "$PACKAGE_BUGREPORT" +_ACEOF + +cat >>confdefs.h <<_ACEOF +#define PACKAGE_URL "$PACKAGE_URL" +_ACEOF + + +# Let the site file select an alternate cache file if it wants to. +# Prefer an explicitly selected file to automatically selected ones. +ac_site_file1=NONE +ac_site_file2=NONE +if test -n "$CONFIG_SITE"; then + # We do not want a PATH search for config.site. + case $CONFIG_SITE in #(( + -*) ac_site_file1=./$CONFIG_SITE;; + */*) ac_site_file1=$CONFIG_SITE;; + *) ac_site_file1=./$CONFIG_SITE;; + esac +elif test "x$prefix" != xNONE; then + ac_site_file1=$prefix/share/config.site + ac_site_file2=$prefix/etc/config.site +else + ac_site_file1=$ac_default_prefix/share/config.site + ac_site_file2=$ac_default_prefix/etc/config.site +fi +for ac_site_file in "$ac_site_file1" "$ac_site_file2" +do + test "x$ac_site_file" = xNONE && continue + if test /dev/null != "$ac_site_file" && test -r "$ac_site_file"; then + { $as_echo "$as_me:${as_lineno-$LINENO}: loading site script $ac_site_file" >&5 +$as_echo "$as_me: loading site script $ac_site_file" >&6;} + sed 's/^/| /' "$ac_site_file" >&5 + . "$ac_site_file" \ + || { { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 +$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} +as_fn_error $? "failed to load site script $ac_site_file +See \`config.log' for more details" "$LINENO" 5; } + fi +done + +if test -r "$cache_file"; then + # Some versions of bash will fail to source /dev/null (special files + # actually), so we avoid doing that. DJGPP emulates it as a regular file. + if test /dev/null != "$cache_file" && test -f "$cache_file"; then + { $as_echo "$as_me:${as_lineno-$LINENO}: loading cache $cache_file" >&5 +$as_echo "$as_me: loading cache $cache_file" >&6;} + case $cache_file in + [\\/]* | ?:[\\/]* ) . "$cache_file";; + *) . "./$cache_file";; + esac + fi +else + { $as_echo "$as_me:${as_lineno-$LINENO}: creating cache $cache_file" >&5 +$as_echo "$as_me: creating cache $cache_file" >&6;} + >$cache_file +fi + +# Check that the precious variables saved in the cache have kept the same +# value. +ac_cache_corrupted=false +for ac_var in $ac_precious_vars; do + eval ac_old_set=\$ac_cv_env_${ac_var}_set + eval ac_new_set=\$ac_env_${ac_var}_set + eval ac_old_val=\$ac_cv_env_${ac_var}_value + eval ac_new_val=\$ac_env_${ac_var}_value + case $ac_old_set,$ac_new_set in + set,) + { $as_echo "$as_me:${as_lineno-$LINENO}: error: \`$ac_var' was set to \`$ac_old_val' in the previous run" >&5 +$as_echo "$as_me: error: \`$ac_var' was set to \`$ac_old_val' in the previous run" >&2;} + ac_cache_corrupted=: ;; + ,set) + { $as_echo "$as_me:${as_lineno-$LINENO}: error: \`$ac_var' was not set in the previous run" >&5 +$as_echo "$as_me: error: \`$ac_var' was not set in the previous run" >&2;} + ac_cache_corrupted=: ;; + ,);; + *) + if test "x$ac_old_val" != "x$ac_new_val"; then + # differences in whitespace do not lead to failure. + ac_old_val_w=`echo x $ac_old_val` + ac_new_val_w=`echo x $ac_new_val` + if test "$ac_old_val_w" != "$ac_new_val_w"; then + { $as_echo "$as_me:${as_lineno-$LINENO}: error: \`$ac_var' has changed since the previous run:" >&5 +$as_echo "$as_me: error: \`$ac_var' has changed since the previous run:" >&2;} + ac_cache_corrupted=: + else + { $as_echo "$as_me:${as_lineno-$LINENO}: warning: ignoring whitespace changes in \`$ac_var' since the previous run:" >&5 +$as_echo "$as_me: warning: ignoring whitespace changes in \`$ac_var' since the previous run:" >&2;} + eval $ac_var=\$ac_old_val + fi + { $as_echo "$as_me:${as_lineno-$LINENO}: former value: \`$ac_old_val'" >&5 +$as_echo "$as_me: former value: \`$ac_old_val'" >&2;} + { $as_echo "$as_me:${as_lineno-$LINENO}: current value: \`$ac_new_val'" >&5 +$as_echo "$as_me: current value: \`$ac_new_val'" >&2;} + fi;; + esac + # Pass precious variables to config.status. + if test "$ac_new_set" = set; then + case $ac_new_val in + *\'*) ac_arg=$ac_var=`$as_echo "$ac_new_val" | sed "s/'/'\\\\\\\\''/g"` ;; + *) ac_arg=$ac_var=$ac_new_val ;; + esac + case " $ac_configure_args " in + *" '$ac_arg' "*) ;; # Avoid dups. Use of quotes ensures accuracy. + *) as_fn_append ac_configure_args " '$ac_arg'" ;; + esac + fi +done +if $ac_cache_corrupted; then + { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 +$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} + { $as_echo "$as_me:${as_lineno-$LINENO}: error: changes in the environment can compromise the build" >&5 +$as_echo "$as_me: error: changes in the environment can compromise the build" >&2;} + as_fn_error $? "run \`make distclean' and/or \`rm $cache_file' and start over" "$LINENO" 5 +fi +## -------------------- ## +## Main body of script. ## +## -------------------- ## + +ac_ext=c +ac_cpp='$CPP $CPPFLAGS' +ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' +ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' +ac_compiler_gnu=$ac_cv_c_compiler_gnu + + + +ac_config_files="$ac_config_files Makefile" + + +{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for a sed that does not truncate output" >&5 +$as_echo_n "checking for a sed that does not truncate output... " >&6; } +if ${ac_cv_path_SED+:} false; then : + $as_echo_n "(cached) " >&6 +else + ac_script=s/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/ + for ac_i in 1 2 3 4 5 6 7; do + ac_script="$ac_script$as_nl$ac_script" + done + echo "$ac_script" 2>/dev/null | sed 99q >conftest.sed + { ac_script=; unset ac_script;} + if test -z "$SED"; then + ac_path_SED_found=false + # Loop through the user's path and test for each of PROGNAME-LIST + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + for ac_prog in sed gsed; do + for ac_exec_ext in '' $ac_executable_extensions; do + ac_path_SED="$as_dir/$ac_prog$ac_exec_ext" + { test -f "$ac_path_SED" && $as_test_x "$ac_path_SED"; } || continue +# Check for GNU ac_path_SED and select it if it is found. + # Check for GNU $ac_path_SED +case `"$ac_path_SED" --version 2>&1` in +*GNU*) + ac_cv_path_SED="$ac_path_SED" ac_path_SED_found=:;; +*) + ac_count=0 + $as_echo_n 0123456789 >"conftest.in" + while : + do + cat "conftest.in" "conftest.in" >"conftest.tmp" + mv "conftest.tmp" "conftest.in" + cp "conftest.in" "conftest.nl" + $as_echo '' >> "conftest.nl" + "$ac_path_SED" -f conftest.sed < "conftest.nl" >"conftest.out" 2>/dev/null || break + diff "conftest.out" "conftest.nl" >/dev/null 2>&1 || break + as_fn_arith $ac_count + 1 && ac_count=$as_val + if test $ac_count -gt ${ac_path_SED_max-0}; then + # Best one so far, save it but keep looking for a better one + ac_cv_path_SED="$ac_path_SED" + ac_path_SED_max=$ac_count + fi + # 10*(2^10) chars as input seems more than enough + test $ac_count -gt 10 && break + done + rm -f conftest.in conftest.tmp conftest.nl conftest.out;; +esac + + $ac_path_SED_found && break 3 + done + done + done +IFS=$as_save_IFS + if test -z "$ac_cv_path_SED"; then + as_fn_error $? "no acceptable sed could be found in \$PATH" "$LINENO" 5 + fi +else + ac_cv_path_SED=$SED +fi + +fi +{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_path_SED" >&5 +$as_echo "$ac_cv_path_SED" >&6; } + SED="$ac_cv_path_SED" + rm -f conftest.sed + + +{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether ln -s works" >&5 +$as_echo_n "checking whether ln -s works... " >&6; } +LN_S=$as_ln_s +if test "$LN_S" = "ln -s"; then + { $as_echo "$as_me:${as_lineno-$LINENO}: result: yes" >&5 +$as_echo "yes" >&6; } +else + { $as_echo "$as_me:${as_lineno-$LINENO}: result: no, using $LN_S" >&5 +$as_echo "no, using $LN_S" >&6; } +fi + + +ac_aux_dir= +for ac_dir in "$srcdir" "$srcdir/.." "$srcdir/../.."; do + if test -f "$ac_dir/install-sh"; then + ac_aux_dir=$ac_dir + ac_install_sh="$ac_aux_dir/install-sh -c" + break + elif test -f "$ac_dir/install.sh"; then + ac_aux_dir=$ac_dir + ac_install_sh="$ac_aux_dir/install.sh -c" + break + elif test -f "$ac_dir/shtool"; then + ac_aux_dir=$ac_dir + ac_install_sh="$ac_aux_dir/shtool install -c" + break + fi +done +if test -z "$ac_aux_dir"; then + as_fn_error $? "cannot find install-sh, install.sh, or shtool in \"$srcdir\" \"$srcdir/..\" \"$srcdir/../..\"" "$LINENO" 5 +fi + +# These three variables are undocumented and unsupported, +# and are intended to be withdrawn in a future Autoconf release. +# They can cause serious problems if a builder's source tree is in a directory +# whose full name contains unusual characters. +ac_config_guess="$SHELL $ac_aux_dir/config.guess" # Please don't use this var. +ac_config_sub="$SHELL $ac_aux_dir/config.sub" # Please don't use this var. +ac_configure="$SHELL $ac_aux_dir/configure" # Please don't use this var. + + +# Find a good install program. We prefer a C program (faster), +# so one script is as good as another. But avoid the broken or +# incompatible versions: +# SysV /etc/install, /usr/sbin/install +# SunOS /usr/etc/install +# IRIX /sbin/install +# AIX /bin/install +# AmigaOS /C/install, which installs bootblocks on floppy discs +# AIX 4 /usr/bin/installbsd, which doesn't work without a -g flag +# AFS /usr/afsws/bin/install, which mishandles nonexistent args +# SVR4 /usr/ucb/install, which tries to use the nonexistent group "staff" +# OS/2's system install, which has a completely different semantic +# ./install, which can be erroneously created by make from ./install.sh. +# Reject install programs that cannot install multiple files. +{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for a BSD-compatible install" >&5 +$as_echo_n "checking for a BSD-compatible install... " >&6; } +if test -z "$INSTALL"; then +if ${ac_cv_path_install+:} false; then : + $as_echo_n "(cached) " >&6 +else + as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + # Account for people who put trailing slashes in PATH elements. +case $as_dir/ in #(( + ./ | .// | /[cC]/* | \ + /etc/* | /usr/sbin/* | /usr/etc/* | /sbin/* | /usr/afsws/bin/* | \ + ?:[\\/]os2[\\/]install[\\/]* | ?:[\\/]OS2[\\/]INSTALL[\\/]* | \ + /usr/ucb/* ) ;; + *) + # OSF1 and SCO ODT 3.0 have their own names for install. + # Don't use installbsd from OSF since it installs stuff as root + # by default. + for ac_prog in ginstall scoinst install; do + for ac_exec_ext in '' $ac_executable_extensions; do + if { test -f "$as_dir/$ac_prog$ac_exec_ext" && $as_test_x "$as_dir/$ac_prog$ac_exec_ext"; }; then + if test $ac_prog = install && + grep dspmsg "$as_dir/$ac_prog$ac_exec_ext" >/dev/null 2>&1; then + # AIX install. It has an incompatible calling convention. + : + elif test $ac_prog = install && + grep pwplus "$as_dir/$ac_prog$ac_exec_ext" >/dev/null 2>&1; then + # program-specific install script used by HP pwplus--don't use. + : + else + rm -rf conftest.one conftest.two conftest.dir + echo one > conftest.one + echo two > conftest.two + mkdir conftest.dir + if "$as_dir/$ac_prog$ac_exec_ext" -c conftest.one conftest.two "`pwd`/conftest.dir" && + test -s conftest.one && test -s conftest.two && + test -s conftest.dir/conftest.one && + test -s conftest.dir/conftest.two + then + ac_cv_path_install="$as_dir/$ac_prog$ac_exec_ext -c" + break 3 + fi + fi + fi + done + done + ;; +esac + + done +IFS=$as_save_IFS + +rm -rf conftest.one conftest.two conftest.dir + +fi + if test "${ac_cv_path_install+set}" = set; then + INSTALL=$ac_cv_path_install + else + # As a last resort, use the slow shell script. Don't cache a + # value for INSTALL within a source directory, because that will + # break other packages using the cache if that directory is + # removed, or if the value is a relative name. + INSTALL=$ac_install_sh + fi +fi +{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $INSTALL" >&5 +$as_echo "$INSTALL" >&6; } + +# Use test -z because SunOS4 sh mishandles braces in ${var-val}. +# It thinks the first close brace ends the variable substitution. +test -z "$INSTALL_PROGRAM" && INSTALL_PROGRAM='${INSTALL}' + +test -z "$INSTALL_SCRIPT" && INSTALL_SCRIPT='${INSTALL}' + +test -z "$INSTALL_DATA" && INSTALL_DATA='${INSTALL} -m 644' + + +cat >confcache <<\_ACEOF +# This file is a shell script that caches the results of configure +# tests run on this system so they can be shared between configure +# scripts and configure runs, see configure's option --config-cache. +# It is not useful on other systems. If it contains results you don't +# want to keep, you may remove or edit it. +# +# config.status only pays attention to the cache file if you give it +# the --recheck option to rerun configure. +# +# `ac_cv_env_foo' variables (set or unset) will be overridden when +# loading this file, other *unset* `ac_cv_foo' will be assigned the +# following values. + +_ACEOF + +# The following way of writing the cache mishandles newlines in values, +# but we know of no workaround that is simple, portable, and efficient. +# So, we kill variables containing newlines. +# Ultrix sh set writes to stderr and can't be redirected directly, +# and sets the high bit in the cache file unless we assign to the vars. +( + for ac_var in `(set) 2>&1 | sed -n 's/^\([a-zA-Z_][a-zA-Z0-9_]*\)=.*/\1/p'`; do + eval ac_val=\$$ac_var + case $ac_val in #( + *${as_nl}*) + case $ac_var in #( + *_cv_*) { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: cache variable $ac_var contains a newline" >&5 +$as_echo "$as_me: WARNING: cache variable $ac_var contains a newline" >&2;} ;; + esac + case $ac_var in #( + _ | IFS | as_nl) ;; #( + BASH_ARGV | BASH_SOURCE) eval $ac_var= ;; #( + *) { eval $ac_var=; unset $ac_var;} ;; + esac ;; + esac + done + + (set) 2>&1 | + case $as_nl`(ac_space=' '; set) 2>&1` in #( + *${as_nl}ac_space=\ *) + # `set' does not quote correctly, so add quotes: double-quote + # substitution turns \\\\ into \\, and sed turns \\ into \. + sed -n \ + "s/'/'\\\\''/g; + s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='\\2'/p" + ;; #( + *) + # `set' quotes correctly as required by POSIX, so do not add quotes. + sed -n "/^[_$as_cr_alnum]*_cv_[_$as_cr_alnum]*=/p" + ;; + esac | + sort +) | + sed ' + /^ac_cv_env_/b end + t clear + :clear + s/^\([^=]*\)=\(.*[{}].*\)$/test "${\1+set}" = set || &/ + t end + s/^\([^=]*\)=\(.*\)$/\1=${\1=\2}/ + :end' >>confcache +if diff "$cache_file" confcache >/dev/null 2>&1; then :; else + if test -w "$cache_file"; then + if test "x$cache_file" != "x/dev/null"; then + { $as_echo "$as_me:${as_lineno-$LINENO}: updating cache $cache_file" >&5 +$as_echo "$as_me: updating cache $cache_file" >&6;} + if test ! -f "$cache_file" || test -h "$cache_file"; then + cat confcache >"$cache_file" + else + case $cache_file in #( + */* | ?:*) + mv -f confcache "$cache_file"$$ && + mv -f "$cache_file"$$ "$cache_file" ;; #( + *) + mv -f confcache "$cache_file" ;; + esac + fi + fi + else + { $as_echo "$as_me:${as_lineno-$LINENO}: not updating unwritable cache $cache_file" >&5 +$as_echo "$as_me: not updating unwritable cache $cache_file" >&6;} + fi +fi +rm -f confcache + +test "x$prefix" = xNONE && prefix=$ac_default_prefix +# Let make expand exec_prefix. +test "x$exec_prefix" = xNONE && exec_prefix='${prefix}' + +# Transform confdefs.h into DEFS. +# Protect against shell expansion while executing Makefile rules. +# Protect against Makefile macro expansion. +# +# If the first sed substitution is executed (which looks for macros that +# take arguments), then branch to the quote section. Otherwise, +# look for a macro that doesn't take arguments. +ac_script=' +:mline +/\\$/{ + N + s,\\\n,, + b mline +} +t clear +:clear +s/^[ ]*#[ ]*define[ ][ ]*\([^ (][^ (]*([^)]*)\)[ ]*\(.*\)/-D\1=\2/g +t quote +s/^[ ]*#[ ]*define[ ][ ]*\([^ ][^ ]*\)[ ]*\(.*\)/-D\1=\2/g +t quote +b any +:quote +s/[ `~#$^&*(){}\\|;'\''"<>?]/\\&/g +s/\[/\\&/g +s/\]/\\&/g +s/\$/$$/g +H +:any +${ + g + s/^\n// + s/\n/ /g + p +} +' +DEFS=`sed -n "$ac_script" confdefs.h` + + +ac_libobjs= +ac_ltlibobjs= +U= +for ac_i in : $LIBOBJS; do test "x$ac_i" = x: && continue + # 1. Remove the extension, and $U if already installed. + ac_script='s/\$U\././;s/\.o$//;s/\.obj$//' + ac_i=`$as_echo "$ac_i" | sed "$ac_script"` + # 2. Prepend LIBOBJDIR. When used with automake>=1.10 LIBOBJDIR + # will be set to the directory where LIBOBJS objects are built. + as_fn_append ac_libobjs " \${LIBOBJDIR}$ac_i\$U.$ac_objext" + as_fn_append ac_ltlibobjs " \${LIBOBJDIR}$ac_i"'$U.lo' +done +LIBOBJS=$ac_libobjs + +LTLIBOBJS=$ac_ltlibobjs + + + +: "${CONFIG_STATUS=./config.status}" +ac_write_fail=0 +ac_clean_files_save=$ac_clean_files +ac_clean_files="$ac_clean_files $CONFIG_STATUS" +{ $as_echo "$as_me:${as_lineno-$LINENO}: creating $CONFIG_STATUS" >&5 +$as_echo "$as_me: creating $CONFIG_STATUS" >&6;} +as_write_fail=0 +cat >$CONFIG_STATUS <<_ASEOF || as_write_fail=1 +#! $SHELL +# Generated by $as_me. +# Run this file to recreate the current configuration. +# Compiler output produced by configure, useful for debugging +# configure, is in config.log if it exists. + +debug=false +ac_cs_recheck=false +ac_cs_silent=false + +SHELL=\${CONFIG_SHELL-$SHELL} +export SHELL +_ASEOF +cat >>$CONFIG_STATUS <<\_ASEOF || as_write_fail=1 +## -------------------- ## +## M4sh Initialization. ## +## -------------------- ## + +# Be more Bourne compatible +DUALCASE=1; export DUALCASE # for MKS sh +if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then : + emulate sh + NULLCMD=: + # Pre-4.2 versions of Zsh do word splitting on ${1+"$@"}, which + # is contrary to our usage. Disable this feature. + alias -g '${1+"$@"}'='"$@"' + setopt NO_GLOB_SUBST +else + case `(set -o) 2>/dev/null` in #( + *posix*) : + set -o posix ;; #( + *) : + ;; +esac +fi + + +as_nl=' +' +export as_nl +# Printing a long string crashes Solaris 7 /usr/bin/printf. +as_echo='\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\' +as_echo=$as_echo$as_echo$as_echo$as_echo$as_echo +as_echo=$as_echo$as_echo$as_echo$as_echo$as_echo$as_echo +# Prefer a ksh shell builtin over an external printf program on Solaris, +# but without wasting forks for bash or zsh. +if test -z "$BASH_VERSION$ZSH_VERSION" \ + && (test "X`print -r -- $as_echo`" = "X$as_echo") 2>/dev/null; then + as_echo='print -r --' + as_echo_n='print -rn --' +elif (test "X`printf %s $as_echo`" = "X$as_echo") 2>/dev/null; then + as_echo='printf %s\n' + as_echo_n='printf %s' +else + if test "X`(/usr/ucb/echo -n -n $as_echo) 2>/dev/null`" = "X-n $as_echo"; then + as_echo_body='eval /usr/ucb/echo -n "$1$as_nl"' + as_echo_n='/usr/ucb/echo -n' + else + as_echo_body='eval expr "X$1" : "X\\(.*\\)"' + as_echo_n_body='eval + arg=$1; + case $arg in #( + *"$as_nl"*) + expr "X$arg" : "X\\(.*\\)$as_nl"; + arg=`expr "X$arg" : ".*$as_nl\\(.*\\)"`;; + esac; + expr "X$arg" : "X\\(.*\\)" | tr -d "$as_nl" + ' + export as_echo_n_body + as_echo_n='sh -c $as_echo_n_body as_echo' + fi + export as_echo_body + as_echo='sh -c $as_echo_body as_echo' +fi + +# The user is always right. +if test "${PATH_SEPARATOR+set}" != set; then + PATH_SEPARATOR=: + (PATH='/bin;/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 && { + (PATH='/bin:/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 || + PATH_SEPARATOR=';' + } +fi + + +# IFS +# We need space, tab and new line, in precisely that order. Quoting is +# there to prevent editors from complaining about space-tab. +# (If _AS_PATH_WALK were called with IFS unset, it would disable word +# splitting by setting IFS to empty value.) +IFS=" "" $as_nl" + +# Find who we are. Look in the path if we contain no directory separator. +as_myself= +case $0 in #(( + *[\\/]* ) as_myself=$0 ;; + *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR +for as_dir in $PATH +do + IFS=$as_save_IFS + test -z "$as_dir" && as_dir=. + test -r "$as_dir/$0" && as_myself=$as_dir/$0 && break + done +IFS=$as_save_IFS + + ;; +esac +# We did not find ourselves, most probably we were run as `sh COMMAND' +# in which case we are not to be found in the path. +if test "x$as_myself" = x; then + as_myself=$0 +fi +if test ! -f "$as_myself"; then + $as_echo "$as_myself: error: cannot find myself; rerun with an absolute file name" >&2 + exit 1 +fi + +# Unset variables that we do not need and which cause bugs (e.g. in +# pre-3.0 UWIN ksh). But do not cause bugs in bash 2.01; the "|| exit 1" +# suppresses any "Segmentation fault" message there. '((' could +# trigger a bug in pdksh 5.2.14. +for as_var in BASH_ENV ENV MAIL MAILPATH +do eval test x\${$as_var+set} = xset \ + && ( (unset $as_var) || exit 1) >/dev/null 2>&1 && unset $as_var || : +done +PS1='$ ' +PS2='> ' +PS4='+ ' + +# NLS nuisances. +LC_ALL=C +export LC_ALL +LANGUAGE=C +export LANGUAGE + +# CDPATH. +(unset CDPATH) >/dev/null 2>&1 && unset CDPATH + + +# as_fn_error STATUS ERROR [LINENO LOG_FD] +# ---------------------------------------- +# Output "`basename $0`: error: ERROR" to stderr. If LINENO and LOG_FD are +# provided, also output the error to LOG_FD, referencing LINENO. Then exit the +# script with STATUS, using 1 if that was 0. +as_fn_error () +{ + as_status=$1; test $as_status -eq 0 && as_status=1 + if test "$4"; then + as_lineno=${as_lineno-"$3"} as_lineno_stack=as_lineno_stack=$as_lineno_stack + $as_echo "$as_me:${as_lineno-$LINENO}: error: $2" >&$4 + fi + $as_echo "$as_me: error: $2" >&2 + as_fn_exit $as_status +} # as_fn_error + + +# as_fn_set_status STATUS +# ----------------------- +# Set $? to STATUS, without forking. +as_fn_set_status () +{ + return $1 +} # as_fn_set_status + +# as_fn_exit STATUS +# ----------------- +# Exit the shell with STATUS, even in a "trap 0" or "set -e" context. +as_fn_exit () +{ + set +e + as_fn_set_status $1 + exit $1 +} # as_fn_exit + +# as_fn_unset VAR +# --------------- +# Portably unset VAR. +as_fn_unset () +{ + { eval $1=; unset $1;} +} +as_unset=as_fn_unset +# as_fn_append VAR VALUE +# ---------------------- +# Append the text in VALUE to the end of the definition contained in VAR. Take +# advantage of any shell optimizations that allow amortized linear growth over +# repeated appends, instead of the typical quadratic growth present in naive +# implementations. +if (eval "as_var=1; as_var+=2; test x\$as_var = x12") 2>/dev/null; then : + eval 'as_fn_append () + { + eval $1+=\$2 + }' +else + as_fn_append () + { + eval $1=\$$1\$2 + } +fi # as_fn_append + +# as_fn_arith ARG... +# ------------------ +# Perform arithmetic evaluation on the ARGs, and store the result in the +# global $as_val. Take advantage of shells that can avoid forks. The arguments +# must be portable across $(()) and expr. +if (eval "test \$(( 1 + 1 )) = 2") 2>/dev/null; then : + eval 'as_fn_arith () + { + as_val=$(( $* )) + }' +else + as_fn_arith () + { + as_val=`expr "$@" || test $? -eq 1` + } +fi # as_fn_arith + + +if expr a : '\(a\)' >/dev/null 2>&1 && + test "X`expr 00001 : '.*\(...\)'`" = X001; then + as_expr=expr +else + as_expr=false +fi + +if (basename -- /) >/dev/null 2>&1 && test "X`basename -- / 2>&1`" = "X/"; then + as_basename=basename +else + as_basename=false +fi + +if (as_dir=`dirname -- /` && test "X$as_dir" = X/) >/dev/null 2>&1; then + as_dirname=dirname +else + as_dirname=false +fi + +as_me=`$as_basename -- "$0" || +$as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ + X"$0" : 'X\(//\)$' \| \ + X"$0" : 'X\(/\)' \| . 2>/dev/null || +$as_echo X/"$0" | + sed '/^.*\/\([^/][^/]*\)\/*$/{ + s//\1/ + q + } + /^X\/\(\/\/\)$/{ + s//\1/ + q + } + /^X\/\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + +# Avoid depending upon Character Ranges. +as_cr_letters='abcdefghijklmnopqrstuvwxyz' +as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' +as_cr_Letters=$as_cr_letters$as_cr_LETTERS +as_cr_digits='0123456789' +as_cr_alnum=$as_cr_Letters$as_cr_digits + +ECHO_C= ECHO_N= ECHO_T= +case `echo -n x` in #((((( +-n*) + case `echo 'xy\c'` in + *c*) ECHO_T=' ';; # ECHO_T is single tab character. + xy) ECHO_C='\c';; + *) echo `echo ksh88 bug on AIX 6.1` > /dev/null + ECHO_T=' ';; + esac;; +*) + ECHO_N='-n';; +esac + +rm -f conf$$ conf$$.exe conf$$.file +if test -d conf$$.dir; then + rm -f conf$$.dir/conf$$.file +else + rm -f conf$$.dir + mkdir conf$$.dir 2>/dev/null +fi +if (echo >conf$$.file) 2>/dev/null; then + if ln -s conf$$.file conf$$ 2>/dev/null; then + as_ln_s='ln -s' + # ... but there are two gotchas: + # 1) On MSYS, both `ln -s file dir' and `ln file dir' fail. + # 2) DJGPP < 2.04 has no symlinks; `ln -s' creates a wrapper executable. + # In both cases, we have to default to `cp -p'. + ln -s conf$$.file conf$$.dir 2>/dev/null && test ! -f conf$$.exe || + as_ln_s='cp -p' + elif ln conf$$.file conf$$ 2>/dev/null; then + as_ln_s=ln + else + as_ln_s='cp -p' + fi +else + as_ln_s='cp -p' +fi +rm -f conf$$ conf$$.exe conf$$.dir/conf$$.file conf$$.file +rmdir conf$$.dir 2>/dev/null + + +# as_fn_mkdir_p +# ------------- +# Create "$as_dir" as a directory, including parents if necessary. +as_fn_mkdir_p () +{ + + case $as_dir in #( + -*) as_dir=./$as_dir;; + esac + test -d "$as_dir" || eval $as_mkdir_p || { + as_dirs= + while :; do + case $as_dir in #( + *\'*) as_qdir=`$as_echo "$as_dir" | sed "s/'/'\\\\\\\\''/g"`;; #'( + *) as_qdir=$as_dir;; + esac + as_dirs="'$as_qdir' $as_dirs" + as_dir=`$as_dirname -- "$as_dir" || +$as_expr X"$as_dir" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ + X"$as_dir" : 'X\(//\)[^/]' \| \ + X"$as_dir" : 'X\(//\)$' \| \ + X"$as_dir" : 'X\(/\)' \| . 2>/dev/null || +$as_echo X"$as_dir" | + sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ + s//\1/ + q + } + /^X\(\/\/\)[^/].*/{ + s//\1/ + q + } + /^X\(\/\/\)$/{ + s//\1/ + q + } + /^X\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + test -d "$as_dir" && break + done + test -z "$as_dirs" || eval "mkdir $as_dirs" + } || test -d "$as_dir" || as_fn_error $? "cannot create directory $as_dir" + + +} # as_fn_mkdir_p +if mkdir -p . 2>/dev/null; then + as_mkdir_p='mkdir -p "$as_dir"' +else + test -d ./-p && rmdir ./-p + as_mkdir_p=false +fi + +if test -x / >/dev/null 2>&1; then + as_test_x='test -x' +else + if ls -dL / >/dev/null 2>&1; then + as_ls_L_option=L + else + as_ls_L_option= + fi + as_test_x=' + eval sh -c '\'' + if test -d "$1"; then + test -d "$1/."; + else + case $1 in #( + -*)set "./$1";; + esac; + case `ls -ld'$as_ls_L_option' "$1" 2>/dev/null` in #(( + ???[sx]*):;;*)false;;esac;fi + '\'' sh + ' +fi +as_executable_p=$as_test_x + +# Sed expression to map a string onto a valid CPP name. +as_tr_cpp="eval sed 'y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g'" + +# Sed expression to map a string onto a valid variable name. +as_tr_sh="eval sed 'y%*+%pp%;s%[^_$as_cr_alnum]%_%g'" + + +exec 6>&1 +## ----------------------------------- ## +## Main body of $CONFIG_STATUS script. ## +## ----------------------------------- ## +_ASEOF +test $as_write_fail = 0 && chmod +x $CONFIG_STATUS || ac_write_fail=1 + +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +# Save the log message, to keep $0 and so on meaningful, and to +# report actual input values of CONFIG_FILES etc. instead of their +# values after options handling. +ac_log=" +This file was extended by asciidoc $as_me 8.6.8, which was +generated by GNU Autoconf 2.68. Invocation command line was + + CONFIG_FILES = $CONFIG_FILES + CONFIG_HEADERS = $CONFIG_HEADERS + CONFIG_LINKS = $CONFIG_LINKS + CONFIG_COMMANDS = $CONFIG_COMMANDS + $ $0 $@ + +on `(hostname || uname -n) 2>/dev/null | sed 1q` +" + +_ACEOF + +case $ac_config_files in *" +"*) set x $ac_config_files; shift; ac_config_files=$*;; +esac + + + +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +# Files that config.status was made for. +config_files="$ac_config_files" + +_ACEOF + +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +ac_cs_usage="\ +\`$as_me' instantiates files and other configuration actions +from templates according to the current configuration. Unless the files +and actions are specified as TAGs, all are instantiated by default. + +Usage: $0 [OPTION]... [TAG]... + + -h, --help print this help, then exit + -V, --version print version number and configuration settings, then exit + --config print configuration, then exit + -q, --quiet, --silent + do not print progress messages + -d, --debug don't remove temporary files + --recheck update $as_me by reconfiguring in the same conditions + --file=FILE[:TEMPLATE] + instantiate the configuration file FILE + +Configuration files: +$config_files + +Report bugs to the package provider." + +_ACEOF +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`" +ac_cs_version="\\ +asciidoc config.status 8.6.8 +configured by $0, generated by GNU Autoconf 2.68, + with options \\"\$ac_cs_config\\" + +Copyright (C) 2010 Free Software Foundation, Inc. +This config.status script is free software; the Free Software Foundation +gives unlimited permission to copy, distribute and modify it." + +ac_pwd='$ac_pwd' +srcdir='$srcdir' +INSTALL='$INSTALL' +test -n "\$AWK" || AWK=awk +_ACEOF + +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +# The default lists apply if the user does not specify any file. +ac_need_defaults=: +while test $# != 0 +do + case $1 in + --*=?*) + ac_option=`expr "X$1" : 'X\([^=]*\)='` + ac_optarg=`expr "X$1" : 'X[^=]*=\(.*\)'` + ac_shift=: + ;; + --*=) + ac_option=`expr "X$1" : 'X\([^=]*\)='` + ac_optarg= + ac_shift=: + ;; + *) + ac_option=$1 + ac_optarg=$2 + ac_shift=shift + ;; + esac + + case $ac_option in + # Handling of the options. + -recheck | --recheck | --rechec | --reche | --rech | --rec | --re | --r) + ac_cs_recheck=: ;; + --version | --versio | --versi | --vers | --ver | --ve | --v | -V ) + $as_echo "$ac_cs_version"; exit ;; + --config | --confi | --conf | --con | --co | --c ) + $as_echo "$ac_cs_config"; exit ;; + --debug | --debu | --deb | --de | --d | -d ) + debug=: ;; + --file | --fil | --fi | --f ) + $ac_shift + case $ac_optarg in + *\'*) ac_optarg=`$as_echo "$ac_optarg" | sed "s/'/'\\\\\\\\''/g"` ;; + '') as_fn_error $? "missing file argument" ;; + esac + as_fn_append CONFIG_FILES " '$ac_optarg'" + ac_need_defaults=false;; + --he | --h | --help | --hel | -h ) + $as_echo "$ac_cs_usage"; exit ;; + -q | -quiet | --quiet | --quie | --qui | --qu | --q \ + | -silent | --silent | --silen | --sile | --sil | --si | --s) + ac_cs_silent=: ;; + + # This is an error. + -*) as_fn_error $? "unrecognized option: \`$1' +Try \`$0 --help' for more information." ;; + + *) as_fn_append ac_config_targets " $1" + ac_need_defaults=false ;; + + esac + shift +done + +ac_configure_extra_args= + +if $ac_cs_silent; then + exec 6>/dev/null + ac_configure_extra_args="$ac_configure_extra_args --silent" +fi + +_ACEOF +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +if \$ac_cs_recheck; then + set X '$SHELL' '$0' $ac_configure_args \$ac_configure_extra_args --no-create --no-recursion + shift + \$as_echo "running CONFIG_SHELL=$SHELL \$*" >&6 + CONFIG_SHELL='$SHELL' + export CONFIG_SHELL + exec "\$@" +fi + +_ACEOF +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +exec 5>>config.log +{ + echo + sed 'h;s/./-/g;s/^.../## /;s/...$/ ##/;p;x;p;x' <<_ASBOX +## Running $as_me. ## +_ASBOX + $as_echo "$ac_log" +} >&5 + +_ACEOF +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +_ACEOF + +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 + +# Handling of arguments. +for ac_config_target in $ac_config_targets +do + case $ac_config_target in + "Makefile") CONFIG_FILES="$CONFIG_FILES Makefile" ;; + + *) as_fn_error $? "invalid argument: \`$ac_config_target'" "$LINENO" 5;; + esac +done + + +# If the user did not use the arguments to specify the items to instantiate, +# then the envvar interface is used. Set only those that are not. +# We use the long form for the default assignment because of an extremely +# bizarre bug on SunOS 4.1.3. +if $ac_need_defaults; then + test "${CONFIG_FILES+set}" = set || CONFIG_FILES=$config_files +fi + +# Have a temporary directory for convenience. Make it in the build tree +# simply because there is no reason against having it here, and in addition, +# creating and moving files from /tmp can sometimes cause problems. +# Hook for its removal unless debugging. +# Note that there is a small window in which the directory will not be cleaned: +# after its creation but before its name has been assigned to `$tmp'. +$debug || +{ + tmp= ac_tmp= + trap 'exit_status=$? + : "${ac_tmp:=$tmp}" + { test ! -d "$ac_tmp" || rm -fr "$ac_tmp"; } && exit $exit_status +' 0 + trap 'as_fn_exit 1' 1 2 13 15 +} +# Create a (secure) tmp directory for tmp files. + +{ + tmp=`(umask 077 && mktemp -d "./confXXXXXX") 2>/dev/null` && + test -d "$tmp" +} || +{ + tmp=./conf$$-$RANDOM + (umask 077 && mkdir "$tmp") +} || as_fn_error $? "cannot create a temporary directory in ." "$LINENO" 5 +ac_tmp=$tmp + +# Set up the scripts for CONFIG_FILES section. +# No need to generate them if there are no CONFIG_FILES. +# This happens for instance with `./config.status config.h'. +if test -n "$CONFIG_FILES"; then + + +ac_cr=`echo X | tr X '\015'` +# On cygwin, bash can eat \r inside `` if the user requested igncr. +# But we know of no other shell where ac_cr would be empty at this +# point, so we can use a bashism as a fallback. +if test "x$ac_cr" = x; then + eval ac_cr=\$\'\\r\' +fi +ac_cs_awk_cr=`$AWK 'BEGIN { print "a\rb" }' /dev/null` +if test "$ac_cs_awk_cr" = "a${ac_cr}b"; then + ac_cs_awk_cr='\\r' +else + ac_cs_awk_cr=$ac_cr +fi + +echo 'BEGIN {' >"$ac_tmp/subs1.awk" && +_ACEOF + + +{ + echo "cat >conf$$subs.awk <<_ACEOF" && + echo "$ac_subst_vars" | sed 's/.*/&!$&$ac_delim/' && + echo "_ACEOF" +} >conf$$subs.sh || + as_fn_error $? "could not make $CONFIG_STATUS" "$LINENO" 5 +ac_delim_num=`echo "$ac_subst_vars" | grep -c '^'` +ac_delim='%!_!# ' +for ac_last_try in false false false false false :; do + . ./conf$$subs.sh || + as_fn_error $? "could not make $CONFIG_STATUS" "$LINENO" 5 + + ac_delim_n=`sed -n "s/.*$ac_delim\$/X/p" conf$$subs.awk | grep -c X` + if test $ac_delim_n = $ac_delim_num; then + break + elif $ac_last_try; then + as_fn_error $? "could not make $CONFIG_STATUS" "$LINENO" 5 + else + ac_delim="$ac_delim!$ac_delim _$ac_delim!! " + fi +done +rm -f conf$$subs.sh + +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +cat >>"\$ac_tmp/subs1.awk" <<\\_ACAWK && +_ACEOF +sed -n ' +h +s/^/S["/; s/!.*/"]=/ +p +g +s/^[^!]*!// +:repl +t repl +s/'"$ac_delim"'$// +t delim +:nl +h +s/\(.\{148\}\)..*/\1/ +t more1 +s/["\\]/\\&/g; s/^/"/; s/$/\\n"\\/ +p +n +b repl +:more1 +s/["\\]/\\&/g; s/^/"/; s/$/"\\/ +p +g +s/.\{148\}// +t nl +:delim +h +s/\(.\{148\}\)..*/\1/ +t more2 +s/["\\]/\\&/g; s/^/"/; s/$/"/ +p +b +:more2 +s/["\\]/\\&/g; s/^/"/; s/$/"\\/ +p +g +s/.\{148\}// +t delim +' >$CONFIG_STATUS || ac_write_fail=1 +rm -f conf$$subs.awk +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +_ACAWK +cat >>"\$ac_tmp/subs1.awk" <<_ACAWK && + for (key in S) S_is_set[key] = 1 + FS = "" + +} +{ + line = $ 0 + nfields = split(line, field, "@") + substed = 0 + len = length(field[1]) + for (i = 2; i < nfields; i++) { + key = field[i] + keylen = length(key) + if (S_is_set[key]) { + value = S[key] + line = substr(line, 1, len) "" value "" substr(line, len + keylen + 3) + len += length(value) + length(field[++i]) + substed = 1 + } else + len += 1 + keylen + } + + print line +} + +_ACAWK +_ACEOF +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +if sed "s/$ac_cr//" < /dev/null > /dev/null 2>&1; then + sed "s/$ac_cr\$//; s/$ac_cr/$ac_cs_awk_cr/g" +else + cat +fi < "$ac_tmp/subs1.awk" > "$ac_tmp/subs.awk" \ + || as_fn_error $? "could not setup config files machinery" "$LINENO" 5 +_ACEOF + +# VPATH may cause trouble with some makes, so we remove sole $(srcdir), +# ${srcdir} and @srcdir@ entries from VPATH if srcdir is ".", strip leading and +# trailing colons and then remove the whole line if VPATH becomes empty +# (actually we leave an empty line to preserve line numbers). +if test "x$srcdir" = x.; then + ac_vpsub='/^[ ]*VPATH[ ]*=[ ]*/{ +h +s/// +s/^/:/ +s/[ ]*$/:/ +s/:\$(srcdir):/:/g +s/:\${srcdir}:/:/g +s/:@srcdir@:/:/g +s/^:*// +s/:*$// +x +s/\(=[ ]*\).*/\1/ +G +s/\n// +s/^[^=]*=[ ]*$// +}' +fi + +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +fi # test -n "$CONFIG_FILES" + + +eval set X " :F $CONFIG_FILES " +shift +for ac_tag +do + case $ac_tag in + :[FHLC]) ac_mode=$ac_tag; continue;; + esac + case $ac_mode$ac_tag in + :[FHL]*:*);; + :L* | :C*:*) as_fn_error $? "invalid tag \`$ac_tag'" "$LINENO" 5;; + :[FH]-) ac_tag=-:-;; + :[FH]*) ac_tag=$ac_tag:$ac_tag.in;; + esac + ac_save_IFS=$IFS + IFS=: + set x $ac_tag + IFS=$ac_save_IFS + shift + ac_file=$1 + shift + + case $ac_mode in + :L) ac_source=$1;; + :[FH]) + ac_file_inputs= + for ac_f + do + case $ac_f in + -) ac_f="$ac_tmp/stdin";; + *) # Look for the file first in the build tree, then in the source tree + # (if the path is not absolute). The absolute path cannot be DOS-style, + # because $ac_f cannot contain `:'. + test -f "$ac_f" || + case $ac_f in + [\\/$]*) false;; + *) test -f "$srcdir/$ac_f" && ac_f="$srcdir/$ac_f";; + esac || + as_fn_error 1 "cannot find input file: \`$ac_f'" "$LINENO" 5;; + esac + case $ac_f in *\'*) ac_f=`$as_echo "$ac_f" | sed "s/'/'\\\\\\\\''/g"`;; esac + as_fn_append ac_file_inputs " '$ac_f'" + done + + # Let's still pretend it is `configure' which instantiates (i.e., don't + # use $as_me), people would be surprised to read: + # /* config.h. Generated by config.status. */ + configure_input='Generated from '` + $as_echo "$*" | sed 's|^[^:]*/||;s|:[^:]*/|, |g' + `' by configure.' + if test x"$ac_file" != x-; then + configure_input="$ac_file. $configure_input" + { $as_echo "$as_me:${as_lineno-$LINENO}: creating $ac_file" >&5 +$as_echo "$as_me: creating $ac_file" >&6;} + fi + # Neutralize special characters interpreted by sed in replacement strings. + case $configure_input in #( + *\&* | *\|* | *\\* ) + ac_sed_conf_input=`$as_echo "$configure_input" | + sed 's/[\\\\&|]/\\\\&/g'`;; #( + *) ac_sed_conf_input=$configure_input;; + esac + + case $ac_tag in + *:-:* | *:-) cat >"$ac_tmp/stdin" \ + || as_fn_error $? "could not create $ac_file" "$LINENO" 5 ;; + esac + ;; + esac + + ac_dir=`$as_dirname -- "$ac_file" || +$as_expr X"$ac_file" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ + X"$ac_file" : 'X\(//\)[^/]' \| \ + X"$ac_file" : 'X\(//\)$' \| \ + X"$ac_file" : 'X\(/\)' \| . 2>/dev/null || +$as_echo X"$ac_file" | + sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ + s//\1/ + q + } + /^X\(\/\/\)[^/].*/{ + s//\1/ + q + } + /^X\(\/\/\)$/{ + s//\1/ + q + } + /^X\(\/\).*/{ + s//\1/ + q + } + s/.*/./; q'` + as_dir="$ac_dir"; as_fn_mkdir_p + ac_builddir=. + +case "$ac_dir" in +.) ac_dir_suffix= ac_top_builddir_sub=. ac_top_build_prefix= ;; +*) + ac_dir_suffix=/`$as_echo "$ac_dir" | sed 's|^\.[\\/]||'` + # A ".." for each directory in $ac_dir_suffix. + ac_top_builddir_sub=`$as_echo "$ac_dir_suffix" | sed 's|/[^\\/]*|/..|g;s|/||'` + case $ac_top_builddir_sub in + "") ac_top_builddir_sub=. ac_top_build_prefix= ;; + *) ac_top_build_prefix=$ac_top_builddir_sub/ ;; + esac ;; +esac +ac_abs_top_builddir=$ac_pwd +ac_abs_builddir=$ac_pwd$ac_dir_suffix +# for backward compatibility: +ac_top_builddir=$ac_top_build_prefix + +case $srcdir in + .) # We are building in place. + ac_srcdir=. + ac_top_srcdir=$ac_top_builddir_sub + ac_abs_top_srcdir=$ac_pwd ;; + [\\/]* | ?:[\\/]* ) # Absolute name. + ac_srcdir=$srcdir$ac_dir_suffix; + ac_top_srcdir=$srcdir + ac_abs_top_srcdir=$srcdir ;; + *) # Relative name. + ac_srcdir=$ac_top_build_prefix$srcdir$ac_dir_suffix + ac_top_srcdir=$ac_top_build_prefix$srcdir + ac_abs_top_srcdir=$ac_pwd/$srcdir ;; +esac +ac_abs_srcdir=$ac_abs_top_srcdir$ac_dir_suffix + + + case $ac_mode in + :F) + # + # CONFIG_FILE + # + + case $INSTALL in + [\\/$]* | ?:[\\/]* ) ac_INSTALL=$INSTALL ;; + *) ac_INSTALL=$ac_top_build_prefix$INSTALL ;; + esac +_ACEOF + +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +# If the template does not know about datarootdir, expand it. +# FIXME: This hack should be removed a few years after 2.60. +ac_datarootdir_hack=; ac_datarootdir_seen= +ac_sed_dataroot=' +/datarootdir/ { + p + q +} +/@datadir@/p +/@docdir@/p +/@infodir@/p +/@localedir@/p +/@mandir@/p' +case `eval "sed -n \"\$ac_sed_dataroot\" $ac_file_inputs"` in +*datarootdir*) ac_datarootdir_seen=yes;; +*@datadir@*|*@docdir@*|*@infodir@*|*@localedir@*|*@mandir@*) + { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $ac_file_inputs seems to ignore the --datarootdir setting" >&5 +$as_echo "$as_me: WARNING: $ac_file_inputs seems to ignore the --datarootdir setting" >&2;} +_ACEOF +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 + ac_datarootdir_hack=' + s&@datadir@&$datadir&g + s&@docdir@&$docdir&g + s&@infodir@&$infodir&g + s&@localedir@&$localedir&g + s&@mandir@&$mandir&g + s&\\\${datarootdir}&$datarootdir&g' ;; +esac +_ACEOF + +# Neutralize VPATH when `$srcdir' = `.'. +# Shell code in configure.ac might set extrasub. +# FIXME: do we really want to maintain this feature? +cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 +ac_sed_extra="$ac_vpsub +$extrasub +_ACEOF +cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 +:t +/@[a-zA-Z_][a-zA-Z_0-9]*@/!b +s|@configure_input@|$ac_sed_conf_input|;t t +s&@top_builddir@&$ac_top_builddir_sub&;t t +s&@top_build_prefix@&$ac_top_build_prefix&;t t +s&@srcdir@&$ac_srcdir&;t t +s&@abs_srcdir@&$ac_abs_srcdir&;t t +s&@top_srcdir@&$ac_top_srcdir&;t t +s&@abs_top_srcdir@&$ac_abs_top_srcdir&;t t +s&@builddir@&$ac_builddir&;t t +s&@abs_builddir@&$ac_abs_builddir&;t t +s&@abs_top_builddir@&$ac_abs_top_builddir&;t t +s&@INSTALL@&$ac_INSTALL&;t t +$ac_datarootdir_hack +" +eval sed \"\$ac_sed_extra\" "$ac_file_inputs" | $AWK -f "$ac_tmp/subs.awk" \ + >$ac_tmp/out || as_fn_error $? "could not create $ac_file" "$LINENO" 5 + +test -z "$ac_datarootdir_hack$ac_datarootdir_seen" && + { ac_out=`sed -n '/\${datarootdir}/p' "$ac_tmp/out"`; test -n "$ac_out"; } && + { ac_out=`sed -n '/^[ ]*datarootdir[ ]*:*=/p' \ + "$ac_tmp/out"`; test -z "$ac_out"; } && + { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $ac_file contains a reference to the variable \`datarootdir' +which seems to be undefined. Please make sure it is defined" >&5 +$as_echo "$as_me: WARNING: $ac_file contains a reference to the variable \`datarootdir' +which seems to be undefined. Please make sure it is defined" >&2;} + + rm -f "$ac_tmp/stdin" + case $ac_file in + -) cat "$ac_tmp/out" && rm -f "$ac_tmp/out";; + *) rm -f "$ac_file" && mv "$ac_tmp/out" "$ac_file";; + esac \ + || as_fn_error $? "could not create $ac_file" "$LINENO" 5 + ;; + + + + esac + +done # for ac_tag + + +as_fn_exit 0 +_ACEOF +ac_clean_files=$ac_clean_files_save + +test $ac_write_fail = 0 || + as_fn_error $? "write failure creating $CONFIG_STATUS" "$LINENO" 5 + + +# configure is writing to config.log, and then calls config.status. +# config.status does its own redirection, appending to config.log. +# Unfortunately, on DOS this fails, as config.log is still kept open +# by configure, so config.status won't be able to write to it; its +# output is simply discarded. So we exec the FD to /dev/null, +# effectively closing config.log, so it can be properly (re)opened and +# appended to by config.status. When coming back to configure, we +# need to make the FD available again. +if test "$no_create" != yes; then + ac_cs_success=: + ac_config_status_args= + test "$silent" = yes && + ac_config_status_args="$ac_config_status_args --quiet" + exec 5>/dev/null + $SHELL $CONFIG_STATUS $ac_config_status_args || ac_cs_success=false + exec 5>>config.log + # Use ||, not &&, to avoid exiting from the if with $? = 1, which + # would make configure fail if this is the last instruction. + $ac_cs_success || as_fn_exit 1 +fi +if test -n "$ac_unrecognized_opts" && test "$enable_option_checking" != no; then + { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: unrecognized options: $ac_unrecognized_opts" >&5 +$as_echo "$as_me: WARNING: unrecognized options: $ac_unrecognized_opts" >&2;} +fi + diff --git a/source-builder/sb/asciidoc/configure.ac b/source-builder/sb/asciidoc/configure.ac new file mode 100644 index 0000000..3061ff6 --- /dev/null +++ b/source-builder/sb/asciidoc/configure.ac @@ -0,0 +1,11 @@ +AC_INIT(asciidoc, 8.6.8) + +AC_CONFIG_FILES(Makefile) + +AC_PROG_SED + +AC_PROG_LN_S + +AC_PROG_INSTALL + +AC_OUTPUT diff --git a/source-builder/sb/asciidoc/dblatex/asciidoc-dblatex.sty b/source-builder/sb/asciidoc/dblatex/asciidoc-dblatex.sty new file mode 100644 index 0000000..9d89839 --- /dev/null +++ b/source-builder/sb/asciidoc/dblatex/asciidoc-dblatex.sty @@ -0,0 +1,20 @@ +%% +%% This style is derived from the docbook one. +%% +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{asciidoc}[2008/06/05 AsciiDoc DocBook Style] +%% Just use the original package and pass the options. +\RequirePackageWithOptions{docbook} + +% Sidebar is a boxed minipage that can contain verbatim. +% Changed shadow box to double box. +\renewenvironment{sidebar}[1][0.95\textwidth]{ + \hspace{0mm}\newline% + \noindent\begin{Sbox}\begin{minipage}{#1}% + \setlength\parskip{\medskipamount}% +}{ + \end{minipage}\end{Sbox}\doublebox{\TheSbox}% +} + +% For DocBook literallayout elements, see `./dblatex/dblatex-readme.txt`. +\usepackage{alltt} diff --git a/source-builder/sb/asciidoc/dblatex/asciidoc-dblatex.xsl b/source-builder/sb/asciidoc/dblatex/asciidoc-dblatex.xsl new file mode 100644 index 0000000..3df2d2e --- /dev/null +++ b/source-builder/sb/asciidoc/dblatex/asciidoc-dblatex.xsl @@ -0,0 +1,74 @@ + + + + + + colorlinks,linkcolor=blue,pdfstartview=FitH + 1 + + 1 + 0 + 3 + 0 + 0 + 1 + + + + 1 + + + + \begin{alltt} + \normalfont{} + + \end{alltt} + + + + + \pagebreak[4] + + + + + + \newline + + + + + \begin{center} + \line(1,0){444} + \end{center} + + + + diff --git a/source-builder/sb/asciidoc/dblatex/dblatex-readme.txt b/source-builder/sb/asciidoc/dblatex/dblatex-readme.txt new file mode 100644 index 0000000..39bb437 --- /dev/null +++ b/source-builder/sb/asciidoc/dblatex/dblatex-readme.txt @@ -0,0 +1,39 @@ +AsciiDoc dblatex README +======================= + +Customization +------------- +The `./dblatex` directory contains: + +`./dblatex/asciidoc-dblatex.xsl`:: Optional dblatex XSL parameter +customization. + +`./dblatex/asciidoc-dblatex.sty`:: Optional customized LaTeX styles. + +Use these files with dblatex(1) `-p` and `-s` options, for example: + + dblatex -p ../dblatex/asciidoc-dblatex.xsl \ + -s ../dblatex/asciidoc-dblatex.sty article.xml + + +Limitations +----------- +Observed in dblatex 0.2.8. + +- dblatex doesn't seem to process the DocBook 'literallayout' element + correctly: it is rendered in a monospaced font and no inline + elements are processed. By default the normal font should be used + and almost all DocBook inline elements should be processed + (http://www.docbook.org/tdg/en/html/literallayout.html). I almost + fixed this by overriding the default dblatex literallayout template + (in `./dblatex/asciidoc-dblatex.xsl`) and using the LaTeX 'alltt' + package, but there are remaining problems: + + * Blank lines are replaced by a single space. + * The 'literallayout' element incorrectly wraps text when rendered + inside a table. + +- Callouts do not work inside DocBook 'literallayout' elements which + means callouts are not displayed inside AsciiDoc literal blocks. A + workaround is to change the AsciiDoc literal block to a listing + block. diff --git a/source-builder/sb/asciidoc/doc/a2x.1 b/source-builder/sb/asciidoc/doc/a2x.1 new file mode 100644 index 0000000..dba224a --- /dev/null +++ b/source-builder/sb/asciidoc/doc/a2x.1 @@ -0,0 +1,744 @@ +'\" t +.\" Title: a2x +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 17 July 2012 +.\" Manual: \ \& +.\" Source: \ \& 8.6.8 +.\" Language: English +.\" +.TH "A2X" "1" "17 July 2012" "\ \& 8\&.6\&.8" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +a2x \- A toolchain manager for AsciiDoc (converts Asciidoc text files to other file formats) +.SH "SYNOPSIS" +.sp +\fBa2x\fR [\fIOPTIONS\fR] \fISOURCE_FILE\fR +.SH "DESCRIPTION" +.sp +A DocBook toolchain manager that translates an AsciiDoc text file \fISOURCE_FILE\fR to PDF, EPUB, DVI, PS, LaTeX, XHTML (single page or chunked), man page, HTML Help or plain text formats using \fIasciidoc(1)\fR and other applications (see REQUISITES section)\&. \fISOURCE_FILE\fR can also be a DocBook file with an \&.xml extension\&. +.SH "OPTIONS" +.PP +\fB\-a, \-\-attribute\fR=\fIATTRIBUTE\fR +.RS 4 +Set asciidoc(1) attribute value (shortcut for +\fB\-\-asciidoc\-opts\fR=\fI"\-a ATTRIBUTE"\fR +option)\&. This option may be specified more than once\&. +.RE +.PP +\fB\-\-asciidoc\-opts\fR=\fIASCIIDOC_OPTS\fR +.RS 4 +Additional +\fIasciidoc(1)\fR +options\&. This option may be specified more than once\&. +.RE +.PP +\fB\-\-conf\-file\fR=\fICONF_FILE\fR +.RS 4 +Load configuration file\&. See +CONF FILES section\&. +.RE +.PP +\fB\-D, \-\-destination\-dir\fR=\fIDESTINATION_DIR\fR +.RS 4 +Output directory\&. Defaults to +\fISOURCE_FILE\fR +directory\&. +.RE +.PP +\fB\-d, \-\-doctype\fR=\fIDOCTYPE\fR +.RS 4 +DocBook document type: +\fIarticle\fR, +\fImanpage\fR +or +\fIbook\fR\&. Default document type is +\fIarticle\fR +unless the format is +\fImanpage\fR +(in which case it defaults to +\fImanpage\fR)\&. +.RE +.PP +\fB\-b, \-\-backend\fR=\fIBACKEND\fR +.RS 4 + +\fIBACKEND\fR +is the name of an installed backend plugin\&. When this option is specified +\fIa2x\fR +attempts load a file name +\fIa2x\-backend\&.py\fR +from the +\fIBACKEND\fR +plugin directory It then converts the +\fISOURCE_FILE\fR +to a +\fIBACKEND\fR +formatted output file using a global function defined in +\fIa2x\-backend\&.py\fR +called +\fIto_BACKEND\fR\&. +.RE +.PP +\fB\-f, \-\-format\fR=\fIFORMAT\fR +.RS 4 +Output formats: +\fIchunked\fR, +\fIdocbook\fR, +\fIdvi\fR, +\fIepub\fR, +\fIhtmlhelp\fR, +\fImanpage\fR, +\fIpdf\fR +(default), +\fIps\fR, +\fItex\fR, +\fItext\fR, +\fIxhtml\fR\&. The AsciiDoc +\fIa2x\-format\fR +attribute value is set to +\fIFORMAT\fR\&. +.RE +.PP +\fB\-h, \-\-help\fR +.RS 4 +Print command\-line syntax and program options to stdout\&. +.RE +.PP +\fB\-\-icons\fR +.RS 4 +Use admonition or navigation icon images in output documents\&. The default behavior is to use text in place of icons\&. +.RE +.PP +\fB\-\-icons\-dir\fR=\fIPATH\fR +.RS 4 +A path (relative to output files) containing admonition and navigation icons\&. Defaults to +images/icons\&. The +\fI\-\-icons\fR +option is implicit if this option is used\&. +.RE +.PP +\fB\-k, \-\-keep\-artifacts\fR +.RS 4 +Do not delete temporary build files\&. +.RE +.PP +\fB\-\-lynx\fR +.RS 4 +Use +\fIlynx(1)\fR +to generate text formatted output\&. The default behavior is to use +\fIw3m(1)\fR\&. +.RE +.PP +\fB\-L, \-\-no\-xmllint\fR +.RS 4 +Do not check asciidoc output with +\fIxmllint(1)\fR\&. +.RE +.PP +\fB\-\-\-epubcheck\fR +.RS 4 +Check EPUB output with +\fIepubcheck(1)\fR\&. +.RE +.PP +\fB\-n, \-\-dry\-run\fR +.RS 4 +Do not do anything just print what would have been done\&. +.RE +.PP +\fB\-r, \-\-resource\fR=\fIRESOURCE_SPEC\fR +.RS 4 +Specify a resource\&. This option may be specified more than once\&. See the +\fBRESOURCES\fR +section for more details\&. +.RE +.PP +\fB\-m, \-\-resource\-manifest\fR=\fIFILE\fR +.RS 4 + +\fIFILE\fR +contains a list resources (one per line)\&. Manifest +\fIFILE\fR +entries are formatted just like +\fB\-\-resource\fR +option arguments\&. Environment variables and tilde home directories are allowed\&. +.RE +.PP +\fB\-\-stylesheet\fR=\fISTYLESHEET\fR +.RS 4 +A space delimited list of one or more CSS stylesheet file names that are used to style HTML output generated by DocBook XSL Stylesheets\&. Defaults to +\fIdocbook\-xsl\&.css\fR\&. The stylesheets are processed in list order\&. The stylesheets must reside in a valid +resource file +location\&. Applies to HTML formats: +\fIxhtml\fR, +\fIepub\fR, +\fIchunked\fR, +\fIhtmlhelp\fR +formats\&. +.RE +.PP +\fB\-v, \-\-verbose\fR +.RS 4 +Print operational details to stderr\&. A second +\fB\-v\fR +option applies the verbose option to toolchain commands\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Print program version to stdout\&. +.RE +.PP +\fB\-\-xsltproc\-opts\fR=\fIXSLTPROC_OPTS\fR +.RS 4 +Additional +\fIxsltproc(1)\fR +options\&. This option may be specified more than once\&. +.RE +.PP +\fB\-\-xsl\-file\fR=\fIXSL_FILE\fR +.RS 4 +Override the built\-in XSL stylesheet with the custom XSL stylesheet +\fIXSL_FILE\fR\&. +.RE +.PP +\fB\-\-fop\fR +.RS 4 +Use FOP to generate PDFs\&. The default behavior is to use +\fIdblatex(1)\fR\&. The +\fI\-\-fop\fR +option is implicit if this option is used\&. +.RE +.PP +\fB\-\-fop\-opts\fR=\fIFOP_OPTS\fR +.RS 4 +Additional +\fIfop(1)\fR +options\&. If this option is specified FOP is used to generate PDFs\&. This option may be specified more than once\&. +.RE +.PP +\fB\-\-dblatex\-opts\fR=\fIDBLATEX_OPTS\fR +.RS 4 +Additional +\fIdblatex(1)\fR +options\&. This option may be specified more than once\&. +.RE +.PP +\fB\-\-backend\-opts\fR=\fIBACKEND_OPTS\fR +.RS 4 +Options for the backend plugin specified by the +\fI\-\-backend\fR +option\&. This option may be specified more than once\&. +.RE +.sp +Options can also be set in the AsciiDoc source file\&. If \fISOURCE_FILE\fR contains a comment line beginning with \fB// a2x:\fR then the remainder of the line will be treated as \fIa2x\fR command\-line options\&. For example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +// a2x default options\&. +// a2x: \-dbook \-\-epubcheck +// Suppress revision history in dblatex outputs\&. +// a2x: \-\-dblatex\-opts "\-P latex\&.output\&.revhistory=0" +.fi +.if n \{\ +.RE +.\} +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Options spanning multiple such comment lines will be concatenated\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Zero or more white space characters can appear between the leading +\fB//\fR +and +\fBa2x:\fR\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Command\-line options take precedence over options set in the source file\&. +.RE +.SH "OUTPUT FILES" +.sp +Output files are written to the directory specified by the \fB\-\-destination\-dir\fR option\&. If no \fB\-\-destination\-dir\fR option is set output files are written to the \fISOURCE_FILE\fR directory\&. +.sp +Output files have the same name as the \fISOURCE_FILE\fR but with an appropriate file name extension: \&.html for \fIxhtml\fR; \&.epub for \fIepub\fR; \&.hhp for \fIhtmlhelp\fR; \&.pdf for \fIpdf\fR; \&.text for \fItext\fR, \&.xml for \fIdocbook\fR\&. By convention manpages have no \&.man extension (man page section number only)\&. Chunked HTML directory names have a \&.chunked extension; chunked HTML Help directory names have a \&.htmlhelp extension\&. +.sp +Same named existing files are overwritten\&. +.sp +In addition to generating HTML files the \fIxhtml\fR, \fIepub\fR, \fIchunked\fR and \fIhtmlhelp\fR formats ensure resource files are copied to their correct destination directory locations\&. +.SH "RESOURCES" +.sp +Resources are files (typically CSS and images) that are required by HTML based outputs (\fIxhtml\fR, \fIepub\fR, \fIchunked\fR, \fIhtmlhelp\fR formats)\&. \fIa2x\fR scans the generated HTML files and builds a list of required CSS and image files\&. Additional resource files can be specified explicitly using the \fB\-\-resource\fR option\&. +.sp +\fIa2x\fR searches for resource files in the following locations in the following order: +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +The +\fISOURCE_FILE\fR +directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +Resource directories specified by the +\fB\-\-resource\fR +option (searched recursively)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 3." 4.2 +.\} +Resource directories specified by the +\fB\-\-resource\-manifest\fR +option (searched recursively in the order they appear in the manifest file)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 4.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 4." 4.2 +.\} +The stock +images +and +stylesheets +directories in the +\fIasciidoc(1)\fR +configuration files directories (searched recursively)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 5.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 5." 4.2 +.\} +The destination directory\&. +.RE +.sp +When a resource file is found it is copied to the correct relative destination directory\&. Missing destination sub\-directories are created automatically\&. +.sp +There are two distinct mechanisms for specifying additional resources: +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +A resource directory which will be searched recursively for missing resource files\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +A resource file which will be copied to the output destination directory\&. +.RE +.sp +Resources are specified with \fB\-\-resource\fR option values which can be one of the following formats: +.sp +.if n \{\ +.RS 4 +.\} +.nf + +[=] +\&.= +.fi +.if n \{\ +.RE +.\} +.sp +Where: +.PP + +.RS 4 +Specifies a directory (absolute or relative to the +\fISOURCE_FILE\fR) which is searched recursively for missing resource files\&. To eliminate ambiguity the + +name should end with a directory separator character\&. +.RE +.PP + +.RS 4 +Specifies a resource file (absolute or relative to the +\fISOURCE_FILE\fR) which will be copied to +\&. If + +is not specified then it is the same as the +\&. +.RE +.PP + +.RS 4 +Specifies the destination of the copied source file\&. The + +path is relative to the destination directory (absolute paths are not allowed)\&. The location of the destination directory depends on the output +\fIFORMAT\fR +(see the +\fBOUTPUT FILES\fR +section for details): +.PP +chunked, htmlhelp +.RS 4 +The chunked output directory\&. +.RE +.PP +epub +.RS 4 +The archived +OEBPS +directory\&. +.RE +.PP +xhtml +.RS 4 +The output +\fBDESTINATION_DIR\fR\&. +.RE +.RE +.PP +\&.= +.RS 4 +When adding resources to EPUB files the mimetype is inferred from the + +extension, if the mimetype cannot be guessed an error occurs\&. The +\&.= +resource syntax can be used to explicitly set mimetypes\&. + +is the file name extension, + +is the corresponding MIME type\&. +.RE +.sp +Resource option examples: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\-\-resource \&.\&./images/ +\-\-resource doc/README\&.txt=README\&.txt +\-\-resource ~/images/tiger\&.png=images/tiger\&.png +\-\-resource \&.ttf=application/x\-font\-ttf +.fi +.if n \{\ +.RE +.\} +.SH "EXAMPLES" +.PP +a2x \-f pdf doc/source\-highlight\-filter\&.txt +.RS 4 +Generates +doc/source\-highlight\-filter\&.pdf +file\&. +.RE +.PP +a2x \-f xhtml \-D \&.\&./doc \-\-icons \-r \&.\&./images/ team\&.txt +.RS 4 +Creates HTML file +\&.\&./doc/team\&.html, uses admonition icons and recursively searches the +\&.\&./images/ +directory for any missing resources\&. +.RE +.PP +a2x \-f manpage doc/asciidoc\&.1\&.txt +.RS 4 +Generate +doc/asciidoc\&.1 +manpage\&. +.RE +.SH "REQUISITES" +.sp +\fIa2x\fR uses the following programs: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBAsciidoc\fR: +http://www\&.methods\&.co\&.nz/asciidoc/ +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBxsltproc\fR: (all formats except text): +http://xmlsoft\&.org/XSLT/ +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBDocBook XSL Stylesheets\fR +(all formats except text): +http://docbook\&.sourceforge\&.net/projects/xsl/ +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBdblatex\fR +(pdf, dvi, ps, tex formats): +http://dblatex\&.sourceforge\&.net/ +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBFOP\fR +(pdf format \(em alternative PDF file generator): +http://xmlgraphics\&.apache\&.org/fop/ +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBw3m\fR +(text format): +http://w3m\&.sourceforge\&.net/index\&.en\&.html +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBLynx\fR +(text format \(em alternative text file generator): +http://lynx\&.isc\&.org/ +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} + +\fBepubcheck\fR +(epub format \(em EPUB file validator): +http://code\&.google\&.com/p/epubcheck/ +.RE +.sp +See also the latest README file\&. +.SH "CONF FILES" +.sp +A configuration file contains executable Python code that overrides the global configuration parameters in a2x\&.py\&. Optional configuration files are loaded in the following order: +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} + +a2x\&.conf +from the directory containing the +\fIa2x\&.py\fR +executable\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} + +a2x\&.conf +from the AsciiDoc global configuration directory\&. Skip this step if we are executing a locally installed (non system wide) copy\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 3." 4.2 +.\} + +a2x\&.conf +from the AsciiDoc +$HOME/\&.asciidoc +configuration directory\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 4.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 4." 4.2 +.\} +The +\fICONF_FILE\fR +specified in the +\fI\-\-conf\-file\fR +option\&. +.RE +.sp +Here are the default configuration file option values: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# Optional environment variable dictionary passed to +# executing programs\&. If set to None the existing +# environment is used\&. +ENV = None + +# External executables\&. +ASCIIDOC = \*(Aqasciidoc\*(Aq +XSLTPROC = \*(Aqxsltproc\*(Aq +DBLATEX = \*(Aqdblatex\*(Aq # pdf generation\&. +FOP = \*(Aqfop\*(Aq # pdf generation (\-\-fop option)\&. +W3M = \*(Aqw3m\*(Aq # text generation\&. +LYNX = \*(Aqlynx\*(Aq # text generation (if no w3m)\&. +XMLLINT = \*(Aqxmllint\*(Aq # Set to \*(Aq\*(Aq to disable\&. +EPUBCHECK = \*(Aqepubcheck\*(Aq # Set to \*(Aq\*(Aq to disable\&. +# External executable default options\&. +ASCIIDOC_OPTS = \*(Aq\*(Aq +DBLATEX_OPTS = \*(Aq\*(Aq +FOP_OPTS = \*(Aq\*(Aq +XSLTPROC_OPTS = \*(Aq\*(Aq +.fi +.if n \{\ +.RE +.\} +.SH "BUGS" +.sp +See the AsciiDoc distribution BUGS file\&. +.SH "AUTHOR" +.sp +a2x was originally written by Stuart Rackham\&. Many people have contributed to it\&. +.SH "RESOURCES" +.sp +SourceForge: http://sourceforge\&.net/projects/asciidoc/ +.sp +Main web site: http://www\&.methods\&.co\&.nz/asciidoc/ +.SH "COPYING" +.sp +Copyright (C) 2002\-2011 Stuart Rackham\&. Free use of this software is granted under the terms of the MIT license\&. diff --git a/source-builder/sb/asciidoc/doc/a2x.1.txt b/source-builder/sb/asciidoc/doc/a2x.1.txt new file mode 100644 index 0000000..56cc956 --- /dev/null +++ b/source-builder/sb/asciidoc/doc/a2x.1.txt @@ -0,0 +1,358 @@ +A2X(1) +====== +:doctype: manpage + + +NAME +---- +a2x - A toolchain manager for AsciiDoc (converts Asciidoc text files to other + file formats) + + +SYNOPSIS +-------- +*a2x* ['OPTIONS'] 'SOURCE_FILE' + + +DESCRIPTION +----------- +A DocBook toolchain manager that translates an AsciiDoc text file +'SOURCE_FILE' to PDF, EPUB, DVI, PS, LaTeX, XHTML (single page or +chunked), man page, HTML Help or plain text formats using +'asciidoc(1)' and other applications (see <>). +'SOURCE_FILE' can also be a DocBook file with an .xml extension. + + +OPTIONS +------- +*-a, --attribute*='ATTRIBUTE':: + Set asciidoc(1) attribute value (shortcut for *--asciidoc-opts*='"-a + ATTRIBUTE"' option). + This option may be specified more than once. + +*--asciidoc-opts*='ASCIIDOC_OPTS':: + Additional 'asciidoc(1)' options. + This option may be specified more than once. + +*--conf-file*='CONF_FILE':: + Load configuration file. See <>. + +*-D, --destination-dir*='DESTINATION_DIR':: + Output directory. Defaults to 'SOURCE_FILE' directory. + +*-d, --doctype*='DOCTYPE':: + DocBook document type: 'article', 'manpage' or 'book'. Default + document type is 'article' unless the format is 'manpage' (in which + case it defaults to 'manpage'). + +*-b, --backend*='BACKEND':: + 'BACKEND' is the name of an installed backend plugin. When this + option is specified 'a2x' attempts load a file name 'a2x-backend.py' + from the 'BACKEND' plugin directory It then converts the + 'SOURCE_FILE' to a 'BACKEND' formatted output file using a global + function defined in 'a2x-backend.py' called 'to_BACKEND'. + +*-f, --format*='FORMAT':: + Output formats: 'chunked', 'docbook', 'dvi', 'epub', 'htmlhelp', + 'manpage', 'pdf' (default), 'ps', 'tex', 'text', 'xhtml'. + The AsciiDoc 'a2x-format' attribute value is set to 'FORMAT'. + +*-h, --help*:: + Print command-line syntax and program options to stdout. + +*--icons*:: + Use admonition or navigation icon images in output documents. The + default behavior is to use text in place of icons. + +*--icons-dir*='PATH':: + A path (relative to output files) containing admonition + and navigation icons. Defaults to `images/icons`. + The '--icons' option is implicit if this option is used. + +*-k, --keep-artifacts*:: + Do not delete temporary build files. + +*--lynx*:: + Use 'lynx(1)' to generate text formatted output. The default + behavior is to use 'w3m(1)'. + +*-L, --no-xmllint*:: + Do not check asciidoc output with 'xmllint(1)'. + +*---epubcheck*:: + Check EPUB output with 'epubcheck(1)'. + +*-n, --dry-run*:: + Do not do anything just print what would have been done. + +*-r, --resource*='RESOURCE_SPEC':: + Specify a resource. This option may be specified more than once. + See the <> section for more details. + +*-m, --resource-manifest*='FILE':: + 'FILE' contains a list resources (one per line). Manifest 'FILE' + entries are formatted just like *--resource* option arguments. + Environment variables and tilde home directories are allowed. + +*--stylesheet*='STYLESHEET':: + A space delimited list of one or more CSS stylesheet file names that + are used to style HTML output generated by DocBook XSL Stylesheets. + Defaults to 'docbook-xsl.css'. The stylesheets are processed in + list order. The stylesheets must reside in a valid <> location. Applies to HTML formats: 'xhtml', 'epub', + 'chunked', 'htmlhelp' formats. + +*-v, --verbose*:: + Print operational details to stderr. + A second *-v* option applies the verbose option to toolchain commands. + +*--version*:: + Print program version to stdout. + +*--xsltproc-opts*='XSLTPROC_OPTS':: + Additional 'xsltproc(1)' options. + This option may be specified more than once. + +*--xsl-file*='XSL_FILE':: + Override the built-in XSL stylesheet with the custom XSL stylesheet + 'XSL_FILE'. + +*--fop*:: + Use FOP to generate PDFs. The default behavior is to use + 'dblatex(1)'. The '--fop' option is implicit if this option is + used. + +*--fop-opts*='FOP_OPTS':: + Additional 'fop(1)' options. If this option is specified FOP is used + to generate PDFs. + This option may be specified more than once. + +*--dblatex-opts*='DBLATEX_OPTS':: + Additional 'dblatex(1)' options. + This option may be specified more than once. + +*--backend-opts*='BACKEND_OPTS':: + Options for the backend plugin specified by the '--backend' option. + This option may be specified more than once. + +Options can also be set in the AsciiDoc source file. If 'SOURCE_FILE' +contains a comment line beginning with *// a2x:* then the remainder of +the line will be treated as 'a2x' command-line options. For example: + + // a2x default options. + // a2x: -dbook --epubcheck + // Suppress revision history in dblatex outputs. + // a2x: --dblatex-opts "-P latex.output.revhistory=0" + +- Options spanning multiple such comment lines will be concatenated. +- Zero or more white space characters can appear between the leading + *//* and *a2x:*. +- Command-line options take precedence over options set in the source + file. + + +[[X4]] +OUTPUT FILES +------------ +Output files are written to the directory specified by the +*--destination-dir* option. If no *--destination-dir* option is set +output files are written to the 'SOURCE_FILE' directory. + +Output files have the same name as the 'SOURCE_FILE' but with an +appropriate file name extension: `.html` for 'xhtml'; `.epub` for +'epub'; `.hhp` for 'htmlhelp'; `.pdf` for 'pdf'; `.text` for 'text', +`.xml` for 'docbook'. By convention manpages have no `.man` extension +(man page section number only). Chunked HTML directory names have a +`.chunked` extension; chunked HTML Help directory names have a +`.htmlhelp` extension. + +Same named existing files are overwritten. + +In addition to generating HTML files the 'xhtml', 'epub', 'chunked' +and 'htmlhelp' formats ensure <> are copied to +their correct destination directory locations. + + +[[X3]] +RESOURCES +--------- +Resources are files (typically CSS and images) that are required by +HTML based outputs ('xhtml', 'epub', 'chunked', 'htmlhelp' formats). +'a2x' scans the generated HTML files and builds a list of required CSS +and image files. Additional resource files can be specified explicitly +using the *--resource* option. + +'a2x' searches for resource files in the following locations in the +following order: + +. The 'SOURCE_FILE' directory. +. Resource directories specified by the *--resource* option (searched + recursively). +. Resource directories specified by the *--resource-manifest* option + (searched recursively in the order they appear in the manifest + file). +. The stock `images` and `stylesheets` directories in the + 'asciidoc(1)' configuration files directories (searched + recursively). +. The destination directory. + +When a resource file is found it is copied to the correct relative +destination directory. Missing destination sub-directories are created +automatically. + +There are two distinct mechanisms for specifying additional resources: + +. A resource directory which will be searched recursively for missing + resource files. +. A resource file which will be copied to the output destination + directory. + +Resources are specified with *--resource* option values which can be +one of the following formats: + + + [=] + .= + +Where: + +``:: + Specifies a directory (absolute or relative to the 'SOURCE_FILE') + which is searched recursively for missing resource files. To + eliminate ambiguity the `` name should end with a + directory separator character. + +``:: + Specifies a resource file (absolute or relative to the + 'SOURCE_FILE') which will be copied to ``. If + `` is not specified then it is the same as the + ``. + +``:: + Specifies the destination of the copied source file. The + `` path is relative to the destination directory + (absolute paths are not allowed). The location of the destination + directory depends on the output 'FORMAT' (see the <> section for details): + + chunked, htmlhelp;; The chunked output directory. + epub;; The archived `OEBPS` directory. + xhtml;; The output *DESTINATION_DIR*. + +`.=`:: + When adding resources to EPUB files the mimetype is inferred from + the `` extension, if the mimetype cannot be + guessed an error occurs. The `.=` resource syntax can + be used to explicitly set mimetypes. `` is the file name + extension, `` is the corresponding MIME type. + +Resource option examples: + + --resource ../images/ + --resource doc/README.txt=README.txt + --resource ~/images/tiger.png=images/tiger.png + --resource .ttf=application/x-font-ttf + + +EXAMPLES +-------- +`a2x -f pdf doc/source-highlight-filter.txt`:: + Generates `doc/source-highlight-filter.pdf` file. + +`a2x -f xhtml -D ../doc --icons -r ../images/ team.txt`:: + Creates HTML file `../doc/team.html`, uses admonition icons and + recursively searches the `../images/` directory for any missing + resources. + +`a2x -f manpage doc/asciidoc.1.txt`:: + Generate `doc/asciidoc.1` manpage. + + +[[X1]] +REQUISITES +---------- +'a2x' uses the following programs: + +- *Asciidoc*: + http://www.methods.co.nz/asciidoc/ +- *xsltproc*: (all formats except text): + http://xmlsoft.org/XSLT/ +- *DocBook XSL Stylesheets* (all formats except text): + http://docbook.sourceforge.net/projects/xsl/ +- *dblatex* (pdf, dvi, ps, tex formats): + http://dblatex.sourceforge.net/ +- *FOP* (pdf format -- alternative PDF file generator): + http://xmlgraphics.apache.org/fop/ +- *w3m* (text format): + http://w3m.sourceforge.net/index.en.html +- *Lynx* (text format -- alternative text file generator): + http://lynx.isc.org/ +- *epubcheck* (epub format -- EPUB file validator): + http://code.google.com/p/epubcheck/ + +See also the latest README file. + + +[[X2]] +CONF FILES +---------- +A configuration file contains executable Python code that overrides +the global configuration parameters in `a2x.py`. Optional configuration +files are loaded in the following order: + +. `a2x.conf` from the directory containing the 'a2x.py' executable. +. `a2x.conf` from the AsciiDoc global configuration directory. Skip + this step if we are executing a locally installed (non system wide) + copy. +. `a2x.conf` from the AsciiDoc `$HOME/.asciidoc` configuration + directory. +. The 'CONF_FILE' specified in the '--conf-file' option. + +Here are the default configuration file option values: + +--------------------------------------------------------------------- +# Optional environment variable dictionary passed to +# executing programs. If set to None the existing +# environment is used. +ENV = None + +# External executables. +ASCIIDOC = 'asciidoc' +XSLTPROC = 'xsltproc' +DBLATEX = 'dblatex' # pdf generation. +FOP = 'fop' # pdf generation (--fop option). +W3M = 'w3m' # text generation. +LYNX = 'lynx' # text generation (if no w3m). +XMLLINT = 'xmllint' # Set to '' to disable. +EPUBCHECK = 'epubcheck' # Set to '' to disable. +# External executable default options. +ASCIIDOC_OPTS = '' +DBLATEX_OPTS = '' +FOP_OPTS = '' +XSLTPROC_OPTS = '' +--------------------------------------------------------------------- + + +BUGS +---- +See the AsciiDoc distribution BUGS file. + + +AUTHOR +------ +a2x 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-2011 Stuart Rackham. Free use of this software is +granted under the terms of the MIT license. + diff --git a/source-builder/sb/asciidoc/doc/article-docinfo.xml b/source-builder/sb/asciidoc/doc/article-docinfo.xml new file mode 100644 index 0000000..25174fc --- /dev/null +++ b/source-builder/sb/asciidoc/doc/article-docinfo.xml @@ -0,0 +1,87 @@ + + + + + Dr + Lois + Common-Demoninator + + Director, M. Behn School of Coop. Eng. + Director of Cooperative Efforts + The Marguerite Behn International School of + Cooperative Engineering + + + + + Mr + Steven + Norman + T + + ATI + Senior Application Analyst + Foobar, Inc. + Application Development + + + + + Peter + Pan + Sr. + Spiderman + + + Peter's a super hero in his spare time. + + + + + + + 2009 + Behn International + + + + + 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. + + + + + + 1.1 + May 2009 + PP + + Updates. + + + + 1.0 + October 2003 + PP + + First release. + + + diff --git a/source-builder/sb/asciidoc/doc/article.pdf b/source-builder/sb/asciidoc/doc/article.pdf new file mode 100644 index 0000000..0406eb1 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/article.pdf differ diff --git a/source-builder/sb/asciidoc/doc/article.txt b/source-builder/sb/asciidoc/doc/article.txt new file mode 100644 index 0000000..9a9cc50 --- /dev/null +++ b/source-builder/sb/asciidoc/doc/article.txt @@ -0,0 +1,139 @@ +The Article Title +================= +Author's Name +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 <>. +indexterm:[Second example index entry] + +An example link to a bibliography entry <>. + + +: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/source-builder/sb/asciidoc/doc/asciidoc.1 b/source-builder/sb/asciidoc/doc/asciidoc.1 new file mode 100644 index 0000000..09db244 --- /dev/null +++ b/source-builder/sb/asciidoc/doc/asciidoc.1 @@ -0,0 +1,310 @@ +'\" t +.\" Title: asciidoc +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 17 July 2012 +.\" Manual: \ \& +.\" Source: \ \& 8.6.8 +.\" Language: English +.\" +.TH "ASCIIDOC" "1" "17 July 2012" "\ \& 8\&.6\&.8" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +asciidoc \- converts an AsciiDoc text file to HTML or DocBook +.SH "SYNOPSIS" +.sp +\fBasciidoc\fR [\fIOPTIONS\fR] \fIFILE\fR +.SH "DESCRIPTION" +.sp +The asciidoc(1) command translates the AsciiDoc text file \fIFILE\fR to DocBook or HTML\&. If \fIFILE\fR is \fI\-\fR then the standard input is used\&. +.SH "OPTIONS" +.PP +\fB\-a, \-\-attribute\fR=\fIATTRIBUTE\fR +.RS 4 +Define or delete document attribute\&. +\fIATTRIBUTE\fR +is formatted like +\fINAME=VALUE\fR\&. Command\-line attributes take precedence over document and configuration file attributes\&. Alternate acceptable forms are +\fINAME\fR +(the +\fIVALUE\fR +defaults to an empty string); +\fINAME!\fR +(delete the +\fINAME\fR +attribute); +\fINAME=VALUE@\fR +(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 +\fItrace\fR +controls the output of diagnostic information\&. +.RE +.PP +\fB\-b, \-\-backend\fR=\fIBACKEND\fR +.RS 4 +Backend output file format: +\fIdocbook45\fR, +\fIxhtml11\fR, +\fIhtml4\fR, +\fIhtml5\fR, +\fIslidy\fR, +\fIwordpress\fR +or +\fIlatex\fR +(the +\fIlatex\fR +backend is experimental)\&. You can also use the backend alias names +\fIhtml\fR +(aliased to +\fIxhtml11\fR) or +\fIdocbook\fR +(aliased to +\fIdocbook45\fR)\&. Defaults to +\fIhtml\fR\&. The +\fB\-\-backend\fR +option is also used to manage backend plugins (see +\fBPLUGIN COMMANDS\fR)\&. +.RE +.PP +\fB\-f, \-\-conf\-file\fR=\fICONF_FILE\fR +.RS 4 +Use configuration file +\fICONF_FILE\fR\&.Configuration files processed in command\-line order (after implicit configuration files)\&. This option may be specified more than once\&. +.RE +.PP +\fB\-\-doctest\fR +.RS 4 +Run Python doctests in +\fIasciidoc\fR +module\&. +.RE +.PP +\fB\-d, \-\-doctype\fR=\fIDOCTYPE\fR +.RS 4 +Document type: +\fIarticle\fR, +\fImanpage\fR +or +\fIbook\fR\&. The +\fIbook\fR +document type is only supported by the +\fIdocbook\fR +backend\&. Default document type is +\fIarticle\fR\&. +.RE +.PP +\fB\-c, \-\-dump\-conf\fR +.RS 4 +Dump configuration to stdout\&. +.RE +.PP +\fB\-\-filter\fR=\fIFILTER\fR +.RS 4 +Specify the name of a filter to be loaded (used to load filters that are not auto\-loaded)\&. This option may be specified more than once\&. The +\fB\-\-filter\fR +option is also used to manage filter plugins (see +\fBPLUGIN COMMANDS\fR)\&. +.RE +.PP +\fB\-h, \-\-help\fR [\fITOPIC\fR] +.RS 4 +Print help TOPIC\&. +\fB\-\-help\fR +\fItopics\fR +will print a list of help topics, +\fB\-\-help\fR +\fIsyntax\fR +summarizes AsciiDoc syntax, +\fB\-\-help\fR +\fImanpage\fR +prints the AsciiDoc manpage\&. +.RE +.PP +\fB\-e, \-\-no\-conf\fR +.RS 4 +Exclude implicitly loaded configuration files except for those named like the input file (\fIinfile\&.conf\fR +and +\fIinfile\-backend\&.conf\fR)\&. +.RE +.PP +\fB\-s, \-\-no\-header\-footer\fR +.RS 4 +Suppress document header and footer output\&. +.RE +.PP +\fB\-o, \-\-out\-file\fR=\fIOUT_FILE\fR +.RS 4 +Write output to file +\fIOUT_FILE\fR\&. Defaults to the base name of input file with +\fIbackend\fR +extension\&. If the input is stdin then the outfile defaults to stdout\&. If +\fIOUT_FILE\fR +is +\fI\-\fR +then the standard output is used\&. +.RE +.PP +\fB\-n, \-\-section\-numbers\fR +.RS 4 +Auto\-number HTML article section titles\&. Synonym for +\fB\-\-attribute numbered\fR\&. +.RE +.PP +\fB\-\-safe\fR +.RS 4 +Enable safe mode\&. Safe mode is disabled by default\&. AsciiDoc +\fIsafe mode\fR +skips potentially dangerous scripted sections in AsciiDoc source files\&. +.RE +.PP +\fB\-\-theme\fR=\fITHEME\fR +.RS 4 +Specify a theme name\&. Synonym for +\fB\-\-attribute theme\fR=\fITHEME\fR\&. The +\fB\-\-theme\fR +option is also used to manage theme plugins (see +\fBPLUGIN COMMANDS\fR)\&. +.RE +.PP +\fB\-v, \-\-verbose\fR +.RS 4 +Verbosely print processing information and configuration file checks to stderr\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Print program version number\&. +.RE +.SH "PLUGIN COMMANDS" +.sp +The asciidoc(1) \fB\-\-filter\fR, \fB\-\-backend\fR and \fB\-\-theme\fR options are used to install, remove and list AsciiDoc filter, backend and theme plugins\&. Syntax: +.sp +.if n \{\ +.RS 4 +.\} +.nf +asciidoc OPTION install ZIP_FILE [PLUGINS_DIR] +asciidoc OPTION remove PLUGIN_NAME [PLUGINS_DIR] +asciidoc OPTION list +asciidoc OPTION build ZIP_FILE PLUGIN_SOURCE +.fi +.if n \{\ +.RE +.\} +.sp +Where: +.PP +\fBOPTION\fR +.RS 4 +asciidoc(1) +\fB\-\-filter\fR, +\fB\-\-backend\fR +or +\fB\-\-theme\fR +option specifying the type of plugin\&. +.RE +.PP +\fBPLUGIN_NAME\fR +.RS 4 +A unique plugin name containing only alphanumeric or underscore characters\&. +.RE +.PP +\fBZIP_FILE\fR +.RS 4 +A Zip file containing plugin resources, the name must start with the plugin name e\&.g\&. +my_filter\-1\&.0\&.zip +packages filter +my_filter\&. +.RE +.PP +\fBPLUGINS_DIR\fR +.RS 4 +The directory containing installed plugins\&. Each plugin is contained in its own separate subdirectory which has the same name as the plugin\&. +\fBPLUGINS_DIR\fR +defaults to the +$HOME/\&.asciidoc/filters +(for filter plugins) or +$HOME/\&.asciidoc/backends +(for backend plugins) or +$HOME/\&.asciidoc/themes +(for theme plugins)\&. +.RE +.PP +\fBPLUGIN_SOURCE\fR +.RS 4 +The name of a directory containing the plugin source files or the name of a single source file\&. +.RE +.sp +The plugin commands perform as follows: +.PP +\fBinstall\fR +.RS 4 +Create a subdirectory in +\fBPLUGINS_DIR\fR +with the same name as the plugin then extract the +\fBZIP_FILE\fR +into it\&. +.RE +.PP +\fBremove\fR +.RS 4 +Delete the +\fBPLUGIN_NAME\fR +plugin subdirectory and all its contents from the +\fBPLUGINS_DIR\fR\&. +.RE +.PP +\fBlist\fR +.RS 4 +List the names and locations of all installed filter or theme plugins (including standard plugins installed in the global configuration directory)\&. +.RE +.PP +\fBbuild\fR +.RS 4 +Create a plugin file named +\fBZIP_FILE\fR +containing the files and subdirectories specified by +\fBPLUGIN_SOURCE\fR\&. File and directory names starting with a period are skipped\&. +.RE +.SH "EXIT STATUS" +.PP +\fB0\fR +.RS 4 +Success +.RE +.PP +\fB1\fR +.RS 4 +Failure (syntax or usage error; configuration error; document processing failure; unexpected error)\&. +.RE +.SH "BUGS" +.sp +See the AsciiDoc distribution BUGS file\&. +.SH "AUTHOR" +.sp +AsciiDoc was originally written by Stuart Rackham\&. Many people have contributed to it\&. +.SH "RESOURCES" +.sp +SourceForge: http://sourceforge\&.net/projects/asciidoc/ +.sp +Main web site: http://www\&.methods\&.co\&.nz/asciidoc/ +.SH "COPYING" +.sp +Copyright (C) 2002\-2011 Stuart Rackham\&. Free use of this software is granted under the terms of the GNU General Public License (GPL)\&. diff --git a/source-builder/sb/asciidoc/doc/asciidoc.1.txt b/source-builder/sb/asciidoc/doc/asciidoc.1.txt new file mode 100644 index 0000000..87a86f3 --- /dev/null +++ b/source-builder/sb/asciidoc/doc/asciidoc.1.txt @@ -0,0 +1,197 @@ +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=VALUE@' (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', + 'html5', 'slidy', 'wordpress' or 'latex' (the 'latex' backend is + experimental). You can also use the backend alias names 'html' + (aliased to 'xhtml11') or 'docbook' (aliased to 'docbook45'). + Defaults to 'html'. The *--backend* option is also used to manage + backend plugins (see <>). + +*-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*='FILTER':: + Specify the name of a filter to be loaded (used to load filters + that are not auto-loaded). This option may be specified more than + once. The *--filter* option is also used to manage filter plugins + (see <>). + +*-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 + *--attribute numbered*. + +*--safe*:: + Enable safe mode. Safe mode is disabled by default. AsciiDoc + 'safe mode' skips potentially dangerous scripted sections in + AsciiDoc source files. + +*--theme*='THEME':: + Specify a theme name. Synonym for *--attribute theme*='THEME'. + The *--theme* option is also used to manage theme plugins (see + <>). + +*-v, --verbose*:: + Verbosely print processing information and configuration file + checks to stderr. + +*--version*:: + Print program version number. + + +[[X1]] +PLUGIN COMMANDS +--------------- +The asciidoc(1) *--filter*, *--backend* and *--theme* options are used +to install, remove and list AsciiDoc filter, backend and theme +plugins. Syntax: + + asciidoc OPTION install ZIP_FILE [PLUGINS_DIR] + asciidoc OPTION remove PLUGIN_NAME [PLUGINS_DIR] + asciidoc OPTION list + asciidoc OPTION build ZIP_FILE PLUGIN_SOURCE + +Where: + +*OPTION*:: + asciidoc(1) *--filter*, *--backend* or *--theme* option specifying + the type of plugin. + +*PLUGIN_NAME*:: + A unique plugin name containing only alphanumeric or underscore + characters. + +*ZIP_FILE*:: + A Zip file containing plugin resources, the name must start with the + plugin name e.g. `my_filter-1.0.zip` packages filter `my_filter`. + +*PLUGINS_DIR*:: + The directory containing installed plugins. Each plugin is contained + in its own separate subdirectory which has the same name as the + plugin. + *PLUGINS_DIR* defaults to the `$HOME/.asciidoc/filters` (for + filter plugins) or `$HOME/.asciidoc/backends` (for backend plugins) or + `$HOME/.asciidoc/themes` (for theme plugins). + +*PLUGIN_SOURCE*:: + The name of a directory containing the plugin source files or the + name of a single source file. + +The plugin commands perform as follows: + +*install*:: + Create a subdirectory in *PLUGINS_DIR* with the same name as the + plugin then extract the *ZIP_FILE* into it. + +*remove*:: + Delete the *PLUGIN_NAME* plugin subdirectory and all its contents + from the *PLUGINS_DIR*. + +*list*:: + List the names and locations of all installed filter or theme + plugins (including standard plugins installed in the global + configuration directory). + +*build*:: + Create a plugin file named *ZIP_FILE* containing the files and + subdirectories specified by *PLUGIN_SOURCE*. File and directory + names starting with a period are skipped. + + +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: + +Main web site: + + +COPYING +------- +Copyright \(C) 2002-2011 Stuart Rackham. Free use of this software is +granted under the terms of the GNU General Public License (GPL). + diff --git a/source-builder/sb/asciidoc/doc/asciidoc.conf b/source-builder/sb/asciidoc/doc/asciidoc.conf new file mode 100644 index 0000000..e073341 --- /dev/null +++ b/source-builder/sb/asciidoc/doc/asciidoc.conf @@ -0,0 +1,7 @@ +# +# Customization for AsciiDoc documentation. +# +[specialwords] +ifndef::doctype-manpage[] +monospacedwords=(?u)\\?\basciidoc\(1\) (?u)\\?\ba2x\(1\) +endif::doctype-manpage[] diff --git a/source-builder/sb/asciidoc/doc/asciidoc.dict b/source-builder/sb/asciidoc/doc/asciidoc.dict new file mode 100644 index 0000000..2abb0f5 --- /dev/null +++ b/source-builder/sb/asciidoc/doc/asciidoc.dict @@ -0,0 +1,1085 @@ +personal_ws-1.1 en 1084 +mandoc +colspecs +API +testcases +BSBEV +dblatex +dapibus +mycss +attributelist +AttributeList +Blondel +permalink +Chunking +unescapes +frontmatter +libxslt +asc +XSLT +stdin +convallis +AttributeEntrys +Steen +BOTTM +CACTU +IndentedBlock +passtext +ZapfDingbats +CALS +LiteralParagraph +del +BOM +Bon +ungenerated +zipP +des +cmd +ListItems +dev +vulputate +Odio +doctest +comspecs +MacDermid +amet +Oleksandr +ExampleBlock +faf +luptatum +dir +Lorum +superceded +inlinegraphic +specialcharacters +cpp +RevisionLine +TitleName +Fusce +ralink +scaledwidth +FooParser +VMiklos +Trotman +DelimitedBlocks +css +preconfigured +Magnocavallo +csv +Mandelson +GCC +CSW +Potapov +nisl +Gao +nullam +LibreOffice +Moolenaar +Habitasse +mimetypes +dtb +doctime +CVS +DTD +Gbs +graphviz +toclevel +plaintext +hyperlinks +dui +dsv +ENV +dvi +stderr +SimpleSection +gif +eBook +prepend +RevisionNumber +CommentBlocks +consequat +fmt +Amade +inline +monospacedwords +informaltable +realpath +validator +colwidth +hhc +Chai +strongwords +setlocal +ListingBlock +listingblock +formalpara +Posuere +exe +AuthorInfo +hhk +vsides +rewriteSystem +taoup +paracounter +hhp +listelement +AttributeLists +magna +xreflabel +PDF's +PDFs +pygmentize +MSIE +pede +permalinks +Boscombe +Daly +arcu +GPL +codec +MSHR +listcontinuation +ListContinuation +apos +ShareSource +epubtest +projectname +hoc +ispum +Maier +args +TableFooter +LiberationSerif +blog +passthroughs +gui +ile +sgmlfmt +formulae +dbkview +AsciiDoc's +BackendBlock +tbody +DSSSL +jim +valign +ldquo +Makefile +munere +Raggett's +citetitle +Lai +guimenuitem +IRC +plugin +starttags +tgroup +Miklos +porttitor +Maecenas +systemIdStartString +footnoteref +joe +velit +truecolor +pre +pere +purus +iso +ItemLabel +jpg +adipiscing +filetype +listnumber +SourceForge +groff +McCurry +mansource +JRE +verear +Lex +mea +jqs +PassthroughBlocks +blockdef +JavaScript +javascript +nam +OEBPS +symlinks +confdir +optionname +sollicitudin +companyname +pageunits +nec +loc +latexmath +articleinfo +auctor +refname +mim +Paillotin +Farhat +uninstall +localdate +ncx +ListEntry +textwidth +ItemTerm +backquotes +ImageMagick +subscripted +lpr +autoplay +Delikatessen +mydocument +odf +brvbar +tabletags +morerows +ListItem +coids +nocontrols +shiftwidth +nulla +endDocument +odt +Cygwin +ogg +ultrices +indentedparagraph +IndentedParagraph +ltr +doctests +AsciiDocAPI +asciidocapi +itemtag +Dvips +Jython +tincidunt +Solaris +pdf +ogv +authorgroup +manpages +ItemText +dignissim +cdata +autoconf +ANDed +devnull +autocmd +readlines +pageunit +coid +noborders +facto +ListParagraphs +nunc +opf +orci +CustomBlocks +refentryinfo +informalfigure +ORed +pygments +yyyy +online +LIBDIR +docinfo +BlockId +png +lobortis +Broberg +Bowlin +navPoint +asciimathml +AsciiMathML +ASCIIMathML +conf +RCS +lowriter +UnicodeDecodeError +CalloutList +SidebarBlocks +idprefix +TableRow +stdout +monospaced +walsh +pre +facilisis +tzname +ListParagraph +partintro +Windtrainer +hgignore +eget +sed +userguide +cras +zwsp +keeptogether +bweb +PRS +Sturmer +sem +BufNewFile +SEO +mdash +filename +psv +inlinemacro +bgcolor +Lavruschenko +pts +Buenos +myslidy +feugiat +colend +sprintf +pyc +EPUBs +Zullinger +AuthorLine +specialsections +subsverbatim +adolescens +qui +htmltoc +SJR +noautoload +biggy +pgwide +RevisionDate +crlf +tex +Blido +Bolido +tabsize +colpcwidth +Orry +Nascetur +onload +RTF +Suraj +quickstart +fillchar +bloggs +tis +listdef +Tsawassen +Aenean +postsubs +src +LastName +lastname +OpenBlocks +toc +tmp +Knisley +massa +vel +colstart +volutpat +stringparam +showcomments +SVN +Tps +vih +prepended +ttf +resx +startup +admonitionblock +coord +Blackdown +mainmatter +Slackware +tableabswidth +BackendBlocks +VMiklos's +sys +doctype +retrive +Pavlovitch +uri +wnone +xhtml +url +utf +footrow +usr +conubia +Hausmann +TitleBlock +txt +lsquo +addEventListener +elit +Efros's +sectiontitle +CommentLines +subprocess +outfile +blandit +revisionhistory +EPUBReader +Xin +params +undefines +Andrs +yellowback +Quisque +Fabrice +htmlhelp +HTMLHelp +cellspacing +Citeaux +themedir +srackham +Lulea +Lule +Ubuntu +xml +XSLTLib +headrow +enim +haad +staticfree +Morbi +Blauer +footdata +al +bg +cb +cd +xsl +backmatter +ar +fils +linenumbering +de +backend's +backends +eb +br +Gutenburg +cp +fb +fermentum +fi +cellcount +et +fo +eu +hg +guimenu +fugiat +toclevels +xzf +gq +JB +refactored +sgml +backcolor +AsciiDoc +asciidoc +subslist +hs +hu +testblock +Vijay +xyz +simpara +lf +defacto +resized +mb +IndentedBlocks +md +js +erat +blogpost +xsltproc +jw +ln +nd +ne +oa +Terje +lt +Helvetica +endtags +thead +ly +mv +stylesheets +roff +YYY +regex +os +config +slidy +tabstop +indentsize +sb +ps +runtime +tcqn +ePub +epub +px +td +vivamus +py +Helleu +getElementById +addon +th +sp +ru +docname +ifeval +su +uk +expandtab +autolabel +LinuxDoc +linuxdoc +tt +Hackett +VM +Frdrique +SidebarBlock +wj +ut +Efros +param +Movet +hcol +manpurpose +ebooks +eBooks +colalign +debian +Iaculis +quis +eval's +stylename +tooltip +fpdf +Tiago +BLAUS +endtag +glossdiv +Lebihan +ListTerms +colsep +indir +Hajage +sherlock +texttag +ctags +RPMs +arabic +dolorum +posttype +eval +termtag +passthrough +BlockTitle +blocktitle +blocktitles +BlockTitles +Iisaka +tfoot +Iisaka's +misevaluations +frac +pagewidth +AUTOEXEC +rowcount +ExampleBlocks +linux +commodo +Fernandes +pretium +notitle +manvolnum +homero +validators +listindex +testasciidoc +imagedata +HotSpot +vimrc +O'Reilly +literallayout +doctitle +holmes +Dmitry +backtick +Bouchers +strikethrough +indexterm +Daitx +vestibulum +quote's +noteblock +refentry +Xubuntu +captionless +orgname +OpenOffice +asciidocEmphasized +Dostoyevsky +chapt +necessitatibus +unformatted +revremark +Thiago +listtag +HTMLParser +docdir +Gogh +Jipsen +JimiProClasses +sgmlformat +LilyPond +CommentBlock +xmllint +tuples +headdata +infty +presubs +Tascii +MathML +nobis +LOCALCLASSPATH +Cheatsheet +mktemp +Xandros +rdquo +Yakshin's +revhistory +colnumber +MEPIS +bibendum +Melis's +expr +tempfile +ponderum +outfilesuffix +libxml +tablepcwidth +chunked +filesystem +Martn +popen +iconsdir +toolchains +listchars +fileext +emphasizedwords +smallnew +linkcss +colspan +localtime +Ruderich +noincsearch +Stas +colspec +GPLv +uriStartString +Hongli +infile +suspendisse +TOCs +todo +mimetype +ridiculus +volnitsky +setlevel +Rosenkraenzer +bodydata +java +Sakellariou +postulant +Vasilev +barchart +Calixto +sudo +coverpage +starttag +whitespace +DelimitedBlock +foofoo +retab +xmlns +changelog +ChangeLog +symlink +ascii +ListLabel +Kleber +Klber +popup +Cerrito +DocBook's +fprintf +mediaobject +gizmo +outdir +getvalue +callouts +mollis +autowidth +karamazov +labitur +xmlto +Fyodor +HMTL +CentOS +Skype +POSIX +builtins +ByteInterleavedRaster +blockname +bulleted +Google +globals +Garnett +porta +OpenBlock +colabswidth +bibliodiv +Bushuev +Inguaggiato +SectionClose +overline +paradef +QuoteBlocks +undefine +docdate +Kurapati +Zolochevskiy +lacus +felis +backend +webm +ListBlock +literalblock +LiteralBlock +href +metus +Mozilla +unstyled +pagebreak +VariableList +LiteralBlocks +Donec +BLONP +dbook +asciimath +interesset +pellentesque +formatlistpat +IMGs +AttributeEntry +attributeentry +Zuckschwerdt +autoindent +sectids +manname +PostScript +jbloggs +epubcheck +README +colstop +LiteralParagraphs +tableblock +slideshows +primis +tuple +Rackham +admonitionparagraph +mantitle +init +VerbatimBlocks +imperdiet +refsynopsisdiv +emacs +consetetur +JIMI +newtables +docbook +DocBook +callout +fileextension +programlisting +outlang +QuoteBlock +chmod +posattrs +subdirectories +RevisionRemark +TableHeader +slideshow +Mihai +KeyboardInterrupt +justo +hexdump +SectionBody +sectionbody +nnoremap +verbatimblock +VerbatimBlock +BulletedList +html +unchunked +Gouichi +Alexey +StringIO +wordpress +nonet +tagname +gzip +corpname +precompiled +rewriteURI +colcount +fringilla +Gentoo +mattis +printf +hsides +imagesdir +callto +URIs +lang +basebackend +urna +rowsep +checksums +BlockMacro +blockmacro +mailto +Sagittis +plugins +http +pychart +fepub +Wiki +euismod +arounds +WINA +superscripted +PassthroughBlock +footrows +configfile +misspelt +namespace +reftext +formatoptions +halign +rsquo +AROUT +Wiese +bodyrow +navMap +listtags +mauris +Dourmousoglou +Wiers +ListingBlocks +TableUnderline +bookinfo +Vajna +upperalpha +xmldecl +tellus +EmailAddress +qanda +hyperlink +screenshot +noout +Wieers +Artem +startDocument +ifdef +Shanahan's +manmanual +Konqueror +FirstName +firstname +LaTeXMathML +latexmathml +sectnum +BlockMacros +cceeff +unfloat +snabbkp +snabbkop +NumberedList +everti +multi +cubilia +manpage +conformant +AttributeEntries +tablewidth +LabeledList +monospace +AsciiDocError +olink +softtabstop +Ghostscript +https +dbtimestamp +ebuild +rewritePrefix +BOLID +PUBReader +inlinemediaobject +nochunks +newlists +mediaobjects +endif +natively +mkdir +sodales +BONAP +ItemContinuation +tyger +upperroman +RevisionInfo +Berglunds +egestas +nabc +autoloaded +symlinked +Sommer +Klum +Obenhuber's +revdate +stylesheet +eleifend +ListTerm +augue +loweralpha +subdirectory +consectetuer +bookmarked +Gmez +Kubuntu +LaTeX +litora +FreeBSD +Araquil +setuptools +bfoobar +lacinia +entrytag +muellner +ifndef +latin +Woodall +revnumber +labeltag +toolchain +cellpadding +entrytbl +Ornare +authorinitials +javascripts +JavaScripts +undefining +viewport +leveloffset +CustomBlock +Krmer +BufRead +specialwords +libexslt +subsnormal +fxhtml +Builtin +hardcoded +Mery +utils +subclassify +stylesdir +unsets +ipsum +namespaced +FilterBlocks +Julien +tempor +WINNT +boolean +TableData +pagefile +docfile +libboost +Praesent +else's +preparadas +scriptsdir +syntaxes +Rsten +rowspan +headrows +charset +burtoogle +Changjian +Ashworth +nbsp +lowerroman +FOPException +Freshmeat +dbhtml +manversion +TableBody +Loc +abc +aliquam +llevar +aap +unspaced +attrlist +Bazon +attrname +Forsterstr +Rhoncus +Rutrum +Redhat +datadir +Kumar +IndentedParagraphs +Berguvsvagen +Berguvsvgen +executables +tabledef +ftdetect +Greaves +SimpleList +superscripting +baz +lorem +Comidas +bodyrows +Fyodorovitch +topbot +greek +comspec +refmiscinfo +firefox +lectus +JavaHelp +unescaped +mydoc +middlename +MiddleName +Jimmac's diff --git a/source-builder/sb/asciidoc/doc/asciidoc.txt b/source-builder/sb/asciidoc/doc/asciidoc.txt new file mode 100644 index 0000000..b7a98f0 --- /dev/null +++ b/source-builder/sb/asciidoc/doc/asciidoc.txt @@ -0,0 +1,6038 @@ +AsciiDoc User Guide +=================== +Stuart Rackham +:Author Initials: SJR +:toc: +:icons: +:numbered: +:website: http://www.methods.co.nz/asciidoc/ + +AsciiDoc is a text document format for writing notes, documentation, +articles, books, ebooks, slideshows, web pages, blogs and UNIX man +pages. AsciiDoc files can be translated to many formats including +HTML, PDF, EPUB, man page. 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. + +.This document +********************************************************************** +This is an overly large document, it probably needs to be refactored +into a Tutorial, Quick Reference and Formal Reference. + +If you're new to AsciiDoc read this section and the <> section and take a look at the example AsciiDoc (`*.txt`) +source files in the distribution `doc` directory. +********************************************************************** + + +Introduction +------------ +AsciiDoc is a plain text human readable/writable document format that +can be translated to DocBook or HTML using the asciidoc(1) command. +You can then either use asciidoc(1) generated HTML directly or run +asciidoc(1) DocBook output through your favorite DocBook toolchain or +use the AsciiDoc a2x(1) toolchain wrapper to produce PDF, EPUB, DVI, +LaTeX, PostScript, man page, HTML and text formats. + +The AsciiDoc format is a useful presentation format in its own right: +AsciiDoc markup is simple, intuitive and as such is easily proofed and +edited. + +AsciiDoc is light weight: it consists of a single Python script and a +bunch of configuration files. Apart from asciidoc(1) and a Python +interpreter, no other programs are required to convert AsciiDoc text +files to DocBook or HTML. See <> +below. + +Text markup conventions tend to be a matter of (often strong) personal +preference: if the default syntax is not to your liking you can define +your own by editing the text based asciidoc(1) configuration files. +You can also create configuration files to translate AsciiDoc +documents to almost any SGML/XML markup. + +asciidoc(1) comes with a set of configuration files to translate +AsciiDoc articles, books and man pages to HTML or DocBook backend +formats. + +.My AsciiDoc Itch +********************************************************************** +DocBook has emerged as the de facto standard Open Source documentation +format. But DocBook is a complex language, the markup is difficult to +read and even more difficult to write directly -- I found I was +spending more time typing markup tags, consulting reference manuals +and fixing syntax errors, than I was writing the documentation. +********************************************************************** + + +[[X6]] +Getting Started +--------------- +Installing AsciiDoc +~~~~~~~~~~~~~~~~~~~ +See the `README` and `INSTALL` files for install prerequisites and +procedures. Packagers take a look at <>. + +[[X11]] +Example AsciiDoc Documents +~~~~~~~~~~~~~~~~~~~~~~~~~~ +The best way to quickly get a feel for AsciiDoc is to view the +AsciiDoc web site and/or distributed examples: + +- Take a look at the linked examples on the AsciiDoc web site home + page {website}. Press the 'Page Source' sidebar menu item to view + corresponding AsciiDoc source. +- Read the `*.txt` source files in the distribution `./doc` directory + along with the corresponding HTML and DocBook XML files. + + +AsciiDoc Document Types +----------------------- +There are three types of AsciiDoc documents: article, book and +manpage. All document types share the same AsciiDoc format with some +minor variations. If you are familiar with DocBook you will have +noticed that AsciiDoc document types correspond to the same-named +DocBook document types. + +Use the asciidoc(1) `-d` (`--doctype`) option to specify the AsciiDoc +document type -- the default document type is 'article'. + +By convention the `.txt` file extension is used for AsciiDoc document +source files. + +article +~~~~~~~ +Used for short documents, articles and general documentation. See the +AsciiDoc distribution `./doc/article.txt` example. + +AsciiDoc defines standard DocBook article frontmatter and backmatter +<> (appendix, abstract, bibliography, +glossary, index). + +book +~~~~ +Books share the same format as articles, with the following +differences: + +- The part titles in multi-part books are <> + (same level as book title). +- Some sections are book specific e.g. preface and colophon. + +Book documents will normally be used to produce DocBook output since +DocBook processors can automatically generate footnotes, table of +contents, list of tables, list of figures, list of examples and +indexes. + +AsciiDoc defines standard DocBook book frontmatter and backmatter +<> (appendix, dedication, preface, +bibliography, glossary, index, colophon). + +.Example book documents +Book:: + The `./doc/book.txt` file in the AsciiDoc distribution. + +Multi-part book:: + The `./doc/book-multi.txt` file in the AsciiDoc distribution. + +manpage +~~~~~~~ +Used to generate roff format UNIX manual pages. AsciiDoc manpage +documents observe special header title and section naming conventions +-- see the <> section for details. + +AsciiDoc defines the 'synopsis' <> to +generate the DocBook `refsynopsisdiv` section. + +See also the asciidoc(1) man page source (`./doc/asciidoc.1.txt`) from +the AsciiDoc distribution. + + +[[X5]] +AsciiDoc Backends +----------------- +The asciidoc(1) command translates an AsciiDoc formatted file to the +backend format specified by the `-b` (`--backend`) command-line +option. asciidoc(1) itself has little intrinsic knowledge of backend +formats, all translation rules are contained in customizable cascading +configuration files. Backend specific attributes are listed in the +<> section. + +docbook45:: + Outputs DocBook XML 4.5 markup. + +html4:: + This backend generates plain HTML 4.01 Transitional markup. + +xhtml11:: + This backend generates XHTML 1.1 markup styled with CSS2. Output + files have an `.html` extension. + +html5:: + This backend generates HTML 5 markup, apart from the inclusion of + <> it is functionally identical to + the 'xhtml11' backend. + +slidy:: + Use this backend to generate self-contained + http://www.w3.org/Talks/Tools/Slidy2/[Slidy] HTML slideshows for + your web browser from AsciiDoc documents. The Slidy backend is + documented in the distribution `doc/slidy.txt` file and + {website}slidy.html[online]. + +wordpress:: + A minor variant of the 'html4' backend to support + http://srackham.wordpress.com/blogpost1/[blogpost]. + +latex:: + Experimental LaTeX backend. + +Backend Aliases +~~~~~~~~~~~~~~~ +Backend aliases are alternative names for AsciiDoc backends. AsciiDoc +comes with two backend aliases: 'html' (aliased to 'xhtml11') and +'docbook' (aliased to 'docbook45'). + +You can assign (or reassign) backend aliases by setting an AsciiDoc +attribute named like `backend-alias-` to an AsciiDoc backend +name. For example, the following backend alias attribute definitions +appear in the `[attributes]` section of the global `asciidoc.conf` +configuration file: + + backend-alias-html=xhtml11 + backend-alias-docbook=docbook45 + +[[X100]] +Backend Plugins +~~~~~~~~~~~~~~~ +The asciidoc(1) `--backend` option is also used to install and manage +backend <>. + +- A backend plugin is used just like the built-in backends. +- Backend plugins <> over built-in backends with + the same name. +- You can use the `{asciidoc-confdir}` <> to + refer to the built-in backend configuration file location from + backend plugin configuration files. +- You can use the `{backend-confdir}` <> to + refer to the backend plugin configuration file location. +- By default backends plugins are installed in + `$HOME/.asciidoc/backends/` where `` is the + backend name. + + +DocBook +------- +AsciiDoc generates 'article', 'book' and 'refentry' +http://www.docbook.org/[DocBook] documents (corresponding to the +AsciiDoc 'article', 'book' and 'manpage' document types). + +Most Linux distributions come with conversion tools (collectively +called a toolchain) for <> to +presentation formats such as Postscript, HTML, PDF, EPUB, DVI, +PostScript, LaTeX, roff (the native man page format), HTMLHelp, +JavaHelp and text. There are also programs that allow you to view +DocBook files directly, for example http://live.gnome.org/Yelp[Yelp] +(the GNOME help viewer). + +[[X12]] +Converting DocBook to other file formats +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +DocBook files are validated, parsed and translated various +presentation file formats using a combination of applications +collectively called a DocBook 'tool chain'. The function of a tool +chain is to read the DocBook markup (produced by AsciiDoc) and +transform it to a presentation format (for example HTML, PDF, HTML +Help, EPUB, DVI, PostScript, LaTeX). + +A wide range of user output format requirements coupled with a choice +of available tools and stylesheets results in many valid tool chain +combinations. + +[[X43]] +a2x Toolchain Wrapper +~~~~~~~~~~~~~~~~~~~~~ +One of the biggest hurdles for new users is installing, configuring +and using a DocBook XML toolchain. `a2x(1)` can help -- it's a +toolchain wrapper command that will generate XHTML (chunked and +unchunked), PDF, EPUB, DVI, PS, LaTeX, man page, HTML Help and text +file outputs from an AsciiDoc text file. `a2x(1)` does all the grunt +work associated with generating and sequencing the toolchain commands +and managing intermediate and output files. `a2x(1)` also optionally +deploys admonition and navigation icons and a CSS stylesheet. See the +`a2x(1)` man page for more details. In addition to `asciidoc(1)` you +also need <>, <> and +optionally: <> or <> (to generate PDF); +`w3m(1)` or `lynx(1)` (to generate text). + +The following examples generate `doc/source-highlight-filter.pdf` from +the AsciiDoc `doc/source-highlight-filter.txt` source file. The first +example uses `dblatex(1)` (the default PDF generator) the second +example forces FOP to be used: + + $ a2x -f pdf doc/source-highlight-filter.txt + $ a2x -f pdf --fop doc/source-highlight-filter.txt + +See the `a2x(1)` man page for details. + +TIP: Use the `--verbose` command-line option to view executed +toolchain commands. + +HTML generation +~~~~~~~~~~~~~~~ +AsciiDoc produces nicely styled HTML directly without requiring a +DocBook toolchain but there are also advantages in going the DocBook +route: + +- HTML from DocBook can optionally include automatically generated + indexes, tables of contents, footnotes, lists of figures and tables. +- DocBook toolchains can also (optionally) generate separate (chunked) + linked HTML pages for each document section. +- Toolchain processing performs link and document validity checks. +- If the DocBook 'lang' attribute is set then things like table of + contents, figure and table captions and admonition captions will be + output in the specified language (setting the AsciiDoc 'lang' + attribute sets the DocBook 'lang' attribute). + +On the other hand, HTML output directly from AsciiDoc is much faster, +is easily customized and can be used in situations where there is no +suitable DocBook toolchain (for example, see the {website}[AsciiDoc +website]). + +PDF generation +~~~~~~~~~~~~~~ +There are two commonly used tools to generate PDFs from DocBook, +<> and <>. + +.dblatex or FOP? +- 'dblatex' is easier to install, there's zero configuration + required and no Java VM to install -- it just works out of the box. +- 'dblatex' source code highlighting and numbering is superb. +- 'dblatex' is easier to use as it converts DocBook directly to PDF + whereas before using 'FOP' you have to convert DocBook to XML-FO + using <>. +- 'FOP' is more feature complete (for example, callouts are processed + inside literal layouts) and arguably produces nicer looking output. + +HTML Help generation +~~~~~~~~~~~~~~~~~~~~ +. Convert DocBook XML documents to HTML Help compiler source files + using <> and <>. +. Convert the HTML Help source (`.hhp` and `.html`) files to HTML Help + (`.chm`) files using the <>. + +Toolchain components summary +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +AsciiDoc:: + Converts AsciiDoc (`.txt`) files to DocBook XML (`.xml`) files. + +[[X13]]http://docbook.sourceforge.net/projects/xsl/[DocBook XSL Stylesheets]:: + These are a set of XSL stylesheets containing rules for converting + DocBook XML documents to HTML, XSL-FO, manpage and HTML Help files. + The stylesheets are used in conjunction with an XML parser such as + <>. + +[[X40]]http://www.xmlsoft.org[xsltproc]:: + An XML parser for applying XSLT stylesheets (in our case the + <>) to XML documents. + +[[X31]]http://dblatex.sourceforge.net/[dblatex]:: + Generates PDF, DVI, PostScript and LaTeX formats directly from + DocBook source via the intermediate LaTeX typesetting language -- + uses <>, <> and + `latex(1)`. + +[[X14]]http://xml.apache.org/fop/[FOP]:: + The Apache Formatting Objects Processor converts XSL-FO (`.fo`) + files to PDF files. The XSL-FO files are generated from DocBook + source files using <> and + <>. + +[[X67]]Microsoft Help Compiler:: + The Microsoft HTML Help Compiler (`hhc.exe`) is a command-line tool + that converts HTML Help source files to a single HTML Help (`.chm`) + file. It runs on MS Windows platforms and can be downloaded from + http://www.microsoft.com. + +AsciiDoc dblatex configuration files +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The AsciiDoc distribution `./dblatex` directory contains +`asciidoc-dblatex.xsl` (customized XSL parameter settings) and +`asciidoc-dblatex.sty` (customized LaTeX settings). These are examples +of optional <> output customization and are used by +<>. + +AsciiDoc DocBook XSL Stylesheets drivers +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +You will have noticed that the distributed HTML and HTML Help +documentation files (for example `./doc/asciidoc.html`) are not the +plain outputs produced using the default 'DocBook XSL Stylesheets' +configuration. This is because they have been processed using +customized DocBook XSL Stylesheets along with (in the case of HTML +outputs) the custom `./stylesheets/docbook-xsl.css` CSS stylesheet. + +You'll find the customized DocBook XSL drivers along with additional +documentation in the distribution `./docbook-xsl` directory. The +examples that follow are executed from the distribution documentation +(`./doc`) directory. These drivers are also used by <>. + +`common.xsl`:: + Shared driver parameters. This file is not used directly but is + included in all the following drivers. + +`chunked.xsl`:: + Generate chunked XHTML (separate HTML pages for each document + section) in the `./doc/chunked` directory. For example: + + $ python ../asciidoc.py -b docbook asciidoc.txt + $ xsltproc --nonet ../docbook-xsl/chunked.xsl asciidoc.xml + +`epub.xsl`:: + Used by <> to generate EPUB formatted documents. + +`fo.xsl`:: + Generate XSL Formatting Object (`.fo`) files for subsequent PDF + file generation using FOP. For example: + + $ python ../asciidoc.py -b docbook article.txt + $ xsltproc --nonet ../docbook-xsl/fo.xsl article.xml > article.fo + $ fop article.fo article.pdf + +`htmlhelp.xsl`:: + Generate Microsoft HTML Help source files for the MS HTML Help + Compiler in the `./doc/htmlhelp` directory. This example is run on + MS Windows from a Cygwin shell prompt: + + $ python ../asciidoc.py -b docbook asciidoc.txt + $ xsltproc --nonet ../docbook-xsl/htmlhelp.xsl asciidoc.xml + $ c:/Program\ Files/HTML\ Help\ Workshop/hhc.exe htmlhelp.hhp + +`manpage.xsl`:: + Generate a `roff(1)` format UNIX man page from a DocBook XML + 'refentry' document. This example generates an `asciidoc.1` man + page file: + + $ python ../asciidoc.py -d manpage -b docbook asciidoc.1.txt + $ xsltproc --nonet ../docbook-xsl/manpage.xsl asciidoc.1.xml + +`xhtml.xsl`:: + Convert a DocBook XML file to a single XHTML file. For example: + + $ python ../asciidoc.py -b docbook asciidoc.txt + $ xsltproc --nonet ../docbook-xsl/xhtml.xsl asciidoc.xml > asciidoc.html + +If you want to see how the complete documentation set is processed +take a look at the A-A-P script `./doc/main.aap`. + + +Generating Plain Text Files +--------------------------- +AsciiDoc does not have a text backend (for most purposes AsciiDoc +source text is fine), however you can convert AsciiDoc text files to +formatted text using the AsciiDoc <> toolchain wrapper +utility. + + +[[X35]] +HTML5 and XHTML 1.1 +------------------- +The 'xhtml11' and 'html5' backends embed or link CSS and JavaScript +files in their outputs, there is also a <> plugin +framework. + +- If the AsciiDoc 'linkcss' attribute is defined then CSS and + JavaScript files are linked to the output document, otherwise they + are embedded (the default behavior). +- The default locations for CSS and JavaScript files can be changed by + setting the AsciiDoc 'stylesdir' and 'scriptsdir' attributes + respectively. +- The default locations for embedded and linked files differ and are + calculated at different times -- embedded files are loaded when + asciidoc(1) generates the output document, linked files are loaded + by the browser when the user views the output document. +- Embedded files are automatically inserted in the output files but + you need to manually copy linked CSS and Javascript files from + AsciiDoc <> to the correct location + relative to the output document. + +.Stylesheet file locations +[cols="3*",frame="topbot",options="header"] +|==================================================================== +|'stylesdir' attribute +|Linked location ('linkcss' attribute defined) +|Embedded location ('linkcss' attribute undefined) + +|Undefined (default). +|Same directory as the output document. +|`stylesheets` subdirectory in the AsciiDoc configuration directory +(the directory containing the backend conf file). + +|Absolute or relative directory name. +|Absolute or relative to the output document. +|Absolute or relative to the AsciiDoc configuration directory (the +directory containing the backend conf file). + +|==================================================================== + +.JavaScript file locations +[cols="3*",frame="topbot",options="header"] +|==================================================================== +|'scriptsdir' attribute +|Linked location ('linkcss' attribute defined) +|Embedded location ('linkcss' attribute undefined) + +|Undefined (default). +|Same directory as the output document. +|`javascripts` subdirectory in the AsciiDoc configuration directory +(the directory containing the backend conf file). + +|Absolute or relative directory name. +|Absolute or relative to the output document. +|Absolute or relative to the AsciiDoc configuration directory (the +directory containing the backend conf file). + +|==================================================================== + +[[X99]] +Themes +~~~~~~ +The AsciiDoc 'theme' attribute is used to select an alternative CSS +stylesheet and to optionally include additional JavaScript code. + +- Theme files reside in an AsciiDoc <> + named `themes//` (where `` is the the theme name set + by the 'theme' attribute). asciidoc(1) sets the 'themedir' attribute + to the theme directory path name. +- The 'theme' attribute can also be set using the asciidoc(1) + `--theme` option, the `--theme` option can also be used to manage + theme <>. +- AsciiDoc ships with two themes: 'flask' and 'volnitsky'. +- The `.css` file replaces the default `asciidoc.css` CSS file. +- The `.js` file is included in addition to the default + `asciidoc.js` JavaScript file. +- If the <> attribute is defined then icons are loaded + from the theme `icons` sub-directory if it exists (i.e. the + 'iconsdir' attribute is set to theme `icons` sub-directory path). +- Embedded theme files are automatically inserted in the output files + but you need to manually copy linked CSS and Javascript files to the + location of the output documents. +- Linked CSS and JavaScript theme files are linked to the same linked + locations as <>. + +For example, the command-line option `--theme foo` (or `--attribute +theme=foo`) will cause asciidoc(1) to search <<"X27","configuration +file locations 1, 2 and 3">> for a sub-directory called `themes/foo` +containing the stylesheet `foo.css` and optionally a JavaScript file +name `foo.js`. + + +Document Structure +------------------ +An AsciiDoc document consists of a series of <> +starting with an optional document Header, followed by an optional +Preamble, followed by zero or more document Sections. + +Almost any combination of zero or more elements constitutes a valid +AsciiDoc document: documents can range from a single sentence to a +multi-part book. + +Block Elements +~~~~~~~~~~~~~~ +Block elements consist of one or more lines of text and may contain +other block elements. + +The AsciiDoc block structure can be informally summarized as follows +footnote:[This is a rough structural guide, not a rigorous syntax +definition]: + + Document ::= (Header?,Preamble?,Section*) + Header ::= (Title,(AuthorInfo,RevisionInfo?)?) + AuthorInfo ::= (FirstName,(MiddleName?,LastName)?,EmailAddress?) + RevisionInfo ::= (RevisionNumber?,RevisionDate,RevisionRemark?) + Preamble ::= (SectionBody) + Section ::= (Title,SectionBody?,(Section)*) + SectionBody ::= ((BlockTitle?,Block)|BlockMacro)+ + Block ::= (Paragraph|DelimitedBlock|List|Table) + List ::= (BulletedList|NumberedList|LabeledList|CalloutList) + BulletedList ::= (ListItem)+ + NumberedList ::= (ListItem)+ + CalloutList ::= (ListItem)+ + LabeledList ::= (ListEntry)+ + ListEntry ::= (ListLabel,ListItem) + ListLabel ::= (ListTerm+) + ListItem ::= (ItemText,(List|ListParagraph|ListContinuation)*) + +Where: + +- '?' implies zero or one occurrence, '+' implies one or more + occurrences, '*' implies zero or more occurrences. +- All block elements are separated by line boundaries. +- `BlockId`, `AttributeEntry` and `AttributeList` block elements (not + shown) can occur almost anywhere. +- There are a number of document type and backend specific + restrictions imposed on the block syntax. +- The following elements cannot contain blank lines: Header, Title, + Paragraph, ItemText. +- A ListParagraph is a Paragraph with its 'listelement' option set. +- A ListContinuation is a <>. + +[[X95]] +Header +~~~~~~ +The Header contains document meta-data, typically title plus optional +authorship and revision information: + +- The Header is optional, but if it is used it must start with a + document <>. +- Optional Author and Revision information immediately follows the + header title. +- The document header must be separated from the remainder of the + document by one or more blank lines and cannot contain blank lines. +- The header can include comments. +- The header can include <>, typically + 'doctype', 'lang', 'encoding', 'icons', 'data-uri', 'toc', + 'numbered'. +- Header attributes are overridden by command-line attributes. +- If the header contains non-UTF-8 characters then the 'encoding' must + precede the header (either in the document or on the command-line). + +Here's an example AsciiDoc document header: + + Writing Documentation using AsciiDoc + ==================================== + Joe Bloggs + v2.0, February 2003: + Rewritten for version 2 release. + +The author information line contains the author's name optionally +followed by the author's email address. The author's name is formatted +like: + + firstname[ [middlename ]lastname][ ]] + +i.e. a first name followed by optional middle and last names followed +by an email address in that order. Multi-word first, middle and last +names can be entered using the underscore as a word separator. The +email address comes last and must be enclosed in angle <> brackets. +Here a some examples of author information lines: + + Joe Bloggs + Joe Bloggs + Vincent Willem van_Gogh + +If the author line does not match the above specification then the +entire author line is treated as the first name. + +The optional revision information line follows the author information +line. The revision information can be one of two formats: + +. An optional document revision number followed by an optional + revision date followed by an optional revision remark: ++ +-- + * If the revision number is specified it must be followed by a + comma. + * The revision number must contain at least one numeric character. + * Any non-numeric characters preceding the first numeric character + will be dropped. + * If a revision remark is specified it must be preceded by a colon. + The revision remark extends from the colon up to the next blank + line, attribute entry or comment and is subject to normal text + substitutions. + * If a revision number or remark has been set but the revision date + has not been set then the revision date is set to the value of the + 'docdate' attribute. + +Examples: + + v2.0, February 2003 + February 2003 + v2.0, + v2.0, February 2003: Rewritten for version 2 release. + February 2003: Rewritten for version 2 release. + v2.0,: Rewritten for version 2 release. + :Rewritten for version 2 release. +-- + +. The revision information line can also be an RCS/CVS/SVN $Id$ + marker: ++ +-- + * AsciiDoc extracts the 'revnumber', 'revdate', and 'author' + attributes from the $Id$ revision marker and displays them in the + document header. + * If an $Id$ revision marker is used the header author line can be + omitted. + +Example: + + $Id: mydoc.txt,v 1.5 2009/05/17 17:58:44 jbloggs Exp $ +-- + +You can override or set header parameters by passing 'revnumber', +'revremark', 'revdate', 'email', 'author', 'authorinitials', +'firstname' and 'lastname' attributes using the asciidoc(1) `-a` +(`--attribute`) command-line option. For example: + + $ asciidoc -a revdate=2004/07/27 article.txt + +Attribute entries can also be added to the header for substitution in +the header template with <> elements. + +The 'title' element in HTML outputs is set to the AsciiDoc document +title, you can set it to a different value by including a 'title' +attribute entry in the document header. + +[[X87]] +Additional document header information +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +AsciiDoc has two mechanisms for optionally including additional +meta-data in the header of the output document: + +'docinfo' configuration file sections:: +If a <> section named 'docinfo' has been loaded +then it will be included in the document header. Typically the +'docinfo' section name will be prefixed with a '+' character so that it +is appended to (rather than replace) other 'docinfo' sections. + +'docinfo' files:: +Two docinfo files are recognized: one named `docinfo` and a second +named like the AsciiDoc source file with a `-docinfo` suffix. For +example, if the source document is called `mydoc.txt` then the +document information files would be `docinfo.xml` and +`mydoc-docinfo.xml` (for DocBook outputs) and `docinfo.html` and +`mydoc-docinfo.html` (for HTML outputs). The <> attributes control which docinfo files are included in +the output files. + +The contents docinfo templates and files is dependent on the type of +output: + +HTML:: + Valid 'head' child elements. Typically 'style' and 'script' elements + for CSS and JavaScript inclusion. + +DocBook:: + Valid 'articleinfo' or 'bookinfo' child elements. DocBook defines + numerous elements for document meta-data, for example: copyrights, + document history and authorship information. See the DocBook + `./doc/article-docinfo.xml` example that comes with the AsciiDoc + distribution. The rendering of meta-data elements (or not) is + DocBook processor dependent. + + +[[X86]] +Preamble +~~~~~~~~ +The Preamble is an optional untitled section body between the document +Header and the first Section title. + +Sections +~~~~~~~~ +In addition to the document title (level 0), AsciiDoc supports four +section levels: 1 (top) to 4 (bottom). Section levels are delimited +by section <>. Sections are translated using +configuration file <>. AsciiDoc +generates the following <> specifically for +use in section markup templates: + +level:: +The `level` attribute is the section level number, it is normally just +the <> level number (1..4). However, if the `leveloffset` +attribute is defined it will be added to the `level` attribute. The +`leveloffset` attribute is useful for <>. + +sectnum:: +The `-n` (`--section-numbers`) command-line option generates the +`sectnum` (section number) attribute. The `sectnum` attribute is used +for section numbers in HTML outputs (DocBook section numbering are +handled automatically by the DocBook toolchain commands). + +[[X93]] +Section markup templates +^^^^^^^^^^^^^^^^^^^^^^^^ +Section markup templates specify output markup and are defined in +AsciiDoc configuration files. Section markup template names are +derived as follows (in order of precedence): + +1. From the title's first positional attribute or 'template' + attribute. For example, the following three section titles are + functionally equivalent: ++ +..................................................................... +[[terms]] +[glossary] +List of Terms +------------- + +["glossary",id="terms"] +List of Terms +------------- + +[template="glossary",id="terms"] +List of Terms +------------- +..................................................................... + +2. When the title text matches a configuration file + <> entry. +3. If neither of the above the default `sect` template is used + (where `` is a number from 1 to 4). + +In addition to the normal section template names ('sect1', 'sect2', +'sect3', 'sect4') AsciiDoc has the following templates for +frontmatter, backmatter and other special sections: 'abstract', +'preface', 'colophon', 'dedication', 'glossary', 'bibliography', +'synopsis', 'appendix', 'index'. These special section templates +generate the corresponding Docbook elements; for HTML outputs they +default to the 'sect1' section template. + +Section IDs +^^^^^^^^^^^ +If no explicit section ID is specified an ID will be synthesised from +the section title. The primary purpose of this feature is to ensure +persistence of table of contents links (permalinks): the missing +section IDs are generated dynamically by the JavaScript TOC generator +*after* the page is loaded. If you link to a dynamically generated TOC +address the page will load but the browser will ignore the (as yet +ungenerated) section ID. + +The IDs are generated by the following algorithm: + +- Replace all non-alphanumeric title characters with underscores. +- Strip leading or trailing underscores. +- Convert to lowercase. +- Prepend the `idprefix` attribute (so there's no possibility of name + clashes with existing document IDs). Prepend an underscore if the + `idprefix` attribute is not defined. +- A numbered suffix (`_2`, `_3` ...) is added if a same named + auto-generated section ID exists. +- If the `ascii-ids` attribute is defined then non-ASCII characters + are replaced with ASCII equivalents. This attribute may be + deprecated in future releases and *should be avoided*, it's sole + purpose is to accommodate deficient downstream applications that + cannot process non-ASCII ID attributes. + +Example: the title 'Jim's House' would generate the ID `_jim_s_house`. + +Section ID synthesis can be disabled by undefining the `sectids` +attribute. + +[[X16]] +Special Section Titles +^^^^^^^^^^^^^^^^^^^^^^ +AsciiDoc has a mechanism for mapping predefined section titles +auto-magically to specific markup templates. For example a title +'Appendix A: Code Reference' will automatically use the 'appendix' +<>. The mappings from title to template +name are specified in `[specialsections]` sections in the Asciidoc +language configuration files (`lang-*.conf`). Section entries are +formatted like: + + =<template> + +`<title>` is a Python regular expression and `<template>` is the name +of a configuration file markup template section. If the `<title>` +matches an AsciiDoc document section title then the backend output is +marked up using the `<template>` markup template (instead of the +default `sect<level>` section template). The `{title}` attribute value +is set to the value of the matched regular expression group named +'title', if there is no 'title' group `{title}` defaults to the whole +of the AsciiDoc section title. If `<template>` is blank then any +existing entry with the same `<title>` will be deleted. + +.Special section titles vs. explicit template names +********************************************************************* +AsciiDoc has two mechanisms for specifying non-default section markup +templates: you can specify the template name explicitly (using the +'template' attribute) or indirectly (using 'special section titles'). +Specifying a <<X93,section template>> attribute explicitly is +preferred. Auto-magical 'special section titles' have the following +drawbacks: + +- They are non-obvious, you have to know the exact matching + title for each special section on a language by language basis. +- Section titles are predefined and can only be customised with a + configuration change. +- The implementation is complicated by multiple languages: every + special section title has to be defined for each language (in each + of the `lang-*.conf` files). + +Specifying special section template names explicitly does add more +noise to the source document (the 'template' attribute declaration), +but the intention is obvious and the syntax is consistent with other +AsciiDoc elements c.f. bibliographic, Q&A and glossary lists. + +Special section titles have been deprecated but are retained for +backward compatibility. + +********************************************************************* + +Inline Elements +~~~~~~~~~~~~~~~ +<<X34,Inline document elements>> are used to format text and to +perform various types of text substitution. Inline elements and inline +element syntax is defined in the asciidoc(1) configuration files. + +Here is a list of AsciiDoc inline elements in the (default) order in +which they are processed: + +Special characters:: + These character sequences escape special characters used by + the backend markup (typically `<`, `>`, and `&` characters). + See `[specialcharacters]` configuration file sections. + +Quotes:: + Elements that markup words and phrases; usually for character + formatting. See `[quotes]` configuration file sections. + +Special Words:: + Word or word phrase patterns singled out for markup without + the need for further annotation. See `[specialwords]` + configuration file sections. + +Replacements:: + Each replacement defines a word or word phrase pattern to + search for along with corresponding replacement text. See + `[replacements]` configuration file sections. + +Attribute references:: + Document attribute names enclosed in braces are replaced by + the corresponding attribute value. + +Inline Macros:: + Inline macros are replaced by the contents of parametrized + configuration file sections. + + +Document Processing +------------------- +The AsciiDoc source document is read and processed as follows: + +1. The document 'Header' is parsed, header parameter values are + substituted into the configuration file `[header]` template section + which is then written to the output file. +2. Each document 'Section' is processed and its constituent elements + translated to the output file. +3. The configuration file `[footer]` template section is substituted + and written to the output file. + +When a block element is encountered asciidoc(1) determines the type of +block by checking in the following order (first to last): (section) +Titles, BlockMacros, Lists, DelimitedBlocks, Tables, AttributeEntrys, +AttributeLists, BlockTitles, Paragraphs. + +The default paragraph definition `[paradef-default]` is last element +to be checked. + +Knowing the parsing order will help you devise unambiguous macro, list +and block syntax rules. + +Inline substitutions within block elements are performed in the +following default order: + +1. Special characters +2. Quotes +3. Special words +4. Replacements +5. Attributes +6. Inline Macros +7. Replacements2 + +The substitutions and substitution order performed on +Title, Paragraph and DelimitedBlock elements is determined by +configuration file parameters. + + +Text Formatting +--------------- +[[X51]] +Quoted Text +~~~~~~~~~~~ +Words and phrases can be formatted by enclosing inline text with +quote characters: + +_Emphasized text_:: + Word phrases \'enclosed in single quote characters' (acute + accents) or \_underline characters_ are emphasized. + +*Strong text*:: + Word phrases \*enclosed in asterisk characters* are rendered + in a strong font (usually bold). + +[[X81]]+Monospaced text+:: + Word phrases \+enclosed in plus characters+ are rendered in a + monospaced font. Word phrases \`enclosed in backtick + characters` (grave accents) are also rendered in a monospaced + font but in this case the enclosed text is rendered literally + and is not subject to further expansion (see <<X80,inline + literal passthrough>>). + +`Single quoted text':: + Phrases enclosed with a \`single grave accent to the left and + a single acute accent to the right' are rendered in single + quotation marks. + +``Double quoted text'':: + Phrases enclosed with \\``two grave accents to the left and + two acute accents to the right'' are rendered in quotation + marks. + +#Unquoted text#:: + Placing \#hashes around text# does nothing, it is a mechanism + to allow inline attributes to be applied to otherwise + unformatted text. + +New quote types can be defined by editing asciidoc(1) configuration +files. See the <<X7,Configuration Files>> section for details. + +.Quoted text behavior +- Quoting cannot be overlapped. +- Different quoting types can be nested. +- To suppress quoted text formatting place a backslash character + immediately in front of the leading quote character(s). In the case + of ambiguity between escaped and non-escaped text you will need to + escape both leading and trailing quotes, in the case of + multi-character quotes you may even need to escape individual + characters. + +[[X96]] +Quoted text attributes +^^^^^^^^^^^^^^^^^^^^^^ +Quoted text can be prefixed with an <<X21,attribute list>>. The first +positional attribute ('role' attribute) is translated by AsciiDoc to +an HTML 'span' element 'class' attribute or a DocBook 'phrase' element +'role' attribute. + +DocBook XSL Stylesheets translate DocBook 'phrase' elements with +'role' attributes to corresponding HTML 'span' elements with the same +'class' attributes; CSS can then be used +http://www.sagehill.net/docbookxsl/UsingCSS.html[to style the +generated HTML]. Thus CSS styling can be applied to both DocBook and +AsciiDoc generated HTML outputs. You can also specify multiple class +names separated by spaces. + +CSS rules for text color, text background color, text size and text +decorators are included in the distributed AsciiDoc CSS files and are +used in conjunction with AsciiDoc 'xhtml11', 'html5' and 'docbook' +outputs. The CSS class names are: + +- '<color>' (text foreground color). +- '<color>-background' (text background color). +- 'big' and 'small' (text size). +- 'underline', 'overline' and 'line-through' (strike through) text + decorators. + +Where '<color>' can be any of the +http://en.wikipedia.org/wiki/Web_colors#HTML_color_names[sixteen HTML +color names]. Examples: + + [red]#Obvious# and [big red yellow-background]*very obvious*. + + [underline]#Underline text#, [overline]#overline text# and + [blue line-through]*bold blue and line-through*. + +is rendered as: + +[red]#Obvious# and [big red yellow-background]*very obvious*. + +[underline]#Underline text#, [overline]#overline text# and +[bold blue line-through]*bold blue and line-through*. + +NOTE: Color and text decorator attributes are rendered for XHTML and +HTML 5 outputs using CSS stylesheets. The mechanism to implement +color and text decorator attributes is provided for DocBook toolchains +via the DocBook 'phrase' element 'role' attribute, but the actual +rendering is toolchain specific and is not part of the AsciiDoc +distribution. + +[[X52]] +Constrained and Unconstrained Quotes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +There are actually two types of quotes: + +Constrained quotes +++++++++++++++++++ +Quoted must be bounded by white space or commonly adjoining +punctuation characters. These are the most commonly used type of +quote. + +Unconstrained quotes +++++++++++++++++++++ +Unconstrained quotes have no boundary constraints and can be placed +anywhere within inline text. For consistency and to make them easier +to remember unconstrained quotes are double-ups of the `_`, `*`, `+` +and `#` constrained quotes: + + __unconstrained emphasized text__ + **unconstrained strong text** + ++unconstrained monospaced text++ + ##unconstrained unquoted text## + +The following example emboldens the letter F: + + **F**ile Open... + +Superscripts and Subscripts +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Put \^carets on either^ side of the text to be superscripted, put +\~tildes on either side~ of text to be subscripted. For example, the +following line: + + e^πi^+1 = 0. H~2~O and x^10^. Some ^super text^ + and ~some sub text~ + +Is rendered like: + +e^πi^+1 = 0. H~2~O and x^10^. Some ^super text^ +and ~some sub text~ + +Superscripts and subscripts are implemented as <<X52,unconstrained +quotes>> and they can be escaped with a leading backslash and prefixed +with with an attribute list. + +Line Breaks +~~~~~~~~~~~ +A plus character preceded by at least one space character at the end +of a non-blank line forces a line break. It generates a line break +(`br`) tag for HTML outputs and a custom XML `asciidoc-br` processing +instruction for DocBook outputs. The `asciidoc-br` processing +instruction is handled by <<X43,a2x(1)>>. + +Page Breaks +~~~~~~~~~~~ +A line of three or more less-than (`<<<`) characters will generate a +hard page break in DocBook and printed HTML outputs. It uses the CSS +`page-break-after` property for HTML outputs and a custom XML +`asciidoc-pagebreak` processing instruction for DocBook outputs. The +`asciidoc-pagebreak` processing instruction is handled by +<<X43,a2x(1)>>. Hard page breaks are sometimes handy but as a general +rule you should let your page processor generate page breaks for you. + +Rulers +~~~~~~ +A line of three or more apostrophe characters will generate a ruler +line. It generates a ruler (`hr`) tag for HTML outputs and a custom +XML `asciidoc-hr` processing instruction for DocBook outputs. The +`asciidoc-hr` processing instruction is handled by <<X43,a2x(1)>>. + +Tabs +~~~~ +By default tab characters input files will translated to 8 spaces. Tab +expansion is set with the 'tabsize' entry in the configuration file +`[miscellaneous]` section and can be overridden in included files by +setting a 'tabsize' attribute in the `include` macro's attribute list. +For example: + + include::addendum.txt[tabsize=2] + +The tab size can also be set using the attribute command-line option, +for example `--attribute tabsize=4` + +Replacements +~~~~~~~~~~~~ +The following replacements are defined in the default AsciiDoc +configuration: + + (C) copyright, (TM) trademark, (R) registered trademark, + -- em dash, ... ellipsis, -> right arrow, <- left arrow, => right + double arrow, <= left double arrow. + +Which are rendered as: + +(C) copyright, (TM) trademark, (R) registered trademark, +-- em dash, ... ellipsis, -> right arrow, <- left arrow, => right +double arrow, <= left double arrow. + +You can also include arbitrary entity references in the AsciiDoc +source. Examples: + + ➊ ¶ + +renders: + +➊ ¶ + +To render a replacement literally escape it with a leading back-slash. + +The <<X7,Configuration Files>> section explains how to configure your +own replacements. + +Special Words +~~~~~~~~~~~~~ +Words defined in `[specialwords]` configuration file sections are +automatically marked up without having to be explicitly notated. + +The <<X7,Configuration Files>> section explains how to add and replace +special words. + + +[[X17]] +Titles +------ +Document and section titles can be in either of two formats: + +Two line titles +~~~~~~~~~~~~~~~ +A two line title consists of a title line, starting hard against the +left margin, and an underline. Section underlines consist a repeated +character pairs spanning the width of the preceding title (give or +take up to two characters): + +The default title underlines for each of the document levels are: + + + Level 0 (top level): ====================== + Level 1: ---------------------- + Level 2: ~~~~~~~~~~~~~~~~~~~~~~ + Level 3: ^^^^^^^^^^^^^^^^^^^^^^ + Level 4 (bottom level): ++++++++++++++++++++++ + +Examples: + + Level One Section Title + ----------------------- + + Level 2 Subsection Title + ~~~~~~~~~~~~~~~~~~~~~~~~ + +[[X46]] +One line titles +~~~~~~~~~~~~~~~ +One line titles consist of a single line delimited on either side by +one or more equals characters (the number of equals characters +corresponds to the section level minus one). Here are some examples: + + = Document Title (level 0) = + == Section title (level 1) == + === Section title (level 2) === + ==== Section title (level 3) ==== + ===== Section title (level 4) ===== + +[NOTE] +===================================================================== +- One or more spaces must fall between the title and the delimiters. +- The trailing title delimiter is optional. +- The one-line title syntax can be changed by editing the + configuration file `[titles]` section `sect0`...`sect4` entries. +===================================================================== + +Floating titles +~~~~~~~~~~~~~~~ +Setting the title's first positional attribute or 'style' attribute to +'float' generates a free-floating title. A free-floating title is +rendered just like a normal section title 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. Floating titles +can also be used in contexts where section titles are illegal: for +example sidebar and admonition blocks. Example: + + [float] + The second day + ~~~~~~~~~~~~~~ + +Floating titles do not appear in a document's table of contents. + + +[[X42]] +Block Titles +------------ +A 'BlockTitle' element is a single line beginning with a period +followed by the title text. A BlockTitle is applied to the immediately +following Paragraph, DelimitedBlock, List, Table or BlockMacro. For +example: + +........................ +.Notes +- Note 1. +- Note 2. +........................ + +is rendered as: + +.Notes +- Note 1. +- Note 2. + + +[[X41]] +BlockId Element +--------------- +A 'BlockId' is a single line block element containing a unique +identifier enclosed in double square brackets. It is used to assign an +identifier to the ensuing block element. For example: + + [[chapter-titles]] + Chapter titles can be ... + +The preceding example identifies the ensuing paragraph so it can be +referenced from other locations, for example with +`<<chapter-titles,chapter titles>>`. + +'BlockId' elements can be applied to Title, Paragraph, List, +DelimitedBlock, Table and BlockMacro elements. The BlockId element +sets the `{id}` attribute for substitution in the subsequent block's +markup template. If a second positional argument is supplied it sets +the `{reftext}` attribute which is used to set the DocBook `xreflabel` +attribute. + +The 'BlockId' element has the same syntax and serves the same function +to the <<X30,anchor inline macro>>. + +[[X79]] +AttributeList Element +--------------------- +An 'AttributeList' block element is an <<X21,attribute list>> on a +line by itself: + +- 'AttributeList' attributes are only applied to the immediately + following block element -- the attributes are made available to the + block's markup template. +- Multiple contiguous 'AttributeList' elements are additively combined + in the order they appear.. +- The first positional attribute in the list is often used to specify + the ensuing element's <<X23,style>>. + +Attribute value substitution +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +By default, only substitutions that take place inside attribute list +values are attribute references, this is because not all attributes +are destined to be marked up and rendered as text (for example the +table 'cols' attribute). To perform normal inline text substitutions +(special characters, quotes, macros, replacements) on an attribute +value you need to enclose it in single quotes. In the following quote +block the second attribute value in the AttributeList is quoted to +ensure the 'http' macro is expanded to a hyperlink. + +--------------------------------------------------------------------- +[quote,'http://en.wikipedia.org/wiki/Samuel_Johnson[Samuel Johnson]'] +_____________________________________________________________________ +Sir, a woman's preaching is like a dog's walking on his hind legs. It +is not done well; but you are surprised to find it done at all. +_____________________________________________________________________ +--------------------------------------------------------------------- + +Common attributes +~~~~~~~~~~~~~~~~~ +Most block elements support the following attributes: + +[cols="1e,1,5a",frame="topbot",options="header"] +|==================================================================== +|Name |Backends |Description + +|id |html4, html5, xhtml11, docbook | +Unique identifier typically serve as link targets. +Can also be set by the 'BlockId' element. + +|role |html4, html5, xhtml11, docbook | +Role contains a string used to classify or subclassify an element and +can be applied to AsciiDoc block elements. The AsciiDoc 'role' +attribute is translated to the 'role' attribute in DocBook outputs and +is included in the 'class' attribute in HTML outputs, in this respect +it behaves like the <<X96,quoted text role attribute>>. + +DocBook XSL Stylesheets translate DocBook 'role' attributes to HTML +'class' attributes; CSS can then be used +http://www.sagehill.net/docbookxsl/UsingCSS.html[to style the +generated HTML]. + +|reftext |docbook | +'reftext' is used to set the DocBook 'xreflabel' attribute. +The 'reftext' attribute can an also be set by the 'BlockId' element. + +|==================================================================== + + +Paragraphs +---------- +Paragraphs are blocks of text terminated by a blank line, the end of +file, or the start of a delimited block or a list. There are three +paragraph syntaxes: normal, indented (literal) and admonition which +are rendered, by default, with the corresponding paragraph style. + +Each syntax has a default style, but you can explicitly apply any +paragraph style to any paragraph syntax. You can also apply +<<X104,delimited block>> styles to single paragraphs. + +The built-in paragraph styles are: 'normal', 'literal', 'verse', +'quote', 'listing', 'TIP', 'NOTE', 'IMPORTANT', 'WARNING', 'CAUTION', +'abstract', 'partintro', 'comment', 'example', 'sidebar', 'source', +'music', 'latex', 'graphviz'. + +normal paragraph syntax +~~~~~~~~~~~~~~~~~~~~~~~ +Normal paragraph syntax consists of one or more non-blank lines of +text. The first line must start hard against the left margin (no +intervening white space). The default processing expectation is that +of a normal paragraph of text. + +[[X85]] +literal paragraph syntax +~~~~~~~~~~~~~~~~~~~~~~~~ +Literal paragraphs are rendered verbatim in a monospaced font without +any distinguishing background or border. By default there is no text +formatting or substitutions within Literal paragraphs apart from +Special Characters and Callouts. + +The 'literal' style is applied implicitly to indented paragraphs i.e. +where the first line of the paragraph is indented by one or more space +or tab characters. For example: + +--------------------------------------------------------------------- + Consul *necessitatibus* per id, + consetetur, eu pro everti postulant + homero verear ea mea, qui. +--------------------------------------------------------------------- + +Renders: + + Consul *necessitatibus* per id, + consetetur, eu pro everti postulant + homero verear ea mea, qui. + +NOTE: Because <<X64,lists>> can be indented it's possible for your +indented paragraph to be misinterpreted as a list -- in situations +like this apply the 'literal' style to a normal paragraph. + +Instead of using a paragraph indent you could apply the 'literal' +style explicitly, for example: + +--------------------------------------------------------------------- +[literal] +Consul *necessitatibus* per id, +consetetur, eu pro everti postulant +homero verear ea mea, qui. +--------------------------------------------------------------------- + +Renders: + +[literal] +Consul *necessitatibus* per id, +consetetur, eu pro everti postulant +homero verear ea mea, qui. + +[[X94]] +quote and verse paragraph styles +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The optional 'attribution' and 'citetitle' attributes (positional +attributes 2 and 3) specify the author and source respectively. + +The 'verse' style retains the line breaks, for example: + +--------------------------------------------------------------------- +[verse, William Blake, from Auguries of Innocence] +To see a world in a grain of sand, +And a heaven in a wild flower, +Hold infinity in the palm of your hand, +And eternity in an hour. +--------------------------------------------------------------------- + +Which is rendered as: + +[verse, William Blake, from Auguries of Innocence] +To see a world in a grain of sand, +And a heaven in a wild flower, +Hold infinity in the palm of your hand, +And eternity in an hour. + +The 'quote' style flows the text at left and right margins, for +example: + +--------------------------------------------------------------------- +[quote, Bertrand Russell, The World of Mathematics (1956)] +A good notation has subtlety and suggestiveness which at times makes +it almost seem like a live teacher. +--------------------------------------------------------------------- + +Which is rendered as: + +[quote, Bertrand Russell, The World of Mathematics (1956)] +A good notation has subtlety and suggestiveness which at times makes +it almost seem like a live teacher. + +[[X28]] +Admonition Paragraphs +~~~~~~~~~~~~~~~~~~~~~ +'TIP', 'NOTE', 'IMPORTANT', 'WARNING' and 'CAUTION' admonishment +paragraph styles are generated by placing `NOTE:`, `TIP:`, +`IMPORTANT:`, `WARNING:` or `CAUTION:` as the first word of the +paragraph. For example: + + NOTE: This is an example note. + +Alternatively, you can specify the paragraph admonition style +explicitly using an <<X79,AttributeList element>>. For example: + + [NOTE] + This is an example note. + +Renders: + +NOTE: This is an example note. + +TIP: If your admonition requires more than a single paragraph use an +<<X22,admonition block>> instead. + +[[X47]] +Admonition Icons and Captions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +NOTE: Admonition customization with `icons`, `iconsdir`, `icon` and +`caption` attributes does not apply when generating DocBook output. If +you are going the DocBook route then the <<X43,a2x(1)>> `--no-icons` +and `--icons-dir` options can be used to set the appropriate XSL +Stylesheets parameters. + +By default the asciidoc(1) HTML backends generate text captions +instead of admonition icon image links. To generate links to icon +images define the <<X45,`icons`>> attribute, for example using the `-a +icons` command-line option. + +The <<X44,`iconsdir`>> attribute sets the location of linked icon +images. + +You can override the default icon image using the `icon` attribute to +specify the path of the linked image. For example: + + [icon="./images/icons/wink.png"] + NOTE: What lovely war. + +Use the `caption` attribute to customize the admonition captions (not +applicable to `docbook` backend). The following example suppresses the +icon image and customizes the caption of a 'NOTE' admonition +(undefining the `icons` attribute with `icons=None` is only necessary +if <<X45,admonition icons>> have been enabled): + + [icons=None, caption="My Special Note"] + NOTE: This is my special note. + +This subsection also applies to <<X22,Admonition Blocks>>. + + +[[X104]] +Delimited Blocks +---------------- +Delimited blocks are blocks of text enveloped by leading and trailing +delimiter lines (normally a series of four or more repeated +characters). The behavior of Delimited Blocks is specified by entries +in configuration file `[blockdef-*]` sections. + +Predefined Delimited Blocks +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +AsciiDoc ships with a number of predefined DelimitedBlocks (see the +`asciidoc.conf` configuration file in the asciidoc(1) program +directory): + +Predefined delimited block underlines: + + CommentBlock: ////////////////////////// + PassthroughBlock: ++++++++++++++++++++++++++ + ListingBlock: -------------------------- + LiteralBlock: .......................... + SidebarBlock: ************************** + QuoteBlock: __________________________ + ExampleBlock: ========================== + OpenBlock: -- + +.Default DelimitedBlock substitutions +[cols="2e,7*^",frame="topbot",options="header,autowidth"] +|===================================================== +| |Attributes |Callouts |Macros | Quotes |Replacements +|Special chars |Special words + +|PassthroughBlock |Yes |No |Yes |No |No |No |No +|ListingBlock |No |Yes |No |No |No |Yes |No +|LiteralBlock |No |Yes |No |No |No |Yes |No +|SidebarBlock |Yes |No |Yes |Yes |Yes |Yes |Yes +|QuoteBlock |Yes |No |Yes |Yes |Yes |Yes |Yes +|ExampleBlock |Yes |No |Yes |Yes |Yes |Yes |Yes +|OpenBlock |Yes |No |Yes |Yes |Yes |Yes |Yes +|===================================================== + +Listing Blocks +~~~~~~~~~~~~~~ +'ListingBlocks' are rendered verbatim in a monospaced font, they +retain line and whitespace formatting and are often distinguished by a +background or border. There is no text formatting or substitutions +within Listing blocks apart from Special Characters and Callouts. +Listing blocks are often used for computer output and file listings. + +Here's an example: + +[listing] +...................................... +-------------------------------------- +#include <stdio.h> + +int main() { + printf("Hello World!\n"); + exit(0); +} +-------------------------------------- +...................................... + +Which will be rendered like: + +-------------------------------------- +#include <stdio.h> + +int main() { + printf("Hello World!\n"); + exit(0); +} +-------------------------------------- + +By convention <<X59,filter blocks>> use the listing block syntax and +are implemented as distinct listing block styles. + +[[X65]] +Literal Blocks +~~~~~~~~~~~~~~ +'LiteralBlocks' are rendered just like <<X85,literal paragraphs>>. +Example: + +--------------------------------------------------------------------- +................................... +Consul *necessitatibus* per id, +consetetur, eu pro everti postulant +homero verear ea mea, qui. +................................... +--------------------------------------------------------------------- + +Renders: +................................... +Consul *necessitatibus* per id, +consetetur, eu pro everti postulant +homero verear ea mea, qui. +................................... + +If the 'listing' style is applied to a LiteralBlock it will be +rendered as a ListingBlock (this is handy if you have a listing +containing a ListingBlock). + +Sidebar Blocks +~~~~~~~~~~~~~~ +A sidebar is a short piece of text presented outside the narrative +flow of the main text. The sidebar is normally presented inside a +bordered box to set it apart from the main text. + +The sidebar body is treated like a normal section body. + +Here's an example: + +--------------------------------------------------------------------- +.An Example Sidebar +************************************************ +Any AsciiDoc SectionBody element (apart from +SidebarBlocks) can be placed inside a sidebar. +************************************************ +--------------------------------------------------------------------- + +Which will be rendered like: + +.An Example Sidebar +************************************************ +Any AsciiDoc SectionBody element (apart from +SidebarBlocks) can be placed inside a sidebar. +************************************************ + +[[X26]] +Comment Blocks +~~~~~~~~~~~~~~ +The contents of 'CommentBlocks' are not processed; they are useful for +annotations and for excluding new or outdated content that you don't +want displayed. CommentBlocks are never written to output files. +Example: + +--------------------------------------------------------------------- +////////////////////////////////////////// +CommentBlock contents are not processed by +asciidoc(1). +////////////////////////////////////////// +--------------------------------------------------------------------- + +See also <<X25,Comment Lines>>. + +NOTE: System macros are executed inside comment blocks. + +[[X76]] +Passthrough Blocks +~~~~~~~~~~~~~~~~~~ +By default the block contents is subject only to 'attributes' and +'macros' substitutions (use an explicit 'subs' attribute to apply +different substitutions). PassthroughBlock content will often be +backend specific. Here's an example: + +--------------------------------------------------------------------- +[subs="quotes"] +++++++++++++++++++++++++++++++++++++++ +<table border="1"><tr> + <td>*Cell 1*</td> + <td>*Cell 2*</td> +</tr></table> +++++++++++++++++++++++++++++++++++++++ +--------------------------------------------------------------------- + +The following styles can be applied to passthrough blocks: + +pass:: + No substitutions are performed. This is equivalent to `subs="none"`. + +asciimath, latexmath:: + By default no substitutions are performed, the contents are rendered + as <<X78,mathematical formulas>>. + +Quote Blocks +~~~~~~~~~~~~ +'QuoteBlocks' are used for quoted passages of text. There are two +styles: 'quote' and 'verse'. The style behavior is identical to +<<X94,quote and verse paragraphs>> except that blocks can contain +multiple paragraphs and, in the case of the 'quote' style, other +section elements. The first positional attribute sets the style, if +no attributes are specified the 'quote' style is used. The optional +'attribution' and 'citetitle' attributes (positional attributes 2 and +3) specify the quote's author and source. For example: + +--------------------------------------------------------------------- +[quote, Sir Arthur Conan Doyle, The Adventures of Sherlock Holmes] +____________________________________________________________________ +As he spoke there was the sharp sound of horses' hoofs and +grating wheels against the curb, followed by a sharp pull at the +bell. Holmes whistled. + +"A pair, by the sound," said he. "Yes," he continued, glancing +out of the window. "A nice little brougham and a pair of +beauties. A hundred and fifty guineas apiece. There's money in +this case, Watson, if there is nothing else." +____________________________________________________________________ +--------------------------------------------------------------------- + +Which is rendered as: + +[quote, Sir Arthur Conan Doyle, The Adventures of Sherlock Holmes] +____________________________________________________________________ +As he spoke there was the sharp sound of horses' hoofs and +grating wheels against the curb, followed by a sharp pull at the +bell. Holmes whistled. + +"A pair, by the sound," said he. "Yes," he continued, glancing +out of the window. "A nice little brougham and a pair of +beauties. A hundred and fifty guineas apiece. There's money in +this case, Watson, if there is nothing else." +____________________________________________________________________ + +[[X48]] +Example Blocks +~~~~~~~~~~~~~~ +'ExampleBlocks' encapsulate the DocBook Example element and are used +for, well, examples. Example blocks can be titled by preceding them +with a 'BlockTitle'. DocBook toolchains will normally automatically +number examples and generate a 'List of Examples' backmatter section. + +Example blocks are delimited by lines of equals characters and can +contain any block elements apart from Titles, BlockTitles and +Sidebars) inside an example block. For example: + +--------------------------------------------------------------------- +.An example +===================================================================== +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. +===================================================================== +--------------------------------------------------------------------- + +Renders: + +.An example +===================================================================== +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. +===================================================================== + +A title prefix that can be inserted with the `caption` attribute +(HTML backends). For example: + +--------------------------------------------------------------------- +[caption="Example 1: "] +.An example with a custom caption +===================================================================== +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. +===================================================================== +--------------------------------------------------------------------- + +[[X22]] +Admonition Blocks +~~~~~~~~~~~~~~~~~ +The 'ExampleBlock' definition includes a set of admonition +<<X23,styles>> ('NOTE', 'TIP', 'IMPORTANT', 'WARNING', 'CAUTION') for +generating admonition blocks (admonitions containing more than a +<<X28,single paragraph>>). Just precede the 'ExampleBlock' with an +attribute list specifying the admonition style name. For example: + +--------------------------------------------------------------------- +[NOTE] +.A NOTE admonition block +===================================================================== +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. + +. Fusce euismod commodo velit. +. Vivamus fringilla mi eu lacus. + .. Fusce euismod commodo velit. + .. Vivamus fringilla mi eu lacus. +. Donec eget arcu bibendum + nunc consequat lobortis. +===================================================================== +--------------------------------------------------------------------- + +Renders: + +[NOTE] +.A NOTE admonition block +===================================================================== +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. + +. Fusce euismod commodo velit. +. Vivamus fringilla mi eu lacus. + .. Fusce euismod commodo velit. + .. Vivamus fringilla mi eu lacus. +. Donec eget arcu bibendum + nunc consequat lobortis. +===================================================================== + +See also <<X47,Admonition Icons and Captions>>. + +[[X29]] +Open Blocks +~~~~~~~~~~~ +Open blocks are special: + +- The open block delimiter is line containing two hyphen characters + (instead of four or more repeated characters). + +- They can be used to group block elements for <<X15,List item + continuation>>. + +- Open blocks can be styled to behave like any other type of delimited + block. The following built-in styles can be applied to open + blocks: 'literal', 'verse', 'quote', 'listing', 'TIP', 'NOTE', + 'IMPORTANT', 'WARNING', 'CAUTION', 'abstract', 'partintro', + 'comment', 'example', 'sidebar', 'source', 'music', 'latex', + 'graphviz'. For example, the following open block and listing block + are functionally identical: + + [listing] + -- + Lorum ipsum ... + -- + + --------------- + Lorum ipsum ... + --------------- + +- An unstyled open block groups section elements but otherwise does + nothing. + +Open blocks are used to generate document abstracts and book part +introductions: + +- Apply the 'abstract' style to generate an abstract, for example: + + [abstract] + -- + In this paper we will ... + -- + +. Apply the 'partintro' style to generate a book part introduction for + a multi-part book, for example: + + [partintro] + .Optional part introduction title + -- + Optional part introduction goes here. + -- + + +[[X64]] +Lists +----- +.List types +- Bulleted lists. Also known as itemized or unordered lists. +- Numbered lists. Also called ordered lists. +- Labeled lists. Sometimes called variable or definition lists. +- Callout lists (a list of callout annotations). + +.List behavior +- List item indentation is optional and does not determine nesting, + indentation does however make the source more readable. +- Another list or a literal paragraph immediately following a list + item will be implicitly included in the list item; use <<X15, list + item continuation>> to explicitly append other block elements to a + list item. +- A comment block or a comment line block macro element will terminate + a list -- use inline comment lines to put comments inside lists. +- The `listindex` <<X60,intrinsic attribute>> is the current list item + index (1..). If this attribute is used outside a list then it's value + is the number of items in the most recently closed list. Useful for + displaying the number of items in a list. + +Bulleted Lists +~~~~~~~~~~~~~~ +Bulleted list items start with a single dash or one to five asterisks +followed by some white space then some text. Bulleted list syntaxes +are: + +................... +- List item. +* List item. +** List item. +*** List item. +**** List item. +***** List item. +................... + +Numbered Lists +~~~~~~~~~~~~~~ +List item numbers are explicit or implicit. + +.Explicit numbering +List items begin with a number followed by some white space then the +item text. The numbers can be decimal (arabic), roman (upper or lower +case) or alpha (upper or lower case). Decimal and alpha numbers are +terminated with a period, roman numbers are terminated with a closing +parenthesis. The different terminators are necessary to ensure 'i', +'v' and 'x' roman numbers are are distinguishable from 'x', 'v' and +'x' alpha numbers. Examples: + +..................................................................... +1. Arabic (decimal) numbered list item. +a. Lower case alpha (letter) numbered list item. +F. Upper case alpha (letter) numbered list item. +iii) Lower case roman numbered list item. +IX) Upper case roman numbered list item. +..................................................................... + +.Implicit numbering +List items begin one to five period characters, followed by some white +space then the item text. Examples: + +..................................................................... +. Arabic (decimal) numbered list item. +.. Lower case alpha (letter) numbered list item. +... Lower case roman numbered list item. +.... Upper case alpha (letter) numbered list item. +..... Upper case roman numbered list item. +..................................................................... + +You can use the 'style' attribute (also the first positional +attribute) to specify an alternative numbering style. The numbered +list style can be one of the following values: 'arabic', 'loweralpha', +'upperalpha', 'lowerroman', 'upperroman'. + +Here are some examples of bulleted and numbered lists: + +--------------------------------------------------------------------- +- Praesent eget purus quis magna eleifend eleifend. + 1. Fusce euismod commodo velit. + a. Fusce euismod commodo velit. + b. Vivamus fringilla mi eu lacus. + c. Donec eget arcu bibendum nunc consequat lobortis. + 2. Vivamus fringilla mi eu lacus. + i) Fusce euismod commodo velit. + ii) Vivamus fringilla mi eu lacus. + 3. Donec eget arcu bibendum nunc consequat lobortis. + 4. Nam fermentum mattis ante. +- Lorem ipsum dolor sit amet, consectetuer adipiscing elit. + * Fusce euismod commodo velit. + ** Qui in magna commodo, est labitur dolorum an. Est ne magna primis + adolescens. Sit munere ponderum dignissim et. Minim luptatum et + vel. + ** Vivamus fringilla mi eu lacus. + * Donec eget arcu bibendum nunc consequat lobortis. +- Nulla porttitor vulputate libero. + . Fusce euismod commodo velit. + . Vivamus fringilla mi eu lacus. +[upperroman] + .. Fusce euismod commodo velit. + .. Vivamus fringilla mi eu lacus. + . Donec eget arcu bibendum nunc consequat lobortis. +--------------------------------------------------------------------- + +Which render as: + +- Praesent eget purus quis magna eleifend eleifend. + 1. Fusce euismod commodo velit. + a. Fusce euismod commodo velit. + b. Vivamus fringilla mi eu lacus. + c. Donec eget arcu bibendum nunc consequat lobortis. + 2. Vivamus fringilla mi eu lacus. + i) Fusce euismod commodo velit. + ii) Vivamus fringilla mi eu lacus. + 3. Donec eget arcu bibendum nunc consequat lobortis. + 4. Nam fermentum mattis ante. +- Lorem ipsum dolor sit amet, consectetuer adipiscing elit. + * Fusce euismod commodo velit. + ** Qui in magna commodo, est labitur dolorum an. Est ne magna primis + adolescens. Sit munere ponderum dignissim et. Minim luptatum et + vel. + ** Vivamus fringilla mi eu lacus. + * Donec eget arcu bibendum nunc consequat lobortis. +- Nulla porttitor vulputate libero. + . Fusce euismod commodo velit. + . Vivamus fringilla mi eu lacus. +[upperroman] + .. Fusce euismod commodo velit. + .. Vivamus fringilla mi eu lacus. + . Donec eget arcu bibendum nunc consequat lobortis. + +A predefined 'compact' option is available to bulleted and numbered +lists -- this translates to the DocBook 'spacing="compact"' lists +attribute which may or may not be processed by the DocBook toolchain. +Example: + + [options="compact"] + - Compact list item. + - Another compact list item. + +TIP: To apply the 'compact' option globally define a document-wide +'compact-option' attribute, e.g. using the `-a compact-option` +command-line option. + +You can set the list start number using the 'start' attribute (works +for HTML outputs and DocBook outputs processed by DocBook XSL +Stylesheets). Example: + + [start=7] + . List item 7. + . List item 8. + +Labeled Lists +~~~~~~~~~~~~~ +Labeled list items consist of one or more text labels followed by the +text of the list item. + +An item label begins a line with an alphanumeric character hard +against the left margin and ends with two, three or four colons or two +semi-colons. A list item can have multiple labels, one per line. + +The list item text consists of one or more lines of text starting +after the last label (either on the same line or a new line) and can +be followed by nested List or ListParagraph elements. Item text can be +optionally indented. + +Here are some examples: + +--------------------------------------------------------------------- +In:: +Lorem:: + Fusce euismod commodo velit. + + Fusce euismod commodo velit. + +Ipsum:: Vivamus fringilla mi eu lacus. + * Vivamus fringilla mi eu lacus. + * Donec eget arcu bibendum nunc consequat lobortis. +Dolor:: + Donec eget arcu bibendum nunc consequat lobortis. + Suspendisse;; + A massa id sem aliquam auctor. + Morbi;; + Pretium nulla vel lorem. + In;; + Dictum mauris in urna. + Vivamus::: Fringilla mi eu lacus. + Donec::: Eget arcu bibendum nunc consequat lobortis. +--------------------------------------------------------------------- + +Which render as: + +In:: +Lorem:: + Fusce euismod commodo velit. + + Fusce euismod commodo velit. + +Ipsum:: Vivamus fringilla mi eu lacus. + * Vivamus fringilla mi eu lacus. + * Donec eget arcu bibendum nunc consequat lobortis. +Dolor:: + Donec eget arcu bibendum nunc consequat lobortis. + Suspendisse;; + A massa id sem aliquam auctor. + Morbi;; + Pretium nulla vel lorem. + In;; + Dictum mauris in urna. + Vivamus::: Fringilla mi eu lacus. + Donec::: Eget arcu bibendum nunc consequat lobortis. + +Horizontal labeled list style +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The 'horizontal' labeled list style (also the first positional +attribute) places the list text side-by-side with the label instead of +under the label. Here is an example: + +--------------------------------------------------------------------- +[horizontal] +*Lorem*:: Fusce euismod commodo velit. Qui in magna commodo, est +labitur dolorum an. Est ne magna primis adolescens. + + Fusce euismod commodo velit. + +*Ipsum*:: Vivamus fringilla mi eu lacus. +- Vivamus fringilla mi eu lacus. +- Donec eget arcu bibendum nunc consequat lobortis. + +*Dolor*:: + - Vivamus fringilla mi eu lacus. + - Donec eget arcu bibendum nunc consequat lobortis. + +--------------------------------------------------------------------- + +Which render as: + +[horizontal] +*Lorem*:: Fusce euismod commodo velit. Qui in magna commodo, est +labitur dolorum an. Est ne magna primis adolescens. + + Fusce euismod commodo velit. + +*Ipsum*:: Vivamus fringilla mi eu lacus. +- Vivamus fringilla mi eu lacus. +- Donec eget arcu bibendum nunc consequat lobortis. + +*Dolor*:: + - Vivamus fringilla mi eu lacus. + - Donec eget arcu bibendum nunc consequat lobortis. + +[NOTE] +===================================================================== +- Current PDF toolchains do not make a good job of determining + the relative column widths for horizontal labeled lists. +- Nested horizontal labeled lists will generate DocBook validation + errors because the 'DocBook XML V4.2' DTD does not permit nested + informal tables (although <<X13,DocBook XSL Stylesheets>> and + <<X31,dblatex>> process them correctly). +- The label width can be set as a percentage of the total width by + setting the 'width' attribute e.g. `width="10%"` +===================================================================== + +Question and Answer Lists +~~~~~~~~~~~~~~~~~~~~~~~~~ +AsciiDoc comes pre-configured with a 'qanda' style labeled list for generating +DocBook question and answer (Q&A) lists. Example: + +--------------------------------------------------------------------- +[qanda] +Question one:: + Answer one. +Question two:: + Answer two. +--------------------------------------------------------------------- + +Renders: + +[qanda] +Question one:: + Answer one. +Question two:: + Answer two. + +Glossary Lists +~~~~~~~~~~~~~~ +AsciiDoc comes pre-configured with a 'glossary' style labeled list for +generating DocBook glossary lists. Example: + +--------------------------------------------------------------------- +[glossary] +A glossary term:: + The corresponding definition. +A second glossary term:: + The corresponding definition. +--------------------------------------------------------------------- + +For working examples see the `article.txt` and `book.txt` documents in +the AsciiDoc `./doc` distribution directory. + +NOTE: To generate valid DocBook output glossary lists must be located +in a section that uses the 'glossary' <<X93,section markup template>>. + +Bibliography Lists +~~~~~~~~~~~~~~~~~~ +AsciiDoc comes with a predefined 'bibliography' bulleted list style +generating DocBook bibliography entries. Example: + +--------------------------------------------------------------------- +[bibliography] +.Optional list title +- [[[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. +--------------------------------------------------------------------- + +The `[[[<reference>]]]` syntax is a bibliography entry anchor, it +generates an anchor named `<reference>` and additionally displays +`[<reference>]` at the anchor position. For example `[[[taoup]]]` +generates an anchor named `taoup` that displays `[taoup]` at the +anchor position. Cite the reference from elsewhere your document using +`<<taoup>>`, this displays a hyperlink (`[taoup]`) to the +corresponding bibliography entry anchor. + +For working examples see the `article.txt` and `book.txt` documents in +the AsciiDoc `./doc` distribution directory. + +NOTE: To generate valid DocBook output bibliography lists must be +located in a <<X93,bibliography section>>. + +[[X15]] +List Item Continuation +~~~~~~~~~~~~~~~~~~~~~~ +Another list or a literal paragraph immediately following a list item +is implicitly appended to the list item; to append other block +elements to a list item you need to explicitly join them to the list +item with a 'list continuation' (a separator line containing a single +plus character). Multiple block elements can be appended to a list +item using list continuations (provided they are legal list item +children in the backend markup). + +Here are some examples of list item continuations: list item one +contains multiple continuations; list item two is continued with an +<<X29,OpenBlock>> containing multiple elements: + +--------------------------------------------------------------------- +1. List item one. ++ +List item one continued with a second paragraph followed by an +Indented block. ++ +................. +$ ls *.sh +$ mv *.sh ~/tmp +................. ++ +List item continued with a third paragraph. + +2. List item two continued with an open block. ++ +-- +This paragraph is part of the preceding list item. + +a. This list is nested and does not require explicit item continuation. ++ +This paragraph is part of the preceding list item. + +b. List item b. + +This paragraph belongs to item two of the outer list. +-- +--------------------------------------------------------------------- + +Renders: + +1. List item one. ++ +List item one continued with a second paragraph followed by an +Indented block. ++ +................. +$ ls *.sh +$ mv *.sh ~/tmp +................. ++ +List item continued with a third paragraph. + +2. List item two continued with an open block. ++ +-- +This paragraph is part of the preceding list item. + +a. This list is nested and does not require explicit item continuation. ++ +This paragraph is part of the preceding list item. + +b. List item b. + +This paragraph belongs to item two of the outer list. +-- + + +[[X92]] +Footnotes +--------- +The shipped AsciiDoc configuration includes three footnote inline +macros: + +`footnote:[<text>]`:: + Generates a footnote with text `<text>`. + +`footnoteref:[<id>,<text>]`:: + Generates a footnote with a reference ID `<id>` and text `<text>`. + +`footnoteref:[<id>]`:: + Generates a reference to the footnote with ID `<id>`. + +The footnote text can span multiple lines. + +The 'xhtml11' and 'html5' backends render footnotes dynamically using +JavaScript; 'html4' outputs do not use JavaScript and leave the +footnotes inline; 'docbook' footnotes are processed by the downstream +DocBook toolchain. + +Example footnotes: + + A footnote footnote:[An example footnote.]; + a second footnote with a reference ID footnoteref:[note2,Second footnote.]; + finally a reference to the second footnote footnoteref:[note2]. + +Renders: + +A footnote footnote:[An example footnote.]; +a second footnote with a reference ID footnoteref:[note2,Second footnote.]; +finally a reference to the second footnote footnoteref:[note2]. + + +Indexes +------- +The shipped AsciiDoc configuration includes the inline macros for +generating DocBook index entries. + +`indexterm:[<primary>,<secondary>,<tertiary>]`:: +`(((<primary>,<secondary>,<tertiary>)))`:: + This inline macro generates an index term (the `<secondary>` and + `<tertiary>` positional attributes are optional). Example: + `indexterm:[Tigers,Big cats]` (or, using the alternative syntax + `(((Tigers,Big cats)))`. Index terms that have secondary and + tertiary entries also generate separate index terms for the + secondary and tertiary entries. The index terms appear in the + index, not the primary text flow. + +`indexterm2:[<primary>]`:: +`((<primary>))`:: + This inline macro generates an index term that appears in both the + index and the primary text flow. The `<primary>` should not be + padded to the left or right with white space characters. + +For working examples see the `article.txt` and `book.txt` documents in +the AsciiDoc `./doc` distribution directory. + +NOTE: Index entries only really make sense if you are generating +DocBook markup -- DocBook conversion programs automatically generate +an index at the point an 'Index' section appears in source document. + + +[[X105]] +Callouts +-------- +Callouts are a mechanism for annotating verbatim text (for example: +source code, computer output and user input). Callout markers are +placed inside the annotated text while the actual annotations are +presented in a callout list after the annotated text. Here's an +example: + +--------------------------------------------------------------------- + .MS-DOS directory listing + ----------------------------------------------------- + 10/17/97 9:04 <DIR> bin + 10/16/97 14:11 <DIR> DOS \<1> + 10/16/97 14:40 <DIR> Program Files + 10/16/97 14:46 <DIR> TEMP + 10/17/97 9:04 <DIR> tmp + 10/16/97 14:37 <DIR> WINNT + 10/16/97 14:25 119 AUTOEXEC.BAT \<2> + 2/13/94 6:21 54,619 COMMAND.COM \<2> + 10/16/97 14:25 115 CONFIG.SYS \<2> + 11/16/97 17:17 61,865,984 pagefile.sys + 2/13/94 6:21 9,349 WINA20.386 \<3> + ----------------------------------------------------- + + \<1> This directory holds MS-DOS. + \<2> System startup code for DOS. + \<3> Some sort of Windows 3.1 hack. +--------------------------------------------------------------------- + +Which renders: + +.MS-DOS directory listing +----------------------------------------------------- +10/17/97 9:04 <DIR> bin +10/16/97 14:11 <DIR> DOS <1> +10/16/97 14:40 <DIR> Program Files +10/16/97 14:46 <DIR> TEMP +10/17/97 9:04 <DIR> tmp +10/16/97 14:37 <DIR> WINNT +10/16/97 14:25 119 AUTOEXEC.BAT <2> + 2/13/94 6:21 54,619 COMMAND.COM <2> +10/16/97 14:25 115 CONFIG.SYS <2> +11/16/97 17:17 61,865,984 pagefile.sys + 2/13/94 6:21 9,349 WINA20.386 <3> +----------------------------------------------------- + +<1> This directory holds MS-DOS. +<2> System startup code for DOS. +<3> Some sort of Windows 3.1 hack. + +.Explanation +- The callout marks are whole numbers enclosed in angle brackets -- + they refer to the correspondingly numbered item in the following + callout list. +- By default callout marks are confined to 'LiteralParagraphs', + 'LiteralBlocks' and 'ListingBlocks' (although this is a + configuration file option and can be changed). +- Callout list item numbering is fairly relaxed -- list items can + start with `<n>`, `n>` or `>` where `n` is the optional list item + number (in the latter case list items starting with a single `>` + character are implicitly numbered starting at one). +- Callout lists should not be nested. +- Callout lists start list items hard against the left margin. +- If you want to present a number inside angle brackets you'll need to + escape it with a backslash to prevent it being interpreted as a + callout mark. + +NOTE: Define the AsciiDoc 'icons' attribute (for example using the `-a +icons` command-line option) to display callout icons. + +Implementation Notes +~~~~~~~~~~~~~~~~~~~~ +Callout marks are generated by the 'callout' inline macro while +callout lists are generated using the 'callout' list definition. The +'callout' macro and 'callout' list are special in that they work +together. The 'callout' inline macro is not enabled by the normal +'macros' substitutions option, instead it has its own 'callouts' +substitution option. + +The following attributes are available during inline callout macro +substitution: + +`{index}`:: + The callout list item index inside the angle brackets. +`{coid}`:: + An identifier formatted like `CO<listnumber>-<index>` that + uniquely identifies the callout mark. For example `CO2-4` + identifies the fourth callout mark in the second set of callout + marks. + +The `{coids}` attribute can be used during callout list item +substitution -- it is a space delimited list of callout IDs that refer +to the explanatory list item. + +Including callouts in included code +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +You can annotate working code examples with callouts -- just remember +to put the callouts inside source code comments. This example displays +the `test.py` source file (containing a single callout) using the +'source' (code highlighter) filter: + +.AsciiDoc source +--------------------------------------------------------------------- + [source,python] + ------------------------------------------- + \include::test.py[] + ------------------------------------------- + + \<1> Print statement. +--------------------------------------------------------------------- + +.Included `test.py` source +--------------------------------------------------------------------- +print 'Hello World!' # \<1> +--------------------------------------------------------------------- + + +Macros +------ +Macros are a mechanism for substituting parametrized text into output +documents. + +Macros have a 'name', a single 'target' argument and an 'attribute +list'. The usual syntax is `<name>:<target>[<attrlist>]` (for +inline macros) and `<name>::<target>[<attrlist>]` (for block +macros). Here are some examples: + + http://www.docbook.org/[DocBook.org] + include::chapt1.txt[tabsize=2] + mailto:srackham@gmail.com[] + +.Macro behavior +- `<name>` is the macro name. It can only contain letters, digits or + dash characters and cannot start with a dash. +- The optional `<target>` cannot contain white space characters. +- `<attrlist>` is a <<X21,list of attributes>> enclosed in square + brackets. +- `]` characters inside attribute lists must be escaped with a + backslash. +- Expansion of macro references can normally be escaped by prefixing a + backslash character (see the AsciiDoc 'FAQ' for examples of + exceptions to this rule). +- Attribute references in block macros are expanded. +- The substitutions performed prior to Inline macro macro expansion + are determined by the inline context. +- Macros are processed in the order they appear in the configuration + file(s). +- Calls to inline macros can be nested inside different inline macros + (an inline macro call cannot contain a nested call to itself). +- In addition to `<name>`, `<target>` and `<attrlist>` the + `<passtext>` and `<subslist>` named groups are available to + <<X77,passthrough macros>>. A macro is a passthrough macro if the + definition includes a `<passtext>` named group. + +Inline Macros +~~~~~~~~~~~~~ +Inline Macros occur in an inline element context. Predefined Inline +macros include 'URLs', 'image' and 'link' macros. + +URLs +^^^^ +'http', 'https', 'ftp', 'file', 'mailto' and 'callto' URLs are +rendered using predefined inline macros. + +- If you don't need a custom link caption you can enter the 'http', + 'https', 'ftp', 'file' URLs and email addresses without any special + macro syntax. +- If the `<attrlist>` is empty the URL is displayed. + +Here are some examples: + + http://www.docbook.org/[DocBook.org] + http://www.docbook.org/ + mailto:joe.bloggs@foobar.com[email Joe Bloggs] + joe.bloggs@foobar.com + +Which are rendered: + +http://www.docbook.org/[DocBook.org] + +http://www.docbook.org/ + +mailto:joe.bloggs@foobar.com[email Joe Bloggs] + +joe.bloggs@foobar.com + +If the `<target>` necessitates space characters use `%20`, for example +`large%20image.png`. + +Internal Cross References +^^^^^^^^^^^^^^^^^^^^^^^^^ +Two AsciiDoc inline macros are provided for creating hypertext links +within an AsciiDoc document. You can use either the standard macro +syntax or the (preferred) alternative. + +[[X30]] +anchor +++++++ +Used to specify hypertext link targets: + + [[<id>,<xreflabel>]] + anchor:<id>[<xreflabel>] + +The `<id>` is a unique string that conforms to the output markup's +anchor syntax. The optional `<xreflabel>` is the text to be displayed +by captionless 'xref' macros that refer to this anchor. The optional +`<xreflabel>` is only really useful when generating DocBook output. +Example anchor: + + [[X1]] + +You may have noticed that the syntax of this inline element is the +same as that of the <<X41,BlockId block element>>, this is no +coincidence since they are functionally equivalent. + +xref +++++ +Creates a hypertext link to a document anchor. + + <<<id>,<caption>>> + xref:<id>[<caption>] + +The `<id>` refers to an anchor ID. The optional `<caption>` is the +link's displayed text. Example: + + <<X21,attribute lists>> + +If `<caption>` is not specified then the displayed text is +auto-generated: + +- The AsciiDoc 'xhtml11' and 'html5' backends display the `<id>` + enclosed in square brackets. +- If DocBook is produced the DocBook toolchain is responsible for the + displayed text which will normally be the referenced figure, table + or section title number followed by the element's title text. + +Here is an example: + +--------------------------------------------------------------------- +[[tiger_image]] +.Tyger tyger +image::tiger.png[] + +This can be seen in <<tiger_image>>. +--------------------------------------------------------------------- + +Linking to Local Documents +^^^^^^^^^^^^^^^^^^^^^^^^^^ +Hypertext links to files on the local file system are specified using +the 'link' inline macro. + + link:<target>[<caption>] + +The 'link' macro generates relative URLs. The link macro `<target>` is +the target file name (relative to the file system location of the +referring document). The optional `<caption>` is the link's displayed +text. If `<caption>` is not specified then `<target>` is displayed. +Example: + + link:downloads/foo.zip[download foo.zip] + +You can use the `<filename>#<id>` syntax to refer to an anchor within +a target document but this usually only makes sense when targeting +HTML documents. + +[[X9]] +Images +^^^^^^ +Inline images are inserted into the output document using the 'image' +macro. The inline syntax is: + + image:<target>[<attributes>] + +The contents of the image file `<target>` is displayed. To display the +image its file format must be supported by the target backend +application. HTML and DocBook applications normally support PNG or JPG +files. + +`<target>` file name paths are relative to the location of the +referring document. + +[[X55]] +.Image macro attributes +- The optional 'alt' attribute is also the first positional attribute, + it specifies alternative text which is displayed if the output + application is unable to display the image file (see also + http://htmlhelp.com/feature/art3.htm[Use of ALT texts in IMGs]). For + example: + + image:images/logo.png[Company Logo] + +- The optional 'title' attribute provides a title for the image. The + <<X49,block image macro>> renders the title alongside the image. + The inline image macro displays the title as a popup ``tooltip'' in + visual browsers (AsciiDoc HTML outputs only). + +- The optional `width` and `height` attributes scale the image size + and can be used in any combination. The units are pixels. The + following example scales the previous example to a height of 32 + pixels: + + image:images/logo.png["Company Logo",height=32] + +- The optional `link` attribute is used to link the image to an + external document. The following example links a screenshot + thumbnail to a full size version: + + image:screen-thumbnail.png[height=32,link="screen.png"] + +- The optional `scaledwidth` attribute is only used in DocBook block + images (specifically for PDF documents). The following example + scales the images to 75% of the available print width: + + image::images/logo.png[scaledwidth="75%",alt="Company Logo"] + +- The image `scale` attribute sets the DocBook `imagedata` element + `scale` attribute. + +- The optional `align` attribute is used for horizontal image + alignment. Allowed values are `center`, `left` and `right`. For + example: + + image::images/tiger.png["Tiger image",align="left"] + +- The optional `float` attribute floats the image `left` or `right` on + the page (works with HTML outputs only, has no effect on DocBook + outputs). `float` and `align` attributes are mutually exclusive. + Use the `unfloat::[]` block macro to stop floating. + +Comment Lines +^^^^^^^^^^^^^ +See <<X25,comment block macro>>. + +Block Macros +~~~~~~~~~~~~ +A Block macro reference must be contained in a single line separated +either side by a blank line or a block delimiter. + +Block macros behave just like Inline macros, with the following +differences: + +- They occur in a block context. +- The default syntax is `<name>::<target>[<attrlist>]` (two + colons, not one). +- Markup template section names end in `-blockmacro` instead of + `-inlinemacro`. + +Block Identifier +^^^^^^^^^^^^^^^^ +The Block Identifier macro sets the `id` attribute and has the same +syntax as the <<X30,anchor inline macro>> since it performs +essentially the same function -- block templates use the `id` +attribute as a block element ID. For example: + + [[X30]] + +This is equivalent to the `[id="X30"]` <<X79,AttributeList element>>). + +[[X49]] +Images +^^^^^^ +The 'image' block macro is used to display images in a block context. +The syntax is: + + image::<target>[<attributes>] + +The block `image` macro has the same <<X55,macro attributes>> as it's +<<X9,inline image macro>> counterpart. + +Block images can be titled by preceding the 'image' macro with a +'BlockTitle'. DocBook toolchains normally number titled block images +and optionally list them in an automatically generated 'List of +Figures' backmatter section. + +This example: + + .Main circuit board + image::images/layout.png[J14P main circuit board] + +is equivalent to: + + image::images/layout.png["J14P main circuit board", + title="Main circuit board"] + +A title prefix that can be inserted with the `caption` attribute +(HTML backends). For example: + + .Main circuit board + [caption="Figure 2: "] + image::images/layout.png[J14P main circuit board] + +[[X66]] +.Embedding images in XHTML documents +********************************************************************* +If you define the `data-uri` attribute then images will be embedded in +XHTML outputs using the +http://en.wikipedia.org/wiki/Data:_URI_scheme[data URI scheme]. You +can use the 'data-uri' attribute with the 'xhtml11' and 'html5' +backends to produce single-file XHTML documents with embedded images +and CSS, for example: + + $ asciidoc -a data-uri mydocument.txt + +[NOTE] +====== +- All current popular browsers support data URIs, although versions + of Internet Explorer prior to version 8 do not. +- Some browsers limit the size of data URIs. +====== +********************************************************************* + +[[X25]] +Comment Lines +^^^^^^^^^^^^^ +Single lines starting with two forward slashes hard up against the +left margin are treated as comments. Comment lines do not appear in +the output unless the 'showcomments' attribute is defined. Comment +lines have been implemented as both block and inline macros so a +comment line can appear as a stand-alone block or within block elements +that support inline macro expansion. Example comment line: + + // This is a comment. + +If the 'showcomments' attribute is defined comment lines are written +to the output: + +- In DocBook the comment lines are enclosed by the 'remark' element + (which may or may not be rendered by your toolchain). +- The 'showcomments' attribute does not expose <<X26,Comment Blocks>>. + Comment Blocks are never passed to the output. + +System Macros +~~~~~~~~~~~~~ +System macros are block macros that perform a predefined task and are +hardwired into the asciidoc(1) program. + +- You can escape system macros with a leading backslash character + (as you can with other macros). +- The syntax and tasks performed by system macros is built into + asciidoc(1) so they don't appear in configuration files. You can + however customize the syntax by adding entries to a configuration + file `[macros]` section. + +[[X63]] +Include Macros +^^^^^^^^^^^^^^ +The `include` and `include1` system macros to include the contents of +a named file into the source document. + +The `include` macro includes a file as if it were part of the parent +document -- tabs are expanded and system macros processed. The +contents of `include1` files are not subject to tab expansion or +system macro processing nor are attribute or lower priority +substitutions performed. The `include1` macro's intended use is to +include verbatim embedded CSS or scripts into configuration file +headers. Example: + +------------------------------------ +\include::chapter1.txt[tabsize=4] +------------------------------------ + +.Include macro behavior +- If the included file name is specified with a relative path then the + path is relative to the location of the referring document. +- Include macros can appear inside configuration files. +- Files included from within 'DelimitedBlocks' are read to completion + to avoid false end-of-block underline termination. +- Attribute references are expanded inside the include 'target'; if an + attribute is undefined then the included file is silently skipped. +- The 'tabsize' macro attribute sets the number of space characters to + be used for tab expansion in the included file (not applicable to + `include1` macro). +- The 'depth' macro attribute sets the maximum permitted number of + subsequent nested includes (not applicable to `include1` macro which + does not process nested includes). Setting 'depth' to '1' disables + nesting inside the included file. By default, nesting is limited to + a depth of ten. +- If the he 'warnings' attribute is set to 'False' (or any other + Python literal that evaluates to boolean false) then no warning + message is printed if the included file does not exist. By default + 'warnings' are enabled. +- 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. To inhibit nested substitution in + included files it is preferable to use the `include` macro and set + the attribute `depth=1`. + +Conditional Inclusion Macros +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Lines of text in the source document can be selectively included or +excluded from processing based on the existence (or not) of a document +attribute. + +Document text between the `ifdef` and `endif` macros is included if a +document attribute is defined: + + ifdef::<attribute>[] + : + endif::<attribute>[] + +Document text between the `ifndef` and `endif` macros is not included +if a document attribute is defined: + + ifndef::<attribute>[] + : + endif::<attribute>[] + +`<attribute>` is an attribute name which is optional in the trailing +`endif` macro. + +If you only want to process a single line of text then the text can be +put inside the square brackets and the `endif` macro omitted, for +example: + + ifdef::revnumber[Version number 42] + +Is equivalent to: + + ifdef::revnumber[] + Version number 42 + endif::revnumber[] + +'ifdef' and 'ifndef' macros also accept multiple attribute names: + +- Multiple ',' separated attribute names evaluate to defined if one + or more of the attributes is defined, otherwise it's value is + undefined. +- Multiple '+' separated attribute names evaluate to defined if all + of the attributes is defined, otherwise it's value is undefined. + +Document text between the `ifeval` and `endif` macros is included if +the Python expression inside the square brackets is true. Example: + + ifeval::[{rs458}==2] + : + endif::[] + +- Document attribute references are expanded before the expression is + evaluated. +- If an attribute reference is undefined then the expression is + considered false. + +Take a look at the `*.conf` configuration files in the AsciiDoc +distribution for examples of conditional inclusion macro usage. + +Executable system macros +^^^^^^^^^^^^^^^^^^^^^^^^ +The 'eval', 'sys' and 'sys2' block macros exhibit the same behavior as +their same named <<X24, system attribute references>>. The difference +is that system macros occur in a block macro context whereas system +attributes are confined to inline contexts where attribute +substitution is enabled. + +The following example displays a long directory listing inside a +literal block: + + ------------------ + sys::[ls -l *.txt] + ------------------ + +NOTE: There are no block macro versions of the 'eval3' and 'sys3' +system attributes. + +Template System Macro +^^^^^^^^^^^^^^^^^^^^^ +The `template` block macro allows the inclusion of one configuration +file template section within another. The following example includes +the `[admonitionblock]` section in the `[admonitionparagraph]` +section: + + [admonitionparagraph] + template::[admonitionblock] + +.Template macro behavior +- The `template::[]` macro is useful for factoring configuration file + markup. +- `template::[]` macros cannot be nested. +- `template::[]` macro expansion is applied after all configuration + files have been read. + + +[[X77]] +Passthrough macros +~~~~~~~~~~~~~~~~~~ +Passthrough macros are analogous to <<X76,passthrough blocks>> and are +used to pass text directly to the output. The substitution performed +on the text is determined by the macro definition but can be overridden +by the `<subslist>`. The usual syntax is +`<name>:<subslist>[<passtext>]` (for inline macros) and +`<name>::<subslist>[<passtext>]` (for block macros). Passthroughs, by +definition, take precedence over all other text substitutions. + +pass:: + Inline and block. Passes text unmodified (apart from explicitly + specified substitutions). Examples: + + pass:[<q>To be or not to be</q>] + pass:attributes,quotes[<u>the '{author}'</u>] + +asciimath, latexmath:: + Inline and block. Passes text unmodified. Used for + <<X78,mathematical formulas>>. + +\+++:: + Inline and block. The triple-plus passthrough is functionally + identical to the 'pass' macro but you don't have to escape `]` + characters and you can prefix with quoted attributes in the inline + version. Example: + + Red [red]+++`sum_(i=1)\^n i=(n(n+1))/2`$+++ AsciiMathML formula + +$$:: + Inline and block. The double-dollar passthrough is functionally + identical to the triple-plus passthrough with one exception: special + characters are escaped. Example: + + $$`[[a,b],[c,d]]((n),(k))`$$ + +[[X80]]`:: + Text quoted with single backtick characters constitutes an 'inline + literal' passthrough. The enclosed text is rendered in a monospaced + font and is only subject to special character substitution. This + makes sense since monospace text is usually intended to be rendered + literally and often contains characters that would otherwise have to + be escaped. If you need monospaced text containing inline + substitutions use a <<X81,plus character instead of a backtick>>. + +Macro Definitions +~~~~~~~~~~~~~~~~~ +Each entry in the configuration `[macros]` section is a macro +definition which can take one of the following forms: + +`<pattern>=<name>[<subslist]`:: Inline macro definition. +`<pattern>=#<name>[<subslist]`:: Block macro definition. +`<pattern>=+<name>[<subslist]`:: System macro definition. +`<pattern>`:: Delete the existing macro with this `<pattern>`. + +`<pattern>` is a Python regular expression and `<name>` is the name of +a markup template. If `<name>` is omitted then it is the value of the +regular expression match group named 'name'. The optional +`[<subslist]` is a comma-separated list of substitution names enclosed +in `[]` brackets, it sets the default substitutions for passthrough +text, if omitted then no passthrough substitutions are performed. + +.Pattern named groups +The following named groups can be used in macro `<pattern>` regular +expressions and are available as markup template attributes: + +name:: + The macro name. + +target:: + The macro target. + +attrlist:: + The macro attribute list. + +passtext:: + Contents of this group are passed unmodified to the output subject + only to 'subslist' substitutions. + +subslist:: + Processed as a comma-separated list of substitution names for + 'passtext' substitution, overrides the the macro definition + 'subslist'. + +.Here's what happens during macro substitution +- Each contextually relevant macro 'pattern' from the `[macros]` + section is matched against the input source line. +- If a match is found the text to be substituted is loaded from a + configuration markup template section named like + `<name>-inlinemacro` or `<name>-blockmacro` (depending on the macro + type). +- Global and macro attribute list attributes are substituted in the + macro's markup template. +- The substituted template replaces the macro reference in the output + document. + + +[[X98]] +HTML 5 audio and video block macros +----------------------------------- +The 'html5' backend 'audio' and 'video' block macros generate the HTML +5 'audio' and 'video' elements respectively. They follow the usual +AsciiDoc block macro syntax `<name>::<target>[<attrlist>]` where: + +[horizontal] +`<name>`:: 'audio' or 'video'. +`<target>`:: The URL or file name of the video or audio file. +`<attrlist>`:: A list of named attributes (see below). + +.Audio macro attributes +[options="header",cols="1,5",frame="topbot"] +|==================================================================== +|Name | Value +|options +|A comma separated list of one or more of the following items: +'autoplay', 'loop' which correspond to the same-named HTML 5 'audio' +element boolean attributes. By default the player 'controls' are +enabled, include the 'nocontrols' option value to hide them. +|==================================================================== + +.Video macro attributes +[options="header",cols="1,5",frame="topbot"] +|==================================================================== +|Name | Value +|height | The height of the player in pixels. +|width | The width of the player in pixels. +|poster | The URL or file name of an image representing the video. +|options +|A comma separated list of one or more of the following items: +'autoplay', 'loop' and 'nocontrols'. The 'autoplay' and 'loop' options +correspond to the same-named HTML 5 'video' element boolean +attributes. By default the player 'controls' are enabled, include the +'nocontrols' option value to hide them. +|==================================================================== + +Examples: + +--------------------------------------------------------------------- +audio::images/example.ogg[] + +video::gizmo.ogv[width=200,options="nocontrols,autoplay"] + +.Example video +video::gizmo.ogv[] + +video::http://www.808.dk/pics/video/gizmo.ogv[] +--------------------------------------------------------------------- + +If your needs are more complex put raw HTML 5 in a markup block, for +example (from http://www.808.dk/?code-html-5-video): + +--------------------------------------------------------------------- +++++ +<video poster="pics/video/gizmo.jpg" id="video" style="cursor: pointer;" > + <source src="pics/video/gizmo.mp4" /> + <source src="pics/video/gizmo.webm" type="video/webm" /> + <source src="pics/video/gizmo.ogv" type="video/ogg" /> + Video not playing? <a href="pics/video/gizmo.mp4">Download file</a> instead. +</video> + +<script type="text/javascript"> + var video = document.getElementById('video'); + video.addEventListener('click',function(){ + video.play(); + },false); +</script> +++++ +--------------------------------------------------------------------- + + +Tables +------ +The AsciiDoc table syntax looks and behaves like other delimited block +types and supports standard <<X73,block configuration entries>>. +Formatting is easy to read and, just as importantly, easy to enter. + +- Cells and columns can be formatted using built-in customizable styles. +- Horizontal and vertical cell alignment can be set on columns and + cell. +- Horizontal and vertical cell spanning is supported. + +.Use tables sparingly +********************************************************************* +When technical users first start creating documents, tables (complete +with column spanning and table nesting) are often considered very +important. The reality is that tables are seldom used, even in +technical documentation. + +Try this exercise: thumb through your library of technical books, +you'll be surprised just how seldom tables are actually used, even +less seldom are tables containing block elements (such as paragraphs +or lists) or spanned cells. This is no accident, like figures, tables +are outside the normal document flow -- tables are for consulting not +for reading. + +Tables are designed for, and should normally only be used for, +displaying column oriented tabular data. +********************************************************************* + +Example tables +~~~~~~~~~~~~~~ + +.Simple table +[width="15%"] +|======= +|1 |2 |A +|3 |4 |B +|5 |6 |C +|======= + +.AsciiDoc source +--------------------------------------------------------------------- +[width="15%"] +|======= +|1 |2 |A +|3 |4 |B +|5 |6 |C +|======= +--------------------------------------------------------------------- + +.Columns formatted with strong, monospaced and emphasis styles +[width="50%",cols=">s,^m,e",frame="topbot",options="header,footer"] +|========================== +| 2+|Columns 2 and 3 +|1 |Item 1 |Item 1 +|2 |Item 2 |Item 2 +|3 |Item 3 |Item 3 +|4 |Item 4 |Item 4 +|footer 1|footer 2|footer 3 +|========================== + +.AsciiDoc source +--------------------------------------------------------------------- +.An example table +[width="50%",cols=">s,^m,e",frame="topbot",options="header,footer"] +|========================== +| 2+|Columns 2 and 3 +|1 |Item 1 |Item 1 +|2 |Item 2 |Item 2 +|3 |Item 3 |Item 3 +|4 |Item 4 |Item 4 +|footer 1|footer 2|footer 3 +|========================== +--------------------------------------------------------------------- + +.Horizontal and vertical source data +[width="80%",cols="3,^2,^2,10",options="header"] +|========================================================= +|Date |Duration |Avg HR |Notes + +|22-Aug-08 |10:24 | 157 | +Worked out MSHR (max sustainable heart rate) by going hard +for this interval. + +|22-Aug-08 |23:03 | 152 | +Back-to-back with previous interval. + +|24-Aug-08 |40:00 | 145 | +Moderately hard interspersed with 3x 3min intervals (2min +hard + 1min really hard taking the HR up to 160). + +|========================================================= + +Short cells can be entered horizontally, longer cells vertically. The +default behavior is to strip leading and trailing blank lines within a +cell. These characteristics aid readability and data entry. + +.AsciiDoc source +--------------------------------------------------------------------- +.Windtrainer workouts +[width="80%",cols="3,^2,^2,10",options="header"] +|========================================================= +|Date |Duration |Avg HR |Notes + +|22-Aug-08 |10:24 | 157 | +Worked out MSHR (max sustainable heart rate) by going hard +for this interval. + +|22-Aug-08 |23:03 | 152 | +Back-to-back with previous interval. + +|24-Aug-08 |40:00 | 145 | +Moderately hard interspersed with 3x 3min intervals (2min +hard + 1min really hard taking the HR up to 160). + +|========================================================= +--------------------------------------------------------------------- + +.A table with externally sourced CSV data +[format="csv",cols="^1,4*2",options="header"] +|=================================================== +ID,Customer Name,Contact Name,Customer Address,Phone +include::customers.csv[] +|=================================================== + +.AsciiDoc source +--------------------------------------------------------------------- +[format="csv",cols="^1,4*2",options="header"] +|=================================================== +ID,Customer Name,Contact Name,Customer Address,Phone +\include::customers.csv[] +|=================================================== +--------------------------------------------------------------------- + + +.Cell spans, alignments and styles +[cols="e,m,^,>s",width="25%"] +|============================ +|1 >s|2 |3 |4 +^|5 2.2+^.^|6 .3+<.>m|7 +^|8 +|9 2+>|10 +|============================ + +.AsciiDoc source +--------------------------------------------------------------------- +[cols="e,m,^,>s",width="25%"] +|============================ +|1 >s|2 |3 |4 +^|5 2.2+^.^|6 .3+<.>m|7 +^|8 +|9 2+>|10 +|============================ +--------------------------------------------------------------------- + +[[X68]] +Table input data formats +~~~~~~~~~~~~~~~~~~~~~~~~ +AsciiDoc table data can be 'psv', 'dsv' or 'csv' formatted. The +default table format is 'psv'. + +AsciiDoc 'psv' ('Prefix Separated Values') and 'dsv' ('Delimiter +Separated Values') formats are cell oriented -- the table is treated +as a sequence of cells -- there are no explicit row separators. + +- 'psv' prefixes each cell with a separator whereas 'dsv' delimits + cells with a separator. +- 'psv' and 'dsv' separators are Python regular expressions. +- The default 'psv' separator contains <<X84, cell specifier>> related + named regular expression groups. +- The default 'dsv' separator is `:|\n` (a colon or a new line + character). +- 'psv' and 'dsv' cell separators can be escaped by preceding them + with a backslash character. + +Here are four 'psv' cells (the second item spans two columns; the +last contains an escaped separator): + + |One 2+|Two and three |A \| separator character + +'csv' is the quasi-standard row oriented 'Comma Separated Values +(CSV)' format commonly used to import and export spreadsheet and +database data. + +[[X69]] +Table attributes +~~~~~~~~~~~~~~~~ +Tables can be customized by the following attributes: + +format:: +'psv' (default), 'dsv' or 'csv' (See <<X68, Table Data Formats>>). + +separator:: +The cell separator. A Python regular expression ('psv' and 'dsv' +formats) or a single character ('csv' format). + +frame:: +Defines the table border and can take the following values: 'topbot' +(top and bottom), 'all' (all sides), 'none' and 'sides' (left and +right sides). The default value is 'all'. + +grid:: +Defines which ruler lines are drawn between table rows and columns. +The 'grid' attribute value can be any of the following values: 'none', +'cols', 'rows' and 'all'. The default value is 'all'. + +align:: +Use the 'align' attribute to horizontally align the table on the +page (works with HTML outputs only, has no effect on DocBook outputs). +The following values are valid: 'left', 'right', and 'center'. + +float:: +Use the 'float' attribute to float the table 'left' or 'right' on the +page (works with HTML outputs only, has no effect on DocBook outputs). +Floating only makes sense in conjunction with a table 'width' +attribute value of less than 100% (otherwise the table will take up +all the available space). 'float' and 'align' attributes are mutually +exclusive. Use the `unfloat::[]` block macro to stop floating. + +halign:: +Use the 'halign' attribute to horizontally align all cells in a table. +The following values are valid: 'left', 'right', and 'center' +(defaults to 'left'). Overridden by <<X70,Column specifiers>> and +<<X84,Cell specifiers>>. + +valign:: +Use the 'valign' attribute to vertically align all cells in a table. +The following values are valid: 'top', 'bottom', and 'middle' +(defaults to 'top'). Overridden by <<X70,Column specifiers>> and +<<X84,Cell specifiers>>. + +options:: +The 'options' attribute can contain comma separated values, for +example: 'header', 'footer'. By default header and footer rows are +omitted. See <<X74,attribute options>> for a complete list of +available table options. + +cols:: +The 'cols' attribute is a comma separated list of <<X70,column +specifiers>>. For example `cols="2<p,2*,4p,>"`. + +- If 'cols' is present it must specify all columns. +- If the 'cols' attribute is not specified the number of columns is + calculated as the number of data items in the *first line* of the + table. +- The degenerate form for the 'cols' attribute is an integer + specifying the number of columns e.g. `cols=4`. + +width:: +The 'width' attribute is expressed as a percentage value +('"1%"'...'"99%"'). The width specifies the table width relative to +the available width. HTML backends use this value to set the table +width attribute. It's a bit more complicated with DocBook, see the +<<X89,DocBook table widths>> sidebar. + +filter:: +The 'filter' attribute defines an external shell command that is +invoked for each cell. The built-in 'asciidoc' table style is +implemented using a filter. + +[[X89]] +.DocBook table widths +********************************************************************** +The AsciiDoc docbook backend generates CALS tables. CALS tables do not +support a table width attribute -- table width can only be controlled +by specifying absolute column widths. + +Specifying absolute column widths is not media independent because +different presentation media have different physical dimensions. To +get round this limitation both +http://www.sagehill.net/docbookxsl/Tables.html#TableWidth[DocBook XSL +Stylesheets] and +http://dblatex.sourceforge.net/doc/manual/ch03s05.html#sec-table-width[dblatex] +have implemented table width processing instructions for setting the +table width as a percentage of the available width. AsciiDoc emits +these processing instructions if the 'width' attribute is set along +with proportional column widths (the AsciiDoc docbook backend +'pageunits' attribute defaults to '*'). + +To generate DocBook tables with absolute column widths set the +'pageunits' attribute to a CALS absolute unit such as 'pt' and set the +'pagewidth' attribute to match the width of the presentation media. +********************************************************************** + +[[X70]] +Column Specifiers +~~~~~~~~~~~~~~~~~ +Column specifiers define how columns are rendered and appear in the +table <<X69,cols attribute>>. A column specifier consists of an +optional column multiplier followed by optional alignment, width and +style values and is formatted like: + + [<multiplier>*][<align>][<width>][<style>] + +- All components are optional. The multiplier must be first and the + style last. The order of `<align>` or `<width>` is not important. +- Column `<width>` can be either an integer proportional value (1...) + or a percentage (1%...100%). The default value is 1. To ensure + portability across different backends, there is no provision for + absolute column widths (not to be confused with output column width + <<X72,markup attributes>> which are available in both percentage and + absolute units). +- The '<align>' column alignment specifier is formatted like: + + [<horizontal>][.<vertical>] ++ +Where `<horizontal>` and `<vertical>` are one of the following +characters: `<`, `^` or `>` which represent 'left', 'center' and +'right' horizontal alignment or 'top', 'middle' and 'bottom' vertical +alignment respectively. + +- A `<multiplier>` can be used to specify repeated columns e.g. + `cols="4*<"` specifies four left-justified columns. The default + multiplier value is 1. +- The `<style>` name specifies a <<X71,table style>> to used to markup + column cells (you can use the full style names if you wish but the + first letter is normally sufficient). +- Column specific styles are not applied to header rows. + +[[X84]] +Cell Specifiers +~~~~~~~~~~~~~~~ +Cell specifiers allow individual cells in 'psv' formatted tables to be +spanned, multiplied, aligned and styled. Cell specifiers prefix 'psv' +`|` delimiters and are formatted like: + + [<span>*|+][<align>][<style>] + +- '<span>' specifies horizontal and vertical cell spans ('+' operator) or + the number of times the cell is replicated ('*' operator). '<span>' + is formatted like: + + [<colspan>][.<rowspan>] ++ +Where `<colspan>` and `<rowspan>` are integers specifying the number of +columns and rows to span. + +- `<align>` specifies horizontal and vertical cell alignment an is the + same as in <<X70,column specifiers>>. +- A `<style>` value is the first letter of <<X71,table style>> name. + +For example, the following 'psv' formatted cell will span two columns +and the text will be centered and emphasized: + + `2+^e| Cell text` + +[[X71]] +Table styles +~~~~~~~~~~~~ +Table styles can be applied to the entire table (by setting the +'style' attribute in the table's attribute list) or on a per column +basis (by specifying the style in the table's <<X69,cols attribute>>). +Table data can be formatted using the following predefined styles: + +default:: +The default style: AsciiDoc inline text formatting; blank lines are +treated as paragraph breaks. + +emphasis:: +Like default but all text is emphasised. + +monospaced:: +Like default but all text is in a monospaced font. + +strong:: +Like default but all text is bold. + +header:: +Apply the same style as the table header. Normally used to create a +vertical header in the first column. + +asciidoc:: +With this style table cells can contain any of the AsciiDoc elements +that are allowed inside document sections. This style runs asciidoc(1) +as a filter to process cell contents. See also <<X83,Docbook table +limitations>>. + +literal:: +No text formatting; monospaced font; all line breaks are retained +(the same as the AsciiDoc <<X65,LiteralBlock>> element). + +verse:: +All line breaks are retained (just like the AsciiDoc <<X94,verse +paragraph style>>). + +[[X72]] +Markup attributes +~~~~~~~~~~~~~~~~~ +AsciiDoc makes a number of attributes available to table markup +templates and tags. Column specific attributes are available when +substituting the 'colspec' cell data tags. + +pageunits:: +DocBook backend only. Specifies table column absolute width units. +Defaults to '*'. + +pagewidth:: +DocBook backend only. The nominal output page width in 'pageunit' +units. Used to calculate CALS tables absolute column and table +widths. Defaults to '425'. + +tableabswidth:: +Integer value calculated from 'width' and 'pagewidth' attributes. +In 'pageunit' units. + +tablepcwidth:: +Table width expressed as a percentage of the available width. Integer +value (0..100). + +colabswidth:: +Integer value calculated from 'cols' column width, 'width' and +'pagewidth' attributes. In 'pageunit' units. + +colpcwidth:: +Column width expressed as a percentage of the table width. Integer +value (0..100). + +colcount:: +Total number of table columns. + +rowcount:: +Total number of table rows. + +halign:: +Horizontal cell content alignment: 'left', 'right' or 'center'. + +valign:: +Vertical cell content alignment: 'top', 'bottom' or 'middle'. + +colnumber, colstart:: +The number of the leftmost column occupied by the cell (1...). + +colend:: +The number of the rightmost column occupied by the cell (1...). + +colspan:: +Number of columns the cell should span. + +rowspan:: +Number of rows the cell should span (1...). + +morerows:: +Number of additional rows the cell should span (0...). + +Nested tables +~~~~~~~~~~~~~ +An alternative 'psv' separator character '!' can be used (instead of +'|') in nested tables. This allows a single level of table nesting. +Columns containing nested tables must use the 'asciidoc' style. An +example can be found in `./examples/website/newtables.txt`. + +[[X83]] +DocBook table limitations +~~~~~~~~~~~~~~~~~~~~~~~~~ +Fully implementing tables is not trivial, some DocBook toolchains do +better than others. AsciiDoc HTML table outputs are rendered +correctly in all the popular browsers -- if your DocBook generated +tables don't look right compare them with the output generated by the +AsciiDoc 'xhtml11' backend or try a different DocBook toolchain. Here +is a list of things to be aware of: + +- Although nested tables are not legal in DocBook 4 the FOP and + dblatex toolchains will process them correctly. If you use `a2x(1)` + you will need to include the `--no-xmllint` option to suppress + DocBook validation errors. ++ +NOTE: In theory you can nest DocBook 4 tables one level using the +'entrytbl' element, but not all toolchains process 'entrytbl'. + +- DocBook only allows a subset of block elements inside table cells so + not all AsciiDoc elements produce valid DocBook inside table cells. + If you get validation errors running `a2x(1)` try the `--no-xmllint` + option, toolchains will often process nested block elements such as + sidebar blocks and floating titles correctly even though, strictly + speaking, they are not legal. + +- Text formatting in cells using the 'monospaced' table style will + raise validation errors because the DocBook 'literal' element was + not designed to support formatted text (using the 'literal' element + is a kludge on the part of AsciiDoc as there is no easy way to set + the font style in DocBook. + +- Cell alignments are ignored for 'verse', 'literal' or 'asciidoc' + table styles. + + +[[X1]] +Manpage Documents +----------------- +Sooner or later, if you program in a UNIX environment, you're going +to have to write a man page. + +By observing a couple of additional conventions (detailed below) you +can write AsciiDoc files that will generate HTML and PDF man pages +plus the native manpage roff format. The easiest way to generate roff +manpages from AsciiDoc source is to use the a2x(1) command. The +following example generates a roff formatted manpage file called +`asciidoc.1` (a2x(1) uses asciidoc(1) to convert `asciidoc.1.txt` to +DocBook which it then converts to roff using DocBook XSL Stylesheets): + + a2x --doctype manpage --format manpage asciidoc.1.txt + +.Viewing and printing manpage files +********************************************************************** +Use the `man(1)` command to view the manpage file: + + $ man -l asciidoc.1 + +To print a high quality man page to a postscript printer: + + $ man -l -Tps asciidoc.1 | lpr + +You could also create a PDF version of the man page by converting +PostScript to PDF using `ps2pdf(1)`: + + $ man -l -Tps asciidoc.1 | ps2pdf - asciidoc.1.pdf + +The `ps2pdf(1)` command is included in the Ghostscript distribution. +********************************************************************** + +To find out more about man pages view the `man(7)` manpage +(`man 7 man` and `man man-pages` commands). + + +Document Header +~~~~~~~~~~~~~~~ +A manpage document Header is mandatory. The title line contains the +man page name followed immediately by the manual section number in +brackets, for example 'ASCIIDOC(1)'. The title name should not contain +white space and the manual section number is a single digit optionally +followed by a single character. + +The NAME Section +~~~~~~~~~~~~~~~~ +The first manpage section is mandatory, must be titled 'NAME' and must +contain a single paragraph (usually a single line) consisting of a +list of one or more comma separated command name(s) separated from the +command purpose by a dash character. The dash must have at least one +white space character on either side. For example: + + printf, fprintf, sprintf - print formatted output + +The SYNOPSIS Section +~~~~~~~~~~~~~~~~~~~~ +The second manpage section is mandatory and must be titled 'SYNOPSIS'. + +refmiscinfo attributes +~~~~~~~~~~~~~~~~~~~~~~ +In addition to the automatically created man page <<X60,intrinsic +attributes>> you can assign DocBook +http://www.docbook.org/tdg5/en/html/refmiscinfo.html[refmiscinfo] +element 'source', 'version' and 'manual' values using AsciiDoc +`{mansource}`, `{manversion}` and `{manmanual}` attributes +respectively. This example is from the AsciiDoc header of a man page +source file: + + :man source: AsciiDoc + :man version: {revnumber} + :man manual: AsciiDoc Manual + + +[[X78]] +Mathematical Formulas +--------------------- +The 'asciimath' and 'latexmath' <<X77,passthrough macros>> along with +'asciimath' and 'latexmath' <<X76,passthrough blocks>> provide a +(backend dependent) mechanism for rendering mathematical formulas. You +can use the following math markups: + +NOTE: The 'latexmath' macro used to include 'LaTeX Math' in DocBook +outputs is not the same as the 'latexmath' macro used to include +'LaTeX MathML' in XHTML outputs. 'LaTeX Math' applies to DocBook +outputs that are processed by <<X31,dblatex>> and is normally used to +generate PDF files. 'LaTeXMathML' is very much a subset of 'LaTeX +Math' and applies to XHTML documents. + +LaTeX Math +~~~~~~~~~~ +ftp://ftp.ams.org/pub/tex/doc/amsmath/short-math-guide.pdf[LaTeX +math] can be included in documents that are processed by +<<X31,dblatex(1)>>. Example inline formula: + + latexmath:[$C = \alpha + \beta Y^{\gamma} + \epsilon$] + +For more examples see the {website}[AsciiDoc website] or the +distributed `doc/latexmath.txt` file. + +ASCIIMathML +~~~~~~~~~~~ +///////////////////////////////////////////////////////////////////// +The older ASCIIMathML 1.47 version is used instead of version 2 +because: + +1. Version 2 doesn't work when embedded. +2. Version 2 is much larger. +///////////////////////////////////////////////////////////////////// + +http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML] +formulas can be included in XHTML documents generated using the +'xhtml11' and 'html5' backends. To enable ASCIIMathML support you must +define the 'asciimath' attribute, for example using the `-a asciimath` +command-line option. Example inline formula: + + asciimath:[`x/x={(1,if x!=0),(text{undefined},if x=0):}`] + +For more examples see the {website}[AsciiDoc website] or the +distributed `doc/asciimathml.txt` file. + +LaTeXMathML +~~~~~~~~~~~ +///////////////////////////////////////////////////////////////////// +There is an http://math.etsu.edu/LaTeXMathML/[extended LaTeXMathML +version] by Jeff Knisley, in addition to a JavaScript file it requires +the inclusion of a CSS file. +///////////////////////////////////////////////////////////////////// + +'LaTeXMathML' allows LaTeX Math style formulas to be included in XHTML +documents generated using the AsciiDoc 'xhtml11' and 'html5' backends. +AsciiDoc uses the +http://www.maths.nottingham.ac.uk/personal/drw/lm.html[original +LaTeXMathML] by Douglas Woodall. 'LaTeXMathML' is derived from +ASCIIMathML and is for users who are more familiar with or prefer +using LaTeX math formulas (it recognizes a subset of LaTeX Math, the +differences are documented on the 'LaTeXMathML' web page). To enable +LaTeXMathML support you must define the 'latexmath' attribute, for +example using the `-a latexmath` command-line option. Example inline +formula: + + latexmath:[$\sum_{n=1}^\infty \frac{1}{2^n}$] + +For more examples see the {website}[AsciiDoc website] or the +distributed `doc/latexmathml.txt` file. + +MathML +~~~~~~ +http://www.w3.org/Math/[MathML] is a low level XML markup for +mathematics. AsciiDoc has no macros for MathML but users familiar with +this markup could use passthrough macros and passthrough blocks to +include MathML in output documents. + + +[[X7]] +Configuration Files +------------------- +AsciiDoc source file syntax and output file markup is largely +controlled by a set of cascading, text based, configuration files. At +runtime The AsciiDoc default configuration files are combined with +optional user and document specific configuration files. + +Configuration File Format +~~~~~~~~~~~~~~~~~~~~~~~~~ +Configuration files contain named sections. Each section begins with a +section name in square brackets []. The section body consists of the +lines of text between adjacent section headings. + +- Section names consist of one or more alphanumeric, underscore or + dash characters and cannot begin or end with a dash. +- Lines starting with a '#' character are treated as comments and + ignored. +- If the section name is prefixed with a '+' character then the + section contents is appended to the contents of an already existing + same-named section. +- Otherwise same-named sections and section entries override + previously loaded sections and section entries (this is sometimes + referred to as 'cascading'). Consequently, downstream configuration + files need only contain those sections and section entries that need + to be overridden. + +TIP: When creating custom configuration files you only need to include +the sections and entries that differ from the default configuration. + +TIP: The best way to learn about configuration files is to read the +default configuration files in the AsciiDoc distribution in +conjunction with asciidoc(1) output files. You can view configuration +file load sequence by turning on the asciidoc(1) `-v` (`--verbose`) +command-line option. + +AsciiDoc reserves the following section names for specific purposes: + +miscellaneous:: + Configuration options that don't belong anywhere else. +attributes:: + Attribute name/value entries. +specialcharacters:: + Special characters reserved by the backend markup. +tags:: + Backend markup tags. +quotes:: + Definitions for quoted inline character formatting. +specialwords:: + Lists of words and phrases singled out for special markup. +replacements, replacements2, replacements3:: + Find and replace substitution definitions. +specialsections:: + Used to single out special section names for specific markup. +macros:: + Macro syntax definitions. +titles:: + Heading, section and block title definitions. +paradef-*:: + Paragraph element definitions. +blockdef-*:: + DelimitedBlock element definitions. +listdef-*:: + List element definitions. +listtags-*:: + List element tag definitions. +tabledef-*:: + Table element definitions. +tabletags-*:: + Table element tag definitions. + +Each line of text in these sections is a 'section entry'. Section +entries share the following syntax: + +name=value:: + The entry value is set to value. +name=:: + The entry value is set to a zero length string. +name!:: + The entry is undefined (deleted from the configuration). This + syntax only applies to 'attributes' and 'miscellaneous' + sections. + +.Section entry behavior +- All equals characters inside the `name` must be escaped with a + backslash character. +- `name` and `value` are stripped of leading and trailing white space. +- Attribute names, tag entry names and markup template section names + consist of one or more alphanumeric, underscore or dash characters. + Names should not begin or end with a dash. +- A blank configuration file section (one without any entries) deletes + any preceding section with the same name (applies to non-markup + template sections). + + +Miscellaneous section +~~~~~~~~~~~~~~~~~~~~~ +The optional `[miscellaneous]` section specifies the following +`name=value` options: + +newline:: + Output file line termination characters. Can include any + valid Python string escape sequences. The default value is + `\r\n` (carriage return, line feed). Should not be quoted or + contain explicit spaces (use `\x20` instead). For example: + + $ asciidoc -a 'newline=\n' -b docbook mydoc.txt + +outfilesuffix:: + The default extension for the output file, for example + `outfilesuffix=.html`. Defaults to backend name. +tabsize:: + The number of spaces to expand tab characters, for example + `tabsize=4`. Defaults to 8. A 'tabsize' of zero suppresses tab + expansion (useful when piping included files through block + filters). Included files can override this option using the + 'tabsize' attribute. +pagewidth, pageunits:: + These global table related options are documented in the + <<X4,Table Configuration File Definitions>> sub-section. + +NOTE: `[miscellaneous]` configuration file entries can be set using +the asciidoc(1) `-a` (`--attribute`) command-line option. + +Titles section +~~~~~~~~~~~~~~ +sectiontitle:: + Two line section title pattern. The entry value is a Python + regular expression containing the named group 'title'. + +underlines:: + A comma separated list of document and section title underline + character pairs starting with the section level 0 and ending + with section level 4 underline. The default setting is: + + underlines="==","--","~~","^^","++" + +sect0...sect4:: + One line section title patterns. The entry value is a Python + regular expression containing the named group 'title'. + +blocktitle:: + <<X42,BlockTitle element>> pattern. The entry value is a + Python regular expression containing the named group 'title'. + +subs:: + A comma separated list of substitutions that are performed on + the document header and section titles. Defaults to 'normal' + substitution. + +Tags section +~~~~~~~~~~~~ +The `[tags]` section contains backend tag definitions (one per +line). Tags are used to translate AsciiDoc elements to backend +markup. + +An AsciiDoc tag definition is formatted like +`<tagname>=<starttag>|<endtag>`. For example: + + emphasis=<em>|</em> + +In this example asciidoc(1) replaces the | character with the +emphasized text from the AsciiDoc input file and writes the result to +the output file. + +Use the `{brvbar}` attribute reference if you need to include a | pipe +character inside tag text. + +Attributes section +~~~~~~~~~~~~~~~~~~ +The optional `[attributes]` section contains predefined attributes. + +If the attribute value requires leading or trailing spaces then the +text text should be enclosed in quotation mark (") characters. + +To delete a attribute insert a `name!` entry in a downstream +configuration file or use the asciidoc(1) `--attribute name!` +command-line option (an attribute name suffixed with a `!` character +deletes the attribute) + +Special Characters section +~~~~~~~~~~~~~~~~~~~~~~~~~~ +The `[specialcharacters]` section specifies how to escape characters +reserved by the backend markup. Each translation is specified on a +single line formatted like: + + <special_character>=<translated_characters> + +Special characters are normally confined to those that resolve +markup ambiguity (in the case of HTML and XML markups the ampersand, +less than and greater than characters). The following example causes +all occurrences of the `<` character to be replaced by `<`. + + <=< + +Quoted Text section +~~~~~~~~~~~~~~~~~~~ +Quoting is used primarily for text formatting. The `[quotes]` section +defines AsciiDoc quoting characters and their corresponding backend +markup tags. Each section entry value is the name of a of a `[tags]` +section entry. The entry name is the character (or characters) that +quote the text. The following examples are taken from AsciiDoc +configuration files: + + [quotes] + _=emphasis + + [tags] + emphasis=<em>|</em> + +You can specify the left and right quote strings separately by +separating them with a | character, for example: + + ``|''=quoted + +Omitting the tag will disable quoting, for example, if you don't want +superscripts or subscripts put the following in a custom configuration +file or edit the global `asciidoc.conf` configuration file: + + [quotes] + ^= + ~= + +<<X52,Unconstrained quotes>> are differentiated from constrained +quotes by prefixing the tag name with a hash character, for example: + + __=#emphasis + +.Quoted text behavior +- Quote characters must be non-alphanumeric. +- To minimize quoting ambiguity try not to use the same quote + characters in different quote types. + +Special Words section +~~~~~~~~~~~~~~~~~~~~~ +The `[specialwords]` section is used to single out words and phrases +that you want to consistently format in some way throughout your +document without having to repeatedly specify the markup. The name of +each entry corresponds to a markup template section and the entry +value consists of a list of words and phrases to be marked up. For +example: + + [specialwords] + strongwords=NOTE IMPORTANT + + [strongwords] + <strong>{words}</strong> + +The examples specifies that any occurrence of `NOTE` or `IMPORTANT` +should appear in a bold font. + +Words and word phrases are treated as Python regular expressions: for +example, the word `^NOTE` would only match `NOTE` if appeared at +the start of a line. + +AsciiDoc comes with three built-in Special Word types: +'emphasizedwords', 'monospacedwords' and 'strongwords', each has a +corresponding (backend specific) markup template section. Edit the +configuration files to customize existing Special Words and to add new +ones. + +.Special word behavior +- Word list entries must be separated by space characters. +- Word list entries with embedded spaces should be enclosed in quotation (") + characters. +- A `[specialwords]` section entry of the form + +name=word1{nbsp}[word2...]+ adds words to existing `name` entries. +- A `[specialwords]` section entry of the form `name` undefines + (deletes) all existing `name` words. +- Since word list entries are processed as Python regular expressions + you need to be careful to escape regular expression special + characters. +- By default Special Words are substituted before Inline Macros, this + may lead to undesirable consequences. For example the special word + `foobar` would be expanded inside the macro call + `http://www.foobar.com[]`. A possible solution is to emphasize + whole words only by defining the word using regular expression + characters, for example `\bfoobar\b`. +- If the first matched character of a special word is a backslash then + the remaining characters are output without markup i.e. the + backslash can be used to escape special word markup. For example + the special word `\\?\b[Tt]en\b` will mark up the words `Ten` and + `ten` only if they are not preceded by a backslash. + +[[X10]] +Replacements section +~~~~~~~~~~~~~~~~~~~~ +`[replacements]`, `[replacements2]` and `[replacements3]` +configuration file entries specify find and replace text and are +formatted like: + + <find_pattern>=<replacement_text> + +The find text can be a Python regular expression; the replace text can +contain Python regular expression group references. + +Use Replacement shortcuts for often used macro references, for +example (the second replacement allows us to backslash escape the +macro name): + + NEW!=image:./images/smallnew.png[New!] + \\NEW!=NEW! + +The only difference between the three replacement types is how they +are applied. By default 'replacements' and 'replacement2' are applied +in <<X102,normal>> substitution contexts whereas 'replacements3' needs +to be configured explicitly and should only be used in backend +configuration files. + +.Replacement behavior +- The built-in replacements can be escaped with a backslash. +- If the find or replace text has leading or trailing spaces then the + text should be enclosed in quotation (") characters. +- Since the find text is processed as a regular expression you need to + be careful to escape regular expression special characters. +- Replacements are performed in the same order they appear in the + configuration file replacements section. + +Markup Template Sections +~~~~~~~~~~~~~~~~~~~~~~~~ +Markup template sections supply backend markup for translating +AsciiDoc elements. Since the text is normally backend dependent +you'll find these sections in the backend specific configuration +files. Template sections differ from other sections in that they +contain a single block of text instead of per line 'name=value' +entries. A markup template section body can contain: + +- Attribute references +- System macro calls. +- A document content placeholder + +The document content placeholder is a single | character and is +replaced by text from the source element. Use the `{brvbar}` +attribute reference if you need a literal | character in the template. + +[[X27]] +Configuration file names, precedence and locations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Configuration files have a `.conf` file name extension; they are +loaded from the following locations: + +1. The directory containing the asciidoc executable. +2. If there is no `asciidoc.conf` file in the directory containing the + asciidoc executable then load from the global configuration + directory (normally `/etc/asciidoc` or `/usr/local/etc/asciidoc`) + i.e. the global configuration files directory is skipped if + AsciiDoc configuration files are installed in the same directory as + the asciidoc executable. This allows both a system wide copy and + multiple local copies of AsciiDoc to coexist on the same host PC. +3. The user's `$HOME/.asciidoc` directory (if it exists). +4. The directory containing the AsciiDoc source file. +5. Explicit configuration files specified using: + - The `conf-files` attribute (one or more file names separated by a + `|` character). These files are loaded in the order they are + specified and prior to files specified using the `--conf-file` + command-line option. + - The asciidoc(1) `--conf-file`) command-line option. The + `--conf-file` option can be specified multiple times, in which + case configuration files will be processed in the same order they + appear on the command-line. +6. <<X100,Backend plugin>> configuration files are loaded from + subdirectories named like `backends/<backend>` in locations 1, 2 + and 3. +7. <<X59,Filter>> configuration files are loaded from subdirectories + named like `filters/<filter>` in locations 1, 2 and 3. + +Configuration files from the above locations are loaded in the +following order: + +- The `[attributes]` section only from: + * `asciidoc.conf` in location 3 + * Files from location 5. ++ +This first pass makes locally set attributes available in the global +`asciidoc.conf` file. + +- `asciidoc.conf` from locations 1, 2, 3. +- 'attributes', 'titles' and 'specialcharacters' sections from the + `asciidoc.conf` in location 4. +- The document header is parsed at this point and we can assume the + 'backend' and 'doctype' have now been defined. +- Backend plugin `<backend>.conf` and `<backend>-<doctype>.conf` files + from locations 6. If a backend plugin is not found then try + locations 1, 2 and 3 for `<backend>.conf` and + `<backend>-<doctype>.conf` backend configuration files. +- Filter conf files from locations 7. +- `lang-<lang>.conf` from locations 1, 2, 3. +- `asciidoc.conf` from location 4. +- `<backend>.conf` and `<backend>-<doctype>.conf` from location 4. +- Filter conf files from location 4. +- `<docfile>.conf` and `<docfile>-<backend>.conf` from location 4. +- Configuration files from location 5. + +Where: + +- `<backend>` and `<doctype>` are values specified by the asciidoc(1) + `-b` (`--backend`) and `-d` (`--doctype`) command-line options. +- `<infile>` is the path name of the AsciiDoc input file without the + file name extension. +- `<lang>` is a two letter country code set by the the AsciiDoc 'lang' + attribute. + +[NOTE] +===================================================================== +The backend and language global configuration files are loaded *after* +the header has been parsed. This means that you can set most +attributes in the document header. Here's an example header: + + Life's Mysteries + ================ + :author: Hu Nose + :doctype: book + :toc: + :icons: + :data-uri: + :lang: en + :encoding: iso-8859-1 + +Attributes set in the document header take precedence over +configuration file attributes. + +===================================================================== + +TIP: Use the asciidoc(1) `-v` (`--verbose`) command-line option to see +which configuration files are loaded and the order in which they are +loaded. + + +Document Attributes +------------------- +A document attribute is comprised of a 'name' and a textual 'value' +and is used for textual substitution in AsciiDoc documents and +configuration files. An attribute reference (an attribute name +enclosed in braces) is replaced by the corresponding attribute +value. Attribute names are case insensitive and can only contain +alphanumeric, dash and underscore characters. + +There are four sources of document attributes (from highest to lowest +precedence): + +- Command-line attributes. +- AttributeEntry, AttributeList, Macro and BlockId elements. +- Configuration file `[attributes]` sections. +- Intrinsic attributes. + +Within each of these divisions the last processed entry takes +precedence. + +NOTE: If an attribute is not defined then the line containing the +attribute reference is dropped. This property is used extensively in +AsciiDoc configuration files to facilitate conditional markup +generation. + + +[[X18]] +Attribute Entries +----------------- +The `AttributeEntry` block element allows document attributes to be +assigned within an AsciiDoc document. Attribute entries are added to +the global document attributes dictionary. The attribute name/value +syntax is a single line like: + + :<name>: <value> + +For example: + + :Author Initials: JB + +This will set an attribute reference `{authorinitials}` to the value +'JB' in the current document. + +To delete (undefine) an attribute use the following syntax: + + :<name>!: + +.AttributeEntry behavior +- The attribute entry line begins with colon -- no white space allowed + in left margin. +- AsciiDoc converts the `<name>` to a legal attribute name (lower + case, alphanumeric, dash and underscore characters only -- all other + characters deleted). This allows more human friendly text to be + used. +- Leading and trailing white space is stripped from the `<value>`. +- Lines ending in a space followed by a plus character are continued + to the next line, for example: + + :description: AsciiDoc is a text document format for writing notes, + + documentation, articles, books, slideshows, web pages + + and man pages. + +- If the `<value>` is blank then the corresponding attribute value is + set to an empty string. +- Attribute references contained in the entry `<value>` will be + expanded. +- By default AttributeEntry values are substituted for + `specialcharacters` and `attributes` (see above), if you want to + change or disable AttributeEntry substitution use the <<X77,pass:[] + inline macro>> syntax. +- Attribute entries in the document Header are available for header + markup template substitution. +- Attribute elements override configuration file and intrinsic + attributes but do not override command-line attributes. + +Here are some more attribute entry examples: + +--------------------------------------------------------------------- +AsciiDoc User Manual +==================== +:author: Stuart Rackham +:email: srackham@gmail.com +:revdate: April 23, 2004 +:revnumber: 5.1.1 +--------------------------------------------------------------------- + +Which creates these attributes: + + {author}, {firstname}, {lastname}, {authorinitials}, {email}, + {revdate}, {revnumber} + +The previous example is equivalent to this <<X95,document header>>: + +--------------------------------------------------------------------- +AsciiDoc User Manual +==================== +Stuart Rackham <srackham@gmail.com> +5.1.1, April 23, 2004 +--------------------------------------------------------------------- + +Setting configuration entries +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +A variant of the Attribute Entry syntax allows configuration file +section entries and markup template sections to be set from within an +AsciiDoc document: + + :<section_name>.[<entry_name>]: <entry_value> + +Where `<section_name>` is the configuration section name, +`<entry_name>` is the name of the entry and `<entry_value>` is the +optional entry value. This example sets the default labeled list +style to 'horizontal': + + :listdef-labeled.style: horizontal + +It is exactly equivalent to a configuration file containing: + + [listdef-labeled] + style=horizontal + +- If the `<entry_name>` is omitted then the entire section is + substituted with the `<entry_value>`. This feature should only be + used to set markup template sections. The following example sets the + 'xref2' inline macro markup template: + + :xref2-inlinemacro.: <a href="#{1}">{2?{2}}</a> + +- No substitution is performed on configuration file attribute entries + and they cannot be undefined. +- This feature can only be used in attribute entries -- configuration + attributes cannot be set using the asciidoc(1) command `--attribute` + option. + +[[X62]] +.Attribute entries promote clarity and eliminate repetition +********************************************************************* +URLs and file names in AsciiDoc macros are often quite long -- they +break paragraph flow and readability suffers. The problem is +compounded by redundancy if the same name is used repeatedly. +Attribute entries can be used to make your documents easier to read +and write, here are some examples: + + :1: http://freshmeat.net/projects/asciidoc/ + :homepage: http://methods.co.nz/asciidoc/[AsciiDoc home page] + :new: image:./images/smallnew.png[] + :footnote1: footnote:[A meaningless latin term] + + Using previously defined attributes: See the {1}[Freshmeat summary] + or the {homepage} for something new {new}. Lorem ispum {footnote1}. + +.Note +- The attribute entry definition must precede it's usage. +- You are not limited to URLs or file names, entire macro calls or + arbitrary lines of text can be abbreviated. +- Shared attributes entries could be grouped into a separate file and + <<X63,included>> in multiple documents. +********************************************************************* + + +[[X21]] +Attribute Lists +--------------- +- An attribute list is a comma separated list of attribute values. +- The entire list is enclosed in square brackets. +- Attribute lists are used to pass parameters to macros, blocks (using + the <<X79,AttributeList element>>) and inline quotes. + +The list consists of zero or more positional attribute values followed +by zero or more named attribute values. Here are three examples: a +single unquoted positional attribute; three unquoted positional +attribute values; one positional attribute followed by two named +attributes; the unquoted attribute value in the final example contains +comma (`,`) and double-quote (`"`) character entities: + + [Hello] + [quote, Bertrand Russell, The World of Mathematics (1956)] + ["22 times", backcolor="#0e0e0e", options="noborders,wide"] + [A footnote, "with an image" image:smallnew.png[]] + +.Attribute list behavior +- If one or more attribute values contains a comma the all string + values must be quoted (enclosed in double quotation mark + characters). +- If the list contains any named or quoted attributes then all string + attribute values must be quoted. +- To include a double quotation mark (") character in a quoted + attribute value the the quotation mark must be escaped with a + backslash. +- List attributes take precedence over existing attributes. +- List attributes can only be referenced in configuration file markup + templates and tags, they are not available elsewhere in the + document. +- Setting a named attribute to `None` undefines the attribute. +- Positional attributes are referred to as `{1}`,`{2}`,`{3}`,... +- Attribute `{0}` refers to the entire list (excluding the enclosing + square brackets). +- Named attribute names cannot contain dash characters. + +[[X75]] +Options attribute +~~~~~~~~~~~~~~~~~ +If the attribute list contains an attribute named `options` it is +processed as a comma separated list of option names: + +- Each name generates an attribute named like `<option>-option` (where + `<option>` is the option name) with an empty string value. For + example `[options="opt1,opt2,opt3"]` is equivalent to setting the + following three attributes + `[opt1-option="",opt2-option="",opt2-option=""]`. +- If you define a an option attribute globally (for example with an + <<X18,attribute entry>>) then it will apply to all elements in the + document. +- AsciiDoc implements a number of predefined options which are listed + in the <<X74,Attribute Options appendix>>. + +Macro Attribute lists +~~~~~~~~~~~~~~~~~~~~~ +Macros calls are suffixed with an attribute list. The list may be +empty but it cannot be omitted. List entries are used to pass +attribute values to macro markup templates. + + +Attribute References +-------------------- +An attribute reference is an attribute name (possibly followed by an +additional parameters) enclosed in curly braces. When an attribute +reference is encountered it is evaluated and replaced by its +corresponding text value. If the attribute is undefined the line +containing the attribute is dropped. + +There are three types of attribute reference: 'Simple', 'Conditional' +and 'System'. + +.Attribute reference evaluation +- You can suppress attribute reference expansion by placing a + backslash character immediately in front of the opening brace + character. +- By default attribute references are not expanded in + 'LiteralParagraphs', 'ListingBlocks' or 'LiteralBlocks'. +- Attribute substitution proceeds line by line in reverse line order. +- Attribute reference evaluation is performed in the following order: + 'Simple' then 'Conditional' and finally 'System'. + +Simple Attributes References +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Simple attribute references take the form `{<name>}`. If the +attribute name is defined its text value is substituted otherwise the +line containing the reference is dropped from the output. + +Conditional Attribute References +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Additional parameters are used in conjunction with attribute names to +calculate a substitution value. Conditional attribute references take +the following forms: + +`{<names>=<value>}`:: + `<value>` is substituted if the attribute `<names>` is + undefined otherwise its value is substituted. `<value>` can + contain simple attribute references. + +`{<names>?<value>}`:: + `<value>` is substituted if the attribute `<names>` is defined + otherwise an empty string is substituted. `<value>` can + contain simple attribute references. + +`{<names>!<value>}`:: + `<value>` is substituted if the attribute `<names>` is + undefined otherwise an empty string is substituted. `<value>` + can contain simple attribute references. + +`{<names>#<value>}`:: + `<value>` is substituted if the attribute `<names>` is defined + otherwise the undefined attribute entry causes the containing + line to be dropped. `<value>` can contain simple attribute + references. + +`{<names>%<value>}`:: + `<value>` is substituted if the attribute `<names>` is not + defined otherwise the containing line is dropped. `<value>` + can contain simple attribute references. + +`{<names>@<regexp>:<value1>[:<value2>]}`:: + `<value1>` is substituted if the value of attribute `<names>` + matches the regular expression `<regexp>` otherwise `<value2>` + is substituted. If attribute `<names>` is not defined the + containing line is dropped. If `<value2>` is omitted an empty + string is assumed. The values and the regular expression can + contain simple attribute references. To embed colons in the + values or the regular expression escape them with backslashes. + +`{<names>$<regexp>:<value1>[:<value2>]}`:: + Same behavior as the previous ternary attribute except for + the following cases: + + `{<names>$<regexp>:<value>}`;; + Substitutes `<value>` if `<names>` matches `<regexp>` + otherwise the result is undefined and the containing + line is dropped. + + `{<names>$<regexp>::<value>}`;; + Substitutes `<value>` if `<names>` does not match + `<regexp>` otherwise the result is undefined and the + containing line is dropped. + +The attribute `<names>` parameter normally consists of a single +attribute name but it can be any one of the following: + +- A single attribute name which evaluates to the attributes value. +- Multiple ',' separated attribute names which evaluates to an empty + string if one or more of the attributes is defined, otherwise it's + value is undefined. +- Multiple '+' separated attribute names which evaluates to an empty + string if all of the attributes are defined, otherwise it's value is + undefined. + +Conditional attributes with single attribute names are evaluated first +so they can be used inside the multi-attribute conditional `<value>`. + +Conditional attribute examples +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Conditional attributes are mainly used in AsciiDoc configuration +files -- see the distribution `.conf` files for examples. + +Attribute equality test:: + If `{backend}` is 'docbook45' or 'xhtml11' the example evaluates to + ``DocBook 4.5 or XHTML 1.1 backend'' otherwise it evaluates to + ``some other backend'': + + {backend@docbook45|xhtml11:DocBook 4.5 or XHTML 1.1 backend:some other backend} + +Attribute value map:: + This example maps the `frame` attribute values [`topbot`, `all`, + `none`, `sides`] to [`hsides`, `border`, `void`, `vsides`]: + + {frame@topbot:hsides}{frame@all:border}{frame@none:void}{frame@sides:vsides} + + +[[X24]] +System Attribute References +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +System attribute references generate the attribute text value by +executing a predefined action that is parametrized by one or more +arguments. The syntax is `{<action>:<arguments>}`. + +`{counter:<attrname>[:<seed>]}`:: + Increments the document attribute (if the attribute is + undefined it is set to `1`). Returns the new attribute value. + + - Counters generate global (document wide) attributes. + - The optional `<seed>` specifies the counter's initial value; + it can be a number or a single letter; defaults to '1'. + - `<seed>` can contain simple and conditional attribute + references. + - The 'counter' system attribute will not be executed if the + containing line is dropped by the prior evaluation of an + undefined attribute. + +`{counter2:<attrname>[:<seed>]}`:: + Same as `counter` except the it always returns a blank string. + +`{eval:<expression>}`:: + Substitutes the result of the Python `<expression>`. + + - If `<expression>` evaluates to `None` or `False` the + reference is deemed undefined and the line containing the + reference is dropped from the output. + - If the expression evaluates to `True` the attribute + evaluates to an empty string. + - `<expression>` can contain simple and conditional attribute + references. + - The 'eval' system attribute can be nested inside other + system attributes. + +`{eval3:<command>}`:: + Passthrough version of `{eval:<expression>}` -- the generated + output is written directly to the output without any further + substitutions. + +`{include:<filename>}`:: + Substitutes contents of the file named `<filename>`. + + - The included file is read at the time of attribute + substitution. + - If the file does not exist a warning is emitted and the line + containing the reference is dropped from the output file. + - Tabs are expanded based on the current 'tabsize' attribute + value. + +`{set:<attrname>[!][:<value>]}`:: + Sets or unsets document attribute. Normally only used in + configuration file markup templates (use + <<X18,AttributeEntries>> in AsciiDoc documents). + + - If the attribute name is followed by an exclamation mark + the attribute becomes undefined. + - If `<value>` is omitted the attribute is set to a blank + string. + - `<value>` can contain simple and conditional attribute + references. + - Returns a blank string unless the attribute is undefined in + which case the return value is undefined and the enclosing + line will be dropped. + +`{set2:<attrname>[!][:<value>]}`:: + Same as `set` except that the attribute scope is local to the + template. + +`{sys:<command>}`:: + Substitutes the stdout generated by the execution of the shell + `<command>`. + +`{sys2:<command>}`:: + Substitutes the stdout and stderr generated by the execution + of the shell `<command>`. + +`{sys3:<command>}`:: + Passthrough version of `{sys:<command>}` -- the generated + output is written directly to the output without any further + substitutions. + +`{template:<template>}`:: + Substitutes the contents of the configuration file section + named `<template>`. Attribute references contained in the + template are substituted. + +.System reference behavior +- System attribute arguments can contain non-system attribute + references. +- Closing brace characters inside system attribute arguments must be + escaped with a backslash. + +[[X60]] +Intrinsic Attributes +-------------------- +Intrinsic attributes are simple attributes that are created +automatically from: AsciiDoc document header parameters; asciidoc(1) +command-line arguments; attributes defined in the default +configuration files; the execution context. Here's the list of +predefined intrinsic attributes: + + {amp} ampersand (&) character entity + {asciidoc-args} used to pass inherited arguments to asciidoc filters + {asciidoc-confdir} the asciidoc(1) global configuration directory + {asciidoc-dir} the asciidoc(1) application directory + {asciidoc-file} the full path name of the asciidoc(1) script + {asciidoc-version} the version of asciidoc(1) + {author} author's full name + {authored} empty string '' if {author} or {email} defined, + {authorinitials} author initials (from document header) + {backend-<backend>} empty string '' + {<backend>-<doctype>} empty string '' + {backend} document backend specified by `-b` option + {backend-confdir} the directory containing the <backend>.conf file + {backslash} backslash character + {basebackend-<base>} empty string '' + {basebackend} html or docbook + {blockname} current block name (note 8). + {brvbar} broken vertical bar (|) character + {docdate} document last modified date + {docdir} document input directory name (note 5) + {docfile} document file name (note 5) + {docname} document file name without extension (note 6) + {doctime} document last modified time + {doctitle} document title (from document header) + {doctype-<doctype>} empty string '' + {doctype} document type specified by `-d` option + {email} author's email address (from document header) + {empty} empty string '' + {encoding} specifies input and output encoding + {filetype-<fileext>} empty string '' + {filetype} output file name file extension + {firstname} author first name (from document header) + {gt} greater than (>) character entity + {id} running block id generated by BlockId elements + {indir} input file directory name (note 2,5) + {infile} input file name (note 2,5) + {lastname} author last name (from document header) + {ldquo} Left double quote character (note 7) + {level} title level 1..4 (in section titles) + {listindex} the list index (1..) of the most recent list item + {localdate} the current date + {localtime} the current time + {lsquo} Left single quote character (note 7) + {lt} less than (<) character entity + {manname} manpage name (defined in NAME section) + {manpurpose} manpage (defined in NAME section) + {mantitle} document title minus the manpage volume number + {manvolnum} manpage volume number (1..8) (from document header) + {middlename} author middle name (from document header) + {nbsp} non-breaking space character entity + {notitle} do not display the document title + {outdir} document output directory name (note 2) + {outfile} output file name (note 2) + {python} the full path name of the Python interpreter executable + {rdquo} Right double quote character (note 7) + {reftext} running block xreflabel generated by BlockId elements + {revdate} document revision date (from document header) + {revnumber} document revision number (from document header) + {rsquo} Right single quote character (note 7) + {sectnum} formatted section number (in section titles) + {sp} space character + {showcomments} send comment lines to the output + {title} section title (in titled elements) + {two-colons} Two colon characters + {two-semicolons} Two semicolon characters + {user-dir} the ~/.asciidoc directory (if it exists) + {verbose} defined as '' if --verbose command option specified + {wj} Word-joiner + {zwsp} Zero-width space character entity + +[NOTE] +====== +1. Intrinsic attributes are global so avoid defining custom attributes + with the same names. +2. `{outfile}`, `{outdir}`, `{infile}`, `{indir}` attributes are + effectively read-only (you can set them but it won't affect the + input or output file paths). +3. See also the <<X88,Backend Attributes>> section for attributes + that relate to AsciiDoc XHTML file generation. +4. The entries that translate to blank strings are designed to be used + for conditional text inclusion. You can also use the `ifdef`, + `ifndef` and `endif` System macros for conditional inclusion. + footnote:[Conditional inclusion using `ifdef` and `ifndef` macros + differs from attribute conditional inclusion in that the former + occurs when the file is read while the latter occurs when the + contents are written.] +5. `{docfile}` and `{docdir}` refer to root document specified on the + asciidoc(1) command-line; `{infile}` and `{indir}` refer to the + current input file which may be the root document or an included + file. When the input is being read from the standard input + (`stdin`) these attributes are undefined. +6. If the input file is the standard input and the output file is not + the standard output then `{docname}` is the output file name sans + file extension. +7. See + http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks[non-English + usage of quotation marks]. +8. The `{blockname}` attribute identifies the style of the current + block. It applies to delimited blocks, lists and tables. Here is a + list of `{blockname}` values (does not include filters or custom + block and style names): + + delimited blocks:: comment, sidebar, open, pass, literal, verse, + listing, quote, example, note, tip, important, caution, warning, + abstract, partintro + + lists:: arabic, loweralpha, upperalpha, lowerroman, upperroman, + labeled, labeled3, labeled4, qanda, horizontal, bibliography, + glossary + + tables:: table + +====== + + +[[X73]] +Block Element Definitions +------------------------- +The syntax and behavior of Paragraph, DelimitedBlock, List and Table +block elements is determined by block definitions contained in +<<X7,AsciiDoc configuration file>> sections. + +Each definition consists of a section title followed by one or more +section entries. Each entry defines a block parameter controlling some +aspect of the block's behavior. Here's an example: + +--------------------------------------------------------------------- +[blockdef-listing] +delimiter=^-{4,}$ +template=listingblock +presubs=specialcharacters,callouts +--------------------------------------------------------------------- + +Configuration file block definition sections are processed +incrementally after each configuration file is loaded. Block +definition section entries are merged into the block definition, this +allows block parameters to be overridden and extended by later +<<X27,loading configuration files>>. + +AsciiDoc Paragraph, DelimitedBlock, List and Table block elements +share a common subset of configuration file parameters: + +delimiter:: + A Python regular expression that matches the first line of a block + element -- in the case of DelimitedBlocks and Tables it also matches + the last line. + +template:: + The name of the configuration file markup template section that will + envelope the block contents. The pipe ('|') character is substituted + for the block contents. List elements use a set of (list specific) + tag parameters instead of a single template. The template name can + contain attribute references allowing dynamic template selection a + the time of template substitution. + +options:: + A comma delimited list of element specific option names. In addition + to being used internally, options are available during markup tag + and template substitution as attributes with an empty string value + named like `<option>-option` (where `<option>` is the option name). + See <<X74,attribute options>> for a complete list of available + options. + +subs, presubs, postsubs:: + * 'presubs' and 'postsubs' are lists of comma separated substitutions that are + performed on the block contents. 'presubs' is applied first, + 'postsubs' (if specified) second. + + * 'subs' is an alias for 'presubs'. + + * If a 'filter' is allowed (Paragraphs, DelimitedBlocks and Tables) + and has been specified then 'presubs' and 'postsubs' substitutions + are performed before and after the filter is run respectively. + + * Allowed values: 'specialcharacters', 'quotes', 'specialwords', + 'replacements', 'macros', 'attributes', 'callouts'. + + * [[X102]]The following composite values are also allowed: + + 'none';; + No substitutions. + 'normal';; + The following substitutions in the following order: + 'specialcharacters', 'quotes', 'attributes', 'specialwords', + 'replacements', 'macros', 'replacements2'. + 'verbatim';; + The following substitutions in the following order: + 'specialcharacters' and 'callouts'. + + * 'normal' and 'verbatim' substitutions can be redefined by with + `subsnormal` and `subsverbatim` entries in a configuration file + `[miscellaneous]` section. + + * The substitutions are processed in the order in which they are + listed and can appear more than once. + +filter:: + This optional entry specifies an executable shell command for + processing block content (Paragraphs, DelimitedBlocks and Tables). + The filter command can contain attribute references. + +posattrs:: + Optional comma separated list of positional attribute names. This + list maps positional attributes (in the block's <<X21,attribute + list>>) to named block attributes. The following example, from the + QuoteBlock definition, maps the first and section positional + attributes: + + posattrs=attribution,citetitle + +style:: + This optional parameter specifies the default style name. + + +<stylename>-style:: + Optional style definition (see <<X23,Styles>> below). + +The following block parameters behave like document attributes and can +be set in block attribute lists and style definitions: 'template', +'options', 'subs', 'presubs', 'postsubs', 'filter'. + +[[X23]] +Styles +~~~~~~ +A style is a set of block parameter bundled as a single named +parameter. The following example defines a style named 'verbatim': + + verbatim-style=template="literalblock",subs="verbatim" + +If a block's <<X21,attribute list>> contains a 'style' attribute then +the corresponding style parameters are be merged into the default +block definition parameters. + +- All style parameter names must be suffixed with `-style` and the + style parameter value is in the form of a list of <<X21,named + attributes>>. +- The 'template' style parameter is mandatory, other parameters can be + omitted in which case they inherit their values from the default + block definition parameters. +- Multi-item style parameters ('subs','presubs','postsubs','posattrs') + must be specified using Python tuple syntax (rather than a simple + list of values as they in separate entries) e.g. + `postsubs=("callouts",)` not `postsubs="callouts"`. + +Paragraphs +~~~~~~~~~~ +Paragraph translation is controlled by `[paradef-*]` configuration +file section entries. Users can define new types of paragraphs and +modify the behavior of existing types by editing AsciiDoc +configuration files. + +Here is the shipped Default paragraph definition: + +-------------------------------------------------------------------- +[paradef-default] +delimiter=(?P<text>\S.*) +template=paragraph +-------------------------------------------------------------------- + +The normal paragraph definition has a couple of special properties: + +1. It must exist and be defined in a configuration file section named + `[paradef-default]`. +2. Irrespective of its position in the configuration files default + paragraph document matches are attempted only after trying all + other paragraph types. + +Paragraph specific block parameter notes: + +delimiter:: + This regular expression must contain the named group 'text' which + matches the text on the first line. Paragraphs are terminated by a + blank line, the end of file, or the start of a DelimitedBlock. + +options:: + The 'listelement' option specifies that paragraphs of this type will + automatically be considered part of immediately preceding list + items. The 'skip' option causes the paragraph to be treated as a + comment (see <<X26,CommentBlocks>>). + +.Paragraph processing proceeds as follows: +1. The paragraph text is aligned to the left margin. +2. Optional 'presubs' inline substitutions are performed on the + paragraph text. +3. If a filter command is specified it is executed and the paragraph + text piped to its standard input; the filter output replaces the + paragraph text. +4. Optional 'postsubs' inline substitutions are performed on the + paragraph text. +5. The paragraph text is enveloped by the paragraph's markup template + and written to the output file. + +Delimited Blocks +~~~~~~~~~~~~~~~~ +DelimitedBlock 'options' values are: + +sectionbody:: + The block contents are processed as a SectionBody. + +skip:: + The block is treated as a comment (see <<X26,CommentBlocks>>). + Preceding <<X21,attribute lists>> and <<X42,block titles>> are not + consumed. + +'presubs', 'postsubs' and 'filter' entries are ignored when +'sectionbody' or 'skip' options are set. + +DelimitedBlock processing proceeds as follows: + +1. Optional 'presubs' substitutions are performed on the block + contents. +2. If a filter is specified it is executed and the block's contents + piped to its standard input. The filter output replaces the block + contents. +3. Optional 'postsubs' substitutions are performed on the block + contents. +4. The block contents is enveloped by the block's markup template and + written to the output file. + +TIP: Attribute expansion is performed on the block filter command +before it is executed, this is useful for passing arguments to the +filter. + +Lists +~~~~~ +List behavior and syntax is determined by `[listdef-*]` configuration +file sections. The user can change existing list behavior and add new +list types by editing configuration files. + +List specific block definition notes: + +type:: + This is either 'bulleted','numbered','labeled' or 'callout'. + +delimiter:: + A Python regular expression that matches the first line of a + list element entry. This expression can contain the named groups + 'text' (bulleted groups), 'index' and 'text' (numbered lists), + 'label' and 'text' (labeled lists). + +tags:: + The `<name>` of the `[listtags-<name>]` configuration file section + containing list markup tag definitions. The tag entries ('list', + 'entry', 'label', 'term', 'text') map the AsciiDoc list structure to + backend markup; see the 'listtags' sections in the AsciiDoc + distributed backend `.conf` configuration files for examples. + +Tables +~~~~~~ +Table behavior and syntax is determined by `[tabledef-*]` and +`[tabletags-*]` configuration file sections. The user can change +existing table behavior and add new table types by editing +configuration files. The following `[tabledef-*]` section entries +generate table output markup elements: + +colspec:: + The table 'colspec' tag definition. + +headrow, footrow, bodyrow:: + Table header, footer and body row tag definitions. 'headrow' and + 'footrow' table definition entries default to 'bodyrow' if + they are undefined. + +headdata, footdata, bodydata:: + Table header, footer and body data tag definitions. 'headdata' and + 'footdata' table definition entries default to 'bodydata' if they + are undefined. + +paragraph:: + If the 'paragraph' tag is specified then blank lines in the cell + data are treated as paragraph delimiters and marked up using this + tag. + +[[X4]] +Table behavior is also influenced by the following `[miscellaneous]` +configuration file entries: + +pagewidth:: + This integer value is the printable width of the output media. See + <<X69,table attributes>>. + +pageunits:: + The units of width in output markup width attribute values. + +.Table definition behavior +- The output markup generation is specifically designed to work with + the HTML and CALS (DocBook) table models, but should be adaptable to + most XML table schema. +- Table definitions can be ``mixed in'' from multiple cascading + configuration files. +- New table definitions inherit the default table and table tags + definitions (`[tabledef-default]` and `[tabletags-default]`) so you + only need to override those conf file entries that require + modification. + + +[[X59]] +Filters +------- +AsciiDoc filters allow external commands to process AsciiDoc +'Paragraphs', 'DelimitedBlocks' and 'Table' content. Filters are +primarily an extension mechanism for generating specialized outputs. +Filters are implemented using external commands which are specified in +configuration file definitions. + +There's nothing special about the filters, they're just standard UNIX +filters: they read text from the standard input, process it, and write +to the standard output. + +The asciidoc(1) command `--filter` option can be used to install and +remove filters. The same option is used to unconditionally load a +filter. + +Attribute substitution is performed on the filter command prior to +execution -- attributes can be used to pass parameters from the +AsciiDoc source document to the filter. + +WARNING: Filters sometimes included executable code. Before installing +a filter you should verify that it is from a trusted source. + +Filter Search Paths +~~~~~~~~~~~~~~~~~~~ +If the filter command does not specify a directory path then +asciidoc(1) recursively searches for the executable filter command: + +- First it looks in the user's `$HOME/.asciidoc/filters` directory. +- Next the global filters directory (usually `/etc/asciidoc/filters` + or `/usr/local/etc/asciidoc`) directory is searched. +- Then it looks in the asciidoc(1) `./filters` directory. +- Finally it relies on the executing shell to search the environment + search path (`$PATH`). + +Standard practice is to install each filter in it's own sub-directory +with the same name as the filter's style definition. For example the +music filter's style name is 'music' so it's configuration and filter +files are stored in the `filters/music` directory. + +Filter Configuration Files +~~~~~~~~~~~~~~~~~~~~~~~~~~ +Filters are normally accompanied by a configuration file containing a +Paragraph or DelimitedBlock definition along with corresponding markup +templates. + +While it is possible to create new 'Paragraph' or 'DelimitedBlock' +definitions the preferred way to implement a filter is to add a +<<X23,style>> to the existing Paragraph and ListingBlock definitions +(all filters shipped with AsciiDoc use this technique). The filter is +applied to the paragraph or delimited block by preceding it with an +attribute list: the first positional attribute is the style name, +remaining attributes are normally filter specific parameters. + +asciidoc(1) auto-loads all `.conf` files found in the filter search +paths unless the container directory also contains a file named +`__noautoload__` (see previous section). The `__noautoload__` feature +is used for filters that will be loaded manually using the `--filter` +option. + +[[X56]] +Example Filter +~~~~~~~~~~~~~~ +AsciiDoc comes with a toy filter for highlighting source code keywords +and comments. See also the `./filters/code/code-filter-readme.txt` +file. + +NOTE: The purpose of this toy 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 multi-language highlighter +use the {website}source-highlight-filter.html[source code highlighter +filter]. + +Built-in filters +~~~~~~~~~~~~~~~~ +The AsciiDoc distribution includes 'source', 'music', 'latex' and +'graphviz' filters, details are on the +{website}index.html#_filters[AsciiDoc website]. + +[cols="1e,5",frame="topbot",options="header"] +.Built-in filters list +|==================================================================== +|Filter name |Description + +|music +|A {website}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. + +|source +|A {website}source-highlight-filter.html[source code highlight filter] +is included in the distribution `./filters/` directory. + +|latex +|The {website}latex-filter.html[AsciiDoc LaTeX filter] translates +LaTeX source to a PNG image that is automatically inserted into the +AsciiDoc output documents. + +|graphviz +|Gouichi Iisaka has written a http://www.graphviz.org/[Graphviz] +filter for AsciiDoc. Graphviz generates diagrams from a textual +specification. Gouichi Iisaka's Graphviz filter is included in the +AsciiDoc distribution. Here are some +{website}asciidoc-graphviz-sample.html[AsciiDoc Graphviz examples]. + +|==================================================================== + +[[X58]] +Filter plugins +~~~~~~~~~~~~~~ +Filter <<X101,plugins>> are a mechanism for distributing AsciiDoc +filters. A filter plugin is a Zip file containing the files that +constitute a filter. The asciidoc(1) `--filter` option is used to +load and manage filer <<X101,plugins>>. + +- Filter plugins <<X27,take precedence>> over built-in filters with + the same name. +- By default filter plugins are installed in + `$HOME/.asciidoc/filters/<filter>` where `<filter>` is the filter + name. + + +[[X101]] +Plugins +------- +The AsciiDoc plugin architecture is an extension mechanism that allows +additional <<X100,backends>>, <<X58,filters>> and <<X99,themes>> to be +added to AsciiDoc. + +- A plugin is a Zip file containing an AsciiDoc backend, filter or + theme (configuration files, stylesheets, scripts, images). +- The asciidoc(1) `--backend`, `--filter` and `--theme` command-line + options are used to load and manage plugins. Each of these options + responds to the plugin management 'install', 'list', 'remove' and + 'build' commands. +- The plugin management command names are reserved and cannot be used + for filter, backend or theme names. +- The plugin Zip file name always begins with the backend, filter or + theme name. + +Plugin commands and conventions are documented in the asciidoc(1) man +page. You can find lists of plugins on the +{website}plugins.html[AsciiDoc website]. + + +[[X36]] +Help Commands +------------- +The asciidoc(1) command has a `--help` option which prints help topics +to stdout. The default topic summarizes asciidoc(1) usage: + + $ asciidoc --help + +To print a help topic specify the topic name as a command argument. +Help topic names can be shortened so long as they are not ambiguous. +Examples: + + $ asciidoc --help manpage + $ asciidoc -h m # Short version of previous example. + $ asciidoc --help syntax + $ asciidoc -h s # Short version of previous example. + +Customizing Help +~~~~~~~~~~~~~~~~ +To change, delete or add your own help topics edit a help +configuration file. The help file name `help-<lang>.conf` is based on +the setting of the `lang` attribute, it defaults to `help.conf` +(English). The <<X27,help file location>> will depend on whether you +want the topics to apply to all users or just the current user. + +The help topic files have the same named section format as other +<<X7,configuration files>>. The `help.conf` files are stored in the +same locations and loaded in the same order as other configuration +files. + +When the `--help` command-line option is specified AsciiDoc loads the +appropriate help files and then prints the contents of the section +whose name matches the help topic name. If a topic name is not +specified `default` is used. You don't need to specify the whole help +topic name on the command-line, just enough letters to ensure it's not +ambiguous. If a matching help file section is not found a list of +available topics is printed. + + +Tips and Tricks +--------------- + +Know Your Editor +~~~~~~~~~~~~~~~~ +Writing AsciiDoc documents will be a whole lot more pleasant if you +know your favorite text editor. Learn how to indent and reformat text +blocks, paragraphs, lists and sentences. <<X20,Tips for 'vim' users>> +follow. + +[[X20]] +Vim Commands for Formatting AsciiDoc +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Text Wrap Paragraphs +^^^^^^^^^^^^^^^^^^^^ +Use the vim `:gq` command to reformat paragraphs. Setting the +'textwidth' sets the right text wrap margin; for example: + + :set textwidth=70 + +To reformat a paragraph: + +1. Position the cursor at the start of the paragraph. +2. Type `gq}`. + +Execute `:help gq` command to read about the vim gq command. + +[TIP] +===================================================================== +- Assign the `gq}` command to the Q key with the `nnoremap Q gq}` + command or put it in your `~/.vimrc` file to so it's always + available (see the <<X61, Example `~/.vimrc` file>>). +- Put `set` commands in your `~/.vimrc` file so you don't have to + enter them manually. +- The Vim website (http://www.vim.org) has a wealth of resources, + including scripts for automated spell checking and ASCII Art + drawing. +===================================================================== + +Format Lists +^^^^^^^^^^^^ +The `gq` command can also be used to format bulleted, numbered and +callout lists. First you need to set the `comments`, `formatoptions` +and `formatlistpat` (see the <<X61, Example `~/.vimrc` file>>). + +Now you can format simple lists that use dash, asterisk, period and +plus bullets along with numbered ordered lists: + +1. Position the cursor at the start of the list. +2. Type `gq}`. + +Indent Paragraphs +^^^^^^^^^^^^^^^^^ +Indent whole paragraphs by indenting the fist line with the desired +indent and then executing the `gq}` command. + +[[X61]] +Example `~/.vimrc` File +^^^^^^^^^^^^^^^^^^^^^^^ +--------------------------------------------------------------------- +" Use bold bright fonts. +set background=dark + +" Show tabs and trailing characters. +set listchars=tab:»·,trail:· +set list + +" Don't highlight searched text. +highlight clear Search + +" Don't move to matched text while search pattern is being entered. +set noincsearch + +" Reformat paragraphs and list. +nnoremap R gq} + +" Delete trailing white space and Dos-returns and to expand tabs to spaces. +nnoremap S :set et<CR>:retab!<CR>:%s/[\r \t]\+$//<CR> + +autocmd BufRead,BufNewFile *.txt,README,TODO,CHANGELOG,NOTES + \ setlocal autoindent expandtab tabstop=8 softtabstop=2 shiftwidth=2 filetype=asciidoc + \ textwidth=70 wrap formatoptions=tcqn + \ formatlistpat=^\\s*\\d\\+\\.\\s\\+\\\\|^\\s*<\\d\\+>\\s\\+\\\\|^\\s*[a-zA-Z.]\\.\\s\\+\\\\|^\\s*[ivxIVX]\\+\\.\\s\\+ + \ comments=s1:/*,ex:*/,://,b:#,:%,:XCOMM,fb:-,fb:*,fb:+,fb:.,fb:> +--------------------------------------------------------------------- + +Troubleshooting +~~~~~~~~~~~~~~~ +AsciiDoc diagnostic features are detailed in the <<X82,Diagnostics +appendix>>. + +Gotchas +~~~~~~~ +Incorrect character encoding:: + If you get an error message like `'UTF-8' codec can't decode ...` + then you source file contains invalid UTF-8 characters -- set the + AsciiDoc <<X54,encoding attribute>> for the correct character set + (typically ISO-8859-1 (Latin-1) for European languages). + +Invalid output:: + AsciiDoc attempts to validate the input AsciiDoc source but makes + no attempt to validate the output markup, it leaves that to + external tools such as `xmllint(1)` (integrated into `a2x(1)`). + Backend validation cannot be hardcoded into AsciiDoc because + backends are dynamically configured. The following example + generates valid HTML but invalid DocBook (the DocBook `literal` + element cannot contain an `emphasis` element): + + +monospaced text with an _emphasized_ word+ + +Misinterpreted text formatting:: + You can suppress markup expansion by placing a backslash character + immediately in front of the element. The following example + suppresses inline monospaced formatting: + + \+1 for C++. + +Overlapping text formatting:: + Overlapping text formatting will generate illegal overlapping + markup tags which will result in downstream XML parsing errors. + Here's an example: + + Some *strong markup _that overlaps* emphasized markup_. + +Ambiguous underlines:: + A DelimitedBlock can immediately follow a paragraph without an + intervening blank line, but be careful, a single line paragraph + underline may be misinterpreted as a section title underline + resulting in a ``closing block delimiter expected'' error. + +Ambiguous ordered list items:: + Lines beginning with numbers at the end of sentences will be + interpreted as ordered list items. The following example + (incorrectly) begins a new list with item number 1999: + + He was last sighted in + 1999. Since then things have moved on. ++ +The 'list item out of sequence' warning makes it unlikely that this +problem will go unnoticed. + +Special characters in attribute values:: + Special character substitution precedes attribute substitution so + if attribute values contain special characters you may, depending + on the substitution context, need to escape the special characters + yourself. For example: + + $ asciidoc -a 'orgname=Bill & Ben Inc.' mydoc.txt + +Attribute lists:: + If any named attribute entries are present then all string + attribute values must be quoted. For example: + + ["Desktop screenshot",width=32] + +[[X90]] +Combining separate documents +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +You have a number of stand-alone AsciiDoc documents that you want to +process as a single document. Simply processing them with a series of +`include` macros won't work because the documents contain (level 0) +document titles. The solution is to create a top level wrapper +document and use the `leveloffset` attribute to push them all down one +level. For example: + +[listing] +..................................................................... +Combined Document Title +======================= + +// Push titles down one level. +:leveloffset: 1 + +\include::document1.txt[] + +// Return to normal title levels. +:leveloffset: 0 + +A Top Level Section +------------------- +Lorum ipsum. + +// Push titles down one level. +:leveloffset: 1 + +\include::document2.txt[] + +\include::document3.txt[] +..................................................................... + +The document titles in the included documents will now be processed as +level 1 section titles, level 1 sections as level 2 sections and so +on. + +- Put a blank line between the `include` macro lines to ensure the + title of the included document is not seen as part of the last + paragraph of the previous document. +- You won't want non-title document header lines (for example, Author + and Revision lines) in the included files -- conditionally exclude + them if they are necessary for stand-alone processing. + +Processing document sections separately +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +You have divided your AsciiDoc document into separate files (one per +top level section) which are combined and processed with the following +top level document: + +--------------------------------------------------------------------- +Combined Document Title +======================= +Joe Bloggs +v1.0, 12-Aug-03 + +\include::section1.txt[] + +\include::section2.txt[] + +\include::section3.txt[] +--------------------------------------------------------------------- + +You also want to process the section files as separate documents. +This is easy because asciidoc(1) will quite happily process +`section1.txt`, `section2.txt` and `section3.txt` separately -- the +resulting output documents contain the section but have no document +title. + +Processing document snippets +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Use the `-s` (`--no-header-footer`) command-line option to suppress +header and footer output, this is useful if the processed output is to +be included in another file. For example: + + $ asciidoc -sb docbook section1.txt + +asciidoc(1) can be used as a filter, so you can pipe chunks of text +through it. For example: + + $ echo 'Hello *World!*' | asciidoc -s - + <div class="paragraph"><p>Hello <strong>World!</strong></p></div> + +Badges in HTML page footers +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +See the `[footer]` section in the AsciiDoc distribution `xhtml11.conf` +configuration file. + +Pretty printing AsciiDoc output +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +If the indentation and layout of the asciidoc(1) output is not to your +liking you can: + +1. Change the indentation and layout of configuration file markup + template sections. The `{empty}` attribute is useful for outputting + trailing blank lines in markup templates. + +2. Use Dave Raggett's http://tidy.sourceforge.net/[HTML Tidy] program + to tidy asciidoc(1) output. Example: + + $ asciidoc -b docbook -o - mydoc.txt | tidy -indent -xml >mydoc.xml + +3. Use the `xmllint(1)` format option. Example: + + $ xmllint --format mydoc.xml + +Supporting minor DocBook DTD variations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The conditional inclusion of DocBook SGML markup at the end of the +distribution `docbook45.conf` file illustrates how to support minor +DTD variations. The included sections override corresponding entries +from preceding sections. + +Creating stand-alone HTML documents +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +If you've ever tried to send someone an HTML document that includes +stylesheets and images you'll know that it's not as straight-forward +as exchanging a single file. AsciiDoc has options to create +stand-alone documents containing embedded images, stylesheets and +scripts. The following AsciiDoc command creates a single file +containing <<X66,embedded images>>, CSS stylesheets, and JavaScript +(for table of contents and footnotes): + + $ asciidoc -a data-uri -a icons -a toc -a max-width=55em article.txt + +You can view the HTML file here: {website}article-standalone.html[] + +Shipping stand-alone AsciiDoc source +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Reproducing presentation documents from someone else's source has one +major problem: unless your configuration files are the same as the +creator's you won't get the same output. + +The solution is to create a single backend specific configuration file +using the asciidoc(1) `-c` (`--dump-conf`) command-line option. You +then ship this file along with the AsciiDoc source document plus the +`asciidoc.py` script. The only end user requirement is that they have +Python installed (and that they consider you a trusted source). This +example creates a composite HTML configuration file for `mydoc.txt`: + + $ asciidoc -cb xhtml11 mydoc.txt > mydoc-xhtml11.conf + +Ship `mydoc.txt`, `mydoc-html.conf`, and `asciidoc.py`. With +these three files (and a Python interpreter) the recipient can +regenerate the HMTL output: + + $ ./asciidoc.py -eb xhtml11 mydoc.txt + +The `-e` (`--no-conf`) option excludes the use of implicit +configuration files, ensuring that only entries from the +`mydoc-html.conf` configuration are used. + +Inserting blank space +~~~~~~~~~~~~~~~~~~~~~ +Adjust your style sheets to add the correct separation between block +elements. Inserting blank paragraphs containing a single non-breaking +space character `{nbsp}` works but is an ad hoc solution compared +to using style sheets. + +Closing open sections +~~~~~~~~~~~~~~~~~~~~~ +You can close off section tags up to level `N` by calling the +`eval::[Section.setlevel(N)]` system macro. This is useful if you +want to include a section composed of raw markup. The following +example includes a DocBook glossary division at the top section level +(level 0): + +--------------------------------------------------------------------- +\ifdef::basebackend-docbook[] + +\eval::[Section.setlevel(0)] + ++++++++++++++++++++++++++++++++ +<glossary> + <title>Glossary + + ... + + ++++++++++++++++++++++++++++++++ +\endif::basebackend-docbook[] +--------------------------------------------------------------------- + +Validating output files +~~~~~~~~~~~~~~~~~~~~~~~ +Use `xmllint(1)` to check the AsciiDoc generated markup is both well +formed and valid. Here are some examples: + + $ xmllint --nonet --noout --valid docbook-file.xml + $ xmllint --nonet --noout --valid xhtml11-file.html + $ xmllint --nonet --noout --valid --html html4-file.html + +The `--valid` option checks the file is valid against the document +type's DTD, if the DTD is not installed in your system's catalog then +it will be fetched from its Internet location. If you omit the +`--valid` option the document will only be checked that it is well +formed. + +The online http://validator.w3.org/#validate_by_uri+with_options[W3C +Markup Validation Service] is the defacto standard when it comes to +validating HTML (it validates all HTML standards including HTML5). + + +:numbered!: + +[glossary] +Glossary +-------- +[glossary] +[[X8]] Block element:: + An AsciiDoc block element is a document entity composed of one or + more whole lines of text. + +[[X34]] Inline element:: + AsciiDoc inline elements occur within block element textual + content, they perform formatting and substitution tasks. + +Formal element:: + An AsciiDoc block element that has a BlockTitle. Formal elements + are normally listed in front or back matter, for example lists of + tables, examples and figures. + +Verbatim element:: + The word verbatim indicates that white space and line breaks in + the source document are to be preserved in the output document. + + +[appendix] +Migration Notes +--------------- +[[X53]] +Version 7 to version 8 +~~~~~~~~~~~~~~~~~~~~~~ +- A new set of quotes has been introduced which may match inline text + in existing documents -- if they do you'll need to escape the + matched text with backslashes. +- The index entry inline macro syntax has changed -- if your documents + include indexes you may need to edit them. +- Replaced a2x(1) `--no-icons` and `--no-copy` options with their + negated equivalents: `--icons` and `--copy` respectively. The + default behavior has also changed -- the use of icons and copying of + icon and CSS files must be specified explicitly with the `--icons` + and `--copy` options. + +The rationale for the changes can be found in the AsciiDoc +`CHANGELOG`. + +NOTE: If you want to disable unconstrained quotes, the new alternative +constrained quotes syntax and the new index entry syntax then you can +define the attribute `asciidoc7compatible` (for example by using the +`-a asciidoc7compatible` command-line option). + +[[X38]] +[appendix] +Packager Notes +-------------- +Read the `README` and `INSTALL` files (in the distribution root +directory) for install prerequisites and procedures. The distribution +`Makefile.in` (used by `configure` to generate the `Makefile`) is the +canonical installation procedure. + + +[[X39]] +[appendix] +AsciiDoc Safe Mode +------------------- +AsciiDoc 'safe mode' skips potentially dangerous scripted sections in +AsciiDoc source files by inhibiting the execution of arbitrary code or +the inclusion of arbitrary files. + +The safe mode is disabled by default, it can be enabled with the +asciidoc(1) `--safe` command-line option. + +.Safe mode constraints +- `eval`, `sys` and `sys2` executable attributes and block macros are + not executed. +- `include::[]` and `include1::[]` block macro + files must reside inside the parent file's directory. +- `{include:}` executable attribute files must reside + inside the source document directory. +- Passthrough Blocks are dropped. + +[WARNING] +===================================================================== +The safe mode is not designed to protect against unsafe AsciiDoc +configuration files. Be especially careful when: + +1. Implementing filters. +2. Implementing elements that don't escape special characters. +3. Accepting configuration files from untrusted sources. +===================================================================== + + +[appendix] +Using AsciiDoc with non-English Languages +----------------------------------------- +AsciiDoc can process UTF-8 character sets but there are some things +you need to be aware of: + +- If you are generating output documents using a DocBook toolchain + then you should set the AsciiDoc `lang` attribute to the appropriate + language (it defaults to `en` (English)). This will ensure things + like table of contents, figure and table captions and admonition + captions are output in the specified language. For example: + + $ a2x -a lang=es doc/article.txt + +- If you are outputting HTML directly from asciidoc(1) you'll + need to set the various `*_caption` attributes to match your target + language (see the list of captions and titles in the `[attributes]` + section of the distribution `lang-*.conf` files). The easiest way is + to create a language `.conf` file (see the AsciiDoc's `lang-en.conf` + file). ++ +NOTE: You still use the 'NOTE', 'CAUTION', 'TIP', 'WARNING', +'IMPORTANT' captions in the AsciiDoc source, they get translated in +the HTML output file. + +- asciidoc(1) automatically loads configuration files named like + `lang-.conf` where `` is a two letter language code that + matches the current AsciiDoc `lang` attribute. See also + <>. + + +[appendix] +Vim Syntax Highlighter +---------------------- +Syntax highlighting is incredibly useful, in addition to making +reading AsciiDoc documents much easier syntax highlighting also helps +you catch AsciiDoc syntax errors as you write your documents. + +The AsciiDoc `./vim/` distribution directory contains Vim syntax +highlighter and filetype detection scripts for AsciiDoc. Syntax +highlighting makes it much easier to spot AsciiDoc syntax errors. + +If Vim is installed on your system the AsciiDoc installer +(`install.sh`) will automatically install the vim scripts in the Vim +global configuration directory (`/etc/vim`). + +You can also turn on syntax highlighting by adding the following line +to the end of you AsciiDoc source files: + + // vim: set syntax=asciidoc: + +TIP: Bold fonts are often easier to read, use the Vim `:set +background=dark` command to set bold bright fonts. + +NOTE: There are a number of alternative syntax highlighters for +various editors listed on the {website}[AsciiDoc website]. + +Limitations +~~~~~~~~~~~ +The current implementation does a reasonable job but on occasions gets +things wrong: + +- Nested quoted text formatting is highlighted according to the outer + format. +- If a closing Example Block delimiter is sometimes mistaken for a + title underline. A workaround is to insert a blank line before the + closing delimiter. +- Lines within a paragraph starting with equals characters may be + highlighted as single-line titles. +- Lines within a paragraph beginning with a period may be highlighted + as block titles. + + +[[X74]] +[appendix] +Attribute Options +----------------- +Here is the list of predefined <>: + + +[cols="2e,2,2,5",frame="topbot",options="header"] +|==================================================================== +|Option|Backends|AsciiDoc Elements|Description + +|autowidth |xhtml11, html5, html4 |table| +The column widths are determined by the browser, not the AsciiDoc +'cols' attribute. If there is no 'width' attribute the table width is +also left up to the browser. + +|unbreakable |xhtml11, html5 |block elements| +'unbreakable' attempts to keep the block element together on a single +printed page c.f. the 'breakable' and 'unbreakable' docbook (XSL/FO) +options below. + +|breakable, unbreakable |docbook (XSL/FO) |table, example, block image| +The 'breakable' options allows block elements to break across page +boundaries; 'unbreakable' attempts to keep the block element together +on a single page. If neither option is specified the default XSL +stylesheet behavior prevails. + +|compact |docbook, xhtml11, html5 |bulleted list, numbered list| +Minimizes vertical space in the list + +|footer |docbook, xhtml11, html5, html4 |table| +The last row of the table is rendered as a footer. + +|header |docbook, xhtml11, html5, html4 |table| +The first row of the table is rendered as a header. + +|pgwide |docbook (XSL/FO) |table, block image, horizontal labeled list| +Specifies that the element should be rendered across the full text +width of the page irrespective of the current indentation. + +|strong |xhtml11, html5, html4 |labeled lists| +Emboldens label text. +|==================================================================== + + +[[X82]] +[appendix] +Diagnostics +----------- +The `asciidoc(1)` `--verbose` command-line option prints additional +information to stderr: files processed, filters processed, warnings, +system attribute evaluation. + +A special attribute named 'trace' enables the output of +element-by-element diagnostic messages detailing output markup +generation to stderr. The 'trace' attribute can be set on the +command-line or from within the document using <> (the latter allows tracing to be confined to specific +portions of the document). + +- Trace messages print the source file name and line number and the + trace name followed by related markup. +- 'trace names' are normally the names of AsciiDoc elements (see the + list below). +- The trace message is only printed if the 'trace' attribute value + matches the start of a 'trace name'. The 'trace' attribute value can + be any Python regular expression. If a trace value is not specified + all trace messages will be printed (this can result in large amounts + of output if applied to the whole document). + +- In the case of inline substitutions: + * The text before and after the substitution is printed; the before + text is preceded by a line containing `<<<` and the after text by + a line containing `>>>`. + * The 'subs' trace value is an alias for all inline substitutions. + +.Trace names +..................................................................... + block close + block open + +dropped line (a line containing an undefined attribute reference). +floating title +footer +header +list close +list entry close +list entry open +list item close +list item open +list label close +list label open +list open +macro block (a block macro) +name (man page NAME section) +paragraph +preamble close +preamble open +push blockname +pop blockname +section close +section open: level +subs (all inline substitutions) +table +..................................................................... + +Where: + +- `` is section level number '0...4'. +- `` is a delimited block name: 'comment', 'sidebar', + 'open', 'pass', 'listing', 'literal', 'quote', 'example'. +- `` is an inline substitution type: + 'specialcharacters','quotes','specialwords', 'replacements', + 'attributes','macros','callouts', 'replacements2', 'replacements3'. + +Command-line examples: + +. Trace the entire document. + + $ asciidoc -a trace mydoc.txt + +. Trace messages whose names start with `quotes` or `macros`: + + $ asciidoc -a 'trace=quotes|macros' mydoc.txt + +. Print the first line of each trace message: + + $ asciidoc -a trace mydoc.txt 2>&1 | grep ^TRACE: + +Attribute Entry examples: + +. Begin printing all trace messages: + + :trace: + +. Print only matched trace messages: + + :trace: quotes|macros + +. Turn trace messages off: + + :trace!: + + +[[X88]] +[appendix] +Backend Attributes +------------------ +This table contains a list of optional attributes that influence the +generated outputs. + +[cols="1e,1,5a",frame="topbot",options="header"] +|==================================================================== +|Name |Backends |Description + +|badges |xhtml11, html5 | +Link badges ('XHTML 1.1' and 'CSS') in document footers. By default +badges are omitted ('badges' is undefined). + +NOTE: The path names of images, icons and scripts are relative path +names to the output document not the source document. + +|data-uri |xhtml11, html5 | +Embed images using the <>. + +|css-signature |html5, xhtml11 | +Set a 'CSS signature' for the document (sets the 'id' attribute of the +HTML 'body' element). CSS signatures provide a mechanism that allows +users to personalize the document appearance. The term 'CSS signature' +was http://archivist.incutio.com/viewlist/css-discuss/13291[coined by +Eric Meyer]. + + +|disable-javascript |xhtml11, html5 | +If the `disable-javascript` attribute is defined the `asciidoc.js` +JavaScript is not embedded or linked to the output document. By +default AsciiDoc automatically embeds or links the `asciidoc.js` +JavaScript to the output document. The script dynamically generates +<> and <>. + +|[[X97]] docinfo, docinfo1, docinfo2 |All backends | +These three attributes control which <> will be included in the the header of the output file: + +docinfo:: Include `-docinfo.` +docinfo1:: Include `docinfo.` +docinfo2:: Include `docinfo.` and `-docinfo.` + +Where `` is the file name (sans extension) of the AsciiDoc +input file and `` is `.html` for HTML outputs or `.xml` for +DocBook outputs. If the input file is the standard input then the +output file name is used. The following example will include the +`mydoc-docinfo.xml` docinfo file in the DocBook `mydoc.xml` output +file: + + $ asciidoc -a docinfo -b docbook mydoc.txt + +This next example will include `docinfo.html` and `mydoc-docinfo.html` +docinfo files in the HTML output file: + + $ asciidoc -a docinfo2 -b html4 mydoc.txt + + +|[[X54]]encoding |html4, html5, xhtml11, docbook | +Set the input and output document character set encoding. For example +the `--attribute encoding=ISO-8859-1` command-line option will set the +character set encoding to `ISO-8859-1`. + +- The default encoding is UTF-8. +- This attribute specifies the character set in the output document. +- The encoding name must correspond to a Python codec name or alias. +- The 'encoding' attribute can be set using an AttributeEntry inside + the document header. For example: + + :encoding: ISO-8859-1 + +|[[X45]]icons |xhtml11, html5 | +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. + +|[[X44]]iconsdir |html4, html5, xhtml11, docbook | +The name of the directory containing linked admonition icons, +navigation icons and the `callouts` sub-directory (the `callouts` +sub-directory contains <> number images). 'iconsdir' +defaults to `./images/icons`. + +|imagesdir |html4, html5, xhtml11, docbook | +If this attribute is defined it is prepended to the target image file +name paths in inline and block image macros. + +|keywords, description, title |html4, html5, xhtml11 | +The 'keywords' and 'description' attributes set the correspondingly +named HTML meta tag contents; the 'title' attribute sets the HTML +title tag contents. Their principle use is for SEO (Search Engine +Optimisation). All three are optional, but if they are used they must +appear in the document header (or on the command-line). If 'title' is +not specified the AsciiDoc document title is used. + +|linkcss |html5, xhtml11 | +Link CSS stylesheets and JavaScripts. By default 'linkcss' is +undefined in which case stylesheets and scripts are automatically +embedded in the output document. + +|[[X103]]max-width |html5, xhtml11 | +Set the document maximum display width (sets the 'body' element CSS +'max-width' property). + +|numbered |html4, html5, xhtml11, docbook (XSL Stylesheets) | +Adds section numbers to section titles. The 'docbook' backend ignores +'numbered' attribute entries after the document header. + +|plaintext | All backends | +If this global attribute is defined all inline substitutions are +suppressed and block indents are retained. This option is useful when +dealing with large amounts of imported plain text. + +|quirks |xhtml11 | +Include the `xhtml11-quirks.conf` configuration file and +`xhtml11-quirks.css` <> to work around IE6 browser +incompatibilities. This feature is deprecated and its use is +discouraged -- documents are still viewable in IE6 without it. + +|revremark |docbook | +A short summary of changes in this document revision. Must be defined +prior to the first document section. The document also needs to be +dated to output this attribute. + +|scriptsdir |html5, xhtml11 | +The name of the directory containing linked JavaScripts. +See <>. + +|sgml |docbook45 | +The `--backend=docbook45` command-line option produces DocBook 4.5 +XML. You can produce the older DocBook SGML format using the +`--attribute sgml` command-line option. + +|stylesdir |html5, xhtml11 | +The name of the directory containing linked or embedded +<>. +See <>. + +|stylesheet |html5, xhtml11 | +The file name of an optional additional CSS <>. + +|theme |html5, xhtml11 | +Use alternative stylesheet (see <>). + +|[[X91]]toc |html5, xhtml11, docbook (XSL Stylesheets) | +Adds a table of contents to the start of an article or book document. +The `toc` attribute can be specified using the `--attribute toc` +command-line option or a `:toc:` attribute entry in the document +header. The 'toc' attribute is defined by default when the 'docbook' +backend is used. To disable table of contents generation undefine the +'toc' attribute by putting a `:toc!:` attribute entry in the document +header or from the command-line with an `--attribute toc!` option. + +*xhtml11 and html5 backends* + +- JavaScript needs to be enabled in your browser. +- The following example generates a numbered table of contents using a + JavaScript embedded in the `mydoc.html` output document: + + $ asciidoc -a toc -a numbered mydoc.txt + +|toc2 |html5, xhtml11 | +Adds a scrollable table of contents in the left hand margin of an +article or book document. Use the 'max-width' attribute to change the +content width. In all other respects behaves the same as the 'toc' +attribute. + +|toc-placement |html5, xhtml11 | +When set to 'auto' (the default value) asciidoc(1) will place the +table of contents in the document header. When 'toc-placement' is set +to 'manual' the TOC can be positioned anywhere in the document by +placing the `toc::[]` block macro at the point you want the TOC to +appear. + +NOTE: If you use 'toc-placement' then you also have to define the +<> attribute. + +|toc-title |html5, xhtml11 | +Sets the table of contents title (defaults to 'Table of Contents'). + +|toclevels |html5, xhtml11 | +Sets the number of title levels (1..4) reported in the table of +contents (see the 'toc' attribute above). Defaults to 2 and must be +used with the 'toc' attribute. Example usage: + + $ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt + +|==================================================================== + + +[appendix] +License +------- +AsciiDoc is free software; you can redistribute it and/or modify it +under the terms of the 'GNU General Public License version 2' (GPLv2) +as published by the Free Software Foundation. + +AsciiDoc 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 version 2 for more details. + +Copyright (C) 2002-2011 Stuart Rackham. diff --git a/source-builder/sb/asciidoc/doc/asciidocapi.txt b/source-builder/sb/asciidoc/doc/asciidocapi.txt new file mode 100644 index 0000000..bbf69e7 --- /dev/null +++ b/source-builder/sb/asciidoc/doc/asciidocapi.txt @@ -0,0 +1,189 @@ +AsciiDoc API +============ + +'asciidocapi' -- a Python API module for 'AsciiDoc'. + + +Introduction +------------ +The 'asciidocapi' module implements a Python API for AsciiDoc. It +allows you to set `asciidoc(1)` program options, compile an AsciiDoc +source file and then interrogate the results. The `asciidocapi.py` +module file contains the `AsciiDocAPI` wrapper class for +`asciidoc.py`. + +.Benefits +- Stable API Shields the user from the undocumented and possibly + volatile `asciidoc.py` internals. +- Easier to use and more flexible than the alternative of running + `asciidoc(1)` as a separate process. +- Executes inside your application (better performance than running + separate `asciidoc(1)` command processes). + + +Using asciidocapi +----------------- +To use the API just drop the `asciidocapi.py` file into your +application directory, import it and use the `AsciiDocAPI` class. The +only requirement is that a compatible version of 'AsciiDoc' is already +installed -- simple, no setuptools to run, no Eggs to install, no +non-standard library dependencies. + +You can find `asciidocapi.py` in the AsciiDoc +http://www.methods.co.nz/asciidoc/INSTALL.html#X1[distribution +archives] (version 8.4.1 or better). + +Once you have `asciidocapi.py` Verify everything is working by running +the module doctests: + + python asciidocapi.py + +If there are no messages then all is well. + +The following minimal example compiles `mydoc.txt` to `mydoc.html`: + +[source,python] +------------------------------------------------------------------------------- +from asciidocapi import AsciiDocAPI +asciidoc = AsciiDocAPI() +asciidoc.execute('mydoc.txt') +------------------------------------------------------------------------------- + +The next interactive example uses file-like objects for input and output: + +------------------------------------------------------------------------------- +$ python +Python 2.5.2 (r252:60911, Jul 31 2008, 17:28:52) +[GCC 4.2.3 (Ubuntu 4.2.3-2ubuntu7)] on linux2 +Type "help", "copyright", "credits" or "license" for more information. +>>> from asciidocapi import AsciiDocAPI +>>> import StringIO +>>> infile = StringIO.StringIO('Hello *{author}*') +>>> outfile = StringIO.StringIO() +>>> asciidoc = AsciiDocAPI() +>>> asciidoc.options('--no-header-footer') +>>> asciidoc.attributes['author'] = 'Joe Bloggs' +>>> asciidoc.execute(infile, outfile, backend='html4') +>>> print outfile.getvalue() +

Hello Joe Bloggs

+ +>>> +------------------------------------------------------------------------------- + + +Implementation Rationale +------------------------ +.Leverage existing knowledge +The API maps directly onto the `asciidoc(1)` command -- this is +deliberate -- if you know the `asciidoc(1)` command learning the API +will be trivial. A nice side effect of this goal is that API and +command-line modes share the same code -- virtually no `asciidoc(1)` +code is specific to API usage. + +.Simplicity +Implemented with a single Python module file (`asciidocapi.py`) +containing the 'AsciiDocAPI' API class. 'AsciiDocAPI' contains just +one method plus a few attributes for processing options and result +messages. No external setup tools and no non-standard library +dependencies are used or required. + +.Loose coupling +The dependency between `asciidocapi.py` and `asciidoc.py` is minimal +-- the current `asciidocapi.py` module uses only two attributes and +one function from the `asciidoc.py` module. + +.Why isn't the API baked right into the asciidoc.py command script? +1. You can't just drop `asciidoc.py` into your application because it + requires all the related config files and filters -- complex and + unnecessary since all this was already done when you installed + AsciiDoc. +2. This scheme separates the API from the AsciiDoc application -- the + API implementation can be extended or replaced independently of + AsciiDoc. + + +API reference +------------- + +[[X2]] +Class `AsciiDocAPI(object)` +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +This is the 'AsciiDoc' API class. + +Instance attributes +^^^^^^^^^^^^^^^^^^^ +`asciidoc`:: +The imported `asciidoc.py` module. + +`attributes`:: +A dictionary of AsciiDoc attribute values passed to AsciiDoc. + +- Setting an attribute value to `None` (`name: None`) will undefine + (delete) the attribute (this in addition to the `name!` attribute + name format that the `asciidoc(1)` command uses). +- To simply define an attribute set the attribute value to a blank + string (`name: ''`) + +`cmd`:: +The file path of the `asciidoc.py` script. Set by the `__init__` +method. + +`messages`:: +A chronologically ordered list of message strings generated during +AsciiDoc execution (last message at the end of the list). + +`options`:: +An instance of the <>. Contains a list of command +options passed to AsciiDoc. + +Instance methods +^^^^^^^^^^^^^^^^ +`__init__(self, asciidoc_py=None)`:: +Locate and import `asciidoc.py` module and verify API compatibility. +Initialize instance attributes. A search for the `asciidoc` module is +made in the following order: + +. Use the `ASCIIDOC_PY` environment variable if it is set. +. Use the `asciidoc_py` argument if it is set. +. Search the environment 'PATH' for `asciidoc.py`, `asciidoc.pyc` and + `asciidoc` (in that order). +. Finally repeat the previous search in the current working directory. + +`execute(self, infile, outfile=None, backend=None)`:: +Compile `infile` to `outfile` using `backend` format. `infile` and +`outfile` can be file path strings or file-like objects. `backend` is +name of 'AsciiDoc' backend (takes same values as `asciidoc(1)` command +`--backend` option). If `outfile` or `backend` are `None` then their +respective `asciidoc(1)` defaults are used. + + +[[X1]] +Class `Options(object)` +~~~~~~~~~~~~~~~~~~~~~~~ +Stores `asciidoc(1)` command options. You can use any `asciidoc(1)` +options with the exception of the `--doctest` and `--filter` options. + +Instance attributes +^^^^^^^^^^^^^^^^^^^ +`values`:: +The list of `(name,value)` command option tuples. + +Instance methods +^^^^^^^^^^^^^^^^ +`__call__(self, name, value=None)`:: +A shortcut for the `append` method. Example: + + opts = Options() + opts('--verbose') + +`append(self, name, value=None)`:: +Append `(name,value)` to the options list. Example: + + opts = Options() + opts.append('--conf-file', 'blog.conf') + + +Class `AsciiDocError(Exception)` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Thrown by the <> when an 'AsciiDoc' execution +error occurs. diff --git a/source-builder/sb/asciidoc/doc/asciimathml.txt b/source-builder/sb/asciidoc/doc/asciimathml.txt new file mode 100644 index 0000000..ed5e269 --- /dev/null +++ b/source-builder/sb/asciidoc/doc/asciimathml.txt @@ -0,0 +1,61 @@ +ASCIIMathML Formulae +==================== + +http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML] is +a clever JavaScript written by Peter Jipsen that dynamically +transforms mathematical formulae written in a wiki-like plain text +markup to http://www.w3.org/Math/[MathML] markup which is displayed as +standard mathematical notation by the Web Browser. See 'Appendix E' +in the AsciiDoc User Guide for more details. + +The AsciiDoc `xhtml11` backend supports ASCIIMathML -- it links the +ASCIIMathML script and escapes ASCIIMathML delimiters and special +characters to yield valid XHTML. To use ASCIIMathML: + +1. Include the `-a asciimath` command-line option when you run + `asciidoc(1)`. +2. Enclose ASCIIMathML formulas inside math or double-dollar + passthroughs or in math passthrough blocks. + +Here's the link:asciimathml.txt[AsciiDoc source] that generated this +page. + +.NOTE +- When you use the `asciimath:[]` inline macro you need to escape `]` + characters in the formulas with a backslash, escaping is unnecessary + if you use the double-dollar macro (for examples see the second + formula below). +- See the + http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML] + website for ASCIIMathML documentation and the latest version. +- If the formulas don't appear to be correct you probably need to + install the correct math fonts (see the + http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML] + website for details). +- See the link:latexmathml.html[LaTeXMathML page] if you prefer to use + LaTeX math formulas. + +A list of example formulas: + +- $$`[[a,b],[c,d]]((n),(k))`$$ +- asciimath:[x/x={(1,if x!=0),(text{undefined},if x=0):}] +- asciimath:[d/dxf(x)=lim_(h->0)(f(x+h)-f(x))/h] +- +++`sum_(i=1)\^n i=(n(n+1))/2`$+++ and *bold + asciimath:[int_0\^(pi/2) sinx\ dx=1]* +- asciimath:[(a,b\]={x in RR : a < x <= b}] +- asciimath:[x^2+y_1+z_12^34] + +********************************************************************* +The first three terms factor to give +asciimath:[(x+b/(2a))^2=(b^2)/(4a^2)-c/a]. + +asciimath:[x+b/(2a)=+-sqrt((b^2)/(4a^2)-c/a)]. + +Now we take square roots on both sides and get +asciimath:[x+b/(2a)=+-sqrt((b^2)/(4a^2)-c/a)]. +Finally we move the asciimath:[b/(2a)] to the right and simplify to +get the two solutions: +*asciimath:[x_(1,2)=(-b+-sqrt(b^2-4ac))/(2a)]*. + +********************************************************************* + diff --git a/source-builder/sb/asciidoc/doc/book-multi.txt b/source-builder/sb/asciidoc/doc/book-multi.txt new file mode 100644 index 0000000..61d5ad3 --- /dev/null +++ b/source-builder/sb/asciidoc/doc/book-multi.txt @@ -0,0 +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 <>. +indexterm:[Second example index entry] + +An example link to a bibliography entry <>. + + + +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/source-builder/sb/asciidoc/doc/book.epub b/source-builder/sb/asciidoc/doc/book.epub new file mode 100644 index 0000000..910c638 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/book.epub differ diff --git a/source-builder/sb/asciidoc/doc/book.txt b/source-builder/sb/asciidoc/doc/book.txt new file mode 100644 index 0000000..7579851 --- /dev/null +++ b/source-builder/sb/asciidoc/doc/book.txt @@ -0,0 +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 <>. +indexterm:[Second example index entry] + +An example link to a bibliography entry <>. + + +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/source-builder/sb/asciidoc/doc/customers.csv b/source-builder/sb/asciidoc/doc/customers.csv new file mode 100644 index 0000000..01f862a --- /dev/null +++ b/source-builder/sb/asciidoc/doc/customers.csv @@ -0,0 +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" diff --git a/source-builder/sb/asciidoc/doc/epub-notes.txt b/source-builder/sb/asciidoc/doc/epub-notes.txt new file mode 100644 index 0000000..0b942ba --- /dev/null +++ b/source-builder/sb/asciidoc/doc/epub-notes.txt @@ -0,0 +1,210 @@ +AsciiDoc EPUB Notes +=================== + + +Restrictions +------------ +- If the date format of the DocBook 'data' element is not formatted like + `YYYY[-MM[-DD]]` you will get an error like the following one when + validating with `epubcheck(1)`: + + ERROR: doc/article.epub/OEBPS/content.opf(6): date value 'Dec 2003' + is not valid, YYYY[-MM[-DD]] expected + +- Navigation headers are suppressed by `docbook-xsl/epub.xsl` (see + <>). + + +DocBook XSL Stylesheets related limitations and bugs +---------------------------------------------------- + +=== epub: toc.section.depth parameter ignored +https://sourceforge.net/tracker/?func=detail&aid=3043393&group_id=21935&atid=373747 + +epub outputs include every section in the table of contents regardless of the +toc.section.depth XSL Stylesheets parameter +(http://docbook.sourceforge.net/release/xsl/current/doc/html/toc.section.depth.html). +This behavior is specific to epub (xhtml and fo outputs honor +toc.section.depth). + +Environment: DocBook XSL 1.75.2; Xubuntu 10.04 + +Also epub/docbook.xsl has written a hard-coded illegal dtb:depth value of -1 +into the toc.ncx navigation control file: + + + +Shouldn't it be a positive integer equal to the depth navPoint nesting in the +navMap element (see +http://www.niso.org/workrooms/daisy/Z39-86-2005.html#NavMeta)? Though epubcheck 1.05 doesn't flag it as invalid -- are they both wrong? + + +[[X1]] +=== epub: untitled DocBook sidebar emits invalid XHTML +https://sourceforge.net/tracker/index.php?func=detail&aid=2840768&group_id=21935&atid=373747 + +I get the same problem, but is confined to EPUB outputs (not XHTML) +and results in the sidebar and all subsequent text on the page +displayed in bold text in both Firefox 3.6.8 and Google Chrome +5.0.375.125 (I haven't checked other browsers). + +Environment: DocBook XSL 1.75.2; Xubuntu 10.04 + +If a DocBook sidebar element does not have a title then the emitted +title is (I haven't checked other browsers). +set to instead of , for example this DocBook markup: + + + Lorem ipsum dolor sit amet, consectetuer adipiscing elit. + + +Generates this EPUB XHTML: + + + +This problem is not picked up by either the epubcheck or the W3C +validators. + +The problem does not occur generating XHTML which emits the following +for the above example: + + + + +=== epub: Unreferenced callout icons in OPF +NOTE: A workaround for this problem was added in `a2x(1)` version +8.6.5. + +https://sourceforge.net/tracker/?func=detail&aid=2854075&group_id=21935&atid=373747 + +Environment: DocBook XSL 1.75.2; Xubuntu 8.04 + +When callouts are used in a document and callout graphics are disabled +(callout.graphics=0) the generated 'contents.opf' still contains +references to all the callout icons even though none are not +referenced in the generated XHTML content. This results in 10 +epubcheck validation errors like: + + image file OEBPS/images/icons/callouts/1.png is missing + +It appears that epub is adding the icons to the OPF without +first checking the callout.graphics parameter. + + +=== epub: Table grids not generated +https://sourceforge.net/tracker/?func=detail&aid=2849647&group_id=21935&atid=373747 + +Environment: DocBook XSL 1.75.2; Xubuntu 8.04 + +DocBook XSL epub does not appear to process the DocBook table element rowsep +and colsep attributes -- table grids are not displayed. The DocBook + results in: + +epub DocBook XSL generates: + + +......................................... + +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] + [{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 +`` into the DocBook output generated by +AsciiDoc: + + pass::[] + +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' and 'html5' backends 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? + +Styling is backend dependent: + +[float] +==== Create an indented paragraph style (xhtml11 and html5 backends) +. Define an 'indented' paragraph style, for example, by putting this + in a custom configuration file: ++ +--------------------------------------------------------------------- +[paradef-default] +indented-style=template="indentedparagraph" + +[indentedparagraph] +
{title?
{title}
}

+| +

+--------------------------------------------------------------------- + +. 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 (xhtml11 and html5 backends) +. Add the following line to 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. +--------------------------------------------------------------------- + +. Include the custom stylesheet by setting the 'stylesheet' attribute + (either from the command-line or with an attribute entry in the + document header). + +[float] +==== Use the role attribute (docbook backend) +. Add the following line to the distributed `docbook-xsl.css` + stylesheet or include it in a custom stylesheet: ++ +--------------------------------------------------------------------- +p.indented {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. +--------------------------------------------------------------------- + +. If you have included the custom CSS in a separate stylesheet you + will need to specify the stylesheet file name (along with the + default `docbook-xsl.css` stylesheet file name) with the + `html.stylesheet` XSL parameter. If you are using 'a2x(1)' use the + `--stylesheet` option (it sets the `html.stylesheet` XSL parameter), + for example: `--stylesheet "docbook-xsl.css mycss.css"`. + +NOTE: This applies to HTML outputs not PDF. To achieve the same +results with PDF outputs you will need to customize the DocBook XSL +Stylesheets to render indented paragraphs from DocBook `simpara` +elements containing the the `role="indented"` attribute. + + +== Is there a way to set default table grid and frame attributes? + +You can set the 'grid' and 'frame' attributes globally in your +document header with Attribute Entries or from the command-line using +the `--attribute` option. In the following example tables that don't +explicitly set the 'grid' and 'frame' values will default to 'all' and +'topbot' respectively: + +--------------------------------------------------------------------- +:grid: all +:frame: topbot +--------------------------------------------------------------------- + +TIP: This technique can be applied to any block element attribute +(just beware of possible ambiguity, for example, table and image +blocks both have a 'width' attribute). + + +== 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 and PDF files using LibreOffice? + +https://www.libreoffice.org/[LibreOffice] can convert HTML produced by +AsciiDoc to ODF text format and PDF format (I used LibreOffice 3.5 at +the time of writing, the fidelity is very good but it's not perfect): + +. Create the HTML file using AsciiDoc, for example: + + asciidoc -a icons -a numbered -a disable-javascript article.txt ++ +JavaScript is disabled because LibreOffice does not execute +JavaScript, this means that AsciiDoc table of contents and footnotes +will not be rendered into ODF (if you want the table of contents and +footnotes you could manually cut and paste them from a Web browser). + +. Convert the HTML file to an ODF text file using LibreOffice: + + lowriter --invisible --convert-to odt article.html ++ +-- +The images imported from an HTML file will be linked, if your document +contains images you should convert them to embedded images: + +[lowerroman] +. Open the document in LibreOffice Writer. +. Run the 'Edit->Links...' menu command. +. Select all links and press the 'Break Link' button. + +Some images may also have been resized. To restore an image to its +original size: + +[lowerroman] +. Right-click on the image and select the 'Picture...' menu item. +. Click on the 'Crop' tab. +. Press the 'Original Size' button. + +-- + +. Convert the ODF file to an PDF text file using LibreOffice: + + lowriter --invisible --convert-to pdf article.odt ++ +A PDF index is automatically created using the section headings. + +Alternatively you could manually copy-and-paste the entire document +from a Web browser into a blank ODF document in LibreOffice -- this +technique will bring through the table of contents and footnotes. + +This tip was originally 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} + + +== 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 element instead of ? + +`` is really the same as `` 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 + `` elements inside `` 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 <>. + +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. + + +== How can I control page breaks when printing HTML outputs? +Here are some techniques you can use to control page breaks in HTML +outputs produced by the 'xhtml11' and 'html5' backends: + +- You can generate a page break with the '<<<' block macro. The + following example prints the 'Rats and Mice' section on a new page: ++ +---------------- +<<< +== Rats and Mice +Lorum ipsum ... +---------------- + +- You can use the 'unbreakable' option to instruct the browser not to + break a block element. The following image and it's caption will be + kept together the printed page: ++ +------------------------------------ +[options="unbreakable"] +.Tiger block image +image::images/tiger.png[Tiger image] +------------------------------------ + +- You can apply the 'unbreakable' option globally to all block + elements by defining the 'unbreakable-option' attribute in your + document header. + +- Finally, the most powerful technique is to create custom CSS + containing paged media properties. For example this asciidoc(1) + command: ++ +-- + + asciidoc --attribute stylesheet=article.css article.txt + +Will include the following `article.css` file in the output document: + +------------------------------------------------- +div#toc, div.sect1 { page-break-before: always; } +------------------------------------------------- + +Which will ensure the table of contents and all top level sections +start on a new printed page. +-- + + +== Is it possible to reposition the Table of Contents in HTML outputs? +By default the 'xhtml11' and 'html5' backends auto-position the TOC +after the header. You can manually position the TOC by setting the +'toc-placement' attribute value to 'manual' and then inserting the +`toc::[]` block macro where you want the TOC to appear. For example, +put this in the document header: + +---------------------- +:toc: +:toc-placement: manual +---------------------- + +The put this where you want the TOC to appear: + +------- +toc::[] +------- + + +== HTML generated by AsciiDoc fills the width of the browser, how can I limit it to a more readable book width? +You can set the maximum with for outputs generated by 'html5', +'xhtml11' and 'slidy' backends by assigning the +link:userguide.html#X103[max-width] attribute (either from the +command-line or with an attribute entry in the document header). For +example: + + asciidoc -a max-width=55em article.txt + + +== Using roles to select fonts for PDF +Some applications require mixing fonts beyond the set of faces +normally provided by default (normal, monospace, italic etc.) for +example mixed language text where the font used for the majority of +text does not contain suitable glyphs in the minority language. + +As AsciiDoc can not provide presentation markup since it is not +provided by Docbook this is achieved by marking text which should use +a different font with a custom role which can be rendered by the the +docbook toolchain. + +NOTE: For XHTML outputs AsciiDoc translates the role attribute to a +class which can be selected and styled by CSS as described in the +AsciiDoc users guide. + +The Docbook toolchains will have to be configured to render the text +that you mark with the custom role. + +For FOP a small XSL wrapper is needed, say a file called `my_fo.xsl` +containing: + +--------------------------------------------------------------- + + + + + + + + +--------------------------------------------------------------- + +This is used with `a2x` by: + + a2x -f pdf --fop --xsl-file=my_fo.xsl input.txt + +and the AsciiDoc source marked by: + + normal text [f2]#special font is like this# and back to normal + +Thanks to Antonio Borneo for this answer. + + +== How can I place a footnote immediately following quoted text? +A closing quote is not recognised if it is immediately followed by a +letter (the 'f' in 'footnote' in the following example): + + ``Double-quoted text''footnote:[Lorum ipsum...] + +A workaround is to put a word-joiner between the trailing quote +and the footnote (the `{empty}` attribute would also work), for +example: + + ``Double-quoted text''{wj}footnote:[Lorum ipsum...] + diff --git a/source-builder/sb/asciidoc/doc/images/icons/README b/source-builder/sb/asciidoc/doc/images/icons/README new file mode 100644 index 0000000..f12b2a7 --- /dev/null +++ b/source-builder/sb/asciidoc/doc/images/icons/README @@ -0,0 +1,5 @@ +Replaced the plain DocBook XSL admonition icons with Jimmac's DocBook +icons (http://jimmac.musichall.cz/ikony.php3). I dropped transparency +from the Jimmac icons to get round MS IE and FOP PNG incompatibilies. + +Stuart Rackham diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/1.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/1.png new file mode 100644 index 0000000..7d47343 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/1.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/10.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/10.png new file mode 100644 index 0000000..997bbc8 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/10.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/11.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/11.png new file mode 100644 index 0000000..ce47dac Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/11.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/12.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/12.png new file mode 100644 index 0000000..31daf4e Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/12.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/13.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/13.png new file mode 100644 index 0000000..14021a8 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/13.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/14.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/14.png new file mode 100644 index 0000000..64014b7 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/14.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/15.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/15.png new file mode 100644 index 0000000..0d65765 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/15.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/2.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/2.png new file mode 100644 index 0000000..5d09341 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/2.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/3.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/3.png new file mode 100644 index 0000000..ef7b700 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/3.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/4.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/4.png new file mode 100644 index 0000000..adb8364 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/4.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/5.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/5.png new file mode 100644 index 0000000..4d7eb46 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/5.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/6.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/6.png new file mode 100644 index 0000000..0ba694a Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/6.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/7.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/7.png new file mode 100644 index 0000000..472e96f Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/7.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/8.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/8.png new file mode 100644 index 0000000..5e60973 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/8.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/callouts/9.png b/source-builder/sb/asciidoc/doc/images/icons/callouts/9.png new file mode 100644 index 0000000..a0676d2 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/callouts/9.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/caution.png b/source-builder/sb/asciidoc/doc/images/icons/caution.png new file mode 100644 index 0000000..9a8c515 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/caution.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/example.png b/source-builder/sb/asciidoc/doc/images/icons/example.png new file mode 100644 index 0000000..1199e86 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/example.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/home.png b/source-builder/sb/asciidoc/doc/images/icons/home.png new file mode 100644 index 0000000..37a5231 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/home.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/important.png b/source-builder/sb/asciidoc/doc/images/icons/important.png new file mode 100644 index 0000000..be685cc Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/important.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/next.png b/source-builder/sb/asciidoc/doc/images/icons/next.png new file mode 100644 index 0000000..64e126b Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/next.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/note.png b/source-builder/sb/asciidoc/doc/images/icons/note.png new file mode 100644 index 0000000..7c1f3e2 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/note.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/prev.png b/source-builder/sb/asciidoc/doc/images/icons/prev.png new file mode 100644 index 0000000..3e8f12f Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/prev.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/tip.png b/source-builder/sb/asciidoc/doc/images/icons/tip.png new file mode 100644 index 0000000..f087c73 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/tip.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/up.png b/source-builder/sb/asciidoc/doc/images/icons/up.png new file mode 100644 index 0000000..2db1ce6 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/up.png differ diff --git a/source-builder/sb/asciidoc/doc/images/icons/warning.png b/source-builder/sb/asciidoc/doc/images/icons/warning.png new file mode 100644 index 0000000..d41edb9 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/icons/warning.png differ diff --git a/source-builder/sb/asciidoc/doc/images/smallnew.png b/source-builder/sb/asciidoc/doc/images/smallnew.png new file mode 100644 index 0000000..411c2e1 Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/smallnew.png differ diff --git a/source-builder/sb/asciidoc/doc/images/tiger.png b/source-builder/sb/asciidoc/doc/images/tiger.png new file mode 100644 index 0000000..332b11f Binary files /dev/null and b/source-builder/sb/asciidoc/doc/images/tiger.png differ diff --git a/source-builder/sb/asciidoc/doc/latex-backend.txt b/source-builder/sb/asciidoc/doc/latex-backend.txt new file mode 100644 index 0000000..32d87df --- /dev/null +++ b/source-builder/sb/asciidoc/doc/latex-backend.txt @@ -0,0 +1,192 @@ +LaTeX backend for Asciidoc +========================== +Benjamin Klum +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 <>. +============================== + +== 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 <>. + +=== 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 <> 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:[
+ +i.e. epub is not generating CSS borders (same for generated th elements). + +Compare this with the (correct) xhtml DocBook XSL generates the correct border +styles: + + + + + +=== epub: htmltoc is not generated +https://sourceforge.net/tracker/?func=detail&aid=2849686&group_id=21935&atid=373747 + +Environment: DocBook XSL 1.75.2; Xubuntu 8.04 + +If DocBook XSL TOC generation is specified the generated +'contents.opf' contains an 'htmltoc' element but the referenced TOC file +is not generated by DocBook XSL. For example the contents.opf contains: + + + +but the actual TOC file `OEBPS/ar01-toc.html` is missing and epubcheck +generates validation errors like: + + ERROR: doc/article.epub: OPS/XHTML file OEBPS/ar01-toc.html is missing + + +=== epub: leading dot in directory name error +https://sourceforge.net/tracker/?func=detail&aid=2849683&group_id=21935&atid=373747 + +Environment: DocBook XSL 1.75.2; Xubuntu 8.04 + +Specifying paths with a leading dot causes problems, for example: + + + +This generates validation errors like: + + ERROR: article.epub/OEBPS/index.html(4): + 'OEBPS/./docbook-xsl.css': referenced resource missing in the package + +The file is in the archive at the correct location, just doesn't +seem to like './' in the path name -- the path needs to be normalized +before being written to the contents.opf. + +It's not just the validator, the file is missing when the EPUB is viewed +(in bookworm). + +This works fine: + + + + +[[X2]] +=== epub: admonition icon images missing from contents.opf +NOTE: A workaround for this problem was added in `a2x(1)` version +8.6.5. + +https://sourceforge.net/tracker/?func=detail&aid=2849681&group_id=21935&atid=373747 + +Environment: DocBook XSL 1.75.2; Xubuntu 8.04 + +When admonition icons are specified epubcheck generates validation +errors like: + + ERROR: article.epub/OEBPS/index.html(4): + 'OEBPS/images/icons/note.png': referenced resource exists, + but not declared in the OPF file + +i.e. The admonition icon is in the EPUB file but DocBook XSL has not +been added to the content.opf manifest. Compare this with callout icons +which are processed correctly. + + +[[X3]] +=== Table width attribute validation error +https://sourceforge.net/tracker/?func=detail&aid=2848734&group_id=21935&atid=373747 + +Environment: DocBook XSL 1.75.2; Xubuntu 8.04 + +I get the following validation errors when navigation headers are in +included in the generated XHTML: + + ERROR: article.epub/OEBPS/ix01.html(3): attribute "width" not allowed + at this point; ignored + +This is because DocBook XSL has emitted invalid XHTML 1.1: tables +using the 'width' element are generated automatically in navigation +headers. + +Though, admittedly, navigation is redundant if you're reading with an +EPUB reader. Suppress by setting the suppress.navigation param to 1. + +Is this a DocBook XSL bug? + + +The Linux zip(1) command +------------------------ +If you use the Linux `zip(1)` command to update or create EPUB files +you must use the `-X`, `--no-extra` command-line option, if you do not +the platform dependent extra fields will confuse `epubcheck(1)` which +will emit errors like ``extra field length for first filename must be +0, but was 28''. diff --git a/source-builder/sb/asciidoc/doc/faq.txt b/source-builder/sb/asciidoc/doc/faq.txt new file mode 100644 index 0000000..2723f20 --- /dev/null +++ b/source-builder/sb/asciidoc/doc/faq.txt @@ -0,0 +1,1358 @@ +AsciiDoc Frequently Asked Questions +=================================== + + +NOTE: New FAQs are appended to the bottom of this document. + +///////////////////////////////////////////////////////////////// +ADD NEW FAQS TO THE BOTTOM OF THIS DOCUMENT TO MAINTAIN NUMBERING +///////////////////////////////////////////////////////////////// + +== How do you handle spaces in included file names? +Spaces are not allowed in macro targets so this include macro will not +be processed: + + include::my document.txt[] + +The work-around is to replace the spaces with the `{sp}` (space +character) attribute, for example: + + include::my{sp}document.txt[] + + +== How do I number all paragraphs? +Some documents such as specifications and legalese require all +paragraphs to be sequentially numbered through the document, and to be +able to reference these numbers. + +This can be achieved by using the DocBook toolchain but numbering the +paragraphs with AsciiDoc using a custom config file containing the +following (see http://www.methods.co.nz/asciidoc/userguide.html#X27 +for ways to include such a file): + +--------------------------------------------------------------------- +[paragraph] +{title} +{title%} +{paracounter} | +{title%} +{title#} +{counter2:paracounter} +{empty} +--------------------------------------------------------------------- + +References to the paragraphs operate in the normal way, you label the +paragraph: + +----------------------------- +[[some_label_you_understand]] +paragraph contents +----------------------------- + +and reference it in the normal manner: + +----------------------------- +<> +----------------------------- + +The text of the reference will be the paragraph number. + +For this to work for HTML you have to generate it via the DocBook +toolchain. + + +== Sources of information on configuring DocBook toolchains +DocBook is a content and structure markup language, therefore +AsciiDoc generated DocBook markup is also limited to content and +structure. Layout and formatting definition is specific to the +DocBook toolchain. + +The dblatex toolchain can be configured by setting parameters defined +at http://dblatex.sourceforge.net/doc/manual/sec-params.html or for +more complex styling by custom Latex stylesheets described at +http://dblatex.sourceforge.net/doc/manual/sec-custom-latex.html. + +Similarly FOP can be configured by parameters described at +http://sagehill.net/docbookxsl/OptionsPart.html and with custom xsl +stylesheets generating formatting objects as described at +http://sagehill.net/docbookxsl/CustomizingPart.html. + + +[[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 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 to 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 this 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 (<>): + + 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 <> (this link displays the text 'A titled paragraph'). + +[id="X2",reftext="2nd section"] +Section Two +----------- +See also <> (this link displays the text 'Section One'). + +[[X3]] +.A titled paragraph +Lorem ipsum dolor sit amet, consectetuer adipiscing elit. + +See also <> (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 +(simplified) example for HTML backends 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=|
, style= + +endif::linkcss[] +ifdef::asciimath[] +ifdef::linkcss[] + +endif::linkcss[] +ifndef::linkcss[] + +endif::linkcss[] +endif::asciimath[] +ifdef::latexmath[] +ifdef::linkcss[] + +endif::linkcss[] +ifndef::linkcss[] + +endif::linkcss[] +endif::latexmath[] + + + + +[footer] + + diff --git a/source-builder/sb/asciidoc/stylesheets/asciidoc.css b/source-builder/sb/asciidoc/stylesheets/asciidoc.css index be88313..163de67 100644 --- a/source-builder/sb/asciidoc/stylesheets/asciidoc.css +++ b/source-builder/sb/asciidoc/stylesheets/asciidoc.css @@ -86,9 +86,7 @@ ul > li > * { color: black; } padding: 0; margin: 0; } -pre { - white-space: pre-wrap; -} + #author { color: #527bbd; @@ -217,7 +215,7 @@ div.exampleblock > div.content { } div.imageblock div.content { padding-left: 0; } -span.image img { border-style: none; vertical-align: text-bottom; } +span.image img { border-style: none; } a.image:visited { color: white; } dl { diff --git a/source-builder/sb/asciidoc/stylesheets/pygments.css b/source-builder/sb/asciidoc/stylesheets/pygments.css index 2c5a906..9ca3659 100644 --- a/source-builder/sb/asciidoc/stylesheets/pygments.css +++ b/source-builder/sb/asciidoc/stylesheets/pygments.css @@ -1,13 +1,16 @@ +/* + pygmentize filter +*/ .highlight .hll { background-color: #ffffcc } -.highlight { background: #f8f8f8; } -.highlight .c { color: #408080; font-style: italic } /* Comment */ +.highlight { background: #f4f4f4; } +.highlight .c { color: #008800; font-style: italic } /* Comment */ .highlight .err { border: 1px solid #FF0000 } /* Error */ -.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .k { color: #AA22FF; font-weight: bold } /* Keyword */ .highlight .o { color: #666666 } /* Operator */ -.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #BC7A00 } /* Comment.Preproc */ -.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */ +.highlight .cm { color: #008800; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #008800 } /* Comment.Preproc */ +.highlight .c1 { color: #008800; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #008800; font-weight: bold } /* Comment.Special */ .highlight .gd { color: #A00000 } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .gr { color: #FF0000 } /* Generic.Error */ @@ -18,45 +21,46 @@ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ .highlight .gt { color: #0040D0 } /* Generic.Traceback */ -.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #008000 } /* Keyword.Pseudo */ -.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .kc { color: #AA22FF; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #AA22FF; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #AA22FF; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #AA22FF } /* Keyword.Pseudo */ +.highlight .kr { color: #AA22FF; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #00BB00; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #666666 } /* Literal.Number */ -.highlight .s { color: #BA2121 } /* Literal.String */ -.highlight .na { color: #7D9029 } /* Name.Attribute */ -.highlight .nb { color: #008000 } /* Name.Builtin */ -.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .s { color: #BB4444 } /* Literal.String */ +.highlight .na { color: #BB4444 } /* Name.Attribute */ +.highlight .nb { color: #AA22FF } /* Name.Builtin */ +.highlight .nc { color: #0000FF } /* Name.Class */ .highlight .no { color: #880000 } /* Name.Constant */ .highlight .nd { color: #AA22FF } /* Name.Decorator */ .highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */ .highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */ -.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nf { color: #00A000 } /* Name.Function */ .highlight .nl { color: #A0A000 } /* Name.Label */ .highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ .highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .nv { color: #B8860B } /* Name.Variable */ .highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mf { color: #666666 } /* Literal.Number.Float */ .highlight .mh { color: #666666 } /* Literal.Number.Hex */ .highlight .mi { color: #666666 } /* Literal.Number.Integer */ .highlight .mo { color: #666666 } /* Literal.Number.Oct */ -.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ -.highlight .sc { color: #BA2121 } /* Literal.String.Char */ -.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .sb { color: #BB4444 } /* Literal.String.Backtick */ +.highlight .sc { color: #BB4444 } /* Literal.String.Char */ +.highlight .sd { color: #BB4444; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BB4444 } /* Literal.String.Double */ .highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ -.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .sh { color: #BB4444 } /* Literal.String.Heredoc */ .highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ .highlight .sx { color: #008000 } /* Literal.String.Other */ .highlight .sr { color: #BB6688 } /* Literal.String.Regex */ -.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ -.highlight .ss { color: #19177C } /* Literal.String.Symbol */ -.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ -.highlight .vc { color: #19177C } /* Name.Variable.Class */ -.highlight .vg { color: #19177C } /* Name.Variable.Global */ -.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .s1 { color: #BB4444 } /* Literal.String.Single */ +.highlight .ss { color: #B8860B } /* Literal.String.Symbol */ +.highlight .bp { color: #AA22FF } /* Name.Builtin.Pseudo */ +.highlight .vc { color: #B8860B } /* Name.Variable.Class */ +.highlight .vg { color: #B8860B } /* Name.Variable.Global */ +.highlight .vi { color: #B8860B } /* Name.Variable.Instance */ .highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ + diff --git a/source-builder/sb/asciidoc/tests/asciidocapi.py b/source-builder/sb/asciidoc/tests/asciidocapi.py new file mode 100644 index 0000000..dcdf262 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/asciidocapi.py @@ -0,0 +1,257 @@ +#!/usr/bin/env python +""" +asciidocapi - AsciiDoc API wrapper class. + +The AsciiDocAPI class provides an API for executing asciidoc. Minimal example +compiles `mydoc.txt` to `mydoc.html`: + + import asciidocapi + asciidoc = asciidocapi.AsciiDocAPI() + asciidoc.execute('mydoc.txt') + +- Full documentation in asciidocapi.txt. +- See the doctests below for more examples. + +Doctests: + +1. Check execution: + + >>> import StringIO + >>> infile = StringIO.StringIO('Hello *{author}*') + >>> outfile = StringIO.StringIO() + >>> asciidoc = AsciiDocAPI() + >>> asciidoc.options('--no-header-footer') + >>> asciidoc.attributes['author'] = 'Joe Bloggs' + >>> asciidoc.execute(infile, outfile, backend='html4') + >>> print outfile.getvalue() +

Hello Joe Bloggs

+ + >>> asciidoc.attributes['author'] = 'Bill Smith' + >>> infile = StringIO.StringIO('Hello _{author}_') + >>> outfile = StringIO.StringIO() + >>> asciidoc.execute(infile, outfile, backend='docbook') + >>> print outfile.getvalue() + Hello Bill Smith + +2. Check error handling: + + >>> import StringIO + >>> asciidoc = AsciiDocAPI() + >>> infile = StringIO.StringIO('---------') + >>> outfile = StringIO.StringIO() + >>> asciidoc.execute(infile, outfile) + Traceback (most recent call last): + File "", line 1, in + File "asciidocapi.py", line 189, in execute + raise AsciiDocError(self.messages[-1]) + AsciiDocError: ERROR: : line 1: [blockdef-listing] missing closing delimiter + + +Copyright (C) 2009 Stuart Rackham. Free use of this software is granted +under the terms of the GNU General Public License (GPL). + +""" + +import sys,os,re,imp + +API_VERSION = '0.1.2' +MIN_ASCIIDOC_VERSION = '8.4.1' # Minimum acceptable AsciiDoc version. + + +def find_in_path(fname, path=None): + """ + Find file fname in paths. Return None if not found. + """ + if path is None: + path = os.environ.get('PATH', '') + for dir in path.split(os.pathsep): + fpath = os.path.join(dir, fname) + if os.path.isfile(fpath): + return fpath + else: + return None + + +class AsciiDocError(Exception): + pass + + +class Options(object): + """ + Stores asciidoc(1) command options. + """ + def __init__(self, values=[]): + self.values = values[:] + def __call__(self, name, value=None): + """Shortcut for append method.""" + self.append(name, value) + def append(self, name, value=None): + if type(value) in (int,float): + value = str(value) + self.values.append((name,value)) + + +class Version(object): + """ + Parse and compare AsciiDoc version numbers. Instance attributes: + + string: String version number '.[.][suffix]'. + major: Integer major version number. + minor: Integer minor version number. + micro: Integer micro version number. + suffix: Suffix (begins with non-numeric character) is ignored when + comparing. + + Doctest examples: + + >>> Version('8.2.5') < Version('8.3 beta 1') + True + >>> Version('8.3.0') == Version('8.3. beta 1') + True + >>> Version('8.2.0') < Version('8.20') + True + >>> Version('8.20').major + 8 + >>> Version('8.20').minor + 20 + >>> Version('8.20').micro + 0 + >>> Version('8.20').suffix + '' + >>> Version('8.20 beta 1').suffix + 'beta 1' + + """ + def __init__(self, version): + self.string = version + reo = re.match(r'^(\d+)\.(\d+)(\.(\d+))?\s*(.*?)\s*$', self.string) + if not reo: + raise ValueError('invalid version number: %s' % self.string) + groups = reo.groups() + self.major = int(groups[0]) + self.minor = int(groups[1]) + self.micro = int(groups[3] or '0') + self.suffix = groups[4] or '' + def __cmp__(self, other): + result = cmp(self.major, other.major) + if result == 0: + result = cmp(self.minor, other.minor) + if result == 0: + result = cmp(self.micro, other.micro) + return result + + +class AsciiDocAPI(object): + """ + AsciiDoc API class. + """ + def __init__(self, asciidoc_py=None): + """ + Locate and import asciidoc.py. + Initialize instance attributes. + """ + self.options = Options() + self.attributes = {} + self.messages = [] + # Search for the asciidoc command file. + # Try ASCIIDOC_PY environment variable first. + cmd = os.environ.get('ASCIIDOC_PY') + if cmd: + if not os.path.isfile(cmd): + raise AsciiDocError('missing ASCIIDOC_PY file: %s' % cmd) + elif asciidoc_py: + # Next try path specified by caller. + cmd = asciidoc_py + if not os.path.isfile(cmd): + raise AsciiDocError('missing file: %s' % cmd) + else: + # Try shell search paths. + for fname in ['asciidoc.py','asciidoc.pyc','asciidoc']: + cmd = find_in_path(fname) + if cmd: break + else: + # Finally try current working directory. + for cmd in ['asciidoc.py','asciidoc.pyc','asciidoc']: + if os.path.isfile(cmd): break + else: + raise AsciiDocError('failed to locate asciidoc') + self.cmd = os.path.realpath(cmd) + self.__import_asciidoc() + + def __import_asciidoc(self, reload=False): + ''' + Import asciidoc module (script or compiled .pyc). + See + http://groups.google.com/group/asciidoc/browse_frm/thread/66e7b59d12cd2f91 + for an explanation of why a seemingly straight-forward job turned out + quite complicated. + ''' + if os.path.splitext(self.cmd)[1] in ['.py','.pyc']: + sys.path.insert(0, os.path.dirname(self.cmd)) + try: + try: + if reload: + import __builtin__ # Because reload() is shadowed. + __builtin__.reload(self.asciidoc) + else: + import asciidoc + self.asciidoc = asciidoc + except ImportError: + raise AsciiDocError('failed to import ' + self.cmd) + finally: + del sys.path[0] + else: + # The import statement can only handle .py or .pyc files, have to + # use imp.load_source() for scripts with other names. + try: + imp.load_source('asciidoc', self.cmd) + import asciidoc + self.asciidoc = asciidoc + except ImportError: + raise AsciiDocError('failed to import ' + self.cmd) + if Version(self.asciidoc.VERSION) < Version(MIN_ASCIIDOC_VERSION): + raise AsciiDocError( + 'asciidocapi %s requires asciidoc %s or better' + % (API_VERSION, MIN_ASCIIDOC_VERSION)) + + def execute(self, infile, outfile=None, backend=None): + """ + Compile infile to outfile using backend format. + infile can outfile can be file path strings or file like objects. + """ + self.messages = [] + opts = Options(self.options.values) + if outfile is not None: + opts('--out-file', outfile) + if backend is not None: + opts('--backend', backend) + for k,v in self.attributes.items(): + if v == '' or k[-1] in '!@': + s = k + elif v is None: # A None value undefines the attribute. + s = k + '!' + else: + s = '%s=%s' % (k,v) + opts('--attribute', s) + args = [infile] + # The AsciiDoc command was designed to process source text then + # exit, there are globals and statics in asciidoc.py that have + # to be reinitialized before each run -- hence the reload. + self.__import_asciidoc(reload=True) + try: + try: + self.asciidoc.execute(self.cmd, opts.values, args) + finally: + self.messages = self.asciidoc.messages[:] + except SystemExit, e: + if e.code: + raise AsciiDocError(self.messages[-1]) + + +if __name__ == "__main__": + """ + Run module doctests. + """ + import doctest + options = doctest.NORMALIZE_WHITESPACE + doctest.ELLIPSIS + doctest.testmod(optionflags=options) diff --git a/source-builder/sb/asciidoc/tests/data/deprecated-quotes.txt b/source-builder/sb/asciidoc/tests/data/deprecated-quotes.txt new file mode 100644 index 0000000..2f44edf --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/deprecated-quotes.txt @@ -0,0 +1,12 @@ +// Deprecated quote attributes. +[role="foo"]##fun with text##. +["green","yellow",2,role="foo"]##fun with text##. +[green,yellow,2]##fun with text##. +More [red,black,4]*fun with text*. +Yet more [red,,1.5]**fun with text**. +Yet more [red,,1.5]+fun with text+. +Yet more [red,,1.5]'fun with text'. + +Yet more [red,,1.5]_fun with text_. + +Yet more [orange]'fun with text'. diff --git a/source-builder/sb/asciidoc/tests/data/filters-test.txt b/source-builder/sb/asciidoc/tests/data/filters-test.txt new file mode 100644 index 0000000..a8b051e --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/filters-test.txt @@ -0,0 +1,90 @@ +Filter Tests +============ + + +== Toy filter example from User Guide + +[code,python] +---------------------------------------------- +''' A multi-line + comment.''' +def sub_word(mo): + ''' Single line comment.''' + word = mo.group('word') # Inline comment + if word in keywords[language]: + return quote + word + quote + else: + return word +---------------------------------------------- + + +== Pychart Chart generations from FAQ + +// Generate chart image file. +sys2::[python "{indir}/barchart.py" --format=png --output="{outdir={indir}}/{imagesdir=}{imagesdir?/}barchart.png" --scale=2] + +// Display chart image file. +image::barchart.png[] + + +== Graphviz Graphs + +.Simple graph +["graphviz", "graphviz1.png", alt="Graphviz->AsciiDoc->HTML"] +--------------------------------------------------------------------- +digraph G { rankdir=LR; Graphviz->AsciiDoc->HTML} +--------------------------------------------------------------------- + +.Not so simple graph +["graphviz", "graphviz2.png"] +--------------------------------------------------------------------- +digraph automata_0 { + size ="8.5, 11"; + node [shape = circle]; + 0 [ style = filled, color=lightgrey ]; + 2 [ shape = doublecircle ]; + 0 -> 2 [ label = "a " ]; + 0 -> 1 [ label = "other " ]; + 1 -> 2 [ label = "a " ]; + 1 -> 1 [ label = "other " ]; + 2 -> 2 [ label = "a " ]; + 2 -> 1 [ label = "other " ]; + "Machine: a" [ shape = plaintext ]; +} +--------------------------------------------------------------------- + + +== Music filter + +.A tune generated from ABC notation +[music,music1.png] +--------------------------------------------------------------------- +T:The Butterfly +R:slip jig +C:Tommy Potts +H:Fiddle player Tommy Potts made this tune from two older slip jigs, +H:one of which is called "Skin the Peelers" in Roche's collection. +D:Bothy Band: 1975. +M:9/8 +K:Em +vB2(E G2)(E F3)|B2(E G2)(E F)ED|vB2(E G2)(E F3)|(B2d) d2(uB A)FD:| +|:(vB2c) (e2f) g3|(uB2d) (g2e) (dBA)|(B2c) (e2f) g2(ua|b2a) (g2e) (dBA):| +|:~B3 (B2A) G2A|~B3 BA(uB d)BA|~B3 (B2A) G2(A|B2d) (g2e) (dBA):| +--------------------------------------------------------------------- + +<>. + +[[X1]] +.A fragment generated from LilyPond source +["music", "music2.png", "ly", link="music2.ly"] +--------------------------------------------------------------------- +\version "2.10.0" +\paper { + ragged-right = ##t +} +{ + \time 3/4 + \clef bass + c2 e4 g2. f4 e d c2 r4 +} +--------------------------------------------------------------------- diff --git a/source-builder/sb/asciidoc/tests/data/lang-de-man-test.txt b/source-builder/sb/asciidoc/tests/data/lang-de-man-test.txt new file mode 100644 index 0000000..f1806d4 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-de-man-test.txt @@ -0,0 +1,21 @@ +// Test for lang-de.conf language file. +:lang: de + +ASCIIDOC(1) +=========== +:doctype: manpage + +NAME +---- +asciidoc - converts an AsciiDoc text file to HTML or DocBook + +ÜBERSICHT +--------- +*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. + +... diff --git a/source-builder/sb/asciidoc/tests/data/lang-de-test.txt b/source-builder/sb/asciidoc/tests/data/lang-de-test.txt new file mode 100644 index 0000000..ebddb62 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-de-test.txt @@ -0,0 +1,106 @@ +// Test for lang-de.conf language file. +:lang: de + +Languages Test +============== +:revnumber: v1.0 +:revdate: 2003-12-21 + +ifdef::doctype-article[] +Zusammenfassung +--------------- +Abstract special section. + +endif::doctype-article[] + + +ifdef::doctype-book[] +Widmung +------- +Dedication special section. + + +Vorwort +------- +Preface special section. + + +Kolophon +-------- +Colophon special section. + +endif::doctype-book[] + + +The First Section +----------------- +Admonishments +~~~~~~~~~~~~~ +Do not translate in the source file -- they are translated to the +output file + +NOTE: Lorum ipsum. + +TIP: Lorum ipsum. + +WARNING: Lorum ipsum. + +CAUTION: Lorum ipsum. + +IMPORTANT: Lorum ipsum. + +.Tiger +image::../../images/tiger.png[Tiger image] + +Followed by an example table: + +.Table +[width="60%",options="header"] +|============================================== +| Option | Description +| -a 'USER GROUP' | Add 'USER' to 'GROUP'. +| -R 'GROUP' | Disables access to 'GROUP'. +|============================================== + +And now for something completely different: ((monkeys)), lions and +tigers. + + +Anhang A: Example Appendix +-------------------------- +Appendix special section. + + +Literaturverzeichnis +-------------------- +Bibliography special section. + +[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. + + +Glossar +------- +Glossary special section. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +ifdef::basebackend-docbook[] +Stichwortverzeichnis +-------------------- +//////////////////////////////////////////////////////////////// +Index special section. +The index is normally left completely empty, it's contents being +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// +endif::basebackend-docbook[] diff --git a/source-builder/sb/asciidoc/tests/data/lang-en-man-test.txt b/source-builder/sb/asciidoc/tests/data/lang-en-man-test.txt new file mode 100644 index 0000000..0dec04a --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-en-man-test.txt @@ -0,0 +1,21 @@ +// Test for lang-en.conf language file. +:lang: en + +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. + +... diff --git a/source-builder/sb/asciidoc/tests/data/lang-en-test.txt b/source-builder/sb/asciidoc/tests/data/lang-en-test.txt new file mode 100644 index 0000000..a312458 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-en-test.txt @@ -0,0 +1,114 @@ +// Test for lang-en.conf language file. +:lang: en + +Languages Test +============== +:revnumber: v1.0 +:revdate: 2003-12-21 + +ifdef::doctype-article[] +// Translate title. +Abstract +-------- +Abstract special section. + +endif::doctype-article[] + + +ifdef::doctype-book[] +// Translate title. +Dedication +---------- +Dedication special section. + + +// Translate title. +Preface +------- +Preface special section. + + +// Translate title. +Colophon +-------- +Colophon special section. + +endif::doctype-book[] + + +The First Section +----------------- +Admonishments +~~~~~~~~~~~~~ +Do not translate in the source file -- they are translated to the +output file + +NOTE: Lorum ipsum. + +TIP: Lorum ipsum. + +WARNING: Lorum ipsum. + +CAUTION: Lorum ipsum. + +IMPORTANT: Lorum ipsum. + +.Tiger +image::../../images/tiger.png[Tiger image] + +Followed by an example table: + +.Table +[width="60%",options="header"] +|============================================== +| Option | Description +| -a 'USER GROUP' | Add 'USER' to 'GROUP'. +| -R 'GROUP' | Disables access to 'GROUP'. +|============================================== + +And now for something completely different: ((monkeys)), lions and +tigers. + + +// Translate title. +Appendix A: Example Appendix +---------------------------- +Appendix special section. + + +// Translate title. +Bibliography +------------ +Bibliography special section. + +[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. + + +// Translate title. +Glossary +-------- +Glossary special section. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +ifdef::basebackend-docbook[] +// Translate title. +Index +----- +//////////////////////////////////////////////////////////////// +Index special section. +The index is normally left completely empty, it's contents being +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// +endif::basebackend-docbook[] diff --git a/source-builder/sb/asciidoc/tests/data/lang-es-man-test.txt b/source-builder/sb/asciidoc/tests/data/lang-es-man-test.txt new file mode 100644 index 0000000..cb95b70 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-es-man-test.txt @@ -0,0 +1,21 @@ +// Test for lang-es.conf language file. +:lang: es + +ASCIIDOC(1) +=========== +:doctype: manpage + +NAME +---- +asciidoc - converts an AsciiDoc text file to HTML or DocBook + +SINOPSIS +-------- +*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. + +... diff --git a/source-builder/sb/asciidoc/tests/data/lang-es-test.txt b/source-builder/sb/asciidoc/tests/data/lang-es-test.txt new file mode 100644 index 0000000..97eca94 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-es-test.txt @@ -0,0 +1,106 @@ +// Test for lang-es.conf language file. +:lang: es + +Languages Test +============== +:revnumber: v1.0 +:revdate: 2003-12-21 + +ifdef::doctype-article[] +Resumen +------- +Abstract special section. + +endif::doctype-article[] + + +ifdef::doctype-book[] +Dedicación +---------- +Dedication special section. + + +Prefacio +-------- +Preface special section. + + +Colofón +------- +Colophon special section. + +endif::doctype-book[] + + +The First Section +----------------- +Admonishments +~~~~~~~~~~~~~ +Do not translate in the source file -- they are translated to the +output file + +NOTE: Lorum ipsum. + +TIP: Lorum ipsum. + +WARNING: Lorum ipsum. + +CAUTION: Lorum ipsum. + +IMPORTANT: Lorum ipsum. + +.Tiger +image::../../images/tiger.png[Tiger image] + +Followed by an example table: + +.Table +[width="60%",options="header"] +|============================================== +| Option | Description +| -a 'USER GROUP' | Add 'USER' to 'GROUP'. +| -R 'GROUP' | Disables access to 'GROUP'. +|============================================== + +And now for something completely different: ((monkeys)), lions and +tigers. + + +Apéndice A: Example Appendix +---------------------------- +Appendix special section. + + +Bibliografía +------------ +Bibliography special section. + +[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. + + +Glosario +-------- +Glossary special section. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +ifdef::basebackend-docbook[] +Índice +------ +//////////////////////////////////////////////////////////////// +Index special section. +The index is normally left completely empty, it's contents being +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// +endif::basebackend-docbook[] diff --git a/source-builder/sb/asciidoc/tests/data/lang-fr-man-test.txt b/source-builder/sb/asciidoc/tests/data/lang-fr-man-test.txt new file mode 100644 index 0000000..edb681f --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-fr-man-test.txt @@ -0,0 +1,21 @@ +// Test for lang-fr.conf language file. +:lang: fr + +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. + +... diff --git a/source-builder/sb/asciidoc/tests/data/lang-fr-test.txt b/source-builder/sb/asciidoc/tests/data/lang-fr-test.txt new file mode 100644 index 0000000..84c25fa --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-fr-test.txt @@ -0,0 +1,106 @@ +// Test for lang-fr.conf language file. +:lang: fr + +Languages Test +============== +:revnumber: v1.0 +:revdate: 2003-12-21 + +ifdef::doctype-article[] +Résumé +------ +Abstract special section. + +endif::doctype-article[] + + +ifdef::doctype-book[] +Dédicace +-------- +Dedication special section. + + +Préface +------- +Preface special section. + + +Colophon +-------- +Colophon special section. + +endif::doctype-book[] + + +The First Section +----------------- +Admonishments +~~~~~~~~~~~~~ +Do not translate in the source file -- they are translated to the +output file + +NOTE: Lorum ipsum. + +TIP: Lorum ipsum. + +WARNING: Lorum ipsum. + +CAUTION: Lorum ipsum. + +IMPORTANT: Lorum ipsum. + +.Tiger +image::../../images/tiger.png[Tiger image] + +Followed by an example table: + +.Table +[width="60%",options="header"] +|============================================== +| Option | Description +| -a 'USER GROUP' | Add 'USER' to 'GROUP'. +| -R 'GROUP' | Disables access to 'GROUP'. +|============================================== + +And now for something completely different: ((monkeys)), lions and +tigers. + + +Appendice A: Example Appendix +----------------------------- +Appendix special section. + + +Bibliographie +------------- +Bibliography special section. + +[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. + + +Glossaire +--------- +Glossary special section. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +ifdef::basebackend-docbook[] +Index +----- +//////////////////////////////////////////////////////////////// +Index special section. +The index is normally left completely empty, it's contents being +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// +endif::basebackend-docbook[] diff --git a/source-builder/sb/asciidoc/tests/data/lang-hu-man-test.txt b/source-builder/sb/asciidoc/tests/data/lang-hu-man-test.txt new file mode 100644 index 0000000..7caf1ad --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-hu-man-test.txt @@ -0,0 +1,21 @@ +// Test for lang-hu.conf language file. +:lang: hu + +ASCIIDOC(1) +=========== +:doctype: manpage + +NAME +---- +asciidoc - converts an AsciiDoc text file to HTML or DocBook + +ÁTTEKINTÉS +---------- +*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. + +... diff --git a/source-builder/sb/asciidoc/tests/data/lang-hu-test.txt b/source-builder/sb/asciidoc/tests/data/lang-hu-test.txt new file mode 100644 index 0000000..cf873c2 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-hu-test.txt @@ -0,0 +1,106 @@ +// Test for lang-hu.conf language file. +:lang: hu + +Languages Test +============== +:revnumber: v1.0 +:revdate: 2003-12-21 + +ifdef::doctype-article[] +Kivonat +------- +Abstract special section. + +endif::doctype-article[] + + +ifdef::doctype-book[] +Ajánlás +-------- +Dedication special section. + + +Előszó +------ +Preface special section. + + +Utószó +------ +Colophon special section. + +endif::doctype-book[] + + +The First Section +----------------- +Admonishments +~~~~~~~~~~~~~ +Do not translate in the source file -- they are translated to the +output file + +NOTE: Lorum ipsum. + +TIP: Lorum ipsum. + +WARNING: Lorum ipsum. + +CAUTION: Lorum ipsum. + +IMPORTANT: Lorum ipsum. + +.Tiger +image::../../images/tiger.png[Tiger image] + +Followed by an example table: + +.Table +[width="60%",options="header"] +|============================================== +| Option | Description +| -a 'USER GROUP' | Add 'USER' to 'GROUP'. +| -R 'GROUP' | Disables access to 'GROUP'. +|============================================== + +And now for something completely different: ((monkeys)), lions and +tigers. + + +A függelék: Example Appendix +---------------------------- +Appendix special section. + + +Bibliográfia +------------ +Bibliography special section. + +[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. + + +Szójegyzék +---------- +Glossary special section. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +ifdef::basebackend-docbook[] +Index +----- +//////////////////////////////////////////////////////////////// +Index special section. +The index is normally left completely empty, it's contents being +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// +endif::basebackend-docbook[] diff --git a/source-builder/sb/asciidoc/tests/data/lang-it-man-test.txt b/source-builder/sb/asciidoc/tests/data/lang-it-man-test.txt new file mode 100644 index 0000000..7309a0c --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-it-man-test.txt @@ -0,0 +1,21 @@ +// Test for lang-it.conf language file. +:lang: it + +ASCIIDOC(1) +=========== +:doctype: manpage + +NAME +---- +asciidoc - converts an AsciiDoc text file to HTML or DocBook + +SINOSSI +------- +*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. + +... diff --git a/source-builder/sb/asciidoc/tests/data/lang-it-test.txt b/source-builder/sb/asciidoc/tests/data/lang-it-test.txt new file mode 100644 index 0000000..790a57e --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-it-test.txt @@ -0,0 +1,106 @@ +// Test for lang-it.conf language file. +:lang: it + +Languages Test +============== +:revnumber: v1.0 +:revdate: 2003-12-21 + +ifdef::doctype-article[] +Abstract +-------- +Abstract special section. + +endif::doctype-article[] + + +ifdef::doctype-book[] +Dedica +------ +Dedication special section. + + +Prefazione +---------- +Preface special section. + + +Colofone +-------- +Colophon special section. + +endif::doctype-book[] + + +The First Section +----------------- +Admonishments +~~~~~~~~~~~~~ +Do not translate in the source file -- they are translated to the +output file + +NOTE: Lorum ipsum. + +TIP: Lorum ipsum. + +WARNING: Lorum ipsum. + +CAUTION: Lorum ipsum. + +IMPORTANT: Lorum ipsum. + +.Tiger +image::../../images/tiger.png[Tiger image] + +Followed by an example table: + +.Table +[width="60%",options="header"] +|============================================== +| Option | Description +| -a 'USER GROUP' | Add 'USER' to 'GROUP'. +| -R 'GROUP' | Disables access to 'GROUP'. +|============================================== + +And now for something completely different: ((monkeys)), lions and +tigers. + + +Appendice A: Example Appendix +----------------------------- +Appendix special section. + + +Bibliografia +------------ +Bibliography special section. + +[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. + + +Glossario +--------- +Glossary special section. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +ifdef::basebackend-docbook[] +Index +----- +//////////////////////////////////////////////////////////////// +Index special section. +The index is normally left completely empty, it's contents being +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// +endif::basebackend-docbook[] diff --git a/source-builder/sb/asciidoc/tests/data/lang-nl-man-test.txt b/source-builder/sb/asciidoc/tests/data/lang-nl-man-test.txt new file mode 100644 index 0000000..4844c17 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-nl-man-test.txt @@ -0,0 +1,21 @@ +// Test for lang-nl.conf language file. +:lang: nl + +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. + +... diff --git a/source-builder/sb/asciidoc/tests/data/lang-nl-test.txt b/source-builder/sb/asciidoc/tests/data/lang-nl-test.txt new file mode 100644 index 0000000..7e6e823 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-nl-test.txt @@ -0,0 +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[] diff --git a/source-builder/sb/asciidoc/tests/data/lang-pt-BR-man-test.txt b/source-builder/sb/asciidoc/tests/data/lang-pt-BR-man-test.txt new file mode 100644 index 0000000..0363ea6 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-pt-BR-man-test.txt @@ -0,0 +1,21 @@ +// Test for lang-pt-BR.conf language file. +:lang: pt-BR + +ASCIIDOC(1) +=========== +:doctype: manpage + +NAME +---- +asciidoc - converts an AsciiDoc text file to HTML or DocBook + +SINOPSE +------- +*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. + +... diff --git a/source-builder/sb/asciidoc/tests/data/lang-pt-BR-test.txt b/source-builder/sb/asciidoc/tests/data/lang-pt-BR-test.txt new file mode 100644 index 0000000..daaff18 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-pt-BR-test.txt @@ -0,0 +1,106 @@ +// Test for lang-pt-BR.conf language file. +:lang: pt-BR + +Languages Test +============== +:revnumber: v1.0 +:revdate: 2003-12-21 + +ifdef::doctype-article[] +Resumo +------ +Abstract special section. + +endif::doctype-article[] + + +ifdef::doctype-book[] +Dedicação +--------- +Dedication special section. + + +Prefácio +-------- +Preface special section. + + +Cólofon +------- +Colophon special section. + +endif::doctype-book[] + + +The First Section +----------------- +Admonishments +~~~~~~~~~~~~~ +Do not translate in the source file -- they are translated to the +output file + +NOTE: Lorum ipsum. + +TIP: Lorum ipsum. + +WARNING: Lorum ipsum. + +CAUTION: Lorum ipsum. + +IMPORTANT: Lorum ipsum. + +.Tiger +image::../../images/tiger.png[Tiger image] + +Followed by an example table: + +.Table +[width="60%",options="header"] +|============================================== +| Option | Description +| -a 'USER GROUP' | Add 'USER' to 'GROUP'. +| -R 'GROUP' | Disables access to 'GROUP'. +|============================================== + +And now for something completely different: ((monkeys)), lions and +tigers. + + +Appêndice A: Example Appendix +----------------------------- +Appendix special section. + + +Bibliografia +------------ +Bibliography special section. + +[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. + + +Glossário +--------- +Glossary special section. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +ifdef::basebackend-docbook[] +Índice +------ +//////////////////////////////////////////////////////////////// +Index special section. +The index is normally left completely empty, it's contents being +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// +endif::basebackend-docbook[] diff --git a/source-builder/sb/asciidoc/tests/data/lang-ru-man-test.txt b/source-builder/sb/asciidoc/tests/data/lang-ru-man-test.txt new file mode 100644 index 0000000..3e50548 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-ru-man-test.txt @@ -0,0 +1,21 @@ +// Test for lang-ru.conf language file. +:lang: ru + +ASCIIDOC(1) +=========== +:doctype: manpage + +NAME +---- +asciidoc - converts an AsciiDoc text file to HTML or DocBook + +ОБЗОР +----- +*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. + +... diff --git a/source-builder/sb/asciidoc/tests/data/lang-ru-test.txt b/source-builder/sb/asciidoc/tests/data/lang-ru-test.txt new file mode 100644 index 0000000..51d9b60 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-ru-test.txt @@ -0,0 +1,106 @@ +// Test for lang-ru.conf language file. +:lang: ru + +Languages Test +============== +:revnumber: v1.0 +:revdate: 2003-12-21 + +ifdef::doctype-article[] +Аннотация +--------- +Abstract special section. + +endif::doctype-article[] + + +ifdef::doctype-book[] +Посвящение +---------- +Dedication special section. + + +Введение +-------- +Preface special section. + + +Колофон +------- +Colophon special section. + +endif::doctype-book[] + + +The First Section +----------------- +Admonishments +~~~~~~~~~~~~~ +Do not translate in the source file -- they are translated to the +output file + +NOTE: Lorum ipsum. + +TIP: Lorum ipsum. + +WARNING: Lorum ipsum. + +CAUTION: Lorum ipsum. + +IMPORTANT: Lorum ipsum. + +.Tiger +image::../../images/tiger.png[Tiger image] + +Followed by an example table: + +.Table +[width="60%",options="header"] +|============================================== +| Option | Description +| -a 'USER GROUP' | Add 'USER' to 'GROUP'. +| -R 'GROUP' | Disables access to 'GROUP'. +|============================================== + +And now for something completely different: ((monkeys)), lions and +tigers. + + +Приложение A: Example Appendix +------------------------------ +Appendix special section. + + +Библиография +------------ +Bibliography special section. + +[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 special section. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +ifdef::basebackend-docbook[] +Предметный указатель +-------------------- +//////////////////////////////////////////////////////////////// +Index special section. +The index is normally left completely empty, it's contents being +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// +endif::basebackend-docbook[] diff --git a/source-builder/sb/asciidoc/tests/data/lang-uk-man-test.txt b/source-builder/sb/asciidoc/tests/data/lang-uk-man-test.txt new file mode 100644 index 0000000..8212e4c --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-uk-man-test.txt @@ -0,0 +1,21 @@ +// Test for lang-uk.conf language file. +:lang: uk + +ASCIIDOC(1) +=========== +:doctype: manpage + +NAME +---- +asciidoc - converts an AsciiDoc text file to HTML or DocBook + +ОГЛЯД +----- +*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. + +... diff --git a/source-builder/sb/asciidoc/tests/data/lang-uk-test.txt b/source-builder/sb/asciidoc/tests/data/lang-uk-test.txt new file mode 100644 index 0000000..76c58eb --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/lang-uk-test.txt @@ -0,0 +1,106 @@ +// Test for lang-uk.conf language file. +:lang: uk + +Languages Test +============== +:revnumber: v1.0 +:revdate: 2011-01-30 + +ifdef::doctype-article[] +Анотація +-------- +Abstract special section. + +endif::doctype-article[] + + +ifdef::doctype-book[] +Присвячення +----------- +Dedication special section. + + +Вступ +----- +Preface special section. + + +Колофон +------- +Colophon special section. + +endif::doctype-book[] + + +The First Section +----------------- +Admonishments +~~~~~~~~~~~~~ +Do not translate in the source file -- they are translated to the +output file + +NOTE: Lorum ipsum. + +TIP: Lorum ipsum. + +WARNING: Lorum ipsum. + +CAUTION: Lorum ipsum. + +IMPORTANT: Lorum ipsum. + +.Tiger +image::../../images/tiger.png[Tiger image] + +Followed by an example table: + +.Table +[width="60%",options="header"] +|============================================== +| Option | Description +| -a 'USER GROUP' | Add 'USER' to 'GROUP'. +| -R 'GROUP' | Disables access to 'GROUP'. +|============================================== + +And now for something completely different: ((monkeys)), lions and +tigers. + + +Додаток A: Example Appendix +--------------------------- +Appendix special section. + + +Бібліографія +------------ +Bibliography special section. + +[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 special section. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + + +ifdef::basebackend-docbook[] +Предметний покажчик +------------------- +//////////////////////////////////////////////////////////////// +Index special section. +The index is normally left completely empty, it's contents being +generated automatically by the DocBook toolchain. +//////////////////////////////////////////////////////////////// +endif::basebackend-docbook[] diff --git a/source-builder/sb/asciidoc/tests/data/oldtables.txt b/source-builder/sb/asciidoc/tests/data/oldtables.txt new file mode 100644 index 0000000..f6e0706 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/oldtables.txt @@ -0,0 +1,64 @@ +AsciiDoc Old Tables +=================== + +Examples of the AsciiDoc 'old tables' syntax. This syntax was used in +AsciiDoc versions up to 8.2.7 and has since been deprecated in favor +of the 'new tables' syntax. + +Simple table: + +`---`--- +1 2 +3 4 +5 6 +-------- + +Table with title, header and footer: + +.An example table +[grid="all"] +`-----------.-------------- +Column 1 Column 2 +--------------------------- +1 Item 1 +2 Item 2 +3 Item 3 +--------------------------- +6 Three items +--------------------------- + +Four columns totaling 15% of the 'pagewidth', CSV data: + +[frame="all"] +````~15 +1,2,3,4 +a,b,c,d +A,B,C,D +~~~~~~~~ + +A table with a numeric ruler and externally sourced CSV data: + +[frame="all", grid="all"] +`15`20`25`20`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +ID,Customer Name,Contact Name,Customer Address,Phone +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +"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/source-builder/sb/asciidoc/tests/data/open-block-test.txt b/source-builder/sb/asciidoc/tests/data/open-block-test.txt new file mode 100644 index 0000000..4826c3a --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/open-block-test.txt @@ -0,0 +1,117 @@ += Additional Open Block and Paragraph styles + + +[comment] +Lorum ipsum... + +[comment] +-- +Lorum ipsum... +-- + +[example] +Lorum ipsum... + +[example] +-- +Lorum ipsum... + +Lorum ipsum... +-- + +[sidebar] +Lorum ipsum... + +[sidebar] +.A title +-- +Lorum ipsum... + +Lorum ipsum... +-- + +[NOTE] +-- +Lorum ipsum... + +Lorum ipsum... +-- + +[CAUTION] +-- +Lorum ipsum... + +Lorum ipsum... +-- + +[IMPORTANT] +-- +Lorum ipsum... + +Lorum ipsum... +-- + +[WARNING] +-- +Lorum ipsum... + +Lorum ipsum... +-- + +[TIP] +-- +Lorum ipsum... + +Lorum ipsum... +-- + +[quote, Sir Arthur Conan Doyle, The Adventures of Sherlock Holmes] +-- +As he spoke there was the sharp sound of horses' hoofs and +grating wheels against the curb, followed by a sharp pull at the +bell. Holmes whistled. + +"A pair, by the sound," said he. "Yes," he continued, glancing +out of the window. "A nice little brougham and a pair of +beauties. A hundred and fifty guineas apiece. There's money in +this case, Watson, if there is nothing else." +-- + +[verse, William Blake, from Auguries of Innocence] +-- +To see a world in a grain of sand, +And a heaven in a wild flower, +Hold infinity in the palm of your hand, +And eternity in an hour. +-- + +[source,python] +-- +y = 15 + +if y == 24: + x = 42 +-- + +[latex] +-- +$y = \int_0^\infty \gamma^2 \cos(x) dx$ +-- + +[graphviz] +-- +digraph G { rankdir=LR; Graphviz->AsciiDoc->HTML} +-- + +[music] +-- +\version "2.10.0" +\paper { + ragged-right = ##t +} +{ + \time 3/4 + \clef bass + c2 e4 g2. f4 e d c2 r4 +} +-- diff --git a/source-builder/sb/asciidoc/tests/data/rcs-id-marker-test.txt b/source-builder/sb/asciidoc/tests/data/rcs-id-marker-test.txt new file mode 100644 index 0000000..55b0892 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/rcs-id-marker-test.txt @@ -0,0 +1,6 @@ +RCS $Id$ Marker Test +==================== +$Id: mydoc.txt,v 1.5 2009/05/17 17:58:44 jbloggs Exp $ + + +Lorum ipsum... diff --git a/source-builder/sb/asciidoc/tests/data/testcases.conf b/source-builder/sb/asciidoc/tests/data/testcases.conf new file mode 100644 index 0000000..de605ac --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/testcases.conf @@ -0,0 +1,12 @@ +[replacements] +test-replacement=TEST_REPLACEMENT + +[test-template] +This template is overriden and should not be displayed. + +[test-template] +Template line 1. + +[+test-template] +Template line 2. + diff --git a/source-builder/sb/asciidoc/tests/data/testcases.txt b/source-builder/sb/asciidoc/tests/data/testcases.txt new file mode 100644 index 0000000..0678d5c --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/testcases.txt @@ -0,0 +1,786 @@ +// +// A collection of AsciiDoc test cases. +// + +Test 'Cases' +============ +:author: Joe Bloggs +// Web page meta data. +:title: Test Cases +:keywords: AsciiDoc, DocBook, EPUB, slideshow +:description: AsciiDoc is a text document format for writing short documents, + + articles, books, slideshows and UNIX man pages. +:replacements.(\w)'(\w): \1’\2 +:test-attribute: TEST_ATTRIBUTE + + +== Passthrough attributes == +ifdef::basebackend-docbook[] +:passtest: pass:[*lorum ipsum*] +endif::basebackend-docbook[] +ifdef::basebackend-html[] +:passtest: pass:[*lorum ipsum*] +endif::basebackend-html[] +{passtest} + +ifdef::basebackend-docbook[] +:passtest: pass:specialcharacters,quotes[*lorum ipsum*] +endif::basebackend-docbook[] +ifdef::basebackend-html[] +:passtest: pass:specialcharacters,quotes[*lorum ipsum*] +endif::basebackend-html[] +{passtest} + + +== Author attributes == +\{eval:expression}, \{sys:command} and \{sys2:command}, \{counter:c1} + +Hello *{author}* ({firstname} {lastname}, {authorinitials}). + +{firstname,lastname,surname#}first name or last name or surname. + +{firstname+lastname+surname#}first name and last name and surname. + +{firstname+lastname#}first name and last name. + + +== System attributes == +{counter:c1} {counter:c2:99} {counter:c3:A} + +{c1} = 1, {c2} = 99, {c3} = A + +{counter:c1} {counter:c2:99} {counter:c3:A} +{c1} {c2} {c3} + +{c1} = 2, {c2} = 100, {c3} = B + +{set:y:Foobar} +y: {y} + +{set:y!} + +y: {y} + +:x: 3 +:y: {eval:{x}+4} + +{x}, {y} + +{set:y:{x}} + +{x}, {y} + + +== Quoted text attributes == + +A=_X_, (_X_), _X_, [_X_] _X_ + +A=*_X_*, (`_X_`), _`X`_, [*_X_*] +_X_+ _X_ + +// These two illustrate that nesting doesn't always work. +[_*X*_] _+X+_ + +[[_intro]] +<<_intro>> <<_intro,intro>> xref:_intro[] _intro_ + +// Quote attributes. +[foo]#fun with text#. +[foo bar]*fun with text*. +[foo]+fun with text+. +[foo]_fun with text_. +[foo]'fun with text'. +[foo]``fun with text''. +[foo]`fun with text'. + +[foo]$$fun with text$$. + +[foo]+++fun with text+++. + +[red]#Obvious# and [big red yellow-background]*very obvious*. + +[underline]#Underline text#, [overline]#overline text# +and [line-through]#line-through text#. + +[firstletter]##T##esting 123 ... + +(``+1\n+'') if (usually ``+-1\n+'') + +(``++1\n++'') if (usually ``++-1\n++'') + +(`{author}') and `{author}' + + +== Configuration attribute entries == + +:listdef-labeled.style: horizontal +term:: definition + +:listdef-labeled.style: vertical +term:: definition + +ifdef::backend-xhtml11[] +<> + +:xref2-inlinemacro.: {2?{2}} + +<> + +:xref2-inlinemacro.: {2=[{1}]} +endif::[] + + +== role attribute == + +[role="test"] +Paragraph with a role attribute. + +[role="test"] +- first +- second +- third + + +== Break list nesting == +1. List 1. +2. List 1. + +// New list. +a. List 2. +b. List 2. + + +== Listing Blocks == +[subs="quotes"] +------------------------------------------ +$ ls *-al* +------------------------------------------ + +[listing] +.......................................... +[subs="quotes"] +------------------------------------------ +$ ls *-al* +------------------------------------------ +.......................................... + +.Listing +------------------------------------------ +$ ls -al +------------------------------------------ + +.Listing example +========================================== +------------------------------------------ +$ ls -al +------------------------------------------ +========================================== + +.Python paragraph +[source,python] +if n < 0: print 'Hello World!' + +.Titled Python listing +[source,python] +------------------------------------------ +if n < 0: print 'Hello World!' +------------------------------------------ + +.Python listing example +========================================== +[source,python] +------------------------------------------ +if n < 0: print 'Hello World!' +------------------------------------------ +========================================== + + +[[X1,anchor reftext]] +== Links == +An [[X2]] inline anchor. +An [[X3, anchor reftext]] inline anchor with reftext. + +<>; captioned link to <>. + +<> link to inline anchor; captioned link to <>. + +Link to <> anchor. + +An example link to a bibliography entry <>. + +[horizontal] +[[[Test::Unit]]]:: http://ruby-doc.org/stdlib/libdoc/test/unit/rdoc/classes/Test/Unit.html + + +== Titles == + +[float] +===== Level 4 ===== +[float] +==== Level 3 ==== +[float] +=== Level 2 === +[float] +== Level 1 == +[float] +Level 4 ++++++++ +[float] +Level 3 +^^^^^^^ +[float] +Level 2 +~~~~~~~ +[float] +Level 1 +------- + +.Block title +Lorum ipsum. + + +== Lists == + +Bulleted: + +- item text +* item text +** item text +*** item text +**** item text +***** item text + +Numbered: + +1. arabic (decimal) numbering +a. loweralpha numbering +A. upperalpha numbering +i) lowerroman numbering +I) upperroman numbering +. arabic (decimal) numbering +.. loweralpha numbering +... lowerroman numbering +.... upperalpha numbering +..... upperroman numbering + +Labeled: + +label:: item text +label;; item text +label::: item text +label:::: item text + +With item anchor: + +one:: Item one. +[[item_two]]two:: Item two. +three:: Item three. + + +== Inline passthroughs == + +- Test pass:[`ABC`]. +- Test `pass:[ABC]`. +- The `++i` and `++j` auto-increments. +- Paths `~/.vim` and `~/docs`. +- The `__init__` method. +- The `{id}` attribute. + +List start number test: + +// The ol start attribute is not valid XHTML 1.1 (but it works in all +// browsers). +ifndef::backend-xhtml11[] +[start=7] +. List item 7. +. List item 8. +endif::backend-xhtml11[] + +== Images + +=== Block images + +[[tiger_image]] +.Tyger tyger +image::../../images/tiger.png[Tyger tyger] + +:height: 250 +:width: 350 +.Tyger tyger two +image::../../images/tiger.png[caption="Figure 2: ", alt="Tiger", align="center"] +:height!: +:width!: + +// Images and icons directories. +:imagesdir: ../../doc +image::music2.png[] + +:icons: +:iconsdir: ../../images/icons +NOTE: Lorum ipsum. + +:icons!: + +ifdef::backend-xhtml11[] +:imagesdir: ../../images +:data-uri: +image:smallnew.png[NEW] 'testing' `123`. + +endif::[] + +:data-uri!: + +=== Inline images + +:imagesdir: ../../images + +Inline image image:smallnew.png[] + +Inline image image:smallnew.png[NEW!] + +Inline image image:smallnew.png["NEW!",title="Small new"] + + +== Admonishments + +NOTE: Lorum ipsum. + +TIP: Lorum ipsum. + +WARNING: Lorum ipsum. + +CAUTION: Lorum ipsum. + +IMPORTANT: Lorum ipsum. + +// With icon images. +:icons: +:iconsdir: ../../images/icons + +NOTE: Lorum ipsum. + +TIP: Lorum ipsum. + +WARNING: Lorum ipsum. + +CAUTION: Lorum ipsum. + +IMPORTANT: Lorum ipsum. + +:icons!: + +== Backslash escapes + +.Apostrophe +Don't vs don\'t. + +.Exceptions +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%",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\... +|======================================== + + +== Paragraphs + +.Normal paragraph +This is a *bold* a line +This is a 'strong' line +This is another _strong_ line + +.Literal paragraph +[literal] +This is a *bold* a line +This is a 'strong' line +This is another _strong_ line + +.Verse paragraph +[verse] +This is a *bold* a line +This is a 'strong' line +This is another _strong_ line + +.Indented (literal) paragraph + This is a *bold* a line + This is a 'strong' line + This is another _strong_ line + +.Indented with quotes substitution +[subs="quotes"] + This is a *bold* a line + This is a 'strong' line + This is another _strong_ line + +.Literal paragraph with quotes substitution +["literal",subs="quotes"] +This is a *bold* a line +This is a 'strong' line +This is another _strong_ line + +ifndef::basebackend-docbook[] +.Monospaced paragraph with line breaks ++This is a *bold* line+ + ++This is a 'strong' line+ + ++This is another _strong_ line+ + + +.Another monospaced paragraph with line breaks ++This is a *bold* a line + +This is a 'strong' line + +This is another _strong_ line+ + +endif::basebackend-docbook[] + +.Literal block with quotes substitution +[subs="quotes"] +............................. +This is a *bold* a line +This is a 'strong' line +This is another _strong_ line +............................. + +[verse, William Blake, from Auguries of Innocence] +To see a world in a grain of sand, +And a heaven in a wild flower, +Hold infinity in the palm of your hand, +And eternity in an hour. + +[quote, Bertrand Russell, The World of Mathematics (1956)] +A good notation has subtlety and suggestiveness which at times makes +it almost seem like a live teacher. + + +URLs +---- +Mail Addresses +~~~~~~~~~~~~~~ +joe_bloggs@mail_server.com_ + +joe-bloggs@mail-server.com. + +joe-bloggs@mail-server.com,joe-bloggs@mail-server.com, + +mailto:joe-bloggs@mail-server.com[Mail] + +mailto:joe_bloggs@mail_server.com[Mail] + +mailto:joe.bloggs@mail.server.com[Mail] + +joe.bloggs@mail.server.com + +lorum ipsum. + + +Comments +-------- +///////////////////////////////////////////////////////////////////// +A comment +block. +///////////////////////////////////////////////////////////////////// + +// This is a comment line. + +Qui in magna commodo, est labitur dolorum an. Est ne magna primis. +// Inline comment line. +adolescens. Sit munere ponderum dignissim et. Minim luptatum et. + +:showcomments: +// This comment line will be displayed in the output. + +Qui in magna commodo, est labitur dolorum an. Est ne magna primis. +// Visible inline comment line. +adolescens. Sit munere ponderum dignissim et. Minim luptatum et. + +///////////////////////////////////////////////////////////////////// +Comment blocks are never displayed in the output. +///////////////////////////////////////////////////////////////////// + +:showcomments!: + +[[comment_macro]] +.Block title +// Block macro comment does not consume titles or attributes. +Lorum ipsum. + +[[comment_block]] +.Block title +///////////////////////////////////////////////////////////////////// +Delimited comment block does not consume titles or attributes. +///////////////////////////////////////////////////////////////////// +Lorum ipsum. + + +ifdef::basebackend-docbook[] +[glossary] +List of terms +------------- +Using positional attribute to specify section template. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + +[template="glossary"] +List of terms +------------- +Using named 'template' attribute to specify section template. + +[glossary] +A glossary term:: + The corresponding (indented) definition. + +A second glossary term:: + The corresponding (indented) definition. + +endif::basebackend-docbook[] + +Index Terms +----------- +Multi-passthough substitution (see +http://groups.google.com/group/asciidoc/browse_frm/thread/1269dc2feb1a482c) +((`foo`)) +(((foo,`bar`))) +(((foo,`bar`,`two`))) + +Table with fractional column width units +---------------------------------------- +NOTE: 'pagewidth' and 'pageunits' only apply to DocBook outputs. + +:miscellaneous.pagewidth: 17.5 +:miscellaneous.pageunits: cm + +.Horizontal and vertical source data +[width="50%",cols="3,^2,^2,10",options="header"] +|========================================================= +|Date |Duration |Avg HR |Notes + +|22-Aug-08 |10:24 | 157 | +Worked out MSHR (max sustainable heart rate) by going hard +for this interval. + +|22-Aug-08 |23:03 | 152 | +Back-to-back with previous interval. + +|24-Aug-08 |40:00 | 145 | +Moderately hard interspersed with 3x 3min intervals (2min +hard + 1min really hard taking the HR up to 160). + +|========================================================= + +== Table with parent configuration file and header attribute entry + +[cols="asciidoc"] +|==== +| +- Attribute entry from header: {test-attribute} +- Replacement from `testcases.conf` configuration file: test-replacement +|==== + +== Table column specifiers with merged cells +See +http://groups.google.com/group/asciidoc/browse_thread/thread/c9238380a1f2507a + +[cols="<1m,>1,^1s, ^1e"] +|============================================ + .2+| .2+|1- A 2+|2- B + |i- a |ii- b + |Values 1 |v1 |v2 |v3 + |Values 2 |v4 |v5 |v6 +|============================================ + +Floating tables and images +-------------------------- +.Simple table +[float="left",width="15%"] +|======= +|1 |2 |A +|3 |4 |B +|5 |6 |C +|======= + +.Tiger +[float="right"] +image::images/tiger.png["Tiger image"] + +unfloat::[] + +Section level offsets +--------------------- +At level 1 + +:leveloffset: -1 +Section title +^^^^^^^^^^^^^ +At level 2 + +:leveloffset: 0 +Section title +~~~~~~~~~~~~~ +At level 2 + +:leveloffset: 2 +Section title +------------- +At level 3 + +:leveloffset!: +:numbered!: + +Section level offsets +--------------------- +At level 1 + +Single-quoted attributes +------------------------ +[quote,'http://en.wikipedia.org/wiki/Samuel_Johnson[Samuel Johnson]'] +_____________________________________________________________________ +Sir, a woman's preaching is like a dog's walking on his hind legs. It +is not done well; but you are surprised to find it done at all. +_____________________________________________________________________ + +["quote","'http://en.wikipedia.org/wiki/Samuel_Johnson[Samuel Johnson]'"] +_____________________________________________________________________ +Sir, a woman's preaching is like a dog's walking on his hind legs. It +is not done well; but you are surprised to find it done at all. +_____________________________________________________________________ + +Footnotes +--------- +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. Sit munere ponderum dignissim et. Minim luptatum et vel. +footnote:[footnote one. +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. Sit munere ponderum dignissim et. Minim luptatum et vel. +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. Sit munere ponderum dignissim et. Minim luptatum et vel.] +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. Sit munere ponderum dignissim et. Minim luptatum et vel. +footnoteref:["F2","footnote two. +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. Sit munere ponderum dignissim et. Minim luptatum et vel."] +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. Sit munere ponderum dignissim et. Minim luptatum et vel +footnoteref:[F2]. +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. Sit munere ponderum dignissim et. Minim luptatum et vel. +footnote:[http://www.methods.co.nz/asciidoc/ Qui in magna commodo, +est labitur dolorum an. Est ne magna primis adolescens. Sit munere +ponderum dignissim et. Minim luptatum et vel +image:images/smallnew.png[]] +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. Sit munere ponderum dignissim et. Minim luptatum et vel. +footnote:[http://www.methods.co.nz/asciidoc/] +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. Sit munere ponderum dignissim et. Minim luptatum et +vel footnote:[http://www.methods.co.nz/asciidoc/[AsciiDoc website].]. +Qui in magna commodo, est labitur dolorum an. Est ne magna primis +adolescens. Sit munere ponderum dignissim et. Minim luptatum et +footnoteref:[F3,A footnote, "with an image" +image:images/smallnew.png[]]. +footnote:[With [square brackets\]] Qui in magna commodo, est labitur +dolorum an. Est ne magna primis. + + +Rulers and page breaks +---------------------- + +Lorum ipsum... + +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +Lorum ipsum... + +<<< + +Lorum ipsum... + + +这是一个测试 +------------ +Double-with character titles. +<<_这是一个测试,link to auto-generated section ID>>. + + +ifdef::backend-html5[] +HTML 5 audio and video block macros +----------------------------------- +audio::images/example.ogg[] + +.Audio tag test +audio::images/example.ogg[] + +video::images/gizmo.ogv[width=200,options="nocontrols,autoplay"] + +.Example video +video::images/gizmo.ogv[] + +video::http://www.808.dk/pics/video/gizmo.ogv[] + +++++ + + + +++++ + +endif::backend-html5[] + + +== Block macros + +:rs458: 2 + +ifeval::[{rs458}==2] +RS458 is 2. +endif::[] +ifeval::[not ({rs458}==2)] +This will not be processed. +endif::[] + +// Test eval block macro. +eval::[Section.setlevel(1)] + +// Test template concatenation. +{template:test-template} + +// Test ascii-ids attribute. +:ascii-ids: +== àn îd without accénts +Lorum ipsum... + +:ascii-ids!: +== àn îd with accénts +Lorum ipsum... + + +== Inline macros +http://groups.google.com/group/asciidoc/[A URL with [square +brackets\]]. diff --git a/source-builder/sb/asciidoc/tests/data/utf8-bom-test.txt b/source-builder/sb/asciidoc/tests/data/utf8-bom-test.txt new file mode 100644 index 0000000..03aae22 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/utf8-bom-test.txt @@ -0,0 +1,9 @@ +UTF-8 BOM Test +============== + +Include file with UTF-8 BOM: + +:leveloffset: 1 +include::{docfile}[depth=1] + +Lorum ipsum... diff --git a/source-builder/sb/asciidoc/tests/data/utf8-examples.txt b/source-builder/sb/asciidoc/tests/data/utf8-examples.txt new file mode 100644 index 0000000..0358f24 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/data/utf8-examples.txt @@ -0,0 +1,217 @@ +UTF-8 encoded sample plain-text file +==================================== + +Markus Kuhn [ˈmaʳkʊs kuːn] — 2002-07-25 + + +The ASCII compatible UTF-8 encoding used in this plain-text file +is defined in Unicode, ISO 10646-1, and RFC 2279. + + +Using Unicode/UTF-8, you can write in emails and source code things such as + +== Mathematics and sciences + + ∮ E⋅da = Q, n → ∞, ∑ f(i) = ∏ g(i), ⎧⎡⎛┌─────┐⎞⎤⎫ + ⎪⎢⎜│a²+b³ ⎟⎥⎪ + ∀x∈ℝ: ⌈x⌉ = −⌊−x⌋, α ∧ ¬β = ¬(¬α ∨ β), ⎪⎢⎜│───── ⎟⎥⎪ + ⎪⎢⎜⎷ c₈ ⎟⎥⎪ + ℕ ⊆ ℕ₀ ⊂ ℤ ⊂ ℚ ⊂ ℝ ⊂ ℂ, ⎨⎢⎜ ⎟⎥⎬ + ⎪⎢⎜ ∞ ⎟⎥⎪ + ⊥ < a ≠ b ≡ c ≤ d ≪ ⊤ ⇒ (⟦A⟧ ⇔ ⟪B⟫), ⎪⎢⎜ ⎲ ⎟⎥⎪ + ⎪⎢⎜ ⎳aⁱ-bⁱ⎟⎥⎪ + 2H₂ + O₂ ⇌ 2H₂O, R = 4.7 kΩ, ⌀ 200 mm ⎩⎣⎝i=1 ⎠⎦⎭ + + +== Linguistics and dictionaries + +ði ıntəˈnæʃənəl fəˈnɛtık əsoʊsiˈeıʃn + +Y [ˈʏpsilɔn], Yen [jɛn], Yoga [ˈjoːgɑ] + + +== APL + + ((V⍳V)=⍳⍴V)/V←,V ⌷←⍳→⍴∆∇⊃‾⍎⍕⌈ + + +== Nicer typography in plain text files + +- ‘single’ and “double” quotes +- Curly apostrophes: “We’ve been here” +- ‚deutsche‘ „Anführungszeichen“ +- †, ‡, ‰, •, 3–4, —, −5/+5, ™, … +- ASCII safety test: 1lI|, 0OD, 8B +- the euro symbol: 14.95 € + + +== Combining characters + +STARGΛ̊TE SG-1, a = v̇ = r̈, a⃑ ⊥ b⃑ + +== Greek (in Polytonic) + +[verse, The Greek anthem] +________________________________ +Σὲ γνωρίζω ἀπὸ τὴν κόψη +τοῦ σπαθιοῦ τὴν τρομερή, +σὲ γνωρίζω ἀπὸ τὴν ὄψη +ποὺ μὲ βία μετράει τὴ γῆ. + +᾿Απ᾿ τὰ κόκκαλα βγαλμένη +τῶν ῾Ελλήνων τὰ ἱερά +καὶ σὰν πρῶτα ἀνδρειωμένη +χαῖρε, ὦ χαῖρε, ᾿Ελευθεριά! +________________________________ + +[verse,From a speech of Demosthenes in the 4th century BC] +______________________________________________________________ +Οὐχὶ ταὐτὰ παρίσταταί μοι γιγνώσκειν, ὦ ἄνδρες ᾿Αθηναῖοι, +ὅταν τ᾿ εἰς τὰ πράγματα ἀποβλέψω καὶ ὅταν πρὸς τοὺς +λόγους οὓς ἀκούω· τοὺς μὲν γὰρ λόγους περὶ τοῦ +τιμωρήσασθαι Φίλιππον ὁρῶ γιγνομένους, τὰ δὲ πράγματ᾿ +εἰς τοῦτο προήκοντα, ὥσθ᾿ ὅπως μὴ πεισόμεθ᾿ αὐτοὶ +πρότερον κακῶς σκέψασθαι δέον. οὐδέν οὖν ἄλλο μοι δοκοῦσιν +οἱ τὰ τοιαῦτα λέγοντες ἢ τὴν ὑπόθεσιν, περὶ ἧς βουλεύεσθαι, +οὐχὶ τὴν οὖσαν παριστάντες ὑμῖν ἁμαρτάνειν. ἐγὼ δέ, ὅτι μέν +ποτ᾿ ἐξῆν τῇ πόλει καὶ τὰ αὑτῆς ἔχειν ἀσφαλῶς καὶ Φίλιππον +τιμωρήσασθαι, καὶ μάλ᾿ ἀκριβῶς οἶδα· ἐπ᾿ ἐμοῦ γάρ, οὐ πάλαι +γέγονεν ταῦτ᾿ ἀμφότερα· νῦν μέντοι πέπεισμαι τοῦθ᾿ ἱκανὸν +προλαβεῖν ἡμῖν εἶναι τὴν πρώτην, ὅπως τοὺς συμμάχους +σώσομεν. ἐὰν γὰρ τοῦτο βεβαίως ὑπάρξῃ, τότε καὶ περὶ τοῦ +τίνα τιμωρήσεταί τις καὶ ὃν τρόπον ἐξέσται σκοπεῖν· πρὶν δὲ +τὴν ἀρχὴν ὀρθῶς ὑποθέσθαι, μάταιον ἡγοῦμαι περὶ τῆς +τελευτῆς ὁντινοῦν ποιεῖσθαι λόγον. + +Δημοσθένους, Γ´ ᾿Ολυνθιακὸς +______________________________________________________________ + + +== Georgian: + +.From a Unicode conference invitation +გთხოვთ ახლავე გაიაროთ რეგისტრაცია Unicode-ის მეათე საერთაშორისო +კონფერენციაზე დასასწრებად, რომელიც გაიმართება 10-12 მარტს, +ქ. მაინცში, გერმანიაში. კონფერენცია შეჰკრებს ერთად მსოფლიოს +ექსპერტებს ისეთ დარგებში როგორიცაა ინტერნეტი და Unicode-ი, +ინტერნაციონალიზაცია და ლოკალიზაცია, Unicode-ის გამოყენება +ოპერაციულ სისტემებსა, და გამოყენებით პროგრამებში, შრიფტებში, +ტექსტების დამუშავებასა და მრავალენოვან კომპიუტერულ სისტემებში. + + +== Russian + +.From a Unicode conference invitation +Зарегистрируйтесь сейчас на Десятую Международную Конференцию по +Unicode, которая состоится 10-12 марта 1997 года в Майнце в Германии. +Конференция соберет широкий круг экспертов по вопросам глобального +Интернета и Unicode, локализации и интернационализации, воплощению и +применению Unicode в различных операционных системах и программных +приложениях, шрифтах, верстке и многоязычных компьютерных системах. + + +== Thai (UCS Level 2) + +Excerpt from a poetry on The Romance of The Three Kingdoms (a Chinese +classic 'San Gua'): + + [----------------------------|------------------------] + ๏ แผ่นดินฮั่นเสื่อมโทรมแสนสังเวช พระปกเกศกองบู๊กู้ขึ้นใหม่ + สิบสองกษัตริย์ก่อนหน้าแลถัดไป สององค์ไซร้โง่เขลาเบาปัญญา + ทรงนับถือขันทีเป็นที่พึ่ง บ้านเมืองจึงวิปริตเป็นนักหนา + โฮจิ๋นเรียกทัพทั่วหัวเมืองมา หมายจะฆ่ามดชั่วตัวสำคัญ + เหมือนขับไสไล่เสือจากเคหา รับหมาป่าเข้ามาเลยอาสัญ + ฝ่ายอ้องอุ้นยุแยกให้แตกกัน ใช้สาวนั้นเป็นชนวนชื่นชวนใจ + พลันลิฉุยกุยกีกลับก่อเหตุ ช่างอาเพศจริงหนาฟ้าร้องไห้ + ต้องรบราฆ่าฟันจนบรรลัย ฤๅหาใครค้ำชูกู้บรรลังก์ ฯ + +(The above is a two-column text. If combining characters are handled +correctly, the lines of the second column should be aligned with the +| character above.) + + +== Ethiopian + +.Proverbs in the Amharic language +[verse] +ሰማይ አይታረስ ንጉሥ አይከሰስ። +ብላ ካለኝ እንደአባቴ በቆመጠኝ። +ጌጥ ያለቤቱ ቁምጥና ነው። +ደሀ በሕልሙ ቅቤ ባይጠጣ ንጣት በገደለው። +የአፍ ወለምታ በቅቤ አይታሽም። +አይጥ በበላ ዳዋ ተመታ። +ሲተረጉሙ ይደረግሙ። +ቀስ በቀስ፥ ዕንቁላል በእግሩ ይሄዳል። +ድር ቢያብር አንበሳ ያስር። +ሰው እንደቤቱ እንጅ እንደ ጉረቤቱ አይተዳደርም። +እግዜር የከፈተውን ጉሮሮ ሳይዘጋው አይድርም። +የጎረቤት ሌባ፥ ቢያዩት ይስቅ ባያዩት ያጠልቅ። +ሥራ ከመፍታት ልጄን ላፋታት። +ዓባይ ማደሪያ የለው፥ ግንድ ይዞ ይዞራል። +የእስላም አገሩ መካ የአሞራ አገሩ ዋርካ። +ተንጋሎ ቢተፉ ተመልሶ ባፉ። +ወዳጅህ ማር ቢሆን ጨርስህ አትላሰው። +እግርህን በፍራሽህ ልክ ዘርጋ። + + +== Runes + +ᚻᛖ ᚳᚹᚫᚦ ᚦᚫᛏ ᚻᛖ ᛒᚢᛞᛖ ᚩᚾ ᚦᚫᛗ ᛚᚪᚾᛞᛖ ᚾᚩᚱᚦᚹᛖᚪᚱᛞᚢᛗ ᚹᛁᚦ ᚦᚪ ᚹᛖᛥᚫ + +(Old English, which transcribed into Latin reads ``He cwaeth that he +bude thaem lande northweardum with tha Westsae.'' and means ``He said +that he lived in the northern land near the Western Sea.'') + + +== Braille + + ⡌⠁⠧⠑ ⠼⠁⠒ ⡍⠜⠇⠑⠹⠰⠎ ⡣⠕⠌ + + ⡍⠜⠇⠑⠹ ⠺⠁⠎ ⠙⠑⠁⠙⠒ ⠞⠕ ⠃⠑⠛⠔ ⠺⠊⠹⠲ ⡹⠻⠑ ⠊⠎ ⠝⠕ ⠙⠳⠃⠞ + ⠱⠁⠞⠑⠧⠻ ⠁⠃⠳⠞ ⠹⠁⠞⠲ ⡹⠑ ⠗⠑⠛⠊⠌⠻ ⠕⠋ ⠙⠊⠎ ⠃⠥⠗⠊⠁⠇ ⠺⠁⠎ + ⠎⠊⠛⠝⠫ ⠃⠹ ⠹⠑ ⠊⠇⠻⠛⠹⠍⠁⠝⠂ ⠹⠑ ⠊⠇⠻⠅⠂ ⠹⠑ ⠥⠝⠙⠻⠞⠁⠅⠻⠂ + ⠁⠝⠙ ⠹⠑ ⠡⠊⠑⠋ ⠍⠳⠗⠝⠻⠲ ⡎⠊⠗⠕⠕⠛⠑ ⠎⠊⠛⠝⠫ ⠊⠞⠲ ⡁⠝⠙ + ⡎⠊⠗⠕⠕⠛⠑⠰⠎ ⠝⠁⠍⠑ ⠺⠁⠎ ⠛⠕⠕⠙ ⠥⠏⠕⠝ ⠰⡡⠁⠝⠛⠑⠂ ⠋⠕⠗ ⠁⠝⠹⠹⠔⠛ ⠙⠑ + ⠡⠕⠎⠑ ⠞⠕ ⠏⠥⠞ ⠙⠊⠎ ⠙⠁⠝⠙ ⠞⠕⠲ + + ⡕⠇⠙ ⡍⠜⠇⠑⠹ ⠺⠁⠎ ⠁⠎ ⠙⠑⠁⠙ ⠁⠎ ⠁ ⠙⠕⠕⠗⠤⠝⠁⠊⠇⠲ + + ⡍⠔⠙⠖ ⡊ ⠙⠕⠝⠰⠞ ⠍⠑⠁⠝ ⠞⠕ ⠎⠁⠹ ⠹⠁⠞ ⡊ ⠅⠝⠪⠂ ⠕⠋ ⠍⠹ + ⠪⠝ ⠅⠝⠪⠇⠫⠛⠑⠂ ⠱⠁⠞ ⠹⠻⠑ ⠊⠎ ⠏⠜⠞⠊⠊⠥⠇⠜⠇⠹ ⠙⠑⠁⠙ ⠁⠃⠳⠞ + ⠁ ⠙⠕⠕⠗⠤⠝⠁⠊⠇⠲ ⡊ ⠍⠊⠣⠞ ⠙⠁⠧⠑ ⠃⠑⠲ ⠔⠊⠇⠔⠫⠂ ⠍⠹⠎⠑⠇⠋⠂ ⠞⠕ + ⠗⠑⠛⠜⠙ ⠁ ⠊⠕⠋⠋⠔⠤⠝⠁⠊⠇ ⠁⠎ ⠹⠑ ⠙⠑⠁⠙⠑⠌ ⠏⠊⠑⠊⠑ ⠕⠋ ⠊⠗⠕⠝⠍⠕⠝⠛⠻⠹ + ⠔ ⠹⠑ ⠞⠗⠁⠙⠑⠲ ⡃⠥⠞ ⠹⠑ ⠺⠊⠎⠙⠕⠍ ⠕⠋ ⠳⠗ ⠁⠝⠊⠑⠌⠕⠗⠎ + ⠊⠎ ⠔ ⠹⠑ ⠎⠊⠍⠊⠇⠑⠆ ⠁⠝⠙ ⠍⠹ ⠥⠝⠙⠁⠇⠇⠪⠫ ⠙⠁⠝⠙⠎ + ⠩⠁⠇⠇ ⠝⠕⠞ ⠙⠊⠌⠥⠗⠃ ⠊⠞⠂ ⠕⠗ ⠹⠑ ⡊⠳⠝⠞⠗⠹⠰⠎ ⠙⠕⠝⠑ ⠋⠕⠗⠲ ⡹⠳ + ⠺⠊⠇⠇ ⠹⠻⠑⠋⠕⠗⠑ ⠏⠻⠍⠊⠞ ⠍⠑ ⠞⠕ ⠗⠑⠏⠑⠁⠞⠂ ⠑⠍⠏⠙⠁⠞⠊⠊⠁⠇⠇⠹⠂ ⠹⠁⠞ + ⡍⠜⠇⠑⠹ ⠺⠁⠎ ⠁⠎ ⠙⠑⠁⠙ ⠁⠎ ⠁ ⠙⠕⠕⠗⠤⠝⠁⠊⠇⠲ + +(The first couple of paragraphs of "A Christmas Carol" by Dickens) + + +== Compact font selection example text + + ABCDEFGHIJKLMNOPQRSTUVWXYZ /0123456789 + abcdefghijklmnopqrstuvwxyz £©µÀÆÖÞßéöÿ + –—‘“”„†•…‰™œŠŸž€ ΑΒΓΔΩαβγδω АБВГДабвгд + ∀∂∈ℝ∧∪≡∞ ↑↗↨↻⇣ ┐┼╔╘░►☺♀ fi�⑀₂ἠḂӥẄɐː⍎אԱა + + +== Greetings in various languages + +Hello world, Καλημέρα κόσμε, コンニチハ + + +== Box drawing alignment tests + +--------------------------------------------------------------------- + █ + ▉ + ╔══╦══╗ ┌──┬──┐ ╭──┬──╮ ╭──┬──╮ ┏━━┳━━┓ ┎┒┏┑ ╷ ╻ ┏┯┓ ┌┰┐ ▊ ╱╲╱╲╳╳╳ + ║┌─╨─┐║ │╔═╧═╗│ │╒═╪═╕│ │╓─╁─╖│ ┃┌─╂─┐┃ ┗╃╄┙ ╶┼╴╺╋╸┠┼┨ ┝╋┥ ▋ ╲╱╲╱╳╳╳ + ║│╲ ╱│║ │║ ║│ ││ │ ││ │║ ┃ ║│ ┃│ ╿ │┃ ┍╅╆┓ ╵ ╹ ┗┷┛ └┸┘ ▌ ╱╲╱╲╳╳╳ + ╠╡ ╳ ╞╣ ├╢ ╟┤ ├┼─┼─┼┤ ├╫─╂─╫┤ ┣┿╾┼╼┿┫ ┕┛┖┚ ┌┄┄┐ ╎ ┏┅┅┓ ┋ ▍ ╲╱╲╱╳╳╳ + ║│╱ ╲│║ │║ ║│ ││ │ ││ │║ ┃ ║│ ┃│ ╽ │┃ ░░▒▒▓▓██ ┊ ┆ ╎ ╏ ┇ ┋ ▎ + ║└─╥─┘║ │╚═╤═╝│ │╘═╪═╛│ │╙─╀─╜│ ┃└─╂─┘┃ ░░▒▒▓▓██ ┊ ┆ ╎ ╏ ┇ ┋ ▏ + ╚══╩══╝ └──┴──┘ ╰──┴──╯ ╰──┴──╯ ┗━━┻━━┛ ▗▄▖▛▀▜ └╌╌┘ ╎ ┗╍╍┛ ┋ ▁▂▃▄▅▆▇█ + ▝▀▘▙▄▟ +--------------------------------------------------------------------- diff --git a/source-builder/sb/asciidoc/tests/testasciidoc.conf b/source-builder/sb/asciidoc/tests/testasciidoc.conf new file mode 100644 index 0000000..62dc7f4 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/testasciidoc.conf @@ -0,0 +1,652 @@ +% globals +{ + 'datadir': 'data', +} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Test cases + +% source +data/testcases.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Filters + +% source +data/filters-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Tables + +% source +../examples/website/newtables.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Old tables + +% source +data/oldtables.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Source highlighter + +% source +../doc/source-highlight-filter.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Example article + +% options +['--section-numbers', ('--attribute','css-signature=article-test')] + +% attributes +# So document date in footer doesn't generate an error. +{'docdate':None} + +% source +../doc/article.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Example article with embedded images (data URIs) + +% source +../doc/article.txt + +% name +article-data-uri + +% backends +['xhtml11','html5'] + +% options +['--section-numbers'] + +% attributes +{'docdate':None, 'data-uri':True, 'icons':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Example article with included docinfo file. + +% source +../doc/article.txt + +% name +article-docinfo + +% backends +['docbook'] + +% options +['--section-numbers'] + +% attributes +{'docdate':None, 'docinfo':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Example book + +% options +['--section-numbers'] + +% source +../doc/book.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Example multi-part book + +% options +['--section-numbers'] + +% source +../doc/book-multi.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Man page + +% attributes +# So document date in footer doesn't generate an error. +{'docdate':None} + +% source +../doc/asciidoc.1.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Example slideshow + +% backends +['slidy'] + +% source +../doc/slidy-example.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +ASCIIMathML + +% attributes +{'asciimath':'','deprecated-quotes':''} + +% backends +['xhtml11','html5'] + +% source +../doc/asciimathml.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +LaTeXMathML + +% attributes +{'latexmath':''} + +% backends +['xhtml11','html5'] + +% source +../doc/latexmathml.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +LaTeX Math + +% backends +['docbook'] + +% source +../doc/latexmath.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +LaTeX Filter + +% source +../doc/latex-filter.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +!User Guide + +% options +['--section-numbers'] + +% source +../doc/asciidoc.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +UTF-8 Examples + +% source +data/utf8-examples.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Additional Open Block and Paragraph styles + +% source +data/open-block-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +English language file (article) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-en-article-test + +% source +data/lang-en-test.txt + +% options +[('--doctype','article')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +English language file (book) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-en-book-test + +% source +data/lang-en-test.txt + +% options +[('--doctype','book')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +English language file (manpage) + +% backends +['docbook'] + +% source +data/lang-en-man-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Russian language file (article) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-ru-article-test + +% source +data/lang-ru-test.txt + +% options +[('--doctype','article')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Russian language file (book) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-ru-book-test + +% source +data/lang-ru-test.txt + +% options +[('--doctype','book')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Russian language file (manpage) + +% backends +['docbook'] + +% source +data/lang-ru-man-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +French language file (article) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-fr-article-test + +% source +data/lang-fr-test.txt + +% options +[('--doctype','article')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +French language file (book) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-fr-book-test + +% source +data/lang-fr-test.txt + +% options +[('--doctype','book')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +French language file (manpage) + +% backends +['docbook'] + +% source +data/lang-fr-man-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +German language file (article) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-de-article-test + +% source +data/lang-de-test.txt + +% options +[('--doctype','article')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +German language file (book) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-de-book-test + +% source +data/lang-de-test.txt + +% options +[('--doctype','book')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +German language file (manpage) + +% backends +['docbook'] + +% source +data/lang-de-man-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Hungarian language file (article) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-hu-article-test + +% source +data/lang-hu-test.txt + +% options +[('--doctype','article')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Hungarian language file (book) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-hu-book-test + +% source +data/lang-hu-test.txt + +% options +[('--doctype','book')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Hungarian language file (manpage) + +% backends +['docbook'] + +% source +data/lang-hu-man-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Spanish language file (article) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-es-article-test + +% source +data/lang-es-test.txt + +% options +[('--doctype','article')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Spanish language file (book) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-es-book-test + +% source +data/lang-es-test.txt + +% options +[('--doctype','book')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Spanish language file (manpage) + +% backends +['docbook'] + +% source +data/lang-es-man-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Brazilian Portuguese language file (article) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-pt-BR-article-test + +% source +data/lang-pt-BR-test.txt + +% options +[('--doctype','article')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Brazilian Portuguese language file (book) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-pt-BR-book-test + +% source +data/lang-pt-BR-test.txt + +% options +[('--doctype','book')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Brazilian Portuguese language file (manpage) + +% backends +['docbook'] + +% source +data/lang-pt-BR-man-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Ukrainian language file (article) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-uk-article-test + +% source +data/lang-uk-test.txt + +% options +[('--doctype','article')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Ukrainian language file (book) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-uk-book-test + +% source +data/lang-uk-test.txt + +% options +[('--doctype','book')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Ukrainian language file (manpage) + +% backends +['docbook'] + +% source +data/lang-uk-man-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Dutch language file (article) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-nl-article-test + +% source +data/lang-nl-test.txt + +% options +[('--doctype','article')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Dutch language file (book) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-nl-book-test + +% source +data/lang-nl-test.txt + +% options +[('--doctype','book')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Dutch language file (manpage) + +% backends +['docbook'] + +% source +data/lang-nl-man-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Italian language file (article) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-it-article-test + +% source +data/lang-it-test.txt + +% options +[('--doctype','article')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Italian language file (book) + +% backends +['docbook','xhtml11','html4','html5'] + +% name +lang-it-book-test + +% source +data/lang-it-test.txt + +% options +[('--doctype','book')] + +% attributes +{'toc':True} + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Italian language file (manpage) + +% backends +['docbook'] + +% source +data/lang-it-man-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +RCS $Id$ marker test + +% source +data/rcs-id-marker-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +UTF-8 BOM test + +% source +data/utf8-bom-test.txt + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +Deprecated quote attributes + +% attributes +{'deprecated-quotes':''} + +% source +data/deprecated-quotes.txt + diff --git a/source-builder/sb/asciidoc/tests/testasciidoc.py b/source-builder/sb/asciidoc/tests/testasciidoc.py new file mode 100755 index 0000000..679ad35 --- /dev/null +++ b/source-builder/sb/asciidoc/tests/testasciidoc.py @@ -0,0 +1,420 @@ +#!/usr/bin/env python + +USAGE = '''Usage: testasciidoc.py [OPTIONS] COMMAND + +Run AsciiDoc conformance tests specified in configuration FILE. + +Commands: + list List tests + run [NUMBER] [BACKEND] Execute tests + update [NUMBER] [BACKEND] Regenerate and update test data + +Options: + -f, --conf-file=CONF_FILE + Use configuration file CONF_FILE (default configuration file is + testasciidoc.conf in testasciidoc.py directory) + --force + Update all test data overwriting existing data''' + + +__version__ = '0.1.1' +__copyright__ = 'Copyright (C) 2009 Stuart Rackham' + + +import os, sys, re, difflib + +if sys.platform[:4] == 'java': + # Jython cStringIO is more compatible with CPython StringIO. + import cStringIO as StringIO +else: + import StringIO + +import asciidocapi + + +BACKENDS = ('html4','xhtml11','docbook','wordpress','html5') # Default backends. +BACKEND_EXT = {'html4':'.html', 'xhtml11':'.html', 'docbook':'.xml', + 'wordpress':'.html','slidy':'.html','html5':'.html'} + + +def iif(condition, iftrue, iffalse=None): + """ + Immediate if c.f. ternary ?: operator. + False value defaults to '' if the true value is a string. + False value defaults to 0 if the true value is a number. + """ + if iffalse is None: + if isinstance(iftrue, basestring): + iffalse = '' + if type(iftrue) in (int, float): + iffalse = 0 + if condition: + return iftrue + else: + return iffalse + +def message(msg=''): + print >>sys.stderr, msg + +def strip_end(lines): + """ + Strip blank strings from the end of list of strings. + """ + for i in range(len(lines)-1,-1,-1): + if not lines[i]: + del lines[i] + else: + break + +def normalize_data(lines): + """ + Strip comments and trailing blank strings from lines. + """ + result = [ s for s in lines if not s.startswith('#') ] + strip_end(result) + return result + + +class AsciiDocTest(object): + + def __init__(self): + self.number = None # Test number (1..). + self.name = '' # Optional test name. + self.title = '' # Optional test name. + self.description = [] # List of lines followoing title. + self.source = None # AsciiDoc test source file name. + self.options = [] + self.attributes = {} + self.backends = BACKENDS + self.datadir = None # Where output files are stored. + self.disabled = False + + def backend_filename(self, backend): + """ + Return the path name of the backend output file that is generated from + the test name and output file type. + """ + return '%s-%s%s' % ( + os.path.normpath(os.path.join(self.datadir, self.name)), + backend, + BACKEND_EXT[backend]) + + def parse(self, lines, confdir, datadir): + """ + Parse conf file test section from list of text lines. + """ + self.__init__() + self.confdir = confdir + self.datadir = datadir + lines = Lines(lines) + while not lines.eol(): + l = lines.read_until(r'^%') + if l: + if not l[0].startswith('%'): + if l[0][0] == '!': + self.disabled = True + self.title = l[0][1:] + else: + self.title = l[0] + self.description = l[1:] + continue + reo = re.match(r'^%\s*(?P[\w_-]+)', l[0]) + if not reo: + raise (ValueError, 'illegal directive: %s' % l[0]) + directive = reo.groupdict()['directive'] + data = normalize_data(l[1:]) + if directive == 'source': + if data: + self.source = os.path.normpath(os.path.join( + self.confdir, os.path.normpath(data[0]))) + elif directive == 'options': + self.options = eval(' '.join(data)) + for i,v in enumerate(self.options): + if isinstance(v, basestring): + self.options[i] = (v,None) + elif directive == 'attributes': + self.attributes = eval(' '.join(data)) + elif directive == 'backends': + self.backends = eval(' '.join(data)) + elif directive == 'name': + self.name = data[0].strip() + else: + raise (ValueError, 'illegal directive: %s' % l[0]) + if not self.title: + self.title = self.source + if not self.name: + self.name = os.path.basename(os.path.splitext(self.source)[0]) + + def is_missing(self, backend): + """ + Returns True if there is no output test data file for backend. + """ + return not os.path.isfile(self.backend_filename(backend)) + + def is_missing_or_outdated(self, backend): + """ + Returns True if the output test data file is missing or out of date. + """ + return self.is_missing(backend) or ( + os.path.getmtime(self.source) + > os.path.getmtime(self.backend_filename(backend))) + + def get_expected(self, backend): + """ + Return expected test data output for backend. + """ + f = open(self.backend_filename(backend)) + try: + result = f.readlines() + # Strip line terminators. + result = [ s.rstrip() for s in result ] + finally: + f.close() + return result + + def generate_expected(self, backend): + """ + Generate and return test data output for backend. + """ + asciidoc = asciidocapi.AsciiDocAPI() + asciidoc.options.values = self.options + asciidoc.attributes = self.attributes + infile = self.source + outfile = StringIO.StringIO() + asciidoc.execute(infile, outfile, backend) + return outfile.getvalue().splitlines() + + def update_expected(self, backend): + """ + Generate and write backend data. + """ + lines = self.generate_expected(backend) + if not os.path.isdir(self.datadir): + print('CREATING: %s' % self.datadir) + os.mkdir(self.datadir) + f = open(self.backend_filename(backend),'w+') + try: + print('WRITING: %s' % f.name) + f.writelines([ s + os.linesep for s in lines]) + finally: + f.close() + + def update(self, backend=None, force=False): + """ + Regenerate and update expected test data outputs. + """ + if backend is None: + backends = self.backends + else: + backends = [backend] + for backend in backends: + if force or self.is_missing_or_outdated(backend): + self.update_expected(backend) + + def run(self, backend=None): + """ + Execute test. + Return True if test passes. + """ + if backend is None: + backends = self.backends + else: + backends = [backend] + result = True # Assume success. + self.passed = self.failed = self.skipped = 0 + print('%d: %s' % (self.number, self.title)) + if self.source and os.path.isfile(self.source): + print('SOURCE: asciidoc: %s' % self.source) + for backend in backends: + fromfile = self.backend_filename(backend) + if not self.is_missing(backend): + expected = self.get_expected(backend) + strip_end(expected) + got = self.generate_expected(backend) + strip_end(got) + lines = [] + for line in difflib.unified_diff(got, expected, n=0): + lines.append(line) + if lines: + result = False + self.failed +=1 + lines = lines[3:] + print('FAILED: %s: %s' % (backend, fromfile)) + message('+++ %s' % fromfile) + message('--- got') + for line in lines: + message(line) + message() + else: + self.passed += 1 + print('PASSED: %s: %s' % (backend, fromfile)) + else: + self.skipped += 1 + print('SKIPPED: %s: %s' % (backend, fromfile)) + else: + self.skipped += len(backends) + if self.source: + msg = 'MISSING: %s' % self.source + else: + msg = 'NO ASCIIDOC SOURCE FILE SPECIFIED' + print(msg) + print('') + return result + + +class AsciiDocTests(object): + + def __init__(self, conffile): + """ + Parse configuration file. + """ + self.conffile = os.path.normpath(conffile) + # All file names are relative to configuration file directory. + self.confdir = os.path.dirname(self.conffile) + self.datadir = self.confdir # Default expected files directory. + self.tests = [] # List of parsed AsciiDocTest objects. + self.globals = {} + f = open(self.conffile) + try: + lines = Lines(f.readlines()) + finally: + f.close() + first = True + while not lines.eol(): + s = lines.read_until(r'^%+$') + s = [ l for l in s if l] # Drop blank lines. + # Must be at least one non-blank line in addition to delimiter. + if len(s) > 1: + # Optional globals precede all tests. + if first and re.match(r'^%\s*globals$',s[0]): + self.globals = eval(' '.join(normalize_data(s[1:]))) + if 'datadir' in self.globals: + self.datadir = os.path.join( + self.confdir, + os.path.normpath(self.globals['datadir'])) + else: + test = AsciiDocTest() + test.parse(s[1:], self.confdir, self.datadir) + self.tests.append(test) + test.number = len(self.tests) + first = False + + def run(self, number=None, backend=None): + """ + Run all tests. + If number is specified run test number (1..). + """ + self.passed = self.failed = self.skipped = 0 + for test in self.tests: + if (not test.disabled or number) and (not number or number == test.number) and (not backend or backend in test.backends): + test.run(backend) + self.passed += test.passed + self.failed += test.failed + self.skipped += test.skipped + if self.passed > 0: + print('TOTAL PASSED: %s' % self.passed) + if self.failed > 0: + print('TOTAL FAILED: %s' % self.failed) + if self.skipped > 0: + print('TOTAL SKIPPED: %s' % self.skipped) + + def update(self, number=None, backend=None, force=False): + """ + Regenerate expected test data and update configuratio file. + """ + for test in self.tests: + if (not test.disabled or number) and (not number or number == test.number): + test.update(backend, force=force) + + def list(self): + """ + Lists tests to stdout. + """ + for test in self.tests: + print '%d: %s%s' % (test.number, iif(test.disabled,'!'), test.title) + + +class Lines(list): + """ + A list of strings. + Adds eol() and read_until() to list type. + """ + + def __init__(self, lines): + super(Lines, self).__init__() + self.extend([s.rstrip() for s in lines]) + self.pos = 0 + + def eol(self): + return self.pos >= len(self) + + def read_until(self, regexp): + """ + Return a list of lines from current position up until the next line + matching regexp. + Advance position to matching line. + """ + result = [] + if not self.eol(): + result.append(self[self.pos]) + self.pos += 1 + while not self.eol(): + if re.match(regexp, self[self.pos]): + break + result.append(self[self.pos]) + self.pos += 1 + return result + + +def usage(msg=None): + if msg: + message(msg + '\n') + message(USAGE) + + +if __name__ == '__main__': + # Process command line options. + import getopt + try: + opts,args = getopt.getopt(sys.argv[1:], 'f:', ['force']) + except getopt.GetoptError: + usage('illegal command options') + sys.exit(1) + if len(args) == 0: + usage() + sys.exit(1) + conffile = os.path.join(os.path.dirname(sys.argv[0]), 'testasciidoc.conf') + force = False + for o,v in opts: + if o == '--force': + force = True + if o in ('-f','--conf-file'): + conffile = v + if not os.path.isfile(conffile): + message('missing CONF_FILE: %s' % conffile) + sys.exit(1) + tests = AsciiDocTests(conffile) + cmd = args[0] + number = None + backend = None + for arg in args[1:3]: + try: + number = int(arg) + except ValueError: + backend = arg + if backend and backend not in BACKENDS: + message('illegal BACKEND: %s' % backend) + sys.exit(1) + if number is not None and number not in range(1, len(tests.tests)+1): + message('illegal test NUMBER: %d' % number) + sys.exit(1) + if cmd == 'run': + tests.run(number, backend) + if tests.failed: + exit(1) + elif cmd == 'update': + tests.update(number, backend, force=force) + elif cmd == 'list': + tests.list() + else: + usage('illegal COMMAND: %s' % cmd) diff --git a/source-builder/sb/asciidoc/text.conf b/source-builder/sb/asciidoc/text.conf new file mode 100644 index 0000000..7bc6658 --- /dev/null +++ b/source-builder/sb/asciidoc/text.conf @@ -0,0 +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/^/ /' diff --git a/source-builder/sb/asciidoc/themes/flask/flask.css b/source-builder/sb/asciidoc/themes/flask/flask.css new file mode 100644 index 0000000..03abe3b --- /dev/null +++ b/source-builder/sb/asciidoc/themes/flask/flask.css @@ -0,0 +1,597 @@ +/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ + +/* Default font. */ +body { + font-family: Georgia,serif; +} + +/* Title font. */ +h1, h2, h3, h4, h5, h6, +div.title, caption.title, +thead, p.table.header, +#toctitle, +#author, #revnumber, #revdate, #revremark, +#footer { + font-family: Arial,Helvetica,sans-serif; +} + +body { + margin: 1em 5% 1em 5%; +} + +a { + color: blue; + text-decoration: underline; +} +a:visited { + color: fuchsia; +} + +em { + font-style: italic; + color: navy; +} + +strong { + font-weight: bold; + color: #083194; +} + +h1, h2, h3, h4, h5, h6 { + color: #527bbd; + margin-top: 1.2em; + margin-bottom: 0.5em; + line-height: 1.3; +} + +h1, h2, h3 { + border-bottom: 2px solid silver; +} +h2 { + padding-top: 0.5em; +} +h3 { + float: left; +} +h3 + * { + clear: left; +} +h5 { + font-size: 1.0em; +} + +div.sectionbody { + margin-left: 0; +} + +hr { + border: 1px solid silver; +} + +p { + margin-top: 0.5em; + margin-bottom: 0.5em; +} + +ul, ol, li > p { + margin-top: 0; +} +ul > li { color: #aaa; } +ul > li > * { color: black; } + +pre { + padding: 0; + margin: 0; +} + +#author { + color: #527bbd; + font-weight: bold; + font-size: 1.1em; +} +#email { +} +#revnumber, #revdate, #revremark { +} + +#footer { + font-size: small; + border-top: 2px solid silver; + padding-top: 0.5em; + margin-top: 4.0em; +} +#footer-text { + float: left; + padding-bottom: 0.5em; +} +#footer-badges { + float: right; + padding-bottom: 0.5em; +} + +#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} +div.imageblock, div.exampleblock, div.verseblock, +div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, +div.admonitionblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +div.admonitionblock { + margin-top: 2.0em; + margin-bottom: 2.0em; + margin-right: 10%; + color: #606060; +} + +div.content { /* Block element content. */ + padding: 0; +} + +/* Block element titles. */ +div.title, caption.title { + color: #527bbd; + font-weight: bold; + text-align: left; + margin-top: 1.0em; + margin-bottom: 0.5em; +} +div.title + * { + margin-top: 0; +} + +td div.title:first-child { + margin-top: 0.0em; +} +div.content div.title:first-child { + margin-top: 0.0em; +} +div.content + div.title { + margin-top: 0.0em; +} + +div.sidebarblock > div.content { + background: #ffffee; + border: 1px solid #dddddd; + border-left: 4px solid #f0f0f0; + padding: 0.5em; +} + +div.listingblock > div.content { + border: 1px solid #dddddd; + border-left: 5px solid #f0f0f0; + background: #f8f8f8; + padding: 0.5em; +} + +div.quoteblock, div.verseblock { + padding-left: 1.0em; + margin-left: 1.0em; + margin-right: 10%; + border-left: 5px solid #f0f0f0; + color: #777777; +} + +div.quoteblock > div.attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock > pre.content { + font-family: inherit; + font-size: inherit; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ +div.verseblock + div.attribution { + text-align: left; +} + +div.admonitionblock .icon { + vertical-align: top; + font-size: 1.1em; + font-weight: bold; + text-decoration: underline; + color: #527bbd; + padding-right: 0.5em; +} +div.admonitionblock td.content { + padding-left: 0.5em; + border-left: 3px solid #dddddd; +} + +div.exampleblock > div.content { + border-left: 3px solid #dddddd; + padding-left: 0.5em; +} + +div.imageblock div.content { padding-left: 0; } +span.image img { border-style: none; } +a.image:visited { color: white; } + +dl { + margin-top: 0.8em; + margin-bottom: 0.8em; +} +dt { + margin-top: 0.5em; + margin-bottom: 0; + font-style: normal; + color: navy; +} +dd > *:first-child { + margin-top: 0.1em; +} + +ul, ol { + list-style-position: outside; +} +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { + list-style-type: lower-alpha; +} +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} + +tfoot { + font-weight: bold; +} +td > div.verse { + white-space: pre; +} + +div.hdlist { + margin-top: 0.8em; + margin-bottom: 0.8em; +} +div.hdlist tr { + padding-bottom: 15px; +} +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { + vertical-align: top; + font-style: normal; + padding-right: 0.8em; + color: navy; +} +td.hdlist2 { + vertical-align: top; +} +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} + +.footnote, .footnoteref { + font-size: 0.8em; +} + +span.footnote, span.footnoteref { + vertical-align: super; +} + +#footnotes { + margin: 20px 0 20px 0; + padding: 7px 0 0 0; +} + +#footnotes div.footnote { + margin: 0 0 5px 0; +} + +#footnotes hr { + border: none; + border-top: 1px solid silver; + height: 1px; + text-align: left; + margin-left: 0; + width: 20%; + min-width: 100px; +} + +div.colist td { + padding-right: 0.5em; + padding-bottom: 0.3em; + vertical-align: top; +} +div.colist td img { + margin-top: 0.3em; +} + +@media print { + #footer-badges { display: none; } +} + +#toc { + margin-bottom: 2.5em; +} + +#toctitle { + color: #527bbd; + font-size: 1.1em; + font-weight: bold; + margin-top: 1.0em; + margin-bottom: 0.1em; +} + +div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { + margin-top: 0; + margin-bottom: 0; +} +div.toclevel2 { + margin-left: 2em; + font-size: 0.9em; +} +div.toclevel3 { + margin-left: 4em; + font-size: 0.9em; +} +div.toclevel4 { + margin-left: 6em; + font-size: 0.9em; +} + +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; } + + +/* + * xhtml11 specific + * + * */ + +tt { + font-family: monospace; + font-size: inherit; + color: navy; +} + +div.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +div.tableblock > table { + border: 3px solid #527bbd; +} +thead, p.table.header { + font-weight: bold; + color: #527bbd; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} + + +/* + * html5 specific + * + * */ + +.monospaced { + font-family: monospace; + font-size: inherit; + color: navy; +} + +table.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +thead, p.tableblock.header { + font-weight: bold; + color: #527bbd; +} +p.tableblock { + margin-top: 0; +} +table.tableblock { + border-width: 3px; + border-spacing: 0px; + border-style: solid; + border-color: #527bbd; + border-collapse: collapse; +} +th.tableblock, td.tableblock { + border-width: 1px; + padding: 4px; + border-style: solid; + border-color: #527bbd; +} + +table.tableblock.frame-topbot { + border-left-style: hidden; + border-right-style: hidden; +} +table.tableblock.frame-sides { + border-top-style: hidden; + border-bottom-style: hidden; +} +table.tableblock.frame-none { + border-style: hidden; +} + +th.tableblock.halign-left, td.tableblock.halign-left { + text-align: left; +} +th.tableblock.halign-center, td.tableblock.halign-center { + text-align: center; +} +th.tableblock.halign-right, td.tableblock.halign-right { + text-align: right; +} + +th.tableblock.valign-top, td.tableblock.valign-top { + vertical-align: top; +} +th.tableblock.valign-middle, td.tableblock.valign-middle { + vertical-align: middle; +} +th.tableblock.valign-bottom, td.tableblock.valign-bottom { + vertical-align: bottom; +} + + +/* + * manpage specific + * + * */ + +body.manpage h1 { + padding-top: 0.5em; + padding-bottom: 0.5em; + border-top: 2px solid silver; + border-bottom: 2px solid silver; +} +body.manpage h2 { + border-style: none; +} +body.manpage div.sectionbody { + margin-left: 3em; +} + +@media print { + body.manpage div#toc { display: none; } +} + + +/* + * Theme specific overrides of the preceding (asciidoc.css) CSS. + * + */ +body { + font-family: Garamond, Georgia, serif; + font-size: 17px; + color: #3E4349; + line-height: 1.3em; +} +h1, h2, h3, h4, h5, h6, +div.title, caption.title, +thead, p.table.header, +#toctitle, +#author, #revnumber, #revdate, #revremark, +#footer { + font-family: Garmond, Georgia, serif; + font-weight: normal; + border-bottom-width: 0; + color: #3E4349; +} +div.title, caption.title { color: #596673; font-weight: bold; } +h1 { font-size: 240%; } +h2 { font-size: 180%; } +h3 { font-size: 150%; } +h4 { font-size: 130%; } +h5 { font-size: 115%; } +h6 { font-size: 100%; } +#header h1 { margin-top: 0; } +#toc { + color: #444444; + line-height: 1.5; + padding-top: 1.5em; +} +#toctitle { + font-size: 20px; +} +#toc a { + border-bottom: 1px dotted #999999; + color: #444444 !important; + text-decoration: none !important; +} +#toc a:hover { + border-bottom: 1px solid #6D4100; + color: #6D4100 !important; + text-decoration: none !important; +} +div.toclevel1 { margin-top: 0.2em; font-size: 16px; } +div.toclevel2 { margin-top: 0.15em; font-size: 14px; } +em, dt, td.hdlist1 { color: black; } +strong { color: #3E4349; } +a { color: #004B6B; text-decoration: none; border-bottom: 1px dotted #004B6B; } +a:visited { color: #615FA0; border-bottom: 1px dotted #615FA0; } +a:hover { color: #6D4100; border-bottom: 1px solid #6D4100; } +div.tableblock > table, table.tableblock { border: 3px solid #E8E8E8; } +th.tableblock, td.tableblock { border: 1px solid #E8E8E8; } +ul > li > * { color: #3E4349; } +pre, tt, .monospaced { font-family: Consolas,Menlo,'Deja Vu Sans Mono','Bitstream Vera Sans Mono',monospace; } +tt, .monospaced { font-size: 0.9em; color: black; +} +div.exampleblock > div.content, div.sidebarblock > div.content, div.listingblock > div.content { border-width: 0 0 0 3px; border-color: #E8E8E8; } +div.verseblock { border-left-width: 0; margin-left: 3em; } +div.quoteblock { border-left-width: 3px; margin-left: 0; margin-right: 0;} +div.admonitionblock td.content { border-left: 3px solid #E8E8E8; } diff --git a/source-builder/sb/asciidoc/themes/volnitsky/volnitsky.css b/source-builder/sb/asciidoc/themes/volnitsky/volnitsky.css new file mode 100644 index 0000000..42ae7d2 --- /dev/null +++ b/source-builder/sb/asciidoc/themes/volnitsky/volnitsky.css @@ -0,0 +1,435 @@ +/* + * AsciiDoc 'volnitsky' theme for xhtml11 and html5 backends. + * Based on css from http://volnitsky.com, which was in turn based on default + * theme from AsciiDoc + * + * FIXME: The styling is still a bit rough in places. + * + */ + +/* Default font. */ +body { + font-family: Georgia,"Times New Roman",Times,serif; +} + +/* Title font. */ +h1, h2, h3, h4, h5, h6, +div.title, caption.title, +thead, p.table.header, +#toctitle, +#author, #revnumber, #revdate, #revremark, +#footer { + font-family: Candara,Arial,sans-serif; +} + + +#toc a { + border-bottom: 1px dotted #999999; + color: #3A3A4D !important; + text-decoration: none !important; +} +#toc a:hover { + border-bottom: 1px solid #6D4100; + color: #6D4100 !important; + text-decoration: none !important; +} +a { color: #666688; text-decoration: none; border-bottom: 1px dotted #666688; } +a:visited { color: #615FA0; border-bottom: 1px dotted #615FA0; } +a:hover { color: #6D4100; border-bottom: 1px solid #6D4100; } + +em { + font-style: italic; + color: #444466; +} + +strong { + font-weight: bold; + color: #444466; +} + +h1, h2, h3, h4, h5, h6 { + color: #666688; + margin-bottom: 0.5em; + line-height: 1.3; + letter-spacing:+0.15em; +} + +h1, h2, h3 { border-bottom: 2px solid #ccd; } +h2 { padding-top: 0.5em; } +h3 { float: left; } +h3 + * { clear: left; } + +div.sectionbody { + margin-left: 0; +} + +hr { + border: 1px solid #444466; +} + +p { + margin-top: 0.5em; + margin-bottom: 0.5em; +} + +ul, ol, li > p { + margin-top: 0; +} + +pre { + padding: 0; + margin: 0; +} + +#author { + color: #444466; + font-weight: bold; + font-size: 1.1em; +} + +#footer { + font-size: small; + border-top: 2px solid silver; + padding-top: 0.5em; + margin-top: 4.0em; +} + +#footer-text { + float: left; + padding-bottom: 0.5em; +} + +#footer-badges { + float: right; + padding-bottom: 0.5em; +} + +#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} + +div.tableblock, div.imageblock, div.exampleblock, div.verseblock, +div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, +div.admonitionblock { + margin-top: 1.5em; + margin-bottom: 1.5em; +} + +div.admonitionblock { + margin-top: 2.5em; + margin-bottom: 2.5em; +} + +div.content { /* Block element content. */ + padding: 0; +} + +/* Block element titles. */ +div.title, caption.title { + color: #444466; + font-weight: bold; + text-align: left; + margin-top: 1.0em; + margin-bottom: 0.5em; +} +div.title + * { + margin-top: 0; +} + +td div.title:first-child { + margin-top: 0.0em; +} +div.content div.title:first-child { + margin-top: 0.0em; +} +div.content + div.title { + margin-top: 0.0em; +} + +div.sidebarblock > div.content { + background: #ffffee; + border: 1px solid silver; + padding: 0.5em; +} + +div.listingblock > div.content { + border: 1px solid silver; + background: #f4f4f4; + padding: 0.5em; +} + +div.quoteblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.quoteblock > div.attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > pre.content { + font-family: inherit; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ +div.verseblock + div.attribution { + text-align: left; +} + +div.admonitionblock .icon { + vertical-align: top; + font-size: 1.1em; + font-weight: bold; + text-decoration: underline; + color: #444466; + padding-right: 0.5em; +} +div.admonitionblock td.content { + padding-left: 0.5em; + border-left: 2px solid silver; +} + +div.exampleblock > div.content { + border-left: 2px solid silver; + padding: 0.5em; +} + +div.imageblock div.content { padding-left: 0; } +span.image img { border-style: none; } +a.image:visited { color: white; } + +dl { + margin-top: 0.8em; + margin-bottom: 0.8em; +} +dt { + margin-top: 0.5em; + margin-bottom: 0; + font-style: normal; + color: #444466; +} +dd > *:first-child { + margin-top: 0.1em; +} + +ul, ol { + list-style-position: outside; +} +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { + list-style-type: lower-alpha; +} +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} + +div.tableblock > table { + border: 3px solid #444466; +} +thead { + font-weight: bold; + color: #444466; +} +tfoot { + font-weight: bold; +} +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} + + +div.hdlist { + margin-top: 0.8em; + margin-bottom: 0.8em; +} +div.hdlist tr { + padding-bottom: 15px; +} +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { + vertical-align: top; + font-style: normal; + padding-right: 0.8em; + color: #444466; +} +td.hdlist2 { + vertical-align: top; +} +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} + +@media print { + #footer-badges { display: none; } +} + +#toctitle { + color: #666688; + font-size: 1.2em; + font-weight: bold; + margin-top: 1.0em; + margin-bottom: 0.1em; +} + +div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { margin-top: 0; margin-bottom: 0; } +div.toclevel1 { margin-top: 0.3em; margin-left: 0; font-size: 1.0em; } +div.toclevel2 { margin-top: 0.25em; margin-left: 2em; font-size: 0.9em; } +div.toclevel3 { margin-left: 4em; font-size: 0.8em; } +div.toclevel4 { margin-left: 6em; font-size: 0.8em; } + +body { + margin: 1em 5%; + max-width: 55em; + padding-left: 0; + +} + +.monospaced, tt, div.listingblock > div.content { + font-family: Consolas, "Andale Mono", "Courier New", monospace; + color: #004400; + background: #f4f4f4; + max-width: 80em; + line-height: 1.2em; +} + +.paragraph p { + line-height: 1.5em; + margin-top: 1em; +} + +.paragraph p, li, dd, .content { max-width: 45em; } +.admonitionblock { max-width: 35em; } + +div.sectionbody div.ulist > ul > li { + list-style-type: square; + color: #aaa; +} + div.sectionbody div.ulist > ul > li > * { + color: black; + /*font-size: 50%;*/ + } + + +div.sectionbody div.ulist > ul > li div.ulist > ul > li { + color: #ccd ; +} + div.sectionbody div.ulist > ul > li div.ulist > ul > li > * { + color: black ; + } + +em { + font-style: normal ! important; + font-weight: bold ! important; + color: #662222 ! important; + letter-spacing:+0.08em ! important; +} + + +/* + * html5 specific + * + * */ + +table.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +thead, p.tableblock.header { + font-weight: bold; + color: #666688; +} +p.tableblock { + margin-top: 0; +} +table.tableblock { + border-width: 3px; + border-spacing: 0px; + border-style: solid; + border-color: #444466; + border-collapse: collapse; +} +th.tableblock, td.tableblock { + border-width: 1px; + padding: 4px; + border-style: solid; + border-color: #444466; +} + +table.tableblock.frame-topbot { + border-left-style: hidden; + border-right-style: hidden; +} +table.tableblock.frame-sides { + border-top-style: hidden; + border-bottom-style: hidden; +} +table.tableblock.frame-none { + border-style: hidden; +} + +th.tableblock.halign-left, td.tableblock.halign-left { + text-align: left; +} +th.tableblock.halign-center, td.tableblock.halign-center { + text-align: center; +} +th.tableblock.halign-right, td.tableblock.halign-right { + text-align: right; +} + +th.tableblock.valign-top, td.tableblock.valign-top { + vertical-align: top; +} +th.tableblock.valign-middle, td.tableblock.valign-middle { + vertical-align: middle; +} +th.tableblock.valign-bottom, td.tableblock.valign-bottom { + vertical-align: bottom; +} + + diff --git a/source-builder/sb/asciidoc/vim/ftdetect/asciidoc_filetype.vim b/source-builder/sb/asciidoc/vim/ftdetect/asciidoc_filetype.vim new file mode 100644 index 0000000..c8f7028 --- /dev/null +++ b/source-builder/sb/asciidoc/vim/ftdetect/asciidoc_filetype.vim @@ -0,0 +1,53 @@ +" Vim filetype detection file +" Language: AsciiDoc +" Author: Stuart Rackham +" Last Change: AsciiDoc 8.2.0 +" URL: http://www.methods.co.nz/asciidoc/ +" Licence: GPL (http://www.gnu.org) +" Remarks: Vim 6 or greater + +" COMMENT OUT ONE OF THE TWO FOLLOWING COMMANDS +" The first sets asciidoc syntax highlighting on all .txt files, the second +" only existing files *.txt that appear to be AsciiDoc files. + +au BufNewFile,BufRead *.asciidoc,*.txt,README,TODO,CHANGELOG,NOTES setfiletype asciidoc +"au BufRead *.txt,README,TODO,CHANGELOG,NOTES call s:FTasciidoc() + +" This function checks for a valid AsciiDoc document title after first +" skipping any leading comments. +function! s:FTasciidoc() + let in_comment_block = 0 + let n = 1 + while n < 50 + let line = getline(n) + let n = n + 1 + if line =~ '^/\{4,}$' + if ! in_comment_block + let in_comment_block = 1 + else + let in_comment_block = 0 + endif + continue + endif + if in_comment_block + continue + endif + if line !~ '\(^//\)\|\(^\s*$\)' + break + endif + endwhile + if line !~ '.\{3,}' + return + endif + let len = len(line) + let line = getline(n) + if line !~ '[-=]\{3,}' + return + endif + if len < len(line) - 3 || len > len(line) + 3 + return + endif + setfiletype asciidoc +endfunction + +" vim: et sw=2 ts=2 sts=2: diff --git a/source-builder/sb/asciidoc/vim/syntax/asciidoc.vim b/source-builder/sb/asciidoc/vim/syntax/asciidoc.vim new file mode 100644 index 0000000..dc5c91a --- /dev/null +++ b/source-builder/sb/asciidoc/vim/syntax/asciidoc.vim @@ -0,0 +1,173 @@ +" Vim syntax file +" Language: AsciiDoc +" Author: Stuart Rackham (inspired by Felix +" Obenhuber's original asciidoc.vim script). +" URL: http://www.methods.co.nz/asciidoc/ +" Licence: GPL (http://www.gnu.org) +" Remarks: Vim 6 or greater +" Limitations: See 'Appendix E: Vim Syntax Highlighter' in the AsciiDoc 'User +" Guide'. + +if exists("b:current_syntax") + finish +endif + +syn clear +syn sync fromstart +syn sync linebreaks=1 + +" Run :help syn-priority to review syntax matching priority. +syn keyword asciidocToDo TODO FIXME CHECK TEST XXX ZZZ DEPRECATED +syn match asciidocBackslash /\\/ +syn region asciidocIdMarker start=/^\$Id:\s/ end=/\s\$$/ +syn match asciidocCallout /\\\@/ +syn match asciidocOpenBlockDelimiter /^--$/ +syn match asciidocLineBreak /[ \t]+$/ +syn match asciidocRuler /^'\{3,}$/ +syn match asciidocPagebreak /^<\{3,}$/ +syn match asciidocEntityRef /\\\@\?[0-9A-Za-z_]\@!/ +syn match asciidocAttributeRef /\\\@.]\{,3}\)\?\([a-z]\)\?\)\?|/ containedin=asciidocTableBlock contained +syn region asciidocTableBlock matchgroup=asciidocTableDelimiter start=/^|=\{3,}$/ end=/^|=\{3,}$/ keepend contains=ALL +syn match asciidocTablePrefix /\(\S\@.]\{,3}\)\?\([a-z]\)\?\)\?!/ containedin=asciidocTableBlock contained +syn region asciidocTableBlock2 matchgroup=asciidocTableDelimiter2 start=/^!=\{3,}$/ end=/^!=\{3,}$/ keepend contains=ALL + +syn match asciidocListContinuation /^+$/ +syn region asciidocLiteralBlock start=/^\.\{4,}$/ end=/^\.\{4,}$/ contains=asciidocCallout,asciidocToDo keepend +syn region asciidocListingBlock start=/^-\{4,}$/ end=/^-\{4,}$/ contains=asciidocCallout,asciidocToDo keepend +syn region asciidocCommentBlock start="^/\{4,}$" end="^/\{4,}$" contains=asciidocToDo +syn region asciidocPassthroughBlock start="^+\{4,}$" end="^+\{4,}$" + +" Allowing leading \w characters in the filter delimiter is to accomodate +" the pre version 8.2.7 syntax and may be removed in future releases. +syn region asciidocFilterBlock start=/^\w*\~\{4,}$/ end=/^\w*\~\{4,}$/ + +syn region asciidocMacroAttributes matchgroup=asciidocRefMacro start=/\\\@>\)\|^$/ contains=asciidocQuoted.* keepend +syn region asciidocMacroAttributes matchgroup=asciidocAnchorMacro start=/\\\@| +text= + +[listtags-glossary] +text= + +[listtags-bibliography] +text= + +[tabletags-default] +paragraph=
|
+ +[tabletags-emphasis] +paragraph=
|
+ +[tabletags-strong] +paragraph=
|
+ +[tabletags-monospaced] +paragraph=
|
+ +[listingblock] + +

{title}

+ + +
+
+|
+
+
+ +[literalblock] + +

{title}

+
+|
+
+ +[sidebarblock] + + +
+

{title}

+| +
+ +[exampleblock] + +

{caption=}{title}

+ +
+| +
+ +[admonitionblock] + + + +

{caption}

+

{title}

+| +
+ diff --git a/source-builder/sb/asciidoc/xhtml11.conf b/source-builder/sb/asciidoc/xhtml11.conf index b648301..998a49a 100644 --- a/source-builder/sb/asciidoc/xhtml11.conf +++ b/source-builder/sb/asciidoc/xhtml11.conf @@ -79,8 +79,8 @@ latexmath-style=template="latexmathblock",subs=() {data-uri%}{alt={target}} -{data-uri#}{alt={target}} +{data-uri#}{alt={target}} {link#} @@ -89,8 +89,8 @@ latexmath-style=template="latexmathblock",subs=()
{caption={figure-caption} {counter:figure-number}. }{title}
-- cgit v1.2.3