search

StyleGuides / WritingStyleGuide

The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Creative Commons Attribution Share Alike 4.0 International
71 stars 20 forks source link

Clarify the use of titles and captions with tables and images #534

Closed alexpdp7 closed 8 months ago

alexpdp7 commented 11 months ago

Titles use title case, while captions use sentence case.

However, it is not obvious that what we use for tables are titles; IBM calls those captions:

https://www.ibm.com/docs/en/ibm-style?topic=format-tables#captions

So if we followed that, then:

https://stylepedia.net/style/6.1/#heading-styles

Tells us that captions are sentence case, which is contrary to what we are currently doing.

I suggest we clarify that the thing we put on a table is a "title", not a caption.

daobrien commented 11 months ago

Might also need to review https://stylepedia.net/style/6.1/#informationlink-ratio which referes to table captions.