jhradilek / publican-makefile Goto Github PK

publican-makefile — a universal makefile for Publican-managed DocBook projects

make [OPTION...] [TARGET...]

The publican-makefile project provides an easy way to build documents that are managed by Publican, an open-source publishing system for documentation authored in DocBook XML. Once the attached Makefile is copied to the root directory of a DocBook project, users can simply type make to build an HTML version for the desktop, or use the make target command to build the document in any of the supported formats.

IMPORTANT: This project does not replace Publican; a working installation of Publican 2.5 or newer is required for the makefile to function.

The following OPTIONs can be used to change the way the document is built:

• LANGUAGE=language_code — Allows you to specify the code of the language in which the document is written. The default value is en-US (American English).
• CONFIG=file_name — Allows you to specify the configuration file to use. The default value is publican.cfg.
• MAINFILE=file_name — Allows you to specify the file that contains important document information such as the title, edition, or product name. Depending on the document type, the default value is either Article_Info.xml or Book_Info.xml.

The following TARGETs can be used to specify the action to perform:

• html-desktop — Builds a single HTML page with the table of contents in the sidebar. This is the default option.
• html-single — Builds a single HTML page with the table of contents at the beginning of the document.
• html — Builds multiple HTML pages.
• epub — Builds an EPUB file.
• pdf — Builds a PDF file.
• txt — Builds a plain text file.
• man — Builds a manual page.
• eclipse — Builds an Eclipse help plug-in.
• all — Builds the document in all available formats. Identical to running the make command with the html-desktop, html-single, html, epub, pdf, txt, man, and eclipse targets.
• publish — Prepares HTML, EPUB, and PDF builds that are ready for publishing.
• package — Builds a package.
• test — Validates the XML files.
• clean — Removes temporary files and directories.

To build a single HTML page with the table of contents located in the sidebar, type the following at a shell prompt:

make

To build a PDF file, type:

make pdf

To build a Czech translation of a document, run the following command:

make LANGUAGE=cs-CZ

• Due to limitations of GNU Make, it is currently not possible to build projects that use file names with spaces in them. Refer to bug 712 for more information about this issue.

publican(1), make(1)

For more information about Publican or DocBook XML, refer to the following resources:

• Publican Wiki — The Publican Wiki serves as the official website for Publican and provides links to other documents, as well as information on how to subscribe to its mailing list or report a bug with Bugzilla.
• Publican User's Guide — The Publican User's Guide describes in detail how to install and use Publican to create, manage, and publish DocBook XML-based documents.
• DocBook: The Definitive Guide — DocBook: The Definitive Guide serves as the official documentation and reference book of DocBook XML.

Copyright © 2011–2014 Jaromir Hradilek

This program is free software; see the source for copying conditions. It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.