Formatter which produces simple DocBook SGML.
|
Methods
|
|
|
|
|
|
__init__
|
__init__ (
self,
docSet,
**configuration,
)
|
|
|
closeOutput
|
closeOutput ( self, output )
Close the output handle.
|
|
|
comment
|
comment (
self,
text,
output,
)
Output text as a comment.
|
|
|
dedent
|
dedent ( self, output )
|
|
|
descriptiveListFooter
|
descriptiveListFooter ( self, output )
Write the closing footer for a descriptive list to the output.
|
|
|
descriptiveListHeader
|
descriptiveListHeader (
self,
output,
title,
)
Write the title as the heading for a descriptive list to the output.
descriptive lists
|
|
|
descriptiveListItem
|
descriptiveListItem (
self,
output,
item,
description,
descriptionFormat,
)
Format and write the item and description for a descriptive list to the output.
|
|
|
dividingLine
|
dividingLine (
self,
output,
fill='-',
)
Write a sectional dividing line made up of repeated fill characters to the output.
|
|
|
fileFooter
|
fileFooter ( self, output )
|
|
|
fileHeader
|
fileHeader (
self,
title1,
title2,
output,
)
|
|
|
formatCode
|
formatCode (
self,
text,
textFormat,
)
Format text as source code and return the new string.
|
Exceptions
|
|
ValueError( 'DocBook formatter cannot handle sourcde code as %s' % textFormat )
|
|
|
|
formatKeyword
|
formatKeyword ( self, text )
Format text as a keyword and return the new string.
|
|
|
getFilenameExtension
|
getFilenameExtension ( self )
Returns the extension for creating output files.
|
|
|
getInternalReference
|
getInternalReference ( self, infoSource )
Returns a reference to infoSource within the current document.
|
|
|
getNamedReference
|
getNamedReference (
self,
infoSource,
name,
relativeSource,
)
|
|
|
getPythonReference
|
getPythonReference ( self, moduleName )
Returns a reference to moduleName documentation on the
Python.org documentation site.
|
|
|
getReference
|
getReference (
self,
infoSource,
relativeSource,
name=None,
)
Returns a reference to the infoSource from relativeSource.
|
|
|
getRootNodeName
|
getRootNodeName ( self )
|
|
|
indent
|
indent ( self, output )
|
|
|
itemFooter
|
itemFooter ( self, output )
Write a section closing footer to the output.
|
|
|
itemHeader
|
itemHeader (
self,
output,
infoObject,
)
Write a section openning header for an infoObject to the output.
|
|
|
listFooter
|
listFooter ( self, output )
Write the closing footer for a list to the output.
|
|
|
listHeader
|
listHeader (
self,
output,
title=None,
allowMultiColumn=1,
)
Output title as a heading for a list. If allowMultiColumn is
true, set up the list to have more than one column. simple lists
|
|
|
listItem
|
listItem (
self,
output,
text,
)
Format and output the text as a list element.
|
|
|
openOutput
|
openOutput (
self,
name,
title1,
title2="",
)
Write the formatting for a file header to the open file.
|
|
|
popSectionLevel
|
popSectionLevel ( self, output )
|
|
|
pushSectionLevel
|
pushSectionLevel ( self, output )
|
|
|
sectionFooter
|
sectionFooter ( self, output )
Write a general purpose section closing footer to the output.
|
|
|
sectionHeader
|
sectionHeader (
self,
output,
title,
)
Write a general purpose section openning title to the output.
|
|
|
writeText
|
writeText (
self,
text,
output,
textFormat,
quote=0,
)
Format and write the text to the output.
Arguments:
-
text
- String to be written.
-
output
- Stream to which
text should be written.
-
textFormat
- Ignored.
-
quote=1
- Boolean option to control whether the text
should be quoted to escape special characters.
|