Skip to content

Commit

Permalink
added annotations and software entries
Browse files Browse the repository at this point in the history
  • Loading branch information
@daniel-jettka
daniel-jettka committed Feb 5, 2024
1 parent c4cc2d0 commit 99beef6
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 18 deletions.
44 changes: 27 additions & 17 deletions data/JTEI/12_2019-20/jtei-cc-ra-bauman-170-source.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -375,8 +375,8 @@
</xsl:if>
</xsl:template>
</egXML>
<head type="legend"><ptr type="software" xml:id="XSLT" target="#XSLT"/><rs
type="soft.name" ref="#XSLT">XSLT</rs> template that converts an
<head type="legend"><ptr type="software" xml:id="R1" target="#xslt"/><rs
type="soft.name" ref="#R1">XSLT</rs> template that converts an
<gi>lb</gi> into a space.</head>
</figure></p>
</div>
Expand Down Expand Up @@ -439,7 +439,8 @@
level="m">A Romance of Many Dimensions</title>) separately and to
differentiate it from the main title. She plans to use TEI P5, so her first
thought is <q>Does the TEI <gi>title</gi> element have a <att>type</att>
attribute?</q> So she switches into oXygen, creates a new
attribute?</q> So she switches into <ptr type="software" xml:id="R5"
target="#oxygen"/><rs type="soft.name" ref="#R5">oXygen</rs>, creates a new
<ident>tei_all</ident> document, puts her cursor immediately before the
closing angle bracket of the <gi>title</gi> start-tag<note><p>The TAGC in
SGML nomenclature.</p></note> and types a space. The result (<ptr
Expand All @@ -449,9 +450,11 @@
the TEI suggested values. <figure xml:id="image2">
<graphic url="images/oXygen_try.png" width="1746px" height="1024px"/>
<head type="legend">Choosing the <att>type</att> attribute from a
drop-down in oXygen</head>
drop-down in <ptr type="software" xml:id="R6"
target="#oxygen"/><rs type="soft.name" ref="#R6">oXygen</rs></head>
</figure> In this fictional—but completely believable—example the encoder
has used the schema (<ident>tei_all</ident>) through a tool (oXygen) as a
has used the schema (<ident>tei_all</ident>) through a tool (<ptr type="software" xml:id="R7"
target="#oxygen"/><rs type="soft.name" ref="#R7">oXygen</rs>) as a
way of finding out about the markup language (TEI). Yes, she could just as
well have read the <ref
target="https://www.tei-c.org/Vault/P5/3.3.0/doc/tei-p5-doc/en/html/ref-title.html"
Expand All @@ -465,13 +468,15 @@
help us write our documents. Editing software can read the schema and
restrict the markup or even text that can be entered based on the rules in
the schema and the position of the cursor. <ptr target="#image3"
type="crossref"/> demonstrates oXygen helping an encoder. Here oXygen is
type="crossref"/> demonstrates oXygen helping an encoder. Here <ptr type="software" xml:id="R8"
target="#oxygen"/><rs type="soft.name" ref="#R8">oXygen</rs> is
not just answering a common question: is the TEI element for a notes
statement <gi>notesStmt</gi> or <gi>noteStmt</gi>? It is also requiring that
the user enter only one of three elements allowed by the schema (or a
comment, etc.). <figure xml:id="image3">
<graphic url="images/oxygen_notesStmt.png" width="693px" height="271px"/>
<head type="legend">Inserting an element in oXygen</head>
<head type="legend">Inserting an element in <ptr type="software" xml:id="R9"
target="#oxygen"/><rs type="soft.name" ref="#R9">oXygen</rs></head>
</figure> By using an editor that understands the schema, an encoder can
avoid making common mistakes (like misspelling an element name) at the time
of the original encoding. This is extremely helpful in constraining one’s
Expand Down Expand Up @@ -792,8 +797,8 @@
would ignore it, would not cause a problem if it were left.</p>
<p>Either way, in order to avoid this potential maintenance nightmare,
<ident>tei_customization.odd</ident> is not a static file, but rather is
generated by running an <ptr type="software" xml:id="XSLT" target="#XSLT"/><rs
type="soft.name" ref="#XSLT">XSLT</rs> program that reads as its input the
generated by running an <ptr type="software" xml:id="R2" target="#xslt"/><rs
type="soft.name" ref="#R2">XSLT</rs> program that reads as its input the
source to TEI P5<note><p>Remember, the TEI Guidelines are written in TEI. The
source to all of P5 is a single TEI document, although for convenience it is
split into well over 850 separate files.</p></note> and writes
Expand Down Expand Up @@ -886,12 +891,12 @@
</div>
<div xml:id="howToGetIt">
<head>How to Get it and Use it</head>
<p>The <ptr type="software" xml:id="XSLT" target="#XSLT"/><rs type="soft.name"
ref="#XSLT">XSLT</rs> program used to generate
<p>The <ptr type="software" xml:id="R3" target="#xslt"/><rs type="soft.name"
ref="#R3">XSLT</rs> program used to generate
<ident>tei_customization.odd</ident> can be found in the <ref
target="https://github.com/TEIC/TEI/tree/dev/P5/Utilities">TEI <ptr
type="software" xml:id="GitHub" target="#GitHub"/><rs type="soft.name"
ref="#GitHub">GitHub</rs> repository</ref>. It is currently called
type="software" xml:id="R4" target="#github"/><rs type="soft.name"
ref="#R4">GitHub</rs> repository</ref>. It is currently called
<ident>TEI-to-tei_customization.xslt</ident>. The generated
<ident>tei_customization</ident> ODD file and the schemas generated from it can
be found in each release of the TEI from 3.3.0 on.<note><p>For example, the
Expand All @@ -902,10 +907,13 @@
target="http://www.tei-c.org/Vault/P5/3.3.0/xml/tei/custom/schema/relaxng/tei_customization.rnc"
/>.</p></note></p>
<p>Furthermore, the current version of <ident>tei_customization</ident> is available
from within oXygen as part of the TEI oXygen framework. However, the RELAX NG
from within <ptr type="software" xml:id="R10"
target="#oxygen"/><rs type="soft.name" ref="#R10">oXygen</rs> as part of the <ptr type="software" xml:id="R11"
target="#teioxygenframework"/><rs type="soft.name" ref="#R11">TEI oXygen framework</rs>. However, the RELAX NG
schema (tei_customization.rng or tei_customization.rnc) has the behavior discussed
in <ptr target="#appendix1" type="crossref"/>. While this is not a bug or broken
in any way, it is likely to be confusing and problematic for most users of oXygen.
in any way, it is likely to be confusing and problematic for most users of <ptr type="software" xml:id="R12"
target="#oxygen"/><rs type="soft.name" ref="#R12">oXygen</rs>.
The TEI_Council is interested in finding a way around this difficulty.</p>
</div>
</div>
Expand Down Expand Up @@ -1144,7 +1152,8 @@
customization that she has to do this. The consequences of failing to turn it off are
severe, though: although completion pop-up boxes still work, validation (both
automatic validation as you type and static validation, for example ⌘-⇧-V) completely
stops working. Furthermore, oXygen leaves this feature on by default for a reason.
stops working. Furthermore, <ptr type="software" xml:id="R13"
target="#oxygen"/><rs type="soft.name" ref="#R13">oXygen</rs> leaves this feature on by default for a reason.
Even though ID/IDREF checking itself is of almost no use to a user working with TEI
P5 documents,<note><p>Because P5 does not use the ID/IDREF mechanism, the only one of
the three added constraints that is useful is (2), that the value of
Expand All @@ -1157,7 +1166,8 @@
<att>prev</att>). And that is a very well-loved feature of oXygen. There are
several possible solutions to this problem, each of which has its drawbacks. The TEI
Council will hopefully implement one of them soon, making use of
<ident>tei_customization</ident> from the oXygen framework much less
<ident>tei_customization</ident> from the <ptr type="software" xml:id="R14"
target="#teioxygenframework"/><rs type="soft.name" ref="#R14">oXygen framework</rs> much less
problematic.</p>
</div>
</back>
Expand Down
7 changes: 6 additions & 1 deletion taxonomy/software-list.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1606,7 +1606,12 @@
the web without server-side processing or translation to HTML.</ref>
<ref type="category">research</ref>
</item>
</list>
<item xml:id="teioxygenframework">
<name>TEI oXygen Framework</name>
<ref type="URL"/>
<ref type="description"/>
</item>
</list>
</body>
</text>
</TEI>

0 comments on commit 99beef6

Please sign in to comment.