Method: FormatterHTB.__init__

Synopsis: __init__( self, listofmodules, output_dir='.', output_type='HTB', pattern=None, texts=None, titlePage=None, additionalFiles=[] )

Initialization of the formatter. This initializes m_pattern with pattern , m_texts according to texts , and m_titlePage with titlePage. If these arguments are None , then this method assigns the defaults which are m_englishPattern , m_englishTexts , and m_englishTitle . Argument additionalFiles is a mostly empty list of additional files that belong to the documentation (for instance images for buttons that are used in pattern or logos etc). These files are copied into the HTML directory or HTB file resp. Please note, that these files shall have different base names because they get copied into the same directory.

The overall procedure is as follows:

1. set m_outputType , m_outputDir , m_listofmodules, and m_filename . m_filename is "refman" if listofmodules contains more than one name. Otherwise, filename is equal to the name of the module to be documented.
2. generate a new directory named m_filename in output_dir (HTML) or a temporary directory (HTB).
3. store name of the eventually generated temporary directory in m_tempDir .
4. generate the title file index.html .