Versions Compared

Old Version 10

changes.mady.by.user Former user

Saved on

compared with

New Version 11

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
width40%
Tip
titleTable of Contents
Table of Contents
indent15px
stylenone
Column
width60%
Info
titleNote: Sakai properties

All referenced Sakai properties can be set anywhere in your sakai.properties file. You do not need to set properties if you will use their default value.

If you do not have a sakai.properties file, you can create one in a folder named "sakai" in your Tomcat instance's root directory (i.e. /opt/apache-tomcat-5.5.23/sakai/sakai.properties).

1 Enabling the Citations Helper

In Sakai 2.4, the Citations Helper is disabled by default. There are two Sakai properties that can be used to control whether or not the Citations Helper is enabled and how visible it is throughout your Sakai instance:

  • citationsEnabledByDefault@org.sakaiproject.citation.api.ConfigurationService=
    • true: enables the Citations Helper across your entire Sakai instance by default. This means all users, with the proper permissions, will be able to add, revise and remove Citation Lists within the Resources of all sites. Each site's Resources tool will, however, have the option to disable Citation Lists for that particular site.
      Highlight

      TODO: link to help on how to do that...

    • false: disables the Citations Helper across your entire Sakai instance by default. This is the "out-of-the-box" setting for this property. It is still possible to enable the Citations Helper on a site by site basis - please see the following allowSiteBySiteOverride property.
  • allowSiteBySiteOverride@org.sakaiproject.citation.api.ConfigurationService=
    • true: allows individual sites to turn on the ability to work with Citation Lists within their Resources Tool.
      Highlight

      TODO: link to help on how to do that...

      This functionality is really only useful if citationsEnabledByDefault is set to false.
    • false: has no effect. This is the "out-of-the-box" setting for this property.

2 Enabling Citations Helper Features

2.1 Create Custom Citations

The ability to create custom citations by entering form data comes with the Citations Helper. If the Citations Helper is enabled within a site, users will always have at least the ability to create custom citations.

Info
titleNote: OpenURL Resolver

If you use an OpenURL resolver at your institution, you can configure the Citations Helper to use it by setting one Sakai property:

  • googleSearchEnabled@org.sakaiproject.citation.api.ConfigurationService=<base URL of OpenURL resolver>
    • The default value for this property is:
      No Format
      nopaneltrue
      http://worldcatlibraries.org/registry/gateway
      This is a freely available service offered by WorldCat that determines if the user has access to any registered OpenURL resolvers based on the user's IP address. If the user is accessing an article while at a library, for example, the library may provide OpenURL services for all patrons within the library.

2.2 Import Citations from Google Scholar

The ability to import citations from Google Scholar is controlled by the following Sakai property:

...

For Sakai 2.4, this process is not yet automated. Please contact Gaurav to register your Sakai instance for use with Google Scholar.

2.3 Search Library Resources

Searching library resources means configuring the Citations Helper to work with one or more metasearch engines. For Sakai 2.4, the Citations Helper supports the SIRSI SingleSearch and Ex Libris MetaLib metasearch engines.

...