Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flashpixx/jQuery-BibJSON
jQuery plugin to create a bibliographie based on BibJSON and BibTeX
https://github.com/flashpixx/jQuery-BibJSON
bibliography bibtex jquery jquery-plugin
Last synced: 5 days ago
JSON representation
jQuery plugin to create a bibliographie based on BibJSON and BibTeX
- Host: GitHub
- URL: https://github.com/flashpixx/jQuery-BibJSON
- Owner: flashpixx
- License: other
- Created: 2016-08-09T17:24:25.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-15T10:05:27.000Z (about 7 years ago)
- Last Synced: 2024-08-01T12:33:23.199Z (3 months ago)
- Topics: bibliography, bibtex, jquery, jquery-plugin
- Language: JavaScript
- Homepage:
- Size: 33.2 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
- awesome-starred - flashpixx/jQuery-BibJSON - jQuery plugin to create a bibliographie based on BibJSON and BibTeX (jquery)
README
# jQuery BibJSON plugin
A JavaScript framework to convert [BibJSON](http://okfnlabs.org/bibjson/) to [BibTeX](http://www.bibtex.org/) to create BibTeX references on-fly.
## Usage
### BibTeX - BibJSON Source
A BibTeX file must be converted into BibJSON first, for the BibTeX file we recommand UTF-8 encoding. The program [Pandoc-Citeproc](https://github.com/jgm/pandoc-citeproc) can be used to for converting with:
```
pandoc-citeproc --bib2json publication.bib > publication.json
```
### Plugin Installation
On default the citation is build into a numbered list in your HTML document, the basic usage is in an JavaScript file:
```javascript
jQuery("#publication").publication({
bibjson : "publication.json",
bibtex : "publication.bib",
});
```
The plugin is bind to the DOM element ```#publication``` (an ```
``` list element). The possible parameters are
| Parameter | Required | Description |
|------------------------|:--------:|-------------|
| bibjson | Yes | URL to the BibJSON source |
| bibtex | No | URL to the BibTeX source, which can be used for exporting the BibTeX entry |
| csshidden | No | CSS class name to mark hidden / filtered entries, default ```.hidden``` |
| cssvisible | No | CSS class name to mark visible / not-filtered entries, default ```.visible``` |
| csspublication | No | CSS class name to mark all publication entries, default ```.publication``` |
| datafield | No | Data-field name (of the data attribute) to store BibTeX-ID within the DOM entry element, default ```bibtexid``` |
| callbackEntryGenerator | Yes | Callback function with one parameter (the publication entry) to generate the publication DOM element, default ```jQuery("
- ")``` |
| callbackIDGenerator | Yes | Callback function with one parameter (the plugin reference) which creates a callback function with one parameter to generate the DOM element ID of a publication entry, default ```-``` |
| callbackFinish | No | Callback function with one parameter, that contains the plugin instance, e.g. for building clipboard export, default is not set |
| callbackEntry | No | A JSON object with callback function |
| crossdomain | No | Enables Ajax cross-domain access, default ```false```|
## Testing
Just run the directory with your favorit webserver e.g [MAMP](https://www.mamp.info) or [XAMPP](https://www.apachefriends.org) and open the ```index.html``` file within the ```test```-directory