diff options
| author | wiemann <wiemann@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2005-06-27 11:10:08 +0000 |
|---|---|---|
| committer | wiemann <wiemann@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2005-06-27 11:10:08 +0000 |
| commit | 1b91cbff68e151a4f93b114708773e764e45a348 (patch) | |
| tree | af76308d644bf58464f8828d33145a0adb1f992b /docutils/docs/api | |
| parent | c8f803dcd889625379c251ba331b1c904281ebd2 (diff) | |
| download | docutils-1b91cbff68e151a4f93b114708773e764e45a348.tar.gz | |
added link targets; note to self: need to document publish_(from_)doctree
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3597 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/api')
| -rw-r--r-- | docutils/docs/api/publisher.txt | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/docutils/docs/api/publisher.txt b/docutils/docs/api/publisher.txt index 79bac6202..98d84235f 100644 --- a/docutils/docs/api/publisher.txt +++ b/docutils/docs/api/publisher.txt @@ -97,39 +97,39 @@ the "whole" part. Parts Provided By All Writers ----------------------------- -whole +_`whole` ``parts['whole']`` contains the entire formatted document. Parts Provided By the HTML Writer --------------------------------- -body +_`body` ``parts['body']`` is equivalent to ``parts['fragment']``. -docinfo +_`docinfo` ``parts['docinfo']`` contains the document bibliographic data. -footer +_`footer` ``parts['footer']`` contains the document footer content, meant to appear at the bottom of a web page, or repeated at the bottom of every printed page. -fragment +_`fragment` ``parts['fragment']`` contains the document body (*not* the HTML ``<body>``). In other words, it contains the entire document, less the document title, subtitle, docinfo, header, and footer. -header +_`header` ``parts['header']`` contains the document header content, meant to appear at the top of a web page, or repeated at the top of every printed page. -html_body +_`html_body` ``parts['html_body']`` contains the HTML ``<body>`` content, less the ``<body>`` and ``</body>`` tags themselves. -html_head +_`html_head` ``parts['html_head']`` contains the HTML ``<head>`` content, less the stylesheet link and the ``<head>`` and ``</head>`` tags themselves. Since ``publish_parts`` returns Unicode strings and @@ -140,7 +140,7 @@ html_head The interpolation should be done by client code. -html_prolog +_`html_prolog` ``parts['html_prolog]`` contains the XML declaration and the doctype declaration. The XML declaration's "encoding" attribute's value is left unresolved, as "%s":: @@ -149,27 +149,27 @@ html_prolog The interpolation should be done by client code. -html_subtitle +_`html_subtitle` ``parts['html_subtitle']`` contains the document subtitle, including the enclosing ``<h2 class="subtitle">`` & ``</h2>`` tags. -html_title +_`html_title` ``parts['html_title']`` contains the document title, including the enclosing ``<h1 class="title">`` & ``</h1>`` tags. -meta +_`meta` ``parts['meta']`` contains all ``<meta ... />`` tags. -stylesheet +_`stylesheet` ``parts['stylesheet']`` contains the document stylesheet link. -subtitle +_`subtitle` ``parts['subtitle']`` contains the document subtitle text and any inline markup. It does not include the enclosing ``<h2>`` & ``</h2>`` tags. -title +_`title` ``parts['title']`` contains the document title text and any inline markup. It does not include the enclosing ``<h1>`` & ``</h1>`` tags. |