simple-oai-pmh/README.md

Simple OAI-PMH 2.0 Data Provider
================================

This is a stand-alone and easy to install data provider for the [Open Archives Initiative's Protocol for Metadata Harvesting (OAI-PMH)](http://openarchives.org/pmh/) written in [PHP](http://php.net/). It serves records in any metadata format from directories of XML files using the directory name as metadata prefix, the filename as identifier and the filemtime as datestamp. 0-byte files are considered deleted records and handled accordingly. Resumption tokens are managed using files. Sets are currently not supported.

Just put the records as XML files in the data directory, adjust a few configuration settings and you are ready to go!

A demo installation can be found [here](http://demo.opencultureconsulting.com/oai_pmh/?verb=Identify).

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/cd72907ff98f4e01beb32576319b83a2)](https://www.codacy.com/app/OCC/OAI-PMH.DataProvider)

Installation
------------

1. Deploy all the files to a webserver.

2. Edit oai2config.php and adjust the settings according to your preferences.

3. Put the records into the specified data directory. Each record has to be a separate XML file with its identifier as filename (i.e. 12345678.xml). Optionally you can maintain deletions by keeping 0-byte files for deleted records.

4. Congratulations! Now you are running an OAI-PMH 2.0 compatible data provider.

5. Updating your records from the command line is just as easy with the update.php script!

History
-------

This project was originally initiated in 2002 by [Heinrich Stamerjohanns](mailto:stamer@uni-oldenburg.de) at [University of Oldenburg](https://www.uni-oldenburg.de/en/). His latest implementation can be still found via the [Internet Archive's Wayback Machine](https://web.archive.org/web/*/http://physnet.uni-oldenburg.de/oai/).

It was then modified in 2011 by [Jianfeng Li](mailto:jianfeng.li@adelaide.edu.au) at [University of Adelaide](http://www.adelaide.edu.au/) for [The Plant Accelerator](http://www.plantaccelerator.org.au/). The modified version can be found in the [Google Code Archive](https://code.google.com/archive/p/oai-pmh-2/).

In 2013 [Daniel Neis Araujo](mailto:danielneis@gmail.com) at [Federal University of Santa Catarina](http://en.ufsc.br/) modified the project again in order to integrate it with [Moodle](https://moodle.org/). His implementation can be found on [GitHub](https://github.com/danielneis/oai_pmh). In 2014 [Kazimierz Pietruszewski](mailto:antenna@antenna.io) provided some [further bugfixes](https://github.com/antennaio/oai_pmh).

The current implementation was derived from the latter in 2017 by [Sebastian Meyer](mailto:sebastian.meyer@opencultureconsutling.com) at [Open Culture Consulting](https://www.opencultureconsulting.com/) for the [German Literature Archive](http://www.dla-marbach.de/en/). It is a stand-alone version focused on easy deployment and file based record handling.
Restructure and update meta files 2017-05-12 18:12:31 +02:00			`Simple OAI-PMH 2.0 Data Provider`
Update copyright information and readme 2017-05-13 12:08:11 +02:00			`================================`
Updating docs 2013-05-15 04:05:24 +02:00
Support multiple data formats 2017-10-05 18:02:15 +02:00			This is a stand-alone and easy to install data provider for the [Open Archives Initiative's Protocol for Metadata Harvesting (OAI-PMH)](http://openarchives.org/pmh/) written in [PHP](http://php.net/). It serves records in any metadata format from directories of XML files using the directory name as metadata prefix, the filename as identifier and the filemtime as datestamp. 0-byte files are considered deleted records and handled accordingly. Resumption tokens are managed using files. Sets are currently not supported.
Updating docs 2013-05-15 04:05:24 +02:00
Update copyright information and readme 2017-05-13 12:08:11 +02:00			`Just put the records as XML files in the data directory, adjust a few configuration settings and you are ready to go!`
Updating docs 2013-05-15 04:05:24 +02:00
Add demo link to README 2017-05-21 20:05:20 +02:00			`A demo installation can be found [here](http://demo.opencultureconsulting.com/oai_pmh/?verb=Identify).`

Add Codacy badge to README 2017-10-13 14:41:12 +02:00			`[![Codacy Badge](https://api.codacy.com/project/badge/Grade/cd72907ff98f4e01beb32576319b83a2)](https://www.codacy.com/app/OCC/OAI-PMH.DataProvider)`

Update copyright information and readme 2017-05-13 12:08:11 +02:00			`Installation`
			`------------`
Updating docs 2013-05-15 04:05:24 +02:00
Update copyright information and readme 2017-05-13 12:08:11 +02:00			`1. Deploy all the files to a webserver.`
Updating docs 2013-05-15 04:05:24 +02:00
Make data directory configurable 2017-06-09 18:50:11 +02:00			`2. Edit oai2config.php and adjust the settings according to your preferences.`
Updating docs 2013-05-15 04:05:24 +02:00
Fix format of README file 2017-10-08 12:51:50 +02:00			`3. Put the records into the specified data directory. Each record has to be a separate XML file with its identifier as filename (i.e. 12345678.xml). Optionally you can maintain deletions by keeping 0-byte files for deleted records.`
Support deletions by keeping 0-byte files 2017-09-28 14:47:24 +02:00
Update copyright information and readme 2017-05-13 12:08:11 +02:00			`4. Congratulations! Now you are running an OAI-PMH 2.0 compatible data provider.`
Updating docs 2013-05-15 04:05:24 +02:00
Add Updater to README.md 2017-12-12 16:28:59 +01:00			`5. Updating your records from the command line is just as easy with the update.php script!`

Update copyright information and readme 2017-05-13 12:08:11 +02:00			`History`
			`-------`
Updating docs 2013-05-15 04:05:24 +02:00
Fix email links in README.md 2017-05-13 13:25:05 +02:00			`This project was originally initiated in 2002 by [Heinrich Stamerjohanns](mailto:stamer@uni-oldenburg.de) at [University of Oldenburg](https://www.uni-oldenburg.de/en/). His latest implementation can be still found via the [Internet Archive's Wayback Machine](https://web.archive.org/web/*/http://physnet.uni-oldenburg.de/oai/).`
Update copyright information and readme 2017-05-13 12:08:11 +02:00
Fix typos 2017-05-13 13:26:17 +02:00			`It was then modified in 2011 by [Jianfeng Li](mailto:jianfeng.li@adelaide.edu.au) at [University of Adelaide](http://www.adelaide.edu.au/) for [The Plant Accelerator](http://www.plantaccelerator.org.au/). The modified version can be found in the [Google Code Archive](https://code.google.com/archive/p/oai-pmh-2/).`
Update copyright information and readme 2017-05-13 12:08:11 +02:00
Another typo... 2017-05-13 13:38:44 +02:00			`In 2013 [Daniel Neis Araujo](mailto:danielneis@gmail.com) at [Federal University of Santa Catarina](http://en.ufsc.br/) modified the project again in order to integrate it with [Moodle](https://moodle.org/). His implementation can be found on [GitHub](https://github.com/danielneis/oai_pmh). In 2014 [Kazimierz Pietruszewski](mailto:antenna@antenna.io) provided some [further bugfixes](https://github.com/antennaio/oai_pmh).`
Update copyright information and readme 2017-05-13 12:08:11 +02:00
Small correction in README :) 2017-10-19 10:17:19 +02:00			`The current implementation was derived from the latter in 2017 by [Sebastian Meyer](mailto:sebastian.meyer@opencultureconsutling.com) at [Open Culture Consulting](https://www.opencultureconsulting.com/) for the [German Literature Archive](http://www.dla-marbach.de/en/). It is a stand-alone version focused on easy deployment and file based record handling.`