Skip to content

Commit e8e6c99

Browse files
LightArrowsEXELightArrowsEXE
committed
Editing: Minor edits, abuse admonitions
1 parent 2120fe1 commit e8e6c99

File tree

1 file changed

+179
-140
lines changed

1 file changed

+179
-140
lines changed

‎docs/guidelines/editing.md

Lines changed: 179 additions & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -26,94 +26,117 @@ but some groups such as Kaleido use British English for its subtitles.
2626

2727
!!! Note "Consistency"
2828
British English is more flexible in which spellings you can use,
29-
as it's not uncommon for both spellings to be accepted.
29+
as it's not uncommon for both spellings to be commonly accepted.
3030
However,
3131
you should strive to keep your spelling consistent throughout the project.
3232

3333
Below is a quick overview of some common differences between British and American English.
3434

35-
=== "-ise/-ize"
36-
37-
British English spellings often end in "-ise"[^endings] while American English uses "-ize":
38-
39-
- Fantasise / Fantasize
40-
- Apologise / Apologize
41-
- Recognise / Recognize
42-
- Realise, Realisation / Realize, Realization
43-
- Organise, Organisation / Organize, Organization
44-
- Customise, Customisation / Customize, Customization
45-
46-
=== "ou/o"
47-
48-
British English often uses "ou" where American English uses "o":
49-
50-
- Colour / Color
51-
- Favourite / Favorite
52-
- Rumour / Rumor
53-
- Neighbour / Neighbor
54-
- Labour / Labor
55-
56-
=== "-re/-er"
57-
58-
British English often ends words with "-re" while American English uses "-er":
59-
60-
- Centre / Center
61-
- Theatre / Theater[^theatre]
62-
- Metre / Meter
63-
- Calibre / Caliber
64-
- Fibre / Fiber
65-
- Litre / Liter
66-
67-
=== "ll/l"
68-
69-
British English often doubles the "l" where American English uses a single "l":
70-
71-
- Travelling / Traveling
72-
- Fuelling / Fueling
73-
- Cancelled / Canceled
74-
- Marvelling / Marveling
75-
- Signalling / Signaling
76-
- Labelling / Labeling
77-
78-
=== "-ce/-se"
79-
80-
British English often uses "-ce" where American English uses "-se":
81-
82-
- Defence / Defense
83-
- Offence / Offense
84-
- Licence / License
85-
- Pretence / Pretense
86-
- Practise (verb), Practice (noun) / Practice (both verb and noun)
87-
- Advice (noun), Advise (verb) / Advice (noun), Advise (verb)
88-
89-
=== "-ogue/-og"
90-
91-
British English often ends words with "-ogue" while American English uses "-og":
92-
93-
- Analogue / Analog
94-
- Dialogue / Dialog
95-
- Prologue / Prolog
96-
- Catalogue / Catalog
97-
- Monologue / Monolog
98-
- Pedagogue / Pedagog
99-
100-
=== "Other words"
101-
102-
Other spelling differences:
103-
104-
- Enrol / Enroll
105-
- Programme (TV and radio), Program (computer) / Program (all uses)
106-
- Jewellery / Jewelry
107-
- Plough / Plow
108-
- Aluminium / Aluminum
109-
- Draught / Draft
110-
- Tyre / Tire
111-
- Sceptical / Skeptical
112-
- Ageing / Aging
113-
- Cosy / Cozy
114-
- Maths / Math
115-
- Lorry / Truck
116-
- Lift / Elevator
35+
!!! Example "Differences between British and American English"
36+
37+
=== "-ise/-ize"
38+
39+
!!! Note "Spelling differences"
40+
British English spellings often end in "-ise",
41+
while American English uses "-ize":
42+
The spelling "-ize" is also often accepted in British English,
43+
but required in American English.
44+
45+
| British English | American English |
46+
|------------------------------|------------------------------|
47+
| Fantasise | Fantasize |
48+
| Apologise | Apologize |
49+
| Recognise | Recognize |
50+
| Realise, Realisation | Realize, Realization |
51+
| Organise, Organisation | Organize, Organization |
52+
| Customise, Customisation | Customize, Customization |
53+
54+
=== "ou/o"
55+
56+
!!! Note "Spelling differences"
57+
British English often uses "ou" where American English uses "o":
58+
59+
| British English | American English |
60+
|-----------------|-------------------|
61+
| Colour | Color |
62+
| Favourite | Favorite |
63+
| Rumour | Rumor |
64+
| Neighbour | Neighbor |
65+
| Labour | Labor |
66+
67+
=== "-re/-er"
68+
69+
!!! Note "Spelling differences"
70+
British English often ends words with "-re" while American English uses "-er":
71+
72+
| British English | American English |
73+
|-----------------|-------------------|
74+
| Centre | Center |
75+
| Theatre | Theater[^theatre] |
76+
| Metre | Meter |
77+
| Calibre | Caliber |
78+
| Fibre | Fiber |
79+
| Litre | Liter |
80+
81+
=== "ll/l"
82+
83+
!!! Note "Spelling differences"
84+
British English often doubles the "l" where American English uses a single "l":
85+
86+
| British English | American English |
87+
|-----------------|-------------------|
88+
| Travelling | Traveling |
89+
| Fuelling | Fueling |
90+
| Cancelled | Canceled |
91+
| Marvelling | Marveling |
92+
| Signalling | Signaling |
93+
| Labelling | Labeling |
94+
95+
=== "-ce/-se"
96+
97+
!!! Note "Spelling differences"
98+
British English often uses "-ce" where American English uses "-se":
99+
100+
| British English | American English |
101+
|--------------------------------------|--------------------------------------|
102+
| Defence | Defense |
103+
| Offence | Offense |
104+
| Licence | License |
105+
| Pretence | Pretense |
106+
| Practise (verb), Practice (noun) | Practice (both verb and noun) |
107+
| Advice (noun), Advise (verb) | Advice (noun), Advise (verb) |
108+
109+
=== "-ogue/-og"
110+
111+
!!! Note "Spelling differences"
112+
British English often ends words with "-ogue" while American English uses "-og":
113+
114+
| British English | American English |
115+
|-----------------|-------------------|
116+
| Analogue | Analog |
117+
| Dialogue | Dialog |
118+
| Prologue | Prolog |
119+
| Catalogue | Catalog |
120+
| Monologue | Monolog |
121+
| Pedagogue | Pedagog |
122+
123+
=== "Other words"
124+
125+
| British English | American English |
126+
|------------------------------------------------|-------------------------|
127+
| Enrol | Enroll |
128+
| Programme (TV and radio), Program (computer) | Program (all uses) |
129+
| Jewellery | Jewelry |
130+
| Plough | Plow |
131+
| Aluminium | Aluminum |
132+
| Draught | Draft |
133+
| Tyre | Tire |
134+
| Sceptical | Skeptical |
135+
| Ageing | Aging |
136+
| Cosy | Cozy |
137+
| Maths | Math |
138+
| Lorry | Truck |
139+
| Lift | Elevator |
117140

118141
Besides dialect differences,
119142
there are a couple other spelling rules that are worth noting:
@@ -155,24 +178,27 @@ as punctuation rules and styles vary greatly between languages.
155178

156179
The use of quotation marks varies between British and American English,
157180

158-
=== "British English"
159181

160-
- Double quotation marks are used when quoting,
161-
and single marks are used when quoting within quotes.
162-
- If the punctuation is part of the quoted material,
163-
it goes inside the quotation marks.
164-
If not,
165-
it goes outside.
166-
- Exclamation and question marks are placed inside the quotation marks if they are part of the quoted material,
167-
otherwise they are placed outside.
182+
!!! Example "Differences between British and American English"
183+
184+
=== "British English"
185+
186+
- Double quotation marks are used when quoting,
187+
and single marks are used when quoting within quotes.
188+
- If the punctuation is part of the quoted material,
189+
it goes inside the quotation marks.
190+
If not,
191+
it goes outside.
192+
- Exclamation and question marks are placed inside the quotation marks if they are part of the quoted material,
193+
otherwise they are placed outside.
168194

169-
=== "American English"
195+
=== "American English"
170196

171-
- Double quotation marks are used when quoting,
172-
and single marks are used when quoting within quotes.
173-
- Periods and commas are always placed inside the quotation marks,
197+
- Double quotation marks are used when quoting,
198+
and single marks are used when quoting within quotes.
199+
- Periods and commas are always placed inside the quotation marks,
174200
even if they are not part of the original quoted material.
175-
- Exclamation and question marks are placed inside the quotation marks if they are part of the quoted material,
201+
- Exclamation and question marks are placed inside the quotation marks if they are part of the quoted material,
176202
otherwise they are placed outside.
177203

178204
### Abbreviated titles
@@ -209,11 +235,11 @@ if they find out later.
209235
Numbers should be spelled out whenever reasonably possible,
210236
and if the characters-per-second (CPS) allows for it.
211237

212-
| Number | Spelled Out |
213-
| ------ | ------------------------ |
214-
| 36 | Thirty-six |
215-
| 100 | One hundred / A hundred |
216-
| 991 | Nine hundred ninety-one |
238+
| Number | Spelled Out |
239+
| ------ | ----------------------- |
240+
| 36 | Thirty-six |
241+
| 100 | One hundred / A hundred |
242+
| 991 | Nine hundred ninety-one |
217243

218244
!!! Abstract "Chicago Manual of Style"
219245
The [Chicago Manual of Style](https://www.chicagomanualofstyle.org/) has the following rules for numbers:
@@ -279,61 +305,75 @@ and should be avoided.
279305
Below are a few examples of garden-pathing,
280306
and how you may go about rewriting them[^gardenpath].
281307

282-
=== "Example A"
308+
!!! Example "Garden-pathing"
309+
=== "Example A"
283310

284-
!!! quote Example
285-
"The horse raced past the barn fell."
311+
!!! Quote "Example Sentence"
312+
"The horse raced past the barn fell."
286313

287-
**Explanation:** The reader initially assumes the horse is "racing past the barn",
288-
but the sentence actually means that the horse _was_ raced past the barn,
289-
and then it fell.
314+
!!! abstract "Explanation"
315+
The reader initially assumes the horse is "racing past the barn",
316+
but the sentence actually means that the horse _was_ raced past the barn,
317+
and then it fell.
290318

291-
**Rewritten:** "The horse that was raced past the barn fell."
319+
!!! note "Rewritten"
320+
"The horse that was raced past the barn fell."
292321

293-
**Why it's better:** Adding "that was" clarifies the relationship between the horse and the action of falling.
322+
!!! abstract "Explanation"
323+
Adding "that was" clarifies the relationship between the horse and the action of falling.
294324

295-
=== "Example B"
325+
=== "Example B"
296326

297-
!!! quote Example
298-
"The man who hunts ducks out on weekends."
327+
!!! Quote "Example Sentence"
328+
"The man who hunts ducks out on weekends."
299329

300-
**Explanation:** The reader initially assumes the sentence means that the old man "hunts ducks (the birds) out on weekends",
301-
but "ducks out" is actually the verb "to duck out" (i.e. leave or avoid something).
330+
!!! abstract "Explanation"
331+
The reader initially assumes the sentence means that the old man "hunts ducks (the birds) out on weekends",
332+
but "ducks out" is actually the verb "to duck out" (i.e. leave or avoid something).
302333

303-
**Rewritten:** "The man who hunts hides out on weekends."
334+
!!! note "Rewritten"
335+
"The man who hunts hides out on weekends."
304336

305-
**Why it's better:** Changing the verb to "hides" makes it clear that the old man is trying to avoid something
306-
while avoiding the misunderstanding that he's hunting a specific animal on weekends.
337+
!!! abstract "Explanation"
338+
Changing the verb to "hides" makes it clear that the old man is trying to avoid something
339+
while avoiding the misunderstanding that he's hunting a specific animal on weekends.
307340

308-
=== "Example C"
341+
=== "Example C"
309342

310-
!!! quote Example
311-
"The prime number few."
343+
!!! Quote "Example Sentence"
344+
"The prime number few."
312345

313-
**Explanation**: The reader initially assumes that "the prime number" is the subject of the sentence,
314-
as in discussing a specific number (maths),
315-
but the sentence is actually referring to a small number of prime people.
316-
The "few" does not logically connect to "the prime number" when read sequentially.
346+
!!! abstract "Explanation"
347+
The reader initially assumes that "the prime number" is the subject of the sentence,
348+
as in discussing a specific number (maths),
349+
but the sentence is actually referring to a small number of prime people.
350+
The "few" does not logically connect to "the prime number" when read sequentially.
317351

318-
**Rewritten:** "The few prime individuals." or "The number of prime individuals is few."
352+
!!! note "Rewritten"
353+
- "The few prime individuals."
354+
- "The number of prime individuals is few."
319355

320-
**Why it's better:** Adding "individuals" makes it clear that the sentence is referring to a group of people.
356+
!!! abstract "Explanation"
357+
Adding "individuals" makes it clear that the sentence is referring to a group of people.
321358

322-
=== "Example D"
359+
=== "Example D"
323360

324-
!!! quote Example
325-
"While the girl sang the song pleased everyone."
361+
!!! Quote "Example Sentence"
362+
"While the girl sang the song pleased everyone."
326363

327-
**Explanation:** The reader initially assumes that "the girl sang the song",
328-
but the sentence is actually saying that the song pleased everyone while the girl sang.
364+
!!! abstract "Explanation"
365+
The reader initially assumes that "the girl sang the song",
366+
but the sentence is actually saying that the song pleased everyone while the girl sang.
329367

330-
**Rewritten:** "The song pleased everyone while the girl sang." or "As the girl was singing, the song pleased everyone." or "While the girl sang, the song pleased everyone."
368+
!!! note "Rewritten"
369+
- "The song pleased everyone while the girl sang."
370+
- "As the girl was singing, the song pleased everyone."
371+
- "While the girl sang, the song pleased everyone."
331372

332-
**Why it's better:**<br>
333-
⠀⠀⠀⠀- The first sentence clarifies that the song is the subject that pleased everyone<br>
334-
⠀⠀⠀⠀⠀and that the girl was singing during that time.<br>
335-
⠀⠀⠀⠀- The second makes the timing clearer by indicating an ongoing action.<br>
336-
⠀⠀⠀⠀- The third splits the clauses, separating "sang" and "the song".<br>
373+
!!! abstract "Explanation"
374+
- The first sentence clarifies that the song is the subject that pleased everyone<br>
375+
- The second makes the timing clearer by indicating an ongoing action.<br>
376+
- The third splits the clauses, separating "sang" and "the song".<br>
337377

338378
As illustrated above,
339379
there are a variety of ways to rewrite sentences to avoid garden-pathing:
@@ -373,6 +413,5 @@ there are a variety of ways to rewrite sentences to avoid garden-pathing:
373413

374414
## Other Things of Note
375415

376-
[^endings]: "-ize" is also often accepted in British English, but required in American English.
377-
[^theatre]: In some cases, "theatre" may still be used in American English, where a "theat*er*" is a venue you visit to watch plays, and "theat*re*" is the performance-driven art form.
416+
[^theatre]: In some cases, "theatre" may still be used in American English, where a "theat*re*" is a venue you visit to watch plays, and "theat*er*" is the performance-driven art form.
378417
[^gardenpath]: Most of these examples are taken from [this paper](https://pdfs.semanticscholar.org/260d/3b53b1376b5cd30881bbd3ce2472af507adc.pdf).

0 commit comments

Comments
 (0)