]> git.stg.codes - stg.git/blob - doc/help/xslt/params/variablelist.max.termlength.xml
--stringparam base.path replaces with -o
[stg.git] / doc / help / xslt / params / variablelist.max.termlength.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.max.termlength">
7 <refmeta>
8 <refentrytitle>variablelist.max.termlength</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>variablelist.max.termlength</refname>
13 <refpurpose>Specifies the longest term in variablelists</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="variablelist.max.termlength.frag">
18 <xsl:param name="variablelist.max.termlength">24</xsl:param>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>In variablelists, the <tag>listitem</tag>
25 is indented to leave room for the 
26 <tag>term</tag> elements. That indent may be computed
27 if it is not specified with a <tag class="attribute">termlength</tag>
28 attribute on the <tag>variablelist</tag> element.
29 </para>
30 <para>
31 The computation counts characters in the 
32 <tag>term</tag> elements in the list
33 to find the longest term.  However, some terms are very long
34 and would produce extreme indents.  This parameter lets you
35 set a maximum character count.  Any terms longer than the maximum
36 would line wrap.  The default value is 24.
37 </para>
38 <para>
39 The character counts are converted to physical widths
40 by multiplying by 0.50em. There will be some variability
41 in how many actual characters fit in the space
42 since some characters are wider than others.
43 </para>
44
45 </refsection>
46 </refentry>