diff --git a/modules/lib/frus-toc.xsl b/modules/lib/frus-toc.xsl index ec0fb333f..6ea09b0b6 100644 --- a/modules/lib/frus-toc.xsl +++ b/modules/lib/frus-toc.xsl @@ -9,7 +9,7 @@ - + @@ -29,10 +29,10 @@ - + - + diff --git a/schema/frus-tei-guidelines.html b/schema/frus-tei-guidelines.html index 82d024f58..e43d36d5b 100644 --- a/schema/frus-tei-guidelines.html +++ b/schema/frus-tei-guidelines.html @@ -1,4 +1,4 @@ -FRUS TEI Guidelines

FRUS TEI Guidelines

1. Introduction

This document is a set of encoding guidelines for the digital edition of the Foreign Relations of the United States (FRUS) series, the official documentary history of U.S. foreign relations. The basis for encoding FRUS is the Text Encoding Initiative (see tei-c.org for the complete TEI P5 Guidelines). This document describes the project-specific subset of the TEI standard and practices used for encoding FRUS, hereafter called FRUS TEI. The primary purpose of FRUS TEI is to accurately and canonically encode the text of the publication and capture its core structural features, including document headings, datelines, paragraphs, footnotes, page numbers, tables, figures, and indexes. Besides capturing these structural features, each volume is enhanced with by identifying all cross references within the series and encoding them as hyperlinks to facilitate reading. Once encoded according to these guidelines, a FRUS TEI document should validate against the FRUS TEI schema without errors and thus will be compatible with tools for electronically publishing and analyzing the FRUS digital archive, including the Office of the Historian website, ebook catalogs, data feeds, and APIs. These guidelines, written in TEI using the ODD (One Document Does it all) format, provide the following information:

  • Prose descriptions, supplemented with visual aids, of how to encode every feature of FRUS volumes
  • An appendix containing full documentation for every TEI element and attribute that is allowed FRUS TEI
  • A set of XML schema derived from this document that can be used to validate that a given file is valid FRUS TEI, or if not, where the problems lie

Although this guide cannot anticipate every situation encoders will encounter, its design allows for new sections or examples to be added as circumstances demand. The discretion to add to or alter this guide lies solely with the Chief of the Division of Publishing.

Table of contents

2. Terminology

  • The Foreign Relations of the United States (FRUS) Series: An official U.S. Government serial publication started in 1861 and published more-or-less continuously since then, with nearly 500 books to date, constituting the official documentary history of U.S. foreign relations. While the first books were titled variously, e.g., "Message of the President of the United States to the Two Houses of Congress," "Papers Relating to Foreign Affairs, Accompanying the Annual Message of the President," and "Papers Relating to the Foreign Relations of the United States," the series acquired its current name with the publications in the late 1940s covering the 1930s. While the early volumes were published the year following the events described in the book, the series gradually fell behind current events. Now, under a law passed in 1991, volumes must be published 30 years after the events they describe. Another important change was the transition from an annual (in the 1861-1951 volumes) to a triennial (in the 1952-1960 volumes) to a presidential administration-based organization (since 1961).
  • Volume: A book in the Foreign Relations series, consisting of a title page and typically organized into front matter, a body containing several hundred transcribed primary source documents, and a back-of-book index. Bound between two covers or released as a digital-only publication. While some book titles contain units of division such as "Volume II Part I" or even "Part II Volume III," we will, for the purposes of the digitization of the series, refer to each discrete book as a volume.
  • Document: A primary source selected by an editor for inclusion in a Foreign Relations volume. Documents typically have a title, a dateline, a source note, a body, and other annotations, primarily in the form of footnotes. Recent volumes (since ____) assign a number to each document, incremented sequentially; the document number, rather than page number, is the primary unit for cross references. Before document numbering, page numbers were the unit for cross references. Occasionally, a document is titled "Editorial Note", which are not primary source documents but rather are narrative interventions by the editor. The editor can use editorial notes to summarize a long document or series of documents that could not be printed because of space constraints, or provide important context.

3. The Structure of a FRUS TEI file

FRUS TEI files, like all TEI files consist of a root <TEI> element, with one child <teiHeader>, which contains metadata about the publication, and one child <text> element, which contains the content of the volume.