| Age | Commit message (Collapse) | Author |
|---|
|
Documents external references
-----------------------------
A new feature with version 1.7 is references to documents in other
packages. For example a protocol specifications may refer to another
one or to a library implementing it.
This feature works with PDF, HTML, PS (and epub?) generated documents
and will generate links to the other versions of the same type, i.e. html
docs will link to other html docs, and pdf docs will link to other pdf
docs.
New: generating target databases
--------------------------------
All documents will generate a target db, analogous to a symbol table
which will be consulted by other documents to find linking information.
This is accomplished with xsltproc.
New: consulting target databases
--------------------------------
While documents are being converted from xml to html/pdf/ps,
they will consult the target dbs of each document they which to refer to.
This is accomplished with xmlto.
New: master database
--------------------
A hand written database has been created which provides an association
between the target dbs and the document themselves. It also reflects
the hierarchical structure of the documents relative to the installation dir.
New: xorg-xhtml.xsl and xorg-fo.xsl
-----------------------------------
A number of motivations are behind the new (and split) versions of xorg.xsl.
This module must remain backward compatible to build previous versions
of documentation. It was originally designed a while ago for sgml.
Given that all documents makefile had to change, it seemed a good opportunity
to break from the past. Among the differences:
The location of xorg.css is no longer set in the stylesheet.
The chunked html is no longer supported.
The html and fo parameters are kept separate.
Additional parameters for external references.
Now allows different values for html/fo xsl for the same parameter
should that be required.
The xorg-xhtml.xsl imports html/docbook.xsl
The xorg-fo.xsl imports fo/docbook.xsl
Co-authored-by: Matt Dew <marcoz@osource.org>
Acked-by: Dan Nicholson <dbn.lists@gmail.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
|
Currently the value of sgmlrootdir is hard coded relative to $prefix.
In Autoconf 2.60, $datarootdir has been added to define the architecture
independent data directory.
--datarootdir=DIR read-only arch.-independent data root [PREFIX/share]
Relative to that location, a number of subdirectories have been defined:
--datadir=DIR read-only architecture-independent data [DATAROOTDIR]
--infodir=DIR info documentation [DATAROOTDIR/info]
--localedir=DIR locale-dependent data [DATAROOTDIR/locale]
--mandir=DIR man documentation [DATAROOTDIR/man]
--docdir=DIR documentation root
[DATAROOTDIR/doc/xorg-sgml-doctools]
--htmldir=DIR html documentation [DOCDIR]
--dvidir=DIR dvi documentation [DOCDIR]
--pdfdir=DIR pdf documentation [DOCDIR]
--psdir=DIR ps documentation [DOCDIR]
The sgmlrootdir should hang off datarootdir. If there is a need to specify
a different location, a new configure option should be added:
--sgmldir=DIR sgml stylesheets and entities [DATAROOTDIR/sgml]
An sgmlrootdir Automake variable is defined in configure.ac to provide
a unique value holder for the sgmlrootdir.
Variable PACKAGE_VERSION is preferred over the undocumented VERSION variable.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
|
These have been copied into & expanded in several modules already,
might as well make a common copy to share so that our docs end up
with a common style.
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Dan Nicholson <dbn.lists@gmail.com>
|
|
This allows the SGML entities to be found no matter where they are
installed, or even when cross-compiling.
Signed-off-by: Yaakov Selkowitz <yselkowitz@users.sourceforge.net>
Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
|
|
Now that the INSTALL file is generated.
Allows running make maintainer-clean.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
|
|
Add missing INSTALL file. Use standard GNU file on building tarball
README may have been updated
Remove AUTHORS file as it is empty and no content available yet.
Remove NEWS file as it is empty and no content available yet.
|
|
ChangeLog filename is known to Automake and requires no further
coding in the makefile.
|
|
|
|
Reported by Benjamin.Close@clearchain.com in bug #13556
|
|
|
|
the docbook tools to find them under normal conditions
|
|
|
|
system to build the README file at make dist time
- in util/macros/xorg-macros.m4, add a new XORG_CHECK_LINUXDOC macro that
will check if the required tools and files exist, and if so set a
conditional.
- util/modular/symlink.sh
- Link all the <driver>.sgml to xf86-video-<driver>/README.sgml
- Add all the README.<driver> to the list of excluded files
- xc/programs/Xserver/hw/xfree86/doc/sgml/SiS.sgml: Various changes to make
it spew less warnings when the text file is built.
|
