This document 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 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
Namespaces | |
---|---|
css | http://www.corestandards.org/ |
dct | http://purl.org/dc/terms/ |
dcmitype | http://purl.org/dc/dcmitype/ |
ore | http://www.openarchives.org/ore/terms/ |
ontowiki | http://ns.ontowiki.net/SysOnt/ |
schema | http://schema.org/ |
Classes
AlignmentObject, Author, Guide, Language, Organization, PlaceSet, PrimarySourceSource, PrimarySourceSet, Subject, TeachingGuide, TimePeriodTimePeriod
Anchor | ||||
---|---|---|---|---|
|
Class:AlignmentObject
PropertyLabel | RDF property | DB property | Expected type | Obligation | Definition | Notes |
---|---|---|---|---|---|---|
@type | @type | N/A | URI | 1 | RDF type of the alignment object | Expected value: "schema:AlignmentObject" |
alignment typealignmentType | schema:alignmentTypeN/A | text | 1 | A category of alignment between the learning resource and the framework node. | Expected value: "requires" | |
educational frameworkeducationalFramework | schema:educationalFramework | N/A | text | 1 | The framework to which the resource being described is aligned. | Format: Common Core State Standards dot notation Example: "CCSS.ELA-Literacy.RH.6-8.7" |
target nametargetName | schema:targetNameN/A | text | 0-1* | The name of a node in an established educational framework. | Expected value: "Common Core State Standard" | |
targetUrl | schema:targetUrlN/A | URI | 0-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 | ||||
---|---|---|---|---|
|
Class:Author
PropertyLabel | RDF property | DB property type | Expected type | Obligation | Definition | Notes | id|||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@type | N/A@type | attributeURI | text | 1 | Unique idRDF type of the author | @type | @type | N/A | URI | 1 | RDF type of the author | Expected Expected value: "schema:Person" | |
name | schema:nameattribute | text | 1 | Name of the author | |||||||||
affiliation | schema:affiliation | relationship | schema:Organization | 0-1 | Organizational affiliation of the author |
*recommended
Anchor | ||||
---|---|---|---|---|
|
Class:
...
Guide
PropertyLabel | RDF property | DBproperty | Expected type | Obligation | Definition | Notes | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@id | @id | URI | 1 | Unambiguous URI of the teaching guide | |||||||||||
@type | @type | N/A | URI | 1 | RDF type of the | languageguide | Expected value: "schema: | LanguageCreativeWork" | |||||||
@idname | @id | N/A | URIschema:name | text | 0-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. | name | schema:name | N/A | text | 0-1 | Name of the language | Expected value: "English"guide | |
text | schema:text ontowiki:Markdown | markdown | 0-1 | Textual content of the guide, such as questions and activity | |||||||||||
set | schema:isPartOf | schema:CreativeWork | 1 | The primary source set to which this guide belongs | |||||||||||
author | scheme:author | schema:Person | 0-n | The author of this guide |
*recommended
Anchor |
---|
...
|
...
|
Class:
...
Language
PropertyLabel | RDF property | DB property type | Expected type | Obligation | Definition | Notes | id|||||
---|---|---|---|---|---|---|---|---|---|---|---|
@type | N/A | attribute | text@type | URI | 1 | Unique idRDF type of the | organization@type | @type | N/Alanguage | Expected value: "schema:Language" | |
@id | @id | URI | 0-1 | RDF type id of the organizationlanguage | Expected value: " schema:Organization" | ||||||
name | schema:name | attribute | text | 1 | Name of the organization | ||||||
location | schema:location | attribute | Class:Place schema:Place (RDF) text (DB)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. | ||||||||
name | schema:name | text | 0-1 | Location Name of the organizationIn the database, the value of this field is equivalent to Class:Place.namelanguage | Expected value: "English" |
*recommended
Anchor | ||||
---|---|---|---|---|
|
Class:
...
Organization
PropertyLabel | RDF property | DB property | Expected type | Obligation | Definition | Notes |
---|---|---|---|---|---|---|
@type | @type | N/A | URI | 1 | RDF type of the placeorganization | Expected value: "schema:PlaceOrganization" |
name | schema:nameN/A | text | 0-1 | Name of the time placeorganization |
*recommended
Anchor | ||||
---|---|---|---|---|
|
Class:
...
Set
PropertyLabel | RDF property | DB property type | Expected type | Obligation | Definition | Notes | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id @id | N/A | attribute | text@id | URI | 1 | Unique id Unambiguous URI of the PSset | |||||||||
@id@type | @id | N/A | URI | 1 | Unambiguous URI of the PS | @type | @type | N/A | URI | @type | URI | 1 | RDF type of the PSset | Expected value: "schema:MediaObjectCreativeWork" | |
name | schema:name | attribute | testtext | 0-1 | *Name | or brief caption describing the PSof the set | |||||||||
image | dctschema: | referencesimage | attribute | ore:Aggregation (RDF) URI (DB) | 1 | The DPLA aggregation representing the PSURI | 0-1* | Large version of image representing set | |||||||
thumbnail | schema: | thumbnailUrlattributethumnailUrl | URI | 0-1* | A thumbnail representation of the PSSmall version of image representing set | ||||||||||
description | schema:description | text | attribute | markdown | 0-1* | Narrative description, transcription, citation, or other text describing the PS | |||||||||
encoding format | schema:encodingFormat | attribute | text | 0-1* | The format in which the full representation of the PS is encoded | Example: "pdf", "mp3", "jpg" | |||||||||
content URL | schema:contentUrl | attribute | URI | 0-1* | A URL pointing to a full representation of the PS | The 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 set | schema:isPartOf | relationship | Class:PrimarySourceSet schema:CreativeWork | 1 | The primary source set to which this primary source belongs |
*recommended
...
Class:PrimarySourceSet
Property | RDF property | DB property type | Expected type | Obligation | Definition | Notes | |
---|---|---|---|---|---|---|---|
id | N/A | attribute | text | 1 | Unique id of the PSS | ||
slug | N/A | attribute | text | 0-1* | Human-readable slug to be used in the construction of a URL for the PSS | ||
@id | @id | N/A | URI | 1 | Unambiguous URI of the PSS | ||
@type | @type | N/A | URI | 1 | RDF type of the PSS | Expected value: "schema:CreativeWork" | |
name | schema:name | attribute | text | 0-1* | Name of the PSS | ||
image | schema:image | attribute | URI | 0-1* | Large version of image representing PSS | ||
thumbnail | schema:thumnailUrl | attribute | URI | 0-1* | Small version of image representing PSS | ||
description | schema:description | attribute | text | 0-1* | Brief description of the PSS | Example: "This collection uses primary sources to explore the French and Indian War." | |
date created | schema:dateCreated | attribute | ISO 8601 date format (yyyy-mm-dd) | 1 | Date the PSS was created | ||
date modified | schema:dateModified | attribute | ISO 8601 date format (yyyy-mm-dd) | 0-1 | Date the PSS was most recently modified | ||
text | schema:text ontowiki:Markdown | attribute | markdown | 0-1 | Narrative overview of the PSS | PrimarySourceSet:text and PrimarySourceSetBrief description of the set | Example: "This collection uses primary sources to explore the French and Indian War." |
dateCreated | schema:dateCreated | ISO 8601 date format (yyyy-mm-dd) | 1 | Date the set was created | |||
dateModified | schema:dateModified | ISO 8601 date format (yyyy-mm-dd) | 0-1 | Date the set was most recently modified | |||
overview | schema:text ontowiki:Markdown | markdown | 0-1 | Narrative 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 | markdown | 0-1 | Narrative 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 | ||
primary source | schema:hasPartrelationship | schema:MediaObjectCreativeWork | 0-n* | Primary sources Sources in the PSSset | |||
teaching guide | schema:hasPartrelationship |
schema:CreativeWork | 0-n* | Teaching guide associated with the PSSset | |||
subject | schema:aboutrelationship | schema:Thing | 0-n* | Educational subject of the PSSset | |||
time periodtimePeriod | dct:temporal | relationship | dct:PeriodOfTime | 0-n* | Temporal subject of the PSSset | ||
author | schema:authorrelationship | schema:Person | 0-n* | Author of the PSSset | |||
publisher | schema:publisher | N/A | schema:Organization | 0-1 | Publisher of the PSSset | The publisher for all PSSset's is DPLA. | |
language | schema:inLanguageN/A | schema:Language | 0-n | Primary language of the PSSset | |||
media typemediaType | dct:type | N/A | dct:DCMIType | 0-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 typelearningResourceType | schema:learningResourceTypeN/A | text | 0-1 | Predominant type of kind characterizing the learning resource | Expected value: "Source Set" | ||
interactivity typeinteractivityType | schema:interactivityType | N/A | text | 0-1 | Predominant mode of learning supported by the learning resource | Expected value: "Interactive" Vocabulary: Learning Registry Metadata Initiative suggested terms | |
license | schema:licenseN/A | URI | 0-1 | URL where the owner specifies permissions for using the resource | Expected value: "http://dp.la/info/terms/" | ||
educational alignmenteducationalAlignment | schema:educationalAlignment | N/A | schema:alignmentObject | 0-n | An alignment to an established educational framework | ||
accessibility featureaccessibilityFeature | schema:accessibilityFeatureN/A | text | 0-n | Content 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 hazardaccessibilityHazard | schema:accessibilityHazard | N/A | text | 0-n | A 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 controlaccessibilityControl | schema:accessibilityControlN/AaccessibilityControl | text | 0-n | Identifies input methods that are sufficient to fully control the described resource | Expected values: "fullMouseControl" Vocabulary: Learning Registry Metadata Initiative suggested terms |
*recommended
Anchor | ||||
---|---|---|---|---|
|
Class:
...
Source
PropertyLabel | RDF property | DB property typeExpected type | Obligation | Definition | Notes | |||
---|---|---|---|---|---|---|---|---|
id @id | N/A@id | attributeURI | text | 1 | Unique id Unambiguous URI of the subjectsource | |||
@type | @type | N/AURI | 1 | RDF type of the subject | Expected value: "schema:Thing"RDF 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 | ||
name | schema:nameattribute | text | 0-1* | Name of the subjector brief caption describing the source | ||||
lrmi | N/A | attribute | boolean | 1 | If true, the subject is intended for used in the Learning Registry Metadata Initiative | Default: true | ||
filter | N/A | attribute | boolean | 1 | If true, the subject is intended for use as a filter in the DPLA web interface | Default: false |
*recommended
...
Class:TeachingGuide
Property | RDF property | DB property type | Expected type | Obligation | Definition | Notes | ||||
---|---|---|---|---|---|---|---|---|---|---|
id | N/A | attribute | text | 1 | Unique id of the teaching guide | |||||
@id | @id | N/A | URI | 1 | Unambiguous URI of the teaching guide | |||||
@type | @type | N/A | URI | 1 | RDF type of the teaching guide | Expected value: "schema:CreativeWork" | ||||
name | schema:name | attribute | text | 0-1* | Name of the teaching guide | |||||
text | schema:text ontowiki:Markdown | attribute | markdown | 0-1 | Textual content of the teaching guide, such as questions and activity | |||||
primary source set | schema:isPartOf | relationship | Class:PrimarySourceSet schema:CreativeWork | 1 | The primary source set to which this teaching guide belongs | |||||
author | scheme:author | relationship | Class:Person schema:Person | 0-n | The author of this teaching guideaggregation | dct:references | ore:Aggregation (RDF) URI (DB) | 1 | The DPLA aggregation representing the source | |
thumbnail | schema:thumbnailUrl | URI | 0-1* | A thumbnail representation of the source | ||||||
textualContent | schema:text ontowiki:Markdown | markdown | 0-1 | Narrative description, transcription, citation, or other text describing the source | ||||||
encodingFormat | schema:encodingFormat | text | 0-1* | The format in which the full representation of the source is encoded | Example: "pdf", "mp3", "jpg" | |||||
contentUrl | schema:contentUrl | URI | 0-1* | A URL pointing to a full representation of the source | The 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. | |||||
citation | dct:bibliographicCitation | markdown | 0-1 | A 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." | |||||
credits | dct:provenance | dct:ProvenanceStatement | 0-1 | A statement relating to the ownership of the source | Example: "Courtesy of the University of Michigan via HathiTrust" | |||||
set | schema:isPartOf | schema:CreativeWork | 1 | The set to which this source belongs |
*recommended
Anchor |
---|
...
|
...
|
Class:
...
Subject
PropertyLabel | RDF property | DB property type | Expected type | Obligation | Definition | Notes | id | N/A | attribute | text | 1 | Unique id of the time period | Definition | Notes | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@type | @type | N/A | URI | 1 | RDF type of the time periodsubject | Expected value: "dctschema:PeriodOfTimeThing" | |||||||||
name | schema:nameattribute | text | 1 | Name of the time period | |||||||||||
lrmi | N/A | attribute | boolean | 1 | If true, the time period is intended for used in the Learning Registry Metadata Initiative as a subject term | Default: true | |||||||||
filter | N/A | attribute | boolean | 1 | If true, the time period is intended for use as a filter in the DPLA web interface | Default: false subject |
*recommended
Anchor | ||||
---|---|---|---|---|
|
Class:TimePeriod
Label | RDF property | Expected type | Obligation | Definition | Notes |
---|---|---|---|---|---|
@type | @type | URI | 1 | RDF type of the time period | Expected value: "dct:PeriodOfTime" |
name | schema:name | text | 1 | Name of the time period |
*recommended