Adding an annotation

Annotations include comments, instructions, and links to related texts or audio. This tutorial shows an example of how to add an annotation to an existing document.

The example text, which has a filename "Counting Numbers", streamText will look like:

<j:streamText xml:id="stream">
   <tei:seg xml:id="seg0">The beginning:</tei:seg>
   <tei:seg xml:id="seg1">One</tei:seg>
   <tei:seg xml:id="seg2">Two</tei:seg>
   <tei:seg xml:id="seg3">Three</tei:seg>
</j:streamText>

In our example, we will first add an annotation comment saying that segment "seg1" is "The first counting number."

First, open a new window or tab of the Open Siddur Client and select the "Annotations" tool. Press "New"

In the "Primary language" field, enter the primary language of the annotations contained in the document.

In the "Document Title" field, enter the name of the document that is being annotated (in our case, that would be Counting Numbers). This convention allows us to quickly associate a document with its annotations by the filename. If we expected the annotation to be used elsewhere, we might give the annotation document a more generic name that reflects how the annotations will be used, or what source they come from. The document title should be in the same language as the document's primary language. One optional alternate title can also be added in this dialog.

In the "Annotations id" field, enter a short identifier for the annotations set the document belongs to. This identifier will be used as the way the annotations in this document are turned on or off when texts are being compiled. This may be related to the annotations' author or the book they came from.

Select a license for the annotations' text.

Select the source that the annotations are being copied from.

When you're done with this dialog, press "New"

A document template will be created. Toward the bottom of the document, you will see:

<j:annotations xml:id="ann">
        <tei:idno>test</tei:idno>
        <tei:note xml:id="note1" type="comment">I am an example. Edit or delete me.</tei:note>
</j:annotations>

We will replace the template note with:

<tei:note xml:id="note_cn" type="comment">The first counting number</tei:note>

The note's identifier (required) is "note_cn". It is a "comment" type of annotation. Other valid annotation types are:

• audio: used to provide a link between a text and an audio representation of the text (linked by a tei:ref element). The text content of the note should describe the audio.
• comment: commentary on the source text. The most generic form of annotation.
• editorial: notation about how the text was edited
• inline: an annotation intended to appear within the stream of text. Prefer other annotation types.
• instruction: instructional material about the text (when to say it, what to do while saying it)
• transcription: notation about the text's transcription
• translation: notation commenting on some aspect of a translation.

When you are finished adding notes, press "save" to save the annotation document.

To link the annotation to the text, go back to the editor for the file containing the text (In our case, this is the original text "Counting Numbers").

Between the end of the tei:teiHeader and beginning of the tei:text element, add a links section if one does not already exist:

   </tei:teiHeader>
   <j:links>
   </j:links>
   <tei:text>

Inside the links section, link the text to the annotation:

<tei:link type="annotation" target="#seg1 /data/notes/Counting%20Numbers#note_cn"/>

(The link type attribute should be "instruction" for instruction-type annotations. For other annotations, it may be "annotation" or "note") For help finding the correct URL for the note target, you can use the "XML>Insert external link" dialog and select "annotations"

When the document is saved, the annotation link is complete.