Z652 Digital Libraries, Fall 2023, Section 3874

A course on digital libraries and building digital collections.

View the Project on GitHub jawalsh/z652-Digital-Libraries-FA23

Documentation Lab

Instructions

In this lab, we’ll practice reading documentation and looking for answers to our questions in the following documentation sources:

  1. CollectionBuilder documentation
  2. SUCHO documentation
  3. Alex’s TEI guidelines for archival transcription

Answer the following questions using the documentation above. Turn in your completed Markdown file to the assignment on Canvas. Download a text file copy of the questions here

Collection Builder

For all answers in this section, give the answer and the URL of the page where you found it.

  1. Which fields are required for all items in CollectionBuilder-GH metadata?
  2. What file do you need to edit to add a new page to your navigation bar?
  3. What metadata fields are required to support the map visualization in CollectionBuilder-GH metadata?
  4. What four columns are included in the config-metadata.csv file?
  5. If you wanted a metadata field called “archive” in your metadata field to display as “Holding Institution” in the metadata section of each item’s page, what file would you edit? (Bonus point: what columns of that file would you edit and what text would you input in each column?)
  6. How should the date September 8, 2023 be formatted so that the timeline visualization works?
  7. What column in what file allows you determine whether a field can be used for sorting on the Browse page of your website?
  8. How do you change which metadata fields contribute values to the “Subjects” visualization page?
  9. What three items (keys) are in the YAML front matter of any of the markdown page files?
  10. When filling in “metadata: “ with the name of your metadata sheet on your “_config.yml” file, should you include the file extension?
  11. Which file controls the display options for most of your website?
  12. How can you separate multiple values in a single field in your metadata file?
  13. Find the example code for including a PDF from your collection (with a caption) on one of your interpretive pages (hint: start with the “Feature Includes” page)

SUCHO Metadata

  1. Which metadata fields are always required for a SUCHO item?
  2. What character separates multiple values in Column E and Column F?
  3. Format the name “Yevhen Federovych Stankovych” according to the content guidelines for Creator
  4. What is the cardinality of the field “date?”“
  5. What would be the correctly formatted value for the field “Host Location” for an item held by an institution in Lviv, the capital of Ukraine’s Lviv Oblast?
  6. If you wanted to indicate that you were working on a row in our metadata spreadsheet, how would you do that?

Alex’s TEI guidelines

  1. What tag should be used to indicate deleted text?

  2. When should <damage> be used instead of <gap>?

  3. How would you indicate that a word is repeated in the following code block?

<p>
The quick brown fox jumped over the the lazy dog.
</p>
  1. Which tag is used to enclose an entire list of non-book items and which tag is used to enclose a list of books? Which tag should be used to enclose an individual non-book item, and which tag should enclose an individual book item?