Chapter 2. Installation

This toolkit already includes all the needed software components (Saxon, FOP, Batik, JEuclid, JavaHelp, Jing, etc), therefore you just need to install a JavaTM Development Kit (JDK) 1.5+ in order to be able to run the command-line tools.

Note that installing a Java runtime (JRE) is insufficient because some command-line tools expect to have the jar utility (part of the JDK, not part of the JRE) in the PATH.

  1. Unzip the distribution somewhere. This creates a doc_kit/ directory.

    C:\> unzip doc_kit.zip
    C:\> dir
    ...
    13/02/2008  14:19    <DIR>          doc_kit
    ...
  2. All the command-line tools are found in the bin/ subdirectory.

    C:\doc_kit> cd bin
    C:\doc_kit\bin> dir /w
    ...
    [.]               [..]              man2sci           sci2jh
    sciviewhelp       sci2html          manrev2sci        scivalid
    scivalid.bat      manrev2sci.bat    man2sci.bat       sci2html.bat
    sciviewhelp.bat   sci2pdf.bat       sci2pdf           sci2jh.bat
    sci2chm.bat
    ...

    All the above command-line tools are intended to be used directly from the doc_kit/bin/ subdirectory.

  3. Test your installation by converting this document (doc_kit/doc/doc.xml) to a JavaHelp .jar file.

    1. First make sure that the Java tools are actually in your PATH.

      C:\doc_kit\bin> java -version
      java version "1.6.0_04"
      Java(TM) SE Runtime Environment (build 1.6.0_04-b12)
      Java HotSpot(TM) Client VM (build 10.0-b19, mixed mode, sharing)
      
      C:\doc_kit\bin> jar
      Usage: jar {ctxui}[vfm0Me] ...
    2. Convert this document (doc_kit/doc/doc.xml) to JavaHelp using the sci2jh command-line tool.

      C:\doc_kit\bin> sci2jh ..\doc\doc.xml C:\tmp\test_help.jar

      Note that the generated JavaHelp file must end with "_help.jar" and not just with ".jar".

    3. Preview the contents of the generated .jar file using the sciviewhelp tool.

      C:\doc_kit\bin> sciviewhelp C:\tmp\test_help.jar