summaryrefslogtreecommitdiff
path: root/docs/user
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2009-09-02 21:36:05 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2009-09-02 21:36:05 +0000
commit94236c1958a681beb15920b3a868ec0740f2f3d8 (patch)
treec2cf2731f9b52c6573716a419fa07e65eea628fa /docs/user
parent60474c6da3e619fff4c1a614e7b0a3ee6d617171 (diff)
downloaddocutils-94236c1958a681beb15920b3a868ec0740f2f3d8.tar.gz
Updated template support: more parts, alternative template
Rename default template to "default.tex". Alternative template "titlepage.tex". Remove --use-titlepage-env option. LaTeXTranslator: sort initialization code. Generate PDF setup code unconditionally. Put in its own part so it can be (re)moved in a custom template. Comment out Writer.astext(). Put header and footer directive content in \\\\DUheader, \\\\DUfooter macros (not printed with the default style/template). git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@6111 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/user')
-rw-r--r--docs/user/docutils-05-compat.sty.txt25
-rw-r--r--docs/user/latex.txt28
2 files changed, 51 insertions, 2 deletions
diff --git a/docs/user/docutils-05-compat.sty.txt b/docs/user/docutils-05-compat.sty.txt
index 0fbc13221..b4bf97985 100644
--- a/docs/user/docutils-05-compat.sty.txt
+++ b/docs/user/docutils-05-compat.sty.txt
@@ -68,6 +68,16 @@ Bugfixes
* `Figure and image alignment`_ now conforms to the rst definition.
+* Put `header and footer directive`__ content in \DUheader respective
+ \DUfooter macros (ignored by the default style/template).
+
+ (They were put inside hard-coded markup at the top/bottom of the document
+ without an option to get them on every page.)
+
+__ ../ref/rst/directives.html#document-header-footer
+
+
+
Backwards compatibility:
"Bug for bug compatibility" is not provided.
@@ -118,6 +128,21 @@ Backwards compatibility:
``\input`` by LaTeX.
+Templates
+---------
+
+New Feature:
+ Advanced configuration via custom templates.
+
+Implementation:
+ A ``--template`` option and config setting allows specification of a
+ template file.
+
+See the `LaTeX writer documentation`__ for details.
+
+__ latex.html#templates
+
+
Custom roles
------------
diff --git a/docs/user/latex.txt b/docs/user/latex.txt
index 72a39119a..ad56c2052 100644
--- a/docs/user/latex.txt
+++ b/docs/user/latex.txt
@@ -201,7 +201,7 @@ Configuration
Configuration can be done via configuration options_ to the Docutils tool,
`custom style sheets`_ and LaTeX packages, as well as `raw LaTeX`_ in the
-document.
+document. Advanced configuration is possible with custom templates_.
Options
-------
@@ -229,7 +229,7 @@ Custom style sheets
LaTeX style sheets can be used to configure the look of the printout/PDF by
(re-)defining LaTeX-commands and settings.
-The option::
+The option ::
--stylesheet=STYLESHEET
@@ -279,6 +279,30 @@ Stylesheet Repository
.. _sandbox: ../../../sandbox/
+Templates
+---------
+
+Some customizations require commands at places other than the insertion
+point of stylesheets or depend on the deletion/replacement of parts of the
+document. This can be done via a custom template. See the `publisher
+documentation`_ for a description of the document parts available in a
+template file.
+
+The ``--template`` option specifies the path to the template file. It is
+tried relative to the current working directory and to the latex writer's
+package sub-directory. The default value is 'default.tex'.
+
+In addition to the 'default.tex' template, the latex writer directory
+contains the alternative 'titlepage.tex'.
+
+Example:
+ Print a title page including docinfo, dedication, and abstract::
+
+ --template=titlepage.tex
+
+.. _publisher documentation: ../api/publisher.html
+
+
Raw LaTeX
---------