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

...

  • Label: A 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 type for the propertyExpected 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, GuideLanguageOrganizationPlaceSetPrimarySourcePrimarySourceSetSourceSubjectTeachingGuideTimePeriod

 

Anchor
AlignmentObject
AlignmentObject

Class:AlignmentObject

LabelRDF propertyDB property typeExpected typeObligationDefinitionNotes
@type@typeN/AURI1RDF type of the alignment objectExpected value: "schema:AlignmentObject"
alignmentTypeschema:alignmentTypeN/Atext1A category of alignment between the learning resource and the framework node.

Expected value: "requires"

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

Format: Common Core State Standards dot notation

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

targetNameschema: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/"

...

Anchor
Author
Author

Class:Author

DB typeUnique id of the author
LabelRDF property propertyExpected typeObligationDefinitionNotesidN/A

attribute

text1 
@type@typeN/AURI1RDF type of the authorExpected value: "schema:Person"
nameschema:nameattributetexttext1Name of the author 
affiliationschema:affiliationrelationship

Class:Organization

schema:Organization

0-1Organizational affiliation of the author 

*recommended

Anchor
LanguageGuideLanguage
Guide

Class:

...

Guide

DB property typeN/A languageLanguage
LabelRDF propertyExpected typeObligationDefinitionNotes

@id

@idURI1Unambiguous URI of the teaching guide 
@type@typeURI1RDF type of the guideExpected value: "schema:CreativeWork"
@idname@idN/AURIschema:nametext0-1*RDF id Name 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"

*recommended

...

Class:Organization

LabelRDF propertyDB property typeExpected typeObligationDefinitionNotes
idN/A

attribute

text1Unique id of the organization 
@type@typeN/Aguide 

text

schema:text

ontowiki:Markdown

markdown0-1Textual content of the guide, such as questions and activity 
setschema:isPartOf

Class:Set

schema:CreativeWork

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

Class:Author

schema:Person

0-nThe author of this guide 

*recommended

Anchor
Language
Language

Class:Language

LabelRDF propertyExpected typeObligationDefinitionNotes
@type@typeURI1RDF type of the organizationlanguageExpected value: "schema:OrganizationLanguage"
name@idschema:name@idattributeURItext0-1Name RDF id of the organization locationschema:locationattribute

Class:Place

schema:Place (RDF)

text (DB)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-1Location Name of the organizationIn the database, the value of this field is equivalent to Class:Place.namelanguage

Expected value: "English"

*recommended

Anchor
PlaceOrganizationPlace
Organization

Class:

...

Organization

DB property
LabelRDF propertyExpected typeExpected typeObligationDefinitionNotes
@type@typeN/AURI1RDF type of the placeorganizationExpected value: "schema:PlaceOrganization"
nameschema:nameN/Atext0-1Name of the time placeorganization 

*recommended

Anchor
PrimarySourcePrimarySourceSetPrimarySource
PrimarySourceSet

Class:

...

Set

DB property type test0-* or brief caption describing the primary sourceaggregationdctreferencesThe DPLA aggregation representing the primary sourcethumbnailUrlattributeA thumbnail representation of the primary sourcetexttext

ontowiki:Markdown

markdown
LabelRDF propertyExpected typeObligationDefinitionNotesidN/A

attribute

text1Unique id of the primary source

@id

@idN/AURI1Unambiguous URI of the primary sourceset 
@type@typeN/AURIURI1RDF type of the primary sourcesetDefault Expected value: "schema:MediaObject"Other possible values: "schema:AudioObject", "schema:VideoObject", "schema:ImageObjectCreativeWork"
nameschema:nameattributetext1Name of the set 
imageschema:imageattribute

ore:Aggregation (RDF)

URI (DB)

1URI0-1*Large version of image representing set 
thumbnailschema:thumnailUrlURI0-1*Small version of image representing set 
descriptionschema:attributedescriptiontext0-1*Narrative description, transcription, citation, or other text describing the primary source 
encodingFormatschema:encodingFormatattributetext0-1*The format in which the full representation of the primary source is encodedExample: "pdf", "mp3", "jpg"
contentUrlschema:contentUrlattributeURI0-1*A URL pointing to a full representation of the primary 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 item as hosted by DPLA, while an unauthorized user may be served the value for ore:Aggregation.isShownAt.
primarySourceSetschema:isPartOfrelationship

Class:PrimarySourceSet

schema:CreativeWork

1The primary source set to which this primary source belongs 

*recommended

...

Class:PrimarySourceSet

LabelRDF propertyDB property typeExpected typeObligationDefinitionNotes
idN/A

attribute

text1Unique id of the PSS 
slugN/Aattributetext0-1*Human-readable slug to be used in the construction of a URL for the PSS 

@id

@idN/AURI1Unambiguous URI of the PSS 
@type@typeN/AURI1RDF type of the PSSExpected value: "schema:CreativeWork"
nameschema:nameattributetext0-1*Name of the PSS 
imageschema:imageattributeURI0-1*Large version of image representing PSS 
thumbnailschema:thumnailUrlattributeURI0-1*Small version of image representing PSS 
descriptionschema:descriptionattributetext0-1*Brief description of the PSS

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

dateCreatedschema:dateCreatedattribute

ISO 8601 date format

(yyyy-mm-dd)

1

Date the PSS was created 
dateModifiedschema:dateModifiedattribute

ISO 8601 date format

(yyyy-mm-dd)

0-1Date the PSS was most recently modified 
text

schema:text

ontowiki:Markdown

attributeBrief 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 PSSset

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

resources

schema:text

ontowiki:Markdown

attribute

markdown0-1Narrative information regarding resources for further research

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

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

primarySourcesourceschema:hasPartrelationship

Class:PrimarySourceSource

schema:MediaObjectCreativeWork

0-n*Primary sources Sources in the PSSset 
teachingGuideguideschema:hasPartrelationship

 

Class:TeachingGuideGuide

schema:CreativeWork

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

Class:Subject

schema:Thing

0-n*Educational subject of the PSSset 
timePerioddct:temporalrelationship

Class:TimePeriod

dct:PeriodOfTime

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

Class:Author

schema:Person

0-n*Author of the PSSset 
publisherschema:publisher

N/A

Class:Organization

schema:Organization

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

Class:Language

schema:Language

0-nPrimary language of the PSSset 
mediaTypedct: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"
learningResourceTypeschema:learningResourceTypeN/Atext0-1Predominant type of kind characterizing the learning resourceExpected value: "Source Set"
interactivityTypeschema: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/"

educationalAlignmentschema:educationalAlignmentN/Aschema:alignmentObject0-nAn alignment to an established educational framework 
accessibilityFeatureschema: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

accessibilityHazardschema: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

accessibilityControlschema: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

Anchor
SubjectSourceSubject
Source

Class:

...

Source

DB type
LabelRDF property propertyExpected 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:TeachingGuide

The author of this teaching guide
LabelRDF 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 
primarySourceSetschema:isPartOfrelationship

Class:PrimarySourceSet

schema:CreativeWork

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

Class:Author

schema:Person

0-nDefinitionNotes

@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 propertyDB property typeExpected typeObligationDefinitionNotesidN/A

attribute

text1Unique id of the time periodDefinitionNotes
@type@typeN/AURI1RDF type of the time periodsubjectExpected value: "dctschema:PeriodOfTimeThing"
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 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