summaryrefslogtreecommitdiff
path: root/docs-xml/xslt/db2latex-xsl/xsl/figure.mod.xsl
blob: eda03111a9a68e8f257194405b097bce41d01d24 (plain)
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
<?xml version='1.0'?>
<!DOCTYPE xsl:stylesheet [ <!ENTITY % xsldoc.ent SYSTEM "./xsldoc.ent"> %xsldoc.ent; ]>
<!--############################################################################# 
|	$Id: figure.mod.xsl,v 1.17 2004/01/26 09:43:31 j-devenish Exp $
|- #############################################################################
|	$Author: j-devenish $												
+ ############################################################################## -->

<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'>

	<doc:reference id="figure" xmlns="">
		<referenceinfo>
			<releaseinfo role="meta">
				$Id: figure.mod.xsl,v 1.17 2004/01/26 09:43:31 j-devenish Exp $
			</releaseinfo>
			<authorgroup>
				&ramon;
				&james;
			</authorgroup>
			<copyright>
				<year>2000</year><year>2001</year><year>2002</year><year>2003</year><year>2004</year>
				<holder>Ramon Casellas</holder>
			</copyright>
			<revhistory>
				<doc:revision rcasver="1.14">&rev_2003_05;</doc:revision>
			</revhistory>
		</referenceinfo>
		<title>Figures and InformalFigures <filename>figure.mod.xsl</filename></title>
		<partintro>
			<para>
			
			<doc:todo>Insert documentation here.</doc:todo>
			
			</para>
		</partintro>
	</doc:reference>

	<doc:template xmlns="">
		<refpurpose> Typeset a caption for a formal figure  </refpurpose>
		<doc:description>
			<para>
			
			Formats a caption, if any, as a centred block.
			
			</para>
		</doc:description>
		<doc:variables>
			<itemizedlist>
				<listitem><simpara><xref linkend="param.latex.figure.caption.style"/></simpara></listitem>
				<listitem><simpara><xref linkend="param.latex.caption.lot.titles.only"/></simpara></listitem>
				<listitem><simpara><xref linkend="param.latex.figure.title.style"/></simpara></listitem>
			</itemizedlist>
		</doc:variables>
		<doc:notes>
			<para>

				The &LaTeX; caption is a combination of <doc:db>title</doc:db>
				and <doc:db>caption</doc:db> children.
				A <link linkend="template.lot">list of figures</link>
				will contain cross-references to these formal figures.

			</para>
		</doc:notes>
		<doc:samples>
			<simplelist type='inline'>
				&test_subfig;
			</simplelist>
		</doc:samples>
	</doc:template>
	<xsl:template name="generate.aux.figure.caption">
		<xsl:text>{</xsl:text>
		<xsl:value-of select="$latex.figure.caption.style"/>
		<xsl:choose>
			<xsl:when test="$latex.caption.lot.titles.only='1'">
				<xsl:text>{\caption[{</xsl:text>
				<xsl:apply-templates select="title"/>
				<xsl:text>}]{{</xsl:text>
			</xsl:when>
			<xsl:otherwise>
				<xsl:text>{\caption{{</xsl:text>
			</xsl:otherwise>
		</xsl:choose>
		<xsl:value-of select="$latex.figure.title.style"/>
		<xsl:text>{</xsl:text>
		<xsl:apply-templates select="title"/>
		<xsl:text>}}</xsl:text>
		<xsl:if test="count(child::mediaobject/caption)=1">
			<xsl:text>. </xsl:text>
			<xsl:apply-templates select="mediaobject/caption" />
		</xsl:if>
		<xsl:text>}</xsl:text>
		<xsl:call-template name="label.id"/>
		<xsl:text>}}&#10;</xsl:text>
	</xsl:template>

	<doc:template xmlns="">
		<refpurpose> Process <doc:db>figure</doc:db> elements </refpurpose>
		<doc:description>
			<para>
			
			Formats a formal, <quote>floating</quote> figure with a title and caption.
			The figure may contain multiple subfigures.
			
			</para>
		</doc:description>
		<doc:variables>
			<itemizedlist>
				<listitem><simpara><xref linkend="param.formal.title.placement"/></simpara></listitem>
			</itemizedlist>
		</doc:variables>
		<doc:notes>
			<para>

				If the figure contains only one mediaobject, that mediaobject's
				caption will be used as the figure caption. However, if there
				are multiple meid in the figure, then it will be divided into
				subfigures with their own caption.

			</para>
			<para>

				If a <sgmltag class="attribute">condition</sgmltag> attribute
				exists and begins with <quote>db2latex:</quote>, or a <sgmltag
				class="pi">latex-float-placement</sgmltag> processing
				instruction is present, the remainder of its value will be used
				as the &LaTeX; <quote>float</quote> placement. Otherwise, the
				default placement is <quote>hbt</quote>.

			</para>
			&essential_preamble;
		</doc:notes>
		<doc:samples>
			<simplelist type='inline'>
				&test_subfig;
			</simplelist>
		</doc:samples>
		<doc:seealso>
			<itemizedlist>
				<listitem><simpara>&mapping;</simpara></listitem>
				<listitem><simpara><xref linkend="template.generate.aux.figure.caption"/></simpara></listitem>
			</itemizedlist>
		</doc:seealso>
	</doc:template>
	<xsl:template match="figure">
		<xsl:variable name="placement">
			<xsl:call-template name="generate.formal.title.placement">
				<xsl:with-param name="object" select="local-name(.)" />
			</xsl:call-template>
		</xsl:variable>
		<xsl:variable name="position">
			<xsl:call-template name="generate.latex.float.position">
				<xsl:with-param name="default" select="'hbt'"/>
			</xsl:call-template>
		</xsl:variable>
		<xsl:call-template name="map.begin">
			<xsl:with-param name="string" select="$position"/>
		</xsl:call-template>
		<xsl:if test="$placement='before'">
			<xsl:text>\captionswapskip{}</xsl:text>
			<xsl:call-template name="generate.aux.figure.caption" />
			<xsl:text>\captionswapskip{}</xsl:text>
		</xsl:if>
		<xsl:apply-templates select="*[name(.) != 'title']"/>
		<xsl:if test="$placement!='before'">
			<xsl:call-template name="generate.aux.figure.caption" />
		</xsl:if>
		<xsl:call-template name="map.end">
			<xsl:with-param name="string" select="$position"/>
		</xsl:call-template>
	</xsl:template>

	<doc:template xmlns="">
		<refpurpose> Typeset a caption for an informal figure  </refpurpose>
		<doc:description>
			<para>
			
			Formats a caption, if any, as a centred block.
			
			</para>
		</doc:description>
		<doc:variables>
			&no_var;
		</doc:variables>
		<doc:notes>
			<para>

				A caption, if any, is gleaned from the <doc:db>caption</doc:db>
				child of any <doc:db>mediaobject</doc:db> contained within the
				<doc:db>informalfigure</doc:db>, and will be formatted as a
				centred block.

			</para>
		</doc:notes>
		<doc:samples>
			<simplelist type='inline'>
				&test_subfig;
			</simplelist>
		</doc:samples>
	</doc:template>
	<xsl:template name="generate.aux.informalfigure.caption">
		<xsl:if test="count(child::mediaobject/caption)=1">
			<xsl:text>\begin{center}&#10;</xsl:text>
			<xsl:apply-templates select="mediaobject/caption" />
			<xsl:text>\end{center}&#10;</xsl:text>
		</xsl:if>
	</xsl:template>

	<doc:template xmlns="">
		<refpurpose>Process <doc:db>informalfigure</doc:db> elements</refpurpose>
		<doc:description>
			<para>
			
			Apply templates for an informal figure.
			
			</para>
		</doc:description>
		<doc:variables>
			&no_var;
		</doc:variables>
		<doc:notes>
			<para>
				The caption is inserted below the informalfigure.
			</para>
		</doc:notes>
		<doc:samples>
			<simplelist type='inline'>
				&test_subfig;
			</simplelist>
		</doc:samples>
		<doc:seealso>
			<itemizedlist>
				<listitem><simpara>&mapping;</simpara></listitem>
				<listitem><simpara><xref linkend="template.generate.aux.informalfigure.caption"/></simpara></listitem>
			</itemizedlist>
		</doc:seealso>
	</doc:template>
	<xsl:template match="informalfigure">
		<xsl:call-template name="map.begin"/>
		<xsl:apply-templates/>
		<xsl:call-template name="generate.aux.informalfigure.caption" />
		<xsl:call-template name="map.end"/>
	</xsl:template>

	<!--
    <xsl:template match="figure[programlisting]">
	<xsl:call-template name="map.begin">
	    <xsl:with-param name="keyword" select="programlisting"/>
	</xsl:call-template>
	<xsl:apply-templates />
	<xsl:call-template name="map.end">
	    <xsl:with-param name="keyword" select="programlisting"/>
	</xsl:call-template>
    </xsl:template>
	-->

</xsl:stylesheet>