Front Matter Documentation Feedback

>>Return to testing instructions: Feedback_on_the_Best_Practices_for_TEI_in_Libraries_ODD_Documentation_and_Schemas

Tester: Melanie Schlosser

Comments/Feedback

• In the ODD HTML file, sections 4.1 and 4.1.8 are missing their section headers, which messes up the ToC. The title for 4.1 is, presumably, "The TEI Header," but I couldn't figure out what the title for 4.1.8 is supposed to be. The content in that section isn't in the wiki documentation.
• Formatting/rendition issues in the ODD HTML
  • Quotation marks in examples sometimes display incorrectly. Sometimes they are rendered as a vertical bar (Example: 3.2.1.), and sometimes they cause a new paragraph to start (Example: 4.1.2)
  • Missing paragraph breaks. This happens most often in the table with the element and attribute recommendations, but it also happens all through sections 4.1.3-4.1.5.
  • Table formatting
    • The tables don't have borders between cells, which would make them easier to read
    • Almost all of the text formatting inside the table cells is wonky, including paragraph breaks, lists, and more. The first good example is in the element recommendations table under <title type=" ">
• In the Introduction, the table that briefly describes the encoding levels is somewhat confusing - mostly because of the third column ("Example of encoding of Alger Hiss document"). This isn't explained previously, and the links in that column take you to page images, not markup. A couple sentences explaining what that column is would be helpful.
• These are the same in the wiki documentation, but I found a few instances of typos or unclear wording:
  • Section 2 (Relationship to TEI Tite): At the end of the first sentence, 'organization' should be 'organizations.'
  • In the second paragraph of that same section, it talks about "mass digitization of born-digital source documents." What does that mean?
  • In section 4.1.1 (Reference), in the first sentence, "It is just one specification group that is used be each of the..." Huh?

Tester: Kevin Hawkins

Comments/Feedback

• Change:

While seamless interoperability of texts created by different organizations is an unobtainable goal, use of a common markup vocabulary and syntax greatly aids interchange.

to:

While seamless interoperability of texts created for different purposes is an elusive goal, use of a common markup vocabulary and syntax greatly aids interchange.

• Revise section on hyphenation to replace use of @type with @break, using the values for this attribute given in section 3.2.2 of P5. (This was all significantly revised in P5 after we wrote this section of the BP.)

• Change:

Use to document classification schemes used in the header or body of the TEI document.

to:

Use to document classification schemes and controlled vocabularies referenced by a @scheme attribute elsewhere in the header or body of the TEI document.

• Change:

If the child <term> elements contain terms from a controlled vocabulary, indicate that controlled vocabulary through the scheme attribute. The value of the scheme attribute corresponds to a classification scheme defined previously in <classDecl>.

to

The value of the @scheme attribute is a URI for a controlled or uncontrolled vocabulary. The URI may be absolute to a version online or to one defined previously in <classDecl>.

(If ticket 3270147 is resolved to say that @scheme is actually optional, then add a note that @scheme is required.

Tester: Enter Your Name

Comments/Feedback

• List feedback, problems encountered, etc. in bulleted list form. Provide detailed examples please so that we may make corrections more easily.
• Feedback
• Feedback