A. Adding a New Project

A. Adding a New Project¶

When adding a new project, you can distinguish two cases. First, you want to reuse some of the existing chapters and, therefore, only need to create a new MAIN*.xml and a new ENV-* file. If you want to create a completely new project, you need to set up the directory structure and also put the Makefile in place.

The main task of the Makefile is to include the ruleset provided in a system makefile named common.mk. You can copy the Makefile from another project and make sure that the path to novdoc is correct.

In the ENV-* file you need to set several parameters, the following are mandatory:

DTDROOT

This variable contains the absolute path to the novdoc directory on your system. This is usually done with a line like:

export DTDROOT=$(cd ../../novdoc; pwd)

MAIN

This is the MAIN file. The top level file of your document. All required files are included directly in this file, or in one of the included files. This file must exist in the xml subdirectory.

BOOK

Use this variable to give your project a name. The resulting PDF will be named like that variable, extended by .pdf.

Some necessary variables that are needed by the system must be loaded from the system profile. The current ENV-* contains the line:

. $DTDROOT/etc/system-profile

There are also several optional parameters you can set in this file. It is very important that you set the optional parameters after loading the system profile. The system profile removes all previously set optional values in order to have a clean environment. The following list gives an overview over currently available optional parameters.

PROFOS and PROFARCH: When using profiling attributes in your document, you need to select the needed parts by setting these variables.
FOPOPTIONS: The default value of FOPOPTIONS is -q. This changes the behaviour of the FO-Processor (XEP and FOP) to be less verbose about what it does.
COMMENTS: You might want to print the comments you include in a document. To print your remakrs in the PDF, set COMMENTS variable to 1.

For the various transforming processes, make needs several directories are needed by make. These have to be provided in each project directory.