Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Table of Contents

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

      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.

      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.

Note: 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: 
      http://worldcatlibraries.org/registry/gateway
      This is a freely available OpenURL resolver offered by WorldCat that resolves OpenURL services, if any, for a given citation based on the user's IP address.

2.2 Import Citations from Google Scholar

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

  • googleSearchEnabled@org.sakaiproject.citation.api.ConfigurationService=
    • true: enables the ability to import citations from Google Scholar.
    • false: disabled the ability to import citations from Google Scholar. This is the "out-of-the-box" setting for this property.

If you are interested in enabling import from Google Scholar, there is a simple registration process that you need to go through in addition to setting the above property to true. Google Scholar presents a link within its search results labeled, "Import to <your Sakai instance name here>." Your Sakai instance name needs to be registered along with a unique id to identify your Sakai instance (usually, this id is your Sakai instance's base URL - i.e. coursemanagement.school.edu).

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.

If your Sakai users require access to one metasearch engine, please follow the Single Instance Setup Guide to properly configure the Citations Helper for use with one metasearch engine.

If there are groups of Sakai users that require access to different metasearch engines (you are in a consortium-like setting), please follow the Multiple Instance Setup Guide to properly configure the Citations Helper for use with multiple metasearch engines.

If you do not use a metasearch engine, you can still enable the Citations Helper and take advantage of the Custom Citations and Google Scholar Import features.

  • No labels