Mounting a Finding Aids Collection

From DLXS Documentation

(Difference between revisions)

Jump to: navigation, search

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

1 Overview
- 1.1 Findaid Class Behaviors Overview
- 1.2 Examples of Findaid Class Implementations and Practices
2 Working with the EAD
3 Preparing Data and Directories
4 Finding Aids Data Preparation
5 Building the Index
6 Working with Fabricated Regions in Findaid Class
7 Customizing Findaid Class
8 Mounting the Collection Online
9 Troubleshooting Finding Aids
10 Linking from Finding Aids Using ID Resolver
11 Workshop Materials
12 Working with the User Interface
- 12.1 Findaid Class Graphics Files
- 12.2 Findaid Class Processing Instructions

[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:

[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"

@@ Line 4: / Line 4: @@
 This topic describes how to mount a Findaid Class collection.
-Workshop materials are located [[Workshop Materials:Finding Aids|here.]]
+Workshop materials are located at http://www.dlxs.org/training/workshop200707/findaidclass/fcoutline.html
 ==Overview==
-===Examples===
+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.
-===Overview of Data Preparation and Indexing Steps===
-'''Data Preparation'''
+To mount a Finding Aids Collection, you will need to complete the following steps:
-# [#DataPrepStep1 validating the files individually] against the EAD ''2002'' DTD<br />'''make validateeach'''<br />
+# [[Preparing_Data and Directories|Prepare your data and set up a directory structure]]
-# [#DataPrepStep2 concatenating the files into one larger XML file]<br />'''make prepdocs'''<br />
+# [[Finding_Aids_Data_Preparation#Validating_and_Normalizing_Your_Data| Validate and normalize your data]]
-# [#DataPrepStep3 validating the concatenated file] against the ''dlxsead2002'' DTD:<br />'''make validate'''<br />
+# [[Building the Index |Build the Index]]
-# [#DataPrepStep4 "normalizing" the concatenated file.]<br />'''make norm'''<br />
+# [[Mounting the Collection Online|Mount the collection online]]
-# [#DataPrepStep5 validating 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:
+===[[Findaid Class Behaviors Overview]]===
- &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;
+This section describes the basic Findaid Class behaviors.
-'''WARNING!'''    If are extra characters or some other problem with the part of the program that strips out the xml declaration and the docytype declearation the file will end up like:
+===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.
- &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.
+;[http://bentley.umich.edu/EAD/index.php University of Michigan, Bentley Historical Library Finding Aids]
+: Out-of-the-box DLXS 13 implementation.
+;[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
-'''Indexing'''
+;[http://dlc.lib.utk.edu/f/fa/ Unversity of Tennesee Special Collections Libraries]
+: DLXS Findaid Class version ?
-# '''make singledd''' indexes words for texts that have been concatenated into on large file for a collection. This is the recommended process.
+;[http://digital.library.pitt.edu/ead/ University of Pittsburgh, Historic Pittsburgh Finding Aids]
-# '''make xml''' indexes the XML structure by reading the DTD. Validates as it indexes.
+:DLXS Findaid Class version ?
-# '''make post''' builds and indexes fabricated regions based on the XPAT queries stored in the workshopfa.extra.srch file.
+;[http://digital.library.pitt.edu/ead/aboutead.html Background on Pittsburgh Finding Aids workflow]
+:
-==Working with the EAD==
+;[http://digicoll.library.wisc.edu/wiarchives University of Wisconsin, Archival Resources in Wisconsin: Descriptive Finding Aids]
-=== EAD 2002 DTD Overview ===
+:DLXS Findaid Class version ?
-These instructions assume that you have already encoded your finding aids files in the XML-based [http://www.loc.gov/ead/ EAD 2002 DTD]. If you have finding aids encoded using the older EAD 1.0 standard or are using the SGML version of EAD2002, you will need to convert your files to the XML version of EAD2002.   When converting from SGML to XML a number of character set issues may arise.  These are pretty much the same issues that were described for text class see [../conversion/index.html Data Conversion: Unicode, XML, and Normalization] .
+;[http://discover.lib.umn.edu/findaid University of Minnesota Libraries, Online Finding Aids]
+:DLXS Findaid Class version ?
-Resources for converting from EAD 1.0 to EAD2002 and/or from SGML EAD to XML EAD are available from:
+;[https://wiki.lib.umn.edu/Staff/FindingAidsInEAD/ EAD Implementation at the University of Minnesota]
+:
-* The Society of American Archivists EAD Tools page:http://www.archivists.org/saagroups/ead/tools.html
+;[http://archives.getty.edu:8082/cgi/f/findaid/findaid-idx?cc=utf8a;c=utf8a;tpl=browse.tpl Getty Research Institute Special Collections Finding Aids]
-* Library of Congress EAD conversion toolshttp://lcweb2.loc.gov/music/eadmusic/eadconv12/ead2002_r.html
+: Heavily customized DLXS11a.  [http://library.pub.getty.edu:8100/DLXS06.html Background on Getty customization and user interface changes to DLXS]
-Other good sources of information about EAD encoding practices and practical issues involved with EADs are:
+;[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.
-* Library of Congress EAD page http://www.loc.gov/ead/ (This is the home of the EAD standard
+==[[Working with the EAD]]==
-* EAD2002 tag library http://www.loc.gov/ead/tglib/index.html
-* The Society of American Archivists EAD Help page: http://www.archivists.org/saagroups/ead/
-* Various EAD Best Practice Guidelines listed on the Society of American Archivists EAD essentials page: [http://www.archivists.org/saagroups/ead/ http://www.archivists.org/saagroups/ead/essentials.html] (the links to BPGs are at the bottom of the page)
-* The EAD listserv http://listserv.loc.gov/listarch/ead.html
-The EAD standard was designed as a ´loose¡ standard in order to accommodate the large variety in local practices for paper finding aids and make it easy for archives to convert from paper to electronic form.  As a result, conformance with the EAD standard still allows a great deal of variety in encoding practices.
+==[[Preparing Data and Directories]]==
-The DLXS software is primarily designed as a system for mounting University of Michigan collections.  In the case of finding aids, the software has been designed to accommodate the encoding practices of the Bentley Historical Library. The more similar your data and setup is to the Bentley’s, the easier is will be to integrate your finding aids collection with DLXS.  If your practices differ significantly from the Bentley’s, you will probably need to do some preprocessing of your files and/or modifications to various files in DLXS.  We have found that the largest number of issues in implementing Findaid Class for member institutions is dealing with differences in encoding practices. We will cover various issues that commonly arise.
+==[[Finding Aids Data Preparation]]==
-More information on the Bentley's encoding practices and workflow:
+==[[Building the Index]]==
-* Overview of Bentley's workflow process for Finding Aids http://bentley.umich.edu/EAD/eadproj.htm
+==[[Working with Fabricated Regions in Findaid Class]]==
-* Description of Bentley Finding Aids and their presentation on the web http://bentley.umich.edu/EAD/findaids.htm
-* Bentley MS Word EAD templates and macros http://bentley.umich.edu/EAD/bhlfiles.htm
-* Description of EAD tags used in Bentley EADs http://bentley.umich.edu/EAD/bhltags.htm
-----
+==[[Customizing Findaid Class]]==
+==[[Mounting the Collection Online]]==
+==[[Troubleshooting Finding Aids]]==
+==[[Linking from Finding Aids Using ID Resolver]]==
+==[http://www.dlxs.org/training/workshop200707/findaidclass/fcoutline.html Workshop Materials]==
-==[[Findaid Class Behaviors Overview]]==
-==Preparing Data and Directories==
-===Character Issues===
-===Encoding Issues===
-==Validating and Normalizing Your Data==
-==Building the Index==
-==Working with Fabricated Regions==
-==Modifying Findaid Class Files==
-==Mounting the Collection Online==
-==Troubleshooting==
-==Linking from Finding Aids Using ID Resolver==
-==Workshop materials==
 ==Working with the User Interface==
-===[[Findaid Class Graphics Files]]===
-===[[Findaid Class Processing Instructions]]===
+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#Working_with_the_table_of_contents |Working with the table of contents]]
+* [[Working with Fabricated Regions in Findaid Class]]
+* [[Troubleshooting Finding Aids#Common_Problems_and_Solutions |Common Problems and Solutions]]
+** [[Troubleshooting Finding Aids#Title_of_Finding_Aid_does_not_show_up |Title of Finding Aid does not show up]]
+===[[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.
+===[[Findaid Class Processing Instructions]]===
+These are some current processing instructions for Finding Aids Class, but the DLXS group will not maintain this section.
 [[#top|Top]]