3
gnome-doc-utils is a collection of documentation utilities for the Gnome
4
project. Notably, it contains utilities for building documentation and
5
all auxiliary files in your source tree, and it contains the DocBook
6
XSLT stylesheets that were once distributed with Yelp. Starting with
7
Gnome 2.8, Yelp will require gnome-doc-utils for the XSLT.
12
The test directory contains a number of tests for gnome-doc-utils.
13
Directories of the form testdocn, where n is a positive integer,
14
are skeleton source trees containing documentation, with the same
15
layout that would be used by actual projects.
17
The testdocs directory contains the unit tests from docbook-testdocs,
18
developed by Norm and Co. for the pan-galactic DocBook stylesheets.
19
An additional README file is in that directory, giving instructions
20
on extending or changing any of the files in gnome-doc-utils CVS.
23
The doc directory contains documentation for gnome-doc-utils. In
24
most cases, gnome-doc-utils is required to build its documentation.
25
Mechanisms are in place for bootstrapping.
28
The xslt directory contains all of the XSLT in gnome-doc-utils.
29
Notably, the xslt/docbook directory contains the DocBook XSLT,
30
and xslt/gettext contains the XSLT gettext utility for translating
34
The sandbox directory is not DISTed, so it will only appear if you
35
have a CVS checkout. It's a playground for new ideas.
38
The xml2po directory contains the xml2po tool developed by Danilo
39
Segan for translation of arbitrary XML formats. It is used by
40
gnome-doc-utils for DocBook translation.
44
Under the test directory are a number of tests for gnome-doc-utils. To
45
test the build system (gnome-doc-utils.m4 and gnome-doc-utils.make), you
46
can use any of the testdocn (for n a positive integer) directories. These
47
are set up as skeleton source trees, behaving exactly as a real project
48
would. Also, gnome-doc-utils uses itself to build its own documentation
49
(under doc), so gnome-doc-utils itself is a test of the build tools.
51
To test the DocBook stylesheets, use the test/testdocs directory. These
52
unit tests are from the docbook-testdocs package on docbook.sourceforge.net,
53
developed by Norm and Co. Simply typing make in that directory will build
54
each test. If the name of the test file is foo.001.xml, the output will be
55
html/foo.001/foo.001.html. Each test generally tests a small number of
56
related DocBook elements. Many of the features of DocBook or of the XSLT
57
in gnome-doc-utils might not be tested by these. Additional tests may
58
be added; follow the instructions in test/testdocs/README for that.
60
Also useful for testing the XSLT is to transform some large documents
61
using it. The Gnome User Guide and the Gnumeric Manual both serve as
66
Unlike most C programming, working on much of gnome-doc-utils really does
67
involve isolated incremental improvements. There's no way to give a short
68
list of broad features in a TODO list.
70
To work on the build tools (gnome-doc-utils.m4 and gnome-doc-utils.make),
71
build the test docs and see what doesn't work. gnome-doc-utils.make has
72
a list of all the high-level targets that should be fully supported.
74
To work on the DocBook XSLT, find an element that isn't implemented yet and
75
implement it. If you have XML Starlet (xmlstar.sourceforge.net) installed,
76
you can type 'make report.html' in the xslt/docbook/html directory to get
77
a nice HTML report on what elements are implemented. There is also a TODO
78
file in this directory with a very succinct list of matches that need to be
79
done that can't be caught by report.html.
81
Note that the XSLT is documented inline with xsldoc, which is itself a part
82
of gnome-doc-utils. Feel free to work on xsldoc as well. The documentation
83
generated by xsldoc is included in the manual under doc/xslt.
85
When in doubt, talk to Shaun McCance <shaunm@gnome.org>. Never commit without
86
permission, unless Shaun has told you otherwise. Wash behind your ears. Don't
87
take candy from strangers. Support independant musicicians.
added
removed
README
