summaryrefslogtreecommitdiff
path: root/docs/modules
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2023-06-27 23:51:10 -0600
committerDan Allen <dan.j.allen@gmail.com>2023-06-28 03:11:20 -0600
commit9c12ed5f067a337b22ed1e2131697f0122e6cae8 (patch)
treeff0f37670d23fffac59427a9f6610a8907dff5fd /docs/modules
parentee40e0088ad384651ab9d344d08ad77cb8aa6069 (diff)
clarify that breakable does not keep title with table when using the bottom placement for caption
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/ROOT/pages/breakable-and-unbreakable.adoc6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/modules/ROOT/pages/breakable-and-unbreakable.adoc b/docs/modules/ROOT/pages/breakable-and-unbreakable.adoc
index a4a8ed00..fb70d351 100644
--- a/docs/modules/ROOT/pages/breakable-and-unbreakable.adoc
+++ b/docs/modules/ROOT/pages/breakable-and-unbreakable.adoc
@@ -40,7 +40,7 @@ Since these blocks are already breakable by default, this option is merely a pub
=== Table
-The `breakable` option can be applied to a table to ensure the anchor and title are kept with the table if the table gets advanced to the next page.
+The `breakable` option can be applied to a table to ensure the anchor and title (i.e., caption) are kept with the table if the table gets advanced to the next page.
[,asciidoc]
----
@@ -54,6 +54,10 @@ The `breakable` option can be applied to a table to ensure the anchor and title
----
<.> Assign the `breakable` option to a table, using the shorthand percent symbol (`%`) for the `option` attribute name, to indicate that the table's title and anchor should be kept with the table.
+The behavior to keep the title with the table is _only_ supported if the table caption is in its default end placement above the table (i.e., `top`).
+If the theme configures the caption end placement (`table-caption-end`) below the table (i.e., `bottom`), the title could be widowed on the next page.
+The lack of widow prevention for the title when placed below the table is due to a limitation in how this converter is implemented.
+
[#section-or-discrete-heading]
=== Section or discrete heading