Skip to content

Commit

Permalink
Merge pull request #73255 from jeana-redhat/rip-smol
Browse files Browse the repository at this point in the history
updates footnote recommendation
  • Loading branch information
jeana-redhat authored Mar 20, 2024
2 parents d9274c4 + 9da3200 commit 5900648
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions contributing_to_docs/doc_guidelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1632,8 +1632,7 @@ footnoteref:[ref-string, This is the footnote text.]

==== Alternative footnote styling in tables

For footnotes in tables, use the following syntax to mimic Asciidoctor's
styling:
For footnotes in tables, use the following syntax:

....
[cols="3",options="header"]
Expand All @@ -1650,21 +1649,19 @@ styling:
|Item E ^[3]^
|Item F ^[3]^
|===
[.small]
--
1. A description.
2. Another description.
3. Two items relate to this description.
--
. A description.
. Another description.
. Two items relate to this description.
....

The notes are kept immediately after the table, instead of moved to the bottom of the rendered assembly. This manual method also allows you to reuse the same footnote number for multiple references as needed.

Note the following:
The notes immediately follow the table, instead of appearing at the bottom of the rendered assembly. With this manual method, you can also reuse the same footnote number for more than one reference.

[NOTE]
====
* Because this method uses a standard ordered list, you might find it helpful to use numbers (such as `1.` instead of `.`) while writing.
* Add a space before the superscripted numbers with square brackets.
* To match the table cell's font size, start the ordered list with a `[.small]`
style and wrap it in a `--` block.
* Older versions of these guidelines recommended the use of the deprecated `[.small]` style. The Red Hat Customer Portal does not support this style.
====

[id="collapsible-content"]
=== Collapsible content
Expand Down

0 comments on commit 5900648

Please sign in to comment.