variablelist.term.separator.xml 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  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.term.separator">
  7. <refmeta>
  8. <refentrytitle>variablelist.term.separator</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>variablelist.term.separator</refname>
  13. <refpurpose>Text to separate <tag>term</tag>s within a multi-term
  14. <tag>varlistentry</tag></refpurpose>
  15. </refnamediv>
  16. <refsynopsisdiv>
  17. <src:fragment xml:id="variablelist.term.separator.frag">
  18. <xsl:param name="variablelist.term.separator">, </xsl:param></src:fragment>
  19. </refsynopsisdiv>
  20. <refsection><info><title>Description</title></info>
  21. <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
  22. elements, the string specified in the value of the
  23. <parameter>variablelist.term.separator</parameter> parameter is placed
  24. after each <tag>term</tag> except the last.</para>
  25. <note>
  26. <para>To generate a line break between multiple <tag>term</tag>s in
  27. a <tag>varlistentry</tag>, set a non-zero value for the
  28. <parameter>variablelist.term.break.after</parameter> parameter. If
  29. you do so, you may also want to set the value of the
  30. <parameter>variablelist.term.separator</parameter> parameter to an
  31. empty string (to suppress rendering of the default comma and space
  32. after each <tag>term</tag>).</para>
  33. </note>
  34. </refsection>
  35. </refentry>