stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/params/use.role.for.mediaobject.xml

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