Encoding of files conforming to the letter template

General

The letter template is a customization of the general template, specifically designed for encoding letters. Editors must refer to the general template for all aspects not covered in the letter template (e.g., facsimile, annotations, etc.).

Letter files start with a header:

<?xml version="1.0" encoding="UTF-8"?>
<?editem template="letter"?>
<?xml-model href="https://xmlschema.huygens.knaw.nl/editem-letter.rng" type="application/xml" schematypens="http://relaxng.org/ns/structure/1.0"?>
<?xml-model href="https://xmlschema.huygens.knaw.nl/editem-letter.rng" type="application/xml" schematypens="http://purl.oclc.org/dsdl/schematron"?>

The first line is the so-called XML declaration, used in all editem XML files. The second line declares that the file conforms to the editem letter template. The third and fourth line declare that the file should conform to the editem-letter.rng schema, interpreted both as a RNG schema (third line) and as a Schematron schema (fourth line).

Metadata

In addition to the elements described in the Metadata section of the general template, editors must include a profileDesc element containing a correspDesc element. This correspDesc element describes the actions related to the correspondence (e.g., who sent/received the letter, when, etc.).

The profileDesc element must follow the fileDesc element in the teiHeader and precede the revisionDesc element, if present. The correspDesc element must include one or more correspAction elements with a type attribute describing each of them. The current allowed values for type are sent and received, but more can be added.

Note: In cases where the recipient of a letter is unknown, editors may omit the <correspAction type="received"> element entirely.

Each correspAction may include the following optional elements:

• rs with a type attribute (allowed values are person and org) and a ref attribute. The value of ref must start with #biolist.xml or #orglist.xml respectively, followed by the xml:id of the corresponding person or organization.
• date with a when attribute. The allowed value for the when attribute is a date in the format yyyy-mm-dd. When the date is uncertain, editors may use the attributes notBefore and notAfter to describe the presumed time frame.
• placeName providing a location (e.g., a city or any known place as identified by the editors). If the location is unknown, editors must indicate this by typing 'Unknown' as the content of the element.

Example

<profileDesc>
    <correspDesc>
        <correspAction type="sent">
            <rs ref="biolist.xml#mondriaan_pieter_junior" type="person">Piet Mondriaan</rs>
            <date when="1915-07-01">c. June-July 1915</date>
            placeName>Unknown</placeName>
        </correspAction>
    <correspAction type="received">
            <rs ref="biolist.xml#meester_augustine_de" type="person">Augustine Hermine de Meester-Obreen</rs>
        </correspAction>
    </correspDesc>
</profileDesc>

Structure

Postal Information

The body of the document may contain an ed:postaldiv element that provides postal information about the letter. The ed:postaldiv element must be associated with an xml:id="PD" attribute and may include one or more of the following optional elements:

• pb used to point to a facsimile (see the section pages)
• ed:postmark contains information present on the postmark
• address contains an address encoded as one or more addrLine elements. The address element may be associated with a type attribute with values sender or receiver. Other values may be added.

Example

<postaldiv xml:id="PD">
   <pb f="1v" n="1" facs="#s1v"/>
   <address type="receiver">
       <addrLine>Mejuffrouw J. Zwartendijk.</addrLine>
       <addrLine>Rotterdamsche Kunstkring</addrLine>
       <addrLine>Witte de Withstr. 35</addrLine>
       <addrLine>Rotterdam.</addrLine>
   </address>
   <address type="sender">
       <addrLine>Mondrian</addrLine>
       <addrLine>"de Linden" Laren (Gooi).</addrLine>
   </address>
   <md:postmark>Laren (N.H.) / 23 I 15 / 7-8V</md:postmark>
</postaldiv>

Openers and closers

The body of the letter may include formulations that open and close the letter, encoded as opener and closer elements respectively.

It is, however, also permitted to omit these and encode opening and closing information in p elements.

The opener element is typically placed at the beginning of the letter, immediately underneath the first div/pb, and carries two attributes:

• xml:id identifies the opener and enables referencing from other parts of the edition. The xml:id value must be unique within the document and can be chosen by editors. We recommend using a value that indicates whether the text is original or a translation, along with the language used, as we do for paragraphs:

  • opener xml:id="p.orig.nl.1" n="1"
  • opener xml:id="p.tr.en.1" n="1"

• n is used to number the element, and editors can choose its value (it is usually 1).

The opener element may contain a dateline element, which provides a brief statement indicating the place and date of the letter. This information can be presented as plain text or encoded as placeName and date elements, respectively. Additionally, the the opener may also include a salute element, which contains a salutation or greeting.

Example: opener 1

<opener xml:id="p.nl.1" n="1">
    <dateline>Amsterdam, den 15<hi rend="super">den</hi> October 1892.</dateline>
    <salue>Beste xxxx</salute>
</opener>

Example: opener 2

<opener xml:id="p.nl.1" n="1">
    <dateline><placeName>Amsterdam</placeName>, <date>den 15<hi rend="super">den</hi> October 1892.</date></dateline>
    <salue>Beste xxxx</salute>
</opener>

The closer element is typically placed at the end of the letter, within the last div, and carries two attributes:

• xml:id identifies the closer and enables referencing from other parts of the edition. The xml:id value must be unique within the document and can be chosen by editors. We recommend using a value that indicates whether the text is original or a translation, along with the language used, as we do for paragraphs:

  • closer xml:id="p.orig.nl.1" n="1"
  • closer xml:id="p.tr.en.1" n="1"

• n is used to number the element, and editors can choose its value.

The closer element may include a salute element, which contains a conclusive salutation or greeting, a signed element, indicating the sender's signature and a dateline element, which provides a brief statement of the place and date of the letter. As for the opener, this information can be presented as plain text or encoded as placeName and date elements, respectively.

Example: closer

<closer xml:id="p.nl.4" n="4">
    <salute>Met de meeste hoogachting</salute>
    <signed>Piet Mondriaan.</signed>
    <dateline>Amsterdam, October 1892.</dateline>
</closer>

Post script

It is possible to encode a post script using the postscript element. It must be placed after the closer element and before the closing tag of the div element. The postscript element must include one or more p elements.

Example: post script

<postscript>
    <p xml:id="p.tr.en.5" n="5">PS. I remain here for a week.</p>
</postscript>

Pages

The beginning of a new page is indicated using pb elements as explained in the general template.

However, what is specific for letter is the mandatory attribute f which must be used together with the n and facs attributes described in the general template.

Example: pages

<pb f="1r" n="1" facs="#s1r"/>