variablelist.max.termlength.xml 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  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. <refsynopsisdiv>
  16. <src:fragment xml:id="variablelist.max.termlength.frag">
  17. <xsl:param name="variablelist.max.termlength">24</xsl:param>
  18. </src:fragment>
  19. </refsynopsisdiv>
  20. <refsection><info><title>Description</title></info>
  21. <para>In variablelists, the <tag>listitem</tag>
  22. is indented to leave room for the
  23. <tag>term</tag> elements. That indent may be computed
  24. if it is not specified with a <tag class="attribute">termlength</tag>
  25. attribute on the <tag>variablelist</tag> element.
  26. </para>
  27. <para>
  28. The computation counts characters in the
  29. <tag>term</tag> elements in the list
  30. to find the longest term. However, some terms are very long
  31. and would produce extreme indents. This parameter lets you
  32. set a maximum character count. Any terms longer than the maximum
  33. would line wrap. The default value is 24.
  34. </para>
  35. <para>
  36. The character counts are converted to physical widths
  37. by multiplying by 0.50em. There will be some variability
  38. in how many actual characters fit in the space
  39. since some characters are wider than others.
  40. </para>
  41. </refsection>
  42. </refentry>