Expansion of the built-in documentation in the Caché DBMS

In the Caché DBMS, it is possible to embed your materials in standard documentation using the methods of the DocBook.Utils class.
Thus, you can create your own corporate documentation with the ability to easily navigate and advanced search on it.

Since the built-in documentation is based on the DocBook v4.0 standard, it is possible to convert it to other formats: HTML, PDF, RTF, etc.
In Russian about DocBook you can read, for example, here:
Why DocBook?
DocBook. Short.

udev.zip - file with an example of an article that repeats the " Developer Corner ".
')
Steps for installing and opening an example article:

1. Start the Caché terminal and go to the “DOCBOOK” area:
   zn "DOCBOOK"
2. run the command:
   do ##class ( DocBook.Utils ). Load ( "C:\Articles\UDEV.xml" )
   

   Note: Your file path may be different;

3. Open your local online documentation in your browser and find the downloaded article in the " Technical Articles " section.

Screenshots of the article in the documentation portal:


<sup>to increase


to increase</sup>

Lovers of embedded documentation in their native language

If there is enthusiasm and time, then you can make its translation on your own.

This will require:

1. in the terminal go to the “DOCBOOK” area:
   zn "DOCBOOK"
2. export all existing books and articles to a given directory:
   do ##class ( DocBook.Utils ). XMLExportAll ( "C:\XMLDOC" ,1)
   

   Note: Your catalog may be different;

3. actually transfer the contents of the generated files;
4. import all back from the specified directory:
   do ##class ( DocBook.Utils ). LoadDir ( "C:\XMLDOC" )

Screenshots of the russified documentation:


<sup>to increase


to increase


to increase</sup>

PS: Arbortext, which is used in InterSystems itself, can be useful for convenient development and publication of documentation.
www.ptc.com/products/arbortext (eng.)
www.pro-technologies.ru/product/Arbortext (rus.)