Mounting a Finding Aids Collection
From DLXS Documentation
(→Examples of Findaid Class Implementations and Practices) |
|||
(10 intermediate revisions not shown.) | |||
Line 7: | Line 7: | ||
==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]] | # [[Preparing_Data and Directories|Prepare your data and set up a directory structure]] | ||
- | # [[#Validating_and_Normalizing_Your_Data| Validate and normalize your data]] | + | # [[Finding_Aids_Data_Preparation#Validating_and_Normalizing_Your_Data| Validate and normalize your data]] |
# [[Building the Index |Build the Index]] | # [[Building the Index |Build the Index]] | ||
# [[Mounting the Collection Online|Mount the collection online]] | # [[Mounting the Collection Online|Mount the collection online]] | ||
+ | ===[[Findaid Class Behaviors Overview]]=== | ||
- | + | This section describes the basic Findaid Class behaviors. | |
- | + | ===Examples of Findaid Class Implementations and Practices=== | |
- | ;[http://bentley.umich.edu/EAD/index. | + | 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/ | + | ;[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 47: | Line 53: | ||
==[[Working with the EAD]]== | ==[[Working with the EAD]]== | ||
- | |||
- | ==[[Findaid Class Behaviors Overview]]== | ||
==[[Preparing Data and Directories]]== | ==[[Preparing Data and Directories]]== | ||
Line 62: | Line 66: | ||
==[[Mounting the Collection Online]]== | ==[[Mounting the Collection Online]]== | ||
- | ==[[Troubleshooting]]== | + | ==[[Troubleshooting Finding Aids]]== |
==[[Linking from Finding Aids Using ID Resolver]]== | ==[[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 <dao> 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 <dao>. 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 <dao> where the id number is 91153-1. | ||
- | |||
- | <dao linktype="simple" href="91153-1" show="new" actuate="onrequest"><br /> <daodesc><br /> <p>[view selected images]</p><br /> </daodesc><br /> </dao> | ||
- | |||
- | The preparedocs.pl program would change this to: | ||
- | |||
- | <dao linktype="simple" href="dao-bhl-91153-1" show="new" actuate="onrequest"><br /> <daodesc><br /> <p>[view selected images]</p><br /> </daodesc><br /> </dao> | ||
- | |||
- | 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>'''<ITEM MTIME="20030728142225"><ID>dao-bhl-bl000684 </ID><URI>http://images.umdl.umich.edu/cgi/i/image/image-idx?&q1=bl000684&rgn1=bhl_href&type=boolean&med=1&view=thumbnail&c=bhl </URI></ITEM>'''</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 98: | 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#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]]=== | ===[[Findaid Class Graphics Files]]=== | ||
Line 111: | Line 85: | ||
===[[Findaid Class Processing Instructions]]=== | ===[[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
[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:
- Prepare your data and set up a directory structure
- Validate and normalize your data
- Build the Index
- 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 ?
- 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:
- Customizing Findaid Class
- Working with Fabricated Regions in Findaid Class
- Common Problems and Solutions
[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.