zope.structuredtext
API¶
zope.structuredtext.document
¶
Structured text document parser
- class zope.structuredtext.document.Document[source]¶
Class instance calls [ex.=> x()] require a structured text structure. Doc will then parse each paragraph in the structure and will find the special structures within each paragraph. Each special structure will be stored as an instance. Special structures within another special structure are stored within the ‘top’ structure EX : ‘-underline this-’ => would be turned into an underline instance. ‘-underline this’ would be stored as an underline instance with a strong instance stored in its string
- parse(raw_string, text_type, type=<class 'type'>)[source]¶
Parse accepts a raw_string, an expr to test the raw_string, and the raw_string’s subparagraphs.
Parse will continue to search through raw_string until all instances of expr in raw_string are found.
If no instances of expr are found, raw_string is returned. Otherwise a list of substrings and instances is returned
zope.structuredtext.stletters
¶
Structured text character classes
zope.structuredtext.stng
¶
Core document model.
- zope.structuredtext.stng.indention(str, front=<built-in method match of re.Pattern object>)[source]¶
Find the number of leading spaces. If none, return 0.
- zope.structuredtext.stng.insert(struct, top, level)[source]¶
Find what will be the parant paragraph of a sentence and return that paragraph’s sub-paragraphs. The new paragraph will be appended to those sub-paragraphs
- zope.structuredtext.stng.display(struct)[source]¶
Runs through the structure and prints out the paragraphs. If the insertion works correctly, display’s results should mimic the orignal paragraphs.
- zope.structuredtext.stng.display2(struct)[source]¶
Runs through the structure and prints out the paragraphs. If the insertion works correctly, display’s results should mimic the orignal paragraphs.
- zope.structuredtext.stng.findlevel(levels, indent)[source]¶
Remove all level information of levels with a greater level of indentation. Then return which level should insert this paragraph
- zope.structuredtext.stng.structurize(paragraphs, delimiter=re.compile('(\\n\\s*\\n|\\r\\n\\s*\\r\\n)'))[source]¶
Accepts paragraphs, which is a list of lines to be parsed. structurize creates a structure which mimics the structure of the paragraphs. Structure => [paragraph,[sub-paragraphs]]
- class zope.structuredtext.stng.StructuredTextDocument(subs=None, **kw)[source]¶
A StructuredTextDocument holds StructuredTextParagraphs as its subparagraphs.
- class zope.structuredtext.stng.StructuredTextExample(subs, **kw)[source]¶
Represents a section of document with literal text, as for examples
- class zope.structuredtext.stng.StructuredTextBullet(src, subs=None, **kw)[source]¶
Represents a section of a document with a title and a body
- class zope.structuredtext.stng.StructuredTextNumbered(src, subs=None, **kw)[source]¶
Represents a section of a document with a title and a body
- class zope.structuredtext.stng.StructuredTextDescriptionTitle(src, subs=None, **kw)[source]¶
Represents a section of a document with a title and a body
- class zope.structuredtext.stng.StructuredTextDescriptionBody(src, subs=None, **kw)[source]¶
Represents a section of a document with a title and a body
- class zope.structuredtext.stng.StructuredTextDescription(title, src, subs, **kw)[source]¶
Represents a section of a document with a title and a body
- class zope.structuredtext.stng.StructuredTextSectionTitle(src, subs=None, **kw)[source]¶
Represents a section of a document with a title and a body
- class zope.structuredtext.stng.StructuredTextSection(src, subs=None, **kw)[source]¶
Represents a section of a document with a title and a body
- class zope.structuredtext.stng.StructuredTextTable(rows, src, subs, **kw)[source]¶
rows is a list of lists containing tuples, which represent the columns/cells in each rows. EX rows = [[(‘row 1:column1’,1)],[(‘row2:column1’,1)]]
- class zope.structuredtext.stng.StructuredTextRow(row, kw)[source]¶
row is a list of tuples, where each tuple is the raw text for a cell/column and the span of that cell/column. EX [(‘this is column one’,1), (‘this is column two’,1)]
- class zope.structuredtext.stng.StructuredTextColumn(text, span, align, valign, typ, kw)[source]¶
StructuredTextColumn is a cell/column in a table. A cell can hold multiple paragraphs. The cell is either classified as a StructuredTextTableHeader or StructuredTextTableData.
zope.structuredtext.stdom
¶
DOM implementation in StructuredText: read-only methods
- class zope.structuredtext.stdom.ParentNode[source]¶
A node that can have children, or, more precisely, that implements the child access methods of the DOM.
- getChildNodes(type=<class 'type'>, sts=<class 'str'>)[source]¶
Returns a NodeList that contains all children of this node. If there are no children, this is a empty NodeList
- class zope.structuredtext.stdom.NodeWrapper(aq_self, aq_parent)[source]¶
This is an acquisition-like wrapper that provides parent access for DOM sans circular references!
- getParentNode()[source]¶
The parent of this node. All nodes except Document DocumentFragment and Attr may have a parent
- getPreviousSibling()[source]¶
The node immediately preceding this node. If there is no such node, this returns None.
- class zope.structuredtext.stdom.Node[source]¶
Node Interface
- getParentNode()[source]¶
The parent of this node. All nodes except Document DocumentFragment and Attr may have a parent
- getPreviousSibling()[source]¶
The node immediately preceding this node. If there is no such node, this returns None.
- getNextSibling()[source]¶
The node immediately preceding this node. If there is no such node, this returns None.
- class zope.structuredtext.stdom.Element[source]¶
Element interface
- getNodeName()¶
The name of the element
- getParentNode()[source]¶
The parent of this node. All nodes except Document DocumentFragment and Attr may have a parent
- getAttributeNode(name)[source]¶
Retrieves an Attr node by name or None if there is no such attribute.
- getAttributes()[source]¶
Returns a NamedNodeMap containing the attributes of this node (if it is an element) or None otherwise.
- getElementsByTagName(tagname)[source]¶
Returns a NodeList of all the Elements with a given tag name in the order in which they would be encountered in a preorder traversal of the Document tree. Parameter: tagname The name of the tag to match (* = all tags). Return Value: A new NodeList object containing all the matched Elements.
- class zope.structuredtext.stdom.NodeList(list=None)[source]¶
NodeList interface - Provides the abstraction of an ordered collection of nodes.
Python extensions: can use sequence-style ‘len’, ‘getitem’, and ‘for..in’ constructs.
- class zope.structuredtext.stdom.NamedNodeMap(data=None)[source]¶
NamedNodeMap interface - Is used to represent collections of nodes that can be accessed by name. NamedNodeMaps are not maintained in any particular order.
Python extensions: can use sequence-style ‘len’, ‘getitem’, and ‘for..in’ constructs, and mapping-style ‘getitem’.
zope.structuredtext.html
¶
HTML renderer for STX documents.
zope.structuredtext.docbook
¶
Render STX document as docbook.
zope.structuredtext
¶
Zope structured text markeup
Consider the following example:
>>> from zope.structuredtext.stng import structurize
>>> from zope.structuredtext.document import DocumentWithImages
>>> from zope.structuredtext.html import HTMLWithImages
>>> from zope.structuredtext.docbook import DocBook
>>> from zope.structuredtext.docbook import DocBookChapterWithFigures
>>> from zope.structuredtext.docbook import DocBookArticle
We first need to structurize the string and make a full-blown document out of it:
>>> structured_string = '''
... Title Here
...
... Body text here.'''
>>> struct = structurize(structured_string)
>>> doc = DocumentWithImages()(struct)
Now feed it to some output generator, in this case HTML or DocBook:
>>> HTMLWithImages()(doc, level=1)
'<html>...'
>>> DocBook()(doc, level=1)
'<!DOCTYPE book ...<book>...'
>>> DocBookArticle()(doc, level=1)
'<!DOCTYPE article ...<article>...'
>>> DocBookChapterWithFigures()(doc, level=1)
'<chapter>...'
For HTML, there is a shortcut:
>>> from zope.structuredtext import stx2html
>>> stx2html(structured_string)
'<html>...'
If we have references in the text we can use a different function:
>>> from zope.structuredtext import stx2htmlWithReferences
>>> stx2htmlWithReferences(structured_string)
'<html>...'