Skip to content

Commit 4625cf0

Browse files
added more style guide items
1 parent 2cbd536 commit 4625cf0

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,8 @@ bookdown::gitbook:
155155

156156
#### Punctuation
157157
- emdashes should have no surrounding spaces. `This kind of typesetting—which is awesome—is correct!` and `Typesetting with spaces around em-dashes — which is bad — is not correct`
158+
- make sure `\index` commands don't break punctuation spacing. E.g. `This is an item \index{item}; it is good` will typeset with an erroneous space after item, i.e. `This is an item ; it is good`
159+
158160
#### Common typos to check for
159161
- RMPSE: should be RMSPE
160162
- boostrap: should be bootstrap
@@ -171,13 +173,18 @@ Generally the book uses American spelling. Some common British vs American and C
171173
These are absolute last steps when rendering the PDF output:
172174
- Look for and fix bad line breaks (e.g. with only one word on the next line, orphans, and widows)
173175
- Look for and fix bad line wraps in code and text
174-
- Look for and fix bad figure placement
176+
- Look for and fix bad figure placement (falling off page, going over the side)
175177
- Look for `??` in the PDF (broken refs)
178+
- Look in the index for near-duplicates, and merge if needed
176179
- Make sure the 3D figures (and the text around them that refers to clicking and dragging) are properly modified for the PDF output
177180
- Make sure all markdown label-replaced URLs (of the form `[blah](url)`) will make
178181
sense in the hardcopy book version (i.e. nothing like "click this"). Many links appear in the additional resources: make sure the
179182
text-replacement of the URL contains enough information for someone to find the resource (without being able to click the link)
180183

184+
#### HTML Output
185+
- Look for broken references (I *think* these end up as `??`)
186+
- Look for uncentered images
187+
181188
## Updating the textbook data
182189
Data sets are collected and curated by `data/retrieve_data.ipynb`. To run that notebook in the Docker container type the following in the terminal:
183190

0 commit comments

Comments
 (0)