CoCalc -- document-includes.yml

GitHub Repository: quarto-dev/quarto-cli
Path: blob/main/src/resources/schema/document-includes.yml
¹²⁹²⁵ views
1
- name: header-includes
2
  disabled: [$office-all, $jats-all, ipynb]
3
  hidden: true
4
  schema:
5
    maybeArrayOf: string
6
  description: Content to include at the end of the document header.
7

8
- name: include-before
9
  disabled: [$office-all, $jats-all, ipynb]
10
  hidden: true
11
  schema:
12
    maybeArrayOf: string
13
  description: Content to include at the beginning of the document body (e.g. after the `<body>` tag in HTML, or the `\begin{document}` command in LaTeX).
14

15
- name: include-after
16
  disabled: [$office-all, $jats-all, ipynb]
17
  hidden: true
18
  schema:
19
    maybeArrayOf: string
20
  description: Content to include at the end of the document body (before the `</body>` tag in HTML, or the `\end{document}` command in LaTeX).
21

22
- name: include-before-body
23
  disabled: [$office-all, $jats-all, ipynb]
24
  schema:
25
    maybeArrayOf:
26
      anyOf:
27
        - path
28
        - ref: smart-include
29
  description: |
30
    Include contents at the beginning of the document body
31
    (e.g. after the `<body>` tag in HTML, or the `\begin{document}` command
32
    in LaTeX).
33

34
    A string value or an object with key "file" indicates a filename whose contents are to be included
35

36
    An object with key "text" indicates textual content to be included
37

38
- name: include-after-body
39
  disabled: [$office-all, $jats-all, ipynb]
40
  schema:
41
    maybeArrayOf:
42
      anyOf:
43
        - path
44
        - ref: smart-include
45
  description: |
46
    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.
47

48
    A string value or an object with key "file" indicates a filename whose contents are to be included
49

50
    An object with key "text" indicates textual content to be included
51

52
- name: include-in-header
53
  disabled: [$office-all, $jats-all, ipynb]
54
  schema:
55
    maybeArrayOf:
56
      anyOf:
57
        - path
58
        - ref: smart-include
59
  description: |
60
    Include contents at the end of the header. This can
61
    be used, for example, to include special CSS or JavaScript in HTML
62
    documents.
63

64
    A string value or an object with key "file" indicates a filename whose contents are to be included
65

66
    An object with key "text" indicates textual content to be included
67

68
- name: resources
69
  schema:
70
    maybeArrayOf: string
71
  tags:
72
    formats: [$html-all]
73
  description: Path (or glob) to files to publish with this document.
74

75
- name: headertext
76
  schema:
77
    maybeArrayOf: string
78
  tags:
79
    formats: [context]
80
  description:
81
    short: Text to be in a running header.
82
    long: |
83
      Text to be in a running header.
84

85
      Provide a single option or up to four options for different placements
86
      (odd page inner, odd page outer, even page innner, even page outer).
87

88
- name: footertext
89
  schema:
90
    maybeArrayOf: string
91
  tags:
92
    formats: [context]
93
  description:
94
    short: Text to be in a running footer.
95
    long: |
96
      Text to be in a running footer.
97

98
      Provide a single option or up to four options for different placements
99
      (odd page inner, odd page outer, even page innner, even page outer).
100

101
      See [ConTeXt Headers and Footers](https://wiki.contextgarden.net/Headers_and_Footers) for more information.
102

103
- name: includesource
104
  schema: boolean
105
  tags:
106
    formats: [context]
107
  default: false
108
  description: Whether to include all source documents as file attachments in the PDF file.
109

110
- name: footer
111
  schema: string
112
  tags:
113
    formats: [man]
114
  description: The footer for man pages.
115

116
- name: header
117
  schema: string
118
  tags:
119
    formats: [man]
120
  description: The header for man pages.
121

122
- name: metadata-file
123
  schema: path
124
  hidden: true
125
  description:
126
    short: "Include file with YAML metadata"
127
    long: |
128
      Read metadata from the supplied YAML (or JSON) file. This
129
      option can be used with every input format, but string scalars
130
      in the YAML file will always be parsed as Markdown. Generally,
131
      the input will be handled the same as in YAML metadata blocks.
132
      Metadata values specified inside the document, or by using `-M`,
133
      overwrite values specified with this option.
134

135
- name: metadata-files
136
  schema:
137
    arrayOf: path
138
  description:
139
    short: "Include files with YAML metadata"
140
    long: |
141
      Read metadata from the supplied YAML (or JSON) files. This
142
      option can be used with every input format, but string scalars
143
      in the YAML file will always be parsed as Markdown. Generally,
144
      the input will be handled the same as in YAML metadata blocks.
145
      Values in files specified later in the list will be preferred
146
      over those specified earlier. Metadata values specified inside
147
      the document, or by using `-M`, overwrite values specified with
148
      this option.
149

150
Product

Resources

Company
