Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:user:gs3_sample_interface_modifications [2016/05/12 14:08]
kjdon
en:user:gs3_sample_interface_modifications [2019/09/24 12:33] (current)
kjdon [Total documents in library]
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. 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. 
 + 
 +Lets leave the collection description displayed as is, but 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 colleciton. 
 + 
 +The buildDate metadata element is a timestamp, so is not user friendly. We can use one of our utility functions to format it. 
 + 
 +==== 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) ==== ==== Footer modification (text on left, image on right) ====