texjavahelp

Help library for Java GUI applications with LaTeX source

Work in progress.

The aim is to produce an alternative to JavaHelp for my Java GUI applications. The documentation source will be in LaTeX, but it needs to be simple enough for the TeX Parser Library to parse. This means that the same source can be used to create both the PDF documentation and the in-application help.

To compile the documentation you need to first create texjavahelplib.bib:

bin/tjhxml2bib lib/resources/texjavahelplib-en.xml lib/resources/texjavahelpdemo-en.xml -o doc/texjavahelplib.bib

The above creates a Bib2Gls file with entry information obtained from the application's XML dictionary files. The entry tags have a particular system that helps tjhxml2bib to determine the glossary entry hierarchy and entry fields. This allows the documentation system to reproduce menu hierarchies, mnemonics, keystrokes and button labels.

Then compile the LaTeX source:

lualatex texjavahelpdoc
bib2gls -g --no-warn-unknown-entry-types texjavahelpdoc
lualatex texjavahelpdoc
lualatex texjavahelpdoc

NOTE The temporary files (aux, toc, glstex etc) created during the build process are required for the next step.

The helpset files can then be created with:

texjavahelpmk doc/texjavahelp.tex lib/resources/helpset

Since texjavahelpmk only has a limited knowledge of LaTeX commands and packages, it's best to minimise the number of packages used. The user-level commands and environments provided by texjavahelp.sty are recognised but as JEditorPane only has limited CSS support, some effects from the PDF can't be replicated in the HTML files.

Home: https://github.com/nlct/texjavahelp