citations-tools/README.md

54 lines
2.5 KiB
Markdown
Raw Normal View History

<div align="center"><img src="https://github.com/ulaulaman/citations-tools/blob/master/assets/banner-772x250.jpg" /></div>
2018-02-01 00:19:04 +01:00
The plugin add some shortcodes add a link to a paper using the doi code or to resolve doi code and publish a full citation apa formatted.
2018-02-02 14:31:42 +01:00
# Description
Using the standard for doi link, the plugin introduce a shortcode in order to create a link to a paper provided by doi.
How to use the shortcode:
2018-02-04 13:49:14 +01:00
[ctdoi code="..."]Title of the paper[/doi]
2018-02-02 14:31:42 +01:00
The plugin send the doi code to [Crossref Metadata Search](https://search.crossref.org/), get the information and publish a full citation in apa standard with the shortcode [ctdoiresolve ...].
2018-02-02 14:31:42 +01:00
How to use the shortcode:
2018-02-04 13:49:14 +01:00
[ctdoiresolve code="..."]
2018-02-02 14:31:42 +01:00
There are also two optional parameters:
2018-02-04 13:49:14 +01:00
[ctdoiresolve code="..." arxiv="..."]
2018-02-02 14:31:42 +01:00
if the paper has an arXiv version
2018-02-04 13:49:14 +01:00
[ctdoiresolve code="..." pdfurl="..."]
2018-02-02 14:31:42 +01:00
if the paper has a free pdf version
[ctdoiresolve code="..." archiveurl="..."]
if the paper has a free version on [https://archive.org/](archive.org)
2018-02-03 12:04:05 +01:00
## External service
2018-02-03 12:16:03 +01:00
**Digital Object Identifier**, or *DOI*, is a persistent identifier used to uniquely identify objects, standardized by the **International Organization for Standardization** (*ISO*). DOIs are mainly used to identify academic, professional, and government information, such as journal articles, research reports and data sets, official publications.
2018-02-03 12:04:05 +01:00
***Citations tools*** uses the [CrossRef Metadata API](http://search.crossref.org/help/api) to retrieve complete publication information using the doi code as a search query. CrossRef is a part of the [doi system](https://dx.doi.org/).
## Screenshot
<div align="center"><img src="https://github.com/ulaulaman/citations-tools/blob/master/assets/screenshot-1.jpg" /><br/>
<em>The doi resolver: the shortcode (up) and the results (down)</em></div>
2018-02-02 14:31:42 +01:00
# Installation
1. Extract the citations-tools.zip file and upload its contents to the /wp-content/plugins/ directory. Alternately, you can install directly from the Plugin directory within your WordPress Install.
2. Activate the plugin through the "Plugins" menu in WordPress.
3. Use the shortcode into your posts or pages.
# Changelog
* 0.2.6 add archive.org link in doi resolver as shortcode's parameter
2018-02-04 13:49:14 +01:00
* 0.2.5 fix error code
2018-02-02 14:32:38 +01:00
* 0.2.4 changed functions names
* 0.2.3 add pdf link in doi resolver as ahortcode's parameter
* 0.2.2 add arXiv link in doi resolver as shortcode's parameter
* 0.2.1 add doi link in doi resolver
* 0.2 add shortcode to resolve doi using code
* 0.1 shortcode for doi link