From 93f58fd482c58f669e37df1e415cfde06324b548 Mon Sep 17 00:00:00 2001 From: Gaetan Nadon Date: Mon, 5 Sep 2011 15:35:55 -0400 Subject: masterdb: add olink support for chunked html 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 --- README | 19 ++++---- masterdb/Makefile.am | 20 ++------ masterdb/masterdb.xml | 124 +++++++++++++++++++++++++------------------------- 3 files changed, 75 insertions(+), 88 deletions(-) diff --git a/README b/README index e057938..c5e262b 100644 --- a/README +++ b/README @@ -11,10 +11,9 @@ 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. +This feature works with PDF and HTML 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. Due to the modular nature of the X window System and the flexibility it provides to O/S builders, one should not expect all links to @@ -90,11 +89,11 @@ These files are generated and installed while the documents are being build. This is what a Docbook/XML reference from docA to docB looks like (docA.xml): Title -This is what an HTML reference from docA to docB looks like (docA.html): +This is what a non-chunked HTML reference from docA to docB looks like (docA.html): Title This is what an HTML targetdoc for docB looks like (docB.html.db): -
+
This is what an HTML reference from docA to docB looks like (docA.html) when the reference cannot be resolved: @@ -114,14 +113,14 @@ This can be caused by one or more of the following: Some pitfalls ------------------------- in docA.xml: the id must match the file basename. -In xorg-*.xsl, +In docs Makefile.am --stringparam current.docid="$(<:.xml=)" supplies docid for *.db. The document id must be unique across all documents. -The baseuri attribute in masterdb.xml is required for pdf/ps references -to work. It cannot be replaced with olink.base.uri in the makefile. +The baseuri attribute in masterdb.xml cannot be used as it conflicts for +documents generated in chunked html. -The pdf/ps "inside the document" references only started working with +The pdf "inside the document" references only started working with docbook-xsl v 1.76.1 which is not yet available to your favorite O/S. In xorg-fo.xsl, insert.olink.pdf.frag must be set to zero which allows the reference to at least point to the top of the document. diff --git a/masterdb/Makefile.am b/masterdb/Makefile.am index 4b8044d..fd571b0 100644 --- a/masterdb/Makefile.am +++ b/masterdb/Makefile.am @@ -2,29 +2,17 @@ master_PRE = masterdb.xml sgmldbs_DATA = \ $(master_PRE:xml=html.xml) \ - $(master_PRE:xml=pdf.xml) \ - $(master_PRE:xml=ps.xml) \ - $(master_PRE:xml=txt.xml) + $(master_PRE:xml=pdf.xml) EXTRA_DIST = $(master_PRE) CLEANFILES = $(sgmldbs_DATA) %.html.xml: %.xml - $(AM_V_GEN)$(SED) -e 's|__ext__|html|g' \ - -e 's|__db__|html|g' \ - -e 's|@datarootdir[@]|$(datarootdir)|g' < $< > $@ - -%.txt.xml: %.xml - $(AM_V_GEN)$(SED) -e 's|__ext__|txt|g' \ + $(AM_V_GEN)$(SED) \ -e 's|__db__|html|g' \ -e 's|@datarootdir[@]|$(datarootdir)|g' < $< > $@ %.pdf.xml: %.xml - $(AM_V_GEN)$(SED) -e 's|__ext__|pdf|g' \ - -e 's|__db__|fo|g' \ - -e 's|@datarootdir[@]|$(datarootdir)|g' < $< > $@ - -%.ps.xml: %.xml - $(AM_V_GEN)$(SED) -e 's|__ext__|ps|g' \ - -e 's|__db__|fo|g' \ + $(AM_V_GEN)$(SED) \ + -e 's|__db__|pdf|g' \ -e 's|@datarootdir[@]|$(datarootdir)|g' < $< > $@ diff --git a/masterdb/masterdb.xml b/masterdb/masterdb.xml index a3944dd..5f732b8 100644 --- a/masterdb/masterdb.xml +++ b/masterdb/masterdb.xml @@ -37,24 +37,24 @@ listed here. This allows crosslinking between documents. - + - + - + - + @@ -62,7 +62,7 @@ listed here. This allows crosslinking between documents. - + @@ -70,28 +70,28 @@ listed here. This allows crosslinking between documents. - + - + - + - + @@ -99,14 +99,14 @@ listed here. This allows crosslinking between documents. - + - + @@ -114,74 +114,74 @@ listed here. This allows crosslinking between documents. - + - + - + - + - + - + - + - + - + - + - + - + @@ -189,116 +189,116 @@ listed here. This allows crosslinking between documents. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -306,109 +306,109 @@ listed here. This allows crosslinking between documents. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -417,7 +417,7 @@ listed here. This allows crosslinking between documents. - + -- cgit v1.2.3