Collection Manager Field Descriptions

From DLXS Documentation

(Difference between revisions)
Jump to: navigation, search
Current revision (13:20, 11 October 2007) (edit) (undo)
 
(9 intermediate revisions not shown.)
Line 1: Line 1:
-
[[DLXS Wiki|Main Page]] > [[Working with DLXS Componenets]] > Collection Manager Field Descriptions
+
[[DLXS Wiki|Main Page]] > [[Working with DLXS Components]] > Collection Manager Field Descriptions
-
 
+
<hr>
-
<b>collid</b><br>
+
[http://www.dlxs.org/wiki-externals/collmgr/collmgr-fields.html Collmgr Field Descriptions (current version)]
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>The unique ID string used for the collection. Usually corresponds to
+
-
the directory name holding the collection files.</p>
+
-
 
+
-
<p>Collids should consist only of letters, numbers and underscores.  Collmgr restricts the allowable characters in a collid to just those typically permitted in programming languages.  For example, hyphens, *, +, %, etc. are not permitted.  </p>
+
-
 
+
-
 
+
-
<b>collname</b><br>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>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.</p>
+
-
             
+
-
 
+
-
<b>contactlink</b><br>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>image, text, findaid
+
-
 
+
-
<p>For constructing the contact mailto link; contains the content of the HREF attribute of the A element (e.g., "mailto:help@some.edu")</p>
+
-
         
+
-
 
+
-
<b>contacttext</b><br>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class:</i> image, text, findaid
+
-
 
+
-
<p>For constructing the contact mailto link; contains the content of the A element that will appear as the link text (e.g. "Help").</p>
+
-
           
+
-
 
+
-
<b>defaultgroupid</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>For assigning a default group to a collection. Causes group templates, etc. to be used for a collection even when a "g" (group) parameter is not on the URL.</p>
+
-
+
-
 
+
-
<b>Group Id</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>The unique identifier for a group of collids.  Used as the value of the "g" URL parameter.</p>
+
-
 
+
-
 
+
-
<b>groupname</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>The name of the group.  The text string provided is displayed as a window title and as the name of the group in lists of groups.</p>
+
-
 
+
-
 
+
-
<b>defaultpageview</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>If the collection has page images ('pageimages' field set to '1'),
+
-
enter one of 'image, 'text' or 'pdf' to control which view of the
+
-
page the page viewer will offer by default.  This field should be left
+
-
blank if the 'pageimages' field is set to 0 or empty.</p>
+
-
+
-
 
+
-
<b>defaultpageviewsize</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string.<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>This is the default size for display of a page image
+
-
in pageviewer. Pageviewer uses this size to determine how much to scale
+
-
an image up or down in size based on possible multiple resolutions stored
+
-
in page image files. If this field is blank, the global default value
+
-
(in the IVGlobals package, in lib/ItemView.cfg) is used.
+
-
Possible values are 'S' for small; 's' for medium or "normal"; and
+
-
'l' (lowercase L) for large.</p>
+
-
 
+
-
 
+
-
<b>orglink</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>For constructing the organization mailto link; contains the content of the
+
-
HREF attribute of the A element (e.g., &quot;mailtoorginfo@umich.edu/&quot;)</p>
+
-
 
+
-
 
+
-
<b>orgtext</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>For constructing the organization mailto link; contains the content of the
+
-
A element that will appear as the link text (e.g. &quot;org-info@umich.edu/&quot;).</p>
+
-
 
+
-
 
+
-
<b>querylanguage</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>If using MySQL to search image collections set the value to 'sql' otherwise 'xpat', with 'xpat' being the default.</p>
+
-
 
+
-
 
+
-
<b>rendering</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>bib
+
-
 
+
-
<p>This value configures the default html rendering mechanism for the collection. If set to &quot;perl&quot;, the CGI program will use HTML templates and create data results in HTML for output. If set to &quot;xslt&quot;, [deprecated] the CGI program will call the XLST engine to render the XML templates and to render XML data results into HTML for output.</p>
+
-
 
+
-
 
+
-
<b>languagepriority</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>array<br>
+
-
<i>class: </i>findaid, image, text
+
-
 
+
-
<p>Specifies the language lookup table to be used for strings, messages, etc in the user interface. This field is present in both the Collection and Group configuration pages.    The effective language into which XSL will render the interface is based on a priority scheme involving the following configuration variables:
+
-
                <ol>
+
-
                  <li>The Collection and Group database &quot;languagepriority&quot; fields which are multi-valued fields whose first value lists the default language followed by the other languages supported for the group or collection, in no particular order.</li>
+
-
 
+
-
                  <li>The Perl global variable @LibGlobals::gLanguageDefaultPriority which is an array of values treated in the same priority fashion as the &quot;languagepriority&quot; fields in the database.</li>
+
-
                  <li>The &quot;lang&quot; URL parameter.</li>
+
-
                </ol></p>
+
-
 
+
-
<p>The effective language is determined by the following alogorithm:
+
-
               
+
-
If there is a &quot;lang&quot; URL parameter, its value determines the effective language.  If its value is not configured for the effective collection or group mode the default (first) value configured for the mode is used.  If the mode does not have any &quot;languagepriority&quot; field values configured for the mode the global Perl variable @LibGlobals::gLanguageDefaultPriority is consulted.  If the requested language is not present in that list the first value is taken as the effective language.  This value, L, is used to construct langmap filename by the convention &quot;langmap.L.xml&quot;.  It is an error if there is not a langmap file by that name in the target fallback directory for the mode (cross-collection or single-collection).</p><p>
+
-
 
+
-
If there is *not* a &quot;lang&quot; URL parameter, the effective language is determined, depending on mode, by the first value in the &quot;languagepriority&quot; fields in the Collection or Group fields, if supplied, else by the first value in the Perl global variable@LibGlobals::gLanguageDefaultPriority.
+
-
              </p>
+
-
 
+
-
 
+
-
<b>xlstpifillermodule</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>Findaid, Text, Image
+
-
 
+
-
<p>The module name (without .pm suffix) of the XsltPIFiller Object (which handles application level or user interface filtering) or the subclass thereof for the collection. Supply one of TextAppXsltPIFiller for the default TextApp behavior or a subclass if one has been written for the collection. Same for FindaidAppXsltPIFiller. BibApp and ImageApp are not configured to use this mechanism yet.</p>
+
-
 
+
-
 
+
-
<b>homesite</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>text, bib
+
-
             
+
-
<p>The URL for the host webserver hosting the middleware for this
+
-
collection. (e.g. &quot;http//www.hti.umich.edu&quot;).
+
-
The value &quot;localhost&quot; can be supplied which
+
-
will resolve to whatever machine the middleware happens
+
-
to be running on.</p>
+
-
         
+
-
<p>Occasionally, the need may be for a URL other than that
+
-
of the middleware host.  For example, the collection may
+
-
have a home page from another institution to which the
+
-
user should be directed such as http://historical.library.cornell.edu/math/.  These
+
-
non-local URLs should be flagged by prepending "foreign:"
+
-
so that the middleware will not append local cgi script
+
-
names to the URL string. </p>
+
-
           
+
-
 
+
-
<b>host</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>The virtual host name for the machine hosting the collection data and data indexes.
+
-
This is usually the same host hosting the middleware. </p>
+
-
 
+
-
<p>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., &quot;www.hti.umich.edu&quot;).  The value &quot;localhost&quot; can also be be supplied which will resolve to whatever machine the middleware happens to be running on. If the value is not &quot;localhost&quot; 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.</p>
+
-
 
+
-
 
+
-
<b>pageviewhost</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>The virtual host name for the machine hosting the
+
-
page image data files.  If no value is supplied
+
-
pageviewhost defaults to the value in the <a href="#host">host</a> field
+
-
(which is usually the same host as that hosting the
+
-
middleware). Note that if the value of pageviewhost is
+
-
different than both the middleware host and the xpat
+
-
data host then the remote daemon (dlxsd) must be
+
-
configured to run on the host specified for
+
-
pageviewhost.  This is necessary in order for the
+
-
pageviewer cgi to send commands to that remote page
+
-
image data host to run programs (if necessary) to
+
-
transform, for example, TIFF files to GIF for web
+
-
display.  See also the the explanation for <a href="#host">host</a>.  </p>
+
-
 
+
-
 
+
-
<b>dd</b>
+
-
<i>required</i><br>
+
-
<i>value/format: </i>array<br>
+
-
<i>class:</i> text, bib, findaid
+
-
 
+
-
<p>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.</p>
+
-
 
+
-
 
+
-
<b>locale</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>This optional field specifies a IANA standard locale value. </p>
+
-
 
+
-
             
+
-
<blockquote><p><b>Text, Findaid, Image:</b> These classes have been converted to pure XML support with some legacy support for  ISO-8859-* SGML data.  If the locale specifies a Unicode UTF-8 encoding (e.g. en_US.UTF-8) the middleware will expect collection data to be Unicode UTF-8 encoded XML.  The effect of this setting is:
+
-
                  <ul>
+
-
                    <li>The middleware will use <b>xpatu</b> search engine to search the collection data.  This implies that the data was indexed by <b>xpatbldu</b> and <b>xmlrgn/multirgn</b>.</li>
+
-
            <li>The middleware will expect user input to be UTF-8 encoded. The is ensured by charset=utf-8 in the &lt;meta&gt; HTML tag and in the HTTP header.</li>
+
-
 
+
-
            <li>Perl's internal UTF-8 flag is set on Perl string variables to handle multi-byte UTF-8 encoded data at the character level. </li>
+
-
          </ul>
+
-
If the field is blank, the default is equivalent to entering &quot;en_US.ISO-8859-1&quot;.  The middleware will expect collection data to be  ISO-8859-* encoded SGML.  Any non-XML character entity references present in the data should be declared in an <tt>entitiesdoctype.chnk</tt> file placed in a collection-specific web directory.  The effect of this setting is:
+
-
            <ul>
+
-
              <li>The middleware will use <b>xpat</b> search engine to search the collection data.  This implies that the data was indexed by <b>xpatbld</b> and <b>sgmlrgn/multirgn</b>.</li>
+
-
 
+
-
              <li>The middleware will still expect user input to be UTF-8 encoded. The is ensured by charset=utf-8 in the &lt;meta&gt; HTML tag and in the HTTP header.</li>
+
-
              <li>Data returned from XPAT is transcoded from ISO-8859-* to UTF-8 and SGML singletons are changeed to XML singletons in the output stream. </li>
+
-
              <li>Perl's internal UTF-8 flag is set on Perl string variables to handle multi-byte UTF-8 encoded data at the character level. </li>
+
-
            </ul>
+
-
          </p></blockquote>
+
-
 
+
-
 
+
-
<blockquote><p><b>BibClass:</b> Currently, BibClass has not been converted to pure XML/XSLT support. If the locale specifies a Unicode UTF-8 encoding (e.g. en_US.UTF-8) the middleware will expect collection data to be Unicode UTF-8 encoded XML.  The effect of this setting is:
+
-
                <ul>
+
-
 
+
-
                  <li>The middleware will use <b>xpatu</b> search engine to search the collection data.  This implies that the data was indexed by <b>xpatbldu</b> and <b>xmlrgn/multirgn</b>.</li>
+
-
                  <li>The middleware will expect user input to be UTF-8 encoded. The is ensured by charset=utf-8 in the HTTP header.  The middleware will change occurrences of charset=ISO-8859-1 (if present in the HTML &lt;meta&gt; tag) to charset=UTF-8 when outputting processed HTML templates.</li>
+
-
 
+
-
                  <li>Perl's internal UTF-8 flag is set on Perl string variables to handle multi-byte UTF-8 encoded data at the character level. </li>
+
-
                </ul>
+
-
If the field is blank, the default is equivalent to entering &quot;en_US.ISO-8859-1&quot;.  The middleware will expect collection data to be  ISO-8859-* encoded SGML. The effect of this setting is:
+
-
                <ul>
+
-
                  <li>The middleware will use <b>xpat</b> search engine to search the collection data.  This implies that the data was indexed by <b>xpatbld</b> and <b>sgmlrgn/multirgn</b>.</li>
+
-
 
+
-
                  <li>The middleware will still expect user input to be ISO-8859-* encoded. The is ensured by charset=ISO-8859-1 in the &lt;meta&gt; HTML tag.</li>
+
-
                </ul>
+
-
              </p></blockquote>
+
-
 
+
-
 
+
-
<p>Note that <b>all</b> collections must be in a single encoding, either all ISO-8859-* or all Unicode UTF-8 for characters in cross-collection result views to render correctly.  Single collection functionality supports either ISO-8859-* or UTF-8 encodings.  It is recommended that collection data be UTF-8 encoded for character support over the widest range of alphabets.  This is necessarily so for collection data containing characters from multiple alphabets.</p>
+
-
 
+
-
 
+
-
<b>map</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>The location of the TerminologyMapper map file for the collection.</p>
+
-
 
+
-
 
+
-
<b>objdir</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>text
+
-
             
+
-
<p>The directory where page image files are stored. Only
+
-
necessary for collections with page images.  Typically,
+
-
<tt>/obj</tt> relative to DLXSROOT. The pageviewer middleware
+
-
appends an additional path component based on the IDNO
+
-
of the text object when accessing a given page.  For
+
-
example, at UM, for the IDNO <tt>aas7611.0001.001</tt> the
+
-
additional path component is <tt>/a/a/s/aas7611.0001.001</tt>
+
-
relative to <tt>/obj</tt> relative to DLXSROOT giving
+
-
<tt>/l1/obj/a/a/s/aas7611.0001.001/</tt>. Images for the
+
-
individual pages of <tt>aas7611.0001.001</tt> reside within
+
-
this final directory path.</p>
+
-
 
+
-
 
+
-
<b>port</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>number<br>
+
-
<i>class: </i>text, findaid, bib
+
-
 
+
-
<p>The access port for the XPAT daemon on the machine
+
-
identified in <a href="#host">host</a>. Only
+
-
necessary for collections where data and indexes are on
+
-
a different machine than the middleware (CGI
+
-
program).</p>
+
-
 
+
-
 
+
-
<b>webdir</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
i>class: </i>all
+
-
 
+
-
<p>The directory path relative to the DLXSROOT environment variable for the collection (usually in the form /c/collid). Image Class requires the leading slash.</p>
+
-
 
+
-
 
+
-
<b>wwdd</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>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</p>
+
-
 
+
-
 
+
-
<b>extendedname</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>bib
+
-
 
+
-
<p>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. </p>
+
-
 
+
-
 
+
-
<b>minmaxyearend</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>number<br>
+
-
<i>class: </i>bib
+
-
 
+
-
<p>The maximum valid year value to be used to check user input for date searches. </p>
+
-
 
+
-
 
+
-
<b>minmaxyearinc</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>number<br>
+
-
<i>class: </i>bib
+
-
 
+
-
<p>The year increment value to be used for date searches. </p>
+
-
 
+
-
 
+
-
<b>minmaxyearstart</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>number<br>
+
-
<i>class: </i>bib
+
-
 
+
-
<p>The minimum valid year value to be used to check user input for date searches. </p>
+
-
 
+
-
 
+
-
<b>primaryhref</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>bib
+
-
 
+
-
<p>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 <a href="#primarytitle">primarytitle</a></p>
+
-
 
+
-
 
+
-
<b>primarytitle</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>value/format: string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>The first title (or graphical banner) that appears at
+
-
the top of the initial web page. Text strings must be
+
-
preceded by &quot;text:&quot; and graphical banners must
+
-
be preceded by &quot;graphic:&quot;. The template and
+
-
database permit either a textual title or a graphical
+
-
banner, but not both.  See <a href="#primaryhref">primaryhref</a>.  If the
+
-
primarytitle is a graphic and not just a string, then
+
-
the <a href="#webdir">webdir</a> field must be filled in as well.</p>
+
-
 
+
-
 
+
-
<b>secondarytitle</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>text, bib, findaid
+
-
 
+
-
<p>A textual second title, appearing below the primarytitle. If the value
+
-
default appears, no secondary title is displayed. </p>
+
-
 
+
-
 
+
-
<b>briefcollname</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>A brief version of the collection name. Used for display beneath thumbnail
+
-
images in results view.</p>
+
-
 
+
-
 
+
-
<b>brwsimg</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>Used to configure the &quot;browse images&quot; link on collection
+
-
specific index pages. Enter &quot;default&quot; to retrieve all
+
-
records with images. Leave the field blank to omit the link completely.
+
-
Enter any single word search term (e.g., &quot;snow&quot;) to retrieve sample records
+
-
that match the term.</p>
+
-
 
+
-
 
+
-
<b>brwsrec</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>Used to configure the &quot;browse records&quot; link on collection
+
-
specific index pages. Enter &quot;default&quot; to retrieve all
+
-
records (with or without images). Leave the field blank to omit
+
-
the link completely. Enter any search term (e.g., &quot;snow&quot;) to retrieve sample records
+
-
that match the term.</p>
+
-
 
+
-
 
+
-
<b>data_table</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>The name of the MySQL table in the DLXS database with the collection's principle data.</p>
+
-
 
+
-
 
+
-
<b>media_table</b>
+
-
<i>required for MySQL collections</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>The name of the MySQL table in the DLXS database with the collection's media file data.</p>
+
-
 
+
-
 
+
-
<b>dfltentryflds</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>default or array <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>The list of fields (as abbreviations) to display in entry (full record)
+
-
views. To display all fields, enter the value &quot;default&quot;.</p>
+
-
 
+
-
<p>For details about the full range of options, please see the relevant <a href="http://www.dlxs.org/d/dlxs/docs/13/class/image/colldb.html">Image Class documentation</a>.</p>
+
-
 
+
-
 
+
-
<b>dfltresentryflds</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>default or array<br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>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 &quot;default&quot;.</p>
+
-
 
+
-
<p>For details about the full range of options, please see the relevant <a href="http://www.dlxs.org/d/dlxs/docs/13/class/image/colldb.html">Image Class documentation</a>.</p>
+
-
 
+
-
 
+
-
<b>dfltsrchflds</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>array<br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>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. The value &quot;default&quot; is no longer valid as of DLXS 11. If the ability to search across all fields is desired, include collid_all here.</p>
+
-
 
+
-
 
+
-
<b>entrydivs</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>array <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>The entry/record display uses HTML DIVs to provide two different display
+
-
modes (i.e., &quot;full image&quot; and &quot;description&quot;). 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 &quot;description.&quot;</p>
+
-
 
+
-
 
+
-
<b>entrydivsdefault</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>The default display mode for the entry/record display. When the record
+
-
is first displayed, should the &quot;full image&quot; view be shown first, or the
+
-
&quot;description&quot; view?</p>
+
-
 
+
-
 
+
-
<b>entryauth</b>
+
-
<i>required for MySQL collections</i><br>
+
-
<i>value/format:</i>string </span><br />
+
-
<i>class: </i>image
+
-
 
+
-
<p>Strictly used for Image Class data loading.
+
-
The entryauth field holds the default item access control value to be included in the media_table record for each item (image or other media file). Set the entryauth field to one of "world", collid (the actual collid), or "no access". Value may be overriden in each data record to restrict access to individual items. <a target="_blank" href="../class/image/mysql.html#itemaccess">More info</a>.
+
-
 
+
-
 
+
-
<b>searchable_items</b>
+
-
<i>required for MySQL collections</i><br>
+
-
<i>value/format:</i>string </span><br />
+
-
<i>class: </i>image
+
-
 
+
-
<p>Strictly used for Image Class data loading.
+
-
<p>Controls display of images in search results when a record has multiple images. Values are "detail", "summary", "both". "Both" is the default value. If records only have one image, "summary" and "both" are safe choices.  <a target="_blank" href="../class/image/mysql.html#itemaccess">More info</a>.
+
-
</p>
+
-
   
+
-
         
+
-
<b>imgqual</b><
+
-
<i>required</i><br>
+
-
<i>value/format:</i> string<br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>The default size for image display. There are several ways to specify
+
-
the quality.</p>
+
-
              <blockquote>examples:
+
-
                <ul>
+
-
                  <li>h600 -- height no larger than 600 pixels</li>
+
-
                  <li>w500 -- width no larger than 600 pixels</li>
+
-
 
+
-
                  <li>m800 -- max dimension of image no larger than 800 pixels</li>
+
-
                  <li>min -- smallest available</li>
+
-
                  <li>max -- largest available</li>
+
-
                  <li>mid -- mid-size among available</li>
+
-
                  <li>preview -- defined in imageclass.cfg ($gDefaultPreviewImageSize)</li>
+
-
                  <li>screen -- defined in imageclass.cfg ($gDefaultScreenImageSize)</li>
+
-
 
+
-
                  <li>integer value -- MrSID res value</li>
+
-
                </ul>
+
-
              </blockquote>
+
-
             
+
-
 
+
-
<b>imgsizemax</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>Allows a restriction to be put on the maximum full size image
+
-
displayed. Definable in terms similar to imgqual. Leave field
+
-
blank for no restriction. This setting may be overriden for privileged
+
-
users by listing user IDs in the privileged_users field. </p>
+
-
 
+
-
 
+
-
<b>privileged_users</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>List user IDs in order to grant unlimited image size access
+
-
even when the <strong><a href="#imgsizemax">imgsizemax</a></strong> field is being used to restrict access for most users to larger sizes.</p>
+
-
 
+
-
 
+
-
<b>range_srchflds (beta)</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>(Consider this as beta functionality. Feedback is desired.)
+
-
List field abbreviations to be targeted in numeric range searches.
+
-
These will have special representation in the search form. To
+
-
search multiple fields as if one (e.g., "start date" and "end date"),
+
-
create a field mapping in<strong> <a href="#field_xcoll_maps">field_xcoll_maps</a></strong> and
+
-
include the xcoll mapping in <strong>range_srchflds</strong>. Remember,
+
-
this is a numeric range search, so field values must be numbers
+
-
in order to get expected results. For example, May 5, 2006 should
+
-
have a data table field value of 20060505. It is also necessary
+
-
to map the range_srchflds toto<strong> ic_range</strong> in <a href="#field_admin_maps"><strong>field_admin_maps</strong></a>.
+
-
<strong>range_srchflds</strong> is where you specify which fields appear in the
+
-
search form. <a href="#field_admin_maps"><strong>field_admin_maps</strong></a> is where you specify that the field
+
-
should be treated as a range when the query is built by the middleware.</p>
+
-
 
+
-
<p>For example, if your data records have a field with the abbreviation
+
-
&quot;year&quot; and it contains 4 digit year values, put <strong>year</strong> in
+
-
the <strong>range_srchflds</strong> Collmgr field, and in <strong><a href="#field_admin_maps">field_admin_maps</a></strong> include
+
-
<strong>ic_range:::year</strong>.</p>
+
-
 
+
-
 
+
-
<b>imgsizemin</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>Allows a restriction to be put on the maximum full size image displayed.
+
-
Definable in terms similar to imgqual. Leave field blank for no restriction.</p>
+
-
 
+
-
 
+
-
<b>mediaonly</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string </span><br />
+
-
<i>class: </i>image
+
-
 
+
-
<p>Controls the presence and default status of the &quot;media only&quot; restriction
+
-
in the search form. Possible values: on, off, on hidden, off hidden</p>
+
-
 
+
-
 
+
-
<b>mediahost</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>The host server for Image Class media files. The host server must be running DLXS middleware (or at least Image Class). Defaults to global configuration in imageclass.cfg.</p>
+
-
 
+
-
 
+
-
<b>numqs</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>number <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>The number of text fields to display in search form.</p>
+
-
 
+
-
 
+
-
<b>relviewmenu</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string <br>
+
-
 
+
-
<i>class: </i>image
+
-
 
+
-
<p>Related view menu. Set to &quot;on&quot; 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.: &quot;off&quot;.</p>
+
-
 
+
-
 
+
-
<b>relviewmenuinstruct</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>String of instruction text to precede the related view menu (relviewmenu).
+
-
e.g.: &quot;default&quot;.</p>
+
-
 
+
-
 
+
-
<b>relviewmenuprefx</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>String of text to precede <strong>each item</strong> in the related view menu (relviewmenu)
+
-
e.g.: &quot;default.&quot;</p>
+
-
 
+
-
 
+
-
<b>relviewmenuvals</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>image
+
-
             
+
-
<p>The SGML ISTRUCT attribute to use for display values in the related view menu (relviewmenu)</p>
+
-
             
+
-
<blockquote><p>e.g.: &quot;default&quot; (same as &quot;CAPTIONS&quot;).</p></blockquote>
+
-
 
+
-
<p>In addition to &quot;CAPTIONS&quot;, any of the ISTRUCT attribute names are valid (e.g., &quot;FACE&quot;).</p>
+
-
 
+
-
 
+
-
<b>resfldtrim</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>number<br>
+
-
<i>class: </i>image
+
-
 
+
-
<p><strong>Functionality currently disabled due to affects on well-formedness of XML.</strong> 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.: &quot;50&quot;.</p>
+
-
 
+
-
 
+
-
<b>reslistresflds</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>default or array <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>The list of fields (as abbreviations) to display in &quot;captions only &quot;
+
-
results view. To display all fields, enter the value &quot;default&quot;.</p>
+
-
 
+
-
 
+
-
<b>resultsviews</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>array <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>The list of results views to be made available to users. Legal values
+
-
are any combination of: thumbnail, thumbfull, reslist. Order is not important.
+
-
 
+
-
 
+
-
<b>resultsviewsdefault</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string </span><br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>The default result view. Legal values (choose one): thumbnail, thumbfull,
+
-
reslist</p>
+
-
 
+
-
 
+
-
<b>sortflds</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>array </span><br>
+
-
<i>class: </i>image, text, findaid
+
-
 
+
-
<p><b>Image:</b> The list of field abbreviations that should be provided as options for
+
-
sorting. Sort fields for multiple collections is configured in the groups
+
-
database. &quot;none&quot; must always be the first value. </p>
+
-
 
+
-
<p><b>Text:</b> The list of field abbreviations  that should be provided as options for
+
-
sorting. The possible values are &quot;occur&quot;, &quot;datea&quot;, &quot;dated&quot;,
+
-
&quot;author&quot;, &quot;title&quot;, &quot;freq&quot; which correspond to the pulldown menu
+
-
items: &quot;NONE&quot;, &quot;date ascending&quot; ,&quot;date descending&quot;,
+
-
&quot;author&quot;, &quot;title&quot; and &quot;frequency&quot;.  The menu items will appear in
+
-
the order listed in the collmgr field. </p>
+
-
     
+
-
<p><b>Finding Aids:</b> The list of field abbreviations  that should be provided as options for
+
-
sorting. The possible values are &quot;occur&quot;, &quot;title&quot;, &quot;creator&quot;, &quot;freq&quot; which correspond to the pulldown menu
+
-
items: &quot;NONE&quot;, &quot;title&quot;, &quot;creator&quot; and &quot;frequency&quot;.  The menu items will appear in
+
-
the order listed in the collmgr field. </p>
+
-
 
+
-
<p>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, &quot;Collected Works of Abraham Lincoln, Vol. 1&quot; published in 1953. If a single field (other than &quot;occur&quot;) is supplied the menu will display the single field and that sort will always be done.
+
-
              </p>
+
-
<p>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.
+
-
          </p>
+
-
           
+
-
 
+
-
<b>field_labels</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>default or array <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>Complete list of all field abbreviations with matching display labels. Must be in the form abbrev:::field label, one per line. Individual field labels may be overriden in any Collmgr field that includes abbreviations, allowing a field label to be changed for the context.. Dots "." are not allowed in the field abbreviation. If using XPAT, and If the SGML uses the dot character in field abbreviations, use underscore here. If there is a field combining all fields, be sure to include it.</p>
+
-
 
+
-
<p>Field labels are required, particularly since they are used to determine the legitimacy of a field in certain situations ( sorting, searching ).</p>
+
-
 
+
-
 
+
-
<b>field_xcoll_maps</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>default or array <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>For mapping collection specific fields to group or class level fields for cross collection searching. Form is xcoll_abbrev:::collabbrev. Each <strong>xcoll_abbrev</strong> starts a new line. Multiple <strong>collection abbreviations</strong> can be listed on a line with a single space between each. Cross collection fields can be arbitrarily added as long as they are added to the group Collmgr record or imageclass.cfg for class level configuration. If using XPAT, the mappings in the SGML must be included here as well.  If using MySQL, mappings only need to be here, and nowhere else. If there is a field that combine all fields, map it to ic_all. Every collection specific field in this list requires a full-text index if MySQL is used. <a target="_blank" href="../class/image/mysql.html">More info</a>.</p>
+
-
 
+
-
 
+
-
<b>field_load_maps</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>array<br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>Strictly used for loading data in to Image Class. The list of fields to be loaded from the source data file. List one fieldname per line. Spaces and forward-slashes should be changed to underscore in this field (no need to change the source data). Each field may be mapped to an alternative or abbreviated name. Form of the mapping is fieldname:::collabbrev. The established convention is to map each field to an abbreviation where the first part is the collid and the second part is an achronym of the imported field name. Once a field is mapped, the abbreviation must be used everywhere the field is referenced. <a target="_blank" href="../class/image/mysql.html">More info</a>.</p>
+
-
 
+
-
 
+
-
<b>field_admin_maps</b>
+
-
<i>required</i><br />
+
-
<i>value/format:</i>default or array </span><br />
+
-
<i>class: </i>image
+
-
<p>Required.</p>
+
-
 
+
-
<p>Mappings in field_admin_maps are used for data loading and/or access/middleware. It is essential to be familiar with data loading methods. <a target="_blank" href="../class/image/mysql.html">More info</a>.</p>
+
-
 
+
-
<p>For mapping collection specific fields to "administrative" fields.
+
-
Form is admin_abbrev:::collabbrev. Admin fields are <strong>ic_id</strong>, <strong>ic_fn</strong>, <strong>ic_vi</strong>, <strong>ic_all</strong>, <strong>ic_exact,
+
-
and ic_range (beta) </strong>.
+
-
Map ic_id to the field in the data_table containing record IDs.
+
-
Map ic_fn to the field in the data_table containing image/media
+
-
filenames.<strong>ic_exact</strong> is only used with MySQL collections,
+
-
and is optional. <strong>ic_exact</strong> forces a field to
+
-
be searched as a an exact phrase, and is intended for searching
+
-
fields that include data such as IDs that include characters
+
-
that are usually treated as spaces by MySQL.Map ic_fn to the
+
-
field(s) containing media file names. Map ic_vi to the field(s)
+
-
containing media captions. Map ic_all to the fields to be searched
+
-
as "Anywhere in record". See <a href="#range_srchflds"><strong>range_srchflds</strong></a> for help with <strong>ic_range</strong>. </p>
+
-
 
+
-
             
+
-
<b>thumbnailresflds</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>default or array <br>
+
-
<i>class: </i>image
+
-
 
+
-
<p>The list of fields (as abbreviations) to display in &quot;thumbnail with captions&quot;
+
-
results view. To display all fields, enter the value &quot;default&quot;.</p>
+
-
 
+
-
 
+
-
<b>bibsearch</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>array </span><br />
+
-
<i>class: </i>text
+
-
<p>The regions in which citation searches are conducted (minimally, citation).
+
-
</p>
+
-
 
+
-
 
+
-
<b>divheadrange</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>  number<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>A number indicating the deepest level of division encoding present in the collection.  Display of heads scoping KWICs and sections will go down to this number.  A collection my have divisions more deeply nested than this number but they will not be displayed.
+
-
For example, specify &quot;4&quot; if the lowest division to display is &lt;DIV4&gt;.</p>
+
-
 
+
-
 
+
-
<b>firstpublishedstart</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>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.</p>
+
-
 
+
-
 
+
-
<b>firstpublishedend</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>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.</p>
+
-
 
+
-
 
+
-
<b>firstpublishedinc</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>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.</p>
+
-
 
+
-
 
+
-
<b>fisheyethreshold</b>
+
-
<i>reserved for future use</i><br>
+
-
<i>value/format:</i><br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>Not currently used. </p>
+
-
 
+
-
 
+
-
<b>notemaxdivhead</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i> number<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>If collection contains notes this field must have a value greater than 0 otherwise it does not need to be set.  This is the number of the most deeply nested
+
-
division enclosing either a &lt;NOTE&gt; or the target of a &lt;PTR&gt;, e.g.
+
-
&quot;3&quot; if &lt;DIV3&gt; is the lowest division containing &lt;NOTE&gt; or the target
+
-
of a &lt;PTR&gt;.</p>
+
-
 
+
-
 
+
-
<b>qtytext</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>number <br>
+
-
<i>class: </i>text, findaid
+
-
 
+
-
<p><b>Text:</b> The number of DLPSTEXTCLASS regions in the collection. This is basically the number of text items in the collection.</p>
+
-
 
+
-
<p><b>FindAid:</b> The number of EAD regions  in the collection. This is basically the number of entire finding aids in the collection.</p>
+
-
 
+
-
 
+
-
<b>regionsearch</b>
+
-
<i>required</i><br >
+
-
<i>value/format:</i>array<br>
+
-
<i>class: </i>text, bib, findaid
+
-
 
+
-
<p>The regions which are retrieved for Boolean searches.  These values vary from class to class.
+
-
                </p>
+
-
 
+
-
 
+
-
<b>singlegender</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>'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.</p>
+
-
 
+
-
 
+
-
<b>singlegenre</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string </span><br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>'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.</p>
+
-
 
+
-
 
+
-
<b>singleperiod</b>
+
-
<i>optional</i><br />
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>'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.</p>
+
-
 
+
-
 
+
-
<b>sortthreshold</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i> number</span><br>
+
-
<i>class: </i>text, findaid, image
+
-
 
+
-
<p>Number of results above which results obtained from a search
+
-
are not sorted.(e.g. &quot;1000&quot;). Currently not used in BibClass which is configured globaly in the .cfg files.  Note that there is still a global setting for FindaidClass, TextClass and ImageClass in effect from their respective .cfg files when the results are across more than one collection.  </p>
+
-
 
+
-
 
+
-
<b>subclass</b>
+
-
<i>reserved for future use</i><br>
+
-
<i>value/format:</i><br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>Not currently used</p>
+
-
 
+
-
 
+
-
<span id="subclassmodule"><b>subclassmodule</b></span>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>bib, text, findaid
+
-
 
+
-
<p>The name of the subclass module (without the '.pm' suffix) that defines
+
-
the subclass of the TextClass, FindaidClass or BibClass object for the collection. </p>
+
-
 
+
-
<p>Many text collections will simply use the value &quot;TextClass&quot; and, likewise,
+
-
many bib and findaid collections will use the value &quot;BibClass.&quot; or &quot;FindaidClass&quot;, respectively. For others with a specific subclass, the convention is &quot;collidTC&quot; (&quot;collidBC&quot; for bib) corresponding to the file collidTC.pm or collidBC.pm. Similarly for FindaidClass. 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 &quot;TextClass/collidTC&quot;).  Similarly for FindaidClass.</p>
+
-
 
+
-
 
+
-
<b>appmodule</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>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 &quot;TextApp/FooTCApp&quot;.)
+
-
Image Class collections previously configured to use ImageApp/mysqlImageApp
+
-
must be changed to ImageApp. All Image Class collections should
+
-
have the value ImageApp.</p>
+
-
 
+
-
 
+
-
<b>pvappmodule</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>The module name (without .pm suffix) of the PVApp object or subclass
+
-
thereof supporting the pageviewer application for this collection. Use
+
-
&quot;PVApp&quot; unless a subclass has been written for this collection. (e.g., the subclass should be entered as &quot;PVApp/FooPVApp&quot;.)</p>
+
-
 
+
-
 
+
-
<b>termsearch</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>array<br>
+
-
<i>class: </i>text, bib findaid
+
-
 
+
-
<p>The regions in which simple searches are conducted, as they appear in the simple search pull-down menu.  Thes vary from class to class.</p>
+
-
 
+
-
 
+
-
<b>pageviewmodule</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i> string<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>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 &quot;PageView&quot; unless a subclass has been written for this collection.(e.g., subclass should be entered as &quot;PageView/FooPV&quot;.)</p>
+
-
 
+
-
 
+
-
<b>wwappmodule</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i> string<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>The module name (without .pm suffix) of the WWApp object or subclass
+
-
thereof supporting the wordwheel application for this collection. Use
+
-
&quot;WWApp&quot; unless a subclass has been written for this collection. (e.g., subclass should be entered as &quot;WWApp/FooWWApp&quot;.)</p>
+
-
 
+
-
 
+
-
<b>pageimages</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>Enter 1 if the collection has page images for viewing under page viewer, 0 otherwise.</p>
+
-
 
+
-
 
+
-
<b>pageviewselectvalues</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>array<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>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.</p>
+
-
 
+
-
 
+
-
<b>pdfchunk</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>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.</p>
+
-
 
+
-
 
+
-
<b>encodingtype</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string <br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>The encoding type of documents in the collection.  The possible values are &quot;monograph&quot;, &quot;serialissue&quot; or &quot;serialarticle&quot;.  A collection of encoding type &quot;monograph&quot; 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 &quot;serialissue&quot; 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 &quot;serialarticle&quot; is a single virtual or <i>born-digital</i> journal structured as a series of articles each of which has a HEADER and a TEXT region.
+
-
 
+
-
 
+
-
<b>detailviewtype</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>The type of the view used to display the detailed results for a single item in the result list.  The possible values are &quot;kwic&quot; or &quot;summary&quot;.  The &quot;kwic&quot; 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  &quot;summary&quot; 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, &quot;3 matches of dog in 5 of 20 poems&quot;.</p>
+
-
 
+
-
 
+
-
<b>detailviewlayout</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i>string<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>The layout of DIVs or PAGEs that scopes either the summary or KWIC as selected in the &quot;detailviewtype&quot; field above.  The possible values are &quot;breadcrumb&quot; or &quot;outline&quot;.  The &quot;outline&quot; 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 &quot;breadcrumb&quot; 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&gt;Europe&gt;France followed on the next line by the summary or KWIC display of hits within &quot;France&quot;.</p>
+
-
 
+
-
 
+
-
<b>printondemand</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string </span><br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>Toggles the existence of a &quot;order a reprint&quot; button that can appear on a bibliographic header/T.O.C. display. When field value is &quot;yes&quot; the link appears; if &quot;no&quot; the link does not appear.</p>
+
-
 
+
-
 
+
-
<b>hold</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>string. </span><br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>Used to restrict collections in release from moving to a production machine.
+
-
When field value is &quot;yes&quot; a collection is prevented from moving to production; when set to &quot;no&quot; the collection is not held. When hold is set to &quot;yes&quot; individual collection rows may not be moved to production.</p>
+
-
 
+
-
 
+
-
<b>groupdescr</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i> string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>A description of the group.</p>
+
-
 
+
-
<b>colldescr</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i> string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>A description of the collection. Not currently used by Image Class.</p>
+
-
 
+
-
 
+
-
<b>pvstoredformatprioritymap</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i> array<br>
+
-
<i>class: </i>text
+
-
               
+
-
<p>It is possible, within a single collection, that
+
-
some pages are available in one storage format while
+
-
others are only available in a different format.  This
+
-
field allows prioritization for these stored formats
+
-
on the basis of the user's requested view in the
+
-
Pageviewer application. Settings in this field
+
-
over-ride the default settings in lib/ItemView.cfg.
+
-
Each line of the field consists of a user requested
+
-
view value (&quot;image&quot; or &quot;pdf&quot;,
+
-
configured in the <a
+
-
href="#pageviewselectvalues">pageviewselectvalues</a>
+
-
field) separated by an &quot;=&quot; sign followed by
+
-
a list of image formats in priority order (tif jp2 sid
+
-
jpg etc.)</p>
+
-
 
+
-
<p>An example setting is: <br /><br />pdf=pdf tif<br />image=jp2 sid jpg tif</p>
+
-
 
+
-
<p>The field works in conjunction with the <a
+
-
href="#pvinputoutputmap">pvinputoutputmap</a> field to
+
-
choose the Pageviewer image handler needed to deliver a
+
-
final format to the browser.  </p>
+
-
 
+
-
             
+
-
<b>pvinputoutputmap</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i> array<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>This field specifies the mapping for a page image from the stored image format to the format to be delivered to the browser.  It selects the handler used to transform from the stored format on disk  to  format sent to the browser for display.  Settings in this field over-ride the default settings in lib/ItemView.cfg.  Each line of the field consists of a stored image format such as &quot;jp2&quot;, &quot;sid&quot;, &quot;jpg&quot;, &quot;tif&quot; or &quot;pdf&quot;, separated by an &quot;=&quot; sign followed by the desired delivery format. </p>
+
-
 
+
-
<p>An example setting is: <br /><br />sid=jpg<br />jp2=jpg<br />tif=gif</p>
+
-
<p>This works in conjunction with the <a href="#pvstoredformatprioritymap">pvstoredformatprioritymap</a> field.</p>
+
-
 
+
-
<i>optional</i><br>
+
-
<i>value/format:</i> array<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>This field specifies the mapping for a page image from the stored image format to the format to be delivered to the browser.  It selects the handler used to transform from the stored format on disk  to  format sent to the browser for display.  Settings in this field over-ride the default settings in lib/ItemView.cfg.  Each line of the field consists of a stored image format such as &quot;jp2&quot;, &quot;sid&quot;, &quot;jpg&quot;, &quot;tif&quot; or &quot;pdf&quot;, separated by an &quot;=&quot; sign followed by the desired delivery format. </p>
+
-
 
+
-
<p>An example setting is: <br /><br />sid=jpg<br />jp2=jpg<br />tif=gif</p>
+
-
<p>This works in conjunction with the <a href="#pvstoredformatprioritymap">pvstoredformatprioritymap</a> field.</p>
+
-
 
+
-
 
+
-
<b>displaynotesinline</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i> string<br>
+
-
<i>class: </i>text
+
-
 
+
-
<p>Set this field to &quot;yes&quot; to display &lt;NOTE1&gt; element content inline at the point of reference. Set this field to &quot;no&quot; to put a link to &lt;NOTE1&gt; element content at the point of reference. </p>
+
-
 
+
-
               
+
-
<b>browseupdatemodule</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i> string<br>
+
-
<i>class: </i>text, image, findaid
+
-
 
+
-
<p>This field specifies the name of the browse update Perl module.  The module files are located in <tt>DLXSROOT/bin/browse</tt>.  If a dynamic browse page is to be served this field must have a value.  The default behavior is available using one of the values BrowseUpdate/ImageMysqlBU and BrowseUpdate/FindaidBU for ImageClass and FindaidClass, respectively. The TextClass values depend on the encodingtype of the collection.  For monograph, serialissue or serialarticle the values are BrowseUpdate/MonographBU, BrowseUpdate/SerialIssueBU and BrowseUpdate/SerialArticleBU, respectively.  Newspapers are a specialization of the serialissue encoding type.  </p>
+
-
 
+
-
<p>This fields works in conjunction with the <a href="#browsefields">browsefields</a>, <a href="#browseable">browseable</a> and <a href="#browsenav">browsenav</a> fields.</p>
+
-
 
+
-
 
+
-
<b>browseable</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i> string<br>
+
-
<i>class: </i>text, image
+
-
 
+
-
<p>A &quot;yes&quot; (case-insensitive) value in this field enables the browse tab in the user interface.  If a file in the collection-specific web directory for this collection contains a file named &quot;browse.html&quot; that page will be served.  This supports static browse pages.  If &quot;browse.html&quot; is not present a dynamic browse page will be served based on data from the browse database.  When a dynamic browse page is served the <a href="#browsenav">browsenav</a> field value is consulted and must be defined. </p>
+
-
 
+
-
<p>This fields also works in conjunction with the <a href="#browsefields">browsefields</a> field.</p>
+
-
 
+
-
 
+
-
<b>browsenav</b></span></td>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i> number<br>
+
-
<i>class: </i>text, image
+
-
 
+
-
<p>This field must be defined if dynamic browsing is enabled via the <a href="#browseable">browseable</a>.  A value of 0, 1, or 2 should be supplied.  A value of 0 creates a single browse page will all items in the collection listed. A value of 1 creates a browse page with an alphabetic &quot;ruler&quot; at the top.  A value of 2 creates a browse page with a 2 level alphabetic &quot;ruler&quot; at the top where the first level is the first letter, A-Z and the second level consists of the selected first letter followed by the available second letters from the main entry for the item.  The value should be adjusted to provide optimal viewing of the number of items in the collection. </p>
+
-
 
+
-
<p>This field also works in conjunction with the <a href="#browsefields">browsefields</a> field.  It can be selectively over-ridden with a different value for a given field by using special syntax in the <a href="#browsefields">browsefields</a> field, which see.</p>
+
-
 
+
-
               
+
-
<b>browsefields</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i> array<br>
+
-
<i>class: </i>text, image
+
-
 
+
-
<p>This field specifies the fields on which the browse user interface is built.  Currently the &quot;title&quot;, &quot;subject&quot; and &quot;author&quot; fields are supported in Text Class. Image Class supports all fields. Only field values starting with a letter are currently browseable. </p>
+
-
 
+
-
<p>This works in conjunction with the <a href="#browseable">browseable</a> and <a href="#browsenav">browsenav</a> fields.</p>
+
-
 
+
-
<p>The <a href="#browsenav">browsenav</a> field specifies how many levels of an alphabetic ruler are shown.  This is a global setting.  For some collections, it may be preferable to selectively over-ride this global setting for one our more fields.  To over-ride the global <a href="#browsenav">browsenav</a> field value for a given item in the &quot;browsefields&quot; field assign a number between 0 and 2 inclusive using either an equal sign (=) or three consecutive colons (:::).  For example, to completely turn off the alphabetic ruler for subject browsing use subject=0.  </p>
+
-
 
+
-
 
+
-
<b>xsltpifillermodule</b></span></td>
+
-
<i>required</i><br>
+
-
<i>value/format:</i> string<br>
+
-
<i>class: </i>text, image, findaid
+
-
 
+
-
<p>The name of the subclass of the XsltPIFiller module that defines
+
-
the PI Filler for the application. </p>
+
-
 
+
-
<p>Most TextClass collections will simply use the value &quot;TextAppXsltPIFiller&quot;. Similarly for ImageApp and FindaidApp, using the same naming convention.  A collection or group of collections may require a specific subclass to be written.  Then the convention is (e.g. for TextApp) &quot;TextAppXsltPIFiller/SubclassTextAppXsltPIFiller&quot;where &quot;Subclass&quot; is the specific name you have given to the subclass.</p>
+
-
 
+
-
 
+
-
<b>devhost</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i> string<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>The name of the machine hosting the XPAT search engine, data and indexes.  If defined here the value takes precedence over the value of <a href="#host">host</a>. </p>
+
-
 
+
-
 
+
-
<b>containerdepth</b>
+
-
<i>required</i><br>
+
-
<i>value/format: number</i><br>
+
-
<i>class: </i>findaid
+
-
 
+
-
<p>A number indicating the deepest level of contents list encoding present in the collection,
+
-
e.g. &quot;4&quot; if the lowest container is &lt;C04&gt;</p>
+
-
 
+
-
 
+
-
<b>sortpriority</b>
+
-
<i>required</i><br>
+
-
<i>value/format:</i> number<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>A number indicating the relative priority of this group when sorting the names of the groups for display in the user interface.  Numbers should be assigned to all groups to determine their sorting order.</p>
+
-
 
+
-
 
+
-
<b>authsystems</b>
+
-
<i>required</i><br>
+
-
<i>value/format: array</i><br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>One or more values specifying the authentication and authorization system supported for collection-level access for this collection.  Possible values are &quot;um&quot; and &quot;athens&quot;, currently. At least one of these values must appear.  The &quot;um&quot; value indicates default authentication and authorization handling.  In this system, the REMOTE_USER, AUTHZD_COLL and PUBLIC_COLL environment variables must be set entirely by an external system and are simply read by the middleware to identify the authenticated user and the authorized and public collection IDs, respectively.  To turn off login links in the user interface and to depend entirely on HTTP Basic Auth, set the $LibGlobals::gAuthenticationEnabled in DLXSROOT/lib/LibGlobals.cfg to zero (0). </p>
+
-
 
+
-
 
+
-
<b>ignoreon</b>
+
-
<i>optional</i><br>
+
-
<i>value/format:</i>array<br>
+
-
<i>class: </i>all
+
-
 
+
-
<p>The name or names of the virtual hosts you do not want this collection 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 &quot;all&quot; which will ignore the collection 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.</p>
+
-
 
+
-
[[#top|Top]]
+

Current revision

Main Page > Working with DLXS Components > Collection Manager Field Descriptions

Collmgr Field Descriptions (current version)

Retrieved from "http://webservices.itcs.umich.edu/mediawiki/dlxs15/index.php/Collection_Manager_Field_Descriptions"
Personal tools