You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<p>See the <strong><em>The Chicago Manual of Style</em></a>, 18th edition</strong> for questions about abbreviations and acronyms that are not covered here:</p>
106
+
<p>See the <strong><em>The Chicago Manual of Style</em>, 18th edition</strong> for questions about abbreviations and acronyms that are not covered here:</p>
107
107
<ul>
108
108
<li>
109
109
<p>A.M. and P.M. or a.m. and p.m.—be consistent.</p>
@@ -340,45 +340,39 @@ title: O'Reilly Style Guide
340
340
341
341
<p>Here is some additional guidance on what to spell out and when:</p>
342
342
<ul>
343
-
<li><p>Always use the symbol % with numerals rather than the spelled out word (percent), and make sure it is closed up to number: 0.05%. Unless the percentage begins a sentence or title/caption, the number should be a numeral with the % symbol.</p>
344
-
</li>
345
-
<li><p>Centuries follow the same zero through nine rule, so those will usually be numerals (i.e., 20th century, 21st century).</p>
343
+
<li><p>Always use the symbol % with numerals rather than the spelled out word (percent), and make sure it is closed up to number: 0.05%. Unless the percentage begins a sentence or title/caption, the number should be a numeral with the % symbol.</p>
346
344
</li>
347
-
<li><p>In most numbers of one thousand or more, commas should be used between groups of three digits, counting from the right (32,904 <em>NOT 32904</em>). Exceptions: page numbers, addresses, port numbers, etc.</p>
348
-
</li>
349
-
<li><p>Spell out numbers from zero to nine and certain round multiples of those numbers unless the same object appears in a sentence with an object 10 or over (five apples; five apples and one hundred oranges; 5 apples and 110 oranges). </p>
350
-
</li>
351
-
<li><p>Spell out ordinal numbers first through ninth, use numerals for 10th and above. No superscript.</p>
352
-
</li>
353
-
<li><p>Use numerals for versions (version 5 or v5).</p>
354
-
</li>
355
-
<li><p>Use a numeral if it’s an actual value (e.g., 5% 7″ $6.00).</p>
356
-
</li>
357
-
<li><p>Whole numbers one through nine followed by hundred, thousand, million, billion, and so forth are usually spelled out (except in the sciences or with monetary amounts).</p>
358
-
<li>
359
-
</ul>
345
+
<li><p>Centuries follow the same zero through nine rule, so those will usually be numerals (i.e., 20th century, 21st century).</p>
346
+
</li>
347
+
<li><p>In most numbers of one thousand or more, commas should be used between groups of three digits, counting from the right (32,904 <em>NOT 32904</em>). Exceptions: page numbers, addresses, port numbers, etc.</p>
348
+
</li>
349
+
<li><p>Spell out numbers from zero to nine and certain round multiples of those numbers unless the same object appears in a sentence with an object 10 or over (five apples; five apples and one hundred oranges; 5 apples and 110 oranges). </p>
350
+
</li>
351
+
<li><p>Spell out ordinal numbers first through ninth, use numerals for 10th and above. No superscript.</p>
352
+
</li>
353
+
<li><p>Use numerals for versions (version 5 or v5).</p>
354
+
</li>
355
+
<li><p>Use a numeral if it’s an actual value (e.g., 5% 7″ $6.00).</p>
356
+
</li>
357
+
<li><p>Whole numbers one through nine followed by hundred, thousand, million, billion, and so forth are usually spelled out (except in the sciences or with monetary amounts).</p>
358
+
<li>
359
+
</ul>
360
360
361
361
<p>This is how we format dates and other numbers:</p>
362
362
363
363
<ul>
364
-
<li>
365
-
<p>1980s or ’80s.</p>
366
-
</li>
367
-
<li>
368
-
<p>32-bit integer.</p>
369
-
</li>
370
-
<li>
371
-
<p>Phone numbers can appear in the format xxx-xxx-xxxx.</p>
372
-
</li>
373
-
<li>
374
-
<p>Use an en dash (–) with negative numbers or for minus signs, rather than a hyphen.</p>
375
-
</li>
376
-
<li>
377
-
<p>Use multiplication symbol “×” for dimensions, not "by" (e.g., "8.5 × 11").</p>
<p>Every formally numbered figure, table, and example should be preceded by a specific in-text reference (for example: see Figure 99-1; Example 1-99 shows; Table 1-1 lists, etc.). Formal figures, tables, and examples should not be introduced with colons or phrases like “in the following figure,” or “as shown in this table.” Though we do support unnumbered informal figures/tables/examples, these should be used only for elements whose contents are not discussed at length or referred back to. Lack of specific in-text references may cause incorrect placement of figures. See <ahref="#cross_references">Cross References</a> above for more detail on including cross references.</p>
391
+
<p>Every formally numbered figure, table, and example should be preceded by a specific in-text reference (for example: see Figure 99-1; Example 1-99 shows; Table 1-1 lists, etc.). Formal figures, tables, and examples should not be introduced with colons or phrases like “in the following figure,” or “as shown in this table.” Though we do support unnumbered informal figures/tables/examples, these should be used only for elements whose contents are not discussed at length or referred back to. Lack of specific in-text references may cause incorrect placement of figures. See <ahref="#cross_references">Cross References</a> for more detail on including cross references.</p>
398
392
399
393
<divdata-type="tip">
400
394
<p>If you are writing or copyediting in Word, figure, table, and example numbers should be numbered as follows: 1-2 (note hyphen [-], not en dash [–] between numbers). The first number is the chapter number. This will be soft-coded in production if not during the writing process.</p>
@@ -781,52 +775,40 @@ title: O'Reilly Style Guide
781
775
782
776
<p><ahref="#getting_started">back to top</a></p>
783
777
</section>
778
+
</section>
784
779
785
780
786
781
787
782
<sectiondata-type="sect1"id="miscellaneous">
788
783
<h1>Miscellaneous</h1>
789
784
790
785
<ul>
791
-
<li>
792
-
<p>Do not use a hyphen between an adverb and the word it modifies. So, “incredibly wide table” rather than “incredibly-wide table.”</p>
793
-
</li>
794
-
<li>
795
-
<p>Close up words with the following prefixes (unless part of a proper noun) “micro,” “meta,” “multi,” “pseudo,” “re,” “non,” “sub,” and "co" (e.g., “multiusers,” “pseudoattribute,” “nonprogrammer,” “subprocess,” "coauthor"). Exceptions are noted in the word list (e.g., "re-create," "re-identification").</p>
796
-
</li>
797
-
<li>
798
-
<p>Avoid using the possessive case for singular nouns ending in “s,” if possible. So, it’s “the Windows Start menu,” not “Windows’s Start menu.”</p>
799
-
</li>
800
-
<li>
801
-
<p>Avoid wholesale changes to the author’s voice—for example, changing the first-person plural (the royal “we”) to the first-person singular or the second person. However, do try to maintain a consistency within sentences or paragraphs, where appropriate.</p>
802
-
</li>
803
-
<li>
804
-
<p>We advise using a conversational, user-friendly tone that assumes the reader is intelligent but doesn’t have this particular knowledge yet—like an experienced colleague onboarding a new hire. First-person pronouns, contractions, and active verbs are all encouraged. Copyeditors: please check with your production editor if you wish to suggest global changes to tone.)</p>
805
-
</li>
806
-
<li>
807
-
<p>Companies are always singular. So, for example, “Apple emphasizes the value of aesthetics in its product line. Consequently, it dominates the digital-music market” is correct. “Apple emphasize the value of aesthetics in their product line. They dominate the digital-music market” is <em>not</em>. (Also applies to generic terms “organization,” “team,” “group,” etc.)</p>
808
-
</li>
809
-
<li>
810
-
<p>When referring to software elements or labels, always capitalize words that are capitalized on screen. Put quotes around any multiword element names that are lowercase or mixed case on screen and would thus be hard to distinguish from the rest of the text (e.g., Click “Don’t select object until rendered” only if necessary.)</p>
811
-
</li>
812
-
<li>
813
-
<p>Use “between” for two items, “among” for three or more. Use “each other” for two, “one another” for three or more.</p>
814
-
</li>
815
-
<li>
816
-
<p>Use the American spellings of words when they differ.</p>
786
+
<li><p>Do not use a hyphen between an adverb and the word it modifies. So, “incredibly wide table” rather than “incredibly-wide table.”</p>
787
+
</li>
788
+
<li><p>Close up words with the following prefixes (unless part of a proper noun) “micro,” “meta,” “multi,” “pseudo,” “re,” “non,” “sub,” and "co" (e.g., “multiusers,” “pseudoattribute,” “nonprogrammer,” “subprocess,” "coauthor"). Exceptions are noted in the word list (e.g., "re-create," "re-identification").</p>
789
+
</li>
790
+
<li><p>Avoid using the possessive case for singular nouns ending in “s,” if possible. So, it’s “the Windows Start menu,” not “Windows’s Start menu.”</p>
791
+
</li>
792
+
<li><p>Avoid wholesale changes to the author’s voice—for example, changing the first-person plural (the royal “we”) to the first-person singular or the second person. However, do try to maintain a consistency within sentences or paragraphs, where appropriate.</p>
793
+
</li>
794
+
<li><p>We advise using a conversational, user-friendly tone that assumes the reader is intelligent but doesn’t have this particular knowledge yet—like an experienced colleague onboarding a new hire. First-person pronouns, contractions, and active verbs are all encouraged. (Copyeditors: please check with your production editor if you wish to suggest global changes to tone.)</p>
795
+
</li>
796
+
<li><p>Companies are always singular. So, for example, “Apple emphasizes the value of aesthetics in its product line. Consequently, it dominates the digital-music market” is correct. “Apple emphasize the value of aesthetics in their product line. They dominate the digital-music market” is <em>not</em>. (Also applies to generic terms “organization,” “team,” “group,” etc.)</p>
797
+
</li>
798
+
<li><p>When referring to software elements or labels, always capitalize words that are capitalized on screen. Put quotes around any multiword element names that are lowercase or mixed case on screen and would thus be hard to distinguish from the rest of the text (e.g., Click “Don’t select object until rendered” only if necessary.)</p>
799
+
</li>
800
+
<li><p>Use “between” for two items, “among” for three or more. Use “each other” for two, “one another” for three or more.</p>
801
+
</li>
802
+
<li><p>Use the American spellings of words when they differ.</p>
803
+
</li>
804
+
<li><p>Common foreign terms (such as “en masse”) are roman.</p>
805
+
</li>
806
+
<li><p>Introduce unnumbered code blocks with colons.</p>
807
+
</li>
808
+
<li><p>Do not stack admonitions, sidebars, or headings.</p>
809
+
</li>
810
+
<li><p>Avoid obscenities and slurs, and obscure if included (grawlix, a two-em dash, etc.)</p>
817
811
</li>
818
-
<li>
819
-
<p>Common foreign terms (such as “en masse”) are roman.</p>
820
-
</li>
821
-
<li>
822
-
<p>Introduce unnumbered code blocks with colons.</p>
823
-
</li>
824
-
<li>
825
-
<p>Do not stack admonitions, sidebars, or headings.</p>
826
-
</li>
827
-
<li>
828
-
<p>Avoid obscenities and slurs, and obscure if included (grawlix, a two-em dash, etc.)</p>
0 commit comments