From b4464627695b202fffff32ba206de1400d8ea78a Mon Sep 17 00:00:00 2001 From: Julian Cable Date: Tue, 18 Jan 2022 12:06:05 +0000 Subject: [PATCH 1/2] 337 Add guidance about referring to UI elements and other publication titles --- en-US/Design.xml | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/en-US/Design.xml b/en-US/Design.xml index 42f4694..76696d0 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -15,15 +15,20 @@ Capitalization - The standard for all Red Hat technical documentation is title case for all headings and titles. + The standard for all Red Hat technical documentation is title case for all headings and titles. Table headings, procedure headings, and formal paragraph titles fall under this heading, and consequently, standard title case capitalization rules apply. - The currently accepted reference for determining title case is at https://titlecase.com/titlecase. - - - Use sentence case for captions, legends, diagram labels, and table column headers. + + + Use title case also when referring to the titles of other publications, even if the title on the publication itself uses different casing. + + + The currently accepted reference for determining title case is at https://titlecase.com/titlecase. + + + Use sentence case for captions, legends, diagram labels, and table column headers. They are not classified as titles. - + Marketing and Brand Capitalization Guide @@ -81,9 +86,14 @@ In all cases, see the IBM Style Guide for initial guidance. The following sections highlight exceptions or cases that might otherwise cause confusion. + + + When writing about items in a user interface (UI), match the capitalization and spelling of those items from the interface. + However, if the interface contains a spelling error, then correct the spelling in your writing, and get the interface corrected if possible. + Depending on the context, an option might be to write around an incorrectly spelled interface item rather than naming it specifically.
- User Interface (UI) Elements, Punctuation, and Symbols + User Interface Elements, Punctuation, and Symbols When describing UI elements, do not include punctuation that appears on those elements, unless omission of that punctuation might lead to confusion. From 08fc13467bc4bdf3f8776aba42fcf8d8130ed65d Mon Sep 17 00:00:00 2001 From: Julian Cable Date: Wed, 19 Jan 2022 10:42:33 +0000 Subject: [PATCH 2/2] 337 Minor punctuation fix --- en-US/Design.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en-US/Design.xml b/en-US/Design.xml index 76696d0..ab20c74 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -23,7 +23,7 @@ Use title case also when referring to the titles of other publications, even if the title on the publication itself uses different casing. - The currently accepted reference for determining title case is at https://titlecase.com/titlecase. + The currently accepted reference for determining title case is at https://titlecase.com/titlecase. Use sentence case for captions, legends, diagram labels, and table column headers.