summaryrefslogtreecommitdiffstats
path: root/kdoctools/docbook/xsl/params/current.docid.xml
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commitce4a32fe52ef09d8f5ff1dd22c001110902b60a2 (patch)
tree5ac38a06f3dde268dc7927dc155896926aaf7012 /kdoctools/docbook/xsl/params/current.docid.xml
downloadtdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.tar.gz
tdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kdoctools/docbook/xsl/params/current.docid.xml')
-rw-r--r--kdoctools/docbook/xsl/params/current.docid.xml21
1 files changed, 21 insertions, 0 deletions
diff --git a/kdoctools/docbook/xsl/params/current.docid.xml b/kdoctools/docbook/xsl/params/current.docid.xml
new file mode 100644
index 000000000..86593e134
--- /dev/null
+++ b/kdoctools/docbook/xsl/params/current.docid.xml
@@ -0,0 +1,21 @@
+<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>