summaryrefslogtreecommitdiff
path: root/docutils/docs/api
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
commit312f3acdf506f3f681d02041c47978483ea74927 (patch)
tree9c561ba862b2de374f0679666800b625a74629b0 /docutils/docs/api
parent049dd2230cab12b2b7e756a7d09c4104947f8492 (diff)
downloaddocutils-312f3acdf506f3f681d02041c47978483ea74927.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@6111 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/api')
-rw-r--r--docutils/docs/api/publisher.txt87
1 files changed, 67 insertions, 20 deletions
diff --git a/docutils/docs/api/publisher.txt b/docutils/docs/api/publisher.txt
index 3fa208d05..60f322927 100644
--- a/docutils/docs/api/publisher.txt
+++ b/docutils/docs/api/publisher.txt
@@ -269,32 +269,79 @@ Parts Provided by the S5/HTML Writer
The S5/HTML writer provides the same parts as the `HTML writer`_.
+
Parts Provided by the LaTeX2e Writer
-````````````````````````````````````
+------------------------------------
+
+abstract
+ ``parts['abstract']`` contains the formatted content of the
+ 'abstract' docinfo field.
+
+body
+ ``parts['body']`` contains the document's content. In other words, it
+ contains the entire document, except the document title, subtitle, and
+ docinfo.
+
+ 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}``.
+
+dedication
+ ``parts['dedication']`` contains the formatted content of the
+ 'dedication' docinfo field.
+
+docinfo
+ ``parts['docinfo']`` contains the document bibliographic data, the
+ 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).
+
+ 'dedication' and 'abstract' are always moved to separate parts.
+
+.. footer
+ ``parts['footer']`` contains the document footer content, meant to
+ appear at the bottom of every printed page.
+ It is not used in the standard template but can be in a custom template
+ to define running heads/foots.
+
+fallbacks
+ ``parts['fallbacks']`` contains fallback definitions for
+ Docutils-specific commands and environments.
head_prefix
- ``parts['head_prefix']`` contains the first part of the LaTeX preamble:
- LaTeX document class, required packages and setup before the stylesheet
- inclusion.
+ ``parts['head_prefix']`` contains the declaration of
+ documentclass and document options.
+
+pdfsetup
+ ``parts['pdfsetup']`` contains the PDF properties
+ ("hyperref" package setup).
+
+requirements
+ ``parts['requirements']`` contains required packages and setup
+ before the stylesheet inclusion.
stylesheet
``parts['stylesheet']`` contains the embedded stylesheet(s) or
stylesheet loading command(s).
-head
- ``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
- 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, i.e.
- the part that can be included into another LaTeX document body using
- ``\input{}``.
+subtitle
+ ``parts['subtitle']`` contains the document subtitle text and any
+ inline markup.
-body_suffix
- ``parts['body_suffix']`` contains the LaTeX ``\end{document}``.
+title
+ ``parts['title']`` contains the document title text and any inline
+ markup.