Customization Assignment

What to Submit:

You will submit four documents this time:

  1. Schema: The .rng file that you customized using Roma Beta.
  2. Proof of Concept:  A valid XML file associated with your .rng file, containing a sample section of encoded text. This file proves that your schema can be used to encode a text and produce a valid file.
  3. Documentation as ODD: Your ODD file, downloaded from Roma Beta.
  4. Values Taxonomy: A document  (.docx, .xml, .txt, .odt, or .xslx) in which you list the values you will allow (or require) for which attributes on which elements. I want this document so that I can determine if you successfully translated your taxonomy into the customization.

1. Making Your RELAX NG Schema

Use Roma Beta (https://romabeta.tei-c.org/) to build up a minimal schema for your encoding project. Select the elements and attribute classes that you need. Exclude any attributes that you don’t need.

Requirements:

  • Your schema must include all the elements you are going to need if you scale up this project (e.g., from one sonnet to 154 sonnets, one screenplay to 25 screenplays).
  • Your schema must include at least the minimal teiHeader elements.
  • Your schema must include only the attributes you want encoders to use.
  • Your schema must include your custom values.
  • Name files in logical ways
  • Save your schema to a folder that you can zip up.

2. Making your valid XML file (your proof-of-concept)

Create an XML file. Save it to the same folder as your .rng file. Associate it with your schema.

Requirements for your prototype XML file:

  • The file must be valid against your schema.
  • Include at least a minimal teiHeader.
  • Add a section of sample text (e.g., at least a single quatrain).
  • Encode at least one structural element (e.g., <div>, <p>, <ab>, <lg>).
  • Encode at least one attribute and one value.

3. ODD file.

Write a robust paragraph describing your customization. Submit what you download from Roma Beta (unless you want to edit the ODD file after you download it and then regenerated it using the ODD processor and the TEI Oxygen Plug-in).

4. Taxonomy of Values

I’m giving you the option to present your taxonomy however you like: a .docx or .odt or .txt file, an XML (encoded in the Balisage customization of DocBook), or a spreadsheet. Ultimately, these values have to be included in your schema but you also want to document them. You are beginning the process of writing documentation.

Requirements:

  • At least one set of values must allow you to describe a structural element.
  • At least one set of values must allow you to capture information relevant to your research questions.
  • Indicate clearly which values go on which attributes, and which elements take those attributes. (A table or a spreadsheet will be helpful here.)