summaryrefslogtreecommitdiff
path: root/params/current.docid.xml
diff options
context:
space:
mode:
Diffstat (limited to 'params/current.docid.xml')
-rw-r--r--params/current.docid.xml27
1 files changed, 27 insertions, 0 deletions
diff --git a/params/current.docid.xml b/params/current.docid.xml
new file mode 100644
index 0000000..93616f2
--- /dev/null
+++ b/params/current.docid.xml
@@ -0,0 +1,27 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ version="5.0" xml:id="current.docid">
+<refmeta>
+<refentrytitle>current.docid</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>current.docid</refname>
+<refpurpose>targetdoc identifier for the document being
+processed</refpurpose>
+</refnamediv>
+<refsynopsisdiv> <src:fragment xml:id="current.docid.frag">
+<xsl:param name="current.docid"/>
+</src:fragment>
+</refsynopsisdiv>
+<refsection><info><title>Description</title></info>
+
+<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>
+</refsection>
+</refentry>