en:user:berry_baskets
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
en:user:berry_baskets [2018/07/30 02:31] – [Setting up the Email Results Functionality] kjdon | en:user:berry_baskets [2023/07/24 01:44] (current) – [Favourites/Berry Baskets (Greenstone 3)] kjdon | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Berry Baskets (Greenstone 3) ====== | ||
- | A 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. | ||
- | ===== Activating Berry Baskets ===== | ||
- | 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/Berry Baskets (Greenstone 3) ====== |
- | The user can turn on this feature | + | //[ This version is for 3.10 and earlier. For 3.11 and later versions, please see our [[en:user: |
+ | |||
+ | A favourites/ | ||
+ | |||
+ | Favourites - a star is displayed for each document | ||
+ | |||
+ | Berry Baskets - little | ||
+ | |||
+ | The basket itself is displayed | ||
+ | |||
+ | ===== Activating Favourites/ | ||
+ | |||
+ | 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/ | ||
+ | < | ||
+ | < | ||
+ | <option name=" | ||
+ | <option name=" | ||
+ | </ | ||
+ | </ | ||
+ | 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, | ||
+ | |||
+ | To make it turned on/off by default, set a paramDefault in web/ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
===== Customizing Berry Baskets ===== | ===== Customizing Berry Baskets ===== | ||
Line 24: | Line 51: | ||
</ | </ | ||
- | By default, these will just get added to the item's display. If you want to customise the display, take a look at the javascript code. web/ | + | Then restart Tomcat. |
+ | |||
+ | By default, these specified metadata elements | ||
+ | |||
+ | If you want to customise the display, take a look at the javascript code. web/ | ||
+ | |||
+ | === 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). | ||
+ | |||
+ | If we have a collection that doesn' | ||
+ | |||
+ | 1. Edit web/ | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | 2. Edit web/ | ||
+ | |||
+ | Look for generateDocDisplay and edit it: | ||
+ | < | ||
+ | Replace: | ||
+ | a.href=generateURL(doc); | ||
+ | a.appendChild(document.createTextNode(doc[' | ||
+ | with either: | ||
+ | 1. Use this if all documents have dc.Title instead of Title | ||
+ | |||
+ | a.href=generateURL(doc); | ||
+ | a.appendChild(document.createTextNode(doc[' | ||
+ | |||
+ | or: | ||
+ | 2. use this if some documents have Title and some have dc.Title | ||
+ | |||
+ | a.href=generateURL(doc); | ||
+ | if (doc[' | ||
+ | | ||
+ | } else if (doc[' | ||
+ | | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | This will now display dc.Title instead of Title for the title link to the document in the full view. | ||
+ | However, as dc.Title is not defined as one of the standard metadatas, it also gets added to the end of the display. To prevent this, either add it to the default_metas list at the top of the file, or modify generateDocDisplay further. | ||
+ | < | ||
+ | Replace: | ||
+ | for (var metaItem in doc) { | ||
+ | if ( !default_metas.includes(metaItem)){ | ||
+ | | ||
+ | } | ||
+ | } | ||
+ | |||
+ | with: | ||
+ | for (var metaItem in doc) { | ||
+ | if ( !default_metas.includes(metaItem) && metaItem != ' | ||
+ | | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | In the text and email view, all metadata is displayed in a list: First the hard-wired ones, then any that are not in the default list. So the dc.Title metadata just gets added to the list. If you added dc.Title to default_metas list as mentioned above, then you need to manually add it to the display to get it to appear. | ||
+ | |||
+ | For example, in populateUrlsAndMetadata(), | ||
+ | < | ||
+ | if (doc[' | ||
+ | metadata += " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
==== Document Link ==== | ==== Document Link ==== | ||
en/user/berry_baskets.1532917896.txt.gz · Last modified: 2018/07/30 02:31 by kjdon