summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2022-07-20 23:50:47 -0600
committerDan Allen <dan.j.allen@gmail.com>2022-07-21 01:21:01 -0600
commit8a87f0c21bed715079bc60620c693073b4c6db48 (patch)
tree0b35a4e3c1d83cf2c14dd97946cec80231a9fe02 /docs
parent92b854bcc51426ff3bc038837f5fb978c9db8987 (diff)
add a description to the page-count attribute and use it in an example
Diffstat (limited to 'docs')
-rw-r--r--docs/modules/theme/pages/add-running-content.adoc8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/modules/theme/pages/add-running-content.adoc b/docs/modules/theme/pages/add-running-content.adoc
index 3bb1ebdf..6b5b37e5 100644
--- a/docs/modules/theme/pages/add-running-content.adoc
+++ b/docs/modules/theme/pages/add-running-content.adoc
@@ -92,7 +92,7 @@ To learn more about the default page numbering and how to customize the numberin
You can use any attribute defined in your AsciiDoc document (such as `doctitle`) in the content of the running header and footer.
In addition, the following attributes are also available when defining the content keys in the footer:
-* `page-count`
+* `page-count` - the highest page number in the document (not necessarily the number of physical pages)
* `page-number` (only set if the `pagenums` attribute is set on the document, which it is by default)
* `page-layout`
* `document-title`
@@ -113,7 +113,7 @@ If you unset the `pagenums` attribute on the document, any line in the running c
You can also use built-in AsciiDoc text replacements like `+(C)+`, numeric character references like `+&#169;+`, hexadecimal character references like `+&#x20ac;+`, and inline formatting (e.g., bold, italic, monospace).
-Here's an example that shows how attributes and replacements can be used in the running footer:
+Here's an example that shows how attributes and replacements can be used in the running content:
[,yaml]
----
@@ -132,10 +132,10 @@ footer:
line-height: 1
recto:
right:
- content: '{section-or-chapter-title} | *{page-number}*'
+ content: '{section-or-chapter-title} | {page-number} of {page-count}'
verso:
left:
- content: '*{page-number}* | {chapter-title}'
+ content: '{page-number} of {page-count} | *{chapter-title}*'
----
== Multi-line values