Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
nigelgbanks committed Mar 4, 2014
0 parents commit 4a0f272
Show file tree
Hide file tree
Showing 8 changed files with 801 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.DS_Store
*~
674 changes: 674 additions & 0 deletions LICENSE.txt

Large diffs are not rendered by default.

60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# 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 agains XML documents stored in Fedora.

## Requirements

This module requires the following modules/libraries:

* [Islandora](https://github.com/islandora/islandora)
* [Tuque](https://github.com/islandora/tuque)
* [Zorba](http://www.zorba.io/home)

## Installation

Install as usual, see [this](https://drupal.org/documentation/install/modules-themes/modules-7) for further information.

For Zorba...

## Configuration

Set the paths for `example` and `module` in Administration » Islandora » MODULE (admin/islandora/module).

Include a screenshot of configuration page.

## 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)

## FAQ

Q. Is this normal?

A. Yes. This is normal. Why ...

## 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)
6 changes: 6 additions & 0 deletions includes/utilities.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?php

/**
* @file
* This file contains helper functions used throughout this module.
*/
7 changes: 7 additions & 0 deletions islandora_xquery.info
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name = Islandora XQuery
description = "Allows the user to modify objects datastreams using XQuery."
package = Islandora
version = 7.x-dev
core = 7.x
dependencies[] = islandora
php = 5.3
8 changes: 8 additions & 0 deletions islandora_xquery.install
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?php

/**
* @file
* Defines the install and uninstall hooks for this module.
*/

// @todo Add function to test for Zorba install.
6 changes: 6 additions & 0 deletions islandora_xquery.module
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?php

/**
* @file
* Defines all the hooks this module implements.
*/
38 changes: 38 additions & 0 deletions tests/xquery.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?php

/**
* @file
* Unit tests for XQuery wrapper functions.
*/

class XQueryUnitTestCase extends DrupalUnitTestCase {

/**
* Gets info to display to describe this test.
*
* @see DrupalUnitTestCase::getInfo()
*/
public static function getInfo() {
return array(
'name' => 'XQuery Unit Tests',
'description' => 'Ensure that XQuery functions correctly.',
'group' => 'Islandora',
);
}

/**
* Sets up the requirements for this test.
*
* @see DrupalUnitTestCase::setUp()
*/
public function setUp() {
parent::setUp('islandora_xquery');
}

/**
* Test running XQuery against fixtures.
*/
public function testXQuery() {
}

}

0 comments on commit 4a0f272

Please sign in to comment.