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
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,6 +74,11 @@ The same comments regarding passwords and `sudo` as above apply here.
74
74
- make sure we have permission to use all external resources that we use
75
75
- remove all references to "clicking on things" in the HTML version of the book (e.g. "click this link to ...")
76
76
- When we introduce a new term, use `**bolding**` to typeset it (but only the first introduction of the term)
77
+
- for symbols as part of the text, make sure you give them their full name and surround with parentheses so that they
78
+
don't "disappear" in the rest of the text. So for example, if I have a `,` in the text, I should do
79
+
something like "here is some text about the comma (`,`)". Or for `<-`, we should do "something like this assignment operator (`<-`)".
80
+
There are likely exceptions to this rule though.
81
+
- Book titles in the text should be typeset in italics (e.g. *R for Data Science*)
77
82
78
83
#### Code blocks
79
84
- Use the knitr label format `##-[name with only alphanumeric + hyphens]` where
@@ -131,6 +136,7 @@ bookdown::gitbook:
131
136
#### Tables
132
137
- make sure all tables get capitalized labels ("Table \\@ref(blah)", not "table below" or "table above")
133
138
- make sure all tables get captions
139
+
- make sure the row + column spacing is reasonable
134
140
135
141
#### Note boxes
136
142
- note boxes should be typeset as quote boxes using `>` and start with **Note:**
@@ -149,7 +155,8 @@ bookdown::gitbook:
149
155
- data frame (not dataframe)
150
156
- data set (not dataset)
151
157
- scatter plot (not scatterplot)
152
-
- capitalize all initialisms and acronyms (URL not url, API not api, $K$-NN not $k$-nn)
158
+
- bar plot (not bar chart)
159
+
- capitalize all initialisms and acronyms (URL not url, API not api, K-NN not k-nn)
153
160
- response variable (not target, output, label)
154
161
- predictor variable (not explanatory, feature)
155
162
- numerical variable (not quantitative variable)
@@ -176,8 +183,11 @@ These are absolute last steps when rendering the PDF output:
176
183
- Look for and fix bad line breaks (e.g. with only one word on the next line, orphans, and widows)
177
184
- Look for and fix bad line wraps in code and text
178
185
- Look for and fix bad figure placement (falling off page, going over the side)
186
+
- Look for and fix large whitespace sections where LaTeX doesn't want to break the next paragraph (usually `\allowdisplaybreaks` helps)
187
+
- Fix incorrect indenting. LaTeX will indent for a new paragraph if there is an extra whitespace line, so these should be deleted if no paragraph break is desired.
179
188
- Look for `??` in the PDF (broken refs)
180
189
- Look in the index for near-duplicates, and merge if needed
190
+
- Look for / fix raw LaTeX code (search for backslash and curly brace in the final PDF)
181
191
- Make sure the 3D figures (and the text around them that refers to clicking and dragging) are properly modified for the PDF output
182
192
- Make sure all markdown label-replaced URLs (of the form `[blah](url)`) will make
183
193
sense in the hardcopy book version (i.e. nothing like "click this"). Many links appear in the additional resources: make sure the
0 commit comments