1
- name: crossref
2
  description: 
3
    short: Configuration for cross-reference labels and prefixes.
4
    long: Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details.
5
  schema:
6
    anyOf:
7
      - enum: [false]
8
      - object:
9
          closed: true
10
          properties:
11
            custom:
12
              arrayOf:
13
                object:
14
                  description: A custom cross reference type. See [Custom](https://quarto.org/docs/reference/metadata/crossref.html#custom) for more details.
15
                  closed: true
16
                  required: ["kind", "reference-prefix", "key"]
17
                  properties:
18
                    kind:
19
                      enum: [float]
20
                      description: The kind of cross reference (currently only "float" is supported).
21
                    reference-prefix:
22
                      string:
23
                        description: The prefix used in rendered references when referencing this type.
24
                    caption-prefix:
25
                      string:
26
                        description: The prefix used in rendered captions when referencing this type. If omitted, the field `reference-prefix` is used.
27
                    space-before-numbering:
28
                      default: true
29
                      boolean:
30
                        description: If false, use no space between crossref prefixes and numbering.
31
                    key:
32
                      string:
33
                        description: The key used to prefix reference labels of this type, such as "fig", "tbl", "lst", etc.
34
                    latex-env:
35
                      string:
36
                        description: In LaTeX output, the name of the custom environment to be used.
37
                    latex-list-of-file-extension:
38
                      string:
39
                        description: In LaTeX output, the extension of the auxiliary file used by LaTeX to collect names to be used in the custom "list of" command. If omitted, a string with prefix `lo` and suffix with the value of `ref-type` is used.
40
                    latex-list-of-description:
41
                      string:
42
                        description: The description of the crossreferenceable object to be used in the title of the "list of" command. If omitted, the field `reference-prefix` is used.
43
                    caption-location:
44
                      enum: [top, bottom, margin]
45
                      default: bottom
46
                      description: The location of the caption relative to the crossreferenceable content.
47

48
            chapters:
49
              boolean:
50
                description: Use top level sections (H1) in this document as chapters.
51
                default: false
52
            title-delim:
53
              string:
54
                description: The delimiter used between the prefix and the caption.
55
            fig-title:
56
              string:
57
                description: The title prefix used for figure captions.
58
            tbl-title:
59
              string:
60
                description: The title prefix used for table captions.
61
            eq-title:
62
              string:
63
                description: The title prefix used for equation captions.
64
            lst-title:
65
              string:
66
                description: The title prefix used for listing captions.
67
            thm-title:
68
              string:
69
                description: The title prefix used for theorem captions.
70
            lem-title:
71
              string:
72
                description: The title prefix used for lemma captions.
73
            cor-title:
74
              string:
75
                description: The title prefix used for corollary captions.
76
            prp-title:
77
              string:
78
                description: The title prefix used for proposition captions.
79
            cnj-title:
80
              string:
81
                description: The title prefix used for conjecture captions.
82
            def-title:
83
              string:
84
                description: The title prefix used for definition captions.
85
            exm-title:
86
              string:
87
                description: The title prefix used for example captions.
88
            exr-title:
89
              string:
90
                description: The title prefix used for exercise captions.
91
            fig-prefix:
92
              string:
93
                description: The prefix used for an inline reference to a figure.
94
            tbl-prefix:
95
              string:
96
                description: The prefix used for an inline reference to a table.
97
            eq-prefix:
98
              string:
99
                description: The prefix used for an inline reference to an equation.
100
            sec-prefix:
101
              string:
102
                description: The prefix used for an inline reference to a section.
103
            lst-prefix:
104
              string:
105
                description: The prefix used for an inline reference to a listing.
106
            thm-prefix:
107
              string:
108
                description: The prefix used for an inline reference to a theorem.
109
            lem-prefix:
110
              string:
111
                description: The prefix used for an inline reference to a lemma.
112
            cor-prefix:
113
              string:
114
                description: The prefix used for an inline reference to a corollary.
115
            prp-prefix:
116
              string:
117
                description: The prefix used for an inline reference to a proposition.
118
            cnj-prefix:
119
              string:
120
                description: The prefix used for an inline reference to a conjecture.
121
            def-prefix:
122
              string:
123
                description: The prefix used for an inline reference to a definition.
124
            exm-prefix:
125
              string:
126
                description: The prefix used for an inline reference to an example.
127
            exr-prefix:
128
              string:
129
                description: The prefix used for an inline reference to an exercise.
130

131
            fig-labels:
132
              ref: crossref-labels-schema
133
              description: The numbering scheme used for figures.
134

135
            tbl-labels:
136
              ref: crossref-labels-schema
137
              description: The numbering scheme used for tables.
138

139
            eq-labels:
140
              ref: crossref-labels-schema
141
              description: The numbering scheme used for equations.
142

143
            sec-labels:
144
              ref: crossref-labels-schema
145
              description: The numbering scheme used for sections.
146

147
            lst-labels:
148
              ref: crossref-labels-schema
149
              description: The numbering scheme used for listings.
150

151
            thm-labels:
152
              ref: crossref-labels-schema
153
              description: The numbering scheme used for theorems.
154

155
            lem-labels:
156
              ref: crossref-labels-schema
157
              description: The numbering scheme used for lemmas.
158

159
            cor-labels:
160
              ref: crossref-labels-schema
161
              description: The numbering scheme used for corollaries.
162

163
            prp-labels:
164
              ref: crossref-labels-schema
165
              description: The numbering scheme used for propositions.
166

167
            cnj-labels:
168
              ref: crossref-labels-schema
169
              description: The numbering scheme used for conjectures.
170

171
            def-labels:
172
              ref: crossref-labels-schema
173
              description: The numbering scheme used for definitions.
174

175
            exm-labels:
176
              ref: crossref-labels-schema
177
              description: The numbering scheme used for examples.
178

179
            exr-labels:
180
              ref: crossref-labels-schema
181
              description: The numbering scheme used for exercises.
182

183
            lof-title:
184
              string:
185
                description: The title used for the list of figures.
186

187
            lot-title:
188
              string:
189
                description: The title used for the list of tables.
190

191
            lol-title:
192
              string:
193
                description: The title used for the list of listings.
194

195
            labels:
196
              ref: crossref-labels-schema
197
              description: The number scheme used for references.
198

199
            subref-labels:
200
              ref: crossref-labels-schema
201
              description: The number scheme used for sub references.
202

203
            ref-hyperlink:
204
              boolean:
205
                default: true
206
                description: Whether cross references should be hyper-linked.
207

208
            appendix-title:
209
              string:
210
                description: The title used for appendix.
211

212
            appendix-delim:
213
              string:
214
                description: The delimiter beween appendix number and title.
215

216
- name: crossrefs-hover
217
  schema: boolean
218
  tags:
219
    formats: [$html-files]
220
  default: true
221
  description: Enables a hover popup for cross references that shows the item being referenced.
222

223