Skip to content

Clarify capitalization for table titles #553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 18, 2024
Merged

Clarify capitalization for table titles #553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion en-US/Cross_references.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
Does the paragraph or section consist largely of links?
</para>
<para>
In running text, each paragraph should contain no more than a couple of links. Links should not occur in every paragraph, and they must not occur in titles, subheadings, figure captions, or table captions. Cross-references interrupt the flow of thought, and can actively interfere with the absorption of information. If the reader needs much extra information, rethink the structure of the section, and enrich the quality of the information. Do not let the cross-references overpower the message. A solution is to add a sentence to the end of the section to indicate where to find more information.
In running text, each paragraph should contain no more than a couple of links. Links should not occur in every paragraph, and they must not occur in titles, subheadings, or figure captions. Cross-references interrupt the flow of thought, and can actively interfere with the absorption of information. If the reader needs much extra information, rethink the structure of the section, and enrich the quality of the information. Do not let the cross-references overpower the message. A solution is to add a sentence to the end of the section to indicate where to find more information.
</para>
<note>
<para>
Expand Down
4 changes: 2 additions & 2 deletions en-US/Design.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<title>Capitalization</title>
<para>
The standard for all Red&nbsp;Hat technical documentation is title case for all headings and titles.
Table headings and procedure headings fall under this heading; standard title case capitalization rules apply.
Table titles and procedure headings fall into this category; standard title case capitalization rules apply.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you s/table headings/table titles/ then shouldn't you do the same for procedures?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree

</para>
</formalpara>
<para>
Expand All @@ -26,7 +26,7 @@
The currently accepted reference for determining title case is at <ulink url="https://titlecase.com/titlecase">https://titlecase.com/titlecase</ulink>.
</para>
<para>
Use sentence case for captions, legends, diagram labels, and table column headers.
Use sentence case for figure captions, legends, diagram labels, and table column headers.
They are not classified as titles.
</para>
<warning>
Expand Down