README

A PHP class to interface with the Bibutils libraries written in ANSI C. Bibutils is a set of C programs written by Chris Putnam.

"The bibutils program set inter-converts between various bibliography formats using a common MODS-format XML intermediate. For example, one can convert RIS-format files to BibTeX by doing two transformations: RIS->MODS->BibTeX. By using a common intermediate for N formats, only 2N programs are required and not N^2-N. These programs operate on the command line and are styled after standard UNIX-like filters." (see CTAN package)

The current version of the libraries using in this project is bibutils 6.10 (released on 2020-03-23). The original files are unmodified and distributed under the GNU General Public License Version 2.

Metadata Object Description Schema (MODS)

The Library of Congress's Metadata Object Description Schema (MODS) XML format:

"MODS is an XML schema and guidelines for encoding a resource description. It supports discovery and management of resources, and access to them, as well as exchange and management of encoded descriptions." (see design principles)

Related:

• Short introduction to using MODS by mChris Putnam.
• Metadata Authority Description Schema (MADS)
• MODS Example XML Documents
• Top-Level Elements in MODS

Installation

$ composer require proximify/bibutils
$ cd vendor/proximify/bibutils && composer build

Class synopsis

namespace Proximify;

class Bibutils {
    public static read( array $options) : string
    public static convert( string $options) : string
}

read

public static Bibutils::read( array $options ) : string

Description

This method reads read bibliographic contents of a file into a MOD XML string. The input is inferred from the file extensions when not explicitly given.

Parameters

Return Values

The loaded bibliographic data. A generic Exception is thrown on error.

convert

public Bibutils::convert( array $options ) : string

Description

This method reads read bibliographic contents of a file into a MOD XML strin and converts it to a selected output bibliographic format. The input format is inferred from the file extensions when not explicitly given.

Parameters

Return Values

The converted bibliographic data. A generic Exception is thrown on error.

Examples

use Proximify\Bibutils;

// Read an EndNote XML into MOD XML
$xml = Bibutils::read(['filename' => 'dev/data/bibtex/one_of_each.bib']);

// Load a RIS file and converted into a BibTex string
$bib = Bibutils::convert(['filename' => 'refs.ris', 'out' => 'bib']);

CLI Scripts

composer app:read dev/data/bibtex/one_of_each.bib
composer app:convert dev/data/bibtex/one_of_each.bib end

Bibutils references

• SourceForge Bibutils 6.10
• CTAN Bibutils 6.7

List of programs

The table below is from the SourceForge documentation

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to and actually do, grant us the rights to use your contribution. For details, visit our Contributor License Agreement.

When you submit a pull request, we will determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided. You will only need to do this once across all repositories using our CLA.

This project has adopted the Proximify Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact support@proximify.com with any additional questions or comments.

License

Copyright (c) Proximify Inc. All rights reserved.

Licensed under the MIT license. Please see License File for more information.

Bibutils (PHP Wrapper) is made by Proximify. We invite the community to participate.