Download the PHP package seboettg/citeproc-php without Composer
On this page you can find all versions of the php package seboettg/citeproc-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download seboettg/citeproc-php
More information about seboettg/citeproc-php
Files in seboettg/citeproc-php
Package citeproc-php
Short Description Full-featured CSL processor (https://citationstyles.org)
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package citeproc-php
citeproc-php
citeproc-php is a full-featured CSL 1.0.1 processor that renders bibliographic metadata into html formatted citations or bibliographies using CSL stylesheets. citeproc-php renders bibliographies as well as citations (except of Citation-specific Options).
Citation Style Language CSL
The Citation Style Language (CSL) is an XML-based format to describe the formatting of citations, notes and bibliographies, offering:
- An open format
- Compact and robust styles
- Extensive support for style requirements
- Automatic style localization
- Infrastructure for style distribution and updating
- Thousands of freely available styles (Creative Commons BY-SA licensed)
For additional documentation of CSL visit http://citationstyles.org.
Installing citeproc-php
The recommended way to install citeproc-php is through Composer.
Add the following lines to your composer.json file in order to add required program libraries as well as CSL styles and locales:
Next, run the Composer command to install the latest stable version of citeproc-php and its dependencies:
After installing, you need to require Composer's autoloader:
You can then later update citeproc-php using composer:
If you have trouble using composer you will find further information on https://getcomposer.org/doc/.
How to use citeproc-php
citeproc-php renders bibliographical metadata into html formatted citations or bibliographies using a stylesheet which defines the citation rules.
Get the metadata of your publications
Create a project folder:
First, you need json formatted metadata array of publication's metadata. There are a lot of services that supports CSL exports. For instance BibSonomy, Zotero, Mendeley. If you don't use any of these services, you can use the following test data for a first step.
Copy this into a file in your project root and name that file metadata.json.
Build a first simple script
You can also render citations instead of bibliographies:
Filter Citations
Since version 2.1 you have also the possibility to apply a filter so that just specific citations appear.
Bibliography-specific styles using CSS
Some CSL stylesheets use bibliography-specific style options like hanging indents or alignments. To get an effect of these options you can render separated Cascading Stylesheets using CiteProc.
You have to insert these styles within the <head> tag of your html output page.
Now, you can watch and test the output using PHP's internal web server:
Start your Browser and open the URL http://localhost:8080.
Under examples folder you will find another example script.
Advanced usage of citeproc-php
Since version 2.1, citeproc-php comes with additional features that are not a part of the CSL specifications.
You can enrich bibliographies and citations with additional HTML tags to inject links (i.e. to set a link to an author's CV), or to add other html markup.
Use Lambda Functions to setup citeproc-php in order to render advanced citations or bibliographies
As you can see, $titleFunction wraps the title and $authorFunction wraps author's name in a link.
Assign these functions to its associated CSL variable (in this case title and author) as follows.
You can also use custom Lambda Functions in order to enrich citations with additional HTML markup.
If you want to restrict citeproc-php to use a custom Lambda Function either for bibliographies or citations, or you want to apply different functions for both, you can define the array as follows:
In this example each entry of the bibliography gets an anchor by its id and the citation (in Elsevier-Vancouver style [1]) gets an URL with a fragment by its id. Hence, every citation mark gets a link to its entry in the bibliography.
Further examples you will find in the example folder.
Good to know
- A custom Lambda Function must have two parameters (
function ($item, $renderedValue) { ... }) in their signature and must return a string. - The 1st parameter of a custom Lambda Function is the item (either a citation item or a name item. Both of type
\stdClass). The 2nd parameter is the rendered result of the associated item. - Custom Lambda Functions may be applied on all Standard Variables (according to the CSL specification).
- Custom Lambda Functions may be applied on all Name Variables (according to the CSL specification). Be aware, just one name item will passed as parameter instead of the full citation item.
- Custom Lambda Function for Number Variables or Date Variables will be ignored.
- is not a valid variable according to the CSL specifications. citeproc-php use to hook in and apply a custom Lambda Function after a whole citation item or bibliography entry is rendered.
Contribution
citeproc-php is an Open Source project. You can support it by reporting bugs, contributing code or contributing documentation.
Star the Repo
Developing software is a hard job and one has to spend a lot of time. Every open-source developer is looking forward about esteem for his work. If you use citeproc-php and if you like it, star it and talk about it in Blogs.
Reporting a Bug
Use the Issue Tracker in order to report a bug.
Contribute Code
You are a developer and you like to help developing new features or bug fixes? Fork citeproc-php, setup a workspace and send a pull request.
I would suggest the following way:
- Fork citeproc-php on Github
-
Clone the forked repo
- Setup your preferred IDE
- Run the UnitTests within your IDE
- Write a test case for your issue. My tests are based on the original test-suite. You can build custom (human-readable) test cases following the described Fixture layout.
-
Additionally, you have to translate (human-readable) test-cases into json format (machine-readable)
-
create a test function within an already existing test class or create a new test class:
- Implement or adapt your code as long as all tests finishing successfully
- Make sure that your test case covers relevant code parts
- Send a pull request
Testing
You can also run test cases without IDE:
Known projects that use citeproc-php
All versions of citeproc-php with dependencies
citation-style-language/locales Version v0.0.*
seboettg/collection Version ^3.1
myclabs/php-enum Version ^1.8
ext-simplexml Version *
ext-json Version *
php Version >=7.3
ext-mbstring Version *
ext-intl Version *