Skip to content

Commit 4fbfc3e

Browse files
Fall 2021 updates
1 parent 10f7f38 commit 4fbfc3e

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

styleguide/index.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,13 @@ title: O'Reilly Style Guide
206206
<p>Chapter: See Chapter 27.</p>
207207
</li>
208208
<li>
209-
<p>Section: See the section “Treatment”. (The text “on page x” will be added post-conversion, so the final xref will eventually read “Treatment” on page 37.) <strong>Treat section xrefs the same way throughout the book.</strong></p>
209+
<p>Section: See “Treatment” on page xx. (The text “on page xx” will be dynamic in Atlas, updating as page numbers change.)</p>
210+
</li>
211+
<li>
212+
<p>Figure: ...as shown in Figure 1-1.</p>
213+
</li>
214+
<li>
215+
<p>Sidebars: See “A Note for Mac Users” on page xx. (As with section xrefs, the page number will update automatically in Atlas.)</p>
210216
</li>
211217
</ul>
212218

@@ -327,7 +333,7 @@ title: O'Reilly Style Guide
327333
<section data-type="sect2" id="figures_tables_and_examples">
328334
<h2>Figures, Tables, and Examples</h2>
329335

330-
<p>Every 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.). Figures, tables, and examples should not be introduced with colons or phrases like “in the following figure,” or “as shown in this table.” Lack of specific in-text references may cause incorrect placement of figures.</p>
336+
<p>Every 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.). Figures, tables, and examples should not be introduced with colons or phrases like “in the following figure,” or “as shown in this table.” Lack of specific in-text references may cause incorrect placement of figures. <strgon>See <a href="cross_references">#cross_references</a> above for more detail on including cross references.</strong></p>
331337

332338
<div data-type="tip">
333339
<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>
@@ -1503,6 +1509,7 @@ title: O'Reilly Style Guide
15031509
<li>text box</li>
15041510
<li>text-input mode</li>
15051511
<li>thread pooling (n)</li>
1512+
<li><strong>timeout (in tech/computing contexts)</strong></li>
15061513
<li>time-sharing processes</li>
15071514
<li>timestamp</li>
15081515
<li>time zone</li>

0 commit comments

Comments
 (0)