This document is in draft and is subject to change.
How to read this document
...
- Property: 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.
- 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
...
| Property | 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 type | schema:alignmentType | N/A | text | 1 | A category of alignment between the learning resource and the framework node. | Expected value: "requires" |
| educational framework | 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 name | 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/" |
...
| Property | RDF property | DB property type | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|---|---|
| id | N/A | attribute | text | 1 | Unique id of the author | |
| @type | @type | N/A | URI | 1 | RDF type of the author | Expected value: "schema:Person" |
| name | schema:name | attribute | text | 1 | Name of the author | |
| affiliation | schema:affiliation | relationship | schema:Organization | 0-1 | Organizational affiliation of the author |
...
| Property | RDF property | DB property type | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|---|---|
| id | N/A | attribute | text | 1 | Unique id of the organization | |
| @type | @type | N/A | URI | 1 | RDF type of the organization | Expected value: "schema:Organization" |
| name | schema:name | attribute | text | 1 | Name of the organization | |
| location | schema:location | attribute | schema:Place (RDF) text (DB) | 0-1 | Location of the organization | In the database, the value of this field is equivalent to Class:Place.name |
...
| Property | RDF property | DB property type | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|---|---|
| id | N/A | attribute | text | 1 | Unique id of the PS | |
@id | @id | N/A | URI | 1 | Unambiguous URI of the PS | |
| @type | @type | N/A | URI | 1 | RDF type of the PS | Expected value: "schema:MediaObject" |
| name | schema:name | attribute | test | 0-1* | Name or brief caption describing the PS | |
| aggregation | dct:references | attribute | ore:Aggregation (RDF) URI (DB) | 1 | The DPLA aggregation representing the PS | |
thumbnail | schema:thumbnailUrl | attribute | URI | 0-1* | A thumbnail representation of the PS | |
| text | schema:text ontowiki:Markdown | 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 | schema:CreativeWork | 1 | The primary source set to which this primary source belongs |
...
| 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 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 |
| primary source | schema:hasPart | relationship | schema:MediaObject | 0-n* | Primary sources in the PSS | |
| teaching guide | 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 | |
| time period | dct:temporal | relationship | dct:PeriodOfTime | 0-n* | Temporal subject of the PSS | |
| author | schema:author | relationship | 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 | |
| media type | 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 type | schema:learningResourceType | N/A | text | 0-1 | Predominant type of kind characterizing the learning resource | Expected value: "Source Set" |
| interactivity type | 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/" |
| educational alignment | schema:educationalAlignment | N/A | schema:alignmentObject | 0-n | An alignment to an established educational framework | |
| accessibility feature | 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 |
| accessibility hazard | 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 control | 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 |
...
| 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 | schema:CreativeWork | 1 | The primary source set to which this teaching guide belongs | |
| author | scheme:author | relationship | schema:Person | 0-n | The author of this teaching guide |
...