summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-08-07 09:59:49 +1000
committerChris Johns <chrisj@rtems.org>2017-08-07 09:59:49 +1000
commit8b96e17c8abf61d97dd224b23370dc148f32fe3c (patch)
treee8eb043159d145ffbbbf9c23ef872226de5ab059
parent295c197b511957f16ebd475c13d3d22ec5c09401 (diff)
downloadrtems-source-builder-8b96e17c8abf61d97dd224b23370dc148f32fe3c.tar.bz2
doc: Remove in source documentation and the asciidoc package
The RSB documentation is now in ReST format and part of the RTEMS Documentation project. See https://docs.rtems.org/. Remove support for the GPL based asciidoc tool and remove the asciidoc package from the RSB. Add the Python Markdown package and update the reporter to use Markdown for HTML generation. The resuling HTML report is a single self contained file. Closes #3047.
-rw-r--r--LICENSE24
-rw-r--r--README18
-rw-r--r--doc/.gitignore2
-rw-r--r--doc/host-results.csv3
-rw-r--r--doc/images/icons/README5
-rw-r--r--doc/images/icons/callouts/1.pngbin329 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/10.pngbin361 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/11.pngbin565 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/12.pngbin617 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/13.pngbin623 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/14.pngbin411 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/15.pngbin640 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/2.pngbin353 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/3.pngbin350 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/4.pngbin345 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/5.pngbin348 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/6.pngbin355 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/7.pngbin344 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/8.pngbin357 -> 0 bytes
-rw-r--r--doc/images/icons/callouts/9.pngbin357 -> 0 bytes
-rw-r--r--doc/images/icons/caution.pngbin2734 -> 0 bytes
-rw-r--r--doc/images/icons/example.pngbin2599 -> 0 bytes
-rw-r--r--doc/images/icons/home.pngbin1340 -> 0 bytes
-rw-r--r--doc/images/icons/important.pngbin2980 -> 0 bytes
-rw-r--r--doc/images/icons/next.pngbin1302 -> 0 bytes
-rw-r--r--doc/images/icons/note.pngbin2494 -> 0 bytes
-rw-r--r--doc/images/icons/prev.pngbin1348 -> 0 bytes
-rw-r--r--doc/images/icons/tip.pngbin2718 -> 0 bytes
-rw-r--r--doc/images/icons/up.pngbin1320 -> 0 bytes
-rw-r--r--doc/images/icons/warning.pngbin3214 -> 0 bytes
-rw-r--r--doc/images/rtemswhitebg.jpgbin117890 -> 0 bytes
-rw-r--r--doc/source-builder.txt3402
-rw-r--r--doc/wscript30
-rw-r--r--source-builder/sb/asciidoc/BUGS27
-rw-r--r--source-builder/sb/asciidoc/BUGS.txt20
-rw-r--r--source-builder/sb/asciidoc/CHANGELOG3291
-rw-r--r--source-builder/sb/asciidoc/CHANGELOG.txt3128
-rw-r--r--source-builder/sb/asciidoc/COPYING339
-rw-r--r--source-builder/sb/asciidoc/COPYRIGHT18
-rw-r--r--source-builder/sb/asciidoc/INSTALL235
-rw-r--r--source-builder/sb/asciidoc/INSTALL.txt227
-rw-r--r--source-builder/sb/asciidoc/MANIFEST90
-rw-r--r--source-builder/sb/asciidoc/Makefile.in185
-rw-r--r--source-builder/sb/asciidoc/README45
-rw-r--r--source-builder/sb/asciidoc/README.txt35
-rwxr-xr-xsource-builder/sb/asciidoc/a2x.py960
-rw-r--r--source-builder/sb/asciidoc/asciidoc.conf647
-rwxr-xr-xsource-builder/sb/asciidoc/asciidoc.py6260
-rw-r--r--source-builder/sb/asciidoc/asciidocapi.py257
-rw-r--r--source-builder/sb/asciidoc/common.aap9
-rwxr-xr-xsource-builder/sb/asciidoc/configure3033
-rw-r--r--source-builder/sb/asciidoc/configure.ac11
-rw-r--r--source-builder/sb/asciidoc/dblatex/asciidoc-dblatex.sty20
-rw-r--r--source-builder/sb/asciidoc/dblatex/asciidoc-dblatex.xsl74
-rw-r--r--source-builder/sb/asciidoc/dblatex/dblatex-readme.txt39
-rw-r--r--source-builder/sb/asciidoc/doc/a2x.1744
-rw-r--r--source-builder/sb/asciidoc/doc/a2x.1.txt358
-rw-r--r--source-builder/sb/asciidoc/doc/article-docinfo.xml87
-rw-r--r--source-builder/sb/asciidoc/doc/article.pdfbin37949 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/article.txt139
-rw-r--r--source-builder/sb/asciidoc/doc/asciidoc.1310
-rw-r--r--source-builder/sb/asciidoc/doc/asciidoc.1.txt197
-rw-r--r--source-builder/sb/asciidoc/doc/asciidoc.conf7
-rw-r--r--source-builder/sb/asciidoc/doc/asciidoc.dict1085
-rw-r--r--source-builder/sb/asciidoc/doc/asciidoc.txt6038
-rw-r--r--source-builder/sb/asciidoc/doc/asciidocapi.txt189
-rw-r--r--source-builder/sb/asciidoc/doc/asciimathml.txt61
-rw-r--r--source-builder/sb/asciidoc/doc/book-multi.txt181
-rw-r--r--source-builder/sb/asciidoc/doc/book.epubbin17614 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/book.txt156
-rw-r--r--source-builder/sb/asciidoc/doc/customers.csv18
-rw-r--r--source-builder/sb/asciidoc/doc/epub-notes.txt210
-rw-r--r--source-builder/sb/asciidoc/doc/faq.txt1358
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/README5
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/1.pngbin329 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/10.pngbin361 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/11.pngbin565 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/12.pngbin617 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/13.pngbin623 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/14.pngbin411 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/15.pngbin640 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/2.pngbin353 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/3.pngbin350 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/4.pngbin345 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/5.pngbin348 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/6.pngbin355 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/7.pngbin344 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/8.pngbin357 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/callouts/9.pngbin357 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/caution.pngbin2734 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/example.pngbin2599 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/home.pngbin1340 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/important.pngbin2980 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/next.pngbin1302 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/note.pngbin2494 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/prev.pngbin1348 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/tip.pngbin2718 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/up.pngbin1320 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/icons/warning.pngbin3214 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/smallnew.pngbin292 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/images/tiger.pngbin6515 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/latex-backend.txt192
-rw-r--r--source-builder/sb/asciidoc/doc/latex-bugs.txt134
-rw-r--r--source-builder/sb/asciidoc/doc/latex-filter.pdfbin100587 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/latex-filter.txt196
-rw-r--r--source-builder/sb/asciidoc/doc/latexmath.txt121
-rw-r--r--source-builder/sb/asciidoc/doc/latexmathml.txt41
-rw-r--r--source-builder/sb/asciidoc/doc/main.aap233
-rw-r--r--source-builder/sb/asciidoc/doc/music-filter.pdfbin36491 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/music-filter.txt148
-rw-r--r--source-builder/sb/asciidoc/doc/publishing-ebooks-with-asciidoc.txt398
-rw-r--r--source-builder/sb/asciidoc/doc/slidy-example.txt167
-rw-r--r--source-builder/sb/asciidoc/doc/slidy.txt113
-rw-r--r--source-builder/sb/asciidoc/doc/source-highlight-filter.pdfbin127428 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/doc/source-highlight-filter.txt270
-rw-r--r--source-builder/sb/asciidoc/doc/testasciidoc.txt231
-rw-r--r--source-builder/sb/asciidoc/docbook-xsl/asciidoc-docbook-xsl.txt65
-rw-r--r--source-builder/sb/asciidoc/docbook-xsl/chunked.xsl17
-rw-r--r--source-builder/sb/asciidoc/docbook-xsl/common.xsl106
-rw-r--r--source-builder/sb/asciidoc/docbook-xsl/epub.xsl35
-rw-r--r--source-builder/sb/asciidoc/docbook-xsl/fo.xsl152
-rw-r--r--source-builder/sb/asciidoc/docbook-xsl/htmlhelp.xsl16
-rw-r--r--source-builder/sb/asciidoc/docbook-xsl/manpage.xsl31
-rw-r--r--source-builder/sb/asciidoc/docbook-xsl/text.xsl55
-rw-r--r--source-builder/sb/asciidoc/docbook-xsl/xhtml.xsl14
-rw-r--r--source-builder/sb/asciidoc/docbook45.conf802
-rw-r--r--source-builder/sb/asciidoc/examples/website/ASCIIMathML.js938
-rw-r--r--source-builder/sb/asciidoc/examples/website/CHANGELOG.txt3128
-rw-r--r--source-builder/sb/asciidoc/examples/website/INSTALL.txt227
-rw-r--r--source-builder/sb/asciidoc/examples/website/LaTeXMathML.js1223
-rw-r--r--source-builder/sb/asciidoc/examples/website/README-website.txt29
-rw-r--r--source-builder/sb/asciidoc/examples/website/README.txt35
-rw-r--r--source-builder/sb/asciidoc/examples/website/a2x.1.txt358
-rw-r--r--source-builder/sb/asciidoc/examples/website/asciidoc-docbook-xsl.txt65
-rw-r--r--source-builder/sb/asciidoc/examples/website/asciidoc-graphviz-sample.txt170
-rw-r--r--source-builder/sb/asciidoc/examples/website/asciidoc.css525
-rw-r--r--source-builder/sb/asciidoc/examples/website/asciidoc.js189
-rw-r--r--source-builder/sb/asciidoc/examples/website/asciidocapi.txt189
-rw-r--r--source-builder/sb/asciidoc/examples/website/asciimathml.txt61
-rwxr-xr-xsource-builder/sb/asciidoc/examples/website/build-website.sh25
-rw-r--r--source-builder/sb/asciidoc/examples/website/customers.csv18
-rw-r--r--source-builder/sb/asciidoc/examples/website/epub-notes.txt210
-rw-r--r--source-builder/sb/asciidoc/examples/website/faq.txt1358
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/highlighter.pngbin128142 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/README5
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/1.pngbin329 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/10.pngbin361 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/11.pngbin565 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/12.pngbin617 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/13.pngbin623 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/14.pngbin411 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/15.pngbin640 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/2.pngbin353 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/3.pngbin350 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/4.pngbin345 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/5.pngbin348 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/6.pngbin355 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/7.pngbin344 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/8.pngbin357 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/callouts/9.pngbin357 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/caution.pngbin2734 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/example.pngbin2599 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/home.pngbin1340 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/important.pngbin2980 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/next.pngbin1302 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/note.pngbin2494 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/prev.pngbin1348 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/tip.pngbin2718 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/up.pngbin1320 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/icons/warning.pngbin3214 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/smallnew.pngbin292 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/images/tiger.pngbin6515 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/examples/website/index.txt510
-rw-r--r--source-builder/sb/asciidoc/examples/website/latex-backend.txt192
-rw-r--r--source-builder/sb/asciidoc/examples/website/latex-bugs.txt134
-rw-r--r--source-builder/sb/asciidoc/examples/website/latex-filter.txt196
-rw-r--r--source-builder/sb/asciidoc/examples/website/latexmathml.txt41
-rw-r--r--source-builder/sb/asciidoc/examples/website/layout1.conf153
-rw-r--r--source-builder/sb/asciidoc/examples/website/layout1.css65
-rw-r--r--source-builder/sb/asciidoc/examples/website/layout2.conf153
-rw-r--r--source-builder/sb/asciidoc/examples/website/layout2.css83
-rw-r--r--source-builder/sb/asciidoc/examples/website/main.aap159
-rw-r--r--source-builder/sb/asciidoc/examples/website/manpage.txt197
-rw-r--r--source-builder/sb/asciidoc/examples/website/music-filter.txt148
-rw-r--r--source-builder/sb/asciidoc/examples/website/newlists.txt40
-rw-r--r--source-builder/sb/asciidoc/examples/website/newtables.txt743
-rw-r--r--source-builder/sb/asciidoc/examples/website/plugins.txt91
-rw-r--r--source-builder/sb/asciidoc/examples/website/publishing-ebooks-with-asciidoc.txt398
-rw-r--r--source-builder/sb/asciidoc/examples/website/slidy-example.txt167
-rw-r--r--source-builder/sb/asciidoc/examples/website/slidy.txt113
-rw-r--r--source-builder/sb/asciidoc/examples/website/source-highlight-filter.txt270
-rw-r--r--source-builder/sb/asciidoc/examples/website/support.txt5
-rw-r--r--source-builder/sb/asciidoc/examples/website/testasciidoc.txt231
-rw-r--r--source-builder/sb/asciidoc/examples/website/userguide.txt6038
-rw-r--r--source-builder/sb/asciidoc/examples/website/version83.txt37
-rw-r--r--source-builder/sb/asciidoc/examples/website/xhtml11-quirks.css43
-rw-r--r--source-builder/sb/asciidoc/filters/code/code-filter-readme.txt37
-rw-r--r--source-builder/sb/asciidoc/filters/code/code-filter-test.txt15
-rw-r--r--source-builder/sb/asciidoc/filters/code/code-filter.conf8
-rwxr-xr-xsource-builder/sb/asciidoc/filters/code/code-filter.py239
-rw-r--r--source-builder/sb/asciidoc/filters/graphviz/asciidoc-graphviz-sample.txt170
-rw-r--r--source-builder/sb/asciidoc/filters/graphviz/graphviz-filter.conf53
-rwxr-xr-xsource-builder/sb/asciidoc/filters/graphviz/graphviz2png.py169
-rw-r--r--source-builder/sb/asciidoc/filters/latex/latex-filter.conf28
-rwxr-xr-xsource-builder/sb/asciidoc/filters/latex/latex2png.py232
-rw-r--r--source-builder/sb/asciidoc/filters/music/music-filter-test.txt40
-rw-r--r--source-builder/sb/asciidoc/filters/music/music-filter.conf42
-rwxr-xr-xsource-builder/sb/asciidoc/filters/music/music2png.py213
-rw-r--r--source-builder/sb/asciidoc/filters/source/source-highlight-filter-test.txt19
-rw-r--r--source-builder/sb/asciidoc/filters/source/source-highlight-filter.conf140
-rw-r--r--source-builder/sb/asciidoc/help.conf394
-rw-r--r--source-builder/sb/asciidoc/html4.conf506
-rw-r--r--source-builder/sb/asciidoc/html5.conf696
-rw-r--r--source-builder/sb/asciidoc/images/highlighter.pngbin128142 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/README5
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/1.pngbin329 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/10.pngbin361 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/11.pngbin565 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/12.pngbin617 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/13.pngbin623 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/14.pngbin411 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/15.pngbin640 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/2.pngbin353 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/3.pngbin350 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/4.pngbin345 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/5.pngbin348 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/6.pngbin355 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/7.pngbin344 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/8.pngbin357 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/callouts/9.pngbin357 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/caution.pngbin2734 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/example.pngbin2599 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/home.pngbin1340 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/important.pngbin2980 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/next.pngbin1302 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/note.pngbin2494 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/prev.pngbin1348 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/tip.pngbin2718 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/up.pngbin1320 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/icons/warning.pngbin3214 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/smallnew.pngbin292 -> 0 bytes
-rw-r--r--source-builder/sb/asciidoc/images/tiger.pngbin6515 -> 0 bytes
-rwxr-xr-xsource-builder/sb/asciidoc/install-sh201
-rw-r--r--source-builder/sb/asciidoc/javascripts/ASCIIMathML.js938
-rw-r--r--source-builder/sb/asciidoc/javascripts/LaTeXMathML.js1223
-rw-r--r--source-builder/sb/asciidoc/javascripts/asciidoc.js189
-rw-r--r--source-builder/sb/asciidoc/javascripts/slidy.js2845
-rw-r--r--source-builder/sb/asciidoc/javascripts/toc.js77
-rw-r--r--source-builder/sb/asciidoc/lang-de.conf61
-rw-r--r--source-builder/sb/asciidoc/lang-el.conf55
-rw-r--r--source-builder/sb/asciidoc/lang-en.conf54
-rw-r--r--source-builder/sb/asciidoc/lang-es.conf57
-rw-r--r--source-builder/sb/asciidoc/lang-fr.conf59
-rw-r--r--source-builder/sb/asciidoc/lang-hu.conf57
-rw-r--r--source-builder/sb/asciidoc/lang-it.conf57
-rw-r--r--source-builder/sb/asciidoc/lang-nl.conf62
-rw-r--r--source-builder/sb/asciidoc/lang-pt-BR.conf58
-rw-r--r--source-builder/sb/asciidoc/lang-ru.conf59
-rw-r--r--source-builder/sb/asciidoc/lang-uk.conf60
-rw-r--r--source-builder/sb/asciidoc/latex.conf700
-rw-r--r--source-builder/sb/asciidoc/main.aap77
-rw-r--r--source-builder/sb/asciidoc/slidy.conf150
-rw-r--r--source-builder/sb/asciidoc/stylesheets/asciidoc.css525
-rw-r--r--source-builder/sb/asciidoc/stylesheets/docbook-xsl.css329
-rw-r--r--source-builder/sb/asciidoc/stylesheets/pygments.css66
-rw-r--r--source-builder/sb/asciidoc/stylesheets/slidy.css445
-rw-r--r--source-builder/sb/asciidoc/stylesheets/toc2.css34
-rw-r--r--source-builder/sb/asciidoc/stylesheets/xhtml11-quirks.css43
-rw-r--r--source-builder/sb/asciidoc/tests/asciidocapi.py257
-rw-r--r--source-builder/sb/asciidoc/tests/data/deprecated-quotes.txt12
-rw-r--r--source-builder/sb/asciidoc/tests/data/filters-test.txt90
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-de-man-test.txt21
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-de-test.txt106
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-en-man-test.txt21
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-en-test.txt114
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-es-man-test.txt21
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-es-test.txt106
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-fr-man-test.txt21
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-fr-test.txt106
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-hu-man-test.txt21
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-hu-test.txt106
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-it-man-test.txt21
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-it-test.txt106
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-nl-man-test.txt21
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-nl-test.txt94
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-pt-BR-man-test.txt21
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-pt-BR-test.txt106
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-ru-man-test.txt21
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-ru-test.txt106
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-uk-man-test.txt21
-rw-r--r--source-builder/sb/asciidoc/tests/data/lang-uk-test.txt106
-rw-r--r--source-builder/sb/asciidoc/tests/data/oldtables.txt64
-rw-r--r--source-builder/sb/asciidoc/tests/data/open-block-test.txt117
-rw-r--r--source-builder/sb/asciidoc/tests/data/rcs-id-marker-test.txt6
-rw-r--r--source-builder/sb/asciidoc/tests/data/testcases.conf12
-rw-r--r--source-builder/sb/asciidoc/tests/data/testcases.txt786
-rw-r--r--source-builder/sb/asciidoc/tests/data/utf8-bom-test.txt9
-rw-r--r--source-builder/sb/asciidoc/tests/data/utf8-examples.txt217
-rw-r--r--source-builder/sb/asciidoc/tests/testasciidoc.conf652
-rwxr-xr-xsource-builder/sb/asciidoc/tests/testasciidoc.py420
-rw-r--r--source-builder/sb/asciidoc/text.conf16
-rw-r--r--source-builder/sb/asciidoc/themes/flask/flask.css597
-rw-r--r--source-builder/sb/asciidoc/themes/volnitsky/volnitsky.css435
-rw-r--r--source-builder/sb/asciidoc/vim/ftdetect/asciidoc_filetype.vim53
-rw-r--r--source-builder/sb/asciidoc/vim/syntax/asciidoc.vim173
-rw-r--r--source-builder/sb/asciidoc/wordpress.conf88
-rw-r--r--source-builder/sb/asciidoc/xhtml11-quirks.conf61
-rw-r--r--source-builder/sb/asciidoc/xhtml11.conf694
-rw-r--r--source-builder/sb/asciidocapi.py257
-rw-r--r--source-builder/sb/markdown/LICENSE.md30
-rw-r--r--source-builder/sb/markdown/README.md38
-rw-r--r--source-builder/sb/markdown/__init__.py529
-rw-r--r--source-builder/sb/markdown/__main__.py136
-rw-r--r--source-builder/sb/markdown/__version__.py30
-rw-r--r--source-builder/sb/markdown/blockparser.py100
-rw-r--r--source-builder/sb/markdown/blockprocessors.py573
-rw-r--r--source-builder/sb/markdown/extensions/__init__.py100
-rw-r--r--source-builder/sb/markdown/extensions/abbr.py91
-rw-r--r--source-builder/sb/markdown/extensions/admonition.py96
-rw-r--r--source-builder/sb/markdown/extensions/attr_list.py178
-rw-r--r--source-builder/sb/markdown/extensions/codehilite.py265
-rw-r--r--source-builder/sb/markdown/extensions/def_list.py115
-rw-r--r--source-builder/sb/markdown/extensions/extra.py132
-rw-r--r--source-builder/sb/markdown/extensions/fenced_code.py113
-rw-r--r--source-builder/sb/markdown/extensions/footnotes.py416
-rw-r--r--source-builder/sb/markdown/extensions/headerid.py97
-rw-r--r--source-builder/sb/markdown/extensions/meta.py78
-rw-r--r--source-builder/sb/markdown/extensions/nl2br.py35
-rw-r--r--source-builder/sb/markdown/extensions/sane_lists.py55
-rw-r--r--source-builder/sb/markdown/extensions/smart_strong.py41
-rw-r--r--source-builder/sb/markdown/extensions/smarty.py268
-rw-r--r--source-builder/sb/markdown/extensions/tables.py196
-rw-r--r--source-builder/sb/markdown/extensions/toc.py310
-rw-r--r--source-builder/sb/markdown/extensions/wikilinks.py89
-rw-r--r--source-builder/sb/markdown/inlinepatterns.py534
-rw-r--r--source-builder/sb/markdown/odict.py191
-rw-r--r--source-builder/sb/markdown/postprocessors.py111
-rw-r--r--source-builder/sb/markdown/preprocessors.py352
-rw-r--r--source-builder/sb/markdown/serializers.py282
-rw-r--r--source-builder/sb/markdown/treeprocessors.py371
-rw-r--r--source-builder/sb/markdown/util.py177
-rw-r--r--source-builder/sb/reports.py268
342 files changed, 6347 insertions, 73893 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..8756b2e
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,24 @@
+RTEMS Tools Project (http://www.rtems.org/)
+Copyright 2010-2017 Chris Johns (chrisj@rtems.org)
+All rights reserved.
+
+This package is part of the RTEMS Tools Project.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+Additions Packages
+------------------
+
+This package includes the follow imported software:
+
+ Markdown: See source-builder/sb/markdown/LICENSE.md.
diff --git a/README b/README
index 7b47ca5..34350c8 100644
--- a/README
+++ b/README
@@ -11,11 +11,21 @@ set'. The RTEMS Source Builder is not limited to this role but designed to fit
with-in this specific niche. It can be used outside of the RTEMS project and we
welcome this happening in other open source or commercial projects.
-The project is part of the RTEMS Project. See http://www.rtems.org/ for
-details. The master repositiory is
-http://git.rtems.org/rtems-source-builder.git/.
+The project is part of the RTEMS Project. The project's websites are:
-Documentation is in the 'doc' directory and available as HTML at https://docs.rtems.org/rsb/.
+ RTEMS Project Website:
+ https://www.rtems.org/
+
+ GIT Source Repository:
+ https://git.rtems.org/rtems-source-builder.git/
+
+ Documentation:
+ https://docs.rtems.org/branches/master/rsb/index.html
+
+ Bugs:
+ https://devel.rtems.org/query?component=RSB
+
+Please refer to the LICENSE file for license details.
Contributions, suggestions, and bug reports are welcome.
diff --git a/doc/.gitignore b/doc/.gitignore
deleted file mode 100644
index 3af9e6f..0000000
--- a/doc/.gitignore
+++ /dev/null
@@ -1,2 +0,0 @@
-.lock-*
-build
diff --git a/doc/host-results.csv b/doc/host-results.csv
deleted file mode 100644
index 2f3d01d..0000000
--- a/doc/host-results.csv
+++ /dev/null
@@ -1,3 +0,0 @@
-FreeBSD 9,FreeBSD kaka 9.1-RELEASE amd64, Build clean, Build clean,AVR fails (CFLAGS for build),
-Windows 7,CYGWIN_NT-6.1-WOW64 popov 1.7.17(0.262/5/3) 2012-10-19 14:39 i686 Cygwin,,ARM,ARM fails (GCC PR56771),Needs more testers and after hardware.
-Fedora 17,Linux rtbf64a 3.7.3-101.fc17.x86_64, Build clean,,,
diff --git a/doc/images/icons/README b/doc/images/icons/README
deleted file mode 100644
index f12b2a7..0000000
--- a/doc/images/icons/README
+++ /dev/null
@@ -1,5 +0,0 @@
-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/doc/images/icons/callouts/1.png b/doc/images/icons/callouts/1.png
deleted file mode 100644
index 7d47343..0000000
--- a/doc/images/icons/callouts/1.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/10.png b/doc/images/icons/callouts/10.png
deleted file mode 100644
index 997bbc8..0000000
--- a/doc/images/icons/callouts/10.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/11.png b/doc/images/icons/callouts/11.png
deleted file mode 100644
index ce47dac..0000000
--- a/doc/images/icons/callouts/11.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/12.png b/doc/images/icons/callouts/12.png
deleted file mode 100644
index 31daf4e..0000000
--- a/doc/images/icons/callouts/12.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/13.png b/doc/images/icons/callouts/13.png
deleted file mode 100644
index 14021a8..0000000
--- a/doc/images/icons/callouts/13.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/14.png b/doc/images/icons/callouts/14.png
deleted file mode 100644
index 64014b7..0000000
--- a/doc/images/icons/callouts/14.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/15.png b/doc/images/icons/callouts/15.png
deleted file mode 100644
index 0d65765..0000000
--- a/doc/images/icons/callouts/15.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/2.png b/doc/images/icons/callouts/2.png
deleted file mode 100644
index 5d09341..0000000
--- a/doc/images/icons/callouts/2.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/3.png b/doc/images/icons/callouts/3.png
deleted file mode 100644
index ef7b700..0000000
--- a/doc/images/icons/callouts/3.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/4.png b/doc/images/icons/callouts/4.png
deleted file mode 100644
index adb8364..0000000
--- a/doc/images/icons/callouts/4.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/5.png b/doc/images/icons/callouts/5.png
deleted file mode 100644
index 4d7eb46..0000000
--- a/doc/images/icons/callouts/5.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/6.png b/doc/images/icons/callouts/6.png
deleted file mode 100644
index 0ba694a..0000000
--- a/doc/images/icons/callouts/6.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/7.png b/doc/images/icons/callouts/7.png
deleted file mode 100644
index 472e96f..0000000
--- a/doc/images/icons/callouts/7.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/8.png b/doc/images/icons/callouts/8.png
deleted file mode 100644
index 5e60973..0000000
--- a/doc/images/icons/callouts/8.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/callouts/9.png b/doc/images/icons/callouts/9.png
deleted file mode 100644
index a0676d2..0000000
--- a/doc/images/icons/callouts/9.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/caution.png b/doc/images/icons/caution.png
deleted file mode 100644
index 9a8c515..0000000
--- a/doc/images/icons/caution.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/example.png b/doc/images/icons/example.png
deleted file mode 100644
index 1199e86..0000000
--- a/doc/images/icons/example.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/home.png b/doc/images/icons/home.png
deleted file mode 100644
index 37a5231..0000000
--- a/doc/images/icons/home.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/important.png b/doc/images/icons/important.png
deleted file mode 100644
index be685cc..0000000
--- a/doc/images/icons/important.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/next.png b/doc/images/icons/next.png
deleted file mode 100644
index 64e126b..0000000
--- a/doc/images/icons/next.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/note.png b/doc/images/icons/note.png
deleted file mode 100644
index 7c1f3e2..0000000
--- a/doc/images/icons/note.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/prev.png b/doc/images/icons/prev.png
deleted file mode 100644
index 3e8f12f..0000000
--- a/doc/images/icons/prev.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/tip.png b/doc/images/icons/tip.png
deleted file mode 100644
index f087c73..0000000
--- a/doc/images/icons/tip.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/up.png b/doc/images/icons/up.png
deleted file mode 100644
index 2db1ce6..0000000
--- a/doc/images/icons/up.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/icons/warning.png b/doc/images/icons/warning.png
deleted file mode 100644
index d41edb9..0000000
--- a/doc/images/icons/warning.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/rtemswhitebg.jpg b/doc/images/rtemswhitebg.jpg
deleted file mode 100644
index f883f2c..0000000
--- a/doc/images/rtemswhitebg.jpg
+++ /dev/null
Binary files differ
diff --git a/doc/source-builder.txt b/doc/source-builder.txt
deleted file mode 100644
index 2b9a17d..0000000
--- a/doc/source-builder.txt
+++ /dev/null
@@ -1,3402 +0,0 @@
-RTEMS Source Builder
-====================
-:doctype: book
-:toc2:
-:toclevels: 5
-:icons:
-:numbered:
-
-image:images/rtemswhitebg.jpg["RTEMS",width="30%"]
-
-Chris Johns <chrisj@rtems.org>
-1.9, July 2014
-
-RTEMS Tools From Source
------------------------
-
-The RTEMS Source Builder is a tool to aid building packages from source used by
-the RTEMS project. It helps consolidate the details you need to build a package
-from source in a controlled and verifiable way. The tool is aimed at developers
-of software who use tool sets for embedded type development and is not limited
-to building just for RTEMS. Embedded development typically uses cross-compiling
-tool chains, debuggers, and debugging aids. Together we call these a 'tool
-set'. The RTEMS Source Builder is not limited to this role but designed to fit
-with-in this specific niche. It can be used outside of the RTEMS project and we
-welcome this happening in other open source or commercial projects.
-
-The RTEMS Source Builder is typically used to build a set of tools or a 'build
-set'. A 'build set' is a collection of packages and a package is a specific
-tool, for example gcc or gdb. The RTEMS Source Builder attempts to support any
-host environment that runs Python and you can build the package on. It is not
-some sort of magic that can take any piece of source code and make it
-build. Someone at some point in time has figured out how to build that package
-from source and taught this tool. The RTEMS Source Builder has been tested on:
-
-[[platform_links]]
-* <<_archlinux,Archlinux>>
-* <<_centos,Centos>>
-* <<_fedora,Fedora>>
-* <<_freebsd,FreeBSD>>
-* <<_netbsd,NetBSD>>
-* <<_macos,MacOS>>
-* <<_mint,Linux Mint>>
-* <<_opensuse,openSUSE>>
-* <<_raspbian,Raspbian>>
-* <<_ubuntu,Ubuntu>>
-* <<_windows,Windows>>
-* <<_ubuntu,Xubuntu>>
-
-The RTEMS Source Builder has two types of configuration data. The first is the
-'build set'. A _build set_ describes a collection of packages that define a set
-of tools you would use when developing software for RTEMS. For example the
-basic GNU tool set is binutils, gcc, and gdb and is the typical base suite of
-tools you need for an embedded cross-development type project. The second type
-of configuration data is the configuration files and they define how a package
-is built. Configuration files are scripts loosely based on the RPM spec file
-format and they detail the steps needed to build a package. The steps are
-'preparation', 'building', and 'installing'. Scripts support macros, shell
-expansion, logic, includes plus many more features useful when build packages.
-
-The RTEMS Source Builder does not interact with any host package management
-systems. There is no automatic dependence checking between various packages you
-build or packages and software your host system you may have installed. We
-assume the build sets and configuration files you are using have been created
-by developers who do. Support is provided for package config or pkgconfg type
-files so you can check and use standard libraries if present. If you have a
-problem please ask on the RTEMS Users mailing list.
-
-This documentation caters for a range of users from new to experienced RTEMS
-developers. New users can follow the Quick Start section up to the "Installing
-and Tar Files" to get a working tools and RTEMS. Users building a binary tool
-set for release can read the "Installing and Tar Files". Users wanting to run
-and test bleeding edge tools or packages, or wanting update or extend the RSB's
-configuration can read the remaining sections.
-
-*************************************************************
-IMPORTANT: If you have a problem please see <<_bugs,the reporting bugs>>
- section.
-*************************************************************
-
-Quick Start
------------
-
-The quick start will show you how to build a set of RTEMS tools for a supported
-architecture. The tools are installed into a build _prefix_. The _prefix_ is the
-top of a group of directories containing all the files needed to develop RTEMS
-applications. Building an RTEMS build set will build all that you need. This
-includes autoconf, automake, assemblers, linkers, compilers, debuggers,
-standard libraries and RTEMS itself.
-
-There is no need to become root or the administrator and we recommend you avoid
-doing this. You can build and install the tools anywhere on the host's file
-system you, as a standard user, have read and write access too. I recommend you
-use your home directory and work under the directory `~/development/rtems`. The
-examples shown here will do this.
-
-You can use the build _prefix_ to install and maintain different versions of
-the tools. Doing this lets you try a new set of tools while not touching your
-proven working production set of tools. Once you have proven the new tools are
-working rebuild with the 'production' prefix switching your development to them.
-
-I also suggest you keep your environment to the bare minimum, particularly the
-path variable. Using environment variables has been proven over the years to be
-difficult to manage in production systems.
-
-.Host Setup
-*************************************************************
-IMPORTANT: Before proceeding to the next section please refer to the
-<<_host_setups,host specific setup>> for your host and install any extra
-packages. The RSB assumes the needed packages are installed and work.
-*************************************************************
-
-.Path to use when building applications
-*************************************************************
-TIP: Do not forget to do this before you use the tools such as build RTEMS.
-
-The RSB by default will install (copy) the executables under the prefix you
-supply. To use the tools once finished just set your path to the 'bin'
-directory under the _prefix_ you use. In the examples that follow the _prefix_
-is `$HOME/development/rtems/4.11` and is set using the `--prefix` option so the
-path you need to configure to build applications can be set with the following
-in a BASH shell:
-
--------------------------------------------------------------
-$ export PATH=$HOME/development/rtems/4.11/bin:$PATH
--------------------------------------------------------------
-Make sure you place the RTEMS tool path at the front of your path so they are
-searched first. RTEMS can provide newer versions of some tools your operating
-system provides and placing the RTEMS tools path at the front means it is
-searched first and the RTEMS needed versions of the tools are used.
-*************************************************************
-
-.RTEMS Version
-*************************************************************
-RSB and RTEMS have matching `git branch` for each version of RTEMS.
-For example, if you want to build a toolchain for 4.11, then you
-should checkout the 4.11 branch of the RSB:
--------------------------------------------------------------
-$ git checkout -t origin/4.11
--------------------------------------------------------------
-Branches are available for the 4.9, 4.10, and 4.11 versions of RTEMS.
-*************************************************************
-
-Setup
-~~~~~
-
-Setup a development work space:
-
--------------------------------------------------------------
-$ cd
-$ mkdir -p development/rtems/src
-$ cd development/rtems/src
--------------------------------------------------------------
-
-The RTEMS Source Builder is distributed as source. It is Python code so all you
-need to do is head over to the RTEMS GIT repository and clone the code directly
-from git:
-
--------------------------------------------------------------
-$ git clone git://git.rtems.org/rtems-source-builder.git
-$ cd rtems-source-builder
--------------------------------------------------------------
-
-Checking
-~~~~~~~~
-
-The next step is to check if your host is set up correctly. The RTEMS Source
-Builder provides a tool to help:
-
--------------------------------------------------------------
-$ source-builder/sb-check
-warning: exe: absolute exe found in path: (__objcopy) /usr/local/bin/objcopy <1>
-warning: exe: absolute exe found in path: (__objdump) /usr/local/bin/objdump
-error: exe: not found: (_xz) /usr/local/bin/xz <2>
-RTEMS Source Builder environment is not correctly set up
-$ source-builder/sb-check
-RTEMS Source Builder environment is ok <3>
--------------------------------------------------------------
-
-<1> A tool is in the environment path but does not match the expected path.
-<2> The executable 'xz' is not found.
-<3> The host's environment is set up correct.
-
-The checking tool will output a list of executable files not found if problems
-are detected. Locate those executable files and install them. You may also be
-given a list of warnings about executable files not in the expected location
-however the executable was located somewhere in your environment's path. You
-will need to check each tool to determine if this is an issue. An executable
-not in the standard location may indicate it is not the host operating system's
-standard tool. It maybe ok or it could be buggy, only you can determine this.
-
-The <<_host_setups,Host Setups>> section lists packages you should install for
-common host operating systems. It maybe worth checking if you have those
-installed.
-
-Build Sets
-~~~~~~~~~~
-
-The RTEMS tools can be built within the RTEMS Source Builder's source tree. We
-recommend you do this so lets change into the RTEMS directory in the RTEMS
-Source Builder package:
-
--------------------------------------------------------------
-$ cd rtems
--------------------------------------------------------------
-
-If you are unsure how to specify the build set for the architecture you wish to
-build ask the tool:
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder --list-bsets <1>
-RTEMS Source Builder - Set Builder, v0.2.0
-Examining: config <2>
-Examining: ../source-builder/config <2>
- 4.10/rtems-all.bset <3>
- 4.10/rtems-arm.bset <4>
- 4.10/rtems-autotools.bset
- 4.10/rtems-avr.bset
- 4.10/rtems-bfin.bset
- 4.10/rtems-h8300.bset
- 4.10/rtems-i386.bset
- 4.10/rtems-lm32.bset
- 4.10/rtems-m32c.bset
- 4.10/rtems-m32r.bset
- 4.10/rtems-m68k.bset
- 4.10/rtems-mips.bset
- 4.10/rtems-nios2.bset
- 4.10/rtems-powerpc.bset
- 4.10/rtems-sh.bset
- 4.10/rtems-sparc.bset
- 4.11/rtems-all.bset
- 4.11/rtems-arm.bset
- 4.11/rtems-autotools.bset
- 4.11/rtems-avr.bset
- 4.11/rtems-bfin.bset
- 4.11/rtems-h8300.bset
- 4.11/rtems-i386.bset
- 4.11/rtems-lm32.bset
- 4.11/rtems-m32c.bset
- 4.11/rtems-m32r.bset
- 4.11/rtems-m68k.bset
- 4.11/rtems-microblaze.bset
- 4.11/rtems-mips.bset
- 4.11/rtems-moxie.bset
- 4.11/rtems-nios2.bset
- 4.11/rtems-powerpc.bset
- 4.11/rtems-sh.bset
- 4.11/rtems-sparc.bset
- 4.11/rtems-sparc64.bset
- 4.11/rtems-v850.bset
- 4.9/rtems-all.bset
- 4.9/rtems-arm.bset
- 4.9/rtems-autotools.bset
- 4.9/rtems-i386.bset
- 4.9/rtems-m68k.bset
- 4.9/rtems-mips.bset
- 4.9/rtems-powerpc.bset
- 4.9/rtems-sparc.bset
- gnu-tools-4.6.bset
- rtems-4.10-base.bset <5>
- rtems-4.11-base.bset
- rtems-4.9-base.bset
- rtems-base.bset <5>
- unstable/4.11/rtems-all.bset <6>
- unstable/4.11/rtems-arm.bset
- unstable/4.11/rtems-avr.bset
- unstable/4.11/rtems-bfin.bset
- unstable/4.11/rtems-h8300.bset
- unstable/4.11/rtems-i386.bset
- unstable/4.11/rtems-lm32.bset
- unstable/4.11/rtems-m32c.bset
- unstable/4.11/rtems-m32r.bset
- unstable/4.11/rtems-m68k.bset
- unstable/4.11/rtems-microblaze.bset
- unstable/4.11/rtems-mips.bset
- unstable/4.11/rtems-moxie.bset
- unstable/4.11/rtems-powerpc.bset
- unstable/4.11/rtems-sh.bset
- unstable/4.11/rtems-sparc.bset
- unstable/4.11/rtems-sparc64.bset
- unstable/4.11/rtems-v850.bset
--------------------------------------------------------------
-<1> Only option needed is +--list-bsets+
-<2> The paths inspected. See <<X1,+_configdir+>> variable.
-<3> Build all RTEMS 4.10 supported architectures.
-<4> The build set for the ARM architecture on RTEMS 4.10.
-<5> Support build set file with common functionality included by other build
- set files.
-<6> Unstable tool sets are used by RTEMS developers to test new tool sets. You
- are welcome to try them but you must remember they are unstable, can change
- at any point in time and your application may not work. If you have an
- issue with a production tool it may pay to try the unstable tool to see if
- it has been resolved.
-
-Building
-~~~~~~~~
-
-In this quick start I will build a SPARC tool set.
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder --log=l-sparc.txt <1> \
- --prefix=$HOME/development/rtems/4.11 <2> 4.11/rtems-sparc <3>
-Source Builder - Set Builder, v0.2.0
-Build Set: 4.11/rtems-sparc
-config: expat-2.1.0-1.cfg <4>
-package: expat-2.1.0-x86_64-freebsd9.1-1
-building: expat-2.1.0-x86_64-freebsd9.1-1
-config: tools/rtems-binutils-2.22-1.cfg <5>
-package: sparc-rtems4.11-binutils-2.22-1
-building: sparc-rtems4.11-binutils-2.22-1
-config: tools/rtems-gcc-4.7.2-newlib-1.20.0-1.cfg <6>
-package: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
-building: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
-config: tools/rtems-gdb-7.5.1-1.cfg <7>
-package: sparc-rtems4.11-gdb-7.5.1-1
-building: sparc-rtems4.11-gdb-7.5.1-1
-installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11 <8>
-installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11
-installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11
-installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11
-cleaning: expat-2.1.0-x86_64-freebsd9.1-1 <9>
-cleaning: sparc-rtems4.11-binutils-2.22-1
-cleaning: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
-cleaning: sparc-rtems4.11-gdb-7.5.1-1
-Build Set: Time 0:13:43.616383 <10>
--------------------------------------------------------------
-
-<1> Providing a log file redirects the build output into a file. Logging the
- build output provides a simple way to report problems.
-<2> The prefix is the location on your file system the tools are installed
- into. Provide a prefix to a location you have read and write access. You
- can use the prefix to install different versions or builds of tools. Just
- use the path to the tools you want to use when building RTEMS.
-<3> The build set. This is the SPARC build set. First a specifically referenced
- file is checked for and if not found the '%{_configdir} path is
- searched. The set builder will first look for files with a +.bset+
- extension and then for a configuration file with a +.cfg+ extension.
-<4> The SPARC build set first builds the expat library as it is used in GDB.
- This is the expat configuration used.
-<5> The binutils build configuration.
-<6> The GCC and Newlib build configuration.
-<7> The GDB build configuration.
-<8> Installing the built packages to the install prefix.
-<9> All the packages built are cleaned at the end. If the build fails all the
- needed files are present. You may have to clean up by deleting the build
- directory if the build fails.
-<10> The time to build the package. This lets you see how different host
- hardware or configurations perform.
-
-Your SPARC RTEMS 4.11 tool set will be installed and ready to build RTEMS and
-RTEMS applications. When the build runs you will notice the tool fetch the
-source code from the internet. These files are cached in a directory called
-+source+. If you run the build again the cached files are used. This is what
-happened in the shown example before.
-
-TIP: The RSB for releases will automatically build and install RTEMS. The
-development version require adding +--with-rtems+. Use this for a single
-command to get the tools and RTEMS with one command.
-
-The installed tools:
-
--------------------------------------------------------------
-$ ls $HOME/development/rtems/4.11
-bin include lib libexec share sparc-rtems4.11
-$ ls $HOME/development/rtems/4.11/bin
-sparc-rtems4.11-addr2line sparc-rtems4.11-cpp
-sparc-rtems4.11-gcc-ar sparc-rtems4.11-gprof
-sparc-rtems4.11-objdump sparc-rtems4.11-size
-sparc-rtems4.11-ar sparc-rtems4.11-elfedit
-sparc-rtems4.11-gcc-nm sparc-rtems4.11-ld
-sparc-rtems4.11-ranlib sparc-rtems4.11-strings
-sparc-rtems4.11-as sparc-rtems4.11-g++
-sparc-rtems4.11-gcc-ranlib sparc-rtems4.11-ld.bfd
-sparc-rtems4.11-readelf sparc-rtems4.11-strip
-sparc-rtems4.11-c++ sparc-rtems4.11-gcc
-sparc-rtems4.11-gcov sparc-rtems4.11-nm
-sparc-rtems4.11-run xmlwf
-sparc-rtems4.11-c++filt sparc-rtems4.11-gcc-4.7.2
-sparc-rtems4.11-gdb sparc-rtems4.11-objcopy
-sparc-rtems4.11-sis
-$ $HOME/development/rtems/4.11/bin/sparc-rtems4.11-gcc -v
-Using built-in specs.
-COLLECT_GCC=/home/chris/development/rtems/4.11/bin/sparc-rtems4.11-gcc
-COLLECT_LTO_WRAPPER=/usr/home/chris/development/rtems/4.11/bin/../ \
-libexec/gcc/sparc-rtems4.11/4.7.2/lto-wrapper
-Target: sparc-rtems4.11 <1>
-Configured with: ../gcc-4.7.2/configure <2>
---prefix=/home/chris/development/rtems/4.11
---bindir=/home/chris/development/rtems/4.11/bin
---exec_prefix=/home/chris/development/rtems/4.11
---includedir=/home/chris/development/rtems/4.11/include
---libdir=/home/chris/development/rtems/4.11/lib
---libexecdir=/home/chris/development/rtems/4.11/libexec
---mandir=/home/chris/development/rtems/4.11/share/man
---infodir=/home/chris/development/rtems/4.11/share/info
---datadir=/home/chris/development/rtems/4.11/share
---build=x86_64-freebsd9.1 --host=x86_64-freebsd9.1 --target=sparc-rtems4.11
---disable-libstdcxx-pch --with-gnu-as --with-gnu-ld --verbose --with-newlib
---with-system-zlib --disable-nls --without-included-gettext
---disable-win32-registry --enable-version-specific-runtime-libs --disable-lto
---enable-threads --enable-plugin --enable-newlib-io-c99-formats
---enable-newlib-iconv --enable-languages=c,c++
-Thread model: rtems <3>
-gcc version 4.7.2 20120920 <4>
- (RTEMS4.11-RSB(cb12e4875c203f794a5cd4b3de36101ff9a88403)-1,gcc-4.7.2/newlib-2.0.0) (GCC)
--------------------------------------------------------------
-
-<1> The target the compiler is built for.
-<2> The configure options used to build GCC.
-<3> The threading model is always RTEMS. This makes the RTEMS tools difficult
- for bare metal development more difficult.
-<4> The version string. It contains the Git hash of the RTEMS Source Builder
- you are using. If your local clone has been modifed that state is also
- recorded in the version string. The hash allows you to track from a GCC
- executable back to the original source used to build it.
-
-NOTE: The RTEMS thread model enables specific hooks in GCC so applications
-built with RTEMS tools need the RTEMS runtime to operate correctly. You can use
-RTEMS tools to build bare metal component but it is more difficult than with a
-bare metal tool chain and you need to know what you are doing at a low
-level. The RTEMS Source Builder can build bare metal tool chains as well. Look
-in the top level +bare+ directory.
-
-Distributing and Archiving A Build
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-If you wish to create and distribute your build or you want to archive a build
-you can create a tar file. This is a more advanced method for binary packaging
-and installing of tools.
-
-By default the RTEMS Source Builder installs the built packages directly and
-optionally it can also create a _build set tar file_ or a _package tar file_
-per package built. The normal and default behaviour is to let the RTEMS Source
-Builder install the tools. The source will be downloaded, built, installed and
-cleaned up.
-
-The tar files are created with the full build prefix present and if you follow
-the examples given in this documentation the path is absolute. This can cause
-problems if you are installing on a host you do not have super user or
-administrator rights on because the prefix path may references part you do not
-have write access too and tar will not extract the files. You can use the
-+--strip-components+ option in tar if your host tar application supports it to
-remove the parts you do not have write access too or you may need to unpack the
-tar file somewhere and copy the file tree from the level you have write access
-from. Embedding the full prefix path in the tar files lets you know what the
-prefix is and is recommended. For example if
-`/home/chris/development/rtems/4.11` is the prefix used you cannot change
-directory to the root (`/`) and install because the `/home` is root access
-only. To install you would:
-
--------------------------------------------------------------
-$ cd
-$ tar --strip-components=3 -xjf rtems-4.11-sparc-rtems4.11-1.tar.bz2
--------------------------------------------------------------
-
-A build set tar file is created by adding `--bset-tar-file` option to the
-`sb-set-builder` command.
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder --log=l-sparc.txt \
- --prefix=$HOME/development/rtems/4.11 \
- --bset-tar-file <1> 4.11/rtems-sparc
-Source Builder - Set Builder, v0.2.0
-Build Set: 4.11/rtems-sparc
-config: expat-2.1.0-1.cfg
-package: expat-2.1.0-x86_64-freebsd9.1-1
-building: expat-2.1.0-x86_64-freebsd9.1-1
-config: tools/rtems-binutils-2.22-1.cfg
-package: sparc-rtems4.11-binutils-2.22-1
-building: sparc-rtems4.11-binutils-2.22-1
-config: tools/rtems-gcc-4.7.2-newlib-1.20.0-1.cfg
-package: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
-building: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
-config: tools/rtems-gdb-7.5.1-1.cfg
-package: sparc-rtems4.11-gdb-7.5.1-1
-building: sparc-rtems4.11-gdb-7.5.1-1
-installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11 <2>
-installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11
-installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11
-installing: rtems-4.11-sparc-rtems4.11-1 -> /home/chris/development/rtems/4.11
-tarball: tar/rtems-4.11-sparc-rtems4.11-1.tar.bz2 <3>
-cleaning: expat-2.1.0-x86_64-freebsd9.1-1
-cleaning: sparc-rtems4.11-binutils-2.22-1
-cleaning: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
-cleaning: sparc-rtems4.11-gdb-7.5.1-1
-Build Set: Time 0:15:25.92873
--------------------------------------------------------------
-
-<1> The option to create a build set tar file.
-<2> The installation still happens unless you specify `--no-install`.
-<3> Creating the build set tar file.
-
-You can also suppress installing the files using the `--no-install` option to
-the `sb-set-builder` command. This is usefu if your prefix is not accessiable
-when building Canadian cross compiled tool sets.
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder --log=l-sparc.txt \
- --prefix=$HOME/development/rtems/4.11 \
- --bset-tar-file --no-install <1> 4.11/rtems-sparc
-Source Builder - Set Builder, v0.2.0
-Build Set: 4.11/rtems-sparc
-config: expat-2.1.0-1.cfg
-package: expat-2.1.0-x86_64-freebsd9.1-1
-building: expat-2.1.0-x86_64-freebsd9.1-1
-config: tools/rtems-binutils-2.22-1.cfg
-package: sparc-rtems4.11-binutils-2.22-1
-building: sparc-rtems4.11-binutils-2.22-1
-config: tools/rtems-gcc-4.7.2-newlib-1.20.0-1.cfg
-package: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
-building: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
-config: tools/rtems-gdb-7.5.1-1.cfg
-package: sparc-rtems4.11-gdb-7.5.1-1
-building: sparc-rtems4.11-gdb-7.5.1-1
-tarball: tar/rtems-4.11-sparc-rtems4.11-1.tar.bz2 <2>
-cleaning: expat-2.1.0-x86_64-freebsd9.1-1
-cleaning: sparc-rtems4.11-binutils-2.22-1
-cleaning: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
-cleaning: sparc-rtems4.11-gdb-7.5.1-1
-Build Set: Time 0:14:11.721274
-$ ls tar
-rtems-4.11-sparc-rtems4.11-1.tar.bz2
--------------------------------------------------------------
-
-<1> The option to supressing installing the packages.
-<2> Create the build set tar.
-
-A package tar file can be created by adding the +--pkg-tar-files+ to the
-+sb-set-builder+ command. This creates a tar file per package built in the
-build set.
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder --log=l-sparc.txt \
- --prefix=$HOME/development/rtems/4.11 \
- --bset-tar-file --pkg-tar-files <1> --no-install 4.11/rtems-sparc
-Source Builder - Set Builder, v0.2.0
-Build Set: 4.11/rtems-sparc
-config: expat-2.1.0-1.cfg
-package: expat-2.1.0-x86_64-freebsd9.1-1
-building: expat-2.1.0-x86_64-freebsd9.1-1
-config: tools/rtems-binutils-2.22-1.cfg
-package: sparc-rtems4.11-binutils-2.22-1
-building: sparc-rtems4.11-binutils-2.22-1
-config: tools/rtems-gcc-4.7.2-newlib-1.20.0-1.cfg
-package: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
-building: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
-config: tools/rtems-gdb-7.5.1-1.cfg
-package: sparc-rtems4.11-gdb-7.5.1-1
-building: sparc-rtems4.11-gdb-7.5.1-1
-tarball: tar/rtems-4.11-sparc-rtems4.11-1.tar.bz2
-cleaning: expat-2.1.0-x86_64-freebsd9.1-1
-cleaning: sparc-rtems4.11-binutils-2.22-1
-cleaning: sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1
-cleaning: sparc-rtems4.11-gdb-7.5.1-1
-Build Set: Time 0:14:37.658460
-$ ls tar
-expat-2.1.0-x86_64-freebsd9.1-1.tar.bz2 sparc-rtems4.11-binutils-2.22-1.tar.bz2
-sparc-rtems4.11-gdb-7.5.1-1.tar.bz2 <2> rtems-4.11-sparc-rtems4.11-1.tar.bz2 <3>
-sparc-rtems4.11-gcc-4.7.2-newlib-1.20.0-1.tar.bz2
--------------------------------------------------------------
-
-<1> The option to create packages tar files.
-<2> The GDB package tar file.
-<3> The build set tar file. All the others in a single tar file.
-
-Controlling the Build
-~~~~~~~~~~~~~~~~~~~~~
-
-Build sets can be controlled via the command line to enable and disable various
-features. There is no definitive list of build options that can be listed
-because they are implemented with the configuration scripts. The best way to
-find what is available is to grep the configuration files. for +with+ and
-+without+.
-
-Following are currentlt available:
-
-'--without-rtems':: Do not build RTEMS when building an RTEMS build set.
-'--without-cxx':: Do not build a C++ compiler.
-'--with-objc':: Attempt to build a C++ compiler.
-'--with-fortran':: Attempt to build a Fortran compiler.
-
-Why Build from Source ?
------------------------
-
-The RTEMS Source Builder is not a replacement for the binary install systems
-you have with commercial operating systems or open source operating system
-distributions. Those products and distributions are critically important and
-are the base that allows the Source Builder to work. The RTEMS Source Builder
-sits somewhere between you manually entering the commands to build a tool set
-and a tool such as +yum+ or +apt-get+ to install binary packages made
-specifically for your host operating system. Building manually or installing a
-binary package from a remote repository are valid and real alternatives while
-the Source Builder is attempting to provide a specific service of repeatably
-being able to build tool sets from source code.
-
-If you are developing a system or product that has a long shelf life or is used
-in a critical piece of infrastructure that has a long life cycle being able to
-build from source is important. It insulates the project from the fast ever
-changing world of the host development machines. If your tool set is binary and
-you have lost the ability to build it you have lost a degree of control and
-flexibility open source gives you. Fast moving host environments are
-fantastic. We have powerful multi-core computers with huge amounts of memory
-and state of the art operating systems to run on them however the product or
-project you are part of may need to be maintained well past the life time of
-these host. Being able to build from source an important and critical part of
-this process because you can move to a newer host and create an equivalent tool
-set.
-
-Building from source provides you with control over the configuration of the
-package you are building. If all or the most important dependent parts are
-built from source you limit the exposure to host variations. For example the
-GNU C compiler (gcc) currently uses a number of 3rd party libraries internally
-(gmp, mpfr, etc). If your validated compiler generating code for your target
-processor is dynamically linked against the host's version of these libraries
-any change in the host's configuration may effect you. The changes the host's
-package management system makes may be perfectly reasonable in relation to the
-distribution being managed however this may not extend to you and your
-tools. Building your tools from source and controlling the specific version of
-these dependent parts means you are not exposing yourself to unexpected and
-often difficult to resolve problems. On the other side you need to make sure
-your tools build and work with newer versions of the host operating
-system. Given the stability of standards based libraries like 'libc' and ever
-improving support for standard header file locations this task is becoming
-easier.
-
-The RTEMS Source Builder is designed to be audited and incorporated into a
-project's verification and validation process. If your project is developing
-critical applications that needs to be traced from source to executable code in
-the target, you need to also consider the tools and how to track them.
-
-If your IT department maintains all your computers and you do not have suitable
-rights to install binary packages, building from source lets you create your
-own tool set that you install under your home directory. Avoiding installing
-any extra packages as a super user is always helpful in maintaining a secure
-computing environment.
-
-[[_bugs]]
-Bugs, Crashes, and Build Failures
----------------------------------
-
-The RTEMS Source Builder is a Python program and every care is taken to test
-the code however bugs, crashes, and build failures can and do happen. If you
-find a bug please report it via the RTEMS Bug tracker tool Bugzilla or via
-email on the RTEMS Users list. RTEMS's bugzilla is found at
-https://www.rtems.org/bugzilla/.
-
-Please include the generated RSB report. If you see the following a report has
-been generated:
-
--------------------------------------------------------------
- ...
- ...
-Build FAILED <1>
- See error report: rsb-report-4.11-rtems-lm32.txt <2>
--------------------------------------------------------------
-<1> The build has failed.
-<2> The report's file name.
-
-The generated report contains the command line, version of the RSB, your host's
-+uname+ details, the version of Python and the last 200 lines of the log.
-
-If for some reason there is no report please send please report the following:
-
-. Command line,
-. The git hash,
-. Host details with the output of the +uname -a+ command,
-. If you have made any modifications.
-
-If there is a Python crash please cut and paste the Python backtrace into the
-bug report. If the tools fail to build please locate the first error in the log
-file. This can be difficult to find on hosts with many cores so it sometimes
-pays to re-run the command with the +--jobs=none+ option to get a log that is
-correctly sequenced. If searching the log file seach for +error:+ and the error
-should be just above it.
-
-[[_contributing]]
-Contributing
-------------
-
-We welcome all users adding, fixing, updating and upgrading packages and their
-configurations. The RSB is open source and open to contributions. These can be
-bug fixes, new features or new configurations. Please break patches down into
-changes to the core Python code, configuration changes or new configurations.
-
-Please email me patches via git so I can maintain your commit messages so you
-are acknowledged as the contributor.
-
-Most of what follows is related to the development of RSB and it's
-configurations.
-
-Project Sets
-------------
-
-The RTEMS Source Builder supports project configurations. Project
-configurations can be public or private and can be contained in the RTEMS
-Source Builder project if suitable, other projects they use the RTEMS Source
-Builder or privately on your local file system.
-
-The configuration file loader searches the macro +_configdir+ and by default
-this is set to +%{\_topdir}/config:%{\_sbdir}/config+ where +_topdir+ is the
-your current working direct, in other words the directory you invoke the RTEMS
-Source Builder command in, and +_sbdir+ is the directory where the RTEMS Source
-Builder command resides. Therefore the +config+ directory under each of these
-is searched so all you need to do is create a +config+ in your project and add
-your configuration files. They do not need to be under the RTEMS Source Builder
-source tree. Public projects are included in the main RTEMS Source Builder such
-as RTEMS.
-
-You can also add your own +patches+ directory next to your +config+ directory
-as the +%patch+ command searches the +_patchdir+ macro variable and it is
-by default set to +%{\_topdir}/patches:%{\_sbdir}/patches+.
-
-The +source-builder/config+ directory provides generic scripts for building
-various tools. You can specialise these in your private configurations to make
-use of them. If you add new generic configurations please contribute them back
-to the project
-
-Bare Metal
-~~~~~~~~~~
-
-The RSB contains a 'bare' configuration tree and you can use this to add
-packages you use on the hosts. For example 'qemu' is supported on a range of
-hosts. RTEMS tools live in the +rtems/config+ directory tree. RTEMS packages
-include tools for use on your host computer as well as packages you can build
-and run on RTEMS.
-
-The 'bare metal' support for GNU Tool chains. An example is the 'lang/gcc491'
-build set. You need to provide a target via the command line '--target'
-option and this is in the standard 2 or 3 tuple form. For example for an ARM
-compiler you would use 'arm-eabi' or 'arm-eabihf', and for SPARC you would
-use 'sparc-elf'.
-
--------------------------------------------------------------
-$ cd rtems-source-builder/bare
-$../source-builder/sb-set-builder --log=log_arm_eabihf \
- --prefix=$HOME/development/bare --target=arm-eabihf lang/gcc491
-RTEMS Source Builder - Set Builder, v0.3.0
-Build Set: lang/gcc491
-config: devel/expat-2.1.0-1.cfg
-package: expat-2.1.0-x86_64-apple-darwin13.2.0-1
-building: expat-2.1.0-x86_64-apple-darwin13.2.0-1
-config: devel/binutils-2.24-1.cfg
-package: arm-eabihf-binutils-2.24-1
-building: arm-eabihf-binutils-2.24-1
-config: devel/gcc-4.9.1-newlib-2.1.0-1.cfg
-package: arm-eabihf-gcc-4.9.1-newlib-2.1.0-1
-building: arm-eabihf-gcc-4.9.1-newlib-2.1.0-1
-config: devel/gdb-7.7-1.cfg
-package: arm-eabihf-gdb-7.7-1
-building: arm-eabihf-gdb-7.7-1
-installing: expat-2.1.0-x86_64-apple-darwin13.2.0-1 -> /Users/chris/development/bare
-installing: arm-eabihf-binutils-2.24-1 -> /Users/chris/development/bare
-installing: arm-eabihf-gcc-4.9.1-newlib-2.1.0-1 -> /Users/chris/development/bare
-installing: arm-eabihf-gdb-7.7-1 -> /Users/chris/development/bare
-cleaning: expat-2.1.0-x86_64-apple-darwin13.2.0-1
-cleaning: arm-eabihf-binutils-2.24-1
-cleaning: arm-eabihf-gcc-4.9.1-newlib-2.1.0-1
-cleaning: arm-eabihf-gdb-7.7-1
--------------------------------------------------------------
-
-RTEMS
-~~~~~
-
-The RTEMS Configurations found in the 'rtems' directory. The configurations are
-grouped by RTEMS version. In RTEMS the tools are specific to a specific version
-because of variations between Newlib and RTEMS. Restructuring in RTEMS and
-Newlib sometimes moves _libc_ functionality between these two parts and this
-makes existing tools incompatible with RTEMS.
-
-RTEMS allows architectures to have different tool versions and patches. The
-large number of architectures RTEMS supports can make it difficult to get a
-common stable version of all the packages. An architecture may require a recent
-GCC because an existing bug has been fixed, however the more recent version may
-have a bug in other architecture. Architecture specific patches should be
-limited to the architecture it relates to. The patch may fix a problem on the
-effect architecture however it could introduce a problem in another
-architecture. Limit exposure limits any possible crosstalk between
-architectures.
-
-RTEMS supports _stable_ and _unstable_. Stable configurations are fixed while
-unstable configurations are supporting using snapshots of user macros and
-reference release candidates or source extracted directly from version
-control. The stable build sets are referenced as +<version>/rtems-<arch>+ and
-include `autoconf` and `automake`.
-
-If you are building a released version of RTEMS the release RTEMS tar file will
-be downloaded and built as part of the build process. If you are building a
-tool set for use with the development branch of RTEMS, the development branch
-will be cloned directly from the RTEMS GIT repository and built.
-
-When building RTEMS within the RTEMS Source Builder it needs a suitable working
-`autoconf` and `automake`. These packages need to built and installed in their
-prefix in order for them to work. The RTEMS Source Builder installs all
-packages only after they have been built so if you host does not have a
-recent enough version of `autoconf` and `automake` you first need to build them
-and install them then build your tool set. The commands are:
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder --log=l-4.11-at.txt \
- --prefix=$HOME/development/rtems/4.11 4.11/rtems-autotools
-$ export PATH=~/development/rtems/4.11/bin:$PATH <1>
-$ ../source-builder/sb-set-builder --log=l-4.11-sparc.txt \
- --prefix=$HOME/development/rtems/4.11 4.11/rtems-sparc
--------------------------------------------------------------
-<1> Setting the path.
-
-TIP: If this is your first time building the tools and RTEMS it pays to add the
-`--dry-run` option. This will run through all the configuration files and if
-any checks fail you will see this quickly rather than waiting for until the
-build fails a check.
-
-To build snapshots for testing purposes you use the available macro maps
-passing them on the command line using the `--macros` option. For RTEMS these
-are held in `config/snapshots` directory. The following builds _newlib_ from
-CVS:
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder --log=l-4.11-sparc.txt \
- --prefix=$HOME/development/rtems/4.11 \
- --macros=snapshots/newlib-head.mc \
- 4.11/rtems-sparc
--------------------------------------------------------------
-
-and the following uses the version control heads for _binutils_, _gcc_,
-_newlib_, _gdb_ and _RTEMS_:
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder --log=l-heads-sparc.txt \
- --prefix=$HOME/development/rtems/4.11-head \
- --macros=snapshots/binutils-gcc-newlib-gdb-head.mc \
- 4.11/rtems-sparc
--------------------------------------------------------------
-
-Patches
-~~~~~~~
-
-Packages being built by the RSB need patches from time to time and the RSB
-supports patching upstream packages. The patches are held in a seperate
-directory called +patches+ relative to the configuration directory you are
-building. For example +%{\_topdir}/patches:%{\_sbdir}/patches+. Patches are
-declared in the configuration files in a similar manner to the package's source
-so please refer to the +%source+ documentation. Patches, like the source, are
-to be made publically available for configurations that live in the RSB package
-and are downloaded on demand.
-
-If a package has a patch management tool it is recommended you reference the
-package's patch management tools directly. If the RSB does not support the
-specific patch manage tool please contact the mailing list to see if support
-can be added.
-
-Patches for packages developed by the RTEMS project can be placed in the RTEMS
-Tools Git repository. The +tools+ directory in the repository has various
-places a patch can live. The tree is broken down in RTEMS releases and then
-tools within that release. If the package is not specific to any release the
-patch can be added closer to the top under the package's name. Patches to fix
-specific tool related issues for a specific architecture should be grouped
-under the specific architecture and only applied when building that
-architecture avoiding a patch breaking an uneffected architecture.
-
-Patches in the RTEMS Tools repository need to be submitted to the upstream
-project. It should not be a clearing house for patches that will not be
-accepted upstream.
-
-Patches are added to a component's name and in the +%prep:+ section the patches
-can be set up, meaning they are applied to source. The patches are applied in
-the order they are added. If there is a dependency make sure you order the
-patches correctly when you add them. You can add any number of patches and the
-RSB will handle them efficently.
-
-Patches can have options. These are added before the patch URL. If no options
-are provided the patch's setup default options are used.
-
-Patches can be declared in build set up files.
-
-This examples shows how to declare a patch for gdb in the +lm32+ architecture:
-
--------------------------------------------------------------
-%patch add <1> gdb <2> %{rtems_gdb_patches}/lm32/gdb-sim-lm32uart.diff <3>
--------------------------------------------------------------
-<1> The patch's +add+ command.
-<2> The group of patches this patch belongs too.
-<3> The patch's URL. It is downloaded from here.
-
-Patches require a checksum to avoid a warning. The +%hash+ directive can be
-used to add a checksum for a patch that is used to verify the patch:
-
--------------------------------------------------------------
-%hash md5 <1> gdb-sim-lm32uart.diff <2> 77d070878112783292461bd6e7db17fb <3>
--------------------------------------------------------------
-<1> The type of checksum, in the case an MD5 hash.
-<2> The patch file the checksum is for.
-<3> The MD5 hash.
-
-The patches are applied when a patch +setup+ command is issued in the +%prep:+
-section. All patches in the group are applied. To apply the GDB patch above
-use:
-
--------------------------------------------------------------
-%patch setup <1> gdb <2> -p1 <3>
--------------------------------------------------------------
-<1> The patch's +setup+ command.
-<2> The group of patches to apply.
-<3> The patch group's default options. If no option is given with the patch
-these options are used.
-
-Architecture specific patches live in the architecture build set file isolating
-the patch to that specific architecture. If a patch is common to a tool it
-resides in the RTEMS tools configuration file. Do not place patches for tools
-in the +source-builder/config+ template configuration files.
-
-To test a patch simply copy it to your local +patches+ directory. The RSB will
-see the patch is present and will not attempt to download it. Once you are
-happy with the patch submit it to the project and a core developer will review
-it and add it to the RTEMS Tools git repository.
-For example, to test a local patch for newlib, add the following two lines to
-the .cfg file in +rtems/config/tools/+ that is included by the bset you use:
--------------------------------------------------------------
-%patch add newlib file://0001-this-is-a-newlib-patch.patch <1>
-%hash md5 0001-this-is-a-newlib-patch.diff 77d070878112783292461bd6e7db17fb <2>
--------------------------------------------------------------
-<1> The diff file prepended with +file://+ to tell RSB this is a local file.
-<2> The output from md5sum on the diff file.
-
-Cross and Canadian Cross Building
----------------------------------
-
-Cross building and Canadian Cross building is the process of building on one
-machine an executable that runs on another machine. An example is building a
-set of RTEMS tools on Linux to run on Windows. The RSB supports cross building
-and Canadian cross building.
-
-This sections details how to the RSB to cross and Canadian cross build.
-
-Cross Building
-~~~~~~~~~~~~~~
-
-Cross building is where the _build_ machine and _host_ are different. The
-_build_ machine runs the RSB and the _host_ machine is where the output from
-the build runs. An example is building a package such as NTP for RTEMS on your
-development machine.
-
-To build the NTP package for RTEMS you enter the RSB command:
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder \
- --log=log_ntp_arm.txt \
- --prefix=$HOME/development/rtems/4.11 <1> \
- --host=arm-rtems4.11 <2> \
- --with-rtems-bsp=xilinx_zynq_zc706 <3> \
- 4.11/net/ntp
--------------------------------------------------------------
-<1> The tools and the RTEMS BSP are installed under the same prefix.
-<2> The +--host+ command is the RTEMS architecture and version.
-<3> The BSP is built and installed in the prefix. The arhcitecture must
- match the +--host+ architecture.
-
-TIP: If you install BSPs into a different path to the prefix use the
-+--with-tools+ option to specify the path to the tools. Do not add the 'bin'
-directory at the end of the path.
-
-Canadian Cross Building
-~~~~~~~~~~~~~~~~~~~~~~~
-
-A Canadian cross builds are where the _build_, _host_ and _target_ machines all
-differ. For example building an RTEMS compiler for an ARM processor that runs
-on Windows is built using a Linux machine. The process is controlled by setting
-the build triplet to the host you are building, the host triplet to the host
-the tools will run on and the target to the RTEMS architecture you require. The
-tools needed by the RSB are:
-
-. Build host C and C++ compiler
-. Host C and C++ cross compiler
-
-The RTEMS Source Builder requires you provide the build host C and C\++
-compiler and the final host C and C\++ cross-compiler. The RSB will build the
-build host RTEMS compiler and the final host RTEMS C and C++ compiler, the
-output of this process.
-
-The Host C and C++ compiler is a cross-compiler that builds executables for
-the host you want the tools for. You need to provide these tools. For Windows a
-number of Unix operating systems provide MinGW tool sets as packages.
-
-The RSB will build an RTEMS tool set for the build host. This is needed when
-building the final host's RTEMS compiler as it needs to build RTEMS runtime
-code such as _libc_ on the build host.
-
-TIP: Make sure the host's cross-compiler tools are in your path before run the
-RSB build command.
-
-TIP: Canadian Cross built tools will not run on the machine being used to build
-them so you should provide the +--bset-tar-files+ and +--no-install+
-options. The option to not install the files lets you provide a prefix that
-does not exist or you cannot access.
-
-To perform a cross build add +--host=+ to the command line. For example to
-build a MinGW tool set on FreeBSD for Windows add +--host=mingw32+ if the cross
-compiler is +mingw32-gcc+:
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder --host=mingw32 \
- --log=l-mingw32-4.11-sparc.txt \
- --prefix=$HOME/development/rtems/4.11 \
- 4.11/rtems-sparc
--------------------------------------------------------------
-
-If you are on a Linux Fedora build host with the MinGW packages installed the
-command line is:
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder --host=i686-w64-mingw32 \
- --log=l-mingw32-4.11-sparc.txt \
- --prefix=$HOME/development/rtems/4.11 \
- 4.11/rtems-sparc
--------------------------------------------------------------
-
-RTEMS 3rd Party Packages
-------------------------
-
-This section describes how to build and add an RTEMS 3rd party package to the
-RSB.
-
-A 3rd party package is a library or software package built to run on RTEMS,
-examples are NTP, Net-Snmp, libjpeg or Python. These pieces of software can be
-used to help build RTEMS applications. The package is built for a specific
-BSP and so requires a working RTEMS tool chain and an installed RTEMS Board
-Support Package (BSP).
-
-The RSB support for building 3rd part packages is based around the pkconfig
-files (PC) installed with the BSP. The pkgconfig support in RTEMS is considered
-experimental and can have some issues for some BSPs. This issue is rooted deep
-in the RTEMS build system. If you have any issues with this support please ask
-on the RTEMS developers mailing list.
-
-Building
-~~~~~~~~
-
-To build a package you need to have a suitable RTEMS tool chain and RTEMS BSP
-installed. The set builder command line requires you provide the tools path,
-the RTEMS host, and the prefix path to the installed RTEMS BSP. The prefix
-needs to be the same as the prefix used to build RTEMS.
-
-To build Net-SNMP the command is:
-
--------------------------------------------------------------
-cd rtems-source-builder/rtems
-$ ../source-builder/sb-set-builder --log=log_sis_net_snmp \
- --prefix=$HOME/development/rtems/bsps/4.11 \
- --with-tools=$HOME/development/rtems/4.11 \
- --host=sparc-rtems4.11 --with-rtems-bsp=sis 4.11/net-mgmt/net-snmp
-RTEMS Source Builder - Set Builder, v0.3.0
-Build Set: 4.11/net-mgmt/net-snmp
-config: net-mgmt/net-snmp-5.7.2.1-1.cfg
-package: net-snmp-5.7.2.1-sparc-rtems4.11-1
-building: net-snmp-5.7.2.1-sparc-rtems4.11-1
-installing: net-snmp-5.7.2.1-sparc-rtems4.11-1 -> /Users/chris/development/rtems/bsps/4.11
-cleaning: net-snmp-5.7.2.1-sparc-rtems4.11-1
-Build Set: Time 0:01:10.651926
--------------------------------------------------------------
-
-Adding
-~~~~~~
-
-Adding a package requires you first build it manually by downloading the source
-for the package and building it for RTEMS using the command line of a standard
-shell. If the package has not been ported to RTEMS you will need to port it and
-this may require you asking questions on the package's user or development
-support lists as well as RTEMS's developers list. Your porting effort may end
-up with a patch. RTEMS requires a patch be submitted upstream to the project's
-community as well as RTEMS so it can be added to the RTEMS Tools git
-repository. A patch in the RTEMS Tools git reposiitory can then be referenced
-by an RSB configuration file.
-
-A package may create executables, for example NTP normally creates executables
-such as +ntdp+, +ntpupdate+, or +ntpdc+. These executables can be useful when
-testing the package however they are of limited use by RTEMS users because they
-cannot be directly linked into a user application. Users need to link to the
-functions in these executables or even the executable as a function placed in
-libraries. If the package does not export the code in a suitable manner please
-contact the project's commuinity and see if you can work them to provide a way
-for the code to be exported. This may be difficult because exporting internal
-headers and functions opens the project up to API compatibility issues they did
-not have before. In the simplest case attempting to get the code into a static
-library with a single call entry point exported in a header would give RTEMS
-user's access to the package's main functionality.
-
-A package requires 3 files to be created:
-
-. The first file is the RTEMS build set file and it resides in the
- +$$rtems/config/%{rtems_version}$$+ path in a directory tree based on the
- FreeBSD ports collection. For the NTP package and RTEMS 4.11 this is
- +rtems/config/4.11/net/ntp.bset+. If you do not know the FreeBSD port path
- for the package you are adding please ask. The build set file references a
- specific configuration file therefore linking the RTEMS version to a specific
- version of the package you are adding. Updating the package to a new version
- requires changing the build set to the new configuration file.
-
-. The second file is an RTEMS version specific configuration file and it
- includes the RSB RTEMS BSP support. These configuration files reside in the
- +rtems/config+ tree again under the FreeBSD port's path name. For example the
- NTP package is found in the +net+ directory of the FreeBSD ports tree so the
- NTP configuration path is +$$rtems/config/net/ntp-4.2.6p5-1.cfg$$+ for that
- specific version. The configuration file name typically provides version
- specific references and the RTEMS build set file references a specific
- version. This configuration file references the build configuration file held
- in the common configuration file tree.
-
-. The build configuration. This is a common script that builds the package. It
- resides in the +source-builder/config+ directory and typically has the
- packages's name with the major version number. If the build script does not
- change for each major version number a _common_ base script can be created
- and included by each major version configuration script. The _gcc_ compiler
- configuration is an example. This approach lets you branch a version if
- something changes that is not backwards compatible. It is important to keep
- existing versions building. The build configuration should be able to build a
- package for the build host as well as RTEMS as the RSB abstracts the RTEMS
- specific parts. See <<H1,+_Configuration_+>> for more details.
-
-BSP Support
-~~~~~~~~~~~
-
-The RSB provides support to help build packages for RTEMS. RTEMS applications
-can be viewed as statically linked executables operating in a single address
-space. As a result only the static libraries a package builds are required and
-these libraries need to be ABI compatible with the RTEMS kernel and application
-code meaning compiler ABI flags cannot be mixed when building code. The 3rd
-party package need to use the same compiler flags as the BSP used to build
-RTEMS.
-
-[TIP]
-=============================================================
-
-RTEMS's dynamic loading support does not use the standard shared library
-support found in Unix and the ELF standard. RTEMS's loader uses static
-libraries and the runtime link editor performs a similar function to a host
-based static linker. RTEMS will only reference static libraries even if dynamic
-libraries are created and installed.
-
-=============================================================
-
-The RSB provides the configuration file +rtems/config/rtems-bsp.cfg+ to support
-building 3rd party packages and you need to include this file in your RTEMS
-version specific configuration file. For example the Net-SNMP configuration
-file:
-
-.rtems/config/net-mgmt/net-snmp-5.7.2.1-1.cfg
--------------------------------------------------------------
-#
-# NetSNMP 5.7.2.1
-#
-
-%if %{release} == %{nil}
- %define release 1 <1>
-%endif
-
-%include %{_configdir}/rtems-bsp.cfg <2>
-
-#
-# NetSNMP Version
-#
-%define net_snmp_version 5.7.2.1 <3>
-
-#
-# We need some special flags to build this version.
-#
-%define net_snmp_cflags <4> -DNETSNMP_CAN_USE_SYSCTL=1 -DARP_SCAN_FOUR_ARGUMENTS=1 -DINP_IPV6=0
-
-#
-# Patch for RTEMS support.
-#
-%patch add net-snmp %{rtems_git_tools}/net-snmp/rtems-net-snmp-5.7.2.1-20140623.patch <5>
-
-#
-# NetSNMP Build configuration
-#
-%include %{_configdir}/net-snmp-5-1.cfg <6>
--------------------------------------------------------------
-<1> The release number.
-<2> Include the RSB RTEMS BSP support.
-<3> The Net-SNMP package's version.
-<4> Add specific CFLAGS to the build process. See the +net-snmp-5.7.2.1-1.cfg+
- for details.
-<5> The RTEMS Net-SNMP patch downloaded from the RTEMS Tools git repo.
-<6> The Net-SNMP standard build configuration.
-
-The RSB RTEMS BSP support file +rtems/config/rtems-bsp.cfg+ checks to make sure
-standard command line options are provided. These include `--host` and
-`--with-rtems-bsp`. If the `--with-tools` command line option is not given the
-+${\_prefix}+ is used.
-
-.rtems/config/rtems-bsp.cfg
--------------------------------------------------------------
-%if %{_host} == %{nil} <1>
- %error No RTEMS target specified: --host=host
-%endif
-
-%ifn %{defined with_rtems_bsp} <2>
- %error No RTEMS BSP specified: --with-rtems-bsp=bsp
-%endif
-
-%ifn %{defined with_tools} <3>
- %define with_tools %{_prefix}
-%endif
-
-#
-# Set the path to the tools.
-#
-%{path prepend %{with_tools}/bin} <4>
--------------------------------------------------------------
-<1> Check the host has been set.
-<2> Check a BSP has been specified.
-<3> If no tools path has been provided assume they are under the %{\_prefix}.
-<4> Add the tools +bin+ path to the system path.
-
-RTEMS exports the build flags used in pkgconfig (.pc) files and the RSB can
-read and manage them even when there is no pkgconfig support installed on your
-build machine. Using this support we can obtain a BSP's configuration and set
-some standard macros variables:
-
-.rtems/config/rtems-bsp.cfg
--------------------------------------------------------------
-%{pkgconfig prefix %{_prefix}/lib/pkgconfig} <1>
-%{pkgconfig crosscompile yes} <2>
-%{pkgconfig filter-flags yes} <3>
-
-#
-# The RTEMS BSP Flags
-#
-%define rtems_bsp %{with_rtems_bsp}
-%define rtems_bsp_ccflags %{pkgconfig ccflags %{_host}-%{rtems_bsp}} <4>
-%define rtems_bsp_cflags %{pkgconfig cflags %{_host}-%{rtems_bsp}}
-%define rtems_bsp_ldflags %{pkgconfig ldflags %{_host}-%{rtems_bsp}}
-%define rtems_bsp_libs %{pkgconfig libs %{_host}-%{rtems_bsp}}
--------------------------------------------------------------
-<1> Set the path to the BSP's pkgconfig file.
-<2> Let pkgconfig know this is a cross-compile build.
-<3> Filter flags such as warnings. Warning flags are specific to a package.
-<4> Ask pkgconfig for the various items we require.
-
-The flags obtain by pkgconfig and given a `rtems_bsp_` prefix and we uses these
-to set the RSB host support CFLAGS, LDFLAGS and LIBS flags. When we build a 3rd
-party library your host computer is the _build_ machine and RTEMS is the _host_
-machine therefore we set the `host` variables:
-
-.rtems/config/rtems-bsp.cfg
--------------------------------------------------------------
-%define host_cflags %{rtems_bsp_cflags}
-%define host_ldflags %{rtems_bsp_ldflags}
-%define host_libs %{rtems_bsp_libs}
--------------------------------------------------------------
-
-Finally we provide all the paths you may require when configuring a
-package. Packages by default consider the `_prefix` the base and install
-various files under this tree. The package you are building is specific to a
-BSP and so needs to install into the specific BSP path under the
-`_prefix`. This allows more than BSP build of this package to be install under
-the same `_prefix` at the same time:
-
-.rtems/config/rtems-bsp.cfg
--------------------------------------------------------------
-%define rtems_bsp_prefix %{_prefix}/%{_host}/%{rtems_bsp} <1>
-%define _exec_prefix %{rtems_bsp_prefix}
-%define _bindir %{_exec_prefix}/bin
-%define _sbindir %{_exec_prefix}/sbin
-%define _libexecdir %{_exec_prefix}/libexec
-%define _datarootdir %{_exec_prefix}/share
-%define _datadir %{_datarootdir}
-%define _sysconfdir %{_exec_prefix}/etc
-%define _sharedstatedir %{_exec_prefix}/com
-%define _localstatedir %{_exec_prefix}/var
-%define _includedir %{_libdir}/include
-%define _lib lib
-%define _libdir %{_exec_prefix}/%{_lib}
-%define _libexecdir %{_exec_prefix}/libexec
-%define _mandir %{_datarootdir}/man
-%define _infodir %{_datarootdir}/info
-%define _localedir %{_datarootdir}/locale
-%define _localedir %{_datadir}/locale
-%define _localstatedir %{_exec_prefix}/var
--------------------------------------------------------------
-<1> The path to the BSP.
-
-When you configure a package you can reference these paths and the RSB will
-provide sensible default or in this case map them to the BSP:
-
-.source-builder/config/ntp-4-1.cfg
--------------------------------------------------------------
- ../${source_dir_ntp}/configure \ <1>
- --host=%{_host} \
- --prefix=%{_prefix} \
- --bindir=%{_bindir} \
- --exec_prefix=%{_exec_prefix} \
- --includedir=%{_includedir} \
- --libdir=%{_libdir} \
- --libexecdir=%{_libexecdir} \
- --mandir=%{_mandir} \
- --infodir=%{_infodir} \
- --datadir=%{_datadir} \
- --disable-ipv6 \
- --disable-HOPFPCI
--------------------------------------------------------------
-<1> The configure command for NTP.
-
-RTEMS BSP Configuration
-~~~~~~~~~~~~~~~~~~~~~~~
-
-To build a package for RTEMS you need to build it with the matching BSP
-configuration. A BSP can be built with specific flags that require all code
-being used needs to be built with the same flags.
-
-
-[[H1]]
-Configuration
--------------
-
-The RTEMS Source Builder has two types of configuration data:
-
-. Build Sets
-. Package Build Configurations
-
-By default these files can be located in two separate directories and
-searched. The first directory is +config+ in your current working directory
-(+_topdir+) and the second is +config+ located in the base directory of the
-RTEMS Source Builder command you run (+_sbdir+). The RTEMS directory +rtems+
-located at the top of the RTEMS Source Builder source code is an example of a
-specific build configuration directory. You can create custom or private build
-configurations and if you run the RTEMS Source Builder command from that
-directory your configurations will be used.
-
-[[X1]] The configuration search path is a macro variable and is reference as
-+%\{_configdir\}+. It's default is defined as:
-
--------------------------------------------------------------
-_configdir : dir optional<2> %{_topdir}/config:%{_sbdir}/config <1>
--------------------------------------------------------------
-
-<1> The +_topdir+ is the directory you run the command from and +_sbdir+ is the
-location of the RTEMS Source Builder command.
-<2> A macro definition in a macro file has 4 fields, the label, type,
-constraint and the definition.
-
-Build set files have the file extension +.bset+ and the package build
-configuration files have the file extension of +.cfg+. The +sb-set-builder+
-command will search for _build sets_ and the +sb-builder+ commands works with
-package build configuration files.
-
-Both types of configuration files use the \'#' character as a comment
-character. Anything after this character on the line is ignored. There is no
-block comment.
-
-Source and Patches
-~~~~~~~~~~~~~~~~~~
-
-The RTEMS Source Builder provides a flexible way to manage source. Source and
-patches are declare in configurations file using the +source+ and +patch+
-directives. These are a single line containing a Universal Resource Location or
-URL and can contain macros and shell expansions. The <<_prep,%prep>> section
-details the source and patch directives
-
-The URL can reference remote and local source and patch resources. The
-following schemes are provided:
-
-'http':: Remote access using the HTTP protocol.
-'https':: Remote access using the Secure HTTP protocol.
-'ftp':: Remote access using the FTP protocol.
-'git':: Remote access to a GIT repository.
-'cvs':: Remote access to a CVS repository.
-'pm':: Remote access to a patch management repository.
-'file':: Local access to an existing source directory.
-
-HTTP, HTTPS, and FTP
-^^^^^^^^^^^^^^^^^^^^
-
-Remote access to TAR or ZIP files is provided using HTTP, HTTPS and FTP
-protocols. The full URL provided is used to access the remote file including
-any query components. The URL is parsed to extract the file component and the
-local source directory is checked for that file. If the file is located locally
-the remote file is not downloaded. Currently no other checks are made. If a
-download fails you need to manually remove the file from the source directory
-and start the build process again.
-
-The URL can contain macros. These are expanded before issuing the request to
-download the file. The standard GNU GCC compiler source URL is:
-
--------------------------------------------------------------
-%source set<1> gcc<2> ftp://ftp.gnu.org/gnu/gcc/gcc-%{gcc_version}/gcc-%{gcc_version}.tar.bz2
--------------------------------------------------------------
-<1> The +%source+ command's set command sets the source. The first is set and
-following sets are ignored.
-<2> The source is part of the +gcc+ group.
-
-The type of compression is automatically detected from the file extension. The
-supported compression formats are:
-
-'gz':: GNU ZIP
-'bzip2':: BZIP2
-'zip':: ZIP
-'xy':: XY
-
-The output of the decompression tool is feed to the standard `tar` utility if
-not a ZIP file and unpacked into the build directory. ZIP files are unpacked by
-the decompression tool and all other files must be in the tar file format.
-
-The +%source+ directive typically supports a single source file tar or zip
-file. The +set+ command is used to set the URL for a specific source group. The
-first set command encoutner is registered and any further set commands are
-ignored. This allows you to define a base standard source location and override
-it in build and architecture specific files. You can also add extra source
-files to a group. This is typically done when a collection of source is broken
-down in a number of smaller files and you require the full package. The
-source's +setup+ command must reide in the +%prep:+ section and it unpacks the
-source code ready to be built.
-
-If the source URL references the GitHub API server 'https://api.github.com/' a
-tarball of the specified version is download. For example the URL for the
-STLINK project on GitHub and version is:
-
--------------------------------------------------------------
-%define stlink_version 3494c11
-%source set stlink https://api.github.com/repos/texane/stlink/texane-stlink-%{stlink_version}.tar.gz
--------------------------------------------------------------
-
-GIT
-^^^
-
-A GIT repository can be cloned and used as source. The GIT repository resides
-in the 'source' directory under the `git` directory. You can edit, update and
-use the repository as you normally do and the results will used to build the
-tools. This allows you to prepare and test patches in the build environment the
-tools are built in. The GIT URL only supports the GIT protocol. You can control
-the repository via the URL by appending options and arguments to the GIT
-path. The options are delimited by `?` and option arguments are delimited from
-the options with `=`. The options are:
-
-`protocol`:: Use a specific protocol. The supported values are _ssh_, _git_,
-_http_, _https_, _ftp_, _ftps_, _rsync_, and _none_.
-`branch`:: Checkout the specified branch.
-`pull`:: Perform a pull to update the repository.
-`fetch`:: Perform a fetch to get any remote updates.
-`reset`:: Reset the repository. Useful to remove any local changes. You can
-pass the `hard` argument to force a hard reset.
-
--------------------------------------------------------------
-%source set gcc git://gcc.gnu.org/git/gcc.git?branch=gcc-4_7-branch?reset=hard
--------------------------------------------------------------
-
-This will clone the GCC git repository and checkout the 4.7-branch and perform
-a hard reset. You can select specific branches and apply patches. The
-repository is cleaned up before each build to avoid various version control
-errors that can arise.
-
-The protocol option lets you set a specific protocol. The 'git://' prefix used
-by the RSB to select a git repository can be removed using _none_ or replaced
-with one of the standard git protcols.
-
-CVS
-^^^
-
-A CVS repository can be checked out. CVS is more complex than GIT to handle
-because of the modules support. This can effect the paths the source ends up
-in. The CVS URL only supports the CVS protocol. You can control the repository
-via the URL by appending options and arguments to the CVS path. The options are
-delimited by `?` and option arguments are delimited from the options with
-`=`. The options are:
-
-`module`:: The module to checkout.
-`src-prefix`:: The path into the source where the module starts.
-`tag`:: The CVS tag to checkout.
-`date`:: The CVS date to checkout.
-
--------------------------------------------------------------
-%source set newlib cvs://pserver:anoncvs@sourceware.org/cvs/src?module=newlib?src-prefix=src
--------------------------------------------------------------
-
-Macros and Defaults
-~~~~~~~~~~~~~~~~~~~
-
-The RTEMS Source Builder uses tables of _macros_ read in when the tool
-runs. The initial global set of macros is called the _defaults_. These values
-are read from a file called `defaults.mc` and modified to suite your host. This
-host specific adaption lets the Source Builder handle differences in the build
-hosts.
-
-Build set and configuration files can define new values updating and extending
-the global macro table. For example builds are given a release number. This is
-typically a single number at the end of the package name. For example:
-
--------------------------------------------------------------
-%define release 1
--------------------------------------------------------------
-
-Once defined if can be accessed in a build set or package configuration file
-with:
-
--------------------------------------------------------------
-%{release}
--------------------------------------------------------------
-
-The +sb-defaults+ command lists the defaults for your host. I will not include
-the output of this command because of its size.
-
--------------------------------------------------------------
-$ ../source-builder/sb-defaults
--------------------------------------------------------------
-
-A nested build set is given a separate copy of the global macro maps. Changes
-in one change set are not seen in other build sets. That same happens with
-configuration files unless inline includes are used. Inline includes are seen
-as part of the same build set and configuration and changes are global to that
-build set and configuration.
-
-Macro Maps and Files
-^^^^^^^^^^^^^^^^^^^^
-
-Macros are read in from files when the tool starts. The default settings are
-read from the defaults macro file called `defaults.mc` located in the top level
-RTEMS Source Builder command directory. User macros can be read in at start up
-by using the `--macros` command line option.
-
-The format for a macro in macro files is:
-
-[options="header,compact",width="50%",cols="15%,15%,15%,55%"]
-|=================================
-| Name | Type | Attribute | String
-|=================================
-
-where 'Name' is a case insensitive macro name, the 'Type' field is:
-
-[horizontal]
-`none`:: Nothing, ignore.
-`dir`:: A directory path.
-`exe`:: An executable path.
-`triplet`:: A GNU style architecture, platform, operating system string.
-
-the 'Attribute' field is:
-
-[horizontal]
-`none`:: Nothing, ignore
-`required`:: The host check must find the executable or path.
-`optional`:: The host check generates a warning if not found.
-`override`:: Only valid outside of the `global` map to indicate this macro
- overrides the same one in the `global` map when the map containing
- it is selected.
-`undefine`:: Only valid outside of the `global` map to undefine the macro if it
- exists in the `global` map when the map containing it is
- selected. The `global` map's macro is not visible but still
- exists.
-
-and the 'String' field is a single or tripled multiline quoted string. The
-'String' can contain references to other macros. Macro that loop are not
-currently detected and will cause the tool to lock up.
-
-Maps are declared anywhere in the map using the map directive:
-
--------------------------------------------------------------
-# Comments
-[my-special-map] <1>
-_host: none, override, 'abc-xyz'
-multiline: none, override, '''First line,
-second line,
-and finally the last line'''
--------------------------------------------------------------
-<1> The map is set to `my-special-map`.
-
-Any macro defintions following a map declaration are placed in that map and the
-default map is `global` when loading a file. Maps are selected in configuration
-files by using the `%select` directive.
-
--------------------------------------------------------------
-%select my-special-map
--------------------------------------------------------------
-
-Selecting a map means all requests for a macro first check the selected map and
-if present return that value else the `global` map is used. Any new macros or
-changes update only the `global` map. This may change in future releases so
-please make sure you use the `override` attribute.
-
-The macro files specificed on the command line are looked for in the
-`_configdir` paths. See <<X1,+_configdir+>> variable for details. Included
-files need to add the `%{_configdir}` macro to the start of the file.
-
-Macro map files can include other macro map files using the `%include`
-directive. The macro map to build _binutils_, _gcc_, _newlib_, _gdb_ and
-_RTEMS_ from version control heads is:
-
--------------------------------------------------------------
-# <1>
-# Build all tool parts from version control head.
-#
-%include %{_configdir}/snapshots/binutils-head.mc
-%include %{_configdir}/snapshots/gcc-head.mc
-%include %{_configdir}/snapshots/newlib-head.mc
-%include %{_configdir}/snapshots/gdb-head.mc
--------------------------------------------------------------
-<1> The file is `config/snapshots/binutils-gcc-newlib-gdb-head.mc`.
-
-The macro map defaults to `global` at the start of each included file and the
-map setting of the macro file including the other macro files does not change.
-
-Personal Macros
-^^^^^^^^^^^^^^^
-
-When the tools start to run they will load personal macros. Personal macros are
-in the standard format for macros in a file. There are two places personal
-macros can be configured. The first is the environment variable
-`RSB_MACROS`. If present the macros from the file the environment variable
-points to are loaded. The second is a file called `.rsb_macros` in your home
-directory. You need to have the environment variable `HOME` defined for this
-work.
-
-Report Mailing
-~~~~~~~~~~~~~~
-
-The build reports can be mailed to a specific email address to logging and
-monitoring. Mailing requires a number of parameters to function. These are:
-
-. To mail address
-. From mail address
-. SMTP host
-
-.To Mail Address
-
-The +to+ mail address is taken from the macro `%{_mail_tools_to}` and the
-default is _rtems-tooltestresults at rtems.org_. You can override the default
-with a personal or user macro file or via the command line option _--mail-to_.
-
-.From Mail Address
-
-The +from+ mail address is taken from:
-
-. GIT configuration
-. User `.mailrc` file
-. Command line
-
-If you have configured an email and name in git it will be used used. If you do
-not a check is made for a `.mailrc` file. The environment variable _MAILRC_ is
-used if present else your home directory is check. If found the file is scanned
-for the `from` setting:
-
- set from="Foo Bar <foo@bar>"
-
-You can also support a from address on the command line with the _--mail-from_
-option.
-
-.SMTP Host
-
-The SMTP host is taken from the macro `%{_mail_smtp_host}` and the default is
-`localhost`. You can override the default with a personal or user macro file or
-via the command line option _--smtp-host_.
-
-Build Set Files
-~~~~~~~~~~~~~~~
-
-Build set files lets you list the packages in the build set you are defining
-and have a file extension of +.bset+. Build sets can define macro variables,
-inline include other files and reference other build set or package
-configuration files.
-
-Defining macros is performed with the +%define+ macro:
-
--------------------------------------------------------------
-%define _target m32r-rtems4.11
--------------------------------------------------------------
-
-Inline including another file with the +%include+ macro continues processing
-with the specified file returning to carry on from just after the include
-point.
-
--------------------------------------------------------------
-%include rtems-4.11-base.bset
--------------------------------------------------------------
-
-This includes the RTEMS 4.11 base set of defines and checks. The configuration
-paths as defined by +_configdir+ are scanned. The file extension is optional.
-
-You reference build set or package configuration files by placing the file name
-on a single line.
-
--------------------------------------------------------------
-tools/rtems-binutils-2.22-1
--------------------------------------------------------------
-
-The +_configdir+ path is scanned for +tools/rtems-binutils-2.22-1.bset+ or
-+tools/rtems-binutils-2.22-1.cfg+. Build set files take precedent over package
-configuration files. If +tools/rtems-binutils-2.22-1+ is a build set a new
-instance of the build set processor is created and if the file is a package
-configuration the package is built with the package builder. This all happens
-once the build set file has finished being scanned.
-
-Configuration Control
-~~~~~~~~~~~~~~~~~~~~~
-
-The RTEMS Souce Builder is designed to fit within most verification and
-validation processes. All of the RTEMS Source Builder is source code. The
-Python code is source and comes with a commercial friendly license. All
-configuration data is text and can be read or parsed with standard text based
-tools.
-
-File naming provides configuration management. A specific version of a package
-is captured in a specific set of configuration files. The top level
-configuration file referenced in a _build set_ or passed to the +sb-builder+
-command relates to a specific configuration of the package being built. For
-example the RTEMS configuration file +rtems-gcc-4.7.2-newlib-2.0.0-1.cfg+
-creates an RTEMS GCC and Newlib package where the GCC version is 4.7.2, the
-Newlib version is 2.0.0, plus any RTEMS specific patches that related to this
-version. The configuration defines the version numbers of the various parts
-that make up this package:
-
--------------------------------------------------------------
-%define gcc_version 4.7.2
-%define newlib_version 2.0.0
-%define mpfr_version 3.0.1
-%define mpc_version 0.8.2
-%define gmp_version 5.0.5
--------------------------------------------------------------
-
-The package build options, if there are any are also defined:
-
--------------------------------------------------------------
-%define with_threads 1
-%define with_plugin 0
-%define with_iconv 1
--------------------------------------------------------------
-
-The generic configuration may provide defaults in case options are not
-specified. The patches this specific version of the package requires can be
-included:
-
--------------------------------------------------------------
-Patch0: gcc-4.7.2-rtems4.11-20121026.diff
--------------------------------------------------------------
-
-Finally including the GCC 4.7 configuration script:
-
--------------------------------------------------------------
-%include %{_configdir}/gcc-4.7-1.cfg
--------------------------------------------------------------
-
-The +gcc-4.7-1.cfg+ file is a generic script to build a GCC 4.7 compiler with
-Newlib. It is not specific to RTEMS. A bare no operating system tool set can be
-built with this file.
-
-The +-1+ part of the file names is a revision. The GCC 4.7 script maybe revised
-to fix a problem and if this fix effects an existing script the file is copied
-and given a +-2+ revision number. Any dependent scripts referencing the earlier
-revision number will not be effected by the change. This locks down a specific
-configuration over time.
-
-Personal Configurations
-~~~~~~~~~~~~~~~~~~~~~~~
-
-The RSB supports personal configurations. You can view the RTEMS support in the
-+rtems+ directory as a private configuration tree that resides within the RSB
-source. There is also the +bare+ set of configurations. You can create your own
-configurations away from the RSB source tree yet use all that the RSB provides.
-
-To create a private configuration change to a suitable directory:
-
--------------------------------------------------------------
-$ cd ~/work
-$ mkdir test
-$ cd test
-$ mkdir config
--------------------------------------------------------------
-
-and create a +config+ directory. Here you can add a new configuration or build
-set file. The section 'Adding New Configurations' details how to add a new
-confguration.
-
-New Configurations
-~~~~~~~~~~~~~~~~~~
-
-This section describes how to add a new configuration to the RSB. We will add a
-configuration to build the Device Tree Compiler. The Device Tree Compiler or
-DTC is part of the Flattened Device Tree project and compiles Device Tree
-Source (DTS) files into Device Tree Blobs (DTB). DTB files can be loaded by
-operating systems and used to locate the various resources such as base
-addresses of devices or interrupt numbers allocated to devices. The Device Tree
-Compiler source code can be downloaded from http://www.jdl.com/software. The
-DTC is supported in the RSB and you can find the configuration files under the
-+bare/config+ tree. I suggest you have a brief look over these files.
-
-Layering by Including
-^^^^^^^^^^^^^^^^^^^^^
-
-Configurations can be layered using the +%include+ directive. The user invokes
-the outer layers which include inner layers until all the required
-configuration is present and the package can be built. The outer layers can
-provide high level details such as the version and the release and the inner
-layers provide generic configuration details that do not change from one
-release to another. Macro variables are used to provide the specific
-configuration details.
-
-Configuration File Numbering
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Configuration files have a number at the end. This is a release number for that
-configuration and it gives us the ability to track a specific configuration for
-a specific version. For example lets say the developers of the DTC package
-change the build system from a single makefile to autoconf and automake between
-version 1.3.0 and version 1.4.0. The configuration file used to build the
-package would change have to change. If we did not number the configuration
-files the ability to build 1.1.0, 1.2.0 or 1.3.0 would be lost if we update a
-common configuration file to build an autoconf and automake version. For
-version 1.2.0 the same build script can be used so we can share the same
-configuration file between version 1.1.0 and version 1.2.0. An update to any
-previous release lets us still build the package.
-
-Common Configuration Scripts
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Common configuration scripts that are independent of version, platform and
-architecture are useful to everyone. These live in the Source Builder's
-configuration directory. Currently there are scripts to build binutils, expat,
-DTC, GCC, GDB and libusb. These files contain the recipes to build these
-package without the specific details of the versions or patches being
-built. They expect to be wrapped by a configuration file that ties the package
-to a specific version and optionally specific patches.
-
-DTC Example
-^^^^^^^^^^^
-
-We will be building the DTC for your host rather than a package for RTEMS. We
-will create a file called +source-builder/config/dtc-1-1.cfg+. This is a common
-script that can be used to build a specific version using a general recipe. The
-file name is 'dtc-1-1.cfg' where the 'cfg' extension indicates this is a
-configuration file. The first *1* says this is for the major release 1 of the
-package and the last *1* is the build configuration version.
-
-The file starts with some comments that detail the configuration. If there is
-anything unusual about the configuration it is a good idea to add something in
-the comments here. The comments are followed by a check for the release. In
-this case if a release is not provided a default of 1 is used.
-
--------------------------------------------------------------
-#
-# DTC 1.x.x Version 1.
-#
-# This configuration file configure's, make's and install's DTC.
-#
-
-%if %{release} == %{nil}
-%define release 1
-%endif
--------------------------------------------------------------
-
-The next section defines some information about the package. It does not effect
-the build and is used to annotate the reports. It is recommended this
-information is kept updated and accurate.
-
--------------------------------------------------------------
-Name: dtc-%{dtc_version}-%{_host}-%{release}
-Summary: Device Tree Compiler v%{dtc_version} for target %{_target} on host %{_host}
-Version: %{dtc_version}
-Release: %{release}
-URL: http://www.jdl.com/software/
-BuildRoot: %{_tmppath}/%{name}-root-%(%{__id_u} -n)
--------------------------------------------------------------
-
-The next section defines the source and any patches. In this case there is a
-single source package and it can be downloaded using the HTTP protocol. The RSB
-knows this is GZip'ped tar file. If more than one package package is needed add
-them increasing the index. The +gcc-4.8-1.cfg+ configuration contains examples
-of more than one source package as well as conditionally including source
-packages based on the outer configuration options.
-
--------------------------------------------------------------
-#
-# Source
-#
-%source set dtc http://www.jdl.com/software/dtc-v%{dtc_version}.tgz
--------------------------------------------------------------
-
-The remainder of the script is broken in to the various phases of a build. They
-are:
-
-. Preperation
-. Bulding
-. Installing, and
-. Cleaning
-
-Preparation is the unpacking of the source, applying any patches as well as any
-package specific set ups. This part of the script is a standard Unix shell
-script. Be careful with the use of '%' and '$'. The RSB uses '%' while the
-shell scripts use '$'.
-
-A standard pattern you will observe is the saving of the build's top
-directory. This is used instead of changing into a subdirectory and then
-changing to the parent when finished. Some hosts will change in a subdirectory
-that is a link however changing to the parent does not change back to the
-parent of the link rather it changes to the parent of the target of the link
-and that is something the RSB nor you can track easily. The RSB configuration
-script's are a collection of various subtle issues so please ask if you are
-unsure why something is being done a particular way.
-
-The preparation phase will often include source and patch setup commands. Outer
-layers can set the source package and add patches as needed while being able to
-use a common recipe for the build. Users can override the standard build and
-supply a custom patch for testing using the user macro command line interface.
-
--------------------------------------------------------------
-#
-# Prepare the source code.
-#
-%prep
- build_top=$(pwd)
-
- %source setup dtc -q -n dtc-v%{dtc_version}
- %patch setup dtc -p1
-
- cd ${build_top}
--------------------------------------------------------------
-
-The configuration file 'gcc-common-1.cfg' is a complex example of source
-preparation. It contains a number of source packages and patches and it
-combines these into a single source tree for building. It uses links to map
-source into the GCC source tree so GCC can be built using the _single source
-tree_ method. It also shows how to fetch source code from version
-control. Newlib is taken directly from its CVS repository.
-
-Next is the building phase and for the DTC example this is simply a matter of
-running +make+. Note the use of the RSB macros for commands. In the case of
-'%{\__make}' it maps to the correct make for your host. In the case of BSD
-systems we need to use the GNU make and not the GNU make.
-
-If your package requires a configuration stage you need to run this before the
-make stage. Again the GCC common configuration file provides a detailed example.
-
--------------------------------------------------------------
-%build
- build_top=$(pwd)
-
- cd dtc-v%{dtc_version}
-
- %{build_build_flags}
-
- %{__make} PREFIX=%{_prefix}
-
- cd ${build_top}
--------------------------------------------------------------
-
-You can invoke make with the macro '%{?_smp_flags}' as a command line
-argument. This macro is controlled by the '--jobs' command line option and the
-host CPU detection support in the RSB. If you are on a multicore host you can
-increase the build speed using this macro. It also lets you disabled building on
-multicores to aid debugging when testing.
-
-Next is the install phase. This phase is a little more complex because you may
-be building a tar file and the end result of the build is never actually
-installed into the prefix on the build host and you may not even have
-permissions to perform a real install. Most packages install to the +prefix+
-and the prefix is typically supplied via the command to the RSB or the
-package's default is used. The default can vary depending on the host's
-operating system. To install to a path that is not the prefix the +DESTDIR+
-make variable is used. Most packages should honour the +DISTDIR+ make variables
-and you can typically specify it on the command line to make when invoking the
-install target. This results in the package being installed to a location that
-is not the prefix but one you can control. The RSB provides a shell variable
-called +SB_BUILD_ROOT+ you can use. In a build set where you are building a
-number of packages you can collect all the built packages in a single tree that
-is captured in the tar file.
-
-Also note the use of the macro +%{\__rmdir}+. The use of these macros allow the
-RSB to vary specific commands based on the host. This can help on hosts like
-Windows where bugs can effect the standard commands such as 'rm'. There are
-many many macros to help you. You can find these listed in the +defaults.mc+
-file and in the trace output. If you are new to creating and editing
-configurations learning these can take a little time.
-
--------------------------------------------------------------
-%install
- build_top=$(pwd)
-
- %{__rmdir} -rf $SB_BUILD_ROOT
-
- cd dtc-v%{dtc_version}
- %{__make} DESTDIR=$SB_BUILD_ROOT PREFIX=%{_prefix} install
-
- cd ${build_top}
--------------------------------------------------------------
-
-Finally there is an optional clean section. The RSB will run this section if
-+--no-clean+ has not been provided on the command line. The RSB does clean up
-for you.
-
-Once we have the configuration files we can execute the build using the
-`sb-builder` command. The command will perform the build and create a tar file
-in the +tar+ directory.
-
--------------------------------------------------------------
-$ ../source-builder/sb-builder --prefix=/usr/local \
- --log=log_dtc devel/dtc-1.2.0
-RTEMS Source Builder, Package Builder v0.2.0
-config: devel/dtc-1.2.0
-package: dtc-1.2.0-x86_64-freebsd9.1-1
-download: http://www.jdl.com/software/dtc-v1.2.0.tgz -> sources/dtc-v1.2.0.tgz
-building: dtc-1.2.0-x86_64-freebsd9.1-1
-$ ls tar
-dtc-1.2.0-x86_64-freebsd9.1-1.tar.bz2
--------------------------------------------------------------
-
-If you want to have the package installed automatically you need to create a
-build set. A build set can build one or more packages from their configurations
-at once to create a single package. For example the GNU tools is typically seen
-as binutils, GCC and GDB and a build set will build each of these packages and
-create a single build set tar file or install the tools on the host into the
-prefix path.
-
-The DTC build set file is called +dtc.bset+ and contains:
-
--------------------------------------------------------------
-#
-# Build the DTC.
-#
-
-%define release 1
-
-devel/dtc-1.2.0.cfg
--------------------------------------------------------------
-
-To build this you can use something similar to:
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder --prefix=/usr/local --log=log_dtc \
- --trace --bset-tar-file --no-install dtc
-RTEMS Source Builder - Set Builder, v0.2.0
-Build Set: dtc
-config: devel/dtc-1.2.0.cfg
-package: dtc-1.2.0-x86_64-freebsd9.1-1
-building: dtc-1.2.0-x86_64-freebsd9.1-1
-tarball: tar/x86_64-freebsd9.1-dtc-set.tar.bz2
-cleaning: dtc-1.2.0-x86_64-freebsd9.1-1
-Build Set: Time 0:00:02.865758
-$ ls tar
-dtc-1.2.0-x86_64-freebsd9.1-1.tar.bz2 x86_64-freebsd9.1-dtc-set.tar.bz2
--------------------------------------------------------------
-
-The build is for a FreeBSD host and the prefix is for user installed
-packages. In this example I cannot let the source builder perform the install
-because I never run the RSB with root priviledges so a build set or bset tar
-file is created. This can then be installed using root privildges.
-
-The command also supplies the --trace option. The output in the log file will
-contian all the macros.
-
-Debugging
-^^^^^^^^^
-
-New configuration files require debugging. There are two types of
-debugging. The first is debugging RSB script bugs. The +--dry-run+ option is
-used here. Suppling this option will result in most of the RSB processing to be
-performed and suitable output placed in the log file. This with the +--trace+
-option should help you resolve any issues.
-
-The second type of bug to fix are related to the execution of one of
-phases. These are usually a mix of shell script bugs or package set up or
-configuration bugs. Here you can use any normal shell script type debug
-technique such as +set -x+ to output the commands or +echo+
-statements. Debugging package related issues may require you start a build with
-teh RSB and supply +--no-clean+ option and then locate the build directories
-and change directory into them and manually run commands until to figure what
-the package requires.
-
-Snapshot Testing
-~~~~~~~~~~~~~~~~
-
-_This section needs to be updated once I sort out snapshot testing._
-
-Testing of release canidates and snapshots is important to those helping
-maintain tool sets. The RTEMS Source Builder helps by providing a simple and
-flexible way to use existing build sets and configuration without needing to
-change them or creating new temporary build sets and configurations.
-
-The process uses snapshot macro files loaded via the command line option
-`--macros`. These files provide macros that override the standard build set and
-configuration file macros.
-
-Lets consider testing a GCC 4.7 snapshot for RTEMS 4.11. Lets assume the
-current RTEMS 4.11 tools reference GCC 4.7.3 with a patch as the stable tool
-set. We want to use a recent snapshot with no patches. In the
-`rtems/config/snapshots` directoy create a file called `gcc-4.7-snapshot.mc`
-containing:
-
--------------------------------------------------------------
-[gcc-4.7-snapshot]
-GCC_Version: none, override, '4.7-20130413'
-Source: none, override, 'http://mirrors.kernel.org/sources.redhat.com/gcc/
-snapshots/%{gcc_version}/gcc-%{gcc_version}.tar.bz2'
-Patch0: none, udefine, ''
--------------------------------------------------------------
-
-In the standard configuration file `source-builder/config/gcc-4.7-1.cfg` the
-map is selected with:
-
--------------------------------------------------------------
-#
-# Select the GCC 4.7 Snapshot Macro Map
-#
-%select gcc-4.7-snapshot
--------------------------------------------------------------
-
-On the command line add `--macros=snapshots/gcc-4.7-snapshot.mc` and this
-snapshot will be built. With careful use of the `--prefix` option you can
-locate the tools in a specific directory and test them without needing to
-effect your production environment.
-
-Scripting
-~~~~~~~~~
-
-Configuration files specify how to build a package. Configuration files are
-scripts and have a +.cfg+ file extension. The script format is based loosely on
-the RPM spec file format however the use and purpose in this tool does not
-compare with the functionality and therefore the important features of the spec
-format RPM needs and uses.
-
-The script language is implemented in terms of macros. The built-in list is:
-
-[horizontal]
-+%{}+:: Macro expansion with conditional logic.
-+%()+:: Shell expansion.
-+%prep+:: The source preparation shell commands.
-+%build+:: The build shell commands.
-+%install+:: The package install shell commands.
-+%clean+:: The package clean shell commands.
-+%include+:: Inline include another configuration file.
-+%name+:: The name of the package.
-+%summary+:: A brief package description. Useful when reporting about a build.
-+%release+:: The package release. A number that is the release as built by this tool.
-+%version+:: The package's version string.
-+%buildarch+:: The build architecture.
-+%source+:: Define a source code package. This macro has a number appended.
-+%patch+:: Define a patch. This macro has a is number appended.
-+%hash+:: Define a checksum for a source or patch file.
-+%echo+:: Print the following string as a message.
-+%warning+:: Print the following string as a warning and continue.
-+%error+:: Print the following string as an error and exit.
-+%select+:: Select the macro map. If there is no map nothing is reported.
-+%define+:: Define a macro. Macros cannot be redefined, you must first undefine it.
-+%undefine+:: Undefine a macro.
-+%if+:: Start a conditional logic block that ends with a +%endif+.
-+%ifn+:: Inverted start of a conditional logic block.
-+%ifarch+:: Test the architecture against the following string.
-+%ifnarch+:: Inverted test of the architecture
-+%ifos+:: Test the host operating system.
-+%else+:: Start the _else_ conditional logic block.
-+%endfi+:: End the conditional logic block.
-+%bconf_with+:: Test the build condition _with_ setting. This is the +--with-*+
-command line option.
-+%bconf_without+:: Test the build condition _without_ setting. This is the
-+--without-*+ command line option.
-
-Expanding
-^^^^^^^^^
-
-A macro can be `%{string}` or the equivalent of `%string`. The following macro
-expansions supported are:
-
-`%{string}`;;
-Expand the 'string' replacing the entire macro text with the text in the table
-for the entry 'string . For example if 'var' is 'foo' then `${var}` would
-become `foo`.
-
-`%{expand: string}`;;
-Expand the 'string' and then use it as a ``string'' to the macro expanding the
-macro. For example if _foo_ is set to 'bar' and 'bar' is set to 'foobar' then
-`%{expand:foo}` would result in `foobar`. Shell expansion can also be used.
-
-`%{with string}`;;
-Expand the macro to '1' if the macro `with_`'string' is defined else expand to
-_0_. Macros with the name `with_`'string' can be define with command line
-arguments to the RTEMS Source Builder commands.
-
-`%{defined string}`;;
-Expand the macro to '1' if a macro of name 'string' is defined else expand to '0'.
-
-`%{?string: expression}`;;
-Expand the macro to 'expression' if a macro of name 'string' is defined else expand to `%{nil}`.
-
-`%{!?string: expression}`;;
-Expand the macro to 'expression' if a macro of name 'string' is not defined. If
-the macro is define expand to `%{nil}`.
-
-`%(expression)`;;
-Expand the macro to the result of running the 'expression' in a host shell. It
-is assumed this is a Unix type shell. For example `%(whoami)` will return your
-user name and `%(date)` will return the current date string.
-
-%prep
-^^^^^
-
-The +%prep+ macro starts a block that continues until the next block macro. The
-_prep_ or preparation block defines the setup of the package's source and is a
-mix of RTEMS Source Builder macros and shell scripting. The sequence is
-typically +%source+ macros for source, +%patch+ macros to patch the source
-mixed with some shell commands to correct any source issues.
-
--------------------------------------------------------------
- <1> <2> <3>
-%source setup gcc -q -c -T -n %{name}-%{version}
--------------------------------------------------------------
-
-<1> The source group to set up.
-<2> The source's name.
-<3> The version of the source.
-
-The source set up are declared with the source +set+ and +add+ commands. For
-example:
-
--------------------------------------------------------------
-%source set gdb http://ftp.gnu.org/gnu/gdb/gdb-%{gdb_version}.tar.bz2
--------------------------------------------------------------
-
-This URL is the primary location of the GNU GDB source code and the RTEMS
-Source Builder can download the file from this location and by inspecting the
-file extension use +bzip2+ decompression with +tar+. When the +%prep+ section
-is processed a check of the local +source+ directory is made to see if the file
-has already been downloaded. If not found in the source cache directory the
-package is downloaded from the URL. You can append other base URLs via the
-command line option +--url+. This option accepts a comma delimited list of
-sites to try.
-
-You could optionally have a few source files that make up the package. For
-example GNU's GCC was a few tar files for a while and it is now a single tar
-file. Support for multiple source files can be conditionally implemented with
-the following scripting:
-
--------------------------------------------------------------
-%source set gcc ftp://ftp.gnu.org/gnu/gcc/gcc-%{gcc_version}/gcc-code-%{gcc_version}.tar.bz2
-%source add gcc ftp://ftp.gnu.org/gnu/gcc/gcc-%{gcc_version}/gcc-g++-%{gcc_version}.tar.bz2
-%source setup gcc -q -T -D -n gcc-%{gcc_version}
--------------------------------------------------------------
-
-Separate modules use separate source groups. The GNU GCC compiler for RTEMS
-uses Newlib, MPFR, MPC, and GMP source packages. You define the source with:
-
--------------------------------------------------------------
-%source set gcc ftp://ftp.gnu.org/gnu/gcc/gcc-%{gcc_version}/gcc-%{gcc_version}.tar.bz2
-%source set newlib ftp://sourceware.org/pub/newlib/newlib-%{newlib_version}.tar.gz
-%source set mpfr http://www.mpfr.org/mpfr-%{mpfr_version}/mpfr-%{mpfr_version}.tar.bz2
-%source set mpc http://www.multiprecision.org/mpc/download/mpc-%{mpc_version}.tar.gz
-%source set gmp ftp://ftp.gnu.org/gnu/gmp/gmp-%{gmp_version}.tar.bz2
--------------------------------------------------------------
-
-and set up with:
-
--------------------------------------------------------------
-%source setup gcc -q -n gcc-%{gcc_version}
-%source setup newlib -q -D -n newlib-%{newlib_version}
-%source setup mpfr -q -D -n mpfr-%{mpfr_version}
-%source setup mpc -q -D -n mpc-%{mpc_version}
-%source setup gmp -q -D -n gmp-%{gmp_version}
--------------------------------------------------------------
-
-Patching also occurs during the preparation stage. Patches are handled in a
-similar way to the source packages except you only +add+ patches. Patches are
-applied using the +setup+ command. The +setup+ command takes the default patch
-option. You can provide options with each patch by adding them as arguments
-before the patch URL. Patches with no options uses the +setup+ default.
-
--------------------------------------------------------------
-%patch add gdb %{rtems_gdb_patches}/gdb-sim-arange-inline.diff
-%patch add gdb -p0 <1> %{rtems_gdb_patches}/gdb-sim-cgen-inline.diff
--------------------------------------------------------------
-<1> This patch has a custom option.
-
-To apply these patches:
-
--------------------------------------------------------------
-%patch setup gdb -p1 <1>
--------------------------------------------------------------
-<1> The default options.
-
-%build
-^^^^^^
-
-The +%build+ macro starts a block that continues until the next block
-macro. The build block is a series of shell commands that execute to build the
-package. It assumes all source code has been unpacked, patch and adjusted so
-the build will succeed.
-
-The following is an example take from the GutHub STLink project:
-
-NOTE: STLink is a JTAG debugging device for the ST ARM family of processors.
-
--------------------------------------------------------------
-%build
- export PATH="%{_bindir}:${PATH}" <1>
-
- cd texane-stlink-%{stlink_version} <2>
-
- ./autogen.sh <3>
-
-%if "%{_build}" != "%{_host}"
- CFLAGS_FOR_BUILD="-g -O2 -Wall" \ <4>
-%endif
- CPPFLAGS="-I $SB_TMPPREFIX/include/libusb-1.0" \ <5>
- CFLAGS="$SB_OPT_FLAGS" \
- LDFLAGS="-L $SB_TMPPREFIX/lib" \
- ./configure \ <6>
- --build=%{_build} --host=%{_host} \
- --verbose \
- --prefix=%{_prefix} --bindir=%{_bindir} \
- --exec-prefix=%{_exec_prefix} \
- --includedir=%{_includedir} --libdir=%{_libdir} \
- --mandir=%{_mandir} --infodir=%{_infodir}
-
- %{__make} %{?_smp_mflags} all <7>
-
- cd ..
--------------------------------------------------------------
-
-<1> Setup the PATH environment variable. This is not always needed.
-<2> This package builds in the source tree so enter it.
-<3> The package is actually checked directly out from the github project and so
- it needs its autoconf and automake files generated.
-<4> Flags for a cross-compiled build.
-<5> Various settings passed to configure to customise the build. In this
- example an include path is being set to the install point of _libusb_. This
- package requires _libusb_ is built before it.
-<6> The +configure+ command. The RTEMS Source Builder provides all the needed
- paths as macro variables. You just need to provide them to +configure+.
-<7> Running make. Do not use +make+ directly, use the RTEMS Source Builder's
- defined value. This value is specific to the host. A large number of
- packages need GNU make and on BSD systems this is +gmake+. You can
- optionally add the SMP flags if the packages build system can handle
- parallel building with multiple jobs. The +_smp_mflags+ value is
- automatically setup for SMP hosts to match the number of cores the host has.
-
-%install
-^^^^^^^^
-
-The +%install+ macro starts a block that continues until the next block
-macro. The install block is a series of shell commands that execute to install
-the package. You can assume the package has build correctly when this block
-starts executing.
-
-Never install the package to the actual _prefix_ the package was built
-with. Always install to the RTEMS Source Builder's temporary path defined in
-the macro variable +\__tmpdir+. The RTEMS Source Builder sets up a shell
-environment variable called +SB_BUILD_ROOT+ as the standard install point. Most
-packages support adding +DESTDIR=+ to the _make install_ command.
-
-Looking at the same example as in <<_build, %build>>:
-
--------------------------------------------------------------
-%install
- export PATH="%{_bindir}:${PATH}" <1>
- rm -rf $SB_BUILD_ROOT <2>
-
- cd texane-stlink-%{stlink_version} <3>
- %{__make} DESTDIR=$SB_BUILD_ROOT install <4>
-
- cd ..
--------------------------------------------------------------
-
-<1> Setup the PATH environment variable. This is not always needed.
-<2> Clean any installed files. This make sure the install is just what
- the package installs and not any left over files from a broken build or
- install.
-<3> Enter the build directory. In this example it just happens to be the source
- directory.
-<4> Run +make install+ to install the package overriding the +DESTDIR+ make
- variable.
-
-%clean
-^^^^^^
-
-The +%clean+ macro starts a block that continues until the next block
-macro. The clean block is a series of shell commands that execute to clean up
-after a package has been built and install. This macro is currenly not been
-used because the RTEMS Source Builder automatically cleans up.
-
-%include
-^^^^^^^^
-
-The +%include+ macro inline includes the specific file. The +\__confdir+
-path is searched. Any relative path component of the include file is appended
-to each part of the +\__configdir+. Adding an extension is optional as files
-with +.bset+ and +.cfg+ are automatically searched for.
-
-Inline including means the file is processed as part of the configuration at
-the point it is included. Parsing continues from the next line in the
-configuration file that contains the +%include+ macro.
-
-Including files allow a kind of configuration file reuse. The outer
-configuration files provide specific information such as package version
-numbers and patches and then include a generic configuration script which
-builds the package.
-
--------------------------------------------------------------
-%include %{_configdir}/gcc-4.7-1.cfg
--------------------------------------------------------------
-
-%name
-^^^^^
-
-The name of the package being built. The name typically contains the components
-of the package and their version number plus a revision number. For the GCC
-with Newlib configuration the name is typically:
-
--------------------------------------------------------------
-Name: %{_target}-gcc-%{gcc_version}-newlib-%{newlib_version}-%{release}
--------------------------------------------------------------
-
-%summary
-^^^^^^^^
-
-The +%summary+ is a brief description of the package. It is useful when
-reporting. This information is not capture in the package anywhere. For the GCC
-with Newlib configuration the summary is typically:
-
--------------------------------------------------------------
-Summary: GCC v%{gcc_version} and Newlib v%{newlib_version} for target %{_target} on host %{_host}
--------------------------------------------------------------
-
-%release
-^^^^^^^^
-
-The +%release+ is packaging number that allows revisions of a package to happen
-where none package versions change. This value typically increases when the
-configuration building the package changes.
-
--------------------------------------------------------------
-%define release 1
--------------------------------------------------------------
-
-%version
-^^^^^^^^
-
-The +%version% macro sets the version the package. If the package is a single
-component it tracks that component's version number. For example in the
-_libusb_ configuration the +%version+ is the same as +%libusb_version+, however
-in a GCC with Newlib configuration there is no single version number. In this
-case the GCC version is used.
-
--------------------------------------------------------------
-Version: %{gcc_version}
--------------------------------------------------------------
-
-%buildarch
-^^^^^^^^^^
-
-The +%buildarch+ macro is set to the architecture the package contains. This is
-currently not used in the RTEMS Source Builder and may go away. This macro is
-more important in a real packaging system where the package could end up on the
-wrong architecture.
-
-%source
-^^^^^^^
-
-The +%source+ macro has 3 commands that controls what it does. You can +set+
-the source files, +add+ source files to a source group, and +setup+ the source
-file group getting it ready to be used.
-
-Source files are source code files in tar or zip files that are unpacked,
-copied or symbolically linked into the package's build tree. Building a package
-requires one or more dependent packages. These are typically the packages
-source code plus dependent libraries or modules. You can create any number of
-these source groups and set each of them up with a separe source group for each
-needed library or module. Each source group normally has a single tar, zip or
-repository and the +set+ defines this. Some projects split the source code into
-separate tar or zip files and you install them by using the +add+ command.
-
-The first instance of a +set+ command creates the source group and sets the
-source files to be set up. Subsequence +set+ commands for the same source group
-are ignored. this lets you define the standard source files and override them
-for specific releases or snapshots.. To set a source file group:
-
--------------------------------------------------------------
-%source set gcc <1> ftp://ftp.gnu.org/gnu/gcc/gcc-%{gcc_version}/gcc-%{gcc_version}.tar.bz2
--------------------------------------------------------------
-<1> The source group is +gcc+.
-
-To add another source package to be installed into the same source tree you use
-the +add+ command:
-
--------------------------------------------------------------
-%source add gcc ftp://ftp.gnu.org/gnu/gcc/gcc-%{gcc_version}/g++-%{gcc_version}.tar.bz2
--------------------------------------------------------------
-
-The source +setup+ command can only be issued in the +%prep:+ section. The
-setup is:
-
--------------------------------------------------------------
-%source gcc setup -q -T -D -n %{name}-%{version}
--------------------------------------------------------------
-
-Accepted options are:
-
-[horizontal]
-*Switch*:: *Description*
-+-n+:: The -n option is used to set the name of the software's build
-directory. This is necessary only when the source archive unpacks into a
-directory named other than +<name>-<version>+.
-+-c+:: The -c option is used to direct %setup to create the top-level build
-directory before unpacking the sources.
-+-D+:: The -D option is used to direct %setup to not delete the build directory
-prior to unpacking the sources. This option is used when more than one source
-archive is to be unpacked into the build directory, normally with the +-b+ or
-+-a+ options.
-+-T+:: The -T option is used to direct %setup to not perform the default
-unpacking of the source archive specified by the first Source: macro. It is used
-with the +-a+ or +-b+ options.
-+-b <n>+:: The -b option is used to direct %setup to unpack the source archive
-specified on the nth Source: macro line before changing directory into the build
-directory.
-
-%patch
-^^^^^^
-
-The +%patch+ macro has the same 3 command as the +%source+ command however the
-+set+ commands is not really that useful with the with command. You add patches
-with the +add+ command and +setup+ applies the patches. Patch options can be
-added to each patch by placing them before the patch URL. If no patch option is
-provided the default options passed to the +setup+ command are used. An option
-starts with a '-'. The +setup+ command must reside inside the +%prep+ section.
-
-Patches are grouped in a similar way to the +%source+ macro so you can control
-applying a group of patches to a specific source tree.
-
-The +__patchdir+ path is search.
-
-To add a patch:
-
--------------------------------------------------------------
-%patch add gcc <1> gcc-4.7.2-rtems4.11-20121026.diff
-%patch add gcc -p0 <2> gcc-4.7.2-rtems4.11-20121101.diff
--------------------------------------------------------------
-<1> The patch group is +gcc+.
-<2> Option for this specific patch.
-
-Placing +%patch setup+ in the +%prep+ section will apply the groups patches.
-
--------------------------------------------------------------
-%patch setup gcc <1> -p1 <2>
--------------------------------------------------------------
-<1> The patch group.
-<2> The default option used to apply the patch.
-
-%hash
-^^^^^
-
-The +%hash+ macro requires 3 arguments and defines a checksum for a specific
-file. The checksum is not applied until the file is checked before downloading
-and once downloaded. A patch or source file that does not has a hash defined
-generates a warning.
-
-A file to be checksum must be unqiue in the any of the source and patch
-directories. The basename of the file is used as the key for the hash.
-
-The hash algorthim can be 'md5', 'sha1', 'sha224', 'sha256', 'sha384', and
-'sha512' and we typically use 'md5'.
-
-To add a hash:
-
--------------------------------------------------------------
-%hash md5 <1> net-snmp-%{net_snmp_version}.tar.gz <2> 7db683faba037249837b226f64d566d4 <3>
--------------------------------------------------------------
-<1> The type of checksum.
-<2> The file to checksum. It can contain macros that are expanded for you.
-<3> The MD5 hash for the Net-SNMP file +net-snmp-5.7.2.1.tar.gz+.
-
-Do not include a path with the file name. Only the basename is required. Files
-can be searched for from a number of places and having a path conponent would
-create confusion. This does mean files with hashes must be unique.
-
-Downloading of repositories such as git and cvs cannot be checksumed. It is
-assumed those protocols and tools manage the state of the files.
-
-%echo
-^^^^^
-
-The +%echo+ macro outputs the following string to stdout. This can also be used
-as `%{echo: message}`.
-
-%warning
-^^^^^^^^
-
-The +%warning+ macro outputs the following string as a warning. This can also
-be used as `%{warning: message}`.
-
-%error
-^^^^^^
-
-The +%error+ macro outputs the follow string as an error and exits the RTEMS
-Source Builder. This can also be used as `%{error: message}`.
-
-%select
-^^^^^^^
-
-The +%select+ macro selects the map specified. If there is no map no error or
-warning is generated. Macro maps provide a simple way for a user to override
-the settings is a configuration file without having to edit it. The changes are
-recorded in the build report so can be traced.
-
-Configuration use different maps so macro overrides can target a specific
-package.
-
-The default map is `global'.
-
--------------------------------------------------------------
-%select gcc-4.8-snapshot <1>
-%define one_plus_one 2 <2>
--------------------------------------------------------------
-
-<1> The map switches to `gcc-4.8-snapshot`. Any overrides in this map will be
- used.
-<2> Defining macros only updates the `global` map and not the selected map.
-
-%define
-^^^^^^^
-
-The +%define+ macro defines a new macro or updates an existing one. If no value
-is given it is assumed to be 1.
-
--------------------------------------------------------------
-%define foo bar
-%define one_plus_one 2
-%define one <1>
--------------------------------------------------------------
-
-<1> The macro _one_ is set to 1.
-
-%undefine
-^^^^^^^^^
-
-The +%undefine+ macro removes a macro if it exists. Any further references to
-it will result in an undefine macro error.
-
-%if
-^^^
-
-The +%if+ macro starts a conditional logic block that can optionally have a
-_else_ section. A test follows this macro and can have the following operators:
-
-[horizontal]
-*Operator*:: *Description*
-+%{}+:: Check the macro is set or _true_, ie non-zero.
-+
--------------------------------------------------------------
-%if ${foo}
- %warning The test passes, must not be empty or is non-zero
-%else
- %error The test fails, must be empty or zero
-%endif
--------------------------------------------------------------
-+!+:: The _not_ operator inverts the test of the macro.
-+
--------------------------------------------------------------
-%if ! ${foo}
- %warning The test passes, must be empty or zero
-%else
- %error The test fails, must not be empty or is non-zero
-%endif
--------------------------------------------------------------
-+==+:: The left hand size must equal the right hand side. For example:
-+
--------------------------------------------------------------
-%define one 1
-%if ${one} == 1
- %warning The test passes
-%else
- %error The test fails
-%endif
--------------------------------------------------------------
-+
-You can also check to see if a macro is empty:
-+
--------------------------------------------------------------
-%if ${nothing} == %{nil}
- %warning The test passes
-%else
- %error The test fails
-%endif
--------------------------------------------------------------
-+!=+:: The left hand size does not equal the right hand side. For example:
-+
--------------------------------------------------------------
-%define one 1
-%if ${one} != 2
- %warning The test passes
-%else
- %error The test fails
-%endif
--------------------------------------------------------------
-+
-You can also check to see if something is set:
-+
--------------------------------------------------------------
-%if ${something} != %{nil}
- %warning The test passes
-%else
- %error The test fails
-%endif
--------------------------------------------------------------
-+>+:: The left hand side is numerically greater than the right hand side.
-+>=+:: The left hand side is numerically greater than or equal to the right
-hand side.
-+<+:: The left hand side is numerically less than the right hand side.
-+\<=+:: The left hand side is numerically less than or equal to the right hand
-side.
-
-%ifn
-^^^^
-
-The +%ifn+ macro inverts the normal +%if+ logic. It avoids needing to provide
-empty _if_ blocks followed by _else_ blocks. It is useful when checking if a
-macro is defined:
-
--------------------------------------------------------------
-%ifn %{defined foo}
- %define foo bar
-%endif
--------------------------------------------------------------
-
-%ifarch
-^^^^^^^
-
-The +%ifarch+ is a short cut for "+%if %{\_arch} == i386+". Currently not used.
-
-%ifnarch
-^^^^^^^^
-
-The +%ifnarch+ is a short cut for "+%if %{\_arch} != i386+". Currently not
-used.
-
-%ifos
-^^^^^
-
-The +%ifos+ is a short cut for "+%if %{\_os} != mingw32+". It allows
-conditional support for various operating system differences when building
-packages.
-
-%else
-^^^^^
-
-The +%else+ macro starts the conditional _else_ block.
-
-%endfi
-^^^^^^
-
-The +%endif+ macro ends a conditional logic block.
-
-%bconf_with
-^^^^^^^^^^^
-
-The +%bconf_with+ macro provides a way to test if the user has passed a
-specific option on the command line with the +--with-<label>+ option. This
-option is only available with the +sb-builder+ command.
-
-%bconf_without
-^^^^^^^^^^^^^^
-
-The +%bconf_without+ macro provides a way to test if the user has passed a
-specific option on the command line with the +--without-<label>+ option. This
-option is only available with the +sb-builder+ command.
-
-Commands
---------
-
-Checker (sb-check)
-~~~~~~~~~~~~~~~~~~
-
-This commands checks your system is set up correctly. Most options are ignored.
-
--------------------------------------------------------------
-$ ../source-builder/sb-check --help
-sb-check: [options] [args]
-RTEMS Source Builder, an RTEMS Tools Project (c) 2012-2013 Chris Johns
-Options and arguments:
---force : Force the build to proceed
---quiet : Quiet output (not used)
---trace : Trace the execution
---dry-run : Do everything but actually run the build
---warn-all : Generate warnings
---no-clean : Do not clean up the build tree
---always-clean : Always clean the build tree, even with an error
---jobs : Run with specified number of jobs, default: num CPUs.
---host : Set the host triplet
---build : Set the build triplet
---target : Set the target triplet
---prefix path : Tools build prefix, ie where they are installed
---topdir path : Top of the build tree, default is $PWD
---configdir path : Path to the configuration directory, default: ./config
---builddir path : Path to the build directory, default: ./build
---sourcedir path : Path to the source directory, default: ./source
---tmppath path : Path to the temp directory, default: ./tmp
---macros file[,[file] : Macro format files to load after the defaults
---log file : Log file where all build out is written too
---url url[,url] : URL to look for source
---no-download : Disable the source downloader
---targetcflags flags : List of C flags for the target code
---targetcxxflags flags : List of C++ flags for the target code
---libstdcxxflags flags : List of C++ flags to build the target libstdc++ code
---with-<label> : Add the --with-<label> to the build
---without-<label> : Add the --without-<label> to the build
---regression : Set --no-install, --keep-going and --always-clean
-$ ../source-builder/sb-check
-RTEMS Source Builder - Check, v0.2.0
-Environment is ok
--------------------------------------------------------------
-
-Defaults (sb-defaults)
-~~~~~~~~~~~~~~~~~~~~~~
-
-This commands outputs and the default macros for your when given no
-arguments. Most options are ignored.
-
--------------------------------------------------------------
-$ ../source-builder/sb-defaults --help
-sb-defaults: [options] [args]
-RTEMS Source Builder, an RTEMS Tools Project (c) 2012-2013 Chris Johns
-Options and arguments:
---force : Force the build to proceed
---quiet : Quiet output (not used)
---trace : Trace the execution
---dry-run : Do everything but actually run the build
---warn-all : Generate warnings
---no-clean : Do not clean up the build tree
---always-clean : Always clean the build tree, even with an error
---jobs : Run with specified number of jobs, default: num CPUs.
---host : Set the host triplet
---build : Set the build triplet
---target : Set the target triplet
---prefix path : Tools build prefix, ie where they are installed
---topdir path : Top of the build tree, default is $PWD
---configdir path : Path to the configuration directory, default: ./config
---builddir path : Path to the build directory, default: ./build
---sourcedir path : Path to the source directory, default: ./source
---tmppath path : Path to the temp directory, default: ./tmp
---macros file[,[file] : Macro format files to load after the defaults
---log file : Log file where all build out is written too
---url url[,url] : URL to look for source
---no-download : Disable the source downloader
---targetcflags flags : List of C flags for the target code
---targetcxxflags flags : List of C++ flags for the target code
---libstdcxxflags flags : List of C++ flags to build the target libstdc++ code
---with-<label> : Add the --with-<label> to the build
---without-<label> : Add the --without-<label> to the build
---regression : Set --no-install, --keep-going and --always-clean
--------------------------------------------------------------
-
-Set Builder (sb-set-builder)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-This command builds a set.
-
--------------------------------------------------------------
-$ ../source-builder/sb-set-builder --help
-RTEMS Source Builder, an RTEMS Tools Project (c) 2012-2013 Chris Johns
-Options and arguments:
---force : Force the build to proceed
---quiet : Quiet output (not used)
---trace : Trace the execution
---dry-run : Do everything but actually run the build
---warn-all : Generate warnings
---no-clean : Do not clean up the build tree
---always-clean : Always clean the build tree, even with an error
---regression : Set --no-install, --keep-going and --always-clean
----jobs : Run with specified number of jobs, default: num CPUs.
---host : Set the host triplet
---build : Set the build triplet
---target : Set the target triplet
---prefix path : Tools build prefix, ie where they are installed
---topdir path : Top of the build tree, default is $PWD
---configdir path : Path to the configuration directory, default: ./config
---builddir path : Path to the build directory, default: ./build
---sourcedir path : Path to the source directory, default: ./source
---tmppath path : Path to the temp directory, default: ./tmp
---macros file[,[file] : Macro format files to load after the defaults
---log file : Log file where all build out is written too
---url url[,url] : URL to look for source
---no-download : Disable the source downloader
---no-install : Do not install the packages to the prefix
---targetcflags flags : List of C flags for the target code
---targetcxxflags flags : List of C++ flags for the target code
---libstdcxxflags flags : List of C++ flags to build the target libstdc++ code
---with-<label> : Add the --with-<label> to the build
---without-<label> : Add the --without-<label> to the build
---mail-from : Email address the report is from.
---mail-to : Email address to send the email too.
---mail : Send email report or results.
---smtp-host : SMTP host to send via.
---no-report : Do not create a package report.
---report-format : The report format (text, html, asciidoc).
---bset-tar-file : Create a build set tar file
---pkg-tar-files : Create package tar files
---list-bsets : List available build sets
---list-configs : List available configurations
---list-deps : List the dependent files.
--------------------------------------------------------------
-
-.Arguments
-The +[args]+ are a list build sets to build.
-
-.Options
-+--force+;;
-Force the build to proceed even if the host check fails. Typically this happens
-if executable files are found in the path at a different location to the host
-defaults.
-+--trace+;;
-Trace enable printing of debug information to stdout. It is really only of use
-to RTEMS Source Builder's developers.
-+--dry-run+;;
-Do everything but actually run the build commands. This is useful when checking
-a new configuration parses cleanly.
-+--warn-all+;;
-Generate warnings.
-+--no-clean+;;
-Do not clean up the build tree during the cleaning phase of the build. This
-leaves the source and the build output on disk so you can make changes, or
-amend or generate new patches. It also allows you to review configure type
-output such as +config.log+.
-+--always-clean+;;
-Clean away the results of a build even if the build fails. This is normally
-used with `--keep-going` when regression testing to see which build sets
-fail to build. It keeps the disk usage down.
-+--jobs+;;
-Control the number of jobs make is given. The jobs can be 'none' for only 1
-job, 'half' so the number of jobs is half the number of detected cores, a
-fraction such as '0.25' so the number of jobs is a quarter of the number of
-detected cores and a number such as '25' which forces the number of jobs to
-that number.
-+--host+;;
-Set the host triplet value. Be careful with this option.
-+--build+;;
-Set the build triplet. Be careful with this option.
-+--target+;;
-Set the target triplet. Be careful with this option. This is useful if you have
-a generic configuration script that can work for a range of architectures.
-+--prefix path+;;
-Tools build prefix, ie where they are installed.
-+--topdir path+;;
-Top of the build tree, that is the current directory you are in.
-+--configdir path+;;
-Path to the configuration directory. This overrides the built in defaults.
-+--builddir path+;;
-Path to the build directory. This overrides the default of +build+.
-+--sourcedir path+;;
-Path to the source directory. This overrides the default of +source+.
-+--tmppath path+;;
-Path to the temporary directory. This overrides the default of +tmp+.
-+--macros files+;;
-Macro files to load. The configuration directory path is searched.
-+--log file+;;
-Log all the output from the build process. The output is directed to +stdout+
-if no log file is provided.
-+--url url+;;
-URL to look for source when downloading. This is can be comma separate list.
-+--no-download+;;
-Disable downloading of source and patches. If the source is not found an error
-is raised.
-+--targetcflags flags+;;
-List of C flags for the target code. This allows for specific local
-customisation when testing new variations.
-+--targetcxxflags flags+;;
-List of C++ flags for the target code. This allows for specific local
-customisation when testing new variations.
-+--libstdcxxflags flags+;;
-List of C\++ flags to build the target libstdc++ code. This allows for specific
-local customisation when testing new variations.
-+--with-<label>+;;
-Add the --with-<label> to the build. This can be tested for in a script with
-the +%bconf_with+ macro.
-+--without-<label>+;;
-Add the --without-<label> to the build. This can be tested for in a script with
-the +%bconf_without+ macro.
-+--mail-from+;;
-Set the from mail address if report mailing is enabled.
-+--mail-to+;;
-Set the to mail address if report mailing is enabled. The report is mailed to
-this address.
-+--mail+;;
-Mail the build report to the mail to address.
-+--smtp-host+;;
-The SMTP host to use to send the email. The default is +localhost+.
-+--no-report+;;
-Do not create a report format.
-+--report-format format+;;
-The report format can be 'text' or 'html'. The default is 'html'.
-+--keep-going+;;
-Do not stop on error. This is useful if your build sets performs a large number
-of testing related builds and there are errors.
-+--always-clean+.
-Always clean the build tree even with a failure.
-+--no-install+;;
-Do not install the packages to the prefix. Use this if you are only after the
-tar files.
-+--regression+;;
-A convenience option which is the same as +--no-install+, +--keep-going+ and
-+--bset-tar-file+;;
-Create a build set tar file. This is a single tar file of all the packages in
-the build set.
-+--pkg-tar-files+;;
-Create package tar files. A tar file will be created for each package built in
-a build set.
-+--list-bsets+;;
-List available build sets.
-+--list-configs+;;
-List available configurations.
-+--list-deps+;;
-Print a list of dependent files used by a build set. Dependent files have a
-'dep[?]' prefix where '?' is a number. The files are listed alphabetically.
-
-Set Builder (sb-builder)
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-This command builds a configuration as described in a configuration
-file. Configuration files have the extension of +.cfg+.
-
--------------------------------------------------------------
-$ ./source-builder/sb-builder --help
-sb-builder: [options] [args]
-RTEMS Source Builder, an RTEMS Tools Project (c) 2012 Chris Johns
-Options and arguments:
---force : Force the build to proceed
---quiet : Quiet output (not used)
---trace : Trace the execution
---dry-run : Do everything but actually run the build
---warn-all : Generate warnings
---no-clean : Do not clean up the build tree
---always-clean : Always clean the build tree, even with an error
---jobs : Run with specified number of jobs, default: num CPUs.
---host : Set the host triplet
---build : Set the build triplet
---target : Set the target triplet
---prefix path : Tools build prefix, ie where they are installed
---topdir path : Top of the build tree, default is $PWD
---configdir path : Path to the configuration directory, default: ./config
---builddir path : Path to the build directory, default: ./build
---sourcedir path : Path to the source directory, default: ./source
---tmppath path : Path to the temp directory, default: ./tmp
---macros file[,[file] : Macro format files to load after the defaults
---log file : Log file where all build out is written too
---url url[,url] : URL to look for source
---targetcflags flags : List of C flags for the target code
---targetcxxflags flags : List of C++ flags for the target code
---libstdcxxflags flags : List of C++ flags to build the target libstdc++ code
---with-<label> : Add the --with-<label> to the build
---without-<label> : Add the --without-<label> to the build
---list-configs : List available configurations
--------------------------------------------------------------
-
-Host Setups
------------
-
-The host versions are listed. If a later version of the host operating system
-exists it should work unless listed.
-
-Please provide patches to update these sections if they are wrong or need
-updating. I cannot install and test each one and rely on getting your feedback.
-
-Linux
-~~~~~
-
-A number of different Linux distrubutions are known to work. The following have
-been tested and report as working.
-
-Archlinux
-^^^^^^^^^
-
-The following packages are required on a fresh Archlinux 64bit installation:
-
---------------------------------------------------------------
-# pacman -S base-devel gdb xz unzip ncurses git zlib
---------------------------------------------------------------
-
-Archlinux, by default installs `texinfo-5` which is incompatible for building
-GCC 4.7 tree. You will have to obtain `texinfo-legacy` from `AUR` and provide
-a manual override.
-
---------------------------------------------------------------
-# pacman -R texinfo
-$ yaourt -S texinfo-legacy
-# ln -s /usr/bin/makeinfo-4.13a /usr/bin/makeinfo
---------------------------------------------------------------
-
-CentOS
-^^^^^^
-
-The following packages are required on a minimal CentOS 6.3 64bit installation:
-
--------------------------------------------------------------
-# yum install autoconf automake binutils gcc gcc-c++ gdb make patch \
-bison flex xz unzip ncurses-devel texinfo zlib-devel python-devel git
--------------------------------------------------------------
-
-The minimal CentOS distribution is a specific DVD that installs a minimal
-system. If you use a full system some of these packages may have been
-installed.
-
-Fedora
-^^^^^^
-
-The RTEMS Source Builder has been tested on Fedora 19 64bit with the following packages.
-
--------------------------------------------------------------
-# yum install ncurses-devel python-devel git bison gcc cvs gcc-c++ \
- flex texinfo patch perl-Text-ParseWords zlib-devel
--------------------------------------------------------------
-
-Raspbian
-^^^^^^^^
-
-The is the Debian distribution for the Raspberry Pi. The following packages are
-required.
-
--------------------------------------------------------------
-$ sudo apt-get install autoconf automake bison flex binutils gcc g++ gdb \
-texinfo unzip ncurses-dev python-dev git
--------------------------------------------------------------
-
-It is recommended you get Model B of the Pi with 512M of memory and to mount a
-remote disk over the network. The tools can be build with a prefix under your
-home directory as recommended and end up on the SD card.
-
-Ubuntu
-^^^^^^
-
-The latest testing was with Ubuntu 16.04.1 LTS 64bit. This section also includes Xubuntu. A
-minimal installation was used and the following packages installed.
-
--------------------------------------------------------------
-$ sudo apt-get build-dep binutils gcc g++ gdb unzip git
-$ sudo apt-get install python2.7-dev
--------------------------------------------------------------
-
-FreeBSD
-~~~~~~~
-
-The RTEMS Source Builder has been tested on FreeBSD 9.1 and 10.0 64bit. You
-need to install some ports. They are:
-
--------------------------------------------------------------
-# cd /usr/ports
-# portinstall --batch lang/python27
--------------------------------------------------------------
-
-If you wish to build Windows (mingw32) tools please install the following
-ports:
-
--------------------------------------------------------------
-# cd /usr/ports
-# portinstall --batch devel/mingw32-binutils devel/mingw32-gcc
-# portinstall --batch devel/mingw32-zlib devel/mingw32-pthreads
--------------------------------------------------------------
-
-The +zlip+ and +pthreads+ ports for MinGW32 are used for builiding a Windows
-QEMU.
-
-If you are on FreeBSD 10.0 and you have pkgng installed you can use 'pkg
-install' rather than 'portinstall'.
-
-NetBSD
-~~~~~~
-
-The RTEMS Source Builder has been tested on NetBSD 6.1 i386. Packages to add
-are:
-
--------------------------------------------------------------
-# pkg_add ftp://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.1/devel/gmake-3.82nb7.tgz
-# pkg_add ftp://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.1/devel/bison-2.7.1.tgz
-# pkg_add ftp://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.1/archivers/xz-5.0.4.tgz
--------------------------------------------------------------
-
-MacOS
-~~~~~
-
-The RTEMS Source Builder has been tested on Mountain Lion. You will need to
-install the Xcode app using the _App Store_ tool, run Xcode and install the
-Developers Tools package within Xcode.
-
-Linux Mint
-^^^^^^^^^^
-
-zlib package is required on Linux Mint. It has a different name (other
-than the usual zlib-dev):
-
--------------------------------------------------------------
-# sudo apt-get install zlib1g-dev
--------------------------------------------------------------
-
-Mavericks
-^^^^^^^^^
-
-The RSB works on Mavericks and the GNU tools can be built for RTEMS using the
-Mavericks clang LLVM tool chain. You will need to build and install a couple of
-packages to make the RSB pass the +sb-check+. These are CVS and XZ. You can get
-these tools from a packaging tool for MacOS such as _MacPorts_ or _HomeBrew_.
-
-I do not use 3rd party packaging on MacOS and prefer to build the packages from
-source using a prefix of '/usr/local'. There are good 3rd party packages around
-however they sometimes bring in extra dependence and that complicates my build
-environment and I want to know the minimal requirements when building
-tools. The following are required:
-
-. The XZ package's home page is http://tukaani.org/xz/ and I use version
- 5.0.5. XZ builds and installs cleanly.
-
-. CVS can be found at http://cvs.nongnu.org/ and I use version 1.11.23. CVS
- requires the following patch
- http://ftp.rtems.org/pub/rtems/people/chrisj/source-builder/cvs-1.11.23-osx-maverick.diff
- to build. Place the diff in the same directory as the unpacked cvs-1.11.23
- and apply with +patch -p0 < cvs-1.11.23-osx-maverick.diff+.
-
-Windows
-~~~~~~~
-
-Windows tool sets are supported. The tools are native Windows executable which
-means they do not need an emulation layer to run once built. The tools
-understand and use standard Windows paths and integrate easily into Windows IDE
-environments because they understand and use standard Windows paths. Native
-Windows tools have proven over time to be stable and reliable with good
-performance. If you are a Windows user or you are required to use Windows you
-can still develop RTEMS application as easily as a Unix operating system. Some
-debugging experiences may vary and if this is an issue please raised the topic
-on the RTEMS Users mailing list.
-
-Building the tools or some other packages may require a Unix or POSIX type
-shell. There are a few options, Cygwin and MSYS2. I recommend MSYS2.
-
-.Ready To Go Windows Tools
-NOTE: From time to time I provide tools for Windows at
-http://ftp.rtems.org/pub/rtems/people/chrisj/source-builder/4.11/mingw32/
-
-MSYS2
-
-This is a new version of the old MinGW project's original MSYS based around the
-Arch Linux pacman packager. MSYS and MSYS2 are a specific fork of the Cygwin
-project with some fundamental changes in the handling of paths and mounts that
-allow easy interaction between the emulated POSIX environment and the native
-Windows environment.
-
-Install MSYS2 using the installer you can download from
-https://msys2.github.io/. Follow the instructions on the install page and make
-sure you remove any global path entries to any other Cygwin, MinGW, MSYS or
-packages that may uses a Cygwin DLL, for example some ports of Git.
-
-To build the tools you need install the following packages using pacman:
-
- $ pacman -S git cvs bison make texinfo patch unzip diffutils tar \
- mingw64/mingw-w64-x86_64-gcc mingw64/mingw-w64-x86_64-binutils
-
-To build make sure you add '--without-python --jobs=none' to the standard RSB
-command line. MSYS2 has a temp file name issue and so the GNU AR steps on
-itself when running in parallel on SMP hardware which means we have to set the
-jobs option to none.
-
-Install a suitable version of Python from http://www.python.org/ and add it to
-the start of your path. The MSYS2 python does not work with waf.
-
-Cygwin
-
-Building on Windows is a little more complicated because the Cygwin shell is
-used rather than the MSYS2 shell. The MSYS2 shell is simpler because the
-detected host triple is MinGW so the build is standard cross-compiler build.
-A Canadian cross-build using Cygwin is supported if you would like native tools.
-
-Install a recent Cygwin version using the Cygwin setup tool. Select and install
-the groups and packages listed:
-
-.Cygwin Packages
-[options="header,compact",width="50%",cols="20%,80%"]
-|================================
-|Group |Package
-|Archive |bsdtar
-| |unzip
-| |xz
-|Devel |autoconf
-| |autoconf2.1
-| |autoconf2.5
-| |automake
-| |binutils
-| |bison
-| |flex
-| |gcc4-core
-| |gcc4-g++
-| |git
-| |make
-| |mingw64-x86_64-binutils
-| |mingw64-x86_64-gcc-core
-| |mingw64-x86_64-g++
-| |mingw64-x86_64-runtime
-| |mingw64-x86_64-zlib
-| |patch
-| |zlib-devel
-|MinGW |mingw-zlib-devel
-|Python |python
-|================================
-
-The setup tool will add a number of dependent package and it is ok to accept
-them.
-
-I have found turning off Windows Defender improves performance if you have
-another up to date virus detection tool installed and enabled. I used the
-excellent `Process Hacker 2` tool to monitor the performance and I found the
-Windows Defender service contributed a high load. In my case I had a 3rd party
-virus tool installed so the Windows Defender service was not needed.
-
-A Canadian cross-compile (Cxc) is required on Cygwin because the host is Cygwin
-therefore a traditional cross-compile will result in Cygiwn binaries. With a
-Canadian cross-compile a Cygwin cross-compiler is built as well as the MinGW
-RTEMS cross-compiler. The Cygwin cross-compiler is required to build the C
-runtime for the RTEMS target because we are building under Cygiwn. The build
-output for an RTEMS 4.10 ARM tool set is:
-
--------------------------------------------------------------
-chris@cygthing ~/development/rtems/src/rtems-source-builder/rtems
-$ ../source-builder/sb-set-builder --log=l-arm.txt --prefix=$HOME/development/rtems/4.10 4.10/rtems-arm
-RTEMS Source Builder - Set Builder, v0.2
-Build Set: 4.10/rtems-arm
-config: expat-2.1.0-1.cfg
-package: expat-2.1.0-x86_64-w64-mingw32-1
-building: expat-2.1.0-x86_64-w64-mingw32-1
-reporting: expat-2.1.0-1.cfg -> expat-2.1.0-x86_64-w64-mingw32-1.html
-config: tools/rtems-binutils-2.20.1-1.cfg
-package: arm-rtems4.10-binutils-2.20.1-1 <1>
-building: arm-rtems4.10-binutils-2.20.1-1
-package: (Cxc) arm-rtems4.10-binutils-2.20.1-1 <2>
-building: (Cxc) arm-rtems4.10-binutils-2.20.1-1
-reporting: tools/rtems-binutils-2.20.1-1.cfg ->
-arm-rtems4.10-binutils-2.20.1-1.html
-config: tools/rtems-gcc-4.4.7-newlib-1.18.0-1.cfg
-package: arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
-building: arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
-package: (Cxc) arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
-building: (Cxc) arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
-reporting: tools/rtems-gcc-4.4.7-newlib-1.18.0-1.cfg ->
-arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1.html
-config: tools/rtems-gdb-7.3.1-1.cfg
-package: arm-rtems4.10-gdb-7.3.1-1
-building: arm-rtems4.10-gdb-7.3.1-1
-reporting: tools/rtems-gdb-7.3.1-1.cfg -> arm-rtems4.10-gdb-7.3.1-1.html
-config: tools/rtems-kernel-4.10.2.cfg
-package: arm-rtems4.10-kernel-4.10.2-1
-building: arm-rtems4.10-kernel-4.10.2-1
-reporting: tools/rtems-kernel-4.10.2.cfg -> arm-rtems4.10-kernel-4.10.2-1.html
-installing: expat-2.1.0-x86_64-w64-mingw32-1 -> /cygdrive/c/Users/chris/development/rtems/4.10
-installing: arm-rtems4.10-binutils-2.20.1-1 -> /cygdrive/c/Users/chris/development/rtems/4.10 <3>
-installing: arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1 -> /cygdrive/c/Users/chris/development/rtems/4.10
-installing: arm-rtems4.10-gdb-7.3.1-1 -> /cygdrive/c/Users/chris/development/rtems/4.10
-installing: arm-rtems4.10-kernel-4.10.2-1 -> /cygdrive/c/Users/chris/development/rtems/4.10
-cleaning: expat-2.1.0-x86_64-w64-mingw32-1
-cleaning: arm-rtems4.10-binutils-2.20.1-1
-cleaning: arm-rtems4.10-gcc-4.4.7-newlib-1.18.0-1
-cleaning: arm-rtems4.10-gdb-7.3.1-1
-cleaning: arm-rtems4.10-kernel-4.10.2-1
-Build Set: Time 10:09:42.810547 <4>
--------------------------------------------------------------
-
-<1> The Cygwin version of the ARM cross-binutils.
-<2> The +(Cxc)+ indicates this is the MinGW build of the package.
-<3> Only the MinGW version is installed.
-<4> Cygwin is slow so please be patient. This time was on an AMD Athlon 64bit
- Dual Core 6000+ running at 3GHz with 4G RAM running Windows 7 64bit.
-
-CAUTION: Cygwin documents the 'Big List Of Dodgy Apps' or 'BLODA'. The link is
-http://cygwin.com/faq/faq.html#faq.using.bloda and it is worth a
-look. You will see a large number of common pieces of software found on Windows
-systems that can cause problems. My testing has been performed with NOD32
-running and I have seen some failures. The list is for all of Cygwin so I am
-not sure which of the listed programs effect the RTEMS Source Biulder. The
-following FAQ item talks about +fork+ failures and presents some technical
-reasons they cannot be avoided in all cases. Cygwin and it's fork MSYS are
-fantastic pieces of software in a difficult environment. I have found building
-a single tool tends to work, building all at once is harder.
-
-
-Build Status By Host
-~~~~~~~~~~~~~~~~~~~~
-
-This table lists the current build and testing status for reported hosts:
-
-[grid="rows",format="csv"]
-[options="header",cols="<,<,<,<,<,<"]
-|===========================
-OS,Uname,4.9,4.10,4.11,Comments
-include::host-results.csv[]
-|===========================
-
-[NOTE]
-==================================================================
-Report any unlisted hosts as a patch.
-==================================================================
-
-History
--------
-
-The RTEMS Source Builder is a stand alone tool based on another tool called the
-'SpecBuilder'. The SpecBuilder was written for the RTEMS project to give me a
-way to build tools on hosts that did not support RPMs. At the time the RTEMS
-tools maintainer only used spec files to create various packages. This meant I
-had either spec files, RPM files or SRPM files. The RPM and SPRM files where
-useless because you needed an 'rpm' type tool to extract and manage them. There
-are versions of 'rpm' for a number of non-RPM hosts however these proved to be
-in various broken states and randomly maintained. The solution I settled on was
-to use spec files so I wrote a Python based tool that parsed the spec file
-format and allowed me to create a shell script I could run to build the
-package. This approach proved successful and I was able to track the RPM
-version of the RTEMS tools on a non-RPM host over a number of years. however
-the SpecBuilder tool did not help me build tools or other packages not related
-to the RTEMS project where there was no spec file I could use so I needed
-another tool. Rather than start again I decided to take the parsing code for
-the spec file format and build a new tool called the RTEMS Source Builder.
diff --git a/doc/wscript b/doc/wscript
deleted file mode 100644
index 614ffbb..0000000
--- a/doc/wscript
+++ /dev/null
@@ -1,30 +0,0 @@
-#
-# Waf build script to build the Source Builder Documentation.
-#
-
-import os.path
-
-version = "1.0.0"
-
-asciidoc = os.path.join(os.getcwd(),
- '..', 'source-builder', 'sb', 'asciidoc')
-
-def configure(ctx):
- ctx.env.ASCIIDOC = ctx.find_program(['asciidoc.py'],
- path_list = [asciidoc],
- mandatory = True)
- ctx.env.ASCIIDOC_FLAGS = ['-b', 'html5', '-a', 'data-uri',
- '-a', 'icons', '-a', 'max-width=55em-a']
-
-def build(ctx):
- ctx(target = 'source-builder.html', source = 'source-builder.txt')
- ctx.add_manual_dependency(ctx.path.find_node('source-builder.txt'),
- ctx.path.find_node('host-results.csv'))
-
-import waflib.TaskGen
-waflib.TaskGen.declare_chain(name = 'html',
- rule = '${ASCIIDOC} ${ASCIIDOC_FLAGS} -o ${TGT} ${SRC}',
- shell = False,
- ext_in = '.txt',
- ext_out = '.html',
- reentrant = False)
diff --git a/source-builder/sb/asciidoc/BUGS b/source-builder/sb/asciidoc/BUGS
deleted file mode 100644
index 8e17177..0000000
--- a/source-builder/sb/asciidoc/BUGS
+++ /dev/null
@@ -1,27 +0,0 @@
- 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
deleted file mode 100644
index b74c1a2..0000000
--- a/source-builder/sb/asciidoc/BUGS.txt
+++ /dev/null
@@ -1,20 +0,0 @@
-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
deleted file mode 100644
index 8d260e5..0000000
--- a/source-builder/sb/asciidoc/CHANGELOG
+++ /dev/null
@@ -1,3291 +0,0 @@
- 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 <tt> tag with <code> 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
- <theme>.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 .<ext>=<mimetype> 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 id="content">...</div> div envelopes document content.
- 3. You need to add <div id="footnotes">...</div> 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 <refname> 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 <optionname>-option attributes into
- markup.
- * Added IRC URLs to AsciiDoc inline macros.
- * Added depth attribute to include::[] system macro.
- * Added footnoteref inline macro.
- * Added stylesheet XHTML attribute to specify additional custom CSS
- stylesheet.
- * If a paragraph style is specified it will be added to the XHTML
- class attribute and DocBook role attribute.
- * Replacements can be set in a document using the reserved
- AttributeEntry name replacement.
- * The prefix for auto-generated section name IDs can be set with the
- idprefix attribute.
-
- Bug fixes
- * Escaped quote skipped over leading and trailing quote instead of
- just the leading quote.
- * Fixed bug that was causing false negative safe mode warnings (patch
- submitted by Julien Palmas).
- * Placed priority of AttributeEntry, AttributeList and BlockTitle
- above Title. This ensures an AttributeEntry, AttributeList or
- BlockTitle followed by a same length leading ListingBlock delimiter
- is not mistaken for a two-line title.
- * Vim syntax highlighter: fixed multi-line quoted text.
- * Contstrained quote termination after non-space character enforced.
- * Vim syntax highlighter: unterminated quoted text is no longer
- highlighted.
- * Vim syntax highlighter: passthroughs now exactly match AsciiDoc
- semantics.
- * Vim syntax highlighter: escaped quoted text, attribute references
- and inline macros are not highlighted.
- * Vim syntax highlighter: TODO’s highlighted in CommentBlocks (thanks
- to Scott Wall); non-greedy $$...$$.
- * 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 <programlisting> elements rather than GNU Highlighter —
- this is the correct way to handle it, plus dblatex(1) makes a much
- better job.
- * scaledwidth and align attributes have been added to the image
- macro. They apply to DocBook outputs (specifically for PDF
- documents). scaledwidth sets the image size as a percent of the
- available page width; align applies left, center or right
- horizontal image justification.
- * Added a2x(1) --fop-opts=FOP_OPTS option (patch submitted by Miklos
- Vajna).
- * Added a2x(1) --dblatex-opts=DBLATEX_OPTS option.
- * Added Mikhail Yakshin’s FOP 0.95 patch which fixes a long-standing
- fo.xsl problem and allows PDF’s to be generated with FOP 0.95
- (previously had to use FOP 0.20.5).
- * The User Guide has been updated and outdated FOP configuration and
- installation sections removed.
-
- Bug fixes
- * Fixed stylesheets/xhtml11-manpage.css not being included when
- linkcss attribute was used.
- * Configuration file *-style attributes are now dumped correctly.
- * Fixed FAILED: malformed section entry LaTeX backend error.
-
- See the also the [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-<lang>.conf will be loaded automatically.
- * The help file name help-<lang>.conf is based on the AsciiDoc lang
- attribute, defaults to help.conf (English).
- * Admonition, figure and table captions have been factored into a
- predefined set of caption_* attributes. They only apply to directly
- generated (X)HTML outputs (DocBook stylesheets generate their own
- language specific captions based on the lang attribute).
- * Dropped platform dependent doc/asciidoc.chm file from distribution
- documentation formats.
-
- Bug fixes
- * The spurious warning with will become a reserved keyword in Python
- 2.6 has been suppressed.
- __________________________________________________________________
-
-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 <a> element targets were
- generated.
- * Multi-word first, middle and last names can be entered in the
- header author line using the underscore as a word separator.
- * The nested inline macros restriction has now been lifted, for
- example you can now include links and inline images inside
- footnotes.
- * Help topic names can be shortened (so long as they are not
- ambiguous). For example asciidoc -hm will print the AsciiDoc man
- page.
- * Added {two_colons} and {two_semicolons} attributes for escaping
- labeled list ambiguity.
- * If quirks mode is disabled the XHTML Mime Type is set to the
- recommended application/xhtml+xml (rather than text/html).
-
- Bug fixes
- * Author information is now correctly set when using attribute
- entries in the header instead of an author line (previously the
- author attribute was not being calculated correctly and there were
- attribute substitution problems).
- __________________________________________________________________
-
-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
- <attribution> element is not generated (previously generated empty
- <attribution> element).
- * If the text of a labeled list item is blank then no texttag is
- written.
- * An end of line backslash performs line continuation for horizontal
- labeled list items.
- * The Revision line now accommodates Subversion $Id markers (in
- addition to CVS and RCS markers). Thanks to Tiago Sturmer Daitx for
- this patch.
- * Implemented a2x(1) option --skip-asciidoc which allows a2x(1) to
- convert DocBook XML files not derived from AsciiDoc sources.
- * If a2x(1) --doctype option is not specified it defaults to manpage
- if --format=manpage else defaults to article (previously --doctype
- always defaulted to article).
- * Added an External Resources section to the [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
- {<name>@<regexp>:<value1>[:<value2>]} and
- {<name>$<regexp>:<value1>[:<value2>]}.
- * Safety violations now generate errors (they previously generated
- warnings).
- * asciidoc(1) now defaults to safe mode, consequently the
- [miscellaneous] safe mode entry and --safe command-line option are
- no longer necessary (though for backward compatibility asciidoc(1)
- still accepts the --safe option).
- * Backend Blocks are now flagged unsafe (they could be used to
- include arbitrary and hence potentially unsafe output content).
- * Filters are no longer considered unsafe. There’s not much point in
- insisting on filter safety since the installation of an unsafe
- filter would require the introduction of new or modified
- configuration files — if your application configurations can be
- compromised you’re in all sorts of trouble (safe mode protects
- against unsafe input files not unsafe configuration). As with all
- filters, before installing, you should verify that they can’t be
- coerced into generating malicious output or exposing sensitive
- information.
-
- Bug fixes
- * Fixed a lot of glaring grammatical and factual errors in the User
- Guide.
- __________________________________________________________________
-
-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 <u> tags from generated HTML.
- * Literal Block delimiters must now consist of at least four points
- (previously three) to avoid lone ellipsis ambiguity.
-
- Bug fixes
- * Some system attribute evaluation failures caused unexpected
- exceptions to occur.
- __________________________________________________________________
-
-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 (<hr/> tag). You will get a warning if processed with
- non-HTML backend.
- * An {imagesdir} attribute specifies image file location for images
- referenced in configuration files when generating HTML (the default
- location is images).
- * An {stylesdir} attribute specifies the location of CSS stylesheets
- when generating styled HTML (the default location for configured
- markup is .).
- * The use of the (often inappropriately named) {caption} attribute
- list entry has been deprecated, use {0} instead.
- * New ExampleBlock delimited block along with associated variants
- Note, Tip, Warning, Caution and Important.
- * The docbook.conf file now facilitates the optional inclusion of a
- DocBook revision history file.
- * To better reflect their purpose the following block elements have
- been renamed: VerbatimBlock to ListingBlock; IndentedBlock to
- LiteralBlock; IndentedParagraph to LiteralParagraph; CustomBlock to
- BackendBlock; SimpleSection to SectionBody. Any corresponding CSS
- class names have also been changed which could result in backward
- incompatibility in customized stylesheets.
- * Swapped plain DocBook admonition icons for Jimmac’s DocBook icons
- ([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 [[[<id>]]] is available, it
- displays [<id>] at the anchor location and is for anchoring
- bibliography list entries.
- * An optional single-line titles syntax can be used.
- * Tweaks to distributed CSS stylesheets and FOP fo.xsl customization
- file.
- * List Item Continuation has been implemented which allows additional
- block elements to be included in list items by separating them from
- the preceding list item element with a line containing a single
- plus character.
- * A new Horizontal Labeled List list type has been added. Generates
- two column list — the first column contains the list element
- labels, the second contains the element text. Same syntax as
- Vertical Labeled Lists except the double colon label suffix is
- followed by the start of the list item text.
-
- Bug fixes
- * Fixed broken backslash line continuation.
- * Labeled list end tags were not undergoing attribute substitution.
- * Documents without any author information now generate legitimate
- DocBook (previously if the author line was not included in the
- document header then an empty (illegal) DocBook author element was
- generated).
- * Multiple spaces in filter command arguments were replaced by a
- single space. The ./examples/asciidoc2text/asciidoc2text.sh script
- now indents text correctly.
- __________________________________________________________________
-
-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: ++<primary>,<secondary>,<tertiary>++.
- * Index terms that have secondary and tertiary entries now
- additionally generate separate index terms for the secondary and
- tertiary entries.
- * A +<primary>+ index term inline macro has been added which displays
- the term in the primary text flow.
- * Added alternative variable list definition using double semi-colon
- terminator as opposed to the standard double colon terminator so
- variable lists can be nested to two levels.
- * Footnotes now appear on a separate line in HTML and Linuxdoc
- outputs.
- * Python version compatibility is checked at startup.
- * Preface and appendix section titles in multi-part Book documents
- are meant to be out of sequence — warnings are no longer emitted
- when outputting HTML.
- * Empty section warnings have been replaced by error messages and are
- emitted only if invalid markup would result.
- * Missing macro sections or invalid macro name warnings are only
- generated at startup if the -v (verbose) option is set. Otherwise
- they are deferred until a matching macro is encountered in the
- input file.
- * Missing or invalid table definition warnings are only generated at
- startup if the -v (verbose) option is set. Otherwise they are
- deferred until a matching table is encountered in the input file.
- * AsciiDoc now makes more of an effort to continue in the face of
- errors.
- * Fixed broken ./examples/website/main.aap script.
- * Converted distribution text files DOS text format as a sop to
- Windows users with challenged text editors.
- * Documentation additions and corrections.
- __________________________________________________________________
-
-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 &mdash; entity.
- * Changed the .UNDER-CONSTRUCTION. macro syntax to
- #UNDER-CONSTRUCTION# so it is not mistaken for a BlockTitle.
- Similarly changed the .NEW. replacement with &#35;NEW&#35;.
- * &#35;NEW&#35; 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-<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 {<name>%<value>}.
- * 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:<expr>} glossary references drop the containing line if
- <expr> evaluates to None.
- * Block, Table and Macro arguments can now be positional (quoted or
- unquoted).
- * Vocabulary change: DelimitedBlock, Table and Macro attributes are
- now referred to as arguments. This makes more sense in light of the
- extended syntax and avoids confusion with backend markup tag
- attributes.
- * tablewidth table ruler parameter can now be expressed in percent
- units (0..100). If between 0 and 1 then the original fractional
- unit measure is applied.
- * The use of quoting for generating footnotes and index entries has
- been dropped in favor of footnote and indexterm inline macros.
- * backmatter inline macro included in distribution.
- * Fixed: CSS styled HTML tables are now fully XHTML 1.0 conformant.
- * Fixed: tablewidth was processed incorrectly when passed as table
- argument.
- * Fixed: Glossary references like {x=\{y}} were one character off if
- {x] was defined and {y} was not.
- __________________________________________________________________
-
-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 {<name>!<value>} and
- {<name>#<value>}.
- * The DelimitedBlock params option has been dropped in favor of the
- new block attributes mechanism. If you have customized block params
- options you may need to adjust source files to use the block
- attributes syntax. The example code filter has been updated to
- reflect these changes.
- * The code filter now has a -t tabsize option.
- * Replaced -w option with -v (verbose) option. The warnings option
- was just to confusing.
- * Named attributes can now be specified in macro calls.
- * The tabsize attribute is recognized in the built-in include macros.
- A tabsize of zero suppresses tab expansion.
- * The configuration file [options] section has been split into
- [miscellaneous] and [titles]. If you have customized any of these
- settings you will need to adjust the affected configuration files.
- * Configuration file [miscellaneous] entries can now also be set
- using the command-line -g option.
- * Fixed: error that occurred when attempting to use zero length
- configuration and source files.
- * Fixed: blocking filter halt problem.
- * Fixed: inline macro escape prefix problem.
- * Fixed: missing macros from configuration dump problem.
- * Fixed: named macros were dumped incorrectly.
- * Many documentation changes/additions/corrections.
- __________________________________________________________________
-
-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 {<name>?<value>}.
- <name> is the glossary entry name and <value> is the text
- substituted if the glossary entry is defined. <value> can only
- contain literal text (no glossary references allowed).
- * Added asciidoc2text to distribution examples/asciidoc2text
- directory (converts AsciiDoc source to text file with section
- numbering).
- * Fixed incorrect nesting of Simple lists inside Variable lists.
- * List definitions have been modified so that list items can be
- indented. This allows a more intuitive indentation of nested lists
- in AsciiDoc source.
- * Lists must be separated from preceding paragraphs by a blank line.
- This is to avoid paragraph lines being mistaken for list items.
- * Corrected asciidoc man page documentation error: the`-f` option
- does not search relative to source document directory for the
- configuration file.
- * Minor updates to various distribution .conf files.
- * Included badges.conf in examples directory.
- * css-embedded-stylesheet.conf now supports footer badges.
- * The default in-line element processing order has been changed:
- Glossary References are now processed before Inline Macros. This
- allows glossary expansions to occur inside macro references.
- * Glossary entries are now allowed in Author and Revision lines.
- * Default List subs options and Paragraph presubs options are
- assigned the following default value if not specified:
- specialcharacters,quotes,specialwords,replacements,glossary,macros
- * Documentation changes/additions/corrections.
- __________________________________________________________________
-
-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
deleted file mode 100644
index 5b01600..0000000
--- a/source-builder/sb/asciidoc/CHANGELOG.txt
+++ /dev/null
@@ -1,3128 +0,0 @@
-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 '<tt>' tag with '<code>' 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
- `<theme>.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 `.<ext>=<mimetype>` 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 id="content">...</div>` div envelopes document
- content.
-. You need to add `<div id="footnotes">...</div>` div to the
- `[footnotes]` section for footnotes to work.
-. Drop the `ifdef::toc[]` macro that surround JavaScript inclusion.
-
-Take a look at the [header] and [footer] changes in the xhtml11.conf
-diff to see what's going on:
-http://hg.sharesource.org/asciidoc/diff/55a5999bfd04/xhtml11.conf
-
-
-Version 8.5.0 (2009-10-04)
---------------------------
-.Additions and changes
-- Implemented a 'float' attribute for tables and block images (HTML
- outputs only).
-- Added `unfloat::[]` block macro to cancel floating.
-- Added table 'align' attribute to (HTML outputs only).
-- The image 'align' attribute now works with HTML backends.
-- Renamed table cell 'align' attribute to 'halign' so it doesn't clash
- with the new table 'align' attribute.
-- Added 'breakable' and 'unbreakable' options to AsciiDoc example and
- block image elements.
-- `[miscellaneous]` section entries now update properly when set from
- a document 'AttributeEntry'.
-- `[miscellaneous]` section `pagewidth` entry accepts fractional
- values.
-- Fractional column widths are now calculated correctly when using
- fractional 'pageunits' (DocBook tables).
-- Use DocBook XSL table width processing instructions.
-- asciidoc 'KeyboardInterrupt' exits with error code 1.
-- Added 'set' system attribute to allow attributes to be set from
- configuration file templates.
-- Allow constrained quotes to be bounded on the left by a colons and
- semicolons, see
- http://groups.google.com/group/asciidoc/browse_frm/thread/b276a927fdc87995
-- Titled listing and literal blocks (DocBook outputs) no longer default
- to examples. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd
-- Updated language file table, figure and example captions to
- accommodate new auto-numbering in html4 and xhtml11 backends.
-- Titled source highlight filter listings generated by docbook backend
- are now rendered as examples. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/f4df7c9eec01a9bd
-- Implemented 'counter' system attribute.
-- Use 'counter' system attributes to number titled tables and block
- images in HTML backends.
-- Added program name suffix to console messages.
-- Added substitution to the 'AttributeEntry' passthrough syntax, this
- replaces the now unnecessary 'attributeentry-subs' attribute.
-- Allow passthrough inline macro syntax to be used in
- 'AttributeEntrys'.
-- Reinstated 8.4.4 default 'lang' attribute behavior. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/d29924043e21cb6a.
-- Added 'max-width' attribute to the 'xhtml11' backend to set maximum
- display width. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/74d9a542b79ccd50.
-- Added 'a2x.py', a rewritten and much enhanced version of the old
- 'a2x' bash script.
-- The new 'a2x' can output EPUB formatted documents.
-- Added `--safe` option and deprecated `--unsafe` option. Patch
- submitted by Todd Zullinger. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/ea3a8ea399ae5d2a
- and
- http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5
-- Added 'CHECK' and 'TEST' todo highlight words to Vim syntax
- highlighter.
-- Line breaks, page breaks, and horizontal rulers are now processed by
- dblatex, thanks to a patch submitted by Mark Fernandes
- (http://groups.google.com/group/asciidoc/browse_frm/thread/a254cf949ea7c6c5).
-- Allow footnote macros hard up against the preceding word so the
- rendered footnote mark can be placed against the noted text without
- an intervening space (patch submitted by Stas Bushuev,
- http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5).
-- Normalized path in `safe_filename` function (submitted by Todd
- Zullinger,
- http://groups.google.com/group/asciidoc/browse_frm/thread/69b3183fdab7c6a5).
-- The Asciidoc 'numbered' and 'toc' attributes cause DocBook outputs
- to include `asciidoc-numbered` and `asciidoc-toc` processing
- instructions, these are used by DocBook XSL to include section
- numbering and table of contents (like Asciidoc HTML backends). For
- backward compatibility both 'numbered' and 'toc' attributes are
- defined by default when the 'docbook' backend is used. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/1badad21ff9447ac.
-- 'data-uri' attribute is now evaluated dynamically and can be set in
- document body (previously could only be set from command-line).
-- Added 'sys3' and 'eval3' system attributes to passthrough generated
- output, this fixes the data-uri inline image problem:
- http://groups.google.com/group/asciidoc/browse_frm/thread/a42db6bc54c2c537.
-- Missing language file generates a warning instead of an error.
-- Updated Spanish language file (updates contributed by Gustavo Andrés
- Gómez Farhat).
-
-.Bug fixes
-- *FIXED:* Options in an 'AttributeList' option attribute are merged
- with (rather than replace) configuration file options.
-- *FIXED:* Comment blocks and comment block macros no longer consume
- preceding block titles and attribute lists.
-- *FIXED:* `examples/website/layout1.conf` and
- `examples/website/layout2.conf` TOC problem. Submitted by Mark
- (burtoogle). See
- http://groups.google.com/group/asciidoc/browse_frm/thread/b9c63be67dd1d11c
-- *FIXED:* Only the first occurrence of passthrough macro was
- substituted. Patch submitted by Peter Johnson. See
- http://groups.google.com/group/asciidoc/browse_frm/thread/1269dc2feb1a482c
-- *FIXED:* asciidoc now runs on Jython 2.5.0.
-- *FIXED:* Wordpress margins and pads in a number of block
- elements
- (http://groups.google.com/group/asciidoc/browse_frm/thread/36ff073c79cbc20a).
-
-Regression issues
-~~~~~~~~~~~~~~~~~
-- Tables generated by 'dblatex' occupy 100% of the available space
- regardless of the 'width' attribute setting. To restore width
- behavior change the 'pageunits' miscellaneous parameter to 'pt'. You
- can do this from the command-line with the `-a pageunits=pt` option.
- See {website}userguide.html#X89[DocBook table widths].
-
-
-Version 8.4.5 (2009-05-24)
---------------------------
-.Additions and changes
-- Added manpage 'Name' and 'Synopsis' section title customization to languages
- configuration files.
-- Synopsis manpage section no longer mandatory.
-- Section markup templates can be specified by setting the title's
- first positional attribute or 'template' attribute.
-- The article and book document header can now include a revision
- remark.
-- A 'role' attribute can now be applied to block elements. This adds
- the 'role' attribute to DocBook elements. Patch submitted by
- http://groups.google.com/group/asciidoc/browse_thread/thread/62278a054188a038[Noah
- Slater]).
-- Renamed 'revision' and 'date' attributes to more sensible and consistent
- 'revnumber' and 'revdate' (old names deprecated but still
- recognized).
-- Moved backend specific attributes to Appendix H in User Guide.
-- Renamed and generalized the docbook backend revision history
- inclusion mechanism to 'docinfo' to reflect the use of all article
- or book information elements. The old revision history names still
- work but have been deprecated.
-- Refactored docbook.conf headers.
-- Moved line break replacement from `[replacements]` to
- `[replacements2]` so the replacement occurs after the mailto macro.
- This fixes bug
- http://groups.google.com/group/asciidoc/browse_thread/thread/4bdcdfb0af773e2
-- The typewriter to punctuation apostrophe replacement can be escaped
- with a backslash.
-- Graphviz filter outputs images to 'imagesdir' if it is defined.
-- Made the block image macro generic so that it can be used for filter
- outputs. As a result Music and Graphviz filters:
- * Have been greatly simplified.
- * Honor the 'data-uri' attribute.
- * 'html4' outputs no longer generate W3C validation warning.
-- The 'iconsdir' attribute no longer requires a trailing directory
- separator character.
-- Removed borders around linked html4 images.
-- Added 'html4' specific HTML output for music filter.
-- 'a2x': Added `--unsafe` option (shortcut for
- `--asciidoc-opts=--unsafe`).
-- 'a2x': The FOP executable can now be named `fop` (this is the
- default name in some distributions).
-- Attributes are now substituted in the system macro attribute list.
-- If the output is set to stdout (i.e. no output directory is defined)
- then Music and Graphviz filters will output included images to the
- source file directory.
-- Added 'name' directive to 'testasciidoc'.
-- Added lots of 'testasciidoc' new tests.
-- Moved language specific configuration parameters into `lang-en.conf`
- file.
-- 'lang' attribute entry can be specified in the AsciiDoc source file
- (preceding the header).
-- Removed cruft from A-A-P scripts and documented them.
-- Added German language config file (`lang-de.conf`) contributed by
- Michael Wild.
-- Added French language config file (`lang-fr.conf`) contributed by
- Yves-Alexis Perez.
-- Added Russian language config file (`lang-ru.conf`) contributed by
- Artem Zolochevskiy.
-- Added Hungarian language config file (`lang-hu.conf`) contributed by
- Miklos Vajna.
-
-.Bug fixes
-- *FIXED:* Multiple manpage names are now handled correctly when
- generating DocBook output, each name now generates a separate
- DocBook `<refname>` element. See
- http://groups.google.com/group/asciidoc/browse_thread/thread/c93bb4db025225d8
-- *FIXED:* A problem that caused AttributeEntries preceding the header
- to be overwritten when the language conf file loaded.
-- *FIXED:* Possible inline macro name ambiguity e.g. link matches olink.
-- *FIXED:* The documented macro definition deletion behavior had been
- broken for a long time.
-- *FIXED:* Email addresses not recognized when followed by a period
- character.
-- *FIXED:* Hyphens in mailto macros can delimit nested addresses e.g.
- \bloggs@mail was processed inside
- \mailto:joe-bloggs@mail-server.com[Mail].
-- *FIXED:* User name in FTP URI generated incorrect FTP link. See
- http://groups.google.com/group/asciidoc/browse_thread/thread/1d796a9c9ddb2855
-- *FIXED:* Source highlighter now works with Wordpress backend (see
- http://groups.google.com/group/asciidoc/browse_thread/thread/6d8c716748b109e3).
-
-[[X2]]
-Regression issues
-~~~~~~~~~~~~~~~~~
-. A colon following the date in the AsciiDoc header is treated as a
- revision remark delimiter -- this could be an issue if you have used
- a colon in the header date.
-
-
-Version 8.4.4 (2009-04-26)
---------------------------
-.Additions and changes
-- Added table column and row spanning.
-- Table styles can now be applied per cell.
-- Vertical cell alignment can be applied to columns and individual
- cells.
-- Added table 'align' attribute to set horizontal alignment for entire
- table.
-- Included Geoff Eddy's update of the experimental LaTeX backend.
-- A new attribute named 'trace' controls the output of diagnostic
- information. If the 'trace' attribute is defined then
- element-by-element diagnostic messages detailing output markup
- generation are printed to stderr.
-- Added 'literal' paragraph style (allows 'literal' style to be
- applied to normal paragraphs).
-- Deleted unused `replacements2` from `xhtml11.conf`.
-- Added `replacements2` to default substitutions.
-- 'testasciidoc.py': messages to 'stdout', only diffs to 'stderr'.
-- Added transparency to `smallnew.png` image.
-
-.Bug fixes
-- All combinations of leading comments and attribute entries at the
- start of a document are now skipped correctly.
-- *FIXED:* `./configure` doesn't support `--docdir` as expected (patch
- submitted by Artem Zolochevskiy)
-- *FIXED:* Constrained quotes were incorrectly matched across line
- boundaries e.g. the string `+\nabc+` incorrectly matched a monospace
- quote.
-
-
-Version 8.4.3 (2009-04-13)
---------------------------
-.Additions and changes
-- DocBook outputs default to DocBook version 4.5 doctype (previously
- 4.2).
-- Configuration file `[specialsections]` definitions can be undefined
- by setting their configuration entry values blank.
-- The Makefile 'install' target depends on the 'all' target to ensure
- pre-install patches are applied.
-- 'testasciidoc.py' now emits user friendly messages if:
- . the configuration file is missing.
- . an illegal backend is specified.
- . an illegal test number is specified.
-
-.Bug fixes
-- Fixed
- http://groups.google.com/group/asciidoc/browse_thread/thread/fd27add515597c06[missing
- template section] error.
-- The 'testasciidoc.py' `--force` option no longer deletes test data
- files that were not specified.
-- Dropped second quotes substitution in table cells -- it had
- effectively disabled quote escaping in table cells.
-
-
-Version 8.4.2 (2009-03-19)
---------------------------
-.Additions and changes
-- Added {website}testasciidoc.html[testasciidoc], a tool to verify
- AsciiDoc conformance.
-- A warning is issued if nested inline passthroughs are encountered.
-- 'asciidocapi': setting an attribute value to `None` will undefine
- (delete) the attribute (this in addition to the `name!` attribute
- name format that the `asciidoc(1)` command uses).
-
-.Bug fixes
-
-
-Version 8.4.1 (2009-03-10)
---------------------------
-.Additions and changes
-- AsciiDoc now has a {website}asciidocapi.html[Python API]. The
- following minimal example compiles `mydoc.txt` to `mydoc.html`:
-+
-[source,python]
--------------------------------------------------------------------------------
-from asciidocapi import AsciiDocAPI asciidoc = AsciiDocAPI()
-asciidoc.execute('mydoc.txt')
--------------------------------------------------------------------------------
-
-- Backtick quoting for monospaced text is now implemented as an
- 'inline literal' passthrough. This makes more sense since monospace
- text is usually intended to be rendered literally. See
- <<X2,Regression issues>> below for the impact this may have on
- existing documents. Here are some examples that would previously
- have had to be escaped:
-
- The `++i` and `++j` auto-increments.
- Paths `~/.vim` and `~/docs`.
- The `__init__` method.
- The `{id}` attribute.
-
-- Added `--doctest` option to `asciidoc(1)` command.
-- Added an optional second argument to 'BlockId' element, this sets
- the `{reftext}` attribute which in turn is used to set the `xreflabel`
- attribute in DocBook elements.
-- Added lists to `--help` syntax summary.
-- `{infile}` and `{indir}` attributes reflect the current input file
- (previously always referred to the root document).
-- `{docfile}` (new) and `{docdir}` (previously deprecated) attributes
- refer to the root document specified on the `asciidoc(1)`
- command-line.
-- Vim syntax highlighter improvements.
-- Syntax summary command (`asciidoc -h syntax`) additions.
-- Admonition icons now have transparent backgrounds.
-- Changed yellow W3C badges to blue ones in page footers.
-
-.Bug fixes
-- Dropped `asciidoc(1)` broken undocumented `--profile` option.
-- Em dash replacement now recognized at start of block.
-
-Regression issues
-~~~~~~~~~~~~~~~~~
-Replacing backtick quoting with the 'inline literal' passthrough
-raises two regression scenarios for existing documents:
-
-1. You have escaped the expansion of enclosed inline elements, for
- example: `\{id}`. You would need to delete the backslashes: `{id}`
- (if you don't the backslashes will be printed). Mostly it's just a
- case of interactively finding and replacing of all occurrences of
- `\.
-
-2. There are enclosed inline elements, for example: `some *bold*
- monospaced`. You would need to switch to plus character monospace
- quoting: `+some *bold* monospaced+` (if you don't the enclosed
- elements won't be expanded).
-
-If your existing documents include these cases and you don't want to
-upgrade then use the `-a no-inline-literal` command-line option,
-alternatively put this in `~/.asciidoc/asciidoc.conf`:
-
- [attributes]
- no-inline-literal=
-
-
-Version 8.3.5 (2009-02-02)
---------------------------
-.Additions and changes
-- Cached compiled regular expression delimiters (speed up 'User
- Manual' compilation by 250%).
-- Created distinct list definitions for each numbered list style to
- allow nesting of all styles.
-- Roman numbers in numbered lists are followed by a closing
- parenthesis instead of a period to eliminate 'i', 'v', 'x' item
- ambiguity with respect to alpha numbered list items.
-- Added `**`, `***`, `****`, `*****`
- bulleted lists.
-- Added `...`, `....`, `.....` implicit numbered
- lists.
-- Added `:::`, `::::` labeled lists.
-- Updated User Guide for new list syntaxes.
-- Optimized paragraph and list termination detection with separate
- precompiled regular expressions for performance and to prevent
- reaching Python 100 named group limit.
-- Updated Vim syntax highlighter for new list syntaxes.
-- Allow `template::[]` macros in conf file entries sections (not just
- in template sections).
-- Dropped unused `[listdef-numbered2]` conf file sections.
-- Renamed 'ListBlock' to more appropriate 'OpenBlock'.
-- Implemented single-line versions of `ifdef::[]` and `ifndef::[]`
- macros.
-- 'html4' backend styling:
- * Underlined admonition captions.
- * Added side border to Example Blocks.
-- 'xhtml11' backend styling:
- * Dropped right hand margin from all but quote and verse blocks.
- * html4 backend: corrected over-sized width of caption in admonition
- block.
-
-.Bug fixes
-- Fixed broken numbered list nesting.
-
-Compatibility issues
-~~~~~~~~~~~~~~~~~~~~
-The roman numbered list parenthesis syntax is incompatible with the
-potentially ambiguous roman period syntax introduced in 8.3.2.
-
-
-Version 8.3.4 (2009-01-20)
---------------------------
-.Additions and changes
-- Implemented a title 'float' style. A floating title (or bridgehead)
- is rendered just like a normal section but is not formally
- associated with a text body and is not part of the regular section
- hierarchy so the normal ordering rules do not apply.
-- Implemented inline comment macro so comment lines can now appear
- inside block elements.
-- Comment lines are sent to the output if the 'showcomments' attribute
- is defined (comment blocks are never sent to the output).
-- Single quoting attribute values in 'AttributeList' elements causes
- them to be substituted like normal inline text (without single
- quoting only attribute substitution is performed).
-- Rewrote list item processing (was very crufty). List continuation
- and list blocks now work as expected. Updated and clarified list
- documentation in User Guide.
-- The 'revision' attribute now recognizes the RCS $Id$ marker format.
-- An RCS $Id$ marker formatted revision line in the header does not
- need to be preceded by an author line.
-- If an RCS $Id$ formatted revision is specified and the author name
- has not already been set then the author name in the $Id$ marker
- will be used.
-- Updated Gouichi Iisaka's Graphviz filter to version 1.1.3.
-- Added 'autowidth' table attribute option for (X)HTML outputs.
-- DocBook backend now puts 'orgname' optional attribute in DocBook
- header.
-- Deprecated undocumented 'companyname' attribute in favor of
- DocBook's 'corpname'.
-- Removed explicit closing backslash from HTML4 self-closing tags to
- comply with WC3 recommendation.
-
-.Bug fixes
-- Fixed 8.3.3 regression whereby adjacent lists with the same syntax
- but different list styles were incorrectly treated as a single list.
-
-
-Version 8.3.3 (2009-01-02)
---------------------------
-This release supersedes 8.3.2.
-
-.Bug fixes
-- The broken and confusing numeration and numeration2 numbered list
- attributes have been dropped, use the style attribute instead.
-
-
-Version 8.3.2 (2009-01-01)
---------------------------
-.Additions and changes
-- Added Gouichi Iisaka's Graphviz filter to distribution.
-- The 'SidebarBlock' element can now be rendered with an 'abstract'
- style.
-- Reorganized filters into a separate subdirectory for each filter.
-- Updated `Makefile.in` and `MANIFEST` files to reflect new filters
- organization.
-- Added 'listing' style to 'LiteralBlock' element so listings with
- nested listing blocks can be rendered as a listing block.
-- Changed example 'code' filter to use preferred 'ListingBlock' syntax
- (the old `~` delimited filter syntax is no longer used).
-- Implemented 'enumeration' and 'enumeration2' numbered list
- attributes for specifying the list numbering style ('arabic',
- 'loweralpha', 'upperalpha', 'lowerroman' and 'upperroman').
-- AsciiDoc now recognizes 'upperalpha', 'lowerroman' and 'upperroman'
- numbers in `listdef-numbered2` numbered lists and sets the number
- style based on the style of the first numbered list item
- (alternative to setting 'enumeration2' attribute).
-- Updated `formatlistpat` definition in `.vimrc` example in User
- Guide.
-- You can now backslash escape system block macros.
-- Added 'Pychart' FAQ.
-- Drop paragraph 'text' and list 'text', 'index' and 'label' match
- groups from attributes -- they are included in the element's text
- and we don't want them processed a second time as attributes.
-- Changed comment line block macro to a passthrough block macro to
- ensure no substitutions.
-- A 'subslist' no longer has to be appended to a 'PassthroughBlock'
- macro definition, if omitted no substitutions are performed.
-- Code tidy up: replaced deprecated `<>` operator with `!=`.
-- Removed unused linuxdoc code.
-- Code tidy ups: dropped old types module reference; replaced
- `has_key()` with preferred `in` operator.
-
-.Bug fixes
-- Old syntax source highlight filter regression: special characters
- where not escaped in DocBook outputs.
-
-
-Version 8.3.1 (2008-12-14)
---------------------------
-.Additions and changes
-- Replaced the `install.sh` script with Ben Walton's updated autoconf
- scripts -- see {website}INSTALL.html[INSTALL] for details.
-- Added a generalized 'AttributeEntry' syntax to allow arbitrary
- configuration file entries to be set from within an AsciiDoc
- document (suggested by Henrik Maier).
-- Listing delimited blocks in DocBook outputs now support IDs; IDs of
- titled Listing and Literal delimited blocks have been moved to the
- enclosing DocBook example tag (thanks to Vijay Kumar for this
- patch).
-- Replaced vertical typewriter apostrophe with punctuation apostrophe
- (thanks to Noah Slater).
-
-.Bug fixes
-- Regression: Excluding double-quotes from unquoted attribute values
- resulted in backward incompatibility, double-quotes in unquoted
- attribute values has been reinstated.
-- Regression: Text like `&...;` was sometimes mistaken for an entity
- reference -- tightened up entity reference matching.
-
-
-Version 8.3.0 (2008-11-29)
---------------------------
-.Additions and changes
-- {website}newtables.html[AsciiDoc new tables] is a complete redesign
- of the tables syntax and generation. The new syntax and features are
- a huge improvement over the old tables. The old tables syntax has
- been deprecated but is currently still processed.
-- {website}newlists.html[Lists can now be styled] like other block
- elements. This allows a single list syntax for 'glossary', 'qanda'
- (Question and Answer) and 'bibliography' lists instead of having to
- remember a different syntax for each type.
-- Inline passthroughs macros have been improved and block passthrough
- macros added. Attribute substitution can be optionally specified
- when the macro is called.
-- The passthrough block has a fully transparent passthrough delimited
- block block style called 'pass'.
-- The 'asciimath' and 'latexmath'
- {website}userguide.html#X77[passthrough macros] along with
- 'asciimath' and 'latexmath' {website}userguide.html#X76[passthrough
- blocks] provide a (backend dependent) mechanism for rendering
- mathematical formulas. There are {website}latexmath.pdf[LaTeX Math],
- {website}asciimathml.html[AsciiMathML] and
- {website}latexmathml.html[LaTeXMathML] examples on the AsciiDoc
- website.
-- Reimplemented and cleaned up filter processing based on a patch
- submitted by Kelly Anderson. Uses the newer subprocess module
- instead of the deprecated popen2 module. Now works in Win32 command
- shell.
-- Addition FAQs, more documentation updates.
-- Arbitrary HTML/XML entities can be entered in AsciiDoc source.
-- Did away with the need for the `shaded-literallayout.patch` (thanks
- to Henrik Maier for this patch).
-- Implemented 'page break' block macro.
-- Added 'line breaks' and 'ruler' processing instructions to DocBook
- outputs (thanks to Henrik Maier for this patch).
-- Added 'deg' (degree) and 'wj' (word joiner) entity attributes
- (thanks to Henrik Maier).
-- Tweaked DocBook 'indexterm2' macro to avoid white space preceding
- the term when used in table cells (thanks to Henrik Maier for this
- patch).
-- Title elements now process the 'options' attribute like other block
- elements.
-- Added `single quoted' element.
-- Spaces on both sides of a -- em-dash are translated to thin space
- characters.
-- Improved detection and reporting of malformed attribute lists.
-- The list 'compact' style is now a list option.
-- Added 'strong' labeled list option which makes the labels bold (HTML
- outputs only).
-- Dropped unsupported 'linuxdoc' backend.
-- Dropped deprecated 'xhtml-deprecated' (version 6) backend.
-- Added 'breakable' and 'unbreakable' attribute options to tables to
- control table breaking across page boundaries (DocBook XSL/FO
- outputs). By and in collaboration with Henrik Maier.
-- Added 'pgwide' attribute option to tables to table, block image,
- horizontal labeled lists. Specifies that the element should be
- rendered across the full text width of the page irrespective of the
- current indentation (DocBook XSL/FO outputs). Thanks to Henrik Maier
- for this patch.
-- Vim syntax highlighter: spaces before/after bullets no longer
- highlighted (which is ugly if using a theme that highlights with
- underlines). Thanks to Donald Chai for this patch.
-- Added `a2x(1)` `--fop` option.
-- Added `a2x(1)` `--no-xmllint` option.
-- Highlighted labelled list terms with the navy color in XHTML
- outputs.
-- Use `w3m(1)` as default `a2x(1)` text format generator (fallback to
- `lynx(1)`).
-- Changed callout formats in html4 and xhtml11 outputs to angle
- brackets to match source highlighter rendering.
-- Macros now inject user defined `<optionname>-option` attributes into
- markup.
-- Added IRC URLs to AsciiDoc inline macros.
-- Added `depth` attribute to `include::[]` system macro.
-- Added 'footnoteref' inline macro.
-- Added 'stylesheet' XHTML attribute to specify additional custom CSS
- stylesheet.
-- If a paragraph style is specified it will be added to the XHTML
- 'class' attribute and DocBook 'role' attribute.
-- Replacements can be set in a document using the reserved
- AttributeEntry name 'replacement'.
-- The prefix for auto-generated section name IDs can be set with the
- 'idprefix' attribute.
-
-.Bug fixes
-- Escaped quote skipped over leading and trailing quote instead of
- just the leading quote.
-- Fixed bug that was causing false negative safe mode warnings (patch
- submitted by Julien Palmas).
-- Placed priority of AttributeEntry, AttributeList and BlockTitle
- above Title. This ensures an AttributeEntry, AttributeList or
- BlockTitle followed by a same length leading ListingBlock delimiter
- is not mistaken for a two-line title.
-- Vim syntax highlighter: fixed multi-line quoted text.
-- Contstrained quote termination after non-space character enforced.
-- Vim syntax highlighter: unterminated quoted text is no longer
- highlighted.
-- Vim syntax highlighter: passthroughs now exactly match AsciiDoc
- semantics.
-- Vim syntax highlighter: escaped quoted text, attribute references
- and inline macros are not highlighted.
-- Vim syntax highlighter: TODO's highlighted in CommentBlocks (thanks
- to Scott Wall); non-greedy pass:[$$...$$].
-- Vim syntax highlighter: Comment lines mistaken for vertical list
- labels (thanks to Scott Wall).
-- Vim syntax highlighter: Single unmatched $$ mistakenly highlighted
- remaining text (patch contributed by Scott Wall).
-- Callouts now work in source highlighted listing generated by
- dblatex.
-- Fixed exception that occured if undefined attribute was present in
- filter command.
-- AttributeList block can now follow a paragraph without intervening
- blank line.
-- The include macro tabsize attribute is no longer propagated to
- nested includes.
-
-.Omissions
-The following features were implemented but then but removed from this
-release:
-
-- 'pi', 'cdata' and 'comment' passthrough macros and passthrough block
- styles (creeping featurism, use 'pass' macros instead).
-- Generic 'tag' inline macro (creeping featurism, use 'pass' macros
- instead).
-
-
-[[X1]]
-Compatibility issues
-~~~~~~~~~~~~~~~~~~~~
-Version 8.3.0 has a number of backward incompatibilities with respect
-to the previous 8.2.7 release:
-
-- The old table syntax is still processed but a 'DEPRECATED' warning
- is issued.
-- Entity references have to be escaped with a backslash.
-- You have to explicitly precede horizontal style labeled lists with
- the `[horizontal]` style attribute -- by default all labeled lists
- are rendered vertically.
-- The list 'compact' style has been dropped and is now a list option
- (use `options="compact"` in attribute lists).
-- AsciiDoc version 6 sytnax no longer supported.
-- Linuxdoc been removed from the distribution.
-- The unsupported experimental 'latex' backend has not been tested on
- this release.
-- The introduction of single-quote quoting requires that double-quote
- quoting is escaped with two backslashes.
-
-
-Version 8.2.7 (2008-07-04)
---------------------------
-.Additions and changes
-- Added `dvi`, `ps` and `tex` output format options to a2x(1).
-- Added `--dblatex` option to a2x(1) so `dblatex(1)` can be used to
- generate PDFs.
-- Added custom `dblatex(1)` configuration files (in distribution
- `./dblatex` directory) that are used by a2x(1).
-- `dblatex(1)` is now used to generate the distributed PDF version of
- the AsciiDoc User Guide.
-- If you don't need a customized the link caption you can enter the
- 'http', 'https', 'ftp', 'file' URLs and email addresses without any
- special macro syntax -- you get the links by just cutting and
- pasting URLs and emails addresses. This also makes it easier to open
- links directly form AsciiDoc source ( most editors allow you to open
- URLs directly). The Vim syntax highlighter has been updated to
- reflect these changes.
-- Highlighted source code paragraphs have been implemented -- it's a
- much more convenient way to enter short code examples (see
- http://www.methods.co.nz/asciidoc/source-highlight-filter.html[the
- online docs]).
-- The source highlighter and music filter syntax has changed -- they
- now used the ListingBlock syntax customized with 'source' and
- 'music' style attribute values. This follows the Paragraph styling
- convention introduced by the source paragraph (previous item) and is
- easier to read. The old syntax still works but has been deprecated.
-- QuoteBlocks now have a 'verse' style -- you no longer have to nest a
- 'verse' LiteralBlock inside a QuoteBlock for verses. The 'verse'
- style on the LiteralBlock has been deprecated (still works though)
- and the 'style' attribute is positional attribute 1, pushing
- 'attribution' and 'citetitle' attributes to the right (you'll need
- to insert a 'quote' attribute into your existing QuoteBlocks).
-- It is no up to the DocBook processor to highlight source code syntax
- in `<programlisting>` elements rather than GNU Highlighter -- this
- is the correct way to handle it, plus `dblatex(1)` makes a much
- better job.
-- 'scaledwidth' and 'align' attributes have been added to the 'image'
- macro. They apply to DocBook outputs (specifically for PDF
- documents). 'scaledwidth' sets the image size as a percent of the
- available page width; 'align' applies 'left', 'center' or 'right'
- horizontal image justification.
-- Added a2x(1) `--fop-opts=FOP_OPTS` option (patch submitted by Miklos
- Vajna).
-- Added a2x(1) `--dblatex-opts=DBLATEX_OPTS` option.
-- Added Mikhail Yakshin's FOP 0.95 patch which fixes a long-standing
- `fo.xsl` problem and allows PDF's to be generated with FOP 0.95
- (previously had to use FOP 0.20.5).
-- The User Guide has been updated and outdated FOP configuration and
- installation sections removed.
-
-.Bug fixes
-- Fixed `stylesheets/xhtml11-manpage.css` not being included when
- 'linkcss' attribute was used.
-- Configuration file `*-style` attributes are now dumped correctly.
-- Fixed 'FAILED: malformed section entry' LaTeX backend error.
-
-See the also the https://sharesource.org/hg/asciidoc/[AsciiDoc
-repository changelog].
-
-
-Version 8.2.6 (2008-04-29)
---------------------------
-.Additions and changes
-- Enhancements to the Vim AsciiDoc syntax highlighter, for example,
- quoted text is now highlighted in titles and macro captions.
-- If you define the `data-uri` intrinsic attribute images referenced
- by 'image' macros will be embedded in XHTML using the
- http://en.wikipedia.org/wiki/Data:_URI_scheme[data: URI scheme].
- *NOTE*: Microsoft browser support for the 'data: URI scheme' is
- currently limited to MSIE 8 beta 1.
-- Added `toc-title` attribute to allow custom table of contents
- titles.
-- Added references to Alex Efros's AsciiDoc Cheatsheet to AsciiDoc
- website.
-- `asciidoc(1)` and `a2x(1)` man pages formatted to conform to
- `man-pages(7)` recommendations.
-- Old code-filter syntax (pre-8.1.0) is no longer recognized so that
- malformed two-line level 2 titles are no longer confused with
- 'code-filter' block delimiters.
-- Added -> <- => <= arrow replacements from the Arrows block of
- Unicode.
-- Added DocBook refentry lang attribute -- patch contributed by
- VMiklos.
-- AttributeEntry names can now be numeric (``named macro targets'').
-- Hide Table of Contents title if Table of Contents empty -- patch
- contributed by Alex Efros.
-- Various XHTML CSS tweaks.
-- Code cleanup:
- * Replaced `realpath()` with Python 2.2 `os.path.realpath()` library
- function.
- * Replaced old string library functions with string methods.
- * Use file generators instead of `readlines()`.
- * Renamed entities that shadowed builtins.
- * Standardized string quoting.
- * Dropped `readlines()` function.
-
-.Bug fixes
-- Fixed broken CSS for decimal ordered lists nested in alpha ordered
- list, thanks to Alex Efros.
-- A missing closing block delimiter now reports the opening delimiter
- line number instead of the end of file line number.
-- Fixed an error generated by the asciidoc `-e` option when there are
- no block definitions -- patch contributed by Alejandro Mery.
-- Handle both `\r\n` (as well as `\n`) line separators that may be
- returned by `{sys}` attribute evaluation.
-- Numbered attribute names no longer interfere with positional
- attribute list values.
-
-
-Version 8.2.5 (2007-11-18)
---------------------------
-.Additions and changes
-
-.Bug fixes
-- Fixed exception thrown by illegal command-line arguments.
-- Rolled back the 'with' warning bug fix introduced in 8.2.4 -- it was
- incompatible with Python <2.5.
-
-
-Version 8.2.4 (2007-11-10)
---------------------------
-.Additions and changes
-- You can now use the `lang` attribute to set the DocBook language
- attribute.
-- Attribute values can now contain attribute references.
-- If the `lang` attribute is defined then configuration files named
- like `lang-<lang>.conf` will be loaded automatically.
-- The help file name `help-<lang>.conf` is based on the AsciiDoc
- `lang` attribute, defaults to `help.conf` (English).
-- Admonition, figure and table captions have been factored into a
- predefined set of `caption_*` attributes. They only apply to
- directly generated (X)HTML outputs (DocBook stylesheets generate
- their own language specific captions based on the `lang` attribute).
-- Dropped platform dependent `doc/asciidoc.chm` file from
- distribution documentation formats.
-
-.Bug fixes
-- The spurious warning 'with will become a reserved keyword
- in Python 2.6' has been suppressed.
-
-
-Version 8.2.3 (2007-09-12)
---------------------------
-.Additions and changes
-- Added VMiklos's 'permalink' patch for auto-generated section IDs
- (enabled by default by the `sectids` attribute).
-- Added http://www.methods.co.nz/asciidoc/faq.html[FAQ] to website.
-- Changed format of \{localdate} attribute to ISO 8601 (`%Y-%m-%d`).
-- Added `abc2ly --beams=None` option to make `music2png.py` conform to
- ABC's notion of beams.
-- XHTML level 2 section headings are now styled with an underlining
- border.
-- XHTML links to AsciiDoc title elements are now implemented with
- title ID attributes (previously separate `<a>` element targets were
- generated.
-- Multi-word first, middle and last names can be entered in the header
- author line using the underscore as a word separator.
-- The nested inline macros restriction has now been lifted, for
- example you can now include links and inline images inside
- footnotes.
-- Help topic names can be shortened (so long as they are not
- ambiguous). For example `asciidoc -hm` will print the AsciiDoc man
- page.
-- Added `{two_colons}` and `{two_semicolons}` attributes for
- escaping labeled list ambiguity.
-- If quirks mode is disabled the XHTML Mime Type is set to the
- recommended `application/xhtml+xml` (rather than `text/html`).
-
-.Bug fixes
-- Author information is now correctly set when using attribute entries
- in the header instead of an author line (previously the 'author'
- attribute was not being calculated correctly and there were
- attribute substitution problems).
-
-
-Version 8.2.2 (2007-07-22)
---------------------------
-.Additions and changes
-- http://www.maths.nottingham.ac.uk/personal/drw/lm.html[LaTeXMathML]
- capability has been added for users who are more familiar with or
- prefer LaTeX math formulas to the
- http://www.methods.co.nz/asciidoc/asciimathml.html[ASCIIMathML]
- notation (thanks to Arthur Sakellariou for the patch).
-- The 'source highlight' and 'code' filters now process embedded
- callouts.
-- Added an `--attribute=ATTRIBUTE` option to `a2x(1)` for passing
- attribute values to asciidoc(1) (a shortcut for `--asciidoc-opts="-a
- ATTRIBUTE"`).
-- Image block and inline macros prepend optional `{imagesdir}`
- attribute to image link targets.
-
-
-.Bug fixes
-- Fixed an assertion error that occurred when a configuration file
- containing an `include::[]` macro was loaded using the
- `--conf-file` option and the configuration file name did not
- include an explicit directory path -- patch submitted by Dmitry
- Potapov.
-- Asciidoc titles are only converted to lower case if all characters
- are upper case otherwise case is left unchanged -- patch submitted
- by Dmitry Potapov.
-- Added a missing check that input is not stdin before loading
- configuration files from the document directory -- patch submitted
- by Dmitry Potapov.
-- Attribute list items must evaluate to strings, numbers or None
- (previously it was possible to evaluate to other object types which
- resulted in surprising attribute values).
-- If an AsciiDoc document has no title an empty XHTML 1.1 'title'
- element is created -- previously the 'title' element was dropped
- which resulted in invalid XHTML 1.1.
-- The Vim syntax file no longer highlights escaped callouts.
-- The Vim syntax highlighter now correctly highlights Double-dollar
- passthroughs when they enclose dollar delimited ASCIIMathML and
- LaTeXMathML formulas.
-
-
-Version 8.2.1 (2007-04-06)
---------------------------
-.Additions and changes
-- A number of improvements have been made to the Vim syntax
- highlighter, for example the word C++ is no longer mistaken for the
- start of an unconstrained monospace quote.
-- Labeled list definitions have been tightened -- a list label can no
- longer containing trailing spaces. The following example is no
- longer recognized as a valid list label:
-
- Lorum ipsum ::
-+
-This change implements the originally intended behavior (as per the
-AsciiDoc documentation and examples) so there should be very few
-compatibility issues.
-
-.Bug fixes
-
-
-Version 8.2.0 (2007-04-04)
---------------------------
-.Additions and changes
-- A Vim syntax file is now included in the AsciiDoc distribution
- (inspired by Felix Obenhuber's `asciidoc.vim` script). You can find
- it (along with a Vim filetype detection script in the distribution
- `./vim/` directory (the scripts are installed automatically by the
- AsciiDoc installer `./install.sh`). See 'Appendix J' of the
- 'AsciiDoc User Guide' for details.
-- Added 'toclevel' attribute (1..4) which sets the number of title
- levels reported in the table of contents. Defaults to 2 and must be
- used with the 'toc' attribute. Example usage:
-
- $ asciidoc -a toc -a toclevels=3 doc/asciidoc.txt
-
-- Added a `listindex` attribute which is the current list item index
- (1..). If this attribute appears outside a list its value is the
- number of items in the most recently closed list.
-- The single line titles syntax now accepts trailing suffixes -- this
- syntax matches the title line syntax of a number of popular Wiki
- markups.
-- If a QuoteBlock has no attribution or citetitle then the DocBook
- `<attribution>` element is not generated (previously generated empty
- `<attribution>` element).
-- If the text of a labeled list item is blank then no `texttag` is
- written.
-- An end of line backslash performs line continuation for horizontal
- labeled list items.
-- The Revision line now accommodates Subversion `$Id` markers (in
- addition to CVS and RCS markers). Thanks to Tiago Sturmer Daitx for
- this patch.
-- Implemented `a2x(1)` option `--skip-asciidoc` which allows `a2x(1)`
- to convert DocBook XML files not derived from AsciiDoc sources.
-- If `a2x(1) --doctype` option is not specified it defaults to
- `manpage` if `--format=manpage` else defaults to `article`
- (previously `--doctype` always defaulted to `article`).
-- Added an 'External Resources' section to the
- http://www.methods.co.nz/asciidoc/index.html[AsciiDoc home page].
-
-.Bug fixes
-
-
-Version 8.1.0 (2006-10-22)
---------------------------
-.Additions and changes
-- AsciiDoc generated XHTML documents now display a table of contents
- if the 'toc' attribute is defined (JavaScript needs to be enabled
- for this to work). Thanks to Troy Hanson who contributed this
- feature based on a JavaScript by Mihai Bazon. I've simplified things
- somewhat to match Docbook XSL Stylesheets style, see Troy's
- http://tpl.sourceforge.net/userguide.html[tpl User Guide] for a
- fancier layout. Use the `-a toc -a numbered` command-line options to
- produce a number table of contents.
-- A http://www.methods.co.nz/asciidoc/music-filter.html[music filter]
- is included in the distribution `./filters/` directory. It
- translates music in http://lilypond.org/[LilyPond] or
- http://abcnotation.org.uk/[ABC] notation to standard classical
- notation in the form of a trimmed PNG image which is inserted into
- the AsciiDoc output document.
-- Incorporated Paul Melis's Win32 filter patch. This workaround
- allows AsciiDoc to run filters under Windows.
-- Added `uninstall.sh` script.
-- Rather than proliferate a confusing number of filter block
- delimiters the following convention has been adopted: delimiters
- belonging to DelimitedBlock filters distributed with AsciiDoc will
- consist of a word (normally a noun identifying the block content)
- followed by four or more tilde characters. This has necessitated
- changing existing filter delimiters (the old delimiters still work
- but may be deprecated in future versions):
-
- * The example code filter block delimiter is now the word `code`
- followed by four or more tilde characters.
- * The source highlight filter block delimiter is now the word
- `source` followed by four or more tilde characters.
-
-- Conditionally redefined subscript and superscripting so they use the
- old replacements mechanism when asciidoc7compatible is defined
- rather than the asciidoc 8 default unconstrained quoting (patch for
- affected files attached).
-- Moved the source highlight filter from `./examples/` to `./filter/`.
-- Added `{verbose}` intrinsic attribute (useful for passing verbose
- flag to filters).
-- Added `{outdir}` intrinsic attribute.
-- Renamed `{docdir}` intrinsic attribute to unambiguous `{indir}`
- (`{docdir}` still works but may be removed in future release).
-- If `asciidoc(1)` outputs to stdout then intrinsic attribute
- `{docname}` is extracted from the input file name.
-
-
-Version 8.0.0 (2006-08-27)
---------------------------
-*********************************************************************
-This is a major release because changes to quoting and index entry
-handling may break existing documents (see 'Additions and changes'
-below and 'Appendix A: Migration Notes' in the AsciiDoc User Guide).
-
-Please report any problems you encounter.
-
-mailto:srackham@gmail.com['Stuart Rackham']
-*********************************************************************
-
-.Additions and changes
-- Quoting can can occur within words (based on patch submitted by
- Benjamin Klum). See the 'Unconstrained Quotes' sub-section in the
- User Guide.
-
-- The underline and plus characters can be used as alternatives to the
- existing apostrophe and backtick quote characters. They are arguably
- better choices than the apostrophe and backtick as they are not
- confused with punctuation.
-
-- The syntax for index entry macros have have been deprecated from
- `+...+` and `++...++` to `((...))` and `(((...)))` respectively.
- Rationale:
- * Bracketing is consistent other with `[[...]]` and `<<...>>`
- reference macros.
- * To easily confused with triple plus passthroughs.
- * To make way for the new monospace quoting.
-
-- Superscripts and subscripts are implemented as constrained quotes so
- they can now be escaped with a leading backslash and prefixed with
- with an attribute list.
-
-- An experimental LaTeX backend has been written by Benjamin Klum (a
- number additions in this release are to accommodate the LaTeX
- backend).
-- `include` macro file names now expand environment variables and
- tilde expansions.
-- A configuration file `[quotes]` entry can be undefined by setting to
- a blank value.
-- Added `callto` inline macro for Skype 'callto' links.
-- Added `colnumber` attribute for table data markup.
-- A leading comment block or comment lines are now skipped (previously
- a document had to start with either attribute entries or a document
- Title).
-- Experimental `rows` attribute (number of source lines in table)
- available in table markup templates (used by experimental LaTeX
- backend).
-- Included install shell script written by mailto:jlm@ofb.net[Jacob
- Mandelson] for installing the tarball distribution.
-- Added INSTALL documentation file.
-- Added 'replacements2' substitution options -- a second replacements
- section.
-- Added the ability to redefine 'normal' and 'verbatim' substitutions
- with `subsnormal` and `subsverbatim` entries in configuration file
- `[miscellaneous]` section.
-- By default `AttributeEntry` values are substituted for
- `specialcharacters` and `attributes`, if you want a different
- AttributeEntry substitution set the `attributeentry-subs` attribute.
-- The `name` in `name=value` configuration file entries can now end
- with a backslash, just escape the trailing backslash with a
- backslash. For example:
-
- abc\\=xyz
-+
-Results in `name=abc\` and `value=xyz` -- previously this would have
-escaped the `=` character.
-
-- A blank configuration file section deletes any preceding section
- with the same name (applies to non-markup template sections).
-- A command-line attribute value with a `@` suffix does not override
- existing document and configuration file attributes (normally
- command-line attributes have precedence over document and
- configuration file attributes).
-- `localtime` attribute is now encoded from the native system encoding
- to the output encoding. Patch submitted by
- mailto:m_pupil@yahoo.com.cn[FKtPp] -- here's his description of the
- problem:
-+
-``I am a Chinese user of AsciiDoc and I find that when I use UTF-8
-(the default encoding) to write asciidoc documents in Windows platform
-the resulting html footer line will get screwed. It was caused by a
-localized tzname that was always encoded in the windows native
-encoding, which in my case is 'cp936'.''
-
-- a2x(1) can generate Open Document Text files using
- http://open.comsultia.com/docbook2odf/[docbook2odf]. Currently
- `docbook2odf(1)` only processes a subset of DocBook, unimplemented
- elements are skipped.
-- The a2x(1) format option defaults to `xhtml` (previously a format
- had to be specified explicitly).
-- The `-d, \--doctype=DOCTYPE` option has been added to a2x(1) which
- is a shortcut for `--asciidoc-options="--doctype=DOCTYPE"`.
-- Replaced a2x(1) `--no-icons` and `--no-copy` options with their
- negated equivalents: `--icons` and `--copy` respectively. The
- default behavior has also changed: copying and use of icons is
- disabled by default. Rationale:
- * To make the default behavior more consistent since use of icons
- and CSS stylesheets does not apply to all formats.
- * To make the default behavior less surprising (the creation of icon
- and stylesheet output files must now be explicit).
-
-- a2x(1) has been bumped from version 0.1.1 to version 1.0.0.
-
-
-.Bug fixes
-- Removed duplicate `./doc/a2x.1.txt` from distribution tarball.
-- Documentation errata.
-- Attribute replacement is no longer performed twice in Titles and
- AttributeEntrys.
-- a2x(1) skipped asciidoc(1) execution when rerun with different
- `--asciidoc-options` options, it now always executes asciidoc(1).
- The problem was that previously asciidoc(1) was executed only if the
- output file was missing or older than the source file.
-
-
-Version 7.1.2 (2006-03-07)
---------------------------
-.Additions and changes
-- Support for
- http://www1.chapman.edu/~jipsen/mathml/asciimath.html[ASCIIMathML]
- has been added. See 'Appendix I: ASCIIMathML Support' in the User
- Guide and the examples at
- http://www.methods.co.nz/asciidoc/asciimath.html.
-- You can now prefix quoted text with inline attributes lists. You
- can use this to set font size and color (XHTML and HTML outputs).
-- Added `##...##` quoting -- it does nothing -- it's purpose is to
- allow inline attributes to be applied to normal text.
-- An 'inline passthrough' mechanism has been implemented.
-- Configuration file comment lines can be escaped with a backslash --
- this is to allows the inclusion of configuration lines that start
- with a hash character.
-- The `scriptsdir` attribute can be used to specify the name of the
- directory containing linked JavaScripts (see the
- link:userguide.html#X33[User Guide] for details.
-- The BackendBlock has been renamed PassthroughBlock for consistency
- with the new inline passthrough naming.
-- `a2x(1)` now works with the older `bash(1)` version 2.05b. Patch
- submitted by mailto:francis@daoine.org[Francis Daly].
-- Content included by the `include1::[]` system macro is no longer
- subject to attribute substitution so that ambiguities no longer
- arise when used to include CSS or JavaScript files.
-
-
-Version 7.1.1 (2006-02-24)
---------------------------
-.Additions and changes
-- The `caption` attribute can be used to customize admonition captions
- as well as image, table and example block element title prefixes
- (`xhtml11` and `html4` backends).
-- You can now override the default icon image using the `icon`
- attribute to specify the path of the linked image (xhtml11 and html4
- backends only).
-- The deprecated `imagesdir` attribute is no longer recognized (use
- `iconsdir` instead).
-- Added 'Appendix H: Using AsciiDoc with non-English Languages' to the
- AsciiDoc User Guide.
-- Added 'Admonition Icons and Captions' subsection to the User Guide
- explaining how to customize Admonition elements.
-
-.Bug fixes
-- `a2x(1)` failed when configuration files were installed in the
- global `/etc/asciidoc/` directory -- it was only searching the
- directory containing the asciidoc executable (thanks to Christian
- Wiese for finding and submitting a patch this bug).
-- The html4 backend admonition caption now correctly displays the
- admonition `caption` attribute (previously displayed the `style`
- attribute).
-
-
-Version 7.1.0 (2006-01-13)
---------------------------
-.Additions and changes
-- `a2x(1)` toolchain wrapper utility. This overcomes the biggest
- hurdle for new users which seems to be assembling and using a
- working DocBook XML toolchain. With `a2x(1)` you can generate XHTML
- (chunked and unchunked), PDF, man page, HTML Help and text file
- outputs from an AsciiDoc input file with a single command. All you
- need to install (in addition to AsciiDoc) is xsltproc(1), DocBook XSL
- Stylesheets and optionally FOP (if you want PDF) or lynx(1) (if you
- want text).
-- Block titles can now start with any non-space character (previously
- where not allowed to start with `.~-_` characters).
-- `./stylesheets/docbook.css` renamed to
- `./stylesheets/docbook-xsl.css` to clarify its function.
-- Renamed `./docbook-xsl/manpages.xsl` to `./docbook-xsl/manpage.xsl`
- for consistency.
-- Admonition and navigation icons moved to `./images/icons/` to
- clarify usage and conform with a2x(1) usage.
-- Renamed xhtml11 intrinsic attribute `imagesdir` to `iconsdir` to
- keep vocab consistent and changed default value to `./images/icons`
- (previously `./images`). `imagesdir` attribute still accepted but
- deprecated.
-- Unused image files have been weeded out of the distribution.
-- Packager notes (appendix B) have been updated to reflect the needs
- of `a2x(1)`.
-
-IMPORTANT: The renaming of the xhtml11 backend `imagesdir` intrinsic
-attribute and it's new default value introduces a backward
-compatibility issue: if you use the `icons` attribute you will need to
-either move your icons to the new default `./images/icons` location or
-include an `--attribute{nbsp}iconsdir="your_icons_path"` option in
-your asciidoc commands.
-
-.Bug fixes
-- Backslash line continuation is now observed in verbatim paragraphs.
-- Fixed errors generated by example
- `./examples/website/build-website.sh` script.
-
-
-Version 7.0.4 (2005-12-08)
---------------------------
-.Additions and changes
-- Added ternary conditional attributes
- `{<name>@<regexp>:<value1>[:<value2>]}` and
- `{<name>$<regexp>:<value1>[:<value2>]}`.
-- Safety violations now generate errors (they previously generated
- warnings).
-- asciidoc(1) now defaults to safe mode, consequently the
- `[miscellaneous]` safe mode entry and `--safe` command-line option
- are no longer necessary (though for backward compatibility
- asciidoc(1) still accepts the `--safe` option).
-- Backend Blocks are now flagged unsafe (they could be used to include
- arbitrary and hence potentially unsafe output content).
-- Filters are no longer considered unsafe. There's not much point in
- insisting on filter safety since the installation of an unsafe
- filter would require the introduction of new or modified
- configuration files -- if your application configurations can be
- compromised you're in all sorts of trouble (safe mode protects
- against unsafe input files not unsafe configuration). As with all
- filters, before installing, you should verify that they can't be
- coerced into generating malicious output or exposing sensitive
- information.
-
-.Bug fixes
-- Fixed a lot of glaring grammatical and factual errors in the User
- Guide.
-
-
-Version 7.0.3 (2005-12-01)
---------------------------
-.Additions and changes
-- Added `--safe` and `--unsafe` command-line options -- AsciiDoc can
- now be executed in a 'safe mode' which disallows the execution of
- arbitrary code or the inclusion of arbitrary files (see
- link:userguide.html#X39[Appendix C in the AsciiDoc User Guide]).
-- Included link:source-highlight-filter.html[source-highlight filter]
- in the distribution `./examples/source-highlight-filter/` directory
- (based on filter submitted by mailto:trolocsis@gmail.com[Ryan
- Phillips]).
-- Included the DocBook XSL Stylesheets 1.69.1 customizations used to
- generate the distributed AsciiDoc documentation (read the
- `asciidoc-docbook-xsl.txt` file in the distribution `./docbook-xsl/`
- directory).
-- AsciiDoc DocBook XSL Stylesheet drivers moved from `./doc/` to
- `./docbook-xsl/`.
-- Modified `./doc/manpages.xsl` so only URL content is displayed in
- manpages.
-
-.Bug fixes
-- Explicitly set table CSS border style (`xhtml11` backend) to `solid`
- because default border styles vary from browser to browser.
-
-
-Version 7.0.2 (2005-08-28)
---------------------------
-.Additions and changes
-- There are now long versions of all AsciiDoc options.
-- If the `--backend` is not specified it defaults to `xhtml11`.
-- Added CSS simulated frames layout to the examples website (see
- `./examples/website/layout2/README-website.txt`). This layout does
- not work with IE6 and the original tables based layout is still the
- default.
-- Support page added to AsciiDoc website.
-
-.Bug fixes
-- Invalid options are now trapped gracefully.
-- Documentation errata.
-
-
-Version 7.0.1 (2005-06-24)
---------------------------
-.Additions and changes
-- Reverted to use of `strong`, `em`, `tt` XHTML tags -- they're more
- obvious and no less correct than `span` tags, besides, the generated
- file sizes are smaller (the 'User Guide' was 11% smaller).
-- Table title rendered with `caption` tag rather than a separate
- `div`.
-- The AsciiDoc 'stylesdir' attribute (if specified) is now recognized
- when searching for embedded stylesheets (previously only searched
- default `./stylesheets` directory).
-- Default charset encoding changed from ISO-8859-1 to UTF-8 -- it's
- less language specific and displays most common languages.
-- `template::[]` macros now expand in all configuration file sections
- previously only in markup template sections.
-- Cleaned up example website layout CSS and configuration
- (presentation has not been changed).
-- Refactored `xhtml11.conf` configuration file.
-- Set consistent and sensible permissions on distributed files.
-- White space is now stripped from DSV formatted table cell data.
-- `class="tableblock"` attribute added to tables generated by
- `xhtml-deprecated-css.conf` to assist CSS.
-
-.Bug fixes
-- Illegal character set encoder (specified by the AsciiDoc `encoding`
- attribute) and character data are trapped gracefully.
-- AsciiDoc table 'format' attribute in table attribute lists were not
- recognized.
-- The nested horizontal labeled list example in the 'AsciiDoc User
- Guide' has been dropped -- it generated invalid DocBook markup.
-
-
-Version 7.0.0 (2005-06-06)
---------------------------
-***************************************************
-This is a major release with many code and
-documentation changes.
-Please report any problems you encounter.
-
-mailto:srackham@gmail.com['Stuart Rackham']
-***************************************************
-
-.Additions and changes
-- A new 'xhtml11' backend generates XHTML 1.1 with integrated CSS2
- replacing the previous 'xhtml', 'css', and 'css-embedded' backends.
-- The CSS stylesheets have finally been rewritten.
-- The asciidoc(1) command help now includes user
- link:userguide.html#X36[customizable help] topics. When asciidoc is
- invoked with the `--help` option the command argument is
- interpreted as a help topic.
-- The previous example website has been replaced by the actual
- AsciiDoc website (see `./examples/website/`.
-- XHTML generation options now controlled by the following attributes:
- 'badges', 'linkcss', 'icons', 'numbered', 'quirks', 'theme',
- 'stylesdir', 'imagesdir' (see the link:userguide.html#X33[User
- Guide] for details.
-- By default HTML and XHTML are output as stand-alone documents (no
- embedded CSS and no linked admonition icon images).
-- Documents encoded with the UTF-8 Unicode character set are now
- processed thanks to a patch supplied by
- mailto:viktor@rbg.informatik.tu-darmstadt.de[Viktor Vasilev].
-- The `-a ^name` command-line syntax to undefine an attribute has been
- deprecated in favor of the `-a name!` syntax.
-- AttributeEntry syntax addition: `:name!:` to undefine `name` attribute.
-- Added `template` system block macro to allow the inclusion of one
- configuration file template section within another.
-- A 'verse' style attribute can now be applied to literal paragraphs
- and blocks to reproduce line breaks and white space from the source
- document.
-- Replacements and Special Words can now be escaped with leading
- backslashes.
-- Replacements are now processed in configuration file order (previous
- ordering was indeterminate).
-- System macros can now be used in the base `asciidoc.conf`
- configuration file.
-- Deprecated features that emitted warnings in prior versions are no
- longer tolerated.
-- The `eval` system attribute expression evaluates to `False` the
- attribute is undefined, if it evaluates to `True` the result is an
- empty string.
-- The Paragraph and DelimitedBlock 'presubs' parameter can be aliased
- as 'subs'.
-- Added 'verbatim' substitutions option.
-- Renamed 'List Continuation Block' to 'List Block' and renamed the
- 'listcontinuation' option to 'list'.
-- Deprecated 'default' substitutions option (use 'normal' instead).
-- The 'section-numbers' section numbering attribute has be renamed
- 'numbered'.
-- Dropped the '\#UNDER CONSTRUCTION#' block macro.
-- Rewrote Paragraph and DelimitedBlock handlers adding a
- link:userguide.html#X23[styles] configuration entry.
-
-.Bug fixes
-- Included files are no longer read inside conditionally excluded
- content.
-- Manpage command names containing dashes (in the manpage NAME
- section) were misinterpreted as the spaced dash command name/purpose
- separator. Bug report and patch supplied by
- mailto:david@dgreaves.com[David Greaves].
-- Unexpected error following malformed author line error.
-
-
-Version 6.0.3 (2005-04-20)
---------------------------
-.Additions and changes
-- Special characters are now substituted in AttributeEntry element
- values.
-- Spaced and unspaced em dashes are now recognized (previously only
- spaced em dashes were recognized).
-- Replaced the table 'noborders' option with richer 'frame' and 'grid'
- attributes.
-- The `duplicate macro` warning message now only occurs when the
- verbose (`-v`) option is enabled.
-- Single lines starting with two forward slashes hard up against the
- left margin are treated as comments and are not processed.
-- Renamed 'section' delimited block option to 'sectionbody' to more
- accurately reflect it's role.
-- Added a List Continuation block -- a specialized delimited block
- that is functionally equivalent to the List Item Continuation
- feature except that the list contained within the block does not
- require explicit '+' list item continuation lines.
-- Dropped deprecated `<u>` tags from generated HTML.
-- Literal Block delimiters must now consist of at least four points
- (previously three) to avoid lone ellipsis ambiguity.
-
-.Bug fixes
-- Some system attribute evaluation failures caused unexpected
- exceptions to occur.
-
-
-Version 6.0.2 (2005-03-30)
---------------------------
-.Additions and changes
-- Three new 'system' block macros have been added -- `eval`, `sys` and
- `sys2` which are the block macro equivalents to the same named
- system attributes.
-- 'Intrinsic' macros have been renamed 'system' macros along with
- 'action' attributes which have been renamed 'system' attributes:
- * To reflect their common (though contextually different) behavior.
- * To avoid confusion with 'intrinsic attributes'.
-
-.Bug fixes
-- Asciidoc now searches in `/etc/asciidoc/filters` for filters.
-
-
-Version 6.0.1 (2005-03-06)
---------------------------
-.Additions and changes
-- A global configuration file location `/etc/asciidoc` has been added
- and is now processed before all other locations (patch supplied by
- mailto:stone@debian.org[Fredrik Steen]).
-- Recoded `tempfile.mktemp()` and other artifacts that are no longer
- necessary or desirable (patches supplied by
- mailto:stone@debian.org[Fredrik Steen]).
-- Added BUGS file to the distribution.
-
-.Bug fixes
-- Illegal comment syntax in `css-embedded-stylesheet.conf` resulted in
- illegal CSS in files generated by the `css-embedded` backend.
-
-
-Version 6.0.0 (2005-01-28)
---------------------------
-***************************************************
-This release has had some fairly major code and
-documentation changes. Please report any problems
-you encounter.
-
-mailto:srackham@gmail.com['Stuart Rackham']
-***************************************************
-
-A lot of new stuff. A new major version number -- some regression
-incompatibility (hopefully mitigated by 'deprecated' warnings).
-
-Went mad trying to rein in the current feature anarchy -- established
-a unified notion of document attributes. Attempted to introduce a
-consistent vocabulary -- renamed many poorly or inconsistently named
-entities.
-
-Actually, deprecated syntax is still processed correctly in almost all
-cases. One source of incompatibility that may arise if you have
-customized CSS stylesheets is the change of AsciiDoc CSS class names
-(see below). I guess the moral is if you've done a lot of
-configuration file customization and are happy with version 5 then you
-may want to stay put.
-
-NOTE: This version requires Python 2.3 or better to run.
-
-.Additions and changes
-- 'Glossary entries' have been renamed 'attributes'. This eliminates
- confusion with the accepted meaning of glossary.
-- An `AttributeEntry` block element has been added so that document
- attributes can be assigned from within an AsciiDoc document.
-- The `AttributeList` block element has been added which is a more
- general solution than the (now deprecated) DelimitedBlock arguments.
-- An BlockId element has been added for setting block element anchor
- (link target) IDs.
-- Quoted text can now span multiple lines (thanks to James Bowlin for
- this patch).
-- Inline macros can now span multiple lines.
-- \``double backtick / apostrophe'' quotes generate ``curly quotes''.
-- A warning is now emitted for out of order list item (applies to
- explicitly enumerated numbered list items).
-- Added `include` action attribute.
-- A line of three or more apostrophes generates an HTML horizontal
- ruler (`<hr/>` tag). You will get a warning if processed with
- non-HTML backend.
-- An `{imagesdir}` attribute specifies image file location for images
- referenced in configuration files when generating HTML (the default
- location is `images`).
-- An `{stylesdir}` attribute specifies the location of CSS
- stylesheets when generating styled HTML (the default location for
- configured markup is `.`).
-- The use of the (often inappropriately named) `{caption}` attribute
- list entry has been deprecated, use `{0}` instead.
-- New 'ExampleBlock' delimited block along with associated variants
- Note, Tip, Warning, Caution and Important.
-- The `docbook.conf` file now facilitates the optional inclusion of a
- DocBook revision history file.
-- To better reflect their purpose the following block elements have
- been renamed: `VerbatimBlock` to `ListingBlock`; `IndentedBlock` to
- `LiteralBlock`; `IndentedParagraph` to `LiteralParagraph`;
- `CustomBlock` to `BackendBlock`; `SimpleSection` to `SectionBody`.
- Any corresponding CSS class names have also been changed which could
- result in backward incompatibility in customized stylesheets.
-- Swapped plain DocBook admonition icons for Jimmac's DocBook icons
- (http://jimmac.musichall.cz/ikony.php3). The original plain icons
- have been moved to `./images/plain`.
-- Renamed `html` backend to `xhtml` to better reflect it's function
- (former `html-4` backend renamed to `html`).
-- A new inline anchor macro syntax `[[[<id>]]]` is available, it
- displays `[<id>]` at the anchor location and is for anchoring
- bibliography list entries.
-- An optional 'single-line titles' syntax can be used.
-- Tweaks to distributed CSS stylesheets and FOP `fo.xsl` customization
- file.
-- 'List Item Continuation' has been implemented which allows
- additional block elements to be included in list items by separating
- them from the preceding list item element with a line containing a
- single plus character.
-- A new 'Horizontal Labeled List' list type has been added. Generates
- two column list -- the first column contains the list element
- labels, the second contains the element text. Same syntax as
- `Vertical Labeled Lists` except the double colon label suffix is
- followed by the start of the list item text.
-
-.Bug fixes
-- Fixed broken backslash line continuation.
-- Labeled list end tags were not undergoing attribute substitution.
-- Documents without any author information now generate legitimate
- DocBook (previously if the author line was not included in the
- document header then an empty (illegal) DocBook `author` element was
- generated).
-- Multiple spaces in filter command arguments were replaced by a
- single space. The `./examples/asciidoc2text/asciidoc2text.sh` script
- now indents text correctly.
-
-
-Version 5.1.1 (2004-10-10)
---------------------------
-*15-December-2004: Interim update:* Updated `asciidoc.py` to fix
-broken `join_lines` function -- no other changes.
-
-- PDF documentation is now produced from DocBook XML using XSLTLib and
- FOP. Previously we processed DocBook SGML with `jw(1)` (which used
- Dvips to convert DVI files to PDF). FOP has come a long way in the
- last 12 months and produces very acceptable PDF under both Linux and
- Windows.
-- Sections detailing how to install and use the DocBook XSL
- Stylesheets, xsltproc, FOP toolchain and the AsciiDoc XSLT drivers
- have been added to the User Guide.
-- The PDF output from the he example article template has been
- included in the distribution (`./doc/article.pdf`).
-- Special characters are emitted using decimal Unicode character codes
- (previously used named character entities which cannot be assumed
- included in non-HTML documents).
-- Added registered trademark (R) to `[replacements]`.
-- CSS stylesheet tweaks.
-- Admonitions (Note, Tip, Important, Warning, Caution) include icons
- when generating css output.
-
-
-Version 5.1.0 (2004-09-18)
---------------------------
-- Callouts have been implemented (see the 'Callouts' section of the
- AsciiDoc User Guide for details).
-- Added XSL drivers for generating XHTML, chunked XHTML and HTML Help
- from DocBook XML using XSL stylesheets and xsltproc(1).
-- Added CSS stylesheet for HTML generated from DocBook XML using XSL
- stylesheets.
-- Distribution contains HTML Help formatted User Guide
- (`./doc/asciidoc.chm`), the User Guide tells you how it's generated.
-- Images referred to by distributed stylesheets are now located in the
- `./images` subdirectory (previously located in `.`).
-- Filters path names are now handled properly under Cygwin.
-- The usual documentation and examples additions, updates and
- polishing.
-
-
-Version 5.0.9 (2004-09-09)
---------------------------
-- The convention of using a `.asc` file extension for AsciiDoc files
- has been dropped in favor of the familiar `.txt` extension. It makes
- more sense in that AsciiDoc is a text presentation format and
- because `.asc` clashed with the same extension used by other
- applications. It's only a naming convention -- you don't have to
- switch if you don't want to.
-- Changed the subscript formatting character from underline to tilde
- since underscores in file names are reasonably common (especially in
- link and image macros).
-- An alternative syntax for the index term inline macro has been
- added: `++<primary>,<secondary>,<tertiary>++`.
-- Index terms that have secondary and tertiary entries now
- additionally generate separate index terms for the secondary and
- tertiary entries.
-- A `+<primary>+` index term inline macro has been added which
- displays the term in the primary text flow.
-- Added alternative variable list definition using double semi-colon
- terminator as opposed to the standard double colon terminator so
- variable lists can be nested to two levels.
-- Footnotes now appear on a separate line in HTML and Linuxdoc
- outputs.
-- Python version compatibility is checked at startup.
-- Preface and appendix section titles in multi-part Book documents are
- meant to be out of sequence -- warnings are no longer emitted when
- outputting HTML.
-- Empty section warnings have been replaced by error messages and are
- emitted only if invalid markup would result.
-- Missing macro sections or invalid macro name warnings are only
- generated at startup if the `-v` (verbose) option is set. Otherwise
- they are deferred until a matching macro is encountered in the input
- file.
-- Missing or invalid table definition warnings are only generated at
- startup if the `-v` (verbose) option is set. Otherwise they are
- deferred until a matching table is encountered in the input file.
-- AsciiDoc now makes more of an effort to continue in the face of
- errors.
-- Fixed broken `./examples/website/main.aap` script.
-- Converted distribution text files DOS text format as a sop to
- Windows users with challenged text editors.
-- Documentation additions and corrections.
-
-
-Version 5.0.8 (2004-05-15)
---------------------------
-- Spurious 'out of sequence' level 2 warnings no longer appear when
- processing 'book' document multi-part book top level Preface and
- Appendix sub-sections since they are (correctly) out of sequence.
-- A warning is no longer emitted for empty Index sections since this
- is normal when generating DocBook outputs.
-- Fixed: `[quotes]` configuration file entries where not being
- overridden by downstream configuration file entries.
-- Footnote text is now output enclosed in square brackets in HTML
- documents.
-- Added superscripts and subscripts to the standard PRS configuration
- files.
-- Adjusted CSS stylesheets so list titles don't have so much space
- between title and first list item (broken in IE6 due to poor CSS
- compliance). Lessened sidebar title top margin.
-
-
-Version 5.0.7 (2004-04-22)
---------------------------
-- The version 5.0.6 README incorrectly stated that AsciiDoc would run
- under Python 2.0, in fact it requires Python 2.1 or better. The
- README has been corrected.
-- Documented techniques for combining and splitting AsciiDoc documents
- and processing the combined and split parts (see the 'Tips and
- Tricks' section of the User Guide).
-- An example of marking up superscripts and subscripts is documented
- in the 'Tips and Tricks' section of the User Guide (the example
- configuration file is in the AsciiDoc `examples` directory).
-- Added ellipsis to shipped `[replacements]`; three periods output an
- ellipsis entity.
-- Removed unused 'SectionClose' class.
-- The AsciiDoc 'Preamble' element is output as a DocBook 'Preface'
- when processed as a 'book' document type (in older AsciiDoc versions
- a warning was issued and processing stopped).
-- Fixed a quoting anomaly: quoted text can no longer begin or end with
- with white space.
-
-
-Version 5.0.6 (2004-03-07)
---------------------------
-- New 'image' macro implements optional image scaling and linking and
- works in both inline and block contexts. The 'image' macro obsolesces
- the existing 'graphic' block macro and 'icon' inline macro.
-- Macro substitution section names now have `-inlinemacro` and
- `-blockmacro` suffixes to resolve context ambiguity, make their
- purpose clearer and relieve section namespace congestion.
-- Header derived glossary entries can now be overridden from the
- command-line.
-- Special character substitution is now performed on AuthorLine
- derived author names.
-- A macro or block argument called 'options' can be used as a shortcut
- for a list named arguments with zero length string values.
-- Tables can be output without borders using the `options="noborders"`
- argument.
-- Table data lines that do not immediately follow a table section
- underline can now be blank. This allows CSV data with embedded blank
- lines to be processed correctly.
-- Blank DSV format table data lines are silently skipped.
-- Tightened up on enforcement of configuration file section names to
- reduce the possibility of section content being seen as a section
- header line.
-- Section titles can be optionally suffixed with title arguments
- enclosed in double square brackets.
-- A replacement has been added to `asciidoc.conf` to replace inline
- double dashes with the `&mdash;` entity.
-- Changed the `.UNDER-CONSTRUCTION.` macro syntax to
- `#UNDER-CONSTRUCTION#` so it is not mistaken for a BlockTitle.
- Similarly changed the `.NEW.` replacement with
- `&#35;NEW&#35;`.
-- `&#35;NEW&#35;` and `#UNDER-CONSTRUCTION#` macros are now
- included in the DocBook backend.
-- Replaced shipped `smallnew.gif` with `smallnew.png`.
-- Documentation tidy ups.
-
-
-Version 5.0.5 (2004-02-25)
---------------------------
-- Fixed the disappearing paragraph titles problem that was caused by
- Inline macros (incorrectly) processing BlockTitles.
-- Tightened AuthorLine validation. Previously invalid email addresses
- and embedded special characters in the AuthorLine resulted in
- invalid output markup.
-
-
-Version 5.0.4 (2004-02-09)
---------------------------
-- Reinstated missing `infile`, `outfile`, `filetype` and
- `filetype-<filetype>` glossary entries.
-- As of version 5.0.3 asciidoc(1) now requires Python 2.0 or greater,
- this has now been documented.
-
-
-Version 5.0.3 (2004-01-23)
---------------------------
-- Fixed problem that caused any filters directory file containing
- `.conf` (not just those with the `.conf` extension) from being
- loaded.
-- All `[miscellaneous]` configuration file entries can now be
- referenced like glossary entries (they are now processed internally
- as glossary entries).
-- The output file line terminator (previously hardwired to `\r\n` is
- now set using the `newline` entry in the configuration file
- `[miscellaneous]` section.
-- The misspelt `blocktitles` configuration file entry name has been
- corrected (to `blocktitle`).
-- An `{empty}` glossary entry has been added to the default
- configuration which is useful for outputting trailing blank lines
- from configuration file substitution sections.
-
-
-Version 5.0.2 (2003-12-18)
---------------------------
-- New (alternative) 'anchor' and 'xref' macro syntax (old syntax still
- valid).
-- DocBook `mediaobject` and `inlinemediaobject` tags are generated in
- place of `graphic` and `inlinegraphic` tags by the AsciiDoc
- `graphic` and `icon` macros. If a macro argument is specified it is
- the alternative text output if the target document format does not
- support the specified graphic file format.
-- Dropped the LinuxDoc left and right square bracket special character
- substitutions as they interfered with macro substitution.
-- Documentation updates and corrections.
-
-
-Version 5.0.1 (2003-12-09)
---------------------------
-- Fixed problem with anchor tag when generating CSS styled HTML.
-
-
-Version 5.0 (2003-12-08)
-------------------------
-***************************************************
-This release has had some fairly major code and
-documentation changes. Please report any problems
-you encounter.
-
-mailto:srackham@gmail.com['Stuart Rackham']
-***************************************************
-
-- AsciiDoc can now produce a full-blown multi-part DocBook book
- including dedication, abstract, preface, colophon, glossary,
- appendix, bibliography and book part elements using the new
- `specialsections` configuration file section.
-- All Section element children (Paragraph, DelimitedBlock, List,
- Table, BlockMacro) can now be titled using the BlockTitle element.
- A BlockTitle element is a single line containing a title and
- beginning with a period.
-- The `index` and `backmatter` macros have been dropped, superseded by
- `specialsections`.
-- The AsciiDoc 'Preface' element has been renamed 'Preamble' (to avoid
- confusion with the DocBook book preface element).
-- Out of sequence titles are now tolerated with a warning. This allows
- book document level 0 sections to be processed.
-- An 'anchor' inline macro has been added for document link target
- creation.
-- 'Note', 'Tip', 'Important' and 'Warning' paragraph types have been
- added to support the corresponding DocBook elements.
-- Title substitution is now performed in SidebarBlock titles.
-- DocBook graphics now output as `figure` and `informalfigure`
- elements rather than `mediaobjects`. This ensures numbered figures
- and a lists of figures are produced by the DocBook toolchain.
-- You can now escape block argument lines by appending a backslash.
- Alternatively, if you embed arguments in the delimiter line AsciiDoc
- does not check for an arguments line.
-- The default DocBook backend file extension has been changed from
- `.docbook` to `.xml` (`.sgml` for the 'docbook-sgml' backend).
-- Warnings are output by default (previously they only printed when
- verbose option enabled).
-- A Question and Answer variable list definition has been added to the
- shipped configuration files, primarily to create DocBook `qanda`
- DocBook elements.
-- Fixed broken code-filter `-b linuxdoc` option. The asciidoc.asc User
- Guide can now be processed by linuxdoc(1) (although tables are
- dropped because LinuxDoc does not implement tables).
-
-.Compatibility issues:
-1. Table titles are no longer in the arguments line, use the new
- BlockTitles.
-2. Graphic titles are no longer in the 'graphic' block macro caption,
- use the new BlockTitles.
-3. The code-filter title must be placed in a preceding BlockTitle.
-4. SidebarBlock titles must be placed in a preceding BlockTitle.
-5. The DelimitedBlock option 'sidebar' has been renamed to 'section'.
-6. The default DocBook backend file extension has been changed from
-`.docbook` to `.xml` (`.sgml` for the 'docbook-sgml' backend).
-
-
-Version 4.2 (2003-11-26)
-------------------------
-- The default HTML output is now XHTML 1.0 markup. To output the
- former HTML 4 markup specify the `html-4` backend.
-- The default DocBook output is now DocBook XML. To output the former
- DocBook SGML specify the `docbook-sgml` backend. The associated
- `docbook-sgml.conf` file illustrates how to support minor DTD
- variations. Examples of using the `xmlto(1)` command for DocBook
- conversion have been added to the User Guide.
-- Glossary entries set using the command-line -g option can now be
- referenced in configuration files.
-- Configuration dumps (`-c` command-line option) no longer output
- redundant undefined glossary entries.
-- DelimitedBlock arguments can now be specified in a separate arguments
- line immediately following the leading delimiter line, This is in
- preference to the existing delimiter embedded arguments. Reasons:
- * The syntax is in keeping with the Tables arguments syntax.
- * It's easier to enter and implements line continuation.
-- A new QuoteBlock DelimitedBlock definition has been added to the
- distribution configuration files.
-- The table arguments lines can be continued using the backslash line
- continuation character.
-- Added new calculated glossary reference type `{<name>%<value>}`.
-- Double-quote characters can now appear in unquoted positional
- arguments.
-
-
-Version 4.1 (2003-11-13)
-------------------------
-- Added DSV (Delimiter Separated Values) tables format.
-- `{eval:<expr>}` glossary references drop the containing line if
- `<expr>` evaluates to `None`.
-- Block, Table and Macro arguments can now be positional (quoted or
- unquoted).
-- Vocabulary change: DelimitedBlock, Table and Macro 'attributes' are
- now referred to as 'arguments'. This makes more sense in light of the
- extended syntax and avoids confusion with backend markup tag
- attributes.
-- 'tablewidth' table ruler parameter can now be expressed in percent
- units (0..100). If between 0 and 1 then the original fractional unit
- measure is applied.
-- The use of quoting for generating footnotes and index entries has
- been dropped in favor of 'footnote' and 'indexterm' inline macros.
-- 'backmatter' inline macro included in distribution.
-- Fixed: CSS styled HTML tables are now fully XHTML 1.0 conformant.
-- Fixed: 'tablewidth' was processed incorrectly when passed as table
- argument.
-- Fixed: Glossary references like `{x=\{y}}` were one character off
- if \{x] was defined and `{y}` was not.
-
-
-Version 4.0 (2003-11-08)
-------------------------
-***************************************************
-This release has had some fairly major code and
-documentation changes. Please report any problems
-you encounter.
-
-'Stuart Rackham'
-***************************************************
-
-- Added tables to AsciiDoc.
-- Added two special 'subs' options: 'default' specifies the default
- substitution options and 'none' specifies no substitution. These
- options can only appear singly.
-- Line continuation using a trailing backslash character is available
- in Paragraphs, ListItems, Tables.
-- The left and right quotes for quoted text can now be specified
- separately.
-- Shipped configuration files implement footnotes (only useful for
- DocBook output) using \[[]] quoting.
-- Shipped configuration files implement index terms (only useful for
- DocBook and LinuxDoc output) using \(()) quoting.
-- The shipped 'html' backend configuration now emits valid 'HTML 4.01
- Transitional'.
-- Added new calculated glossary reference types `{<name>!<value>}`
- and `{<name>#<value>}`.
-- The DelimitedBlock 'params' option has been dropped in favor of the
- new 'block attributes' mechanism. If you have customized block
- params options you may need to adjust source files to use the
- 'block attributes' syntax. The example code filter has been updated
- to reflect these changes.
-- The code filter now has a `-t tabsize` option.
-- Replaced `-w` option with `-v` (verbose) option. The warnings option
- was just to confusing.
-- Named attributes can now be specified in macro calls.
-- The 'tabsize' attribute is recognized in the built-in `include`
- macros. A tabsize of zero suppresses tab expansion.
-- The configuration file `[options]` section has been split into
- `[miscellaneous]` and `[titles]`. If you have customized any of
- these settings you will need to adjust the affected configuration
- files.
-- Configuration file `[miscellaneous]` entries can now also be set
- using the command-line `-g` option.
-- Fixed: error that occurred when attempting to use zero length
- configuration and source files.
-- Fixed: blocking filter halt problem.
-- Fixed: inline macro escape prefix problem.
-- Fixed: missing macros from configuration dump problem.
-- Fixed: named macros were dumped incorrectly.
-- Many documentation changes/additions/corrections.
-
-
-Version 3.2.2 (2003-10-26)
---------------------------
-- Added `-n` option (synonym for `-g section-numbers`).
-- Dropped the processing commentary (hey, this is Unix).
-- Added new calculated glossary reference type `{<name>?<value>}`.
- `<name>` is the glossary entry name and `<value>` is the text
- substituted if the glossary entry is defined. `<value>` can only
- contain literal text (no glossary references allowed).
-- Added `asciidoc2text` to distribution `examples/asciidoc2text`
- directory (converts AsciiDoc source to text file with section
- numbering).
-- Fixed incorrect nesting of Simple lists inside Variable lists.
-- List definitions have been modified so that list items can be
- indented. This allows a more intuitive indentation of nested lists
- in AsciiDoc source.
-- Lists must be separated from preceding paragraphs by a blank line.
- This is to avoid paragraph lines being mistaken for list items.
-- Corrected asciidoc man page documentation error: the`-f` option does
- *not* search relative to source document directory for the
- configuration file.
-- Minor updates to various distribution `.conf` files.
-- Included `badges.conf` in `examples` directory.
-- `css-embedded-stylesheet.conf` now supports footer badges.
-- The default in-line element processing order has been changed:
- Glossary References are now processed before Inline Macros. This
- allows glossary expansions to occur inside macro references.
-- Glossary entries are now allowed in Author and Revision lines.
-- Default List `subs` options and Paragraph `presubs` options are
- assigned the following default value if not specified:
-
- specialcharacters,quotes,specialwords,replacements,glossary,macros
-
-- Documentation changes/additions/corrections.
-
-
-Version 3.2 (2003-05-26)
-------------------------
-- Added a `-s` command-line option to suppress the output of
- `[header]` and `[footer]` sections.
-- Article document headers are no longer mandatory: this allows
- AsciiDoc to process arbitrary chunks of text. When used in
- conjunction with the new `-s` command-line option corresponding
- chunks of backend markup can be generated.
-- AsciiDoc now emits a warning message and continues when an out of
- sequence section title is detected (previously it failed and
- halted). This allows document sections to be processed separately.
-- Optional 'presubs' and 'postsubs' entries have been added to
- 'DelimitedBlock' and 'Paragraph' definitions. As a consequence
- substitution options are no longer legal in 'options' entries.
-- 'presubs' and 'postsubs' substitutions are processed in the order
- the options are specified (rather than the fixed 'options' order of
- previous versions).
-- ./filters subdirectories are automatically searched for filter
- commands.
-- A 'title-subs' configuration option specifies the substitutions
- performed on document Header and Section titles.
-- A 'subs' entry in now included in List configuration file
- definitions that specified substitutions performed on list entry
- text.
-- Configuration files are auto-loaded from ./filters subdirectories.
-- Added example code filter (see ./examples/filters).
-- Bug fix: if section was empty you may have got erroneous 'missing
- tag "paragraph"' error.
-- Internal code tidy up.
-
-
-Version 3.1 (2003-05-18)
-------------------------
-- In version 3.0 a `[macros]` section entry of the form 'name' was
- equivalent to 'name='. An entry of the form 'name' now undefines the
- entry (to bring it in line with the behavior of other special
- sections).
-- Paragraphs have now been generalized (in the same way as Lists and
- DelimitedBlocks).
-- The 'indentsize' option has been dropped as as consequence of
- paragraph generalization.
-- Pipe | characters can be included in substituted tag and
- substitution section text using the \{brvbar} (broken vertical bar)
- glossary reference.
-- Removed the restriction requiring substitution section text
- placeholders | to be on a separate line.
-- Added an `-e` asciidoc(1) command option that excludes implicit
- configuration files (used in conjunction with `-c` generated
- configuration files).
-- Version 3.0 documentation has undergone a considerable cleanup.
-- The dumping of quoted section entries (see `-c` option) now works
- correctly.
-- The format of special section entries has been made consistent:
- `name` undefines the entry; `name=` sets the entry value to a blank
- string; `name=value` sets the entry value to `value`.
-- As a consequence of the previous change the caret prefix is no
- longer used in glossary configuration file entries (although it is
- still used when undefining an entry using the `-g` command-line
- option).
-
-
-Version 3.0 (2003-05-13)
-------------------------
-This version is the culmination of work begun in the 2.x releases
-whereby fixed policy has been replaced by extensible mechanisms.
-
-- Added `-c` command-line option to dump a composite asciidoc(1)
- configuration file to stdout.
-- Lists and Delimited Blocks are now defined by a set of configuration
- file parameter sections. The user can modify the default
- definitions or add new ones.
-- Block content can now be processed through external filters.
-- The default behavior for Custom Blocks is to perform glossary
- substitution (previously there was no substitution inside Custom
- Blocks).
-- The old 2.x style macros have been reimplemented; as with Lists and
- Delimited Blocks there syntax and behavior can be configured by the
- user. The default macro syntax remains the same but the semantics
- are now (hopefully) a bit more intelligible.
-- Block and Builtin macros use :: delimiter instead of the 2.x single
- colon delimit (to distinguish them from inline macros). The 2.x
- syntax is still supported for backward compatibility.
-- Nested lists are now supported and IndentedParagraphs can be
- included in list items.
-- Conditional source inclusion can be specified using built in `ifdef`,
- `ifndef` and `endif` macros.
-- The new conditional source inclusion feature has been used to reduce
- the number of default configuration files down to one per backend.
-- A change of name: 2.x 'Substitutions' are now called 'Replacements'
- and the 2.x `[substitutions]` configuration file section is now
- called `[replacements]` (the old name is still recognized for
- backward compatibility).
-- The line break is now implemented as a 'Replacements' substitution.
-- Inline 'icon' macro for inline images has been added to default
- configuration files.
-
-Version 2.2 (2003-04-07)
-------------------------
-- The `master.conf` configuration file name has been deprecated in
- favor of `asciidoc.conf`.
-- The standard configuration files set is now loaded from the
- `.asciidoc` folder in the users home directory (if it exists) and
- then from the source document directory. Configuration files that
- don't exist are silently skipped.
-- Configuration files named like the source file will be automatically
- loaded if they are found in the source file directory. For example
- if the source file is `mydoc.asc` and the `-b html` option is used
- then asciidoc(1) will look for `mydoc.conf` and `mydoc-html.conf` in
- that order.
-- The characters used to quote formatted text can be configured and
- extended by the user (see the master.conf [quotes] section).
-- Quoted text can now be escaped by prefixing a backslash character to
- the leading quote.
-- The double single-quote '' strong text quote has been deprecated in
- favor of an asterisk * character.
-- Added \{eval:expression}, \{sys:command} and \{sys2:command}
- glossary reference actions.
-- Trailing brace characters `}` are now allowed inside glossary
- references provided they are escaped with a backslash character.
-- Glossary entries can now be escaped by prefixing a backslash
- character to the leading brace character (use this in preference to
- placing the backslash inside the brace).
-- The output macro has been deprecated (use the new include1 macro
- inside a CustomBlock).
-- The default document type is `article` (asciidoc no longer attempts
- to guess).
-- Files included within DelimitedBlocks are not searched for block
- termination underlines. This ensures the entire file is part of the
- DelimitedBlock.
-- `include` macros can now be used in configuration files.
-- Corrected \{infile} and \{outfile} glossary entry documentation.
-- File inclusion is now limited to a depth of 5 to catch recursion
- loops.
-- Inline tags have been deprecated, they're not necessary and they
- immediately make the source document backend specific. Use
- CustomBlocks or Substitutions instead.
-
-Version 2.1 (2003-03-17)
-------------------------
-- Added section auto numbering `{sectnum}` glossary entry
- (auto-numbering function contributed by Ludovico Magnocavallo).
-- asciidoc(1) now correctly returns non-zero exit status if an error
- occurs.
-- An AsciiDoc example website has been included in the AsciiDoc
- distribution `examples/website` directory.
-- NOTE: The `asciidoc` wrapper script included in the 2.0 distribution
- has been dropped, if you've symlinked or aliased to `asciidoc` you'll
- need to change them to point directly to `asciidoc.py` instead.
-- An RCS $Id$ marker can be used as the document header revision line
- (based on a patch submitted by Ludovico Magnocavallo).
-- In addition to the `name=value` glossary entry format two new ones
- have been introduced: `name` (the default value is set to an empty
- string) and `^name` (the glossary entry is undefined).
-- The `-q` command-line option has been deprecated and the `-w level`
- command-line option added. +
- NOTE: By default skipped substitution warnings are now suppressed.
-- If a configuration file specified with the `-f` command-line option
- is not found relative to the current working directory then the
- search is repeated relative to the asciidoc(1) directory. This
- allows global configuration files to be used.
-- Added `{infile}`, `{outfile}` predefined glossary entries.
-- Added `under-construction` macro to HTML article configuration
- files.
-- Deprecated `{asciidoc_version}` glossary entry in favor of
- `{asciidoc-version}` (to it consistent with other entries).
-
-Version 2.0 (2003-02-24)
-------------------------
-- The emphasized, strong and monospaced words options have been
- generalized with the introduction of macro based 'special words'
- lists.
-- Glossary references can now appear in both the document and macro
- bodies.
-- All output files use `crlf` line termination (previously used UNIX
- `lf` (newline) termination).
-- Added [substitutions] section which implements arbitrary regular
- expression based substitutions.
-- An optional `master.conf` configuration file can be used for entries
- that are not backend or document type specific.
-- Special character definitions moved from the code to the new
- [special_characters] configuration file section.
-- Configuration file glossary added.
-- Command-line -g glossary entry added.
-- A new 'book' document type has been implemented for the 'docbook'
- backend. It outputs DocBook 'book' documents.
-- A major internal change has been the implementation of parametrized
- user definable 'macros'. Internally most document elements are now
- processed as macros.
-- Configuration file macro variables can be specified with default
- values (literals or other macro variables).
-- An attempt has been made to tighten up the vocabulary used to
- describe the AsciiDoc document syntax.
-- The term abstract has been replaced by the more general term
- 'preface' and a new preface section introduced into article
- configuration files (replacing the synopsis sections).
-- Any section elements can now be put in the document preface
- (previous versions only allowed paragraphs).
-- AsciiDoc Blocks have been unified and their behavior can be user
- defined and parametrized.
-- An 'output' inclusion allows an external file to be written directly
- to the backend output file.
-- A new CustomBlock has been added. Default behavior is to insert the
- enveloped AsciiDoc source lines directly into the output file.
-- A 'line break' tag can be inserted by terminating a line with a '+'
- character (only really useful for HTML backends).
-- An fourth section level has been introduced.
-- The SidebarBlock delimiter line characters have been changed. The
- deprecated underline is still accepted.
-- Levels 2 and 3 title underline characters have been changed. The
- deprecated underlines are still accepted.
-- Lines with backend specific inline tags can be inserted into
- AsciiDoc source files.
-- Single words enveloped by underscores are no longer emphasized. This
- feature was deprecated as it is redundant (use single quotes
- instead) and was being applied to file names with underscores.
-- A `-q` quiet option has been added to suppress warning messages.
-- Badge images sourced locally.
-- Added 'author' and 'author-mail' meta tags to HTML configuration
- files.
-
-Version 1.5 (2003-01-08)
-------------------------
-- Implemented sidebar document elements.
-- Explicit checks for user specified configuration files and input
- file (rather than throwing exception).
-
-Version 1.4 (2003-01-04)
-------------------------
-- New configuration file options 'emphasizedwords' and 'strongwords'.
- These allow the definition of words that will always be emphasized
- or rendered in a strong font without inline formatting.
-- Document and section titles are no long subject to inline
- formatting.
-- Multiple configuration files can be overlaid in a single command.
-- Configuration file tags and options entries can now be overridden on
- an entry by entry basis (previously the entire section was
- overloaded).
-- Configuration file tags and options entries are now cached this has
- resulted in around 37% performance improvement over version 1.3.
-- Variable lists can now contain multiple terms per list item.
-- Placeholder paragraph eliminated from empty sections that contain
- subsections.
-- Added \{asciidoc_version} substitution variable.
-- More documentation additions and tidy ups.
-
-Version 1.3 (2003-01-01)
-------------------------
-- A new 'strong' text formatting convention has been implemented:
- Word phrases enclosed in pairs of single quote characters (acute
- accents) are rendered in a strong font (usually bold).
-- Paragraphs can now be followed immediately by Simple lists and
- Ordered lists without an intervening blank line.
-- A user specified configuration file (`asciidoc(1)` -f option)
- overlays the default configuration file rather than replacing it.
- Custom configuration files need only contain those sections
- that have been customized.
-- Comment Block delimiters have been relaxed slightly. They must start
- with three forward slashes /// but the remainder can contain any
- characters, this allows comments to be embedded in the delimiter line.
-- Leading non-digit characters preceding revision number are now
- ignored.
-- Set default indentsize [option] from 2 to documented default value
- of zero in HTML backend html-article.conf and html-manpage.conf
- files.
-- Fixed error that occurred when taking input from stdin without
- explicitly specifying a document type.
-- Restored file name and line number error message information.
-- Changed deprecated -t option to -d in asciidoc --help and usage
- command output.
-- CSS styles tweaking.
-- Code, configuration file and documentation tidy ups.
-
-Version 1.2 (2002-12-28)
-------------------------
-- Implemented 'include' URL to allow file inclusion.
-- `fileextension` configuration file [option] renamed to more sensible
- `outfilesuffix` (`fileextension` still accepted by this version but
- will be dropped in future).
-- Improved error reporting.
-- CSS backends generate valid XHTML.
-- New `css-embedded` backend generates HTML with embedded stylesheets
- (use the `css` backend for linked stylesheets). The css-embedded
- backend output contains no linked images so the generated html files
- are completely self contained.
-- Bug fixes.
-
-Version 1.1 (2002-12-03)
-------------------------
-- Added css (cascading style sheets) backend
-- Implemented IndentedBlock document element.
-- Tabsize command-line option has been deprecated in
- favor of configuration file.
-- Default indent width changed to zero.
-- Added \{localdate} and \{localtime} substitution variables.
-- Added optional [options] configuration file section with
- fileextension, tabsize and indentsize options.
-- Implemented \{authorinitials} substitution variable.
-- Added https link type.
-- Corrected [graphic] substitution from \{title} to \{caption}
- in linuxdoc-article.conf configuration file.
-- Fixed error that occurred when '==' title underline was
- used.
-
-Version 1.0 (2002-11-25)
-------------------------
-First AsciiDoc public release along with AsciiDoc web site
-(http://www.methods.co.nz/asciidoc/) and SourceForge.net project registration
-(https://sourceforge.net/projects/asciidoc/[]).
-
-// vim: set syntax=asciidoc:
diff --git a/source-builder/sb/asciidoc/COPYING b/source-builder/sb/asciidoc/COPYING
deleted file mode 100644
index a43ea21..0000000
--- a/source-builder/sb/asciidoc/COPYING
+++ /dev/null
@@ -1,339 +0,0 @@
- GNU GENERAL PUBLIC LICENSE
- Version 2, June 1991
-
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
- 675 Mass Ave, Cambridge, MA 02139, USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
- Preamble
-
- The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-License is intended to guarantee your freedom to share and change free
-software--to make sure the software is free for all its users. This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it. (Some other Free Software Foundation software is covered by
-the GNU Library General Public License instead.) You can apply it to
-your programs, too.
-
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
-
- To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
-
- For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
-you have. You must make sure that they, too, receive or can get the
-source code. And you must show them these terms so they know their
-rights.
-
- We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
-
- Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software. If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
-
- Finally, any free program is threatened constantly by software
-patents. We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary. To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at all.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
- GNU GENERAL PUBLIC LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
- 0. This License applies to any program or other work which contains
-a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License. The "Program", below,
-refers to any such program or work, and a "work based on the Program"
-means either the Program or any derivative work under copyright law:
-that is to say, a work containing the Program or a portion of it,
-either verbatim or with modifications and/or translated into another
-language. (Hereinafter, translation is included without limitation in
-the term "modification".) Each licensee is addressed as "you".
-
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
-
- 1. You may copy and distribute verbatim copies of the Program's
-source code as you receive it, in any medium, provided that you
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a fee.
-
- 2. You may modify your copy or copies of the Program or any portion
-of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
- a) You must cause the modified files to carry prominent notices
- stating that you changed the files and the date of any change.
-
- b) You must cause any work that you distribute or publish, that in
- whole or in part contains or is derived from the Program or any
- part thereof, to be licensed as a whole at no charge to all third
- parties under the terms of this License.
-
- c) If the modified program normally reads commands interactively
- when run, you must cause it, when started running for such
- interactive use in the most ordinary way, to print or display an
- announcement including an appropriate copyright notice and a
- notice that there is no warranty (or else, saying that you provide
- a warranty) and that users may redistribute the program under
- these conditions, and telling the user how to view a copy of this
- License. (Exception: if the Program itself is interactive but
- does not normally print such an announcement, your work based on
- the Program is not required to print an announcement.)
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
-
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
- 3. You may copy and distribute the Program (or a work based on it,
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
-
- a) Accompany it with the complete corresponding machine-readable
- source code, which must be distributed under the terms of Sections
- 1 and 2 above on a medium customarily used for software interchange; or,
-
- b) Accompany it with a written offer, valid for at least three
- years, to give any third party, for a charge no more than your
- cost of physically performing source distribution, a complete
- machine-readable copy of the corresponding source code, to be
- distributed under the terms of Sections 1 and 2 above on a medium
- customarily used for software interchange; or,
-
- c) Accompany it with the information you received as to the offer
- to distribute corresponding source code. (This alternative is
- allowed only for noncommercial distribution and only if you
- received the program in object code or executable form with such
- an offer, in accord with Subsection b above.)
-
-The source code for a work means the preferred form of the work for
-making modifications to it. For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable. However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-If distribution of executable or object code is made by offering
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
- 4. You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License. Any attempt
-otherwise to copy, modify, sublicense or distribute the Program is
-void, and will automatically terminate your rights under this License.
-However, parties who have received copies, or rights, from you under
-this License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
- 5. You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or
-distribute the Program or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
-
- 6. Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions. You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
-this License.
-
- 7. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Program at all. For example, if a patent
-license would not permit royalty-free redistribution of the Program by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
-
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices. Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
- 8. If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded. In such case, this License incorporates
-the limitation as if written in the body of this License.
-
- 9. The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Program
-specifies a version number of this License which applies to it and "any
-later version", you have the option of following the terms and conditions
-either of that version or of any later version published by the Free
-Software Foundation. If the Program does not specify a version number of
-this License, you may choose any version ever published by the Free Software
-Foundation.
-
- 10. If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author
-to ask for permission. For software which is copyrighted by the Free
-Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this. Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
-
- NO WARRANTY
-
- 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
-
- 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
-
- END OF TERMS AND CONDITIONS
-
- Appendix: How to Apply These Terms to Your New Programs
-
- If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
- <one line to give the program's name and a brief idea of what it does.>
- Copyright (C) 19yy <name of author>
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
-
- Gnomovision version 69, Copyright (C) 19yy name of author
- Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
- This is free software, and you are welcome to redistribute it
- under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License. Of course, the commands you use may
-be called something other than `show w' and `show c'; they could even be
-mouse-clicks or menu items--whatever suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary. Here is a sample; alter the names:
-
- Yoyodyne, Inc., hereby disclaims all copyright interest in the program
- `Gnomovision' (which makes passes at compilers) written by James Hacker.
-
- <signature of Ty Coon>, 1 April 1989
- Ty Coon, President of Vice
-
-This General Public License does not permit incorporating your program into
-proprietary programs. If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library. If this is what you want to do, use the GNU Library General
-Public License instead of this License.
diff --git a/source-builder/sb/asciidoc/COPYRIGHT b/source-builder/sb/asciidoc/COPYRIGHT
deleted file mode 100644
index 13273f3..0000000
--- a/source-builder/sb/asciidoc/COPYRIGHT
+++ /dev/null
@@ -1,18 +0,0 @@
-Copyright (C) 2000-2007 Stuart Rackham
-
-Email: srackham@gmail.com
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or (at
-your option) any later version.
-
-This program is distributed in the hope that it will be useful, but
-WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-USA.
diff --git a/source-builder/sb/asciidoc/INSTALL b/source-builder/sb/asciidoc/INSTALL
deleted file mode 100644
index cfca794..0000000
--- a/source-builder/sb/asciidoc/INSTALL
+++ /dev/null
@@ -1,235 +0,0 @@
- 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
deleted file mode 100644
index eb07ddd..0000000
--- a/source-builder/sb/asciidoc/INSTALL.txt
+++ /dev/null
@@ -1,227 +0,0 @@
-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 <<X3,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:
-
-[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
deleted file mode 100644
index 68eebb4..0000000
--- a/source-builder/sb/asciidoc/MANIFEST
+++ /dev/null
@@ -1,90 +0,0 @@
-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
deleted file mode 100644
index d8672c3..0000000
--- a/source-builder/sb/asciidoc/Makefile.in
+++ /dev/null
@@ -1,185 +0,0 @@
-#
-# 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
deleted file mode 100644
index 9e5857b..0000000
--- a/source-builder/sb/asciidoc/README
+++ /dev/null
@@ -1,45 +0,0 @@
- 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
deleted file mode 100644
index b53c714..0000000
--- a/source-builder/sb/asciidoc/README.txt
+++ /dev/null
@@ -1,35 +0,0 @@
-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
deleted file mode 100755
index 1b192a2..0000000
--- a/source-builder/sb/asciidoc/a2x.py
+++ /dev/null
@@ -1,960 +0,0 @@
-#!/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 '<AttrDict ' + dict.__repr__(self) + '>'
- 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<arg0>[^"]+)\s*"', cmd)
- if not mo:
- mo = re.match(r'^\s*(?P<arg0>[^ ]+)', 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_<backend name>' 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
deleted file mode 100644
index fab1a22..0000000
--- a/source-builder/sb/asciidoc/asciidoc.conf
+++ /dev/null
@@ -1,647 +0,0 @@
-#
-# asciidoc.conf
-#
-# Asciidoc global configuration file.
-# Contains backend independent configuration settings that are applied to all
-# AsciiDoc documents.
-#
-
-[miscellaneous]
-tabsize=8
-textwidth=70
-newline=\r\n
-
-[attributes]
-backend-alias-html=xhtml11
-backend-alias-docbook=docbook45
-toclevels=2
-toc-placement=auto
-sectids=
-iconsdir=./images/icons
-encoding=UTF-8
-# Uncomment to use xhtml11 quirks mode CSS.
-#quirks=
-# HTML source code highlighter (source-highlight, pygments or highlight).
-source-highlighter=source-highlight
-# Uncomment to use deprecated quote attributes.
-#deprecated-quotes=
-empty=
-sp=" "
-# Attribute and AttributeList element patterns.
-attributeentry-pattern=^:(?P<attrname>\w[^.]*?)(\.(?P<attrname2>.*?))?:(\s+(?P<attrvalue>.*))?$
-attributelist-pattern=(?u)(^\[\[(?P<id>[\w_:][\w_:.-]*)(,(?P<reftext>.*?))?\]\]$)|(^\[(?P<attrlist>.*)\]$)
-# Substitution attributes for escaping AsciiDoc processing.
-amp=&
-lt=<
-gt=>
-brvbar=|
-nbsp=&#160;
-zwsp=&#8203;
-wj=&#8288;
-deg=&#176;
-backslash=\
-two-colons=::
-two-semicolons=;;
-# DEPRECATED: underscore attribute names.
-two_colons=::
-two_semicolons=;;
-# Left and right single and double quote characters.
-# See http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks
-lsquo=&#8216;
-rsquo=&#8217;
-ldquo=&#8220;
-rdquo=&#8221;
-
-[titles]
-subs=specialcharacters,quotes,replacements,macros,attributes,replacements2
-# Double-line title pattern and underlines.
-sectiontitle=^(?P<title>.*?)$
-underlines="==","--","~~","^^","++"
-# Single-line title patterns.
-sect0=^= +(?P<title>[\S].*?)( +=)?$
-sect1=^== +(?P<title>[\S].*?)( +==)?$
-sect2=^=== +(?P<title>[\S].*?)( +===)?$
-sect3=^==== +(?P<title>[\S].*?)( +====)?$
-sect4=^===== +(?P<title>[\S].*?)( +=====)?$
-blocktitle=^\.(?P<title>([^.\s].*)|(\.[^.\s].*))$
-
-[specialcharacters]
-&=&amp;
-<=&lt;
->=&gt;
-
-[quotes]
-# The order is important, quotes are processed in conf file order.
-**=#strong
-*=strong
-``|''=doublequoted
-'=emphasis
-`|'=singlequoted
-ifdef::no-inline-literal[]
-`=monospaced
-endif::no-inline-literal[]
-# +++ and $$ quoting is applied to the +++ and $$ inline passthrough
-# macros to allow quoted attributes to be used.
-# This trick only works with inline passthrough macros.
-+++=#unquoted
-$$=#unquoted
-++=#monospaced
-+=monospaced
-__=#emphasis
-_=emphasis
-\##=#unquoted
-\#=unquoted
-^=#superscript
-~=#subscript
-
-[specialwords]
-emphasizedwords=
-strongwords=
-monospacedwords=
-
-[replacements]
-# Replacements performed in order of configuration file entry. The first entry
-# of each replacement pair performs the (non-escaped) replacement, the second
-# strips the backslash from the escaped replacement.
-
-# (C) Copyright (entity reference &copy;)
-(?<!\\)\(C\)=&#169;
-\\\(C\)=(C)
-
-# (R) registered trade mark (entity reference &reg;
-(?<!\\)\(R\)=&#174;
-\\\(R\)=(R)
-
-# (TM) Trademark (entity reference &trade;)
-(?<!\\)\(TM\)=&#8482;
-\\\(TM\)=(TM)
-
-# -- Spaced and unspaced em dashes (entity reference &mdash;).
-# Space on both sides is translated to thin space characters.
-(^-- )=&#8212;&#8201;
-(\n-- )|( -- )|( --\n)=&#8201;&#8212;&#8201;
-(\w)--(\w)=\1&#8212;\2
-\\--(?!-)=--
-
-# Replace vertical typewriter apostrophe with punctuation apostrophe.
-(\w)'(\w)=\1&#8217;\2
-(\w)\\'(\w)=\1'\2
-
-# ... Ellipsis (entity reference &hellip;)
-(?<!\\)\.\.\.=&#8230;
-\\\.\.\.=...
-
-# Arrows from the Arrows block of Unicode.
-# -> right arrow
-(?<!\\)-&gt;=&#8594;
-\\-&gt;=-&gt;
-# => right double arrow
-(?<!\\)\=&gt;=&#8658;
-\\\=&gt;==&gt;
-# <- left arrow
-(?<!\\)&lt;-=&#8592;
-\\&lt;-=&lt;-
-# <= left double arrow
-(?<!\\)&lt;\==&#8656;
-\\&lt;\==&lt;=
-
-# Arbitrary entity references.
-(?<!\\)&amp;([:_#a-zA-Z][:_.\-\w]*?;)=&\1
-\\(&amp;[:_#a-zA-Z][:_.\-\w]*?;)=\1
-
-#-----------
-# Paragraphs
-#-----------
-[paradef-default]
-delimiter=(?s)(?P<text>\S.*)
-posattrs=style
-style=normal
-template::[paragraph-styles]
-
-[paradef-literal]
-delimiter=(?s)(?P<text>\s+.*)
-options=listelement
-posattrs=style
-style=literal
-template::[paragraph-styles]
-
-[paradef-admonition]
-delimiter=(?s)^\s*(?P<style>NOTE|TIP|IMPORTANT|WARNING|CAUTION):\s+(?P<text>.+)
-template::[paragraph-styles]
-
-[paragraph-styles]
-normal-style=template="paragraph"
-comment-style=template="paragraph",options=('skip',)
-verse-style=template="verseparagraph",posattrs=("style","attribution","citetitle")
-quote-style=template="quoteparagraph",posattrs=("style","attribution","citetitle")
-literal-style=template="literalparagraph",subs=("verbatim",)
-listing-style=template="listingparagraph",subs=("verbatim",)
-example-style=template="exampleparagraph"
-sidebar-style=template="sidebarparagraph"
-abstract-style=template="abstractparagraph"
-partintro-style=template="partintroparagraph"
-NOTE-style=template="admonitionparagraph",name="note",caption="{note-caption}"
-TIP-style=template="admonitionparagraph",name="tip",caption="{tip-caption}"
-IMPORTANT-style=template="admonitionparagraph",name="important",caption="{important-caption}"
-WARNING-style=template="admonitionparagraph",name="warning",caption="{warning-caption}"
-CAUTION-style=template="admonitionparagraph",name="caution",caption="{caution-caption}"
-
-[literalparagraph]
-template::[literalblock]
-
-[verseparagraph]
-template::[verseblock]
-
-[quoteparagraph]
-template::[quoteblock]
-
-[listingparagraph]
-template::[listingblock]
-
-[exampleparagraph]
-template::[exampleblock]
-
-[sidebarparagraph]
-template::[sidebarblock]
-
-[abstractparagraph]
-template::[abstractblock]
-
-[partintroparagraph]
-template::[partintroblock]
-
-
-[macros]
-#--------------
-# Inline macros
-#--------------
-# Backslash prefix required for escape processing.
-# (?s) re flag for line spanning.
-
-# Macros using default syntax.
-(?su)(?<!\w)[\\]?(?P<name>http|https|ftp|file|irc|mailto|callto|image|link|anchor|xref|indexterm):(?P<target>\S*?)\[(?P<attrlist>.*?)(?<!\\)\]=
-
-# These URL types don't require any special attribute list formatting.
-(?su)(?<!\S)[\\]?(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])=
-# Allow a leading parenthesis and square bracket.
-(?su)(?<\=[([])[\\]?(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])=
-# Allow <> brackets.
-(?su)[\\]?&lt;(?P<name>http|https|ftp|file|irc):(?P<target>//[^\s<>]*[\w/])&gt;=
-
-# Email addresses don't require special attribute list formatting.
-# The before ">: and after "< character exclusions stop multiple substitution.
-(?su)(?<![">:\w._/-])[\\]?(?P<target>\w[\w._-]*@[\w._-]*\w)(?!["<\w_-])=mailto
-
-# Allow footnote macros hard up against the preceding word so the footnote mark
-# can be placed against the noted text without an intervening space
-# (http://groups.google.com/group/asciidoc/browse_frm/thread/e1dcb7ee0efc17b5).
-(?su)[\\]?(?P<name>footnote|footnoteref):(?P<target>\S*?)\[(?P<attrlist>.*?)(?<!\\)\]=
-
-# Anchor: [[[id]]]. Bibliographic anchor.
-(?su)[\\]?\[\[\[(?P<attrlist>[\w_:][\w_:.-]*?)\]\]\]=anchor3
-# Anchor: [[id,xreflabel]]
-(?su)[\\]?\[\[(?P<attrlist>[\w"_:].*?)\]\]=anchor2
-# Link: <<id,text>>
-(?su)[\\]?&lt;&lt;(?P<attrlist>[\w"_:].*?)&gt;&gt;=xref2
-
-ifdef::asciidoc7compatible[]
-# Index term: ++primary,secondary,tertiary++
-(?su)(?<!\S)[\\]?\+\+(?P<attrlist>[^+].*?)\+\+(?!\+)=indexterm
-# Index term: +primary+
-# Follows ++...++ macro otherwise it will match them.
-(?<!\S)[\\]?\+(?P<attrlist>[^\s\+][^+].*?)\+(?!\+)=indexterm2
-endif::asciidoc7compatible[]
-
-ifndef::asciidoc7compatible[]
-# Index term: (((primary,secondary,tertiary)))
-(?su)(?<!\()[\\]?\(\(\((?P<attrlist>[^(].*?)\)\)\)(?!\))=indexterm
-# Index term: ((primary))
-# Follows (((...))) macro otherwise it will match them.
-(?<!\()[\\]?\(\((?P<attrlist>[^\s\(][^(].*?)\)\)(?!\))=indexterm2
-endif::asciidoc7compatible[]
-
-# Callout
-[\\]?&lt;(?P<index>\d+)&gt;=callout
-
-# Passthrough macros.
-(?su)[\\]?(?P<name>pass):(?P<subslist>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=[]
-
-# Triple-plus and double-dollar inline passthroughs.
-(?su)[\\]?\+\+\+(?P<passtext>.*?)\+\+\+=pass[]
-(?su)[\\]?\$\$(?P<passtext>.*?)\$\$=pass[specialcharacters]
-
-# Inline literal.
-ifndef::no-inline-literal[]
-(?su)(?<![`\w])([\\]?`(?P<passtext>[^`\s]|[^`\s].*?\S)`)(?![`\w])=literal[specialcharacters]
-endif::no-inline-literal[]
-
-# Inline comment.
-(?mu)^[\\]?//(?P<passtext>[^/].*|)$=comment[specialcharacters]
-
-# Default (catchall) inline macro is not implemented so there is no ambiguity
-# with previous definition that could result in double substitution of escaped
-# references.
-#(?su)[\\]?(?P<name>\w(\w|-)*?):(?P<target>\S*?)\[(?P<passtext>.*?)(?<!\\)\]=
-
-#-------------
-# Block macros
-#-------------
-# Macros using default syntax.
-(?u)^(?P<name>image|unfloat|toc)::(?P<target>\S*?)(\[(?P<attrlist>.*?)\])$=#
-
-# Passthrough macros.
-(?u)^(?P<name>pass)::(?P<subslist>\S*?)(\[(?P<passtext>.*?)\])$=#
-
-^'{3,}$=#ruler
-^<{3,}$=#pagebreak
-^//(?P<passtext>[^/].*|)$=#comment[specialcharacters]
-
-# Implemented in HTML backends.
-[unfloat-blockmacro]
-[toc-blockmacro]
-
-#-----------------
-# Delimited blocks
-#-----------------
-[blockdef-comment]
-delimiter=^/{4,}$
-options=skip
-posattrs=style
-
-[blockdef-sidebar]
-delimiter=^\*{4,}$
-template=sidebarblock
-options=sectionbody
-posattrs=style
-# DEPRECATED: Use Openblock instead.
-abstract-style=template="abstractblock"
-
-[blockdef-open]
-# A block without opening or closing tags.
-delimiter=^--$
-posattrs=style
-style=default
-default-style=template="openblock",options=("sectionbody",)
-comment-style=template="openblock",options=("skip",)
-abstract-style=template="abstractblock",options=("sectionbody",)
-partintro-style=template="partintroblock",options=("sectionbody",)
-example-style=template="exampleblock",options=("sectionbody",)
-sidebar-style=template="sidebarblock",options=("sectionbody",)
-verse-style=template="verseblock",posattrs=("style","attribution","citetitle")
-quote-style=template="quoteblock",posattrs=("style","attribution","citetitle"),options=("sectionbody",)
-literal-style=template="literalparagraph",subs=("verbatim",)
-listing-style=template="listingparagraph",subs=("verbatim",)
-NOTE-style=template="admonitionblock",name="note",caption="{note-caption}",options=("sectionbody",)
-TIP-style=template="admonitionblock",name="tip",caption="{tip-caption}",options=("sectionbody",)
-IMPORTANT-style=template="admonitionblock",name="important",caption="{important-caption}",options=("sectionbody",)
-WARNING-style=template="admonitionblock",name="warning",caption="{warning-caption}",options=("sectionbody",)
-CAUTION-style=template="admonitionblock",name="caution",caption="{caution-caption}",options=("sectionbody",)
-
-[blockdef-pass]
-delimiter=^\+{4,}$
-template=passblock
-# Default subs choosen for backward compatibility.
-subs=attributes,macros
-posattrs=style
-pass-style=template="passblock",subs=()
-
-[blockdef-listing]
-delimiter=^-{4,}$
-template=listingblock
-subs=verbatim
-posattrs=style
-
-[blockdef-literal]
-delimiter=^\.{4,}$
-template=literalblock
-subs=verbatim
-posattrs=style
-listing-style=template="listingblock"
-# DEPRECATED: Use verse style on quote blocks instead.
-verse-style=template="verseblock",subs="normal"
-
-[blockdef-quote]
-delimiter=^_{4,}$
-subs=normal
-style=quote
-posattrs=style,attribution,citetitle
-quote-style=template="quoteblock",options=("sectionbody",)
-verse-style=template="verseblock"
-
-[blockdef-example]
-delimiter=^={4,}$
-template=exampleblock
-options=sectionbody
-posattrs=style
-NOTE-style=template="admonitionblock",name="note",caption="{note-caption}"
-TIP-style=template="admonitionblock",name="tip",caption="{tip-caption}"
-IMPORTANT-style=template="admonitionblock",name="important",caption="{important-caption}"
-WARNING-style=template="admonitionblock",name="warning",caption="{warning-caption}"
-CAUTION-style=template="admonitionblock",name="caution",caption="{caution-caption}"
-
-# For use by custom filters.
-# DEPRECATED: No longer used, a styled listing block (blockdef-listing) is preferable.
-[blockdef-filter]
-delimiter=^~{4,}$
-template=listingblock
-subs=none
-posattrs=style
-
-#-------
-# Lists
-#-------
-[listdef-bulleted]
-# - bullets.
-delimiter=^\s*- +(?P<text>.+)$
-posattrs=style
-type=bulleted
-tags=bulleted
-callout-style=tags="callout"
-bibliography-style=tags="bibliography"
-
-[listdef-bulleted1]
-# * bullets.
-template::[listdef-bulleted]
-delimiter=^\s*\* +(?P<text>.+)$
-
-[listdef-bulleted2]
-# ** bullets.
-template::[listdef-bulleted]
-delimiter=^\s*\*{2} +(?P<text>.+)$
-
-[listdef-bulleted3]
-# *** bullets.
-template::[listdef-bulleted]
-delimiter=^\s*\*{3} +(?P<text>.+)$
-
-[listdef-bulleted4]
-# **** bullets.
-template::[listdef-bulleted]
-delimiter=^\s*\*{4} +(?P<text>.+)$
-
-[listdef-bulleted5]
-# ***** bullets.
-template::[listdef-bulleted]
-delimiter=^\s*\*{5} +(?P<text>.+)$
-
-[listdef-arabic]
-# Arabic numbering.
-delimiter=^\s*(?P<index>\d+\.) +(?P<text>.+)$
-posattrs=style
-type=numbered
-tags=numbered
-style=arabic
-
-[listdef-loweralpha]
-# Lower alpha numbering.
-template::[listdef-arabic]
-delimiter=^\s*(?P<index>[a-z]\.) +(?P<text>.+)$
-style=loweralpha
-
-[listdef-upperalpha]
-# Upper alpha numbering.
-template::[listdef-arabic]
-delimiter=^\s*(?P<index>[A-Z]\.) +(?P<text>.+)$
-style=upperalpha
-
-[listdef-lowerroman]
-# Lower roman numbering.
-template::[listdef-arabic]
-delimiter=^\s*(?P<index>[ivx]+\)) +(?P<text>.+)$
-style=lowerroman
-
-[listdef-upperroman]
-# Upper roman numbering.
-template::[listdef-arabic]
-delimiter=^\s*(?P<index>[IVX]+\)) +(?P<text>.+)$
-style=upperroman
-
-[listdef-numbered1]
-# . numbering.
-template::[listdef-arabic]
-delimiter=^\s*\. +(?P<text>.+)$
-
-[listdef-numbered2]
-# .. numbering.
-template::[listdef-loweralpha]
-delimiter=^\s*\.{2} +(?P<text>.+)$
-
-[listdef-numbered3]
-# ... numbering.
-template::[listdef-lowerroman]
-delimiter=^\s*\.{3} +(?P<text>.+)$
-
-[listdef-numbered4]
-# .... numbering.
-template::[listdef-upperalpha]
-delimiter=^\s*\.{4} +(?P<text>.+)$
-
-[listdef-numbered5]
-# ..... numbering.
-template::[listdef-upperroman]
-delimiter=^\s*\.{5} +(?P<text>.+)$
-
-[listdef-labeled]
-# label:: item.
-delimiter=^\s*(?P<label>.*[^:])::(\s+(?P<text>.+))?$
-posattrs=style
-type=labeled
-tags=labeled
-vertical-style=tags="labeled"
-horizontal-style=tags="horizontal"
-glossary-style=tags="glossary"
-qanda-style=tags="qanda"
-
-[listdef-labeled2]
-# label;; item.
-template::[listdef-labeled]
-delimiter=^\s*(?P<label>.*[^;]);;(\s+(?P<text>.+))?$
-
-[listdef-labeled3]
-# label::: item.
-template::[listdef-labeled]
-delimiter=^\s*(?P<label>.*[^:]):{3}(\s+(?P<text>.+))?$
-
-[listdef-labeled4]
-# label:::: item.
-template::[listdef-labeled]
-delimiter=^\s*(?P<label>.*[^:]):{4}(\s+(?P<text>.+))?$
-
-[listdef-callout]
-posattrs=style
-delimiter=^<?(?P<index>\d*>) +(?P<text>.+)$
-type=callout
-tags=callout
-style=arabic
-
-# DEPRECATED: Old list syntax.
-[listdef-qanda]
-posattrs=style
-delimiter=^\s*(?P<label>.*\S)\?\?$
-type=labeled
-tags=qanda
-
-# DEPRECATED: Old list syntax.
-[listdef-bibliography]
-posattrs=style
-delimiter=^\+ +(?P<text>.+)$
-type=bulleted
-tags=bibliography
-
-# DEPRECATED: Old list syntax.
-[listdef-glossary]
-delimiter=^(?P<label>.*\S):-$
-posattrs=style
-type=labeled
-tags=glossary
-
-#-------
-# Tables
-#-------
-[tabledef-default]
-delimiter=^\|={3,}$
-posattrs=style
-template=table
-default-style=tags="default"
-verse-style=tags="verse"
-literal-style=tags="literal",subs=("specialcharacters",)
-emphasis-style=tags="emphasis"
-strong-style=tags="strong"
-monospaced-style=tags="monospaced"
-header-style=tags="header"
-asciidoc-style=tags="asciidoc",subs=(),filter='"{python}" "{asciidoc-file}" -b {backend} {asciidoc-args}{lang? -a "lang={lang}@"}{icons? -a icons -a "iconsdir={iconsdir}"}{imagesdir? -a "imagesdir={imagesdir}"}{data-uri? -a data-uri} -a "indir={indir}"{trace? -a "trace={trace}"}{blockname? -a "blockname={blockname}"} -s -'
-
-[tabledef-nested]
-# Same as [tabledef-default] but with different delimiter and separator.
-delimiter=^!={3,}$
-separator=((?<!\S)((?P<span>[\d.]+)(?P<op>[*+]))?(?P<align>[<\^>.]{,3})?(?P<style>[a-z])?)?!
-posattrs=style
-template=table
-verse-style=tags="verse"
-literal-style=tags="literal",subs=("specialcharacters",)
-emphasis-style=tags="emphasis"
-strong-style=tags="strong"
-monospaced-style=tags="monospaced"
-header-style=tags="header"
-asciidoc-style=tags="asciidoc",subs=(),filter='"{python}" "{asciidoc-file}" -b {backend} {asciidoc-args}{lang? -a "lang={lang}@"}{icons? -a icons -a "iconsdir={iconsdir}"}{imagesdir? -a "imagesdir={imagesdir}"}{data-uri? -a data-uri} -a "indir={indir}"{trace? -a "trace={trace}"}{blockname? -a "blockname={blockname}"} -s -'
-
-#----------------------------------------
-# Common block and macro markup templates
-#----------------------------------------
-[comment-inlinemacro]
-# Outputs nothing.
-
-[comment-blockmacro]
-# Outputs nothing.
-
-[pass-blockmacro]
-{passtext}
-
-[pass-inlinemacro]
-template::[pass-blockmacro]
-
-[passblock]
-|
-
-[filter-image-blockmacro]
-# Synthesize missing target attribute for filter generated file names.
-# The tag split | ensures missing target file names are auto-generated
-# before the filter is executed, the remainder (the [image-blockmacro])
-# is excuted after the filter to ensure data URI encoding comes after
-# the image is created.
-{target%}{counter2:target-number}
-{target%}{set2:target:{docname}__{target-number}.png}
-|
-template::[image-blockmacro]
-
-[+docinfo]
-# Blank section to suppress missing template warning.
-
-#----------------------------------
-# Default special section templates
-#----------------------------------
-[abstract]
-template::[sect1]
-
-[colophon]
-template::[sect1]
-
-[dedication]
-template::[sect1]
-
-[preface]
-template::[sect1]
-
-[appendix]
-template::[sect1]
-
-[glossary]
-template::[sect1]
-
-[bibliography]
-template::[sect1]
-
-[index]
-template::[sect1]
-
-[synopsis]
-template::[sect1]
-
-#--------------------------------------------------------------------
-# Deprecated old table definitions.
-#
-
-[old_tabledef-default]
-fillchar=-
-format=fixed
-
-[old_tabledef-csv]
-fillchar=~
-format=csv
-
-[old_tabledef-dsv]
-fillchar=_
-format=dsv
-
-# End of deprecated old table definitions.
-#--------------------------------------------------------------------
diff --git a/source-builder/sb/asciidoc/asciidoc.py b/source-builder/sb/asciidoc/asciidoc.py
deleted file mode 100755
index 8c68895..0000000
--- a/source-builder/sb/asciidoc/asciidoc.py
+++ /dev/null
@@ -1,6260 +0,0 @@
-#!/usr/bin/env python
-"""
-asciidoc - converts an AsciiDoc text file to HTML or DocBook
-
-Copyright (C) 2002-2010 Stuart Rackham. Free use of this software is granted
-under the terms of the GNU General Public License (GPL).
-"""
-
-import sys, os, re, time, traceback, tempfile, subprocess, codecs, locale, unicodedata, copy
-
-### Used by asciidocapi.py ###
-VERSION = '8.6.8' # See CHANGLOG file for version history.
-
-MIN_PYTHON_VERSION = '2.4' # Require this version of Python or better.
-
-#---------------------------------------------------------------------------
-# Program constants.
-#---------------------------------------------------------------------------
-DEFAULT_BACKEND = 'html'
-DEFAULT_DOCTYPE = 'article'
-# Allowed substitution options for List, Paragraph and DelimitedBlock
-# definition subs entry.
-SUBS_OPTIONS = ('specialcharacters','quotes','specialwords',
- 'replacements', 'attributes','macros','callouts','normal','verbatim',
- 'none','replacements2','replacements3')
-# Default value for unspecified subs and presubs configuration file entries.
-SUBS_NORMAL = ('specialcharacters','quotes','attributes',
- 'specialwords','replacements','macros','replacements2')
-SUBS_VERBATIM = ('specialcharacters','callouts')
-
-NAME_RE = r'(?u)[^\W\d][-\w]*' # Valid section or attribute name.
-OR, AND = ',', '+' # Attribute list separators.
-
-
-#---------------------------------------------------------------------------
-# Utility functions and classes.
-#---------------------------------------------------------------------------
-
-class EAsciiDoc(Exception): pass
-
-class OrderedDict(dict):
- """
- Dictionary ordered by insertion order.
- Python Cookbook: Ordered Dictionary, Submitter: David Benjamin.
- http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/107747
- """
- def __init__(self, d=None, **kwargs):
- self._keys = []
- if d is None: d = kwargs
- dict.__init__(self, d)
- def __delitem__(self, key):
- dict.__delitem__(self, key)
- self._keys.remove(key)
- def __setitem__(self, key, item):
- dict.__setitem__(self, key, item)
- if key not in self._keys: self._keys.append(key)
- def clear(self):
- dict.clear(self)
- self._keys = []
- def copy(self):
- d = dict.copy(self)
- d._keys = self._keys[:]
- return d
- def items(self):
- return zip(self._keys, self.values())
- def keys(self):
- return self._keys
- def popitem(self):
- try:
- key = self._keys[-1]
- except IndexError:
- raise KeyError('dictionary is empty')
- val = self[key]
- del self[key]
- return (key, val)
- def setdefault(self, key, failobj = None):
- dict.setdefault(self, key, failobj)
- if key not in self._keys: self._keys.append(key)
- def update(self, d=None, **kwargs):
- if d is None:
- d = kwargs
- dict.update(self, d)
- for key in d.keys():
- if key not in self._keys: self._keys.append(key)
- def values(self):
- return map(self.get, self._keys)
-
-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 an item is not present None is returned.
- """
- def __getattr__(self, key):
- try: return self[key]
- except KeyError: return None
- 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 '<AttrDict ' + dict.__repr__(self) + '>'
- def __getstate__(self):
- return dict(self)
- def __setstate__(self,value):
- for k,v in value.items(): self[k]=v
-
-class InsensitiveDict(dict):
- """
- Like a dictionary except key access is case insensitive.
- Keys are stored in lower case.
- """
- def __getitem__(self, key):
- return dict.__getitem__(self, key.lower())
- def __setitem__(self, key, value):
- dict.__setitem__(self, key.lower(), value)
- def has_key(self, key):
- return dict.has_key(self,key.lower())
- def get(self, key, default=None):
- return dict.get(self, key.lower(), default)
- def update(self, dict):
- for k,v in dict.items():
- self[k] = v
- def setdefault(self, key, default = None):
- return dict.setdefault(self, key.lower(), default)
-
-
-class Trace(object):
- """
- Used in conjunction with the 'trace' attribute to generate diagnostic
- output. There is a single global instance of this class named trace.
- """
- SUBS_NAMES = ('specialcharacters','quotes','specialwords',
- 'replacements', 'attributes','macros','callouts',
- 'replacements2','replacements3')
- def __init__(self):
- self.name_re = '' # Regexp pattern to match trace names.
- self.linenos = True
- self.offset = 0
- def __call__(self, name, before, after=None):
- """
- Print trace message if tracing is on and the trace 'name' matches the
- document 'trace' attribute (treated as a regexp).
- 'before' is the source text before substitution; 'after' text is the
- source text after substitutuion.
- The 'before' and 'after' messages are only printed if they differ.
- """
- name_re = document.attributes.get('trace')
- if name_re == 'subs': # Alias for all the inline substitutions.
- name_re = '|'.join(self.SUBS_NAMES)
- self.name_re = name_re
- if self.name_re is not None:
- msg = message.format(name, 'TRACE: ', self.linenos, offset=self.offset)
- if before != after and re.match(self.name_re,name):
- if is_array(before):
- before = '\n'.join(before)
- if after is None:
- msg += '\n%s\n' % before
- else:
- if is_array(after):
- after = '\n'.join(after)
- msg += '\n<<<\n%s\n>>>\n%s\n' % (before,after)
- message.stderr(msg)
-
-class Message:
- """