Name

buildbooks — Building Books with make

Make Targets

Use the following syntax:

make [TARGET]

make ROOTID={ID_VALUE} [BUILDTARGET]

The optional TARGET argument can be a BUILDTARGET, or some other target. The BUILDTARGETS can have one or more of the following names:

pdf

Creates PDF with cropmarks and with grey images. This is the default target.

color-pdf

Creates PDF without cropmarks and with color images.

force

This is just like the pdf target, but every source file is profiled again. This is useful when you make changes to the build environment that make cannot detect.

html

Creates HTML. The resulting document can be found in the html subdirectory with index.html being the starting point. If you use a ROOTID, the starting point will be html/$(ID_VALUE).html.

The following are common targets where ROOTID does not have any effect:

check

Print the values of several variables that are used in the Makefile.

clean

Remove all profiled files as well as temporary files. Does not remove books that have been made.

configure

Starts a reconfiguration of the currently used xep-suse script. This is necessary after an update, when a change in the xep-daps.xml file has changed. If unsure, just run the command. See also the target update.

directories

Create a template directory structure. When creating a completely new project, you may just create the main directory, and copy the file Makefile from an existing project. Make sure that the path to common.mk in Makefile is correct and run make directories.

dist-html

Create html and desktop packages. These are needed to submit the packages of the distribution. Resulting files are $(BOOK)_$(LANG)-desktop.tar.bz2 and $(BOOK)_$(LANG)-html.tar.bz2 where $(LANG) is selected by the lang attribute of $(MAIN).

filelist

Creates a list of all xml files used in the current book. You might want to add the entity file to complete this list.

dist-xml

Create packages of the unprofiled xml files and of the profiled xml files in .zip archives. The resulting name is $(BOOK)_$(LANG)-src.zip for the unprofiled xml and $(BOOK)_$(LANG).zip for the profiled version. If one of these files already exists, it is renamed with the old script.

dist-graphics

Create package of the PNG and SVG files that are used in the current project. The name of the archive is $(BOOK)_$(LANG)-graphics.tar.bz2 where $(LANG) is selected by the lang attribute of $(MAIN).

showgfx

Print a list of the images that are missing from the currently selected book.

show-remarks

Show all the remarks in a selected book. In oXygen, the displayed xpath may also be used to jump to the remark in the source xml file.

update

Get all updates of the stylesheets and make mechanics. After this, the profiling step of all source files is performed during the next rebuild. See also the target configure.

validate

Update the profiling step and validate the profiled book.

validatesingle

Validate each individual file of the XML source, rather than the entire book.

The variable ID_VALUE can contain any chapter or section id. In this case, the basename of the resulting pdf or html will be this id.