From b628c6300136277660adc596a4debb62279a3df1 Mon Sep 17 00:00:00 2001 From: Julian Cable Date: Wed, 4 Aug 2021 11:33:32 +0100 Subject: [PATCH 1/4] Changed Times of day guidance. --- en-US/A.xml | 14 +++++++------- en-US/Language.xml | 18 ++++++++++-------- en-US/P.xml | 12 ++++++------ 3 files changed, 23 insertions(+), 21 deletions(-) diff --git a/en-US/A.xml b/en-US/A.xml index 75cf57e..88f62a4 100644 --- a/en-US/A.xml +++ b/en-US/A.xml @@ -94,16 +94,16 @@ - a.m. - + AM + - + + + + For times of day, use uppercase without periods, and use a preceding nonbreaking space after the numeral, for example "11 AM". + See also . diff --git a/en-US/Language.xml b/en-US/Language.xml index 22aec39..571c08f 100644 --- a/en-US/Language.xml +++ b/en-US/Language.xml @@ -1264,26 +1264,28 @@ Numbers (move from N entry) --> Exception: Use of an all-numeric representation is allowed when space is limited, as in a user interface, or to enhance readability. In such cases, use the ISO date format with a 4-digit year (YYYY-MM-DD) and define the format in a header or legend. - + + For times of day, use uppercase without periods, such as "11 AM". Use a nonbreaking space between the numeral and "AM" or "PM". - --> + - Use "noon" or "12 noon" instead of "12 p.m.". - Use "midnight" or "12 midnight" instead of "12 a.m.". + Use "noon" or "12 noon" instead of "12 PM". + Use "midnight" or "12 midnight" instead of "12 AM". Examples - The training class begins at 10 a.m. on 1 April 2021. + The training class begins at 10 AM on 1 April 2021. + + - The coffee break is from 2:00 p.m. to 2:30 p.m. + The coffee break is from 2:00 PM to 2:30 PM. diff --git a/en-US/P.xml b/en-US/P.xml index 52325fd..1b63f69 100644 --- a/en-US/P.xml +++ b/en-US/P.xml @@ -121,15 +121,15 @@ - p.m. + PM - + + + + For times of day, use uppercase without periods, and use a preceding nonbreaking space after the numeral, for example "2 PM". + See also . From f9dbf039b8f582a5c25ba4d774e34d04b70d6a3a Mon Sep 17 00:00:00 2001 From: Julian Cable Date: Wed, 4 Aug 2021 12:03:14 +0100 Subject: [PATCH 2/4] Added release notes in Markdown. --- en-US/rel_notes.md | 68 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 en-US/rel_notes.md diff --git a/en-US/rel_notes.md b/en-US/rel_notes.md new file mode 100644 index 0000000..c7b8bbe --- /dev/null +++ b/en-US/rel_notes.md @@ -0,0 +1,68 @@ +# Red Hat Style Guide: Version 5.0 Release Notes, July 2021 + +Changed guide title to “Red Hat Technical Writing Style Guide”. Changed subtitle to “Style Conventions for Writers and Editors”. + +Several updates, following a review of latest IBM Style Guide. Added inclusive language guidance. + +Removed guidance about DocBook and markup, to focus instead on writing. + +Deleted obsolete references, such as to diskettes and fax machines. + +Minor edits so the guide itself conforms more fully with its own advice. + +## Chapter 2, Grammar: + +* Added section on use of relative pronoun “that”. +* Punctuation: Added sections: + - Exclamation Points + - Referring to Punctuation Marks + - Names of Punctuation Marks and Special Characters + +## Chapter 3, Design: +* Clarified that sentence case is required for captions, legends, and diagram labels. +* Added subsection on phraseology for changing to the root user. + +## Chapter 4, renamed to "Choosing Appropriate Language". +Expanded scope beyond slang and jargon, to cover the following additional topics: +* Inclusive Language +* Phrasal Verbs (two-word verb forms) +* Avoiding Ambiguities (moved from Chapter 2 and added more categories) +* Dates and Times +Changed times of day standard from “a.m.”, “p.m.” to “AM”, “PM”. +* Numbers + +## Usage A-Z: +* Various additions and updates. Corrected alphabetical sorting sequence. +* Moved items that are not literal term entries to an earlier chapter. +* Entries previously used a mixture of "v." and "vb." to denote a verb. Changed all occurrences to "v." +* Added entries: + - appendixes + - as long as + - blacklist + - colocate, colocation + - display + - following + - i.e. + - indexes + - login, log in, log in to + - master + - sign in, sign in to + - slave + - whitelist + - wish +* Updated entries: + - backwards-compatible + - high-availability + - hostname + - OK + - please + - setup + - username + - ZIP Code +* Deleted entries: + - e-business + - floppy disk, floppy drive + - IBM eServer System p + - iSeries + - pSeries + - zSeries \ No newline at end of file From ecd28d71f73df154907f4ccea096c8b3ce305d82 Mon Sep 17 00:00:00 2001 From: Julian Cable Date: Thu, 5 Aug 2021 10:54:55 +0100 Subject: [PATCH 3/4] Updated release notes. --- en-US/rel_notes.md | 69 +++++++++------------------------------------- 1 file changed, 13 insertions(+), 56 deletions(-) diff --git a/en-US/rel_notes.md b/en-US/rel_notes.md index c7b8bbe..1781a79 100644 --- a/en-US/rel_notes.md +++ b/en-US/rel_notes.md @@ -2,67 +2,24 @@ Changed guide title to “Red Hat Technical Writing Style Guide”. Changed subtitle to “Style Conventions for Writers and Editors”. -Several updates, following a review of latest IBM Style Guide. Added inclusive language guidance. +Added inclusive language guidance. -Removed guidance about DocBook and markup, to focus instead on writing. +Added section on use of relative pronoun “that”. + +Added sections on exclamation points and referring to punctuation marks. -Deleted obsolete references, such as to diskettes and fax machines. +Clarified that sentence case is required for captions, legends, and diagram labels. -Minor edits so the guide itself conforms more fully with its own advice. +Added section on phrasal verbs (two-word verb forms). -## Chapter 2, Grammar: +Added more categories of ambiguities to avoid. -* Added section on use of relative pronoun “that”. -* Punctuation: Added sections: - - Exclamation Points - - Referring to Punctuation Marks - - Names of Punctuation Marks and Special Characters +Dates and Times: Changed times of day standard from “a.m.”, “p.m.” to “AM”, “PM”. -## Chapter 3, Design: -* Clarified that sentence case is required for captions, legends, and diagram labels. -* Added subsection on phraseology for changing to the root user. +Usage A-Z added entries: appendixes, as long as, blacklist, colocate/colocation, display, following, i.e., indexes, login/log in/log in to, master, sign in/sign in to, slave, whitelist, wish -## Chapter 4, renamed to "Choosing Appropriate Language". -Expanded scope beyond slang and jargon, to cover the following additional topics: -* Inclusive Language -* Phrasal Verbs (two-word verb forms) -* Avoiding Ambiguities (moved from Chapter 2 and added more categories) -* Dates and Times -Changed times of day standard from “a.m.”, “p.m.” to “AM”, “PM”. -* Numbers +Updated entries: backwards-compatible, high-availability, hostname, lifecycle, OK, please, setup, username, ZIP Code + +Removed guidance about DocBook and markup, to focus instead on writing. -## Usage A-Z: -* Various additions and updates. Corrected alphabetical sorting sequence. -* Moved items that are not literal term entries to an earlier chapter. -* Entries previously used a mixture of "v." and "vb." to denote a verb. Changed all occurrences to "v." -* Added entries: - - appendixes - - as long as - - blacklist - - colocate, colocation - - display - - following - - i.e. - - indexes - - login, log in, log in to - - master - - sign in, sign in to - - slave - - whitelist - - wish -* Updated entries: - - backwards-compatible - - high-availability - - hostname - - OK - - please - - setup - - username - - ZIP Code -* Deleted entries: - - e-business - - floppy disk, floppy drive - - IBM eServer System p - - iSeries - - pSeries - - zSeries \ No newline at end of file +Minor edits so the guide itself conforms more fully with its own advice. \ No newline at end of file From 81a5f7e9a2759ec4c61c9c83018ec87118aff79e Mon Sep 17 00:00:00 2001 From: Julian Cable Date: Thu, 5 Aug 2021 11:20:31 +0100 Subject: [PATCH 4/4] Times of day updates --- en-US/A.xml | 8 -------- en-US/Language.xml | 10 +++------- en-US/P.xml | 7 ------- 3 files changed, 3 insertions(+), 22 deletions(-) diff --git a/en-US/A.xml b/en-US/A.xml index 88f62a4..5b4dcf8 100644 --- a/en-US/A.xml +++ b/en-US/A.xml @@ -95,21 +95,13 @@ AM - - - For times of day, use uppercase without periods, and use a preceding nonbreaking space after the numeral, for example "11 AM". See also . - diff --git a/en-US/Language.xml b/en-US/Language.xml index 571c08f..6a76d1d 100644 --- a/en-US/Language.xml +++ b/en-US/Language.xml @@ -1264,23 +1264,19 @@ Numbers (move from N entry) --> Exception: Use of an all-numeric representation is allowed when space is limited, as in a user interface, or to enhance readability. In such cases, use the ISO date format with a 4-digit year (YYYY-MM-DD) and define the format in a header or legend. - - For times of day, use uppercase without periods, such as "11 AM". Use a nonbreaking space between the numeral and "AM" or "PM". - Use "noon" or "12 noon" instead of "12 PM". - Use "midnight" or "12 midnight" instead of "12 AM". + Use "noon" or "12 noon" instead of "12 PM". + Use "midnight" or "12 midnight" instead of "12 AM". Examples - The training class begins at 10 AM on 1 April 2021. + The training class begins at 10 AM on 1 April 2021. diff --git a/en-US/P.xml b/en-US/P.xml index 1b63f69..31aa693 100644 --- a/en-US/P.xml +++ b/en-US/P.xml @@ -123,19 +123,12 @@ PM - - For times of day, use uppercase without periods, and use a preceding nonbreaking space after the numeral, for example "2 PM". See also . -