defaults.rb 2.72 KB
Newer Older
1 2
module Jekyll
  class Scholar
Sylvester Keil's avatar
Sylvester Keil committed
3
    @defaults = {
4
      # Style used for citations and bibliographies
5
      'style'                  => 'apa',
6
      # Sets languages used in bibliography
7
      'locale'                 => 'en',
8

9
      # Keys used to sort bibliography
10
      'sort_by'                => 'none',
11
      # Order used to sort biobliography
12 13 14
      'order'                  => 'ascending',
      'group_by'               => 'none',
      'group_order'            => 'ascending',
15
      # HTML tags used for bibliography group names
16
      'bibliography_group_tag' => 'h2,h3,h4,h5',
17
      # HTML tag used for list of bibliography entries
18
      'bibliography_list_tag'  => 'ol',
19
      # HTML tag used for individual bibliography entries
20
      'bibliography_item_tag'  => 'li',
21
      # Attributes applied to HTML tag for list of bibliography entries
22
      'bibliography_list_attributes' => {},
23
      # Attributes applied to HTML tag for bibliography entries
24
      'bibliography_item_attributes' => {},
25

26
      # Name of folder references files are stored in
27
      'source'                 => './_bibliography',
28
      # Name of default references file
29 30
      'bibliography'           => 'references.bib',
      'repository'             => nil,
31

32
      'bibtex_options'         => { :strip => false, :parse_months => true },
Thomas Wood's avatar
Thomas Wood committed
33
      'bibtex_filters'         => [ :superscript, :latex ],
34
      'bibtex_skip_fields'     => [ :abstract, :month_numeric ],
35

36 37
      'replace_strings'        => true,
      'join_strings'           => true,
38

39 40 41
      'details_dir'            => 'bibliography',
      'details_layout'         => 'bibtex.html',
      'details_link'           => 'Details',
42
      'use_raw_bibtex_entry'   => true,
43

44 45
      'bibliography_class'     => 'bibliography',
      'bibliography_template'  => '{{reference}}',
46

47 48
      'reference_tagname'      => 'span',
      'missing_reference'      => '(missing reference)',
Sylvester Keil's avatar
Sylvester Keil committed
49

50
      'details_link_class'     => 'details',
Sylvester Keil's avatar
Sylvester Keil committed
51

52 53 54 55 56 57 58 59
      'query'                  => '@*',

      'type_names' => {
        'article' => 'Journal Articles',
        'book' => 'Books',
        'incollection' => 'Book Chapters',
        'inproceedings' => 'Conference Articles',
        'thesis' => 'Theses',
60 61
        'mastersthesis' => 'Master\'s Theses',
        'phdthesis' => 'PhD Theses',
62 63 64 65 66 67 68 69 70 71
        'manual' => 'Manuals',
        'techreport' => 'Technical Reports',
        'misc' => 'Miscellaneous',
        'unpublished' => 'Unpublished',
      },
      'type_aliases' => {
        'phdthesis' => 'thesis',
        'mastersthesis' => 'thesis',
      },
      'type_order' => [],
Sylvester Keil's avatar
Sylvester Keil committed
72

73
      'month_names' => nil,
rmrf's avatar
rmrf committed
74 75 76
      # Delimiter for files in repositories for slides
      'file_delimit' => '_',
      
Sylvester Keil's avatar
Sylvester Keil committed
77
    }.freeze
78 79 80 81 82

    class << self
      attr_reader :defaults
    end
  end
Sylvester Keil's avatar
Sylvester Keil committed
83
end