olink.doctitle

olink.doctitle — show the document title for external olinks?

Synopsis

<xsl:param name="olink.doctitle">no</xsl:param> 

Description

When olinks between documents are resolved, the generated text may not make it clear that the reference is to another document. It is possible for the stylesheets to append the other document's title to external olinks. For this to happen, two parameters must be set.

  • This olink.doctitle parameter should be set to either yes or maybe to enable this feature.

  • And you should also set the current.docid parameter to the document id for the document currently being processed for output.

Then if an olink's targetdoc id differs from the current.docid value, the stylesheet knows that it is a reference to another document and can append the target document's title to the generated olink text.

The text for the target document's title is copied from the olink database from the ttl element of the top-level div for that document. If that ttl element is missing or empty, no title is output.

The supported values for olink.doctitle are:

yes

Always insert the title to the target document if it is not the current document.

no

Never insert the title to the target document, even if requested in an xrefstyle attribute.

maybe

Only insert the title to the target document, if requested in an xrefstyle attribute.

An xrefstyle attribute may override the global setting for individual olinks. The following values are supported in an xrefstyle attribute using the select: syntax:

docname

Insert the target document name for this olink using the docname gentext template, but only if the value of olink.doctitle is not no.

docnamelong

Insert the target document name for this olink using the docnamelong gentext template, but only if the value of olink.doctitle is not no.

nodocname

Omit the target document name even if the value of olink.doctitle is yes.

Another way of inserting the target document name for a single olink is to employ an xrefstyle attribute using the template: syntax. The %o placeholder (the letter o, not zero) in such a template will be filled in with the target document's title when it is processed. This will occur regardless of the value of olink.doctitle.

Note that prior to version 1.66 of the XSL stylesheets, the allowed values for this parameter were 0 and 1. Those values are still supported and mapped to 'no' and 'yes', respectively.