Skip to content

Commit 397b505

Browse files
Update index.md
Copyedits from Tim Stewart, our newest freelancer!
1 parent a8ed2a6 commit 397b505

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

styleguide/index.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ title: O'Reilly Style Guide
140140

141141
<p>In general, when referring to another book within a book’s text, include the author name(s) for up to two authors. For three or more authors, state the first author name, followed by “et al.” (be sure to include the period).</p>
142142

143-
<p>On first reference to another book, include author and publisher name. For example, "You can find more information in <em>The Elements of Typographic Style</em> by Robert Bringhurst (H&amp;M)," or "For more information, consult Robert Bringhurt’s <em>The Elements of Typographic Style</em> (H&amp;M)." On subsequent references, just use the book title.</p>
143+
<p>On first reference to another book, include author and publisher name. For example, "You can find more information in <em>The Elements of Typographic Style</em> by Robert Bringhurst (H&amp;M)," or "For more information, consult Robert Bringhurst’s <em>The Elements of Typographic Style</em> (H&amp;M)." On subsequent references, just use the book title.</p>
144144

145145
<p>When referencing an O’Reilly book within the text, note only "O’Reilly" in parentheses, not "O’Reilly Media, Inc." References to other O’Reilly books should be linked to the book’s <a href="http://shop.oreilly.com/category/browse-subjects.do">catalog page</a>.</p>
146146

@@ -149,7 +149,7 @@ title: O'Reilly Style Guide
149149
</div>
150150

151151
<h3>Citations</h3>
152-
<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 discernable consistency, suggest Chicago's Notes for footnotes and Bibliography for endnotes or back matter.</strong></p>
152+
<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>
153153

154154
<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>
155155

@@ -289,7 +289,7 @@ title: O'Reilly Style Guide
289289
<p>Use a numeral if it’s an actual value (e.g., 5% 7″ $6.00).</p>
290290
</li>
291291
<li>
292-
<p>Always use the symbol % with numerals rather than the spelled out word (percent), and make sure it is closed up to number: .05%. Unless the percentage begins a sentence or title/caption, the number should be a numeral with the % symbol.</p>
292+
<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>
293293
</li>
294294
<li>
295295
<p>Ordinal numbers: Spell out first through ninth, use numerals for 10th and above. No superscript.</p>
@@ -563,9 +563,9 @@ title: O'Reilly Style Guide
563563

564564
<p>O'Reilly style:</p>
565565
<ul>
566-
<li>Here is an item</li>
567-
<li>Here is another item</li>
568-
<li>Here is the final item</li>
566+
<li>Here is an item.</li>
567+
<li>Here is another item.</li>
568+
<li>Here is the final item.</li>
569569
</ul>
570570
</div>
571571

@@ -669,7 +669,7 @@ title: O'Reilly Style Guide
669669
<section data-type="sect2" id="punctuation">
670670
<h2>Punctuation</h2>
671671

672-
<p>For anything not covered in this list, please consult the Chicago Manual of Style, 17th Edition.</p>
672+
<p>For anything not covered in this list, please consult the _Chicago Manual of Style_, 17th Edition.</p>
673673

674674
<ul>
675675
<li>
@@ -688,7 +688,7 @@ title: O'Reilly Style Guide
688688
<p>No period after list items unless one item forms a complete sentence (then use periods for all items within that list, even fragments).</p>
689689
</li>
690690
<li>
691-
<p>Em-dashes are always closed (no space around them).</p>
691+
<p>Em dashes are always closed (no space around them).</p>
692692
</li>
693693
<li>
694694
<p>Ellipses are always closed (no space around them).</p>
@@ -723,7 +723,7 @@ title: O'Reilly Style Guide
723723
<p>Do not use a hyphen between an adverb and the word it modifies. So, “incredibly wide table” rather than “incredibly-wide table.”</p>
724724
</li>
725725
<li>
726-
<p>Unless part of a proper noun, close up words with the prefixes “micro,” “meta,” “multi,” “pseudo,” “re,” “non,” “sub,” and "co" (e.g., “multiusers,” “pseudoattribute,” “nonprogammer,” “subprocess,” "coauthor"). <strong>Exceptions are noted in the word list (e.g., "re-create," "re-identification")</strong>.</p>
726+
<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>
727727
</li>
728728
<li>
729729
<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>
@@ -732,7 +732,7 @@ title: O'Reilly Style Guide
732732
<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>
733733
</li>
734734
<li>
735-
<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>
735+
<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>
736736
</li>
737737
<li>
738738
<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>
@@ -756,7 +756,7 @@ title: O'Reilly Style Guide
756756
<p>Do not stack admonitions, sidebars, or headings.</p>
757757
</li>
758758
<li>
759-
<p>Avoid obscenities and slurs, and obscure if included (grawlix, a two em dash, etc.)</p>
759+
<p>Avoid obscenities and slurs, and obscure if included (grawlix, a two-em dash, etc.)</p>
760760
</li>
761761
</ul>
762762

@@ -816,7 +816,7 @@ title: O'Reilly Style Guide
816816
<td><p><code>Constant width</code></p></td>
817817
</tr>
818818
<tr>
819-
<td><p>Language and script elements: class names, types, namespaces, attributes, methods, variables, keywords, functions, modules, commands, properties, parameters, values, objects, events, XML and HTML tags, and similar elements. Some examples include: <code>System.Web.UI</code>, a <code>while</code> loop, the <code>Socket</code> class, and the <code>Obsolete</code> attribute. <strong>Exception:</strong> commands in Unix, Oracle, and Linux book, which are regular italics.</p></td>
819+
<td><p>Language and script elements: class names, types, namespaces, attributes, methods, variables, keywords, functions, modules, commands, properties, parameters, values, objects, events, XML and HTML tags, and similar elements. Some examples include: <code>System.Web.UI</code>, a <code>while</code> loop, the <code>Socket</code> class, and the <code>Obsolete</code> attribute. <strong>Exception:</strong> commands in Unix, Oracle, and Linux books, which are regular italics.</p></td>
820820
<td><p><code>Constant width</code></p></td>
821821
</tr>
822822
<tr>
@@ -862,7 +862,7 @@ title: O'Reilly Style Guide
862862

863863
<section data-type="sect1" id="cover-style">
864864
<h1>O'Reilly Cover Style</h1>
865-
<p>Use Chicago Maual of Style, 17th Edition for anything not mentioned here.</p>
865+
<p>Use _Chicago Manual of Style_, 17th Edition for anything not mentioned here.</p>
866866

867867
<p>Bulleted lists on the back cover should begin with a capitalized word and end with <em>no</em> punctuation. Even if the list item is a complete sentence, it will not take a period.</p>
868868

@@ -1052,7 +1052,9 @@ title: O'Reilly Style Guide
10521052

10531053
<h2 id="worldlist-E">E</h2>
10541054
<ul>
1055-
<li>ebook* ebusiness* ecommerce </li>
1055+
<li>ebook</li>
1056+
<li>ebusiness</li>
1057+
<li>ecommerce</li>
10561058
<li>eBay</li>
10571059
<li>Emacs</li>
10581060
<li>email</li>
@@ -1265,7 +1267,7 @@ title: O'Reilly Style Guide
12651267
<li>MKS Toolkit</li>
12661268
<li>model-in-the-loop</li>
12671269
<li>MS-DOS</li>
1268-
<li>multiline (Unless before a proper noun, always close up the following prefixes: “non,” “sub,” “multi,” and “pseudo.”)</li>
1270+
<li>multiline </li>
12691271
<li>Multi-Touch (when referring to Apple's trademark)</li>
12701272
<li>My Services</li>
12711273
<li>MySpace</li>
@@ -1338,7 +1340,7 @@ title: O'Reilly Style Guide
13381340
<li>packet switch networks</li>
13391341
<li>Paint Shop Pro</li>
13401342
<li>pagefile</li>
1341-
<li>page rank (but Google PageRank)</li>
1343+
<li>page rank (but Google PageRank)</li>
13421344
<li>parentheses (p)</li>
13431345
<li>parenthesis (s)</li>
13441346
<li>Pascal</li>
@@ -1413,7 +1415,7 @@ title: O'Reilly Style Guide
14131415
<li>reference page or manpage</li>
14141416
<li>re-identification (hyphenate)</li>
14151417
<li>remote-access server</li>
1416-
<li>Rendezvous (<em>Mac OS X Zeroconf networking</em>)</li>
1418+
<li>Rendezvous (<em>Mac OS X zeroconf networking</em>)</li>
14171419
<li>Return (key)</li>
14181420
<li>RFC 822</li>
14191421
<li>rich text (n)</li>
@@ -1485,7 +1487,7 @@ title: O'Reilly Style Guide
14851487
<li>stateless</li>
14861488
<li>status bar</li>
14871489
<li>stylesheet</li>
1488-
<li>subprocess (Unless before a proper noun, always close up the following prefixes: “non,” “sub,” “multi,” and “pseudo.”)</li>
1490+
<li>subprocess</li>
14891491
<li>SUSE Linux</li>
14901492
<li>swapfile</li>
14911493
<li>swapspace</li>

0 commit comments

Comments
 (0)