simple-oai-pmh/README.md

29 lines
2.5 KiB
Markdown
Raw Normal View History

2017-05-12 18:12:31 +02:00
Simple OAI-PMH 2.0 Data Provider
================================
2013-05-15 04:05:24 +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 a directory of XML files using the filename as identifier and the filemtime as datestamp. Resumption tokens are managed using files. Multiple metadata formats and sets are currently not supported.
2013-05-15 04:05:24 +02:00
Just put the records as XML files in the data directory, adjust a few configuration settings and you are ready to go!
2013-05-15 04:05:24 +02:00
Installation
------------
2013-05-15 04:05:24 +02:00
1. Deploy all the files to a webserver.
2013-05-15 04:05:24 +02:00
2. Put the records into the data/ directory (or create a symlink named "data" pointing to your records). Each record has to be a separate XML file with its identifier as filename (i.e. 12345678.xml).
2013-05-15 04:05:24 +02:00
3. Edit oai2config.php and adjust the settings according to your preferences.
2013-05-15 04:05:24 +02:00
4. Congratulations! Now you are running an OAI-PMH 2.0 compatible data provider.
2013-05-15 04:05:24 +02:00
History
-------
2013-05-15 04:05:24 +02:00
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/).
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/).
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).
2017-05-13 13:37:53 +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 simplified stand-alone version focused on easy deployment and file based record handling.