Title case or sentence case for diagram label

[herve4m]

I do not understand which case design (case vs title) I should use for diagram labels.

WritingStyleGuide/en-US/Design.xml

Line 19 in 93abd0d

Diagram labels, table headings, procedure, and formal paragraph titles all fall under this heading, and consequently, standard title case capitalization rules apply.

One sentence says:

The standard for all Red Hat technical documentation is title case for all headings and titles. Diagram labels, table headings, procedure, and formal paragraph titles all fall under this heading, and consequently, standard title case capitalization rules apply.

And the next one says:

Use sentence case for captions, legends, diagram labels, and table column headers.

[daobrien]

Thanks @herve4m as soon as my connection is back up I'll dig in and have a look and let you know.

[daobrien]

I think I can see what's happened there. That was an addition to the last release and I think we need to clean up our terminology a bit.
I'll try to clarify with some diagrams:
"Table 2.1" is a title (not a very good one, but requires title case nonetheless). Both "Example" and "Improvement" are table column headers and require sentence case. See Table 2.7 for a better example of a correctly formatted title.

I'm disinclined to use the term "label" at all except perhaps to identify different parts of a diagram. Refer to the following:

This illustrates a screen capture with a correctly formatted title (title case) and caption (sentence case). The only labels that I would identify as such are part of the UI itself (Applications, Builds, and so on).

Does that clarify? If so, we can go ahead and update that subsection.

[daobrien]

And I've just realised that the title is not quite correct :( It should be "Navigating Menus in a Web UI".

[herve4m]

In AsciiDoc, the syntax we use to introduce diagrams is:

.Reviewing the import log
image::images/create/log.png[scalefit="1",width="100%",align="center"]

The rendering is, both in PDF and in ROL:

There is only one "title/label (?)" after the diagram "Figure 9.1: Reviewing the import log". I've never seen a "title/label" both before and after the diagram.

Maybe the irrelevant part could be removed from the style guide.

Skeleton references:

https://github.com/RedHatTraining/skeleton/blob/main/documentation/ref_guide.adoc#images
https://github.com/RedHatTraining/skeleton/blob/main/documentation/sample-attributes.adoc#images

[daobrien]

So in this case, .Reviewing the import log specifies the caption. I don't know if AsciiDoc supports titles in this situation, or if we'd ever use them. Some use cases use both (as shown in the Style Guide example), but remember that the Style Guide covers a wide range of use cases, not just GLS, and not just Red Hat.

I agree the Style Guide guidance needs a bit of repair, but it's all relevant. Just because GLS doesn't use titles on screen captures doesn't mean they're irrelevant.

[julian-cable]

Removed "Diagram labels" from list of title case elements.