Home
Reference
Reference information on editorial practices, TEI-encoding standards, and image sources.
TEI Style Manual
TEI encoding practices for the Knowledge Project.
Cross References
Encoding for cross references, planned for v2.

Reference
Reference information on editorial practices, TEI-encoding standards, and image sources.
- Editorial standards
  The following editorial principles are employed in creating this digital edition.
- Image Sources
  Bibliographic information on image sources.
- Naming Conventions
  Lists the naming conventions we use for editions, sections, folders, and files.
- TEI Style Manual
  TEI encoding practices for the Knowledge Project.
  - Author Names
    Encoding author initials at the end of entries.
  - Bidirectional Text
    Managing Hebrew and Arabic Text
  - Callouts
    How to encode callouts included in the text from the 11th ed. supplied by Project Gutenberg.
  - Citation, Drama, Speech, and Verse
    Encoding elements for verse and drama passages, planned for v2.
  - Cross References
    Encoding for cross references, planned for v2.
  - Entry Terms
    Encoding entry terms.
  - Foreign Text
    Tagging words or phrases in a different language, planned for v2.
  - Formulas
    Encoding math and chemical formulas in TEI, planned for v2.
  - Images
    Treatment of images in EB11 files from Project Gutenberg.
  - Lists
    Formatting lists in TEI
  - Music
    Encoding musical notes and staffs, planned for v2.
  - Notes
    TEI encoding of foot- and marginal notes.
  - Page Numbers
    Specifies encoding method for page numbers in TEI.
  - Source Text Problems
    Indicate where text in the print edition is missing, illegible, or apparently incorrect.
  - Subdivisions
    Encoding for subdivisions in entries, planned for v2.
  - TEI tag
    Encoding instructions for the TEI tag
  - Typographical Values
    TEI encoding we use for semantically significant typographical features, with their CSS equivalents.
- Unicode Characters
  List of Unicode characters and entities used frequently in the Encyclopedia and not on the standard US keyboard.

Cross References

Encoding for cross references, planned for v2.

TEI provides three elements for cross references that we use.

<xr> (cross-reference phrase) contains a phrase, sentence, or icon referring the reader to some other location in this or another text. May contain character data and phrase-level elements; usually contains a <ref> or a <ptr> element. This element encloses both the actual indication of the location referred to, which may be tagged using the <ref> or <ptr> elements, and any accompanying material which gives more information about why the reader is being referred there.
<ref> (reference) defines a reference to another location, possibly modified by additional text or comment.
<ptr> (pointer) empty element that defines a pointer to another location. Cannot contain any additional text (so generally unsuitable for Nineteenth-Century Knowledge Project cross references).
@target specifies the destination of the reference by supplying one or more URI references.

Usage of the <xr> is preferred (example 1), to capture the context of the cross reference. Where that is not feasible, using a <ref> element alone is legitimate (example 2).

<xr>See especially <ref target="#SEC12">section 12 on page 34</ref>.</xr>
See <ref target="kp-eb0703-0123-0095-01">Shipbuilding</ref>.