README.md 2.48 KB
Newer Older
Hiren Patel's avatar
Hiren Patel committed
1 2 3
jekyll-scholar-extras
=====================

Hiren Patel's avatar
Hiren Patel committed
4 5
```jekyll-scholar-extras``` provides customized generators and tags for generating a publication bibliography with individual details pages from a [BibTeX](http://www.bibtex.org) file. This resembles other [BibTeX](http://www.bibtex.org) to HTML converters such as [bibtex2web](http://www.cs.washington.edu/homes/mernst/software/#bibtex2web).

root's avatar
root committed
6
These customizations are extensions to [Jekyll](http://jekyllrb.com/) and [Jekyll-Scholar](https://github.com/inukshuk/jekyll-scholar). 
7

8 9 10
Installation
------------

rmrf's avatar
rmrf committed
11
You must compile ```jekyll-scholar-extras``` from source.  If someone is interested in publishing to a gem server, then I would be happy to help enable this.
12 13 14 15 16 17
Usage
-----
To enable ```jekyll-scholar-extras```, add a file in your plugin directory (e.g., to `_plugins/jekyll-scholar-extras.rb`) with the following:

      require 'jekyll/scholar/extras'

Hiren Patel's avatar
Hiren Patel committed
18 19 20 21 22 23 24 25

Features
--------
These extras provide some additional features over the vanilla Jekyll-Scholar.  These are described below:
* Disable generation of BibTeX entries marked  to not be public.
* Create a PDF download link based on the BibTeX key associated with each entry.


26 27 28 29
Example
-------

An example setup that uses the customized bibliography and details page generators and tags.
Laurent Gatto's avatar
Laurent Gatto committed
30
* [Sample 1](https://caesr.uwaterloo.ca//publications/index.html)
31 32 33 34 35 36 37


License
-------

```jekyll-scholar-extras``` is distributed under the same license as Jekyll.

rmrf's avatar
rmrf committed
38
Copyright (c) 2012-2016 [Hiren Patel](https://caesr.uwaterloo.ca/)
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the 'Software'), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
root's avatar
root committed
56
SOFTWARE.