summaryrefslogtreecommitdiff
path: root/docutils/docs/api
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2009-04-22 15:32:44 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2009-04-22 15:32:44 +0000
commitda5d000e9ba77f12020db17e7ded436d05723641 (patch)
treeddd6d425704c2d9bf4f96ab316f364fd015dd8df /docutils/docs/api
parent46a0c8dd14843f2383711724a77c799cd55db324 (diff)
downloaddocutils-da5d000e9ba77f12020db17e7ded436d05723641.tar.gz
documentation update: Parts Provided by the LaTeX2e Writer
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5916 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/api')
-rw-r--r--docutils/docs/api/publisher.txt19
1 files changed, 14 insertions, 5 deletions
diff --git a/docutils/docs/api/publisher.txt b/docutils/docs/api/publisher.txt
index 9717fcc34..d614e582d 100644
--- a/docutils/docs/api/publisher.txt
+++ b/docutils/docs/api/publisher.txt
@@ -273,19 +273,28 @@ Parts Provided by the LaTeX2e Writer
````````````````````````````````````
__`head_prefix`
- ``parts['head_prefix']`` contains the LaTeX document class, package
- and stylesheet inclusion.
+ ``parts['head_prefix']`` contains the first part of the LaTeX preamble:
+ LaTeX document class, required packages and setup before the stylesheet
+ inclusion.
+
+__`stylesheet`
+ ``parts['stylesheet']`` contains the embedded stylesheet(s) or
+ stylesheet loading command(s).
__`head`
- ``parts['head']`` currently is empty.
+ ``parts['head']`` contains the part of the LaTeX preamble following
+ the stylesheet(s): fallback definitions for Docutils-specific commands,
+ PDF hyperlink setup and title metadata (if present).
__`body_prefix`
``parts['body_prefix']`` contains the LaTeX ``\begin{document}`` and
- title page.
+ the title page or ``\maketitle`` (in titled documents).
__`body`
``parts['body']`` contains the LaTeX document content, less
- the ``\begin{document}`` and ``\end{document}`` tags themselves.
+ the ``\begin{document}`` and ``\end{document}`` tags themselves, i.e.
+ the part that can be included into another LaTeX document body using
+ ``\input{}``.
__`body_suffix`
``parts['body_suffix']`` contains the LaTeX ``\end{document}``.