rudolfbyker/php-marc-csl

description

1.0.0 2021-10-22 10:27 UTC

Requires

• php: >=7.3
• ext-json: *
• scriptotek/marc: ^2.2

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• Rudolf W Byker

README

This package tries to map MARC21 records to CSL variables. There is no official or industry standard mapping. We develop our mapping on our interpretation of:

• the MARC21 docs
• the CSL docs
• the Citeproc JS docs, especially the CSL-JSON part.

To see which MARC fields maps to which CSL variables, look at the documentation or source code of the MarcCslVariables class, especially the getAll() method.

Example usage:

// Get a MARC record (e.g. from an XML file)
$record = Record::fromSimpleXMLElement(simplexml_load_file("marc/xml/35663.xml"));

// Wrap the record in the class provided by this package.
$marcCsl = new MarcCslVariables($record);

// Get the CSL variables as a PHP data structure.
$csl_variables = $csl_variables->jsonSerialize();

// Get the CSL variables as a CSL-JSON string.
$json_string = json_encode($csl_variables);

From here, you can use the CSL JSON string as input for something like CiteProc-JS or CiteProc-PHP in order to generate bibliographies and citations.

Installing

composer require rudolfbyker/php-marc-csl

Running unit tests

composer install
composer test

Reporting bugs

If your data is mapped incorrectly, create an issue or PR, and provide:

• the input MARC data
• the actual output
• the expected output
• links to relevant CSL and MARC documentation
• suggestions for how to fix it

Generating docs

1. Download phpDocumentor. According to https://www.phpdoc.org/, we should not install phpDocumentor using composer. Follow the instructions there to install it.
2. Remove the old docs dir: rm -rf docs.
3. Run phpDocumentor.phar to generate new docs.
4. Commit generated docs. Docs committed to the repository should be available on Github pages: https://github.com/rudolfbyker/php-marc-csl/deployments/activity_log?environment=github-pages