Caché Utilities

Caché 5 Documentation Export

Generate Static HTML from Caché 5 in Three Steps

For simplicity, it is assumed that you are running on a Windows 2000 machine and that Caché R5 has been installed in its default place, "C:\CacheSys". You will need approximately 50MB of unused space to hold the result.

1) Create the top-level containing directory and subdirectory to hold the generated HTML. To avoid long pathnames, locate them at the top level of the system disk.

mkdir C:\StaticDocs
mkdir C:\StaticDocs\HTML

2) Start a Caché terminal window. In the terminal, switch to the DocBook namespace, and invoke the HTML generator with an argument specifying the target directory.

ZN "docbook"
DO ##CLASS(DocBook.Utils).BuildHTMLAll("C:\StaticDocs\HTML")

The window will show a number of trace messages as the documentation is produced. When the generation is finished, close the Terminal window.

3) In order for these files to be rendered properly, copy the relevant images into a parallel directory so the relative references in the generated HTML will locate them properly. The following DOS commands make this copy and then pare down the information to what is necessary:

mkdir C:\StaticDocs\CSP
xcopy C:\CacheSys\CSP\docbook C:\StaticDocs\CSP\docbook /E /I /Q
cd C:\StaticDocs\CSP\docbook
rmdir doctypes /S /Q
rmdir language /S /Q

Congratulations, you have generated static documentation for Caché 5.

In the target directory ("C:\StaticDocs\HTML"), you will see a number of other directories. These represent nicknames for the books. The first letter indicates whether it is a guide ("G") or a reference manual ("R"). The remaining characters are a shorthand for the book. For example, "GCI" stands for "Caché Installation Guide"; "RCOS” for "Caché ObjectScript Commands"; "GDDM" for "Distributed Data Management Guide".

Please note:
Despite the implication of "All" in the method name used to generate the documentation, there are no directory names beginning with "T" because the tutorials are not generated in static form.

There is a file in each sub-directory of the HTML directory with the same name as its parent and a suffix of ".html". This is the starting point of each "book". For example, typing "file:C:\StaticDocs\HTML\gcos\gcos.html" into the IE browser address field brings up "Using Caché ObjectScript".