From 0a8e35cc9c21f90189dbb8e50b80642977e354d5 Mon Sep 17 00:00:00 2001 From: Dan Allen Date: Thu, 13 Jun 2024 13:59:36 -0600 Subject: [PATCH] clarify that foreground image is configured much like the background image, with some limitations --- docs/modules/ROOT/pages/background-images.adoc | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/modules/ROOT/pages/background-images.adoc b/docs/modules/ROOT/pages/background-images.adoc index 1c992138f..6f79d623c 100644 --- a/docs/modules/ROOT/pages/background-images.adoc +++ b/docs/modules/ROOT/pages/background-images.adoc @@ -4,11 +4,13 @@ You can add a background image to all content pages in your document by setting the `page-background-image` document attribute. 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. You can set (or override) the background image applied to the title page using the `title-page-background-image` document attribute. +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`. -This page explains how these attributes are used. +This page explains how these document attributes are used. +It also covers how attributes on the image macro can be used to control the size, fit, and position of the image. All the document attributes covered on this page must be defined in the document header. -As an alternative to using document attributes, you can define these background images xref:theme:images.adoc[in your theme]. +As an alternative to using document attributes, you can define these background images and the foreground image xref:theme:images.adoc[in your theme]. [#page-background-image] == page-background-image attribute @@ -17,6 +19,9 @@ Background images can be applied to all content pages using the `page-background A content page is defined as every page in the document except for cover and imported pages. The list of content pages includes the title page as well as non-facing pages in a prepress document. +NOTE: As a counterpart, a foreground image can be added to all pages using the `page-foreground-image`. +Unlike the background image, the foreground image cannot be added per side or page layout. + The `page-background-image` attribute accepts an inline image macro. The target of the image macro can be xref:image-paths-and-formats.adoc#imagesdir[an absolute path or a path relative to imagesdir].