|
17 | 17 |
|
18 | 18 | </varlistentry> |
19 | 19 | <varlistentry id="agile-development"> |
20 | | - <term>agile, agile development</term> |
| 20 | + <term role="true">agile</term> |
| 21 | + <term role="true">agile development</term> |
21 | 22 | <listitem> |
22 | 23 | <para> |
23 | 24 | <emphasis>adj.</emphasis> Use only as an adjective. It is not a proper noun, nor is it owned or trademarked and should not be capitalized. |
|
27 | 28 |
|
28 | 29 | </varlistentry> |
29 | 30 | <varlistentry id="air-gap"> |
30 | | - <term>air gap</term> |
| 31 | + <term role="true">air gap</term> |
| 32 | + <term role="false">air wall</term> |
31 | 33 | <listitem> |
32 | 34 | <para> |
33 | 35 | <emphasis>n.</emphasis> Use "air gap" to describe systems that are separated, not by software, but physically. Do not use "air wall." "Air gap" is preferred in technical publications because there is no actual wall that you need to breach, but rather a gap that you need to bridge. You cannot break through something that does not exist. |
|
36 | 38 | </listitem> |
37 | 39 |
|
38 | 40 | </varlistentry> |
39 | | - <varlistentry> |
40 | | - <term>a.m. and p.m.</term> |
| 41 | + <varlistentry id="am"> |
| 42 | + <term role="true">a.m.</term> |
| 43 | + <term role="false">am</term> |
41 | 44 | <listitem> |
42 | 45 | <para> |
43 | 46 | Correct. Use the lowercase form and include the periods, and use a preceding space. |
44 | 47 | </para> |
| 48 | + <para> |
| 49 | + See also <xref linkend="pm"/>. |
| 50 | + </para> |
45 | 51 | <para> |
46 | 52 | See <citetitle>The IBM Style Guide</citetitle> for a full discussion of how to represent times. |
47 | 53 | </para> |
|
50 | 56 |
|
51 | 57 | </varlistentry> |
52 | 58 | <varlistentry id="all-in-one"> |
53 | | - <term>all-in-one</term> |
| 59 | + <term role="true">all-in-one</term> |
| 60 | + <term role="false">allinone</term> |
54 | 61 | <listitem> |
55 | 62 | <para> |
56 | 63 | <emphasis>n., adj.</emphasis> Correct. Hyphenate in both cases. Do not use "allinone" or other variations. |
|
59 | 66 | </listitem> |
60 | 67 |
|
61 | 68 | </varlistentry> |
62 | | - <varlistentry id="AMD64-Intel64"> |
63 | | - <term>AMD64 and Intel 64</term> |
| 69 | + <varlistentry id="AMD64"> |
| 70 | + <term role="true">AMD64</term> |
64 | 71 | <listitem> |
65 | 72 | <para> |
66 | 73 | Correct. Do not use "Hammer," "x86_64," "x86-64," "x64," "64-bit x86" or other variations as the name of this architecture. |
67 | 74 | </para> |
68 | 75 | <para> |
69 | | - The correct term for AMD's implementation of this architecture is "AMD64." 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 implementations specifically. |
| 76 | + The correct term for AMD's implementation of this architecture is "AMD64." |
| 77 | + When discussing the architecture generally, reference both AMD64 and Intel 64 implementations specifically. |
70 | 78 | </para> |
| 79 | + <para> |
| 80 | + See also <xref linkend="Intel64"/>. |
| 81 | + </para> |
71 | 82 | <note> |
72 | 83 | <para> |
73 | 84 | The AMD64 logo is trademarked; the term "AMD64" is not. For more information about AMD trademarks, see the <citetitle>AMD Trademark Information</citetitle> page at <ulink url="http://www.amd.com/us/aboutamd/Pages/trademarks.aspx" />. |
|
82 | 93 |
|
83 | 94 | </varlistentry> |
84 | 95 | <varlistentry id="atm"> |
85 | | - <term>ATM</term> |
| 96 | + <term role="true">ATM</term> |
86 | 97 | <listitem> |
87 | 98 | <para> |
88 | | - 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. |
| 99 | + Initialism for Asynchronous Transfer Mode, a network technology based on transferring data in cells or packets of a fixed size. |
| 100 | + The cell size used with ATM is relatively small compared to units used with older technologies. |
89 | 101 | </para> |
90 | 102 |
|
91 | 103 | </listitem> |
92 | 104 |
|
93 | 105 | </varlistentry> |
94 | 106 | <varlistentry id="above"> |
95 | | - <term>above</term> |
| 107 | + <term role="caution">above</term> |
96 | 108 | <listitem> |
97 | 109 | <para> |
98 | | - 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. |
| 110 | + Do not use to refer to information mentioned previously. |
| 111 | + When documents are converted to online format, the information may no longer be "above." |
| 112 | + Use a cross-reference if the referenced material is sufficiently removed, or write "as mentioned previously" instead. |
99 | 113 | </para> |
100 | 114 |
|
101 | 115 | </listitem> |
|
105 | 119 | <term>acronyms</term> |
106 | 120 | <listitem> |
107 | 121 | <para> |
108 | | - An acronym is a word formed from the initial letters of a name, such as ROM for <emphasis>R</emphasis>ead <emphasis>O</emphasis>nly <emphasis>M</emphasis>emory, or by combining initial letters or part of a series of words, such as LILO for <emphasis>LI</emphasis>nux <emphasis>LO</emphasis>ader. 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. |
| 122 | + An acronym is a word formed from the initial letters of a name, such as ROM for <emphasis>R</emphasis>ead <emphasis>O</emphasis>nly <emphasis>M</emphasis>emory, or by combining initial letters or part of a series of words, such as LILO for <emphasis>LI</emphasis>nux <emphasis>LO</emphasis>ader. |
| 123 | + Note that an acronym is pronounced as a word. |
| 124 | + Compare this to an initialism, which is also formed in a similar fashion to an acronym, but in which each letter is pronounced separately. |
109 | 125 | </para> |
110 | 126 | <para> |
111 | | - 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. |
| 127 | + Spell out most acronyms and initialisms before using them in text, such as "The Embedded DevKit (EDK)..." |
| 128 | + Unless the acronym or initialism stands for a proper noun, use sentence case for the spelled out version - for example, "central processing unit (CPU)." |
| 129 | + Unless required for the audience or the topic, do not spell out well-known abbreviations, such as HTML. |
112 | 130 | </para> |
113 | 131 | <para> |
114 | 132 | To form the plural of an acronym, add a trailing, lowercase "s," or "es," for example, ROMs, PINs, BIOSes. |
|
117 | 135 | </listitem> |
118 | 136 |
|
119 | 137 | </varlistentry> |
120 | | - <varlistentry id="alright"> |
121 | | - <term>alright, all right</term> |
| 138 | + <varlistentry id="alternate"> |
| 139 | + <term role="true">alternate</term> |
122 | 140 | <listitem> |
123 | 141 | <para> |
124 | | - Avoid if at all possible. These terms carry a more familiar or colloquial tone than is expected in Red Hat documentation. Use more formal alternatives such as "correct" or "as expected," depending on context. |
| 142 | + <emphasis>vb.</emphasis> "Alternate" as a verb means to change between two states or options. |
125 | 143 | </para> |
| 144 | + <para> |
| 145 | + See also <xref linkend="alternative"/>. |
| 146 | + </para> |
126 | 147 |
|
127 | 148 | </listitem> |
128 | 149 |
|
129 | 150 | </varlistentry> |
130 | | - <varlistentry id="alternate"> |
131 | | - <term>alternate</term> |
| 151 | + |
| 152 | + <varlistentry id="alternative"> |
| 153 | + <term role="true">alternative</term> |
132 | 154 | <listitem> |
133 | 155 | <para> |
134 | | - Do not use this to mean "an alternative to 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..." |
| 156 | + <emphasis>adj.</emphasis> Used to describe another way or method of doing something. |
| 157 | + "Alternate" (vb.) means to change between two states or options. If you mean "another way of doing something," use "an alternative method is to..." |
135 | 158 | </para> |
| 159 | + <para> |
| 160 | + See also <xref linkend="alternate"/>. |
| 161 | + </para> |
136 | 162 |
|
137 | 163 | </listitem> |
138 | 164 |
|
139 | 165 | </varlistentry> |
140 | 166 | <varlistentry id="andor"> |
141 | | - <term>and/or</term> |
| 167 | + <term role="false">and/or</term> |
142 | 168 | <listitem> |
143 | 169 | <para> |
144 | | - Avoid if possible. Try to rewrite to make the available options explicit and clear. Do not write <emphasis>this and/or that</emphasis>. Write <emphasis>this or that or both</emphasis>. |
| 170 | + Avoid if possible. |
| 171 | + Try to rewrite to make the available options explicit and clear. |
| 172 | + Do not write <emphasis>this and/or that</emphasis>. |
| 173 | + Write <emphasis>this or that or both</emphasis>. |
145 | 174 | </para> |
146 | 175 |
|
147 | 176 | </listitem> |
148 | 177 |
|
149 | 178 | </varlistentry> |
150 | | - <varlistentry id="applications"> |
151 | | - <term>applications</term> |
| 179 | + <varlistentry id="application"> |
| 180 | + <term>application</term> |
152 | 181 | <listitem> |
153 | 182 | <para> |
154 | | - When used as a proper name, use the capitalization of the product, such as GNUPro, Source-Navigator, and Red Hat Enterprise Linux. When used as a command, use lowercase as appropriate, such as "To start GCC, type gcc." |
| 183 | + When used as a proper name, use the capitalization of the product, such as GNUPro, Source-Navigator, and Red Hat Enterprise Linux. |
| 184 | + When used as a command, use lowercase as appropriate, such as "To start GCC, type gcc." |
155 | 185 | </para> |
156 | 186 | <note> |
157 | 187 | <para> |
|
164 | 194 |
|
165 | 195 | </varlistentry> |
166 | 196 | <varlistentry id="applixware"> |
167 | | - <term>Applixware</term> |
| 197 | + <term role="true">Applixware</term> |
| 198 | + <term role="false">Applix</term> |
| 199 | + <term role="false">ApplixWare</term> |
168 | 200 | <listitem> |
169 | 201 | <para> |
170 | | - Correct. Do not use "Applix" or "ApplixWare." |
| 202 | + Correct. |
| 203 | + Do not use "Applix" or "ApplixWare." |
171 | 204 | </para> |
172 | 205 |
|
173 | 206 | </listitem> |
|
177 | 210 | <term>architect</term> |
178 | 211 | <listitem> |
179 | 212 | <para> |
180 | | - 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. 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. For example, a sentence that mentions rearchitecting might require "refactoring" as a replacement rather than "rebuilding." |
| 213 | + Do not use as a verb. |
| 214 | + Even though it might make sense in the correct context, using it as a verb can be jargon or unclear for your audience. |
| 215 | + Use "design," "build," "create," or another descriptive verb instead. |
| 216 | + Before replacing the verb form of "architect" during the editing process, check with the writer to find out the intended meaning. |
| 217 | + For example, a sentence that mentions rearchitecting might require "refactoring" as a replacement rather than "rebuilding." |
181 | 218 | </para> |
182 | 219 | </listitem> |
183 | 220 | </varlistentry> |
184 | 221 | <varlistentry id="as-well-as"> |
185 | | - <term>as well as</term> |
| 222 | + <term role="caution">as well as</term> |
186 | 223 | <listitem> |
187 | 224 | <para> |
188 | | - Not interchangeable with "and." "As well as" used in a series places more emphasis on the items preceding it, whereas "and" places equal weight on all items in the series. For example, "We sell kitchen electronics and china, as well as some gourmet foods." But "We sell kitchen electronics, china, and silverware." |
| 225 | + Not interchangeable with "and." |
| 226 | + "As well as" used in a series places more emphasis on the items preceding it, whereas "and" places equal weight on all items in the series. |
| 227 | + For example, "We sell kitchen electronics and china, as well as some gourmet foods." |
| 228 | + But "We sell kitchen electronics, china, and silverware." |
189 | 229 | </para> |
190 | 230 |
|
191 | 231 | </listitem> |
192 | 232 |
|
193 | 233 | </varlistentry> |
194 | 234 | <varlistentry id="as-a-service"> |
195 | | - <term>as-a-Service</term> |
| 235 | + <term role="caution">as-a-Service</term> |
196 | 236 | <listitem> |
197 | 237 | <para> |
198 | | - Be aware that there is a great deal of overlap in as-a-Service acronyms. To avoid confusion, always spell out the full term on first possible use. |
| 238 | + Be aware that there is a great deal of overlap in as-a-Service acronyms. |
| 239 | + To avoid confusion, always spell out the full term on first use. |
199 | 240 | </para> |
200 | 241 | <itemizedlist> |
201 | 242 | <listitem> |
|
272 | 313 | </listitem> |
273 | 314 | <listitem> |
274 | 315 | <para> |
275 | | - 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). |
| 316 | + Hyphenate when written out: Thing-as-a-Service. |
| 317 | + For two-word prefixes, do not include a hyphen between the first and second words: Mobile Backend-as-a-Service. |
| 318 | + 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). |
276 | 319 | </para> |
277 | 320 |
|
278 | 321 | </listitem> |
|
288 | 331 | </listitem> |
289 | 332 |
|
290 | 333 | </varlistentry> |
291 | | - <varlistentry id="auto-detect"> |
| 334 | + <!--<varlistentry id="auto-detect"> |
292 | 335 | <term>auto-detect</term> |
293 | 336 | <listitem> |
294 | 337 | <para> |
|
297 | 340 |
|
298 | 341 | </listitem> |
299 | 342 |
|
300 | | - </varlistentry> |
| 343 | + </varlistentry> Commented for now waiting for verification that the closed version is correct. --> |
301 | 344 | <varlistentry id="autofs"> |
302 | | - <term>autofs</term> |
| 345 | + <term role="true">autofs</term> |
303 | 346 | <listitem> |
304 | 347 | <para> |
305 | | - Always lowercase. This refers to the kernel-based automount utility. No other forms are recognized. |
| 348 | + Always lowercase. |
| 349 | + This refers to the kernel-based automount utility. |
| 350 | + No other forms are recognized. |
306 | 351 | </para> |
307 | 352 |
|
308 | 353 | </listitem> |
|
0 commit comments