Mounting a Finding Aids Collection

From DLXS Documentation

(Difference between revisions)
Jump to: navigation, search
m
Current revision (21:58, 1 July 2008) (edit) (undo)
(→Examples of Findaid Class Implementations and Practices)
 
(336 intermediate revisions not shown.)
Line 1: Line 1:
-
==Mounting a Finding Aids Collection==
+
[[DLXS Wiki|Main Page]] > [[Mounting Collections: Class-specific Steps]] > Mounting a Finding Aids Collection
 +
<hr>
-
These instructions assume that you have already encoded your finding aids files in the XML-based EAD 2002 DTD. Only you, after looking at your texts and your encoding practices, can do the intellectual work required to encode your finding aids in XML using the EAD 2002 DTD. While DLPS does not have any quick and easy tools for this stage of data preparation, we do have a recommended model: 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. DLXS does not support the process of creating new finding aids files: how you do this is you to you. The Bentley Historical Library, however, provides a discussion of some specific tools and a workflow process you might use to create these files.
+
This topic describes how to mount a Findaid Class collection.
 +
Workshop materials are located at http://www.dlxs.org/training/workshop200707/findaidclass/fcoutline.html
-
=== Findaid Class and Behaviors 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:
-
The Findaid Class consists of EAD2002-encoded Finding Aids. You can learn more about the ead2002 DTD and ead2002 in general at the Library of Congress ead2002 web site. The Findaid Class relies on a single XML Document Type Definition (DTD) file to deliver all collections in the class. This file is essentially identical to the ead2002 DTD with one extra wrapping element added. DLXS then uses XPAT to index the XML and the Findaid Class middleware makes it possible for users to search the resources on the web.
+
# [[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]]
-
The behavior of the Finding Aids Class is similar in many ways to that of 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 the creation of personal collections (a “bookbag”) of Finding Aids.
+
===[[Findaid Class Behaviors Overview]]===
-
The general characteristics of the Finding Aids class are the following:
+
-
*Allows search and retrieval of ead2002-endcoded Finding Aids and portions thereof
+
-
*Allows searching across multiple collections of Finding Aids simultaneously
+
-
*Allows searching of each collection independently
+
-
*Allows bookmarking of individual Finding Aids
+
-
*Requires minimal administrative data
+
-
*Uses a single data model and shared middleware for all collections in the system
+
-
*Permits access restrictions at the collection level
+
-
The Finding Aids class provides no functionality for creating and managing electronic texts in SGML.
+
This section describes the basic Findaid Class behaviors.
-
=== Findaid Class Behaviors ===
+
===Examples of Findaid Class Implementations and Practices===
-
The Findaid Class is typically used for either campus or public access. Its behaviors include the following:
+
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.
-
*Cross-collection searching in any combination of collections
+
-
*Selection of collections
+
-
*Collection-specific searching
+
-
*Collection-specific browsing of
+
-
*Simple and Boolean searching
+
-
*Searching within a user-selected Finding Aid
+
-
*Ability to review and revise previous searches
+
-
*Viewing of sections of a Finding Aid or the full text in HTML, and display in context of search terms found
+
-
*Ability to select particular Finding Aids for saving in a session-based personal collection, or bookbag, and to download or email these
+
-
*Keeping a record of user search history during a session
+
-
=== Representative Resources ===
+
;[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
-
Bentley Historical Library Finding Aids
+
;[http://dlc.lib.utk.edu/f/fa/ Unversity of Tennesee Special Collections Libraries]
 +
: DLXS Findaid Class version ?
-
University of Michigan Special Collections Finding Aids
+
;[http://digital.library.pitt.edu/ead/ University of Pittsburgh, Historic Pittsburgh Finding Aids]
 +
:DLXS Findaid Class version ?
 +
;[http://digital.library.pitt.edu/ead/aboutead.html Background on Pittsburgh Finding Aids workflow]
 +
:
-
== Setting Up the Collection: Practical Issues ==
+
;[http://digicoll.library.wisc.edu/wiarchives University of Wisconsin, Archival Resources in Wisconsin: Descriptive Finding Aids]
 +
:DLXS Findaid Class version ?
-
'''1. Choosing Unique Collection IDs'''
+
;[http://discover.lib.umn.edu/findaid University of Minnesota Libraries, Online Finding Aids]
 +
:DLXS Findaid Class version ?
-
There are two areas of practice that can affect on your online collection outside of hands-on encoding or the conversion of word processed finding aids. First is the use of IDs as attributes on elements. This does not refer to the EADID, but to collection IDs within the finding aids used to identify the element so that it can be referred to, or referenced from, somewhere else. Each ID within a document must be unique (and the DTD enforces this). Before you assign IDs to any part of the collection, you should consider the consequences of joining all your finding aids into one collection. In this case, IDs will need to be unique across the entire collection. One way to ensure uniqueness is to prefix ID values with the eadid for a given document. At this time, there is no functionality in DLXS that requires you to have IDs on any elements, but you may want to use them for your own internal purposes.
+
;[https://wiki.lib.umn.edu/Staff/FindingAidsInEAD/ EAD Implementation at the University of Minnesota]
 +
:
-
For example, you might want to put IDs on an attribute that you want to then link to with a target attribute. If the attribute is the full name of an organization commonly abbreviated, and you would like to target the abbreviated name back to the full name, the full corpname element would have an ID attribute and the abbreviated corpname element would have a target containing the ID value. From the point of view of developers at UM DLXS, this is a fairly typical problem that we ourselves have encountered.
+
;[http://archives.getty.edu:8082/cgi/f/findaid/findaid-idx?cc=utf8a;c=utf8a;tpl=browse.tpl Getty Research Institute Special Collections Finding Aids]
 +
: Heavily customized DLXS11a. [http://library.pub.getty.edu:8100/DLXS06.html Background on Getty customization and user interface changes to DLXS]
-
We recommend that you choose a unique collection ID that is unique across all collections, regardless of class. Even if you do not want to implement cross-class searching at this point, choosing a unique ID makes this kind of search possible to implement in the future. It also allows you to store your collections on the same server.
+
;[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.
-
Next, request authorization for the collection ID. Will the collection be public, restricted, or item-level restricted?
+
==[[Working with the EAD]]==
-
'''2. Working with Fabricated Regions'''
+
==[[Preparing Data and Directories]]==
-
The second area of practice that can affect your online collection are the decisions you make about fabricated regions. Briefly, fabricated regions are ways of grouping elements you have marked up. When you are ready to index your data, XPAT looks at a file named extra.srch which groups queries into discrete regions. For example, you might have lots of different tags related to names: <persname>, <famname>, <corpname>, etc. DLXS groups these queries into the fabricated region <name> for convenient, faster indexing. If you decide not to use all the possible markup options, you should take out the empty regions. Some of these regions, however, are cached in many other places in the user interface, not all of which are documented. General recommendations for thinking about markup and fabricated regions include the following:
+
==[[Finding Aids Data Preparation]]==
-
# Think about what elements you want to markup. You may want to markup more elements than you think you need to any not display all the searchable options at this point. If you only markup your texts to a basic level, however, you may have less options later.
+
==[[Building the Index]]==
-
# If you have empty regions, you should remove them from the extra.srch file, but remember to take them out of the other files that reference them. We are working on documenting these locations.
+
-
# what else?
+
-
See Working with Fabricated Regions in FindaidClass, and Working with Fabricated Regions (TextClass) for more information.
+
==[[Working with Fabricated Regions in Findaid Class]]==
-
== Preparing Data and Directories ==
+
==[[Customizing Findaid Class]]==
-
The rules that govern FindaidClass and the ways UM DLXS organizes finding aids were decided by the larger finding aids community. We have provided the DTDs and other files you need to use to mount your collection. While you can, theoretically, alter these files, we don’t recommend it. Of the four DLXS classes, it is most difficult to change options in FindaidClass. This section describes how to set up your directories and data to mount your collection in the following topics:
+
==[[Mounting the Collection Online]]==
-
* Setting Up Directories
+
==[[Troubleshooting Finding Aids]]==
-
* Preparing Your Data
+
-
* Cleaning Up Your Data
+
-
* Validating the Concatenated File
+
-
* Possible Validation Errors
+
-
The data preparation process includes the following steps:
+
==[[Linking from Finding Aids Using ID Resolver]]==
-
# Validating the files individually against the EAD 2002 DTD.
+
==[http://www.dlxs.org/training/workshop200707/findaidclass/fcoutline.html Workshop Materials]==
-
# Concatenating the files into one larger XML file.
+
-
# Validating the concatenated file against the dlxsead2002 DTD.
+
-
==[[Findaid Class Graphics Files]]==
+
==Working with the User Interface==
-
==[[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]]

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