[Happydoc-checkins] CVS: HappyDoc3/happydoclib/docset/docset_TAL __init__.py,NONE,1.1

[Doug H. <dou...@us...>]

Update of /cvsroot/happydoc/HappyDoc3/happydoclib/docset/docset_TAL
In directory sc8-pr-cvs1:/tmp/cvs-serv32222/happydoclib/docset/docset_TAL

Added Files:
	__init__.py 
Log Message:
Initial version of a TAL template based documentation set.  This
version does not actually generate any output.


--- NEW FILE: __init__.py ---
#!/usr/bin/env python
#
# $Id: __init__.py,v 1.1 2003/01/26 19:12:58 doughellmann Exp $
#
# Copyright 2003 Doug Hellmann.
#
#
#                         All Rights Reserved
#
# Permission to use, copy, modify, and distribute this software and
# its documentation for any purpose and without fee is hereby
# granted, provided that the above copyright notice appear in all
# copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of Doug
# Hellmann not be used in advertising or publicity pertaining to
# distribution of the software without specific, written prior
# permission.
#
# DOUG HELLMANN DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
# NO EVENT SHALL DOUG HELLMANN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#

"""TAL-based documentation set writer.

"""

__rcs_info__ = {
    #
    #  Creation Information
    #
    'module_name'  : '$RCSfile: __init__.py,v $',
    'rcs_id'       : '$Id: __init__.py,v 1.1 2003/01/26 19:12:58 doughellmann Exp $',
    'creator'      : 'Doug Hellmann <do...@he...>',
    'project'      : 'HappyDoc',
    'created'      : 'Sun, 19-Jan-2003 16:38:01 EST',

    #
    #  Current Information
    #
    'author'       : '$Author: doughellmann $',
    'version'      : '$Revision: 1.1 $',
    'date'         : '$Date: 2003/01/26 19:12:58 $',
}
try:
    __version__ = __rcs_info__['version'].split(' ')[1]
except:
    __version__ = '0.0'

#
# Import system modules
#
import sys

#
# Import Local modules
#
import happydoclib
from happydoclib.docset import base
from happydoclib.trace import trace

#
# Module
#

TRACE_LEVEL=0

class TALDocset(base.MultiFileDocSet):
    """TAL Template Docset Writer

    Parameters
        
    """

    def __init__(self, scanner,
                 title,
                 outputDirectory,
                 includeComments=1,
                 includePrivateNames=1,
                 sortNames=0,
                 statusMessageFunc=None,
                 extraParameters={},
                 ):
        trace.into('TALDocset', '__init__',
                   scanner=scanner,
                   title=title,
                   outputDirectory=outputDirectory,
                   includeComments=includeComments,
                   includePrivateNames=includePrivateNames,
                   sortNames=sortNames,
                   extraParameters=extraParameters,
                   outputLevel=TRACE_LEVEL,
                   )
        base.MultiFileDocSet.__init__(self, scanner,
                             title=title,
                             outputDirectory=outputDirectory,
                             includeComments=includeComments,
                             includePrivateNames=includePrivateNames,
                             sortNames=sortNames,
                             statusMessageFunc=statusMessageFunc,
                             extraParameters=extraParameters,
                             )
        trace.outof(outputLevel=TRACE_LEVEL)
        return

    def _initializeWriters(self):
        """Hook to allow subclasses to register writers without having to
        override __init__ with all of its arguments.
        """
        base.MultiFileDocSet._initializeWriters(self)
        return

    def writeTOCFile(self, packageTreeNode):
        """Write the table of contents for a directory.

        Subclasses must implement this method.

        The packageTreeNode is a directory, and the table of contents
        for that directory should be written as appropriate.
        """
        self.statusMessage('writeTOCFile needs work')
        return

    def writeFileHeader(self, output, packageTreeNode, title='', subtitle=''):
        """Does nothing.
        """
        return

    def writeFileFooter(self, output):
        """Does nothing.
        """
        return

    def processPythonFile(self, packageTreeNode):
        """Handler for text/x-python nodes.
        """
        self.statusMessage('processPythonFile needs work')
        return
    
    def processPlainTextFile(self, packageTreeNode):
        """Handler for text/x-structured and text/plain nodes.

        Converts the input file to the output file format and
        generates the output.  The output directory is assumed to
        already exist.
        """
        self.statusMessage('processPlainTextFile needs work')
        return

    def processPythonClass(self, packageTreeNode):
        """Writes information about classes in this module to the output stream.
        """
        self.statusMessage('processPythonClass needs work')
        return
    

def entryPoint():
    return { 'name':'TAL',
             'factory':TALDocset,
             }