Library of Congress

Recommended Best Practices for Encoded Archival Description Finding Aids at the Library of Congress (EAD Version 2002)

DRAFT

December 9, 2004

NOTE ABOUT PRINTING: The current document is a single html file which can easily be printed in its entirety. However, be forewarned that it is very long (over 200 pages!).


Table of Contents

Top | Introduction | Conventions | Implementing XML | Practices


List of Practices

2.1.  Generic Text and Formatting Elements
     2.1.1.  Heading
     2.1.2.  Paragraph
     2.1.3.  Note
2.2.  Linking Elements
     2.2.1.  Internal Linking
     2.2.2.  External Linking
3.1.  EAD Header
     3.1.1.  Unique File Identifier
     3.1.2.  File Description
     3.1.3.  Profile Description
     3.1.4.  Revision Description
3.2.  Title Page and Prefatory Matter
3.3.  Collection-Level Information (Archival Description)
     3.3.1.  Basic Description: The High-Level <did>
          3.3.1.1.  Title of the Unit
          3.3.1.2.  Date of the Unit
          3.3.1.3.  ID of the Unit
          3.3.1.4.  Origination
          3.3.1.5.  Physical Description
          3.3.1.6.  Language of the Material
          3.3.1.7.  Repository
          3.3.1.8.  Abstract
          3.3.1.9.  Note
          3.3.1.10.  Physical Location
          3.3.1.11.  Digital Archival Object Group
     3.3.2.  Controlled Vocabulary Terms
          3.3.2.1.  Use of Attributes in <controlaccess> Subelements
          3.3.2.2.  Personal, Corporate, Family, and Geographic Names
          3.3.2.3.  Form and Genre Terms
          3.3.2.4.  Function and Occupation Terms
          3.3.2.5.  Subjects and Titles
          3.3.2.6.  Use of Grouped Controlled Vocabulary Terms
          3.3.2.7.  Use of Controlled Vocabulary Outside of <controlaccess>
     3.3.3.  Administrative Information
          3.3.3.1.  Acquisition Information
          3.3.3.2.  Custodial History
          3.3.3.3.  Accruals
          3.3.3.4.  Processing Information
          3.3.3.5.  Appraisal
          3.3.3.6.  Conditions Governing Use
          3.3.3.7.  Conditions Governing Access
          3.3.3.8.  Alternate Form of the Materials Available
          3.3.3.9.  Preferred Citation of the Material
     3.3.4.  Biographical Sketches and Agency Histories
     3.3.5.  Scope and Content Note
     3.3.6.  Arrangement
     3.3.7.   Description of Subordinate Components
          3.3.7.1.  What is a Component?
          3.3.7.2.  Unnumbered Versus Numbered Components
          3.3.7.3.  Basic Description of Each Component
               3.3.7.3.1.  Unit Title
               3.3.7.3.2.  Unit Date
               3.3.7.3.3.  Physical Description
               3.3.7.3.4.  Abstracts
               3.3.7.3.5.  ID Numbers
               3.3.7.3.6.  Physical Location Information
               3.3.7.3.7.   Container Information
          3.3.7.4.  Expanded Description of Components
     3.3.8.  Adjunct Descriptive Data
          3.3.8.1.  Bibliographies
          3.3.8.2.  File Plans
          3.3.8.3.  Indexes
          3.3.8.4.  Other Finding Aids
          3.3.8.5.  Related Material
          3.3.8.6.  Separated Material
     3.3.9.  Other Descriptive Data

Table of Contents

INTRODUCTION

The Library of Congress EAD Practices Working Group has drafted these proposed guidelines for the creation of EAD finding aids at the Library of Congress, a process which has included documenting current practices at the Library, examining other documented standards and practices, and addressing outstanding issues.

These guidelines are intended for use in conjunction with the EAD Tag Library Version 2002 and EAD Application Guidelines, published by the Society of American Archivists and the Library of Congress and available online at http://lcweb.loc.gov/ead/. The guidelines in this current draft accompany Chapter 3 of the Application Guidelines, "Creating Finding Aids in EAD." They also conform to the Research Library Group's "RLG Best Practice Guidelines for Encoded Archival Description" (August 2002), available online at http://www.rlg.org/rlgead/bpg.pdf.

Technical documents and other files supplementing the administration and publication of EAD finding aids at the Library of Congress are available at http://lcweb.loc.gov/ead/practices/technical/technical-ead2002.html.

The guidelines for version 1.0 of the EAD DTD were made available to the Library of Congress EAD Technical Group for review, and many suggestions for improvement have been incorporated into a final draft which is available for use by Library staff. This document has been revised in compliance with EAD 2002, and includes revision of the numbering of practices in the table of contents.

For further information about the creation or content of this document, please contact the working group at lcead@loc.gov.

Table of Contents

Basic Conventions Used

The LC Practices guidelines are based on the EAD Application Guidelines and cite its chapter and subordinate numbers to facilitate cross-consultation. Each of the individually numbered sections described below is referred to as a "practice." Most practices here accompany Chapter 3 of the Application Guidelines, "Creating Finding Aids in EAD," although two practices from Chapter 7, "EAD Linking Elements", are included. The order of practices reflect the recommended order of elements in an EAD finding aid.

This section of the guidelines describe the contents of each section of an individual practice.

Name:

The topic of the individual practice (most often an EAD element name) given here usually matches the section heading for that table of contents number in the Application Guidelines

Table of Contents Number:

This locally assigned number follows the order recommended or required by the LC Best Practice Guidelines and the EAD DTD.

Guidelines Number:

This number matches the one given in the Application Guidelines (version 1.0). Not all the sections of Chapter 3 are found in the LC Practices document, since local practices do not need to be defined for each topic. Occasionally a topic covered by one number in the Application Guidelines (e.g. "3.5.1.4.1, Acquisition Information and Custodial History, is split into two practices, "3.5.1.4.1a, Acquisition Information" and "3.5.1.4.1b, Custodial History").

Tag:

Tag names elements under discussion are provided in the tag section. Tag names appear within angle brackets, e.g., <acqinfo>. No tag is given if the practice does not concern a specific element or elements.

Description:

The description section provides a brief summary of the content of the topic or nature of the element. Fuller descriptions are provided in the Tag Library and Application Guidelines. The second paragraph of the description usually gives LC recommended practice for the topic, for instance, that use of a particular element is required or recommended. For some practices a third paragraph, "new in EAD 2002", describes changes in the new EAD DTD.

See also:

References provided here list other practices within this document related to the current topic. These references are not active links in this version of the document.

References to specific portions of the Tag Library or Application Guidelines are not provided in this section but will be made where appropriate.

Labels/Heads:

Suggested formulation of appropriate content for labels, which aid in clear displays, and for heads, which are important for navigation as well as displays. A particular element may use the LABEL attribute (such as <did> subelements); or, it may include <head> as a subelement, but both are never used for the same element.

Encoding Analog:

See the EAD Tag Library, Appendix A.3, for a crosswalk between MARC21 and EAD.

Other attributes:

Recommended attributes (except for ENCODINGANALOG, discussed above) for the element under discussion are listed here, sometimes with suggested values for those attributes. The Tag Library includes complete lists of all attributes and their possible content for each element, and are discussed at length in its "EAD Attributes" section.

One of these attributes, NORMAL, is recommended for all dates, both <date> and <unitdate>. This practice is new at LC. Date normalization will follow ISO 8601 in YYYYMMDD format.

Set the SCRIPTCODE attribute for <language> within <langusage> and <langmaterial> using ISO 15924 only if nonroman script needs to be noted.

The most common values for the SOURCE attribute on controlled access elements are those listed in the semiclosed list from EAD version 1.0. These values are: aat, aacr2, cdwa, dot, gmgpc, lcnaf, lcsh, lctgm, local, mesh, mim, ncarules, nmc, rad, rbgenr, tgn, ulan.

Subelements:

Subelements are listed when the practice focuses on a broader parent element. For instance, elements used within the wrapper element <eadheader> are listed as subelements. If the order in which they are listed is the recommended order in which they should be used, this is noted. If use of the subelement is either required or recommended, that practice is noted here as well.

In many cases, individual practices exist for each subelement described; where this is true, references are given to the number and name of that practice. The order of the practices associated with these subelements follows the recommended order.

Examples:

Most practices include one or more examples of recommended markup. For each tagging example, there are one or more examples of a display that could be generated from the tagging example, depending on output specifications. Note that formatting features such as bold, italics, underlining, graphics, and font sizes and colors cannot be provided in the display examples in this version of the practices manual, although they form an important part of output specifications.

Comments:

Specific recommendations and discussions pertaining to LC implementation and issues arising from the practice topic are given here. The comments usually build on the initial description and refer specifically to the numbered examples provided.

Repeatable:

If an element is repeatable (may be used multiple times in the context described), this is noted as well as if the element is recursive (may be used within itself, e.g., <controlaccess> within a broader <controlaccess>).

Order:

If the practice concerns a particular element, either a specific order is recommended ("following <userestrict> and preceding <altformavail>"), or the parent element is noted ("within <descgrp>").

Revision Date:

The date of the last revision to the individual practice provides version control to this regularly updated document.

Table of Contents

Implementing XML in EAD 2002

The Library of Congress implemented EAD version 1 as an SGML DTD. Implemention of the new EAD DTD (EAD 2002) will incorporate migration of SGML files to XML files. All new EAD finding aids will be created in XML using EAD 2002; legacy finding aids will be converted to XML and migrated to EAD 2002. The LC Practices describe encoding changes throughout the document and highlight these with the label, "New in EAD 2002". This section discusses the features of XML which differ from SGML as found in EAD finding aids; further information about XML is widely available and may be found at http://xml.coverpages.org/xml.html.

XML is Case Sensitive

Because XML is case sensitive (upper- and lower-case characters are not interchangeable), the EAD 2002 XML DTD requires that all element names, attribute names, and enumerated attribute values be in lower case.

In particular, the following must be in lower case for the document to validate:

XML Character Encoding

The default character encoding for XML is UTF-8 or UTF-16. Character encoding transformations are included in the conversion from EAD version 1 to EAD 2002. The W3C strongly discourages use of the character entity references found in SGML documents (such as &eacute;), and not all XML tools support these entity references. While valid in XML, these entity references should be replaced using the graphic character displays or numeric character references, as appropriate. For basic information on character encoding issues related to Unicode and XML, see the RLG DigiNews article on Character Sets and Character Encoding: A Brief Introduction at: http://www.rlg.org/en/page.php?Page_ID=17068&Printable=&Article ID=992

Differences between SGML Prolog and XML Prolog

1. XML declaration required: Use the following:

<?xml version="1.0" encoding="utf-8"?>

2. Public identifiers: XML syntax and values are different from the SGML public identifer. Use the following:

<!DOCTYPE ead PUBLIC "+//ISBN 1-931666-00-8//DTD ead.dtd (Encoded Archival Description (EAD) Version 2002)//EN"

3. System identifiers: XML requires the use of a system identifier. Use the following:

"http://lcweb2.loc.gov/xmlcommon/dtds/ead2002/ead.dtd"

4. Processing instructions: SGML applications such as Panorama required processing instructions such as <?ATTLINK EXTPTR HREF URI> to resolve external entities. While these are permitted in XML, they are no longer necessary and should not be added to newly encoded finding aids.

Examples of the full XML prolog may be seen in Section 2.2.2, External Linking, Examples 1 and 2.

Converting from SGML EAD Version 1

LC finding aids encoded using EAD Version 1 will be converted from SGML to XML and transformed into EAD 2002 using conversion routines available at http://lcweb2.loc.gov/music/eadmusic/eadconv12/ead2002_r.htm. In addition to converting to the new DTD, all elements, attributes, and most attribute values will be converted to lowercase. Notation of empty elements is changed into XML (e.g. line breaks are now appear as "<lb/>). SGML character entities will be converted to UTF-8 values. A few additional changes will need to be done to the XML files after they have been converted:

1. After validating the XML instance on the local PC and before uploading the file to the server change the system identifer to include the full path to the location of the DTD on the server; in other words, change

<!DOCTYPE ead PUBLIC "+//ISBN 1-931666-00-8//DTD ead.dtd (Encoded Archival Description (EAD) Version 2002)//EN" "ead.dtd">

to

<!DOCTYPE ead PUBLIC "+//ISBN 1-931666-00-8//DTD ead.dtd (Encoded Archival Description (EAD) Version 2002)//EN" "http://lcweb2.loc.gov/xmlcommon/dtds/ead2002/ead.dtd">

2. In Collection Summary, move <langmaterial> element from the end of the <did> to immediately follow <repository> as specified in Section 3.3.1.6, Language of the Material.

3. Look at the conversion report to make sure that all data has been migrated success; in addition, review the encoding of the finding aid to make sure that the finding aid is in major compliance with the current version of the LC Practices.

Differences Between Converted Finding Aids and New EAD 2002 Encoding:

Processing instructions: processing instructions such as <?ATTLINK EXTPTR HREF URI> which were present in the SGML finding aids have been converted to XML format, e.g. <?ATTLINK EXTPTR HREF URI?>. These may be retained in a converted XML document but should not be added to newly encoded finding aids.

Parsed entity declarations: LC Practice recommends in Section 2.2.2, External Linking, that entity declarations for external entites linked to from the finding aid appear in either the document prolog or in a separate ".ent" file in the same directory as the finding aid. In the process of document conversion, the values of the declared entities are extracted from the declarations and appear as the value of the HREF attribute, and the entity declaration is no longer present (i.e., HREF="&arendthome;") will be changed to HREF="http://memory.loc.gov/ammem/arendthtml/". This result for converted finding aids is acceptable, but newly encoded finding aids should continue to implement the practice concerning use of external entities.


Library of Congress EAD Practices


Table of Contents

Generic Text and Formatting Elements

Table of Contents Number:

2.1

EAD Guideline:

3.5.1.7 (Ver. 1.0)

Description:

Use judgment in deciding when to place punctuation in an encoded document and when to let a style sheet supply the punctuation; see the Application Guidelines for further guidance.

Remember that finding aids viewed externally using a different style sheet or HTML encoding scheme may not supply the punctuation your internal style sheet does, and determine whether this is an acceptable risk. Also remember that if some finding aids include the punctuation and others supply by style sheet, it will be difficult to program the HTML transformation consistently to avoid double punctuation where it is already present.

If container lists are created in a database, it is more logical to assume that commas don't need to be included. If the document already exists in a word processing format, the commas are already present and extra work is required to strip them out. If in doubt, omit punctuation.

See also:

n/a

Encoding Analog:

n/a

Other Attributes:

n/a

Subelements:

Tagging Example 1.

Whitespace outside the element for inline title element


<p>The publication of <title>A Walk in the Woods</title> in 1996 resulted in ...</p>

 



Display of Tagging Example 1.

 
The publication of A Walk in the Woods in 1996 resulted in ...
 



Tagging Example 2.

Punctuation outside the element for inline emph element


<p>On the good ship <emph render="italic">Lollipop</emph>, life was easy.</p>

 



Display of Tagging Example 2.

 
On the good ship Lollipop, life was easy.
 



Tagging Example 3.

Period included at end of inline title element as required by editorial practice


<p>Shirley Jackson is the author of <title render="doublequote">The Lottery.</title></p>

 



Display of Tagging Example 3.

 
Shirley Jackson is the author of "The Lottery."
 



Comments:

Repeatable:

n/a

Order:

n/a

Revision Date:

05/07/03


Table of Contents

Heading

Table of Contents Number:

2.1.1

EAD Guideline:

3.5.1.7.1 (Ver. 1.0)

Tag:

<head>

Description:

See also:

n/a

Labels/Heads:

n/a

Encoding Analog:

n/a

Other Attributes:

n/a

Subelements:

n/a

Tagging Example 1.

Heads provided for both Administrative Information Section and provenance paragraph


<descgrp type="admininfo">
  
<head>Administrative Information</head>
  
<acqinfo encodinganalog="541">
    
<head>Provenance</head> 
    
<p>
      The papers of Susan Q. Archivista, archivist and philanthropist, were
      given to the Library of Congress by Josiah Quincy and Sally Rae
      Archivista in 1978.  An addition to the collection includes items
      purchased by the Library in 1998.
    
</p>
  
</acqinfo>
</descgrp>
 



Display of Tagging Example 1.

Heads provided for both Administrative Information Section and provenance paragraph


Archivista Papers              | Administrative Information      
  *Collection Summary          |     
  *Administrative Information  | Provenance
     *Provenance               | The papers of Susan Q. Archivista,
                               | archivist and philanthropist, were
                               | given to the Library of Congress
                               | by Josiah Quincy and Sally Rae
                               | Archivista in 1978.  An addition 
                               | to the collection includes items
                               | purchased by the Library in 1998.
 

Display of heads in navigator illustrated: provenance head is subordinate to that for <descgrp>



Comments:

Headings are illustrated for each element for which they are valid.

Repeatable:

no

Order:

first element within any section where valid

Revision Date:

05/07/03


Table of Contents

Paragraph

Table of Contents Number:

2.1.2

EAD Guideline:

3.5.1.7.2 (Ver. 1.0)

Description:

The paragraph element is an important structural element within EAD. It must be used within many elements before text can be inserted, and can be used to format text within those elements into one or multiple units. Within paragraph, many other elements are available for use within text, including reference and linking elements, formatting elements, controlled access elements, and some <did> subelements.

See also:

n/a

Labels/Heads:

n/a

Encoding Analog:

n/a

Other Attributes:

n/a

Subelements:

n/a

Tagging Example 1.

Paragraph used within <separatedmaterial>; linking and controlaccess elements available within <p>


<separatedmaterial encodinganalog="544 0">
   
<p>An extensive collection of additional Olmsted Associates
   records, including graphic material related to this collection, is
   located at the Frederick Law Olmsted National Historical Site in
   Brookline, Massachusetts. Records for the period 1870-1910 also are
   included in the Subject File of the 
<archref href="&amp;loc.mss/eadmss.ms001019;" show="new" actuate="onload"><origination>Frederick Law Olmsted</origination>
   Papers
</archref> in the Library of Congress.</p>
</separatedmaterial>
 



Display of Tagging Example 1.

Paragraph used within <separatedmaterial>; linking and controlaccess elements available within <p>


An extensive collection of additional Olmsted Associates records,
including graphic material related to this collection, is located at
the Frederick Law Olmsted National Historical Site in Brookline,
Massachusetts. Records for the period 1870-1910 also are included in
the Subject File of the Frederick Law Olmsted Papers in the Library of
Congress.

 



Tagging Example 2.

Less detailed tagging: published titles tagged with <title> and no attribute. Single and double quotes from keyboard used rather than <title> tagging for names of poems and <emph> for Hoosier poet.


<p>
  James Whitcomb Riley was born in Greenfield, Indiana, and is known as
  the "Hoosier poet." He was on the staff of the 
<title>Indianapolis
    Journal,
</title> 1877-1885, and his contributions to that newspaper
  established his fame as a poet. Typescript poems in the papers include
  "The Name of Old Glory," "The Lisper," "The Young Old Man," and "At
  'The Literary.'"
</p>

 



Display of Tagging Example 2.

Display is identical with that of Example 3


James Whitcomb Riley was born in Greenfield, Indiana, and is known as
the "Hoosier poet." He was on the staff of the Indianapolis Journal,
1877-1885, and his contributions to that newspaper established his
fame as a poet. Typescript poems in the papers include "The Name of
Old Glory," "The Lisper," "The Young Old Man," and "At 'The
Literary.'"

 



Tagging Example 3.

More detailed tagging: published titles tagged with <title> and render attribute. Double quotes from keyboard deleted in favor of <title> tagging for names of poems and <emph> for Hoosier poet.


<p>
  James Whitcomb Riley was born in Greenfield, Indiana, and is known as
  the 
<emph render="doublequote">Hoosier poet.</emph> He was on the staff of
  the 
<title render="italic">Indianapolis Journal</title>, 1877-1885,
  and his contributions to that newspaper established his fame as a
  poet. Typescript poems in the papers include 
<title render="doublequote">
    The Name of Old Glory,
</title> <title render="doublequote">The
    Lisper,
</title> <title render="doublequote">The Young Old Man,</title> and
  
<title render="doublequote">At <emph render="singlequote">The Literary.</emph>
  
</title>
</p>

 



Display of Tagging Example 3.

Display is identical with that of Example 2


James Whitcomb Riley was born in Greenfield, Indiana, and is known as
the "Hoosier poet." He was on the staff of the Indianapolis Journal,
1877-1885, and his contributions to that newspaper established his
fame as a poet. Typescript poems in the papers include "The Name of
Old Glory," "The Lisper," "The Young Old Man," and "At 'The
Literary.'"

 



Comments:

Repeatable:

yes

Order:

n/a

Revision Date:

05/24/04


Table of Contents

Note

Table of Contents Number:

2.1.3

EAD Guideline:

3.5.1.7.3 (Ver. 1.0)

Tag:

<note>

Description:

The note element is available in many places as explanatory text. This element is used for supplementary data such as footnotes and should not be used when more specific elements are available.

See also:

Section 3.3.1.9, Note (within high-level <did>)

Labels/Heads:

n/a

Encoding Analog:

500$a

Other Attributes:

Use as appropriate when notes should appear as footnotes, endnotes, or linked notes:

See Tag Library for full list of attributes and their values.

Subelements:

See Tag Library for full list of valid subelements.

Tagging Example 1.

Note is short explanatory text; no special display required


<c02 level="file">
  
<did>
    
<unittitle encodinganalog="245$a">Diary, author unknown</unittitle>
    
<note encodinganalog="500">
      
<p>
        A study of this item in 1982 concluded that it came from the Shaker
        community at Union Village, Ohio, and not Pleasant Hill.
      
</p>
    
</note>
  
</did>
</c02>
 



Display of Tagging Example 1.

Note is short explanatory text; no special display required


Diary, author unknown
  A study of this item in 1982 concluded that it came from the Shaker
  community at Union Village, Ohio, and not Pleasant Hill.

 



Comments:

Repeatable:

yes

Order:

n/a

Revision Date:

05/07/03


Table of Contents

Linking Elements

Table of Contents Number:

2.2

EAD Guideline:

7.1.2 (Ver. 1.0)

Tag:

n/a

Description:

There are seventeen elements in EAD that can be used to establish links: fifteen manage links directly, while two (<daogrp> and <linkgrp>) are wrapper elements that consolidate multiple, related links. Linking elements are discussed here under the general categories of internal links (with the EAD document) and external links (to other documents.)

New in EAD 2002: linking elements <arc> and <resource> have been added.

See also:

Section 2.2.1, Internal Linking

See also:

Section 2.2.2, External Linking

Labels/Heads:

n/a

Encoding Analog:

n/a

Other Attributes:

n/a

Subelements:

Comments:

Repeatable:

n/a

Order:

n/a

Revision Date:

05/07/03


Table of Contents

Internal Linking

Table of Contents Number:

2.2.1

EAD Guideline:

7.2 (Ver. 1.0)

Tag:

n/a

Description:

Internal linking enhances the ability to navigate a finding aid via explicit links between related information appearing in different places in the finding aid. Extensive information about linking can be found in Chapter 7 of the EAD Application Guidelines.

LC Practice requires the use of the TARGET, ACTUATE, and SHOW attributes with internal linking elements, and recommends the use of <ref> over <ptr> for internal linking.

New in EAD 2002: linking elements <arc> and <resource> have been added. Values for the ACTUATE attribute have changed.

See also:

Section 3.3.8.3, Indexes

See also:

Section 2.2.2, External Linking

Labels/Heads:

n/a

Encoding Analog:

n/a

Other Attributes:

See Tag Library for full list of attributes and their values.

Subelements:

Simple linking within the finding aid:

Additionally, <indexentry> may be used within the index to bundle <ref>, <ptr>, or <ptrgrp>.

Extended linking within the finding aid (must be bundled using <linkgrp>)

Tagging Example 1.

Cross-reference from Hart linked to target (Rodgers)


<c02 level="file">
  
<did>
    
<container type="box">135</container>
    
<unittitle encodinganalog="245$a">Hart, Lorenz <ref show="replace" actuate="onrequest" target="rodgers176">See Container 176, Rodgers,
        Richard
</ref>
    
</unittitle>
  
</did>
</c02>
<c02 level="file">
  
<did>
    
<container type="box">176</container>
    
<unittitle id="rodgers176" encodinganalog="245$a">Rodgers,
      Richard, and Lorenz Hart, 
<title>I Married an Angel,</title>
      
<unitdate encodinganalog="245$f" normal="1938" type="inclusive">[1938]</unitdate>
    
</unittitle>
  
</did>
</c02>
 



Display of Tagging Example 1.

Cross-reference from Hart linked to target (Rodgers)


Box 135     Hart, Lorenz See Container 176, Rodgers, Richard

Box 176     Rodgers, Richard, and Lorenz Hart, I Married an Angel, [1938]
 



Comments:

Repeatable:

n/a

Order:

n/a

Revision Date:

11/03/03


Table of Contents

External Linking

Table of Contents Number:

2.2.2

EAD Guideline:

7.3 (Ver. 1.0)

Tag:

n/a

Description:

External linking refers to links from a finding aid to another electronic resource, which may be another encoded finding aid, a digital archival object (<dao>), an external image or file not from the archival collection (e.g., the LC seal or an illustration), or a web page. Extensive information about linking can be found in Chapter 7 of the EAD Application Guidelines.

LC practice requires the use of the HREF, ACTUATE, and SHOW attributes with external linking elements.

New in EAD 2002: linking elements <arc> and <resource> have been added. Values for the ACTUATE attribute have changed.

See also:

Section 2.1.2, Paragraph (use of linking elements within)

See also:

Section 2.2.1, Internal Linking

See also:

Section 3.1.2, File Description (<extptr> to LC seal)

See also:

Section 3.3.1.11, Digital Archival Object Group

See also:

Section 3.3.3.8, Alternate Form of the Materials Available (examples of <extref> to URLs, discussion of <daogrp>)

See also:

Section 3.3.7.4, Expanded Description of Components (<daogrp> at component level)

See also:

Section 3.3.8.1, Bibliographies (<bibref> and <archref> as linking elements)

See also:

Section 3.3.8.5, Related Material (<bibref> and <archref> as linking elements)

See also:

Section 3.3.8.6, Separated Material (<bibref> and <archref> as linking elements)

Labels/Heads:

n/a

Encoding Analog:

n/a

Other Attributes:

Simple linking:

See Tag Library for full list of attributes and their values.

Extended linking (<daoloc>):

See Tag Library for full list of valid attributes and their values for this and for other extended linking elements.

Subelements:

Simple linking:

Extended linking:

Tagging Example 1a.

XML prolog with entity declarations, linking elements for Hannah Arendt Papers


&lt;?xml version="1.0" encoding="utf-8"?&gt;

&lt;!DOCTYPE ead PUBLIC "+//ISBN 1-931666-00-8//DTD ead.dtd (Encoded Archival Description
(EAD) Version 2002)//EN" "http://lcweb2.loc.gov/xmlcommon/dtds/ead2002/ead.dtd" 

[
&lt;!ENTITY arendthome "http://memory.loc.gov/ammem/arendthtml/"&gt;
&lt;!ENTITY eadmss.mhafol02 "http://memory.loc.gov/ammem/arendthtml/mharendtFolderP02.html"&gt;
&lt;!ENTITY eadmss.mhafol03 "http://memory.loc.gov/ammem/arendthtml/mharendtFolderP03.html"&gt;
&lt;!ENTITY lcseal SYSTEM "http://lcweb2.loc.gov/xmlcommon/lcseal.jpg" NDATA jpeg&gt;
]&gt;

&lt;ead&gt;[Beginning of EAD finding aid]&lt;/ead&gt;



Tagging Example 1b.

<daoloc> has href value as an entity declared in prolog for Arendt


<c01 level="series">
  
<did>
    
<unittitle id="clcorr" encodinganalog="245$a">Correspondence, 
      
<unitdate encodinganalog="245$f" normal="1938/1976" type="inclusive">1938-1976</unitdate>
    
</unittitle>
    
<daogrp>
      
<daoloc href="&amp;eadmss.mhafol02;">
        
<daodesc>
          
<p>Items available online.</p>
        
</daodesc>
      
</daoloc>
    
</daogrp>
  
</did>
</c01>



Display of Tagging Example 1b.

<daoloc> link goes to American memory presentation of series contents


Correspondence, 1938-1976
   Items available online.



Tagging Example 2a.

XML prolog with entity declarations and link to external 'bell.ent' entity file for Bell papers


&lt;?xml version="1.0" encoding="utf-8"&gt;
&lt;!DOCTYPE ead PUBLIC "+//ISBN 1-931666-00-8//DTD ead.dtd (Encoded Archival Description
(EAD) Version 2002)//EN" "http://lcweb2.loc.gov/xmlcommon/dtds/ead2002/ead.dtd"
[

&lt;!ENTITY lcseal SYSTEM "http://lcweb2.loc.gov/xmlcommon/lcseal.jpg" NDATA jpeg&gt;
&lt;!ENTITY % links SYSTEM "bell.ent"&gt;
%links;

]&gt;        

&lt;ead&gt;[Beginning of EAD finding aid]&lt;/ead&gt;



Tagging Example 2b.

Partial content of external 'bell.ent' entity file; handle registered for each entity


&lt;!ENTITY eadmss.mb003001 "http://hdl.loc.gov/loc.mss/eadmss.mb003001"&gt;
&lt;!ENTITY eadmss.mb004001 "http://hdl.loc.gov/loc.mss/eadmss.mb004001"&gt;
&lt;!ENTITY eadmss.mb004102 "http://hdl.loc.gov/loc.mss/eadmss.mb004102"&gt;
&lt;!ENTITY eadmss.mb005003 "http://hdl.loc.gov/loc.mss/eadmss.mb005003"&gt;



Tagging Example 2c.

Shows <daoloc> with href value an entity declared in external entity file for Bell

<c03 level="file">
  
<did>
    
<unittitle encodinganalog="245$a">Family
    correspondence
</unittitle>
    
<daogrp>
      
<daoloc href="&amp;eadmss.mb003001;">
        
<daodesc>
          
<p>Items available online.</p>
        
</daodesc>
      
</daoloc>
    
</daogrp>
  
</did>
</c03>



Display of Tagging Example 2c.

<daoloc> link resolves via handle server to search results linking to contents of partially digitized folder


Family correspondence
   Items available online.        
 



Comments:

EAD linking elements

XML prolog

Handles and external entities:

Conversion from SGML to XML:

Repeatable:

n/a

Order:

n/a

Revision Date:

05/27/04


Table of Contents

EAD Header

Table of Contents Number:

3.1

EAD Guideline:

3.6.1 (Ver. 1.0)

Tag:

<eadheader>

Description:

The <eadheader> comprises a set of metadata about the finding aid that serves to identify each EAD instance, and is based on the TEI header.

LC Practice requires the inclusion of <eadheader> and its subelements; <eadheader> and two of its subelements, <eadid> and <filedesc>, are required by the EAD DTD. Consistent formulation of its information is essential.

New in EAD 2002: required attributes LANGENCODING, SCRIPTENCODING, REPOSITORYENCODING, COUNTRYENCODING, and DATEENCODING.

See also:

Section 3.2, Title Page and Prefatory Matter

Labels/Heads:

n/a

Encoding Analog:

n/a

Other Attributes:

See Tag Library for full list of attributes and their values.

Subelements:

Listed in order required by DTD. Required elements must be included to conform with LC practice.

Tagging Example 1.

Fully encoded <eadheader> element

 <ead>
  
<eadheader relatedencoding="MARC21" langencoding="iso639-2b" scriptencoding="iso15924" repositoryencoding="iso15511" countryencoding="iso3166-1" dateencoding="iso8601">
    
<eadid countrycode="us" mainagencycode="dlc" identifier="hdl:loc.gov/loc.mss/eadmss.ms001004" encodinganalog="856$u">http://hdl.loc.gov/loc.mss/eadmss.ms001004</eadid>
    
<filedesc>
      
<titlestmt>
        
<titleproper encodinganalog="245$a">Charles and Ray
        Eames
</titleproper>
        
<subtitle>A Register of Their Papers in the Library of
          Congress
</subtitle> 
        
<author encodinganalog="245$c">Prepared by Margaret H. McAleer
          with the assistance of Thelma Follette, Lisa Madison, and
          Robert A. Vietrogoski
</author>
      
</titlestmt>
      
<publicationstmt>
        
<publisher encodinganalog="260$b">
          
<extptr href="lcseal" show="embed" actuate="onload" /> Manuscript Division, Library of Congress
        
</publisher>
        
<address>
          
<addressline>Washington, D.C.</addressline>
        
</address>
        
<date encodinganalog="260$c" normal="1995">1995</date>
      
</publicationstmt>
      
<seriesstmt>
        
<titleproper>Registers of Papers in the Manuscript Division of
        the Library of Congress
</titleproper>
      
</seriesstmt>
    
</filedesc>
    
<profiledesc>
      
<creation>Text converted and initial EAD tagging provided by
      Apex Data Services, 
<date normal="1999-01">January 1999;</date>
      encoding completed by Manuscript Division, 
<date normal="1999-11">November 1999</date></creation>
      
<langusage encodinganalog="546">Finding aid written in <language langcode="eng" encodinganalog="041">English</language> and <language langcode="ita" encodinganalog="041">Italian</language>
      
</langusage>
    
</profiledesc>
    
<revisiondesc>
      
<change encodinganalog="583">
        
<date normal="2000-04">2000 April</date>
        
<item>Linked to digital content</item>
      
</change>
      
<change encodinganalog="583">
        
<date normal="1999-11">1999 November</date>
        
<item>Revised to EAD version 1</item>
      
</change>
    
</revisiondesc>
  
</eadheader>
</ead>                
        



Display of Tagging Example 1.

If header used to generate display, header should not be set to audience='internal'


                       Charles and Ray Eames
            A Register of Their Papers in the Library of Congress

                   Prepared by Margaret H. McAleer 
        with the assistance of Thelma Follette, Lisa Madison,
                     and Robert A. Vietrogoski

              Manuscript Division, Library of Congress
                        Washington, D.C.

                        [LC seal graphic]

                              1995

Text converted and initial EAD tagging provided by Apex Data Services,
January 1999; encoding completed by Manuscript Division, November 1999

2000 April Linked to digital content
1999 November Revised to EAD version 1
 

Note: display of series statement and language code suppressed



Comments:

Repeatable:

no

Order:

first element within <ead>

Revision Date:

05/26/04


Table of Contents

Unique File Identifier

Table of Contents Number:

3.1.1

EAD Guideline:

3.6.1.1 (Ver. 1.0)

Tag:

<eadid>

Description:

The <eadid> is an element required by the DTD that includes a unique alphanumeric identifier for each separate EAD finding aid. The <eadid> for a finding aid remains constant no matter how many times the finding aid may be revised or expanded.

LC Practice requires the <eadid>, which should be formulated according to the scheme described below.

New in EAD 2002: attributes COUNTRYCODE, IDENTIFIER, MAINAGENCYCODE, and others (attributes SYSTEMID, SOURCE, and TYPE are no longer valid).

See also:

n/a

Labels/Heads:

n/a

Encoding Analog:

856$u

Other Attributes:

Tagging Example 1.

<eadid> for the fourth Manuscript Division finding aid created in 2001


<eadheader>
  
<eadid countrycode="us" mainagencycode="dlc" identifier="hdl:loc.gov/loc.mss/eadmss.ms001004" encodinganalog="856$u">http://hdl.loc.gov/loc.mss/eadmss.ms001004</eadid>
</eadheader>        
        



Display of Tagging Example 1.

<eadid> for the fourth Manuscript Division finding aid created in 2001


http://hdl.loc.gov/loc.mss/eadmss.ms001004
 

Note: display of <eadid> is usually suppressed in HTML and XML versions



Comments:

Assumptions:

EAD ID structure:

Repeatable:

no

Order:

first element within <ead>

Revision Date:

05/18/04


Table of Contents

File Description

Table of Contents Number:

3.1.2

EAD Guideline:

3.6.1.2 (Ver. 1.0)

Tag:

<filedesc>

Description:

Bibliographic information about the intellectual content of the encoded finding aid is bundled in the required element <filedesc>, in which elements such as the finding aid's title, subtitle, author, and publisher are encoded in a series of subelements.

LC Practice requires the inclusion of <filedesc>, which is a mandatory element required by the EAD DTD.

See also:

n/a

Labels/Heads:

n/a

Encoding Analog:

n/a

Other Attributes:

n/a

Subelements:

Listed in recommended order. Encoding analogs listed below are required.

Tagging Example 1.

File description including series statement


<filedesc>
   
<titlestmt>
      
<titleproper encodinganalog="245$a">Charles and Ray
      Eames
</titleproper>
      
<subtitle>A Register of Their Papers in the Library of
      Congress
</subtitle>
      
<author encodinganalog="245$c">Prepared by Margaret H. McAleer
      with the assistance of Thelma Follette, Lisa Madison, and Robert
      A. Vietrogoski
</author>
   
</titlestmt>
   
<publicationstmt>
      
<publisher encodinganalog="260$b">
         
<extptr href="lcseal" show="embed" actuate="onload" />
         Manuscript Division, Library of Congress
      
</publisher>
      
<address>
         
<addressline>Washington, D.C.</addressline>
      
</address>
      
<date encodinganalog="260$c" normal="1995">1995</date>
   
</publicationstmt>
   
<seriesstmt>
      
<titleproper>Registers of Papers in the Manuscript Division of
      the Library of Congress
</titleproper>
   
</seriesstmt>
</filedesc>
                
 



Display of Tagging Example 1.

Title display generated from file (series statement display suppressed)


                    Charles and Ray Eames
       A Register of Their Papers in the Library of Congress

               Prepared by Margaret H. McAleer 
        with the assistance of Thelma Follette, Lisa Madison,
               and Robert A. Vietrogoski
 
                   [LC seal graphic]

           Manuscript Division, Library of Congress
                    Washington, D.C. 

                            1995
 



Comments:

Repeatable:

no

Order:

first element within <ead> following <eadid>

Revision Date:

05/09/03


Table of Contents

Profile Description

Table of Contents Number:

3.1.3

EAD Guideline:

3.6.1.3 (Ver. 1.0)

Tag:

<profiledesc>

Description:

The <profiledesc> element bundles information about the creation of the encoded finding aid.

LC Practices requires the inclusion of <profiledesc>, as it establishes initial version control for the finding aid.

New in EAD 2002: attribute LANGCODE in <language>.

See also:

n/a

Labels/Heads:

n/a

Encoding Analog:

n/a

Other Attributes:

n/a

Subelements:

Set the SCRIPTCODE attribute for <language> using ISO 15924 only if nonroman script needs to be noted.

Tagging Example 1.

Creation description explicitly naming encoder/s; multiple languages in finding aid


<profiledesc>
   
<creation>Finding Aid encoded by Morgan Cundiff and Paul Fraunfelter, <date normal="2001">2001</date>
   
</creation>
   
<langusage encodinganalog="546">Finding aid written in 
      
<language langcode="eng" encodinganalog="041">English</language> and <language langcode="fre" encodinganalog="041">French</language>
   
</langusage>
</profiledesc>
 



Display of Tagging Example 1.

Title display generated from creation description (language statement display suppressed)


  Finding Aid encoded by Morgan Cundiff and Paul Fraunfelter, 2001
 



Tagging Example 2.

Finding aid initially encoded by vendor

 <profiledesc>
   
<creation>Text converted and initial EAD tagging provided by Apex
   Data Services, 
<date normal="1999-01">January 1999;</date> encoding
   completed by Manuscript Division, 
<date normal="1999-11">November
   1999
</date>
   
</creation>
   
<langusage encodinganalog="546">Finding aid written in 
      
<language langcode="eng" encodinganalog="041">English</language>
   
</langusage>
</profiledesc>
        



Display of Tagging Example 2.

Finding aid initially encoded by vendor (language statement display suppressed)


Text converted and initial EAD tagging provided by Apex Data Services,
January 1999; encoding completed by Manuscript Division, 1999

 



Comments:

Repeatable:

no

Order:

follows <filedesc> and precedes <revisiondesc>

Revision Date:

6/6/03


Table of Contents

Revision Description

Table of Contents Number:

3.1.4

EAD Guideline:

3.6.1.4 (Ver. 1.0)

Tag:

<revisiondesc>

Description:

The <revisiondesc> element contains information about substantial changes that have been made to the encoded finding aid.

LC Practice requires the inclusion of <revisiondesc> when applicable.

See also:

n/a

Labels/Heads:

n/a

Encoding Analog:

n/a

Other Attributes:

n/a

Subelements:

Tagging Example 1.

Finding aid revised and expanded (first revision of encoded finding aid)


<revisiondesc>
   
<change encodinganalog="583">
      
<date normal="1999-07">1999 July</date>
      
<item>Finding aid revised to incorporate additional materials in
      December 1998, and re-encoded by John Smith.
</item>
   
</change>