TEIWiki - User contributions [en]

Milestone-chunk.xquery

2015-06-24T09:52:34Z

Jensopetersen: modifying original script to include xml attributes and empty elements like handShift

== Authorship ==
{|
| ''Author''
| David Sewell, University of Virginia, [mailto:dsewell@virginia.edu dsewell@virginia.edu]
|-
| ''Last revised''
| 2007-05-02
|-
| ''Previous version''
| none
|}

== Summary ==
This is an XQuery 1.0 function that will return all of the content between two milestone elements such as '''pb'''
while preserving the hierarchical structure of the containing elements. For example, given content like this in a TEI document:
<pre><nowiki>
<TEI>
<text>
<body>
<div1 type="chapter" n="1"> 
<div2 xml:id="doc100">
An example<pb n="3"/>of a very short page<pb n="4"/>here.
</div2> 
</div1>
</body>
</text>
</TEI>
</nowiki></pre>

the function would produce the following XML fragment as output when asked to return content between '''pb/@n=3''' and '''pb/@n=4'''
with the '''text''' element as the ancestor:

<pre><nowiki>
<text>
<body>
<div1 type="chapter" n="1">
<div2 xml:id="doc100">
<pb n="3"/>of a very short page
</div2>
</div1>
</body>
</text>
</nowiki></pre>

In other words, the full hierarchical structure of the ancestor elements, including their attributes, is preserved, but only the nodal content between the milestons is included.

== Required Input ==

The function signature is
<pre><nowiki>
local:milestone-chunk(
$ms1 as element(),
$ms2 as element(),
$node as node()*
)
</nowiki></pre>

'''$node''' is an element known to be a common ancestor of the two milestones. For example, it could be '''TEI/text''', or '''TEI/text/body''', or even '''TEI/text/body/div1[3]''' if the milestone parameters are both descendants of that div1.

'''$ms1''' is the first milestone element; '''$ms2''' is the second milestone element.

For example, the output in "Summary" above might have been produced by the call

<pre><nowiki>
let $input := doc("mydoc.xml")/tei:TEI/tei:text
return local:milestone-chunk($input//pb[@n="3"], $input//pb[@n="4"], $input)
</nowiki></pre>

If '''$input''' had been
doc("mydoc.xml")/tei:TEI/tei:text/tei:body
then the output would have started at the '''body''' element, etc.

'''$ms1''' and '''$ms2''' do not need to be adjacent milestones. You can, for example, return content between '''pb/@n=4''' and '''pb/@n=7'''. Nor do the milestones need to be of the same type; you can return content between the '''pb''' for page 4 and an arbitrary anchor or pointer element later in the document.

== Expected Output ==

As indicated in the example in "Summary" above, the output should be a single XML element reflecting the structure of the input ancestor element and its descendants, but otherwise containing only the nodal content between the two milestone elements in the original input.

== Known Restrictions or Problems ==
The output will contain a copy of the first milestone element, but not of the second (closing) one. This is a consequence of the need to use pseudo-milestones for the second milestone in some cases; see next paragraph.

When using this function to generate content between TEI '''pb''' elements, an obvious problem is that the final page will not have a final '''pb''' milestone. In this case, use a pseudo-milestone such as the last node in the input element. For example, using the sample document in "Summary" above, the content of page 4 ("here.") would be output via the call
<pre><nowiki>
let $input := doc("mydoc.xml")/tei:TEI/tei:text
local:milestone-chunk($input//pb[@n="4"], ($input//node())[last()], $input)
</nowiki></pre>

If you use this function to recurse over all the '''pb''' elements in a document, you will need to use a strategy like this when '''$ms1''' has no following '''pb''' element.

The function will not gracefully handle invalid input, but will probably throw run-time errors. You should be sure that the parameters passed to it reflect actual milestone elements with a common ancestor.

== Code ==
<pre><nowiki>
declare function local:milestone-chunk(
$ms1 as element(),
$ms2 as element(),
$node as node()*
) as node()*
{
typeswitch ($node)
case element() return
if ($node is $ms1) then $node
else if ( some $n in $node/descendant::* satisfies ($n is $ms1 or $n is $ms2) )
then
element { name($node) }
{ for $i in ( $node/node() | $node/@* )
return local:milestone-chunk($ms1, $ms2, $i) }
else if ( $node >> $ms1 and $node << $ms2 ) then $node
else ()
case attribute() return $node (: will never match attributes outside non-returned elements :)
default return
if ( $node >> $ms1 and $node << $ms2 ) then $node
else ()
};
</nowiki></pre>

== Implementation in eXist ==
A string-based function to return fragments between two nodes is implemented in [[eXist]] (as a function called [http://exist-db.org/exist/apps/fundocs/view.html?uri=http://exist-db.org/xquery/util&location=java:org.exist.xquery.functions.util.UtilModule&details=true#get-fragment-between.4 util:get-fragment-between()]) by Josef Willenborg, Max Planck Institute for the History of Science [mailto:jwillenborg@mpiwg-berlin.mpg.de jwillenborg@mpiwg-berlin.mpg.de]:

<pre><nowiki>
util:get-fragment-between($beginning-node as node()?, $ending-node as node()?, $make-fragment as xs:boolean?) xs:string
</nowiki></pre>

Returns an xml fragment or a sequence of nodes between two elements (normally milestone elements). The $beginning-node represents the first node/milestone element, $ending-node, the second one. The third argument, $make-fragment, is a boolean value for the path completion. If it is set to true() the result sequence is wrapped into a parent element node.

Example call of the function for getting the fragment between two TEI page break element nodes:
<pre><nowiki>
let $fragment := util:get-fragment-between(//pb[1], //pb[2], true())
</nowiki></pre>

== Extended version which keeps the namespace declaration ==
A short explanation of the problem [http://sourceforge.net/mailarchive/forum.php?thread_name=CAKKtb%2Buzzd0RYJHfcvpz6z6ogUwBcbXhPDkk%2Bahq3YAaF0u_ig%40mail.gmail.com&forum_name=exist-open]
<pre><nowiki>
declare function local:milestone-chunk-ns(
$ms1 as element(),
$ms2 as element(),
$node as node()*
) as node()*
{
typeswitch ($node)
case element() return
if ($node is $ms1) then $node
else if ( some $n in $node/descendant::* satisfies ($n is $ms1 or $n is $ms2) )
then
(: element { name($node) } :)
element {QName (namespace-uri($node), name($node))}
{ for $i in ( $node/node() | $node/@* )
return local:milestone-chunk-ns($ms1, $ms2, $i) }
else if ( $node >> $ms1 and $node << $ms2 ) then $node
else ()
case attribute() return $node (: will never match attributes outside non-returned elements :)
default return
if ( $node >> $ms1 and $node << $ms2 ) then $node
else ()
};
</nowiki></pre>

== Extended version which maintains xml attributes in scope and listed preceding empty elements ==
<pre><nowiki>
xquery version "1.0";

declare namespace tei="http://www.tei-c.org/ns/1.0";

declare function local:get-common-ancestor($element as element(), $start-node as node(), $end-node as node())
as element()
{
let $element :=
($element//*[. is $start-node]/ancestor::* intersect $element//*[. is $end-node]/ancestor::*)[last()]
return
$element
};

declare function local:get-fragment(
$node as node()*,
$start-node as element(),
$end-node as element(),
$include-start-and-end-nodes as xs:boolean,
$empty-ancestor-elements-to-include as xs:string+
) as node()*
{
typeswitch ($node)
case element() return
if ($node is $start-node or $node is $end-node)
then
if ($include-start-and-end-nodes)
then $node
else ()
else
if (some $node in $node/descendant::* satisfies ($node is $start-node or $node is $end-node))
then
element {node-name($node)}
{
(:the xml attributes that govern their descendants are carried over to the fragment;
if the fragment has several layers before it reaches text nodes, this information is duplicated, but this does no harm:)
if ($node/@xml:base)
then attribute{'xml:base'}{$node/@xml:base}
else
if ($node/ancestor::*/@xml:base)
then attribute{'xml:base'}{$node/ancestor::*/@xml:base[1]}
else (),
if ($node/@xml:space)
then attribute{'xml:space'}{$node/@xml:space}
else
if ($node/ancestor::*/@xml:space)
then attribute{'xml:space'}{$node/ancestor::*/@xml:space[1]}
else (),
if ($node/@xml:lang)
then attribute{'xml:lang'}{$node/@xml:lang}
else
if ($node/ancestor::*/@xml:lang)
then attribute{'xml:lang'}{$node/ancestor::*/@xml:lang[1]}
else ()
,
(:carry over the nearest of preceding empty elements that have significance for the fragment; though amy element could be included here, the idea is to allow empty elements such as handShift to be carried over:)
for $empty-ancestor-element-to-include in $empty-ancestor-elements-to-include
return
$node/preceding::*[local-name(.) = $empty-ancestor-element-to-include][1]
,
(:recurse:)
for $node in $node/node()
return local:get-fragment($node, $start-node, $end-node, $include-start-and-end-nodes, $empty-ancestor-elements-to-include) }
else
(:if an element follows the start-node or precedes the end-note, carry it over:)
if ($node >> $start-node and $node << $end-node)
then $node
else ()
default return
(:if a text, comment or PI node follows the start-node or precedes the end-node, carry it over:)
if ($node >> $start-node and $node << $end-node)
then $node
else ()
};

declare function local:get-fragment-from-doc(
$node as node()*,
$start-node as element(),
$end-node as element(),
$wrap-in-first-common-ancestor-only as xs:boolean,
$include-start-and-end-nodes as xs:boolean,
$empty-ancestor-elements-to-include as xs:string+
) as node()*
{
if ($node instance of element())
then
let $node :=
if ($wrap-in-first-common-ancestor-only)
then local:get-common-ancestor($node, $start-node, $end-node)
else $node
return
local:get-fragment($node, $start-node, $end-node, $include-start-and-end-nodes, $empty-ancestor-elements-to-include)
else
if ($node instance of document-node())
then local:get-fragment-from-doc($node/element(), $start-node, $end-node, $wrap-in-first-common-ancestor-only, $include-start-and-end-nodes, $empty-ancestor-elements-to-include)
else ()

};

let $input := doc('/db/eebo/A00283.xml')

return
local:get-fragment-from-doc($input, $input//tei:pb[@n="7"], $input//tei:pb[@n="8"], true(), true(), ('handShift'))
</nowiki></pre>

[[Category:XQuery]]

Milestone-chunk.xquery

2015-06-23T10:33:09Z

Jensopetersen: /* Implementation in eXist */

Milestone-chunk.xquery

2015-06-23T10:29:55Z

Jensopetersen: /* Implementation in eXist */ The string-based nature of the eXist function must be made clear. It is not an implementation of milestone-chunk.xquery.

Critical Apparatus Workgroup

2014-12-11T13:43:12Z

Jensopetersen: /* “Critical Apparatus” vs. “Textual Variance” vs. “Textual Variants” */ added plural -s

The [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/TC.html Critical Apparatus] workgroup is part of the TEI special interest group on manuscript [[SIG:MSS]].

Participants to the preliminary workgroup:

* Marjorie Burghart (MB)
* James Cummings (JC)
* Fotis Jannidis (FJ)
* Gregor Middell (GM)
* Dan O'Donnell (DOD)
* Matija Ogrin (MO)
* Espen Ore (EO)
* Elena Pierazzo (EP)
* Roberto Rosselli del Turco (RDT)
* Chris Wittern (CW)

Comments below from others:
* Pascale Sutter (PS)
* [[User:Stuartyeates|Stuart Yeates]] (SAY)

== “Critical Apparatus” vs. “Textual Variance” vs. “Textual Variants”==

The very name of the chapter, "Critical apparatus", is felt by some to be be a problem: the '''critical apparatus''' is just inherited from the printed world and one of the possible physical embodiments of '''textual variance'''. EP therefore proposes to use this new name, moving from "critical apparatus" to textual variance.

MB argues that, oddly, "textual variance" feels more restrictive to her than "critical apparatus": it is a notion linked with Cerquiglini's work, which does not correspond to '''every''' branch of textual criticism. On the other hand, strictly speaking, the "critical apparatus" is not limited to registering the variants of the several witnesses of a text. It also includes various kinds of notes (identification of the sources of the text, historical notes, etc.). Even texts with a single witness may have a critical apparatus. Maybe the problem with the name has its origins in the choice of giving the name "critical apparatus" to a part of the guidelines dedicated solely to the registration of textual variants.

FJ argues that for German ears the concept of textual variance is not closely connected to a specific scholar.

MB proposes to use '''textual variants''' instead, since it focuses more on actual elements in the edition, when "variance" is nothing concrete but a phenomenon.

Side remarks by MB: this vocabulary question might prove sticky in the end. The <app> elements is named <app> because it is considered "an apparatus entry", so unless we end up recommending to change the elements names, the phrase "critical apparatus" will still be used in the module, at least to explain the tag names?

RDT argues that while backward compatibility is clearly a bonus, as MB states <app> stands for 'apparatus entry': we shouldn't be afraid to change its function, for instance making it a container instead of a phrase level element. RDT stresses that he is proposing this by way of example, and to stress that our focus is on variants: these might then be organised in <app>s for traditional CA display, and/or in other, new ways for electronic display. Note that this might mean no traditional critical apparatus in a digital edition.

MB: It is characteristic of a print-based approach to encoding that the <app> element was considered as encoding an apparatus entry (hence the <app> name), when what it really encodes is a locus where different witnesses have variant readings (whch would probably have justified a name along the lines of <locus> or whatnot).

JC: Thinks this points to a slight divergent nature at the heart of the current critical apparatus recommendations. That of encoding an apparatus at the site of textual variance and encoding a structured view of a note entirely separate from the edited version of texts. (In mass digitization of critical editions, for example, one might have an <app> in a set of notes at the bottom of the page which are not encoded at the site of variance, or indeed necessarily connected with it.) It is this striving to both be able to encode all sorts of various legacy forms of apparatus as well as simultaneously catering for those who are recording the structure by which they will generate an apparatus in producing some output. So JC would argue that the first of these are apparatus and the second of these is a site/locus of textual variance.

SAY: Prefers either '''textual variants''' or '''textual variance''' over '''Critical Apparatus''' simply because I believe their meaning is clearer to a larger proportion of English speaking people. Clear meanings help us inter-operate with other groups and standards by making our standard easier to read by third parties.

MO: argues that we should retain '''Critical Apparatus''' because it is a core philological term. In every branch of the Humanities, the terminology is among those core elements that are most resistant to changes, because old terms are deeply rooted in the practice and in the epistemological system of the disciplines. The most common way how terminology is changed in the Humanities is that old terms gradually accept new layers of meaning -- new semantics. Let us think, e.g., of 'digital edition'. The term 'edition' absorbed new meanings, and continues to be a good, functional term. This applies also to the dilemma of 'Critical Apparatus' vs. 'Textual Variants'. In the TEI community, we should also use the same fundamental terminology as is used in other, more traditional areas of philology, and show the advantage of our conception of the same term.

== Issues ==

Preliminary notice: most of the issues raised here are connected with the parallel segmentation method, not because it is the more flawed, but because it is the more used by the members of this group. While location-referenced and double-end-point-attachment might be useful for mass conversion of printed material (for the former) and/or when using a piece of software handling the encoding (for the latter), the parallel segmentation method seems to be the easiest and more powerful way to encode the critical apparatus "by hand".

Also, one might point out that most of the issues raised here might be solved with standoff encoding. But this is extremely cumbersome to handle without the aid of a software, and it does not correspond to the way most people work.

=== Specific phenomena ===

==== Transpositions ====

In a nutshell: with the parallel segmentation method, it is often cumbersome to render transpositions.

Additionally it is not possible to mark them up explicitly. [http://juxtasoftware.org/ Juxta] for example works around that by storing transposition data in a custom XML format:

<pre>
<moves>
<move doc1="1855 MS" space1="original" start1="9679" end1="10462" doc2="1881 1st Ed." space2="original" start2="9872" end2="10467" />
<move doc1="1855 MS" space1="original" start1="9679" end1="10483" doc2="1870 2nd Ed." space2="original" start2="7781" end2="8376" />
<move doc1="1855 MS" space1="original" start1="9679" end1="10504" doc2="1870 Proof" space2="original" start2="8458" end2="9056" />
<move doc1="1855 MS" space1="original" start1="9886" end1="10525" doc2="1870 1st Ed." space2="original" start2="8546" end2="9141" />
<move doc1="1870 Proof" space1="original" start1="1640" end1="1850" doc2="1881 1st Ed." space2="original" start2="2961" end2="3070" />
</moves>
</pre>

Neither is this TEI-compliant, nor is the offset/range-based addressing (@start1/@start2 and @end1/@end2) proper XML markup. A standardized encoding would be helpful.

See also:

* http://tei.markmail.org/thread/fuszgtpnn2ywf6bh

==== Handling of punctuation ====

Seems to be a common problem in textual criticism/ apparatus creation, but lacks guidelines/ encoding examples:

* http://tei.markmail.org/thread/es6byhxpsbgkrxzo

==== Representing omissions in an apparatus ====

What's the proper way to represent missing lines/ paragraphs/ verses?

* http://tei.markmail.org/thread/parztmwmlx5mqsof
* http://tei.markmail.org/thread/4sheu6nji3dvnf64

=== Markup-related ===

==== Inclusion of structural markup in the apparatus ====

In a nutshell: the <app> element is phrase-level, when it really should be allowed to include paragraphs, and even <div>s.

Use case:

<blockquote style="background:#FFEAEA">I'm encoding a 19th c. edition of a medieval text, and one of the witness has omissions of several paragraphs. Of course, the TEI schema
won't let me put elements inside an <app>/<lem> element... 

- I use the parallel segmentation method 
- It is important to me to keep a methodical link between the encoded
apparatus and the notes numbers in the original edition (the
@n of each <app> tag bears the number of the footnote in the original
edition) 

Here is the [http://baluze.univ-avignon.fr/scan/t1/%285%29.jpg scan of a page from this edition], please consider footnote number 9.
The note contains: "9. Eodem anno, rex Francie… dampnificati, paragraphes omis par Bal.", meaning that the ''Bal.'' witness has an omission where other witnesses have two long paragraphs, the first one beginning on the previous page (see the [http://baluze.univ-avignon.fr/scan/t1/%284%29.jpg previous page scanned]).
</blockquote>

* http://tei.markmail.org/thread/tbzi2yj5xd4dto34

Another use case:

We have several witnesses of a poem, and in our base text, we have 8 stanzas, in another version only 6 stanzas and in some other 7? We are not allowed to have an <lg> and not even an <l> element within the <app> entry. So, we must put it the other way round, which may be somewhat awkward, like this:

<l>
<app>
<rdg wit="#A"> [the text of the verse line here] </rdg>
<rdg wit="#B"/>
<rdg wit="#C"/>
</app>
</l>

We should then repeat this for every <l> , while it would be more practical to "say" this only once for entire stanza (with an <lg> within a <rdg> ).

* Source: http://marjorie.burghart.online.fr/?q=en/content/tei-critical-apparatus-cheatsheet#comment-15

More use cases from TEI-L:

* http://tei.markmail.org/thread/jyezaqfycaldtdcv
* http://tei.markmail.org/thread/fbyuxyabbxq4rwbr
* http://tei.markmail.org/thread/vrwkl7kkruulyjzh
* http://tei.markmail.org/thread/x5agpwzn4hiwwwcx

==== Encoding variants in structural markup ====

* http://tei.markmail.org/thread/ap62n37uf6rbfds4
* http://tei.markmail.org/thread/hbmnsn3v4aqjabt3

==== Conflicts between individual readings and the semantics of structural markup that surrounds it ====

In a nutshell: with the parallel segmentation method, witnesses with different forms of lineation pose a problem.

=== Workflow-related ===

==== Scalability ====

In a nutshell: the parallel segmentation method is difficult to handle when adding hundreds of conflicting witnesses.

<blockquote style="background:#FFEAEA">
Scaling is generally a problem with methods of indicating textual variance, but in parallel segmentation this is exacerbated because as the number of witnesses increase, the likelihood of needing to reformulate the reading boundaries, never mind the difficulty in reading or understanding such encodings. This may be a problem not only when looking at a single text with many witnesses, where variation in structure may be extremely difficult to represent where conflicts occur which disrupt this very basic structure (for example, imagine a set of witnesses where some have lines in linegroups, some just lines, some paragraphs, some paragraphs in divisions, but all with the same underlying text). But also where parallel segmentation is being used to record divergent interpretations of these individual witnesses by many editors (for distributed co-operative editions generated from many editorial views of a text). A plausible recommendation is to use a form of stand-off apparatus for such editions rather than parallel segmentation. And while some of the current methods can be used in a stand-off method, they should be updated to reflect current P5 usage of URI-based pointers.
</blockquote>

==== Refactoring ====

In a nutshell: with the the parallel segmentation method, it is cumbersome to add a new reading that necessitates changing where the borders of readings are drawn.

==== Complexity ====

Manually crafting an apparatus is error-prone:

* http://tei.markmail.org/thread/yuxqotf5aynxznq5

==== Feasibility of double-endpoint-attached method ====

* http://tei.markmail.org/thread/fsj7gvojds4mwcm5
* http://tei.markmail.org/thread/flwcnf4fxm4u7ebj

=== Model vs. Representation ===

==== Showing a lemma different from the content of the <lem> or chosen reading in an apparatus note ====

In a nutshell: depending on the desired output of your digital edition, you may need to show in the apparatus entry a lemma text different from the content of the <lem> or desired <rdg>. This is typically the case for long omissions, when one does not display the full text that is omitted by one or more witnesses, but only the beginning and end of the omitted span of text.

Use case:
<blockquote style="background:#FFEAEA">Let's consider again the example used in a previous use case:
Here is the [http://baluze.univ-avignon.fr/scan/t1/%285%29.jpg scan of a page from this edition], please consider footnote number 9.
The note contains: "9. Eodem anno, rex Francie… dampnificati, paragraphes omis par Bal.", meaning that the ''Bal.'' witness has an omission where other witnesses have two long paragraphs, the first one beginning on the previous page (see the [http://baluze.univ-avignon.fr/scan/t1/%284%29.jpg previous page scanned]).
 
You certainly do not want to generate a footnote with these two full paragraphs to tell the reader that one witness omits them, but on the other hand you want to be able to represent the source according to its various witnesses, so location-referenced is not in order.
</blockquote>

Possible workaround: add a new possible child to <add>, indicating how the content of the <lem> should be dislayed; something like:

<app>
<lemDisplay>Eodem anno, rex Francie… dampnificati</lemDisplay>
<lem>[several lines or paragraphs]</lem>
<rdg wit="#V"></rdg>
</app>

==== Representing "verbose" apparatus ====

In a nutshell: when you want to represent an apparatus entry written in a rather verbose way (in a print-to-digital edition). The same is true if you want to be able to generate a verbose apparatus note in a "born digital" edition.

Use cases:
<blockquote style="background:#FFEAEA">You're encoding an existing edition, and want to represent the source it edits, while keeping intact the text / apparatus of the existing edition. Some apparatus entries are easy to represent with the <app> / <lem> / <rdg> elements, some others add editorial comments to the listing of the variants, and are quite difficult to represent. BTW, the same goes when you are encoding a born-digital edition for which you want to be able to generate an alternative print output corresponding to the traditional standards of a collection.
 
A - When I have a footnote giving two lectiones from the same manuscript, one before correction and the other after: 
Text: ad lectorem Venetum (b) .
 
Note: b) ms., lectionem venerum corrigé postérieurement en lectorem Venetum
 
 
If I encode it like this, with two separate rdg for the same
witness, each with a different @type (for instance, "anteCorr" and
"postCorr"), it gives an accurate account of the state of the witness, BUT it is an
interpretation of the original note in the critical apparatus, i.e. if
I do this I delete some text added by the original editor. 

<app n="b">
 
<lem>lectorem Venetum</lem>
 
<rdg wit="#ms.2" type="anteCorr">lectionem venerum</rdg>
 
<rdg wit="#ms.2" type="postCorr">lectorem Venetum</rdg>

 
</app>
</blockquote>

 

<blockquote style="background:#FFEAEA">
Let's consider this other note. There is some text added verbosely within the apparatus note by the editor. 
Text: Hiis diebus civitas
Pergamensis(b) tenebat exersitum 
Note: b) se, mis indûment avant tenebat par le ms.

Should I encode it as: 
... Pergamensis <app
n="b"> 
    <lem/> 
    <rdg
type="addition" wit="#ms"><sic>se</sic></rdg> 
</app>... 


If one represents this note strictly with the <app> / <rdg>, it leads to the suppression of remarks by the original editor. Adding a note in the rdg to preserve the editor's comments could work here, but it's not always the case 
Like: 
... Pergamensis <app
n="b"> 
    <lem/> 
    <rdg
type="addition" wit="#ms"><sic>se</sic> <note><hi
rend="italics">mis
indûment avant</hi> tenebat.</note></rdg> 

</app>
</blockquote>

 

<blockquote style="background:#FFEAEA">
'''Text''': …reliqui demum meos socios (d) 
'''Note''': d) domum
meam solito, Bal.; dni ou dm, ms.; en note meam solita.

Here we have 2 witnesses (Bal. et ms.), the latter with a) an uncertain
lectio ("dni" or "dm") and b) a part of the lectio which is written as
a note ("meam solita"). This is tricky to encode.
</blockquote>

See also:

* http://tei.markmail.org/thread/ib3bsrpirepp4ibc
* http://tei.markmail.org/thread/diubpw5adw6ntcas

==== Representation of suggestions by the editor: ''lege'' ''dele'' etc. ====

In a nutshell: Sometimes, the editor provides working suggestions through apparatus notes such as ''lege(ndum)'' ("read"), ''dele(ndum)'' ("delete)" etc. They do not belong in the textual variants ''per se'', and are not attached to witnesses, although they do belong in the critical apparatus.

* http://tei.markmail.org/thread/vfw25psb5vgdiftw

==== Collations of differing granularity ====

* http://tei.markmail.org/thread/bonflsyb2d3ebtp2
* http://tei.markmail.org/thread/gqyymzd4a4xvhch7

== An encoding proposal from the perspective of computer-aided collation tools ==

Gregor Middell gave an overview of textual variance from a software developer's perspective for the workgroup on a [[Textual_Variance|separate page]]. The models described there are used in tools like [http://collatex.sourceforge.net/ CollateX], [http://www.juxtasoftware.org/ Juxta] and [http://code.google.com/p/multiversiondocs/ nmerge].

Collecting ideas from the mailinglist by James Cummings, Dan O'Donnell and Marjorie Burghart as well as following the [[Textual_Variance|“Gothenburg model” of textual variance]], a first take at separating the [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller model from the representation] of textual variance could be structured as follows.

=== Modelling input data: Make the units of a collation addressable in the witnesses ===

The Gothenburg model assumes a [[Textual_Variance#Tokenizer|preprocessing step]] by which the witnesses get split up into '''tokens''' of desired granularity. This granularity becomes the minimal unit of collation and can defined as pages, paragraphs, verses, lines, words, characters or any other unit that makes sense in the context of a particular tradition under investigation. To model collation results on top of tokenized witnesses, those tokens have to be addressable.

The TEI defines an [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html#SAXP array of pointing mechanisms], which can be used to address anything from a whole XML document via URIs down to arbitrary content of those documents via sophisticated XPointer schemes. Projects would be free to choose among those mechanisms as long as each token is made available for later reference.

Examples:

<pre>

<w>The</w> <w>cat</w> <w>ate</w> <w>the</w> <w>food</w> <w>quickly</w>.

</pre>

<pre>

<w>Quickly</w>, <w>the</w> <w>cat</w> <w>ate</w> <w>the</w> <w>food</w>.

</pre>

Here tokens on the word-level could be addressed via the [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html#SATSXP xpath1() XPointer scheme]:

# <nowiki>http://edition.org/witness_1#xpath1(/p[1]/w[1])</nowiki>
# <nowiki>http://edition.org/witness_1#xpath1(/p[1]/w[2])</nowiki>
# ...

A less verbose scheme would rely on each container element of a token being identified via a (possibly autogenerated) <code>xml:id</code> attribute, like in the following verse-level tokenization.

<pre>
<lg xml:base="urn:goethe:faust2">
<l xml:id="l_1">Die Sonne sinkt, die letzten Schiffe</l>
<l xml:id="l_2">Sie ziehen munter hafenein.</l>
<l xml:id="l_3">Ein großer Kahn ist im Begriffe</l>
<l xml:id="l_4">Auf dem Canale hier zu sein.</l>
</lg>
</pre>

# <nowiki>urn:goethe:faust2#l_1</nowiki>
# <nowiki>urn:goethe:faust2#l_2</nowiki>
# ...

One can even think of reference schemes, which are as independent of existing markup as possible. By introducing <anchor/> milestone elements at token boundaries and using the [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html#SATSRN range() XPointer scheme] the tokenization of arbitrary TEI documents can be accomplished, because <anchor/> is part of [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-model.global.html model.global].

=== Modelling collated data: Encode the alignment/linking between tokens ===

After tokens in the different witnesses have been made addressable, collation data can be modelled on top of that as [[Textual_Variance#Aligner|alignments of tokens]]. An '''alignment''' can be expressed as a set of tokens from different witnesses or, in accordance with the [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html corresponding guidelines chapter] as a link between two or more tokens.

Taking the first example from above, a collation of the two given witnesses could be expressed as

<pre>
<linkGrp type="collation" xml:base="http://edition.org/">
<link target="witness_1#xpath1(/p[1]/w[1]) witness_2#xpath1(/p[1]/w[2])" />
<link target="witness_1#xpath1(/p[1]/w[2]) witness_2#xpath1(/p[1]/w[3])" />
<link target="witness_1#xpath1(/p[1]/w[3]) witness_2#xpath1(/p[1]/w[4])" />
<link target="witness_1#xpath1(/p[1]/w[4]) witness_2#xpath1(/p[1]/w[5])" />
<link target="witness_1#xpath1(/p[1]/w[5]) witness_2#xpath1(/p[1]/w[6])" />
<link target="witness_1#xpath1(/p[1]/w[6]) witness_2#xpath1(/p[1]/w[1])" type="transposition" />
</linkGrp>
</pre>

Each link in this example corresponds to a row in an alignment table as depicted in the Gothenburg model description. Omitted/ added tokens are expressed implictly by not linking to tokens in other witnesses, this is to say: Whether a set of tokens has been added to a witness or has been omitted from it, is a matter of interpreting collation data as expressed above from the perspective of one witness or another and with regard to the way, this witness aligns with others.

One advantage of encoding collation data in such a set-oriented way is its '''scalability''':

# Gradually adding witnesses to the collation may amount to adding alignments to the existing ones or modifying/augmenting the latter, depending on whether the collation is done pairwise (e. g. in relation to a base text) or via multiple alignment (e. g. without a prechosen base).
# Guiding a collation tool in producing ever more precise aligments in consecutive runs can be achieved by [[Textual_Variance#Analyzer|declaring alignments]] (for example transpositions), feeding those into the collator, adjusting the resulting alignment set, feeding it back into the collator for another run and so forth. Being able to encode the initial/preliminary results of such an iterative process in a standardized way, makes it possible to run different collation tools on the same text tradition, ideally each being able to make use of former results by other tools and to contribute to the overall result.

The major disadvantage of encoding collation data this way is its apparant lack of human readability and that it is hardly possible to edit it by hand, especially when the collated text tradition grows larger. This problem can only be solved via tool support.

=== Encoding the interpretation/ representation: Derive an apparatus from the collation ===

A TEI-encoded critical apparatus is one possible rendition of collation data, possibly enhanced with information yielded from interpreting the alignments. There are a couple of ways how we could encode the above collation as an apparatus.

==== Apparatus pointing to the collated tokens (for easier post-processing) ====

<pre>
<app>
<rdg wit="http://edition.org/witness_1" xml:base="http://edition.org/witness_1" />
<rdg wit="http://edition.org/witness_2" xml:base="http://edition.org/witness_2" xml:id="w2_1">
<ptr target="#xpath1(/p[1]/w[1])" />
</rdg>
</app>
<app>
<rdg wit="http://edition.org/witness_1" xml:base="http://edition.org/witness_1">
<ptr target="#xpath1(/p[1]/w[1])" />
<ptr target="#xpath1(/p[1]/w[2])" />
<ptr target="#xpath1(/p[1]/w[3])" />
<ptr target="#xpath1(/p[1]/w[4])" />
<ptr target="#xpath1(/p[1]/w[5])" />
</rdg>
<rdg wit="http://edition.org/witness_2" xml:base="http://edition.org/witness_2">
<ptr target="#xpath1(/p[1]/w[2])" />
<ptr target="#xpath1(/p[1]/w[3])" />
<ptr target="#xpath1(/p[1]/w[4])" />
<ptr target="#xpath1(/p[1]/w[5])" />
<ptr target="#xpath1(/p[1]/w[6])" />
</rdg>
</app>
<app>
<rdg wit="http://edition.org/witness_1" xml:base="http://edition.org/witness_1" corresp="#w2_1">
<ptr target="#xpath1(/p[1]/w[6])" />
</rdg>
<rdg wit="http://edition.org/witness_2" xml:base="http://edition.org/witness_2" />
</app>
</pre>

==== Apparatus with embedded textual content (for readability) ====

<pre>
<app>
<rdg wit="http://edition.org/witness_1" />
<rdg wit="http://edition.org/witness_2" xml:id="w2_1">Quickly,</rdg>
</app>
<app>
<rdg wit="http://edition.org/witness_1">The cat ate the food</rdg>
<rdg wit="http://edition.org/witness_2">the cat ate the food.</rdg>
</app>
<app>
<rdg wit="http://edition.org/witness_1" corresp="#w2_1">quickly.</rdg>
<rdg wit="http://edition.org/witness_2" />
</app>
</pre>

Some problems here:

* @corresp vs. <link/> for transpositions over more than two witnesses
* How to derive the segment content from the original witness automatically, if the token content does not add up to it (e. g. because of punctuation being excluded from the tokens from the start)?

== Bibliography ==

* O'Donnell, Daniel Paul. [http://etjanst.hb.se/bhs/ith/1-8/dpo.pdf “The Ghost in the Machine: Revisiting an Old Model for the Dynamic Generation of Digital Editions.”] HumanIT 8.1 (2005): 5171.
* Vetter, L. and McDonald, J. ‘Witnessing Dickinson’s Witnesses’, Literary and Linguistic Computing, 18.2: 2003, 151-165.
* [http://eprints.qut.edu.au/38436/ Schmidt, D., 2010. The inadequacy of embedded markup for cultural heritage texts. Literary and Linguistic Computing, 25(3), pp. 337-356.]

[[Category:SIG:Manuscripts]]
[[Category:Critical Apparatus]]

XML Whitespace

2014-08-07T20:48:32Z

Jensopetersen: presenting a way to normalize whitespace "in the TEI fashion" with XQuery

TEI has robust features for specifying space, gaps, line breaks, and related aspects of the space between text. But TEI is an XML vocabulary, and XML itself, and programs that read and process XML files, have their own ways to deal with what they call whitespace, that is, space, tab, carriage return and linefeed characters. Sometimes the standards, constraints, and conventions imposed by XML cause problems for TEI encodings and for programs that process TEI files.

This article explains interactions between TEI and XML's treatment of whitespace and concludes with recommendations for both producers of TEI encodings and authors of programs that process TEI encodings.

==Where XML Considers Whitespace to be Significant==

In XML documents, some whitespace is significant, some is not. For example, inside the brackets that mark XML elements extra whitespace is not significant. For any program processing these as pieces of XML,

<tt><title type="main"></tt>

and

<tt><title     type = "main" ></tt>

are the same. There is no significance to the extra space. By XML rules, no application that processes the data in this XML file (processing it as XML and not just as text) is allowed to treat these two representations differently. A person or computer editing this file is free to use either one, based merely on readability and aesthetics. The fact that there is whitespace between <tt>title</tt> and <tt>type</tt> is significant, but how much or of what kind (space characters, tabs, carriage returns, new lines) is not significant. The space between <tt>type</tt> and <tt>=</tt> is not significant.

Whitespace can be significant, however, in the content of an element. For example,

<tt><name>JoAnn</name></tt>

and

<tt><name>Jo Ann</name></tt>

are different because of that space between <tt>Jo</tt> and <tt>Ann</tt>, and any program reading this element in an XML file is obliged to maintain the distinction.

But things can get complicated. Consider this:

<persName> 
 <forename>Jo</forename>
 <forename>Ann</forename>
 <surname>Henry</forename>
</persName>

Should the carriage returns and new lines matter? Should it matter if that
open area before <tt><surname></tt> is a tab or is instead four space characters? Should it matter that there is extra space after <tt><persName></tt>?

== Normalize = Collapse + Trim ==

Many applications, including web browsers and many programs that read XML files will, unless instructed otherwise, “collapse” XML whitespace, that is, they will replace any contiguous string of space characters (0x20), tabs (0x09), carriage returns (0x0D) and line feeds (0x0A) with just one space character. So

<name>Jo Ann</name>

<name>Jo Ann</name>

<name>Jo
 Ann</name>

would all be treated as if there were just one space character between <tt>Jo</tt> and <tt>Ann</tt>. Moreover many applications will remove, or “trim”, leading and trailing XML whitespace. So these, too,

<name> Jo Ann</name >

<name>
 Jo Ann</name>

<name>
 Jo 
 Ann
</name>

would be treated as if the XML had been simply <tt><name>Jo Ann</name></tt>.

Sometimes, as in the XSLT function “normalize-space()”, the term “normalize” refers to the combination of collapsing XML whitespace and then trimming. Other times, as in XML Schema, “collapse” is the name of the combined operation. This article uses the XSLT terminology: normalizing is collapsing plus trimming.

Normalizing XML whitespace is very common. It is so pervasive that it is easy to overlook that it is happening and even difficult to know which program processing an XML file is doing the normalizing—is it the XSLT processor, the XSL program, the web browser, the print routine, or some combination?

== @xml:space ==

[http://www.w3.org/TR/REC-xml/#sec-white-space The XML specification] defines an attribute, <tt>xml:space</tt>, that when set to <tt>preserve</tt> instructs applications to suspend default trimming, collapsing, and normalizing and instead keep all the spaces, tabs, carriage returns, and line feeds just as they are. If <tt>xml:space</tt> is set to default or is simply left off, no such request is made; the application is free to do whatever its developer thinks best.

The attribute <tt>xml:space</tt> is inherited by child elements. One could, for example, put <tt>xml:space="preserve"</tt> into a TEI <tt><text></tt> element but not in <tt><teiHeader></tt>, to indicate that the request applies to all of the text but to none of the header.

TEI allows <tt>xml:space</tt> to be used [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-att.global.html on any element]. But since TEI has so much rich functionality for encoding spaces, gaps, line breaks, and so on, the <tt>xml:space</tt> attribute is rarely used. Whatever could be accomplished by setting its value to <tt>preserve</tt> would be better accomplished by using native TEI elements. So the value is normally left as <tt>default</tt> by simply not including the attribute. Downstream processors are then left free to treat XML whitespace however the application developers want.

== Default Whitespace Processing ==
When <tt>xml:space</tt> is left as <tt>default</tt>, '''nothing in XML or TEI specifies how consumers of a TEI XML file should treat whitespace.'''

There are, however, unspecified conventions. TEI encodings generally assume that space will be normalized, that in this encoding

 
 We hold these truths to be self-evident, that all men are 
 are created equal, that they are endowed by their creator 
 with certain inalienable Rights, that among these are Life, 
 Liberty and the pursuit of Happiness.


some downstream processor will collapse spaces, tabs, carriage returns, and line feeds and will trim the space just after the <tt></tt> and just before the <tt></tt>, and that in this encoding, [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-persName.html from the TEI 5 Guidelines],

<persName>
 <forename>Edward</forename>
 <forename>George</forename>
 <surname type="linked">Bulwer-Lytton</surname>, <roleName>Baron Lytton of
 <placeName>Knebworth</placeName>
 </roleName>
</persName>

the man's name is <tt>Edward George Bulwer-Lytton, Baron Lytton of Knebworth</tt>, and not <tt> Edward George Bulwer-Lytton, Baron Lytton of Knebworth </tt> with space on the outsides, or <tt>EdwardGeorgeBulwer-Lytton,BaronLyttonofKnebworth</tt>, or some name with carriage returns in it.

=== Collapsing ===

A TEI encoder should assume that any string of whitespace characters will be collapsed into one space character. In theory, this can be circumvented by setting <tt>xml:space='preserve'</tt>, but not all downstream processors honor such requests. Web browsers, for example, do not. It is safer to use TEI's <tt><space></tt> element.

Programmers of downstream applications should feel free to collapse whitespace but should also honor <tt>xml:space='preserve'</tt> unless they can be certain that doing so is unnecessary.

=== Trimming ===

Whether text in an element should or will be trimmed depends on whether it is the only text in the element or it has siblings that are themselves elements.

==== Text-Only Elements ====

Even when specifications may be unclear on the matter, XML culture, conventions, product features, programming habits, and general best practices are allied not only to collapse but to trim whitespace from elements that contain only text. Encoders and consumers of TEI data should accept this. Unless <tt>@xml:space</tt> has been set to <tt>'preserve'</tt>, consumers of TEI files should trim such space and encoders should assume such space will be trimmed.

When this is done, these encodings

<country>Australia</country>

<country> Australia </country>

<country>
 Australia 
<country>

will all produce the same result. If the processing software were extracting data for use in a database, the resulting field would be <tt>country: Australia    </tt> in all three cases. If an encoder wants leading and trailing space to be preserved, if, for example,

<tt><emph rend='underline'> Yes! <emph></tt>

is meant to underline the space before and after the word, then <tt>xml:space='preserve'</tt> must be included in the <tt><emph></tt> element '''and''' it must be ensured that downstream processors actually honor <tt>xml:space='preserve'</tt>. If the underlining is meant to extend for not one but several spaces, only heroic care by encoder and consumer will ensure that it does. Use of <tt><space rend='underline'></tt> will be more reliable.

With both collapsing and trimming—that is, with normalizing—all of the following encodings would yield the same result.

<name>Ralph Waldo Emerson</name>

<name> Ralph Waldo Emerson </name>

<name>
 Ralph 
 Waldo 
 Emerson 
<name>

==== Mixed-Content Elements ====

If an element contains not just text, but other elements, where and when space should be trimmed is more complicated. Consider the following encoding.

  The <emph> cat </emph> ate  the <foreign>grande croissant</foreign>. I didn't!
 

The <tt></tt> element contains five child nodes.
{| class="wikitable"
|-
| <tt>      </tt><tt>  The </tt>
|| A text node
|-
| <tt>            </tt><tt><emph> cat </emph></tt>
|| An <tt><emph></tt> element that itself contains one text node
|-
| <tt>                              </tt><tt> ate  the </tt>
|| A text node
|-
| <tt>                                        </tt><tt><foreign>grande croissant</foreign></tt>
|| A <tt><foreign></tt> element that itself contains one text node
|-
| <tt>                                                                           . I didn't!      </tt>
|| A text node that includes a carriage return and then two spaces
|-
|}

By convention, it is presumed that this encodes a passage that could have been equivalently encoded one of these ways:

The 
<emph>cat</emph>
ate the 
<foreign>croissant</foreign>. 
I didn't!

The <emph>cat</emph> ate the <foreign>grande croissant</foreign>. I didn't!

The algorithm to normalize space in mixed content is:
* Collapse all white space, then
* trim:
** trim leading space on the first text node in an element and
** trim trailing space on the last text node in an element,
** trim both if a text node is both first and last, i.e., is the only text node in the element.

Applying that algorithm to the above passage:
{| class="wikitable"
|-
| <tt>      </tt><tt>  The </tt> 
<tt>        </tt><tt>The </tt>
|| Because this is the first node in the element, leading space is trimmed and trailing space is collapsed but not trimmed.
|-
| <tt>            </tt><tt><emph> cat </emph></tt> 
<tt>                   cat      </tt>
|| Because the only thing inside the <emph> element is a text node, the text there gets collapsed and trimmed.
|-
| <tt>                               </tt><tt> ate  the </tt> 
<tt>                               </tt><tt> ate the </tt>
|| Space is collapsed but not trimmed on either side.
|-
| <tt>                                        <foreign>grande croissant</foreign></tt> 
<tt>                                                 grande croissant</tt>

|| Space in this text-only node is collapsed and trimmed, but no change results.
|-
| <tt>                                                                         . I didn't!</tt> <tt>     </tt> 
<tt>                                                                         . I didn't!</tt>
|| Because this is the last node in the element, trailing space is trimmed and leading space is collapsed but not trimmed.
|-
|}
The result is as if the encoding had been
The <emph>cat</emph> ate the <foreign>grande croissant</foreign>. I didn't!

'''Note:''' The normalization process would have corrupted the text had the encoder put spaces ''inside'' the <emph>, like this:
The<emph> cat </emph>ate the <foreign>grande croissant</foreign>. I didn't!

The resulting text would be:

Thecatate the ''grande croissant''. I didn't!

'''An encoder should assume that an element that includes nothing but text ''will'' get trimmed.'''

== Structured Elements and xsl:strip-space ==

As mentioned above, normalization of whitespace is very common. Programmers implement it without asking encoders. And encoders presume some downstream application will effect it. This complex encoding of a person's name, [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-persName.html taken from the TEI 5 Guidelines] and mentioned above,

<persName>
 <forename>Edward</forename>
 <forename>George</forename>
 <surname type="linked">Bulwer-Lytton</surname>, <roleName>Baron Lytton of
 <placeName>Knebworth</placeName>
 </roleName>
</persName>

presumes—though without saying so—that a downstream program will normalize space according to the algorithm above and produce the name <tt>Edward George Bulwer-Lytton, Baron Lytton of Knebworth</tt>.

Note here that the <tt><persName></tt> element contains both text and elements. Note the comma. And note that had the forenames been encoded without intervening whitespace, the result would have been <tt>EdwardGeorge</tt>.

A problem lurks. Part of defining an XML vocabulary such as TEI is specifying whether an element may contain text and elements or just elements. In TEI 5, <tt><address></tt>, for example, unlike <tt><persName></tt>, may only contain other elements. This

<address>
 <street>10 Downing Street</street>
 <settlement>London</settlement>
 <postCode>SW1A 2AA</postCode>
<address>

is valid TEI. But this

<address>
 <street>10 Downing Street</street>,
 <settlement>London</settlement>
 <postCode>SW1A 2AA</postCode>
<address>

is not, because of that comma after the <tt><street></tt> element. Free non-whitespace text is not allowed between the elements that comprise the <tt><address></tt> element. Though the term is sometimes used more loosely, <tt><address></tt> would commonly be called a "structured element."

Elements that do not allow free non-whitespace text—structured elements, strictly speaking—mimic database records. When XML is used to move data between databases, such elements are the norm; indeed many XSLT programmers have never worked on anything but structured data. In a TEI file, structured data is more common in the header than in the text. A program extracting metadata from a TEI file will often be looking for structured data in the header, so that it can populate database fields, maybe like this:

street: 10 Downing Street 
settlement: London 
postCode: SW1A 2AA 

Defining an element as a structured element specifies that space between child elements can be completely ignored. Thus these two encodings

<address>
 <settlement type="city">London</settlement>
 <postCode>SW1A 2AA</postCode>
<address>

<address>
 <settlement type="city">London</settlement><postCode>SW1A 2AA</postCode>
<address>

are equivalent. They encode:

city: London 
postCode: SW1A 2AA 

Nothing in the encoding indicates that there should be a space, a comma, a new-line, or anything else between "London" and "SW1A 2AA". What, if anything, will be there is left to the processing application. When rendering prose, the application might insert a comma; when printing a mailing label, it might insert a new-line. If might use different punctuation when mailing to different countries.

To correctly process structured elements, XSL programmers insert an instruction, <tt><xsl:strip-space></tt>, at the beginning of their programs, followed by a list of the names of the structured elements. Among other things, this ensures that all whitespace between the children of structured elements will be removed. It will be as if such whitespace was collapsed and trimmed and made to completely disappear.

This situation can produce a temptation best resisted. An encoder may want to request that space be inserted between the components of a structured element, that, for example,

<address>
 <settlement type="city">London</settlement>
 <postCode>SW1A 2AA</postCode>
<address>

should be taken to encode "London SW1A 2AA". To implement this, the downstream processor could simply treat <tt><address></tt> as if it were not a structured element and was a mixed-content element instead. The encoder could then leave whitespace between the child elements and the regular normalization algorithm described above would collapse it and leave one space character.

The temptation is all the more seductive because (1) XML verification will not signal an error, (2) demands on the programmers of downstream applications are reduced, and (3) it is easy to succumb unknowingly. In XSLT, the programmer intentionally or inadvertently leaves <tt><xsl:strip-space></tt> off, something the programmer is happy to do since gathering the list of structured elements was inconvenient anyway, and all seems to be well.

But the better practice is indeed to burden the application with properly formatting structured elements. This burden is part of what it means for an element to be structured. If the project team agrees that whitespace in structured elements will be significant, the schema should be customized to make these elements mixed-content elements instead of structured elements. This ensures that future users of the XML files will be able to understand the files' contents. It also signals that

<tt><settlement>New</settlement><settlement>York</settlement></tt>

and

<tt><settlement>New</settlement> <settlement>York</settlement></tt>

are different, which they would not be if the element were a structured one.

== Recommendations ==

* Programmers should, unless instructed otherwise by <tt>@xml:space='preserve'</tt>, implement code that normalizes space.
* Encoders should presume such normalization will be done but should include a note in <tt><encodingDesc></tt> announcing the presumption. If normalization is not desired as the default, this certainly should be announced in <tt><encodingDesc></tt>
* Encoders should use <tt>xml:space='preserve'</tt> only with the utmost care. Whatever could be accomplished by using it is usually accomplished with less risk by using native TEI elements.
* Project teams should not intentionally or inadvertently use structured elements as if they were mixed-content elements. If this must be done, the schema should be customized to record the change.

== XSLT Normalization Code ==

To normalize mixed-content elements, XSLT's <tt>normalize-space()</tt> function cannot simply be used on all text nodes. The XSLT stylesheet must consider where a text node is among its siblings.

The following XSLT 1.0 code implements the normalization algorithm described above. It works for both text-only and mixed-content elements. The code overrides the built-in template for the appropriate text nodes so may simply be added to XSLT stylesheets.
<pre>

<xsl:template match="text()[not(ancestor::*[@xml:space][1]/@xml:space='preserve')]">

<xsl:if test="position()!=1 and normalize-space(substring(., 1, 1)) = '' and normalize-space()!=''">
<xsl:text> </xsl:text>
</xsl:if>
<xsl:value-of select="normalize-space()"/>

<xsl:if test="position()!=last() and position()!=1 and normalize-space(substring(., string-length())) = ''
or position()!=last() and position() =1 and normalize-space(substring(., string-length())) = '' and normalize-space()!=''
or last()=1 and string-length()!=0 and normalize-space()='' ">
<xsl:text> </xsl:text>
</xsl:if>
</xsl:template>
</pre>
The <tt>normalize-space(substring(., string-length())) = <nowiki>''</nowiki></tt> is just a way to test for whitespace.

An alternative in XSLT 2.0 is the code below, which covers all uses of <tt>text()</tt>. it is written in a slightly more verbose style than the XSLT 1.0 version.

<pre>
<xsl:template match="text()">
<xsl:choose>
<xsl:when
test="ancestor::*[@xml:space][1]/@xml:space='preserve'">
<xsl:value-of select="."/>
</xsl:when>
<xsl:otherwise>

<xsl:if test="position()!=1 and matches(.,'^\s') and normalize-space()!=''">
<xsl:text> </xsl:text>
</xsl:if>
<xsl:value-of select="normalize-space(.)"/>
<xsl:choose>

<xsl:when test="last()=1 and string-length()!=0 and normalize-space()=''">
<xsl:text> </xsl:text>
</xsl:when>

<xsl:when test="position()!=1 and position()!=last() and matches(.,'\s$')">
<xsl:text> </xsl:text>
</xsl:when>

<xsl:when test="position()=1 and matches(.,'\s$') and normalize-space()!=''">
<xsl:text> </xsl:text>
</xsl:when>
</xsl:choose>
</xsl:otherwise>
</xsl:choose>
</xsl:template>
</pre>

== XQuery Normalization Code ==

The corresponding XQuery code would run like this:

<pre>
(:
The rules are:
#1 Retain one leading space if the node isn't first, has non-space content, and has leading space.
#2 Retain one trailing space if the node isn't last, isn't first, and has trailing space.
#3 Retain one trailing space if the node isn't last, is first, has trailing space, and has non-space content.
#4 Retain a single space if the node is an only child and only has space content.
:)
declare function local:tei-normalize-space($input)
{
element {node-name($input)}
{$input/@*,
for $child in $input/node()
return
if ($child instance of element())
then local:tei-normalize-space($child)
else
if ($child instance of text())
then
(:#1 Retain one leading space if node isn't first, has non-space content, and has leading space:)
if ($child/position() ne 1 and matches($child,'^\s') and normalize-space($child) ne '')
then (' ', normalize-space($child))
else
(:#4 retain one space, if the node is an only child, and has content but it's all space:)
if ($child/last() eq 1 and string-length($child) ne 0 and normalize-space($child) eq '')
(:NB: this overrules standard normalization:)
then ' '
else
(:#2 if the node isn't last, isn't first, and has trailing space, retain trailing space and collapse and trim the rest:)
if ($child/position() ne 1 and $child/position() ne last() and matches($child,'\s$'))
then (normalize-space($child), ' ')
else
(:#3 if the node isn't last, is first, has trailing space, and has non-space content, then keep trailing space:)
if ($child/position() eq 1 and matches($child,'\s$') and normalize-space($child) ne '')
then (normalize-space($child), ' ')
(:if the node is an only child, and has content which is not all space, then trim and collapse, that is, apply standard normalization:)
else normalize-space($child)
(:output comments and pi's:)
else $child
}
};
</pre>

== External Links ==
*[http://www.w3.org/TR/REC-xml/#sec-white-space XML 1.0 (Fifth Edition W3C Recommendation 26 November 2008) 2.10 White Space Handling] The spec on @xml:space.
*[http://www.jenitennison.com/blog/node/41 Things that make me scream: xml:space="preserve" in WordML] Frustrations of dealing with @xml:space.
*[http://lists.xml.org/archives/xml-dev/201207/msg00172.html What is @xml:space about?] A discussion of @xml:space on xml-dev.
*[http://msdn.microsoft.com/en-us/library/ms788746(v=vs.90).aspx Whitespace Processing in XAML] Another description of the algorithm for normalizing mixed-content elements.

[[Category:XSLT]]
[[Category:XQuery]]
[[Category:Markup]]
[[Category:Recommended Practice]]

EXist

2014-07-01T12:06:51Z

Jensopetersen: /* Sample implementations */ Added Syrica.org

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist-db.org eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery-30/ XQuery 3.0], [http://www.w3.org/TR/xpath-30/ XPath 3.0], [http://www.w3.org/TR/xslt20/ XSLT 2.0] (based on [http://www.saxonica.com/ Saxon]), XForms 1.1 (based on [http://www.betterForm.de betterForm], [http://www.orbeon.com Orbeon] or [http://www.agencexml.com/xsltforms XSLTForms]) XProc, JSON and JSONP.

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://exquery.github.io/exquery/exquery-restxq-specification/restxq-1.0-specification.html RESTXQ], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The 1.4 version added a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

The [http://exist.sourceforge.net/download.html 2.0 version] completely redesigned the Security subsystem introducing Access Control Lists and multiple realm authentication, and also introduced a re-write of the WebDAV Server making it more widely compatible with clients. In addition hundreds of bugfixes and performance improvements have been made since the 1.4 release.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate, XSLT and XProc
* [http://xmldb-org.sourceforge.net/xapi/ XML:DB API]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Security Access Control Lists on Documents and Collections
* Optional multi-realm integration with LDAP and Active Directory
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.oracle.com JRE] >= 6. Being a Java application it can be used on most operating systems, including Windows, Linux, Mac OS X, Solaris and FreeBSD and it can be deployed in several ways, as a standalone server application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library embedded in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/licenses/lgpl-2.1.html GNU LGPL 2.1] license.

== Support for TEI ==
Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the Digital.Humanities@Oxford Summer School in 2011; see the [http://digital.humanities.ox.ac.uk/dhoxss/2011/sessions.html#xmldb session description] with links to slides and sample material.

From the Package Manager, accessed through the eXist Dashboard, one can install the application Shakespeare's Works in TEI from the eXist Public Repository. All Shakespeare's plays from the [http://wordhoard.northwestern.edu/ WordHoard Shakespeare] can be queried with search results displayed in the hit list in KWIC format. See also the [https://github.com/wolfgangmm/ShakespeareDemo GitHub repo] for this application.

A TEI module called Matumi is distributed as an eXist application. Matumi is still under development. It requires eXist version 1.5 and is installed from within eXist's Package Reposistory. After installation, it can be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

Matumi is not a full-blown TEI module yet, but it has some notable features, such as the ability to browse by filtering texts and core parts of the markup. It contains faceted search feeding off the markup, making possible "translingual" searches that utilise references added to name forms.

The app uses XQuery only.

Installation will store a number of basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present orientation of the app.

If you access through browsing, you can arrange the data by four criteria - books, entry title, subjects and names.

If you access through search, in order to retrieve some sample results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

There is a comprehensive discussion of optimising eXist/XQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As detailed above, eXist is itself written in the Java language. However, it enables complete applications to be created without writing any programming code, by just using only XQuery, XSLT, (X)HTML, CSS, XForms, XProc and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
[http://exist-db.org/exist/apps/doc/ eXist Documentation]

== Tech support ==
Technical support for the Open Source product is provided mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

Commercial support, consultancy and training is also available from the creators of eXist through [http://www.existsolutions.com eXist Solutions]. eXist Solutions directly support and further the development of eXist.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

In August 2011, a dedicated email list was created on using eXist with TEI resources. For information or to subscribe, go to the [https://lists.sourceforge.net/lists/listinfo/exist-teixml eXist-TEIXML] information page.

== Sample implementations ==
* [http://mapoflondon.uvic.ca/ The Map of Early Modern London] maps the streets, sites, and significant boundaries of late 16th-century and early 17th-century London.
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The correspondence, diaries, writings and works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://syriaca.org/ Syrica.org] publishes online reference works concerning the culture, history, and literature of Syriac communities from antiquity to the present. Public repo at [https://github.com/srophe/srophe-eXist-app GitHub].
* [http://graves.uvic.ca/ Diary of Robert Graves]

* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://sermones.net/thesaurus/ Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.

* [http://bcgenesis.uvic.ca/ The Colonial Despatches of Vancouver Island and British Columbia 1846-1871] contains the original correspondence between the British Colonial Office and the colonies of Vancouver Island and British Columbia.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 2.0 revision 18252 - 2013-02-07

== How to download ==
Download an installer for the current stable version (version 2.1, July 2013) from the [http://www.exist-db.org/exist/apps/homepage/index.html#subscriptions eXist Home Page]; clone or download the current trunk version from the [https://github.com/eXist-db/exist eXist GitHub Page].

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2014-07-01T12:02:07Z

Jensopetersen: /* Sample implementations */ PHP again

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist-db.org eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery-30/ XQuery 3.0], [http://www.w3.org/TR/xpath-30/ XPath 3.0], [http://www.w3.org/TR/xslt20/ XSLT 2.0] (based on [http://www.saxonica.com/ Saxon]), XForms 1.1 (based on [http://www.betterForm.de betterForm], [http://www.orbeon.com Orbeon] or [http://www.agencexml.com/xsltforms XSLTForms]) XProc, JSON and JSONP.

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://exquery.github.io/exquery/exquery-restxq-specification/restxq-1.0-specification.html RESTXQ], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The 1.4 version added a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

The [http://exist.sourceforge.net/download.html 2.0 version] completely redesigned the Security subsystem introducing Access Control Lists and multiple realm authentication, and also introduced a re-write of the WebDAV Server making it more widely compatible with clients. In addition hundreds of bugfixes and performance improvements have been made since the 1.4 release.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate, XSLT and XProc
* [http://xmldb-org.sourceforge.net/xapi/ XML:DB API]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Security Access Control Lists on Documents and Collections
* Optional multi-realm integration with LDAP and Active Directory
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.oracle.com JRE] >= 6. Being a Java application it can be used on most operating systems, including Windows, Linux, Mac OS X, Solaris and FreeBSD and it can be deployed in several ways, as a standalone server application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library embedded in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/licenses/lgpl-2.1.html GNU LGPL 2.1] license.

== Support for TEI ==
Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the Digital.Humanities@Oxford Summer School in 2011; see the [http://digital.humanities.ox.ac.uk/dhoxss/2011/sessions.html#xmldb session description] with links to slides and sample material.

From the Package Manager, accessed through the eXist Dashboard, one can install the application Shakespeare's Works in TEI from the eXist Public Repository. All Shakespeare's plays from the [http://wordhoard.northwestern.edu/ WordHoard Shakespeare] can be queried with search results displayed in the hit list in KWIC format. See also the [https://github.com/wolfgangmm/ShakespeareDemo GitHub repo] for this application.

A TEI module called Matumi is distributed as an eXist application. Matumi is still under development. It requires eXist version 1.5 and is installed from within eXist's Package Reposistory. After installation, it can be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

Matumi is not a full-blown TEI module yet, but it has some notable features, such as the ability to browse by filtering texts and core parts of the markup. It contains faceted search feeding off the markup, making possible "translingual" searches that utilise references added to name forms.

The app uses XQuery only.

Installation will store a number of basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present orientation of the app.

If you access through browsing, you can arrange the data by four criteria - books, entry title, subjects and names.

If you access through search, in order to retrieve some sample results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

There is a comprehensive discussion of optimising eXist/XQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As detailed above, eXist is itself written in the Java language. However, it enables complete applications to be created without writing any programming code, by just using only XQuery, XSLT, (X)HTML, CSS, XForms, XProc and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
[http://exist-db.org/exist/apps/doc/ eXist Documentation]

== Tech support ==
Technical support for the Open Source product is provided mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

Commercial support, consultancy and training is also available from the creators of eXist through [http://www.existsolutions.com eXist Solutions]. eXist Solutions directly support and further the development of eXist.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

In August 2011, a dedicated email list was created on using eXist with TEI resources. For information or to subscribe, go to the [https://lists.sourceforge.net/lists/listinfo/exist-teixml eXist-TEIXML] information page.

== Sample implementations ==
* [http://mapoflondon.uvic.ca/ The Map of Early Modern London] maps the streets, sites, and significant boundaries of late 16th-century and early 17th-century London.
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The correspondence, diaries, writings and works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]

* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://sermones.net/thesaurus/ Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.

* [http://bcgenesis.uvic.ca/ The Colonial Despatches of Vancouver Island and British Columbia 1846-1871] contains the original correspondence between the British Colonial Office and the colonies of Vancouver Island and British Columbia.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 2.0 revision 18252 - 2013-02-07

== How to download ==
Download an installer for the current stable version (version 2.1, July 2013) from the [http://www.exist-db.org/exist/apps/homepage/index.html#subscriptions eXist Home Page]; clone or download the current trunk version from the [https://github.com/eXist-db/exist eXist GitHub Page].

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2014-06-10T12:06:59Z

Jensopetersen: /* Sample implementations */ Has paleographie ever used eXist? Clearly a PHP site.

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist-db.org eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery-30/ XQuery 3.0], [http://www.w3.org/TR/xpath-30/ XPath 3.0], [http://www.w3.org/TR/xslt20/ XSLT 2.0] (based on [http://www.saxonica.com/ Saxon]), XForms 1.1 (based on [http://www.betterForm.de betterForm], [http://www.orbeon.com Orbeon] or [http://www.agencexml.com/xsltforms XSLTForms]) XProc, JSON and JSONP.

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://exquery.github.io/exquery/exquery-restxq-specification/restxq-1.0-specification.html RESTXQ], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The 1.4 version added a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

The [http://exist.sourceforge.net/download.html 2.0 version] completely redesigned the Security subsystem introducing Access Control Lists and multiple realm authentication, and also introduced a re-write of the WebDAV Server making it more widely compatible with clients. In addition hundreds of bugfixes and performance improvements have been made since the 1.4 release.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate, XSLT and XProc
* [http://xmldb-org.sourceforge.net/xapi/ XML:DB API]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Security Access Control Lists on Documents and Collections
* Optional multi-realm integration with LDAP and Active Directory
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.oracle.com JRE] >= 6. Being a Java application it can be used on most operating systems, including Windows, Linux, Mac OS X, Solaris and FreeBSD and it can be deployed in several ways, as a standalone server application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library embedded in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/licenses/lgpl-2.1.html GNU LGPL 2.1] license.

== Support for TEI ==
Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the Digital.Humanities@Oxford Summer School in 2011; see the [http://digital.humanities.ox.ac.uk/dhoxss/2011/sessions.html#xmldb session description] with links to slides and sample material.

From the Package Manager, accessed through the eXist Dashboard, one can install the application Shakespeare's Works in TEI from the eXist Public Repository. All Shakespeare's plays from the [http://wordhoard.northwestern.edu/ WordHoard Shakespeare] can be queried with search results displayed in the hit list in KWIC format. See also the [https://github.com/wolfgangmm/ShakespeareDemo GitHub repo] for this application.

A TEI module called Matumi is distributed as an eXist application. Matumi is still under development. It requires eXist version 1.5 and is installed from within eXist's Package Reposistory. After installation, it can be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

Matumi is not a full-blown TEI module yet, but it has some notable features, such as the ability to browse by filtering texts and core parts of the markup. It contains faceted search feeding off the markup, making possible "translingual" searches that utilise references added to name forms.

The app uses XQuery only.

Installation will store a number of basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present orientation of the app.

If you access through browsing, you can arrange the data by four criteria - books, entry title, subjects and names.

If you access through search, in order to retrieve some sample results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

There is a comprehensive discussion of optimising eXist/XQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As detailed above, eXist is itself written in the Java language. However, it enables complete applications to be created without writing any programming code, by just using only XQuery, XSLT, (X)HTML, CSS, XForms, XProc and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
[http://exist-db.org/exist/apps/doc/ eXist Documentation]

== Tech support ==
Technical support for the Open Source product is provided mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

Commercial support, consultancy and training is also available from the creators of eXist through [http://www.existsolutions.com eXist Solutions]. eXist Solutions directly support and further the development of eXist.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

In August 2011, a dedicated email list was created on using eXist with TEI resources. For information or to subscribe, go to the [https://lists.sourceforge.net/lists/listinfo/exist-teixml eXist-TEIXML] information page.

== Sample implementations ==
* [http://mapoflondon.uvic.ca/ The Map of Early Modern London] maps the streets, sites, and significant boundaries of late 16th-century and early 17th-century London.
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The correspondence, diaries, writings and works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://sermones.net/thesaurus/ Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.

* [http://bcgenesis.uvic.ca/ The Colonial Despatches of Vancouver Island and British Columbia 1846-1871] contains the original correspondence between the British Colonial Office and the colonies of Vancouver Island and British Columbia.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 2.0 revision 18252 - 2013-02-07

== How to download ==
Download an installer for the current stable version (version 2.1, July 2013) from the [http://www.exist-db.org/exist/apps/homepage/index.html#subscriptions eXist Home Page]; clone or download the current trunk version from the [https://github.com/eXist-db/exist eXist GitHub Page].

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2013-11-11T07:08:53Z

Jensopetersen:

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist-db.org eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery-30/ XQuery 3.0], [http://www.w3.org/TR/xpath-30/ XPath 3.0], [http://www.w3.org/TR/xslt20/ XSLT 2.0] (based on [http://www.saxonica.com/ Saxon]), XForms 1.1 (based on [http://www.betterForm.de betterForm], [http://www.orbeon.com Orbeon] or [http://www.agencexml.com/xsltforms XSLTForms]) XProc, JSON and JSONP.

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://exquery.github.io/exquery/exquery-restxq-specification/restxq-1.0-specification.html RESTXQ], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The 1.4 version added a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

The [http://exist.sourceforge.net/download.html 2.0 version] completely redesigned the Security subsystem introducing Access Control Lists and multiple realm authentication, and also introduced a re-write of the WebDAV Server making it more widely compatible with clients. In addition hundreds of bugfixes and performance improvements have been made since the 1.4 release.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate, XSLT and XProc
* [http://xmldb-org.sourceforge.net/xapi/ XML:DB API]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Security Access Control Lists on Documents and Collections
* Optional multi-realm integration with LDAP and Active Directory
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.oracle.com JRE] >= 6. Being a Java application it can be used on most operating systems, including Windows, Linux, Mac OS X, Solaris and FreeBSD and it can be deployed in several ways, as a standalone server application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library embedded in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/licenses/lgpl-2.1.html GNU LGPL 2.1] license.

== Support for TEI ==
Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the Digital.Humanities@Oxford Summer School in 2011; see the [http://digital.humanities.ox.ac.uk/dhoxss/2011/sessions.html#xmldb session description] with links to slides and sample material.

From the Package Manager, accessed through the eXist Dashboard, one can install the application Shakespeare's Works in TEI from the eXist Public Repository. All Shakespeare's plays from the [http://wordhoard.northwestern.edu/ WordHoard Shakespeare] can be queried with search results displayed in the hit list in KWIC format. See also the [https://github.com/wolfgangmm/ShakespeareDemo GitHub repo] for this application.

A TEI module called Matumi is distributed as an eXist application. Matumi is still under development. It requires eXist version 1.5 and is installed from within eXist's Package Reposistory. After installation, it can be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

Matumi is not a full-blown TEI module yet, but it has some notable features, such as the ability to browse by filtering texts and core parts of the markup. It contains faceted search feeding off the markup, making possible "translingual" searches that utilise references added to name forms.

The app uses XQuery only.

Installation will store a number of basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present orientation of the app.

If you access through browsing, you can arrange the data by four criteria - books, entry title, subjects and names.

If you access through search, in order to retrieve some sample results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

There is a comprehensive discussion of optimising eXist/XQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As detailed above, eXist is itself written in the Java language. However, it enables complete applications to be created without writing any programming code, by just using only XQuery, XSLT, (X)HTML, CSS, XForms, XProc and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
[http://exist-db.org/exist/apps/doc/ eXist Documentation]

== Tech support ==
Technical support for the Open Source product is provided mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

Commercial support, consultancy and training is also available from the creators of eXist through [http://www.existsolutions.com eXist Solutions]. eXist Solutions directly support and further the development of eXist.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

In August 2011, a dedicated email list was created on using eXist with TEI resources. For information or to subscribe, go to the [https://lists.sourceforge.net/lists/listinfo/exist-teixml eXist-TEIXML] information page.

== Sample implementations ==
* [http://mapoflondon.uvic.ca/ The Map of Early Modern London] maps the streets, sites, and significant boundaries of late 16th-century and early 17th-century London.
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The correspondence, diaries, writings and works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ The Colonial Despatches of Vancouver Island and British Columbia 1846-1871] contains the original correspondence between the British Colonial Office and the colonies of Vancouver Island and British Columbia.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 2.0 revision 18252 - 2013-02-07

== How to download ==
Download an installer for the current stable version (version 2.1, July 2013) from the [http://www.exist-db.org/exist/apps/homepage/index.html#subscriptions eXist Home Page]; clone or download the current trunk version from the [https://github.com/eXist-db/exist eXist GitHub Page].

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2013-11-10T16:19:50Z

Jensopetersen: /* Support for TEI */ Added info about Shakespeare Demo

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery-30/ XQuery 3.0], [http://www.w3.org/TR/xpath-30/ XPath 3.0], [http://www.w3.org/TR/xslt20/ XSLT 2.0] (based on [http://www.saxonica.com/ Saxon]), XForms 1.1 (based on [http://www.betterForm.de betterForm], [http://www.orbeon.com Orbeon] or [http://www.agencexml.com/xsltforms XSLTForms]) XProc, JSON and JSONP.

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://exquery.github.io/exquery/exquery-restxq-specification/restxq-1.0-specification.html RESTXQ], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The 1.4 version added a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

The [http://exist.sourceforge.net/download.html 2.0 version] completely redesigned the Security subsystem introducing Access Control Lists and multiple realm authentication, and also introduced a re-write of the WebDAV Server making it more widely compatible with clients. In addition hundreds of bugfixes and performance improvements have been made since the 1.4 release.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate, XSLT and XProc
* [http://xmldb-org.sourceforge.net/xapi/ XML:DB API]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Security Access Control Lists on Documents and Collections
* Optional multi-realm integration with LDAP and Active Directory
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.oracle.com JRE] >= 6. Being a Java application it can be used on most operating systems, including Windows, Linux, Mac OS X, Solaris and FreeBSD and it can be deployed in several ways, as a standalone server application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library embedded in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/licenses/lgpl-2.1.html GNU LGPL 2.1] license.

== Support for TEI ==
Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the Digital.Humanities@Oxford Summer School in 2011; see the [http://digital.humanities.ox.ac.uk/dhoxss/2011/sessions.html#xmldb session description] with links to slides and sample material.

From the Package Manager, accessed through the eXist Dashboard, one can install the application Shakespeare's Works in TEI from the eXist Public Repository. All Shakespeare's plays from the [http://wordhoard.northwestern.edu/ WordHoard Shakespeare] can be queried with search results displayed in the hit list in KWIC format. See also the [https://github.com/wolfgangmm/ShakespeareDemo GitHub repo] for this application.

A TEI module called Matumi is distributed as an eXist application. Matumi is still under development. It requires eXist version 1.5 and is installed from within eXist's Package Reposistory. After installation, it can be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

Matumi is not a full-blown TEI module yet, but it has some notable features, such as the ability to browse by filtering texts and core parts of the markup. It contains faceted search feeding off the markup, making possible "translingual" searches that utilise references added to name forms.

The app uses XQuery only.

Installation will store a number of basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present orientation of the app.

If you access through browsing, you can arrange the data by four criteria - books, entry title, subjects and names.

If you access through search, in order to retrieve some sample results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

There is a comprehensive discussion of optimising eXist/XQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As detailed above, eXist is itself written in the Java language. However, it enables complete applications to be created without writing any programming code, by just using only XQuery, XSLT, (X)HTML, CSS, XForms, XProc and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
[http://exist-db.org/exist/apps/doc/ eXist Documentation]

== Tech support ==
Technical support for the Open Source product is provided mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

Commercial support, consultancy and training is also available from the creators of eXist through [http://www.existsolutions.com eXist Solutions]. eXist Solutions directly support and further the development of eXist.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

In August 2011, a dedicated email list was created on using eXist with TEI resources. For information or to subscribe, go to the [https://lists.sourceforge.net/lists/listinfo/exist-teixml eXist-TEIXML] information page.

== Sample implementations ==
* [http://mapoflondon.uvic.ca/ The Map of Early Modern London] maps the streets, sites, and significant boundaries of late 16th-century and early 17th-century London.
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The correspondence, diaries, writings and works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ The Colonial Despatches of Vancouver Island and British Columbia 1846-1871] contains the original correspondence between the British Colonial Office and the colonies of Vancouver Island and British Columbia.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 2.0 revision 18252 - 2013-02-07

== How to download ==
Download an installer for the current stable version (version 2.1, July 2013) from the [http://www.exist-db.org/exist/apps/homepage/index.html#subscriptions eXist Home Page]; clone or download the current trunk version from the [https://github.com/eXist-db/exist eXist GitHub Page].

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2013-11-10T16:02:19Z

Jensopetersen: /* How to download */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery-30/ XQuery 3.0], [http://www.w3.org/TR/xpath-30/ XPath 3.0], [http://www.w3.org/TR/xslt20/ XSLT 2.0] (based on [http://www.saxonica.com/ Saxon]), XForms 1.1 (based on [http://www.betterForm.de betterForm], [http://www.orbeon.com Orbeon] or [http://www.agencexml.com/xsltforms XSLTForms]) XProc, JSON and JSONP.

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://exquery.github.io/exquery/exquery-restxq-specification/restxq-1.0-specification.html RESTXQ], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The 1.4 version added a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

The [http://exist.sourceforge.net/download.html 2.0 version] completely redesigned the Security subsystem introducing Access Control Lists and multiple realm authentication, and also introduced a re-write of the WebDAV Server making it more widely compatible with clients. In addition hundreds of bugfixes and performance improvements have been made since the 1.4 release.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate, XSLT and XProc
* [http://xmldb-org.sourceforge.net/xapi/ XML:DB API]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Security Access Control Lists on Documents and Collections
* Optional multi-realm integration with LDAP and Active Directory
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.oracle.com JRE] >= 6. Being a Java application it can be used on most operating systems, including Windows, Linux, Mac OS X, Solaris and FreeBSD and it can be deployed in several ways, as a standalone server application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library embedded in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/licenses/lgpl-2.1.html GNU LGPL 2.1] license.

== Support for TEI ==
Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the Digital.Humanities@Oxford Summer School in 2011; see the [http://digital.humanities.ox.ac.uk/DHSS2011/sessions.html#xmldb session description, slides, and sample materials].

A TEI module called Matumi is distributed as an eXist application. Matumi is still under development. It requires eXist version 1.5 and is installed from within eXist's Package Reposistory. After installation, it can be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

Matumi is not a full-blown TEI module yet, but it has some notable features, such as the ability to browse by filtering texts and core parts of the markup. It contains faceted search feeding off the markup, making possible "translingual" searches that utilise references added to name forms. 

The app uses XQuery only.

Installation will store a number of basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present orientation of the app.

If you access through browsing, you can arrange the data by four criteria - books, entry title, subjects and names.

If you access through search, in order to retrieve some sample results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

There is a comprehensive discussion of optimising eXist/XQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As detailed above, eXist is itself written in the Java language. However, it enables complete applications to be created without writing any programming code, by just using only XQuery, XSLT, (X)HTML, CSS, XForms, XProc and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
[http://exist-db.org/exist/apps/doc/ eXist Documentation]

== Tech support ==
Technical support for the Open Source product is provided mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

Commercial support, consultancy and training is also available from the creators of eXist through [http://www.existsolutions.com eXist Solutions]. eXist Solutions directly support and further the development of eXist.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

In August 2011, a dedicated email list was created on using eXist with TEI resources. For information or to subscribe, go to the [https://lists.sourceforge.net/lists/listinfo/exist-teixml eXist-TEIXML] information page.

== Sample implementations ==
* [http://mapoflondon.uvic.ca/ The Map of Early Modern London] maps the streets, sites, and significant boundaries of late 16th-century and early 17th-century London.
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The correspondence, diaries, writings and works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ The Colonial Despatches of Vancouver Island and British Columbia 1846-1871] contains the original correspondence between the British Colonial Office and the colonies of Vancouver Island and British Columbia.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 2.0 revision 18252 - 2013-02-07

== How to download ==
Download an installer for the current stable version (version 2.1, July 2013) from the [http://www.exist-db.org/exist/apps/homepage/index.html#subscriptions eXist Home Page]; clone or download the current trunk version from the [https://github.com/eXist-db/exist eXist GitHub Page].

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2013-11-10T14:59:16Z

Jensopetersen: /* Support for TEI */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery-30/ XQuery 3.0], [http://www.w3.org/TR/xpath-30/ XPath 3.0], [http://www.w3.org/TR/xslt20/ XSLT 2.0] (based on [http://www.saxonica.com/ Saxon]), XForms 1.1 (based on [http://www.betterForm.de betterForm], [http://www.orbeon.com Orbeon] or [http://www.agencexml.com/xsltforms XSLTForms]) XProc, JSON and JSONP.

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://exquery.github.io/exquery/exquery-restxq-specification/restxq-1.0-specification.html RESTXQ], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The 1.4 version added a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

The [http://exist.sourceforge.net/download.html 2.0 version] completely redesigned the Security subsystem introducing Access Control Lists and multiple realm authentication, and also introduced a re-write of the WebDAV Server making it more widely compatible with clients. In addition hundreds of bugfixes and performance improvements have been made since the 1.4 release.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate, XSLT and XProc
* [http://xmldb-org.sourceforge.net/xapi/ XML:DB API]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Security Access Control Lists on Documents and Collections
* Optional multi-realm integration with LDAP and Active Directory
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.oracle.com JRE] >= 6. Being a Java application it can be used on most operating systems, including Windows, Linux, Mac OS X, Solaris and FreeBSD and it can be deployed in several ways, as a standalone server application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library embedded in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/licenses/lgpl-2.1.html GNU LGPL 2.1] license.

== Support for TEI ==
Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the Digital.Humanities@Oxford Summer School in 2011; see the [http://digital.humanities.ox.ac.uk/DHSS2011/sessions.html#xmldb session description, slides, and sample materials].

A TEI module called Matumi is distributed as an eXist application. Matumi is still under development. It requires eXist version 1.5 and is installed from within eXist's Package Reposistory. After installation, it can be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

Matumi is not a full-blown TEI module yet, but it has some notable features, such as the ability to browse by filtering texts and core parts of the markup. It contains faceted search feeding off the markup, making possible "translingual" searches that utilise references added to name forms. 

The app uses XQuery only.

Installation will store a number of basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present orientation of the app.

If you access through browsing, you can arrange the data by four criteria - books, entry title, subjects and names.

If you access through search, in order to retrieve some sample results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

There is a comprehensive discussion of optimising eXist/XQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As detailed above, eXist is itself written in the Java language. However, it enables complete applications to be created without writing any programming code, by just using only XQuery, XSLT, (X)HTML, CSS, XForms, XProc and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
[http://exist-db.org/exist/apps/doc/ eXist Documentation]

== Tech support ==
Technical support for the Open Source product is provided mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

Commercial support, consultancy and training is also available from the creators of eXist through [http://www.existsolutions.com eXist Solutions]. eXist Solutions directly support and further the development of eXist.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

In August 2011, a dedicated email list was created on using eXist with TEI resources. For information or to subscribe, go to the [https://lists.sourceforge.net/lists/listinfo/exist-teixml eXist-TEIXML] information page.

== Sample implementations ==
* [http://mapoflondon.uvic.ca/ The Map of Early Modern London] maps the streets, sites, and significant boundaries of late 16th-century and early 17th-century London.
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The correspondence, diaries, writings and works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ The Colonial Despatches of Vancouver Island and British Columbia 1846-1871] contains the original correspondence between the British Colonial Office and the colonies of Vancouver Island and British Columbia.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 2.0 revision 18252 - 2013-02-07

== How to download ==
Download the current stable version (version 2.1, July 2013) from the [http://www.exist-db.org/exist/apps/homepage/index.html#subscriptions eXist Home Page]; clone or download the current trunk version from [https://github.com/eXist-db/exist eXist GitHub Page].

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2013-11-10T14:57:51Z

Jensopetersen: /* Documentation */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery-30/ XQuery 3.0], [http://www.w3.org/TR/xpath-30/ XPath 3.0], [http://www.w3.org/TR/xslt20/ XSLT 2.0] (based on [http://www.saxonica.com/ Saxon]), XForms 1.1 (based on [http://www.betterForm.de betterForm], [http://www.orbeon.com Orbeon] or [http://www.agencexml.com/xsltforms XSLTForms]) XProc, JSON and JSONP.

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://exquery.github.io/exquery/exquery-restxq-specification/restxq-1.0-specification.html RESTXQ], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The 1.4 version added a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

The [http://exist.sourceforge.net/download.html 2.0 version] completely redesigned the Security subsystem introducing Access Control Lists and multiple realm authentication, and also introduced a re-write of the WebDAV Server making it more widely compatible with clients. In addition hundreds of bugfixes and performance improvements have been made since the 1.4 release.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate, XSLT and XProc
* [http://xmldb-org.sourceforge.net/xapi/ XML:DB API]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Security Access Control Lists on Documents and Collections
* Optional multi-realm integration with LDAP and Active Directory
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.oracle.com JRE] >= 6. Being a Java application it can be used on most operating systems, including Windows, Linux, Mac OS X, Solaris and FreeBSD and it can be deployed in several ways, as a standalone server application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library embedded in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/licenses/lgpl-2.1.html GNU LGPL 2.1] license.

== Support for TEI ==
Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the Digital.Humanities@Oxford Summer School in 2011; see the [http://digital.humanities.ox.ac.uk/DHSS2011/sessions.html#xmldb session description, slides, and sample materials].

A TEI module called Matumi is distributed as an eXist application. Matumi is still under development. It requires eXist version 1.5 and is installed from within eXist's Package Reposistory. After installation, it can be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

Matumi is not a full-blown TEI module yet, but it has some notable features, such as the ability to browse by filtering texts and core parts of the markup. It contains faceted search feeding off the markup, making possible "translingual" searches that utilise references added to name forms. 

The app uses XQuery only.

Installation will store a number of basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present orientation of the app.

If you access through browsing, you can arrange the data by four criteria - books, entry title, subjects and names.

If you access through search, in order to retrieve some sample results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

There is a comprehensive discussion of optimising eXist/xQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As detailed above, eXist is itself written in the Java language. However, it enables complete applications to be created without writing any programming code, by just using only XQuery, XSLT, (X)HTML, CSS, XForms, XProc and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
[http://exist-db.org/exist/apps/doc/ eXist Documentation]

== Tech support ==
Technical support for the Open Source product is provided mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

Commercial support, consultancy and training is also available from the creators of eXist through [http://www.existsolutions.com eXist Solutions]. eXist Solutions directly support and further the development of eXist.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

In August 2011, a dedicated email list was created on using eXist with TEI resources. For information or to subscribe, go to the [https://lists.sourceforge.net/lists/listinfo/exist-teixml eXist-TEIXML] information page.

== Sample implementations ==
* [http://mapoflondon.uvic.ca/ The Map of Early Modern London] maps the streets, sites, and significant boundaries of late 16th-century and early 17th-century London.
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The correspondence, diaries, writings and works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ The Colonial Despatches of Vancouver Island and British Columbia 1846-1871] contains the original correspondence between the British Colonial Office and the colonies of Vancouver Island and British Columbia.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 2.0 revision 18252 - 2013-02-07

== How to download ==
Download the current stable version (version 2.1, July 2013) from the [http://www.exist-db.org/exist/apps/homepage/index.html#subscriptions eXist Home Page]; clone or download the current trunk version from [https://github.com/eXist-db/exist eXist GitHub Page].

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2013-11-10T14:55:28Z

Jensopetersen: /* Documentation */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery-30/ XQuery 3.0], [http://www.w3.org/TR/xpath-30/ XPath 3.0], [http://www.w3.org/TR/xslt20/ XSLT 2.0] (based on [http://www.saxonica.com/ Saxon]), XForms 1.1 (based on [http://www.betterForm.de betterForm], [http://www.orbeon.com Orbeon] or [http://www.agencexml.com/xsltforms XSLTForms]) XProc, JSON and JSONP.

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://exquery.github.io/exquery/exquery-restxq-specification/restxq-1.0-specification.html RESTXQ], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The 1.4 version added a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

The [http://exist.sourceforge.net/download.html 2.0 version] completely redesigned the Security subsystem introducing Access Control Lists and multiple realm authentication, and also introduced a re-write of the WebDAV Server making it more widely compatible with clients. In addition hundreds of bugfixes and performance improvements have been made since the 1.4 release.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate, XSLT and XProc
* [http://xmldb-org.sourceforge.net/xapi/ XML:DB API]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Security Access Control Lists on Documents and Collections
* Optional multi-realm integration with LDAP and Active Directory
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.oracle.com JRE] >= 6. Being a Java application it can be used on most operating systems, including Windows, Linux, Mac OS X, Solaris and FreeBSD and it can be deployed in several ways, as a standalone server application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library embedded in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/licenses/lgpl-2.1.html GNU LGPL 2.1] license.

== Support for TEI ==
Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the Digital.Humanities@Oxford Summer School in 2011; see the [http://digital.humanities.ox.ac.uk/DHSS2011/sessions.html#xmldb session description, slides, and sample materials].

A TEI module called Matumi is distributed as an eXist application. Matumi is still under development. It requires eXist version 1.5 and is installed from within eXist's Package Reposistory. After installation, it can be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

Matumi is not a full-blown TEI module yet, but it has some notable features, such as the ability to browse by filtering texts and core parts of the markup. It contains faceted search feeding off the markup, making possible "translingual" searches that utilise references added to name forms. 

The app uses XQuery only.

Installation will store a number of basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present orientation of the app.

If you access through browsing, you can arrange the data by four criteria - books, entry title, subjects and names.

If you access through search, in order to retrieve some sample results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

There is a comprehensive discussion of optimising eXist/xQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As detailed above, eXist is itself written in the Java language. However, it enables complete applications to be created without writing any programming code, by just using only XQuery, XSLT, (X)HTML, CSS, XForms, XProc and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
exist-db.org/exist/apps/doc/

== Tech support ==
Technical support for the Open Source product is provided mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

Commercial support, consultancy and training is also available from the creators of eXist through [http://www.existsolutions.com eXist Solutions]. eXist Solutions directly support and further the development of eXist.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

In August 2011, a dedicated email list was created on using eXist with TEI resources. For information or to subscribe, go to the [https://lists.sourceforge.net/lists/listinfo/exist-teixml eXist-TEIXML] information page.

== Sample implementations ==
* [http://mapoflondon.uvic.ca/ The Map of Early Modern London] maps the streets, sites, and significant boundaries of late 16th-century and early 17th-century London.
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The correspondence, diaries, writings and works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ The Colonial Despatches of Vancouver Island and British Columbia 1846-1871] contains the original correspondence between the British Colonial Office and the colonies of Vancouver Island and British Columbia.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 2.0 revision 18252 - 2013-02-07

== How to download ==
Download the current stable version (version 2.1, July 2013) from the [http://www.exist-db.org/exist/apps/homepage/index.html#subscriptions eXist Home Page]; clone or download the current trunk version from [https://github.com/eXist-db/exist eXist GitHub Page].

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2013-11-10T14:54:05Z

Jensopetersen: /* How to download */ 2.0 > 2.1

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery-30/ XQuery 3.0], [http://www.w3.org/TR/xpath-30/ XPath 3.0], [http://www.w3.org/TR/xslt20/ XSLT 2.0] (based on [http://www.saxonica.com/ Saxon]), XForms 1.1 (based on [http://www.betterForm.de betterForm], [http://www.orbeon.com Orbeon] or [http://www.agencexml.com/xsltforms XSLTForms]) XProc, JSON and JSONP.

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://exquery.github.io/exquery/exquery-restxq-specification/restxq-1.0-specification.html RESTXQ], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The 1.4 version added a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

The [http://exist.sourceforge.net/download.html 2.0 version] completely redesigned the Security subsystem introducing Access Control Lists and multiple realm authentication, and also introduced a re-write of the WebDAV Server making it more widely compatible with clients. In addition hundreds of bugfixes and performance improvements have been made since the 1.4 release.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate, XSLT and XProc
* [http://xmldb-org.sourceforge.net/xapi/ XML:DB API]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Security Access Control Lists on Documents and Collections
* Optional multi-realm integration with LDAP and Active Directory
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.oracle.com JRE] >= 6. Being a Java application it can be used on most operating systems, including Windows, Linux, Mac OS X, Solaris and FreeBSD and it can be deployed in several ways, as a standalone server application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library embedded in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/licenses/lgpl-2.1.html GNU LGPL 2.1] license.

== Support for TEI ==
Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the Digital.Humanities@Oxford Summer School in 2011; see the [http://digital.humanities.ox.ac.uk/DHSS2011/sessions.html#xmldb session description, slides, and sample materials].

A TEI module called Matumi is distributed as an eXist application. Matumi is still under development. It requires eXist version 1.5 and is installed from within eXist's Package Reposistory. After installation, it can be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

Matumi is not a full-blown TEI module yet, but it has some notable features, such as the ability to browse by filtering texts and core parts of the markup. It contains faceted search feeding off the markup, making possible "translingual" searches that utilise references added to name forms. 

The app uses XQuery only.

Installation will store a number of basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present orientation of the app.

If you access through browsing, you can arrange the data by four criteria - books, entry title, subjects and names.

If you access through search, in order to retrieve some sample results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

There is a comprehensive discussion of optimising eXist/xQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As detailed above, eXist is itself written in the Java language. However, it enables complete applications to be created without writing any programming code, by just using only XQuery, XSLT, (X)HTML, CSS, XForms, XProc and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support for the Open Source product is provided mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

Commercial support, consultancy and training is also available from the creators of eXist through [http://www.existsolutions.com eXist Solutions]. eXist Solutions directly support and further the development of eXist.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

In August 2011, a dedicated email list was created on using eXist with TEI resources. For information or to subscribe, go to the [https://lists.sourceforge.net/lists/listinfo/exist-teixml eXist-TEIXML] information page.

== Sample implementations ==
* [http://mapoflondon.uvic.ca/ The Map of Early Modern London] maps the streets, sites, and significant boundaries of late 16th-century and early 17th-century London.
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The correspondence, diaries, writings and works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ The Colonial Despatches of Vancouver Island and British Columbia 1846-1871] contains the original correspondence between the British Colonial Office and the colonies of Vancouver Island and British Columbia.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 2.0 revision 18252 - 2013-02-07

== How to download ==
Download the current stable version (version 2.1, July 2013) from the [http://www.exist-db.org/exist/apps/homepage/index.html#subscriptions eXist Home Page]; clone or download the current trunk version from [https://github.com/eXist-db/exist eXist GitHub Page].

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2013-07-04T13:42:14Z

Jensopetersen: /* Sample implementations */ Adding MoEML

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery-30/ XQuery 3.0], [http://www.w3.org/TR/xpath-30/ XPath 3.0], [http://www.w3.org/TR/xslt20/ XSLT 2.0] (based on [http://www.saxonica.com/ Saxon]), XForms 1.1 (based on [http://www.betterForm.de betterForm], [http://www.orbeon.com Orbeon] or [http://www.agencexml.com/xsltforms XSLTForms]) XProc, JSON and JSONP.

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://exquery.github.io/exquery/exquery-restxq-specification/restxq-1.0-specification.html RESTXQ], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The 1.4 version added a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

The [http://exist.sourceforge.net/download.html 2.0 version] completely redesigned the Security subsystem introducing Access Control Lists and multiple realm authentication, and also introduced a re-write of the WebDAV Server making it more widely compatible with clients. In addition hundreds of bugfixes and performance improvements have been made since the 1.4 release.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate, XSLT and XProc
* [http://xmldb-org.sourceforge.net/xapi/ XML:DB API]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Security Access Control Lists on Documents and Collections
* Optional multi-realm integration with LDAP and Active Directory
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.oracle.com JRE] >= 6. Being a Java application it can be used on most operating systems, including Windows, Linux, Mac OS X, Solaris and FreeBSD and it can be deployed in several ways, as a standalone server application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library embedded in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/licenses/lgpl-2.1.html GNU LGPL 2.1] license.

== Support for TEI ==
Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the Digital.Humanities@Oxford Summer School in 2011; see the [http://digital.humanities.ox.ac.uk/DHSS2011/sessions.html#xmldb session description, slides, and sample materials].

A TEI module called Matumi is distributed as an eXist application. Matumi is still under development. It requires eXist version 1.5 and is installed from within eXist's Package Reposistory. After installation, it can be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

Matumi is not a full-blown TEI module yet, but it has some notable features, such as the ability to browse by filtering texts and core parts of the markup. It contains faceted search feeding off the markup, making possible "translingual" searches that utilise references added to name forms. 

The app uses XQuery only.

Installation will store a number of basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present orientation of the app.

If you access through browsing, you can arrange the data by four criteria - books, entry title, subjects and names.

If you access through search, in order to retrieve some sample results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

There is a comprehensive discussion of optimising eXist/xQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As detailed above, eXist is itself written in the Java language. However, it enables complete applications to be created without writing any programming code, by just using only XQuery, XSLT, (X)HTML, CSS, XForms, XProc and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support for the Open Source product is provided mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

Commercial support, consultancy and training is also available from the creators of eXist through [http://www.existsolutions.com eXist Solutions]. eXist Solutions directly support and further the development of eXist.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

In August 2011, a dedicated email list was created on using eXist with TEI resources. For information or to subscribe, go to the [https://lists.sourceforge.net/lists/listinfo/exist-teixml eXist-TEIXML] information page.

== Sample implementations ==
* [http://mapoflondon.uvic.ca/ The Map of Early Modern London] maps the streets, sites, and significant boundaries of late 16th-century and early 17th-century London.
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The correspondence, diaries, writings and works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ The Colonial Despatches of Vancouver Island and British Columbia 1846-1871] contains the original correspondence between the British Colonial Office and the colonies of Vancouver Island and British Columbia.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 2.0 revision 18252 - 2013-02-07

== How to download ==
Download the current stable version (version 2.0, February 2013) from the [http://www.exist-db.org/exist/apps/homepage/index.html#subscriptions eXist Home Page]; check out the current trunk version from "svn co <nowiki>https://svn.code.sf.net/p/exist/code/trunk/eXist</nowiki>".

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

XPointer

2012-05-21T07:42:50Z

Jensopetersen: typo (I hope)

''For use cases where these techniques might be used, see [[Stand-off use cases]].''

The '''[http://www.w3.org/TR/xptr-framework/ XPointer Framework]''' is a collection of schemes (note: ''schemes'' not ''schemas'') that specify the method for addressing into the XML tree or help in this task. One end of its functionality overlaps with XPath, but the other allows one to address points and ranges inside elements, and this is often precious to us TEI-ers, especially in some [[stand-off markup]] systems or for working with ontologies (RDF may use it). It was initially defined as a companion to [[XLink]] that took care of URI fragment identifiers (the strings placed after the '#' in a URI).

Some of the schemes, e.g. the simplest [http://www.w3.org/TR/xptr-element/ element() scheme], which uses simple tree-traversal syntax, are supported by any decent XML tool nowadays. It is worth pointing out that '''any tool that claims to support XInclude, must support the general conventions of the XPointer Framework and the XPointer element() scheme''' ([http://www.w3.org/TR/xinclude/#application per the XInclude spec]). The "general conventions" of the Framework mean, practically, the possibility of addressing elements by their IDs and the possibility of using multiple schemes in a single pointer (see [[#XPointer syntax|below]]).

Apart from element(), there is also the [http://www.w3.org/TR/xptr-xmlns/ xmlns() scheme] that does namespace binding, and finally the [http://www.w3.org/TR/xptr-xpointer/ xpointer() scheme] that does an incredible lot of useful things in a very clever way, except it's not supported in full anywhere.

The three schemes mentioned above have been defined or, in the case of xpointer(), drafted, by the W3C. The XPointer Framework, however, allows other parties to define their own schemes and get them registered in a special corner of the W3C called the [http://www.w3.org/2005/04/xpointer-schemes/ XPointer Registry]. And this is the point where we, as the TEI community, may want to focus some of our attention. Thanks to Syd Bauman, a number of [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html#SATSTEI-defined schemes] (described in the ''Linking and Alignment'' chapter of the Guidelines) have been registered with the W3C. One of them, [http://simonstl.com/ietf/draft-stlaurent-xpath-frag-01.txt xpath1()], is actually shared with other Internet communities, and implemented in Firefox (see [https://bugzilla.mozilla.org/show_bug.cgi?id=182323 bug #182323]). Another is smlxpath1() defined by the [http://www.w3.org/TR/sml/ Service Modeling Language]. Yet another is the string-range() scheme, one of the TEI-defined schemes that are useful in stand-off architecture and that may address into the content of elements.

== Structure of the XPointer Framework ==

The structure of the XPointer Framework is illustrated below:

<code>
XPointer Framework
. .
/ \
/ \
. .
syntax scheme repository
. .
/ \
/ \
. .
W3C schemes external-party (a.o. TEI) schemes
. . . . . .
/ | \ / | \
/ | \ / | \
. . . . . .
element() xmlns() xpointer() range() '''[http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html#SATSSR string-range()]''' ... xpath2()
. .
/ \
/ \
. .
XPath 1.0 functions XPointer functions
. . .
/ | \
/ | \
. . .
range-to() end-point() '''[http://www.w3.org/TR/xptr-xpointer/#stringrange string-range()]''' ...
</code>

Notice that '''string-range()''' is mentioned twice in the diagram above. This is because of an unfortunate homonymy that has generated some confusion in the past but, hopefully, will not do so any longer.

The XPointer xpointer() scheme uses [http://www.w3.org/TR/xpath#corelib XPath functions] and adds to them [http://www.w3.org/TR/xptr-xpointer/#xptr-functions several others], which, by entering the inter-character space, are able to cleverly address what no XPath has been able to address before. Among these functions is one called string-range().

Thus the difference between the W3C's <code>(location-set) string-range(location-set, string-to-match, offset?, length?)</code> '''function''' and the TEI's <code>(string) string-range(pointer, offset, length?)</code> '''scheme''' is not merely a difference in the definition, but also a difference in the status. There is at least one important consequence of this, worth bearing in mind: '''the status and implementation of TEI's schemes does not directly depend on the status and implementation of the xpointer() scheme'''. Of course, one can hope that the former may piggyback on the latter, from the perspective of software developers.

== XPointer syntax ==

The term "XPointer syntax" is used here informally. Its practical relevance is that it allows for two things: addressing by ID and using multiple pointers. Still informally, the syntax may be sketched as follows:

<pre>
Pointer ::= ID | SchemeBased
SchemeBased ::= PointerPart+</pre>

The first alternative allows for addressing by ID, reminiscent of HTML: <code>"resource.xml#ID"</code> (which may also use the element() scheme, as in <code>"resource.xml#element(ID)"</code>), and the other for sequencing schemes, as in the examples below:

#<code>"resource.xml#xpointer((//p)[1]) element(p1)"</code>
#<code>"resource.xml#xmlns(tei=<nowiki>http://www.tei-c.org/ns/1.0</nowiki>)xpointer(//tei:p[1])"</code>

The XPointer processor must evaluate such sequences from left to right and stop whenever it succeeds in making a match. This means that in the first case, ''if the scheme is recognized'', the processor tries to match the first of all elements that can be found in the document, and if it does not succeed, it moves to the second scheme and looks for the first element identified by the ID "p1". Notice that this setup makes it '''possible for us to use TEI-defined schemes with any processor, provided that we provide some kind of fallback''' as the last scheme. Does that buy us much? Hardly, but it's a step forward until the processor starts recognizing TEI schemes.

The second example sequence involves namespace binding: the xmlns() scheme binds the prefix, returns no result, so the processor moves to the next scheme and tries to make a match against, this time, a namespace-qualified element name.

The fact that the non-W3C schemes xpath1() and smlxpath1() are supported and in use ('''note:''' what are the tools that support them? -- need to find that out), makes it more likely for us to get the developers to plug in TEI-defined schemes into their tools. Of course these schemes have to be coded first, but that was obvious from the beginning.

Pushing the xpointer() scheme ahead might result in our being able to reuse the routines handling that scheme, which would reduce the work on TEI-scheme-handling.

Link to [[Xpath12match.xslt]]

----

'''Here I have to stop for a while'''

What follows is a mess for now.

== Lobbying section ==
(Refer to my unfinished essay on [[community efforts]] that will probably have to wait for after TEI-MM; this section is obviously also unfinished.)

=== libxml2 ===
[http://xmlsoft.org/index.html Libxml2] is to my knowledge the only XML toolkit that has rudimentary support for XPointer's xpointer() schema. In fact, the support is rather bad... but at least it is there and can be fixed and extended if the need for it can be demonstrated. (The trick with diploma works may also work here -- there is a separate XPointer module that the student can concentrate on, possibly having an eye on what is common in handling the xpointer() scheme and the TEI-defined schemes)

In fact, the TEI doesn't need the xpointer() scheme to be supported in xmllint (libxml2's parser) -- it just needs the general XPointer Framework to work (see the Addendum below for explanation).

'''This is a fragment of my e-mail, with some links in it, about the xpointer/xinclude stuff'''

Have to extract some bits from this fragment still.

<tt>
I searched for freely-available free-standing XPointer-aware tools
and found out that only libxml2 (with xmllint) comes reasonably close,
but its XPointer support is incomplete and buggy. I reported some of
that on TEI-L some time ago. Since then, libxml2 has seen two bugfix
releases, but the crucial functionality is still missing.

We have a colleague, Jakub Wilk, who did some bug-hunting and submitted
a few patches to libxml2 in his free time, but I guess both his free
time and patience have run out now (which I find perfectly understandable).

In case you were interested in pursuing this further, let me give you
some links as starters:

;"internal error, xpointer.c<nowiki>:</nowiki>2409" when using string-range():
:https://bugzilla.gnome.org/show_bug.cgi?id=562541

;Xpointer range-to function loses the end-point children:
:https://bugzilla.gnome.org/show_bug.cgi?id=306081

;buggy range() XPointer function:
:https://bugzilla.gnome.org/show_bug.cgi?id=584219

;buggy string-range() XPointer function:
:https://bugzilla.gnome.org/show_bug.cgi?id=583442

I tried to use the xpointer-schema string-range() function instead of
the TEI-defined string-range schema, but that was impossible for a
while, until this bug got fixed:

;unrecognized XPointer schemes are not skipped silently:
:https://bugzilla.gnome.org/show_bug.cgi?id=563562

(so there is a light...)

But that would require a few complications in the markup, to provide a
cascade of XPointer schemas, with the W3C schema as fallback until the
TEI-defined schemas are supported by some tool.
</tt>

Stand-off markup

2011-11-14T07:49:56Z

Jensopetersen: /* Granularity: addressing elements/tokens vs. addressing (spans of) characters */

'''Stand-off markup''' (also known as '''remote markup''' or '''stand-off annotation''') is the kind of markup that resides in a location different from the location of the data being described by it. It is thus the opposite of '''inline markup''', where data and annotations are intermingled within a single location.

== Analogy: annotating binary data ==

In the case of XML describing binary data, such as images or audio/video, this kind of system comes naturally, as it is impossible to store bits of binary files as element content in an XML file — in order for an XML annotation to be able to describe an image of a text or inscription that got scanned or photographed, a certain reference system is required (e.g. with pixels as individual units), together with pointers that create connections between elements in the XML file and areas of the image. Similarly with audio/video data, which you can index by the time axis, byte order, or within other appropriate reference systems.

This kind of annotation system can also be applied to texts: instead of mixing data and markup, the source text can be left as read-only (and thus secure and possibly even located on a remote server) and the markup that describes it can constitute a separate layer, linked to the original by appropriate pointers.

== Advantages ==

* separation of logical layers of annotation
* overlapping hierarchies
* text read-only or secured, annotations free (cf. ANC)
* etc.

== A bit of history ==
* CES, XCES, ANC

* CES image

* mention HyTime and the TEI's contribution to XLink?

* ISO, Ide+Romary (?)

* mention ATLAS (?)

== Current implementations ==

* ANC Tool (to aggregate XCES annotations, could it be customized?)

* mention libxml2 and xmllint as the only (?) '''free-standing''' parser that (almost) implements the entire XPointer framework (bugs + non-W3C schemes are not handled)

* mention TEI schemes defined at http://www.w3.org/2005/04/xpointer-schemes/

* mention, perhaps, the way to use the string-range() function of the xpointer() scheme

== Granularity: addressing elements/tokens vs. addressing (spans of) characters ==

* James's paper
* NKJP/Polish: catching ambiguities at sublexical level

When one does not want or need to address stand-off annotation at the sound or character level, an easy way to proceed is to build up a primary resource in TEI format, which is fully segmented at the word level (<w>, with IDs). Annotation files may in turn just refer to the corresponding IDs by means of a simple URL (http://www.myorganisation.org/myCorpus#w3425).

== Links ==
*Documentation
** [http://www.cs.vassar.edu/CES/CES1-5.html#ToCOview CES documentation]
** [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html#SASO TEI Guidelines, ch. 16.9]

* Tools that go some way towards creating/handling stand-off markup
** [http://www.cs.unibo.it/projects/xslt%2B%2B/XPointerTest.html XSLT++ Project: XPointer implementation]
** [http://www.huygensinstituut.knaw.nl/projects/editor EDITOR (the Edition as a Digital Instrument for Text-based Open Research)]
** [http://www.anc.org/tools/using-gate.html Gate for ANC] (not sure how it would handle TEI, separate plug-ins would be needed?)

* Related papers
** [http://www.computerphilologie.de/jg06/boot.html A SANE approach to annotation in the digital edition, by Peter Boot, ''Jahrbuch für Computerphilologie'' 8 (2006)]

[[category:Markup]]

Serna

2011-10-07T12:04:55Z

Jensopetersen: /* Language(s) */

[[Category:Tools]]

[[Category:Editing tools]]

== Synopsis ==
Serna provides a lightweight solution for students, open source developers, and other users to work with DITA, DocBook, TEI,and other popular XML formats. There are a few related products: Serna Enterprise (closed-source XML editor with a license fee), Serna SDK (for use with Serna Enterprise XML), and Serna Free (closed-source freeware).

== Features ==
See http://syntext.com/products/serna-feature-matrix/ .

== User commentary ==
'''Please sign all comments.'''

== System requirements ==
Available for Windows XP/Windows 7, Linux, and Mac OS X.

== Source code and licensing ==
See http://syntext.com/products/ .

== Support for TEI ==
Supports TEI P4 "out of the box".

== Language(s) ==
A Java application.

(What computer language is the tool written in?)
(What language(s) are used in the interface?)
(What language(s) are used in the documentation?)

== Documentation ==
http://syntext.com/support/documentation/

== Tech support ==
http://syntext.com/support/

== User community ==
http://syntext.com/support/forum.html

== Sample implementations ==

== Current version number and date of release ==
4.3 (2011-09-29)

== History of versions ==
* 4.1 (2009-03-12)
* 4.0 (2008-12-01)
* 3.8 (2008-07-28)
* 3.7 (2008-05-07)
* 3.6 (2008-03-19)

== How to download or buy ==
http://www.syntext.com/downloads/serna/

== Additional notes ==

Serna

2011-10-07T12:03:31Z

Jensopetersen: /* System requirements */

[[Category:Tools]]

[[Category:Editing tools]]

== Synopsis ==
Serna provides a lightweight solution for students, open source developers, and other users to work with DITA, DocBook, TEI,and other popular XML formats. There are a few related products: Serna Enterprise (closed-source XML editor with a license fee), Serna SDK (for use with Serna Enterprise XML), and Serna Free (closed-source freeware).

== Features ==
See http://syntext.com/products/serna-feature-matrix/ .

== User commentary ==
'''Please sign all comments.'''

== System requirements ==
Available for Windows XP/Windows 7, Linux, and Mac OS X.

== Source code and licensing ==
See http://syntext.com/products/ .

== Support for TEI ==
Supports TEI P4 "out of the box".

== Language(s) ==
(What computer language is the tool written in?)
(What language(s) are used in the interface?)
(What language(s) are used in the documentation?)

== Documentation ==
http://syntext.com/support/documentation/

== Tech support ==
http://syntext.com/support/

== User community ==
http://syntext.com/support/forum.html

== Sample implementations ==

== Current version number and date of release ==
4.3 (2011-09-29)

== History of versions ==
* 4.1 (2009-03-12)
* 4.0 (2008-12-01)
* 3.8 (2008-07-28)
* 3.7 (2008-05-07)
* 3.6 (2008-03-19)

== How to download or buy ==
http://www.syntext.com/downloads/serna/

== Additional notes ==

Serna

2011-10-07T11:58:04Z

Jensopetersen: /* Current version number and date of release */

[[Category:Tools]]

[[Category:Editing tools]]

== Synopsis ==
Serna provides a lightweight solution for students, open source developers, and other users to work with DITA, DocBook, TEI,and other popular XML formats. There are a few related products: Serna Enterprise (closed-source XML editor with a license fee), Serna SDK (for use with Serna Enterprise XML), and Serna Free (closed-source freeware).

== Features ==
See http://syntext.com/products/serna-feature-matrix/ .

== User commentary ==
'''Please sign all comments.'''

== System requirements ==

== Source code and licensing ==
See http://syntext.com/products/ .

== Support for TEI ==
Supports TEI P4 "out of the box".

== Language(s) ==
(What computer language is the tool written in?)
(What language(s) are used in the interface?)
(What language(s) are used in the documentation?)

== Documentation ==
http://syntext.com/support/documentation/

== Tech support ==
http://syntext.com/support/

== User community ==
http://syntext.com/support/forum.html

== Sample implementations ==

== Current version number and date of release ==
4.3 (2011-09-29)

== History of versions ==
* 4.1 (2009-03-12)
* 4.0 (2008-12-01)
* 3.8 (2008-07-28)
* 3.7 (2008-05-07)
* 3.6 (2008-03-19)

== How to download or buy ==
http://www.syntext.com/downloads/serna/

== Additional notes ==

Serna

2011-10-07T11:55:19Z

Jensopetersen: /* History of versions */

[[Category:Tools]]

[[Category:Editing tools]]

== Synopsis ==
Serna provides a lightweight solution for students, open source developers, and other users to work with DITA, DocBook, TEI,and other popular XML formats. There are a few related products: Serna Enterprise (closed-source XML editor with a license fee), Serna SDK (for use with Serna Enterprise XML), and Serna Free (closed-source freeware).

== Features ==
See http://syntext.com/products/serna-feature-matrix/ .

== User commentary ==
'''Please sign all comments.'''

== System requirements ==

== Source code and licensing ==
See http://syntext.com/products/ .

== Support for TEI ==
Supports TEI P4 "out of the box".

== Language(s) ==
(What computer language is the tool written in?)
(What language(s) are used in the interface?)
(What language(s) are used in the documentation?)

== Documentation ==
http://syntext.com/support/documentation/

== Tech support ==
http://syntext.com/support/

== User community ==
http://syntext.com/support/forum.html

== Sample implementations ==

== Current version number and date of release ==
4.1 (2009-03-12)

== History of versions ==
* 4.1 (2009-03-12)
* 4.0 (2008-12-01)
* 3.8 (2008-07-28)
* 3.7 (2008-05-07)
* 3.6 (2008-03-19)

== How to download or buy ==
http://www.syntext.com/downloads/serna/

== Additional notes ==

Critical Apparatus Workgroup

2011-09-10T15:24:32Z

Jensopetersen: /* Representing "verbose" apparatus */ typos, grammar

The [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/TC.html Critical Apparatus] workgroup is part of the TEI special interest group on manuscript [[SIG:MSS]].

Participants to the preliminary workgroup:

* Marjorie Burghart (MB)
* James Cummings (JC)
* Fotis Jannidis (FJ)
* Gregor Middell (GM)
* Dan O'Donnell (DOD)
* Espen Ore (EO)
* Elena Pierazzo (EP)
* Roberto Rosselli del Turco (RDT)
* Chris Wittern (CW)

Comments below from others:
* Pascale Sutter (PS)
* [[User:Stuartyeates|Stuart Yeates]] (SAY)

== “Critical Apparatus” vs. “Textual Variance” vs. “Textual Variants”==

The very name of the chapter, "Critical apparatus", is felt by some to be be a problem: the '''critical apparatus''' is just inherited from the printed world and one of the possible physical embodiment of '''textual variance'''. EP therefore proposes to use this new name, moving from "critical apparatus" to textual variance.

MB argues that, oddly, "textual variance" feels more restrictive to her than "critical apparatus": it is a notion linked with Cerquiglini's work, which does not correspond to '''every''' branch of textual criticism. On the other hand, strictly speaking, the "critical apparatus" is not limited to registering the variants of the several witnesses of a text. It also includes various kinds of notes (identification of the sources of the text, historical notes, etc.). Even texts with a single witness may have a critical apparatus. Maybe the problem with the name has its origins in the choice of giving the name "critical apparatus" to a part of the guidelines dedicated solely to the registration of textual variants.

FJ argues that for German ears the concept of textual variance is not closely connected to a specific scholar.

MB proposes to use '''textual variants''' instead, since it focuses more on actual elements in the edition, when "variance" is nothing concrete but a phenomenon.

Side remarks by MB: this vocabulary question might prove sticky in the end. The <app> elements is named <app> because it is considered "an apparatus entry", so unless we end up recommending to change the elements names, the phrase "critical apparatus" will still be used in the module, at least to explain the tag names?

RDT argues that while backward compatibility is clearly a bonus, as MB states <app> stands for 'apparatus entry': we shouldn't be afraid to change its function, for instance making it a container instead of a phrase level element. RDT stresses that he is proposing this by way of example, and to stress that our focus is on variants: these might then be organised in <app>s for traditional CA display, and/or in other, new ways for electronic display. Note that this might mean no traditional critical apparatus in a digital edition.

MB: It is characteristic of a print-based approach to encoding that the <app> element was considered as encoding an apparatus entry (hence the <app> name), when what it really encodes is a locus where different witnesses have variant readings (whch would probably have justified a name along the lines of <locus> or whatnot).

JC: Thinks this points to a slight divergent nature at the heart of the current critical apparatus recommendations. That of encoding an apparatus at the site of textual variance and encoding a structured view of a note entirely separate from the edited version of texts. (In mass digitization of critical editions, for example, one might have an <app> in a set of notes at the bottom of the page which are not encoded at the site of variance, or indeed necessarily connected with it.) It is this striving to both be able to encode all sorts of various legacy forms of apparatus as well as simultaneously catering for those who are recording the structure by which they will generate an apparatus in producing some output. So JC would argue that the first of these are apparatus and the second of these is a site/locus of textual variance.

SAY: Prefers either '''textual variants''' or '''textual variance''' over '''Critical Apparatus''' simply because I believe their meaning is clearer to a larger proportion of English speaking people. Clear meanings help us inter-operate with other groups and standards by making our standard easier to read by third parties.

== Issues ==

Preliminary notice: most of the issues raised here are connected with the parallel segmentation method, not because it is the more flawed, but because it is the more used by the members of this group. While location-referenced and double-end-point-attachment might be useful for mass conversion of printed material (for the former) and/or when using a piece of software handling the encoding (for the latter), the parallel segmentation method seems to be the easiest and more powerful way to encode the critical apparatus "by hand".

Also, one might point out that most of the issues raised here might be solved with standoff encoding. But this is extremely cumbersome to handle without the aid of a software, and it does not correspond to the way most people work.

=== Specific phenomena ===

==== Transpositions ====

In a nutshell: with the parallel segmentation method, it is often cumbersome to render transpositions.

Additionally it is not possible to mark them up explicitly. [http://juxtasoftware.org/ Juxta] for example works around that by storing transposition data in a custom XML format:

<pre>
<moves>
<move doc1="1855 MS" space1="original" start1="9679" end1="10462" doc2="1881 1st Ed." space2="original" start2="9872" end2="10467" />
<move doc1="1855 MS" space1="original" start1="9679" end1="10483" doc2="1870 2nd Ed." space2="original" start2="7781" end2="8376" />
<move doc1="1855 MS" space1="original" start1="9679" end1="10504" doc2="1870 Proof" space2="original" start2="8458" end2="9056" />
<move doc1="1855 MS" space1="original" start1="9886" end1="10525" doc2="1870 1st Ed." space2="original" start2="8546" end2="9141" />
<move doc1="1870 Proof" space1="original" start1="1640" end1="1850" doc2="1881 1st Ed." space2="original" start2="2961" end2="3070" />
</moves>
</pre>

Neither is this TEI-compliant, nor is the offset/range-based addressing (@start1/@start2 and @end1/@end2) proper XML markup. A standardized encoding would be helpful.

See also:

* http://tei.markmail.org/thread/fuszgtpnn2ywf6bh

==== Handling of punctuation ====

Seems to be a common problem in textual criticism/ apparatus creation, but lacks guidelines/ encoding examples:

* http://tei.markmail.org/thread/es6byhxpsbgkrxzo

==== Representing omissions in an apparatus ====

What's the proper way to represent missing lines/ paragraphs/ verses?

* http://tei.markmail.org/thread/parztmwmlx5mqsof
* http://tei.markmail.org/thread/4sheu6nji3dvnf64

=== Markup-related ===

==== Inclusion of structural markup in the apparatus ====

In a nutshell: the <app> element is phrase-level, when it really should be allowed to include paragraphs, and even <div>s.

Use case:

<blockquote style="background:#FFEAEA">I'm encoding a 19th c. edition of a medieval text, and one of the witness has omissions of several paragraphs. Of course, the TEI schema
won't let me put elements inside an <app>/<lem> element... 

- I use the parallel segmentation method 
- It is important to me to keep a methodical link between the encoded
apparatus and the notes numbers in the original edition (the
@n of each <app> tag bears the number of the footnote in the original
edition) 

Here is the [http://baluze.univ-avignon.fr/scan/t1/%285%29.jpg scan of a page from this edition], please consider footnote number 9.
The note contains: "9. Eodem anno, rex Francie… dampnificati, paragraphes omis par Bal.", meaning that the ''Bal.'' witness has an omission where other witnesses have two long paragraphs, the first one beginning on the previous page (see the [http://baluze.univ-avignon.fr/scan/t1/%284%29.jpg previous page scanned]).
</blockquote>

* http://tei.markmail.org/thread/tbzi2yj5xd4dto34

Another use case:

We have several witnesses of a poem, and in our base text, we have 8 stanzas, in another version only 6 stanzas and in some other 7? We are not allowed to have an <lg> and not even an <l> element within the <app> entry. So, we must put it the other way round, which may be somewhat awkward, like this:

<l>
<app>
<rdg wit="#A"> [the text of the verse line here] </rdg>
<rdg wit="#B"/>
<rdg wit="#C"/>
</app>
</l>

We should then repeat this for every <l> , while it would be more practical to "say" this only once for entire stanza (with an <lg> within a <rdg> ).

* Source: http://marjorie.burghart.online.fr/?q=en/content/tei-critical-apparatus-cheatsheet#comment-15

More use cases from TEI-L:

* http://tei.markmail.org/thread/jyezaqfycaldtdcv
* http://tei.markmail.org/thread/fbyuxyabbxq4rwbr
* http://tei.markmail.org/thread/vrwkl7kkruulyjzh
* http://tei.markmail.org/thread/x5agpwzn4hiwwwcx

==== Encoding variants in structural markup ====

* http://tei.markmail.org/thread/ap62n37uf6rbfds4
* http://tei.markmail.org/thread/hbmnsn3v4aqjabt3

==== Conflicts between individual readings and the semantics of structural markup that surrounds it ====

In a nutshell: with the parallel segmentation method, witnesses with different forms of lineation pose a problem.

=== Workflow-related ===

==== Scalability ====

In a nutshell: the parallel segmentation method is difficult to handle when adding hundreds of conflicting witnesses.

<blockquote style="background:#FFEAEA">
Scaling is generally a problem with methods of indicating textual variance, but in parallel segmentation this is exacerbated because as the number of witnesses increase, the likelihood of needing to reformulate the reading boundaries, never mind the difficulty in reading or understanding such encodings. This may be a problem not only when looking at a single text with many witnesses, where variation in structure may be extremely difficult to represent where conflicts occur which disrupt this very basic structure (for example, imagine a set of witnesses where some have lines in linegroups, some just lines, some paragraphs, some paragraphs in divisions, but all with the same underlying text). But also where parallel segmentation is being used to record divergent interpretations of these individual witnesses by many editors (for distributed co-operative editions generated from many editorial views of a text). A plausible recommendation is to use a form of stand-off apparatus for such editions rather than parallel segmentation. And while some of the current methods can be used in a stand-off method, they should be updated to reflect current P5 usage of URI-based pointers.
</blockquote>

==== Refactoring ====

In a nutshell: with the the parallel segmentation method, it is cumbersome to add a new reading that necessitates changing where the borders of readings are drawn.

==== Complexity ====

Manually crafting an apparatus is error-prone:

* http://tei.markmail.org/thread/yuxqotf5aynxznq5

==== Feasibility of double-endpoint-attached method ====

* http://tei.markmail.org/thread/fsj7gvojds4mwcm5
* http://tei.markmail.org/thread/flwcnf4fxm4u7ebj

=== Model vs. Representation ===

==== Showing a lemma different from the content of the <lem> or chosen reading in an apparatus note ====

In a nutshell: depending on the desired output of your digital edition, you may need to show in the apparatus entry a lemma text different from the content of the <lem> or desired <rdg>. This is typically the case for long omissions, when one does not display the full text that is omitted by one or more witnesses, but only the beginning and end of the omitted span of text.

Use case:
<blockquote style="background:#FFEAEA">Let's consider again the example used in a previous use case:
Here is the [http://baluze.univ-avignon.fr/scan/t1/%285%29.jpg scan of a page from this edition], please consider footnote number 9.
The note contains: "9. Eodem anno, rex Francie… dampnificati, paragraphes omis par Bal.", meaning that the ''Bal.'' witness has an omission where other witnesses have two long paragraphs, the first one beginning on the previous page (see the [http://baluze.univ-avignon.fr/scan/t1/%284%29.jpg previous page scanned]).
 
You certainly do not want to generate a footnote with these two full paragraphs to tell the reader that one witness omits them, but on the other hand you want to be able to represent the source according to its various witnesses, so location-referenced is not in order.
</blockquote>

Possible workaround: add a new possible child to <add>, indicating how the content of the <lem> should be dislayed; something like:

<app>
<lemDisplay>Eodem anno, rex Francie… dampnificati</lemDisplay>
<lem>[several lines or paragraphs]</lem>
<rdg wit="#V"></rdg>
</app>

==== Representing "verbose" apparatus ====

In a nutshell: when you want to represent an apparatus entry written in a rather verbose way (in a print-to-digital edition). The same is true if you want to be able to generate a verbose apparatus note in a "born digital" edition.

Use cases:
<blockquote style="background:#FFEAEA">You're encoding an existing edition, and want to represent the source it edits, while keeping intact the text / apparatus of the existing edition. Some apparatus entries are easy to represent with the <app> / <lem> / <rdg> elements, some others add editorial comments to the listing of the variants, and are quite difficult to represent. BTW, the same goes when you are encoding a born-digital edition for which you want to be able to generate an alternative print output corresponding to the traditional standards of a collection.
 
A - When I have a footnote giving two lectiones from the same manuscript, one before correction and the other after: 
Text: ad lectorem Venetum (b) .
 
Note: b) ms., lectionem venerum corrigé postérieurement en lectorem Venetum
 
 
If I encode it like this, with two separate rdg for the same
witness, each with a different @type (for instance, "anteCorr" and
"postCorr"), it gives an accurate account of the state of the witness, BUT it is an
interpretation of the original note in the critical apparatus, i.e. if
I do this I delete some text added by the original editor. 

<app n="b">
 
<lem>lectorem Venetum</lem>
 
<rdg wit="#ms.2" type="anteCorr">lectionem venerum</rdg>
 
<rdg wit="#ms.2" type="postCorr">lectorem Venetum</rdg>

 
</app>
</blockquote>

 

<blockquote style="background:#FFEAEA">
Let's consider this other note. There is some text added verbosely within the apparatus note by the editor. 
Text: Hiis diebus civitas
Pergamensis(b) tenebat exersitum 
Note: b) se, mis indûment avant tenebat par le ms.

Should I encode it as: 
... Pergamensis <app
n="b"> 
    <lem/> 
    <rdg
type="addition" wit="#ms"><sic>se</sic></rdg> 
</app>... 


If one represents this note strictly with the <app> / <rdg>, it leads to the suppression of remarks by the original editor. Adding a note in the rdg to preserve the editor's comments could work here, but it's not always the case 
Like: 
... Pergamensis <app
n="b"> 
    <lem/> 
    <rdg
type="addition" wit="#ms"><sic>se</sic> <note><hi
rend="italics">mis
indûment avant</hi> tenebat.</note></rdg> 

</app>
</blockquote>

 

<blockquote style="background:#FFEAEA">
'''Text''': …reliqui demum meos socios (d) 
'''Note''': d) domum
meam solito, Bal.; dni ou dm, ms.; en note meam solita.

Here we have 2 witnesses (Bal. et ms.), the latter with a) an uncertain
lectio ("dni" or "dm") and b) a part of the lectio which is written as
a note ("meam solita"). This is tricky to encode.
</blockquote>

See also:

* http://tei.markmail.org/thread/ib3bsrpirepp4ibc
* http://tei.markmail.org/thread/diubpw5adw6ntcas

==== Representation of suggestions by the editor: ''lege'' ''dele'' etc. ====

In a nutshell: Sometimes, the editor provides working suggestions through apparatus notes such as ''lege(ndum)'' ("read"), ''dele(ndum)'' ("delete)" etc. They do not belong in the textual variants ''per se'', and are not attached to witnesses, although they do belong in the critical apparatus.

* http://tei.markmail.org/thread/vfw25psb5vgdiftw

==== Collations of differing granularity ====

* http://tei.markmail.org/thread/bonflsyb2d3ebtp2
* http://tei.markmail.org/thread/gqyymzd4a4xvhch7

== An encoding proposal from the perspective of computer-aided collation tools ==

Gregor Middell gave an overview of textual variance from a software developer's perspective for the workgroup on a [[Textual_Variance|separate page]]. The models described there are used in tools like [http://collatex.sourceforge.net/ CollateX], [http://www.juxtasoftware.org/ Juxta] and [http://code.google.com/p/multiversiondocs/ nmerge].

Collecting ideas from the mailinglist by James Cummings, Dan O'Donnell and Marjorie Burghart as well as following the [[Textual_Variance|“Gothenburg model” of textual variance]], a first take at separating the [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller model from the representation] of textual variance could be structured as follows.

=== Modelling input data: Make the units of a collation addressable in the witnesses ===

The Gothenburg model assumes a [[Textual_Variance#Tokenizer|preprocessing step]] by which the witnesses get split up into '''tokens''' of desired granularity. This granularity becomes the minimal unit of collation and can defined as pages, paragraphs, verses, lines, words, characters or any other unit that makes sense in the context of a particular tradition under investigation. To model collation results on top of tokenized witnesses, those tokens have to be addressable.

The TEI defines an [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html#SAXP array of pointing mechanisms], which can be used to address anything from a whole XML document via URIs down to arbitrary content of those documents via sophisticated XPointer schemes. Projects would be free to choose among those mechanisms as long as each token is made available for later reference.

Examples:

<pre>

<w>The</w> <w>cat</w> <w>ate</w> <w>the</w> <w>food</w> <w>quickly</w>.

</pre>

<pre>

<w>Quickly</w>, <w>the</w> <w>cat</w> <w>ate</w> <w>the</w> <w>food</w>.

</pre>

Here tokens on the word-level could be addressed via the [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html#SATSXP xpath1() XPointer scheme]:

# <nowiki>http://edition.org/witness_1#xpath1(/p[1]/w[1])</nowiki>
# <nowiki>http://edition.org/witness_1#xpath1(/p[1]/w[2])</nowiki>
# ...

A less verbose scheme would rely on each container element of a token being identified via a (possibly autogenerated) <code>xml:id</code> attribute, like in the following verse-level tokenization.

<pre>
<lg xml:base="urn:goethe:faust2">
<l xml:id="l_1">Die Sonne sinkt, die letzten Schiffe</l>
<l xml:id="l_2">Sie ziehen munter hafenein.</l>
<l xml:id="l_3">Ein großer Kahn ist im Begriffe</l>
<l xml:id="l_4">Auf dem Canale hier zu sein.</l>
</lg>
</pre>

# <nowiki>urn:goethe:faust2#l_1</nowiki>
# <nowiki>urn:goethe:faust2#l_2</nowiki>
# ...

One can even think of reference schemes, which are as independent of existing markup as possible. By introducing <anchor/> milestone elements at token boundaries and using the [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html#SATSRN range() XPointer scheme] the tokenization of arbitrary TEI documents can be accomplished, because <anchor/> is part of [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-model.global.html model.global].

=== Modelling collated data: Encode the alignment/linking between tokens ===

After tokens in the different witnesses have been made addressable, collation data can be modelled on top of that as [[Textual_Variance#Aligner|alignments of tokens]]. An '''alignment''' can be expressed as a set of tokens from different witnesses or, in accordance with the [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html corresponding guidelines chapter] as a link between two or more tokens.

Taking the first example from above, a collation of the two given witnesses could be expressed as

<pre>
<linkGrp type="collation" xml:base="http://edition.org/">
<link target="witness_1#xpath1(/p[1]/w[1]) witness_2#xpath1(/p[1]/w[2])" />
<link target="witness_1#xpath1(/p[1]/w[2]) witness_2#xpath1(/p[1]/w[3])" />
<link target="witness_1#xpath1(/p[1]/w[3]) witness_2#xpath1(/p[1]/w[4])" />
<link target="witness_1#xpath1(/p[1]/w[4]) witness_2#xpath1(/p[1]/w[5])" />
<link target="witness_1#xpath1(/p[1]/w[5]) witness_2#xpath1(/p[1]/w[6])" />
<link target="witness_1#xpath1(/p[1]/w[6]) witness_2#xpath1(/p[1]/w[1])" type="transposition" />
</linkGrp>
</pre>

Each link in this example corresponds to a row in an alignment table as depicted in the Gothenburg model description. Omitted/ added tokens are expressed implictly by not linking to tokens in other witnesses, this is to say: Whether a set of tokens has been added to a witness or has been omitted from it, is a matter of interpreting collation data as expressed above from the perspective of one witness or another and with regard to the way, this witness aligns with others.

One advantage of encoding collation data in such a set-oriented way is its '''scalability''':

# Gradually adding witnesses to the collation may amount to adding alignments to the existing ones or modifying/augmenting the latter, depending on whether the collation is done pairwise (e. g. in relation to a base text) or via multiple alignment (e. g. without a prechosen base).
# Guiding a collation tool in producing ever more precise aligments in consecutive runs can be achieved by [[Textual_Variance#Analyzer|declaring alignments]] (for example transpositions), feeding those into the collator, adjusting the resulting alignment set, feeding it back into the collator for another run and so forth. Being able to encode the initial/preliminary results of such an iterative process in a standardized way, makes it possible to run different collation tools on the same text tradition, ideally each being able to make use of former results by other tools and to contribute to the overall result.

The major disadvantage of encoding collation data this way is its apparant lack of human readability and that it is hardly possible to edit it by hand, especially when the collated text tradition grows larger. This problem can only be solved via tool support.

=== Encoding the interpretation/ representation: Derive an apparatus from the collation ===

A TEI-encoded critical apparatus is one possible rendition of collation data, possibly enhanced with information yielded from interpreting the alignments. There are a couple of ways how we could encode the above collation as an apparatus.

==== Apparatus pointing to the collated tokens (for easier post-processing) ====

<pre>
<app>
<rdg wit="http://edition.org/witness_1" xml:base="http://edition.org/witness_1" />
<rdg wit="http://edition.org/witness_2" xml:base="http://edition.org/witness_2" xml:id="w2_1">
<ptr target="#xpath1(/p[1]/w[1])" />
</rdg>
</app>
<app>
<rdg wit="http://edition.org/witness_1" xml:base="http://edition.org/witness_1">
<ptr target="#xpath1(/p[1]/w[1])" />
<ptr target="#xpath1(/p[1]/w[2])" />
<ptr target="#xpath1(/p[1]/w[3])" />
<ptr target="#xpath1(/p[1]/w[4])" />
<ptr target="#xpath1(/p[1]/w[5])" />
</rdg>
<rdg wit="http://edition.org/witness_2" xml:base="http://edition.org/witness_2">
<ptr target="#xpath1(/p[1]/w[2])" />
<ptr target="#xpath1(/p[1]/w[3])" />
<ptr target="#xpath1(/p[1]/w[4])" />
<ptr target="#xpath1(/p[1]/w[5])" />
<ptr target="#xpath1(/p[1]/w[6])" />
</rdg>
</app>
<app>
<rdg wit="http://edition.org/witness_1" xml:base="http://edition.org/witness_1" corresp="#w2_1">
<ptr target="#xpath1(/p[1]/w[6])" />
</rdg>
<rdg wit="http://edition.org/witness_2" xml:base="http://edition.org/witness_2" />
</app>
</pre>

==== Apparatus with embedded textual content (for readability) ====

<pre>
<app>
<rdg wit="http://edition.org/witness_1" />
<rdg wit="http://edition.org/witness_2" xml:id="w2_1">Quickly,</rdg>
</app>
<app>
<rdg wit="http://edition.org/witness_1">The cat ate the food</rdg>
<rdg wit="http://edition.org/witness_2">the cat ate the food.</rdg>
</app>
<app>
<rdg wit="http://edition.org/witness_1" corresp="#w2_1">quickly.</rdg>
<rdg wit="http://edition.org/witness_2" />
</app>
</pre>

Some problems here:

* @corresp vs. <link/> for transpositions over more than two witnesses
* How to derive the segment content from the original witness automatically, if the token content does not add up to it (e. g. because of punctuation being excluded from the tokens from the start)?

== Bibliography ==

* O'Donnell, Daniel Paul. [http://etjanst.hb.se/bhs/ith/1-8/dpo.pdf “The Ghost in the Machine: Revisiting an Old Model for the Dynamic Generation of Digital Editions.”] HumanIT 8.1 (2005): 5171.
* Vetter, L. and McDonald, J. ‘Witnessing Dickinson’s Witnesses’, Literary and Linguistic Computing, 18.2: 2003, 151-165.
* [http://eprints.qut.edu.au/38436/ Schmidt, D., 2010. The inadequacy of embedded markup for cultural heritage texts. Literary and Linguistic Computing, 25(3), pp. 337-356.]

[[Category:SIG:Manuscripts]]
[[Category:Critical Apparatus]]

Critical Apparatus Workgroup

2011-09-10T15:16:11Z

Jensopetersen: /* “Critical Apparatus” vs. “Textual Variance” vs. “Textual Variants” */ typo

The [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/TC.html Critical Apparatus] workgroup is part of the TEI special interest group on manuscript [[SIG:MSS]].

Participants to the preliminary workgroup:

* Marjorie Burghart (MB)
* James Cummings (JC)
* Fotis Jannidis (FJ)
* Gregor Middell (GM)
* Dan O'Donnell (DOD)
* Espen Ore (EO)
* Elena Pierazzo (EP)
* Roberto Rosselli del Turco (RDT)
* Chris Wittern (CW)

Comments below from others:
* Pascale Sutter (PS)
* [[User:Stuartyeates|Stuart Yeates]] (SAY)

== “Critical Apparatus” vs. “Textual Variance” vs. “Textual Variants”==

The very name of the chapter, "Critical apparatus", is felt by some to be be a problem: the '''critical apparatus''' is just inherited from the printed world and one of the possible physical embodiment of '''textual variance'''. EP therefore proposes to use this new name, moving from "critical apparatus" to textual variance.

MB argues that, oddly, "textual variance" feels more restrictive to her than "critical apparatus": it is a notion linked with Cerquiglini's work, which does not correspond to '''every''' branch of textual criticism. On the other hand, strictly speaking, the "critical apparatus" is not limited to registering the variants of the several witnesses of a text. It also includes various kinds of notes (identification of the sources of the text, historical notes, etc.). Even texts with a single witness may have a critical apparatus. Maybe the problem with the name has its origins in the choice of giving the name "critical apparatus" to a part of the guidelines dedicated solely to the registration of textual variants.

FJ argues that for German ears the concept of textual variance is not closely connected to a specific scholar.

MB proposes to use '''textual variants''' instead, since it focuses more on actual elements in the edition, when "variance" is nothing concrete but a phenomenon.

Side remarks by MB: this vocabulary question might prove sticky in the end. The <app> elements is named <app> because it is considered "an apparatus entry", so unless we end up recommending to change the elements names, the phrase "critical apparatus" will still be used in the module, at least to explain the tag names?

RDT argues that while backward compatibility is clearly a bonus, as MB states <app> stands for 'apparatus entry': we shouldn't be afraid to change its function, for instance making it a container instead of a phrase level element. RDT stresses that he is proposing this by way of example, and to stress that our focus is on variants: these might then be organised in <app>s for traditional CA display, and/or in other, new ways for electronic display. Note that this might mean no traditional critical apparatus in a digital edition.

MB: It is characteristic of a print-based approach to encoding that the <app> element was considered as encoding an apparatus entry (hence the <app> name), when what it really encodes is a locus where different witnesses have variant readings (whch would probably have justified a name along the lines of <locus> or whatnot).

JC: Thinks this points to a slight divergent nature at the heart of the current critical apparatus recommendations. That of encoding an apparatus at the site of textual variance and encoding a structured view of a note entirely separate from the edited version of texts. (In mass digitization of critical editions, for example, one might have an <app> in a set of notes at the bottom of the page which are not encoded at the site of variance, or indeed necessarily connected with it.) It is this striving to both be able to encode all sorts of various legacy forms of apparatus as well as simultaneously catering for those who are recording the structure by which they will generate an apparatus in producing some output. So JC would argue that the first of these are apparatus and the second of these is a site/locus of textual variance.

SAY: Prefers either '''textual variants''' or '''textual variance''' over '''Critical Apparatus''' simply because I believe their meaning is clearer to a larger proportion of English speaking people. Clear meanings help us inter-operate with other groups and standards by making our standard easier to read by third parties.

== Issues ==

Preliminary notice: most of the issues raised here are connected with the parallel segmentation method, not because it is the more flawed, but because it is the more used by the members of this group. While location-referenced and double-end-point-attachment might be useful for mass conversion of printed material (for the former) and/or when using a piece of software handling the encoding (for the latter), the parallel segmentation method seems to be the easiest and more powerful way to encode the critical apparatus "by hand".

Also, one might point out that most of the issues raised here might be solved with standoff encoding. But this is extremely cumbersome to handle without the aid of a software, and it does not correspond to the way most people work.

=== Specific phenomena ===

==== Transpositions ====

In a nutshell: with the parallel segmentation method, it is often cumbersome to render transpositions.

Additionally it is not possible to mark them up explicitly. [http://juxtasoftware.org/ Juxta] for example works around that by storing transposition data in a custom XML format:

<pre>
<moves>
<move doc1="1855 MS" space1="original" start1="9679" end1="10462" doc2="1881 1st Ed." space2="original" start2="9872" end2="10467" />
<move doc1="1855 MS" space1="original" start1="9679" end1="10483" doc2="1870 2nd Ed." space2="original" start2="7781" end2="8376" />
<move doc1="1855 MS" space1="original" start1="9679" end1="10504" doc2="1870 Proof" space2="original" start2="8458" end2="9056" />
<move doc1="1855 MS" space1="original" start1="9886" end1="10525" doc2="1870 1st Ed." space2="original" start2="8546" end2="9141" />
<move doc1="1870 Proof" space1="original" start1="1640" end1="1850" doc2="1881 1st Ed." space2="original" start2="2961" end2="3070" />
</moves>
</pre>

Neither is this TEI-compliant, nor is the offset/range-based addressing (@start1/@start2 and @end1/@end2) proper XML markup. A standardized encoding would be helpful.

See also:

* http://tei.markmail.org/thread/fuszgtpnn2ywf6bh

==== Handling of punctuation ====

Seems to be a common problem in textual criticism/ apparatus creation, but lacks guidelines/ encoding examples:

* http://tei.markmail.org/thread/es6byhxpsbgkrxzo

==== Representing omissions in an apparatus ====

What's the proper way to represent missing lines/ paragraphs/ verses?

* http://tei.markmail.org/thread/parztmwmlx5mqsof
* http://tei.markmail.org/thread/4sheu6nji3dvnf64

=== Markup-related ===

==== Inclusion of structural markup in the apparatus ====

In a nutshell: the <app> element is phrase-level, when it really should be allowed to include paragraphs, and even <div>s.

Use case:

<blockquote style="background:#FFEAEA">I'm encoding a 19th c. edition of a medieval text, and one of the witness has omissions of several paragraphs. Of course, the TEI schema
won't let me put elements inside an <app>/<lem> element... 

- I use the parallel segmentation method 
- It is important to me to keep a methodical link between the encoded
apparatus and the notes numbers in the original edition (the
@n of each <app> tag bears the number of the footnote in the original
edition) 

Here is the [http://baluze.univ-avignon.fr/scan/t1/%285%29.jpg scan of a page from this edition], please consider footnote number 9.
The note contains: "9. Eodem anno, rex Francie… dampnificati, paragraphes omis par Bal.", meaning that the ''Bal.'' witness has an omission where other witnesses have two long paragraphs, the first one beginning on the previous page (see the [http://baluze.univ-avignon.fr/scan/t1/%284%29.jpg previous page scanned]).
</blockquote>

* http://tei.markmail.org/thread/tbzi2yj5xd4dto34

Another use case:

We have several witnesses of a poem, and in our base text, we have 8 stanzas, in another version only 6 stanzas and in some other 7? We are not allowed to have an <lg> and not even an <l> element within the <app> entry. So, we must put it the other way round, which may be somewhat awkward, like this:

<l>
<app>
<rdg wit="#A"> [the text of the verse line here] </rdg>
<rdg wit="#B"/>
<rdg wit="#C"/>
</app>
</l>

We should then repeat this for every <l> , while it would be more practical to "say" this only once for entire stanza (with an <lg> within a <rdg> ).

* Source: http://marjorie.burghart.online.fr/?q=en/content/tei-critical-apparatus-cheatsheet#comment-15

More use cases from TEI-L:

* http://tei.markmail.org/thread/jyezaqfycaldtdcv
* http://tei.markmail.org/thread/fbyuxyabbxq4rwbr
* http://tei.markmail.org/thread/vrwkl7kkruulyjzh
* http://tei.markmail.org/thread/x5agpwzn4hiwwwcx

==== Encoding variants in structural markup ====

* http://tei.markmail.org/thread/ap62n37uf6rbfds4
* http://tei.markmail.org/thread/hbmnsn3v4aqjabt3

==== Conflicts between individual readings and the semantics of structural markup that surrounds it ====

In a nutshell: with the parallel segmentation method, witnesses with different forms of lineation pose a problem.

=== Workflow-related ===

==== Scalability ====

In a nutshell: the parallel segmentation method is difficult to handle when adding hundreds of conflicting witnesses.

<blockquote style="background:#FFEAEA">
Scaling is generally a problem with methods of indicating textual variance, but in parallel segmentation this is exacerbated because as the number of witnesses increase, the likelihood of needing to reformulate the reading boundaries, never mind the difficulty in reading or understanding such encodings. This may be a problem not only when looking at a single text with many witnesses, where variation in structure may be extremely difficult to represent where conflicts occur which disrupt this very basic structure (for example, imagine a set of witnesses where some have lines in linegroups, some just lines, some paragraphs, some paragraphs in divisions, but all with the same underlying text). But also where parallel segmentation is being used to record divergent interpretations of these individual witnesses by many editors (for distributed co-operative editions generated from many editorial views of a text). A plausible recommendation is to use a form of stand-off apparatus for such editions rather than parallel segmentation. And while some of the current methods can be used in a stand-off method, they should be updated to reflect current P5 usage of URI-based pointers.
</blockquote>

==== Refactoring ====

In a nutshell: with the the parallel segmentation method, it is cumbersome to add a new reading that necessitates changing where the borders of readings are drawn.

==== Complexity ====

Manually crafting an apparatus is error-prone:

* http://tei.markmail.org/thread/yuxqotf5aynxznq5

==== Feasibility of double-endpoint-attached method ====

* http://tei.markmail.org/thread/fsj7gvojds4mwcm5
* http://tei.markmail.org/thread/flwcnf4fxm4u7ebj

=== Model vs. Representation ===

==== Showing a lemma different from the content of the <lem> or chosen reading in an apparatus note ====

In a nutshell: depending on the desired output of your digital edition, you may need to show in the apparatus entry a lemma text different from the content of the <lem> or desired <rdg>. This is typically the case for long omissions, when one does not display the full text that is omitted by one or more witnesses, but only the beginning and end of the omitted span of text.

Use case:
<blockquote style="background:#FFEAEA">Let's consider again the example used in a previous use case:
Here is the [http://baluze.univ-avignon.fr/scan/t1/%285%29.jpg scan of a page from this edition], please consider footnote number 9.
The note contains: "9. Eodem anno, rex Francie… dampnificati, paragraphes omis par Bal.", meaning that the ''Bal.'' witness has an omission where other witnesses have two long paragraphs, the first one beginning on the previous page (see the [http://baluze.univ-avignon.fr/scan/t1/%284%29.jpg previous page scanned]).
 
You certainly do not want to generate a footnote with these two full paragraphs to tell the reader that one witness omits them, but on the other hand you want to be able to represent the source according to its various witnesses, so location-referenced is not in order.
</blockquote>

Possible workaround: add a new possible child to <add>, indicating how the content of the <lem> should be dislayed; something like:

<app>
<lemDisplay>Eodem anno, rex Francie… dampnificati</lemDisplay>
<lem>[several lines or paragraphs]</lem>
<rdg wit="#V"></rdg>
</app>

==== Representing "verbose" apparatus ====

In a nutshell: when you want to represent an apparatus entry written in a rather verbose way (in a print-to-digital edition). The same is true if you want to be able to generate a verbose apparatus note in a "born digital" edition.

Use cases:
<blockquote style="background:#FFEAEA">You're encoding an existing edition, and want to represent the source it edits, while keeping intact the text / apparatus of the existing edition. Some apparatus entries are easy to represent with the <app> / <lem> / <rdg> elements, some others add editorial comments to the listing of the variants, and are quite difficult to represent. BTW, the same goes when you are encoding a born-digital edition for which you want to be able to generate an alternative print output corresponding to the traditional standards of a collection.
 
A - When I have a footnote giving two lectiones from the same manuscrip, one before correction and the other after: 
Text: ad lectorem Venetum (b) .
 
Note: b) ms., lectionem venerum corrigé postérieurement en lectorem Venetum
 
 
If I encode it like this, with two seprate rdg for the same
witness, each with a different @type (for instance, "anteCorr" and
"postCorr"), it gives an accurate account of the state of the witness, BUT it is an
interpretation of the original note in the critical apparatus, i.e. if
I do this I delete some text added by the original editor. 

<app n="b">
 
<lem>lectorem Venetum</lem>
 
<rdg wit="#ms.2" type="anteCorr">lectionem venerum</rdg>
 
<rdg wit="#ms.2" type="postCorr">lectorem Venetum</rdg>

 
</app>
</blockquote>

 

<blockquote style="background:#FFEAEA">
Let's consider this other note. There is some text added verbosely within the apparatus note by the editor. 
Text: Hiis diebus civitas
Pergamensis(b) tenebat exersitum 
Note: b) se, mis indûment avant tenebat par le ms.

Should I encode it as: 
... Pergamensis <app
n="b"> 
    <lem/> 
    <rdg
type="addition" wit="#ms"><sic>se</sic></rdg> 
</app>... 


I one represents this note strictly with the <app> / <rdg>, it leads to suppress remarks by the original editor. Adding a note in the rdg to preserve the editor's comments could work here, ut it's not always the case 
Like: 
... Pergamensis <app
n="b"> 
    <lem/> 
    <rdg
type="addition" wit="#ms"><sic>se</sic> <note><hi
rend="italics">mis
indûment avant</hi> tenebat.</note></rdg> 

</app>
</blockquote>

 

<blockquote style="background:#FFEAEA">
'''Text''': …reliqui demum meos socios (d) 
'''Note''': d) domum
meam solito, Bal.; dni ou dm, ms.; en note meam solita.

Here we have 2 witnesses (Bal. et ms.), the latter with a) an uncertain
lectio ("dni" or "dm") and b) a part of the lectio which is written as
a note ("meam solita"). This is tricky to encode.
</blockquote>

See also:

* http://tei.markmail.org/thread/ib3bsrpirepp4ibc
* http://tei.markmail.org/thread/diubpw5adw6ntcas

==== Representation of suggestions by the editor: ''lege'' ''dele'' etc. ====

In a nutshell: Sometimes, the editor provides working suggestions through apparatus notes such as ''lege(ndum)'' ("read"), ''dele(ndum)'' ("delete)" etc. They do not belong in the textual variants ''per se'', and are not attached to witnesses, although they do belong in the critical apparatus.

* http://tei.markmail.org/thread/vfw25psb5vgdiftw

==== Collations of differing granularity ====

* http://tei.markmail.org/thread/bonflsyb2d3ebtp2
* http://tei.markmail.org/thread/gqyymzd4a4xvhch7

== An encoding proposal from the perspective of computer-aided collation tools ==

Gregor Middell gave an overview of textual variance from a software developer's perspective for the workgroup on a [[Textual_Variance|separate page]]. The models described there are used in tools like [http://collatex.sourceforge.net/ CollateX], [http://www.juxtasoftware.org/ Juxta] and [http://code.google.com/p/multiversiondocs/ nmerge].

Collecting ideas from the mailinglist by James Cummings, Dan O'Donnell and Marjorie Burghart as well as following the [[Textual_Variance|“Gothenburg model” of textual variance]], a first take at separating the [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller model from the representation] of textual variance could be structured as follows.

=== Modelling input data: Make the units of a collation addressable in the witnesses ===

The Gothenburg model assumes a [[Textual_Variance#Tokenizer|preprocessing step]] by which the witnesses get split up into '''tokens''' of desired granularity. This granularity becomes the minimal unit of collation and can defined as pages, paragraphs, verses, lines, words, characters or any other unit that makes sense in the context of a particular tradition under investigation. To model collation results on top of tokenized witnesses, those tokens have to be addressable.

The TEI defines an [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html#SAXP array of pointing mechanisms], which can be used to address anything from a whole XML document via URIs down to arbitrary content of those documents via sophisticated XPointer schemes. Projects would be free to choose among those mechanisms as long as each token is made available for later reference.

Examples:

<pre>

<w>The</w> <w>cat</w> <w>ate</w> <w>the</w> <w>food</w> <w>quickly</w>.

</pre>

<pre>

<w>Quickly</w>, <w>the</w> <w>cat</w> <w>ate</w> <w>the</w> <w>food</w>.

</pre>

Here tokens on the word-level could be addressed via the [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html#SATSXP xpath1() XPointer scheme]:

# <nowiki>http://edition.org/witness_1#xpath1(/p[1]/w[1])</nowiki>
# <nowiki>http://edition.org/witness_1#xpath1(/p[1]/w[2])</nowiki>
# ...

A less verbose scheme would rely on each container element of a token being identified via a (possibly autogenerated) <code>xml:id</code> attribute, like in the following verse-level tokenization.

<pre>
<lg xml:base="urn:goethe:faust2">
<l xml:id="l_1">Die Sonne sinkt, die letzten Schiffe</l>
<l xml:id="l_2">Sie ziehen munter hafenein.</l>
<l xml:id="l_3">Ein großer Kahn ist im Begriffe</l>
<l xml:id="l_4">Auf dem Canale hier zu sein.</l>
</lg>
</pre>

# <nowiki>urn:goethe:faust2#l_1</nowiki>
# <nowiki>urn:goethe:faust2#l_2</nowiki>
# ...

One can even think of reference schemes, which are as independent of existing markup as possible. By introducing <anchor/> milestone elements at token boundaries and using the [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html#SATSRN range() XPointer scheme] the tokenization of arbitrary TEI documents can be accomplished, because <anchor/> is part of [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-model.global.html model.global].

=== Modelling collated data: Encode the alignment/linking between tokens ===

After tokens in the different witnesses have been made addressable, collation data can be modelled on top of that as [[Textual_Variance#Aligner|alignments of tokens]]. An '''alignment''' can be expressed as a set of tokens from different witnesses or, in accordance with the [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/SA.html corresponding guidelines chapter] as a link between two or more tokens.

Taking the first example from above, a collation of the two given witnesses could be expressed as

<pre>
<linkGrp type="collation" xml:base="http://edition.org/">
<link target="witness_1#xpath1(/p[1]/w[1]) witness_2#xpath1(/p[1]/w[2])" />
<link target="witness_1#xpath1(/p[1]/w[2]) witness_2#xpath1(/p[1]/w[3])" />
<link target="witness_1#xpath1(/p[1]/w[3]) witness_2#xpath1(/p[1]/w[4])" />
<link target="witness_1#xpath1(/p[1]/w[4]) witness_2#xpath1(/p[1]/w[5])" />
<link target="witness_1#xpath1(/p[1]/w[5]) witness_2#xpath1(/p[1]/w[6])" />
<link target="witness_1#xpath1(/p[1]/w[6]) witness_2#xpath1(/p[1]/w[1])" type="transposition" />
</linkGrp>
</pre>

Each link in this example corresponds to a row in an alignment table as depicted in the Gothenburg model description. Omitted/ added tokens are expressed implictly by not linking to tokens in other witnesses, this is to say: Whether a set of tokens has been added to a witness or has been omitted from it, is a matter of interpreting collation data as expressed above from the perspective of one witness or another and with regard to the way, this witness aligns with others.

One advantage of encoding collation data in such a set-oriented way is its '''scalability''':

# Gradually adding witnesses to the collation may amount to adding alignments to the existing ones or modifying/augmenting the latter, depending on whether the collation is done pairwise (e. g. in relation to a base text) or via multiple alignment (e. g. without a prechosen base).
# Guiding a collation tool in producing ever more precise aligments in consecutive runs can be achieved by [[Textual_Variance#Analyzer|declaring alignments]] (for example transpositions), feeding those into the collator, adjusting the resulting alignment set, feeding it back into the collator for another run and so forth. Being able to encode the initial/preliminary results of such an iterative process in a standardized way, makes it possible to run different collation tools on the same text tradition, ideally each being able to make use of former results by other tools and to contribute to the overall result.

The major disadvantage of encoding collation data this way is its apparant lack of human readability and that it is hardly possible to edit it by hand, especially when the collated text tradition grows larger. This problem can only be solved via tool support.

=== Encoding the interpretation/ representation: Derive an apparatus from the collation ===

A TEI-encoded critical apparatus is one possible rendition of collation data, possibly enhanced with information yielded from interpreting the alignments. There are a couple of ways how we could encode the above collation as an apparatus.

==== Apparatus pointing to the collated tokens (for easier post-processing) ====

<pre>
<app>
<rdg wit="http://edition.org/witness_1" xml:base="http://edition.org/witness_1" />
<rdg wit="http://edition.org/witness_2" xml:base="http://edition.org/witness_2" xml:id="w2_1">
<ptr target="#xpath1(/p[1]/w[1])" />
</rdg>
</app>
<app>
<rdg wit="http://edition.org/witness_1" xml:base="http://edition.org/witness_1">
<ptr target="#xpath1(/p[1]/w[1])" />
<ptr target="#xpath1(/p[1]/w[2])" />
<ptr target="#xpath1(/p[1]/w[3])" />
<ptr target="#xpath1(/p[1]/w[4])" />
<ptr target="#xpath1(/p[1]/w[5])" />
</rdg>
<rdg wit="http://edition.org/witness_2" xml:base="http://edition.org/witness_2">
<ptr target="#xpath1(/p[1]/w[2])" />
<ptr target="#xpath1(/p[1]/w[3])" />
<ptr target="#xpath1(/p[1]/w[4])" />
<ptr target="#xpath1(/p[1]/w[5])" />
<ptr target="#xpath1(/p[1]/w[6])" />
</rdg>
</app>
<app>
<rdg wit="http://edition.org/witness_1" xml:base="http://edition.org/witness_1" corresp="#w2_1">
<ptr target="#xpath1(/p[1]/w[6])" />
</rdg>
<rdg wit="http://edition.org/witness_2" xml:base="http://edition.org/witness_2" />
</app>
</pre>

==== Apparatus with embedded textual content (for readability) ====

<pre>
<app>
<rdg wit="http://edition.org/witness_1" />
<rdg wit="http://edition.org/witness_2" xml:id="w2_1">Quickly,</rdg>
</app>
<app>
<rdg wit="http://edition.org/witness_1">The cat ate the food</rdg>
<rdg wit="http://edition.org/witness_2">the cat ate the food.</rdg>
</app>
<app>
<rdg wit="http://edition.org/witness_1" corresp="#w2_1">quickly.</rdg>
<rdg wit="http://edition.org/witness_2" />
</app>
</pre>

Some problems here:

* @corresp vs. <link/> for transpositions over more than two witnesses
* How to derive the segment content from the original witness automatically, if the token content does not add up to it (e. g. because of punctuation being excluded from the tokens from the start)?

== Bibliography ==

* O'Donnell, Daniel Paul. [http://etjanst.hb.se/bhs/ith/1-8/dpo.pdf “The Ghost in the Machine: Revisiting an Old Model for the Dynamic Generation of Digital Editions.”] HumanIT 8.1 (2005): 5171.
* Vetter, L. and McDonald, J. ‘Witnessing Dickinson’s Witnesses’, Literary and Linguistic Computing, 18.2: 2003, 151-165.
* [http://eprints.qut.edu.au/38436/ Schmidt, D., 2010. The inadequacy of embedded markup for cultural heritage texts. Literary and Linguistic Computing, 25(3), pp. 337-356.]

[[Category:SIG:Manuscripts]]
[[Category:Critical Apparatus]]

EXist

2011-08-31T05:51:25Z

Jensopetersen: /* Support for TEI */ updating

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery/ XQuery 1.0], [http://www.w3.org/TR/xpath20/ XPath 2.0], [http://www.w3.org/TR/xslt XSLT 1.0] (based on [http://http://xalan.apache.org/ Apache Xalan]) or [http://www.w3.org/TR/xslt20 XSLT 2.0] [http://saxon.sourceforge.net/ Saxon]

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The [http://exist.sourceforge.net/download.html 1.4 version] adds a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate
* [http://xmldb-org.sourceforge.net/xapi/ XMLDB Api]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.sun.com/javase/downloads/index.jsp JDK] > 1.4. Being a Java application it can be used on most operating systems, from Windows 2000/XP to Linux or Mac OS X, and it can be deployed in several ways, as a standalone application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/copyleft/lesser.html GNU LGPL] license.

== Support for TEI ==
Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the Digital.Humanities@Oxford Summer School in 2011; see the [http://digital.humanities.ox.ac.uk/DHSS2011/sessions.html#xmldb session description, slides, and sample materials].

A TEI module called Matumi is distributed as an eXist application. Matumi is still under development. It requires eXist version 1.5 and is installed from within eXist's Package Reposistory. After installation, it can be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

Matumi is not a full-blown TEI module yet, but it has some notable features, such as the ability to browse by filtering texts and core parts of the markup. It contains faceted search feeding off the markup, making possible "translingual" searches that utilise references added to name forms. 

The app uses XQuery only.

Installation will store a number of basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present orientation of the app.

If you access through browsing, you can arrange the data by four criteria - books, entry title, subjects and names.

If you access through search, in order to retrieve some sample results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

There is a comprehensive discussion of optimising eXist/xQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As wrote before, eXist is a Java application. Anyway, whole applications can be created without writing any line of programming code, but using only XQuery, XSLT, (X)HTML, CSS and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support is provived mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being eXist open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

In August 2011, a dedicated email list was created on using eXist with TEI resources. For information or to subscribe, go to the [https://lists.sourceforge.net/lists/listinfo/exist-teixml eXist-TEIXML] information page.

== Sample implementations ==
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The correspondence, diaries, writings and works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ Colonial Despatches]: the colonial despatches of Vancouver Island and British Columbia 1846-1871.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 1.4.0-rev10440 - 2009-11-11

== How to download ==
Download the current stable version (version 1.4, April 2011) from the [http://exist-db.org/index.html#download eXist Home Page]; check out the current trunk version from "svn co <nowiki>https://exist.svn.sourceforge.net/svnroot/exist/trunk/eXist</nowiki>".

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2011-05-13T09:54:26Z

Jensopetersen: /* Sample implementations */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery/ XQuery 1.0], [http://www.w3.org/TR/xpath20/ XPath 2.0], [http://www.w3.org/TR/xslt XSLT 1.0] (based on [http://http://xalan.apache.org/ Apache Xalan]) or [http://www.w3.org/TR/xslt20 XSLT 2.0] [http://saxon.sourceforge.net/ Saxon]

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The [http://exist.sourceforge.net/download.html 1.4 version] adds a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate
* [http://xmldb-org.sourceforge.net/xapi/ XMLDB Api]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.sun.com/javase/downloads/index.jsp JDK] > 1.4. Being a Java application it can be used on most operating systems, from Windows 2000/XP to Linux or Mac OS X, and it can be deployed in several ways, as a standalone application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/copyleft/lesser.html GNU LGPL] license.

== Support for TEI ==
A TEI module distributed as an eXist application is under development. This protoype can be downloaded from [http://exist.svn.sourceforge.net/viewvc/exist/apps/TEIXLingual/?pathrev=14317 Sourceforge]. The app requires eXist 1.5. To install on a Unix-like system, cd into the directory and call ant. This will create a file named "encyclopedia-0.1.xar" inside the build directory. On your local eXist home page, access the Admin panel, click on Package Reposistory, choose the xar file, and upload and install it. The app can now be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

The app is not a full-blown TEI module yet, lacking some fairly obvious features, such as display of metadata about the texts displayed and the ability to browse through texts and marked-up items; these features will be added in May-June 2011. The app contains faceted search feeding off the markup, it makes possible "translingual" searches utilising unique (mainly, dbpedia) references added manually to different name forms, it contains an inline (WYMeditor-based) editor for marking up simple TEI (name) structures and supplying them with key attributes, and it has a general ATOM-based commenting function.

The app uses XQuery only; no XSLT is used.

The installation will store a number of very basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present name of the app. In order to generate some example results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the TEI@Oxford Summer School in 2010; see [http://tei.oucs.ox.ac.uk/Oxford/2010-07-oxford/materials/workshops/eXist/ oxford/materials/workshops/eXist].


There is a comprehensive discussion of optimising eXist/xQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As wrote before, eXist is a Java application. Anyway, whole applications can be created without writing any line of programming code, but using only XQuery, XSLT, (X)HTML, CSS and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support is provived mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being eXist open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

== Sample implementations ==
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The correspondence, diaries, writings and works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ Colonial Despatches]: the colonial despatches of Vancouver Island and British Columbia 1846-1871.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 1.4.0-rev10440 - 2009-11-11

== How to download ==
Download the current stable version (version 1.4, April 2011) from the [http://exist-db.org/index.html#download eXist Home Page]; check out the current trunk version from "svn co <nowiki>https://exist.svn.sourceforge.net/svnroot/exist/trunk/eXist</nowiki>".

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2011-05-13T09:37:36Z

Jensopetersen: /* Current version number and date of release */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery/ XQuery 1.0], [http://www.w3.org/TR/xpath20/ XPath 2.0], [http://www.w3.org/TR/xslt XSLT 1.0] (based on [http://http://xalan.apache.org/ Apache Xalan]) or [http://www.w3.org/TR/xslt20 XSLT 2.0] [http://saxon.sourceforge.net/ Saxon]

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The [http://exist.sourceforge.net/download.html 1.4 version] adds a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate
* [http://xmldb-org.sourceforge.net/xapi/ XMLDB Api]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.sun.com/javase/downloads/index.jsp JDK] > 1.4. Being a Java application it can be used on most operating systems, from Windows 2000/XP to Linux or Mac OS X, and it can be deployed in several ways, as a standalone application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/copyleft/lesser.html GNU LGPL] license.

== Support for TEI ==
A TEI module distributed as an eXist application is under development. This protoype can be downloaded from [http://exist.svn.sourceforge.net/viewvc/exist/apps/TEIXLingual/?pathrev=14317 Sourceforge]. The app requires eXist 1.5. To install on a Unix-like system, cd into the directory and call ant. This will create a file named "encyclopedia-0.1.xar" inside the build directory. On your local eXist home page, access the Admin panel, click on Package Reposistory, choose the xar file, and upload and install it. The app can now be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

The app is not a full-blown TEI module yet, lacking some fairly obvious features, such as display of metadata about the texts displayed and the ability to browse through texts and marked-up items; these features will be added in May-June 2011. The app contains faceted search feeding off the markup, it makes possible "translingual" searches utilising unique (mainly, dbpedia) references added manually to different name forms, it contains an inline (WYMeditor-based) editor for marking up simple TEI (name) structures and supplying them with key attributes, and it has a general ATOM-based commenting function.

The app uses XQuery only; no XSLT is used.

The installation will store a number of very basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present name of the app. In order to generate some example results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the TEI@Oxford Summer School in 2010; see [http://tei.oucs.ox.ac.uk/Oxford/2010-07-oxford/materials/workshops/eXist/ oxford/materials/workshops/eXist].


There is a comprehensive discussion of optimising eXist/xQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As wrote before, eXist is a Java application. Anyway, whole applications can be created without writing any line of programming code, but using only XQuery, XSLT, (X)HTML, CSS and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support is provived mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being eXist open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

== Sample implementations ==
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The Collected Works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ Colonial Despatches]: the colonial despatches of Vancouver Island and British Columbia 1846-1871.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
Current stable release: eXist 1.4.0-rev10440 - 2009-11-11

== How to download ==
Download the current stable version (version 1.4, April 2011) from the [http://exist-db.org/index.html#download eXist Home Page]; check out the current trunk version from "svn co <nowiki>https://exist.svn.sourceforge.net/svnroot/exist/trunk/eXist</nowiki>".

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2011-05-13T09:33:22Z

Jensopetersen: added WeGA

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery/ XQuery 1.0], [http://www.w3.org/TR/xpath20/ XPath 2.0], [http://www.w3.org/TR/xslt XSLT 1.0] (based on [http://http://xalan.apache.org/ Apache Xalan]) or [http://www.w3.org/TR/xslt20 XSLT 2.0] [http://saxon.sourceforge.net/ Saxon]

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The [http://exist.sourceforge.net/download.html 1.4 version] adds a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate
* [http://xmldb-org.sourceforge.net/xapi/ XMLDB Api]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.sun.com/javase/downloads/index.jsp JDK] > 1.4. Being a Java application it can be used on most operating systems, from Windows 2000/XP to Linux or Mac OS X, and it can be deployed in several ways, as a standalone application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/copyleft/lesser.html GNU LGPL] license.

== Support for TEI ==
A TEI module distributed as an eXist application is under development. This protoype can be downloaded from [http://exist.svn.sourceforge.net/viewvc/exist/apps/TEIXLingual/?pathrev=14317 Sourceforge]. The app requires eXist 1.5. To install on a Unix-like system, cd into the directory and call ant. This will create a file named "encyclopedia-0.1.xar" inside the build directory. On your local eXist home page, access the Admin panel, click on Package Reposistory, choose the xar file, and upload and install it. The app can now be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

The app is not a full-blown TEI module yet, lacking some fairly obvious features, such as display of metadata about the texts displayed and the ability to browse through texts and marked-up items; these features will be added in May-June 2011. The app contains faceted search feeding off the markup, it makes possible "translingual" searches utilising unique (mainly, dbpedia) references added manually to different name forms, it contains an inline (WYMeditor-based) editor for marking up simple TEI (name) structures and supplying them with key attributes, and it has a general ATOM-based commenting function.

The app uses XQuery only; no XSLT is used.

The installation will store a number of very basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present name of the app. In order to generate some example results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, presented at the TEI@Oxford Summer School in 2010; see [http://tei.oucs.ox.ac.uk/Oxford/2010-07-oxford/materials/workshops/eXist/ oxford/materials/workshops/eXist].


There is a comprehensive discussion of optimising eXist/xQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As wrote before, eXist is a Java application. Anyway, whole applications can be created without writing any line of programming code, but using only XQuery, XSLT, (X)HTML, CSS and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support is provived mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being eXist open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

== Sample implementations ==
* [http://www.weber-gesamtausgabe.de/ Carl-Maria-von-Weber-Gesamtausgabe (WeGA)] The Collected Works of Carl Maria von Weber
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ Colonial Despatches]: the colonial despatches of Vancouver Island and British Columbia 1846-1871.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
eXist 1.4 - 2009-09-08

== How to download ==
Download the current stable version (version 1.4, April 2011) from the [http://exist-db.org/index.html#download eXist Home Page]; check out the current trunk version from "svn co <nowiki>https://exist.svn.sourceforge.net/svnroot/exist/trunk/eXist</nowiki>".

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2011-05-03T08:59:59Z

Jensopetersen: /* Synopsis */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery/ XQuery 1.0], [http://www.w3.org/TR/xpath20/ XPath 2.0], [http://www.w3.org/TR/xslt XSLT 1.0] (based on [http://http://xalan.apache.org/ Apache Xalan]) or [http://www.w3.org/TR/xslt20 XSLT 2.0] [http://saxon.sourceforge.net/ Saxon]

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]).

The [http://exist.sourceforge.net/download.html 1.4 version] adds a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate
* [http://xmldb-org.sourceforge.net/xapi/ XMLDB Api]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.sun.com/javase/downloads/index.jsp JDK] > 1.4. Being a Java application it can be used on most operating systems, from Windows 2000/XP to Linux or Mac OS X, and it can be deployed in several ways, as a standalone application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/copyleft/lesser.html GNU LGPL] license.

== Support for TEI ==
A TEI module distributed as an eXist application is under development. This protoype can be downloaded from [http://exist.svn.sourceforge.net/viewvc/exist/apps/TEIXLingual/?pathrev=14317 Sourceforge]. The app requires eXist 1.5. To install on a Unix-like system, cd into the directory and call ant. This will create a file named "encyclopedia-0.1.xar" inside the build directory. On your local eXist home page, access the Admin panel, click on Package Reposistory, choose the xar file, and upload and install it. The app can now be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

The app is not a full-blown TEI module yet, lacking some fairly obvious features, such as display of metadata about the texts displayed and the ability to browse through texts and marked-up items; these features will be added in May-June 2011. The app contains faceted search feeding off the markup, it makes possible "translingual" searches utilising unique (mainly, dbpedia) references added manually to different name forms, it contains an inline (WYMeditor-based) editor for marking up simple TEI (name) structures and supplying them with key attributes, and it has a general ATOM-based commenting function.

The app uses XQuery only; no XSLT is used.

The installation will store a number of very basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present name of the app. In order to generate some example results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, created in cooperation with Dan McCreary and presented at the TEI@Oxford Summer School in 2010; see [http://tei.oucs.ox.ac.uk/Oxford/2010-07-oxford/materials/workshops/eXist/ oxford/materials/workshops/eXist].


There is a comprehensive discussion of optimising eXist/xQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As wrote before, eXist is a Java application. Anyway, whole applications can be created without writing any line of programming code, but using only XQuery, XSLT, (X)HTML, CSS and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support is provived mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being eXist open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

== Sample implementations ==
* [http://demo.exist-db.org/examples.xml official demo] (without TEI related examples)
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ Colonial Despatches]: the colonial despatches of Vancouver Island and British Columbia 1846-1871.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
eXist 1.4 - 2009-09-08

== How to download ==
Download the current stable version (version 1.4, April 2011) from the [http://exist-db.org/index.html#download eXist Home Page]; check out the current trunk version from "svn co <nowiki>https://exist.svn.sourceforge.net/svnroot/exist/trunk/eXist</nowiki>".

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2011-05-03T07:49:56Z

Jensopetersen: /* Synopsis */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Technologies: [http://www.w3.org/TR/xquery/ XQuery 1.0], [http://www.w3.org/TR/xpath20/ XPath 2.0], [http://www.w3.org/TR/xslt XSLT 1.0] (based on [http://http://xalan.apache.org/ Apache Xalan]) or [http://www.w3.org/TR/xslt20 XSLT 2.0] [http://saxon.sourceforge.net/ Saxon]

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]

The [http://exist.sourceforge.net/download.html 1.4 version] adds a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate
* [http://xmldb-org.sourceforge.net/xapi/ XMLDB Api]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.sun.com/javase/downloads/index.jsp JDK] > 1.4. Being a Java application it can be used on most operating systems, from Windows 2000/XP to Linux or Mac OS X, and it can be deployed in several ways, as a standalone application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/copyleft/lesser.html GNU LGPL] license.

== Support for TEI ==
A TEI module distributed as an eXist application is under development. This protoype can be downloaded from [http://exist.svn.sourceforge.net/viewvc/exist/apps/TEIXLingual/?pathrev=14317 Sourceforge]. The app requires eXist 1.5. To install on a Unix-like system, cd into the directory and call ant. This will create a file named "encyclopedia-0.1.xar" inside the build directory. On your local eXist home page, access the Admin panel, click on Package Reposistory, choose the xar file, and upload and install it. The app can now be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

The app is not a full-blown TEI module yet, lacking some fairly obvious features, such as display of metadata about the texts displayed and the ability to browse through texts and marked-up items; these features will be added in May-June 2011. The app contains faceted search feeding off the markup, it makes possible "translingual" searches utilising unique (mainly, dbpedia) references added manually to different name forms, it contains an inline (WYMeditor-based) editor for marking up simple TEI (name) structures and supplying them with key attributes, and it has a general ATOM-based commenting function.

The app uses XQuery only; no XSLT is used.

The installation will store a number of very basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present name of the app. In order to generate some example results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, created in cooperation with Dan McCreary and presented at the TEI@Oxford Summer School in 2010; see [http://tei.oucs.ox.ac.uk/Oxford/2010-07-oxford/materials/workshops/eXist/ oxford/materials/workshops/eXist].


There is a comprehensive discussion of optimising eXist/xQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As wrote before, eXist is a Java application. Anyway, whole applications can be created without writing any line of programming code, but using only XQuery, XSLT, (X)HTML, CSS and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support is provived mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being eXist open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

== Sample implementations ==
* [http://demo.exist-db.org/examples.xml official demo] (without TEI related examples)
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ Colonial Despatches]: the colonial despatches of Vancouver Island and British Columbia 1846-1871.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
eXist 1.4 - 2009-09-08

== How to download ==
Download the current stable version (version 1.4, April 2011) from the [http://exist-db.org/index.html#download eXist Home Page]; check out the current trunk version from "svn co <nowiki>https://exist.svn.sourceforge.net/svnroot/exist/trunk/eXist</nowiki>".

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2011-05-03T07:48:43Z

Jensopetersen: /* Synopsis */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==

[http://exist.sourceforge.net/ eXist-db] is an open source database management system built using [http://en.wikipedia.org/wiki/XML XML] technology. It stores XML data according to the XML data model and features efficient, index-based XQuery processing.

eXist-db supports many [http://en.wikipedia.org/wiki/Web_2 Web 2.0] technology standards, making
it an excellent platform for developing web-based applications:

*Key technologies: [http://www.w3.org/TR/xquery/ XQuery 1.0], [http://www.w3.org/TR/xpath20/ XPath 2.0], [http://www.w3.org/TR/xslt XSLT 1.0] (based on [http://http://xalan.apache.org/ Apache Xalan]) or [http://www.w3.org/TR/xslt20 XSLT 2.0] [http://saxon.sourceforge.net/ Saxon]

*Interfaces: [http://en.wikipedia.org/wiki/Representational_State_Transfer REST], [http://www.webdav.org/ WebDAV], [http://www.w3.org/TR/soap/ SOAP], [http://en.wikipedia.org/wiki/XML-RPC XML-RPC], and [http://en.wikipedia.org/wiki/Atom_(standard) Atom Publishing Protocol]

*XML database specific features: [http://xmldb-org.sourceforge.net/xupdate/index.html XML:DB], [http://xmldb-org.sourceforge.net/xupdate/ XUpdate], [http://exist.sourceforge.net/update_ext.html XQuery update extensions] (to be aligned with the new [http://www.w3.org/TR/xquery-update-10/ XQuery Update Facility 1.0]

The [http://exist.sourceforge.net/download.html 1.4 version] adds a new full text index based on [http://lucene.apache.org/java/docs/index.html Apache Lucene], a lightweight [http://en.wikipedia.org/wiki/Rewrite_engine URL rewriting] and [http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller Model–view–controller] framework, as well as support for [http://xproc.org/ XProc]. With version 1.4, the XQuery engine has seen a major redesign, resulting in improved performance.

eXist-db is highly compliant with the [http://www.w3.org/TR/xquery/ XQuery standard] (current [http://www.w3.org/XML/Query/test-suite/ XQuery Test Suite] score is [http://www.w3.org/XML/Query/test-suite/XQTSReportSimple.html 99.4%]).

The query engine is extensible and features a large collection of [http://demo.exist-db.org/exist/xquery/functions.xql XQuery Function Modules].

eXist-db provides a powerful environment for the development of web applications
based on XQuery and related standards. Entire web applications can be written in
XQuery, using XSLT, XHTML, CSS and Javascript (for AJAX functionality).



== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate
* [http://xmldb-org.sourceforge.net/xapi/ XMLDB Api]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.sun.com/javase/downloads/index.jsp JDK] > 1.4. Being a Java application it can be used on most operating systems, from Windows 2000/XP to Linux or Mac OS X, and it can be deployed in several ways, as a standalone application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/copyleft/lesser.html GNU LGPL] license.

== Support for TEI ==
A TEI module distributed as an eXist application is under development. This protoype can be downloaded from [http://exist.svn.sourceforge.net/viewvc/exist/apps/TEIXLingual/?pathrev=14317 Sourceforge]. The app requires eXist 1.5. To install on a Unix-like system, cd into the directory and call ant. This will create a file named "encyclopedia-0.1.xar" inside the build directory. On your local eXist home page, access the Admin panel, click on Package Reposistory, choose the xar file, and upload and install it. The app can now be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

The app is not a full-blown TEI module yet, lacking some fairly obvious features, such as display of metadata about the texts displayed and the ability to browse through texts and marked-up items; these features will be added in May-June 2011. The app contains faceted search feeding off the markup, it makes possible "translingual" searches utilising unique (mainly, dbpedia) references added manually to different name forms, it contains an inline (WYMeditor-based) editor for marking up simple TEI (name) structures and supplying them with key attributes, and it has a general ATOM-based commenting function.

The app uses XQuery only; no XSLT is used.

The installation will store a number of very basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present name of the app. In order to generate some example results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, created in cooperation with Dan McCreary and presented at the TEI@Oxford Summer School in 2010; see [http://tei.oucs.ox.ac.uk/Oxford/2010-07-oxford/materials/workshops/eXist/ oxford/materials/workshops/eXist].


There is a comprehensive discussion of optimising eXist/xQuery for TEI on [http://exist.2174344.n4.nabble.com/eXist-optimisation-and-large-TEI-collections-td3487406.html the eXist-open mailing list]

== Language(s) ==
As wrote before, eXist is a Java application. Anyway, whole applications can be created without writing any line of programming code, but using only XQuery, XSLT, (X)HTML, CSS and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support is provived mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being eXist open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

== Sample implementations ==
* [http://demo.exist-db.org/examples.xml official demo] (without TEI related examples)
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ Colonial Despatches]: the colonial despatches of Vancouver Island and British Columbia 1846-1871.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
eXist 1.4 - 2009-09-08

== How to download ==
Download the current stable version (version 1.4, April 2011) from the [http://exist-db.org/index.html#download eXist Home Page]; check out the current trunk version from "svn co <nowiki>https://exist.svn.sourceforge.net/svnroot/exist/trunk/eXist</nowiki>".

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2011-05-01T09:13:08Z

Jensopetersen: /* Support for TEI */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==
[http://exist.sourceforge.net/ eXist] is a Native XML Database, used for storing and querying XML files. Since the first versions, made available between 2000 and 2001, eXist has considerably evolved, thanks also to an active community of developers and users, and in its latest releases, it has several functions, such as support for [http://www.w3.org/TR/xquery/ XQuery], [http://www.w3.org/2001/XInclude XInclude] and [http://xmldb-org.sourceforge.net/xupdate/ XUpdate]. Through an integration with [[ApacheCocoon]], [http://www.w3.org/TR/xslt XSLT] processing can be added to the whole workflow, using the pipeline concept of the [http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html Sitemap]. In this way data and documents can be queried and transformed using together, in the same process, [http://www.w3.org/TR/xquery/ XQuery] and [http://www.w3.org/TR/xslt XSLT]. Moreover [http://exist.sourceforge.net/ eXist] can be integrated as a block in [[ApacheCocoon]], so to use all the modules of this framework, and not the limited version shipped with this database. Recently, starting from version 1.1, [http://exist.sourceforge.net/ eXist] has changed the indexing core, becoming more efficient in being used with complex document-centric files, such as TEI encoded texts.

== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate
* [http://xmldb-org.sourceforge.net/xapi/ XMLDB Api]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.sun.com/javase/downloads/index.jsp JDK] > 1.4. Being a Java application it can be used on most operating systems, from Windows 2000/XP to Linux or Mac OS X, and it can be deployed in several ways, as a standalone application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/copyleft/lesser.html GNU LGPL] license.

== Support for TEI ==
A TEI module distributed as an eXist application is under development. This protoype can be downloaded from [http://exist.svn.sourceforge.net/viewvc/exist/apps/TEIXLingual/?pathrev=14317 Sourceforge]. The app requires eXist 1.5. To install on a Unix-like system, cd into the directory and call ant. This will create a file named "encyclopedia-0.1.xar" inside the build directory. On your local eXist home page, access the Admin panel, click on Package Reposistory, choose the xar file, and upload and install it. The app can now be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

The app is not a full-blown TEI module yet, lacking some fairly obvious features, such as display of metadata about the texts displayed and the ability to browse through texts and marked-up items; these features will be added in May-June 2011. The app contains faceted search feeding off the markup, it makes possible "translingual" searches utilising unique (mainly, dbpedia) references added manually to different name forms, it contains an inline (WYMeditor-based) editor for marking up simple TEI (name) structures and supplying them with key attributes, and it has a general ATOM-based commenting function.

The app uses XQuery only; no XSLT is used.

The installation will store a number of very basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present name of the app. In order to generate some example results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts with eXist, created in cooperation with Dan McCreary and presented at the TEI@Oxford Summer School in 2010; see [http://tei.oucs.ox.ac.uk/Oxford/2010-07-oxford/materials/workshops/eXist/ oxford/materials/workshops/eXist].



== Language(s) ==
As wrote before, eXist is a Java application. Anyway, whole applications can be created without writing any line of programming code, but using only XQuery, XSLT, (X)HTML, CSS and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support is provived mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being eXist open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

== Sample implementations ==
* [http://demo.exist-db.org/examples.xml official demo] (without TEI related examples)
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ Colonial Despatches]: the colonial despatches of Vancouver Island and British Columbia 1846-1871.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
eXist 1.4 - 2009-09-08

== How to download ==
Download the current stable version (version 1.4, April 2011) from the [http://exist-db.org/index.html#download eXist Home Page]; check out the current trunk version from "svn co <nowiki>https://exist.svn.sourceforge.net/svnroot/exist/trunk/eXist</nowiki>".

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2011-04-28T10:23:08Z

Jensopetersen: /* Sample implementations */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==
[http://exist.sourceforge.net/ eXist] is a Native XML Database, used for storing and querying XML files. Since the first versions, made available between 2000 and 2001, eXist has considerably evolved, thanks also to an active community of developers and users, and in its latest releases, it has several functions, such as support for [http://www.w3.org/TR/xquery/ XQuery], [http://www.w3.org/2001/XInclude XInclude] and [http://xmldb-org.sourceforge.net/xupdate/ XUpdate]. Through an integration with [[ApacheCocoon]], [http://www.w3.org/TR/xslt XSLT] processing can be added to the whole workflow, using the pipeline concept of the [http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html Sitemap]. In this way data and documents can be queried and transformed using together, in the same process, [http://www.w3.org/TR/xquery/ XQuery] and [http://www.w3.org/TR/xslt XSLT]. Moreover [http://exist.sourceforge.net/ eXist] can be integrated as a block in [[ApacheCocoon]], so to use all the modules of this framework, and not the limited version shipped with this database. Recently, starting from version 1.1, [http://exist.sourceforge.net/ eXist] has changed the indexing core, becoming more efficient in being used with complex document-centric files, such as TEI encoded texts.

== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate
* [http://xmldb-org.sourceforge.net/xapi/ XMLDB Api]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.sun.com/javase/downloads/index.jsp JDK] > 1.4. Being a Java application it can be used on most operating systems, from Windows 2000/XP to Linux or Mac OS X, and it can be deployed in several ways, as a standalone application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/copyleft/lesser.html GNU LGPL] license.

== Support for TEI ==
A TEI module distributed as an eXist application is under development. This protoype can be downloaded from [http://exist.svn.sourceforge.net/viewvc/exist/apps/TEIXLingual/?pathrev=14317 Sourceforge]. The app requires eXist 1.5. To install on a Unix-like system, cd into the directory and call ant. This will create a file named "encyclopedia-0.1.xar" inside the build directory. On your local eXist home page, access the Admin panel, click on Package Reposistory, choose the xar file, and upload and install it. The app can now be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

The app is not a full-blown TEI module yet, lacking some fairly obvious features, such as display of metadata about the texts displayed and the ability to browse through texts and marked-up items; these features will be added in May-June 2011. The app contains faceted search feeding off the markup, it makes possible "translingual" searches utilising unique (mainly, dbpedia) references added manually to different name forms, it contains an inline (WYMeditor-based) editor for marking up simple TEI (name) structures and supplying them with key attributes, and it has a general ATOM-based commenting function.

The app uses XQuery only; no XSLT is used.

The installation will store a number of very basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present name of the app. In order to generate some example results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts within an XRX framework with eXist, created in cooperation with Dan McCreary; see [http://tei.oucs.ox.ac.uk/Oxford/2010-07-oxford/materials/workshops/eXist/ oxford/materials/workshops/eXist].



== Language(s) ==
As wrote before, eXist is a Java application. Anyway, whole applications can be created without writing any line of programming code, but using only XQuery, XSLT, (X)HTML, CSS and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support is provived mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being eXist open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

== Sample implementations ==
* [http://demo.exist-db.org/examples.xml official demo] (without TEI related examples)
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://graves.uvic.ca/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions
* [http://thesaurus.sermones.net/voragine/index.xsp Sermones.net : éditions électroniques de sermons latins médiévaux]: l’édition électronique de corpus de sermons, dont le premier est la série de sermons de Carême de Jacques de Voragine.
* [http://ciham.ish-lyon.cnrs.fr/paleographie/index.php?l=en Interactive Album of Mediaeval Palaeography]: website for training in practical palaeographical skills.
* [http://bcgenesis.uvic.ca/ Colonial Despatches]: the colonial despatches of Vancouver Island and British Columbia 1846-1871.
* [http://mariage.uvic.ca/ Le mariage sous L'Ancien Régime]
* [http://scancan.net/ Scandinavian-Canadian Studies / Études scandinaves au Canada]
* [http://voice.univie.ac.at Vienna-Oxford International Corpus of English]: a corpus of transcripts of spoken ELF interactions in TEI format.



== Current version number and date of release ==
eXist 1.4 - 2009-09-08

== How to download ==
Download the current stable version (version 1.4, April 2011) from the [http://exist-db.org/index.html#download eXist Home Page]; check out the current trunk version from "svn co <nowiki>https://exist.svn.sourceforge.net/svnroot/exist/trunk/eXist</nowiki>".

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2011-04-28T09:49:49Z

Jensopetersen: /* How to download */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==
[http://exist.sourceforge.net/ eXist] is a Native XML Database, used for storing and querying XML files. Since the first versions, made available between 2000 and 2001, eXist has considerably evolved, thanks also to an active community of developers and users, and in its latest releases, it has several functions, such as support for [http://www.w3.org/TR/xquery/ XQuery], [http://www.w3.org/2001/XInclude XInclude] and [http://xmldb-org.sourceforge.net/xupdate/ XUpdate]. Through an integration with [[ApacheCocoon]], [http://www.w3.org/TR/xslt XSLT] processing can be added to the whole workflow, using the pipeline concept of the [http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html Sitemap]. In this way data and documents can be queried and transformed using together, in the same process, [http://www.w3.org/TR/xquery/ XQuery] and [http://www.w3.org/TR/xslt XSLT]. Moreover [http://exist.sourceforge.net/ eXist] can be integrated as a block in [[ApacheCocoon]], so to use all the modules of this framework, and not the limited version shipped with this database. Recently, starting from version 1.1, [http://exist.sourceforge.net/ eXist] has changed the indexing core, becoming more efficient in being used with complex document-centric files, such as TEI encoded texts.

== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate
* [http://xmldb-org.sourceforge.net/xapi/ XMLDB Api]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.sun.com/javase/downloads/index.jsp JDK] > 1.4. Being a Java application it can be used on most operating systems, from Windows 2000/XP to Linux or Mac OS X, and it can be deployed in several ways, as a standalone application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/copyleft/lesser.html GNU LGPL] license.

== Support for TEI ==
A TEI module distributed as an eXist application is under development. This protoype can be downloaded from [http://exist.svn.sourceforge.net/viewvc/exist/apps/TEIXLingual/?pathrev=14317 Sourceforge]. The app requires eXist 1.5. To install on a Unix-like system, cd into the directory and call ant. This will create a file named "encyclopedia-0.1.xar" inside the build directory. On your local eXist home page, access the Admin panel, click on Package Reposistory, choose the xar file, and upload and install it. The app can now be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

The app is not a full-blown TEI module yet, lacking some fairly obvious features, such as display of metadata about the texts displayed and the ability to browse through texts and marked-up items; these features will be added in May-June 2011. The app contains faceted search feeding off the markup, it makes possible "translingual" searches utilising unique (mainly, dbpedia) references added manually to different name forms, it contains an inline (WYMeditor-based) editor for marking up simple TEI (name) structures and supplying them with key attributes, and it has a general ATOM-based commenting function.

The app uses XQuery only; no XSLT is used.

The installation will store a number of very basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present name of the app. In order to generate some example results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts within an XRX framework with eXist, created in cooperation with Dan McCreary; see [http://tei.oucs.ox.ac.uk/Oxford/2010-07-oxford/materials/workshops/eXist/ oxford/materials/workshops/eXist].



== Language(s) ==
As wrote before, eXist is a Java application. Anyway, whole applications can be created without writing any line of programming code, but using only XQuery, XSLT, (X)HTML, CSS and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support is provived mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being eXist open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

== Sample implementations ==
* [http://demo.exist-db.org/examples.xml official demo] (without TEI related examples)
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://www.tapor.uvic.ca:8080/cocoon/graves/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions

== Current version number and date of release ==
eXist 1.4 - 2009-09-08

== How to download ==
Download the current stable version (version 1.4, April 2011) from the [http://exist-db.org/index.html#download eXist Home Page]; check out the current trunk version from "svn co <nowiki>https://exist.svn.sourceforge.net/svnroot/exist/trunk/eXist</nowiki>".

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2011-04-28T09:49:26Z

Jensopetersen: /* How to download */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==
[http://exist.sourceforge.net/ eXist] is a Native XML Database, used for storing and querying XML files. Since the first versions, made available between 2000 and 2001, eXist has considerably evolved, thanks also to an active community of developers and users, and in its latest releases, it has several functions, such as support for [http://www.w3.org/TR/xquery/ XQuery], [http://www.w3.org/2001/XInclude XInclude] and [http://xmldb-org.sourceforge.net/xupdate/ XUpdate]. Through an integration with [[ApacheCocoon]], [http://www.w3.org/TR/xslt XSLT] processing can be added to the whole workflow, using the pipeline concept of the [http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html Sitemap]. In this way data and documents can be queried and transformed using together, in the same process, [http://www.w3.org/TR/xquery/ XQuery] and [http://www.w3.org/TR/xslt XSLT]. Moreover [http://exist.sourceforge.net/ eXist] can be integrated as a block in [[ApacheCocoon]], so to use all the modules of this framework, and not the limited version shipped with this database. Recently, starting from version 1.1, [http://exist.sourceforge.net/ eXist] has changed the indexing core, becoming more efficient in being used with complex document-centric files, such as TEI encoded texts.

== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate
* [http://xmldb-org.sourceforge.net/xapi/ XMLDB Api]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.sun.com/javase/downloads/index.jsp JDK] > 1.4. Being a Java application it can be used on most operating systems, from Windows 2000/XP to Linux or Mac OS X, and it can be deployed in several ways, as a standalone application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/copyleft/lesser.html GNU LGPL] license.

== Support for TEI ==
A TEI module distributed as an eXist application is under development. This protoype can be downloaded from [http://exist.svn.sourceforge.net/viewvc/exist/apps/TEIXLingual/?pathrev=14317 Sourceforge]. The app requires eXist 1.5. To install on a Unix-like system, cd into the directory and call ant. This will create a file named "encyclopedia-0.1.xar" inside the build directory. On your local eXist home page, access the Admin panel, click on Package Reposistory, choose the xar file, and upload and install it. The app can now be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

The app is not a full-blown TEI module yet, lacking some fairly obvious features, such as display of metadata about the texts displayed and the ability to browse through texts and marked-up items; these features will be added in May-June 2011. The app contains faceted search feeding off the markup, it makes possible "translingual" searches utilising unique (mainly, dbpedia) references added manually to different name forms, it contains an inline (WYMeditor-based) editor for marking up simple TEI (name) structures and supplying them with key attributes, and it has a general ATOM-based commenting function.

The app uses XQuery only; no XSLT is used.

The installation will store a number of very basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present name of the app. In order to generate some example results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts within an XRX framework with eXist, created in cooperation with Dan McCreary; see [http://tei.oucs.ox.ac.uk/Oxford/2010-07-oxford/materials/workshops/eXist/ oxford/materials/workshops/eXist].



== Language(s) ==
As wrote before, eXist is a Java application. Anyway, whole applications can be created without writing any line of programming code, but using only XQuery, XSLT, (X)HTML, CSS and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support is provived mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being eXist open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

== Sample implementations ==
* [http://demo.exist-db.org/examples.xml official demo] (without TEI related examples)
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://www.tapor.uvic.ca:8080/cocoon/graves/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions

== Current version number and date of release ==
eXist 1.4 - 2009-09-08

== How to download ==
Download the current stable version (version 1.4, April 2011) from [http://exist-db.org/index.html#download eXist Home Page]; check out the current trunk version from "svn co <nowiki>https://exist.svn.sourceforge.net/svnroot/exist/trunk/eXist</nowiki>".

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2011-04-28T09:48:51Z

Jensopetersen: /* How to download */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==
[http://exist.sourceforge.net/ eXist] is a Native XML Database, used for storing and querying XML files. Since the first versions, made available between 2000 and 2001, eXist has considerably evolved, thanks also to an active community of developers and users, and in its latest releases, it has several functions, such as support for [http://www.w3.org/TR/xquery/ XQuery], [http://www.w3.org/2001/XInclude XInclude] and [http://xmldb-org.sourceforge.net/xupdate/ XUpdate]. Through an integration with [[ApacheCocoon]], [http://www.w3.org/TR/xslt XSLT] processing can be added to the whole workflow, using the pipeline concept of the [http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html Sitemap]. In this way data and documents can be queried and transformed using together, in the same process, [http://www.w3.org/TR/xquery/ XQuery] and [http://www.w3.org/TR/xslt XSLT]. Moreover [http://exist.sourceforge.net/ eXist] can be integrated as a block in [[ApacheCocoon]], so to use all the modules of this framework, and not the limited version shipped with this database. Recently, starting from version 1.1, [http://exist.sourceforge.net/ eXist] has changed the indexing core, becoming more efficient in being used with complex document-centric files, such as TEI encoded texts.

== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate
* [http://xmldb-org.sourceforge.net/xapi/ XMLDB Api]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.sun.com/javase/downloads/index.jsp JDK] > 1.4. Being a Java application it can be used on most operating systems, from Windows 2000/XP to Linux or Mac OS X, and it can be deployed in several ways, as a standalone application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/copyleft/lesser.html GNU LGPL] license.

== Support for TEI ==
A TEI module distributed as an eXist application is under development. This protoype can be downloaded from [http://exist.svn.sourceforge.net/viewvc/exist/apps/TEIXLingual/?pathrev=14317 Sourceforge]. The app requires eXist 1.5. To install on a Unix-like system, cd into the directory and call ant. This will create a file named "encyclopedia-0.1.xar" inside the build directory. On your local eXist home page, access the Admin panel, click on Package Reposistory, choose the xar file, and upload and install it. The app can now be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

The app is not a full-blown TEI module yet, lacking some fairly obvious features, such as display of metadata about the texts displayed and the ability to browse through texts and marked-up items; these features will be added in May-June 2011. The app contains faceted search feeding off the markup, it makes possible "translingual" searches utilising unique (mainly, dbpedia) references added manually to different name forms, it contains an inline (WYMeditor-based) editor for marking up simple TEI (name) structures and supplying them with key attributes, and it has a general ATOM-based commenting function.

The app uses XQuery only; no XSLT is used.

The installation will store a number of very basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present name of the app. In order to generate some example results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts within an XRX framework with eXist, created in cooperation with Dan McCreary; see [http://tei.oucs.ox.ac.uk/Oxford/2010-07-oxford/materials/workshops/eXist/ oxford/materials/workshops/eXist].



== Language(s) ==
As wrote before, eXist is a Java application. Anyway, whole applications can be created without writing any line of programming code, but using only XQuery, XSLT, (X)HTML, CSS and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support is provived mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being eXist open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

== Sample implementations ==
* [http://demo.exist-db.org/examples.xml official demo] (without TEI related examples)
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://www.tapor.uvic.ca:8080/cocoon/graves/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions

== Current version number and date of release ==
eXist 1.4 - 2009-09-08

== How to download ==
Download the current stable version (version 1.4, April 2011) from [http://exist-db.org/index.html#download http://exist-db.org/index.html#download eXist Home Page]; check out the current trunk version from "svn co <nowiki>https://exist.svn.sourceforge.net/svnroot/exist/trunk/eXist</nowiki>".

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]

EXist

2011-04-28T09:42:56Z

Jensopetersen: /* Support for TEI */

[[Category:Tools]]

[[Category:Querying tools]]
[[Category:Publishing and delivery tools]]
[[Category:XQuery]]

== Synopsis ==
[http://exist.sourceforge.net/ eXist] is a Native XML Database, used for storing and querying XML files. Since the first versions, made available between 2000 and 2001, eXist has considerably evolved, thanks also to an active community of developers and users, and in its latest releases, it has several functions, such as support for [http://www.w3.org/TR/xquery/ XQuery], [http://www.w3.org/2001/XInclude XInclude] and [http://xmldb-org.sourceforge.net/xupdate/ XUpdate]. Through an integration with [[ApacheCocoon]], [http://www.w3.org/TR/xslt XSLT] processing can be added to the whole workflow, using the pipeline concept of the [http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html Sitemap]. In this way data and documents can be queried and transformed using together, in the same process, [http://www.w3.org/TR/xquery/ XQuery] and [http://www.w3.org/TR/xslt XSLT]. Moreover [http://exist.sourceforge.net/ eXist] can be integrated as a block in [[ApacheCocoon]], so to use all the modules of this framework, and not the limited version shipped with this database. Recently, starting from version 1.1, [http://exist.sourceforge.net/ eXist] has changed the indexing core, becoming more efficient in being used with complex document-centric files, such as TEI encoded texts.

== Features ==
* Persistent storing and indexing of the XML documents
* Database administration functions (data management, backup, recoveries)
* Management of the stored documents in collections
* XQuery engine with extentions for full-text search
* Support for XQuery, XSLT, XInclude and XPointer (partial), XUpdate
* [http://xmldb-org.sourceforge.net/xapi/ XMLDB Api]
* Use of network protocols (HTTP/REST, XML-RPC, SOAP, WebDAV)
* Integration with [[ApacheCocoon]]

== User commentary ==
'''Please sign all comments.'''

Can be very sensitive to placement of certain files, in particular collection.xconf. Silently ignores config files in the wrong place. [[User:Stuartyeates|Stuartyeates]] 18:15, 26 April 2011 (EDT)

== System requirements ==
eXist is written in Java, and therefore requires a [http://java.sun.com/javase/downloads/index.jsp JDK] > 1.4. Being a Java application it can be used on most operating systems, from Windows 2000/XP to Linux or Mac OS X, and it can be deployed in several ways, as a standalone application, as a web application inside a servlet container (such as [http://tomcat.apache.org/ Apache Tomcat] or [http://www.mortbay.org/ Jetty]) or as a Java library in a larger application.

== Source code and licensing ==
eXist is open-source, released under the [http://www.gnu.org/copyleft/lesser.html GNU LGPL] license.

== Support for TEI ==
A TEI module distributed as an eXist application is under development. This protoype can be downloaded from [http://exist.svn.sourceforge.net/viewvc/exist/apps/TEIXLingual/?pathrev=14317 Sourceforge]. The app requires eXist 1.5. To install on a Unix-like system, cd into the directory and call ant. This will create a file named "encyclopedia-0.1.xar" inside the build directory. On your local eXist home page, access the Admin panel, click on Package Reposistory, choose the xar file, and upload and install it. The app can now be accessed from [http://localhost:8080/exist/apps/encyclopedia/ http://localhost:8080/exist/apps/encyclopedia/] on a default installation.

The app is not a full-blown TEI module yet, lacking some fairly obvious features, such as display of metadata about the texts displayed and the ability to browse through texts and marked-up items; these features will be added in May-June 2011. The app contains faceted search feeding off the markup, it makes possible "translingual" searches utilising unique (mainly, dbpedia) references added manually to different name forms, it contains an inline (WYMeditor-based) editor for marking up simple TEI (name) structures and supplying them with key attributes, and it has a general ATOM-based commenting function.

The app uses XQuery only; no XSLT is used.

The installation will store a number of very basic TEI documents in the data directory. These files are excepts from encyclopaedias, whence the present name of the app. In order to generate some example results, select lemma and search for "nation", select term and search for "ars", select name and search for "marx", select text and search for "gouvernement", or select key and search for "http://dbpedia.org/page/French_Revolution".

Joe Wicentowski has a step-by-step introduction with full example files on how to publish TEI texts within an XRX framework with eXist, created in cooperation with Dan McCreary; see [http://tei.oucs.ox.ac.uk/Oxford/2010-07-oxford/materials/workshops/eXist/ oxford/materials/workshops/eXist].



== Language(s) ==
As wrote before, eXist is a Java application. Anyway, whole applications can be created without writing any line of programming code, but using only XQuery, XSLT, (X)HTML, CSS and Javascript. Using the available network interfaces is possible to query eXist not only with Java, and there are already available several modules for other languages ([http://www.bmuskalla.de/DB_eXist/ PHP], [http://query-exist.sourceforge.net/ Perl]) and frameworks ([http://sourceforge.net/projects/springxmldb/ Spring], [http://www.throwingbeans.org/tech/xml_databases_with_exist_and_coldfusion.html ColdFusion], [http://www.zope.org/Members/spilloz/existda Zope]).
The [http://exist-db.org/documentation.html documentation] is available only in english.

== Documentation ==
http://exist-db.org/documentation.html

== Tech support ==
Technical support is provived mainly throught the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Being eXist open-source all kind of support and help is made voluntarily and with no obligations. Anyway the support it is very efficient, and almost all the requests are answered in a complete and qualified way.

== User community ==
The user community is very active and, as for the technical support, the main way of communication is the [http://sourceforge.net/mail/?group_id=17691 mailing list]. Many participants of this list are also part of the TEI Community. There is also a [http://wiki.exist-db.org wiki] and an IRC channel: #existdb at irc.freenode.net.

== Sample implementations ==
* [http://demo.exist-db.org/examples.xml official demo] (without TEI related examples)
* [http://web.uvic.ca/hrd/achallc2005/abstracts.htm ACH/ALLC 2005: Conference Program and Abstracts]
* [http://www.tapor.uvic.ca:8080/cocoon/graves/ Diary of Robert Graves]
* [http://193.204.255.27/operaliber/index.php?page=/operaLiber/home OperaLiber]
* [http://www.anglo-norman.net/ The Anglo-Norman Dictionary]
* [http://mith2.umd.edu/eada/ Early Americas Digital Archive]
* [http://buddhistinformatics.ddbc.edu.tw/BZA/ A Digital Comparative Edition and Translation of the Shorter Chinese Saṃyukta Āgama]
* [http://history.state.gov/ Foreign Relations of the United States and other publications of the Office of the Historian, U.S. Department of State]
* [https://github.com/stuartyeates/He-Kupu-Tawhito Multilingual Concordances with TEI]
* [http://vnsletters.org/VNS/ VNS letters online]: digital edition of letters concerning the Belgian literary journal 'Van nu en Straks'
* [http://ctb.kantl.be/corpora/CPWNL/ Corpus Pieter Willems]: searchable facsimile edition of the first Dutch dialect survey ever
* [http://tbe.kantl.be/TBE/xquery/TBEvalidator.xq TEI validator]: interactive validating app for TEI documents using eXist's XML validation functions

== Current version number and date of release ==
eXist 1.4 - 2009-09-08

== How to download ==
[http://exist-db.org/index.html#download http://exist-db.org/index.html#download].

== See also ==
* [[Berkeley DB XML]]
* [[Base-X]]
* [[TEI Web Publishing]]