blob: ff56a8786e491c88e40a2df9f35ded43a6aa1fee [file] [log] [blame]
<refentry xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
version="5.0" xml:id="variablelist.max.termlength">
<refmeta>
<refentrytitle>variablelist.max.termlength</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
</refmeta>
<refnamediv>
<refname>variablelist.max.termlength</refname>
<refpurpose>Specifies the longest term in variablelists</refpurpose>
</refnamediv>
<refsynopsisdiv>
<src:fragment xml:id="variablelist.max.termlength.frag">
<xsl:param name="variablelist.max.termlength">24</xsl:param>
</src:fragment>
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>In variablelists, the <tag>listitem</tag>
is indented to leave room for the
<tag>term</tag> elements. That indent may be computed
if it is not specified with a <tag class="attribute">termlength</tag>
attribute on the <tag>variablelist</tag> element.
</para>
<para>
The computation counts characters in the
<tag>term</tag> elements in the list
to find the longest term. However, some terms are very long
and would produce extreme indents. This parameter lets you
set a maximum character count. Any terms longer than the maximum
would line wrap. The default value is 24.
</para>
<para>
The character counts are converted to physical widths
by multiplying by 0.50em. There will be some variability
in how many actual characters fit in the space
since some characters are wider than others.
</para>
</refsection>
</refentry>