The Landscapes of Injustice Schema and Documentation
Natsuki Abe, Stewart Arneil, Erin Chan, Nathaniel Hayes, Martin Holmes, Kara Isozaki, Lindsey Jacobson, Jennifer Landrey, Gordon Lyall, Lindy Marks, Jordan Stanger-Ross, Joey Takeda and Lisa Uyeda
2014–2020

Table of contents

1. Introduction

Welcome to the Landscapes of Injustice Digital Archive project. This document provides detailed guidelines for editors, programmers, maintainers and research assistants working on the project.

2. Using the Subversion Repository

We keep all our XML files and related documents in a Subversion Repository. This is a version-control system that ensures that every version of every file can be retrieved if necessary, and prevents one person from inadvertently overwriting changes to a file made by someone else.

Subversion runs on one of our HCMC servers. In order to use it, you will need to install a Subversion client on your computer, and also learn a couple of simple command-line commands. Subversion is usually abbreviated to ‘svn’.

2.1. Installing a Subversion client

How you will do this depends on which operating system you are using.

2.1.1. Windows

Obtain a command-line client from CollabNet (http://www.open.collab.net/downloads/subversion/). Registration is required to download the program, but there is no cost. Make sure to download the correct version; there are versions for 32-bit and 64-bit Windows. Once the program is downloaded, install it by double-clicking the downloaded installer and following its instructions.

2.1.2. Macintosh

  • Open a terminal.
  • Type:
    xcode-select --install
  • Press return.

Note that MacOSX updates have sometimes broken the svn install, so you may need to go through the above steps again if svn stops working.

2.1.3. Linux

Subversion is installed as part of a regular desktop on most Linux distributions.

If you do not have subversion on your Linux:

  • Open a terminal.
  • Type:
    sudo apt-get install subversion
  • Press return and answer "y" to questions about space.

2.2. Checking out the repository for the first time

Once your subversion client is installed, the first thing we need to do is to check out the repository. To do this, you need to open a terminal window:

  • On Windows, click on the Start menu and type cmd into the search box.
  • On a Mac, select Terminal from the Utilities folder in Applications.
  • On Linux, press Control + Alt + T.

Now we'll check that svn is installed and working. Type svn checkout into the terminal window and press return. If the terminal response is that there are Not enough arguments provided, then svn is working OK.

We are then going to create an "loi" local repository. Before we do that, you may want to be in your "Documents" folder, or some other directory other than your root. To do this type:

cd [PATH TO DIRECTORY]/[NAME OF DIRECTORY]

Example:

Note: Windows uses "\", Mac and Linux use, "/".

Now we'll create a directory for our project files:

mkdir loi

And now we've created that directory, we'll navigate into it:

cd loi

And now we'll check out the files from the repository into our directory. Make sure you don't forget the space and period at the end of this command:

svn checkout https://hcmc.uvic.ca/svn/landscapes/production .

2.3. Using SVN in your daily work

These are the basic rules when you're working with svn:

Before you start work, update your local files:

  • Open a terminal and enter the following commands:
  • cd loi
  • svn update

You can leave the terminal open while you work. Then, when you're ready to commit your changes:

  • svn update
    (It's important to update before committing changes in case anything else has been changed and committed by someone else)
  • svn commit -m "A message explaining the changes you have made"

That's basically it. If you see any warnings or error messages from svn, check that you're in the right folder in your terminal. You may also see error messages if two people have been editing the same file at the same time, and Subversion needs you to make a decision about whose changes should be kept.

2.4. Tips for using the terminal

Finding out where you are right now:

pwd

Moving up the tree one level:

cd ../

List files in a folder (Mac and Linux):

ls

List files in a folder with full information:

ls -al

List files in a folder (Windows):

dir /w

3. XML Terminology

For an introduction to XML please see the w3schools tutorial here. The two main components of XML that you should know are elements and attributes.

4. Working with Oxygen

Your encoding work will all be done in the Oxygen XML Editor (also referred to as Oxygen). When you install Oxygen, there are lots of applications that come with it: Oxygen Author, Oxygen Developer, Compare Files, Compare Directories and others. But the one you want to work with is always Oxygen XML Editor, which has the blue icon with the red cross on it. Here's how to get started:

  1. Open the Oxygen XML Editor.
  2. Click on Project / Open Project...
  3. Navigate to the loi folder in your home directory.
  4. Choose the file loi-production.xpr.

You should see a tree of folders and files down the left of your Oxygen editor. This includes all the files in the project. You can ignore most of them. The folders that matter to data encoders and editors are in the data folder, where all the TEI files and LOI schema are kept. To expand a folder, click the little blue icon beside it. Sometimes you will need to click the icon with two blue squares on the left side of the editor to make this tree appear.

4.1. Validate your files before upload

This is important: always validate any and all XML files in Oxygen before uploading them to the repository in Terminal/SVN. Get into the habit of saving your files often (Ctrl + S on your keyboard), and validating often (Ctrl + Shift + V on your keyboard).

To validate the file upon which you are currently working, use the following keyboard command: Ctrl + Shift + V. Alternatively, click on the validate button in Oxygen's toolbar. The button looks like this:

To validate multiple files, (1) open Oxygen's built-in file browser, (2) select the folder you want, and (3) select Validate. Here's a screenshot of the process:

If your validation is successful, a green box with the words 'Validation successful' will appear at the bottom of the editor. If the validation is unsuccessful, a red box and the words 'Validation failed' will appear along with the number of errors that you have created. You must correct these errors before uploading the file to the repository. Please refer to SVN daily use.

5. TINA and Ography Files XML Mark-up Guide

The TINA files make up our "archive" of primary material. This section will explain how to encode this data and add new people, place, and organization entries into central reference files called "ographies."

5.1. Setup

To work on TINA files you will need to have the following programs open:

  • Oxygen XML Editor
  • A terminal window
  • An internet browser with the Zotero group library open and loaded. You will need to have previously been given permission to access the library.

In Oxygen navigate to the ‘Project’ tab along the top toolbar and select ‘Open Project’. A file selection box will open and it will automatically open your ‘RADish’ folder. You should be looking at a folder called ‘Production’ - open this and select the file ‘loi-production.xpr’

You should now have a sidebar on the left that lists all of the folders and files that exist within this project. Click the little blue icon beside a folder to expand it.

  • Expand the ‘production’ folder
  • Expand the ‘data’ folder.
  • The folders inside ‘data’ that you are concerned with are:
    • ‘orgography’
    • ‘personography’
    • ‘placeography’
    • ‘RADish’

5.2. Choosing Which TINA File to Work On

You will now decide which TINA file you will be working on. Please do this in consultation with other research assistants that are working on the project. RAs who have worked for Landscapes of Injustice previously will know what files need to be worked on, which are priority, etc. Consulting with the other RAs around you will also prevent multiple RAs from working on the same file, which can prove to be disastrous.

Once you know which file you will be working on you will open it in Oxygen:

  • Expand the ‘RADish’ folder (inside the ‘data’ folder)
  • Expand the folder of the archive you will be working in (e.g. ‘TINA_LAC’)
    • Now open the file you have been assigned. The smaller archives may have only one file, but the larger archives have multiple files which have been separated out at the fonds level.

5.3. Checking Diagnostics

Every time you start working in XML, you will need to consult the diagnostics tool. This tool will show you, among other things:

  • Person, place or organization links that are broken
  • Duplicate IDs that need to be fixed
  • Every XML ID that has been created in this project

The diagnostics tool will automatically build itself each time you commit. To open the results of the diagnostics tool after a SVN commit, go to this link: Products

If you would like to manually build the diagnostics to see your current progress, run the diagnosticsTransform.html located at the root folder:

Open the diagnosticsTransform.html file in Oxygen and press the "transform" button. To see these instructions in the html file, view it in "Author" mode (tabs below).

This will build the diagnostics though it may take a few minutes.

To open the results of the diagnostics you ran on your local machine find the diagnostics.html in the ‘products’ folder and open it in a web browser. This is your local copy of diagnostics that you have just built. It will not be what everyone else sees on the Jenkins server version until you commit.

Note: if for some reason the transform does not work, it may mean that there is no build associated with the file. Contact Gord for support.

Opening ‘diagnostics.html’ will open the results that show the problems in the XML files that need to be addressed.

To view the list of errors, such as duplicate IDs and broken links, or to view the list of files that are missing information, open 'products/diagnostics.html'.

products/diagnostics.html

To view the list of each XML ID that has been created in this project, open ‘products/ids.html’. The first column lists the ID and the second column lists the type of ID it is.

products/ids.html

5.4. Working on a TINA File

5.4.1. Creating XML IDs

Each XML ID is unique and it consists of four letters and a number greater than zero. When creating an XML ID you will need to consult the ids.html, as well as the New XML ID Tracker, to ensure that the ID you are creating has not already been used. The first list is the master list of all ids currently used across the database, and the "New XML ID Tracker" is a mechanism to avoid two people creating the same id on the same day working from different machines or remotely.

In each list, use CTRL + F to search for the ID you plan to create. If that ID is already in use, you must choose another, usually by changing the number to one higher than the highest one already in use. An example of this is a person with the last name Tanaka. If the numerically highest ID for the prefix ‘tana’ is tana1, your ID would then be tana2.

*Note: Some persons may be identified as having multiple ids pointing to that same person which means the ids will be collapsed into one resulting in the erasure of an existing id. This means there may be gaps in some of the id list. Example: tana1, tana2, tana4. In this case it is ok to create a new id “tana3”.

Within each ID we follow the practice of marking up all person names, organization names, and place names. An example of this practice can be found in the place ID for Blind Creek where the person name Eikichi Kagetsu and the place name Burnaby are marked up:

<place xml:id="blin1">  <placeName>Blind Creek</placeName>  <desc>A creek in <placeName ref="plc:bnby1">Burnaby</placeName>. <persName ref="prs:kage1">Eikichi Kagetsu</persName> once had logging interests here.</desc> </place>

WORKFLOW

  • Check LOI master list of XML ids for the next logical id to use.
  • Check the New XML ID Tracker to make sure someone hasn't already added a new id today that you would have used.
  • **Put your new id in "NEW XML ID Tracker" list to claim it as yours; add, date, your initials, file that the entity came from, and into which ography the entry was added.
  • Add the new person entry and id into correct ography file (see below).
  • Give your newly marked-up person, place, org entry this new id (see below).

5.4.1.1. Personography IDs

Each person name that you come across will need to be marked up using a <persName> element. In some cases you will need to create the unique XML ID for the name that you come across. This process is described below.

Person IDs are comprised of the first four letters of the last name followed by an integer greater than zero. If the person’s last name is three letters instead of four, the letter x will be used as a placeholder for the fourth letter.

To create a new entry in the personography, you first need to locate where the new ID will fit. There are 26 personography files inside the ‘personography’ folder, one for each letter of the alphabet. What file the new ID will go in is decided by surname. For example, the person ID for Kazuko Kagawa is in personography_k.xml.

To start building an ID you will begin with the <person> element. Inside of this element will be two attributes: xml:id and sex.

The xml:id is the four letter, one integer ID you chose in consultation with the diagnostics. For Kazuko Kagawa the ID we chose is kaga2.

<person xml:id="kaga2"/>

Now we add the sex element on the same line. We use ‘F’ for female, ‘M’ for male, and ‘U’ for unknown. In this case we know that Kazuko Kagawa is female, so we use ‘F’:

<person xml:id="kaga2sex="F"/>

You will now be adding the <persName> element. This element will include the <surname> and <forename> elements. This is where you enter the person’s full name. If you have their full name, you will select “yes” when given the choice when you begin typing <persName>. Next, add the <surname> element, and again select “yes” if you know their full surname. In the space between the opening and closing of the <surname> element, enter the person’s surname:

<person xml:id="kaga2">  <persName>   <surname>Kagawa</surname>  </persName> </person>

Now we will add the <forename> element on the line underneath the <surname> element and separate them with a comma. Like the <surname> element, select “yes” if you know the person’s full first name and write the forename in the space between the opening and closing of the <forename> element:

<person xml:id="kaga2">  <persName>   <surname>Kagawa</surname>   <forename>Kiyoko</forename>  </persName> </person>

This is an example of a person ID in its most basic form.

Ideally we would also be able to add some biographical information in a <note> to a person entry.

<person xml:id="shea1sex="M">  <persName>   <surname>Shears</surname>   <forename>Frank</forename>   <addName>Gould</addName>  </persName>  <note>F.G. Shears (born March 3, 1885 in London, England) was a bureaucrat who took on a prominent administrative role in the dispossession of Japanese Canadians in World War II. Shears was hired by the Secretary of State in 1940, and served as the director of the Vancouver Office of the Custodian of Enemy Property from 1942 until the closure of the office in 1952. As director, he oversaw the forced sale of Japanese Canadian assets and the payment of claims arising from Justice Henry Bird’s <orgName ref="org:jpcc1">Royal Commission</orgName>. As one of the longest-serving employees of the Custodian, Shears experienced this history from a unique perspective, privy to the decision-making of his political and bureaucratic masters, but also constantly receiving letters and appeals from the Japanese Canadians he helped to dispossess. (Source: Kimura Appendix)</note> </person>

5.4.1.2. Organization IDs

For organization IDs, you should pick an ID that makes sense while still adhering to the strictures of our schematron rules which indicate that each ID must be four letters and a number. Sometimes it will make sense to use the first four letters of the main part of the organization name, like the M. Ebisuzaki Company, the ID for which is “ebis11”. Other times it will make sense to use the first letter of each word in the organization name, like the Exchequer Court of Canada, the ID for which is “ecoc1”. Always remember to check the uniqueness of the ID with the diagnostics.

To start building an org ID you will begin with the <org> element. Inside this element is the xml:id attribute.

Using the Exchequer Court of Canada as an example, your ID would initially look like this:

<org xml:id="ecoc1"/>

Now we need to add the orgName element:

<org xml:id="ecoc1">  <orgName>Exchequer Court of Canada</orgName> </org>

If this is all of the information you have for this ID you will close the <org> element. This is an org ID in its most basic form. If you have more information you can include it as well, using primarily a <desc> element or a <note> element:

<org xml:id="eocj1">  <orgName>Embassy of Canada to Japan</orgName>  <desc>Located in <placeName ref="plc:toky2">Tokyo</placeName>.</desc> </org>
<org xml:id="ktco1">  <orgName full="yes">K. Takahashi &amp; Company</orgName>  <note>A company based in <placeName ref="plc:vanc1">Vancouver</placeName> owned by <persName ref="prs:taka53">Kinji Takahashi</persName>.</note> </org>

5.4.1.3. Place IDs

Just like XML IDs for people, the IDs in the placeography consist of the first four letters of a place name and a number. The only mandatory attribute in a <place> element is xml:id. Remember to check the uniqueness of the ID with the diagnostics. Each placeography entry must also contain a <placeName> element and a <desc> element containing a brief description of the place:

<place xml:id="anna2">  <placeName>Annacis Island</placeName>  <desc>An island located on the <placeName ref="plc:fras43">Fraser River</placeName> in <placeName ref="plc:delt4">Delta</placeName>, <placeName ref="plc:brit1">British Columbia</placeName>.</desc> </place>

Additional notes about a place should be contained in a <note> element:

<place xml:id="angl12">  <placeName>Angler</placeName>  <desc>A prisoner of war camp in <placeName ref="plc:onta1">Ontario</placeName> near <placeName ref="plc:neys1">Neys Provincial Park</placeName>.</desc>  <note>Also known as Angler Internment Camp, Internment Camp 101, and Angler POW Camp.</note> </place>

5.4.2. Mark Up

All person names, place names, and organization names need to have a <persName>, <placeName>, or <orgName> tag applied to them.

The easiest way to do this is to highlight the piece of text that you would like to mark up and pressing ctrl + e on the keyboard. This will bring up a drop down list that will enable you to select the tag you require.

Doing so will change the text to look like this:

<persName>Eikichi Kagetsu</persName>

This is not complete. All <persName>, <placeName>, and <orgName> elements must include a reference to an ID in the personography, placeography, or orgography. You will need to insert this reference within the opening of the tag. The ID that you reference will be the ID that exists in the respective ography, so you will need to first either find that ID, or create that ID. Then you will insert the reference and your work will look like so:

<persName ref="prs:kage10">Eikichi Kagetsu</persName>

*Note: all references must include the prefix of the ography they belong to. The prefix “prs:” for person names, “plc:” for place names, “org:” for organization names, and "team:" for LOI team members.

5.4.3. Fields to Complete

There are a large number of fields associated with each object, sub-series, series, and fonds. You are only responsible for some of these fields. This section of the guide will walk you through how to complete the fields that you are responsible for.

First: to find a record that needs work and is currently not being worked on please consult the TINA Status document. Also consult with your co-workers to make sure this document is up to date and chat about which document is best for you to currently be working on.

Second: it is recommended that you work from the bottom to the top, so the fields listed below are listed in the order in which you will come across them. The bottom of an object will begin at the end of the <listObject>.

These are the fields that should be complete:

5.4.3.1. Metadata Author

This is you! Gordon Lyall and Lindsey Jacobson have been added as ubiquitous metadata authors, but in working with the TINA files you are also a metadata author. To add this information you will need to put in a new <respStmt> (responsibility statement) element underneath the last <respStmt> that is present. This element will contain your name wrapped in a <persName> element and a <resp> (responsibility) element. You must have already created an XML ID for yourself in the personography to complete this step. Personography entries for Landscapes of Injustice team members are written in the ‘team.xml’ file within the ‘personography’ folder.

Start with the <respStmt> element. You will follow this with a <persName> element, and finally a <resp> element:

<respStmt>  <persName ref="team:mark15">Lindy Marks</persName>  <resp>Metadata author</resp> </respStmt>

5.4.3.2. Researcher

In some cases the researcher’s name will already have been added. In other cases, however, you will have to determine who the researcher is and put their name into the <respStmt> element that has the <resp> element of “Researcher.”

To determine who the researcher is, you will look in Zotero at the name of the person who uploaded the document to Zotero (this will be a username) or read the child notes.

Looking at “lac_rg117_a-1_volume_0003_file_08” as an example, we see that the user who uploaded the document is “adamkos” and the child notes are written by “Adam K.” This means that the researcher is Adam Kostrich. Personography entries for Landscapes of Injustice team members can be found in the ‘team.xml’ file within the ‘personography’ folder.

If you cannot find a researcher, please contact Gord or Kaitlin Findlay, they will likely know, have a good idea, or can find out.

5.4.3.3. Document Date

This information should already be provided.

5.4.3.4. Document Author

The document author is the person and/or group that created or compiled the document. This could be the Office of the Custodian, the Government of Canada, the Supreme Court of Canada, etc. In terms of using the name of a person, the doc author is the person whose name appears most frequently in the file. This is particularly the case for files containing lots of correspondence. The <docAuthor> element should be in place. You need to replace the placeholder of “AUTHOR” with the actual doc author and mark up the person's name or org name that you have listed.

If there are many authors on a file, add the primary author of the file and write “and others.” If there are two individuals conversing back and forth, add both individuals.

Example:

<docAuthor>  <persName ref="prs:shea1">F.G. Shears</persName>, <persName ref="prs:wrig1">K.W. Wright</persName>, and others. </docAuthor>

If there is no identifiable doc author you should instead replace the placeholder of “AUTHOR” with “Unknown”:

<docAuthor>Unknown</docAuthor>

5.4.3.5. Digitization Level

Scrolling up, this is the next section that you need to work on. For this section you have three options: “selectively”, “in full” or “unknown”:

<p>This record was digitized selectively.</p>
<p>This record was digitized in full.</p>
<p>The digitization level of this record is unknown.</p>

The child notes in Zotero should list the digitization level as either selectively or in full. In the case that the child notes do not list the digitization level, or in the case that there are no child notes, you will use “unknown.” Or contact Gord, he may know, or know how to find out.

5.4.3.6. Object Description

This is where you write your scope and content describing the object. It will look similar to this:

<summary corresp="rad:radScopeAndContent">  <p>!IMAGINE NO TEXT JUST WHITESPACE!</p> </summary>

If there is already text in this section you simply need to mark up all person names, place names, and organization names that appear in the text.

If this information is not provided, you will need to navigate to the child notes of this file in Zotero. The child notes should already have a description included, so copy and paste it into the space between the opening and closing of the <p> element. Now you need to mark up all person names, place names, and organization names.

If there is no text provided (no child notes or no description in the child notes) you will have to write your own description which you will then mark up.

These are all of the item level fields that you will be responsible for. Continue following this procedure for all of the items as you scroll up. At some point you will come across fields relating to higher-level descriptions that you will need to fill in. These fields pertain to sub-series, series, and fonds. The higher the level the more vague and general your description will be.

You will know that you have hit a higher level field when scrolling up from an object-level scope and content field you come across another scope and content field, rather than a new object.

To identify what level you are at, scroll to the line that has an item element in it. Part of this element will be an n attribute which will describe the level. An example looks like this:

<item xml:id="lac_rg117_a-3_volume_2809"  n="sub-series"/>

Looking at n, this field is for a sub-series.

5.4.3.7. Sub-series Description

The sub-series description should briefly describe all of the files that it contains. You will again need to mark up all person, place, and organization names. An example of a sub-series level description is:

<p>This subseries consists of four files containing the <orgName ref="org:cust3">Office of the Custodian</orgName> case file for <persName ref="prs:kage12">Eikichi Kagetsu</persName> with extensive discussion relating to the seizure and sale of his real estate and his debt to the <orgName ref="org:ysbx1">Yokohama Specie Bank</orgName>.</p>

5.4.3.8. Series Description

The series description should describe all of the sub-series that are contained in the series. You will again need to mark up all person, place, and organization names. An example of a series level description is:

<p>This series comprises one file discussing the post-war use of seized Japanese Canadian farms in <placeName ref="plc:neww3">New Westminster</placeName>, <placeName ref="plc:brit1">British Columbia</placeName>.</p>

5.4.3.9. Fonds Description

The fonds level description should describe all of the series contained within it. You will again need to mark up all person, place, and organization names. An example of a fonds level description is:

<p>This fonds comprises one series pertaining to the <orgName ref="org:jfvd1">Japanese Fishing Vessel Disposal Committee</orgName>.</p>

5.5. Committing Your Changes

All changes made to TINA files need to be committed to the server. This is done through the terminal. You should commit with some regularity, at the very least when you leave for the day, though best practice would be to commit when you take a break as well.

First, ensure that all of the files you were working on in Oxygen have been saved.

Next, open the terminal and navigate to the ‘production’ folder which has the repository installed in it.

Now you should do an SVN update to ensure that you have the most up to date version of the repository on your local machine.

Once you have updated it is time to commit with a message about the changes you made:

svn commit -m “continued work on TINA_CHE and added to personography”

To commit your changes press enter. If there are no conflicts, you are done!

If conflicts occur, contact Stewart Arneil immediately.

5.6. Bird Commission Fonds in LAC

The Bird Commission fonds are a set of individual case file records for Japanese Canadians who participated in the Bird Commission. This section assumes that reader/encoder has knowledge of TINA data structure, ographies, and LOI general guidelines for "Working on a TINA File."

5.6.1. Updates

As of July 10, 2020, EC has completed:

  • fonds and all sub-series level summaries
  • first pass of volume 59 of claim case files (file #s 1161 to 1180)
  • volumes 60 to 74 of case files (file #s 1181 to 1406) in full
  • volumes 75 to 79 of other material pertaining to the commission in full
  • all digitization statements to reflect “full” digitization
  • all <docAuthor> fields with the ubiquitous author “<orgName ref="org:jpcc1">Japanese Property Claims Commission</orgName> and others.”

Work still needed to be completed is:

  • a first and second pass of volumes 1 to 58* of claim case files (file #s 1 to 1160)
  • a second pass of volume 59 of case files (file #s 1161 to 1180)

*Note: Volumes 1 to 11 (file #s 1 to 203), volume 25 (file #s 507 to 524), and volumes 51 to 53 (file #s 1013 to 1066) already have claimants’ names listed in the <title> of the records (e.g., “Case file 7 Iwata, Mrs. Haruko”).

5.6.2. Bird Commission Workflow

5.6.2.1. Two-stage process

There is a two-stage process for completing the rest of the case files:

  • First pass will be a “light” treatment for the summaries in preparation for the database launch (approximately 100 hours). “Light” treatment centres on pulling the claimant’s name and Bird Commission and Custodian case file numbers.
  • Second pass will be a “full” treatment for the summaries (approximately 250 hours). “Full” treatment adds to info from first pass, pulling more information about the claimant, listing the kinds of documents in the file, listing additional docAuthors, and marking up key places, organizations, and people.

See Light and Full treatment sections for details.

5.6.2.2. Basics of working in fonds

  • Open up the Bird Commission fonds in Oxygen (loi -> data -> TINA_LAC -> lac_rg33-69.xml) and find a volume/file to start with.
  • You can find incomplete file summaries by executing this path in the XPath box in your tool bar while you have the xml page open:
    //summary[@corresp='rad:radScopeAndContent']/p[not(matches(., '[^\s]'))]
  • Navigate to file in the fonds on the database (Archival Datasets -> Library and Archives Canada -> Royal Commission ...) or Zotero (.export -> LAC -> lac_rg33-69 [Bird Commission]). (In recent experience, pdfs load faster from the database.)
  • Navigate to file in LAC’s finding aid.
  • Refer to the “XML mark-up Guide” for encoding help, if needed.

5.6.2.3. “Light” treatment process (first pass)

  • Use this general template for summary, modifying it as needed (replace square brackets with claimant’s info):
    This file contains documents pertaining to the <orgName ref="org:jpcc1">Bird Commission</orgName> claim of [First name Last name] (claim case number [#]). 
  • Pull claimant’s name from file (usually found on first claim summary/recommendations page of file before the transcript). Also reference the finding aid and/or the Custodian form in the file (if included) for name as any of these sources may have incorrect spelling. Include any incorrect or alternate spellings of names in following square brackets.
    Note that some claims have multiple claimants and some may be for companies or organizations, represented by an individual.
  • Search the list of “All Database Ids in the Project” for the claimant’s name. If matching name(s) found, search corresponding personography file for matching name. If you can quickly determine that it’s the same person as the claimant (from listed address, for example), link to that ID. If not, create a new personography ID and entry for claimant.
  • In personography entry for claimant, add a <note> with the following template, filling in the claimant’s info and the xml ID for the record (replace square brackets):
    <orgName ref="org:jpcc1">Bird Commission</orgName> case file number [#]. <orgName ref="org:cust3">Custodian</orgName> file number [#]. (Source: lac_rg33-69_volume_[XX_file_XXXX].)
  • The finding aid usually lists “Mrs.” or “Miss” before the names of female claimants (and nothing before the names of male claimants). Use this info to record the sex of the claimant in their personography entry (e.g., “<person xml:id="xxxx1" sex="F">”). Do not include “Mrs.” or “Miss” when recording claimants’ names.
  • If the claimant’s Custodian file number listed in the file has “X1” in it (noting they were interned), include variants on it in square brackets in their personography entry note to match how we’re treating the case file numbers sequentially and to give more options for searching (e.g., “<orgName ref="org:cust3">Custodian</orgName> file number X1-376 [XI-376 or 376_xi]”).

Here’s an example of a completed “light” treatment for claim number 1168:

Summary example:

<p>This file contains documents pertaining to the <orgName ref="org:jpcc1">Bird Commission</orgName> claim of <persName ref="prs:yosh158">Edward Shigeuki Yoshida</persName> [also listed as Shigeuki Yoshida and Shigeucki Edward Yoshida] (claim case number 1168).</p>

Personography entry example:

<person xml:id="yosh158sex="M">  <persName>   <surname>Yoshida</surname>   <forename>Edward</forename>   <addName>Shigeuki</addName>  </persName>  <note>   <orgName ref="org:jpcc1">Bird Commission</orgName> case file number 1168. <orgName ref="org:cust3">Custodian</orgName> file number 6668. (Source: lac_rg33-69_volume_59_file_1168.)</note> </person>

Note that the correct spelling of the claimant’s name was determined from referencing the finding aid and other documents in the file, as the initial claim summary/recommendations page (first image below) had the name spelled incorrectly. (Remember to include alternate or incorrect spellings in square brackets.)

*After completing all files in a volume, go to the volume’s sub-series summary and edit it to reflect the kinds of case files in it, if necessary. For example, volume 58’s summary reads as follows:

This sub-series comprises twenty-four files containing documents pertaining to the Bird Commission claims of various Japanese Canadian individuals and/or organizations or companies. Claim case numbers range from 1137 to 1160.

Once all of its files are complete, edit the italicized text above. If volume 58 contains only case files for people (i.e., no businesses), change the summary to reflect this. See other sub-series summaries for examples.

5.6.2.4. “Full” treatment process (second pass)

  • Building off the “light” treatment, add this template to existing summary, modifying it as needed:
    Documents include the following: claim overview forms; a transcript of hearing proceedings; and ___.
  • Using the finding aid and referencing documents in the file, generally list the documents included in the file, marking up any key places, organizations, or people according to the focus of the project. Note that the majority of files include the initial “claim overview form” and a hearing transcript, in addition to other documents.
  • Pull a couple more notable docAuthors from the documents, if relevant.
  • Include more info about the claimant in their personography ID, including things like their pre-uprooting address, family members relevant to the file/claim, etc.

Here’s an example of a completed “full” treatment of file claim number 1168 (to compare with the info from the finding aid):

Summary example:

<p>This file contains documents pertaining to the <orgName ref="org:jpcc1">Bird Commission</orgName> claim of <persName ref="prs:yosh158">Edward Shigeuki Yoshida</persName> [also listed as Shigeuki Yoshida and Shigeucki Edward Yoshida] (claim case number 1168). Documents include the following: claim overview forms; a transcript of hearing proceedings; a real estate (other than farm) summary; agreements for sales (involving the claimant, <orgName ref="org:vlmc1">Victoria Lumber and Manufacturing Co. Ltd.</orgName>, and <persName ref="prs:yosh161">Henry Shigetoki Yoshida</persName>); an estimate by <orgName ref="org:srpc1">Sidney Roofing &amp; Paper Co.</orgName>; appraisals; a statement of personal chattels; an analysis of personal property claim; correspondence between the <orgName ref="org:cust3">Custodian</orgName> and the claimant; a certificate of encumbrance for a lot in <placeName ref="plc:chem10">Chemainus</placeName>, <placeName ref="plc:brit1">BC</placeName>; a 1944 <placeName ref="plc:noco1">North Cowichan</placeName>, <placeName ref="plc:brit1">BC</placeName>, assessment notice; a <orgName ref="org:cust3">Custodian</orgName> form for the claimant; a photograph of a house at Lot 26, Map 303, District of <placeName ref="plc:noco1">North Cowichan</placeName>, <placeName ref="plc:chem10">Chemainus</placeName>, <placeName ref="plc:brit1">BC</placeName>; a letter to the <orgName ref="org:cust3">Custodian</orgName>; a memorandum listing personal property; a real property summary; and auction sheets.</p>

Personography entry example:

<person xml:id="yosh158sex="M">  <persName>   <surname>Yoshida</surname>   <forename>Edward</forename>   <addName>Shigeuki</addName>  </persName>  <occupation>Truck driver and insurance agent</occupation>  <residence>   <address>    <settlement>     <placeName ref="plc:chem10">Chemainus</placeName>    </settlement>    <region>     <placeName ref="plc:brit1">BC</placeName>    </region>   </address>  </residence>  <note>   <orgName ref="org:jpcc1">Bird Commission</orgName> case file number 1168. <orgName ref="org:cust3">Custodian</orgName> file number 6668. (Source: lac_rg33-69_volume_59_file_1168.)</note> </person>

docAuthor example:

<orgName ref="org:jpcc1">Japanese Property Claims Commission</orgName>, <orgName ref="org:cust3">Office of the Custodian</orgName>, <orgName ref="org:srpc1">Sidney Roofing &amp; Paper Co.</orgName>, <persName ref="prs:yosh158">Edward Shigeuki Yoshida</persName>, and others.

Finding aid entry example:

Look at processed case files from volumes 60 to 74 in Oxygen or on the database for other examples of “full” summaries and personography entries for claimants.

6. Oral History Transcript Guide

This is the Landscapes of Injustice Oral History Transcript Guidelines. Before working on any of the following stages, it is imperative that you consult and update the spreadsheet LOI Oral History Database_work flow on either Basecamp or Google Docs. This way we can avoid two RAs doing the same job on one transcript. The four columns you will consult are: Transcribed, Pre-Audio Check: Full/Partial, Audio Check, Final Check, and XML. First, make sure your column is blank. Then type your initials into the column and row that corresponds to the narrator and stage you are completing. You will update the spreadsheet after you finish your task(s) and replace your initials with “Y (initials)” to show it is complete and that you have finished the task.

These are the materials you will need:

Once you have access to the files, follow the directions below. Contact Stewart if there are any issues.

6.1. Checkout Oral History Transcription Documents

To access the transcriptions (.docx files):

Open your terminal and create a new directory called "loiOH".

mkdir loiOH

Enter your new directory:

cd loiOH

... and checkout the repository. This mini repository is in a "secret" location only available to LOI svn users.
***You should be challenged with your Netlink and password credentials. If you are not, please let Stewart know immediately.

svn checkout https://hcmc.uvic.ca/svn/landscapes/oralHistoryDocs/originals/ . 

6.2. Transcription Stage

In the initial stage, you will listen to the audio file and write a rough transcription. Be sure to put your initials in the Spreadsheet to show you are working on it.

It is important to keep a standard for writing all transcripts, so while doing the initial stage, please write as follows:

JORDAN
We are here to talk to Mike Abe for the Landscapes of Injustice project. [Long pause.] Well Mike, thanks for speaking to me today.

MIKE
[Laughs.] Thank you for having me today, [laughs] Dr. Stanger-Ross. [Both laugh.]

This way first names are fully capitalized, and the square brackets delineate any verbal cues or information that is not spoken aloud by the interviewer or narrator. For example:

[Phone rings; tape is momentarily paused.] [Doorbell goes off, Jordan checks the front door.] [Mike’s voice becomes emotional.] 

Noting moments of emotion is especially important as these do not transfer clearly in the written document. It is also important that when transcribing you listen for moments where the narrator pauses and put commas or other grammar in relation to their verbal cues; spoken speech does not translate easily to the written word and will look strange on the page, but it is important to capture the narrator and interviewer’s way of speaking. This also shows characterization of speech.

Try not to include “uh,” “mhmm,” or “ah,” and limit use of “like” or “you know.” Overuse can seem jarring and distracting, but a few can show characterization of speech or emotion. Use your discretion when transcribing. Try to imagine how the person sounds when reading their words without the audio.

Keep note of moments where you may not be sure of spelling or titles by typing “(?)” beside the information. Titles of companies or areas you can’t find on an easy google search should also be marked with “(?).” This is imperative for the Final Check stage and keeps a consistent standard for searching within the documents. Mark any lines of Japanese with “(?)”. It is important that we check with narrators for this information later. You DO NOT have to find these terms at this stage—just write a rough draft of the interview. For example:

MIKE
My daughter, Shizu(?), is also working for Landscapes of Injustice. Shikata ga nai(?).

This way, when we do the Final Check, we are able to search within the document for “(?)” and generate the list of words we need to check with the narrator. Names are especially tricky because Laureen, Loreine, Loreen, etc., are all different variations of the same name. Some transcripts will already have this convention, but the majority do not. For anything that stands out as strange, or if you’re not sure, just put “(?)” because the transcript may have been written before this standard. This stage is the last chance to record these before the Final Check.

Lastly, it is very important to timestamp every five minutes. There is some flexibility, such as [01:21:12] or [00:04:36], but it is important to be as close to five minutes as possible. Once you have finished, add the Cover Page and fill out any metadata fields you can; some fields will be left blank and filled out at a later stage.

Also, if it is clear, please note whether a narrator is issei, nisei, sansei, or yonsei.

6.2.1. Cover Page

This is the cover page for all oral histories. It delineates the metadata that must be filled out for each interview, especially before it gets XML markup. This is available in the file server under “oh_documents” and titled “Oral_History_Transcription_Cover_Page.” There are a few exceptions for the Transcription Stage noted below, so only fill in those that do not say [Leave Blank]:

Interviewee Name: [Last, First]

Interviewer Name: [Last, First]

Interviewee Generation: [Issei, Nisei, Sansei, Yonsei, unknown, or non-applicable]

Interview Date: [YYYY-MM-DD]

Interview Location: [City, Province/State]

Interview Summary: [Leave blank]

Note: [Anything that should be noted about interview. Ex: If interviewer and narrator know each other, or if there is anything out of the ordinary]

Subject Keywords: [Leave blank]

Time Periods: [Key periods, such as: 1914; 1930s-40s, 1980s]

Consent Forms: [Check that the Consent Forms are filled out properly and saved onto the server; put “Digitally archived at UVic” if completed; if missing or incomplete in any way, make a note here as well as the spreadsheet]

Rights: [Check that the Media Release is filled out properly and saved onto the server; put “To project” if completed; if missing from records, make a note here as well as the spreadsheet]

Restrictions: [Include any notes about keeping names private or a narrator’s wish to view transcript etc. in the Consent Form. Note any reasons if you the transcriber or the interviewer believe this interview should be restricted from public access or completely destroyed. Update this on the Spreadsheet.]"

Sensitive material: [Consult the risk matrix.]

Transcriber: [Last, First]

Transcriber notes: [Anything worth noting from a transcribers point of view, such as moments missing because of a distraction that remains untranscribed for a substantial amount of time]

Translator: [Leave blank unless specified]

Translator notes: [Leave blank unless specified]

Equipment Used in Recording: [Should normally be “Zoom H2N”]

Media Type and Format: [Should normally be one “Audio .WAV file”]

Length of Interview: [00:00:000]

Language: [English, unless in rare cases it is in Japanese]

Landscapes ID Number (OFFICE USE): [Should be stated; contact Jennifer/Stewart if blank]

**Make sure your name is in the Transcriber metadata of the Cover Page and that you have updated the Spreadsheet upon completion, as well as any information that is missing (Consent Forms, Media Release, or Restrictions, etc.). Update the Spreadsheet column with “Y(initials)” to show that you have completed stage. DO NOT FORGET TO COMMIT YOUR CHANGES TO THE SVN REPOSITORY.

6.2.2. Naming Convention

After completing your transcription using your transcription software (possibly oTranscribe) copy and paste this information into a word editing document. You will save this word editing document based on the following convention:

source_tr_lastname_firstname.docx

You will determine the source out of three options based on when, where, and by whom the interview was done by. The three options are loi, bca, or nmm. You will know the source from where you accessed the audio file, and where the audio files are accessible from is located on the LOI Oral History Database_workflow spreadsheet.

loi_tr_kishi_roger.docx

If the interview contains multiple people the naming convention will be:

source_tr_lastname_firstname_and_lastname_firstname.docx

For two people:

loi_tr_yamamoto_terumi_and_jensen_fay.docx

For three or more people:

source_tr_lastname_firstname_lastname_firstname_and_lastname_firstname.docx

If an interviewee or interviewees conducted multiple interviews on different dates, then all subsequent interviews will receive a number based on when it occurred in the timeline of interviews (i.e. the first interview conducted in January 2019 receives no number, but the second interview conducted in February 2019 receives the number 2 at the end of the name, and the third interview conducted in March 2019 receives the number 3 at the end of the name, etc.) so the convention will be as follows for all interviews conducted after the first one:

source_tr_lastname_firstname_number.docx

For the initial interview:

loi_tr_moritsugu_frank.docx

And for the second:

loi_tr_moritsugu_frank_2.docx

When you have multiple interviews including the same people please combine the convention for multiple people and multiple interviews:

source_tr_lastname_firstname_and_lastname_firstname_number.docx

6.2.3. Adding to the SVN Repository

Now, you need to add your files to the SVN repository. PLace your .docx file in the "loiOH" folder. Then navigate to this folder in your terminal:

cd loiOH

Add your document to the repository with SVN:

svn add "fileName here"

And don't forget to commit!

svn commit -m "adding hutt3 interview"

6.3. Pre-Audio Check

This is the pre-audio check stage to determine the accuracy of a transcription and to decide which proper audio check process to proceed with, “Full” or “Partial”.

To start, put your initials in the Spreadsheet column N to show you are working on it. Then update the SVN repository before you open the working transcript.

Only edit documents from the hidden "loiOH" folder from the SVN repository. DO NOT update documents from the file server.

Once you have checked out the repository, you can open the loi_docx file. Next, go to the file server and open the .WAV or .MP3 file for that interview.

For the first, approximately 3-5 minutes, read the interview along with the audio to check for possible errors. You are to look out primarily for multiple discrepancies between the transcription and the audio, especially in the case of mistakes that lead to a change in meaning and intention.

You are to determine whether the next audio check process should be done in “full” or in “partial” process. The “full” audio check involves listening to the entire interview while copyediting, while the “partial” audio check involves listening to only 15 minutes of the audio.

This stage acts as an early indicator to RAs whether or not the transcription is in need of heavy editing and extra care. Please use your discretion when deciding how much work this transcript will need to be up to standard.

After deciding whether this interview requires the “full” or “partial” treatment, save and commit any edits you may have made. For a refresher, see “Using the Subversion Repository” section or refer to the SVN repository guidelines documents received from Stewart or Martin.

Return to the Spreadsheet and change the value to either:

Full (RA initials)
Partial (RA initials)

6.4. Audio Check

In this stage you will draft the official looking transcript for the standard LOI uses. You will be updating the Cover Page, checking for inaccuracies in the transcript, and writing the interview summary. Many of these transcripts were done prior to these standards and are in varying stages, and may require further editing than others.

To start, put your initials in the Spreadsheet column O to show you are working on it. Then update the SVN repository before you open the working transcript.

Only edit documents from the hidden "loiOH" folder from the SVN repository. DO NOT update documents from the file server.

Once you have checked out the repository you can work on one of the loi_docx files.

6.4.1. Cover Page

First, you will check the metadata on the Cover Page. Many transcripts were first written before this standard, and may have different information. Double check that the Consent Forms and Media Release are in the server and “Digitally archived at Uvic,” and that the rights are “To project.” Note any issues on the Spreadsheet and within the Cover Page of the working transcript for anything missing. Fix any improper standards (make sure it is Last Name, First Name, etc.) in the Cover Page.

Please see "Cover Page" section for instructions.

6.4.2. Editing Process

Next is to listen to the audio file while reading the transcript line-by-line to “copy-edit”. How much of the audio you are required to listen to during this process is indicated in the Spreadsheet in column N, whether the value is either “Full (RA initials)” or “Partial (RA initials)”.

If “Full”, it was previously determined that there were consistent transcription errors affecting readability not up to the conventions in place now. Listen to the whole interview while continuing the editing process.

If “Partial”, it was determined that there were minimal errors found, none that affected the meaning of the audio interview. Listen to roughly 15 minutes of the interview at minimum while continuing the editing process. It is at your discretion if you later determine it requires the “Full” treatment.

Other than the length of time spent listening to the audio, the editing and conventions are consistent. For all interviews, make sure all timestamps are in the centre of the page and wrapped in square brackets, correct any obvious errors, etc. Edit all ellipses into the format of “. . .” (dot space dot space dot). This is for consistency for future work. It is important to keep a standard for the writing of each transcript, so while doing this stage, please write as follows:

 [00:00:00] 

JORDAN
We are here to talk to Mike Abe for the Landscapes of Injustice project. [Long pause.] Well Mike, thanks for speaking to me today.

MIKE
[Laughs.] Thank you for having me today, [laughs] Dr. Stanger-Ross. [Both laugh.]

Return to the "Transcriptions" section for a refresher on conventions.

Keep note of moments where you may not be sure of spelling or titles by typing “(?)” beside the information. Titles of companies or areas you can’t find on an easy google search should also be marked with “(?).” This is imperative for the Final Check stage and keeps a consistent standard for searching within the documents. This should have been done during the transcription stage but might have been transcribed earlier before the standard. Mark any lines of Japanese with “(?)”. It is important that we check with narrators for this information later. Make sure the format follows as the example below:

 MIKE 
My middle name is Kenji(?). My mother would call me a yancha(?) if I was misbehaving as a child. Yancha bozu(?) she would say.

Certain transcripts will need to be heavily edited because they were written before this standard.

It is important to be reviewing the timestamps, especially since previous transcriptions did not have a clear guideline. Moving through the Audio Check, ensure that the timestamp [00:15:46] is every five minutes. There is some flexibility, such as [01:21:12] or [00:04:36], but it is important to be as close to five minutes as possible.

Note: Only do an Audio Check for files that have one .WAV OR .MP3 file. Make a note on the Spreadsheet for any interviews with multiple audio files.

Also, if it is clear, please note whether a narrator is issei, nisei, sansei, or yonsei.

At the very end of the Audio Check, you are also required to fill in the summary within the metadata.

6.4.3. Summaries

Summaries are extremely important for future researchers working with LOI material. They should be about half a page (more or less, depending on the interview). They should be half general/inclusive, and then half LOI specific, meaning focusing on the loss of property, what items seemed important to the narrators, and whether they returned to their homes after the war, etc. Here is a rough guide to help you (however, each interview is different so this is a suggestion rather than a strict standard):

  • 3-4 sentences about topics addressed in the interview (childhood, internment, Redress, etc.)
  • 1-2 sentences about what seemed important to the narrator or the emphasis that they brought
  • 1-2 sentences how it connects to dispossession:
    • discussion of loss
    • connection to dispossession
    • reflections on telling family history/family silences, etc

Be clear and concise, using active voice. Consider the summary as a sort of “teaser” that hits the important notes but doesn’t declare only one interpretation; imagine the narrator and how hard it is to summarize a person with one paragraph. Keep the tone open instead of static. For example:

Interview Summary: Roger Kishi’s father was interned in Christina Lake and his mother in Greenwood. In this interview, Roger explains that his paternal grandfather was a boatbuilder in Steveston and that his father built boats during the internment. Roger speaks about how his parents did not talk about internment, and his immediate and extended family also did not share their experiences. Roger narrates how as a teenager and early adult, he learned about this history during the Redress movement through books and documentaries. He explains that he cannot speak Japanese and feels he has lost his culture. He believes that it is important to record this history, to make sure it does not get lost, to acknowledge the wrongs in Canada’s past, and to focus on fighting discrimination of any kind. Roger recalls how his position as a community council member in Cumberland has led him to discover layers of this history: racism in mining records; the desecration of the Japanese gravesite after dispossession; Florence Bell’s class photographs in 1941 and ‘42 showing the loss of Japanese Canadian school children; and more. He describes an important connection for him that came in the early 2000s when he discovered the Campbell River Museum had a boat his paternal grandfather had built and sold to a Japanese Canadian family: the family sold the boat before seizure but bought it back in 1949 after they returned to the coast, fished it until the 70s, and then tied it up until the museum took possession and restored it. Even though dispossession is a hard history, he believes we must acknowledge and preserve it.
Interview Summary: Linda King was raised in Trail, British Columbia. She begins this interview by describing how when she was a child, she travelled with her mother and sister to visit Dr. Shimotakahara in Kaslo. She recalls how she played with Japanese-Canadian children and her mother visited Amy Fugioka, a woman with chronic arthritis. Despite this experience, Linda explains that she only learned about the internment and dispossession in her 50s. This was when she moved to New Denver to own a shop and her friend Nobby Hyashi brought her books on the internment. When she moved to New Denver, she also met Tad Mori, a Japanese Canadian who in 1942 was in charge of guarding Doukhobor children. She recalls seeing the paper-thin shacks and feeling angry whenever this history is mentioned. Her mother had a kind attitude towards Japanese Canadians, and King attributes her perspectives today to the impact this had on her growing up. She recalls going to a garage sale at her Japanese-Canadian son-in-law’s grandmother’s house where they had jewellery and mink coats; she explains that this gave her the idea that this family was well-off before being uprooted from Vancouver. King discusses how this history should never have happened, and says that the money from Redress was not enough.

For guidance on terminology, please see Jordan's LOI Public Outputs Language Guide.

6.4.4. Updating the SVN Repository

Now, you need to update your files to the SVN repository. First using the SVN commands for navigating in the repository (using cd to move in the repository, for a quick refresh please see the "Using the Subversion Repository" section or refer to the documents you received from Stewart or Martin for the SVN repository guidelines):

cd loiOH

And don't forget to commit!

svn commit -m "adding hutt3 interview"

6.5. Final Check

For this stage, you will be contacting narrators for any spelling or confusing information within the transcript before we do XML markup. To start, be sure to put your initials in the Spreadsheet to show you are working on this stage. Next, proofread the “Interview Summary” in the Cover Page, written by whomever finished the Audio Check. This is to catch any typos and/or other issues.

Now, it is extremely important to note whether a narrator has requested to review the transcript prior to future use or if they have not consented to the use of their full name in published material. This can be found in their Consent Form and should be noted within the “Restrictions” section of the Cover Page (update if it is missing and update the Spreadsheet). If the narrators HAVE NOT requested to review the transcript, then the Final Check is still required for project purposes, but if we never hear from the narrator then we can still go ahead with XML markup.

For the Final Check, you will go through the transcript document and search for any moments of “(?)” then highlight the associated word or name like shown in the image below within the transcript. Make sure there are page numbers in the document. For example:

After this, you will generate a PDF copy of the transcript. It is important that this is a PDF file so that when we send it to narrators, they cannot edit the document itself. After you have marked all the terms that need to be checked and created the PDF, you will then make a new document from the Final Check Document Template (available in the LOI file server in “oh_documents”, in the archival cluster google drive under Oral Histories>Oral History Documents, or on Basecamp). Title this to match the working transcript (loi_tr_abe_mike) with the Final Check suffix so that it lines up beneath the file (loi_tr_abe_mike_finalcheck). Upload this to the loiOH repository. For a refresher, refer to Adding to the SVN Repository. Within that new document, you will fill out the [DATE] and [INTERVIEWEE NAME] as well as the table. For example:

PAGE NUMBERNAME AND/OR INFORMATIONCORRECTIONS
31Shizu
31Shikata ga nai

To minimize the size of the fact checking document being sent to the narrators, please avoid repeating names. Use your discretion. If you think they may be referring to different people with the same name, then include each instance. This is to help make this process more efficient for the RA while asking for less work from our narrators, many of whom may be quite elderly.

After this step, you will then send an email (with the PDF and the new final check document) to the narrator. Their contact information can be found on their bio form in the file server.You will copy and use the Final Check Email Template (available on the file server in “oh_documents”, in the archival cluster google drive under Oral Histories>Oral History Documents, or on Basecamp). The email will offer them the option of submitting their corrections electronically or over the phone where you will fill out the table yourself. Please use the loi researcher gmail so a record of each exchange can be found—ask Stewart for login and credentials.

You may also call the narrators. This is an option because in the past we have had few responses to our electronic attempts. Ideally for ease of process, you can direct them to the email sent where they can choose to make corrections with you over the phone or on their own. They may do so electronically in the document or printed out, then scanned or mailed.

Suggested script for phone calls, please adjust as you see fit.

Hello I’m [your name] from Landscapes of Injustice, may I speak with [narrator’s name]. 

Hi I’m calling regarding the oral history interview you did with us in [year interview was done]. We are processing the interview now and would like to clarify some names and terms mentioned during your interview so the record is as accurate as possible. Do you have some time now to go over this list over the phone or would you like to fill out the document on your own and send it to us at a later date?

If they only have a phone number listed or the email bounced back, ask if they have access to an updated email address or perhaps a spouse or children’s account that the documents can be sent to. If not, or they have other reasons to be unable to use a visual copy of the list, you will have to verbally verify the correct spelling of each word or name. The easiest method for this could be to spell the name slowly and clearly to them, or for them to spell the name to you depending on how well their hearing is/how clearly they speak.

Note: a narrator might respond requesting edits to be made to the written record because they are concerned by how they sound after reading the transcripts. There is an email drafted to be sent in response to these cases titled “Response EMAIL TEMPLATE” (available on the file server in “oh_documents”, in the archival cluster google drive under Oral Histories>Oral History Documents, or on Basecamp.) If this occurs over the phone, follow the sentiment in the draft, explaining softly that this is a historical record and that although people’s words can read awkwardly at times. This is normal in speech and every interview is like this.

If we have attempted contact with a narrator and not heard back, we will go forward with the XML markup. However, this is only for those who have not requested to review the transcript and who have all their required documents (Media Release and Consent Form). If documents are missing, this should be noted in their Cover Page and the Spreadsheet if it has not already been done.

The Final Check is only completed once:

  • You have heard back from the narrator and made the corrections (if necessary) to spelling and/or other information;
  • If the narrator has not responded, and they did not request to review the transcript, then Stewart has given the OK for Japanese language speaking RAs to go forward and check the document;
  • If the Consent Form and Media Release are filled out and digitally archived at UVic.

We cannot go forward with XML without the documents.

When you have heard back from the narrator or Stewart has given the OK for Japanese language speaking RAs to check the document, you will record this at the very end of the Final Check document. For example:

Did narrator request transcript check: Yes.

Narrator contacted: Yes; email response 2019-04-15.

Corrections finalized: Yes.


OR


Did narrator request transcript check: No.

Was narrator contacted: Yes, but no response. Stewart Ok’ed and Nathaniel Hayes continued with check.

Corrections finalized: Yes.

6.5.1. Contacting Narrators for corrected forms

Another crucial task during the OH process is contacting narrators seeking corrected consent or media release forms, permission to use their real name, or for secondary permission after reviewing the transcript.

You can identify the interviews that have these complications or modifiers by looking at a few places in the OH workflow spreadsheet.

If the Access Location is in Yellow, there is an issue with the forms, no permission to use their real name, or they have requested to review the transcript. This is also indicated in the Permissions column and the NOTES/ISSUES column.

We cannot move forward with an interview if consent/media release forms are incomplete, or if they require the transcript to be reviewed.

We will need to contact the narrator’s according to the information we have available in the bio forms they filled out at the time of the interview. These can be found in the file server under their folder. Please contact them using the “Consent_Forms_EMAIL_TEMPLATE” document as a base for your email. Please adjust the email template as necessary according to the specifics of the missing content. This template document can be found in the LOI file server in “oh_documents”, in the archival cluster google drive under Oral Histories>Oral History Documents, or on Basecamp).

If there is no email listed on the bio form, it bounces back, or you don’t receive a response within a week or more, then try phoning the narrator, explain what the issue is (a missing signature, box not checked, etc.) and ask if they have an updated email address they can access where the documents can be sent to, or to check their inbox for it. We cannot accept consent over the phone as it must be in writing.

Suggested script for phone calls, please adjust as you see fit.

Hello I’m [your name] from Landscapes of Injustice, may I speak with [narrator’s name]. 

Hi I’m calling regarding the oral history interview you did with us in [year interview was done]. We are processing the interview now and have run into an issue regarding your [consent and/or media release forms]. [Explain what the issue is like there’s a missing signature, a box wasn’t checked, etc.]

It is very important to us that we properly correct this so we can ensure the wonderful interview you conducted with us can be included in the completed database.

[If you have attempted to send an email and didn’t hear back] I have sent an email to [read out the email sent to] with the original forms. Is this email up to date? [If yes] When it is convenient to you, could you please read over the email and reply with confirmation that you agree to the terms of the [consent/media release form]? If you’d rather, I could walk you through the email over the phone now or on another work day. The project requires written consent so I unfortunately cannot accept your consent over the phone but I could help walk you through the email now or another work day that is more convenient to you.

[If no email listed, email bounced back, or you are told the email is not current] Do you have access to an updated email address so I can send the email? When it is convenient to you, could you please read over the email and reply with confirmation that you agree to the terms of the [consent/media release form]? If you’d rather, I could walk you through the email over the phone now or on another work day. The project requires written consent so I unfortunately cannot accept your consent over the phone but I could help walk you through the email now or another work day that is more convenient to you.

Thank you very much for sharing your story with the project and for your cooperation again now.

6.5.2. Cover Page

Update the Cover Page and ignore those that say [Leave Blank].

6.6. XML Mark Up

Once the transcript has been Audio Checked and Final Checked, has all the necessary forms, then it is ready and polished for XML mark up. At this point, we should no longer have to alter the document or contact narrators.

Take note of the “Keywords” list in the metadata. All proper nouns being marked up within the document will be generated here. If there is a list from the transcript cover page, you can include them here beforehand. It is important for you to take note of any keywords that don’t fit the categories of Persons (personography), Places (placeography), and Organizations (orgography). These kinds of things include: titles of boats, titles of books, etc.

6.6.1. XML Quick Guidelines

When making new IDs for people, places, and organizations, ask yourself if this needs to be marked up and referenced, or if it is redundant information. For example, Ocean Falls is a secluded mill town on the coast of BC, but Chapel Hill, North Carolina is just a place a narrator lived once in their lives and has nothing to do with this history. Ask yourself what is worth mentioning, and what doesn’t need to be coded.

Only include street names within our four research areas: Vancouver, Steveston, Haney, and Salt Spring.

People should have IDs if they have some identifiable character or reference to this history.

6.6.2. XML Mark-up Steps

This a a step-by-step guide for marking up oral history transcriptions in TEI XML. Some details may differ for each interview but in general these steps are the tasks required to complete this task.

If you are starting to work on Oral Histories at this stage, here is how you determine which files to work on, in consultation with the Oral History Database workflow spreadsheet:

  • Look for a transcript that has someone's initials and a "Y" in the 'Final Check' column. This means that all other previous steps have been completed and it is ready to be worked on. If it is just the initals, it is in progress.
  • Make sure that nobody has written their initials in the 'XML' column. If there are initials here, someone is already working on it and you need to find another.
  • Once you have found one to work on, write your initials in the 'XML' column to indicate you are working on it

Now that you have selected which file to work on, open the transcipt. Sometimes there are multiple docx files that appear to be the transcript. Usually, it is one named loi_tr_lastname_firstname but when you open it double check that there is a name listed as having completed the Audio Check and the Final Check. Please also make sure that these names match those listed in the spreadsheet.

The following are the steps for XML mark up:

  • Location: Every interview has an XML file with incomplete metadata. You will find your assigned transcript in data/oralHistories.
  • Add <respStmt>. You are an Encoder:
  • Complete any missing metadata. For example, <desc> in the <media> element.
  • Add keywords and abstract supplied in the transcript from the svn repository. And mark them up along Oral History markup quick guidelines.
  • Add timeline and use timestamp values supplied in the svn copy of the transcript for @absolute value.
    XML DocumentTranscription
  • Each roughly 5 minute block of the interview is wrapped in an <annotationBlock>. Every time a new person speaks, their statements are wrapped in an <u> element.

To start marking up the transcript replace <div><gap/></div> with interview content wrapped in <annotationBlock> and <u>. Copy and paste the text from the transcription, wrap in these elements and mark up according to the quick guidelines. Add new people to personography if they are either Japanese Canadian or a figure significant to this history that is not yet in the personography. Only add places and organizations if they are important. Make sure to mark up every instance of these (If "Japan" is mentioned 50 times, it needs to be marked up with a <placeName> 50 times). Example:

<annotationBlock start="#timestamp0"  end="#timestamp1">  <u who="team:peki2">We'll just start by saying that we are interviewing <persName ref="prs:baba2">Mr. Sam Baba</persName>, today at the <orgName ref="org:jccc2">Japanese Canadian Cultural Centre</orgName> on October 27th, 2015.  Thank you very much for meeting with us and doing  this interview.</u>  <u who="prs:baba2">You are more than welcome.</u>  <u who="team:peki2">Great. So, <persName ref="prs:baba2">Mr. Baba</persName>, please tell me about your life.</u>  <u>Well, as you know, back in 1945 when the Pacific War ended, all  of the Japanese were relocated outside of the <placeName ref="plc:brit1">BC</placeName> coast line into a lot of places,  at that time,  called ghost towns, which is a mining town that depleted.  To accommodate the Japanese,  they relocated to these so-called ghost towns.  So I was 15 at the time,  when the war broke out, and the whole family - of course, men over 18 years old - were all gathered  and shipped into what they probably called prisoner camps.  So mothers and children were all left without their fathers and big brothers.  So we were shipped to a place called <placeName ref="plc:kasl1">Kaslo</placeName>, and that's where we started our life. Yes our dad and all the fellows that were over 18 we're never reunited with their families again for quite a few years.  So we lived in the ghost town for about 4 or 5 years,  I guess at the time. When the war ended the government gave us a choice of - we couldn't go back to <placeName ref="plc:brit1">British Columbia</placeName>, we had to go east of the Rockies. <placeName ref="plc:albe1">Alberta</placeName>   <placeName ref="plc:sask6">Saskatchewan</placeName>   <placeName ref="plc:mani1">Manitoba</placeName> or <placeName ref="plc:queb1">Quebec</placeName>.  So we were in a place called <placeName ref="plc:tash9">Tashme</placeName>, and my brother and I --  what happened was -- my brother and I signed for <placeName ref="plc:japa1">Japan</placeName>, my dad made us sign for <placeName ref="plc:japa1">Japan</placeName>. The two oldest sons. He had 7 sons <incident>    <desc>laughs</desc>   </incident>, and 4 daughters.  So the oldest one,  he made us sign to go to <placeName ref="plc:japa1">Japan</placeName>.  So we didn't want to go back to <placeName ref="plc:japa1">Japan</placeName>.  However when we signed for <placeName ref="plc:japa1">Japan</placeName>,  we got shipped out to a place called <placeName ref="plc:tash9">Tashme</placeName>, <placeName ref="plc:brit1">BC</placeName>,  where all the people that signed for <placeName ref="plc:japa1">Japan</placeName> got sent there. So after the war they will be shipped to <placeName ref="plc:japa1">Japan</placeName>.  So after the end of the war,  the government gave us a chance to cancel our trip to <placeName ref="plc:japa1">Japan</placeName>.  So I wrote my dad and said, <q> What should we do?</q>. He said, <q>You cancel it</q>,  and at the time I was going around with my wife.  So we got married.  My dad took the whole family to Thunder Bay, Fort Williams. And they went to a bush camp to work in a logging factory.  So my wife and I got married in <placeName ref="plc:tash9">Tashme</placeName>,  and <placeName ref="plc:toro1">Toronto</placeName> and surrounding areas were all closed to Japanese, you couldn't come in here, you know?  Unless you had a sponsor.  Fortunately for us my wife had a very good friend living in <placeName ref="plc:toro1">Toronto</placeName> already,  so she sponsored us,  and rented a Jewish home on Bathurst Street - one bedroom.  So we came to <placeName ref="plc:toro1">Toronto</placeName> back in 1946 I think it was.  And we started living in this Jewish home.  And then fortunately my wife was a seamstress,  she had her own dress company,  little dress store in Vancouver.  So when we came here, she was able to find work right away at a Jewish dress manufacturing company called Exclusive Dress on King St.  So she found a job right away.  We had no money, you know,  to speak of.  After paying a couple weeks rent we had nothing.  Fortunately she started working so at least we we're able to pay rent and eat.  And I used to read <placeName ref="plc:toro1">Toronto</placeName> newspapers every day looking for the want ads,  and I would go apply for a job.  As soon as they see my black hair -  position filled.  I walked the streets of <placeName ref="plc:toro1">Toronto</placeName> for 3 months,  couldn't find a job, nobody hired me, you know? I said, <q>oh my God, what did I get myself into?</q>.  Later on a friend of mine phoned me, said <q>Sam, there is a job at a Jewish factory, a toy company.</q> I said, <q>I don't care what it is, I'll take it.</q>  </u> </annotationBlock>

* Don't forget to change the timestamps on the next <annotationBlock>.

<annotationBlock start="#timestamp1"  end="#timestamp2"/>
Add incidents of significance (i.e. things that interrupt the interview or the flow such as answers phone call, door, checks on dinner etc) with a <desc> in an <incident> tag:
<incident>  <desc>Dishes clatter in the background again</desc> </incident>

We are marking up all people, places, and organizations. Please refer to the TINA Mark Up guide for details on this process. Also see Creating XML ids for instruction on how to enter a new entity into the database. BUT, before you start marking up your transcript, please see below for tricks and tips on how to do some of the mark up mechanically and efficiently.

Below are more specifics on marking up transcriptions.

6.6.2.1. Action, Pauses, Laughter, and Other Moments

Anytime there are square brackets in the original transcript relating to a non-speech moment in the original interview, encode these moments with elements <incident> and then <desc>. For example, a [Pause] in XML would become:

<incident>  <desc>Pause.</desc> </incident>

Make sure to remove the square brackets. Also, inside the <desc> element the first word should always be capitalized and there should always be a period before the closing <desc> element.

In the instance when something is unclear, tag the "[unclear]" text with:

<unclear/>

The "unclear" text does not need to be included.

If there is text from the transcript noted as unclear, such as:

I think they were happy. [Unclear about this statement because it was difficult to hear the narrator.]

Wrap the uncertain text with the <unclear> element:

<unclear>I think they were happy.</unclear>

6.6.2.2. Editorial Notes

Due to inconsistencies in transcribing oral history interviews, some square brackets also contain editorial notes from transcribers or others.

Editorial notes should be marked up using a <note> element with an type attribute with the value of “editorial” and an resp attribute with the value of “team:(team member’s ID that made the editorial note)”.

For example, if Nathaniel Hayes with XML ID haye1 transcribed an interview and left the editorial note [This Japanese word means fish paste.] The mark-up would be as follows:

<note type="editorialresp="team:haye1">This Japanese word means fish paste.</note>

These notes should appear in the exact location where they were found in the transcript and the element should be beside the final punctuation of the sentence (i.e. think of them like a footnote; there should be no space between the period, comma, or quotation that the footnote follows):

<p>Here is some text about a thing.<note type="editorialresp="team:haye1">Note Like This.</note> And here is some more text.</p>

6.6.2.3. Quotes and Quoted Speech from the Transcript

Mark up all literal quotation marks in the original transcript with the <q> element and remove the quotation marks added from the original transcript.

For example:

<p>She would tell me, “Eat all your food.”</p>

Would look like:

<p>She would tell me, <q>Eat all your food.</q> </p>

6.6.2.4. Japanese Language Words in English Transcripts

When a Japanese word is in an English transcript, we encode these words with the <foreign> element and the xml:lang attribute with the value of “ja-Latn”:

<foreign xml:lang="ja-Latn">takai</foreign>

If you are unsure if a word is a Japanese word, please ask someone on the LOI team with Japanese language knowledge.

6.6.2.5. Sensitive Text and Personal Information

We have been advised that very little should be redacted from the oral history interviews. Be very selective in what you deem severe enough to be omitted as it should be either personal details that are a risk if made public (like contemporary home address or contact information) or detailed/graphic accounts of mental distress or death. If you are unsure, feel free to reach out to fellow RA’s or contact Gord or Stewart.

6.6.2.5.1. Address or Home Location

If an address is listed or a person’s home has been described in a way that could be identifiable via google searching (i.e. mentioning someone lives in West Vancouver is general enough to include, but mentioning that someone currently lives near a recognizable landmark in a named community is of concern), then this information needs to be redacted for privacy concerns.

To redact the information, we use the <gap> element with the attribute reason and the value “privacy”.

For example:

<p>We are interviewing Nathaniel Hayes at his home at <gap reason="privacy"/>, which is quite beautiful.</p>
6.6.2.5.2. Sensitive Information

Based on our Risk Matrix guidelines, certain information was deemed sensitive. This text should already be marked in the .docx transcript, and the type of sensitivities should be listed at the top of the XML document in the <TEI> element under the ana attribute (if not please refer to metadata mark up steps).

Sensitive text should be wrapped in the <seg> element with the ana attribute and the appropriate sensitivities.

For example:

<p>And that is how fish paste was made in Tofino. But I am remembering something. I never tried it when I was younger. <seg ana="sens:stereotype">It was something you just didn’t do back then, eating food Orientals made.</seg> </p>

Outdated language should be flagged for oral histories.

If the sensitive material spans two utterances, then the sensitive material will require multiple <seg> elements because <seg> elements must be within a <u> element. If split by an <annotationBlock> or a new utterance for example, then ensure both <seg> elements are self contained on either side of the <annotationBlock> in <u> elements.

<u who="prs:fake1">  <seg ana="sens:stereotype">It was something you just didn’t do back then. . .</seg> </u> <u who="team:fake2">Didn’t do what?</u> <u who="prs:fake1">  <seg ana="sens:stereotype">Eat food Orientals made.</seg> </u>

6.6.3. Marking up dual language interviews

If your interview is in two languages (English and Japanese) please leave the mark-up for this to our LOI language experts. An example of this kind of interview can be seen in yama81_2018-03-19.xml where the main language spoken is Japanese and the speakers occasionally switch to English. If you are to transcribe a dual language interview, please use this document as a guide for mark-up. Note that xml:id for <u>, in each language, correspond with a <u> of the other language, have an abbreviation indicating the language of the referent and the utterance, and have the id of the interview prepended to it. And the reverse is true for the corresp:

<annotationBlock start="#timestamp0"  end="#timestamp1">  <u xml:id="yama81_2018-03-19_en1"   xml:lang="encorresp="#yama81_2018-03-19_entrans1"   who="team:naka96"> So, this is <persName ref="team:naka96">    <forename>Carolyn</forename>    <surname>Nakagawa</surname>   </persName>. I'm here with <persName ref="prs:yama81">    <forename>Terumi</forename>    <surname>Yamamoto</surname>   </persName> and <persName ref="prs:jens1">    <forename>Fay</forename>    <surname>Jensen</surname>   </persName>, and we are here at their home in <placeName>Richmond</placeName> to record <persName ref="prs:yama81">    <forename>Terumi</forename>   </persName>'s oral history for the <orgName>Landscapes of Injustice</orgName> Project. And, it is <date when="2018-03-19">March 19th, 2018</date>.    So, <foreign xml:lang="ja">    <persName ref="prs:yama81">     <forename>てるみ</forename>    </persName>さんと呼んでもいいですか.</foreign>  </u>  <u xml:id="yama81_2018-03-19_entrans1"   xml:lang="encorresp="#yama81_2018-03-19_en1"   resp="#yama81_2018-03-19_trl"> So, this is <persName ref="team:naka96">    <forename>Carolyn</forename>    <surname>Nakagawa</surname>   </persName>. I'm here with <persName ref="prs:yama81">    <forename>Terumi</forename>    <surname>Yamamoto</surname>   </persName> and <persName ref="prs:jens1">    <forename>Fay</forename>    <surname>Jensen</surname>   </persName>, and we are here at their home in <placeName>Richmond</placeName> to record <persName ref="prs:yama81">    <forename>Terumi</forename>   </persName>'s oral history for the <orgName>Landscapes of Injustice</orgName> Project. And, it is <date when="2018-03-19">March 19th, 2018</date>.    So, may I call you <persName ref="prs:yama81">    <forename>Terumi</forename>   </persName>?  </u>  <u xml:id="yama81_2018-03-19_ja1"   xml:lang="jacorresp="#yama81_2018-03-19_jatrans1"   who="prs:yama81"> はい.  </u>  <u xml:id="yama81_2018-03-19_jatrans1"   xml:lang="encorresp="#yama81_2018-03-19_ja1"   resp="#yama81_2018-03-19_trl"> Yes, you may.  </u>  <u xml:id="yama81_2018-03-19_en2"   xml:lang="encorresp="#yama81_2018-03-19_entrans2"   who="team:naka96"> Yes, so can I ask you about your first memory of your life? Do you remember from your childhood, early memories? <foreign xml:lang="ja">子供の頃の<choice>     <orig>記憶</orig>     <reg>(きおく)</reg>    </choice>がありますか。</foreign>  </u>  <u xml:id="yama81_2018-03-19_entrans2"   xml:lang="encorresp="#yama81_2018-03-19_en2"   resp="#yama81_2018-03-19_trl"> Yes, so can I ask you about your first memory of your life? Do you remember from your childhood, early memories?    Do you have any recollection of your childhood?  </u>  <u xml:id="yama81_2018-03-19_ja2"   xml:lang="jacorresp="#yama81_2018-03-19_jatrans2"   who="prs:yama81"> (?) 分からん。  </u>  <u xml:id="yama81_2018-03-19_jatrans2"   xml:lang="encorresp="#yama81_2018-03-19_ja2"   resp="#yama81_2018-03-19_trl">   <unclear>(?)</unclear> I don’t understand.  </u> </annotationBlock>

6.6.4. Encoding Tricks and Troubleshooting

This section provides instructions for a search/replace trick using regular expressions (regex) and a way to check <annotationBlock> attribute values with XPath.

6.6.4.2. Using XPath to troubleshoot <annotationBlock> errors

Sometimes (especially while encoding longer interviews) you may find that you forgot to change the values of the timestamp attributes in the <annotationBlock>. You can use XPath to see all the <annotationBlock> and their attribute values.

First enter this query in the XPath box on the toolbar:

//annotationBlock

Hit enter and down below you should see the list of <annotationBlock>.

Note that the @start and @end are reversed. This is fine; you can still scroll through this list to see where timestamps were missed or duplicated causing error in timestamp markup.

Tip: timestamps are roughly 5 minutes apart. If you are adding an <annotationBlock> at a time that is roughly close to a time that ends in an even number, the number of your @start should be even as well; and vice versa for odd numbers.

6.6.5. Final Steps

Finally, make sure your name is in the XML metadata of the Cover Page and that you have updated the Spreadsheet.
DO NOT FORGET TO COMMIT YOUR CHANGES TO THE SVN REPOSITORY.

Thank you for helping us finish these interviews! They are a benefit to the project and your work is highly appreciated!

6.6.6. Encoding Supplementary Materials and Related Items

In some cases, oral histories contain related items that should be distributed with the interview (photographs, scans of documents, et cetera). These files (usually collected into a single PDF) should live on the HCMC server. Once they have been placed on the server, a pointer to the file's location on the server should encoded in the document's <notesStmt> (between the <publicationStmt> and the <sourceDesc> in the document's <teiHeader>) using a <relatedItem> with a type=supplementaryMaterial and an target that points to the file's location on the server:
<relatedItem type="supplementaryMaterial"  target="ext:oralHistories/pdfs/oral_history_barn23_2019-02-28.pdf"/>
Here's the same example, but in the broader context of the <teiHeader>:
<teiHeader>  <fileDesc>   <titleStmt> <!--[...]-->   </titleStmt>   <publicationStmt> <!--[...]-->   </publicationStmt>   <notesStmt>    <relatedItem type="supplementaryMaterial"     target="ext:oralHistories/pdfs/oral_history_barn23_2019-02-28.pdf"/>   </notesStmt>   <sourceDesc>    <recordingStmt> <!--[...]-->    </recordingStmt>   </sourceDesc>  </fileDesc> <!--[...]--> </teiHeader>

6.6.7. Specifying Sequences of Oral Histories (Added 2021-02-13)

Sometimes, interviews are conducted over multiple days or are somehow related to one another in a sequence. While this was fomerly specified in the <title> of the document, the project has decided to take a more formal approach for noting sequences to aid in navigating the document collection.

Specifying a sequence of documents is a bit labour intensive, but fairly straightforward. On the document's <text> element, use the next and prev attributes to point to the next and previous documents in the sequence respectively using doc: prefix and the target document's xml:id. Here is an example from the second of three oral histories narrated by Winifred Awmack:
<text prev="doc:oral_history_awma1_1984-02-06"  next="doc:oral_history_awma1_1985-02-21"> <!--[...]--> </text>
Note this must be done for every document in the sequence: i.e. for the sequence of documents A, B, C, you need to encode:
Documentprevnext
Adoc:B
Bdoc:Adoc:C
Cdoc:B
To use the Winifred Awmack interview as an example:
<!--oral_history_awma1_1984-02-06.xml--><text next="doc:oral_history_awma1_1984-02-08"> <!--[...]--> </text> <!--oral_history_awma1_1984-02-08.xml--> <text prev="doc:oral_history_awma1_1984-02-06"  next="doc:oral_history_awma1_1985-02-21"> <!--[...]--> </text> <!--oral history-awma1_1985-02-21--> <text prev="doc:oral_history_awma1_1984-02-08"> <!--[...]--> </text>
The diagnostics will flag any errors in this sequencing, so make sure to confirm the validity of the pointers by checking the diagnostics after the build has completed.

7. Case Files Data Entry Guide

This process and template are the end result of a period of trying different ways of working with the case files and is what we have found to be the easiest and quickest way to process case files while still maintaining a high level of detail for each file.

7.1. HCMC Setup

7.1.1. Google Drive Permissions

  • Gain access to the Archival Cluster Google Drive by having another RA with access share it with you (it is only accessible by collaborators). Bookmark this page as you will be working with it often.

7.1.2. Local Machine Setup

  • In your “Documents” directory (folder), create a subdirectory (subfolder) titled “casefile_conversions” (do not include the quotation marks in the folder name).
  • Within “casefile_conversions”, create another directory titled “Hopper”.
  • Retrieve (download and save) the pdf-maker shell script titled “rg117_CaseFiles_pdfMaker.sh” from Archival Cluster Google Drive to your local machine and move it to “casefile_conversions” directory.
  • To make the pdf-maker shell script executable, right click the program and select properties. Under Permissions, check the box that states “Allow executing file as program”.

Your “casefile_conversions” directory should now be set up as follows:

7.1.3. Access and Drop Point

  • Open the File Manager tab from the command bar (located in the vertical toolbar on the Desktop).
  • Select Other Locations noted on the left side (scroll down to the bottom of the list).
  • Connect to the server:
    • If this is your first time, where it states “Enter server address” enter “sftp://nfs.hcmc.uvic.ca” then select “connect”. (If you cannot access this server, please talk to Stewart or Martin for permissions; this may take a day or two due to Uvic programming administration.)
    • If this is not your first time, select the down arrow (next to the “Connect” button), select the recent server titled “/ on nfs.hcmc.uvic.ca sftp://nfs.hcmc.uvic.ca/”, and then select “Connect”.
  • To access the server, fill in your netlink ID and password when prompted. You may be presented with the option to save your login details so you don’t have to re-enter them every time you log in to your machine; select whichever option you prefer and then select “Connect” (or press the enter key).
  • Follow this path through directories (folders) to the case files:
    home1h/loi/dev/LAC/rg117/rg117_c-3
  • The directories inside of “rg117_c-3” contain the various microfilm reels you will be processing (e.g., the directory “C-9322” contains the C-9322 microfilm reel images).
    • To start, locate the directory “rg117_C-3_PDFs” inside of “rg117_c-3” (it should be the last directory in the list if you have the directory ordered alphabetically by name). Right click on “rg117_C-3_PDFs” and select “Open In New Window”. [Note: Opening directories in this way (right clicking and then opening in a new window or tab) will maintain your access to the server so you don’t have to reconnect every time when opening multiple directories in different windows; however, you can always reconnect in any window by re-following the steps above.]
    • “rg117_C-3_PDFs” is the directory to which you will upload your pdfs (after making a pdf for a single case file). For now, drag this window aside for later.

7.1.4. Starting a Microfilm Reel

  • Return to the open “rg117_c-3” window and select a microfilm reel directory to work on (e.g., directory “C-9321”):
    • Determining which reel to start working on is done by consulting the Case Files (RG117 C-3) Tracker to see which reels have already been completed and which are currently being worked on by other RAs. Reels are processed in sequential order, so it’s recommended that you start on the next sequential reel (i.e., the reel that follows the one[s] currently being worked on by others). [Note: It’s best practice to bookmark the tracker as you will be using it often.]
    • In the tracker, scroll down to find the last completed case file; note the reel number (column H of spreadsheet) of this file as you will be starting on the next sequential reel.
    If you need assistance, ask a fellow RA (who is working on case files) to confirm which reel you can start on.
  • Open your microfilm reel and starting page
    • In the same “rg117_c-3” window, open the reel directory you’ve elected to work on.
    • Open a page (a jpg file) in the reel directory to start working from:
      • If starting a new reel, you will start on page 0001.
        • Note: In some cases, the first page of a new reel may not coincide with the first page of a case file (e.g., page 0001 of reel C-9322 is part of case file #1604, which actually begins in the previous C-9321 reel).
        • If your reel begins with a case file that started on previous reel, ignore it and move to next case file. If your last case file crosses into the next reel, go to that reel, download the images to complete the case file, place them in your "hopper" along with the other images, and then execute the shell script.
      • If not starting a new reel and continuing one already in-progress, reference the Case Files Tracker to check which page to start from in this reel (i.e., the next sequential page in the reel following the case files that have already been completed and recorded in the spreadsheet).
    • Drag both the “rg117_c-3” window and the opened case file page (jpg) aside for later.

7.1.5. Hopper and Terminal

  • Open the “Hopper”:
    • If not already open, open the “casefile_conversions” directory (on your local machine) that you created in the Local Machine Setup stage.
    • Right click on “Hopper” and select “Open In a New Window”.
    The “Hopper” is where you will copy your microfilm reel images to in order to make pdfs.
  • Use the Terminal to move to the “casefile_conversions” directory:
    • Open the Terminal (located in the toolbar on your desktop).
    • Determine which directory you created “casefile_conversions” in (if not in “Documents”); move to that directory and then move to “casefile_conversions”. For example:
  • Once in “casefile_conversions”, (Linux .sh users) open the pdf-maker shell script by typing “./r”, press Tab to autocomplete “rg117_CaseFiles_pdfMaker.sh”, and then press the enter key.
    (Windows .bat users), start typing "rg..." and press tab to autocomplete, and the press the enter key.

    This shell script will be used to generate the pdfs and metadata for input into the tracker.

7.1.6. Metadata Notes Document and Templates

Create and set up a text document for your metadata notes:

  • Open up LibreOffice (in the toolbar on the desktop).
  • Create a new text document.
  • Copy and paste the following page into your text document:
    [Reel number you’re working on; e.g., C-9321] Metadata Notes - [Your Name]

    Reel started: yyyy-mm-dd. Reel finished: yyyy-mm-dd.

    METADATA FORMATTING *also see Metadata Formatting Section

    Page # Range: ####–####

    Microfilm Reel #: C-xxxx (e.g., “C-9316”)

    Case File #: #####; #####_xi (e.g., “01626”; “0135_xi”)

    File Person’s Name: last-first (e.g., “tanaka-kenji”)

    Citizenship Status: naturalized Canadian; Canadian born; Japanese national; unknown

    Sex: 0 (unknown); 1 (male); 2 (female)

    Metadata Author: First Last (e.g., “John Smith”)

    Type: person; business

    Sensitive: *see Sensitive
    METADATA TEMPLATE

    PAGE #s TO ROTATE:

    Page Range:

    Microfilm Reel #: [Reel number you’re working on; e.g., C-9321]

    Case File #:

    File Person’s Name:

    Citizenship Status:

    Sex:

    Metadata Author: [Your Name; e.g., “John Smith”]

    Type:

    Scope and Content:

    He was born on _. He was a(n) _ employed by _. His family includes _. His home address is listed as (or He lived at/in) _. He was forcibly uprooted to _.

    or

    She was born on _. She was a(n) _ employed by _. Her family includes _. Her home address is listed as (or She lived at/in) _. She was forcibly uprooted to _.

    Sensitive:
  • In your text document, replace all the square brackets with the information relevant to you and the reel you’ll be working on.
  • Save this document in “casefile_conversions”, including the reel number and your name in the title (e.g., “C-9321 Metadata Notes John Smith”).

The template is what you will use to record metadata and write scope and content as you process case files. For each new case file you work on, you will re-use the template section in your text document by copy and pasting, always leaving yourself a blank one in your text document for future use.

Note: The paragraph format is set up in such a way that double clicking on the underscores will select them, allowing you to replace them by inputting the information for that field.

You’re now all set up to process case files!

7.2. Processing Case Files

You will be working page-by-page through each case file, writing metadata notes for the file in your text document as you go along. Afterwards, you will create a pdf for the file using your metadata notes, upload the pdf to the HCMC server, and input the metadata into the Case Files (RG117 C-3) Tracker.

If you’ve followed all the steps in the previous sections above, the following should already be open (if not, open them now):

  • “casefile_conversions”
  • “Hopper”
  • “RG117_C-3_PDFs”
  • Case Files (RG117 C-3) Tracker
  • e.g., “C-9322” (your chosen microfilm reel)
  • e.g., “c-9321-0952.jpg” (starting page, or page you left off on, of your microfilm reel)
  • Terminal with pdf-maker shell script (“rg117_CaseFiles_pdfMaker.sh” or “rg117_CaseFiles_pdfMaker.bat”) open
  • your “Metadata Notes” text document

7.2.1. Screens Layout

1. First, you’ll need to arrange the windows listed above on your screens in a manner that is efficient for you to navigate between them as you work.

While you’re working page-by-page through a case file, you’ll need to have the Image Viewer window (displaying jpg pages of the file) and your “Metadata Notes” text document (to take notes as you read) most prominently in view.

However, in the background you should also have all the other windows ready for the next steps afterwards.

Recommendation:

On one screen have open the following (on the left screen in the example above, clockwise from the top left):

  • “casefile_conversions”
  • “RG117_C-3_PDFs”
  • your starting case file page.
  • your chosen microfilm directory
  • “Hopper”

On the other screen have open the following (on the right screen in example above, left to right):

  • your “Metadata Notes” text document
  • Terminal window with pdf-maker shell script open
  • internet browser with Case Files (RG117 C-3) Tracker open (behind other windows or minimized)

2. Once you’ve laid out your windows, you can now enlarge your Image Viewer window with the first page of your case file to take up an entire screen (to more easily read through the file).

Note: You can snap a window by clicking its title bar and dragging it to the edge of a screen and holding it, letting go after the blue snap-preview animation appears. Drag and hold to the top of a screen to make the window full screen. Drag and hold to either the right or left side of a screen to make a window half screen (vertically).

Please read through the rest of this guide before starting to process case files on your own.

7.2.2. Metadata Formatting

Certain metadata fields need to be strictly formatted according to the metadata guidelines below to ensure the correct output. For now, read through and familiarize yourself with the guidelines; however, as you work, please refer back to the guidelines often until you’ve memorized the correct formatting.

METADATA FIELDSNOTESEXAMPLES
Page # Range:

####–####
Each page range must be 4 digits; add zero(s) before the page numbers if less than 4 digits. Page numbers are listed in the file names of the jpgs (last 4 characters/digits of file name).0001-0025
0952-1053
Microfilm Reel #:

C-####
Reel number is found in the directory name and also in the file names of the jpgs (first 6 characters of file name).C-9322
Case File #:

#####
#####_xi
Case file numbers must be entered as 5 digits; add zero(s) before the case file number if less than 5 digits.

For case files which have “XI” listed before the case file number (e.g., “XI-1305”), add “_xi” after the file number to assure sequential filing.
00250
01305_xi
12500
File Person’s Name:

last-first
File person’s name must be entirely lowercase, with the last name and first name separated by a hyphen only.

If the person has more than one listed first name or other name, put only one in this metadata field. Use your discretion on which name to use in the metadata (for example, you could use the name that appears in the file most often). Then, include the person’s full name and/or alternate names in the scope and content.
tanaka-kenji
suzuki-yuki
Citizenship Status:

naturalized Canadian
Canadian born
Japanese national
unknown
The file person’s citizenship status; found on the “Information from R.C.M.P.” form (usually the second document in file).

Use uppercase for Canadian and Japanese only.
Sex:

0
1
2
0 = unknown
1 = male
2 = female
Metadata Author:

First Last
Your name.John Smith
Type:

person
business
Indicate whether the case file is for an individual person or a company/business. The majority of files are for people.

* See “Businesses” if you come across a business case file.
Scope and Content:* See “Scope and Content Style Guide”.
Sensitive:*See “Sensitive”.

Note 1: The order of the fields listed above is not necessarily the order that such information will appear in a file; rather, this order is reflective of how you will need to enter data in the Terminal for the pdf-maker shell script. We will explain this process in the pdf Making section.

Note 2: Sometimes you will come across duplicate images of the same case file. In such cases, you will write “DUP” and the page range of the duplicate in square brackets following the actual page range. For example, “0397 - 0400 [DUP 0401 - 0404]”.

Note 3: If a file spans two reels, record the page range of the file in both reels and enter it into tracker as “xxxx - xxxx [xxxx - xxxx]” (with the data in the square brackets being the page range of the second reel). For example, “2354 - 2413 [0001 - 0056]”. Also, record the second reel number in square brackets after the first. For example, “C-9317 [C-9318]”.

7.2.2.1. Process Example Pt. 1: Initial Metadata

In this section, we will start working through case file #1630 from start to finish as an example of the metadata-writing process.

  • Starting with the first page of your case file, you can already begin filling out some of the metadata. Usually, the first page of a case file starts with an index card with the case file number written on it.
    From this first page, we can note in our text document the starting page of the file (“0952 - ”), the case file number (“01630”), and the reel number (“C-9322”).Note: Confirm that this initial handwritten case file number matches those listed on the documents following it.
  • Usually, the next document in the file is an “Office of the Custodian - Japanese Section” form for the file person.
    From the first page of this form, we can note the file person’s name (“nogami-sankichi”) and their sex (“1”), which we can use to assume which pronoun template to use.Note: The version of this initial Office of the Custodian form may vary from file to file depending on the age of the file person and how much property they owned. The one in the example above is the longer three-page form; you may also see a one-page form instead.

At this point of the file, we can now also start writing the scope and content.

7.2.3. Scope and Content Style Guide

This part of the document is a template for the Scope and Content section of the case files. It is meant to provide guidance for writing Scope and Content to ensure relevant information is included.

The Scope and Content for the case files do not follow archival practices; rather, they are more like brief bios of the file persons with summaries of their dispossession.

Unlike the metadata formatting, the Scope and Content formatting is more flexible to account for differences in lived experience and variances between files; use your discretion on including information that may go beyond the template and provided examples. However, for consistency, please adhere to the scope and content template that you copied and pasted into your Metadata Notes document earlier as well as the Metadata Guidelines.

7.2.3.1. Language

Read through and refer to the LOI Public Outputs Language Guide, written by Project Director Jordan Stanger-Ross, for an overview of terms that we do not use while writing Scope and Content, along with alternatives for each.

7.2.3.2. Pronouns

For the scope and content, you will use the pronouns corresponding with the file person’s listed sex; i.e., use masculine pronouns (he/him/his) for those listed as male and use feminine pronouns (she/her/hers) for those listed as female.

S & C FIELDSEXAMPLES
He/She was born onHe was born on
He/She wasHe was
His/Her family includesHis family includes
He/She livedHe lived

7.2.3.3. Birthdate and Occupation

After determining and filling out pronouns, you can move on to the biographical details of the file person.

S & C FIELDSNOTESEXAMPLES
He/She was born on dd Month yyyyHe was born on 03 December 1893.
He/She was [occupation] employed by [employer]**If available, include employer information such as name, company/organization, and address.He was a fisherman employed by B.C. Packers, Claxton, BC.

7.2.3.4. Names and Family Members

7.2.3.4.1. Names

Usually, in the files, last names are listed first and in all caps (for example, “SUZUKI Yuki”); however, this will not always be the case. It’s always best practice to check names listed on official forms (i.e., the initial “Office of the Custodian - Japanese Section” form and the “Information from R.C.M.P.” form) against those in the rest of the file.

Note 1: Often, these initial forms will have incorrectly spelled names, so pay attention to variances throughout the file to determine the correct spelling and/or alternate spellings.

Sometimes, names are difficult to read or are written differently throughout the file. You can use square brackets following the name (but before the parentheses) to indicate other variations on names or other possible readings.

TEMPLATEEXAMPLES
First Last [alternate names]Tetsuro Masuda [also, Tetsuro Thomas Masuda]

Yuka Tanaka [possibly Yuko Tanaka]

Note 2: As specified in the Metadata Formatting, if the file person has more than one listed first name or other name, write only one in the metadata field for names (i.e., “last-first”), using your discretion. Then, include the full name and/or alternate name(s) in the Scope and Content. For example, for a person listed as Harry Ryutaro Deguchi, you could write the metadata field as “deguchi-harry” and include in the Scope and Content the sentence “He is also named in the file as Harry Ryutaro Deguchi.”

If you’re having trouble with a name, record your best guess (using square brackets if needed) and move on. A general disclaimer will be included regarding names within the project to cover this uncertainty.

Usually, the last names of file members’ wives and children are omitted in the case file; for this project, you can assume that their last names matched that of the file person’s, unless otherwise specified.

If the file person was a wife, her file will often list her name as “LASTNAME (firstname) Mrs. husband’sfirstname”. Do not include her husband’s first name as part of her name; rather, you will list her husband as a family member (see next section below).

For any person that has a maiden name, include both the person’s first AND last name for BOTH their married name and their maiden name. For example, if the file person was a married woman who was registered with the Office of the Custodian under her married name, use that name for the metadata but in the Scope and Content include an additional sentence listing her maiden name (i.e., “Her maiden name is Firstname Maidenlastname”). This will allow both her married name and maiden name to be string searchable.

7.2.3.4.2. Family Members

Following the “His/Her family includes” field of the scope and content, you will list all the names of the file person’s family members listed in the file, and include relevant information about each member in parentheses.

For each family member, format their information as follows:

First Last [alternate names if applicable] (relevant information)

The family information provided in each file is highly variable. You must include the family members’ names and their relation to the file person, but please include as much relevant information in your scope and content as is provided in the file.

Relevant information includes the options in the following table:

Examples of relation to file person*If maiden name is included
mother/father
wife/husband
daughter/son
child
adopted child
common-law spouse
aunt/uncle
niece/nephew
nee or ne First Maidenlast

These options are examples of information you may find, but will likely not be present in every case file. The information that is included must be formatted in the following order:

First Last (relation; maiden name*)

Examples:

  • “Yuka Tanaka [possibly Yuko Tanaka] (daughter; nee Yuka Abe or Yuko Abe).”
  • “Yuki Suzuki (sister-in-law; nee Yuki Kimura).”
  • “Choju Ichikawa (father).”

7.2.3.5. Locations

Following the “He/She lived” field of the scope and content, you will list all of the provided locations for the file person.

Generally, you will start by listing the provided home address(es) for the file person and then listing where they were forcibly uprooted to.

If the file person was exiled to Japan, also include this information in this field. Such information is usually stamped on the “Information from R.C.M.P.” form as “RETURNED TO JAPAN” with the boat name and date of exile (please include date).

He/She lived at _, was forcibly uprooted to _, and was exiled to Japan on dd Month yyyy.

Note: If not all of this information is provided or applicable, only record what is and move on.

Examples:

She lived in Hakoda Bay, Tofino, BC and was forcibly uprooted to New Denver, BC.

Her home addresses are listed as 3681 West 6th Avenue, Vancouver, BC and 231 East Cordova Street, Vancouver, BC; she was forcibly uprooted to Tashme, BC and was exiled to Japan on 02 October 1946.

He lived at 776 Powell Street, Vancouver, BC and was forcibly uprooted to Japanese Work Camp, Unit Four, Three Valley, BC; Giscome, BC; Greenwood, BC; and Eagle Lake Sawmills, Giscome, BC.

Stylistic Notes for Locations

Stylistic NotesExamples
Ordinals:

Format as “1st” and not “first”
“1700 West 1st Avenue, Vancouver, BC”
Places:

Include both city and province
Abbreviate province names
“Vancouver, BC”
“Winnipeg, MB”
Punctuation:

No internal periods in place names
Internal periods in organization names, if it appears that way in the document
“Toronto, ON”
“B.C. Security Commission” but “RCMP”
Abbreviations:

All other abbreviations spelled out; for e.g., change “St.” to “Street,” “Dept.” to “Department,” “W.” to “West”, “R.R.” to “Rural Route”, and “Co. Ltd.” to “Company Limited”
Maintain “&” in organization names
“224 Powell Street, Vancouver, BC”
“H.G. Helgerson Limited”
“Rural Route No. 2, Eburne, BC”
“#1 Road Camp, Solsqua, BC”
“Japan & Canada Trust Savings Company”

7.2.3.6. Process Example Pt. 2: Scope and Content, Other Metadata

Continuing with our example case file from Process Example Pt. 1, we can start filling out the scope and content for #1630.

1. Work through the case file page by page to fill out the rest of the metadata (according to the Metadata Formatting) and the scope and content (according to the Style Guide).

Usually, the majority of the file person’s biographical details, including citizenship status, can be found within the first two documents (“Office of the Custodian - Japanese Section” form and “Information from R.C.M.P.” form).

Note: Some file pages will be incorrectly oriented. As you work through a file, make note of which page numbers need to be rotated in your Metadata Notes document. See pdf Making.

7.2.4. File Notes Formatting

In the Case Files Tracker, there are columns for file notes:

Please IGNORE all of these columns EXCEPT for the “Sensitive” column. These other columns concern previous processes for case files.

7.2.4.1. Sensitive

As you work through case files, you will fill out this column out as necessary (i.e., it will not be applicable to all case files).

The column is for indicating that a file contains information deemed by the project as potentially sensitive. Marking a file with these label(s) will assign it a severity label according to our risk matrix. If the combined label severity is equal to or greater than “High-grade” level, the file will be restricted (metadata only, redacted names).

Carefully read through the Risk Matrix section, paying particular attention to the instructions regarding case files. Please refer back to the matrix before assigning any labels to a file and consult other RAs or Stewart if you’re unsure if a file warrants a label.

For quick reference, the labels are as follows:

  • “sens:illness”
  • “sens:youth”
  • “sens:implicate”
  • “sens:criminal”
  • “sens:stereotype”
  • “sens:cultural”
  • “sens:dishonour”
  • "sens:details"

Record any labels in your text document for later input into the tracker spreadsheet.

Labels should then be inputted into the “Sensitive” field of the tracker spreadsheet according to the following formatting guidelines:

  • Every label should be prefaced with “sens:” (beginning with a lowercase letter “s”) followed by the label name/type (with no spaces between); for e.g., “sens:illness”.
  • You may apply as many of the labels as appropriate to any document.
  • Include no more than one instance of any label for any document.
  • Multiple values are separated by a space only.

For example:

7.2.4.2. Process Example Pt. 3: File Notes

While writing scope and content, concurrently record any necessary information in the file notes field.

1. File #1630 does not contain any content that would warrant a Sensitive label, so with all of the metadata fields and scope and content completed, we’re ready to create a pdf of our case file.

*At this point, if you haven't yet started working on a case file you can begin to do so now. Once you have worked through your case file and written all of the metadata, scope and content, and any file notes, return to this point in the guide to learn how to make your file into a pdf and record the file in the tracker.

7.2.5. pdf Making

As mentioned in the Hopper and Terminal section, you will make pdfs using the “Hopper,” the Terminal, and the pdf-maker shell script.

  • Once you’ve determined the page range of your case file, you will copy these images from the HCMC server to your local machine in the “Hopper” directory.

    Within your microfilm reel directory window, start by clicking on the first image file (of your case file) to select it. Next, scroll to the last image file, hold down the ‘Shift’ key, and click on that last image to select that range of files.

    Now, with all of your file pages selected, COPY the images and paste them into your open “Hopper” directory window. DO NOT ‘CUT’ the images or they will be deleted from the server.
  • Now that the images are in the “Hopper,” rotate any incorrectly orientated pages (that you made note of in your text document as you worked through the case file). When asked if you would like to save your changes before closing, select “Save”.

    Note: You must do image rotations on your local machine as such changes cannot be made to image files on the HCMC server.
  • Next, copy and paste the metadata (that you recorded in your text document) into your Terminal window with the pdf-maker shell script open. Follow the prompts in the script to complete all fields, pressing ‘Enter’ after each input.
    Note: For copy and pasting, the Terminal only accepts right clicking (not ctrl commands).
  • Once you’ve hit ‘Enter’ after the last field (the Metadata Author field), the script will convert the images in the “Hopper” into a pdf. This newly created pdf will now be located in your “casefile_conversions” directory. DO NOT CLOSE THE TERMINAL WINDOW.
  • Now you will copy your created pdf from your local machine to the HCMC server in the “RG117_C-3_PDFs” directory.

Note: The script will automatically name the pdf file; but for reference, the LOI filename convention is:

lac_rg_117_c3_FILENUMBER_lastname-firstname.pdf

7.2.6. Case Files Tracker

  • Navigate back to your Terminal window. Near the bottom of the window you will see instructions to: "find the pasteLoi.csv file in the same directory as this script and copy the line(s) and paste them in the Google Sheets file called 'Case Files (RG117 C-3) Tracker'" You may do this for each case file created, OR you can create a bunch of case files and then copy and paste them into your tracker.
  • Navigate to the Case File Tracker and select the correct row for your file. Remember, case files are listed sequentially by case file number.

    Note: You may have to add more rows to the spreadsheet to fit your data in sequential order.
  • In order to have the data properly spaced across columns, you must select the first box in the row, under the column “File Number (Sequential).” Do not open this box by double-clicking. Now use ctrl + v to paste.

    Tip #1 "pasteLOI.csv" must be closed while entering data in the terminal interface or permission will be denied.
    Tip #2 Before copy and pasting from your "pasteLOI.csv" makes sure that all the dates are visible (i.e. NO ####-##-##) by expanding those columns.
    Tip #3 After you have copy and pasted a bunch of rows, erase the data from your "pasteLOI.csv" and save the file.
  • The Casefile Tracker is set to “Automatic” (versus “Plain Text”), so when you paste in your line of data the spreadsheet will automatically remove the leading 0s (zeros) in front of the file numbers (e.g., case file number “00208” is transformed into “208”). This will happen in the pasteLOI.csv file as well. The removal of the leading zeros in the “File Number (Sequential)” fields of the Tracker is the desired outcome. The addition of zeros to bring case file numbers to five digits is necessary for the pdf-maker script to make file names, but in the Tracker please ensure that the zeros have been automatically removed.

    For the “_xi” case files numbers, the spreadsheet will NOT automatically remove the leading zeroes. Please manually remove any of these zeroes yourself (e.g., change “01209_xi” to “1209_xi” in the “File Number (Sequential)” column).

    Note: Do NOT manually remove the leading zeros in any other column, such as in the “Page Range” or “LOI pdf File Name” columns.
  • Now it’s time to fill out the “Scope and Content” column. Navigate back to your Metadata Notes document, select your scope and content paragraph, then copy and paste it into the corresponding column. This time, you must double-click in the box in order to paste successfully.
  • Next, you will follow the same process to enter any file notes (sensitive labels, notable documents, and snippets) into their respective columns.

Congratulations! You have successfully completed your first case file.

If you’ve started working on a new reel, please record such information in the Case File Reel Completion Tracker by keeping track of the date you started working on it, the date you completed it, etc. This will not only help us keep track of the status of all the reels but also give us a better estimate of how long it will take to complete everything.

7.3. Completed Case File Examples

7.3.1. Example #1

Page Range: 1229-1254

Start Date: 1942-03-28

Latest Date: 1946-06-25

Microfilm Reel #: C-9321

Case File: 01567

File Person’s Name: shimizu-fumiko

Citizenship Status: Canadian born

Sex: 1

Metadata Author: Lindy Marks

Scope and Content: He was born on 9 November 1876. He was a mill worker employed by B.C. Fir & Cedar Lumber Company Limited, Vancouver, BC. His family includes Tsuyu Ishihara (wife; nee Tsuyu Yoshioka; in Japan). His home address is listed as 344 Fourth Avenue West, Vancouver, BC. He was forcibly uprooted to Sandon, BC and New Denver, BC.

Sensitive:

7.3.2. Example #2

Page Range: 1198-1202

Start Date: 1942-03-30

Latest Date: 1944-08-09

Microfilm Reel #: C-9322

Case File: 01635

File Person’s Name: wong-marjorie

Citizenship Status: Canadian born

Sex: 2

Metadata Author: Erin Chan

Scope and Content: She was born on 18 June 1917. She is also named in the file as Marjorie Hisa Wong, and her maiden name is Marjorie Hisa Kuwata. She was a housewife. Her family includes Kinu Kuwata (mother; nee Kinu Yoneda), Tokusaburo Kuwata (father), Charles Wong (husband), Geraldine Wong (daughter), and Russell Wong (son). The “Information from R.C.M.P.” form, under “Names of Children under 16”, also lists “1 - Chinese nationality – (not listed)”. She lived at 1724 Government Street, Victoria, BC and then in High River, AB.

Sensitive:

7.3.3. Example #3

Page Range: 1640-1692

Start Date: 1942-03-24

Latest Date: 1950-12-28

Microfilm Reel #: C-9319

Case File #: 01452

File Person’s Name: masu-minoru

Citizenship Status: Canadian born

Sex: 1

Metadata Author: Erin Chan

Scope and Content: He was born on 09 March 1916. He was a fisherman. His family includes Yaye Nasu (mother; nee Yaye Nomura) and Oyokichi Nasu (father). He lived in Ucluelet, BC and was forcibly uprooted to Slocan, BC; Love’s Mushroom Farm Scarborough Junction, ON; 102 Centre Avenue, Toronto, ON; and 81 Montrose Avenue, Toronto, ON.

Sensitive:

7.3.4. Example #4

Page Range: 1547-1629

Start Date: 1942-03-30

Latest Date: 1950-12-28

Microfilm Reel #: C-9322

Case File #: 01654

File Person’s Name: onotera-hideo

Citizenship Status: Canadian born

Sex: 1

Metadata Author: Erin Chan

Scope and Content: He was born on 08 April 1914. He was a fisherman and a farmer, working on his and his brother’s berry farm. His family includes Tsuruyo Suto [possibly Tsuruyo Onotera] (mother), Tamotsu Onotera (father), Tatsuo Onotera (brother), Masa Onotera (wife), and Larry Yasuo Onotera (son). He lived on Rural Route #1, New Westminster, BC and at the Patricia Hotel, Vancouver, BC; he was forcibly uprooted to Kaslo, BC, Penticton, BC, and Greenwood, BC.

Sensitive:

7.4. Organization Case Files

You may come across case files that are specific to companies/businesses or organizations with assets seized by the Office of the Custodian. These files are mostly included in later reels and may be mixed in with people files.

Business files are handled in a similar manner to people files, with some changes to the formatting of the metadata and scope and content.

For organization case files metadata:

  • You will not be filling out the “Citizenship Status” and “Sex” fields.
  • In the name field, format the name in all lowercase letters, separating words with hyphens.
    • Ignore any punctuation marks (apostrophes, hyphens) present in the name of the company/business. For any ampersands, replace with “and.” For e.g., “Gord’s Garage & Son” would be formatted as “gords-garage-and-son”.
    • Do not abbreviate any words.
      • E.g., “Powell Lumber and Fuel Company” would be written out as “powell-lumber-and-fuel-company.” You must include words like “company” and “limited.”
      • E.g., “Ucluelet Fishermen’s Co-op Association” becomes “ucluelet-fishermens-coop-association”
  • Write “organization” for the case file type field.

For entity case files scope and content, write according to the following guidelines in the order they appear:

  • Description of the company, if included in the file:
    • E.g., “Haney Box Company Limited was a box company that manufactured produce boxes for tomatoes, strawberries, and raspberries.”
  • Any alternate or previous names, if applicable and available
    • E.g., “Originally named The Nikko Company, the business was renamed to Import and Domestic Silk Company on 21 October 1940.”
  • Location of the entity, if it is included in the file.
    • E.g., “The Fernridge Lumber Company was located at Alouette Lake, Haney, BC.”
  • Important dates, if available (incorporated, liquidated, name changes):
    • E.g., “The No. 2 District Fishermen’s Association operated out of Port Essington, BC. It was incorporated on 22 January 1940.”
  • Other entities closely related to the entity to whom the file belongs. Note: this does not include creditors or debtors.
    • E.g., “It also incorporated the Skeena Japanese Fishermen’s Association, located at Prince Rupert, BC.”
  • People associated with the file and their position, if available. We are concerned primarily with the names of Japanese Canadians. Use your best judgement on how many names to include/pull from the file. In the interest of time, please do not include more than 15 names.
    • It would be preferable to type out a one-page list of ten clear, easy-to-read names than to struggle over five hard-to-read names that you need to read through several pages of documents to find.
    • If you come across lists of names of Japanese Canadian people associated with the file and you do not type out all of them, please make a note at the end of the scope and content that states: “The file includes (a) list(s) of Japanese Canadian people associated with the file.”
    • If you determine that a file meets the criteria for restriction in accordance with the risk matrix, please include all of the names of Japanese Canadians that you come across. This is the only way family members searching for documents pertaining to their relatives will be able to decide whether to request the file or not.

Examples of Completed Scope and Contents

The Camp and Mill Workers’ Federal Labor Union No. 31 Vancouver and Vicinity also owned and controlled The Daily People newspaper. People involved in the organization include Taneji Sada (president), Atsmu Kamino (1st vice-president), Ichiro Matsushita (2nd vice-president), Takaichi Umezuki (secretary), Kijuro Inouye (treasurer), and members of the union who are listed in the file. 
The East Coast Troller’s Association was part of the Amalgamated Association of Fisherman of British Columbia. People associated with this file include Masahichi Yamashita (president), Mataichiro Doi (vice president), and Mitsujiro Noguchi (secretary of the Amalgamated Association of Fisherman of British Columbia). 

7.5. Estate Case Files

You may also come across case files for the estates of Japanese Canadians who died prior to 1942.

Like other types of files, estate files are subject to their own naming convention. It looks like this:

lastname-firstname-estate

In terms of metadata for estate files, we want to collect information regarding citizenship and sex, but the file type is now “estate.”

Note: When a file does not provide any information regarding citizenship status or sex, we will write “unknown” for the citizenship status, “0” in the sex field, and refer to the file person using they/them pronouns.

For estate case files, each scope and content will begin with the statement “This file pertains to the estate of __.” The rest of the scope and content will vary by file as there does not seem to be any consistency with regards to the type of information included. Include the following types of information if they appear in the file:

  • Date and location of death
  • Previous addresses
  • People associated with the file and their role/relationship to the file person if provided.
    • The types of people who should be included are family members, executors of the estate, and beneficiaries of the estate.

If none of the above information exists in the file, write a simple description of the file using what information does exist.

Examples:

This file pertains to the estate of Tsuya Nishimura. She died in 1936. People associated with this file include Jutaro Nishimura (father) and Shige Nishimura (mother).
This file pertains to the estate of Ichitaro Amano. He died on 13 April 1926 in Vancouver, BC. People associated with this file include Mitsuru Amano (son and sole beneficiary), Tajiro Amano (brother), and Denzo Enjo (executor).
This file pertains to the estate of Sankichi Tanaka. A document in the file indicates that he owned 1000 shares in Canada Mio Company Limited.

7.6. Nikkei Volunteer Case File Work

There are some volunteers at the Nikkei National Museum that Lisa Uyeda and Lindsey Jacobson coordinate, and they are working on writing scope and content descriptions for case files. When the volunteers finish a batch that we have sent them either Lisa or Lindsey will be in contact to request that we send them further files to work on. We also transfer the data from the volunteer spreadsheet to the main case files spreadsheet. This is the process for how to do that.

7.6.1. Sending to Volunteers

These are the steps to prepare batches of case files and send to Nikkei for volunteer work:

  • Open the Archival Cluster folder in Google Drive
  • Open the VolunteerCaseFiles folder. This is the folder that the volunteers have access to.
  • You will create a new folder in this folder and title it Batch #, where # will be the number of the batch that you are creating. To create a new folder, navigate to the left hand side and click on the button near the top that says “New” then select “Folder.”
  • Now that you have created a new folder, navigate to the folder of one of the previous batches. Right-click on the spreadsheet that is in that folder and select “Make a copy.”
  • Now you should have a spreadsheet named “Copy…” Rename this spreadsheet to “Case Files (RG117 C-3) Tracker Volunteer Metadata Batch #” where # will be the number of the batch this is.
  • Delete any information that is in this copy of the spreadsheet. You want it to be blank except for the top matter setting out what the spreadsheet is and all of the column titles. Change column D row 1 to the correct batch number, and column D row 2 to the correct date.
  • Move your new spreadsheet to your new created folder by right-clicking and selecting “Move to”
  • Once in the dialogue box select your new folder
  • Now you need to determine which files to send the volunteers. In the Case Files (RG117 C-3) Tracker, locate case files that have no scope and content written for them. You will be sending 30 per batch
  • Fill out the column in the spreadsheet that indicates the date that the files were sent with today’s date
  • Once you know which files you will be sending, fill out the relevant sections of the volunteer spreadsheet in the folder you created with the metadata from these files. This will include the case file number and the pdf file name.
  • Now you will transfer copies of the PDFs to the folder you created. Have the folder open on one screen, and on the other have open the folder named “RG117_C-3_PDFs.” You need to drag and drop each PDF file into the new batch folder.
    • The easiest ways that I have found to do this utilize the search bar in the HCMC folder. Search either the name or case file number of the file you are looking for then drag and drop it into the folder in Google Drive.
    • *Isolation contingency*: You will need to download the pdfs using FileZilla SFTP client to your local computer and then upload them to Google Drive from there.
  • Repeat this process until all of the PDFs of the case files are in the Google Drive folder and you’re done!
  • Send an email to either Lisa or Lindsey to let them know that there are new files ready for the volunteers.

7.6.2. Receiving from Volunteers

  • Lindsey (or Lisa) will send an email to someone in the Victoria office letting us know that the volunteers have finished with the case files they have
    • This also means it’s time to send new batches! Follow the process above
  • In one tab or on one monitor, open the volunteer spreadsheet that has been completed, and in another tab or on the second monitor, open the Case Files (RG117 C-3) Tracker spreadsheet
  • In the volunteer spreadsheet, copy all of the text in the scope and content column for the first case file on the sheet
  • Paste this text into the scope and content column for the same case file number in the main case files spreadsheet
  • Repeat this process until all of the text has been transferred from the volunteer spreadsheet to the main case file spreadsheet
  • Fill in the column in the spreadsheet that indicates the date the scope and content was sent back by the volunteers with today’s date. Do this for each case file.

7.6.3. Volunteer Case File Completion Tracker

Please use this tracker for volunteer batch returns.

8. Risk Matrix Guide

If the file/transcript contains substantial amounts of any of these categories of content, modify the spreadsheet, word file or xml file you’re working on as detailed below. “Substantial” is your judgement of a combination of the frequency and severity of instances within the document. Our primary concern is detailed accounts of sensitive information about identifiable people not otherwise easily available.

LabelDescriptionSeverity
illnessDetails or graphic images of serious illness (mental or physical) or mortality of identifiable individual(s)4
implicateDefaming or implicating identifiable individual(s) who were not part of document creation2
criminalDetails of potentially criminal activity, especially violence2
youthSerious anti-social activity or illness of youth under age of 183
stereotypeEgregious stereotyping (positive or negative) of a culture, group or person (beyond outdated language), especially vulnerable1
culturalMight be considered private by community for cultural reasons1
dishonourMight cause undue or disproportionate dishonour / embarrassment to family1
detailsCurrent personal identifying details (such as contact info)4

You may apply as many of the labels as appropriate to any document.

Include no more than one instance of any label for any document.

Use of the “cultural” label will likely require a reference to community members.

We will use these to determine:

8.1. When to add Sensitive information flags during workflow

For archival records (i.e. only metadata) that have ScopeContent metadata:Read ScopeContent for references to sensitive material
if reference is vague, take quick look at document
edit XML ana attribute on the container of actual object (e.g. <item> that has a n="file" or n="item" and contains the <listObject>)
See example.
For archival records (i.e. only metadata) that don’t have ScopeContent metadata:After you create ScopeContent
edit XML ana attribute on the container of actual object (e.g. <item> that has a n="file" or n="item" and contains the <listObject>)
See example.
For Individual Case File recordsAfter you create ScopeContent
edit the Sensitive field in spreadsheet
See example.
For LOI Oral History transcriptsAfter you do audio check/proofing
edit the Sensitive field in spreadsheet
and then, in the XML version of the oral history, wrap the sensitive text in a <seg> element and use the same sensitive value(s) in the ana attribute.
See example for Leslie Barnwell (@xml:id='barn23' in oral_history_barn23_2019-02-28.xml).
For other full-text records (e.g. community documents)We’ll need to specify a new task to edit XML ana attribute.
For court recordsProject is ok with court records being included as-is.

8.2. Risk Matrix Mark-Up Examples

TINA Files

Case Files

Oral Histories

LOI Oral History Database oral_history_barn23_2019-02-28.xml

9. LOI Public Outputs Language Guide

This guide proposes inappropriate and appropriate language for Landscapes of Injustice public outputs. It pertains to text created by the collective [e.g. in museum panels, text for teachers, etc.], rather than language in primary source and archival document [which are part of a separate discussion led by the Archival Cluster. This document is meant to advance ongoing discussion, rather than as a final statement of approach.

Terminology

Inappropriate termAppropriate term
Japanese (when referring to Canadians of Japanese ancestry)Japanese Canadian

Nikkei

Canadian of Japanese descent
JapJapanese Canadian
Canadian born JapaneseJapanese Canadian
Enemy aliens (when referring to people with Japanese nationality status)Japanese nationals
Rebels (for people detailed in POW camps)Prisoners
Evacuation/EvacueesInternment/Internees – for entire process/experience (also “Internment Era” for time period 1942-1949)

Forced uprooting - for process of displacement

Incarceration- for government administered sites, including BC and Ontario administered sites)
Protected zoneRestricted area
RepatriationExile
RelocationUprooting

Forced Uprooting
DispersalForced dispersal
SalesForced sales

Dispossession- For broader process of property loss, including theft, neglect, and vandalism

[Sales by other Canadians during the same era—sometimes described/analyzed in contrast to the forced sales—can be called “free market sales”].
LiquidationForced sale.

Except in the case of the forcible sale of business assets by the Custodian of Enemy Property, in which case we will use forced liquidation.

Other Language Matters

HyphenationLOI proposes to use a hyphen in “Japanese Canadian” when the phrase is used adjectivally (e.g. Japanese-Canadian community). When used as a noun, however, no hyphen will be used (e.g. Japanese Canadians responded).
Japanese language termsUse of transliterated Japanese language, where appropriate, is encouraged in LOI publications and public outputs. Whenever being used, including in names, these uses should be vetted by a competent Japanese language speaker to ensure accuracy.
Recommended temporal terminologyWhen referring to the period of time in which the internment took place, we recommend the use of 1940s in place of “wartime” or equivalents, because the internment era lasted until 1949.
NikkeiThere is some current discussion/debate within the community about the use of the term Nikkei. In most instances, Landscapes of Injustice publications and outputs we use the phrase “Japanese Canadian” instead. However the project has partner organizations that use the term, has used it in publications, and takes no formal position on this issue.

10. Isolation Workflow

Due to the covid19 pandemic, it has become necessary to carry on LOI digital database work from home to practice social isolation. This section is a guide to seetting up necessary apps for home work. It will be updated as requirements and needs change.

10.1. Case Files

  • Download FileZilla Client
    • When it installs it will ask you to choose which components you would like. Leave all of the pre-checked ones selected. Select ‘desktop icon’ if you would like to have a desktop icon.
    • Decline the two other programs FileZilla asks you to install i.e. McAffee
    Create a New Site in FileZilla
    • Select the option ‘File / Site Manager’
    • Click on the ‘New Site’ button; a new site will be added in the selection box
    • Name the new site ‘Landscapes’ (1)
    • Set the protocol to SFTP (2)
    • Set the host to nfs.hcmc.uvic.ca (3)
    • Set logon type to 'Ask for password' (4)
    • Set the user to be your netlink ID without the @uvic.ca part. The password will be your netlink ID password (5)
    • Click Ok
  • Finding the case files
    • When you first access the Landscapes site you will be put into home1t/[your netlink ID]
    • To navigate out of here, click on the very first yellow square at the top of the tree of folders
    • From this yellow square you can navigate to the case files by following this pathway: home1h/loi/dev/LAC/rg117/rg117_c-3/rg117_C-3_PDFs (rg117_C-3_PDFs hold all of the PDF files that have been created from case file images)
  • Opening the files
    • Double-click on the file you would like to open
    • The client will ask for your password and will then transfer a copy of the file to your local machine
    • At the bottom of the program there is a tab marked ‘Successful Transfers’
    • Clicking this tab will show you the location of the file on your local machine
    • Open a file explorer window, go to that location, and the file will be there, ready for you to start working on

10.1.1. Procedures for Case File Workers

Updated: 28 April 2020

For metadata enterers (no abstracts):

  • Using your ftp client, download a reel that has not been processed (please refer to the Case File Reel Completion Tracker and consult with your LOI colleagues on which reel to work on). Downloading the files will take a while so it is best to do it over night. Download the reel to a folder external to your Case File Processing directory as described in "Processing Case Files".
  • For Linux and Mac (Unix) users: place this modified (no pdf creation) shell script in same location as instructed in Processing Case Files (i.e. replace “rg117_CaseFiles_pdfMaker.sh” with "rg117_CaseFiles_pdfMaker-noImg2pdf.sh"). For Windows users, use this script (Note: Windows Defender may try to prevent you from running this script. Don't worry, it is safe, you may run it anyway).
  • Follow Processing Case Files instructions. (Note: this new script will not create a pdf so disregard pdf making step). Images for this step will be harvested from the images you downloaded and placed on your computer.
  • Stop process at Scope and Content Style Guide BUT don't forget to add metadata into Case File Tracker.
  • Note: some case files cross microfilm reels. If your reel begins with a case file that started on previous reel, ignore it and move to next case file. If your last case file crosses into the next reel, go to that reel, download the images to complete the case file, place them in your "hopper" along with the other images, and then execute the shell script. Metadata for case files that cross reels looks like this:
  • Data for the next reel inside square brackets.

For metadata enterers instructed to write Scope and Content

  • Same instructions as above but also write a Scope and Content abstract in the Case Files Tracker following the Scope and Content Style Guide.
  • Or, if instructed by Stewart or Gord, complete Scope and Content for a set of case files in the tracker that have other metadata already provided. Steps:
    • Download the indicated pdfs from the HCMC server in the “RG117_C-3_PDFs” directory.
    • Review assigned case files and write abstracts following the Scope and Content Style Guide.

10.2. Oral Histories XML Work

10.2.1. Accessing the XML Files from LOI Production Site

Please see "Using the Subversion Repository" section of this documentation for instructions on downloading an svn client for all platforms.

Windows Terminal

  • Open a command window by navigating to the start menu of your computer and typing ‘cmd’ into the search bar
  • A terminal window will open. You will automatically be in C:\Users\[username]
  • You can move into your Documents folder if you wish

Mac Terminal

  • Click the Finder logo, located in the bottom toolbar of your screen (it looks like a two-toned smiling face).
  • On the left toolbar, click "Applications" (if that was the last folder you visited within the Finder, Finder will open to this folder automatically).
  • Scroll down and open the "Utilities" folder.
  • Double click "Terminal" to launch it.

Both Terminals

  • Make a new directory by typing ‘mkdir loi’ into the command line and then pressing the return key
  • Change from the home directory to the ‘loi’ directory by typing ‘cd loi’ followed by the return key
  • Check out the files by typing “svn checkout https://hcmc.uvic.ca/svn/landscapes/production/ .” (without the quotation marks) followed by the return key. Make sure to include the s in https and the space + period at the end
  • This will download a copy of the database to your ‘loi’ directory.

10.2.2. Accessing the Transcripts

  • Open a terminal window (make sure you are located where you want to be ("Documents" or somewhere relevant to the "loi" folder you already created, BUT not in it!
  • Make a new directory by typing ‘mkdir loiOH’ into the command line and pressing the return key
  • Navigate to this new directory by typing ‘cd loiOH’ into the command line and pressing the return key
  • Once in ‘loiOH’ check out the files by typing: “svn checkout https://hcmc.uvic.ca/svn/landscapes/oralHistoryDocs/originals/ . ” (without the quotation marks) and hitting return. Make sure to include the s in https and the space + period at the end)
  • To access the transcripts, navigate to the ‘loiOH’ folder on your local machine. This is where all the transcripts are

10.2.3. Working on the Files

  • Download Oxygen XML Editor
  • You will need to have access to the email address that you choose to give Oxygen because that is where the 31-day license key will be sent
  • Do not include the Fusion Connector
  • When it asks you what files to work with, keep all of the default selected and also select XML files
  • You are now ready to begin working on the oral history files. Please follow the procedures outlined in the XML Mark Up Steps guide

10.3. The Task Master

The Task Master is our tracker to track project production so that Stewart can generate realistic output goals.

Please fill out the first three columns with your details and hours worked on a specific task, and then, in the appropriate column for the work you did, provide a logical number of records or data completed for that task. Or fill out "Other Activities" or "Notes" field indicating what you spent time on.

Here are brief descriptions of task columns:

Case Files: processed using scriptNumber of case files entered into Case Files (RG117 C-3) Tracker with metadata other than Scope and Content.
Case Files: added scope and contentNumber of Scope and Contents added to Case Files (RG117 C-3) Tracker.
Case Files: supplied missing metadataNumber of case files that had metadata back-filled in Case Files (RG117 C-3) Tracker.
TINA: records editedNumber of objects, files, series, fonds, etc., edited.
TINA: diagnostic errorsNumber of diagnostic errors cleared (see Checking Diagnostics) .
"OH: narrators contacted"Number of narrators contacted about their transcript.
"OH: Pre-Audio Check: Full/Partial"Number of interviews that have completed this stage (see Pre-Audio Check)
OH: Audio CheckNumber of interviews audio checked (See Audio Check).
OH: Final CheckNumber of interviews fully checked (See Final Check).
OH: XMLNumber of interviews marked up in XML transcript. (See XML Mark Up)

If you have any questions about any of these do not hesitate to reach out to any team member for advice.

10.4. Communication

The team has opted to use the Discord service for general discussions during work hours. This is an option that is recommended for efficient communication and support as we all work from home.

The app can be downloaded here.

Please contact Natsuki Abe for a link to LOI's private group.

Appendix A

Appendix A.1 Elements

Appendix A.1.1 <TEI>

<TEI> (TEI document) contains a single TEI-conformant document, combining a single TEI header with one or more members of the model.resource class. Multiple <TEI> elements may be combined within a <TEI> (or <teiCorpus>) element. [4. Default Text Structure 15.1. Varieties of Composite Text]
Moduletextstructure
Attributes
xml:id(identifier) provides a unique identifier for the element bearing the attribute.
Derived fromatt.global
StatusRequired
DatatypeID
xml:lang(language) indicates the language of the element content using a ‘tag’ generated according to BCP 47.
Derived fromatt.global
StatusRequired
Datatypeteidata.language
versionspecifies the version number of the TEI Guidelines against which this document is valid.
StatusOptional
Datatypeteidata.version
Note

Major editions of the Guidelines have long been informally referred to by a name made up of the letter P (for Proposal) followed by a digit. The current release is one of the many releases of the fifth major edition of the Guidelines, known as P5. This attribute may be used to associate a TEI document with a specific release of the P5 Guidelines, in the absence of a more precise association provided by the source attribute on the associated <schemaSpec>.

Contained by
textstructure: TEI
May contain
header: teiHeader
textstructure: TEI text
transcr: facsimile
Note

This element is required. It is customary to specify the TEI namespace http://www.tei-c.org/ns/1.0 on it, for example: <TEI version="4.4.0" xml:lang="it" xmlns="http://www.tei-c.org/ns/1.0">.

Example
<TEI version="3.3.0" xmlns="http://www.tei-c.org/ns/1.0">  <teiHeader>   <fileDesc>    <titleStmt>     <title>The shortest TEI Document Imaginable</title>    </titleStmt>    <publicationStmt>     <p>First published as part of TEI P2, this is the P5          version using a namespace.</p>    </publicationStmt>    <sourceDesc>     <p>No source: this is an original work.</p>    </sourceDesc>   </fileDesc>  </teiHeader>  <text>   <body>    <p>This is about the shortest TEI document imaginable.</p>   </body>  </text> </TEI>
Example
<TEI version="2.9.1" xmlns="http://www.tei-c.org/ns/1.0">  <teiHeader>   <fileDesc>    <titleStmt>     <title>A TEI Document containing four page images </title>    </titleStmt>    <publicationStmt>     <p>Unpublished demonstration file.</p>    </publicationStmt>    <sourceDesc>     <p>No source: this is an original work.</p>    </sourceDesc>   </fileDesc>  </teiHeader>  <facsimile>   <graphic url="page1.png"/>   <graphic url="page2.png"/>   <graphic url="page3.png"/>   <graphic url="page4.png"/>  </facsimile> </TEI>
Schematron
<sch:ns prefix="tei"  uri="http://www.tei-c.org/ns/1.0"/> <sch:ns prefix="xs"  uri="http://www.w3.org/2001/XMLSchema"/>
Schematron
<sch:ns prefix="rng"  uri="http://relaxng.org/ns/structure/1.0"/> <sch:ns prefix="rna"  uri="http://relaxng.org/ns/compatibility/annotations/1.0"/>
Content model
<content>
 <sequence minOccurs="1" maxOccurs="1">
  <elementRef key="teiHeader"/>
  <alternate minOccurs="1" maxOccurs="1">
   <sequence minOccurs="1" maxOccurs="1">
    <classRef key="model.resource"
     minOccurs="1" maxOccurs="unbounded"/>
    <elementRef key="TEI" minOccurs="0"
     maxOccurs="unbounded"/>
   </sequence>
   <elementRef key="TEI" minOccurs="1"
    maxOccurs="unbounded"/>
  </alternate>
 </sequence>
</content>
    
Schema Declaration
element TEI
{
   att.global.attribute.n,
   att.global.attribute.xmlbase,
   att.global.attribute.xmlspace,
   att.global.rendition.attribute.rend,
   att.global.rendition.attribute.style,
   att.global.rendition.attribute.rendition,
   att.global.linking.attribute.corresp,
   att.global.linking.attribute.synch,
   att.global.linking.attribute.sameAs,
   att.global.linking.attribute.copyOf,
   att.global.linking.attribute.next,
   att.global.linking.attribute.prev,
   att.global.linking.attribute.exclude,
   att.global.linking.attribute.select,
   att.global.analytic.attribute.ana,
   att.global.facs.attribute.facs,
   att.global.change.attribute.change,
   att.global.responsibility.attribute.cert,
   att.global.responsibility.attribute.resp,
   att.global.source.attribute.source,
   att.typed.attributes,
   attribute xml:id { text },
   attribute xml:lang { text },
   attribute version { text }?,
   ( teiHeader, ( ( model.resource+, TEI* ) | TEI+ ) )
}

Appendix A.1.2 <ab>

<ab> (anonymous block) contains any component-level unit of text, acting as a container for phrase or inter level elements analogous to, but without the same constraints as, a paragraph. [16.3. Blocks, Segments, and Anchors]
Modulelinking
Attributes
Member of
Contained by
May contain
Note

The <ab> element may be used at the encoder's discretion to mark any component-level elements in a text for which no other more specific appropriate markup is defined. Unlike paragraphs, <ab> may nest and may use the type and subtype attributes.

Example
<div type="bookn="Genesis">  <div type="chaptern="1">   <ab>In the beginning God created the heaven and the earth.</ab>   <ab>And the earth was without form, and void; and      darkness was upon the face of the deep. And the      spirit of God moved upon the face of the waters.</ab>   <ab>And God said, Let there be light: and there was light.</ab> <!-- ...-->  </div> </div>
Schematron
<sch:report test="(ancestor::tei:l or ancestor::tei:lg) and not( ancestor::tei:floatingText |parent::tei:figure |parent::tei:note )"> Abstract model violation: Lines may not contain higher-level divisions such as p or ab, unless ab is a child of figure or note, or is a descendant of floatingText. </sch:report>
Content model
<content>
 <macroRef key="macro.abContent"/>
</content>
    
Schema Declaration
element ab
{
   att.global.attributes,
   att.typed.attributes,
   att.declaring.attributes,
   att.fragmentable.attributes,
   att.written.attributes,
   macro.abContent
}

Appendix A.1.3 <abbr>

<abbr> (abbreviation) contains an abbreviation of any sort. [3.6.5. Abbreviations and Their Expansions]
Modulecore
Attributes
type(type) allows the encoder to classify the abbreviation according to some convenient typology.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Sample values include:
suspension
(suspension) the abbreviation provides the first letter(s) of the word or phrase, omitting the remainder.
contraction
(contraction) the abbreviation omits some letter(s) in the middle.
brevigraph
the abbreviation comprises a special symbol or mark.
superscription
(superscription) the abbreviation includes writing above the line.
acronym
(acronym) the abbreviation comprises the initial letters of the words of a phrase.
title
(title) the abbreviation is for a title of address (Dr, Ms, Mr, …)
organization
(organization) the abbreviation is for the name of an organization.
geographic
(geographic) the abbreviation is for a geographic name.
Note

The type attribute is provided for the sake of those who wish to classify abbreviations at their point of occurrence; this may be useful in some circumstances, though usually the same abbreviation will have the same type in all occurrences. As the sample values make clear, abbreviations may be classified by the method used to construct them, the method of writing them, or the referent of the term abbreviated; the typology used is up to the encoder and should be carefully planned to meet the needs of the expected use. For a typology of Middle English abbreviations, see 6.2.

Member of
Contained by
May contain
Note

If abbreviations are expanded silently, this practice should be documented in the <editorialDecl>, either with a <normalization> element or a <p>.

Example
<choice>  <expan>North Atlantic Treaty Organization</expan>  <abbr cert="low">NorATO</abbr>  <abbr cert="high">NATO</abbr>  <abbr cert="highxml:lang="fr">OTAN</abbr> </choice>
Example
<choice>  <abbr>SPQR</abbr>  <expan>senatus populusque romanorum</expan> </choice>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element abbr
{
   att.global.attributes,
   att.typed.attribute.subtype,
   attribute type { text }?,
   macro.phraseSeq
}

Appendix A.1.4 <abstract>

<abstract> contains a summary or formal abstract prefixed to an existing source document by the encoder. [2.4.4. Abstracts]
Moduleheader
Attributes
Member of
Contained by
header: profileDesc
May contain
Note

This element is intended only for cases where no abstract is available in the original source. Any abstract already present in the source document should be encoded as a <div> within the <front>, as it should for a born-digital document.

Example
<profileDesc>  <abstract resp="#LB">   <p>Good database design involves the acquisition and deployment of      skills which have a wider relevance to the educational process. From      a set of more or less instinctive rules of thumb a formal discipline      or "methodology" of database design has evolved. Applying that      methodology can be of great benefit to a very wide range of academic      subjects: it requires fundamental skills of abstraction and      generalisation and it provides a simple mechanism whereby complex      ideas and information structures can be represented and manipulated,      even without the use of a computer. </p>  </abstract> </profileDesc>
Content model
<content>
 <alternate minOccurs="1"
  maxOccurs="unbounded">
  <classRef key="model.pLike"/>
  <classRef key="model.listLike"/>
  <elementRef key="listBibl"/>
 </alternate>
</content>
    
Schema Declaration
element abstract
{
   att.global.attributes,
   ( model.pLike | model.listLike | listBibl )+
}

Appendix A.1.5 <acquisition>

<acquisition> (acquisition) contains any descriptive or other information concerning the process by which a manuscript or manuscript part or other object entered the holding institution. [10.8. History]
Modulemsdescription
Attributes
Contained by
msdescription: history
May contain
Example
<acquisition>Left to the <name type="place">Bodleian</name> by <name type="person">Richard Rawlinson</name> in 1755. </acquisition>
Content model
<content>
 <macroRef key="macro.specialPara"/>
</content>
    
Schema Declaration
element acquisition
{
   att.global.attributes,
   att.datable.attributes,
   macro.specialPara
}

Appendix A.1.6 <addName>

<addName> (additional name) contains an additional name component, such as a nickname, epithet, or alias, or any other descriptive phrase used within a personal name. [13.2.1. Personal Names]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Example
<persName>  <forename>Frederick</forename>  <addName type="epithet">the Great</addName>  <roleName>Emperor of Prussia</roleName> </persName>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element addName
{
   att.global.attributes,
   att.personal.attributes,
   att.typed.attributes,
   macro.phraseSeq
}

Appendix A.1.7 <additional>

<additional> (additional) groups additional information, combining bibliographic information about a manuscript or other object, or surrogate copies of it, with curatorial or administrative information. [10.9. Additional Information]
Modulemsdescription
Attributes
Contained by
msdescription: msDesc
namesdates: object
May contain
msdescription: adminInfo
Example
<additional>  <adminInfo>   <recordHist>    <p> <!-- record history here -->    </p>   </recordHist>   <custodialHist>    <p> <!-- custodial history here -->    </p>   </custodialHist>  </adminInfo>  <surrogates>   <p> <!-- information about surrogates here -->   </p>  </surrogates>  <listBibl>   <bibl> <!-- ... -->   </bibl> <!-- full bibliography here -->  </listBibl> </additional>
Content model
<content>
 <sequence>
  <elementRef key="adminInfo" minOccurs="0"/>
  <elementRef key="surrogates"
   minOccurs="0"/>
  <elementRef key="listBibl" minOccurs="0"/>
 </sequence>
</content>
    
Schema Declaration
element additional
{
   att.global.attributes,
   ( adminInfo?, surrogates?, listBibl? )
}

Appendix A.1.8 <addrLine>

<addrLine> (address line) contains one line of a postal address. [3.6.2. Addresses 2.2.4. Publication, Distribution, Licensing, etc. 3.12.2.4. Imprint, Size of a Document, and Reprint Information]
Modulecore
Attributes
Member of
Contained by
core: address
May contain
Note

Addresses may be encoded either as a sequence of lines, or using any sequence of component elements from the model.addrPart class. Other non-postal forms of address, such as telephone numbers or email, should not be included within an <address> element directly but may be wrapped within an <addrLine> if they form part of the printed address in some source text.

Example
<address>  <addrLine>Computing Center, MC 135</addrLine>  <addrLine>P.O. Box 6998</addrLine>  <addrLine>Chicago, IL</addrLine>  <addrLine>60680 USA</addrLine> </address>
Example
<addrLine>  <ref target="tel:+1-201-555-0123">(201) 555 0123</ref> </addrLine>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element addrLine { att.global.attributes, macro.phraseSeq }

Appendix A.1.9 <address>

<address> (address) contains a postal address, for example of a publisher, an organization, or an individual. [3.6.2. Addresses 2.2.4. Publication, Distribution, Licensing, etc. 3.12.2.4. Imprint, Size of a Document, and Reprint Information]
Modulecore
Attributes
Member of
Contained by
May contain
Note

Unlike the TEI's definition of <address>, <address> in LOI can include mixed content.

ExampleUsing just the elements defined by the core module, an address could be represented as follows:
<address>  <street>via Marsala 24</street>  <postCode>40126</postCode>  <name>Bologna</name>  <name>Italy</name> </address>
ExampleWhen a schema includes the names and dates module more specific elements such as country or settlement would be preferable over generic <name>:
<address>  <street>via Marsala 24</street>  <postCode>40126</postCode>  <settlement>Bologna</settlement>  <country>Italy</country> </address>
Example
<address>  <addrLine>Computing Center, MC 135</addrLine>  <addrLine>P.O. Box 6998</addrLine>  <addrLine>Chicago, IL 60680</addrLine>  <addrLine>USA</addrLine> </address>
Example
<address>  <country key="FR"/>  <settlement type="city">Lyon</settlement>  <postCode>69002</postCode>  <district type="arrondissement">IIème</district>  <district type="quartier">Perrache</district>  <street>   <num>30</num>, Cours de Verdun</street> </address>
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.addrPart"/>
  <classRef key="model.milestoneLike"/>
 </alternate>
</content>
    
Schema Declaration
element address
{
   att.global.attributes,
   ( text | model.addrPart | model.milestoneLike )*
}

Appendix A.1.10 <adminInfo>

<adminInfo> (administrative information) contains information about the present custody and availability of the manuscript or other object, and also about the record description itself. [10.9.1. Administrative Information]
Modulemsdescription
Attributes
Contained by
msdescription: additional
May contain
core: note
header: availability
Example
<adminInfo>  <recordHist>   <source>Record created <date>1 Aug 2004</date>   </source>  </recordHist>  <availability>   <p>Until 2015 permission to photocopy some materials from this      collection has been limited at the request of the donor. Please ask repository staff for details      if you are interested in obtaining photocopies from Series 1:      Correspondence.</p>  </availability>  <custodialHist>   <p>Collection donated to the Manuscript Library by the Estate of      Edgar Holden in 1993. Donor number: 1993-034.</p>  </custodialHist> </adminInfo>
Content model
<content>
 <sequence>
  <elementRef key="recordHist"
   minOccurs="0"/>
  <elementRef key="availability"
   minOccurs="0"/>
  <elementRef key="custodialHist"
   minOccurs="0"/>
  <classRef key="model.noteLike"
   minOccurs="0"/>
 </sequence>
</content>
    
Schema Declaration
element adminInfo
{
   att.global.attributes,
   ( recordHist?, availability?, custodialHist?, model.noteLike? )
}

Appendix A.1.11 <affiliation>

<affiliation> (affiliation) contains an informal description of a person's present or past affiliation with some organization, for example an employer or sponsor. [15.2.2. The Participant Description]
Modulenamesdates
Attributes
typecharacterizes the element in some sense, using any convenient classification scheme or typology.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Sample values include:
sponsor
recommend
discredit
pledged
Member of
Contained by
May contain
Note

If included, the name of an organization may be tagged using either the <name> element as above, or the more specific <orgName> element.

Example
<affiliation>Junior project officer for the US <name type="org">National Endowment for    the Humanities</name> </affiliation>
ExampleThis example indicates that the person was affiliated with the Australian Journalists Association at some point between the dates listed.
<affiliation notAfter="1960-01-01"  notBefore="1957-02-28">Paid up member of the <orgName>Australian Journalists Association</orgName> </affiliation>
ExampleThis example indicates that the person was affiliated with Mount Holyoke College throughout the entire span of the date range listed.
<affiliation from="1902-01-01"  to="1906-01-01">Was an assistant professor at Mount Holyoke College.</affiliation>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element affiliation
{
   att.global.attributes,
   att.editLike.attributes,
   att.datable.attributes,
   att.naming.attributes,
   att.typed.attribute.subtype,
   attribute type { text }?,
   macro.phraseSeq
}

Appendix A.1.12 <annotationBlock>

<annotationBlock> groups together various annotations, e.g. for parallel interpretations of a spoken segment. [8.4.6. Analytic Coding]
Modulespoken
Attributes
Member of
Contained by
figures: cell
header: change licence
msdescription: acquisition origin summary
namesdates: occupation
textstructure: argument body div
May contain
spoken: incident u
Example
<annotationBlock who="#SPK1start="#T2"  end="#T3xml:id="ag20">  <u xml:id="u20">   <seg xml:id="seg37type="utterance"    subtype="modeless">    <w xml:id="w46">Yeah</w>   </seg>  </u> </annotationBlock> <annotationBlock who="#SPK1start="#T5"  end="#T6xml:id="ag21">  <u xml:id="u21">   <seg xml:id="seg38type="utterance"    subtype="modeless">    <w xml:id="w47">Mhm</w>   </seg>  </u> </annotationBlock>
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <elementRef key="u"/>
  <elementRef key="spanGrp"/>
  <classRef key="model.global.spoken"/>
 </alternate>
</content>
    
Schema Declaration
element annotationBlock
{
   att.ascribed.attributes,
   att.timed.attributes,
   att.global.attributes,
   ( u | spanGrp | model.global.spoken )*
}

Appendix A.1.13 <argument>

<argument> (argument) contains a formal list or prose description of the topics addressed by a subdivision of a text. [4.2. Elements Common to All Divisions 4.6. Title Pages]
Moduletextstructure
Attributes
Member of
Contained by
core: lg list
figures: table
msdescription: msItem
textstructure: body div opener
May contain
Example
<argument>  <p>Monte Video — Maldonado — Excursion    to R Polanco — Lazo and Bolas — Partridges —    Absence of Trees — Deer — Capybara, or River Hog —    Tucutuco — Molothrus, cuckoo-like habits — Tyrant    Flycatcher — Mocking-bird — Carrion Hawks —    Tubes formed by Lightning — House struck</p> </argument>
Content model
<content>
 <sequence>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.global"/>
   <classRef key="model.headLike"/>
  </alternate>
  <sequence minOccurs="1"
   maxOccurs="unbounded">
   <classRef key="model.common"/>
   <classRef key="model.global"
    minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
 </sequence>
</content>
    
Schema Declaration
element argument
{
   att.global.attributes,
   ( ( model.global | model.headLike )*, ( ( model.common, model.global* )+ ) )
}

Appendix A.1.14 <att>

<att> (attribute) contains the name of an attribute appearing within running text. [22. Documentation Elements]
Moduletagdocs
Attributes
scheme(scheme) supplies an identifier for the scheme in which this name is defined.
StatusOptional
Datatypeteidata.enumerated
Sample values include:
TEI
(Text Encoding Initiative) this attribute is part of the TEI scheme.[Default]
DBK
(Docbook) this attribute is part of the Docbook scheme.
XX
(unknown) this attribute is part of an unknown scheme.
imaginary
(imaginary) the attribute is from a non-existent scheme, for illustrative purposes only
XHTML
(XHTML) the attribute is part of the XHTML language
XML
(XML) the attribute is part of the XML language
XI
(XI) the attribute is defined in the xInclude schema
Member of
Contained by
May contain
XSD Name
Note

As an alternative to using the scheme attribute a namespace prefix may be used. Where both scheme and a prefix are used, the prefix takes precedence.

Example
<p>The TEI defines several <soCalled>global</soCalled> attributes; their names include <att>xml:id</att>, <att>rend</att>, <att>xml:lang</att>, <att>n</att>, <att>xml:space</att>, and <att>xml:base</att>; <att scheme="XX">type</att> is not amongst them.</p>
Content model
<content>
 <dataRef key="teidata.name"/>
</content>
    
Schema Declaration
element att { att.global.attributes, attribute scheme { text }?, teidata.name }

Appendix A.1.15 <author>

<author> (author) in a bibliographic reference, contains the name(s) of an author, personal or corporate, of a work; for example in the same form as that provided by a recognized bibliographic name authority. [3.12.2.2. Titles, Authors, and Editors 2.2.1. The Title Statement]
Modulecore
Attributes
Member of
Contained by
core: bibl
header: titleStmt
msdescription: msItem
May contain
Note

Particularly where cataloguing is likely to be based on the content of the header, it is advisable to use a generally recognized name authority file to supply the content for this element. The attributes key or ref may also be used to reference canonical information about the author(s) intended from any appropriate authority, such as a library catalogue or online resource.

In the case of a broadcast, use this element for the name of the company or network responsible for making the broadcast.

Where an author is unknown or unspecified, this element may contain text such as Unknown or Anonymous. When the appropriate TEI modules are in use, it may also contain detailed tagging of the names used for people, organizations or places, in particular where multiple names are given.

Example
<author>British Broadcasting Corporation</author> <author>La Fayette, Marie Madeleine Pioche de la Vergne, comtesse de (1634–1693)</author> <author>Anonymous</author> <author>Bill and Melinda Gates Foundation</author> <author>  <persName>Beaumont, Francis</persName> and <persName>John Fletcher</persName> </author> <author>  <orgName key="BBC">British Broadcasting    Corporation</orgName>: Radio 3 Network </author>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element author
{
   att.global.attributes,
   att.naming.attributes,
   att.datable.attributes,
   macro.phraseSeq
}

Appendix A.1.16 <authority>

<authority> (release authority) supplies the name of a person or other agency responsible for making a work available, other than a publisher or distributor. [2.2.4. Publication, Distribution, Licensing, etc.]
Moduleheader
Attributes
Member of
Contained by
May contain
Example
<authority>John Smith</authority>
Content model
<content>
 <macroRef key="macro.phraseSeq.limited"/>
</content>
    
Schema Declaration
element authority
{
   att.global.attributes,
   att.canonical.attributes,
   macro.phraseSeq.limited
}

Appendix A.1.17 <availability>

<availability> (availability) supplies information about the availability of a text, for example any restrictions on its use or distribution, its copyright status, any licence applying to it, etc. [2.2.4. Publication, Distribution, Licensing, etc.]
Moduleheader
Attributes
status(status) supplies a code identifying the current availability of the text.
StatusOptional
Datatypeteidata.enumerated
Legal values are:
free
(free) the text is freely available.
unknown
(unknown) the status of the text is unknown.
restricted
(restricted) the text is not freely available.
Member of
Contained by
core: bibl
msdescription: adminInfo
May contain
core: p
header: licence
linking: ab
Note

A consistent format should be adopted

Example
<availability status="restricted">  <p>Available for academic research purposes only.</p> </availability> <availability status="free">  <p>In the public domain</p> </availability> <availability status="restricted">  <p>Available under licence from the publishers.</p> </availability>
Example
<availability>  <licence target="http://opensource.org/licenses/MIT">   <p>The MIT License      applies to this document.</p>   <p>Copyright (C) 2011 by The University of Victoria</p>   <p>Permission is hereby granted, free of charge, to any person obtaining a copy      of this software and associated documentation files (the "Software"), to deal      in the Software without restriction, including without limitation the rights      to use, copy, modify, merge, publish, distribute, sublicense, and/or sell      copies of the Software, and to permit persons to whom the Software is      furnished to do so, subject to the following conditions:</p>   <p>The above copyright notice and this permission notice shall be included in      all copies or substantial portions of the Software.</p>   <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR      IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,      FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE      AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER      LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,      OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN      THE SOFTWARE.</p>  </licence> </availability>
Content model
<content>
 <alternate minOccurs="1"
  maxOccurs="unbounded">
  <classRef key="model.availabilityPart"/>
  <classRef key="model.pLike"/>
 </alternate>
</content>
    
Schema Declaration
element availability
{
   att.global.attributes,
   att.declarable.attributes,
   attribute status { "free" | "unknown" | "restricted" }?,
   ( model.availabilityPart | model.pLike )+
}

Appendix A.1.18 <bibl>

<bibl> (bibliographic citation) contains a loosely-structured bibliographic citation of which the sub-components may or may not be explicitly tagged. [3.12.1. Methods of Encoding Bibliographic References and Lists of References 2.2.7. The Source Description 15.3.2. Declarable Elements]
Modulecore
Attributes
Member of
Contained by
May contain
Note

Contains phrase-level elements, together with any combination of elements from the model.biblPart class

Example
<bibl>Blain, Clements and Grundy: Feminist Companion to Literature in English (Yale, 1990)</bibl>
Example
<bibl>  <title level="a">The Interesting story of the Children in the Wood</title>. In <author>Victor E Neuberg</author>, <title>The Penny Histories</title>. <publisher>OUP</publisher>  <date>1968</date>. </bibl>
Example
<bibl type="articlesubtype="book_chapter"  xml:id="carlin_2003">  <author>   <name>    <surname>Carlin</surname>      (<forename>Claire</forename>)</name>  </author>, <title level="a">The Staging of Impotence : France’s last    congrès</title> dans <bibl type="monogr">   <title level="m">Theatrum mundi : studies in honor of Ronald W.      Tobin</title>, éd.  <editor>    <name>     <forename>Claire</forename>     <surname>Carlin</surname>    </name>   </editor> et  <editor>    <name>     <forename>Kathleen</forename>     <surname>Wine</surname>    </name>   </editor>,  <pubPlace>Charlottesville, Va.</pubPlace>,  <publisher>Rookwood Press</publisher>,  <date when="2003">2003</date>.  </bibl> </bibl>
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.gLike"/>
  <classRef key="model.highlighted"/>
  <classRef key="model.pPart.data"/>
  <classRef key="model.pPart.edit"/>
  <classRef key="model.segLike"/>
  <classRef key="model.ptrLike"/>
  <classRef key="model.biblPart"/>
  <classRef key="model.global"/>
 </alternate>
</content>
    
Schema Declaration
element bibl
{
   att.global.attributes,
   att.declarable.attributes,
   att.typed.attributes,
   att.sortable.attributes,
   att.docStatus.attributes,
   (
      text
    | model.gLikemodel.highlightedmodel.pPart.datamodel.pPart.editmodel.segLikemodel.ptrLikemodel.biblPartmodel.global
   )*
}

Appendix A.1.19 <birth>

<birth> (birth) contains information about a person's birth, such as its date and place. [15.2.2. The Participant Description]
Modulenamesdates
Attributes
typecharacterizes the element in some sense, using any convenient classification scheme or typology.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Sample values include:
caesarean
(caesarean section)
vaginal
(vaginal delivery)
exNihilo
(ex nihilo)
incorporated
founded
established
Member of
Contained by
namesdates: person
May contain
Example
<birth>Before 1920, Midlands region.</birth>
Example
<birth when="1960-12-10">In a small cottage near <name type="place">Aix-la-Chapelle</name>, early in the morning of <date>10 Dec 1960</date> </birth>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element birth
{
   att.global.attributes,
   att.editLike.attributes,
   att.datable.attributes,
   att.dimensions.attributes,
   att.naming.attributes,
   att.typed.attribute.subtype,
   attribute type { text }?,
   macro.phraseSeq
}

Appendix A.1.20 <body>

<body> (text body) contains the whole body of a single unitary text, excluding any front or back matter. [4. Default Text Structure]
Moduletextstructure
Attributes
Contained by
textstructure: text
May contain
Example
<body>  <l>Nu scylun hergan hefaenricaes uard</l>  <l>metudæs maecti end his modgidanc</l>  <l>uerc uuldurfadur sue he uundra gihuaes</l>  <l>eci dryctin or astelidæ</l>  <l>he aerist scop aelda barnum</l>  <l>heben til hrofe haleg scepen.</l>  <l>tha middungeard moncynnæs uard</l>  <l>eci dryctin æfter tiadæ</l>  <l>firum foldu frea allmectig</l>  <trailer>primo cantauit Cædmon istud carmen.</trailer> </body>
Content model
<content>
 <sequence>
  <classRef key="model.global"
   minOccurs="0" maxOccurs="unbounded"/>
  <sequence minOccurs="0">
   <classRef key="model.divTop"/>
   <alternate minOccurs="0"
    maxOccurs="unbounded">
    <classRef key="model.global"/>
    <classRef key="model.divTop"/>
   </alternate>
  </sequence>
  <sequence minOccurs="0">
   <classRef key="model.divGenLike"/>
   <alternate minOccurs="0"
    maxOccurs="unbounded">
    <classRef key="model.global"/>
    <classRef key="model.divGenLike"/>
   </alternate>
  </sequence>
  <alternate>
   <sequence minOccurs="1"
    maxOccurs="unbounded">
    <classRef key="model.divLike"/>
    <alternate minOccurs="0"
     maxOccurs="unbounded">
     <classRef key="model.global"/>
     <classRef key="model.divGenLike"/>
    </alternate>
   </sequence>
   <sequence minOccurs="1"
    maxOccurs="unbounded">
    <classRef key="model.div1Like"/>
    <alternate minOccurs="0"
     maxOccurs="unbounded">
     <classRef key="model.global"/>
     <classRef key="model.divGenLike"/>
    </alternate>
   </sequence>
   <sequence>
    <sequence minOccurs="1"
     maxOccurs="unbounded">
     <alternate minOccurs="1" maxOccurs="1">
      <elementRef key="schemaSpec"/>
      <classRef key="model.common"/>
     </alternate>
     <classRef key="model.global"
      minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
    <alternate minOccurs="0">
     <sequence minOccurs="1"
      maxOccurs="unbounded">
      <classRef key="model.divLike"/>
      <alternate minOccurs="0"
       maxOccurs="unbounded">
       <classRef key="model.global"/>
       <classRef key="model.divGenLike"/>
      </alternate>
     </sequence>
     <sequence minOccurs="1"
      maxOccurs="unbounded">
      <classRef key="model.div1Like"/>
      <alternate minOccurs="0"
       maxOccurs="unbounded">
       <classRef key="model.global"/>
       <classRef key="model.divGenLike"/>
      </alternate>
     </sequence>
    </alternate>
   </sequence>
  </alternate>
  <sequence minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.divBottom"/>
   <classRef key="model.global"
    minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
 </sequence>
</content>
    
Schema Declaration
element body
{
   att.global.attributes,
   att.declaring.attributes,
   (
      model.global*,
      ( ( model.divTop, ( model.global | model.divTop )* )? ),
      ( ( model.divGenLike, ( model.global | model.divGenLike )* )? ),
      (
         ( ( model.divLike, ( model.global | model.divGenLike )* )+ )
       | ( ( model.div1Like, ( model.global | model.divGenLike )* )+ )
       | (
            ( ( ( schemaSpec | model.common ), model.global* )+ ),
            (
               ( ( model.divLike, ( model.global | model.divGenLike )* )+ )
             | ( ( model.div1Like, ( model.global | model.divGenLike )* )+ )
            )?
         )
      ),
      ( ( model.divBottom, model.global* )* )
   )
}

Appendix A.1.21 <catRef>

<catRef> (category reference) specifies one or more defined categories within some taxonomy or text typology. [2.4.3. The Text Classification]
Moduleheader
Attributes
targetspecifies the destination of the reference by supplying one or more URI References
Derived fromatt.pointing
StatusRequired
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Legal values are:
loi:loiCollection
Collections
loi:loiCollectionCustodianCaseFiles
Custodian Case Files
loi:loiCollectionOralHistories
Oral Histories
loi:loiCollectionProtestLetters
Protest Letters
loi:loiCollectionLegalCases
Legal Cases
loi:loiCollectionLandTitles
Land Titles
loi:loiCollectionLandLots
Land Lots
loi:loiCollectionFishingBoatLedger
Fishing Boat Ledger
loi:loiCollectionFishingVesselRequestLetters
Fishing Vessel Request Letters
loi:loiCollectionDirectories
Directories
loi:loiCollectionArchivalFiles
Other Archival Files
loi:loiCollectionMiscellaneous
Miscellaneous
loi:loiData
Data
loi:loiDataNames
Names
loi:loiDataOrganizations
Organizations
loi:loiDataPlaces
Places
loi:loiDataVancouverStreets
Powell Street Neighbourhood Streets
loi:loiDataTeam
Team
loi:loiAbout
About
loi:loiBornDigital
(Born digital document.) Born Digital
loi:loiBornDigitalAbout
(An about document for the website) About
loi:loiBornDigitalSearch
(A search page.) Search
loi:loiBornDigitalIndex
(A document index, only allowed on generated pages.) Document Index
loi:loiBornDigitalBoilerplate
(A boilerplate document not meant for standalone publication on the website. This includes documents like the site menu.) Boilerplate
loi:loiDataset
(A created or derived dataset.) Datasets
loi:loiDatasetCustodianCaseFile
Custodian Case Files
loi:loiDatasetCustodianCaseFileReel
Custodian Case File Reel
loi:loiDatasetCustodianCaseFileName
Custodian Case File Name Index
loi:loiDatasetNames
(A listing of names document) People
loi:loiDatasetNamesA
(A listing of names) Names: A
loi:loiDatasetNamesB
(A listing of names) Names: B
loi:loiDatasetNamesC
(A listing of names) Names: C
loi:loiDatasetNamesD
(A listing of names) Names: D
loi:loiDatasetNamesE
(A listing of names) Names: E
loi:loiDatasetNamesF
(A listing of names) Names: F
loi:loiDatasetNamesG
(A listing of names) Names: G
loi:loiDatasetNamesH
(A listing of names) Names: H
loi:loiDatasetNamesI
(A listing of names) Names: I
loi:loiDatasetNamesJ
(A listing of names) Names: J
loi:loiDatasetNamesK
(A listing of names) Names: K
loi:loiDatasetNamesL
(A listing of names) Names: L
loi:loiDatasetNamesM
(A listing of names) Names: M
loi:loiDatasetNamesN
(A listing of names) Names: N
loi:loiDatasetNamesO
(A listing of names) Names: O
loi:loiDatasetNamesP
(A listing of names) Names: P
loi:loiDatasetNamesQ
(A listing of names) Names: Q
loi:loiDatasetNamesR
(A listing of names) Names: R
loi:loiDatasetNamesS
(A listing of names) Names: S
loi:loiDatasetNamesT
(A listing of names) Names: T
loi:loiDatasetNamesU
(A listing of names) Names: U
loi:loiDatasetNamesV
(A listing of names) Names: V
loi:loiDatasetNamesW
(A listing of names) Names: W
loi:loiDatasetNamesX
(A listing of names) Names: X
loi:loiDatasetNamesY
(A listing of names) Names: Y
loi:loiDatasetNamesZ
(A listing of names) Names: Z
loi:loiDatasetTeam
(An LOI Team Member document) Team Members
loi:loiDatasetPlace
(A listing of names) Places
loi:loiDatasetOrg
(A orgs listing document) Organizations
loi:loiDatasetArchival
Archival Datasets
loi:loiDatasetArchivalFonds
Archival Dataset: Fonds
loi:loiDatasetArchivalSousfonds
Archival Dataset: Sous-fonds
loi:loiDatasetArchivalSeries
Archival Dataset: Series
loi:loiDatasetArchivalSubseries
Archival Dataset: Subseries
loi:loiDatasetArchivalFile
Archival Dataset: File
loi:loiDatasetArchivalObject
Archival Dataset: Object
loi:loiDatasetLegalCaseFile
Legal Case File
loi:loiDatasetTitle
Titles
loi:loiDatasetLot
Lots
loi:loiDatasetStory
Lot/Titles Stories
loi:loiPrimarySource
(A primary source document.) Primary Source
loi:loiPrimarySourceProtestLetter
(A letter protesting the sale of property or a government reply to protest letter.) Protest Letter
loi:loiPrimarySourceFishingVesselRequest
(A letter requesting information about seized Japanese-Canadian fishing vessels.) Fishing Vessel Request Letter
loi:loiPrimarySourceDirectory
Directory
loi:loiPrimarySourceOralHistory
Oral History
loi:loiPrimarySourceBoatLedger
Fishing Boat Ledger
loi:loiDatasetStreetIndex
Street Index
schemeidentifies the classification scheme within which the set of categories concerned is defined, for example by a <taxonomy> element, or by some other resource.
StatusRequired
Datatypeteidata.pointer
Legal values are:
loi:loiNavigation
LOI Navigation TaxonomyTaxonomy for site navigation
loi:loiDocumentTypes
LOI Document Type TaxonomyTaxonomy of document types
Contained by
header: textClass
May containEmpty element
Note

The scheme attribute needs to be supplied only if more than one taxonomy has been declared.

Example
<catRef scheme="#myTopics"  target="#news #prov #sales2"/> <!-- elsewhere --> <taxonomy xml:id="myTopics">  <category xml:id="news">   <catDesc>Newspapers</catDesc>  </category>  <category xml:id="prov">   <catDesc>Provincial</catDesc>  </category>  <category xml:id="sales2">   <catDesc>Low to average annual sales</catDesc>  </category> </taxonomy>
SchematronGenerated co-occurance constraint to limit targets to their appropriate scheme/taxonomy.
<sch:pattern> <sch:rule context="tei:catRef[@scheme = 'loi:loiNavigation'][@target]">  <sch:let name="targPtr"   value="substring-after(@target,':')"/>  <sch:let name="vals"   value="('loiCollection','loiCollectionCustodianCaseFiles','loiCollectionOralHistories','loiCollectionProtestLetters','loiCollectionLegalCases','loiCollectionLandTitles','loiCollectionLandLots','loiCollectionFishingBoatLedger','loiCollectionFishingVesselRequestLetters','loiCollectionDirectories','loiCollectionArchivalFiles','loiCollectionMiscellaneous','loiData','loiDataNames','loiDataOrganizations','loiDataPlaces','loiDataVancouverStreets','loiDataTeam','loiAbout')"/>  <sch:assert test="$targPtr = $vals">ERROR: Target <sch:value-of select="@target"/> cannot be used with document taxonomy scheme (<sch:value-of select="@scheme"/>).    Allowable values are <sch:value-of select="string-join($vals,', ')"/>  </sch:assert> </sch:rule> <sch:rule context="tei:catRef[@scheme = 'loi:loiDocumentTypes'][@target]">  <sch:let name="targPtr"   value="substring-after(@target,':')"/>  <sch:let name="vals"   value="('loiBornDigital','loiBornDigitalAbout','loiBornDigitalSearch','loiBornDigitalIndex','loiBornDigitalBoilerplate','loiDataset','loiDatasetCustodianCaseFile','loiDatasetCustodianCaseFileReel','loiDatasetCustodianCaseFileName','loiDatasetNames','loiDatasetNamesA','loiDatasetNamesB','loiDatasetNamesC','loiDatasetNamesD','loiDatasetNamesE','loiDatasetNamesF','loiDatasetNamesG','loiDatasetNamesH','loiDatasetNamesI','loiDatasetNamesJ','loiDatasetNamesK','loiDatasetNamesL','loiDatasetNamesM','loiDatasetNamesN','loiDatasetNamesO','loiDatasetNamesP','loiDatasetNamesQ','loiDatasetNamesR','loiDatasetNamesS','loiDatasetNamesT','loiDatasetNamesU','loiDatasetNamesV','loiDatasetNamesW','loiDatasetNamesX','loiDatasetNamesY','loiDatasetNamesZ','loiDatasetTeam','loiDatasetPlace','loiDatasetOrg','loiDatasetArchival','loiDatasetArchivalFonds','loiDatasetArchivalSousfonds','loiDatasetArchivalSeries','loiDatasetArchivalSubseries','loiDatasetArchivalFile','loiDatasetArchivalObject','loiDatasetLegalCaseFile','loiDatasetTitle','loiDatasetLot','loiDatasetStory','loiPrimarySource','loiPrimarySourceProtestLetter','loiPrimarySourceFishingVesselRequest','loiPrimarySourceDirectory','loiPrimarySourceOralHistory','loiPrimarySourceBoatLedger','loiDatasetStreetIndex')"/>  <sch:assert test="$targPtr = $vals">ERROR: Target <sch:value-of select="@target"/> cannot be used with document taxonomy scheme (<sch:value-of select="@scheme"/>).    Allowable values are <sch:value-of select="string-join($vals,', ')"/>  </sch:assert> </sch:rule> </sch:pattern>
Content model
<content>
 <empty/>
</content>
    
Schema Declaration
element catRef
{
   att.global.attributes,
   att.pointing.attribute.targetLang,
   att.pointing.attribute.evaluate,
   attribute target
   {
      list
      {
         (
            "loi:loiCollection"
          | "loi:loiCollectionCustodianCaseFiles"
          | "loi:loiCollectionOralHistories"
          | "loi:loiCollectionProtestLetters"
          | "loi:loiCollectionLegalCases"
          | "loi:loiCollectionLandTitles"
          | "loi:loiCollectionLandLots"
          | "loi:loiCollectionFishingBoatLedger"
          | "loi:loiCollectionFishingVesselRequestLetters"
          | "loi:loiCollectionDirectories"
          | "loi:loiCollectionArchivalFiles"
          | "loi:loiCollectionMiscellaneous"
          | "loi:loiData"
          | "loi:loiDataNames"
          | "loi:loiDataOrganizations"
          | "loi:loiDataPlaces"
          | "loi:loiDataVancouverStreets"
          | "loi:loiDataTeam"
          | "loi:loiAbout"
          | "loi:loiBornDigital"
          | "loi:loiBornDigitalAbout"
          | "loi:loiBornDigitalSearch"
          | "loi:loiBornDigitalIndex"
          | "loi:loiBornDigitalBoilerplate"
          | "loi:loiDataset"
          | "loi:loiDatasetCustodianCaseFile"
          | "loi:loiDatasetCustodianCaseFileReel"
          | "loi:loiDatasetCustodianCaseFileName"
          | "loi:loiDatasetNames"
          | "loi:loiDatasetNamesA"
          | "loi:loiDatasetNamesB"
          | "loi:loiDatasetNamesC"
          | "loi:loiDatasetNamesD"
          | "loi:loiDatasetNamesE"
          | "loi:loiDatasetNamesF"
          | "loi:loiDatasetNamesG"
          | "loi:loiDatasetNamesH"
          | "loi:loiDatasetNamesI"
          | "loi:loiDatasetNamesJ"
          | "loi:loiDatasetNamesK"
          | "loi:loiDatasetNamesL"
          | "loi:loiDatasetNamesM"
          | "loi:loiDatasetNamesN"
          | "loi:loiDatasetNamesO"
          | "loi:loiDatasetNamesP"
          | "loi:loiDatasetNamesQ"
          | "loi:loiDatasetNamesR"
          | "loi:loiDatasetNamesS"
          | "loi:loiDatasetNamesT"
          | "loi:loiDatasetNamesU"
          | "loi:loiDatasetNamesV"
          | "loi:loiDatasetNamesW"
          | "loi:loiDatasetNamesX"
          | "loi:loiDatasetNamesY"
          | "loi:loiDatasetNamesZ"
          | "loi:loiDatasetTeam"
          | "loi:loiDatasetPlace"
          | "loi:loiDatasetOrg"
          | "loi:loiDatasetArchival"
          | "loi:loiDatasetArchivalFonds"
          | "loi:loiDatasetArchivalSousfonds"
          | "loi:loiDatasetArchivalSeries"
          | "loi:loiDatasetArchivalSubseries"
          | "loi:loiDatasetArchivalFile"
          | "loi:loiDatasetArchivalObject"
          | "loi:loiDatasetLegalCaseFile"
          | "loi:loiDatasetTitle"
          | "loi:loiDatasetLot"
          | "loi:loiDatasetStory"
          | "loi:loiPrimarySource"
          | "loi:loiPrimarySourceProtestLetter"
          | "loi:loiPrimarySourceFishingVesselRequest"
          | "loi:loiPrimarySourceDirectory"
          | "loi:loiPrimarySourceOralHistory"
          | "loi:loiPrimarySourceBoatLedger"
          | "loi:loiDatasetStreetIndex"
         )+
      }
   },
   attribute scheme { "loi:loiNavigation" | "loi:loiDocumentTypes" },
   empty
}

Appendix A.1.22 <cb>

<cb> (column beginning) marks the beginning of a new column of a text on a multi-column page. [3.11.3. Milestone Elements]
Modulecore
Attributes
Member of
Contained by
May containEmpty element
Note

On this element, the global n attribute indicates the number or other value associated with the column which follows the point of insertion of this <cb> element. Encoders should adopt a clear and consistent policy as to whether the numbers associated with column breaks relate to the physical sequence number of the column in the whole text, or whether columns are numbered within the page. The <cb> element is placed at the head of the column to which it refers.

ExampleMarkup of an early English dictionary printed in two columns:
<pb/> <cb n="1"/> <entryFree>  <form>Well</form>, <sense>a Pit to hold Spring-Water</sense>: <sense>In the Art of <hi rend="italic">War</hi>, a Depth the Miner    sinks into the Ground, to find out and disappoint the Enemies Mines,    or to prepare one</sense>. </entryFree> <entryFree>To <form>Welter</form>, <sense>to wallow</sense>, or <sense>lie groveling</sense>.</entryFree> <!-- remainder of column --> <cb n="2"/> <entryFree>  <form>Wey</form>, <sense>the greatest Measure for dry Things,    containing five Chaldron</sense>. </entryFree> <entryFree>  <form>Whale</form>, <sense>the greatest of    Sea-Fishes</sense>. </entryFree>
Content model
<content>
 <empty/>
</content>
    
Schema Declaration
element cb
{
   att.global.attributes,
   att.typed.attributes,
   att.edition.attributes,
   att.spanning.attributes,
   att.breaking.attributes,
   empty
}

Appendix A.1.23 <cell>

<cell> (cell) contains one cell of a table. [14.1.1. TEI Tables]
Modulefigures
Attributes
Contained by
figures: row
May contain
Example
<row>  <cell role="label">General conduct</cell>  <cell role="data">Not satisfactory, on account of his great unpunctuality    and inattention to duties</cell> </row>
Content model
<content>
 <macroRef key="macro.specialPara"/>
</content>
    
Schema Declaration
element cell
{
   att.global.attributes,
   att.tableDecoration.attributes,
   macro.specialPara
}

Appendix A.1.24 <change>

<change> (change) documents a change or set of changes made during the production of a source document, or during the revision of an electronic file. [2.6. The Revision Description 2.4.1. Creation 11.7. Identifying Changes and Revisions]
Moduleheader
Attributes
target(target) points to one or more elements that belong to this change.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Contained by
header: revisionDesc
May contain
Note

The who attribute may be used to point to any other element, but will typically specify a <respStmt> or <person> element elsewhere in the header, identifying the person responsible for the change and their role in making it.

It is recommended that changes be recorded with the most recent first. The status attribute may be used to indicate the status of a document following the change documented.

Example
<titleStmt>  <title> ... </title>  <editor xml:id="LDB">Lou Burnard</editor>  <respStmt xml:id="BZ">   <resp>copy editing</resp>   <name>Brett Zamir</name>  </respStmt> </titleStmt> <!-- ... --> <revisionDesc status="published">  <change who="#BZwhen="2008-02-02"   status="public">Finished chapter 23</change>  <change who="#BZwhen="2008-01-02"   status="draft">Finished chapter 2</change>  <change n="P2.2when="1991-12-21"   who="#LDB">Added examples to section 3</change>  <change when="1991-11-11who="#MSM">Deleted chapter 10</change> </revisionDesc>
Example
<profileDesc>  <creation>   <listChange>    <change xml:id="DRAFT1">First draft in pencil</change>    <change xml:id="DRAFT2"     notBefore="1880-12-09">First revision, mostly        using green ink</change>    <change xml:id="DRAFT3"     notBefore="1881-02-13">Final corrections as        supplied to printer.</change>   </listChange>  </creation> </profileDesc>
SchematronAll change/@who pointers should point to a team member.
<sch:pattern> <sch:rule context="tei:change[@who]">  <sch:let name="pointers"   value="tokenize(@who,'\s+')"/>  <sch:let name="errors"   value="$pointers[not(matches(.,'^team:'))]"/>  <sch:assert test="empty($errors)">ERROR: All change/@who should point to a team member. The pointer(s) <sch:value-of select="string-join($errors,', ')"/> do not.</sch:assert> </sch:rule> </sch:pattern>
Content model
<content>
 <macroRef key="macro.specialPara"/>
</content>
    
Schema Declaration
element change
{
   att.ascribed.attributes,
   att.datable.attributes,
   att.docStatus.attributes,
   att.global.attributes,
   att.typed.attributes,
   attribute target { list { + } }?,
   macro.specialPara
}

Appendix A.1.25 <charDecl>

<charDecl> (character declarations) provides information about nonstandard characters and glyphs. [5.2. Markup Constructs for Representation of Characters and Glyphs]
Modulegaiji
Attributes
Member of
Contained by
header: encodingDesc
May contain
core: desc
gaiji: glyph
Example
<charDecl>  <char xml:id="aENL">   <unicodeProp name="Name"    value="LATIN LETTER ENLARGED SMALL A"/>   <mapping type="standard">a</mapping>  </char> </charDecl>
Content model
<content>
 <sequence>
  <elementRef key="desc" minOccurs="0"/>
  <alternate minOccurs="1"
   maxOccurs="unbounded">
   <elementRef key="char"/>
   <elementRef key="glyph"/>
  </alternate>
 </sequence>
</content>
    
Schema Declaration
element charDecl { att.global.attributes, ( desc?, ( char | glyph )+ ) }

Appendix A.1.26 <choice>

<choice> (choice) groups a number of alternative encodings for the same point in a text. [3.5. Simple Editorial Changes]
Modulecore
Attributes
Member of
Contained by
May contain
Note

Because the children of a <choice> element all represent alternative ways of encoding the same sequence, it is natural to think of them as mutually exclusive. However, there may be cases where a full representation of a text requires the alternative encodings to be considered as parallel.

Note also that <choice> elements may self-nest.

Where the purpose of an encoding is to record multiple witnesses of a single work, rather than to identify multiple possible encoding decisions at a given point, the <app> element and associated elements discussed in section 12.1. The Apparatus Entry, Readings, and Witnesses should be preferred.

ExampleAn American encoding of Gulliver's Travels which retains the British spelling but also provides a version regularized to American spelling might be encoded as follows.
<p>Lastly, That, upon his solemn oath to observe all the above articles, the said man-mountain shall have a daily allowance of meat and drink sufficient for the support of <choice>   <sic>1724</sic>   <corr>1728</corr>  </choice> of our subjects, with free access to our royal person, and other marks of our <choice>   <orig>favour</orig>   <reg>favor</reg>  </choice>.</p>
Content model
<content>
 <alternate minOccurs="2"
  maxOccurs="unbounded">
  <classRef key="model.choicePart"/>
  <elementRef key="choice"/>
 </alternate>
</content>
    
Schema Declaration
element choice
{
   att.global.attributes,
   ( model.choicePart | choice ),
   ( model.choicePart | choice ),
   ( model.choicePart | choice )*
}

Appendix A.1.27 <closer>

<closer> (closer) groups together salutations, datelines, and similar phrases appearing as a final group at the end of a division, especially of a letter. [4.2.2. Openers and Closers 4.2. Elements Common to All Divisions]
Moduletextstructure
Attributes
Member of
Contained by
core: lg list
figures: table
textstructure: body div
May contain
Example
<div type="letter">  <p> perhaps you will favour me with a sight of it when convenient.</p>  <closer>   <salute>I remain, &amp;c. &amp;c.</salute>   <signed>H. Colburn</signed>  </closer> </div>
Example
<div type="chapter">  <p> <!-- ... --> and his heart was going like mad and yes I said yes I will Yes.</p>  <closer>   <dateline>    <name type="place">Trieste-Zürich-Paris,</name>    <date>1914–1921</date>   </dateline>  </closer> </div>
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.gLike"/>
  <elementRef key="signed"/>
  <elementRef key="dateline"/>
  <elementRef key="salute"/>
  <classRef key="model.phrase"/>
  <classRef key="model.global"/>
 </alternate>
</content>
    
Schema Declaration
element closer
{
   att.global.attributes,
   att.written.attributes,
   (
      text
    | model.gLikesigneddatelinesalutemodel.phrasemodel.global
   )*
}

Appendix A.1.28 <corr>

<corr> (correction) contains the correct form of a passage apparently erroneous in the copy text. [3.5.1. Apparent Errors]
Modulecore
Attributes
Member of
Contained by
May contain
ExampleIf all that is desired is to call attention to the fact that the copy text has been corrected, <corr> may be used alone:
I don't know, Juan. It's so far in the past now — how <corr>can we</corr> prove or disprove anyone's theories?
ExampleIt is also possible, using the <choice> and <sic> elements, to provide an uncorrected reading:
I don't know, Juan. It's so far in the past now — how <choice>  <sic>we can</sic>  <corr>can we</corr> </choice> prove or disprove anyone's theories?
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element corr
{
   att.global.attributes,
   att.editLike.attributes,
   att.typed.attributes,
   macro.paraContent
}

Appendix A.1.29 <correspAction>

<correspAction> (correspondence action) contains a structured description of the place, the name of a person/organization and the date related to the sending/receiving of a message or any other action related to the correspondence. [2.4.6. Correspondence Description]
Moduleheader
Attributes
typedescribes the nature of the action.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Suggested values include:
sent
information concerning the sending or dispatch of a message.
received
information concerning the receipt of a message.
transmitted
information concerning the transmission of a message, i.e. between the dispatch and the next receipt, redirect or forwarding.
redirected
information concerning the redirection of an unread message.
forwarded
information concerning the forwarding of a message.
Member of
Contained by
header: correspDesc
May contain
Example
<correspAction type="sent">  <persName>Adelbert von Chamisso</persName>  <settlement>Vertus</settlement>  <date when="1807-01-29"/> </correspAction>
Content model
<content>
 <alternate>
  <classRef key="model.correspActionPart"
   minOccurs="1" maxOccurs="unbounded"/>
  <classRef key="model.pLike" minOccurs="1"
   maxOccurs="unbounded"/>
 </alternate>
</content>
    
Schema Declaration
element correspAction
{
   att.global.attributes,
   att.typed.attribute.subtype,
   att.sortable.attributes,
   attribute type
   {
      "sent" | "received" | "transmitted" | "redirected" | "forwarded"
   }?,
   ( model.correspActionPart+ | model.pLike+ )
}

Appendix A.1.30 <correspDesc>

<correspDesc> (correspondence description) contains a description of the actions related to one act of correspondence. [2.4.6. Correspondence Description]
Moduleheader
Attributes
Member of
Contained by
header: profileDesc
May contain
core: note p
linking: ab
Example
<correspDesc>  <correspAction type="sent">   <persName>Carl Maria von Weber</persName>   <settlement>Dresden</settlement>   <date when="1817-06-23">23 June 1817</date>  </correspAction>  <correspAction type="received">   <persName>Caroline Brandt</persName>   <settlement>Prag</settlement>  </correspAction>  <correspContext>   <ref type="prev"    target="http://www.weber-gesamtausgabe.de/A041209">Previous letter of   <persName>Carl Maria von Weber</persName>      to <persName>Caroline Brandt</persName>:   <date from="1817-06-19to="1817-06-20">June 19/20, 1817</date>   </ref>   <ref type="next"    target="http://www.weber-gesamtausgabe.de/A041217">Next letter of   <persName>Carl Maria von Weber</persName> to   <persName>Caroline Brandt</persName>:   <date when="1817-06-27">June 27, 1817</date>   </ref>  </correspContext> </correspDesc>
Content model
<content>
 <alternate>
  <classRef key="model.correspDescPart"
   minOccurs="1" maxOccurs="unbounded"/>
  <classRef key="model.pLike" minOccurs="1"
   maxOccurs="unbounded"/>
 </alternate>
</content>
    
Schema Declaration
element correspDesc
{
   att.declarable.attributes,
   att.canonical.attributes,
   att.global.attributes,
   att.typed.attributes,
   ( model.correspDescPart+ | model.pLike+ )
}

Appendix A.1.31 <date>

<date> (date) contains a date in any format. [3.6.4. Dates and Times 2.2.4. Publication, Distribution, Licensing, etc. 2.6. The Revision Description 3.12.2.4. Imprint, Size of a Document, and Reprint Information 15.2.3. The Setting Description 13.4. Dates]
Modulecore
Attributes
Member of
Contained by
May contain
Example
<date when="1980-02">early February 1980</date>
Example
Given on the <date when="1977-06-12">Twelfth Day of June in the Year of Our Lord One Thousand Nine Hundred and Seventy-seven of the Republic the Two Hundredth and first and of the University the Eighty-Sixth.</date>
Example
<date when="1990-09">September 1990</date>
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.gLike"/>
  <classRef key="model.phrase"/>
  <classRef key="model.global"/>
 </alternate>
</content>
    
Schema Declaration
element date
{
   att.global.attribute.xmlid,
   att.global.attribute.xmllang,
   att.global.attribute.xmlbase,
   att.global.responsibility.attribute.resp,
   att.datable.w3c.attribute.when,
   att.datable.w3c.attribute.notBefore,
   att.datable.w3c.attribute.notAfter,
   att.datable.w3c.attribute.from,
   att.datable.w3c.attribute.to,
   att.canonical.attribute.ref,
   att.dimensions.attribute.precision,
   att.ranging.attribute.atMost,
   ( text | model.gLike | model.phrase | model.global )*
}

Appendix A.1.32 <dateline>

<dateline> (dateline) contains a brief description of the place, date, time, etc. of production of a letter, newspaper story, or other work, prefixed or suffixed to it as a kind of heading or trailer. [4.2.2. Openers and Closers]
Moduletextstructure
Attributes
Member of
Contained by
core: lg list
figures: table
textstructure: body closer div opener
May contain
Example
<dateline>Walden, this 29. of August 1592</dateline>
Example
<div type="chapter">  <p> <!-- ... --> and his heart was going like mad and yes I said yes I will Yes.</p>  <closer>   <dateline>    <name type="place">Trieste-Zürich-Paris,</name>    <date>1914–1921</date>   </dateline>  </closer> </div>
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.gLike"/>
  <classRef key="model.phrase"/>
  <classRef key="model.global"/>
  <elementRef key="docDate"/>
 </alternate>
</content>
    
Schema Declaration
element dateline
{
   att.global.attributes,
   ( text | model.gLike | model.phrase | model.global | docDate )*
}

Appendix A.1.33 <death>

<death> (death) contains information about a person's death, such as its date and place. [15.2.2. The Participant Description]
Modulenamesdates
Attributes
typecharacterizes the element in some sense, using any convenient classification scheme or typology.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Sample values include:
proclaimed
assumed
verified
clinical
brain
natural
unnatural
fragmentation
dissolution
Note

This attribute is not intended to express the cause of death.

Member of
Contained by
namesdates: person
May contain
Example
<death when="1902-10-01"/>
Example
<death when="1960-12-10">Passed away near <name type="place">Aix-la-Chapelle</name>, after suffering from cerebral palsy. </death>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element death
{
   att.datable.attributes,
   att.dimensions.attributes,
   att.editLike.attributes,
   att.global.attributes,
   att.naming.attributes,
   att.typed.attribute.subtype,
   attribute type { text }?,
   macro.phraseSeq
}

Appendix A.1.34 <desc>

<desc> (description) contains a short description of the purpose, function, or use of its parent element, or when the parent is a documentation element, describes or defines the object being documented. [22.4.1. Description of Components]
Modulecore
Attributes
typecharacterizes the element in some sense, using any convenient classification scheme or typology.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Suggested values include:
deprecationInfo
(deprecation information) This element describes why or how its parent element is being deprecated, typically including recommendations for alternate encoding.
<dataSpec module="tei"  ident="teidata.point"  validUntil="2050-02-25">  <desc type="deprecationInfo"   versionDate="2018-09-14"   xml:lang="en">Several standards bodies, including NIST in the USA,    strongly recommend against ending the representation of a number    with a decimal point. So instead of <q>3.</q> use either <q>3</q>    or <q>3.0</q>.</desc> <!-- ... --> </dataSpec>
Member of
Contained by
May contain
Note

When used in a specification element such as <elementSpec>, TEI convention requires that this be expressed as a finite clause, begining with an active verb.

ExampleExample of a <desc> element inside a documentation element.
<dataSpec module="tei"  ident="teidata.point">  <desc versionDate="2010-10-17"   xml:lang="en">defines the data type used to express a point in cartesian space.</desc>  <content>   <dataRef name="token"    restriction="(-?[0-9]+(\.[0-9]+)?,-?[0-9]+(\.[0-9]+)?)"/>  </content> <!-- ... --> </dataSpec>
ExampleExample of a <desc> element in a non-documentation element.
<place xml:id="KERG2">  <placeName>Kerguelen Islands</placeName> <!-- ... -->  <terrain>   <desc>antarctic tundra</desc>  </terrain> <!-- ... --> </place>
SchematronA <desc> with a type of deprecationInfo should only occur when its parent element is being deprecated. Furthermore, it should always occur in an element that is being deprecated when <desc> is a valid child of that element.
<sch:rule context="tei:desc[ @type eq 'deprecationInfo']"> <sch:assert test="../@validUntil">Information about a deprecation should only be present in a specification element that is being deprecated: that is, only an element that has a @validUntil attribute should have a child <desc type="deprecationInfo">.</sch:assert> </sch:rule>
Content model
<content>
 <macroRef key="macro.limitedContent"/>
</content>
    
Schema Declaration
element desc
{
   att.global.attributes,
   att.translatable.attributes,
   att.typed.attribute.subtype,
   attribute type { "deprecationInfo" }?,
   macro.limitedContent
}

Appendix A.1.35 <distributor>

<distributor> (distributor) supplies the name of a person or other agency responsible for the distribution of a text. [2.2.4. Publication, Distribution, Licensing, etc.]
Moduleheader
Attributes
Member of
Contained by
core: bibl
May contain
Example
<distributor>Oxford Text Archive</distributor> <distributor>Redwood and Burn Ltd</distributor>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element distributor
{
   att.global.attributes,
   att.canonical.attributes,
   macro.phraseSeq
}

Appendix A.1.36 <district>

<district> (district) contains the name of any kind of subdivision of a settlement, such as a parish, ward, or other administrative or geographic unit. [13.2.3. Place Names]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Example
<placeName>  <district type="ward">Jericho</district>  <settlement>Oxford</settlement> </placeName>
Example
<placeName>  <district type="area">South Side</district>  <settlement>Chicago</settlement> </placeName>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element district
{
   att.global.attributes,
   att.naming.attributes,
   att.typed.attributes,
   att.datable.attributes,
   macro.phraseSeq
}

Appendix A.1.37 <div>

<div> (text division) contains a subdivision of the front, body, or back of a text. [4.1. Divisions of the Body]
Moduletextstructure
Attributes
Member of
Contained by
textstructure: body div
May contain
Example
<body>  <div type="part">   <head>Fallacies of Authority</head>   <p>The subject of which is Authority in various shapes, and the object, to repress all      exercise of the reasoning faculty.</p>   <div n="1type="chapter">    <head>The Nature of Authority</head>    <p>With reference to any proposed measures having for their object the greatest        happiness of the greatest number [...]</p>    <div n="1.1type="section">     <head>Analysis of Authority</head>     <p>What on any given occasion is the legitimate weight or influence to be attached to          authority [...] </p>    </div>    <div n="1.2type="section">     <head>Appeal to Authority, in What Cases Fallacious.</head>     <p>Reference to authority is open to the charge of fallacy when [...] </p>    </div>   </div>  </div> </body>
Schematron
<sch:report test="(ancestor::tei:l or ancestor::tei:lg) and not(ancestor::tei:floatingText)"> Abstract model violation: Lines may not contain higher-level structural elements such as div, unless div is a descendant of floatingText. </sch:report>
Schematron
<sch:report test="(ancestor::tei:p or ancestor::tei:ab) and not(ancestor::tei:floatingText)"> Abstract model violation: p and ab may not contain higher-level structural elements such as div, unless div is a descendant of floatingText. </sch:report>
Content model
<content>
 <sequence>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.divTop"/>
   <classRef key="model.global"/>
  </alternate>
  <sequence minOccurs="0">
   <alternate>
    <sequence minOccurs="1"
     maxOccurs="unbounded">
     <alternate>
      <classRef key="model.divLike"/>
      <classRef key="model.divGenLike"/>
     </alternate>
     <classRef key="model.global"
      minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
    <sequence>
     <sequence minOccurs="1"
      maxOccurs="unbounded">
      <alternate minOccurs="1"
       maxOccurs="1">
       <elementRef key="schemaSpec"/>
       <classRef key="model.common"/>
      </alternate>
      <classRef key="model.global"
       minOccurs="0" maxOccurs="unbounded"/>
     </sequence>
     <sequence minOccurs="0"
      maxOccurs="unbounded">
      <alternate>
       <classRef key="model.divLike"/>
       <classRef key="model.divGenLike"/>
      </alternate>
      <classRef key="model.global"
       minOccurs="0" maxOccurs="unbounded"/>
     </sequence>
    </sequence>
   </alternate>
   <sequence minOccurs="0"
    maxOccurs="unbounded">
    <classRef key="model.divBottom"/>
    <classRef key="model.global"
     minOccurs="0" maxOccurs="unbounded"/>
   </sequence>
  </sequence>
 </sequence>
</content>
    
Schema Declaration
element div
{
   att.global.attributes,
   att.divLike.attributes,
   att.typed.attributes,
   att.declaring.attributes,
   att.written.attributes,
   (
      ( model.divTop | model.global )*,
      (
         (
            (
               ( ( ( model.divLike | model.divGenLike ), model.global* )+ )
             | (
                  ( ( ( schemaSpec | model.common ), model.global* )+ ),
                  ( ( ( model.divLike | model.divGenLike ), model.global* )* )
               )
            ),
            ( ( model.divBottom, model.global* )* )
         )?
      )
   )
}

Appendix A.1.38 <divGen>

<divGen> (automatically generated text division) indicates the location at which a textual division generated automatically by a text-processing application is to appear. [3.9.2. Index Entries]
Modulecore
Attributes
typespecifies what type of generated text division (e.g. index, table of contents, etc.) is to appear.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Sample values include:
index
an index is to be generated and inserted at this point.
toc
a table of contents
figlist
a list of figures
tablist
a list of tables
Note

Valid values are application-dependent; those shown are of obvious utility in document production, but are by no means exhaustive.

Member of
Contained by
textstructure: body div
May contain
core: head
Note

This element is intended primarily for use in document production or manipulation, rather than in the transcription of pre-existing materials; it makes it easier to specify the location of indices, tables of contents, etc., to be generated by text preparation or word processing software.

ExampleOne use for this element is to allow document preparation software to generate an index and insert it in the appropriate place in the output. The example below assumes that the indexName attribute on <index> elements in the text has been used to specify index entries for the two generated indexes, named NAMES and THINGS:
<back>  <div1 type="backmat">   <head>Bibliography</head> <!-- ... -->  </div1>  <div1 type="backmat">   <head>Indices</head>   <divGen n="Index Nominumtype="NAMES"/>   <divGen n="Index Rerumtype="THINGS"/>  </div1> </back>
ExampleAnother use for <divGen> is to specify the location of an automatically produced table of contents:
<front> <!--<titlePage>...</titlePage>-->  <divGen type="toc"/>  <div>   <head>Preface</head>   <p> ... </p>  </div> </front>
Content model
<content>
 <classRef key="model.headLike"
  minOccurs="0" maxOccurs="unbounded"/>
</content>
    
Schema Declaration
element divGen
{
   att.global.attributes,
   att.typed.attribute.subtype,
   attribute type { text }?,
   model.headLike*
}

Appendix A.1.39 <docAuthor>

<docAuthor> (document author) contains the name of the author of the document, as given on the title page (often but not always contained in a byline). [4.6. Title Pages]
Moduletextstructure
Attributes
Member of
Contained by
core: lg list
figures: table
msdescription: msItem
textstructure: body div
May contain
Note

The document author's name often occurs within a byline, but the <docAuthor> element may be used whether the <byline> element is used or not. It should be used only for the author(s) of the entire document, not for author(s) of any subset or part of it. (Attributions of authorship of a subset or part of the document, for example of a chapter in a textbook or an article in a newspaper, may be encoded with <byline> without <docAuthor>.)

Example
<titlePage>  <docTitle>   <titlePart>Travels into Several Remote Nations of the World, in Four      Parts.</titlePart>  </docTitle>  <byline> By <docAuthor>Lemuel Gulliver</docAuthor>, First a Surgeon,    and then a Captain of several Ships</byline> </titlePage>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element docAuthor
{
   att.global.attributes,
   att.canonical.attributes,
   macro.phraseSeq
}

Appendix A.1.40 <docDate>

<docDate> (document date) contains the date of a document, as given on a title page or in a dateline. [4.6. Title Pages]
Moduletextstructure
Attributes
when(when) gives the value of the date in standard form, i.e. YYYY-MM-DD.
StatusOptional
Datatypeteidata.temporal.w3c
Note

For simple dates, the when attribute should give the Gregorian or proleptic Gregorian date in one of the formats specified in XML Schema Part 2: Datatypes Second Edition.

Member of
Contained by
core: lg list
figures: table
msdescription: msItem
textstructure: body dateline div
May contain
Note

Cf. the general <date> element in the core tag set. This specialized element is provided for convenience in marking and processing the date of the documents, since it is likely to require specialized handling for many applications. It should be used only for the date of the entire document, not for any subset or part of it.

Example
<docImprint>Oxford, Clarendon Press, <docDate>1987</docDate> </docImprint>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element docDate
{
   att.global.attributes,
   attribute when { text }?,
   macro.phraseSeq
}

Appendix A.1.41 <emph>

<emph> (emphasized) marks words or phrases which are stressed or emphasized for linguistic or rhetorical effect. [3.3.2.2. Emphatic Words and Phrases 3.3.2. Emphasis, Foreign Words, and Unusual Language]
Modulecore
Attributes
Member of
Contained by
May contain
Example
You took the car and did <emph>what</emph>?!!
Example
<q>What it all comes to is this,</q> he said. <q>  <emph>What    does Christopher Robin do in the morning nowadays?</emph> </q>
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element emph { att.global.attributes, macro.paraContent }

Appendix A.1.42 <encodingDesc>

<encodingDesc> (encoding description) documents the relationship between an electronic text and the source or sources from which it was derived. [2.3. The Encoding Description 2.1.1. The TEI Header and Its Components]
Moduleheader
Attributes
Contained by
header: teiHeader
May contain
core: p
gaiji: charDecl
header: samplingDecl
linking: ab
Example
<encodingDesc>  <p>Basic encoding, capturing lexical information only. All    hyphenation, punctuation, and variant spellings normalized. No    formatting or layout information preserved.</p> </encodingDesc>
Content model
<content>
 <alternate minOccurs="1"
  maxOccurs="unbounded">
  <classRef key="model.encodingDescPart"/>
  <classRef key="model.pLike"/>
 </alternate>
</content>
    
Schema Declaration
element encodingDesc
{
   att.global.attributes,
   ( model.encodingDescPart | model.pLike )+
}

Appendix A.1.43 <equipment>

<equipment> (equipment) provides technical details of the equipment and media used for an audio or video recording used as the source for a spoken text. [8.2. Documenting the Source of Transcribed Speech 15.3.2. Declarable Elements]
Modulespoken
Attributes
Contained by
spoken: recording
May contain
core: p
linking: ab
Example
<equipment>  <p>"Hi-8" 8 mm NTSC camcorder with integral directional    microphone and windshield and stereo digital sound    recording channel.  </p> </equipment>
Example
<equipment>  <p>8-track analogue transfer mixed down to 19 cm/sec audio    tape for cassette mastering</p> </equipment>
Content model
<content>
 <classRef key="model.pLike" minOccurs="1"
  maxOccurs="unbounded"/>
</content>
    
Schema Declaration
element equipment
{
   att.global.attributes,
   att.declarable.attributes,
   model.pLike+
}

Appendix A.1.44 <event>

<event> (event) contains data relating to any kind of significant event associated with a person, place, or organization. [13.3.1. Basic Principles]
Modulenamesdates
Attributes
Member of
Contained by
May contain
header: idno
linking: ab
msdescription: msDesc
namesdates: event
Example
<person>  <event type="matwhen="1972-10-12">   <label>matriculation</label>  </event>  <event type="gradwhen="1975-06-23">   <label>graduation</label>  </event> </person>
Content model
<content>
 <sequence>
  <elementRef key="idno" minOccurs="0"
   maxOccurs="unbounded"/>
  <classRef key="model.headLike"
   minOccurs="0" maxOccurs="unbounded"/>
  <alternate>
   <classRef key="model.pLike"
    minOccurs="1" maxOccurs="unbounded"/>
   <classRef key="model.labelLike"
    minOccurs="1" maxOccurs="unbounded"/>
  </alternate>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.noteLike"/>
   <classRef key="model.biblLike"/>
   <elementRef key="linkGrp"/>
   <elementRef key="link"/>
   <elementRef key="idno"/>
   <elementRef key="ptr"/>
  </alternate>
  <elementRef key="event" minOccurs="0"
   maxOccurs="unbounded"/>
 </sequence>
</content>
    
Schema Declaration
element event
{
   att.global.attributes,
   att.datable.attributes,
   att.editLike.attributes,
   att.typed.attributes,
   att.naming.attributes,
   att.sortable.attributes,
   att.locatable.attributes,
   (
      idno*,
      model.headLike*,
      ( model.pLike+ | model.labelLike+ ),
      ( model.noteLike | model.biblLike | linkGrp | link | idno | ptr )*,
      event*
   )
}

Appendix A.1.45 <expan>

<expan> (expansion) contains the expansion of an abbreviation. [3.6.5. Abbreviations and Their Expansions]
Modulecore
Attributes
Member of
Contained by
May contain
Note

The content of this element should be the expanded abbreviation, usually (but not always) a complete word or phrase. The <ex> element provided by the transcr module may be used to mark up sequences of letters supplied within such an expansion.

If abbreviations are expanded silently, this practice should be documented in the <editorialDecl>, either with a <normalization> element or a <p>.

Example
The address is Southmoor <choice>  <expan>Road</expan>  <abbr>Rd</abbr> </choice>
Example
<choice xml:lang="la">  <abbr>Imp</abbr>  <expan>Imp<ex>erator</ex>  </expan> </choice>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element expan
{
   att.global.attributes,
   att.editLike.attributes,
   macro.phraseSeq
}

Appendix A.1.46 <facsimile>

<facsimile> contains a representation of some written source in the form of a set of images rather than as transcribed or encoded text. [11.1. Digital Facsimiles]
Moduletranscr
Attributes
Member of
Contained by
textstructure: TEI
May contain
transcr: surface
Example
<facsimile>  <graphic url="page1.png"/>  <surface>   <graphic url="page2-highRes.png"/>   <graphic url="page2-lowRes.png"/>  </surface>  <graphic url="page3.png"/>  <graphic url="page4.png"/> </facsimile>
Example
<facsimile>  <surface ulx="0uly="0lrx="200lry="300">   <graphic url="Bovelles-49r.png"/>  </surface> </facsimile>
Schematron
<sch:rule context="tei:facsimile//tei:line | tei:facsimile//tei:zone"> <sch:report test="child::text()[ normalize-space(.) ne '']"> A facsimile element represents a text with images, thus transcribed text should not be present within it. </sch:report> </sch:rule>
Content model
<content>
 <sequence>
  <elementRef key="front" minOccurs="0"/>
  <alternate minOccurs="1"
   maxOccurs="unbounded">
   <classRef key="model.graphicLike"/>
   <elementRef key="surface"/>
   <elementRef key="surfaceGrp"/>
  </alternate>
  <elementRef key="back" minOccurs="0"/>
 </sequence>
</content>
    
Schema Declaration
element facsimile
{
   att.global.attributes,
   att.declaring.attributes,
   ( front?, ( model.graphicLike | surface | surfaceGrp )+, back? )
}

Appendix A.1.47 <fileDesc>

<fileDesc> (file description) contains a full bibliographic description of an electronic file. [2.2. The File Description 2.1.1. The TEI Header and Its Components]
Moduleheader
Attributes
Contained by
header: teiHeader
May contain
Note

The major source of information for those seeking to create a catalogue entry or bibliographic citation for an electronic file. As such, it provides a title and statements of responsibility together with details of the publication or distribution of the file, of any series to which it belongs, and detailed bibliographic notes for matters not addressed elsewhere in the header. It also contains a full bibliographic description for the source or sources from which the electronic text was derived.

Example
<fileDesc>  <titleStmt>   <title>The shortest possible TEI document</title>  </titleStmt>  <publicationStmt>   <p>Distributed as part of TEI P5</p>  </publicationStmt>  <sourceDesc>   <p>No print source exists: this is an original digital text</p>  </sourceDesc> </fileDesc>
Content model
<content>
 <sequence>
  <sequence>
   <elementRef key="titleStmt"/>
   <elementRef key="editionStmt"
    minOccurs="0"/>
   <elementRef key="extent" minOccurs="0"/>
   <elementRef key="publicationStmt"/>
   <elementRef key="seriesStmt"
    minOccurs="0" maxOccurs="unbounded"/>
   <elementRef key="notesStmt"
    minOccurs="0"/>
  </sequence>
  <elementRef key="sourceDesc"
   minOccurs="1" maxOccurs="unbounded"/>
 </sequence>
</content>
    
Schema Declaration
element fileDesc
{
   att.global.attributes,
   (
      (
         titleStmt,
         editionStmt?,
         extent?,
         publicationStmt,
         seriesStmt*,
         notesStmt?
      ),
      sourceDesc+
   )
}

Appendix A.1.48 <foreign>

<foreign> (foreign) identifies a word or phrase as belonging to some language other than that of the surrounding text. [3.3.2.1. Foreign Words or Expressions]
Modulecore
Attributes
Member of
Contained by
May contain
Note

The global xml:lang attribute should be supplied for this element to identify the language of the word or phrase marked. As elsewhere, its value should be a language tag as defined in 6.1. Language Identification.

This element is intended for use only where no other element is available to mark the phrase or words concerned. The global xml:lang attribute should be used in preference to this element where it is intended to mark the language of the whole of some text element.

The <distinct> element may be used to identify phrases belonging to sublanguages or registers not generally regarded as true languages.

Example
This is heathen Greek to you still? Your <foreign xml:lang="la">lapis philosophicus</foreign>?
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element foreign { att.global.attributes, macro.phraseSeq }

Appendix A.1.49 <forename>

<forename> (forename) contains a forename, given or baptismal name. [13.2.1. Personal Names]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Example
<persName>  <roleName>Ex-President</roleName>  <forename>George</forename>  <surname>Bush</surname> </persName>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element forename
{
   att.global.attributes,
   att.personal.attributes,
   att.typed.attributes,
   macro.phraseSeq
}

Appendix A.1.50 <g>

<g> (character or glyph) represents a glyph, or a non-standard character. [5. Characters, Glyphs, and Writing Modes]
Modulegaiji
Attributes
refpoints to a description of the character or glyph intended.
StatusOptional
Datatypeteidata.pointer
Member of
Contained by
May containCharacter data only
Note

The name g is short for gaiji, which is the Japanese term for a non-standardized character or glyph.

Example
<g ref="#ctlig">ct</g>
This example points to a <glyph> element with the identifier ctlig like the following:
<glyph xml:id="ctlig"> <!-- here we describe the particular ct-ligature intended --> </glyph>
Example
<g ref="#per-glyph">per</g>
The medieval brevigraph per could similarly be considered as an individual glyph, defined in a <glyph> element with the identifier per-glyph as follows:
<glyph xml:id="per-glyph"> <!-- ... --> </glyph>
Content model
<content>
 <textNode/>
</content>
    
Schema Declaration
element g
{
   att.global.attributes,
   att.typed.attributes,
   attribute ref { text }?,
   text
}

Appendix A.1.51 <gap>

<gap> (gap) indicates a point where material has been omitted in a transcription, whether for editorial reasons described in the TEI header, as part of sampling practice, or because the material is illegible, invisible, or inaudible. [3.5.3. Additions, Deletions, and Omissions]
Modulecore
Attributes
ana(Restrictions on material of a sensitive nature.) This attribute flags records in our database that may contain sensitive, personal or defamatory information. These classes of ana identify the type and severity of the restriction applied.
StatusOptional
Datatype1–∞ occurrences of  separated by whitespace
Legal values are:
sens:illness
(Illness label - Severity 4.) Details or graphic images of serious illness (mental or physical) or mortality of identifiable individual(s).
sens:youth
(Youth label - Severity 3.) Details of serious anti-social activity or illness of youth under age of 18.
sens:implicate
(Implicate label - Severity 2.) Defaming or implicating identifiable individual(s) who were not part of document creation.
sens:criminal
(Criminal label - Severity 2.) Details of potentially serious or violent criminal activity, especially violence.
sens:stereotype
(Stereotype label - Severity 1.) Egregious stereotyping (positive or negative) of a culture, group or person (beyond outdated language), especially vulnerable individual(s)/group(s).
sens:cultural
(Cultural label - Severity 1.) Could be considered private by community for cultural reasons.
sens:dishonour
(Dishonour label - Severity 1.) Could cause undue or disproportionate dishonour / embarrassment to self or family.
sens:details
(Details label - Severity 4.) Current personal identifying details (such as contact info).
reason(reason) gives the reason for omission
StatusOptional
Datatype1–∞ occurrences of teidata.enumerated separated by whitespace
Suggested values include:
cancelled
(cancelled)
deleted
(deleted)
editorial
(editorial) for features omitted from transcription due to editorial policy
illegible
(illegible)
inaudible
(inaudible)
irrelevant
(irrelevant)
sampling
(sampling)
agent(agent) in the case of text omitted because of damage, categorizes the cause of the damage, if it can be identified.
StatusOptional
Datatypeteidata.enumerated
Sample values include:
rubbing
(rubbing) damage results from rubbing of the leaf edges
mildew
(mildew) damage results from mildew on the leaf surface
smoke
(smoke) damage results from smoke
Member of
Contained by
May contain
core: desc
Note

The <gap>, <unclear>, and <del> core tag elements may be closely allied in use with the <damage> and <supplied> elements, available when using the additional tagset for transcription of primary sources. See section 11.3.3.2. Use of the gap, del, damage, unclear, and supplied Elements in Combination for discussion of which element is appropriate for which circumstance.

The <gap> tag simply signals the editors decision to omit or inability to transcribe a span of text. Other information, such as the interpretation that text was deliberately erased or covered, should be indicated using the relevant tags, such as <del> in the case of deliberate deletion.

Example
<gap quantity="4unit="chars"  reason="illegible"/>
Example
<gap quantity="1unit="essay"  reason="sampling"/>
Example
<del>  <gap atLeast="4atMost="8unit="chars"   reason="illegible"/> </del>
Example
<gap extent="several linesreason="lost"/>
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <classRef key="model.descLike"/>
  <classRef key="model.certLike"/>
 </alternate>
</content>
    
Schema Declaration
element gap
{
   att.global.attribute.xmlid,
   att.global.attribute.n,
   att.global.attribute.xmllang,
   att.global.attribute.xmlbase,
   att.global.attribute.xmlspace,
   att.global.rendition.attribute.rend,
   att.global.rendition.attribute.style,
   att.global.rendition.attribute.rendition,
   att.global.linking.attribute.corresp,
   att.global.linking.attribute.synch,
   att.global.linking.attribute.sameAs,
   att.global.linking.attribute.copyOf,
   att.global.linking.attribute.next,
   att.global.linking.attribute.prev,
   att.global.linking.attribute.exclude,
   att.global.linking.attribute.select,
   att.global.facs.attribute.facs,
   att.global.change.attribute.change,
   att.global.responsibility.attribute.cert,
   att.global.responsibility.attribute.resp,
   att.global.source.attribute.source,
   att.timed.attributes,
   att.editLike.attributes,
   att.dimensions.attributes,
   attribute ana
   {
      list
      {
         (
            "sens:illness"
          | "sens:youth"
          | "sens:implicate"
          | "sens:criminal"
          | "sens:stereotype"
          | "sens:cultural"
          | "sens:dishonour"
          | "sens:details"
         )+
      }
   }?,
   attribute reason
   {
      list
      {
         (
            "cancelled"
          | "deleted"
          | "editorial"
          | "illegible"
          | "inaudible"
          | "irrelevant"
          | "sampling"
         )+
      }
   }?,
   attribute agent { text }?,
   ( model.descLike | model.certLike )*
}

Appendix A.1.52 <geo>

<geo> (geographical coordinates) contains any expression of a set of geographic coordinates, representing a point, line, or area on the surface of the earth in some notation. [13.3.4.1. Varieties of Location]
Modulenamesdates
Attributes
Member of
Contained by
May containCharacter data only
Note

Uses of <geo> can be associated with a coordinate system, defined by a <geoDecl> element supplied in the TEI header, using the decls attribute. If no such link is made, the assumption is that the content of each <geo> element will be a pair of numbers separated by whitespace, to be interpreted as latitude followed by longitude according to the World Geodetic System.

Example
<geoDecl xml:id="WGSdatum="WGS84">World Geodetic System</geoDecl> <geoDecl xml:id="OSdatum="OSGB36">Ordnance Survey</geoDecl> <!-- ... --> <location>  <desc>A tombstone plus six lines of    Anglo-Saxon text, built into the west tower (on the south side    of the archway, at 8 ft. above the ground) of the    Church of St. Mary-le-Wigford in Lincoln.</desc>  <geo decls="#WGS">53.226658 -0.541254</geo>  <geo decls="#OS">SK 97481 70947</geo> </location>
Example
<geo>41.687142 -74.870109</geo>
Content model
<content>
 <textNode/>
</content>
    
Schema Declaration
element geo { att.global.attributes, att.declaring.attributes, text }

Appendix A.1.53 <gi>

<gi> (element name) contains the name (generic identifier) of an element. [22. Documentation Elements 22.5. Element Specifications]
Moduletagdocs
Attributes
schemesupplies the name of the scheme in which this name is defined.
StatusOptional
Datatypeteidata.enumerated
Sample values include:
TEI
this element is part of the TEI scheme.[Default]
DBK
(docbook) this element is part of the Docbook scheme.
XX
(unknown) this element is part of an unknown scheme.
Schematron
this element is from Schematron.
HTML
this element is from the HTML scheme.
Member of
Contained by
May contain
XSD Name
Example
<p>The <gi>xhtml:li</gi> element is roughly analogous to the <gi>item</gi> element, as is the <gi scheme="DBK">listItem</gi> element.</p>
This example shows the use of both a namespace prefix and the scheme attribute as alternative ways of indicating that the <gi> in question is not a TEI element name: in practice only one method should be adopted.
Content model
<content>
 <dataRef key="teidata.name"/>
</content>
    
Schema Declaration
element gi { att.global.attributes, attribute scheme { text }?, teidata.name }

Appendix A.1.54 <glyph>

<glyph> (character glyph) provides descriptive information about a character glyph. [5.2. Markup Constructs for Representation of Characters and Glyphs]
Modulegaiji
Attributes
Contained by
gaiji: charDecl
May contain
Example
<glyph xml:id="rstroke">  <localProp name="Name"   value="LATIN SMALL LETTER R WITH A FUNNY STROKE"/>  <localProp name="entityvalue="rstroke"/>  <figure>   <graphic url="glyph-rstroke.png"/>  </figure> </glyph>
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <elementRef key="unicodeProp"/>
  <elementRef key="unihanProp"/>
  <elementRef key="localProp"/>
  <elementRef key="mapping"/>
  <elementRef key="figure"/>
  <classRef key="model.graphicLike"/>
  <classRef key="model.noteLike"/>
  <classRef key="model.descLike"/>
 </alternate>
</content>
    
Schema Declaration
element glyph
{
   att.global.attributes,
   (
      unicodeProp
    | unihanProp
    | localProp
    | mapping
    | figure
    | model.graphicLikemodel.noteLikemodel.descLike
   )*
}

Appendix A.1.55 <graphic>

<graphic> (graphic) indicates the location of a graphic or illustration, either forming part of a text, or providing an image of it. [3.10. Graphics and Other Non-textual Components 11.1. Digital Facsimiles]
Modulecore
Attributes
Member of
Contained by
May contain
core: desc
Note

The mimeType attribute should be used to supply the MIME media type of the image specified by the url attribute.

Within the body of a text, a <graphic> element indicates the presence of a graphic component in the source itself. Within the context of a <facsimile> or <sourceDoc> element, however, a <graphic> element provides an additional digital representation of some part of the source being encoded.

Example
<figure>  <graphic url="fig1.png"/>  <head>Figure One: The View from the Bridge</head>  <figDesc>A Whistleresque view showing four or five sailing boats in the foreground, and a    series of buoys strung out between them.</figDesc> </figure>
Example
<facsimile>  <surfaceGrp n="leaf1">   <surface>    <graphic url="page1.png"/>   </surface>   <surface>    <graphic url="page2-highRes.png"/>    <graphic url="page2-lowRes.png"/>   </surface>  </surfaceGrp> </facsimile>
Example
<facsimile>  <surfaceGrp n="leaf1xml:id="spi001">   <surface xml:id="spi001r">    <graphic type="normal"     subtype="thumbnailurl="spi/thumb/001r.jpg"/>    <graphic type="normalsubtype="low-res"     url="spi/normal/lowRes/001r.jpg"/>    <graphic type="normal"     subtype="high-resurl="spi/normal/highRes/001r.jpg"/>    <graphic type="high-contrast"     subtype="low-resurl="spi/contrast/lowRes/001r.jpg"/>    <graphic type="high-contrast"     subtype="high-resurl="spi/contrast/highRes/001r.jpg"/>   </surface>   <surface xml:id="spi001v">    <graphic type="normal"     subtype="thumbnailurl="spi/thumb/001v.jpg"/>    <graphic type="normalsubtype="low-res"     url="spi/normal/lowRes/001v.jpg"/>    <graphic type="normal"     subtype="high-resurl="spi/normal/highRes/001v.jpg"/>    <graphic type="high-contrast"     subtype="low-resurl="spi/contrast/lowRes/001v.jpg"/>    <graphic type="high-contrast"     subtype="high-resurl="spi/contrast/highRes/001v.jpg"/>    <zone xml:id="spi001v_detail01">     <graphic type="normal"      subtype="thumbnailurl="spi/thumb/001v-detail01.jpg"/>     <graphic type="normal"      subtype="low-res"      url="spi/normal/lowRes/001v-detail01.jpg"/>     <graphic type="normal"      subtype="high-res"      url="spi/normal/highRes/001v-detail01.jpg"/>     <graphic type="high-contrast"      subtype="low-res"      url="spi/contrast/lowRes/001v-detail01.jpg"/>     <graphic type="high-contrast"      subtype="high-res"      url="spi/contrast/highRes/001v-detail01.jpg"/>    </zone>   </surface>  </surfaceGrp> </facsimile>
Content model
<content>
 <classRef key="model.descLike"
  minOccurs="0" maxOccurs="unbounded"/>
</content>
    
Schema Declaration
element graphic
{
   att.global.attributes,
   att.media.attributes,
   att.resourced.attributes,
   att.declaring.attributes,
   att.typed.attributes,
   model.descLike*
}

Appendix A.1.56 <head>

<head> (heading) contains any type of heading, for example the title of a section, or the heading of a list, glossary, manuscript description, etc. [4.2.1. Headings and Trailers]
Modulecore
Attributes
Member of
Contained by
May contain
Note

The <head> element is used for headings at all levels; software which treats (e.g.) chapter headings, section headings, and list titles differently must determine the proper processing of a <head> element based on its structural position. A <head> occurring as the first element of a list is the title of that list; one occurring as the first element of a <div1> is the title of that chapter or section.

ExampleThe most common use for the <head> element is to mark the headings of sections. In older writings, the headings or incipits may be rather longer than usual in modern works. If a section has an explicit ending as well as a heading, it should be marked as a <trailer>, as in this example:
<div1 n="Itype="book">  <head>In the name of Christ here begins the first book of the ecclesiastical history of    Georgius Florentinus, known as Gregory, Bishop of Tours.</head>  <div2 type="section">   <head>In the name of Christ here begins Book I of the history.</head>   <p>Proposing as I do ...</p>   <p>From the Passion of our Lord until the death of Saint Martin four hundred and twelve      years passed.</p>   <trailer>Here ends the first Book, which covers five thousand, five hundred and ninety-six      years from the beginning of the world down to the death of Saint Martin.</trailer>  </div2> </div1>
ExampleWhen headings are not inline with the running text (see e.g. the heading "Secunda conclusio") they might however be encoded as if. The actual placement in the source document can be captured with the place attribute.
<div type="subsection">  <head place="margin">Secunda conclusio</head>  <p>   <lb n="1251"/>   <hi rend="large">Potencia: habitus: et actus: recipiunt speciem ab obiectis<supplied>.</supplied>   </hi>   <lb n="1252"/>Probatur sic. Omne importans necessariam habitudinem ad proprium    [...]  </p> </div>
ExampleThe <head> element is also used to mark headings of other units, such as lists:
With a few exceptions, connectives are equally useful in all kinds of discourse: description, narration, exposition, argument. <list rend="bulleted">  <head>Connectives</head>  <item>above</item>  <item>accordingly</item>  <item>across from</item>  <item>adjacent to</item>  <item>again</item>  <item> <!-- ... -->  </item> </list>
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <elementRef key="lg"/>
  <classRef key="model.gLike"/>
  <classRef key="model.phrase"/>
  <classRef key="model.inter"/>
  <classRef key="model.lLike"/>
  <classRef key="model.global"/>
 </alternate>
</content>
    
Schema Declaration
element head
{
   att.global.attributes,
   att.typed.attributes,
   att.placement.attributes,
   att.written.attributes,
   (
      text
    | lgmodel.gLikemodel.phrasemodel.intermodel.lLikemodel.global
   )*
}

Appendix A.1.57 <history>

<history> (history) groups elements describing the full history of a manuscript, manuscript part, or other object. [10.8. History]
Modulemsdescription
Attributes
Contained by
msdescription: msDesc
namesdates: object
May contain
core: p
linking: ab
msdescription: acquisition origin summary
Example
<history>  <origin>   <p>Written in Durham during the mid twelfth      century.</p>  </origin>  <provenance>   <p>Recorded in two medieval      catalogues of the books belonging to Durham Priory, made in 1391 and      1405.</p>  </provenance>  <provenance>   <p>Given to W. Olleyf by William Ebchester, Prior (1446-56)      and later belonged to Henry Dalton, Prior of Holy Island (Lindisfarne)      according to inscriptions on ff. 4v and 5.</p>  </provenance>  <acquisition>   <p>Presented to Trinity College in 1738 by      Thomas Gale and his son Roger.</p>  </acquisition> </history>
Content model
<content>
 <alternate>
  <classRef key="model.pLike" minOccurs="1"
   maxOccurs="unbounded"/>
  <sequence>
   <elementRef key="summary" minOccurs="0"/>
   <elementRef key="origin" minOccurs="0"/>
   <elementRef key="provenance"
    minOccurs="0" maxOccurs="unbounded"/>
   <elementRef key="acquisition"
    minOccurs="0"/>
  </sequence>
 </alternate>
</content>
    
Schema Declaration
element history
{
   att.global.attributes,
   ( model.pLike+ | ( summary?, origin?, provenance*, acquisition? ) )
}

Appendix A.1.58 <idno>

<idno> (identifier) supplies any form of identifier used to identify some object, such as a bibliographic item, a person, a title, an organization, etc. in a standardized way. [13.3.1. Basic Principles 2.2.4. Publication, Distribution, Licensing, etc. 2.2.5. The Series Statement 3.12.2.4. Imprint, Size of a Document, and Reprint Information]
Moduleheader
Attributes
typecategorizes the identifier, for example as an ISBN, Social Security number, etc.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Legal values are:
accession
(The accession identifier of an object or resource in an archive.)
custodian
(The identifying number for a Japanese Canadian used by the Custodian of Enemy Property.)
custodian2
(A SECOND identifying number for a Japanese Canadian used by the Custodian of Enemy Property; a small number of cases end up with two numbers.)
URI
(A URI serving as a unique identifier in some way.)
URL
(The full URL of a site which serves as the public identity of an entity or project (such as the Landscapes of Injustice site URL).)
personId
(A personal identifying number, typically a registration id for a Japanese Canadian.)
propertyId
(An identifier relating to property used in correspondence with the Custodian of Enemy Property.)
LOI
(The original LOI xml:id of a person whose xml:id in the Monument project is different for some reason.)
Member of
Contained by
May contain
gaiji: g
header: idno
character data
Note

<idno> should be used for labels which identify an object or concept in a formal cataloguing system such as a database or an RDF store, or in a distributed system such as the World Wide Web. Some suggested values for type on <idno> are ISBN, ISSN, DOI, and URI.

Example
<idno type="ISBN">978-1-906964-22-1</idno> <idno type="ISSN">0143-3385</idno> <idno type="DOI">10.1000/123</idno> <idno type="URI">http://www.worldcat.org/oclc/185922478</idno> <idno type="URI">http://authority.nzetc.org/463/</idno> <idno type="LT">Thomason Tract E.537(17)</idno> <idno type="Wing">C695</idno> <idno type="oldCat">  <g ref="#sym"/>345 </idno>
In the last case, the identifier includes a non-Unicode character which is defined elsewhere by means of a <glyph> or <char> element referenced here as #sym.
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.gLike"/>
  <elementRef key="idno"/>
 </alternate>
</content>
    
Schema Declaration
element idno
{
   att.global.attributes,
   att.sortable.attributes,
   att.datable.attributes,
   att.typed.attribute.subtype,
   attribute type
   {
      "accession"
    | "custodian"
    | "custodian2"
    | "URI"
    | "URL"
    | "personId"
    | "propertyId"
    | "LOI"
   }?,
   ( text | model.gLike | idno )*
}

Appendix A.1.59 <incident>

<incident> (A non-verbal moment in the interview.) Incident is used by LOI Oral History team to indicate any non-verbal moment of significance in the interview such as an interuption, a pause, or a laugh. It replaces more specific element use such as kinesic and vocal. [8.3.3. Vocal, Kinesic, Incident]
Modulespoken
Attributes
Member of
Contained by
May contain
core: desc
Example
<incident>  <desc>ceiling collapses</desc> </incident>
Content model
<content>
 <classRef key="model.descLike"
  minOccurs="0" maxOccurs="unbounded"/>
</content>
    
Schema Declaration
element incident
{
   att.global.attributes,
   att.timed.attributes,
   att.typed.attributes,
   att.ascribed.attributes,
   model.descLike*
}

Appendix A.1.60 <item>

<item> (item) contains one component of a list. [3.8. Lists 2.6. The Revision Description]
Modulecore
Attributes
ana(Restrictions on material of a sensitive nature.) This attribute flags records in our database that may contain sensitive, personal or defamatory information. These classes of ana identify the type and severity of the restriction applied.
StatusOptional
Datatype1–∞ occurrences of  separated by whitespace
Legal values are:
sens:illness
(Details or graphic images of serious illness (mental or physical) or mortality of identifiable individual(s).) Illness label
sens:youth
(Details of serious anti-social activity or illness of youth under age of 18.) Youth label
sens:implicate
(Defaming or implicating identifiable individual(s) who were not part of document creation.) Implicate label
sens:criminal
(Details of potentially serious or violent criminal activity, especially violence.) Criminal label
sens:stereotype
(Egregious stereotyping (positive or negative) of a culture, group or person (beyond outdated language), especially vulnerable individual(s)/group(s).) Stereotype label
sens:cultural
(Could be considered private by community for cultural reasons.) Cultural label
sens:dishonour
(Could cause undue or disproportionate dishonour / embarrassment to self or family.) Dishonour label
sens:details
(Current personal identifying details (such as contact info).) Details label
Contained by
core: list
May contain
Note

May contain simple prose or a sequence of chunks.

Whatever string of characters is used to label a list item in the copy text may be used as the value of the global n attribute, but it is not required that numbering be recorded explicitly. In ordered lists, the n attribute on the <item> element is by definition synonymous with the use of the <label> element to record the enumerator of the list item. In glossary lists, however, the term being defined should be given with the <label> element, not n.

Example
<list rend="numbered">  <head>Here begin the chapter headings of Book IV</head>  <item n="4.1">The death of Queen Clotild.</item>  <item n="4.2">How King Lothar wanted to appropriate one third of the Church revenues.</item>  <item n="4.3">The wives and children of Lothar.</item>  <item n="4.4">The Counts of the Bretons.</item>  <item n="4.5">Saint Gall the Bishop.</item>  <item n="4.6">The priest Cato.</item>  <item> ...</item> </list>
Content model
<content>
 <macroRef key="macro.specialPara"/>
</content>
    
Schema Declaration
element item
{
   att.global.attribute.xmlid,
   att.global.attribute.n,
   att.global.attribute.xmllang,
   att.global.attribute.xmlbase,
   att.global.attribute.xmlspace,
   att.global.rendition.attribute.rend,
   att.global.rendition.attribute.style,
   att.global.rendition.attribute.rendition,
   att.global.linking.attribute.corresp,
   att.global.linking.attribute.synch,
   att.global.linking.attribute.sameAs,
   att.global.linking.attribute.copyOf,
   att.global.linking.attribute.next,
   att.global.linking.attribute.prev,
   att.global.linking.attribute.exclude,
   att.global.linking.attribute.select,
   att.global.facs.attribute.facs,
   att.global.change.attribute.change,
   att.global.responsibility.attribute.cert,
   att.global.responsibility.attribute.resp,
   att.global.source.attribute.source,
   att.sortable.attributes,
   attribute ana
   {
      list
      {
         (
            "sens:illness"
          | "sens:youth"
          | "sens:implicate"
          | "sens:criminal"
          | "sens:stereotype"
          | "sens:cultural"
          | "sens:dishonour"
          | "sens:details"
         )+
      }
   }?,
   macro.specialPara
}

Appendix A.1.61 <keywords>

<keywords> (keywords) contains a list of keywords or phrases identifying the topic or nature of a text. [2.4.3. The Text Classification]
Moduleheader
Attributes
schemeidentifies the controlled vocabulary within which the set of keywords concerned is defined, for example by a <taxonomy> element, or by some other resource.
StatusOptional
Datatypeteidata.pointer
Contained by
header: textClass
May contain
core: list
Note

Each individual keyword (including compound subject headings) should be supplied as a <term> element directly within the <keywords> element. An alternative usage, in which each <term> appears within an <item> inside a <list> is permitted for backwards compatibility, but is deprecated.

If no control list exists for the keywords used, then no value should be supplied for the scheme attribute.

Example
<keywords scheme="http://classificationweb.net">  <term>Babbage, Charles</term>  <term>Mathematicians - Great Britain - Biography</term> </keywords>
Example
<keywords>  <term>Fermented beverages</term>  <term>Central Andes</term>  <term>Schinus molle</term>  <term>Molle beer</term>  <term>Indigenous peoples</term>  <term>Ethnography</term>  <term>Archaeology</term> </keywords>
Content model
<content>
 <alternate>
  <elementRef key="term" minOccurs="1"
   maxOccurs="unbounded"/>
  <elementRef key="list"/>
 </alternate>
</content>
    
Schema Declaration
element keywords
{
   att.global.attributes,
   attribute scheme { text }?,
   ( term+ | list )
}

Appendix A.1.62 <l>

<l> (verse line) contains a single, possibly incomplete, line of verse. [3.13.1. Core Tags for Verse 3.13. Passages of Verse or Drama 7.2.5. Speech Contents]
Modulecore
Attributes
Member of
Contained by
figures: cell
header: change licence
linking: ab seg
msdescription: acquisition origin summary
namesdates: occupation
spoken: u
textstructure: argument body div salute signed
transcr: supplied
May contain
Example
<l met="x/x/x/x/x/real="/xx/x/x/x/">Shall I compare thee to a summer's day?</l>
Schematron
<sch:report test="ancestor::tei:l[not(.//tei:note//tei:l[. = current()])]"> Abstract model violation: Lines may not contain lines or lg elements. </sch:report>
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.gLike"/>
  <classRef key="model.phrase"/>
  <classRef key="model.inter"/>
  <classRef key="model.global"/>
 </alternate>
</content>
    
Schema Declaration
element l
{
   att.global.attributes,
   att.fragmentable.attributes,
   ( text | model.gLike | model.phrase | model.inter | model.global )*
}

Appendix A.1.63 <label>

<label> (label) contains any label or heading used to identify part of a text, typically but not exclusively in a list or glossary. [3.8. Lists]
Modulecore
Attributes
Member of
Contained by
May contain
ExampleLabels are commonly used for the headwords in glossary lists; note the use of the global xml:lang attribute to set the default language of the glossary list to Middle English, and identify the glosses and headings as modern English or Latin:
<list type="glossxml:lang="enm">  <head xml:lang="en">Vocabulary</head>  <headLabel xml:lang="en">Middle English</headLabel>  <headItem xml:lang="en">New English</headItem>  <label>nu</label>  <item xml:lang="en">now</item>  <label>lhude</label>  <item xml:lang="en">loudly</item>  <label>bloweth</label>  <item xml:lang="en">blooms</item>  <label>med</label>  <item xml:lang="en">meadow</item>  <label>wude</label>  <item xml:lang="en">wood</item>  <label>awe</label>  <item xml:lang="en">ewe</item>  <label>lhouth</label>  <item xml:lang="en">lows</item>  <label>sterteth</label>  <item xml:lang="en">bounds, frisks (cf. <cit>    <ref>Chaucer, K.T.644</ref>    <quote>a courser, <term>sterting</term>as the fyr</quote>   </cit>  </item>  <label>verteth</label>  <item xml:lang="la">pedit</item>  <label>murie</label>  <item xml:lang="en">merrily</item>  <label>swik</label>  <item xml:lang="en">cease</item>  <label>naver</label>  <item xml:lang="en">never</item> </list>
ExampleLabels may also be used to record explicitly the numbers or letters which mark list items in ordered lists, as in this extract from Gibbon's Autobiography. In this usage the <label> element is synonymous with the n attribute on the <item> element:
I will add two facts, which have seldom occurred in the composition of six, or at least of five quartos. <list rend="runontype="ordered">  <label>(1)</label>  <item>My first rough manuscript, without any intermediate copy, has been sent to the press.</item>  <label>(2) </label>  <item>Not a sheet has been seen by any human eyes, excepting those of the author and the    printer: the faults and the merits are exclusively my own.</item> </list>
ExampleLabels may also be used for other structured list items, as in this extract from the journal of Edward Gibbon:
<list type="gloss">  <label>March 1757.</label>  <item>I wrote some critical observations upon Plautus.</item>  <label>March 8th.</label>  <item>I wrote a long dissertation upon some lines of Virgil.</item>  <label>June.</label>  <item>I saw Mademoiselle Curchod — <quote xml:lang="la">Omnia vincit amor, et nos cedamus      amori.</quote>  </item>  <label>August.</label>  <item>I went to Crassy, and staid two days.</item> </list>
Note that the <label> might also appear within the <item> rather than as its sibling. Though syntactically valid, this usage is not recommended TEI practice.
ExampleLabels may also be used to represent a label or heading attached to a paragraph or sequence of paragraphs not treated as a structural division, or to a group of verse lines. Note that, in this case, the <label> element appears within the <p> or <lg> element, rather than as a preceding sibling of it.
<p>[...] <lb/>&amp; n’entrer en mauuais &amp; mal-heu- <lb/>ré meſnage. Or des que le conſente- <lb/>ment des parties y eſt le mariage eſt <lb/> arreſté, quoy que de faict il ne ſoit <label place="margin">Puiſſance maritale    entre les Romains.</label>  <lb/> conſommé. Depuis la conſomma- <lb/>tion du mariage la femme eſt ſoubs <lb/> la puiſſance du mary, s’il n’eſt eſcla- <lb/>ue ou enfant de famille : car en ce <lb/> cas, la femme, qui a eſpouſé vn en- <lb/>fant de famille, eſt ſous la puiſſance [...]</p>
In this example the text of the label appears in the right hand margin of the original source, next to the paragraph it describes, but approximately in the middle of it. If so desired the type attribute may be used to distinguish different categories of label.
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element label
{
   att.global.attributes,
   att.typed.attributes,
   att.placement.attributes,
   att.written.attributes,
   macro.phraseSeq
}

Appendix A.1.64 <langUsage>

<langUsage> (language usage) describes the languages, sublanguages, registers, dialects, etc. represented within a text. [2.4.2. Language Usage 2.4. The Profile Description 15.3.2. Declarable Elements]
Moduleheader
Attributes
Member of
Contained by
header: profileDesc
May contain
core: p
header: language
linking: ab
Example
<langUsage>  <language ident="fr-CAusage="60">Québecois</language>  <language ident="en-CAusage="20">Canadian business English</language>  <language ident="en-GBusage="20">British English</language> </langUsage>
Content model
<content>
 <alternate>
  <classRef key="model.pLike" minOccurs="1"
   maxOccurs="unbounded"/>
  <elementRef key="language" minOccurs="1"
   maxOccurs="unbounded"/>
 </alternate>
</content>
    
Schema Declaration
element langUsage
{
   att.global.attributes,
   att.declarable.attributes,
   ( model.pLike+ | language+ )
}

Appendix A.1.65 <language>

<language> (language) characterizes a single language or sublanguage used within a text. [2.4.2. Language Usage]
Moduleheader
Attributes
ident(identifier) Supplies a language code constructed as defined in BCP 47 which is used to identify the language documented by this element, and which is referenced by the global xml:lang attribute.
StatusRequired
Datatypeteidata.language
usagespecifies the approximate percentage (by volume) of the text which uses this language.
StatusOptional
DatatypenonNegativeInteger
Contained by
header: langUsage
May contain
Note

Particularly for sublanguages, an informal prose characterization should be supplied as content for the element.

Example
<langUsage>  <language ident="en-USusage="75">modern American English</language>  <language ident="i-az-Arabusage="20">Azerbaijani in Arabic script</language>  <language ident="x-lapusage="05">Pig Latin</language> </langUsage>
Content model
<content>
 <macroRef key="macro.phraseSeq.limited"/>
</content>
    
Schema Declaration
element language
{
   att.global.attributes,
   attribute ident { text },
   attribute usage { text }?,
   macro.phraseSeq.limited
}

Appendix A.1.66 <lb>

<lb> (line beginning) marks the beginning of a new (typographic) line in some edition or version of a text. [3.11.3. Milestone Elements 7.2.5. Speech Contents]
Modulecore
Attributes
Member of
Contained by
May containEmpty element
Note

By convention, <lb> elements should appear at the point in the text where a new line starts. The n attribute, if used, indicates the number or other value associated with the text between this point and the next <lb> element, typically the sequence number of the line within the page, or other appropriate unit. This element is intended to be used for marking actual line breaks on a manuscript or printed page, at the point where they occur; it should not be used to tag structural units such as lines of verse (for which the <l> element is available) except in circumstances where structural units cannot otherwise be marked.

The type attribute may be used to characterize the line break in any respect. The more specialized attributes break, ed, or edRef should be preferred when the intent is to indicate whether or not the line break is word-breaking, or to note the source from which it derives.

ExampleThis example shows typographical line breaks within metrical lines, where they occur at different places in different editions:
<l>Of Mans First Disobedience,<lb ed="1674"/> and<lb ed="1667"/> the Fruit</l> <l>Of that Forbidden Tree, whose<lb ed="1667 1674"/> mortal tast</l> <l>Brought Death into the World,<lb ed="1667"/> and all<lb ed="1674"/> our woe,</l>
ExampleThis example encodes typographical line breaks as a means of preserving the visual appearance of a title page. The break attribute is used to show that the line break does not (as elsewhere) mark the start of a new word.
<titlePart>  <lb/>With Additions, ne-<lb break="no"/>ver before Printed. </titlePart>
Content model
<content>
 <empty/>
</content>
    
Schema Declaration
element lb
{
   att.global.attributes,
   att.typed.attributes,
   att.edition.attributes,
   att.spanning.attributes,
   att.breaking.attributes,
   empty
}

Appendix A.1.67 <lg>

<lg> (line group) contains one or more verse lines functioning as a formal unit, e.g. a stanza, refrain, verse paragraph, etc. [3.13.1. Core Tags for Verse 3.13. Passages of Verse or Drama 7.2.5. Speech Contents]
Modulecore
Attributes
Member of
Contained by
figures: cell
header: change licence
linking: ab seg
msdescription: acquisition origin summary
namesdates: occupation
spoken: u
textstructure: argument body div salute signed
transcr: supplied
May contain
Note

contains verse lines or nested line groups only, possibly prefixed by a heading.

Example
<lg type="free">  <l>Let me be my own fool</l>  <l>of my own making, the sum of it</l> </lg> <lg type="free">  <l>is equivocal.</l>  <l>One says of the drunken farmer:</l> </lg> <lg type="free">  <l>leave him lay off it. And this is</l>  <l>the explanation.</l> </lg>
Schematron
<sch:assert test="count(descendant::tei:lg|descendant::tei:l|descendant::tei:gap) > 0">An lg element must contain at least one child l, lg, or gap element.</sch:assert>
Schematron
<sch:report test="ancestor::tei:l[not(.//tei:note//tei:lg[. = current()])]"> Abstract model violation: Lines may not contain line groups. </sch:report>
Content model
<content>
 <sequence>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.divTop"/>
   <classRef key="model.global"/>
  </alternate>
  <alternate>
   <classRef key="model.lLike"/>
   <classRef key="model.stageLike"/>
   <classRef key="model.labelLike"/>
   <classRef key="model.pPart.transcriptional"/>
   <elementRef key="lg"/>
  </alternate>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.lLike"/>
   <classRef key="model.stageLike"/>
   <classRef key="model.labelLike"/>
   <classRef key="model.pPart.transcriptional"/>
   <classRef key="model.global"/>
   <elementRef key="lg"/>
  </alternate>
  <sequence minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.divBottom"/>
   <classRef key="model.global"
    minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
 </sequence>
</content>
    
Schema Declaration
element lg
{
   att.global.attributes,
   att.divLike.attributes,
   att.typed.attributes,
   att.declaring.attributes,
   (
      ( model.divTop | model.global )*,
      (
         model.lLike
       | model.stageLike
       | model.labelLikemodel.pPart.transcriptionallg
      ),
      (
         model.lLike
       | model.stageLike
       | model.labelLikemodel.pPart.transcriptionalmodel.globallg
      )*,
      ( ( model.divBottom, model.global* )* )
   )
}

Appendix A.1.68 <licence>

<licence> contains information about a licence or other legal agreement applicable to the text. [2.2.4. Publication, Distribution, Licensing, etc.]
Moduleheader
Attributes
Member of
Contained by
header: availability
May contain
Note

A <licence> element should be supplied for each licence agreement applicable to the text in question. The target attribute may be used to reference a full version of the licence. The when, notBefore, notAfter, from or to attributes may be used in combination to indicate the date or dates of applicability of the licence.

Example
<licence target="http://www.nzetc.org/tm/scholarly/tei-NZETC-Help.html#licensing"> Licence: Creative Commons Attribution-Share Alike 3.0 New Zealand Licence </licence>
Example
<availability>  <licence target="http://creativecommons.org/licenses/by/3.0/"   notBefore="2013-01-01">   <p>The Creative Commons Attribution 3.0 Unported (CC BY 3.0) Licence      applies to this document.</p>   <p>The licence was added on January 1, 2013.</p>  </licence> </availability>
Content model
<content>
 <macroRef key="macro.specialPara"/>
</content>
    
Schema Declaration
element licence
{
   att.global.attributes,
   att.pointing.attributes,
   att.datable.attributes,
   macro.specialPara
}

Appendix A.1.69 <list>

<list> (list) contains any sequence of items organized as a list. [3.8. Lists]
Modulecore
Attributes
type(type) describes the nature of the items in the list.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Suggested values include:
gloss
(gloss) each list item glosses some term or concept, which is given by a <label> element preceding the list item.
index
(index) each list item is an entry in an index such as the alphabetical topical index at the back of a print volume.
instructions
(instructions) each list item is a step in a sequence of instructions, as in a recipe.
litany
(litany) each list item is one of a sequence of petitions, supplications or invocations, typically in a religious ritual.
syllogism
(syllogism) each list item is part of an argument consisting of two or more propositions and a final conclusion derived from them.
Note

Previous versions of these Guidelines recommended the use of type on <list> to encode the rendering or appearance of a list (whether it was bulleted, numbered, etc.). The current recommendation is to use the rend or style attributes for these aspects of a list, while using type for the more appropriate task of characterizing the nature of the content of a list.

The formal syntax of the element declarations allows <label> tags to be omitted from lists tagged <list type="gloss">; this is however a semantic error.

Member of
Contained by
May contain
Note

May contain an optional heading followed by a series of items, or a series of label and item pairs, the latter being optionally preceded by one or two specialized headings.

Example
<list rend="numbered">  <item>a butcher</item>  <item>a baker</item>  <item>a candlestick maker, with  <list rend="bulleted">    <item>rings on his fingers</item>    <item>bells on his toes</item>   </list>  </item> </list>
Example
<list type="syllogismrend="bulleted">  <item>All Cretans are liars.</item>  <item>Epimenides is a Cretan.</item>  <item>ERGO Epimenides is a liar.</item> </list>
Example
<list type="litanyrend="simple">  <item>God save us from drought.</item>  <item>God save us from pestilence.</item>  <item>God save us from wickedness in high places.</item>  <item>Praise be to God.</item> </list>
ExampleThe following example treats the short numbered clauses of Anglo-Saxon legal codes as lists of items. The text is from an ordinance of King Athelstan (924–939):
<div1 type="section">  <head>Athelstan's Ordinance</head>  <list rend="numbered">   <item n="1">Concerning thieves. First, that no thief is to be spared who is caught with      the stolen goods, [if he is] over twelve years and [if the value of the goods is] over      eightpence.   <list rend="numbered">     <item n="1.1">And if anyone does spare one, he is to pay for the thief with his          wergild — and the thief is to be no nearer a settlement on that account — or to          clear himself by an oath of that amount.</item>     <item n="1.2">If, however, he [the thief] wishes to defend himself or to escape, he is          not to be spared [whether younger or older than twelve].</item>     <item n="1.3">If a thief is put into prison, he is to be in prison 40 days, and he may          then be redeemed with 120 shillings; and the kindred are to stand surety for him          that he will desist for ever.</item>     <item n="1.4">And if he steals after that, they are to pay for him with his wergild,          or to bring him back there.</item>     <item n="1.5">And if he steals after that, they are to pay for him with his wergild,          whether to the king or to him to whom it rightly belongs; and everyone of those who          supported him is to pay 120 shillings to the king as a fine.</item>    </list>   </item>   <item n="2">Concerning lordless men. And we pronounced about these lordless men, from whom      no justice can be obtained, that one should order their kindred to fetch back such a      person to justice and to find him a lord in public meeting.   <list rend="numbered">     <item n="2.1">And if they then will not, or cannot, produce him on that appointed day,          he is then to be a fugitive afterwards, and he who encounters him is to strike him          down as a thief.</item>     <item n="2.2">And he who harbours him after that, is to pay for him with his wergild          or to clear himself by an oath of that amount.</item>    </list>   </item>   <item n="3">Concerning the refusal of justice. The lord who refuses justice and upholds      his guilty man, so that the king is appealed to, is to repay the value of the goods and      120 shillings to the king; and he who appeals to the king before he demands justice as      often as he ought, is to pay the same fine as the other would have done, if he had      refused him justice.   <list rend="numbered">     <item n="3.1">And the lord who is an accessory to a theft by his slave, and it becomes          known about him, is to forfeit the slave and be liable to his wergild on the first          occasionp if he does it more often, he is to be liable to pay all that he owns.</item>     <item n="3.2">And likewise any of the king's treasurers or of our reeves, who has been          an accessory of thieves who have committed theft, is to liable to the same.</item>    </list>   </item>   <item n="4">Concerning treachery to a lord. And we have pronounced concerning treachery to      a lord, that he [who is accused] is to forfeit his life if he cannot deny it or is      afterwards convicted at the three-fold ordeal.</item>  </list> </div1>
Note that nested lists have been used so the tagging mirrors the structure indicated by the two-level numbering of the clauses. The clauses could have been treated as a one-level list with irregular numbering, if desired.
Example
<p>These decrees, most blessed Pope Hadrian, we propounded in the public council ... and they confirmed them in our hand in your stead with the sign of the Holy Cross, and afterwards inscribed with a careful pen on the paper of this page, affixing thus the sign of the Holy Cross. <list rend="simple">   <item>I, Eanbald, by the grace of God archbishop of the holy church of York, have      subscribed to the pious and catholic validity of this document with the sign of the Holy      Cross.</item>   <item>I, Ælfwold, king of the people across the Humber, consenting have subscribed with      the sign of the Holy Cross.</item>   <item>I, Tilberht, prelate of the church of Hexham, rejoicing have subscribed with the      sign of the Holy Cross.</item>   <item>I, Higbald, bishop of the church of Lindisfarne, obeying have subscribed with the      sign of the Holy Cross.</item>   <item>I, Ethelbert, bishop of Candida Casa, suppliant, have subscribed with thef sign of      the Holy Cross.</item>   <item>I, Ealdwulf, bishop of the church of Mayo, have subscribed with devout will.</item>   <item>I, Æthelwine, bishop, have subscribed through delegates.</item>   <item>I, Sicga, patrician, have subscribed with serene mind with the sign of the Holy      Cross.</item>  </list> </p>
SchematronLists should only be empty in the special case of RADish files; those lists aren't really empty in any case--they must also include a processing instruction for including items from another RADish file.
<sch:pattern> <sch:rule context="tei:list[not(exists(child::*))]">  <sch:assert test="processing-instruction('loi-include')">ERROR: Empty lists    can only occur in RADish files and must have loi-include processing instructions.</sch:assert> </sch:rule> </sch:pattern>
Schematron
<sch:rule context="tei:list[@type='gloss']"> <sch:assert test="tei:label">The content of a "gloss" list should include a sequence of one or more pairs of a label element followed by an item element</sch:assert> </sch:rule>
Content model
<content>
 <sequence minOccurs="1" maxOccurs="1">
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.divTop"/>
   <classRef key="model.global"/>
   <elementRef key="desc" minOccurs="0"
    maxOccurs="unbounded"/>
  </alternate>
  <alternate minOccurs="1" maxOccurs="1">
   <sequence minOccurs="0"
    maxOccurs="unbounded">
    <elementRef key="item"/>
    <classRef key="model.global"
     minOccurs="0" maxOccurs="unbounded"/>
   </sequence>
   <sequence minOccurs="1" maxOccurs="1">
    <elementRef key="headLabel"
     minOccurs="0"/>
    <elementRef key="headItem"
     minOccurs="0"/>
    <sequence minOccurs="1"
     maxOccurs="unbounded">
     <elementRef key="label"/>
     <classRef key="model.global"
      minOccurs="0" maxOccurs="unbounded"/>
     <elementRef key="item"/>
     <classRef key="model.global"
      minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
   </sequence>
  </alternate>
  <sequence minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.divBottom"/>
   <classRef key="model.global"
    minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
 </sequence>
</content>
    
Schema Declaration
element list
{
   att.global.attributes,
   att.sortable.attributes,
   att.typed.attribute.subtype,
   attribute type
   {
      "gloss" | "index" | "instructions" | "litany" | "syllogism"
   }?,
   (
      ( model.divTop | model.global | desc* )*,
      (
         ( ( item, model.global* )* )
       | (
            headLabel?,
            headItem?,
            ( ( label, model.global*, item, model.global* )+ )
         )
      ),
      ( ( model.divBottom, model.global* )* )
   )
}

Appendix A.1.70 <listEvent>

<listEvent> (list of events) contains a list of descriptions, each of which provides information about an identifiable event. [13.3.1. Basic Principles]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Example
<listEvent>  <head>Battles of the American Civil War: Kentucky</head>  <event xml:id="event01when="1861-09-19">   <label>Barbourville</label>   <desc>The Battle of Barbourville was one of the early engagements of      the American Civil War. It occurred September 19, 1861, in Knox      County, Kentucky during the campaign known as the Kentucky Confederate      Offensive. The battle is considered the first Confederate victory in      the commonwealth, and threw a scare into Federal commanders, who      rushed troops to central Kentucky in an effort to repel the invasion,      which was finally thwarted at the <ref target="#event02">Battle of        Camp Wildcat</ref> in October.</desc>  </event>  <event xml:id="event02when="1861-10-21">   <label>Camp Wild Cat</label>   <desc>The Battle of Camp Wildcat (also known as Wildcat Mountain and Camp      Wild Cat) was one of the early engagements of the American Civil      War. It occurred October 21, 1861, in northern Laurel County, Kentucky      during the campaign known as the Kentucky Confederate Offensive. The      battle is considered one of the very first Union victories, and marked      the first engagement of troops in the commonwealth of Kentucky.</desc>  </event>  <event xml:id="event03from="1864-06-11"   to="1864-06-12">   <label>Cynthiana</label>   <desc>The Battle of Cynthiana (or Kellar’s Bridge) was an engagement      during the American Civil War that was fought on June 11 and 12, 1864,      in Harrison County, Kentucky, near the town of Cynthiana. A part of      Confederate Brigadier General John Hunt Morgan's 1864 Raid into      Kentucky, the battle resulted in a victory by Union forces over the      raiders and saved the town from capture.</desc>  </event> </listEvent>
Content model
<content>
 <sequence>
  <classRef key="model.headLike"
   minOccurs="0" maxOccurs="unbounded"/>
  <elementRef key="desc" minOccurs="0"
   maxOccurs="unbounded"/>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <elementRef key="relation" minOccurs="1"
    maxOccurs="1"/>
   <elementRef key="listRelation"
    minOccurs="1" maxOccurs="1"/>
  </alternate>
  <sequence minOccurs="1"
   maxOccurs="unbounded">
   <classRef key="model.eventLike"
    minOccurs="1" maxOccurs="unbounded"/>
   <alternate minOccurs="0"
    maxOccurs="unbounded">
    <elementRef key="relation"
     minOccurs="1" maxOccurs="1"/>
    <elementRef key="listRelation"
     minOccurs="1" maxOccurs="1"/>
   </alternate>
  </sequence>
 </sequence>
</content>
    
Schema Declaration
element listEvent
{
   att.global.attributes,
   att.typed.attributes,
   att.declarable.attributes,
   att.sortable.attributes,
   (
      model.headLike*,
      desc*,
      ( relation | listRelation )*,
      ( ( model.eventLike+, ( relation | listRelation )* )+ )
   )
}

Appendix A.1.71 <listObject>

<listObject> (list of objects) contains a list of descriptions, each of which provides information about an identifiable physical object. [13.3.5. Objects]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Note

The type attribute may be used to distinguish different types of objects.

Example
<listObject>  <object xml:id="AlfredJewel">   <objectIdentifier>    <country>United Kingdom</country>    <region>Oxfordshire</region>    <settlement>Oxford</settlement>    <institution>University of Oxford</institution>    <repository>Ashmolean Museum</repository>    <collection>English Treasures</collection>    <idno type="ashmolean">AN1836p.135.371</idno>    <idno type="wikipedia">https://en.wikipedia.org/wiki/Alfred_Jewel</idno>    <objectName>Alfred Jewel</objectName>   </objectIdentifier>   <physDesc>    <p> The Alfred Jewel is about 6.4 cm in length and is made of combination of filigreed <material>gold</material>        surrounding a polished teardrop shaped piece of transparent <material>quartz</material>. Underneath the rock crystal        is a cloisonné enamel image of a man with ecclesiastical symbols. The sides of the jewel holding the crystal in        place contain an openwork inscription saying "AELFRED MEC HEHT GEWYRCAN", meaning 'Alfred ordered me made'. </p>   </physDesc>   <history>    <origin>It is generally accepted that the Alfred Jewel dates from the <origDate>late 9th Century</origDate> and was        most likely made in <origPlace>England</origPlace>. </origin>    <provenance when="1693">The jewel was discovered in 1693 at Petherton Park, North Petherton in the English county of        Somerset, on land owned by Sir Thomas Wroth. North Petherton is about 8 miles away from Athelney, where King Alfred        founded a monastery. </provenance>    <provenance when="1698">A description of the Alfred Jewel was first published in 1698, in the Philosophical        Transactions of the Royal Society.</provenance>    <acquisition> It was bequeathed to Oxford University by Colonel Nathaniel Palmer (c. 1661-1718) and today is in the        Ashmolean Museum in Oxford. </acquisition>   </history>  </object> </listObject>
Content model
<content>
 <sequence>
  <classRef key="model.headLike"
   minOccurs="0" maxOccurs="unbounded"/>
  <elementRef key="desc" minOccurs="0"
   maxOccurs="unbounded"/>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <elementRef key="relation" minOccurs="1"
    maxOccurs="1"/>
   <elementRef key="listRelation"
    minOccurs="1" maxOccurs="1"/>
  </alternate>
  <sequence minOccurs="1"
   maxOccurs="unbounded">
   <classRef key="model.objectLike"
    minOccurs="1" maxOccurs="unbounded"/>
   <alternate minOccurs="0"
    maxOccurs="unbounded">
    <elementRef key="relation"
     minOccurs="1" maxOccurs="1"/>
    <elementRef key="listRelation"
     minOccurs="1" maxOccurs="1"/>
   </alternate>
  </sequence>
 </sequence>
</content>
    
Schema Declaration
element listObject
{
   att.global.attributes,
   att.typed.attributes,
   att.declarable.attributes,
   att.sortable.attributes,
   (
      model.headLike*,
      desc*,
      ( relation | listRelation )*,
      ( ( model.objectLike+, ( relation | listRelation )* )+ )
   )
}

Appendix A.1.72 <listOrg>

<listOrg> (list of organizations) contains a list of elements, each of which provides information about an identifiable organization. [13.2.2. Organizational Names]
Modulenamesdates
Attributes
Member of
Contained by
figures: cell
linking: ab seg
msdescription: acquisition origin summary
namesdates: listOrg occupation org
spoken: u
textstructure: argument body div salute signed
transcr: supplied
May contain
Note

The type attribute may be used to distinguish lists of organizations of a particular type if convenient.

Example
<listOrg>  <head>Libyans</head>  <org>   <orgName>Adyrmachidae</orgName>   <desc>These people have, in most points, the same customs as the Egyptians, but      use the costume of the Libyans. Their women wear on each leg a ring made of      bronze [...]</desc>  </org>  <org>   <orgName>Nasamonians</orgName>   <desc>In summer they leave their flocks and herds upon the sea-shore, and go up      the country to a place called Augila, where they gather the dates from the      palms [...]</desc>  </org>  <org>   <orgName>Garamantians</orgName>   <desc>[...] avoid all society or intercourse with their fellow-men, have no      weapon of war, and do not know how to defend themselves. [...]</desc> <!-- ... -->  </org> </listOrg>
Content model
<content>
 <sequence>
  <classRef key="model.headLike"
   minOccurs="0" maxOccurs="unbounded"/>
  <elementRef key="desc" minOccurs="0"
   maxOccurs="unbounded"/>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <elementRef key="relation" minOccurs="1"
    maxOccurs="1"/>
   <elementRef key="listRelation"
    minOccurs="1" maxOccurs="1"/>
  </alternate>
  <sequence minOccurs="1"
   maxOccurs="unbounded">
   <alternate minOccurs="1"
    maxOccurs="unbounded">
    <elementRef key="org" minOccurs="1"
     maxOccurs="1"/>
    <elementRef key="listOrg" minOccurs="1"
     maxOccurs="1"/>
   </alternate>
   <alternate minOccurs="0"
    maxOccurs="unbounded">
    <elementRef key="relation"
     minOccurs="1" maxOccurs="1"/>
    <elementRef key="listRelation"
     minOccurs="1" maxOccurs="1"/>
   </alternate>
  </sequence>
 </sequence>
</content>
    
Schema Declaration
element listOrg
{
   att.global.attributes,
   att.typed.attributes,
   att.declarable.attributes,
   att.sortable.attributes,
   (
      model.headLike*,
      desc*,
      ( relation | listRelation )*,
      ( ( ( org | listOrg )+, ( relation | listRelation )* )+ )
   )
}

Appendix A.1.73 <listPerson>

<listPerson> (list of persons) contains a list of descriptions, each of which provides information about an identifiable person or a group of people, for example the participants in a language interaction, or the people referred to in a historical source. [13.3.2. The Person Element 15.2. Contextual Information 2.4. The Profile Description 15.3.2. Declarable Elements]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Note

The type attribute may be used to distinguish lists of people of a particular type if convenient.

Example
<listPerson type="respondents">  <personGrp xml:id="PXXX"/>  <person xml:id="P1234sex="2age="mid"/>  <person xml:id="P4332sex="1age="mid"/>  <listRelation>   <relation type="personalname="spouse"    mutual="#P1234 #P4332"/>  </listRelation> </listPerson>
Content model
<content>
 <sequence>
  <classRef key="model.headLike"
   minOccurs="0" maxOccurs="unbounded"/>
  <elementRef key="desc" minOccurs="0"
   maxOccurs="unbounded"/>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <elementRef key="relation" minOccurs="1"
    maxOccurs="1"/>
   <elementRef key="listRelation"
    minOccurs="1" maxOccurs="1"/>
  </alternate>
  <sequence minOccurs="1"
   maxOccurs="unbounded">
   <alternate minOccurs="1"
    maxOccurs="unbounded">
    <classRef key="model.personLike"
     minOccurs="1" maxOccurs="1"/>
    <elementRef key="listPerson"
     minOccurs="1" maxOccurs="1"/>
   </alternate>
   <alternate minOccurs="0"
    maxOccurs="unbounded">
    <elementRef key="relation"
     minOccurs="1" maxOccurs="1"/>
    <elementRef key="listRelation"
     minOccurs="1" maxOccurs="1"/>
   </alternate>
  </sequence>
 </sequence>
</content>
    
Schema Declaration
element listPerson
{
   att.global.attributes,
   att.typed.attributes,
   att.declarable.attributes,
   att.sortable.attributes,
   (
      model.headLike*,
      desc*,
      ( relation | listRelation )*,
      ( ( ( model.personLike | listPerson )+, ( relation | listRelation )* )+ )
   )
}

Appendix A.1.74 <listPlace>

<listPlace> (list of places) contains a list of places, optionally followed by a list of relationships (other than containment) defined amongst them. [2.2.7. The Source Description 13.3.4. Places]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Example
<listPlace type="offshoreIslands">  <place>   <placeName>La roche qui pleure</placeName>  </place>  <place>   <placeName>Ile aux cerfs</placeName>  </place> </listPlace>
Content model
<content>
 <sequence>
  <classRef key="model.headLike"
   minOccurs="0" maxOccurs="unbounded"/>
  <elementRef key="desc" minOccurs="0"
   maxOccurs="unbounded"/>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <elementRef key="relation" minOccurs="1"
    maxOccurs="1"/>
   <elementRef key="listRelation"
    minOccurs="1" maxOccurs="1"/>
  </alternate>
  <sequence minOccurs="1"
   maxOccurs="unbounded">
   <alternate minOccurs="1"
    maxOccurs="unbounded">
    <classRef key="model.placeLike"
     minOccurs="1" maxOccurs="1"/>
    <elementRef key="listPlace"
     minOccurs="1" maxOccurs="1"/>
   </alternate>
   <alternate minOccurs="0"
    maxOccurs="unbounded">
    <elementRef key="relation"
     minOccurs="1" maxOccurs="1"/>
    <elementRef key="listRelation"
     minOccurs="1" maxOccurs="1"/>
   </alternate>
  </sequence>
 </sequence>
</content>
    
Schema Declaration
element listPlace
{
   att.global.attributes,
   att.typed.attributes,
   att.declarable.attributes,
   att.sortable.attributes,
   (
      model.headLike*,
      desc*,
      ( relation | listRelation )*,
      ( ( ( model.placeLike | listPlace )+, ( relation | listRelation )* )+ )
   )
}

Appendix A.1.75 <listRelation>

<listRelation> provides information about relationships identified amongst people, places, and organizations, either informally as prose or as formally expressed relation links. [13.3.2.3. Personal Relationships]
Modulenamesdates
Attributes
Member of
Contained by
May contain
core: desc head p
linking: ab
Note

May contain a prose description organized as paragraphs, or a sequence of <relation> elements.

Example
<listPerson>  <person xml:id="pp1"> <!-- data about person pp1 -->  </person>  <person xml:id="pp2"> <!-- data about person pp1 -->  </person> <!-- more person (pp3, pp4) elements here -->  <listRelation type="personal">   <relation name="parent"    active="#pp1 #pp2passive="#pp3 #pp4"/>   <relation name="spouse"    mutual="#pp1 #pp2"/>  </listRelation>  <listRelation type="social">   <relation name="employeractive="#pp1"    passive="#pp3 #pp5 #pp6 #pp7"/>  </listRelation> </listPerson>
The persons with identifiers pp1 and pp2 are the parents of pp3 and pp4; they are also married to each other; pp1 is the employer of pp3, pp5, pp6, and pp7.
Example
<listPerson>  <person xml:id="en_pp1"> <!-- data about person en_pp1 -->  </person>  <person xml:id="en_pp2"> <!-- data about person en_pp2 -->  </person> <!-- more person (en_pp3, en_pp4) elements here --> </listPerson> <listPlace>  <place xml:id="en_pl1"> <!-- data about place en_pl1 -->  </place> <!-- more place (en_pl2, en_pl3) elements here --> </listPlace> <listRelation>  <relation name="residence"   active="#en_pp1 #en_pp2passive="#en_pl1"/> </listRelation>
The persons with identifiers en_pp1 and en_pp2 live in en_pl1.
Example
<listRelation>  <p>All speakers are members of the Ceruli family, born in Naples.</p> </listRelation>
Content model
<content>
 <sequence>
  <classRef key="model.headLike"
   minOccurs="0" maxOccurs="unbounded"/>
  <elementRef key="desc" minOccurs="0"
   maxOccurs="unbounded"/>
  <alternate minOccurs="1" maxOccurs="1">
   <classRef key="model.pLike"/>
   <alternate minOccurs="1"
    maxOccurs="unbounded">
    <elementRef key="relation"
     minOccurs="1" maxOccurs="1"/>
    <elementRef key="listRelation"
     minOccurs="1" maxOccurs="1"/>
   </alternate>
  </alternate>
 </sequence>
</content>
    
Schema Declaration
element listRelation
{
   att.global.attributes,
   att.typed.attributes,
   att.sortable.attributes,
   ( model.headLike*, desc*, ( model.pLike | ( relation | listRelation )+ ) )
}

Appendix A.1.76 <location>

<location> (location) defines the location of a place as a set of geographical coordinates, in terms of other named geo-political entities, or as an address. [13.3.4. Places]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Example
<place>  <placeName>Abbey Dore</placeName>  <location>   <geo>51.969604 -2.893146</geo>  </location> </place>
Example
<place xml:id="BGbuildingtype="building">  <placeName>Brasserie Georges</placeName>  <location>   <country key="FR"/>   <settlement type="city">Lyon</settlement>   <district type="arrondissement">IIème</district>   <district type="quartier">Perrache</district>   <placeName type="street">    <num>30</num>, Cours de Verdun</placeName>  </location> </place>
Example
<place type="imaginary">  <placeName>Atlantis</placeName>  <location>   <offset>beyond</offset>   <placeName>The Pillars of <persName>Hercules</persName>   </placeName>  </location> </place>
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <elementRef key="precision"/>
  <classRef key="model.labelLike"/>
  <classRef key="model.placeNamePart"/>
  <classRef key="model.offsetLike"/>
  <classRef key="model.measureLike"/>
  <classRef key="model.addressLike"/>
  <classRef key="model.noteLike"/>
  <classRef key="model.biblLike"/>
 </alternate>
</content>
    
Schema Declaration
element location
{
   att.global.attributes,
   att.typed.attributes,
   att.datable.attributes,
   att.editLike.attributes,
   (
      precision
    | model.labelLikemodel.placeNamePart
    | model.offsetLike
    | model.measureLikemodel.addressLikemodel.noteLikemodel.biblLike
   )*
}

Appendix A.1.77 <mapping>

<mapping> (character mapping) contains one or more characters which are related to the parent character or glyph in some respect, as specified by the type attribute. [5.2. Markup Constructs for Representation of Characters and Glyphs]
Modulegaiji
Attributes
Contained by
gaiji: glyph
May contain
gaiji: g
character data
Note

Suggested values for the type attribute include exact for exact equivalences, uppercase for uppercase equivalences, lowercase for lowercase equivalences, and simplified for simplified characters. The <g> elements contained by this element can point to either another <char> or <glyph>element or contain a character that is intended to be the target of this mapping.

Example
<mapping type="modern">r</mapping> <mapping type="standard"></mapping>
Content model
<content>
 <macroRef key="macro.xtext"/>
</content>
    
Schema Declaration
element mapping { att.global.attributes, att.typed.attributes, macro.xtext }

Appendix A.1.78 <material>

<material> (material) contains a word or phrase describing the material of which the object being described is composed. [10.3.2. Material and Object Type]
Modulemsdescription
Attributes
functiondescribes the function or use of the material in relation to the object as a whole.
StatusOptional
Datatypeteidata.enumerated
Sample values include:
binding
covering material of a codex
endband
sewing at the head or tail of the codex spine to strengthen the binding, often decorative
slipcase
removable protective cover for a set of one or more codices
support
the surface for writing
tie
a ribbon or string used to bind or close a codex or rolled scroll
Note

The sample values here are for descriptive bibliography. Other sets of sample values might include armrests, legs, tabletop, pan, and back for furniture; or wall, floor, window, column, ceiling, roof, stairs, chimney for architecture.

targetidentifies one or more elements to which the metamark applies.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Member of
Contained by
May contain
Note

The ref attribute may be used to point to one or more items within a taxonomy of types of material, defined either internally or externally.

Example
<physDesc>  <p>   <material>Parchment</material> leaves with a  <material>sharkskin</material> binding.</p> </physDesc>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element material
{
   att.global.attributes,
   att.canonical.attributes,
   att.typed.attributes,
   attribute function { text }?,
   attribute target { list { + } }?,
   macro.phraseSeq
}

Appendix A.1.79 <media>

<media> indicates the location of any form of external media such as an audio or video clip etc. [3.10. Graphics and Other Non-textual Components]
Modulecore
Attributes
mimeType(MIME media type) specifies the applicable multimedia internet mail extension (MIME) media type
Derived fromatt.internetMedia
StatusRequired
Datatype1–∞ occurrences of teidata.word separated by whitespace
Legal values are:
audio/mpeg
(An MP3 file (preferred)) MP3
audio/wav
(A WAV file) WAV
url(uniform resource locator) specifies the URL from which the media concerned may be obtained.
Derived fromatt.resourced
StatusRequired
Datatypeteidata.pointer
dur(duration) indicates the length of this element in time.
Derived fromatt.duration.w3c
StatusRequired
Datatypeteidata.duration.w3c
Member of
Contained by
May contain
core: desc
Note

The attributes available for this element are not appropriate in all cases. For example, it makes no sense to specify the temporal duration of a graphic. Such errors are not currently detected.

The mimeType attribute must be used to specify the MIME media type of the resource specified by the url attribute.

Example
<figure>  <media mimeType="image/pngurl="fig1.png"/>  <head>Figure One: The View from the Bridge</head>  <figDesc>A Whistleresque view showing four or five sailing boats in the foreground, and a    series of buoys strung out between them.</figDesc> </figure>
Example
<media mimeType="audio/wav"  url="dingDong.wavdur="PT10S">  <desc>Ten seconds of bellringing sound</desc> </media>
Example
<media mimeType="video/mp4"  url="clip45.mp4dur="PT45Mwidth="500px">  <desc>A 45 minute video clip to be displayed in a window 500    px wide</desc> </media>
Content model
<content>
 <classRef key="model.descLike"
  minOccurs="0" maxOccurs="unbounded"/>
</content>
    
Schema Declaration
element media
{
   att.typed.attribute.type,
   att.global.linking.attribute.sameAs,
   att.global.linking.attribute.select,
   att.global.responsibility.attribute.resp,
   att.media.attribute.scale,
   attribute mimeType { list { ( "audio/mpeg" | "audio/wav" )+ } },
   attribute url { text },
   attribute dur { text },
   model.descLike*
}

Appendix A.1.80 <milestone>

<milestone> (milestone) marks a boundary point separating any kind of section of a text, typically but not necessarily indicating a point at which some part of a standard reference system changes, where the change is not represented by a structural element. [3.11.3. Milestone Elements]
Modulecore
Attributes
Member of
Contained by
May containEmpty element
Note

For this element, the global n attribute indicates the new number or other value for the unit which changes at this milestone. The special value unnumbered should be used in passages which fall outside the normal numbering scheme, such as chapter or other headings, poem numbers or titles, etc.

The order in which <milestone> elements are given at a given point is not normally significant.

Example
<milestone n="23ed="Launit="Dreissiger"/> ... <milestone n="24ed="AVunit="verse"/> ...
Content model
<content>
 <empty/>
</content>
    
Schema Declaration
element milestone
{
   att.global.attributes,
   att.milestoneUnit.attributes,
   att.typed.attributes,
   att.edition.attributes,
   att.spanning.attributes,
   att.breaking.attributes,
   empty
}

Appendix A.1.81 <msContents>

<msContents> (manuscript contents) describes the intellectual content of a manuscript, manuscript part, or other object either as a series of paragraphs or as a series of structured manuscript items. [10.6. Intellectual Content]
Modulemsdescription
Attributes
Contained by
msdescription: msDesc
namesdates: object
May contain
core: p
linking: ab
msdescription: msItem summary
Note

Unless it contains a simple prose description, this element should contain at least one of the elements <summary>, <msItem>, or <msItemStruct>. This constraint is not currently enforced by the schema.

Example
<msContents class="#sermons">  <p>A collection of Lollard sermons</p> </msContents>
Example
<msContents>  <msItem n="1">   <locus>fols. 5r-7v</locus>   <title>An ABC</title>   <bibl>    <title>IMEV</title>    <biblScope>239</biblScope>   </bibl>  </msItem>  <msItem n="2">   <locus>fols. 7v-8v</locus>   <title xml:lang="frm">Lenvoy de Chaucer a Scogan</title>   <bibl>    <title>IMEV</title>    <biblScope>3747</biblScope>   </bibl>  </msItem>  <msItem n="3">   <locus>fol. 8v</locus>   <title>Truth</title>   <bibl>    <title>IMEV</title>    <biblScope>809</biblScope>   </bibl>  </msItem>  <msItem n="4">   <locus>fols. 8v-10v</locus>   <title>Birds Praise of Love</title>   <bibl>    <title>IMEV</title>    <biblScope>1506</biblScope>   </bibl>  </msItem>  <msItem n="5">   <locus>fols. 10v-11v</locus>   <title xml:lang="la">De amico ad amicam</title>   <title xml:lang="la">Responcio</title>   <bibl>    <title>IMEV</title>    <biblScope>16 &amp; 19</biblScope>   </bibl>  </msItem>  <msItem n="6">   <locus>fols. 14r-126v</locus>   <title>Troilus and Criseyde</title>   <note>Bk. 1:71-Bk. 5:1701, with additional losses due to mutilation throughout</note>  </msItem> </msContents>
Content model
<content>
 <alternate>
  <classRef key="model.pLike" minOccurs="1"
   maxOccurs="unbounded"/>
  <sequence>
   <elementRef key="summary" minOccurs="0"/>
   <elementRef key="textLang" minOccurs="0"/>
   <elementRef key="titlePage"
    minOccurs="0"/>
   <alternate minOccurs="0"
    maxOccurs="unbounded">
    <elementRef key="msItem"/>
    <elementRef key="msItemStruct"/>
   </alternate>
  </sequence>
 </alternate>
</content>
    
Schema Declaration
element msContents
{
   att.global.attributes,
   att.msExcerpt.attributes,
   att.msClass.attributes,
   (
      model.pLike+
    | ( summary?, textLang?, titlePage?, ( msItem | msItemStruct )* )
   )
}

Appendix A.1.82 <msDesc>

<msDesc> (manuscript description) contains a description of a single identifiable manuscript or other text-bearing object such as an early printed book. [10.1. Overview]
Modulemsdescription
Attributes
Member of
Contained by
May contain
Note

Although the <msDesc> has primarily been designed with a view to encoding manuscript descriptions, it may also be used for other objects such as early printed books, fascicles, epigraphs, or any text-bearing objects that require substantial description. If an object is not text-bearing or the reasons for describing the object is not primarily the textual content, the more general <object> may be more suitable.

Example
<msDesc>  <msIdentifier>   <settlement>Oxford</settlement>   <repository>Bodleian Library</repository>   <idno type="Bod">MS Poet. Rawl. D. 169.</idno>  </msIdentifier>  <msContents>   <msItem>    <author>Geoffrey Chaucer</author>    <title>The Canterbury Tales</title>   </msItem>  </msContents>  <physDesc>   <objectDesc>    <p>A parchment codex of 136 folios, measuring approx        28 by 19 inches, and containing 24 quires.</p>    <p>The pages are margined and ruled throughout.</p>    <p>Four hands have been identified in the manuscript: the first 44        folios being written in two cursive anglicana scripts, while the        remainder is for the most part in a mixed secretary hand.</p>   </objectDesc>  </physDesc> </msDesc>
Content model
<content>
 <sequence>
  <elementRef key="msIdentifier"/>
  <classRef key="model.headLike"
   minOccurs="0" maxOccurs="unbounded"/>
  <alternate>
   <classRef key="model.pLike"
    minOccurs="1" maxOccurs="unbounded"/>
   <sequence>
    <elementRef key="msContents"
     minOccurs="0"/>
    <elementRef key="physDesc"
     minOccurs="0"/>
    <elementRef key="history" minOccurs="0"/>
    <elementRef key="additional"
     minOccurs="0"/>
    <alternate>
     <elementRef key="msPart" minOccurs="0"
      maxOccurs="unbounded"/>
     <elementRef key="msFrag" minOccurs="0"
      maxOccurs="unbounded"/>
    </alternate>
   </sequence>
  </alternate>
 </sequence>
</content>
    
Schema Declaration
element msDesc
{
   att.global.attributes,
   att.sortable.attributes,
   att.typed.attributes,
   att.declaring.attributes,
   att.docStatus.attributes,
   (
      msIdentifier,
      model.headLike*,
      (
         model.pLike+
       | (
            msContents?,
            physDesc?,
            history?,
            additional?,
            ( msPart* | msFrag* )
         )
      )
   )
}

Appendix A.1.83 <msIdentifier>

<msIdentifier> (manuscript identifier) contains the information required to identify the manuscript or similar object being described. [10.4. The Manuscript Identifier]
Modulemsdescription
Attributes
Member of
Contained by
core: bibl
msdescription: msDesc
May contain
header: idno
msdescription: repository
Example
<msIdentifier>  <settlement>San Marino</settlement>  <repository>Huntington Library</repository>  <idno>MS.El.26.C.9</idno> </msIdentifier>
Schematron
<sch:report test="not(parent::tei:msPart) and (local-name(*[1])='idno' or local-name(*[1])='altIdentifier' or normalize-space(.)='')">An msIdentifier must contain either a repository or location.</sch:report>
Content model
<content>
 <sequence>
  <sequence>
   <classRef key="model.placeNamePart"
    expand="sequenceOptional"/>
   <elementRef key="institution"
    minOccurs="0"/>
   <elementRef key="repository"
    minOccurs="0"/>
   <elementRef key="collection"
    minOccurs="0" maxOccurs="unbounded"/>
   <elementRef key="idno" minOccurs="0"
    maxOccurs="unbounded"/>
  </sequence>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <elementRef key="msName"/>
   <elementRef key="objectName"/>
   <elementRef key="altIdentifier"/>
  </alternate>
 </sequence>
</content>
    
Schema Declaration
element msIdentifier
{
   att.global.attributes,
   (
      (
         placeName?,
         region?,
         settlement?,
         district?,
         institution?,
         repository?,
         collection*,
         idno*
      ),
      ( msName | objectName | altIdentifier )*
   )
}

Appendix A.1.84 <msItem>

<msItem> (manuscript item) describes an individual work or item within the intellectual content of a manuscript, manuscript part, or other object. [10.6.1. The msItem and msItemStruct Elements]
Modulemsdescription
Attributes
Member of
Contained by
msdescription: msContents msItem
May contain
Example
<msItem class="#saga">  <locus>ff. 1r-24v</locus>  <title>Agrip af Noregs konunga sögum</title>  <incipit>regi oc h<ex>ann</ex> setiho  <gap reason="illegibleextent="7"/>sc    heim se<ex>m</ex> þio</incipit>  <explicit>h<ex>on</ex> hev<ex>er</ex>   <ex>oc</ex>þa buit hesta .ij. aNan viþ    fé enh<ex>on</ex>o<ex>m</ex> aNan til    reiþ<ex>ar</ex>  </explicit>  <textLang mainLang="non">Old Norse/Icelandic</textLang> </msItem>
Content model
<content>
 <sequence>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <elementRef key="locus"/>
   <elementRef key="locusGrp"/>
  </alternate>
  <alternate>
   <classRef key="model.pLike"
    minOccurs="1" maxOccurs="unbounded"/>
   <alternate minOccurs="1"
    maxOccurs="unbounded">
    <classRef key="model.titlepagePart"/>
    <classRef key="model.msItemPart"/>
    <classRef key="model.global"/>
   </alternate>
  </alternate>
 </sequence>
</content>
    
Schema Declaration
element msItem
{
   att.global.attributes,
   att.msExcerpt.attributes,
   att.msClass.attributes,
   (
      ( locus | locusGrp )*,
      (
         model.pLike+
       | ( model.titlepagePart | model.msItemPart | model.global )+
      )
   )
}

Appendix A.1.85 <name>

<name> (name, proper noun) contains a proper noun or noun phrase. [3.6.1. Referring Strings]
Modulecore
Attributes
Member of
Contained by
May contain
Note

Proper nouns referring to people, places, and organizations may be tagged instead with <persName>, <placeName>, or <orgName>, when the TEI module for names and dates is included.

Example
<name type="person">Thomas Hoccleve</name> <name type="place">Villingaholt</name> <name type="org">Vetus Latina Institut</name> <name type="personref="#HOC001">Occleve</name>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element name
{
   att.global.attributes,
   att.personal.attributes,
   att.datable.attributes,
   att.editLike.attributes,
   att.typed.attributes,
   macro.phraseSeq
}

Appendix A.1.86 <nationality>

<nationality> (nationality) contains an informal description of a person's present or past nationality or citizenship. [15.2.2. The Participant Description]
Modulenamesdates
Attributes
typecharacterizes the element in some sense, using any convenient classification scheme or typology.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Sample values include:
birth
naturalised
self-assigned
Member of
Contained by
namesdates: person
May contain
Example
<nationality key="USnotBefore="1966"> Obtained US Citizenship in 1966</nationality>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element nationality
{
   att.global.attributes,
   att.datable.attributes,
   att.editLike.attributes,
   att.naming.attributes,
   att.typed.attribute.subtype,
   attribute type { text }?,
   macro.phraseSeq
}

Appendix A.1.87 <note>

<note> (note) contains a note or annotation. [3.9.1. Notes and Simple Annotation 2.2.6. The Notes Statement 3.12.2.8. Notes and Statement of Language 9.3.5.4. Notes within Entries]
Modulecore
Attributes
Member of
Contained by
May contain
ExampleIn the following example, the translator has supplied a footnote containing an explanation of the term translated as "painterly":
And yet it is not only in the great line of Italian renaissance art, but even in the painterly <note place="bottomtype="gloss"  resp="#MDMH">  <term xml:lang="de">Malerisch</term>. This word has, in the German, two distinct meanings, one objective, a quality residing in the object, the other subjective, a mode of apprehension and creation. To avoid confusion, they have been distinguished in English as <mentioned>picturesque</mentioned> and <mentioned>painterly</mentioned> respectively. </note> style of the Dutch genre painters of the seventeenth century that drapery has this psychological significance. <!-- elsewhere in the document --> <respStmt xml:id="MDMH">  <resp>translation from German to English</resp>  <name>Hottinger, Marie Donald Mackie</name> </respStmt>
For this example to be valid, the code MDMH must be defined elsewhere, for example by means of a responsibility statement in the associated TEI header.
ExampleThe global n attribute may be used to supply the symbol or number used to mark the note's point of attachment in the source text, as in the following example:
Mevorakh b. Saadya's mother, the matriarch of the family during the second half of the eleventh century, <note n="126anchored="true"> The alleged mention of Judah Nagid's mother in a letter from 1071 is, in fact, a reference to Judah's children; cf. above, nn. 111 and 54. </note> is well known from Geniza documents published by Jacob Mann.
However, if notes are numbered in sequence and their numbering can be reconstructed automatically by processing software, it may well be considered unnecessary to record the note numbers.
Content model
<content>
 <macroRef key="macro.specialPara"/>
</content>
    
Schema Declaration
element note
{
   att.global.attributes,
   att.placement.attributes,
   att.pointing.attributes,
   att.typed.attributes,
   att.written.attributes,
   att.anchoring.attributes,
   macro.specialPara
}

Appendix A.1.88 <notesStmt>

<notesStmt> (notes statement) collects together any notes providing information about a text additional to that recorded in other parts of the bibliographic description. [2.2.6. The Notes Statement 2.2. The File Description]
Moduleheader
Attributes
Contained by
header: fileDesc
May contain
Note

Information of different kinds should not be grouped together into the same note.

Example
<notesStmt>  <note>Historical commentary provided by Mark Cohen</note>  <note>OCR scanning done at University of Toronto</note> </notesStmt>
Content model
<content>
 <alternate minOccurs="1"
  maxOccurs="unbounded">
  <classRef key="model.noteLike"/>
  <elementRef key="relatedItem"/>
 </alternate>
</content>
    
Schema Declaration
element notesStmt { att.global.attributes, ( model.noteLike | relatedItem )+ }

Appendix A.1.89 <num>

<num> (number) contains a number, written in any form. [3.6.3. Numbers and Measures]
Modulecore
Attributes
typeindicates the type of numeric value.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Suggested values include:
cardinal
absolute number, e.g. 21, 21.5
ordinal
ordinal number, e.g. 21st
fraction
fraction, e.g. one half or three-quarters
percentage
a percentage
Note

If a different typology is desired, other values can be used for this attribute.

valuesupplies the value of the number in standard form.
StatusOptional
Datatypeteidata.numeric
Valuesa numeric value.
Note

The standard form used is defined by the TEI datatype teidata.numeric.

Member of
Contained by
May contain
Note

Detailed analyses of quantities and units of measure in historical documents may also use the feature structure mechanism described in chapter 18. Feature Structures. The <num> element is intended for use in simple applications.

Example
<p>I reached <num type="cardinalvalue="21">twenty-one</num> on my <num type="ordinalvalue="21">twenty-first</num> birthday</p> <p>Light travels at <num value="3E10">3×10<hi rend="sup">10</hi>  </num> cm per second.</p>
Schematron<num> elements should only have a corresp attribute if it's being used as a statistics placeholder
<sch:pattern> <sch:rule context="tei:num[@corresp]">  <sch:assert test="string-length(string(.)) = 0">ERROR: Nums with a corresp attribute must be empty.</sch:assert> </sch:rule> </sch:pattern>
Schematron<num> elements should only use the stats prefix for their @corresp.
<sch:pattern> <sch:rule context="tei:num[@corresp]">  <sch:assert test="every $token in tokenize(@corresp,'\s+') satisfies starts-with($token, 'stats:')">ERROR: All num corresp pointers must start with the stats prefix.</sch:assert> </sch:rule> </sch:pattern>
SchematronThe stat prefix should only be used in nums
<sch:pattern> <sch:rule context="tei:*[@*[matches(.,'stats:')]]">  <sch:assert test="self::tei:num and @corresp">ERROR: The stats: prefix should only be used    as a corresp value for num elements.</sch:assert> </sch:rule> </sch:pattern>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element num
{
   att.global.attributes,
   att.typed.attribute.subtype,
   att.ranging.attributes,
   attribute type { "cardinal" | "ordinal" | "fraction" | "percentage" }?,
   attribute value { text }?,
   macro.phraseSeq
}

Appendix A.1.90 <object>

<object> contains a description of a single identifiable physical object. [13.3.5. Objects]
Modulenamesdates
Attributes
Member of
Contained by
namesdates: listObject object
May contain
Note

The <object> element is a recent addition to the TEI P5 Guidelines as of version 3.5.0 and as such may be more prone to further revision in the next few releases as its use develops. This may be particularly evident where its contents have been borrowed from <msDesc> and have yet to be generalized from their use in the context of manuscript descriptions.

The <object> element may be used for describing any object, text-bearing or not, though where the textuality of the object is the primary concern or a collection is mostly composed of manuscripts, encoders may prefer the <msDesc> element (a more specific form of <object>) which may be used not only to describe manuscripts but any form of text-bearing objects such as early printed books.

Example
<listObject>  <object xml:id="Alfred_Jewel">   <objectIdentifier>    <country>United Kingdom</country>    <region>Oxfordshire</region>    <settlement>Oxford</settlement>    <institution>University of Oxford</institution>    <repository>Ashmolean Museum</repository>    <collection>English Treasures</collection>    <idno type="ashmolean">AN1836p.135.371</idno>    <idno type="wikipedia">https://en.wikipedia.org/wiki/Alfred_Jewel</idno>    <objectName>Alfred Jewel</objectName>   </objectIdentifier>   <physDesc>    <p> The Alfred Jewel is about 6.4 cm in length and is made of combination of filigreed <material>gold</material>        surrounding a polished teardrop shaped piece of transparent <material>quartz</material>. Underneath the rock        crystal is a cloisonné enamel image of a man with ecclesiastical symbols. The sides of the jewel holding the        crystal in place contain an openwork inscription saying "AELFRED MEC HEHT GEWYRCAN", meaning 'Alfred ordered        me made'. </p>   </physDesc>   <history>    <origin>It is generally accepted that the Alfred Jewel dates from the <origDate>late 9th Century</origDate> and        was most likely made in <origPlace>England</origPlace>. </origin>    <provenance when="1693">The jewel was discovered in 1693 at Petherton Park, North Petherton in the English        county of Somerset, on land owned by Sir Thomas Wroth. North Petherton is about 8 miles away from Athelney,        where King Alfred founded a monastery. </provenance>    <provenance when="1698">A description of the Alfred Jewel was first published in 1698, in the Philosophical        Transactions of the Royal Society.</provenance>    <acquisition> It was bequeathed to Oxford University by Colonel Nathaniel Palmer (c. 1661-1718) and today is in        the Ashmolean Museum in Oxford. </acquisition>   </history>  </object> </listObject> <!-- Elsewhere in document --> <p> The <objectName ref="#MinsterLovellJewel">Minster Lovell Jewel</objectName> is probably the most similar to the <objectName ref="#Alfred_Jewel">Alfred Jewel</objectName> and was found in <placeName ref="#MinsterLovell">Minster    Lovell</placeName> in <placeName ref="#Oxfordshire">Oxfordshire</placeName> and is kept at the <orgName ref="#AshmoleanMuseum">Ashmolean Museum</orgName>. </p>
Example
<listObject>  <object xml:id="MaskOfTutankhamun">   <objectIdentifier>    <objectName xml:lang="en">Mask of Tutankhamun</objectName>    <idno type="carter">256a</idno>    <idno type="JournalD'Entrée">60672</idno>    <idno type="exhibition">220</idno>    <institution>Museum of Egyptian Antiquities</institution>    <address>     <street>15 Meret Basha</street>     <district>Ismailia</district>     <settlement>Cairo</settlement>     <country>Egypt</country>     <location>      <geo>30.047778, 31.233333</geo>     </location>    </address>   </objectIdentifier>   <msContents>    <p>The back and shoulders of the mask is inscribed with a protective spell in Egyptian hieroglyphs formed of ten        vertical and horizontal lines. This spell first appeared on masks in the Middle Kingdom at least 500 years        before Tutankhamun, and comes from chapter 151 of the <title>Book of the Dead</title>.</p>   </msContents>   <physDesc>    <p> The mask of Tutankhamun is 54cm x 39.3cm x 49cm. It is constructed from two layers of high-karat gold that        varies in thickness from 1.5-3mm. It weighs approximately 10.23kg and x-ray crystallography shows that it is        composed of two alloys of gold with a lighter 18.4 karat shade being used for the face and neck while a heavier        22.5 karat gold was used for the rest of the mask.</p>    <p>In the mask Tutankhamun wears a nemes headcloth which has the royal insignia of a cobra (Wadjet) and vulture        (Nekhbet) on it. These are thought respectively to symbolize Tutankhamun's rule of both Lower Egypt and Upper        Egypt. His ears are pierced for earrings. The mask has rich inlays of coloured glass and gemstones, including        lapis lazuli surrounding the eye and eyebrows, quartz for the eyes, obsidian for the pupils. The broad collar is        made up of carnelian, feldspar, turquoise, amazonite, faience and other stones.</p>   </physDesc>   <history>    <origin>     <p>The mask of Tutankhamun was created in <origPlace>Egypt</origPlace> around <origDate when="-1323type="circa">1323 BC</origDate>. It is a death mask of the 18th-dynasty ancient Egyptian Pharaoh Tutankhamun          who reigned 1332–1323 BC. </p>    </origin>    <provenance>     <p>The mask of Tutankhamun was found in his burial chamber at Theban Necropolis in the Valley of the Kings in          1922. On 28 October 1925 the excavation team led by English archaeologist Howard Carter opened the heavy          sarcophagus and three coffins and were the first people in around 3,250 years to see the mask of Tutankhamun.          Carter wrote in his diary: <quote> The pins removed, the lid was raised. The penultimate scene was disclosed –            a very neatly wrapped mummy of the young king, with golden mask of sad but tranquil expression, symbolizing            Osiris … the mask bears that god's attributes, but the likeness is that of Tut.Ankh.Amen – placid and            beautiful, with the same features as we find upon his statues and coffins. The mask has fallen slightly            back, thus its gaze is straight up to the heavens. </quote>     </p>    </provenance>    <acquisition> In December 1925, the mask was removed from the tomb, placed in a crate and transported 635        kilometres (395 mi) to the Egyptian Museum in Cairo, where it remains on public display. </acquisition>   </history>   <additional>    <adminInfo>     <custodialHist>      <custEvent when="1944">When it was discovered in 1925, the 2.5kg narrow gold beard was no longer attached to            the mask and was reattached to the chin by use of a wooden dowel in 1944.</custEvent>      <custEvent when="2014-08"> In August 2014 when the mask was removed from its display case for cleaning, the            beard fell off again. Those working in the museum unadvisedly used a quick-drying epoxy to attempt to fix            it, but left the beard off-centre. </custEvent>      <custEvent when="2015-01">The damage was noticed and repaired in January 2015 by a German-Egyptian team who            used beeswax, a material known to be used as adhesives by the ancient Egyptians.</custEvent>     </custodialHist>    </adminInfo>   </additional>  </object> </listObject>
Content model
<content>
 <sequence>
  <elementRef key="objectIdentifier"
   minOccurs="1" maxOccurs="unbounded"/>
  <classRef key="model.headLike"
   minOccurs="0" maxOccurs="unbounded"/>
  <alternate>
   <classRef key="model.pLike"
    minOccurs="0" maxOccurs="unbounded"/>
   <sequence>
    <elementRef key="msContents"
     minOccurs="0"/>
    <elementRef key="physDesc"
     minOccurs="0"/>
    <elementRef key="history" minOccurs="0"/>
    <elementRef key="additional"
     minOccurs="0"/>
   </sequence>
  </alternate>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.noteLike"/>
   <classRef key="model.biblLike"/>
   <elementRef key="linkGrp"/>
   <elementRef key="link"/>
  </alternate>
  <elementRef key="object" minOccurs="0"
   maxOccurs="unbounded"/>
 </sequence>
</content>
    
Schema Declaration
element object
{
   att.global.attributes,
   att.sortable.attributes,
   att.typed.attributes,
   att.declaring.attributes,
   att.docStatus.attributes,
   att.canonical.attributes,
   (
      objectIdentifier+,
      model.headLike*,
      ( model.pLike* | ( msContents?, physDesc?, history?, additional? ) ),
      ( model.noteLike | model.biblLike | linkGrp | link )*,
      object*
   )
}

Appendix A.1.91 <objectIdentifier>

<objectIdentifier> (object identifier) groups one or more identifiers or pieces of locating information concerning a single object. [13.3.5. Objects]
Modulenamesdates
Attributes
Member of
Contained by
core: bibl
namesdates: object
May contain
core: address
header: idno
msdescription: repository
Example
<objectIdentifier>  <country>United Kingdom</country>  <region>Oxfordshire</region>  <settlement>Oxford</settlement>  <institution>University of Oxford</institution>  <repository>Ashmolean Museum</repository>  <collection>English Treasures</collection>  <idno type="ashmolean">AN1836p.135.371</idno>  <idno type="wikipedia">https://en.wikipedia.org/wiki/Alfred_Jewel</idno>  <objectName>Alfred Jewel</objectName> </objectIdentifier>
Example
<object xml:id="Excalibur-MultipleNames">  <objectIdentifier>   <objectName type="main">Excalibur</objectName>   <objectName type="alt">Caliburn</objectName>   <objectName xml:lang="cy">Caledfwlch</objectName>   <objectName xml:lang="cnx">Calesvol</objectName>   <objectName xml:lang="br">Kaledvoulc'h</objectName>   <objectName xml:lang="la">Caliburnus</objectName>   <country>Wales</country>  </objectIdentifier>  <p>Excalibur is the name for the legendary sword of King Arthur, in Welsh it is called Caledfwlch,    in Cornish it is called Calesvol, in Breton it is called Kaledvoulc'h, and in Latin it is called Caliburnus.    In some versions Excalibur's blade was engraved with phrases on opposite sides which in translation read:    "Take me up" and "Cast me away" (or similar).</p> </object>
Content model
<content>
 <alternate minOccurs="1"
  maxOccurs="unbounded">
  <classRef key="model.placeNamePart"/>
  <elementRef key="institution"/>
  <elementRef key="repository"/>
  <elementRef key="collection"/>
  <elementRef key="idno"/>
  <elementRef key="msName"/>
  <elementRef key="objectName"/>
  <elementRef key="altIdentifier"/>
  <elementRef key="address"/>
 </alternate>
</content>
    
Schema Declaration
element objectIdentifier
{
   att.global.attributes,
   (
      model.placeNamePart
    | institution
    | repository
    | collection
    | idno
    | msName
    | objectName
    | altIdentifier
    | address
   )+
}

Appendix A.1.92 <occupation>

<occupation> (occupation) contains an informal description of a person's trade, profession or occupation. [15.2.2. The Participant Description]
Modulenamesdates
Attributes
typecharacterizes the element in some sense, using any convenient classification scheme or typology.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Sample values include:
primary
other
paid
unpaid
schemeindicates the classification system or taxonomy in use, for example by supplying the identifier of a <taxonomy> element, or pointing to some other resource.
StatusOptional
Datatypeteidata.pointer
codeidentifies an occupation code defined within the classification system or taxonomy defined by the scheme attribute.
StatusOptional
Datatypeteidata.pointer
Member of
Contained by
namesdates: person
May contain
Note

The content of this element may be used as an alternative to the more formal specification made possible by its attributes; it may also be used to supplement the formal specification with commentary or clarification.

Example
<occupation>accountant</occupation>
Example
<occupation scheme="#occupationtaxonomy"  code="#acc">accountant</occupation>
Content model
<content>
 <macroRef key="macro.specialPara"/>
</content>
    
Schema Declaration
element occupation
{
   att.global.attributes,
   att.datable.attributes,
   att.editLike.attributes,
   att.naming.attributes,
   att.typed.attribute.subtype,
   attribute type { text }?,
   attribute scheme { text }?,
   attribute code { text }?,
   macro.specialPara
}

Appendix A.1.93 <opener>

<opener> (opener) groups together dateline, byline, salutation, and similar phrases appearing as a preliminary group at the start of a division, especially of a letter. [4.2. Elements Common to All Divisions]
Moduletextstructure
Attributes
Member of
Contained by
core: lg list
textstructure: body div
May contain
Example
<opener>  <dateline>Walden, this 29. of August 1592</dateline> </opener>
Example
<opener>  <dateline>   <name type="place">Great Marlborough Street</name>   <date>November 11, 1848</date>  </dateline>  <salute>My dear Sir,</salute> </opener> <p>I am sorry to say that absence from town and other circumstances have prevented me from earlier enquiring...</p>
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.gLike"/>
  <classRef key="model.phrase"/>
  <elementRef key="argument"/>
  <elementRef key="byline"/>
  <elementRef key="dateline"/>
  <elementRef key="epigraph"/>
  <elementRef key="salute"/>
  <elementRef key="signed"/>
  <classRef key="model.global"/>
 </alternate>
</content>
    
Schema Declaration
element opener
{
   att.global.attributes,
   att.written.attributes,
   (
      text
    | model.gLikemodel.phraseargument
    | byline
    | dateline
    | epigraph
    | salutesignedmodel.global
   )*
}

Appendix A.1.94 <org>

<org> (organization) provides information about an identifiable organization such as a business, a tribe, or any other grouping of people. [13.3.3. Organizational Data]
Modulenamesdates
Attributes
rolespecifies a primary role or classification for the organization.
StatusOptional
Datatype1–∞ occurrences of teidata.enumerated separated by whitespace
Note

Values for this attribute may be locally defined by a project, using arbitrary keywords such as artist, employer, familyGroup, or politicalParty, each of which should be associated with a definition. Such local definitions will typically be provided by a <desc> for each <valItem> element in the schema specification of the project's customization.

Member of
Contained by
namesdates: listOrg listPerson org
May contain
Example
<org xml:id="JAMs">  <orgName>Justified Ancients of Mummu</orgName>  <desc>An underground anarchist collective spearheaded by  <persName>Hagbard Celine</persName>, who fight the Illuminati    from a golden submarine, the <name>Leif Ericson</name>  </desc>  <bibl>   <author>Robert Shea</author>   <author>Robert Anton Wilson</author>   <title>The Illuminatus! Trilogy</title>  </bibl> </org>
Content model
<content>
 <sequence>
  <classRef key="model.headLike"
   minOccurs="0" maxOccurs="unbounded"/>
  <alternate>
   <classRef key="model.pLike"
    minOccurs="0" maxOccurs="unbounded"/>
   <alternate minOccurs="0"
    maxOccurs="unbounded">
    <classRef key="model.labelLike"/>
    <classRef key="model.nameLike"/>
    <classRef key="model.placeLike"/>
    <classRef key="model.orgPart"/>
    <classRef key="model.milestoneLike"/>
   </alternate>
  </alternate>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.noteLike"/>
   <classRef key="model.biblLike"/>
   <elementRef key="linkGrp"/>
   <elementRef key="link"/>
   <elementRef key="ptr"/>
  </alternate>
  <classRef key="model.personLike"
   minOccurs="0" maxOccurs="unbounded"/>
 </sequence>
</content>
    
Schema Declaration
element org
{
   att.global.attributes,
   att.typed.attributes,
   att.editLike.attributes,
   att.sortable.attributes,
   attribute role { list { + } }?,
   (
      model.headLike*,
      (
         model.pLike*
       | (
            model.labelLikemodel.nameLikemodel.placeLikemodel.orgPartmodel.milestoneLike
         )*
      ),
      ( model.noteLike | model.biblLike | linkGrp | link | ptr )*,
      model.personLike*
   )
}

Appendix A.1.95 <orgName>

<orgName> (organization name) contains an organizational name. [13.2.2. Organizational Names]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Example
About a year back, a question of considerable interest was agitated in the <orgName key="PAS1type="voluntary">  <placeName key="PEN">Pennsyla.</placeName> Abolition Society </orgName> [...]
SchematronThe pattern for orgName ref is org:[a-z]{4}\d+
<sch:pattern> <sch:rule context="tei:orgName[@ref]">  <sch:assert test="matches(@ref, '^org:[a-z]{4}\d+$')">The pattern for orgName @ref must start with "org:" followed by four letters and a number.</sch:assert> </sch:rule> </sch:pattern>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element orgName
{
   att.global.attributes,
   att.datable.attributes,
   att.editLike.attributes,
   att.personal.attributes,
   att.typed.attributes,
   macro.phraseSeq
}

Appendix A.1.96 <orig>

<orig> (original form) contains a reading which is marked as following the original, rather than being normalized or corrected. [3.5.2. Regularization and Normalization 12. Critical Apparatus]
Modulecore
Attributes
Member of
Contained by
May contain
ExampleIf all that is desired is to call attention to the original version in the copy text, <orig> may be used alone:
<l>But this will be a <orig>meere</orig> confusion</l> <l>And hardly shall we all be <orig>vnderstoode</orig> </l>
ExampleMore usually, an <orig> will be combined with a regularized form within a <choice> element:
<l>But this will be a <choice>   <orig>meere</orig>   <reg>mere</reg>  </choice> confusion</l> <l>And hardly shall we all be <choice>   <orig>vnderstoode</orig>   <reg>understood</reg>  </choice> </l>
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element orig { att.global.attributes, macro.paraContent }

Appendix A.1.97 <origin>

<origin> (origin) contains any descriptive or other information concerning the origin of a manuscript, manuscript part, or other object. [10.8. History]
Modulemsdescription
Attributes
Contained by
msdescription: history
May contain
Example
<origin notBefore="1802notAfter="1845"  evidence="internalresp="#AMH">Copied in <name type="origPlace">Derby</name>, probably from an old Flemish original, between 1802 and 1845, according to <persName xml:id="AMH">Anne-Mette Hansen</persName>. </origin>
Content model
<content>
 <macroRef key="macro.specialPara"/>
</content>
    
Schema Declaration
element origin
{
   att.global.attributes,
   att.editLike.attributes,
   att.datable.attributes,
   macro.specialPara
}

Appendix A.1.98 <p>

<p> (paragraph) marks paragraphs in prose. [3.1. Paragraphs 7.2.5. Speech Contents]
Modulecore
Attributes
Member of
Contained by
May contain
Example
<p>Hallgerd was outside. <q>There is blood on your axe,</q> she said. <q>What have you    done?</q> </p> <p>  <q>I have now arranged that you can be married a second time,</q> replied Thjostolf. </p> <p>  <q>Then you must mean that Thorvald is dead,</q> she said. </p> <p>  <q>Yes,</q> said Thjostolf. <q>And now you must think up some plan for me.</q> </p>
Schematron
<sch:report test="(ancestor::tei:ab or ancestor::tei:p) and not( ancestor::tei:floatingText |parent::tei:exemplum |parent::tei:item |parent::tei:note |parent::tei:q |parent::tei:quote |parent::tei:remarks |parent::tei:said |parent::tei:sp |parent::tei:stage |parent::tei:cell |parent::tei:figure )"> Abstract model violation: Paragraphs may not occur inside other paragraphs or ab elements. </sch:report>
Schematron
<sch:report test="(ancestor::tei:l or ancestor::tei:lg) and not( ancestor::tei:floatingText |parent::tei:figure |parent::tei:note )"> Abstract model violation: Lines may not contain higher-level structural elements such as div, p, or ab, unless p is a child of figure or note, or is a descendant of floatingText. </sch:report>
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element p
{
   att.global.attributes,
   att.declaring.attributes,
   att.fragmentable.attributes,
   att.written.attributes,
   macro.paraContent
}

Appendix A.1.99 <pb>

<pb> (page beginning) marks the beginning of a new page in a paginated document. [3.11.3. Milestone Elements]
Modulecore
Attributes
Member of
Contained by
May containEmpty element
Note

A <pb> element should appear at the start of the page which it identifies. The global n attribute indicates the number or other value associated with this page. This will normally be the page number or signature printed on it, since the physical sequence number is implicit in the presence of the <pb> element itself.

The type attribute may be used to characterize the page break in any respect. The more specialized attributes break, ed, or edRef should be preferred when the intent is to indicate whether or not the page break is word-breaking, or to note the source from which it derives.

ExamplePage numbers may vary in different editions of a text.
<p> ... <pb n="145ed="ed2"/> <!-- Page 145 in edition "ed2" starts here --> ... <pb n="283ed="ed1"/> <!-- Page 283 in edition "ed1" starts here--> ... </p>
ExampleA page break may be associated with a facsimile image of the page it introduces by means of the facs attribute
<body>  <pb n="1facs="page1.png"/> <!-- page1.png contains an image of the page; the text it contains is encoded here -->  <p> <!-- ... -->  </p>  <pb n="2facs="page2.png"/> <!-- similarly, for page 2 -->  <p> <!-- ... -->  </p> </body>
Content model
<content>
 <empty/>
</content>
    
Schema Declaration
element pb
{
   att.global.attributes,
   att.typed.attributes,
   att.edition.attributes,
   att.spanning.attributes,
   att.breaking.attributes,
   empty
}

Appendix A.1.100 <persName>

<persName> (personal name) contains a proper noun or proper-noun phrase referring to a person, possibly including one or more of the person's forenames, surnames, honorifics, added names, etc. [13.2.1. Personal Names]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Example
<persName>  <forename>Edward</forename>  <forename>George</forename>  <surname type="linked">Bulwer-Lytton</surname>, <roleName>Baron Lytton of  <placeName>Knebworth</placeName>  </roleName> </persName>
SchematronThe pattern for persName ref is either team:[a-z]{4}\d+ or prs:[a-z]{4}\d+
<sch:pattern> <sch:rule context="tei:persName[@ref]">  <sch:assert test="matches(@ref, '^(team:|prs:)[a-z]{4}\d+$')">The pattern for persName @ref must start with "team:" or "prs:" followed by four letters and a number.</sch:assert> </sch:rule> </sch:pattern>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element persName
{
   att.global.attributes,
   att.datable.attributes,
   att.editLike.attributes,
   att.personal.attributes,
   att.typed.attributes,
   macro.phraseSeq
}

Appendix A.1.101 <person>

<person> (person) provides information about an identifiable individual, for example a participant in a language interaction, or a person referred to in a historical source. [13.3.2. The Person Element 15.2.2. The Participant Description]
Modulenamesdates
Attributes
rolespecifies a primary role or classification for the person.
StatusOptional
Datatype1–∞ occurrences of teidata.enumerated separated by whitespace
Note

Values for this attribute may be locally defined by a project, using arbitrary keywords such as artist, employer, author, relative, or servant, each of which should be associated with a definition. Such local definitions will typically be provided by a <valList> element in the project schema specification.

sexspecifies the sex of the person.
StatusOptional
Datatype1–∞ occurrences of teidata.sex separated by whitespace
Note

Values for this attribute may be defined locally by a project, or they may refer to an external standard.

genderspecifies the gender of the person.
StatusOptional
Datatype1–∞ occurrences of teidata.gender separated by whitespace
Note

Values for this attribute may be defined locally by a project, or they may refer to an external standard.

agespecifies an age group for the person.
StatusOptional
Datatypeteidata.enumerated
Note

Values for this attribute may be locally defined by a project, using arbitrary keywords such as infant, child, teen, adult, or senior, each of which should be associated with a definition. Such local definitions will typically be provided by a <valList> element in the project schema specification.

Member of
Contained by
namesdates: listPerson org
May contain
Note

May contain either a prose description organized as paragraphs, or a sequence of more specific demographic elements drawn from the model.personPart class.

Example
<person sex="Fage="adult">  <p>Female respondent, well-educated, born in Shropshire UK, 12 Jan 1950, of unknown occupation. Speaks French fluently. Socio-Economic    status B2.</p> </person>
Example
<person sex="intersexrole="god"  age="immortal">  <persName>Hermaphroditos</persName>  <persName xml:lang="grc">Ἑρμαφρόδιτος</persName> </person>
Example
<person xml:id="Ovi01sex="Mrole="poet">  <persName xml:lang="en">Ovid</persName>  <persName xml:lang="la">Publius Ovidius Naso</persName>  <birth when="-0044-03-20"> 20 March 43 BC <placeName>    <settlement type="city">Sulmona</settlement>    <country key="IT">Italy</country>   </placeName>  </birth>  <death notBefore="0017notAfter="0018">17 or 18 AD <placeName>    <settlement type="city">Tomis (Constanta)</settlement>    <country key="RO">Romania</country>   </placeName>  </death> </person>
ExampleThe following exemplifies an adaptation of the vCard standard to indicate an unknown gender for a fictional character.
<person xml:id="arielgender="U">  <persName>Ariel</persName>  <note>Character in <title level="m">The Tempest</title>.</note> </person>
Content model
<content>
 <alternate>
  <classRef key="model.pLike" minOccurs="1"
   maxOccurs="unbounded"/>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.personPart"/>
   <classRef key="model.global"/>
   <elementRef key="ptr"/>
  </alternate>
 </alternate>
</content>
    
Schema Declaration
element person
{
   att.global.attributes,
   att.editLike.attributes,
   att.sortable.attributes,
   attribute role { list { + } }?,
   attribute sex { list { + } }?,
   attribute gender { list { + } }?,
   attribute age { text }?,
   ( model.pLike+ | ( model.personPart | model.global | ptr )* )
}

Appendix A.1.102 <physDesc>

<physDesc> (physical description) contains a full physical description of a manuscript, manuscript part, or other object optionally subdivided using more specialized elements from the model.physDescPart class. [10.7. Physical Description]
Modulemsdescription
Attributes
Contained by
msdescription: msDesc
namesdates: object
May contain
core: p
linking: ab
Example
<physDesc>  <objectDesc form="codex">   <supportDesc material="perg">    <support>Parchment.</support>    <extent>i + 55 leaves    <dimensions scope="alltype="leaf"      unit="inch">      <height></height>      <width>5⅜</width>     </dimensions>    </extent>   </supportDesc>   <layoutDesc>    <layout columns="2">In double columns.</layout>   </layoutDesc>  </objectDesc>  <handDesc>   <p>Written in more than one hand.</p>  </handDesc>  <decoDesc>   <p>With a few coloured capitals.</p>  </decoDesc> </physDesc>
Content model
<content>
 <sequence>
  <classRef key="model.pLike" minOccurs="0"
   maxOccurs="unbounded"/>
  <classRef key="model.physDescPart"
   expand="sequenceOptional"/>
 </sequence>
</content>
    
Schema Declaration
element physDesc { att.global.attributes, ( model.pLike* ) }

Appendix A.1.103 <place>

<place> (place) contains data about a geographic location [13.3.4. Places]
Modulenamesdates
Attributes
typecharacterizes the element in some sense, using any convenient classification scheme or typology.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Legal values are:
region
(The largest grouping within the Monument placeography.)
district
(The second-largest grouping within the Monument placeography, contained within a region.)
area
(The third-largest grouping within the Monument placeography, contained within a district or within a region.)
settlement
(The smallest grouping within the Monument placeography, normally contained by an area.)
Member of
Contained by
corpus: settingDesc
namesdates: listPlace org place
May contain
Example
<place>  <country>Lithuania</country>  <country xml:lang="lt">Lietuva</country>  <place>   <settlement>Vilnius</settlement>  </place>  <place>   <settlement>Kaunas</settlement>  </place> </place>
SchematronThe pattern for placeName ref is plc:[a-z]{4}\d+
<sch:pattern> <sch:rule context="tei:placeName[@ref]">  <sch:assert test="matches(@ref, '^plc:[a-z]{4}\d+$')">The pattern for placeName @ref must start with "plc:" followed by four letters and a number.</sch:assert> </sch:rule> </sch:pattern>
Schematron
<sch:pattern> <sch:rule context="tei:place[@type]">  <sch:assert test="child::tei:placeName"> ERROR: a place element must have a placeName.  </sch:assert>  <sch:assert test="not(@type='settlement') or child::tei:location[child::tei:geo]"> ERROR: a settlement must include a location element with a geo child.  </sch:assert> </sch:rule> </sch:pattern>
Schematron
<sch:pattern> <sch:rule context="tei:place[@type]">  <sch:assert test="not(@type='settlement') or parent::tei:place[@type='area']"> ERROR: a settlement must be a child of an area.  </sch:assert>  <sch:assert test="@type='region' or parent::tei:place[@type]"> ERROR: This type of place must be nested inside a larger place.  </sch:assert>  <sch:assert test="matches(@xml:id, '^mp[A-Z]')"> ERROR: a Monument place id must start with mp + a capital letter.  </sch:assert>  <sch:assert test="not(@type='district') or parent::tei:place[@type='region']"> ERROR: a district must be a child of a region.  </sch:assert>  <sch:assert test="not(@type='area') or parent::tei:place[@type=('district', 'region')]"> ERROR: an area must be a child of a district or a region.  </sch:assert> </sch:rule> </sch:pattern>
Content model
<content>
 <sequence minOccurs="1" maxOccurs="1">
  <classRef key="model.headLike"
   minOccurs="0" maxOccurs="unbounded"/>
  <alternate minOccurs="1" maxOccurs="1">
   <classRef key="model.pLike"
    minOccurs="0" maxOccurs="unbounded"/>
   <alternate minOccurs="0"
    maxOccurs="unbounded">
    <classRef key="model.labelLike"/>
    <classRef key="model.placeStateLike"/>
    <classRef key="model.eventLike"/>
    <elementRef key="name"/>
   </alternate>
  </alternate>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.noteLike"/>
   <classRef key="model.biblLike"/>
   <elementRef key="idno"/>
   <elementRef key="ptr"/>
   <elementRef key="linkGrp"/>
   <elementRef key="link"/>
  </alternate>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.placeLike"/>
   <elementRef key="listPlace"/>
  </alternate>
 </sequence>
</content>
    
Schema Declaration
element place
{
   att.global.attributes,
   att.typed.attribute.subtype,
   att.editLike.attributes,
   att.sortable.attributes,
   attribute type { "region" | "district" | "area" | "settlement" }?,
   (
      model.headLike*,
      (
         model.pLike*
       | ( model.labelLike | model.placeStateLike | model.eventLike | name )*
      ),
      ( model.noteLike | model.biblLike | idno | ptr | linkGrp | link )*,
      ( model.placeLike | listPlace )*
   )
}

Appendix A.1.104 <placeName>

<placeName> (place name) contains an absolute or relative place name. [13.2.3. Place Names]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Example
<placeName>  <settlement>Rochester</settlement>  <region>New York</region> </placeName>
Example
<placeName>  <geogName>Arrochar Alps</geogName>  <region>Argylshire</region> </placeName>
Example
<placeName>  <measure>10 miles</measure>  <offset>Northeast of</offset>  <settlement>Attica</settlement> </placeName>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element placeName
{
   att.datable.attributes,
   att.editLike.attributes,
   att.global.attributes,
   att.personal.attributes,
   att.typed.attributes,
   macro.phraseSeq
}

Appendix A.1.105 <postBox>

<postBox> (postal box or post office box) contains a number or other identifier for some postal delivery point other than a street address. [3.6.2. Addresses]
Modulecore
Attributes
Member of
Contained by
core: address
May containCharacter data only
Note

The position and nature of postal codes is highly country-specific; the conventions appropriate to the country concerned should be used.

Example
<postBox>P.O. Box 280</postBox>
Example
<postBox>Postbus 532</postBox>
Content model
<content>
 <textNode/>
</content>
    
Schema Declaration
element postBox { att.global.attributes, text }

Appendix A.1.106 <postCode>

<postCode> (postal code) contains a numerical or alphanumeric code used as part of a postal address to simplify sorting or delivery of mail. [3.6.2. Addresses]
Modulecore
Attributes
Member of
Contained by
core: address
May containCharacter data only
Note

The position and nature of postal codes is highly country-specific; the conventions appropriate to the country concerned should be used.

Example
<postCode>HR1 3LR</postCode>
Example
<postCode>60142-7</postCode>
Content model
<content>
 <textNode/>
</content>
    
Schema Declaration
element postCode { att.global.attributes, text }

Appendix A.1.107 <profileDesc>

<profileDesc> (text-profile description) provides a detailed description of non-bibliographic aspects of a text, specifically the languages and sublanguages used, the situation in which it was produced, the participants and their setting. [2.4. The Profile Description 2.1.1. The TEI Header and Its Components]
Moduleheader
Attributes
Contained by
header: teiHeader
May contain
Note

Although the content model permits it, it is rarely meaningful to supply multiple occurrences for any of the child elements of <profileDesc> unless these are documenting multiple texts.

Example
<profileDesc>  <langUsage>   <language ident="fr">French</language>  </langUsage>  <textDesc n="novel">   <channel mode="w">print; part issues</channel>   <constitution type="single"/>   <derivation type="original"/>   <domain type="art"/>   <factuality type="fiction"/>   <interaction type="none"/>   <preparedness type="prepared"/>   <purpose type="entertaindegree="high"/>   <purpose type="informdegree="medium"/>  </textDesc>  <settingDesc>   <setting>    <name>Paris, France</name>    <time>Late 19th century</time>   </setting>  </settingDesc> </profileDesc>
SchematronAll <profileDesc>s must, at minimum, include a <textClass>.
<sch:pattern> <sch:rule context="tei:profileDesc">  <sch:assert test="tei:textClass">ERROR: All documents must include a profileDesc with a textClass element child.</sch:assert> </sch:rule> </sch:pattern>
Content model
<content>
 <classRef key="model.profileDescPart"
  minOccurs="0" maxOccurs="unbounded"/>
</content>
    
Schema Declaration
element profileDesc { att.global.attributes, model.profileDescPart* }

Appendix A.1.108 <pubPlace>

<pubPlace> (publication place) contains the name of the place where a bibliographic item was published. [3.12.2.4. Imprint, Size of a Document, and Reprint Information]
Modulecore
Attributes
Member of
Contained by
core: bibl
May contain
Example
<publicationStmt>  <publisher>Oxford University Press</publisher>  <pubPlace>Oxford</pubPlace>  <date>1989</date> </publicationStmt>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element pubPlace
{
   att.global.attributes,
   att.naming.attributes,
   macro.phraseSeq
}

Appendix A.1.109 <publicationStmt>

<publicationStmt> (publication statement) groups information concerning the publication or distribution of an electronic or other text. [2.2.4. Publication, Distribution, Licensing, etc. 2.2. The File Description]
Moduleheader
Attributes
Contained by
header: fileDesc
May contain
Note

Where a publication statement contains several members of the model.publicationStmtPart.agency or model.publicationStmtPart.detail classes rather than one or more paragraphs or anonymous blocks, care should be taken to ensure that the repeated elements are presented in a meaningful order. It is a conformance requirement that elements supplying information about publication place, address, identifier, availability, and date be given following the name of the publisher, distributor, or authority concerned, and preferably in that order.

Example
<publicationStmt>  <publisher>C. Muquardt </publisher>  <pubPlace>Bruxelles &amp; Leipzig</pubPlace>  <date when="1846"/> </publicationStmt>
Example
<publicationStmt>  <publisher>Chadwyck Healey</publisher>  <pubPlace>Cambridge</pubPlace>  <availability>   <p>Available under licence only</p>  </availability>  <date when="1992">1992</date> </publicationStmt>
Example
<publicationStmt>  <publisher>Zea Books</publisher>  <pubPlace>Lincoln, NE</pubPlace>  <date>2017</date>  <availability>   <p>This is an open access work licensed under a Creative Commons Attribution 4.0 International license.</p>  </availability>  <ptr target="http://digitalcommons.unl.edu/zeabook/55"/> </publicationStmt>
Content model
<content>
 <alternate>
  <sequence minOccurs="1"
   maxOccurs="unbounded">
   <classRef key="model.publicationStmtPart.agency"/>
   <classRef key="model.publicationStmtPart.detail"
    minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
  <classRef key="model.pLike" minOccurs="1"
   maxOccurs="unbounded"/>
 </alternate>
</content>
    
Schema Declaration
element publicationStmt
{
   att.global.attributes,
   (
      (
         (
            model.publicationStmtPart.agency,
            model.publicationStmtPart.detail*
         )+
      )
    | model.pLike+
   )
}

Appendix A.1.110 <publisher>

<publisher> (publisher) provides the name of the organization responsible for the publication or distribution of a bibliographic item. [3.12.2.4. Imprint, Size of a Document, and Reprint Information 2.2.4. Publication, Distribution, Licensing, etc.]
Modulecore
Attributes
Member of
Contained by
core: bibl
May contain
Note

Use the full form of the name by which a company is usually referred to, rather than any abbreviation of it which may appear on a title page

Example
<imprint>  <pubPlace>Oxford</pubPlace>  <publisher>Clarendon Press</publisher>  <date>1987</date> </imprint>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element publisher
{
   att.global.attributes,
   att.canonical.attributes,
   macro.phraseSeq
}

Appendix A.1.111 <q>

<q> (quoted) contains material which is distinguished from the surrounding text using quotation marks or a similar method, for any one of a variety of reasons including, but not limited to: direct speech or thought, technical terms or jargon, authorial distance, quotations from elsewhere, and passages that are mentioned but not used. [3.3.3. Quotation]
Modulecore
Attributes
type(type) may be used to indicate whether the offset passage is spoken or thought, or to characterize it more finely.
StatusOptional
Datatypeteidata.enumerated
Suggested values include:
spoken
(spoken) representation of speech
thought
(thought) representation of thought, e.g. internal monologue
written
(written) quotation from a written source
soCalled
(so called) authorial distance
foreign
(foreign)
distinct
(distinct) linguistically distinct
term
technical term
emph
(emph) rhetorically emphasized
mentioned
(mentioned) refering to itself, not its normal referent
Member of
Contained by
May contain
Note

May be used to indicate that a passage is distinguished from the surrounding text for reasons concerning which no claim is made. When used in this manner, <q> may be thought of as syntactic sugar for <hi> with a value of rend that indicates the use of such mechanisms as quotation marks.

Example
It is spelled <q>Tübingen</q> — to enter the letter <q>u</q> with an umlaut hold down the <q>option</q> key and press <q>0 0 f c</q>
Content model
<content>
 <macroRef key="macro.specialPara"/>
</content>
    
Schema Declaration
element q
{
   att.global.attributes,
   att.ascribed.directed.attributes,
   attribute type
   {
      "spoken"
    | "thought"
    | "written"
    | "soCalled"
    | "foreign"
    | "distinct"
    | "term"
    | "emph"
    | "mentioned"
   }?,
   macro.specialPara
}

Appendix A.1.112 <quote>

<quote> (quotation) contains a phrase or passage attributed by the narrator or author to some agency external to the text. [3.3.3. Quotation 4.3.1. Grouped Texts]
Modulecore
Attributes
Member of
Contained by
May contain
Note

If a bibliographic citation is supplied for the source of a quotation, the two may be grouped using the <cit> element.

Example
Lexicography has shown little sign of being affected by the work of followers of J.R. Firth, probably best summarized in his slogan, <quote>You shall know a word by the company it keeps</quote> <ref>(Firth, 1957)</ref>
Content model
<content>
 <macroRef key="macro.specialPara"/>
</content>
    
Schema Declaration
element quote
{
   att.global.attributes,
   att.typed.attributes,
   att.msExcerpt.attributes,
   att.notated.attributes,
   macro.specialPara
}

Appendix A.1.113 <recording>

<recording> (recording event) provides details of an audio or video recording event used as the source of a spoken text, either directly or from a public broadcast. [8.2. Documenting the Source of Transcribed Speech 15.3.2. Declarable Elements]
Modulespoken
Attributes
typethe kind of recording.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Legal values are:
audio
audio recording[Default]
video
audio and video recording
Contained by
May contain
Note

The dur attribute is used to indicate the original duration of the recording.

Example
<recording type="audiodur="P30M">  <equipment>   <p>Recorded on a Sony TR444 walkman by unknown participants; remastered      to digital tape at <placeName>Borehamwood Studios</placeName> by   <orgName>Transcription Services Inc</orgName>.</p>  </equipment> </recording>
Example
<recording type="audiodur="P10M">  <equipment>   <p>Recorded from FM Radio to digital tape</p>  </equipment>  <broadcast>   <bibl>    <title>Interview on foreign policy</title>    <author>BBC Radio 5</author>    <respStmt>     <resp>interviewer</resp>     <name>Robin Day</name>    </respStmt>    <respStmt>     <resp>interviewee</resp>     <name>Margaret Thatcher</name>    </respStmt>    <series>     <title>The World Tonight</title>    </series>    <note>First broadcast on    <date when="1989-11-27">27 Nov 89</date>    </note>   </bibl>  </broadcast> </recording>
Content model
<content>
 <sequence minOccurs="1" maxOccurs="1">
  <elementRef key="date"/>
  <elementRef key="equipment"/>
  <elementRef key="media"/>
  <elementRef key="respStmt" minOccurs="0"
   maxOccurs="unbounded"/>
 </sequence>
</content>
    
Schema Declaration
element recording
{
   att.global.attributes,
   att.declarable.attributes,
   att.duration.attributes,
   att.typed.attribute.subtype,
   attribute type { "audio" | "video" }?,
   ( date, equipment, media, respStmt* )
}

Appendix A.1.114 <recordingStmt>

<recordingStmt> (recording statement) describes a set of recordings used as the basis for transcription of a spoken text. [8.2. Documenting the Source of Transcribed Speech 2.2.7. The Source Description]
Modulespoken
Attributes
Member of
Contained by
header: sourceDesc
May contain
spoken: recording
Example
<recordingStmt>  <recording type="audiodur="P30M">   <respStmt>    <resp>Location recording by</resp>    <name>Sound Services Ltd.</name>   </respStmt>   <equipment>    <p>Multiple close microphones mixed down to stereo Digital        Audio Tape, standard play, 44.1 KHz sampling frequency</p>   </equipment>   <date>12 Jan 1987</date>  </recording> </recordingStmt>
Example
<recordingStmt>  <p>Three    distinct recordings made by hidden microphone in early February    2001.</p> </recordingStmt>
Content model
<content>
 <elementRef key="recording"/>
</content>
    
Schema Declaration
element recordingStmt { att.global.attributes, recording }

Appendix A.1.115 <ref>

<ref> (reference) defines a reference to another location, possibly modified by additional text or comment. [3.7. Simple Links and Cross-References 16.1. Links]
Modulecore
Attributes
Member of
Contained by
May contain
Note

The target and cRef attributes are mutually exclusive.

Example
See especially <ref target="http://www.natcorp.ox.ac.uk/Texts/A02.xml#s2">the second sentence</ref>
Example
See also <ref target="#locution">s.v. <term>locution</term> </ref>.
Schematron
<sch:report test="@target and @cRef">Only one of the attributes @target' and @cRef' may be supplied on <sch:name/> </sch:report>
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element ref
{
   att.cReferencing.attributes,
   att.declaring.attributes,
   att.global.attributes,
   att.internetMedia.attributes,
   att.pointing.attributes,
   att.typed.attributes,
   macro.paraContent
}

Appendix A.1.116 <reg>

<reg> (regularization) contains a reading which has been regularized or normalized in some sense. [3.5.2. Regularization and Normalization 12. Critical Apparatus]
Modulecore
Attributes
Member of
Contained by
May contain
ExampleIf all that is desired is to call attention to the fact that the copy text has been regularized, <reg> may be used alone:
<q>Please <reg>knock</reg> if an <reg>answer</reg> is <reg>required</reg> </q>
ExampleIt is also possible to identify the individual responsible for the regularization, and, using the <choice> and <orig> elements, to provide both the original and regularized readings:
<q>Please <choice>   <reg resp="#LB">knock</reg>   <orig>cnk</orig>  </choice> if an <choice>   <reg>answer</reg>   <orig>nsr</orig>  </choice> is <choice>   <reg>required</reg>   <orig>reqd</orig>  </choice> </q>
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element reg
{
   att.global.attributes,
   att.editLike.attributes,
   att.typed.attributes,
   macro.paraContent
}

Appendix A.1.117 <region>

<region> (region) contains the name of an administrative unit such as a state, province, or county, larger than a settlement, but smaller than a country. [13.2.3. Place Names]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Example
<placeName>  <region type="staten="IL">Illinois</region> </placeName>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element region
{
   att.global.attributes,
   att.naming.attributes,
   att.typed.attributes,
   att.datable.attributes,
   macro.phraseSeq
}

Appendix A.1.118 <relatedItem>

<relatedItem> contains or references some other bibliographic item which is related to the present one in some specified manner, for example as a constituent or alternative version of it. [3.12.2.7. Related Items]
Modulecore
Attributes
targetpoints to the related bibliographic element by means of an absolute or relative URI reference
StatusOptional
Datatypeteidata.pointer
Member of
Contained by
core: bibl
header: notesStmt
May contain
core: bibl ref
msdescription: msDesc
Note

If the target attribute is used to reference the related bibliographic item, the element must be empty.

Example
<biblStruct>  <monogr>   <author>Shirley, James</author>   <title type="main">The gentlemen of Venice</title>   <imprint>    <pubPlace>New York</pubPlace>    <publisher>Readex Microprint</publisher>    <date>1953</date>   </imprint>   <extent>1 microprint card, 23 x 15 cm.</extent>  </monogr>  <series>   <title>Three centuries of drama: English, 1642–1700</title>  </series>  <relatedItem type="otherForm">   <biblStruct>    <monogr>     <author>Shirley, James</author>     <title type="main">The gentlemen of Venice</title>     <title type="sub">a tragi-comedie presented at the private house in Salisbury          Court by Her Majesties servants</title>     <imprint>      <pubPlace>London</pubPlace>      <publisher>H. Moseley</publisher>      <date>1655</date>     </imprint>     <extent>78 p.</extent>    </monogr>   </biblStruct>  </relatedItem> </biblStruct>
Schematron
<sch:report test="@target and count( child::* ) > 0">If the @target attribute on <sch:name/> is used, the relatedItem element must be empty</sch:report> <sch:assert test="@target or child::*">A relatedItem element should have either a 'target' attribute or a child element to indicate the related bibliographic item</sch:assert>
Content model
<content>
 <alternate minOccurs="0">
  <classRef key="model.biblLike"/>
  <classRef key="model.ptrLike"/>
 </alternate>
</content>
    
Schema Declaration
element relatedItem
{
   att.global.attributes,
   att.typed.attributes,
   attribute target { text }?,
   ( model.biblLike | model.ptrLike )?
}

Appendix A.1.119 <relation>

<relation> (relationship) describes any kind of relationship or linkage amongst a specified group of places, events, persons, objects or other items. [13.3.2.3. Personal Relationships]
Modulenamesdates
Attributes
namesupplies a name for the kind of relationship of which this is an instance.
StatusOptional
Datatypeteidata.enumerated
activeidentifies the ‘active’ participants in a non-mutual relationship, or all the participants in a mutual one.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
mutualsupplies a list of participants amongst all of whom the relationship holds equally.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
passiveidentifies the ‘passive’ participants in a non-mutual relationship.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Contained by
May contain
core: desc
Note

Only one of the attributes active and mutual may be supplied; the attribute passive may be supplied only if the attribute active is supplied. Not all of these constraints can be enforced in all schema languages.

Example
<relation type="socialname="supervisor"  active="#p1passive="#p2 #p3 #p4"/>
This indicates that the person with identifier p1 is supervisor of persons p2, p3, and p4.
Example
<relation type="personalname="friends"  mutual="#p2 #p3 #p4"/>
This indicates that p2, p3, and p4 are all friends.
Example
<relation type="CRM"  name="P89_falls_within"  active="http://id.clarosnet.org/places/metamorphoses/place/italy-orvieto"  passive="http://id.clarosnet.org/places/metamorphoses/country/IT"/>
This indicates that there is a relation, defined by CIDOC CRM, between two resources identified by URLs.
Example
<relation resp="http://viaf.org/viaf/44335536/"  ref="http://purl.org/saws/ontology#isVariantOf"  active="http://www.ancientwisdoms.ac.uk/cts/urn:cts:greekLit:tlg3017.Syno298.sawsGrc01:divedition.divsection1.o14.a107"  passive="http://data.perseus.org/citations/urn:cts:greekLit:tlg0031.tlg002.perseus-grc1:9.35"/>
This example records a relationship, defined by the SAWS ontology, between a passage of text identified by a CTS URN, and a variant passage of text in the Perseus Digital Library, and assigns the identification of the relationship to a particular editor (all using resolvable URIs).
Schematron
<sch:assert test="@ref or @key or @name">One of the attributes 'name', 'ref' or 'key' must be supplied</sch:assert>
Schematron
<sch:report test="@active and @mutual">Only one of the attributes @active and @mutual may be supplied</sch:report>
Schematron
<sch:report test="@passive and not(@active)">the attribute 'passive' may be supplied only if the attribute 'active' is supplied</sch:report>
Content model
<content>
 <elementRef key="desc" minOccurs="0"/>
</content>
    
Schema Declaration
element relation
{
   att.global.attributes,
   att.datable.attributes,
   att.editLike.attributes,
   att.canonical.attributes,
   att.sortable.attributes,
   att.typed.attributes,
   attribute name { text }?,
   ( attribute active { list { + } }? | attribute mutual { list { + } }? ),
   attribute passive { list { + } }?,
   desc?
}

Appendix A.1.120 <repository>

<repository> (repository) contains the name of a repository within which manuscripts or other objects are stored, possibly forming part of an institution. [10.4. The Manuscript Identifier]
Modulemsdescription
Attributes
Contained by
msdescription: msIdentifier
namesdates: objectIdentifier
May contain
Example
<msIdentifier>  <settlement>Oxford</settlement>  <institution>University of Oxford</institution>  <repository>Bodleian Library</repository>  <idno>MS. Bodley 406</idno> </msIdentifier>
Content model
<content>
 <macroRef key="macro.phraseSeq.limited"/>
</content>
    
Schema Declaration
element repository
{
   att.global.attributes,
   att.naming.attributes,
   macro.phraseSeq.limited
}

Appendix A.1.121 <residence>

<residence> (residence) describes a person's present or past places of residence. [15.2.2. The Participant Description]
Modulenamesdates
Attributes
typecharacterizes the element in some sense, using any convenient classification scheme or typology.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Legal values are:
natal
(The birth location of a Japanese Canadian child born during internment.)
original
(Original residence location of a Japanese Canadian prior to being uprooted.)
uprooted
(A location to which an uprooted Japanese Canadian was relocated.)
Member of
Contained by
namesdates: person
May contain
Example
<residence>Childhood in East Africa and long term resident of Glasgow, Scotland.</residence>
Example
<residence notAfter="1997">Mbeni estate, Dzukumura region, Matabele land</residence> <residence notBefore="1903notAfter="1996">  <placeName>   <settlement>Glasgow</settlement>   <region>Scotland</region>  </placeName> </residence>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element residence
{
   att.global.attributes,
   att.datable.attributes,
   att.editLike.attributes,
   att.naming.attributes,
   att.typed.attribute.subtype,
   attribute type { "natal" | "original" | "uprooted" }?,
   macro.phraseSeq
}

Appendix A.1.122 <resp>

<resp> (responsibility) contains a phrase describing the nature of a person's intellectual responsibility, or an organization's role in the production or distribution of a work. [3.12.2.2. Titles, Authors, and Editors 2.2.1. The Title Statement 2.2.2. The Edition Statement 2.2.5. The Series Statement]
Modulecore
Attributes
ref(reference) provides an explicit means of locating a full definition or identity for the entity being named by means of one or more URIs.
Derived fromatt.canonical
StatusRequired
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Legal values are:
resp:aut
(A person, family, or organization responsible for creating a work that is primarily textual in content, regardless of media type (e.g., printed text, spoken word, electronic text, tactile text) or genre (e.g., poems, novels, screenplays, blogs). Use also for persons, etc., creating a new work by paraphrasing, rewriting, or adapting works by another creator such that the modification has substantially changed the nature and content of the original or changed the medium of expression.) Author
resp:edt
(A person, family, or organization contributing to a resource by revising or elucidating the content, e.g., adding an introduction, notes, or other critical matter. An editor may also prepare a resource for production, publication, or distribution. For major revisions, adaptations, etc., that substantially change the nature and content of the original work, resulting in a new work, see author) Editor
resp:cre
(A person or organization responsible for the intellectual or artistic content of a resource.) Creator
resp:col
(A curator who brings together items from various sources that are then arranged, described, and cataloged as a collection. A collector is neither the creator of the material nor a person to whom manuscripts in the collection may have been addressed.) Collector
resp:ive
(A person, family or organization responsible for creating or contributing to a resource by responding to an interviewer, usually a reporter, pollster, or some other information gathering agent.) Interviewee
resp:ivr
(A person, family, or organization responsible for creating or contributing to a resource by acting as an interviewer, reporter, pollster, or some other information gathering agent.) Interviewer
resp:mda
(A team member responsibile for authoring and researching parts of a metadata record, outside of the context of the holding institution.) Metadata Author
resp:mdc
(A person or organization primarily responsible for compiling and maintaining the original description of a metadata set.) Metadata Contact
resp:mrk
(A person or organization performing the coding of SGML, HTML, or XML markup of metadata, text, etc.) Markup Editor
resp:oth
(A role that has no equivalent. CONSULT WITH TECHNICAL TEAM BEFORE USING.) Other
resp:pfr
(A person who corrects printed matter.) Proofreader
resp:prg
(A person, family, or organization responsible for creating a computer program.) Programmer
resp:res
(A person or organization responsibile for performing research.) Researcher
resp:trc
(A person, family, or organization contributing to a resource by changing it from one system of notation to another.) Transcriber
resp:trl
(A person or organization who renders a text from one language into another, or from an older form of a language into the modern form.) Translator
Contained by
core: respStmt
May contain
Note

The attribute ref, inherited from the class att.canonical may be used to indicate the kind of responsibility in a normalized form by referring directly to a standardized list of responsibility types, such as that maintained by a naming authority, for example the list maintained at http://www.loc.gov/marc/relators/relacode.html for bibliographic usage.

Example
<respStmt>  <resp ref="http://id.loc.gov/vocabulary/relators/com.html">compiler</resp>  <name>Edward Child</name> </respStmt>
SchematronA resp in a respStmt shouldn't contain a persName; right now, we flag these as errors in the schematron, but this should be made more explicit once we're finished.
<sch:pattern> <sch:rule context="tei:respStmt/tei:resp">  <sch:assert test="not(tei:persName)">ERROR: Responsibility statements should not include the person's name in the <resp>; the the <persName> element should be a child of <respStmt> with the resp giving a statement of responsibility (i.e. Transcribed by).</sch:assert> </sch:rule> </sch:pattern>
Content model
<content>
 <macroRef key="macro.phraseSeq.limited"/>
</content>
    
Schema Declaration
element resp
{
   att.global.attributes,
   att.canonical.attribute.key,
   att.datable.attributes,
   attribute ref
   {
      list
      {
         (
            "resp:aut"
          | "resp:edt"
          | "resp:cre"
          | "resp:col"
          | "resp:ive"
          | "resp:ivr"
          | "resp:mda"
          | "resp:mdc"
          | "resp:mrk"
          | "resp:oth"
          | "resp:pfr"
          | "resp:prg"
          | "resp:res"
          | "resp:trc"
          | "resp:trl"
         )+
      }
   },
   macro.phraseSeq.limited
}

Appendix A.1.123 <respStmt>

<respStmt> (statement of responsibility) supplies a statement of responsibility for the intellectual content of a text, edition, recording, or series, where the specialized elements for authors, editors, etc. do not suffice or do not apply. May also be used to encode information about individuals or organizations which have played a role in the production or distribution of a bibliographic work. [3.12.2.2. Titles, Authors, and Editors 2.2.1. The Title Statement 2.2.2. The Edition Statement 2.2.5. The Series Statement]
Modulecore
Attributes
Member of
Contained by
core: bibl
header: titleStmt
msdescription: msItem
spoken: recording
May contain
core: resp
namesdates: orgName persName
Note

We constrain the content of <respStmt> to follow the strict order of <resp> and then <persName> or <orgName>.

Example
<respStmt>  <resp>transcribed from original ms</resp>  <persName>Claus Huitfeldt</persName> </respStmt>
Example
<respStmt>  <resp>converted to XML encoding</resp>  <name>Alan Morrison</name> </respStmt>
SchematronA name in a respStmt should not include the word "and" or have an ampersand; those should be split into multiple respStmts.
<sch:pattern> <sch:rule context="tei:respStmt/tei:persName | tei:respStmt/tei:orgName">  <sch:let name="text"   value="string-join(descendant::text(),'')"/>  <sch:assert test="not(matches($text,'\s+(and|&amp;)\s+'))">ERROR: Do not combine multiple names into    one respStmt. Split these into multiple respStmts if more than one person applies to this resp.</sch:assert> </sch:rule> </sch:pattern>
SchematronA name in a respStmt should not include the word "and" or have an ampersand; those should be split into multiple respStmts.
<sch:pattern> <sch:rule context="tei:respStmt/tei:persName | tei:respStmt/tei:orgName">  <sch:assert test="@ref">ERROR: persName/orgName in a respStmt must have a ref pointing to the    responsible person/org.</sch:assert> </sch:rule> </sch:pattern>
SchematronA name in a respStmt should not include the word "and" or have an ampersand; those should be split into multiple respStmts.
<sch:pattern> <sch:rule context="tei:respStmt/tei:persName | tei:respStmt/tei:orgName">  <sch:let name="text"   value="string-join(descendant::text(),'')"/>  <sch:assert test="not(matches($text,','))">ERROR: Names in respStmts should be regularized (i.e. FORENAME SURNAME not SURNAME, FORENAME).</sch:assert> </sch:rule> </sch:pattern>
Content model
<content>
 <sequence minOccurs="1" maxOccurs="1">
  <elementRef key="resp"/>
  <alternate minOccurs="1" maxOccurs="1">
   <elementRef key="persName"/>
   <elementRef key="orgName"/>
  </alternate>
 </sequence>
</content>
    
Schema Declaration
element respStmt
{
   att.global.attributes,
   att.canonical.attributes,
   ( resp, ( persName | orgName ) )
}

Appendix A.1.124 <revisionDesc>

<revisionDesc> (revision description) summarizes the revision history for a file. [2.6. The Revision Description 2.1.1. The TEI Header and Its Components]
Moduleheader
Attributes
Contained by
header: teiHeader
May contain
core: list
header: change
Note

If present on this element, the status attribute should indicate the current status of the document. The same attribute may appear on any <change> to record the status at the time of that change. Conventionally <change> elements should be given in reverse date order, with the most recent change at the start of the list.

Example
<revisionDesc status="embargoed">  <change when="1991-11-11who="#LB"> deleted chapter 10 </change> </revisionDesc>
Content model
<content>
 <alternate>
  <elementRef key="list"/>
  <elementRef key="listChange"/>
  <elementRef key="change" minOccurs="1"
   maxOccurs="unbounded"/>
 </alternate>
</content>
    
Schema Declaration
element revisionDesc
{
   att.global.attributes,
   att.docStatus.attributes,
   ( list | listChange | change+ )
}

Appendix A.1.125 <roleName>

<roleName> (role name) contains a name component which indicates that the referent has a particular role or position in society, such as an official title or rank. [13.2.1. Personal Names]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Note

A <roleName> may be distinguished from an <addName> by virtue of the fact that, like a title, it typically exists independently of its holder.

Example
<persName>  <forename>William</forename>  <surname>Poulteny</surname>  <roleName>Earl of Bath</roleName> </persName>
Example
<p>The <roleName role="solicitor_general">S.G.</roleName> is the only national public official, including the Supreme Court justices, required by statute to be “learned in the law.”</p>
Example
<p>  <persName ref="#NJF">   <roleName role="solicitor_general">Solicitor General</roleName> Noel J. Francisco</persName>, representing the administration, asserted in rebuttal that there was nothing to disavow (...) <persName ref="#NJF">Francisco</persName> had violated the scrupulous standard of candor about the facts and the law that <roleName role="solicitor_general">S.G.s</roleName>, in Republican and Democratic administrations alike, have repeatedly said they must honor. </p>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element roleName
{
   att.global.attributes,
   att.personal.attributes,
   att.typed.attributes,
   macro.phraseSeq
}

Appendix A.1.126 <row>

<row> (row) contains one row of a table. [14.1.1. TEI Tables]
Modulefigures
Attributes
Contained by
figures: table
May contain
figures: cell
Example
<row role="data">  <cell role="label">Classics</cell>  <cell>Idle listless and unimproving</cell> </row>
Content model
<content>
 <elementRef key="cell" minOccurs="1"
  maxOccurs="unbounded"/>
</content>
    
Schema Declaration
element row { att.global.attributes, att.tableDecoration.attributes, cell+ }

Appendix A.1.127 <rs>

<rs> (referencing string) contains a general purpose name or referring string. [13.2.1. Personal Names 3.6.1. Referring Strings]
Modulecore
Attributes
Member of
Contained by
May contain
Example
<q>My dear <rs type="person">Mr. Bennet</rs>, </q> said <rs type="person">his lady</rs> to him one day, <q>have you heard that <rs type="place">Netherfield Park</rs> is let at last?</q>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element rs
{
   att.global.attributes,
   att.naming.attributes,
   att.typed.attributes,
   macro.phraseSeq
}

Appendix A.1.128 <salute>

<salute> (salutation) contains a salutation or greeting prefixed to a foreword, dedicatory epistle, or other division of a text, or the salutation in the closing of a letter, preface, etc. [4.2.2. Openers and Closers]
Moduletextstructure
Attributes
Member of
Contained by
core: lg list
figures: table
textstructure: body closer div opener
May contain
Example
<salute>To all courteous mindes, that will voutchsafe the readinge.</salute>
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element salute
{
   att.global.attributes,
   att.written.attributes,
   macro.paraContent
}

Appendix A.1.129 <samplingDecl>

<samplingDecl> (sampling declaration) contains a prose description of the rationale and methods used in sampling texts in the creation of a corpus or collection. [2.3.2. The Sampling Declaration 2.3. The Encoding Description 15.3.2. Declarable Elements]
Moduleheader
Attributes
Member of
Contained by
header: encodingDesc
May contain
core: p
linking: ab
Note

This element records all information about systematic inclusion or omission of portions of the text, whether a reflection of sampling procedures in the pure sense or of systematic omission of material deemed either too difficult to transcribe or not of sufficient interest.

Example
<samplingDecl>  <p>Samples of up to 2000 words taken at random from the beginning, middle, or end of each    text identified as relevant by respondents.</p> </samplingDecl>
Content model
<content>
 <classRef key="model.pLike" minOccurs="1"
  maxOccurs="unbounded"/>
</content>
    
Schema Declaration
element samplingDecl
{
   att.global.attributes,
   att.declarable.attributes,
   model.pLike+
}

Appendix A.1.130 <seg>

<seg> (arbitrary segment) represents any segmentation of text below the ‘chunk’ level. [16.3. Blocks, Segments, and Anchors 6.2. Components of the Verse Line 7.2.5. Speech Contents]
Modulelinking
Attributes
ana(Restrictions on material of a sensitive nature.) This attribute flags records in our database that may contain sensitive, personal or defamatory information. These classes of ana identify the type and severity of the restriction applied.
StatusOptional
Datatype1–∞ occurrences of  separated by whitespace
Legal values are:
sens:illness
(Details or graphic images of serious illness (mental or physical) or mortality of identifiable individual(s).) Illness label
sens:youth
(Details of serious anti-social activity or illness of youth under age of 18.) Youth label
sens:implicate
(Defaming or implicating identifiable individual(s) who were not part of document creation.) Implicate label
sens:criminal
(Details of potentially serious or violent criminal activity, especially violence.) Criminal label
sens:stereotype
(Egregious stereotyping (positive or negative) of a culture, group or person (beyond outdated language), especially vulnerable individual(s)/group(s).) Stereotype label
sens:cultural
(Could be considered private by community for cultural reasons.) Cultural label
sens:dishonour
(Could cause undue or disproportionate dishonour / embarrassment to self or family.) Dishonour label
sens:details
(Current personal identifying details (such as contact info).) Details label
subtype
StatusOptional
Datatype1–∞ occurrences of token separated by whitespace
Member of
Contained by
May contain
Note

The <seg> element may be used at the encoder's discretion to mark any segments of the text of interest for processing. One use of the element is to mark text features for which no appropriate markup is otherwise defined. Another use is to provide an identifier for some segment which is to be pointed at by some other element—i.e. to provide a target, or a part of a target, for a <ptr> or other similar element.

Example
<seg>When are you leaving?</seg> <seg>Tomorrow.</seg>
Example
<s>  <seg rend="capstype="initial-cap">So father's only</seg> glory was the ballfield. </s>
Example
<seg type="preamble">  <seg>Sigmund, <seg type="patronym">the son of Volsung</seg>, was a king in Frankish country.</seg>  <seg>Sinfiotli was the eldest of his sons ...</seg>  <seg>Borghild, Sigmund's wife, had a brother ... </seg> </seg>
SchematronA seg in the about pages must have type snippet
<sch:pattern> <sch:rule context="tei:seg[ancestor::tei:TEI[matches(@xml:id,'^loi.+_captions$')]]">  <sch:assert test="@type='snippet'">The seg in a caption document must have the type 'snippet'</sch:assert> </sch:rule> </sch:pattern>
SchematronA snippet seg must only be in caption docs
<sch:pattern> <sch:rule context="tei:seg[@type='snippet']">  <sch:assert test="ancestor::tei:TEI[matches(@xml:id,'^loi.+_captions$')]"> ERROR: A snippet seg should only be in the caption document  </sch:assert> </sch:rule> </sch:pattern>
SchematronA snippet seg must only be in caption docs
<sch:pattern> <sch:rule context="tei:seg[@type='snippet'][ancestor::tei:TEI[matches(@xml:id,'^loi.+_captions$')]]">  <sch:assert test="ancestor::tei:div[matches(@xml:id,'_about$')]"> ERROR: Snippet segs should only be in the about div.  </sch:assert> </sch:rule> </sch:pattern>
SchematronA snippet seg must only be in caption docs
<sch:pattern> <sch:rule context="tei:div[matches(@xml:id,'_about')][ancestor::tei:TEI[matches(@xml:id,'^loi.+_captions$')]]">  <sch:assert test="count(tei:seg[@type='snippet']) lt 2"> ERROR: Each about div should only have ONE snippet.  </sch:assert> </sch:rule> </sch:pattern>
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element seg
{
   att.global.attribute.xmlid,
   att.global.attribute.n,
   att.global.attribute.xmllang,
   att.global.attribute.xmlbase,
   att.global.attribute.xmlspace,
   att.global.rendition.attribute.rend,
   att.global.rendition.attribute.style,
   att.global.rendition.attribute.rendition,
   att.global.linking.attribute.corresp,
   att.global.linking.attribute.synch,
   att.global.linking.attribute.sameAs,
   att.global.linking.attribute.copyOf,
   att.global.linking.attribute.next,
   att.global.linking.attribute.prev,
   att.global.linking.attribute.exclude,
   att.global.linking.attribute.select,
   att.global.facs.attribute.facs,
   att.global.change.attribute.change,
   att.global.responsibility.attribute.cert,
   att.global.responsibility.attribute.resp,
   att.global.source.attribute.source,
   att.segLike.attributes,
   att.typed.attribute.type,
   att.written.attributes,
   att.notated.attributes,
   attribute ana
   {
      list
      {
         (
            "sens:illness"
          | "sens:youth"
          | "sens:implicate"
          | "sens:criminal"
          | "sens:stereotype"
          | "sens:cultural"
          | "sens:dishonour"
          | "sens:details"
         )+
      }
   }?,
   attribute subtype { list { + } }?,
   macro.paraContent
}

Appendix A.1.131 <setting>

<setting> describes one particular setting in which a language interaction takes place. [15.2.3. The Setting Description]
Modulecorpus
Attributes
Contained by
corpus: settingDesc
May contain
core: date name p
linking: ab
Note

If the who attribute is not supplied, the setting is assumed to be that of all participants in the language interaction.

Example
<setting>  <placeName>New York City, US</placeName>  <date>1989</date>  <locale>on a park bench</locale>  <activity>feeding birds</activity> </setting>
Content model
<content>
 <alternate>
  <classRef key="model.pLike" minOccurs="1"
   maxOccurs="unbounded"/>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.nameLike.agent"/>
   <classRef key="model.dateLike"/>
   <classRef key="model.settingPart"/>
  </alternate>
 </alternate>
</content>
    
Schema Declaration
element setting
{
   att.global.attributes,
   att.ascribed.attributes,
   (
      model.pLike+
    | ( model.nameLike.agent | model.dateLike | model.settingPart )*
   )
}

Appendix A.1.132 <settingDesc>

<settingDesc> (setting description) describes the setting or settings within which a language interaction takes place, or other places otherwise referred to in a text, edition, or metadata. [15.2. Contextual Information 2.4. The Profile Description]
Modulecorpus
Attributes
Member of
Contained by
header: profileDesc
May contain
core: p
corpus: setting
linking: ab
namesdates: listPlace place
Note

May contain a prose description organized as paragraphs, or a series of <setting> elements. If used to record not settings of language interactions, but other places mentioned in the text, then <place> optionally grouped by <listPlace> inside <standOff> should be preferred.

Example
<settingDesc>  <p>Texts recorded in the    Canadian Parliament building in Ottawa, between April and November 1988 </p> </settingDesc>
Content model
<content>
 <alternate>
  <classRef key="model.pLike" minOccurs="1"
   maxOccurs="unbounded"/>
  <alternate minOccurs="1"
   maxOccurs="unbounded">
   <elementRef key="setting"/>
   <classRef key="model.placeLike"/>
   <elementRef key="listPlace"/>
  </alternate>
 </alternate>
</content>
    
Schema Declaration
element settingDesc
{
   att.global.attributes,
   att.declarable.attributes,
   ( model.pLike+ | ( setting | model.placeLike | listPlace )+ )
}

Appendix A.1.133 <settlement>

<settlement> (settlement) contains the name of a settlement such as a city, town, or village identified as a single geo-political or administrative unit. [13.2.3. Place Names]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Example
<placeName>  <settlement type="town">Glasgow</settlement>  <region>Scotland</region> </placeName>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element settlement
{
   att.global.attributes,
   att.naming.attributes,
   att.typed.attributes,
   att.datable.attributes,
   macro.phraseSeq
}

Appendix A.1.134 <sic>

<sic> (Latin for thus or so) contains text reproduced although apparently incorrect or inaccurate. [3.5.1. Apparent Errors]
Modulecore
Attributes
Member of
Contained by
May contain
Example
for his nose was as sharp as a pen, and <sic>a Table</sic> of green fields.
ExampleIf all that is desired is to call attention to the apparent problem in the copy text, <sic> may be used alone:
I don't know, Juan. It's so far in the past now — how <sic>we can</sic> prove or disprove anyone's theories?
ExampleIt is also possible, using the <choice> and <corr> elements, to provide a corrected reading:
I don't know, Juan. It's so far in the past now — how <choice>  <sic>we can</sic>  <corr>can we</corr> </choice> prove or disprove anyone's theories?
Example
for his nose was as sharp as a pen, and <choice>  <sic>a Table</sic>  <corr>a' babbld</corr> </choice> of green fields.
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element sic { att.global.attributes, macro.paraContent }

Appendix A.1.135 <signed>

<signed> (signature) contains the closing salutation, etc., appended to a foreword, dedicatory epistle, or other division of a text. [4.2.2. Openers and Closers]
Moduletextstructure
Attributes
Member of
Contained by
core: lg list
figures: table
textstructure: body closer div opener
May contain
Example
<signed>Thine to command <name>Humph. Moseley</name> </signed>
Example
<closer>  <signed>Sign'd and Seal'd,  <list>    <item>John Bull,</item>    <item>Nic. Frog.</item>   </list>  </signed> </closer>
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element signed
{
   att.global.attributes,
   att.written.attributes,
   macro.paraContent
}

Appendix A.1.136 <sourceDesc>

<sourceDesc> (source description) describes the source(s) from which an electronic text was derived or generated, typically a bibliographic description in the case of a digitized text, or a phrase such as "born digital" for a text which has no previous existence. [2.2.7. The Source Description]
Moduleheader
Attributes
Contained by
header: fileDesc
May contain
core: bibl list p
figures: table
linking: ab
msdescription: msDesc
Example
<sourceDesc>  <bibl>   <title level="a">The Interesting story of the Children in the Wood</title>. In  <author>Victor E Neuberg</author>, <title>The Penny Histories</title>.  <publisher>OUP</publisher>   <date>1968</date>. </bibl> </sourceDesc>
Example
<sourceDesc>  <p>Born digital: no previous source exists.</p> </sourceDesc>
Content model
<content>
 <alternate>
  <classRef key="model.pLike" minOccurs="1"
   maxOccurs="unbounded"/>
  <alternate minOccurs="1"
   maxOccurs="unbounded">
   <classRef key="model.biblLike"/>
   <classRef key="model.sourceDescPart"/>
   <classRef key="model.listLike"/>
  </alternate>
 </alternate>
</content>
    
Schema Declaration
element sourceDesc
{
   att.global.attributes,
   att.declarable.attributes,
   (
      model.pLike+
    | ( model.biblLike | model.sourceDescPart | model.listLike )+
   )
}

Appendix A.1.137 <state>

<state> (state) contains a description of some status or quality attributed to a person, place, or organization often at some specific time or for a specific date range. [13.3.1. Basic Principles 13.3.2.1. Personal Characteristics]
Modulenamesdates
Attributes
Member of
Contained by
May contain
linking: ab
msdescription: msDesc
namesdates: state
Note

Where there is confusion between <trait> and <state> the more general purpose element <state> should be used even for unchanging characteristics. If you wish to distinguish between characteristics that are generally perceived to be time-bound states and those assumed to be fixed traits, then <trait> is available for the more static of these. The <state> element encodes characteristics which are sometimes assumed to change, often at specific times or over a date range, whereas the <trait> elements are used to record characteristics, such as eye-colour, which are less subject to change. Traits are typically, but not necessarily, independent of the volition or action of the holder.

Example
<state ref="#SCHOLtype="status">  <label>scholar</label> </state>
Example
<org>  <orgName notAfter="1960">The Silver Beetles</orgName>  <orgName notBefore="1960">The Beatles</orgName>  <state type="membershipfrom="1960-08"   to="1962-05">   <desc>    <persName>John Lennon</persName>    <persName>Paul McCartney</persName>    <persName>George Harrison</persName>    <persName>Stuart Sutcliffe</persName>    <persName>Pete Best</persName>   </desc>  </state>  <state type="membershipnotBefore="1963">   <desc>    <persName>John Lennon</persName>    <persName>Paul McCartney</persName>    <persName>George Harrison</persName>    <persName>Ringo Starr</persName>   </desc>  </state> </org>
Content model
<content>
 <sequence>
  <elementRef key="precision" minOccurs="0"
   maxOccurs="unbounded"/>
  <alternate>
   <elementRef key="state" minOccurs="1"
    maxOccurs="unbounded"/>
   <sequence>
    <classRef key="model.headLike"
     minOccurs="0" maxOccurs="unbounded"/>
    <classRef key="model.pLike"
     minOccurs="1" maxOccurs="unbounded"/>
    <alternate minOccurs="0"
     maxOccurs="unbounded">
     <classRef key="model.noteLike"/>
     <classRef key="model.biblLike"/>
    </alternate>
   </sequence>
   <alternate minOccurs="0"
    maxOccurs="unbounded">
    <classRef key="model.labelLike"/>
    <classRef key="model.noteLike"/>
    <classRef key="model.biblLike"/>
   </alternate>
  </alternate>
 </sequence>
</content>
    
Schema Declaration
element state
{
   att.global.attributes,
   att.datable.attributes,
   att.editLike.attributes,
   att.typed.attributes,
   att.naming.attributes,
   att.dimensions.attributes,
   (
      precision*,
      (
         state+
       | (
            model.headLike*,
            model.pLike+,
            ( model.noteLike | model.biblLike )*
         )
       | ( model.labelLike | model.noteLike | model.biblLike )*
      )
   )
}

Appendix A.1.138 <street>

<street> contains a full street address including any name or number identifying a building as well as the name of the street or route on which it is located. [3.6.2. Addresses]
Modulecore
Attributes
Member of
Contained by
core: address
May contain
Note

The order and presentation of house names and numbers and street names, etc., may vary considerably in different countries. The encoding should reflect the order which is appropriate in the country concerned.

Example
<street>via della Faggiola, 36</street>
Example
<street>  <name>Duntaggin</name>, 110 Southmoor Road </street>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element street { att.global.attributes, macro.phraseSeq }

Appendix A.1.139 <summary>

<summary> contains an overview of the available information concerning some aspect of an item or object (for example, its intellectual content, history, layout, typography etc.) as a complement or alternative to the more detailed information carried by more specific elements. [10.6. Intellectual Content]
Modulemsdescription
Attributes
Contained by
msdescription: history msContents
May contain
Example
<summary>This item consists of three books with a prologue and an epilogue. </summary>
Example
<typeDesc>  <summary>Uses a mixture of Roman and Black Letter types.</summary>  <typeNote>Antiqua typeface, showing influence of Jenson's Venetian    fonts.</typeNote>  <typeNote>The black letter face is a variant of Schwabacher.</typeNote> </typeDesc>
Content model
<content>
 <macroRef key="macro.specialPara"/>
</content>
    
Schema Declaration
element summary { att.global.attributes, macro.specialPara }

Appendix A.1.140 <supplied>

<supplied> (supplied) signifies text supplied by the transcriber or editor for any reason; for example because the original cannot be read due to physical damage, or because of an obvious omission by the author or scribe. [11.3.3.1. Damage, Illegibility, and Supplied Text]
Moduletranscr
Attributes
reasonone or more words indicating why the text has had to be supplied, e.g. overbinding, faded-ink, lost-folio, omitted-in-original.
StatusOptional
Datatype1–∞ occurrences of teidata.word separated by whitespace
Member of
Contained by
May contain
Note

The <damage>, <gap>, <del>, <unclear> and <supplied> elements may be closely allied in use. See section 11.3.3.2. Use of the gap, del, damage, unclear, and supplied Elements in Combination for discussion of which element is appropriate for which circumstance.

Example
I am dr Sr yr <supplied reason="illegible"  source="#amanuensis_copy">very humble Servt</supplied> Sydney Smith
Example
<supplied reason="omitted-in-original">Dedication</supplied> to the duke of Bejar
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element supplied
{
   att.global.attributes,
   att.editLike.attributes,
   att.dimensions.attributes,
   attribute reason { list { + } }?,
   macro.paraContent
}

Appendix A.1.141 <surface>

<surface> defines a written surface as a two-dimensional coordinate space, optionally grouping one or more graphic representations of that space, zones of interest within that space, and transcriptions of the writing within them. [11.1. Digital Facsimiles 11.2.2. Embedded Transcription]
Moduletranscr
Attributes
attachmentdescribes the method by which this surface is or was connected to the main surface
StatusOptional
Datatypeteidata.enumerated
Sample values include:
glued
glued in place
pinned
pinned or stapled in place
sewn
sewn in place
flippingindicates whether the surface is attached and folded in such a way as to provide two writing surfaces
StatusOptional
Datatypeteidata.truthValue
Contained by
May contain
Note

The <surface> element represents any two-dimensional space on some physical surface forming part of the source material, such as a piece of paper, a face of a monument, a billboard, a scroll, a leaf etc.

The coordinate space defined by this element may be thought of as a grid lrx - ulx units wide and uly - lry units high.

The <surface> element may contain graphic representations or transcriptions of written zones, or both. The coordinate values used by every <zone> element contained by this element are to be understood with reference to the same grid.

Where it is useful or meaningful to do so, any grouping of multiple <surface> elements may be indicated using the <surfaceGrp> element.

Example
<facsimile>  <surface ulx="0uly="0lrx="200lry="300">   <graphic url="Bovelles-49r.png"/>  </surface> </facsimile>
Content model
<content>
 <sequence>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.global"/>
   <classRef key="model.labelLike"/>
   <classRef key="model.graphicLike"/>
  </alternate>
  <sequence minOccurs="0"
   maxOccurs="unbounded">
   <alternate>
    <elementRef key="zone"/>
    <elementRef key="line"/>
    <elementRef key="path"/>
    <elementRef key="surface"/>
    <elementRef key="surfaceGrp"/>
   </alternate>
   <classRef key="model.global"
    minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
 </sequence>
</content>
    
Schema Declaration
element surface
{
   att.global.attributes,
   att.coordinated.attributes,
   att.declaring.attributes,
   att.typed.attributes,
   attribute attachment { text }?,
   attribute flipping { text }?,
   (
      ( model.global | model.labelLike | model.graphicLike )*,
      ( ( ( zone | line | path | surface | surfaceGrp ), model.global* )* )
   )
}

Appendix A.1.142 <surname>

<surname> (surname) contains a family (inherited) name, as opposed to a given, baptismal, or nick name. [13.2.1. Personal Names]
Modulenamesdates
Attributes
Member of
Contained by
May contain
Example
<surname type="combine">St John Stevas</surname>
Content model
<content>
 <macroRef key="macro.phraseSeq"/>
</content>
    
Schema Declaration
element surname
{
   att.global.attributes,
   att.personal.attributes,
   att.typed.attributes,
   macro.phraseSeq
}

Appendix A.1.143 <table>

<table> (table) contains text displayed in tabular form, in rows and columns. [14.1.1. TEI Tables]
Modulefigures
Attributes
rows(rows) indicates the number of rows in the table.
StatusOptional
Datatypeteidata.count
Note

If no number is supplied, an application must calculate the number of rows.

Rows should be presented from top to bottom.

cols(columns) indicates the number of columns in each row of the table.
StatusOptional
Datatypeteidata.count
Note

If no number is supplied, an application must calculate the number of columns.

Within each row, columns should be presented left to right.

Member of
Contained by
figures: cell
linking: ab seg
msdescription: acquisition origin summary
namesdates: occupation
spoken: u
textstructure: argument body div salute signed
transcr: supplied
May contain
Note

Contains an optional heading and a series of rows.

Any rendition information should be supplied using the global rend attribute, at the table, row, or cell level as appropriate.

Example
<table rows="4cols="4">  <head>Poor Men's Lodgings in Norfolk (Mayhew, 1843)</head>  <row role="label">   <cell role="data"/>   <cell role="data">Dossing Cribs or Lodging Houses</cell>   <cell role="data">Beds</cell>   <cell role="data">Needys or Nightly Lodgers</cell>  </row>  <row role="data">   <cell role="label">Bury St Edmund's</cell>   <cell role="data">5</cell>   <cell role="data">8</cell>   <cell role="data">128</cell>  </row>  <row role="data">   <cell role="label">Thetford</cell>   <cell role="data">3</cell>   <cell role="data">6</cell>   <cell role="data">36</cell>  </row>  <row role="data">   <cell role="label">Attleboro'</cell>   <cell role="data">3</cell>   <cell role="data">5</cell>   <cell role="data">20</cell>  </row>  <row role="data">   <cell role="label">Wymondham</cell>   <cell role="data">1</cell>   <cell role="data">11</cell>   <cell role="data">22</cell>  </row> </table>
Content model
<content>
 <sequence>
  <alternate minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.headLike"/>
   <classRef key="model.global"/>
  </alternate>
  <alternate>
   <sequence minOccurs="1"
    maxOccurs="unbounded">
    <elementRef key="row"/>
    <classRef key="model.global"
     minOccurs="0" maxOccurs="unbounded"/>
   </sequence>
   <sequence minOccurs="1"
    maxOccurs="unbounded">
    <classRef key="model.graphicLike"/>
    <classRef key="model.global"
     minOccurs="0" maxOccurs="unbounded"/>
   </sequence>
  </alternate>
  <sequence minOccurs="0"
   maxOccurs="unbounded">
   <classRef key="model.divBottom"/>
   <classRef key="model.global"
    minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
 </sequence>
</content>
    
Schema Declaration
element table
{
   att.global.attributes,
   att.typed.attributes,
   attribute rows { text }?,
   attribute cols { text }?,
   (
      ( model.headLike | model.global )*,
      (
         ( ( row, model.global* )+ )
       | ( ( model.graphicLike, model.global* )+ )
      ),
      ( ( model.divBottom, model.global* )* )
   )
}

Appendix A.1.144 <teiHeader>

<teiHeader> (TEI header) supplies descriptive and declarative metadata associated with a digital resource or set of resources. [2.1.1. The TEI Header and Its Components 15.1. Varieties of Composite Text]
Moduleheader
Attributes
Contained by
textstructure: TEI
May contain
Note

In LOI, we require <profileDesc> since it is necessary for specifying a document type. We also make <revisionDesc> mandatory.

Example
<teiHeader>  <fileDesc>   <titleStmt>    <title>Shakespeare: the first folio (1623) in electronic form</title>    <author>Shakespeare, William (1564–1616)</author>    <respStmt>     <resp>Originally prepared by</resp>     <name>Trevor Howard-Hill</name>    </respStmt>    <respStmt>     <resp>Revised and edited by</resp>     <name>Christine Avern-Carr</name>    </respStmt>   </titleStmt>   <publicationStmt>    <distributor>Oxford Text Archive</distributor>    <address>     <addrLine>13 Banbury Road, Oxford OX2 6NN, UK</addrLine>    </address>    <idno type="OTA">119</idno>    <availability>     <p>Freely available on a non-commercial basis.</p>    </availability>    <date when="1968">1968</date>   </publicationStmt>   <sourceDesc>    <bibl>The first folio of Shakespeare, prepared by Charlton Hinman (The Norton Facsimile,        1968)</bibl>   </sourceDesc>  </fileDesc>  <encodingDesc>   <projectDesc>    <p>Originally prepared for use in the production of a series of old-spelling        concordances in 1968, this text was extensively checked and revised for use during the        editing of the new Oxford Shakespeare (Wells and Taylor, 1989).</p>   </projectDesc>   <editorialDecl>    <correction>     <p>Turned letters are silently corrected.</p>    </correction>    <normalization>     <p>Original spelling and typography is retained, except that long s and ligatured          forms are not encoded.</p>    </normalization>   </editorialDecl>   <refsDecl xml:id="ASLREF">    <cRefPattern matchPattern="(\S+) ([^.]+)\.(.*)"     replacementPattern="#xpath(//div1[@n='$1']/div2/[@n='$2']//lb[@n='$3'])">     <p>A reference is created by assembling the following, in the reverse order as that          listed here: <list>       <item>the <att>n</att> value of the preceding <gi>lb</gi>       </item>       <item>a period</item>       <item>the <att>n</att> value of the ancestor <gi>div2</gi>       </item>       <item>a space</item>       <item>the <att>n</att> value of the parent <gi>div1</gi>       </item>      </list>     </p>    </cRefPattern>   </refsDecl>  </encodingDesc>  <revisionDesc>   <list>    <item>     <date when="1989-04-12">12 Apr 89</date> Last checked by CAC</item>    <item>     <date when="1989-03-01">1 Mar 89</date> LB made new file</item>   </list>  </revisionDesc> </teiHeader>
Content model
<content>
 <sequence minOccurs="1" maxOccurs="1">
  <elementRef key="fileDesc"/>
  <elementRef key="encodingDesc"
   minOccurs="0"/>
  <elementRef key="profileDesc"/>
  <elementRef key="revisionDesc"/>
 </sequence>
</content>
    
Schema Declaration
element teiHeader
{
   att.global.attributes,
   ( fileDesc, encodingDesc?, profileDesc, revisionDesc )
}

Appendix A.1.145 <text>

<text> (text) contains a single text of any kind, whether unitary or composite, for example a poem or drama, a collection of essays, a novel, a dictionary, or a corpus sample. [4. Default Text Structure 15.1. Varieties of Composite Text]
Moduletextstructure
Attributes
Member of
Contained by
textstructure: TEI
May contain
linking: timeline
spoken: incident
textstructure: body
Note

This element should not be used to represent a text which is inserted at an arbitrary point within the structure of another, for example as in an embedded or quoted narrative; the <floatingText> is provided for this purpose.

Example
<text>  <front>   <docTitle>    <titlePart>Autumn Haze</titlePart>   </docTitle>  </front>  <body>   <l>Is it a dragonfly or a maple leaf</l>   <l>That settles softly down upon the water?</l>  </body> </text>
ExampleThe body of a text may be replaced by a group of nested texts, as in the following schematic:
<text>  <front> <!-- front matter for the whole group -->  </front>  <group>   <text> <!-- first text -->   </text>   <text> <!-- second text -->   </text>  </group> </text>
Content model
<content>
 <sequence>
  <classRef key="model.global"
   minOccurs="0" maxOccurs="unbounded"/>
  <sequence minOccurs="0">
   <elementRef key="front"/>
   <classRef key="model.global"
    minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
  <alternate>
   <elementRef key="body"/>
   <elementRef key="group"/>
  </alternate>
  <classRef key="model.global"
   minOccurs="0" maxOccurs="unbounded"/>
  <sequence minOccurs="0">
   <elementRef key="back"/>
   <classRef key="model.global"
    minOccurs="0" maxOccurs="unbounded"/>
  </sequence>
 </sequence>
</content>
    
Schema Declaration
element text
{
   att.global.attributes,
   att.declaring.attributes,
   att.typed.attributes,
   att.written.attributes,
   (
      model.global*,
      ( ( front, model.global* )? ),
      ( body | group ),
      model.global*,
      ( ( back, model.global* )? )
   )
}

Appendix A.1.146 <textClass>

<textClass> (text classification) groups information which describes the nature or topic of a text in terms of a standard classification scheme, thesaurus, etc. [2.4.3. The Text Classification]
Moduleheader
Attributes
Member of
Contained by
header: profileDesc
May contain
Note

All <textClass> elements must include, at minimum, one <catRef> child; it may also include <keywords>, but only for the oral histories.

Example
<taxonomy>  <category xml:id="acprose">   <catDesc>Academic prose</catDesc>  </category> <!-- other categories here --> </taxonomy> <!-- ... --> <textClass>  <catRef target="#acprose"/>  <classCode scheme="http://www.udcc.org">001.9</classCode>  <keywords scheme="http://authorities.loc.gov">   <list>    <item>End of the world</item>    <item>History - philosophy</item>   </list>  </keywords> </textClass>
SchematronWe should use only use the <keywords> element if it's an oral history.
<sch:rule context="tei:textClass/tei:keywords"> <sch:assert test="if (not(empty($docTypes))) then $docTypes[contains(@target,'OralHistory')] else true()">ERROR: Element <sch:name/> not allowed here. <sch:name/> should only be used in Oral History documents.</sch:assert> </sch:rule>
Content model
<content>
 <sequence minOccurs="1" maxOccurs="1">
  <elementRef key="catRef" minOccurs="1"
   maxOccurs="unbounded"/>
  <elementRef key="keywords" minOccurs="0"/>
 </sequence>
</content>
    
Schema Declaration
element textClass
{
   att.global.attributes,
   att.declarable.attributes,
   ( catRef+, keywords? )
}

Appendix A.1.147 <timeline>

<timeline> (timeline) provides a set of ordered points in time which can be linked to elements of a spoken text to create a temporal alignment of that text. [16.4.2. Placing Synchronous Events in Time]
Modulelinking
Attributes
origindesignates the origin of the timeline, i.e. the time at which it begins.
StatusOptional
Datatypeteidata.pointer
Note

If this attribute is not supplied, the implication is that the time of origin is not known. If it is supplied, it must point either to one of the <when> elements in its content, or to another <timeline> element.

unitspecifies the unit of time corresponding to the interval value of the timeline or of its constituent points in time.
StatusOptional
Datatypeteidata.enumerated
Suggested values include:
d
(days)
h
(hours)
min
(minutes)
s
(seconds)
ms
(milliseconds)
intervalspecifies a time interval either as a positive integral value or using one of a set of predefined codes.
StatusOptional
Datatypeteidata.interval
Note

The value irregular indicates uncertainty about all the intervals in the timeline; the value regular indicates that all the intervals are evenly spaced, but the size of the intervals is not known; numeric values indicate evenly spaced values of the size specified. If individual points in time in the timeline are given different values for the interval attribute, those values locally override the value given in the timeline.

Member of
Contained by
May contain
linking: when
Example
<timeline xml:id="TL01unit="ms">  <when xml:id="TL-w0absolute="11:30:00"/>  <when xml:id="TL-w1interval="unknown"   since="#TL-w0"/>  <when xml:id="TL-w2interval="100"   since="#TL-w1"/>  <when xml:id="TL-w3interval="200"   since="#TL-w2"/>  <when xml:id="TL-w4interval="150"   since="#TL-w3"/>  <when xml:id="TL-w5interval="250"   since="#TL-w4"/>  <when xml:id="TL-w6interval="100"   since="#TL-w5"/> </timeline>
Content model
<content>
 <elementRef key="when" minOccurs="1"
  maxOccurs="unbounded"/>
</content>
    
Schema Declaration
element timeline
{
   att.global.attributes,
   attribute origin { text }?,
   attribute unit { "d" | "h" | "min" | "s" | "ms" }?,
   attribute interval { text }?,
   when+
}

Appendix A.1.148 <title>

<title> (title) contains a title for any kind of work. [3.12.2.2. Titles, Authors, and Editors 2.2.1. The Title Statement 2.2.5. The Series Statement]
Modulecore
Attributes
typeclassifies the title according to some convenient typology.
Derived fromatt.typed
StatusOptional
Datatypeteidata.enumerated
Sample values include:
main
main title
sub
(subordinate) subtitle, title of part
alt
(alternate) alternate title, often in another language, by which the work is also known
short
abbreviated form of title
desc
(descriptive) descriptive paraphrase of the work functioning as a title
Note

This attribute is provided for convenience in analysing titles and processing them according to their type; where such specialized processing is not necessary, there is no need for such analysis, and the entire title, including subtitles and any parallel titles, may be enclosed within a single <title> element.

levelindicates the bibliographic level for a title, that is, whether it identifies an article, book, journal, series, or unpublished material.
StatusOptional
Datatypeteidata.enumerated
Legal values are:
a
(analytic) the title applies to an analytic item, such as an article, poem, or other work published as part of a larger item.
m
(monographic) the title applies to a monograph such as a book or other item considered to be a distinct publication, including single volumes of multi-volume works
j
(journal) the title applies to any serial or periodical publication such as a journal, magazine, or newspaper
s
(series) the title applies to a series of otherwise distinct publications such as a collection
u
(unpublished) the title applies to any unpublished material (including theses and dissertations unless published by a commercial press)
Note

The level of a title is sometimes implied by its context: for example, a title appearing directly within an <analytic> element is ipso facto of level ‘a’, and one appearing within a <series> element of level ‘s’. For this reason, the level attribute is not required in contexts where its value can be unambiguously inferred. Where it is supplied in such contexts, its value should not contradict the value implied by its parent element.

Member of
Contained by
May contain
Note

The attributes key and ref, inherited from the class att.canonical may be used to indicate the canonical form for the title; the former, by supplying (for example) the identifier of a record in some external library system; the latter by pointing to an XML element somewhere containing the canonical form of the title.

Example
<title>Information Technology and the Research Process: Proceedings of a conference held at Cranfield Institute of Technology, UK, 18–21 July 1989</title>
Example
<title>Hardy's Tess of the D'Urbervilles: a machine readable edition</title>
Example
<title type="full">  <title type="main">Synthèse</title>  <title type="sub">an international journal for    epistemology, methodology and history of    science</title> </title>
SchematronAll titles much have some meaningful content
<sch:pattern> <sch:rule context="tei:title">  <sch:let name="text"   value="string-join(descendant::text(),'')"/>  <sch:assert test="$text ne ''">ERROR: Titles must have meaningful content.</sch:assert> </sch:rule> </sch:pattern>
SchematronTitles shouldn't start or end with spaces
<sch:pattern> <sch:rule context="tei:title">  <sch:let name="text"   value="string-join(descendant::text(),'')"/>  <sch:assert test="not(matches($text,'^\s|\s$'))">ERROR: Titles shouldn't begin or end with spaces.</sch:assert> </sch:rule> </sch:pattern>
SchematronTitles shouldn't have a child element other than a text node
<sch:pattern> <sch:rule context="tei:title[not(@type='generated')]">  <sch:assert test="not(*[not(self::tei:foreign)])">ERROR: Titles shouldn't have any children other than a <foreign> or a text node.</sch:assert> </sch:rule> </sch:pattern>
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element title
{
   att.global.attributes,
   att.typed.attribute.subtype,
   att.canonical.attributes,
   att.datable.attributes,
   attribute type { text }?,
   attribute level { "a" | "m" | "j" | "s" | "u" }?,
   macro.paraContent
}

Appendix A.1.149 <titleStmt>

<titleStmt> (title statement) groups information about the title of a work and those responsible for its content. [2.2.1. The Title Statement 2.2. The File Description]
Moduleheader
Attributes
Contained by
header: fileDesc
May contain
Example
<titleStmt>  <title>Capgrave's Life of St. John Norbert: a machine-readable transcription</title>  <respStmt>   <resp>compiled by</resp>   <name>P.J. Lucas</name>  </respStmt> </titleStmt>
Content model
<content>
 <sequence>
  <elementRef key="title" minOccurs="1"
   maxOccurs="unbounded"/>
  <classRef key="model.respLike"
   minOccurs="0" maxOccurs="unbounded"/>
 </sequence>
</content>
    
Schema Declaration
element titleStmt { att.global.attributes, ( title+, model.respLike* ) }

Appendix A.1.150 <trait>

<trait> (trait) contains a description of some status or quality attributed to a person, place, or organization typically, but not necessarily, independent of the volition or action of the holder and usually not at some specific time or for a specific date range. [13.3.1. Basic Principles 13.3.2.1. Personal Characteristics]
Modulenamesdates
Attributes
Member of
Contained by
May contain
linking: ab
msdescription: msDesc
namesdates: trait
Note

Where there is confusion between <trait> and <state> the more general purpose element <state> should be used even for unchanging characteristics. If you wish to distinguish between characteristics that are generally perceived to be time-bound states and those assumed to be fixed traits, then <trait> is available for the more static of these. The <state> element encodes characteristics which are sometimes assumed to change, often at specific times or over a date range, whereas the <trait> elements are used to record characteristics, such as eye-colour, which are less subject to change. Traits are typically, but not necessarily, independent of the volition or action of the holder.

Example
<trait type="physical">  <label>Eye colour</label>  <desc>Blue</desc> </trait>
Content model
<content>
 <sequence>
  <elementRef key="precision" minOccurs="0"
   maxOccurs="unbounded"/>
  <alternate>
   <elementRef key="trait" minOccurs="1"
    maxOccurs="unbounded"/>
   <sequence>
    <classRef key="model.headLike"
     minOccurs="0" maxOccurs="unbounded"/>
    <classRef key="model.pLike"
     minOccurs="1" maxOccurs="unbounded"/>
    <alternate minOccurs="0"
     maxOccurs="unbounded">
     <classRef key="model.noteLike"/>
     <classRef key="model.biblLike"/>
    </alternate>
   </sequence>
   <alternate minOccurs="0"
    maxOccurs="unbounded">
    <classRef key="model.labelLike"/>
    <classRef key="model.noteLike"/>
    <classRef key="model.biblLike"/>
   </alternate>
  </alternate>
 </sequence>
</content>
    
Schema Declaration
element trait
{
   att.global.attributes,
   att.datable.attributes,
   att.editLike.attributes,
   att.naming.attributes,
   att.typed.attributes,
   att.dimensions.attributes,
   (
      precision*,
      (
         trait+
       | (
            model.headLike*,
            model.pLike+,
            ( model.noteLike | model.biblLike )*
         )
       | ( model.labelLike | model.noteLike | model.biblLike )*
      )
   )
}

Appendix A.1.151 <u>

<u> (utterance) contains a stretch of speech usually preceded and followed by silence or by a change of speaker. [8.3.1. Utterances]
Modulespoken
Attributes
trans(transition) indicates the nature of the transition between this utterance and the previous one.
StatusOptional
Datatypeteidata.enumerated
Legal values are:
smooth
this utterance begins without unusual pause or rapidity.[Default]
latching
this utterance begins with a markedly shorter pause than normal.
overlap
this utterance begins before the previous one has finished.
pause
this utterance begins after a noticeable pause.
Member of
Contained by
figures: cell
header: change licence
msdescription: acquisition origin summary
namesdates: occupation
textstructure: argument body div
May contain
Note

Prose and a mixture of speech elements

Although individual transcriptions may consistently use <u> elements for turns or other units, and although in most cases a <u> will be delimited by pause or change of speaker, <u> is not required to represent a turn or any communicative event, nor to be bounded by pauses or change of speaker. At a minimum, a <u> is some phonetic production by a given speaker.

Example
<u who="#spkr1">if did you set</u> <u trans="latchingwho="#spkr2">well Joe and I set it between us</u> <list type="speakers">  <item xml:id="spkr1"/>  <item xml:id="spkr2"/> </list>
SchematronUtterances must have an who identifying a speaker with either a team member or a person prefix.
<sch:pattern> <sch:rule context="tei:u">  <sch:assert test="matches(@who, '^(team:|prs:)[a-z]{4}\d+$')">Utterances must have an @who identifying a speaker with either "team:" or "prs:" followed by the persons id.</sch:assert> </sch:rule> </sch:pattern>
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element u
{
   att.global.attributes,
   att.timed.attributes,
   att.declaring.attributes,
   att.ascribed.directed.attributes,
   att.notated.attributes,
   attribute trans { "smooth" | "latching" | "overlap" | "pause" }?,
   macro.paraContent
}

Appendix A.1.152 <unclear>

<unclear> (unclear) contains a word, phrase, or passage which cannot be transcribed with certainty because it is illegible or inaudible in the source. [11.3.3.1. Damage, Illegibility, and Supplied Text 3.5.3. Additions, Deletions, and Omissions]
Modulecore
Attributes
reasonindicates why the material is hard to transcribe.
StatusOptional
Datatype1–∞ occurrences of teidata.enumerated separated by whitespace
Suggested values include:
illegible
(illegible)
inaudible
(inaudible)
faded
(faded)
background_noise
(background noise)
eccentric_ductus
(eccentric ductus) indicates illegibility due to an unusual, awkward, or incompetent execution of a glyph or glyphs
<div>  <head>Rx</head>  <p>500 mg <unclear reason="illegible">placebo</unclear>  </p> </div>
Note

One or more words may be used to describe the reason; usually each word will refer to a single cause.

agentWhere the difficulty in transcription arises from damage, categorizes the cause of the damage, if it can be identified.
StatusOptional
Datatypeteidata.enumerated
Sample values include:
rubbing
damage results from rubbing of the leaf edges
mildew
damage results from mildew on the leaf surface
smoke
damage results from smoke
Member of
Contained by
May contain
Note

The same element is used for all cases of uncertainty in the transcription of element content, whether for written or spoken material. For other aspects of certainty, uncertainty, and reliability of tagging and transcription, see chapter 21. Certainty, Precision, and Responsibility.

The <damage>, <gap>, <del>, <unclear> and <supplied> elements may be closely allied in use. See section 11.3.3.2. Use of the gap, del, damage, unclear, and supplied Elements in Combination for discussion of which element is appropriate for which circumstance.

The hand attribute points to a definition of the hand concerned, as further discussed in section 11.3.2.1. Document Hands.

Example
<u> ...and then <unclear reason="background-noise">Nathalie</unclear> said ... </u>
Content model
<content>
 <macroRef key="macro.paraContent"/>
</content>
    
Schema Declaration
element unclear
{
   att.global.attributes,
   att.editLike.attributes,
   att.dimensions.attributes,
   attribute reason
   {
      list
      {
         (
            "illegible"
          | "inaudible"
          | "faded"
          | "background_noise"
          | "eccentric_ductus"
         )+
      }
   }?,
   attribute agent { text }?,
   macro.paraContent
}

Appendix A.1.153 <when>

<when> indicates a point in time either relative to other elements in the same timeline tag, or absolutely. [16.4.2. Placing Synchronous Events in Time]
Modulelinking
Attributes
absolutesupplies an absolute value for the time.
StatusOptional
Datatypeteidata.temporal.w3c
Note

This attribute should always be specified on a <when> element which serves as the target for the origin attribute of a <timeline>.

unitspecifies the unit of time in which the interval value is expressed, if this is not inherited from the parent <timeline>.
StatusOptional
Datatypeteidata.enumerated
Suggested values include:
d
(days)
h
(hours)
min
(minutes)
s
(seconds)
ms
(milliseconds)
intervalspecifies a time interval either as a number or as one of the keywords defined by the datatype teidata.interval
StatusOptional
Datatypeteidata.interval
sinceidentifies the reference point for determining the time of the current <when> element, which is obtained by adding the interval to the time of the reference point.
StatusOptional
Datatypeteidata.pointer
Note

This attribute should point to another <when> element in the same <timeline>. If no value is supplied, and the absolute attribute is also unspecified, then the reference point is understood to be the origin of the enclosing <timeline> tag.

Contained by
linking: timeline
May containEmpty element
Note

On this element, the global xml:id attribute must be supplied to specify an identifier for this point in time. The value used may be chosen freely provided that it is unique within the document and is a syntactically valid name. There is no requirement for values containing numbers to be in sequence.

Example
<when xml:id="TW3interval="20since="#w2"/>
Content model
<content>
 <empty/>
</content>
    
Schema Declaration
element when
{
   att.global.attributes,
   attribute absolute { text }?,
   attribute unit { "d" | "h" | "min" | "s" | "ms" }?,
   attribute interval { text }?,
   attribute since { text }?,
   empty
}

Appendix A.2 Model classes

Appendix A.2.1 model.addrPart

model.addrPart groups elements such as names or postal codes which may appear as part of a postal address. [3.6.2. Addresses]
Moduletei
Used by
Membersmodel.nameLike[model.nameLike.agent[name orgName persName] model.offsetLike model.persNamePart[addName forename roleName surname] model.placeStateLike[model.placeNamePart[district placeName region settlement] location state trait] idno rs] addrLine postBox postCode street

Appendix A.2.2 model.addressLike

model.addressLike groups elements used to represent a postal or email address. [1. The TEI Infrastructure]
Moduletei
Used by
Membersaddress affiliation

Appendix A.2.3 model.attributable

model.attributable groups elements that contain a word or phrase that can be attributed to a source. [3.3.3. Quotation 4.3.2. Floating Texts]
Moduletei
Used by
Membersmodel.quoteLike[quote]

Appendix A.2.4 model.availabilityPart

model.availabilityPart groups elements such as licences and paragraphs of text which may appear as part of an availability statement [2.2.4. Publication, Distribution, Licensing, etc.]
Moduletei
Used by
Memberslicence

Appendix A.2.5 model.biblLike

model.biblLike groups elements containing a bibliographic description. [3.12. Bibliographic Citations and References]
Moduletei
Used by
Membersbibl msDesc

Appendix A.2.6 model.biblPart

model.biblPart groups elements which represent components of a bibliographic description. [3.12. Bibliographic Citations and References]
Moduletei
Used by
Membersmodel.imprintPart[distributor pubPlace publisher] model.respLike[author respStmt] availability bibl listRelation msIdentifier objectIdentifier relatedItem

Appendix A.2.7 model.choicePart

model.choicePart groups elements (other than <choice> itself) which can be used within a <choice> alternation. [3.5. Simple Editorial Changes]
Moduletei
Used by
Membersabbr corr expan orig reg seg sic supplied unclear

Appendix A.2.8 model.common

model.common groups common chunk- and inter-level elements. [1.3. The TEI Class System]
Moduletei
Used by
Membersmodel.divPart[model.divPart.spoken[annotationBlock u] model.lLike[l] model.pLike[ab p] lg] model.inter[model.attributable[model.quoteLike[quote]] model.biblLike[bibl msDesc] model.egLike model.labelLike[desc label] model.listLike[list listEvent listObject listOrg listPerson listPlace listRelation table] model.oddDecl model.stageLike] q
Note

This class defines the set of chunk- and inter-level elements; it is used in many content models, including those for textual divisions.

Appendix A.2.9 model.correspActionPart

model.correspActionPart groups elements which define the parts (usually names, dates and places) of one action related to the correspondence.
Moduletei
Used by
Membersmodel.addressLike[address affiliation] model.dateLike[date] model.nameLike[model.nameLike.agent[name orgName persName] model.offsetLike model.persNamePart[addName forename roleName surname] model.placeStateLike[model.placeNamePart[district placeName region settlement] location state trait] idno rs] note

Appendix A.2.10 model.correspDescPart

model.correspDescPart groups together metadata elements for describing correspondence
Moduletei
Used by
MemberscorrespAction note

Appendix A.2.11 model.dateLike

model.dateLike groups elements containing temporal expressions. [3.6.4. Dates and Times 13.4. Dates]
Moduletei
Used by
Membersdate

Appendix A.2.12 model.descLike

model.descLike groups elements which contain a description of their function.
Moduletei
Used by
Membersdesc

Appendix A.2.13 model.divBottom

model.divBottom groups elements appearing at the end of a text division. [4.2. Elements Common to All Divisions]
Moduletei
Used by
Membersmodel.divBottomPart[closer signed] model.divWrapper[argument dateline docAuthor docDate salute]

Appendix A.2.14 model.divBottomPart

model.divBottomPart groups elements which can occur only at the end of a text division. [4.6. Title Pages]
Moduletei
Used by
Memberscloser signed

Appendix A.2.15 model.divGenLike

model.divGenLike groups elements used to represent a structural division which is generated rather than explicitly present in the source.
Moduletei
Used by
MembersdivGen

Appendix A.2.16 model.divLike

model.divLike groups elements used to represent un-numbered generic structural divisions.
Moduletei
Used by
Membersdiv

Appendix A.2.17 model.divPart

model.divPart groups paragraph-level elements appearing directly within divisions. [1.3. The TEI Class System]
Moduletei
Used by
Membersmodel.divPart.spoken[annotationBlock u] model.lLike[l] model.pLike[ab p] lg
Note

Note that this element class does not include members of the model.inter class, which can appear either within or between paragraph-level items.

Appendix A.2.18 model.divPart.spoken

model.divPart.spoken groups elements structurally analogous to paragraphs within spoken texts. [8.1. General Considerations and Overview]
Modulespoken
Used by
MembersannotationBlock u
Note

Spoken texts may be structured in many ways; elements in this class are typically larger units such as turns or utterances.

Appendix A.2.19 model.divTop

model.divTop groups elements appearing at the beginning of a text division. [4.2. Elements Common to All Divisions]
Moduletei
Used by
Membersmodel.divTopPart[model.headLike[head] opener signed] model.divWrapper[argument dateline docAuthor docDate salute]

Appendix A.2.20 model.divTopPart

model.divTopPart groups elements which can occur only at the beginning of a text division. [4.6. Title Pages]
Moduletei
Used by
Membersmodel.headLike[head] opener signed

Appendix A.2.21 model.divWrapper

model.divWrapper groups elements which can appear at either top or bottom of a textual division. [4.2. Elements Common to All Divisions]
Moduletei
Used by
Membersargument dateline docAuthor docDate salute

Appendix A.2.22 model.emphLike

model.emphLike groups phrase-level elements which are typographically distinct and to which a specific function can be attributed. [3.3. Highlighting and Quotation]
Moduletei
Used by
Membersemph foreign title

Appendix A.2.23 model.encodingDescPart

model.encodingDescPart groups elements which may be used inside <encodingDesc> and appear multiple times.
Moduletei
Used by
MemberscharDecl samplingDecl

Appendix A.2.24 model.eventLike

model.eventLike groups elements which describe events.
Moduletei
Used by
Membersevent listEvent

Appendix A.2.25 model.gLike

model.gLike groups elements used to represent individual non-Unicode characters or glyphs.
Moduletei
Used by
Membersg

Appendix A.2.27 model.global.edit

model.global.edit groups globally available elements which perform a specifically editorial function. [1.3. The TEI Class System]
Moduletei
Used by
Membersgap

Appendix A.2.28 model.global.meta

model.global.meta groups globally available elements which describe the status of other elements. [1.3. The TEI Class System]
Moduletei
Used by
Memberstimeline
Note

Elements in this class are typically used to hold groups of links or of abstract interpretations, or by provide indications of certainty etc. It may find be convenient to localize all metadata elements, for example to contain them within the same divison as the elements that they relate to; or to locate them all to a division of their own. They may however appear at any point in a TEI text.

Appendix A.2.29 model.global.spoken

model.global.spoken groups elements which may appear globally within spoken texts. [8.1. General Considerations and Overview]
Modulespoken
Used by
Membersincident
Note

This class groups elements which can appear anywhere within transcribed speech.

Appendix A.2.30 model.graphicLike

model.graphicLike groups elements containing images, formulae, and similar objects. [3.10. Graphics and Other Non-textual Components]
Moduletei
Used by
Membersgraphic media

Appendix A.2.31 model.headLike

model.headLike groups elements used to provide a title or heading at the start of a text division.
Moduletei
Used by
Membershead

Appendix A.2.32 model.hiLike

model.hiLike groups phrase-level elements which are typographically distinct but to which no specific function can be attributed. [3.3. Highlighting and Quotation]
Moduletei
Used by
Membersq

Appendix A.2.33 model.highlighted

model.highlighted groups phrase-level elements which are typographically distinct. [3.3. Highlighting and Quotation]
Moduletei
Used by
Membersmodel.emphLike[emph foreign title] model.hiLike[q]

Appendix A.2.34 model.imprintPart

model.imprintPart groups the bibliographic elements which occur inside imprints. [3.12. Bibliographic Citations and References]
Moduletei
Used by
Membersdistributor pubPlace publisher

Appendix A.2.35 model.inter

model.inter groups elements which can appear either within or between paragraph-like elements. [1.3. The TEI Class System]
Moduletei
Used by
Membersmodel.attributable[model.quoteLike[quote]] model.biblLike[bibl msDesc] model.egLike model.labelLike[desc label] model.listLike[list listEvent listObject listOrg listPerson listPlace listRelation table] model.oddDecl model.stageLike

Appendix A.2.36 model.lLike

model.lLike groups elements representing metrical components such as verse lines.
Moduletei
Used by
Membersl

Appendix A.2.37 model.labelLike

model.labelLike groups elements used to gloss or explain other parts of a document.
Moduletei
Used by
Membersdesc label

Appendix A.2.39 model.listLike

model.listLike groups list-like elements. [3.8. Lists]
Moduletei
Used by
Memberslist listEvent listObject listOrg listPerson listPlace listRelation table

Appendix A.2.40 model.measureLike

model.measureLike groups elements which denote a number, a quantity, a measurement, or similar piece of text that conveys some numerical meaning. [3.6.3. Numbers and Measures]
Moduletei
Used by
Membersgeo num

Appendix A.2.41 model.milestoneLike

model.milestoneLike groups milestone-style elements used to represent reference systems. [1.3. The TEI Class System 3.11.3. Milestone Elements]
Moduletei
Used by
Memberscb lb milestone pb

Appendix A.2.42 model.msItemPart

model.msItemPart groups elements which can appear within a manuscript item description.
Moduletei
Used by
Membersmodel.biblLike[bibl msDesc] model.msQuoteLike[title] model.quoteLike[quote] model.respLike[author respStmt] idno msItem

Appendix A.2.43 model.msQuoteLike

model.msQuoteLike groups elements which represent passages such as titles quoted from a manuscript as a part of its description.
Moduletei
Used by
Memberstitle

Appendix A.2.44 model.nameLike

model.nameLike groups elements which name or refer to a person, place, or organization.
Moduletei
Used by
Membersmodel.nameLike.agent[name orgName persName] model.offsetLike model.persNamePart[addName forename roleName surname] model.placeStateLike[model.placeNamePart[district placeName region settlement] location state trait] idno rs
Note

A superset of the naming elements that may appear in datelines, addresses, statements of responsibility, etc.

Appendix A.2.45 model.nameLike.agent

model.nameLike.agent groups elements which contain names of individuals or corporate bodies. [3.6. Names, Numbers, Dates, Abbreviations, and Addresses]
Moduletei
Used by
Membersname orgName persName
Note

This class is used in the content model of elements which reference names of people or organizations.

Appendix A.2.46 model.noteLike

model.noteLike groups globally-available note-like elements. [3.9. Notes, Annotation, and Indexing]
Moduletei
Used by
Membersnote

Appendix A.2.47 model.objectLike

model.objectLike groups elements which describe objects.
Moduletei
Used by
MemberslistObject object

Appendix A.2.48 model.orgPart

model.orgPart groups elements which form part of the description of an organization.
Moduletei
Used by
Membersmodel.eventLike[event listEvent] listOrg listPerson listPlace

Appendix A.2.51 model.pPart.edit

model.pPart.edit groups phrase-level elements for simple editorial correction and transcription. [3.5. Simple Editorial Changes]
Moduletei
Used by
Membersmodel.pPart.editorial[abbr choice expan] model.pPart.transcriptional[corr orig reg sic supplied unclear]

Appendix A.2.52 model.pPart.editorial

model.pPart.editorial groups phrase-level elements for simple editorial interventions that may be useful both in transcribing and in authoring. [3.5. Simple Editorial Changes]
Moduletei
Used by
Membersabbr choice expan

Appendix A.2.53 model.pPart.msdesc

model.pPart.msdesc groups phrase-level elements used in manuscript description. [10. Manuscript Description]
Moduletei
Used by
Membersmaterial

Appendix A.2.54 model.pPart.transcriptional

model.pPart.transcriptional groups phrase-level elements used for editorial transcription of pre-existing source materials. [3.5. Simple Editorial Changes]
Moduletei
Used by
Memberscorr orig reg sic supplied unclear

Appendix A.2.56 model.persNamePart

model.persNamePart groups elements which form part of a personal name. [13.2.1. Personal Names]
Modulenamesdates
Used by
MembersaddName forename roleName surname

Appendix A.2.57 model.persStateLike

model.persStateLike groups elements describing changeable characteristics of a person which have a definite duration, for example occupation, residence, or name.
Moduletei
Used by
Membersaffiliation nationality occupation persName residence state trait
Note

These characteristics of an individual are typically a consequence of their own action or that of others.

Appendix A.2.58 model.personLike

model.personLike groups elements which provide information about people and their relationships.
Moduletei
Used by
Membersorg person

Appendix A.2.59 model.personPart

model.personPart groups elements which form part of the description of a person. [15.2.2. The Participant Description]
Moduletei
Used by
Membersmodel.biblLike[bibl msDesc] model.eventLike[event listEvent] model.persStateLike[affiliation nationality occupation persName residence state trait] birth death idno name

Appendix A.2.61 model.phrase.xml

model.phrase.xml groups phrase-level elements used to encode XML constructs such as element names, attribute names, and attribute values [22. Documentation Elements]
Moduletei
Used by
Membersatt gi

Appendix A.2.62 model.placeLike

model.placeLike groups elements used to provide information about places and their relationships.
Moduletei
Used by
Membersplace

Appendix A.2.63 model.placeNamePart

model.placeNamePart groups elements which form part of a place name. [13.2.3. Place Names]
Moduletei
Used by
Membersdistrict placeName region settlement

Appendix A.2.64 model.placeStateLike

model.placeStateLike groups elements which describe changing states of a place.
Moduletei
Used by
Membersmodel.placeNamePart[district placeName region settlement] location state trait

Appendix A.2.65 model.profileDescPart

model.profileDescPart groups elements which may be used inside <profileDesc> and appear multiple times.
Moduletei
Used by
Membersabstract correspDesc langUsage settingDesc textClass

Appendix A.2.66 model.ptrLike

model.ptrLike groups elements used for purposes of location and reference. [3.7. Simple Links and Cross-References]
Moduletei
Used by
Membersref

Appendix A.2.67 model.publicationStmtPart.agency

model.publicationStmtPart.agency groups the child elements of a <publicationStmt> element of the TEI header that indicate an authorising agent. [2.2.4. Publication, Distribution, Licensing, etc.]
Moduletei
Used by
Membersauthority distributor publisher
Note

The ‘agency’ child elements, while not required, are required if one of the ‘detail’ child elements is to be used. It is not valid to have a ‘detail’ child element without a preceding ‘agency’ child element.

See also model.publicationStmtPart.detail.

Appendix A.2.68 model.publicationStmtPart.detail

model.publicationStmtPart.detail groups the agency-specific child elements of the <publicationStmt> element of the TEI header. [2.2.4. Publication, Distribution, Licensing, etc.]
Moduletei
Used by
Membersmodel.ptrLike[ref] address availability date idno pubPlace
Note

A ‘detail’ child element may not occur unless an ‘agency’ child element precedes it.

See also model.publicationStmtPart.agency.

Appendix A.2.69 model.quoteLike

model.quoteLike groups elements used to directly contain quotations.
Moduletei
Used by
Membersquote

Appendix A.2.70 model.resource

model.resource groups separate elements which constitute the content of a digital resource, as opposed to its metadata. [1.3. The TEI Class System]
Moduletei
Used by
Membersfacsimile text

Appendix A.2.71 model.respLike

model.respLike groups elements which are used to indicate intellectual or other significant responsibility, for example within a bibliographic element.
Moduletei
Used by
Membersauthor respStmt

Appendix A.2.72 model.segLike

model.segLike groups elements used for arbitrary segmentation. [16.3. Blocks, Segments, and Anchors 17.1. Linguistic Segment Categories]
Moduletei
Used by
Membersseg
Note

The principles on which segmentation is carried out, and any special codes or attribute values used, should be defined explicitly in the <segmentation> element of the <encodingDesc> within the associated TEI header.

Appendix A.2.73 model.settingPart

model.settingPart groups elements used to describe the setting of a linguistic interaction.
Moduletei
Used by
MembersplaceName

Appendix A.2.74 model.sourceDescPart

model.sourceDescPart groups elements which may be used inside <sourceDesc> and appear multiple times.
Moduletei
Used by
MembersrecordingStmt

Appendix A.2.75 model.titlepagePart

model.titlepagePart groups elements which can occur as direct constituents of a title page, such as <docTitle>, <docAuthor>, <docImprint>, or <epigraph>. [4.6. Title Pages]
Moduletei
Used by
Membersargument docAuthor docDate graphic

Appendix A.3 Attribute classes

Appendix A.3.1 att.anchoring

att.anchoring (anchoring) provides attributes for use on annotations, e.g. notes and groups of notes describing the existence and position of an anchor for annotations.
Moduletei
Membersnote
Attributes
anchored(anchored) indicates whether the copy text shows the exact place of reference for the note.
StatusOptional
Datatypeteidata.truthValue
Defaulttrue
Note

In modern texts, notes are usually anchored by means of explicit footnote or endnote symbols. An explicit indication of the phrase or line annotated may however be used instead (e.g. ‘page 218, lines 3–4’). The anchored attribute indicates whether any explicit location is given, whether by symbol or by prose cross-reference. The value true indicates that such an explicit location is indicated in the copy text; the value false indicates that the copy text does not indicate a specific place of attachment for the note. If the specific symbols used in the copy text at the location the note is anchored are to be recorded, use the n attribute.

targetEnd(target end) points to the end of the span to which the note is attached, if the note is not embedded in the text at that point.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Note

This attribute is retained for backwards compatibility; it may be removed at a subsequent release of the Guidelines. The recommended way of pointing to a span of elements is by means of the range function of XPointer, as further described in 16.2.4.6. range().

Example
<p>(...) tamen reuerendos dominos archiepiscopum et canonicos Leopolienses necnon episcopum in duplicibus Quatuortemporibus<anchor xml:id="A55234"/> totaliter expediui...</p> <!-- elsewhere in the document --> <noteGrp targetEnd="#A55234">  <note xml:lang="en"> Quatuor Tempora, so called dry fast days.  </note>  <note xml:lang="pl"> Quatuor Tempora, tzw. Suche dni postne.  </note> </noteGrp>

Appendix A.3.2 att.ascribed

att.ascribed provides attributes for elements representing speech or action that can be ascribed to a specific individual. [3.3.3. Quotation 8.3. Elements Unique to Spoken Texts]
Moduletei
Membersatt.ascribed.directed[q u] annotationBlock change incident setting
Attributes
whoindicates the person, or group of people, to whom the element content is ascribed.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
In the following example from Hamlet, speeches (<sp>) in the body of the play are linked to <castItem> elements in the <castList> using the who attribute.
<castItem type="role">  <role xml:id="Barnardo">Bernardo</role> </castItem> <castItem type="role">  <role xml:id="Francisco">Francisco</role>  <roleDesc>a soldier</roleDesc> </castItem> <!-- ... --> <sp who="#Barnardo">  <speaker>Bernardo</speaker>  <l n="1">Who's there?</l> </sp> <sp who="#Francisco">  <speaker>Francisco</speaker>  <l n="2">Nay, answer me: stand, and unfold yourself.</l> </sp>
Note

For transcribed speech, this will typically identify a participant or participant group; in other contexts, it will point to any identified <person> element.

Appendix A.3.3 att.ascribed.directed

att.ascribed.directed provides attributes for elements representing speech or action that can be directed at a group or individual. [3.3.3. Quotation 8.3. Elements Unique to Spoken Texts]
Moduletei
Membersq u
Attributes
toWhomindicates the person, or group of people, to whom a speech act or action is directed.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
In the following example from Mary Pix's The False Friend, speeches (<sp>) in the body of the play are linked to <castItem> elements in the <castList> using the toWhom attribute, which is used to specify who the speech is directed to. Additionally, the <stage> includes toWhom to indicate the directionality of the action.
<castItem type="role">  <role xml:id="emil">Emilius.</role> </castItem> <castItem type="role">  <role xml:id="lov">Lovisa</role> </castItem> <castItem type="role">  <role xml:id="serv">A servant</role> </castItem> <!-- ... --> <sp who="#emil"  toWhom="#lov">  <speaker>Emil.</speaker>  <l n="1">My love!</l> </sp> <sp who="#lov"  toWhom="#emil">  <speaker>Lov.</speaker>  <l n="2">I have no Witness of my Noble Birth</l>  <stage who="emil"   toWhom="#serv">Pointing to her Woman.</stage>  <l>But that poor helpless wretch——</l> </sp>
Note

To indicate the recipient of written correspondence, use the elements used in section 2.4.6. Correspondence Description, rather than a toWhom attribute.

Appendix A.3.4 att.breaking

att.breaking provides attributes to indicate whether or not the element concerned is considered to mark the end of an orthographic token in the same way as whitespace. [3.11.3. Milestone Elements]
Moduletei
Memberscb lb milestone pb
Attributes
breakindicates whether or not the element bearing this attribute should be considered to mark the end of an orthographic token in the same way as whitespace.
StatusRecommended
Datatypeteidata.enumerated
Sample values include
yes
the element bearing this attribute is considered to mark the end of any adjacent orthographic token irrespective of the presence of any adjacent whitespace
no
the element bearing this attribute is considered not to mark the end of any adjacent orthographic token irrespective of the presence of any adjacent whitespace
maybe
the encoding does not take any position on this issue.
In the following lines from the Dream of the Rood, linebreaks occur in the middle of the words lāðost and reord-berendum.
<ab> ...eƿesa tome iu icƿæs ȝeƿorden ƿita heardoſt . leodum la<lb break="no"/> ðost ærþan ichim lifes ƿeȝ rihtne ȝerymde reord be<lb break="no"/> rendum hƿæt me þaȝeƿeorðode ƿuldres ealdor ofer... </ab>

Appendix A.3.5 att.cReferencing

att.cReferencing provides attributes that may be used to supply a canonical reference as a means of identifying the target of a pointer.
Moduletei
Membersref
Attributes
cRef(canonical reference) specifies the destination of the pointer by supplying a canonical reference expressed using the scheme defined in a <refsDecl> element in the TEI header
StatusOptional
Datatypeteidata.text
Note

The value of cRef should be constructed so that when the algorithm for the resolution of canonical references (described in section 16.2.5. Canonical References) is applied to it the result is a valid URI reference to the intended target.

The <refsDecl> to use may be indicated with the decls attribute.

Currently these Guidelines only provide for a single canonical reference to be encoded on any given <ptr> element.

Appendix A.3.6 att.canonical

att.canonical provides attributes that can be used to associate a representation such as a name or title with canonical information about the object being named or referenced. [13.1.1. Linking Names and Their Referents]
Moduletei
Membersatt.naming[att.personal[addName forename name orgName persName placeName roleName surname] affiliation author birth death district event nationality occupation pubPlace region repository residence rs settlement state trait] authority correspDesc date distributor docAuthor material object publisher relation resp respStmt title
Attributes
keyprovides an externally-defined means of identifying the entity (or entities) being named, using a coded value of some kind.
StatusOptional
Datatypeteidata.text
<author>  <name key="name 427308"   type="organisation">[New Zealand Parliament, Legislative Council]</name> </author>
<author>  <name key="Hugo, Victor (1802-1885)"   ref="http://www.idref.fr/026927608">Victor Hugo</name> </author>
Note

The value may be a unique identifier from a database, or any other externally-defined string identifying the referent.

No particular syntax is proposed for the values of the key attribute, since its form will depend entirely on practice within a given project. For the same reason, this attribute is not recommended in data interchange, since there is no way of ensuring that the values used by one project are distinct from those used by another. In such a situation, a preferable approach for magic tokens which follows standard practice on the Web is to use a ref attribute whose value is a tag URI as defined in RFC 4151.

ref(reference) provides an explicit means of locating a full definition or identity for the entity being named by means of one or more URIs.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
<name ref="http://viaf.org/viaf/109557338"  type="person">Seamus Heaney</name>
Note

The value must point directly to one or more XML elements or other resources by means of one or more URIs, separated by whitespace. If more than one is supplied the implication is that the name identifies several distinct entities.

Appendix A.3.7 att.coordinated

att.coordinated provides attributes that can be used to position their parent element within a two dimensional coordinate system.
Moduletranscr
Memberssurface
Attributes
startindicates the element within a transcription of the text containing at least the start of the writing represented by this zone or surface.
StatusOptional
Datatypeteidata.pointer
ulxgives the x coordinate value for the upper left corner of a rectangular space.
StatusOptional
Datatypeteidata.numeric
ulygives the y coordinate value for the upper left corner of a rectangular space.
StatusOptional
Datatypeteidata.numeric
lrxgives the x coordinate value for the lower right corner of a rectangular space.
StatusOptional
Datatypeteidata.numeric
lrygives the y coordinate value for the lower right corner of a rectangular space.
StatusOptional
Datatypeteidata.numeric
pointsidentifies a two dimensional area by means of a series of pairs of numbers, each of which gives the x,y coordinates of a point on a line enclosing the area.
StatusOptional
Datatype3–∞ occurrences of teidata.point separated by whitespace

Appendix A.3.8 att.datable

att.datable provides attributes for normalization of elements that contain dates, times, or datable events. [3.6.4. Dates and Times 13.4. Dates]
Moduletei
Membersacquisition affiliation author birth change date death district event idno licence location name nationality occupation orgName origin persName placeName region relation residence resp settlement state title trait
Attributes
calendarindicates one or more systems or calendars to which the date represented by the content of this element belongs.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Schematron
<sch:rule context="tei:*[@calendar]"> <sch:assert test="string-length( normalize-space(.) ) gt 0"> @calendar indicates one or more systems or calendars to which the date represented by the content of this element belongs, but this <sch:name/> element has no textual content.</sch:assert> </sch:rule>
He was born on <date calendar="#gregorian">Feb. 22, 1732</date> (<date calendar="#julian"  when="1732-02-22">Feb. 11, 1731/32, O.S.</date>).
He was born on <date calendar="#gregorian #julian"  when="1732-02-22">Feb. 22, 1732 (Feb. 11, 1731/32, O.S.)</date>.
Note

Note that the calendar attribute (unlike datingMethod defined in att.datable.custom) defines the calendar system of the date in the original material defined by the parent element, not the calendar to which the date is normalized.

periodsupplies pointers to one or more definitions of named periods of time (typically <category>s or <calendar>s) within which the datable item is understood to have occurred.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Note

This ‘superclass’ provides attributes that can be used to provide normalized values of temporal information. By default, the attributes from the att.datable.w3c class are provided. If the module for names & dates is loaded, this class also provides attributes from the att.datable.iso and att.datable.custom classes. In general, the possible values of attributes restricted to the W3C datatypes form a subset of those values available via the ISO 8601 standard. However, the greater expressiveness of the ISO datatypes may not be needed, and there exists much greater software support for the W3C datatypes.

Appendix A.3.9 att.datable.custom

att.datable.custom provides attributes for normalization of elements that contain datable events to a custom dating system (i.e. other than the Gregorian used by W3 and ISO). [13.4. Dates]
Modulenamesdates
Membersatt.datable[acquisition affiliation author birth change date death district event idno licence location name nationality occupation orgName origin persName placeName region relation residence resp settlement state title trait]
Attributes
when-customsupplies the value of a date or time in some custom standard form.
StatusOptional
Datatype1–∞ occurrences of teidata.word separated by whitespace
The following are examples of custom date or time formats that are not valid ISO or W3C format normalizations, normalized to a different dating system
<p>Alhazen died in Cairo on the <date when="1040-03-06"   when-custom="431-06-12"> 12th day of Jumada t-Tania, 430 AH  </date>.</p> <p>The current world will end at the <date when="2012-12-21"   when-custom="13.0.0.0.0">end of B'ak'tun 13</date>.</p> <p>The Battle of Meggidu (<date when-custom="Thutmose_III:23">23rd year of reign of Thutmose III</date>).</p> <p>Esidorus bixit in pace annos LXX plus minus sub <date when-custom="Ind:4-10-11">die XI mensis Octobris indictione IIII</date> </p>
Not all custom date formulations will have Gregorian equivalents.The when-custom attribute and other custom dating are not constrained to a datatype by the TEI, but individual projects are recommended to regularize and document their dating formats.
notBefore-customspecifies the earliest possible date for the event in some custom standard form.
StatusOptional
Datatype1–∞ occurrences of teidata.word separated by whitespace
notAfter-customspecifies the latest possible date for the event in some custom standard form.
StatusOptional
Datatype1–∞ occurrences of teidata.word separated by whitespace
from-customindicates the starting point of the period in some custom standard form.
StatusOptional
Datatype1–∞ occurrences of teidata.word separated by whitespace
<event xml:id="FIRE1"  datingMethod="#julian"  from-custom="1666-09-02"  to-custom="1666-09-05">  <head>The Great Fire of London</head>  <p>The Great Fire of London burned through a large part    of the city of London.</p> </event>
to-customindicates the ending point of the period in some custom standard form.
StatusOptional
Datatype1–∞ occurrences of teidata.word separated by whitespace
datingPointsupplies a pointer to some location defining a named point in time with reference to which the datable item is understood to have occurred
StatusOptional
Datatypeteidata.pointer
datingMethodsupplies a pointer to a <calendar> element or other means of interpreting the values of the custom dating attributes.
StatusOptional
Datatypeteidata.pointer
Contayning the Originall, Antiquity, Increaſe, Moderne eſtate, and deſcription of that Citie, written in the yeare <date when-custom="1598"  calendar="#julian"  datingMethod="#julian">1598</date>. by Iohn Stow Citizen of London.
In this example, the calendar attribute points to a <calendar> element for the Julian calendar, specifying that the text content of the <date> element is a Julian date, and the datingMethod attribute also points to the Julian calendar to indicate that the content of the when-custom attribute value is Julian too.
<date when="1382-06-28"  when-custom="6890-06-20"  datingMethod="#creationOfWorld"> μηνὶ Ἰουνίου εἰς <num>κ</num> ἔτους <num>ςωϞ</num> </date>
In this example, a date is given in a Mediaeval text measured ‘from the creation of the world’, which is normalized (in when) to the Gregorian date, but is also normalized (in when-custom) to a machine-actionable, numeric version of the date from the Creation.
Note

Note that the datingMethod attribute (unlike calendar defined in att.datable) defines the calendar or dating system to which the date described by the parent element is normalized (i.e. in the when-custom or other X-custom attributes), not the calendar of the original date in the element.

Appendix A.3.10 att.datable.iso

att.datable.iso provides attributes for normalization of elements that contain datable events using the ISO 8601:2004 standard. [3.6.4. Dates and Times 13.4. Dates]
Modulenamesdates
Membersatt.datable[acquisition affiliation author birth change date death district event idno licence location name nationality occupation orgName origin persName placeName region relation residence resp settlement state title trait]
Attributes
when-isosupplies the value of a date or time in a standard form.
StatusOptional
Datatypeteidata.temporal.iso
The following are examples of ISO date, time, and date & time formats that are not valid W3C format normalizations.
<date when-iso="1996-09-24T07:25+00">Sept. 24th, 1996 at 3:25 in the morning</date> <date when-iso="1996-09-24T03:25-04">Sept. 24th, 1996 at 3:25 in the morning</date> <time when-iso="1999-01-04T20:42-05">4 Jan 1999 at 8:42 pm</time> <time when-iso="1999-W01-1T20,70-05">4 Jan 1999 at 8:42 pm</time> <date when-iso="2006-05-18T10:03">a few minutes after ten in the morning on Thu 18 May</date> <time when-iso="03:00">3 A.M.</time> <time when-iso="14">around two</time> <time when-iso="15,5">half past three</time>
All of the examples of the when attribute in the att.datable.w3c class are also valid with respect to this attribute.
He likes to be punctual. I said <q>  <time when-iso="12">around noon</time> </q>, and he showed up at <time when-iso="12:00:00">12 O'clock</time> on the dot.
The second occurence of <time> could have been encoded with the when attribute, as 12:00:00 is a valid time with respect to the W3C XML Schema Part 2: Datatypes Second Edition specification. The first occurence could not.
notBefore-isospecifies the earliest possible date for the event in standard form, e.g. yyyy-mm-dd.
StatusOptional
Datatypeteidata.temporal.iso
notAfter-isospecifies the latest possible date for the event in standard form, e.g. yyyy-mm-dd.
StatusOptional
Datatypeteidata.temporal.iso
from-isoindicates the starting point of the period in standard form.
StatusOptional
Datatypeteidata.temporal.iso
to-isoindicates the ending point of the period in standard form.
StatusOptional
Datatypeteidata.temporal.iso
Note

The value of these attributes should be a normalized representation of the date, time, or combined date & time intended, in any of the standard formats specified by ISO 8601:2004, using the Gregorian calendar.

If both when-iso and dur-iso are specified, the values should be interpreted as indicating a span of time by its starting time (or date) and duration. That is,
<date when-iso="2007-06-01dur-iso="P8D"/>
indicates the same time period as
<date when-iso="2007-06-01/P8D"/>

In providing a ‘regularized’ form, no claim is made that the form in the source text is incorrect; the regularized form is simply that chosen as the main form for purposes of unifying variant forms under a single heading.

Appendix A.3.11 att.datable.w3c

att.datable.w3c provides attributes for normalization of elements that contain datable events conforming to the W3C XML Schema Part 2: Datatypes Second Edition. [3.6.4. Dates and Times 13.4. Dates]
Moduletei
Membersatt.datable[acquisition affiliation author birth change date death district event idno licence location name nationality occupation orgName origin persName placeName region relation residence resp settlement state title trait]
Attributes
whensupplies the value of the date or time in a standard form, e.g. yyyy-mm-dd.
StatusOptional
Datatypeteidata.temporal.w3c
Examples of W3C date, time, and date & time formats.
<p>  <date when="1945-10-24">24 Oct 45</date>  <date when="1996-09-24T07:25:00Z">September 24th, 1996 at 3:25 in the morning</date>  <time when="1999-01-04T20:42:00-05:00">Jan 4 1999 at 8 pm</time>  <time when="14:12:38">fourteen twelve and 38 seconds</time>  <date when="1962-10">October of 1962</date>  <date when="--06-12">June 12th</date>  <date when="---01">the first of the month</date>  <date when="--08">August</date>  <date when="2006">MMVI</date>  <date when="0056">AD 56</date>  <date when="-0056">56 BC</date> </p>
This list begins in the year 1632, more precisely on Trinity Sunday, i.e. the Sunday after Pentecost, in that year the <date calendar="#julian"  when="1632-06-06">27th of May (old style)</date>.
<opener>  <dateline>   <placeName>Dorchester, Village,</placeName>   <date when="1828-03-02">March 2d. 1828.</date>  </dateline>  <salute>To    Mrs. Cornell,</salute> Sunday <time when="12:00:00">noon.</time> </opener>
notBeforespecifies the earliest possible date for the event in standard form, e.g. yyyy-mm-dd.
StatusOptional
Datatypeteidata.temporal.w3c
notAfterspecifies the latest possible date for the event in standard form, e.g. yyyy-mm-dd.
StatusOptional
Datatypeteidata.temporal.w3c
fromindicates the starting point of the period in standard form, e.g. yyyy-mm-dd.
StatusOptional
Datatypeteidata.temporal.w3c
toindicates the ending point of the period in standard form, e.g. yyyy-mm-dd.
StatusOptional
Datatypeteidata.temporal.w3c
Schematron
<sch:rule context="tei:*[@when]"> <sch:report test="@notBefore|@notAfter|@from|@to"  role="nonfatal">The @when attribute cannot be used with any other att.datable.w3c attributes.</sch:report> </sch:rule>
Schematron
<sch:rule context="tei:*[@from]"> <sch:report test="@notBefore"  role="nonfatal">The @from and @notBefore attributes cannot be used together.</sch:report> </sch:rule>
Schematron
<sch:rule context="tei:*[@to]"> <sch:report test="@notAfter"  role="nonfatal">The @to and @notAfter attributes cannot be used together.</sch:report> </sch:rule>
Example
<date from="1863-05-28to="1863-06-01">28 May through 1 June 1863</date>
Note

The value of these attributes should be a normalized representation of the date, time, or combined date & time intended, in any of the standard formats specified by XML Schema Part 2: Datatypes Second Edition, using the Gregorian calendar.

The most commonly-encountered format for the date portion of a temporal attribute is yyyy-mm-dd, but yyyy, --mm, ---dd, yyyy-mm, or --mm-dd may also be used. For the time part, the form hh:mm:ss is used.

Note that this format does not currently permit use of the value 0000 to represent the year 1 BCE; instead the value -0001 should be used.

Appendix A.3.12 att.datcat

att.datcat provides attributes that are used to align XML elements or attributes with the appropriate Data Categories (DCs) defined by an external taxonomy, in this way establishing the identity of information containers and values, and providing means of interpreting them. [9.5.2. Lexical View 18.3. Other Atomic Feature Values]
Moduletei
Membersatt.segLike[seg]
Attributes
datcatprovides a pointer to a definition of, and/or general information about, (a) an information container (element or attribute) or (b) a value of an information container (element content or attribute value), by referencing an external taxonomy or ontology. If valueDatcat is present in the immediate context, this attribute takes on role (a), while valueDatcat performs role (b).
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
valueDatcatprovides a definition of, and/or general information about a value of an information container (element content or attribute value), by reference to an external taxonomy or ontology. Used especially where a contrast with datcat is needed.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
targetDatcatprovides a definition of, and/or general information about, information structure of an object referenced or modeled by the containing element, by reference to an external taxonomy or ontology. This attribute has the characteristics of the datcat attribute, except that it addresses not its containing element, but an object that is being referenced or modeled by its containing element.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
ExampleThe example below presents the TEI encoding of the name-value pair <part of speech, common noun>, where the name (key) ‘part of speech’ is abbreviated as ‘POS’, and the value, ‘common noun’ is symbolized by ‘NN’. The entire name-value pair is encoded by means of the element <f>. In TEI XML, that element acts as the container, labeled with the name attribute. Its contents may be complex or simple. In the case at hand, the content is the symbol ‘NN’.The datcat attribute relates the feature name (i.e., the key) to the data category ‘part of speech’, while the attribute valueDatcat relates the feature value to the data category common noun. Both these data categories should be defined in an external and preferably open reference taxonomy or ontology.
<fs>  <f name="POS"   datcat="http://hdl.handle.net/11459/CCR_C-396_5a972b93-2294-ab5c-a541-7c344c5f26c3">   <symbol valueDatcat="http://hdl.handle.net/11459/CCR_C-1256_7ec6083c-23d4-224d-6f94-eecbe6861545"    value="NN"/>  </f> <!-- ... --> </fs>
‘NN’ is the symbol for common noun used e.g. in the CLAWS-7 tagset defined by the University Centre for Computer Corpus Research on Language at the University of Lancaster. The very same data category used for tagging an early version of the British National Corpus, and coming from the BNC Basic (C5) tagset, uses the symbol ‘NN0’ (rather than ‘NN’). Making these values semantically interoperable would be extremely difficult without a human expert if they were not anchored in a single point of an established reference taxonomy of morphosyntactic data categories. In the case at hand, the string http://hdl.handle.net/11459/CCR_C-1256_7ec6083c-23d4-224d-6f94-eecbe6861545 is both a persistent identifier of the data category in question, as well as a pointer to a shared definition of common noun.While the symbols ‘NN’, ‘NN0’, and many others (often coming from languages other than English) are implicitly members of the container category ‘part of speech’, it is sometimes useful not to rely on such an implicit relationship but rather use an explicit identifier for that data category, to distinguish it from other morphosyntactic data categories, such as gender, tense, etc. For that purpose, the above example uses the datcat attribute to reference a definition of part of speech. The reference taxonomy in this example is the CLARIN Concept Registry.If the feature structure markup exemplified above is to be repeated many times in a single document, it is much more efficient to gather the persistent identifiers in a single place and to only reference them, implicitly or directly, from feature structure markup. The following example is much more concise than the one above and relies on the concepts of feature structure declaration and feature value library, discussed in chapter [[undefined FS]].
<fs>  <f name="POSfVal="#commonNoun"/> <!-- ... --> </fs>
The assumption here is that the relevant feature values are collected in a place that the annotation document in question has access to — preferably, a single document per linguistic resource, for example an <fsdDecl> that is XIncluded as a sibling of <text> or a child of <encodingDesc>; a <taxonomy> available resource-wide (e.g., in a shared header) is also an option.The example below presents an <fvLib> element that collects the relevant feature values (most of them omitted). At the same time, this example shows one way of encoding a tagset, i.e., an established inventory of values of (in the case at hand) morphosyntactic categories.
<fvLib n="POS values">  <symbol xml:id="commonNounvalue="NN"   datcat="http://hdl.handle.net/11459/CCR_C-396_5a972b93-2294-ab5c-a541-7c344c5f26c3"/>  <symbol xml:id="properNounvalue="NP"   datcat="http://hdl.handle.net/11459/CCR_C-1371_fbebd9ec-a7f4-9a36-d6e9-88ee16b944ae"/> <!-- ... --> </fvLib>
Note that these Guidelines do not prescribe a specific choice between datcat and valueDatcat in such cases. The former is the generic way of referencing a data category, whereas the latter is more specific, in that it references a data category that represents a value. The choice between them comes into play where a single element — or a tight element complex, such as the <f>/<symbol> complex illustrated above — make it necessary or useful to distinguish between the container data category and its value.
ExampleIn the context of dictionaries designed with semantic interoperability in mind, the following example ensures that the <pos> element is interpreted as the same information container as in the case of the example of <f name="POS"> above.
<gramGrp>  <pos datcat="http://hdl.handle.net/11459/CCR_C-396_5a972b93-2294-ab5c-a541-7c344c5f26c3"   valueDatcat="http://hdl.handle.net/11459/CCR_C-1256_7ec6083c-23d4-224d-6f94-eecbe6861545">NN</pos> </gramGrp>
Efficiency of this type of interoperable markup demands that the references to the particular data categories should best be provided in a single place within the dictionary (or a single place within the project), rather than being repeated inside every entry. For the container elements, this can be achieved at the level of <tagUsage>, although here, the valueDatcat attribute should be used, because it is not the <tagUsage> element that is associated with the relevant data category, but rather the element <pos> (or <case>, etc.) that is described by <tagUsage>:
<tagsDecl partial="true"> <!-- ... -->  <namespace name="http://www.tei-c.org/ns/1.0">   <tagUsage gi="pos"    targetDatcat="http://hdl.handle.net/11459/CCR_C-396_5a972b93-2294-ab5c-a541-7c344c5f26c3">Contains the part of speech.</tagUsage>   <tagUsage gi="case"    targetDatcat="http://hdl.handle.net/11459/CCR_C-1840_9f4e319c-f233-6c90-9117-7270e215f039">Contains information about the grammatical case that the described form is inflected for.</tagUsage> <!-- ... -->  </namespace> </tagsDecl>
Another possibility is to shorten the URIs by means of the <prefixDef> mechanism, as illustrated below:
<listPrefixDef>  <prefixDef ident="ccrmatchPattern="pos"   replacementPattern="http://hdl.handle.net/11459/CCR_C-396_5a972b93-2294-ab5c-a541-7c344c5f26c3"/>  <prefixDef ident="ccrmatchPattern="adj"   replacementPattern="http://hdl.handle.net/11459/CCR_C-1230_23653c21-fca1-edf8-fd7c-3df2d6499157"/> </listPrefixDef> <!-- ... --> <entry> <!--...-->  <form>   <orth>isotope</orth>  </form>  <gramGrp>   <pos datcat="ccr:pos"    valueDatcat="ccr:adj">adj</pos>  </gramGrp> <!--...--> </entry>
This mechanism creates implications that are not always wanted, among others, in the case at hand, suggesting that the identifiers ‘pos’ and ‘adj’ belong to a namespace associated with the CLARIN Concept Repository (CCR), whereas that is solely a shorthand mechanism whose scope is the current resource. Documenting this clearly in the header of the dictionary is therefore advised.Yet another possibility is to associate the information about the relationship between a TEI markup element and the data category that it is intended to model already at the level of modeling the dictionary resource, that is, at the level of the ODD, in <equiv> element that is a child of <elementSpec> or <attDef>.
ExampleThe targetDatcat attribute is designed to be used in, e.g., feature structure declarations, and is analogous to the targetLang attribute of the att.pointing class, in that it describes the object that is being referenced, rather than the referencing object.
<fDecl name="POS"  targetDatcat="http://hdl.handle.net/11459/CCR_C-396_5a972b93-2294-ab5c-a541-7c344c5f26c3">  <fDescr>part of speech (morphosyntactic category)</fDescr>  <vRange>   <vAlt>    <symbol value="NN"     datcat="http://hdl.handle.net/11459/CCR_C-1256_7ec6083c-23d4-224d-6f94-eecbe6861545"/>    <symbol value="NP"     datcat="http://hdl.handle.net/11459/CCR_C-1371_fbebd9ec-a7f4-9a36-d6e9-88ee16b944ae"/> <!-- ... -->   </vAlt>  </vRange> </fDecl>
Above, the <fDecl> uses targetDatcat, because if it were to use datcat, it would be asserting that it is an instance of the container data category part of speech, whereas it is not — it models a container (<f>) that encodes a part of speech. Note also that it is the <f> that is modeled above, not its values, which are used as direct references to data categories; hence the use of datcat in the <symbol> element.
Note

The TEI Abstract Model can be expressed as a hierarchy of attribute-value matrices (AVMs) of various types and of various levels of complexity, nested or grouped in various ways. At the most abstract level, an AVM consists of an information container and the value (contents) of that container.

A simple example of an XML serialization of such structures is, on the one hand, the opening and closing tags that delimit and name the container, and, on the other, the content enclosed by the two tags that constitues the value. An analogous example is an attribute name and the value of that attribute.

In a TEI XML example of two equivalent serializations expressing the name-value pair <part-of-speech,common-noun>, namely <pos>commonNoun</pos> and pos="common-noun", one would classify the element <pos> and the attribute pos as containers (mapping onto the first member of the relevant name-value pair), while the character data content of <pos> or the value of pos would be seen as mapping onto the second member of the pair.

The att.datcat class provides means of addressing the containers and their values, while at the same time providing a way to interpret them in the context of external taxonomies or ontologies. Aligning e.g. both the <pos> element and the pos attribute with the same value of an external reference point (i.e., an entry in an agreed taxonomy) affirms the identity of the concept serialised by both the element container and the attribute container, and optionally provides a definition of that concept (in the case at hand, the concept part of speech).

The value of the att.datcat attributes should be a PID (persistent identifier) that points to a specific — and, ideally, shared — taxonomy or ontology. Among the resources that can, to a lesser or greater extent, be used as inventories of (more or less) standardized linguistic categories are the GOLD ontology, CLARIN CCR, OLiA, or TermWeb's DatCatInfo, and also the Universal Dependencies inventory, on the assumption that its URIs are going to persist. It is imaginable that a project may choose to address a local taxonomy store instead, but this risks losing the advantage of interchangeability with other projects.

Historically, datcat and valueDatcat originate from the (the now obsolete) ISO 12620:2009 standard, describing the data model and procedures for a Data Category Registry (DCR). The current version of that standard, ISO 12620-1, does not standardize the serialization of pointers, merely mentioning the TEI att.datcat as an example.

Note that no constraint prevents the occurrence of a combination of att.datcat attributes: the <fDecl> element, which is a natural bearer of the targetDatcat attribute, is an instance of a specific modeling element, and, in principle, could be semantically fixed by an appropriate reference taxonomy of modeling devices.

Appendix A.3.13 att.declarable

att.declarable provides attributes for those elements in the TEI header which may be independently selected by means of the special purpose decls attribute. [15.3. Associating Contextual Information with a Text]
Moduletei
Membersavailability bibl correspDesc equipment langUsage listEvent listObject listOrg listPerson listPlace recording samplingDecl settingDesc sourceDesc textClass
Attributes
defaultindicates whether or not this element is selected by default when its parent is selected.
StatusOptional
Datatypeteidata.truthValue
Legal values are:
true
This element is selected if its parent is selected
false
This element can only be selected explicitly, unless it is the only one of its kind, in which case it is selected if its parent is selected.[Default]
Note

The rules governing the association of declarable elements with individual parts of a TEI text are fully defined in chapter 15.3. Associating Contextual Information with a Text. Only one element of a particular type may have a default attribute with a value of true.

Appendix A.3.14 att.declaring

att.declaring provides attributes for elements which may be independently associated with a particular declarable element within the header, thus overriding the inherited default for that element. [15.3. Associating Contextual Information with a Text]
Moduletei
Membersab body div facsimile geo graphic lg media msDesc object p ref surface text u
Attributes
decls(declarations) identifies one or more declarable elements within the header, which are understood to apply to the element bearing this attribute and its content.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Note

The rules governing the association of declarable elements with individual parts of a TEI text are fully defined in chapter 15.3. Associating Contextual Information with a Text.

Appendix A.3.15 att.dimensions

att.dimensions provides attributes for describing the size of physical objects.
Moduletei
Membersbirth date death gap state supplied trait unclear
Attributes
unitnames the unit used for the measurement
StatusOptional
Datatypeteidata.enumerated
Suggested values include:
cm
(centimetres)
mm
(millimetres)
in
(inches)
line
lines of text
char
(characters) characters of text
quantityspecifies the length in the units specified
StatusOptional
Datatypeteidata.numeric
extentindicates the size of the object concerned using a project-specific vocabulary combining quantity and units in a single string of words.
StatusOptional
Datatypeteidata.text
<gap extent="5 words"/>
<height extent="half the page"/>
precisioncharacterizes the precision of the values specified by the other attributes.
StatusOptional
Datatypeteidata.certainty
scopewhere the measurement summarizes more than one observation, specifies the applicability of this measurement.
StatusOptional
Datatypeteidata.enumerated
Sample values include:
all
measurement applies to all instances.
most
measurement applies to most of the instances inspected.
range
measurement applies to only the specified range of instances.

Appendix A.3.16 att.divLike

att.divLike provides attributes common to all elements which behave in the same way as divisions. [4. Default Text Structure]
Moduletei
Membersdiv lg
Attributes
org(organization) specifies how the content of the division is organized.
StatusOptional
Datatypeteidata.enumerated
Legal values are:
composite
no claim is made about the sequence in which the immediate contents of this division are to be processed, or their inter-relationships.
uniform
the immediate contents of this element are regarded as forming a logical unit, to be processed in sequence.[Default]
sampleindicates whether this division is a sample of the original source and if so, from which part.
StatusOptional
Datatypeteidata.enumerated
Legal values are:
initial
division lacks material present at end in source.
medial
division lacks material at start and end.
final
division lacks material at start.
unknown
position of sampled material within original unknown.
complete
division is not a sample.[Default]

Appendix A.3.17 att.docStatus

att.docStatus provides attributes for use on metadata elements describing the status of a document.
Moduletei
Membersbibl change msDesc object revisionDesc
Attributes
statusdescribes the status of a document either currently or, when associated with a dated element, at the time indicated.
StatusOptional
Datatypeteidata.enumerated
Sample values include:
approved
candidate
cleared
deprecated
draft
[Default]
embargoed
expired
frozen
galley
proposed
published
recommendation
submitted
unfinished
withdrawn
Example
<revisionDesc status="published">  <change when="2010-10-21"   status="published"/>  <change when="2010-10-02status="cleared"/>  <change when="2010-08-02"   status="embargoed"/>  <change when="2010-05-01status="frozen"   who="#MSM"/>  <change when="2010-03-01status="draft"   who="#LB"/> </revisionDesc>

Appendix A.3.18 att.duration

att.duration provides attributes for normalization of elements that contain datable events.
Modulespoken
Membersatt.timed[annotationBlock gap incident media u] date recording
Attributes
Note

This ‘superclass’ provides attributes that can be used to provide normalized values of temporal information. By default, the attributes from the att.duration.w3c class are provided. If the module for names & dates is loaded, this class also provides attributes from the att.duration.iso class. In general, the possible values of attributes restricted to the W3C datatypes form a subset of those values available via the ISO 8601 standard. However, the greater expressiveness of the ISO datatypes is rarely needed, and there exists much greater software support for the W3C datatypes.

Appendix A.3.19 att.duration.iso

att.duration.iso provides attributes for recording normalized temporal durations. [3.6.4. Dates and Times 13.4. Dates]
Moduletei
Membersatt.duration[att.timed[annotationBlock gap incident media u] date recording]
Attributes
dur-iso(duration) indicates the length of this element in time.
StatusOptional
Datatypeteidata.duration.iso
Note

If both when and dur or dur-iso are specified, the values should be interpreted as indicating a span of time by its starting time (or date) and duration. In order to represent a time range by a duration and its ending time the when-iso attribute must be used.

In providing a ‘regularized’ form, no claim is made that the form in the source text is incorrect; the regularized form is simply that chosen as the main form for purposes of unifying variant forms under a single heading.

Appendix A.3.20 att.duration.w3c

att.duration.w3c provides attributes for recording normalized temporal durations. [3.6.4. Dates and Times 13.4. Dates]
Moduletei
Membersatt.duration[att.timed[annotationBlock gap incident media u] date recording]
Attributes
dur(duration) indicates the length of this element in time.
StatusOptional
Datatypeteidata.duration.w3c
Note

If both when and dur are specified, the values should be interpreted as indicating a span of time by its starting time (or date) and duration. In order to represent a time range by a duration and its ending time the when-iso attribute must be used.

In providing a ‘regularized’ form, no claim is made that the form in the source text is incorrect; the regularized form is simply that chosen as the main form for purposes of unifying variant forms under a single heading.

Appendix A.3.21 att.editLike

att.editLike provides attributes describing the nature of an encoded scholarly intervention or interpretation of any kind. [3.5. Simple Editorial Changes 10.3.1. Origination 13.3.2. The Person Element 11.3.1.1. Core Elements for Transcriptional Work]
Moduletei
Membersaffiliation birth corr date death event expan gap location name nationality occupation org orgName origin persName person place placeName reg relation residence state supplied trait unclear
Attributes
evidenceindicates the nature of the evidence supporting the reliability or accuracy of the intervention or interpretation.
StatusOptional
Datatype1–∞ occurrences of teidata.enumerated separated by whitespace
Suggested values include:
internal
there is internal evidence to support the intervention.
external
there is external evidence to support the intervention.
conjecture
the intervention or interpretation has been made by the editor, cataloguer, or scholar on the basis of their expertise.
instantindicates whether this is an instant revision or not.
StatusOptional
Datatypeteidata.xTruthValue
Defaultfalse
Note

The members of this attribute class are typically used to represent any kind of editorial intervention in a text, for example a correction or interpretation, or to date or localize manuscripts etc.

Each pointer on the source (if present) corresponding to a witness or witness group should reference a bibliographic citation such as a <witness>, <msDesc>, or <bibl> element, or another external bibliographic citation, documenting the source concerned.

Appendix A.3.22 att.edition

att.edition provides attributes identifying the source edition from which some encoded feature derives.
Moduletei
Memberscb lb milestone pb
Attributes
ed(edition) supplies a sigil or other arbitrary identifier for the source edition in which the associated feature (for example, a page, column, or line break) occurs at this point in the text.
StatusOptional
Datatype1–∞ occurrences of teidata.word separated by whitespace
edRef(edition reference) provides a pointer to the source edition in which the associated feature (for example, a page, column, or line break) occurs at this point in the text.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Example
<l>Of Mans First Disobedience,<lb ed="1674"/> and<lb ed="1667"/> the Fruit</l> <l>Of that Forbidden Tree, whose<lb ed="1667 1674"/> mortal tast</l> <l>Brought Death into the World,<lb ed="1667"/> and all<lb ed="1674"/> our woe,</l>
Example
<listBibl>  <bibl xml:id="stapledon1937">   <author>Olaf Stapledon</author>,  <title>Starmaker</title>, <publisher>Methuen</publisher>, <date>1937</date>  </bibl>  <bibl xml:id="stapledon1968">   <author>Olaf Stapledon</author>,  <title>Starmaker</title>, <publisher>Dover</publisher>, <date>1968</date>  </bibl> </listBibl> <!-- ... --> <p>Looking into the future aeons from the supreme moment of the cosmos, I saw the populations still with all their strength maintaining the<pb n="411edRef="#stapledon1968"/>essentials of their ancient culture, still living their personal lives in zest and endless novelty of action, … I saw myself still preserving, though with increasing difficulty, my lucid con-<pb n="291edRef="#stapledon1937"/>sciousness;</p>

Appendix A.3.23 att.fragmentable

att.fragmentable provides attributes for representing fragmentation of a structural element, typically as a consequence of some overlapping hierarchy.
Moduletei
Membersatt.divLike[div lg] att.segLike[seg] ab l p
Attributes
partspecifies whether or not its parent element is fragmented in some way, typically by some other overlapping structure: for example a speech which is divided between two or more verse stanzas, a paragraph which is split across a page division, a verse line which is divided between two speakers.
StatusOptional
Datatypeteidata.enumerated
Legal values are:
Y
(yes) the element is fragmented in some (unspecified) respect
N
(no) the element is not fragmented, or no claim is made as to its completeness[Default]
I
(initial) this is the initial part of a fragmented element
M
(medial) this is a medial part of a fragmented element
F
(final) this is the final part of a fragmented element
Note

The values I, M, or F should be used only where it is clear how the element may be reconstituted.

Appendix A.3.24 att.global

att.global provides attributes common to all elements in the TEI encoding scheme. [1.3.1.1. Global Attributes]
Moduletei
MembersTEI ab abbr abstract acquisition addName additional addrLine address adminInfo affiliation annotationBlock argument att author authority availability bibl birth body catRef cb cell change charDecl choice closer corr correspAction correspDesc date dateline death desc distributor district div divGen docAuthor docDate emph encodingDesc equipment event expan facsimile fileDesc foreign forename g gap geo gi glyph graphic head history idno incident item keywords l label langUsage language lb lg licence list listEvent listObject listOrg listPerson listPlace listRelation location mapping material media milestone msContents msDesc msIdentifier msItem name nationality note notesStmt num object objectIdentifier occupation opener org orgName orig origin p pb persName person physDesc place placeName postBox postCode profileDesc pubPlace publicationStmt publisher q quote recording recordingStmt ref reg region relatedItem relation repository residence resp respStmt revisionDesc roleName row rs salute samplingDecl seg setting settingDesc settlement sic signed sourceDesc state street summary supplied surface surname table teiHeader text textClass timeline title titleStmt trait u unclear when
Attributes
xml:id(identifier) provides a unique identifier for the element bearing the attribute.
StatusOptional
DatatypeID
Note

The xml:id attribute may be used to specify a canonical reference for an element; see section 3.11. Reference Systems.

n(number) gives a number (or other label) for an element, which is not necessarily unique within the document.
StatusOptional
Datatypeteidata.text
Note

The value of this attribute is always understood to be a single token, even if it contains space or other punctuation characters, and need not be composed of numbers only. It is typically used to specify the numbering of chapters, sections, list items, etc.; it may also be used in the specification of a standard reference system for the text.

xml:lang(language) indicates the language of the element content using a ‘tag’ generated according to BCP 47.
StatusOptional
Datatypeteidata.language
<p> … The consequences of this rapid depopulation were the loss of the last <foreign xml:lang="rap">ariki</foreign> or chief (Routledge 1920:205,210) and their connections to ancestral territorial organization.</p>
Note

The xml:lang value will be inherited from the immediately enclosing element, or from its parent, and so on up the document hierarchy. It is generally good practice to specify xml:lang at the highest appropriate level, noticing that a different default may be needed for the <teiHeader> from that needed for the associated resource element or elements, and that a single TEI document may contain texts in many languages.

Only attributes with free text values (rare in these guidelines) will be in the scope of xml:lang.

The authoritative list of registered language subtags is maintained by IANA and is available at http://www.iana.org/assignments/language-subtag-registry. For a good general overview of the construction of language tags, see https://www.w3.org/International/articles/language-tags/, and for a practical step-by-step guide, see https://www.w3.org/International/questions/qa-choosing-language-tags.en.php.

The value used must conform with BCP 47. If the value is a private use code (i.e., starts with x- or contains -x-), a <language> element with a matching value for its ident attribute should be supplied in the TEI header to document this value. Such documentation may also optionally be supplied for non-private-use codes, though these must remain consistent with their (IETF)Internet Engineering Task Force definitions.

xml:baseprovides a base URI reference with which applications can resolve relative URI references into absolute URI references.
StatusOptional
Datatypeteidata.pointer
<div type="bibl">  <head>Selections from <title level="m">The Collected Letters of Robert Southey. Part 1: 1791-1797</title>  </head>  <listBibl xml:base="https://romantic-circles.org/sites/default/files/imported/editions/southey_letters/XML/">   <bibl>    <ref target="letterEEd.26.3.xml">     <title>Robert Southey to Grosvenor Charles Bedford</title>, <date when="1792-04-03">3 April 1792</date>.    </ref>   </bibl>   <bibl>    <ref target="letterEEd.26.57.xml">     <title>Robert Southey to Anna Seward</title>, <date when="1793-09-18">18 September 1793</date>.    </ref>   </bibl>   <bibl>    <ref target="letterEEd.26.85.xml">     <title>Robert Southey to Robert Lovell</title>, <date from="1794-04-05"      to="1794-04-06">5-6 April, 1794</date>.    </ref>   </bibl>  </listBibl> </div>
xml:spacesignals an intention about how white space should be managed by applications.
StatusOptional
Datatypeteidata.enumerated
Legal values are:
default
signals that the application's default white-space processing modes are acceptable
preserve
indicates the intent that applications preserve all white space
Note

The XML specification provides further guidance on the use of this attribute. Note that many parsers may not handle xml:space correctly.

Appendix A.3.25 att.global.analytic

att.global.analytic provides additional global attributes for associating specific analyses or interpretations with appropriate portions of a text. [17.2. Global Attributes for Simple Analyses 17.3. Spans and Interpretations]
Moduleanalysis
Membersatt.global[TEI ab abbr abstract acquisition addName additional addrLine address adminInfo affiliation annotationBlock argument att author authority availability bibl birth body catRef cb cell change charDecl choice closer corr correspAction correspDesc date dateline death desc distributor district div divGen docAuthor docDate emph encodingDesc equipment event expan facsimile fileDesc foreign forename g gap geo gi glyph graphic head history idno incident item keywords l label langUsage language lb lg licence list listEvent listObject listOrg listPerson listPlace listRelation location mapping material media milestone msContents msDesc msIdentifier msItem name nationality note notesStmt num object objectIdentifier occupation opener org orgName orig origin p pb persName person physDesc place placeName postBox postCode profileDesc pubPlace publicationStmt publisher q quote recording recordingStmt ref reg region relatedItem relation repository residence resp respStmt revisionDesc roleName row rs salute samplingDecl seg setting settingDesc settlement sic signed sourceDesc state street summary supplied surface surname table teiHeader text textClass timeline title titleStmt trait u unclear when]
Attributes
ana(analysis) indicates one or more elements containing interpretations of the element on which the ana attribute appears.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Note

When multiple values are given, they may reflect either multiple divergent interpretations of an ambiguous text, or multiple mutually consistent interpretations of the same passage in different contexts.

Appendix A.3.26 att.global.change

att.global.change provides attributes allowing its member elements to specify one or more states or revision campaigns with which they are associated.
Moduletranscr
Membersatt.global[TEI ab abbr abstract acquisition addName additional addrLine address adminInfo affiliation annotationBlock argument att author authority availability bibl birth body catRef cb cell change charDecl choice closer corr correspAction correspDesc date dateline death desc distributor district div divGen docAuthor docDate emph encodingDesc equipment event expan facsimile fileDesc foreign forename g gap geo gi glyph graphic head history idno incident item keywords l label langUsage language lb lg licence list listEvent listObject listOrg listPerson listPlace listRelation location mapping material media milestone msContents msDesc msIdentifier msItem name nationality note notesStmt num object objectIdentifier occupation opener org orgName orig origin p pb persName person physDesc place placeName postBox postCode profileDesc pubPlace publicationStmt publisher q quote recording recordingStmt ref reg region relatedItem relation repository residence resp respStmt revisionDesc roleName row rs salute samplingDecl seg setting settingDesc settlement sic signed sourceDesc state street summary supplied surface surname table teiHeader text textClass timeline title titleStmt trait u unclear when]
Attributes
changepoints to one or more <change> elements documenting a state or revision campaign to which the element bearing this attribute and its children have been assigned by the encoder.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace

Appendix A.3.27 att.global.facs

att.global.facs provides attributes used to express correspondence between an element and all or part of a facsimile image or surface. [11.1. Digital Facsimiles]
Moduletranscr
Membersatt.global[TEI ab abbr abstract acquisition addName additional addrLine address adminInfo affiliation annotationBlock argument att author authority availability bibl birth body catRef cb cell change charDecl choice closer corr correspAction correspDesc date dateline death desc distributor district div divGen docAuthor docDate emph encodingDesc equipment event expan facsimile fileDesc foreign forename g gap geo gi glyph graphic head history idno incident item keywords l label langUsage language lb lg licence list listEvent listObject listOrg listPerson listPlace listRelation location mapping material media milestone msContents msDesc msIdentifier msItem name nationality note notesStmt num object objectIdentifier occupation opener org orgName orig origin p pb persName person physDesc place placeName postBox postCode profileDesc pubPlace publicationStmt publisher q quote recording recordingStmt ref reg region relatedItem relation repository residence resp respStmt revisionDesc roleName row rs salute samplingDecl seg setting settingDesc settlement sic signed sourceDesc state street summary supplied surface surname table teiHeader text textClass timeline title titleStmt trait u unclear when]
Attributes
facs(facsimile) points to one or more images, portions of an image, or surfaces which correspond to the current element.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace

Appendix A.3.28 att.global.linking

att.global.linking provides a set of attributes for hypertextual linking. [16. Linking, Segmentation, and Alignment]
Modulelinking
Membersatt.global[TEI ab abbr abstract acquisition addName additional addrLine address adminInfo affiliation annotationBlock argument att author authority availability bibl birth body catRef cb cell change charDecl choice closer corr correspAction correspDesc date dateline death desc distributor district div divGen docAuthor docDate emph encodingDesc equipment event expan facsimile fileDesc foreign forename g gap geo gi glyph graphic head history idno incident item keywords l label langUsage language lb lg licence list listEvent listObject listOrg listPerson listPlace listRelation location mapping material media milestone msContents msDesc msIdentifier msItem name nationality note notesStmt num object objectIdentifier occupation opener org orgName orig origin p pb persName person physDesc place placeName postBox postCode profileDesc pubPlace publicationStmt publisher q quote recording recordingStmt ref reg region relatedItem relation repository residence resp respStmt revisionDesc roleName row rs salute samplingDecl seg setting settingDesc settlement sic signed sourceDesc state street summary supplied surface surname table teiHeader text textClass timeline title titleStmt trait u unclear when]
Attributes
corresp(corresponds) points to elements that correspond to the current element in some way.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
<group>  <text xml:id="t1-g1-t1"   xml:lang="mi">   <body xml:id="t1-g1-t1-body1">    <div type="chapter">     <head>He Whakamaramatanga mo te Ture Hoko, Riihi hoki, i nga Whenua Maori, 1876.</head>     <p></p>    </div>   </body>  </text>  <text xml:id="t1-g1-t2"   xml:lang="en">   <body xml:id="t1-g1-t2-body1"    corresp="#t1-g1-t1-body1">    <div type="chapter">     <head>An Act to regulate the Sale, Letting, and Disposal of Native Lands, 1876.</head>     <p></p>    </div>   </body>  </text> </group>
In this example a <group> contains two <text>s, each containing the same document in a different language. The correspondence is indicated using corresp. The language is indicated using xml:lang, whose value is inherited; both the tag with the corresp and the tag pointed to by the corresp inherit the value from their immediate parent.
<!-- In a placeography called "places.xml" --><place xml:id="LOND1"  corresp="people.xml#LOND2 people.xml#GENI1">  <placeName>London</placeName>  <desc>The city of London...</desc> </place> <!-- In a literary personography called "people.xml" --> <person xml:id="LOND2"  corresp="places.xml#LOND1 #GENI1">  <persName type="lit">London</persName>  <note>   <p>Allegorical character representing the city of <placeName ref="places.xml#LOND1">London</placeName>.</p>  </note> </person> <person xml:id="GENI1"  corresp="places.xml#LOND1 #LOND2">  <persName type="lit">London’s Genius</persName>  <note>   <p>Personification of London’s genius. Appears as an      allegorical character in mayoral shows.   </p>  </note> </person>
In this example, a <place> element containing information about the city of London is linked with two <person> elements in a literary personography. This correspondence represents a slightly looser relationship than the one in the preceding example; there is no sense in which an allegorical character could be substituted for the physical city, or vice versa, but there is obviously a correspondence between them.
synch(synchronous) points to elements that are synchronous with the current element.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
sameAspoints to an element that is the same as the current element.
StatusOptional
Datatypeteidata.pointer
copyOfpoints to an element of which the current element is a copy.
StatusOptional
Datatypeteidata.pointer
Note

Any content of the current element should be ignored. Its true content is that of the element being pointed at.

nextpoints to the next element of a virtual aggregate of which the current element is part.
StatusOptional
Datatypeteidata.pointer
Note

It is recommended that the element indicated be of the same type as the element bearing this attribute.

prev(previous) points to the previous element of a virtual aggregate of which the current element is part.
StatusOptional
Datatypeteidata.pointer
Note

It is recommended that the element indicated be of the same type as the element bearing this attribute.

excludepoints to elements that are in exclusive alternation with the current element.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
selectselects one or more alternants; if one alternant is selected, the ambiguity or uncertainty is marked as resolved. If more than one alternant is selected, the degree of ambiguity or uncertainty is marked as reduced by the number of alternants not selected.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Note

This attribute should be placed on an element which is superordinate to all of the alternants from which the selection is being made.

Appendix A.3.29 att.global.rendition

att.global.rendition provides rendering attributes common to all elements in the TEI encoding scheme. [1.3.1.1.3. Rendition Indicators]
Moduletei
Membersatt.global[TEI ab abbr abstract acquisition addName additional addrLine address adminInfo affiliation annotationBlock argument att author authority availability bibl birth body catRef cb cell change charDecl choice closer corr correspAction correspDesc date dateline death desc distributor district div divGen docAuthor docDate emph encodingDesc equipment event expan facsimile fileDesc foreign forename g gap geo gi glyph graphic head history idno incident item keywords l label langUsage language lb lg licence list listEvent listObject listOrg listPerson listPlace listRelation location mapping material media milestone msContents msDesc msIdentifier msItem name nationality note notesStmt num object objectIdentifier occupation opener org orgName orig origin p pb persName person physDesc place placeName postBox postCode profileDesc pubPlace publicationStmt publisher q quote recording recordingStmt ref reg region relatedItem relation repository residence resp respStmt revisionDesc roleName row rs salute samplingDecl seg setting settingDesc settlement sic signed sourceDesc state street summary supplied surface surname table teiHeader text textClass timeline title titleStmt trait u unclear when]
Attributes
rend(rendition) indicates how the element in question was rendered or presented in the source text.
StatusOptional
Datatype1–∞ occurrences of teidata.word separated by whitespace
<head rend="align(center) case(allcaps)">  <lb/>To The <lb/>Duchesse <lb/>of <lb/>Newcastle, <lb/>On Her <lb/>  <hi rend="case(mixed)">New Blazing-World</hi>. </head>
Note

These Guidelines make no binding recommendations for the values of the rend attribute; the characteristics of visual presentation vary too much from text to text and the decision to record or ignore individual characteristics varies too much from project to project. Some potentially useful conventions are noted from time to time at appropriate points in the Guidelines. The values of the rend attribute are a set of sequence-indeterminate individual tokens separated by whitespace.

stylecontains an expression in some formal style definition language which defines the rendering or presentation used for this element in the source text
StatusOptional
Datatypeteidata.text
<head style="text-align: center; font-variant: small-caps">  <lb/>To The <lb/>Duchesse <lb/>of <lb/>Newcastle, <lb/>On Her <lb/>  <hi style="font-variant: normal">New Blazing-World</hi>. </head>
Note

Unlike the attribute values of rend, which uses whitespace as a separator, the style attribute may contain whitespace. This attribute is intended for recording inline stylistic information concerning the source, not any particular output.

The formal language in which values for this attribute are expressed may be specified using the <styleDefDecl> element in the TEI header.

If style and rendition are both present on an element, then style overrides or complements rendition. style should not be used in conjunction with rend, because the latter does not employ a formal style definition language.

renditionpoints to a description of the rendering or presentation used for this element in the source text.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
<head rendition="#ac #sc">  <lb/>To The <lb/>Duchesse <lb/>of <lb/>Newcastle, <lb/>On Her <lb/>  <hi rendition="#normal">New Blazing-World</hi>. </head> <!-- elsewhere... --> <rendition xml:id="sc"  scheme="css">font-variant: small-caps</rendition> <rendition xml:id="normal"  scheme="css">font-variant: normal</rendition> <rendition xml:id="ac"  scheme="css">text-align: center</rendition>
Note

The rendition attribute is used in a very similar way to the class attribute defined for XHTML but with the important distinction that its function is to describe the appearance of the source text, not necessarily to determine how that text should be presented on screen or paper.

If rendition is used to refer to a style definition in a formal language like CSS, it is recommended that it not be used in conjunction with rend. Where both rendition and rend are supplied, the latter is understood to override or complement the former.

Each URI provided should indicate a <rendition> element defining the intended rendition in terms of some appropriate style language, as indicated by the scheme attribute.

Appendix A.3.30 att.global.responsibility

att.global.responsibility provides attributes indicating the agent responsible for some aspect of the text, the markup or something asserted by the markup, and the degree of certainty associated with it. [1.3.1.1.4. Sources, certainty, and responsibility 3.5. Simple Editorial Changes 11.3.2.2. Hand, Responsibility, and Certainty Attributes 17.3. Spans and Interpretations 13.1.1. Linking Names and Their Referents]
Moduletei
Membersatt.global[TEI ab abbr abstract acquisition addName additional addrLine address adminInfo affiliation annotationBlock argument att author authority availability bibl birth body catRef cb cell change charDecl choice closer corr correspAction correspDesc date dateline death desc distributor district div divGen docAuthor docDate emph encodingDesc equipment event expan facsimile fileDesc foreign forename g gap geo gi glyph graphic head history idno incident item keywords l label langUsage language lb lg licence list listEvent listObject listOrg listPerson listPlace listRelation location mapping material media milestone msContents msDesc msIdentifier msItem name nationality note notesStmt num object objectIdentifier occupation opener org orgName orig origin p pb persName person physDesc place placeName postBox postCode profileDesc pubPlace publicationStmt publisher q quote recording recordingStmt ref reg region relatedItem relation repository residence resp respStmt revisionDesc roleName row rs salute samplingDecl seg setting settingDesc settlement sic signed sourceDesc state street summary supplied surface surname table teiHeader text textClass timeline title titleStmt trait u unclear when]
Attributes
cert(certainty) signifies the degree of certainty associated with the intervention or interpretation.
StatusOptional
Datatypeteidata.probCert
resp(responsible party) indicates the agency responsible for the intervention or interpretation, for example an editor or transcriber.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Note

To reduce the ambiguity of a resp pointing directly to a person or organization, we recommend that resp be used to point not to an agent (<person> or <org>) but to a <respStmt>, <author>, <editor> or similar element which clarifies the exact role played by the agent. Pointing to multiple <respStmt>s allows the encoder to specify clearly each of the roles played in part of a TEI file (creating, transcribing, encoding, editing, proofing etc.).

Example
Blessed are the <choice>  <sic>cheesemakers</sic>  <corr resp="#editorcert="high">peacemakers</corr> </choice>: for they shall be called the children of God.
Example
<!-- in the <text> ... --><lg> <!-- ... -->  <l>Punkes, Panders, baſe extortionizing    sla<choice>    <sic>n</sic>    <corr resp="#JENS1_transcriber">u</corr>   </choice>es,</l> <!-- ... --> </lg> <!-- in the <teiHeader> ... --> <!-- ... --> <respStmt xml:id="JENS1_transcriber">  <resp when="2014">Transcriber</resp>  <name>Janelle Jenstad</name> </respStmt>

Appendix A.3.31 att.global.source

att.global.source provides attributes used by elements to point to an external source. [1.3.1.1.4. Sources, certainty, and responsibility 3.3.3. Quotation 8.3.4. Writing]
Moduletei
Membersatt.global[TEI ab abbr abstract acquisition addName additional addrLine address adminInfo affiliation annotationBlock argument att author authority availability bibl birth body catRef cb cell change charDecl choice closer corr correspAction correspDesc date dateline death desc distributor district div divGen docAuthor docDate emph encodingDesc equipment event expan facsimile fileDesc foreign forename g gap geo gi glyph graphic head history idno incident item keywords l label langUsage language lb lg licence list listEvent listObject listOrg listPerson listPlace listRelation location mapping material media milestone msContents msDesc msIdentifier msItem name nationality note notesStmt num object objectIdentifier occupation opener org orgName orig origin p pb persName person physDesc place placeName postBox postCode profileDesc pubPlace publicationStmt publisher q quote recording recordingStmt ref reg region relatedItem relation repository residence resp respStmt revisionDesc roleName row rs salute samplingDecl seg setting settingDesc settlement sic signed sourceDesc state street summary supplied surface surname table teiHeader text textClass timeline title titleStmt trait u unclear when]
Attributes
sourcespecifies the source from which some aspect of this element is drawn.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Schematron
<sch:rule context="tei:*[@source]"> <sch:let name="srcs"  value="tokenize( normalize-space(@source),' ')"/> <sch:report test="( self::tei:classRef | self::tei:dataRef | self::tei:elementRef | self::tei:macroRef | self::tei:moduleRef | self::tei:schemaSpec ) and $srcs[2]"> When used on a schema description element (like <sch:value-of select="name(.)"/>), the @source attribute should have only 1 value. (This one has <sch:value-of select="count($srcs)"/>.) </sch:report> </sch:rule>
Note

The source attribute points to an external source. When used on an element describing a schema component (<classRef>, <dataRef>, <elementRef>, <macroRef>, <moduleRef>, or <schemaSpec>), it identifies the source from which declarations for the components should be obtained.

On other elements it provides a pointer to the bibliographical source from which a quotation or citation is drawn.

In either case, the location may be provided using any form of URI, for example an absolute URI, a relative URI, a private scheme URI of the form tei:x.y.z, where x.y.z indicates the version number, e.g. tei:4.3.2 for TEI P5 release 4.3.2 or (as a special case) tei:current for whatever is the latest release, or a private scheme URI that is expanded to an absolute URI as documented in a <prefixDef>.

When used on elements describing schema components, source should have only one value; when used on other elements multiple values are permitted.

Example
<p> <!-- ... --> As Willard McCarty (<bibl xml:id="mcc_2012">2012, p.2</bibl>) tells us, <quote source="#mcc_2012">‘Collaboration’ is a problematic and should be a contested    term.</quote> <!-- ... --> </p>
Example
<p> <!-- ... -->  <quote source="#chicago_15_ed">Grammatical theories are in flux, and the more we learn, the    less we seem to know.</quote> <!-- ... --> </p> <!-- ... --> <bibl xml:id="chicago_15_ed">  <title level="m">The Chicago Manual of Style</title>, <edition>15th edition</edition>. <pubPlace>Chicago</pubPlace>: <publisher>University of    Chicago Press</publisher> (<date>2003</date>), <biblScope unit="page">p.147</biblScope>. </bibl>
Example
<elementRef key="psource="tei:2.0.1"/>
Include in the schema an element named <p> available from the TEI P5 2.0.1 release.
Example
<schemaSpec ident="myODD"  source="mycompiledODD.xml"> <!-- further declarations specifying the components required --> </schemaSpec>
Create a schema using components taken from the file mycompiledODD.xml.

Appendix A.3.32 att.internetMedia

att.internetMedia provides attributes for specifying the type of a computer resource using a standard taxonomy.
Moduletei
Membersatt.media[graphic media] ref
Attributes
mimeType(MIME media type) specifies the applicable multimedia internet mail extension (MIME) media type
StatusOptional
Datatype1–∞ occurrences of teidata.word separated by whitespace
ExampleIn this example mimeType is used to indicate that the URL points to a TEI XML file encoded in UTF-8.
<ref mimeType="application/tei+xml; charset=UTF-8"  target="https://raw.githubusercontent.com/TEIC/TEI/dev/P5/Source/guidelines-en.xml"/>
Note

This attribute class provides an attribute for describing a computer resource, typically available over the internet, using a value taken from a standard taxonomy. At present only a single taxonomy is supported, the Multipurpose Internet Mail Extensions (MIME) Media Type system. This typology of media types is defined by the Internet Engineering Task Force in RFC 2046. The list of types is maintained by the Internet Assigned Numbers Authority (IANA). The mimeType attribute must have a value taken from this list.

Appendix A.3.33 att.locatable

att.locatable provides attributes for referencing locations by pointing to entries in a canonical list of places. [2.3.9. The Unit Declaration 13.3.4.3. States, Traits, and Events]
Moduletei
Membersevent
Attributes
whereindicates one or more locations by pointing to a <place> element or other canonical description.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace

Appendix A.3.34 att.media

att.media provides attributes for specifying display and related properties of external media.
Moduletei
Membersgraphic media
Attributes
widthWhere the media are displayed, indicates the display width
StatusOptional
Datatypeteidata.outputMeasurement
heightWhere the media are displayed, indicates the display height
StatusOptional
Datatypeteidata.outputMeasurement
scaleWhere the media are displayed, indicates a scale factor to be applied when generating the desired display size
StatusOptional
Datatypeteidata.numeric

Appendix A.3.35 att.milestoneUnit

att.milestoneUnit provides attributes to indicate the type of section which is changing at a specific milestone. [3.11.3. Milestone Elements 2.3.6.3. Milestone Method 2.3.6. The Reference System Declaration]
Modulecore
Membersmilestone
Attributes
unitprovides a conventional name for the kind of section changing at this milestone.
StatusRequired
Datatypeteidata.enumerated
Suggested values include:
page
physical page breaks (synonymous with the <pb> element).
column
column breaks.
line
line breaks (synonymous with the <lb> element).
book
any units termed book, liber, etc.
poem
individual poems in a collection.
canto
cantos or other major sections of a poem.
speaker
changes of speaker or narrator.
stanza
stanzas within a poem, book, or canto.
act
acts within a play.
scene
scenes within a play or act.
section
sections of any kind.
absent
passages not present in the reference edition.
unnumbered
passages present in the text, but not to be included as part of the reference.
<milestone n="23"  ed="La"  unit="Dreissiger"/> ... <milestone n="24"  ed="AV"  unit="verse"/> ...
Note

If the milestone marks the beginning of a piece of text not present in the reference edition, the special value absent may be used as the value of unit. The normal interpretation is that the reference edition does not contain the text which follows, until the next <milestone> tag for the edition in question is encountered.

In addition to the values suggested, other terms may be appropriate (e.g. Stephanus for the Stephanus numbers in Plato).

The type attribute may be used to characterize the unit boundary in any respect other than simply identifying the type of unit, for example as word-breaking or not.

Appendix A.3.36 att.msClass

att.msClass provides attributes to indicate text type or classification. [10.6. Intellectual Content 10.6.1. The msItem and msItemStruct Elements]
Modulemsdescription
MembersmsContents msItem
Attributes
classidentifies the text types or classifications applicable to this item by pointing to other elements or resources defining the classification concerned.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace

Appendix A.3.37 att.msExcerpt

att.msExcerpt (manuscript excerpt) provides attributes used to describe excerpts from a manuscript placed in a description thereof. [10.6. Intellectual Content]
Modulemsdescription
MembersmsContents msItem quote
Attributes
defectiveindicates whether the passage being quoted is defective, i.e. incomplete through loss or damage.
StatusOptional
Datatypeteidata.xTruthValue
Note

In the case of an incipit, indicates whether the incipit as given is defective, i.e. the first words of the text as preserved, as opposed to the first words of the work itself. In the case of an explicit, indicates whether the explicit as given is defective, i.e. the final words of the text as preserved, as opposed to what the closing words would have been had the text of the work been whole.

Appendix A.3.38 att.naming

att.naming provides attributes common to elements which refer to named persons, places, organizations etc. [3.6.1. Referring Strings 13.3.6. Names and Nyms]
Moduletei
Membersatt.personal[addName forename name orgName persName placeName roleName surname] affiliation author birth death district event nationality occupation pubPlace region repository residence rs settlement state trait
Attributes
rolemay be used to specify further information about the entity referenced by this name in the form of a set of whitespace-separated values, for example the occupation of a person, or the status of a place.
StatusOptional
Datatype1–∞ occurrences of teidata.enumerated separated by whitespace
nymRef(reference to the canonical name) provides a means of locating the canonical form (nym) of the names associated with the object named by the element bearing it.
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Note

The value must point directly to one or more XML elements by means of one or more URIs, separated by whitespace. If more than one is supplied, the implication is that the name is associated with several distinct canonical names.

Appendix A.3.39 att.notated

att.notated provides attributes to indicate any specialised notation used for element content.
Moduletei
Membersquote seg u
Attributes
notationnames the notation used for the content of the element.
StatusOptional
Datatypeteidata.enumerated

Appendix A.3.40 att.personal

att.personal (attributes for components of names usually, but not necessarily, personal names) common attributes for those elements which form part of a name usually, but not necessarily, a personal name. [13.2.1. Personal Names]
Moduletei
MembersaddName forename name orgName persName placeName roleName surname
Attributes
fullindicates whether the name component is given in full, as an abbreviation or simply as an initial.
StatusOptional
Datatypeteidata.enumerated
Legal values are:
yes
(yes) the name component is spelled out in full.[Default]
abb
(abbreviated) the name component is given in an abbreviated form.
init
(initial letter) the name component is indicated only by one initial.
sort(sort) specifies the sort order of the name component in relation to others within the name.
StatusOptional
Datatypeteidata.count

Appendix A.3.41 att.placement

att.placement provides attributes for describing where on the source page or object a textual element appears. [3.5.3. Additions, Deletions, and Omissions 11.3.1.4. Additions and Deletions]
Moduletei
Membershead label note
Attributes
placespecifies where this item is placed.
StatusRecommended
Datatype1–∞ occurrences of teidata.enumerated separated by whitespace
Suggested values include:
top
at the top of the page
bottom
at the foot of the page
margin
in the margin (left, right, or both)
opposite
on the opposite, i.e. facing, page
overleaf
on the other side of the leaf
above
above the line
right
to the right, e.g. to the right of a vertical line of text, or to the right of a figure
below
below the line
left
to the left, e.g. to the left of a vertical line of text, or to the left of a figure
end
at the end of e.g. chapter or volume.
inline
within the body of the text.
inspace
in a predefined space, for example left by an earlier scribe.
<add place="margin">[An addition written in the margin]</add> <add place="bottom opposite">[An addition written at the foot of the current page and also on the facing page]</add>
<note place="bottom">Ibid, p.7</note>

Appendix A.3.42 att.pointing

att.pointing provides a set of attributes used by all elements which point to other elements by means of one or more URI references. [1.3.1.1.2. Language Indicators 3.7. Simple Links and Cross-References]
Moduletei
MemberscatRef licence note ref
Attributes
targetLangspecifies the language of the content to be found at the destination referenced by target, using a ‘language tag’ generated according to BCP 47.
StatusOptional
Datatypeteidata.language
Schematron
<sch:rule context="tei:*[not(self::tei:schemaSpec)][@targetLang]"> <sch:assert test="@target">@targetLang should only be used on <sch:name/> if @target is specified.</sch:assert> </sch:rule>
<linkGrp xml:id="pol-swh_aln_2.1-linkGrp">  <ptr xml:id="pol-swh_aln_2.1.1-ptr"   target="pol/UDHR/text.xml#pol_txt_1-head"   type="tuv"   targetLang="pl"/>  <ptr xml:id="pol-swh_aln_2.1.2-ptr"   target="swh/UDHR/text.xml#swh_txt_1-head"   type="tuv"   targetLang="sw"/> </linkGrp>
In the example above, the <linkGrp> combines pointers at parallel fragments of the Universal Declaration of Human Rights: one of them is in Polish, the other in Swahili.
Note

The value must conform to BCP 47. If the value is a private use code (i.e., starts with x- or contains -x-), a <language> element with a matching value for its ident attribute should be supplied in the TEI header to document this value. Such documentation may also optionally be supplied for non-private-use codes, though these must remain consistent with their (IETF)Internet Engineering Task Force definitions.

targetspecifies the destination of the reference by supplying one or more URI References
StatusOptional
Datatype1–∞ occurrences of teidata.pointer separated by whitespace
Note

One or more syntactically valid URI references, separated by whitespace. Because whitespace is used to separate URIs, no whitespace is permitted inside a single URI. If a whitespace character is required in a URI, it should be escaped with the normal mechanism, e.g. TEI%20Consortium.

evaluate(evaluate) specifies the intended meaning when the target of a pointer is itself a pointer.
StatusOptional
Datatypeteidata.enumerated
Legal values are:
all
if the element pointed to is itself a pointer, then the target of that pointer will be taken, and so on, until an element is found which is not a pointer.
one
if the element pointed to is itself a pointer, then its target (whether a pointer or not) is taken as the target of this pointer.
none
no further evaluation of targets is carried out beyond that needed to find the element specified in the pointer's target.
Note

If no value is given, the application program is responsible for deciding (possibly on the basis of user input) how far to trace a chain of pointers.

Appendix A.3.43 att.ranging

att.ranging provides attributes for describing numerical ranges.
Moduletei
Membersatt.dimensions[birth date death gap state supplied trait unclear] num
Attributes
atLeastgives a minimum estimated value for the approximate measurement.
StatusOptional
Datatypeteidata.numeric
atMostgives a maximum estimated value for the approximate measurement.
StatusOptional
Datatypeteidata.numeric
minwhere the measurement summarizes more than one observation or a range, supplies the minimum value observed.
StatusOptional
Datatypeteidata.numeric
maxwhere the measurement summarizes more than one observation or a range, supplies the maximum value observed.
StatusOptional
Datatypeteidata.numeric
confidencespecifies the degree of statistical confidence (between zero and one) that a value falls within the range specified by min and max, or the proportion of observed values that fall within that range.
StatusOptional
Datatypeteidata.probability
Example
The MS. was lost in transmission by mail from <del rend="overstrike">  <gap reason="illegible"   extent="one or two lettersatLeast="1atMost="2unit="chars"/> </del> Philadelphia to the Graphic office, New York.
Example
Americares has been supporting the health sector in Eastern Europe since 1986, and since 1992 has provided <measure atLeast="120000000unit="USD"  commodity="currency">more than $120m</measure> in aid to Ukrainians.

Appendix A.3.44 att.resourced

att.resourced provides attributes by which a resource (such as an externally held media file) may be located.
Moduletei
Membersgraphic media
Attributes
url(uniform resource locator) specifies the URL from which the media concerned may be obtained.
StatusRequired
Datatypeteidata.pointer
SchematronURL (in att.resourced) should never have spaces.
<sch:pattern> <sch:rule context="tei:*[@url]">  <sch:assert test="not(matches(@url,'\s'))">ERROR: @url on element <sch:name/> should not have a space character.</sch:assert> </sch:rule> </sch:pattern>

Appendix A.3.45 att.segLike

att.segLike provides attributes for elements used for arbitrary segmentation. [16.3. Blocks, Segments, and Anchors 17.1. Linguistic Segment Categories]
Moduletei
Membersseg
Attributes
function(function) characterizes the function of the segment.
StatusOptional
Datatypeteidata.enumerated
Note

Attribute values will often vary depending on the type of element to which they are attached. For example, a <cl>, may take values such as coordinate, subject, adverbial etc. For a <phr>, such values as subject, predicate etc. may be more appropriate. Such constraints will typically be implemented by a project-defined customization.

Appendix A.3.46 att.sortable

att.sortable provides attributes for elements in lists or groups that are sortable, but whose sorting key cannot be derived mechanically from the element content. [9.1. Dictionary Body and Overall Structure]
Moduletei
Membersbibl correspAction event idno item list listEvent listObject listOrg listPerson listPlace listRelation msDesc object org person place relation
Attributes
sortKeysupplies the sort key for this element in an index, list or group which contains it.
StatusOptional
Datatypeteidata.word
David's other principal backer, Josiah ha-Kohen <index indexName="NAMES">  <term sortKey="Azarya_Josiah_Kohen">Josiah ha-Kohen b. Azarya</term> </index> b. Azarya, son of one of the last gaons of Sura was David's own first cousin.
Note

The sort key is used to determine the sequence and grouping of entries in an index. It provides a sequence of characters which, when sorted with the other values, will produced the desired order; specifics of sort key construction are application-dependent

Dictionary order often differs from the collation sequence of machine-readable character sets; in English-language dictionaries, an entry for 4-H will often appear alphabetized under ‘fourh’, and McCoy may be alphabetized under ‘maccoy’, while A1, A4, and A5 may all appear in numeric order ‘alphabetized’ between ‘a-’ and ‘AA’. The sort key is required if the orthography of the dictionary entry does not suffice to determine its location.

Appendix A.3.47 att.spanning

att.spanning provides attributes for elements which delimit a span of text by pointing mechanisms rather than by enclosing it. [11.3.1.4. Additions and Deletions 1.3.1. Attribute Classes]
Moduletei
Memberscb lb milestone pb
Attributes
spanToindicates the end of a span initiated by the element bearing this attribute.
StatusOptional
Datatypeteidata.pointer
SchematronThe @spanTo attribute must point to an element following the current element
<sch:rule context="tei:*[@spanTo]"> <sch:assert test="id(substring(@spanTo,2)) and following::*[@xml:id=substring(current()/@spanTo,2)]">The element indicated by @spanTo (<sch:value-of select="@spanTo"/>) must follow the current element <sch:name/> </sch:assert> </sch:rule>
Note

The span is defined as running in document order from the start of the content of the pointing element to the end of the content of the element pointed to by the spanTo attribute (if any). If no value is supplied for the attribute, the assumption is that the span is coextensive with the pointing element. If no content is present, the assumption is that the starting point of the span is immediately following the element itself.

Appendix A.3.48 att.tableDecoration

att.tableDecoration provides attributes used to decorate rows or cells of a table. [14. Tables, Formulæ, Graphics, and Notated Music]
Modulefigures
Memberscell row
Attributes
role(role) indicates the kind of information held in this cell or in each cell of this row.
StatusOptional
Datatypeteidata.enumerated
Suggested values include:
label
labelling or descriptive information only.
data
data values.[Default]
Note

When this attribute is specified on a row, its value is the default for all cells in this row. When specified on a cell, its value overrides any default specified by the role attribute of the parent <row> element.

rows(rows) indicates the number of rows occupied by this cell or row.
StatusOptional
Datatypeteidata.count
Default1
Note

A value greater than one indicates that this cell spans several rows. Where several cells span multiple rows, it may be more convenient to use nested tables.

cols(columns) indicates the number of columns occupied by this cell or row.
StatusOptional
Datatypeteidata.count
Default1
Note

A value greater than one indicates that this cell or row spans several columns. Where an initial cell spans an entire row, it may be better treated as a heading.

Appendix A.3.49 att.timed

att.timed provides attributes common to those elements which have a duration in time, expressed either absolutely or by reference to an alignment map. [8.3.5. Temporal Information]
Moduletei
MembersannotationBlock gap incident media u
Attributes
startindicates the location within a temporal alignment at which this element begins.
StatusOptional
Datatypeteidata.pointer
Note

If no value is supplied, the element is assumed to follow the immediately preceding element at the same hierarchic level.

endindicates the location within a temporal alignment at which this element ends.
StatusOptional
Datatypeteidata.pointer
Note

If no value is supplied, the element is assumed to precede the immediately following element at the same hierarchic level.

Appendix A.3.50 att.translatable

att.translatable provides attributes used to indicate the status of a translatable portion of an ODD document.
Moduletagdocs
Membersdesc
Attributes
versionDatespecifies the date on which the source text was extracted and sent to the translator
StatusOptional
Datatypeteidata.temporal.working
Note

The versionDate attribute can be used to determine whether a translation might need to be revisited, by comparing the modification date on the containing file with the versionDate value on the translation. If the file has changed, changelogs can be checked to see whether the source text has been modified since the translation was made.

Appendix A.3.51 att.typed

att.typed provides attributes that can be used to classify or subclassify elements in any way. [1.3.1. Attribute Classes 17.1.1. Words and Above 3.6.1. Referring Strings 3.7. Simple Links and Cross-References 3.6.5. Abbreviations and Their Expansions 3.13.1. Core Tags for Verse 7.2.5. Speech Contents 4.1.1. Un-numbered Divisions 4.1.2. Numbered Divisions 4.2.1. Headings and Trailers 4.4. Virtual Divisions 13.3.2.3. Personal Relationships 11.3.1.1. Core Elements for Transcriptional Work 16.1.1. Pointers and Links 16.3. Blocks, Segments, and Anchors 12.2. Linking the Apparatus to the Text 22.5.1.2. Defining Content Models: RELAX NG 8.3. Elements Unique to Spoken Texts 23.3.1.3. Modification of Attribute and Attribute Value Lists]
Moduletei
MembersTEI ab abbr addName affiliation bibl birth cb change corr correspAction correspDesc date death desc district div divGen event forename g graphic head idno incident label lb lg list listEvent listObject listOrg listPerson listPlace listRelation location mapping material media milestone msDesc name nationality note num object occupation org orgName pb persName place placeName quote recording ref reg region relatedItem relation residence roleName rs seg settlement state surface surname table text title trait
Attributes
typecharacterizes the element in some sense, using any convenient classification scheme or typology.
StatusOptional
Datatypeteidata.enumerated
<div type="verse">  <head>Night in Tarras</head>  <lg type="stanza">   <l>At evening tramping on the hot white road</l>   <l></l>  </lg>  <lg type="stanza">   <l>A wind sprang up from nowhere as the sky</l>   <l></l>  </lg> </div>
Note

The type attribute is present on a number of elements, not all of which are members of att.typed, usually because these elements restrict the possible values for the attribute in a specific way.

subtype(subtype) provides a sub-categorization of the element, if needed
StatusOptional
Datatypeteidata.enumerated
Note

The subtype attribute may be used to provide any sub-classification for the element additional to that provided by its type attribute.

Schematron
<sch:rule context="tei:*[@subtype]"> <sch:assert test="@type">The <sch:name/> element should not be categorized in detail with @subtype unless also categorized in general with @type</sch:assert> </sch:rule>
Note

When appropriate, values from an established typology should be used. Alternatively a typology may be defined in the associated TEI header. If values are to be taken from a project-specific list, this should be defined using the <valList> element in the project-specific schema description, as described in 23.3.1.3. Modification of Attribute and Attribute Value Lists .

Appendix A.3.52 att.written

att.written provides attributes to indicate the hand in which the content of an element was written in the source being transcribed. [1.3.1. Attribute Classes]
Moduletei
Membersab closer div head label note opener p salute seg signed text
Attributes
handpoints to a <handNote> element describing the hand considered responsible for the content of the element concerned.
StatusOptional
Datatypeteidata.pointer

Appendix A.4 Macros

Appendix A.4.1 macro.abContent

macro.abContent (anonymous block content) defines the content of anonymous block elements. [1.3. The TEI Class System]
Moduletei
Used by
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.paraPart"/>
  <elementRef key="ab"/>
 </alternate>
</content>
    
Declaration
macro.abContent = ( text | model.paraPart | ab )*

Appendix A.4.2 macro.limitedContent

macro.limitedContent (paragraph content) defines the content of prose elements that are not used for transcription of extant materials. [1.3. The TEI Class System]
Moduletei
Used by
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.limitedPhrase"/>
  <classRef key="model.inter"/>
 </alternate>
</content>
    
Declaration
macro.limitedContent = ( text | model.limitedPhrase | model.inter )*

Appendix A.4.3 macro.paraContent

macro.paraContent (paragraph content) defines the content of paragraphs and similar elements. [1.3. The TEI Class System]
Moduletei
Used by
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.paraPart"/>
 </alternate>
</content>
    
Declaration
macro.paraContent = ( text | model.paraPart )*

Appendix A.4.4 macro.phraseSeq

macro.phraseSeq (phrase sequence) defines a sequence of character data and phrase-level elements. [1.4.1. Standard Content Models]
Moduletei
Used by
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.gLike"/>
  <classRef key="model.attributable"/>
  <classRef key="model.phrase"/>
  <classRef key="model.global"/>
 </alternate>
</content>
    
Declaration
macro.phraseSeq =
   ( text | model.gLike | model.attributable | model.phrase | model.global )*

Appendix A.4.5 macro.phraseSeq.limited

macro.phraseSeq.limited (limited phrase sequence) defines a sequence of character data and those phrase-level elements that are not typically used for transcribing extant documents. [1.4.1. Standard Content Models]
Moduletei
Used by
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.limitedPhrase"/>
  <classRef key="model.global"/>
 </alternate>
</content>
    
Declaration
macro.phraseSeq.limited = ( text | model.limitedPhrase | model.global )*

Appendix A.4.6 macro.specialPara

macro.specialPara ('special' paragraph content) defines the content model of elements such as notes or list items, which either contain a series of component-level elements or else have the same structure as a paragraph, containing a series of phrase-level and inter-level elements. [1.3. The TEI Class System]
Moduletei
Used by
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.gLike"/>
  <classRef key="model.phrase"/>
  <classRef key="model.inter"/>
  <classRef key="model.divPart"/>
  <classRef key="model.global"/>
 </alternate>
</content>
    
Declaration
macro.specialPara =
   (
      text
    | model.gLikemodel.phrasemodel.intermodel.divPartmodel.global
   )*

Appendix A.4.7 macro.xtext

macro.xtext (extended text) defines a sequence of character data and gaiji elements.
Moduletei
Used by
Content model
<content>
 <alternate minOccurs="0"
  maxOccurs="unbounded">
  <textNode/>
  <classRef key="model.gLike"/>
 </alternate>
</content>
    
Declaration
macro.xtext = ( text | model.gLike )*

Appendix A.5 Datatypes

Appendix A.5.1 teidata.certainty

teidata.certainty defines the range of attribute values expressing a degree of certainty.
Moduletei
Used by
Content model
<content>
 <valList type="closed">
  <valItem ident="high"/>
  <valItem ident="medium"/>
  <valItem ident="low"/>
  <valItem ident="unknown"/>
 </valList>
</content>
    
Declaration
teidata.certainty = "high" | "medium" | "low" | "unknown"
Note

Certainty may be expressed by one of the predefined symbolic values high, medium, or low. The value unknown should be used in cases where the encoder does not wish to assert an opinion about the matter.

Appendix A.5.2 teidata.count

teidata.count defines the range of attribute values used for a non-negative integer value used as a count.
Moduletei
Used by
Element:
Content model
<content>
 <dataRef name="nonNegativeInteger"/>
</content>
    
Declaration
teidata.count = xsd:nonNegativeInteger
Note

Any positive integer value or zero is permitted

Appendix A.5.3 teidata.duration.iso

teidata.duration.iso defines the range of attribute values available for representation of a duration in time using ISO 8601 standard formats
Moduletei
Used by
Content model
<content>
 <dataRef name="token"
  restriction="[0-9.,DHMPRSTWYZ/:+\-]+"/>
</content>
    
Declaration
teidata.duration.iso = token { pattern = "[0-9.,DHMPRSTWYZ/:+\-]+" }
Example
<time dur-iso="PT0,75H">three-quarters of an hour</time>
Example
<date dur-iso="P1,5D">a day and a half</date>
Example
<date dur-iso="P14D">a fortnight</date>
Example
<time dur-iso="PT0.02S">20 ms</time>
Note

A duration is expressed as a sequence of number-letter pairs, preceded by the letter P; the letter gives the unit and may be Y (year), M (month), D (day), H (hour), M (minute), or S (second), in that order. The numbers are all unsigned integers, except for the last, which may have a decimal component (using either . or , as the decimal point; the latter is preferred). If any number is 0, then that number-letter pair may be omitted. If any of the H (hour), M (minute), or S (second) number-letter pairs are present, then the separator T must precede the first ‘time’ number-letter pair.

For complete details, see ISO 8601 Data elements and interchange formats — Information interchange — Representation of dates and times.

Appendix A.5.4 teidata.duration.w3c

teidata.duration.w3c defines the range of attribute values available for representation of a duration in time using W3C datatypes.
Moduletei
Used by
Element:
Content model
<content>
 <dataRef name="duration"/>
</content>
    
Declaration
teidata.duration.w3c = xsd:duration
Example
<time dur="PT45M">forty-five minutes</time>
Example
<date dur="P1DT12H">a day and a half</date>
Example
<date dur="P7D">a week</date>
Example
<time dur="PT0.02S">20 ms</time>
Note

A duration is expressed as a sequence of number-letter pairs, preceded by the letter P; the letter gives the unit and may be Y (year), M (month), D (day), H (hour), M (minute), or S (second), in that order. The numbers are all unsigned integers, except for the S number, which may have a decimal component (using . as the decimal point). If any number is 0, then that number-letter pair may be omitted. If any of the H (hour), M (minute), or S (second) number-letter pairs are present, then the separator T must precede the first ‘time’ number-letter pair.

For complete details, see the W3C specification.

Appendix A.5.5 teidata.enumerated

teidata.enumerated defines the range of attribute values expressed as a single XML name taken from a list of documented possibilities.
Moduletei
Used by
teidata.gender teidata.sexElement:
Content model
<content>
 <dataRef key="teidata.word"/>
</content>
    
Declaration
teidata.enumerated = teidata.word
Note

Attributes using this datatype must contain a single ‘word’ which contains only letters, digits, punctuation characters, or symbols: thus it cannot include whitespace.

Typically, the list of documented possibilities will be provided (or exemplified) by a value list in the associated attribute specification, expressed with a <valList> element.

Appendix A.5.6 teidata.gender

teidata.gender defines the range of attribute values used to represent the gender of a person, persona, or character.
Moduletei
Used by
Element:
Content model
<content>
 <dataRef key="teidata.enumerated"/>
</content>
    
Declaration
teidata.gender = teidata.enumerated
Note

Values for attributes using this datatype may be defined locally by a project, or they may refer to an external standard.

Values for this datatype should not be used to encode morphological gender (cf. <gen>, msd as defined in att.linguistic, and 9.3.1. Information on Written and Spoken Forms).

Appendix A.5.7 teidata.interval

teidata.interval defines attribute values used to express an interval value.
Moduletei
Used by
Element:
Content model
<content>
 <alternate>
  <dataRef name="float"/>
  <valList>
   <valItem ident="regular"/>
   <valItem ident="irregular"/>
   <valItem ident="unknown"/>
  </valList>
 </alternate>
</content>
    
Declaration
teidata.interval = xsd:float | ( "regular" | "irregular" | "unknown" )
Note

Any value greater than zero or any one of the values regular, irregular, unknown.

Appendix A.5.8 teidata.language

teidata.language defines the range of attribute values used to identify a particular combination of human language and writing system. [6.1. Language Identification]
Moduletei
Used by
Element:
Content model
<content>
 <alternate>
  <dataRef name="language"/>
  <valList>
   <valItem ident=""/>
  </valList>
 </alternate>
</content>
    
Declaration
teidata.language = xsd:language | ( "" )
Note

The values for this attribute are language ‘tags’ as defined in BCP 47. Currently BCP 47 comprises RFC 5646 and RFC 4647; over time, other IETF documents may succeed these as the best current practice.

A ‘language tag’, per BCP 47, is assembled from a sequence of components or subtags separated by the hyphen character (-, U+002D). The tag is made of the following subtags, in the following order. Every subtag except the first is optional. If present, each occurs only once, except the fourth and fifth components (variant and extension), which are repeatable.

language
The IANA-registered code for the language. This is almost always the same as the ISO 639 2-letter language code if there is one. The list of available registered language subtags can be found at http://www.iana.org/assignments/language-subtag-registry. It is recommended that this code be written in lower case.
script
The ISO 15924 code for the script. These codes consist of 4 letters, and it is recommended they be written with an initial capital, the other three letters in lower case. The canonical list of codes is maintained by the Unicode Consortium, and is available at http://unicode.org/iso15924/iso15924-codes.html. The IETF recommends this code be omitted unless it is necessary to make a distinction you need.
region
Either an ISO 3166 country code or a UN M.49 region code that is registered with IANA (not all such codes are registered, e.g. UN codes for economic groupings or codes for countries for which there is already an ISO 3166 2-letter code are not registered). The former consist of 2 letters, and it is recommended they be written in upper case; the list of codes can be searched or browsed at https://www.iso.org/obp/ui/#search/code/. The latter consist of 3 digits; the list of codes can be found at http://unstats.un.org/unsd/methods/m49/m49.htm.
variant
An IANA-registered variation. These codes ‘are used to indicate additional, well-recognized variations that define a language or its dialects that are not covered by other available subtags’.
extension
An extension has the format of a single letter followed by a hyphen followed by additional subtags. These exist to allow for future extension to BCP 47, but as of this writing no such extensions are in use.
private use
An extension that uses the initial subtag of the single letter x (i.e., starts with x-) has no meaning except as negotiated among the parties involved. These should be used with great care, since they interfere with the interoperability that use of RFC 4646 is intended to promote. In order for a document that makes use of these subtags to be TEI-conformant, a corresponding <language> element must be present in the TEI header.

There are two exceptions to the above format. First, there are language tags in the IANA registry that do not match the above syntax, but are present because they have been ‘grandfathered’ from previous specifications.

Second, an entire language tag can consist of only a private use subtag. These tags start with x-, and do not need to follow any further rules established by the IETF and endorsed by these Guidelines. Like all language tags that make use of private use subtags, the language in question must be documented in a corresponding <language> element in the TEI header.

Examples include

sn
Shona
zh-TW
Taiwanese
zh-Hant-HK
Chinese written in traditional script as used in Hong Kong
en-SL
English as spoken in Sierra Leone
pl
Polish
es-MX
Spanish as spoken in Mexico
es-419
Spanish as spoken in Latin America

The W3C Internationalization Activity has published a useful introduction to BCP 47, Language tags in HTML and XML.

Appendix A.5.9 teidata.name

teidata.name defines the range of attribute values expressed as an XML Name.
Moduletei
Used by
Content model
<content>
 <dataRef name="Name"/>
</content>
    
Declaration
teidata.name = xsd:Name
Note

Attributes using this datatype must contain a single word which follows the rules defining a legal XML name (see https://www.w3.org/TR/REC-xml/#dt-name): for example they cannot include whitespace or begin with digits.

Appendix A.5.10 teidata.namespace

teidata.namespace defines the range of attribute values used to indicate XML namespaces as defined by the W3C Namespaces in XML Technical Recommendation.
Moduletei
Used by
Content model
<content>
 <dataRef restriction="\S*" name="anyURI"/>
</content>
    
Declaration
teidata.namespace = xsd:anyURI { pattern = "\S*" }
Note

The range of syntactically valid values is defined by RFC 3986 Uniform Resource Identifier (URI): Generic Syntax

Appendix A.5.11 teidata.numeric

teidata.numeric defines the range of attribute values used for numeric values.
Moduletei
Used by
Element:
Content model
<content>
 <alternate>
  <dataRef name="double"/>
  <dataRef name="token"
   restriction="(\-?[\d]+/\-?[\d]+)"/>
  <dataRef name="decimal"/>
 </alternate>
</content>
    
Declaration
teidata.numeric =
   xsd:double | token { pattern = "(\-?[\d]+/\-?[\d]+)" } | xsd:decimal
Note

Any numeric value, represented as a decimal number, in floating point format, or as a ratio.

To represent a floating point number, expressed in scientific notation, ‘E notation’, a variant of ‘exponential notation’, may be used. In this format, the value is expressed as two numbers separated by the letter E. The first number, the significand (sometimes called the mantissa) is given in decimal format, while the second is an integer. The value is obtained by multiplying the mantissa by 10 the number of times indicated by the integer. Thus the value represented in decimal notation as 1000.0 might be represented in scientific notation as 10E3.

A value expressed as a ratio is represented by two integer values separated by a solidus (/) character. Thus, the value represented in decimal notation as 0.5 might be represented as a ratio by the string 1/2.

Appendix A.5.12 teidata.outputMeasurement

teidata.outputMeasurement defines a range of values for use in specifying the size of an object that is intended for display.
Moduletei
Used by
Content model
<content>
 <dataRef name="token"
  restriction="[\-+]?\d+(\.\d+)?(%|cm|mm|in|pt|pc|px|em|ex|ch|rem|vw|vh|vmin|vmax)"/>
</content>
    
Declaration
teidata.outputMeasurement =
   token
   {
      pattern = "[\-+]?\d+(\.\d+)?(%|cm|mm|in|pt|pc|px|em|ex|ch|rem|vw|vh|vmin|vmax)"
   }
Example
<figure>  <head>The TEI Logo</head>  <figDesc>Stylized yellow angle brackets with the letters <mentioned>TEI</mentioned> in    between and <mentioned>text encoding initiative</mentioned> underneath, all on a white    background.</figDesc>  <graphic height="600pxwidth="600px"   url="http://www.tei-c.org/logos/TEI-600.jpg"/> </figure>
Note

These values map directly onto the values used by XSL-FO and CSS. For definitions of the units see those specifications; at the time of this writing the most complete list is in the CSS3 working draft.

Appendix A.5.13 teidata.pattern

teidata.pattern defines attribute values which are expressed as a regular expression.
Moduletei
Used by
Content model
<content>
 <dataRef name="token"/>
</content>
    
Declaration
teidata.pattern = token
Note
A regular expression, often called a pattern, is an expression that describes a set of strings. They are usually used to give a concise description of a set, without having to list all elements. For example, the set containing the three strings Handel, Händel, and Haendel can be described by the pattern H(ä|ae?)ndel (or alternatively, it is said that the pattern H(ä|ae?)ndel matches each of the three strings)
Wikipedia

This TEI datatype is mapped to the XSD token datatype, and may therefore contain any string of characters. However, it is recommended that the value used conform to the particular flavour of regular expression syntax supported by XSD Schema.

Appendix A.5.14 teidata.point

teidata.point defines the data type used to express a point in cartesian space.
Moduletei
Used by
Content model
<content>
 <dataRef name="token"
  restriction="(-?[0-9]+(\.[0-9]+)?,-?[0-9]+(\.[0-9]+)?)"/>
</content>
    
Declaration
teidata.point = token { pattern = "(-?[0-9]+(\.[0-9]+)?,-?[0-9]+(\.[0-9]+)?)" }
Example
<facsimile>  <surface ulx="0uly="0lrx="400lry="280">   <zone points="220,100 300,210 170,250 123,234">    <graphic url="handwriting.png"/>   </zone>  </surface> </facsimile>
Note

A point is defined by two numeric values, which should be expressed as decimal numbers. Neither number can end in a decimal point. E.g., both 0.0,84.2 and 0,84 are allowed, but 0.,84. is not.

Appendix A.5.15 teidata.pointer

teidata.pointer defines the range of attribute values used to provide a single URI, absolute or relative, pointing to some other resource, either within the current document or elsewhere.
Moduletei
Used by
Element:
Content model
<content rend="replace">
 <dataRef name="anyURI"
  restriction="((prs:)|(plc:)|(doc:)|(org:)|(obj:)|(char:)|(rad:)|(loi:)|(resp:)|(team:)|(sens:)|(eth:)|(ext:)|(ntl:)|(title:)|(lot:)|(stats:)|(https?://)|(#)).+"/>
</content>
    
Declaration
teidata.pointer =
   xsd:anyURI
   {
      pattern = "((prs:)|(plc:)|(doc:)|(org:)|(obj:)|(char:)|(rad:)|(loi:)|(resp:)|(team:)|(sens:)|(eth:)|(ext:)|(ntl:)|(title:)|(lot:)|(stats:)|(https?://)|(#)).+"
   }
Note

The range of syntactically valid values is defined by RFC 3986 Uniform Resource Identifier (URI): Generic Syntax. Note that the values themselves are encoded using RFC 3987 Internationalized Resource Identifiers (IRIs) mapping to URIs. For example, https://secure.wikimedia.org/wikipedia/en/wiki/% is encoded as https://secure.wikimedia.org/wikipedia/en/wiki/%25 while http://موقع.وزارة-الاتصالات.مصر/ is encoded as http://xn--4gbrim.xn----rmckbbajlc6dj7bxne2c.xn--wgbh1c/

Appendix A.5.16 teidata.probCert

teidata.probCert defines a range of attribute values which can be expressed either as a numeric probability or as a coded certainty value.
Moduletei
Used by
Content model
<content>
 <alternate>
  <dataRef key="teidata.probability"/>
  <dataRef key="teidata.certainty"/>
 </alternate>
</content>
    
Declaration
teidata.probCert = teidata.probability | teidata.certainty

Appendix A.5.17 teidata.probability

teidata.probability defines the range of attribute values expressing a probability.
Moduletei
Used by
Content model
<content>
 <dataRef name="double"/>
</content>
    
Declaration
teidata.probability = xsd:double
Note

Probability is expressed as a real number between 0 and 1; 0 representing certainly false and 1 representing certainly true.

Appendix A.5.18 teidata.replacement

teidata.replacement defines attribute values which contain a replacement template.
Moduletei
Used by
Content model
<content>
 <textNode/>
</content>
    
Declaration
teidata.replacement = text

Appendix A.5.19 teidata.sex

teidata.sex defines the range of attribute values used to identify the sex of an organism.
Moduletei
Used by
Element:
Content model
<content>
 <dataRef key="teidata.enumerated"/>
</content>
    
Declaration
teidata.sex = teidata.enumerated
Note

Values for attributes using this datatype may be defined locally by a project, or they may refer to an external standard.

Appendix A.5.20 teidata.temporal.iso

teidata.temporal.iso defines the range of attribute values expressing a temporal expression such as a date, a time, or a combination of them, that conform to the international standard Data elements and interchange formats – Information interchange – Representation of dates and times.
Moduletei
Used by
Content model
<content>
 <alternate>
  <dataRef name="date"/>
  <dataRef name="gYear"/>
  <dataRef name="gMonth"/>
  <dataRef name="gDay"/>
  <dataRef name="gYearMonth"/>
  <dataRef name="gMonthDay"/>
  <dataRef name="time"/>
  <dataRef name="dateTime"/>
  <dataRef name="token"
   restriction="[0-9.,DHMPRSTWYZ/:+\-]+"/>
 </alternate>
</content>
    
Declaration
teidata.temporal.iso =
   xsd:date
 | xsd:gYear
 | xsd:gMonth
 | xsd:gDay
 | xsd:gYearMonth
 | xsd:gMonthDay
 | xsd:time
 | xsd:dateTime
 | token { pattern = "[0-9.,DHMPRSTWYZ/:+\-]+" }
Note

If it is likely that the value used is to be compared with another, then a time zone indicator should always be included, and only the dateTime representation should be used.

For all representations for which ISO 8601:2004 describes both a basic and an extended format, these Guidelines recommend use of the extended format.

Appendix A.5.21 teidata.temporal.w3c

teidata.temporal.w3c defines the range of attribute values expressing a temporal expression such as a date, a time, or a combination of them, that conform to the W3C XML Schema Part 2: Datatypes Second Edition specification.
Moduletei
Used by
Element:
Content model
<content>
 <alternate>
  <dataRef name="date"/>
  <dataRef name="gYear"/>
  <dataRef name="gMonth"/>
  <dataRef name="gDay"/>
  <dataRef name="gYearMonth"/>
  <dataRef name="gMonthDay"/>
  <dataRef name="time"/>
  <dataRef name="dateTime"/>
 </alternate>
</content>
    
Declaration
teidata.temporal.w3c =
   xsd:date
 | xsd:gYear
 | xsd:gMonth
 | xsd:gDay
 | xsd:gYearMonth
 | xsd:gMonthDay
 | xsd:time
 | xsd:dateTime
Note

If it is likely that the value used is to be compared with another, then a time zone indicator should always be included, and only the dateTime representation should be used.

Appendix A.5.22 teidata.temporal.working

teidata.temporal.working defines the range of values, conforming to the W3C XML Schema Part 2: Datatypes Second Edition specification, expressing a date or a date and a time within the working life of the document.
Moduletei
Used by
Content model
<content>
 <alternate>
  <dataRef name="date"
   restriction="(19[789][0-9]|[2-9][0-9]{3}).*"/>
  <dataRef name="dateTime"
   restriction="(19[789][0-9]|[2-9][0-9]{3}).*"/>
 </alternate>
</content>
    
Declaration
teidata.temporal.working =
   xsd:date { pattern = "(19[789][0-9]|[2-9][0-9]{3}).*" }
 | xsd:dateTime { pattern = "(19[789][0-9]|[2-9][0-9]{3}).*" }
Note

If it is likely that the value used is to be compared with another, then a time zone indicator should always be included, and only the dateTime representation should be used.

The earliest time expressable with this datatype is 01 January 1970 (the Unix Epoch), which could be written as either 1970-01-01 or 1970-01-01T00:00:00Z.

Appendix A.5.23 teidata.text

teidata.text defines the range of attribute values used to express some kind of identifying string as a single sequence of Unicode characters possibly including whitespace.
Moduletei
Used by
Content model
<content>
 <dataRef name="string"/>
</content>
    
Declaration
teidata.text = string
Note

Attributes using this datatype must contain a single ‘token’ in which whitespace and other punctuation characters are permitted.

Appendix A.5.24 teidata.truthValue

teidata.truthValue defines the range of attribute values used to express a truth value.
Moduletei
Used by
Element:
Content model
<content>
 <dataRef name="boolean"/>
</content>
    
Declaration
teidata.truthValue = xsd:boolean
Note

The possible values of this datatype are 1 or true, or 0 or false.

This datatype applies only for cases where uncertainty is inappropriate; if the attribute concerned may have a value other than true or false, e.g. unknown, or inapplicable, it should have the extended version of this datatype: teidata.xTruthValue.

Appendix A.5.25 teidata.unboundedCount

teidata.unboundedCount defines the range of values used for a counting number or the string unbounded for infinity.
Moduletei
Used by
Content model
<content>
 <alternate>
  <dataRef name="nonNegativeInteger"/>
  <valList type="closed">
   <valItem ident="unbounded"/>
  </valList>
 </alternate>
</content>
    
Declaration
teidata.unboundedCount = xsd:nonNegativeInteger | ( "unbounded" )

Appendix A.5.26 teidata.version

teidata.version defines the range of attribute values which may be used to specify a TEI or Unicode version number.
Moduletei
Used by
Element:
Content model
<content>
 <dataRef name="token"
  restriction="[\d]+(\.[\d]+){0,2}"/>
</content>
    
Declaration
teidata.version = token { pattern = "[\d]+(\.[\d]+){0,2}" }
Note

The value of this attribute follows the pattern specified by the Unicode consortium for its version number (http://unicode.org/versions/). A version number contains digits and fullstop characters only. The first number supplied identifies the major version number. A second and third number, for minor and sub-minor version numbers, may also be supplied.

Appendix A.5.27 teidata.versionNumber

teidata.versionNumber defines the range of attribute values used for version numbers.
Moduletei
Used by
Content model
<content>
 <dataRef name="token"
  restriction="[\d]+[a-z]*[\d]*(\.[\d]+[a-z]*[\d]*){0,3}"/>
</content>
    
Declaration
teidata.versionNumber =
   token { pattern = "[\d]+[a-z]*[\d]*(\.[\d]+[a-z]*[\d]*){0,3}" }

Appendix A.5.28 teidata.word

teidata.word defines the range of attribute values expressed as a single word or token.
Moduletei
Used by
teidata.enumeratedElement:
Content model
<content>
 <dataRef name="token"
  restriction="[^\p{C}\p{Z}]+"/>
</content>
    
Declaration
teidata.word = token { pattern = "[^\p{C}\p{Z}]+" }
Note

Attributes using this datatype must contain a single ‘word’ which contains only letters, digits, punctuation characters, or symbols: thus it cannot include whitespace.

Appendix A.5.29 teidata.xTruthValue

teidata.xTruthValue (extended truth value) defines the range of attribute values used to express a truth value which may be unknown.
Moduletei
Used by
Content model
<content>
 <alternate>
  <dataRef name="boolean"/>
  <valList>
   <valItem ident="unknown"/>
   <valItem ident="inapplicable"/>
  </valList>
 </alternate>
</content>
    
Declaration
teidata.xTruthValue = xsd:boolean | ( "unknown" | "inapplicable" )
Note

In cases where where uncertainty is inappropriate, use the datatype teidata.TruthValue.

Appendix A.5.30 teidata.xmlName

teidata.xmlName defines attribute values which contain an XML name.
Moduletei
Used by
Content model
<content>
 <dataRef name="NCName"/>
</content>
    
Declaration
teidata.xmlName = xsd:NCName
Note

The rules defining an XML name form a part of the XML Specification.

Appendix A.5.31 teidata.xpath

teidata.xpath defines attribute values which contain an XPath expression.
Moduletei
Used by
Content model
<content>
 <textNode/>
</content>
    
Declaration
teidata.xpath = text
Note

Any XPath expression using the syntax defined in 6.2..

When writing programs that evaluate XPath expressions, programmers should be mindful of the possibility of malicious code injection attacks. For further information about XPath injection attacks, see the article at OWASP.

Appendix A.6 Constraints

SchematronAll @xml:ids at the root of any document must match the document filename.
<sch:pattern> <sch:rule context="/tei:TEI | /tei:item[not(ancestor::tei:*)]">  <sch:assert test="@xml:id and matches($docUri,concat('[/\\]', $docId,'\.xm[l_]$'))">ERROR: Document xml:id (<sch:value-of select="$docId"/>) must match the document file name (<sch:value-of select="$docUri"/>).</sch:assert> </sch:rule> </sch:pattern>
SchematronAll local pointers must be resolvable.
<sch:pattern> <sch:rule context="tei:*[@*[matches(.,'(^|\s+)#')]]">  <sch:let name="localRefs"   value="for $a in @*[matches(.,'(^|\s+)#')] return tokenize($a,'\s+')[starts-with(.,'#')]"/>  <sch:let name="errors"   value="for $r in $localRefs return if ($docIds = substring-after($r,'#')) then () else $r"/>  <sch:assert test="empty($errors)">ERROR: Bad pointer(s): <sch:value-of select="string-join($errors,', ')"/>  </sch:assert> </sch:rule> </sch:pattern>
SchematronNo linking elements inside other linking elements.
<sch:pattern> <sch:rule context="tei:placeName[not(parent::tei:place)][@ref] | tei:orgName[not(parent::tei:org)][@ref] | tei:persName[not(parent::tei:person)][@ref] | tei:ref">  <sch:assert role="error"   test="not(descendant::tei:*[local-name()=('placeName','persName','orgName')][@ref] or tei:ref)">A persName, placeName, orgName with an @ref or a ref element cannot have a child that is also a linking element.</sch:assert> </sch:rule> </sch:pattern>
SchematronObjects should only be on terminal nodes.
<sch:rule context="tei:item[tei:list]/tei:listObject"> <sch:assert test="not(../tei:list/descendant::tei:listObject)">ERROR: items that have descendant objects cannot have a child object.</sch:assert> </sch:rule>
SchematronObjects should have at most 1 URI
<sch:rule context="tei:objectIdentifier"> <sch:assert test="count(tei:idno[@type='URI']) lt 2">ERROR: Objects should only point to a single URI</sch:assert> </sch:rule>
SchematronAll object elements must have an id.
<sch:pattern> <sch:rule context="tei:object">  <sch:assert role="error" test="@xml:id">ERROR: object element must have a @xml:id.</sch:assert> </sch:rule> </sch:pattern>
SchematronAll person, orgs, and places in an ography file must have an id.
<sch:pattern> <sch:rule context="tei:body/tei:listPerson/tei:person | tei:body/tei:listOrg/tei:org | tei:body/tei:listPlace/tei:place">  <sch:let name="isOgraphy"   value="matches($docId,'ography(_[a-z])?$')"/>  <sch:assert test="if ($isOgraphy) then (matches(@xml:id,'^[a-z]{4}\d+')) else true()">ERROR: All ography content (person, org, place) must have an @xml:id that is 4 lowercase letters and a digit.</sch:assert> </sch:rule> </sch:pattern>
SchematronThese are global variables that can be used throughout the schematron constraints.
<sch:pattern> <sch:let name="spaceRegex"  value="'(^\s)|(\s$)'"/> <sch:let name="persPrefix" value="'prs'"/> <sch:let name="docPrefix" value="'doc'"/> <sch:let name="orgPrefix" value="'org'"/> <sch:let name="docId"  value="root(/)/tei:*/@xml:id"/> <sch:let name="docUri"  value="document-uri(/)"/> <sch:let name="docIds"  value="//tei:*[@xml:id]/@xml:id"/> <sch:let name="docTypes"  value="//tei:catRef"/> </sch:pattern>
SchematronAll xml:lang attributes must be one of a sepcified set of values
<sch:pattern> <sch:rule context="tei:*[@xml:lang]">  <sch:assert test="@xml:lang = ('en', 'ja-Latn', 'ja')">ERROR: All xml:langs must be either en, ja-Latn, or ja</sch:assert> </sch:rule> </sch:pattern>
Schematron
<sch:pattern> <sch:rule context="tei:TEI[starts-with(@xml:id, 'monument_')]/descendant::tei:residence[@type='original']">  <sch:assert role="error"   test="not(matches(., ',?\s+B\.?C\.?\s*$'))"> ERROR: Do not include ", BC" in any original residence.  </sch:assert> </sch:rule> </sch:pattern>
Schematron
<sch:pattern> <sch:rule context="tei:person[child::tei:idno[@type='custodian']]">  <sch:assert role="error"   test="descendant-or-self::*[@source]">ERROR: a person with a custodian id MUST have a @source attribute, or a descendant element with a @source attribute.</sch:assert> </sch:rule> </sch:pattern>
Schematron
<sch:pattern> <sch:rule context="tei:listRelation/tei:relation">  <sch:let name="persId"   value="ancestor::tei:person/@xml:id"/>  <sch:assert role="error"   test="@passive = 'prs:' || $persId"> ERROR: the @passive attribute of a relation element should point    to the id of the person element which contains it:  <sch:value-of select="'prs:' || $persId"/>  </sch:assert>  <sch:assert role="error"   test="not(@active = @passive)"> ERROR: A same person pointer cannot appear in both @active and @passive.  </sch:assert> </sch:rule> </sch:pattern>
Schematron
<sch:pattern> <sch:let name="apos" value="''''"/> <sch:rule context="tei:person/tei:residence | tei:person/tei:note/tei:p">  <sch:assert role="error"   test="not(contains(., $apos))">ERROR: do not use straight apostrophes. Use the curly apostrophe ʼ instead.</sch:assert> </sch:rule> </sch:pattern>
Schematron
<sch:rule context="tei:surname"> <sch:assert test="not(normalize-space(.) = '')"> ERROR: Surnames may not be blank or empty. </sch:assert> </sch:rule>
Schematron
<sch:pattern> <sch:rule context="tei:person[not(@corresp) and (not(@xml:id) or not(matches(@xml:id, '^(m_)?[a-z]{4,4}(\d+)?$')))]">  <sch:assert test="@xml:id and matches(@xml:id, '^(m_)?[a-z]{4,4}\d+$')"> ERROR: person elements must have a unique xml:id. If you are creating a    new record for the Monument project (not appearing in LOI), please type    m_ plus the first four letters of the id you need, and the next available    id will be shown.  </sch:assert> </sch:rule> <sch:rule context="tei:person[matches(@xml:id, '^m_[a-z]{4,4}$')]">  <sch:let name="letters"   value="xs:string(@xml:id)"/>  <sch:let name="maxId"   value="max((0, for $i in //tei:person[@xml:id][matches(xs:string(@xml:id), '^' || $letters || '\d+$')]/@xml:id return xs:integer(substring($i, 7))))"/>  <sch:let name="nextId"   value="$letters || xs:string($maxId + 1)"/>  <sch:assert test="not(matches(@xml:id, '^m_[a-z]{4,4}$'))"> NOTE: <sch:value-of select="$nextId"/> is the next available id for the letter prefix <sch:value-of select="$letters"/>.  </sch:assert> </sch:rule> </sch:pattern>
SchematronDating elements in Oral Histories should have dating attributes
<sch:pattern> <sch:rule context="tei:body[$docTypes[contains(@target,'OralHistory')]]">  <sch:assert test="tei:annotationBlock | tei:timeline | tei:div[count(child::tei:*) = 1]/tei:gap">ERROR: The body of oral history documents should either be timeline and annotationBlock (if it has a transcription) or a div with a gap element if there is no transcription available yet.</sch:assert> </sch:rule> </sch:pattern>
SchematronDating elements in Oral Histories should have dating attributes
<sch:pattern> <sch:rule context="tei:date[ancestor::tei:teiHeader][$docTypes[contains(@target,'OralHistory')]]">  <sch:assert test="@when or @notBefore or @notAfter or @to or @from">ERROR: Date elements in oral history metadata must have dating attributes (one or more of @when, @to, @from, @notBefore, @notAfter).</sch:assert> </sch:rule> </sch:pattern>
SchematronRules to ban literal quotation marks, square brackets, and literal ellipses from utterances
<sch:pattern> <sch:rule context="tei:*[text()][ancestor-or-self::tei:u]">  <sch:let name="errors"   value="for $t in text() return if (matches($t,'\[|\]')) then $t else ()"/>  <sch:assert test="empty($errors)">ERROR: No square brackets.</sch:assert> </sch:rule> </sch:pattern>
SchematronRules to ban literal quotation marks, square brackets, and literal ellipses from utterances
<sch:pattern> <sch:rule context="tei:*[text()][ancestor-or-self::tei:u]">  <sch:let name="errors"   value="for $t in text() return if (matches($t,'…')) then $t else ()"/>  <sch:assert test="empty($errors)">ERROR: No literal ellipsis characters allowed in transcription.</sch:assert> </sch:rule> </sch:pattern>
SchematronRules to ban literal quotation marks, square brackets, and literal ellipses from utterances
<sch:pattern> <sch:rule context="tei:*[text()][ancestor-or-self::tei:u]">  <sch:let name="errors"   value="for $t in text() return if (matches($t, '“|”|"')) then $t else ()"/>  <sch:assert role="error"   test="empty($errors)">ERROR: No double quotes inside a u tag.</sch:assert> </sch:rule> </sch:pattern>
SchematronNext/Prev doc pointers should only exist in oral histories.
<sch:pattern> <sch:rule context="tei:text[@next or @prev]">  <sch:assert test="$docTypes[contains(@target,'OralHistory')]">ERROR: Only oral histories should specify @next/@prev pointers on text elements.</sch:assert> </sch:rule> </sch:pattern>
Schematronnext/prev pointers should be single valued and only point to docs.
<sch:pattern> <sch:rule context="tei:text[@next or @prev]">  <sch:let name="atts"   value="(@next, @prev)"/>  <sch:assert test="every $att in $atts satisfies matches($att,'^doc:oral_history_[^\s]+$')">ERROR: next/prev pointers should point to a single oral history    with the doc prefix.</sch:assert> </sch:rule> </sch:pattern>
SchematronElements in the spoken module should only be used in Oral History documents.
<sch:pattern> <sch:rule context="tei:annotationBlock | tei:equipment | tei:incident | tei:recording | tei:recordingStmt | tei:u">  <sch:assert test="$docTypes[contains(@target,'OralHistory')]">ERROR: Element <sch:name/> not allowed here. <sch:name/> should only be used in Oral History documents.</sch:assert> </sch:rule> </sch:pattern>
SchematronOral histories should not contain information about its parts in the title.
<sch:pattern> <sch:rule context="tei:titleStmt/tei:title[$docTypes[contains(@target,'OralHistory')]]">  <sch:assert test="not(matches(string(.), '\(\s*\d+\s*|\s*\d+\s*\)'))">ERROR: Do not put part information e.g. "(1 of 2)" in the title of an oral history. Use @nex/@prev to properly put the documents in sequence.</sch:assert> </sch:rule> </sch:pattern>
Natsuki Abe, Stewart Arneil, Erin Chan, Nathaniel Hayes, Martin Holmes, Kara Isozaki, Lindsey Jacobson, Jennifer Landrey, Gordon Lyall, Lindy Marks, Jordan Stanger-Ross, Joey Takeda and Lisa Uyeda. Date: 2020-02-06