Differences

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

--- en:user:berry_baskets [2019/10/02 01:52] – [Berry Baskets (Greenstone 3)] kjdon
+++ en:user:berry_baskets [2023/07/24 01:44] (current) – [Favourites/Berry Baskets (Greenstone 3)] kjdon
@@ Line 1: / Line 1: @@
 ====== Favourites/Berry Baskets (Greenstone 3) ======
-A favourites/berry basket functionality has been implemented in Greenstone 3. This allows the user to collect up a set of interesting of useful documents as she is browsing through a library. Once they are finished, they can view the basket of links, and email it to themselves.
+//[ This version is for 3.10 and earlier. For 3.11 and later versions, please see our [[en:user:favourites| Favourites]] page. ]//
-===== Activating Berry Baskets =====
+A favourites/berry basket 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 library administrator can enable the Berry Basket functionality by including the BerryBasket serviceRack in the siteConfig.xml file. This is present by default: commenting it out will remove that functionality from the library.
+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.
-The user can turn on this feature in the Preferences page. Once it is activated, little berries will appear in browsing lists and search results. These berries can be dragged into the basket that appears on the right hand side of the page.
+Berry Baskets - little berries are displayed by each document. Drag a berry on to the basket to add that document.
+The basket itself is displayed on the side of the page. Clicking the link in the basket will take you to a full view of the contents of the basket.
+===== Activating Favourites/Berry Baskets =====
+By default, Favourites is active, not Berry Baskets.
+The library administrator can change to use Berry Baskets, or disable the functionality altogether by editing options in the web/interfaces/default/interfaceConfig.xml file.
+<code>
+<optionList>
+  <option name="favouriteBasket" value="true"/>
+  <option name="berryBasket" value="false"/>
+</optionList>
+</code>
+Set both to false to disable this completely.
+While the functionality is active, it is not turned on for the user by default. (It will be for 3.10 and later). The user can go to Preferences, and turn it on/off.
+To make it turned on/off by default, set a paramDefault in web/sites/localsite/siteConfig.xml.
+<code>
+<format>
+  <paramDefault name="favouritebasket" value="on"/>  (or 'off', or 'berrybasket')
+</format>
+</code>
 ===== Customizing Berry Baskets =====
@@ Line 30: / Line 57: @@
 If you want to customise the display, take a look at the javascript code. web/interfaces/default/js/berrybasket/berrybasket.js, function showBasket() displays the small version on other pages, while web/interfaces/default/js/berrybasket/berrycheckout.js functions showFullView(), showTextView() and showEmail() display the different basket views. In particular, populateUrlsAndMetadata() displays the links plus metadata entries for Text and Email views, and generateDocDisplay() displays the entries for the text view.
-=== Using dc.Title instead of Title in Berry Basket display ===
+=== Example: Using dc.Title instead of Title in Berry Basket display ===
 By default, the berry basket entries display Title metadata. If the linked item is a section, it will also display the book Title (root_Title).