#Instructions for Creating Searchbar entries for Mozilla and Firefox web browsers.
#Adapted from work by Thomas Dowling, OhioLINK

#This is a process of adding a search plugin for your INNOPAC/Millennium Catalog
#into Mozilla or Firefox Broswers.
#For more information, go to: http://mycroft.mozdev.org/deepdocs/quickstart.html

#Steps to complete to get the plugins working in Firefox.
#
#1. Create Web Directory for files that patrons will download onto their machine.
#2. Create icon file.   
#3. Create parameters (.src) file.  
#4. Create Webpage with Javascript downloads to allow patrons to install these files.
#

#1. Create Web Directory for files that patrons will download onto their machine.
#It might be best to have this on a basic web server and not your INNOPAC/Millennium
#System.  
#For the University of Toledo, we created http://library.utoledo.edu/downloads/plugin/

#2. Create icon file.
#The icon needs to be small (16x16 pixels).  It can be a GIF, JPEG or PNG file.

#3. Create parameters (.src) file.  
#OVERVIEW
#The .src file is how Mozilla or Firefox knows where to send the search.  As I learn more
#I will update this section.
#This file can be created and edited in Notepad or another text editor.  It must be saved with
#a .src file extention.  I am not sure that this is required, but it makes sense that the icon 
#file (#2 above) and the .src file have the same name.  
#During the install, it gets placed in the \searchplugins\ directory of the program.
#On my computer, that is C:\Program Files\Mozilla Firefox\searchplugins
#You can manually delete files here to remove plugins after they are added.

#FULL EXAMPLE
#-----------Full Example---------

<search
 version="7.1"
 name="UTMOST Catalog"
 description="UTMOST Library Catalog" 
 action="http://utmost.cl.utoledo.edu/search/X?"
 searchForm="http://utmost.cl.utoledo.edu"
 method="GET" >

<input name="searchtype" value="X">
<input name="searcharg" user="">
<input name="SORT" value="D">

<interpret
 resultListStart='class="browseEntry"'
 resultListEnd='</tr>'
 resultItemStart='class="browseEntryData"'
 resultItemEnd='</td>'
>
</search>

<browser
 update="http://library.utoledo.edu/downloads/plugins/utmost.src" 
 updateIcon="http://library.utoledo.edu/downloads/plugins/utmost.gif" 
 updateCheckDays="14" 
>

#----------End Example---------------

#SECTIONS EXPLAINED (as best as I can)
#SEARCH
<search
 version="7.1"
 name="UTMOST Catalog"
 description="UTMOST Library Catalog" 
 action="http://utmost.cl.utoledo.edu/search/~"
 searchForm="http://utmost.cl.utoledo.edu"
 method="GET">

#The Search settings is where you put the URL and other information for your 
#INNOPAC/Millennium Server
#name is what appears in the Searchbar. Keep this brief
#action is for the URL of your INNOPAC/Millennium followed by "/search/~"
#search if for the URL of your INNOPAC/Millennium

#INPUT
<input name="searchtype" value="X">
<input name="searcharg" user="">
<input name="SORT" value="D">

#This is where you put the information on the type of search
#The Index tag goes in the top line.  
#The value "X" is for Advanced Keyword Search.
#The SORT Value of "D" is for date (newest material sorts first)
#You can add or subtract data here as needed.
#If you want, you can setup different .src files/icons for different
#searches in the same database by adding values here

#INTERPRET
<interpret
 resultListStart='class="browseEntry"'
 resultListEnd='</tr>'
 resultItemStart='class="browseEntryData"'
 resultItemEnd='</td>'
>
</search>

#I will try to developed this code in time.  This is primarily used by 
#Mozilla when creating the search sidebar.  Right now, what this is ideally supposed
#to do is to give value and meaning to the PREVIOUS and NEXT buttons in the sidebar to 
#Move through the result set.  This does not have an impact (I think) for Firefox.

#BROWSER
<browser
 update="http://library.utoledo.edu/downloads/plugin/utmost.src" 
 updateIcon="http://library.utoledo.edu/downloads/plugin/utmost.gif" 
 updateCheckDays="14" 
>

#This is where you can put the URL for the .src and icon file for self-updating
#as the files change and are updated.  This way, if something changes or improves 
#over time, the patron does not need to return to the download page.
#Inlcude the links to the .src file, icon file, and how many days should it check
#for updates.

#4. Create Webpage with Javascript downloads to allow patrons to install these files

#This is the full file.
#It can be found at http://library.utoledo.edu/downloads/plugin/ut.html

#There is little that you need to change. The webpage installs the plugin files 
#to the correct directory on the computer.  To ensure that it installs properly, change 
#the URLs in the Javascript section starting "function addEngine(name,cat)".  This needs
#to point to your web directory for storing the icons and .src files.  If you use JPEG or
#PNG files, then change the last part of this line:
#"http://library.utoledo.edu/downloads/plugin/"+name+".gif"

#For the plugins, enter this Javascript code for each plugin offered:
#<p>Install the <a
  href="javascript:addEngine('utmost','utmost')">UTMOST Catalog Search Plugin</a></p>
#Giving the .src and icon file the same name will make this easier to maintain.

#-----------Full Example---------
<html>
<head>
<title>Mozilla Plugin</title>
<link rel=stylesheet href="http://www.cl.utoledo.edu/style/webpac.css"
  type="text/css">
<script type="text/javascript">
<!--

function errorMsg() {
  alert("This plugin requires Mozilla, Firefox, Netscape 6+ or another Mozilla-based browser.");
}

function addEngine(name,cat) {
  //alert("-|"+name+"|- -|"+cat+"|-");
  if ((typeof window.sidebar == "object") &&
    (typeof window.sidebar.addSearchEngine == "function")) {
    window.sidebar.addSearchEngine(
      "http://library.utoledo.edu/downloads/plugin/"+name+".src",
      "http://library.utoledo.edu/downloads/plugin/"+name+".gif",
      name,
      cat);
  } else {
    errorMsg();
  }
}
//-->
</script>
 
</head>
<body bgcolor="#FFFFFF">

<h2>Mozilla/Firefox Search Plugins&nbsp;</h2>

<h2>University of Toledo Library Catalog (Innovative Interfaces, Inc.)</h2>

<p>Install the <a
  href="javascript:addEngine('utmost','utmost')">UTMOST Catalog Search Plugin</a></p>


<p>Install the <a
  href="javascript:addEngine('ol-catalog-plugin','ol-catalog-plugin')">OhioLINK Central Catalog Search Plugin</a></p>

</body>
</html>
#FULL EXAMPLE
#-----------End Example---------

##Written by Corey Seeman, University of Toledo, December 8, 2004
##corey.seeman@utoledo.edu