summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2010-09-15 11:09:45 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2010-09-15 11:09:45 +0000
commita8a145d40efbb9f0280dcd99d408c281d7c38149 (patch)
tree2c1aeddff47764d765c65f373044544f56d476bb /docs/api
parentb9fdfca93d901d7adf89da0406c71d301906592a (diff)
downloaddocutils-a8a145d40efbb9f0280dcd99d408c281d7c38149.tar.gz
latex2e writer: Place title data in the document preamble.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@6416 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/publisher.txt25
1 files changed, 12 insertions, 13 deletions
diff --git a/docs/api/publisher.txt b/docs/api/publisher.txt
index 54e6e4b6c..46c971909 100644
--- a/docs/api/publisher.txt
+++ b/docs/api/publisher.txt
@@ -273,6 +273,9 @@ The S5/HTML writer provides the same parts as the `HTML writer`_.
Parts Provided by the LaTeX2e Writer
------------------------------------
+See the template files for examples how these parts can be combined
+into a valid LaTeX document.
+
abstract
``parts['abstract']`` contains the formatted content of the
'abstract' docinfo field.
@@ -285,18 +288,8 @@ body
This part can be included into another LaTeX document body using the
``\input{}`` command.
-.. body_prefix
- ``parts['body_prefix']`` contains the LaTeX ``\begin{document}``
-
body_pre_docinfo
- ``parts['body_pre_docinfo]`` contains title (and poss. subtitle) setup
- and the ``\maketitle`` command.
-
- With ``--use-latex-docinfo``, it also contains the 'author',
- 'organization', 'contact', 'address' and 'date' docinfo items.
-
-.. body_suffix
- ``parts['body_suffix']`` contains the LaTeX ``\end{document}``.
+ ``parts['body_pre_docinfo]`` contains the ``\maketitle`` command.
dedication
``parts['dedication']`` contains the formatted content of the
@@ -307,8 +300,7 @@ docinfo
docinfo field list rendered as a table.
With ``--use-latex-docinfo`` 'author', 'organization', 'contact',
- 'address' and 'date' info is moved to the title metadata (included in
- body_pre_docinfo).
+ 'address' and 'date' info is moved to titledata.
'dedication' and 'abstract' are always moved to separate parts.
@@ -343,3 +335,10 @@ subtitle
title
``parts['title']`` contains the document title text and any inline
markup.
+
+titledata
+ ``parts['titledata]`` contains the combined title data in
+ ``\title``, ``\author``, and ``\data`` macros.
+
+ With ``--use-latex-docinfo``, this includes the 'author',
+ 'organization', 'contact', 'address' and 'date' docinfo items.