// -------------------------------------------------------------------- //
// Website: Marlowe Society
// Author: Mark Abbott
// Filename: msartidx.js
// Filetype: Javascript
// Date: 12 Oct 2009
// Version: 3
// -------------------------------------------------------------------- //
// -------------------------------------------------------------------- //
// ** EXCEPTION HANDLING ** //
// -------------------------------------------------------------------- //
var MSX_BASE = 900;
var MSX_XMLLOADFAIL = MSX_BASE + 1;
var MSX_NONXMLBROWSER = MSX_BASE + 2;
var MSX_MSG_NOCATSORTING = "The Library Catalogue cannot be processed on this browser using the 'Sort Books By:' selection criteria above, or the alphabetic filtering buttons on the left. Instead the entire catalogue is displayed below, sorted alphabetically by Author.";
function writeWarningPara (warningText) {
document.write ("
" + warningText + "
");
}
// Create an object type MarSocException
function MarSocException (id, message, descr)
{
// Message is directed at user, description at debugging
this.number=id;
this.message=message;
this.description=descr;
this.name="MarSocException";
}
// Make the exception convert to a pretty string for display to user on the browser.
MarSocException.prototype.toString = function ()
{
return '
' + this.message + '
';
}
// Make the exception convert to a pretty string for display to user on the browser.
function WriteFullMarSocException (e)
{
document.write ('' + e.name + '[' + e.number + ']' + ': ' + e.description + ' User Msg: "' + e.message + '"');
}
function writeBrowserDetails () {
document.write ("
");
// return currently selected letter
return (ltr);
}
//----------------//
// Draw a list of list letter button links with currently selected button disabled
function drawFullLetterLinks (selectedChar, fldQueryTxt) {
// The alphabetic letter links are laid out as an unordered list:
//
');
// Then all the remaining letters
var letter = "a";
var letterCode = 0;
for (letterCode="a".charCodeAt(0); letterCode<="z".charCodeAt(0); letterCode++) {
letter = String.fromCharCode(letterCode);
document.write ('
');
}
function drawLetterLinks (selectedChar) {
// Draw letter links without any field query e.g. for article index
drawFullLetterLinks (selectedChar, NULLFLDQUERYTXT);
}
//----------------//
// ** XML LIBRARY CATALOGUE LOAD, XSLT TRANSFORM AND DISPLAY ** //
// Catalogue data and transformation documents in the cat sub-folder //
var relLibCatPath = "./cat/"
var fullLibCatPath = "http://www.marlowe-society.org/marsoclib/cat/"
var locaLibCatPath = "C:/Abbo/webprojects/marsoc/marlowesociety/marsoclib/"
var libCatPath = relLibCatPath;
var htmlLibCatFile = "mslibcattable.html";
var fullLibCatHtmlPage = "msfullcatalog.html";
var xmlLibCatDoc = "mslibcatalog.xml";
var xslLibCatDoc = "catalogtoweblist.xsl";
var htmlLibCatURL = locaLibCatPath + htmlLibCatFile;
var xmlLibCatURL = libCatPath + xmlLibCatDoc;
var xslLibCatURL = libCatPath + xslLibCatDoc;
// **** Function to load, transform and render data in an XML document
function loadXmlDocAndTransform (xmlURL, xslURL, p1name, p1value, p2name, p2value) {
var xmlDoc;
var xslDoc;
var xslt;
var xslProc;
var xmlBrowser = true;
// Create the XML and XSLT document objects
// For IE browsers use Msxml2 - not supporting old IE5 XMLDOM
if (window.ActiveXObject) {
xmlDoc = new ActiveXObject("Msxml2.DomDocument");
xslDoc = new ActiveXObject("Msxml2.FreeThreadedDOMDocument");
}
// For Mozilla based (standards compliant) browsers, including Opera:
else if (document.implementation && document.implementation.createDocument) {
xmlDoc = document.implementation.createDocument("","doc",null);
xslDoc = document.implementation.createDocument("","doc",null);
}
else {
xmlBrowser = false;
}
if (xmlBrowser) {
// Load XML document
xmlDoc.async = false;
xmlDoc.resolveExternals = false;
try {
xmlDoc.load(xmlURL);
}
catch(e) {
throw new MarSocException(MSX_XMLLOADFAIL, MSX_MSG_NOCATSORTING, "Loading the Library Catalogue XML document at " + xmlURL + " failed. Either it could not be loaded or it failed to validate as XML.");
}
// Load XLST document
xslDoc.async = false;
xslDoc.resolveExternals = false;
try {
xslDoc.load(xslURL);
}
catch(e) {
throw new MarSocException(MSX_XMLLOADFAIL, MSX_MSG_NOCATSORTING, "Loading the Library Catalogue XSLT document at " + xslURL + " failed. Either it could not be loaded or it failed to validate as XML.");
}
// For IE browsers use Msxml2 - not supporting old IE5 XMLDOM
if (window.ActiveXObject) {
xslt = new ActiveXObject("Msxml2.XSLTemplate");
xslt.stylesheet = xslDoc;
// Set up XSLT Processor to process input XML document
xslProc = xslt.createProcessor();
xslProc.input = xmlDoc;
// Add two supplied XLS parameters:
xslProc.addParameter(p1name, p1value);
xslProc.addParameter(p2name, p2value);
// Transform XML document into HTML table using XLST
xslProc.transform();
// Render resulting HTML fragment
//document.write(xslProc.output);
var catalogelt = document.getElementById("libcatalogpanel");
catalogelt.innerHTML = xslProc.output;
}
// For Mozilla based (standards compliant) browsers:
else if (document.implementation && document.implementation.createDocument) {
// Set up XLST processor to process input XML document
xsltProc = new XSLTProcessor();
xsltProc.importStylesheet(xslDoc);
// Add two supplied XLS parameters:
xsltProc.setParameter(null, p1name, p1value);
xsltProc.setParameter(null, p2name, p2value);
// Transform XML document into HTML table using XLST
var frag = xsltProc.transformToFragment(xmlDoc, document);
// Render resulting HTML fragment
var serializer = new XMLSerializer();
xsltOutputDoc = serializer.serializeToString(frag);
//document.write(xsltOutputDoc);
var catalogelt = document.getElementById("libcatalogpanel");
catalogelt.innerHTML = xsltOutputDoc;
}
}
else {
// Browser does not support the required XML processing
//document.write("
Unable to display XML output using this browser.
");
throw new MarSocException(MSX_NONXMLBROWSER, MSX_MSG_NOCATSORTING, "Browser does not support XSLT transformations of XML to form HTML elements: UserAgent:" + navigator.userAgent + " Vendor:" + navigator.vendor + " App Name:" + navigator.appName + " Version:" + navigator.appVersion);
// Other debug values of potential interest:
//document.write("[window.ActiveXObject="+window.ActiveXObject+"] ");
//document.write("[typeof XSLTProcessor = " + typeof XSLTProcessor + "] ");
//document.write("[document.implementation="+document.implementation+"] ");
//document.write("[document.implementation.createDocument=" + document.implementation.createDocument+"] ");
//document.write("[document.implementation.hasFeature=" + document.implementation.hasFeature+"] ");
}
}
function genFileIECatTableHtmlFromXml (xmlURL, xslURL, p1name, p1value, p2name, p2value, outfilename) {
// This writes HTML output to file.
// Must be run in IE6 or later.
var xmlDoc;
var xslDoc;
var xslt;
var xslProc;
// Create the XML and XSLT document objects
xmlDoc = new ActiveXObject("Msxml2.DomDocument");
xslDoc = new ActiveXObject("Msxml2.FreeThreadedDOMDocument");
// Load XML document
xmlDoc.async = false;
xmlDoc.resolveExternals = false;
xmlDoc.load(xmlURL);
// Load XLST document
xslDoc.async = false;
xslDoc.resolveExternals = false;
xslDoc.load(xslURL);
xslt = new ActiveXObject("Msxml2.XSLTemplate");
xslt.stylesheet = xslDoc;
// Set up XSLT Processor to process input XML document
xslProc = xslt.createProcessor();
xslProc.input = xmlDoc;
// Add two supplied XLS parameters:
xslProc.addParameter(p1name, p1value);
xslProc.addParameter(p2name, p2value);
// Transform XML document into HTML table using XLST
xslProc.transform();
// Write HTML fragment to output file
var fout = new ActiveXObject("Scripting.FileSystemObject");
var file = fout.CreateTextFile(outfilename,1);
file.write(xslProc.output);
file.close();
}
function LoadCatalogFromIframe (introText) {
// This routine displays the HTML table (stored in the HTML snippet file)
// defining the full MarSoc Library Catalogue, sorted alphabetically be author.
// The HTML snippet file is created locally (as part of development) using
// mslib_gencattablefile.html which calls genFullLibCatalogueFromXml, which
// calls genFileIECatTableHtmlFromXml to generate the HTML data.
// To enable this to work in as many browsers as possible, this function
// accesses the HTML contents of the file via a somewhat circuitous route:
// - a hidden iFrame (id=libcatalogiframe) is used to load the contents of
// the file which contains the HTML snippet into the document,
// - DOM methods are then used to extract the HTML table element,
// - and copy it to the libcatalogpanel DIV for display
// Simply opening a file to read the contents has all sorts of browser
// compatibility problems which makes such an approach unusable.
//
// This function can thus be used when it is not possible to process the XML with
// XSLT (e.g. Safari browser does not support), or an error is encountered
// (e.g an exception is raised in Opera trying to load the XML file).
// This function thus provides an alternative method for at least displaying
// the full catalogue, albeit without the sort/filter facilities.
// Prefix catalog table with intro para. This is a warning since we only do
// this if we haven't been able to do the XML/XSLT stuff.
var introPara = "";
if (introText != "") introPara = "
" + introText + "
";
// Extract the HTML table element from the hidden iFrame:
// 1. Identify the hidden iFrame element object in the document
var catFrame = document.getElementById('libcatalogiframe');
// 2. Extract the contents of this object into a document, taking
// account of whether we are IE (contentWindow) or other (contentDocument)
var catDocObj = (catFrame.contentWindow || catFrame.contentDocument);
// 3. And this for Safari...
if (catDocObj.document) catDocObj = catDocObj.document;
var catTableEltByTagName = catDocObj.getElementsByTagName("tr");
// 4. Extract table (id=catalogtable) from iframe doc - parentNode means
// we include the table tag as well as inner nodes
var catTableElt = catDocObj.getElementById("catalogtable").parentNode;
// 5. Identify the libcatalogpanel DIV where we want to display catalog
var catalogelt = document.getElementById("libcatalogpanel");
// 6. Copy across HTML table element containing catalog data
catalogelt.innerHTML = introPara + catTableElt.innerHTML;
}
function redirectToFullCat () {
window.location = fullLibCatHtmlPage;
}
function drawFullCatByAuthorHtml (introText) {
try {
LoadCatalogFromIframe (introText);
}
catch (e) {
// We have failed to load the HTML via the iFrame.
// Note this seems to happen in Safari as iFrame will not load until all
// javascript has executed. Can't seem to resolve at the moment.
// As a last resort, just redirect to the simple full catalogue page.
redirectToFullCat();
}
}
function drawLibCatalogueFromXml () {
// Set up parameters for XSLT
// 1. Selected Letter (when 'all', set to empty string to retrieve all records)
// 2. Selected Field
var selectedLtr = gblCatCurrQueryLtr;
if (selectedLtr==ALLLETTERSCHAR) selectedLtr = XLSTSEARCHALLPARAM;
// Pass in the FieldValue string rather than index
var selectedFldValue = catSrchFieldOptions[gblCatCurrQueryFld];
// Call function to load, transform and render XML with specific
// XML, XSL and XSL parameters' names and values for Library Catalogue data
try
{
// Opera just seems to hang: redirect until can resolve
if (is_opera) {
redirectToFullCat();
}
else {
loadXmlDocAndTransform (xmlLibCatURL, xslLibCatURL, "ltrfilter", selectedLtr, "fieldfilter", selectedFldValue);
}
}
catch(e)
{
// An error has occurred trying to load / tranform XML catalogue
// Warn user that cannot use search criteria and just draw full table as plain HTML
// document.write ("
" + e.toString() + "
");
// Debug: WriteFullMarSocException (e);
//drawFullCatByAuthorHtml (e.toString());
// In fact, just redirect to full catalogue list page
redirectToFullCat();
}
}
// ** Version to generate full alternate HTML table catalog in output file for noscript case etc ** //
// ** CAN ONLY BE RUN LOCALLY TO GENERATE FILE ** //
// Instructions:
// 1. Open mslib_gencattablefile.html locally in IE browser
// 2. Confirm that ActiveXControl can run to create local file
// 3. Any errors will be reported in browser window, otherwise:
// 4. Creates HTML source in:
// C:/Abbo/webprojects/marsoc/marlowesociety/marsoclib/mslibcattable.html
// As a test that file is then opened and contents displayed on the gen broser
// page via a call to drawFullCatByAuthorHtml.
// 5. Tidy up the raw source text as follows:
// - Globally replace ' with '
// - Repeat for Word's curly apostrophes
// - Replace with (these get in even though XSLT specifies !!!
// 6. This source file should be uploaded to website as it is potentially accessed by
// drawFullCatByAuthorHtml when browser does not support XML/XSLT processing.
// 7. Cut any paste the HTML source to MsLibCatFullTable.lbi
function genFullLibCatalogueFromXml () {
var selectedLtr = XLSTSEARCHALLPARAM;
var selectedFldValue = catSrchFieldOptions[DEFAULTCATSEARCHTYPE];
document.write ("
Writing HTML Library catalogue table to: " + htmlLibCatURL + "...
");
WriteFullMarSocException (e);
}
}
//----------------//
// **** Catalogue Search Selection **** //
// Catalogue Index: Field to order on //
var CATSEARCHBYCATNO = 0;
var CATSEARCHBYTITLE = 1;
var CATSEARCHBYAUTHOR = 2;
//var CATSEARCHBYISBN = 2;
var CATSEARCHBYPUBLISHER = 3;
var CATSEARCHBYPUBDATE = 4;
var CATSEARCHBYDONOR = 5;
var CATSEARCHBYKEYWORD = 6;
var DEFAULTCATSEARCHTYPE = CATSEARCHBYAUTHOR;
var firstCatSrchTy = CATSEARCHBYCATNO;
var lastCatSrchTy = CATSEARCHBYKEYWORD;
var catSrchFieldOptions = new Array("Catalogue No", "Title", "Author", "Publisher", "Publication Date", "Donor", "Keyword");
// Global variables holding current selections for Library Catalogue
var gblCatCurrQueryLtr = "";
var gblCatCurrQueryFld = DEFAULTCATSEARCHTYPE;
function drawLibCatalogLetterLinks () {
// Draw letter links with current field query appended
var fldQuery = "&" + fldQueryName + "=" + gblCatCurrQueryFld;
drawFullLetterLinks (gblCatCurrQueryLtr, fldQuery);
}
function drawCatalogSearchTypeSelect () {
// Draw the drop-down menu with current Field type initially selected
document.write('');
// Draw the Go button, which triggers refreshCatalogPage if clicked
document.write ('');
drawLibCatHelpButton();
}
function drawLibCatHelpButton () {
document.write ('');
}
function getSelectedCatSearchFieldIdx () {
// Following shows how to get selected menu option index and text
//var selIdx = document.catSearchCritForm.catSearchType.selectedIndex;
//var selVal = document.catSearchCritForm.catSearchType.options[selIdx].value;
return (document.catSearchCritForm.catSearchType.selectedIndex);
}
// NOT needed so far
// function getCatSearchFieldIdxFromValue (fldValue) {
// var srchFieldIdx = DEFAULTCATSEARCHTYPE;
// // Search for supplied Field string and return index
// for (i=firstCatSrchTy; i<=lastCatSrchTy; i++) {
// if (fldValue==catSrchFieldOptions[i]) srchFieldIdx=i;
// }
// return (srchFieldIdx);
// }
function refreshCatalogPage () {
// Get index of newly selected field
gblCatCurrQueryFld = getSelectedCatSearchFieldIdx ();
// Handle selected letter = all
var selectedLtr = gblCatCurrQueryLtr;
if (selectedLtr==ALLLETTERSCHAR) selectedLtr=ALLLTRSQUERYVALUE;
// Construct new URL using current letter and newly selected field
var coreURL = "" + getCoreURL(location.href);
var newURL = coreURL + "?" + ltrQueryName + "=" + selectedLtr +
"&" + fldQueryName + "=" + gblCatCurrQueryFld;
// Display the page applying new selection
window.location.href = newURL;
}
//----------------//
function titleSortFn(a,b) {
// This function enables the sort to execute on the title column of the array
// Note that each thing we are passed is an array, so we don't compare the things
// we're passed; instead, we compare their second column
if (a[aidxTitle]b[aidxTitle]) return 1;
return 0;
}
function keywordSortFn(a,b) {
// This function enables the sort to execute on the title column of the array
// Note that each thing we are passed is an array, so we don't compare the things
// we're passed; instead, we compare their second column
if (a[aidxKeyWds]b[aidxKeyWds]) return 1;
if ((a[aidxKeyWds]==b[aidxKeyWds]) && (a[aidxPubNo]b[aidxPubNo])) return 1;
return 0;
}
//----------------//
function searchMatch (article, selectedLetter, searchType) {
var stringToMatch = "";
var firstLtr = 'A';
var lcSelLtr = selectedLetter.charAt(0).toLowerCase();
var idxKey;
var matchKey = NOTMATCHED;
var finished = false;
if (searchType==SEARCHBYTITLE) {
stringToMatch=article[aidxTitle];
firstLtr = stringToMatch.charAt(0).toLowerCase();
if (firstLtr==lcSelLtr) {
// For a title match, just display the first key word
matchKey=0;
}
}
if (searchType==SEARCHBYKEYWORD) {
idxKey=0;
while (!finished) {
if (article[aidxKeyWds][idxKey]==NULLKEYWORD) {
finished=true;
}
else {
stringToMatch=article[aidxKeyWds][idxKey];
firstLtr = stringToMatch.charAt(0).toLowerCase();
if (firstLtr==lcSelLtr) {
matchKey=idxKey;
// Only search for first matching key word
finished=true;
}
else {
idxKey++;
finished=(idxKey==MAXNUMKEYWORDS);
}
}
}
}
return (matchKey);
}
function findNextArtKeyword (article, startIdxKey, selectedLetter) {
var stringToMatch = "";
var firstLtr = 'A';
var lcSelLtr = selectedLetter.charAt(0).toLowerCase();
var idxKey = startIdxKey;
var matchKey = NOTMATCHED;
var finished = (startIdxKey>=MAXNUMKEYWORDS);
// Search for next Keyword in Article starting with same Letter
while (!finished) {
if (article[aidxKeyWds][idxKey]==NULLKEYWORD) {
finished=true;
}
else {
stringToMatch=article[aidxKeyWds][idxKey];
firstLtr = stringToMatch.charAt(0).toLowerCase();
if (firstLtr==lcSelLtr) {
matchKey=idxKey;
// Only searching for next matching key word
finished=true;
}
else {
idxKey++;
finished=(idxKey==MAXNUMKEYWORDS);
}
}
}
return (matchKey);
}
function addArticleToList (d, a, k) {
numSelectedArticles++;
selectedArticles[numSelectedArticles-1] = new Array (msArtDb[d][a][aidxPubType], msArtDb[d][a][aidxPubNo], msArtDb[d][a][aidxPgNo], msArtDb[d][a][aidxTitle], msArtDb[d][a][aidxAuthor], msArtDb[d][a][aidxKeyWds][k]);
}
function retrieveArticleList (selectedLetter, searchType) {
var doc=0;
var art=0;
var readallarticles = false;
var idxKey, nextIdxKey;
var firstLtr, lastLtr, ltr;
numSelectedArticles=0;
if (selectedLetter==ALLLETTERSCHAR) {
firstLtr = "a";
lastLtr = "z";
}
else {
firstLtr = selectedLetter;
lastLtr = selectedLetter;
}
var letterCode = 0;
for (letterCode=firstLtr.charCodeAt(0); letterCode<=lastLtr.charCodeAt(0); letterCode++) {
ltr = String.fromCharCode(letterCode);
// Search through all pub articles for items beginning with this letter
for (doc=0; doc');
document.write(startTagChar[articleOutputMode]+'td class="colkeyword">' + article[aidxKeyWds].toUpperCase() + startTagChar[articleOutputMode] + '/td>');
document.write(startTagChar[articleOutputMode]+'td class="coltitle">' + article[aidxTitle] + startTagChar[articleOutputMode] + '/td>');
document.write(startTagChar[articleOutputMode]+'td class="colauthor">' + article[aidxAuthor] + startTagChar[articleOutputMode] + '/td>');
// The issue details provide a link to the relevant publication's contents list
document.write(startTagChar[articleOutputMode]+'td class="colissue">');
document.write(startTagChar[articleOutputMode]+'a href="' + relHomeLink + '/pubs/' + pubSubDirString[article[aidxPubType]] + '/');
document.write(pubFilenameString[article[aidxPubType]] + genPubNumString(article[aidxPubNo]) + '.html">');
document.write(pubString[article[aidxPubType]] + ' ' + article[aidxPubNo] + startTagChar[articleOutputMode] + '/a>');
document.write(startTagChar[articleOutputMode]+'/td>');
document.write(startTagChar[articleOutputMode]+'td class="colpage">' + article[aidxPgNo] + startTagChar[articleOutputMode] + '/td>');
document.writeln(startTagChar[articleOutputMode]+'/tr>');
}
//----------------//
function writeSelectedArticleList (selectedLetter, searchType) {
var art = 0;
var srchResultsSummaryStr = 'Articles Found [' + numSelectedArticles + ']: ' +
srchTypeText[searchType] + ' beginning with {' + selectedLetter.charAt(0).toUpperCase() + '}';
if (numSelectedArticles>0) {
// List the retrieved articles in a table
document.write(startTagChar[articleOutputMode]+'table id="catalogtable" cellspacing="0" summary="Index of Articles: ');
document.write(srchTypeText[searchType]+' ');
document.writeln('beginning with ' + selectedLetter.charAt(0).toUpperCase() + '">');
// Table caption summarises results of search
document.write(startTagChar[articleOutputMode]+'caption>' + srchResultsSummaryStr + startTagChar[articleOutputMode]+'/caption>');
// Write table column headings
document.write(startTagChar[articleOutputMode]+'tr>');
document.write(startTagChar[articleOutputMode]+'th class="colkeyword" scope="col">Key Word'+startTagChar[articleOutputMode]+'/th>');
document.write(startTagChar[articleOutputMode]+'th class="coltitle" scope="col">Article Title'+startTagChar[articleOutputMode]+'/th>');
document.write(startTagChar[articleOutputMode]+'th class="colauthor" scope="col">Author'+startTagChar[articleOutputMode]+'/th>');
document.write(startTagChar[articleOutputMode]+'th class="colissue" scope="col">Issue'+startTagChar[articleOutputMode]+'/th>');
document.write(startTagChar[articleOutputMode]+'th class="colpage" scope="col">Pg'+startTagChar[articleOutputMode]+'/th>');
document.writeln(startTagChar[articleOutputMode]+'/tr>');
// Write details of each matching article
for (art=0; art');
}
else {
// Report no articles found
document.write('