Skip to content

Commit a353d5e

Browse files
authored
Word usage updates: screenshot, lookup, see/refer to (#546)
* Word usage updates: screenshot, lookup, see/refer to * Addresses one comment * Updates to see/refer to entries * Minor fix
1 parent 9daece9 commit a353d5e

29 files changed

+155
-152
lines changed

en-US/0-9.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<term>2-track (IT)</term>
2222
<listitem>
2323
<para>
24-
<emphasis>adj.</emphasis> A less common way to refer to bimodal or hybrid IT. See <xref linkend="bimodal-it" />.
24+
<emphasis>adj.</emphasis> A less common way to refer to bimodal or hybrid IT. Refer to <xref linkend="bimodal-it" />.
2525
</para>
2626

2727
</listitem>

en-US/A.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
<emphasis>v.</emphasis> "Alternate" as a verb means to change between two states or options.
7070
</para>
7171
<para>
72-
See also <xref linkend="alternative"/>.
72+
Refer also to <xref linkend="alternative"/>.
7373
</para>
7474

7575
</listitem>
@@ -84,7 +84,7 @@
8484
"Alternate" (vb.) means to change between two states or options. If you mean "another way of doing something", use "an alternative method is to ...".
8585
</para>
8686
<para>
87-
See also <xref linkend="alternate"/>.
87+
Refer also to <xref linkend="alternate"/>.
8888
</para>
8989

9090
</listitem>
@@ -97,7 +97,7 @@
9797
For times of day, use uppercase without periods, and use a preceding nonbreaking space after the numeral, for example "11&nbsp;AM".
9898
</para>
9999
<para>
100-
See also <xref linkend="pm"/>.
100+
Refer also to <xref linkend="pm"/>.
101101
</para>
102102

103103
</listitem>
@@ -114,14 +114,14 @@
114114
When discussing the architecture generally, reference both AMD64 and Intel 64 implementations specifically.
115115
</para>
116116
<para>
117-
See also <xref linkend="Intel64"/>.
117+
Refer also to <xref linkend="Intel64"/>.
118118
</para>
119119
<note>
120120
<para>
121-
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="https://www.amd.com/en/corporate/trademarks" />.
121+
The AMD64 logo is trademarked; the term "AMD64" is not. For more information about AMD trademarks, refer to the <citetitle>AMD Trademark Information</citetitle> page at <ulink url="https://www.amd.com/en/corporate/trademarks" />.
122122
</para>
123123
<para>
124-
For more information about Intel&reg; trademarks, see <ulink url="http://www.intel.com/content/www/us/en/legal/trademarks.html" /> and <ulink url="http://www.intel.com/content/www/us/en/trademarks/trademarks.html" />.
124+
For more information about Intel&reg; trademarks, refer to <ulink url="http://www.intel.com/content/www/us/en/legal/trademarks.html" /> and <ulink url="http://www.intel.com/content/www/us/en/trademarks/trademarks.html" />.
125125
</para>
126126

127127
</note>

en-US/B.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
Use the one-word form only if it is part of the established product terminology, for example "Mobile Backend-as-a-Service", and when it is not being used to describe a generic process.
2020
</para>
2121
<para>
22-
See also <xref linkend="front-end" />
22+
Refer also to <xref linkend="front-end" />
2323
</para>
2424

2525
</listitem>
@@ -73,7 +73,7 @@
7373
<term>backwards compatible</term>
7474
<listitem>
7575
<para>
76-
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 <xref linkend="forwards-compatible" />.
76+
Do not use. Instead, use "compatible with earlier versions" to refer to something that is compatible with older equipment or previous versions of software. Refer also to <xref linkend="forwards-compatible" />.
7777
</para>
7878

7979
</listitem>
@@ -106,7 +106,7 @@
106106
<term>basically</term>
107107
<listitem>
108108
<para>
109-
Do not use. For example, removing the word "basically" in the following sentence strengthens it: "This is how it is basically done." See also <xref linkend="simply" />.
109+
Do not use. For example, removing the word "basically" in the following sentence strengthens it: "This is how it is basically done." Refer also to <xref linkend="simply" />.
110110
</para>
111111

112112
</listitem>
@@ -152,7 +152,7 @@
152152
<term>big data</term>
153153
<listitem>
154154
<para>
155-
<emphasis>n., adj.</emphasis> Always use lowercase. Do not capitalize except at the beginning of a sentence, or if it is part of a Red&nbsp;Hat product, service, solution, or business unit name. See also <xref linkend="cloud" />. Big data is also never hyphenated, per AP style, even when used as a complex adjective.
155+
<emphasis>n., adj.</emphasis> Always use lowercase. Do not capitalize except at the beginning of a sentence, or if it is part of a Red&nbsp;Hat product, service, solution, or business unit name. Refer also to <xref linkend="cloud" />. Big data is also never hyphenated, per AP style, even when used as a complex adjective.
156156
</para>
157157

158158
</listitem>
@@ -296,7 +296,7 @@
296296
<term>Bps, bps</term>
297297
<listitem>
298298
<para>
299-
The abbreviation of bytes per second is Bps. The abbreviation of bits per second is bps. To avoid confusion, do not use at the beginning of a sentence. See also <xref linkend="bandwidth" />.
299+
The abbreviation of bytes per second is Bps. The abbreviation of bits per second is bps. To avoid confusion, do not use at the beginning of a sentence. Refer also to <xref linkend="bandwidth" />.
300300
</para>
301301

302302
</listitem>
@@ -306,7 +306,7 @@
306306
<term>breadcrumb trail</term>
307307
<listitem>
308308
<para>
309-
See the <citetitle>IBM Style Guide</citetitle> for initial guidance on how to use this term.
309+
Refer to the <citetitle>IBM Style Guide</citetitle> for initial guidance on how to use this term.
310310
</para>
311311
<note>
312312
<para>
@@ -379,10 +379,10 @@
379379
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.
380380
</para>
381381
<para>
382-
See <ulink url="http://en.wikipedia.org/wiki/Btrfs" /> for more information on this file system.
382+
Refer to <ulink url="http://en.wikipedia.org/wiki/Btrfs" /> for more information on this file system.
383383
</para>
384384
<para>
385-
See <ulink url="http://en.wikipedia.org/wiki/List_of_file_systems" /> for a list of file-system names and how to present them.
385+
Refer to <ulink url="http://en.wikipedia.org/wiki/List_of_file_systems" /> for a list of file-system names and how to present them.
386386
</para>
387387

388388
</listitem>
@@ -428,7 +428,7 @@
428428
Ordinarily you would not include the text "button" in a procedure or description. For example, "Click <guibutton>OK</guibutton> to continue" is perfectly acceptable. It might be necessary to distinguish between buttons and links; for example, "Click the <guibutton>Download</guibutton> link".
429429
</para>
430430
<para>
431-
See also <xref linkend="documenting-ui"/>.
431+
Refer also to <xref linkend="documenting-ui"/>.
432432
</para>
433433

434434
</listitem>

en-US/C.xml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
When referring to a compact disk, use "CD". For example, "Insert the CD into the CD drive". The plural is "CDs".
4747
</para>
4848
<para>
49-
See the Word Usage chapter of the <citetitle>IBM Style Guide</citetitle> for more information.
49+
Refer to the Word Usage chapter of the <citetitle>IBM Style Guide</citetitle> for more information.
5050
</para>
5151

5252
</listitem>
@@ -67,7 +67,7 @@
6767
<listitem>
6868
<para>
6969
Correct. Ceph is a distributed storage platform that provides object, block, and file storage.<footnote> <para>
70-
See <ulink url="http://en.wikipedia.org/wiki/Ceph_%28software%29" />
70+
Refer to <ulink url="http://en.wikipedia.org/wiki/Ceph_%28software%29" />
7171
</para>
7272
</footnote> Do not use alternative capitalization.
7373
</para>
@@ -129,7 +129,7 @@
129129
Define on first use; generally continuous integration/continuous delivery. It does not mean continuous development, a term with questionable usefulness and only marginal adoption.
130130
</para>
131131
<para>
132-
See also <xref linkend="continuous-integration" />, <xref linkend="continuous-delivery" />, <xref linkend="continuous-deployment" />.
132+
Refer also to <xref linkend="continuous-integration" />, <xref linkend="continuous-delivery" />, <xref linkend="continuous-deployment" />.
133133
</para>
134134

135135
</listitem>
@@ -153,7 +153,7 @@
153153
</para>
154154
<!-- Added comment about "click on". -->
155155
<para>
156-
See the Word Usage chapter of the <citetitle>IBM Style Guide</citetitle> for more information.
156+
Refer to the Word Usage chapter of the <citetitle>IBM Style Guide</citetitle> for more information.
157157
</para>
158158

159159
</listitem>
@@ -186,7 +186,7 @@
186186
<term>cloud</term>
187187
<listitem>
188188
<para>
189-
Although cloud is important to Red&nbsp;Hat's business, it is not a proper noun. Do not capitalize, unless it is part of a Red&nbsp;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&nbsp;Hat CloudForms or Red&nbsp;Hat Cloud Foundations. See also "big data".
189+
Although cloud is important to Red&nbsp;Hat's business, it is not a proper noun. Do not capitalize, unless it is part of a Red&nbsp;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&nbsp;Hat CloudForms or Red&nbsp;Hat Cloud Foundations. Refer also to "big data".
190190
</para>
191191

192192
</listitem>
@@ -247,7 +247,7 @@
247247
<term>combo-box</term>
248248
<listitem>
249249
<para>
250-
Do not use as an abbreviation for "combination box". See the relevant entry in the <citetitle>IBM Style Guide</citetitle> for further usage information.
250+
Do not use as an abbreviation for "combination box". Refer to the relevant entry in the <citetitle>IBM Style Guide</citetitle> for further usage information.
251251
</para>
252252

253253
</listitem>
@@ -313,7 +313,7 @@
313313
<term>command line, command prompt, command-line</term>
314314
<listitem>
315315
<para>
316-
See the appropriate entries in the <citetitle>IBM Style Guide</citetitle> for an explanation of how to use these terms.
316+
Refer to the appropriate entries in the <citetitle>IBM Style Guide</citetitle> for an explanation of how to use these terms.
317317
</para>
318318

319319
</listitem>
@@ -348,7 +348,7 @@
348348
<term>communication service provider (CSP)</term>
349349
<listitem>
350350
<para>
351-
Another way to refer to a telecommunications provider. See also <xref linkend="telco" />.
351+
Another way to refer to a telecommunications provider. Refer also to <xref linkend="telco" />.
352352
</para>
353353

354354
</listitem>
@@ -358,7 +358,7 @@
358358
<term>Containers-as-a-Service</term>
359359
<listitem>
360360
<para>
361-
The term "Containers-as-a-Service" is owned by Docker and should be used only when referring to that company's offering. See also <xref linkend="as-a-service" />.
361+
The term "Containers-as-a-Service" is owned by Docker and should be used only when referring to that company's offering. Refer also to <xref linkend="as-a-service" />.
362362
</para>
363363

364364
</listitem>
@@ -511,7 +511,7 @@
511511
<listitem>
512512
<para>
513513
<emphasis>n.</emphasis> CVE stands for Common Vulnerabilities and Exposures, and should be capitalized as shown.
514-
See <ulink url="https://en.wikipedia.org/wiki/Common_Vulnerabilities_and_Exposures"></ulink> for more information.
514+
Refer to <ulink url="https://en.wikipedia.org/wiki/Common_Vulnerabilities_and_Exposures"></ulink> for more information.
515515
</para>
516516
</listitem>
517517
</varlistentry>

en-US/D.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116
<listitem>
117117
<para>
118118
<remark>Needs review</remark>
119-
When presenting specific dates and times numerically, see ISO Standard 8601. For dates, this means <replaceable>YYYMDD</replaceable> is the recommended representation.
119+
When presenting specific dates and times numerically, refer to ISO Standard 8601. For dates, this means <replaceable>YYYMDD</replaceable> is the recommended representation.
120120
</para>
121121
122122
</listitem>
@@ -189,7 +189,7 @@
189189
<term>dialog box</term>
190190
<listitem>
191191
<para>
192-
See the Word Usage chapter of the <citetitle>IBM Style Guide</citetitle> for usage information related to this and similar terms.
192+
Refer to the Word Usage chapter of the <citetitle>IBM Style Guide</citetitle> for usage information related to this and similar terms.
193193
</para>
194194

195195
</listitem>
@@ -231,7 +231,7 @@
231231
<term>disk, disc</term>
232232
<listitem>
233233
<para>
234-
Use "compact disc" or "hard disk". See the <citetitle>IBM Style Guide</citetitle> for more information and example use cases.
234+
Use "compact disc" or "hard disk". Refer to the <citetitle>IBM Style Guide</citetitle> for more information and example use cases.
235235
</para>
236236
<!-- Removed reference to "diskette". -->
237237

@@ -273,7 +273,7 @@
273273
<term>documentation</term>
274274
<listitem>
275275
<para>
276-
When referring to the current manual set, use "documentation". For example, "This manual is also available as part of our online documentation." When referring to another manual, quote the title of the manual, for example, "See the <citetitle>Getting Started Guide</citetitle> for further information."
276+
When referring to the current manual set, use "documentation". For example, "This manual is also available as part of our online documentation." When referring to another manual, quote the title of the manual, for example, "Refer to the <citetitle>Getting Started Guide</citetitle> for further information."
277277
</para>
278278

279279
</listitem>
@@ -316,7 +316,7 @@
316316
<term>downstream</term>
317317
<listitem>
318318
<para>
319-
Correct. Use the one-word form for both the nominal and adjectival forms. See also <xref linkend="upstream" />. Do not use "down-stream" or "down stream."
319+
Correct. Use the one-word form for both the nominal and adjectival forms. Refer also to <xref linkend="upstream" />. Do not use "down-stream" or "down stream."
320320
</para>
321321

322322
</listitem>

0 commit comments

Comments
 (0)