]> git.stg.codes - stg.git/blob - doc/xslt/params/reference.autolabel.xml
Improved doc generation.
[stg.git] / doc / xslt / params / reference.autolabel.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="reference.autolabel">
7 <refmeta>
8 <refentrytitle>reference.autolabel</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
10 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
11 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
13 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
14 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
15 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
16 </refmeta>
17 <refnamediv>
18 <refname>reference.autolabel</refname>
19 <refpurpose>Specifies the labeling format for Reference titles</refpurpose>
20 </refnamediv>
21 <refsynopsisdiv>
22 <src:fragment xml:id="reference.autolabel.frag">
23   <xsl:param name="reference.autolabel">I</xsl:param>
24 </src:fragment>
25 </refsynopsisdiv>
26 <refsection><info><title>Description</title></info>
27 <para>If non-zero, references will be numbered using the parameter
28   value as the number format if the value matches one of the
29   following:
30 </para>
31 <variablelist>
32   <varlistentry>
33     <term>1 or arabic</term>
34     <listitem>
35       <para>Arabic numeration (1, 2, 3 ...).</para>
36     </listitem>
37   </varlistentry>
38   <varlistentry>
39     <term>A or upperalpha</term>
40     <listitem>
41       <para>Uppercase letter numeration (A, B, C ...).</para>
42     </listitem>
43   </varlistentry>
44   <varlistentry>
45     <term>a or loweralpha</term>
46     <listitem>
47       <para>Lowercase letter numeration (a, b, c ...).</para>
48     </listitem>
49   </varlistentry>
50   <varlistentry>
51     <term>I or upperroman</term>
52     <listitem>
53       <para>Uppercase roman numeration (I, II, III ...).</para>
54     </listitem>
55   </varlistentry>
56   <varlistentry>
57     <term>i or lowerroman</term>
58     <listitem>
59       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
60     </listitem>
61   </varlistentry>
62 </variablelist>
63 <para>Any non-zero value other than the above will generate
64 the default number format (upperroman).
65 </para>
66 </refsection>
67 </refentry>