summaryrefslogtreecommitdiff
path: root/README
AgeCommit message (Collapse)Author
2011-09-09masterdb: add olink support for chunked htmlGaetan Nadon
For olinks to chunked html, the masterdb cannot contain the baseuri attribute. The xsl parameter olink.base.uri needs to be used in makefiles for non chunked html while the chunked html does not use it. The txt and ps documents cannot be an end point of olinks, so no target dbs will be generated for those formats, hence no masterdb needed either. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-06-11Masterdb: read the target dbs from the usual doc directoryGaetan Nadon
This is a coordinated change with the packages building DocBook/XML. The target dbs are now installed alongside the generated documents. Currently 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. The master db xi:include statement is changed. It uses a fully qualified path but could also have used a relative path although it is difficult to ensure it would work reliably. The generated html/pdf link are still relative. The README elaborates on requirements which previously existed but were not introduced by this patch. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-03-29DocBook/XML: add support for docbook external referencesGaetan Nadon
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>
2010-11-11Update README to cover using xorg.css directly in installed docsAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-06-18Add COPYING & README filesAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>