Between Tuesday August 20th, 5:00pm and Thursday August 22nd, 8:00am git.uwaterloo.ca will be down for an upgrade to version 10.8.7.

fd1c3435 by Ellis Michael Committed by Sylvester Keil

Referencing defaults.rb from README, added table (#178)

The README now explicitly says it only contains some of the configuration
and that the others are in defaults.rb. Config options are listed in a
table.
1 parent de618cc5
...@@ -53,92 +53,32 @@ configuration: ...@@ -53,92 +53,32 @@ configuration:
53 53
54 gems: ['jekyll/scholar'] 54 gems: ['jekyll/scholar']
55 55
56 In your configuration you can now adjust the Jekyll-Scholar settings. The 56 ### Configuration
57 default configuration is as follows: 57
58 In your Jekyll configuration file you can adjust the Jekyll-Scholar settings
59 using the `scholar` key. For example, the following sets the bibliography style
60 to `mla`.
58 61
59 scholar: 62 scholar:
60 style: apa 63 style: mla
61 locale: en 64
62 65 The table below describes some commonly used configuration options. For a
63 sort_by: none 66 description of all options and their defaults, see
64 order: ascending 67 [`defaults.rb`](/lib/jekyll/scholar/defaults.rb).
65 68
66 group_by: none 69 | Option | Default | Description |
67 group_order: ascending 70 |--------|---------|-------------|
68 71 | `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)). |
69 source: ./_bibliography 72 | `locale` | `en` | Defines what language to use when formatting your references (this typically applies to localized terms, e.g., 'Eds.' for editors in English). |
70 bibliography: references.bib 73 | `source` | `./_bibliography` | Indicates where your bibliographies are stored. |
71 bibliography_template: "{{reference}}" 74 | `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. |
72 75 | `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. |
73 replace_strings: true 76 | `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. |
74 join_strings: true 77 | `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. |
75 78 | `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. |
76 use_raw_bibtex_entry: true 79 | `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 }`. |
77 bibtex_filters: 80 | `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. |
78 - superscript 81
79 - latex
80
81 details_dir: bibliography
82 details_layout: bibtex.html
83 details_link: Details
84
85 query: "@*"
86
87 You can use any style that ships with
88 [CiteProc-Ruby](https://github.com/inukshuk/citeproc-ruby) by name (e.g.,
89 apa, mla, chicago-fullnote-bibliography) which is usually the filename as seen
90 [here](https://github.com/citation-style-language/styles)
91 sans the `.csl` ending; note that you have to use `dependent/style` if you want
92 to use one from that directory.
93 Alternatively you can add a link to any CSL style (e.g., you could link to any of the styles available at
94 the official [CSL style repository](https://github.com/citation-style-language/styles)).
95
96 The `locale` settings defines what language to use when formatting
97 your references (this typically applies to localized terms, e.g., 'Eds.' for
98 editors in English).
99
100 The `source` option indicates where your bibliographies are stored;
101 `bibliography` is the name of your default bibliography. For best results,
102 please ensure that your Bibliography is encoded as ASCII or UTF-8.
103
104 The `use_raw_bibtex_entry` option by default disable parsing of Liquid tags
105 embedded in the Bibtex fields. This option provides a way to circumvent the
106 problem that (the conflicting syntax of) the double braces functionality of
107 BibTex is accidentally parsed by Liquid, while it was intended to keep the
108 exact capitalization style.
109
110 The `sort_by` and `order` options specify if and how bibliography
111 entries are sorted. Entries can be sorted on multiple fields, by using
112 a list of keys, e.g. `sort_by: year,month`. Ordering can be specified
113 per sort level, e.g. `order: descending,ascending` will sort the years
114 descending, but per year the months are ascending. If there are more
115 sort keys than order directives, the last order entry is used for the
116 remaining keys.
117
118 The `group_by` and `group_order` options specify how bibliography
119 items are grouped. Grouping can be multi-level as well,
120 e.g. `group_by: type, year` groups entries per publication type, and
121 within those groups per year. Ordering for groups is specified in the
122 same way as the sort order. Publication types -- specified with group
123 key `type`, can be ordered by adding `type_order` to the
124 configuration. For example, `type_order: article,techreport` lists
125 journal articles before technical reports. Types not mentioned in
126 `type_order` are considered smaller than types that are
127 mentioned. Types can be merge in one group using the `type_aliases`
128 setting. By default `phdthesis` and `mastersthesis` are grouped as
129 `thesis`. By using, for example, `type_aliases: { inproceedings:
130 article}`, journal and conference articles appear in a single
131 group. The display names for entry types are specified with
132 `type_names`. Names for common types are provided, but they can be
133 extended or overridden. For example, the default name for `article` is
134 *Journal Articles*, but it can be changed to *Papers* using
135 `type_names: { article: Papers }`.
136
137 The `bibtex_filters` option configures which
138 [BibTeX-Ruby](https://github.com/inukshuk/bibtex-ruby) formatting filters
139 values of entries should be passed through. This defaults to the `latex`
140 filter which converts LaTeX character escapes into unicode, and `superscript`
141 which converts the `\textsuperscript` command into a HTML `<sup>` tag.
142 82
143 ### Bibliographies 83 ### Bibliographies
144 84
......
1 module Jekyll 1 module Jekyll
2 class Scholar 2 class Scholar
3 @defaults = { 3 @defaults = {
4 # Style used for citations and bibliographies
4 'style' => 'apa', 5 'style' => 'apa',
6 # Sets languages used in bibliography
5 'locale' => 'en', 7 'locale' => 'en',
6 8
9 # Keys used to sort bibliography
7 'sort_by' => 'none', 10 'sort_by' => 'none',
11 # Order used to sort biobliography
8 'order' => 'ascending', 12 'order' => 'ascending',
9 'group_by' => 'none', 13 'group_by' => 'none',
10 'group_order' => 'ascending', 14 'group_order' => 'ascending',
15 # HTML tags used for bibliography group names
11 'bibliography_group_tag' => 'h2,h3,h4,h5', 16 'bibliography_group_tag' => 'h2,h3,h4,h5',
17 # HTML tag used for list of bibliography entries
12 'bibliography_list_tag' => 'ol', 18 'bibliography_list_tag' => 'ol',
19 # HTML tag used for individual bibliography entries
13 'bibliography_item_tag' => 'li', 20 'bibliography_item_tag' => 'li',
21 # Attributes applied to HTML tag for list of bibliography entries
14 'bibliography_list_attributes' => {}, 22 'bibliography_list_attributes' => {},
23 # Attributes applied to HTML tag for bibliography entries
15 'bibliography_item_attributes' => {}, 24 'bibliography_item_attributes' => {},
16 25
26 # Name of folder references files are stored in
17 'source' => './_bibliography', 27 'source' => './_bibliography',
28 # Name of default references file
18 'bibliography' => 'references.bib', 29 'bibliography' => 'references.bib',
19 'repository' => nil, 30 'repository' => nil,
20 31
......