HAB eXist-db OAI-PMH Interface

This is the OAI-PMH Interface for the Manuscript Database by Herzog August Bibliothek Wolfenbüttel. The interface is implemented as an eXist-db application. All versions can be downloaded here.

Deployment

Just upload the .xar file to your eXist-db package manager. See available versions.

Configuration can be changed in the package's profiles.xml. Either change the default profile or copy it, choose a different name for it and change it. To make the app use a non-default profile, the url parameter profile=my-profile needs to be specified when making OAI PMH requests.

Special care has to be taken with data containing the xml:base attribute. The attribute influences the way the app determines document locations and therefore leads to problems. In most circumstances, it should be removed. Run the included find-xml-base.xq script with eXide's "Eval" to find affected documents.

Development

This repository ships with a Vagrantfile so you may run

vagrant up

to get startet. The dataset used to develop this software is not included and has to be installed afterwards, which is very simple: Given the file mss.zip in /vagrant/mss.zip, do

vagrant ssh
cd /mnt
sudo /vagrant/bin/mount.sh # leave password empty when prompted

sudo unzip /vagrant/mss.zip
sudo cp -urv mss/ dav/ # this will take a lot of time
sudo rm -rf mss
sudo umount dav

At this point the data is available and the application can be used at https://localhost:8080

Tests

The application has been validated with the official OAI-PMH validator and there is a number of local tests available as rspec tests. To run them, install ruby, run bundle install and then bundle exec rspec.

XQuery and eXist-db resources

• https://www.w3.org/TR/2017/REC-xquery-31-20170321/#id-filter-expression
• https://www.ibm.com/support/knowledgecenter/en/SSEPGG_10.5.0/com.ibm.db2.luw.xml.doc/doc/xqrduration.html
• http://www.april.secac.com/website/YoungloveTEI.pdf
• https://www.tutorialspoint.com/xquery/xquery_indexof.htm
• http://www.xqueryfunctions.com/xq/fn_base-uri.html
• http://exist-db.org/exist/apps/fundocs/index.html
• https://www.w3schools.com/xml/xquery_example.asp
• https://www.w3.org/TR/xquery-operators/#general-seq-funcs
• https://www.w3.org/TR/2017/REC-xquery-31-20170321/
• http://www.existsolutions.com/contact.xml
• https://stackoverflow.com/questions/3782508/updating-variables-in-xquery-possible-or-not