Skip to content

Commit

Permalink
Adding handNotes and handNote and adding documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
joeytakeda committed Feb 20, 2025
1 parent 2f89dce commit e79f88d
Show file tree
Hide file tree
Showing 4 changed files with 130 additions and 3 deletions.
67 changes: 67 additions & 0 deletions docs/transcribing_editing.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ Uncommon or unfamiliar abbreviations—like Revd—will often need to be expande
<title>Letter from the <choice><abbr>Revd.</abbr><expan>Reverend</expan></choice> Mr. <persName>Lyon</persName></title>
```

#### Expanding Hyphenated Words

Hyphenated words (i.e. words tagged with `<w>`) may also need to be expanded; in this case, just wrap the `<w>` in an `<abbr>` and then use a `<choice>` and `<expan>` as above:



### Supplying, Regularizing, and Flagging Incorrect Text

Since the LiM represents multiple voices, we need to be explicit in our signalling of our editorial interventions and judicious in our appraisal of what kind of intervention we need to make.
Expand Down Expand Up @@ -216,3 +222,64 @@ How and where you attach that `@xml:lang` depends on whether the segment of fore
<item><title>This example was created <foreign xml:lang="la">ex nihilo</foreign></title></item>
```

### Multiple Hands

Annotations in different hands—i.e. additions written in a different medium by another scribe—can be encoded using the `@hand` attribute in concert with the `<handNotes>` element in the `<teiHeader>`.

Hands are not centralized, so each distinct hand encountered in a file needs to be encoded in the `<teiHeader>`. Specifically, the `<handNotes>` and `<handNote>` element should appear in the `<profileDesc>`, below the `<limItem>` element:

```
<profileDesc>
<limItem>
<!--Lots of metadata here...-->
</limItem>
<!--Add a handNotes and handNote element here-->
<handNotes>
<handNote></handNote>
</handNotes>
</profileDesc>
```

Encode each distinct hand in the document using the `<handNote>` element, which must contain an `@xml:id` and a `@medium`:

```
<handNotes>
<handNote xml:id="hand_pencil" medium="pencil">Unknown hand in pencil</handNote>
</handNotes>
```

If you know the scribe, use the `@scribeRef` attribute to denote to whom the hand belongs:

```
<handNote xml:id="hand_crayon" medium="crayon" scribeRef="pers:BLOGJ1">Hand in crayon, likely J. Bloggs.</handNote>
```

Once the `<handNote>` is encoded, use the `@hand` attribute to point to the `@xml:id` of the `<handNote>`:

```
<!--In the teiHeader-->
<teiHeader>
<!-- [...] -->
<profileDesc>
<limItem>
<!--[...]-->
</limItem>
<handNotes>
<handNote xml:id="hand_pencil" medium="pencil">Unknown hand in pencil</handNote>
<handNote xml:id="hand_crayon" medium="crayon" scribeRef="pers:BLOGJ1">Hand in crayon, likely J. Bloggs.</handNote>
</handNotes>
</profileDesc>
<!--[...]-->
</teiHeader>
<text>
<body>
<!--[...]-->
<add hand="#hand_pencil">Bogue</add>
<!--[...]-->
<note type="lim" anchored="false" hand="#hand_crayon">
<p>[...]</p>
</note>
</body>
</text>
```

18 changes: 18 additions & 0 deletions schema/lim.full.odd
Original file line number Diff line number Diff line change
Expand Up @@ -1244,6 +1244,24 @@

</constraint>
</constraintSpec>
</elementSpec><elementSpec ident="handNote" module="header" mode="change">
<attList>
<attDef ident="xml:id" mode="change" usage="req"/>
<attDef ident="medium" mode="change" usage="rec">
<valList type="closed" mode="add">
<valItem ident="pencil" mode="add"/>
<valItem ident="ink" mode="add"/>
<valItem ident="crayon" mode="add"/>
</valList>
</attDef>
<attDef ident="n" mode="delete"/>
<attDef ident="scribe" mode="delete"/>
<attDef ident="script" mode="delete"/>
<attDef ident="scriptRef" mode="delete"/>
<attDef ident="part" mode="delete"/>
<attDef ident="scope" mode="delete"/>
<attDef ident="source" mode="delete"/>
</attList>
</elementSpec><elementSpec ident="langUsage" module="header" mode="change">
<content>
<elementRef key="language" minOccurs="1" maxOccurs="unbounded"/>
Expand Down
28 changes: 25 additions & 3 deletions schema/lim.rng
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?><grammar xmlns="http://relaxng.org/ns/structure/1.0" xmlns:tei="http://www.tei-c.org/ns/1.0" xmlns:teix="http://www.tei-c.org/ns/Examples" xmlns:xlink="http://www.w3.org/1999/xlink" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes" ns="http://www.tei-c.org/ns/1.0"><!--
Schema generated from ODD source 2025-02-20T04:09:06Z. .
Schema generated from ODD source 2025-02-20T04:34:10Z. .
TEI Edition: P5 Version 4.7.0. Last updated on 16th November 2023, revision e5dd73ed0
TEI Edition Location: https://www.tei-c.org/Vault/P5/4.7.0/
Expand Down Expand Up @@ -5245,8 +5245,30 @@ Sample values include: 1] first-line; 2] first-letter; 3] before; 4] after</a:do
<element name="handNote">
<a:documentation xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0">(note on hand) describes a particular style or hand distinguished within a manuscript. [10.7.2. Writing, Decoration, and Other Notations]</a:documentation>
<ref name="macro.specialPara"/>
<ref name="att.global.attributes"/>
<ref name="att.handFeatures.attributes"/>
<ref name="att.global.attribute.xmllang"/>
<ref name="att.global.rendition.attribute.rendition"/>
<ref name="att.handFeatures.attribute.scribeRef"/>
<attribute name="xml:id">
<a:documentation xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0">(identifier) provides a unique identifier for the element bearing the attribute.</a:documentation>
<data type="ID"/>
</attribute>
<optional>
<attribute name="medium">
<a:documentation xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0">describes the tint or type of ink, e.g. brown, or other writing medium, e.g. pencil</a:documentation>
<list>
<oneOrMore>
<choice>
<value>pencil</value>
<a:documentation xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0"/>
<value>ink</value>
<a:documentation xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0"/>
<value>crayon</value>
<a:documentation xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0"/>
</choice>
</oneOrMore>
</list>
</attribute>
</optional>
<empty/>
</element>
</define>
Expand Down
20 changes: 20 additions & 0 deletions schema/modules/header.xml
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,26 @@
</constraint>
</constraintSpec>
</elementSpec>
<!--handNote-->
<elementSpec ident="handNote" module="header" mode="change">
<attList>
<attDef ident="xml:id" mode="change" usage="req"/>
<attDef ident="medium" mode="change" usage="rec">
<valList type="closed" mode="add">
<valItem ident="pencil" mode="add"/>
<valItem ident="ink" mode="add"/>
<valItem ident="crayon" mode="add"/>
</valList>
</attDef>
<attDef ident="n" mode="delete"/>
<attDef ident="scribe" mode="delete"/>
<attDef ident="script" mode="delete"/>
<attDef ident="scriptRef" mode="delete"/>
<attDef ident="part" mode="delete"/>
<attDef ident="scope" mode="delete"/>
<attDef ident="source" mode="delete"/>
</attList>
</elementSpec>
<!--langUsage-->
<elementSpec ident="langUsage" module="header" mode="change">
<content>
Expand Down

0 comments on commit e79f88d

Please sign in to comment.