README.md 24.4 KB
Newer Older
Sylvester Keil's avatar
Sylvester Keil committed
1 2 3 4 5 6 7 8
Jekyll-Scholar
==============

Jekyll-Scholar is for all the academic bloggers out there. It is a set of
extensions to [Jekyll](http://jekyllrb.com/), the awesome, blog aware, static
site generator; it formats your bibliographies and reading lists for the web
and gives your blog posts citation super-powers.

Sylvester Keil's avatar
Sylvester Keil committed
9
For additional features you may also want to take a look at
10
[jekyll-scholar-extras](https://github.com/jgoodall/jekyll-scholar-extras).
Sylvester Keil's avatar
Sylvester Keil committed
11

Sylvester Keil's avatar
Sylvester Keil committed
12
[![Build Status](https://travis-ci.org/inukshuk/jekyll-scholar.png?branch=master)](https://travis-ci.org/inukshuk/jekyll-scholar)
Sylvester Keil's avatar
Sylvester Keil committed
13
[![Coverage Status](https://coveralls.io/repos/inukshuk/jekyll-scholar/badge.png)](https://coveralls.io/r/inukshuk/jekyll-scholar)
Sylvester Keil's avatar
Sylvester Keil committed
14
[![Dependency Status](https://gemnasium.com/inukshuk/jekyll-scholar.png)](https://gemnasium.com/inukshuk/jekyll-scholar)
Sylvester Keil's avatar
Sylvester Keil committed
15

Sylvester Keil's avatar
Sylvester Keil committed
16 17
Already using Jekyll-Scholar and interested to help out? Please get in touch with us if you would like to become a maintainer!

Sylvester Keil's avatar
Sylvester Keil committed
18 19 20 21 22
Installation
------------

    $ [sudo] gem install jekyll-scholar

Sylvester Keil's avatar
Sylvester Keil committed
23 24 25 26
Or add it to your `Gemfile`:

    gem 'jekyll-scholar'

27
### Github Pages
28 29

Note that it is not possible to use this plugin with the
30
  [default Github pages workflow](https://help.github.com/articles/using-jekyll-with-pages/). 
31 32
Github does not allow any but a few select plugins to run for security reasons,
and Jekyll-Scholar is not among them.
33 34 35 36 37 38
You will have to generate your site locally and push the results to the `master` resp. `gh-pages` 
branch of your site repository.
You can keep sources, configuration and plugins in a separate branch; see e.g.
  [here](http://davidensinger.com/2013/07/automating-jekyll-deployment-to-github-pages-with-rake/)
for details.

39

40

Sylvester Keil's avatar
Sylvester Keil committed
41 42
Usage
-----
Sylvester Keil's avatar
Sylvester Keil committed
43 44 45 46 47 48 49 50

Install and setup a new [Jekyll](http://jekyllrb.com/) directory (see the
[Jekyll-Wiki](https://github.com/mojombo/jekyll/wiki/Usage) for detailed
instructions). To enable the Jekyll-Scholar add the following statement
to a file in your plugin directory (e.g., to `_plugins/ext.rb`):

    require 'jekyll/scholar'

Sylvester Keil's avatar
Sylvester Keil committed
51 52
Alternatively, add `jekyll-scholar` to your `gem` list in your Jekyll
configuration:
Sylvester Keil's avatar
Sylvester Keil committed
53

Celad Evra's avatar
Celad Evra committed
54
    gems: ['jekyll/scholar']
Sylvester Keil's avatar
Sylvester Keil committed
55

56 57 58 59 60
### Configuration

In your Jekyll configuration file you can adjust the Jekyll-Scholar settings
using the `scholar` key. For example, the following sets the bibliography style
to `mla`.
Sylvester Keil's avatar
Sylvester Keil committed
61 62

    scholar:
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
      style: mla

The table below describes some commonly used configuration options. For a
description of all options and their defaults, see
[`defaults.rb`](/lib/jekyll/scholar/defaults.rb).

| Option | Default | Description |
|--------|---------|-------------|
| `style` | `apa` | Indicates the style used for the bibliography and citations. You can use any style that ships with [CiteProc-Ruby](https://github.com/inukshuk/citeproc-ruby) by name (e.g., apa, mla, chicago-fullnote-bibliography) which is usually the filename as seen [here](https://github.com/citation-style-language/styles) without the `.csl` ending; note that you have to use `dependent/style` if you want to use one from that directory. Alternatively you can add a link to any CSL  style (e.g., you could link to any of the styles available at the official [CSL style repository](https://github.com/citation-style-language/styles)). | 
| `locale` | `en` | Defines what language to use when formatting your references (this typically applies to localized terms, e.g., 'Eds.' for editors in English). |
| `source` | `./_bibliography` |  Indicates where your bibliographies are stored. |
| `bibliograpy` | `references.bib` | Indicates the name of your default bibliography. For best results, please ensure that your bibliography is encoded as ASCII or UTF-8. |
| `use_raw_bibtex_entry` | `true` | When `true`, disables parsing of Liquid tags embedded in the Bibtex fields. This option provides a way to circumvent the problem that (the conflicting syntax of) the double braces functionality of BibTex is accidentally parsed by Liquid, while it was intended to keep the exact capitalization style. |
| `sort_by` | `none` | Specifies if and how bibliography entries are sorted. Entries can be sorted on multiple fields, by using a list of keys, e.g. `year,month`. Ordering can be specified per sort level, e.g. `order: descending,ascending` will sort the years descending, but per year the months are ascending. If there are more sort keys than order directives, the last order entry is used for the remaining keys. |
| `order` | `ascending` | Specifies order bibliography entries are sorted in. Can be `ascending` or descending. Ordering can be specified per sort level, e.g. `descending,ascending` will sort in descending on the first key then ascending order on the second key. If there are more sort keys than order directives, the last order entry is used for the remaining keys. |
| `group_by` | `none` | Specifies how bibliography items are grouped. Grouping can be multi-level, e.g. `type, year` groups entries per publication type, and within those groups per year. |
| `group_order` | `ascending` |  Ordering for groups is specified in the same way as the sort order. Publication types -- specified with group key `type`, can be ordered by adding `type_order` to the configuration. For example, `type_order: article,techreport` lists journal articles before technical reports. Types not mentioned in `type_order` are considered smaller than types that are mentioned. Types can be merge in one group using the `type_aliases` setting. By default `phdthesis` and `mastersthesis` are grouped as `thesis`. By using, for example, `type_aliases: { inproceedings: article}`, journal and conference articles appear in a single group. The display names for entry types are specified with `type_names`. Names for common types are provided, but they can be extended or overridden. For example, the default name for `article` is *Journal Articles*, but it can be changed to *Papers* using `type_names: { article: Papers }`. |
| `bibtex_filters` | `latex,superscript` | Configures which [BibTeX-Ruby](https://github.com/inukshuk/bibtex-ruby) formatting filters values of entries should be passed through. The default `latex` filter converts LaTeX character escapes into unicode, and `superscript` which converts the `\textsuperscript` command into a HTML `<sup>` tag. |

Thomas Wood's avatar
Thomas Wood committed
82

Sylvester Keil's avatar
Sylvester Keil committed
83 84 85 86 87 88 89 90 91 92
### Bibliographies

Once you have loaded Jekyll-Scholar, all files with the extension `.bib` or
`.bibtex` will be converted when you run Jekyll (don't forget to add a YAML
header to the files); the file can contain regular HTML or Markdown and
BibTeX entries; the latter will be formatted by Jekyll-Scholar according to
the citation style and language defined in your configuration file.

For example, if you had a file `bibliography.bib` in your root directory:

Sylvester Keil's avatar
Sylvester Keil committed
93 94 95 96
    ---
    ---
    References
    ==========
Sylvester Keil's avatar
Sylvester Keil committed
97

Sylvester Keil's avatar
Sylvester Keil committed
98 99 100 101 102 103
    @book{ruby,
      title     = {The Ruby Programming Language},
      author    = {Flanagan, David and Matsumoto, Yukihiro},
      year      = {2008},
      publisher = {O'Reilly Media}
    }
Sylvester Keil's avatar
Sylvester Keil committed
104 105 106 107 108 109 110

It would be converted to `bibliography.html` with the following content:

    <h1 id='references'>References</h1>

    <p>Flanagan, D., &#38; Matsumoto, Y. (2008). <i>The Ruby Programming Language</i>. O&#8217;Reilly Media.</p>

Sylvester Keil's avatar
Sylvester Keil committed
111
This makes it very easy for you to add your bibliography to your Jekyll-powered
Sylvester Keil's avatar
Sylvester Keil committed
112 113
blog or website.

Laurent Gatto's avatar
Laurent Gatto committed
114
If you are using other converters to generate your site, don't worry, you can
Sylvester Keil's avatar
Sylvester Keil committed
115 116 117 118 119 120 121 122 123 124
still generate bibliographies using the `bibliography` tag. In your site
or blog post, simply call:

    {% bibliography %}

This will generate your default bibliography; if you use multiple, you can
also pass in a name to tell Jekyll-Scholar which bibliography it should render.

Let's say you have two bibliographies stored in `_bibliography/books.bib` and
`_bibliography/papers.bib`; you can include the bibliographies on your site
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
125 126
by respectively calling `{% bibliography --file books %}` and
`{% bibliography --file papers %}`. For example, you could have a file `references.md`
Sylvester Keil's avatar
Sylvester Keil committed
127
with several reference lists:
Sylvester Keil's avatar
Sylvester Keil committed
128

Sylvester Keil's avatar
Sylvester Keil committed
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
    ---
    title: My References
    ---

    {{ page.title }}
    ================

    The default Bibliography
    ------------------------

    {% bibliography %}

    Secondary References
    --------------------

Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
144
    {% bibliography --file secondary %}
Sylvester Keil's avatar
Sylvester Keil committed
145

Sylvester Keil's avatar
Sylvester Keil committed
146 147 148
Finally, the bibliography tag supports an optional filter parameter. This
filter takes precedence over the global filter defined in your configuration.

Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
149
    {% bibliography --query @*[year=2013] %}
Sylvester Keil's avatar
Sylvester Keil committed
150 151 152 153 154

The example above would print a bibliography of all entires published in
the year 2013. Of course you can also combine the file and filter parameters
like this:

Sylvester Keil's avatar
Sylvester Keil committed
155
    {% bibliography -f secondary -q @*[year=2013] %}
Sylvester Keil's avatar
Sylvester Keil committed
156 157 158 159 160 161 162 163

This would print the publications from 2013 of the bibliography at
`_bibliography/secondary.bib`.

For more details about filters, see the corresponding section below or
consult the [BibTeX-Ruby](https://github.com/inukshuk/bibtex-ruby)
documentation.

164 165 166 167 168 169
If you need to limit the number of entries in your bibliography, you can
use the `--max` option:

    {% bibliography --max 5 %}

This would generate a bibliography containing only the first 5 entries
170 171
of your bibliography (after query filters and sort options have been
applied). Limiting entries is disabled if grouping is active.
172

173 174 175 176 177 178 179
### Bibliography Template

Your bibliography is always rendered as an ordered list. Additionally,
each reference is wrapped in an HTML tag (`span` by default but you can
change this using the `reference_tagname` setting) with the cite key
as id. The reference string itself is governed by the rules in your
CSL style but you can also customize the main template a little bit.
180 181
By default, the template is `{{reference}}` – this renders only the
reference tag. The template uses Liquid to render and, in
182
addition to the reference, exposes the cite-key (as `key`), the
183 184
entry's `type`, the `index` in the bibliography, and the link to
file repository as `link`. Thus, you could
185 186 187
customize the template in your configuration as follows:

    scholar:
188
      bibliography_template: <abbr>[{{key}}]</abbr>{{reference}}
189 190 191

This would be processed into something like:

192
    <li><abbr>[ruby]</abbr><span id="ruby">Matsumoto, Y. (2008). <i>The Ruby Programming Language</i>. O&#8217;Reilly Media.</span></li>
193

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
If you have more complex requirements, it quickly becomes tedious to
have the template inside the configuration; for this reason, you can
also put the bibliography template into your layouts directory. Jekyll-Scholar
will load this template if the option set in your configuration matches
an existing layout (without the file extension). That is to say, if you set:

    scholar:
      bibliography_template: bib

And there is a file `_layouts/bib.html` (or with another extension) the
contents of this file will be used as the template. Please note that it is
important for this file to contain the YAML front matter! For example, this
would be a more complex template file:

    ---
    ---
    {{ reference }}

    {% if entry.abstract %}
Lorcan Coyle's avatar
Lorcan Coyle committed
213
    <p>{{ entry.abstract }}</p>
214 215
    {% endif %}

Lorcan Coyle's avatar
Lorcan Coyle committed
216
    <pre>{{ entry.bibtex }}</pre>
Sylvester Keil's avatar
Sylvester Keil committed
217

218 219 220
You can also override the default bibliography template, by passing the
`--template` or `-T` option parameter to the bibliography tag.

Sylvester Keil's avatar
Sylvester Keil committed
221 222
### Citations

Sylvester Keil's avatar
Sylvester Keil committed
223 224 225
If you want to reference books or papers from your bibliography in your blog
posts, Jekyll-Scholar can help you, too. Simply use the `cite` tag with
the appropriate key of the item you want to cite and Jekyll-Scholar will
Sylvester Keil's avatar
Sylvester Keil committed
226
create a formatted citation reference for you. For a quick example, take
Sylvester Keil's avatar
Sylvester Keil committed
227
following blog post:
Sylvester Keil's avatar
Sylvester Keil committed
228

Sylvester Keil's avatar
Sylvester Keil committed
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
    ---
    layout: default
    title: A Blogging Scholar
    ---

    {{ page.title }}
    ================

    Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
    incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
    nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
    Duis 'aute irure dolor in reprehenderit in voluptate' {% cite derrida:purveyor %}
    velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
    cupidatat non proident, 'sunt in culpa qui officia deserunt mollit anim id est
    laborum' {% cite rabinowitz %}.

    Duis 'aute irure dolor in reprehenderit in voluptate' {% cite breton:surrealism %}
    velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
    cupidatat non proident, 'sunt in culpa qui officia deserunt mollit anim id est
    laborum' {% cite rainey %}.

    References
    ----------

    {% bibliography %}
Sylvester Keil's avatar
Sylvester Keil committed
254

255 256 257 258
Note that this will print your entire bibliography in the Reference section.
If you would like to include only those entries you cited on the page, pass
the `cited` option to the bibliography tag:

Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
259
    {% bibliography --cited %}
260

Sylvester Keil's avatar
Sylvester Keil committed
261 262 263 264 265 266
By default, the `--cited` option will still sort your bibliography if you set
the sort option. Especially for styles using citation numbers, this is usually
not the desired behaviour. In such cases you can use `--cited_in_order` instead
of `--cited` and your bibliography will contain all cited items in the order
they were cited on the page.

Sylvester Keil's avatar
Sylvester Keil committed
267 268 269 270 271
For longer quotes, Jekyll-Scholar provides a `quote` tag:

    {% quote derrida:purveyor %}
    Lorem ipsum dolor sit amet, consectetur adipisicing elit,
    sed do eiusmod tempor.
Sylvester Keil's avatar
Sylvester Keil committed
272

Sylvester Keil's avatar
Sylvester Keil committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286
    Lorem ipsum dolor sit amet, consectetur adipisicing.
    {% endquote %}

For example, this could be rendered as:

    <blockquote>
      <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit,<br/>
      sed do eiusmod tempor.</p>
      <p>Lorem ipsum dolor sit amet, consectetur adipisicing.</p>
      <cite>
        <a href="#derrida:purveyor">(Derrida, 1975)</a>
      </cite>
    </blockquote>

287 288 289 290 291 292
#### Multiple citation

You can cite multiple items in a single citation by referencing all ids
of the items you wish to quote separated by spaces. For example,
`{% cite ruby microscope %}` would produce a cite tag like:

Sylvester Keil's avatar
Sylvester Keil committed
293
    <a href="#ruby">(Flanagan &amp; Matsumoto 2008; Shaughnessy 2013)</a>
294

295 296 297 298 299 300 301 302 303 304 305 306 307
#### Citations when there's more than one bibliography

Let's return to the example above where you have two bibliographies stored 
in `_bibliography/books.bib` and `_bibliography/papers.bib`. We also must
have the main bibliography, e.g., `_bibliography/references.bib`. As we
know from above, it's possible to use bibliographies other than the main
bibliography by calling `{% bibliography --file books %}` or 
`{% bibliography --file papers %}`. 

Though what if we want to cite an article that's not in the main bibliography? 
We use the same approach as above; to cite an article in the `books.bib` 
bibliography, we simply call `{% cite ruby --file books %}` 

Sylvester Keil's avatar
Sylvester Keil committed
308 309 310 311 312 313 314 315
#### Suppressing author names

Sometimes you want to suppress author names in a citation, because the
name has already been mentioned in your text; for such cases Jekyll-Scholar
provides the `--suppress_author` option (short form: `-A`):
`...as Matz explains {% cite ruby -A -l 42 %}` would produce something
like: `...as Matz explains (2008, p. 42)`.

316 317
#### Page numbers and locators

318 319
If you would like to add page numbers or similar locators to your citation,
use the `-l` or `--locator` option. For example, `{% cite ruby --locator 23-5 %}` would
Sylvester Keil's avatar
Sylvester Keil committed
320
produce a citation like `(Matsumoto, 2008, pp. 23-5)`.
321 322 323 324

When quoting multiple items (see above) you can add multiple locators after
the list of ids. For example, `{% cite ruby microscope -l 2 -l 24 & 32 %}`.

325 326 327 328 329
Page is the default locator, however, you can indicate the type of locator
by adding a `-L` or `--label` option (one for each locator) for instance,
`{% cite ruby microscope --label chapter --locator 3 -L figure -l 24 & 32 %}`
produces something like: `(Matsumoto, 2008, chap. 3; Shaughnessy, 2013, figs. 24 & 32)`.

330 331 332 333 334 335 336 337 338 339 340 341 342
#### Displaying formatted references

If you want to display the full formatted reference entry, you can use the
`reference` tag. For example, given the following Bibtex entry,

    @book{ruby,
      title     = {The Ruby Programming Language},
      author    = {Flanagan, David and Matsumoto, Yukihiro},
      year      = {2008},
      publisher = {O'Reilly Media}
    }

using `{% reference ruby %}` anywhere in your page, it will print
Sylvester Keil's avatar
Sylvester Keil committed
343 344
"Flanagan, D., & Matsumoto, Y. (2008). *The Ruby Programming Language.*.
O'Reilly Media" (the exact result depends on your formatting style).
345

Sylvester Keil's avatar
Sylvester Keil committed
346 347 348
The `reference` tag accepts the same --file/-f parameter as the bibliography
tag. This can be handy if you want to use a special BibTeX file as input for
a specific page. As an example, the tag
349

Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
350
    {% reference ruby --file /home/foo/bar.bib %}
351 352

will attempt to read the key `ruby` from file `/home/foo/bar.bib`. It will not
Sylvester Keil's avatar
Sylvester Keil committed
353
fallback to the default BibTeX file.
Sylvester Keil's avatar
Sylvester Keil committed
354

355
#### Citation pointing to another page in your site
356
In some cases, you might want your citation to link to another page on your cite (ex. a separate works cited page). As a solution, add a relative path to your scholar configurations:
Alex Gil's avatar
Alex Gil committed
357

358 359 360 361
~~~ yaml
    scholar:
      relative: "/relative/path/file.html"
~~~
362 363


Sylvester Keil's avatar
Sylvester Keil committed
364
#### Multiple bibliographies within one document (like [multibib.sty](http://www.ctan.org/pkg/multibib))
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
365 366

When you have multiple `{% bibliography %}` sections in one file,
Sylvester Keil's avatar
Sylvester Keil committed
367
Jekyll-Scholar will generate several lists containing the same
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
368 369 370
publications that have the same `id` attributes. As a result, when you
cite a reference the link to an `id` attribute cannot be resolved
uniquely. Your browser will always take you take you to the first
Sylvester Keil's avatar
Sylvester Keil committed
371
occurrence of the `id`. Moreover, valid HTML requires unique `id`
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
372 373 374 375 376
attributes. This scenario may happen, for example, if you cite the
same reference in different blog posts, and all of these posts are
shown in one html document.

As a solution, Jekyll-Scholar provides the `--prefix` tag. In your
Sylvester Keil's avatar
Sylvester Keil committed
377
first post you might cite as
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
378

Sylvester Keil's avatar
Sylvester Keil committed
379 380 381
    ---
    title: Post 1
    ---
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
382 383 384
    Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
    incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
    nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Sylvester Keil's avatar
Sylvester Keil committed
385
    Duis 'aute irure dolor in reprehenderit in voluptate'
Sylvester Keil's avatar
Sylvester Keil committed
386
    {% cite derrida:purveyor --prefix post1 %} velit esse cillum
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
387 388 389 390 391 392 393 394 395 396 397 398
    dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
    non proident, 'sunt in culpa qui officia deserunt mollit anim id
    est laborum' {% cite rabinowitz --prefix post1 %}.

    References
    ----------

    {% bibliography --cited --prefix post1 %}


For the second blog post you would cite as follows:

Sylvester Keil's avatar
Sylvester Keil committed
399 400 401
    ---
    title: Post 2
    ---
Sylvester Keil's avatar
Sylvester Keil committed
402
    Duis 'aute irure dolor in reprehenderit in voluptate'
Sylvester Keil's avatar
Sylvester Keil committed
403
    {% cite rabinowitz --prefix post2 %} velit esse cillum
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
404 405 406 407 408 409 410 411 412
    dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
    non proident, 'sunt in culpa qui officia deserunt mollit anim id
    est laborum' {% cite rainey --prefix post2  %}.

    References
    ----------

    {% bibliography --cited --prefix post2 %}

Sylvester Keil's avatar
Sylvester Keil committed
413 414 415
Even though both posts cite 'rabinowitz', both citations will be
assigned unique identifiers linking to the respective references
section, although both posts will be rendered into a single HTML
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
416 417 418
document.


Sylvester Keil's avatar
Sylvester Keil committed
419 420 421
### File Repositories

File repository support was added to Jekyll-Scholar starting at version
Sylvester Keil's avatar
Sylvester Keil committed
422
2.0. Currently, if you have a folder in your site that contains PDF or
Sylvester Keil's avatar
Sylvester Keil committed
423 424 425 426
Postscript files of your papers, you can use the configuration option
`repository` to indicate this directory. When generating bibliographies,
Jekyll-Scholar will look in that folder to see if it contains a filename
matching each entry's BibTeX key: if it does, the path to that file
427 428 429 430 431 432 433 434
will be exposed to the bibliography template as the `link` property.

Since version 4.1.0 repositories are not limited to PDF and PS files.
These files are mapped to the `links` property in your bibliography
template. Here is an example of template that utilizes this feature
to link to supporting material in a ZIP archive:

    {{ reference }} [<a href="{{links.zip}}">Supporting Materials</a>]
Sylvester Keil's avatar
Sylvester Keil committed
435

Sylvester Keil's avatar
Sylvester Keil committed
436 437 438
### Detail Pages

If your layouts directory contains a layout file for bibliography details
439
(the `details_layout` configuration options), Jekyll-Scholar will generate
Sylvester Keil's avatar
Sylvester Keil committed
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
a details page for each entry in you main bibliography. That is to say, if
your bibliography contains the following entry:

    @book{ruby,
      title     = {The Ruby Programming Language},
      author    = {Flanagan, David and Matsumoto, Yukihiro},
      year      = {2008},
      publisher = {O'Reilly Media}
    }

Then a page 'bibliography/ruby.html' will be generated according to your
details page layout. In the layout file, you have access to all fields
of your BibTeX entry. Here is an example of a details page layout:

    ---
    ---
    <html>
    <head></head>
    <body>
      <h1>{{ page.entry.title }}</h1>
Sylvester Keil's avatar
Sylvester Keil committed
460 461
      <h2>{{ page.entry.author }}</h2>
      <p>{{ page.entry.abstract }}</p>
Sylvester Keil's avatar
Sylvester Keil committed
462 463 464
    </body>
    </html>

Sylvester Keil's avatar
Sylvester Keil committed
465 466 467 468
When Jekyll-Scholar generates detail pages, it also adds links to each
entry's detail page to the generated bibliography. You can alter the
name of the link via the 'details_link' configuration option.

469 470 471 472 473 474 475 476 477 478
Jekyll-Scholar also provides a Liquid tag for conveniently adding links
to individual detail pages. For example, if you would like to add a simple
link to one of the items in your bibliography on a page or in a blog post
you can use the `cite_details` tag to generate the link. For this to work,
you need to pass the BibTeX key of the element you want to reference to
the tag and, optionally, provide a text for the link (the default text
can be set via the 'details_link' configuration option).

    Duis 'aute irure dolor in reprehenderit in voluptate' velit esse cillum
    dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
479
    proident {% cite_details key --text Click Here For More Details %}.
480

Sylvester Keil's avatar
Sylvester Keil committed
481 482 483 484 485 486 487 488 489 490 491

### Bibliography Filters

By default, Jekyll-Scholar includes all entries in you main BibTeX file
when generating bibliographies. If you want to include only those entries
matching certain criteria, you can do so by adjusting the 'query'
configuration option. For example:

    query: "@book" #=> includes only books
    query: "@article[year>=2003]" #=> includes only articles published 2003 or later
    query: "@*[url]" #=> includes all entries with a url field
492 493
    query: "@*[status!=review]" #=> includes all entries whose status field is not set to 'review'
    query: "@book[year <= 1900 && author ^= Poe]" #=> Books published before 1900 where the author matches /Poe/
Sylvester Keil's avatar
Sylvester Keil committed
494
    query: "!@book" #=> includes all entries with a type other than book
Sylvester Keil's avatar
Sylvester Keil committed
495

Sylvester Keil's avatar
Sylvester Keil committed
496
Please note that some of these queries require BibTeX-Ruby 2.3.0 or
Sylvester Keil's avatar
Sylvester Keil committed
497 498
later versions. You can also overwrite the configuration's query parameter
in each bibliography tag individually as described above.
Sylvester Keil's avatar
Sylvester Keil committed
499 500 501 502 503 504 505 506 507 508

Contributing
------------

The Jekyll-Scholar source code is
[hosted on GitHub](http://github.com/inukshuk/jekyll-scholar/).
You can check out a copy of the latest code using Git:

    $ git clone https://github.com/inukshuk/jekyll-scholar.git

Sylvester Keil's avatar
Sylvester Keil committed
509 510
To use this lasted version instead of the one provide by RubyGems,
just add the line
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
511

Sylvester Keil's avatar
Sylvester Keil committed
512
    $:.unshift '/full/path/to/the/repository/lib'
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
513

Sylvester Keil's avatar
Sylvester Keil committed
514
to your `_plugins/ext.rb` before requiring 'jekyll/scholar', where
Sylvester Keil's avatar
Sylvester Keil committed
515 516
`/full/path/to/the/repository` is the path to your local version
of Jekyll-Scholar.
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
517

Sylvester Keil's avatar
Sylvester Keil committed
518
When contributing to Jekyll-Scholar, please make sure to install
519 520 521 522 523
all dependencies and run the cucumber features:

    $ bundle install
    $ rake

Sylvester Keil's avatar
Sylvester Keil committed
524 525 526 527
If you've found a bug or have a question, please open an issue on the
[Jekyll-Scholar issue tracker](http://github.com/inukshuk/jekyll-scholar/issues).
Or, for extra credit, clone the Jekyll-Scholar repository, write a failing
example, fix the bug and submit a pull request.
Sylvester Keil's avatar
Sylvester Keil committed
528

Sylvester Keil's avatar
Sylvester Keil committed
529 530 531
Additionally, if we merged at least one of your pull request you will get
write permissions to the repository if you want them.

Sylvester Keil's avatar
Sylvester Keil committed
532 533 534 535 536
License
-------

Jekyll-Scholar is distributed under the same license as Jekyll.

537
Copyright (c) 2011-2015 [Sylvester Keil](http://sylvester.keil.or.at/)
Sylvester Keil's avatar
Sylvester Keil committed
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555

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
SOFTWARE.