Table of Contents

Class: HTMLTableFormatter HappyDoc-r0_7_1/formatter/formatter_htmlfile.py

Output documentation using HTML with tables.

Base Classes   
formatter_file.FileBasedFormatter
Methods   
__init__
_writeListItems
closeOutput
dedent
descriptiveListFooter
descriptiveListHeader
descriptiveListItem
dividingLine
formatCode
genericSectionFooter
genericSectionHeader
getFilenameExtension
getInternalReference
getNamedReference
getPythonReference
getReference
getRootLocation
getRootNodeName
htmlFooter
htmlHeader
indent
itemFooter
itemHeader
listFooter
listHeader
listItem
openOutput
popSectionLevel
pushSectionLevel
sectionFooter
sectionHeader
writeCode
writeText
  __init__ 
__init__ (
        self,
        docSet,
        pageBackgroundColor='#ffffff',
        levelOneHeadingBackgroundColor='#88bbee',
        levelOneHeadingForegroundColor='#000000',
        levelTwoHeadingBackgroundColor='#99ccff',
        levelTwoHeadingForegroundColor='#000000',
        appName='HappyDoc',
        appVersion='Unknown',
        appHome='http://happydoc.sourceforge.net',
        docsetTitle=None,
        dateStampFiles=1,
        **configuration,
        )

Initialize the HTMLTableFormatter.

Parameters

docSet

the DocSet instance containing global cross-reference information

pageBackgroundColor

background color for HTML pages

levelOneHeadingBackgroundColor

background color for level one heading sections

levelOneHeadingForegroundColor

foreground color for level one heading sections

levelTwoHeadingBackgroundColor

background color for level two heading sections

levelTwoHeadingForegroundColor

foreground color for level two heading sections

dateStampFiles

Boolean indicating whether or not to include a date/time stamp in files.

**configuration

additional, optional, configuration values

  _writeListItems 
_writeListItems (
        self,
        items,
        output,
        )

Format and output the items as list elements.

Determine the geometry of the list (number of columns and rows)

Output the list

  closeOutput 
closeOutput ( self,  output )

Close the output handle.

  dedent 
dedent ( self,  output )

End an indented section.

  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.

  descriptiveListItem 
descriptiveListItem (
        self,
        output,
        item,
        description,
        )

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.

  formatCode 
formatCode ( self,  text )

Format text as source code and return the new string.

  genericSectionFooter 
genericSectionFooter ( self,  output )

Write a general purpose section closing footer to the output.

  genericSectionHeader 
genericSectionHeader (
        self,
        output,
        title1,
        title2,
        anchor=None,
        )

Output a standard nested table chunk which represents a section header.

The output looks something like this:

            |--------|---------------------------|
            | title1 | title2                    |
            |        |---------------------------|
            |        | section text goes here
            |--------|

Parameters

output

destination for written output

title1

title to be placed in left column

title2

title to be placed on top of right column

anchor

optional, anchor to which a reference can point to find this section

  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,
        )

Returns a reference to name within the documentation for infoSource from relativeSource.

print \ngetNamedReference(, infoSource.getName(), ,, name, ,, relativeSource, )

  getPythonReference 
getPythonReference ( self,  moduleName )

Returns a reference to moduleName documentation on the Python.org documentation site.

  getReference 
getReference (
        self,
        infoSource,
        relativeSource,
        )

Returns a reference to the infoSource from relativeSource.

print \ngetReference(, infoSource, ,, relativeSource, )

  getRootLocation 
getRootLocation ( self,  output )

Return the root documentation node location relative to this output location.

print **SAME

  getRootNodeName 
getRootNodeName ( self )

Returns the name of the root node for documentation of this type.

  htmlFooter 
htmlFooter ( self,  output )

Output a standard HTML footer used by all output files.

  htmlHeader 
htmlHeader (
        self,
        title,
        subtitle,
        titleBg,
        titleFg,
        output,
        )

Output a standard HTML header used by all output files.

Parameters

title

title of the document

output

destination for written output

titleBg

background color for the title bar

titleFg

foreground color for text in the title bar

  indent 
indent ( self,  output )

Begin an indented section.

  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.

  listItem 
listItem (
        self,
        output,
        text,
        )

Format and output the text as a list element.

  openOutput 
openOutput (
        self,
        name,
        title1,
        title2=' ',
        )

Open output destination using name with the title from title1. Write title2 as a secondary title to the new output.

  popSectionLevel 
popSectionLevel ( self,  output )

Pop a section level from the output stack.

  pushSectionLevel 
pushSectionLevel ( self,  output )

Push a section level on the output stack.

  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.

  writeCode 
writeCode (
        self,
        text,
        output,
        )

Format and write the text to output as source code.

  writeText 
writeText (
        self,
        text,
        output,
        )

Format and write the text to the output.

text = StructuredText.html_quote(text)


Table of Contents

This document was automatically generated on Sat Sep 9 20:27:32 2000 by HappyDoc version r0_7_1