SCons / src / engine / SCons / Tool / docbook / docbook-xsl-1.76.1 / params / use.role.for.mediaobject.xml

<refentry xmlns=""
          version="5.0" xml:id="use.role.for.mediaobject">
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
<refpurpose>Use <tag class="attribute">role</tag> attribute 
value for selecting which of several objects within a mediaobject to use.

<src:fragment xml:id="use.role.for.mediaobject.frag">
<xsl:param name="use.role.for.mediaobject" select="1"/>


<para>If non-zero, the <tag class="attribute">role</tag> attribute on
<tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
The order of selection when then parameter is non-zero is:
    <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
<para>Else if an object's role attribute has a value of
<literal>html</literal> for HTML processing or
<literal>fo</literal> for FO output, then the first
of such objects is selected.
<para>Else the first suitable object is selected.</para>
If the value of 
is zero, then role attributes are not considered
and the first suitable object
with or without a role value is used.