DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH PRINT BOOK
 
Using DocView

Adding documentation using metadata

DocView provides a feature to extend the list of documentation available through its server. If you install new documentation that you want to include in DocView's lists, you supply a doc metadata file and execute the doctool configuration script.

See ``Document example'' for an example of writing and installing metadata file.

If you are installing or removing many .desktop files, the process can be made more efficient with the --metaonly option. This option causes the --add option to install the document metadata into the DocView configuration, but does not regenerate the home pages. Then you run the command without the --metaonly option on the last document to regenerate the home pages.

Metadata files

There are two types of metadata files: .directory files for categories, and bookid.desktop for documents.

Document example

This example metadata file OSAdminG.desktop adds a link to the table of contents of the ``System Administration Guide''.

   [Desktop Entry]
   Name=System Administration Guide
   DocPath=/usr/share/doc/OpenServer/en/OSAdminG/CONTENTS.html
   X-COL-Weight=1

The metadata file is installed by its package at /usr/share/meta/doc/OSdoc/OSAdminG.desktop. The post export installation script configures it into the system using this command:

   /usr/bin/doctool --add  OSdoc/OSAdminG.desktop
To remove the file, execute this command in the pre uninstall removal script:
   /usr/bin/doctool --remove OSdoc/OSAdminG.desktop

Directory example

This example metadata file .directory (note the leading dot) adds a group heading Apache Documentation to the main home page.

   [Desktop Entry]
   Name=Apache Documentation
   Type=group
   X-COL-Weight=10

The metadata file is installed by its package at /usr/share/meta/doc/ApacheDoc/.directory. The post export installation script configures it into the system using this command:

   /usr/bin/doctool --add ApacheDoc/.directory
Documents that are to appear under this new group should install their metadata file under /usr/share/doc/meta/ApacheDoc to be included in that group.

To remove the file, execute this command in the pre uninstall removal script:

   /usr/bin/doctool --remove ApacheDoc/.directory

Next topic: Updating the man page list
Previous topic: Adding and removing documentation

© 2005 The SCO Group, Inc. All rights reserved.
SCO OpenServer Release 6.0.0 -- 26 May 2005