TreeTextToHtml

Documentation generator




Home



Newest version

Description

History of changes



License

Source code


Newest version

Download version 1.0.1 released on 06.01.2006. It requires at least Windows XP.

To run the program, unzip the downloaded file where you want, and run the executable file.

Main window screenshot



Description

TreeTextToHtml is a documentation generator. Basically, you write a plain-text file in which you specify what text you want to be headers and glossary items, and the program converts the file into a number of HTML files (the content, the "Table of Contents", and the "Glossary") that you can integrate into a HTML project. The generated files contain all the links to headers and glossary items, links that you don't have to manually create or maintain.

The SexualEducation book and the Links page have been created using the predefined project model.

When you write the source plain-text file, you only need to write a few more characters that define the headers and glossary items. You can also insert predefined pictures (especially emoticons) using just a few characters.

The predefined user interface has multiple frames: the menu, the content, the table of contents, and the glossary. They are all visible at the same time, and each can be individually navigated. Clicking an item from the table of contents or the glossary, will display the associated topic in the content frame.

Headers are outlined (like this: "First level > Second level > Third level"), and each level has a link to its own topic. Also, all items that are in the glossary and can be found in the content of the book, have a link to the same place: the topic of the glossary item. The complexity of the structure of links is enormous. However, the generated document is extremely compact, and can be navigated either by scrolling from top to bottom, or by jumping from link to link (if the reader is interested only in some topics). Also, the last reading position is saved, and the next time the document is opened, the saved position is displayed.

A glossary item can have two parts: a unique part (which is mandatory and must be unique in the whole glossary), and a common part (which is optional and can be shared with other glossary items). Thus, glossary items are also outlined on two levels, containing all the chained links: from the common part to all the unique parts that share the common part, and from the unique part to the common part.

Even more, the topics that are marked with a glossary item that is common to other glossary items, will contain at their end a list with links: all those unique glossary items that share the same common part.



Note: the documentation of the program is not satisfactory, but you can simply look at the example provided in the source code archive, in the "SexualEducation" directory. There you can find the source from which SexualEducation is being built.



History of changes

First public release of TreeTextToHtml: version 1 on 6 November 2005.







License | Contact