Customizing Findaid Class
From DLXS Documentation
Main Page > Mounting Collections: Class-specific Steps > Mounting a Finding Aids Collection > Customizing Findaid Class
Contents |
[edit] Working with the table of contents
The table of contents on the left-hand side of the finding aid display is based on fabricated regions set up in *.extra.srch and configured either in a configuration file or in a subclass of FindaidClass.pm
If a subclass is not being used to override the FindaidClass::_initialize method, the configuration file will be used. It is:
$DLXSROOT/cgi/f/findaidclass/findaidclass.cfg
The configuration file sets up a hash called %gSectHeadsHash. The relevant section of the findaidclass.cfg file is:
# **********************************************************************
# Hash of section heads that XPAT should search for. A reference to
# this hash is added as member data keyed by 'tocheads' to the
# FindaidClass object at initialization time. Comment out those that
# are missing in your finding aids.
# **********************************************************************
%gSectHeadsHash = (
'bioghist-t' => {
'collection' => qq{Biography},
'recordgrp' => qq{History},
},
'controlaccess-t' => qq{Subject Terms},
'frontmatter-t' => qq{Title Page},
'arrangement-t' => qq{Arrangement},
'scopecontent-t' => qq{Collection Scope and Content Note},
'summaryinfo-t' => qq{Summary Information},
'contentslist-t' => qq{Contents List},
'admininfo-t' => qq{Access and Use},
'add-t' => qq{Additional Descriptive Data},
);
The %gSectHeadsHash is normally loaded read from the configuration file and loaded into a hash called tocheads in the FindaidClass::_initialize method when the FindaidClass object is created. If you wish to change the table of contents on a collection-specific basis, you can override the FindaidClass::_initialize method in a collection-specific subclass.
For an example of using a subclass to override the default table of contents see: $DLXSROOT/cgi/f/findaid/FindaidClass/SamplefaFC.pm
Note that the default setting in the Collection Manager for the samplefa collection is to use this subclass:
The diagram below shows the fabricated region and the corresponding EAD element tags for the out-of-the-box table of contents
[edit] Changing the labels in the table of contents
If you want to change the labels for all of your Findaid Class collections, you can change the strings in the %gSectHeadsHash hash in $DLXSROOT/cgi/f/findaid/findaidclass.cfg. If you want to change the labels on a collection by collection basis, you will probably want to subclass and override the FindaidClass::_initialize method as is done in the sample file: $DLXSROOT/cgi/f/findaid/FindaidClass/SamplefaFC.pm
