Skip to content

Word usage updates: screenshot, lookup, see/refer to #546

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
julian-cable merged 4 commits into from
Nov 23, 2023
Merged

Word usage updates: screenshot, lookup, see/refer to #546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dd77928
Word usage updates: screenshot, lookup, see/refer to
julian-cable Nov 22, 2023
9352e04
Addresses one comment
julian-cable Nov 22, 2023
9db041d
Updates to see/refer to entries
julian-cable Nov 22, 2023
31aba5c
Minor fix
julian-cable Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion en-US/0-9.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<term>2-track (IT)</term>
<listitem>
<para>
<emphasis>adj.</emphasis> A less common way to refer to bimodal or hybrid IT. See <xref linkend="bimodal-it" />.
<emphasis>adj.</emphasis> A less common way to refer to bimodal or hybrid IT. Refer to <xref linkend="bimodal-it" />.
</para>

</listitem>
Expand Down
12 changes: 6 additions & 6 deletions en-US/A.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
<emphasis>v.</emphasis> "Alternate" as a verb means to change between two states or options.
</para>
<para>
See also <xref linkend="alternative"/>.
Refer also to <xref linkend="alternative"/>.
</para>

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

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

</listitem>
Expand All @@ -114,14 +114,14 @@
When discussing the architecture generally, reference both AMD64 and Intel 64 implementations specifically.
</para>
<para>
See also <xref linkend="Intel64"/>.
Refer also to <xref linkend="Intel64"/>.
</para>
<note>
<para>
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" />.
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" />.
</para>
<para>
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" />.
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" />.
</para>

</note>
Expand Down
18 changes: 9 additions & 9 deletions en-US/B.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
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.
</para>
<para>
See also <xref linkend="front-end" />
Refer also to <xref linkend="front-end" />
</para>

</listitem>
Expand Down Expand Up @@ -73,7 +73,7 @@
<term>backwards compatible</term>
<listitem>
<para>
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" />.
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" />.
</para>

</listitem>
Expand Down Expand Up @@ -106,7 +106,7 @@
<term>basically</term>
<listitem>
<para>
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" />.
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" />.
</para>

</listitem>
Expand Down Expand Up @@ -152,7 +152,7 @@
<term>big data</term>
<listitem>
<para>
<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.
<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.
</para>

</listitem>
Expand Down Expand Up @@ -296,7 +296,7 @@
<term>Bps, bps</term>
<listitem>
<para>
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" />.
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" />.
</para>

</listitem>
Expand All @@ -306,7 +306,7 @@
<term>breadcrumb trail</term>
<listitem>
<para>
See the <citetitle>IBM Style Guide</citetitle> for initial guidance on how to use this term.
Refer to the <citetitle>IBM Style Guide</citetitle> for initial guidance on how to use this term.
</para>
<note>
<para>
Expand Down Expand Up @@ -379,10 +379,10 @@
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.
</para>
<para>
See <ulink url="http://en.wikipedia.org/wiki/Btrfs" /> for more information on this file system.
Refer to <ulink url="http://en.wikipedia.org/wiki/Btrfs" /> for more information on this file system.
</para>
<para>
See <ulink url="http://en.wikipedia.org/wiki/List_of_file_systems" /> for a list of file-system names and how to present them.
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.
</para>

</listitem>
Expand Down Expand Up @@ -428,7 +428,7 @@
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".
</para>
<para>
See also <xref linkend="documenting-ui"/>.
Refer also to <xref linkend="documenting-ui"/>.
</para>

</listitem>
Expand Down
20 changes: 10 additions & 10 deletions en-US/C.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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".
</para>
<para>
See the Word Usage chapter of the <citetitle>IBM Style Guide</citetitle> for more information.
Refer to the Word Usage chapter of the <citetitle>IBM Style Guide</citetitle> for more information.
</para>

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

</listitem>
Expand All @@ -153,7 +153,7 @@
</para>
<!-- Added comment about "click on". -->
<para>
See the Word Usage chapter of the <citetitle>IBM Style Guide</citetitle> for more information.
Refer to the Word Usage chapter of the <citetitle>IBM Style Guide</citetitle> for more information.
</para>

</listitem>
Expand Down Expand Up @@ -186,7 +186,7 @@
<term>cloud</term>
<listitem>
<para>
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".
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".
</para>

</listitem>
Expand Down Expand Up @@ -247,7 +247,7 @@
<term>combo-box</term>
<listitem>
<para>
Do not use as an abbreviation for "combination box". See the relevant entry in the <citetitle>IBM Style Guide</citetitle> for further usage information.
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.
</para>

</listitem>
Expand Down Expand Up @@ -313,7 +313,7 @@
<term>command line, command prompt, command-line</term>
<listitem>
<para>
See the appropriate entries in the <citetitle>IBM Style Guide</citetitle> for an explanation of how to use these terms.
Refer to the appropriate entries in the <citetitle>IBM Style Guide</citetitle> for an explanation of how to use these terms.
</para>

</listitem>
Expand Down Expand Up @@ -348,7 +348,7 @@
<term>communication service provider (CSP)</term>
<listitem>
<para>
Another way to refer to a telecommunications provider. See also <xref linkend="telco" />.
Another way to refer to a telecommunications provider. Refer also to <xref linkend="telco" />.
</para>

</listitem>
Expand All @@ -358,7 +358,7 @@
<term>Containers-as-a-Service</term>
<listitem>
<para>
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" />.
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" />.
</para>

</listitem>
Expand Down Expand Up @@ -511,7 +511,7 @@
<listitem>
<para>
<emphasis>n.</emphasis> CVE stands for Common Vulnerabilities and Exposures, and should be capitalized as shown.
See <ulink url="https://en.wikipedia.org/wiki/Common_Vulnerabilities_and_Exposures"></ulink> for more information.
Refer to <ulink url="https://en.wikipedia.org/wiki/Common_Vulnerabilities_and_Exposures"></ulink> for more information.
</para>
</listitem>
</varlistentry>
Expand Down
10 changes: 5 additions & 5 deletions en-US/D.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@
<listitem>
<para>
<remark>Needs review</remark>
When presenting specific dates and times numerically, see ISO Standard 8601. For dates, this means <replaceable>YYYMDD</replaceable> is the recommended representation.
When presenting specific dates and times numerically, refer to ISO Standard 8601. For dates, this means <replaceable>YYYMDD</replaceable> is the recommended representation.
</para>

</listitem>
Expand Down Expand Up @@ -189,7 +189,7 @@
<term>dialog box</term>
<listitem>
<para>
See the Word Usage chapter of the <citetitle>IBM Style Guide</citetitle> for usage information related to this and similar terms.
Refer to the Word Usage chapter of the <citetitle>IBM Style Guide</citetitle> for usage information related to this and similar terms.
</para>

</listitem>
Expand Down Expand Up @@ -231,7 +231,7 @@
<term>disk, disc</term>
<listitem>
<para>
Use "compact disc" or "hard disk". See the <citetitle>IBM Style Guide</citetitle> for more information and example use cases.
Use "compact disc" or "hard disk". Refer to the <citetitle>IBM Style Guide</citetitle> for more information and example use cases.
</para>
<!-- Removed reference to "diskette". -->

Expand Down Expand Up @@ -273,7 +273,7 @@
<term>documentation</term>
<listitem>
<para>
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."
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."
</para>

</listitem>
Expand Down Expand Up @@ -316,7 +316,7 @@
<term>downstream</term>
<listitem>
<para>
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."
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."
</para>

</listitem>
Expand Down
Loading