Data entry guide
Instructions for entering data via the Primary Source Sets app web interface.
Audio, Author, Document, Image, Source, Set, Teaching Guide, Video
Audio
File upload
- Make sure that files have unique names. If a file already exists with the same file name, the existing file will be over-written.
- Wait until the file upload says "100% complete" before navigating away from the page.
- Acceptable file formats: .mp3 .mp2 .mp4a .wav .flac .aif .aiff .wma .mpga .oga .ogg .au .adp .aac .weba
Author
| Label | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|
| Name | text | Required | Name of the author. | Example: "Ella Howard" |
| Affiliation | text | Optional | Organizational affiliation of the author. | Example: "Armstrong State University, Savannah, Georgia" |
Document
File upload
- Make sure that files have unique names. If a file already exists with the same file name, the existing file will be over-written.
- Wait until the file upload says "100% complete" before navigating away from the page.
- Acceptable file formats: .pdf
Image
File upload
- Make sure that files have unique names. If a file already exists with the same file name, the existing file will be over-written.
- Wait until the file upload says "100% complete" before navigating away from the page.
- Acceptable file formats: .jpg .jpeg .png .gif
| Label | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|
| Size | 'large', 'small', or 'thumbnail' | Required | The size of the image. | Large images will be displayed on as the main asset on the source page. Thumbnail images will represent the source on the set page. Small images will represent the set on the landing page. |
| Width | number | Optional | Pixel width of the image. | |
| Height | number | Optional | Pixel height of the image. | |
| Alt text | text | Optional | Alt text for the image. | If left blank, the alt text for the image will default to the source caption. |
Set
Field | Data format | Obligation | Definition | Notes |
|---|---|---|---|---|
| Name | markdown | Required | Name of the set | Example: "The French and Indian War" |
| SEO description | text | Recommended | Brief description of the set. This description is intended for use in SEO - it will appear and in the Learning Registry. | Example: "A set of primary sources exploring the French and Indian War, with accompanying teaching guide." |
| Overview | Optional | Narrative overview of the set. |
| |
| Resources | markdown | Optional | Narrative information regarding resources for further research. Can include links to additional sources and tips for finding related materials in the DPLA. |
|
| Author | choose one or more from menu | Recommended | Author(s) of the set. |
|
Source
| Field | Data format | Obligation | Definition | Notes |
|---|---|---|---|---|
| Caption | markdown | Recommended | Name or brief caption describing the source. | Maximum length: 140 characters Example: "Diary of Major George Washington, 1753" |
| DPLA id | text | Required | The DPLA aggregation representing the source. | Example: "ebc07432a6ba4f864daaddc4ad0a68f9" |
| Citation | markdown | Recommended | A bibliographic citation for the the source. | Example: Washington, George. *The Journal of Major George Washington.* Chicago: The Newberry Library, 1958: page 53. |
| Credits | markdown | Recommended | A statement crediting the hub and contributing institution. | Example: "Courtesy of The University of Michigan via Hathitrust" |
| Description / transcription | markdown | Optional | Narrative description, transcription, citation, or other text describing the source. | |
| Featured | checkbox | Required | If checked, this source's small image will be the featured image for the set. | |
| Main media asset | checkbox | Recommended | The large image, document, audio, or video, that will be features on the source page. | |
| Thumbnail | checkbox | Recommended | The thumbnail image that will be used to represent the source on the set page. | |
| Small image | checkbox | Optional | The small image that will be used to represent the set on the landing page. |
Teaching Guide
| Label | Expected type | Obligation | Definition | Notes |
|---|---|---|---|---|
| Name | markdown | Required | Name of the guide. | Example: "Exploring the French and Indian War" |
Questions | markdown | Recommended | Discussion questions related to the set for use in an educational context. | Example: 1. Choose five days from [British soldier Luke Gridley’s diary](http://dp.la/sets/french-and-indian-war/source/34). From his description, what do we learn about soldiers’ experience of the war? Use the [letter to William Pitt] (http://dp.la/sets/french-and-indian-war/source/35) and the [British history of the war](http://dp.la/sets/french-and- indian-war/source/36) to learn about the British perspective on the war. 2. What do the sources tell us about England's reason for fighting? Are the sources biased? |
| Activity | Optional | Activity related to the set for use in an educational context. |
| |
| Author | choose one or more from menu | Recommended | Author(s) of the guide. | Enter the authors for the teaching guide even if they are the same as the authors for the set. |
Video
File upload
- Make sure that files have unique names. If a file already exists with the same file name, the existing file will be over-written.
- Wait until the file upload says "100% complete" before navigating away from the page.
- Acceptable file formats: .mov .m4v .mp4 .mpeg .mp1 .3gp .3g2 .avi .f4v .flv .h261 .h263 .h264 .jpm .jpgv .asf .wm .wmv .mj2 .ogv .webm .qt .movie .dv