Interface Style Configuration Files - Sections and Variables

Main -> Documentation -> WebZ System Administration -> WebZ Configuration Files -> Interface Style Configuration Files -> Sections and Variables

Interface Style Configuration Files - Sections and Variables

Contents

Introduction
Document Conventions
Sections in Interface Style Configuration Files
Section Descriptions

Introduction

This document is a reference to the sections contained in interface style configuration files. Beginning with SiteSearch 4.1.0, interface styles consist of BaseStyle.ini and associated configuration files. For SiteSearch 4.0.x versions, there is a single file for each interface style.

Document Conventions

<WebZ_root> is the location of your WebZ environment.
4.0.x refers to any SiteSearch 4 version prior to 4.1.0; that is, 4.0.0, 4.0.0a, 4.0.1, or 4.0.2.
HTML file names that begin with the letters "nf" are files specific to the no-frames interface in the WebZ Out-of-the-Box Interface (OBI), version 1.

Sections in Interface Style Configuration Files

The sections in interface style configuration files define various aspects of the WebZ OBI, such as screen colors, font styles, gadget parameters, and so on. The sections are listed below and are arranged according to functionality. Section Descriptions provide general information about each section, links to additional information, and where, applicable describe, one or more of the variables included in the section.

The table indicates where these sections exist in the default interface style configuration file (frameGreenStyle.ini) in the OBI, version 1, which was introduced in SiteSearch 4.1.0. Unless otherwise indicated, the default interface style configuration file for the OBI, version 0 (and SiteSearch 4.0.x versions), defaultStyle.ini, contains all of these sections. See Interface Styles in the WebZ OBI for information about the interface styles included in the OBI, version 1, and the OBI, version 0.

Function	Section	File(s) in OBI, version 1 Default Style
Initialization	[defaults]	BaseStyle.ini
Display	[colors]	colorsGreen.ini
	[fonts]	fontsArial.ini
	[images]	imagesGreen.ini
	[messages]	BaseStyle.ini
Links and Anchors	[anchors]	BaseStyle.ini
	[pages]	pagesFrame.ini
	[targets]	pagesFrame.ini
Gadgets	[BriefSearchResultsHeader] (beginning with version 4.1.0) [DatabaseList] [DbListforScan] (beginning with version 4.1.0) [DbResults] [DumpTool] [ExpandBoxHeader] [FullRecordHeader] (beginning with version 4.1.0) [FullTextHeader] (beginning with version 4.1.0) [ILLConfirm] [ImgDisplay] (beginning with version 4.1.0) [ImgJumpBar] [ImgNav] [JumpBar] [Limits] [QuickSearchTopics] [RefineLimits] [RefineScan] [RefineScreen] [RefineSearch] [ScanIndex] [SearchA] [SearchB] [SearchC] [SearchBoxHeader] [Sort] [SortRefine] [TabBar] [TermFinderSearchHeader] (beginning with version 4.1.0) [TermListSearchHeader] (beginning with version 4.1.0) [ThesTreeSearchHeader] (beginning with version 4.1.0) [ThesNavButtons] (beginning with version 4.1.0) [TopicList]	BaseStyle.ini

Note:

The no-frames interface in the OBI, version 1, contains an additional section, [Toolbar], in the BaseNoFrameStyle.ini configuration file.

Section Descriptions

This is an alphabetical index to the sections contained in interface style configuration files. The variables in each section follow the pattern used throughout SiteSearch configuration files: a variable name and the value assigned to the variable.

[anchors] Section

The [anchors] section lists the HTML anchors that provide links to other pages in the interface. These anchors often contain style table references to the [pages], [images], [targets], and [fonts] sections.

[BriefSearchResultsHeader] Section (beginning with version 4.1.0)

The [BriefSearchResultsHeader] section provides input parameters for the ORG.oclc.gadgets.BriefSearchResultsHeader class, which builds the header on the brief search results page (brief.html or nfbrief.html in the OBI, version 1).

[colors] Section

This section specifies color values for various elements in the interface, such as headings, input boxes, headings, labels, and other text. For consistency, the interface style files shipped with SiteSearch use RGB hex (e.g., #cccc99, #ffffff, etc.) color values for consistency, but you may use any HTML-valid format. The following example shows the color settings for page background, text, links, visited links, active links, input boxes, and input box labels.

bgcolor      =     #ffffff
text         =     #000000
link         =     #006600
vLink        =     #006600
aLink        =     #006600
inputbox     =     #cccc99
inputboxText =     #000000

[DatabaseList] Section

The [DatabaseList] section provides input parameters for the ORG.oclc.gadgets.DatabaseList class, which builds the list of database names that a given patrons can access. In the OBI, version 1, this list appears on the database list screen (dblist.html or nfdblist.html). The anchorCommand parameter refers to the search page that the patron sees if he or clicks a link for a database on the list.

[DbListforScan] Section (beginning with version 4.1.0)

The [DbListforScan] section provides input parameters for the ORG.oclc.gadgets.DbListforScan class, which builds the list of databases scanned to produce browse results. In the OBI, version 1, this list appears in scannav.html or nfscanresults.html.

[DbResults] Section

This section defines input parameters for the class that creates the list of topics and databases that the user searched to obtain the references shown on the search results screen. This class is ORG.oclc.gadgets.DbListforSearchResult in the OBI, version 1, and ORG.oclc.gadgets.SearchResultsDbList in the OBI, version 0.

[defaults] Section

This section defines defaults required to operate all the functions demonstrated in the WebZ OBI.

Variable

Description

DefaultSearchScreen

Default basic search screen. The initialization class, ORG.oclc.obi.initialize, uses the value of this variable to determine the search screen to display when starting a new user session.

HtmlHeadTitle
(beginning with SiteSearch 4.1.0)

Title that appears in the title bar of all of your HTML pages. This variable allows you to enter common information on your all HTML pages in only one place.

defaultDb

Default database. The initialization class, ORG.oclc.obi.initialize, uses the value of this variable to preselect a remote database for searching when starting a new user session.

ILLTextNameforUser

Name (such as Patron or Borrower) used in section headings on the ILL request form (illform.html).

localDb

Default local database. The initialization class, ORG.oclc.obi.initialize, uses the value of this variable to preselect a local database when starting a new user session.

ToolBarTitle

Reference to the image used in the toolbar at the top of the screen.

autho
password

Default autho and password used for ILL authorization on authorize.html if used.

multifullfmt
(beginning with SiteSearch 4.1.0)

Format used by the Advanced Query verb (ORG.oclc.obi.extverb.AdvancedQuery) to display multiple records in full format on the same page.

doublecheckdbs
(beginning with SiteSearch 4.1.2)

If you configure WebZ for ILL double check, specifies the database to search for a particular item (a "home" library) before allowing a patron to submit an ILL request for the item.

Note:

If you use WebZ's Access component (which includes the accessdb database or your own patron authorization database) to control patron authorization to WebZ, the value of the doublecheckdbs column in the instsym table for the institution associated with the patron overrides this value.

doublecheckcontinue
(beginning with SiteSearch 4.1.2)

If you configure WebZ for ILL Double Check, indicates whether to allow the patron to submit an ILL request for a item contained in the double check database (see doublecheckdbs). Possible values are:

TRUE Allow the patron to submit the ILL request even if his/her home library contains the item.

FALSE Do not allow the patron to submit the ILL request if his/her home library contains the item.

Note:

If you use WebZ's Access component (which includes the accessdb database or your own patron authorization database) to control patron authorization to WebZ, the value of the doublecheckcontinue column in the instdbilltable for the database for the institution associated with the patron overrides this value.

nameSpace
QueryCommand
FetchCommand
ScanCommand

(beginning with SiteSearch 4.1.0)

Namespace in inserted into URLs in your SiteSearch system, such as /WebZ/ in the following example:

http://bongo:19860/WebZ/Authorize?sessionid=0

HTML files in the OBI, version 1, and gadgets use these style table references instead of hard-coded references to the WebZ namespace

The default values are:

nameSpace    = /WebZ/
QueryCommand = /WebZ/QUERY
FetchCommand = /WebZ/FETCH
ScanCommand  = /WebZ/SCAN

You can use another namespace as long as you change it in the all of these variables and in the nameSpace variables in JaSSIServer.ini and WebSvrExt.ini.

ILLEmailCmd
ILLMEmailCmd
ILLISOILLCmd
(beginning with SiteSearch 4.1.2)

Class (verb or extended verb) to use to process interlibrary loan requests of the type indicated by the variable. The default values are:

Default values	ILL Server	ILL Service Type
ILLEmailCmd = ILLEmail	EmailILL	EMAIL
ILLMEmailCmd = ILLMIMEEmail	MimeEmailILL	MIME_EMAIL
ILLISOILLCmd = ISOILL	OclcISOILL	ISOILL

The default verbs pertain to the generic ILL servers shipped beginning with SiteSearch 4.1.2, and are part of the ORG.oclc.webz class package.

If you wish to route ILL requests to a different IPIG-compliant ILL service compatible with SiteSearch 4.1.2 or higher, modify its ILL command so that it refers to the verb designed to process requests to this ILL service. You can find the appropriate verbs in the ORG.oclc.obi.extverb class package. If you extend one of the ILL processing verbs provided, enter its name as the variable value and add its class package to the [PackageOrder] section of the JaSSIServer.ini configuration file.

maxtopicdbs
(beginning with SiteSearch 4.1.2)

Maximum number of databases allowed in a patron-created custom topic, as displayed on the topic definition screen (<WebZ_root>/htdocs/obiv1/html/definetopic.html in the OBI, version 1). You may find limiting the number of databases in a topic useful for optimizing performance. The default value is 10.

[DumpTool] Section

The [DumpTool] section specifies the gadget (ORG.oclc.gadgets.Dump) that displays all data contained in the UserStateObject for the current user. The UserStateObject maintains persistent user state data that for the user's session. This information is often useful for troubleshooting by SiteSearch staff.

[ExpandBoxHeader] Section

This section defines the gadget (ORG.oclc.gadgets.ExpandHeader) that creates a header for the expand screen (expand.html). This header includes the current database chosen and the related topics or databases in the topic area, depending on the current database.

[fonts] Section

The [fonts] section defines font styles used throughout the interface. This includes the default font face and specific font sizes and colors for text used in headings, labels, anchors, record display, and more. In the OBI, version 1, the font colors are style table references to the [colors] section of the interface style.

[FullRecordHeader] Section (beginning with version 4.1.0)

The [FullRecordHeader] section provides input parameters for the ORG.oclc.gadgets.FullRecordHeader class, which builds the header on the full record page (full.html or nffull.html in the OBI, version 1).

[FullTextHeader] Section (beginning with version 4.1.0)

The [FullRecordHeader] section provides input parameters for the ORG.oclc.gadgets.FullTextHeader class, which builds the header on the full text record page (fulltext.html or nffulltext.html in the OBI, version 1).

[htmlparms] Section (version 4.0.2 only)

The [htmlparms] section defines the size of the toolbar or top frame in the interface.

[ILLConfirm] Section

This section specifies the gadget (ORG.oclc.gadgets.IllConfirm) that displays information on the confirmation screen that appears after a patron submits an Interlibrary Loan (ILL) request.

[images] Section

The [images] section defines various images used throughout the interface. By default, the path for a given image is relative to the DocumentRoot variable defined in JaSSIServer.ini, as shown in the following portion of an [images] section. In the OBI, version 1, these images are often buttons that patrons click to issue commands, such as displaying the full text version of a record, save a record, or e-mail saved records.

[Images]
toolbar   = /images/toolbar.gif
webplaces = /images/grn_destinations.gif
go        = /images/btn_grn_go.gif

[ImgDisplay] (beginning with version 4.1.0)

The [ImgDisplay] section indicates the gadget used (ORG.oclc.gadgets.ImageDisplay) for building a thumbnail display for an image that represents an image database containing a series of images.

[ImgJumpBar] Section

The [ImgJumpBar] section defines the gadget to use (ORG.oclc.gadgets.ImageJumpbar) to create a jump bar for navigating image records.

[ImgNav] Section

The [ImgNav] section defines input parameters for the ORG.oclc.gadgets.ImageNav gadget class, which creates thumbnail images for navigating image records. The height and width variables specify the HTML height and weight values for scaling the images. The pagesize parameter specifies the number of images to display per page.

[JumpBar] Section

The [JumpBar] section defines input parameters for the ORG.oclc.gadgets.JumpBar gadget class, which creates a jump bar for navigating a set of records. The JumpBarLabel parameter allows you to specify the label for the jump bar.

[Limits] and [RefineLimits] Sections

These sections define input parameters for the ORG.oclc.gadgets.Limits gadget class, which creates HTML drop-down selection lists or radio buttons from which a patron can select search limits.

In the OBI, version 1, the patron can select search limits from the advanced search screen (advancedsearch.html) or refine search screen (refine.html or nfrefine.html). The indexlist parameter specifies which indexlist in the database configuration file to use to create the list, and is typically set to "limits".

[messages] Section

The [messages] section lists messages displayed to patrons on various HTML screens. The message variables often specify the font for the message with a reference to a variable in the [fonts] section.

[pages] Section

The [pages] section defines which HTML pages to use for various purposes within the interface. For example, the briefdisplay and fulldisplay variables specify which pages to use to display those particular record formats in the interface. The variables in the [pages] section are used by a number of WebZ classes responsible for building HTML responses. The path for each page is relative to the DocumentRoot variable defined in JaSSIServer.ini, as shown in these examples from pagesFrame.ini in the OBI, version 1:

[pages]

index        = index.html

homepage     = /html/homeframe.html
search       = /html/search.html
briefdisplay = /html/brief.html
badsearch    = /error/badsearch.html

To learn more about how a page variable is used by a particular class, see the API documentation and source code for the class itself. Refer to Determining How or Where an Interface Setting Is Used for information about locating the occurrence or usage of a variable.

[QuickSearchTopics] Section

The [QuickSearchTopics] section defines input parameters for the ORG.oclc.gadgets.QuickSearchTopics gadget class. The topicNames parameter is a comma-separated list of individual topics to display in the Quick Search Topics header in the interface. The topic names must match the names defined in the topic definition file (see ObiTopics.ini). If topicNames is not defined, then WebZ uses the topics Articles, Books, and Web by default. If these particular topics are not defined in the topic definition file, then no topics appear in the Quick Search Topic header. In the OBI, version 1, the Quick Search Topic header appears on the database list screen (dblist.html or nfdblist.html).

[RefineScreen] Section

The [RefineScreen] section specifies the gadget (ORG.oclc.gadgets.RefineScreen) that controls the display for refining searches. The search refine options appear when the user asks to refine a search or the user's search yields no results.

[SearchA], [SearchB], [SearchC], [ScanIndex], [RefineScan], and [RefineSearch] Sections

These sections define input parameters for the ORG.oclc.gadgets.IndexSelect gadget class, which creates a drop-down selection list of database indexes on the advanced search, browse, refine search, and refine browse screens. In the OBI, version 1, these are advancedsearch.html, scansearch.html, refine.html or nfrefine.html, and refinescan.html or nfrefinescan.html, respectively. The indexlist parameter specifies which indexlist in the database configuration file to use to create the list.

[SearchBoxHeader] Section

This section defines the gadget that provides the list of database and topic definitions on the search, advanced search, and browse screens (ORG.oclc.gadgets.SearchHeader). In the OBI, version 1, these are search.html, advancedsearch.html, and scansearch.html, respectively.

[Sort] and [SortRefine] Sections

These sections define input parameters for the ORG.oclc.gadgets.SortSelect gadget class, which creates an HTML drop-down selection list of sort keys for a database.

[TabBar] Section

The [TabBar] section defines input parameters for the ORG.oclc.gadgets.SearchTabbar gadget class. The indexlist parameter is typically set to "tabbar", which uses the value of the tabbar index list defined for the database. Each database included with the WebZ system has a definition for a tabbar indexlist in its database configuration file.

The browse and termfinder parameters indicate whether to add Browse (for browse searching) and Term Finder tabs (for vocabulary-assisted searching) to the tab bar on a database-by-database basis (=database), to never add these tabs to the tab bar (=false), or to always add these tabs (=true). It is generally best to set browse=database and termfinder=database unless all (or none) of your databases support these features.

[Targets] Section

The [Targets] section lists HTML targets that specify the appropriate frame for displaying HTML pages in frames-based interfaces.

[TermFinderSearchHeader], [TermListSearchHeader], and [ThesTreeSearchHeader] Sections (beginning with version 4.1.0)

These sections define input parameters for the ORG.oclc.gadgets.TermFinderHeader class. This gadget builds the header on the term finder search (termfindersearch.html), term list display (termlist.html), and thesaurus tree screens (thestree.html) for vocabulary-assisted searching in the OBI, version 1.

[ThesNavButtons] (beginning with version 4.1.0)

This section defines the class (ORG.oclc.gadgets.ThesNavButtons) that creates the navigational buttons and their related anchors on the thesaurus tree screen (thestree.html) in the OBI, version 1.

[Toolbar] (beginning with version 4.1.0)

This section defines input parameters for the class (ORG.oclc.gadgets.ToolbarAnchor) that builds a toolbar for a no-frames interface. The anchor* parameters identify variable names in the [anchors] section that define the anchors to add to the toolbar.

[TopicList] Section

The [TopicList] section defines input parameters for the ORG.oclc.gadgets.TopicList gadget class. The topicNames parameter is All by default, but you can substitute a comma-separated list of individual topics. The topic names must match the names defined in the topics definition file (refer to ObiTopics.ini). The anchorCommand parameter refers to the search page that the patron sees if he or clicks a link for a topic on the list.

[Main][Documentation][Support][Technical Reference][Community][Glossary][Search]

Last Modified: