summaryrefslogtreecommitdiff
path: root/doc/faq.txt
diff options
context:
space:
mode:
authorStuart Rackham <srackham@methods.co.nz>2010-08-03 10:57:00 +1200
committerStuart Rackham <srackham@methods.co.nz>2010-08-03 10:57:00 +1200
commit77d2d6bc56d211fd47f98491d13b31005b126f74 (patch)
tree53398198bbbef6c7973a2deacbc67062592e1a98 /doc/faq.txt
parent36168829f29370cd44fde081030c99caa6ef722b (diff)
downloadasciidoc-git-77d2d6bc56d211fd47f98491d13b31005b126f74.tar.gz
Updated FAQ and fixed a typo.
Diffstat (limited to 'doc/faq.txt')
-rw-r--r--doc/faq.txt73
1 files changed, 44 insertions, 29 deletions
diff --git a/doc/faq.txt b/doc/faq.txt
index 8ef689d..d09ef0f 100644
--- a/doc/faq.txt
+++ b/doc/faq.txt
@@ -26,6 +26,33 @@ as a listing block. For example:
...........................
+== How can I customize PDF files generated by dblatex?
+
+There are a number of dblatex XSL parameters that can be used to
+customize PDF output. You can set them globally in the AsciiDoc
+`./dblatex/asciidoc-dblatex.xsl` configuration file or you can also
+pass them on the a2x(1) command-line. Here are some examples:
+
+The
+http://dblatex.sourceforge.net/doc/manual/latex.output.revhistory.html[latex.output.revhistory]
+parameter is used to supress the revision history:
+
+ a2x -f pdf --dblatex-opts "-P latex.output.revhistory=0" doc/article.txt
+
+The
+http://dblatex.sourceforge.net/doc/manual/doc.layout.html[doc.layout]
+parameter is used to include the cover page and document body (i.e. excludes
+table of contents and index), the
+http://dblatex.sourceforge.net/doc/manual/doc.publisher.show.html[doc.publisher.show]
+parameter is used to exclude the cover page logo:
+
+ a2x -f pdf --dblatex-opts " -P doc.layout=\"coverpage mainmatter\" -P doc.publisher.show=0" doc/article.txt
+
+See also the
+http://dblatex.sourceforge.net/doc/manual/sec-params.html[dblatex XSL
+parameter reference].
+
+
== How can I add lists of figures and tables to PDFs created by dblatex?
Set the
http://dblatex.sourceforge.net/doc/sec-custom.html[doc.lot.show XSL
@@ -35,6 +62,23 @@ option, for example:
$ a2x --dblatex-opts="--param=doc.lot.show=figure,table" doc/article.txt
+== Why don't tables generated by dblatex obey the width attribute?
+Tables generated by dblatex will take 100% of the available space
+unless you change the 'pageunits' micellaneous parameter to 'pt'.
+Here's how:
+
+- From the command-line with the `-a pageunits=pt` option
+- Or by setting `pageunits=pt` in a configuration file
+ `[miscellaneous]` section.
+- Or by setting this AttributeEntry in your document:
+
+ :miscellaneous.pageunits: pt
+
+See the
+http://www.methods.co.nz/asciidoc/userguide.html#X89[DocBook table
+widths] sidebar in the 'AsciiDoc User Guide' for an explanation.
+
+
== How can I stop the document title being displayed?
You could simply omit the document title, but this will result in a
blank 'title' element in HTML outputs. If you want the HTML 'title'
@@ -86,23 +130,6 @@ name, for example:
----------
-== Why don't tables generated by dblatex obey the width attribute?
-Tables generated by dblatex will take 100% of the available space
-unless you change the 'pageunits' micellaneous parameter to 'pt'.
-Here's how:
-
-- From the command-line with the `-a pageunits=pt` option
-- Or by setting `pageunits=pt` in a configuration file
- `[miscellaneous]` section.
-- Or by setting this AttributeEntry in your document:
-
- :miscellaneous.pageunits: pt
-
-See the
-http://www.methods.co.nz/asciidoc/userguide.html#X89[DocBook table
-widths] sidebar in the 'AsciiDoc User Guide' for an explanation.
-
-
== How can I insert XML processing instructions into output documents?
Use an inline or block passthrough macros. This example inserts
`<?dblatex bgcolor="#cceeff"?>` into the DocBook output generated by
@@ -849,18 +876,6 @@ and set the attribute `depth=1` instead, for example:
................................................
-== How can I customize PDF files generated by dblatex?
-
-There are a number of dblatex XSL parameters that can be used to
-customize PDF output. You can set them globally in the AsciiDoc
-`./dblatex/asciidoc-dblatex.xsl` configuration file or you can also
-pass them on the a2x(1) command-line, for example:
-
- a2x -f pdf --dblatex-opts "-P latex.output.revhistory=0" doc/article.txt
-
-See also the http://dblatex.sourceforge.net/[dblatex] documentation.
-
-
== How can I make the mailto macro work with multiple email addresses?
For the AsciiDoc 'mailto' macro to work with multiple email addresses