wiki:schema

Schema support

The MPDL document storing and querying system supports the document schemas Archimedes, Echo and TEI(-Lite). For URI's a subset of XPointer will be supported in the near future.

The element "pb" (page break) and "s" (sentence) are supported especially: a special fast method is used to retrieve a certain page (the fragment between two "pb" elements) in a document. And all fulltext queries within documents are executed against the element "s" and result in hits which each contains the position in the document (page number and sentence number).

Archimedes

Schema

The Archimedes schema is developed by the Archimedes project and can be found here.

Example

In the following simple example the metadata part consists of 4 elements („author“, „title“, „lang“, „date“) and the text part consists of 2 pages („pb“) with 2 paragraphs („p“) which contains 3 sentences („s“).

<?xml version="1.0" encoding="UTF-8"?>
<archimedes xmlns:xlink="http://www.w3.org/1999/xlink">
  <info>
    <author>Name, Prename</author>
    <title>Title</title>
    <lang>en</lang>
    <date>1789</date>
  </info>
  <text>
    <body>
      <pb xlink:href="0001.jpg"/>
      <p>
        <s>This is the first sentence of the first paragraph.</s>
        <s>This is the second sentence of the first paragraph.</s>
        <s>This is the third sentence of the first paragraph.</s>
      </p>
      <p>
        <s>This is the first sentence of the second paragraph.</s>
        <s>This is the second sentence of the second paragraph.</s>
        <s>This is the third sentence of the second paragraph.</s>
      </p>
      <pb xlink:href="0002.jpg"/>
      <p>
        <s>This is the first sentence of the first paragraph with line <lb/>break.</s><lb/>
        <s>This is the second sentence of the first paragraph with line <lb/>break.</s><lb/>
        <s>This is the third sentence of the first paragraph with line <lb/>break.</s><lb/>
      </p>
      <p>
        <s>This is the first sentence of the second paragraph.</s>
        <s>This is the second sentence of the second paragraph.</s>
        <s>This is the third sentence of the second paragraph.</s>
      </p>
    </body>
  </text>
</archimedes>

Echo

Schema

The MPDL Echo schema is developed by the schema group of this project and can be found here.

Elements

An Echo document (element „echo“ with namespace „echo“) consists of a metadata part (element „metadata“) which contains the Dublin Core metadata of the document and a fulltext part (element „text“) which contains the content of the document.

Dublin Core metadata elements (namespace dcterms):

  • identifier
  • creator
  • title
  • date
  • rights
  • license
  • accessRights

Fulltext elements (with attributes in paranthesis):

  • text elements: head (style), div (type, level, style), p (style), pb (file), lb, cb, gap (extent), s (style)
  • figure elements: figure, image (file), caption (style), description (style), variables (style), handwritten (xlink:href)
  • note elements: note (position, xlink:label)
  • quotation elements: q (style), quote (style), blockquote (style), set-off (style)
  • translation elements: foreign (lang, xml:lang), reg (orig, style)
  • mathematical elements: var (type, style), num (style), mml:*
  • geographical elements: place, event, time
  • person elements: person
  • xhtml elements: xhtml:* : e.g. table, ul
  • other elements: expan (style), emph (class, style), ref (target), anchor (type, xlink:label, xlink:href)

Example

In the following simple example the metadata part consists of 4 Dublin Core elements („creator“, „title“, „language“, „date“) and the text part consists of 2 pages („pb“) with 2 paragraphs („p“) which contains 3 sentences („s“).

<?xml version="1.0" encoding="UTF-8"?>
<echo xmlns="http://www.mpiwg-berlin.mpg.de/ns/echo/1.0/" xmlns:dcterms="http://purl.org/dc/terms">
  <metadata>
    <dcterms:creator>Name, Prename</dcterms:creator>
    <dcterms:title>Title</dcterms:title>
    <dcterms:language>en</dcterms:language>
    <dcterms:date>1789</dcterms:date>
  </metadata>
  <text>
    <pb file="0001"/>
    <p>
      <s>This is the first sentence of the first paragraph.</s>
      <s>This is the second sentence of the first paragraph.</s>
      <s>This is the third sentence of the first paragraph.</s>
    </p>
    <p>
      <s>This is the first sentence of the second paragraph.</s>
      <s>This is the second sentence of the second paragraph.</s>
      <s>This is the third sentence of the second paragraph.</s>
    </p>
    <pb file="0002"/>
    <p>
      <s>This is the first sentence of the first paragraph with line <lb/>break.</s><lb/>
      <s>This is the second sentence of the first paragraph with line <lb/>break.</s><lb/>
      <s>This is the third sentence of the first paragraph with line <lb/>break.</s><lb/>
    </p>
    <p>
      <s>This is the first sentence of the second paragraph.</s>
      <s>This is the second sentence of the second paragraph.</s>
      <s>This is the third sentence of the second paragraph.</s>
    </p>
  </text>
</echo>

TEI

Schema

TEI provides customizations for different purposes. The MPDL project supports a subset of TEI Lite which is widely used and includes basic elements for simple documents. Also some useful elements (which are part of the TEI schema with all modules) and MathML and SVG (which are part of the TEI schema with all modules plus external additions) are supported.

A description of TEI pointers can be found here. A description of notes/annotations can be found here.

Elements

TEI Lite (with attributes in paranthesis):

  • metadata elements: fileDesc, titleStmt, author, name, title, publicationStmt, date, idno, availability, sourceDesc, bibl, profileDesc, langUsage, language
  • text elements: div, gap (extent), head, lb, lg, l, p, pb, s, seg
  • link elements: ref (target), ptr (target), anchor (xml:id)
  • figure elements: figure
  • note elements: note (place)
  • quotation elements: cit, q, quote
  • translation elements: foreign (xml:lang), reg
  • terminology elements: mentioned, term
  • name elements: name (type="place"), (type="person"), name (type="organization")
  • time elements: date
  • mathematical elements: num
  • other elements: hi (rend), expan, emph, choice, orig, abbr, sic, corr

TEI

  • text elements: pb (facs)
  • dictionary elements: entry, form, orth, sense, etym, def
  • figure elements: figure (facs)
  • name elements: placeName (type), persName
  • other elements: ex, am

Additional

  • MathML elements: all elements of MathML 2.0
  • SVG elements: all elements of SVG 1.1

Example 1

In the following simple example the metadata part ("teiHeader") consists of 5 elements („author“, „title“, „language“, „date“, "idno") and the text part consists of 2 pages („pb“) with 2 paragraphs („p“) which contains 3 sentences („s“).

<?xml version="1.0" encoding="UTF-8"?>
<TEI xmlns="http://www.tei-c.org/ns/1.0">
  <teiHeader>
    <fileDesc>
      <titleStmt>
        <title>Title</title>
        <author>Name, Prename</author>
      </titleStmt>
      <publicationStmt>
        <date>1789</date>
        <idno>/experimental/yourDirectory</idno>
        <availability status="free">
          <p>This text is available under Creative Commons license CC-BY</p>
        </availability>
      </publicationStmt>
      <sourceDesc>
        <bibl>
        </bibl>
      </sourceDesc>
    </fileDesc>
    <profileDesc>
      <langUsage>
        <language ident="en">English</language>
      </langUsage>
    </profileDesc>
  </teiHeader>
  <text>
    <body>
      <pb facs="0001.jpg"/>
      <p>
        <s>This is the first sentence of the first paragraph. And <ref target="http://slime.de">here</ref> is a link.</s>
        <s>This is the second sentence of the first paragraph.</s>
        <s>This is the third sentence of the first paragraph.</s>
      </p>
      <p>
        <s>This is the first sentence of the second paragraph.</s>
        <s>This is the second sentence of the second paragraph.</s>
        <s>This is the third sentence of the second paragraph.</s>
      </p>
      <pb facs="0002.jpg"/>
      <p>
        <s>This is the first sentence of the first paragraph with line <lb/>break.</s><lb/>
        <s>This is the second sentence of the first paragraph with line <lb/>break.</s><lb/>
        <s>This is the third sentence of the first paragraph with line <lb/>break.</s><lb/>
      </p>
      <p>
        <s>This is the first sentence of the second paragraph.</s>
        <s>This is the second sentence of the second paragraph.</s>
        <s>This is the third sentence of the second paragraph.</s>
      </p>
      <figure facs="fig-0001.jpg"></figure>
    </body>
  </text>
</TEI>

Example 2: TEI document with MathML and SVG

In the following simple example the text part consists of a MathML formula and a SVG graphics.

<?xml version="1.0" encoding="UTF-8"?>
<TEI xmlns="http://www.tei-c.org/ns/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
  <teiHeader>
    <fileDesc>
      <titleStmt>
        <title>Title</title>
        <author>Name, Prename</author>
      </titleStmt>
      <publicationStmt>
        <date>1789</date>
        <idno>/experimental/yourDirectory</idno>
        <availability status="free">
          <p>This text is available under Creative Commons license CC-BY</p>
        </availability>
      </publicationStmt>
      <sourceDesc>
        <bibl>
        </bibl>
      </sourceDesc>
    </fileDesc>
    <profileDesc>
      <langUsage>
        <language ident="en">English</language>
      </langUsage>
    </profileDesc>
  </teiHeader>
  <text>
    <body>
      <pb facs="0001.jpg"/>
      <hi rend="bold">MathML example: </hi><lb/>
      <formula>
        <math xmlns="http://www.w3.org/1998/Math/MathML">
          <mrow>
            <mi>a</mi>
            <mo>&#x2062;<!-- &InvisibleTimes; --></mo>
            <msup>
              <mi>x</mi>
              <mn>2</mn>
            </msup>
            <mo>+</mo>
            <mi>b</mi>
            <mo>&#x2062;<!-- &InvisibleTimes; --></mo>
            <mi>x</mi>
            <mo>+</mo>
            <mi>c</mi>
          </mrow>
        </math>
      </formula>
      <hi rend="bold">SVG example: </hi><lb/><lb/>
      <svg xmlns="http://www.w3.org/2000/svg" width="600" height="300" version="1.1">
        <a xlink:href="http://www.youtube.com/watch?v=yHrQ_8GWRiY" target="_blank">
          <image x="0" y="0" width="100%" height="100%" xlink:href="http://mpdl-test.mpiwg-berlin.mpg.de:30030/mpdl/images/slime_logo.png">
            <animate attributeType="CSS" attributeName="opacity" from="0" to="1" dur="5s" repeatCount="1" />
            <animate attributeName="width" attributeType="XML" begin="0s" dur="5s" fill="freeze" from="100" to="600"/>
            <animate attributeName="height" attributeType="XML" begin="0s" dur="5s" fill="freeze" from="100" to="300"/>
          </image>
        </a>
      </svg>
    </body>
  </text>
</TEI>
Last modified 6 years ago Last modified on Sep 2, 2011 11:57:00 AM