Mounting a Finding Aids Collection

From DLXS Documentation

(Difference between revisions)
Jump to: navigation, search
(→Overview)
(→Overview of Data Preparation and Indexing Steps)
Line 9: Line 9:
===Examples===
===Examples===
===Overview of Data Preparation and Indexing Steps===
===Overview of Data Preparation and Indexing Steps===
 +
 +
'''Data Preparation'''
 +
 +
# [#DataPrepStep1 validating the files individually] against the EAD ''2002'' DTD<br />'''make validateeach'''<br />
 +
# [#DataPrepStep2 concatenating the files into one larger XML file]<br />'''make prepdocs'''<br />
 +
# [#DataPrepStep3 validating the concatenated file] against the ''dlxsead2002'' DTD:<br />'''make validate'''<br />
 +
# [#DataPrepStep4 "normalizing" the concatenated file.]<br />'''make norm'''<br />
 +
# [#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:
 +
 +
&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 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:
 +
 +
 +
&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. This is the recommended process.
 +
# '''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==

Revision as of 15:21, 14 August 2007

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 here.

Contents

Overview

Examples

Overview of Data Preparation and Indexing Steps

Data Preparation

  1. [#DataPrepStep1 validating the files individually] against the EAD 2002 DTD
    make validateeach
  2. [#DataPrepStep2 concatenating the files into one larger XML file]
    make prepdocs
  3. [#DataPrepStep3 validating the concatenated file] against the dlxsead2002 DTD:
    make validate
  4. [#DataPrepStep4 "normalizing" the concatenated file.]
    make norm
  5. [#DataPrepStep5 validating the normalized concatenated file against the dlxsead2002 DTD]
    make validate

The end result of these steps is a file containing the concatenated EADs wrapped in a <COLL> element which validates against the dlxsead2002 and is ready for indexing: 

<COLL>
<ead><eadheader><eadid>1</eadid>...</eadheader>... content</ead>
<ead><eadheader><eadid>2</eadid>...</eadheader>... content</ead>
<ead><eadheader><eadid>3</eadid>...</eadheader>... content</ead>
</COLL>

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: 


<COLL>
baddata<ead><eadheader><eadid>1</eadid>...</eadheader>... content</ead>
baddata<ead><eadheader><eadid>2</eadid>...</eadheader>... content</ead>
baddata<ead><eadheader><eadid>3</eadid>...</eadheader>... content</ead>
</COLL>

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

  1. make singledd indexes words for texts that have been concatenated into on large file for a collection. This is the recommended process.
  2. make xml indexes the XML structure by reading the DTD. Validates as it indexes.
  3. make post builds and indexes fabricated regions based on the XPAT queries stored in the workshopfa.extra.srch file.

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

Findaid Class Graphics Files

Findaid Class Processing Instructions

Top

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