| 1 | ===============================================================================
|
|---|
| 2 | Information on AiR-BOOT Manual Creation [2017-04-13]
|
|---|
| 3 | ===============================================================================
|
|---|
| 4 |
|
|---|
| 5 | Apache OpenOffice Writer for the Master Document
|
|---|
| 6 | ------------------------------------------------
|
|---|
| 7 | The AiR-BOOT Manual is provided in the PDF and OS/2 INF formats.
|
|---|
| 8 | Of course we do not want to maintain both formats separately, so a sort of
|
|---|
| 9 | _master_ format is required. This is found in the Open Document Format (ODF)
|
|---|
| 10 | used by Apache OpenOffice, especially the ODT-variant used by AOO-Writer.
|
|---|
| 11 |
|
|---|
| 12 | The port of Apache OpenOffice for OS/2 is provided by "bww bitwise works GmbH".
|
|---|
| 13 | See: https://www.bitwiseworks.com
|
|---|
| 14 |
|
|---|
| 15 |
|
|---|
| 16 | The Master Document
|
|---|
| 17 | -------------------
|
|---|
| 18 | The file "airboot-manual.odt" is the master document in ODT-format.
|
|---|
| 19 | It can be modified using AOO-Writer. Before putting a new version in the
|
|---|
| 20 | repository, it is always reconstructed from its exploded form.
|
|---|
| 21 |
|
|---|
| 22 |
|
|---|
| 23 | The AiR-BOOT Manual in PDF-format
|
|---|
| 24 | ---------------------------------
|
|---|
| 25 | This is done using the excellent PDF-export feature of Apache OpenOffice.
|
|---|
| 26 | The steps are:
|
|---|
| 27 | o Reconstruct the master-document
|
|---|
| 28 | o Load it in AOO for OS/2
|
|---|
| 29 | o Manually export it to PDF
|
|---|
| 30 |
|
|---|
| 31 |
|
|---|
| 32 | The AiR-BOOT Manual in INF-format
|
|---|
| 33 | ---------------------------------
|
|---|
| 34 | This is done using XSLT.
|
|---|
| 35 | Because an ODT is actually a ZIP-file, with the file 'content.xml' holding the
|
|---|
| 36 | document-content in XML-form, it can be processed by XSLT.
|
|---|
| 37 |
|
|---|
| 38 | Construction of the manual is done by:
|
|---|
| 39 | o Exploding the ODT to a subdirectory -- UNZIP
|
|---|
| 40 | o Transforming 'content.xml' to 'airboot-manual.ipf' -- XSLTPROC
|
|---|
| 41 | o Converting PNG images to OS/2 BMP images -- GBMCONV
|
|---|
| 42 | o Compiling IPF to INF -- WIPFC
|
|---|
| 43 |
|
|---|
| 44 |
|
|---|
| 45 | Conversion of the embedded images
|
|---|
| 46 | ---------------------------------
|
|---|
| 47 | AOO embedded images are stored in PNG-format.
|
|---|
| 48 | Since the IPF creation tools can only handle OS/2 bitmap format, these images
|
|---|
| 49 | must first be converted from PNG to OS/2 BMP. This is done with the 'gbmconv'
|
|---|
| 50 | utility, which is part of the 'Generalised Bitmap Module' (GBM) package.
|
|---|
| 51 |
|
|---|
| 52 | Be sure that any old "?:\os2\dll\gbm.dll" is *not* active when using 'gbmconv'!
|
|---|
| 53 |
|
|---|
| 54 | The Generalised Bitmap Module is provided by "Heiko Nitzsche".
|
|---|
| 55 | See: http://heikon.home.tlink.de (** unavailable **)
|
|---|
| 56 | http://www.ecsoft2.org/generalised-bitmap-module-gbm (via eCoSoft)
|
|---|
| 57 |
|
|---|
| 58 |
|
|---|
| 59 | Tools Versions
|
|---|
| 60 | --------------
|
|---|
| 61 | o UNZIP -- v6.00 is the version used
|
|---|
| 62 | o XSLTPROC -- xsltproc was compiled against libxml 20904,
|
|---|
| 63 | libxslt 10129 and libexslt 817
|
|---|
| 64 | o GBMCONV -- v1.7.6 is the version used
|
|---|
| 65 | o Open Watcom WIPFC -- v1.9 is the version used
|
|---|
| 66 | o GNU Make -- v3.81 is the version used
|
|---|
| 67 |
|
|---|
| 68 |
|
|---|
| 69 |
|
|---|
| 70 | Ben Rietbroek <rousseau.os2dev@gmx.com>,
|
|---|
| 71 |
|
|---|
| 72 | AiR-BOOT maintainer.
|
|---|
