Skip to content

Commit b9307af

Browse files
committed
clarify that foreground image is configured much like the background image, with some limitations
1 parent a13427d commit b9307af

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

docs/modules/ROOT/pages/background-images.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@
44
You can add a background image to all content pages in your document by setting the `page-background-image` document attribute.
55
You can also set the background images for recto and verso pages separately using the `page-background-image-recto` and `page-background-image-verso` document attributes.
66
You can set (or override) the background image applied to the title page using the `title-page-background-image` document attribute.
7+
If you want to overlay a background image on top of the page content (i.e., a watermark), you can do so using the `page-foreground-image`.
78

8-
This page explains how these attributes are used.
9+
This page explains how these document attributes are used.
10+
It also covers how attributes on the image macro can be used to control the size, fit, and position of the image.
911
All the document attributes covered on this page must be defined in the document header.
1012

11-
As an alternative to using document attributes, you can define these background images xref:theme:images.adoc[in your theme].
13+
As an alternative to using document attributes, you can define these background images and the foreground image xref:theme:images.adoc[in your theme].
1214

1315
[#page-background-image]
1416
== page-background-image attribute
@@ -17,6 +19,9 @@ Background images can be applied to all content pages using the `page-background
1719
A content page is defined as every page in the document except for cover and imported pages.
1820
The list of content pages includes the title page as well as non-facing pages in a prepress document.
1921

22+
NOTE: As a counterpart, a foreground image can be added to all pages using the `page-foreground-image`.
23+
Unlike the background image, the foreground image cannot be added per side or page layout.
24+
2025
The `page-background-image` attribute accepts an inline image macro.
2126
The target of the image macro can be xref:image-paths-and-formats.adoc#imagesdir[an absolute path or a path relative to imagesdir].
2227

0 commit comments

Comments
 (0)