Suggested workflow

From the high-level point of view, the development process is three-step:

At the beginning, the first step might be hard, as the XSLT code for converting XML to TeXML might be with faults, and you get incorrect LaTeX code.

If you are lucky, the only errors you get are the missed images. To get a summary of the missed files, issue the following command:

$ cdoc missed

To get some result, you might prefer to play with the LaTeX code instead of fixing XSLT. Time to time, you want to re-check log files for the list of errors. The corresponding command is:

$ cdoc errors

If the LaTeX code doesn't compile under Consodoc, check the environment which Consodoc uses to run LaTeX. To get the command prompt with this environment, issue the following command:

$ cdoc texenv

After you get some result, check the PDF for layout problems. If you can fix the problems by improving the XSLT code, do it. However, some problems can be fixed only manually. The recommended approach is to use the DVI file. To get one, issue the following command:

$ cdoc dvi

Open the DVI file from the folder tmp in the xdvi viewer. If it doesn't open due to unresolved dependencies on a custom TEXMF tree, ajust the environment:

$ cdoc texenv2

When you see a problem in the DVI file, use the combination Ctrl-Mouse1 to make xdvi open an editor. The editor will load the LaTeX code and position the cursor near the source of the problem.

While correcting the LaTeX code, remember the changes you made:

$ cdoc patch

After you get a good result, start tuning it. The log file should contain a lot of warnings about overfull boxes. To re-display the warnings, issue the command:

$ cdoc warnings

The most often used LaTeX commands to tune the layout are: \enlargethispage, \newpage, \hfuzz, \\, \discretionary.

PDF and DVI files are re-generated each time you changed the sources, but Consodoc doesn't track external dependencies, such as changes in the custom TEXMF tree. If you want to force re-generation of the DVI or PDF, issue the following commands:

$ cdoc repdf
$ cdoc redvi

When you are satisfied with the layout, remember the changes you made:

$ cdoc patch

If you use a version control system, put the patch file under its control.