Table of Contents

Class: FileBasedFormatter ../HappyDoc-r2_0/happydoclib/formatter/fileformatterbase.py

A base class for file-based formatters for HappyDoc.

Base Classes   
happydoclib.happyformatter.HappyFormatterBase
Methods   
__init__
closeOutput
fixUpOutputFilename
getFilenamePrefix
getFullOutputNameForFile
getFullOutputNameForObject
getLocalOutputNameForObject
getOutputNameForFile
getOutputNameForObject
getRootNodeName
openOutput
  __init__ 
__init__ (
        self,
        docSet,
        filenamePrefix='',
        **extraNamedParameters,
        )

Initialize a FileBasedFormatter.

Parameters

docSet
The documentation set controlling the formatter.
filenamePrefix
A prefix to append to the base names of files and directories being created. This is useful for situations where the names which would be automatically generated might cause a name clash or conflict.
extraNamedParameters
Parameters specified by name which were not supported by a subclass initialization.
  closeOutput 
closeOutput ( self,  output )

Close the output handle.

  fixUpOutputFilename 
fixUpOutputFilename ( self,  filename )

Tweak the filename to remove relative references and add the safe prefix.

  getFilenamePrefix 
getFilenamePrefix ( self )

Return the filename prefix value for this formatter instance.

  getFullOutputNameForFile 
getFullOutputNameForFile ( self,  filename )

Get the full name, including path, to the filename to convert.

  getFullOutputNameForObject 
getFullOutputNameForObject ( self,  infoObject )

Get the full name, including path, to the object being output.

  getLocalOutputNameForObject 
getLocalOutputNameForObject ( self,  infoObject )

Return a local reference to base name of the thing to which output should be written for an info source. This is usually a file name, but could be anything understood by the formatter as a name. If infoObject is None, return the name for a root node for this formatter.

  getOutputNameForFile 
getOutputNameForFile ( self,  filename )

Return the base name of the thing to which output should be written for a file. This is usually a file name, but could be anything understood by the formatter as a name. If infoObject is None, return the name for a root node for this formatter.

  getOutputNameForObject 
getOutputNameForObject ( self,  infoObject )

Return the base name of the thing to which output should be written for an info source. This is usually a file name, but could be anything understood by the formatter as a name. If infoObject is None, return the name for a root node for this formatter.

  getRootNodeName 
getRootNodeName ( self )

Return the name of the root node for the documentation tree.

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

Open the named output destination and give the title.


Table of Contents

This document was automatically generated on Sun Dec 30 07:30:18 2001 by HappyDoc version 2.0