opencultureconsulting
/
simple-oai-pmh
mirror of https://github.com/opencultureconsulting/simple-oai-pmh.git
2
0
Fork 0
Code Issues Releases Activity
84 Commits 1 Branch 9 Tags 522 KiB
PHP 64.6%
XSLT 35.4%
Go to file
Sebastian Meyer 1ffce85f73 Add resume to quicklinks 2017-12-22 11:37:44 +01:00
.github Create ISSUE_TEMPLATE 2017-10-19 20:02:24 +02:00
data Support multiple data formats 2017-10-05 18:02:15 +02:00
CODE_OF_CONDUCT.md Add Code of Conduct 2017-10-19 19:34:06 +02:00
CONTRIBUTING.md Add Contribution Guidelines 2017-10-19 19:56:50 +02:00
LICENSE.txt Restructure and update meta files 2017-05-12 18:12:31 +02:00
README.md Add Updater to README.md 2017-12-12 16:28:59 +01:00
index.php Fix some more bugs 2017-10-08 13:38:00 +02:00
oai2config.php Fix syntax error in oaiconfig.php 2017-10-08 12:59:57 +02:00
oai2exception.php Update copyright information and readme 2017-05-13 12:08:11 +02:00
oai2server.php Use another token to split string 2017-12-22 10:50:55 +01:00
oai2transform.xsl Add resume to quicklinks 2017-12-22 11:37:44 +01:00
oai2xml.php Fix some more bugs 2017-10-08 13:38:00 +02:00
update.php Streamline formatting of update.php 2017-12-22 09:56:44 +01:00

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) written in PHP. 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.

Codacy Badge

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 at University of Oldenburg. His latest implementation can be still found via the Internet Archive's Wayback Machine.

It was then modified in 2011 by Jianfeng Li at University of Adelaide for The Plant Accelerator. The modified version can be found in the Google Code Archive.

In 2013 Daniel Neis Araujo at Federal University of Santa Catarina modified the project again in order to integrate it with Moodle. His implementation can be found on GitHub. In 2014 Kazimierz Pietruszewski provided some further bugfixes.

The current implementation was derived from the latter in 2017 by Sebastian Meyer at Open Culture Consulting for the German Literature Archive. It is a stand-alone version focused on easy deployment and file based record handling.