diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2021-05-07 14:15:40 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2021-05-07 14:18:34 -0600 |
| commit | 0621fd666434f4df9bf2e6661b5af1bcc23cff26 (patch) | |
| tree | e863e66ef6a94a14ecc7a885bb301f7c94dfe5ef | |
| parent | d885c413ca34b9075fab23590133d72634711cfd (diff) | |
clarify the default image width setting in the README [skip ci]
| -rw-r--r-- | README.adoc | 6 | ||||
| -rw-r--r-- | docs/theming-guide.adoc | 5 |
2 files changed, 8 insertions, 3 deletions
diff --git a/README.adoc b/README.adoc index 3d2d6852..5e37bea5 100644 --- a/README.adoc +++ b/README.adoc @@ -547,7 +547,7 @@ In all cases, the width is converted to pt. === Specifying a default width -If you want to scale all block images that don't have a pdfwidth or scaledwidth attribute specified, assign a value to the image_width key in your theme. +To scale all block images that don't define either a `pdfwidth` or `scaledwidth` attribute on the image macro, assign a value to the image-width key in your theme file. [source,yaml] ---- @@ -555,6 +555,10 @@ image: width: 100% ---- +The image-width key accepts the same values as the `pdfwidth` attribute. +Thus, you can think of it as the fallback value for the `pdfwidth` attribute. +If specified, this value takes precedence over the `width` attribute on the image macro. + === Inline Image Sizing Inline images can be sized in much the same way as block images (using the pdfwidth, scaledwidth or width attributes), with the following exceptions: diff --git a/docs/theming-guide.adoc b/docs/theming-guide.adoc index c1a4b37c..5b614573 100644 --- a/docs/theming-guide.adoc +++ b/docs/theming-guide.adoc @@ -3384,8 +3384,9 @@ The keys in this category control the arrangement of block images. max-width: fit-content |=== -. Only applies to block images. -If specified, this value takes precedence over the value of the `width` attribute on the image macro, but not over the value of the `pdfwidth` attribute. +. Only applies to block images that don't have either a `pdfwidth` or `scaledwidth` attribute on the image macro. +If specified, this value takes precedence over the value of the `width` attribute on the image macro, but not over the value of the `pdfwidth` or `scaledwidth` attributes. +This key accepts the same values as the `pdfwidth` attribute. . The border is only used if a border color is specified, the border width is specified, the border width is greater than 0, and the `noborder` role is not present. The border is drawn above the image on the inside of the box reserved for the image. . The value `auto` means the border should expand to fit the width of the container (i.e., full width) instead of the image. |