Commit 616d19d4 authored by Sylvester Keil's avatar Sylvester Keil
Browse files

update readme

parent d8dee426
...@@ -131,7 +131,7 @@ The example above would print a bibliography of all entires published in ...@@ -131,7 +131,7 @@ 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 the year 2013. Of course you can also combine the file and filter parameters
like this: like this:
{% bibliography --file secondary --query @*[year=2013] %} {% bibliography -f secondary -q @*[year=2013] %}
This would print the publications from 2013 of the bibliography at This would print the publications from 2013 of the bibliography at
`_bibliography/secondary.bib`. `_bibliography/secondary.bib`.
...@@ -217,11 +217,9 @@ using `{% reference ruby %}` anywhere in your page, it will print ...@@ -217,11 +217,9 @@ using `{% reference ruby %}` anywhere in your page, it will print
"Flanagan, D., & Matsumoto, Y. (2008). *The Ruby Programming Language.*. "Flanagan, D., & Matsumoto, Y. (2008). *The Ruby Programming Language.*.
O'Reilly Media" (the exact result depends on your formatting style). O'Reilly Media" (the exact result depends on your formatting style).
The `reference` tag accepts a second optional argument that specifies the The `reference` tag accepts the same --file/-f parameter as the bibliography
absolute path of the BibTeX file to use as input. Using it, you can override tag. This can be handy if you want to use a special BibTeX file as input for
the file from which the bib entries are read. This can be handy if you a specific page. As an example, the tag
want to use a special BibTeX file as input for a specific page. As an example,
the tag
{% reference ruby --file /home/foo/bar.bib %} {% reference ruby --file /home/foo/bar.bib %}
...@@ -243,14 +241,14 @@ shown in one html document. ...@@ -243,14 +241,14 @@ shown in one html document.
As a solution, Jekyll-Scholar provides the `--prefix` tag. In your As a solution, Jekyll-Scholar provides the `--prefix` tag. In your
first post you might cite as first post you might cite as
--- ---
title: Post 1 title: Post 1
--- ---
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor 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 incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis 'aute irure dolor in reprehenderit in voluptate' Duis 'aute irure dolor in reprehenderit in voluptate'
{% cite derrida:purveyor --prefix post1 %} velit esse cillum {% cite derrida:purveyor --prefix post1 %} velit esse cillum
dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
non proident, 'sunt in culpa qui officia deserunt mollit anim id non proident, 'sunt in culpa qui officia deserunt mollit anim id
est laborum' {% cite rabinowitz --prefix post1 %}. est laborum' {% cite rabinowitz --prefix post1 %}.
...@@ -263,11 +261,11 @@ first post you might cite as ...@@ -263,11 +261,11 @@ first post you might cite as
For the second blog post you would cite as follows: For the second blog post you would cite as follows:
--- ---
title: Post 2 title: Post 2
--- ---
Duis 'aute irure dolor in reprehenderit in voluptate' Duis 'aute irure dolor in reprehenderit in voluptate'
{% cite rabinowitz --prefix post2 %} velit esse cillum {% cite rabinowitz --prefix post2 %} velit esse cillum
dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
non proident, 'sunt in culpa qui officia deserunt mollit anim id non proident, 'sunt in culpa qui officia deserunt mollit anim id
est laborum' {% cite rainey --prefix post2 %}. est laborum' {% cite rainey --prefix post2 %}.
...@@ -355,18 +353,13 @@ You can check out a copy of the latest code using Git: ...@@ -355,18 +353,13 @@ You can check out a copy of the latest code using Git:
$ git clone https://github.com/inukshuk/jekyll-scholar.git $ git clone https://github.com/inukshuk/jekyll-scholar.git
To use this lasted version instead of the one provide by Ruby Gems, To use this lasted version instead of the one provide by RubyGems,
replace the line just add the line
require 'jekyll/scholar'
by
$:.unshift '/full/path/to/the/repository/lib' $:.unshift '/full/path/to/the/repository/lib'
require 'jekyll/scholar'
in your `_plugins/ext.rb`, where `/full/path/to/the/repository` is to your `_plugins/ext.rb` before requiring 'jekyll/scholar', where
where you have cloned jekyll-scholar into. `/full/path/to/the/repository` is where you have cloned jekyll-scholar into.
If you've found a bug or have a question, please open an issue on the 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). [Jekyll-Scholar issue tracker](http://github.com/inukshuk/jekyll-scholar/issues).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment