highlight.js for WebVoyage 7 (Tomcat)

highlight.js changes for WebVoyage 7 (Tomcat)

This code can be used as-is, just copy and paste. The following is a list of what the changes to the original code will do:

It will highlight only whole words

Changes to function highlightNodes(htmlBlock, searchTerms) allow only the highlighted term and it's plural versions to be highlighted, so if your search criteria is ice, the ice in rice will not be highlighted but ices will be highlighted.
function isAlphaNumeric(str) was added to test for alphanumeric characters surrounding the search criteria. Revised on Nov 11, 2008 because Firefox will not work correctly work with the regular expression unless is is specifically declared as a RegExp object. Revised July 16, 2009 because if a word to be highlighted was the first word following <span> in record display, it was not being highlighted because isAlphaNumeric(str) was returning true for empty strings.

Prevent highlighting of certain words

Changes to function highlightResultSet(searchTerms) and highlightRecordDisplay(searchTerms) make it so certain search terms will not be highlighted. The words that will not be highlighted are defined in an array called stop_words.
To add your own stop words, look for the line var stop_words = new Array('is','to','the','for','in'); and add your own words in the same format as the existing words. (don't forget your single quotes and commas!)
function array_contains() was added to compare the search terms to the words in the array.

Highlighting quoted phrases as quoted phrases only, not as individual words.

Changes to function highlightResultSet(searchTerms) and highlightRecordDisplay(searchTerms) make it so quoted phrases, like "foreign policy", will be highlighted as phrases. In the "foreign policy" example, foreign will not be highlighted unless it is followed by policy, and policy will only be highlighted if the preceding word is foreign.

Copy and paste the code below or download the highlight script.

/*
#(c)#=====================================================================
#(c)#
#(c)#       Copyright 2007 ExLibris Group
#(c)#                      All Rights Reserved
#(c)#
#(c)#=====================================================================

**          Product : WebVoyage :: highLight js
**          Version : 7.1
**          Created : 13-MAY-2008
**      Orig Author : Mel Pemble
**    Last Modified : 16-JUL-2009
** Last Modified By : Jim Robinson
*/

/****************************************************************************************/

/* 
 * Add words to this list that are NOT to be highlighted.
 * Each word must be enclosed in single quotes
 * Words must be separated by a comma
 * There is no comma after the last word
 * Single character words will not be highlighted, so there is no need to add them to the list (a, I)
 */
var stop_words = new Array('is','to','the','for','in','and','with','from','of');

/****************************************************************************************/

/* Grab a chunk of HTML */
   var htmlChunk = document.getElementById('resultList').innerHTML;
   
   /* Loop thru the html by searchterm */
   for (var iCount = 0; iCount < searchTermsArray.length; iCount++) {
      if(searchTermsArray[iCount].length > 1 && !stop_words.array_contains(searchTermsArray[iCount])) { // only highlight words with more that 1 character
         htmlChunk = highlightNodes(htmlChunk, searchTermsArray[iCount]);
      }
   }
  
  /* reassign the innerHTML to the newly highlighted chunk */
  document.getElementById('resultList').innerHTML = htmlChunk;
  
  return true;
}

/****************************************************************************************/

function highlightRecordDisplay(searchTerms) {
   var myNodes = new Array(); 
   myNodes = _getElementsByClassName ('subfieldData');
   myNodes = myNodes.concat(_getElementsByClassName('bibTitle'));
   
   /* Separate search Terms */
   var searchTermsArray;
   // If the search criteria is a quoted phrase...
   if(searchTerms != null && searchTerms.charAt(0)=='"' && searchTerms.charAt(searchTerms.length-1)=='"') {
      searchTerms = searchTerms.replace(/"/g,''); // remove quotes
      searchTermsArray = [searchTerms]; // add the phrase to the array to be checked
   } else {
      searchTerms = searchTerms != null ? searchTerms.replace(/"/g,'') : searchTerms; // remove any quotes anyway
      searchTermsArray = searchTerms.split(" "); // break down the search words
   }

for (var arrCount = 0; arrCount < myNodes.length; arrCount++ ) {
      /* Grab a chunk of HTML */
      var htmlChunk = myNodes[arrCount].innerHTML;
   
      /* Loop thru the html by searchterm */
      for (var iCount = 0; iCount < searchTermsArray.length; iCount++) {
         if(searchTermsArray[iCount].length > 1 && !stop_words.array_contains(searchTermsArray[iCount])) { // only highlight words with more that 1 character
            htmlChunk = highlightNodes(htmlChunk, searchTermsArray[iCount]);
         }
      }
  
      /* reassign the innerHTML to the newly highlighted chunk */
      myNodes[arrCount].innerHTML = htmlChunk;
   }  
   return true;
}

/****************************************************************************************/

function sortByLength(arrayName) {
   var length = arrayName.length;

for (var i=0; i<(length-1); i++) {
      for (var j=i+1; j<length; j++) {
         if (arrayName[j].length > arrayName[i].length) {
            var temp = arrayName[i];
            arrayName[i] = arrayName[j];
            arrayName[j] = temp;
         }
      }
   }
}

/****************************************************************************************/

function parseQueryString() {
   var paramArray = new Array();
   var query = unescape(window.location.search.substring(1));
   var pairs = query.split(/\&/);
   for(var i in pairs) {
      var varName = pairs[i].split(/\=/);
      paramArray[varName[0]] = varName[1];
   }
   return paramArray;
}

/****************************************************************************************/

function isAlphaNumeric(str){
   if(str=='') return false;
   var re = new RegExp(/[^a-zA-Z0-9]/g);
   return re.test(str) ? false : true;
}

/****************************************************************************************/

// Compares search terms to a list of words we do not want highlighted.
Array.prototype.array_contains = function(searchTerm) {
   var i=this.length-1;
   if(i>=0) {
      do {
         if(this[i] === searchTerm) {
            return true;
         }
      } while(i--);
   }
   return false;
}

/****************************************************************************************/

Removed the code to highlight words for keyword searches only. It didn't work correctly after the first page of results.
Moved stop_words to the top of the script for easy access.
Made before_char a non-alphanumeric if iIndexPtr is zero. Peter MacDonald at Hamilton College pointed out that if a search term was the first word of a field in the record display, it wasn't being highlighted. Turns out that the isAlphaNumeric(str) function would return true for empty strings, which made it look like the first word was part of another word (like ice in rice), so it wouldn't get highlighted. Thanks, Peter!