doc/xslt/params/current.docid.xml

   1 <refentry xmlns="http://docbook.org/ns/docbook"
   2           xmlns:xlink="http://www.w3.org/1999/xlink"
   3           xmlns:xi="http://www.w3.org/2001/XInclude"
   4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
   5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
   6           version="5.0" xml:id="current.docid">
   7 <refmeta>
   8 <refentrytitle>current.docid</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>current.docid</refname>
  13 <refpurpose>targetdoc identifier for the document being
  14 processed</refpurpose>
  15 </refnamediv>
  16 <refsynopsisdiv> <src:fragment xml:id="current.docid.frag">
  17 <xsl:param name="current.docid"/>
  18 </src:fragment>
  19 </refsynopsisdiv>
  20 <refsection><info><title>Description</title></info>
  21
  22 <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
  23 the targetdoc identifier of the current document, since that
  24 identifier does not appear in the document itself. </para>
  25 <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>
  26 </refsection>
  27 </refentry>