Skip to content

Latest commit

 

History

History
131 lines (101 loc) · 5.58 KB

README.md

File metadata and controls

131 lines (101 loc) · 5.58 KB
Raw

Manuscript Solution Pack Build Status

Introduction

Allows users to create and view Manuscripts. Including the upload of TEI and XSLT and CSS documents. Users will be able to view transformed manuscript TEI (via the upload XSLT) side by side with the image(s) of the manuscript (via the Open Seadragon viewer). Users will also be able to browse Manuscripts via Box / Folder hierarchies as defined by their record in an associated finding aid.

The Connecticut Digital Archive has put together an informative user documentation guide that outlines the functionality of this module.

Key Features

  • Ability to upload TEI
  • Ability to upload XSLT (1.0) / CSS
  • Ability to associate XSLT / CSS with a Finding Aid Object
  • Rendering of TEI as HTML (XSLT)
  • Open Sea Dragon Viewer display of Manuscript image Content
  • Side by side view of Transformed TEI and Open Sea Dragon Viewer
  • Navigation of manuscripts by box / folder meta-data (SOLR driven)

Requirements

This module requires the following modules/libraries:

This module has the following recommended (optional) modules/libraries:

Installation

Install as usual, see this for further information.

Download/clone the jsTree library to sites/all/libraries/jstree. The module has been tested with the 3.0.0 release of jsTree.

Troubleshooting/Issues

Having problems or solved a problem? Check out the Islandora google groups for a solution.

FAQ

Q. What elements are necessary in finding aid EAD metadata?

A. Components (c, c01, c02, c03, etc) MUST have id attributes unique to the given XML document in order to reliably produce links and relationships. Components MUST have a level as one of:

  • series
  • subseries
  • file

Additionally, as of writing, the only supported types of containers inside of components are boxes and folders. Folder entries MAY be associatited to boxes using the parent attribute, to target the id given to a box. Alternatively, associations will be made by iterating containers and producing a new association for each "box" encountered.

A minimal example of the structure we require:

<ead xmlns="urn:isbn:1-931666-22-9">
  <eadheader>
    <eadid>example-id</eadid>
    <filedesc>
      <titlestmt>
        <titleproper>Example Collection</titleproper>
      </titlestmt>
    </filedesc>
  </eadheader>
  <archdesc level="collection">
    <did>
      <unittitle>Example Collection</unittitle>
    </did>
    <dsc>
      <c01 id="alpha" level="series">
        <!--
          "bravo" makes use of the "parent" attribute to associate a folder
          with a box.
        -->
        <did>
          <unittitle>Alpha</unittitle>
        </did>
        <c02 id="bravo" level="file">
          <did>
            <unittitle>Bravo</unittitle>
            <container id="container-one" type="box">1</container>
            <container parent="container-one" type="folder">1</container>
          </did>
        </c02>
        <!--
          "charlie" relates containers by associating boxes and folders as they
          occur in document order.
        -->
        <c02 id="charlie" level="file">
          <did>
            <unittitle>Charlie</unittitle>
            <container type="boxes">2-3</container>
            <container type="box">4</container>
            <container type="folder">1</container>
            <container type="box">5</container>
            <container type="folders">1-7</container>
          </did>
        </c02>
      </c01>
    </dsc>
  </archdesc>
</ead>

In bravo, we have one logical container:

  • folder 1 from box 1

In charlie, we have three logical containers:

  • boxes 2 to 3
  • folder 1 from box 4
  • folders 1 to 7 from box 5

Do note that the code tries not to make any assumptions about the numbering of boxes or folders. Folders could either be numbered sequentially across boxes (in which case specifying a range of folders could make sense when specifying a range of boxes) or specific to a box. Additionally, pluralization of types is largely ignored.

Maintainers/Sponsors

Current maintainers:

Development

If you would like to contribute to this module, please check out our helpful Documentation for Developers info, as well as our Developers section on the Islandora.ca site.

License

GPLv3