]> git.stg.codes - stg.git/blob - doc/xslt/params/preface.autolabel.xml
Ticket 26. The const MODULE_SETTINGS & ms parameter added to the
[stg.git] / doc / xslt / params / preface.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="preface.autolabel">
7 <refmeta>
8 <refentrytitle>preface.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>preface.autolabel</refname>
19 <refpurpose>Specifices the labeling format for Preface titles</refpurpose>
20 </refnamediv>
21
22 <refsynopsisdiv>
23 <src:fragment xml:id="preface.autolabel.frag"><xsl:param name="preface.autolabel" select="0"/></src:fragment>
24 </refsynopsisdiv>
25
26 <refsection><info><title>Description</title></info>
27
28 <para>If non-zero then prefaces will be numbered using the parameter
29 value as the number format if the value matches one of the following:
30 </para>
31
32 <variablelist>
33   <varlistentry>
34     <term>1 or arabic</term>
35     <listitem>
36       <para>Arabic numeration (1, 2, 3 ...).</para>
37     </listitem>
38   </varlistentry>
39   <varlistentry>
40     <term>A or upperalpha</term>
41     <listitem>
42       <para>Uppercase letter numeration (A, B, C ...).</para>
43     </listitem>
44   </varlistentry>
45   <varlistentry>
46     <term>a or loweralpha</term>
47     <listitem>
48       <para>Lowercase letter numeration (a, b, c ...).</para>
49     </listitem>
50   </varlistentry>
51   <varlistentry>
52     <term>I or upperroman</term>
53     <listitem>
54       <para>Uppercase roman numeration (I, II, III ...).</para>
55     </listitem>
56   </varlistentry>
57   <varlistentry>
58     <term>i or lowerroman</term>
59     <listitem>
60       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
61     </listitem>
62   </varlistentry>
63 </variablelist>
64
65 <para>Any nonzero value other than the above will generate
66 the default number format (arabic).
67 </para>
68
69
70 </refsection>
71 </refentry>