Sunteți pe pagina 1din 155

Unicorn WorkFlows Training Guide

Fundamentals of iBistro/iLink
Customization
(Version GL3.0)

DOC-FDMTGEN-U
Publication Name: Fundamentals of iBistro/iLink Customization
Publication Number: DOC-FDMTGEN-U
Version Number: GL3.0
First Printing: May 2002
Last Updated: March 2006

Additional copies of this document can be downloaded from the Client Care section of the SirsiDynix Web
site at www.sirsidynix.com.

© 2006 SirsiDynix. All Rights Reserved.

The processes and all the routines contained herein are the proprietary properties and trade secrets of
SirsiDynix. Except as provided by license agreement, this manual shall not be duplicated, used or disclosed
for any purpose or reason, in whole or in part, without the express written consent of SirsiDynix. The
information in this document is subject to change without notice and should not be construed as a
commitment by SirsiDynix.

Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in sub-
paragraph (b)(3) of the Rights in Technical Data and Computer Software clause in DFARS 252.227-7013.

Rights for non-DOD U.S. Government departments and Agencies are as set forth in FAR 52.227-19(c)(1,2).

Sirsi®, WebCat®, Vizion®, WorkFlows®, Unicorn®, UnicornECOLE®, UnicornOASIS®, UnicornSTILAS®,


Site Source®, DRA®, DRA Net®, Inlex®, MultiLIS®. Taos®, JurisLink™, Corinthian®, Dynix®, URSA®,
Horizon™, Remote Patron Authentication™, and TeleCirc™ are trademarks of SirsiDynix.

Other product and company names herein may be the trademarks of their respective owners. All titles,
versions, trademarks, claims of compatibility, etc., of hardware and software products mentioned herein are
the sole property and responsibility of the respective vendors. SirsiDynix makes no endorsement of any
particular product for any purpose, nor claims responsibility for its operation and accuracy.
Table of Contents
Introduction ...................................................................................... 1
Training Overview ...........................................................................................1
Who should attend?................................................................................................................. 1
Prerequisites............................................................................................................................ 1
Course Goals........................................................................................................................... 1
Introduction......................................................................................................2
Webservers and iBistro/iLink .........................................................................3
OPAC Configuration......................................................................... 5
Overview...........................................................................................................5
Gateways and Gateway Elements ..................................................................5
Gateway................................................................................................................................... 5
Gateway Elements................................................................................................................... 7
Turn Off a Delivered Gateway Element................................................................................. 16
WWW Destination Elements .........................................................................19
Catalog Access Destination Elements.........................................................24
Destination Tab Attributes ..................................................................................................... 28
Search Field Tab Attributes ................................................................................................... 31

Book Lists ....................................................................................... 33


Overview.........................................................................................................33
Creating Book Lists.......................................................................................33
Create the Information Desk Policy ....................................................................................... 33
Assign the Bibliographic Records to the Book List................................................................ 38
Using Reports with Book Lists.....................................................................42
More Information Desk Reports............................................................................................. 60
Have You Read ..............................................................................................61
Activating “Have You Read” .................................................................................................. 61
Best Sellers and Recommended Reading Lists..........................................65
Best Sellers List Configuration Wizard .................................................................................. 65
Recommended Reading Configuration Wizard ..................................................................... 68
Reports .................................................................................................................................. 68

iBistro/iLink Configuration ............................................................ 70


Unicorn User Environment ...........................................................................70
User Profile ............................................................................................................................ 71
Environment Attribute ............................................................................................................ 72
Gateway................................................................................................................................. 73
webconfig.......................................................................................................74
Overview................................................................................................................................ 74
LOGIN|1|WEBSERVER||....................................................................................................... 74

Version 3.0, March 2006 i


Fundamentals of iBistro/iLink Customization

CGIOPAC_TIMEOUT|180| .................................................................................................... 75
UNICORN_TYPE|2|............................................................................................................... 75
Environment Files..........................................................................................76
System-Wide Environment Files ........................................................................................... 76
Environment Files – Working with Fonts and Color .............................................................. 77
Environment Files: Working with search defaults, view options, and use flags ................... 81
Specific Environment Files...........................................................................84
envn#.env .............................................................................................................................. 84
List Policies Report ................................................................................................................ 84
iBistro/iLink Test Environment.....................................................................85
Create a New Gateway Policy............................................................................................... 85
Create New User Profile and Environment Policies .............................................................. 88
Create a New Environment File............................................................................................. 92
Create a New User Login ...................................................................................................... 95
Automate the Login Process with a New URL ...................................................................... 98
iBistro/iLink Image Files ...............................................................................99
Delivered Image Files ............................................................................................................ 99
Directory Structure............................................................................................................... 100
Environment Files – Working with Images .......................................................................... 101
Putting Images on the Webserver ....................................................................................... 103
Manually Copying Images to the Webserver....................................................................... 104
Labels and Messages..................................................................................108
Appendix A – ibistro.env ............................................................. 114
Appendix B – link.env .................................................................. 144
Appendix C – vi Quick Reference .............................................. 146
Index .............................................................................................. 150

ii Version 3.0, March 2006


Introduction
Training Overview
This course teaches you how to configure iBistro/iLink. Topics
include the OPAC Manager, iBistro/iLink file structure, image
and environment files, and labels.
Using specially developed Unicorn files that interact with your
library's information resources and external databases, you can
customize the appearance of your iBistro/iLink interface and the
resources available for users.

Who should attend?


Library staff responsible for iBistro/iLink administration

Prerequisites
Essential Skills for WorkFlows and iBistro/iLink - This
course teaches basic skills including navigating WorkFlows and
iBistro/iLink, searching techniques, changing toolbars, keyboard
navigation, and using the Help file.

Course Goals
After completing this course, you will be able to:
• Create additional gateway elements
• Create book lists
• Configure different environment files to customize
iBistro/iLink for different users
• Create a test user environment
• Work with custom images
• Work with labels and messages
• Understand the iBistro/iLink directory structure

Version 3.0, March 2006 1


Fundamentals of iBistro/iLink Customization

Introduction
There is no difference between iBistro, iLink, and
UnicornECOLE iBistro in terms of architecture or means of
customization. The only differences have to do with style and the
type of content SirsiDynix delivers for the respective interface.
For ease of reference, we will refer to all three products as
“iBistro” or “iBistro/iLink” throughout this training guide.
SirsiDynix’s first Web-based OPAC, WebCat, was delivered
with Unicorn through version 2000. Many Unicorn users still use
WebCat. iBistro and iLink are essentially a content-enriched
WebCat, with a similar architecture and means of customization.
Beginning with Unicorn version 2001, iBistro and iLink are
delivered, but customers can upgrade without purchasing iBistro
or iLink. Beginning with Unicorn version 2002, customers can
choose Web2 as their public access interface.
Anytime a final step mentions to “halt and run the Unicorn
servers,” users with an NT/Windows platform will stop and start
the Unicorn services.

2 Version 3.0, March 2006


Introduction

Webservers and iBistro/iLink


The SirsiDynix Unicorn iBistro/iLink system is housed in at
least two cooperative file systems:
• Unicorn file system – Contains files that control the
content of iBistro/iLink Web pages.
• Webserver file system – Contains the CGI binaries,
webserver daemon, and image files. While SirsiDynix
delivers all Unicorn software into specified Unicorn
directories, the physical location of webserver files is
entirely at the discretion of the system administrator.

For Unicorn turnkey systems installed on Window NT or 2000,


the files are typically installed in the following locations:
Unicorn files d:\Sirsi\Unicorn\Webcat
Webserver files c:\Program Files\Apache group
\Apache2\Htdocs

For Unicorn turnkey systems installed on SUN or AIX UNIX


operating systems, the files are typically installed in the
following locations:
Unicorn files /s/sirsi/Unicorn/Webcat
Webserver files /var/apache/htdocs

Version 3.0, March 2006 3


Fundamentals of iBistro/iLink Customization

4 Version 3.0, March 2006


OPAC Configuration
Overview
OPAC Configuration wizards on the Configuration toolbar help
you design, customize, and manage public access windows and
options. This includes configuring reference databases and
applications available through the Knowledge Portal, as well as
creating customized searches for library patrons. You can also
create a “Gateway” based on your library’s information
resources. These resources include external reference databases
and resources available on external networks. In essence, the
Gateway is a view of the library’s information universe.

Gateways and Gateway Elements

Gateway
A Gateway is a named set of individually configured choices
(elements) arranged in a hierarchical tree structure. You assign
these choices to a group of users to establish how they will view
iBistro/iLink windows. The Gateway defines what choices are
available. It is assigned through the user’s Environment policy,
which is part of the User Profile policy.

NOTE Some systems can be configured so that the


Environment policy is part of the User
record.

To understand how a Gateway works, picture Unicorn’s standard


choices in the iBistro/iLink screens as branches of an upside-
down tree. Start making choices at the root of the tree, and
continue to branch out from there as you make additional
choices.

Version 3.0, March 2006 5


Fundamentals of iBistro/iLink Customization

CAUTION SirsiDynix delivers a predefined Gateway named


Unicorn. Do not modify this gateway because updates
to the Unicorn software may overwrite any changes
you make to the Unicorn Gateway. SirsiDynix also
delivers an iBistro or iLink gateway that you can
change. If you want additional custom gateways, copy
the Unicorn Gateway to create a new Gateway, and
then modify the new one.

6 Version 3.0, March 2006


OPAC Configuration

Gateway Elements
Gateways have two types of elements:
• Destination – A Destination is the final element
(system, database, or function) in the Gateway tree
structure. This could be considered an application-level
command, bringing the user to a desired end. Types of
destinations include reference databases, Z39.50 sites,
library information postings, request submissions, and
predefined searches.
• Group Element– A Group Element contains specific
destinations or other groups.

The diagram below illustrates Group Elements (boxes) and


Destinations (text below boxes):

Version 3.0, March 2006 7


Fundamentals of iBistro/iLink Customization

The following graphics show the iBistro Gateway through the


gateway elements as they appear in WorkFlows.
1. On the Configuration module toolbar, click the OPAC
Configuration toolbar, then click the Gateway

Database Configuration wizard . The following


window appears:

2. Select IBISTRO and click Modify. The following


window appears:

8 Version 3.0, March 2006


OPAC Configuration

3. For this example, select Knowledge Portal, and click


Modify. The following window appears:

There are three tabs on this window


• Basic
• Destination
• WWW Information (displays only if the WWW in Use
box is selected)

We will discuss the entries on each tab in the following sections.

Version 3.0, March 2006 9


Fundamentals of iBistro/iLink Customization

Basic Tab
The Basic tab appears when you select any Gateway Element.
This tab contains the following attributes, which describe
characteristics of the selected group or destination element.
Name
This attribute identifies the Gateway element. This name
cannot contain any spaces and must be unique.
Description
This attribute provides a description of how the element
may be used by the library. This description will appear in
lists of elements to select from in the iBistro/iLink
windows.
Type
This attribute defines the type of gateway element.
Depending on the type selected, different tabs and tab
attributes will display.
WWW In Use
Select this attribute to display the WWW Information tab,
which allows the display of headers/footers and additional
information about an element. We will discuss the entries
on this tab on page 13.
User Hierarchy Level
This attribute identifies which users can access this gateway
element, based on the User Access policy. Users must have
a user level equal to or higher than this attribute's value to
access an element.
For example, STAFF elements can be accessed by users
with a user access of STAFF. PUBLIC elements can be
accessed by users with a user access of STAFF or PUBLIC.
If a login has a user access lower than the element, then that
element will not display to that user.
Element Status
This attribute has one of the following values.
ƒ AVAILABLE – The Gateway element is active.
ƒ HIDDEN – The Gateway element is usable but
does not appear with the other elements in the
same group. This element may appear when
referenced from another group, or this element
may contain elements used by custom buttons.
ƒ NOT_AVAIL – The Gateway element is
inactive. Use this value to turn off an element.

10 Version 3.0, March 2006


OPAC Configuration

Icon Name
This attribute specifies the image that graphically represents
this Gateway element. This image is not a hypergraphic.
Display Instructions
This attribute is used only with an InfoVIEW public access
catalog.
Instruction
This attribute is used only with an InfoVIEW public access
catalog.

Instruction Helper
Use this helper to edit the instruction text file for the
gateway element. This file may contain searching examples
and instructions, an abstract of database contents, copyright
statements, usage disclaimers, and/or usage restrictions.
These instruction files are located in the
/Unicorn/Gateway/Instruction directory.
Heading
This 1-80 character attribute specifies the window title. If
the element is a group element, this heading appears above
the list of group or destination elements included within this
element. If the element is a destination element, this
heading appears at the top of the window, if applicable.
Available Clients for Access
This attribute limits which clients can access the current
element. This element can be used by the iBistro/iLink,
WorkFlows, InfoVIEW client, or any combination of the
three. Certain element types only work with certain clients;
for example, WWW-type Gateway elements only work in
iBistro/iLink, so it is best to limit access to the WebCat
client.

Version 3.0, March 2006 11


Fundamentals of iBistro/iLink Customization

Destination Tab

The Destination tab appears when you select any Gateway


Element. This tab contains different attributes, depending on
whether the selected element is a group or destination element.
The example shown above is for a group element. If the selected
element is a destination, the attributes vary based on the type of
destination element. These attributes describe characteristics of
the selected group or destination element.

12 Version 3.0, March 2006


OPAC Configuration

WWW Information Tab

NOTE This tab only appears if you select the


WWW in use check box.

This tab contains the following attributes:


Display Introduction
This attribute specifies whether to display the header file at
the top of the window that corresponds to this element.
Introduction
This attribute lets you select a header file containing the
text that will appear in the OPAC. This file is stored in the
/Unicorn/Gateway/Webhdr directory. Click the

Introduction helper to select a header file.

Version 3.0, March 2006 13


Fundamentals of iBistro/iLink Customization

CAUTION If a text file begins with an S, do not modify


it. It is a SirsiDynix-generated text file and
any changes to this file may be overwritten
during a software update. Instead, create a
new text file using the SirsiDynix-generated
file as a base and begin the new file name
with a C for custom.

Display Paragraph
This attribute specifies whether to display a text file
containing descriptive information about the current
element. You can specify that this paragraph displays at the
top or bottom of the window.
Paragraph
This attribute allows you to select a text file containing
descriptive text about the current element. This file is stored
in the /Unicorn/Gateway/Webpar directory. Click the

Paragraph helper to select the text file.


Display Sentence
This attribute specifies whether to display the brief
description of an element’s function.
Sentence
This attributes allows you to type a line of text that appears
in the window offering this element as a choice. This text
should briefly explain the current element’s function.
Display Footer
This attribute specifies whether footer text should appear at
the bottom of the window corresponding to the current
element.
Footer
This attribute allows you to select a text file that can be
displayed at the bottom of the window and corresponds to
the current element. This file is stored in the
/Unicorn/Gateway/Webftr directory. Click the Footer

helper to select the text file.


Wall Paper Cover Background
This attribute specifies the name of a graphics file. This
image will be used as a wall paper background for the
window corresponding to the current element.

14 Version 3.0, March 2006


OPAC Configuration

Display Icon List


Select this attribute to display the choices in this group
element as icons near the top of the page.
Display Check List
Select this attribute to display a bulleted check list of the
choices in this group element. The text that appears for each
choice is the description text entered when the
corresponding element was created. Standard delivery is to
Display Check List.
Display Detail List
Select this attribute to display the detail list which displays
this group element's choices as icons accompanied by
paragraphs describing each element. The icons and
paragraph text used in this detail list are defined when
creating the elements that belong to this group.

Version 3.0, March 2006 15


Fundamentals of iBistro/iLink Customization

Turn Off a Delivered Gateway Element

To hide the “Contact Us” link on the rootbar

1. On the Configuration module toolbar, click the OPAC


Configuration toolbar, and then click the Gateway

Database Configuration wizard . The following


window appears:

16 Version 3.0, March 2006


OPAC Configuration

2. Select the gateway to modify (IBISTRO), and click


Modify. The following window appears:

Version 3.0, March 2006 17


Fundamentals of iBistro/iLink Customization

3. Select Contact Us, and click Modify. The following


window appears:

4. In the Element Status list, click NOT_AVAIL.


5. Click Save. The Elements for IBISTRO Gateway
window reappears.
6. Click Cancel, and then click Close. This change will
take effect after you halt and run the Unicorn servers.

NOTE You can apply these steps to any gateway


element. Making a group element NOT
AVAILABLE will also make all destination
elements within that group not appear in
iBistro/iLink.

18 Version 3.0, March 2006


OPAC Configuration

WWW Destination Elements


The Knowledge Portal element in iBistro/iLink connects library
users to Z39.50 destinations and the World Wide Web. WEB
destination elements allow access to Web pages from the OPAC.

To create a link to SirsiDynix’s home page in


iBistro/iLink using Knowledge Portal
1. On the Configuration module toolbar, click the OPAC
Configuration toolbar, and then click the Gateway

Database Configuration wizard . The List


Policies window appears:

Version 3.0, March 2006 19


Fundamentals of iBistro/iLink Customization

2. Select the gateway to modify (IBISTRO), and click


Modify. The following window appears:

3. Double-click Knowledge Portal to display a list of


group elements:

20 Version 3.0, March 2006


OPAC Configuration

4. Double-click World Wide Web to display a list of


delivered Web sites:

5. Click Create. The following window appears:

Version 3.0, March 2006 21


Fundamentals of iBistro/iLink Customization

6. For this example, in the Name box, type SIRSIDYNIX.


The name must be unique and cannot contain any
spaces.
7. In the Description box, type SirsiDynix. The
description entered here will appear in the OPAC as a
hyperlink to the Web page.
8. In the Type box, select WEB.
9. In the User Hierarchy Level list, select
EXTEND_PUB. This identifies which users can access
this gateway element based on the User Access policy.
Users must have a user hierarchical level equal to or
higher than this attribute’s value.
10. In the Element Status list, select AVAILABLE.
11. Leave the Icon Name list attribute blank.
12. Leave the box next to Display Instructions deselected.
13. Leave the Instruction and Heading boxes blank, and
leave the Webcat, WorkFlows, and Infoview check
boxes selected.
14. Click the Destination tab. The following window
appears:

15. In the URL box, type the URL of the Web site. In this
example, type http://www.sirsidynix.com.

22 Version 3.0, March 2006


OPAC Configuration

16. Click Save. The new Web site now appears in the list:

17. Click Cancel, and then click Close. These changes will
take effect after you halt and run the Unicorn servers.

Version 3.0, March 2006 23


Fundamentals of iBistro/iLink Customization

Catalog Access Destination Elements

Catalog Access elements, such as QUICK_SEARCH and


ADVANCED_SEARCH access the library catalog in a search,
browse, or term search. This type of element may either accept
text typed by the OPAC user or use a predefined text string.

To access the Catalog Access elements

1. On the Configuration module toolbar, click the OPAC


Configuration toolbar, then click the Gateway Database

Configuration wizard .

The List Policies window appears:

24 Version 3.0, March 2006


OPAC Configuration

2. Select the gateway to modify (IBISTRO), and click


Modify. The following window appears:

3. Double-click Catalog Searches to display the options.

Version 3.0, March 2006 25


Fundamentals of iBistro/iLink Customization

4. Click ADVANCED_SEARCH, and then click Modify.


The following window appears:

26 Version 3.0, March 2006


OPAC Configuration

5. Click the Destination tab. The following window


appears:

Version 3.0, March 2006 27


Fundamentals of iBistro/iLink Customization

Destination Tab Attributes

Initial Catalog Operation


This attribute specifies the type of initial search operation of
the library catalog.
ƒ Search – Searches the catalog using specified
words or phrases, retrieving items that match
these terms.
ƒ Browse – Browses the catalog for library catalog
headings in the same alphabetic range as the
typed term.
ƒ Term – Searches the catalog for headings that
match, either partially or completely, the typed
search term.
ƒ None

Presentation Type

NOTE This attribute is only available when the


initial operation is Search.

This attribute defines how the search fields appear.


ƒ Labeled Fields – Displays multiple text boxes
with descriptive labels (i.e., Advanced Search).

ƒ Search Icons – Displays a single text box with


graphical icons representing the search criteria
(i.e., Browse).

28 Version 3.0, March 2006


OPAC Configuration

ƒ Single Field – Displays a single text box with a


drop-down list for selecting author, title, series,
etc. (i.e., Quick Search).

Version 3.0, March 2006 29


Fundamentals of iBistro/iLink Customization

Catalog Search Qualifier


The attributes in the Catalog Search Qualifier section define
qualifiers to limit the search.

6. Click the Search Field tab. The following window


appears:

30 Version 3.0, March 2006


OPAC Configuration

Search Field Tab Attributes


On this tab you can define the various search fields displayed in
iBistro/iLink. These search fields may have preconfigured search
criteria. You can define up to eight search fields.
Label
The search field label appears next to the entry field where
the user types the search term.
Keyword Index
This attribute defines which Keyword Index will be
searched.
Browse Index
This attribute defines the default Browse Index(es) if a
keyword search does not retrieve any items.
Operator
This attribute defines the default operator that appears in a
labeled fields view.
Predefined Search Key
This attribute lets you type a predefined 1-60 character
search term or expression.
Search Icon
This attribute specifies an icon to represent the search field.
Special Processing
Terms in this field may receive one of the following types
of special processing.
ƒ Author – This type affects browsing only. If no
hits are found in the browse catalog, the terms are
rotated, and a check is made to see if a match is
found. For example, if a user typed Ayn Rand
and no match is found, then it would search
Rand Ayn.
ƒ Phrase – This type is found on Chinese systems
only. Unicorn will perform Chinese language
phrase processing on terms typed into this field.
ƒ Pinyin – This type is found on Chinese systems
only. Unicorn will perform Chinese language
phrase processing on terms typed into this field.
ƒ Title – This type affects browsing also. If no hits
are found, the stopword that was typed at the
beginning of the search will be automatically
dropped so that the matching is successful.

Version 3.0, March 2006 31


Fundamentals of iBistro/iLink Customization

Thesaurus
This attribute specifies that the thesaurus will be searched
and that cross-references will appear if the typed search
expression has any.

To add a search field to the delivered Advanced


Search gateway element that will search the
catalog’s ISBN (020) index

1. On the Configuration module toolbar, click the OPAC


Configuration toolbar, and then click the Gateway
Database Configuration wizard.
2. On the List Policies window, click IBISTRO, and then
click Modify.
3. On the Elements for IBISTRO Gateway window,
double-click Catalog Searches.
4. Click ADVANCED_SEARCH, and then click Modify.
5. Click the Search Field tab.
6. In a blank Label box, type isbn and in the Keyword
Index box, select 020. Leave the remaining fields blank.

7. Click Save, and then click Cancel. The Gateway


window reappears.
8. Click Close to exit the wizard.

These changes will take effect after you halt and run the Unicorn
servers. Here is how it appears in iBistro:

32 Version 3.0, March 2006


Book Lists
Overview
You can post special catalog lists to the OPAC, such as items of
seasonal or local interest, by linking standard catalog records to
Information Desk policies and configuring the OPAC to display
them.

Creating Book Lists


The Catalog Format policies and the Information Desk policies
link records to book lists in the OPAC. This is accomplished in
three steps.
1. Create an Information Desk policy
2. Configure the Information Desk policy that represents
the book list to display in the OPAC.
3. Assign the Information Desk policy to bibliographic
records in the catalog. The following procedures
describe this process.

Create the Information Desk Policy


Create an Information Desk policy, providing the name and
description of how records linked with the Information Desk
policy are used.

To create an information desk policy for local


interest items

1. On the Configuration module toolbar, click the OPAC


Configuration toolbar, and, then click the Gateway

Database Configuration wizard .

The List Policies window appears:

Version 3.0, March 2006 33


Fundamentals of iBistro/iLink Customization

2. Select the gateway to modify (IBISTRO), and click


Modify. The Elements for IBISTRO Gateway window
appears:

34 Version 3.0, March 2006


Book Lists

3. On the Public Access Choices list, select Library Info,


and click Create. The following window appears:

4. In the Name box, type LOCAL. The name can contain


up to 10 characters – no spaces or punctuation.
5. In the Description box, type Local Interest as the
policy description. The description can contain up to 60
characters, including spaces and punctuation. This is the
name that displays in the OPAC.
6. In the Type box, select CAT_BULTN.
7. Do not select the WWW in use check box.
8. In the User hierarchy level box, select EXTEND_PUB.
9. In the Element status box, select AVAILABLE.
10. Leave the Icon name, Instruction, and Heading boxes
blank. Do not select the Display instructions check box.
11. Clear the WorkFlows and Infoview boxes.

Version 3.0, March 2006 35


Fundamentals of iBistro/iLink Customization

12. Click the Destination tab.

13. Click the Information Desk helper . The


following window appears:

36 Version 3.0, March 2006


Book Lists

14. Click Create. The following window appears:

15. In the Name box, type LOCAL.


16. In the Description box, type Local Interest.
17. Click Save. The Destination tab reappears.
18. In the Bulletin Destination box, you can now select
LOCAL.
19. Click Save. The Elements for IBISTRO Gateway
window reappears with Local Interest now appearing in
the Library Info section on the Public Access Choices
list:

Version 3.0, March 2006 37


Fundamentals of iBistro/iLink Customization

20. Click Cancel to exit and redisplay the List Policies


window.
21. Click Close. This change will take effect after you halt
and run the Unicorn servers.

Assign the Bibliographic Records to the Book List


A book list is a list of items from the catalog that make up a
specialized bibliography.
After identifying catalog items, each record to be posted to this
list is assigned a special Information Desk policy. Use this policy
to group related records and associate these records with an
Information Desk choice. This can be done manually or in batch
using reports. Posted records appear when a user selects the
Information Desk choice.

To create a catalog list of local interest items

1. On the Cataloging module toolbar, click the Title


Maintenance toolbar, and, then click the Modify Title

wizard . The Item Search window appears:

2. Search for the record to be modified.

38 Version 3.0, March 2006


Book Lists

3. When you locate the record, click Modify. The item


record appears.

Version 3.0, March 2006 39


Fundamentals of iBistro/iLink Customization

4. On the Bibliographic tab, insert a blank entry field as


shown below:
Use the Before or After
helper to add the blank
entry field.

5. Click the 610 tag, and then click the Insert a field
before the current one helper.
6. Type 598, press TAB twice, and type the Information
Desk policy name (LOCAL) in the field. Make sure the
policy name is in all caps.

40 Version 3.0, March 2006


Book Lists

NOTE Every title record posted as an Information


Desk choice must contain a 598 entry field
linking the record to a specified policy name.
Any item can be placed on more than one
book list, and the entry tag may contain
multiple Information Desk policy names.

7. Click Save, and then click Close.


8. In iBistro, click Local Interest in the Library
Information box to display the book list of selected
Local Interest items.

Version 3.0, March 2006 41


Fundamentals of iBistro/iLink Customization

Using Reports with Book Lists


Another way to create links to Information Desk policies or
bulletin elements is to use the Add Items to Item List report.
This is an easy way to mark items that can be easily grouped
together by common bibliographic or item record characteristics.
The report edits selected records by adding a 598 Entry ID with
the appropriate Information Desk policy assigned in the report
selection criteria.

To link catalog records with a Subject heading of


“Science Fiction” to the Science Fiction Book List
using the Add Items to Item List report:

1. On the Reports module toolbar, click the Schedule New

Reports wizard
2. If the Set Session Settings window appears, click OK to
accept the defaults. The Schedule New Reports window
appears:

42 Version 3.0, March 2006


Book Lists

3. Click the Info Desk tab. The following window appears:

4. Select the Add Items to Item List report, and click


Setup & Schedule. The following window appears:

5. In the Report Name box, change the name of the report


to Science Fiction Book List.

Version 3.0, March 2006 43


Fundamentals of iBistro/iLink Customization

6. Click the Information Desk tab. The following window


appears:

7. In the Information Desk list, select SCIFI.


8. Next to Type, click Bibliographic.
9. Click the Search String gadget and type science
fiction{SU} in the Enter String box:

44 Version 3.0, March 2006


Book Lists

10. Click Add. The entry now appears in the List Selected.
Click OK. The following window reappears:

Version 3.0, March 2006 45


Fundamentals of iBistro/iLink Customization

11. Click the Copy Selection tab. The following window


appears:

12. Click the Current Location gadget. The Gadget:Location


window appears:

46 Version 3.0, March 2006


Book Lists

13. Click Does not contain selected policies.


14. In the List to Choose From, select those locations to
exclude from the list, such as DISCARD,
INPROCESS, LOST, and MISSING. Click the right
arrow to add these policies to List Selected:

Version 3.0, March 2006 47


Fundamentals of iBistro/iLink Customization

15. Click OK to close the gadget and return to the previous


window.
16. Click Run Now. The following window appears:

17. Click Close.

48 Version 3.0, March 2006


Book Lists

NOTE After all the items are selected by the Add


Items to Item List report, run the Add,
Delete, Update Databases report so that
the edited records will appear in iBistro.

18. In iBistro, to display the book list of selected items, click


Science Fiction in the Library Information box. The
Science Fiction icon displays.

Schedule additional Add Items to Item List reports


corresponding to all Book List elements.

Version 3.0, March 2006 49


Fundamentals of iBistro/iLink Customization

You can also create a New Books list using this report.

To create a New Books list using the Add Items to


Item List report
1. On the Reports toolbar, click the Schedule New

Reports wizard .
2. If the Set Session Settings window appears, click OK to
accept defaults. The Schedule New Reports window
appears:

50 Version 3.0, March 2006


Book Lists

3. Click the Info Desk tab. The following window appears:

4. Select the Add Items to Item List report, and click


Setup & Schedule. The following window appears:

5. In the Report Name box, change the name of the report


to New Books List.

Version 3.0, March 2006 51


Fundamentals of iBistro/iLink Customization

6. Click the Information Desk tab. The following window


appears:

7. In the Information Desk list, select the NEW (New


Books) Information Desk policy.
8. Next to Type, click Item.

52 Version 3.0, March 2006


Book Lists

9. Click the Copy Selection tab. The following window


appears:

10. Click the Home Location gadget. The Gadget:Location


window appears.

Version 3.0, March 2006 53


Fundamentals of iBistro/iLink Customization

11. Click Does not contain selected policies.

54 Version 3.0, March 2006


Book Lists

12. In the List to Choose From, select those locations to


exclude from the list, such as ILL, INPROCESS, ON-
ORDER, and REFERENCE. Click the right arrow to
add these policies to List Selected.

13. Click OK to close the gadget and return to the previous


window.

Version 3.0, March 2006 55


Fundamentals of iBistro/iLink Customization

14. Click the Title Selection tab. The following window


appears:

15. Click the Date created gadget. The following window


appears:

56 Version 3.0, March 2006


Book Lists

16. Click the Date Depends on the Report Run Date

helper . The following window appears:

17. Using the helper, set the range to 1 month before and 0
months after. Click OK. The previous window appears
with the new information in the Date created box:

Version 3.0, March 2006 57


Fundamentals of iBistro/iLink Customization

18. Click Schedule. The following window appears:

19. To schedule this report to run on the first day of every


month, click Monthly. New information now appears:

58 Version 3.0, March 2006


Book Lists

20. Monthly schedules the report to run one or more


selected days of the month. Use the Start running on
calendar to select the starting day, and type or select the
starting hour, minute, and AM or PM. Under Days of
Month, select the check box next to the day of the
month you want the report to run.

NOTE If you select 31, the report will be scheduled


for the actual last day of every month.

NOTE There is no need to run a separate report to


remove “old” New Books from the list. When
scheduled to automatically run on a regular
basis, the Add Items to Item List report will
refresh the list each time it runs. It first
removes all NEW Information Desk policies
from the records that currently have NEW in
a 598 entry ID. It then adds NEW to a 598
entry ID in catalog titles that meet the
selection criteria in this report.

21. To configure the New Books list to display under


Library Info in the OPAC, follow the steps under Create
the Information Desk Policy on p. 33, substituting NEW
for LOCAL.

NOTE After the Add Items to Item List report


selects all the items, run the Add, Delete,
Update Databases report so that the edited
records will appear in the OPAC.

Version 3.0, March 2006 59


Fundamentals of iBistro/iLink Customization

More Information Desk Reports


In addition to Add Items to Item List, you can use the
following reports with book lists.
• Print Bulletins – Provides a printed list of all catalog
records matching the selected Information Desk policy
name.
• Remove Bulletins – Removes bulletins and catalog
items from the list.
• Remove Items From Item List – Removes links
between catalog records and an Information Desk policy.

60 Version 3.0, March 2006


Book Lists

Have You Read

Have You Read icons, delivered under the Library Info group
element, are Bulletin-type elements. Functionally, Have You
Read elements work like Information Desk bulletin elements.
Clicking one of the icons retrieves a book list of catalog records
containing the specified Information Desk policy in a 598 tag.

Activating “Have You Read”


SirsiDynix configures the first two steps for the Have You Read
book lists on a delivered Unicorn system. To use any of the Have
You Read elements, you must complete the third step, which is
to link bibliographic records in your library’s catalog to those
elements. You can choose to use all or only some of the Have
You Read elements.

Version 3.0, March 2006 61


Fundamentals of iBistro/iLink Customization

To link catalog records to the Staff Favorites Have


You Read element

One Have You Read element is called Staff Favorites. There is


already a delivered Staff Favorites (FAV) Information Desk
policy linked to the Staff Favorites (STAFF_FAV_(BULL))
gateway element. Follow the steps below to individually search
for and manually edit records, inserting the Information Desk
policy FAV into a 598 tag.
1. On the Cataloging module toolbar, click the Title
Maintenance toolbar, then click the Modify Title

wizard . The Item Search window appears:

2. Search for the record to be modified.


3. When you locate the record, click Modify. The item
record appears.

62 Version 3.0, March 2006


Book Lists

4. On the Bibliographic tab, insert a blank entry field as


shown below:

Use the Before or After


helper to add the blank
entry field.

5. In this example, click the 650 tag, and then click the
Insert a field before the current one helper.
6. Type 598, press TAB twice, and type the Information
Desk policy name (FAV) in the field. Make sure the
policy name is in all caps.

Version 3.0, March 2006 63


Fundamentals of iBistro/iLink Customization

NOTE Every title record posted as an Information


Desk choice must contain a 598 entry field
linking the record to a specified policy name.

7. Click Save, and then click Close.


8. In iBistro, to display the book list of selected items, click
Have You Read? in the Library Information box and
then click Staff Favorites.

64 Version 3.0, March 2006


Book Lists

Best Sellers and Recommended Reading


Lists
The SirsiDynix DataStream™ subscription (also referred to as
Content Enrichment) provides your library with continuously
updated best seller and recommended reading lists. Links to the
items that appear on these lists appear on the iBistro/iLink
Search/Home page:

Best Sellers List Configuration Wizard


SirsiDynix delivers the BEST_SELL policy with a standard set
of Best Seller lists, including lists such as the NY Times Fiction
and Non Fiction Best Sellers and Publisher’s Weekly Best
Sellers. The COMPLETE policy includes all lists available from
the SirsiDynix Content Enrichment. You can choose to display
all or only selected best seller lists. This wizard allows you to
create groups of lists (policies) to display to different user
groups.

To select which Best Sellers lists display in the


OPAC

1. On the Configuration module toolbar, click the OPAC


Configuration toolbar, and then click the Best Sellers

List Configuration wizard . The following


window appears:

Version 3.0, March 2006 65


Fundamentals of iBistro/iLink Customization

2. BEST_SELL is selected, so just click Modify. The


following window appears:

3. Click the Lists to display gadget. The following


window appears:

66 Version 3.0, March 2006


Book Lists

4. To add a new list to display in iBistro/iLink, select a list


from the left column, and click the right arrow.
5. When you’ve finished adding lists, click OK. The Best
Sellers List Configuration window reappears with the
new list(s) added.
Once configured, run the Update iBistro Content Lists report on
a regular basis to download updated best seller lists from the
SirsiDynix Content Enrichment server to your server.
You can view a list of current best seller lists on the SirsiDynix
Client Care Web site at this URL:

http://www.sirsi.com/uhtbin/custinfo/Documentation/Contentlists/index.html

Version 3.0, March 2006 67


Fundamentals of iBistro/iLink Customization

Recommended Reading Configuration Wizard

Use the Recommended Reading Configuration wizard to


select which recommended reading lists display in the OPAC.
These lists point to individual Recommended Reading titles and
provide brief explanations of the awards won. You can display
all or only selected recommended reading lists. Using this
wizard, you can also create groups of lists (policies) to display to
different user groups.
The procedure to modify the delivered lists is the same as we just
discussed for the Best Sellers List Configuration wizard.
Once configured, run the Update iBistro Content Lists report to
download recommended reading lists.

Reports

Update iBistro Content Lists Report


The Update iBistro Content Lists (Updibistrolist) report (in the
iBistro report group) updates best seller and recommended
reading lists. You can schedule this report several times per
week.
The DataStream subscription provides licensed access to an
enrichment database that provides links to covers, reviews,
summaries, etc., and basic access to ASCII hot sites, best seller
lists, and recommended reading lists. Basic subscription data is
packaged at SirsiDynix three times per week. The entire content
enrichment (and best sellers lists) is packaged once per week.
The Update iBistro Content Lists report downloads the basic part
of the content package at any time, while continuing to
download the enrichment data (and best sellers lists) once per
week at the SirsiDynix-scheduled time.

Index Content Titles Report


The Index Content Titles (Idxcontentkeys) report indexes new
best sellers and recommended reading titles. Run this report after
the Update iBistro Content Lists report.

68 Version 3.0, March 2006


Book Lists

Version 3.0, March 2006 69


iBistro/iLink Configuration
Unicorn User Environment
Every time a user accesses iBistro/iLink, a user has logged in to
the system. If the user connects directly to iBistro/iLink without
entering a login ID or PIN, the user is logged in as a
SirsiDynix-delivered WEBSERVER user. Whether the user logs
in to iBistro/iLink as the WEBSERVER user or another user, a
user environment is being used for the interface.
The user environment is important in two ways:
• It defines the user’s assigned gateway.
• It is the policy that triggers the environment files that
allow more detailed customization of system variables.

The gateway can determine which elements will be available to


the user through iBistro/iLink. The environment files provide
more detailed customization using system variables. Therefore, it
is important that Unicorn administrators know how to identify a
user’s environment and gateway.
The following diagram illustrates the relationship between the
User Record, User Profile, and Environment policies.

Version 3.0, March 2006 70


iBistro/iLink Configuration

User Profile
The Unicorn user record includes the Profile name, which
determines the associated User Profile policy.

Version 3.0, March 2006 71


Fundamentals of iBistro/iLink Customization

Environment Attribute
The User Profile policy references an Environment policy that,
by virtue of its being assigned through the user’s profile, is
assigned to the user.

72 Version 3.0, March 2006


iBistro/iLink Configuration

Gateway
The Environment policy determines the user’s Gateway and the
policy number used to name a specific iBistro environment file,
if required.

Version 3.0, March 2006 73


Fundamentals of iBistro/iLink Customization

webconfig

Overview
You can control many behaviors of iBistro/iLink using
configuration files delivered in the Unicorn directory system.
One of these is the webconfig file, which is located in the
Unicorn/Webcat/Config directory.
The webconfig file contains lines of pipe-delimited definitions
for the OPAC. We will discuss two important lines from this file
in the following sections.

LOGIN|0|WEBSERVER||
CGIOPAC_TIMEOUT|180|

LOGIN|1|WEBSERVER||
In the login line, the second pipe-delimited field indicates
whether logins are on (1) or off (0) for the system. Rules for
login are as follows.
• If logins are off, the default value of WEBSERVER
is used by the system.

NOTE Because users bypass the login screen, it is


important for the default login to have a
blank PIN field.

• If logins are on, the third field value appears in the data
field for user identification. It can be deleted and
replaced with a different user ID. The delivered default
is WEBSERVER.
• If logins are on and no value is put in the third field,
there will be no default in the ID field to be deleted and
replaced.
• If logins are off and no value is put in the third field, the
user will always use the WEBSERVER user.

You can use the fourth field for a user alternate identification
value. If the system is configured for alternative ID access
instead of User ID access, the WEBSERVER alternative ID is
delivered populated, and the same rules mentioned earlier apply
for the fourth field.

74 Version 3.0, March 2006


iBistro/iLink Configuration

CGIOPAC_TIMEOUT|180|
This line sets the response timeout (in seconds) from the server.
This timeout represents the amount of time it takes the server to
process a query and return data. The response timeout is
delivered as 180 seconds.

NOTE The response timeout is not the inactivity


timeout, which ends a user session if the
user has not sent a request to the server in x
amount of time.

For example, a user submits a general search on the term


“united,” and the response is slow due to the thousands of
records hit by the query. The response timeout stops the action if
it takes the system more than the allotted time to complete the
response.

UNICORN_TYPE|2|
There are three options for the UNICORN_TYPE value in the
webconfig file.
0 = iLink
2 = iBistro
1 or 7 = Ecole
The selection depends on the type of OPAC you are running, and
only one selection can be made in the file. If you have multiple
OPAC types running on the same system, you need a libconfig
file for each library. This example shows the format for the
Arrowood library:

libconfig.ARROWOOD

The only line in the libconfig file would be the


UNICORN_TYPE variable.

Version 3.0, March 2006 75


Fundamentals of iBistro/iLink Customization

Environment Files

System-Wide Environment Files


Environment files hold variables and variable values that control
the presentation of iBistro/iLink for quantified groups of users.
The environment variables determine which data-entry fields and
default values appear in the OPAC. The /Unicorn/Webcat/Config
directory contains the environment files.
For a list of delivered environment variables, see “Appendix A –
Delivered iBistro/iLink Environment Files” on page 114.
There are three levels of environment files. They are listed below
in hierarchical order with their description.
ibistro.env
The ibistro.env file contains SirsiDynix’s primary list of
customer-configurable iBistro and iLink environment
variables. These are all variables available for a particular
release. Consider this the master list of iBistro environment
variables. This file is updated during upgrades; do not make
changes to this file.
link.env
This file is associated with ibistro.env. It contains the
variables that make up the style differences between iLink
and iBistro. The link.env file is informational only.
system.env
The system.env file is the file in which a library can set
system wide variables. The presence of a variable within
system.env will supersede that same value in the ibistro.env
file. The system.env file is preserved during upgrades.
envn#.env
Any value that appears within these files supersedes the
same value defined in the system.env and ibistro.env files.
A site can have multiple envn#.env files. These files are
preserved during upgrades.

NOTE You can have multiple envn#.env files,


however, there can only be one envn#.env
file for each environment policy.

76 Version 3.0, March 2006


iBistro/iLink Configuration

Environment Files – Working with Fonts and Color

Exercise 1: Change the font used throughout the


iBistro/iLink pages
1. On your server, locate the Unicorn/Webcat/Config
directory.
2. Copy the following lines from the ibistro.env file:

# Font configuration
FONT_FACE|Verdana, Helvetica, Arial, sans-serif|

3. Paste these lines in the system.env file.


4. Insert a different FONT_FACE value.

# Font configuration
FONT_FACE|Garamond, Verdana, Helvetica, Arial, sans-serif|

5. Save your changes to the system.env file. This will


change the font used throughout iBistro/iLink. This
variable will not change the fonts on the toolbar, which
are image files.

NOTE When changing the font face variable, it is a


good idea to insert more than one font.
When a user views the iBistro/iLink page,
the first font listed may not be installed on
the user’s PC.

6. Log in to iBistro/iLink to view your changes.

Version 3.0, March 2006 77


Fundamentals of iBistro/iLink Customization

Exercise 2: Change the colors used in the rootbar


The HTML color code is a six-digit code where each pair of
digits represents one of the RGB (red-green-blue) colors. The
value for each pair can range from 00 to FF. When the three
pairs of color codes are combined, a color emerges. For example,
#0000FF represents blue. For this color code, the red color code
has the value of 00, the green color code has the value of 00, and
the blue color code has the value of FF. An HTML color code of
#000000 represents black; a color code of #FFFFFF represents
white.
There are 216 “browser-safe” colors. These colors can only
contain 00, 33, 66, 99, CC, and FF values in each of the paired
digits of the RGB spectrum.
1. On your server, locate the Unicorn/Webcat/Config
directory.
2. Copy the following lines from the ibistro.env file:

BLASTOFF_COLOR|#FFFF99| # yellow (revC only)


ROOTBAR_COLOR|#FFFFFF| # white (revC only)

3. Paste these lines in the system.env file.


4. Change the colors used in these variables.

BLASTOFF_COLOR|#FF6699|
ROOTBAR_COLOR|#CCFF66|

5. Save your changes to the system.env file.


6. Log in to iBistro/iLink to view your changes.

78 Version 3.0, March 2006


iBistro/iLink Configuration

Library
slogan Exercise 3: Change the text color of the library
slogan

1. On your server, locate the Unicorn/Webcat/Config


directory.
2. Copy the following line from the ibistro.env file:

TITLEBAR_TEXT_COLOR|#FFFFFF|

3. Paste these lines in the system.env file.


4. Change the color used in this variable.

TITLEBAR_TEXT_COLOR|#FF6600|

5. Save your changes to the system.env file.


6. Log in to iBistro/iLink to view your changes.

Version 3.0, March 2006 79


Fundamentals of iBistro/iLink Customization

Exercise 4: Change the style of links throughout


the iBistro/iLink pages

These variables control the style of links throughout iBistro.


These variables do not affect the style of the rootbar, which has
its own configuration.
1. On your server, locate the Unicorn/Webcat/Config
directory.
2. Copy the following lines from the ibistro.env file:

# defined in style sheet


LINK_COLOR|#006699| # blue
VISITED_COLOR|#006699| # blue (revC only)
HOVER_COLOR|#FF0000| # red
HOVER_BGCOLOR|#FFFFCC| # yellow

3. Paste these lines in the system.env file.


4. Change the colors for these variables.

# defined in style sheet


LINK_COLOR|#33CC00|
VISITED_COLOR|#3333CC|
HOVER_COLOR|#CCCCFF|
HOVER_BGCOLOR|#FF3399|

5. Save your changes to the system.env file.


6. Log in to iBistro/iLink to view your changes.

80 Version 3.0, March 2006


iBistro/iLink Configuration

Environment Files: Working with search defaults,


view options, and use flags

Exercise 5: Suppress the format search option in


Power Search

1. On your server, locate the Unicorn/Webcat/Config


directory.
2. Copy the following lines from the ibistro.env file:

# Flag causes the format search qualifier to appear (default:SEARCH_FORMAT)


USE_SOPT_FORMAT|1|

3. Paste these lines in the system.env file.

Version 3.0, March 2006 81


Fundamentals of iBistro/iLink Customization

4. Change the value for the USE_SOPT_FORMAT


variable:

# Flag causes the format search qualifier to appear (default:SEARCH_FORMAT)


USE_SOPT_FORMAT|0|

This variable is like a switch:


1 – Activates the variable
0 – Deactivates the variable

5. Save your changes to the system.env file.


6. Log in to iBistro/iLink to view your changes.

82 Version 3.0, March 2006


iBistro/iLink Configuration

Exercise 6: Set the default sort of hit lists to


reverse publication-year order
1. On your server, locate the Unicorn/Webcat/Config
directory.
2. Copy the following lines from the ibistro.env file:

# Catalog Search Options default values -- 3_search.h


# NOTE: If ANY search limit is set in a Catalog Access gateway search element, then
# no locally set default search options such as those below will be used in the
search.
SEARCH_SORT_BY|ANY|

3. Paste these lines in the system.env file.


4. Change the default sort option for the
SEARCH_SORT_BY variable.

# Catalog Search Options default values -- 3_search.h


# NOTE: If ANY search limit is set in a Catalog Access gateway search element, then
# no locally set default search options such as those below will be used in the
search.
SEARCH_SORT_BY|-PBYR|

5. Save your changes to the system.env file.


6. Log in to iBistro/iLink to view your changes.

You can set the following options for this variable:


• -PBYR (reverse chronological publication year order)
• PBYR (chronological publication year order)
• AU (alphabetically by author)
• TI (alphabetically by title)
• SU (alphabetically by subject)

At installation, records automatically appear in reverse


publication year order. However, as you add records to the
database, the most recently added records display at the top of
the list.

Version 3.0, March 2006 83


Fundamentals of iBistro/iLink Customization

Specific Environment Files

envn#.env
The envn#.env file lets you associate iBistro/iLink variables with
individual logins. Envn#.env files are directly related to an
iBistro/iLink login’s environment policy. The # symbol
represents the environment policy number.

List Policies Report


To display the policy number, run the List Policies (listpol)
report or select Display All Policies in the character client.
Here is an example of policy numbers in the List Policies report
(policy numbers are circled):

*ENVIRONMENTS
NAME DESCRIPTION
HELPS SCREENS KEYS WSCONFIG
1. ADMIN System Administrator
Generic Admin Ts NONE
Gateway: IBISTRO Search Source Group : ROOT
Log: NO
Search Output Limit: 10 Search Sort Limit: 200
Idle Timeout: NO Workstation Printer List: ALL
Report Printer List: ALL Default Command: FIND ITEM Host
Timeout: 105
Language: ENGLISH
2. GENERIC
Generic Generic Generic NONE
Gateway: UNICORN Search Source Group : ROOT
Log: NO
Search Output Limit: 0 Search Sort Limit: 1
Idle Timeout: 30 Workstation Printer List: ALL
Report Printer List: ALL Default Command: FIND ITEM Host
Timeout: 60
Language: ENGLISH
...

8. WEBSERVER World Wide Web Server Access


Generic Public Generic NONE
Gateway: IBISTRO Search Source Group : ROOT
Log: NO
Search Output Limit: 10 Search Sort Limit: 200
Idle Timeout: 120 Workstation Printer List: ALL
Report Printer List: ALL Default Command: FIND ITEM Host
Timeout: 105
Language: ENGLISH
9. MORGANCIRC Circulation
Generic Morgan Ps NONE
Gateway: IBISTRO Search Source Group : ROOT
Log: NO
Search Output Limit: 10 Search Sort Limit: 200
Idle Timeout: NO Workstation Printer List: ALL
Report Printer List: ALL Default Command: FIND ITEM Host
Timeout: 105
Language: ENGLISH

84 Version 3.0, March 2006


iBistro/iLink Configuration

iBistro/iLink Test Environment


You may want to make changes to environment variables and
gateway elements in a test environment before posting them
“live” to patrons. You can do this by using a new custom
gateway, new user login, new profile and environment policies,
and a new environment file.

Create a New Gateway Policy


The first step in creating a test iBistro/iLink environment is to
create a new gateway policy. The simplest way to do this is to
copy an existing gateway, such as IBISTRO.

To create a new gateway policy

1. On the Configuration module toolbar, click the OPAC


Configuration toolbar, and then click the Gateway

Policy wizard . The following window appears:

Version 3.0, March 2006 85


Fundamentals of iBistro/iLink Customization

2. Select the gateway to copy (IBISTRO), and then click


Copy. The following window appears:

3. Type the New policy name (for example, TEST), and


then click OK. There is a 10-character limit. The
following window appears:

4. Click the General tab, and type iBistro Test System in


the Description box.

86 Version 3.0, March 2006


iBistro/iLink Configuration

5. Click Save when you are finished making changes. The


new iBistro Test policy now appears in the Policy list:

Version 3.0, March 2006 87


Fundamentals of iBistro/iLink Customization

Create New User Profile and Environment Policies


A gateway is assigned through a user's Environment policy,
which is part of the User Profile policy.
To use the new test gateway, you must create new user
Environment and Profile policies.

To create these new policies

1. On the Configuration module toolbar, click the User


Configuration toolbar, and then click the User Profile

Policy wizard . The following window appears:

88 Version 3.0, March 2006


iBistro/iLink Configuration

2. Click WEBSERVER, and then click Copy. The


following window appears:

3. Type a new policy name, such as TEST. Click OK. The


following window appears:

Version 3.0, March 2006 89


Fundamentals of iBistro/iLink Customization

4. Click the Login Attributes tab, and then click the

Environment helper . A list of Environment


policies appears:

5. Select WEBSERVER, and then click Copy. The


following window appears:

90 Version 3.0, March 2006


iBistro/iLink Configuration

6. Type the new policy name (TEST), and click OK. The
following window appears:

7. In the Gateway database box, select the new gateway


policy you created in the previous exercise (TEST), and
click Save. The Login Attributes tab reappears.
8. Select the Environment policy you just created (TEST)
from the list, and click Save.
9. Click Close. These changes will take effect after you
halt and run the Unicorn servers.

Version 3.0, March 2006 91


Fundamentals of iBistro/iLink Customization

Create a New Environment File


You can customize the new test environment by modifying the
new gateway. You will also need to change some environment
variables.

To create a new environment file to use with the


new test environment

1. On the Reports module toolbar, click the Schedule New

Reports wizard .
2. If the properties window displays, click OK to accept
defaults.
3. Click the Administration tab. The following window
appears:

92 Version 3.0, March 2006


iBistro/iLink Configuration

4. Select the List Policies report and click Setup &


Schedule. A new window appears:

5. Click Run Now. A confirmation window appears:

6. Click Display Finished Reports.


7. Select List Policies in the Finished Reports list, and
click View.
8. The Finished Reports: View Reports window appears.
Click OK. The report should open in the word
processing application defined in your Reports session
settings.

Version 3.0, March 2006 93


Fundamentals of iBistro/iLink Customization

9. Scroll down to find the ENVIRONMENTS section;


below is a sample:

*ENVIRONMENTS
NAME DESCRIPTION
HELPS SCREENS KEYS WSCONFIG

1. ADMIN System Administrator


Generic Admin Ts NONE
Gateway: IBISTRO Search Source Group : ROOT
Log: NO
Search Output Limit: 10 Search Sort Limit: 200
Idle Timeout: NO Workstation Printer List: ALL
Report Printer List: ALL Default Command: Find Item Host Timeout: 105
Language: ENGLISH

2. GENERIC Generic
Generic Generic Generic NONE
Gateway: UNICORN Search Source Group : ROOT

...

24. TEST World Wide Web Server Access

Generic Public Generic NONE


Gateway: TEST Search Source Group : ROOT
Log: NO
Search Output Limit: 10 Search Sort Limit: 200
Idle Timeout: 120 Workstation Printer List: ALL
Report Printer List: ALL Default Command: Find Item Host Timeout: 105
Language: ENGLISH

10. Make note of the policy # before the TEST environment


created earlier (in the sample above, this is 24).
11. On your Unicorn server in the /Webcat/Config directory,
create a new file called envn#.env, substituting # with
the number just identified in the List Policies report
(envn24.env).

94 Version 3.0, March 2006


iBistro/iLink Configuration

Create a New User Login


Every time a user accesses iBistro/iLink, a user has logged into
the system. Typically, this is the WEBSERVER user.

To create a TEST user to access the new TEST


gateway and environment:

1. On the Circulation module toolbar, click the User


Information & Maintenance toolbar, and then click the

Copy User wizard .


2. Search for the WEBSERVER user record.
3. Type the new user ID (TEST), and click OK.
4. On the Basic tab, in the Name box, type a name such as
Test User. Change the profile name to the new one
created earlier (TEST).
5. Click the Privilege tab and make note of the PIN for this
user.
6. Click OK, and then click Close.

Version 3.0, March 2006 95


Fundamentals of iBistro/iLink Customization

Exercise 7: Move the Library Info box off of the


title bar, using the new TEST environment
1. On your server, locate the Unicorn/Webcat/Config
directory.
2. Open the envn#.env file created above, and type the
following line:

USE_TITLEBAR_LIBINFO|0|

3. Save your changes to the envn#.env file.


4. Log in to iBistro/iLink to view your changes. Use the
URL created above for the TEST login.
The Library Info box should now display below the
search box.

Exercise 8: Change the Library Slogan for the


new TEST environment.
1. On your server, locate the Unicorn/Webcat/Config
directory.
2. Copy the following lines from the ibistro.env file:

96 Version 3.0, March 2006


iBistro/iLink Configuration

#this phrase displays in the title bar after the gateway description
LIBRARY_SLOGAN|$<library_slogan>|

3. Paste these lines in the envn#.env file.


4. Change the value for the LIBRARY_SLOGAN variable:

#this phrase displays in the title bar after the gateway description
LIBRARY_SLOGAN|This is the TEST iBistro Environment|

5. Save your changes to the envn#.env file.


6. Log in to iBistro/iLink to view your changes. Use the
URL created above for the TEST login.

Note the new library slogan on the iBistro/iLink interface:

NOTE We will discuss another way to change the


Library Slogan in the “Labels and
Messages” section on page 108.

Version 3.0, March 2006 97


Fundamentals of iBistro/iLink Customization

Automate the Login Process with a New URL


Now that all of the pieces are in place, you can create a URL that
automatically passes the new login and PIN information to the
server. Later, you can use this URL to test changes that you
make to the new gateway and environment.
1. Create a URL that will automatically login the new
TEST user you created. The URL you create should look
something like this:

(UNIX)
http://mywebcat.library.org/uhtbin/cgisirsi/x/0/57/49?user_id=####&password=####

(WINDOWS)
http://mywebcat.library.org/uhtbin/cgisirsi.exe/x/x/0/57/49?user_id=####&password=####

2. Replace the number symbols (####) with the default


user ID and PIN or password to be used when logging
in.

98 Version 3.0, March 2006


iBistro/iLink Configuration

iBistro/iLink Image Files


iBistro/iLink images are categorized into five groups.
• Buttons
• Gateway Icons
• Other
• Rootbar
• Special

Delivered Image Files


The /Unicorn/Webcat/Images_deliv/English directory contains
the delivered image folders.

Buttons
The Buttons folder contains Bistro, Khaki, Link, Rust, Teal and
Violet image set directories, and includes such toolbar images as
and .

Gateway Icons
The Gateway_icons/Photo folder contain images used for
gateway elements in Kids’ Library, Find It Fast, and Have
You Read?. There are over 1,000 images in this directory.

Other
The Other folder contains the Misc, Miscib, Miscil, and Misck12
image set directories, which include miscellaneous graphics. It
also contains the library logo, which is delivered on iBistro as:

Version 3.0, March 2006 99


Fundamentals of iBistro/iLink Customization

Rootbar
The Rootbar folder contains Bistro, Khaki, Link, Rust, Teal, and
Violet image set directories. These images are used if
iBistro/iLink is configured to include Rootbar images instead of
Cascading Style Sheets.

Special
The Special folder contains Bistro, Khaki, Link, Rust, Teal and
Violet image set directories and includes such content images as
(URL2) and (Review). The Bistro set is almost
completely graphical, and the others use text images with a
bullet (for example, and ).

Directory Structure
The expected directory structure of /Webcat/Images_custom
mimics that of Webcat/Images_deliv. System administrators who
intend to use custom images must create the exact directory
structure of /Images_deliv in /Images_custom.

100 Version 3.0, March 2006


iBistro/iLink Configuration

Environment Files – Working with Images


SirsiDynix delivers several image sets for use with iBistro/iLink
images. These image sets let you change the delivered color
scheme for buttons and other graphics. The buttons and special
groups of images include Bistro, Khaki, Link, Rust, Teal and
Violet image sets.

Exercise 9: Change the toolbar image set


1. On your server, locate the Unicorn/Webcat/Config
directory.
2. Copy the following lines from the ibistro.env file:

# Source of images
IMG_BUTTONS|Bistro|

3. Paste these lines in the system.env file.


4. Change the value for the IMG_BUTTONS variable.

# Source of images
IMG_BUTTONS|Violet|

5. Save your changes to the system.env file.


6. Log in to iBistro/iLink to view your changes.

Version 3.0, March 2006 101


Fundamentals of iBistro/iLink Customization

Exercise 10: Change the image set used for


Content Enrichment features like summaries,
URLs, reviews, etc.
1. On your server, locate the Unicorn/Webcat/Config
directory.
2. Copy the following line from the ibistro.env file:

IMG_SPECIAL|Bistro|

3. Paste this line in the system.env file.


4. Change the value for this variable.

IMG_SPECIAL|Link|

5. Save your changes to the system.env file.


6. Log in to iBistro/iLink to view your changes.

102 Version 3.0, March 2006


iBistro/iLink Configuration

Putting Images on the Webserver


The setup_webcat script copies the directory structure of
/Images_deliv and /Images_custom to the webserver file system.
The new image directories are found in the following locations:
Windows systems

C:\Program Files\Apache Group\Apache2\Htdocs\Webcat_Images

UNIX systems

/var/apache/WebCat_Images

Before running the setup_webcat script, UNIX sites should enter


their default settings:
1. On the Configuration module toolbar, click the Common
Tasks toolbar, and then click the OPAC Administration

wizard . The following window appears:

2. Make any corrections, click Save, and then click Close.

Version 3.0, March 2006 103


Fundamentals of iBistro/iLink Customization

Manually Copying Images to the Webserver


The browser does not have permission to read the image files or
enter the directory to read the files. The setup_webcat script sets
the permissions of directories and files in the following way, and
so should the system administrator if images are copied
manually.

To verify/set permissions for files and folders on


Windows systems
1. Using Windows Explorer, select the file or folder, and
then right-click.
2. Select Properties. The Properties window appears.
3. On the General tab, in the Attributes section, click
Advanced.
4. Verify that the attributes look like the following:

Files

104 Version 3.0, March 2006


iBistro/iLink Configuration

Folders

5. Click OK and then click Apply. Click OK again.

Version 3.0, March 2006 105


Fundamentals of iBistro/iLink Customization

To verify permissions for files and directories on


UNIX systems:
• If the element is a file, type the following:

chmod 744 filename

The permissions should look like this:

-rwxr--r-- 1 sirsi staff 204 Jan 8 10:00 EXIT.gif

• If the element is a directory, type the following:

chmod 755 directoryname

The permissions should look like this:

drwxr-xr-x 2 sirsi staff 1024 Jan 8 10:00 Bistro

106 Version 3.0, March 2006


iBistro/iLink Configuration

Exercise 11: Replace the delivered logo image on


the title bar with your own custom image
The delivered image is called LIBLOGO.gif.
• For systems using iBistro, the image is located in the
Unicorn/Webcat/Images_deliv/English/Other/Miscib
directory.
• For systems using iLink, the image is located in the
Unicorn/Webcat/Images_deliv/English/Other/Miscil
directory.

Add your library image to the custom images in the Unicorn


directory, as well as to the image directory on the webserver.
1. On your server, locate the Unicorn/Webcat/Config
directory.
2. Verify the image set referenced for the IMG_OTHER
variable in the system.env file. If this variable is not in
the system.env file, verify the default image set for the
IMG_OTHER variable in the ibistro.env file. Typically,
this variable is delivered as IMG_OTHER|Miscib| for
iBistro and IMG_OTHER|Miscil| for iLink.
3. Place your own custom image in the appropriate image
set directory under
Unicorn/Webcat/Images_custom/English/Other.
4. Name the image in this folder LIBLOGO.gif.
5. Run the setup_webcat script. Before doing this, Unix
sites must follow the Prepare Webcat steps on p. 103.
Windows sites will be prompted to enter their default
settings when they run the script:

6. Log on to iBistro/iLink to view your changes.

Version 3.0, March 2006 107


Fundamentals of iBistro/iLink Customization

Labels and Messages


Unicorn uses labels and messages to display text in both
iBistro/iLink and WorkFlows. The delivered files are called
Labels and Messages and are located in the
Unicorn/Language/Deliv/English directory on the server. These
delivered files contain labels and messages current to the
Unicorn release. Do not edit these files, because Unicorn
overwrites these files during upgrades. Instead, put custom labels
and messages files in the Unicorn/Language/Custom/English
directory on the server. Unicorn does not overwrite these files
during upgrades.
The ibistro.env file and page files reference labels and messages
when displaying the iBistro/iLink pages. You can examine
ibistro.env and page files to help determine what you want to
customize.
For example, the title bar in iBistro/iLink displays a library
slogan that is controlled by the ibistro.env and labels files.
LIBRARY_SLOGAN is a variable in the ibistro.env file:

LIBRARY_SLOGAN|$<library_slogan>|

This variable references a label in the Labels file:

library_slogan||Your Electronic Library on the


Web|#iBistro

By changing the text of the label in the Labels file, you can insert
a new library slogan into the title bar of iBistro/iLink.

NOTE Be sure to halt and run the Unicorn servers


after customizing the labels and messages
files.

Changes to the Messages file are done the same way as changes
to the Labels file.

108 Version 3.0, March 2006


iBistro/iLink Configuration

FAQ: Can I make label changes in the system.env


file instead of the labels file?
Rather than changing the label in the Labels file, you can display
custom text in iBistro/iLink by copying the appropriate variable
from ibistro.env into system.env, as demonstrated in Exercise 8
of this training guide. For example, you can change the library
slogan by pasting the LIBRARY_SLOGAN variable into the
system.env file and changing the value as follows:

LIBRARY_SLOGAN|Welcome to the Library’s online catalog|

However, this method is not appropriate if your iBistro/iLink is


configured to use multiple languages. There are several Labels
files in the Language directory that lets you create custom labels
for multiple languages. Changing labels in the system.env file
affects all iBistro/iLink pages. Therefore, if your iBistro/iLink is
configured to use multiple languages or if you ever plan to add
languages in the future, you should make all label changes in the
Labels file.

Version 3.0, March 2006 109


Fundamentals of iBistro/iLink Customization

Exercise 12: Change the label for the hyperlink to


Power Search
1. If you do not already have a
Unicorn/Language/Custom/English directory on your
Unicorn server, create one.
2. In this directory, create a new file named Labels.
3. On your server, locate the Labels file in the
Unicorn/Language/Deliv/English directory on your
server.
4. Copy the following line from the Labels file:

alttext_powersrch||Power Search|#iBistro

5. Paste this line into the Labels file in the


Unicorn/Language/Custom/English directory.
6. Change the value for this variable.

alttext_powersrch||Advanced Search Options|#iBistro

7. Save your changes to the Labels file.


8. Halt and run the Unicorn servers.
9. Log in to iBistro/iLink to view your changes.

110 Version 3.0, March 2006


iBistro/iLink Configuration

Exercise 13: Change the title of the What Others


are Reading box
1. On your server, locate the
Unicorn/Language/Deliv/English directory.
2. Copy the following line from the Labels file:

what_others_read||What Others Are Reading|#iBistro

3. Paste this line into the Labels file in the


Unicorn/Language/Custom/English directory.
4. Change the value for this variable.

what_others_read||What's popular|#iBistro

5. Save your changes to the Labels file.


6. Halt and run the Unicorn servers.
7. Log in to iBistro/iLink to view your changes.

Version 3.0, March 2006 111


Fundamentals of iBistro/iLink Customization

Exercise 14: Change the iBistro/iLink timeout


message
1. On your server, locate the
Unicorn/Language/Custom/English directory.
2. In this directory, create a new file named Messages.
3. Locate the Messages file in the
Unicorn/Language/Deliv/English directory.
4. Copy the following line from the Messages file:

13131|Session has timed out. Please click OK to start a new OPAC session||

5. Paste this line into the Messages file in the


Unicorn/Language/Custom/English directory.
6. Change the value for this variable.

13131|Session has timed out. Please click OK to restart iBistro||

7. Save your changes to the Messages file.


8. Halt and run the Unicorn servers.
9. Log in to iBistro/iLink to view your changes.

112 Version 3.0, March 2006


iBistro/iLink Configuration

Version 3.0, March 2006 113


Appendix A –
ibistro.env
# Copyright (c) 2000 - 2005, Sirsi Corporation.
#
# This is the deliverable iBistro environment file
#

# titlebar.h
TITLE|iBistro at ...| # Title displayed at top of each page
# name of the gif file displayed in the titlebar; make this blank for no icon
# image is from directory defined in IMG_OTHER environment parameter below
LIBLOGO|LIBLOGO|
WEBCAT_NAME|[$<opac_name>]|
# this phrase displays in the title bar after the gateway description
LIBRARY_SLOGAN|$<library_slogan>|
# this phrase displays in the copyright area after the iBistro logo
TAGLINE|$<ibistro_tagline>|
COPYRIGHT_STATEMENT|$<copyright_statement_opac>| # revC only

# Http server's address. If a port number is required, specify it.


# However, it is recommended that if the port number is 80, the default
# WWW port number, it should not be explicitly specified here. This is
# because of Netscape Javascript problems that can prevent some WebCat
# functionality from working for Netscape users.
# Examples: "your.addr.edu" or "your.addr.edu:5001".
HTTP_ADDRESS||
USE_FULL_HTTP_ADDRESS|1|
HTTP_PROTOCOL|http|
HOME_URL|| # URL to go to when EXIT button is pressed
USECVT|1| #do 8-bit hex code conversion

# Defines the directory under Pages_deliv or Pages_custom in which the page


# files to use are located.
PAGES_SET|Elib_revC|

# Set to 1 enable Webcat/Logs/yyyymmdd.weblog statistical usage logging,


# or to 0 to disable it.
USAGE_LOGGING|0|

# WebCat page expiration date. Set in the past, it prevents browsers and
# proxy servers (e.g., AOL's) from caching WebCat pages. WebCat will not work
# correctly if cached pages are used.
HTTP_EXPIRES|Thu, 29 Feb 1996, 10:27:00 GMT|

# Holds the web_authentication valued passed by CGI


WEB_AUTHENTICATION||

# Holds the authority and station lib


WEBAUTH_UASC|SIRSI|
WEBAUTH_STALIB|MAIN|

# Source of images
IMAGE_PATH|/WebCat_Images|
IMG_ACCSTAB|Bistro|
IMG_BUTTONS|Bistro|
IMG_GATEICON|Photo|
IMG_OTHER|Miscib|
IMG_ROOTBAR|Bistro|
IMG_SPECIAL|Bistro|
IMG_SRCHICON|Bistro|

IMG_ARCHICON|/WebCat_Images/Archicons

Version 3.0, March 2006 114


Appendix A –iBistro.env

# Languages supported.
# Sample: WEBCAT_LANGUAGES|ENGLISH:English,SPANISH:Spanish,CHINESE:Chinese|
WEBCAT_LANGUAGES||

# Configure Virtual Reference integration


# The following environment variables control the integration
# of virtual reference into iBistro.
# The following values are used for the VIRTUAL_REFERENCE variable:
# 0 - virtual reference not available
# 1 - a link to virtual reference is integrated into the rootbar
# 2 - a virtual reference textarea is positioned in the titlebar
VIRTUAL_REFERENCE|0| # revC only
#VIRTUAL_REFERENCE|1| # revC only
#VIRTUAL_REFERENCE|2| # revC only
VREFERENCE_LIVESERVER|| # revC only
VREFERENCE_LIVEQUEUE|| # revC only
VREFERENCE_LIVEDOMAIN|| # revC only
VREFERENCE_LIVEPARTITION|| # revC only
ASK_VREFERENCE|$<ask_vreference>| # revC only

# Directory for URLs to temporary WebCat files


WEBCAT_TMP_DIR|/WebCat|

# alt text for hidden link that lets screen readers skip rootbar and buttonbar
# navigation
SKIPNAVTEXT|$<skip_nav>|

# Font configuration
FONT_FACE|Verdana, Helvetica, Arial, sans-serif|
ROOTBAR_FONT_FACE|Verdana, Helvetica, Arial, sans-serif| # revC only
FONT_FACE_MONO|"Courier New", Courier, monospace| #Font face for
unformatted text (revC only)
FONT_SIZE|12px| #Default font size
(revC only)
FONT_SIZE_MD|11px| #Font size for medium text (revC
only)
FONT_SIZE_SM|10px| #Font size for small text (revC
only)
FONT_SIZE_TITLE_BAR|14px| #Font size for large titlebar (revC only)

# Color configuration

# Use hex values for the selection of colors (#000000 to #FFFFFF).


#
# Newer workstations are able to display thousands (even millions)
# of colors, but there are only 216 colors that are considered web-safe.
#
# Browser-safe colors contain the 00, 33, 66, 99, CC, and FF values
# in each of the paired digits of the RGB spectrum.
#
# A workstation that displays only 256 colors will dither hex values
# other than ones in the web-safe palette.
#
# A good practice is to test your configuration on a workstation that
# is typical to your target audience.

ACCOUNT_HEADING_BGCOLOR|#CCFFFF| # cyan
ACCOUNT_STRIPE_BGCOLOR|#EEEEEE| # pale gray
ANNOUNCE_BGCOLOR|#FFCC33| # lt yellow-orange (revC only)
BESTSELL_BGCOLOR|#006699| # denim blue
BIBSTRIPE_BGCOLOR|#EEEEEE| # pale gray
BLASTOFF_COLOR|#FFFF99| # yellow (revC only)
BODY_BGCOLOR|#FFFFFF| # white (revC only)
BODY_COLOR|#000000| # black (revC only)
BUTTONBAR_BGCOLOR|#0099CC| # lt denim blue
BUTTONBAR_COLOR|#FFFFFF| # white (revC only)
CONTENT_BGCOLOR|#FFFFFF| # white (revC only)
CONTENT_COLOR|#000000| # black (revC only)
ENRICH_STRIPE_BGCOLOR|#CCFFFF| # cyan
ENRICHCONTENT_BGCOLOR|#FFFFFF| # white (revC only)

Version 3.0, March 2006 115


Fundamentals of iBistro/iLink Customization

ENRICHCONTENT_COLOR|#000000| # black (revC only)


ENRICHHEADER_BGCOLOR|#FFFFFF| # white (revC only)
ENRICHHEADER_COLOR|#996600| # med brown (revC only)
ENRICHTAGLINE_BGCOLOR|#FFFFFF| # white (revC only)
ENRICHTAGLINE_COLOR|#888888| # medium gray (revC only)
ERROR_COLOR|#CC0000| # maroon (revC only)
FORM_BGCOLOR|#CCCCFF| # lavender
GATELIST_BGCOLOR|#FFFFFF| # white
GATELIST_HEADING_COLOR|#CCFFFF| #
GATELIST_LINE_COLOR|#EEEEEE| # pale gray
GATELIST_STRIPE_COLOR|#EEEEEE| # pale gray
HEADER_BGCOLOR|#006699| # medium blue (revC only)
HEADER_COLOR|#FFFFFF| # white (revC only)
HOLDINGSSTRIPE_BGCOLOR|#CCCCCC| # med gray
HOLDINGSHEADER_BGCOLOR|#FFFFFF| # white (revC only)
HOLDINGSHEADER_COLOR|#006699| # medium blue (revC only)
HOLDINGSLIST_BGCOLOR|#FFFFFF| # white (revC only)
HOLDINGSLIST_COLOR|#000000| # black (revC only)
HOTURLS_BGCOLOR|#006699| # med denim blue
ITEMLISTING_BGCOLOR|#FFFFFF| # white (revC only)
ITEMLISTING2_BGCOLOR|#EFEFEF| # light gray (revC only)
LANGICON_BGCOLOR|#FFFFFF| # white (revC only)
LCCATS_BGCOLOR|#006699| # med denim blue
LIBINFO_BGCOLOR|#006699| # med denim blue
LISTNUM_BGCOLOR|#99CCFF| # med azure
LISTSTRIPE_BGCOLOR|#EEEEEE| # pale gray
MARCHEADER_BGCOLOR|#FFFFFF| # white (revC only)
MARCHEADER_COLOR|#996600| # gold (revC only)
MARCTAG_BGCOLOR|#FFFFFF| # white (revC only)
MARCTAG_COLOR|#000000| # black (revC only)
MYFAVAUTH_BGCOLOR|#006699| # med denim blue
MYFAVSUBJ_BGCOLOR|#0099CC| # lt denim blue
MYFAVS_BGCOLOR|#006699| # med denim blue
ORDERSSTRIPE_BGCOLOR|#FFCCCC| # pink
PAGETOP_BGCOLOR|#CCCCFF| # lavender
PAGECONTAINER_BGCOLOR|#FFFFFF| # white (revC only)
PAGECONTAINER_COLOR|#000000| # black (revC only)
POPAUTHORS_BGCOLOR|#0099CC| # lt denim blue
POPSUBJECTS_BGCOLOR|#006699| # med denim blue
POPTITLES_BGCOLOR|#006699| # med denim blue
POPTOP_BGCOLOR|#006699| # med denim blue
POPTOP_HOTTEXT_COLOR|#FF0000| # red
RECREAD_BGCOLOR|#006699| # med denim blue
ROOTBAR1_BGCOLOR|#FFFFFF| # white
ROOTBAR_COLOR|#FFFFFF| # white (revC only)
ROOTBAR_BGCOLOR|#006699| # med denim blue (revC only)
RSVSTRIPE_BGCOLOR|#EEEEEE| # pale gray
RSVHOLDINGS_BGCOLOR|#EEEEEE| # pale gray (revC only)
RSVHOLDINGS_COLOR|#000000| # black (revC only)
SEARCHBOX_BGCOLOR|#EEEEEE| # pale grey (revC only)
SUBHEADER_BGCOLOR|#EEEEEE| # pale grey (revC only)
SUBHEADER_COLOR|#000000| # black (revC only)
TAB_BORDER_COLOR|#999999| # dark grey (revC only)
TAB_BGCOLOR|#006699| # med denim blue (revC only)
TAB_COLOR|#FFFFFF| # white (revC only)
TAB_HOVER_COLOR|#006699| # med denim blue (revC only)
TAB_HOVER_BGCOLOR|#EEEEEE| # pale grey (revC only)
TITLEBAR_BGCOLOR|#006699| # med denim blue (revC only)
TITLEBAR_TEXT_COLOR|#FFFFFF| # white
XREFSTRIPE_BGCOLOR|#EEEEEE| # pale gray
XREFS_BGCOLOR|#CCCCFF| # lavender

# defined in style sheet


LINK_COLOR|#006699| # blue
VISITED_COLOR|#006699| # blue (revC only)
HOVER_COLOR|#FF0000| # red
HOVER_BGCOLOR|#FFFFCC| # yellow

# these ROOTBAR_ variables only used when USE_ROOTBAR_CSSTEXT is 1


ROOTBAR_TEXT_COLOR|#FFFFFF| # white
ROOTBAR_LINK_COLOR|#FFFFFF| # white

116 Version 3.0, March 2006


Appendix A –iBistro.env

ROOTBAR_HOVER_COLOR|#FFFFFF| # white
ROOTBAR1_TEXT_COLOR|#006699| # med denim blue
ROOTBAR1_LINK_COLOR|#006699| # med denim blue
ROOTBAR1_HOVER_COLOR|#FF0000| # red

# calendar colors
MONTHYEAR_COLOR|#006699| # med denim blue
WEEKHEAD_COLOR|#006699| # med denim blue
WEEKEND_COLOR|#EFEFEF| # light gray
WEEKDAY_COLOR|#FFFFFF| # white
CALENDARFONT_COLOR|#000000| # black
CALENDARSELDATE_COLOR|#CCCCFF| # lavender

# Number of seconds of inactivity before resetting session


SESSION_TIMEOUT|900|

# If cookies are used for logging into WebCat, then how many minutes
# of inactivity should occur before the cookies are deleted from the user's
# browser? A value of 0 means that the cookie will exist only for the life
# of the browser window (i.e., a non-persistent cookie).
LOGIN_COOKIE_EXPIRATION|1440|

# Images for Gateway Root Bar


RB_IMG_ARCHIVE|RBARCH|
RB_IMG_ARCH_BROWSE|RBHIER|
RB_IMG_ARCH_SEARCH|RBSEARCH|
RB_IMG_KNOWLEDGE_PORTAL|RBPORTAL|
RB_IMG_LIB_CATALOG|RBBASIC|
RB_IMG_MY_ACCOUNT|RBUSERV|
RB_IMG_NEEDMATERIAL|RBREQUEST|
RB_IMG_FAST|RBFAST|
RB_IMG_REFLIB|RBREFLIB|
RB_IMG_KIDSLIB|RBKIDS|
RB_IMG_RESERVE_DESK|RBRSV|
RB_IMG_CONTACT_US|RBUS|

# Specific references to gateway elements or groups


# specifies what gateway contains the INFO_DESK_TOP elements
INFO_DESK_GATE|IBISTRO|
# specifies what group to display in the Library Info box on the opening page
INFO_DESK_TOP|LIB_INFO|
# specifies what group to display when Power Search is selected
GATE_POWER_SEARCH|POWER_SEARCH|
# specifies what element to search for Web Resources
Z3950_ICON_SEARCH|SITE_SOURCE|
# specifies what gateway group to search for Broadcast searching
Z3950_BROADCAST_GROUP|ZBROADCAST_GROUP|

# iBistro Enrichment File Location, server side


ENRICHMENT_URL|http://content.sirsi.net/uhtbin/getenrich
# iBistro Enrichment File Location, browser side
BROWSER_ENRICHMENT_URL|http://content.sirsi.net/uhtbin/getenrich
# XML Enrichment Index Location
CHECK_ENRICHMENT_URL|http://enrichment.sirsi.net/checkenrich/checkenrich

# Misc message
ERRMSG_UNDEF_STATE|$(13451) $(13452)|

# Flag for whether to include "ALL" in list of libraries for searching


USE_LIBRARY_ALL|1|

# Flag for whether to use the "HERE" library


USE_LIBRARY_HERE|0|

# Flag for whether to use policy names (0) or descriptions (1) in pull-downs
USE_POLICY_DESCRIPTIONS|1|

# Flag for whether this is a Chinese system.


SINO_TRANSLATION_SYSTEM|0|

Version 3.0, March 2006 117


Fundamentals of iBistro/iLink Customization

# Flag needs to be 0 for Chinese searching.


UPPERCASE_SEARCH|1|

# Electronic Books Configuration


#
# Subscription-only ebooks are available only after
# the library has set up an account with ebook vendor such as netLibrary,
# ebrary, BWI/Follett.
#
# The catalog may offer other ebook records containing URLs for free sites
# such as Project Gutenberg, Bartleby.com, Blackmask, BookRags, or the
# Library of Southern Literature.
#
# Turns on the ebook searching feature on the front page
CFG_EBOOKS|0|
# Text displays with a checkbox to limit search to ebooks only
EBOOKS_ONLY_LABEL|$<search_ebooks>|
# Qualifying item type #1 for limiting search to ebooks only
EBOOK_TYPE1|E-BOOK|
# Qualifying item type #2 for limiting search to ebooks only
EBOOK_TYPE2||
# Qualifying item type #3 for limiting search to ebooks only
EBOOK_TYPE3||
# Qualifying item type #4 for limiting search to ebooks only
EBOOK_TYPE4||
# Qualifying item type #5 for limiting search to ebooks only
EBOOK_TYPE5||

# netLibrary Configuration
NETLIBRARY_EBOOKS|0|
# Fields hold account information (different for every library)
NETLIBRARY_ACCTID|| # netLibrary-assigned account ID
NETLIBRARY_SIGKEY|SIRSI1012600| # netLibrary-assigned signature key
NETLIBRARY_ENCKEY|SIRSI102600\$\$\$\$\$| # netLibrary-assigned encryption key
# these variables provide the ALT= text that appears over the button graphics
ALTTEXT_EPREVIEW|$<netLibrary_preview>|
ALTTEXT_ECHECKOUT|$<netLibrary_checkout>|
ALTTEXT_EBOOK|$<alttext_ebook:u>|

# BWI/Follett Configuration
BWIFOLLETT_EBOOKS|0|

# ebrary URL access information (different for every library)


#EBRARY_URL_LIBRARY|http://site.ebrary.com/lib/sitename|

# CLCD Configuration
CLCD_URL|http://clcd.odyssi.com/cgi-bin/sirsi/search/r?dbs+child:@term+@isbn+|
ALTTEXT_CLCD|$<alttext_clcd>|

# Content display flags


# Basic content set to display by default
# Premium content set to hidden by default
DISP_CONTENT_AUTHOR_BIO|1|
DISP_CONTENT_BLREVIEW|1|
DISP_CONTENT_BLURB|1|
DISP_CONTENT_BOOKWRAP|1|
DISP_CONTENT_CLCD|1|
DISP_CONTENT_CHREVIEW|1|
DISP_CONTENT_COVER_FULL|1|
DISP_CONTENT_COVER_GIF|1|
DISP_CONTENT_EXCERPT|1|
DISP_CONTENT_LJREVIEW|1|
DISP_CONTENT_REVIEW|1|
DISP_CONTENT_SLJREVIEW|1|
DISP_CONTENT_SUMMARY_AC|1|
DISP_CONTENT_SUMMARY|1|
DISP_CONTENT_TOC|1|
DISP_CONTENT_EBRARY|0|

# NoveList Configuration

118 Version 3.0, March 2006


Appendix A –iBistro.env

# icons can display, but without NoveList subscription cannot be viewed.


# Contact EBSCO's technical support for questions concerning the values
# for NOVELIST_URL_START, NOVELIST_CUSTID, NOVELIST_AUTHTYPE and
# NOVELIST_URL_END.
NOVELIST_LINK|0|
# NoveList URL
NOVELIST_URL_START|http://search.epnet.com/Login.aspx?| # EBSCO designated URL
# NoveList access information (different for every library)
NOVELIST_CUSTID|custid=****| # EBSCO assigned customer account ID
#
NOVELIST_AUTHTYPE|&authtype=****| # EBSCO designated authtype
#
# EBSCO designated string
NOVELIST_URL_END|&profile=novelist&nllink=true&nlboolean=IB+|
#
ALTTEXT_NOVELIST|$<alttext_novelist>|

# Gateway menu icon table parameters -- 1.pg #not valid in iBISTRO


ICON_COLUMNS|5|
USE_ICON_DESC|1|

# Gateway menu labels -- 1.pg


CHECKLIST_PROMPT|$<choose_one>:|

# Gateway Relational Alias parameters -- 1.pg


BUTTON_MORE_SEARCHES|MORESRCH.gif|

# Gateway Help label -- 2.pg


HELPHEADER|$<help:u> -- |

# iBistro use flags -- 3.pg


# display My Favorite... on opening page to PERSONAL-access user
IBISTRO_MYFAVS_CONFIG|1|
# display the What Others Are Reading[Most Popular] box on opening page
IBISTRO_MOSTPOP_CONFIG|1|
# display the Hot Sites box on opening page
IBISTRO_HOTSITES_CONFIG|1|
# display locally defined web sites defined in file HOT_WEB_FILE
USE_LOCAL_HOTWEB|0|
# display locally defined web sites from this Unicorn/iBistro file
HOT_WEB_FILE||
# display link in Hot Sites box going to Web Resources category searches page
IBISTRO_WEBRESOURCES_CONFIG|0|
# display the Best Sellers box on opening page
IBISTRO_BESTSELL_CONFIG|1|
# display the specified Best Seller list
BESTSELL_CONFIG_LIST|BEST_SELL|
# display the Recommended Reading box on opening page
IBISTRO_RECREAD_CONFIG|1|
# display the specified Recommended Reading list
RECREAD_CONFIG_LIST|REC_READ|
# offer Recommend Purchase option for items not held or with a long wait
USE_RECPURCH_ICON|1|
# display the Lib Info box on opening page
IBISTRO_LIBINFO_CONFIG|1|
# display x LibInfo/Announcement entries on opening page
LIBINFO_LISTLEN|4|

# BUYNOW options offer patrons a link to an online bookstore when an item


# is not held by the library system or is currently unavailable. Values:
# 0 - do not offer the BUY NOW option anywhere
# 1 - offer the library-configurable BUY NOW option using the
# online bookstore definitions in BUYNOW_URL_PT1 and BUYNOW_URL_PT3.
# 2 - offer the automatic BN.com partnership link so a portion of any
# purchase is automatically returned to the library. Does not apply
# to Recommended Reading lists. Requires that a Unicorn/Config/site_id
# file exist that contains the Sirsi customer code so that any
# purchased made through that link may be credited to that library
# and appropriate distribution of purchase price percentages made be
# made.

Version 3.0, March 2006 119


Fundamentals of iBistro/iLink Customization

USE_BUYNOW_ICON|2|
# display the BUY NOW icon in catalog displays only when no copies available
USE_BUYNOW_NOTAVAILABLE|0|
# display the Lib Info box in the titlebar (displays below otherwise)
USE_TITLEBAR_LIBINFO|1|
# display the Login box either in the titlebar or below the search area
USE_LOGIN|1|
# display the Login box in the titlebar (displays below otherwise as Login/Favs)
USE_TITLEBAR_LOGIN|1|
# on initial login or failed login (48.pg), offer a button to the HOME_URL
# default button label is defined in LOGIN_HOME_URL_LABEL
USE_LOGIN_HOME_URL|0|
# rootbar with Cascading Style Sheet text rather than rootbar graphics
USE_ROOTBAR_CSSTEXT|1|
# display the Try These Too (X-Refs) box on hit list and view pages
IBISTRO_TRYTHESEXREFS_CONFIG|1|
# display the You Found Titles in Categories box on hit list and view pages
IBISTRO_LCCATS_CONFIG|1|
# display a background image behind the main page.
# image must be in the Images_custom/*/Other/*/ directory.
USE_BG_IMAGE|0| # revC only
# provide full background image name, like campus.gif
BG_IMAGE_NAME|| # revC only

# Sirsi SingleSearch / Other Resources


# launches a new window that allows patrons to search multiple designated
# resources all at once.
# URL to be used for SingleSearch/Other Resources requests
SINGLE_SEARCH_URL||
# user id for the SingleSearch/Other Resources requests
SINGLE_SEARCH_USERID||
# password for the SingleSearch/Other Resources requests
SINGLE_SEARCH_PASSWORD||
# if SingleSearch/Other Resources is configured, use this text in the link
OTHER_RESOURCES_LABEL|$<other_resources>|

# Sirsi OpenURL Resolver


# retrieves information linked to a bibliographic citation.
# URL for the OpenURL Resolver
OPEN_URL||
# if Resolver is configured, offer patrons this Resolver link on search pages
CFG_OPENURL_ARTICLE_LOOKUP|0|
# with this text for the article lookup link
OPENURL_ARTICLE_LOOKUP_LABEL|$<lookup_journal_articles>|
# if Resolver is configured, offer patrons this Resolver link on search pages
CFG_OPENURL_PERTITLES_AZ|0|
# with this text for the journal titles link
OPENURL_PERTITLES_AZ_LABEL|$<journal_titles_atoz>|
# on single item view, an ISSN produces this text display for a journal Resolver link
OPENURL_JOURNAL_LINK_LABEL|$<look_links_full_text>|
# on single item view, an ISBN produces this text display for a monograph Resolver link
OPENURL_MONOGRAPH_LINK_LABEL|$<other_links>|

# iBistro front page labels -- 3.pg


BEST_SELLERS_LIST_LABEL|$<best_sellers_list>|
HOT_SITES_LIST_LABEL|$<hot_sites_list>...|
LIB_INFO_DESC|$<LIB_INFO_DESC>|
RECOMMENDED_READING_LIST_LABEL|$<rec_reading_list>|
SEARCH_FOR|$<D531:u>|
SEARCH_ACROSS|$<search_across>| # revB only
SEARCH_IN|$<D273:L>| # revB only
CATALOG_LABEL|$<catalog:u>|

USE_SEARCH_HISTORY|0|
SEARCH_HISTORY_LABEL|$<previous_searches:u>|
SEARCH_HISTORY_PROMPT|$<choose_prev_query>|

120 Version 3.0, March 2006


Appendix A –iBistro.env

# Flag to turn on eLearning button from MindLeaders. Requires a subscription to


access courses.
# ** requires Microsoft Internet Explorer 5.0 or higher and Macromedia Flash **
#ELEARNING_CONFIG|0|
# eLearning from MindLeaders catchtms JSP
#ELEARNING_CATCHTMS_JSP|http://courses.mindleaders.com/dpec/shared/tms/tms.htm?aicc_url=
http://127.0.0.1/dpec/shared/tms/catchtms.jsp
# eLearning from MindLeaders URL login JSP
#ELEARNING_LOGIN_JSP|http://courses.mindleaders.com/dpec/login.jsp
# eLearning from MindLeaders' site id. This will be different for every library.
#ELEARNING_SITE_ID||
#ELEARNING_GROUP_ID||
# eLearning from MindLeaders alternate text
#ALTTEXT_ELEARNING|eLearning $<from> MindLeaders|
# eLearning from MindLeaders create account timeout
#ELEARNING_TIMEOUT|3000|
# eLearning from MindLeaders unsupported browser
#ELEARNING_UNSUPPORTED_BROWSER|$<elearning_browser_msg>|
# eLearning login explanations
#ELEARNING_EXPLAIN1|Access to eLearning courses from MindLeaders is available through
your library.|
#ELEARNING_EXPLAIN2|This feature requires Microsoft Internet Explorer 5.0 and higher and
Macromedia Flash.</p><p>|
#ELEARNING_EXPLAIN3|Each user must have a personal MindLeaders account.|
#ELEARNING_EXPLAIN4|A user may sign up for a free account below.|
#ELEARNING_EXPLAIN5|After successfully completing the registration you will see a new
window. Please close the window and use the Go to eLearning Courses button to start
taking a course.|
#ELEARNING_EXPLAIN6|If you have already signed up, please use the Go to eLearning
Courses button to start or continue taking eLearning courses through your library.|

# Catalog Search Options use flags -- 3_search.h

# DEFAULT_QUERY_TYPE can be set to either BASIC_SEARCH, BASIC_BROWSE,


# BASIC_EXACT, BASIC_TERM, SINGLE_SEARCH, SINGLE_BROWSE, SINGLE_EXACT, or
# SINGLE_TERM.
DEFAULT_QUERY_TYPE|SINGLE_SEARCH|

# Flag causes the library search qualifier to appear (default:SEARCH_LIBRARY)


USE_SOPT_LIBRARY|1|
# Flag causes the publication year search qualifier to appear
USE_SOPT_PUBYEAR|1|
# Flag causes the language search qualifier to appear (default: SEARCH_LANGUAGE)
USE_SOPT_LANGUAGE|1|
# Flag causes the format search qualifier to appear (default:SEARCH_FORMAT)
USE_SOPT_FORMAT|1|
# Flag causes the item type search qualifier to appear (default:SEARCH_ITEM_TYPE)
USE_SOPT_ITEM_TYPE|1|
# Flag causes the location search qualifier to appear (default:SEARCH_LOCATION)
USE_SOPT_LOCATION|1|
# Flag causes the item category1 search qualifier to appear (default:SEARCH_ITEM_CAT1)
USE_SOPT_ICAT1|1|
# Flag causes the item category2 search qualifier to appear (default:SEARCH_ITEM_CAT2)
USE_SOPT_ICAT2|1|
# Flag causes the match on search qualifier to appear (default:SEARCH_MATCH_ON)
USE_SOPT_MATCH_ON|1|
# Flag causes the shadow search qualifier to appear (default:SEARCH_SHADOW)
USE_SOPT_SHADOW|0|
# Flag causes the sort by search qualifier to appear (default:SEARCH_SORT_BY)
USE_SOPT_SORT_BY|1|
# Flag causes the relevance ranking option to appear (default:SEARCH_RELEVANCE)
(cancels out SORT_BY)
USE_SOPT_RELEVANCE|0|

# Custom search option pulldown lists used on search options pages.


# Instead of displaying all policies as search qualifiers, use a CUSTOM list
# by defining a list of policies:policy descriptions. Policy:policy description
# pairs are separated by a colon, and list entries are separated with commas.
# The entire list (between the pipes) is enclosed in double-quotes.
# Policy descriptions may be label variables in square brackets, as in:
# SPANISH:$[LANG_desc_spanish]

Version 3.0, March 2006 121


Fundamentals of iBistro/iLink Customization

# or plain text, as in
# ENGLISH:English
# example:
# SOPT_CUSTOMFORMAT|"ANY:$[any:U],MARC:$[book:u],VM:AV Materials,SERIAL:Magazines and
Periodicals"|
#
SOPT_CUSTOMLANGUAGE||
SOPT_CUSTOMFORMAT||
SOPT_CUSTOMITEMTYPE||
SOPT_CUSTOMLOCATION||
SOPT_CUSTOMICAT1||
SOPT_CUSTOMICAT2||
SOPT_CUSTOMCLASS||

# QUICKSEARCH_LIBR_OPTIONS: Which list of libraries for the Quick Search


# libraries option. Values:
# 1 - Both SRCL and LIBR.
# 2 - SRCL only.
# 3 - LIBR only.
QUICKSEARCH_LIBR_OPTIONS|3|

# POWERSEARCH_LIBR_OPTIONS: Which list of libraries for the Power Search


# libraries option. Values:
# 1 - Both SRCL and LIBR.
# 2 - SRCL only.
# 3 - LIBR only.
POWERSEARCH_LIBR_OPTIONS|1|

# Catalog Search button labels -- 3_search.h


CAT_SEARCH_RESET_TEXT|$<reset:u>|
CAT_SEARCH_SEND_TEXT|$<search:u>|

# Catalog Search Options labels -- 3_search.h


CAT_ICON_BROWSE_LABEL|$<browse:u>|
CAT_ICON_EXACT_SEARCH_LABEL|$<exact:u>|
CAT_ICON_SEARCH_LABEL|$<keyword:u>|
CAT_ICON_TERM_SEARCH_LABEL|$<D581:u>|
LIBRARYPROMPT|$<library>:|
LOOKUPICAT1LABEL|$<D295>:|
LOOKUPICAT2LABEL|$<D296>:|
LOOKUPOPTIONSHEADING|$<limit_by:u>|
LOOKUPQUALFORMATPROMPT|$<format>:|
LOOKUPQUALLANGPROMPT|$<language>:|
LOOKUPQUALLOCATIONPROMPT|$<locn>:|
LOOKUPQUALPUBYEARPROMPT|$<pubyear>:|
LOOKUPQUALTYPEPROMPT|$<type>:|
SEARCHTYPEPROMPT|$<D342>:|
SHADOWPROMPT|$<shadow>:|
SORTTERMSPROMPT|$<D558>:|
SRCHOPT_MATCH_ON_EXACT|$<exact_content:u>|
SRCHOPT_MATCH_ON_KEYWORD|$<keywords:u>|
SRCHOPT_MATCH_ON_PARTIAL|$<left_to_right:u>|
SRCHOPT_SHADOW_BOTH|$<both:u>|
SRCHOPT_SHADOW_NO|$<no:u>|
SRCHOPT_SHADOW_YES|$<yes:u>|
SRCHOPT_SORT_BY_AUTHOR|$<author:u>|
SRCHOPT_SORT_BY_NONE|$<none:u>|
SRCHOPT_SORT_BY_PBYR|$<old_to_new>|
SRCHOPT_SORT_BY_RELEVANCE|$<relevance:u>|
SRCHOPT_SORT_BY_REV_PBYR|$<new_to_old>|
SRCHOPT_SORT_BY_SUBJECT|$<subject:u>|
SRCHOPT_SORT_BY_TITLE|$<title:u>|

# Catalog Search Options default values -- 3_search.h


# NOTE: If ANY search limit is set in a Catalog Access gateway search element, then
# no locally set default search options such as those below will be used in the
search.
SEARCH_FORMAT|ANY|
SEARCH_ITEM_CAT1|ANY|

122 Version 3.0, March 2006


Appendix A –iBistro.env

SEARCH_ITEM_CAT2|ANY|
SEARCH_ITEM_TYPE|ANY|
SEARCH_LANGUAGE|ANY|
SEARCH_LIBRARY|ALL|
SEARCH_LOCATION|ANY|
SEARCH_MATCH_ON|KEYWORD|
SEARCH_PUBYEAR||
SEARCH_RELEVANCE|N|
SEARCH_SHADOW|NO|
SEARCH_SORT_BY|ANY|
# when executing a hypertext search from a single item view,
# do the search as
LIKESEARCHTYPE|PARTIAL|

# Use of Default Catalog Search Options on the Quick Search Page -- 3_search.h
# By default, only the sort-by hidden option is used on the quick search page.
USE_QUICKSRCH_OPT_PUBYEAR|0|
USE_QUICKSRCH_OPT_LANGUAGE|0|
USE_QUICKSRCH_OPT_FORMAT|0|
USE_QUICKSRCH_OPT_ITEM_TYPE|0|
USE_QUICKSRCH_OPT_LOCATION|0|
USE_QUICKSRCH_OPT_ITEM_CAT1|0|
USE_QUICKSRCH_OPT_ITEM_CAT2|0|
USE_QUICKSRCH_OPT_SHADOW|0|
USE_QUICKSRCH_OPT_SORT_BY|1|
USE_QUICKSRCH_OPT_RELEVANCE|0|

# Misc Catalog Search parameters -- 3_search.h


# this flag causes a Keyword radio button to display above the search field
CAT_ICON_SEARCH|0|
# this flag causes a Browse radio button to display above the search field
CAT_ICON_BROWSE|0|
# this flag causes an Exact radio button to display above the search field
CAT_ICON_EXACT_SEARCH|0|
# this flag causes a Term Search radio button to display above the search field
CAT_ICON_TERM_SEARCH|0|
OPERVAL_AND|$<and:u>|
OPERVAL_OR|$<or:u>|
OPERVAL_NOT|$<not:u>|
OPERVAL_XOR|$<xor:u>|
# allow searching in LibraryHQ Site Source
CAT_ICON_WEB_RESOURCES|0|
WEB_RESOURCES_LABEL|$<web_resources>|

# allow searching in configurable web search window


CAT_ICON_SEARCH_ENGINE|1|

# configure Alta Vista as search engine


# web search engine label
#SEARCH_ENGINE_LABEL|Alta Vista|
# web search engine URL (goes before query terms)
#SEARCH_ENGINE_URL_PT1|http://www.altavista.com/sites/search/web?q=|
# web search engine addendum (goes after query terms)
#SEARCH_ENGINE_URL_PT2|&pg=q|

# configure Google as search engine


# web search engine label
SEARCH_ENGINE_LABEL|Google|
# web search engine URL (goes before query terms)
SEARCH_ENGINE_URL_PT1|http://www.google.com/search?q=|
# web search engine addendum (goes after query terms)
SEARCH_ENGINE_URL_PT2|&safe=vss&vss=1&sa=Google+Search|

# configure Yahoo as search engine


# web search engine label
#SEARCH_ENGINE_LABEL|Yahoo|
# web search engine URL (goes before query terms)
#SEARCH_ENGINE_URL_PT1|http://google.yahoo.com/bin/query?p=|
# web search engine addendum (goes after query terms)
#SEARCH_ENGINE_URL_PT2|&w=dir&hc=0&hs=0|

Version 3.0, March 2006 123


Fundamentals of iBistro/iLink Customization

CAT_ICON_ZBROADCAST|0|
OTHER_LIBRARIES_LABEL|$<zbroadcast_search_request>|

# Catalog Browse/Term Search use flag -- 3_browse.h, 3_term.h


# offer the library field to qualify browsing (default: BRWSOPT_LIBRARY)
USE_BRWSOPT_LIBRARY|1|
# display library qualifier in browse hit
CATBROWSE_DETAIL|0|

# Catalog Browse/Term Search default value -- 3_browse.h, 3_term.h


BRWSOPT_LIBRARY|ALL|

# Catalog Browse/Term Search labels -- 3_browse.h, 3_term.h


LIBRARYLABEL|$<library>:|
BROWSE_ON|$<browse_on>|

# Catalog Browse button labels -- 3_browse.h


CAT_BROWSE_RESET_TEXT|$<reset:u>|
CAT_BROWSE_SEND_TEXT|$<search:u>|

# Catalog Term Search button labels -- 3_term.h


CAT_TERM_RESET_TEXT|$<reset:u>| # revB only
CAT_TERM_SEND_TEXT|$<search:u>| # revB only

# Catalog Hits List use flags -- 4.pg, buttons4b.h


# display on-order or in-process information to patrons
DISPONORDER|1|
# at top of page display classification portion of call number without analytic
DISPCLASSONLY|0|
# at top of page display the full call number with analytic
DISPFULLCALL|1|
# display the Limit Search button
USE_LIMIT_BUTTON|1|
# display a text URL as well as icon
USE_TEXT_URL|0|
# display summarized list of available copies and libraries/locations
USE_COPY_SUMMARY_HOLDINGS|1|
# multilibrary systems only: when a library-qualified search finds 2 or more titles,
# and one title's only copies in specified library are ALL shadowed,
# setting this flag to 1 allows title/author info to appear on hits list with an UNVIEW
button,
# and displays COPYSTAT_NONE_EXIST_LIBR message instead of MN 434 (Unavailable for
display).
VIEWHITS_UNAVAILABLE|0|
# Number of hits to retrieve per hitlist page
NUM_SEARCH_HITS|20|
# display first item type icon (defined by ITYPnDISP and ITYPnICON variables below)
DISP_ITYPICON|0|
# display sort option in catalog search hit list with search strategy
CATSEARCH_SORT_DETAIL|0|
# display qualifier details in catalog search hit list with search strategy
CATSEARCH_DETAIL|0|
# arrange hitlist from bulletin search by sorting by title (TI)
# Other sort options: author (AU), subject (SU), pub year (PBYR), and
# reverse pub year (-PBYR)
BULLETIN_SORT_BY|TI|

# Catalog Hits List labels -- 4.pg


ADDEDVOLUMESTEXT|$<D35>|
ANDOTHERSTEXT|$<and_others>|
ATLIBLABEL|$<at>:|
CAT4_SCREEN_TITLE|$<search_results>|
CATHITLISTTITLE|$<catalog_results>|
CATHITLISTMSG1|$<search_found>|
CATHITLISTMSG2|$<titles>|
CATHITLISTPAGES|$<pages:u>|
CATHITLISTXREFMSG1|$<there_r_also>|
CATHITLISTXREFMSG2|$<cross_refs>|
CATLOOKUPLISTHEADING1|$<you_found>|
CATLOOKUPLISTHEADING2|$<items>|

124 Version 3.0, March 2006


Appendix A –iBistro.env

CATLOOKUPLIST_CHECKBOX_MSG1|$<use_checkboxes>|
CATLOOKUPLIST_CHECKBOX_MSG2|$<below_mark_for_printcap>|
CAT_SEARCH_RETURN_FULL|$<return_to_full_results>|
CHARGEUSERLABEL|$<charged_to>:|
COPIESLABEL|$<copies>:|
COPIESORDERLABEL|$<copies_on_order:u>|
COPIES_AVAIL_AT|$<copies_available_at>|
COPIES_AVAIL|$<copies_available>|
COPYLABEL|$<copy:u>|
COPY_AVAILABLE_IN|$<copy_available_in>|
COPY_AVAIL_AT|$<copy_available_at>|
COPY_AVAIL_IN|$<D273:L>|
COPYSTAT_NONE_EXIST_LIBR|$<no_copies_this_lib>|
DISPONORDERSTATUS|$<ON_ORDER>|
DISPONSUBORDERSTATUS|$<CURR_SUBSCRIP>|
DISPORDRECVSTATUS|$<D480:U>|
DISPRECURORDERSTATUS|$<opac_recurr_order_status>|
ITEMTYPELABEL|$<type>:|
ITEMS_FOUND|$<items_found>.|
LIBSEARCH_DETAIL_LABEL|$<library>:| #for "library/group:" use $<libgroup_detail>
NONETEXTUPPER|$<none:U>|
PUBYEARLABEL|$<pub_year>:|
QUERY_RETRY_TEXT|$<search_again>|
VIEWFORDETTEXT|$<D657>|
CATEGORY|$<category:L>.|
CATEGORY_BOX_TITLE|$<categories_box>:|
SEARCH_OTHER_AREAS|$<search_other_areas>|
CONTINUE_SEARCH_IN|$<continue_search_in>:|
WERE_FOUND_IN|$<were_found_in>|
WAS_FOUND_IN|$<was_found_in>|

# Catalog Single Item View use flags -- 5.pg, dspholdings.h


# display full (up to 60 char) location description rather than location name
USE_ITEM_LOCATION_DESC|1|
# display full (up to 60 char) library description rather than library name
USE_ITEM_LIBRARY_DESC|1|
# display full (up to 60 char) item type description rather than item type name
USE_ITEM_TYPE_DESC|1|
# offer option to place Enhanced Hold on hitlist
USE_HOLD_ICON_HITLIST|0|
# offer option to place Enhanced Hold on single/detail view
USE_HOLD_ICON|1|
# offer Enhanced Hold link for all copies (1) or only
# when no copies are currently available (0)
HOLD_ITEMS_ON_SHELF|1|
# Allow holds to be placed on items that are on order
# 0 doesn't allow holds on order 1 does allow hold on on order items
ALLOW_HOLD_OPEN_ORDER|0|
# suppress calculated estimated wait period when all copies unavailable.
HIDE_EST_WAIT|0|
# display current/search library's call number at the page top even if
# hit list call numbers
DISPCALLTOP|0| # revB only
# if Patron Booking is configured, offer Booking button
USEBOOKING|0|
# display summarized holdings rather than a copy list
SUMMARY_HOLDINGS|1|
# display borrowing user (only available if SUMMARY_HOLDINGS is 0)
VIEWCHARGEUSER|0|
# display number of holds (only available if SUMMARY_HOLDINGS is 0)
USEVIEWHOLDS|0|
# display due date (only available if SUMMARY_HOLDINGS is 0)
USEVIEWDUEDATE|0|
# use the CSS tabbed single-item view (Elib_revC only)
TABBED_SINGLE_ITEM_VIEW|1| # revC only
# set the default tab for single-item view (Elib_revC only)
# the value for tabbed_single_item_default must be
# 1 - for item information
# 3 - catalog record
TABBED_SINGLE_ITEM_DEFAULT|1| #revC only
# set the default tab for single-item view (Elib_revC only) on Z3950 searches

Version 3.0, March 2006 125


Fundamentals of iBistro/iLink Customization

# the value for tabbed_single_item_default must be


# 1 - for item information
# 3 - catalog record
TABBED_SINGLE_ITEM_DEFAULT_Z3950|1| #revC only
# display the View Options/Change Display button
USE_VIEWOPT_BUTTON|1|
# display copies' public note(s) from item extended info
DISPOPACNOTE|1|
# launch 856 link in new window using Javascript
856URL_JSNEWWIN|1|
# Sort order of libraries in call display.
# x - no sorting
# n - by library name
# d - by library description
CGI_CALLDISP|n|
# if Hyperion configured and catalog 856 entry contains an embedded
# Hyperion resource link
# 0 = link launches full Hyperion session
# 1 = link displays resource only
CAT_IARC_RESOURCE_ONLY|0|

# Catalog Single Item View labels -- 5.pg, dspholdings.h


CAT5_SCREEN_TITLE|$<search_result>|
FULL_VIEW_CATALOG|$<full_view_catalog>|
VIEW_HOLDINGS_TITLE|$<holdings:u>|
CATHITVIEWMSG1|$<record>|
CATHITVIEWMSG2|$<D246:l>|
CATHITVIEWMSG3|$<from_catalog>|
CATLOOKUPVIEW_CHECKBOX_MSG|$<check_here_for_printcap>|
HOLDCOLTEXT|$<holds:u>|
FOR_SEARCH|$<for_search>|
FOUNDLABEL|$<found>|
IN_CATEGORY|$<in_category>|
LIBRARYCOLTEXT|$<library:u>|
MATERIALCOLTEXT|$<material:u>|
LOCATIONCOLTEXT|$<locn:u>|
CHARGEDSPUSERLABEL|$<charged_to:u>|
DISPLAYINGTEXT|$<displaying:u>|
ORDERSTEXT|$<order_s>|
DISPORDERSTATUSLABEL|$<status:u>|
DISPORDERPARTSLABEL|$<parts:u>|
COPYCOLTEXT|$<copies:u>|
COPYSTAT_NONE_AVAIL|$<no_copies_available>.|
COPYSTAT_NONE_AVAIL_NO_ESTWAIT|$<no_copies_available_unk_wait>.|
COPYSTAT_ESTWAIT|($<estimated_wait>|
COPYSTAT_ESTWAIT_DAYS|$<days>)|
COPYSTAT_NONE_AVAIL_LIBR|$<no_copies_available_any_lib>.|
COPIESSTAT_TOTAL_LOCN|$<copies_totl_all_locn>|
COPYSTAT_TOTAL_LOCN|$<copy_totl_all_locn>|
READBLURB_LABEL|$<read_blurb>|
READEXCERPT_LABEL|$<read_excerpt>|
SAME_ITEM|$<same_item>|
TELLMEWHEN_AUTHOR|$<tellmewhen_author>|
TELLMEWHEN_SUBJECT|$<tellmewhen_subject>|
MORE_SUBJECTS|$<more_like_this>|
MORE_AUTHORS|$<more_by_this_author>|
OFLABEL|$<of>|
FORLABEL|$<for>:|
ORLABEL|$<or>|
OPACNOTE|$<note:3u>|
PAGELABEL|$<page>|
CALLNUMCOLTEXT|$<call_nums:u>|
RESDESKLABEL|$<rsv_desk>:|
RESVCIRCRULELABEL|$<circ_rule2>:|
BOUNDINLABEL|$<D75>:|
IARCLABEL|$<view_image>|
# if an item has this as its current location, then it is checked out
CHECKEDOUTLOCN|CHECKEDOUT|
DISPNOCIRCTEXT|($<D368>)| #not valid in iBistro
VIEWINGLABEL|$<viewing_results:u>|
XREF_BOX_TITLE|$<xref_box>...|

126 Version 3.0, March 2006


Appendix A –iBistro.env

# labels that work with the CSS tabbed single-item view (Elib_revC only)
VIEW_ENRICHMENT|$<VIEW_ENRICHMENT:u>| # revC only
ITEM_SUMMARY_LABEL|$<ITEM_SUMMARY_LABEL:u>| # revC only
VIEW_MARC_RECORD|$<VIEW_MARC_RECORD:u>| # revC only
ISBN_LABEL|$<isbn:U>| # revC only
PAGES_LABEL|$<pages:u>| # revC only
PUB_YEAR_LABEL|$<pub_date:u>| # revC only
PUBLISHER_LABEL|$<publisher:u>| # revC only
COPY_INFO_LABEL|$<copy_info:u>| # revC only

# To send Best Seller (ISBN) and unavailable item requests to online bookstore,
# enter the first part of URL in BUYNOW_URL_PT1 (when USE_BUYNOW_ICON|1):
# BUYNOW_URL_PT1|http://www.amazon.com/exec/obidos/ASIN/| # Amazon
# BUYNOW_URL_PT1|http://www.amazon.co.uk # Amazon UK
BUYNOW_URL_PT1|http://bn.bfast.com/booklink/click?ISBN=| # Barnes & Noble
# ISBN is part 2
# enter partner ID information in BUYNOW_URL_PT3
BUYNOW_URL_PT3||

# To send Recommended Reading (title/author) requests to online bookstore,


# specify one from the list below:
# AMAZONUK(www.amazon.co.uk), AMAZONUS(www.amazon.com), BNUS(www.bn.com)
# Not used with Enhanced Buy Now.
# To disable Recommended Reading BUYNOW feature, but keep BUYNOW feature in
# other areas, define the store variable as empty: BUYNOW_STORE||
BUYNOW_STORE|BNUS|
# last part of URL to send to bookstore; may contain partner ID
BUYNOW_URL_PTID||

# Browse Results list label -- 6.pg


CATBROWSE_SCREEN_TITLE|$<catalog_browse_results>|
CATTERMSRCH_SCREEN_TITLE|$<term_searching>|
NOTFOUND_BROWSELIST_MSG|$(438)| #Yes, this should be (), not <>
CATBROWSEXREFLABEL|$<D538>:|
BROWSING_ON|$<browsing_on>:| # revB only

# Cross Reference use flags -- 8.pg


# display the see also relationships (broader, narrower, related) labels
USE_XXREF_LABELS|0|

# Cross Reference label -- 8.pg


CATXREF_SCREEN_TITLE|$<cat_lookup_crossref>|
NOTFOUND_XREFLIST_MSG|$(439)| #Yes, this should be (), not <>
XREFMAINTERMLABEL|$<for_xref_term:u>| #not used in iBistro
SEARCH_TOPICS_RELATED|$<search_topics_related_to:u>| # iBistro
XREFLABEL1|$<D535>:|
XREFLABEL2|$<D524>:|
XREFLABEL3|$<D529>:|
XREFLABEL4|$<D526>:|
XREFLABEL5|$<D527>:|
XREFLABEL6|$<D528>:|
XREFLABEL7|$<D525>:|
XREFLABEL8|$<D240>:|
XREFLABEL9|$<D535>:|
XREFLABEL10|$<D524>:|
XREFLABEL11||
XREFLABEL12|$<D351>:|

# Cross Reference default -- 8.pg


# when executing a hypertext search from a display of xrefs, do the search as
# EXACT, PARTIAL or KEYWORD
XREF_LOOKUP_TYPE|EXACT|

# Error Page labels -- 9.pg


ERROR_SCREEN_TITLE|$<error:u>|
USER_REPLIES_MSG|$<you_have_no_requests>|
UNDET_ERROR_MSG|$<undetermined_resp_err>|

# Kept/Print/Capture Config flags -- 10.pg


# for sites who have PROCITE, allow patrons to select PROCITE formatting

Version 3.0, March 2006 127


Fundamentals of iBistro/iLink Customization

# also required USE_CAPOPT_FORMAT to be on


CFG_PROCITE|0|

# Print/Capture Search Results flags -- 10.pg


# offer the option to print the marked titles to a system printer
USECAPPRINTSYSTEM|0|
# offer the option to view the marked titles
USECAPVIEW|1|
# offer the option to save the marked titles
USECAPSAVE|0|
# offer the option to print the marked titles to a local printer
USECAPPRINTLOCAL|1|
# offer the option to email the marked titles
USECAPEMAIL|1|
# offer option when processing the marked titles: FORMATTED or FLAT ASCII
# use CAPOPT_FORMAT to set the default value
USE_CAPOPT_FORMAT|0|
# offer AUTHOR/TITLE/CALL NUMBER sort option when processing the marked titles
# use CAPOPT_SORT_BY to set the default value
USE_CAPOPT_SORT|1|
# offer library specification when processing the marked titles
# use VIEW_LIBRARY to set a default value
USE_CAPOPT_LIBRARY|1|
# offer call number sort option when processing the marked titles:
# ASCENDING or DESCENDING
USE_CAPOPT_DSP_RULE|0|
# offer shadow option when processing the marked titles
USE_CAPOPT_SHADOW|0|
# offer FULL/BRIEF/ALL entry list option when processing the marked titles
USE_CAPOPT_ELST|1|

# Print/Capture Search Results labels -- 10.pg


CAT10_SCREEN_TITLE|$<print_capture>|
CAPEMAILLABEL1|$<D210>:|
CAPOPT_FORMAT_FLAT_ASCII|$<flat_ascii>|
CAPOPT_FORMAT_FORMATTED|$<P440:u>|
CAPOPT_SORT_BY_AUTHOR|$<author:u>|
CAPOPT_SORT_BY_CALLNUMBER|$<call_num:u>|
CAPOPT_SORT_BY_TITLE|$<title:u>|
CAPPRINTLOCALLABEL1|$<print_local_printer>:|
CAPPRINTLOCALLABEL2|$<using_file_menu_print>|
CAPPRINTSYSTEMLABEL1|$<print_library_printer>:|
CAPPRINTSYSTEMLABEL2|$<or_networked_printer>:|
CAPSAVELABEL1|$<save_to_local_file>|
CAPSAVELABEL2|$<using_file_menu_save>|
CAPVIEWLABEL1|$<view_marked_results>|
CAPVIEWLABEL2|$<on_screen>|
DOWNLOADPROMPT|$<download_using_file_menu>|
METHODPROMPT|$<choose_one>:|
PRINTERPROMPT|$<print_system_printer>:|
PRNTEMAILPROMPT|$<D210>:|
RESULTLIST1PROMPT|$<out_of>|
RESULTLIST2PROMPT|$<records_printcap_numbers>:|
RESULTSORTPROMPT|$<D558>:|
RESULTTYPEPROMPT|$<D629>:|
SYSTEMDEVICEPROMPT|$<sys_device_name>:|

# other labels already defined in View Options page

# Print/Capture Search Results default values -- 10.pg


# sets the default values for Print/Capture/Keep option fields
CAPOPT_FORMAT|FORMATTED|
CAPOPT_SORT_BY|TITLE|
CAPOPT_VIEWDUEDATE|l| # 'l' or 'd'
CAPOPT_VIEWHOLDS|t| # 't' or 'h'
# if CAPOPT_ENTRYLIST has a value like BRIEF, that value will be used
CAPOPT_ENTRYLIST|BRIEF|
CAPOPT_ENTRYLIST_BIB|0|

# Catalog Change Display (View Options) use flags -- 11.pg, viewoptions.h


# offer the option to change the library holdings being viewed

128 Version 3.0, March 2006


Appendix A –iBistro.env

# use VIEWOPT_LIBRARY to set the default value


USE_VOPT_LIBRARY|1|
# offer the option to display ASCENDING/DESCENDING call number
# use VIEWOPT_DSP_RULE to set the default value
USE_VOPT_DSP_RULE|0|
# offer the option to display ALL/BRIEF/FULL catalog entries
# use VIEWOPT_ENTRY_LIST to set the default value
USE_VOPT_ENTRYLIST|1|
# offer the option to display call numbers/copies from the shadow index
# use VIEWOPT_SHADOW to set the default value
USE_VOPT_SHADOW|0|
# offer the option to display a particular call number's volume/part
# use VIEWOPT_VOLNUMS to set the default value
USE_VOPT_VOLNUMS|0|
# offer the option to display associated items on order and in process
# use VIEWOPT_ORDERS to set the default value
USE_VOPT_ORDERS|0|
# offer the option to display holdings
# use VIEWOPT_HOLDINGS to set the default value
USE_VOPT_HOLDINGS|0|
# offer the option to display the title formatted or unformatted
# use VIEWOPT_UNFORMATTED to set the default value
USE_VOPT_UNFORMATTED|1|

# Catalog Change Display (View Options) labels -- 11.pg, viewoptions.h


CALLORDERPROMPT|$<D397>:|
DISPHOLDINGSPROMPT|$<holdings>:|
DISPORDERSPROMPT|$<orders>:|
DISPUNFORMATTEDPROMPT|$<unformatted_display>:|
VIEWOPTIONSHEADING|$<change_display>|
VIEWOPT_DSP_RULE_ASCENDING|$<ascending:u>|
VIEWOPT_DSP_RULE_DESCENDING|$<descending:u>|
VIEWOPT_ENTRYLIST_ALL|$<all:u>|
VIEWOPT_ENTRYLIST_BIB|$<bibliography:u>|
VIEWOPT_ENTRYLIST_BRIEF|$<brief:u>|
VIEWOPT_ENTRYLIST_FULL|$<full:u>|
VIEWOPT_N|$<no:u>|
VIEWOPT_Y|$<yes:u>|
VIEWOPT_SHADOW_BOTH|$<both:u>|
VIEWOPT_SHADOW_NO|$<no:u>|
VIEWOPT_SHADOW_YES|$<yes:u>|
VIEWRECPROMPT|$<D658>:|
VOLUMENUMBERPROMPT|$<D561>:|

# Catalog Change Display (View Options) default values -- 11.pg, viewoptions.h


VIEWOPT_LIBRARY|ALL|
VIEWOPT_DSP_RULE||
VIEWOPT_ENTRY_LIST|FULL|
VIEWOPT_SHADOW|NO|
VIEWOPT_VOLNUMS||
VIEWOPT_ORDERS|Y|
VIEWOPT_HOLDINGS|Y|
VIEWOPT_ALLCOPIES|Y|
VIEWOPT_ALLCALLS|Y|
VIEWOPT_UNFORMATTED|N|

# Print Results labels -- 12.pg


PRINT_SCREEN_TITLE|$<print:u>|
PRINT_SUCCESS_MSG|$<search_results_spooled_to_print>|

# Email Results labels -- 13.pg


EMAIL_SCREEN_TITLE|$<P382>|
EMAIL_SUCCESS_MSG|$<search_results_mailed>|

# Download Results -- 14.pg and 62.pg


DOWNLOAD_WIN|1|
DOWNLOAD_WIN_TIMEOUT|120000| # milliseconds

# Browse Call Number use flags -- 15.pg


# offer the option to qualify browsing by library

Version 3.0, March 2006 129


Fundamentals of iBistro/iLink Customization

# use CALLBROWSE_LIBRARY to set the default value


USE_CALLBRSWOPT_LIBRARY|1|
# offer the option to qualify browsing by class scheme
# use CALLBROWSE_CLASS to set the default value
USE_CALLBRSWOPT_CLASS|0|
# offer the option to qualify browsing by shadow
# use CALLBROWSE_SHADOW to set the default value
USE_CALLBRSWOPT_SHADOW|0|
# offer the option to qualify browsing by item type
# use CALLBROWSE_ITEM_TYPE to set the default value
USE_CALLBRSWOPT_ITEM_TYPE|1|
# offer the option to qualify browsing by location
# use CALLBROWSE_LOCATION to set the default value
USE_CALLBRSWOPT_LOCATION|1|
# offer the option to qualify browsing by item cat1
# use CALLBROWSE_ICAT1 to set the default value
USE_CALLBRSWOPT_ICAT1|0|
# offer the option to qualify browsing by item cat2
# use CALLBROWSE_ICAT2 to set the default value
USE_CALLBRSWOPT_ICAT2|0|
# when other call number browse qualifiers have been used in
# a command, stop presenting list if no matching call numbers
# are found in XX entries
# use CALLBROWSE_MAXSKIP to set the default value
USE_CALLBRSWOPT_MAXSKIP|0|
# display qualifier details in call number hit list
CALLBROWSE_DETAIL|0|

# Browse Call Number button labels -- 15.pg


CALLBRWSLOOKUPOPTIONSHEADING|$<limit_by:u>|
CALL_BROWSE_RESET_TEXT|$<reset:u>|
CALL_BROWSE_SEND_TEXT|$<search:u>|

# Browse Call Number labels -- 15.pg


ITEMCLASSLABELPUBLIC|$<D553>:|
MAXCALLTOSKIPPROMPT|$<D346>:|
CALLBRWSOPT_SHADOW_NO|$<no:u>|
CALLBRWSOPT_SHADOW_YES|$<yes:u>|
CALLBRWSOPT_SHADOW_BOTH|$<both:u>|

# other labels already defined in search options

# Browse Call Number default values -- 15.pg


CALLBROWSE_LIBRARY|HERE|
CALLBROWSE_CLASS|LC|
CALLBROWSE_SHADOW|NO|
CALLBROWSE_ITEM_TYPE|ANY|
CALLBROWSE_LOCATION|ANY|
CALLBROWSE_ICAT1|ANY|
CALLBROWSE_ICAT2|ANY|
CALLBROWSE_MAXSKIP|50|

# Browse Call Number Results labels -- 16.pg


CALLBROWSELIST_SCREEN_TITLE|$<browsing_shelves>| #Webcat
CALLSEARCHLIST_SCREEN_TITLE|$<call_number_search>| #iBistro

# Single Item View from Call Number Results labels -- 17.pg


CALLBROWSEVIEW_SCREEN_TITLE|$<full_view_catalog>| #Webcat
CALLSEARCHVIEW_SCREEN_TITLE|$<call_number_search>| #iBistro
CALLSEARCH_FOR|$<searching>| #iBistro

# Reserves Form use flags -- 19.pg


# show the reserve desk as search choice and in display info
USERESCOL|1|
# offer the Instructor button in Reserve search
USE_RSV_INSTRUCTOR|1|
# offer the Course Number button in Reserve search
USE_RSV_COURSEID|1|
# offer the Course Name button in Reserve search
USE_RSV_COURSENAME|1|
# offer the Place A New Reserve request button in Reserve search

130 Version 3.0, March 2006


Appendix A –iBistro.env

USE_ACADRESVREQ|1|

# Reserves Form button labels -- 19.pg


RSV_INSTRUCTOR_LOOKUP_TEXT|$<INSTRUCTOR_HEAD>|
RSV_COURSE_ID_LOOKUP_TEXT|$<COURSE_NUM_HEAD>|
RSV_COURSE_NAME_LOOKUP_TEXT|$<COURSE_NAME_HEAD>|
RSV_RESET_TEXT|$<reset_query_val>|

# Reserves Form labels -- 19.pg


RESVCOLLPROMPT|$<rsv_desk>:|

# Reserves Form default values -- 19.pg


BROWSERESCOL|ANY|
# Whether to include shadowed titles/calls/items. NO, BOTH, or YES.
RSV_SHADOW|NO|

# Reserves Browse Page -- 20.pg


BROWSERES_INSTRUCTOR_SCREEN_TITLE|$<list_instructors>|
BROWSERES_COURSE_SCREEN_TITLE|$<list_courses>|

# Reserves list labels -- 21.pg


RESVCOURSES|$<courses:u>|
RESVINSTRUCTORS|$<instructors:u>|

# Reserves hits list labels -- 22.pg


RSV_SEARCH_LIST|$<list_of_reserves:u>|
RSV_SEARCH_RESULTS|$<reserve_results>|
RSV_ITEM_BY|$<items_reserve_by>|
RSVFORLABEL|$<for>|
RESVAVAILABLETEXT|$<available:u>|

# User Status Form use flags -- accessfields2.h, 24.pg, 34.pg


# offer user ID field on login page
USERID_ACCESS|1|
# offer alt ID field on login page
ALTID_ACCESS|1|
# offer PIN field on login page
PIN_ACCESS|1|
# input case for alt id
ALTIDCASE||
# strip character by code from user ID field on login page
STRIP_USERID|0|

# User Status Form button labels -- 24.pg


USRSTATUS_SEND_TEXT|$<disp_user_info>|
USRSTATUS_RESET_TEXT|$<reset_query_val>|

# User Identification Form labels -- 24.pg, 50.pg, 52.pg


USERIDTEXT|$<type_ID_for_info>.|
USERIDPINTEXT|$<type_ID>.|
USERIDRENEWTEXT|$<type_ID>.|
USERIDLABELPUBLIC|$<userID>:|
ALTIDLABELPUBLIC|$<AltID>:|
PINPROMPT|$<PIN>:|

# My Account use flags -- 25.pg


# when displaying holds include queue position data
USEHOLDQUEUEPOS|1|
# Allow the users to edit holds
USE_EDIT_HOLD|0|
# Allow the user to enter hold suspension dates when creating and editing holds
USE_SUSPEND_HOLD|0|
# Allow the user to display/edit hold expiration date
USE_HOLD_EXPIRATION_DATE|1|
# Determines if the RESCOLCD is passed on renew attempts
# This is defaulted to 0 to mimic traditional behavior
# and can be set to 1 to allow the opac to pass the
# RESCOLCD which will allow the OPAC user to renew
# reserve items that could otherwise be renewed.
RENEW_RESERVE_ITEMS|0|
# If SORT_CHARGES is 1, then user charges and user renewal charges

Version 3.0, March 2006 131


Fundamentals of iBistro/iLink Customization

# in MY ACCOUNT section of iBistro will be sorted by due date


SORT_CHARGES|1|
# Allows Electronic Payment column, Pay Bill Now button and
# Pay Bills button to appear. Only works with PayPal.
ELECTRONIC_PAYMENT|0|
# Text to indicate electonic payment
ELECTRONIC_PAYMENT_TEXT|$<electronic_payment>|
# PayPal business account, for example:library@library.org
PAYPAL_BUSINESS||
# PayPal's URL
PAYPAL_URL||
# PayPal's notification URL
PAYPAL_NOTIFY_URL||
# Minimum amount that can be paid using PayPal
PAYPAL_MINIMUM|0|
# Allow payment of bills with Comprise Technologies SAM interface
# SAM (Smart Access Manager)
SAM_PAYMENT|0|
# Allow barred users to use SAM payment
SAM_PAYMENT_BARRED|0|

SAM_HOST||

SAM_PORT||

# My Account labels -- 25.pg


AMTOWEDCOLTEXT|$<you_owe:u>|
AUTHORCOLTEXT|$<author:u>|
AVAILABLECOLTEXT|$<hold_availability:u>|
AVAILABLETEXT|$<available:u>|
BILLEDLABEL|$<billed>:|
BILLLABEL|$<bill>|
BILLSLABELCAPS|$<bills:u>|
BILLSLABELLOWER|$<bills>|
BOOKENDCOLTEXT|$<end_daytime:u>|
BOOKINGLABEL|$<booking>|
BOOKINGRANGECOLTEXT|$<booked_for:u>|
BOOKINGSLABELCAPS|$<bookings:u>|
BOOKINGSLABELLOWER|$<bookings>|
BOOKSTARTCOLTEXT|$<start_daytime:u>|
CANCELCOLTEXT|$<cancel:u>|
CANCEL_HOLDS_BUTTON|$<cancel_selected_holds>|
CANCELHOLDS_INSTRUC|$(13454)|
CANCEL_RSVNS_BUTTON|$<cancel_selected_rsvns>|
CHECKOUTLABELCAPS|$<checkouts:u>|
CHECKOUTLABEL|$<checkout:L>|
CHECKOUTLABELLOWER|$<checkouts>|
DUELABEL|$<due:u>:|
DUE_RECALLLABEL|$<due:u>/$<recalled:u>|
EDITALLTEXT|$<edit_all:u>|
EDITCOLTEXT|$<P345:u>|
EXPIRESCOLTEXT|$<expires:u>|
FINELABEL|$<now_you_owe:u>|
HOLDLABEL|$<hold>|
HOLD_QUEUE_NO_ITEM_MSG|$<unavailable:u>|
HOLD_NEVER_EXPIRES|$<never_expires:u>|
HOLDSLABELCAPS|$<holds:u>|
HOLDSLABELLOWER|$<holds>|
NOACTIVITY_MSG|$(13474)|
NOITEMBILLTEXT|$<D372>|
OWESLABEL|$<owes>:|
PAYPAL_ALL_TEXT|$<pay_bills>|
PAYPAL_MINIMUM_MESSAGE|$<paypal_minimum>|
PAYPAL_TEXT|$<pay_bill_now>|
PICKUPLIBCOLTEXT|$<pickup_at:u>|
PICKUPLIBRCOLTEXT|$<pickup_at:u>|
POSHOLDQUEUEMSG|$<your_position_in_holds_Q>|
REASONCOLTEXT|$<reason:u>|
RECALLDUELABEL|$<recalled:u>|
REPLIESLABELLOWER|$<D506:u>|
RESERVATIONLABEL|$<reservation>|

132 Version 3.0, March 2006


Appendix A –iBistro.env

RESERVATIONSLABELCAPS|$<reservations:c>|
RESERVATIONSLABELLOWER|$<reservations>|
SAM_PAY_BILL_TEXT|$<pay_bill_with_sam>|
SAM_PAY_ALL_BILLS_TEXT|$<pay_all_bills_with_sam>|
SAM_HEAD_PART1|$<sam_head_part1>|
SAM_HEAD_PART2|$<sam_head_part2>|
SEEMOREINFOLABEL|$<see_more_info>:|
SUSPENDBEGINCOLTEXT|$<suspension_start_date:u>|
SUSPENDENDCOLTEXT|$<suspension_end_date:u>|
TITLECOLTEXT|$<title:u>|
UNAVAILABLETEXT|($<unavailable>)|
USERINFO_SCREEN_TITLE|$<MY_ACCOUNT_DESC>|
USERSTATUSBILLS|$<bills:U>|
USERSTATUSBOOKINGS|$<bookings:U>|
USERSTATUSCHECKOUTS|$<checkouts:U>|
USERSTATUSHOLDS|$<holds:U>|
USERSTATUSREQUESTS|$<D506:U>|
USERSTATUSRSVNS|$<reservations:U>|
# User Access Denied labels -- 26.pg
USER_ACCESS_DENIED_SCREEN_TITLE|$<access_cont_failure>|
USER_ACCESS_DENIED_MSG|$<access_denied>|
USER_ACCESS_PASSWD_EXPIRED_MSG|$(13453)|

# Contents/Index labels -- 31.pg


CONTENTS_PLACE_MARKER|$<you_are_here>|

# List of Request labels -- 33.pg


REQUEST_LIST_SCREEN_TITLE|$<types_requests>|
REQUEST_LIST_INSTRUC|$<select_request_type>|

# Place Request button labels -- 34.pg


PLACE_REQ_SEND_TEXT|$<send>|
PLACE_REQ_RESET_TEXT|$<reset_query_val>|
MY_USERID_IS|$<my_userid_is>:|

# Place Request labels -- 34.pg


ITEMIDLABELPUBLIC|$<itemID>:|
NUM_REQ_ROWS|3|

# Request Placed labels -- 35.pg


REQUEST_SUCCESS_SCREEN_TITLE|$<request_confirmation>|
REQUEST_SUCCESS_MSG|$<your_request_placed>|

# Place Holds use flags -- 36.pg, 37.pg, 71.pg


# hide the user ID on hold confirmation page
HIDEUSERID|0|
# hide the user alt ID on hold confirmation page
HIDEALTID|0|
# offer the option to set hold against reserve materials
ALLOWRESERVEHOLDS|0| # not valid in iBistro or WebCat - value must stay 0
# offer the pickup library option
# (offers all libraries in list unless default defined in HOLD_PICKUP_LIBR_LIST)
USE_HOLD_PICKUP_LIBR|1|
# Custom pickup library list.
# Sample: HOLD_PICKUP_LIBR_LIST|<OPTION VALUE=MAIN>Main Library<OPTION
VALUE=BRANCH1>Branch1 Library<OPTION VALUE=BRANCH4>Branch4 Library|
HOLD_PICKUP_LIBR_LIST||
HOLD_RANGE|GROUP| # Demand Management hold range: "GROUP" or "SYSTEM"
# Allow the users to edit holds
USE_EDIT_HOLD|0|
# Allow the user to enter hold suspension dates when creating and editing holds
USE_SUSPEND_HOLD|0|
# Allow the user to enter/edit default hold expiration date
USE_HOLD_EXPIRATION_DATE|0|

# Place Holds button labels -- 36.pg


PLACE_HOLD_SEND_TEXT|$<place_hold>|
PLACE_HOLD_RESET_TEXT|$<reset_query_val>|

# Place Holds labels -- 36.pg

Version 3.0, March 2006 133


Fundamentals of iBistro/iLink Customization

PLACE_HOLD_TEXT|$<place_hold>|
ITEMNUMLABELPUBLIC|$<call_num>:|
COPYPROMPT|$<copy>:|
PICKUP_LIBR_PROMPT|$<pickup_at>:|
HOLD_EXP_DATE_PROMPT|$<expiration_date>:|
SUSPEND_START_DATE_PROMPT|$<suspension_start_date>:|
SUSPEND_END_DATE_PROMPT|$<suspension_end_date>|
AUTHOR_PROMPT|$<AUTHOR_TERM_DESC>:|
TITLE_PROMPT|$<TITLE_TERM_DESC>:|

# Z3950 Search Form defaults -- 38.pg


ZSEARCH_SORT_BY|ANY|

# Z3950 Search Form labels -- 38.pg


ZR38_SCREEN_TITLE|$<search_on>|
ZSEARCH_INSTRUC|$<type_search_term_select_search>.|
ZSEARCH_RADIO_TEXT|$<search:u>|
ZBROWSE_RADIO_TEXT|$<browse:u>|
ZSEARCH_SEND_TEXT|$<search:u>|
ZSEARCH_RESET_TEXT|$<reset:u>|
ZLOOKUPOPTIONSHEADING|$<limit_by:u>|
ZRLOOKUPQUALBROWSE|$<browse_if_nothing>:|
ZRLOOKUPQUALDETAIL|$<show_search_details>:|

# Z3950 Login Authentication labels -- 39.pg


ZR39_SCREEN_TITLE|$<access_cont>|
ZR39_AUTHENTICATION|$<authentication:u>:|
ZLOGIN_SEND_TEXT|$<login:u>|

# Z3950 Search No-Hits labels -- 40.pg


ZR40_SCREEN_TITLE|$<search_results>|

# Z3950 Search Hits Use flags -- 41.pg


# display link to ILL request on Z39.50 hit list and single item view
USE_ILL_ICON|0|

# Z3950 Search Hits defaults -- 41.pg


# Name of request policy to use for ILL request
ILL_REQUEST_TYPE|ILL|

# Z3950 Search Hits List labels -- 41.pg


ZRSEARCH_RESULTS|$<search_results>|
ZRSEARCH_DETAIL|$<D530>|
ZHITLISTMSG1|$<search_found>|
ZHITLISTMSG2|$<records>.|
LIBHQ_COPYRIGHT|$<copyright> &#169; 2001, LibraryHQ|
Z3950_HITS_FOR| $<z3950_hits_for> |# revB only

# Z3950 Single Item Display -- 42.pg


# See also Catalog Single Item View -- 5.pg

# Z3950 Browse List labels -- 43.pg


ZR43_SCREEN_TITLE|$<browsing:u>|

# Z3950 Query History labels -- 44.pg


ZRQUERYNUM|$<query:u> #|
ZRQUERYHISTORYHEADING|$<query_history>|
ZRQUERYHISTORYDOCS|$<D205>|
ZRQUERYHISTORYMSG|$<zsearch_again_prev_queries>:| # revB only

# Z3950 Local Holdings List labels -- 45.pg


ZR45_SCREEN_TITLE|$<local_holdings>|
ZRHOLDINGSMATCHCNT|$<D344>|
ZRHOLDINGSMATCHLABEL|$<D343>|

# User Request List labels -- 46.pg


URL_SCREEN_TITLE|$<user_requests>|
REQ_TOTAL_LABEL1|$<you_have> |
REQ_TOTAL_LABEL2| $<requests>.|
REPLYTEXT1| $<D835> |

134 Version 3.0, March 2006


Appendix A –iBistro.env

REPLYTEXT2| $<request> |
REPLYSENTTEXT|$<D862> |
REPLYNOTSENTTEXT|$<D843>.|

# User Request View labels -- 47.pg


URV_SCREEN_TITLE|$<request:u>|
REPLYTEXT3|$<on:u> |
REPLYTEXT4| $<D855> |
REPLYTEXT5| $<D851> |
REPLYTEXT6|$<D854> |
REQUESTINFOHEADING|$<D672>|
REPLYINFOHEADING|$<D845>|

# Login page labels -- 48.pg, 74.pg


LOGIN_FORM_TITLE|$<logintoopac>|
LOGIN_FORM_INSTRUCT|$<webcat_login_instr>|
LOGIN_HOME_URL_LABEL|$<home:u>|

# User PIN Change Form button labels -- 50.pg


USER_PIN_SEND_TEXT|$<change_PIN>|
USER_PIN_RESET_TEXT|$<reset_query_val>|

# User PIN Change Form labels -- 50.pg


USER_PIN_INSTRUC|$(13455)|
ENTERPINPROMPT|$<D219>:|
REENTERPINPROMPT|$<D483>:|

# User PIN Changed labels -- 51.pg


UPC51_SCREEN_TITLE|$<PIN_changed>|
USER_PIN_MESSAGE1|$<s_PIN_changed>.|

# User Renew Access form button labels -- 52.pg


USER_ID_SEND_TEXT|$<list_charged_items>|
USER_ID_RESET_TEXT|$<reset_query_val>|

# User Renew List button labels -- 53.pg


USER_RENEW_SEND_TEXT|$<renew_selected_items>|
USER_RENEW_RESET_TEXT|$<clear_selections>|

# User Renew List labels -- 53.pg


UR53_SCREEN_TITLE|$<select_items_to_renew>|
RENEW_SELECTED_LABEL|$<renew_selected_items>|
RENEW_ALL_LABEL|$<D489:u>|
RENEW_LIST_COUNT_MSG|$<items_eligible_for_renewal:L>.|
RENEW_LIST_SELECT_MSG1|$<use_checkboxes>|
RENEW_LIST_SELECT_MSG2|$<below_mark_items_to_renew>.|
RENEW_LIST_ACNT_ERROR|$<accountable_item_renewable_only_by_staff>|

# User Renew Results labels -- 54.pg


UR54_SCREEN_TITLE|$<items_renewed>|
RENEW_SUCCESS_SINGLE|$<item_was_renewed>.|
RENEW_SUCCESS_MULTI|$<items_were_renewed>.|
RENEW_FAIL_SINGLE|$<item_failed_to_be_renewed>.|
RENEW_FAIL_MULTI|$<items_failed_to_be_renewed>.|
RENEW_LIMIT_ERROR_MSG|$<renew_limit_msg>.|

# Reserves Single View use flags -- 55.pg


# display circulation rule with reserve info
DISPRSVCIRCRULE|1|
# if Reservation is configured, offer Reservation button
USERESERVATION|1|

# Reserves Single View labels -- 55.pg


RSV_VIEW_TITLE|$<full_view_reserve:u>|
HOLDINGSTEXT|$<holdings:U>|
RESERVECOLTEXT|$<reserve_desk_circ>|
RESERVEDESKTEXT|$<P993:u>|
RESVCIRCRULETEXT|$<circ_rule2:u>|
ITEM_RESERVED_BY|$<S46:u>|
ITEMS_RESERVED_BY|$<S48:u>|
RSVCOPIES_AVAIL|$<rsvcopies_available>.|

Version 3.0, March 2006 135


Fundamentals of iBistro/iLink Customization

RSVCOPIES_AVAIL_AT|$<rsvcopies_available_at>|
RSVCOPY_AVAIL|$<rsvcopy_available>.|
RSVCOPY_AVAIL_AT|$<rsvcopy_available_at>|
RSVCOPYSTAT_NONE_AVAIL|$<no_rsvcopies_available>.|
COPYSTAT_TOTAL_RSV|$<copy_totl_on_rsv>.|
COPIESSTAT_TOTAL_RSV|$<copies_totl_on_rsv>.|

# Exact Browse Failure labels -- 56.pg


NOTFOUND_EXACTBROWSE_MSG|$(450)|

# User Renew Not Allowed -- 57.pg


UR57_SCREEN_TITLE|$<materials_renewal>|
UNAUTH_RENEW|$(13456)|

# Reserves Booking Form -- 58.pg


BK58_SCREEN_TITLE|$<book_item>|
BOOK_START_TIME_PROMPT|$<start_daytime> ($<daytime_pattern>):|
BOOK_END_TIME_PROMPT|$<end_daytime> ($<daytime_pattern>):|
USE_BOOK_END_TIME|1|
USE_PICKUP_LIBRARY|1|
PICKUP_LIBRARY_PROMPT|$<P862>:|
BOOK_RSV_SEND_TEXT|$<book_item>|
BOOK_TIME_PROMPT|$<booking_times>|

# Item Booked Page -- 59.pg


BK59_SCREEN_TITLE|$<item_booked>|

# User Bookings Page -- 60.pg


BOOKING_TIME_LABEL|$<booked_for>:|
PICKUP_LIBRARY_LABEL|$<pickup_at>|

# Z39.50 Print/Capture Search Results use flags -- 66.pg


# offer the option to print the marked titles to a local printer
USEZCAPPRINTLOCAL|1|
# offer the option to print the marked titles to a system printer
USEZCAPPRINTSYSTEM|0|
# offer the option to save the marked titles
USEZCAPSAVE|0|
# offer the option to view the marked titles
USEZCAPVIEW|1|
# offer the option to email the marked titles
USEZCAPEMAIL|1|
# offer option when processing the marked titles: FORMATTED or FLAT ASCII
# use ZCAPOPT_FORMAT to set the default value
USE_ZCAPOPT_FORMAT|1|
# offer entry number specification when processing the marked titles
# use ZCAPOPT_ELST to set the default value
USE_ZCAPOPT_ELST|1|

# Z39.50 Print/Capture Search Results labels -- 66.pg


ZCAP66_SCREEN_TITLE|$<print_capture_kept>|

# Z39.50 Print/Capture Search Results defaults -- 66.pg


ZCAPOPT_FORMAT|FORMATTED|
ZCAPOPT_ELST|FULL|

# Edit Request button labels -- 67.pg


EDIT_REQ_SEND_TEXT|$<edit_request>|
REQ_FOLLOWUP_LABEL|$<D825:u>|

# Holds Deleted -- 70.pg


DELHOLDS_MSG|$<holds_cancelled>|

# Enhanced Hold Form -- 71.pg


ENHHOLD_FIRSTAVAIL_LABEL|$<first_available>|
ENHHOLD_SELECTEDCALL_LABEL|$<volumes_selected_list>|
ENHHOLD_CALL_MSG|$<enhhold_call_msg>|\
PICK_EXPIRATION_DATE|$<calendar_pick_expiration_date_txt>|
PICK_SUSPEND_BEGIN_DATE|$<calendar_pick_suspend_begin_date_txt>|

136 Version 3.0, March 2006


Appendix A –iBistro.env

PICK_SUSPEND_END_DATE|$<calendar_pick_suspend_end_date_txt>|

# Enhanced Hold Created -- 72.pg


HOLDS_PLACED_MSG|$<holds_placed>|

# Login/change-password -- 74.pg
NEW_PASSWORD|$<enter_new_password>:|
NEW2_PASSWORD|$<reenter_new_password>:|

# Booking Form -- 75.pg


BK75_SCREEN_TITLE|$<list_of_item_bookings>|
BOOK_ITEMS_EXPLAIN|$<book_items_explain>|
BOOK_PREPARE_SEND_TEXT|$<book_item_set_datetime>|
CALENDAR_LABEL|$<bookings_on_item>| #revC only
BOOKINGS_NONE_TEXT|$<none>|
BOOKING_CAL_MONTHS|2|

# No hits found page -- 76.pg


NOTHING_FOUND_MSG|$<your_search_found_nothing>|
NOHIT_OPTIONS_MSG|$<nohit_options_msg1>|
NOHIT_OPTIONS_WITHBRWS_MSG|$<nohit_options_msg2>|
CLOSEST_MATCH_ALL_LIBS_MSG|$<closest_match_found_all_libs>|
CLOSEST_MATCH_ONE_LIB_MSG|$<closest_match_found_one_lib>|
RE_SEARCH_NEW_TERMS|$<search_new_words>|
RE_SEARCH_ALL_LIBS|$<search_all_libraries>|
RE_SEARCH_ANOTHER_GROUP_LIBS|$<search_another_group_libraries>|
RE_SEARCH_ANOTHER_LIB|$<search_another_library>|
RE_SEARCH_NEW_TERMS_BUTTON_MSG|$<re_search_new_words_button_msg>| # revB only
RE_SEARCH_BUTTON_MSG|$<re_search_button_msg>|# revB only
SEARCH_NOHITS|$<search_found_no_matches>.|
SEARCH_NOHITS_LIB|$<search_found_no_lib_matches>.|
SEARCH_NOHITS_ALLLIBS|$<search_found_nothing_alllibs>|

# Fix bad request page -- 77.pg


DATA_VALIDATION_ERRORS_MSG|$<data_validation_errors>|

# Select Item for Reservation -- 84.pg


RSVN_SELECT_DATE|$<rsvn_item_set_datetime>|
RSVN_TIME_LABEL|$<rsvn_time_label>:|
RSV84_SCREEN_TITLE|$<select_rsvn_item>|

# Reservation Form -- 85.pg


RSV85_SCREEN_TITLE|$<reservation_item>|
PLACE_RESERVATION|$<place_reservation>|
PICK_START_DATE|$<calendar_pick_startDate_txt>|
PICK_END_DATE|$<calendar_pick_endDate_txt>|
RSVN_CAL_MONTHS|2|
USE_RSVN_END_TIME|1|
RSVN_TIME_PROMPT|$<rsvn_time_prompt>|
RSVN_START_TIME_PROMPT|$<start_daytime> ($<daytime_pattern>):|
RSVN_END_TIME_PROMPT|$<end_daytime> ($<daytime_pattern>):|

# Reservations Deleted -- 87.pg


DELRSVNS_MSG|$<rsvns_cancelled>|

# Holds Deleted -- 88.pg


EDITHOLDS_MSG|$<holds_edited>|

# eBook Checkout -- 89.pg


CHECKOUT_MSG|$<item_checked_out_cs>|
# loan period for BWI in minutes
# needs to be coordinated with the circ policy
BWI_LOAN_PERIOD|120|
BWI_USE_EBOOK|$<use_ebook>|
BWI_CHECKOUT_MESSAGE|$<bwi_checkout_message>|

# eBook -- 90.pg
BWI_LOGIN_SEND_TEXT|$<use_ebook>|
BWI_LOGIN_RESET_TEXT|$<reset:u>|

# eBook -- 91.pg

Version 3.0, March 2006 137


Fundamentals of iBistro/iLink Customization

BWI_VIEW_MESSAGE|$<bwi_vib_message>|

# Select VIB or Checkout of eBook -- 92.pg


BWI_VIB|$<view_in_browser>|
BWI_CHECKOUT|$<checkout_download>|

# Payment acknowledgement -- 93.pg


BILLPAYMENT_MSG|$<bill_status>|
PAYMENT_BALANCE|$<with_balance>|

# Z39.50 Broadcast Search Results Header -- 78.pg


ZBROADCAST_DB_STATUS|$<zdb_currently_unavailable>| # revB only
ZBROADCAST_RESULTS_LABEL|$<zbroadcast_results>| # revB only
TITLELABEL|$<title>| # revB only
TITLESLABEL|$<titles>| # revB only

# Best Sellers Hits List -- 81.pg


NO_COPIES_FOUND|$<no_copies_found>.|
SEARCH_OTHER_EDITIONS|$<search_other_editions>.|
BEST_SELLERS_FOUND_SUMMARY1| $<best_sellers_found_summary1> |
BEST_SELLERS_FOUND_SUMMARY2| $<best_sellers_found_summary2>|

# Tell Me When Favorite Created -- 82.pg


FAVORITE_CREATED_MSG|$(13475).|

# Web Resources Search Categories -- 2000.pg


# display the Hot Sites Archive choice
HOT_SITES_ARCHIVE_CONFIG|1|
WEBRESOURCES_LIST_LABEL|$<web_resources>|
WEBRESOURCES_LIST_DESC|$<web_resources_desc>|

# My Favorites -- 2001.pg
MY_FAV|$<my_fav>...|
MY_FAVS_HEADING|$<my_favs>| # revB only
MY_FAVS_DESC|$<my_favs_desc>.| # revB only
MY_FAV_AUTHORS|$<my_fav_authors>|
MY_FAV_SUBJECTS|$<my_fav_subjects>|
AUTHORS|$<authors:u>|
SUBJECTS|$<subjects:u>|

# Most Popular -- 2002.pg


MOSTPOP_SCREEN_TITLE|$<what_others_read>|
MOSTPOP_DESC|$<most_popular_description>|
MOSTPOP_SALUTE|$<happy_surfing>!|
MOSTPOP_TITLE|$<most_pop_title>:|
MOSTPOP_TITLES|$<most_pop_titles>...|
MOSTPOP_SUBJECT|$<most_pop_subject>:|
MOSTPOP_SUBJECTS|$<most_pop_subjects>...|
MOSTPOP_AUTHOR|$<most_pop_author>:|
MOSTPOP_AUTHORS|$<most_pop_authors>...|

# Modify Favorites -- 2003.pg


REMV_ALL_AUTHS|$<remove_all_authors>|
REMV_ALL_SUBJS|$<remove_all_subjects>|
REMV_SELECTED_AUTHS|$<remove_selected_authors>|
REMV_SELECTED_SUBJS|$<remove_selected_subjects>|
MODIFY_FAVS_HEADING|$<modify_my_favs:u>|
MODIFY_FAVS_DESC|$<modify_favs_desc>|

# MyProfile Edit -- 2005.pg


MYBISTROHEADING|$<mybistro_heading>|
MYBISTRO_NOTIFY_INTERVAL1|$<mybistro_notify_interval1>|
MYBISTRO_NOTIFY_INTERVAL2|$<mybistro_notify_interval2>.|
MYBISTRO_TRACK_CHECKOUTS|$<mybistro_track_checkouts>.|

# Place Holds button labels -- 2009.pg


EDIT_HOLD_SEND_TEXT|$<edit_hold>|
EDIT_HOLD_RESET_TEXT|$<reset_query_val>|
EDIT_SELECTED_HOLD_TEXT|$<edit_selected_hold>|

138 Version 3.0, March 2006


Appendix A –iBistro.env

# Hyperion Archive
#
HYPERION_GATEWAY|HYPERION|
DEF_ARCH_ORGA_TYPE|Content|
ARCH_BRWS_HITS|300|
ARCH_PHYSORD_IMG|PHYSORD.gif|

# For XML displays, defines the URL to the processing servet


HYPER_XSL_SERVLET_URL|/servlet/servlet.XSLTServletWithParams|
# Subdirectory name for Hyperion XSL stylesheets
HYPER_XSL_STYLE|Default|

#
# ARCH_META_WINDOW: Whether Meta Data is displayed in:
# 1 -- the main Hyperion browser window.
# 2 -- the image Hyperion browser window.
# 3 -- another, 3rd Hyperion browser window.
ARCH_META_WINDOW|1|

# Archive Search Form default & use flags -- 900.pg


ARCH_USE_CONTENT_SEARCH|1|
ARCH_DEF_QUERY_TYPE|CONTENT_SRCH| # Either CONTENT_SRCH or ATTRIBUTE_SRCH
ARCH_ATTR_NUM_HITS|20|
ARCH_CONT_NUM_HITS|20|
# include DESCRIPTION, ORGUNIT ID & ALT ID as search choices with ORGA policies
ARCH_USE_SEARCH_EXTRAS|1|

# Archive Search Form labels -- 900.pg


ARCH900_SCREEN_TITLE|$<archive_srch_page>|
ARCH_SRCH_SEND_TEXT|$<archive_srch_text>|
ARCH_ATTRIBUTE_SRCH_LABEL|$<metadata_desc>|
ARCH_FIELD_SRCH_LABEL|$<field_search>|
ARCH_OPER_SRCH_LABEL|$<D390:u>|
ARCH_TERM_SRCH_LABEL|$<search_term:u>|
ARCH_CONTENT_SRCH_LABEL|$<D138:u>|

# Archive Browse -- 901.pg


ARCH901_SCREEN_TITLE|$<hierarchy>|
ARCH_USE_DSPORGATTR|1|

# Archive View labels -- 902.pg


ARCH902_SCREEN_TITLE|$<archive_view_page>|
ARCH_NO_IMG|$(9377).|

# Archive Print Form button labels -- 903.pg


ARCHIVE_PRINT_SEND_TEXT|$<archive_print_page>|

# Archive Print use flags -- 903.pg


USE_ARCH_PRINTER_PULLDOWN|1|
USE_ARCH_PRINTER_TEXT|1|

# Archive Print Form labels -- 903.pg


ARCH903_SCREEN_TITLE|$<archive_print_page>|
DOCUMENT_LABEL|$<P325:u>:|
ARTICLE_LABEL|$<article:u>:|
PRINTER_LABEL|$<printer:u>:|
PRT_PAGES_LABEL|$<print_pages:u>:|
END_PAGES_LABEL|$<pages_document>|
ALL_PAGES_RADIO|$<all_pages:u>|
PAGE_RANGE_RADIO1|$<pages:u>|
PAGE_RANGE_RADIO2|$<through>|
PAGE_LAST_VIEWED|$<page_last_viewed:u>|
COPIES_LABEL|$<copies:u>:|

# Archive Print labels -- 904.pg


ARCH904_SCREEN_TITLE|$<print:u>|
ARCH_PRINT_SUCCESS_MSG|$(9376).|

# Archive Orgunit Info labels -- 905.pg


ARCH905_SCREEN_TITLE|$<D185:u>|
ARCH_LABEL_ORGID|$<name:u>|

Version 3.0, March 2006 139


Fundamentals of iBistro/iLink Customization

ARCH_LABEL_ORGALTID|$<altID:u>|
ARCH_LABEL_HIER|$<P14:u>|
ARCH_LABEL_ATTR|$<P66>|
ARCH_LABEL_DESC|$<description:u>|

# Archive Hitlist -- 906.pg


ARCH906_SCREEN_TITLE|$<search_results:u>|
ARCH_HITLIST_HEAD1|$<search_found:u>|
ARCH_HITLIST_HEAD2|$<hits:L>. $<below_are_numbers>|
ARCH_HITLIST_HEAD3|$<through>|
USE_ARCH_SRCH_ATTR_DISP|1|

# Archive Page Jump -- 907.pg


ARCH907_SCREEN_TITLE|$<page_jump:u>|
ARCH_JUMPTO_HEAD1|$<there_r>| # revB only
ARCH_JUMPTO_HEAD2|$<pages>| # revB only
ARCH_JUMPTO_LABEL|$<page_number:u>|
ARCH_JUMPTO_SEND|$<jump:u>|

# Archive Search Results Jump -- 908.pg


ARCH908_SCREEN_TITLE|$<hit_jump>|
ARCH_SRCH_JUMPTO_HEAD1|$<you_found>|
ARCH_SRCH_JUMPTO_HEAD2|$<items>|
ARCH_SRCH_JUMPTO_LABEL|$<hit_number:u>|
ARCH_SRCH_JUMPTO_SEND|$<jump:u>|

# Archive Content-type Search Hitlist -- 909.pg


ARCH909_SCREEN_TITLE|$<search_results:u>|
USE_ARCH_AUGMENT|1|

# Archive Image View Buttons -- 911.pg


ARCH_USE_SHOPPING_CART|0|

# Archive Image Marked -- 912.pg


ARCH_IMG_MARKED_MSG|$(13444)|

# Archive Image Marked -- 913.pg


ARCH_SHOPPING_CART_TITLE|$<session_list>|

# Image ALT text


ALTTEXT_ACADRESVREQ|$<alttext_acadresvreq>|
ALTTEXT_AUGMENT|$<alttext_augment>|
ALTTEXT_AUTHORBIO|$<alttext_authorbio>|
ALTTEXT_BACKWARD|$<alttext_backward>|
ALTTEXT_BLURB|$<alttext_blurb>|
ALTTEXT_BOOKITEM|$<alttext_bookitem>|
ALTTEXT_BOOKWRAP|$<alttext_bookwrap>|
ALTTEXT_BOTTOM|$<alttext_bottom>|
ALTTEXT_BUYNOW|$<alttext_buynow>|
ALTTEXT_CANCEL|$<alttext_cancel>|
ALTTEXT_CAPTURE|$<alttext_capture>|
ALTTEXT_CHANGEDISPLAY|$<alttext_changedisplay>|
ALTTEXT_COVER|$<alttext_cover>|
ALTTEXT_DOWN|$<alttext_down>|
ALTTEXT_EBRARY|$<alttext_ebrary>|
ALTTEXT_EMAIL|$<alttext_email>|
ALTTEXT_END|$<logout>|
ALTTEXT_EXCERPT|$<alttext_excerpt>|
ALTTEXT_FORWARD|$<alttext_forward>|
ALTTEXT_FULLDETAILS|$<alttext_fulldetails>|
ALTTEXT_GOBACK|$<alttext_goback>|
ALTTEXT_HELP|$<alttext_help>|
ALTTEXT_HIERARCHY|$<alttext_hierarchy>|
ALTTEXT_HISTORY|$<alttext_history>|
ALTTEXT_HOLDINGS|$<alttext_holdings>|
ALTTEXT_HOLD|$<RTYP_desc_hold>|
ALTTEXT_ILL|$<alttext_ill>|
ALTTEXT_JUMP|$<alttext_jump>|
ALTTEXT_KEEP|$<alttext_keep>|
ALTTEXT_KEPT|$<alttext_kept>|
ALTTEXT_LIMITSEARCH|$<alttext_limitsearch>|

140 Version 3.0, March 2006


Appendix A –iBistro.env

ALTTEXT_LOGINBENEFITS|$<alttext_loginbenefits>|
ALTTEXT_MEDIA|$<alttext_media>|
ALTTEXT_MODIFY|$<alttext_modify>|
ALTTEXT_MOREINFO|$<alttext_moreinfo>|
ALTTEXT_MORE|$<alttext_more>|
ALTTEXT_MYLIST|$<alttext_mylist>|
ALTTEXT_MYPROFILE|$<alttext_myprofile>|
ALTTEXT_NEWSEARCH|$<alttext_newsearch>|
ALTTEXT_NEXTPAGE|$<alttext_nextpage>|
ALTTEXT_OK|$<alttext_ok>|
ALTTEXT_POWERSRCH|$<alttext_powersrch>|
ALTTEXT_PREFERENCES|$<alttext_preferences>|
ALTTEXT_PREVIOUSPAGE|$<alttext_prevpage>|
ALTTEXT_PRINTFORMATTED|$<alttext_printformatted>|
ALTTEXT_PRINTLOCAL|$<alttext_printlocal>|
ALTTEXT_PRINTSYSTEM|$<alttext_printsystem>|
ALTTEXT_RECPURCH|$<alttext_recpurch>|
ALTTEXT_REMOVE|$<remove:u>|
ALTTEXT_RESERVATION|$<alttext_reservation>|
ALTTEXT_RESETQUERY|$<alttext_resetquery>| # revB only
ALTTEXT_REVIEW|$<alttext_review>|
ALTTEXT_SAVE|$<alttext_save>|
ALTTEXT_SEECONTENTS|$<alttext_seecontents>|
ALTTEXT_SEEINDEX|$<alttext_seeindex>|
ALTTEXT_SNGSRCH|$<alttext_ssearch>|
ALTTEXT_SUMMARY|$<alttext_summary>|
ALTTEXT_TELLMEWHEN|$<alttext_tellmewhen>|
ALTTEXT_TEXTARCHIVE|$<alttext_textarchive>|
ALTTEXT_TOC|$<alttext_toc>|
ALTTEXT_TOP|$<alttext_top>|
ALTTEXT_UP|$<alttext_up>|
ALTTEXT_URL|$<alttext_url>|
ALTTEXT_VIEWCART|$<alttext_viewcart>|
ALTTEXT_VIEWOPTIONS|$<alttext_viewoptions>|
ALTTEXT_VIEW|$<alttext_view>|
ALTTEXT_XREF|$<alttext_xref>|
ALTTEXT_OPTIONS|$<options>|

# Item types which should display icons in hits list (only if DISP_ITYPICON = 1)
# Up to 20 item types may be defined (see list of icons delivered below)
ITYP01DISP|BOOK| #if item type is BOOK
ITYP01ICON|BOOK| #display icon BOOK.gif

ITYP02DISP|NEW-BOOK| #if item type is NEW-BOOK


ITYP02ICON|BOOK| #display icon BOOK.gif

ITYP03DISP|ILL-BOOK| #if item type is ILL-BOOK


ITYP03ICON|BOOK| #display icon BOOK.gif

ITYP04DISP|REF-BOOK| #if item type is REF-BOOK


ITYP04ICON|REFBOOK| #display icon REFBOOK.gif

ITYP05DISP|MAGAZINE| #if item type is MAGAZINE


ITYP05ICON|MAGAZINE| #display icon MAGAZINE.gif

ITYP06DISP|AV| #if item type is AV


ITYP06ICON|MMEDIA| #display icon MMEDIA.gif

ITYP07DISP|NEWSPAPER| #if item type is NEWSPAPER


ITYP07ICON|NEWSPAPER| #display icon NEWSPAPER.gif

ITYP08DISP|MICROFORM| #if item type is MICROFORM


ITYP08ICON|FILMSTRIP| #display icon FILMSTRIP.gif

ITYP09DISP|AV-EQUIP| #if item type is AV-EQUIP


ITYP09ICON|EQUIPMENT| #display icon EQUIPMENT.gif
# full list of icon names delivered:
# AUDIOCASS, AVEQUIP, BOOK, CDMUSIC, CD, DISKETTE, ELECFILE, EQUIPMENT, FILMSTRIP,
# KIDS, KIT, LARGEPRT, LPRECORD, MAGAZINE, MAP, MMEDIA, NEWSPAPER, REFBOOK,
# SCORE, SERIAL, SLIDE, SOUND, TV, VIDEO

Version 3.0, March 2006 141


Fundamentals of iBistro/iLink Customization

# DATE_TYPE is used to set a date display


# If DATE_TYPE is blank then the UNICORN date setting is used
# 0 is for american style dates
# 1 is for european style dates
# 2 is for asian style dates
# 3 is for hijri style dates
DATE_TYPE||

# CHANGE_DATE_TYPE is used to control whether or not the


# user can alter the date type
# 0 is used to block the user from changing the date type
# 1 is used to allow the user to change the date type
CHANGE_DATE_TYPE|0|

# WEBCAT_DATE_TYPES is used to specify which date types to allow


# Sample: WEBCAT_DATE_TYPE|0:$<date_type_american:4>,1:
$<date_type_european:4>,2:$<date_type_asian:4>,3:$<date_type_arabic:4>|
WEBCAT_DATE_TYPE||

142 Version 3.0, March 2006


Appendix A –iBistro.env

Version 3.0, March 2006 143


Appendix B –
link.env
WEBCAT_NAME|iLink|

#iLink Image directories


IMG_OTHER|Miscil|
IMG_ROOTBAR|Link|
IMG_ACCSTAB|Link|
IMG_SRCHICON|Link|
IMG_SPECIAL|Link|
IMG_BUTTONS|Link|
#iLink color environment parameters
ACCOUNT_HEADING_BGCOLOR|#FFCC33| # lt yellow-orange
ACCOUNT_STRIPE_BGCOLOR|#EEEEEE| # pale gray
ANNOUNCE_BGCOLOR|#FFCC33| # lt yellow-orange
BUTTONBAR_BGCOLOR|#003366| # navy blue
FORM_BGCOLOR|#EEEEEE| # pale gray
GATELIST_HEADING_COLOR|#FFCC33| # lt yellow-orange
GATELIST_LINE_COLOR|#EEEEEE| # pale gray
GATELIST_STRIPE_COLOR|#EEEEEE| # pale gray
HOLDINGSSTRIPE_BGCOLOR|#CCCCCC| # med gray
LISTNUM_BGCOLOR|#99CCFF|
LISTSTRIPE_BGCOLOR|#EEEEEE| # pale gray
LIBINFO_BGCOLOR|#666666| # dk gray
MYFAVAUTH_BGCOLOR|#CCCCCC| # med gray
MYFAVSUBJ_BGCOLOR|#9999CC| # lavendar
ORDERSSTRIPE_BGCOLOR|#99CCEE|
PAGETOP_BGCOLOR|#99CCFF|
POPAUTHORS_BGCOLOR|#666666| # dk gray
POPSUBJECTS_BGCOLOR|#666666| # dk gray
POPTOP_BGCOLOR|#666666| # dk gray
HOTURLS_BGCOLOR|#666666| # dk gray
LCCATS_BGCOLOR|#666666| # dk gray
MYFAVS_BGCOLOR|#666666| # dk gray
XREFS_BGCOLOR|#666666| # dk gray
BESTSELL_BGCOLOR|#666666| # dk gray
POPTITLES_BGCOLOR|#666666| # dk gray
RECREAD_BGCOLOR|#666666| # dk gray
ROOTBAR_BGCOLOR|#666666| # dk gray
RSVSTRIPE_BGCOLOR|#EEEEEE| # pale gray
XREFSTRIPE_BGCOLOR|#EEEEEE| # pale gray
ROOTBAR1_TEXT_COLOR|#666666| # dk gray
ROOTBAR1_LINK_COLOR|#666666| # dk gray
ROOTBAR1_BGCOLOR|#FFFFFF| # white
ROOTBAR1_HOVER_COLOR|#FFCC33| # lt yellow-orange
ROOTBAR_TEXT_COLOR|#FFFFFF| # white
ROOTBAR_LINK_COLOR|#FFFFFF| # white
ROOTBAR_HOVER_COLOR|#FFCC33| # lt yellow-orange
#iLink front page labels -- 3.pg
IBISTRO_TAGLINE|$<ilink_tagline>|
HOT_SITES_LIST_LABEL|$<hot_sites_list_il>...|
MY_FAV|$<my_fav_il>...|
MY_FAVS_HEADING|$<my_favs_il>|
MOSTPOP_SCREEN_TITLE|$<high_interest_items>|
MOSTPOP_DESC|$<high_interest_description>|
MOSTPOP_SALUTE||
MOSTPOP_TITLE|$<title:c>:|
MOSTPOP_TITLES|$<high_interest_titles>...|
MOSTPOP_SUBJECT|$<subject:c>:|
MOSTPOP_SUBJECTS|$<high_interest_subjects>...|
MOSTPOP_AUTHOR|$<author:c>:|
MOSTPOP_AUTHORS|$<high_interest_authors>...|

Version 3.0, March 2006 144


Appendix A –iBistro.env

LOGIN_FORM_TITLE|$<illogin_form_title>|
# specifies what gateway contains the INFO_DESK_TOP elements
INFO_DESK_GATE|ILINK|
INFO_DESK_TOP|LIB_INFO|
BESTSELL_CONFIG_LIST|ILINK|
RECREAD_CONFIG_LIST|ILINK|

Version 3.0, March 2006 145


Appendix C –
vi Quick Reference
SirsiDynix uses vi for the standard editor for OPAC Manager
interface editing because the vi text editor is provided on every
UNIX platform. There are many different vi keying commands
that are necessary for proficiency with the editor, and this guide
presents approximately 100. SirsiDynix recommends the
following text for further reading:
Learning the vi Editor by Linda Lamb. Sebastopol, CA: O'Reilly
& Associates, Inc., 1994.
h, j, k, l Move left, down, up, right
w, W, b, B Forward, backward by word counting, not
counting punctuation
e, E End of Word, counting, not counting punctuation
), ( Beginning of next, previous sentence
}, { Beginning of next, previous paragraph
]], [[ Beginning of next, previous section
0,$ First, last position of current line
^ First character of current line, ignore spaces
+, - First character of next, previous line
n| Column n of current line
H Top line of screen
M Middle line of screen
L Last line of screen
nH n (number) of lines after top line
nL n (number) of lines before last line
Ctrl-F, Ctrl-B Scroll forward, backward one screen
Ctrl-D, Ctrl-U Scroll down, up one-half screen
Ctrl-E, Ctrl-Y Show one more line at bottom, top of window
z<RETURN> Reposition line with cursor; to top of screen
z. Reposition line with cursor; to middle of screen
Z- Reposition line with cursor; to bottom of screen
Ctrl-L, Ctrl-R Redraw screen (without scrolling)
/pattern Search forward for pattern
/?pattern Search backward for pattern
n, N Repeat last search in same, opposite direction
/, ? Repeat previous search forward, backward
fx Search forward for character x in current line
Fx Search backward for character x in current line
tx Search forward for character before x in current
line
Tx Search backward for character after x in current
line

Version 3.0, March 2006 146


Appendix C – vi Quick Reference

; Repeat previous current-line search


, Repeat previous current-line search in opposite
direction
Ctrl-G Display current line number
nG Move to line number n
G Move to last line in file
:n Move to line number n
mx Mark current position as x
‘x Move cursor to x
‘‘ Return to previous mark or context
x Move to beginning of line containing mark x
Return to beginning of line containing previous
mark
i,a Insert Text before, after cursor
I, A Insert Text at beginning, end of line
o, O Open new line for text below, above cursor
r Change character
cw Change word
cc Change current line
C Change to end of line
R Type over characters
s Delete character and substitute text
S Delete current line and substitute text
x Delete character
X Delete character before cursor
dw Delete word
dd Delete current line
D Delete to end of line
p, P Put deleted text after, before cursor
np Put test from delete buffer number n after cursor
(for last nine deletions)
yw Yank (copy) word
yy Yank current line
"ayy Yank current line into named buffer a
p, P Put yanked text after, before cursor
"aP Put text from buffer a before cursor
. Repeat last edit command
u, U Undo last edit, restore current line
J Join two lines
:d Delete lines
:m Move lines
:co ot :t Copy lines
:.,$d Delete from current line to end of file
:30,60m0 Move lines 30 through 60 to top of file
:.,/pattern/co$ Copy from current line through line containing
pattern to end of file
ZZ Write (save) and quit file
:x Write (save) and quit file
:wq Write (save) and quit file

Version 3.0, March 2006 147


Fundamentals of iBistro/iLink Customization

:w Write (save) file


:w! Write (save) file (overriding protection)
:30,60w newfile Write from line 30 through line 60 as newfile
:30,60w>> file Write from line 30 through line 60 and append to
file
:w %.new Write current buffer named file as file.new
:q Quit file
:q! Quit file (overriding protection)
Q Quit vi and invoke ex
:e file2 Edit file2 without leaving vi
:n Edit next file
:e! Return to version of current file at time of last
write (save)
:e# Edit alternate file
% Current filename
# Alternate filename
vi file Invoke vi editor on file
vi file1 file2 Invoke vi editor on files sequentially
view file Invoke vi editor of file in read-only mode
vi -R file Invoke vi editor of file in read-only mode
vi -r file Recover file and recent edits after system crash
vi + file Open file at last line
vi +n file Open file directly at line number n
vi +/pattern file Open file directly at pattern
ex file Invoke ex editor on file from UNIX

148 Version 3.0, March 2006


Appendix C – vi Quick Reference

Version 3.0, March 2006 149


Index
turn off................................................................. 16
Gateway elements
A Destination ............................................................ 7
Advanced Search ......................................................24 Group Element ...................................................... 7
Gateway icon image files ......................................... 98
Gateway policy................................................... 33, 84
B Group Element ........................................................... 7
Best Sellers List Configuration wizard .....................64
Book lists H
create....................................................................33
overview...............................................................33 Have You Read?
using reports with.................................................41 activate ................................................................ 60
Button image files.....................................................98 overview.............................................................. 60
Hitlists
change default sort............................................... 82
C
Catalog Access Destination elements .......................24 I
Catalog list
create list of local interest items...........................38 ibistro.env................................................................. 75
CGIOPAC_TIMEOUT|180| .....................................74 Image files
Colors buttons ................................................................. 98
change ..................................................................76 change special images ....................................... 101
change in rootbar..................................................77 change toolbar images ....................................... 100
change text color-library slogan...........................78 directory structure (custom images) .................... 99
change text color-title bars ...................................78 gateway icons ...................................................... 98
location.............................................................. 102
manual copy ...................................................... 103
D other .................................................................... 98
Destination element ....................................................7 rootbar ................................................................. 99
set permissions .................................................. 103
setup .................................................................. 102
E special.................................................................. 99
title bar change .................................................. 106
Environment attribute ...............................................71
Index Content Titles report....................................... 67
Environment files
Information Desk policy........................................... 33
color .....................................................................76
fonts .....................................................................76
ibistro.env ............................................................75 K
link.env ................................................................75
overview...............................................................75 Knowledge Portal Element....................................... 19
system.env............................................................75
envn#.env..................................................................83 L
Labels
F change in system.env......................................... 108
File systems ................................................................3 overview............................................................ 107
Fonts Library slogan
change ..................................................................76 change ............................................................... 109
Format search option change text color ................................................. 78
suppress in Power Search.....................................80 link.env..................................................................... 75
List Policies report ................................................... 83
Local interest items .................................................. 38
G LOGIN|1|WEBSERVER|| ........................................ 73
Gateway ....................................................................72
definition................................................................5 M
Gateway Element
Messages

Version 3.0, March 2006 150


Index

overview.............................................................107 Special image files ................................................... 99


Special images
change ............................................................... 101
O system.env................................................................ 75
OPAC Configuration
overview.................................................................5 T
Test environment...................................................... 84
P Timeout message
Policy number...........................................................83 change ............................................................... 111
Power Search Title bar
suppress format search option ..............................80 change image..................................................... 106
Print Bulletins report.................................................59 change library slogan......................................... 109
change text color ................................................. 78
Toolbar
Q change images ................................................... 100
Quick Search.............................................................24
U
R Update iBistro Content Lists report.......................... 67
Recommended Reading Configuration wizard .........67 User environment ..................................................... 69
Remove Bulletins report ...........................................59 User profile .............................................................. 70
Remove Items From Item List report........................59
Reports V
Index Content Title ..............................................67
List Policies..........................................................83 vi key commands) .................................................. 145
Print Bulletins ......................................................59
Remove Bulletins.................................................59 W
Remove Items From Item List .............................59
Update iBistro Content Lists................................67 webconfig file........................................................... 73
Reverse publication year order sort...........................82 CGIOPAC_TIMEOUT|180| ................................ 74
Rootbar LOGIN|1|WEBSERVER|| ................................... 73
change colors .......................................................77 Webservers................................................................. 3
image files............................................................99 What Others Are Reading
change title ........................................................ 110
Wizards
S Best Sellers List Configuration............................ 64
setup_webcat...........................................................103 Recommended Reading Configuration................ 67
Sort WWW Destination Element..................................... 19
by reverse publication year ..................................82

Version 3.0, March 2006 151

S-ar putea să vă placă și