voyant_latex.pl File Reference
Changes two Latex files in each zlx_ directory of the system so that they contain the appropriate information for the project.
More...
Go to the source code of this file.
Defines
Functions
Variables
Detailed Description
Changes two Latex files in each zlx_ directory of the system so that they contain the appropriate information for the project.
-
Parameters:
-
globe::path |
default location to find the Latex temporary directories. The name should be terminated with a slash (\). This should be the top directory where various master-doxygen.sty and master-header.tex can be found and more importantly, the zlx_ directories where generated LaTex files from Doxygen reside. |
globe::master_tree_file |
[optional path and] filename for the file that stores the information needed for the project and the latex files. It does need additional comment tags containing the voy_latex variables and the latex_header variables. |
-
Returns:
-
Generates appropriate header.tex and doxygen.sty files for each zlx_ directory in the system. These are then used in Latex's PDF generation for each subproject.
This tool reads in the voyant_master_nav.html file (or equivalent). This file must specify:
- The voy_order for the system that lists all directories, associated names, and associated PDF files.
- The voy_latex which contains variables used in LaTex build such as master file names, company name, etc.
- The latex_head which contains additional information for the refman.tex file.
This tool steps through all cref_ directory names in the voy_order and generates an equivalent zlx_ directory name which should be found under $globe::path. The voy_latex variables declare where additional master.tex and master.sty files reside. These contain call-outs for variables that voy_latex resolves for the given project. All variables in the master files are resolved with information appropriate for the project.
Upon conclusion, appropriate refman.tex and doxygen.sty files are written to each zlx_ directory.
-
Author:
-
Glenn C. Maxey
Definition in file voyant_latex.pl.
Define Documentation
Function Documentation
if |
( |
exists($globe::m_info{$def_type}) |
|
) |
|
|
if |
( |
@ |
ARGV, |
|
|
$ |
_arg_inc |
|
) |
|
|
Variable Documentation
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-perl-hcr-02