1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
<?xml version='1.0'?>
<!--#############################################################################
|- #############################################################################
|
| PURPOSE: Admonition templates.
+ ############################################################################## -->
<xsl:stylesheet
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:doc="http://nwalsh.com/xsl/documentation/1.0"
exclude-result-prefixes="doc" version='1.0'>
<!--############################################################################# -->
<!-- DOCUMENTATION -->
<doc:reference name="admonition" xmlns="">
<referenceinfo>
<releaseinfo role="meta">
</releaseinfo>
<authorgroup>
<author><firstname>Ramon</firstname> <surname>Casellas</surname></author>
<author><firstname>James</firstname> <surname>Devenish</surname></author>
</authorgroup>
<copyright><year>2000</year><year>2001</year><year>2002</year><year>2003</year>
<holder>Ramon Casellas</holder>
</copyright>
</referenceinfo>
<title>Admonition XSL Variables and Templates <filename>admonition.mod.xsl</filename></title>
<partintro>
<section><title>Introduction</title>
<para>DocBook includes admonitions, which are set off from the main text.</para>
</section>
<formalpara><title>Pertinent Variables</title>
<itemizedlist>
<listitem><simpara><xref linkend="param.latex.use.fancybox"/></simpara></listitem>
<listitem><simpara><xref linkend="param.latex.admonition.path"/></simpara></listitem>
<listitem><simpara><xref linkend="param.latex.admonition.imagesize"/></simpara></listitem>
<listitem><simpara><xref linkend="param.latex.apply.title.templates.admonitions"/></simpara></listitem>
</itemizedlist>
</formalpara>
</partintro>
</doc:reference>
<!--############################################################################# -->
<!-- DOCUMENTATION -->
<doc:param name="latex.admonition.environment" xmlns="">
<refpurpose>
Declares a new environment to be used for admonitions
(warning, tip, important, caution, note).
</refpurpose>
<refdescription>
<para>
A LaTeX environment is emitted. That environment has two mandatory parameters.
Instances of the environment are customised for each admonition via those parameters.
Instances will be typeset as boxed areas in the document flow.
</para>
<para>
The first argument is the filename for graphics (e.g $latex.admonition.path/warning).
The second argument is the admonition title or the associated generic text.
</para>
<para>
It requires the LaTeX <link linkend="param.latex.use.fancybox">fancybox package</link>.
It also uses graphics, by default.
</para>
<example>
<title>Processing the <sgmltag class="element">warning</sgmltag> admonition</title>
<para> When processing the admonition, the following code is generated: </para>
<programlisting><![CDATA[
\begin{admonition}{figures/warning}{My WARNING}
...
\end{admonition}]]>
</programlisting>
</example>
</refdescription>
</doc:param>
<!--############################################################################# -->
<xsl:variable name="latex.admonition.environment">
<xsl:text>% ---------------------------------------------- </xsl:text>
<xsl:text>% Define a new LaTeX environment (adminipage) </xsl:text>
<xsl:text>% ---------------------------------------------- </xsl:text>
<xsl:text>\newenvironment{admminipage}% </xsl:text>
<xsl:text>{ % this code corresponds to the \begin{adminipage} command </xsl:text>
<xsl:text> \begin{Sbox}% </xsl:text>
<xsl:text> \begin{minipage}% </xsl:text>
<xsl:text>} %done </xsl:text>
<xsl:text>{ % this code corresponds to the \end{adminipage} command </xsl:text>
<xsl:text> \end{minipage} </xsl:text>
<xsl:text> \end{Sbox} </xsl:text>
<xsl:text> \fbox{\TheSbox} </xsl:text>
<xsl:text>} %done </xsl:text>
<xsl:text>% ---------------------------------------------- </xsl:text>
<xsl:text>% Define a new LaTeX length (admlength) </xsl:text>
<xsl:text>% ---------------------------------------------- </xsl:text>
<xsl:text>\newlength{\admlength} </xsl:text>
<xsl:text>% ---------------------------------------------- </xsl:text>
<xsl:text>% Define a new LaTeX environment (admonition) </xsl:text>
<xsl:text>% With 2 parameters: </xsl:text>
<xsl:text>% #1 The file (e.g. note.pdf) </xsl:text>
<xsl:text>% #2 The caption </xsl:text>
<xsl:text>% ---------------------------------------------- </xsl:text>
<xsl:text>\newenvironment{admonition}[2] </xsl:text>
<xsl:text>{ % this code corresponds to the \begin{admonition} command </xsl:text>
<xsl:text> \hspace{0mm}\newline\hspace*\fill\newline </xsl:text>
<xsl:text> \noindent </xsl:text>
<xsl:text> \setlength{\fboxsep}{5pt} </xsl:text>
<xsl:text> \setlength{\admlength}{\linewidth} </xsl:text>
<xsl:text> \addtolength{\admlength}{-10\fboxsep} </xsl:text>
<xsl:text> \addtolength{\admlength}{-10\fboxrule} </xsl:text>
<xsl:text> \admminipage{\admlength} </xsl:text>
<xsl:text> {\bfseries \sc\large{#2}}</xsl:text>
<xsl:text> \newline </xsl:text>
<xsl:text> \\[1mm] </xsl:text>
<xsl:text> \sffamily </xsl:text>
<!--
If we cannot find the latex.admonition.path;
Comment out the next line (\includegraphics).
This tactic is to avoid deleting the \includegraphics
altogether, as that could confuse a person trying to
find the use of parameter #1 in the environment.
-->
<xsl:if test="$latex.admonition.path=''">
<xsl:text>%</xsl:text>
</xsl:if>
<xsl:text> \includegraphics[</xsl:text> <xsl:value-of select="$latex.admonition.imagesize" /> <xsl:text>]{#1} </xsl:text>
<xsl:text> \addtolength{\admlength}{-1cm} </xsl:text>
<xsl:text> \addtolength{\admlength}{-20pt} </xsl:text>
<xsl:text> \begin{minipage}[lt]{\admlength} </xsl:text>
<xsl:text> \parskip=0.5\baselineskip \advance\parskip by 0pt plus 2pt </xsl:text>
<xsl:text>} %done </xsl:text>
<xsl:text>{ % this code corresponds to the \end{admonition} command </xsl:text>
<xsl:text> \vspace{5mm} </xsl:text>
<xsl:text> \end{minipage} </xsl:text>
<xsl:text> \endadmminipage </xsl:text>
<xsl:text> \vspace{.5em} </xsl:text>
<xsl:text> \par </xsl:text>
<xsl:text>} </xsl:text>
</xsl:variable>
<!--############################################################################# -->
<!-- DOCUMENTATION -->
<doc:template name="admon.graphic" xmlns="">
<refpurpose> Choose an admonition graphic </refpurpose>
<refdescription>
<para> For each admonition element (note, warning, caution, top, important),
this template chooses the graphics filename. If the admonition element is
not known, the <sgmltag class="element">note</sgmltag> graphic is used.
</para>
</refdescription>
</doc:template>
<!--############################################################################# -->
<xsl:template name="admon.graphic">
<xsl:param name="node" select="."/>
<xsl:choose>
<xsl:when test="name($node)='note'">note</xsl:when>
<xsl:when test="name($node)='warning'">warning</xsl:when>
<xsl:when test="name($node)='caution'">caution</xsl:when>
<xsl:when test="name($node)='tip'">tip</xsl:when>
<xsl:when test="name($node)='important'">important</xsl:when>
<xsl:otherwise>note</xsl:otherwise>
</xsl:choose>
</xsl:template>
<!--############################################################################# -->
<!-- DOCUMENTATION -->
<doc:template name="admonitions" match="note|important|warning|caution|tip" xmlns="">
<refpurpose> XSL Template for admonitions </refpurpose>
<refdescription>
<para> Uses the <xref linkend="param.latex.admonition.environment"/>.
</para>
<note><para>An admonition will look something like this.</para></note>
<formalpara><title>Remarks and Bugs</title>
<itemizedlist>
<listitem>
<para>
There can be <quote>excessive</quote> whitespace between
the bottom of the admonition area and a subsequent paragraph.
</para>
</listitem>
</itemizedlist>
</formalpara>
</refdescription>
</doc:template>
<!--############################################################################# -->
<xsl:template match="note|important|warning|caution|tip">
<xsl:call-template name="map.begin">
<xsl:with-param name="keyword">admonition</xsl:with-param>
<xsl:with-param name="string">
<xsl:text>{</xsl:text>
<xsl:value-of select="$latex.admonition.path"/><xsl:text>/</xsl:text>
<xsl:call-template name="admon.graphic"/>
<xsl:text>}{</xsl:text>
<xsl:choose>
<xsl:when test="title and $latex.apply.title.templates.admonitions='1'">
<xsl:call-template name="extract.object.title">
<xsl:with-param name="object" select="."/>
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<xsl:call-template name="gentext.element.name"/>
</xsl:otherwise>
</xsl:choose>
<xsl:text>}</xsl:text>
</xsl:with-param>
</xsl:call-template>
<xsl:apply-templates/>
<xsl:call-template name="map.end">
<xsl:with-param name="keyword">admonition</xsl:with-param>
</xsl:call-template>
</xsl:template>
<!-- Empty title template -->
<xsl:template match="note/title|important/title|warning/title|caution/title|tip/title"/>
</xsl:stylesheet>
|
