doc/xslt/params/use.role.for.mediaobject.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="use.role.for.mediaobject">
   7 <refmeta>
   8 <refentrytitle>use.role.for.mediaobject</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>use.role.for.mediaobject</refname>
  13 <refpurpose>Use <tag class="attribute">role</tag> attribute
  14 value for selecting which of several objects within a mediaobject to use.
  15 </refpurpose>
  16 </refnamediv>
  17
  18 <refsynopsisdiv>
  19 <src:fragment xml:id="use.role.for.mediaobject.frag">
  20 <xsl:param name="use.role.for.mediaobject" select="1"/>
  21 </src:fragment>
  22 </refsynopsisdiv>
  23
  24 <refsection><info><title>Description</title></info>
  25
  26 <para>If non-zero, the <tag class="attribute">role</tag> attribute on
  27 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> container will be used to select which object will be
  28 used.
  29 </para>
  30 <para>
  31 The order of selection when then parameter is non-zero is:
  32 </para>
  33 <orderedlist>
  34 <listitem>
  35     <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</parameter> has a value, then the object whose role equals that value is selected.</para>
  36 </listitem>
  37 <listitem>
  38 <para>Else if an object's role attribute has a value of
  39 <literal>html</literal> for HTML processing or
  40 <literal>fo</literal> for FO output, then the first
  41 of such objects is selected.
  42 </para>
  43 </listitem>
  44 <listitem>
  45 <para>Else the first suitable object is selected.</para>
  46 </listitem>
  47 </orderedlist>
  48 <para>
  49 If the value of
  50 <parameter>use.role.for.mediaobject</parameter>
  51 is zero, then role attributes are not considered
  52 and the first suitable object
  53 with or without a role value is used.
  54 </para>
  55 </refsection>
  56 </refentry>