1 Overview

The Manifest.xml described here contains information about a set of editions that are grouped here together, usually for the purpose of further description and processing.

There are two main elements under the root element manifest¹:

editions The editions representing the work under consideration. Work is taken in a very broad sense here.
divisions The internal subdivisions of the work under consideration.

The editions element holds information about the editions that are collected here. It contains edition elements, which give the details for each edition. This includes also the type, which can be either "documentary" or "interpretative". Documentary editions are editions that strive to reproduce an existing print edition, while interpretative editions do reflect the views of the editor and do not follow one single edition.

Other details for editions that will be collected here are the id, which is a unique label (or identifier) used to refer to this specific edition within the manifest and the processing systems.

The edition element may have the following children:

description Description of the edition or item this element is attached to.
divisions The internal subdivisions of the work under consideration.

Both of these elements are optional. description contains a description of the edition, which could be the title, but also other information deemed relevant. divisions allows reference to divisions within the edition. This element is repeatable and when occuring more than once the edition is considered made up of the sequence of these divisions.

The divisions element can also occur as a child element of manifest, optionally following the editions element. If used here, there will be only one division element, which holds all subdivisions as possibly nesting div elements. The purpose of this element is to provide an entry point to the editions, which is neither tied to one specific edition, nor to a hyperlink or similar in a technical sense. The label on the div elements is used to provide a human readable label that can be used to point to that specific division, much the same as "Chapter 2" will (usually) refer to the same section of a work, no matter which edition is used. To serve as a link between this nesting structure of chapters, sections and so forth, each div can have one or more edRef elements, which point to the text span in one of the editions that is covering this specific section.

In this example, the start and end attributes give the number of the first and last token that is part of this section of a text, thus identifying the text span independent of the text format of the text. Other possibilities for adressing a text span are available if the edition is in TEI/XML.

2 The elements defined for the Manifest

Schema KRXManifest: Elements

<creation>

<creation> Information about the creation
Module	KRXManifest
Contained by	KRXManifest: description edition editionGroup
May contain	KRXManifest: date resp title
Content model	<content> <alternate maxOccurs="unbounded" minOccurs="0"> <elementRef key="title"/> <elementRef key="date"/> <elementRef key="resp"/> </alternate> </content>
Schema Declaration	element creation { ( krx_title \| krx_date \| krx_resp )* }

<date>

<date> Date of the work

Module

KRXManifest

Attributes

notbefore

Earliest possible date

Status	Optional
Datatype	string

notafter

Latest possible date

Status	Optional
Datatype	string

cert

Degree of certainty of this assertion

Status	Optional
Legal values are:	high High degree of certainty middle Middle degree of certainty low Low degree of certainty

Contained by

KRXManifest: creation

May contain

Character data only

Content model

<content>
 <textNode/>
</content>

Schema Declaration

element date
{
   attribute notbefore { string }?,
   attribute notafter { string }?,
   attribute cert { "high" | "middle" | "low" }?,
   text
}

<description>

<description> Description of the edition or item this element is attached to.
Module	KRXManifest
Contained by	KRXManifest: div edition manifest
May contain	KRXManifest: creation note title character data
Content model	<content> <alternate maxOccurs="unbounded" minOccurs="0"> <textNode/> <elementRef key="note" minOccurs="0"/> <elementRef key="title" minOccurs="0"/> <elementRef key="creation" minOccurs="0"/> </alternate> </content>
Schema Declaration	element description { ( text \| krx_note? \| krx_title? \| krx_creation? )* }

<div>

<div> One specific subdivision on any level.

Module

KRXManifest

Attributes

label

A label to identify the subdivision, can be any string, but should be unique in the manifest. This can be used to access this textual division.

Status	Optional
Datatype	token

edition

A reference to the edition, as defined elsewhere in this manifest.

Status	Optional
Datatype	IDREF

sequence

Sequencial number of this division, given in such a way that ordering by this number will produce the text in the same sequence as the base edition.

Status	Optional
Datatype	nonNegativeInteger

start

The sequencial number of the first token of this division in the token list.

Status	Optional
Datatype	nonNegativeInteger

end

The sequencial number of the last token of this division in the token list.

Status	Optional
Datatype	nonNegativeInteger

divid

If the source file of this edition has an identifier (usually a xml:id for this subdivision), it can be recorded here.

Status	Optional
Datatype	token

Contained by

KRXManifest: div divisions

May contain

KRXManifest: description div edRef label

Content model

<content>
 <sequence maxOccurs="1" minOccurs="1">
  <elementRef key="label"
   maxOccurs="unbounded" minOccurs="0"/>
  <elementRef key="description"
   minOccurs="0"/>
  <elementRef key="edRef"
   maxOccurs="unbounded" minOccurs="0"/>
  <elementRef key="div"
   maxOccurs="unbounded" minOccurs="0"/>
 </sequence>
</content>

Schema Declaration

element div
{
   attribute label { token }?,
   attribute edition { xsd:IDREF }?,
   attribute sequence { xsd:nonNegativeInteger }?,
   attribute start { xsd:nonNegativeInteger }?,
   attribute end { xsd:nonNegativeInteger }?,
   attribute divid { token }?,
   ( krx_label*, krx_description?, krx_edRef*, krx_div* )
}

<divisions>

<divisions> The internal subdivisions of the work under consideration.

Module

KRXManifest

Attributes

edition

If necessary, the edition for which these textual divisions are valid can be given here

Status	Optional
Datatype	token

Contained by

KRXManifest: edition manifest

May contain

KRXManifest: div

Content model

<content>
 <elementRef key="div"
  maxOccurs="unbounded" minOccurs="1"/>
</content>

Schema Declaration

element divisions { attribute edition { token }?, krx_div+ }

<edition>

<edition> One edition of the work. If there are multiple divisions, this indicates that the sequence of these divisions make up the work.

Module

KRXManifest

Attributes

xml:id

The identifier of the work. This will be used to refer to this manifest from the display of this text.

Status	Optional
Datatype	ID

The identifier of the edition. This is required and has to be unique within this manifest. It will be used by the processing tools to refer to this edition.

Status	Required
Datatype	ID

format

The parsing tool is selected based on the format given here, there are two formats defined at the moment. Additional formats can be added, but require a plugin to parse them.

Status	Required
Legal values are:	xml/TEI TEI file encoded in XML txt/mandoku Mandoku format

location

This gives either the relative path to the local folder containing the edition or a resolvable remote reference to the edition, for example on github.

Status

Required

Datatype

string

Note

TODO: format for remote reference.

TODO: Format for identifying portion of text in file.

base

The edition marked as 'base' is the reference edition for sequential reordering.

Status	Optional
Legal values are:	true This edition is the reference edition false Not the reference edition (default)

type

The edition has to be declared as either ‘documentary’ or ‘interpretative’.

Status	Required
Legal values are:	documentary An edition that documents an existing print source as faithful as possible, without editorial changes. interpretative An edition that might be based on a print source, but possibly makes editorial changes.

role

One of the editions has to be declared as the base edition, the others are reference editions.

Status	Recommended
Legal values are:	base This edition is the base edition. reference All editions except the base edition are considered reference editions. [Default]

language

The language of the document, identified with an identifier according to RFC 1766.

Status	Optional
Datatype	language

sigle

A short identifier used to identify this edition.

Status	Optional
Datatype	string

Contained by

KRXManifest: editionGroup editions

May contain

KRXManifest: creation description divisions tokenmap

Content model

<content>
 <sequence maxOccurs="1" minOccurs="1">
  <elementRef key="creation" maxOccurs="1"
   minOccurs="0"/>
  <elementRef key="description"/>
  <elementRef key="tokenmap" maxOccurs="1"
   minOccurs="0"/>
  <elementRef key="divisions"
   maxOccurs="unbounded" minOccurs="0"/>
 </sequence>
</content>

Schema Declaration

element edition
{
   attribute xml:id { xsd:ID }?,
   attribute id { xsd:ID },
   attribute format { "xml/TEI" | "txt/mandoku" },
   attribute location { string },
   attribute base { "true" | "false" }?,
   attribute type { "documentary" | "interpretative" },
   attribute role { "base" | "reference" }?,
   attribute language { xsd:language }?,
   attribute sigle { string }?,
   ( krx_creation?, krx_description, krx_tokenmap?, krx_divisions* )
}

<editionGroup>

<editionGroup> A group of the editions representing the work under consideration.

Module

KRXManifest

Attributes

type

The treatment of the editions within this group are based on the value of this attribute.

Status	Required
Legal values are:	root The root text of this work. root+annotation The root text, interspersed with commentary. annotation Commentary to the root text, without repeating the text. translation Translations of the text and / or commentary. other Texts, that are grouped with this texts for some reason other than being textually related.

sigle

A short identifier used to identify this group of editions.

Status	Optional
Datatype	string

Contained by

KRXManifest: editions

May contain

KRXManifest: creation edition

Content model

<content>
 <sequence maxOccurs="1" minOccurs="1">
  <elementRef key="creation" maxOccurs="1"
   minOccurs="0"/>
  <elementRef key="edition"
   maxOccurs="unbounded" minOccurs="1"/>
 </sequence>
</content>

Schema Declaration

element editionGroup
{
   attribute type
   {
      "root" | "root+annotation" | "annotation" | "translation" | "other"
   },
   attribute sigle { string }?,
   ( krx_creation?, krx_edition+ )
}

<editions>

<editions> The editions representing the work under consideration. Work is taken in a very broad sense here.
Module	KRXManifest
Contained by	KRXManifest: manifest
May contain	KRXManifest: edition editionGroup
Content model	<content> <alternate maxOccurs="1" minOccurs="1"> <elementRef key="editionGroup" maxOccurs="unbounded" minOccurs="1"/> <elementRef key="edition" maxOccurs="unbounded" minOccurs="1"/> </alternate> </content>
Schema Declaration	element editions { krx_editionGroup+ \| krx_edition+ }

<edRef>

<edRef> Reference to this subdivision in one specific edition, identified by the key.

Module KRXManifest

Attributes

start

The sequencial number of the first token of this division in the token list.

Status	Optional
Datatype	nonNegativeInteger

end

The sequencial number of the last token of this division in the token list.

Status	Optional
Datatype	nonNegativeInteger

key

A reference to the edition, as defined elsewhere in this manifest.

Status	Optional
Datatype	IDREF

timestamp

The timestamp in ISO format, e.g. 2020-10-09T14:23:52+09:00.

Status	Optional
Datatype	dateTime

label

A label to identify the subdivision as used in this edition. It can be any string, but should be unique in the manifest. This can be used to access this textual division.

Status	Optional
Datatype	token

Contained by

KRXManifest: div

May contain Empty element

Content model

<content>
 <empty/>
</content>

Schema Declaration

element edRef
{
   attribute start { xsd:nonNegativeInteger }?,
   attribute end { xsd:nonNegativeInteger }?,
   attribute key { xsd:IDREF }?,
   attribute timestamp { xsd:dateTime }?,
   attribute label { token }?,
   empty
}

<label>

<label> Additional label

Module

KRXManifest

Attributes

language

The language of the label, identified with an identifier according to RFC 1766.

Status	Optional
Datatype	language

Contained by

KRXManifest: div

May contain

Character data only

Content model

<content>
 <textNode/>
</content>

Schema Declaration

element label { attribute language { xsd:language }?, text }

<manifest>

<manifest> The root of the manifest. One manifest describes one work.

Module

KRXManifest

Attributes

xml:id

The identifier of the work. This will be used to refer to this manifest from the display of this text.

Status	Optional
Datatype	ID

Contained by

KRXManifest: manifests

May contain

KRXManifest: description divisions editions title

Note

Currently, only one work can be described per one manifest file. Need to think about what to do with use cases that need multiple works. Use several manifest in a file?

Content model

<content>
 <sequence maxOccurs="1" minOccurs="1">
  <elementRef key="title" minOccurs="0"/>
  <elementRef key="description"/>
  <elementRef key="editions"/>
  <elementRef key="divisions" minOccurs="0"/>
 </sequence>
</content>

Schema Declaration

element manifest
{
   attribute xml:id { xsd:ID }?,
   ( krx_title?, krx_description, krx_editions, krx_divisions? )
}

<manifests>

<manifests> Root for manifests that contain multiple manifest elements.
Module	KRXManifest
Contained by	—
May contain	KRXManifest: manifest
Content model	<content> <elementRef key="manifest" maxOccurs="unbounded"/> </content>
Schema Declaration	element manifests { krx_manifest+ }

<map>

<map> Map of one textual feature to a specific token type

Module

derived-module-KRXManifest

Attributes

src

Element or simple matching expression (for XML texts) or regular expressions (for plain text) that identifies the textual feature

Status	Optional
Datatype	string

tok

Token type

Status	Optional
Legal values are:	h Token is part of a heading p Token is part of a paragraph n Token is part of a note or annotation of any kind q Token is part of a quotation v Token is part of a verse line

Contained by

KRXManifest: tokenmap

May contain

Empty element

Content model

<content>
 <empty/>
</content>

Schema Declaration

element map
{
   attribute src { string }?,
   attribute tok { "h" | "p" | "n" | "q" | "v" }?,
   empty
}

<note>

<note> An additional note
Module	KRXManifest
Contained by	KRXManifest: description
May contain	Character data only
Content model	<content> <textNode/> </content>
Schema Declaration	element note { text }

<resp>

<resp> Person responsible for some aspect of the work

Module

KRXManifest

Attributes

role

Status	Optional
Datatype	string
Sample values include:	author Author compiler Compiler translator Translator

key

A key identifying this person in some reference system.

Status	Optional
Datatype	string

Contained by

KRXManifest: creation

May contain

Character data only

Content model

<content>
 <textNode/>
</content>

Schema Declaration

element resp { attribute role { string }?, attribute key { string }?, text }

<title>

<title> Title of the work.
Module	KRXManifest
Contained by	KRXManifest: creation description manifest
May contain	Character data only
Content model	<content> <textNode/> </content>
Schema Declaration	element title { text }

<tokenmap>

<tokenmap> Mappings from textual features to token types
Module	KRXManifest
Contained by	KRXManifest: edition
May contain	derived-module-KRXManifest: map
Content model	<content> <elementRef key="map" maxOccurs="unbounded" minOccurs="1"/> </content>
Schema Declaration	element tokenmap { krx_map+ }

Schema for Manifest files in the KanripoX project

2020-12-07

Table of contents

1 Overview

2 The elements defined for the Manifest

Schema KRXManifest: Elements

<creation>

<date>

<description>

<div>

<divisions>

<edition>

<editionGroup>

<editions>

<edRef>

<label>

<manifest>

<manifests>

<map>

<note>

<resp>

<title>

<tokenmap>