#######################
# Software Dependencies
#######################
#Linux server is being used: http://www.linux.org/
#Perl: http://www.perl.org/ 5.6 or above, including packages File::Copy, Shell::Command, Time::Local, XML::Twig
#  (filepath to perl is set on top line of each script;  if not in /usr/bin/perl, please modify to match 
#   correct path to perl executable;  locate by typing "which perl" on commandline)
#ImageMagick: http://www.imagemagick.org/script/index.php  (must be on classpath of script user;
#   locate by typing "which convert" on commandline)
#Tesseract OCR: http://sourceforge.net/projects/tesseract-ocr/ (must be on classpath of script user;
#   locate by typing "which tesseract" on commandline) 
#If using static HTML delivery for content, the server recognizes "index.html" as a default page 
#   in web directories.  This is a common default set in the
#   configuration file for the apache web server.


############
# EADs
############

# EADs are created in Archivist Toolkit or are in the same format
# namespace at top of EAD includes an ns2 prefix with namespace for xlink, as well as the usual ones for validation.
# So the top element reads, for example:
#  <ead xsi:schemaLocation="urn:isbn:1931666-22-9 http://www.loc.gov/ead/ead.xsd" xmlns:ns2="http://www.w3.org/1999/xlink" xmlns="urn:isbn:1-931666-22-9" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

# Containers in EADs include Box, Folder, and Item where a Box may or may not contain one or more folders
#   and a folder may or may not contain one or more items. Items do not occur outside of folders, and
#   folders do not occur outside of boxes.
# Frame will be accepted as an alternatives to Folder; Volume will be accepted as an alternative for
# either Box or Folder (but not both in a single container).
# Levels in the EAD include series and subseries, which contain file levels.  Within the file level the 
# Box and Folder are normally entered as containers.  Item level entries (not made by this script)
# within the file level is NOT supported,
# as there is no way to match up these entered item descriptions with the digitized content.
#   All linking will be done at file level!  So at minimum, this script expects file level to be used where
#  boxes and/or folders are entered as containers.  Thus, if you have a single series, you must enter at least one
#  box at file level for the folders to be linked in.  Without identification of the box, at least, there's no linking.

# Also, if folder-level linking is desired (collection is only processed to the box level)
# then the digitized files must have a folder number in their filename -- if no folders 
# actually exist in the box, use folder number 1 in the digital file naming.
# Note:  folder-level linking is not currently supported in Acumen.  That is to say, the EAD in Acumen would still
#  link out to the folder, but the folder and its items would be displayed via the static HTML at this point.


# EADs will be delivered online via Acumen or some other delivery software.  If not, and simple HTML output
# for each EAD is desired, a sample XSL file is provided in the /EADS/XSL directory.
# Modify as desired and apply to each EAD using the transformation system of your choice, to create an 
# HTML page for each EAD. Name the resultant HTML for the collection identifier (with .html extension) and place
# in the EADs folder for online upload. One possible processor is Saxon:  http://saxon.sourceforge.net/
# The file will be renamed index.html and placed in the collection web directory http://yoursite/collID  
# where collID is your selected collection identifier.

# Note that most browsers will
#    transform an xml file based on the rules in the XSL it is linked to.  Thus, if you modify an xsl file to your
#    liking, name it ead.xsl, place it in the same directory as the EAD, and link it at the top like this:
#    <?xml-stylesheet type="text/xsl" href="./ead.xsl"?>  (just below the "<?xml version" statement), you'll
#    be able to access that collection EAD by linking to the file itself.  (If named testColl.ead.xml and in the
#    http://yourInstitution/collections/testColl  directory, it will be at
#    http://yourInstitution/collections/testColl/testColl.xml -- this will become your digital collection url.



################
# FILE NAMING
################

# Each collection has a unique collection_identifier composed of letters, numbers, underscores and/or hyphens.
# Underscores will indicate division into subdirectories.  If using Acumen, the first portion of this 
# identifier may indicate type of material, for division of collections by type of material, so as to group
# image collections, text collections, finding aids, audio, and so forth.  This is optional.
#  If using Acumen, and also breaking down collections by type of material,
# an example of a manuscript collection identifier would be u0003_0000252 for MSS 252 in manuscripts;
# an example of an audio collection identifier would be u0008_0000001; sheet music would be u0004_0000001.
# In this example, all manuscript collection identifiers begin with u0003_, all sheet music collection 
# identifiers begin with u0004_, and all audio collection identifiers begin with u0008_.

# Whether the type of material division is used or not, the collection identifier is the
# alphanumeric value that precedes the box/folder/item numbering
# section of the identifier. 
# Valid values include letters, numbers, and hyphens.
# Remember, an underscore divides the segments which specify a directory name
#   thus, if u0004 indicates sheet music, and within the sheet music content the third collection grouping
#   is indicated by 0000003, then the collection_identifier is u0004_0000003 and u0004 will be a web directory
#   containing the directory 0000003.  

# EAD is named the same as the collection identifier, followed by .ead.xml. Thus, the EAD for the above collection
#   would be u0004_0000003.ead.xml

# Item identifiers are composed of the collection_identifier followed by an underscore, followed by Box number, Folder number
#   and item number.  [REFERENCE THE config.txt FILE IN THE config DIRECTORY]
#   Thus, if the box_number_length is 3, and the folder_number_length is 2, item_number_length is 2, then
#   the segment of the identifier following the collection_identifier will be 7 characters long (left-padding with
#   zeros as necessary throughout).  Thus for the above mentioned collection and these specified lengths, box 7 folder 12
#   item 16 would be identified by u0004_0000003_0071216.
#   This portion of the file identifier (0071216) will be the name of a subdirectory within the collection subdirectory.

# If an item consists of more than one file, the files are numbered consecutively, left-padded with zeroes as specified
#   by the page_number_length value.  If the latter is specified in the config file to be 4, then page 2 of the above item
#   would be identified by u0004_0000003_0071216_0002 and the tif would be named u0004_0000003_0071216_0002.tif

# If an item consists of only one file, it may simply be named without the last segment: u0004_0000003_0071216.tif

####################
#  DERIVATIVES
####################

# Assumption is that all archival captures are TIFF files with the extension ".tif" and that deliverables include
# thumbnails and large images, and OCR if desired.  While Acumen uses OCR, the static HTML access does not.