HtmlDoc - A HTML Text-processor for Java Elements

PACKAGE:charite.christo. PACKAGE:javax.swing. PACKAGE:java.lang. Note that the project is still in a very early state.!

Motivation: The documentation of complex applications contains references of GUI elements which need to be kept up to date. Problems evolve when the program source is changed and for example the label of a button is altered. With every change in the source text the corresponding parts of the documentation need to be changed as well. Tis is also true for screen-hardcopies within the documentation. For smaller projects all citations of a GUI button can be changed manually when the respective label text or the button functionality changes. However, for more complex programs this is performed more effectively using HtmlDoc. The HtmlDoc can also be used for HTML files describing Java code.

Implementation: Special HTML expressions are inserted by the user. These HTML expressions are replaced by this program and a modified HTML file is generated. The HTML expressions are enclosed in the tags for italics <i>. Thus, the HTML code is syntactically valid before as well as after processing. The HTML expressions can refer to public variables and methods in Java classes. Therefore these classes must be public and their class files must be in the class path.

Parameters: Four types of input parameters are allowed
Command line switches: Examples: The following example command line processes this document.
java charite.christo.HtmlDocMain  charite.christo.HtmlDocMain
    


Description of the special HTML expressions: Note that the syntax for methods and fields is similar to the JDK javadoc tool. After the class name a "#" sign preceedes the name of the method or variable. A frequent mistake is to use a dot instead of "#". Currently the following tags are understood:
STRING_ARRAY:HtmlDoc#SPECIAL_HTML_TAG