This is a bootstrap repository for developing and generating documents using docbook.

All document stubs and content are formatted using DocBook5. Documents are generated using the DocBook5 XSLT2.0 stylesheets.

The contents of this repository are provided under the terms of the Apache 2.0 License.

Installation

1. Install dependencies (libxml, libxslt, jing, python with lxml, cssutils modules)

   • On Fedora & RHEL:

     sudo yum install -y libxml libxslt jing python python-lxml python-cssutils optipng
     

   • On Debian/Ubuntu:

     apt-get ...
     

2. Clone the repository into $HOME/.docbook or softlink it using ln -s

3. Install phantomjs and ensure phantomjs is in $PATH (phantomjs is used to render PDFs of article and slide content)

Creating DocBooks

1. Use the articles, book, or slides directory contents based on whether you are building a docbook article, book, or set of slides. The scripts assume that all docbook files end with a specific extension:

   • Article: .article.xml
   • Book: .book.xml
   • Slides: .slides.xml

2. Write the contents according to the DocBook5 specification

3. Compile the contents into an html or pdf file using make.

DocBooks can be built by hand using xsltproc or the provided share/dbk5proc.py script and the appropriate xslt files.

Makefile Usage

make html:

compiles the docbook into a single HTML file

make pdf:

compiles the docbook into an HTML file, then uses phantomjs to render it into a PDF

make all:

generates both the html and pdf content

make check:

validates the format of all of the .xml files using an appropriate RelaxNG schema

make clean:

cleans up all of the generated output files