Path: blob/main/src/resources/schema/document-references.yml
12921 views
- name: bibliography1schema:2maybeArrayOf: path3description: |4Document bibliography (BibTeX or CSL). May be a single file or a list of files56- name: csl7schema: path8description: Citation Style Language file to use for formatting references.910- name: citations-hover11schema: boolean12tags:13formats: [$html-files]14default: true15description: Enables a hover popup for citation that shows the reference information.1617- name: citation-location18schema:19enum: [document, margin]20tags:21formats: [$html-doc, typst]22default: document23description: Where citation information should be displayed (`document` or `margin`)2425- name: cite-method26tags:27formats: [$pdf-all]28schema:29enum: [citeproc, natbib, biblatex]30default: citeproc31description: |32Method used to format citations (`citeproc`, `natbib`, or `biblatex`).3334- name: citeproc35schema: boolean36default: true37description:38short: "Turn on built-in citation processing"39long: |40Turn on built-in citation processing. To use this feature, you will need41to have a document containing citations and a source of bibliographic data:42either an external bibliography file or a list of `references` in the43document's YAML metadata. You can optionally also include a `csl`44citation style file.4546- name: biblatexoptions47schema:48maybeArrayOf: string49tags:50formats: [$pdf-all]51description: A list of options for BibLaTeX.5253- name: natbiboptions54schema:55maybeArrayOf: string56tags:57formats: [$pdf-all]58description: One or more options to provide for `natbib` when generating a bibliography.5960- name: biblio-style61schema: string62tags:63formats: [$pdf-all]64description: The bibliography style to use (e.g. `\bibliographystyle{dinat}`) when using `natbib` or `biblatex`.6566- name: bibliographystyle67schema: string68tags:69formats: [typst]70description: 'The bibliography style to use (e.g. `#set bibliography(style: "apa")`) when using typst built-in citation system (e.g when not `citeproc: true`).'7172- name: biblio-title73schema: string74tags:75formats: [$pdf-all]76description: The bibliography title to use when using `natbib` or `biblatex`.7778- name: biblio-config79schema: boolean80tags:81formats: [$pdf-all]82description: Controls whether to output bibliography configuration for `natbib` or `biblatex` when cite method is not `citeproc`.8384- name: citation-abbreviations85schema: path86description:87short: "JSON file containing abbreviations of journals that should be used in formatted bibliographies."88long: |89JSON file containing abbreviations of journals that should be90used in formatted bibliographies when `form="short"` is91specified. The format of the file can be illustrated with an92example:9394```json95{ "default": {96"container-title": {97"Lloyd's Law Reports": "Lloyd's Rep",98"Estates Gazette": "EG",99"Scots Law Times": "SLT"100}101}102}103```104- name: link-citations105schema: boolean106tags:107formats: [$pdf-all, docx]108description: If true, citations will be hyperlinked to the corresponding bibliography entries (for author-date and numerical styles only). Defaults to false.109110- name: link-bibliography111schema: boolean112tags:113formats: [$pdf-all, docx]114description:115short: If true, DOIs, PMCIDs, PMID, and URLs in bibliographies will be rendered as hyperlinks.116long: |117If 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 of118these 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.119120- name: notes-after-punctuation121schema: boolean122tags:123formats: [$pdf-all, docx]124description:125short: Places footnote references or superscripted numerical citations after following punctuation.126long: |127If true (the default for note styles), Quarto (via Pandoc) will put footnote references or superscripted numerical citations after128following punctuation. For example, if the source contains `blah blah [@jones99]`., the result will look like `blah blah.[^1]`, with129the note moved after the period and the space collapsed.130131If false, the space will still be collapsed, but the footnote will not be moved after the punctuation. The option may also be used132in numerical styles that use superscripts for citation numbers (but for these styles the default is not to move the citation).133134135