Data Specifications
- Audrey Altman (Unlicensed)
This document is in draft and is subject to change.
How to read this document
This document specifies data for the Educational Uses 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:
- Label: A label for the property.
- RDF property: A recognized RDF property that can be expressed as a URI.
- 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, Set, Source, Subject, TimePeriod
Class:AlignmentObject
| Label | RDF property | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|---|
| @type | @type | URI | 1 | RDF type of the alignment object | Expected value: "schema:AlignmentObject" |
| alignmentType | schema:alignmentType | text | 1 | A category of alignment between the learning resource and the framework node. | Expected value: "requires" |
| educationalFramework | schema:educationalFramework | 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" |
| targetName | schema:targetName | text | 0-1* | The name of a node in an established educational framework. | Expected value: "Common Core State Standard" |
| targetUrl | schema:targetUrl | 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/" |
*recommended
Class:Author
| Label | RDF property | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|---|
| @type | @type | URI | 1 | RDF type of the author | Expected value: "schema:Person" |
| name | schema:name | text | 1 | Name of the author | |
| affiliation | schema:affiliation | schema:Organization | 0-1 | Organizational affiliation of the author |
*recommended
Class:Guide
| Label | RDF property | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|---|
@id | @id | URI | 1 | Unambiguous URI of the teaching guide | |
| @type | @type | URI | 1 | RDF type of the guide | Expected value: "schema:CreativeWork" |
| name | schema:name | text | 0-1* | Name of the 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
Class:Language
| Label | RDF property | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|---|
| @type | @type | URI | 1 | RDF type of the language | Expected value: "schema:Language" |
| @id | @id | URI | 0-1 | RDF 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. |
| name | schema:name | text | 0-1 | Name of the language | Expected value: "English" |
*recommended
Class:Organization
| Label | RDF property | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|---|
| @type | @type | URI | 1 | RDF type of the organization | Expected value: "schema:Organization" |
| name | schema:name | text | 1 | Name of the organization |
*recommended
Class:Set
| Label | RDF property | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|---|
@id | @id | URI | 1 | Unambiguous URI of the set | |
| @type | @type | URI | 1 | RDF type of the set | Expected value: "schema:CreativeWork" |
| name | schema:name | text | 1 | Name of the set | |
| image | schema:image | URI | 0-1* | Large version of image representing set | |
| thumbnail | schema:thumnailUrl | URI | 0-1* | Small version of image representing set | |
| description | schema:description | text | 0-1* | Brief 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 | 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 Set:text and Set:resources may be concatenated to form a single schema:text field |
| source | schema:hasPart | schema:CreativeWork | 0-n* | Sources in the set | |
| guide | schema:hasPart |
schema:CreativeWork | 0-n* | Teaching guide associated with the set | |
| subject | schema:about | schema:Thing | 0-n* | Educational subject of the set | |
| timePeriod | dct:temporal | dct:PeriodOfTime | 0-n* | Temporal subject of the set | |
| author | schema:author | schema:Person | 0-n* | Author of the set | |
| publisher | schema:publisher | schema:Organization | 0-1 | Publisher of the set | The publisher for all set's is DPLA. |
| language | schema:inLanguage | schema:Language | 0-n | Primary language of the set | |
| mediaType | dct:type | 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" |
| learningResourceType | schema:learningResourceType | text | 0-1 | Predominant type of kind characterizing the learning resource | Expected value: "Source Set" |
| interactivityType | schema:interactivityType | text | 0-1 | Predominant mode of learning supported by the learning resource | Expected value: "Interactive" Vocabulary: Learning Registry Metadata Initiative suggested terms |
| license | schema:license | URI | 0-1 | URL where the owner specifies permissions for using the resource | Expected value: "http://dp.la/info/terms/" |
| educationalAlignment | schema:educationalAlignment | schema:alignmentObject | 0-n | An alignment to an established educational framework | |
| accessibilityFeature | schema:accessibilityFeature | 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 |
| accessibilityHazard | schema:accessibilityHazard | 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 |
| accessibilityControl | schema:accessibilityControl | 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
Class:Source
| Label | RDF property | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|---|
@id | @id | URI | 1 | Unambiguous URI of the source | |
| @type | @type | URI | 1 | 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:name | text | 0-1* | Name or brief caption describing the source | |
| aggregation | 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
Class:Subject
| Label | RDF property | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|---|
| @type | @type | URI | 1 | RDF type of the subject | Expected value: "schema:Thing" |
| name | schema:name | text | 1 | Name of the subject |
*recommended
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