Extension:DocBookExport

The DocBookExport extension lets you create a DocBook from selected wiki pages. You can download the DocBook as an XML file. Other formats supported are ODT, HTML and PDF.

Configuration

 * Set the URL for the html to docbook script installed in your server. Eg. http://example.com/html_to_docbook/wikiHtmlToDocbookConvertor.php
 * Set the URL for the html to docbook script installed in your server. Eg. http://example.com/html_to_docbook/wikiHtmlToDocbookConvertor.php

Dependencies

 * Install the following dependencies on the same or different server, that would be used to handle the html to docbook generation:
 * "pandoc": See  for the latest version


 * For Ubuntu use the following commands, replace the version number as per the latest release
 * To download DocBook files in Zip format install the following software:
 * ZipArchive php extension: See https://stackoverflow.com/q/3872555/1150075
 * To download DocBook in PDF format install the following software:
 * "xsltproc": See https://www.howtoinstall.co/en/ubuntu/xenial/xsltproc
 * "fop": See https://www.howtoinstall.co/en/ubuntu/xenial/fop
 * Install html_to_docbook as per directions in the README file


 * On the wiki, install the "Figures" extension - that supports defining figures in MediaWiki
 * Install mpdf in your MediaWiki installation using composer using the following command:

Usage
To create a book define the page structure using the docbook parser function or tag extension. See examples below.

Parser function example:

On saving the page two links will be made available to download the DocBook: one to download the DocBook as XML files in a zip file and another to download in PDF format.

The parameters shown can be customized as follows:
 * is used to defines the wiki pages that will be part of the docbook as cover, sections and chapters. The first line starts with a  and indicates the preface,   indicates a chapter and   indicates a section of that chapter. Sub-sections can be defined using   or   and so on. The last line again starts with a   and indicates the wiki page to be used as the appendix. Sometimes you may want to merge contents of multiple wiki pages to one section/chapter. For that you can add a comma separated list of such pages as well. You can also customize the title of such a section by adding the following wikitext   at the end of the line. Similarly you can customize the header for a specific section by using the   syntax at the end of the line as shown in the example.


 * This parameter defines the name of the Docbook. This doesn't relate to any wiki page and is only used to name the files and the title of the docbook.
 * This parameter specifies the wiki page to be used as the cover page.
 * This parameter specifies the header to be used for every page of the docbook.
 * This parameter specifies the footer to be used for every page of the docbook.
 * This parameter is a comma separated list of terms that should be indexed.
 * If you have wiki pages for all your index terms you can add them to a category and mention it here.

DocBook supports figures which are images or other media that can be referenced elsewhere in the document. A separate list of figures is also prepared. To define a figure you need to use the Figures extension.

Grouping of indexes is possible as well. To use this feature add the following wikitext to the page containing the index term specifying the group name:

Credits
This extension has been written by WikiWorks for NATO.

Development and Help
You are welcome to submit bug fixes in Gerrit and bug reports and feature requests in Wikimedia Phabricator under tag/mediawiki-extensions-docbookexport.

Please also feel free to contact the author or WikiWorks for consulting on further developments, feature requests or bug fixes on this extension.