Caesarea-Maritima.org: Documentation

TEI Encoding Manual for A Comprehensive Bibliography on Caesarea Maritima

Table of Contents

Overview

Authorities and Resources

Book Records

Title

Author, Editor, and Translator

Series and Series Number

Volume Information

Edition

Publication Information

Place

Publisher

Date

ISBN and URL

Language

Short Title

Archive

Rights

Extra

Book Section Records

Creating Book Sections from Book Records

Additional Fields Used in Book Section Records

Title, Book Title, and Short Title

(Section) Author

Pages

Relate Function

Journal Article Records

Miscellaneous Documentation

Controlled Vocabulary for Zotero Tags

Tags Delineating Sub-Modules

Editorial Tags

Overview

What follows is a general overview of the editorial practices employed thus far in the generation of the Caesarea Maritima bibliography. These practices apply to the encoding of records in Zotero.

Authorities and Resources

Book Records

Monographic works should be encoded using the Zotero item type, "Book". The following fields should be used to capture bibliographic data about book records. If a Zotero field is not specified below, please leave it blank.

Title

This field contains the main, unabridged title of the record. E.g. Caesarea Papers: Straton’s Tower, Herod’s Harbour, and Roman and Byzantine Caesarea. Including the Papers Given at the Symposium Held at the University of Maryland, the Smithsonian Institution, and the Jewish Community Center of Greater Washington on 25-28 March, 1988.

Note that Zotero should not be relied upon to properly capitalize titles. Rather, each title should be capitalized manually following the Chicago Manual of Style, based on the source language. For instance, many European languages employ sentence-style capitalization, where only the first word in the title is capitalized.

Author, Editor, and Translator

Log in this field the names of the individuals responsible for the work being recorded. For edited volumes, do not include the names of individual chapter authors in the Book record. These will be added as authors in the Book Section records for the corresponding chapters.

If a single individual was responsible for the work both as an editor and a translator, two creator fields must be used, one identifying the individual as editor and another identifying the individual as translator.

Note that currently we are not using a standard authority for spelling creators' names. This may be rectified later, but for the present use the spelling provided by the prose citation.

If a work has no author, editor, or translator, as may occur in rare cases such as with conference proceedings, leave the creator field(s) blank. However, add a Zotero note to this record indicating the fact that there is no author or editor.

Series and Series Number

These fields record information about the series to which the work belongs, and the place the work occupies in the series' numerical sequence. For instance, "Studies in Christianity and Judaism" number "8".

In some cases a work may belong to multiple series. Since Zotero only offers fields for information on a single series, we have elected to utilize the Extra field for encoding information about secondary series. In such cases, the encoder must use discretion in deciding which series should be logged as the primary (encoded in the "Series" field) and which should be the secondary (encoded in the "Extra" field).

Note: Do not abbreviate series titles in any way. Instead, include in the field the full, unabridged series title. If necessary for display purposes, Zotero can be tasked to render the series title in an abbreviated form. Conversion the other way is much more difficult.

Volume Information

Several records exist as a single volume of a multi-volume work. In such cases, the work's volume number should be recorded in the "Volume" field.

If the total number of volumes in the multi-volume work is known, this number may be recorded in the "# of Volumes" field; however, this field may also be left blank.

For encoding named volumes in a multi-volume work (e.g. The Mithraeum at Caesarea Maritima which is volume II of The Joint Expedition to Caesarea Maritima), see the Extra field.

Edition:

This field may be used to indicate if a work is the nth edition, etc. If the work is a reprint, indicate this as "repr." in this field. This field may be left blank if no edition information is given.

Publication Information

Place

Record information about the place of publication in this field. US states should be abbreviated using the two-letter postal abbreviation system (e.g., Ann Arbor, MI). Refer to the Chicago Manual of Style for determining when a state needs to be included in place of publication references. For multiple publication places but a single publisher, simply record the first place listed either on the title page or in the prose citation.

Publisher

Record the name of the publisher in this field. As per the Chicago Manual of Style, you may omit words like "press", "publishing house", "inc.", etc. except in two cases:

  1. For academic publishers, e.g. "Oxford University Press", you should retain the word "Press".
  2. In cases where the abbreviated form may be confusing, such as "New Press" (in this case, do not abbreviate to "New").

In some cases a source will be 'co-published' by two or more publishers. In such cases, record the publishers in a sequence, separated by a semi-colon, ';'. You will also need to record the places of publication for each of these publishers, being careful to maintain the same sequence.

Date

Record the date of publication in this field. Please include only the four-digit year.

Reprints

For reprints of a work, our practice is to include the publication information of the first printing in the dedicated Zotero fields ("Publisher", "Place", and "Date") and to record the publication information for the reprint in the Extra field using the controlled vocabulary for reprint publication information outlined below.

ISBN and URL

Every record needs a stable, unique identifier. The most preferred identifier is the OCLC number which connects this record with the WorldCat catalog. However, the ISBN offers another identifier that may be recorded when available. Otherwise, this field may be left blank.

URLs are not a preferred identifier unless they are stable URLs. An example of a stable URL would be https://www.jstor.org/stable/10.3366/j.ctt3fgqv5. If using a URL as an identifier, take care to ensure that it is a stable URL (sometimes called a permalink or a persistent link).

  • PENDING: link to the use of URLs with machine readable editions of a work in the testimonia module

For the use of DOIs with Books and Book Section records, see the Extra field.

Language

When cataloging the languages used in a specific work, please use the ISO 639 language codes; 2-character where possible (ISO 639-1:), 3-character otherwise (ISO 639-3). Cf. https://www.iso.org/iso-639-language-codes.html. If a record describes a source written in multiple languages or having text from multiple languages, separate these language codes with a comma ','.

Short Title

A shorthand title can be created for a given record and recorded in this field. As per the Chicago Manual of Style, the short tile should contain key words from the unabridged title. You may omit initial "A" or "The"; word order must not be changed.

If a title is too short for a separate Short Title (usually titles of four words or fewer), use the full title in this field or leave this field blank.

Archive

"Archive" is used only in the following case. For machine-readable versions of texts, "Archive" is used to record the full name of the digital repository where the machine-readable text is stored, e.g., "Perseus Digital Library".

Rights

For machine-readable works, the "Rights" field is used to log any copyright and licensing information, for instance a Creative Commons license. Alternatively, this field can be used to log the status of an electronic work as being in the public domain.

Extra

Given the constraints of the named fields which Zotero provides, we have elected to record information that does not fall into those fields as key:value pairs in the Extra field. Each key:value pair should be recorded on its own line. The 'key' will be one of the following controlled vocabulary and the 'value' will be a string corresponding to that key. The pair should be separated by a colon and a space, for example: "Abbreviation: Harbour Archaeology I".

List of controlled vocabulary for Extra field and their definitions:

  • "Series": The name of an additional series beyond the Zotero series field (See Series).

  • "seriesNumber": The number of the additional series beyond Zotero's series number field (See Series).

  • "Aph": Records the reference number for journal articles as recorded by L'Annee Philologique, which is used as a unique identifier in some cases. These are not directly resolvable, but the online bibliography may be searched by APh reference number. Note that this online bibliography is not open access, but may be provided by one's institution.

  • "OCLC": Online Computer Library Center ID number resolvable to http://worldcat.org/oclc/\d+ where "\d+" stands for the OCLC number.

  • "multivolumeTitle": The general title of a titled multi-volume work whose individual volumes are also titled, e.g. Joint Expedition to Caesarea Maritima, volume 5, whose individual title is The Greek and Latin Inscriptions of Caesarea Maritima. In this case, The Greek and Latin Inscriptions of Caesarea Maritima would appear in Zotero's Title field, and Joint Expedition to Caesarea Maritima would appear in the Extra field as the multivolumeTitle. Note that the volume number of these multi-volume works is recorded in Zotero's volume number field.

  • "Abbreviation": The abbreviation of a book or journal title. Many of these derive from conventional sources, such as L'Annee Philologique or the Society of Biblical Literature, but some are unique to the Caesarea-Maratima database. No distinction is maintained between derived or unique abbreviations. NOTE: These abbreviations may be used in the future, but at present these are not displayed in the HTML of the records.

  • "DOI": a Document Object Identifier. While Zotero offers this field for journal articles, it does not do so for books or book sections, some of which do have DOIs. In those cases, the "DOI" key is used to capture the item's DOI. For journal articles, however, the DOI is recorded in Zotero's DOI field.

  • "partNumber": Certain book sections (see Book Section Records) consist of both a volume and a part number. For subsections of these books, this key:value pair identifies which part of the larger book item the subsection belongs to. For example, the article "Working Base" comes from The Harbours of Caesarea Maritima, volume 1, part 2. However, the publications of The Harbours of Caesarea Maritima have only been divided into "Volume I, parts 1-2" and "Volume II". So, the key:value pair for the article "Working Base" specifies that it comes from part 2, i.e., partNumber: 2.

  • "CTS-URN": gives the Canonical Text Services URN for a machine-readable version of a primary source edition or translation. CTS-URNs should be of the form `urn:cts:{ctsNameSpace}:{textGroup.work.edition|translation}{passageReference}. For bibliographic records, the CTS-URN should be specified to the edition|translation level as the bibliographic record represents a specific edition or translation of a work rather than the abstract concept of a work. So, for example, the CTS-URN for the Benedic Niese's 1885 edition of Josephus' Antiquitates Judaicae, encoded by the Perseus Digital Library, is urn:cts:greekLit:tlg0526.tlg001.perseus-grc1.

  • "xmlFile": for machine-readable texts which are not API-servable via URNs, this value records a link to the raw XML of the machine-readable text, if available. e.g., "https://ccel.org/ccel/schaff/npnf203.xml".

  • "reprintPublisher": records the name of the publisher responsible for reprinting the record. In the case of reprints, we record the original printing information in the dedicated Zotero fields and the reprint information in the extra field.

  • "reprintPlace": records the place of publication for the reprinted version of the record. In the case of reprints, we record the original printing information in the dedicated Zotero fields and the reprint information in the extra field.

  • "reprintDate" - records the date of publication for the reprinted version of the record. In the case of reprints, we record the original printing information in the dedicated Zotero fields and the reprint information in the extra field.

Book Section Records

Creating Book Sections from Book Records

In most cases it is easiest to generate records for the chapters and subsections of a Book using Zotero's "Duplicate Item" function. Once a Book record has been duplicated, change its "item type" to Book Section. Once you have changed the item type, edit the record according to the following guidelines for Book Section records. Alternatively, the Zutilo plugin offers a function that automatically creates a Book Section record from a selected Book record.

Additional Fields Used in Book Section Records

Title, Book Title, and Short Title

The Title field records the title of the book section while the Book Title field records the title of the book in which the section appears. For example, you would record the title of the essay "Countermarked Byzantine Folles and the Identification of a New Imperial Family Member" in the Title field. The volume it appears in, Caesarea Papers 2: Herod's Temple, the Provincial Governor's Praetorium and Granaries, the Later Harbor, a Gold Coin Hoard, and Other Studies, would be recorded in the Book Title field. The Short Title field records an abbreviation of the Title field - not the Book Title field. So, in this example, the Short Title field would be "Countermarked Byzantine Folles".

(Section) Author

If the Book Section record is generated by duplication from the Book record, as noted above, the editors information will be preserved. However, you will need to record the author of the book section in an additional Author field.

Pages

This field records the page range which the book section occupies. Please record the entire range, that is, do not use inclusive numbers. For example, for a record running from pages 123 to 137, record "123-137" rather than "123-37". Inclusive numbers can easily be generated at a later point if desired, but it is more difficult to convert inclusive numbers to the full range.

Relate Function

If you are using the Zutilo plugin to generate Book Section records, these sections will automatically be related to the monograph record and any other related book sections at the time of creation.

Alternatively, once all sections of a book have been encoded, Zotero's "relate" functionality may be used to link the parts of the book to each other and to the book as a whole. This can be done manually using the record's "Relate" tab. However, a component of the Zutilo plugin offers the ability to select a set of items and interrelate all of them with one click. Download and installation instructions may be found here. Once Zutilo is installed as a plugin, go to Tools > Zutilo Preferences. In the dialogue box, make sure "Relate Items" is set either to "Zutilo Context Menu" or to "Zotero Context Menu". Now you may select the book and its book sections, right-click (ctrl-click on Mac) and click "Relate selected items".

Journal Article Records

PENDING.

Miscellaneous Documentation

The following sections capture various editorial practices not described above.

Controlled Vocabulary for Zotero Tags:

Zotero's tagging system has been employed, at present, in two situations. First, tags have been used to assist in the delineation of bibliographic records for A Comprehensive Bibliography of Caesarea Maritima and for the Textual Evidence for Caesarea Maritima. Second, certain tags assist in the production and editorial process of records by marking records which have issues or need attention.

Tags Delineating Sub-Modules

  • Testimonia-Works-Cited: Indicates that this bibliography record describes an edition or translation of, or is in some other way relevant to, one or more testimonia records in the Textual Evidence for Caesarea Maritima module.
  • Comprehensive-Bibliography: Indicates that this bibliography record describes a secondary source of scholarly relevance to the study of Caesarea Maritima and thus is a part of A Comprehensive Bibliography of Caesarea Maritima.

Note that bibliographic records must be tagged with one of these values, but may be tagged with both as a given record could be relevant both to the testimonia and bibliographic modules.

Editorial Tags

  • !INCOMPLETE: Indicates that this Zotero record is incomplete in some way. The Note attached to the record, which should begin with the string "!INCOMPLETE: ", should provide clarification as to what specific data is missing.
  • !CHECK: Indicates that this Zotero record may have been corrupted or may be incorrect in some way. The record's accuracy needs to be verified. More information on what specific aspects need verification may be found in the Note attached to the record, which should begin with the string "!CHECK".
  • !NoIdentifier: Indicates that this Zotero record is otherwise complete but is missing a stable identifier. This is likely the case for journal articles which did not have a corresponding OCLC number.
  • PrintEditionNoMachine-Readable: Indicates that this Zotero record describes an edition or translation of a text found in the testimonia module for which a corresponding machine-readable/electronic version has not been identified or catalogued.