Contents   Module: pymanual
<<Function: only_letters_digits<<   >>Class: FormattingContext>>

Class: FormatterHTB

Base classes:
Formatter

This class is the currently available output to HTML and hyper text books (HTB). Text layout is based on page layout pattern m_pattern (set by __init__( )) where certain tags are replaced by generated text. All these tags are introduced by a dollar sign (which is here in the documentation followed by a blank to prevent tag expansion).

$ NEXTLINK:
Gets replaced by the URL to the next HTML file in the document (not available in the title page).
$ NEXTTITLE:
Gets replaced by the title of the next HTML file in the document (not available in the title page).
$ PREVLINK:
Gets replaced by the URL to the previous HTML file in the document (not available in the title page).
$ PREVTITLE:
Gets replaced by the title of the previous HTML file in the document (not available in the title page).
$ UPLINK:
Gets replaced by the URL to the next higher level HTML file (not available in the title page).
$ UPTITLE:
Gets replaced by the title of the next higher level HTML file (not available in the title page).
$ TITLE:
The title of the current element (not available in the title page).
$ MODNAMES:
A comma separated list of the names of the modules to be documented. Without links.
$ MODLIST:
An item list or table of the modules to be documented includeing hyperlinks.
$ PARTLINKS:
A list of hyperlinks to parts of the current context. The parts of the empty context are the modules to be documented. The parts of a class are the methods. A method or a function has no parts, so this will be replaced by the empty string.
$ TODAY:
Date in English format.
$ TOC:
Table of contents: An enumeration of all pages.
$ HEUTE:
Date in German format.
$ DOCUMENTATION:
The documentation of the current element in HTML format (not available in the title page).
$ AUTHORS:
The author of the element. This may be an empty string.
$ COPYRIGHT:
A string describing copyright info. This may be an empty string.
$ VERSION:
A string describing the version. This string may be empty.

Users may add general remarks to an overall project (including several modules) providing a particular title page by __init__( ) and optionally additional HTML pages as additional files. Note, that functions, classes, and methods are put in files named according to FormattingContext.get_label( )+ '.html' .

Some of the members of this class represent actual state. Others provide default parameters. Members contributing to the state:

m_outputType:
Defines the type of desired output. Currently allowed are the strings "HTB" and HTML.
m_outputDir:
Defines the directory where to save the desired output.
m_listofmodules:
The list of names of the modules to be documented.
m_tempDir:
Holds the pathname to a temporary directory if required.
m_filename:
Holds the filename of the desired output file without suffix.
m_index:
If this is not None then this is a list of tuples (indices, label) for the index file (suffix .hhk in input for Microsoft help compiler or HTB archives). This map is filled on generating documentations.
m_indexNo:
A counter for the targets of indices from m_index . This counter is used to produce unique labels for the indices to point at.
m_openDocuments:
Is a mapping of context (instance of FormattingContext ) to strings representing the content of the $DOCUMENTATION tag for the object represented by the key.
m_itemsToClose:
Unfortunately, the interface from code analysis does not provide any menas to indicate the end of an item element. However, items can be expected to end with either the closing of a list element or the start of a new item. So, this member provides the necessary state to close any open list element providing a stack on list elements to be closed in appropriate situations. This stack holds the tag for closing the item. This is done on method closeItem( ).
m_pattern:
The general pattern for HTML pages.
m_texts:
Is a list of predefined texts.
m_titlePage:
The pattern of the title page. This page is only generated on documenting more than one module.
m_additionalFiles:
A list of filenames that should be integrated into the resulting documentation because they serve as source of multimedia data or as destination of hyper links. Note, that these files will be added to the resulting document with their base names. So, hyper links should refer to the base names of these files and base names shall not be shared among additional files.

The following members provide hints for calling the class and can be requested statically.

m_englishPattern:
A simple m_pattern for English documentation.
m_germanPattern:
A simple m_pattern for German documentation.
m_englishTexts:
An English version of m_texts .
m_germanTexts:
A German version of m_texts .
m_englishTitle:
An English pattern for the title page.
m_germanTitle:
A German pattern for the title page.

Member of class FormatterHTB


Elements:
(c) Dr. Harald Meyer auf'm Hofe 2005-2006 
pymanual 0.999

Generated by pymanual (c) 2005-2006 on August 02, 2006.