Sophie

Sophie

distrib > Fedora > 17 > i386 > media > updates > by-pkgid > 9f452694b2d23dacae7f9cc757f9be50 > files > 639

docbook-style-xsl-1.78.1-1.fc17.noarch.rpm

<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>index.on.role</title><link rel="stylesheet" type="text/css" href="../reference.css"><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="../index.html" title="DocBook XSL Stylesheets: Reference Documentation"><link rel="up" href="toc_index.html" title="ToC/LoT/Index Generation"><link rel="prev" href="index.on.type.html" title="index.on.type"><link rel="next" href="index.links.to.section.html" title="index.links.to.section"><link rel="copyright" href="copyright.html" title="License"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">index.on.role</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.on.type.html">Prev</a> </td><th width="60%" align="center">ToC/LoT/Index Generation</th><td width="20%" align="right"> <a accesskey="n" href="index.links.to.section.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="index.on.role"></a><div class="titlepage"></div>

<div class="refnamediv"><h2><span class="refentrytitle">index.on.role</span></h2><p>
index.on.role
 &#8212; Select indexterms based on <code class="sgmltag-attribute">role</code> value
</p></div>

<div class="refsynopsisdiv"><h2>Synopsis</h2>
<a name="index.on.role.frag"></a><pre class="programlisting">
&lt;xsl:param name="index.on.role" select="0"&gt;&lt;/xsl:param&gt;
</pre>
</div>

<div class="refsection"><a name="idp373072"></a><h2>Description</h2>

<p>
If non-zero, 
then an <a href="http://docbook.org/tdg5/en/html/index.html"><code class="sgmltag-element">index</code></a> element that has a
<code class="sgmltag-attribute">role</code> attribute
value will contain only those <a href="http://docbook.org/tdg5/en/html/indexterm.html"><code class="sgmltag-element">indexterm</code></a>
elements with a matching role value.
If an <a href="http://docbook.org/tdg5/en/html/index.html"><code class="sgmltag-element">index</code></a> has no <code class="sgmltag-attribute">role</code>
attribute or it is blank, then the index will contain
all <a href="http://docbook.org/tdg5/en/html/indexterm.html"><code class="sgmltag-element">indexterm</code></a>s in the current scope.
</p>
<p>
If <code class="literal">index.on.role</code> is zero, then the
<code class="sgmltag-attribute">role</code> attribute has no effect
on selecting indexterms for an index.
</p>

<p>If you are using DocBook version 4.3 or later, you should
use the <code class="sgmltag-attribute">type</code> attribute instead of <code class="sgmltag-attribute">role</code>
on <a href="http://docbook.org/tdg5/en/html/indexterm.html"><code class="sgmltag-element">indexterm</code></a> and <a href="http://docbook.org/tdg5/en/html/index.html"><code class="sgmltag-element">index</code></a>,
and set the <a href="../html/index.on.type.html"><em class="parameter"><code>index.on.type</code></em></a> to a nonzero
value.
</p>

</div>
</div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.on.type.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="toc_index.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="index.links.to.section.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">index.on.type </td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top"> index.links.to.section</td></tr></table></div></body></html>