Skip to content

Commit 88f5723

Browse files
authored
Merge pull request #35 from oreillymedia/katherinetozer-patch-3
Word list suggestions from new CE—any objections?
2 parents 1299727 + 30b5d78 commit 88f5723

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

styleguide/index.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ title: O'Reilly Style Guide
4040

4141
<p>For term conventions, check our guide and word list first, then <em>The Chicago Manual of Style</em>, 17th edition, then <em><a href="https://www.merriam-webster.com">Merriam-Webster’s Collegiate Dictionary</a></em>. Use your book-specific word list (provided by production) to document style choices that differ or are not covered here (e.g., A.M. or a.m., data center or datacenter).</p>
4242

43-
<p>To avoid unintentional bias, when writing about groups of people, check the group’s advocacy organization for guidance on appropriate language. The <a href="https://consciousstyleguide.com">Conscious Style Guide</a> is one good resource, aggregating links to relevant organizations. <strong>The <a href="https://itconnect.uw.edu/work/inclusive-language-guide">University of Washington has another</a> that is tech-specific.</strong> The <a href="https://ncdj.org/style-guide">Disability Language Style Guide</a> is a thorough guide to writing about disabilities with sensitivity. Always follow a person’s preference and note exceptions, if necessary (e.g., quoting research that is decades old).</p>
43+
<p>To avoid unintentional bias, when writing about groups of people, check the group’s advocacy organization for guidance on appropriate language. The <a href="https://consciousstyleguide.com">Conscious Style Guide</a> is one good resource, aggregating links to relevant organizations. <strong>The <a href="https://itconnect.uw.edu/work/inclusive-language-guide">University of Washington has another</a> that is tech-specific.</strong> The <strong><a href="https://ncdj.org/style-guide">Disability Language Style Guide</a></strong> is a thorough guide to writing about disabilities with sensitivity. Always follow a person’s preference and note exceptions, if necessary (e.g., quoting research that is decades old).</p>
4444

4545
<p>For questions specific to your book or assignment, please consult with your editor or production editor.</p>
4646
</section>
@@ -152,7 +152,7 @@ title: O'Reilly Style Guide
152152
<h3>Citations</h3>
153153
<p>When citing other materials in bibliographies, reference lists, or footnotes, use the “Notes and Bibliography” system from the <a href="https://www.chicagomanualofstyle.org/tools_citationguide.html"><em>The Chicago Manual of Style</em></a>, 17th edition. <strong>Chicago also has an Author-Date system that some authors prefer, which is perfectly acceptable. If there is no discernible consistency, suggest Chicago's Notes for footnotes and Bibliography for endnotes or back matter.</strong></p>
154154

155-
<p><strong>Let your production editor know which of Chicago's systems you applied by adding a note to the Word List Doc.</strong></p>
155+
<p>Let your production editor know which of Chicago's systems you applied by adding a note to the Word List Doc.</p>
156156

157157
<section data-type="sect3" id="footnotes">
158158
<h3>Footnotes</h3>
@@ -333,7 +333,7 @@ title: O'Reilly Style Guide
333333
<section data-type="sect2" id="figures_tables_and_examples">
334334
<h2>Figures, Tables, and Examples</h2>
335335

336-
<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. <strong>See <a href="#cross_references">Cross References</a> above for more detail on including cross references.</strong></p>
336+
<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 <a href="#cross_references">Cross References</a> above for more detail on including cross references.</p>
337337

338338
<div data-type="tip">
339339
<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>
@@ -745,7 +745,7 @@ title: O'Reilly Style Guide
745745
<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>
746746
</li>
747747
<li>
748-
<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.<strong>(Copyeditors: please check with your production editor if you wish to suggest global changes to tone.)</strong></p>
748+
<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>
749749
</li>
750750
<li>
751751
<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>
@@ -803,7 +803,8 @@ title: O'Reilly Style Guide
803803
</thead>
804804
<tbody>
805805
<tr>
806-
<td><p>Filenames, file extensions (such as .jpeg), directory paths, and libraries.</p></td>
806+
807+
<td><p>Filenames, file extensions (such as .jpeg), directory paths, libraries, and commands in Unix, Oracle, and Linux books. <strong>Exception: Python packages (e.g., NumPy, scikit-learn, TensorFlow, etc.) are roman and cased according to convention.</strong></p></td>
807808
<td><p><em>Body font italic</em></p></td>
808809
</tr>
809810
<tr>
@@ -944,7 +945,7 @@ title: O'Reilly Style Guide
944945
<li>big data</li>
945946
<li>Big Design Up Front (BDUF)</li>
946947
<li>bioinformatics</li>
947-
<li><strong>Bitcoin (capitalize the concept/network/currency in general; lowercase specific units of currency)</strong></li>
948+
<li>Bitcoin (capitalize the concept/network/currency in general; lowercase specific units of currency)</li>
948949
<li>bitmap</li>
949950
<li>bit mask</li>
950951
<li>Bitnet</li>
@@ -986,7 +987,7 @@ title: O'Reilly Style Guide
986987
<li>client/server</li>
987988
<li>client side (n)</li>
988989
<li>client-side (a)</li>
989-
<li><strong>cloud native (n or a)</strong></li>
990+
<li>cloud native (n or a)</li>
990991
<li>co-class</li>
991992
<li>coauthor</li>
992993
<li>codebase</li>
@@ -1093,7 +1094,7 @@ title: O'Reilly Style Guide
10931094
<li>fax</li>
10941095
<li>file manager</li>
10951096
<li>filename</li>
1096-
<li><strong>filepath</strong></li>
1097+
<li>filepath</li>
10971098
<li>file server</li>
10981099
<li>filesystem</li>
10991100
<li>file type</li>
@@ -1124,8 +1125,8 @@ title: O'Reilly Style Guide
11241125
<li>GHz</li>
11251126
<li>gid</li>
11261127
<li>GIMP</li>
1127-
<li><strong>Git</strong></li>
1128-
<li><strong>GitHub</strong></li>
1128+
<li>Git</li>
1129+
<li>GitHub</li>
11291130
<li>GNOME</li>
11301131
<li>GNU Emacs</li>
11311132
<li>GNU Public License (GPL)</li>
@@ -1231,7 +1232,7 @@ title: O'Reilly Style Guide
12311232
<li>leftmost</li>
12321233
<li>less-than sign or &lt;</li>
12331234
<li>leveled (not levelled)</li>
1234-
<li><strong>life cycle or lifecycle (be consistent)</strong></li>
1235+
<li>life cycle or lifecycle (be consistent)</li>
12351236
<li>line-feed (a)</li>
12361237
<li>line feed (n)</li>
12371238
<li>Linux</li>
@@ -1249,9 +1250,9 @@ title: O'Reilly Style Guide
12491250

12501251
<h2 id="wordlist-M">M</h2>
12511252
<ul>
1252-
<li><strong>Mac (or MacBook)</strong></li>
1253+
<li>Mac (or MacBook)</li>
12531254
<li>macOS (replaces Mac OS X)</li>
1254-
<li><strong>machine learning (n and a, no hyphen)</strong></li>
1255+
<li>machine learning (n and a, no hyphen)</li>
12551256
<li>mail-handling (adjective)</li>
12561257
<li>– man hours s/b avoided (alternatives: work hours, employee hours)</li>
12571258
<li>manpage</li>
@@ -1335,7 +1336,7 @@ title: O'Reilly Style Guide
13351336
<li>Oracle Parallel Query Option</li>
13361337
<li>O’Reilly Media, Inc.
13371338
<ul>
1338-
<li><strong>O’Reilly’s platform s/b "the O’Reilly platform" or "the O’Reilly learning platform" and then "O’Reilly" on subsequent mentions.</strong></li>
1339+
<li>O’Reilly’s platform s/b "the O’Reilly platform" or "the O’Reilly learning platform" and then "O’Reilly" on subsequent mentions</li>
13391340
</ul>
13401341
</li>
13411342
<li>OS/2</li>
@@ -1435,7 +1436,7 @@ title: O'Reilly Style Guide
14351436
<li>right-click</li>
14361437
<li>righthand (a)</li>
14371438
<li>rmail</li>
1438-
<li><strong>road map or roadmap (be consistent)</strong></li>
1439+
<li>road map or roadmap (be consistent)</li>
14391440
<li>rollback (n); roll back (v)</li>
14401441
<li>rollout (n); roll out (v)</li>
14411442
<li>rootkit</li>
@@ -1525,14 +1526,14 @@ title: O'Reilly Style Guide
15251526
<li>text box</li>
15261527
<li>text-input mode</li>
15271528
<li>thread pooling (n)</li>
1528-
<li><strong>timeout (in tech/computing contexts)</strong></li>
1529+
<li>timeout (in tech/computing contexts)</li>
15291530
<li>time-sharing processes</li>
15301531
<li>timestamp</li>
15311532
<li>time zone</li>
15321533
<li>title bar</li>
15331534
<li>Token Ring</li>
15341535
<li>toolbar</li>
1535-
<li><strong>toolchain</strong></li>
1536+
<li>toolchain</li>
15361537
<li>toolkit</li>
15371538
<li>tool tip</li>
15381539
<li>top-level (a)</li>

0 commit comments

Comments
 (0)