Name

mk_docbook_pdf — Generate PDF documentation

Synopsis

mk_docbook_pdf SOURCE=source_file PDF=pdf_name

Options

SOURCE=source_file

Specifies the DocBook XML source file to process.

STYLESHEET=xsl_file

Specifies the XSL stylesheet for generating Formatting Objects. Defaults to $MK_DOCBOOK_XSL_DIR/fo/profile-docbook.xsl.

INSTALLDIR=install_dir

Specifies the directory where the generated PDF will be placed. Defaults to $MK_DOCDIR/pdf.

INCLUDES=source_list

Specifies a list of additional files that might be included or referenced by source_file, such as included xml files or images.

DEPS=deps

Specifies any additional dependencies needed to generate the documentation

Description

Processes the specified source file with XSLT and Apache FOP to produce a PDF file called pdf_name.

To use this function, you must use mk_check_docbook as well as mk_check_docbook_pdf to check for all prerequisits in a configure section of your project, and both must succeed.

You can test if DocBook processing is available with mk_have_docbook and if PDF generation is available with mk_have_docbook_pdf. This function will fail it is not available.