|
|
| (One intermediate revision not shown.) |
| Line 1: |
Line 1: |
| - | The [../../collmeta/colldatabases.html collection database] for BibClass and all other classes is managed through the [../../collmeta/collmgr.html collmgr] program. The collmgr application mediates access to creating and updating the metadata, and has online, in-context documentation, for example, the DLPS implementation of [../../collmeta/collmgr-fields.html collmgr documentation]. This documentation notes fields that are "required," as well as the types of values that each field supports. In those cases where a field uses the reserved keyword "default," a system-supplied default value or function is used. For example, in BibClass, if "default" is used for <tt>short filter</tt>, records will be displayed according to the rules used in the default BibClass short filter.
| |
| | | | |
| - | For most of your BibClass collections, you will add the following fields. The instructions below assume a sample collection named "nyt". Please replace these sample names with your local filenames.
| |
| - |
| |
| - | * <tt>collid</tt> = [The unique ID string used for the collection, e.g.,] ''nyt''
| |
| - | * <tt>collname</tt> = [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, e.g.,] ''Historical Index to the New York Times (1863-1905)''
| |
| - | * <tt>appmodule</tt> = [The module name (without .pm suffix) of the Application Object or subclass thereof supporting the basic application functionality for the BibClass middleware, e.g.,] ''BibApp''
| |
| - | * <tt>homesite</tt> = [The URL for the host webserver hosting the middleware, e.g.,] ''http://www.hti.umich.edu/''
| |
| - | * <tt>host</tt> = [The host name for the machine hosting the collection data and data indexes, e.g.,] ''www.hti.umich.edu''
| |
| - | * <tt>map</tt> = [The location of the TerminologyMapper map file for the collection, e.g.,] ''nyt.map'' [or default]
| |
| - | * <tt>minmaxyearend</tt> = [The maximum valid year value to be used to check user input for date searches, e.g.,] ''2002''
| |
| - | * <tt>minmaxyearstart</tt> = [The minimum valid year value to be used to check user input for date searches, e.g.,] ''1912''
| |
| - | * <tt>objdir</tt> = [The directory where text/image objects are stored, e.g.,] ''/n/nyt''
| |
| - | * <tt>port</tt> = [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, e.g.,] ''620''
| |
| - | * <tt>primarytitle</tt> = [The first title (or graphical banner) that appears at the top of the initial web page, e.g.,] ''text:Historical Index to the New York Times (1863-1905)''
| |
| - | * <tt>subclassmodule</tt> = [The name of the subclass module (without the ".pm" suffix) that defines the subclass of the BibClass object for the collection, e.g.,] ''BibClass/NytBC''
| |
| - | * <tt>webdir</tt> = [The directory path relative to DLXSROOT for the collection (usually in the form /c/collid), e.g.,] ''/n/nyt''
| |
| - | * <tt>dd</tt> = [A list of one or more XPAT .dd files for the collection. Their location is specified by the dddir field, e.g.,] ''/idx/n/nyt/nyt.dd''
| |
| - | * <tt>regionsearch</tt> = [The regions which are retrieved for Boolean searches (minimally, "entire record"), e.g.,]
| |
| - | ** ''entire record''
| |
| - | ** ''author''
| |
| - | ** ''title''
| |
| - |
| |
| - | Submit your changes and check them in.
| |
| - |
| |
| - | = Related Information =
| |
| - |
| |
| - | You '''must''' also create templates for the new collection. For more information on creating and altering templates, please see [templates.html Creating and Editing HTML/Template Files].
| |
| - |
| |
| - | You '''may''' also add new fields, not previously defined. For more information on adding new searchable fields, please see [maps.html Adding New Searchable Fields].
| |
| - |
| |
| - | You '''may''' also wish to create special filtering routines for the new collection. For more information on creating and editing filters, please see [filters.html Creating and Editing Filtering Routines].
| |
