Differences

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

--- en:user:favourites [2023/07/24 02:14] – kjdon
+++ en:user:favourites [2024/02/12 23:42] (current) – [Customizing Favourites] kjdon
@@ Line 1: / Line 1: @@
-====== Favourites/Berry Baskets (Greenstone 3) ======
+====== Greenstone 3 Favourites ======
-//[ This version is for 3.11. For 3.10 and earlier versions, please see our [[en:user:berry_baskets| Berry Baskets]] page. ]//
+//[ This page documents favourites for Greenstone 3 version 3.11. For 3.10 and earlier versions, please see our [[en:user:berry_baskets| Berry Baskets]] page. ]//
-A favourites functionality has been implemented in Greenstone 3. This allows the user to collect up a set of interesting or useful documents as she is browsing through the library. Once they are finished, they can view the basket of links, and email it to themselves.
+The favourites functionality allows the user to collect up a set of interesting or useful documents as she is browsing through the library. Once they are finished, they can view the basket of links, and email it to themselves.
-Favourites - a star is displayed for each document in browsing and searching lists. Clicking the star will add/remove that document from the favourites list.
+When favourites are enabled, a star is displayed for each document in browsing and searching lists. Clicking the star will add/remove that document to/from the favourites list.
-A link to the favourites list is displayed on searching adn browsing pages. Clicking the link in the basket will take you to a full view of the contents of the list.
+A link to the favourites list is also displayed on searching, browsing and document view pages. Clicking the link will take you to a full view of the contents of the list, where you can remove items, and email the list, or copy the list for pasting elsewhere.
 ===== Activating Favourites =====
@@ Line 24: / Line 24: @@
 ===== Customizing Favourites =====
+The links in the list of favourites can now be customised using format statements (like we use to customise document lists for browsing and searching).
+The content of the favourites page is defined in web/interfaces/default/transform/pages/favourites.
+The default templace for the documentNode is below. This will be used if there is no alternative specified in the FavouriteBasket ServiceRack, or in a collectionConfig file.
+<code>
+<xsl:template match="documentNode">
+   <xsl:call-template name="displayFavourite"/>
+</xsl:template>
+<xsl:template match="documentNode" mode="plain-text">
+   <xsl:call-template name="displayPlainText"/>
+</xsl:template>
+</code>
+The displayFavourite template displays a link to the source doc (eg pdf/image etc) plus the document title which is linked to the greenstone version of the document. The displayPlainText template makes a plain text version, with no HTML markup, suitable for use in an email or in the copy buffer.
+web/sites/localsite/siteConfig.xml is where the FavouriteBasket ServiceRack is added to the library. In here we can customise the display for a particular site - by default, the documentNode templates above are just repeated here. Note, in order to be able to add collection specific formatting, this site-wide format element needs to be present.
+<code>
+   <serviceRack name="FavouriteBasket">
+      <format>
+        <!-- set the following to true is you have an email service on the server, or if you have setup mail server properties in resources/web/global.properties.in-->
+        <gsf:option name="serverEmail" value="false"/>
+        <!-- default template used for email/copy-->
+        <xsl:template match="documentNode" mode="plain-text">
+          <xsl:call-template name="displayPlainText"/>
+        </xsl:template>
+        <!-- default template used for favourites display -->
+        <xsl:template match="documentNode">
+          <xsl:call-template name="displayFavourite"/>
+        </xsl:template>
+      </format>
+    </serviceRack>
+</code>
+A collection can specify its own customisation for documents from that collection in the favourites list. In this case, we have to put it in a special place: inside a top level ccServices element (cross collection services), specifying which service the format element is for.
+For example:
+<code>
+<ccServices>
+  <format service="GetFavouritesList">
+    <xsl:template match="documentNode">
+      <xsl:call-template name="displayFavourite"/><gsf:metadata name="dc.Creator/>
+    </xsl:template>
+    <xsl:template mode="plain-text" match="documentNode">
+      <gsf:metadata name="dc.Title"/>
+       <xsl:text> (</xsl:text>
+       <xsl:value-of select="@collection"/>
+       <xsl:text>)</xsl:text>
+    </xsl:template>
+  </format>
+</ccServices>
+</code>
+The first template uses the default display template, but adds on dc.Creator metadata. The second template does away with the default altogether, and displays the dc.Title metadata, followed by the collection name in brackets. A pretty useless display, as it contains no link to the document, but just for illustrative purposes.
 ===== Setting up the Email Results Functionality =====
 The favourites list can be emailed out using a mail server, or by using the user's existing mail client.
 Mail server:
-  * the results will be emailed from an address you specify
+  * the results will be emailed from a pre-specified  address
   * requires the mail server to be set up
   * works for all users
@@ Line 43: / Line 98: @@
 If you have a mail server set up on the machine running tomcat, or you want to use another existing mail server,
-Please edit resources/web/global.properties.in (31 July 2018 and later binaries) or resources/web/global.properties (30 July 2018 or earlier binaries). Set your mail server, username and password etc by uncommenting the lines and setting the proper values.
+Please edit resources/web/global.properties.in. Set your mail server, username and password etc by uncommenting the lines and setting the proper values.
 <code>