-
Notifications
You must be signed in to change notification settings - Fork 1k
Expand file tree
/
Copy pathbeamer.json
More file actions
771 lines (771 loc) · 41.8 KB
/
beamer.json
File metadata and controls
771 lines (771 loc) · 41.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
[
{
"name": "attributes",
"title": "Title & Author",
"options": [
{
"name": "title",
"description": "Document title"
},
{
"name": "subtitle",
"description": "Identifies the subtitle of the document."
},
{
"name": "date",
"description": "Document date"
},
{
"name": "author",
"description": "Author or authors of the document"
},
{
"name": "institute",
"description": "Author affiliations for the presentation."
},
{
"name": "abstract",
"description": "Summary of document"
},
{
"name": "thanks",
"description": "The contents of an acknowledgments footnote after the document title."
},
{
"name": "order",
"description": "Order for document when included in a website automatic sidebar menu."
}
]
},
{
"name": "options",
"title": "Format Options",
"options": [
{
"name": "theme",
"description": "Theme name, theme scss file, or a mix of both."
},
{
"name": "pdf-engine",
"description": "Use the specified engine when producing PDF output. If the engine is not\nin your PATH, the full path of the engine may be specified here. If this\noption is not specified, Quarto uses the following defaults\ndepending on the output format in use:\n\n- `latex`: `xelatex` (other options: `pdflatex`, `lualatex`,\n `tectonic`, `latexmk`)\n- `context`: `context`\n- `html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;\n see [print-css.rocks](https://print-css.rocks) for a good\n introduction to PDF generation from HTML/CSS.)\n- `ms`: `pdfroff`\n"
},
{
"name": "pdf-engine-opt",
"description": "Use the given string as a command-line argument to the pdf-engine.\nFor example, to use a persistent directory foo for latexmk’s auxiliary\nfiles, use `pdf-engine-opt: -outdir=foo`. Note that no check for \nduplicate options is done.\n"
},
{
"name": "beameroption",
"description": "Add an extra Beamer option using `\\setbeameroption{}`."
},
{
"name": "aspectratio",
"description": "The aspect ratio for this presentation."
},
{
"name": "logo",
"description": "The logo image."
},
{
"name": "titlegraphic",
"description": "The image for the title slide."
},
{
"name": "navigation",
"description": "Controls navigation symbols for the presentation (`empty`, `frame`, `vertical`, or `horizontal`)"
},
{
"name": "section-titles",
"description": "Whether to enable title pages for new sections."
},
{
"name": "colortheme",
"description": "The Beamer color theme for this presentation."
},
{
"name": "fonttheme",
"description": "The Beamer font theme for this presentation."
},
{
"name": "innertheme",
"description": "The Beamer inner theme for this presentation."
},
{
"name": "outertheme",
"description": "The Beamer outer theme for this presentation."
},
{
"name": "themeoptions",
"description": "Options passed to LaTeX Beamer themes."
},
{
"name": "quarto-required",
"description": "A semver version range describing the supported quarto versions for this document\nor project.\n\nExamples:\n\n- `>= 1.1.0`: Require at least quarto version 1.1\n- `1.*`: Require any quarto versions whose major version number is 1\n"
}
]
},
{
"name": "toc",
"title": "Table of Contents",
"options": [
{
"name": "toc",
"description": "Include an automatically generated table of contents (or, in\nthe case of `latex`, `context`, `docx`, `odt`,\n`opendocument`, `rst`, or `ms`, an instruction to create\none) in the output document. This option has no effect\nif `standalone` is `false`.\n\nNote that if you are producing a PDF via `ms`, the table\nof contents will appear at the beginning of the\ndocument, before the title. If you would prefer it to\nbe at the end of the document, use the option\n`pdf-engine-opt: --no-toc-relocation`.\n"
},
{
"name": "toc-title",
"description": "The title used for the table of contents."
},
{
"name": "lof",
"description": "Print a list of figures in the document."
},
{
"name": "lot",
"description": "Print a list of tables in the document."
}
]
},
{
"name": "numbering",
"title": "Numbering",
"options": [
{
"name": "number-sections",
"description": "Number section headings rendered output. By default, sections are not numbered.\nSections with class `.unnumbered` will never be numbered, even if `number-sections`\nis specified.\n"
},
{
"name": "number-depth",
"description": "By default, all headings in your document create a \nnumbered section. You customize numbering depth using \nthe `number-depth` option. \n\nFor example, to only number sections immediately below \nthe chapter level, use this:\n\n```yaml \nnumber-depth: 1\n```\n"
},
{
"name": "number-offset",
"description": "Offset for section headings in output (offsets are 0 by default)\nThe first number is added to the section number for\ntop-level headings, the second for second-level headings, and so on.\nSo, for example, if you want the first top-level heading in your\ndocument to be numbered \"6\", specify `number-offset: 5`. If your\ndocument starts with a level-2 heading which you want to be numbered\n\"1.5\", specify `number-offset: [1,4]`. Implies `number-sections`\n"
},
{
"name": "shift-heading-level-by",
"description": "Shift heading levels by a positive or negative integer.\nFor example, with `shift-heading-level-by: -1`, level 2\nheadings become level 1 headings, and level 3 headings\nbecome level 2 headings. Headings cannot have a level\nless than 1, so a heading that would be shifted below level 1\nbecomes a regular paragraph. Exception: with a shift of -N,\na level-N heading at the beginning of the document\nreplaces the metadata title.\n"
},
{
"name": "top-level-division",
"description": "Treat top-level headings as the given division type (`default`, `section`, `chapter`, or `part`). The hierarchy\norder is part, chapter, then section; all headings are shifted such \nthat the top-level heading becomes the specified type. \n\nThe default behavior is to determine the\nbest division type via heuristics: unless other conditions\napply, `section` is chosen. When the `documentclass`\nvariable is set to `report`, `book`, or `memoir` (unless the\n`article` option is specified), `chapter` is implied as the\nsetting for this option. If `beamer` is the output format,\nspecifying either `chapter` or `part` will cause top-level\nheadings to become `\\part{..}`, while second-level headings\nremain as their default type.\n"
}
]
},
{
"name": "slides",
"title": "Slides",
"options": [
{
"name": "incremental",
"description": "Make list items in slide shows display incrementally (one by one). \nThe default is for lists to be displayed all at once.\n"
},
{
"name": "slide-level",
"description": "Specifies that headings with the specified level create slides.\nHeadings above this level in the hierarchy are used to divide \nthe slide show into sections; headings below this level create \nsubheads within a slide. Valid values are 0-6. If a slide level\nof 0 is specified, slides will not be split automatically on \nheadings, and horizontal rules must be used to indicate slide \nboundaries. If a slide level is not specified explicitly, the\nslide level will be set automatically based on the contents of\nthe document\n"
}
]
},
{
"name": "fonts",
"title": "Fonts",
"options": [
{
"name": "mainfont",
"description": "For HTML output, sets the CSS `font-family` on the HTML element.\n\nFor LaTeX output, the main font family for use with `xelatex` or \n`lualatex`. Takes the name of any system font, using the\n[`fontspec`](https://ctan.org/pkg/fontspec) package. \n\nFor ConTeXt output, the main font family. Use the name of any \nsystem font. See [ConTeXt Fonts](https://wiki.contextgarden.net/Fonts) for more\ninformation.\n"
},
{
"name": "monofont",
"description": "For HTML output, sets the CSS font-family property on code elements.\n\nFor PowerPoint output, sets the font used for code.\n\nFor LaTeX output, the monospace font family for use with `xelatex` or \n`lualatex`: take the name of any system font, using the\n[`fontspec`](https://ctan.org/pkg/fontspec) package. \n\nFor ConTeXt output, the monspace font family. Use the name of any \nsystem font. See [ConTeXt Fonts](https://wiki.contextgarden.net/Fonts) for more\ninformation.\n"
},
{
"name": "fontsize",
"description": "For HTML output, sets the base CSS `font-size` property.\n\nFor LaTeX and ConTeXt output, sets the font size for the document body text.\n"
},
{
"name": "fontenc",
"description": "Allows font encoding to be specified through [`fontenc`](https://www.ctan.org/pkg/fontenc) package.\n\nSee [LaTeX Font Encodings Guide](https://ctan.org/pkg/encguide) for addition information on font encoding.\n"
},
{
"name": "fontfamily",
"description": "Font package to use when compiling a PDf with the `pdflatex` `pdf-engine`. \n\nSee [The LaTeX Font Catalogue](https://tug.org/FontCatalogue/) for a \nsummary of font options available.\n\nFor groff (`ms`) files, the font family for example, `T` or `P`.\n"
},
{
"name": "fontfamilyoptions",
"description": "Options for the package used as `fontfamily`.\n\nFor example, to use the Libertine font with proportional lowercase\n(old-style) figures through the [`libertinus`](https://ctan.org/pkg/libertinus) package:\n\n```yaml\nfontfamily: libertinus\nfontfamilyoptions:\n - osf\n - p\n```\n"
},
{
"name": "sansfont",
"description": "The sans serif font family for use with `xelatex` or \n`lualatex`. Takes the name of any system font, using the\n[`fontspec`](https://ctan.org/pkg/fontspec) package.\n"
},
{
"name": "mathfont",
"description": "The math font family for use with `xelatex` or \n`lualatex`. Takes the name of any system font, using the\n[`fontspec`](https://ctan.org/pkg/fontspec) package.\n"
},
{
"name": "CJKmainfont",
"description": "The CJK main font family for use with `xelatex` or \n`lualatex` using the [`xecjk`](https://ctan.org/pkg/xecjk) package.\n"
},
{
"name": "mainfontoptions",
"description": "The main font options for use with `xelatex` or `lualatex` allowing\nany options available through [`fontspec`](https://ctan.org/pkg/fontspec).\n\nFor example, to use the [TeX Gyre](http://www.gust.org.pl/projects/e-foundry/tex-gyre) \nversion of Palatino with lowercase figures:\n\n```yaml\nmainfont: TeX Gyre Pagella\nmainfontoptions:\n - Numbers=Lowercase\n - Numbers=Proportional \n```\n"
},
{
"name": "sansfontoptions",
"description": "The sans serif font options for use with `xelatex` or `lualatex` allowing\nany options available through [`fontspec`](https://ctan.org/pkg/fontspec).\n"
},
{
"name": "monofontoptions",
"description": "The monospace font options for use with `xelatex` or `lualatex` allowing\nany options available through [`fontspec`](https://ctan.org/pkg/fontspec).\n"
},
{
"name": "mathfontoptions",
"description": "The math font options for use with `xelatex` or `lualatex` allowing\nany options available through [`fontspec`](https://ctan.org/pkg/fontspec).\n"
},
{
"name": "CJKoptions",
"description": "The CJK font options for use with `xelatex` or `lualatex` allowing\nany options available through [`fontspec`](https://ctan.org/pkg/fontspec).\n"
},
{
"name": "microtypeoptions",
"description": "Options to pass to the [microtype](https://ctan.org/pkg/microtype) package."
},
{
"name": "linestretch",
"description": "For HTML output sets the CSS `line-height` property on the html \nelement, which is preferred to be unitless.\n\nFor LaTeX output, adjusts line spacing using the \n[setspace](https://ctan.org/pkg/setspace) package, e.g. 1.25, 1.5.\n"
}
]
},
{
"name": "colors",
"title": "Colors",
"options": [
{
"name": "linkcolor",
"description": "For HTML output, sets the CSS `color` property on all links.\n\nFor LaTeX output, The color used for internal links using color options\nallowed by [`xcolor`](https://ctan.org/pkg/xcolor), \nincluding the `dvipsnames`, `svgnames`, and\n`x11names` lists.\n\nFor ConTeXt output, sets the color for both external links and links within the document.\n"
},
{
"name": "filecolor",
"description": "The color used for external links using color options\nallowed by [`xcolor`](https://ctan.org/pkg/xcolor), \nincluding the `dvipsnames`, `svgnames`, and\n`x11names` lists.\n"
},
{
"name": "citecolor",
"description": "The color used for citation links using color options\nallowed by [`xcolor`](https://ctan.org/pkg/xcolor), \nincluding the `dvipsnames`, `svgnames`, and\n`x11names` lists.\n"
},
{
"name": "urlcolor",
"description": "The color used for linked URLs using color options\nallowed by [`xcolor`](https://ctan.org/pkg/xcolor), \nincluding the `dvipsnames`, `svgnames`, and\n`x11names` lists.\n"
},
{
"name": "toccolor",
"description": "The color used for links in the Table of Contents using color options\nallowed by [`xcolor`](https://ctan.org/pkg/xcolor), \nincluding the `dvipsnames`, `svgnames`, and\n`x11names` lists.\n"
},
{
"name": "colorlinks",
"description": "Add color to link text, automatically enabled if any of \n`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set.\n"
}
]
},
{
"name": "layout",
"title": "Layout",
"options": [
{
"name": "cap-location",
"description": "Where to place figure and table captions (`top`, `bottom`, or `margin`)"
},
{
"name": "fig-cap-location",
"description": "Where to place figure captions (`top`, `bottom`, or `margin`)"
},
{
"name": "tbl-cap-location",
"description": "Where to place table captions (`top`, `bottom`, or `margin`)"
},
{
"name": "documentclass",
"description": "The document class."
},
{
"name": "classoption",
"description": "For LaTeX/PDF output, the options set for the document\nclass.\n\nFor HTML output using KaTeX, you can render display\nmath equations flush left using `classoption: fleqn`\n"
},
{
"name": "pagestyle",
"description": "Control the `\\pagestyle{}` for the document."
},
{
"name": "papersize",
"description": "The paper size for the document.\n"
},
{
"name": "grid",
"description": "Properties of the grid system used to layout Quarto HTML pages."
},
{
"name": "margin-left",
"description": "For HTML output, sets the `margin-left` property on the Body element.\n\nFor LaTeX output, sets the left margin if `geometry` is not \nused (otherwise `geometry` overrides this value)\n\nFor ConTeXt output, sets the left margin if `layout` is not used, \notherwise `layout` overrides these.\n\nFor `wkhtmltopdf` sets the left page margin.\n"
},
{
"name": "margin-right",
"description": "For HTML output, sets the `margin-right` property on the Body element.\n\nFor LaTeX output, sets the right margin if `geometry` is not \nused (otherwise `geometry` overrides this value)\n\nFor ConTeXt output, sets the right margin if `layout` is not used, \notherwise `layout` overrides these.\n\nFor `wkhtmltopdf` sets the right page margin.\n"
},
{
"name": "margin-top",
"description": "For HTML output, sets the `margin-top` property on the Body element.\n\nFor LaTeX output, sets the top margin if `geometry` is not \nused (otherwise `geometry` overrides this value)\n\nFor ConTeXt output, sets the top margin if `layout` is not used, \notherwise `layout` overrides these.\n\nFor `wkhtmltopdf` sets the top page margin.\n"
},
{
"name": "margin-bottom",
"description": "For HTML output, sets the `margin-bottom` property on the Body element.\n\nFor LaTeX output, sets the bottom margin if `geometry` is not \nused (otherwise `geometry` overrides this value)\n\nFor ConTeXt output, sets the bottom margin if `layout` is not used, \notherwise `layout` overrides these.\n\nFor `wkhtmltopdf` sets the bottom page margin.\n"
},
{
"name": "geometry",
"description": "Options for the [geometry](https://ctan.org/pkg/geometry) package. For example:\n\n```yaml\ngeometry:\n - top=30mm\n - left=20mm\n - heightrounded\n```\n"
},
{
"name": "hyperrefoptions",
"description": "Options for the [hyperref](https://ctan.org/pkg/hyperref) package. For example:\n\n```yaml\nhyperrefoptions:\n - linktoc=all\n - pdfwindowui\n - pdfpagemode=FullScreen \n```\n\nTo customize link colors, please see the [Quarto PDF reference](https://quarto.org/docs/reference/formats/pdf.html#colors).\n"
},
{
"name": "indent",
"description": "Whether to use document class settings for indentation. If the document \nclass settings are not used, the default LaTeX template removes indentation \nand adds space between paragraphs\n\nFor groff (`ms`) documents, the paragraph indent, for example, `2m`.\n"
},
{
"name": "block-headings",
"description": "Make `\\paragraph` and `\\subparagraph` (fourth- and\nfifth-level headings, or fifth- and sixth-level with book\nclasses) free-standing rather than run-in; requires further\nformatting to distinguish from `\\subsubsection` (third- or\nfourth-level headings). Instead of using this option,\n[KOMA-Script](https://ctan.org/pkg/koma-script) can adjust headings \nmore extensively:\n\n```yaml\nheader-includes: |\n \\RedeclareSectionCommand[\n beforeskip=-10pt plus -2pt minus -1pt,\n afterskip=1sp plus -1sp minus 1sp,\n font=\\normalfont\\itshape]{paragraph}\n \\RedeclareSectionCommand[\n beforeskip=-10pt plus -2pt minus -1pt,\n afterskip=1sp plus -1sp minus 1sp,\n font=\\normalfont\\scshape,\n indent=0pt]{subparagraph}\n```\n"
}
]
},
{
"name": "code",
"title": "Code",
"options": [
{
"name": "code-line-numbers",
"description": "Include line numbers in code block output (`true` or `false`).\n\nFor revealjs output only, you can also specify a string to highlight\nspecific lines (and/or animate between sets of highlighted lines).\n\n* Sets of lines are denoted with commas:\n * `3,4,5`\n * `1,10,12`\n* Ranges can be denoted with dashes and combined with commas:\n * `1-3,5` \n * `5-10,12,14`\n* Finally, animation steps are separated by `|`:\n * `1-3|1-3,5` first shows `1-3`, then `1-3,5`\n * `|5|5-10,12` first shows no numbering, then 5, then lines 5-10\n and 12\n"
},
{
"name": "code-annotations",
"description": "The style to use when displaying code annotations. Set this value\nto false to hide code annotations.\n"
},
{
"name": "code-block-border-left",
"description": "Specifies to apply a left border on code blocks. Provide a hex color to specify that the border is\nenabled as well as the color of the border.\n"
},
{
"name": "code-block-bg",
"description": "Specifies to apply a background color on code blocks. Provide a hex color to specify that the background color is\nenabled as well as the color of the background.\n"
},
{
"name": "highlight-style",
"description": "Specifies the coloring style to be used in highlighted source code.\n\nInstead of a *STYLE* name, a JSON file with extension\n` .theme` may be supplied. This will be parsed as a KDE\nsyntax highlighting theme and (if valid) used as the\nhighlighting style.\n"
},
{
"name": "syntax-definitions",
"description": "KDE language syntax definition files (XML)"
},
{
"name": "listings",
"description": "Use the `listings` package for LaTeX code blocks. The package\ndoes not support multi-byte encoding for source code. To handle UTF-8\nyou would need to use a custom template. This issue is fully\ndocumented here: [Encoding issue with the listings package](https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue)\n"
},
{
"name": "indented-code-classes",
"description": "Specify classes to use for all indented code blocks"
}
]
},
{
"name": "execute",
"title": "Execution",
"description": "Execution options should be specified within the `execute` key. For example:\n\n```yaml\nexecute:\n echo: false\n warning: false\n```\n",
"options": [
{
"name": "eval",
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines \n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n"
},
{
"name": "echo",
"description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: in addition to echoing, include the cell delimiter as part of the output.\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n"
},
{
"name": "output",
"description": "Include the results of executing the code in the output. Possible values:\n\n- `true`: Include results.\n- `false`: Do not include results.\n- `asis`: Treat output as raw markdown with no enclosing containers.\n"
},
{
"name": "warning",
"description": "Include warnings in rendered output."
},
{
"name": "error",
"description": "Include errors in the output (note that this implies that errors executing code\nwill not halt processing of the document).\n"
},
{
"name": "include",
"description": "Catch all for preventing any output (code or results) from being included in output.\n"
},
{
"name": "cache",
"description": "Cache results of computations (using the [knitr cache](https://yihui.org/knitr/demo/cache/) \nfor R documents, and [Jupyter Cache](https://jupyter-cache.readthedocs.io/en/latest/) \nfor Jupyter documents).\n\nNote that cache invalidation is triggered by changes in chunk source code \n(or other cache attributes you've defined). \n\n- `true`: Cache results\n- `false`: Do not cache results\n- `refresh`: Force a refresh of the cache even if has not been otherwise invalidated.\n"
},
{
"name": "freeze",
"description": "Control the re-use of previous computational output when rendering.\n\n- `true`: Never recompute previously generated computational output during a global project render\n- `false` (default): Recompute previously generated computational output\n- `auto`: Re-compute previously generated computational output only in case their source file changes\n"
}
]
},
{
"name": "figures",
"title": "Figures",
"options": [
{
"name": "fig-align",
"description": "Figure horizontal alignment (`default`, `left`, `right`, or `center`)"
},
{
"name": "fig-env",
"description": "LaTeX environment for figure output"
},
{
"name": "fig-pos",
"description": "LaTeX figure position arrangement to be used in `\\begin{figure}[]`.\n\nComputational figure output that is accompanied by the code \nthat produced it is given a default value of `fig-pos=\"H\"` (so \nthat the code and figure are not inordinately separated).\n\nIf `fig-pos` is `false`, then we don't use any figure position\nspecifier, which is sometimes necessary with custom figure\nenvironments (such as `sidewaysfigure`).\n"
},
{
"name": "fig-cap-location",
"description": "Where to place figure captions (`top`, `bottom`, or `margin`)"
},
{
"name": "fig-width",
"description": "Default width for figures generated by Matplotlib or R graphics.\n\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with\ndocument or project metadata.\n"
},
{
"name": "fig-height",
"description": "Default height for figures generated by Matplotlib or R graphics.\n\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with\ndocument or project metadata.\n"
},
{
"name": "fig-format",
"description": "Default format for figures generated by Matplotlib or R graphics (`retina`, `png`, `jpeg`, `svg`, or `pdf`)"
},
{
"name": "fig-dpi",
"description": "Default DPI for figures generated by Matplotlib or R graphics.\n\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with\ndocument or project metadata.\n"
},
{
"name": "fig-asp",
"description": "The aspect ratio of the plot, i.e., the ratio of height/width. When `fig-asp` is specified,\nthe height of a plot (the option `fig-height`) is calculated from `fig-width * fig-asp`.\n\nThe `fig-asp` option is only available within the knitr engine.\n"
}
]
},
{
"name": "tables",
"title": "Tables",
"options": [
{
"name": "tbl-colwidths",
"description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n"
},
{
"name": "tbl-cap-location",
"description": "Where to place table captions (`top`, `bottom`, or `margin`)"
},
{
"name": "df-print",
"description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n"
}
]
},
{
"name": "references",
"title": "References",
"options": [
{
"name": "bibliography",
"description": "Document bibliography (BibTeX or CSL). May be a single file or a list of files\n"
},
{
"name": "csl",
"description": "Citation Style Language file to use for formatting references."
},
{
"name": "cite-method",
"description": "Method used to format citations (`citeproc`, `natbib`, or `biblatex`).\n"
},
{
"name": "citeproc",
"description": "Turn on built-in citation processing. To use this feature, you will need\nto have a document containing citations and a source of bibliographic data: \neither an external bibliography file or a list of `references` in the \ndocument's YAML metadata. You can optionally also include a `csl` \ncitation style file.\n"
},
{
"name": "biblatexoptions",
"description": "A list of options for BibLaTeX."
},
{
"name": "natbiboptions",
"description": "One or more options to provide for `natbib` when generating a bibliography."
},
{
"name": "biblio-style",
"description": "The bibliography style to use (e.g. `\\bibliographystyle{dinat}`) when using `natbib` or `biblatex`."
},
{
"name": "biblio-title",
"description": "The bibliography title to use when using `natbib` or `biblatex`."
},
{
"name": "biblio-config",
"description": "Controls whether to output bibliography configuration for `natbib` or `biblatex` when cite method is not `citeproc`."
},
{
"name": "citation-abbreviations",
"description": "JSON file containing abbreviations of journals that should be\nused in formatted bibliographies when `form=\"short\"` is\nspecified. The format of the file can be illustrated with an\nexample:\n\n```json\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n```\n"
},
{
"name": "link-citations",
"description": "If true, citations will be hyperlinked to the corresponding bibliography entries (for author-date and numerical styles only). Defaults to false."
},
{
"name": "link-bibliography",
"description": "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 \nthese 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.\n"
},
{
"name": "notes-after-punctuation",
"description": "If true (the default for note styles), Quarto (via Pandoc) will put footnote references or superscripted numerical citations after \nfollowing punctuation. For example, if the source contains blah blah [@jones99]., the result will look like blah blah.[^1], with \nthe note moved after the period and the space collapsed. \n\nIf false, the space will still be collapsed, but the footnote will not be moved after the punctuation. The option may also be used \nin numerical styles that use superscripts for citation numbers (but for these styles the default is not to move the citation).\n"
}
]
},
{
"name": "footnotes",
"title": "Footnotes",
"options": [
{
"name": "links-as-notes",
"description": "Causes links to be printed as footnotes."
}
]
},
{
"name": "crossref",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
{
"name": "citation",
"title": "Citation",
"options": [
{
"name": "citation",
"description": "Citation information for the document itself specified as [CSL](https://docs.citationstyles.org/en/stable/specification.html) \nYAML in the document front matter.\n\nFor more on supported options, see [Citation Metadata](https://quarto.org/docs/reference/metadata/citation.html).\n"
}
]
},
{
"name": "language",
"title": "Language",
"options": [
{
"name": "lang",
"description": "Identifies the main language of the document using IETF language tags \n(following the [BCP 47](https://www.rfc-editor.org/info/bcp47) standard), \nsuch as `en` or `en-GB`. The [Language subtag lookup](https://r12a.github.io/app-subtags/) \ntool can look up or verify these tags. \n\nThis affects most formats, and controls hyphenation \nin PDF output when using LaTeX (through [`babel`](https://ctan.org/pkg/babel) \nand [`polyglossia`](https://ctan.org/pkg/polyglossia)) or ConTeXt.\n"
},
{
"name": "language",
"description": "YAML file containing custom language translations"
},
{
"name": "dir",
"description": "The base script direction for the document (`rtl` or `ltr`).\n\nFor bidirectional documents, native pandoc `span`s and\n`div`s with the `dir` attribute can\nbe used to override the base direction in some output\nformats. This may not always be necessary if the final\nrenderer (e.g. the browser, when generating HTML) supports\nthe [Unicode Bidirectional Algorithm].\n\nWhen using LaTeX for bidirectional documents, only the\n`xelatex` engine is fully supported (use\n`--pdf-engine=xelatex`).\n"
}
]
},
{
"name": "includes",
"title": "Includes",
"options": [
{
"name": "include-before-body",
"description": "Include contents at the beginning of the document body\n(e.g. after the `<body>` tag in HTML, or the `\\begin{document}` command\nin LaTeX).\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n"
},
{
"name": "include-after-body",
"description": "Include content at the end of the document body immediately after the markdown content. While it will be included before the closing `</body>` tag in HTML and the `\\end{document}` command in LaTeX, this option refers to the end of the markdown content.\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n"
},
{
"name": "include-in-header",
"description": "Include contents at the end of the header. This can\nbe used, for example, to include special CSS or JavaScript in HTML\ndocuments.\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n"
},
{
"name": "metadata-files",
"description": "Read metadata from the supplied YAML (or JSON) files. This\noption can be used with every input format, but string scalars\nin the YAML file will always be parsed as Markdown. Generally,\nthe input will be handled the same as in YAML metadata blocks.\nValues in files specified later in the list will be preferred\nover those specified earlier. Metadata values specified inside\nthe document, or by using `-M`, overwrite values specified with\nthis option.\n"
}
]
},
{
"name": "metadata",
"title": "Metadata",
"options": [
{
"name": "keywords",
"description": "List of keywords to be included in the document metadata."
},
{
"name": "subject",
"description": "The document subject"
},
{
"name": "title-meta",
"description": "Sets the title metadata for the document"
},
{
"name": "author-meta",
"description": "Sets the author metadata for the document"
},
{
"name": "date-meta",
"description": "Sets the date metadata for the document"
}
]
},
{
"name": "render",
"title": "Rendering",
"options": [
{
"name": "from",
"description": "Format to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n"
},
{
"name": "output-file",
"description": "Output file to write to"
},
{
"name": "output-ext",
"description": "Extension to use for generated output file\n"
},
{
"name": "template",
"description": "Use the specified file as a custom template for the generated document.\n"
},
{
"name": "template-partials",
"description": "Include the specified files as partials accessible to the template for the generated content.\n"
},
{
"name": "standalone",
"description": "Produce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n"
},
{
"name": "filters",
"description": "Specify executables or Lua scripts to be used as a filter transforming\nthe pandoc AST after the input is parsed and before the output is written.\n"
},
{
"name": "shortcodes",
"description": "Specify Lua scripts that implement shortcode handlers\n"
},
{
"name": "keep-md",
"description": "Keep the markdown file generated by executing code"
},
{
"name": "keep-ipynb",
"description": "Keep the notebook file generated from executing code."
},
{
"name": "ipynb-filters",
"description": "Filters to pre-process ipynb files before rendering to markdown"
},
{
"name": "ipynb-shell-interactivity",
"description": "Specify which nodes should be run interactively (displaying output from expressions)\n"
},
{
"name": "keep-tex",
"description": "Keep the intermediate tex file used during render."
},
{
"name": "extract-media",
"description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n"
},
{
"name": "resource-path",
"description": "List of paths to search for images and other resources.\n"
},
{
"name": "default-image-extension",
"description": "Specify a default extension to use when image paths/URLs have no\nextension. This allows you to use the same source for formats that\nrequire different kinds of images. Currently this option only affects\nthe Markdown and LaTeX readers.\n"
},
{
"name": "abbreviations",
"description": "Specifies a custom abbreviations file, with abbreviations one to a line.\nThis list is used when reading Markdown input: strings found in this list\nwill be followed by a nonbreaking space, and the period will not produce sentence-ending space in formats like LaTeX. The strings may not contain\nspaces.\n"
},
{
"name": "dpi",
"description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n"
},
{
"name": "html-table-processing",
"description": "If `none`, do not process tables in HTML input."
}
]
},
{
"name": "latexmk",
"title": "Latexmk",
"options": [
{
"name": "latex-auto-mk",
"description": "Use Quarto's built-in PDF rendering wrapper (includes support \nfor automatically installing missing LaTeX packages)\n"
},
{
"name": "latex-auto-install",
"description": "Enable/disable automatic LaTeX package installation"
},
{
"name": "latex-min-runs",
"description": "Minimum number of compilation passes."
},
{
"name": "latex-max-runs",
"description": "Maximum number of compilation passes."
},
{
"name": "latex-clean",
"description": "Clean intermediates after compilation."
},
{
"name": "latex-makeindex",
"description": "Program to use for `makeindex`."
},
{
"name": "latex-makeindex-opts",
"description": "Array of command line options for `makeindex`."
},
{
"name": "latex-tlmgr-opts",
"description": "Array of command line options for `tlmgr`."
},
{
"name": "latex-output-dir",
"description": "Output directory for intermediates and PDF."
},
{
"name": "latex-tinytex",
"description": "Set to `false` to prevent an installation of TinyTex from being used to compile PDF documents."
},
{
"name": "latex-input-paths",
"description": "Array of paths LaTeX should search for inputs."
}
]
},
{
"name": "text",
"title": "Text Output",
"options": [
{
"name": "ascii",
"description": "Use only ASCII characters in output. Currently supported for XML\nand HTML formats (which use entities instead of UTF-8 when this\noption is selected), CommonMark, gfm, and Markdown (which use\nentities), roff ms (which use hexadecimal escapes), and to a\nlimited degree LaTeX (which uses standard commands for accented\ncharacters when possible). roff man output uses ASCII by default.\n"
}
]
}
]