Markup Clean Up, Lemma, and Critical Apparatus - HeardLibrary/corpus-baudelaire GitHub Wiki

Markup Clean Up

  • Verify that File name and idno are correct.
  • Remove all encoding related to meter and rhyme
  • In teiHeader - Title of poem should be in all caps
  • Div, remove poem number (if any) and use the following structure
   <div type="poem" subtype="if applicable">
  • Title in head should use the following structure
  <head>
      <title type="main"></title>
      <title type="sub">Use this for a subtitle/dedication</title>
   </head>
  • For line groups and lines
   <lg type="stanza" subtype="quatrain/etc" n="">
      <l n=""></l>
   </lg>
  • Update wording in the ``elemnt of``` in the TEI Header

Wording Previously Used

<respStmt>
          <resp>Encoded by</resp>
          <name xml:id="VUCB">Vandebilt University Corpus-Baudelaire(VUCB) TEAM</name>
</respStmt>

Changes to wording in the <resp> element, where "Encoded by" will be replaced by "Basic Markup" so that the updated <respStmt> will read as follows

<respStmt>
          <resp>Basic Markup</resp>
          <name xml:id="Insert XML ID">Insert Name Here</name>
</respStmt>

Special wording will also be use for encoders working on the critical apparatus and peer review. See below

  • Markup for Poems with Multiple part

Lemma

  • Find the lemma edition (see editions folder) in which your poem was first published.
  • Bring the text of your poem in line with the text of the lemma edition.
    • Also review capitalization, punctuation, accents, and spelling.
  • Working with Special characters -
    • You will need to replicate an special characters included in the lemma text. This could range from an em dash (—) to typographical ligatures such as œ for oe in words like œil. Those working on Windows machines can use the character map to insert these characters, and something similar exists for Mac users. An alternate resource for special characters is available here: http://copypastecharacter.com/all-characters

Critical Apparatus

  • Identify all editions that contain your poem, lemma and subsequent editions (see editions folder for copies of texts).
  • Compare all published versions of your poem and identify any differences.
    • In addition to the text, also review capitalization, punctuation, accents and spelling.
  • Make updates to the witnesses in the TEI header
    • All editions of the Fleurs du Mals are represented in the header as witnesses (there are four represented). For any edition in which your poem does not appear, delete the corresponding witness. To clarify, only editions in which your poem has appeared should be listed as a witness in the TEI header.
  • Add a <respStmt> element to TEI header to indicate your role in encoding the critical apparatus. Note contents of <resp> element. See following example:
<respStmt>
          <resp>Critical Apparatus</resp>
          <name xml:id="Insert XML ID">Insert Name Here</name>
</respStmt>

Special circumstances regarding the <respStmt> element. If an encoder is responsible for the Basic Markup and the Critical Apparatus the <respStmt> should appear as follows:

<respStmt>
                    <resp>Basic Markup</resp>
                    <name xml:id="RVR">Ramona V. Romero</name>
                </respStmt>
                <respStmt>
                    <resp>Critical Apparatus</resp>
                    <name ref="#RVR">Ramona V. Romero</name>
                </respStmt>

Note the use of the ref attribute in the <name> element of the second <respStmt>

Peer Review

  • Once the Critical Apparatus has been completed the poem is must go through a peer review process before being declared done.
  • The person responsible for encoding the critical apparatus for a given poem cannot be responsible for reviewing the same poem. The peer review must be done by a second party.
  • The reviewer is responsible for verifying the accuracy of the contents of the TEI header, the basic poem markup and the encoding of the critical apparatus.
  • The reviewer must add a <respStmt> element to TEI header. Note contents of <resp> element. See following example:
<respStmt>
          <resp>Review</resp>
          <name xml:id="Insert XML ID">Insert Name Here</name>
</respStmt>

Special circumstances regarding the <respStmt> element. If an encoder is responsible for the Basic Markup and/or Critical Apparatus and the Review the <respStmt> should appear as follows:

                <respStmt>
                    <resp>Basic Markup</resp>
                    <name xml:id="RVR">Ramona V. Romero</name>
                </respStmt>
                <respStmt>
                    <resp>Critical Apparatus</resp>
                    <name ref="#RVR">Ramona V. Romero</name>
                </respStmt>
                <respStmt>
                    <resp>Review</resp>
                    <name ref="#RVR">Ramona V. Romero</name>
                </respStmt>

Note the use of the ref attribute in the <name> element of the second and third <respStmt>

##Peer Review Checklist## ###Header###

  • Make sure title is in ALL CAPS.
  • Add <respStmt> for Review.
  • Review witnesses and make sure that any witnesses not relevant to the poem have been deleted.
  • Make sure the <idno> element matches the file name.

###Body###

  • Review structural features of poem
    • Each <body> element should be followed by a <div> element that encloses the entire poem.
    • Check numbering of poems and stanzas and lines.
    • <lg> elements around stanzas should have attribute type="stanza", particular types of stanzas should be notes in a subtype attribute.
    • Review formatting of <head> and <title> elements. Main titles should all include a type="main" attribute.
  • Review each <app> element
    • Look for anything missed by previous coders
  • Be on the watch for invalid code or improperly coded content.
⚠️ **GitHub.com Fallback** ⚠️