# # $Header: /usr/local/cvsroot/pythondoc/formatters/HTML4strings.py,v 1.2 1999/05/01 01:13:21 daniel Exp $ # # Copyright (C) Daniel Larsson # All Rights Reserved. # # See copyright notice in the file 'LICENSE.TXT', which should have accompanied # this distribution. # """Strings used to build HTML files. This module just contains some string used by the HTML 4.0 formatter to create the HTML files. It is separated from the formatter to more easily be able to adapt the output. """ __author__ = "Daniel Larsson, Daniel.Larsson@telia.com" import time import pythondoc.version HEADER = \ ''' ''' % (pythondoc.version.__version__, time.ctime(time.time())) MODULE_HEADER = HEADER + ''' Module %(modulename)s %(header)s

Module %(modulename)s

''' DECL_IN = '''

Declared in module %s

''' FILE_END = ''' %(footer)s ''' CLASS_HEADER = HEADER + ''' Class %(classname)s %(header)s

class %(classname)s%(oneliner)s

Declared in module %(modulename)s

%(hierarchy)s

Synopsis

class %(classname)s%(bases)s:
%(methods)s
'''

CLASS_END = '''
''' FUNCTION_HEADER = HEADER + ''' Function %(functionname)s %(header)s

%(functionname)s%(oneliner)s

Declared in module %(modulename)s

def %(functionname)s(%(args)s)
'''

FUNCTION_END = '''
''' METHOD = ''' %(linkstart)sdef %(methodname)s%(linkend)s(%(args)s)''' METHOD_HEAD = '''

%(methodname)s(%(args)s)

%(oneliner)s

''' INHERITS_FROM = '\n # Inherited from %s\n' PARAGRAPH = '''

%s

''' MODMODULE = 'submodule %s%s\n' MODCLASS = 'class %(classname)s%(bases)s%(oneliner)s\n' FUNC_NAME = 'def %(funcname)s' FUNC_DOCLINK = '' + FUNC_NAME + '' MODFUNC_T = '%s(%%(args)s)%%(oneliner_top)s\n' MODFUNC = MODFUNC_T % FUNC_NAME MODFUNC_DOC = MODFUNC_T % FUNC_DOCLINK MODVAR = '%s %s = %s\n' MODALIAS = 'alias %s = %s (type %s)\n' FUNCTION_HEAD = '''

%(funcname)s(%(args)s)

%(oneliner)s

''' ONELINER = ' # %s' ARGS_DESC = '''
%s
''' ARG_DESC = '''
%s
%s
\n''' INDEX_HEADER = HEADER + ''' Contents %(header)s

Documented Python modules

Index

''' INDICES_HEADER = HEADER + ''' Index page %(header)s

Index page

Table of contents

''' INDEX_ENTRY = '

%s

\n' # # $Log: HTML4strings.py,v $ # Revision 1.2 1999/05/01 01:13:21 daniel # Removed Windows style line endings. # # # ***************** Version 6 ***************** # User: Daniel Date: 98-12-13 Time: 16:14 # Updated in $/Pythondoc/formatters # New email address. # Fixed some outputs. # # ***************** Version 5 ***************** # User: Daniel Date: 98-10-04 Time: 20:48 # Updated in $/Pythondoc/formatters # Added tag to tell pythondoc generated the HTML pages... # # ***************** Version 4 ***************** # User: Daniel Date: 98-08-11 Time: 20:52 # Updated in $/Pythondoc/formatters # Added placeholder for inheritance hierarchy. # Now, links from functions are only created if there is something to # link to!! # # ***************** Version 3 ***************** # User: Daniel Date: 98-08-06 Time: 21:36 # Updated in $/Pythondoc/formatters # Fixed nested elements to make the generated HTML valid. # # ***************** Version 2 ***************** # User: Daniel Date: 98-08-06 Time: 20:24 # Updated in $/Pythondoc/formatters # Added id attribute on argument description element (hyperlink target!). #