summaryrefslogtreecommitdiff
path: root/docs/modules/theme/pages
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2022-06-10 15:07:33 -0600
committerGitHub <noreply@github.com>2022-06-10 15:07:33 -0600
commitf4bd057f69b3d72da73bf20e31fca7a2bfedbf3a (patch)
treeeee20f12c66dad23f8f57c8e5e3b2f97f5cc5951 /docs/modules/theme/pages
parent8d25b995f19cd8ada4b692227e59bf7c33dc3868 (diff)
resolves #327 arrange body of article or manpage doctype into multiple columns if page-columns key is set in theme (PR #2232)
Diffstat (limited to 'docs/modules/theme/pages')
-rw-r--r--docs/modules/theme/pages/page.adoc23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/modules/theme/pages/page.adoc b/docs/modules/theme/pages/page.adoc
index 64df40f7..97c5852c 100644
--- a/docs/modules/theme/pages/page.adoc
+++ b/docs/modules/theme/pages/page.adoc
@@ -39,6 +39,21 @@ page:
recto: image:page-bg-recto.png[]
verso: image:page-bg-verso.png[]
+|columns
+|Integer +
+(default: _not set_)
+|[source]
+page:
+ columns: 2
+
+|column_gap
+|xref:measurement-units.adoc[Measurement] +
+(default: _$base-font-size_)
+|[source]
+page:
+ columns: 2
+ columns_gap: 12
+
|xref:images.adoc#foreground[foreground-image]
|xref:images.adoc#specify[image macro] {vbar} xref:images.adoc#specify[path] +
(default: _not set_)
@@ -111,6 +126,14 @@ If no cover is specified, the recto margin is not applied to the title page.
To apply the recto margin to the title page, but not include a cover, assign the value `~` to the `front-cover-image` and `back-cover-image` attributes.
See xref:cover.adoc[] for information about the `cover` category keys.
+[#columns]
+=== Columns
+
+The columns are only applied to the body of a document with the article or manpage doctype.
+The body of the document begins after the document title and TOC, if present.
+
+If the columns are set on the index section using the `index-columns` key, they will be ignored when `page-columns` is set.
+
[#numbering]
== page-numbering