SimpleTextFormatter Files

STF is a system of automatically generating professional documentation under control of a program or a script. It is frequently used to automatically generate test reports. STF is also used to clean up the output of a process and turn it into a nice looking report.

Normally a developer only works with the STF API layer. The developer throws text at the API, which sorts it out and writes a file in the STF format. STFXlate.py then translates STF formatted text into HTML, LaTeX, or WIKI format. For LaTeX files, pdflatex is used to translate the LaTeX file to PDF.

The process is designed to be automated, or command line driven, or menu driven, as desired.

The enclosed documentation is written in STF as an example and also to test the process. Also included is a case study using the Python API. This is a test report generator. See the enclosed documentation for details.

What sets STF apart is its ability to integrate multipart documents. It can accept information in multiple STF files, Perl's POD format, plain text, etc. The standard formatting commands are recognized: Paragraphs, Lists, Tables, Figures, Footnotes, etc. It is designed to take a document and output it as PDF, HTML, or Wiki, where the outputs are very similar in appearance. So a web version and printed version are equivalent.

The documentation also discusses how to export STF to other formats, such as RTF, DocBook, etc.

See the Wiki for details: https://sourceforge.net/p/simpletextformatter/wiki/DocumationMagic/

Download STF: https://sourceforge.net/projects/simpletextformatter/files/