]> git.stg.codes - stg.git/blob - doc/xslt/common/pi.xml
Produce debug output only if SMUX_DEBUG is defined
[stg.git] / doc / xslt / common / pi.xml
1 <?xml version="1.0"?>
2
3 <reference><info><title>Common Processing Instruction Reference</title>
4     <releaseinfo role="meta">
5       $Id: pi.xsl 8782 2010-07-27 21:15:17Z mzjn $
6     </releaseinfo>
7   </info>
8   <partintro xml:id="partintro">
9     <title>Introduction</title>
10     
11 <para>This is generated reference documentation for all
12       user-specifiable processing instructions (PIs) in the
13       “common” part of the DocBook XSL stylesheets.
14       <note>
15         
16 <para>You add these PIs at particular points in a document to
17           cause specific “exceptions” to formatting/output behavior. To
18           make global changes in formatting/output behavior across an
19           entire document, it’s better to do it by setting an
20           appropriate stylesheet parameter (if there is one).</para>
21
22       </note>
23     </para>
24
25   </partintro>
26
27 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbchoice_choice">
28 <refnamediv>
29 <refname>dbchoice_choice</refname>
30 <refpurpose>Generates a localized choice separator</refpurpose>
31 </refnamediv>
32 <refsynopsisdiv>
33
34     <synopsis><tag class="xmlpi">dbchoice choice="and"|"or"|<replaceable>string</replaceable>"</tag></synopsis>
35   
36 </refsynopsisdiv>
37 <refsect1><title>Description</title>
38     
39 <para>Use the <tag class="xmlpi">dbchoice choice</tag> PI to
40       generate an appropriate localized “choice” separator (for
41       example, <literal>and</literal> or <literal>or</literal>)
42       before the final item in an inline <tag>simplelist</tag></para>
43
44     <warning>
45       
46 <para>This PI is a less-than-ideal hack; support for it may
47         disappear in the future (particularly if and when a more
48         appropriate means for marking up "choice" lists becomes
49         available in DocBook).</para>
50
51     </warning>
52   </refsect1><refsect1><title>Parameters</title>
53     
54 <variablelist>
55       <varlistentry><term>choice="and"</term>
56         <listitem>
57           
58 <para>generates a localized <literal>and</literal> separator</para>
59
60         </listitem>
61       </varlistentry>
62       <varlistentry><term>choice="or"</term>
63         <listitem>
64           
65 <para>generates a localized <literal>or</literal> separator</para>
66
67         </listitem>
68       </varlistentry>
69       <varlistentry><term>choice="<replaceable>string</replaceable>"</term>
70         <listitem>
71           
72 <para>generates a literal <replaceable>string</replaceable> separator</para>
73
74         </listitem>
75       </varlistentry>
76     </variablelist>
77
78   </refsect1></refentry>
79
80 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbtimestamp">
81 <refnamediv>
82 <refname>dbtimestamp</refname>
83 <refpurpose>Inserts a date timestamp</refpurpose>
84 </refnamediv>
85 <refsynopsisdiv>
86
87     <synopsis><tag class="xmlpi">dbtimestamp format="<replaceable>formatstring</replaceable>" [padding="0"|"1"]</tag></synopsis>
88   
89 </refsynopsisdiv>
90 <refsect1><title>Description</title>
91     
92 <para>Use the <tag class="xmlpi">dbtimestamp</tag> PI at any point in a
93       source document to cause a date timestamp (a formatted
94       string representing the current date and time) to be
95       inserted in output of the document.</para>
96
97   </refsect1><refsect1><title>Parameters</title>
98     
99 <variablelist>
100       <varlistentry><term>format="<replaceable>formatstring</replaceable>"</term>
101         <listitem>
102           
103 <para>Specifies format in which the date and time are
104             output</para>
105
106         <note>
107           
108 <para>For details of the content of the format string,
109             see <link role="tcg" xlink:href="Datetime.html">Date and time</link>.</para>
110
111         </note>
112         </listitem>
113       </varlistentry>
114       <varlistentry><term>padding="0"|"1"</term>
115         <listitem>
116           
117 <para>Specifies padding behavior; if non-zero, padding is is added</para>
118
119         </listitem>
120       </varlistentry>
121     </variablelist>
122
123   </refsect1></refentry>
124
125 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbtex_delims">
126 <refnamediv>
127 <refname>dbtex_delims</refname>
128 <refpurpose>Generates delimiters around embedded TeX equations
129     in output</refpurpose>
130 </refnamediv>
131 <refsynopsisdiv>
132
133     <synopsis><tag class="xmlpi">dbtex delims="no"|"yes"</tag></synopsis>
134   
135 </refsynopsisdiv>
136 <refsect1><title>Description</title>
137     
138 <para>Use the <tag class="xmlpi">dbtex delims</tag> PI as a
139       child of a <tag>textobject</tag> containing embedded TeX
140       markup, to cause that markup to be surrounded by
141       <literal>$</literal> delimiter characters in output.</para>
142
143       <warning>
144        
145 <para>This feature is useful for print/PDF output only if you
146        use the obsolete and now unsupported PassiveTeX XSL-FO
147        engine.</para>
148
149       </warning>
150   </refsect1><refsect1><title>Parameters</title>
151     
152 <variablelist>
153       <varlistentry><term>dbtex delims="no"|"yes"</term>
154         <listitem>
155           
156 <para>Specifies whether delimiters are output</para>
157
158         </listitem>
159       </varlistentry>
160     </variablelist>
161
162   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
163     
164 <para><parameter>tex.math.delims</parameter></para>
165
166   </refsect1></refentry>
167 </reference>
168