Entering Text

Textual contributions are entered and edited in an XML editor available through the Open Siddur user interface. To access the editor, click on the "texts" button in the header.

To create a new document, click on the "New" button. A dialog box will appear prompting you to enter basic information about the document.

• For the primary language enter the main language of the document. (This may differ from the primary language of the bibliography entry.)
• For the document title, enter a title that describes the document. In some cases, the siddur or other publication from which you are transcribing will provide a title. In other cases, you will have to create a title. The title should be brief and should identify the text clearly.
• You may also provide an alternate title. This may be done, for example, if a prayer has more than one common name, or if you wish to provide both English and Hebrew titles. This field is optional.
• Select the license appropriate to the document. If the document is in the public domain, select Creative Commons Zero 1.0. If the work has been released under a different Creative Commons license, choose the license under which it was released. If it is your own original work, you may select the license of your choice. See http://creativecommons.org/ for more information.
• Select the source of the text you are about to contribute from the list at the bottom of the window. This is a complete list of bibliography entries. You can find yours by scrolling down or by using the search window provided. If you are contributing an original work, select An Original Work for the Open Siddur Project.

At the top of the screen you will find a list of existing textual contributions organized by title. (You will provide the title of your document in the XML file.) Below the list, you will find a window containing a template to be used for entering and marking up text. ?? indicates where information can be filled in.

The editor will autocomplete closing XML tags. For example, if you have the opening tag <tei:seg>, when you begin typing the closing tag </, the editor will complete the tag as follows: </tei:seg>.

The remaining sections of this documentation explain how to mark up text in the JLPTEI format. For background on this format, see [Introduction to JLPTEI].

Note: You will not be able to save your document until it constitutes a valid XML document. This will involve entering the language of the document, the main title, and the language of the main title. See [The TEI Header].

###The tei:TEI Element:

Every JLPTEI file that contains content (as opposed to metadata alone) follows the same basic format: a header, which contains metadata about the file and its source, followed by the content. The file is enclosed in the tei:TEI root element.

The root element looks like this:

<tei:TEI xmlns:tei="http://www.tei-c.org/ns/1.0" xmlns:j="http://jewishliturgy.org/ns/jlptei/1.0" xml:lang="en">

The namespaces tei and j are defined in the template. You do not have to alter anything in the code.

The xml:lang parameter defines the primary language of the document using the abbreviations in the ISO 639 language code list. The most common languages used in Open Siddur texts are abbreviated as follows:

• en = English
• he = Hebrew
• arc = Aramaic

###The TEI Header:

The TEI header (tei:teiHeader) contains all of the document's metadata. Enclosed within the header are the file description (tei:fileDesc) and the revision description (tei:revisionDesc).

File Description:

The file description contains a title statement (tei:titleStmt), a publication statement (tei:publicationStmt), and a source description (tei:sourceDesc).

Title Statement:

The title statement includes information about the document's title and may also include a responsibility statement (tei:respStmt), which is used to assign credit for work on the document.

Every document must have a main title (tei:title type="main"). This is the title that will appear in the list of texts on the Open Siddur site.

The xml:lang parameter defines the language of the title. You must provide the language using an abbreviation from the ISO 639 language code list.

You will not be able to save your document until you enter the main title and the language of the main title. We recommend saving the document as soon as it constitutes valid XML.

In addition to the main title, there are two optional title types: alternative title (tei:title type="alt"), used for alternative forms of the title such as translations, and subtitle (tei:title type="sub"):

The following example is a title statement for a book with a main title in English, an alternative title in Hebrew, and no subtitle:

<tei:titleStmt>
<tei:title type="main" xml:lang="en">The Standard Prayer Book</tei:title>
<tei:title type="alt" xml:lang="he">סדר תפלות כל השנה</tei:title>

Works may have multiple alternative titles. Generally, there will be at most one subtitle. For works with more than one subtitle, we recommend using one tei:title element and separating the subtitles with a semicolon.

Responsibility Statement

The responsibility statement is optional. It is used to assign credit for work (such as transcription, editing, or proofreading) done by someone other than you.

The responsibility key "trc" indicates a transcriber. Some common responsibility keys are:

aut

Author

ann

Annotator

ctb

Contributor

cre

Creator

edt

Editor

fac

Facsimilist

fnd

Funder

mrk

Markup editor

oth

Other

pfr

Proofreader

trc

Transcriber

For a more comprehensive list of responsibility keys, see the Marc Code List for Relators.

Example responsibility statement:

<tei:respStmt>
<tei:resp key="fac">Scanned by</tei:resp>
<tei:name ref="/user/JohnHare">John Bruno Hare</tei:name>
</tei:respStmt>

To do: Continue editing from here

Publication Statement

The publication statement includes the distributor, the availability status, and the license information.

Example:

<tei:publicationStmt>
<tei:distributor>
<tei:ref target="http://opensiddur.org">Open Siddur Project</tei:ref>
</tei:distributor>
<tei:availability status="free">
<tei:licence target="http://www.creativecommons.org/publicdomain/zero/1.0"/>
</tei:availability>
<tei:date>2014-03-03</tei:date>
</tei:publicationStmt>

#####Distributor This refers to the distributor of the final version of the text, which will nearly always be the Open Siddur Project.

#####Availability Status

#####License

Source Description

The source description contains the bibliographic information for the source. In the template, this will appear as follows:

<tei:sourceDesc>
<tei:link type="bibl" target="#stream /data/sources/Born%20Digital"/>
</tei:sourceDesc>

Highlight /data/sources/Born%20Digital and replace it with the actual bibliography source by clicking on the Links helper tab, selecting Source from the drop-down menu, and then selecting the source of your text.

Template: <tei:link type="bibl" target="#stream /data/sources/Born%20Digital"/> Replace /data/sources/Born%20Digital with the bibliography source, found in the right drop-down menu.

####Revision Description The revision description contains a commit log detailing the revision history of the contribution. If you choose, you can change the top commit log entry and include a comment about what you've done, such as "added structure," "work in progress," etc.

###Tei:text The tei:text element contains the text itself. The text must be broken into logical minimal segments of about 1-6 words. For example, the traditional blessing formula might be broken into the following segments:

1. Blessed are You,
2. Lord our God,
3. King of the universe

Each segment is enclosed in a tei:seg element. Using the example above:

<tei:seg>Blessed are You,</tei:seg>
<tei:seg>Lord our God,</tei:seg>
<tei:seg>King of the universe</tei:seg>

Each segment must have a valid xml:id attribute with a value that is unique within the document. Individual words and punctuation marks will be tagged and will also have xml:id attributes with unique values. You do not have to do the tagging or provide the attributes yourself. After entering the text in segments, simply go to the XML helper tab and select Tag words and punctuation, followed by Add required xml:id attributes.

The first of the above segments will now look something like this:

<tei:seg xml:id="seg1_w2ab1b5b1b3">
<tei:w xml:id="seg1w1_w2ab1b5b1b3a">Blessed</tei:w>
<tei:w xml:id="seg1w2_w2ab1b5b1b3b2">are</tei:w>
<tei:w xml:id="seg1w3_w2ab1b5b1b3b4">you</tei:w>
<tei:pc xml:id="seg1pc4_w2ab1b5b1b3b5">,</tei:pc>
</tei:seg>