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.
- 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, Language, Organization, Place, PrimarySource, PrimarySourceSet, Subject, TeachingGuide, TimePeriod
...
| Label | RDF property | DB property type | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|---|---|
| @type | @type | N/A | URI | 1 | RDF type of the alignment object | Expected value: "schema:AlignmentObject" |
| alignmentType | schema:alignmentType | N/A | text | 1 | A category of alignment between the learning resource and the framework node. | Expected value: "requires" |
| educationalFramework | 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" |
| targetName | schema:targetName | N/A | text | 0-1* | The name of a node in an established educational framework. | Expected value: "Common Core State Standard" |
| targetUrl | schema:targetUrl | N/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/" |
...
| Label | 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 | |
| published | N/A | attribute | boolean | 1 | Whether or not the PSS is intended for live publication on the DPLA website. | If true, PSS will be accessible to all users. If false, PSS will only be accessible to authorized users. |
@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." |
| dateCreated | schema:dateCreated | attribute | ISO 8601 date format (yyyy-mm-dd) | 1 | Date the PSS was created | |
| dateModified | 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 PrimarySourceSet: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 PrimarySourceSet:text and PrimarySourceSet:resources may be concatenated to form a single schema:text field |
| primarySource | schema:hasPart | relationship | schema:CreativeWork | 0-n* | Primary sources in the PSS | |
| teachingGuide | schema:hasPart | relationship |
Class:TeachingGuide schema:CreativeWork | 0-n* | Teaching guide associated with the PSS | |
| subject | schema:about | relationship | schema:Thing | 0-n* | Educational subject of the PSS | |
| timePeriod | dct:temporal | relationship | dct:PeriodOfTime | 0-n* | Temporal subject of the PSS | |
| author | schema:author | relationship | Class:Author schema:Person | 0-n* | Author of the PSS | |
| publisher | schema:publisher | N/A | schema:Organization | 0-1 | Publisher of the PSS | The publisher for all PSS's is DPLA. |
| language | schema:inLanguage | N/A | schema:Language | 0-n | Primary language of the PSS | |
| mediaType | 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" |
| learningResourceType | schema:learningResourceType | N/A | text | 0-1 | Predominant type of kind characterizing the learning resource | Expected value: "Source Set" |
| interactivityType | 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:license | N/A | URI | 0-1 | URL where the owner specifies permissions for using the resource | Expected value: "http://dp.la/info/terms/" |
| educationalAlignment | schema:educationalAlignment | N/A | schema:alignmentObject | 0-n | An alignment to an established educational framework | |
| accessibilityFeature | schema:accessibilityFeature | N/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 |
| accessibilityHazard | 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 |
| accessibilityControl | schema:accessibilityControl | N/A | 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 |
...