summaryrefslogtreecommitdiffstats
path: root/source-builder/sb/asciidoc/dblatex/dblatex-readme.txt
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 /source-builder/sb/asciidoc/dblatex/dblatex-readme.txt
parent4.12: Fix SIS patch URL (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.
Diffstat (limited to 'source-builder/sb/asciidoc/dblatex/dblatex-readme.txt')
-rw-r--r--source-builder/sb/asciidoc/dblatex/dblatex-readme.txt39
1 files changed, 0 insertions, 39 deletions
diff --git a/source-builder/sb/asciidoc/dblatex/dblatex-readme.txt b/source-builder/sb/asciidoc/dblatex/dblatex-readme.txt
deleted file mode 100644
index 39bb437..0000000
--- a/source-builder/sb/asciidoc/dblatex/dblatex-readme.txt
+++ /dev/null
@@ -1,39 +0,0 @@
-AsciiDoc dblatex README
-=======================
-
-Customization
--------------
-The `./dblatex` directory contains:
-
-`./dblatex/asciidoc-dblatex.xsl`:: Optional dblatex XSL parameter
-customization.
-
-`./dblatex/asciidoc-dblatex.sty`:: Optional customized LaTeX styles.
-
-Use these files with dblatex(1) `-p` and `-s` options, for example:
-
- dblatex -p ../dblatex/asciidoc-dblatex.xsl \
- -s ../dblatex/asciidoc-dblatex.sty article.xml
-
-
-Limitations
------------
-Observed in dblatex 0.2.8.
-
-- dblatex doesn't seem to process the DocBook 'literallayout' element
- correctly: it is rendered in a monospaced font and no inline
- elements are processed. By default the normal font should be used
- and almost all DocBook inline elements should be processed
- (http://www.docbook.org/tdg/en/html/literallayout.html). I almost
- fixed this by overriding the default dblatex literallayout template
- (in `./dblatex/asciidoc-dblatex.xsl`) and using the LaTeX 'alltt'
- package, but there are remaining problems:
-
- * Blank lines are replaced by a single space.
- * The 'literallayout' element incorrectly wraps text when rendered
- inside a table.
-
-- Callouts do not work inside DocBook 'literallayout' elements which
- means callouts are not displayed inside AsciiDoc literal blocks. A
- workaround is to change the AsciiDoc literal block to a listing
- block.