README

• 作者：Matt Butcher matt@aleph-null.tv，2010-02-06
• 许可证：类似MIT的许可证 (COPYING-MIT.txt)

此库为 RIS 格式提供基本的序列化和反序列化支持。

RIS 用于编码参考的元数据。该格式的规范性参考可在此找到

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

安装

方法 1： 使用 Packagist 安装。

1. 按照 https://packagist.org.cn 上的说明进行操作
2. 在您的新项目中，创建一个 composer.json 文件，其中需要 LibRIS

{
  "require": {
    "technosophos/LibRIS": ">=1.0.0"
  }
}

下次运行 php composer.phar install 时，它将自动获取并安装 LibRIS。

请注意，从 LibRIS 2.0.0 版本开始，Composer 自动加载器可以加载 LibRIS

<?php
require 'vendor/.composer/autoload.php';

use \LibRIS\RISReader;

$reader = new RISReader();

//...
?>

方法 2： 使用 Pear 安装 LibRIS

使用您的 pear 客户端安装 LibRIS

pear channel-discover pear.querypath.org
pear install querypath/LibRIS

有关更多信息，请参阅 pear.querypath.org.

在脚本中使用它如下

<?php
require 'LibRIS.php';
?>

如果您已经使用 Pear 安装了 LibRIS，您可以通过执行 pear upgrade LibRIS 将您的库升级到最新稳定版本。

方法 3： 下载 LibRIS

1. 从 下载页面 获取 LibRIS
2. 解压缩文件 (tar -zxvf LibRIS-1.0.0.tgz)
3. 将文件放在您想要的位置。

在脚本中使用它如下

<?php
require 'path/to/LibRIS.php';
?>

使用 LibRIS

此类的一般用法很简单

• LibRIS 类用于解析 RIS。
• RISWriter 类用于将 RIS 数据写入字符串。

以下是一个示例（来自 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);
?>

以下是对上述代码的逐行解释

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.

记录的格式在 doc/RecordFormat.mdown 中有文档记录。

我发现了一个错误！

如果您发现了一个错误，请 告知 我。最佳方式是在 http://github.com/technosophos/LibRIS/issues 上提交报告。

您也可以在 Freenode 的 IRC 上的 #querypath 找到我。

Phing 脚本

此文件包含一个 Phing build.xml 脚本。然而，它很少被使用。

如果您有兴趣将其用作构建工具链的一部分，请参阅 phing.info

为什么会有 README 文件和 README.mdown 文件？

• README 是 Pear 打包系统的一个必需文件。
• README.mdown 是本项目针对 GitHub 优化的 README 文件。