ulaulaman
/
citations-tools
mirror of https://github.com/ulaulaman/citations-tools.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README.md 

Add banner, screenshot and update changelog
This commit is contained in:
ulaulaman 2018-02-05 18:50:37 +01:00 committed by GitHub
parent db1f8fbb8b
commit 060cf95100
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,3 +1,5 @@
<div align="center"><img src="https://github.com/ulaulaman/citations-tools/blob/master/assets/banner-772x250.jpg" /></div>
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.
# Description
@ -6,7 +8,7 @@ How to use the shortcode:
[ctdoi code="..."]Title of the paper[/doi]
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 [cpdoiresolve ...].
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 ...].
How to use the shortcode:
[ctdoiresolve code="..."]
@ -21,18 +23,27 @@ if the paper has an arXiv version
if the paper has a free pdf version
[ctdoiresolve code="..." archiveurl="..."]
if the paper has a free version on [https://archive.org/](archive.org)
## External service
**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.
***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>
# 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
* 0.2.5 fix error code
* 0.2.4 changed functions names
* 0.2.3 add pdf link in doi resolver as ahortcode's parameter