DocumationMagic

Documation Magic is designed to add the ability for programs and scripts to create sophisticated documation on the fly. Calls are made to an API and the API writes a file in Simple Text Format (STF). A translation process is then invoked to produce an HTML, RTF, PDF, or Wiki document. Specific details of the API depend on the language to which it is targeted. Thus a C API would differ slightly from a C++ API which would differ slightly from a Python API, etc. Because each API outputs in STF format, the resulting document looks the same regardless of the API used to produce the intermediate format. The documents in this Wiki were generated using Documation Magic/STF. You can view them on-line here, or download the corresponding PDF representation. You can also download the entire system, i.e. STF, to view the document source.

Installation Process Under Development

Status:

• PDF output - Working Correctly
• HTML output - Working Correctly
• RTF output - Working Correctly
• Wiki output - Working Correctly

Capabilities:

The capabilities provided are designed to produce professional looking documents. Capabilities provided include:
1 Table of Contents including a list of tables and a list of figures
2 Index
3 Inter and intra document links
4 Numbered and unnumbered paragraphs
5 Enumerated and bullet lists
6 Formatted tables
7 Inline formatting (bold, italics, etc.)
8 Macro capability to extend the available functionality
9 Intelligent targeting of the content to HTML, PDF, Wiki, and RTF documents.
10 Fully controllable cover page(s) for formal documentation, or a simple cover page for informal documents
11 Conditional processing

The major output switches are:
--latex = create a latex document which is processed by pdflatex to create a pdf representation of the document.
--html = directly create an HTML representation of the document.
--rtf = create a latex document which is processed by latex2rtf to create an RTF representation of the document.
--wiki = directly create a markdown document which can be uploaded to a wiki site.

The Wiki output displays differently on different sites. This is because markdown, the Wiki format, is not standardized. See the [Parenthetical Notes] for a discussion.

The STF Syntax Summary was generated by STFXlate using the Wiki output flag (--wiki), See STF Syntax Summary, or alternately download the same document in PDF format. Part of the strength of this system is a single source document can be exported to Wiki, PDF, HTML, RTF, and a few other formats. The PDF representation is shown above. All versions, including the HTML version are part of the STF download. The same source (also included in the STF download) was used to generate all three representations.

Additional Information (all written in STF and translated to produce Wiki, PDF, and HTML representations. Because of Wiki limitations, the PDF and HTML versions look a bit better, even though the Wiki versions are legible.) is as follows:
1. Syntax Summary -- This is the STF reference document.
2. Creating Documents With Cover Pages -- Examples of how to setup cover pages.
3. Test Report Generator -- this is a description of how to use the sample TRG to produce test reports. The TRG was written using the STF Python API (Also included with STF.)
4. Python Interface -- This is a description of the STF Python Interface library. Use this when generating reports from Python.
5. Sample Report -- A sample Formal test report created from fictional test data.
6. Sample Quick Look Report -- A sample quick look test report created from the same fictional test data. The quick look report shows all of the information from the TRG, the formal report only contains a subset. The Quick Look report is automatically produced by the TRG. The Formal report is generated using the tables generated for the Quick Look report.
7. Working With Images -- How to use figures, images and tables of images.
8. Create Document Under Program Control
9. Working with the GUI
10. Image Study -- an example of how to manipulate images.
11. [Version] -- Versioning information