Skip to content

Commit 5900648

Browse files
authored
Merge pull request #73255 from jeana-redhat/rip-smol
updates footnote recommendation
2 parents d9274c4 + 9da3200 commit 5900648

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1632,8 +1632,7 @@ footnoteref:[ref-string, This is the footnote text.]
16321632

16331633
==== Alternative footnote styling in tables
16341634

1635-
For footnotes in tables, use the following syntax to mimic Asciidoctor's
1636-
styling:
1635+
For footnotes in tables, use the following syntax:
16371636

16381637
....
16391638
[cols="3",options="header"]
@@ -1650,21 +1649,19 @@ styling:
16501649
|Item E ^[3]^
16511650
|Item F ^[3]^
16521651
|===
1653-
[.small]
1654-
--
1655-
1. A description.
1656-
2. Another description.
1657-
3. Two items relate to this description.
1658-
--
1652+
. A description.
1653+
. Another description.
1654+
. Two items relate to this description.
16591655
....
16601656

1661-
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.
1662-
1663-
Note the following:
1657+
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.
16641658

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

16691666
[id="collapsible-content"]
16701667
=== Collapsible content

0 commit comments

Comments
 (0)