root/main/trunk/greenstone3/web/interfaces/default/transform/config_format.xsl @ 26121

Revision 26121, 13.7 KB (checked in by ak19, 8 years ago)

Added a gsf:icon option that takes a file attribute for custom icon images located inside a collection's images folder. To be used in the tutorial Building a Multimedia Collection, the step on Using different icons for different media types.

Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<xsl:stylesheet version="1.0"
3    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
4    xmlns:xslt="output.xsl"
5    xmlns:java="http://xml.apache.org/xslt/java"
6    xmlns:gsf="http://www.greenstone.org/greenstone3/schema/ConfigFormat"
7    xmlns:util="xalan://org.greenstone.gsdl3.util.XSLTUtil"
8    extension-element-prefixes="java">
9    <xsl:param name="interface_name"/>
10    <xsl:param name="library_name"/>
11 
12    <xsl:output method="xml"/>
13    <xsl:namespace-alias stylesheet-prefix="xslt" result-prefix="xsl"/>
14
15    <xsl:template match="format">
16        <format>
17            <xsl:apply-templates/>
18        </format>
19    </xsl:template>
20 
21    <xsl:template match="gsf:template">
22        <xslt:template>
23            <xsl:copy-of select="@*"/>
24            <xsl:attribute name="priority">2</xsl:attribute>
25            <xsl:if test=".//gsf:link">
26                <xslt:param name="serviceName"/>
27                <xslt:param name="collName"/>
28            </xsl:if>
29            <xsl:apply-templates/>
30        </xslt:template>
31    </xsl:template>
32   
33    <xsl:template match="gsf:variable">
34        <xslt:variable>
35            <xsl:copy-of select="@*"/>
36            <xsl:apply-templates/>
37        </xslt:variable>
38        <script type="text/javascript">
39            gs.variables.<xsl:value-of select="@name"/><xslt:text disable-output-escaping="yes"> = "</xslt:text><xsl:apply-templates/><xslt:text disable-output-escaping="yes">";</xslt:text>
40        </script>
41    </xsl:template>
42   
43    <xsl:template match="gsf:defaultClassifierNode">
44        <xslt:call-template name="defaultClassifierNode"/>
45    </xsl:template>
46
47    <xsl:template match="gsf:image">
48        <xslt:variable name="metaName">
49            <xsl:choose>
50                <xsl:when test="@type = 'thumb'">Thumb</xsl:when>
51                <xsl:when test="@type = 'screen'">Screen</xsl:when>
52                <xsl:when test="@type = 'source'">SourceFile</xsl:when>
53            </xsl:choose>
54        </xslt:variable>
55        <xslt:if test="(.//metadataList)[last()]/metadata[@name = $metaName]">
56            <img>
57                <xslt:attribute name='src'>
58                    <xslt:value-of disable-output-escaping="yes" select="/page/pageResponse/collection/metadataList/metadata[@name = 'httpPath']"/>
59                    <xsl:text>/index/assoc/</xsl:text>
60                    <xslt:value-of disable-output-escaping="yes" select="/page/pageResponse/document/metadataList/metadata[@name = 'assocfilepath']"/>
61                    <xsl:text>/</xsl:text>
62                    <xslt:value-of disable-output-escaping="yes" select="(.//metadataList)[last()]/metadata[@name = $metaName]"/>
63                </xslt:attribute>
64            </img>
65        </xslt:if>
66    </xsl:template>
67
68    <xsl:template match="gsf:link">
69        <xsl:choose>
70            <xsl:when test="@type='classifier'">
71                <a>
72                    <xslt:attribute name='href'>
73                        <xslt:value-of select='$library_name'/>
74                        <xsl:text>/collection/</xsl:text>
75                        <xslt:value-of select='/page/pageResponse/collection/@name'/>
76                        <xsl:text>/browse/</xsl:text>
77                        <xslt:value-of select='util:replace(@nodeID, ".", "/")'/>
78                    </xslt:attribute>
79                    <xsl:apply-templates/>
80                </a>
81            </xsl:when>
82            <xsl:when test="@type='source'">
83                <a><xslt:attribute name='href'><xslt:value-of
84                   disable-output-escaping="yes" select="/page/pageResponse/collection/metadataList/metadata[@name='httpPath']" />/index/assoc/<xslt:value-of
85                   disable-output-escaping="yes" select="(.//metadataList)[last()]/metadata[@name='assocfilepath']" />/<xslt:value-of
86                   disable-output-escaping="yes" select="(.//metadataList)[last()]/metadata[@name='srclinkFile']" /></xslt:attribute>
87                  <xsl:apply-templates/>
88                </a>
89            </xsl:when>
90            <xsl:when test="@type='web'">
91              <xslt:value-of disable-output-escaping="yes" select="metadataList/metadata[contains(@name, 'weblink')]"/>
92              <xsl:apply-templates/>
93              <xslt:value-of disable-output-escaping="yes" select="metadataList/metadata[contains(@name, '/weblink')]"/>
94            </xsl:when>
95            <xsl:when test="@type='equivdoc'">
96              <xsl:call-template name="gsf:equivlinkgs3"/>
97            </xsl:when>
98            <xsl:otherwise> <!-- a document link -->
99                <xslt:variable name="bookswitch">
100                    <xslt:value-of select="/page/pageRequest/paramList/param[@name='book']/@value"/>
101                </xslt:variable>
102                <a>
103                    <xslt:attribute name="href">
104                        <xslt:value-of select='$library_name'/>
105                        <xsl:text>/collection/</xsl:text>
106                        <xslt:value-of select='/page/pageResponse/collection/@name'/>
107                        <xsl:text>/document/</xsl:text>
108                        <xslt:value-of select='@nodeID'/>
109                        <xslt:choose>
110                            <xslt:when test="$bookswitch = 'on' or $bookswitch = 'flashxml'">
111                                <xsl:text>?book=on</xsl:text>
112                            </xslt:when>
113                            <xslt:otherwise>
114                                <xslt:if test="$opt-doc-link-args">?<xslt:value-of select="$opt-doc-link-args"/></xslt:if>
115                            </xslt:otherwise>
116                        </xslt:choose>
117                    </xslt:attribute>
118                    <xsl:apply-templates/>
119                </a>
120            </xsl:otherwise>
121        </xsl:choose>
122    </xsl:template>
123
124    <xsl:template match="gsf:icon">
125        <xsl:choose>
126            <xsl:when test="@type='classifier'">
127                <img style="border:0px"><xsl:attribute name="src"><xsl:value-of select="util:getInterfaceText($interface_name, /page/@lang, 'bookshelf_image')"/></xsl:attribute></img>
128            </xsl:when>
129            <xsl:when test="@type='web'">
130              <xslt:value-of disable-output-escaping="yes" select="metadataList/metadata[contains(@name, 'webicon')]"/>             
131            </xsl:when>
132            <xsl:when test="@file">
133                <img>
134                <xslt:attribute name='src'>
135                    <xslt:value-of disable-output-escaping="yes" select="/page/pageResponse/collection/metadataList/metadata[@name = 'httpPath']"/>
136                    <xsl:text>/images/</xsl:text>
137                    <xsl:value-of disable-output-escaping="yes" select="@file"/>
138                </xslt:attribute>
139                </img>
140            </xsl:when>
141            <xsl:when test="not(@type) or @type='document'">
142                <img style="border:0px"><xslt:attribute name="id">documentBasketBook<xslt:value-of select="/page/pageResponse/collection/@name"/>:<xslt:value-of select="@nodeID"/></xslt:attribute><xslt:attribute name="src">
143                    <xslt:choose>
144                        <xslt:when test="@docType='hierarchy' and @nodeType='root'">
145                            <xsl:value-of select="util:getInterfaceText($interface_name, /page/@lang, 'book_image')"/>
146                        </xslt:when>
147                        <xslt:otherwise>
148                            <xsl:value-of select="util:getInterfaceText($interface_name, /page/@lang, 'page_icon_image')"/>
149                        </xslt:otherwise>
150                    </xslt:choose>
151                </xslt:attribute></img>
152            </xsl:when>
153        </xsl:choose>
154    </xsl:template>
155   
156  <!-- calls a template in gslib.xsl in order to avoid xsl vs xslt issue -->
157  <!--<xsl:template match="gsf:equivlinkgs3">
158    <xslt:call-template name="equivDocLinks">
159      <xslt:with-param name="count" select="0"/>
160    </xslt:call-template>
161  </xsl:template>-->
162
163  <!-- Another way (also works with DSpace tutorial): build all the equivalent document links for the current document in one go. No looping necessary: handled in function call. -->
164  <xsl:template match="gsf:equivlinkgs3" name="gsf:equivlinkgs3">
165    <xslt:variable name="docicon" select="metadataList/metadata[contains(@name, 'equivDocIcon')]"/>
166    <xslt:variable name="docStartlink" select="metadataList/metadata[contains(@name, 'all_*,*_equivDocLink')]"/>   
167    <xslt:variable name="docEndlink" select="metadataList/metadata[contains(@name, '/equivDocLink')]"/>
168
169    <xslt:variable name="equivDocLinks" select="java:org.greenstone.gsdl3.util.XSLTUtil.getEquivDocLinks(',',$docicon, $docStartlink, $docEndlink, ' ')" />
170    <xslt:value-of disable-output-escaping="yes" select="$equivDocLinks"/>
171  </xsl:template>
172
173<!--
174In the collection's format statement, could have the following javascript+XSLT in place of
175the gsf:equivlinkgs3 element (which resolves to the XSLT in config_format.xsl and gslib.xsl).
176<xsl:text disable-output-escaping="yes">&lt;script&gt;var equivDocIcon= [ &quot;
177</xsl:text>
178<gsf:metadata name="equivDocIcon" separator="&quot;, &quot;" multiple="true"/>
179<xsl:text disable-output-escaping="yes">&quot;];var equivDocStartLink= [ &quot;
180</xsl:text>
181<gsf:metadata name="equivDocLink" separator="&quot;,&quot;" multiple="true"/>
182<xsl:text disable-output-escaping="yes">&quot;];var equivDocEndLink= [ &quot;
183</xsl:text>
184<gsf:metadata name="/equivDocLink" separator="&quot;,&quot;" multiple="true"/>
185<xsl:text disable-output-escaping="yes">&quot;];for (var i=0; i&lt;equivDocIcon.length; i++) { document.write(equivDocStartLink[i]+ equivDocIcon[i] + equivDocEndLink[i]); }&lt;/script&gt;
186</xsl:text>
187-->
188
189    <!-- gsf:cgiparam example, as used by the Enhanced PDF tutorial:
190        <a><xsl:attribute name="href"><gsf:metadata name="httpPath" type="collection"/>/index/assoc/<gsf:metadata name="archivedir"/>/<gsf:metadata name="srclinkFile"/>#search=&amp;quot;<gsf:cgi-param name="query"/>&amp;quot;</xsl:attribute>src doc link with query highlighting</a> -->
191    <xsl:template match="gsf:cgi-param">
192        <xslt:value-of disable-output-escaping="yes" select="/page/pageRequest/paramList/param[@name='s1.{@name}']/@value"/>       
193    </xsl:template>
194
195    <!-- A GLI user can use a gsf:displayText element in GS3's Format Features to retrieve
196      a string defined in either collectionConfig.xml or else the interface dictionaries.
197      If the requested string occurs in neither, the request string itself will be output. -->
198    <xsl:template match="gsf:displayText">
199      <xslt:variable name="displaytext">
200        <xsl:call-template name="gsf:displayItem"/>
201      </xslt:variable>
202
203      <xslt:choose>
204        <xslt:when test="$displaytext != ''">
205          <xslt:value-of disable-output-escaping="yes" select="$displaytext"/>       
206        </xslt:when>
207        <xslt:otherwise>
208          <xslt:variable name="interfacetxt">
209        <xsl:call-template name="gsf:interfaceText"/>
210          </xslt:variable>
211
212          <xslt:choose>
213        <xslt:when test="$interfacetxt != ''">
214          <xslt:value-of disable-output-escaping="yes" select="$interfacetxt"/>
215        </xslt:when>
216        <xslt:otherwise>
217          <xslt:value-of disable-output-escaping="yes" select="'{@name}'"/>
218        </xslt:otherwise>
219          </xslt:choose>
220        </xslt:otherwise>
221      </xslt:choose>
222    </xsl:template>
223
224    <!-- With gsf:displayItem, a user can request a displayItem from collectionConfig.xml -->
225    <xsl:template match="gsf:displayItem" name="gsf:displayItem">
226      <xslt:value-of disable-output-escaping="yes" select="/page/pageResponse/collection/displayItem[@name='{@name}']"/>
227    </xsl:template>
228
229    <!-- With gsf:interfaceText, a user can request a string from the interface dictionaries in the current lang -->
230    <xsl:template match="gsf:interfaceText" name="gsf:interfaceText">
231      <xslt:value-of disable-output-escaping="yes" select="util:getInterfaceText($interface_name, /page/@lang, '{@name}')"/>
232    </xsl:template>
233
234    <!-- if this gsf:metadata is a child of a document node then we want to get the metadata for that node -->
235  <xsl:template match="gsf:metadata">
236    <xsl:if test="not(@hidden = 'true')">
237      <!-- set hidden=true on a gsf:metadata so that it gets retrieved from the server but not displayed -->
238      <xsl:variable name="meta_name"><xsl:call-template name="getMetadataName"/></xsl:variable>
239      <xsl:variable name="separator"><xsl:choose><xsl:when test="@separator"><xsl:value-of disable-output-escaping='yes' select="@separator"/></xsl:when><xsl:otherwise><xsl:text>, </xsl:text></xsl:otherwise></xsl:choose></xsl:variable>
240      <xsl:variable name="postest">
241    <xsl:choose><xsl:when test="@pos = 'first'">position()=1</xsl:when><xsl:when test="@pos = 'last'">position() = last()</xsl:when><xsl:when test="@pos">position() = <xsl:value-of select="@pos"/></xsl:when><xsl:otherwise>true()</xsl:otherwise></xsl:choose>
242      </xsl:variable>
243      <xsl:variable name="multiple"><xsl:choose><xsl:when test="@pos">false()</xsl:when><xsl:otherwise>true()</xsl:otherwise></xsl:choose></xsl:variable>
244      <xslt:for-each><xsl:attribute name="select">
245    <xsl:if test="@type='collection'">/page/pageResponse/collection/</xsl:if>metadataList/metadata[@name='<xsl:value-of select="$meta_name"/>'<xsl:if test="@lang"><xsl:text> and @lang=</xsl:text><xsl:value-of select="@lang"/></xsl:if><xsl:text>]</xsl:text></xsl:attribute>
246      <xslt:if test="{$postest}">
247      <xslt:if test="{$multiple} and position()>1"><xsl:value-of select="$separator"/></xslt:if>
248      <xsl:choose>
249        <xsl:when test="@format">
250        <xslt:value-of disable-output-escaping='yes' select="util:{@format}(., /page/@lang )"/>
251          </xsl:when>
252        <xsl:otherwise>
253          <xslt:value-of disable-output-escaping='yes' select="."/>
254</xsl:otherwise>
255      </xsl:choose>
256    </xslt:if>
257    </xslt:for-each>
258  </xsl:if>
259  </xsl:template>
260
261  <xsl:template name="getMetadataName">
262    <xsl:if test='@select'>
263      <xsl:value-of select='@select'/>
264      <xsl:text>_</xsl:text>
265    </xsl:if>
266    <xsl:value-of select="@name"/>
267  </xsl:template>
268
269    <xsl:template match="gsf:text">
270        <xslt:call-template name="documentNodeText"/>
271    </xsl:template>
272 
273    <xsl:template match="gsf:choose-metadata">
274        <xslt:choose>
275            <xsl:for-each select="gsf:metadata">
276                <xslt:when>
277                    <xsl:attribute name="test">(.//metadataList)[last()]/metadata[@name='<xsl:call-template name="getMetadataName"/>']</xsl:attribute>
278                    <xsl:apply-templates select="."/>
279                </xslt:when>
280            </xsl:for-each>
281            <xsl:if test="gsf:default">
282                <xslt:otherwise><xsl:apply-templates select="gsf:default"/></xslt:otherwise>
283            </xsl:if>
284        </xslt:choose>
285    </xsl:template>
286 
287    <xsl:template match="gsf:switch">
288        <xsl:variable name="meta-name"><xsl:for-each select="gsf:metadata"><xsl:call-template name="getMetadataName"/></xsl:for-each></xsl:variable>
289        <xslt:variable name="meta"><xsl:choose><xsl:when test="@preprocess"><xslt:value-of select="util:{@preprocess}((.//metadataList)[last()]/metadata[@name='{$meta-name}'], /page/@lang )"/></xsl:when><xsl:otherwise><xslt:value-of select="(.//metadataList)[last()]/metadata[@name='{$meta-name}']"/></xsl:otherwise></xsl:choose></xslt:variable>
290        <xslt:choose>
291            <xsl:for-each select="gsf:when">
292                <xslt:when test="util:{@test}($meta, '{@test-value}')">
293                    <xsl:apply-templates/>
294                </xslt:when>
295            </xsl:for-each>
296            <xsl:if test="gsf:otherwise">
297                <xslt:otherwise>
298                    <xsl:apply-templates select="gsf:otherwise/node()"/>
299                </xslt:otherwise>
300            </xsl:if>
301        </xslt:choose>
302    </xsl:template>
303 
304    <xsl:template match="*">
305        <xsl:copy>
306        <xsl:copy-of select="@*"/>
307            <xsl:apply-templates/>
308        </xsl:copy>
309    </xsl:template>
310
311</xsl:stylesheet>
312
313
Note: See TracBrowser for help on using the browser.