--- /dev/null
+<?xml version="1.0"?>
+<refentry id="collect.xref.targets">
+<refmeta>
+<refentrytitle>collect.xref.targets</refentrytitle>
+<refmiscinfo role="type">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>collect.xref.targets</refname>
+<refpurpose>Controls whether cross reference data is
+collected</refpurpose>
+</refnamediv>
+<refsynopsisdiv> <src:fragment id="collect.xref.targets.frag">
+<xsl:param name="collect.xref.targets" select="'no'"/>
+</src:fragment>
+</refsynopsisdiv>
+<refsect1>
+<title>Description</title>
+<para>
+In order to resolve olinks efficiently, the stylesheets can
+generate an external data file containing information about
+all potential cross reference endpoints in a document.
+This parameter determines whether the collection process is run when the document is processed by the stylesheet. The default value is <literal>no</literal>, which means the data file is not generated during processing. The other choices are <literal>yes</literal>, which means the data file is created and the document is processed for output, and <literal>only</literal>, which means the data file is created but the document is not processed for output.
+See also <parameter>targets.filename</parameter>.
+</para>
+</refsect1>
+</refentry>
--- /dev/null
+<?xml version="1.0"?>
+<refentry id="current.docid">
+<refmeta>
+<refentrytitle>current.docid</refentrytitle>
+<refmiscinfo role="type">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>current.docid</refname>
+<refpurpose>targetdoc identifier for the document being
+processed</refpurpose>
+</refnamediv>
+<refsynopsisdiv> <src:fragment id="current.docid.frag">
+<xsl:param name="current.docid" select="''"/> </src:fragment>
+</refsynopsisdiv>
+<refsect1>
+<title>Description</title>
+<para>When olinks between documents are resolved for HTML output, the stylesheet can compute the relative path between the current document and the target document. The stylesheet needs to know the <literal>targetdoc</literal> identifiers for both documents, as they appear in the <parameter>target.database.document</parameter> database file. This parameter passes to the stylesheet
+the targetdoc identifier of the current document, since that
+identifier does not appear in the document itself. </para>
+<para>This parameter can also be used for print output. If an olink's <literal>targetdoc</literal> id differs from the <literal>current.docid</literal>, then the stylesheet can append the target document's title to the generated olink text. That identifies to the reader that the link is to a different document, not the current document. See also <parameter>olink.doctitle</parameter> to enable that feature.</para>
+</refsect1>
+</refentry>
--- /dev/null
+<?xml version="1.0"?>
+<refentry id="olink.base.uri">
+<refmeta>
+<refentrytitle>olink.base.uri</refentrytitle>
+<refmiscinfo role="type">uri</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>olink.base.uri</refname>
+<refpurpose>Base URI used in olink hrefs</refpurpose>
+</refnamediv>
+<refsynopsisdiv> <src:fragment id="olink.base.uri.frag">
+<xsl:param name="olink.base.uri" select="''"/> </src:fragment>
+</refsynopsisdiv>
+<refsect1>
+<title>Description</title>
+<para>When cross reference data is collected for resolving olinks, it may be necessary to prepend a base URI to each target's href. This parameter lets you set that base URI when cross reference data is collected. This feature is needed when you want to link to a document that is processed without chunking. The output filename for such a document is not known to the XSL stylesheet; the only target information consists of fragment identifiers such as <literal>#idref</literal>. To enable the resolution of olinks between documents, you should pass the name of the HTML output file as the value of this parameter. Then the hrefs recorded in the cross reference data collection look like <literal>outfile.html#idref</literal>, which can be reached as links from other documents.</para>
+</refsect1>
+</refentry>
--- /dev/null
+<?xml version="1.0"?>
+<refentry id="olink.doctitle">
+<refmeta>
+<refentrytitle>olink.doctitle</refentrytitle>
+<refmiscinfo role="type">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>olink.doctitle</refname>
+<refpurpose>show the document title for external olinks?</refpurpose>
+
+</refnamediv>
+<refsynopsisdiv> <src:fragment id="olink.doctitle.frag">
+<xsl:param name="olink.doctitle" select="0"/> </src:fragment>
+</refsynopsisdiv>
+<refsect1>
+<title>Description</title>
+<para>When olinks between documents are resolved for print output, 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. The <parameter>olink.doctitle</parameter> parameter should be set to nonzero to enable this
+feature. And you should set the <parameter>current.docid</parameter> parameter to the document id for the document currently
+being processed for output. If an olink's <literal>targetdoc</literal> id differs from the <literal>current.docid</literal>, then the stylesheet can append the target document's
+title to the generated olink text. </para>
+</refsect1>
+</refentry>
--- /dev/null
+<?xml version="1.0"?>
+<refentry id="target.database.document">
+<refmeta>
+<refentrytitle>target.database.document</refentrytitle>
+<refmiscinfo role="type">uri</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>target.database.document</refname>
+<refpurpose>Name of master database file for resolving
+olinks</refpurpose>
+</refnamediv>
+<refsynopsisdiv> <src:fragment id="target.database.document.frag">
+<xsl:param name="target.database.document" select="'targetdb.xml'"/>
+</src:fragment>
+</refsynopsisdiv>
+<refsect1>
+<title>Description</title>
+<para>
+To resolve olinks between documents, the stylesheets use
+a master database document that identifies the target datafiles for all the documents within the scope
+of the olinks. This parameter value is the URI of
+the master document to be read during processing to resolve olinks.
+The default value is <filename>targetdb.xml</filename>.</para>
+<para>The data structure of the file is defined in the <filename>targetdatabase.dtd</filename> DTD. The database file provides the high level elements to record the identifiers, locations, and relationships of documents. The cross reference data for individual documents is generally pulled into the database using system entity references or XIncludes. See also <parameter>targets.filename</parameter>.
+
+</para>
+</refsect1>
+</refentry>
--- /dev/null
+<?xml version="1.0"?>
+<refentry id="targets.filename">
+<refmeta>
+<refentrytitle>targets.filename</refentrytitle>
+<refmiscinfo role="type">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>targets.filename</refname>
+<refpurpose>Name of cross reference targets data file</refpurpose>
+</refnamediv>
+<refsynopsisdiv> <src:fragment id="targets.filename.frag">
+<xsl:param name="targets.filename" select="'target.db'"/>
+</src:fragment>
+</refsynopsisdiv>
+<refsect1>
+<title>Description</title>
+<para>
+In order to resolve olinks efficiently, the stylesheets can
+generate an external data file containing information about
+all potential cross reference endpoints in a document.
+This parameter lets you change the name of the generated
+file from the default name <filename>target.db</filename>.
+The name must agree with that used in the target database
+used to resolve olinks during processing.
+See also <parameter>target.database.document</parameter>.
+</para>
+</refsect1>
+</refentry>
--- /dev/null
+<?xml version="1.0"?>
+<refentry id="use.local.olink.style">
+<refmeta>
+<refentrytitle>use.local.olink.style</refentrytitle>
+<refmiscinfo role="type">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>use.local.olink.style</refname>
+<refpurpose>Process olinks using xref style of current
+document</refpurpose>
+</refnamediv>
+<refsynopsisdiv> <src:fragment id="use.local.olink.style.frag">
+<xsl:param name="use.local.olink.style" select="0"/> </src:fragment>
+</refsynopsisdiv>
+<refsect1>
+<title>Description</title>
+<para>When cross reference data is collected for use by olinks, the data for each potential target includes one field containing a completely assembled cross reference string, as if it were an xref generated in that document. Other fields record the separate title, number, and element name of each target. When an olink is formed to a target from another document, the olink resolves to that preassembled string by default. If the <parameter>use.local.olink.style</parameter> parameter is set to non-zero, then instead the cross
+reference string is formed again from the target title, number, and
+element name, using the stylesheet processing the targeting document.
+Then olinks will match the xref style in the targeting document
+rather than in the target document. If both documents are processed
+with the same stylesheet, then the results will be the same.</para>
+</refsect1>
+</refentry>
projects / docbook-dsssl / commitdiff