image class colldb

Image Class Collection Database (colldb) Column Definitions

colldb column name

type

repeatable

example

description

related global variable in imageclass.cfg

collid

string

no

bhl

the collection id

n/a

collname

string

no

Bentley Historical Library University of Michigan

long form of the collection name. used in the search form's list of collections.

n/a

host

domain name

no

fizzie.umdl.umich.edu

domain name of server hosting xpat index

n/a

webdir

c/coll

no

b/bhl

collection specific portion of the web path where collection specific templates, etc. may be stored.

see %gPathHash and %gUrlHash

briefcollname

string

no

UM Bentley

short form of the collection name. used in the thumbnail results view for cross collection searches under each thumbnail.

n/a

banner

text:string
or
image:url

no

text:Bentley Historical Library

text or image file url to display in the header of collection specific searches.

$gBanner

dfltresflds

category abbreviations

yes

bhl.fn|bhl.it|bhl.ca

category (field) abbreviations for the categories to be displayed with each search result.

n/a

resfldtrim

integer

no

50

maximum length for each of the defltresflds. longer values will be trimmed to the specified length and appended with elipsis.

n/a

dfltentryflds

category abbreviations
or
"default"

yes

bhl.it|bhl.da|bhl.tis|bhl.cr|bhl.ca|bhl.no|bhl.su|bhl.g|bhl.ct|bhl.cc|bhl.lo|bhl.fn|bhl.ne

category (field) abbreviations for the categories to be displayed in the entry (full record) view. set to "default" to display all categories.

n/a

dfltresentryflds

category abbreviations
or
"default"

yes

bhl.it|bhl.da|bhl.tis|bhl.cr|bhl.ca|bhl.no

category (field) abbreviations for the categories to be displayed in the thumbfull (thumbnail results with full records) view. set to "default" to display all categories.

n/a

dfltsrchflds

category abbreviations

yes

bhl.it|bhl.da|bhl.tis|bhl.cr|bhl.ca|bhl.no|bhl.su|bhl.g|bhl.ct|bhl.cc|bhl.lo|bhl.fn|bhl.ne

category (field) abbreviations for the categories to be displayed in the search form when only one collection is being searched.

n/a

numqs

integer

no

3

number of text entry boxes to display in a collection specific search form.

$gXCnumqs

resultsviews

string

yes

thumbnail|thumbfull|reslist

list of view options used to build the view menu in the search form. display text for each is set in the imageclass.cfg global variable $gViewLabels.

%gResultsViews

resultsviewsdefault

string

no

thumbnail

default selected view of the view menu in the search form.

%gResultsViews

relviewmenu

"on"
or
"off"

no

off

related views typically have their own display in an entry view, however a menu of related views may also be displayed. typically used for "page flipping". a value of "on" turns this feature on for the collection.

n/a

relviewmenuinstruct

string
or
"default"

no

go to

optional string of instructional text to prefix the related views menu with.

n/a

relviewmenuprefx

string
or
"default"

no

page

optional string to prefix each option value of the related views menu with.

n/a

relviewmenuvals

"viewid", "isentryid", "stid", "face", "stty", "x", "y", "mt", "ms", "m"
or
default

no

viewid

the ISTRUCT element attribute value to use for option values in the related views menu. value "default" uses ISTRUCT attribute "CAPTIONS". "viewid" and "captions" are the most logical values here. Look at the Image Class DTD or some Image Class SGML to see ISTRUCT attributes values.

n/a

mediaonly

"on", "off", "on hidden", "off hidden"

no

"on"

determines whether the search form has a visible or hidden form element for restricting the search to records with image files. "on" displays the form element and it is checked by default. "off hidden" includes the form element as a hidden input with a value of "0". Can you figure out how the other two values behave?

$gMediaOnlyDefault

entrydivs

string

yes

full image|description|other views

the view options to present to the user in the entry view display. Further configurable in the template by adding or removing divs.

n/a

entrydivsdefault

string

no

full image

the view option of the entry view display selected by default.

n/a

dddir

/c/coll

no

/b/bhl

subdirectory of XPAT index. the middleware prepends this with /DLXSROOT/idx.

n/a

dd

filename

no

image.dd

the name of the XPAT dd file.

n/a

map

default
or
path

no

default

the full path to the map file. the map file is used by middleware in the process of building XPAT queries. with Image Class it is unlikely that a different map will be needed, so stick to "default."

n/a

xpatexec

path

no

/l/local/xpat/bin/xpat

the path to the XPAT binary.

n/a

port

port number

no

619

the port

n/a

colldb column name	type	repeatable	example	description	related global variable in imageclass.cfg
collid	string	no	bhl	the collection id	n/a
collname	string	no	Bentley Historical Library University of Michigan	long form of the collection name. used in the search form's list of collections.	n/a
host	domain name	no	fizzie.umdl.umich.edu	domain name of server hosting xpat index	n/a
webdir	c/coll	no	b/bhl	collection specific portion of the web path where collection specific templates, etc. may be stored.	see %gPathHash and %gUrlHash
briefcollname	string	no	UM Bentley	short form of the collection name. used in the thumbnail results view for cross collection searches under each thumbnail.	n/a
banner	text:string or image:url	no	text:Bentley Historical Library	text or image file url to display in the header of collection specific searches.	$gBanner
dfltresflds	category abbreviations	yes	bhl.fn\|bhl.it\|bhl.ca	category (field) abbreviations for the categories to be displayed with each search result.	n/a
resfldtrim	integer	no	50	maximum length for each of the defltresflds. longer values will be trimmed to the specified length and appended with elipsis.	n/a
dfltentryflds	category abbreviations or "default"	yes	bhl.it\|bhl.da\|bhl.tis\|bhl.cr\|bhl.ca\|bhl.no\|bhl.su\|bhl.g\|bhl.ct\|bhl.cc\|bhl.lo\|bhl.fn\|bhl.ne	category (field) abbreviations for the categories to be displayed in the entry (full record) view. set to "default" to display all categories.	n/a
dfltresentryflds	category abbreviations or "default"	yes	bhl.it\|bhl.da\|bhl.tis\|bhl.cr\|bhl.ca\|bhl.no	category (field) abbreviations for the categories to be displayed in the thumbfull (thumbnail results with full records) view. set to "default" to display all categories.	n/a
dfltsrchflds	category abbreviations	yes	bhl.it\|bhl.da\|bhl.tis\|bhl.cr\|bhl.ca\|bhl.no\|bhl.su\|bhl.g\|bhl.ct\|bhl.cc\|bhl.lo\|bhl.fn\|bhl.ne	category (field) abbreviations for the categories to be displayed in the search form when only one collection is being searched.	n/a
numqs	integer	no	3	number of text entry boxes to display in a collection specific search form.	$gXCnumqs
resultsviews	string	yes	thumbnail\|thumbfull\|reslist	list of view options used to build the view menu in the search form. display text for each is set in the imageclass.cfg global variable $gViewLabels.	%gResultsViews
resultsviewsdefault	string	no	thumbnail	default selected view of the view menu in the search form.	%gResultsViews
relviewmenu	"on" or "off"	no	off	related views typically have their own display in an entry view, however a menu of related views may also be displayed. typically used for "page flipping". a value of "on" turns this feature on for the collection.	n/a
relviewmenuinstruct	string or "default"	no	go to	optional string of instructional text to prefix the related views menu with.	n/a
relviewmenuprefx	string or "default"	no	page	optional string to prefix each option value of the related views menu with.	n/a
relviewmenuvals	"viewid", "isentryid", "stid", "face", "stty", "x", "y", "mt", "ms", "m" or default	no	viewid	the ISTRUCT element attribute value to use for option values in the related views menu. value "default" uses ISTRUCT attribute "CAPTIONS". "viewid" and "captions" are the most logical values here. Look at the Image Class DTD or some Image Class SGML to see ISTRUCT attributes values.	n/a
mediaonly	"on", "off", "on hidden", "off hidden"	no	"on"	determines whether the search form has a visible or hidden form element for restricting the search to records with image files. "on" displays the form element and it is checked by default. "off hidden" includes the form element as a hidden input with a value of "0". Can you figure out how the other two values behave?	$gMediaOnlyDefault
entrydivs	string	yes	full image\|description\|other views	the view options to present to the user in the entry view display. Further configurable in the template by adding or removing divs.	n/a
entrydivsdefault	string	no	full image	the view option of the entry view display selected by default.	n/a
dddir	/c/coll	no	/b/bhl	subdirectory of XPAT index. the middleware prepends this with /DLXSROOT/idx.	n/a
dd	filename	no	image.dd	the name of the XPAT dd file.	n/a
map	default or path	no	default	the full path to the map file. the map file is used by middleware in the process of building XPAT queries. with Image Class it is unlikely that a different map will be needed, so stick to "default."	n/a
xpatexec	path	no	/l/local/xpat/bin/xpat	the path to the XPAT binary.	n/a
port	port number	no	619	the port	n/a