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