README.md 20 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'

Sylvester Keil's avatar
Sylvester Keil committed
27
28
Usage
-----
Sylvester Keil's avatar
Sylvester Keil committed
29
30
31
32
33
34
35
36

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
37
38
Alternatively, add `jekyll-scholar` to your `gem` list in your Jekyll
configuration:
Sylvester Keil's avatar
Sylvester Keil committed
39

Celad Evra's avatar
Celad Evra committed
40
    gems: ['jekyll/scholar']
Sylvester Keil's avatar
Sylvester Keil committed
41

Sylvester Keil's avatar
Sylvester Keil committed
42
43
44
45
46
47
In your configuration you can now adjust the Jekyll-Scholar settings. The
default configuration is as follows:

    scholar:
      style: apa
      locale: en
Sylvester Keil's avatar
Sylvester Keil committed
48

Sylvester Keil's avatar
Sylvester Keil committed
49
50
      sort_by: none
      order: ascending
Sylvester Keil's avatar
Sylvester Keil committed
51

Sylvester Keil's avatar
Sylvester Keil committed
52
53
      source: ./_bibliography
      bibliography: references.bib
54
      bibliography_template: "{{reference}}"
55

56
      replace_strings: true
David Moxey's avatar
David Moxey committed
57
      join_strings:    true
58
59
      
      use_raw_bibtex_entry: false
60

Sylvester Keil's avatar
Sylvester Keil committed
61
62
63
      details_dir:    bibliography
      details_layout: bibtex.html
      details_link:   Details
Sylvester Keil's avatar
Sylvester Keil committed
64
65

      query: "@*"
Sylvester Keil's avatar
Sylvester Keil committed
66
67
68
69
70
71
72

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), or else 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)).

Sylvester Keil's avatar
Sylvester Keil committed
73
The `locale` settings defines what language to use when formatting
Sylvester Keil's avatar
Sylvester Keil committed
74
75
76
your references (this typically applies to localized terms, e.g., 'Eds.' for
editors in English).

Sylvester Keil's avatar
Sylvester Keil committed
77
The `source` option indicates where your bibliographies are stored;
Sylvester Keil's avatar
fix #40    
Sylvester Keil committed
78
79
`bibliography` is the name of your default bibliography. For best results,
please ensure that your Bibliography is encoded as ASCII or UTF-8.
Sylvester Keil's avatar
Sylvester Keil committed
80

81
82
83
84
The `use_raw_bibtex_entry` option will disable parsing of Liquid tags that 
are embedded in the Bibtex fields. This option provides a way to circumvent 
the problem that the double braces functionality of BibTex is accidentally 
parsed by Liquid, while it was intended to keep the exact capitalization style.
Sylvester Keil's avatar
Sylvester Keil committed
85

Sylvester Keil's avatar
Sylvester Keil committed
86
87
88
89
90
91
92
93
94
95
### 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
96
97
98
99
    ---
    ---
    References
    ==========
Sylvester Keil's avatar
Sylvester Keil committed
100

Sylvester Keil's avatar
Sylvester Keil committed
101
102
103
104
105
106
    @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
107
108
109
110
111
112
113

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
114
This makes it very easy for you to add your bibliography to your Jekyll-powered
Sylvester Keil's avatar
Sylvester Keil committed
115
116
blog or website.

Laurent Gatto's avatar
Laurent Gatto committed
117
If you are using other converters to generate your site, don't worry, you can
Sylvester Keil's avatar
Sylvester Keil committed
118
119
120
121
122
123
124
125
126
127
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
128
129
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
130
with several reference lists:
Sylvester Keil's avatar
Sylvester Keil committed
131

Sylvester Keil's avatar
Sylvester Keil committed
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
    ---
    title: My References
    ---

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

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

    {% bibliography %}

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

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

Sylvester Keil's avatar
Sylvester Keil committed
149
150
151
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
152
    {% bibliography --query @*[year=2013] %}
Sylvester Keil's avatar
Sylvester Keil committed
153
154
155
156
157

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
158
    {% bibliography -f secondary -q @*[year=2013] %}
Sylvester Keil's avatar
Sylvester Keil committed
159
160
161
162
163
164
165
166

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.

167
168
169
170
171
172
173
174
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
of your bibliography (after query filters and sort options have been applied).

175
176
177
178
179
180
181
### 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.
182
183
By default, the template is `{{reference}}` – this renders only the
reference tag. The template uses Liquid to render and, in
184
addition to the reference, exposes the cite-key (as `key`), the
185
186
entry's `type`, the `index` in the bibliography, and the link to
file repository as `link`. Thus, you could
187
188
189
customize the template in your configuration as follows:

    scholar:
190
      bibliography_template: <abbr>[{{key}}]</abbr>{{reference}}
191
192
193

This would be processed into something like:

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

196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
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
215
    <p>{{ entry.abstract }}</p>
216
217
    {% endif %}

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

220
221
222
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
223
224
### Citations

Sylvester Keil's avatar
Sylvester Keil committed
225
226
227
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
228
create a formatted citation reference for you. For a quick example, take
Sylvester Keil's avatar
Sylvester Keil committed
229
following blog post:
Sylvester Keil's avatar
Sylvester Keil committed
230

Sylvester Keil's avatar
Sylvester Keil committed
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
    ---
    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
256

257
258
259
260
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
261
    {% bibliography --cited %}
262

Sylvester Keil's avatar
Sylvester Keil committed
263
264
265
266
267
268
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
269
270
271
272
273
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
274

Sylvester Keil's avatar
Sylvester Keil committed
275
276
277
278
279
280
281
282
283
284
285
286
287
288
    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>

289
290
291
292
293
294
#### 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
295
    <a href="#ruby">(Flanagan &amp; Matsumoto 2008; Shaughnessy 2013)</a>
296

Sylvester Keil's avatar
Sylvester Keil committed
297
298
299
300
301
302
303
304
#### 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)`.

305
306
307
308
#### Page numbers and locators

If you would like to add page numbers to your citation, you can use the
`-l` or `--locator` option. For example, `{% cite ruby -l 23-5 %}` would
Sylvester Keil's avatar
Sylvester Keil committed
309
produce a citation like `(Matsumoto, 2008, pp. 23-5)`.
310
311
312
313

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 %}`.

314
315
316
317
318
319
320
321
322
323
324
325
326
#### 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
327
328
"Flanagan, D., & Matsumoto, Y. (2008). *The Ruby Programming Language.*.
O'Reilly Media" (the exact result depends on your formatting style).
329

Sylvester Keil's avatar
Sylvester Keil committed
330
331
332
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
333

Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
334
    {% reference ruby --file /home/foo/bar.bib %}
335
336

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

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

When you have multiple `{% bibliography %}` sections in one file,
Sylvester Keil's avatar
Sylvester Keil committed
342
Jekyll-Scholar will generate several lists containing the same
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
343
344
345
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
346
occurrence of the `id`. Moreover, valid HTML requires unique `id`
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
347
348
349
350
351
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
352
first post you might cite as
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
353

Sylvester Keil's avatar
Sylvester Keil committed
354
355
356
    ---
    title: Post 1
    ---
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
357
358
359
    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
360
    Duis 'aute irure dolor in reprehenderit in voluptate'
Sylvester Keil's avatar
Sylvester Keil committed
361
    {% cite derrida:purveyor --prefix post1 %} velit esse cillum
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
362
363
364
365
366
367
368
369
370
371
372
373
    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
374
375
376
    ---
    title: Post 2
    ---
Sylvester Keil's avatar
Sylvester Keil committed
377
    Duis 'aute irure dolor in reprehenderit in voluptate'
Sylvester Keil's avatar
Sylvester Keil committed
378
    {% cite rabinowitz --prefix post2 %} velit esse cillum
Bjoern Rueffer (Air)'s avatar
Bjoern Rueffer (Air) committed
379
380
381
382
383
384
385
386
387
    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
388
389
390
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
391
392
393
document.


Sylvester Keil's avatar
Sylvester Keil committed
394
395
396
### File Repositories

File repository support was added to Jekyll-Scholar starting at version
Sylvester Keil's avatar
Sylvester Keil committed
397
2.0. Currently, if you have a folder in your site that contains PDF or
Sylvester Keil's avatar
Sylvester Keil committed
398
399
400
401
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
402
403
404
405
406
407
408
409
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
410

Sylvester Keil's avatar
Sylvester Keil committed
411
412
413
### Detail Pages

If your layouts directory contains a layout file for bibliography details
414
(the `details_layout` configuration options), Jekyll-Scholar will generate
Sylvester Keil's avatar
Sylvester Keil committed
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
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
435
436
      <h2>{{ page.entry.author }}</h2>
      <p>{{ page.entry.abstract }}</p>
Sylvester Keil's avatar
Sylvester Keil committed
437
438
439
    </body>
    </html>

Sylvester Keil's avatar
Sylvester Keil committed
440
441
442
443
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.

444
445
446
447
448
449
450
451
452
453
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
454
    proident {% cite_details key --text Click Here For More Details %}.
455

Sylvester Keil's avatar
Sylvester Keil committed
456
457
458
459
460
461
462
463
464
465
466

### 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
467
468
    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
469
    query: "!@book" #=> includes all entries with a type other than book
Sylvester Keil's avatar
Sylvester Keil committed
470

Sylvester Keil's avatar
Sylvester Keil committed
471
Please note that some of these queries require BibTeX-Ruby 2.3.0 or
Sylvester Keil's avatar
Sylvester Keil committed
472
473
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
474
475
476
477
478
479
480
481
482
483

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
484
485
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
486

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

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

Sylvester Keil's avatar
Sylvester Keil committed
493
When contributing to Jekyll-Scholar, please make sure to install
494
495
496
497
498
all dependencies and run the cucumber features:

    $ bundle install
    $ rake

Sylvester Keil's avatar
Sylvester Keil committed
499
500
501
502
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
503

Sylvester Keil's avatar
Sylvester Keil committed
504
505
506
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
507
508
509
510
511
License
-------

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

512
Copyright (c) 2011-2015 [Sylvester Keil](http://sylvester.keil.or.at/)
Sylvester Keil's avatar
Sylvester Keil committed
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530

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.