Update of /cvsroot/docstring/dps/dps/transforms
In directory usw-pr-cvs1:/tmp/cvs-serv26057/dps/dps/transforms
Added Files:
components.py
Log Message:
Document component transforms: table of contents generation, footnote/citation placement, etc.
--- NEW FILE: components.py ---
#! /usr/bin/env python
"""
:Authors: David Goodger, Ueli Schlaepfer
:Contact: go...@us...
:Revision: $Revision: 1.1 $
:Date: $Date: 2002/03/16 06:03:29 $
:Copyright: This module has been placed in the public domain.
Transforms related to document components.
- `Contents`: Used to build a table of contents.
"""
__docformat__ = 'reStructuredText'
__all__ = ['build_contents', 'Contents']
import re
from dps import nodes, utils
from dps.transforms import TransformError, Transform
class Contents(Transform):
"""
This transform generates a table of contents from the entire document tree
or from a single branch. It locates "section" elements and builds them
into a nested bullet list, which is placed within a "topic". A title is
either explicitly specified, taken from the appropriate language module,
or omitted (local table of contents). The depth may be specified.
Two-way references between the table of contents and section titles are
generated (requires Writer support).
This transform requires a startnode, which which contains generation
options and provides the location for the generated table of contents (the
startnode is replaced by the table of contents "topic").
"""
def transform(self):
topic = nodes.topic(CLASS='contents')
title = self.startnode.details['title']
if self.startnode.details.has_key('local'):
startnode = self.startnode.parent
# @@@ generate an error if the startnode (directive) not at
# section/document top-level? Drag it up until it is?
while not isinstance(startnode, nodes.Structural):
startnode = startnode.parent
if not title:
title = []
else:
startnode = self.doctree
if not title:
title = nodes.title('', self.language.labels['contents'])
contents = self.build_contents(startnode)
if len(contents):
topic += title
topic += contents
self.startnode.parent.replace(self.startnode, topic)
else:
self.startnode.parent.remove(self.startnode)
def build_contents(self, node, level=0):
level += 1
sections = []
i = len(node) - 1
while i >= 0 and isinstance(node[i], nodes.section):
sections.append(node[i])
i -= 1
sections.reverse()
entries = []
for section in sections:
title = section[0]
reference = nodes.reference('', '', refid=section['id'],
*title.getchildren())
entry = nodes.paragraph('', '', reference)
item = nodes.list_item('', entry)
itemid = self.doctree.set_id(item)
title['refid'] = itemid
if (not self.startnode.details.has_key('depth')) \
or level < self.startnode.details['depth']:
subsects = self.build_contents(section, level)
item += subsects
entries.append(item)
if entries:
entries = nodes.bullet_list('', *entries)
return entries
|
