Skip to content

Commit a8ed2a6

Browse files
authored
Update index.md
Clarifying wording about adding xrefs
1 parent f58f6b9 commit a8ed2a6

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

styleguide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ title: O'Reilly Style Guide
332332
<section data-type="sect2" id="figures_tables_and_examples">
333333
<h2>Figures, Tables, and Examples</h2>
334334

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

337337
<div data-type="tip">
338338
<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>

0 commit comments

Comments
 (0)