ImageClass Templates & Processing Instructions

inserts form for activating the various portfolio actions, such as adding an item to a portfolio.

action param may be set to: add or remove

inserts information about the portfolio, such as the title of the portfolio. any field of the bookbagdb can be displayed(?).

Most often, colname="bbagname", which displays the name of the portfolio.

insert list of existing portfolios for opening a portfolio or adding to a portfolio.

action can be "open" or "add"

type can be "public" or "private". type is only specifice when action is "open".

inserts the necessary CSS (cascading style sheet) link depending on the situation.

type can be "ie" or "ns" (Internet Explorer or Netscape)

type="link" inserts value from colldb "contactlink" field

type="text" inserts value from colldb "contacttext" field

if multiple collection mode, default contact info from imageclass.cfg is used.

searchgroup.tpl
search.tpl

inserts an image without a form. this means that the image is not interactive (you can't click on it to zoom). it is just an image.

quality = the default size for image display. there are several ways to specify the quality.

examples:

• h600 -- height no larger than 600 pixels
• w600 -- width no larger than 600 pixels
• m800 -- max dimension of image no larger than 800 pixels
• min -- smallest available
• max -- largest available
• mid -- mid-size among available
• preview -- defined in imageclass.cfg ($gDefaultPreviewImageSize)
• screen -- defined in imageclass.cfg ($gDefaultScreenImageSize)
• integer value -- MrSID res value

Image Class version 1 quality terms are approximately converted to the above quality terms.

override should be set to "on" to allow the template to be overriden by the value of the quality cgi parameter, if present. See existing templates for examples.

inserts the interface tool for panning a MrSID image.

See <?IMAGE> for description of quality and override values.

inserts the interface tool for choosing from the range of full-size images that are available.

See <?IMAGE> for description of quality values.

inserts an image with a form. this means that the image is interactive and can be clicked on for zooming.

See <?IMAGE> for description of quality and override values.

quality
override

inserts the interface tool for zooming.

See <?IMAGE> for description of quality and override values.

inserts login button. if login is turned off in imageclass.cfg, button is not displayed.

type can be set to "bbag", in which case a message precedes the button encouraging the user to login to use bbag functions.

on can be set to "white", which causes the login button designed to sit on a white background to be loaded (login-white.gif). usually, login-black.gif is loaded. on can be set to any color, and the file login-color.gif will be loaded, however only login-white.gif and login-black.gif are provided.

fields
table
thumb

Displays a record in entry (full record) views. Fields and field order are specified in the colldb field "dfltentryflds," or may be overridden by a fields parameter. Whether specified in colldb or by fields parameter, the rules about how to specify the fields to display are as follows.

Fields must be listed as abbreviations in the order desired and delimited by pipes ( "|" ). e.g., MUSART.TI|MUSART.CR|musart.DA

Values are not case sensitive.

There are several options that may be turned on and off to enhance the display of records. The options are specified inline with the field abbreviations. When the status of an option is changed, the change is persistent for all subsequent fields, until the status is changed again. The exceptions to this are the "sectionlabel" and "urltext", which are specified as often as needed.

The "url" option, for example, causes fields that contain a URL (and nothing but a URL), to be turned into a hyperlink. It can be used in conjunction with the "urltext" option, which makes allows the link text to be specified. Normally the URL itself is used for the link text. e.g.,
MUSART.TI|url:on|urltext:View_Copyright_Statement|MUSART.cp|url:off|MUSART.DA

The "hilite" option causes search terms to be hilited. This option is "on" by default, but if you wanted to turn hiliting off for several consecutive fields, you could. e.g., MUSART.TI|hilite:off|MUSART.DA|MUSART.PG|MUSART.LI|hilite:on|MUSART.TY

The complete list of field options are as follows:

* use underscores for spaces. special characters may not work.

table parameter may be set to "on" or "off" to specify whether record is wrapped in a table, or simple text with line breaks. Default is"on".

thumb parameter may be set to "on" or "off" to specify whether a thumbnail image should be included with the record. Default is "on".

Cross collection fields are configured in imageclass.cfg.

inserts a menu for entry type templates that is a menu of all related views (aka "other views"). If a record has more than one image associated with it, then it has related views. the related views menu is intended for use with colls that need a "pageflipping" function.
e.g., "Students on Site", "Harpers Weekly".

uses the colldb for configuration.
colldb fields used:
relviewmenu -- on/off switch for the menu
relviewmenuvals -- specifies which istruct attribute value to use for menu *display*
options. default is "CAPTIONS"
relviewmenuinstruct -- instruction text, if any to put in front of form
relviewmenuprefx -- prefix string to put in front of each and every displayed menu
option

if a particular record has only one view/image, a related views menu is not built/displayed, even if the option is turned on.

Inserts a table of results. Layout varies automatically depending on the view.

x parameter is for specifying the number of columns in a table of thumbnail results. The default is 5.

the fields displayed for each results are configurable in the colldb field called "dfltresflds".

term hiliting happens by default, and without an option to turn it off.

optionally, field values may be trimmed to a specific character length to conserve space in thumbnail views. configure this option in the colldb field called "resfldtrim".

reslist.tpl
thumbfull.tpl
thumbnail.tpl
index.tpl
noresults.tpl

inserts a URL link for switching between portfolio entry view and portfolio slideshow view. Likely values are...

bbentry

bbslideentry

inserts styles that control the visibility of DIVs in the entry/record display. the default divs are listed below, but there are ways to add or change DIVs if that is of interest. Contact dlxs-info@umich.edu for guidance.

full-image

description

other-views