Skip to content

Commit 9da3200

Browse files
committed
updates footnote recommendation
1 parent 18718c3 commit 9da3200

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
@@ -1627,8 +1627,7 @@ footnoteref:[ref-string, This is the footnote text.]
16271627

16281628
==== Alternative footnote styling in tables
16291629

1630-
For footnotes in tables, use the following syntax to mimic Asciidoctor's
1631-
styling:
1630+
For footnotes in tables, use the following syntax:
16321631

16331632
....
16341633
[cols="3",options="header"]
@@ -1645,21 +1644,19 @@ styling:
16451644
|Item E ^[3]^
16461645
|Item F ^[3]^
16471646
|===
1648-
[.small]
1649-
--
1650-
1. A description.
1651-
2. Another description.
1652-
3. Two items relate to this description.
1653-
--
1647+
. A description.
1648+
. Another description.
1649+
. Two items relate to this description.
16541650
....
16551651

1656-
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.
1657-
1658-
Note the following:
1652+
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.
16591653

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

16641661
[id="collapsible-content"]
16651662
=== Collapsible content

0 commit comments

Comments
 (0)