|
|
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.
doctool --add pathname/mydoc.desktopThe path should be relative to /usr/share/meta/doc, where the metadata file is installed. This program executes the installation for all the doc presentation systems. This program is located in /usr/bin/doctool.
doctool --remove pathname/mydoc.desktop
There are two types of metadata files: .directory files for categories, and bookid.desktop for documents.
Name=
Displayed titleName[
xx]=
Localized titleDocPath=
pathnameComment=
DescriptionName
field.
X-COL-weight=
decimal number
X-COL-Type=[group|catagory]
group
contains a tightly
coupled group of documents, while a directory of
type category
contains documents fitting into a
more general category. See below for processing differences.
X-COL-IntroURI=
pathnameThis 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/UnixWare/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
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/.directoryDocuments 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.