collid |
required value/format:string class: all The unique ID string used for the collection. Usually corresponds to the directory name holding the collection files.
|
collname |
required value/format:string class: all The collection name as it will appear on the cross-collection results lists, in the collection picker (sorted alphabetically), and on the home page for the collection.
|
contactlink |
optional value/format:string class: all For constructing the contact mailto link; contains the content of the HREF attribute of the A element (e.g., "mailto:hti-info@umich.edu/")
|
contacttext |
optional value/format:string class: all For constructing the contact mailto link; contains the content of the A element that will appear as the link text (e.g. "hti-info@umich.edu/").
|
orglink |
optional value/format:string class: all For constructing the organization mailto link; contains the content of the HREF attribute of the A element (e.g., "mailtoorginfo@umich.edu/")
|
orgtext |
optional value/format:string class: all For constructing the organization mailto link; contains the content of the A element that will appear as the link text (e.g. "org-info@umich.edu/").
|
homesite |
required value/format:string class: text, bib The URL for the host webserver hosting the middleware for this collection. (e.g. "http//www.hti.umich.edu"). The value "localhost" can be supplied which will resolve to whatever machine the middleware happens to be running on.
|
host |
required value/format:string class: all The virtual host name for the machine hosting the collection data and data indexes. This is usually the same host hosting the middleware. To make the middleware access data on the same machine the middleware itself is running on, the value should agree with the value of the HTTP_HOST environment variable set by a webserver running on that machine. (e.g., "www.hti.umich.edu"). The value "localhost" can also be be supplied which will resolve to whatever machine the middleware happens to be running on. If the value is not "localhost" and is different from the value of the HTTP_HOST environment variable, the middleware will attempt to set up a socket connection to the machine named here to send commands to an XPAT process running on that remote machine. This requires that the XPAT daemon be properly configured on that remote machine. |
dd |
required value/format: array class: all bib, image: A list of one or more XPAT .dd files for the collection. Their location is specified by the dddir field. text: A list of one or more XPAT dd files for the collection specified as full paths relative to the value in the DLXSROOT environment variable. |
dddir |
required value/format: string class: bib, image The directory containing the XPAT dd file or files (specified in the dd field) for the collection. |
ignoreon |
optional value/format:array class: all The name or names of the virtual hosts you do not want this collection or group to appear on. The names can be the full name e.g. prod.somewhere.edu or just a part of the name e.g. somewhere.edu or just the token "all" which will ignore the colletion or group regardless of host. This is useful if you have a collection or group in the database that is skeletal, i.e. just present to hold values to be read directly from the database for UI purposes. Or perhaps the collection or group is not fully implemented for production use but you want it to appear for development purposes. If you are running the middleware on multiple servers this allows you to hide the collection or group on one or more of your hosts even though the collection or group is listed in the database and, in the case of a collection, authorized in the AUTHZD_COLL environment variable.
|
locale |
optional value/format:string class: text POSIX standard locale values, used for sorting of words with 8-bit characters. If not supplied, the locale for sorting defaults to the locale of the webserver running the middleware. If a collection is predominantly French, the locale value would be 'fr'. For more information about locales, type "locale -a" at the prompt of any Unix machine. |
map |
required value/format:string class: all The location of the TerminologyMapper map file for the collection.
|
objdir |
required value/format:string class: text, bib The directory where text/image objects are stored. Only necessary for collections.
|
port |
optional value/format:number class: all The access port for the XPAT daemon on the machine identified in "host" above. Only necessary for collections where data and indexes are on a different machine than the middleware (CGI program).
|
browseable |
optional value/format:string class: all The field takes "yes" or "no" as a value. If "yes" the navbar browse link will appear and if clicked, browse.tpl will be served from the collection-specific web dir.
|
webdir |
required value/format:string class: all The directory path relative to the DLXSROOT environment variable for the collection (usually in the form /c/collid).
|
wwdd |
optional value/format:string class: text The location of the XPAT data dictionary for the collection word wheel/word index, if there is one. For example, /idx/c/coll/WW/coll.ww.dd
|
extendedname |
required value/format:string class: bib If a value other than default is supplied for the extendedname, the value will appear on individual search pages (e.g., simple or advanced) above the search input boxes.
|
minmaxyearend |
required value/format:number class: bib The maximum valid year value to be used to check user input for date searches.
|
minmaxyearinc |
optional value/format:number class: bib The year increment value to be used for date searches.
|
minmaxyearstart |
required value/format:number class: bib The minimum valid year value to be used to check user input for date searches.
|
primaryhref |
optional value/format:string class: bib The primarytitle can be presented as a link. If a value other than default appears in the database, the template renders that value as a link. (See primarytitle)
|
primarytitle |
required value/format:value/format: string class: bib The first title (or graphical banner) that appears at the top of the initial web page. Text strings must be preceded by "text:" and graphical banners must be preceded by "graphic:". The template and database permit either a textual title or a graphical banner, but not both. (See primaryhref)
|
secondarytitle |
required value/format:string class: bib A textual second title, appearing below the primarytitle. If the value default appears, no secondary title is displayed.
|
banner |
required value/format:string class: image Often the same as collname, but used in the header of pages. May be specified as text, or as a graphic (e.g., image:bhlbanner.gif). Graphic file must be in $DLXSROOT/web/[c/collid]/graphics. The banner for cross collection display is configured in imageclass.cfg (in cgi dir).
|
briefcollname |
required value/format:string class: image A brief version of the collection name. Used for display beneath thumbnail images in results view.
|
brwsimg |
required value/format:string class: image Used to configure the "browse images" link on collection specific index pages. Enter "default" to retrieve all records with images. Leave the field blank to omit the link completely. Enter any search term (e.g., "snow") to retrieve sample records that match the term.
|
brwsrec |
required value/format:string class: image Used to configure the "browse records" link on collection specific index pages. Enter "default" to retrieve all records (with or without images). Leave the field blank to omit the link completely. Enter any search term (e.g., "snow") to retrieve sample records that match the term.
|
dfltentryflds |
required value/format:default or array class: image The list of fields (as abbreviations) to display in entry (full record) views. To display all fields, enter the value "default". For details about the full range of options, please see the appropriate Image Class documentation.
|
dfltresentryflds |
required value/format:default or array class: image The list of fields (as abbreviations) to display in the results view that includes the full record (i.e., thumbfull view). To display all fields, enter the value "default". For details about the full range of options, please see the appropriate Image Class documentation.
|
dfltsrchflds |
required value/format:default or array class: image The list of fields (as abbreviations) that may be searched. These are the fields that show up in the search form. to display all fields, enter the value "default".
|
entrydivs |
required value/format:array class: image The entry/record display uses HTML DIVs to provide two different display modes (i.e., "full image" and "description"). The user can flip back and forth between the two display modes. If a collection has records with images and descriptions, you will want to include both, (e.g., full image, on one line, and description, on another ). For a collection that has descriptions but no images, you probably want to only include "description."
|
entrydivsdefault |
required value/format:string class: image The default display mode for the entry/record display. When the record is first displayed, should the "full image" view be shown first, or the "description" view?
|
imgqual |
required value/format: string class: image The default size for image display. There are several ways to specify the quality. examples:
|
imgsizemax |
optional value/format:string class: image Allows a restriction to be put on the maximum full size image displayed. Definable in terms similar to imgqual above.leave field blank for no restriction.
|
imgsizemin |
optional value/format:string class: image Allows a restriction to be put on the minimum full size image displayed. Definable in terms similar to imgqual above.leave field blank for no restriction.
|
mediaonly |
required value/format:string class: image Controls the presence and default status of the "media only" restriction in the search form. There are several possible values.
|
numqs |
required value/format:number class: image The number of text fields to display in search form.
|
relviewmenu |
required value/format:string class: image Related view menu. Set to "on" to display a pop-up menu in the entry/record view that allows navigation to any of the images associated with the entry/record (the record must have multiple images). Useful as a page-flipping mechanism. e.g.: "off".
|
relviewmenuinstruct |
required value/format:string class: image String of instruction text to precede the related view menu (relviewmenu). e.g.: "default".
|
relviewmenuprefx |
required value/format:string class: image String of text to precede each item in the related view menu (relviewmenu) e.g.: "default."
|
relviewmenuvals |
required value/format:string class: image The SGML ISTRUCT attribute to use for display values in the related view menu (relviewmenu)
In addition to "CAPTIONS", any of the ISTRUCT attribute names are valid (e.g., "FACE").
|
resfldtrim |
required value/format:number class: image Maximum character string length for each field in dfltresflds. This is used for trimming long fields down to the specified number of characters when being displayed under thumbnail images. e.g.: "50".
|
reslistresflds |
required value/format:default or array class: image The list of fields (as abbreviations) to display in "captions only " results view. To display all fields, enter the value "default".
|
resultsviews |
required value/format:array class: image The list of results views to be made available to users. Legal values are any combination of: thumbnail, thumbfull, reslist. Order is not important.
|
resultsviewsdefault |
required value/format:string class: image The default result view. Legal values (choose one): thumbnail, thumbfull, reslist
|
sortflds |
required value/format:array class: image, text Image: The list of field abbreviations that should be provided as options for sorting. Sort fields for multiple collections is configured in the groups database. "none" must always be the first value. Text: The list of field abbreviations that should be provided as options for sorting. The possible values are "occur", "datea", "dated", "author", "title" which correspond to the pulldown menu items: "NONE", "date ascending" ,"date descending", "author" and "title". . The menu items will appear in the order listed in the collmgr field. In single collection mode, the middleware defaults to the first item listed here. If no field abbreviations are specified, the sort selection menu will not appear in the user interface. This makes sense for a collection by a single author with a single publication date where every title is identical or nearly so. For example, "Collected Works of Abraham Lincoln, Vol. 1" published in 1953. If a single field (other than "occur") is supplied the menu will display the single field and that sort will always be done. In cross-collection mode, these fields are not used. Instead the values in %gSortFields and @gSortFieldsOrder in DLXSROOT/cgi/t/text/textclass.cfg are used and the sort order defaults to the first element of @gSortFieldsOrder (probably 'occur'). Note, for example, when lincoln is part of a cross collection search the sort menu is constructed from @gSortFields which may specify a sort order not specified for the lincoln collection in single-collection mode. In this case, lincoln will sort by author, title, date among the items from the other collections in the search results but only if author, title, date mappings are present in the lincoln.map file. If no mapping for the given sort order exists the item will sort to the end of the list. |
thumbfullresflds |
required value/format:default or array class: image The list of fields (as abbreviations) To display in "thumbnail with full record" results view. to display all fields, enter the value "default".
|
thumbnailresflds |
required value/format:default or array class: image The list of fields (as abbreviations) to display in "thumbnail with captions" results view. To display all fields, enter the value "default".
|
bibsearch |
required value/format:array class: text The regions in which citation searches are conducted (minimally, citation).
|
charfilters |
optional value/format: class: text Supply one or more of 'isogreek', 'pldgreek', 'chgreek', 'ipa', or 'misc' to filter each class of character entity references (if present in the collection data).
|
divheadrange |
required value/format: class: text A number indicating the deepest level of encoding present in the collection, e.g. "4" if the lowest division is <DIV4>
|
firstpublishedstart |
optional value/format:string class: text Indicates whether there are maps for dates of first publication, if available, in the form YYYY where YYYY is the earliest publication date. Derived from markup in the collection. Must be supported by entries in the collection map.
|
firstpublishedend |
optional value/format:string class: text Indicates whether there are maps for dates of first publication, if available, in the form YYYY where YYYY is the latest publication date. Must be supported by entries in the collection map.
|
firstpublishedinc |
optional value/format:string class: text Indicates whether there are maps for dates of first publication, if available, X where X is increment in the number of years between firstpublishedstart and firstpublishedend. Derived from markup in the collection. Must be supported by entries in the collection map.
|
fisheyethreshold |
reserved for future use value/format: class: text Not currently used.
|
lel |
required value/format:number class: text The encoding level of the document that has the lowest level of encoding of any document in the collection.
|
notemaxdivhead |
optional value/format: class: text If collection contains notes, this is the number of the most deeply nested division enclosing either a <NOTE> or the target of a <PTR>, e.g. "3" if <DIV3> is the lowest division containing <NOTE> or the target of a <PTR>.
|
notesfilters |
optional value/format: class: text Supply either or both of 'inline' or 'ptr' to filter each kind of note (if present in the collection data) corresponding to <NOTE> and <PTR> elements.
|
qtytext |
required value/format:number class: text The number of DLPSTEXTCLASS objects (or texts) in the collection.
|
regionsearch |
required value/format:array class: text, bib The regions which are retrieved for Boolean searches (minimally, "work").
|
singlegender |
optional value/format:string class: text 'mappped' indicates that there are maps for specific assigned genders for a single collection, used to create restrictions for searches if available. Otherwise blank. Derived from markup in the collection. Must be supported by entries in the collection map.
|
singlegenre |
optional value/format:string class: text 'mapped' indicates that there are maps for specific assigned genres for a single collection, used to create restrictions for searches if available. Otherwise blank. Derived from markup in the collection. Must be supported by entries in the collection map.
|
singleperiod |
optional value/format:string class: text 'mapped' indicates that there are maps for specific assigned periods for a single collection, used to create restrictions for searches, if available. Otherwise blank. Derived from markup in the collection. Must be supported by entries in the collection map.
|
sortthreshold |
required value/format: class: text Number of results above which results obtained from a search are not sorted.(e.g. "1000")
|
standalonename |
required value/format:string, preceded by text: or graphic: class: text The collection banner for the standalone collection, which will create a link to the collections index page from all underlying pages.
|
subclass |
reserved for future
use value/format: class: text Not currently used
|
subclassmodule |
required value/format:string class: bib, text The name of the subclass module (without the '.pm' suffix) that defines the subclass of the TextClass or BibClass object for the collection. Many text collections will simply use the value "TextClass" and, likewise, many bib collections will use the value "BibClass." For others with a specific subclass, the convention is "collidTC" ("collidBC" for bib) corresponding to the file collidTC.pm or collidBC.pm. These modules are located in the TextClass cgi directory for Text Class or BibClass for Bib Class. (e.g., The subclass should be entered as "TextClass/collidTC"). |
appmodule |
required value/format:string class: all The module name (without .pm suffix) of the Application Object or subclass thereof supporting the basic application functionality for a given class (Text, Image, Bib) of the middleware. Supply one of TextApp, ImageApp or BibApp for the default application behavior or a subclass if one has been written for this collection. (e.g., the subclass should be entered as "TextApp/FooTCApp".) |
pvappmodule |
required value/format:string class: text The module name (without .pm suffix) of the PVApp object or subclass thereof supporting the pageviewer application for this collection. Use "PVApp" unless a subclass has been written for this collection. (e.g., the subclass should be entered as "PVApp/FooPVApp".) |
tcumodule |
required value/format: class: text The module name (without .pm suffix) of the TextClassUtils object or subclass thereof supporting this collection. Use "TextClassUtils" unless a subclass has been written for this collection. (e.g., the subclass should be entered as "TextClassUtils/FooTCU".) |
termsearch |
required value/format:array class: text The regions in which simple searches are conducted, as they appear in the simple search pull-down menu (minimally, full text).
|
wwappmodule |
required value/format: class: text The module name (without .pm suffix) of the WWApp object or subclass thereof supporting the wordwheel application for this collection. Use "WWApp" unless a subclass has been written for this collection. (e.g., subclass should be entered as "WWApp/FooWWApp".)
|
pageviewmodule |
required value/format: class: text The module name (without .pm suffix) of the PageView object or subclass thereof supporting the database access and image transformation function for the page viewer application for this collection. Use "PageView" unless a subclass has been written for this collection.(e.g., subclass should be entered as "PageView/FooPV".)
|
wwrealms |
required value/format:array (TITLE, AUTHOR, TEXT) class: text The SGML regions from which word wheel/word index words are gathered if a word wheel/word index is built.
|
wwrealmseng |
required value/format:array. (title, author, full text) class: text The values that appear (i.e., the displayed labels) with radio buttons on the word wheel/word index search template. Must correspond to wwrealms.
|
pageimages |
optional value/format:string class: text Enter 1 if the collection has page images for viewing under page viewer, 0 otherwise.
|
defaultpageview |
optional value/format:string. class: text If the collection has page images, enter one of 'image, 'text' or 'pdf' to control which view of the page the page viewer will offer by default.
|
pageviewselectvalues |
optional value/format:array class: text If the collection has page images, enter one or more of 'image, 'text' or 'pdf' to control which viewing formats will be displayed in the page viewer pulldown list.
|
pdfchunk |
optional value/format:string. class: text If the collection has pdf, enter the number of image files which are to be bundled into a single pdf file for viewing under page viewer.
|
pageviewimageformat |
optional value/format:string. class: text The format of the object which should be generated from the stored object, e.g. 'gif', 'pdf', 'tif'.
|
storedimageformat |
optional value/format:string. class: text The format of the the stored object representing a page, e.g. 'gif', 'pdf', 'tif'. This is the source of the transformation whose output is specified by the pageviewimageformat field.
|
encodingtype |
required value/format:string. class: text The encoding type of documents in the collection. The possible values are "monograph", "serialissue" or "serialarticle". A collection of encoding type "monograph" is structured into one or more documents each of which has a HEADER and a TEXT region. A typical document might be a book by a single author. A collection of encoding type "serialissue" is structured into journals each of which has a HEADER and a TEXT region. Within the TEXT region must occur one or more DIV1 regions representing articles in the given issue of the journal. A collection of encoding type "serialarticle" is a single virtual or born-digital journal structured as a series of articles each of which has a HEADER and a TEXT region.
|
detailviewtype |
required value/format:string. class: text The type of the view used to display the detailed results for a single item in the result list. The possible values are "kwic" or "summary". The "kwic" detail view displays bibliographic data for the item followed by a list of Key Words in Context (KWIC). The key word or words are the search terms highlighted in red centered within a context of 100 characters before and after the search term. The "summary" detail view also starts wth the bibliographic data for the item but is followed by a one line summary of the number of hits of the search term within the given item or subregion of the item. For eaxmple, "3 matches of dog in 5 of 20 poems".
|
detailviewlayout |
required value/format:string. class: text The layout of DIVs or PAGEs that scopes either the summary or KWIC as selected in the "detailviewtype" field above. The possible values are "breadcrumb" or "outline". The "outline" layout is more or less self-explanitory. Each DIV or PAGE that scopes a KWIC or summary is indented to its proper level as one proceeds down the page. The "breadcrumb" layout is expressed as a path from an upper level DIV down through lower level DIVs all on a single line. For example, 20th Century History>Europe>France followed on the next line by the summary or KWIC display of hits within "France".
|