Commit 0673a772 authored by JoostvanPinxten's avatar JoostvanPinxten Committed by Sylvester Keil
Browse files

Fix default parameters as reported in #168 (#169)

* 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
parent d85c1dbc
...@@ -73,7 +73,7 @@ default configuration is as follows: ...@@ -73,7 +73,7 @@ default configuration is as follows:
replace_strings: true replace_strings: true
join_strings: true join_strings: true
use_raw_bibtex_entry: false use_raw_bibtex_entry: true
bibtex_filters: bibtex_filters:
- superscript - superscript
- latex - latex
...@@ -101,10 +101,11 @@ The `source` option indicates where your bibliographies are stored; ...@@ -101,10 +101,11 @@ The `source` option indicates where your bibliographies are stored;
`bibliography` is the name of your default bibliography. For best results, `bibliography` is the name of your default bibliography. For best results,
please ensure that your Bibliography is encoded as ASCII or UTF-8. 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 The `use_raw_bibtex_entry` option by default disable parsing of Liquid tags
are embedded in the Bibtex fields. This option provides a way to circumvent embedded in the Bibtex fields. This option provides a way to circumvent the
the problem that the double braces functionality of BibTex is accidentally problem that (the conflicting syntax of) the double braces functionality of
parsed by Liquid, while it was intended to keep the exact capitalization style. 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 The `sort_by` and `order` options specify if and how bibliography
entries are sorted. Entries can be sorted on multiple fields, by using entries are sorted. Entries can be sorted on multiple fields, by using
......
...@@ -36,7 +36,6 @@ Feature: Citations ...@@ -36,7 +36,6 @@ Feature: Citations
| source | ./_bibliography | | source | ./_bibliography |
| bibliography_template | {{entry.bibtex}} | | bibliography_template | {{entry.bibtex}} |
| details_layout | details.html | | details_layout | details.html |
| use_raw_bibtex_entry | true |
And I have a "_bibliography" directory And I have a "_bibliography" directory
And I have a file "_bibliography/references.bib": And I have a file "_bibliography/references.bib":
""" """
...@@ -65,6 +64,7 @@ Feature: Citations ...@@ -65,6 +64,7 @@ Feature: Citations
| source | ./_bibliography | | source | ./_bibliography |
| bibliography_template | {{entry.bibtex}} | | bibliography_template | {{entry.bibtex}} |
| details_layout | details.html | | details_layout | details.html |
| use_raw_bibtex_entry | false |
And I have a "_bibliography" directory And I have a "_bibliography" directory
And I have a file "_bibliography/references.bib": And I have a file "_bibliography/references.bib":
""" """
......
...@@ -28,7 +28,7 @@ module Jekyll ...@@ -28,7 +28,7 @@ module Jekyll
'details_dir' => 'bibliography', 'details_dir' => 'bibliography',
'details_layout' => 'bibtex.html', 'details_layout' => 'bibtex.html',
'details_link' => 'Details', 'details_link' => 'Details',
'use_raw_bibtex_entry' => false, 'use_raw_bibtex_entry' => true,
'bibliography_class' => 'bibliography', 'bibliography_class' => 'bibliography',
'bibliography_template' => '{{reference}}', 'bibliography_template' => '{{reference}}',
......
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