1
- name: bibliography
2
  schema:
3
    maybeArrayOf: path
4
  description: |
5
    Document bibliography (BibTeX or CSL). May be a single file or a list of files
6

7
- name: csl
8
  schema: path
9
  description: Citation Style Language file to use for formatting references.
10

11
- name: citations-hover
12
  schema: boolean
13
  tags:
14
    formats: [$html-files]
15
  default: true
16
  description: Enables a hover popup for citation that shows the reference information.
17

18
- name: citation-location
19
  schema:
20
    enum: [document, margin]
21
  tags:
22
    formats: [$html-doc, typst]
23
  default: document
24
  description: Where citation information should be displayed (`document` or `margin`)
25

26
- name: cite-method
27
  tags:
28
    formats: [$pdf-all]
29
  schema:
30
    enum: [citeproc, natbib, biblatex]
31
  default: citeproc
32
  description: |
33
    Method used to format citations (`citeproc`, `natbib`, or `biblatex`).
34

35
- name: citeproc
36
  schema: boolean
37
  default: true
38
  description:
39
    short: "Turn on built-in citation processing"
40
    long: |
41
      Turn on built-in citation processing. To use this feature, you will need
42
      to have a document containing citations and a source of bibliographic data: 
43
      either an external bibliography file or a list of `references` in the 
44
      document's YAML metadata. You can optionally also include a `csl` 
45
      citation style file.
46

47
- name: biblatexoptions
48
  schema:
49
    maybeArrayOf: string
50
  tags:
51
    formats: [$pdf-all]
52
  description: A list of options for BibLaTeX.
53

54
- name: natbiboptions
55
  schema:
56
    maybeArrayOf: string
57
  tags:
58
    formats: [$pdf-all]
59
  description: One or more options to provide for `natbib` when generating a bibliography.
60

61
- name: biblio-style
62
  schema: string
63
  tags:
64
    formats: [$pdf-all]
65
  description: The bibliography style to use (e.g. `\bibliographystyle{dinat}`) when using `natbib` or `biblatex`.
66

67
- name: bibliographystyle
68
  schema: string
69
  tags:
70
    formats: [typst]
71
  description: 'The bibliography style to use (e.g. `#set bibliography(style: "apa")`) when using typst built-in citation system (e.g when not `citeproc: true`).'
72

73
- name: biblio-title
74
  schema: string
75
  tags:
76
    formats: [$pdf-all]
77
  description: The bibliography title to use when using `natbib` or `biblatex`.
78

79
- name: biblio-config
80
  schema: boolean
81
  tags:
82
    formats: [$pdf-all]
83
  description: Controls whether to output bibliography configuration for `natbib` or `biblatex` when cite method is not `citeproc`.
84

85
- name: citation-abbreviations
86
  schema: path
87
  description:
88
    short: "JSON file containing abbreviations of journals that should be used in formatted bibliographies."
89
    long: |
90
      JSON file containing abbreviations of journals that should be
91
      used in formatted bibliographies when `form="short"` is
92
      specified. The format of the file can be illustrated with an
93
      example:
94

95
      ```json
96
      { "default": {
97
          "container-title": {
98
            "Lloyd's Law Reports": "Lloyd's Rep",
99
            "Estates Gazette": "EG",
100
            "Scots Law Times": "SLT"
101
          }
102
        }
103
      }
104
      ```
105
- name: link-citations
106
  schema: boolean
107
  tags:
108
    formats: [$pdf-all, docx]
109
  description: If true, citations will be hyperlinked to the corresponding bibliography entries (for author-date and numerical styles only). Defaults to false.
110

111
- name: link-bibliography
112
  schema: boolean
113
  tags:
114
    formats: [$pdf-all, docx]
115
  description:
116
    short: If true, DOIs, PMCIDs, PMID, and URLs in bibliographies will be rendered as hyperlinks.
117
    long: |
118
      If true, DOIs, PMCIDs, PMID, and URLs in bibliographies will be rendered as hyperlinks. (If an entry contains a DOI, PMCID, PMID, or URL, but none of 
119
      these fields are rendered by the style, then the title, or in the absence of a title the whole entry, will be hyperlinked.) Defaults to true.
120

121
- name: notes-after-punctuation
122
  schema: boolean
123
  tags:
124
    formats: [$pdf-all, docx]
125
  description:
126
    short: Places footnote references or superscripted numerical citations after following punctuation.
127
    long: |
128
      If true (the default for note styles), Quarto (via Pandoc) will put footnote references or superscripted numerical citations after 
129
      following punctuation. For example, if the source contains `blah blah [@jones99]`., the result will look like `blah blah.[^1]`, with 
130
      the note moved after the period and the space collapsed. 
131

132
      If false, the space will still be collapsed, but the footnote will not be moved after the punctuation. The option may also be used 
133
      in numerical styles that use superscripts for citation numbers (but for these styles the default is not to move the citation).
134

135