package documentation

Open Document Format (ODF) Writer.

This module is provisional: the API is not settled and may change with any minor Docutils version.

Module pygmentsformatter Additional support for Pygments formatter.

From __init__.py:

Class ​List​Level Undocumented
Class ​ODFTranslator No class docstring; 0/59 instance variable, 0/6 class variable, 8/241 methods documented
Class ​Reader Undocumented
Class ​Table​Style Undocumented
Class ​Writer No class docstring; 0/4 instance variable, 1/10 class variable, 0/2 constant, 5/12 methods documented
Function add​_ns Undocumented
Function ​Element Undocumented
Function escape​_cdata Undocumented
Function fix​_ns Undocumented
Function ​Sub​Element Undocumented
Function ​To​String Undocumented
Constant BUILTIN​_DEFAULT​_TABLE​_STYLE Undocumented
Constant CNSD Undocumented
Constant CONTENT​_NAMESPACE​_ATTRIB Undocumented
Constant CONTENT​_NAMESPACE​_DICT Undocumented
Constant FILL​_PAT1 Undocumented
Constant FILL​_PAT2 Undocumented
Constant GENERATOR​_DESC Undocumented
Constant IMAGE​_NAME​_COUNTER Undocumented
Constant MANIFEST​_NAMESPACE​_ATTRIB Undocumented
Constant MANIFEST​_NAMESPACE​_DICT Undocumented
Constant MANNSD Undocumented
Constant META​_NAMESPACE​_ATTRIB Undocumented
Constant META​_NAMESPACE​_DICT Undocumented
Constant METNSD Undocumented
Constant NAME​_SPACE​_1 Undocumented
Constant SNSD Undocumented
Constant SPACES​_PATTERN Undocumented
Constant STYLES​_NAMESPACE​_ATTRIB Undocumented
Constant STYLES​_NAMESPACE​_DICT Undocumented
Constant TABLENAMEDEFAULT Undocumented
Constant TABLEPROPERTYNAMES Undocumented
Constant TABLESTYLEPREFIX Undocumented
Constant TABS​_PATTERN Undocumented
Constant VERSION Undocumented
Variable pygments Undocumented
Class _​Element​Interface​Wrapper Undocumented
Variable ​_parents Undocumented
pygments =

Undocumented

VERSION: str =

Undocumented

Value
'1.0a'
IMAGE_NAME_COUNTER =

Undocumented

Value
itertools.count()
_parents =

Undocumented

SPACES_PATTERN =

Undocumented

Value
re.compile(r'( +)')
TABS_PATTERN =

Undocumented

Value
re.compile(r'(\t+)')
FILL_PAT1 =

Undocumented

Value
re.compile(r'^ +')
FILL_PAT2 =

Undocumented

Value
re.compile(r' {2,}')
TABLESTYLEPREFIX: str =

Undocumented

Value
'rststyle-table-'
TABLENAMEDEFAULT =

Undocumented

Value
'%s0'%TABLESTYLEPREFIX
TABLEPROPERTYNAMES: tuple[str, ...] =

Undocumented

Value
('border', 'border-top', 'border-left', 'border-right', 'border-bottom')
GENERATOR_DESC: str =

Undocumented

Value
'Docutils.org/odf_odt'
NAME_SPACE_1: str =

Undocumented

Value
'urn:oasis:names:tc:opendocument:xmlns:office:1.0'
CONTENT_NAMESPACE_DICT =

Undocumented

Value
{'chart': 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0',
 'dc': 'http://purl.org/dc/elements/1.1/',
 'dom': 'http://www.w3.org/2001/xml-events',
 'dr3d': 'urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0',
 'draw': 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0',
 'fo': 'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0',
 'form': 'urn:oasis:names:tc:opendocument:xmlns:form:1.0',
...
CNSD =

Undocumented

Value
{'chart': 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0',
 'dc': 'http://purl.org/dc/elements/1.1/',
 'dom': 'http://www.w3.org/2001/xml-events',
 'dr3d': 'urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0',
 'draw': 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0',
 'fo': 'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0',
 'form': 'urn:oasis:names:tc:opendocument:xmlns:form:1.0',
...
STYLES_NAMESPACE_DICT =

Undocumented

Value
{'chart': 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0',
 'dc': 'http://purl.org/dc/elements/1.1/',
 'dom': 'http://www.w3.org/2001/xml-events',
 'dr3d': 'urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0',
 'draw': 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0',
 'fo': 'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0',
 'form': 'urn:oasis:names:tc:opendocument:xmlns:form:1.0',
...
SNSD =

Undocumented

Value
{'chart': 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0',
 'dc': 'http://purl.org/dc/elements/1.1/',
 'dom': 'http://www.w3.org/2001/xml-events',
 'dr3d': 'urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0',
 'draw': 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0',
 'fo': 'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0',
 'form': 'urn:oasis:names:tc:opendocument:xmlns:form:1.0',
...
MANIFEST_NAMESPACE_DICT: dict[str, str] =

Undocumented

Value
{'manifest': 'urn:oasis:names:tc:opendocument:xmlns:manifest:1.0'}
MANNSD: dict[str, str] =

Undocumented

Value
{'manifest': 'urn:oasis:names:tc:opendocument:xmlns:manifest:1.0'}
META_NAMESPACE_DICT =

Undocumented

Value
{'dc': 'http://purl.org/dc/elements/1.1/',
 'meta': 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0',
 'office': NAME_SPACE_1,
 'ooo': 'http://openoffice.org/2004/office',
 'xlink': 'http://www.w3.org/1999/xlink'}
METNSD =

Undocumented

Value
{'dc': 'http://purl.org/dc/elements/1.1/',
 'meta': 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0',
 'office': NAME_SPACE_1,
 'ooo': 'http://openoffice.org/2004/office',
 'xlink': 'http://www.w3.org/1999/xlink'}
CONTENT_NAMESPACE_ATTRIB =

Undocumented

Value
{'xmlns:chart': 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0',
 'xmlns:dc': 'http://purl.org/dc/elements/1.1/',
 'xmlns:dom': 'http://www.w3.org/2001/xml-events',
 'xmlns:dr3d': 'urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0',
 'xmlns:draw': 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0',
 'xmlns:fo': 'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0',
 'xmlns:form': 'urn:oasis:names:tc:opendocument:xmlns:form:1.0',
...
STYLES_NAMESPACE_ATTRIB =

Undocumented

Value
{'xmlns:chart': 'urn:oasis:names:tc:opendocument:xmlns:chart:1.0',
 'xmlns:dc': 'http://purl.org/dc/elements/1.1/',
 'xmlns:dom': 'http://www.w3.org/2001/xml-events',
 'xmlns:dr3d': 'urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0',
 'xmlns:draw': 'urn:oasis:names:tc:opendocument:xmlns:drawing:1.0',
 'xmlns:fo': 'urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0',
 'xmlns:form': 'urn:oasis:names:tc:opendocument:xmlns:form:1.0',
...
MANIFEST_NAMESPACE_ATTRIB: dict[str, str] =

Undocumented

Value
{'xmlns:manifest': 'urn:oasis:names:tc:opendocument:xmlns:manifest:1.0'}
META_NAMESPACE_ATTRIB =

Undocumented

Value
{'xmlns:dc': 'http://purl.org/dc/elements/1.1/',
 'xmlns:meta': 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0',
 'xmlns:office': NAME_SPACE_1,
 'xmlns:ooo': 'http://openoffice.org/2004/office',
 'xmlns:xlink': 'http://www.w3.org/1999/xlink'}
def Element(tag, attrib=None, nsmap=None, nsdict=CNSD):

Undocumented

def SubElement(parent, tag, attrib=None, nsmap=None, nsdict=CNSD):

Undocumented

def fix_ns(tag, attrib, nsdict):

Undocumented

def add_ns(tag, nsdict=CNSD):

Undocumented

def ToString(et):

Undocumented

def escape_cdata(text):

Undocumented

BUILTIN_DEFAULT_TABLE_STYLE =

Undocumented

Value
TableStyle(border='0.0007in solid #000000')