Commit dec002b4 authored by Jeremy Bicha's avatar Jeremy Bicha

New upstream version 0.20.10

parents 8643b66c de9ae7b2
Shaun McCance <shaunm@gnome.org>
The Gnome Documentation Utilities is a collection of programs and data files
to help you build, maintain, and distribute documentation. This package is
entirely free software; however, not all components of the package are under
the same free software license.
The GNU General Public License and the GNU Lesser General Public License are
used for particular components of this package, depending on need. You should
have received a copy of both licenses with this package; see COPYING.GPL and
COPYING.LGPL. If you did not receive these files, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
This document attempts to provide a brief overview of the programs in this
package and their licensing terms.
xml2po
------
The xml2po program is used to convert between PO files and XML documents.
Within gnome-doc-utils, it is used primarily to translate documentation
written in the DocBook format. It was written by Danilo Segan.
xml2po is released under the terms of the GNU GPL. PO and XML files
output by xml2po are unaffected by the GPL; you are free to license
them however you see fit.
gnome-doc-prepare
-----------------
The gnome-doc-prepare script is used to initialize your source tree for
using the gnome-doc-utils build utilities. It can also be used to create
a template document and the necessary supporting files and folders. It
was written by Danilo Segan.
gnome-doc-prepare is released under the terms of the GNU GPL. The build
files output by gnome-doc-prepare are unaffected by the GPL; you are free
to distribute them however you see fit. The template files are separate
entities from gnome-doc-prepare. They should specify their own terms of
distribution. In many cases, they will be simply stubs, and will have no
restrictions on modification or redistribution.
As a special exception to the GNU General Public License, if you distribute
gnome-doc-prepare as part of a program that contains a configuration script
generated by Autoconf, you may include gnome-doc-prepare under the same
distribution terms that you use for the rest of that program.
gnome-doc-utils.make
--------------------
The gnome-doc-utils.make make script can be included into your Makefiles
to build, verify, and install your documentation. It was written by
Shaun McCance.
gnome-doc-utils.make is released under the terms of the GNU GPL. Most
files output by gnome-doc-utils.make are actually output using one of
the other tools in this package, or using a commonly-available tool
from another package. Thus, the files output by this script are not
affected by the GPL. They may, however, be affected by the terms of
the individual programs that are being invoked.
We make every effort to avoid calling programs that will introduce
restrictions on redistribution of your package; however, we can not
guarantee that no such restrictions exist for files generated by tools
outside this package.
As a special exception to the GNU General Public License, if you distribute
gnome-doc-utils.make as part of a program that contains a configuration script
generated by Autoconf, you may include gnome-doc-utils.make under the same
distribution terms that you use for the rest of that program.
XSLT
----
This package contains various XSLT files for transforming DocBook and other
formats. They were written primarily by Shaun McCance.
The XSLT files are released under the terms of the GNU LGPL. You may build
customizations from these stylesheets using their public documented interfaces,
using either xsl:import or xsl:include, with no restrictions on your customized
stylesheets. You may also invoke the stylesheets freely, either with a simple
XSLT processor such as xsltproc, or using an XSLT processing library within
your program. The use of these stylesheets has no bearing on the licensing
terms of the XSLT processing program you use.
The files output by the stylesheets are not affected by the terms of the LGPL.
In particular, some of the stylesheets output program files rather than simple
data files. The generated program files are also not affected by the LGPL.
You can redistribute all generated files as you see fit.
Sometimes it is necessary to include small portions of the stylesheets within
your source distribution to make building simpler for end users and packagers.
As a special exception to the GNU General Public License, if you distribute
the stylesheets as part of a program that contains a configuration script
generated by Autoconf, you may include those stylesheets under the same
distribution terms that you use for the rest of that program.
Images
------
This package contains a number of images that are used in the formatted
output. They were created primarily by Josef Vybíral. These images are
licensed under the terms of the GNU GPL.
As a special exception to the GNU General Public License, if you distribute
copies of your document formatted by the tools in this package, you may
redistribute unmodified copies of any images used or referenced in that
formatted copy without restriction.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
if ENABLE_BUILD_UTILS
build_SUBDIRS = xml2po
pkgdata_DATA=\
template.omf.in \
template.make \
template-document.xml
endif
# doc must go last
SUBDIRS = data po xslt tools $(build_SUBDIRS) doc
ACLOCAL_AMFLAGS = -I m4
EXTRA_DIST = \
$(pkgdata_DATA) \
COPYING.GPL \
COPYING.LGPL \
bootstrap.make \
intltool-extract.in \
intltool-merge.in \
intltool-update.in
DISTCLEANFILES = \
intltool-extract \
intltool-merge \
intltool-update \
gnome-doc-utils.make
DISTCHECK_CONFIGURE_FLAGS = --disable-scrollkeeper
distuninstallcheck_listfiles = \
find -regex '.*/var/scrollkeeper/.*' -prune -or -type f -print
This diff is collapsed.
This diff is collapsed.
ABOUT
=====
gnome-doc-utils 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.
ORGANIZATION
============
test/
The test directory contains a number of tests for gnome-doc-utils.
Directories of the form testdocn, where n is a positive integer,
are skeleton source trees containing documentation, with the same
layout that would be used by actual projects.
The testdocs directory contains the unit tests from docbook-testdocs,
developed by Norm and Co. for the pan-galactic DocBook stylesheets.
An additional README file is in that directory, giving instructions
on extending or changing any of the files in gnome-doc-utils CVS.
doc/
The doc directory contains documentation for gnome-doc-utils. In
most cases, gnome-doc-utils is required to build its documentation.
Mechanisms are in place for bootstrapping.
xslt/
The xslt directory contains all of the XSLT in gnome-doc-utils.
Notably, the xslt/docbook directory contains the DocBook XSLT,
and xslt/gettext contains the XSLT gettext utility for translating
automatic text.
sandbox/
The sandbox directory is not DISTed, so it will only appear if you
have a CVS checkout. It's a playground for new ideas.
xml2po/
The xml2po directory contains the xml2po tool developed by Danilo
Segan for translation of arbitrary XML formats. It is used by
gnome-doc-utils for DocBook translation.
TESTING
=======
Under the test directory are a number of tests for gnome-doc-utils. To
test the build system (gnome-doc-utils.m4 and gnome-doc-utils.make), you
can use any of the testdocn (for n a positive integer) directories. These
are set up as skeleton source trees, behaving exactly as a real project
would. Also, gnome-doc-utils uses itself to build its own documentation
(under doc), so gnome-doc-utils itself is a test of the build tools.
To test the DocBook stylesheets, use the test/testdocs directory. These
unit tests are from the docbook-testdocs package on docbook.sourceforge.net,
developed by Norm and Co. Simply typing make in that directory will build
each test. If the name of the test file is foo.001.xml, the output will be
html/foo.001/foo.001.html. Each test generally tests a small number of
related DocBook elements. Many of the features of DocBook or of the XSLT
in gnome-doc-utils might not be tested by these. Additional tests may
be added; follow the instructions in test/testdocs/README for that.
Also useful for testing the XSLT is to transform some large documents
using it. The Gnome User Guide and the Gnumeric Manual both serve as
excellent test docs.
HACKING
=======
Unlike most C programming, working on much of gnome-doc-utils really does
involve isolated incremental improvements. There's no way to give a short
list of broad features in a TODO list.
To work on the build tools (gnome-doc-utils.m4 and gnome-doc-utils.make),
build the test docs and see what doesn't work. gnome-doc-utils.make has
a list of all the high-level targets that should be fully supported.
To work on the DocBook XSLT, find an element that isn't implemented yet and
implement it. If you have XML Starlet (xmlstar.sourceforge.net) installed,
you can type 'make report.html' in the xslt/docbook/html directory to get
a nice HTML report on what elements are implemented. There is also a TODO
file in this directory with a very succinct list of matches that need to be
done that can't be caught by report.html.
Note that the XSLT is documented inline with xsldoc, which is itself a part
of gnome-doc-utils. Feel free to work on xsldoc as well. The documentation
generated by xsldoc is included in the manual under doc/xslt.
When in doubt, talk to Shaun McCance <shaunm@gnome.org>. Never commit without
permission, unless Shaun has told you otherwise. Wash behind your ears. Don't
take candy from strangers. Support independant musicicians.
This diff is collapsed.
_xml2po = PYTHONPATH="$(shell pwd)/$(top_builddir)/xml2po:$(shell pwd)/$(top_srcdir)/xml2po:$(PYTHONPATH)" "$(shell pwd)/$(top_builddir)/xml2po/xml2po/xml2po"
_db2html = $(top_srcdir)/xslt/docbook/html/db2html.xsl
_db2omf = $(top_srcdir)/xslt/docbook/omf/db2omf.xsl
_chunks = $(top_srcdir)/xslt/docbook/utils/chunks.xsl
_credits = $(top_srcdir)/xslt/docbook/utils/credits.xsl
_ids = $(top_srcdir)/xslt/docbook/utils/ids.xsl
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
AC_INIT([gnome-doc-utils], [0.20.10],
[http://bugzilla.gnome.org/enter_bug.cgi?product=gnome-doc-utils])
AM_INIT_AUTOMAKE([1.9 no-dist-gzip dist-bzip2])
m4_ifdef([AM_SILENT_RULES],[AM_SILENT_RULES([yes])],[AC_SUBST(AM_DEFAULT_VERBOSITY,1)])
AC_CONFIG_MACRO_DIR([m4])
dnl In the interest of portability, we don't use GNU awk extensions,
dnl even though they rule. To prevent accidental use and subsequent
dnl bug reports after busted tarballs were shipped, we use --traditional
dnl whenever our awk is gawk.
AC_PROG_AWK
if test x$AWK = xgawk; then
GDU_AWK='gawk --traditional';
else
GDU_AWK=$AWK;
fi
AC_SUBST(GDU_AWK)
AC_PROG_LN_S
gdu_cv_have_gdu=yes
GNOME_DOC_DEFINES
AC_ARG_ENABLE([documentation],
AS_HELP_STRING([--enable-documentation], [enable documentation generated via XSLT]),
[], [enable_documentation=yes])
AM_CONDITIONAL(ENABLE_DOCUMENTATION, test x$enable_documentation = xyes)
AC_ARG_ENABLE([build-utils],
AC_HELP_STRING([--enable-build-utils],
[build and install the build utilities [default=yes]]),,
enable_build_utils=yes)
AM_CONDITIONAL(ENABLE_BUILD_UTILS, test x$enable_build_utils = xyes)
if test x$enable_build_utils = xyes; then
AM_PATH_PYTHON([2.4])
fi
PKG_CHECK_MODULES(GNOME_DOC_UTILS,
[
libxml-2.0 >= 2.6.12
libxslt >= 1.1.8
])
GETTEXT_PACKAGE=gnome-doc-utils
AC_SUBST(GETTEXT_PACKAGE)
AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE,"$GETTEXT_PACKAGE")
IT_PROG_INTLTOOL([0.35.0])
AX_GLIB_GNU_GETTEXT
AC_CONFIG_FILES([
Makefile
data/Makefile
data/icons/Makefile
data/icons/hicolor/Makefile
data/icons/hicolor/48x48/Makefile
data/icons/hicolor/48x48/status/Makefile
data/icons/hicolor/scalable/Makefile
data/icons/hicolor/scalable/status/Makefile
data/rng/Makefile
data/templates/Makefile
data/watermarks/Makefile
doc/Makefile
doc/gnome-doc-make/Makefile
doc/xslt/Makefile
po/Makefile.in
tools/Makefile
tools/gnome-doc-utils.pc
xslt/Makefile
xml2po/Makefile
xml2po/xml2po.pc
xml2po/xml2po/Makefile
xml2po/xml2po/modes/Makefile
xml2po/examples/Makefile
xslt/common/Makefile
xslt/docbook/Makefile
xslt/docbook/common/Makefile
xslt/docbook/html/Makefile
xslt/docbook/omf/Makefile
xslt/docbook/utils/Makefile
xslt/mallard/Makefile
xslt/mallard/cache/Makefile
xslt/mallard/common/Makefile
xslt/mallard/html/Makefile
xslt/gettext/Makefile
])
AC_CONFIG_FILES([tools/gnome-doc-tool],[chmod +x tools/gnome-doc-tool])
AC_CONFIG_FILES([tools/gnome-doc-prepare],[chmod +x tools/gnome-doc-prepare])
AC_OUTPUT
SUBDIRS = icons templates watermarks rng
This diff is collapsed.
SUBDIRS = hicolor
This diff is collapsed.
This diff is collapsed.
icondir = $(datadir)/gnome-doc-utils/icons/hicolor/48x48/status
icon_DATA = \
admon-bug.png \
admon-caution.png \
admon-important.png \
admon-note.png \
admon-tip.png \
admon-warning.png
EXTRA_DIST = $(icon_DATA)
This diff is collapsed.
SUBDIRS = 48x48 scalable
This diff is collapsed.
This diff is collapsed.
icondir = $(datadir)/gnome-doc-utils/icons/hicolor/scalable/status
icon_DATA = \
admon-caution.svg \
admon-bug.svg \
admon-important.svg \
admon-note.svg \
admon-tip.svg \
admon-warning.svg
EXTRA_DIST = $(icon_DATA)
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
specdir = $(datadir)/xml/mallard/1.0/
spec_DATA = mallard.rnc mallard.rng
EXTRA_DIST = $(spec_DATA)
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
templatedir = $(datadir)/gnome-doc-utils/templates
template_DATA = \
gnome-app-template.xml \
gnome-applet-template.xml \
legal.xml
EXTRA_DIST = $(template_DATA)
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
<legalnotice id="legalnotice">
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License (GFDL), Version 1.1 or any later version published
by the Free Software Foundation with no Invariant Sections,
no Front-Cover Texts, and no Back-Cover Texts. You can find
a copy of the GFDL at this <ulink type="help"
url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS
distributed with this manual.
</para>
<para> This manual is part of a collection of GNOME manuals
distributed under the GFDL. If you want to distribute this
manual separately from the collection, you can do so by
adding a copy of the license to the manual, as described in
section 6 of the license.
</para>
<para>
Many of the names used by companies to distinguish their
products and services are claimed as trademarks. Where those
names appear in any GNOME documentation, and the members of
the GNOME Documentation Project are made aware of those
trademarks, then the names are in capital letters or initial
capital letters.
</para>
<para>
DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE
WITH THE FURTHER UNDERSTANDING THAT:
<orderedlist>
<listitem>
<para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
THAT THE DOCUMENT OR MODIFIED VERSION OF THE
DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
OF THE DOCUMENT OR MODIFIED VERSION OF THE
DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
EXCEPT UNDER THIS DISCLAIMER; AND
UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
PARTIES, BE LIABLE TO ANY PERSON FOR ANY
DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES OF ANY CHARACTER
INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
LOSSES ARISING OUT OF OR RELATING TO USE OF THE
DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
THE POSSIBILITY OF SUCH DAMAGES.
</para>
</listitem>
</orderedlist>
</para>
</legalnotice>
watermarkdir = $(datadir)/gnome-doc-utils/watermarks
watermark_DATA = \
watermark-blockquote-00AB.png \
watermark-blockquote-00BB.png \
watermark-blockquote-201C.png \
watermark-blockquote-201D.png \
watermark-blockquote-201E.png \
watermark-code.png \
watermark-code-python.png
EXTRA_DIST = \
$(watermark_DATA) \
watermark-blockquote.xcf \
watermark-code-python.svg
This diff is collapsed.
This diff is collapsed.
SUBDIRS = gnome-doc-make xslt
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
include $(top_srcdir)/tools/gnome-doc-utils.make
include $(top_srcdir)/bootstrap.make
dist-hook: doc-dist-hook
DOC_MODULE = gnome-doc-make
DOC_INCLUDES = legal.xml make-ref.xml
C/make-ref.xml: $(top_srcdir)/tools/gnome-doc-utils.make
$(AM_V_at)test -d "C" || mkdir "C"
$(AM_V_GEN)$(GDU_AWK) -f $(srcdir)/gnome-doc-make.awk $< > $@
EXTRA_DIST = gnome-doc-make.awk
DOC_LINGUAS = de
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
<?xml version="1.0" encoding="utf-8"?>
<legalnotice id="legalnotice">
<para>Das vorliegende Dokument kann gemäß den Bedingungen der GNU Free Documentation License (GFDL), Version 1.1 oder jeder späteren, von der Free Software Foundation veröffentlichten Version ohne unveränderbare Abschnitte sowie ohne Texte auf dem vorderen und hinteren Buchdeckel kopiert, verteilt und/oder modifiziert werden. Eine Kopie der GFDL finden Sie unter diesem <ulink type="help" url="ghelp:fdl">Link</ulink> oder in der mit diesem Handbuch gelieferten Datei COPYING-DOCS.</para>