Differences

This shows you the differences between two versions of the page.

--- en:user:gs3_sample_interface_modifications [2016/05/12 02:08] – kjdon
+++ en:user:gs3_sample_interface_modifications [2019/10/21 22:28] – [Changing the collection description] kjdon
@@ Line 3: / Line 3: @@
 This page provides examples of interface modifications. Many of these changes can be made at either the collection, interface or site level.
-===== General =====
+See the [[en:user:interfaces|interfaces page]] for more general information about customising the interface.
+==== Changing the collection description ====
+The collection's description - shown on the about page - generally comes from the 'description' displayItem in the collection's collectionConfig.xml file. This can only hold text and html. Sometimes you might want to do more in the description.
+The place where the description gets printed out is in the about page XSL: web/interfaces/default/transform/pages/about.xsl.
+There is a template called coll-description:
+<code>
+<xsl:template name="coll-description">
+   <gslib:collectionDescriptionTextAndServicesLinks/>
+</xsl:template>
+</code>
+<gslib> elements are shortcuts to predefined templates, and can be found in web/interfaces/default/transform/gslib.xsl. See the [[en:user:gslib|gslib page]] for more details.
+This template basically outputs the collection's description displayItem. Lets leave that displayed as is, but also output "This collection contains X documents, and was last built on Y".
+We can redefine the template as:
+<code>
+<xsl:template name="coll-description">
+   <gslib:collectionDescriptionTextAndServicesLinks/>
+   <xsl:variable name="raw_date"><gslib:collectionMeta name="buildDate"/></xsl:variable>
+   The collection contains <gslib:collectionMeta name="numDocs"/> documents, and was last
+   built on <xsl:value-of select="util:formatTimeStamp($raw_date, 0, 0, /page/@lang)"/>.
+</xsl:template>
+</code>
+<gslib:collectionMeta> can retrieve metadata elements from the collection (as opposed to from documents). Here we use it to retrieve "numDocs" metadata - the number of documents in the collection - and "buildDate" metadata - the date the collection was last built.
+The buildDate metadata element is a timestamp, so is not user friendly. We can use one of our utility functions to format it.
+Utility functions are defined in src/java/org/greenstone/gsdl3/util/XSLTUtil.java.
+In this case, we are formatting the timestamp as a date (the second 0). We could also format it as 'days ago' (using 3 instead of 0):
+<code>
+The collection contains <gslib:collectionMeta name="numDocs"/> documents, and was last
+   built <xsl:value-of select="util:formatTimeStamp($raw_date, 0, 3, /page/@lang)"/> days ago.
+</code>
+If we want this text to be displayed in a language dependent manner, then we need to define it in the properties file, (and translate it in the appropriate language properties file), and retrieve it from there.
+The default interface has these two statements already defined (in web/WEB-INF/classes/interface_default.properties):
+<code>
+about.standarddescriptiondays=This collection contains {0-numdocs} documents and was last built {1-numdays} days ago.
+about.standarddescriptiondate=This collection contains {0-numdocs} documents and was last built on {1-date}.
+</code>
+To call them, we need to define variables for the arguments, and then pass them in as a ; separated string.
+<code>
+<xsl:variable name="raw_date"><gslib:collectionMeta name="buildDate"/></xsl:variable>
+<xsl:variable name="formatted_date"><xsl:value-of select="util:formatTimeStamp($raw_date, 0, 3, /page/@lang)"/></xsl:variable>
+<xsl:variable name="numdocs"><gslib:collectionMeta name="numDocs"/></xsl:variable>
+<p><xsl:value-of select="util:getInterfaceText($interface_name, /page/@lang, 'about.standarddescriptiondays', concat($numdocs, ';', $formatted_date))"/></p>
+</code>
+If we wanted to use this technique, but want to define our own text just for the collection, we can add an interface_custom.propeties file into web/sites/localsite/collect/coll-name/resources folder.
+Define the property there, eg:
+<code>
+descriptionextra=This very awesome collection was last built {0-days} ago, and contains {1-numdocs} manuscripts.
+</code>
+Then we use a similar utility function call that will look for the key in the custom file instead of the standard file:
+<code>
+<xsl:value-of select="util:getCollectionText('lucene-jdbm-demo', $site_name, /page/@lang, 'descriptionextra', concat($formatted_date, ';', $numdocs))"/>
+</code>
+Note we have changed the order in which we use the arguments, so we need to change the order we pass them in.
+==== Total documents in library ====
+The above section shows how to add "this collection contains X number of documents" to a collection's about page. But what if we want to do that for the whole library?
+We can add up all the numDocs from each collection using 'sum', and count the number of collections using 'count':
+<code>
+<xsl:template match="/page/pageResponse">
+....
+<xsl:variable name="totaldocs" select="sum(/page/pageResponse/collectionList/collection/metadataList
+/metadata[@name='numDocs'])" />
+<xsl:variable name="totalcolls" select="count(/page/pageResponse/collectionList/collection)"/>
+<p>This library contains a total of <xsl:value-of select="$totaldocs"/> documents over <xsl:value-of
+select="$totalcolls"/> collections.</p>
+....
+</xsl:template>
+</code>
 ==== Footer modification (text on left, image on right) ====