Skip to content

Commit

Permalink
Fix default parameters as reported in #168 (#169)
Browse files Browse the repository at this point in the history
* Add test for raw bibtex entries on the details page. It currently fails as the details generator does not get passed through the liquidify utility, but instead is passed to liquid parser immediately.

* Fix the issue that the bibliography tag is rendered differently on the details page than in the bibliography tag. They should now behave (more or less) in the same way.

* Change default for use_raw_bibtex_entry to true, which is a saner default. Fixes issue #168.

* Fix documentation style to be consistent, and update the description of use_raw_bibtex_entries to include how/when to use it.

* Fix feature tests for raw bibtex entries, default value is now False instead of True
  • Loading branch information
JoostvanPinxten authored and inukshuk committed Sep 26, 2016
1 parent d85c1db commit 0673a77
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ default configuration is as follows:
replace_strings: true
join_strings: true

use_raw_bibtex_entry: false
use_raw_bibtex_entry: true
bibtex_filters:
- superscript
- latex
Expand Down Expand Up @@ -101,10 +101,11 @@ The `source` option indicates where your bibliographies are stored;
`bibliography` is the name of your default bibliography. For best results,
please ensure that your Bibliography is encoded as ASCII or UTF-8.

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.
The `use_raw_bibtex_entry` option by default disable 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.

The `sort_by` and `order` options specify if and how bibliography
entries are sorted. Entries can be sorted on multiple fields, by using
Expand Down
2 changes: 1 addition & 1 deletion features/cite_details.feature
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ Feature: Citations
| source | ./_bibliography |
| bibliography_template | {{entry.bibtex}} |
| details_layout | details.html |
| use_raw_bibtex_entry | true |
And I have a "_bibliography" directory
And I have a file "_bibliography/references.bib":
"""
Expand Down Expand Up @@ -65,6 +64,7 @@ Feature: Citations
| source | ./_bibliography |
| bibliography_template | {{entry.bibtex}} |
| details_layout | details.html |
| use_raw_bibtex_entry | false |
And I have a "_bibliography" directory
And I have a file "_bibliography/references.bib":
"""
Expand Down
2 changes: 1 addition & 1 deletion lib/jekyll/scholar/defaults.rb
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class Scholar
'details_dir' => 'bibliography',
'details_layout' => 'bibtex.html',
'details_link' => 'Details',
'use_raw_bibtex_entry' => false,
'use_raw_bibtex_entry' => true,

'bibliography_class' => 'bibliography',
'bibliography_template' => '{{reference}}',
Expand Down

0 comments on commit 0673a77

Please sign in to comment.