doc/xslt/params/variablelist.as.blocks.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="variablelist.as.blocks">
   7 <refmeta>
   8 <refentrytitle>variablelist.as.blocks</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>variablelist.as.blocks</refname>
  13 <refpurpose>Format <tag>variablelist</tag>s lists as blocks?</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17 <src:fragment xml:id="variablelist.as.blocks.frag">
  18 <xsl:param name="variablelist.as.blocks" select="0"/>
  19 </src:fragment>
  20 </refsynopsisdiv>
  21
  22 <refsection><info><title>Description</title></info>
  23
  24 <para>If non-zero, <tag>variablelist</tag>s will be formatted as
  25 blocks.</para>
  26
  27 <para>If you have long terms, proper list markup in the FO case may produce
  28 unattractive lists. By setting this parameter, you can force the stylesheets
  29 to produce block markup instead of proper lists.</para>
  30
  31 <para>You can override this setting with a processing instruction as the
  32 child of <tag>variablelist</tag>: <tag class="xmlpi">dbfo
  33 list-presentation="blocks"</tag> or <tag class="xmlpi">dbfo
  34 list-presentation="list"</tag>.</para>
  35
  36 <para>When using <literal>list-presentation="list"</literal>,
  37 you can also control the amount of space used for the <tag>term</tag>s with
  38 the <tag class="xmlpi">dbfo term-width=".25in"</tag> processing instruction,
  39 the <tag class="attribute">termlength</tag> attribute on <tag>variablelist</tag>,
  40 or allow the stylesheets to attempt to calculate the amount of space to leave based on the
  41 number of letters in the longest term.
  42 </para>
  43
  44 <programlisting>  &lt;variablelist&gt;
  45         &lt;?dbfo list-presentation="list"?&gt;
  46         &lt;?dbfo term-width="1.5in"?&gt;
  47         &lt;?dbhtml list-presentation="table"?&gt;
  48         &lt;?dbhtml term-width="1.5in"?&gt;
  49         &lt;varlistentry&gt;
  50           &lt;term&gt;list&lt;/term&gt;
  51           &lt;listitem&gt;
  52                 &lt;para&gt;
  53                   Formatted as a list even if variablelist.as.blocks is set to 1.
  54                 &lt;/para&gt;
  55           &lt;/listitem&gt;
  56         &lt;/varlistentry&gt;
  57   &lt;/variablelist&gt;</programlisting>
  58
  59
  60 </refsection>
  61
  62 </refentry>