https://github.com/remko/docbook-kit

Collection of DocBook writing utilities & style(s)
https://github.com/remko/docbook-kit

Last synced: 10 months ago
JSON representation

Collection of DocBook writing utilities & style(s)

• Host: GitHub
• URL: https://github.com/remko/docbook-kit
• Owner: remko
• License: bsd-3-clause
• Created: 2009-04-11T09:03:35.000Z (about 17 years ago)
• Default Branch: master
• Last Pushed: 2014-11-14T13:34:19.000Z (over 11 years ago)
• Last Synced: 2023-04-11T12:36:28.751Z (about 3 years ago)
• Language: XSLT
• Homepage: http://el-tramo.be/docbook-kit
• Size: 592 KB
• Stars: 22
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

          
# [DocBook kit] (https://el-tramo.be/docbook-kit)

## About

This is a collection of scripts and Makefiles to help creating DocBook

documents.

## Requirements

- Python >= 2.4 (http://python.org)

- xmllint (http://xmlsoft.org/xmllint.html). Part of LibXML2.

- xsltproc (http://xmlsoft.org/XSLT/xsltproc2.html). Part of LibXML2.

- pdftk (http://www.accesspdf.com/pdftk/). For PDF attachments. Optional.

- links (http://links.sourceforge.net). For TXT output.

- wget (http://www.gnu.org/software/wget/). To download required DocBook files. 

- aspell (http://aspell.net/). For spellchecking. Optional.

- zip. For EPUB format. Optional.

## Usage

To use this kit, put it in the directory of your DocBook project, and have

a look at the example/ dir to see how to use it in your project.

## Tools

- The Makefile include automatically downloads DocBook if necessary,

  and automatically builds your project (and its depended-on files).

  If you want to avoid downloading all tools if you already have them in

  another project that uses the docbook-kit, just create a `docbook` softlink 

  to the `docbook` dir in your other project.

  The makefile provides the following commands:

  - `make`: Create HTML and PDF versions (if FOP is available) of the document

  - `make html`: Create a HTML version of the document

  - `make pdf`: Create a PDF version of the document

  - `make epub`: Create an EPUB version of the document

	- `make wordpress`: Create a PHP file that integrates with a WordPress blog

  - `make txt`: Create a text version of the document

  - `make clean`: Clean up all generated files

  - `make check-document`: Validates the document syntax

  - `make check-spelling`: Checks the spelling of the document

  - `make check-quotes`: Checks for correct usage of curly quotes

  - `make check-braces`: Checks for correctly balanced braces

  - `make check-ulinks`: Checks whether the URIs pointed to by 

      elements are valid.

  - `make package`: Creates a tarball of your document. The package contains

      a flattened version of the DocBook sources, and normalized figure

      names.

If you want to use custom fonts in your style sheets, drop the `.ttf` or

`.pfm` file in the `fonts/` directory.