Main -> Documentation -> WebZ System Administration -> WebZ Configuration Files -> Interface Display Configuration Files -> Example

Interface Display Configuration File Example

 
This document provides an example of an interface display configuration file. The example shown is frameDisplayGadgets.ini from the WebZ Out-of-the-Box Interface (OBI), version 1.


Example

Note: 

The continuation characters (\) used in this example are included for readability and do not appear in the actual file.

# frameDisplayGadgets.ini

# Record display formatting
#
[ResultsRecord]
gadget = ORG.oclc.gadgets.FormatRecordsWithDuplicates
fmt = brief
dataWrapper = briefhtml
startRecno = toprecno
duplicatesFmt = briefduplicates
 
[MultiFullResultsRecord]
gadget = ORG.oclc.gadgets.FormatRecordsWithDuplicates
fmt = multifull
dataWrapper = multifullhtml
startRecno = toprecno
duplicatesFmt = duplicates
 
# Record display formatting for Full Display records
#
[FullRecord]
gadget = ORG.oclc.gadgets.FormatRecordsWithDuplicates
startRecno = fullrecno
fmt = full
duplicatesFmt = duplicates
SearchKeyFmtClass = holdingsKey
dataWrapper = FullHtml
 
# Builds the full text button for the full record
# display when the record has full text available
# based on the content in the record.
#
[FullTextLink]
gadget = ORG.oclc.gadgets.FormatRecords
fmt = linkToFullText
startRecno = fullrecno
errormsg = none
 
# Record display formatting for Full Display records
#
[FullTextRecord]
gadget = ORG.oclc.gadgets.FormatRecords
fmt = fulltext
startRecno = fullrecno
dataWrapper = FullTextHtml
noRecordsMessage = &StyleTable.fonts.defaultRecordText;There are no Full Text \
Records Available for this record. Please return to the citation record \
display screen.</font>
 
# Debug format to dump the record
# [DumpRecord]
gadget = ORG.oclc.gadgets.FormatRecords fmtclass = dump
 
# Debug format to dump the record #
[TempDumpRecord]
gadget = ORG.oclc.gadgets.FormatRecords
fmtclass = dump
tempdb = true
 
# Builds the local Library Holdings button for the
# full record display when the database
# has the localholdingslink format specified
#
[LocalHoldingsLink]
gadget = ORG.oclc.gadgets.FormatRecords
fmt = linkToLibHoldings
errormsg = none
 
#Display some brief bib information about the record
#before displaying the local holdings for it
#
[HoldingsRecordHeader]
gadget = ORG.oclc.gadgets.FormatRecords
fmt = libHoldingsHdr
dataWrapper = libHoldingsHtml
 
# Display the local holdings data
#
[HoldingsRecord]
gadget = ORG.oclc.gadgets.FormatRecords
fmt = localholdings
tempDb = true
dataWrapper = libHoldingsHtml
noRecordsMessage = &StyleTable.fonts.smallRecordText;There are no library \
holdings found for this item.</font>
 
# The Display bookmarks
#
[BookMarkBrief]
gadget = ORG.oclc.gadgets.BookMarkBrief
fmt = bookmark
fulltextfmt = bookmarkFT
dataWrapper = BookMarkBriefHtml
 
# The Full Display bookmarks
# also used by the BookMark Email class
# to format records for E-mail
#
[BookMarkFull]
gadget = ORG.oclc.gadgets.BookMarkFull
addUnsave = true
fmt = bookmarkfull
fulltextfmt = bookmarkfullFT
dataWrapper = BookMarkText
duplicatesFmt = bookmarkDups
 
# Email bookmarks
#
[BookMarkEmail]
gadget = ORG.oclc.gadgets.BookMarkEmail
fmt = bookmark
fulltextfmt = bookmarkFT
duplicatesFmt = bookmarkDups
dataWrapper = BookmarkBriefHtml
server = yourhost.edu
from = sitesearch@yourhost.edu
subject = SiteSearch Saved Records

# ILL request form
#
[ISOILLRecordFmt]
gadget = ORG.oclc.gadgets.IllForm
fmt = isoill
dataWrapper = isoillHtml
 
# Scan Results
#
[ScanResults]
gadget = ORG.oclc.gadgets.ScanResults
 
# TermList Search Results
#
[TermListDisplay]
gadget = ORG.oclc.gadgets.TermListDisplay
fmt = termlist
dataWrapper = termlistHtml
tempdb = true
 
# Thesaurus Results
#
[ThesTreeDisplay]
gadget = ORG.oclc.gadgets.ThesTreeDisplay
fmt = thestree
dataWrapper = thesaurusHtml
tempdb = true
 
# HTML for the brief record display
#
[BriefHtml]
beforeBookMarkAnchor= <tr><td valign="top" align="left">
afterBookMarkAnchor= </td>\n
beforeFETCHAnchor = &StyleTable.fonts.defaultRecordText;
afterFETCHAnchor = </font><br>\n
beforeRecordNumber = <td valign="top" align="left"> \
&StyleTable.fonts.smallRecordText;
afterRecordNumber = .</td>
beforeFieldLabel = \n&StyleTable.fonts.smallRecordText;<b>
afterFieldLabel = : </b>
fieldTrailer = </font><br>\n
lineBreak = ;&nbsp;
beforeRecordData = <td valign="top" align="left">
afterRecordDate = </td></tr>
hldStartLbl = &StyleTable.fonts.smallRecordtext;<b>
hldEndLbl = : </b>
hldSep = <br>\n
hldFldSep = " -- </font>"
afterImageBookmark = ""
beforeImageDisplayAnchor = <br>
afterImageDisplayAnchor = </td>\n
ThesaurusBriefBeforeLabel = \n&StyleTable.fonts.smallRecordText;
ThesaurusBriefAfterLabel = : </i>
ThesaurusBriefFieldTrailer = ""
 
# HTML for the display of full records
#
[FullHtml]
beforeBookMarkAnchor = <tr><td valign="top">
afterBookMarkAnchor = </td>\n
beforeRecordData = <td valign="top" align="left"><table width="100%">
afterRecordData = </table></td></tr>\n
beforeFieldLabel = <tr><td valign="top" align="right"> \
&StyleTable.fonts.defaultRecordtext;<b>
afterFieldLabel = </b></font></td><td valign="top" width="80%" align="left"> \
&StyleTable.fonts.defaultRecordText;
fieldTrailer = </td></tr>\n
lineBreak = \n<br>
 
beforeDuplicatesHoldingsLabel = \n
afterDuplicatesHoldingsLabel = ""
duplicatesFieldTrailer = ""
 
hldSep = <br><hr></td></tr><tr><td>&nbsp;</td><td valign="top" align="left"> \
&StyleTable.fonts.defaultRecordText;
 
hldStartLbl = <b>
hldEndLbl = : </b>
hldFldSep = <br>\n
hldStatusLblStart = <b>
hldStatusLblEnd= : <\b><dl><dd>\n
hldStatusEnd = </dd></dl>\n
afterImageBookmark = ""
beforeImageDisplayAnchor = <br>
afterImageDisplayAnchor = </td>\n
 
# HTML for the Displays of local library holdings in a table # when the link to the local holdings is done from another # database.
#
[LibHoldingsHtml] beforeFieldLabel = <tr><td valign="top" "align="right"> \
&StyleTable.fonts.smallRecordtext;<b>
afterFieldLabel = </b></font></td><td valign="top" align="left"> \
&StyleTable.fonts.smallRecordText;
fieldTrailer = </td></tr>\n
lineBreak = ;&nbsp:
beforeHoldingsLabel = ""
afterHoldingsLabel = <tr>\n
hldStartLbl = <td><font &StyleTable.fonts.face; size="-3">
hldEndLbl = "" hldSep = </td></tr>\n<tr>
hldFldSep = </font></td>\n
hldTrailer = </td>\n</tr>\n
 
#HTML for the display of more than 1 full record on a page
#
[MultiFullHtml]
beforeBookMarkAnchor = <tr><td valign="top"><table valign="top"> \
<tr><td valign="top">
afterBookMarkAnchor = <\td>\n
beforeRecordNumber = <td valign="top" align="left"> \
&StyleTable.fonts.smallRecordText;
afterRecordNumber = .</td></tr></table></td>
beforeRecordData = <td valign="top" align="left"> \
<table valign="top" width="100%">
afterRecordData = </table></td></tr>\n
beforeFieldLabel = <tr><td valign="top" align="right"> \
&StyleTable.fonts.defaultRecordtext;<b>
afterFieldLabel = </b></font></td><td valign="top" align="left" width="80%"> \
&StyleTable.fonts.defaultRecordText;
fieldTrailer = </td></tr>\n
lineBreak = \n<br>
 
beforeDuplicatesHoldingsLabel = \n
afterDuplicatesHoldingsLabel = ""
duplicatesFieldTrailer = ""
 
hldSep = <br><hr></td></tr></tr><tr><td>&nbsp;</td><td valign="top" align="left"> \
&StyleTable.fonts.defaultRecordText;
hldStartLbl = <b>
hldEndLbl = : </b>
hldFldSep = <br>\n
hldStatusLblStart = <b>
hldStatusLblEnd = : </b><dl><dd>\n
hldStatusEnd = </dd></dl>\n
afterImageBookmark = ""
beforeImageDisplayAnchor = <br>
afterImageDisplayAnchor = </td>\n
 
# HTML for the display of full text records
#
[FullTextHtml]
fieldTrailer = <p>\n
titleLabel = <h1>&StyleTable.fonts.smallRecordText;
titleTrailer = </font></h1><p>
beforeFTData = &StyleTable.fonts.smallRecordText;
afterFTData = </font>
beforeRecordData = <tr><td>
afterRecordData = </td></tr>\n
lineBreak = <p>\n
 
# HTML for the full display of bookmarked records
#
[BookMarkText]
beforeFieldLabel = " "
afterFieldLabel = ": "
lineLength = 70
indent = " "
fieldTrailer = \n
lineBreak = "\n "
recordSeparator = \n
beforeFTData = " "
beforeHoldingsLabel = " ---------- "
afterHoldingsLabel = " ----------\n"
beforeDuplicatesHoldingsLabel = ""
afterDuplicatesHoldingsLabel = ""
hldSep = " --------------------\n"
hldStartLbl = " "
hldEndLbl = ": "
hldFldSep = \n
hldStatusLblStart= " "
hldStatusLblEnd = ":\n "
hldStatusFldSep = "\n "
hldStatusEnd = \n
 
#HTML for Displays of the 'short' bookmark
#
[BookMarkBriefHtml]
beforeFieldLabel = \n&StyleTable.fonts.smallRecordText;<b>
afterFieldLabel = : </b>
fieldTrailer = </font><BR>\n
lineBreak = "; "
 
# HTML for display of the isoill form page
#
[isoillHtml]
beforeFieldLabel = <tr><th valign="top" align="left"> \ &StyleTable.fonts.smallRecordText;<i>
afterFieldLabel = </i></font></th>\n<td valign="top" align="left"> \
&StyleTable.fonts.smallRecordText;
fieldTrailer = </td></tr>\n
 
# HTML for display of the Term List
#
[termListHtml]
sectionheader = <tr><td colspan="3" valign="middle" align="left">\n
sectiontrailer = </td></tr>\n
 
rowstart = <tr>\n<td valign="middle" align="left"> \
&StyleTable.fonts.smallRecordText;
betweenrows = </font></td>\n</tr>\n<tr>\n<td colspan="2" align="left"> \
&nbsp;</td>\n<td>
betweencolumns = </td>\n<td align="left">&StyleTable.fonts.defaultRecordText;
rowend = </td>\n</tr>\n
lineBreak = \n<br>
ThesaurusUsedForBeforeLabel = <table>\n<tr>\n<td valign="top"> \
\n&StyleTable.fonts.smallRecordText;<i>
ThesaurusUsedForAfterLabel = </i></td>\n<td>&StyleTable.fonts.smallRecordText;
ThesaurusUsedForSeparator = ;&nbsp;
ThesaurusUsedForTrailer = </font></td>\n</tr>\n</table>\n
 
# HTML for display of the Thesaurus Tree
#
[thesaurusHtml]
ThesaurusUsedForBeforeLabel = <tr><td>&nbsp;</td>\n<td valign="top"> \
\n&StyleTable.fonts.smallRecordText;<i>
ThesaurusUsedForAfterLabel = : </i>&StyleTable.fonts.smallRecordText;
ThesaurusUsedForSeparator = ;&nbsp;
ThesaurusUsedForTrailer = </font></td>\n</tr>

See Also

About Interface Display Configuration Files
Interface Display Configuration Files - Section and Variables
Display Formatting Configuration Files
Rules-Based Formatting Process Overview



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

Last Modified: