doc/xslt/params/preferred.mediaobject.role.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="preferred.mediaobject.role">
   7 <refmeta>
   8 <refentrytitle>preferred.mediaobject.role</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>preferred.mediaobject.role</refname>
  13 <refpurpose>Select which mediaobject to use based on
  14 this value of an object's <tag class="attribute">role</tag> attribute.
  15 </refpurpose>
  16 </refnamediv>
  17
  18 <refsynopsisdiv>
  19 <src:fragment xml:id="preferred.mediaobject.role.frag">
  20 <xsl:param name="preferred.mediaobject.role"/>
  21 </src:fragment>
  22 </refsynopsisdiv>
  23
  24 <refsection><info><title>Description</title></info>
  25
  26 <para>A mediaobject may contain several objects such as imageobjects.
  27 If the parameter <parameter>use.role.for.mediaobject</parameter> is
  28 non-zero, then the <literal>role</literal> attribute on
  29 <tag>imageobject</tag>s and other objects within a
  30 <tag>mediaobject</tag> container will be used to select which object
  31 will be used.  If one of the objects has a role value that matches the
  32 <parameter>preferred.mediaobject.role</parameter> parameter, then it
  33 has first priority for selection.  If more than one has such a role
  34 value, the first one is used.
  35 </para>
  36 <para>
  37 See the <parameter>use.role.for.mediaobject</parameter> parameter
  38 for the sequence of selection.</para>
  39 </refsection>
  40 </refentry>