Last updated 2003-12-01 11:33:47 EST
Doc Title Image Class Processing Instructions
Author 1 Weise, John
CVS Revision $Revision: 1.6 $
Image Class Processing Instructions

dlxs-help@umich.edu

The following table includes descriptions of all the processing instructions that appear in Image Class templates, as well as relevant template files in which they appear. Processing instructions are HTML tags that are processed by the middleware and replaced with HTML and or Javascript.

Note that "bookbag" and "portfolio" are equal. PIs and template names that include "bb" are associated with bookbag/portfolio functionality.

Please see DLXS HTML Templates / Interfaces for an overview.

PI tag Optional parameters Associated templates Description
<?TOTALRESULTS> none thumbnail.tpl
reslist.tpl
thumbfull.tpl
Inserts count of total number of hits in the result set.
<?STATS> type collinfo.tpl
Inserts count of total number of images or records in the collection. Type attribute can have values "images" or "records".
<?MEDIAEQUIVSTOOL> none any
Insert link to equivalent media options (e.g., the QuickTime equivalent of an Windows Media File). Requires proper configuration of imageprep script as well as proper metadata preparation.
<?RESULTSVIEW> type search.tpl
searchgroup.tpl
Inserts form element of "type" hidden or buttons that selects the results view.
<?INSERTTEXT> filename any
Inserts contents of file specified in the "filename" attribute. Uses fallback to determine collection, group, or class path.
<?FBFILE> file any
Inserts a link to the filename specified in the "file" attribute after using fallback mechanism to choose collection, group, or class path to the file.
<?COLLHOME> none info.tpl
search.tpl
Insert a link to the collection home page.
<?CGIROOT> none any
Insert the CGI root path. e.g., /cgi/i/image/image-idx
<?BROWSEALL> type index.tpl
search.tpl
When used with a type value of "brwsimg" or "brwsrec" inserts a "browse all..." link. There are also "brwsimg" and "brwsrec" Collmgr fields that can take a single term as a value. The value will be used to build the link, and will restrict the result set to records containing the term.
<?BANNER> none entry.tpl
groups.tpl
index.tpl
reslist.tpl
search.tpl
thumbfull.tpl
thumbnail.tpl
inserts the name of the collection or the cross collection banner (e.g., UM Image Source) in cross collection mode. banner text is configurable in the "banner" colldb field. Cross collection banner specified in imageclass.cfg. May be text or graphic.
<?ALLPUROSE> any all this PI does nothing by default, but may be programmed to do almost anything. The allpurpose routine is in $DLXSROOT/cgi/i/image/ICLocalUtils.pm.
<?BBACTIONFORM> action bbentry.tpl
bbreslist.tpl
bbthumbfull.tpl
bbthumbnail.tpl
entry.tpl
reslist.tpl
thumbfull.tpl
thumbnail.tpl

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

<?BBAGINFO> colname bbentry.tpl
bbreslist.tpl
bbslideentry.tpl
bbthumbfull.tpl
bbthumbnail.tpl

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.

<?BBAGNAMEFORM> none bbname.tpl
inserts form for creating/naming a new portfolio
<?BBAGPICKLIST> action
type
bbdel.tpl
bbname.tpl
bbopen.tpl

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".

<?COLLNAME> none bbentry.tpl
bbslideentry.tpl
entry.tpl
reslist.tpl
thumbfull.tpl
thumbnail.tpl
inserts the collection name as specified in "collname" field of colldb or "Multiple Collections" in cross collection mode.
<?COLLPICK> none index.tpl
search.tpl
inserts a list of collections for selection by the user
<?COLLPICKARRAYS> none search.tpl
inserts javascript arrays that are needed by collpicker. the arrays hold field lists per coll.
<?COLLPICKBUTTON> none search.tpl
inserts a button (but why?)
<?CSSURL> type bbentry.tpl
bbname.tpl
bbopen.tpl
bbreslist.tpl
bbslideentry.tpl
bbthumbfull.tpl
bbthumbnail.tpl
entry.tpl
groups.tpl
index.tpl
reslist.tpl
search.tpl
thumbfull.tpl
thumbnail.tpl

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

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

<?DELETEPORTFOLIO> none bbreslist.tpl
bbthumbfull.tpl
bbthumbnail.tpl
inserts button to initiate deletion of entire portfolio
<?DIVBUTTONS> none bbentry.tpl
entry.tpl
inserts the radio buttons used for switching between "full image", "description" and "other views" entry views
<?ENTRYID> none bbentry.tpl
bbslideentry.tpl
entry.tpl
inserts the entry (record) id.
<?FISHEYE> none reslist.tpl
thumbfull.tpl
thumbnail.tpl
inserts the "fisheye" tool into a results view. the fisheye tool allows quick jumping among the full range of results.
<?GROUPNAME> none index.tpl
search.tpl
inserts the name of the group being searched if in cross collection mode. groups are defined in the "groups" table.
<?GROUPSLINK> none index.tpl
search.tpl
inserts a link to the group selection page
<?GROUPSPICK> groups groups.tpl
inserts a list of groups for selecting a group to search. the optional "groups" parameter is for specifying a list of groups (as group ids separated by vertical bars/pipes) to include. without a value for the "groups" parameter, all groups are listed by default.
<?CONTACT> type entry.tpl
reslist.tpl
thumbfull.tpl
thumbnail.tpl

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.

<?HIDDENSID> none

searchgroup.tpl
search.tpl

inserts session id in search form
<?IMAGE> quality
override
bbentry.tpl
bbslideentry.tpl
entry.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.

<?IMAGEPANTOOL> quality
override
bbentry.tpl
entry.tpl

inserts the interface tool for panning a MrSID image.

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

<?IMAGESIZETOOL> quality bbentry.tpl
entry.tpl

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

See <?IMAGE> for description of quality values.

<?IMAGEWITHFORM> quality
override
bbentry.tpl
entry.tpl

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.

<?IMAGEZOOMTOOL>

quality
override

bbentry.tpl
entry.tpl

inserts the interface tool for zooming.

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

<?INFOTEXT> none index.tpl
collinfo.tpl
inserts the info.txt file if the file is found in the collections web directory. this allows a collection specific description to be included for each collection without necessarily creating a collection specific index.tpl and collinfo.tpl template. the info.txt file may include HTML tags, but it should not be a complete HTML document.
<?JAVASCRIPTURL> none bbentry.tpl
bbreslist.tpl
bbslideentry.tpl
bbthumbfull.tpl
bbthumbnail.tpl
entry.tpl
groups.tpl
index.tpl
reslist.tpl
search.tpl
thumbfull.tpl
thumbnail.tpl
inserts link that loads Image Class JavaScript.
<?LOGINLINK> type
on
bbentry.tpl
bbreslist.tpl
bbslideentry.tpl
bbthumbfull.tpl
bbthumbnail.tpl
entry.tpl
groups.tpl
index.tpl
reslist.tpl
search.tpl
thumbfull.tpl
thumbnail.tpl

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.

<?MEDIAONLYBUTTON> none search.tpl
searchgroup.tpl
inserts media restriction in search form (i.e., search for images only)
<?NEXT> none reslist.tpl
thumbfull.tpl
thumbnail.tpl
inserts link to next page of results.
<?NEXTENTRY> view bbentry.tpl
bbslideentry.tpl
entry.tpl
inserts link to next result in entry/record view. the "view" attribute can be used to indicate the view/layer within the entry template that the link will originate from. this allows the present view to be maintained in the next. Typical values of the "view" attribute are description, full-image, and other-views.
<?NORESULTSMESSAGE> none noresults.tpl
inserts message to user about the fact they got zero results.
<?OPENPORTFOLIO> none bbentry.tpl
bbreslist.tpl
bbslideentry.tpl
bbthumbfull.tpl
bbthumbnail.tpl
entry.tpl
groups.tpl
index.tpl
reslist.tpl
search.tpl
thumbfull.tpl
thumbnail.tpl
inserts button and link for opening a portfolio
<?PATH>
No longer valid as of DLXS release 11a. Discontinue use in all templates. use FBFILE PI instead.
type bbdel.tpl
bbentry.tpl
bbname.tpl
bbopen.tpl
bbslideentry.tpl
entry.tpl
groups.tpl
search.tpl
tips.tpl
inserts a path of a certain type, most commonly "web", which creates a relative URL path to the current web directory.
<?PREV> none bbentry.tpl
bbslideentry.tpl
entry.tpl
reslist.tpl
thumbfull.tpl
thumbnail.tpl
inserts link to previous page of results.
<?PREVENTRY> view bbentry.tpl
bbslideentry.tpl
entry.tpl
inserts link to previous result in entry/record. the "view" attribute can be used to indicate the view/layer within the entry template that the link will originate from. this allows the present view to be maintained in the previous. Typical values of the "view" attribute are description, full-image, and other-views. view.
<?RECORDTABLE>

fields
table
thumb

bbentry.tpl
bbslideentry.tpl
entry.tpl

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:

option values default description
label on/off on display name of field before field value
sectionlabel text string*
empty display a section label before a series of fields. allows a record to split into sections.
url on/off off turn the entire contents of the field in to a link. assumes the field contains a single URL.
urltext text string* empty display the provided string as the text of the "url" option link. if "urltext" is not specified, the URL value is used as the text of the link.
idres on/off off look the value of the field up in the id resolver and display the value. use with "url" and/or "urltext" to turn the value in to a link.
dateconv on/off off

displays some ISO format dates in a more human readable form.

supports YYYYMMDD, YYYYMMDD/YYYYMMDD and maintains any data that might follow the date in the field e.g, (ca.)

hilite on/off on

hilites search terms in the field.

DLXS hiliting supports 3 search fields only (q1 - q3).

keylinks on/off off

turns the field value into a url that will search the collection for that value. by default, each word of the field is made into a separate link. the delimiter used to split the field can be specified by the "delim" option.

delim 1 or more characters SPACE

used in conjunction with the keylinks option to split the value of a field into smaller parts by the value delim specifies. for example, if a field holds a list of keywords delimited by "; " delim can be set to ";_" to tell the keylinks option how to split the field. (note: use an underscore for SPACE.) e.g., delim:;_

* 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.

<?RELATEDVIEWS> none bbentry.tpl
entry.tpl
inserts table of related views for a record (all of the images associated with a single record). See also documentation on "Image Structures".
<?RELATEDVIEWSMENU> none bbentry.tpl
entry.tpl

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.

<?RESULTSTABLE> x bbreslist.tpl
bbthumbfull.tpl
bbthumbnail.tpl
reslist.tpl
thumbfull.tpl
thumbnail.tpl

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".

<?SEARCHFORM> none search.tpl
searchgroup.tpl
inserts a search form.
<?SEARCHLINK> none

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

inserts link to search form page
<?SLICESUMMARY> none reslist.tpl
thumbfull.tpl
thumbnail.tpl
inserts a summary of search results.
<?SORTMENU> none bbreslist.tpl
bbthumbfull.tpl
bbthumbnail.tpl
reslist.tpl
thumbfull.tpl
thumbnail.tpl
inserts sort menu
<?SWITCHENTRYVIEW> view bbentry.tpl
bbslideentry.tpl

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

bbentry

bbslideentry

<?THUMBFULLDIVS> none bbthumbfull.tpl
thumbfull.tpl
inserts the set of HTML DIVs, one for every record included in the page of results, that is used for displaying full records on the results page (thumb with full record view).
<?THUMBFULLJSARRAYS> none bbthumbfull.tpl
thumbfull.tpl
inserts JavaScript arrays used for dynamically displaying a full record on the results page when requested.
<?THUMBFULLSTYLE> gen bbthumbfull.tpl
thumbfull.tpl
inserts style definitions for positioning of the full record divs. Gen attribute can be used to specify use of "next" generation display, which is simply thumbs with no text below them.
<?THUMBNAIL> none entry.tpl
bbentry.tpl
slideentry.tpl
inserts a thumbnail image. (does this really work???)
<?VIEWINSTRUCT> none bbreslist.tpl
bbthumbfull.tpl
bbthumbnail.tpl
reslist.tpl
thumbfull.tpl
thumbnail.tpl
inserts instructions for the user, depending on the situation.
<?VIEWTABS> form bbreslist.tpl
bbthumbfull.tpl
bbthumbnail.tpl
reslist.tpl
thumbfull.tpl
thumbnail.tpl
inserts the view tabs that are used for switching among the results views. by default, the viewtabs are graphical. Optionally the "form" PI parameter can be used to specify that the viewtabs be displayed as "text". This simply provides a quick and dirty way to change the background color of the header row without creating a new graphic that is dithered to the new background color.

graphic (default)

text
<?VISIBILITY> div bbentry.tpl
bbslideentry.tpl
entry.tpl

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

<?ZOOMTHUMB> none entry.tpl
this is not ready for primetime, but it is a feature for displaying a thumbnail that has a red box drawn on it indicating the portion of the full image that is currently being viewed. It is a navigational tool.
<?RESTRICTSTATUS> none index.tp
collinfo.tpl
inserts authority of the user relative to the collection