Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/discoverygarden/islandora_xquery

Provides XQuery support via Zorba (http://www.zorba.io/)
https://github.com/discoverygarden/islandora_xquery

drupal-7 tool

Last synced: 4 days ago
JSON representation

Provides XQuery support via Zorba (http://www.zorba.io/)

Awesome Lists containing this project

README 

        
# Islandora XQuery [![Build Status](https://travis-ci.org/discoverygarden/islandora_xquery.png?branch=7.x)](https://travis-ci.org/discoverygarden/islandora_xquery)



## Introduction



This module utilizes Zorba to run XQueries against XML documents stored in Fedora.



## Requirements



In addition to a functioning Islandora instance with the Libraries API, this module requires the following modules/libraries:

* An XQuery processor, one of:

    * [Zorba](http://www.zorba.io/home); or,

    * [BaseX](http://basex.org/)

* [libxdiff](http://www.xmailserver.org/xdiff-lib.html)

* [PHP xdiff Extension](http://www.php.net/manual/en/intro.xdiff.php)

* [GeSHi](http://qbnz.com/highlighter/)

* [Islandora Object Lock](https://github.com/discoverygarden/islandora_object_lock)



## Installation



Example installation scripts:

* [Ubuntu 12.04](resources/install_islandora_xquery.sh)

* [Ubuntu 18.04 and RedHat/Centos 7](resources/install_islandora_xquery_with_basex.sh)



Your mileage may vary with other distros/versions.  These scripts will handle installing the islandora_xquery module and all of its dependencies.  It assumes that you have a functioning Islandora install with Drush.



Basic Algorithm:

* Install XQuery processor

* [Compile libxdiff from source (./configure, make, make install)](http://www.xmailserver.org/xdiff-lib.html)

* [Install PHP xdiff extension](http://www.php.net/manual/en/xdiff.setup.php)

* Install GeSHi using the Libraries API (put geshi folder in sites/all/libraries)

* [Install Islandora Object Lock Module](https://github.com/discoverygarden/islandora_object_lock)

* Install Islandora Xquery Module



## Configuration



At installation time, it may be necessary to select and configure the XQuery

processor to be used at `admin/islandora/tools/xquery/manage/processor`.



Templates can be added for re-use at `admin/islandora/tools/xquery/manage`.



## Troubleshooting/Issues



Having problems or solved a problem? Check out the Islandora google groups for a solution.



* [Islandora Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora)

* [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev)



### Warning!

The default Zorba implementation uses the Saxon processor, which WILL unescape your xml entities!  For example, even the lowly identity transform will change ```"Things and Stuff"``` to  ```”Things and Stuff”```.  You will get some brand spanking new quotes you never asked for!  You’ve been warned!



## Maintainers/Sponsors

Current maintainers:



* [discoverygarden](https://github.com/discoverygarden)



This project has been sponsored by:



* [The Canadian Writing Research Collaboratory](http://www.cwrc.ca/en/)

The Canadian Writing Research Collaboratory is an online project designed to

enable unprecedented avenues for studying the words that most move people in and

about Canada.



## Development



If you would like to contribute to this module, please check out our helpful

[Documentation for Developers](https://github.com/Islandora/islandora/wiki#wiki-documentation-for-developers)

info, as well as our [Developers](http://islandora.ca/developers) section on the Islandora.ca site.



## License



[GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt)