README

• Author: Matt Butcher matt@aleph-null.tv, 2010-02-06
• License: An MIT-like license (COPYING-MIT.txt)

This library provides basic marshaling and unmarshaling support for the RIS format.

RIS is used to encode metadata about references. The normative reference for the format can be found here:

http://www.refman.com/support/risformat_intro.asp

Installation

composer require researchgate/libris

Using LibRIS

General usage for this class is simple:

• The LibRIS class is used to parse RIS.
• The RISWriter class is used for writing RIS data into a string.

Here's an example (from test/simple_test.php):

<?php
require_once 'LibRIS/RISReader.php';
require_once 'LibRIS/RISWriter.php';

$ris = new \LibRIS\RISReader();
$ris->parseFile('./test1.ris');

$ris->printRecords();

$records = $ris->getRecords();

$rw = new \LibRIS\RISWriter();
print $rw->writeRecords($records);
?>

Here's a line-by-line explanation of the code above:

1. Include the libraries.
2. You don't need this if you use an autoloader.
3. 
4. Create a new LibRIS reader
5. Parse a file
6. 
7. Pretty-print the parsed records
8. 
9. Create a new writer
10. Turn our parsed record back into a valid RIS record.

The format of the records is documented in doc/RecordFormat.mdown.

I Found a Bug!

If you found a bug, please let me know. The best way is to file a report at http://github.com/technosophos/LibRIS/issues.

You can also find me on Freenode's IRC in #querypath.

Why is there a README file and a README.mdown file?

• README is a required file for the Pear packaging system.
• README.mdown is the GitHub-friendly README file for this project.