FEATURES |
 |
The main features of Source Help Builder are:
- adding any source modification to help project.
How it works: the program scans the source code and creates a structure tree allowing to synchronize help file with source code.
 
This process is reversible, it means that descriptions from all topics can be added to the code as comments, so the source text will be documented. If something is in the tree still but that was deleted from the sources, it is displaying: the deleted classes are unchecked in the Hierarchy tree, however, you should decide their future by yourself, probably, they contain any important descriptions or something else.
In other words this feature does Source Help Builder interacted with source code on all levels.
- creating different help formats.
Source Help Builder creates help in HLP, CHM and PDF formats and can be as printed so integrated with Help System of Delphi IDE. The help project can be exported to XML file and imported from XML file too.
- visualization of the help writing process.
You control how well your documentation is done on any stage. The Summary, Description and Note sections show either there is any text in the approach section of each topic and checked automatically.
You can set either the topic has been completed fully (4 clicks on the circle to fill it fully) or almost completed (3 clicks to fill the circle for 3/4) or requires any important adding (2 clicks to fill the circle for 1/2) or contains just minimal descriptions (1 click to fill the circle for 1/4). So, a help writer can see a real level of the help completeness. It can be used during help compiling, for example, check the option Topic Completeness and choose "25%" to include all topic with "25%" and more completeness rank.
- fully functional word processing (WYSIWIG mode).
You can customize the help text inserting images and tables, selecting fonts, colors, alignments etc. A WYSIWYG mode allows a developer to see what the end result will look like while the document is being created.
- multi language help and documentation.
Source Help Builder allows you to localize documentation keeping all links between any help topics. You can translate topics either in a new window or in the same window that the original text; in case any topic are not translated yet, it will be included to the help in the original language.
|
