xldl.dtd

XLDL Literature Description Language

$Date: 2005/01/04 12:47:47 $

Overview: doctype for novels, stories, poems, plays
Version: 0.2.0
Copyright: 2004 (c) Ingo Schramm
License: GNU LGPL
Public: -//Ister.ORG//XLDL Literature Description Language//EN
System: http://xml.ister.org/dtd/xldl/xldl.dtd

This file provides an XML doctype that may be useful for the storage of novels, stories, poems and related texts. In general, it may not be useful for scientific literature. The doctype is aimed to be as useful as possible and as powerful as needed. A lot of features are supported like version control, internationalization or custom treatment of selected parts of text.

With XLDL you may also mark certain entities, such as acting persons, locations, times or metaphors. With a capable software, these marks may be useful to navigate through the logical structure of the document or to group and search these entities. This allows the user to treat an XLDL document like a small database.

As usual with XML, this doctype reflects the semantic structure of a text. It cannot store typographical information. Please, use XSL for that purpose or transform a document with XSLT to fit for another document type (such as XHTML or FO).

Changelog:

0.2.0
added element <sourcelang>
added element <mark>
added element <binary>
moved element <holder> to <owner>
added a number of id attributes

0.1.0
first production release

This document includes DTDDoc documentation.

Define an opus.

This element opens an XLDL document. Each such document is considdered to be an opus. An opus has some meta data and some contents. Additionally, an opus can have different parts in its contents such as volumes, chapters or acts.

<opus>
    <meta></meta>
    <content></content>
</opus>

<opus>'s children Name Cardinality content Only one meta Only one

<opus>'s attributes Name Values Default class books, book, article, novel, story, essay, poem, play, tragedy, comedy, radioplay, screenplay xmlns http://xml.ister.org/dtd/xldl xmlns:xldl http://xml.ister.org/dtd/xldl

(meta, content)

specify the XLDL namespace of an opus

Default value: http://xml.ister.org/dtd/xldl

specify the default namespace of an opus

Default value: http://xml.ister.org/dtd/xldl

specify the class of the current opus

Possible values : books, book, article, novel, story, essay, poem, play, tragedy, comedy, radioplay, screenplay

Metadata of the current opus.

This element encloses all metadata of the opus.

<meta>
  <title>The Wide Open</title>
  <author>John Gott</author>
</meta>

<meta>'s children Name Cardinality acknowledgement Any number author Any number copyright One or none dedication Any number disclaimer Any number slogan Any number sourcelang One or none subtitle Any number title Only one type Only one

(title, subtitle*, author*, type, copyright?, sourcelang?, dedication*, acknowledgement*, disclaimer*, slogan*)

Give the global title of the opus.

If you need to store different languages of the title you may use a <text> tag inside of <title>.

 
<title>
  <text>
    <par xml:lang="eng">The Wide Open</par>
    <par xml:lang="ger">Die offene Weite</par>
  </text>
</title>

<title>'s children Name Cardinality text Any number

(#PCDATA | text)*

Give one or more subtitles.

If you need to store different languages of one subtitle you may use a <text> tag inside of <title>.

<subtitle></subtitle>

<subtitle>'s children Name Cardinality text Any number

(#PCDATA | text)*

Store the names of one or more authors.

<author>John Gott</author>

Specify the type of the text.

While the class attribute of the <opus> tag specifies the opus in a standardized way, this tag may be used to store a more customizable specification of the text's type, usually the one the author of the text has specified.

<type>faustic novel</type>

Store information about copyrights.

The copyright of a text may be reserved. This tag exists to store information about this fact.

<copyright>
  <year>2004</year>
  <owner>John Gott</owner>
  <text>
    <par>Some rights reserved.</par>
    <par>This work is licensed under a Creative Commons License.</par>
  </text>
</copyright>

<copyright>'s children Name Cardinality location Any number owner Only one text One or none year Only one

(year, owner, location*, text?)

The year the copyright has been claimed.

<year>2004</year>

The owner of the copyright.

<owner>John Gott</owner>

The location of the copyright claim.

<location>EU</location>
<location>USA</location>
<location>World</location>

Give the original or source language of the opus.

<sourclang>ger</sourcelang>

The opus or a part of the opus may be dedicated to someone.

<dedication>To Nora.</dedication>

The author or publisher may need to acknowledge someone.

<acknowledgement>
  <text>
    <par>My Brother.</par>
  </text>
</acknowledgement>

<acknowledgement>'s children Name Cardinality text Only one

(text)

If the publisher or the author have something to disclaim.

<disclaimer>
  <text>
    <par>Seriousness cannot be guaranteed.</par>
  </text>
</disclaimer>

<disclaimer>'s children Name Cardinality text Only one

(text)

There may be a slogen preceeded to the whole opus.

<slogan>
  <text>
    <par>The wide open. Nothing holy.</par>
  </text>
  <author>Bodhidarma</author>
</slogan>

<slogan>'s children Name Cardinality author Any number text Only one

(text, author*)

This tag encloses the content of the opus.

<content version="1.0" date="2004-31-12">
  <text></text>
</content>

If you want to store different versions of the content in one single document you must use the <extra> tag since only one <content> tag is allowed.

<content>
  <extra>
    <content version="1.0"></content>
    <content version="2.0"></content>
  </extra>
</content>

<content>'s children Name Cardinality act Any number chapter Any number coda One or none extra Any number part Any number preface One or none scene Any number text Any number volume Any number

<content>'s attributes Name Values Default date version

(preface?, (volume+ | part+ | chapter+ | act+ | scene+ | text+ | extra*), coda?)

specify the version of the content

specify the date of the content

This tag includes a preface.

<preface>
  <title>Preface</title>
  <text>
    </par>This book is about nothing.</par>
  </text>
</preface>

<preface>'s children Name Cardinality chapter Any number extra Any number subtitle Any number text Any number title One or none

<preface>'s attributes Name Values Default id Match the ID rules.

(title?, subtitle*, (chapter+ | text+ | extra*))

specify a unique id

Possible values : Match the ID rules.

This tag stores any type of text.

The <text> tag encloses nearly any type of text. It can be used in a huge number of different tags that define special structural semantics.

<text>
  <par>A one line poem.</par>
  <poetize>
    <stanza>
       <line>Little Little Line lived long, alas, by wine.</line>
    </stanza>
  </poetize>
</text>

<text>'s children Name Cardinality extra Any number footnote Any number par Any number poetize Any number

<text>'s attributes Name Values Default id Match the ID rules.

((par+ | poetize+ | extra*), footnote*)

specify a unique id

Possible values : Match the ID rules.

Open a volume of a huge opus.

<opus>
  <volume number="1">
    <title>Volume One</title>
  </volume>
  <volume number="2">
    <title>Volume Two</title>
  </volume>
</opus>

<volume>'s children Name Cardinality chapter Any number coda One or none dedication One or none extra Any number part Any number preface One or none slogan One or none subtitle Any number title One or none

<volume>'s attributes Name Values Default id Match the ID rules. number

(title?, subtitle*, dedication?, slogan?, preface?, (part+ | chapter+ | extra*), coda?)

specify a unique id

Possible values : Match the ID rules.

the number of the volume

Open a part of e.g. an opus or volume.

<volume number="1">
  <part number="1">
    <title>The Drunken Duke</title>
  </part>
  <part number="2">
    <title>Police and Thiefs</title>
  </part>
</volume>

<part>'s children Name Cardinality chapter Any number dedication One or none extra Any number slogan One or none subtitle Any number title One or none

<part>'s attributes Name Values Default id Match the ID rules. number

(title?, subtitle*, dedication?, slogan?, (chapter+ | extra*))

specify a unique id

Possible values : Match the ID rules.

the number of the part

Define a chapter.

<content>
  <chapter number="1">
    <title>Chapter I</title>
  </chapter>
  <chapter number="2">
    <title>Chapter II</title>
  </chapter>
</content>

<chapter>'s children Name Cardinality dedication One or none extra Any number section Any number slogan One or none subtitle Any number text Any number title One or none

<chapter>'s attributes Name Values Default id Match the ID rules. number

(title?, subtitle*, dedication?, slogan?, (section+ | text+ | extra*))

specify a unique id

Possible values : Match the ID rules.

the number of the chapter

Define a section.

<content>
  <chapter number="1">
    <title>Chapter I</title>
    <section number="1">
      <title>1.</title>
    </section>
    <section number="2">
      <title>2.</title>
    </section>
  </chapter>
</content>

<section>'s children Name Cardinality dedication One or none extra Any number slogan One or none subtitle Any number text Any number title One or none

<section>'s attributes Name Values Default id Match the ID rules. number

(title?, subtitle*, dedication?, slogan?, (text+ | extra*))

specify a unique id

Possible values : Match the ID rules.

the number of the section

This tag may be used to define a coda.

A coda can also be considdered as an epilog or something like this.

<content>
  <chapter number="1"></chapter>
  <chapter number="2"></chapter>
  <coda></coda>
</content>

<coda>'s children Name Cardinality chapter Any number extra Any number text Any number

(chapter+ | text+ | extra*)

This tag defines an act of a dramatic opus.

<opus class="play">
<content>
  <act number="1">
    <title>First Act</title>
    <scene></scene>
  </act>
</content>
</opus>

<act>'s children Name Cardinality dedication One or none description One or none extra Any number scene Any number slogan One or none subtitle Any number title One or none

<act>'s attributes Name Values Default id Match the ID rules. number

(title?, subtitle*, dedication?, slogan?, description?, (scene+ | extra*))

specify a unique id

Possible values : Match the ID rules.

the number of the act

This tag encloses a scene of a dramatic opus.

<act number="1">
  <scene number="1">
     <title>Scene 1</title>
  </scene>
  <scene number="2">
     <title>Scene 2</title>
  </scene>
</act>

<scene>'s children Name Cardinality acting Any number description Any number extra Any number slogan One or none speech Any number subtitle Any number title One or none

<scene>'s attributes Name Values Default id Match the ID rules. number

(title?, subtitle*, slogan?, acting*, ((description?, speech)+ | extra*))

specify a unique id

Possible values : Match the ID rules.

the number of the scene

With this tag one may define the acting parts of a scene.

<scene number="1">
  <acting>The Officer</acting>
  <acting>The Thief</acting>
</scene>

<acting>'s children Name Cardinality extra Any number

(#PCDATA | extra)*

A single speech.

<scene>
  <speach>
    <speaker>The Officer</speaker>
    <text>
      <par>Alas!</par>
    </text>
  </speach>
</scene>

<speech>'s children Name Cardinality description Any number extra Any number speaker Only one text Any number

(speaker, ((description?, text)+ | extra*))

The speaker of the current speech.

<scene>
  <speach>
    <speaker>The Officer</speaker>
    <text>
      <poetize>
        <stanza>
          <line>Alas!</line>
        </stanza>
      <poetize>
    </text>
  </speach>
</scene>

<speaker>'s children Name Cardinality extra Any number

(#PCDATA | extra)*

Give a custom descrption to a speech, scene or act.

<speach>
  <speaker>The Officer</speaker>
  <description>sad</description>
  <text>
    <par>Alas...</par>
  </text>
  <description>angry</description>
  <text>
    <par>Alas!</par>
  </text>
</speach>

<description>'s children Name Cardinality extra Any number

(#PCDATA | extra)*

Enclose a single paragraph.

Every text snippet should either be stored inside of a <par> tag or a <line> tag.

<par>"What a wonderful day", she said.</par>

To apply version control you may use the version attribute.

<par id="p23" idrefs="p23_0.1.1 p23_0.1.2" version="0.1.0">"What a wonderful day", she said.</par>
<par id="p23_0.1.1" idref="p23" version="0.1.1">"What a beautiful day", she said.</par>
<par id="p23_0.1.2" idref="p23" version="0.1.2">"What a day", she said.</par>

Use the mode attribute to request special treatment of the paragraph.

<par mode="hidden" type="todo">Add a chapter here.</par>

<par>'s children Name Cardinality binary Any number enum Any number extra Any number mark Any number poetize Any number tinged Any number

<par>'s attributes Name Values Default date id Match the ID rules. idref Match the IDREF rules. idrefs Match the IDREFS rules. mode special, solitary, empty, hidden type version xml:lang Match the NMTOKEN rules.

(#PCDATA | poetize | enum | tinged | mark | binary | extra)*

specify a unique id

Possible values : Match the ID rules.

reference 'id' e.g. of another version

Possible values : Match the IDREF rules.

references to 'id's e.g. of subsequent versions

Possible values : Match the IDREFS rules.

define a version of this paragraph

define the date of this paragraph or version

define a custom type of the paragraph

define a special mode of this paragraph

Possible values : special, solitary, empty, hidden

define the language of the paragraph

Possible values : Match the NMTOKEN rules.

Define a footnote.

Usually not needed, but if you try to store texts of Laurence Sterne or Jean Paul you might be happy about this.

<par id="p345" idref="f24"> </par>
<footnote id="f24" idref="p345" offset="0">
This line is not empty. It shows the nothingness in its entire beauty!
</footnote>

<footnote>'s children Name Cardinality binary Any number extra Any number tinged Any number

<footnote>'s attributes Name Values Default id Match the ID rules. idref Match the IDREF rules. offset

(#PCDATA | tinged | binary | extra)*

specify a unique id

Possible values : Match the ID rules.

reference 'id' e.g. of paragraph

Possible values : Match the IDREF rules. - Required

bind this footnote to offset'th character of the referenced paragraph, starting with 0

Required

This is for poems or similar parts of a text.

<poetize>
  <stanza>
    <line></line>
  <stanza>
</poetize>

<poetize>'s children Name Cardinality extra Any number footnote Any number stanza At least one

(stanza+, (footnote* | extra*))

Enclose a single stanza.

<poetize>
  <stanza>
    <line>One hand good,</line>
    <line>One holds food,</line>
    <line>One is none,</line>
    <line>Linda's gone.</line>
  <stanza>
</poetize>

Cf. <par> for the use of version, type and mode attribute.

<stanza>'s children Name Cardinality extra Any number line Any number

<stanza>'s attributes Name Values Default date id Match the ID rules. idref Match the IDREF rules. idrefs Match the IDREFS rules. mode special, solitary, empty, hidden type version

(line+ | extra*)

specify a unique id

Possible values : Match the ID rules.

reference 'id' e.g. of another version

Possible values : Match the IDREF rules.

references to 'id's e.g. of subsequent versions

Possible values : Match the IDREFS rules.

define a version of this stanza

define the date of this stanza or version

define a custom type of the stanza

define a special mode of this stanza

Possible values : special, solitary, empty, hidden

A single line of a poem.

<poetize>
  <stanza>
    <line>One hand good,</line>
    <line>One holds food,</line>
    <line>One is none,</line>
    <line>Linda's gone.</line>
  <stanza>
</poetize>

Cf. <par> for the use of version, type and mode attribute.

<line>'s children Name Cardinality binary Any number extra Any number mark Any number tinged Any number

<line>'s attributes Name Values Default date id Match the ID rules. idref Match the IDREF rules. idrefs Match the IDREFS rules. mode special, solitary, empty, hidden type version xml:space default, preserve preserve

(#PCDATA | tinged | mark | binary | extra)*

specify a unique id

Possible values : Match the ID rules.

reference 'id' e.g. of another version

Possible values : Match the IDREF rules.

references to 'id's e.g. of subsequent versions

Possible values : Match the IDREFS rules.

define a version of this line

define the date of this line or version

define a custom type of the line

define a special mode of this line

Possible values : special, solitary, empty, hidden

define the treatment of blanks for this line

Possible values : default, preserve - Required

This tag allows for structural recursion.

The same effect may take place if one refers to external entities.

<opus>
  <meta></meta>
  <content>
    <extra name="global">
      <content></content>
      <content>
         <text>
           <par>
             <extra name="local">
                <meta></meta>
                <content></content>
             <extra>
           </par>
         </text>
      </content>
    </extra>
  </content>
</opus>

<extra>'s children Name Cardinality content Any number meta One or none

<extra>'s attributes Name Values Default id Match the ID rules. name

(meta? | content+)

specify a unique id

Possible values : Match the ID rules.

give the current recursion container a name

Define an enumeration.

<enum type="number">
  <item><par>First</par></item>
  <item><par>Second</par></item>
</enum>

<enum>'s children Name Cardinality item At least one

<enum>'s attributes Name Values Default id Match the ID rules. type

(item+)

specify a unique id

Possible values : Match the ID rules.

define a custom type of the enumeration

Define an item of an enumeration.

<enum type="number">
  <item><par>First</par></item>
  <item><par>Second</par></item>
</enum>

<item>'s children Name Cardinality extra Any number par Any number

<item>'s attributes Name Values Default id Match the ID rules.

(par+ | extra+)

specify a unique id

Possible values : Match the ID rules.

Mark text as tinged.

This may be used to emphasize some words or to mark words or sentences as to speek or understand in a special way, e.g. angry or gentle.

<par>So, <tinged type="angry">come</tinged> to me!</par>

<tinged>'s attributes Name Values Default id Match the ID rules. idref Match the IDREF rules. type

specify a unique id

Possible values : Match the ID rules.

reference a single node

Possible values : Match the IDREF rules.

specify the type of the tinge

Set a sematic mark.

This may be used to mark persons, sites, times, metaphors or other entities. The marks may be grouped by the type attribute to use the document as a searchable database.

<par>"What a beautiful day", <mark type="person" name="Linda">she</mark> said.</par>
<par>They met <mark type="site" name="Linda's Appartement">there</mark> the next day.</par>
<par>They met there <mark type="time" name="day 3">the next day</mark>.</par>
<par>Her words were <mark type="metaphor" comment="reel bees">flighty butterflies</mark>.</par>

<mark>'s attributes Name Values Default comment id Match the ID rules. idref Match the IDREF rules. idrefs Match the IDREFS rules. name type

specify a unique id

Possible values : Match the ID rules.

reference a certain node

Possible values : Match the IDREF rules.

references certain nodes

Possible values : Match the IDREFS rules.

define the type of the mark

give the mark a unique name

add a comment to the mark

Include binary data such as images in the document.

Though one may use external entities to include references to binary data this element may be useful to distribute a whole document as is.

Note: Binary data must be encoded either with "Base64" or "Quoted Printable".

<par>
<binary name="image.gif" encoding="base64">R0lGODlh...</binary>
</par>

<binary>'s attributes Name Values Default encoding base64, quoted_printable id Match the ID rules. idref Match the IDREF rules. idrefs Match the IDREFS rules. name offset

specify a unique id

Possible values : Match the ID rules.

reference a single node

Possible values : Match the IDREF rules.

reference a group of nodes

Possible values : Match the IDREFS rules.

give the included ressource a name

specify one of the two possible encodings

Possible values : base64, quoted_printable - Required

bind this binary to the offset'th character of the referenced node, starting with 0