mirror of
https://github.com/TiddlyWiki/TiddlyWiki5.git
synced 2026-04-27 16:54:36 +00:00
First pass at bibtex importer
This commit is contained in:
47
plugins/tiddlywiki/bibtex/files/README.md
Executable file
47
plugins/tiddlywiki/bibtex/files/README.md
Executable file
@@ -0,0 +1,47 @@
|
||||
bibtexParseJs
|
||||
=============
|
||||
A JavaScript library that parses BibTeX parser. Forked from
|
||||
[bibtex-parser](https://github.com/mikolalysenko/bibtex-parser).
|
||||
|
||||
|
||||
## Using in Browser
|
||||
Include bibtexParse.js and call
|
||||
|
||||
```
|
||||
bibtexParse.toJSON('@article{sample1,title={sample title}}');
|
||||
```
|
||||
|
||||
## Using in [Node.js](http://nodejs.org/)
|
||||
Install ```npm install bibtex-parse-js```
|
||||
|
||||
```
|
||||
var bibtexParse = require('bibtex-parse-js');
|
||||
|
||||
var sample = bibtexParse.toJSON('@article{sample1,title={sample title}}');
|
||||
|
||||
console.log(sample);
|
||||
```
|
||||
|
||||
**Returns** A parsed bibtex file as a JSON Array Object
|
||||
|
||||
```
|
||||
[ { citationKey: 'SAMPLE1',
|
||||
entryType: 'ARTICLE',
|
||||
entryTags: { TITLE: 'sample title' } } ]
|
||||
```
|
||||
|
||||
## Contributing
|
||||
Contributions are welcome. Please make sure the unit test(test/runTest.js) reflects the
|
||||
changes and completes successfully.
|
||||
|
||||
#### Travis CI
|
||||
See the latest build and results at [https://travis-ci.org/ORCID/bibtexParseJs](https://travis-ci.org/ORCID/bibtexParseJs)
|
||||
|
||||
## Credits
|
||||
(c) 2010 Henrik Muehe. MIT License
|
||||
[visit](https://code.google.com/p/bibtex-js/)
|
||||
|
||||
|
||||
CommonJS port maintained by Mikola Lysenko
|
||||
[visit](https://github.com/mikolalysenko/bibtex-parser)
|
||||
|
||||
Reference in New Issue
Block a user