]> git.stg.codes - stg.git/blob - doc/xslt/params/variablelist.term.separator.xml
Ticket 26. The std::string modulePath variable definition moved after
[stg.git] / doc / xslt / params / variablelist.term.separator.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.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
17 <refsynopsisdiv>
18 <src:fragment xml:id="variablelist.term.separator.frag">
19 <xsl:param name="variablelist.term.separator">, </xsl:param></src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag>
25 elements, the string specified in the value of the
26 <parameter>variablelist.term.separator</parameter> parameter is placed
27 after each <tag>term</tag> except the last.</para>
28
29 <note>
30   <para>To generate a line break between multiple <tag>term</tag>s in
31   a <tag>varlistentry</tag>, set a non-zero value for the
32   <parameter>variablelist.term.break.after</parameter> parameter. If
33   you do so, you may also want to set the value of the
34   <parameter>variablelist.term.separator</parameter> parameter to an
35   empty string (to suppress rendering of the default comma and space
36   after each <tag>term</tag>).</para>
37 </note>
38
39 </refsection>
40 </refentry>