As with any website, you will probably want to create links between your webpages. In a DocBook document, you would use
link to form links between parts of your document. But in Website, each
webpage is a separate XML document, so you cannot use
link because they only work within a document.
To link between your webpages, you can use
olink. Starting with Website version 2.5, olink became much easier to use. That version adopted the new XSL-based olink mechanism that is described in this book. See Chapter 24, Olinking between documents for general background information on using olinks. In Website, olinking is even easier than it is for regular DocBook documents. That's because Website maintains information about the separate
webpage documents in the
layout.xml file, so it can set up the olink data files automatically. Website can also handle a second olink database to generate links to other documents besides
Olink differs from other linking elements in that it requires two attributes: one to locate the document and one to locate an ID value
within that document. The following is an example of an
<olink targetdoc="home" targetptr="whatsnew"/>
targetdoc attribute identifies
the document that contains the target of the link. In Website, the
id attribute value on the
is used as the document identifier since it must exist and it must be unique. Its value should be
used in the
targetdoc attribute of an
targetptr attribute must match an
id attribute value on an element within that document. If
you want to link to the top of the page, then the
targetptr should have the same value as the
olink has no content, then the
stylesheet generates content in a manner similar to an
xref. The content comes from a website database document that the
stylesheets can create. If an
olink element does have
content, then that is used instead of the generated content.
Once you enter olinks between your webpages, you need to make sure the
website.database.document parameter is set to process them. The following sections
describe the processing steps for the two build methods in
You have the option to use a second olink database to form olinks to a collection of documents outside of your
webpage collection. That database is identified by the
target.database.document and is discussed fully in Chapter 24, Olinking between documents.
Here is how you process a website with olinks using the XSLT build method.
layout.xml file the same as before.
layout.xml file as before with the
autolayout.xsl stylesheet to create the
autolayout.xml file as before with
chunk-website.xsl stylesheet. But set the parameter
to the value “
--stringparam collect.xref.targets yes \
--stringparam output-root htdocs \
Here is how you process a website with olinks using the Makefile method.
layout.xml file the same as before.
depends processing steps as before.
Process your website as you would normally (usually by typing make website), but add the
website.database.document parameter whose value is the pathname of the
generated database file. If you use the default filename
website.database.xml, then you can omit the
parameter on the command line.
The following is a sample
Makefile using xsltproc and XML catalogs. The extra steps for olinking are highlighted.
PROC = XML_CATALOG_FILES=../catalog.xml xsltproc all: make website include depends.tabular autolayout.xml: layout.xml $(PROC) \ --output $@ \ autolayout.xsl $< make depends depends: autolayout.xml $(PROC) \ --output depends.tabular \ --stringparam output-root htdocs \ makefile-dep.xsl $< website.database.xml: autolayout.xml $(PROC) \ --output $@ \ website-targets.xsl $< %.html: autolayout.xml $(PROC) \ --output $@ \ --stringparam website.database.document website.database.xml \ --stringparam output-root htdocs \ tabular.xsl \ $(filter-out autolayout.xml website.database.xml %xsl,$^)
This Makefile proceeds as before, except it also builds a website targets database
website.database.xml. It then passes that filename as the
website.database.document parameter to the stylesheet when it processes the
webpages. These two steps
make the target information available to the XSLT processor so it can
resolve the olinks in the webpages. Note that
website.database.xml was added to the
filter-out expression so it is not
processed like a normal content file.
|DocBook XSL: The Complete Guide - 4th Edition
|PDF version available
Copyright © 2002-2007 Sagehill Enterprises