[ This page documents favourites for Greenstone 3 version 3.11. For 3.10 and earlier versions, please see our Berry Baskets page. ]

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.

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 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.

A library can enable the favourites functionality using a servlet option. Favourites are enabled by default. To disable, please edit resources/web/servlets.xml.in, and set the favouritebasket parameter to false in the servlet description for the library you want to change.

A user can enable/disable favourites for themselves (assuming the library provides the funtionality) on the preferences page. Favourites are enabled for the user by default. To set them to be disabled by default, set a paramDefault in web/sites/localsite/siteConfig.xml (or in the siteConfig.xml of the site you are using for the library). This format element goes at the top level of the siteConfig element.

<format>
  <paramDefault name="favouritebasket" value="off"/>  
</format>

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
• requires the mail server to be set up
• works for all users

User's mail client:

• doesn't require any mail server setup
• the email will be sent from the user's own address
• Won't work if the user has no default mail client

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.

#outgoing mail setup.
#  by default it will use port 25 on localhost. Uncomment and modify 
# these settings to use another mail server
# sample values are for gmail setup
# Note for gmail, you will need to enable account access for less secure apps
# for this to work. https://www.google.com/settings/security/lesssecureapps
#mail.smtp.host=smtp.gmail.com
#[email protected]
#mail.smtp.password=xxxpassword
# port number,  eg for gmail: 465 (ssl) 587 (tls)
#mail.smtp.port=587
#[email protected]
# set the following to ssl or tls
#mail.security=tls