|
|
|
|
|
UNIX Shell scripts are used to create control the process of generating the HTML system, mostly because this is Voyants development environment. If we would have had a development environment based on Windows, I would have used DOS batch files.
Simplicity in usage and understanding were the goals in writing these scripts. The naming convention illustrates this most readily.
All scripts begin with a two-digit number that is intended to reflect the approximate order that the script can be called with respect to the other scripts.
Information after the two-digit number indicates what operation it performs.
All scripts have a .b extension to indicate (to me) that it is like a DOS batch file that would have a .bat extension. Although the extension doesnt play a role in UNIX, it is a useful device to separate file types.
Assuming that the first digit in the script number is the series, then a 0 as the second digit in the script number is the master and typically calls the other numbers in the series. For example, 30_tp_tools.b calls the 31_perl.b and 31_script.b files and the 32_perl.b and 32_script.b files.
Scripts beginning with the same number can be called from the command line in any order, such as 56_nav_script.b and 56_nav_index.b.
Scripts that have a 5 as the second digit are generally always called from within other scripts and accomplish several operations that would be tedious to repeat in higher level scripts. For example:
35_gen_dox.b is called from 32_perl.b and 32_script.b.
45_latex_build.b is called from 40_latex_build.b.
55_nav_gen.b is called from both 50_nav_update.b and 35_gen_dox.b.
Here is a list of the Shell script files.
Note: Although this TechPubTools project only has one 30_ script file for controlling Doxygen builds of API source code, it is possible to have many of them that output to different cref_ directories. Moreover, source code dependencies can exist between these Doxygen projects that tag files help resolve. In such an event, the order in which the 30_ script files are called can make a difference and would be specified in the 00_ files.
|
|
|
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-hug-02