Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This document is in draft and is subject to change.

How to read this document

This document specifies data for the Educational Uses Project projects.  It describes conceptual classes and properties, how data are expressed in Resource Descriptive Framework (RDF), and how they are persisted to a relational database.  For the purposes of our implementation, data that are identical across all instances of a class are not persisted to the database.  Each class has the following specifications:

  • PropertyLabel: A human-readable name or label for the property.
  • RDF property: A recognized RDF property that can be expressed as a URI.
  • DB property: How the property is persisted to a relational database. "Attribute" indicates that this property is persisted as an attribute of the described class.  "Relationship" indicates that this property is persisted as a relationship to another entity in the database.
  • Expected type: The expected data Expected type: The expected data type for the property. 
  • Obligation: The number of allowable values for each property.  Properties that are recommended (but not required) are indicated with a *.
  • Definition: The definition of the property.
  • Notes: Additional information that will help create or format data

 

Classes

AlignmentObject, Author,  Language Guide, Organization Language, Place Organization, PrimarySource Set, PrimarySourceSet Source, Subject, TeachingGuide, TimePeriod SubjectTimePeriod

 

Anchor
AlignmentObject
AlignmentObject

Class:AlignmentObject

DB
PropertyLabelRDF property propertyExpected typeObligationDefinitionNotes
@type@typeN/AURI1RDF type of the alignment objectExpected value: "schema:AlignmentObject"
alignment typealignmentTypeschema:alignmentTypeN/Atext1A category of alignment between the learning resource and the framework node.

Expected value: "requires"

educational frameworkeducationalFrameworkschema:educationalFrameworkN/Atext1The framework to which the resource being described is aligned.

The value for this field should match the label for targetUrl

Example: Format: Common Core State Standards dot notation

Example: "CCSS.ELA-Literacy.RH.6-8.7"

target nametargetNameschema:targetNameN/Atext0-1*The name of a node in an established educational framework.

Expected value: "Common Core State Standard"

targetUrlschema:targetUrlN/AURI0-1*The URL of a node in an established educational framework.

Expected values: "ccss:ELA-Literacy/RH/6-8/7/", "ccss:ELA-Literacy/RH/6-8/7/", "ccss:ELA-Literacy/RH/6-8/9/", "ccss:ELA-Literacy/RH/9-10/9/", "ccss:ELA-Literacy/RH/11-12/7/", "ccss:ELA-Literacy/RH/11-12/9/", "ccss:ELA-Literacy/CCRA/R/7/", "ccss:ELA-Literacy/CCRA/W/8/", "ccss:ELA-Literacy/WHST/6-8/8/", "ccss:ELA-Literacy/WHST/9-10/8/"

*recommended

Anchor
Author
Author

Class:

...

Author

DB typeidN/AUnique id PSS0-*Human-readable slug to be used in the construction of a URL for the PSS@id
PropertyLabelRDF property propertyExpected typeObligationDefinitionNotes
@type@typeattributeURItext1RDF type of the  slugN/AattributeauthorExpected value: "schema:Person"
nameschema:nametext1Name of the author 
affiliation@idN/AURI1Unambiguous URI of the PSS @type@typeN/Aschema:affiliation

Class:Organization

schema:Organization

0-1Organizational affiliation of the author 

*recommended

Anchor
Guide
Guide

Class:Guide

PSSimageimageURI*thumbnailthumnailUrlSmall version of image representing PSSdescriptionschemadescriptiontext1*
LabelRDF propertyExpected typeObligationDefinitionNotes

@id

@idURI1Unambiguous URI of the teaching guide 
@type@typeURI1RDF type of the PSSguideExpected value: "schema:CreativeWork"
nameschema:nameattributetext0-1*Name of the guide 

text

schema:

text

attribute

ontowiki:Markdown

markdown0-1Large version of image representing PSSTextual content of the guide, such as questions and activity 
setschema:isPartOfattributeURI0-1*

Class:Set

schema:CreativeWork

1The primary source set to which this guide belongs 
authorscheme:attributeauthor

Class:Author

schema:Person

0-Brief description of the PSS

Example: "This collection uses primary sources to explore the French and Indian War."

date createdschema:dateCreatedattribute

ISO 8601 date format

(yyyy-mm-dd)

1

Date the PSS was created 
date modifiedschema:dateModifiedattribute

ISO 8601 date format

(yyyy-mm-dd)

0-1Date the PSS was most recently modified 
text

schema:text

ontowiki:Markdown

attribute

markdown

0-1Narrative overview of the PSS

PrimarySourceSet:text and PrimarySourceSet:resources may be concatenated to form a single schema:text field

resources

schema:text

ontowiki:Markdown

attributemarkdown0-1Narrative information regarding resources for further research

Can include links to additional sources and tips for finding related materials in the DPLA

PrimarySourceSet:text and PrimarySourceSet:resources may be concatenated to form a single schema:text field

primary sourceschema:hasPartrelationship

Class:PrimarySource

schema:MediaObject

0-n*Primary sources in the PSS 
teaching guideschema:hasPartrelationship

Class:TeachingGuide

schema:CreativeWork

0-n*Teaching guide associated with the PSS 
subjectschema:aboutrelationship

Class:Subject

schema:Thing

0-n*Educational subject of the PSS 
time perioddct:temporalrelationship

Class:TimePeriod

dct:PeriodOfTime

0-n*Temporal subject of the PSS 
authorschema:authorrelationship

Class:Person

schema:Person

0-n*Author of the PSS 
publisherschema:publisher

N/A

Class:Organization

schema:Organization

0-1Publisher of the PSSThe publisher for all PSS's is DPLA.
languageschema:inLanguageN/A

schema:Language

0-nPrimary language of the PSS 
media typedct:typeN/Adct:DCMIType0-1

The set of classes specified by the DCMI Type Vocabulary, used to categorize the nature or genre of the resource.

 

Expected value: "dcmitype:InteractiveResource"
learning resource typeschema:learningResourceTypeN/Atext0-1Predominant type of kind characterizing the learning resourceExpected value: "Source Set"
interactivity typeschema:interactivityTypeN/Atext0-1Predominant mode of learning supported by the learning resource

Expected value: "Interactive"

Vocabulary: Learning Registry Metadata Initiative suggested terms

licenseschema:licenseN/AURI0-1URL where the owner specifies permissions for using the resource

Expected value: "http://dp.la/info/terms/"

educational alignmentschema:educationalAlignmentN/Aschema:alignmentObject0-nAn alignment to an established educational framework 
accessibility featureschema:accessibilityFeatureN/Atext0-nContent features of the resource, such as accessible media, alternatives and supported enhancements for accessibility

Expected values: "captions", "structuralNavigation", "audioControl", "videoControl"

Vocabulary: Learning Registry Metadata Initiative suggested terms

accessibility hazardschema:accessibilityHazardN/Atext0-nA characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3

Expected values: "noFlashingHazard", "motionSimulation", "noSoundHazard"

Vocabulary: Learning Registry Metadata Initiative suggested terms

accessibility controlschema:accessibilityControlN/Atext0-nIdentifies input methods that are sufficient to fully control the described resource

Expected values: "fullMouseControl"

Vocabulary: Learning Registry Metadata Initiative suggested terms

*recommended

 

Class:PrimarySource

PropertyRDF propertyDB property typeExpected typeObligationDefinitionNotes
idN/A

attribute

text1Unique id of the PS 

@id

@idN/AURI1Unambiguous URI of the PS 
@type@typeN/AURI1RDF type of the PSExpected value: "schema:MediaObject"
nameschema:nameattributetest0-1*Name or brief caption describing the PS 
aggregationdct:referencesattribute

ore:Aggregation (RDF)

URI (DB)

1The DPLA aggregation representing the PS 

thumbnail

schema:thumbnailUrlattributeURI0-1*A thumbnail representation of the PS 
text

schema:text

ontowiki:Markdown

attributemarkdown0-1Narrative description, transcription, citation, or other text describing the PS 
encoding formatschema:encodingFormatattributetext0-1*The format in which the full representation of the PS is encodedExample: "pdf", "mp3", "jpg"
content URLschema:contentUrlattributeURI0-1*A URL pointing to a full representation of the PSThe content URL may be dependent on the authorization status of the user accessing the data. For example, an authorized user may be served the URI for the full representation of the item as hosted by DPLA, while an unauthorized user may be served the value for ore:Aggregation.isShownAt.
primary source setschema:isPartOfrelationship

Class:PrimarySourceSet

schema:CreativeWork

1The primary source set to which this primary source belongs 

*recommended

 

Class:TeachingGuide

PropertyRDF propertyDB property typeExpected typeObligationDefinitionNotes
idN/A

attribute

text1Unique id of the teaching guide 

@id

@idN/AURI1Unambiguous URI of the teaching guide 
@type@typeN/AURI1RDF type of the teaching guideExpected value: "schema:CreativeWork"
nameschema:nameattributetext0-1*Name of the teaching guide 

text

schema:text

ontowiki:Markdown

attributemarkdown0-1Textual content of the teaching guide, such as questions and activity 
primary source setschema:isPartOfrelationship

Class:PrimarySourceSet

schema:CreativeWork

1The primary source set to which this teaching guide belongs 
authorscheme:authorrelationship

Class:Person

schema:Person

0-nThe author of this teaching guide 

*recommended

 

Class:Author

PropertyRDF propertyDB property typeExpected typeObligationDefinitionNotes
idN/A

attribute

text1Unique id of the author 
@type@typeN/AURI1RDF type of the authorExpected value: "schema:Person"
nameschema:nameattributetext1Name of the author 
affiliationschema:affiliation

relationship

Class:Organization

schema:Organization

0-1Organizational affiliation of the author 

*recommended

 

Class:Organization

PropertyRDF propertyDB property typeExpected typeObligationDefinitionNotes
idN/A

attribute

text1Unique id of the organization 
@type@typeN/AURI1RDF type of the organizationExpected value: "schema:Organization"
nameschema:nameattributetext1Name of the organization 
locationschema:locationattribute

Class:Place

schema:Place (RDF)

text (DB)

0-1Location of the organizationIn the database, the value of this field is equivalent to Class:Place.name

*recommended

 

Class:Subject

PropertyRDF propertyDB property typeExpected typeObligationDefinitionNotes
idN/A

attribute

text1Unique id of the subject 
@type@typeN/AURI1RDF type of the subjectExpected value: "schema:Thing"
nameschema:nameattributetext1Name of the subject 
lrmiN/Aattribute

boolean

1If true, the subject is intended for used in the Learning Registry Metadata InitiativeDefault: true
filterN/Aattributeboolean1If true, the subject is intended for use as a filter in the DPLA web interfaceDefault: false

*recommended

 

Class:TimePeriod

PropertyRDF propertyDB property typeExpected typeObligationDefinitionNotes
idN/A

attribute

text1Unique id of the time period 
@type@typeN/AURI1RDF type of the time periodExpected value: "dct:PeriodOfTime"
nameschema:nameattributetext1Name of the time period 
lrmiN/Aattribute

boolean

1If true, the time period is intended for used in the Learning Registry Metadata Initiative as a subject term Default: true
filterN/Aattributeboolean1If true, the time period is intended for use as a filter in the DPLA web interfaceDefault: false 

*recommended

 

Class:Place

PropertyRDF propertyDB propertyExpected typeObligationDefinitionNotes
@type@typeN/AURI1RDF type of the placeExpected value: "schema:Place"
nameschema:nameN/Atext0-1Name of the time place 

*recommended

 

Class:Language

DB
PropertyRDF propertynThe author of this guide 

*recommended

Anchor
Language
Language

Class:Language

LabelRDF propertyExpected typeObligationDefinitionNotes
@type@typeURI1RDF type of the languageExpected value: "schema:Language"
@id@idURI0-1RDF id of the language

Expected value: "http://www.lexvo.org/page/term/eng/English"

Vocabulary: Lexvo

In the future, other languages may be used, but for the time being, the only expected language is English.

nameschema:nametext0-1Name of the language

Expected value: "English"

*recommended

Anchor
Organization
Organization

Class:Organization

LabelRDF propertyExpected typeObligationDefinitionNotes
@type@typeURI1RDF type of the organizationExpected value: "schema:Organization"
nameschema:nametext1Name of the organization 

*recommended

Anchor
PrimarySourceSet
PrimarySourceSet

Class:Set

LabelRDF propertyExpected typeObligationDefinitionNotes

@id

@idURI1Unambiguous URI of the set 
@type@typeURI1RDF type of the setExpected value: "schema:CreativeWork"
nameschema:nametext1Name of the set 
imageschema:imageURI0-1*Large version of image representing set 
thumbnailschema:thumnailUrlURI0-1*Small version of image representing set 
descriptionschema:descriptiontext0-1*Brief description of the set

Example: "This collection uses primary sources to explore the French and Indian War."

dateCreatedschema:dateCreated

ISO 8601 date format

(yyyy-mm-dd)

1

Date the set was created 
dateModifiedschema:dateModified

ISO 8601 date format

(yyyy-mm-dd)

0-1Date the set was most recently modified 
overview

schema:text

ontowiki:Markdown

markdown

0-1Narrative overview of the set

Set:text and Set:resources may be concatenated to form a single schema:text field

resources

schema:text

ontowiki:Markdown

markdown0-1Narrative information regarding resources for further research

Can include links to additional sources and tips for finding related materials in the DPLA

Set:text and Set:resources may be concatenated to form a single schema:text field

sourceschema:hasPart

Class:Source

schema:CreativeWork

0-n*Sources in the set 
guideschema:hasPart

 

Class:Guide

schema:CreativeWork

0-n*Teaching guide associated with the set 
subjectschema:about

Class:Subject

schema:Thing

0-n*Educational subject of the set 
timePerioddct:temporal

Class:TimePeriod

dct:PeriodOfTime

0-n*Temporal subject of the set 
authorschema:author

Class:Author

schema:Person

0-n*Author of the set 
publisherschema:publisher

Class:Organization

schema:Organization

0-1Publisher of the setThe publisher for all set's is DPLA.
languageschema:inLanguage

Class:Language

schema:Language

0-nPrimary language of the set 
mediaTypedct:typedct:DCMIType0-1

The set of classes specified by the DCMI Type Vocabulary, used to categorize the nature or genre of the resource.

 

Expected value: "dcmitype:InteractiveResource"
learningResourceTypeschema:learningResourceTypetext0-1Predominant type of kind characterizing the learning resourceExpected value: "Source Set"
interactivityTypeschema:interactivityTypetext0-1Predominant mode of learning supported by the learning resource

Expected value: "Interactive"

Vocabulary: Learning Registry Metadata Initiative suggested terms

licenseschema:licenseURI0-1URL where the owner specifies permissions for using the resource

Expected value: "http://dp.la/info/terms/"

educationalAlignmentschema:educationalAlignmentschema:alignmentObject0-nAn alignment to an established educational framework 
accessibilityFeatureschema:accessibilityFeaturetext0-nContent features of the resource, such as accessible media, alternatives and supported enhancements for accessibility

Expected values: "captions", "structuralNavigation", "audioControl", "videoControl"

Vocabulary: Learning Registry Metadata Initiative suggested terms

accessibilityHazardschema:accessibilityHazardtext0-nA characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3

Expected values: "noFlashingHazard", "motionSimulation", "noSoundHazard"

Vocabulary: Learning Registry Metadata Initiative suggested terms

accessibilityControlschema:accessibilityControltext0-nIdentifies input methods that are sufficient to fully control the described resource

Expected values: "fullMouseControl"

Vocabulary: Learning Registry Metadata Initiative suggested terms

*recommended

Anchor
Source
Source

Class:Source

LabelRDF propertyExpected typeObligationDefinitionNotes

@id

@idURI1Unambiguous URI of the source 
@type@typeURI1RDF type of the source

Default value: "schema:CreativeWork"

Other possible values: "schema:MediaObject", "schema:AudioObject", "schema:VideoObject", "schema:ImageObject"

@type can be derived from the type property

nameschema:nametext0-1*Name or brief caption describing the source 
aggregationdct:references

ore:Aggregation (RDF)

URI (DB)

1The DPLA aggregation representing the source 

thumbnail

schema:thumbnailUrlURI0-1*A thumbnail representation of the source 
textualContent

schema:text

ontowiki:Markdown

markdown0-1Narrative description, transcription, citation, or other text describing the source 
encodingFormatschema:encodingFormattext0-1*The format in which the full representation of the source is encodedExample: "pdf", "mp3", "jpg"
contentUrlschema:contentUrlURI0-1*A URL pointing to a full representation of the sourceThe content URL may be dependent on the authorization status of the user accessing the data. For example, an authorized user may be served the URI for the full representation of the source as hosted by DPLA, while an unauthorized user may be served the value for ore:Aggregation.isShownAt.
citationdct:bibliographicCitationmarkdown0-1A bibliographic reference to the source

Example:

"National Museum of American History, Kenneth E. Behrig Center. George Washington's Camp Chest. Digital Public Library of America. http://dp.la/primary-source-sets/sets/american-revolution/sources/8."

creditsdct:provenancedct:ProvenanceStatement0-1A statement relating to the ownership of the source

Example: "Courtesy of the University of Michigan via HathiTrust"

setschema:isPartOf

Class:Set

schema:CreativeWork

1The set to which this source belongs 

*recommended

Anchor
Subject
Subject

Class:Subject

LabelRDF propertyExpected typeObligationDefinitionNotes
@type@typeN/AURI1RDF type of the languagesubjectExpected value: "schema:Language"
@id@idN/AURI0-1RDF id of the language

Expected value: "http://www.lexvo.org/page/term/eng/English"

Vocabulary: Lexvo

In the future, other languages may be used, but for the time being, the only expected language is English.

nameschema:nameN/Atext0-1Name of the language

Expected value: "English"

If an @id is given, this field should match the label of the @id

...

Thing"
nameschema:nametext1Name of the subject 

*recommended

Anchor
TimePeriod
TimePeriod

Class:TimePeriod

LabelRDF propertyExpected typeObligationDefinitionNotes
@type@typeURI1RDF type of the time periodExpected value: "dct:PeriodOfTime"
nameschema:nametext1Name of the time period 

*recommended