Skip to content

Commit ad3a44b

Browse files
A few new year edits to resolve common questions
In the past year or so, a couple different CEs have had the same misunderstanding with figure caption guidance, rewriting captions to be consistently fragments or sentences rather than just changing the punctuation. Here's my attempt at a clarification—ultimately directing to you, the PE, since there are so many dependencies. Per Slack discussion, the direction on compound nouns was too broad and not often enforced anyway (AFAIK). I removed it and added two common culprits to the word list instead: road map and life cycle—we've *been* fine with either (preferring MW) as long as the book is consistent, so why not codify that here. Feedback welcome!
1 parent 39bf90e commit ad3a44b

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

styleguide/index.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -347,13 +347,13 @@ title: O'Reilly Style Guide
347347

348348
<ul>
349349
<li>
350-
<p>Figure 1-1. Figure captions are sentence-cased, with the exception of proper nouns. <strong>Code styling is allowed within the figure name or caption.</strong> There is no period after figure captions, but if all captions are long and sentence style, periods can be used as long as they are used consistently throughout.</p>
350+
<p>Figure 1-1. Figure captions are sentence-cased, with the exception of proper nouns. Code styling is allowed within the figure name or caption. There is no period after figure captions. Exceptions should be discussed with your production editor (e.g., if several long captions require punctuation, we can collaborate on efficient ways to achieve consistency). </p>
351351
</li>
352352
<li>
353-
<p>Table 1-1. Column heads and table titles are sentence-cased, with the exception of proper nouns. <strong>Code styling is allowed within the table name or caption.</strong> There is no period after table titles.</p>
353+
<p>Table 1-1. Column heads and table titles are sentence-cased, with the exception of proper nouns. Code styling is allowed within the table name or caption. There is no period after table titles.</p>
354354
</li>
355355
<li>
356-
<p>Example 1-1. Example titles are sentence-cased, with the exception of proper nouns. <strong>Code styling is allowed within the example name or caption.</strong> There is no period after example titles.</p>
356+
<p>Example 1-1. Example titles are sentence-cased, with the exception of proper nouns. Code styling is allowed within the example name or caption. There is no period after example titles.</p>
357357
</li>
358358
</ul>
359359

@@ -725,9 +725,6 @@ title: O'Reilly Style Guide
725725
</li>
726726
<li>
727727
<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>
728-
</li>
729-
<li>
730-
<p>Compound words are closed up when used as nouns (“coverup”), hyphenated when used as adjectives (“the cover-up measures”), and two words when used as verbs (“cover up the flaw with…”).</p>
731728
</li>
732729
<li>
733730
<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>
@@ -1217,6 +1214,7 @@ title: O'Reilly Style Guide
12171214
<li>leftmost</li>
12181215
<li>less-than sign or &lt;</li>
12191216
<li>leveled (not levelled)</li>
1217+
<li><strong>life cycle or lifecycle (be consistent)</strong></li>
12201218
<li>line-feed (a)</li>
12211219
<li>line feed (n)</li>
12221220
<li>Linux</li>
@@ -1420,6 +1418,7 @@ title: O'Reilly Style Guide
14201418
<li>right-click</li>
14211419
<li>righthand (a)</li>
14221420
<li>rmail</li>
1421+
<li><strong>road map or roadmap (be consistent)</strong></li>
14231422
<li>rollback (n); roll back (v)</li>
14241423
<li>rollout (n); roll out (v)</li>
14251424
<li>rootkit</li>

0 commit comments

Comments
 (0)