[Next] [Prev] [Up] [Top]
OUR AUTOMATED SYSTEM
A system which dynamically includes running examples.
The ADAMO documentation contains numerous examples based upon source code examples and associated output. These examples exists also in the form of running programs that are part of the ADAMO package. They are subject to changes. To avoid the tedious task of maintaining both running and included examples, we have build a system that allows Unix shell scripts to be incorporated within FrameMaker documents. These scripts are executed at MIF generation time (Figure 1.) and their output is included in the FrameMaker document.
We use this facility to include source code, but also to compile and link it, execute it, and include the resulting output
Figure 1. The overall process that builds the documentation relies on 4 steps. To begin with, FrameMaker files are converted to MIF. Next, included Unix shell scripts are expanded to build the examples. Finally, Both CDF and HTML files are generated by CDFMaker and WebMaker.
An Automated System for the Maintenance of Multiform Documentation
[Next] [Prev] [Up] [Top]
Generated with WebMaker
