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 property. 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, GuideLanguageOrganizationPlaceSetSourceSubjectTimePeriod

...

Class:AlignmentObject

DB type
LabelRDF property propertyExpected typeObligationDefinitionNotes
@type@typeN/AURI1RDF type of the alignment objectExpected value: "schema:AlignmentObject"
alignmentTypeschema:alignmentTypeN/Atexttext1A 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 type1
LabelRDF property propertyExpected typeObligationDefinitionNotesidN/A

attribute

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

Class:Organization

schema:Organization

0-1Organizational affiliation of the author 

...

Anchor
Guide
Guide

Class:Guide

DB type
LabelRDF property propertyExpected typeObligationDefinitionNotes
id

@id

N/A

attribute

text1Unique id of the teaching guide 

@id

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

text

schema:text

ontowiki:Markdown

attribute

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

Class:Set

schema:CreativeWork

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

Class:Author

schema:Person

0-nThe author of this guide 

...

Class:Language

LabelRDF propertyDB property typeExpected typeObligationDefinitionNotes
@type@typeN/AURI1RDF type of the languageExpected 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"

...

Class:Organization

LabelRDF propertyDB property typeExpected typeObligationDefinitionNotes
idN/A

attribute

text1Unique id of the organization 
@type@typeN/A@type@typeURI1RDF type of the organizationExpected value: "schema:Organization"
nameschema:nameattributetext1Name of the organization 

...

Class:Place

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

...

Class:Set

N/Aattributeattributeattributeattribute
LabelRDF propertyDB property typeExpected typeObligationDefinitionNotes
id

@id

N/A

attribute

text@idURI1Unique id Unambiguous URI of the set 
slugN/Aattributetext0-1*Human-readable slug to be used in the construction of a URL for the set 
publishedN/Aattributeboolean1Whether or not the set is intended for live publication on the DPLA website.

If true, set will be accessible to all users. If false, set will only be accessible to authorized users.

Default value: false

@id

@idN/AURI1Unambiguous URI of the set 
@type@type@type@typeURI1RDF type of the setExpected value: "schema:CreativeWork"
nameschema:nametext0-1*Name of the set 
imageschema:imageattributeURI0-1*Large version of image representing set 
thumbnailschema:thumnailUrlURI0-1*Small version of image representing set 
descriptionschema:descriptionattributetext0-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 
text

schema:text

ontowiki:Markdown

attribute

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

attribute

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

Class:Source

schema:CreativeWork

0-n*Sources in the set 
guideschema:hasPartrelationship

 

Class:Guide

schema:CreativeWork

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

Class:Subject

schema:Thing

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

Class:TimePeriod

dct:PeriodOfTime

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

Class:Author

schema:Person

0-n*Author of the set 
publisherschema:publisherN/A

Class:Organization

schema:Organization

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

Class:Language

schema:Language

0-nPrimary language of the set 
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/AeducationalAlignmentschema: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

...

Anchor
Source
Source

Class:Source

DB type

Acceptable values: "image", "audio", "video", "document"

This value will be used to determine how to embed the object in the HTML page.
LabelRDF property propertyExpected typeObligationDefinitionNotes
idN/A

attribute

text1Unique id of the source 

@id

@idN/AURI1Unambiguous URI of the source 
typeN/Aattributetext1Media type of the sourceNotes

@id

@idURI1Unambiguous URI of the source 
@type@typeN/AURI1RDF 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:nameattributetest0-1*Name or brief caption describing the source 
aggregationdct:referencesattribute

ore:Aggregation (RDF)

URI (DB)

1The DPLA aggregation representing the source 

thumbnail

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

schema:text

ontowiki:Markdown

attribute

markdown0-1Narrative description, transcription, citation, or other text describing the source 
encodingFormatschema:encodingFormatattributetext0-1*The format in which the full representation of the source is encodedExample: "pdf", "mp3", "jpg"
contentUrlschema:contentUrlattributeURI0-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.
setschema:isPartOfrelationship

Class:Set

schema:CreativeWork

1The set to which this source belongs 

...

Class:Subject

 
LabelRDF propertyDB property typeExpected typeObligationDefinitionNotesidN/A

attribute

text1Unique id of the subject
@type@typeN/AURI1RDF type of the subjectExpected value: "schema:Thing"
nameschema:nameattributetext1Name of the subject 
filterN/Aattributeboolean1If true, the subject is intended for use as a filter in the DPLA web interfaceDefault: false
nameschema:nametext1Name of the subject 

*recommended

Anchor
TimePeriod
TimePeriod

Class:TimePeriod

DB typeUnique id of the time period
LabelRDF property propertyExpected typeObligationDefinitionNotesidN/A

attribute

text1 
@type@typeN/AURI1RDF type of the time periodExpected value: "dct:PeriodOfTime"
nameschema:nameattributetext1Name of the time period 

...