|
|
|
|
|
voyant_latex.pl changes two Latex files in each zlx_ directory of the system so that they contain the appropriate information for the project before the PDF files are generated. Most of the content for the PDF files comes from Doxygen and is in a Latex format.
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.
master_project_file [optional path and] filename for the file that stores the information needed for the project and the latex files. Ideally, this should be the same project file used by the voyant_nav.pl tool, because this contains the voy_order for the project.
latex_variables [optional path and] filename for the file that contains additional comment tags with the voy_latex variables and the voy_latex_head variables.
Global variables are defined in the globe.pm file, a Perl package. Whenever these global variables are referenced here, they are prefixed with globe::.
Each Doxygen directory in the project file can have their own directories with LaTex files. The master Latex files in each of those directories can be updated with appropriate information so that the headers and footers in the PDF file contain relevant information.
To do so, several Latex variables are defined in the <!-- begin voy_latex -- !-- end voy_latex --> comment of the latex_variables file. They are:
"##master_header_tex##", "master-header.tex" "##master_doxygen_sty##", "master-doxygen.sty" "##output_header_tex##", "voy-header.tex" "##output_doxygen_sty##", "doxygen.sty" "zz-yyyy-by-companyname-zz", "by Voyant Technologies, Inc." "zz-genbydoxversion-zz", "Generated by Doxygen 1.2.11.1" "zz-outside-lfooter-zz", "Voyant Technologies, Inc." "zz-inside-rfooter-zz", "zz-docnum-zz" "zz-inside-lfooter-zz", "zz-docnum-zz" "zz-outside-rfooter-zz", "zz-doctitle-zz"
Another Latex variable can be defined in the <!-- begin voy_latex_head -- !-- end voy_latex_head --> comment of the latex_variables file. It is:
"refman.tex", "\begin{titlepage}", "\end{titlepage}"
voyant_latex.pl 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. It first reads the 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 voy_latex_head which contains additional information for the refman.tex file.
voyant_latex.pl steps through all cref_ directory names in the voy_order and generates an equivalent zlx_ directory name. These directories 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.
|
|
|
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-hug-02