Site Structure & Naming Conventions for Non‐XML Files - LiteratureInContext/LiC-data GitHub Wiki

Typically, each XML file or digital edition will also incorporate facsimile page images and images in notes by pointing to their stored location on AWS. All stable media that we want to ensure is kept live as part of the digital edition must be saved onto the AWS server to ensure that links are less likely to break. Your professor or the site owners will have access to the AWS server for uploading. All files are stored in AWS bucket lic-assets-staging, which houses folders for each of the xml:ids in the collection (see Site Structure & Naming Conventions for XML Files documentation). For instance, any media for Austen’s Northanger Abbey will be housed in a folder titled with the xml:id for that text: austen-northanger-abbey.

Inside each text folder are two sub-folders, one for page images and one for notes. They are called, respectively, “pageImages” and “notes”.

Page Images

All facsimile page images should be stored in the relevant pageImages folder (here, for Willa Cather’s short story, “Paul’s Case”):

In the XML, stored on GitHub, all elements that contain @facs will point to “pageImages/filename.extension”. For instance, page 76 would be encoded as <pb n=”76” facs=”pageImages/76.jpg.”/> The application will resolve the first part of the URL, which in its entirety is https://lic-assets-staging.s3.us-east-1.amazonaws.com/cather-pauls-case/pageImages/76.jpg Note that the URL is composed in part by the unique xml:id for that file—in this case, “cather-pauls-case.”

Notes

If your annotations include images, you will use a similar shorthand. All images related to your edition will be housed in the AWS folder named with the unique xml:id, and then inside the folder “notes.”