Skip to content

#306 Added guidance about pronouncing file or directory names that begin with special characters. #326

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 1 commit into from
Jan 5, 2022
Merged

#306 Added guidance about pronouncing file or directory names that begin with special characters. #326

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 20 additions & 2 deletions en-US/Design.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -688,7 +688,7 @@ $ vi myFile.txt

</section>
<section id="using-abbreviations">
<title>Using Abbreviations, Acronyms, and Initialisms Correctly</title>
<title>Using Abbreviations, Acronyms, Initialisms, and Special Characters Correctly</title>
<para>
This section describes how to use abbreviations, acronyms, and initialisms correctly in Red&nbsp;Hat documentation.
</para>
Expand Down Expand Up @@ -727,7 +727,7 @@ $ vi myFile.txt
Be sure to use correct capitalization for acronyms. Not all acronyms are capitalized (for example, "spool"); see the <citetitle>IBM Style Guide</citetitle> or another suitable reference if you are unsure.
</para>

<formalpara>
<formalpara id="initialisms">
<title>Initialisms</title>
<para>
An initialism is an abbreviation that consists of the first letters of words in a phrase, syllables, or some combination thereof. Each character is pronounced separately. For example, <abbrev>FTP</abbrev> is an initialism for <systemitem class="protocol">File Transfer Protocol.</systemitem>
Expand All @@ -737,6 +737,24 @@ $ vi myFile.txt
<para>
Consider pronunciation when using articles. See <xref linkend="acronyms" /> for more information.
</para>
<formalpara id="special-characters">
<title>Special Characters</title>
<para>
Consider pronunciation when referring to file or directory names that begin with special characters, and use the correct indefinite article.
</para>

</formalpara>
<para>
If a file or directory name begins with a special character, such as an underscore, then you need to pronounce that character.
</para>

<para>
For example, using "an <filename>_build/</filename> directory" is correct, because you pronounce "an underscore build directory".
</para>

<para>
Using "a <filename>-compile/</filename> directory" is correct, because you pronounce "a dash compile directory".
</para>

</section>
<section id="product-names">
Expand Down