summaryrefslogtreecommitdiff
path: root/docutils/docs/api
diff options
context:
space:
mode:
authorwiemann <wiemann@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2005-06-27 11:25:47 +0000
committerwiemann <wiemann@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2005-06-27 11:25:47 +0000
commit6fbf88cb02c38e40268df74688fc357f442e137e (patch)
tree53db5f6e6a825fbd30628031d805f529fb82e5e5 /docutils/docs/api
parentceeeaa182fc2bfe5e0f2a4943fbaa57300b93031 (diff)
downloaddocutils-6fbf88cb02c38e40268df74688fc357f442e137e.tar.gz
added more links; added note about body != html_body
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3599 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/api')
-rw-r--r--docutils/docs/api/publisher.txt13
1 files changed, 7 insertions, 6 deletions
diff --git a/docutils/docs/api/publisher.txt b/docutils/docs/api/publisher.txt
index 98d84235f..73cfc0ef2 100644
--- a/docutils/docs/api/publisher.txt
+++ b/docutils/docs/api/publisher.txt
@@ -19,19 +19,19 @@ then call its ``publish`` method. ``docutils.core.Publisher.publish``
handles everything else. There are five convenience functions in the
``docutils.core`` module:
-* ``publish_cmdline``: for command-line front-end tools, like
+:_`publish_cmdline`: for command-line front-end tools, like
``rst2html.py``. There are several examples in the ``tools/``
directory. A detailed analysis of one such tool is in `Inside A
Docutils Command-Line Front-End Tool`_
-* ``publish_file``: for programmatic use with file-like I/O. In
+:_`publish_file`: for programmatic use with file-like I/O. In
addition to writing the encoded output to a file, also returns the
encoded output as a string.
-* ``publish_string``: for programmatic use with string I/O. Returns
+:_`publish_string`: for programmatic use with string I/O. Returns
the encoded output as a string.
-* ``publish_parts``: for programmatic use with string input; returns a
+:_`publish_parts`: for programmatic use with string input; returns a
dictionary of document parts. Dictionary keys are the names of
parts, and values are Unicode strings; encoding is up to the client.
Useful when only portions of the processed document are desired.
@@ -39,7 +39,7 @@ handles everything else. There are five convenience functions in the
There are usage examples in the `docutils/examples.py`_ module.
-* ``publish_programmatically``: for custom programmatic use. This
+:_`publish_programmatically`: for custom programmatic use. This
function implements common code and is used by ``publish_file``,
``publish_string``, and ``publish_parts``. It returns a 2-tuple:
the encoded string output and the Publisher object.
@@ -105,7 +105,8 @@ Parts Provided By the HTML Writer
---------------------------------
_`body`
- ``parts['body']`` is equivalent to ``parts['fragment']``.
+ ``parts['body']`` is equivalent to parts['fragment_']. It is
+ *not* equivalent to parts['html_body_'].
_`docinfo`
``parts['docinfo']`` contains the document bibliographic data.