Mounting a Finding Aids Collection

From DLXS Documentation

(Difference between revisions)
Jump to: navigation, search
Current revision (21:58, 1 July 2008) (edit) (undo)
(→Examples of Findaid Class Implementations and Practices)
 
(13 intermediate revisions not shown.)
Line 5: Line 5:
Workshop materials are located at http://www.dlxs.org/training/workshop200707/findaidclass/fcoutline.html
Workshop materials are located at http://www.dlxs.org/training/workshop200707/findaidclass/fcoutline.html
- 
==Overview==
==Overview==
 +
The Finding Aids Class is in many ways similar in behavior to Text Class. Access minimally includes full text searching across collections or within a particular collection of Finding Aids, viewing Finding Aids in a variety of display formats, and creation of personal collections ("bookbag") of Finding Aids.
 +
To mount a Finding Aids Collection, you will need to complete the following steps:
To mount a Finding Aids Collection, you will need to complete the following steps:
-
# [[#Preparing_Data_and_Directories | Prepare your data and set up a directory structure]]
 
-
# [[#Validating_and_Normalizing_Your_Data| Validate and normalize your data]]
 
-
# [[#Building_the_Index |Build the Index]]
 
-
# [[#Mounting_the_Collection_Online |Mount the collection online]]
 
 +
# [[Preparing_Data and Directories|Prepare your data and set up a directory structure]]
 +
# [[Finding_Aids_Data_Preparation#Validating_and_Normalizing_Your_Data| Validate and normalize your data]]
 +
# [[Building the Index |Build the Index]]
 +
# [[Mounting the Collection Online|Mount the collection online]]
 +
 +
===[[Findaid Class Behaviors Overview]]===
-
===Examples of Findaid Class implementations and practices===
+
This section describes the basic Findaid Class behaviors.
-
This section contains links to public implementations of DLXS Findaid Class as well as documentation on workflow and implementation issues. If you are a member of DLXS and have a collection or resource you would like to add, or wish to add more information about your collection, please edit this page.
+
===Examples of Findaid Class Implementations and Practices===
-
;[http://bentley.umich.edu/EAD/index.html University of Michigan, Bentley Historical Library Finding Aids]
+
This section contains links to public implementations of DLXS Findaid Class as well as documentation on workflow and implementation issues. If you are a member of DLXS and have a collection or resource you would like to add, or wish to add more information about your collection, please edit this section.
 +
 
 +
;[http://bentley.umich.edu/EAD/index.php University of Michigan, Bentley Historical Library Finding Aids]
: Out-of-the-box DLXS 13 implementation.
: Out-of-the-box DLXS 13 implementation.
-
;[http://bentley.umich.edu/EAD/eadproj.htm Overview of Bentley's workflow process for Finding Aids ]
+
;[http://bentley.umich.edu/EAD/eadproject.php Overview of Bentley's workflow process for Finding Aids ]
:See also the links in [[#Practical_EAD_Encoding_Issues | Practical EAD Encoding Issues]] for background on the Bentley EAD workflow and encoding practices
:See also the links in [[#Practical_EAD_Encoding_Issues | Practical EAD Encoding Issues]] for background on the Bentley EAD workflow and encoding practices
Line 46: Line 51:
;[http://archives.getty.edu:8082/cgi/f/findaid/findaid-idx?cc=iastaff;c=iastaff;tpl=browse.tpl J. Paul Getty Trust Institutional Archives Finding Aids]
;[http://archives.getty.edu:8082/cgi/f/findaid/findaid-idx?cc=iastaff;c=iastaff;tpl=browse.tpl J. Paul Getty Trust Institutional Archives Finding Aids]
:Heavily customized DLXS11a.
:Heavily customized DLXS11a.
- 
-
===Overview of Data Preparation and Indexing Steps===
 
- 
-
'''Data Preparation'''
 
- 
-
# [[#dataprep_step1|Validate the files individually]] against the EAD ''2002'' DTD<br />'''make validateeach'''<br />
 
-
# [[#dataprep_step2|Concatenate the files into one larger XML file]]<br />'''make prepdocs'''<br />
 
-
# [[#dataprep_step3| Validate the concatenated file against the ''dlxsead2002'' DTD]]:<br />'''make validate'''<br />
 
-
# [[#dataprep_step4| Normalize the concatenated file.]]<br />'''make norm'''<br />
 
-
# [[#dataprep_step5| Validate the normalized concatenated file against the ''dlxsead2002'' DTD]]<br />'''make validate'''<br />
 
- 
-
The end result of these steps is a file containing the concatenated EADs wrapped in a &lt;COLL&gt; element which validates against the dlxsead2002 and is ready for indexing:
 
- 
-
&lt;COLL&gt;<br />&lt;ead&gt;&lt;eadheader&gt;&lt;eadid&gt;1&lt;/eadid&gt;...&lt;/eadheader&gt;... content&lt;/ead&gt;<br />&lt;ead&gt;&lt;eadheader&gt;&lt;eadid&gt;2&lt;/eadid&gt;...&lt;/eadheader&gt;... content&lt;/ead&gt;<br />&lt;ead&gt;&lt;eadheader&gt;&lt;eadid&gt;3&lt;/eadid&gt;...&lt;/eadheader&gt;... content&lt;/ead&gt;<br />&lt;/COLL&gt;
 
-
 
- 
-
'''WARNING!''' If there are extra characters or some other problem with the part of the program that strips out the xml declaration and the doctype declaration the file will end up like:
 
- 
-
 
-
&lt;COLL&gt;<br />baddata&lt;ead&gt;&lt;eadheader&gt;&lt;eadid&gt;1&lt;/eadid&gt;...&lt;/eadheader&gt;... content&lt;/ead&gt;<br />baddata&lt;ead&gt;&lt;eadheader&gt;&lt;eadid&gt;2&lt;/eadid&gt;...&lt;/eadheader&gt;... content&lt;/ead&gt;<br />baddata&lt;ead&gt;&lt;eadheader&gt;&lt;eadid&gt;3&lt;/eadid&gt;...&lt;/eadheader&gt;... content&lt;/ead&gt;<br />&lt;/COLL&gt;
 
- 
-
In this case you will get "character data not allowed" or similar errors during the make validate step. You can troubleshoot by looking at the concatenated file and/or checking your original EADs.
 
- 
-
'''Indexing'''
 
- 
-
# '''make singledd''' indexes words for texts that have been concatenated into on large file for a collection.
 
-
# '''make xml''' indexes the XML structure by reading the DTD. Validates as it indexes.
 
-
# '''make post''' builds and indexes fabricated regions based on the XPAT queries stored in the workshopfa.extra.srch file.
 
==[[Working with the EAD]]==
==[[Working with the EAD]]==
- 
- 
-
==[[Findaid Class Behaviors Overview]]==
 
==[[Preparing Data and Directories]]==
==[[Preparing Data and Directories]]==
- 
- 
==[[Finding Aids Data Preparation]]==
==[[Finding Aids Data Preparation]]==
- 
==[[Building the Index]]==
==[[Building the Index]]==
- 
==[[Working with Fabricated Regions in Findaid Class]]==
==[[Working with Fabricated Regions in Findaid Class]]==
-
 
+
==[[Customizing Findaid Class]]==
-
==Customizing Findaid Class ==
+
-
===Working with the table of contents===
+
-
 
+
-
The table of contents on the left-hand side of the finding aid display is based on fabricated regions set up in *.extra.srch and configured either in a configuration file or in a subclass of FindaidClass.pm
+
-
 
+
-
If a subclass is not being used to override the FindaidClass::_initialize method, the configuration file will be used. It is:
+
-
 
+
-
$DLXSROOT/cgi/f/findaidclass/findaidclass.cfg
+
-
 
+
-
The configuration file sets up a hash called %gSectHeadsHash. The relevant section of the findaidclass.cfg file is:
+
-
 
+
-
# **********************************************************************
+
-
# Hash of section heads that XPAT should search for. A reference to
+
-
# this hash is added as member data keyed by 'tocheads' to the
+
-
# FindaidClass object at initialization time. Comment out those that
+
-
# are missing in your finding aids.
+
-
# **********************************************************************
+
-
%gSectHeadsHash = (
+
-
'bioghist-t' => {
+
-
'collection' => qq{Biography},
+
-
'recordgrp' => qq{History},
+
-
},
+
-
'controlaccess-t' => qq{Subject Terms},
+
-
'frontmatter-t' => qq{Title Page},
+
-
'arrangement-t' => qq{Arrangement},
+
-
'scopecontent-t' => qq{Collection Scope and Content Note},
+
-
'summaryinfo-t' => qq{Summary Information},
+
-
'contentslist-t' => qq{Contents List},
+
-
'admininfo-t' => qq{Access and Use},
+
-
'add-t' => qq{Additional Descriptive Data},
+
-
);
+
-
 
+
-
 
+
-
The %gSectHeadsHash is normally loaded read from the configuration file and loaded into a hash called tocheads in the FindaidClass::_initialize method when the FindaidClass object is created. If you wish to change the table of contents on a collection-specific basis, you can override the FindaidClass::_initialize method in a collection-specific subclass.
+
-
 
+
-
For an example of using a subclass to override the default table of contents see:
+
-
$DLXSROOT/cgi/f/findaid/FindaidClass/[[SamplefaFC.pm]]
+
-
 
+
-
 
+
-
 
+
-
Note that the default setting in the Collection Manager for the samplefa collection is to use this subclass:
+
-
 
+
-
[[Image:Samplefa collmgr subclass.png | image of CollMgr setting for subclass of Findaid Class]]
+
-
 
+
-
 
+
-
 
+
-
The diagram below shows the fabricated region and the corresponding EAD element tags for the out-of-the-box table of contents
+
-
 
+
-
[[Image:Tochead2.jpg]]
+
-
 
+
-
====Changing the labels in the table of contents====
+
-
If you want to change the labels for all of your Findaid Class collections, you can change the strings in the %gSectHeadsHash hash in $DLXSROOT/cgi/f/findaid/findaidclass.cfg. If you want to change the labels on a collection by collection basis, you will probably want to subclass and override the FindaidClass::_initialize method as is done in the sample file: $DLXSROOT/cgi/f/findaid/FindaidClass/[[SamplefaFC.pm]]
+
-
 
+
-
====Adding sections to the table of contents ====
+
-
 
+
-
====Changing the Bioghist labels to use the appropriate <head> elemements====
+
==[[Mounting the Collection Online]]==
==[[Mounting the Collection Online]]==
 +
==[[Troubleshooting Finding Aids]]==
-
 
+
==[[Linking from Finding Aids Using ID Resolver]]==
-
==Troubleshooting==
+
-
 
+
-
===General Techniques===
+
-
===Common Problems and Solutions===
+
-
 
+
-
====Title of Finding Aid does not show up====
+
-
 
+
-
This is usually caused by the <origination> preceding the <unittitle> in the top level <did> element of your EAD
+
-
 
+
-
In the *.extra.srch file
+
-
 
+
-
 
+
-
comment out the following line:
+
-
 
+
-
''(note that the region definitions are all on one line, but have been wrapped so they will be readable in the wiki)''
+
-
 
+
-
 
+
-
##
+
-
((region "<origination".."</unittitle>")
+
-
within ((region did within region archdesc)
+
-
not within region dsc));
+
-
{exportfile "/l1/release/13/idx/s/samplefa/maintitle.rgn"};
+
-
export; ~sync "maintitle";
+
-
##
+
-
 
+
-
copy the line but reverse the order of unittitle and origination
+
-
 
+
-
##
+
-
((region "<unittitle".."</origination>")
+
-
within ((region did within region archdesc)
+
-
not within region dsc));
+
-
{exportfile "/l1/release/13/idx/s/samplefa/maintitle.rgn"};
+
-
export; ~sync "maintitle";
+
-
##
+
-
 
+
-
 
+
-
 
+
-
* make post errors
+
-
** x
+
-
** y
+
-
 
+
-
See also
+
-
* [[#Customizing_Findaid_Class | Customizing Findaid Class]]
+
-
* [[Working_with_Fabricated_Regions_in_Findaid_Class |Working with Fabricated Regions in Findaid Class ]]
+
-
 
+
-
==Linking from Finding Aids Using ID Resolver==
+
-
 
+
-
How do you do this?
+
-
 
+
-
Findaid Class is coded so that if there is an href attribute to the &lt;dao&gt; element, it will check to see if it contains the string "http". If it does, FindaidClass will not us ID Resolver, but will create a link based on the content of the href attribute of the &lt;dao&gt;. If there is no "http" string in the href attribute, FindaidClass assumes that the href attribute is actully an id and will look up that id in in the idresolver and build a link if it finds the ID in the IDRESOLVER table. The method FilterAllDaos_XML in $DLXSROOT/cgi/f/findaid/FindaidClass.pm can be overridden per collection if different behavior is needed.
+
-
 
+
-
If you decide to use this feature, you will want to modify the preprocessing script preparedocs.pl which out-of-the-box inserts the string 'dao-bhl-' after the href. Below is an example of a Bentley &lt;dao&gt; where the id number is 91153-1.
+
-
 
+
-
&lt;dao linktype="simple" href="91153-1" show="new" actuate="onrequest"&gt;<br /> &lt;daodesc&gt;<br /> &lt;p&gt;[view selected images]&lt;/p&gt;<br /> &lt;/daodesc&gt;<br /> &lt;/dao&gt;
+
-
 
+
-
The preparedocs.pl program would change this to:
+
-
 
+
-
&lt;dao linktype="simple" href="dao-bhl-91153-1" show="new" actuate="onrequest"&gt;<br /> &lt;daodesc&gt;<br /> &lt;p&gt;[view selected images]&lt;/p&gt;<br /> &lt;/daodesc&gt;<br /> &lt;/dao&gt;
+
-
 
+
-
The ID resolver would look up the id "dao-bhl-91153-1" and replace it with the appropriate URL.
+
-
 
+
-
<font color="#0000A0">ID Resolver Data Transformation and Deployment</font>
+
-
 
+
-
The ID Resolver is a CGI that takes as input a unique identifier and returns a URI. It is used, for example, by Harper's Weekly to link the text pages in Text Class middleware to the image pages in the Image Class middleware, and vice versa.
+
-
 
+
-
Plug something like the following in to your web browser and you should get something back. If you choose to test middleware on a development machine that uses the id resolver, make sure that the middleware on that machine is calling the resolver on the machine with the data, and not the resolver on the production server.
+
-
 
+
-
* [http://clamato.umdl.umich.edu/cgi/i/idresolver/idresolver?id=dao-bhl-bl000684 http://clamato.hti.umich.edu/cgi/i/idresolver/idresolver?id=dao-bhl-bl000684]
+
-
* which should yield...<br /><code>'''&lt;ITEM MTIME="20030728142225"&gt;&lt;ID&gt;dao-bhl-bl000684 &lt;/ID&gt;&lt;URI&gt;http://images.umdl.umich.edu/cgi/i/image/image-idx?&amp;q1=bl000684&amp;rgn1=bhl_href&amp;type=boolean&amp;med=1&amp;view=thumbnail&amp;c=bhl &lt;/URI&gt;&lt;/ITEM&gt;'''</code>
+
-
 
+
-
[http://www.dlxs.org/docs/13/ancil/idresolver.html Information on how to set up the ID resolver]
+
-
 
+
-
</blockquote>
+
==[http://www.dlxs.org/training/workshop200707/findaidclass/fcoutline.html Workshop Materials]==
==[http://www.dlxs.org/training/workshop200707/findaidclass/fcoutline.html Workshop Materials]==
Line 233: Line 75:
General user interface customizations, such as changing rendering style (CSS) or making changes to the XSL are covered in [[Customizing the User Interface]]. Specific user-interface issues related to Findaid Class are discussed in the following sections:
General user interface customizations, such as changing rendering style (CSS) or making changes to the XSL are covered in [[Customizing the User Interface]]. Specific user-interface issues related to Findaid Class are discussed in the following sections:
-
# [[#Customizing_Findaid_Class |Customizing Findaid Class]]
+
* [[Customizing Findaid Class]]
-
## [[#Working_with_the_table_of_contents | Working with the table of contents]]
+
** [[Customizing Findaid Class#Working_with_the_table_of_contents |Working with the table of contents]]
-
# [[#Working_with_Fabricated_Regions_in_Findaid_Class |Working with Fabricated Regions in Findaid Class]]
+
* [[Working with Fabricated Regions in Findaid Class]]
-
# [[#Common_Problems_and_Solutions |Common Problems and Solutions]]
+
* [[Troubleshooting Finding Aids#Common_Problems_and_Solutions |Common Problems and Solutions]]
-
## [[#Title_of_Finding_Aid_does_not_show_up |Title of Finding Aid does not show up]]
+
** [[Troubleshooting Finding Aids#Title_of_Finding_Aid_does_not_show_up |Title of Finding Aid does not show up]]
-
 
+
-
 
+
-
 
+
===[[Findaid Class Graphics Files]]===
===[[Findaid Class Graphics Files]]===
Line 246: Line 85:
===[[Findaid Class Processing Instructions]]===
===[[Findaid Class Processing Instructions]]===
-
We decided that we could not maintain a list of class specific processing instructions so this section should probably be cut.
+
These are some current processing instructions for Finding Aids Class, but the DLXS group will not maintain this section.
-
 
+
-
 
+
-
 
+
[[#top|Top]]
[[#top|Top]]

Current revision

Main Page > Mounting Collections: Class-specific Steps > Mounting a Finding Aids Collection

This topic describes how to mount a Findaid Class collection.

Workshop materials are located at http://www.dlxs.org/training/workshop200707/findaidclass/fcoutline.html

Contents

[edit] Overview

The Finding Aids Class is in many ways similar in behavior to Text Class. Access minimally includes full text searching across collections or within a particular collection of Finding Aids, viewing Finding Aids in a variety of display formats, and creation of personal collections ("bookbag") of Finding Aids.

To mount a Finding Aids Collection, you will need to complete the following steps:

  1. Prepare your data and set up a directory structure
  2. Validate and normalize your data
  3. Build the Index
  4. Mount the collection online

[edit] Findaid Class Behaviors Overview

This section describes the basic Findaid Class behaviors.

[edit] Examples of Findaid Class Implementations and Practices

This section contains links to public implementations of DLXS Findaid Class as well as documentation on workflow and implementation issues. If you are a member of DLXS and have a collection or resource you would like to add, or wish to add more information about your collection, please edit this section.

University of Michigan, Bentley Historical Library Finding Aids
Out-of-the-box DLXS 13 implementation.
Overview of Bentley's workflow process for Finding Aids
See also the links in Practical EAD Encoding Issues for background on the Bentley EAD workflow and encoding practices
Unversity of Tennesee Special Collections Libraries
DLXS Findaid Class version ?
University of Pittsburgh, Historic Pittsburgh Finding Aids
DLXS Findaid Class version ?
Background on Pittsburgh Finding Aids workflow
University of Wisconsin, Archival Resources in Wisconsin: Descriptive Finding Aids
DLXS Findaid Class version ?
University of Minnesota Libraries, Online Finding Aids
DLXS Findaid Class version ?
EAD Implementation at the University of Minnesota
Getty Research Institute Special Collections Finding Aids
Heavily customized DLXS11a. Background on Getty customization and user interface changes to DLXS
J. Paul Getty Trust Institutional Archives Finding Aids
Heavily customized DLXS11a.

[edit] Working with the EAD

[edit] Preparing Data and Directories

[edit] Finding Aids Data Preparation

[edit] Building the Index

[edit] Working with Fabricated Regions in Findaid Class

[edit] Customizing Findaid Class

[edit] Mounting the Collection Online

[edit] Troubleshooting Finding Aids

[edit] Linking from Finding Aids Using ID Resolver

[edit] Workshop Materials

[edit] Working with the User Interface

General user interface customizations, such as changing rendering style (CSS) or making changes to the XSL are covered in Customizing the User Interface. Specific user-interface issues related to Findaid Class are discussed in the following sections:

[edit] Findaid Class Graphics Files

Are there findaid class specific graphics files? The existing html docs actually point to a ../t/text/ directory and it appears that the graphics are generic and not at all specific to findaid class.

[edit] Findaid Class Processing Instructions

These are some current processing instructions for Finding Aids Class, but the DLXS group will not maintain this section.

Top

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