LaTeX Source
The LaTeX source is contained in flowframtk-0.8.4-src/doc/manual The manual is currently only available in English. The manual requires the file flowframtk-0.8.4/doc/version.tex which is created by the main makefile flowframtk-0.8.4/Makefile. If you are not using make, you will need to create this file, which should simply contain the line:
\version{0.8.4}
The documentation consists of the following files:
- Makefile
- The documentation makefile. Just running
"make" will make the PDF version and the Java helpset.
- Makefile-lang
- Creates the documentation for either
en-GB or en-US, depending on the value of the environment variable
APPLANG.
- flowframtk-main.tex
- The main contents of the manual for FlowframTk (i.e. this document).
- flowframtk-<lang>.tex
- The driver files
(containing the \documentclass command) for the FlowframTk manual.
- accelerators.tex
- The contents of
Table 2.1. This file is input by flowframtk-main.tex.
- preamble.tex
- The main bulk of the preamble for
flowframtk-main.tex and jdrview-main.tex.
- jdrview-main.tex
- The main contents of the manual for Jdrview.
- jdrview-<lang>.tex
- The driver files
(containing the \documentclass command) for the Jdrview manual.
- jdrutils-main.tex
- The main contents of the manual for the command line
converters, such as jdr2tex.
- jdrutils-<lang>.tex
- The driver files
(containing the \documentclass command) for the jdrutils manual.
- flowframtk.sty
- Style file used by the documentation.
- transdict.pl
- This is a Perl script that converts the
dictionary file to a file that TeX can parse
(dictionary-<lang>.tex).
- flowframtk.perl
- This is the LATEX2HTML version
of flowframtk.sty. This also creates temporary files
used by makehelpset to assist generating the helpset.
Note that flowframtk.sty loads the glossaries
package, but flowframtk.perl doesn't load the equivalent
glossaries.perl as flowframtk.perl uses popup
windows to display the glossary terms instead of linking them
to the glossary section.
- fixpaths
- This removes the path names to the images
used by the HTML files that form the helpset. This is needed
as the HTML files and the images are moved to a different location.
- makehelpset
- This is a Perl script that assists
making the helpset. It uses the files generated by
flowframtk.perl to create the map and index files required by
the JavaHelp utility jhindexer.
- Makefile.jhindexer
- The Makefile used to generate
the helpset.
- images-<lang>/
- Images specific to this particular language set. Images used by both US and UK manuals are stored in ../sharedimages/