Schema for nexus files in the KanripoX project

2020-12-07

Table of contents

1 Overview

The nexus files described here describe links between locations in texts. The links consist of references to a span of one or more consecutive characters in a text. Related links can be grouped together to form a nexus. This can be used for example to describe corresponding passages in different versions of a text.

The main elements under the root element nexusListare::

The nexus element holds the locationRef elements, which contain the reference information to locate the passage of the text. The reference is expressed by pointing to a sequence of one or more tokens in a token file for the edition.

2 The elements defined for the nexus files

Schema KRXNexus: Elements

<locationRef>

<locationRef> Reference to a location in the token file. Optionally might hold a copy of the referenced text as a string of characters.
ModuleKRXNexus
Attributes
edIdentifier of the edition (as used in the token file)
Status Required
Datatype string
tpThe sequencial number of the first token in the token file.
Status Required
Datatype nonNegativeInteger
tcountThe number of tokens that make up this text span.
Status Optional
Datatype nonNegativeInteger
Default 1
targetIdentifier of the first token in the text span
Status Required
Datatype string
nLabel or identifier for this reference.
Status Optional
Datatype string
Contained by
KRXNexus: nexus
May containCharacter data only
Content model
<content>
 <textNode/>
</content>
Schema Declaration
element locationRef
{
   attribute ed { string },
   attribute tp { xsd:nonNegativeInteger },
   attribute tcount { xsd:nonNegativeInteger }?,
   attribute target { string },
   attribute n { string }?,
   text
}

<nexus>

<nexus> A group of locationRef elements.
ModuleKRXNexus
Attributes
xml:idThe identifier of this token group.
Status Optional
Datatype ID
tpThe sequencial number of the first token of this text span.
Status Required
Datatype nonNegativeInteger
tcountThe number of tokens that make up this text span.
Status Optional
Datatype nonNegativeInteger
Default 1
Contained by
KRXNexus: nexusList
May contain
KRXNexus: locationRef
derived-module-KRXNexus: note
Content model
<content>
 <sequence maxOccurs="1" minOccurs="1">
  <elementRef key="note"
   maxOccurs="unbounded" minOccurs="0"/>
  <elementRef key="locationRef"
   maxOccurs="unbounded" minOccurs="0"/>
 </sequence>
</content>
Schema Declaration
element nexus
{
   attribute xml:id { xsd:ID }?,
   attribute tp { xsd:nonNegativeInteger },
   attribute tcount { xsd:nonNegativeInteger }?,
   ( nx_note*, nx_locationRef* )
}

<nexusList>

<nexusList> Root for Nexus that may contain one or more nexus elements.
ModuleKRXNexus
Attributes
xml:id
Status Recommended
Datatype ID
edReference to the edition defined in the manifest.
Status Required
Datatype string
nA label
Status Optional
Datatype string
Contained by
—
May contain
KRXNexus: nexus
derived-module-KRXNexus: note
Content model
<content>
 <sequence maxOccurs="1" minOccurs="1">
  <elementRef key="note" maxOccurs="1"
   minOccurs="0"/>
  <elementRef key="nexus"
   maxOccurs="unbounded"/>
 </sequence>
</content>
Schema Declaration
element nexusList
{
   attribute xml:id { ID }?,
   attribute ed { string },
   attribute n { string }?,
   ( nx_note?, nx_nexus+ )
}

<note>

<note> Annotation or additional information concerning the role or purpose of this reference.
Modulederived-module-KRXNexus
Attributes
xml:id
Status Recommended
Datatype ID
Contained by
KRXNexus: nexus nexusList
May containCharacter data only
Content model
<content>
 <textNode/>
</content>
Schema Declaration
element note { attribute xml:id { ID }?, text }
 Home Feedback 
Date: 2020-12-07