Skip to content

Commit 21bd682

Browse files
committed
Count the abstract (addresses #13)
1 parent 6af4171 commit 21bd682

17 files changed

Lines changed: 387 additions & 104 deletions

README.md

Lines changed: 34 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -201,33 +201,47 @@ format:
201201
### Terminal output
202202
203203
The word count will appear in the terminal output when rendering the
204-
document. It shows multiple values:
204+
document. It shows multiple values across three sections:
205205
206-
- **Overall totals**: (1) the total count of everything, including the
207-
body, notes, references, and appendix sections, and (2) the count for
208-
just the body and notes.
206+
- **Manuscript totals**: (1) the count for the body, notes, and
207+
references, (2) the count for just the body and notes, and (3) if
208+
there’s an appendix, the count for the body, notes, references, and
209+
appendix.
209210
210211
The journals I typically work with count the body + notes + references
211212
towards the total word count. When shrinking manuscripts to fit word
212213
limits, I find it helpful to split the references count off from the
213214
body + notes so I can more easily see where edits might be most
214215
efficient (e.g. re-word sentences vs. remove references)
215216
216-
- **Individual section totals**: counts for the (1) text body, (2)
217-
notes, (3) references, and (4) appendix
217+
- **Specific totals**: counts for the (1) text body, (2) notes, (3)
218+
references, and (4) appendix
218219
219-
``` text
220-
Overall totals:
221-
--------------------------------
222-
- 451 total words
223-
- 378 words in body and notes
220+
- **Overall totals**: counts for (1) everything, including the abstract,
221+
and (2) the abstract by itself.
224222
225-
Section totals:
226-
--------------------------------
223+
The abstract total is included here because it’s rarely counted as
224+
part of the actual manuscript word limit itself, but still needs to be
225+
counted since it generally has its own separate word count.
226+
227+
``` text
228+
Manuscript totals:
229+
---------------------------------------------------
230+
- 458 words (text + notes + references)
231+
- 405 words (text + notes)
232+
- 478 words (text + notes + appendix + references)
233+
234+
Specific totals:
235+
---------------------------------------------------
227236
- 315 words in text body
228-
- 63 words in notes
229-
- 53 words in reference section
230-
- 20 words in appendix section
237+
- 90 words in notes
238+
- 53 words in references
239+
- 20 words in appendix
240+
241+
Overall totals:
242+
---------------------------------------------------
243+
- 484 words in entire document
244+
- 6 words in abstract
231245
```
232246
233247
### Shortcodes
@@ -249,8 +263,11 @@ counts directly in the document:
249263
250264
- Use `{{< words-note >}}` to include a count of the words in the notes
251265
266+
- Use `{{< words-abstract >}}` to include a count of the words in the
267+
abstract
268+
252269
- Use `{{< words-sum ARG >}}` where `ARG` is some concatenation of the
253-
four countable areas: `body`, `ref`, `append`, and `note`
270+
five countable areas: `body`, `ref`, `append`, `note`, and `abstract`
254271
255272
For example, `{{< words-sum body-note >}}` includes a count of the
256273
words in the body and notes; `{{< words-sum ref-append >}}` includes a

README.qmd

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -138,26 +138,36 @@ format:
138138

139139
### Terminal output
140140

141-
The word count will appear in the terminal output when rendering the document. It shows multiple values:
141+
The word count will appear in the terminal output when rendering the document. It shows multiple values across three sections:
142142

143-
- **Overall totals**: (1) the total count of everything, including the body, notes, references, and appendix sections, and (2) the count for just the body and notes.
143+
- **Manuscript totals**: (1) the count for the body, notes, and references, (2) the count for just the body and notes, and (3) if there's an appendix, the count for the body, notes, references, and appendix.
144144

145145
The journals I typically work with count the body + notes + references towards the total word count. When shrinking manuscripts to fit word limits, I find it helpful to split the references count off from the body + notes so I can more easily see where edits might be most efficient (e.g. re-word sentences vs. remove references)
146146

147-
- **Individual section totals**: counts for the (1) text body, (2) notes, (3) references, and (4) appendix
147+
- **Specific totals**: counts for the (1) text body, (2) notes, (3) references, and (4) appendix
148148

149-
```text
150-
Overall totals:
151-
--------------------------------
152-
- 451 total words
153-
- 378 words in body and notes
149+
- **Overall totals**: counts for (1) everything, including the abstract, and (2) the abstract by itself.
154150

155-
Section totals:
156-
--------------------------------
151+
The abstract total is included here because it's rarely counted as part of the actual manuscript word limit itself, but still needs to be counted since it generally has its own separate word count.
152+
153+
```text
154+
Manuscript totals:
155+
---------------------------------------------------
156+
- 458 words (text + notes + references)
157+
- 405 words (text + notes)
158+
- 478 words (text + notes + appendix + references)
159+
160+
Specific totals:
161+
---------------------------------------------------
157162
- 315 words in text body
158-
- 63 words in notes
159-
- 53 words in reference section
160-
- 20 words in appendix section
163+
- 90 words in notes
164+
- 53 words in references
165+
- 20 words in appendix
166+
167+
Overall totals:
168+
---------------------------------------------------
169+
- 484 words in entire document
170+
- 6 words in abstract
161171
```
162172

163173
### Shortcodes
@@ -174,7 +184,9 @@ There are also multiple shortcodes you can use to include different word counts
174184

175185
- Use `{{{< words-note >}}}` to include a count of the words in the notes
176186

177-
- Use `{{{< words-sum ARG >}}}` where `ARG` is some concatenation of the four countable areas: `body`, `ref`, `append`, and `note`
187+
- Use `{{{< words-abstract >}}}` to include a count of the words in the abstract
188+
189+
- Use `{{{< words-sum ARG >}}}` where `ARG` is some concatenation of the five countable areas: `body`, `ref`, `append`, `note`, and `abstract`
178190

179191
For example, `{{{< words-sum body-note >}}}` includes a count of the words in the body and notes; `{{{< words-sum ref-append >}}}` includes a count of the words in the references and appendix
180192

_extensions/wordcount/_extension.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
title: Quarto Word Count
22
authors:
33
- name: Andrew Heiss
4-
orcid: 0000-0003-1866-860X
4+
orcid: 0000-0002-3948-3914
55
- name: Justin Landis
66
orcid: 0000-0001-5501-4934
7-
version: 1.7.1
7+
version: 1.8.0
88
quarto-required: ">=1.4.551"
99
contributes:
1010
shortcodes:

0 commit comments

Comments
 (0)