eulxml.xmlmap.eadmap
- Encoded Archival Description (EAD)¶
General Information¶
The Encoded Archival Description (EAD) is a a standard xml format for encoding finding aids. For more information, please consult the official Library of Congress EAD site.
This set of xml objects is an attempt to make the major fields of an EAD document accessible for search and display. It is by no means an exhaustive mapping of all EAD elements in all their possible configurations.
Encoded Archival Description¶
LOC documentation for EAD element
Nearly all fields in all EAD XmlObjects are mapped as
eulxml.xmlmap.XPathString
or eulxml.xmlmap.XPathStringList
,
except for custom EAD sub-objects, which are indicated where in use.
- class
eulxml.xmlmap.eadmap.
EncodedArchivalDescription
(node[, context])¶
XmlObject
for an Encoded Archival Description (EAD) Finding Aid (Schema-based). All XPaths use the EAD namespace; this class can not be used with non-namespaced, DTD-based EAD.Expects node passed to constructor to be top-level ead element.
abstract
= <eulxml.xmlmap.fields.NodeField>¶collection level abstract - archdesc[@level=”collection”]/did/abstract
archdesc
= <eulxml.xmlmap.fields.NodeField>¶
ArchivalDescription
- archdesc
record author - eadheader/filedesc/titlestmt/author
dsc
= <eulxml.xmlmap.fields.NodeField>¶
SubordinateComponents
archdesc/dsc; accessible at top-level for convenience
eadid
= <eulxml.xmlmap.fields.NodeField>¶ead id
EadId
- eadheader/eadid
file_desc
= <eulxml.xmlmap.fields.NodeField>¶
FileDescription
- filedesc
id
= <eulxml.xmlmap.fields.StringField>¶top-level id attribute - @id; preferable to use eadid
physical_desc
= <eulxml.xmlmap.fields.StringField>¶collection level physical description - archdesc[@level=”collection”]/did/physdesc
profiledesc
= <eulxml.xmlmap.fields.NodeField>¶
ProfileDescription
- profiledesc
title
= <eulxml.xmlmap.fields.NodeField>¶record title - eadheader/filedesc/titlestmt/titleproper
unittitle
= <eulxml.xmlmap.fields.NodeField>¶unit title for the archive - archdesc[@level=”collection”]/did/unittitle
Archival Description¶
LOC documentation for EAD archdesc element
- class
eulxml.xmlmap.eadmap.
ArchivalDescription
(node[, context])¶Archival description, contains the bulk of the information in an EAD document.
Expected node element passed to constructor: ead/archdesc.
alternate_form
= <eulxml.xmlmap.fields.NodeField>¶alternative form available
Section
- altformavail
controlaccess
= <eulxml.xmlmap.fields.NodeField>¶
ControlledAccessHeadings
- controlaccess; subject terms, names, etc.
dao_list
= <eulxml.xmlmap.fields.NodeListField>¶list of digital archival object references as
DigitalArchivalObject
did
= <eulxml.xmlmap.fields.NodeField>¶descriptive identification
DescriptiveIdentification
- did
extent
= <eulxml.xmlmap.fields.StringListField>¶extent from the physical description - did/physdesc/extent
index
= <eulxml.xmlmap.fields.NodeListField>¶list of
Index
- index; e.g., index of selected correspondents
langmaterial
= <eulxml.xmlmap.fields.StringField>¶language of the materials - did/langmaterial
location
= <eulxml.xmlmap.fields.StringField>¶physical location - did/physloc
origination
= <eulxml.xmlmap.fields.StringField>¶origination - did/origination
related material
Section
- relatedmaterial
separated_material
= <eulxml.xmlmap.fields.NodeField>¶separated material
Section
- separatedmaterial
unitid
= <eulxml.xmlmap.fields.NodeField>¶
Unitid
- did/unitid
Subordinate Components¶
See also LOC documentation for dsc element , c (component) element
- class
eulxml.xmlmap.eadmap.
SubordinateComponents
(node[, context])¶Description of Subordinate Components (dsc element); container lists and series.
Expected node element passed to constructor: ead/archdesc/dsc.
c
= <eulxml.xmlmap.fields.NodeListField>¶list of
Component
- c01; list of c01 elements directly under this section
hasSeries
()¶Check if this finding aid has series/subseries.
Determined based on level of first component (series) or if first component has subcomponents present.
Return type: boolean
type
= <eulxml.xmlmap.fields.StringField>¶type of component - @type
- class
eulxml.xmlmap.eadmap.
Component
(node[, context])¶Generic component cN (c1-c12) element - a subordinate component of the materials
alternate_form
= <eulxml.xmlmap.fields.NodeField>¶alternative form available
Section
- altformavail
c
= <eulxml.xmlmap.fields.NodeListField>¶list of
Component
- recursive mapping to any c-level 2-12; c02|c03|c04|c05|c06|c07|c08|c09|c10|c11|c12
dao_list
= <eulxml.xmlmap.fields.NodeListField>¶list of digital archival object references as
DigitalArchivalObject
did
= <eulxml.xmlmap.fields.NodeField>¶
hasSubseries
()¶Check if this component has subseries or not.
Determined based on level of first subcomponent (series or subseries) or if first component has subcomponents present.
rtype: boolean
id
= <eulxml.xmlmap.fields.StringField>¶component id - @id
level
= <eulxml.xmlmap.fields.StringField>¶level of the component - @level
related material
Section
- relatedmaterial
Controlled Access Headings¶
LOC Documentation for controlaccess element
- class
eulxml.xmlmap.eadmap.
ControlledAccessHeadings
(node[, context])¶Controlled access headings, such as subject terms, family and corporate names, etc.
Expected node element passed to constructor: contolaccess.
controlaccess
= <eulxml.xmlmap.fields.NodeListField>¶list of
ControlledAccessHeadings
- recursive mapping to controlaccess
- class
eulxml.xmlmap.eadmap.
Heading
(node[, context])¶Generic xml object for headings used under controlaccess
source
= <eulxml.xmlmap.fields.StringField>¶source vocabulary for controlled term - @source
value
= <eulxml.xmlmap.fields.StringField>¶controlled term text value (content of the heading element)
Index and Index Entry¶
See also LOC Documentation for index element, indexentry element
- class
eulxml.xmlmap.eadmap.
Index
(node[, context])¶Index (index element); list of key terms and reference information.
Expected node element passed to constructor: ead/archdesc/index.
entry
= <eulxml.xmlmap.fields.NodeListField>¶list of
IndexEntry
- indexentry; entry in the index
note
= <eulxml.xmlmap.fields.NodeField>¶
Note
- class
eulxml.xmlmap.eadmap.
IndexEntry
(node[, context])¶Index entry in an archival description index.
name
= <eulxml.xmlmap.fields.NodeField>¶access element, e.g. name or subject
ptrgroup
= <eulxml.xmlmap.fields.NodeField>¶
PointerGroup
- group of references for this index entry
File Description¶
See also LOC Documentation for filedesc element, publicationstmt element
- class
eulxml.xmlmap.eadmap.
FileDescription
(node[, context])¶Bibliographic information about this EAD document.
Expected node element passed to constructor: ead/eadheader/filedesc.
publication
= <eulxml.xmlmap.fields.NodeField>¶publication information - publicationstmt
- class
eulxml.xmlmap.eadmap.
PublicationStatement
(node[, context])¶Publication information for an EAD document.
Expected node element passed to constructor: ead/eadheader/filedesc/publicationstmt.
address
= <eulxml.xmlmap.fields.NodeField>¶address of publication/publisher - address
date
= <eulxml.xmlmap.fields.NodeField>¶
DateField
- date
publisher
= <eulxml.xmlmap.fields.StringField>¶publisher - publisher
Miscellaneous¶
See also LOC documentation for did element , container element
- class
eulxml.xmlmap.eadmap.
DescriptiveIdentification
(node[, context])¶Descriptive Information (did element) for materials in a component
abstract
= <eulxml.xmlmap.fields.NodeField>¶abstract - abstract
dao_list
= <eulxml.xmlmap.fields.NodeListField>¶list of digital archival object references as
DigitalArchivalObject
langmaterial
= <eulxml.xmlmap.fields.StringField>¶language of materials - langmaterial
location
= <eulxml.xmlmap.fields.StringField>¶physical location - physloc
origination
= <eulxml.xmlmap.fields.StringField>¶origination - origination
physdesc
= <eulxml.xmlmap.fields.StringField>¶physical description - physdesc
unitdate
= <eulxml.xmlmap.fields.NodeField>¶unit date - .//unitdate can be anywhere under the DescriptiveIdentification
unitid
= <eulxml.xmlmap.fields.NodeField>¶
Unitid
- unitid
unittitle
= <eulxml.xmlmap.fields.NodeField>¶unit title - unittitle
- class
eulxml.xmlmap.eadmap.
Container
(node[, context])¶Container -
DescriptiveIdentification
subelement for locating materials.Expected node element passed to constructor: did/container.
type
= <eulxml.xmlmap.fields.StringField>¶type - @type
value
= <eulxml.xmlmap.fields.StringField>¶text value - (contents of the container element)
- class
eulxml.xmlmap.eadmap.
Section
(node[, context])¶Generic EAD section. Currently only has mappings for head, paragraph, and note.
content
= <eulxml.xmlmap.fields.NodeListField>¶list of paragraphs - p
head
= <eulxml.xmlmap.fields.NodeField>¶heading - head
note
= <eulxml.xmlmap.fields.NodeField>¶
Note
- class
eulxml.xmlmap.eadmap.
Address
(node[, context])¶Address information.
Expected node element passed to constructor: address.
lines
= <eulxml.xmlmap.fields.StringListField>¶list of lines in an address - line
- class
eulxml.xmlmap.eadmap.
PointerGroup
(node[, context])¶Group of pointer or reference elements in an index entry
Expected node element passed to constructor: ptrgrp.
- class
eulxml.xmlmap.eadmap.
Reference
(node[, context])¶Internal linking element that may contain text.
Expected node element passed to constructor: ref.
target
= <eulxml.xmlmap.fields.StringField>¶link target
type
= <eulxml.xmlmap.fields.StringField>¶link type - xlink:type
value
= <eulxml.xmlmap.fields.NodeField>¶text content of the reference
- class
eulxml.xmlmap.eadmap.
ProfileDescription
(dom_node[, context])¶Profile Descriptor for an EAD document. Expected node element passed to constructor: ‘ead/eadheader/profiledesc’.
date
= <eulxml.xmlmap.fields.NodeField>¶
DateField
- creation/date
language_codes
= <eulxml.xmlmap.fields.StringListField>¶language codes - langusage/language/@langcode
languages
= <eulxml.xmlmap.fields.StringListField>¶language information - langusage/language
- class
eulxml.xmlmap.eadmap.
DigitalArchivalObject
(dom_node[, context])¶Digital Archival Object (dao element)
audience
= <eulxml.xmlmap.fields.StringField>¶audience (internal or external)
href
= <eulxml.xmlmap.fields.StringField>¶url where the digital archival object can be accessed
id
= <eulxml.xmlmap.fields.StringField>¶identifier
show
= <eulxml.xmlmap.fields.StringField>¶attribute to determine how the resource should be displayed
title
= <eulxml.xmlmap.fields.StringField>¶title