From 9955b8a1a964223beeb8fd95c1d5eb0964168afb Mon Sep 17 00:00:00 2001 From: daobrien Date: Fri, 4 Nov 2022 13:39:21 +1000 Subject: [PATCH 1/2] Addresses #424 Add info on using captions. A small subsection on when and when not to use captions and callouts. --- en-US/Design.xml | 111 ++++++++++++++++++++++++++++++----------------- 1 file changed, 71 insertions(+), 40 deletions(-) diff --git a/en-US/Design.xml b/en-US/Design.xml index 70da4db..14f45c1 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -21,7 +21,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. @@ -46,7 +46,7 @@ Do not use terminating periods. - + Restrictions apply to abbreviating Red Hat product or solution names in public-facing documents. Always use the full name on first use. For some products, for example Red Hat OpenShift Container Platform, you can omit "Red Hat" after the first use. - + Further restrictions apply to using acronyms and initialisms. In this same example, and only in technical documentation, "RHOCP" is acceptable after the first use of the full product name. - + Do not include "Inc." when referring to Red Hat except in legal documents. - + Do not use articles in front of product names. For example, do not write "the JBoss Enterprise Application Platform was ...". @@ -928,24 +959,24 @@ $ vi myFile.txt - + Do not hyphenate or break a product name across lines. Incorrect Example of Line Breaking - + - For advanced management capabilities with Red - Hat Satellite and cloud management services, use the Red - Hat Enterprise Linux Smart Management Add + For advanced management capabilities with Red + Hat Satellite and cloud management services, use the Red + Hat Enterprise Linux Smart Management Add -On. - - + + - +
@@ -1002,7 +1033,7 @@ $ vi myFile.txt If you are working with images or other objects where space is especially tight, this rule is more flexible, but "Red Hat" should never be broken over two lines. - + Non-breaking spaces are not needed elsewhere in a product name and might cause undesirable line-breaking behavior. In particular, do not use non-breaking spaces between extended components of Red Hat product names. For example, "Red Hat Enterprise Linux OpenStack Platform" does not require a non-breaking space between any of the words after "Red Hat". From c2fcf7a2e620503d7858232bcf3bd5b24f30a99f Mon Sep 17 00:00:00 2001 From: daobrien Date: Fri, 4 Nov 2022 21:15:53 +1000 Subject: [PATCH 2/2] Fixed a grammerior. --- 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 14f45c1..ccc1f78 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -149,7 +149,7 @@ Refer to the Figures section in the IBM Style Guide for general advice about using figures, illustrations, and screen captures. - The following specific conventions apply to using captions and callouts with figures in Red Hat technical documentation, and is generally recommended. + The following specific conventions apply to using captions and callouts with figures in Red Hat technical documentation, and are generally recommended.