Skip to content
Alexander Duryee edited this page Oct 19, 2020 · 1 revision

EAS Tag Libraries Technical Documentation

This page is a guide to downloading, working with, and contributing to the EAS Tag Libraries repository.

About This Repository

Working with EAS-TagLibraries

Contributing to the EAS Tag Libraries

  1. Create a fork of the repository
  2. Make and commit changes to your forked repository
  3. Create a pull request to https://github.com/SAA-SDT/EAS-TagLibraries.
  4. Changes to specific standards will be reviewed and, if accepted, merged in by the corresponding subteam. Changes to the tag library formatting/structure will be reviewed and, if accepted, merged in by the Schema subteam.

Generating the EAS Tag Libraries

The publication formats for the tag libraries are PDF and HTML, both of which will be distributed via the host organization's website (e.g. loc.gov for EAD and staatsbibliothek-berlin.de for EAC-CPF).

PDF and HTML files can be generated either manually or via the included build script; the latter is preferred. Specific procedures for manually generating tag library files will differ based on operating system, how software libraries/tools were installed, command line vs. oXygen, etc. and will not be provided. Instructions for running the build script are as follows:

macOS / Linux

  1. Open Terminal and cd to the build/ directory in the repository
  2. sh generate_tag_libraries.sh (eac|ead|premis) path/to/tei.xml

For example, if you wanted to generate the EAC-CPF files from the included TEI, you would execute sh generate_tag_libraries.sh eac ../tei/EAC-CPF-TL-eng.xml.

Windows

  1. Open the Command Prompt and cd to the build/ directory in the repository
  2. generate_tag_libraries.bat (eac|ead|premis) path\to\tei.xml

For example, if you wanted to generate the EAC-CPF files from the included TEI, you would execute generate_tag_libraries.bat eac ..\tei\EAC-CPF-TL-eng.xml.

Manual Command Line Generation

  1. Generate the FOXML document by applying tagLibrary2pdf.xslt to the TEI via Saxon. Note that Saxon is required due to XSLT 2.0 support.
  2. Generate the HTML document by applying tagLibrary2html.xslt to the TEI via Saxon. Note that Saxon is required due to XSLT 2.0 support.
  3. Generate the PDF by running fop against the FOXML.

oXygen Generation

tk