Rework odd #67

ingoboerner · 2024-06-21T09:12:56Z

Create a TEI customization (based on TEI Drama ODD) that implements the necessary restrictions for the DraCor API to work.

The derived schema can be used to validate TEI files to be included in DraCor corpora. It allows for greater flexibility in the application of the TEI Guidelines than the original "legacy" ODD derived schema.

The conformance to the API will be tested with Schematron rules that are embedded into the RelaxNG schema.

The ODD also includes definitions for the so-called "features" that were identified in the CLS INFRA Deliverable "On Programmable Corpora" (https://zenodo.org/records/7664964). It includes the explanations of the features developed for the API Ontology (https://github.com/ingoboerner/dracor-ontology/blob/main/v1/dracor_api_ontology.ttl) The identifiers of the features (xml:id s) should allow a automatic linking to the Schemas in the OpenAPI spec (originally, including the links to the ontology, e.g. https://github.com/dracor-org/dracor-api/blob/extend_openapi/api.yaml#L1637-L1639)

At some point it should be possible to gather all <constraintSpec> elements (currently linked with @corresp to the

describing the feature) that are relevant for a feature and thus test if a TEI file in question can be processed by the API to return data on a feature.

The examples from the legacy ODD have been moved to a separate ODD file; eventually it would make sense to re-include them; an open question remains how to proceed in regards to the "Encoding Guidelines" included as a draft in the legacy ODD.

For the initial discussion see also issue #66.

ingoboerner · 2024-06-25T09:48:33Z

Do we want a warning on the edge case, e.g. pantomime:

<body>
      <div type="act">
        <stage>This is an edge case, e.g. pantomime.</stage>
      </div>
</body>

Schematron rule in <constraintSpec ident="network_check_basic_play_structure_sp"/> would warn that there are no speech acts. But I have rule <constraintSpec ident="network_play_without_speaking_characters"/> that triggers on this edge case and suggests in the case of

<body>
      <div type="act">
<!-- empty -->
      </div>
</body>

to add at least a stage direction.

…bly not in use; remove unnecessary examples

ingoboerner · 2024-11-04T10:35:05Z

This is done in tei drama customization, I first uncommented it, not remove it alltogether... not 100% sure why it was there in the first place but it was already switched off in the current working draft:

<!-- <classSpec predeclare="true" module="linking" xml:id="CLLINK"
                type="atts" ident="att.global.linking" mode="change">
                <desc xml:lang="en" versionDate="2014-01-12">defines the
                    attributes used for aggregating partial elements into a
                    single virtual element.</desc>
                <attList>
                    <attDef ident="corresp" usage="opt" mode="delete"/>
                    <attDef ident="synch" usage="opt" mode="delete"/>
                    <attDef ident="sameAs" usage="opt" mode="delete"/>
                    <attDef ident="copyOf" usage="opt" mode="delete"/>
                    <attDef ident="next" usage="opt" mode="change">
                        <valDesc mode="change">a URI which should point to an element of
                            the same type, typically within the same document</valDesc>
                    </attDef>
                    <attDef ident="prev" usage="opt" mode="change">
                        <valDesc mode="change">a URI which should point to an element of
                            the same type, typically within the same document</valDesc>
                    </attDef>
                    <attDef ident="exclude" usage="opt" mode="delete"/>
                    <attDef ident="select" usage="opt" mode="delete"/>
                </attList>     
            </classSpec> -->

ingoboerner · 2024-11-04T12:56:48Z

I have still 14 closed value lists. Will relax the restrictions of all of them but indicate which values are supported by the API as tested with the <event>. Later we can use Schematron to provide encoding hints.

<biblScope>, @type: "volume" and "page"
<classCode>: only "wikidata" of @type
<forename>: @type "patronym"
<l>: some rendering options?
<listRelation>: used to restrict it to the encoding of social relations "personal"
<castGroup>: use of @rend "braced" to display the curly brackets in the output
<name>: @type "variant"
<persName>: @type: "variant", "pen", "nobility", "pseudo"
<person>: @sex
<personGrp>attribute @sex: Maybe this could even be done globally on this attribute
<relation>: @name: "parent_of", "lover_of", ...
<surname>: @sort
<title>: @type: "main", "sub"
<titlePart>: @type: "main", "sub"

…or-org#46

ingoboerner · 2024-11-07T10:58:03Z

OK, now I am running into troubles: As @lehkost pointed out in issue #46 there is a more recent release of the guidelines than installed in my Oxygen ODD Framework. An since version (see the issue) there has been a change to encoding sex/gender which is not reflected in our current way of encoding + is not reflected in the schema that I am currently producing. Don't know how to best proceed with this issue at the moment

cmil · 2024-11-08T16:50:19Z

OK, now I am running into troubles: As @lehkost pointed out in issue #46 there is a more recent release of the guidelines than installed in my Oxygen ODD Framework. An since version (see the issue) there has been a change to encoding sex/gender which is not reflected in our current way of encoding + is not reflected in the schema that I am currently producing. Don't know how to best proceed with this issue at the moment

If there isn't a strong reason that prevents us from doing so I would suggest to base our ODD on the latest TEI version which at the moment is 4.8.1 (https://github.com/TEIC/TEI/releases).

@ingoboerner Can you update your Oxygen framework to that version?

ingoboerner added 8 commits June 18, 2024 11:38

rename old odd to dracor-legacy

ee0bb39

moved encoding guidelines and examples to new odd

0c05b1f

stared new API odd

0b24fe2

include tei_drama odd

5445d72

adapted api schema

cbe1435

added structure, corpus features

31631b5

added features based on ontology and d71

1645efc

some changes to api-odd

5b1d560

ingoboerner assigned cmil and unassigned cmil Jun 21, 2024

ingoboerner requested a review from cmil June 21, 2024 09:13

ingoboerner self-assigned this Jun 21, 2024

add general network-data documentation, adaptions to validate corpus.xml

a85b9ae

ingoboerner added 16 commits June 25, 2024 11:53

check for basic play stucture

47314c5

check for valid ids in who-attributes

9a76368

detect unlinked sp

db4fdea

stubs of constraints for features

bb69ad5

current working version

59bba28

start consilidating odd based ob dracor-api.odd

29c64fe

included encoding guidelines

c5c706c

added schematron for wikidata_id

17861dd

implement testing of the wikidata ID of a play

9a29640

some mior changes

d2ed35d

reintroduce examples of elements starting with a, mark elements proba…

6a17d0c

…bly not in use; remove unnecessary examples

added checks for year written and printed

bb90958

re-added some examples

76a0040

added some tests

1a0995b

re-added the examples for castList

03ed86d

minor changes

b0a8fd5

ingoboerner added 3 commits November 4, 2024 11:47

fix dracor-org#69 don't restrict global attributes

0479ed6

clean up type attribute values of div

a149e8e

loosen restrictions on dates and type of events

fb0c9ee

open up unit list of biblScope

df941cd

ingoboerner mentioned this pull request Nov 5, 2024

Document How/Why to assign Genre to a play #74

Open

ingoboerner added 2 commits November 6, 2024 09:57

update genre encoding

f143192

allow @rend globally

4a5d4db

ingoboerner mentioned this pull request Nov 6, 2024

link tei:castItem and tei:person #34

Open

ingoboerner added 3 commits November 6, 2024 10:31

relax restrictions on rend value list in castGroup

f4d9a38

relax value list of attribute scheme of classCode

87511e5

introduce gloss to the attribute value lists

8018b5e

ingoboerner mentioned this pull request Nov 6, 2024

Granular markup of fragmented verse lines not supported by API when counting lines #75

Open

ingoboerner added 2 commits November 6, 2024 12:39

modify attr part of l see also dracor-org#75

b812a04

open up list of types of listRelation

c7742f4

ingoboerner mentioned this pull request Nov 7, 2024

Type-Values used for <name>, <persName>, ... #76

Open

open list of type of persName see also dracor-org#76

a092f8f

ingoboerner mentioned this pull request Nov 7, 2024

clarify order of items in <listPerson> #77

Open

relaxed type list of attr sex of elem person, personGrp see also drac…

8a19223

…or-org#46

change ident of schema root

025a3f6

ingoboerner mentioned this pull request Nov 7, 2024

Explicitly stating the Version TEI Guidelines used to create the customization from #78

Open

ingoboerner added 4 commits November 7, 2024 12:57

set base TEI version to 4.4.0

7f0991d

relax value list of attribute type on title elements

8c193d7

update list of relation name values

9c280de

fix sort attribute of surname

f788511

cmil force-pushed the rework-odd branch from 00fb7ea to 601bb15 Compare November 21, 2024 07:34

cmil merged commit ed3da1e into dracor-org:rework-odd Nov 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rework odd #67

Rework odd #67

ingoboerner commented Jun 21, 2024

ingoboerner commented Jun 25, 2024 •

edited

Loading

ingoboerner commented Nov 4, 2024

ingoboerner commented Nov 4, 2024

ingoboerner commented Nov 7, 2024

cmil commented Nov 8, 2024 •

edited

Loading

Rework odd #67

Rework odd #67

Conversation

ingoboerner commented Jun 21, 2024

ingoboerner commented Jun 25, 2024 • edited Loading

ingoboerner commented Nov 4, 2024

ingoboerner commented Nov 4, 2024

ingoboerner commented Nov 7, 2024

cmil commented Nov 8, 2024 • edited Loading

ingoboerner commented Jun 25, 2024 •

edited

Loading

cmil commented Nov 8, 2024 •

edited

Loading