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
Copy file name to clipboardExpand all lines: styleguide/index.md
+9-2Lines changed: 9 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -206,7 +206,13 @@ title: O'Reilly Style Guide
206
206
<p>Chapter: See Chapter 27.</p>
207
207
</li>
208
208
<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>
<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 <ahref="cross_references">#cross_references</a> above for more detail on including cross references.</strong></p>
331
337
332
338
<divdata-type="tip">
333
339
<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
1503
1509
<li>text box</li>
1504
1510
<li>text-input mode</li>
1505
1511
<li>thread pooling (n)</li>
1512
+
<li><strong>timeout (in tech/computing contexts)</strong></li>
0 commit comments