Syndetics Plus Content Enrichment Adding Syndetics "Plus" code into Voyager / Tomcat

Tags:
Last Updated: Jul 21, 2010 15:36

Description
In February of 2010, Syndetics released a "Plus" version of their content enrichment product. The change resolves the previous issue with pop up windows being blocked. Important note: Voyager v.7.0.1 has a known bug in it where Syndetics book jackets (any version) will not display in Internet Explorer. As of July 2010, this page has been modified to provide instructions for Voyager v7.2.2
Author: Judy Brink-Drescher Judy Brink-Drescher
Additional author(s): Tom Pasley T.Pasley@ucol.ac.nz
Institution: Molloy College
Year: 2010
License: BSD style
Short description: Use, modification and distribution of the code are permitted provided the copyright notice, list of conditions and disclaimer appear in all related material.
Link to terms: [Detailed license terms]
Skill required for using this code: Basic - this is more or less a cut and paste exercise.

State
Programming language
Software requirements
Screen captures
Author(s) homepage
Download
Working example
Using the following Ex Libris open interfaces
Changes

Version 1.2 ....
Version 1.1 ....
...

Release notes
Installation instructions
TO DO list
Known issues
Comments

State

Stable

Programming language

Basic HTML, XSL, CSS

Software requirements

Screen captures

Author(s) homepage

http://students.molloy.edu/library1/about/jbd.asp

Download

A sample display.xsl file has been added as an attachment. When files were relocated, those comments refer to lines compared to the pristine version in exl_default. Additionally, a word doc from syndetics is attached that has the divs for bookjackets, content and hyperlinks.

Working example

http://endeavor.molloy.edu/vwebv/holdingsInfo?searchId=85&recCount=10&recPointer=0&bibId=90495

Note that by clicking on the book jacket at the record level there are "old syndetics" pop ups. This is the only way I have seen the 'similar titles' feature work.

Using the following Ex Libris open interfaces

Changes

Version 1.2 ....

Version 1.1 ....

...

Release notes

Installation instructions

Syndetics currently (as of May 2010) provides a word document (attached) that indicates there are 2 main steps - for full functionality, there are actually a few more steps than that.

1.WebVoyage Architecture Manual Chapter 20

NOTE: Because I had a prior installation, I only followed the page.properties instructions, as prior versions of instructions did not properly handle the implementation of Syndetics Plus. The following step was not required for v7.0.1, but was necessary in v7.2x in order to get the book jackets to display within the results page.

The following is the excerpt applied from the manual (page 20.2):

Syndetic Solutions Implementation
This section describes, as an example, the WebVoyáge implementation of displaying Syndetics Solutions cover images for results and holdings pages in Voyager 7.x.

NOTE:
Directory path references to xxxdb implies that you need to substitute your database path name; and where [skin] is referenced, substitute the path name that is used at your site. The default skin path provided is en_US as in the following:
/m1/voyager/xxxdb/tomcat/vwebv/context/vwebv/ui/en_US/.

pageProperties.xml
The pageProperties.xml file located in

/m1/voyager/xxxdb/tomcat/vwebv/context/vwebv/ui/SKIN/xsl/userTextConfigs/

defines how the URL to the cover image for the titles results page is built to include the pre and post-link text and the alternate name for the image.

<\!-\- each library is responsible for creating a relationship with a provider of cover images
\-->
<\!-\- these options should not be enabled by default \-->
<\!-\- <resultsCoverTag nameIdMatch="page.searchResults.item.type.isbn" linkPRE_TEXT="http:/
/images.sample.com/images/" linkPOST_TEXT=".gif" altText="Cover Image"/> \-->
<\!--resultsCoverTag nameIdMatch="page.searchResults.item.type.isbn" linkPRE_TEXT="http://
www.syndetics.com/hw7.pl?isbn=" linkPOST_TEXT="/SC.gif" altText="Cover Image"/ -

The /SC.gif is the Syndetics Solutions syntax for small cover (SC). If you prefer a medium or large cover image, use MC or LC, respectively.

2. Enabling Syndetics JavaScript Connector - modify the file /xsl/pagetools/framework.xsl. Find the ## All pages need a title ## and insert the script as indicated below.

<!-- ## All pages need a title ## -->
         <title>
            <xsl:call-template name="buildPageTitle">
               <xsl:with-param name="nameId" select="'page.title'"/>
            </xsl:call-template>
         </title>

          <script type="text/javascript" src="{$jscript-loc}ajaxUtils.js"/>

		<!-- this is the code from the Syndetics plus information -->
<script src="http://plus.syndetics.com/widget.php?id=CLIENTCODE" type="text/javascript"></script>

<noscript>This page contains enriched content visible when JavaScript is enabled.</noscript>
			<!-- end of syndetics code -->

Be sure to replace the word "clientcode" with your syndetics client code.

3. Add the covertag to display in the record - modify xml/contentlayout/config/displaycfg.xml.

<!-- Cover Tags for MARC Display - Syndetics enabled JBD

    Uncomment the <coverTags> block below to add cover graphics and title info link to the MARC display.

    Be sure to replace "ENTER_YOUR_CLIENT_ID" below with your Syndetics Client ID.
-->

<coverTags altText="Cover Image" linkPRE_TEXT="http://www.syndetics.com/hw7.pl?isbn="
linkPOST_TEXT="/MC.jpg" infoPRE_TEXT="http://syndetics.com/index.aspx?isbn="
infoPOST_TEXT="/index.html&amp;client=CLIENTCODE&amp;type=rn12"
singleInstance="true">
<displayTag field="020" indicator1="X" indicator2="X" subfield="a"/>
</coverTags>
    <displayTags label="Title:">
<!--
        <displayTag field="130" indicator1="X" indicator2="X" subfield="aplskfmnor" redirect="title" redirectOn="apl"/>

SC, MC (as shown) or LC stand for cover sizes of small medium or large

Be sure to replace the word "clientcode" with your syndetics client code.

4. Adding content info and hyperlinks to the content on your title view page. Place widget tags where you want the Syndetics content to appear and where you want the hyperlinks to appear. Add only the div tags for the features you have paid for. The Syndetics instructions attached provides a list of all tags.

Cut and paste the div tags that are applicable and paste the content into /xml/contentlayout/display/display.xsl Since there are multiple placements, the easiest thing is to view the attached display.xsl.

An example of a content tag for author notes is: <div id="syn_anotes"></div>

An example of a HYPERLINK tag for the author notes is: <div id="syn_anotes_link”></div>

This particular configuration will put the content links above the book jacket on the left hand side. By moving the code you can place it elsewhere as well e.g. into the header above the record, although placement options are somewhat limited unless you are an advanced coder.

5. If desired, edit framework.css to modify how the Syndetics content appears. In the example configuration, it was necessary to restrict the size of the links in order to place them above the book jacket on the holdings page. Additionally, the following code floats a smaller book jacket to the left in the content display at the bottom of the record, as well as highlights the content in a slightly different color and pads it a bit off from the sides.

/* sydentics */
#syn_summary_link, #syn_avsummary_link, #syn_toc_link, #syn_anotes_link, #syn_dbchapter_link, #syn_fiction_link
{
	min-width: 150px;
}

#syn_sc
{
    float: left;
    margin: 8px;
}


#syn_summary, #syn_avsummary, #syn_toc, #syn_anotes, #syn_dbchapter, #syn_fiction
{
	margin-right: 5px;
	background: #e6e6e6;
}

Labels