CoCalc -- document-numbering.yml

GitHub Repository: quarto-dev/quarto-cli
Path: blob/main/src/resources/schema/document-numbering.yml
¹²⁹²¹ views
1
- name: number-sections
2
  schema: boolean
3
  default: false
4
  description:
5
    short: "Number section headings"
6
    long: |
7
      Number section headings rendered output. By default, sections are not numbered.
8
      Sections with class `.unnumbered` will never be numbered, even if `number-sections`
9
      is specified.
10

11
- name: number-depth
12
  schema: number
13
  tags:
14
    formats: [$html-all, $pdf-all, docx]
15
  description:
16
    short: The depth to which sections should be numbered.
17
    long: |
18
      By default, all headings in your document create a 
19
      numbered section. You customize numbering depth using 
20
      the `number-depth` option. 
21

22
      For example, to only number sections immediately below 
23
      the chapter level, use this:
24

25
      ```yaml  
26
      number-depth: 1
27
      ```
28

29
- name: secnumdepth
30
  schema: number
31
  hidden: true
32
  tags:
33
    formats: [$pdf-all]
34
  description: The numbering depth for sections. (Use `number-depth` instead).
35

36
- name: number-offset
37
  tags:
38
    formats: [$html-all]
39
  schema:
40
    maybeArrayOf: number
41
  default: [0, 0, 0, 0, 0, 0]
42
  description:
43
    short: Offset for section headings in output (offsets are 0 by default)
44
    long: |
45
      Offset for section headings in output (offsets are 0 by default)
46
      The first number is added to the section number for
47
      top-level headings, the second for second-level headings, and so on.
48
      So, for example, if you want the first top-level heading in your
49
      document to be numbered "6", specify `number-offset: 5`. If your
50
      document starts with a level-2 heading which you want to be numbered
51
      "1.5", specify `number-offset: [1,4]`. Implies `number-sections`
52

53
- name: section-numbering
54
  tags:
55
    formats: [typst]
56
  schema: string
57
  description: "Schema to use for numbering sections, e.g. `1.A.1`"
58

59
- name: shift-heading-level-by
60
  schema: number
61
  description:
62
    short: |
63
      Shift heading levels by a positive or negative integer. For example, with 
64
      `shift-heading-level-by: -1`, level 2 headings become level 1 headings.
65
    long: |
66
      Shift heading levels by a positive or negative integer.
67
      For example, with `shift-heading-level-by: -1`, level 2
68
      headings become level 1 headings, and level 3 headings
69
      become level 2 headings.  Headings cannot have a level
70
      less than 1, so a heading that would be shifted below level 1
71
      becomes a regular paragraph.  Exception: with a shift of -N,
72
      a level-N heading at the beginning of the document
73
      replaces the metadata title.
74

75
- name: page-numbering
76
  schema: 
77
    anyOf:
78
      - boolean
79
      - string
80
  tags:
81
    formats: [typst]
82
  description:
83
    short: |
84
      Schema to use for numbering pages, e.g. `1` or `i`, or `false` to omit page numbering.
85
    long: |
86
      Schema to use for numbering pages, e.g. `1` or `i`, or `false` to omit page numbering.
87

88
      See [Typst Numbering](https://typst.app/docs/reference/model/numbering/) 
89
      for additional information.
90

91
- name: pagenumbering
92
  schema:
93
    maybeArrayOf: string
94
  tags:
95
    formats: [context]
96
  description:
97
    short: Sets the page numbering style and location for the document.
98
    long: |
99
      Sets the page numbering style and location for the document using the
100
      `\setuppagenumbering` command. 
101

102
      See [ConTeXt Page Numbering](https://wiki.contextgarden.net/Command/setuppagenumbering) 
103
      for additional information.
104

105
- name: top-level-division
106
  tags:
107
    formats: [$pdf-all, context, $docbook-all, tei]
108
  schema:
109
    enum: [default, section, chapter, part]
110
  description:
111
    short: |
112
      Treat top-level headings as the given division type (`default`, `section`, `chapter`, or `part`). The hierarchy
113
      order is part, chapter, then section; all headings are shifted such 
114
      that the top-level heading becomes the specified type.
115
    long: |
116
      Treat top-level headings as the given division type (`default`, `section`, `chapter`, or `part`). The hierarchy
117
      order is part, chapter, then section; all headings are shifted such 
118
      that the top-level heading becomes the specified type.  
119

120
      The default behavior is to determine the
121
      best division type via heuristics: unless other conditions
122
      apply, `section` is chosen. When the `documentclass`
123
      variable is set to `report`, `book`, or `memoir` (unless the
124
      `article` option is specified), `chapter` is implied as the
125
      setting for this option. If `beamer` is the output format,
126
      specifying either `chapter` or `part` will cause top-level
127
      headings to become `\part{..}`, while second-level headings
128
      remain as their default type.
129

130
Product

Resources

Company
