diff --git a/en-US/A.xml b/en-US/A.xml index 044cebd..12d5359 100644 --- a/en-US/A.xml +++ b/en-US/A.xml @@ -19,16 +19,16 @@ AArch64, aarch64 - n. A 64-bit version of the ARM architecture. - Use this term when referring to operating systems and server instances, for example Red Hat Enterprise Linux, Fedora, CoreOS, and other Linux distributions. + n. A 64-bit version of the ARM architecture. + Use this term when referring to operating systems and server instances, for example Red Hat Enterprise Linux, Fedora, CoreOS, and other Linux distributions. Use the uppercase (AArch64) format in general cases when referring to system architecture. - Use the lowercase (aarch64) format only when referring to objects or parameters. + Use the lowercase (aarch64) format only when referring to objects or parameters. It can be styled as code (monospace font or a code-styled block) when referring to code. - Cloud providers might use different formats of this term to refer to architectures. + Cloud providers might use different formats of this term to refer to architectures. If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case. @@ -145,16 +145,16 @@ AMD64, amd64 - n. The AMD 64-bit version of the x86 architecture. - Use this term for Red Hat OpenShift Container Platform attributes, Kubernetes, operators, application programming interfaces (APIs), or command-line interface (CLI) objects. + n. The AMD 64-bit version of the x86 architecture. + Use this term for Red Hat OpenShift Container Platform attributes, Kubernetes, operators, application programming interfaces (APIs), or command-line interface (CLI) objects. Use the uppercase format (AMD64) in general sentences when referring to Red Hat OpenShift Container Platform features. - Use the lowercase format (amd64) only when referring to objects or parameters. + Use the lowercase format (amd64) only when referring to objects or parameters. It can be styled as code (monospace font or a code-styled block) when referring to code. - Cloud providers might use different formats of this term to refer to architectures. + Cloud providers might use different formats of this term to refer to architectures. If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case. @@ -196,16 +196,16 @@ ARM64, arm64 - n. A 64-bit version of the ARM architecture. - Use this term for Red Hat OpenShift Container Platform attributes, Kubernetes, operators, application programming interfaces (APIs), and command-line interface (CLI) objects. + n. A 64-bit version of the ARM architecture. + Use this term for Red Hat OpenShift Container Platform attributes, Kubernetes, operators, application programming interfaces (APIs), and command-line interface (CLI) objects. Use the uppercase format (ARM64) in general sentences when referring to Red Hat OpenShift Container Platform features. - Use lowercase format (arm64) only when referring to objects or parameters. + Use lowercase format (arm64) only when referring to objects or parameters. It can be styled as code (monospace font or a code-styled block) when referring to code. - Cloud providers might use different formats of this term to refer to architectures. + Cloud providers might use different formats of this term to refer to architectures. If you are documenting code, commands, or outputs, then confer with your subject-matter expert on the correct format for the specific use case. @@ -303,7 +303,7 @@ artificial intelligence (AI) - Unless clarity requires it or the concept is being introduced or explained, "artificial intelligence" does not have to be spelled out on first use; "AI" is understood and suffices. When spelling it out, do not capitalize the term. + Unless clarity requires it or the concept is being introduced or explained, "artificial intelligence" does not have to be spelled out on first use; "AI" is understood and suffices. When spelling it out, do not capitalize the term unless it is part of a proper noun. @@ -319,34 +319,40 @@ - DRaaS (Disaster Recovery-as-a-Service) + AIaaS (Artificial Intelligence-as-a-Service) - + - UCaaS (Unified Communications-as-a-Service) + CaaS (Cloud-as-a-Service, Communications-as-a-Service, ) - + - SaaS (Search-as-a-Service, Security-as-a-Service, Storage-as-a-Service, or Software-as-a-Service) + IaaS (Infrastructure-as-a-Service) + PaaS (Payments-as-a-Service, Platform-as-a-Service) @@ -355,11 +361,11 @@ - MaaS (Messaging-as-a-Service, Metal-as-a-Service) + SaaS (Search-as-a-Service, Security-as-a-Service, Software-as-a-Service, or Storage-as-a-Service) - + @@ -400,7 +412,7 @@ - Avoid use of an acronym if it could stand for more than one term in a single asset. for example, if you are writing content that discusses both Cloud-as-a-Service and Containers-as-a-Service. + Avoid using an acronym if it could stand for more than one term in a single asset: for example, if you are writing content that discusses both Cloud-as-a-Service and Containers-as-a-Service. @@ -414,10 +426,10 @@ as Code - Use camel case for both the full term and the acronym. + Use camel case for both the full term and the acronym. Do not hyphenate. Some "as Code" acronyms might overlap. - To avoid confusion, always spell out the full term on first use. + To avoid confusion, always spell out the full term on first use. Examples: diff --git a/en-US/Design.xml b/en-US/Design.xml index 7411bd1..44f6644 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -50,7 +50,7 @@ Writing Effective Titles - Use a title that represents the content. + Use titles that represent the content. @@ -63,7 +63,7 @@ In some cases, a verb might not be appropriate because the content is purely informational. Instead of using a vague verb like "Understanding", "Describing", "Introducing", or "Exploring", either use a more specific verb, or use a noun phrase instead of a verb. A noun phrase is descriptive and omits a verb, for example "OpenShift Operators" or "The OpenShift Web Console." - Avoid a title that consists of only one word. + Avoid titles that consist of only one word. @@ -88,12 +88,12 @@ Introducing Cluster Updates Cluster Updates - + MetalLB The MetalLB Component - + @@ -486,12 +486,12 @@ $ vi myFile.txt On Windows operating systems, use the backtick character (`). - + For content that is potentially used in multiple operating systems, use the Linux shell continuation character, and include an explanatory sentence before the command. - + Do not use manual line indentation for the second and subsequent lines of commands. - For some output formats, no control is possible over where lines would break, and any indentation might appear as extra spaces in inelegant places. + For some output formats, no control is possible over where lines would break, and any indentation might appear as extra spaces in awkward places. Long Command Example If the memory machine pool does not exist, then create it. - + On a Microsoft Windows system, replace the line continuation character (\) in the following long command with the backtick character (`), which is the line continuation character in PowerShell. $ aws iam create-policy --policy-name RosaCloudWatch \ - --policy-document file://policy.json --query Policy.Arn --output text +--policy-document file://policy.json --query Policy.Arn --output text arn:aws:iam::452954386616:policy/RosaCloudWatch @@ -527,7 +527,8 @@ The ARN in the preceding output is different on your system.
Omitting Part of Output - For the sake of brevity, do not show all output to the user in all cases, but only those parts of any output that are relevant to the context that is described. + For the sake of brevity, do not show all output to the user in all cases. + Instead, show only those parts of any output that are relevant to the context that is described. Where output is not included, place a marker to show that information is purposely excluded. When shortening the output, use a consistent notation. For omitting entire horizontal lines of output, Red Hat uses the ...output omitted... notation, starting and ending with an ellipsis, and highlighted in italics. @@ -719,7 +720,7 @@ telemetry-operator.v1.0.0 Telemetry Operator ... --> If the file to edit is empty or does not exist, do not highlight any content to add. - You can also use here documents to describe how to create a file with required content. + You can also use here documents to describe how to create a file with required content. For more information about here documents, refer to The syntax of here documents varies by system, shell, language, and so on. The following example creates the my-script file in the current directory, with the example content. @@ -734,7 +735,7 @@ telemetry-operator.v1.0.0 Telemetry Operator ... -->
- +
Using Host and Usernames Correctly @@ -811,13 +812,13 @@ telemetry-operator.v1.0.0 Telemetry Operator ... --> - For example, you are the system administrator at Global Banking and you are asked to set up permissions to the accounting directory for the following users: Huong Sabo, Jolene Paluch, Abby Quincy, Francis Ritcher, and Jaya Lamont. + For example, you are the system administrator at Global Banking and you are asked to set up permissions to the accounting directory for the following users: Huong Sabo, Jolene Paluch, Abby Quincy, Francis Ritcher, and Jaya Lamont. Huong is a department manager and needs read access to the accounting directory. Jolene is the lead accountant and needs both read and write access. Choosing a Realistic Name - Consider the following points when choosing a realistic name: + Consider the following points when choosing a realistic name: @@ -848,10 +849,10 @@ telemetry-operator.v1.0.0 Telemetry Operator ... --> Avoid name combinations or abbreviations that result in unintended meanings, such as slang. An example that works well might be "John Smith", with an email address of jsmith@example.com. However, for the name "Brian Strong", a corresponding email address of bstrong@example.com might not work so well (when read out, it sounds like "be strong"). - Consider also any implications for names in different languages. + Consider also any implications for names in different languages. - Refer also to the + Refer also to the Google Developer Documentation Style Guide. @@ -1000,7 +1001,7 @@ telemetry-operator.v1.0.0 Telemetry Operator ... -->
- However, in some cases, the sentence might be easier to understand if the noun appears first, or if additional language separates the object name from the noun. + However, in some cases, the sentence might be easier to understand if the noun appears first, or if additional language separates the object name from the noun. For example, if the noun refers to a password, a value, or a status, then consider stating the noun first, or including explanatory language between the object name and the noun, or doing both. In other cases, a noun might be omitted. @@ -1182,7 +1183,7 @@ telemetry-operator.v1.0.0 Telemetry Operator ... --> Capitalization Unless the acronym or initialism stands for a proper noun, use sentence case for the spelled out version: for example, "central processing unit (CPU)". - Not all acronyms are capitalized (for example, "spool"); refer to + Not all acronyms are capitalized (for example, "spool"); refer to Capitalization in IBM Style @@ -1195,7 +1196,7 @@ telemetry-operator.v1.0.0 Telemetry Operator ... --> Articles - When deciding which articles to use, consider pronunciation. + When deciding which articles to use, consider pronunciation. For example, use "an RTS (real-time strategy)", because RTS is an initialism and you pronounce the first character as an "R" (är). Conversely, use "a RAM upgrade", because RAM is an acronym and you pronounce it as a word (răm). @@ -1559,7 +1560,7 @@ Publication Title by First name Surname; Publisher. - If the URL is long or complex, then create a link by using the title of the destination as a label, and put the URL in a footnote. + If the URL is long or complex, then create a link by using the title of the destination as a label, and put the URL in a footnote. For example: Refer to the Classification of Species diff --git a/en-US/Grammar.xml b/en-US/Grammar.xml index 46903b8..442ef3d 100644 --- a/en-US/Grammar.xml +++ b/en-US/Grammar.xml @@ -137,7 +137,7 @@ Vim has fast, efficient keystrokes to delete an exact amount of words, lines, sentences, or paragraphs. Vim has fast, efficient keystrokes to delete an exact number of words, lines, sentences, or paragraphs. - + @@ -154,7 +154,7 @@ For guidance on how to form a possessive, refer to . - + Do not use possessives with product names. @@ -176,19 +176,19 @@ Red Hat OpenShift's Logging operator creates cluster logging and cluster log forwarder instances. The Red Hat OpenShift Logging operator creates cluster logging and cluster log forwarder instances. - + OpenSauced's Chrome Extension is a good tool to display your open source contributions. The OpenSauced Chrome Extension is a good tool to display your open source contributions. - + - + Do not use possessives with abbreviations. @@ -215,8 +215,8 @@
- - + + You can use the possessive form with the "Red Hat" company name to refer only to the company itself, without identifying any products or services. @@ -229,13 +229,13 @@ - + Red Hat's approach to hybrid cloud security helps customers implement security across their entire infrastructure. - + Otherwise, you can use possessives for people and inanimate objects. @@ -248,12 +248,12 @@ - + The alt tag's text for the Pepsi logo is too short. - +
Using Who, Whom, That, and Which Correctly @@ -402,7 +402,7 @@ Consider the following points when constructing sentences: - + Sentence Length @@ -594,7 +594,7 @@ Causative Verbs - Avoid the construction "have something happen". Rewrite to replace "have" with a verb that describes the actual action. + Avoid the construction "have something happen". Rewrite to replace "have" with a verb that describes the actual action. @@ -632,7 +632,7 @@ -
@@ -943,11 +943,11 @@ Split contractions and abbreviations into separate paragraphs. --> For example, do not use "can't", "don't", "won't", and similar examples. Write out the words in full. Contractions are a mark of informal writing, and should be avoided when writing technical documentation or other more formal types of manuals. - They can also cause problems for translation. + They can also cause problems for translation. - Take care also with abbreviations; replace "e.g." with "for example", and replace "i.e." with "that is", and so on. + Take care also with abbreviations; replace "e.g." with "for example", and replace "i.e." with "that is", and so on.
@@ -965,7 +965,7 @@ Split contractions and abbreviations into separate paragraphs. --> . - + Hyphenate for Clarity @@ -1007,7 +1007,7 @@ Split contractions and abbreviations into separate paragraphs. --> - Exceptions to this rule include cooperate and coordinate. + Exceptions to this rule include cooperate, coordinate, and reestablish. @@ -1026,15 +1026,15 @@ Split contractions and abbreviations into separate paragraphs. --> -
+
Pronouns and Gender References Do not use gender-specific pronouns in documentation, except to refer to a specific named user, such as in a case study. It is easier to read a sentence that uses "they" and "their" rather than "he/she" and "his/hers". - It is acceptable to use "they" to refer to one person, with a plural verb. + It is acceptable to use "they" to refer to one person, with a plural verb. - + Usually, when giving instructions, use the imperative mood or use "you". In more general explanations, you can use "users" or "new users". Do not use "one" in place of "you" when writing technical documentation, because it is too formal. @@ -1042,11 +1042,11 @@ Split contractions and abbreviations into separate paragraphs. --> Avoid first person "I, we, our". - Use second person "you" whenever possible. + Use second person "you" whenever possible. - If referring to what Red Hat does, use "Red Hat" followed by a singular verb. - + If referring to what Red Hat does, use "Red Hat" followed by a singular verb. + @@ -1066,7 +1066,7 @@ Split contractions and abbreviations into separate paragraphs. --> An engineer must be trained on the equipment that he services. Engineers must be trained on the equipment that they service. - + In the web console, we can restart or shut down the system. In the web console, you can restart or shut down the system. @@ -1082,8 +1082,8 @@ Split contractions and abbreviations into separate paragraphs. --> -
- + +
Tense @@ -1101,6 +1101,6 @@ Split contractions and abbreviations into separate paragraphs. --> Report an issue -
+ diff --git a/en-US/Language.xml b/en-US/Language.xml index ac8a695..aa47e5e 100644 --- a/en-US/Language.xml +++ b/en-US/Language.xml @@ -94,7 +94,7 @@ apples to apples - Do not use. Explain instead what is meant, such as "a fair comparison". + Do not use. Explain instead what is meant, such as "a fair comparison". @@ -180,7 +180,7 @@ - + bottom line @@ -527,7 +527,7 @@ low-hanging fruit - Metaphor. Do not use. Instead, describe the outcome or opportunity in more precise terms, such as "readily achievable goals" or "low-risk, high-yield opportunities". + Metaphor. Do not use. Instead, describe the outcome or opportunity in more precise terms, such as "readily achievable goals" or "low-risk, high-yield opportunities". @@ -978,8 +978,8 @@ - Using the ausearch command allows administrators to focus on only the messages they are interested in. - Administrators can use the ausearch command to focus on only messages of interest. + Using the ausearch command allows administrators to focus on only the messages they are interested in. + Administrators can use the ausearch command to focus on only messages of interest. @@ -988,8 +988,8 @@ - The system menu allows you to switch network and VPN connections on or off. - From the system menu, you can switch network and VPN connections on or off. + The system menu allows you to switch network and VPN connections on or off. + From the system menu, you can switch network and VPN connections on or off. @@ -1036,7 +1036,7 @@ Do not use "master" when it is paired with "slave". - The master and slave mount propagation terminology that is used in Linux is problematic and divisive, and needs to be changed. + The master and slave mount propagation terminology that is used in Linux is problematic and divisive, and needs to be changed. When naming the default branch name for a GitHub repository, use "main" instead of "master". Use of "master" is acceptable in other contexts, such as to refer to mastery of a skill. @@ -1064,7 +1064,7 @@ Avoiding Redundant Words Avoid redundant words, such as "actually", "really", "simply", and "very". - They are typically filler words that add no value to a sentence. + They are typically filler words that add no value to a sentence. Redundant words might also occur where two words or phrases are used that mean approximately the same thing, such as "revert back" versus "revert", or that add nothing to the sentence, such as "located on" versus "on". @@ -1139,24 +1139,24 @@ The next() method should return null to indicate the end of results. - + - The next() method is expected to return null to indicate the end of results. + The next() method is expected to return null to indicate the end of results. - Or: The next() method must return null to indicate the end of results. + Or: The next() method must return null to indicate the end of results. It may be held in memory. - + - It can be held in memory. + It can be held in memory. - Or: It might be held in memory. + Or: It might be held in memory. @@ -1170,7 +1170,7 @@ - + Avoid Stating that Something Is Easy @@ -1194,9 +1194,9 @@ - Mounting a device is relatively simple. + Mounting a device is relatively simple. Identify the device for mounting, ensure that the mount point exists, and mount the device on the mount point. - (Omit the first sentence.) + (Omit the first sentence.) To mount a device, identify the device for mounting, ensure that the mount point exists, and mount the device on the mount point. @@ -1273,12 +1273,12 @@ To create another administrator, click File > New. - - - To create another administrator account, click File > New. - - - Or: To set privileges for another administrator, click File > New. + + + To create another administrator account, click File > New. + + + Or: To set privileges for another administrator, click File > New. @@ -1323,12 +1323,12 @@ Use the utility to run activities and save your settings. - Depending on the meaning: + Depending on the meaning: - Use the utility to run activities and to save your settings (if the utility does both functions). + Use the utility to run activities and to save your settings (if the utility does both functions). - Or: Use the utility to run activities, and then save your settings (if the process consists of two separate steps, of which the utility does only one). + Or: Use the utility to run activities, and then save your settings (if the process consists of two separate steps, of which the utility does only one). @@ -1400,17 +1400,17 @@ - + - Users can only delete files that they own. + Users can only delete files that they own. (Misleadingly suggests that users cannot take any actions other than deletion on those files) - + - Users can delete only files that they own. + Users can delete only files that they own. (Clarifies the files that deletion applies to) diff --git a/en-US/N.xml b/en-US/N.xml index 8276bc8..bb205d7 100644 --- a/en-US/N.xml +++ b/en-US/N.xml @@ -10,9 +10,9 @@ named - When referring to the designation of files, objects, or entities within documentation, use the term "named" instead of "called". + When referring to the designation of files, objects, or entities within documentation, use the term "named" instead of "called". This choice promotes clarity and precision in technical content. - The word "named" directly associates the name with the entity and is more specific in technical contexts. + The word "named" directly associates the name with the entity and is more specific in technical contexts. Use "named" to refer to such items as a file, directory, task, user, or group. For example, "When you need to store configuration settings, create a directory named configurations to keep your workspace organized." @@ -111,6 +111,19 @@ + + + non-real-time + + + Hyphenate in both places. + + + For example: "The values affect only non-real-time processes and do not elevate a process's priority above any real-time tasks." + + + + nonsecure @@ -138,7 +151,7 @@ Generally, use "number sign" to refer to the # character. Otherwise, use "hash" to refer to a hashtag in social media, or to refer to Secure Hash Algorithm (refer to ), or when writing exclusively for a European audience. - You can instead use "pound sign" when writing exclusively for a North American audience, if "number sign" is not appropriate for the context. + You can instead use "pound sign" when writing exclusively for a North American audience, if "number sign" is not appropriate for the context. diff --git a/en-US/Punctuation.xml b/en-US/Punctuation.xml index 38068ca..ac61ab7 100644 --- a/en-US/Punctuation.xml +++ b/en-US/Punctuation.xml @@ -107,13 +107,13 @@ magenta - + - + --> - + Use a semicolon to separate items in a series if the items contain commas. @@ -149,10 +149,10 @@ If, however, any sentences intervene between the introduction and the next item, then end both the introduction and any intervening sentences with a period instead. - + - In the following example, the related list immediately follows the stem, or introductory sentence, after "as follows". + In the following example, the related list immediately follows the stem, or introductory sentence, after "as follows". If that sentence instead ends with "the following", then ensure that a noun is used after those words. @@ -223,10 +223,10 @@ - + - In the following example, a colon is used for a step that introduces a command: + In the following example, a colon is used for a step that introduces a command: @@ -238,10 +238,10 @@ PLAY [Gather and display facts for managed nodes] **************************** - + - In the following example, several sentences introduce a code example, and each one ends in a period: + In the following example, several sentences introduce a code example, and each one ends in a period: @@ -259,7 +259,7 @@ PLAY [Gather and display facts for managed nodes] **************************** - +
@@ -530,21 +530,21 @@ PLAY [Gather and display facts for managed nodes] **************************** Slashes - Avoid use of a slash character to mean either of two options. + Avoid use of a slash character to mean either of two options. - For example, instead of "enable/disable", use "enable or disable". - + For example, instead of "enable/disable", use "enable or disable". + Instead of "A and/or B", use "A or B", or "A, or B, or both". - +
Quotation Marks - When indicating the start or end of a direct quotation, use curly quotation marks. + When indicating the start or end of a direct quotation, use curly quotation marks. In all other contexts, such as when writing code samples, code syntax, hexadecimal numbers, or hypertext links, use straight quotation marks. Refer to Typographical Considerations in IBM Style @@ -554,10 +554,10 @@ PLAY [Gather and display facts for managed nodes] ****************************. - In technical documentation, place punctuation marks, including periods, commas, question marks, exclamation points, dashes, and semicolons inside the quotation marks if they are part of the quotation or part of a programming element that uses quotation marks; if not, place punctuation marks outside the quotation marks. + In technical documentation, place punctuation marks, including periods, commas, question marks, exclamation points, dashes, and semicolons inside the quotation marks if they are part of the quotation or part of a programming element that uses quotation marks; if not, place punctuation marks outside the quotation marks. If a sentence ends with a quotation, use only one punctuation mark to end the sentence, and place it inside the closing quotation mark if it is part of the quotation, or outside if it is not. - + Correct Examples of the Use of Punctuation with Quotation Marks @@ -582,12 +582,6 @@ Using project "default". The title of the web page is "OpenShift 3 Etherpad". - - - - In the program segment, ensure that the value is X'FF'. - - @@ -598,18 +592,18 @@ Using project "default". - +
- @@ -617,10 +611,10 @@ Using project "default".
Apostrophes - Do not use an apostrophe to denote a plural. + Do not use an apostrophe to denote a plural. - To denote a possessive, use an apostrophe as follows: + To denote a possessive, use an apostrophe as follows: Plural nouns not ending in s should add an 's (for example, the alumni's contribution). @@ -663,21 +657,21 @@ Using project "default".
Punctuation in Tables - Use the following guidance for punctuation in tables: + Use the following guidance for punctuation in tables: - If all cells in a table column are complete sentences, then end each cell with a period. + If all cells in a table column are complete sentences, then end each cell with a period. - If all cells in a table column are sentence fragments, then do not use a period to end each cell. + If all cells in a table column are sentence fragments, then do not use a period to end each cell. - If cells in a table column contain a mixture of complete sentences and sentence fragments, then first consider whether it would be appropriate to make them grammatically parallel (either all complete sentences or all sentence fragments). - However, in some cases, such an approach might not work, where tables are complex and include a variety of content, such as lists of strings, variables, IP addresses, descriptions, or states (selected or cleared). + If cells in a table column contain a mixture of complete sentences and sentence fragments, then first consider whether it would be appropriate to make them grammatically parallel (either all complete sentences or all sentence fragments). + However, in some cases, such an approach might not work, where tables are complex and include a variety of content, such as lists of strings, variables, IP addresses, descriptions, or states (selected or cleared). In such cases, treat each cell as an individual entry, and either use or omit a closing period depending on whether that cell is a complete sentence. - Example of a complex table with punctuation: + Example of a complex table with punctuation: @@ -694,73 +688,73 @@ Using project "default". - + Question - + Default domain name - + Description - + This domain name is used to set the hostname of the node. - + Answer variable name - + global_domain_name - + Answer type - + text - + Required - + (selected) - + Minimum length - + 1 - + Maximum length - + 251 - + Default answer - + lab.example.com @@ -769,7 +763,7 @@ Using project "default".
-
+
Referring to Punctuation Marks and Special Characters @@ -780,13 +774,13 @@ Using project "default". . , : ; ' ‘ ’ " “ ” ( ) [ ] { } ! ? - For all other characters, use the character name followed by the symbol in parentheses. - For special character names that include a noun such as "sign", "symbol", or "character", provide the character name, the noun that describes the symbol, and then the symbol in parentheses, for example "the greater-than symbol (>)". - For special character names that do not include such nouns, provide the character name and the symbol in parentheses, for example "a forward slash (/)". - You can end a sentence with the symbol in parentheses. + For all other characters, use the character name followed by the symbol in parentheses. + For special character names that include a noun such as "sign", "symbol", or "character", provide the character name, the noun that describes the symbol, and then the symbol in parentheses, for example "the greater-than symbol (>)". + For special character names that do not include such nouns, provide the character name and the symbol in parentheses, for example "a forward slash (/)". + You can end a sentence with the symbol in parentheses. - Do not use the symbol on its own. + Do not use the symbol on its own. Referring to Punctuation Marks @@ -806,7 +800,7 @@ Using project "default". Use the pipe character (|) to send the output of one program to the input of another program. - The hyphen after the greater than symbol (>) indicates that a newline character (\n) is not added to the end of the variable. + The hyphen after the greater-than symbol (>) indicates that a newline character (\n) is not added to the end of the variable. @@ -824,7 +818,7 @@ Using project "default". Names of Punctuation Marks and Special Characters Use the names in the following table to refer to punctuation marks or special characters: - + Names of Punctuation Marks and Special Characters @@ -874,7 +868,7 @@ Using project "default". ` Backtick - + { } Braces @@ -954,7 +948,7 @@ Using project "default". - Hyphen or minus sign - + < Less-than symbol