Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bpiwowar/papercite

Bibtex plugin for wordpress
https://github.com/bpiwowar/papercite

Last synced: 7 days ago
JSON representation

Bibtex plugin for wordpress

Awesome Lists containing this project

README

        

# PAPERCITE

**Contributors:** bpiwowar, digitalfisherman
**Tags:** formatting, bibtex, bibliography, footnotes
**Requires at least:** 3.8
**Tested up to:** 5.4
**Stable Tag:** 0.5.23
**License:** GPLv2 or later
**License URI:** http://www.gnu.org/licenses/gpl-2.0.html

Papercite helps to format bibtex entries to display a bibliography or
cite papers.
***This fork adds support for textual footnotes, besides references from bibliograhic databases.***

## Description

[![Build Status](https://travis-ci.org/bpiwowar/papercite.svg?branch=master)](https://travis-ci.org/bpiwowar/papercite)

**To report bugs or request features, please go to https://github.com/digfish/papercite**. **Documentation can be found on http://papercite.readthedocs.org/en/latest/**.

papercite format bibtex entries as HTML so they can be inserted in
WordPress pages and posts. The input data is a bibtex file (either local
or remote) and entries can be formatted by default using various
predefined styles. Bibtex source file and a link to the publication are
also available from the HTML.

*Input*: Sources files are BibTex files that can be:

* WordPress media files (since 0.5.6)
* Stored into a WordPress folder (with multi-site support);
* An URL (e.g., from citeulike.org and bibsonomy.org);
* A custom field when local to a post/page

*Efficiency*:

* *Database backend* to speed up the processing by caching the bibtex
entries for big BibTeX files.
* Fast OsBiB-based parser

*Filtering and grouping*:

* Filtering on publication type and authors
* Regular expression filtering on any type
* Publications can be grouped and sorted in various ways

*Output*:

* Access the single bibtex entry source code to enable copy&paste
(toggle-enabled visualization)
* Easy output customisation with the use of two templates: one for
each entry, one for the list of entries
* Auto-detection of PDF files based on the BibTeX key (or on the PDF
entry)
* Citation mode: use references in the text and print the citations at
the end of a block, page or post
* Form to let the user dynamically filter the entries

**Documentation can be found from within WordPress plugin list (click on
the documentation link)**. You can see the documentation of the plugin
as installed on my site here.

*Contributors*:

* B. Piwowarski (main developper)
* Jaroslav Vítků: Filtering by author and type; form to filter
publications
* Michael Schreifels: auto-bibshow and no processing in post lists
options
* Stefan Aiche: group by year option
* Łukasz Radliński: bug fixes & handling polish characters
* Max Harper: patch for having good URLs
* Martin Henze: option for highlighting name(s) of specific
author(s)/editor(s)
* Some parts of the code come from bib2html (version 0.9.3) written by
Sergio Andreozzi.
* Samuel Viana aka digfish (digitalfisherman on Wordpress) : current mantainer

## Installation

Follow these step or use the plugin installer from WordPress to install
papercite:

1. download the zip file and extract the content of the zip file into a
local folder
2. upload the folder papercite into your wp-content/plugins/ directory
3. log in the wordpress administration page and access the Plugins menu

Then, you should activate papercite, and follow the instructions given
in the *documentation* that you can access through the plugin list
(click on the documentation link).

## Frequently Asked Questions

# Where is the documentation?

The documentation is now bundled with the plug-in. Go to the plug-in
list page in the WordPress dashboard, and click on the documentation
link.

# How can I edit my bibtex files?

If your file is local to the blog installation, you have two options:

* via FTP client with text editor
* via Wordpress Admin interface: Manage->Files->Other Files

** use wp-content/papercite-data/bib/mybibfile.bib as a path

Alternatively, you can maintain your updated biblilography by using
systems such as citeulike.org and bibsonomy.org; specify the bib file
using as a URL (e.g., in citeulike, you should use
http://www.citeulike.org/bibtex/user/username)

# How are the entries sorted?

Entries are sorted by year by default.

# How can I personalize the HTML rendering?

The HTML rendering is isolated in two template files, located in the
subfolders tpl (citation list rendering) and format (entry rendering).

# How do I use the new textual footnotes ?

Using the new shortcode `[ppcnote]`. For example:

In molecular biology, the term double helix [ppcnote]usually applies to DNA[\ppcnote]

will result in a footnote being generated after the post text. The numbering of the footnotes is separated from the one used in the citations.

## Screenshots

### 1. With the bibshow & bibcite commands
![With the bibshow & bibcite commands](https://ps.w.org/papercite/assets/screenshot-1.png)

![With the bibshow & bibcite commands](https://ps.w.org/papercite/assets/screenshot-1.png)
[With the bibshow & bibcite commands]

### 2. With the bibtex command
![With the bibtex command](https://ps.w.org/papercite/assets/screenshot-2.png)

![With the bibtex command](https://ps.w.org/papercite/assets/screenshot-2.png)
[With the bibtex command]

### 3. The bibfilter command
![The bibfilter command](https://ps.w.org/papercite/assets/screenshot-3.png)

![The bibfilter command](https://ps.w.org/papercite/assets/screenshot-3.png)
[The bibfilter command]

## Changelog

### 0.5.23
* Fixed warning on PHP using continue statement (issue #147)

### 0.5.22
* Fixed problem with uploading .bib files to the media library was being denied for security reasons (issue #144)

### 0.5.20

* Support for textual footnotes
* Minor bug corrections

### 0.5.18

- Fixed ignored limit option (issue #128)
- More tests to cover potential future issues

### 0.5.17

- Updated tests (docker & travis)
- PHP fixes
- Added support for -- and special latex commands (issue #111)
- Added modifiers for output (html, strip, protect, sanitize)
- SSL certificates can be ignored (issue #98)

### 0.5.15

- Fixed yet another bug with remote URL fetching

### 0.5.14

- Fixed a fatal error for remote URLs

### 0.5.13

- New "show_links" option to display links with bibcite
- New "highlight" option to highlight authors and editors
- Bibfilter form is now using UTF-8 (issue #87)
- Fixed formatting issues
- Corrected warnings (undefined variables and constants)

### 0.5.12

- Fixed a bug with bibfilter
- Fixed handling of letter "n" with accute accent in OSBib (issue #83)

### 0.5.11

- Improved documentation for customizing templates and CSS (issue #81)
- Custom post/page options refactored (partial fix for issue #80)

### 0.5.10

- Better handling of errors when retrieving remote URLs
- Fixed warnings and issue more error messages when something goes
wrong (issue #80)

### 0.5.9

- (Bug #79) Clears the cache upon upgrading to avoid unknown class
names when deserializing

### 0.5.7

- Prevents name clash with other modules using OSBib (e.g.
TeachPress). Fixes #79.

### 0.5.6

- Handles accents with a space before the accentuated character. Fixes
#70
- Added support for Czech accents to osbib parser. Fixes #77. Thanks
to mcapino.
- Files can come from wordpress media (issue #76)
- Improved the speed of the OSBib parser (issue #68)

### 0.5.5

- OSBib parser is now the default
- Handles non-standard plugin folder

### 0.5.4

- Incompatibility with PHP version < 5.4

### 0.5.2

- Option to add new files detectors (beyond pdf) - issue #38
- Option to control title processing (issue #54)
- Any field can now be used for filters (issue #62)
- Unparseable year field causes database issues (issue #63)

### 0.5.1

- The journal field was not parsed with OSBiB (issue #59)

### 0.5.0

- @conference is now properly handled as @inproceedings (issue #53)
- Option to limit the number of papers output by bibtex (issue #50)
- More accents handled (issue #51)
- Added support for interactive filtering by means of new command
(bibfilter). Thanks to Jaroslav Vítků
- Added support for these additional filtering commands to bibtex
command (author and type)
- Added two new options: auto-bibshow and skip display in post lists
(thanks to Michael Schreifels)
- Fixed quite a few PHP warnings

### 0.4.5

- Fixed bug #48 (URL as source not working anymore with PHP < 5.4)

### 0.4.4

- Fix problems with ignored booktitle in books (harvard and ieee
styles) - fixes issue #45
- Fix for newlines by L. Murray (issues #26 and #35)
- Handles for URL types (issue #41, A. Dyck)

### 0.4.3

- Maintenance mode plugins support (bug #39)
- Support for PHP 5.4 (bug #37)
- Improved accent support - bug #36 (josemmoya)

### 0.4.2

- Fixes fatal error in PHP 5.4 (bug #37)
- Improved accent support - bug #36 (josemmoya)

### 0.4.1

- Post/page BibTeX entries from custom fields
- Bug fixes and information for database backend

### 0.4.0

- Optional database backend
- New style "plain" (thanks to Andrius Velykis)
- New template "av-bibtex" (thanks to Andrius Velykis)
- Improved compatibility with the highlight plugin (thanks to Andrius
Velykis)

### 0.3.21

- Fixed issue #26 (newlines stripped from bibtex)
- Fixed bug #32 (thanks to petrosb)

### 0.3.20

- OSBib now returns a correct entry type (closes #28)

### 0.3.19

- Improved parsing for the OSBib parser (closes #29, #27)
- Handles properly authors initials : closes #31 (thanks to petrosb)

### 0.3.18

- Enhancement #25 (display the bibliography at the end if no bibshow
is given)

### 0.3.17

- Fixed a small bug in the OSBiB parser

### 0.3.16

- Updated the documentation about how papercite searches for PDFs
- Added the OSBiB bibtex parser which should be much fadster than the
previous (pear) one (note that it is not actived by default for the
moment, so you should go to the plugin preferences page to set it as
your bibtex parser).

### 0.3.15

- Corrected "Bootitle" to "booktitle" in all formats (thanks to
Enkerli@github)
- Corrected a numbering bug that skipped numbers from 1 to 20 (issue
#11)

### 0.3.14

- The HTML code produced has been cleaned up (valid HTML) [bug 28]

### 0.3.13

- Enhancement (bug 26): several bibtex files can be given
- New (optional) bibtex parser handles larger bibtex files (bug 23)
- Master thesis is now properly handled (bug 27)

### 0.3.12

- Fix missing