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
** <ahref="#dates_and_numbers">Dates and Numbers</a>
19
+
** <ahref="#figures_tables_and_examples">Figures, Tables, and Examples</a>
20
+
** <ahref="#gen_ai">Generative AI</a>
21
+
** <ahref="#headings">Headings</a>
22
+
** <ahref="#links">Links</a>
23
+
** <ahref="#lists">Lists</a>
24
+
*** <ahref="#bulleted_list">Bulleted list</a>
25
+
*** <ahref="#numbered_list">Numbered list</a>
26
+
*** <ahref="#variable_list">Variable list</a>
27
+
** <ahref="#punctuation">Punctuation</a>
28
+
** <ahref="#typography_and_font_conventions">Typography and Font Conventions</a>
29
+
** <ahref="#miscellaneous">Miscellaneous</a>
30
30
* <ahref="#cover-style">O'Reilly Cover Copy</a>
31
31
* <ahref="#word-list">O’Reilly Word List</a>
32
32
@@ -645,58 +645,6 @@ title: O'Reilly Style Guide
645
645
646
646
647
647
648
-
<sectiondata-type="sect1"id="miscellaneous">
649
-
<h1>Miscellaneous</h1>
650
-
651
-
<ul>
652
-
<li>
653
-
<p>Do not use a hyphen between an adverb and the word it modifies. So, “incredibly wide table” rather than “incredibly-wide table.”</p>
654
-
</li>
655
-
<li>
656
-
<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>
657
-
</li>
658
-
<li>
659
-
<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>
660
-
</li>
661
-
<li>
662
-
<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>
663
-
</li>
664
-
<li>
665
-
<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>
666
-
</li>
667
-
<li>
668
-
<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>
669
-
</li>
670
-
<li>
671
-
<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>
672
-
</li>
673
-
<li>
674
-
<p>Use “between” for two items, “among” for three or more. Use “each other” for two, “one another” for three or more.</p>
675
-
</li>
676
-
<li>
677
-
<p>Use the American spellings of words when they differ.</p>
678
-
</li>
679
-
<li>
680
-
<p>Common foreign terms (such as “en masse”) are roman.</p>
681
-
</li>
682
-
<li>
683
-
<p>Introduce unnumbered code blocks with colons.</p>
684
-
</li>
685
-
<li>
686
-
<p>Do not stack admonitions, sidebars, or headings.</p>
687
-
</li>
688
-
<li>
689
-
<p>Avoid obscenities and slurs, and obscure if included (grawlix, a two-em dash, etc.)</p>
690
-
</li>
691
-
</ul>
692
-
693
-
<p><ahref="#getting_started">back to top</a></p>
694
-
</section>
695
-
696
-
697
-
698
-
699
-
700
648
<sectiondata-type="sect2"id="punctuation">
701
649
<h2>Punctuation</h2>
702
650
@@ -836,6 +784,54 @@ title: O'Reilly Style Guide
836
784
837
785
838
786
787
+
<sectiondata-type="sect1"id="miscellaneous">
788
+
<h1>Miscellaneous</h1>
789
+
790
+
<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>
817
+
</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