Commit graph

9 commits

Author SHA1 Message Date
Gaetan Nadon
b7bb23fe7c docbook.am: embed css styles inside the HTML HEAD element
Rather than referring to the external xorg.css stylesheet, embed the content
of the file in the html output produced. This is accomplished by using
version 1.10 of xorg-xhtml.xsl.

This makes the whole html docs tree much more relocatable.
In addition, it eliminates xorg.css as a runtime file which makes
xorg-sgml-doctools a build time only package.

Signed-off-by: Gaetan Nadon <nadon@memsize.(none)>
2011-12-30 17:08:14 -05:00
Gaetan Nadon
24632d2804 compose: upgrade makefile to support olinking on chunked html
The essential differences over the regular docbook.am are:
Adding root.filename parameter for naming of chapters html files.
Using xhtml xmlto format and xorg-chunk.xsl stylesheet
Set olink.base.uri for pdf but not for chunked html
Olink is not applicable to ps and txt formats.

Html chapters are added to shelf_DATA as they are also installed.
The xml is generated from a perl script and not distributed.

Requires version 1.10 of xorg-sgml-doctools.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-09 14:44:53 -04:00
Gaetan Nadon
93ab0a1c9a docbook.am: refactor common flags for xmlto and xsltproc
Maximize reuse and reduce risk of setting the wrong flag
at the wrong place.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-08-31 19:46:20 -04:00
Gaetan Nadon
85b725aa9e docbook.am: add search path for local entities
Currently, only $(XORG_SGML_PATH)/X11 is searched for xml entities.
A module may want to add entities that apply only to itself and
not to all modules, like the xserver does.

This feature may or may not be used in this module, but all modules
share a copy of docbook.am.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-08-31 15:41:22 -04:00
Gaetan Nadon
b5ed2d368d docbook.am: explicitly list xmlto flags for each target
Normal evolution of make targets make it impractical to factor out
common command flags for xmlto.

The targets now list each command option as its presence or absence
needs to be justified.

xorg.ss is only needed by xmlto for html.
masterdb is only needed by xmlto.
img.src.path must not be used by html.
xsltproc need to use customization layer xorg-*.xsl.
txt format is not required to search masterdb.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-08-25 16:42:34 -04:00
Gaetan Nadon
d5b3605f3b docbook.am: do not generate docs if docbook customization layer is missing
The stylesheets used to be only about style, fonts or colors.
Complex features are now used like olink and chunked html which
may cause a build break when stylesheets are missing or lead to hard
to find problem.

Some modules may be built when stylesheets are present while others
are built without. There is no requirement to build crippled docs.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-08-25 13:12:49 -04:00
Gaetan Nadon
b370eeb019 Install target dbs alongside generated documents
This matches a change in xorg-sgml-docs whereby the masterdb will look for
the target dbs into the same location as the generated documents.

The target dbs are now installed alongside the generated documents.
Previously they are installed in $prefix/sgml/X11/dbs alongside masterdb which
has the potential of installing outside the package prefix and cause
distcheck to fail when user does not have write permission in this package.

Requires XORG_CHECK_SGML_DOCTOOLS(1.8) which was released 2011-06-11
2011-06-11 19:49:23 -04:00
Alan Coopersmith
9a1ae7a90f Install xml versions of specs even if HAVE_XMLTO is false
Moves HAVE_XMLTO check into docbook.am, more closely matches behaviour
from before docbook.am changes (commit e8c76407d2)

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
2011-04-12 18:18:22 -07:00
Gaetan Nadon
e8c76407d2 Documentation: add Docbook external references support
When writing technical documentation, it is often necessary to cross
reference to other information. When that other information is not in the
current document, additional support is needed, namely <olink>.

A new feature with version 1.7 of xorg-sgml-doctools adds references to
other documents within or outside this package.

This patch adds technical support for this feature but does not change
the content of the documentation as seen by the end user.

Each book or article must generate a database containing the href
of sections that can be referred to from another document. This database
is installed in DATAROOTDIR/sgml/X11/dbs. There is a requirement that
the value of DATAROOTDIR for xorg-sgml-doctools and for the package
documentation is the same. This forms a virtual document tree.

This database is consulted by other documents while they are being generated
in order to fulfill the missing information for linking.
Refer to the xorg-sgml-doctools for further technical information.

Co-authored-by: Matt Dew <marcoz@osource.org>

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-03-30 20:18:35 -04:00