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: README.md
+8-1Lines changed: 8 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -155,6 +155,8 @@ bookdown::gitbook:
155
155
156
156
#### Punctuation
157
157
- 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
+
158
160
#### Common typos to check for
159
161
- RMPSE: should be RMSPE
160
162
- boostrap: should be bootstrap
@@ -171,13 +173,18 @@ Generally the book uses American spelling. Some common British vs American and C
171
173
These are absolute last steps when rendering the PDF output:
172
174
- Look for and fix bad line breaks (e.g. with only one word on the next line, orphans, and widows)
173
175
- 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)
175
177
- Look for `??` in the PDF (broken refs)
178
+
- Look in the index for near-duplicates, and merge if needed
176
179
- Make sure the 3D figures (and the text around them that refers to clicking and dragging) are properly modified for the PDF output
177
180
- Make sure all markdown label-replaced URLs (of the form `[blah](url)`) will make
178
181
sense in the hardcopy book version (i.e. nothing like "click this"). Many links appear in the additional resources: make sure the
179
182
text-replacement of the URL contains enough information for someone to find the resource (without being able to click the link)
180
183
184
+
#### HTML Output
185
+
- Look for broken references (I *think* these end up as `??`)
186
+
- Look for uncentered images
187
+
181
188
## Updating the textbook data
182
189
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:
0 commit comments