| 1 | <WARPIN VERSION="0.9.17">
|
|---|
| 2 |
|
|---|
| 3 | <HEAD>
|
|---|
| 4 | <TITLE>DocBook Framework for OS/2</TITLE>
|
|---|
| 5 |
|
|---|
| 6 | <PCK INDEX=1
|
|---|
| 7 | PACKAGEID="Kacer.BIZ\DocBook Framework\Base\1\0\0"
|
|---|
| 8 | TARGET="$(WARPIN_DEFAULTAPPSPATH)\DBF4OS2"
|
|---|
| 9 | TITLE="Base files"
|
|---|
| 10 | BASE
|
|---|
| 11 | SELECT
|
|---|
| 12 | NODESELECT
|
|---|
| 13 | LONGFILENAMES
|
|---|
| 14 | CREATEOBJECT="WPFolder|DocBook Framework 1.0.0|<WP_DESKTOP>|OBJECTID=<DocBook_Folder>;"
|
|---|
| 15 | CREATEOBJECT="WPProgram|Read Me|<DocBook_Folder>|EXENAME=e.exe;PARAMETERS=$(1)\ReadMe.TXT;OBJECTID=<DocBook_ReadMe>;"
|
|---|
| 16 | CREATEOBJECT="WPProgram|Useful Links|<DocBook_Folder>|EXENAME=e.exe;PARAMETERS=$(1)\UsefulLinks.TXT;OBJECTID=<DocBook_UsefulLinks>;"
|
|---|
| 17 | CREATEOBJECT="WPUrl|DocBook Framework Home Page|<DocBook_Folder>|URL=http://www.kacer.biz/os2/docbook-framework;OBJECTID=<DocBook_HomePage>;"
|
|---|
| 18 | CONFIGSYS="SET PATH=$(1)\Scripts | ADDRIGHT">
|
|---|
| 19 | This package contains DocBook Framework base files. This is the only available package in version 1.0.0.
|
|---|
| 20 | </PCK>
|
|---|
| 21 |
|
|---|
| 22 | </HEAD>
|
|---|
| 23 |
|
|---|
| 24 | <BODY>
|
|---|
| 25 |
|
|---|
| 26 |
|
|---|
| 27 | <!-- **************************************************************************************************************** -->
|
|---|
| 28 | <PAGE INDEX=1 TYPE=README>
|
|---|
| 29 | <NEXTBUTTON TARGET=2>~Next</NEXTBUTTON>
|
|---|
| 30 | <TEXT>
|
|---|
| 31 | Welcome to DocBook Framework for OS/2 installation!
|
|---|
| 32 |
|
|---|
| 33 | Below is displayed basic information about the framework. Please read it carefully and then press the "Next" button.
|
|---|
| 34 |
|
|---|
| 35 |
|
|---|
| 36 | Select "Next" to continue.
|
|---|
| 37 | Select "Cancel" to abort installation.
|
|---|
| 38 | </TEXT>
|
|---|
| 39 | <README FORMAT=HTML>
|
|---|
| 40 | <P>
|
|---|
| 41 | <B>DocBook Framework for OS/2, version 1.0.0</B>
|
|---|
| 42 |
|
|---|
| 43 | <P>
|
|---|
| 44 | DocBook Framework for OS/2 is a bundle of programs and libraries allowing you
|
|---|
| 45 | to manipulate DocBook source files and convert them to various output formats.
|
|---|
| 46 | The framework itself does not bring any new software to you, it just groups
|
|---|
| 47 | free software downloaded from different places and provides Rexx scripts to
|
|---|
| 48 | configure and launch the software in the right way.
|
|---|
| 49 |
|
|---|
| 50 | <P>
|
|---|
| 51 | DocBook is a XML-based platform-independent format for books, articles,
|
|---|
| 52 | technical documentation, FAQ, slides, etc. Once you write your stuff in DocBook,
|
|---|
| 53 | you can convert it to a number of output formats, including:
|
|---|
| 54 |
|
|---|
| 55 | <UL>
|
|---|
| 56 | <LI>HTML
|
|---|
| 57 | <LI>XHTML
|
|---|
| 58 | <LI>HTML Help for Windows
|
|---|
| 59 | <LI>Java Help
|
|---|
| 60 | <LI>Eclipse Help
|
|---|
| 61 | <LI>UNIX Manual Pages
|
|---|
| 62 | <LI>Formatting Objects, an intermediate format between DocBook and various paged-media formats
|
|---|
| 63 | <LI>PCL
|
|---|
| 64 | <LI>PDF
|
|---|
| 65 | <LI>PostScript
|
|---|
| 66 | <LI>RTF
|
|---|
| 67 | <LI>SVG
|
|---|
| 68 | <LI>plain text
|
|---|
| 69 | <LI>WML (Wordprocessing Markup Language)
|
|---|
| 70 | </UL>
|
|---|
| 71 |
|
|---|
| 72 | <P>
|
|---|
| 73 | The main advantages of using DocBook are the following:
|
|---|
| 74 |
|
|---|
| 75 | <UL>
|
|---|
| 76 | <LI>
|
|---|
| 77 | DocBook is a platform-independent format. You can can edit, read and convert
|
|---|
| 78 | he same file on any platform. You can even change the platform right in the
|
|---|
| 79 | middle of editing your file, the first part can be written on Windows, the
|
|---|
| 80 | second one on OS/2.
|
|---|
| 81 | <LI>
|
|---|
| 82 | DocBook is XML. This means that you can use all standard tools that
|
|---|
| 83 | manipulate XML data, such as parsers, checkers, and converters.
|
|---|
| 84 | <LI>
|
|---|
| 85 | DocBook is an open format. This guarantees that you will be able to read and
|
|---|
| 86 | manipulate your today-written article in the future.
|
|---|
| 87 | <LI>
|
|---|
| 88 | Many output formats available. Being a XML format, DocBook itself is not
|
|---|
| 89 | intended to be read directly by humans. Instead, many output formats can be
|
|---|
| 90 | generated from DocBook, including popular formats such as PDF, HTML and RTF.
|
|---|
| 91 | </UL>
|
|---|
| 92 |
|
|---|
| 93 |
|
|---|
| 94 | <P>
|
|---|
| 95 | <B>System Requirements</B>
|
|---|
| 96 |
|
|---|
| 97 | <P>
|
|---|
| 98 | The framework is a bundle of Java software, data files, and Rexx scripts.
|
|---|
| 99 | Therefore, you will need the following stuff installed:
|
|---|
| 100 |
|
|---|
| 101 | <UL>
|
|---|
| 102 | <LI>Rexx
|
|---|
| 103 | <LI>Java. Use Golden Code or InnoTek Java 1.4, if you can. However, IBM Java 1.3 should also work.
|
|---|
| 104 | <LI>WarpIN for installation/deinstallation. Since you are reading this file, you have probably installed it already.
|
|---|
| 105 | </UL>
|
|---|
| 106 |
|
|---|
| 107 |
|
|---|
| 108 | <P>
|
|---|
| 109 | <B>Installation and Deinstallation</B>
|
|---|
| 110 |
|
|---|
| 111 | <P>
|
|---|
| 112 | DocBook Framework is installed automatically using WarpIN. During installation,
|
|---|
| 113 | your <CODE>CONFIG.SYS</CODE> will be modified. If you don't allow WarpIN to perform the
|
|---|
| 114 | modification, you will have to:
|
|---|
| 115 |
|
|---|
| 116 | <UL>
|
|---|
| 117 | <LI>either modify <CODE>CONFIG.SYS</CODE> on your own by adding the <CODE>...\Scripts</CODE> directory to your <CODE>PATH</CODE>, or
|
|---|
| 118 | <LI>add the <CODE>...\Scripts</CODE> directory to your <CODE>PATH</CODE> from the command line every time you use the framework.
|
|---|
| 119 | </UL>
|
|---|
| 120 |
|
|---|
| 121 | <P>
|
|---|
| 122 | In addition, <CODE>java.exe</CODE> must be in your <CODE>PATH</CODE>. It is assumed that <CODE>PATH</CODE> already
|
|---|
| 123 | contains a Java <CODE>...\jre\bin</CODE> directory and no checks are performed, neither
|
|---|
| 124 | during installation nor during normal operation.
|
|---|
| 125 |
|
|---|
| 126 | <P>
|
|---|
| 127 | Before you start using the framework, take a little time to configure it. A few
|
|---|
| 128 | configuration files must be set up in order for the tools to operate properly.
|
|---|
| 129 | Please read the file <CODE>PatchTheseFiles.TXT</CODE> for more details. These changes can be
|
|---|
| 130 | performed automatically and future versions of the framework will contain
|
|---|
| 131 | a little configuration tool that will be executed during installation.
|
|---|
| 132 |
|
|---|
| 133 | <P>
|
|---|
| 134 | The framework can be uninstalled using WarpIN. You can also delete it manually,
|
|---|
| 135 | but then the WarpIN database will not be consistent with your hard disk's
|
|---|
| 136 | content.
|
|---|
| 137 |
|
|---|
| 138 |
|
|---|
| 139 | <P>
|
|---|
| 140 | <B>Components of the Framework</B>
|
|---|
| 141 |
|
|---|
| 142 | <P>
|
|---|
| 143 | The framework consists of the following components:
|
|---|
| 144 |
|
|---|
| 145 | <OL>
|
|---|
| 146 | <LI>DocBook DTD and ISO entities.
|
|---|
| 147 | <LI>DocBook XSL stylesheets that prescribe how DocBook documents should be converted into other formats.
|
|---|
| 148 | <LI>Saxon - XSLT processor that converts a DocBook document into another format using a XSL stylesheet.
|
|---|
| 149 | <LI>FOP - FO processor that converts an FO document (generated by Saxon) into a paged-media document.
|
|---|
| 150 | <LI>Rexx scripts that set up the environment properly before launching the programs.
|
|---|
| 151 | </OL>
|
|---|
| 152 |
|
|---|
| 153 | <P>
|
|---|
| 154 | Other software can be plugged into the framework, e.g. XFC or XEP. Rexx scripts
|
|---|
| 155 | for starting them are present in the distribution, but the programs could not
|
|---|
| 156 | be included because of their strict licenses. However, you can easily download
|
|---|
| 157 | them on your own and install them into the <CODE>...\SW\XFC</CODE> and <CODE>...\SW\XEP</CODE>
|
|---|
| 158 | directories. Look into the <CODE>UsefulLinks.TXT</CODE> file for links to the software.
|
|---|
| 159 |
|
|---|
| 160 | <P>
|
|---|
| 161 | Some DocBook-related programs were not included in the distribution. An example
|
|---|
| 162 | of such programs is OpenJade, a converter using DSSSL styles. DSSSL styles are
|
|---|
| 163 | older than XSL styles and their importance falls down continuously. In adition,
|
|---|
| 164 | OpenJade is a native program. Programs like OpenJade may be included in a future
|
|---|
| 165 | version if users request it.
|
|---|
| 166 |
|
|---|
| 167 | <P>
|
|---|
| 168 | Editors were not included either. I recommend using either jEdit or XXE. The
|
|---|
| 169 | latter is almost-WYSIWYG so it will probably be preferred by many users. Again,
|
|---|
| 170 | see the file <CODE>UsefulLinks.TXT</CODE> for an URL.
|
|---|
| 171 |
|
|---|
| 172 |
|
|---|
| 173 | <P>
|
|---|
| 174 | <B>Using the Framework</B>
|
|---|
| 175 |
|
|---|
| 176 | <P>
|
|---|
| 177 | The framework offers 19 Rexx scripts that you can call directly and pass them
|
|---|
| 178 | your DocBook file as a parameter. The scripts are as follows:
|
|---|
| 179 |
|
|---|
| 180 | <DL>
|
|---|
| 181 | <DD>DB2EclipseHelp.CMD
|
|---|
| 182 | <DT>Converts DocBook into Eclipse help.
|
|---|
| 183 |
|
|---|
| 184 | <DD>DB2FO.CMD
|
|---|
| 185 | <DT>Converts DocBook into Formatting Objects. Formatting objects are the starting point for paged-media formats, therefore a very important format. Look at FO2* scripts to see what you get out of formatting objects.
|
|---|
| 186 |
|
|---|
| 187 | <DD>DB2HTML.CMD
|
|---|
| 188 | <DT>Converts DocBook into a single HTML file.
|
|---|
| 189 |
|
|---|
| 190 | <DD>DB2HTMLChunks.CMD
|
|---|
| 191 | <DT>Converts DocBook into a set of HTML files, chained by links.
|
|---|
| 192 |
|
|---|
| 193 | <DD>DB2HTMLHelp.CMD
|
|---|
| 194 | <DT>Converts DocBook into a set of HTML files that can be compiled into a CHM file. This can be used on Windows only.
|
|---|
| 195 |
|
|---|
| 196 | <DD>DB2JavaHelp.CMD
|
|---|
| 197 | <DT>Converts DocBook into a set of HTML and XML files that can be packed into a JAR archive and read by a Java program.
|
|---|
| 198 |
|
|---|
| 199 | <DD>DB2ManPages.CMD
|
|---|
| 200 | <DT>Converts DocBook reference entries into UNIX manual pages. Not much useful on OS/2...
|
|---|
| 201 |
|
|---|
| 202 | <DD>DB2XHTML.CMD
|
|---|
| 203 | <DT>Converts DocBook into a single XHTML file.
|
|---|
| 204 |
|
|---|
| 205 | <DD>DB2XHTMLChunks.CMD
|
|---|
| 206 | <DT>Converts DocBook into a set XHTML files, chained by links.
|
|---|
| 207 |
|
|---|
| 208 | <DD>FO2MIF.CMD
|
|---|
| 209 | <DT>This conversion does not work yet.
|
|---|
| 210 |
|
|---|
| 211 | <DD>FO2PCL.CMD
|
|---|
| 212 | <DT>Converts Formatting Objects into a PCL file that can be sent to a printer.
|
|---|
| 213 |
|
|---|
| 214 | <DD>FO2PDF.CMD
|
|---|
| 215 | <DT>Converts Formatting Objects into a Portable Document format.
|
|---|
| 216 |
|
|---|
| 217 | <DD>FO2Printer.CMD
|
|---|
| 218 | <DT>Renders Formatting Objects directly onto a printer.
|
|---|
| 219 |
|
|---|
| 220 | <DD>FO2PS.CMD
|
|---|
| 221 | <DT>Converts Formatting Objects into PostScript.
|
|---|
| 222 |
|
|---|
| 223 | <DD>FO2RTF-UsingXFC.CMD
|
|---|
| 224 | <DT>Converts Formatting Objects into Rich Text Format. On OS/2, use OpenOffice to open the resulting RTF. You must install XFC on your own to be able to perform this conversion.
|
|---|
| 225 |
|
|---|
| 226 | <DD>FO2Screen.CMD
|
|---|
| 227 | <DT>Renders Formatting Objects on the screen.
|
|---|
| 228 |
|
|---|
| 229 | <DD>FO2SVG.CMD
|
|---|
| 230 | <DT>Converts Formatting Objects into Scalable Vector Graphics.
|
|---|
| 231 |
|
|---|
| 232 | <DD>FO2TXT.CMD
|
|---|
| 233 | <DT>Converts Formatting Objects into plain text.
|
|---|
| 234 |
|
|---|
| 235 | <DD>FO2WML-UsingXFC.CMD
|
|---|
| 236 | <DT>Converts Formatting Objects into Wordprocessing Markup Language. The resulting file can be opened by Microsoft Word XP and 2003 on Windows. You must install XFC on your own to be able to perform this conversion.
|
|---|
| 237 | </DL>
|
|---|
| 238 |
|
|---|
| 239 | <P>
|
|---|
| 240 | If a new XSL stylesheet appears, you can directly call the converters and
|
|---|
| 241 | supply them the stylesheet as a parameter. See Saxon.CMD, FOP.CMD, XFC.CMD, and
|
|---|
| 242 | XEP.CMD for details.
|
|---|
| 243 |
|
|---|
| 244 |
|
|---|
| 245 | <P>
|
|---|
| 246 | <B>More Information</B>
|
|---|
| 247 |
|
|---|
| 248 | <P>
|
|---|
| 249 | The framework's homepage is at <CODE>http://www.kacer.biz/os2/docbook-framework</CODE>.
|
|---|
| 250 |
|
|---|
| 251 | <P>
|
|---|
| 252 | To contact the packager, write to <CODE>jarda@kacer.biz</CODE>.
|
|---|
| 253 | </README>
|
|---|
| 254 | </PAGE>
|
|---|
| 255 |
|
|---|
| 256 |
|
|---|
| 257 | <!-- **************************************************************************************************************** -->
|
|---|
| 258 | <PAGE INDEX=2 TYPE=TEXT>
|
|---|
| 259 | <NEXTBUTTON TARGET=3>~Next</NEXTBUTTON>
|
|---|
| 260 | <TEXT>
|
|---|
| 261 | You can let the installation program change your CONFIG.SYS (The PATH variable should be updated.) or assure the necessary working environment by yourself. If you want to set your PATH manually, read the ReadMe.TXT file for instructions.
|
|---|
| 262 |
|
|---|
| 263 |
|
|---|
| 264 | Select "Next" to continue.
|
|---|
| 265 | Select "Cancel" to abort installation.
|
|---|
| 266 | </TEXT>
|
|---|
| 267 | </PAGE>
|
|---|
| 268 |
|
|---|
| 269 |
|
|---|
| 270 | <!-- **************************************************************************************************************** -->
|
|---|
| 271 | <PAGE INDEX=3 TYPE=CONTAINER>
|
|---|
| 272 | <NEXTBUTTON TARGET=4>~Next</NEXTBUTTON>
|
|---|
| 273 | <TEXT>
|
|---|
| 274 | On this page, you may deselect a package if it is already installed or change a package's target path.
|
|---|
| 275 | </TEXT>
|
|---|
| 276 | </PAGE>
|
|---|
| 277 |
|
|---|
| 278 |
|
|---|
| 279 | <!-- **************************************************************************************************************** -->
|
|---|
| 280 | <PAGE INDEX=4 TYPE=CONFIGURE>
|
|---|
| 281 | <NEXTBUTTON TARGET=5>~Next</NEXTBUTTON>
|
|---|
| 282 | <TEXT>
|
|---|
| 283 | Please check the boxes below if you want to configure your system automatically. Otherwise you will have to set up you system manually.
|
|---|
| 284 | </TEXT>
|
|---|
| 285 | </PAGE>
|
|---|
| 286 |
|
|---|
| 287 |
|
|---|
| 288 | <!-- **************************************************************************************************************** -->
|
|---|
| 289 | <PAGE INDEX=5 TYPE=TEXT>
|
|---|
| 290 | <NEXTBUTTON TARGET=0>I~nstall</NEXTBUTTON>
|
|---|
| 291 | <TEXT>
|
|---|
| 292 | Press "Install" to begin installing DocBook Framework for OS/2 v. 1.0.0 on your computer.
|
|---|
| 293 | </TEXT>
|
|---|
| 294 | </PAGE>
|
|---|
| 295 |
|
|---|
| 296 | </BODY>
|
|---|
| 297 | </WARPIN>
|
|---|
| 298 |
|
|---|
