Peer review indicator for SFX Menu

Tags: intermediate
Last Updated: Mar 15, 2011 12:53

• Description

  Enter application description here...

  ---

• Author: Teemu Nuutinen
• Additional author(s):
• Institution: Helsinki University Library
• Year: 2011

  ---

• License: Perl License
• Short description: This program is free software; you can redistribute it and/or modify it
  under the same terms as Perl itself.
• Link to terms: Detailed license terms

  ---

• Skill required for using this code:
  intermediate

  ---

State

Stable

Programming languages

Perl, JavaScript (jQuery)

Software requirements

- SFX 4 (for SFX 3 see minor modification at the comments section)
- jQuery (working example uses v1.4.3, but any fairly recent version should do)

Screen captures

Download

l_peer.pl v0.3

Working example

http://sfx.nelliportaali.fi/sfxlcl3/L/3q4kvg

Installation instructions

This requires changes to the following Ex Libris files:

- ./config/ctx_object.config for COinS support
- banner.tmpl of SFX Menu
- sfxmenu.tmpl of SFX Menu

1. Find out the owner of your SFX instance; e.g. view a local target and then click Additional details, see Owner field. It should look something like r.consortium-name.instance-name.
2. Download the l_peer.pl script and change the owner value in the following line:
3. Copy the modified script to ./cgi/public/l_peer.pl
4. Activate COinS for the SFX Menu (this provides the object id):

   $ cn
   $ vi ctx_object.config
   # find the line with include_coins
   # set the value to "Y" if it's "N"
   

   You should also check that the SFX Menu templates have the COinS-element (for further information see SFX manuals).

5. Edit ./templates/sfxmenu/banner.tmpl with advanced menu or ./templates/simplified_template1/banner.tmpl with simplified template/menu and add a span-element with id="l_peer" e.g. after the ISSN-number:
   
   (remember to add this for both BANNER_TYPE_1 and BANNER_TYPE_2!).
6. Download jQuery to a web-accessible directory of your choice, e.g. ./templates/js/MyDirectory/jquery.js (you can of course optionally use another online source for it).
7. Edit sfxmenu.tmpl and add the jquery-script to the head-element, e.g.
8. Continue to edit sfxmenu.tmpl and add the following after the above script-element:
9. Test it using a peer reviewed (according to SFX KB) journal like Nature!

Known issues

• The owner must be found out manually.

Comments

Using the RSI API for this would be ideal instead of going through the above ordeal - unfortunately it always requires year-information. Better yet, there should be a built-in template variable for this precious information - why keep it hidden in the KB?

If you are still using SFX 3 and want to implement this, you don't need the owner value and you must replace the following

with