Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history 
Merge with develop for release v1.3.0
  • Loading branch information
@dvglc
dvglc committed May 12, 2019
2 parents 2fb2753 + 0df1f37 commit fa98433
Show file tree
Hide file tree
Showing 100 changed files with 12,524 additions and 36,307 deletions.
6 changes: 2 additions & 4 deletions Readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

This software package provides a XML/TEI-based digital edition environment. It has been developed as the central element of the web presence of the project "[The School of Salamanca. A digital collection of sources and a dictionary of its juridical-political language](https://www.salamanca.school)" of the [Academy of Sciences and Literature | Mainz](https://www.adwmainz.de/), Germany. It is meant to be deployed as an application package within [eXist-db](https://exist-db.org/) and it draws upon a series of further services described in more detail below. The data files as well as other parts of the infrastructure will be published separately.

Technical documentation can be found in <docs/Technical.md> and a description of the API is in <docs/API.md>.

## Features

Expand All @@ -17,17 +18,15 @@ Some of the particular features of this software are the following:

* **Microservices architecture**: Some of the application's functions are implemented as clients requesting data from dedicated services. Navigation between passages relies (in part) on the id service described above, search relies on an [OpenSearch](http://www.opensearch.org/)-compatible search service, image viewing on an [iiif](http://iiif.io/)-conforming image and manifest service etc. For the environment that this application expects, see below.


## Environment

Configuration is concentrated in a single file modules/config.xqm. This file is one of the things you will want to customize when you intend to launch the software yourself. However, at (https://www.salamanca.school), the application is also integrated with the following other servers:
Configuration is concentrated in a single file modules/config.xqm. This file is one of the things you will want to customize when you intend to launch the software yourself. However, at <https://www.salamanca.school>, the application is also integrated with the following other servers:

* an iiif-conformant image server (iiif image and presentation APIs)
* an any23 service rendering rdf information in a desired serialisation
* a sphinxsearch search server, accessed via an opensearch-compatible php interface
* a wordpress blog


## Caveats/provisos

While we consider some aspects of the software sufficiently consolidated and tests to offer them for public review, criticism and re-use, we are well aware that some other areas urgently need to be taken care of. This concerns, among others:
Expand All @@ -37,7 +36,6 @@ While we consider some aspects of the software sufficiently consolidated and tes
* Performance - when we are satisfied with everything, we want to minify js and css code. However, we also have to revise the application more generally in terms of performance. In some cases, caching routines can certainly help (in the case of the rdf lifting service, we have started working on this, but this is not working properly right now.)
* Error handling can certainly be done in a more orderly way.


## License

This software is published under the MIT license:
Expand Down
5 changes: 4 additions & 1 deletion admin.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@ <h2>Works</h2>
<br/>
</table>
<p>
<span data-template="render:needsCorpusZipString">boing</span>
<span data-template="render:needsTeiCorpusZip">boing</span>
</p>
<p>
<span data-template="render:needsTxtCorpusZip">boing</span>
</p>
</div>

Expand Down
66 changes: 21 additions & 45 deletions collection.xconf
View file
Original file line number Diff line number Diff line change
@@ -1,52 +1,8 @@
<collection xmlns="http://exist-db.org/collection-config/1.0">
<index xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:tei="http://www.tei-c.org/ns/1.0" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:sal="http://salamanca.adwmainz.de">
<index xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:tei="http://www.tei-c.org/ns/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:sal="http://salamanca.adwmainz.de">

<fulltext default="none" attributes="false"/>


<!--
<lucene diacritics="no">

<!-\- <analyzer class="org.apache.lucene.analysis.standard.StandardAnalyzer"/> -\->
<analyzer class="org.apache.lucene.analysis.core.StandardAnalyzer"/>
<analyzer id="ws" class="org.apache.lucene.analysis.core.WhitespaceAnalyzer"/>

<!-\- Fields: all (i.e. p+head+list(+note?)), heading, note, person, place, lemma, dict, entry -\->
<!-\- Wir indizieren keine div's, weil die verschachtelt sind und für dieselbe Textstelle immer mehrere Hits generieren -\->
<text qname="tei:head" boost="1.8"/> <!-\- Überschriften -\->
<text qname="@key" boost="1.8"/> <!-\- normierte Schreibungen -\->
<text qname="@n" boost="1.8"/> <!-\- manuell angelegte Kurzformen der Summarien -\->
<text qname="@xml:id"/> <!-\- so id lookup is sped up also in expanded documents -\->
<text qname="tei:item"/> <!-\- Listeneinträge, z.B. Inhaltsangaben -\->
<text qname="tei:p"> <!-\- Haupttext -\->
<ignore qname="tei:note"/> <!-\- We index those separately for extra queries, but we exclude them -\->
<ignore qname="tei:head"/> <!-\- from the 'p' index in order not to get duplicate hits -\->
<ignore qname="tei:list"/>
<ignore qname="@n"/>
<ignore qname="@key"/>
</text>
<text qname="tei:note"/> <!-\- Here is what we can query explicitly -\->
<text qname="tei:persName"/>
<text qname="tei:placeName"/>
<text qname="tei:title"/>
<text qname="tei:term"/>
<text qname="tei:titlePage"/>
<text qname="tei:imprint"/>
<inline qname="tei:hi"/> <!-\- The following don't mark word boundaries by themselves -\->
<inline qname="tei:choice"/>
<inline qname="tei:corr"/>
<inline qname="tei:expan"/>
<inline qname="tei:reg"/>
<inline qname="tei:sic"/>
<inline qname="tei:g"/>
<ignore qname="tei:abbr"/> <!-\- The following are ignored altogether -\->
<ignore qname="tei:orig"/>
<ignore qname="tei:cb"/>
<ignore qname="tei:lb"/>
<ignore qname="tei:pb"/>
<ignore qname="tei:fw"/>
</lucene>
-->
<range>

<!-- sal index file fields ... -->
Expand All @@ -64,6 +20,7 @@
<create qname="tei:char"/>
<create qname="tei:date">
<field name="tei.date.type" match="@type" type="xs:string"/>
<field name="tei.date.when" match="@when" type="xs:string"/>
</create>
<create qname="tei:div">
<field name="tei.div.n" match="@n" type="xs:string"/>
Expand All @@ -83,6 +40,16 @@
<create qname="tei:text">
<field name="tei.text.type" match="@type" type="xs:string"/>
</create>
<create qname="tei:pb">
<field name="tei.pb.n" match="@n" type="xs:string"/>
<field name="tei.pb.facs" match="@facs" type="xs:string"/>
</create>
<create qname="tei:note">
<field name="tei.note.n" match="@n" type="xs:string"/>
</create>
<create qname="tei:milestone">
<field name="tei.milestone.n" match="@n" type="xs:string"/>
</create>

<!-- HTML elements... -->
<create qname="div">
Expand All @@ -93,6 +60,15 @@
<field name="a.href" match="@href" type="xs:string"/>
</create>


<!-- RDF elements... -->
<create qname="rdf:Description">
<field name="rdf.description.about" match="@rdf:about" type="xs:anyURI"/>
</create>
<create qname="rdfs:seeAlso">
<field name="rdfs.seeAlso.about" match="@rdf:resource" type="xs:anyURI"/>
</create>
<create qname="rdfs:label"/>
</range>

</index>
Expand Down

0 comments on commit fa98433

Please sign in to comment.