User Tools

Site Tools


eaditor:ead_core

EAD Core

There are two XForms web forms for creating and editing EAD finding aids: the core, which encompasses the EAD Header, Front Matter, and the Archival Description (with the <did>, <did>-level components, and <dsc>), and the component form for editing individual components at any level within the document.

Introduction to Web Form Concepts

The diagram above illustrates an example of the core web form, which displays the EAD Header tab by default when the finding aid loads.

  • A. Save and Load Controls. If the form is invalid, it cannot save to eXist.
  • B. Table of Contents: shows a nested list reflecting the hierarchy of components. Click on a component to load it in its own form.
  • C. Adding Front Matter will create a new tab.
  • D. The Document ID is the xml:id of the <ead> element. It is required and is used for generating the filename for the finding aid. The orange exclamation point icon indicates that the field is invalid. The form cannot be saved while there are invalid fields. Examples of invalid fields include: required values, values that do not meet schema requirements (the normal attribute of date elements must meet the ISO 8601 encoding standard), blank paragraphs, etc.
  • E. Navigation Tabs. A tab will be created for Front Matter if that element exists in the finding aid.
  • F. A green plus (+) icon indicates that elements can be added into the current node (eadheader). A popup window with available elements will appear upon clicking the + (example, below), unless G.
  • G. If there is text adjacent to the plus (+) icon, that specific element will be inserted.
  • H. Click on the red X to remove an element (this includes all of its descendants).
  • I. Attributes of certain elements may be edited by clicking on the @ symbol. This will open a popup window generated dynamically from the EAD 2002 schema.xsd, which enables the user to enter strings or select values from drop-down menus (for audience and container type). Values are displayed with gray text. Applying the add-attributes link to other elements in a finding aid will be discussed in another wiki article.

EAD Header

This tab is self-explanatory, but it should be noted there are two required fields: EAD ID and the Proper Title in the File Description/Title Statement

Archival Description

The archival description (<archdesc>) tab is broken into three sections, Descriptive Identification, Component-level Information, and Description of Subordinate Components (which, being optional, is added by the link under the Archival Description heading. The <archdesc> level must be selected; collection is the default.

Descriptive Identification (<did>)

It is important to note that the Unit Title is the only required element within the <did>. Click on the green + icon next to the header to add additional elements. See example below.

Component-level Information

These are the optional elements which may be included within the <archdesc>, excluding the <dsc> and <did>. Click the green + icon to add elements. See example below.

Description of Subordinate Components (<dsc>)

Once the <dsc> has been added into the <archdesc>, this section will appear in the form. There are three required fields to make the finding aid valid: the level attribute, the unit title, and the xml:id of the <c> element. The xml:id is generated dynamically when a component is inserted into the <dsc>, but it may be changed. It is important, though, to note that the value of the xml:id field must be a valid xs:ID datatype, as per the W3C XML specifications. The XForms validation protocol built into the form recognizes this requirement, and the exclamation icon will be visible if the value of the field is invalid.

After the finding aid is saved, the table of contents menu in the left column of the form will be updated with modifications to the <dsc>. The user may click on a new link for the component to edit it.

eaditor/ead_core.txt · Last modified: 2011/12/06 20:08 by egruber