From ce4a32fe52ef09d8f5ff1dd22c001110902b60a2 Mon Sep 17 00:00:00 2001
From: toma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>
Date: Wed, 25 Nov 2009 17:56:58 +0000
Subject: 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
---
 kdoctools/docbook/xsl/params/index.on.role.xml | 43 ++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 kdoctools/docbook/xsl/params/index.on.role.xml

(limited to 'kdoctools/docbook/xsl/params/index.on.role.xml')

diff --git a/kdoctools/docbook/xsl/params/index.on.role.xml b/kdoctools/docbook/xsl/params/index.on.role.xml
new file mode 100644
index 000000000..804c7de6a
--- /dev/null
+++ b/kdoctools/docbook/xsl/params/index.on.role.xml
@@ -0,0 +1,43 @@
+<refentry id="index.on.role">
+<refmeta>
+<refentrytitle>index.on.role</refentrytitle>
+<refmiscinfo role="type">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>index.on.role</refname>
+<refpurpose>Select indexterms based on role value</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='index.on.role.frag'>
+<xsl:param name="index.on.role" select="0"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>
+If non-zero, 
+then an <sgmltag>index</sgmltag> element that has a
+<sgmltag>role</sgmltag> attribute
+value will contain only those <sgmltag>indexterm</sgmltag>
+elements with a matching role value.
+If an <sgmltag>index</sgmltag> has no <sgmltag>role</sgmltag>
+attribute or it is blank, then the index will contain
+all <sgmltag>indexterm</sgmltag>s in the current scope.
+</para>
+<para>
+If <literal>index.on.role</literal> is zero, then the
+<sgmltag>role</sgmltag> attribute has no effect
+on selecting indexterms for an index.
+</para>
+
+<para>If you are using DocBook version 4.3 or later, you should
+use the <sgmltag>type</sgmltag> attribute instead of <sgmltag>role</sgmltag>
+on <sgmltag>indexterm</sgmltag> and <sgmltag>index</sgmltag>,
+and set the <parameter>index.on.type</parameter> to a nonzero
+value.
+</para>
+
+</refsect1>
+</refentry>
-- 
cgit v1.2.1