diff --git a/LICENSE b/LICENSE index 3bbbc1e..3b7b82d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,116 +1,427 @@ -CC0 1.0 Universal - -Statement of Purpose - -The laws of most jurisdictions throughout the world automatically confer -exclusive Copyright and Related Rights (defined below) upon the creator and -subsequent owner(s) (each and all, an "owner") of an original work of -authorship and/or a database (each, a "Work"). - -Certain owners wish to permanently relinquish those rights to a Work for the -purpose of contributing to a commons of creative, cultural and scientific -works ("Commons") that the public can reliably and without fear of later -claims of infringement build upon, modify, incorporate in other works, reuse -and redistribute as freely as possible in any form whatsoever and for any -purposes, including without limitation commercial purposes. These owners may -contribute to the Commons to promote the ideal of a free culture and the -further production of creative, cultural and scientific works, or to gain -reputation or greater distribution for their Work in part through the use and -efforts of others. - -For these and/or other purposes and motivations, and without any expectation -of additional consideration or compensation, the person associating CC0 with a -Work (the "Affirmer"), to the extent that he or she is an owner of Copyright -and Related Rights in the Work, voluntarily elects to apply CC0 to the Work -and publicly distribute the Work under its terms, with knowledge of his or her -Copyright and Related Rights in the Work and the meaning and intended legal -effect of CC0 on those rights. - -1. Copyright and Related Rights. A Work made available under CC0 may be -protected by copyright and related or neighboring rights ("Copyright and -Related Rights"). Copyright and Related Rights include, but are not limited -to, the following: - - i. the right to reproduce, adapt, distribute, perform, display, communicate, - and translate a Work; - - ii. moral rights retained by the original author(s) and/or performer(s); - - iii. publicity and privacy rights pertaining to a person's image or likeness - depicted in a Work; - - iv. rights protecting against unfair competition in regards to a Work, - subject to the limitations in paragraph 4(a), below; - - v. rights protecting the extraction, dissemination, use and reuse of data in - a Work; - - vi. database rights (such as those arising under Directive 96/9/EC of the - European Parliament and of the Council of 11 March 1996 on the legal - protection of databases, and under any national implementation thereof, - including any amended or successor version of such directive); and - - vii. other similar, equivalent or corresponding rights throughout the world - based on applicable law or treaty, and any national implementations thereof. - -2. Waiver. To the greatest extent permitted by, but not in contravention of, -applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and -unconditionally waives, abandons, and surrenders all of Affirmer's Copyright -and Related Rights and associated claims and causes of action, whether now -known or unknown (including existing as well as future claims and causes of -action), in the Work (i) in all territories worldwide, (ii) for the maximum -duration provided by applicable law or treaty (including future time -extensions), (iii) in any current or future medium and for any number of -copies, and (iv) for any purpose whatsoever, including without limitation -commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes -the Waiver for the benefit of each member of the public at large and to the -detriment of Affirmer's heirs and successors, fully intending that such Waiver -shall not be subject to revocation, rescission, cancellation, termination, or -any other legal or equitable action to disrupt the quiet enjoyment of the Work -by the public as contemplated by Affirmer's express Statement of Purpose. - -3. Public License Fallback. Should any part of the Waiver for any reason be -judged legally invalid or ineffective under applicable law, then the Waiver -shall be preserved to the maximum extent permitted taking into account -Affirmer's express Statement of Purpose. In addition, to the extent the Waiver -is so judged Affirmer hereby grants to each affected person a royalty-free, -non transferable, non sublicensable, non exclusive, irrevocable and -unconditional license to exercise Affirmer's Copyright and Related Rights in -the Work (i) in all territories worldwide, (ii) for the maximum duration -provided by applicable law or treaty (including future time extensions), (iii) -in any current or future medium and for any number of copies, and (iv) for any -purpose whatsoever, including without limitation commercial, advertising or -promotional purposes (the "License"). The License shall be deemed effective as -of the date CC0 was applied by Affirmer to the Work. Should any part of the -License for any reason be judged legally invalid or ineffective under -applicable law, such partial invalidity or ineffectiveness shall not -invalidate the remainder of the License, and in such case Affirmer hereby -affirms that he or she will not (i) exercise any of his or her remaining -Copyright and Related Rights in the Work or (ii) assert any associated claims -and causes of action with respect to the Work, in either case contrary to -Affirmer's express Statement of Purpose. - -4. Limitations and Disclaimers. - - a. No trademark or patent rights held by Affirmer are waived, abandoned, - surrendered, licensed or otherwise affected by this document. - - b. Affirmer offers the Work as-is and makes no representations or warranties - of any kind concerning the Work, express, implied, statutory or otherwise, - including without limitation warranties of title, merchantability, fitness - for a particular purpose, non infringement, or the absence of latent or - other defects, accuracy, or the present or absence of errors, whether or not - discoverable, all to the greatest extent permissible under applicable law. - - c. Affirmer disclaims responsibility for clearing rights of other persons - that may apply to the Work or any use thereof, including without limitation - any person's Copyright and Related Rights in the Work. Further, Affirmer - disclaims responsibility for obtaining any necessary consents, permissions - or other rights required for any use of the Work. - - d. Affirmer understands and acknowledges that Creative Commons is not a - party to this document and has no duty or obligation with respect to this - CC0 or use of the Work. - -For more information, please see - \ No newline at end of file +Attribution-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More_considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-ShareAlike 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-ShareAlike 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + + including for purposes of Section 3(b); and + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/README.md b/README.md index b2038bc..32e572a 100644 --- a/README.md +++ b/README.md @@ -7,4 +7,4 @@ The Red Hat Style Guide and Word Usage Dictionary is a joint effort by various g It covers recommended design practices, how to write for translation, common mistakes to avoid, rules for everyday punctuation, grammar, and sources of information for the less common cases. -It is based on The IBM Style Guide but differs in several key areas, uses the Merriam-Webster Collegiate Dictionary and American Heritage Dictionary as spelling references, and the Chicago Manual of Style (17th Ed.) for further grammatical and style decisions. +It is based on The IBM Style Guide but differs in several key areas, uses the Merriam-Webster Unabridged Dictionary and American Heritage Dictionary as spelling references, and the Chicago Manual of Style (17th Ed.) for further grammatical and style decisions. diff --git a/en-US/0-9.xml b/en-US/0-9.xml index ec89d36..1ad984c 100644 --- a/en-US/0-9.xml +++ b/en-US/0-9.xml @@ -3,6 +3,7 @@ %BOOK_ENTITIES; ]> + 0-9 @@ -20,7 +21,7 @@ 2-track (IT) - adj. A less common way to refer to bimodal or hybrid IT. See + adj. A less common way to refer to bimodal or hybrid IT. See . @@ -30,7 +31,7 @@ 3-D - adj., n.. Correct. Do not use 3D, 3-d, or other variations. + adj., n. Correct. Do not use 3D, 3-d, or other variations. diff --git a/en-US/A.xml b/en-US/A.xml index 26b30c4..5b4dcf8 100644 --- a/en-US/A.xml +++ b/en-US/A.xml @@ -5,17 +5,32 @@ ]> A + + "&" and "+" - Ampersands or plus signs can be used in design elements and graphics when space is limited, and when either referring to or quoting third-party content that uses them. Do not use them in original body copy. + Ampersands or plus signs can be used instead of the word "and" in design elements and graphics when space is limited, and when either referring to or quoting third-party content that uses them. Do not use them in original body copy. + + + + + + above + + + Do not use to refer to information that was mentioned previously. + When documents are converted to online format, the information might no longer be "above." + Use a cross-reference if the referenced material is sufficiently removed, or write "as mentioned previously" instead. + + agile agile development @@ -37,128 +52,83 @@ - - - a.m. - am - - - Correct. Use the lowercase form and include the periods, and use a preceding space. - - - See also . - - - See The IBM Style Guide for a full discussion of how to represent times. - - - - all-in-one allinone - n., adj. Correct. Hyphenate in both cases. Do not use "allinone" or other variations. + n., adj. Hyphenate in both places. Do not use "allinone" or other variations. - - AMD64 + + + alternate - Correct. Do not use "Hammer," "x86_64," "x86-64," "x64," "64-bit x86" or other variations as the name of this architecture. - - - The correct term for AMD's implementation of this architecture is "AMD64." - When discussing the architecture generally, reference both AMD64 and Intel 64 implementations specifically. + v. "Alternate" as a verb means to change between two states or options. - See also . + See also . - - - The AMD64 logo is trademarked; the term "AMD64" is not. For more information about AMD trademarks, see the AMD Trademark Information page at . - - - For more information about Intel® trademarks, see and . - - - - - ATM + + + alternative - Initialism for Asynchronous Transfer Mode, a network technology based on transferring data in cells or packets of a fixed size. - The cell size used with ATM is relatively small compared to units used with older technologies. + adj. Describes another way or method of doing something. + "Alternate" (vb.) means to change between two states or options. If you mean "another way of doing something," use "an alternative method is to ..." + + See also . + - - above + + AM - Do not use to refer to information mentioned previously. - When documents are converted to online format, the information may no longer be "above." - Use a cross-reference if the referenced material is sufficiently removed, or write "as mentioned previously" instead. - + For times of day, use uppercase without periods, and use a preceding nonbreaking space after the numeral, for example "11 AM". + + + See also . + - - acronyms + + AMD64 - An acronym is a word formed from the initial letters of a name, such as ROM for Read Only Memory, or by combining initial letters or part of a series of words, such as LILO for LInux LOader. - Note that an acronym is pronounced as a word. - Compare this to an initialism, which is also formed in a similar fashion to an acronym, but in which each letter is pronounced separately. - - - Spell out most acronyms and initialisms before using them in text, such as "The Embedded DevKit (EDK)..." - Unless the acronym or initialism stands for a proper noun, use sentence case for the spelled out version - for example, "central processing unit (CPU)." - Unless required for the audience or the topic, do not spell out well-known abbreviations, such as HTML. + Correct. Do not use "Hammer," "x86_64," "x86-64," "x64," "64-bit x86" or other variations as the name of this architecture. - To form the plural of an acronym, add a trailing, lowercase "s," or "es," for example, ROMs, PINs, BIOSes. - - - - - - - alternate - - - vb. "Alternate" as a verb means to change between two states or options. + The correct term for AMD's implementation of this architecture is "AMD64." + When discussing the architecture generally, reference both AMD64 and Intel 64 implementations specifically. - See also . + See also . + + + The AMD64 logo is trademarked; the term "AMD64" is not. For more information about AMD trademarks, see the AMD Trademark Information page at . + + + + For more information about Intel® trademarks, see and . + - - - - - - alternative - - - adj. Used to describe another way or method of doing something. - "Alternate" (vb.) means to change between two states or options. If you mean "another way of doing something," use "an alternative method is to..." - - - See also . - + @@ -170,12 +140,26 @@ Avoid if possible. Try to rewrite to make the available options explicit and clear. Do not write this and/or that. - Write this or that or both. + Write this or that, or both. + + + + appendixes + + + Correct. This is the correct plural form for US English spelling. Do not use "appendices." + + + + + + + + Applixware Applix ApplixWare - Correct. + "Applixware" is correct. Do not use "Applix" or "ApplixWare." @@ -211,9 +197,9 @@ Do not use as a verb. - Even though it might make sense in the correct context, using it as a verb can be jargon or unclear for your audience. + Even though it might make sense in the correct context, using it as a verb can be jargon or be unclear for your audience. Use "design," "build," "create," or another descriptive verb instead. - Before replacing the verb form of "architect" during the editing process, check with the writer to find out the intended meaning. + Before replacing the verb form of "architect" during the editing process, clarify with the writer the intended meaning. For example, a sentence that mentions rearchitecting might require "refactoring" as a replacement rather than "rebuilding." @@ -235,7 +221,7 @@ as-a-Service - Be aware that there is a great deal of overlap in as-a-Service acronyms. + Some as-a-Service acronyms overlap. To avoid confusion, always spell out the full term on first use. @@ -259,7 +245,7 @@ - FaaS (Function[s]-as-a-Service) + FaaS (Functions-as-a-Service) @@ -301,27 +287,28 @@ - Capitalize the noun (e.g., Platform, Software, Infrastructure) and Service, both when abbreviated and written out. + Capitalize the noun (such as Platform, Software, Infrastructure) and Service, both when abbreviated and when written out. - When in all capitals, such as a title or headline, the "aa" in the acronym remains lowercase (e.g., INTRODUCTION TO PaaS SOLUTIONS). + When in all capitals, such as a title or headline, the "aa" in the acronym remains lowercase (such as INTRODUCTION TO PaaS SOLUTIONS). + Hyphenate when written out: Thing-as-a-Service. - For two-word prefixes, do not include a hyphen between the first and second words: Mobile Backend-as-a-Service. - Can be used as an adjective to describe multiple (e.g., when referring to an IaaS, PaaS, and SaaS, use as-a-Service offerings, as-a-Service products, or similar wording). + For two-word prefixes, do not include a hyphen between the first and second words, for example: Mobile Backend-as-a-Service. + It can be used as an adjective to describe multiple: for example, when referring to IaaS, PaaS, and SaaS, use as-a-Service offerings, as-a-Service products, or similar wording. - Avoid an acronym if it could stand for more than one term in a single asset (e.g., if you're writing content that discusses both Cloud-as-a-Service and Containers-as-a-Service). + 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. @@ -330,7 +317,30 @@ + + + as long as + + + Use only to refer to a comparison of length or time. Otherwise, use an alternative, such as "provided that". + + + + + + + ATM + + + Initialism for Asynchronous Transfer Mode, a network technology based on transferring data in cells or packets of a fixed size. + The cell size used with ATM is relatively small compared to units that are used with older technologies. + + + + + + @@ -63,27 +64,18 @@ backtrace - n. "Backtrace" is the most common term used to refer to a stack trace (or stack backtrace), which is a report of the active stack frames (that is, function calls) at a certain point in time during the execution of a program. In contrast, the Python programming language calls its stack trace a "traceback," possibly because the stack frames are printed in the opposite order of those presented by gdb, the GNU Debugger. "Traceback" is the preferred term when referring to a Python stack trace. + n. "Backtrace" is the most common term to refer to a stack trace (or stack backtrace), which is a report of the active stack frames (that is, function calls) at a certain point in time during the execution of a program. In contrast, the Python programming language calls its stack trace a "traceback," possibly because the stack frames are printed in the opposite order of those presented by gdb, the GNU Debugger. "Traceback" is the preferred term when referring to a Python stack trace. - - - backwards - - - Avoid using "backwards" unless you are stating that something has "backwards compatibility." - - - - backwards compatible - Correct. Use to refer to something that is compatible with older equipment or previous versions of software. See also . + Do not use. Instead, use "compatible with earlier versions" to refer to something that is compatible with older equipment or previous versions of software. See also . + @@ -92,7 +84,7 @@ bandwidth - Correct. Bandwidth can refer to a range within a band of frequencies or wavelengths, or the amount of data that can be transmitted in a fixed amount of time. + Correct. Bandwidth can refer to a range within a band of frequencies or wavelengths, or the amount of data that can be transmitted in a fixed time. @@ -135,7 +127,23 @@ below - Do not use to refer to information mentioned "below," or later in a document. When documents are converted to online format, the information may no longer be "below." Use a cross-reference instead. + Do not use to refer to information that follows later in a document. When documents are converted to online format, the information might no longer be "below." Use a cross-reference instead. + + + + + + + biannual, bimonthly, biweekly, semiweekly, semimonthly + + + People have trouble remembering whether biweekly means "every two weeks" or "twice a week." "Semiweekly" has a similar problem. Even though both terms have clear dictionary definitions, it is best to avoid them in favor of clear communication. + + + Instead of biweekly, write "every two weeks" or "every other week." + + + Instead of semiweekly, write "twice a week." @@ -155,42 +163,26 @@ bimodal IT - Gartner phrase for the combination of traditional (mode 1 or type 1) and modern (mode 2 or type 2) IT infrastructure and resources. There are many ways to talk about this combination approach; be sure you use the right phrase for your audience. Using only the Gartner term can alienate other analysts or those not familiar with Gartner's phrasing. + Gartner phrase for the combination of traditional (mode 1 or type 1) and modern (mode 2 or type 2) IT infrastructure and resources. Many ways exist to describe this combination approach; be sure to use the right phrase for your audience. Using only the Gartner term can alienate other analysts or those who are not familiar with Gartner's phrasing. The practice of having both modes together is often referred to as hybrid, agile, or modern IT. - Hybrid IT is a more general term, e.g. it could mean on-premise plus public cloud. Agile and modern IT can both carry an implication of "mode 2", so when using those terms, be specific about the exact technology combination you mean. + Hybrid IT is a more general term, for example it could mean on-premises plus public cloud. Agile and modern IT can both carry an implication of "mode 2", so when using those terms, be specific about the exact technology combination that you mean. - - - bimonthly, biweekly, semiweekly, semimonthly - - - People have trouble remembering if biweekly means "every two weeks" or "twice a week." Semiweekly has a similar problem. Even though both terms have clear dictionary definitions, we recommend that you avoid them in favor of clear communication. - - - Instead of biweekly, write "every two weeks" or "every other week." - - - Instead of semiweekly or semimonthly, write "twice a week." - - - - BIND - This is correct when referring to the DNS software. Do not use Bind. + Correct when referring to the DNS software. Do not use Bind. @@ -216,6 +208,19 @@ + + + blacklist + + + Do not use. Use "denylist" or "blocklist". + + + Do not use the terms "white" or "black" in a context where white is represented as good or black is represented as bad. Such usage reinforces a model that promotes racial bias. + + + + Boolean @@ -223,7 +228,7 @@ Correct. Named after George Boole, who first developed the concept. - According to The IBM Style Guide, it is acceptable to use "boolean" in API programming information when it refers to a primitive return type. + According to the IBM Style Guide, it is acceptable to use "boolean" in API programming information when it refers to a primitive return type. @@ -233,13 +238,13 @@ boot - v. To load the first piece of software that starts a computer. Because the operating system is essential for running all other programs, it is usually the first piece of software loaded during the boot process. + v. To load the first piece of software that starts a computer. Because the operating system is essential for running all other programs, it is usually the first piece of software to load during the boot process. - n. Refers to the starting-up of a computer, which involves loading the operating system and other basic software. A cold boot refers to starting a computer that is turned off. A warm boot refers to resetting a computer that is already running. + n. Refers to starting up a computer, which involves loading the operating system and other basic software. A cold boot refers to starting a computer that is turned off. A warm boot refers to resetting a computer that is already running. - Boot is an abbreviation of bootstrap, which in olden days was a strap attached to the top of your boot that you could pull to help get your boot on. Hence, the expression "pull oneself up by the bootstraps." Similarly, bootstrap utilities help the computer get started. + Boot is an abbreviation of bootstrap, which in olden days was a strap attached to the top of your boot that you could pull to help to get your boot on. Hence, the expression "pull yourself up by the bootstraps." Similarly, bootstrap utilities help the computer to get started. @@ -272,7 +277,7 @@ One word. Do not use "bottle neck" or "bottle-neck." - A bottleneck refers to the delay in transmission of data through the circuits of a computer's microprocessor or over a TCP/IP network. The delay typically occurs when a system's bandwidth cannot support the amount of information being relayed at the speed it is being processed. There are, however, many factors that can create a bottleneck in a system. + A bottleneck refers to the delay in transmission of data through the circuits of a computer's microprocessor or over a TCP/IP network. The delay typically occurs when a system's bandwidth cannot support the amount of information that is being relayed at the speed that it is being processed. However, many factors can create a bottleneck in a system. @@ -302,11 +307,11 @@ breadcrumb trail - See The IBM Style Guide for initial guidance on how to use this term. + See the IBM Style Guide for initial guidance on how to use this term. - Do not confuse the breadcrumb trail with the name of the actual page in a user interface. The final breadcrumb in the trail is the name of the page, unless the page itself offers a distinct title. The breadcrumb trail indicates the path taken to reach the current page. + Do not confuse the breadcrumb trail with the name of the actual page in a user interface. The final breadcrumb in the trail is the name of the page, unless the page itself offers a distinct title. The breadcrumb trail indicates the path that is taken to reach the current page. @@ -329,7 +334,7 @@ break - (v.) Do not use to mean "break the system" or similar. For example, "applying an unapproved patch might break the system." Choose an alternative such "cause the system to fail." + (v.) Do not use to mean "break the system" or similar. For example, "applying an unapproved patch might break the system." Choose an alternative such as "cause the system to fail." @@ -347,7 +352,7 @@ Britain - If referring to the language, say "English." If referring to the country, say the United Kingdom of Great Britain and Northern Ireland, or the UK. Using Britain or British is usually wrong and to some implies a specific subjective statement about the state of Northern Ireland. + If referring to the language, say "English." If referring to the country, say the United Kingdom of Great Britain and Northern Ireland, or the UK. Using Britain or British is usually wrong and might imply a subjective statement about the state of Northern Ireland. @@ -357,10 +362,12 @@ broadcast - To simultaneously send the same message to multiple recipients. Broadcasting is a useful feature in email systems. It is also supported by some fax systems. + To send the same message simultaneously to multiple recipients. Broadcasting is a useful feature in email systems. + - In networking, a distinction is made between broadcasting and multicasting. Broadcasting sends a message to everyone on the network whereas multicasting sends a message to a select list of recipients. + In networking, a distinction is made between broadcasting and multicasting. Broadcasting sends a message to everyone on the network whereas multicasting sends a message to a selected list of recipients. @@ -370,7 +377,7 @@ Btrfs - A copy-on-write file system for Linux. Use a capital "B" when referring to the file system. When referring to tools, commands, and other utilities related to the file system, be faithful to those utilities. + A copy-on-write file system for Linux. Use an uppercase "B" when referring to the file system. When referring to tools, commands, and other utilities that relate to the file system, be faithful to those utilities. See for more information on this file system. @@ -406,7 +413,7 @@ bunches of - Do not use, unless "bunch" is a specific term used in the software being documented. Use "many" or some other alternative instead. + Do not use, unless "bunch" is a specific term that is used in the documented software. Use "many" or some other alternative instead. @@ -419,7 +426,7 @@ Describe a GUI button as a "button," not a "pushbutton" or "push-button." - Ordinarily you would not include the text "button" in a procedure or description. For example, "Click OK to continue" is perfectly acceptable. It may be necessary to distinguish between buttons and links; for example, "Click the Download link." + Ordinarily you would not include the text "button" in a procedure or description. For example, "Click OK to continue" is perfectly acceptable. It might be necessary to distinguish between buttons and links; for example, "Click the Download link." See also . diff --git a/en-US/Book_Design.xml b/en-US/Book_Design.xml index 1bfbc04..d182a6d 100644 --- a/en-US/Book_Design.xml +++ b/en-US/Book_Design.xml @@ -6,7 +6,7 @@
Overall Book Design - This section describes a general approach to the overall layout and design of technical documentation. This design was developed specifically for technical documentation and may not suit content produced by other groups. + This section describes a general approach to the overall layout and design of technical documentation. This design was developed specifically for technical documentation and might not suit content produced by other groups. This section covers the following topics: @@ -51,7 +51,7 @@ The title should be a combination of the complete product name, its version, and the name of the book. For example, "Red Hat Satellite 5.6 Installation Guide", or "Red Hat Enterprise Linux 6 Deployment Guide". - The subtitle should be a single, succinct phrase that describes the intent of the book; an abstract of the abstract. For example, "Installing Red Hat Enterprise Linux 6 for all architectures". + The subtitle should be a single, succinct phrase that describes the intent of the book; an abstract of the abstract. For example, "Installing Red Hat Enterprise Linux 8 for all architectures".
@@ -87,7 +87,7 @@ - Why (and possibly Who): A basic rationale for why this book exists, and its audience (and elaborate on the target audience inside the book). For example, "This provides a basis for administrators and developers to write custom scripts and integrate Red Hat Satellite with third-party applications." + Why (and possibly Who): A basic rationale for why this book exists, and its audience (and elaborate on the target audience inside the book). For example, "This book provides a basis for administrators and developers to write custom scripts and to integrate Red Hat Satellite with third-party applications." @@ -99,10 +99,10 @@ Drawing these basics together might produce the following example abstract: - "The Red Hat Satellite 5.6 API Guide is a full reference for Satellite's XMRPC API. The guide explains each API method and demonstrates examples of data models for input and output. This provides a basis for administrators and developers to write custom scripts and integrate Red Hat Satellite with third-party applications." + "The Red Hat Satellite 5.6 API Guide is a full reference for Satellite's XMRPC API. The guide explains each API method and demonstrates examples of data models for input and output. This book provides a basis for administrators and developers to write custom scripts and to integrate Red Hat Satellite with third-party applications." - Update or modify each component according to the type of book you are writing. + Update or modify each component according to the type of book that you are writing. @@ -116,12 +116,12 @@
Unused Heading Titles - This section lists various heading titles that have been used in Red Hat technical documentation, but should be avoided except in specific circumstances. + This section lists various heading titles that might be used in Red Hat technical documentation, but that should be avoided except in specific circumstances. Overview - Do not use "overview" as a title. No justification was found for using this as a title; anywhere that it might be considered is already covered by either better or more common titles. + Do not use "overview" as a title. No justification was found for using it as a title; anywhere that it might be considered is already covered by either better or more common titles. diff --git a/en-US/Book_Info.xml b/en-US/Book_Info.xml index fa5d3b2..f3ceb25 100644 --- a/en-US/Book_Info.xml +++ b/en-US/Book_Info.xml @@ -4,10 +4,11 @@ %BOOK_ENTITIES; ]> - Conventions for Writers and Editors - The Red Hat Style Guide + Style Conventions for Writers and Editors + + Red Hat Technical Writing Style Guide - 4.2 + 5.0 1 diff --git a/en-US/C.xml b/en-US/C.xml index 46ef295..59b63a9 100644 --- a/en-US/C.xml +++ b/en-US/C.xml @@ -10,7 +10,7 @@ can, may - Use "can" to describe actions or conditions that are possible. Use "may" only to describe situations where permission is being given. If either "can," "could," or "may" apply, use "can" - it is less tentative. + Use "can" to describe actions or conditions that are possible. Use "may" only to describe situations where permission is being given. If any of "can," "could," or "may" apply, use "can"; it is less tentative. @@ -20,7 +20,7 @@ cannot - Correct, when used in the negative form. For example, "you cannot end a sentence with a preposition." Do not use "can not." When used as an additive, use two words. For example, "you can not only end a sentence with a preposition, but you can also start a sentence with a conjunction." + Correct, as one word, when used in the negative form. For example, "you cannot end a sentence with a preposition." Do not use "can not." When used as an additive, use two words. For example, "you can not only end a sentence with a preposition, but you can also start a sentence with a conjunction." @@ -46,7 +46,7 @@ When referring to a compact disk, use "CD." For example, "Insert the CD into the CD drive." The plural is "CDs." - See the Word Usage appendix of The IBM Style Guide for more information. + See the Word Usage chapter of the IBM Style Guide for more information. @@ -56,7 +56,7 @@ CD #1 - When referring to a specific CD in the Red Hat Enterprise Linux CD set, it is correct to refer to it as: Red Hat Enterprise Linux CD #1. Avoid using Red Hat Enterprise Linux CD 1 + When referring to a specific CD in the Red Hat Enterprise Linux CD set, it is correct to refer to it as: Red Hat Enterprise Linux CD #1. Avoid using Red Hat Enterprise Linux CD 1. @@ -79,7 +79,7 @@ cgroup - Correct (all lowercase) when referring to the kernel-based technology. This is a contraction of control group, and not a proper noun in itself; proper nouns use initial caps. This being the case, it is permissible to capitalize if used at the beginning of a sentence. + Correct (all lowercase) when referring to the kernel-based technology. It is a contraction of control group, and not a proper noun in itself; proper nouns use initial caps. It is therefore permissible to capitalize it if used at the beginning of a sentence. Where cgroup refers to something else, for example, a package name, file name, and so on, use a literal rendition. @@ -92,7 +92,7 @@ characters - Do not use "characters" when you should use "bytes." In English, bytes and characters can be used interchangeably; in other languages a single character may consist of multiple bytes. + Do not use "characters" to mean "bytes." In English, bytes and characters can be used interchangeably; in other languages, a single character might consist of multiple bytes. In computer software, any symbol that requires one byte of storage. This includes all the ASCII and extended ASCII characters, including the space character. In character-based software, everything that appears on the screen, including graphics symbols, is considered to be a character. In graphics-based applications, the term character is generally reserved for letters, numbers, and punctuation. @@ -105,7 +105,7 @@ check - Avoid. Use "verify," "make sure," "ensure," or "read," depending on the context. + Avoid. Use "verify," "ensure," or "read," depending on the context. @@ -135,7 +135,7 @@ CI/CD - Define on first use; generally continuous integration/continuous delivery. This is not continuous development, a term with questionable usefulness and only marginal adoption. + Define on first use; generally continuous integration/continuous delivery. It does not mean continuous development, a term with questionable usefulness and only marginal adoption. See also , , . @@ -148,7 +148,7 @@ ciphertext - n. One word. Do not use "cipher text" or "cipher-text" or other variants. + n. One word. Do not use "cipher text", "cipher-text", or other variants. @@ -158,10 +158,11 @@ click - v. Use when referring to a GUI control button, for example, "Click OK." + v. Use when referring to a GUI control button, for example, "Click OK." Do not use "click on". + - See the Word Usage appendix of The IBM Style Guide for more information. + See the Word Usage chapter of the IBM Style Guide for more information. @@ -171,7 +172,7 @@ client-side, client side - adj. Use the hyphenated form as an adjective. For example: "Winbind is a client-side service used to connect to Windows NT servers." + adj. Use the hyphenated form as an adjective. For example: "Winbind is a client-side service to connect to some Windows servers." n. Use the two-word form as a noun. For example: "Winbind runs on the client side of a client/server Samba implementation." @@ -181,10 +182,10 @@ - clobber or clobbered + clobber, clobbered - Avoid these and similar terms unless they are the actual name of something. Use "altered," "invalidated," or "overwritten," or whatever is appropriate in the specific context. + Avoid these and similar terms unless they are the actual name of something. Use "altered," "invalidated," or "overwritten," or whatever is appropriate in the context. @@ -194,7 +195,7 @@ cloud - Although cloud is important to our business, it is not a proper noun. Do not capitalize, unless it is part of a Red Hat product, service, solution, or business unit name. Use a lowercase “c” when referring to cloud or cloud computing in a general sense. Use a capitalized “C” when referring to the full name of official products, such as Red Hat CloudForms or Red Hat Cloud Foundations. See also "big data." + Although cloud is important to Red Hat's business, it is not a proper noun. Do not capitalize, unless it is part of a Red Hat product, service, solution, or business unit name. Use a lowercase "c" when referring to cloud or cloud computing in a general sense. Use a capitalized "C" when referring to the full name of official products, such as Red Hat CloudForms or Red Hat Cloud Foundations. See also "big data." @@ -207,7 +208,7 @@ Define briefly on first use. - Refers to the event where a private cloud exceeds its capacity and "bursts" into and uses public cloud resources. The advantage of such a hybrid cloud deployment is that an organization only pays for extra compute resources when they are needed. + Refers to the event where a private cloud exceeds its capacity and "bursts" into and uses public cloud resources. The advantage of such a hybrid cloud deployment is that an organization pays only for extra computing resources when they are needed. @@ -235,6 +236,18 @@ n. Use only as a noun, not a verb. Use "write" for a verb. + + + + + + + + colocate, colocation + + + Write unhyphenated, to refer to people or services in the same location. + @@ -243,7 +256,7 @@ combo-box - Do not use as an abbreviation for "combination box." See the relevant entry in The IBM Style Guide for further usage information. + Do not use as an abbreviation for "combination box." See the relevant entry in the IBM Style Guide for further usage information. @@ -263,7 +276,7 @@ comma-separated values (CSV) - Use this in preference to "comma-delimited values" whenever possible. The initialism CSV is widely used to denote information broken up through use of commas. Often used to share data between different, but similar applications, wherein the comma is a translator of the data. + Use this in preference to "comma-delimited values" whenever possible. The initialism CSV is widely used to denote information that is broken up through use of commas. This method is often used to share data between different, but similar applications, wherein the comma is a translator of the data. @@ -286,7 +299,7 @@ adj. Correct (compound adjective). Do not use "command driven" or "commanddriven." - Refers to programs and operating systems that accept commands in the form of special words or letters. In contrast, programs that provide a list of options in a menu are said to be menu-driven. + Refers to programs and operating systems that accept commands in the form of special words or letters. In contrast, programs that provide a list of options in a menu are said to be menu-driven. @@ -296,10 +309,10 @@ command language - n. The programming language through which a user communicates with the operating system or an application. For example, the DOS command language includes the commands DIR, COPY, and DEL, to name a few. The part of an operating system that responds to operating system commands is called the command processor. + n. The programming language through which a user communicates with the operating system or an application. For example, the DOS command language includes the commands DIR, COPY, and DEL, to name a few. The part of an operating system that responds to operating system commands is called the command processor. - With graphical user interfaces, the command language consists of operations you perform with a mouse or similar input device. + With graphical user interfaces, the command language consists of operations that you perform with a mouse or similar input device. @@ -309,7 +322,7 @@ command line, command prompt, command-line - See the appropriate entries in The IBM Style Guide for an explanation of how to use these terms. + See the appropriate entries in the IBM Style Guide for an explanation of how to use these terms. @@ -319,7 +332,7 @@ commodity - Avoid using "commodity" when referring to hardware, including servers or storage, because it implies that the hardware is undifferentiated and can make conservative readers think it is cheap. Use instead: + Avoid using "commodity" when referring to hardware, including servers or storage, because it implies that the hardware is undifferentiated and might imply that it is cheap. Use instead: @@ -354,7 +367,7 @@ Containers-as-a-Service - The term "Containers-as-a-Service" is owned by Docker and should only be used when referring to that company's offering. See also . + The term "Containers-as-a-Service" is owned by Docker and should be used only when referring to that company's offering. See also . @@ -364,7 +377,7 @@ container-based - Used to refer to more complex applications made up of multiple services that are distributed in containers. More common than "containerized." + Used to refer to more complex applications with multiple services that are distributed in containers. More common than "containerized." @@ -384,7 +397,7 @@ continuous delivery (CD) - A software implementation architecture that ensures all approved code can be easily pushed to production. + A software implementation architecture that ensures that all approved code can be easily pushed to production. @@ -404,27 +417,19 @@ continuous integration (CI) - A software development architecture where the developer code branch is synchronized with the main code branch or master multiple times per day. Development always works with the current code base. - - - - - - - contractions - - - Do not use. Contractions are a mark of informal writing, and should be avoided when writing policy manuals or other more formal types of manuals. They also cause problems for translation. + A software development architecture where the developer code branch is synchronized with the main code branch multiple times per day. Development always works with the current code base. + + control character - A special, non-printing character that begins, modifies, or ends a function, event, operation or control operation. The ASCII character set defines 32 control characters. Originally, these codes were designed to control teletype machines. Now, however, they are often used to control display monitors, printers, and other modern devices. + A special, non-printing character that begins, modifies, or ends a function, event, operation, or control operation. The ASCII character set defines 32 control characters. Originally, these codes were designed to control teletype machines. Now, however, they are often used to control display monitors, printers, and other modern devices. @@ -447,7 +452,7 @@ A program that enhances an operating system by creating an environment in which you can run other programs. Control programs generally provide a graphical interface and enable you to run several programs at once in different windows. - Control programs are also called operating environments. + Control programs are also called operating environments. @@ -459,7 +464,7 @@ n. A message given to a web browser by a web server. - The browser stores the message in a text file called cookie.txt. + The browser stores the message in a text file named cookie.txt. The message is then sent back to the server each time the browser requests a page from the server. @@ -471,7 +476,7 @@ CR - Use if referring to code, such as "Type CR at the end of each line..." If referring to the keyboard key, use either Enter or Return, depending upon the platform. + Use if referring to code, such as "Type CR at the end of each line ..." If referring to the keyboard key, use either Enter or Return, depending on the platform. @@ -481,7 +486,7 @@ crash - IBM recommends the use of "fail" rather than "crash." The latter is not outlawed, but you would have to justify its use; that is, indicate why "fail" is inadequate. + IBM recommends the use of "fail" rather than "crash." Use the latter only if you can justify why "fail" is inadequate. @@ -514,7 +519,7 @@ CVE - n. CVE stands for Common Vulnerabilities and Exposures and should be capitalized as shown. + n. CVE stands for Common Vulnerabilities and Exposures, and should be capitalized as shown. See for more information. @@ -523,7 +528,7 @@ Cygmon - Correct. Do not use "CygMon," "cygmon," or "CYGMON." An exception is if a command is being typed (such as cygmon). + Correct. Do not use "CygMon," "cygmon," or "CYGMON." An exception is if a command is being typed (such as cygmon). Refer to it as "Cygmon: a ROM monitor," not "Cygmon: the Cygnus ROM monitor," or "Cygmon: the ROM monitor." diff --git a/en-US/Conventions_for_Writers_and_Editors.ent b/en-US/Conventions_for_Writers_and_Editors.ent index a631fd8..87f791a 100644 --- a/en-US/Conventions_for_Writers_and_Editors.ent +++ b/en-US/Conventions_for_Writers_and_Editors.ent @@ -1,4 +1,5 @@ - + + \ No newline at end of file diff --git a/en-US/Conventions_for_Writers_and_Editors.xml b/en-US/Conventions_for_Writers_and_Editors.xml index 3f5dfde..d8ebb90 100644 --- a/en-US/Conventions_for_Writers_and_Editors.xml +++ b/en-US/Conventions_for_Writers_and_Editors.xml @@ -17,7 +17,7 @@ - + diff --git a/en-US/Cross_references.xml b/en-US/Cross_references.xml index c413ea7..546c632 100644 --- a/en-US/Cross_references.xml +++ b/en-US/Cross_references.xml @@ -6,10 +6,12 @@ Using Cross-references Effectively - This section contains suggestions on how to use cross-references in the most effective way. That is, so that it works for the reader, rather than the author. In DocBook XML, cross-references are formatted according to the style sheets; at this point no references are available that describe how they should be formatted in other media. Formatting is not described in this section. + This section contains suggestions on how to use cross-references in the most effective way: that is, so that they work for the reader rather than for the author. + + Formatting is not described in this section. - In the days of print-only documentation, cross-references referred readers to additional or related information that existed elsewhere in the physical printed book; on other pages. The readers had to physically turn pages to find the referenced page, so authors, editors, and proofreaders developed a certain caution about scattering cross-references through the text. Despite the ease of use and creation of cross-references and links in online documents today, the author must still do the work for the reader. It is still the author who must do the heavy lifting and arrange the information so that the reader can absorb it in the smoothest possible fashion. Forcing the reader to leap from link to link could indicate that the author is writing for their own ease, and not for the good of the reader. + In the days of print-only documentation, cross-references referred readers to additional or related information that existed elsewhere in the physical printed book, on other pages. The readers had to physically turn pages to find the referenced page, so authors, editors, and proofreaders developed a certain caution about scattering cross-references through the text. Despite the ease of use and creation of cross-references and links in online documents today, the author must still do the work for the reader. The author must still do the heavy lifting and arrange the information so that the reader can absorb it in the smoothest possible fashion. Forcing the reader to leap from link to link might indicate that the author is writing for their own ease, and not for the good of the reader.
The Additional Information Test @@ -17,7 +19,7 @@ Is the cross-reference pointing to vital information or additional information? - A cross-reference should always point to additional information, not core information that the reader needs to perform the task at hand. For example, in a procedure to configure an application, do not merely provide a link to the appendix where the correct naming conventions are described. Give the reader examples and explanations of a valid file name, and at the end of the procedure provide the link to the appendix. + A cross-reference should always point to additional information, not to core information that the reader needs to perform the task at hand. For example, in a procedure to configure an application, do not merely provide a link to the appendix where the correct naming conventions are described. Give the reader examples and explanations of a valid file name, and at the end of the procedure, provide a link to the appendix.
@@ -27,11 +29,11 @@ Does the paragraph or section consist largely of links? - In running text, there should not be more than a couple of links per paragraph. There should not be links in every paragraph, and there certainly must not be links in titles, subheadings, figure or table captions. Cross-references interrupt the flow of thought, and can actively interfere with the absorption of information. If the reader needs a lot of additional 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 indicating where more information is available. + 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. - Lists can be an exception, but try to provide the reader with a descriptive phrase or sentence for each cross-referenced item, as well as a lead-in and concluding sentence for the paragraph that contains the list. + Lists can be an exception, but try to provide the reader with a descriptive phrase or sentence for each cross-referenced item, as well as a lead-in and a concluding sentence for the paragraph that contains the list. @@ -40,10 +42,10 @@
The Repeatability Test - Does the information have to be repeated? + Must the information be repeated? - This is a hard one, and one that many authors abhor. Often the answer is yes. If the information is vital, and needs to appear in multiple places, it just has to be done. It's not a crime. In some circumstances, like online help, the reader wants the answer immediately. Do not force even one extra click on them. In a safety situation, it may be the only chance the reader has to find critical information quickly. Any vital information, that is not more than a couple of paragraphs, (or half a page, or 5 rows of a table) can be repeated rather than cross-referenced to. + This is a hard question, and one that many authors abhor. Often the answer is yes. If the information is vital, and must appear in multiple places, then it must be repeated. It's not a crime. In some circumstances, such is in online help, the reader wants the answer immediately. Do not force even one extra click on them. In a safety situation, it might be the only chance for the reader to find critical information quickly. Any vital information, which is not more than a couple of paragraphs (or half a page, or five rows of a table), can be repeated rather than be cross-referenced to. Cross-referencing is a good servant but a poor master. Content still rules! diff --git a/en-US/D.xml b/en-US/D.xml index 84095a2..4e62af4 100644 --- a/en-US/D.xml +++ b/en-US/D.xml @@ -10,10 +10,10 @@ daisy chain - Noun: A hardware configuration in which devices are connected to each other in a series. The SCSI interface, for example, supports a daisy chain of up to seven devices. + n. A hardware configuration in which devices are connected to each other in a series. The SCSI interface, for example, supports a daisy chain of up to seven devices. - Verb: To connect devices in a daisy chain pattern. + v. To connect devices in a daisy chain pattern. @@ -23,7 +23,7 @@ dash - In technical publications, The IBM Style Guide recommends not to use em dashes or en dashes at all. Use a colon or other suitable punctuation. + In technical publications, the IBM Style Guide recommends not to use em dashes or en dashes at all. Use a colon or other suitable punctuation. @@ -50,7 +50,7 @@ data mirroring - The act of copying data from one location to a storage device in real time. Because the data is copied in real time, the information stored from the original location is always an exact copy of the data from the production device. Data mirroring is useful in the speedy recovery of critical data after a disaster. Data mirroring can be implemented locally or offsite at a completely different location. + The act of copying data from one location to a storage device in real time. Because the data is copied in real time, the information that is stored from the original location is always an exact copy of the data from the production device. Data mirroring is useful in the speedy recovery of critical data after a disaster. Data mirroring can be implemented locally or offsite at a different location. @@ -104,13 +104,14 @@ data type - n. Do not use "datatype" or "data-type" unless they are actually variable names or some other literal value. + n. Do not use "datatype" or "data-type" unless they are variable names or some other literal value. + - + - debug @@ -141,6 +142,17 @@ + + + desire + + + Use "want" instead of "desire" when the reader's actions are optional (that is, they might not "need" something but might still "want" something). + + + + + desktop @@ -158,7 +170,7 @@ Any machine or component that attaches to a computer. Examples of devices include disk drives, printers, mice, and modems. These particular devices fall into the category of peripheral devices because they are separate from the main computer. - Most devices, whether peripheral or not, require a program called a device driver that acts as a translator, converting general commands from an application into specific commands that the device understands. + Most devices, whether peripheral or not, require a program called a device driver that acts as a translator, converting general commands from an application into specific commands that the device understands. @@ -168,7 +180,7 @@ DevOps - n., adj. A portmanteau that combines "development" and "operations." It refers to a specific method or organizational approach where developers and IT operations work together to create the applications that run the business. DevOps may also refer to the engineers and developers who work within these modern IT organizations. + n., adj. A portmanteau that combines "development" and "operations." It refers to a specific method or organizational approach where developers and IT operations work together to create the applications that run the business. DevOps can also refer to the engineers and developers who work within these modern IT organizations. @@ -178,7 +190,7 @@ dialog box - See the Word Usage appendix of The IBM Style Guide for usage information related to this and similar terms. + See the Word Usage chapter of the IBM Style Guide for usage information related to this and similar terms. @@ -198,14 +210,14 @@ digital transformation - Avoid this phrase. It is vague and could mean using digital technology to do something faster, to do something differently, or to do a completely new thing. The word "transform" implies a process with a beginning and an end. Some people use the phrase "digital leadership" to describe the ongoing adoption of digital technologies to advance their organization. If you must discuss the concepts of digital transformation or digital leadership, briefly define what you mean on the first occurrence. Describe, rather than label. + Avoid this phrase. It is vague and could mean use of digital technology to do something faster, to do something differently, or to do a completely new thing. The word "transform" implies a process with a beginning and an end. Some people use the phrase "digital leadership" to describe the ongoing adoption of digital technologies to advance their organization. If you must discuss the concepts of digital transformation or digital leadership, briefly define what you mean on the first occurrence. Describe, rather than label. Disk Druid - Correct. Do not use "Disk druid," "disk druid," or "diskdruid." This is a partitioning tool incorporated into Red Hat Enterprise Linux. + Correct. Do not use "Disk druid," "disk druid," or "diskdruid." This is a partitioning tool that is incorporated into Red Hat Enterprise Linux. @@ -215,8 +227,9 @@ disk, disc - Use "compact disc," but "diskette" or "hard disk." See The IBM Style Guide for more information and example use cases. + Use "compact disc" or "hard disk." See the IBM Style Guide for more information and example use cases. + @@ -230,6 +243,17 @@ + + + + display + + + v. Use only as a transitive verb. For example, write "the system displays a message" or "the message is displayed" (not "the message displays"). + + + + DNS @@ -268,37 +292,37 @@ double-click - v. Do not use "double click." + v. Always write hyphenated. - - downstream + + download - Correct. Use the one-word form for both the nominal and adjectival forms. See also . Do not use "down-stream" or "down stream." + v., n. Do not use "down load" or "down-load." - - downtime + + downstream - Correct. Refers to the period during which a server, service, or other resource is unavailable. Do not use "down-time" or "down time." + Correct. Use the one-word form for both the nominal and adjectival forms. See also . Do not use "down-stream" or "down stream." - - download + + downtime - v., n. Do not use "down load" or "down-load." + Correct. Refers to the period during which a server, service, or other resource is unavailable. Do not use "down-time" or "down time." diff --git a/en-US/Design.xml b/en-US/Design.xml index 6620120..1fa44a6 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -17,12 +17,13 @@ The standard for all Red Hat technical documentation is title case for all headings and titles. Diagram labels, table headings, procedure, and formal paragraph titles all fall under this heading, and consequently, standard title case capitalization rules apply. - The currently accepted reference for determining title case is https://titlecase.com/titlecase. + The currently accepted reference for determining title case is at https://titlecase.com/titlecase. - + + - Use sentence case for table column headers. - These are not classified as titles. + Use sentence case for captions, legends, diagram labels, and table column headers. + They are not classified as titles. Marketing and Brand Capitalization Guide @@ -41,19 +42,20 @@ Do not use terminating periods. - - Avoid Imperative Form + + Avoid Imperative Mood - Use the gerund form (noun form of verb) for titles, not the imperative form. + Use the gerund form (noun form of verb) for titles, not the imperative mood. For example, "Testing the Product", not "Test the Product". + - See The IBM Style Guide for more information. + See the IBM Style Guide for more information. Gerunds should be avoided elsewhere. - Refer to . + See . @@ -62,7 +64,7 @@ When creating chapter and section titles, do not include file, command, or similar names, and do not include DocBook elements. Instead, focus on the task at hand and introduce the required file and command names in the text. Including such objects in titles is generally considered poor technical writing practice. - Depending on how your documentation is built and delivered, including these object types can result in unpredictable results and even cause failed builds. + Depending on how your documentation is built and delivered, including these object types can result in unpredictable results and can even cause failed builds. @@ -70,14 +72,14 @@
Documenting Fonts - The preferred way to refer to each type of postscript font is "PostScript Type x," substituting "x" with either 1, 2, or 3, if the problem is specific to a particular type. + The preferred way to refer to each type of PostScript font is "PostScript Type x," substituting "x" with either 1, 2, or 3, if the problem is specific to a particular type.
Documenting the User Interface - In all cases, see The IBM Style Guide for initial guidance. + In all cases, see the IBM Style Guide for initial guidance. The following sections highlight exceptions or cases that might otherwise cause confusion.
@@ -105,7 +107,7 @@ - If you cannot easily reproduce the symbol, include a screen capture and/or a succinct description of the object type. + If you cannot easily reproduce the symbol, include a screen capture, or a succinct description of the object type, or both. Use this approach for icons, especially when they have no tooltip or other help text. Preferred Style for Documenting Icons @@ -118,26 +120,31 @@ - See the Computer Interfaces chapter in The IBM Style Guide for more information. + See the UI elements chapter in the IBM Style Guide for more information.
Navigating Through Multiple GUI Options - Use "Navigate to" when moving through multiple GUI options because it covers all cases where you might have to click, point to, select, or otherwise make a series of selections to initiate an action. + Use "Navigate to" when moving through multiple GUI options because it covers all cases where you might have to click, point to, press, select, or otherwise make a series of selections to initiate an action. - From example, "From the OpenShift web console, navigate to Monitoring → Alerting." + For example, "From the OpenShift web console, navigate to Monitoring → Alerting."
- Starting Applications from the Red Hat Enterprise Linux Desktop + Starting Applications from the Desktop + + This section describes how to start applications from a Red Hat Enterprise Linux-based distribution. + - Red Hat Enterprise Linux 7 introduces a new approach to starting applications from the desktop. In an effort to maintain consistency and to make translation easier, Red Hat documentation assumes the customer is using GNOME Classic, the default user interface, and prefers a consistent approach to instructing customers how to start applications. + RHEL 8 uses the following approach to starting applications from the desktop. + In an effort to maintain consistency and to make translation easier, Red Hat documentation assumes use of GNOME Classic, the default user interface, and prefers a consistent approach to instructing customers how to start applications. - The preferred approach is to use the Super key to enter the Activities Overview, enter the name of the required application, and to press Enter. The Super key appears in a variety of guises, depending on the keyboard and other hardware, but often as either the Windows or Command key, and typically to the left of the Spacebar. For example: + The preferred approach is to use the Super key to enter the Activities Overview, to enter the name of the required application, and to press Enter. + The Super key appears in various guises, depending on the keyboard and other hardware, but often as either the Windows or Command key, and typically to the left of the Spacebar. For example: Preferred Approach to Starting Applications from the Desktop @@ -151,7 +158,7 @@
Documenting Command Terminology and Syntax - Sufficient variation exists in the terminology used to describe commands, options, arguments, and so on that only general advice is provided here. + Sufficient variation exists in the terminology that is used to describe commands, options, arguments, and so on that only general advice is provided here. When referring to the command line as specified by Bash and POSIX, follow the terminology that the software uses. @@ -169,7 +176,7 @@ - See info bash and the Computer Interfaces chapter of The IBM Style Guide for further guidance. + See info bash and the IBM Style Guide for further guidance. The following examples are intended to highlight correct usage. @@ -184,14 +191,14 @@ - In the entire command consists of the following components: + In , the entire command consists of the following components: The prompt ($) - Indicates that a normal user can run the command, as compared to the root user, indicated by the number sign (#). + Indicates that a normal user can run the command, as compared to the root user, which would be indicated by the number sign (#). @@ -202,7 +209,7 @@ The actual command to run, without any optional or replaceable values. - This must be typed as is. + It must be typed as-is. @@ -212,7 +219,7 @@ Source options [username@]hostname:/repository_filename) - The optional user name, indicated by brackets ([]), followed by the host name and path to the repository. + The optional username, indicated by brackets ([]), followed by the hostname and path to the repository. All aspects of this component must be replaced with valid values. @@ -224,7 +231,7 @@ The optional directory into which the repository will be cloned. - This must be replaced with a valid value, or omitted. + It must be replaced with a valid value, or be omitted. @@ -237,26 +244,27 @@ $ scp filename [username@]hostname:/directory + - In the entire command consists of the following components: + In , the entire command consists of the following components: The command prompt ($) - + - Indicates that a normal user can run the command, as compared to the root user, which is indicated by the number sign (#). + - + The command (scp) - + - The actual command to run, without any optional or replaceable values. This must be typed as is. + @@ -266,7 +274,7 @@ Source options (filename) - The file name to copy. This must be replaced with a valid value. + The file name to copy. It must be replaced with a valid value. @@ -276,7 +284,7 @@ Target options ([username@]hostname:/directory) - The optional user name, indicated by brackets ([]), followed by the host name and path to the target directory. All aspects of this component must be replaced with valid values. + The optional username, indicated by brackets ([]), followed by the hostname and path to the target directory. All aspects of this component must be replaced with valid values. @@ -286,24 +294,24 @@ - Avoid using the and options on most commands, especially when logged in as the root user. This can lead to unintended consequences, such as removing files or directories by mistake or installing packages or other software that may not suit your system. Refer to the following examples: + In most cases, avoid using the and options on most commands, especially when logged in as the root user. This can lead to unintended consequences, such as removing files or directories by mistake or installing packages or other software that might not suit your system. Refer to the following examples: [root@serverc pam.d]# rm -f system-auth password-auth [root@serverc ~]# yum install -y new-package - In the examples shown above, omit the and options, respectively. + In these examples, omit the and options, respectively. - In some cases, such as in Ansible Playbooks or other automation scripts, it may be necessary to use these options. + In some cases, such as in Ansible Playbooks or other automation scripts, it might be necessary to use these options.
Documenting Multiple or Long Commands - Sometimes you need to demonstrate how to use very long commands that extend over two or more lines, or include several commands in a single example. If the commands are relatively short and straightforward, include the commands on consecutive lines: + Sometimes you need to demonstrate how to use long commands that extend over two or more lines, or that include several commands in a single example. If the commands are relatively short and straightforward, include the commands on consecutive lines: Documenting Multiple Commands @@ -337,7 +345,7 @@ $ vi myFile.txt You can also indent the second and subsequent lines of such commands to assist in clarity and readability if required. - You can use this option for either of the two designs mentioned above. + You can use this option for either of these two designs. @@ -356,13 +364,13 @@ $ vi myFile.txt Wrapping Long Commands Without Continuation Characters - This example uses neither continuation characters nor PS2 prompts, but it does demonstrate how to use line indentation to help clarify long commands. + This example uses neither continuation characters nor PS2 prompts, but it does demonstrate how to use line indentation to help to clarify long commands. # cd /var/lib/katello # myCommand --option funky --color=true - --config_file=<replaceable>/home/user/config.conf</replaceable> - --output_file=<replaceable>/home/user/output.txt</replaceable> + --config_file=/home/user/config.conf + --output_file=/home/user/output.txt @@ -371,21 +379,21 @@ $ vi myFile.txt
Referring to Replaceable Paths - To refer to a path that users need to replace with something specific to their system, use <replaceable> tags, the correct syntax for the system and object in question, and an indicative name. + To refer to a path that users need to replace with something that is specific to their system, use the appropriate markup for your content, the correct syntax for the system and object in question, and an indicative name. Use a leading slash if the absolute path is required. Referring to Replaceable Paths on Linux Systems - "Mount the ISO file in <filename><replaceable>/path/to/iso/file</replaceable></filename>." + "Mount the ISO file in /path/to/iso/file." - Remember to use the syntax appropriate to the system that you are documenting or describing. + Remember to use the appropriate syntax for the system that you are documenting or describing. Referring to Replaceable Paths on Microsoft Windows Systems - "Mount the ISO file in <filename><replaceable>C:\path\to\iso\file</replaceable></filename>." + "Mount the ISO file in C:\path\to\iso\file." @@ -393,58 +401,66 @@ $ vi myFile.txt For example: - A PATH variable for Bash might appear as <replaceable>/usr/bin:/usr/local/bin</replaceable>. + A PATH variable for Bash might appear as /usr/bin:/usr/local/bin. - A package path in Lua might appear as <replaceable>local.share.lua</replaceable>. + A package path in Lua might appear as local.share.lua.
Using Escalated Privileges Correctly + + + The term escalated privileges refers to changing to a user whose privileges allow operations that a normal user cannot access. + It also refers to temporarily changing the privileges of the current user to perfom those operations without actually changing user accounts. + This section is aimed primarily at Red Hat Training course material, but the principles and guidelines apply equally in any environment. - - The term escalated privileges refers to changing to a user whose privileges allow operations that a normal user cannot access. - It also refers to temporarily changing the privileges of the current user to perfom those operations without actually changing user accounts. - Classroom Exceptions - Although security is important, it is more important to not have unnecessary classroom security distract from the immediate topic being taught. + Although security is important, it is more important that classroom security does not unnecessarily distract from the immediate topic that is being taught.
General Recommendations - - These are recommendations, not rules. - As with most things, consistency is important. + The following are recommendations, not rules. + As in most matters, consistency is important. Do not swap between different approaches without reason. Choose which approach works best for your situation and use it consistently. - - In all cases, use the minimum privilege level required to achieve the task. + In all cases, use the minimum required privilege level to achieve the task. - In exercises, use sudo and sudo -i and set this up to work throughout all relevant systems in the classroom. + Use a consistent approach when giving instructions to change users. + For example: "Connect to the cluster node and become the root user." + + + Variations such as "become root" or similar are strongly discouraged. + + + + + Use sudo and sudo -i and set it up to work throughout all relevant systems. Do not use su - without good cause. - When there is a scattered minority of privileged commands in a mostly unprivileged exercise, use sudo on a per-command basis. + When a scattered minority of privileged commands occur in a mostly unprivileged exercise, use sudo on a per-command basis. - When the exercise is majority privileged, or has a significant number of privileged commands, use sudo -i either at the beginning of the exercise, or at an appropriate step where the privileged commands begin. + When the exercise is majority privileged, or has many privileged commands, use sudo -i, either at the beginning of the exercise, or at an appropriate step where the privileged commands begin. @@ -454,32 +470,34 @@ $ vi myFile.txt -
-
Exceptions + + - Some courses are specifically designed to teach sudo and its variations, the use of the related files, such as /etc/sudoers and so on. - For these courses, use the required variation for the topic being taught. + Some courses are specifically designed to teach sudo and its variations, the use of the related files, such as /etc/sudoers, and so on. + For these courses, use the required variation for the topic that is being taught. -
Ansible Courses - - - - Ansible courses typically use a devops user with passwordless sudo access (devops ALL=(ALL) NOPASSWD: ALL) on managed nodes to enable the use of become without a become password as root to do anything. - - - - - As much as possible, leave the system-wide default as become: false or become: no and if a single task needs privileges, set become: true or become: yes on that task. - - - - - If most tasks in a play require escalated privileges, set the entire play to become: true or become: yes and possibly selectively set individual tasks to become: false or become: no. - - - -
+
+
Ansible Courses + + + + Ansible courses typically use a devops user with passwordless sudo access (devops ALL=(ALL) NOPASSWD: ALL) on managed nodes to enable the use of become without a become password as root to do anything. + + + + + As much as possible, leave the system-wide default as become: false or become: no and if a single task needs privileges, set become: true or become: yes on that task. + + + + + If most tasks in a play require escalated privileges, set the entire play to become: true or become: yes and possibly selectively set individual tasks to become: false or become: no. + + + +
+
@@ -487,16 +505,16 @@ $ vi myFile.txt
Describing How to View and Edit Files - To describe how to view and edit files, such as configuration files, scripts, and so on, do not include editor names as part of the guidance, unless the topic is about a specific editor, or is otherwise necessary to achieve a desired result. + To describe how to view and edit files, such as configuration files, scripts, and so on, do not include editor names as part of the guidance, unless the topic is about a specific editor, or is otherwise necessary to achieve a wanted result. - For example, do not refer to cat or vi if you need to tell readers to "View the my-script file." If you need to tell readers to edit a file and add or remove content, write "Edit the my-script file and add the following content:" and then include the required content in a <screen> block. Use <code> tags to highlight the text that needs to be changed. Include some surrounding text in the file for context. Do not use line numbers as a reference point because they can change. + For example, do not refer to cat or vi if you need to tell readers to "view the my-script file." If you need to tell readers to edit a file and add or remove content, write "Edit the my-script file and add the following content:" and then include the required content in a <screen> block. Use <code> tags to highlight the text to change. Include some surrounding text in the file for context. Do not use line numbers as a reference point because they can change. - If the file that you need to edit is empty or does not exist, do not use <code> tags to highlight any content that needs to be added. + If the file to edit is empty or does not exist, do not use <code> tags to highlight any content to add. - You can also use here documents to describe how to create a file with required content. The syntax of here documents varies by system, shell, language, and so on, but a simple example is shown below. This example creates the my-script file in the current directory, using the example content. + You can also use here documents to describe how to create a file with required content. 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. my-script @@ -505,14 +523,14 @@ $ vi myFile.txt > # Start adding variables after this line > EOF]]> - In some cases it is necessary to indicate which tool to use to view a file. This is especially true of log files and other very long files. In these cases, suggest a viewer based on the operating system or environment in which you are working, such as tail, head, less, or journalctl. + In some cases, it is necessary to indicate which tool to use to view a file, especially for log files and other long files. In these cases, suggest a viewer based on the operating system or environment in which you are working, such as tail, head, less, or journalctl.
- Using Host and User Names Correctly + Using Host and Usernames Correctly - Many examples in Red Hat documentation require the use of user names, host names, IP addresses, and similar information. In an effort to reduce security risks, to minimize translation overhead, and to maintain consistency, Red Hat recommends the following. + Many examples in Red Hat documentation require the use of usernames, hostnames, IP addresses, and similar information. In an effort to reduce security risks, to minimize translation overhead, and to maintain consistency, Red Hat recommends the following approach. @@ -523,7 +541,7 @@ $ vi myFile.txt - Use RFC 2606 to determine suitable domain names. For documentation and example purposes, this is typically example.com, example.net, example.org, and example.edu. + Use RFC 2606 to determine suitable domain names. For documentation and example purposes, it is typically example.com, example.net, example.org, and example.edu. @@ -538,7 +556,7 @@ $ vi myFile.txt As much as possible, use user, username, root, admin, or similar names to identify classes of users. - Use these generic names when you refer to users outside of a case study. This helps students identify which part of a command can and should be replaced by establishing a consistent format for names of users and system items. For example: + Use these generic names when you refer to users outside a case study. It helps students to identify which part of a command to replace, by establishing a consistent format for names of users and system items. For example: [root@fedora ~]# setfacl -m u:user1:rw /project/file1 @@ -576,20 +594,20 @@ $ vi myFile.txt Sometimes, the recommended list of user and group names is too restrictive for the scope of a book or article. In such cases, the following extended model is acceptable. - Using Realistic User Names + Using Realistic Usernames When you are writing a detailed case study, such as training exercises, reviews, and similar material, use realistic names. These names should not be real people. In other words, do not use the name of an employee, a well-known person, or your neighbor. - For example, you are the system administrator at Global Banking and you have been asked to set up permissions to the accounting directory for the following users: John Doe, Sunni Koning, Huong Sabo, and Jerlene Paluch. John is a department manager and needs to be able to read from the accounting directory, Sunni is the lead accountant and needs both read and write access. + 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: John Doe, Sunni Koning, Huong Sabo, and Jerlene Paluch. John is a department manager and needs read access to the accounting directory. Sunni is the lead accountant and needs both read and write access. Choosing a Realistic Name - Consider the following when choosing a realistic name: - Examples taken from The IBM Style Guide and the Google Developer Documentation Style Guide. + Consider the following points when choosing a realistic name: + Examples taken from the IBM Style Guide and the Google Developer Documentation Style Guide. @@ -653,7 +671,7 @@ $ vi myFile.txt Group Names - Use any lowercase name that is a logical extension of the accepted user names, without the numerical suffix. For example, architects, developers, operators. + Use any lowercase name that is a logical extension of the accepted usernames, without the numerical suffix. For example, architects, developers, operators. @@ -666,7 +684,7 @@ $ vi myFile.txt
Documenting Currencies - Use local currency symbols wherever possible. If symbol clash occurs (USD vs AUD, for example), disambiguate with the 2-character country code. For example, US$, AU$. + Use local currency symbols wherever possible. If symbol clash occurs (USD versus AUD, for example), disambiguate with the 2-character country code. For example, US$, AU$. @@ -688,19 +706,34 @@ $ vi myFile.txt - + Acronyms - What are acronyms anyway? They are similar to abbreviations and initialisms but they are pronounced as an actual word. For example, COBOL is the acronym for Common Business-oriented Language, and POP is the acronym for Post Office Protocol. + What are acronyms anyway? + They are similar to abbreviations and initialisms but they are pronounced as a word. + An acronym is a word that is formed from the initial letters of a name, such as ROM for Read-Only Memory, or by combining initial letters or part of a series of words, such as LILO for LInux LOader. + COBOL is the acronym for Common Business-oriented Language, and POP is the acronym for Post Office Protocol. - + + + Consider pronunciation when using articles. 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). + + + + Spell out most acronyms and initialisms before using them in text, such as "The Embedded DevKit (EDK) ..." + Unless the acronym or initialism stands for a proper noun, use sentence case for the spelled out version: for example, "central processing unit (CPU)." + Unless required for the audience or the topic, do not spell out well-known abbreviations, such as HTML. + + - Bear pronunciation in mind when using articles. 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). + To form the plural of an acronym, add a trailing, lowercase "s" or "es" without an apostrophe, for example, ROMs, PINs, BIOSes. + - Be sure to use correct capitalization for acronyms. Not all acronyms are capitalized (for example, "spool"); see The IBM Style Guide or another suitable reference if you are unsure. + Be sure to use correct capitalization for acronyms. Not all acronyms are capitalized (for example, "spool"); see the IBM Style Guide or another suitable reference if you are unsure. + Initialisms @@ -709,14 +742,14 @@ $ vi myFile.txt - Bear pronunciation in mind when using articles. See for more information. + Consider pronunciation when using articles. See for more information.
Using Company, Product, and Brand Names Correctly - A number of restrictions apply to using company, product, and brand names in Red Hat documentation. Refer to internal sources for further conditions that might apply to your own products. + Various restrictions apply to using company, product, and brand names in Red Hat documentation. Refer to internal sources for further conditions that might apply to your own products. @@ -745,7 +778,7 @@ $ vi myFile.txt - Use non-breaking spaces to avoid breaking the company name over multiple lines. This also applies to product names and their versions. For example, use a non-breaking space between "Red" and "Hat," and also between "Enterprise," "Linux," and the version number. + Use non-breaking spaces to avoid breaking the company name, or product names and their versions, over multiple lines. For example, use a non-breaking space between "Red" and "Hat," and also between "Enterprise," "Linux," and the version number. 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. @@ -754,7 +787,7 @@ $ vi myFile.txt - Do not use non-breaking spaces between "Red Hat" and any product name. Consider the following examples: + Do not use non-breaking spaces between "Red Hat" and any product name. Consider the following DocBook XML examples: @@ -765,17 +798,19 @@ $ vi myFile.txt - The latest version is Red&nbsp;Hat Enterprise&nbsp;Linux&nbsp;7.0 + The latest version is Red&nbsp;Hat Enterprise&nbsp;Linux&nbsp;8.0 - + + For other markup languages, use the equivalent non-breaking space character. + - 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 "Linux" and "OpenStack" nor between "OpenStack" and "Platform." + 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 "Linux" and "OpenStack", nor between "OpenStack" and "Platform." @@ -791,7 +826,7 @@ $ vi myFile.txt - In this case, "Platform" is part of the product name. In other cases, words like "platform," "manager," and so on may not be part of the product name, in which case an article is acceptable, if not necessary. + In this case, "Platform" is part of the product name. In other cases, words like "platform," "manager," and so on might not be part of the product name, in which case an article is acceptable, if not necessary. @@ -808,7 +843,7 @@ $ vi myFile.txt - Red Hat Enterprise Linux 7 + Red Hat Enterprise Linux 8 @@ -823,7 +858,7 @@ $ vi myFile.txt - When writing about a product line, product release, or product family, use major version numbers. This includes all the releases (past, present, and future) of that major version. + When writing about a product line, product release, or product family, use major version numbers. It includes all the releases (past, present, and future) of that major version. Only use minor version numbers when you are referring to a specific minor release, or to a feature that is specific to that minor release. For example: @@ -852,7 +887,7 @@ $ vi myFile.txt - This rule only applies to Red Hat products. Refer to other companies' products and use their version numbers as they use them. + This rule applies only to Red Hat products. Refer to other companies' products and use their version numbers as they use them. @@ -864,7 +899,7 @@ $ vi myFile.txt To call attention to a statement, use an admonition. Red Hat technical documentation currently uses Note, Important, and Warning admonitions. - Admonitions automatically include a suitable title according to the type of admonition. Do not use a phrase or anything else for the title. Keep the following in mind if using admonitions: + Admonitions automatically include a suitable title according to the type of admonition. Do not use a phrase or anything else for the title. Keep in mind these considerations if using admonitions: @@ -886,7 +921,7 @@ $ vi myFile.txt - Use an Important admonition to show the user a piece of information that should not be overlooked. While this information may not change anything the user is doing, it should show the user that this piece of information could be vital. + Use an Important admonition to show the user a piece of information that should not be overlooked. While this information might not change anything that the user is doing, it should show the user that this piece of information could be vital. @@ -908,7 +943,7 @@ $ vi myFile.txt When making a recommendation, the preferred verbiage is "Red Hat recommends..." instead of the common but indirect "It is recommended...". Recommendations can include best practices, recommended practices, and product-specific suggestions. - Refer to for information on using the terms "best practices" and "recommended practices" in Red Hat documentation. + See for information on using the terms "best practices" and "recommended practices" in Red Hat documentation. @@ -934,6 +969,7 @@ $ vi myFile.txt </example> </section> +<!-- Describe at beginning of guide what it covers, but not to use markup. --> <section id="citing-other-works"> <title>Citing Other Works @@ -943,13 +979,15 @@ $ vi myFile.txt - + -<citetitle>Book Title</citetitle> by <author><firstname>First name</firstname><surname>Surname</surname></author>; Publisher. + +Book Title by First name Surname; Publisher. + For example, Maximum RPM by @@ -957,7 +995,7 @@ $ vi myFile.txt Bailey - ; Red Hat Press. + ; Red Hat Press. Referencing Other Internet Sites @@ -975,13 +1013,13 @@ $ vi myFile.txt - Short URLs, such as http://partner.redhat.com are OK to use in body text at your discretion. + Short URLs, such as http://partner.redhat.com, are OK to use in body text at your discretion. - If the URL is excessively long, or complex, create a link using the title of the destination as a label, and put the actual URL in a footnote. For example: See the Classification of Species + If the URL is excessively long or complex, create a link by using the title of the destination as a label, and put the actual URL in a footnote. For example: See the Classification of Species http://world-database-of-everything.com/en/classifcation_of_species/mammals.html page for more information. @@ -993,7 +1031,7 @@ $ vi myFile.txt
-
+ diff --git a/en-US/E.xml b/en-US/E.xml index 37285a8..01cafdf 100644 --- a/en-US/E.xml +++ b/en-US/E.xml @@ -7,20 +7,21 @@ E - e-book, e-business, e-commerce, e-learning, email + e-book, e-commerce, e-learning, email Refer to the primary reference for the type of copy you are creating, either AP or IBM. + - - e.g., i.e. + + e.g. - Red Hat technical documentation always expands these abbreviations. + Red Hat technical documentation always expands these abbreviations. Write out "for example". @@ -40,7 +41,7 @@ Emacs - If referring to the program, use "Emacs." For example, "Source-Navigator supports Emacs or vi commands." If referring to the shell prompt command, use "emacs." For example, "At the prompt, type emacs." The complete and correct name is "GNU Emacs." + If referring to the program, use "Emacs." For example, "Source-Navigator supports Emacs or vi commands." If referring to the shell prompt command, use "emacs." For example, "At the prompt, type emacs." The complete and correct name is "GNU Emacs." @@ -77,13 +78,13 @@ environment - The state of a computer, usually determined by which programs are running and basic hardware and software characteristics. For example, when one speaks of running a program in a UNIX environment, it means running a program on a computer that has the UNIX operating system. + The state of a computer, usually determined by which programs are running and basic hardware and software characteristics. For example, running a program in a UNIX environment means running a program on a computer that has the UNIX operating system. - One ingredient of an environment, therefore, is the operating system. But operating systems include a number of different parameters. For example, many operating systems allow you to choose your command prompt or a default command path. All these parameters taken together constitute the environment. + One ingredient of an environment, therefore, is the operating system. But operating systems include many different parameters. For example, in some operating systems, you can choose your command prompt or a default command path. All these parameters together constitute the environment. - Another term for environment in this sense is platform. + Another term for environment in this sense is platform. @@ -99,7 +100,7 @@ n. Initialism for "end of line" - Always use uppercase for the initialism. Do not capitalize the expansion except at the beginning of a sentence. When documenting GUI objects, use the same capitalization as that shown in the GUI. + Always use uppercase for the initialism. Do not capitalize the expansion except at the beginning of a sentence. When documenting GUI objects, use the same capitalization as shown in the GUI. @@ -129,22 +130,14 @@ event - An action or occurrence detected by a program. Events can be user actions, such as clicking a mouse button or pressing a key, or system occurrences, such as running out of memory. + An action or occurrence that is detected by a program. Events can be user actions, such as clicking a mouse button or pressing a key, or system occurrences, such as running out of memory. - - exclamation points (!) - - - Do not use at the end of sentences. An exclamation point can be used when referring to a command, such as the bang (!) command. - + - - - Exec-Shield @@ -159,7 +152,7 @@ execute - Has the same meaning as run. Execute means to perform an action, as in executing a program or a command. + Has the same meaning as run. Execute means to perform an action, as in executing a program or a command. @@ -169,7 +162,7 @@ Exif - Correct. Do not use "EXIF." Exif is an image file format specification that enables metadata tags to be added to existing JPEG, TIFF and RIFF files. Sometimes to referred to as "Exif Print." + Correct. Do not use "EXIF." Exif is an image file format specification that enables adding metadata tags to existing JPEG, TIFF, and RIFF files. Sometimes referred to as "Exif Print." @@ -179,7 +172,7 @@ extranet - Refers to an intranet that is partially accessible to authorized outsiders. Whereas an intranet resides behind a firewall and is accessible only to people who are members of the same company or organization, an extranet provides various levels of accessibility to outsiders. You can access an extranet only if you have a valid user name and password, and your identity determines which parts of the extranet you can view. + Refers to an intranet that is partially accessible to authorized outsiders. Whereas an intranet resides behind a firewall and is accessible only to members of the same company or organization, an extranet provides various levels of accessibility to outsiders. You can access an extranet only if you have a valid username and password, and your identity determines which parts of the extranet you can view. Capitalize only at the beginning of a sentence. diff --git a/en-US/Easily_Confused_Words.xml b/en-US/Easily_Confused_Words.xml index 9f952bc..53bf144 100644 --- a/en-US/Easily_Confused_Words.xml +++ b/en-US/Easily_Confused_Words.xml @@ -23,7 +23,7 @@ n. Refers to the emotional impact of an action. Unless you are writing a psychology article, this is unlikely to be the choice for you. - vb. Means to have an influence on something, or to cause something to change. + v. Means to have an influence on something, or to cause something to change. @@ -36,7 +36,7 @@ n. Refers to the result of some action. For example, "the team members discussed the effect of the new policy on their working conditions." - vb. Means to produce a result, or to cause something to happen. For example, "the CEO claimed that the new policy would effect a positive economic outcome." + v. Means to produce a result, or to cause something to happen. For example, "the CEO claimed that the new policy would effect a positive economic outcome." The use of "effect" as a verb is less common than the use of "affect," and there are usually alternatives that are clearer. For example, "the CEO claimed that the new policy would produce a positive economic outcome." @@ -59,7 +59,7 @@ assure - vb. Suggests mental comfort. For example, "I assured my future father-in-law that I would eventually find a job." + v. Suggests mental comfort. For example, "I assured my future father-in-law that I would eventually find a job." @@ -69,7 +69,7 @@ ensure - vb. Means to make sure of something, to be certain that something exists or some condition has been met. + v. Means to make sure of something, to be certain that something exists or some condition has been met. @@ -79,7 +79,7 @@ insure - vb. Relates to monetary insurance. + v. Relates to monetary insurance. diff --git a/en-US/F.xml b/en-US/F.xml index 952d661..c840078 100644 --- a/en-US/F.xml +++ b/en-US/F.xml @@ -10,7 +10,7 @@ fail back, failback - vb. Use the 2-word form. + v. Use the 2-word form. n. Use the 1-word form. @@ -26,7 +26,7 @@ fail over, failover - vb. Use the 2-word form. + v. Use the 2-word form. n., adj. Use the 1-word form. @@ -41,7 +41,7 @@ FAQ - When referring to a Frequently Asked Questions (FAQ) section of content, refer to it as "an FAQ" (to be read as "an Q") not "a FAQ." The plural form is "FAQs." + When referring to a Frequently Asked Questions (FAQ) section of content, refer to it as "an FAQ" (to be read as "an F") not "a FAQ." The plural form is "FAQs." @@ -51,7 +51,7 @@ fault tolerance (n.), fault-tolerant (adj.) - The ability of a system to respond gracefully to an unexpected hardware or software failure. There are many levels of fault tolerance, the lowest being the ability to continue operation in the event of a power failure. Many fault-tolerant computer systems mirror all operations; that is, every operation is performed on two or more duplicate systems, so if one fails the other can take over. + The ability of a system to respond gracefully to an unexpected hardware or software failure. Fault tolerance has many levels, the lowest being the ability to continue operation in the event of a power failure. Many fault-tolerant computer systems mirror all operations; that is, every operation is performed on two or more duplicate systems, so that if one fails, then the other can take over. @@ -84,7 +84,7 @@ A serial data transfer architecture developed by a consortium of computer and mass storage device manufacturers and now being standardized by ANSI. The most prominent Fibre Channel standard is Fibre Channel Arbitrated Loop (FAL). - FAL was designed for new mass storage devices and other peripheral devices that require very high bandwidth. Using optical fiber to connect devices, FAL supports full-duplex data transfer rates of 100MBps. FAL is compatible with, and is expected to eventually replace, SCSI for high-performance storage systems. + FAL was designed for new mass storage devices and other peripheral devices that require high bandwidth. Using optical fiber to connect devices, FAL supports full-duplex data transfer rates of 100 MBps. FAL is compatible with, and is expected eventually to replace, SCSI for high-performance storage systems. @@ -94,7 +94,7 @@ file extensions (general usage) - See File names, file types, and directory names in The IBM Style Guide. + See File names, file types, and directory names in the IBM Style Guide. @@ -104,7 +104,7 @@ file mode, file name, file system, file type - n. Write as shown, two words, unless used as a variable. See The IBM Style Guide for more information. + n. Write as shown, two words, unless used as a variable. See the IBM Style Guide for more information. adj. Hyphenate when used as a compound adjective. For example, "file-system attributes." @@ -117,8 +117,9 @@ FireWire - Correct. Do not use "Firewire" or "firewire." Although FireWire is a trademark of Apple Computer, it does not need to be listed with a trademark symbol when mentioned. Only when talking about Apple's FireWire software license or specific logos should the symbol be used (which is almost never). See http ://developer.apple.com/softwarelicensing/agreements/firewire.html for full details. + Correct. Do not use "Firewire" or "firewire." Although FireWire is a trademark of Apple Computer, it is not needed to append a trademark symbol, except to refer to Apple's FireWire software license or specific logos. See https://www.apple.com/legal/intellectual-property/guidelinesfor3rdparties.html. + @@ -130,7 +131,7 @@ n. Do not use "firm ware" or "firm-ware." - Software (programs or data) that has been written onto read-only memory (ROM). Firmware is a combination of software and hardware. ROMs, PROMs, and EPROMs that have data or programs recorded on them are firmware. + Software (programs or data) that is written onto read-only memory (ROM). Firmware is a combination of software and hardware. ROMs, PROMs, and EPROMs that have data or programs recorded on them are firmware. @@ -146,7 +147,8 @@ - + + + follow - vb. Refers to the use of the () option to various commands, such as tail, so that output is appended as the file grows. + v. Refers to the use of the () option for various commands, such as tail, so that output is appended as the file grows. + + + + following + + + When introducing a list or a procedure, use "following" with a noun. Instead of "Complete the following", use "Complete the following steps". + + + + foreground - In multiprocessing systems, the process that is currently accepting input from the keyboard or other input device is sometimes called the foreground process. + In multiprocessing systems, the process that is currently accepting input from the keyboard or other input device is sometimes called the foreground process. @@ -200,7 +213,7 @@ fortnight - A period of two weeks (14 nights). Avoid using. This term is not common in American English and may also be unfamiliar to non-native speakers. + A period of two weeks (14 nights). Avoid; this term is not common in American English and might also be unfamiliar to non-native speakers. @@ -232,7 +245,6 @@ Do not use. Instead, use "compatible with later versions." See also . - @@ -240,14 +252,15 @@ FQDN - A fully qualified domain name consists of a list of domain labels representing the hierarchy from the lowest relevant level in the DNS to the top-level domain (TLD). The domain labels are concatenated using the full stop (.) character (dot or period) as a separator between labels.https://en.wikipedia.org/wiki/Fully_qualified_domain_name + A fully qualified domain name consists of a list of domain labels representing the hierarchy from the lowest relevant level in the DNS to the top-level domain (TLD). The domain labels are concatenated by using the dot or period character (.) as a separator between labels.https://en.wikipedia.org/wiki/Fully_qualified_domain_name For example, www.redhat.com is a fully qualified domain name, where www is the host, redhat is the second-level domain, and com is the top-level domain. - A FQDN always starts with a host name and continues all the way up to the top-level domain name; consequently www.parc.xerox.com is also a FQDN. + An FQDN always starts with a hostname and continues all the way up to the top-level domain name; consequently www.parc.xerox.com is also an FQDN. + @@ -275,7 +288,7 @@ Do not use "frontend" as a noun or adjective. - See also + See also . @@ -292,21 +305,23 @@ - Futexes + futexes Correct. "Futex" is an abbreviation of "fast user-space mutex." Consequently, "futexes" is the correct plural form. + - Fuzzy + fuzzy Correct only when referring to fuzzy searches. See for details and examples. + diff --git a/en-US/G.xml b/en-US/G.xml index 9b3b2a5..35892e8 100644 --- a/en-US/G.xml +++ b/en-US/G.xml @@ -30,7 +30,7 @@ GB - Abbreviation of gigabyte. Depending on the type of content you are writing, refer either to The AP Style Guide or The IBM Style Guide. + Abbreviation of gigabyte. Depending on the type of content you are writing, refer either to The AP Style Guide or the IBM Style Guide. AP style: Do not use a space between the value and the abbreviation. For example, "a 2GB file." @@ -103,7 +103,7 @@ - GEO + GEO, geo Do not use. Use "region" or "geographical location" according to your needs. @@ -116,7 +116,7 @@ GFS, GFS2 - As of Red Hat Enterprise Linux 6, this is known as the Resilient Storage Add-On. Ensure you use the correct term. + As of Red Hat Enterprise Linux 6, it is known as the Resilient Storage Add-On. Ensure that you use the correct term. @@ -132,21 +132,21 @@ - - GigE + + gigabyte - See . + 2 to the 30th power (1,073,741,824) bytes. One gigabyte is equal to 1,024 megabytes. When abbreviating "gigabyte," use "GB." Use a non-breaking space between the unit and any value to prevent widows and orphans. - - - gigabyte + + + GigE - 2 to the 30th power (1,073,741,824) bytes. One gigabyte is equal to 1,024 megabytes. When abbreviating "gigabyte," use "GB." Use a non-breaking space between the unit and any value to prevent widows and orphans. + See . @@ -166,7 +166,7 @@ GNOME - Correct. Do not use "gnome," "Gnome," or other variants. See also + Correct. Do not use "gnome," "Gnome," or other variants. See also . @@ -176,7 +176,7 @@ GNOME Classic - Correct. Although the desktop team tends to refer to GNOME Classic (technically, GNOME Shell with the classic mode extensions enabled) as "classic mode" in internal and developer-oriented community documents, we should stay consistent with what is exposed to the user on the GDM login screen, that is, "GNOME Classic". The GNOME "modern mode" (technically, GNOME Shell with the classic mode extensions disabled) is referred to as "GNOME" (on the login screen and elsewhere). + Correct. Although the desktop team tends to refer to GNOME Classic (technically, GNOME Shell with the classic mode extensions enabled) as "classic mode" in internal and developer-oriented community documents, stay consistent with what is exposed to the user on the GDM login screen, that is, "GNOME Classic". The GNOME "modern mode" (technically, GNOME Shell with the classic mode extensions disabled) is referred to as "GNOME" (on the login screen and elsewhere). @@ -202,7 +202,7 @@ - + GPL diff --git a/en-US/Grammar.xml b/en-US/Grammar.xml index ea6fc76..2a305c6 100644 --- a/en-US/Grammar.xml +++ b/en-US/Grammar.xml @@ -121,7 +121,7 @@ Who - Relative pronoun when a person (or persons) is the subject. + Relative pronoun when persons are the subject. @@ -131,7 +131,7 @@ Whom - Relative pronoun when person is not the subject. + Relative pronoun when persons are not the subject. @@ -219,7 +219,7 @@ - The GNOME developers to whom I owe my gratitude are... + The GNOME developers to whom they owe gratitude are... @@ -227,18 +227,19 @@ - To help you choose between who and whom, substitute the person about whom you are speaking with either him or he. + To help you choose between who and whom, substitute the person about whom you are speaking with he, she, him, or her. + - If your restatement contains him, her, them, me, or us, then use whom or whomever. "I'm giving the book to him." "To whom am I giving the book?" + If your restatement contains him, her, them, me, or us, then use whom or whomever. "I'm giving the book to him." "To whom am I giving the book?" - If the restatement contains the word he, she, they, I, or we, then use who or whoever. "Do you think he would mind?" "Who do you think would mind?" "She's walking in the door." "Who's walking in the door?" + If the restatement contains the word he, she, they, II, or we, then use who or whoever. "Do you think he would mind?" "Who do you think would mind?" "She's walking in the door." "Who's walking in the door?" @@ -254,12 +255,13 @@ A sentence is one, complete thought. A sentence expresses something about a subject (a person, place, or thing) and a verb (what the subject is or does). - The following are things to consider when constructing sentences: + Consider the following points when constructing sentences: + Sentence Length - Try not to pack too much information into one sentence. Keep it short. For example, the following sentence is a good example of how not to write: + Try not to pack too much information into one sentence. In technical documentation, try not to exceed 30 words in a sentence. Keep it short. The following sentence is a bad writing example: @@ -269,7 +271,7 @@ Run-on Sentences - Two or more complete ideas that are joined without punctuation create a run-on sentence (also called a fused sentence). The sentence does not have to be long to be a run-on sentence, although the longer the sentence the more difficult it is to read. You can: + Two or more complete ideas that are joined without punctuation, or separated only by a comma, create a run-on sentence (also called a fused sentence). The sentence does not have to be long to be a run-on sentence, although the longer the sentence the more difficult it is to read. You can: @@ -282,19 +284,19 @@ - Use semicolons to form a compound sentence. Think of a semicolon as an extended breather; longer than a comma. + Use semicolons to form a compound sentence. Think of a semicolon as an extended breather; it is longer than a comma. - Insert a coordinating conjunction, such as "and" or "but", between the independent clauses to form a compound sentence. For example, "The process will start, but it will produce an error." + Insert a coordinating conjunction, such as "and" or "but", between the independent clauses to form a compound sentence. For example, "The process starts, but it produces an error." - Insert a subordinating conjunction, such as "although" or "because", which will form a compound sentence with a subordinate clause. For example, "Although the process will start, it will produce an error." + Insert a subordinating conjunction, such as "although" or "because", which forms a compound sentence with a subordinate clause. For example, "Although the process starts, it produces an error." @@ -338,7 +340,7 @@ Sentence Fragments - A sentence fragment is an incomplete sentence. For example, "We will release no upgrade before its time." is a complete sentence, whereas in "We will release no upgrade. At least, before its time." the second of the two sentences is a fragment. Repair sentence fragments by making them complete sentences. + A sentence fragment is an incomplete sentence. For example, "Red Hat releases no upgrade before its time." is a complete sentence, whereas in "We will release no upgrade. At least, before its time." the second of the two sentences is a fragment. Repair sentence fragments by making them complete sentences. @@ -413,6 +415,40 @@ + + + + "That" in Clauses + + Include the word "that" in clauses unless it results in writing that is too formal or stilted. The use of the conjunction "that" makes the sentence easier to translate and improves clarity for readers whose primary language is not English, + + + + + + + + + + + Example + Improvement + + + + + + + Verify your directory service is working. + Verify that your directory service is working. + + + + + + + +
Verbosity @@ -435,10 +471,15 @@ - The individual member of the social community often receives his information via visual, symbolic channels. + The individual member of the social community often receives information via visual, symbolic channels. People read. (Translation by Richard Feynman.) + + Perform the installation of the product. + Install the product. + + @@ -467,8 +508,8 @@ - To update the address lists may be your primary concern. - Your primary concern may be to update the address lists. + To update the address lists might be your primary concern. + Your primary concern might be to update the address lists. @@ -479,187 +520,21 @@
-
- Avoiding Ambiguities - - - Capitalizing Proper Nouns - - - In some cases it is not clear if a term refers to a concept or a proper noun or product name. By using the correct capitalization, you will help translators identify untranslatable proper nouns and Red Hat product names. - - - - - - - - - Example - Improvement - - - - - - - This property must be enabled when you are using CTDB in a Windows domain or in active directory security mode. - This property must be enabled when you are using CTDB in a Windows domain or in Active Directory security mode. - - - - - - - -
- - - - - - Homographic Verbs - - - The verb "may" can be used to express possibility as well as to grant permissions. Similarly, "should" can be used to make recommendations as well as to express obligation or expectation. A sentence containing one of these verbs often has a double meaning. Avoid these types of words. - - - - - - - - - Example - Improvement - - - - - - - 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. 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. OR It might be held in memory. - - - + - - -
- - - - - - Homonymity - - - When a single term has multiple meanings, be explicit in order to differentiate between them. - - - - - - - - - Example - Improvement - - - - - - - Tab through the dialog box. Set the tab. Move the tab on the ruler. How to show or hide tabs. Select the tab. - Use the tab key to move through the dialog box. Set the tab stop. Move the tab mark on the ruler. How to show or hide tab characters. Select the View tab in the Options dialog box. - - - - To create another administrator, click New on the File menu. - To create another administrator account, click New on the File menu. OR To set privileges for another administrator, click New on the File menu. - - - - - - - -
- - - See also . - - - - - - - - - Invisible Plurals - - - Some two-word phrases (noun + noun) do not clarify whether the first noun is singular or plural. - - - - - - - - - Example - Improvement - - - - - - - Once the file retrieval has been completed, you are ready to restart your system. - After the files have been retrieved, you can restart your system. - - - - - - - -
- - - - - - Synonymity - - - Sometimes multiple terms have a single meaning. If terms are used inconsistently, users (and translators) will assume they refer to different things. It is best to use a single term for a single concept throughout. - - - For example, "Administration GUI" and "Administration Console" could both be used to refer to a single application or to different applications. For this reason it is important that writers choose the most suitable term for each situation and use it consistently. - - - - - - - - -
+
Contractions and Abbreviations - Do not use contractions in Red Hat documents. For example, do not use "can't," "don't," "won't," and similar examples. Always write out in full. Take care also with abbreviations; replace "e.g." with "for example," and replace "i.e." with "that is," and so on. See The IBM Style Guide for full details. + Do not use contractions in Red Hat documents. 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. + + + + Take care also with abbreviations; replace "e.g." with "for example," and replace "i.e." with "that is," and so on.
@@ -667,8 +542,9 @@
Hyphenation - There are no hard and fast rules for hyphenation. In general, do not hyphenate unless required for clarity, or our other references declare that hyphens are required. The following is general guidance; if you are unsure about whether or not to hyphenate, ask your peers. + There are no hard and fast rules for hyphenation. In general, do not hyphenate unless required for clarity, or our other references declare that hyphens are required. The following is general guidance; if you are unsure about whether or not to hyphenate, ask your peers. See also the "Hyphens" topic in the IBM Style Guide. + Hyphenate for Clarity @@ -729,26 +605,27 @@ -
+
Gender References - Do not use gender-specific pronouns in documentation. It is far less awkward to read a sentence that uses "they" and "their" rather than "he/she" and "his/hers." In most cases, use "you" when giving instructions, and "the user," "new users," and so on in more general explanations. Do not use "one" in place of "you" when writing technical documentation. Using "one" is far too formal. + Do not use gender-specific pronouns in documentation, except to refer to a specific named user, such as in a case study. It is far less awkward 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. In most cases, when giving instructions, use the imperative mood or use "you". In more general explanations, you can use "the user" or "new users". Do not use "one" in place of "you" when writing technical documentation. Using "one" is far too formal. Do not use "it" to refer to a person. - +
Tense - Avoid future tense (or using the term "will") whenever possible. For example, future tense ("The screen will display...") does not read as well as the present tense ("The screen displays..."). Remember, the users you are writing for most often refer to the documentation while they are using the system, not after or in advance of using the system. + Avoid future tense (or using the term "will") whenever possible. For example, future tense ("The window will open ...") does not read as well as the present tense ("The window opens ..."). Remember, the users you are writing for most often refer to the documentation while they are using the system, not after or in advance of using the system. + - Use simple present tense as much as possible. It avoids problems with consequences and time related communications, and is the easiest tense for translation. + Use simple present tense as much as possible. It avoids problems with consequences and time-related communications, and is the easiest tense for translation. Report an issue -
+
diff --git a/en-US/H.xml b/en-US/H.xml index fc8703f..fc7bf97 100644 --- a/en-US/H.xml +++ b/en-US/H.xml @@ -54,7 +54,7 @@ - he, she + he/she Do not use. Reword to avoid. In most cases, "they" is acceptable as a singular pronoun. @@ -63,17 +63,7 @@ - - help desk - - - Typically two words, but use the term accepted by your organization. - - - - - - + health check @@ -110,7 +100,17 @@ - Do not capitalize when referring to those services in a general way. For example: "A health check ensures your systems perform at their best." + Do not capitalize when referring to those services in a general way. For example: "A health check ensures that your systems perform at their best." + + + + + + + help desk + + + Typically two words, but use the term accepted by your organization. @@ -126,12 +126,15 @@ + high-availability, high availability - adj. Hyphenate. For example, "high-availability cluster." Do not use "high availability." + adj. Hyphenate, except as part of a product name. For example, "high-availability cluster." + + n. Two words. For example, "Support is available 24x7 to help maintain high availability." @@ -153,7 +156,7 @@ home page - n. Two words. Capitalize the "H" at the beginning of a sentence. If part of a proper noun, capitalize accordingly. See The IBM Style Guide for more information. + n. Two words. Capitalize the "H" at the beginning of a sentence. If part of a proper noun, capitalize accordingly. @@ -170,10 +173,12 @@ - host name + hostname - n. Two words in most cases. Capitalize the "H" at the beginning of a sentence. See The IBM Style Guide for more information. + n. One word in most cases. + Capitalize the "H" at the beginning of a sentence. + See the IBM Style Guide for more information. @@ -244,7 +249,7 @@ HTML - When referring to the language, use "HTML," such as "To see the HTML version of this documentation..." When referring to a web page extension, use "html," such as "The main page is index.html." + When referring to the language, use "HTML," such as "To see the HTML version of this documentation ..." When referring to a web page extension, use "html," such as "The main page is index.html." @@ -257,7 +262,7 @@ adj. Hyphenate. Normal hyphenation rules apply. - n. Use the two-word version in all cases. Capitalize "huge" at the beginning of a sentence, and capitalize both words in titles. If you are documenting a user interface, use the capitalization used in that interface. + n. Use the two-word version in all cases. Capitalize "huge" at the beginning of a sentence, and capitalize both words in titles. If you are documenting a user interface, use the capitalization that is used in that interface. @@ -267,7 +272,7 @@ hybrid IT - The preferred term when talking about IT that spans both traditional and modern infrastructure, or private and public environments, or some combination of these. Because hybrid can indicate either infrastructure or environment or both, be specific about the underlying combination. See also . + The preferred term to refer to IT that spans both traditional and modern infrastructure, or private and public environments, or some combination of them. Because hybrid can indicate either infrastructure or environment, or both, be specific about the underlying combination. See also . @@ -277,7 +282,7 @@ Hyper-Threading - n. Hyper-Threading is Intel's implementation of simultaneous multithreading. Do not use hyperthreading or hyper-threading. If you are not referring specifically to Intel's implementation, use "simultaneous multithreading" or "SMT" instead. + n. Hyper-Threading is Intel's implementation of simultaneous multithreading. Do not use "hyperthreading" or "hyper-threading". If you are not referring specifically to Intel's implementation, use "simultaneous multithreading" or "SMT" instead. diff --git a/en-US/I.xml b/en-US/I.xml index 260b90b..fabe045 100644 --- a/en-US/I.xml +++ b/en-US/I.xml @@ -10,7 +10,7 @@ IA64 or ia64 - Do not use. Always use the term Itanium instead. It can be used in file names because they are not visible in the content. + Do not use. Always use the term Itanium instead. These terms can be used in file names because they are not visible in the content. @@ -25,6 +25,7 @@ + IBM Z - IBM Z is a family name used by IBM for all of its mainframe computers from the Z900 on. In July 2017, with another generation of products, the official family was changed to IBM Z from IBM z Systems. + IBM Z is a family name used by IBM for all of its mainframe computers from the Z900 on. In 2017, the official family was changed to IBM Z from IBM z Systems. + + + + + + + + i.e. + + + Do not use a Latin abbreviation. Instead, write out "that is". @@ -56,11 +69,24 @@ + + + + indexes + + + Correct. This is the correct plural form for US English spelling. Do not use "indices." + + + + + + InfiniBand - InfiniBand is a switched fabric network topology used in high-performance computing. The term is both a service mark and a trademark of the InfiniBand Trade Association. Their rules for using the mark are standard ones: append the ™ symbol the first time it is used and respect the capitalization (including the inter-capped "B") from then on. In ASCII-only circumstances, the "(TM)" string is the acceptable alternative. + InfiniBand is a switched fabric network topology that is used in high-performance computing. The term is both a service mark and a trademark of the InfiniBand Trade Association. Their rules for using the mark are standard ones: append the ™ symbol the first time that it is used and respect the capitalization (including the inter-capped "B") from then on. In ASCII-only circumstances, the "(TM)" string is the acceptable alternative. "Open InfiniBand" is deprecated and should not be used. @@ -103,13 +129,12 @@ Intel 64 - Correct. Do not use "Hammer," "x86_64," "x86-64," "x64," "64-bit x86" or other variations as the name of this architecture. + Correct. Do not use "Hammer," "x86_64," "x86-64," "x64," "64-bit x86," or other variations as the name of this architecture. The correct term for Intel's implementation of this architecture is "Intel® 64." - Until late 2006, Intel's official name for the architecture was "Intel EM64T" (for Extended Memory 64 Technology). - They have since changed the name to "Intel® 64" however, and Red Hat documentation should reflect this change. - When discussing the architecture generally, reference both AMD64 and Intel 64 implementations specifically. + + When discussing the architecture generally, reference both AMD64 and Intel 64 implementations specifically. See also . @@ -117,8 +142,9 @@ The AMD64 logo is trademarked; the term "AMD64" is not. - For more information about AMD trademarks, see the AMD Trademark Information page at . + For more information about AMD trademarks, see the AMD Trademark Information page at . + For more information about Intel® trademarks, see and . @@ -156,7 +182,7 @@ Correct. The first and all prominent uses of the name should be fully spelled out, immediately followed by the initialism. For example, "Intel Virtualization Technology (Intel VT) for Intel 64 or Itanium architecture (Intel Vi). Subsequent uses can be abbreviated to "Intel Vi." - Always write the initialism in uppercase, accompanied by the "Intel" mark. Do not use "Vi" or "VT." Do not use the initialism in any prominent places, such as in titles or paragraph headings, nor include any trademark symbols, such as ™ or "(TM)." + Always write the initialism in uppercase, accompanied by the "Intel" mark. Do not use "Vi" or "VT." Do not use the initialism in any prominent places, such as in titles or paragraph headings, and do not include any trademark symbols, such as ™ or "(TM)." @@ -197,7 +223,7 @@ Internet of Things (IoT) - Correct. Capitalize as shown, spell out on the first occurrence, and use the initialism thereafter. + Correct. Capitalize as shown; spell out on the first occurrence; and use the initialism thereafter. The Internet of Things (IoT) refers to uniquely identifiable objects and their virtual representations in an internet-like structure. @@ -213,7 +239,7 @@ Intranet, intranet - See the "Word usage" appendix of The IBM Style Guide for guidance. + See the "Word usage" appendix of the IBM Style Guide for guidance. @@ -223,10 +249,10 @@ I/O - Correct. Stands for input/output (pronounced "eye-oh"). The term I/O is used to describe any program, operation or device that transfers data to or from a computer and to or from a peripheral device. Every transfer is an output from one device and an input into another. Devices such as keyboards and mice are input-only devices, while devices such as printers are output-only. A writable CD is both an input and an output device. + Correct. Stands for input/output (pronounced "eye-oh"). The term "I/O" is used to describe any program, operation, or device that transfers data to or from a computer and to or from a peripheral device. Every transfer is an output from one device and an input into another. Devices such as keyboards and mice are input-only devices, while devices such as printers are output-only. A writable CD is both an input and an output device. - The term I/O is a non-countable noun. Append "operations" in order to refer to multiple units of I/O. For example: I/O operations could not be recovered in situations where I/O should have been temporarily queued, such as when paths were unavailable. + The term "I/O" is a non-countable noun. Append "operations" to refer to multiple units of I/O. For example: I/O operations could not be recovered in situations where I/O should have been temporarily queued, such as when paths were unavailable. @@ -256,10 +282,10 @@ IP Masquerade - A Linux networking function. IP Masquerade, also called IPMASQ or MASQ, allows one or more computers in a network without assigned IP addresses to communicate with the internet using the Linux server's assigned IP address. The IPMASQ server acts as a gateway, and the other devices are invisible behind it, so to other machines on the internet the outgoing traffic appears to be coming from the IPMASQ server and not the internal PCs. + A Linux networking function. IP Masquerade, also called IPMASQ or MASQ, allows one or more computers in a network without assigned IP addresses to communicate with the internet by using the Linux server's assigned IP address. The IPMASQ server acts as a gateway, and the other devices are invisible behind it, so to other machines on the internet the outgoing traffic appears to be coming from the IPMASQ server and not from the internal PCs. - Because IPMASQ is a generic technology, the server can be connected to other computers through LAN technologies such as Ethernet, Token Ring, and FDDI, as well as dial-up connections such as PPP or SLIP. + Because IPMASQ is a generic technology, the server can be connected to other computers through LAN technologies such as Ethernet, Token-Ring, and FDDI, as well as dial-up connections such as PPP or SLIP. @@ -279,7 +305,7 @@ IP switching - A new type of IP routing developed by Ipsilon Networks, Inc. Unlike conventional routers, IP switching routers use ATM hardware to speed packets through networks. Although the technology is new, it appears to be considerably faster than older router techniques. + A type of IP routing that Ipsilon Networks, Inc. developed. Unlike conventional routers, IP switching routers use ATM hardware to speed packets through networks. This type of IP routing appears to be considerably faster than older router techniques. @@ -289,7 +315,7 @@ ISV - Short for independent software vendor, a company that produces software. + Short for "independent software vendor", a company that produces software. @@ -299,7 +325,7 @@ IT/I.T. - Use "I.T." (with periods) only in headlines or subheadings where all caps are used, in order to clarify that the word is "IT" vs. "it." + Use "I.T." (with periods) only in headlines or subheadings where all caps are used, to clarify that the word is "IT" versus "it." @@ -309,31 +335,33 @@ Itanium - A member of Intel's Merced family of processors, Itanium is a 64-bit RISC microprocessor. Based on the EPIC (Explicitly Parallel Instruction Computing) design philosophy, which states that the compiler should decide which instructions be executed together, Itanium has the highest FPU power available. + A member of Intel's Merced family of processors, Itanium is a 64-bit RISC microprocessor. Based on the EPIC (Explicitly Parallel Instruction Computing) design philosophy, which states that the compiler should decide which instructions should be executed together, Itanium has the highest FPU power available. - In 64-bit mode, Itanium is able to calculate two bundles of a maximum of three instructions at a time. In 32-bit mode, it is much slower. Decoders must first translate 32-bit instruction sets into 64-bit instruction sets, which results in extra-clock cycle use. + In 64-bit mode, Itanium can calculate two bundles of a maximum of three instructions at a time. In 32-bit mode, it is much slower. Decoders must first translate 32-bit instruction sets into 64-bit instruction sets, which results in extra-clock cycle use. Itanium's primary use is driving large applications that require more than 4 GB of memory, such as databases, ERP, and future internet applications. - Do not use the term IA64. It can be used in file names because they are not printed in the content. + Do not use the term "IA64". It can be used in file names because they are not printed in the content. - Itanium 2 + Itanium 2 - Itanium 2 is correct. Do not use "Itanium2" and always use a non-breaking space between "Itanium" and "2." + Itanium 2 is correct. Do not use "Itanium2" and always use a non-breaking space between "Itanium" and "2." + + diff --git a/en-US/J.xml b/en-US/J.xml index 715093f..28be68f 100644 --- a/en-US/J.xml +++ b/en-US/J.xml @@ -10,7 +10,7 @@ JavaScript - "JavaScript" is a trademark of Oracle Corporation, and should be used when referring to the scripting language. When referring to a file written using this language, use all lowercase; for example, "...copy the IPA javascript file to the /temp directory." + "JavaScript" is a trademark of Oracle Corporation, and should be used when referring to the scripting language. When referring to a file that is written with this language, use all lowercase; for example, "...copy the IPA javascript file to the /temp directory." @@ -30,7 +30,7 @@ job - A task performed by a computer system. For example, printing a file is a job. Jobs can be performed by a single program or by a collection of programs. + A task that a computer system performs. For example, printing a file is a job. Jobs can be performed by a single program or by a collection of programs. @@ -40,7 +40,7 @@ jsvc - The Apache Commons Daemon jsvc is a set of libraries and applications for making Java applications run on UNIX more easily. At the beginning of a sentence, use "Jsvc", otherwise all lowercase. + The Apache Commons Daemon jsvc is a set of libraries and applications to run Java applications on UNIX more easily. At the beginning of a sentence, use "Jsvc", otherwise all lowercase. diff --git a/en-US/K.xml b/en-US/K.xml index 3867def..8a8b51d 100644 --- a/en-US/K.xml +++ b/en-US/K.xml @@ -10,7 +10,7 @@ KB, kB - Refer to The IBM Style Guide for the correct abbreviation to use for specific use cases. + See the IBM Style Guide for the correct abbreviation to use for specific use cases. @@ -43,7 +43,7 @@ kernel - The central module of an operating system. It is the part of the operating system that loads first, and it remains in main memory. Because it stays in memory, it is important for the kernel to be as small as possible while still providing all the essential services required by other parts of the operating system and applications. Typically, the kernel is responsible for memory management, process and task management, and disk management. + The central module of an operating system. It is the part of the operating system that loads first, and it remains in main memory. Because it stays in memory, it is important for the kernel to be as small as possible while still providing all the essential services that other parts of the operating system and applications require. Typically, the kernel is responsible for memory management, process and task management, and disk management. @@ -63,7 +63,7 @@ kernel panic - Correct. Numerous circumstances may cause a kernel panic, but unlike a kernel oops, when confronted with a kernel panic the operating system shuts down to prevent the possibility of further damage or security breaches. + Correct. Numerous circumstances might cause a kernel panic, but unlike a kernel oops, when confronted with a kernel panic the operating system shuts down to prevent the possibility of further damage or security breaches. @@ -115,7 +115,7 @@ keytab - n. (Kerberos) Correct. A keytab (short for "key table") stores long-term keys for one or more principals. See for full details. + n. (Kerberos) Correct. A keytab (short for "key table") stores long-term keys for one or more principals. For details, see . diff --git a/en-US/L.xml b/en-US/L.xml index 1e2e109..8cf9568 100644 --- a/en-US/L.xml +++ b/en-US/L.xml @@ -62,11 +62,13 @@ left-click - v. Do not use "left click" or "leftclick." + v. Write the term hyphenated. Do not use "left click" or "leftclick." + + LibreOffice @@ -91,14 +93,12 @@ + - life cycle, life-cycle, lifecycle + lifecycle - n. Two words. Only use the one-word form if it is an established part of a software interface, part of a proper noun, or an external standard. - - - adj. Hyphenate. + n., adj. One word. @@ -123,7 +123,7 @@ - To copy a program from a storage device into memory. Every program must be loaded into memory before it can be executed. Usually the loading process is performed invisibly by a part of the operating system called the loader. + To copy a program from a storage device into memory. Every program must be loaded into memory before it can be executed. Usually the loading process is performed invisibly by a part of the operating system called the loader. @@ -135,7 +135,7 @@ - n. The measurement of how any finite resource is being used. For example, the amount of data (traffic) being carried by the network, or the amount of CPU being used at any given time. + n. The measurement of how any finite resource is being used. For example, the amount of data (traffic) that the network carries, or the amount of CPU in use at any given time. @@ -149,7 +149,7 @@ load balancing - Distributing processing and communications activity evenly across a computer network so that no single device is overwhelmed. Load balancing is especially important for networks where it is difficult to predict the number of requests that will be issued to a server. Busy websites typically employ two or more web servers in a load balancing scheme. If one server starts to get swamped, requests are forwarded to another server with more capacity. Load balancing can also refer to the communications channels themselves. + Distributing processing and communications activity evenly across a computer network so that no single device is overwhelmed. Load balancing is especially important for networks where it is difficult to predict the number of requests that are issued to a server. Busy websites typically employ two or more web servers in a load balancing scheme. If one server starts to get swamped, requests are forwarded to another server with more capacity. Load balancing can also refer to the communications channels themselves. @@ -159,25 +159,42 @@ logical topology - Also called signal topology. Every LAN has a topology, or the way that the devices on a network are arranged and how they communicate with each other. The physical topology is the way that the workstations are connected to the network through the actual cables that transmit data - the physical structure of the network. The logical topology, in contrast, is the way that the signals act on the network media, or the way that the data passes through the network from one device to the next without regard to the physical interconnection of the devices. + Also called signal topology. Every LAN has a topology, which refers to the way that the devices on a network are arranged and how they communicate with each other. The physical topology is the way that the workstations are connected to the network through the cables that transmit data: the physical structure of the network. The logical topology, in contrast, is the way that the signals act on the network media, or the way that the data passes through the network from one device to the next without regard to the physical interconnection of the devices. + - - lookup, look-up, look up + + login, log in - - n. Use the one-word form. - - v. Use the two-word form. + Write as one word as an adjective or noun, or as two words as a verb. + + + + adj., n. One word. For example, "the login credentials". + + + + + + v. Two words. For example, "to log in as root". + + + + + + + + + log in to + - adj. Hyphenate when used as a modifier. For example, "a look-up table." + v. Write as three words. For example, "to log in to the system". - @@ -190,15 +207,31 @@ + + + lookup, look-up, look up + + + n. Use the one-word form. + + + v. Use the two-word form. + + + adj. Hyphenate when used as a modifier. For example, "a look-up table." + + + + loopback address - The loopback address is a special IP address (127.0.0.1 for IPv4, ::1 for IPv6) that is designated for the software loopback interface of a machine. The loopback interface has no hardware associated with it, and it is not physically connected to a network. + The loopback address is a special IP address (127.0.0.1 for IPv4, ::1 for IPv6) that is designated for the software loopback interface of a machine. No hardware is associated with a loopback interface, and it is not physically connected to a network. - The loopback interface allows IT professionals to test IP software without worrying about broken or corrupted drivers or hardware. + With a loopback interface, IT professionals can test IP software without concern for broken or corrupted drivers or hardware. @@ -218,7 +251,7 @@ LPAR - Abbreviation of logical partitioning, a system of taking a computer's total resources, such as processors, memory, and storage, and splitting them into smaller units that can be run with their own instance of the operating system and applications. Logical partitioning, which requires specialized hardware circuits, is typically used to separate different functions of a system, such as web serving, database functions, client/server actions, or systems that serve multiple time zones or languages. Logical partitioning can also be used to keep testing environments separated from production environments. Because the partitions act as separate physical machines, they can communicate with each other. Logical partitioning was first used in 1976 by IBM. + Abbreviation of "logical partitioning", a system of taking a computer's total resources, such as processors, memory, and storage, and splitting them into smaller units that can be run with their own instance of the operating system and applications. Logical partitioning, which requires specialized hardware circuits, is typically used to separate different functions of a system, such as web serving, database functions, client/server actions, or systems that serve multiple time zones or languages. Logical partitioning can also keep testing environments separated from production environments. Because the partitions act as separate physical machines, they can communicate with each other. Logical partitioning was first used in 1976 by IBM. diff --git a/en-US/Language.xml b/en-US/Language.xml new file mode 100644 index 0000000..6a76d1d --- /dev/null +++ b/en-US/Language.xml @@ -0,0 +1,1320 @@ + + +%BOOK_ENTITIES; +]> + + + Choosing Appropriate Language + + + Red Hat produces documentation for a global audience, and in many cases this documentation is translated into many languages. To reach the widest possible audience, and to make the task of translation as straightforward as possible, avoid slang and other culture-specific terminology. This chapter attempts to identify commonly used slang terms and phraseology, and to provide alternatives. + + + If you find slang terms or other difficult-to-understand passages in our documentation, use this section to search for alternatives. + + + Red Hat is committed to eliminating use of language that might exclude or offend certain groups of people. This chapter describes some considerations for use of inclusive language. + + + Also in this chapter is guidance on some common categories of ambiguity in writing and how to avoid it. + + +
+ Avoiding Misleading or Confusing Language + + Some terms, phrases, and general language can be confusing if you are not a native speaker or if the phraseology has regional significance. Sometimes spelling changes are introduced over time and regions, based purely on differences in pronunciation. Some phrases can carry hidden or unintentional meanings. This section attempts to introduce a few examples. + + + + best practices + + + This is a commonly understood phrase, and despite some concerns about using superlatives without statistics to back them up, Red Hat does not actively discourage its use. It is also a more common search term than most alternatives. If you are in any doubt, the preferred alternative is "recommended practices." + + + See the section for additional information about recommendations in Red Hat documentation. + + + + + + first come, first served + + + Indicates that customers will be attended to in the order that they arrive. The phrase abbreviates the sentence "The first to come is the first to be served," so use "served" instead of "serve" to keep the verb function the same. This phrase is an idiom, so avoid using it when content will be translated. When you use this phrase as an adjective, it is hyphenated as follows: Admittance is on a first-come, first-served basis. + + + + + + + + +
+
+ Identifying and Avoiding Slang + + Examples of slang terms: + + + + administrivia + + + Not a word. Do not use. + + + + + + + anything you like, anything they like + + + This phrase is probably readily understood but should not appear in Red Hat documentation. + + + + + "They can also use the slapi_register_plugin() call to register any kind of plug-in they like." + + + Rephrase to something more suitable, such as "... to register any other kind of plug-in." + + + + + + + + + + + + ask (as a noun), make the ask + + + "To ask" is a verb. + As a noun, "ask" is chiefly British and also considered informal. + Do not use it in technical documentation. + + + + + + + at this point in time + + + Do not use. In most cases, use "now." In some cases it is acceptable to use "at this point," for example, when you have reached a specific point in a procedure. + + + + + + + automagic + + + Also, automagical. Both terms are slang. Do not use. + + + + + + + best-of-breed + + + Jargon. Say exactly what you mean, for example, "the best product in its class" or "the best product of its type." Other alternatives include best, foremost, most advanced, optimum. The category is usually implied. Be wary of using superlatives without data to back up any claims. + + + + + + + bleeding edge + + + Do not use. + + + + + + + bottom line + + + Traditionally used in financial contexts; avoid overuse. + + + + + + + + bucketize + + + Not a word. Try "categorize" or "organize into logical groups." + + + + + + + center of competency + + + Do not use. + + + + + + + check this site + + + Understood to mean "have a look at this website." The preferred phraseology is "See www.somewhere.com for more information." It is better to avoid "check" because it has so many meanings. + + + + + + + + core competency + + + Jargon, cold and impersonal. Better choices include "specialization," "skill," "strength," "expertise," and so on. The De-Jargonator says: "'Competent' means 'adequate but not exceptional.' Why would you describe what you do best as 'competence'? Try instead: What your organization does best; competitive advantage; special or unique expertise or ability; specialty." + + + + + + + eat your own dogfood + + + Developer-speak. It means to use your own products. You can get a detailed description at http://en.wikipedia.org/wiki/Eat_one%27s_own_dog_food. + + + + + + + data point + + + Do not use. + + + + + + + dig deeper, delve deeper + + + "Visit the following web link to dig deeper into [subject]..." Using "dig deeper" may translate awkwardly. Consider rewording: "For detailed information regarding [subject], see [link]." + + + + + + + double-edged sword, double-bladed sword + + + If something is described as a double-edged sword, it indicates that it has two opposing behaviors or consequences. Instead, state that it can have unexpected consequences, or that the positive result might be offset by the negative result. + + + + + + + enterprise-ready + + + Although Red Hat used to use this term to emphasize its products' enterprise readiness, it is not as necessary now, especially when talking about a product with "Enterprise" in its name, unless you're calling this out as a key selling point. + + + + + + + exceed your expectations + + + Vague. Clarify with specifics, for example, "The movie made more money on the opening weekend than anyone expected." instead of "The movie exceeded our expectations." + + + + + + + fib + + + A fib is a "small lie," also known as a "white lie." + For example, "This command tells fibs" is better written as "The output of this command can be misleading." + + + + + + + flying by the seat of your pants + + + Generally understood to mean "reacting to events as they occur." Difficult to offer alternatives without context. + + + + + + + frame it up + + + Do not use. + + + + + + + frown upon + + + "To frown upon" means to hold in low regard, not to approve of, and so on. For example: "...we generally frown on the use of session context...". This translates to (and should have been written as) "...the use of session context is not recommended..." (or words to that effect). + + + + + + + fuzzy (search) + + + Even though "fuzzy" is slang, it is common when referring to searches, especially in databases. This example came from the Directory Server documentation: + + + + + In Directory Server, if you do a fuzzy search for "Smith," you will probably also get "Smyth," because it sounds the same. + + + + + + + The use of "fuzzy" is valid in this context. + + + Note the difference between this and "wildcard" searches: "Sm?th" could return "Smith," "Smyth," "Smeth," or even "Smrth." + + + Do not use "fuzzy" to describe something that is not clear, such as an image, a concept, an idea, and so on. For example, "He was a bit fuzzy on the details" is not valid. + + + + + + + going-forward basis + + + Jargon. Say "from now on," "in the future," or something similar. + + + + + + + happy path + + + Do not use. Often understood to mean "a path or method of least resistance" or "the preferred way to solve the current issue", this is localized slang and could easily be misunderstood. It could also produce problems for translation. + + + + + + + harness the power + + + Do not use. + + + + + + + have a crack at, jump right in + + + Have a crack at and jump right in are closely related in meaning as they imply to "get started or give it a try." Alternatives to these are "start," "try," and "begin," and will depend on the context of what is being discussed. + + + + + + + if you want, if you wish + + + Do not use. For example, instead of saying "If you want to perform an action,..." say "To perform an action,..." + + + + + + + in concert with + + + Do not use. Instead, say "with." For example, change "Use gcov in concert with GCC to analyze..." to "Use gcov with GNU CC to analyze..." + + + + + + + improve, enhance + + + Vague. Try to be more specific. + + + + + + + in a pinch + + + Under a tight schedule, hard pressed to achieve something. + + + + + + + + is designed to + + + Avoid this and similar phrases when describing products and services. Instead, state what the product does. + + + + + Incorrect: SSH is designed to work with almost any kind of public key algorithm or encoding format. + + + + + + Correct: SSH works with almost any kind of public key algorithm or encoding format. + + + + + + + + + + + kettle of fish + + + Commonly used in the expression "a different kettle of fish," meaning "that's a different matter (altogether)." Depending on the context, try to use "topic," "subject," "matter," or something similar. + + + + + + + leverage + + + Avoid. Alternatives include "use" and "take advantage of". + + + + + + + lights on, lights-on + + + Avoid using this term, because 1) it is jargon, 2) not everyone knows what it means, and 3) the meaning could be lost or confused in translation to other languages. + + + It is typically used to mean maintaining the status quo or just doing what is required to keep things up and running (versus being proactive and innovative). For example, "A cloud can deliver strategic advantages to the business by redirecting resources from lights-on to innovation." + + + + + + + low-hanging fruit + + + Metaphor. Do not use. + + + + + + + + meet your needs + + + Vague. Try to be more specific, for example, "lower your middleware costs." + + + + + + + mission-critical + + + Overused and jargony. Unless the topic is actually critical to a mission, use a factual term or phrase, for example, "Ensure that you have the applications that you need to help your customers." versus "Ensure that you have the mission-critical applications that your customers demand." + + + + + + + net-net + + + Jargon. Use "in summary," "the end result," or something similar. + + + + + + + niche focus + + + Do not use. + + + + + + + over the wire + + + Commonly used in expressions such as "password information is sent in plain text over the wire," meaning "sent unencrypted through the transmission medium" (whether it is a wired or wireless network, the internet, or whatever). The phrase is probably not required at all. "Sent or transmitted in plain text" is fine. + + + + + + + + paradigm + + + Avoid. Use "model," "standard," or something similar. + + + + + + + performant + + + In the technical industry context, it means "performs as expected" or "well-performing." It is not necessarily a word everyone knows (and technically, it means "a performer," as in a play, according to most dictionaries), so use an alternative if possible. + + + + + + + + piggyback + + + Slang. Do not use. + + + + + + + pre-baked + + + Means "prepared beforehand." Choose a suitable alternative, such as "preconfigured," depending on the context. + + + + + productize + + + Not a word. Find another way to say "modify something to become suitable as a commercial product." [wiktionary] + + + + + + + ready to rumble + + + "Let's get ready to rumble!" is a trademarked catchphrase used to introduce televised boxing or wrestling events. In US English slang, being "ready to rumble" means you are "ready to go ahead" or "ready to start." + + + + + + + rest on your laurels + + + Do not use. + + + + + + + right before doing something + + + Preferred phrase would be "immediately before doing something." Otherwise, write around the phrase. + + + + + + + root your server in the /serverRoot directory + + + This expression is inelegant. + Be aware of the multiple meanings of words. + Try something like "Use the /serverRoot directory as the root directory for your server." + + + + + + + shoot yourself in the foot + + + To "shoot yourself in the foot" indicates that you did something to harm your own cause, or acting against your own best interests. Remove the sentence; it should be self-evident from the surrounding information. (Found this statement alongside the "double-edged sword" comment with an added note about "preserving all your toes.") + + + + + + + shy of + + + Apart from the "normal" meaning of shy, it is also found in such phrases as "he was just shy of the mark," meaning that he didn't quite succeed. Also, to be "a few items shy of what's required" means to have fewer than the minimum required number. Avoid this terminology and use more easily understood terms; it will help translators and also those reading English documentation who are unfamiliar with such slang. + + + + + + + silo, siloed + + + Use "stand-alone," "confined," "separated," or something similar. + + + + + + + + + solutions-based + + + Do not use. + + + + + + + solution stack + + + Do not use. + + + + + + + + stovepipe + + + Jargon. In business, related to lack of cross-organizational communication, similar to "silo." + + + + + + + synergistic, synergy + + + Jargon. Use "cooperative," "working together," "collaborative," "harmonious," or something similar. + + + + + + + + to think outside the box + + + Use "think creatively" or "think unconventionally" or rephrase completely. + + + + + + + tunnel vision + + + Do not use. + + + + + + + under the covers + + + This refers to something being out of plain sight or not immediately obvious. For example, you might only see the results of some action or command, but what happens "under the covers" is what is going on in the background, that you can't see or are not aware of, to make that action of command possible. + + + + + + + value-added + + + Jargon. Say "added value" or "valuable." Or be more specific, for example, "adds value by improving productivity." + + + + + + + very + + + Use with caution. For example, there is little value in saying "very cost-effective" versus "cost-effective." + + + + + + + virtual elephants + + + This refers to a group of blind-folded people all touching different parts of an elephant and trying to describe what it is. Nobody sees the "big picture." Curiously, it appeared in an STC article about working in global and virtual teams and using effective communication. It falls into the same category as "skeletons in the closet," "dark horse," "black sheep," and so on. Use descriptions and adjectives that are not specific to a particular culture or locale. See http://en.wikipedia.org/wiki/Blind_Men-anElephant for more information. + + + + + + + + +
+
+ Neologisms (Invented Words) + + The English language is full of these words. Some of them are useful; some of them are less so; others are just painful, difficult to translate, and should be avoided. Many of them are the result of creating nouns from verbs, verbs from nouns, and adjectives from just about anything. Unless a particular word has been in use for some time and is generally accepted into common English, try to avoid these neologisms. If necessary, reword or restructure your sentences. + + + Examples + + + "This feature allows synchronization of adds, deletes, and changes ..." + + + + + This sentence converted three verbs to nouns. A better structure might be, "This feature allows the synchronization of add, delete, and change operations..." + + + + + + + + + + +
+ +
+ Phrasal Verbs + + Avoid using a two-word verb form (a phrasal verb) if a one-word equivalent exists. + + + + + + + + + Example + Improvement + + + + + + + click on + click + + + + fill in, fill out (a form) + complete (a form) + + + + leave out + omit + + + + print out + print + + + + + + + +
+ +
+
+ Anthropomorphism + + Anthropomorphism is applying human qualities to non-human things or animals. Avoid it in your writing. + + + Examples + + + The computer will think for a brief period. + + + + + Computers do not actually think but they might take a while to "process" commands. + + + + + + + + + + The Proxy Server is talking to either RHN Hosted or a Satellite Server. + + + + + It is quite common to say "talk to" in this context, but "communicate with," "connected to," "registered with," or something similar would be better. + + + + + + + + + + + Report an issue + + +
+ + +
+ Inclusive Language + + In a blog post, Red Hat senior vice president and chief technology officer, Chris Wright, affirms a commitment for Red Hat to identify and replace problematic language that is potentially divisive and does not foster inclusion: + + + + + + Follow these guiding principles: + + + Do not use the terms "white" or "black" in a context where white is represented as good or black is represented as bad, such as "whitelist" and "blacklist". Such usage reinforces a model that promotes racial bias. + + + For alternatives, choose words that describe the action that is taken or the function that is performed, rather than a metaphor for that action or function, for example "allowlist" instead of "whitelist", or "blocklist" or "denylist" instead of "blacklist". + + + Do not use "master" when it is paired with "slave". Such use diminishes the horror of the dehumanizing practice of slavery. Use of "master" is acceptable in other contexts, such as to refer to mastery of a skill. + + + Avoid gender bias. As an example, do not assume that the subject of a sentence is male if the context might refer to any gender. Thus, instead of using "man hours", use "labor hours" or "person hours". Avoid binary gendered language, such as "he" or "she", except to refer to a specific named person. Do not use "he or she". Instead, use the ungendered "they" as the preferred pronoun. + + + Avoid neurodiversity bias. For example, avoid the terms "sanity check" and "sanity test", and do not use "disabled" to refer to a person. + + + Avoid superlatives in job titles and descriptions, especially problematic terms such as "guru", "ninja", "rockstar", or "evangelist". + + + Such guidance, including judgement of what constitutes acceptable versus unacceptable use, will evolve over time. + +
+ + +
+ Avoiding Ambiguities + + + + Capitalizing Proper Nouns + + + In some cases it is not clear if a term refers to a concept or a proper noun or product name. By using the correct capitalization, you will help translators identify untranslatable proper nouns and Red Hat product names. + + + + + + + + + Example + Improvement + + + + + + + This property must be enabled when you are using CTDB in a Windows domain or in active directory security mode. + This property must be enabled when you are using CTDB in a Windows domain or in Active Directory security mode. + + + + + + + +
+ + + + + + Homographic Verbs + + + The verb "may" might indicate possibility or grant permission. Similarly, "should" might imply a recommendation or express obligation or expectation. A sentence containing one of these verbs often has a double meaning. Avoid these types of words. + + + + + + + + + + Example + Improvement + + + + + + + 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. 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. OR It might be held in memory. + + + + + + + +
+ + + + + + Homonymity + + + When a single term has multiple meanings, be explicit in order to differentiate between them. + + + + + + + + + Example + Improvement + + + + + + + Tab through the dialog box. Set the tab. Move the tab on the ruler. How to show or hide tabs. Select the tab. + Use the tab key to move through the dialog box. Set the tab stop. Move the tab mark on the ruler. How to show or hide tab characters. Select the View tab in the Options dialog box. + + + + To create another administrator, click New on the File menu. + To create another administrator account, click New on the File menu. OR To set privileges for another administrator, click New on the File menu. + + + + + + + +
+ + + See also . + + + + + + + + + Verb phrases + + + When you have more than one infinitive verb within a sentence, be clear what each verb refers to. + + + + + + + + + + Example + Improvement + + + + + + + Use the utility to run activities and save your settings. + + Depending on the meaning: 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 when you are done, save your settings (if the process consists of two separate steps, of which the utility does only one). + + + + + + + +
+ + + + + + + Invisible Plurals + + + Some two-word phrases (noun + noun) do not clarify whether the first noun is singular or plural. + + + + + + + + + Example + Improvement + + + + + + + Once the file retrieval has been completed, you are ready to restart your system. + After the files have been retrieved, you can restart your system. + + + + + + + +
+ + + + + + Verb phrases + + + Avoid ambiguous pronoun references, where a pronoun can refer to more than one antecedent. + + + + + + + + + + Example + Improvement + + + + + + + If the completed field contains text, it does not change. + If the completed field contains text, that text does not change. + + + + + + + +
+ + + + + + Synonymity + + + Sometimes multiple terms have a single meaning. If terms are used inconsistently, users (and translators) will assume they refer to different things. It is best to use a single term for a single concept throughout. + + + For example, "Administration GUI" and "Administration Console" could both be used to refer to a single application or to different applications. For this reason it is important that writers choose the most suitable term for each situation and use it consistently. + + + + + + + Use of "using" + + + Use of the word "using" can result in ambiguity, which can often be resolved by using "that uses" or "by using", according to the meaning. + + + + + + + + + + Example + Improvement + + + + + + + + Open the firewall ports using the existing service configuration. + + + Option 1: Open the firewall ports by using the existing service configuration. + + Option 2: Use the existing service configuration to open the firewall ports. + + + + + + The resource agents using mail alerts require a mail transport agent. + The resource agents that use mail alerts require a mail transport agent. + + + + + + + +
+ + + + + + Verb phrases + + + Ensure that a verb phrase at the start of a sentence modifies the correct word. + + + + + + + + + + Example + Improvement + + + + + + + Having configured your environment, the product is ready to be used. (The product does not configure the environment.) + After you configure your environment, you can use the product. + + + + + + + +
+ + + + + + + +
+ +
+ Dates and Times + + + Do not use an all-numeric representation for dates. For example, 9/12/2020 means September 12, 2020 in the US but 9 December 2020 in most other countries. Instead, write the month as a word. + + + + Instead of writing "The product was manufactured on 4/1/21", which is ambiguous, use a format in running text where the month is represented as a word rather than as a numeral, such as "The product was manufactured on 1 April 2021". + + + + 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". + + + Examples + + + The training class begins at 10 AM on 1 April 2021. + + + + + The coffee break is from 2:00 PM to 2:30 PM. + + + + + + +
+ + + +
+ Numbers + + Spell out the following number types: numbers zero through nine, any number that begins a sentence, a number that precedes another number (four 6-pound bags; eleven 20-pound bags), approximations (thousands of ...), and very large values. + + + Use numerals for numbers 10 and greater, and for numbers less than 10 if they appear in the same paragraph as numbers of 10 or greater (for example, "You answered 8 out of 14 questions correctly"). Use numerals for negative numbers, fractions, percentages, decimals, measurements, and references to book sections (for example, Chapter 3, Table 5, Page 11). Also use numerals when referring to registers (such as R1), code (such as x = 6), and release versions (such as Red Hat Enterprise Linux 8, Linux kernel 4.18). + + + Do not use commas in numbers with four digits (use 1000 rather than 1,000). Use commas, to separate goups of three digits, in numbers with five or more digits (such as 10,000; 123,456,789; 1,000,000,000). + + + See The Chicago Manual of Style, 17th Edition for detailed information on numbering formats. + + + +
+ Phone numbers + + Use spaces, not dashes or dots, to punctuate phone numbers. When indicating a number for international use, include the country code (+1 555 555 5555 for a US number, for example). US 800 numbers are not accessible from outside the country, so do not precede them with a country code (800 555 5555). Phone numbers beginning with 0 are not for international use. Make these numbers ready for international use by dropping the zero and adding the appropriate country code. For example, (055) 12345 would be for use in Italy only; change it to +39 (55) 12345 for international use. + + +
+ +
+ \ No newline at end of file diff --git a/en-US/M.xml b/en-US/M.xml index bf5dc7d..c28b479 100644 --- a/en-US/M.xml +++ b/en-US/M.xml @@ -10,7 +10,9 @@ macOS - In 2016, Apple rebranded OS X to macOS, adopting the nomenclature that it uses for their other operating systems: iOS, watchOS, and tvOS. The latest version of macOS is macOS 10.12 Sierra, which was publicly released in September 2016. + In 2016, Apple rebranded OS X to macOS, adopting the nomenclature that it uses for their other operating systems: iOS, watchOS, and tvOS. + + @@ -20,17 +22,17 @@ make sure - This means "be careful to remember, attend to, or find out something." For example, "make sure the rhedk group is listed in the output." + This means "be careful to remember, attend to, or find out something." For example, "make sure that the rhedk group is listed in the output." - You may be able to use "verify" or "ensure" instead. + You might be able to use "verify" or "ensure" instead. - manual/man page + manual, man page Correct. Two words. Do not use "manpage." @@ -39,12 +41,26 @@ + + + master + + + Do not use "master" when it is paired with "slave". Such use diminishes the horror of the dehumanizing practice of slavery. Use another term such as "main", "primary", "controller", or "leader". + + + Use of "master" is acceptable in other contexts, such as to refer to mastery of a skill. + + + + matrixes - Correct. This is the correct plural form for U.S. English spelling. Do not use "matrices." + Correct. This is the correct plural form for US English spelling. Do not use "matrices." + @@ -90,6 +106,16 @@ + + + MDOS + + + Correct. Do not use "ms-dos," "MSDOS," or "msdos." + + + + media @@ -97,19 +123,20 @@ - Objects on which data can be stored. These include hard disks, diskettes, CDs, and tapes. + Objects on which data can be stored. These include hard disks, CDs, and tapes. + - In computer networks, media refers to the cables linking workstations together. There are many different types of transmission media, the most popular being twisted-pair wire (normal electrical wire), coaxial cable (the type of cable used for cable television), and fibre optic cable (cables made out of glass). + In computer networks, "media" refers to the cables that link workstations together. Out of many types of transmission media, the most popular are twisted-pair wire (normal electrical wire), coaxial cable (the type of cable used for cable television), and fiber optic cable (cables made out of glass). - The form and technology used to communicate information. Multimedia presentations, for example, combine sound, pictures, and videos, all of which are different types of media. + The form and technology to communicate information. Multimedia presentations, for example, combine sound, pictures, and videos, all of which are different types of media. @@ -192,7 +219,7 @@ Montecito - Do not use. This is a code name for the "Intel Itanium Processor 9000 Sequence." This latter phrase should be used instead. + Do not use. It is a code name for the "Intel Itanium Processor 9000 Sequence." This latter phrase should be used instead. @@ -207,7 +234,7 @@ - To make a mass storage device available. In Linux environments, for example, inserting a floppy disk into the drive is called mounting the floppy. + To make a mass storage device available. For example, inserting a USB flash drive is called mounting the drive. @@ -252,16 +279,6 @@ - - - MDOS - - - Correct. Do not use "ms-dos," "MSDOS," or "msdos." - - - - multiprocessing @@ -284,11 +301,12 @@ - Mutexes + mutexes Correct. "Mutex" is an abbreviation of "mutual exclusion." Consequently, "mutexes" is the correct plural form. + @@ -297,7 +315,9 @@ MySQL - Common open source database server and client package. Do not use "MYSQL" or "mySQL." Mark the first mention of MySQL in body text with an ball (®) to denote a registered trademark. + Common open source database server and client package. Do not use "MYSQL" or "mySQL." Mark the first mention of MySQL in body text with an + + ® symbol to denote a registered trademark. diff --git a/en-US/N.xml b/en-US/N.xml index 4838241..4ec6a2e 100644 --- a/en-US/N.xml +++ b/en-US/N.xml @@ -10,29 +10,19 @@ navigate to - Use "Navigate to" when moving through multiple GUI options because it covers all cases where you might have to click, point to, select, or otherwise make a series of selections to initiate an action. For example, "From the OpenShift web console, navigate to Monitoring → Alerting." + Use "Navigate to" when moving through multiple GUI options, because it covers all cases where you might have to click, point to, select, or otherwise make a series of selections to initiate an action. For example, "From the OpenShift web console, navigate to Monitoring → Alerting." - Do not use "Go to" or "point to" or other variations. + Do not use "Go to", or "point to", or other variations. - - need - - - Use "need" instead of "desire" and "wish." Use "want" when the reader's actions are optional (that is, they may not "need" something but may still "want" something). - - - - - needs, needs to be, need to - Avoid when possible. Suggested alternatives include "must," "required," or "should." + Avoid when possible. Suggested alternatives include "must" or "required." @@ -56,7 +46,7 @@ network transparency - A condition in which an operating system or other service allows the user access to a remote resource through a network without needing to know if the resource is remote or local. For example, Sun Microsystems" NFS, which has become a de facto industry standard, provides access to shared files through an interface called the Virtual File System (VFS) that runs on top of the TCP/IP stack. Users can manipulate shared files as if they were stored locally on the user's own hard disk. + A condition in which an operating system or other service gives user access to a remote resource through a network without needing to know if the resource is remote or local. For example, Sun Microsystems NFS, now a de facto industry standard, provides access to shared files through the Virtual File System (VFS) interface that runs on top of the TCP/IP stack. Users can manipulate shared files as if they were stored locally on the user's own hard disk. @@ -66,10 +56,10 @@ NFS - Abbreviation of Network File System, a client/server application designed by Sun Microsystems that allows all network users to access shared files stored on computers of different types. NFS provides access to shared files through an interface called the Virtual File System (VFS) that runs in a layer above TCP/IP. Users can manipulate shared files as if they were stored locally on the user's own hard disk. + Abbreviation of Network File System, a client/server application designed by Sun Microsystems that provides access for all network users to shared files stored on computers of different types. NFS provides access to shared files through the Virtual File System (VFS) interface that runs in a layer above TCP/IP. Users can manipulate shared files as if they were stored locally on the user's own hard disk. - With NFS, computers connected to a network operate as clients while accessing remote files, and as servers while providing remote users access to local shared files. The NFS standards are publicly available and widely used. + With NFS, computers that are connected to a network operate as clients while accessing remote files, and as servers while providing remote users access to local shared files. The NFS standards are publicly available and widely used. @@ -81,7 +71,7 @@ - In networks, a processing location. A node can be a computer or some other device, such as a printer. Every node has a unique network address, sometimes called a Data Link Control (DLC) address or Media Access Control (MAC) address. + In networks, a processing location. A node can be a computer or some other device such as a printer. Every node has a unique network address, sometimes called a Data Link Control (DLC) address or a Media Access Control (MAC) address. @@ -117,22 +107,11 @@ - - numbers - - - Spell out numbers zero through nine, any number that begins a sentence, a number that precedes another number (four 6-pound bags; eleven 20-pound bags), approximations (thousands of...), and very large values. Use numerals for numbers 10 and greater and for numbers less than 10 if they appear in the same paragraph as numbers of 10 or greater (for example, "You answered 8 out of 14 questions correctly"). Use numerals for negative numbers, fractions, percentages, decimals, measurements, and references to book sections (Chapter 3, Table 5, Page 11). Also use numerals when referring to registers (such as R1), code (such as x = 6), and release versions (Red Hat Enterprise Linux 6, Source-Navigator 4.5). - - - Do not use commas in numbers with four digits (use 1000 rather than 1,000). Do use commas in numbers with five or more digits (10,000; 123,456,789; 1,000,000,000). - - - See The Chicago Manual of Style, 17th Edition for detailed information on numbering formats. - - - - + + diff --git a/en-US/O.xml b/en-US/O.xml index 7bc3847..f780786 100644 --- a/en-US/O.xml +++ b/en-US/O.xml @@ -20,8 +20,9 @@ object-oriented - Correct. Do not use "object oriented" or "objectoriented." This is a modifier, such as "Java is an object-oriented language." + Correct. Do not use "object oriented," "objectoriented," or "object-orientated." It is a modifier, such as "Java is an object-oriented language." + @@ -30,10 +31,7 @@ OEM - n. Stands for original equipment manufacturer, which is a misleading term for a company that has a special relationship with computer producers. OEMs buy computers in bulk and customize them for a particular application. They then sell the customized computer under their own name. The term is really a misnomer because OEMs are not the original manufacturers - they are the customizers. - - - To provide equipment to another company, an OEM, which customizes and markets the equipment. + n. Stands for original equipment manufacturer, which is a misleading term for a company that has a special relationship with computer producers. OEMs buy computers in bulk and customize them for a particular application. They then sell the customized computer under their own name. The term is a misnomer because OEMs are not the original manufacturers; they are the customizers. @@ -43,7 +41,7 @@ offline - adj. Do not use "off-line." + adj. Write as one word. Do not use "off-line." @@ -56,10 +54,12 @@ Correct. Use this term to refer to backing up a database while the database is not being accessed by applications. Do not use "cold backup" or any other variations. - The counterpart to this term is "online backup," to refer to the process of backing up a database while it is being accessed by other applications. Do not use "hot backup" or any other variations. + The counterpart to this term is "online backup," to refer to the process of backing up a database while it is being accessed by other applications. Do not use "hot backup" or any other variations. + + @@ -71,6 +71,10 @@ When referring to the OK button, it is not necessary to use "button" in the sentence. For example, "Click OK to close the dialog box." + + Use "OK" only to refer to an interface element, not in general text. For example, instead of using "It is OK to run the command", use alternative wording, such as "You can run the command". + + @@ -98,13 +102,15 @@ online - Correct. Do not use "on-line." + adj. Write as one word. Do not use "on-line." + + on-site @@ -119,7 +125,7 @@ on-the-fly - Do not use. Avoid using idioms, as this saying is not globally known. In this case, for example, "real time" is both non-idiomatic and more technically accurate. + Do not use. Avoid idioms, which might not be globally known. In this case, for example, "real time" is both non-idiomatic and more technically accurate. @@ -129,7 +135,7 @@ oops - A kernel oops is an error message generated as a result of a bug in the kernel. Do not use "oops" on its own. Also, avoid using "kernel oops" at the beginning of a sentence. See also "kernel panic." + A kernel oops is an error message that is generated as a result of a bug in the kernel. Do not use "oops" on its own. Also, avoid using "kernel oops" at the beginning of a sentence. See also "kernel panic." @@ -145,19 +151,11 @@ - - OpenJDK - - - The OpenJDK trademark is owned by Oracle with a fair-use clause, so be very careful about how you use this term. - - - open architecture - An architecture whose specifications are public. This includes officially approved standards as well as privately designed architectures whose specifications are made public by the designers. The opposite of open is closed or proprietary. + An architecture whose specifications are public. It includes officially approved standards as well as privately designed architectures whose specifications are made public by the designers. The opposite of open is closed or proprietary. @@ -172,6 +170,14 @@ + + + OpenJDK + + + The OpenJDK trademark is owned by Oracle with a fair-use clause, so be careful about how you use this term. + + OpenOffice @@ -180,7 +186,7 @@ A Linux desktop suite. Do not use "Openoffice," "Open Office," or "ooo." - See also + See also . @@ -201,10 +207,10 @@ open source way - A phrase coined by the Red Hat community and adopted by opensource.com in 2009. It is a reference to an "open source method", as in "Let's develop this the open source way." + A phrase that was coined by the Red Hat community and adopted by opensource.com in 2009. It is a reference to an "open source method", as in "Let's develop this project the open source way." - Do not use to suggest that something is being done only in the "spirit" of open source without actually having an open source policy as defined by Open Source Initiative to avoid diluting the legal meaning of the term "open source". + Do not use to suggest that something is being done only in the "spirit" of open source without actually having an open source policy as defined by Open Source Initiative, to avoid diluting the legal meaning of the term "open source". @@ -224,7 +230,7 @@ orientate - Do not use. A user becomes "oriented" to an environment. Try a synonym such as "familiarize," as in "This section helps familiarize you with the environment." + Do not use. A user becomes "oriented" to an environment. Try a synonym such as "familiarize," as in "This section helps to familiarize you with the environment." @@ -234,7 +240,7 @@ output device - Any machine capable of representing information from a computer. This includes display screens, printers, plotters, and synthesizers. + Any machine that is capable of representing information from a computer, including display screens, printers, plotters, and synthesizers. @@ -244,7 +250,7 @@ overcloud - n. Always lowercase. This is a concept, not a technology or product name. Being a common noun, this requires an article in most cases. See also . + n. Always lowercase. This is a concept, not a technology or product name. Being a common noun, it requires an article in most cases. See also . diff --git a/en-US/Objectives.xml b/en-US/Objectives.xml index 09475af..fc7a45f 100644 --- a/en-US/Objectives.xml +++ b/en-US/Objectives.xml @@ -48,6 +48,7 @@ + diff --git a/en-US/P.xml b/en-US/P.xml index 02ec0ac..31aa693 100644 --- a/en-US/P.xml +++ b/en-US/P.xml @@ -10,7 +10,7 @@ PaaS - n. This is the correct abbreviation for "Platform-as-a-Service." In the spelled-out version of this and its variants (for example, Infrastructure-as-a-Service and Software-as-a-Service), hyphens are always used. + n. The correct abbreviation for "Platform-as-a-Service." In the spelled-out version of this term and its variants (for example, Infrastructure-as-a-Service and Software-as-a-Service), always use hyphens. Marketing, Brand, Customer Portal Usage @@ -19,6 +19,9 @@ + + See also . + @@ -27,7 +30,7 @@ PC - n. Use to refer to a personal computer. See The IBM Style Guide for further information. + n. Use to refer to a personal computer. @@ -37,7 +40,7 @@ persist - vb. + v. Do not use as a verb to mean "store" or "save," for example, when referring to persistent storage. @@ -69,10 +72,10 @@ plain text - n. Two words. In most cases, do not use "plaintext," "cleartext" or other variants. + n. Two words. In most cases, do not use "plaintext," "cleartext," or other variants. - Cryptographers distinguish between "cleartext" (unencrypted data) and "plaintext" (unencrypted data as input to an encryption algorithm). Red Hat uses "plain text" as a plain English denotation of all unencrypted information, whether it is sitting about just being stored or is being fed to an encryption algorithm. Unless it is necessary to make the cryptographer's distinction, do not use "plaintext" or "cleartext." + Cryptographers distinguish between "cleartext" (unencrypted data) and "plaintext" (unencrypted data as input to an encryption algorithm). Red Hat uses "plain text" as a plain English denotation of all unencrypted information, whether it is stored or being fed to an encryption algorithm. Unless it is necessary to make the cryptographer's distinction, do not use "plaintext" or "cleartext." @@ -82,7 +85,11 @@ please - Do not use. Instead of saying "Please refer to the Getting Started Guide," use "See the Getting Started Guide." + Do not use. Instead of saying "Please see the Getting Started Guide," use "See the Getting Started Guide." + + + + Technical information requires an authoritative tone; terms of politeness convey the wrong tone for technical information and are not regarded the same way in all cultures. @@ -102,27 +109,26 @@ plug-in - n. Do not use "plugin." + n. Write hyphenated. Do not use "plugin." - A hardware or software module that adds a specific feature or service to a larger system. For example, a number of plug-ins are available for the Netscape Navigator browser that enable it to display different types of audio or video messages. Navigator plug-ins are based on MIME file types. + A hardware or software module that adds a specific feature or service to a larger system. + + - p.m. + PM - Correct. Use the lowercase form and include the periods, and use a preceding space. - + For times of day, use uppercase without periods, and use a preceding nonbreaking space after the numeral, for example "2 PM". + See also . - - See The IBM Style Guide for a full discussion of how to represent times. - @@ -137,40 +143,40 @@ - - PostScript + + POSIX - n. This is a registered trademark of Adobe. Do not use "Postscript." + n. Do not use "Posix," "posix," or variations thereof. + + + An acronym for "Portable Operating System Interface for UNIX." - - PowerPC + + PostScript - n. The name of the Power architecture is "Power", but the designation of individual chips tend to be either "PowerPC" or "POWER". Refer to IBM marketing or the Open Power Foundation if unsure. - - - Do not use the "PPC64" or "ppc64le" shorthand. Depending on context either "64-bit PowerPC" (which covers most 64-bit PowerPC implementations) or "64-bit IBM Power Series" (which covers the IBM POWER2 and IBM POWER8 and POWER9 series) is correct. Additional ABI features are important, but are not officially part of the Power architecture name, so use them as descriptors, such as "64-bit IBM Power Series in little-endian mode". - - - NB: the PowerPC version of Red Hat Enterprise Linux runs on 64-bit IBM Power Series hardware in almost all cases. + n. It is a registered trademark of Adobe. Do not use "Postscript." - - POSIX + + PowerPC - n. Do not use "Posix," "posix," or variations thereof. + n. The name of the Power architecture is "Power", but the designation of individual chips tends to be either "PowerPC" or "POWER". Refer to IBM marketing or the Open Power Foundation if unsure. - An acronym for "Portable Operating System Interface for UNIX." + Do not use the "PPC64" or "ppc64le" shorthand. Depending on context, either "64-bit PowerPC" (which covers most 64-bit PowerPC implementations) or "64-bit IBM Power Series" (which covers the IBM POWER2 and IBM POWER8 and POWER9 series) is correct. Additional application binary interface (ABI) features are important, but are not officially part of the Power architecture name, so use them as descriptors, such as "64-bit IBM Power Series in little-endian mode". + + + Note: The PowerPC version of Red Hat Enterprise Linux runs on 64-bit IBM Power Series hardware in almost all cases. @@ -193,7 +199,7 @@ press - vb. Use for keyboard instructions. For example: "Press the Enter key" or more succinctly "Press Enter." + v. Use for keyboard instructions. For example: "Press the Enter key" or more succinctly "Press Enter." @@ -207,13 +213,13 @@ - Use "proofs of concept" when there are multiple proofs, only one concept. + Use "proofs of concept" for multiple proofs and only one concept. - Use "proofs of concepts" when there are multiple proofs and multiple concepts. + Use "proofs of concepts" for multiple proofs and multiple concepts. @@ -241,7 +247,8 @@ - + + pull-down @@ -265,32 +272,32 @@ push-button automation, turn-key automation - Metaphorical language (literally, push a button or turn a key to begin automation), and difficult to translate. Often used to refer to easy or hands-off automation, but human intervention is required, so this use is not accurate. Instead, use language accurate to the situation being described, such as: + Metaphorical language (literally, push a button or turn a key to begin automation), and difficult to translate. Often used to refer to easy or hands-off automation, but human intervention is required, so this use is not accurate. Instead, use accurate language for the situation, such as: - User-triggered automation. + User-triggered automation - Ready-to-use/ready-to-deploy. + Ready-to-use, ready-to-deploy - Self-service/self-provisioned. + Self-service, self-provisioned. - Single-step automation. + Single-step automation - On-demand automation. + On-demand automation @@ -300,7 +307,7 @@ PXE - Short for Pre-Boot Execution Environment. Pronounced "pixie," PXE is one of the components of Intel's Wired for Management (WfM) specification. It allows a workstation to boot from a server on a network in preference to booting the operating system on the local hard drive. + Short for Pre-Boot Execution Environment. Pronounced "pixie," PXE is one of the components of Intel's Wired for Management (WfM) specification. With PXE, a workstation can boot from a server on a network in preference to booting the operating system on the local hard drive. PXE is a mandatory element of the WfM specification. To be considered compliant, PXE must be supported by the computer's BIOS and its NIC. diff --git a/en-US/Punctuation.xml b/en-US/Punctuation.xml index 953e782..e1046c9 100644 --- a/en-US/Punctuation.xml +++ b/en-US/Punctuation.xml @@ -23,13 +23,13 @@ - They had been writing code all night: this could explain their bloodshot eyes. + They had been writing code all night: this factor could explain their bloodshot eyes. - They had been writing code all night; this could explain their bloodshot eyes. + They had been writing code all night; this factor could explain their bloodshot eyes. @@ -125,13 +125,13 @@ - Open a terminal + Open a terminal. - Type cd Documents/Books + Type cd Documents/Books. @@ -199,8 +199,9 @@ - Use a semicolon before a conjunctive adverb, such as however, therefore, otherwise, namely, for example, and so on. + Use a semicolon before a conjunctive adverb, such as however, therefore, otherwise, namely, for example, and so on. + @@ -380,8 +381,9 @@
Parentheses - Parentheses are similar to commas in that they set off information that further explains or enhances a statement. Information that is very closely related to the statement should be set off with commas; information that is more incidental should be set off with parentheses. + Parentheses are similar to commas in that they set off information that further explains or enhances a statement. Information that is closely related to the statement should be set off with commas; information that is more incidental should be set off with parentheses. + @@ -398,8 +400,9 @@ - Expressions beginning with i.e., e.g., that is and so on can be set off with parentheses if they cause a major break in the sentence. If the break is minor, use commas. + Expressions beginning with for example, that is and so on can be set off with parentheses if they cause a major break in the sentence. If the break is minor, use commas. + @@ -409,7 +412,7 @@ - Classic works of literature (e.g., Dickens, Shakespeare, the Brontes) lined the shelves. + Classic works of literature (such as Dickens, Shakespeare, the Brontes) lined the shelves. @@ -422,22 +425,47 @@
Quotation Marks + Commas and periods go inside quotation marks. - - Question marks, exclamation points, dashes, and semicolons go inside the quotation marks if they are part of the quote; if not, they go outside. + + Question marks, exclamation points, dashes, and semicolons go inside the quotation marks if they are part of the quotation; if not, they go outside. +
+ + -
Apostrophes + + Do not use an apostrophe to denote a plural. + + + 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). @@ -453,5 +481,239 @@
-
+ +
+ Exclamation Points + + Do not use at the end of sentences. An exclamation point can be used when referring to a command, such as the bang (!) command. + + +
+ + +
+ Referring to Punctuation Marks + + To refer to a punctuation mark or special character, use its name alone if it is one of the following standard characters: + + + . , : ; ' " ( ) [ ] ! ? + + + For another character, use its name followed by the symbol in parentheses. + + + Do not use the symbol on its own. + + Referring to Punctuation Marks + + + Use a semicolon to separate two parts of a sentence that can each stand on their own. + + + The path contains the library qualifier in braces, { }. + + + + For more details, see the IBM Style Guide. + + +
+ + +
+ 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 + + + + + + Symbol + Name + + + + + + + & + Ampersand + + + + < > + Angle brackets + + + + ' + Apostrophe + + + + * + Asterisk + + + + @ + At sign + + + + \ + Backslash + + + + ` + Backtick + + + + { } + Braces + + + + [ ] + Brackets + + + + ^ + Caret + + + + ✓ + Check mark + + + + : + Colon + + + + , + Comma + + + + " + Double quotation mark + + + + ... + Ellipsis + + + + — + Em dash + + + + – + En dash + + + + = + Equal sign + + + + ! + Exclamation point + + + + / + Forward slash + + + + > + Greater than symbol + + + + - + Hyphen or minus sign + + + + < + Less than symbol + + + + # + Number sign; use hash to refer to a hashtag in social media + + + + ( ) + Parentheses + + + + % + Percent sign + + + + . + Period; dot (when not referring to punctuation) + + + + + + Plus sign + + + + ? + Question mark + + + + ; + Semicolon + + + + ' + Single quotation mark + + + + ~ + Tilde + + + + _ + Underscore + + + + + + + +
+ +
+
\ No newline at end of file diff --git a/en-US/Q.xml b/en-US/Q.xml index 631750c..32244f2 100644 --- a/en-US/Q.xml +++ b/en-US/Q.xml @@ -6,32 +6,16 @@ Q - - Q and A - - - n. Abbreviation for "Question and Answer," this format is listed in the American Heritage Dictionary. - - - - In DocBook XML, the title is defined by the DocBook style sheets for the <qandadiv> element. The relevant generated text in English is "Q & A" and is localized automatically. - - - - - - - qeth - Lowercase at all times. - Based on information from Linux on System z: Device Drivers, Features and Commands at http://www.ibm.com/developerworks/linux/linux390/development_documentation.html#1 + Lowercase at all times. - + diff --git a/en-US/R.xml b/en-US/R.xml index 5dcd72b..5176aaa 100644 --- a/en-US/R.xml +++ b/en-US/R.xml @@ -10,7 +10,7 @@ RAM - Correct. Do not use "Ram" or any other variations. This is an acronym for "random access memory." + Correct. Do not use "Ram" or any other variations. It is an acronym for "random access memory." @@ -23,7 +23,7 @@ Correct. Do not use "RAMdisk," "ramdisk," or "RAdisk." - Refers to RAM that has been configured to simulate a disk drive. You can access files on a RAM disk as you would access files on a real disk. RAM disks, however, are approximately a thousand times faster than hard disk drives. They are particularly useful, therefore, for applications that require frequent disk accesses. + Refers to RAM that is configured to simulate a disk drive. You can access files on a RAM disk as you would access files on a real disk. RAM disks, however, are approximately a thousand times faster than hard disk drives. They are particularly useful, therefore, for applications that require frequent disk accesses. @@ -34,6 +34,9 @@ Unprocessed. The term refers to data that is passed to an I/O device without being interpreted. In contrast, cooked refers to data that is processed before being passed to the I/O device. + + + The term can also refer to information that is not organized, formatted, or analyzed. The term comes from UNIX, which supports cooked and raw modes for data output to a terminal. In cooked mode, special characters, such as erase and kill, are processed by the device driver before being sent to the output device. @@ -41,22 +44,12 @@ - - - raw data - - - Information that has not been organized, formatted, or analyzed. - - - - read - v. To copy data to a place where it can be used by a program. The term is commonly used to describe copying data from a storage medium, such as a disk, to main memory. Also used to refer to the act of determining the contents of a variable or parameter. + v. To copy data to a place where a program can use it. The term is commonly used to describe copying data from a storage medium, such as a disk, to main memory. It can also refer to the act of determining the contents of a variable or parameter. n. The act of reading. For example, a fast disk drive performs 100 reads per second. @@ -69,7 +62,7 @@ read-only - Capable of being displayed, but not modified or deleted. All operating systems allow you to protect objects (disks, files, directories) with a read-only attribute that prevents other users from modifying the object. + Capable of being displayed, but not modified or deleted. For all operating systems, you can protect objects (disks, files, or directories) with a read-only attribute that prevents other users from modifying the object. @@ -79,14 +72,14 @@ read/write - Capable of being displayed (read) and modified (written to). Most objects (disks, files, directories) are read/write, but operating systems also allow you to protect objects with a read-only attribute that prevents other users from modifying the object. + Capable of being displayed (read) and modified (written to). Most objects (disks, files, or directories) are read/write, but you can also protect objects with a read-only attribute that prevents other users from modifying the object. - real time/real-time + real time, real-time n. The actual time during which something takes place. For example, "The computer may partly analyze the data in real time (as it comes in) -- R. H. March." @@ -132,7 +125,7 @@ remote access - The ability to log onto a network from a distant location. Generally, this implies a computer, a modem, and some remote access software to connect to the network. Whereas remote control refers to taking control of another computer, remote access means that the remote computer actually becomes a full-fledged host on the network. The remote access software dials in directly to the network server. The only difference between a remote host and workstations connected directly to the network is slower data transfer speeds. + The ability to log on to a network from a distant location. Generally, it implies a computer, a modem, and some remote access software to connect to the network. Whereas remote control refers to taking control of another computer, remote access means that the remote computer becomes a full-fledged host on the network. The remote access software dials in directly to the network server. The only difference between a remote host and workstations that are connected directly to the network is slower data transfer speeds. @@ -142,7 +135,7 @@ remote access server - A server that is dedicated to handling users that are not on a LAN but need remote access to it. The remote access server allows users to gain access to files and print services on the LAN from a remote location. For example, a user who dials into a network from home using an analog modem or an ISDN connection will dial into a remote access server. After the user is authenticated they can access shared drives and printers as if they were physically connected to the office LAN. + A dedicated server to handle users who are not on a LAN but who need remote access to it. With a remote access server, users can gain access to files and print services on the LAN from a remote location. @@ -172,7 +165,7 @@ right-click - v. Correct. Do not use "right click." + v. Write the term hyphenated. Do not use "right click." @@ -192,7 +185,7 @@ ROM, PROM - Acronym for read-only memory, computer memory on which data has been prerecorded. After data has been written onto a ROM chip, it cannot be removed and can only be read. + Acronym for read-only memory, computer memory on which data is prerecorded. After data has been written to a ROM chip, it cannot be removed and can only be read. A variation of a ROM is a PROM (programmable read-only memory). PROMs are manufactured as blank chips on which data can be written with a device called a PROM programmer. @@ -205,7 +198,7 @@ roundtable, round table - v. Use the one-word form to refer to a type of event or gathering. + n. Use the one-word form to refer to a type of event or gathering. n. Use the two-word form to refer to a circular table. @@ -218,7 +211,7 @@ RPM - Initialism for the RPM Package Manager. RPM manages files in the RPM format, known as RPM packages. Note: RPM packages are known informally as rpm files, but this informal usage is not used in Red Hat documentation in order to avoid confusion with the command name. Files in RPM format are referred to as "RPM packages." + Initialism for RPM Package Manager. RPM manages files in the RPM format, known as RPM packages. Note: RPM packages are known informally as rpm files, but this informal usage is not used in Red Hat documentation, to avoid confusion with the command name. Files in RPM format are referred to as "RPM packages." diff --git a/en-US/Resources.xml b/en-US/Resources.xml index a02719b..dbdc529 100644 --- a/en-US/Resources.xml +++ b/en-US/Resources.xml @@ -6,14 +6,14 @@ Resources - This section lists some books and websites for you to consult on your quest to create the perfect document. + This section lists some books and websites for you to consult on your quest to create a better document. - The guides that you refer to first are generally dictated by the type of material you are writing. It is important to establish this first because the guidelines in the following references sometimes contradict each other. This does not mean they are wrong; different audiences require different writing styles, and different references are sometimes required when you change styles. The following documentation types are recognized: + The guides that you refer to first are generally dictated by the type of material that you are writing. It is important to establish this point first because the guidelines in the following references sometimes contradict each other. It does not mean that the guidelines are wrong; different audiences require different writing styles, and different references are sometimes required when you change styles. The following documentation types are recognized: - Technical content: software manuals and documentation, user guides + Technical content: software manuals and documentation, user guides, training courses @@ -50,7 +50,7 @@ - IBM Style Guide, Sixth Edition. IBM Corp, 2004. + IBM Style Guide. IBM Corporation, latest version. @@ -101,10 +101,11 @@
-
+ + diff --git a/en-US/Revision_History.xml b/en-US/Revision_History.xml index f1e8054..92f53f6 100644 --- a/en-US/Revision_History.xml +++ b/en-US/Revision_History.xml @@ -7,6 +7,29 @@ Revision History + + 3-0 + July 2021 + + Julian + Cable + jcable@redhat.com + + + + Major update to align with some recent changes in IBM Style. + Sentence case is required for captions, legends, and diagram labels. + + Punctuation: Added sections on referring to punctuation marks and names of punctuation marks and special characters. + Rename Chapter 4 to "Choosing Appropriate Language": expand scope beyond slang and jargon, to cover inclusive language; avoiding ambiguities (moved from Chapter 2 and added more categories); dates and times (AM and PM are now written in uppercase without periods); and numbers. + Usage A-Z: Various additions and updates. Corrected alphabetical sorting sequence. Moved items that are not literal term entries to an earlier chapter. + Minor edits so the guide itself conforms with its own advice. + + + + + + 2.0-1 Wed Jun 3 2015 diff --git a/en-US/S.xml b/en-US/S.xml index dcc252c..fabaee0 100644 --- a/en-US/S.xml +++ b/en-US/S.xml @@ -20,7 +20,8 @@ SaaS - Correct. This is the correct abbreviation for "Software-as-a-Service." See also . + The correct abbreviation for "Software-as-a-Service." + See also . @@ -37,7 +38,7 @@ - record + S-record Correct. Do not use "s-record," "Record," "s-Record," or any other variations. @@ -50,7 +51,7 @@ screen capture - n. Do not use "screen shot," "screenshot," or other terms or variations. See the relevant entry in The IBM Style Guide. + n. Do not use "screen shot," "screenshot," or other terms or variations. See the relevant entry in the IBM Style Guide. @@ -99,8 +100,8 @@ With this new version, the application is running on a more secure, gateway-protected endpoint. - This functionality secures your connection. - This functionality improves the security of your connection. + This function secures your connection. + This function improves the security of your connection. Developers can easily change the code to implement secured access. @@ -146,11 +147,11 @@ - - sends out + + send out - Do not use. Instead, use "emits" or "issues." + Do not use. Instead, use "emit" or "issue." @@ -160,7 +161,7 @@ server farm - Also referred to as server cluster, computer farm or ranch. A server farm is a group of networked servers that are housed in one location. A server farm streamlines internal processes by distributing the workload between the individual components of the farm and expedites computing processes by harnessing the power of multiple servers. The farms rely on load-balancing software that accomplishes such tasks as tracking demand for processing power from different machines, prioritizing the tasks and scheduling and rescheduling them depending on priority and demand that users put on the network. When one server in the farm fails, another can step in as a backup. + Also referred to as a server cluster, computer farm, or ranch. A server farm is a group of networked servers that are housed in one location. A server farm streamlines internal processes by distributing the workload between the individual components of the farm and expedites computing processes by harnessing the power of multiple servers. The farms rely on load-balancing software that accomplishes such tasks as tracking demand for processing power from different machines, prioritizing the tasks, and scheduling and rescheduling them depending on priority and demand that users put on the network. When one server in the farm fails, another can step in as a backup. @@ -176,11 +177,12 @@ + setup - Use "setup" as a noun, "set up" as a verb, and "set-up" as an adjective. For example: + Use "setup" as a noun or an adjective, and "set up" as a verb. For example: @@ -197,7 +199,7 @@ - Follow the set-up instructions included with the hardware. + Follow the setup instructions that are included with the hardware. @@ -214,7 +216,7 @@ Pronounced "shä" and thus requires "an" as the indefinite article. - SHA stands for Secure Hash Algorithm; each is a cryptographic hash function. SHA2 variants are often specified using their digest size, in bits, as the trailing number, in lieu of "2." Thus "SHA224," "SHA256," "SHA384," and "SHA512" are considered correct when referring to these specific hash functions. + SHA stands for Secure Hash Algorithm; each is a cryptographic hash function. SHA2 variants are often specified by using their digest size, in bits, as the trailing number, in lieu of "2." Thus "SHA224," "SHA256," "SHA384," and "SHA512" are considered correct when referring to these specific hash functions. See for full details. @@ -260,7 +262,7 @@ share name - Correct. Do not use "sharename" or "Sharename" unless you are quoting the output of commands, such as "smbclient -L." + Correct. Do not use "sharename" or "Sharename" unless you are quoting the output of commands, such as smbclient -L or similar. @@ -315,6 +317,25 @@ + + + + sign in + + + v. Write as two words. For example, "two options are available to sign in". + + + + + + sign in to + + + v. Write as three words. For example, "to sign in to the system". + + + simply @@ -330,7 +351,7 @@ since, as, because - Do not use "since" or "as" to mean "because," it is ambiguous. Use "because" to refer to a reason. Use "since" or "as" to refer to the passage of time. + Do not use "since" or "as" to mean "because"; it is ambiguous. Use "because" to refer to a reason. Use "since" or "as" to refer to the passage of time. @@ -340,7 +361,7 @@ skill set, skills, knowledge - n. Avoid using "skill set" as much as possible; use "skills" or "knowledge" instead. Do not use "skill set" or "skill-set" as an adjective. Do not use "skill-set knowledge;" it is redundant. See the following examples: + n. Avoid using "skill set" as much as possible; use "skills" or "knowledge" instead. Do not use "skill set" or "skill-set" as an adjective. Do not use "skill-set knowledge"; it is redundant. See the following examples: Example Use of Term "Skillset" Versus "Skills" @@ -372,11 +393,21 @@ n. SLA stands for Service Level agreement. The phrase itself is not normally capitalized but official SLA defect ratings, such as Low, Moderate, and Critical, carry initial caps. - This distinguishes the SLA-defined ratings from the severity of general issues and identifies them as requiring a predetermined response time and level of support according to agreements. + This capitalization distinguishes the SLA-defined ratings from the severity of general issues and identifies them as requiring a predetermined response time and level of support according to agreements. + + + slave + + + Do not use. It diminishes the horror of the dehumanizing practice of slavery. Use another term such as "worker", "child", "helper", "replica", or "secondary (server, node, process, or other noun)". + + + + smart card @@ -402,7 +433,7 @@ softcopy - Do not use. Instead, use "online." For example, "To view the online documentation..." + Do not use. Instead, use "online." For example, "To view the online documentation ..." @@ -433,7 +464,7 @@ v. In addition to the generic use of this term as a noun and verb, in -a programming and technical sense this also means "Run the source command against the named file." +a programming and technical sense, it also means "Run the source command against the named file." @@ -441,7 +472,7 @@ a programming and technical sense this also means "Run the sourcespace - Use when referring to white space, such as "Ensure there is a space between each command." Use "Spacebar" when referring to the keyboard key. + Use when referring to white space, such as "Ensure that a space occurs between each command." Use "Spacebar" when referring to the keyboard key. @@ -481,11 +512,11 @@ a programming and technical sense this also means "Run the sourcespelled - Correct. Do not use "spelt." + Correct. It is the standard US English spelling. Do not use "spelt." - + @@ -494,16 +525,16 @@ a programming and technical sense this also means "Run the sourceSQL - When referring to the ISO standard (ISO 9075 and its descendants), this is pronounced as an initialism: ĕs kyü ĕl. Consequently, it takes "an" as an indefinite article. + When referring to the ISO standard (ISO 9075 and its descendants), it is pronounced as an initialism: ĕs kyü ĕl. Consequently, it takes "an" as an indefinite article. When referring to Microsoft's proprietary product, SQL Server, pronounce it as a word: "sequel." In this case, it takes "a" as an indefinite article. - NB: Oracle also pronounces its SQL-based products (such as PL/SQL) as "sequel." + Note: Oracle also pronounces its SQL-based products (such as PL/SQL) as "sequel." - More generally, avoid using "SQL" as a generic marker if at all possible. When discussing MySQL, write "MySQL." When discussing Microsoft SQL Server, write "Microsoft SQL Server." When discussing PostgreSQL (which is pronounced pŏstgrĕs kyü ĕl), write "PostgreSQL." + More generally, avoid use of "SQL" as a generic marker if possible. When discussing MySQL, write "MySQL." When discussing Microsoft SQL Server, write "Microsoft SQL Server." When discussing PostgreSQL (which is pronounced pŏstgrĕs kyü ĕl), write "PostgreSQL." @@ -513,7 +544,7 @@ a programming and technical sense this also means "Run the sourceSR-IOV - Correct. SR-IOV stands for Single Root I/O Virtualization. It is a virtualization specification that allows a PCIe device to appear to be multiple separate physical PCIe devices. Do not use SR/IOV. + Correct. SR-IOV stands for Single Root I/O Virtualization. It is a virtualization specification for a PCIe device to appear to be multiple separate physical PCIe devices. Do not use SR/IOV. @@ -523,7 +554,7 @@ a programming and technical sense this also means "Run the sourceSSH - Initialism for Secure Shell, a network protocol that allows data exchange using a secure channel. When referring to the protocol, do not use "ssh," "Ssh," or other variants. When referring to the command, use ssh. + Initialism for Secure Shell, a network protocol for data exchange with a secure channel. When referring to the protocol, do not use "ssh," "Ssh," or other variants. When referring to the command, use ssh. Do not use as a verb. @@ -546,7 +577,7 @@ a programming and technical sense this also means "Run the sourceSSL - Initialism for Secure Sockets Layer, a protocol developed by Netscape for transmitting private documents over the internet. SSL uses a public key to encrypt data that is transferred over the SSL connection. The majority of web browsers support SSL, and many websites use the protocol to obtain confidential user information, such as credit card numbers. By convention, URLs that require an SSL connection start with https: instead of http:. + Initialism for Secure Sockets Layer, a protocol developed by Netscape for transmitting private documents over the internet. SSL uses a public key to encrypt data that is transferred over the SSL connection. Most web browsers support SSL, and many websites use the protocol to obtain confidential user information, such as credit card numbers. By convention, URLs that require an SSL connection start with https: instead of http:. @@ -556,10 +587,13 @@ a programming and technical sense this also means "Run the sourcestand-alone - adj. Correct. Do not use "standalone." + adj. Write hyphenated. Do not use "standalone." - Refers to something that is self-contained, or that does not require any other devices to function. For example, a fax machine is a stand-alone device because it does not require a computer, printer, modem, or other device. A printer, on the other hand, is not a stand-alone device because it requires a computer to feed it data. + Refers to something that is self-contained, or that does not require any other devices to function. + + For example, a smartphone is a stand-alone device because it does not require a computer, printer, modem, or other device. + A printer, on the other hand, is not a stand-alone device because it requires a computer to feed it data. @@ -571,6 +605,7 @@ a programming and technical sense this also means "Run the source A legacy Linux desktop suite. Do not use "Star," "Staroffice," or "Star Office." + The successors of StarOffice are and . @@ -578,11 +613,11 @@ a programming and technical sense this also means "Run the source - - starts up + + start up - Do not use. Instead, use "activates" or "invokes." + v. Do not use. Instead, use "activate" or "invoke." @@ -622,7 +657,8 @@ a programming and technical sense this also means "Run the sourcesubcommand - Correct. Do not use "sub-command" or "verb." A subcommand refers to a secondary or even tertiary command used with a primary command. Not to be confused with options or arguments, subcommands operate on ever more focused objects or entities. For example: + Correct. Do not use "sub-command" or refer to a subcommand as a "verb." + A subcommand refers to a secondary or even a tertiary command that is used with a primary command. Not to be confused with options or arguments, subcommands operate on ever more focused objects or entities. For example: hammer import organization --help @@ -669,7 +705,7 @@ a programming and technical sense this also means "Run the source - NB: subpackages are not the same as dependencies and should not be treated as such. + Note: Subpackages are not the same as dependencies and should not be treated as such. @@ -679,7 +715,7 @@ a programming and technical sense this also means "Run the sourcesuperuser - A synonym for the root user. More common in Solaris documentation than Linux. If and when used, this is the correct spelling. Do not use "super user" or "super-user." + A synonym for the root user. More common in Solaris documentation than Linux. If and when used, this spelling is correct. Do not use "super user" or "super-user." @@ -722,7 +758,7 @@ a programming and technical sense this also means "Run the sourcesymmetric encryption - A type of encryption where the same key is used to encrypt and decrypt the message. This differs from asymmetric (or public-key) encryption, which uses one key to encrypt a message and another to decrypt the message. + A type of encryption where the same key is used to encrypt and to decrypt the message. It differs from asymmetric (or public-key) encryption, which uses one key to encrypt a message and another to decrypt the message. diff --git a/en-US/Slang.xml b/en-US/Slang.xml deleted file mode 100644 index f4ec60b..0000000 --- a/en-US/Slang.xml +++ /dev/null @@ -1,876 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - Avoiding Jargon, Slang, Metaphors, and Misleading Language - - Red Hat produces documentation for a global audience, and in many cases this documentation is translated into many languages. To reach the widest possible audience, and to make the task of translation as straightforward as possible, avoid slang and other culture-specific terminology. This section attempts to identify commonly used slang terms and phraseology, and to provide alternatives. - - - If you find slang terms or other difficult-to-understand passages in our documentation, use this page to search for alternatives. - -
- Avoiding Misleading or Confusing Language - - Some terms, phrases, and general language can be confusing if you are not a native speaker or if the phraseology has regional significance. Sometimes spelling changes are introduced over time and regions, based purely on differences in pronunciation. Some phrases can carry hidden or unintentional meanings. This section attempts to introduce a few examples. - - - - best practices - - - This is a commonly understood phrase, and despite some concerns about using superlatives without statistics to back them up, Red Hat does not actively discourage its use. It is also a more common search term than most alternatives. If you are in any doubt, the preferred alternative is "recommended practices." - - - See the section for additional information about recommendations in Red Hat documentation. - - - - - - first come, first served - - - Indicates that customers will be attended to in the order that they arrive. The phrase abbreviates the sentence "The first to come is the first to be served," so use "served" instead of "serve" to keep the verb function the same. This phrase is an idiom, so avoid using it when content will be translated. When you use this phrase as an adjective, it is hyphenated as follows: Admittance is on a first-come, first-served basis. - - - - - - - - -
-
- Identifying and Avoiding Slang - - Examples of slang terms: - - - - administrivia - - - Not a word. Do not use. - - - - - - - anything you/they like - - - This is probably readily understood but should not appear in Red Hat documentation. - - - - - "They can also use the slapi_register_plugin() call to register any kind of plug-in they like." - - - Rephrase to something more suitable, such as "...to register any other kind of plug-in." - - - - - - - - - - - - ask (as a noun), make the ask - - - Ask is a verb. Do not use it as a noun. - - - - - - - at this point in time - - - Do not use. In most cases, use "now." In some cases it is acceptable to use "at this point," for example, when you have reached a specific point in a procedure. - - - - - - - automagic - - - Also, automagical. Both terms are slang. Do not use. - - - - - - - best-of-breed - - - Jargon. Say exactly what you mean, for example, "the best product in its class" or "the best product of its type." Other alternatives include best, foremost, most advanced, optimum. The category is usually implied. Be wary of using superlatives without data to back up any claims. - - - - - - - bleeding edge - - - Do not use. - - - - - - - bottom line - - - Traditionally used in financial contexts; avoid overuse. - - - - - - - - bucketize - - - Not a word. Try "categorize" or "organize into logical groups." - - - - - - - center of competency - - - Do not use. - - - - - - - check this site - - - Understood to mean "have a look at this website." The preferred phraseology is "See www.somewhere.com for more information." It is better to avoid "check" because it has so many meanings. - - - - - - - coopetition - - - Not a word. Do not use. - - - - - - - core competency - - - Jargon, cold and impersonal. Better choices include "specialization," "skill," "strength," "expertise," etc. The De-Jargonator says: "'Competent' means 'adequate but not exceptional.' Why would you describe what you do best as 'competence'? Try instead: What your organization does best; competitive advantage; special or unique expertise or ability; specialty." - - - - - - - eat your own dogfood - - - Developer-speak. It means to use your own products. You can get a detailed description at http://en.wikipedia.org/wiki/Eat_one%27s_own_dog_food. - - - - - - - data point - - - Do not use. - - - - - - - dig deeper, delve deeper - - - "Visit the following web link to dig deeper into [subject]..." Using "dig deeper" may translate awkwardly. Consider rewording: "For detailed information regarding [subject], see [link]." - - - - - - - double-edged sword, double-bladed sword - - - If something is described as a double-edged sword, it indicates that it has two opposing behaviors or consequences. Instead, state that it can have unexpected consequences, or that the positive result might be offset by the negative result. - - - - - - - enterprise-ready - - - Although we used to use this term to emphasize our products' enterprise readiness, it is not as necessary now, especially when talking about a product with "Enterprise" in its name, unless you're calling this out as a key selling point. - - - - - - - exceed your expectations - - - Vague. Clarify with specifics, for example, "The movie made more money on the opening weekend than anyone expected." instead of "The movie exceeded our expectations." - - - - - - - fib - - - A fib is a "small lie," also known as a "white lie." This appeared in one of the GLS books: "this command tells fibs." Use something like "The output of this command can be misleading." - - - - - - - flying by the seat of your pants - - - Generally understood to mean "reacting to events as they occur." Difficult to offer alternatives without context. - - - - - - - frame it up - - - Do not use. - - - - - - - frown upon - - - "To frown upon" means to hold in low regard, not to approve of, etc. This appeared in the Seam guide: "...we generally frown on the use of session context...". This translates to (and should have been written as) "...the use of session context is not recommended..." (or words to that effect). - - - - - - - fuzzy (search) - - - Even though "fuzzy" is slang, it is common when referring to searches, especially in databases. This example came from the Directory Server documentation: - - - - - In Directory Server, if you do a fuzzy search for "Smith" you will probably also get "Smyth," because it sounds the same. - - - - - - - The use of "fuzzy" is valid in this context. - - - Note the difference between this and "wildcard" searches: "Sm?th" could return "Smith," "Smyth," "Smeth," or even "Smrth." - - - Do not use "fuzzy" to describe something that is not clear, such as an image, a concept, an idea, and so on. For example, "He was a bit fuzzy on the details" is not valid. - - - - - - - going-forward basis - - - Jargon. Say "from now on," "in the future," or something similar. - - - - - - - happy path - - - Do not use. Often understood to mean "a path or method of least resistance" or "the preferred way to solve the current issue", this is very localized slang and could easily be misunderstood. It could also produce problems for translation. - - - - - - - harness the power - - - Do not use. - - - - - - - have a crack at/jump right in - - - Have a crack at and jump right in are closely related in meaning as they imply to "get started or give it a try." Alternatives to these are "start," "try," and "begin," and will depend on the context of what is being discussed. - - - - - - - if you want, if you wish - - - Do not use. For example, instead of saying "If you want to perform an action,..." say "To perform an action,..." - - - - - - - in concert with - - - Do not use. Instead, say "with." For example, change "Use gcov in concert with GCC to analyze..." to "Use gcov with GNU CC to analyze..." - - - - - - - improve, enhance - - - Vague. Try to be more specific. - - - - - - - in a pinch - - - Under a tight schedule, hard pressed to achieve something. - - - - - - - infomediary - - - Not a word. Do not use. - - - - - - - is designed to - - - Avoid this and similar phrases when describing products and services. Instead, state what the product does. - - - - - Incorrect: SSH is designed to work with almost any kind of public key algorithm or encoding format. - - - - - - Correct: SSH works with almost any kind of public key algorithm or encoding format. - - - - - - - - - - - kettle of fish - - - Commonly used in the expression "a different kettle of fish," meaning "that's a different matter (altogether)." Depending on the context, try to use "topic," "subject," "matter," or something similar. - - - - - - - leverage - - - Avoid. Alternatives include "use" and "take advantage of". - - - - - - - lights on, lights-on - - - Avoid using this term, because 1) it is jargon, 2) not everyone knows what it means, and 3) the meaning could be lost or confused in translation to other languages. - - - Typically used to mean maintaining the status quo or just doing what is required to keep things up and running (versus being proactive and innovative). For example, "A cloud can deliver strategic advantages to the business by redirecting resources from lights-on to innovation." - - - - - - - low-hanging fruit - - - Metaphor. Do not use. - - - - - - - marketecture - - - Not a word. Do not use. - - - - - - - meet your needs - - - Vague. Try to be more specific, for example, "lower your middleware costs." - - - - - - - mission-critical - - - Overused and jargony. Unless the topic is actually critical to a mission, use a factual term or phrase, for example, "Make sure you have the applications you need to help your customers." vs. "Make sure you have the mission-critical applications your customers demand." - - - - - - - net-net - - - Jargon. Use "in summary," "the end result," or something similar. - - - - - - - niche focus - - - Do not use. - - - - - - - over the wire - - - Commonly used in expressions such as "password information is sent in plain text over the wire," meaning "sent unencrypted through the transmission medium" (whether it is a wired or wireless network, the internet, or whatever). The phrase is probably not required at all. "Sent/transmitted in plain text" is fine. - - - - - - - pain in the backside - - - Nobody should ever write this or anything like it in any Red Hat documentation. Most people should know what it means. Use "problematic," "difficult," or something similar. - - - - - - - paradigm - - - Avoid. Use "model," "standard," or something similar. - - - - - - - performant - - - In the technical industry context, it means "performs as expected" or "well-performing." It is not necessarily a word everyone knows (and technically, it means "a performer," as in a play, according to most dictionaries), so use an alternative if possible. - - - - - - - physicalize - - - Not a word. Do not use. - - - - - - - piggyback - - - Slang. Do not use. - - - - - - - pre-baked - - - Means "prepared beforehand." Choose a suitable alternative, such as "preconfigured," depending on the context. - - - - - productize - - - Not a word. Find another way to say "modify something to become suitable as a commercial product." [wiktionary] - - - - - - - ready to rumble - - - "Let's get ready to rumble!" is a trademarked catchphrase used to introduce televised boxing or wrestling events. In US English slang, being "ready to rumble" means you are "ready to go ahead" or "ready to start." - - - - - - - rest on your laurels - - - Do not use. - - - - - - - right before doing something - - - Preferred phrase would be "immediately before doing something." Otherwise, write around the phrase. - - - - - - - root your server in the /serverRoot directory - - - This is not very elegant. Be aware of the multiple meanings of words. Try something like "Use the /serverRoot directory as the root directory for your server." This example came from the Directory Server documentation, but it could apply to Web Servers or any other type of server. - - - - - - - shoot yourself in the foot - - - To "shoot yourself in the foot" indicates that you have done something to harm your own cause, or acting against your own best interests. Remove the sentence - it should be self-evident from the surrounding information. (Found this statement alongside the "double-edged sword" comment with an added note about "preserving all your toes.") - - - - - - - shy of - - - Apart from the "normal" meaning of shy, it is also found in such phrases as "he was just shy of the mark," meaning that he didn't quite succeed. Also, to be "a few items shy of what's required" means to have less than the minimum number required. Avoid this terminology and use more easily understood terms; it will help our translators and also those reading our English documentation who are unfamiliar with such slang. - - - - - - - silo, siloed - - - Useful in farming, but in business it is jargon. Use "stand-alone," "confined," "separated," "segregated," or something similar. - - - - - - - solutioning - - - Not a word. Lazy version of "creating a solution." - - - - - - - solutions-based - - - Do not use. - - - - - - - solution stack - - - Do not use. - - - - - - - - stovepipe - - - Jargon. In business, related to lack of cross-organizational communication, similar to "silo." - - - - - - - synergistic, synergy - - - Jargon. Use "cooperative," "working together," "collaborative," "harmonious," or something similar. - - - - - - - synergical connectivity - - - Seriously? - - - - - - - to think outside the box - - - 1990 called and wants its jargon back. How about "(think) creatively" or "(think) unconventionally"? - - - - - - - tunnel vision - - - Do not use. - - - - - - - under the covers - - - This refers to something being out of plain sight or not immediately obvious. For example, you might only see the results of some action or command, but what happens "under the covers" is what is going on in the background, that you can't see or are not aware of, to make that action of command possible. - - - - - - - value-added - - - Jargon. Say "added value" or "valuable." Or be more specific, for example, "adds value by improving productivity." - - - - - - - very - - - Use with caution. For example, there is little value in saying "very cost-effective" vs. "cost-effective." - - - - - - - virtual elephants - - - This refers to a group of blind-folded people all touching different parts of an elephant and trying to describe what it is. Nobody sees the "big picture." Curiously, it appeared in an STC article about working in global and virtual teams and using effective communication. It falls into the same category as "skeletons in the closet," "dark horse," "black sheep," and so on. Use descriptions and adjectives that are not specific to a particular culture or locale. See http://en.wikipedia.org/wiki/Blind_Men-anElephant for more information. - - - - - - - - -
-
- Neologisms (Invented Words) - - The English language is full of these. Some of them are useful, some of them are less so, others are just painful, difficult to translate, and should be avoided. Many of them are the result of creating nouns from verbs, verbs from nouns, and adjectives from just about anything. Unless a particular word has been in use for some time and has been generally accepted into common English, try to avoid these neologisms. If necessary, reword or restructure your sentences. - - - Examples - - - "This feature allows synchronization of adds, deletes, and changes ..." - - - - - This sentence has converted three verbs to nouns. A better structure might be, "This feature allows the synchronization of add, delete, and change operations..." - - - - - - - - - - -
-
- Anthropomorphism - - Anthropomorphism is applying human qualities to non-human things or animals. Avoid this in your writing. - - - Examples - - - The computer will think for a brief period. - - - - - Computers do not actually think but they might take a while to "process" commands. - - - - - - - - - - The Proxy Server is talking to either RHN Hosted or a Satellite Server. - - - - - It is quite common to say "talk to" in this context, but "communicate with," "connected to," "registered with," or something similar would be better. - - - - - - - - - - - Report an issue - - -
- - diff --git a/en-US/Style_Conventions_for_Writers_and_Editors.ent b/en-US/Style_Conventions_for_Writers_and_Editors.ent new file mode 100644 index 0000000..87f791a --- /dev/null +++ b/en-US/Style_Conventions_for_Writers_and_Editors.ent @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/en-US/Style_Conventions_for_Writers_and_Editors.xml b/en-US/Style_Conventions_for_Writers_and_Editors.xml new file mode 100644 index 0000000..d8ebb90 --- /dev/null +++ b/en-US/Style_Conventions_for_Writers_and_Editors.xml @@ -0,0 +1,65 @@ + + +%BOOK_ENTITIES; +]> + + + + + Writing Style Guide + + + Recommended design practices, how to write for translation, common mistakes to avoid, rules for everyday punctuation, grammar, and sources of information for the less common cases. + + + + + + + + + + + + + + Usage Dictionary + + + The Usage Dictionary provides guidelines for the correct use of common terms in Red Hat documentation, which terms to avoid, and the preferred spelling if variations exist. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/en-US/T.xml b/en-US/T.xml index 694d402..f255be0 100644 --- a/en-US/T.xml +++ b/en-US/T.xml @@ -20,7 +20,7 @@ tar, tarball - n. See the Word Usage appendix of The IBM Style Guide. + n. See the Word Usage chapter of the IBM Style Guide. @@ -59,17 +59,10 @@ - - - telephone numbers - - - Use spaces, not dashes or dots, to punctuate phone numbers. When indicating a number for international use, include the country code (+1 555 555 5555 for a US number, for example). US 800 numbers are not accessible from outside the country, so do not precede them with a country code (800 555 5555). Phone numbers beginning with 0 are not for international use. Make these numbers ready for international by dropping the zero and adding the appropriate country code. For example, (055) 12345 would be for use in Italy only; change it to +39 (55) 12345 for international use. - + - + - terminal @@ -77,7 +70,7 @@ n. Do not use to describe where to type commands. Use "command line" instead. - See the Word Usage appendix of The IBM Style Guide for more information. + See the Word Usage chapter of the IBM Style Guide for more information. @@ -87,30 +80,30 @@ terminal emulation - Refers to making a computer respond like a particular type of terminal. Terminal emulation programs allow you to access a mainframe computer or bulletin board service with a personal computer. + Refers to making a computer respond like a particular type of terminal. With a terminal emulation program, you can access a mainframe computer or bulletin board service with a personal computer. - - text mode + + text-based - Correct. Do not use "textmode" or "text-mode." - - - A video mode in which a display screen is divided into rows and columns of boxes. Each box can contain one character. Text mode is also called character mode. + adj. Correct. Do not use "text based." - - text-based + + text mode - adj. Correct. Do not use "text based." + Correct. Do not use "textmode" or "text-mode." + + + A video mode in which a display screen is divided into rows and columns of boxes. Each box can contain one character. Text mode is also called character mode. @@ -140,7 +133,7 @@ throughput - n. The amount of data transferred from one place to another or processed in a specified amount of time. Data transfer rates for disk drives and networks are measured in terms of throughput. Typically, throughput is measured in kbps, Mbps, or Gbps. See The IBM Style Guide for more information about using measurements and abbreviations. + n. The amount of data that is transferred from one place to another or processed in a specified amount of time. Data transfer rates for disk drives and networks are measured in terms of throughput. Typically, throughput is measured in kbps, Mbps, or Gbps. See the IBM Style Guide for more information about using measurements and abbreviations. @@ -156,6 +149,7 @@ + time frame (n.) @@ -177,10 +171,11 @@ - token ring (n.) + token-ring (n.) - When capitalized, Token Ring refers to the PC network architecture developed by IBM. The IBM Token-Ring specification has been standardized by the IEEE as the IEEE 802.5 standard. See The IBM Style Guide for further uses of this term. + When capitalized, Token-Ring refers to the PC network architecture that IBM developed. The IBM Token-Ring specification is standardized by the IEEE as the IEEE 802.5 standard. + diff --git a/en-US/Translation.xml b/en-US/Translation.xml index c0cfaa1..7800861 100644 --- a/en-US/Translation.xml +++ b/en-US/Translation.xml @@ -6,19 +6,19 @@ Writing Clearly and Succinctly - This chapter provides guidelines, tips, and techniques to help make your writing easier to read and understand, and also to translate. + This chapter provides guidelines, tips, and techniques to help to make your writing easier to read and understand, and also to translate.
Sentence Structure - This section helps to describe how to construct your content for clarity and readability. + This section describes how to construct your content for clarity and readability. A full discussion of this topic is beyond the scope of this guide. - +
Using and Formatting Lists - Lists appear in a range of formats, such as series, ordered, unordered (itemized), and so on. Avoid using itemized lists to format a single sentence. Some translation tools display list items and the introductory sentence (or sentence stem) as individual sentences for translation. If these are not complete sentences, they can be difficult to translate. + Lists appear in a range of formats, such as series, ordered, unordered (itemized), and so on. Avoid using itemized lists to format a single sentence. Some translation tools display list items and the introductory sentence (or sentence stem) as individual sentences for translation. If they are not complete sentences, they can be difficult to translate. The following general guidelines apply to lists: @@ -28,8 +28,8 @@ Itemized lists - These appear as a bulleted list. - Use this list type for three or more entries where order is not important, or in a demonstration section when students are encouraged to not perform steps but to watch the instructor instead. + They appear as a bulleted list. + Use this list type for three or more entries where order is not important, or in a demonstration section when students are encouraged not to perform steps but to watch the instructor instead. Titles are optional. @@ -38,9 +38,9 @@ Ordered lists - These appear as a numbered list. + They appear as a numbered list. Use this list type for multiple entries if you need to refer to one of the entries from elsewhere in your document, or where order is important. - For example, if you need to list the order of operations required to prepare for an installation, or list a sequence of events that occurs. + For example, if you need to list the order of operations that are required to prepare for an installation, or list a sequence of events that occurs. Titles are optional. @@ -49,12 +49,12 @@ Variable lists - These appear as a list of terms followed by definitions. + They appear as a list of terms followed by definitions. Use this list type to list and describe a series of terms, such as variables, command options or arguments, and similar items. Titles are optional. (This list is written as a variable list.) A variable list is often preferable to a table, because tables have the additional overhead of calculating column width for every translation. - Tables are best reserved for information that relies upon, or benefits greatly from, a grid layout. + Tables are best reserved for information that relies on, or benefits greatly from, a grid layout. @@ -62,8 +62,8 @@ Procedures - These appear as a list of numbered steps. - Procedures always include a title, and are used to list the steps required to achieve a task. + They appear as a list of numbered steps. + Procedures always include a title, and are used to list the required steps to achieve a task. @@ -71,23 +71,25 @@ You can nest lists, but try to keep the number of levels to two or fewer. To nest procedures in DocBook, use <substep> elements. +
Formatting Lists for Readability It is important to provide sufficient spacing between elements in your documents to facilitate reading and comprehension. You can include a lot of information in a few short paragraphs but readers need to be able to process that information in chunks. - The same applies to lists. + The same consideration applies to lists. If you use DocBook to build itemized, ordered, or variable (definition) lists, you can use the or attributes to specify the spacing between list items. DocBook uses the spacing attribute by default. + - Use a list with normal spacing if any list item contains the following: + Use a list with normal spacing if any list item contains the following components: Nested lists. - Note that nested lists themselves can use the attribute if they fall outside the bounds of these recommendations. + Nested lists themselves can use the attribute if they fall outside the bounds of these recommendations. @@ -106,13 +108,13 @@ - The use of all but very simple graphics in lists is strongly discouraged. + The use of all but the simplest graphics in lists is strongly discouraged. - + - The following discussion provides some initial insight into using lists correctly. See The IBM Style Guide for a full discussion. + The following discussion provides some initial insight into using lists correctly. See the IBM Style Guide for a full discussion. @@ -130,7 +132,7 @@ - Before you start the installation, make sure you have + Before you start the installation, ensure that you have @@ -157,7 +159,7 @@ - Ensure you have enough free storage on your system. + Ensure that you have enough free storage on your system. @@ -180,11 +182,11 @@
- +
Noun Stacking - Modifier strings (modifier + noun + noun sentence format), over-modified nouns (or noun stacks), are especially difficult to translate, particularly when several different combinations could make sense. + Modifier strings (modifier + noun + noun sentence format) and over-modified nouns (or noun stacks) are especially difficult to translate, particularly when several different combinations might make sense. @@ -207,8 +209,8 @@ - Set default printer configuration parameters for new users. Enter the maximum length of time that you want to keep the automatic synchronization address list updates in days and press ENTER. - For new users, set the parameters to the default printer configuration. Enter the maximum length of time, in number of days, that you want to keep the address lists updated by automatic synchronization. Then press ENTER. + Set default printer configuration parameters for new users. Enter the maximum length of time that you want to keep the automatic synchronization address list updates in days and press Enter. + For new users, set the parameters to the default printer configuration. Enter the maximum length of time, in number of days, that you want to keep the address lists updated by automatic synchronization. Then, press Enter. @@ -223,10 +225,10 @@
Grammatical Genders - When using ambiguous pronouns such as "they" or "it" it is not always clear what they refer to. For languages that have different genders for nouns, it is important to know exactly what each pronoun refers to. For example, the word "it" can be translated in several different ways and may require other grammatical adjustments. + When using ambiguous pronouns such as "they" or "it", it is not always clear what they refer to. For languages that have different genders for nouns, it is important to know exactly what each pronoun refers to. For example, the word "it" can be translated in several different ways and might require other grammatical adjustments. - Further, an initialism such as RPM might refer to the package or the package manager. In German, manager is a masculine noun, and so RPM requires the masculine article "der" when it refers to the RPM Package Manager. Package is a neuter noun, and requires the neuter article "das" when it refers to an RPM package. + Further, an initialism such as RPM might refer to the package or to the package manager. In German, manager is a masculine noun, and so RPM requires the masculine article "der" when it refers to the RPM Package Manager. Package is a neuter noun, and requires the neuter article "das" when it refers to an RPM package.
@@ -243,13 +245,14 @@ - Set the parameter XYZ to 1 in the configuration file /etc/config.conf. It configures the way the Gateway application handles incoming network traffic. - Set the XYZ parameter to 1 in the configuration /etc/config.conf file. This parameter configures how the Gateway application handles incoming network traffic. + Set the parameter XYZ to 1 in the configuration file /etc/config.conf. It configures the way the Gateway application handles incoming network traffic. + Set the XYZ parameter to 1 in the /etc/config.conf configuration file. This parameter configures how the Gateway application handles incoming network traffic. The RPM is useful. The RPM package is useful. OR The RPM Package Manager is useful. + @@ -261,18 +264,16 @@
- DocBook Elements + Using Markup Correctly + + If you use a markup language to write your content, make the most of the available tagging options. + Many terms are not translatable, and should not be used as structural parts of a sentence. + - Use the correct DocBook elements to help translators understand the meaning of and to identify translatable and non-translatable terms. + Correctly marking up terms can help translators to understand the meaning of, and to identify, translatable and non-translatable terms. - - - Tagged Terms in Sentences - - Many tagged terms are not translatable, and so they should not be used as structural parts of a sentence. Otherwise, translators have to fill in the blanks or tag terms themselves. - - +
@@ -313,15 +314,21 @@
+ + + This guide does not try to cover the many ways that you can use markup languages to write content. + Many online resources exist for these languages. + +
Code Blocks - Avoid including commentary within the same box as command input or output. These might be confused with part of the output, and during translation might be accidentally overlooked and left in English. + Avoid including commentary within the same box as command input or output. These comments might be confused with part of the output, and during translation might be accidentally overlooked and left in English. - For example, consider the word "Usage" in the following: + For example, consider the word "Usage" in the following block: Usage: rhevm-iso-uploader [options] list @@ -336,11 +343,12 @@ . Entities are called by reference, and take the form &name; (both the ampersand and the semicolon are required). + - Entities can be helpful in some cases, but they are more of a hindrance when used for terms that need translation. Translators need to compare the string with the built document to determine what the entity stands for. These entities might even be overlooked and not translated at all. + Entities can be helpful in some cases, but they are more of a hindrance when used for terms that need translation. Translators must compare the string with the built document to determine what the entity stands for. These entities might even be overlooked and not be translated at all. - To avoid issues with incorrect or outdated entity values, problems with translation, and so on, only include the entities required to actually build your books. If you use Publican () to create and maintain your documentation, it creates and populates the required entities with default values when you create a book. Required entities vary by brand, but only the following are required for a standard book: + To avoid issues with incorrect or outdated entity values, problems with translation, and so on, only include the entities that are required to build your books. If you use Publican () to create and maintain your documentation, it creates and populates the required entities with default values when you create a book. Required entities vary by brand; only the following entities are required for a standard book: @@ -370,7 +378,7 @@ - Do not include entities such as &PRODNAME; or &VERSION; and so on, or things like &BIBLE; to represent "The St. James Bible". To learn more about entities, see the relevant chapter in + Do not include entities such as &PRODNAME; or &VERSION; and so on, or things like &BIBLE; to represent "The King James Bible". To learn more about entities, see the relevant chapter in
diff --git a/en-US/U.xml b/en-US/U.xml index 2173e15..5a8c1be 100644 --- a/en-US/U.xml +++ b/en-US/U.xml @@ -23,7 +23,7 @@ Correct. Do not use "ULTRASPARC," "UltraSparc," or other variations. - UltraSPARC is a trademark of SPARC International, Inc., and is used under license by Sun Microsystems, Inc. Products bearing the SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc. + UltraSPARC is a trademark of SPARC International, Inc., and is used under license by Sun Microsystems, Inc. Products that bear the SPARC trademarks are based on an architecture developed by Sun Microsystems, Inc. @@ -33,7 +33,7 @@ undercloud - n. Always lowercase. This is a concept, not a technology or product name. Being a common noun, this requires an article in most cases. See also . + n. Always lowercase. It is a concept, not a technology or product name. Being a common noun, it requires an article in most cases. See also . @@ -69,13 +69,13 @@ unset - Incorrect. Use "Clear" instead. + Incorrect. Use "Clear" instead, to refer to removing a selection from a check box. To disable the Wobbly Widget application, clear the Enable Wobbly Widget check box. - This rule only matches TCP packets that have the SYN flag set and the ACK flag cleared. + This rule matches only TCP packets where the SYN flag is set and the ACK flag is cleared. @@ -164,15 +164,15 @@ - + user - n. When referring to the reader, use "you" instead of "user." For example, "The user must..." is incorrect. Use "You must..." instead. + n. When referring to the reader, use "you" instead of "the user." For example, "The user must..." is incorrect. Use "You must..." instead. - If referring to more than one user, calling the collection "users" is acceptable, such as "Other users may want to access your database." + If referring to more than one user, calling the collection "users" is acceptable, such as "Other users might want to access your database." @@ -185,17 +185,19 @@ n. Correct. Do not use "user-interface" or "userinterface." - The junction between a user and a computer program. An interface is a set of commands or menus through which a user communicates with a program. A command-driven interface is one in which you enter commands. A menu-driven interface is one in which you select command choices from various menus displayed on the screen. + The junction between a user and a computer program. An interface is a set of commands or menus through which a user communicates with a program. In a command-driven interface, you enter commands. In a menu-driven interface, you select command choices from various menus that are displayed on the screen. - user name + username - n. Correct. Do not use "username" unless you are using it as a variable. + n. One word in most cases. + Capitalize the "U" at the beginning of a sentence. + See the IBM Style Guide for more information. diff --git a/en-US/V.xml b/en-US/V.xml index 8fef600..f10df65 100644 --- a/en-US/V.xml +++ b/en-US/V.xml @@ -20,7 +20,7 @@ VDSM - Initialism for Virtual Desktop Server Management. DO NOT spell out this initialism. Using the term "virtual desktop" in this context has negative marketing implications. Use VDSM without expansion. + Initialism for Virtual Desktop Server Management. Do not spell out this initialism. Using the term "virtual desktop" in this context has negative marketing implications. Use VDSM without expansion. @@ -36,29 +36,29 @@ - - Vim + + video mode - Correct when referring to the application. - Do not use "VIM" (all caps). - Only use "vim" (all lowercase) when referring to the command to start the application. + Correct. Do not use "video-mode" or "videomode." - Vim is an acronym, derived from Vi IMproved. (In the original 1991 release for the Amiga platform, the acronym was derived from Vi IMitation. It became Vi IMproved when ported to various UNIX-based operating systems in 1992.) Despite being an acronym, and despite the first word of the "About" text that appears when you start the editor, the standard, proper noun-derived, mixed-case spelling has been in use since its release on the Amiga. + The setting of a video adapter. Most video adapters can run in either text mode or graphics mode. In text mode, a monitor can display only ASCII characters. In graphics mode, a monitor can display any bit-mapped image. In addition to the text and graphics modes, video adapters offer different modes of resolution and color depth. - - video mode + + Vim - Correct. Do not use "video-mode" or "videomode." + Correct when referring to the application. + Do not use "VIM" (all caps). + Only use "vim" (all lowercase) when referring to the command to start the application. - The setting of a video adapter. Most video adapters can run in either text mode or graphics mode. In text mode, a monitor can display only ASCII characters. In graphics mode, a monitor can display any bit-mapped image. In addition to the text and graphics modes, video adapters offer different modes of resolution and color depth. + Vim is an acronym, derived from Vi IMproved. (In the original 1991 release for the Amiga platform, the acronym was derived from Vi IMitation. It became Vi IMproved when ported to various UNIX-based operating systems in 1992.) Despite being an acronym, and despite the first word of the "About" text that appears when you start the editor, the standard, proper noun-derived, mixed-case spelling has been in use since its release on the Amiga. @@ -71,33 +71,33 @@ Correct. Do not use "virtual-console" or "Virtual Console" for general use. - This can be abbreviated to "VC" as long as the term has been introduced in the same content in its full version first, such as "A virtual console (VC) is a shell prompt in a non-graphical environment. Multiple VCs can be accessed simultaneously." + It can be abbreviated to "VC" provided that the term is first introduced in the same content in its full version, such as "A virtual console (VC) is a shell prompt in a non-graphical environment. Multiple VCs can be accessed simultaneously." - - virtual machine, VM + + virtualized guest - Refers to virtual hardware that consists of virtual CPUs, memory, devices, and so on. Do not use "guest virtual machine" unless you want to specifically emphasize the fact that it is a guest. + The term "virtualized guest" should be used only when comparing a "fully virtualized guest" with a "paravirtualized guest." - This can be abbreviated to "VM" as long as the term has been introduced in the same content in its full version first, and provided there is no possibility of confusion with other terms, such as "virtual memory." Author discretion is recommended. + See also "guest operating system." - - virtualized guest + + virtual machine, VM - The term "virtualized guest" should be used only when comparing a "fully virtualized guest" with a "paravirtualized guest." + Refers to virtual hardware that consists of virtual CPUs, memory, devices, and so on. Do not use "guest virtual machine" except for specific emphasis that it is a guest. - See also "guest operating system." + It can be abbreviated to "VM" provided that the term is first introduced in the same content in its full version, and without any possible confusion with other terms, such as "virtual memory." Author discretion is recommended. @@ -127,7 +127,7 @@ VPN - Initialism for virtual private network, a network that is constructed by using public wires to connect nodes. For example, there are a number of systems that enable you to create networks using the internet as the medium for transporting data. These systems use encryption and other security mechanisms to ensure that only authorized users can access the network and that the data cannot be intercepted. + Initialism for virtual private network, a network that uses public wires to connect nodes. For example, various systems can create networks with the internet as the medium for transporting data. These systems use encryption and other security mechanisms to ensure that only authorized users can access the network and that the data cannot be intercepted. diff --git a/en-US/W.xml b/en-US/W.xml index 8a9d5d3..99d767b 100644 --- a/en-US/W.xml +++ b/en-US/W.xml @@ -21,19 +21,6 @@ - - - WCA - - - An abbreviation of "web clipping application," an application that allows users to extract static information from a web server and load that data onto a web-enabled PDA. - - - WCAs are also called "query applications." - - - - want @@ -41,19 +28,20 @@ Use instead of "wish" or "would like." Rephrase to avoid whenever possible. - For example, "If you want to use the debugger..." can be rewritten as "To use the debugger..." + For example, "If you want to use the debugger, ..." can be rewritten as "To use the debugger, ..." - - we suggest + + WCA - Do not use. - Use a more direct construction, or use "recommend." - For example, instead of "We suggest that you make a backup of your data disk," write "Back up your data disk." + An abbreviation of "web clipping application," to extract static information from a web server and load that data onto a web-enabled personal digital assistant (PDA). + + + WCAs are also called "query applications." @@ -70,6 +58,16 @@ + + + web page + + + n. Two words. Capitalize the "W" at the beginning of a sentence. If part of a proper noun, capitalize accordingly. + + + + web UI @@ -82,15 +80,40 @@ + + we suggest + + + Do not use. + Use a more direct construction, or use "recommend." + For example, instead of "We suggest that you make a backup of your data disk," write "Back up your data disk." + + + + + + + + whitelist + + + Do not use. Use "allowlist". + + + Do not use the terms "white" or "black" in a context where white is represented as good or black is represented as bad. Such usage reinforces a model that promotes racial bias. + + + + - who/whom + who, whom Use the pronoun "who" as a subject. Use the pronoun "whom" as a direct object, an indirect object, or the object of a preposition. - For example: Who owns this? To whom does this belong? + For example: Who owns this phone? To whom does this phone belong? @@ -99,6 +122,7 @@ will + Do not use future tense unless it is absolutely necessary. For example, do not write "The next section will describe the process in detail." @@ -113,12 +137,23 @@ Correct. Do not combine into one word or hyphenate. - This is a window manager for the "X Window System." + This is a window manager for the X Window System. + + + wish + + + Use "want" instead of "wish" when the reader's actions are optional (that is, they might not "need" something but might still "want" something). + + + + + diff --git a/en-US/WUG_References.xml b/en-US/WUG_References.xml index 104b229..364183d 100644 --- a/en-US/WUG_References.xml +++ b/en-US/WUG_References.xml @@ -6,7 +6,7 @@ References - The IBM Style Guide + the IBM Style Guide Chicago Manual of Style, 17th Edition diff --git a/en-US/XYZ.xml b/en-US/XYZ.xml index 9bce184..d560434 100644 --- a/en-US/XYZ.xml +++ b/en-US/XYZ.xml @@ -30,13 +30,7 @@ Xen - Use where it accurately refers to the original Xen version of the package. If the Xen package we distribute is for all practical purposes the same as the upstream code, we can refer to the package we distribute as "Xen" in a referential way. - - - A referential use is one that describes another entity's goods or services, not our own, such as referring to Microsoft Windows as a technology we compete and integrate with. When referring to another entity's trademark, always use good trademark practices; that is, only use the trademark as an adjective followed by the noun, do not use a logo form of the trademark, do not make it more prominent than our own marks, and do not incorporate the trademark into our own product names. Here, the proper use would be "Xen hypervisor." - - - The Xen Trademark Policy is available at http://www.xenproject.org/trademark-policy.html. + Use where it accurately refers to the original Xen version of the package. You can refer to the distributed package as "Xen" if it is essentially the same as the upstream code. @@ -56,7 +50,7 @@ X Windows - Do not use. This is an incorrect reference to the X Window System (or X). + Do not use. It is an incorrect reference to the X Window System (or X). @@ -66,7 +60,7 @@ X Window System - Also referred to as X. When making multiple references to the X Window System, the complete reference must appear first, with shortened references following. For example, "Reinstalling the X Window System, or X, is not necessary if... To start an X session, from the shell prompt..." + Also referred to as X. When making multiple references to the X Window System, the complete reference must appear first, with shortened references following. For example, "Reinstalling the X Window System, or X, is not necessary if ..." "To start an X session, from the shell prompt ..." @@ -86,7 +80,7 @@ you - Correct. Do not use "I," "he," or "she." + Use second person wherever possible. Do not use "I," "we," "he," or "she." @@ -96,7 +90,7 @@ you may - Avoid. For example, "you may" can be eliminated from the following: "You may double-click the desktop..." + Avoid. For example, "you may" can be eliminated from the following sentence: "You may double-click the desktop ..." @@ -106,22 +100,26 @@ zip - See the Word Usage appendix of The IBM Style Guide. + See the Word Usage chapter of the IBM Style Guide. + + - Zip Code + ZIP Code - Correct. Do not use "zip code," "Zip code," or any other variation. + Use only for an address in the US, a US territory, or the Philippines. Otherwise, use "postal code". + + diff --git a/en-US/rel_notes.md b/en-US/rel_notes.md new file mode 100644 index 0000000..1781a79 --- /dev/null +++ b/en-US/rel_notes.md @@ -0,0 +1,25 @@ +# 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”. + +Added inclusive language guidance. + +Added section on use of relative pronoun “that”. + +Added sections on exclamation points and referring to punctuation marks. + +Clarified that sentence case is required for captions, legends, and diagram labels. + +Added section on phrasal verbs (two-word verb forms). + +Added more categories of ambiguities to avoid. + +Dates and Times: Changed times of day standard from “a.m.”, “p.m.” to “AM”, “PM”. + +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 + +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. + +Minor edits so the guide itself conforms more fully with its own advice. \ No newline at end of file diff --git a/index.html b/index.html index c27b286..2299291 100644 --- a/index.html +++ b/index.html @@ -40,22 +40,22 @@

- Red Hat Style Guide + Red Hat Technical Writing Style Guide

-

- - RHT DocBook XML Guide v2 +

- +

- - RHT DocBook XML Guide v3 + + RHT DocBook XML Guide v4.0

- Red Hat Brand Standards + Red Hat Brand Standards

@@ -63,7 +63,7 @@