asciidoctor-pdf 1.5.0.alpha.17 → 1.5.0.beta.1

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