asciidoctor-pdf 1.5.0.alpha.18 → 1.5.0.beta.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.adoc +45 -0
- data/NOTICE.adoc +14 -11
- data/README.adoc +76 -25
- data/asciidoctor-pdf.gemspec +2 -0
- data/data/themes/base-theme.yml +4 -0
- data/data/themes/default-theme.yml +17 -34
- data/data/themes/default-with-fallback-font-theme.yml +22 -0
- data/docs/theming-guide.adoc +957 -892
- data/lib/asciidoctor-pdf/asciidoctor_ext/image.rb +4 -4
- data/lib/asciidoctor-pdf/converter.rb +483 -357
- data/lib/asciidoctor-pdf/core_ext.rb +1 -0
- data/lib/asciidoctor-pdf/core_ext/hash.rb +5 -0
- data/lib/asciidoctor-pdf/formatted_text.rb +1 -0
- data/lib/asciidoctor-pdf/formatted_text/inline_image_arranger.rb +3 -1
- data/lib/asciidoctor-pdf/formatted_text/parser.rb +24 -12
- data/lib/asciidoctor-pdf/formatted_text/parser.treetop +1 -1
- data/lib/asciidoctor-pdf/formatted_text/text_background_and_border_renderer.rb +45 -0
- data/lib/asciidoctor-pdf/formatted_text/transform.rb +44 -21
- data/lib/asciidoctor-pdf/prawn_ext/extensions.rb +9 -11
- data/lib/asciidoctor-pdf/prawn_ext/images.rb +18 -7
- data/lib/asciidoctor-pdf/theme_loader.rb +94 -76
- data/lib/asciidoctor-pdf/version.rb +1 -1
- metadata +26 -3
@@ -0,0 +1,22 @@
|
|
1
|
+
extends: default
|
2
|
+
font:
|
3
|
+
catalog:
|
4
|
+
Noto Serif:
|
5
|
+
normal: notoserif-regular-subset.ttf
|
6
|
+
bold: notoserif-bold-subset.ttf
|
7
|
+
italic: notoserif-italic-subset.ttf
|
8
|
+
bold_italic: notoserif-bold_italic-subset.ttf
|
9
|
+
M+ 1mn:
|
10
|
+
normal: mplus1mn-regular-ascii-conums.ttf
|
11
|
+
bold: mplus1mn-bold-ascii.ttf
|
12
|
+
italic: mplus1mn-italic-ascii.ttf
|
13
|
+
bold_italic: mplus1mn-bold_italic-ascii.ttf
|
14
|
+
# M+ 1p supports Latin, Latin-1 Supplement, Latin Extended, Greek, Cyrillic, Vietnamese, Japanese & an assortment of symbols
|
15
|
+
# It also provides arrows for ->, <-, => and <= replacements in case these glyphs are missing from font
|
16
|
+
M+ 1p Fallback:
|
17
|
+
normal: mplus1p-regular-fallback.ttf
|
18
|
+
bold: mplus1p-regular-fallback.ttf
|
19
|
+
italic: mplus1p-regular-fallback.ttf
|
20
|
+
bold_italic: mplus1p-regular-fallback.ttf
|
21
|
+
fallbacks:
|
22
|
+
- M+ 1p Fallback
|
data/docs/theming-guide.adoc
CHANGED
@@ -44,26 +44,28 @@ toc::[]
|
|
44
44
|
|
45
45
|
== Language Overview
|
46
46
|
|
47
|
-
The theme language
|
48
|
-
Therefore, if you have a background in web design, the
|
47
|
+
The Asciidoctor PDF theme language is described using the http://en.wikipedia.org/wiki/YAML[YAML] data format and incorporates many _concepts_ from CSS and SASS.
|
48
|
+
Therefore, if you have a background in web design, the terminology should be immediately familiar to you.
|
49
|
+
*Note, however, that the theming system isn't actually CSS.*
|
49
50
|
|
50
51
|
Like CSS, themes have both selectors and properties.
|
51
52
|
Selectors are the component you want to style.
|
52
53
|
The properties are the style elements of that component that can be styled.
|
53
|
-
All selector names are implicit (e.g., `heading`), so you customize the theme primarily by manipulating pre-defined property values (e.g., `
|
54
|
+
All selector names are implicit (e.g., `heading`), so you customize the theme primarily by manipulating pre-defined property values (e.g., `font-size`).
|
54
55
|
|
55
56
|
[NOTE]
|
56
57
|
====
|
57
58
|
The theme language in Asciidoctor PDF supports a limited subset of the properties from CSS.
|
58
59
|
Some of these properties have different names from those found in CSS.
|
59
60
|
|
60
|
-
*
|
61
|
-
*
|
62
|
-
*
|
63
|
-
* The `
|
61
|
+
* An underscore (`_`) may be used in place of a hyphen (`-`) in all property names (so you may use `font_family` or `font-family`).
|
62
|
+
* An underscore (`_`) may be used in place of a hyphen (`-`) in all variable names (so you may use `$base_font_family` or `$base-font-family`).
|
63
|
+
* Instead of separate properties for font weight and font style, the theme language combines these settings in the `font-style` property (allowed values: `normal`, `bold`, `italic` and `bold_italic`).
|
64
|
+
* The `align` property in the theme language is roughly equivalent to the `text-align` property in CSS.
|
65
|
+
* The `font-color` property in the theme language is equivalent to the `color` property in CSS.
|
64
66
|
====
|
65
67
|
|
66
|
-
A theme
|
68
|
+
A theme is described in a YAML-based data format and stored in a dedicated theme file.
|
67
69
|
YAML is a human-friendly data format that resembles CSS and helps to describe the theme.
|
68
70
|
The theme language adds some extra features to YAML, such as variables, basic math, measurements and color values.
|
69
71
|
These enhancements will be explained in detail in later sections.
|
@@ -80,31 +82,31 @@ page:
|
|
80
82
|
margin: [0.75in, 1in, 0.75in, 1in]
|
81
83
|
size: Letter
|
82
84
|
base:
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
85
|
+
font-color: #333333
|
86
|
+
font-family: Times-Roman
|
87
|
+
font-size: 12
|
88
|
+
line-height-length: 17
|
89
|
+
line-height: $base-line-height-length / $base-font-size
|
90
|
+
vertical-spacing: $base-line-height-length
|
89
91
|
heading:
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
92
|
+
font-color: #262626
|
93
|
+
font-size: 17
|
94
|
+
font-style: bold
|
95
|
+
line-height: 1.2
|
96
|
+
margin-bottom: $vertical-spacing
|
95
97
|
link:
|
96
|
-
|
97
|
-
|
98
|
-
indent: $
|
98
|
+
font-color: #002FA7
|
99
|
+
outline-list:
|
100
|
+
indent: $base-font-size * 1.5
|
99
101
|
footer:
|
100
|
-
height: $
|
101
|
-
|
102
|
+
height: $base-line-height-length * 2.5
|
103
|
+
line-height: 1
|
102
104
|
recto:
|
103
105
|
right:
|
104
106
|
content: '{page-number}'
|
105
107
|
verso:
|
106
108
|
left:
|
107
|
-
content: $
|
109
|
+
content: $footer-recto-right-content
|
108
110
|
----
|
109
111
|
|
110
112
|
When creating a new theme, you only have to define the keys you want to override from the base theme, which is loaded prior to loading your custom theme.
|
@@ -117,7 +119,7 @@ Instead of writing a theme from scratch, you can extend the default theme using
|
|
117
119
|
----
|
118
120
|
extends: default
|
119
121
|
base:
|
120
|
-
color: #ff0000
|
122
|
+
font-color: #ff0000
|
121
123
|
----
|
122
124
|
|
123
125
|
You can also point the extends key at another custom theme to extend from it.
|
@@ -142,27 +144,27 @@ Once the theme is loaded, all keys are flattened into a single map of qualified
|
|
142
144
|
Nesting is simply a shorthand way of organizing the keys.
|
143
145
|
In the end, a theme is just a map of key/value pairs.
|
144
146
|
|
145
|
-
Nested keys are adjoined to their parent key with an underscore (`_`).
|
146
|
-
This means the selector part (e.g., `link`) is combined with the property name (e.g., `
|
147
|
+
Nested keys are adjoined to their parent key with an underscore (`_`) or hyphen (`-`).
|
148
|
+
This means the selector part (e.g., `link`) is combined with the property name (e.g., `font-color`) into a single, qualified key (e.g., `link_font_color` or `link-font-color`).
|
147
149
|
|
148
150
|
For example, let's assume we want to set the base (i.e., global) font size and color.
|
149
151
|
These keys may be written longhand:
|
150
152
|
|
151
153
|
[source,yaml]
|
152
154
|
----
|
153
|
-
|
154
|
-
|
155
|
-
|
155
|
+
base-font-color: #333333
|
156
|
+
base-font-family: Times-Roman
|
157
|
+
base-font-size: 12
|
156
158
|
----
|
157
159
|
|
158
|
-
Or, to avoid having to type the prefix `
|
160
|
+
Or, to avoid having to type the prefix `base-` multiple times, the keys may be written as a hierarchy:
|
159
161
|
|
160
162
|
[source,yaml]
|
161
163
|
----
|
162
164
|
base:
|
163
|
-
|
164
|
-
|
165
|
-
|
165
|
+
font-color: #333333
|
166
|
+
font-family: Times-Roman
|
167
|
+
font-size: 12
|
166
168
|
----
|
167
169
|
|
168
170
|
Or even:
|
@@ -176,8 +178,8 @@ base:
|
|
176
178
|
size: 12
|
177
179
|
----
|
178
180
|
|
179
|
-
Each level of nesting must be indented by two
|
180
|
-
Also note the presence of the colon after each key name.
|
181
|
+
Each level of nesting must be indented by two spaces from the indentation of the parent level.
|
182
|
+
Also note the presence of the colon (`:`) after each key name.
|
181
183
|
|
182
184
|
== Values
|
183
185
|
|
@@ -187,7 +189,7 @@ The value of a key may be one of the following types:
|
|
187
189
|
- Font family name (e.g., Roboto)
|
188
190
|
- Font style (normal, bold, italic, bold_italic)
|
189
191
|
- Alignment (left, center, right, justify)
|
190
|
-
- Color as hex string (e.g., #
|
192
|
+
- Color as hex string (e.g., 'ff0000', #ff0000, or '#ff0000')
|
191
193
|
- Image path
|
192
194
|
- Enumerated type (where specified)
|
193
195
|
- Text content (where specified)
|
@@ -201,7 +203,7 @@ The value of a key may be one of the following types:
|
|
201
203
|
- Color CMYK array (e.g., [50, 100, 0, 0])
|
202
204
|
- Margin (e.g., [1in, 1in, 1in, 1in])
|
203
205
|
- Padding (e.g., [1in, 1in, 1in, 1in])
|
204
|
-
* Variable reference (e.g., $base_font_color)
|
206
|
+
* Variable reference (e.g., $base_font_color or $base-font-color)
|
205
207
|
* Math expression
|
206
208
|
|
207
209
|
Note that keys almost always require a value of a specific type, as documented in <<Keys>>.
|
@@ -214,24 +216,24 @@ This behavior saves you from having to specify properties unless you want to ove
|
|
214
216
|
|
215
217
|
The following keys are inherited:
|
216
218
|
|
217
|
-
*
|
218
|
-
*
|
219
|
-
*
|
220
|
-
*
|
221
|
-
*
|
222
|
-
*
|
223
|
-
*
|
219
|
+
* font-family
|
220
|
+
* font-color
|
221
|
+
* font-size
|
222
|
+
* font-style
|
223
|
+
* text-transform
|
224
|
+
* line-height (currently some exceptions)
|
225
|
+
* margin-bottom (if not specified, defaults to $vertical-spacing)
|
224
226
|
|
225
227
|
.Heading Inheritance
|
226
228
|
****
|
227
|
-
Headings inherit starting from a specific heading level (e.g., `
|
229
|
+
Headings inherit starting from a specific heading level (e.g., `heading-h2-font-size`), then to the heading category (e.g., `heading-font-size`), then directly to the base value (e.g., `base-font-size`).
|
228
230
|
Any setting from an enclosing context, such as a sidebar, is skipped.
|
229
231
|
****
|
230
232
|
|
231
233
|
=== Variables
|
232
234
|
|
233
235
|
To save you from having to type the same value in your theme over and over, or to allow you to base one value on another, the theme language supports variables.
|
234
|
-
Variables consist of the key name preceded by a dollar sign (`$`) (e.g., `$
|
236
|
+
Variables consist of the key name preceded by a dollar sign (`$`) (e.g., `$base-font-size`).
|
235
237
|
Any qualified key that has already been defined can be referenced in the value of another key.
|
236
238
|
(In order words, as soon as the key is assigned, it's available to be used as a variable).
|
237
239
|
|
@@ -244,21 +246,21 @@ For example, once the following line is processed,
|
|
244
246
|
[source,yaml]
|
245
247
|
----
|
246
248
|
base:
|
247
|
-
|
249
|
+
font-color: #333333
|
248
250
|
----
|
249
251
|
|
250
|
-
the variable `$
|
252
|
+
the variable `$base-font-color` will be available for use in subsequent lines and will resolve to `#333333`.
|
251
253
|
|
252
254
|
Let's say you want to make the font color of the sidebar title the same as the heading font color.
|
253
|
-
Just assign the value `$
|
255
|
+
Just assign the value `$heading-font-color` to the `$sidebar-title-font-color`.
|
254
256
|
|
255
257
|
[source,yaml]
|
256
258
|
----
|
257
259
|
heading:
|
258
|
-
|
260
|
+
font-color: #191919
|
259
261
|
sidebar:
|
260
262
|
title:
|
261
|
-
|
263
|
+
font-color: $heading-font-color
|
262
264
|
----
|
263
265
|
|
264
266
|
You can also use variables in math expressions to use one value to build another.
|
@@ -268,9 +270,9 @@ It also makes it easy to test different values very quickly.
|
|
268
270
|
[source,yaml]
|
269
271
|
----
|
270
272
|
base:
|
271
|
-
|
272
|
-
|
273
|
-
|
273
|
+
font-size: 12
|
274
|
+
font-size-large: $base-font-size * 1.25
|
275
|
+
font-size-small: $base-font-size * 0.85
|
274
276
|
----
|
275
277
|
|
276
278
|
We'll cover more about math expressions later.
|
@@ -286,22 +288,22 @@ For instance, here's how you can define your brand colors:
|
|
286
288
|
[source,yaml,subs=attributes+]
|
287
289
|
----
|
288
290
|
brand:
|
289
|
-
primary: #E0162B {conum-guard-yaml} <1>
|
290
|
-
secondary: '#FFFFFF' {conum-guard-yaml} <2>
|
291
|
-
alert: '0052A5' {conum-guard-yaml} <3>
|
291
|
+
primary-color: #E0162B {conum-guard-yaml} <1>
|
292
|
+
secondary-color: '#FFFFFF' {conum-guard-yaml} <2>
|
293
|
+
alert-color: '0052A5' {conum-guard-yaml} <3>
|
292
294
|
----
|
293
|
-
<1> To align with CSS, you may add
|
294
|
-
A YAML preprocessor is used to ensure the value is not treated as a comment as
|
295
|
+
<1> To align with CSS, you may add `+#+` in front of the hex color value to coerce it to a string.
|
296
|
+
A YAML preprocessor is used to ensure the value is not treated as a comment as would normally be the case in YAML.
|
295
297
|
<2> You may put quotes around the CSS-style hex value to make it friendly to a YAML editor or validation tool.
|
296
298
|
<3> The leading `+#+` on a hex value is entirely optional.
|
297
|
-
However, we recommend that you always use either a leading `+#+` or surrounding quotes (or both) to prevent YAML from mangling the value.
|
299
|
+
However, we recommend that you always use either a leading `+#+` or surrounding quotes (or both) to prevent YAML from mangling the value (for example, 000000 would become 0, so use '000000' or #000000 instead).
|
298
300
|
|
299
301
|
You can now use these custom variables later in the theme file:
|
300
302
|
|
301
303
|
[source,yaml]
|
302
304
|
----
|
303
305
|
base:
|
304
|
-
|
306
|
+
font-color: $brand-primary-color
|
305
307
|
----
|
306
308
|
|
307
309
|
=== Math Expressions & Functions
|
@@ -335,7 +337,7 @@ Here's an example of a math expression with fixed values.
|
|
335
337
|
[source,yaml]
|
336
338
|
----
|
337
339
|
conum:
|
338
|
-
|
340
|
+
line-height: 4 / 3
|
339
341
|
----
|
340
342
|
|
341
343
|
Variables may be used in place of numbers anywhere in the expression:
|
@@ -343,8 +345,8 @@ Variables may be used in place of numbers anywhere in the expression:
|
|
343
345
|
[source,yaml]
|
344
346
|
----
|
345
347
|
base:
|
346
|
-
|
347
|
-
|
348
|
+
font-size: 12
|
349
|
+
font-size-large: $base-font-size * 1.25
|
348
350
|
----
|
349
351
|
|
350
352
|
Values used in a math expression are automatically coerced to a float value before the operation.
|
@@ -364,8 +366,8 @@ You might use these functions in font size calculations so that you get more exa
|
|
364
366
|
[source,yaml]
|
365
367
|
----
|
366
368
|
base:
|
367
|
-
|
368
|
-
|
369
|
+
font-size: 12.5
|
370
|
+
font-size-large: ceil($base-font-size * 1.25)
|
369
371
|
----
|
370
372
|
|
371
373
|
=== Measurement Units
|
@@ -403,9 +405,6 @@ The following units are supported:
|
|
403
405
|
Viewport-relative percentages (vw or vh units) are calculated as a percentage of the page width or height, respectively.
|
404
406
|
Currently, percentage units can only be used for placing elements on the title page or for setting the width of a block image.
|
405
407
|
|
406
|
-
IMPORTANT: Numbers with more than two digits should be written as a float (e.g., 100.0), a math expression (e.g, 1 * 100), or with a unit (e.g., 100pt).
|
407
|
-
Otherwise, the value may be misinterpreted as a hex color (e.g., '100') and could cause the converter to crash.
|
408
|
-
|
409
408
|
Here's an example of how you can use inches to define the page margins:
|
410
409
|
|
411
410
|
[source,yaml]
|
@@ -482,7 +481,7 @@ or
|
|
482
481
|
|
483
482
|
The theme language supports color values in three formats:
|
484
483
|
|
485
|
-
Hex:: A string of 3 or 6 characters with an optional leading `#`, optional surrounding quotes or both.
|
484
|
+
Hex:: A string of 3 or 6 characters with an optional leading `#`, optional surrounding quotes, or both.
|
486
485
|
RGB:: An array of numeric values ranging from 0 to 255.
|
487
486
|
CMYK:: An array of numeric values ranging from 0 to 1 or from 0% to 100%.
|
488
487
|
Transparent:: The special value `transparent` indicates that a color should not be used.
|
@@ -490,10 +489,12 @@ Transparent:: The special value `transparent` indicates that a color should not
|
|
490
489
|
==== Hex
|
491
490
|
|
492
491
|
The hex color value is likely most familiar to web developers.
|
493
|
-
The value must be either 3 or 6 characters (case insensitive) with an optional leading hash (`#`), optional surrounding quotes or both.
|
492
|
+
The value must be either 3 or 6 characters (case insensitive) with an optional leading hash (`#`), optional surrounding quotes, or both.
|
494
493
|
|
495
494
|
To align with CSS, you may add a `+#+` in front of the hex color value.
|
496
|
-
A YAML preprocessor is used to ensure the value is not treated as a comment as
|
495
|
+
A YAML preprocessor is used to ensure the value is not treated as a comment as would normally be the case in YAML.
|
496
|
+
That same preprocessor will also coerce a primitive value to a string if `color` is the name of the last segment in the key (e.g., `font-color`).
|
497
|
+
This avoids the problem of 000 becoming 0 (and similar implicit conversions) when the theme file is parsed.
|
497
498
|
|
498
499
|
You also may put quotes around the CSS-style hex value to make it friendly to a YAML editor or validation tool.
|
499
500
|
In this case, the leading `+#+` on a hex value is entirely optional.
|
@@ -519,7 +520,7 @@ Here's how a hex color value appears in the theme file:
|
|
519
520
|
[source,yaml]
|
520
521
|
----
|
521
522
|
base:
|
522
|
-
|
523
|
+
font-color: #ff0000
|
523
524
|
----
|
524
525
|
|
525
526
|
==== RGB
|
@@ -538,7 +539,7 @@ Here's how a RGB color value appears in the theme file:
|
|
538
539
|
[source,yaml]
|
539
540
|
----
|
540
541
|
base:
|
541
|
-
|
542
|
+
font-color: [255, 0, 0]
|
542
543
|
----
|
543
544
|
|
544
545
|
==== CMYK
|
@@ -559,7 +560,7 @@ Here's how a CMYK color value appears in the theme file:
|
|
559
560
|
[source,yaml]
|
560
561
|
----
|
561
562
|
base:
|
562
|
-
|
563
|
+
font-color: [0, 0.99, 1, 0]
|
563
564
|
----
|
564
565
|
|
565
566
|
==== Transparent
|
@@ -569,13 +570,14 @@ It's possible to specify no color by assigning the special value `transparent`,
|
|
569
570
|
[source,yaml]
|
570
571
|
----
|
571
572
|
base:
|
572
|
-
|
573
|
+
background-color: transparent
|
573
574
|
----
|
574
575
|
|
575
576
|
=== Images
|
576
577
|
|
577
578
|
An image is specified either as a bare image path or as an inline image macro as found in the AsciiDoc syntax.
|
578
|
-
Images are currently resolved relative to the value of the `pdf-
|
579
|
+
Images in the theme file are currently resolved relative to the value of the `pdf-themesdir` attribute.
|
580
|
+
(If `pdf-theme` is a path that ends in `.yml`, and `pdf-themesdir` is not set, then the images are resolved relative to the directory of the path specified by `pdf-theme`).
|
579
581
|
|
580
582
|
The following image types (and corresponding file extensions) are supported:
|
581
583
|
|
@@ -583,35 +585,34 @@ The following image types (and corresponding file extensions) are supported:
|
|
583
585
|
* JPEG (.jpg)
|
584
586
|
* SVG (.svg)
|
585
587
|
|
586
|
-
CAUTION: The GIF format (.gif)
|
588
|
+
CAUTION: The GIF format (.gif) and BMP format (.bmp) are not supported unless you're using prawn-gmagick.
|
589
|
+
See https://github.com/asciidoctor/asciidoctor-pdf#supporting-additional-image-file-formats[support for additional image file formats] for details.
|
587
590
|
|
588
591
|
Here's how an image is specified in the theme file as a bare image path:
|
589
592
|
|
590
593
|
[source,yaml]
|
591
594
|
----
|
592
|
-
|
593
|
-
|
595
|
+
title-page:
|
596
|
+
background-image: title-cover.png
|
594
597
|
----
|
595
598
|
|
596
|
-
In this case, the image is resolved relative to theme directory.
|
597
|
-
|
598
599
|
Here's how the image is specified using the inline image macro:
|
599
600
|
|
600
601
|
[source,yaml]
|
601
602
|
----
|
602
|
-
|
603
|
-
|
603
|
+
title-page:
|
604
|
+
background-image: image:title-cover.png[]
|
604
605
|
----
|
605
606
|
|
606
|
-
In
|
607
|
-
Wrapping the value in the image macro sends a hint to the converter to resolve it just like other images.
|
607
|
+
In either case, the image is resolved relative to the value of the `pdf-themesdir` attribute, as previously described.
|
608
608
|
|
609
|
-
Like in the AsciiDoc syntax, the
|
609
|
+
Like in the AsciiDoc syntax, wrapping the value in the image macro allows you to specify other settings, such as `pdfwidth`, `fit`, and/or `align`.
|
610
|
+
For example:
|
610
611
|
|
611
612
|
[source,yaml]
|
612
613
|
----
|
613
|
-
|
614
|
-
|
614
|
+
title-page:
|
615
|
+
logo-image: image:logo.png[width=250,align=center]
|
615
616
|
----
|
616
617
|
|
617
618
|
=== Quoted String
|
@@ -632,7 +633,7 @@ Here's an example of using formatting in the content of the menu caret:
|
|
632
633
|
|
633
634
|
[source,yaml]
|
634
635
|
----
|
635
|
-
|
636
|
+
menu-caret-content: " <font size=\"1.15em\"><color rgb=\"#b12146\">\u203a</color></font> "
|
636
637
|
----
|
637
638
|
|
638
639
|
NOTE: The string must be double quoted in order to use a Unicode escape code like `\u203a`.
|
@@ -647,6 +648,8 @@ If you want to use custom fonts, you must first declare them in your theme file.
|
|
647
648
|
IMPORTANT: Asciidoctor has no challenge working with Unicode.
|
648
649
|
In fact, it prefers Unicode and considers the entire range.
|
649
650
|
However, once you convert to PDF, you have to meet the font requirements of PDF in order to preserve Unicode characters.
|
651
|
+
That means you need to provide a font (at least a fallback font) that contains glyphs for all the characters you want to use.
|
652
|
+
If you don't, you may notice that characters are missing.
|
650
653
|
There's nothing Asciidoctor can do to convince PDF to work with extended characters without the right fonts in play.
|
651
654
|
|
652
655
|
=== Built-In (AFM) Fonts
|
@@ -668,13 +671,13 @@ The names of the built-in fonts (for general-purpose text) are as follows:
|
|
668
671
|
|===
|
669
672
|
|
670
673
|
Using a built-in font requires no additional files.
|
671
|
-
You can use the key anywhere a `
|
674
|
+
You can use the key anywhere a `font-family` property is accepted in the theme file.
|
672
675
|
For example:
|
673
676
|
|
674
677
|
[source,yaml]
|
675
678
|
----
|
676
679
|
base:
|
677
|
-
|
680
|
+
font-family: Times-Roman
|
678
681
|
----
|
679
682
|
|
680
683
|
However, when you use a built-in font, the characters you can use in your document are limited to the characters in the WINANSI (http://en.wikipedia.org/wiki/Windows-1252[Windows-1252]) code set.
|
@@ -694,11 +697,14 @@ When using the built-in PDF (AFM) fonts on a block of content in your AsciiDoc d
|
|
694
697
|
The following text could not be fully converted to the Windows-1252 character set:
|
695
698
|
| <string with unknown glyph>
|
696
699
|
|
697
|
-
This behavior differs from the default behavior in Prawn, which simply
|
700
|
+
This behavior differs from the default behavior in Prawn, which is to simply crash.
|
698
701
|
|
699
702
|
You'll often see this warning if you're using callouts in your document and you haven't specified a TrueType font in your theme.
|
700
703
|
To prevent this warning, you need to specify a TrueType font.
|
701
704
|
|
705
|
+
When using a TrueType font, you will get no warning for a missing glyph.
|
706
|
+
That's a consequence of how Prawn works and is outside of Asciidoctor PDF's control.
|
707
|
+
|
702
708
|
For more information about how Prawn handles character encodings for built-in fonts, see https://github.com/prawnpdf/prawn/blob/master/CHANGELOG.md#vastly-improved-handling-of-encodings-for-pdf-built-in-afm-fonts[this note in the Prawn CHANGELOG].
|
703
709
|
****
|
704
710
|
|
@@ -752,7 +758,7 @@ Name the files as follows:
|
|
752
758
|
* roboto-bold.ttf (_originally Roboto-Bold.ttf_)
|
753
759
|
* roboto-bold_italic.ttf (_originally Roboto-BoldItalic.ttf_)
|
754
760
|
|
755
|
-
Next, declare the font under the `
|
761
|
+
Next, declare the font under the `font-catalog` key at the top of your theme file, giving it a unique key (e.g., `Roboto`).
|
756
762
|
|
757
763
|
[source,yaml]
|
758
764
|
----
|
@@ -765,18 +771,18 @@ font:
|
|
765
771
|
bold_italic: roboto-bold_italic.ttf
|
766
772
|
----
|
767
773
|
|
768
|
-
You can use the key that you assign to the font in the font catalog anywhere the `
|
774
|
+
You can use the key that you assign to the font in the font catalog anywhere the `font-family` property is accepted in the theme file.
|
769
775
|
For instance, to use the Roboto font for all headings, you'd use:
|
770
776
|
|
771
777
|
[source,yaml]
|
772
778
|
----
|
773
779
|
heading:
|
774
|
-
|
780
|
+
font-family: Roboto
|
775
781
|
----
|
776
782
|
|
777
783
|
When you execute Asciidoctor PDF, you need to specify the directory where the fonts reside using the `pdf-fontsdir` attribute:
|
778
784
|
|
779
|
-
$ asciidoctor-pdf -a pdf-
|
785
|
+
$ asciidoctor-pdf -a pdf-theme=basic-theme.yml -a pdf-fontsdir=path/to/fonts document.adoc
|
780
786
|
|
781
787
|
WARNING: Currently, all fonts referenced by the theme need to be present in the directory specified by the `pdf-fontsdir` attribute.
|
782
788
|
|
@@ -841,7 +847,7 @@ font:
|
|
841
847
|
bold_italic: droid-sans-fallback.ttf
|
842
848
|
----
|
843
849
|
|
844
|
-
Next, add the key name to the `fallbacks` key under the `
|
850
|
+
Next, add the key name to the `fallbacks` key under the `font-catalog` key.
|
845
851
|
The `fallbacks` key accepts an array of values, meaning you can specify more than one fallback font.
|
846
852
|
However, we recommend using a single fallback font, if possible, as shown here:
|
847
853
|
|
@@ -870,7 +876,7 @@ Of course, make sure you've configured your theme to use your custom font:
|
|
870
876
|
[source,yaml]
|
871
877
|
----
|
872
878
|
base:
|
873
|
-
|
879
|
+
font-family: Roboto
|
874
880
|
----
|
875
881
|
|
876
882
|
That's it!
|
@@ -884,9 +890,9 @@ This section lists all the keys that are available when creating a custom theme.
|
|
884
890
|
The keys are organized by category.
|
885
891
|
Each category represents a common prefix under which the keys are typically nested.
|
886
892
|
|
887
|
-
TIP: Keys can be nested wherever an underscore (`_`) appears in the name.
|
893
|
+
TIP: Keys can be nested wherever an underscore (`_`) or hyphen (`-`) appears in the name.
|
888
894
|
This nested structure is for organizational purposes only.
|
889
|
-
All keys are flatted when the theme is loaded (e.g., `align` nested under `base` becomes `
|
895
|
+
All keys are flatted when the theme is loaded (e.g., `align` nested under `base` becomes `base-align`).
|
890
896
|
|
891
897
|
The converter uses the values of these keys to control how most elements are arranged and styled in the PDF.
|
892
898
|
The default values listed in this section get inherited from the https://github.com/asciidoctor/asciidoctor-pdf/blob/master/data/themes/base-theme.yml[base theme].
|
@@ -906,7 +912,7 @@ Each value is interpreted as a filename.
|
|
906
912
|
If the filename equals `default`, it resolves to the location of the default (built-in) theme.
|
907
913
|
If the filename is absolute, it's used as is.
|
908
914
|
If the filename begins with `./`, it's resolved as a theme file relative to the current theme file.
|
909
|
-
Otherwise, the filename is resolved as a theme file in the normal way (relative to the value of the `pdf-
|
915
|
+
Otherwise, the filename is resolved as a theme file in the normal way (relative to the value of the `pdf-themesdir` attribute).
|
910
916
|
|
911
917
|
Currently, the base theme is always loaded first.
|
912
918
|
Then, the files referenced by the extends key are loaded in order.
|
@@ -940,17 +946,25 @@ See <<Title Page>> for details.
|
|
940
946
|
|
941
947
|
3+|[#key-prefix-page]*Key Prefix:* <<key-prefix-page,page>>
|
942
948
|
|
943
|
-
|
|
949
|
+
|background-color^[1]^
|
944
950
|
|<<colors,Color>> +
|
945
951
|
(default: #ffffff)
|
946
952
|
|page:
|
947
|
-
|
953
|
+
background-color: #fefefe
|
954
|
+
|
955
|
+
|background-image^[1]^
|
956
|
+
|image macro^[2]^ +
|
957
|
+
(default: _not set_)
|
958
|
+
|page:
|
959
|
+
background-image: image:page-bg.png[]
|
948
960
|
|
949
|
-
|
|
950
|
-
|
|
961
|
+
|background-image-(recto{vbar}verso)^[1]^
|
962
|
+
|image macro^[2]^ +
|
951
963
|
(default: _not set_)
|
952
964
|
|page:
|
953
|
-
|
965
|
+
background-image:
|
966
|
+
recto: image:page-bg-recto.png[]
|
967
|
+
verso: image:page-bg-verso.png[]
|
954
968
|
|
955
969
|
|layout
|
956
970
|
|portrait {vbar} landscape +
|
@@ -964,17 +978,17 @@ See <<Title Page>> for details.
|
|
964
978
|
|page:
|
965
979
|
margin: [0.5in, 0.67in, 1in, 0.67in]
|
966
980
|
|
967
|
-
|
|
981
|
+
|margin-inner^[3]^
|
968
982
|
|<<measurement-units,Measurement>> +
|
969
983
|
(default: 48)
|
970
984
|
|page:
|
971
|
-
|
985
|
+
margin-inner: 0.75in
|
972
986
|
|
973
|
-
|
|
987
|
+
|margin-outer^[3]^
|
974
988
|
|<<measurement-units,Measurement>> +
|
975
989
|
(default: 24)
|
976
990
|
|page:
|
977
|
-
|
991
|
+
margin-outer: 0.59in
|
978
992
|
|
979
993
|
|size
|
980
994
|
|https://github.com/prawnpdf/pdf-core/blob/0.6.0/lib/pdf/core/page_geometry.rb#L16-L68[Named size^] {vbar} <<measurement-units,Measurement[width,height]>> +
|
@@ -982,21 +996,20 @@ See <<Title Page>> for details.
|
|
982
996
|
|page:
|
983
997
|
size: Letter
|
984
998
|
|
985
|
-
|
|
999
|
+
|numbering-start-at
|
986
1000
|
|title {vbar} toc {vbar} body +
|
987
1001
|
(default: body)
|
988
1002
|
|page:
|
989
|
-
|
1003
|
+
numbering-start-at: toc
|
990
1004
|
|===
|
991
1005
|
|
992
|
-
.
|
993
|
-
|
994
|
-
|
995
|
-
|
996
|
-
|
997
|
-
|
998
|
-
.
|
999
|
-
. The margins for `recto` (right-hand, odd-numbered) and `verso` (left-hand, even-numbered) pages are calculated automatically from the margin_inner and margin_outer values.
|
1006
|
+
. By default, page background images are automatically scaled to fit the bounds of the page (i.e., `fit=contain`).
|
1007
|
+
The size of the background can be controlled using any of the sizing attributes on the image macro (i.e., fit, pdfwidth, scaledwidth, or width).
|
1008
|
+
If the recto (right-hand, odd-numbered pages) or verso (left-hand, even-numbered pages) background is specified, it will be used only for that side.
|
1009
|
+
If you flatten out the keys (e.g., `page-background-recto`), you can also set the default page background image (`page-background`), which will then be used as a fallback if a background image isn't specified for a side.
|
1010
|
+
To disable the background for a side, use the value `none`.
|
1011
|
+
. Target may be an absolute path or a path relative to the value of the `pdf-themesdir` attribute.
|
1012
|
+
. The margins for `recto` (right-hand, odd-numbered) and `verso` (left-hand, even-numbered) pages are calculated automatically from the margin-inner and margin-outer values.
|
1000
1013
|
These margins and used when the value `prepress` is assigned to the `media` document attribute.
|
1001
1014
|
|
1002
1015
|
[#keys-base]
|
@@ -1005,7 +1018,7 @@ These margins and used when the value `prepress` is assigned to the `media` docu
|
|
1005
1018
|
The keys in this category provide generic theme settings and are often referenced throughout the theme file as variables.
|
1006
1019
|
We recommended that you define this category after the page category and before all other categories.
|
1007
1020
|
|
1008
|
-
NOTE: While it's common to define additional keys in this category (e.g., `
|
1021
|
+
NOTE: While it's common to define additional keys in this category (e.g., `base-border-radius`) to keep your theme DRY, we recommend using <<Custom Variables,custom variables>> instead.
|
1009
1022
|
|
1010
1023
|
[cols="3,4,5l"]
|
1011
1024
|
|===
|
@@ -1019,92 +1032,92 @@ NOTE: While it's common to define additional keys in this category (e.g., `base_
|
|
1019
1032
|
|base:
|
1020
1033
|
align: justify
|
1021
1034
|
|
1022
|
-
|
|
1035
|
+
|border-color
|
1023
1036
|
|<<colors,Color>> +
|
1024
1037
|
(default: #eeeeee)
|
1025
1038
|
|base:
|
1026
|
-
|
1039
|
+
border-color: #eeeeee
|
1027
1040
|
|
1028
|
-
//
|
1029
|
-
//|
|
1041
|
+
// border-radius is variable, not an official key
|
1042
|
+
//|border-radius
|
1030
1043
|
//|<<values,Number>>
|
1031
1044
|
//|base:
|
1032
|
-
//
|
1045
|
+
// border-radius: 4
|
1033
1046
|
|
1034
|
-
|
|
1047
|
+
|border-width
|
1035
1048
|
|<<values,Number>> +
|
1036
1049
|
(default: 0.5)
|
1037
1050
|
|base:
|
1038
|
-
|
1051
|
+
border-width: 0.5
|
1039
1052
|
|
1040
|
-
|
|
1053
|
+
|font-color
|
1041
1054
|
|<<colors,Color>> +
|
1042
1055
|
(default: #000000)
|
1043
1056
|
|base:
|
1044
|
-
|
1057
|
+
font-color: #333333
|
1045
1058
|
|
1046
|
-
|
|
1059
|
+
|font-family
|
1047
1060
|
|<<fonts,Font family name>> +
|
1048
1061
|
(default: Helvetica)
|
1049
1062
|
|base:
|
1050
|
-
|
1063
|
+
font-family: Noto Serif
|
1051
1064
|
|
1052
|
-
|
|
1065
|
+
|font-size
|
1053
1066
|
|<<values,Number>> +
|
1054
1067
|
(default: 12)
|
1055
1068
|
|base:
|
1056
|
-
|
1069
|
+
font-size: 10.5
|
1057
1070
|
|
1058
|
-
//
|
1059
|
-
//|
|
1071
|
+
// font-size-large is a variable, not an official key
|
1072
|
+
//|font-size-large
|
1060
1073
|
//|<<values,Number>>
|
1061
1074
|
//|base:
|
1062
|
-
//
|
1075
|
+
// font-size-large: 13
|
1063
1076
|
|
1064
|
-
|
|
1077
|
+
|font-size-min
|
1065
1078
|
|<<values,Number>> +
|
1066
1079
|
(default: 9)
|
1067
1080
|
|base:
|
1068
|
-
|
1081
|
+
font-size-min: 6
|
1069
1082
|
|
1070
|
-
//
|
1071
|
-
//|
|
1083
|
+
// font-size-small is a variable, not an official key
|
1084
|
+
//|font-size-small
|
1072
1085
|
//|<<values,Number>>
|
1073
1086
|
//|base:
|
1074
|
-
//
|
1087
|
+
// font-size-small: 9
|
1075
1088
|
|
1076
|
-
|
|
1089
|
+
|font-style
|
1077
1090
|
|<<font-styles,Font style>> +
|
1078
1091
|
(default: normal)
|
1079
1092
|
|base:
|
1080
|
-
|
1093
|
+
font-style: normal
|
1081
1094
|
|
1082
|
-
|
|
1095
|
+
|text-transform^[1]^
|
1083
1096
|
|none +
|
1084
1097
|
(default: none)
|
1085
1098
|
|base:
|
1086
|
-
|
1099
|
+
text-transform: none
|
1087
1100
|
|
1088
|
-
|
|
1101
|
+
|line-height-length^[2]^
|
1089
1102
|
|<<values,Number>> +
|
1090
1103
|
(default: 13.8)
|
1091
1104
|
|base:
|
1092
|
-
|
1105
|
+
line-height-length: 12
|
1093
1106
|
|
1094
|
-
|
|
1107
|
+
|line-height^[2]^
|
1095
1108
|
|<<values,Number>> +
|
1096
1109
|
(default: 1.15)
|
1097
1110
|
|base:
|
1098
|
-
|
1099
|
-
$
|
1100
|
-
$
|
1111
|
+
line-height: >
|
1112
|
+
$base-line-height-length /
|
1113
|
+
$base-font-size
|
1101
1114
|
|===
|
1102
1115
|
|
1103
|
-
. The `
|
1116
|
+
. The `text-transform` key cannot be set globally.
|
1104
1117
|
Therefore, this key should not be used.
|
1105
1118
|
The value of `none` is implicit and is documented here for completeness.
|
1106
|
-
. You should set one of `
|
1107
|
-
For instance, if you set `
|
1119
|
+
. You should set one of `line-height` or `line-height-length`, then derive the value of the other using a calculation as these are correlated values.
|
1120
|
+
For instance, if you set `line-height-length`, then use `$base-line-height-length / $base-font-size` as the value of `line-height`.
|
1108
1121
|
|
1109
1122
|
[#keys-vertical-spacing]
|
1110
1123
|
=== Vertical Spacing
|
@@ -1115,10 +1128,10 @@ The keys in this category control the general spacing between elements where a m
|
|
1115
1128
|
|===
|
1116
1129
|
|Key |Value Type |Example
|
1117
1130
|
|
1118
|
-
|
|
1131
|
+
|vertical-spacing
|
1119
1132
|
|<<values,Number>> +
|
1120
1133
|
(default: 12)
|
1121
|
-
|
|
1134
|
+
|vertical-spacing: 10
|
1122
1135
|
|===
|
1123
1136
|
|
1124
1137
|
[#keys-link]
|
@@ -1132,35 +1145,35 @@ The keys in this category are used to style hyperlink text.
|
|
1132
1145
|
|
1133
1146
|
3+|[#key-prefix-link]*Key Prefix:* <<key-prefix-link,link>>
|
1134
1147
|
|
1135
|
-
|
|
1148
|
+
|font-color
|
1136
1149
|
|<<colors,Color>> +
|
1137
1150
|
(default: #0000ee)
|
1138
1151
|
|link:
|
1139
|
-
|
1152
|
+
font-color: #428bca
|
1140
1153
|
|
1141
|
-
|
|
1154
|
+
|font-family
|
1142
1155
|
|<<fonts,Font family name>> +
|
1143
1156
|
(default: _inherit_)
|
1144
1157
|
|link:
|
1145
|
-
|
1158
|
+
font-family: Roboto
|
1146
1159
|
|
1147
|
-
|
|
1160
|
+
|font-size
|
1148
1161
|
|<<values,Number>> +
|
1149
1162
|
(default: _inherit_)
|
1150
1163
|
|link:
|
1151
|
-
|
1164
|
+
font-size: 9
|
1152
1165
|
|
1153
|
-
|
|
1166
|
+
|font-style
|
1154
1167
|
|<<font-styles,Font style>> +
|
1155
1168
|
(default: _inherit_)
|
1156
1169
|
|link:
|
1157
|
-
|
1170
|
+
font-style: italic
|
1158
1171
|
|
1159
|
-
|
|
1172
|
+
|text-decoration
|
1160
1173
|
|none {vbar} underline {vbar} line-through +
|
1161
1174
|
(default: none)
|
1162
1175
|
|link:
|
1163
|
-
|
1176
|
+
text-decoration: underline
|
1164
1177
|
|===
|
1165
1178
|
|
1166
1179
|
[#keys-literal]
|
@@ -1174,29 +1187,29 @@ The keys in this category are used for inline monospaced text in prose and table
|
|
1174
1187
|
|
1175
1188
|
3+|[#key-prefix-literal]*Key Prefix:* <<key-prefix-literal,literal>>
|
1176
1189
|
|
1177
|
-
|
|
1190
|
+
|font-color
|
1178
1191
|
|<<colors,Color>> +
|
1179
1192
|
(default: _inherit_)
|
1180
1193
|
|literal:
|
1181
|
-
|
1194
|
+
font-color: #b12146
|
1182
1195
|
|
1183
|
-
|
|
1196
|
+
|font-family
|
1184
1197
|
|<<fonts,Font family name>> +
|
1185
1198
|
(default: Courier)
|
1186
1199
|
|literal:
|
1187
|
-
|
1200
|
+
font-family: M+ 1mn
|
1188
1201
|
|
1189
|
-
|
|
1202
|
+
|font-size
|
1190
1203
|
|<<values,Number>> +
|
1191
1204
|
(default: _inherit_)
|
1192
1205
|
|literal:
|
1193
|
-
|
1206
|
+
font-size: 12
|
1194
1207
|
|
1195
|
-
|
|
1208
|
+
|font-style
|
1196
1209
|
|<<font-styles,Font style>> +
|
1197
1210
|
(default: _inherit_)
|
1198
1211
|
|literal:
|
1199
|
-
|
1212
|
+
font-style: bold
|
1200
1213
|
|===
|
1201
1214
|
|
1202
1215
|
[#keys-heading]
|
@@ -1212,96 +1225,96 @@ The keys in this category control the style of most headings, including part tit
|
|
1212
1225
|
|
1213
1226
|
|align
|
1214
1227
|
|<<text-alignments,Text alignment>> +
|
1215
|
-
(default: $
|
1228
|
+
(default: $base-align)
|
1216
1229
|
|heading:
|
1217
1230
|
align: center
|
1218
1231
|
|
1219
|
-
|
|
1232
|
+
|font-color
|
1220
1233
|
|<<colors,Color>> +
|
1221
1234
|
(default: _inherit_)
|
1222
1235
|
|heading:
|
1223
|
-
|
1236
|
+
font-color: #222222
|
1224
1237
|
|
1225
|
-
|
|
1238
|
+
|font-family
|
1226
1239
|
|<<fonts,Font family name>> +
|
1227
|
-
(default: $
|
1240
|
+
(default: $base-font-family)
|
1228
1241
|
|heading:
|
1229
|
-
|
1242
|
+
font-family: Noto Serif
|
1230
1243
|
|
1231
|
-
// NOTE:
|
1232
|
-
//|
|
1244
|
+
// NOTE: heading-font-size is overridden by h<n>-font-size in base theme
|
1245
|
+
//|font-size
|
1233
1246
|
//|<<values,Number>> +
|
1234
|
-
//(default: $
|
1247
|
+
//(default: $base-font-size)
|
1235
1248
|
//|heading:
|
1236
|
-
//
|
1249
|
+
// font-size: 18
|
1237
1250
|
|
1238
|
-
|
|
1251
|
+
|font-style
|
1239
1252
|
|<<font-styles,Font style>> +
|
1240
1253
|
(default: bold)
|
1241
1254
|
|heading:
|
1242
|
-
|
1255
|
+
font-style: bold
|
1243
1256
|
|
1244
|
-
|
|
1257
|
+
|text-transform
|
1245
1258
|
|<<text-transforms,Text transform>> +
|
1246
1259
|
(default: _inherit_)
|
1247
1260
|
|heading:
|
1248
|
-
|
1261
|
+
text-transform: uppercase
|
1249
1262
|
|
1250
|
-
|
|
1263
|
+
|line-height
|
1251
1264
|
|<<values,Number>> +
|
1252
1265
|
(default: 1.15)
|
1253
1266
|
|heading:
|
1254
|
-
|
1267
|
+
line-height: 1.2
|
1255
1268
|
|
1256
|
-
|
|
1269
|
+
|margin-top
|
1257
1270
|
|<<measurement-units,Measurement>> +
|
1258
1271
|
(default: 4)
|
1259
1272
|
|heading:
|
1260
|
-
|
1273
|
+
margin-top: $vertical-spacing * 0.2
|
1261
1274
|
|
1262
|
-
|
|
1275
|
+
|margin-bottom
|
1263
1276
|
|<<measurement-units,Measurement>> +
|
1264
1277
|
(default: 12)
|
1265
1278
|
|heading:
|
1266
|
-
|
1279
|
+
margin-bottom: 9.6
|
1267
1280
|
|
1268
|
-
3+|[#key-prefix-heading-level]*Key Prefix:* <<key-prefix-heading-level,
|
1281
|
+
3+|[#key-prefix-heading-level]*Key Prefix:* <<key-prefix-heading-level,heading-h<n> >>^[1]^
|
1269
1282
|
|
1270
1283
|
|align
|
1271
1284
|
|<<text-alignments,Text alignment>> +
|
1272
|
-
(default: $
|
1285
|
+
(default: $heading-align)
|
1273
1286
|
|heading:
|
1274
|
-
|
1287
|
+
h2-align: center
|
1275
1288
|
|
1276
|
-
|
|
1289
|
+
|font-color
|
1277
1290
|
|<<colors,Color>> +
|
1278
|
-
(default: $
|
1291
|
+
(default: $heading-font-color)
|
1279
1292
|
|heading:
|
1280
|
-
|
1293
|
+
h2-font-color: [0, 99%, 100%, 0]
|
1281
1294
|
|
1282
|
-
|
|
1295
|
+
|font-family
|
1283
1296
|
|<<fonts,Font family name>> +
|
1284
|
-
(default: $
|
1297
|
+
(default: $heading-font-family)
|
1285
1298
|
|heading:
|
1286
|
-
|
1299
|
+
h4-font-family: Roboto
|
1287
1300
|
|
1288
|
-
|
|
1301
|
+
|font-size^[1]^
|
1289
1302
|
|<<values,Number>> +
|
1290
1303
|
(default: <1>=24; <2>=18; <3>=16; <4>=14; <5>=12; <6>=10)
|
1291
1304
|
|heading:
|
1292
|
-
|
1305
|
+
h6-font-size: $base-font-size * 1.7
|
1293
1306
|
|
1294
|
-
|
|
1307
|
+
|font-style
|
1295
1308
|
|<<font-styles,Font style>> +
|
1296
|
-
(default: $
|
1309
|
+
(default: $heading-font-style)
|
1297
1310
|
|heading:
|
1298
|
-
|
1311
|
+
h3-font-style: bold_italic
|
1299
1312
|
|
1300
|
-
|
|
1313
|
+
|text-transform
|
1301
1314
|
|<<text-transforms,Text transform>> +
|
1302
|
-
(default: $
|
1315
|
+
(default: $heading-text-transform)
|
1303
1316
|
|heading:
|
1304
|
-
|
1317
|
+
text-transform: lowercase
|
1305
1318
|
|===
|
1306
1319
|
|
1307
1320
|
. `<n>` is a number ranging from 1 to 6, representing each of the six heading levels.
|
@@ -1319,332 +1332,328 @@ TIP: The title page can be disabled from the document by setting the `notitle` a
|
|
1319
1332
|
|===
|
1320
1333
|
|Key |Value Type |Example
|
1321
1334
|
|
1322
|
-
3+|[#key-prefix-title-page]*Key Prefix:* <<key-prefix-title-page,
|
1335
|
+
3+|[#key-prefix-title-page]*Key Prefix:* <<key-prefix-title-page,title-page>>
|
1323
1336
|
|
1324
1337
|
|align
|
1325
1338
|
|<<text-alignments,Text alignment>> +
|
1326
1339
|
(default: center)
|
1327
|
-
|
|
1340
|
+
|title-page:
|
1328
1341
|
align: right
|
1329
1342
|
|
1330
|
-
|
|
1343
|
+
|background-color^[1]^
|
1331
1344
|
|<<colors,Color>> +
|
1332
1345
|
(default: _inherit_)
|
1333
|
-
|
|
1334
|
-
|
1346
|
+
|title-page:
|
1347
|
+
background-color: #eaeaea
|
1335
1348
|
|
1336
|
-
|
|
1337
|
-
|
|
1349
|
+
|background-image^[1]^
|
1350
|
+
|image macro^[2]^ +
|
1338
1351
|
(default: _not set_)
|
1339
|
-
|
|
1340
|
-
|
1352
|
+
|title-page:
|
1353
|
+
background-image: image:title.png[]
|
1341
1354
|
|
1342
|
-
|
|
1355
|
+
|font-color
|
1343
1356
|
|<<colors,Color>> +
|
1344
1357
|
(default: _inherit_)
|
1345
|
-
|
|
1346
|
-
|
1358
|
+
|title-page:
|
1359
|
+
font-color: #333333
|
1347
1360
|
|
1348
|
-
|
|
1361
|
+
|font-family
|
1349
1362
|
|<<fonts,Font family name>> +
|
1350
1363
|
(default: _inherit_)
|
1351
|
-
|
|
1352
|
-
|
1364
|
+
|title-page:
|
1365
|
+
font-family: Noto Serif
|
1353
1366
|
|
1354
|
-
|
|
1367
|
+
|font-size
|
1355
1368
|
|<<values,Number>> +
|
1356
1369
|
(default: _inherit_)
|
1357
|
-
|
|
1358
|
-
|
1370
|
+
|title-page:
|
1371
|
+
font-size: 13
|
1359
1372
|
|
1360
|
-
|
|
1373
|
+
|font-style
|
1361
1374
|
|<<font-styles,Font style>> +
|
1362
1375
|
(default: _inherit_)
|
1363
|
-
|
|
1364
|
-
|
1376
|
+
|title-page:
|
1377
|
+
font-style: bold
|
1365
1378
|
|
1366
|
-
|
|
1379
|
+
|text-transform
|
1367
1380
|
|<<text-transforms,Text transform>> +
|
1368
1381
|
(default: _inherit_)
|
1369
|
-
|
|
1370
|
-
|
1382
|
+
|title-page:
|
1383
|
+
text-transform: uppercase
|
1371
1384
|
|
1372
|
-
|
|
1385
|
+
|line-height
|
1373
1386
|
|<<values,Number>> +
|
1374
1387
|
(default: 1.15)
|
1375
|
-
|
|
1376
|
-
|
1388
|
+
|title-page:
|
1389
|
+
line-height: 1
|
1377
1390
|
|
1378
|
-
3+|[#key-prefix-title-page-logo]*Key Prefix:* <<key-prefix-title-page-logo,
|
1391
|
+
3+|[#key-prefix-title-page-logo]*Key Prefix:* <<key-prefix-title-page-logo,title-page-logo>>
|
1379
1392
|
|
1380
1393
|
|align
|
1381
1394
|
|<<image-alignments,Image alignment>> +
|
1382
1395
|
(default: _inherit_)
|
1383
|
-
|
|
1396
|
+
|title-page:
|
1384
1397
|
logo:
|
1385
1398
|
align: right
|
1386
1399
|
|
1387
1400
|
|image
|
1388
|
-
|
|
1401
|
+
|image macro^[2]^ +
|
1389
1402
|
(default: _not set_)
|
1390
|
-
|
|
1403
|
+
|title-page:
|
1391
1404
|
logo:
|
1392
1405
|
image: image:logo.png[pdfwidth=25%]
|
1393
1406
|
|
1394
1407
|
|top
|
1395
1408
|
|Percentage^[3]^ +
|
1396
1409
|
(default: 10%)
|
1397
|
-
|
|
1410
|
+
|title-page:
|
1398
1411
|
logo:
|
1399
1412
|
top: 25%
|
1400
1413
|
|
1401
|
-
3+|[#key-prefix-title-page-title]*Key Prefix:* <<key-prefix-title-page-title,
|
1414
|
+
3+|[#key-prefix-title-page-title]*Key Prefix:* <<key-prefix-title-page-title,title-page-title>>
|
1402
1415
|
|
1403
|
-
|
|
1416
|
+
|font-color
|
1404
1417
|
|<<colors,Color>> +
|
1405
1418
|
(default: _inherit_)
|
1406
|
-
|
|
1419
|
+
|title-page:
|
1407
1420
|
title:
|
1408
|
-
|
1421
|
+
font-color: #999999
|
1409
1422
|
|
1410
|
-
|
|
1423
|
+
|font-family
|
1411
1424
|
|<<fonts,Font family name>> +
|
1412
1425
|
(default: _inherit_)
|
1413
|
-
|
|
1426
|
+
|title-page:
|
1414
1427
|
title:
|
1415
|
-
|
1428
|
+
font-family: Noto Serif
|
1416
1429
|
|
1417
|
-
|
|
1430
|
+
|font-size
|
1418
1431
|
|<<values,Number>> +
|
1419
1432
|
(default: 18)
|
1420
|
-
|
|
1433
|
+
|title-page:
|
1421
1434
|
title:
|
1422
|
-
|
1435
|
+
font-size: $heading-h1-font-size
|
1423
1436
|
|
1424
|
-
|
|
1437
|
+
|font-style
|
1425
1438
|
|<<font-styles,Font style>> +
|
1426
1439
|
(default: _inherit_)
|
1427
|
-
|
|
1440
|
+
|title-page:
|
1428
1441
|
title:
|
1429
|
-
|
1442
|
+
font-style: bold
|
1430
1443
|
|
1431
|
-
|
|
1444
|
+
|text-transform
|
1432
1445
|
|<<text-transforms,Text transform>> +
|
1433
1446
|
(default: _inherit_)
|
1434
|
-
|
|
1447
|
+
|title-page:
|
1435
1448
|
title:
|
1436
|
-
|
1449
|
+
text-transform: uppercase
|
1437
1450
|
|
1438
|
-
|
|
1451
|
+
|line-height
|
1439
1452
|
|<<values,Number>> +
|
1440
|
-
(default: $
|
1441
|
-
|
|
1453
|
+
(default: $heading-line-height)
|
1454
|
+
|title-page:
|
1442
1455
|
title:
|
1443
|
-
|
1456
|
+
line-height: 0.9
|
1444
1457
|
|
1445
1458
|
|top
|
1446
1459
|
|Percentage^[3]^ +
|
1447
1460
|
(default: 40%)
|
1448
|
-
|
|
1461
|
+
|title-page:
|
1449
1462
|
title:
|
1450
1463
|
top: 55%
|
1451
1464
|
|
1452
|
-
|
|
1465
|
+
|margin-top
|
1453
1466
|
|<<measurement-units,Measurement>> +
|
1454
1467
|
(default: 0)
|
1455
|
-
|
|
1468
|
+
|title-page:
|
1456
1469
|
title:
|
1457
|
-
|
1470
|
+
margin-top: 13.125
|
1458
1471
|
|
1459
|
-
|
|
1472
|
+
|margin-bottom
|
1460
1473
|
|<<measurement-units,Measurement>> +
|
1461
1474
|
(default: 0)
|
1462
|
-
|
|
1475
|
+
|title-page:
|
1463
1476
|
title:
|
1464
|
-
|
1477
|
+
margin-bottom: 5
|
1465
1478
|
|
1466
|
-
3+|[#key-prefix-title-page-subtitle]*Key Prefix:* <<key-prefix-title-page-subtitle,
|
1479
|
+
3+|[#key-prefix-title-page-subtitle]*Key Prefix:* <<key-prefix-title-page-subtitle,title-page-subtitle>>
|
1467
1480
|
|
1468
|
-
|
|
1481
|
+
|font-color
|
1469
1482
|
|<<colors,Color>> +
|
1470
1483
|
(default: _inherit_)
|
1471
|
-
|
|
1484
|
+
|title-page:
|
1472
1485
|
subtitle:
|
1473
|
-
|
1486
|
+
font-color: #181818
|
1474
1487
|
|
1475
|
-
|
|
1488
|
+
|font-family
|
1476
1489
|
|<<fonts,Font family name>> +
|
1477
1490
|
(default: _inherit_)
|
1478
|
-
|
|
1491
|
+
|title-page:
|
1479
1492
|
subtitle:
|
1480
|
-
|
1493
|
+
font-family: Noto Serif
|
1481
1494
|
|
1482
|
-
|
|
1495
|
+
|font-size
|
1483
1496
|
|<<values,Number>> +
|
1484
1497
|
(default: 14)
|
1485
|
-
|
|
1498
|
+
|title-page:
|
1486
1499
|
subtitle:
|
1487
|
-
|
1500
|
+
font-size: $heading-h3-font-size
|
1488
1501
|
|
1489
|
-
|
|
1502
|
+
|font-style
|
1490
1503
|
|<<font-styles,Font style>> +
|
1491
1504
|
(default: _inherit_)
|
1492
|
-
|
|
1505
|
+
|title-page:
|
1493
1506
|
subtitle:
|
1494
|
-
|
1507
|
+
font-style: bold_italic
|
1495
1508
|
|
1496
|
-
|
|
1509
|
+
|text-transform
|
1497
1510
|
|<<text-transforms,Text transform>> +
|
1498
1511
|
(default: _inherit_)
|
1499
|
-
|
|
1512
|
+
|title-page:
|
1500
1513
|
subtitle:
|
1501
|
-
|
1514
|
+
text-transform: uppercase
|
1502
1515
|
|
1503
|
-
|
|
1516
|
+
|line-height
|
1504
1517
|
|<<values,Number>> +
|
1505
|
-
(default: $
|
1506
|
-
|
|
1518
|
+
(default: $heading-line-height)
|
1519
|
+
|title-page:
|
1507
1520
|
subtitle:
|
1508
|
-
|
1521
|
+
line-height: 1
|
1509
1522
|
|
1510
|
-
|
|
1523
|
+
|margin-top
|
1511
1524
|
|<<measurement-units,Measurement>> +
|
1512
1525
|
(default: 0)
|
1513
|
-
|
|
1526
|
+
|title-page:
|
1514
1527
|
subtitle:
|
1515
|
-
|
1528
|
+
margin-top: 13.125
|
1516
1529
|
|
1517
|
-
|
|
1530
|
+
|margin-bottom
|
1518
1531
|
|<<measurement-units,Measurement>> +
|
1519
1532
|
(default: 0)
|
1520
|
-
|
|
1533
|
+
|title-page:
|
1521
1534
|
subtitle:
|
1522
|
-
|
1535
|
+
margin-bottom: 5
|
1523
1536
|
|
1524
|
-
3+|[#key-prefix-authors]*Key Prefix:* <<key-prefix-authors,
|
1537
|
+
3+|[#key-prefix-authors]*Key Prefix:* <<key-prefix-authors,title-page-authors>>
|
1525
1538
|
|
1526
1539
|
|delimiter
|
1527
1540
|
|<<quoted-string,Quoted string>> +
|
1528
1541
|
(default: ', ')
|
1529
|
-
|
|
1542
|
+
|title-page:
|
1530
1543
|
authors:
|
1531
1544
|
delimiter: '; '
|
1532
1545
|
|
1533
|
-
|
|
1546
|
+
|font-color
|
1534
1547
|
|<<colors,Color>> +
|
1535
1548
|
(default: _inherit_)
|
1536
|
-
|
|
1549
|
+
|title-page:
|
1537
1550
|
authors:
|
1538
|
-
|
1551
|
+
font-color: #181818
|
1539
1552
|
|
1540
|
-
|
|
1553
|
+
|font-family
|
1541
1554
|
|<<fonts,Font family name>> +
|
1542
1555
|
(default: _inherit_)
|
1543
|
-
|
|
1556
|
+
|title-page:
|
1544
1557
|
authors:
|
1545
|
-
|
1558
|
+
font-family: Noto Serif
|
1546
1559
|
|
1547
|
-
|
|
1560
|
+
|font-size
|
1548
1561
|
|<<values,Number>> +
|
1549
1562
|
(default: _inherit_)
|
1550
|
-
|
|
1563
|
+
|title-page:
|
1551
1564
|
authors:
|
1552
|
-
|
1565
|
+
font-size: 13
|
1553
1566
|
|
1554
|
-
|
|
1567
|
+
|font-style
|
1555
1568
|
|<<font-styles,Font style>> +
|
1556
1569
|
(default: _inherit_)
|
1557
|
-
|
|
1570
|
+
|title-page:
|
1558
1571
|
authors:
|
1559
|
-
|
1572
|
+
font-style: bold_italic
|
1560
1573
|
|
1561
|
-
|
|
1574
|
+
|text-transform
|
1562
1575
|
|<<text-transforms,Text transform>> +
|
1563
1576
|
(default: _inherit_)
|
1564
|
-
|
|
1577
|
+
|title-page:
|
1565
1578
|
authors:
|
1566
|
-
|
1579
|
+
text-transform: uppercase
|
1567
1580
|
|
1568
|
-
|
|
1581
|
+
|margin-top
|
1569
1582
|
|<<measurement-units,Measurement>> +
|
1570
1583
|
(default: 12)
|
1571
|
-
|
|
1584
|
+
|title-page:
|
1572
1585
|
authors:
|
1573
|
-
|
1586
|
+
margin-top: 13.125
|
1574
1587
|
|
1575
|
-
|
|
1588
|
+
|margin-bottom
|
1576
1589
|
|<<measurement-units,Measurement>> +
|
1577
1590
|
(default: 0)
|
1578
|
-
|
|
1591
|
+
|title-page:
|
1579
1592
|
authors:
|
1580
|
-
|
1593
|
+
margin-bottom: 5
|
1581
1594
|
|
1582
|
-
3+|[#key-prefix-revision]*Key Prefix:* <<key-prefix-revision,
|
1595
|
+
3+|[#key-prefix-revision]*Key Prefix:* <<key-prefix-revision,title-page-revision>>
|
1583
1596
|
|
1584
1597
|
|delimiter
|
1585
1598
|
|<<quoted-string,Quoted string>> +
|
1586
1599
|
(default: ', ')
|
1587
|
-
|
|
1600
|
+
|title-page:
|
1588
1601
|
revision:
|
1589
1602
|
delimiter: ': '
|
1590
1603
|
|
1591
|
-
|
|
1604
|
+
|font-color
|
1592
1605
|
|<<colors,Color>> +
|
1593
1606
|
(default: _inherit_)
|
1594
|
-
|
|
1607
|
+
|title-page:
|
1595
1608
|
revision:
|
1596
|
-
|
1609
|
+
font-color: #181818
|
1597
1610
|
|
1598
|
-
|
|
1611
|
+
|font-family
|
1599
1612
|
|<<fonts,Font family name>> +
|
1600
1613
|
(default: _inherit_)
|
1601
|
-
|
|
1614
|
+
|title-page:
|
1602
1615
|
revision:
|
1603
|
-
|
1616
|
+
font-family: Noto Serif
|
1604
1617
|
|
1605
|
-
|
|
1618
|
+
|font-size
|
1606
1619
|
|<<values,Number>> +
|
1607
1620
|
(default: _inherit_)
|
1608
|
-
|
|
1621
|
+
|title-page:
|
1609
1622
|
revision:
|
1610
|
-
|
1623
|
+
font-size: $base-font-size-small
|
1611
1624
|
|
1612
|
-
|
|
1625
|
+
|font-style
|
1613
1626
|
|<<font-styles,Font style>> +
|
1614
1627
|
(default: _inherit_)
|
1615
|
-
|
|
1628
|
+
|title-page:
|
1616
1629
|
revision:
|
1617
|
-
|
1630
|
+
font-style: bold
|
1618
1631
|
|
1619
|
-
|
|
1632
|
+
|text-transform
|
1620
1633
|
|<<text-transforms,Text transform>> +
|
1621
1634
|
(default: _inherit_)
|
1622
|
-
|
|
1635
|
+
|title-page:
|
1623
1636
|
revision:
|
1624
|
-
|
1637
|
+
text-transform: uppercase
|
1625
1638
|
|
1626
|
-
|
|
1639
|
+
|margin-top
|
1627
1640
|
|<<measurement-units,Measurement>> +
|
1628
1641
|
(default: 0)
|
1629
|
-
|
|
1642
|
+
|title-page:
|
1630
1643
|
revision:
|
1631
|
-
|
1644
|
+
margin-top: 13.125
|
1632
1645
|
|
1633
|
-
|
|
1646
|
+
|margin-bottom
|
1634
1647
|
|<<measurement-units,Measurement>> +
|
1635
1648
|
(default: 0)
|
1636
|
-
|
|
1649
|
+
|title-page:
|
1637
1650
|
revision:
|
1638
|
-
|
1651
|
+
margin-bottom: 5
|
1639
1652
|
|===
|
1640
1653
|
|
1641
|
-
.
|
1642
|
-
|
1643
|
-
|
1644
|
-
This limitation is due to a bug in Prawn 1.3.1.
|
1645
|
-
The limitation will remain until AsciidoctorJ PDF upgrades to Prawn 2.x (an upgrade that is waiting on AsciidoctorJ to migrate to JRuby 9000).
|
1646
|
-
For more details, see http://discuss.asciidoctor.org/Asciidoctor-YAML-style-file-for-PDF-and-maven-td3849.html[this thread].
|
1647
|
-
. Target may be an absolute path or a path relative to the value of the `pdf-stylesdir` attribute.
|
1654
|
+
. By default, page background images are automatically scaled to fit the bounds of the page (i.e., `fit=contain`).
|
1655
|
+
The size of the background can be controlled using any of the sizing attributes on the image macro (i.e., fit, pdfwidth, scaledwidth, or width).
|
1656
|
+
. Target may be an absolute path or a path relative to the value of the `pdf-themesdir` attribute.
|
1648
1657
|
. Percentage unit can be % (relative to content height) or vh (relative to page height).
|
1649
1658
|
|
1650
1659
|
[#keys-prose]
|
@@ -1659,29 +1668,29 @@ Typically, all the margin is placed on the bottom.
|
|
1659
1668
|
|
1660
1669
|
3+|[#key-prefix-prose]*Key Prefix:* <<key-prefix-prose,prose>>
|
1661
1670
|
|
1662
|
-
|
|
1671
|
+
|margin-top
|
1663
1672
|
|<<measurement-units,Measurement>> +
|
1664
1673
|
(default: 0)
|
1665
1674
|
|prose:
|
1666
|
-
|
1675
|
+
margin-top: 0
|
1667
1676
|
|
1668
|
-
|
|
1677
|
+
|margin-bottom
|
1669
1678
|
|<<measurement-units,Measurement>> +
|
1670
1679
|
(default: 12)
|
1671
1680
|
|prose:
|
1672
|
-
|
1681
|
+
margin-bottom: $vertical-spacing
|
1673
1682
|
|
1674
|
-
|
|
1683
|
+
|margin-inner^[1]^
|
1675
1684
|
|<<measurement-units,Measurement>> +
|
1676
|
-
(default: $
|
1685
|
+
(default: $prose-margin-bottom)
|
1677
1686
|
|prose:
|
1678
|
-
|
1687
|
+
margin-inner: 0
|
1679
1688
|
|
1680
|
-
|
|
1689
|
+
|text-indent
|
1681
1690
|
|<<measurement-units,Measurement>> +
|
1682
1691
|
(default: _not set_)
|
1683
1692
|
|prose:
|
1684
|
-
|
1693
|
+
text-indent: 18
|
1685
1694
|
|===
|
1686
1695
|
|
1687
1696
|
. Controls the margin between adjacent paragraphs.
|
@@ -1703,17 +1712,17 @@ The keys in this category control the spacing around block elements when a more
|
|
1703
1712
|
//|block:
|
1704
1713
|
// padding: [12, 15, 12, 15]
|
1705
1714
|
|
1706
|
-
|
|
1715
|
+
|margin-top
|
1707
1716
|
|<<measurement-units,Measurement>> +
|
1708
1717
|
(default: 0)
|
1709
1718
|
|block:
|
1710
|
-
|
1719
|
+
margin-top: 6
|
1711
1720
|
|
1712
|
-
|
|
1721
|
+
|margin-bottom
|
1713
1722
|
|<<measurement-units,Measurement>> +
|
1714
1723
|
(default: 12)
|
1715
1724
|
|block:
|
1716
|
-
|
1725
|
+
margin-bottom: 6
|
1717
1726
|
|===
|
1718
1727
|
|
1719
1728
|
Block styles are applied to the following block types:
|
@@ -1751,47 +1760,47 @@ The keys in this category control the arrangement and style of block captions.
|
|
1751
1760
|
|caption:
|
1752
1761
|
align: left
|
1753
1762
|
|
1754
|
-
|
|
1763
|
+
|font-color
|
1755
1764
|
|<<colors,Color>> +
|
1756
1765
|
(default: _inherit_)
|
1757
1766
|
|caption:
|
1758
|
-
|
1767
|
+
font-color: #333333
|
1759
1768
|
|
1760
|
-
|
|
1769
|
+
|font-family
|
1761
1770
|
|<<fonts,Font family name>> +
|
1762
1771
|
(default: _inherit_)
|
1763
1772
|
|caption:
|
1764
|
-
|
1773
|
+
font-family: M+ 1mn
|
1765
1774
|
|
1766
|
-
|
|
1775
|
+
|font-size
|
1767
1776
|
|<<values,Number>> +
|
1768
1777
|
(default: _inherit_)
|
1769
1778
|
|caption:
|
1770
|
-
|
1779
|
+
font-size: 11
|
1771
1780
|
|
1772
|
-
|
|
1781
|
+
|font-style
|
1773
1782
|
|<<font-styles,Font style>> +
|
1774
1783
|
(default: italic)
|
1775
1784
|
|caption:
|
1776
|
-
|
1785
|
+
font-style: italic
|
1777
1786
|
|
1778
|
-
|
|
1787
|
+
|text-transform
|
1779
1788
|
|<<text-transforms,Text transform>> +
|
1780
1789
|
(default: _inherit_)
|
1781
1790
|
|caption:
|
1782
|
-
|
1791
|
+
text-transform: uppercase
|
1783
1792
|
|
1784
|
-
|
|
1793
|
+
|margin-inside
|
1785
1794
|
|<<measurement-units,Measurement>> +
|
1786
1795
|
(default: 4)
|
1787
1796
|
|caption:
|
1788
|
-
|
1797
|
+
margin-inside: 3
|
1789
1798
|
|
1790
|
-
|
|
1799
|
+
|margin-outside
|
1791
1800
|
|<<measurement-units,Measurement>> +
|
1792
1801
|
(default: 0)
|
1793
1802
|
|caption:
|
1794
|
-
|
1803
|
+
margin-outside: 0
|
1795
1804
|
|===
|
1796
1805
|
|
1797
1806
|
[#keys-code]
|
@@ -1805,65 +1814,65 @@ The keys in this category are used to control the style of literal, listing and
|
|
1805
1814
|
|
1806
1815
|
3+|[#key-prefix-code]*Key Prefix:* <<key-prefix-code,code>>
|
1807
1816
|
|
1808
|
-
|
|
1817
|
+
|background-color
|
1809
1818
|
|<<colors,Color>> +
|
1810
1819
|
(default: _not set_)
|
1811
1820
|
|code:
|
1812
|
-
|
1821
|
+
background-color: #f5f5f5
|
1813
1822
|
|
1814
|
-
|
|
1823
|
+
|border-color
|
1815
1824
|
|<<colors,Color>> +
|
1816
1825
|
(default: #eeeeee)
|
1817
1826
|
|code:
|
1818
|
-
|
1827
|
+
border-color: #cccccc
|
1819
1828
|
|
1820
|
-
|
|
1829
|
+
|border-radius
|
1821
1830
|
|<<values,Number>> +
|
1822
1831
|
(default: _not set_)
|
1823
1832
|
|code:
|
1824
|
-
|
1833
|
+
border-radius: 4
|
1825
1834
|
|
1826
|
-
|
|
1835
|
+
|border-width
|
1827
1836
|
|<<values,Number>> +
|
1828
1837
|
(default: 0.5)
|
1829
1838
|
|code:
|
1830
|
-
|
1839
|
+
border-width: 0.75
|
1831
1840
|
|
1832
|
-
|
|
1841
|
+
|font-color
|
1833
1842
|
|<<colors,Color>> +
|
1834
1843
|
(default: _inherit_)
|
1835
1844
|
|code:
|
1836
|
-
|
1845
|
+
font-color: #333333
|
1837
1846
|
|
1838
|
-
|
|
1847
|
+
|font-family
|
1839
1848
|
|<<fonts,Font family name>> +
|
1840
1849
|
(default: Courier)
|
1841
1850
|
|code:
|
1842
|
-
|
1851
|
+
font-family: M+ 1mn
|
1843
1852
|
|
1844
|
-
|
|
1853
|
+
|font-size
|
1845
1854
|
|<<values,Number>> +
|
1846
1855
|
(default: 10.5)
|
1847
1856
|
|code:
|
1848
|
-
|
1857
|
+
font-size: 11
|
1849
1858
|
|
1850
|
-
|
|
1859
|
+
|font-style
|
1851
1860
|
|<<font-styles,Font style>> +
|
1852
1861
|
(default: _inherit_)
|
1853
1862
|
|code:
|
1854
|
-
|
1863
|
+
font-style: italic
|
1855
1864
|
|
1856
|
-
|
|
1865
|
+
|line-height
|
1857
1866
|
|<<values,Number>> +
|
1858
1867
|
(default: 1.2)
|
1859
1868
|
|code:
|
1860
|
-
|
1869
|
+
line-height: 1.25
|
1861
1870
|
|
1862
|
-
|
|
1871
|
+
|line-gap^[1]^
|
1863
1872
|
|<<values,Number>> +
|
1864
1873
|
(default: 0)
|
1865
1874
|
|code:
|
1866
|
-
|
1875
|
+
line-gap: 3.8
|
1867
1876
|
|
1868
1877
|
|padding
|
1869
1878
|
|<<measurement-units,Measurement>> {vbar} <<measurement-units,Measurement[top,right,bottom,left]>> +
|
@@ -1871,16 +1880,16 @@ The keys in this category are used to control the style of literal, listing and
|
|
1871
1880
|
|code:
|
1872
1881
|
padding: 11
|
1873
1882
|
|
1874
|
-
3+|[#key-prefix-table-cell]*Key Prefix:* <<key-prefix-code-linenum,
|
1883
|
+
3+|[#key-prefix-table-cell]*Key Prefix:* <<key-prefix-code-linenum,code-linenum>>^[2]^
|
1875
1884
|
|
1876
|
-
|
|
1885
|
+
|font-color
|
1877
1886
|
|<<colors,Color>> +
|
1878
1887
|
(default: #999999)
|
1879
1888
|
|code:
|
1880
|
-
|
1889
|
+
linenum-font-color: #ccc
|
1881
1890
|
|===
|
1882
|
-
. The
|
1883
|
-
. The
|
1891
|
+
. The line-gap property is used to tune the height of the background color applied to a span of block text highlighted using Rouge.
|
1892
|
+
. The code-linenum category only applies when using Pygments as the source highlighter.
|
1884
1893
|
Otherwise, the style is controlled by the source highlighter theme.
|
1885
1894
|
|
1886
1895
|
[#keys-callout-numbers]
|
@@ -1894,39 +1903,39 @@ The keys in this category are used to control the style of callout numbers (conu
|
|
1894
1903
|
|
1895
1904
|
3+|[#key-prefix-conum]*Key Prefix:* <<key-prefix-conum,conum>>
|
1896
1905
|
|
1897
|
-
|
|
1906
|
+
|font-color
|
1898
1907
|
|<<colors,Color>> +
|
1899
1908
|
(default: _inherit_)
|
1900
1909
|
|conum:
|
1901
|
-
|
1910
|
+
font-color: #b12146
|
1902
1911
|
|
1903
|
-
|
|
1912
|
+
|font-family^[1,2]^
|
1904
1913
|
|<<fonts,Font family name>> +
|
1905
1914
|
(default: _inherit_)
|
1906
1915
|
|conum:
|
1907
|
-
|
1916
|
+
font-family: M+ 1mn
|
1908
1917
|
|
1909
|
-
|
|
1918
|
+
|font-size^[2]^
|
1910
1919
|
|<<values,Number>> +
|
1911
1920
|
(default: _inherit_)
|
1912
1921
|
|conum:
|
1913
|
-
|
1922
|
+
font-size: $base-font-size
|
1914
1923
|
|
1915
|
-
|
|
1924
|
+
|font-style^[2]^
|
1916
1925
|
|<<font-styles,Font style>> +
|
1917
1926
|
(default: _inherit_)
|
1918
1927
|
|conum:
|
1919
|
-
|
1928
|
+
font-style: normal
|
1920
1929
|
|
1921
|
-
|
|
1930
|
+
|line-height^[2]^
|
1922
1931
|
|<<values,Number>> +
|
1923
1932
|
(default: 1.15)
|
1924
1933
|
|conum:
|
1925
|
-
|
1934
|
+
line-height: 4 / 3
|
1926
1935
|
|===
|
1927
1936
|
|
1928
1937
|
. Currently, the font must contain the circle numbers starting at glyph U+2460.
|
1929
|
-
.
|
1938
|
+
. font-family, font-size, font-style, and line-height are only used for markers in a colist.
|
1930
1939
|
These properties are inherited for conums inside a verbatim block.
|
1931
1940
|
|
1932
1941
|
[#keys-menu]
|
@@ -1940,11 +1949,11 @@ The keys in this category apply to the menu label (generated from the inline men
|
|
1940
1949
|
|
1941
1950
|
3+|[#key-prefix-menu]*Key Prefix:* <<key-prefix-menu,menu>>
|
1942
1951
|
|
1943
|
-
|
|
1952
|
+
|caret-content
|
1944
1953
|
|<<quoted-string,Quoted string>> +
|
1945
1954
|
(default: " \u203a ")
|
1946
1955
|
|menu:
|
1947
|
-
|
1956
|
+
caret-content: ' > '
|
1948
1957
|
|===
|
1949
1958
|
|
1950
1959
|
[#keys-blockquote]
|
@@ -1958,47 +1967,47 @@ The keys in this category control the arrangement and style of quote blocks.
|
|
1958
1967
|
|
1959
1968
|
3+|[#key-prefix-blockquote]*Key Prefix:* <<key-prefix-blockquote,blockquote>>
|
1960
1969
|
|
1961
|
-
|
|
1970
|
+
|border-width^[1]^
|
1962
1971
|
|<<values,Number>> +
|
1963
1972
|
(default: 4)
|
1964
1973
|
|blockquote:
|
1965
|
-
|
1974
|
+
border-width: 5
|
1966
1975
|
|
1967
|
-
|
|
1976
|
+
|border-color^[1]^
|
1968
1977
|
|<<colors,Color>> +
|
1969
1978
|
(default: #eeeeee)
|
1970
1979
|
|blockquote:
|
1971
|
-
|
1980
|
+
border-color: #eeeeee
|
1972
1981
|
|
1973
|
-
|
|
1982
|
+
|font-color
|
1974
1983
|
|<<colors,Color>> +
|
1975
1984
|
(default: _inherit_)
|
1976
1985
|
|blockquote:
|
1977
|
-
|
1986
|
+
font-color: #333333
|
1978
1987
|
|
1979
|
-
|
|
1988
|
+
|font-family
|
1980
1989
|
|<<fonts,Font family name>> +
|
1981
1990
|
(default: _inherit_)
|
1982
1991
|
|blockquote:
|
1983
|
-
|
1992
|
+
font-family: Noto Serif
|
1984
1993
|
|
1985
|
-
|
|
1994
|
+
|font-size
|
1986
1995
|
|<<values,Number>> +
|
1987
1996
|
(default: _inherit_)
|
1988
1997
|
|blockquote:
|
1989
|
-
|
1998
|
+
font-size: 13
|
1990
1999
|
|
1991
|
-
|
|
2000
|
+
|font-style
|
1992
2001
|
|<<font-styles,Font style>> +
|
1993
2002
|
(default: _inherit_)
|
1994
2003
|
|blockquote:
|
1995
|
-
|
2004
|
+
font-style: bold
|
1996
2005
|
|
1997
|
-
|
|
2006
|
+
|text-transform
|
1998
2007
|
|<<text-transforms,Text transform>> +
|
1999
2008
|
(default: _inherit_)
|
2000
2009
|
|blockquote:
|
2001
|
-
|
2010
|
+
text-transform: uppercase
|
2002
2011
|
|
2003
2012
|
|padding
|
2004
2013
|
|<<measurement-units,Measurement>> {vbar} <<measurement-units,Measurement[top,right,bottom,left]>> +
|
@@ -2006,42 +2015,42 @@ The keys in this category control the arrangement and style of quote blocks.
|
|
2006
2015
|
|blockquote:
|
2007
2016
|
padding: [5, 10, -5, 12]
|
2008
2017
|
|
2009
|
-
3+|[#key-prefix-blockquote-cite]*Key Prefix:* <<key-prefix-blockquote-cite,
|
2018
|
+
3+|[#key-prefix-blockquote-cite]*Key Prefix:* <<key-prefix-blockquote-cite,blockquote-cite>>
|
2010
2019
|
|
2011
|
-
|
|
2020
|
+
|font-size
|
2012
2021
|
|<<values,Number>> +
|
2013
2022
|
(default: _inherit_)
|
2014
2023
|
|blockquote:
|
2015
2024
|
cite:
|
2016
|
-
|
2025
|
+
font-size: 9
|
2017
2026
|
|
2018
|
-
|
|
2027
|
+
|font-color
|
2019
2028
|
|<<colors,Color>> +
|
2020
2029
|
(default: _inherit_)
|
2021
2030
|
|blockquote:
|
2022
2031
|
cite:
|
2023
|
-
|
2032
|
+
font-color: #999999
|
2024
2033
|
|
2025
|
-
|
|
2034
|
+
|font-family
|
2026
2035
|
|<<fonts,Font family name>> +
|
2027
2036
|
(default: _inherit_)
|
2028
2037
|
|blockquote:
|
2029
2038
|
cite:
|
2030
|
-
|
2039
|
+
font-family: Noto Serif
|
2031
2040
|
|
2032
|
-
|
|
2041
|
+
|font-style
|
2033
2042
|
|<<font-styles,Font style>> +
|
2034
2043
|
(default: _inherit_)
|
2035
2044
|
|blockquote:
|
2036
2045
|
cite:
|
2037
|
-
|
2046
|
+
font-style: bold
|
2038
2047
|
|
2039
|
-
|
|
2048
|
+
|text-transform
|
2040
2049
|
|<<text-transforms,Text transform>> +
|
2041
2050
|
(default: _inherit_)
|
2042
2051
|
|blockquote:
|
2043
2052
|
cite:
|
2044
|
-
|
2053
|
+
text-transform: uppercase
|
2045
2054
|
|===
|
2046
2055
|
|
2047
2056
|
. Only applies to the left side.
|
@@ -2057,59 +2066,59 @@ The keys in this category control the arrangement and style of sidebar blocks.
|
|
2057
2066
|
|
2058
2067
|
3+|[#key-prefix-sidebar]*Key Prefix:* <<key-prefix-sidebar,sidebar>>
|
2059
2068
|
|
2060
|
-
|
|
2069
|
+
|background-color
|
2061
2070
|
|<<colors,Color>> +
|
2062
2071
|
(default: #eeeeee)
|
2063
2072
|
|sidebar:
|
2064
|
-
|
2073
|
+
background-color: #eeeeee
|
2065
2074
|
|
2066
|
-
|
|
2075
|
+
|border-color
|
2067
2076
|
|<<colors,Color>> +
|
2068
2077
|
(default: _not set_)
|
2069
2078
|
|sidebar:
|
2070
|
-
|
2079
|
+
border-color: #ffffff
|
2071
2080
|
|
2072
|
-
|
|
2081
|
+
|border-radius
|
2073
2082
|
|<<values,Number>> +
|
2074
2083
|
(default: _not set_)
|
2075
2084
|
|sidebar:
|
2076
|
-
|
2085
|
+
border-radius: 4
|
2077
2086
|
|
2078
|
-
|
|
2087
|
+
|border-width
|
2079
2088
|
|<<values,Number>> +
|
2080
2089
|
(default: _not set_)
|
2081
2090
|
|sidebar:
|
2082
|
-
|
2091
|
+
border-width: 0.5
|
2083
2092
|
|
2084
|
-
|
|
2093
|
+
|font-color
|
2085
2094
|
|<<colors,Color>> +
|
2086
2095
|
(default: _inherit_)
|
2087
2096
|
|sidebar:
|
2088
|
-
|
2097
|
+
font-color: #262626
|
2089
2098
|
|
2090
|
-
|
|
2099
|
+
|font-family
|
2091
2100
|
|<<fonts,Font family name>> +
|
2092
2101
|
(default: _inherit_)
|
2093
2102
|
|sidebar:
|
2094
|
-
|
2103
|
+
font-family: M+ 1p
|
2095
2104
|
|
2096
|
-
|
|
2105
|
+
|font-size
|
2097
2106
|
|<<values,Number>> +
|
2098
2107
|
(default: _inherit_)
|
2099
2108
|
|sidebar:
|
2100
|
-
|
2109
|
+
font-size: 13
|
2101
2110
|
|
2102
|
-
|
|
2111
|
+
|font-style
|
2103
2112
|
|<<font-styles,Font style>> +
|
2104
2113
|
(default: _inherit_)
|
2105
2114
|
|sidebar:
|
2106
|
-
|
2115
|
+
font-style: italic
|
2107
2116
|
|
2108
|
-
|
|
2117
|
+
|text-transform
|
2109
2118
|
|<<text-transforms,Text transform>> +
|
2110
2119
|
(default: _inherit_)
|
2111
2120
|
|sidebar:
|
2112
|
-
|
2121
|
+
text-transform: uppercase
|
2113
2122
|
|
2114
2123
|
|padding
|
2115
2124
|
|<<measurement-units,Measurement>> {vbar} <<measurement-units,Measurement[top,right,bottom,left]>> +
|
@@ -2117,7 +2126,7 @@ The keys in this category control the arrangement and style of sidebar blocks.
|
|
2117
2126
|
|sidebar:
|
2118
2127
|
padding: [12, 15, 0, 15]
|
2119
2128
|
|
2120
|
-
3+|[#key-prefix-sidebar-title]*Key Prefix:* <<key-prefix-sidebar-title,
|
2129
|
+
3+|[#key-prefix-sidebar-title]*Key Prefix:* <<key-prefix-sidebar-title,sidebar-title>>
|
2121
2130
|
|
2122
2131
|
|align
|
2123
2132
|
|<<text-alignments,Text alignment>> +
|
@@ -2126,40 +2135,40 @@ The keys in this category control the arrangement and style of sidebar blocks.
|
|
2126
2135
|
title:
|
2127
2136
|
align: center
|
2128
2137
|
|
2129
|
-
|
|
2138
|
+
|font-color
|
2130
2139
|
|<<colors,Color>> +
|
2131
2140
|
(default: _inherit_)
|
2132
2141
|
|sidebar:
|
2133
2142
|
title:
|
2134
|
-
|
2143
|
+
font-color: #333333
|
2135
2144
|
|
2136
|
-
|
|
2145
|
+
|font-family
|
2137
2146
|
|<<fonts,Font family name>> +
|
2138
2147
|
(default: _inherit_)
|
2139
2148
|
|sidebar:
|
2140
2149
|
title:
|
2141
|
-
|
2150
|
+
font-family: Noto Serif
|
2142
2151
|
|
2143
|
-
|
|
2152
|
+
|font-size
|
2144
2153
|
|<<values,Number>> +
|
2145
2154
|
(default: _inherit_)
|
2146
2155
|
|sidebar:
|
2147
2156
|
title:
|
2148
|
-
|
2157
|
+
font-size: 13
|
2149
2158
|
|
2150
|
-
|
|
2159
|
+
|font-style
|
2151
2160
|
|<<font-styles,Font style>> +
|
2152
2161
|
(default: bold)
|
2153
2162
|
|sidebar:
|
2154
2163
|
title:
|
2155
|
-
|
2164
|
+
font-style: bold
|
2156
2165
|
|
2157
|
-
|
|
2166
|
+
|text-transform
|
2158
2167
|
|<<text-transforms,Text transform>> +
|
2159
2168
|
(default: _inherit_)
|
2160
2169
|
|sidebar:
|
2161
2170
|
title:
|
2162
|
-
|
2171
|
+
text-transform: uppercase
|
2163
2172
|
|===
|
2164
2173
|
|
2165
2174
|
[#keys-example]
|
@@ -2173,59 +2182,59 @@ The keys in this category control the arrangement and style of example blocks.
|
|
2173
2182
|
|
2174
2183
|
3+|[#key-prefix-example]*Key Prefix:* <<key-prefix-example,example>>
|
2175
2184
|
|
2176
|
-
|
|
2185
|
+
|background-color
|
2177
2186
|
|<<colors,Color>> +
|
2178
2187
|
(default: #ffffff)
|
2179
2188
|
|example:
|
2180
|
-
|
2189
|
+
background-color: #fffef7
|
2181
2190
|
|
2182
|
-
|
|
2191
|
+
|border-color
|
2183
2192
|
|<<colors,Color>> +
|
2184
2193
|
(default: #eeeeee)
|
2185
2194
|
|example:
|
2186
|
-
|
2195
|
+
border-color: #eeeeee
|
2187
2196
|
|
2188
|
-
|
|
2197
|
+
|border-radius
|
2189
2198
|
|<<values,Number>> +
|
2190
2199
|
(default: _not set_)
|
2191
2200
|
|example:
|
2192
|
-
|
2201
|
+
border-radius: 4
|
2193
2202
|
|
2194
|
-
|
|
2203
|
+
|border-width
|
2195
2204
|
|<<values,Number>> +
|
2196
2205
|
(default: 0.5)
|
2197
2206
|
|example:
|
2198
|
-
|
2207
|
+
border-width: 0.75
|
2199
2208
|
|
2200
|
-
|
|
2209
|
+
|font-color
|
2201
2210
|
|<<colors,Color>> +
|
2202
2211
|
(default: _inherit_)
|
2203
2212
|
|example:
|
2204
|
-
|
2213
|
+
font-color: #262626
|
2205
2214
|
|
2206
|
-
|
|
2215
|
+
|font-family
|
2207
2216
|
|<<fonts,Font family name>> +
|
2208
2217
|
(default: _inherit_)
|
2209
2218
|
|example:
|
2210
|
-
|
2219
|
+
font-family: M+ 1p
|
2211
2220
|
|
2212
|
-
|
|
2221
|
+
|font-size
|
2213
2222
|
|<<values,Number>> +
|
2214
2223
|
(default: _inherit_)
|
2215
2224
|
|example:
|
2216
|
-
|
2225
|
+
font-size: 13
|
2217
2226
|
|
2218
|
-
|
|
2227
|
+
|font-style
|
2219
2228
|
|<<font-styles,Font style>> +
|
2220
2229
|
(default: _inherit_)
|
2221
2230
|
|example:
|
2222
|
-
|
2231
|
+
font-style: italic
|
2223
2232
|
|
2224
|
-
|
|
2233
|
+
|text-transform
|
2225
2234
|
|<<text-transforms,Text transform>> +
|
2226
2235
|
(default: _inherit_)
|
2227
2236
|
|example:
|
2228
|
-
|
2237
|
+
text-transform: uppercase
|
2229
2238
|
|
2230
2239
|
|padding
|
2231
2240
|
|<<measurement-units,Measurement>> {vbar} <<measurement-units,Measurement[top,right,bottom,left]>> +
|
@@ -2245,53 +2254,53 @@ The keys in this category control the arrangement and style of admonition blocks
|
|
2245
2254
|
|
2246
2255
|
3+|[#key-prefix-admonition]*Key Prefix:* <<key-prefix-admonition,admonition>>
|
2247
2256
|
|
2248
|
-
|
|
2257
|
+
|column-rule-color
|
2249
2258
|
|<<colors,Color>> +
|
2250
2259
|
(default: #eeeeee)
|
2251
2260
|
|admonition:
|
2252
|
-
|
2261
|
+
column-rule-color: #aa0000
|
2253
2262
|
|
2254
|
-
|
|
2263
|
+
|column-rule-style
|
2255
2264
|
|solid {vbar} double {vbar} dashed {vbar} dotted +
|
2256
2265
|
(default: solid)
|
2257
2266
|
|admonition:
|
2258
|
-
|
2267
|
+
column-rule-style: double
|
2259
2268
|
|
2260
|
-
|
|
2269
|
+
|column-rule-width
|
2261
2270
|
|<<values,Number>> +
|
2262
2271
|
(default: 0.5)
|
2263
2272
|
|admonition:
|
2264
|
-
|
2273
|
+
column-rule-width: 0.5
|
2265
2274
|
|
2266
|
-
|
|
2275
|
+
|font-color
|
2267
2276
|
|<<colors,Color>> +
|
2268
2277
|
(default: _inherit_)
|
2269
2278
|
|admonition:
|
2270
|
-
|
2279
|
+
font-color: #999999
|
2271
2280
|
|
2272
|
-
|
|
2281
|
+
|font-family
|
2273
2282
|
|<<fonts,Font family name>> +
|
2274
2283
|
(default: _inherit_)
|
2275
2284
|
|admonition:
|
2276
|
-
|
2285
|
+
font-family: Noto Sans
|
2277
2286
|
|
2278
|
-
|
|
2287
|
+
|font-size
|
2279
2288
|
|<<values,Number>> +
|
2280
2289
|
(default: _inherit_)
|
2281
2290
|
|admonition:
|
2282
|
-
|
2291
|
+
font-size: $base-font-size-large
|
2283
2292
|
|
2284
|
-
|
|
2293
|
+
|font-style
|
2285
2294
|
|<<font-styles,Font style>> +
|
2286
2295
|
(default: _inherit_)
|
2287
2296
|
|admonition:
|
2288
|
-
|
2297
|
+
font-style: italic
|
2289
2298
|
|
2290
|
-
|
|
2299
|
+
|text-transform
|
2291
2300
|
|<<text-transforms,Text transform>> +
|
2292
2301
|
(default: _inherit_)
|
2293
2302
|
|admonition:
|
2294
|
-
|
2303
|
+
text-transform: none
|
2295
2304
|
|
2296
2305
|
|padding
|
2297
2306
|
|<<measurement-units,Measurement>> {vbar} <<measurement-units,Measurement[top,right,bottom,left]>> +
|
@@ -2299,7 +2308,7 @@ The keys in this category control the arrangement and style of admonition blocks
|
|
2299
2308
|
|admonition:
|
2300
2309
|
padding: [0, 12, 0, 12]
|
2301
2310
|
|
2302
|
-
3+|[#key-prefix-admonition-label]*Key Prefix:* <<key-prefix-admonition-label,
|
2311
|
+
3+|[#key-prefix-admonition-label]*Key Prefix:* <<key-prefix-admonition-label,admonition-label>>
|
2303
2312
|
|
2304
2313
|
|align
|
2305
2314
|
|<<text-alignments,Text alignment>> +
|
@@ -2308,64 +2317,64 @@ The keys in this category control the arrangement and style of admonition blocks
|
|
2308
2317
|
label:
|
2309
2318
|
align: center
|
2310
2319
|
|
2311
|
-
|
|
2320
|
+
|min-width
|
2312
2321
|
|<<measurement-units,Measurement>> +
|
2313
2322
|
(default: _not set_)
|
2314
2323
|
|admonition:
|
2315
2324
|
label:
|
2316
|
-
|
2325
|
+
min-width: 48
|
2317
2326
|
|
2318
2327
|
|padding^[1]^
|
2319
2328
|
|<<measurement-units,Measurement>> {vbar} <<measurement-units,Measurement[top,right,bottom,left]>> +
|
2320
|
-
(default: $
|
2329
|
+
(default: $admonition-padding)
|
2321
2330
|
|admonition:
|
2322
2331
|
padding: [0, 12, 0, 12]
|
2323
2332
|
|
2324
|
-
|
|
2333
|
+
|vertical-align
|
2325
2334
|
|top {vbar} middle {vbar} bottom +
|
2326
2335
|
(default: middle)
|
2327
2336
|
|admonition:
|
2328
2337
|
label:
|
2329
|
-
|
2338
|
+
vertical-align: top
|
2330
2339
|
|
2331
|
-
3+|*Key Prefix:*
|
2340
|
+
3+|*Key Prefix:* admonition-label, admonition-label-<name>^[2]^
|
2332
2341
|
|
2333
|
-
|
|
2342
|
+
|font-color
|
2334
2343
|
|<<colors,Color>> +
|
2335
2344
|
(default: _inherit_)
|
2336
2345
|
|admonition:
|
2337
2346
|
label:
|
2338
|
-
|
2347
|
+
font-color: #262626
|
2339
2348
|
|
2340
|
-
|
|
2349
|
+
|font-family
|
2341
2350
|
|<<fonts,Font family name>> +
|
2342
2351
|
(default: _inherit_)
|
2343
2352
|
|admonition:
|
2344
2353
|
label:
|
2345
|
-
|
2354
|
+
font-family: M+ 1p
|
2346
2355
|
|
2347
|
-
|
|
2356
|
+
|font-size
|
2348
2357
|
|<<values,Number>> +
|
2349
2358
|
(default: _inherit_)
|
2350
2359
|
|admonition:
|
2351
2360
|
label:
|
2352
|
-
|
2361
|
+
font-size: 12
|
2353
2362
|
|
2354
|
-
|
|
2363
|
+
|font-style
|
2355
2364
|
|<<font-styles,Font style>> +
|
2356
2365
|
(default: bold)
|
2357
2366
|
|admonition:
|
2358
2367
|
label:
|
2359
|
-
|
2368
|
+
font-style: bold_italic
|
2360
2369
|
|
2361
|
-
|
|
2370
|
+
|text-transform
|
2362
2371
|
|<<text-transforms,Text transform>> +
|
2363
2372
|
(default: uppercase)
|
2364
2373
|
|admonition:
|
2365
2374
|
label:
|
2366
|
-
|
2375
|
+
text-transform: lowercase
|
2367
2376
|
|
2368
|
-
3+|[#key-prefix-admonition-icon]*Key Prefix:* <<key-prefix-admonition-icon,
|
2377
|
+
3+|[#key-prefix-admonition-icon]*Key Prefix:* <<key-prefix-admonition-icon,admonition-icon-<name> >>^[2]^
|
2369
2378
|
|
2370
2379
|
|name
|
2371
2380
|
|<icon set>-<icon name>^[3]^ +
|
@@ -2375,13 +2384,13 @@ The keys in this category control the arrangement and style of admonition blocks
|
|
2375
2384
|
tip:
|
2376
2385
|
name: fas-fire
|
2377
2386
|
|
2378
|
-
|
|
2387
|
+
|stroke-color
|
2379
2388
|
|<<colors,Color>> +
|
2380
2389
|
(default: caution=#bf3400; important=#bf0000; note=#19407c; tip=#111111; warning=#bf6900)
|
2381
2390
|
|admonition:
|
2382
2391
|
icon:
|
2383
2392
|
important:
|
2384
|
-
|
2393
|
+
stroke-color: ff0000
|
2385
2394
|
|
2386
2395
|
|size
|
2387
2396
|
|<<values,Number>> +
|
@@ -2392,9 +2401,9 @@ The keys in this category control the arrangement and style of admonition blocks
|
|
2392
2401
|
size: 24
|
2393
2402
|
|===
|
2394
2403
|
|
2395
|
-
. The top and bottom padding values are ignored on
|
2404
|
+
. The top and bottom padding values are ignored on admonition-label-padding.
|
2396
2405
|
. `<name>` can be `note`, `tip`, `warning`, `important`, or `caution`.
|
2397
|
-
The subkeys in the icon category cannot be flattened (e.g., `
|
2406
|
+
The subkeys in the icon category cannot be flattened (e.g., `tip-name: far-lightbulb` is not valid syntax).
|
2398
2407
|
. Required.
|
2399
2408
|
See the `.yml` files in the https://github.com/jessedoyle/prawn-icon/tree/master/data/fonts[prawn-icon repository] for a list of valid icon names.
|
2400
2409
|
The prefix (e.g., `fas-`) determines which font set to use.
|
@@ -2437,41 +2446,41 @@ The keys in this category control the styling of lead paragraphs.
|
|
2437
2446
|
|
2438
2447
|
3+|[#key-prefix-lead]*Key Prefix:* <<key-prefix-lead,lead>>
|
2439
2448
|
|
2440
|
-
|
|
2449
|
+
|font-color
|
2441
2450
|
|<<colors,Color>> +
|
2442
2451
|
(default: _inherit_)
|
2443
2452
|
|lead:
|
2444
|
-
|
2453
|
+
font-color: #262626
|
2445
2454
|
|
2446
|
-
|
|
2455
|
+
|font-family
|
2447
2456
|
|<<fonts,Font family name>> +
|
2448
2457
|
(default: _inherit_)
|
2449
2458
|
|lead:
|
2450
|
-
|
2459
|
+
font-family: M+ 1p
|
2451
2460
|
|
2452
|
-
|
|
2461
|
+
|font-size
|
2453
2462
|
|<<values,Number>> +
|
2454
2463
|
(default: 13.5)
|
2455
2464
|
|lead:
|
2456
|
-
|
2465
|
+
font-size: 13
|
2457
2466
|
|
2458
|
-
|
|
2467
|
+
|font-style
|
2459
2468
|
|<<font-styles,Font style>> +
|
2460
2469
|
(default: _inherit_)
|
2461
2470
|
|lead:
|
2462
|
-
|
2471
|
+
font-style: bold
|
2463
2472
|
|
2464
|
-
|
|
2473
|
+
|text-transform
|
2465
2474
|
|<<text-transforms,Text transform>> +
|
2466
2475
|
(default: _inherit_)
|
2467
2476
|
|lead:
|
2468
|
-
|
2477
|
+
text-transform: uppercase
|
2469
2478
|
|
2470
|
-
|
|
2479
|
+
|line-height
|
2471
2480
|
|<<values,Number>> +
|
2472
2481
|
(default: 1.4)
|
2473
2482
|
|lead:
|
2474
|
-
|
2483
|
+
line-height: 1.4
|
2475
2484
|
|===
|
2476
2485
|
|
2477
2486
|
[#keys-abstract]
|
@@ -2485,35 +2494,35 @@ The keys in this category control the arrangement and style of the abstract.
|
|
2485
2494
|
|
2486
2495
|
3+|[#key-prefix-abstract]*Key Prefix:* <<key-prefix-abstract,abstract>>
|
2487
2496
|
|
2488
|
-
|
|
2497
|
+
|font-color
|
2489
2498
|
|<<colors,Color>> +
|
2490
|
-
(default: $
|
2499
|
+
(default: $base-font-color)
|
2491
2500
|
|abstract:
|
2492
|
-
|
2501
|
+
font-color: #5c6266
|
2493
2502
|
|
2494
|
-
|
|
2503
|
+
|font-size
|
2495
2504
|
|<<values,Number>> +
|
2496
2505
|
(default: 13.5)
|
2497
2506
|
|abstract:
|
2498
|
-
|
2507
|
+
font-size: 13
|
2499
2508
|
|
2500
|
-
|
|
2509
|
+
|font-style
|
2501
2510
|
|<<font-styles,Font style>> +
|
2502
|
-
(default: $
|
2511
|
+
(default: $base-font-style)
|
2503
2512
|
|abstract:
|
2504
|
-
|
2513
|
+
font-style: italic
|
2505
2514
|
|
2506
|
-
|
|
2515
|
+
|text-transform
|
2507
2516
|
|<<text-transforms,Text transform>> +
|
2508
|
-
(default: $
|
2517
|
+
(default: $base-text-transform)
|
2509
2518
|
|abstract:
|
2510
|
-
|
2519
|
+
text-transform: uppercase
|
2511
2520
|
|
2512
|
-
|
|
2521
|
+
|line-height
|
2513
2522
|
|<<values,Number>> +
|
2514
2523
|
(default: 1.4)
|
2515
2524
|
|abstract:
|
2516
|
-
|
2525
|
+
line-height: 1.4
|
2517
2526
|
|
2518
2527
|
|padding
|
2519
2528
|
|<<measurement-units,Measurement>> {vbar} <<measurement-units,Measurement[top,right,bottom,left]>> +
|
@@ -2521,7 +2530,7 @@ The keys in this category control the arrangement and style of the abstract.
|
|
2521
2530
|
|abstract:
|
2522
2531
|
padding: [0, 12, 0, 12]
|
2523
2532
|
|
2524
|
-
3+|[#key-prefix-abstract-title]*Key Prefix:* <<key-prefix-abstract-title,
|
2533
|
+
3+|[#key-prefix-abstract-title]*Key Prefix:* <<key-prefix-abstract-title,abstract-title>>
|
2525
2534
|
|
2526
2535
|
|align
|
2527
2536
|
|<<text-alignments,Text alignment>> +
|
@@ -2530,40 +2539,40 @@ The keys in this category control the arrangement and style of the abstract.
|
|
2530
2539
|
title:
|
2531
2540
|
align: center
|
2532
2541
|
|
2533
|
-
|
|
2542
|
+
|font-color
|
2534
2543
|
|<<colors,Color>> +
|
2535
|
-
(default: $
|
2544
|
+
(default: $base-font-color)
|
2536
2545
|
|abstract:
|
2537
2546
|
title:
|
2538
|
-
|
2547
|
+
font-color: #333333
|
2539
2548
|
|
2540
|
-
|
|
2549
|
+
|font-family
|
2541
2550
|
|<<fonts,Font family name>> +
|
2542
|
-
(default: $
|
2551
|
+
(default: $base-font-family)
|
2543
2552
|
|abstract:
|
2544
2553
|
title:
|
2545
|
-
|
2554
|
+
font-family: Noto Serif
|
2546
2555
|
|
2547
|
-
|
|
2556
|
+
|font-size
|
2548
2557
|
|<<values,Number>> +
|
2549
|
-
(default: $
|
2558
|
+
(default: $base-font-size)
|
2550
2559
|
|abstract:
|
2551
2560
|
title:
|
2552
|
-
|
2561
|
+
font-size: 13
|
2553
2562
|
|
2554
|
-
|
|
2563
|
+
|font-style
|
2555
2564
|
|<<font-styles,Font style>> +
|
2556
2565
|
(default: bold)
|
2557
2566
|
|abstract:
|
2558
2567
|
title:
|
2559
|
-
|
2568
|
+
font-style: bold
|
2560
2569
|
|
2561
|
-
|
|
2570
|
+
|text-transform
|
2562
2571
|
|<<text-transforms,Text transform>> +
|
2563
|
-
(default: $
|
2572
|
+
(default: $base-text-transform)
|
2564
2573
|
|abstract:
|
2565
2574
|
title:
|
2566
|
-
|
2575
|
+
text-transform: uppercase
|
2567
2576
|
|===
|
2568
2577
|
|
2569
2578
|
[#keys-thematic-break]
|
@@ -2575,37 +2584,37 @@ The keys in this category control the style of thematic breaks (aka horizontal r
|
|
2575
2584
|
|===
|
2576
2585
|
|Key |Value Type |Example
|
2577
2586
|
|
2578
|
-
3+|[#key-prefix-thematic-break]*Key Prefix:* <<key-prefix-thematic-break,
|
2587
|
+
3+|[#key-prefix-thematic-break]*Key Prefix:* <<key-prefix-thematic-break,thematic-break>>
|
2579
2588
|
|
2580
|
-
|
|
2589
|
+
|border-color
|
2581
2590
|
|<<colors,Color>> +
|
2582
2591
|
(default: #eeeeee)
|
2583
|
-
|
|
2584
|
-
|
2592
|
+
|thematic-break:
|
2593
|
+
border-color: #eeeeee
|
2585
2594
|
|
2586
|
-
|
|
2595
|
+
|border-style
|
2587
2596
|
|solid {vbar} double {vbar} dashed {vbar} dotted +
|
2588
2597
|
(default: solid)
|
2589
|
-
|
|
2590
|
-
|
2598
|
+
|thematic-break:
|
2599
|
+
border-style: dashed
|
2591
2600
|
|
2592
|
-
|
|
2601
|
+
|border-width
|
2593
2602
|
|<<measurement-units,Measurement>> +
|
2594
2603
|
(default: 0.5)
|
2595
|
-
|
|
2596
|
-
|
2604
|
+
|thematic-break:
|
2605
|
+
border-width: 0.5
|
2597
2606
|
|
2598
|
-
|
|
2607
|
+
|margin-top
|
2599
2608
|
|<<measurement-units,Measurement>> +
|
2600
2609
|
(default: 0)
|
2601
|
-
|
|
2602
|
-
|
2610
|
+
|thematic-break:
|
2611
|
+
margin-top: 6
|
2603
2612
|
|
2604
|
-
|
|
2613
|
+
|margin-bottom
|
2605
2614
|
|<<measurement-units,Measurement>> +
|
2606
|
-
(default: $
|
2607
|
-
|
|
2608
|
-
|
2615
|
+
(default: $vertical-spacing)
|
2616
|
+
|thematic-break:
|
2617
|
+
margin-bottom: 18
|
2609
2618
|
|===
|
2610
2619
|
|
2611
2620
|
[#keys-description-list]
|
@@ -2617,25 +2626,25 @@ The keys in this category control the arrangement and style of definition list i
|
|
2617
2626
|
|===
|
2618
2627
|
|Key |Value Type |Example
|
2619
2628
|
|
2620
|
-
3+|[#key-prefix-description-list]*Key Prefix:* <<key-prefix-description-list,
|
2629
|
+
3+|[#key-prefix-description-list]*Key Prefix:* <<key-prefix-description-list,description-list>>
|
2621
2630
|
|
2622
|
-
|
|
2631
|
+
|term-font-style
|
2623
2632
|
|<<font-styles,Font style>> +
|
2624
2633
|
(default: bold)
|
2625
|
-
|
|
2626
|
-
|
2634
|
+
|description-list:
|
2635
|
+
term-font-style: italic
|
2627
2636
|
|
2628
|
-
|
|
2637
|
+
|term-spacing
|
2629
2638
|
|<<measurement-units,Measurement>> +
|
2630
2639
|
(default: 4)
|
2631
|
-
|
|
2632
|
-
|
2640
|
+
|description-list:
|
2641
|
+
term-spacing: 5
|
2633
2642
|
|
2634
|
-
|
|
2643
|
+
|description-indent
|
2635
2644
|
|<<values,Number>> +
|
2636
2645
|
(default: 30)
|
2637
|
-
|
|
2638
|
-
|
2646
|
+
|description-list:
|
2647
|
+
description-indent: 15
|
2639
2648
|
|===
|
2640
2649
|
|
2641
2650
|
[#keys-outline-list]
|
@@ -2647,31 +2656,31 @@ The keys in this category control the arrangement and style of outline list item
|
|
2647
2656
|
|===
|
2648
2657
|
|Key |Value Type |Example
|
2649
2658
|
|
2650
|
-
3+|[#key-prefix-outline-list]*Key Prefix:* <<key-prefix-outline-list,
|
2659
|
+
3+|[#key-prefix-outline-list]*Key Prefix:* <<key-prefix-outline-list,outline-list>>
|
2651
2660
|
|
2652
2661
|
|indent
|
2653
2662
|
|<<measurement-units,Measurement>> +
|
2654
2663
|
(default: 30)
|
2655
|
-
|
|
2664
|
+
|outline-list:
|
2656
2665
|
indent: 40
|
2657
2666
|
|
2658
|
-
|
|
2667
|
+
|item-spacing
|
2659
2668
|
|<<measurement-units,Measurement>> +
|
2660
2669
|
(default: 6)
|
2661
|
-
|
|
2662
|
-
|
2670
|
+
|outline-list:
|
2671
|
+
item-spacing: 4
|
2663
2672
|
|
2664
|
-
|
|
2673
|
+
|marker-font-color^[1]^
|
2665
2674
|
|<<colors,Color>> +
|
2666
2675
|
(default: _inherit_)
|
2667
|
-
|
|
2668
|
-
|
2676
|
+
|outline-list:
|
2677
|
+
marker-font-color: #3c763d
|
2669
2678
|
|
2670
|
-
|
|
2679
|
+
|text-align^[2]^
|
2671
2680
|
|<<text-alignments,Text alignment>> +
|
2672
|
-
(default: $
|
2673
|
-
|
|
2674
|
-
|
2681
|
+
(default: $base-align)
|
2682
|
+
|outline-list:
|
2683
|
+
text-align: left
|
2675
2684
|
|===
|
2676
2685
|
|
2677
2686
|
. Controls the color of the bullet glyph that marks items in unordered lists and the number for items in ordered lists.
|
@@ -2686,42 +2695,42 @@ The keys in this category control the arrangement and style of unordered list it
|
|
2686
2695
|
|===
|
2687
2696
|
|Key |Value Type |Example
|
2688
2697
|
|
2689
|
-
3+|[#key-prefix-ulist-marker]*Key Prefix:* <<key-prefix-ulist-marker,
|
2698
|
+
3+|[#key-prefix-ulist-marker]*Key Prefix:* <<key-prefix-ulist-marker,ulist-marker>>
|
2690
2699
|
|
2691
|
-
|
|
2700
|
+
|font-family
|
2692
2701
|
|<<fonts,Font family name>> +
|
2693
2702
|
(default: _inherit_)
|
2694
2703
|
|ulist:
|
2695
2704
|
marker:
|
2696
|
-
|
2705
|
+
font-family: Noto Serif
|
2697
2706
|
|
2698
|
-
|
|
2707
|
+
|font-size
|
2699
2708
|
|<<values,Number>> +
|
2700
2709
|
(default: _inherit_)
|
2701
2710
|
|ulist:
|
2702
2711
|
marker:
|
2703
|
-
|
2712
|
+
font-size: 9
|
2704
2713
|
|
2705
|
-
|
|
2714
|
+
|font-color
|
2706
2715
|
|<<colors,Color>> +
|
2707
|
-
(default: $
|
2716
|
+
(default: $outline-list-marker-font-color)
|
2708
2717
|
|ulist:
|
2709
2718
|
marker:
|
2710
|
-
|
2719
|
+
font-color: #cccccc
|
2711
2720
|
|
2712
|
-
|
|
2721
|
+
|line-height
|
2713
2722
|
|<<values,Number>> +
|
2714
|
-
(default: $
|
2723
|
+
(default: $base-line-height)
|
2715
2724
|
|ulist:
|
2716
2725
|
marker:
|
2717
|
-
|
2726
|
+
line-height: 1.5
|
2718
2727
|
|===
|
2719
2728
|
|
2720
2729
|
[cols="3,4,5l"]
|
2721
2730
|
|===
|
2722
2731
|
|Key |Value Type |Example
|
2723
2732
|
|
2724
|
-
3+|*Key Prefix:*
|
2733
|
+
3+|*Key Prefix:* ulist-marker-<type>^[1]^
|
2725
2734
|
|
2726
2735
|
|content
|
2727
2736
|
|<<quoted-string,Quoted string>>
|
@@ -2730,37 +2739,37 @@ The keys in this category control the arrangement and style of unordered list it
|
|
2730
2739
|
disc:
|
2731
2740
|
content: "\uf140"
|
2732
2741
|
|
2733
|
-
|
|
2742
|
+
|font-family
|
2734
2743
|
|<<fonts,Font family name>> +
|
2735
2744
|
(default: _inherit_)
|
2736
2745
|
|ulist:
|
2737
2746
|
marker:
|
2738
2747
|
disc:
|
2739
|
-
|
2748
|
+
font-family: fas
|
2740
2749
|
|
2741
|
-
|
|
2750
|
+
|font-size
|
2742
2751
|
|<<values,Number>> +
|
2743
2752
|
(default: _inherit_)
|
2744
2753
|
|ulist:
|
2745
2754
|
marker:
|
2746
2755
|
disc:
|
2747
|
-
|
2756
|
+
font-size: 9
|
2748
2757
|
|
2749
|
-
|
|
2758
|
+
|font-color
|
2750
2759
|
|<<colors,Color>> +
|
2751
2760
|
(default: _inherit_)
|
2752
2761
|
|ulist:
|
2753
2762
|
marker:
|
2754
2763
|
disc:
|
2755
|
-
|
2764
|
+
font-color: #ff0000
|
2756
2765
|
|
2757
|
-
|
|
2766
|
+
|line-height
|
2758
2767
|
|<<values,Number>> +
|
2759
2768
|
(default: _inherit_)
|
2760
2769
|
|ulist:
|
2761
2770
|
marker:
|
2762
2771
|
disc:
|
2763
|
-
|
2772
|
+
line-height: 2
|
2764
2773
|
|===
|
2765
2774
|
|
2766
2775
|
. <type> is one of disc, square, circle, checked, unchecked
|
@@ -2776,79 +2785,85 @@ The keys in this category control the arrangement and style of tables and table
|
|
2776
2785
|
|
2777
2786
|
3+|[#key-prefix-table]*Key Prefix:* <<key-prefix-table,table>>
|
2778
2787
|
|
2779
|
-
|
|
2788
|
+
|background-color
|
2780
2789
|
|<<colors,Color>> +
|
2781
2790
|
(default: transparent)
|
2782
2791
|
|table:
|
2783
|
-
|
2792
|
+
background-color: #ffffff
|
2784
2793
|
|
2785
|
-
|
|
2794
|
+
|border-color
|
2786
2795
|
|<<colors,Color>> +
|
2787
2796
|
(default: #000000)
|
2788
2797
|
|table:
|
2789
|
-
|
2798
|
+
border-color: #dddddd
|
2790
2799
|
|
2791
|
-
|
|
2800
|
+
|border-style
|
2792
2801
|
|solid {vbar} dashed {vbar} dotted +
|
2793
2802
|
(default: solid)
|
2794
2803
|
|table:
|
2795
|
-
|
2804
|
+
border-style: solid
|
2796
2805
|
|
2797
|
-
|
|
2806
|
+
|border-width
|
2798
2807
|
|<<values,Number>> +
|
2799
2808
|
(default: 0.5)
|
2800
2809
|
|table:
|
2801
|
-
|
2810
|
+
border-width: 0.5
|
2802
2811
|
|
2803
|
-
|
|
2812
|
+
|caption-side
|
2804
2813
|
|top {vbar} bottom +
|
2805
2814
|
(default: top)
|
2806
2815
|
|table:
|
2807
|
-
|
2816
|
+
caption-side: bottom
|
2808
2817
|
|
2809
|
-
|
|
2818
|
+
|caption-max-width
|
2819
|
+
|fit-content {vbar} none +
|
2820
|
+
(default: fit-content)
|
2821
|
+
|table:
|
2822
|
+
caption-max-width: none
|
2823
|
+
|
2824
|
+
|font-color
|
2810
2825
|
|<<colors,Color>> +
|
2811
2826
|
(default: _inherit_)
|
2812
2827
|
|table:
|
2813
|
-
|
2828
|
+
font-color: #333333
|
2814
2829
|
|
2815
|
-
|
|
2830
|
+
|font-family
|
2816
2831
|
|<<fonts,Font family name>> +
|
2817
2832
|
(default: _inherit_)
|
2818
2833
|
|table:
|
2819
|
-
|
2834
|
+
font-family: Helvetica
|
2820
2835
|
|
2821
|
-
|
|
2836
|
+
|font-size
|
2822
2837
|
|<<values,Number>> +
|
2823
2838
|
(default: _inherit_)
|
2824
2839
|
|table:
|
2825
|
-
|
2840
|
+
font-size: 9.5
|
2826
2841
|
|
2827
|
-
|
|
2842
|
+
|font-style
|
2828
2843
|
|<<font-styles,Font style>> +
|
2829
2844
|
(default: _inherit_)
|
2830
2845
|
|table:
|
2831
|
-
|
2846
|
+
font-style: italic
|
2832
2847
|
|
2833
|
-
|
|
2848
|
+
|grid-color
|
2834
2849
|
|<<colors,Color>> +
|
2835
|
-
(default: $
|
2850
|
+
(default: $table-border-color)
|
2836
2851
|
|table:
|
2837
|
-
|
2852
|
+
grid-color: #eeeeee
|
2838
2853
|
|
2839
|
-
|
|
2854
|
+
|grid-style
|
2840
2855
|
|solid {vbar} dashed {vbar} dotted +
|
2841
2856
|
(default: solid)
|
2842
2857
|
|table:
|
2843
|
-
|
2858
|
+
grid-style: dashed
|
2844
2859
|
|
2845
|
-
|
|
2860
|
+
|grid-width
|
2846
2861
|
|<<values,Number>> +
|
2847
|
-
(default: $
|
2862
|
+
(default: $table-border-width)
|
2848
2863
|
|table:
|
2849
|
-
|
2864
|
+
grid-width: 0.5
|
2850
2865
|
|
2851
|
-
3+|[#key-prefix-table-head]*Key Prefix:* <<key-prefix-table-head,
|
2866
|
+
3+|[#key-prefix-table-head]*Key Prefix:* <<key-prefix-table-head,table-head>>
|
2852
2867
|
|
2853
2868
|
//|align
|
2854
2869
|
//|<<text-alignments,Text alignment>> +
|
@@ -2857,112 +2872,123 @@ The keys in this category control the arrangement and style of tables and table
|
|
2857
2872
|
// head:
|
2858
2873
|
// align: center
|
2859
2874
|
|
2860
|
-
|
|
2875
|
+
|background-color
|
2876
|
+
|<<colors,Color>> +
|
2877
|
+
(default: $table-background-color)
|
2878
|
+
|table:
|
2879
|
+
head:
|
2880
|
+
background-color: #f0f0f0
|
2881
|
+
|
2882
|
+
|border-bottom-color
|
2861
2883
|
|<<colors,Color>> +
|
2862
|
-
(default: $
|
2884
|
+
(default: $table-border-color)
|
2885
|
+
|table:
|
2886
|
+
head:
|
2887
|
+
border-bottom-color: #dddddd
|
2888
|
+
|
2889
|
+
|border-bottom-style
|
2890
|
+
|solid {vbar} dashed {vbar} dotted +
|
2891
|
+
(default: solid)
|
2892
|
+
|table:
|
2893
|
+
head:
|
2894
|
+
border-bottom-style: dashed
|
2895
|
+
|
2896
|
+
|border-bottom-width
|
2897
|
+
|<<values,Number>> +
|
2898
|
+
(default: 1.25)
|
2863
2899
|
|table:
|
2864
2900
|
head:
|
2865
|
-
|
2901
|
+
border-bottom-width: 1
|
2866
2902
|
|
2867
|
-
|
|
2903
|
+
|font-color
|
2868
2904
|
|<<colors,Color>> +
|
2869
|
-
(default: $
|
2905
|
+
(default: $table-font-color)
|
2870
2906
|
|table:
|
2871
2907
|
head:
|
2872
|
-
|
2908
|
+
font-color: #333333
|
2873
2909
|
|
2874
|
-
|
|
2910
|
+
|font-family
|
2875
2911
|
|<<fonts,Font family name>> +
|
2876
|
-
(default: $
|
2912
|
+
(default: $table-font-family)
|
2877
2913
|
|table:
|
2878
2914
|
head:
|
2879
|
-
|
2915
|
+
font-family: Noto Serif
|
2880
2916
|
|
2881
|
-
|
|
2917
|
+
|font-size
|
2882
2918
|
|<<values,Number>> +
|
2883
|
-
(default: $
|
2919
|
+
(default: $table-font-size)
|
2884
2920
|
|table:
|
2885
2921
|
head:
|
2886
|
-
|
2922
|
+
font-size: 10
|
2887
2923
|
|
2888
|
-
|
|
2924
|
+
|font-style
|
2889
2925
|
|<<font-styles,Font style>> +
|
2890
2926
|
(default: bold)
|
2891
2927
|
|table:
|
2892
2928
|
head:
|
2893
|
-
|
2929
|
+
font-style: normal
|
2894
2930
|
|
2895
|
-
|
|
2931
|
+
|text-transform
|
2896
2932
|
|<<text-transforms,Text transform>> +
|
2897
2933
|
(default: _inherit_)
|
2898
2934
|
|table:
|
2899
2935
|
head:
|
2900
|
-
|
2936
|
+
text-transform: uppercase
|
2901
2937
|
|
2902
|
-
3+|[#key-prefix-table-body]*Key Prefix:* <<key-prefix-table-body,
|
2938
|
+
3+|[#key-prefix-table-body]*Key Prefix:* <<key-prefix-table-body,table-body>>
|
2903
2939
|
|
2904
|
-
|
|
2940
|
+
|background-color
|
2905
2941
|
|<<colors,Color>> +
|
2906
|
-
(default: $
|
2942
|
+
(default: $table-background-color)
|
2907
2943
|
|table:
|
2908
2944
|
body:
|
2909
|
-
|
2945
|
+
background-color: #fdfdfd
|
2910
2946
|
|
2911
|
-
|
|
2947
|
+
|stripe-background-color^[1]^
|
2912
2948
|
|<<colors,Color>> +
|
2913
2949
|
(default: #eeeeee)
|
2914
2950
|
|table:
|
2915
2951
|
body:
|
2916
|
-
|
2952
|
+
stripe-background-color: #efefef
|
2917
2953
|
|
2918
|
-
3+|[#key-prefix-table-foot]*Key Prefix:* <<key-prefix-table-foot,
|
2954
|
+
3+|[#key-prefix-table-foot]*Key Prefix:* <<key-prefix-table-foot,table-foot>>
|
2919
2955
|
|
2920
|
-
|
|
2956
|
+
|background-color
|
2921
2957
|
|<<colors,Color>> +
|
2922
|
-
(default: $
|
2958
|
+
(default: $table-background-color)
|
2923
2959
|
|table:
|
2924
2960
|
foot:
|
2925
|
-
|
2961
|
+
background-color: #f0f0f0
|
2926
2962
|
|
2927
|
-
|
|
2963
|
+
|font-color
|
2928
2964
|
|<<colors,Color>> +
|
2929
|
-
(default: $
|
2965
|
+
(default: $table-font-color)
|
2930
2966
|
|table:
|
2931
2967
|
foot:
|
2932
|
-
|
2968
|
+
font-color: #333333
|
2933
2969
|
|
2934
|
-
|
|
2970
|
+
|font-family
|
2935
2971
|
|<<fonts,Font family name>> +
|
2936
|
-
(default: $
|
2972
|
+
(default: $table-font-family)
|
2937
2973
|
|table:
|
2938
2974
|
foot:
|
2939
|
-
|
2975
|
+
font-family: Noto Serif
|
2940
2976
|
|
2941
|
-
|
|
2977
|
+
|font-size
|
2942
2978
|
|<<values,Number>> +
|
2943
|
-
(default: $
|
2979
|
+
(default: $table-font-size)
|
2944
2980
|
|table:
|
2945
2981
|
foot:
|
2946
|
-
|
2982
|
+
font-size: 10
|
2947
2983
|
|
2948
|
-
|
|
2984
|
+
|font-style
|
2949
2985
|
|<<font-styles,Font style>> +
|
2950
2986
|
(default: normal)
|
2951
2987
|
|table:
|
2952
2988
|
foot:
|
2953
|
-
|
2954
|
-
|
2955
|
-
//deprecated
|
2956
|
-
//3+|[#key-prefix-table-row]*Key Prefix:* <<key-prefix-table-row,table_<parity>_row>>^[1]^
|
2957
|
-
//
|
2958
|
-
//|background_color
|
2959
|
-
//|<<colors,Color>> +
|
2960
|
-
//(default: $table_background_color)
|
2961
|
-
//|table:
|
2962
|
-
// even_row:
|
2963
|
-
// background_color: #f9f9f9
|
2989
|
+
font-style: italic
|
2964
2990
|
|
2965
|
-
3+|[#key-prefix-table-cell]*Key Prefix:* <<key-prefix-table-cell,
|
2991
|
+
3+|[#key-prefix-table-cell]*Key Prefix:* <<key-prefix-table-cell,table-cell>>
|
2966
2992
|
|
2967
2993
|
|padding
|
2968
2994
|
|<<measurement-units,Measurement>> {vbar} <<measurement-units,Measurement[top,right,bottom,left]>> +
|
@@ -2971,59 +2997,62 @@ The keys in this category control the arrangement and style of tables and table
|
|
2971
2997
|
cell:
|
2972
2998
|
padding: 3
|
2973
2999
|
|
2974
|
-
3+|[#key-prefix-table-header-cell]*Key Prefix:* <<key-prefix-table-header-cell,
|
3000
|
+
3+|[#key-prefix-table-header-cell]*Key Prefix:* <<key-prefix-table-header-cell,table-header-cell>>
|
2975
3001
|
|
2976
3002
|
//|align
|
2977
3003
|
//|<<text-alignments,Text alignment>> +
|
2978
|
-
//(default: $
|
3004
|
+
//(default: $table-head-align)
|
2979
3005
|
//|table:
|
2980
|
-
//
|
3006
|
+
// header-cell:
|
2981
3007
|
// align: center
|
2982
3008
|
|
2983
|
-
|
|
3009
|
+
|background-color
|
2984
3010
|
|<<colors,Color>> +
|
2985
|
-
(default: $
|
3011
|
+
(default: $table-head-background-color)
|
2986
3012
|
|table:
|
2987
|
-
|
2988
|
-
|
3013
|
+
header-cell:
|
3014
|
+
background-color: #f0f0f0
|
2989
3015
|
|
2990
|
-
|
|
3016
|
+
|font-color
|
2991
3017
|
|<<colors,Color>> +
|
2992
|
-
(default: $
|
3018
|
+
(default: $table-head-font-color)
|
2993
3019
|
|table:
|
2994
|
-
|
2995
|
-
|
3020
|
+
header-cell:
|
3021
|
+
font-color: #1a1a1a
|
2996
3022
|
|
2997
|
-
|
|
3023
|
+
|font-family
|
2998
3024
|
|<<fonts,Font family name>> +
|
2999
|
-
(default: $
|
3025
|
+
(default: $table-head-font-family)
|
3000
3026
|
|table:
|
3001
|
-
|
3002
|
-
|
3027
|
+
header-cell:
|
3028
|
+
font-family: Noto Sans
|
3003
3029
|
|
3004
|
-
|
|
3030
|
+
|font-size
|
3005
3031
|
|<<values,Number>> +
|
3006
|
-
(default: $
|
3032
|
+
(default: $table-head-font-size)
|
3007
3033
|
|table:
|
3008
|
-
|
3009
|
-
|
3034
|
+
header-cell:
|
3035
|
+
font-size: 12
|
3010
3036
|
|
3011
|
-
|
|
3037
|
+
|font-style
|
3012
3038
|
|<<font-styles,Font style>> +
|
3013
|
-
(default: $
|
3039
|
+
(default: $table-head-font-style)
|
3014
3040
|
|table:
|
3015
|
-
|
3016
|
-
|
3041
|
+
header-cell:
|
3042
|
+
font-style: italic
|
3017
3043
|
|
3018
|
-
|
|
3044
|
+
|text-transform
|
3019
3045
|
|<<text-transforms,Text transform>> +
|
3020
|
-
(default: $
|
3046
|
+
(default: $table-head-text-transform)
|
3021
3047
|
|table:
|
3022
|
-
|
3023
|
-
|
3048
|
+
header-cell:
|
3049
|
+
text-transform: uppercase
|
3024
3050
|
|===
|
3025
|
-
.
|
3026
|
-
|
3051
|
+
. This key only controls the color that is used for stripes.
|
3052
|
+
The appearance of stripes is controlled using the `stripes` table attribute, the `table-stripes` document attribute (since Asciidoctor 2), or the `stripes` document attribute (prior to Asciidoctor 2).
|
3053
|
+
Permitted attribute values are even, odd, all, and none.
|
3054
|
+
Prior to Asciidoctor 2, even rows are shaded by default (e.g., `stripes=even`).
|
3055
|
+
Since Asciidoctor 2, table stripes are not enabled by default (e.g., `stripes=none`).
|
3027
3056
|
|
3028
3057
|
[#keys-footnotes]
|
3029
3058
|
=== Footnotes
|
@@ -3038,41 +3067,41 @@ The styling of the links is controlled by the global link styles.
|
|
3038
3067
|
|
3039
3068
|
3+|[#key-prefix-footnotes]*Key Prefix:* <<key-prefix-footnotes,footnotes>>
|
3040
3069
|
|
3041
|
-
|
|
3070
|
+
|font-color
|
3042
3071
|
|<<colors,Color>> +
|
3043
|
-
(default: $
|
3072
|
+
(default: $base-font-color)
|
3044
3073
|
|footnotes:
|
3045
|
-
|
3074
|
+
font-color: #cccccc
|
3046
3075
|
|
3047
|
-
|
|
3076
|
+
|font-size
|
3048
3077
|
|<<values,Number>> +
|
3049
3078
|
(default: 8)
|
3050
3079
|
|footnotes:
|
3051
|
-
|
3080
|
+
font-size: 6
|
3052
3081
|
|
3053
|
-
|
|
3082
|
+
|font-style
|
3054
3083
|
|<<font-styles,Font style>> +
|
3055
|
-
(default: $
|
3084
|
+
(default: $base-font-style)
|
3056
3085
|
|footnotes:
|
3057
|
-
|
3086
|
+
font-style: italic
|
3058
3087
|
|
3059
|
-
|
|
3088
|
+
|item-spacing
|
3060
3089
|
|<<measurement-units,Measurement>> +
|
3061
3090
|
(default: 3)
|
3062
3091
|
|footnotes:
|
3063
|
-
|
3092
|
+
item-spacing: 5
|
3064
3093
|
|
3065
|
-
|
|
3094
|
+
|margin-top
|
3066
3095
|
|<<measurement-units,Measurement>> +
|
3067
3096
|
(default: 0)
|
3068
3097
|
|footnotes:
|
3069
|
-
|
3098
|
+
margin-top: 10
|
3070
3099
|
|
3071
|
-
|
|
3100
|
+
|text-transform
|
3072
3101
|
|<<text-transforms,Text transform>> +
|
3073
3102
|
(default: _inherit_)
|
3074
3103
|
|footnotes:
|
3075
|
-
|
3104
|
+
text-transform: lowercase
|
3076
3105
|
|===
|
3077
3106
|
|
3078
3107
|
[#keys-table-of-contents]
|
@@ -3086,48 +3115,48 @@ The keys in this category control the arrangement and style of the table of cont
|
|
3086
3115
|
|
3087
3116
|
3+|[#key-prefix-toc]*Key Prefix:* <<key-prefix-toc,toc>>
|
3088
3117
|
|
3089
|
-
|
|
3118
|
+
|font-color
|
3090
3119
|
|<<colors,Color>> +
|
3091
3120
|
(default: _inherit_)
|
3092
3121
|
|toc:
|
3093
|
-
|
3122
|
+
font-color: #333333
|
3094
3123
|
|
3095
|
-
|
|
3124
|
+
|font-family
|
3096
3125
|
|<<fonts,Font family name>> +
|
3097
3126
|
(default: _inherit_)
|
3098
3127
|
|toc:
|
3099
|
-
|
3128
|
+
font-family: Noto Serif
|
3100
3129
|
|
3101
|
-
|
|
3130
|
+
|font-size
|
3102
3131
|
|<<values,Number>> +
|
3103
3132
|
(default: _inherit_)
|
3104
3133
|
|toc:
|
3105
|
-
|
3134
|
+
font-size: 9
|
3106
3135
|
|
3107
|
-
|
|
3136
|
+
|font-style
|
3108
3137
|
|<<font-styles,Font style>> +
|
3109
3138
|
// QUESTION why is the default not inherited?
|
3110
3139
|
(default: normal)
|
3111
3140
|
|toc:
|
3112
|
-
|
3141
|
+
font-style: bold
|
3113
3142
|
|
3114
|
-
|
|
3143
|
+
|text-decoration
|
3115
3144
|
|none {vbar} underline +
|
3116
3145
|
(default: none)
|
3117
3146
|
|toc:
|
3118
|
-
|
3147
|
+
text-decoration: underline
|
3119
3148
|
|
3120
|
-
|
|
3149
|
+
|text-transform
|
3121
3150
|
|<<text-transforms,Text transform>> +
|
3122
3151
|
(default: _inherit_)
|
3123
3152
|
|toc:
|
3124
|
-
|
3153
|
+
text-transform: uppercase
|
3125
3154
|
|
3126
|
-
|
|
3155
|
+
|line-height
|
3127
3156
|
|<<values,Number>> +
|
3128
3157
|
(default: 1.4)
|
3129
3158
|
|toc:
|
3130
|
-
|
3159
|
+
line-height: 1.5
|
3131
3160
|
|
3132
3161
|
|indent
|
3133
3162
|
|<<measurement-units,Measurement>> +
|
@@ -3135,127 +3164,127 @@ The keys in this category control the arrangement and style of the table of cont
|
|
3135
3164
|
|toc:
|
3136
3165
|
indent: 20
|
3137
3166
|
|
3138
|
-
|
|
3167
|
+
|margin-top
|
3139
3168
|
|<<measurement-units,Measurement>> +
|
3140
3169
|
(default: 0)
|
3141
3170
|
|toc:
|
3142
|
-
|
3171
|
+
margin-top: 0
|
3143
3172
|
|
3144
|
-
3+|[#key-prefix-toc-level]*Key Prefix:* <<key-prefix-toc-level,
|
3173
|
+
3+|[#key-prefix-toc-level]*Key Prefix:* <<key-prefix-toc-level,toc-h<n> >>^[1]^
|
3145
3174
|
|
3146
|
-
|
|
3175
|
+
|font-color
|
3147
3176
|
|<<colors,Color>> +
|
3148
3177
|
(default: _inherit_)
|
3149
3178
|
|toc:
|
3150
|
-
|
3179
|
+
h3-font-color: #999999
|
3151
3180
|
|
3152
|
-
|
|
3181
|
+
|font-family
|
3153
3182
|
|<<fonts,Font family name>> +
|
3154
3183
|
(default: _inherit_)
|
3155
3184
|
|toc:
|
3156
|
-
|
3185
|
+
font-family: Noto Serif
|
3157
3186
|
|
3158
|
-
|
|
3187
|
+
|font-size
|
3159
3188
|
|<<values,Number>> +
|
3160
3189
|
(default: _inherit_)
|
3161
3190
|
|toc:
|
3162
|
-
|
3191
|
+
font-size: 9
|
3163
3192
|
|
3164
|
-
|
|
3193
|
+
|font-style
|
3165
3194
|
|<<font-styles,Font style>> +
|
3166
3195
|
(default: _inherit_)
|
3167
3196
|
|toc:
|
3168
|
-
|
3197
|
+
font-style: italic
|
3169
3198
|
|
3170
|
-
|
|
3199
|
+
|text-decoration
|
3171
3200
|
|none {vbar} underline +
|
3172
3201
|
(default: _inherit_)
|
3173
3202
|
|toc:
|
3174
|
-
|
3203
|
+
text-decoration: none
|
3175
3204
|
|
3176
|
-
|
|
3205
|
+
|text-transform
|
3177
3206
|
|<<text-transforms,Text transform>> +
|
3178
3207
|
(default: _inherit_)
|
3179
3208
|
|toc:
|
3180
|
-
|
3209
|
+
text-transform: uppercase
|
3181
3210
|
|
3182
|
-
3+|[#key-prefix-toc-title]*Key Prefix:* <<key-prefix-toc-title,
|
3211
|
+
3+|[#key-prefix-toc-title]*Key Prefix:* <<key-prefix-toc-title,toc-title>>
|
3183
3212
|
|
3184
3213
|
|align
|
3185
3214
|
|<<text-alignments,Text alignment>> +
|
3186
|
-
(default: $
|
3215
|
+
(default: $heading-h2-align)
|
3187
3216
|
|toc:
|
3188
3217
|
title:
|
3189
3218
|
align: right
|
3190
3219
|
|
3191
|
-
|
|
3220
|
+
|font-color
|
3192
3221
|
|<<colors,Color>> +
|
3193
|
-
(default: $
|
3222
|
+
(default: $heading-h2-font-color)
|
3194
3223
|
|toc:
|
3195
3224
|
title:
|
3196
|
-
|
3225
|
+
font-color: #aa0000
|
3197
3226
|
|
3198
|
-
|
|
3227
|
+
|font-family
|
3199
3228
|
|<<fonts,Font family name>> +
|
3200
|
-
(default: $
|
3229
|
+
(default: $heading-h2-font-family)
|
3201
3230
|
|toc:
|
3202
3231
|
title:
|
3203
|
-
|
3232
|
+
font-family: Noto Serif
|
3204
3233
|
|
3205
|
-
|
|
3234
|
+
|font-size
|
3206
3235
|
|<<values,Number>> +
|
3207
|
-
(default: $
|
3236
|
+
(default: $heading-h2-font-size)
|
3208
3237
|
|toc:
|
3209
3238
|
title:
|
3210
|
-
|
3239
|
+
font-size: 18
|
3211
3240
|
|
3212
|
-
|
|
3241
|
+
|font-style
|
3213
3242
|
|<<font-styles,Font style>> +
|
3214
|
-
(default: $
|
3243
|
+
(default: $heading-h2-font-style)
|
3215
3244
|
|toc:
|
3216
3245
|
title:
|
3217
|
-
|
3246
|
+
font-style: bold_italic
|
3218
3247
|
|
3219
|
-
|
|
3248
|
+
|text-transform
|
3220
3249
|
|<<text-transforms,Text transform>> +
|
3221
|
-
(default: $
|
3250
|
+
(default: $heading-h2-text-transform)
|
3222
3251
|
|sidebar:
|
3223
3252
|
title:
|
3224
|
-
|
3253
|
+
text-transform: uppercase
|
3225
3254
|
|
3226
|
-
3+|[#key-prefix-toc-dot-leader]*Key Prefix:* <<key-prefix-toc-dot-leader,
|
3255
|
+
3+|[#key-prefix-toc-dot-leader]*Key Prefix:* <<key-prefix-toc-dot-leader,toc-dot-leader>>
|
3227
3256
|
|
3228
3257
|
|content
|
3229
3258
|
|<<quoted-string,Quoted string>> +
|
3230
3259
|
(default: '. ')
|
3231
3260
|
|toc:
|
3232
|
-
|
3261
|
+
dot-leader:
|
3233
3262
|
content: ". "
|
3234
3263
|
|
3235
|
-
|
|
3264
|
+
|font-color^[2]^
|
3236
3265
|
|<<colors,Color>> +
|
3237
3266
|
(default: _inherit_)
|
3238
3267
|
|toc:
|
3239
|
-
|
3240
|
-
|
3268
|
+
dot-leader:
|
3269
|
+
font-color: #999999
|
3241
3270
|
|
3242
|
-
|
|
3271
|
+
|font-style^[2]^
|
3243
3272
|
|<<font-styles,Font style>> +
|
3244
3273
|
(default: normal)
|
3245
3274
|
|toc:
|
3246
|
-
|
3247
|
-
|
3275
|
+
dot-leader:
|
3276
|
+
font-style: bold
|
3248
3277
|
|
3249
3278
|
|levels^[3]^
|
3250
3279
|
|all {vbar} none {vbar} Integers (space-separated) +
|
3251
3280
|
(default: all)
|
3252
3281
|
|toc:
|
3253
|
-
|
3282
|
+
dot-leader:
|
3254
3283
|
levels: 2 3
|
3255
3284
|
|===
|
3256
3285
|
|
3257
3286
|
. `<n>` is a number ranging from 1 to 6, representing each of the six heading levels.
|
3258
|
-
. The dot leader inherits all font properties except `
|
3287
|
+
. The dot leader inherits all font properties except `font-style` from the root `toc` category.
|
3259
3288
|
. 0-based levels (e.g., part = 0, chapter = 1).
|
3260
3289
|
Dot leaders are only shown for the specified levels.
|
3261
3290
|
If value is not specified, dot leaders are shown for all levels.
|
@@ -3266,66 +3295,70 @@ If value is not specified, dot leaders are shown for all levels.
|
|
3266
3295
|
The keys in this category control the arrangement and style of running header and footer content.
|
3267
3296
|
Please note that the running content will _not_ be used unless a) the periphery (header or footer) is configured and b) the height key for the periphery is assigned a value.
|
3268
3297
|
|
3298
|
+
CAUTION: If the height of the running content periphery is larger than the page margin, the running content will cover the main content.
|
3299
|
+
To avoid this problem, reduce the height of the running content periphery or make the page margin on that side larger.
|
3300
|
+
|
3269
3301
|
[cols="3,4,5l"]
|
3270
3302
|
|===
|
3271
3303
|
|Key |Value Type |Example
|
3272
3304
|
|
3273
|
-
3+|[#key-prefix-
|
3274
|
-
|
3305
|
+
3+|[#key-prefix-running-content]*Key Prefix:* <<key-prefix-running-content,running-content>>
|
3306
|
+
|
3307
|
+
|start-at
|
3275
3308
|
|title {vbar} toc {vbar} body +
|
3276
3309
|
(default: body)
|
3277
|
-
|
|
3278
|
-
|
3310
|
+
|running-content:
|
3311
|
+
start-at: toc
|
3279
3312
|
|
3280
3313
|
3+|[#key-prefix-header]*Key Prefix:* <<key-prefix-header,header>>
|
3281
3314
|
|
3282
|
-
|
|
3315
|
+
|background-color^[1]^
|
3283
3316
|
|<<colors,Color>> +
|
3284
3317
|
(default: _not set_)
|
3285
3318
|
|header:
|
3286
|
-
|
3319
|
+
background-color: #eeeeee
|
3287
3320
|
|
3288
|
-
|
|
3321
|
+
|border-color
|
3289
3322
|
|<<colors,Color>> +
|
3290
3323
|
(default: _not set_)
|
3291
3324
|
|header:
|
3292
|
-
|
3325
|
+
border-color: #dddddd
|
3293
3326
|
|
3294
|
-
|
|
3327
|
+
|border-style
|
3295
3328
|
|solid {vbar} double {vbar} dashed {vbar} dotted +
|
3296
3329
|
(default: solid)
|
3297
3330
|
|header:
|
3298
|
-
|
3331
|
+
border-style: dashed
|
3299
3332
|
|
3300
|
-
|
|
3333
|
+
|border-width
|
3301
3334
|
|<<measurement-units,Measurement>> +
|
3302
|
-
(default: $
|
3335
|
+
(default: $base-border-width)
|
3303
3336
|
|header:
|
3304
|
-
|
3337
|
+
border-width: 0.25
|
3305
3338
|
|
3306
|
-
|
|
3339
|
+
|font-color
|
3307
3340
|
|<<colors,Color>> +
|
3308
3341
|
(default: _inherit_)
|
3309
3342
|
|header:
|
3310
|
-
|
3343
|
+
font-color: #333333
|
3311
3344
|
|
3312
|
-
|
|
3345
|
+
|font-family
|
3313
3346
|
|<<fonts,Font family name>> +
|
3314
3347
|
(default: _inherit_)
|
3315
3348
|
|header:
|
3316
|
-
|
3349
|
+
font-family: Noto Serif
|
3317
3350
|
|
3318
|
-
|
|
3351
|
+
|font-size
|
3319
3352
|
|<<values,Number>> +
|
3320
3353
|
(default: _inherit_)
|
3321
3354
|
|header:
|
3322
|
-
|
3355
|
+
font-size: 9
|
3323
3356
|
|
3324
|
-
|
|
3357
|
+
|font-style
|
3325
3358
|
|<<font-styles,Font style>> +
|
3326
3359
|
(default: _inherit_)
|
3327
3360
|
|header:
|
3328
|
-
|
3361
|
+
font-style: italic
|
3329
3362
|
|
3330
3363
|
|height^[2]^
|
3331
3364
|
|<<measurement-units,Measurement>> +
|
@@ -3333,11 +3366,11 @@ Please note that the running content will _not_ be used unless a) the periphery
|
|
3333
3366
|
|header:
|
3334
3367
|
height: 0.75in
|
3335
3368
|
|
3336
|
-
|
|
3369
|
+
|line-height
|
3337
3370
|
|<<values,Number>> +
|
3338
|
-
(default: $
|
3371
|
+
(default: $base-line-height)
|
3339
3372
|
|header:
|
3340
|
-
|
3373
|
+
line-height: 1.2
|
3341
3374
|
|
3342
3375
|
|padding^[3]^
|
3343
3376
|
|<<measurement-units,Measurement>> {vbar} <<measurement-units,Measurement[top,right,bottom,left]>> +
|
@@ -3345,26 +3378,38 @@ Please note that the running content will _not_ be used unless a) the periphery
|
|
3345
3378
|
|header:
|
3346
3379
|
padding: [0, 3, 0, 3]
|
3347
3380
|
|
3348
|
-
|
|
3381
|
+
|image-vertical-align
|
3349
3382
|
|top {vbar} middle {vbar} bottom {vbar} <<measurement-units,Measurement>> +
|
3350
3383
|
(default: _not set_)
|
3351
3384
|
|header:
|
3352
|
-
|
3385
|
+
image-vertical-align: 4
|
3386
|
+
|
3387
|
+
|sectlevels
|
3388
|
+
|Integer +
|
3389
|
+
(default: 2)
|
3390
|
+
|header:
|
3391
|
+
sectlevels: 3
|
3353
3392
|
|
3354
|
-
|
|
3393
|
+
|text-transform
|
3394
|
+
|<<text-transforms,Text transform>> +
|
3395
|
+
(default: none)
|
3396
|
+
|header:
|
3397
|
+
text-transform: uppercase
|
3398
|
+
|
3399
|
+
|vertical-align
|
3355
3400
|
|top {vbar} middle {vbar} bottom +
|
3356
3401
|
(default: middle)
|
3357
3402
|
|header:
|
3358
|
-
|
3403
|
+
vertical-align: center
|
3359
3404
|
|
3360
|
-
|<side
|
3405
|
+
|<side>-columns^[4]^
|
3361
3406
|
|Column specs triple +
|
3362
3407
|
(default: _not set_)
|
3363
3408
|
|header:
|
3364
3409
|
recto:
|
3365
3410
|
columns: <25% =50% >25%
|
3366
3411
|
|
3367
|
-
|<side
|
3412
|
+
|<side>-<position>-content^[4,5]^
|
3368
3413
|
|<<quoted-string,Quoted string>> +
|
3369
3414
|
(default: '\{page-number}')
|
3370
3415
|
|header:
|
@@ -3374,53 +3419,53 @@ Please note that the running content will _not_ be used unless a) the periphery
|
|
3374
3419
|
|
3375
3420
|
3+|[#key-prefix-footer]*Key Prefix:* <<key-prefix-footer,footer>>
|
3376
3421
|
|
3377
|
-
|
|
3422
|
+
|background-color^[1]^
|
3378
3423
|
|<<colors,Color>> +
|
3379
3424
|
(default: _not set_)
|
3380
3425
|
|footer:
|
3381
|
-
|
3426
|
+
background-color: #eeeeee
|
3382
3427
|
|
3383
|
-
|
|
3428
|
+
|border-color
|
3384
3429
|
|<<colors,Color>> +
|
3385
3430
|
(default: _not set_)
|
3386
3431
|
|footer:
|
3387
|
-
|
3432
|
+
border-color: #dddddd
|
3388
3433
|
|
3389
|
-
|
|
3434
|
+
|border-style
|
3390
3435
|
|solid {vbar} double {vbar} dashed {vbar} dotted +
|
3391
3436
|
(default: solid)
|
3392
3437
|
|footer:
|
3393
|
-
|
3438
|
+
border-style: dashed
|
3394
3439
|
|
3395
|
-
|
|
3440
|
+
|border-width
|
3396
3441
|
|<<measurement-units,Measurement>> +
|
3397
|
-
(default: $
|
3442
|
+
(default: $base-border-width)
|
3398
3443
|
|footer:
|
3399
|
-
|
3444
|
+
border-width: 0.25
|
3400
3445
|
|
3401
|
-
|
|
3446
|
+
|font-color
|
3402
3447
|
|<<colors,Color>> +
|
3403
3448
|
(default: _inherit_)
|
3404
3449
|
|footer:
|
3405
|
-
|
3450
|
+
font-color: #333333
|
3406
3451
|
|
3407
|
-
|
|
3452
|
+
|font-family
|
3408
3453
|
|<<fonts,Font family name>> +
|
3409
3454
|
(default: _inherit_)
|
3410
3455
|
|footer:
|
3411
|
-
|
3456
|
+
font-family: Noto Serif
|
3412
3457
|
|
3413
|
-
|
|
3458
|
+
|font-size
|
3414
3459
|
|<<values,Number>> +
|
3415
3460
|
(default: _inherit_)
|
3416
3461
|
|footer:
|
3417
|
-
|
3462
|
+
font-size: 9
|
3418
3463
|
|
3419
|
-
|
|
3464
|
+
|font-style
|
3420
3465
|
|<<font-styles,Font style>> +
|
3421
3466
|
(default: _inherit_)
|
3422
3467
|
|footer:
|
3423
|
-
|
3468
|
+
font-style: italic
|
3424
3469
|
|
3425
3470
|
|height^[2]^
|
3426
3471
|
|<<measurement-units,Measurement>> +
|
@@ -3428,11 +3473,11 @@ Please note that the running content will _not_ be used unless a) the periphery
|
|
3428
3473
|
|footer:
|
3429
3474
|
height: 0.75in
|
3430
3475
|
|
3431
|
-
|
|
3476
|
+
|line-height
|
3432
3477
|
|<<values,Number>> +
|
3433
|
-
(default: $
|
3478
|
+
(default: $base-line-height)
|
3434
3479
|
|footer:
|
3435
|
-
|
3480
|
+
line-height: 1.2
|
3436
3481
|
|
3437
3482
|
|padding^[3]^
|
3438
3483
|
|<<measurement-units,Measurement>> {vbar} <<measurement-units,Measurement[top,right,bottom,left]>> +
|
@@ -3440,26 +3485,38 @@ Please note that the running content will _not_ be used unless a) the periphery
|
|
3440
3485
|
|footer:
|
3441
3486
|
padding: [0, 3, 0, 3]
|
3442
3487
|
|
3443
|
-
|
|
3488
|
+
|image-vertical-align
|
3444
3489
|
|top {vbar} middle {vbar} bottom {vbar} <<measurement-units,Measurement>> +
|
3445
3490
|
(default: _not set_)
|
3446
3491
|
|footer:
|
3447
|
-
|
3492
|
+
image-vertical-align: 4
|
3448
3493
|
|
3449
|
-
|
|
3494
|
+
|sectlevels
|
3495
|
+
|Integer +
|
3496
|
+
(default: 2)
|
3497
|
+
|footer:
|
3498
|
+
sectlevels: 3
|
3499
|
+
|
3500
|
+
|text-transform
|
3501
|
+
|<<text-transforms,Text transform>> +
|
3502
|
+
(default: none)
|
3503
|
+
|footer:
|
3504
|
+
text-transform: uppercase
|
3505
|
+
|
3506
|
+
|vertical-align
|
3450
3507
|
|top {vbar} middle {vbar} bottom +
|
3451
3508
|
(default: middle)
|
3452
3509
|
|footer:
|
3453
|
-
|
3510
|
+
vertical-align: top
|
3454
3511
|
|
3455
|
-
|<side
|
3512
|
+
|<side>-columns^[4]^
|
3456
3513
|
|Column specs triple +
|
3457
3514
|
(default: _not set_)
|
3458
3515
|
|footer:
|
3459
3516
|
verso:
|
3460
3517
|
columns: <50% =0% <50%
|
3461
3518
|
|
3462
|
-
|<side
|
3519
|
+
|<side>-<position>-content^[4,5]^
|
3463
3520
|
|<<quoted-string,Quoted string>> +
|
3464
3521
|
(default: '\{page-number}')
|
3465
3522
|
|footer:
|
@@ -3474,15 +3531,15 @@ Please note that the running content will _not_ be used unless a) the periphery
|
|
3474
3531
|
Where the page sides fall in relation to the physical or printed page number is controlled using the `pdf-folio-placement` attribute (except when `media=prepress`, which implies `physical`).
|
3475
3532
|
. `<position>` can be `left`, `center` or `right`.
|
3476
3533
|
|
3477
|
-
IMPORTANT:
|
3534
|
+
IMPORTANT: If you don't specify a height for either the header or footer key, it effectively disables the content at that periphery.
|
3478
3535
|
|
3479
|
-
If you define running header and footer content in your theme, you can still disable this content per document by setting the `noheader` and `nofooter` attributes in the AsciiDoc document header, respectively.
|
3536
|
+
If you define running header and footer content in your theme (including the height), you can still disable this content per document by setting the `noheader` and `nofooter` attributes in the AsciiDoc document header, respectively.
|
3480
3537
|
|
3481
3538
|
If content is not specified for the running footer, the page number (i.e., `\{page-number}`) is shown on the left on verso pages and the right on recto pages.
|
3482
|
-
You can disable this behavior by defining the attribute `nofooter` in the AsciiDoc document header or by defining the key `
|
3539
|
+
You can disable this behavior by defining the attribute `nofooter` in the AsciiDoc document header or by defining the key `footer-<side>-content: none` in the theme.
|
3483
3540
|
|
3484
|
-
TIP: Although not listed in the table above, you can control the font
|
3485
|
-
For example, you can set the font color used for the right-hand column on recto pages by setting `
|
3541
|
+
TIP: Although not listed in the table above, you can control the font settings (font-family, font-size, font-color, font-style, text-transform) that get applied to the running content in each column position for each page side (e.g., `footer-<side>-<position>-font-color`).
|
3542
|
+
For example, you can set the font color used for the right-hand column on recto pages by setting `footer-recto-right-font-color: 6CC644`.
|
3486
3543
|
|
3487
3544
|
==== Attribute References
|
3488
3545
|
|
@@ -3506,16 +3563,16 @@ Here's an example that shows how attributes and replacements can be used in the
|
|
3506
3563
|
----
|
3507
3564
|
header:
|
3508
3565
|
height: 0.75in
|
3509
|
-
|
3566
|
+
line-height: 1
|
3510
3567
|
recto:
|
3511
3568
|
center:
|
3512
3569
|
content: '(C) ACME -- v{revnumber}, {docdate}'
|
3513
3570
|
verso:
|
3514
3571
|
center:
|
3515
|
-
content: $
|
3572
|
+
content: $header-recto-center-content
|
3516
3573
|
footer:
|
3517
3574
|
height: 0.75in
|
3518
|
-
|
3575
|
+
line-height: 1
|
3519
3576
|
recto:
|
3520
3577
|
right:
|
3521
3578
|
content: '{section-or-chapter-title} | *{page-number}*'
|
@@ -3532,7 +3589,7 @@ To force a hard line break in the output, add `{sp}+` to the end of the line in
|
|
3532
3589
|
----
|
3533
3590
|
footer:
|
3534
3591
|
height: 0.75in
|
3535
|
-
|
3592
|
+
line-height: 1.2
|
3536
3593
|
recto:
|
3537
3594
|
right:
|
3538
3595
|
content: |
|
@@ -3561,20 +3618,20 @@ Here's an example of how to use an image in the running header (which also appli
|
|
3561
3618
|
----
|
3562
3619
|
header:
|
3563
3620
|
height: 0.75in
|
3564
|
-
|
3621
|
+
image-vertical-align: 2 {conum-guard-yaml} <1>
|
3565
3622
|
recto:
|
3566
3623
|
center:
|
3567
3624
|
content: image:footer-logo.png[width=80]
|
3568
3625
|
verso:
|
3569
3626
|
center:
|
3570
|
-
content: $
|
3627
|
+
content: $header-recto-center-content
|
3571
3628
|
----
|
3572
|
-
<1> You can use the `
|
3629
|
+
<1> You can use the `footer-vertical-align` attribute to slighly nudge the image up or down.
|
3573
3630
|
|
3574
3631
|
CAUTION: By default, the image must fit in the allotted space for the running header or footer.
|
3575
3632
|
Otherwise, you will run into layout issues.
|
3576
3633
|
Adjust the width attribute accordingly using the `pdfwidth` attribute.
|
3577
|
-
Alternatively, you can set the `fit` attribute to `scale-down` (e.g., `fit=scale-down`) to reduce the image size to fit in the available space or `contain` (e
|
3634
|
+
Alternatively, you can set the `fit` attribute to `scale-down` (e.g., `fit=scale-down`) to reduce the image size to fit in the available space or `contain` (i.e., `fit=contain`) to scale the image (up or down) to fit the available space.
|
3578
3635
|
|
3579
3636
|
== Applying Your Theme
|
3580
3637
|
|
@@ -3583,14 +3640,15 @@ This is done using AsciiDoc attributes.
|
|
3583
3640
|
|
3584
3641
|
There are three AsciiDoc attributes that tell Asciidoctor PDF how to locate and apply your theme.
|
3585
3642
|
|
3586
|
-
pdf-
|
3643
|
+
pdf-theme (or pdf-style):: The name of the YAML theme file to load.
|
3644
|
+
If the name ends with `.yml`, it's assumed to be the complete name of a file and is resolved relative to `pdf-themesdir`, if specified, otherwise the current directory.
|
3645
|
+
Otherwise, `-theme.yml` is appended to the name to make the file name (i.e., `<name>-theme.yml`) and is resolved relative to `pdf-themesdir`, if specified, otherwise the built-in themes dir.
|
3646
|
+
|
3647
|
+
pdf-themesdir (or pdf-stylesdir):: The directory where the theme file is located.
|
3587
3648
|
_Specifying an absolute path is recommended._
|
3588
3649
|
+
|
3589
3650
|
If you use images in your theme, image paths are resolved relative to this directory.
|
3590
|
-
|
3591
|
-
pdf-style:: The name of the YAML theme file to load.
|
3592
|
-
If the name ends with `.yml`, it's assumed to be the complete name of a file.
|
3593
|
-
Otherwise, `-theme.yml` is appended to the name to make the file name (i.e., `<name>-theme.yml`).
|
3651
|
+
If `pdf-theme` ends with `.yml`, and `pdf-themesdir` is not specified, then `pdf-themesdir` defaults to the directory of the path specified by `pdf-theme`.
|
3594
3652
|
|
3595
3653
|
pdf-fontsdir:: The directory where the fonts used by your theme, if any, are located.
|
3596
3654
|
_Specifying an absolute path is recommended._
|
@@ -3611,15 +3669,15 @@ resources/
|
|
3611
3669
|
|
3612
3670
|
Here's how you'd load your theme when calling Asciidoctor PDF:
|
3613
3671
|
|
3614
|
-
$ asciidoctor-pdf -a pdf-
|
3672
|
+
$ asciidoctor-pdf -a pdf-themesdir=resources/themes -a pdf-theme=basic -a pdf-fontsdir=resources/fonts
|
3615
3673
|
|
3616
3674
|
If all goes well, Asciidoctor PDF should run without an error or warning.
|
3617
3675
|
|
3618
3676
|
NOTE: You only need to specify the `pdf-fontsdir` if you are using custom fonts in your theme.
|
3619
3677
|
|
3620
|
-
You can skip setting the `pdf-
|
3678
|
+
You can skip setting the `pdf-themesdir` attribute and just pass the absolute path of your theme file to the `pdf-theme` attribute.
|
3621
3679
|
|
3622
|
-
$ asciidoctor-pdf -a pdf-
|
3680
|
+
$ asciidoctor-pdf -a pdf-theme=resources/themes/basic-theme.yml -a pdf-fontsdir=resources/fonts
|
3623
3681
|
|
3624
3682
|
However, in this case, image paths in your theme won't be resolved properly.
|
3625
3683
|
|
@@ -3627,7 +3685,7 @@ Paths are resolved relative to the current directory.
|
|
3627
3685
|
However, in the future, this may change so that paths are resolved relative to the base directory (typically the document's directory).
|
3628
3686
|
Therefore, it's recommend that you specify absolute paths for now to future-proof your configuration.
|
3629
3687
|
|
3630
|
-
|
3688
|
+
$ asciidoctor-pdf -a pdf-themesdir=/path/to/resources/themes -a pdf-theme=basic -a pdf-fontsdir=/path/to/resources/fonts
|
3631
3689
|
|
3632
3690
|
As usual, you can also use build tools like Maven and Gradle to build a themed PDF.
|
3633
3691
|
The only thing you need to add to an existing build is the attributes mentioned above.
|
@@ -3669,6 +3727,10 @@ These settings override equivalent keys defined in the theme file, where applica
|
|
3669
3727
|
|path^[2]^ {vbar} image macro^[3]^
|
3670
3728
|
|:page-background-image: image:bg.jpg[]
|
3671
3729
|
|
3730
|
+
|page-background-image-(recto{vbar}verso)^[4]^
|
3731
|
+
|path^[2]^ {vbar} image macro^[3]^
|
3732
|
+
|:page-background-image-recto: image:bg-recto.jpg[]
|
3733
|
+
|
3672
3734
|
|pagenums^[5]^
|
3673
3735
|
|flag (default: _set_)
|
3674
3736
|
|:pagenums:
|
@@ -3689,13 +3751,17 @@ These settings override equivalent keys defined in the theme file, where applica
|
|
3689
3751
|
|virtual {vbar} virtual-inverted {vbar} physical {vbar} physical-inverted
|
3690
3752
|
|:pdf-folio-placement: physical
|
3691
3753
|
|
3754
|
+
|pdf-version
|
3755
|
+
|1.3 {vbar} 1.4 {vbar} 1.5 {vbar} 1.6 {vbar} 1.7 (default: 1.4)
|
3756
|
+
|:pdf-version: 1.7
|
3757
|
+
|
3692
3758
|
|pdfmark^[6]^
|
3693
3759
|
|flag (default: _not set_)
|
3694
3760
|
|:pdfmark:
|
3695
3761
|
|
3696
|
-
|text-
|
3762
|
+
|text-align^[7]^
|
3697
3763
|
|<<text-alignments,Text alignment>>
|
3698
|
-
|:text-
|
3764
|
+
|:text-align: left
|
3699
3765
|
|
3700
3766
|
|title-logo-image
|
3701
3767
|
|path^[2]^ {vbar} image macro^[3]^
|
@@ -3714,17 +3780,16 @@ These settings override equivalent keys defined in the theme file, where applica
|
|
3714
3780
|
. The path is resolved relative to base_dir.
|
3715
3781
|
. The target of the image macro is resolved relative to `imagesdir`.
|
3716
3782
|
If the image macro syntax is not used, the value is resolved relative to the base directory, which defaults to the document directory.
|
3717
|
-
.
|
3718
|
-
|
3719
|
-
|
3720
|
-
|
3721
|
-
|
3722
|
-
For more details, see http://discuss.asciidoctor.org/Asciidoctor-YAML-style-file-for-PDF-and-maven-td3849.html[this thread].
|
3783
|
+
. By default, page background images are automatically scaled to fit the bounds of the page (i.e., `fit=contain`).
|
3784
|
+
The size of the background can be controlled using any of the sizing attributes on the image macro (i.e., fit, pdfwidth, scaledwidth, or width).
|
3785
|
+
If the recto (right-hand, odd-numbered pages) or verso (left-hand, even-numbered pages) background is specified, it will be used only for that side.
|
3786
|
+
If a background image isn't specified for a side, the converter will use the default page background image (`page-background-image`), if specified.
|
3787
|
+
To disable the background for a side, use the value `none`.
|
3723
3788
|
. Controls whether the `page-number` attribute is accessible to the running header and footer content specified in the theme file.
|
3724
3789
|
Use the `noheader` and `nofooter` attributes to disable the running header and footer, respectively, from the document.
|
3725
3790
|
. Enables generation of the http://milan.kupcevic.net/ghostscript-ps-pdf/#marks[pdfmark] file, which contains metadata that is fed to Ghostscript when optimizing the PDF file.
|
3726
|
-
. _(Experimental)_ The `text-
|
3727
|
-
The value of this attribute overrides the `
|
3791
|
+
. _(Experimental)_ The `text-align` document attribute is intended as a simple way to toggle text justification.
|
3792
|
+
The value of this attribute overrides the `base-align` key set by the theme.
|
3728
3793
|
For more fine-grained control, you should customize using the theme.
|
3729
3794
|
. Force a title page to be added even when the doctype is not book.
|
3730
3795
|
|
@@ -3740,7 +3805,7 @@ The following sections describe the behaviors that this setting activates.
|
|
3740
3805
|
|
3741
3806
|
=== Double-Sided Page Margins
|
3742
3807
|
|
3743
|
-
The page margins for the recto (right-hand, odd-numbered) and verso (left-hand, even-numbered) pages are automatically calculated by replacing the side page margins with the values of the `
|
3808
|
+
The page margins for the recto (right-hand, odd-numbered) and verso (left-hand, even-numbered) pages are automatically calculated by replacing the side page margins with the values of the `page-margin-inner` and `page-margin-outer` keys.
|
3744
3809
|
|
3745
3810
|
For example, let's assume you've defined the following settings in your theme:
|
3746
3811
|
|
@@ -3748,8 +3813,8 @@ For example, let's assume you've defined the following settings in your theme:
|
|
3748
3813
|
----
|
3749
3814
|
page:
|
3750
3815
|
margin: [0.5in, 0.67in, 0.67in, 0.67in]
|
3751
|
-
|
3752
|
-
|
3816
|
+
margin-inner: 0.75in
|
3817
|
+
margin-outer: 0.59in
|
3753
3818
|
----
|
3754
3819
|
|
3755
3820
|
The page margins for the recto and verso pages will be resolved as follows:
|