Skip to content
This repository has been archived by the owner on Jan 22, 2020. It is now read-only.

Latest commit

 

History

History
593 lines (480 loc) · 53.4 KB

DATADICT.md

File metadata and controls

593 lines (480 loc) · 53.4 KB
Raw

Dúchas Application Programming Interface (Version 0.5): Data dictionary

Note: This documentation describes a prerelease version of the Dúchas API. Features are being added on an ongoing basis. This documentation will be revised in advance of the v1.0 release.

This document describes the data structure of the collections made available via the Dúchas Application Programming Interface (API). Dúchas is a project is to initiate the digitization of the National Folklore Collection (NFC). For general information regarding the API and for developer guidelines please consult the developer documentation.

Contents

The Main Manuscript Collection (CBÉ)

The Main Manuscript Collection consists of stories, accounts, questionnaires, diaries and other materials which have been physically bound into volumes. Each volume is represented in the data set by a volume entity, and each page by a page entity. Each page entity also contains a reference that identifies the scanned image of the page. Together, volume and page entities represent the collection’s physical structure. In parallel to the physical structure, a logical structure exists which annotates and indexes the physical structure. It consists of part and item entities.

A part entity represents a distinct section within a manuscript volume and may have originally been physically separate from the other contents of the volume. It is consonant with the msPart element as specified in the Text Encoding Initiative (TEI) P5 Guidelines. An item entity represents a discrete work, such as a story or diary entry. It is consonant with the TEI msItem element. Notice that mapping between items and pages is many-to-many: an item can span over several pages and a page can accommodate several items. An item entity also contains detailed data about the people who were involved in its writing, the subject to which it pertains and other data.

Queries to the Main Manuscript Collection may return one or more volume objects. The information below describes the properties of this object type.

Main Manuscript volume

Property name Type Cardinality Description
ID integer one The volume identifier (unique within collection).
DateCreated ISO 8601 datetime none or one The date and time of entry creation.
DateModified ISO 8601 datetime none or one The date and time of most recent modification to entry. This reflects the latest updates to the manuscript parts and items, as well as updates to the volume metadata itself.
VolumeNumber string none or one The volume's NFC archival reference number.
Status integer one Specifies the entry's editorial status. (Privileged)
Pages page one Metadata describing the volume's physical pages.
Parts part none or one Metadata describing the logical parts which subdivide the manuscript volume and their contents.

Main Manuscript page

Property name Type Cardinality Description
ID integer one The page identifier (unique within collection).
DateCreated ISO 8601 datetime none or one The date and time of entry creation.
DateModified ISO 8601 datetime none or one The date and time of most recent modification to entry.
PageNumber string one The page number.
ListingOrder string one The listing order of the page within the volume. This is generally, but not always, identical to the page number as written on the page itself.
TitlePage boolean none or one Indicates that this is a title page associated with a manuscript part.
ImageFileName string one The file name that identifies the scanned image of the page.
Sensitive boolean one If true the page contains sensitive content and should not be made publicly available. (Privileged)

Main Manuscript part

Property name Type Cardinality Description
ID integer one The part identifier (unique within collection).
DateCreated ISO 8601 datetime none or one The date and time of entry creation.
DateModified ISO 8601 datetime none or one The date and time of most recent modification to entry.
ListingOrder string one The listing order of the manuscript part within the volume.
TitlePages integer none or one or more Denotes title pages associated with the manuscript part. Title pages may contain a general title, information about collectors or other introductory remarks.
Date date none or one Metadata associated with the date or period of time, if known, during which the manuscript part was compiled.
Counties county none or one or many Denotes the Irish administrative county or counties associated with the manuscript part.
LocationsIreland locationIreland none or one or many Denotes a location or locations in Ireland associated with the manuscript part.
Countries country none or one or many Denotes a country or countries, apart from Ireland, associated with the manuscript part.
LocationsAbroad locationAbroad none or one or many Denotes a location or locations outside of Ireland associated with the manuscript part.
Collectors person none or one or many Denotes a person or persons involved in collecting the material within the manuscript part.
Informants person none or one or many Denotes a person or persons from whom material was obtained in the course of compiling the manuscript part.
RelevantPersons person none or one or many Denotes a person or persons referenced within, or otherwise associated with, the manuscript part.
ExtraInfoStatus string none or one Specifies the publication status of the ExtraInfoEN and ExtraInfoGA fields.
ExtraInfoEN string none or one Free-text remarks on the manuscript part (in English). Authored as part of the Dúchas project.
ExtraInfoGA string none or one Free-text remarks on the manuscript part (in Irish). Authored as part of the Dúchas project.
Items item none or one or many Metadata describing the discrete items which compose the manuscript part.

Main Manuscript item

Property name Type Cardinality Description
ID integer one The item identifier (unique within collection).
DateCreated ISO 8601 datetime none or one The date and time of entry creation.
DateModified ISO 8601 datetime none or one The date and time of most recent modification to entry.
EditorsPick ISO 8601 datetime none or one Denotes the date on which the item was featured as an editors' pick on the dúchas.ie website, if featured.
Sensitive boolean one If true the item contains sensitive content and should not be made publicly available. (Privileged)
ListingOrder string none or one The listing order of the item within its parent manuscript part. The order of items is determined, in the first instance, by their initial page number however the listingOrder property may be used, for example, to represent the order of two or more items on a single page.
Date date none or one Metadata associated with the date or period of time, if known, during which the manuscript item was collected.
Title string none or one The title of the item, if one is given.
Extract string none or one A brief extract from the text of the item. Typically provided if no title property can be specified.
Pages integer one or many Specifies the page identifier(s) associated with the item.
FirstPageID integer one Identifies the initial page associated with the item. Note that if the item does not span more than one page this will have the same value as the LastPageID
LastPageID integer one Identifies the final page associated with the item. Note that if the item does not span more than one page this will have the same value as the FirstPageID
ContentType string none or one The contentType of the manuscript item
ContentModes string none or one or many Denotes the contentMode or writing mode(s) of the manuscript item
ContentScripts ISO 15924 script code none or one or many Denotes the writing script(s) of the manuscript item
Languages ISO 639-1 language code none or one or many Denotes the writing language(s) of the manuscript item
Counties county none or one or many Denotes the Irish administrative county or counties associated with the manuscript item.
LocationsIreland locationIreland none or one or many Denotes a location or locations in Ireland associated with the manuscript item.
Countries country none or one or many Denotes a country or countries, apart from Ireland, associated with the manuscript item.
LocationsAbroad locationAbroad none or one or many Denotes a location or locations outside of Ireland associated with the manuscript item.
Collectors person none or one or many Denotes a person or persons involved in collecting the manuscript item.
Informants person none or one or many Denotes a person or persons from whom the manuscript item was obtained.
RelevantPersons person none or one or many Denotes a person or persons referenced within, or otherwise associated with, the manuscript item.
LinkedItems ManuscriptItemLink none or one or many Denotes one or more manuscript items which are directly related to this item. Typically the items are linked by a sequential relationship (e.g. the other items precede or follow the current item in a series of continuing or related stories).
ExtraInfoStatus string none or one Specifies the publication status of the ExtraInfoEN and ExtraInfoGA fields. (Privileged)
ExtraInfoEN string none or one Free-text remarks on the manuscript item (in English). Authored as part of the Dúchas project.
ExtraInfoGA string none or one Free-text remarks on the manuscript item (in Irish). Authored as part of the Dúchas project.

contentType

Value Description
SEAN Folklore.
CÍN-LAE Diary entry.
CEIST Questionnaire.
COMH Correspondence.

contentMode

Value Description
LÁMH Handwritten text.
CLÓ Typewritten text.
LÍN Drawing.

manuscriptItemLink

Denotes a direct relationship between two manuscript times. Typically the items are linked by a sequential relationship (e.g. the other items precede or follow the current item in a series of continuing or related stories).

Property name Type Cardinality Description
PartID integer one The part identifier associated with the linked manuscript item.
PageID integer one The page identifier associated with the initial page of the linked manuscript item.
ItemID integer one The identifer of the linked manuscript item.
Sequence string none or one Describes the linked item's sequential relationship (PREV if the linked item precedes the current item in sequence; NEXT if the linked item follows).

The Schools' Collection (CBÉS)

The Schools' Collection consists of stories and accounts which have been physically bound into volumes. Each volume is represented in the data set by a volume entity, and each page by a page entity. Each page entity also contains a reference that identifies the scanned image of the page. Together, volume and page entities represent the collection’s physical structure. In parallel to the physical structure, a logical structure exists which annotates and indexes the physical structure. It consists of part and item entities.

A part entity represents a distinct section within a manuscript volume and may have originally been physically separate from the other contents of the volume. It is consonant with the msPart element as specified in the Text Encoding Initiative (TEI) P5 Guidelines. It the Schools' Collection a part contains material collected by a single school. In the case of schools where multiple teachers and/or class groups took part in Scéim na Scol folklore collection scheme there may be multiple part entities associated with a single school. In the previous Schools' Collection XML-based API manuscript parts were referred to as chapters.

An item entity represents a discrete work, such as a story. It is consonant with the TEI msItem element. Notice that mapping between items and pages is many-to-many: an item can span over several pages and a page can accommodate several items. An item entity also contains detailed data about the people who were involved in its writing, the subject to which it pertains and other data. In the previous Schools' Collection XML-based API manuscript items were referred to as stories.

Queries to the Schools' Collection may return one or more volume objects. The information below describes the properties of this object type.

Schools' Collection volume

Property name Type Cardinality Description
ID integer one The volume identifier (unique within collection).
DateCreated ISO 8601 datetime none or one The date and time of entry creation.
DateModified ISO 8601 datetime none or one The date and time of most recent modification to entry. This reflects the latest updates to the manuscript parts, manuscript items, and newly-created or updated page transcripts as well as updates to the volume metadata itself.
VolumeNumber string none or one The volume's NFC archival reference number.
Status integer one Specifies the entry's editorial status. (Privileged)
Type string one Distinguishes the particular type of School's Collection volume type.
Pages page one Metadata describing the volume's physical pages.
Parts part none or one Metadata describing the logical parts which subdivide the manuscript volume and their contents.

type

Value Description
bound-volume The volume is composed of originally separate parts that were bound together.
copybook-package The volume is composed of the original copybooks the children used to transcribe the folkloric material.
volume The volume is typical of those created as part of the Scéim na Scol folklore collection scheme.

Schools' Collection page

Property name Type Cardinality Description
ID integer one The page identifier (unique within collection).
DateCreated ISO 8601 datetime none or one The date and time of entry creation.
DateModified ISO 8601 datetime none or one The date and time of most recent modification to entry.
PageNumber string one The page number.
ListingOrder string one The listing order of the page within the volume. This is generally, but not always, identical to the page number as written on the page itself.
TitlePage boolean none or one Indicates that this is a title page associated with a manuscript part.
ImageFileName string one The file name that identifies the scanned image of the page.
Sensitive boolean one If true the page contains sensitive content and should not be made publicly available. (Privileged)
Transcripts transcript none or one or many One or more transcripts of material on the manuscript page contributed by members of the Meitheal Dúchas.ie community transcription project.

Schools' Collection part

Property name Type Cardinality Description
ID integer one The part identifier (unique within collection).
DateCreated ISO 8601 datetime none or one The date and time of entry creation.
DateModified ISO 8601 datetime none or one The date and time of most recent modification to entry.
ListingOrder string one The listing order of the manuscript part within the volume.
TitlePages integer none or one or more Denotes title pages associated with the manuscript part. Title pages typically contain information about the participating school and the local area.
School school none or one Metadata that describe the school associated with the manuscript part.
Teachers person none or one or many Denotes a school teacher or teachers involved in collating the material within the manuscript part.
Items item none or one or many Metadata describing the discrete items which compose the manuscript part.

Schools' Collection item

Property name Type Cardinality Description
ID integer one The item identifier (unique within collection).
DateCreated ISO 8601 datetime none or one The date and time of entry creation.
DateModified ISO 8601 datetime none or one The date and time of most recent modification to entry.
EditorsPick ISO 8601 datetime none or one Denotes the date on which the item was featured as an editors' pick on the dúchas.ie website, if featured.
Sensitive boolean one If true the item contains sensitive content and should not be made publicly available. (Privileged)
ListingOrder string none or one The listing order of the item within its parent manuscript part. The order of items is determined, in the first instance, by their initial page number however the listingOrder property may be used, for example, to represent the order of two or more items on a single page.
Title string none or one The title of the item, if one is given.
Extract string none or one A brief extract from the text of the item. Typically provided if no title property can be specified.
Pages integer one or many Specifies the page identifier(s) associated with the item.
FirstPageID integer one Identifies the initial page associated with the item. Note that if the item does not span more than one page this will have the same value as the LastPageID
LastPageID integer one Identifies the final page associated with the item. Note that if the item does not span more than one page this will have the same value as the FirstPageID
Topics topic none or one A topic or topics from the Schools’ Collection Subject List associated with this item.
Languages ISO 639-1 language code none or one or many Denotes the writing language(s) of the manuscript item
Counties county none or one or many Denotes the Irish administrative county or counties associated with the manuscript item other than those associated with the school or the informant's place of residence.
LocationsIreland locationIreland none or one or many Denotes a location or locations in Ireland associated with the manuscript item other than those associated with the school or the informant's place of residence.
Collectors person none or one or many Denotes a person or persons involved in collecting the manuscript item.
Informants person none or one or many Denotes a person or persons from whom the manuscript item was obtained.

Schools' Collection person

Due to the scope of the Schools' Collection digitisation project it has not yet been feasible to extract a normalised set of personal metadata. Instead, the initial phases of the project sought to capture information about the persons referred to within the collection 'as is'. Thus, potentially, the same individual may be referred by more than one person entity.

Property name Type Cardinality Description
ID integer one The person identifier.
Names name one or many Names associated with the person.
Gender string none or one The person's gender (f or m).
Age age none or one Metadata regarding a person's age.
AddressesIreland locationIreland none or one or many Denotes a location or locations in Ireland given as the person's address.
Occupations string none or one or many Occupations associated with the person. These occupations are not linked to a controlled vocabulary: they record the person's occupations as they were written down and may be in English or Irish.
CollectorRelationship string none or one If the person in question is an informant this property expresses the relationship (familial or otherwise) the informant has with respect to the person collecting the material.

CollectorRelationship

Value Description
GRPAR The individual is the collector's grandparent.
PAR The individual is the collector's parent.
REL The individual is related to the collector (the relationship is unspecified).
UNK The relationship is unknown.
UNREL The individual is unrelated to the collector.

Schools' Collection age

Property name Type Cardinality Description
Age integer one The person's age in years, if known.
Qualifier string none or one Additional information regarding the person's age.
RangeMax integer none or one If not null this value specifies the person's maximum potential age, i.e. if the person's age is 50 and their RangeMax value is 60 their age is in the range of 50-60 years.

Qualifier

Value Description
APPROX The age is approximate.
OVER The person's actual age is higher than age value, e.g. the person is 'over 60'.

school

Describes a school that participated in the Scéim na Scol folklore collection scheme.

Property name Type Cardinality Description
Name string one The school name.
RollNumber string none or one The school's Department of Education roll number.
Locations locationIreland none or one or many A location or locations associated with the school.

Schools' Collection topic

Represents a topic taken from the Schools’ Collection Subject List. Note that topics are hierarchical and a given topic will contain data pertaining to its antecedent topic categories where applicable.

Property name Type Cardinality Description
ID integer one The topic identifier.
TitleEN string one The topic's English-language title.
TitleGA string one The topic's Irish-language title.
SubTopics topic none or one Hierarchical descendants of this topic.

The Photographic Collection (CBÉG)

Queries to the Photographic Collection may return one or more photograph objects. The information below describes the properties of this object type.

photograph

Property name Type Cardinality Description
ID integer one The photograph identifier (unique within collection).
DateCreated ISO 8601 datetime one The date and time of entry creation.
DateModified ISO 8601 datetime none or one The date and time of most recent modification to entry.
EditorsPick ISO 8601 datetime none or one Denotes the date on which the photograph was featured as an editors' pick on the dúchas.ie website, if featured.
ReferenceNumber string none or one The NFC archival reference for the photograph.
Status integer one Specifies the entry's editorial status. (Privileged)
Sensitive boolean one If true the entry contains sensitive content and should not be made publicly available. (Privileged)
Digitized boolean one If true the entry is associated with a digitized image.
Copyright string none or one Denotes the copyright holder for the entry.
Condition integer none or one Denotes the overall condition or clarity of the digitized image associated with this entry.
ConditionDescription string none or one Additional commentary on the image condition, where appropriate.
HandbookTopic handbookTopic none or one Denotes the associated subject heading (topic) in Seán Ó Súilleabháin's A Handbook of Irish Folklore.
Date date none or one Metadata associated with the photograph's capture date.
Photographer person none or one Denotes the person who captured the photograph.
RelevantPersons person none or one or many Denotes persons visible in, or otherwise associated with, the photograph.
Counties county none or one or many Denotes the Irish administrative county or counties in which the photograph was captured.
LocationsIreland locationIreland none or one or many Denotes a location or locations in Ireland associated with the photograph.
Countries country none or one or many Denotes a country or countries, apart from Ireland, associated with the photograph.
LocationsAbroad locationAbroad none or one or many Denotes a location or locations outside of Ireland associated with the photograph.
ArchivedDescriptionStatus string none or one Specifies the publication status of the ArchivedDescription field. (Privileged)
ArchivedDescription string none or one A free-text archival description of the photograph. Imported from NFC's previous data management system at the outset of the digitization process.
ExtraInfoStatus string none or one Specifies the publication status of the ExtraInfoEN and ExtraInfoGA fields. (Privileged)
ExtraInfoEN string none or one A free-text commentary on the photograph (in English). Authored as part of the Dúchas project.
ExtraInfoGA string none or one A free-text commentary on the photograph (in Irish). Authored as part of the Dúchas project.
Formats format none or one or many Describes the physical image formats held by the NFC that are associated with the entry.
ArchivedInfo archivedInfo none or one Comprises the archival information imported from NFC's previous data management system at the outset of the digitization process. (Privileged)
Digitization digitization none or one Metadata associated with the digitization of the archive image or images associated with this entry.

copyright

Value Description
CBE NFC is the copyright holder.
OTH Copyright is held by an entity other than NFC.
NOT Copyright does not apply.
UNK Copyright status is unknown.

condition

Value Description
0 Poor condition.
1 Medium condition.
2 Good condition.

archivedDescriptionStatus

Specifies the publication status of the archivedDescription field.

Value Description
EDIT The ArchivedDescription field is not suitable for publication.
PUB The ArchivedDescription field is suitable for publication.

handbookTopic

Denotes a subject heading (topic) in Seán Ó Súilleabháin's A Handbook of Irish Folklore. It has been archival practice in NFC to associate photographs in CBÉG with a Handbook topic and a Handbook topic ID constitutes the first segment of the photograph ReferenceNumber.

Property name Type Cardinality Description
ID string one The topic's unique identifier.
TopicEN string one The general topic category (in English).
TopicGA string one The general topic category (in Irish).
SubTopicEN string one The specific topic category (in English).
SubTopicGA string one The specific topic category (in Irish).

format

Property name Type Cardinality Description
Quantity integer none or one The quantity of images in this format held by NFC.
Color string none or one Denotes the image color type.
ColorComment string none or one Additional commentary regarding the image color type.
Dimensions string none or one The dimensions of the physical image.
DimensionsComment string none or one Additional commentary regarding the image dimensions.
Medium string none or one The image medium.
MediumComment string none or one Additional commentary regarding the image medium.
Physical string none or one Denotes the physical character of the image.
PhysicalComment string none or one Additional commentary regarding the physical character of the image.

archivedInfo

As part of the Dúchas project photograph metadata from the NFC's previous data management system was ingested for archival purposes. The ArchivedInfo object holds this metadata.

Property name Type Cardinality Description
Copyright string none or one Denotes the photograph copyright holder(s).
Condition string none or one Describes the photograph's physical condition.
Topic string none or one Denotes the associated subject heading (topic) in Seán Ó Súilleabháin's A Handbook of Irish Folklore.
Date string none or one The date of photograph capture.
Photographer string none or one The photographer name.
Location string none or one The location where the photograph was captured.
Format string none or one Information regarding the physical image formats held by NFC.

digitization

Property name Type Cardinality Description
DateCaptured string one Denotes the date of image digitization.
Operator string one The name of the operator responsible. (Privileged)
CaptureDevice string one The capture device used.
CaptureSoftware string one The capture software used.
SourceCondition string one The condition of the physical source image.
CopyNote string one ?
MimeType string one The MIME type of the digitized image.
ImageBitDepth string one The bit depth of the digitized image.
ImageEditor string one The image editing software used.
ImageResolution string one The resolution of the digitized image.
ImageSize string one The pixel size of the digitized image.
FileSize string one The file size of the digitized image.
ComputerOS string one The operating system used.
Storage string one Image storage details.

The Persons Database (CBÉD)

Queries to the Persons Database may return one or more person objects. The information below describes the properties of this object type.

person

Property name Type Cardinality Description
ID integer one The person identifier (unique within collection).
DateCreated ISO 8601 datetime one The date and time of entry creation.
DateModified ISO 8601 datetime none or one The date and time of most recent modification to entry.
Names name one or many Names associated with the person.
Gender string none or one The person's gender (f or m).
AinmID integer none or one The person's unique identifier in the ainm.ie database.
ViafID integer none or one The person's unique identifier in the VIAF database.
BirthDate date none or one The person's date of birth.
DeathDate date none or one The person's date of death.
BirthCounty county none or one The person's county of birth if born in Ireland.
BirthPlaceIreland locationIreland none or one The person's birth location if born in Ireland.
BirthCountry country none or one The person's country of birth if born outside of Ireland.
BirthPlaceAbroad locationAbroad none or one The person's birth location if born outside of Ireland.
Counties county none or one or many Denotes an Irish administrative county or counties associated with the person.
AddressesIreland locationIreland none or one or many Denotes a location or locations in Ireland associated with the person.
Countries country none or one or many Denotes a country or countries, apart from Ireland, associated with the person.
AddressesAbroad locationAbroad none or one or many Denotes a location or locations outside of Ireland associated with the person.
Occupations occupation none or one or many Occupations associated with the person.

name

Property name Type Cardinality Description
FirstNames string none or one A person's first name(s) and, optionally, middle names or nickname.
Surname string none or one A person's surname.
FullName string one A person's full name, including first names and surname.

occupation

Property name Type Cardinality Description
ID string one The occupation's unique identifier.
NameEN string one The occupation name (in English).
NameGA string one The occupation name (in Irish).

Common entities

A number of entities are common to multiple collections. These are described below.

coordinates

Property name Type Cardinality Description
Latitude double one The latitudinal coordinate.
Longitude double one The longitudinal coordinate.

county

Property name Type Cardinality Description
LogainmID integer one The county's unique identifier in the logainm.ie database.
NameEN string one The county's English-language name.
NameGA string one The county's Irish-language name.
QualifiedNameEN string one The county's English-language name, prefixed with "Co. " qualifier.
QualifiedNameGA string one The county's Irish-language name, prefixed with "Co. " qualifier and having the correct grammatical case and inflection applied.
Coordinates coordinates one A set of geographic coordinates associated with the county.

country

Property name Type Cardinality Description
IsoCode string one The country's unique ISO 3166 country code (see note below).
GeoNameID integer one The country's unique identifier in the geonames.org database.
NameEN string one The country's English-language name.
NameGA string one The country's Irish-language name.
Coordinates coordinates one A set of geographic coordinates associated with the country.

Note: Country codes in the IsoCode property adhere to the ISO 3166-1 standard except for England (GB-ENG), Northern Ireland (GB-NIR), Scotland (GB-SCT) and Wales (GB-WLS) where ISO 3166-2 codes are used. For these countries it was necessary to have greater resolution than the ISO 3166-1 standard provides.

date

Property name Type Cardinality Description
IsoDate ISO 8601 datetime none or one Aggregates the values of the Year, Month and Day properties below in the form of an ISO 8601 datetime string.
IsoStartDate ISO 8601 datetime none or one Aggreates the values of the PeriodStartYear, PeriodStartMonth and PeriodStartDay properties below to represent the start date in a time interval.
IsoEndDate ISO 8601 datetime none or one Aggreates the values of the PeriodEndYear, PeriodEndMonth and PeriodEndDay properties below to represent the end date in a time interval.
IsoDuration ISO 8601 datetime none or one Represents the span of time between the IsoStartDate and IsoEndDate properties, where appropriate.
Accuracy string none or one Indicates the accuracy of the date information using standard MODS date qualifier vocabulary.
Year integer none or one Denotes year in YYYY format.
Month integer none or one Denotes calendar month (values 1-12).
Day integer none or one Denotes day of month (values 1-31).
PeriodStartYear integer none or one Denotes the start year in a time interval in YYYY format.
PeriodStartMonth integer none or one Denotes the start calendar month (values 1-12) in a time interval.
PeriodStartDay integer none or one Denotes the start day of month (values 1-31) in a time interval.
PeriodEndYear integer none or one Denotes the end year in a time interval in YYYY format.
PeriodEndMonth integer none or one Denotes the end calendar month (values 1-12) in a time interval.
PeriodEndDay integer none or one Denotes the end day of month (values 1-31) in a time interval.

Accuracy

This property indicates the accuracy of the date information using standard MODS date qualifier vocabulary.

Value Description
APPROX The date is approximate.
INFER The date is inferred.
QUESTION The date is questionable.

locationAbroad

Property name Type Cardinality Description
GeoNameID integer one The location's unique identifier in the geonames.org database.
NameEN string one The location name (in English).
NameGA string one The location name (in Irish).
Coordinates coordinates one The location's geographical coordinates.
Country country one The country in which the location is situated.

locationIreland

Property name Type Cardinality Description
LogainmID integer one The location's unique identifier in the logainm.ie database.
NameEN string one The location name (in English).
NameGA string one The location name (in Irish).
Coordinates coordinates one The location's geographical coordinates.
Counties county one or many The county or counties in which the location is situated.

transcript

A transcript of material on a manuscript page contributed by members of the Meitheal Dúchas.ie community transcription project. The transcribed material is provided subject to a CC-BY-NC 4.0 licence.

Property name Type Cardinality Description
ID integer one The transcript's unique identifier.
DateCreated ISO 8601 datetime one The date and time of transcript creation.
DateModified ISO 8601 datetime none or one The date and time of most recent modification to transcript.
ItemID integer one Identifies the manuscript item that is transribed.
Approved boolean one Denotes whether the transcription has been approved for publication. Transcripts contributed by junior members of Meitheal Dúchas.ie are unapproved until they are reviewed by a member of the Dúchas editorial team. (Privileged)
Moderated boolean one Denotes whether the transcript has been reviewed by a member of the Dúchas editorial team. (Privileged)
Text string one The transcript text.
Transcribers transcriber none or one or many Metadata regarding the volunteers who contributed to the transcript. This value is empty if the transcription was carried out by anonymous contributors.

transcriber

Property name Type Cardinality Description
ID integer one The transcriber's unique identifier.
Name string none or one The transcriber name. If the transcriber sebequently deleted their account this value is null.

Common values

A number of properties with standardized values are common to multiple collections. These are described below.

status

Specifies the entry's editorial status. Only entries with a status value of 4 are deemed ready for publication.

Value Description
0 The entry is newly ingested.
1 First editorial pass complete.
2 First editorial check complete.
3 Second editorial pass complete.
4 Second editorial check complete.

extraInfoStatus

Specifies the publication status of the extraInfo field.

Value Description
EDIT The extraInfo field, if present, is not suitable for publication.
PUB The extraInfo field, if present, is suitable for publication.