GNOME Doc Utils-0.2.0

Introduction to GNOME Doc Utils

The GNOME Doc Utils package is a collection of documentation utilities for the GNOME project. Notably, it contains utilities for building documentation and all auxiliary files in your source tree, and it contains the DocBook XSLT stylesheets that were once distributed with Yelp. Starting with GNOME 2.8, Yelp will require GNOME Doc Utils for the XSLT.

Package Information

GNOME Doc Utils Dependencies

Required

ScrollKeeper-0.3.14

Optional

pkg-config-0.19 and Python-2.4.1

Installation of GNOME Doc Utils

[Note]

Note

The instructions below are based on installing the package into a GNOME-2 environment. If, for whatever reason, you're installing this package without having ORBit2 and the core GNOME-2 libraries installed, you'll need to modify the --prefix= parameter on the configure script to point to your desired installation path (e.g., --prefix=/usr).

Install GNOME Doc Utils by running the following commands:

./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
    --localstatedir=/var/lib &&
make

To test the results, issue: make check.

Now, as the root user:

make install

Command Explanations

--localstatedir=/var/lib: This switch puts ScrollKeeper files in /var/lib/scrollkeeper instead of $GNOME_PREFIX/var/scrollkeeper.

Contents

Installed Programs: gnome-doc-prepare and xml2po
Installed Libraries: None
Installed Directories: $GNOME_PREFIX/share/gnome-doc-utils, $GNOME_PREFIX/share/gnome/help/gnome-doc-make, $GNOME_PREFIX/share/gnome/help/gnome-doc-xslt, $GNOME_PREFIX/share/omf/gnome-doc-make, $GNOME_PREFIX/share/omf/gnome-doc-xslt, $GNOME_PREFIX/share/xml/gnome and $GNOME_PREFIX/share/xml2po
Installed Stylesheets: Custom DocBook XSLT stylesheets used by Yelp

Short Descriptions

gnome-doc-prepare

prepares a package to use gnome-doc-utils.

xml2po

is a Python script used to translate XML documents.

Last updated on 2005-08-01 13:29:19 -0600