Page Comparison

1 Turning on 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.

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

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.

3 Starting Sakai

Once the above properties have been set in your sakai.properties file, you can startup Tomcat normally. 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). The properties can be set anywhere in the file, and, if you are using the default values (false), you do not need to include the propertiesCompleting Basic Setup without completing the '2.3 Search Library Resources' section is all that is necessary to enable the Citations Helper for use without a metasearch engine.