docutils.nodes.topic

Package docutils :: Module nodes :: Class topic

[show private | hide private]

Class topic

  Node --+    
         |    
   Element --+
             |
Structural --+
             |
            topic

Topics are terminal, "leaf" mini-sections, like block quotes with titles, or textual figures. A topic is just like a section, except that it has no subsections, and it doesn't have to conform to section placement rules.

Topics are allowed wherever body elements (list, table, etc.) are allowed, but only at the top level of a section or document. Topics cannot nest inside topics, sidebars, or body elements; you can't have a topic inside a table, list, block quote, etc.

Method Summary
Inherited from Element
	`__init__(self, rawsource, children, *attributes)`
	`__add__(self, other)`
	`__delitem__(self, key)`
	`__getitem__(self, key)`
	`__iadd__(self, other)` Append a node or a list of nodes to `self.children`.
	`__len__(self)`
	`__radd__(self, other)`
	`__repr__(self)`
	`__setitem__(self, key, item)`
	`__str__(self)`
	`__unicode__(self)`
	`append(self, item)`
	`astext(self)`
	`attlist(self)`
	`copy(self)` Return a copy of self.
	`delattr(self, attr)`
	`emptytag(self)`
	`endtag(self)`
	`extend(self, item)`
	`first_child_matching_class(self, childclass, start, end)` Return the index of the first child whose class exactly matches.
	`first_child_not_matching_class(self, childclass, start, end)` Return the index of the first child whose class does not match.
	`get(self, key, failobj)`
	`get_children(self)` Return this element's children.
	`has_key(self, attr)`
	`hasattr(self, attr)`
	`index(self, item)`
	`insert(self, index, item)`
	`pformat(self, indent, level)` Return an indented pseudo-XML representation, for test purposes.
	`pop(self, i)`
	`remove(self, item)`
	`replace(self, old, new)` Replace one child `Node` with another child or children.
	`set_class(self, name)` Add a new name to the "class" attribute.
	`setdefault(self, key, failobj)`
	`shortrepr(self)`
	`starttag(self)`
	`_dom_node(self, domroot)`
Inherited from Node
	`__nonzero__(self)` Node instances are always true, even if they're empty.
	`asdom(self, dom)` Return a DOM fragment representation of this Node.
	`setup_child(self, child)`
	`walk(self, visitor)` Traverse a tree of `Node` objects, calling `visit_...` methods of `visitor` when entering each node.
	`walkabout(self, visitor)` Perform a tree traversal similarly to `Node.walk()` (which see), except also call `depart_...` methods before exiting each node.

Class Variable Summary
Inherited from Element
`str`	`child_text_separator` = `'\n\n'`
`NoneType`	`tagname` = None
Inherited from Node
`NoneType`	`document` = None
`NoneType`	`line` = None
`NoneType`	`parent` = None
`NoneType`	`source` = None

Generated by Epydoc 2.0 on Tue Jul 22 05:31:32 2003

http://epydoc.sf.net