Mounting a Finding Aids Collection

From DLXS Documentation

(Difference between revisions)
Jump to: navigation, search
(Overview of Data Preparation and Indexing Steps)
Current revision (21:58, 1 July 2008) (edit) (undo)
(Examples of Findaid Class Implementations and Practices)
 
(326 intermediate revisions not shown.)
Line 4: Line 4:
This topic describes how to mount a Findaid Class collection.
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==
==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]
 +
:
 +
 
 +
;[http://digicoll.library.wisc.edu/wiarchives University of Wisconsin, Archival Resources in Wisconsin: Descriptive Finding Aids]
 +
:DLXS Findaid Class version ?
 +
 
 +
;[http://discover.lib.umn.edu/findaid University of Minnesota Libraries, Online Finding Aids]
 +
:DLXS Findaid Class version ?
 +
 
 +
;[https://wiki.lib.umn.edu/Staff/FindingAidsInEAD/ EAD Implementation at the University of Minnesota]
 +
:
 +
 
 +
;[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]
 +
 
 +
;[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.
 +
 
 +
==[[Working with the EAD]]==
 +
 
 +
==[[Preparing Data and Directories]]==
 +
 
 +
==[[Finding Aids Data Preparation]]==
 +
 
 +
==[[Building the Index]]==
 +
 
 +
==[[Working with Fabricated Regions in Findaid Class]]==
 +
 
 +
==[[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]==
-
==Working with the EAD==
 
-
==[[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==
==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]]
[[#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

Personal tools