diff --git a/DESCRIPTION b/DESCRIPTION index 9c0ab36..7e64c4d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: quarto-wordcount Title: Counts Words in Quarto Documents -Version: 1.2.0 +Version: 1.3.0 License: MIT + file LICENSE Encoding: UTF-8 Imports: diff --git a/README.md b/README.md index f7c98e7..8da06f6 100644 --- a/README.md +++ b/README.md @@ -113,15 +113,33 @@ format: ### Terminal output The word count will appear in the terminal output when rendering the -document. It shows multiple values: (1) the total count, (2) the count -for the document sans references, and (3) the count for the reference -list alone. +document. It shows multiple values: + +- **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. + + 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) + +- **Individual section totals**: counts for the (1) text body, (2) + notes, (3) references, and (4) appendix ``` text -133 total words ------------------------------ -76 words in text body -57 words in reference section +Overall totals: +-------------------------------- +• 451 total words +• 378 words in body and notes + +Section totals: +-------------------------------- +• 315 words in text body +• 63 words in notes +• 53 words in reference section +• 20 words in appendix section ``` ### Shortcodes @@ -154,7 +172,7 @@ You can use shortcodes in your YAML metadata too: ``` yaml title: Something -subtitle: "{{< words-total >}} words" +subtitle: "{{< words-sum body-note-ref >}} words" ``` ### Appendices @@ -192,14 +210,6 @@ More words here ::: ``` -That will create this word count: - - 5 in the main text + references, with 4 in the appendix - ------------------------------------------------------- - 5 words in text body - 0 words in reference section - 4 words in appendix section - ## Example You can see a minimal sample document at [`template.qmd`](template.qmd). diff --git a/README.qmd b/README.qmd index 5308743..8861fcd 100644 --- a/README.qmd +++ b/README.qmd @@ -71,13 +71,26 @@ format: ### Terminal output -The word count will appear in the terminal output when rendering the document. It shows multiple values: (1) the total count, (2) the count for the document sans references, and (3) the count for the reference list alone. +The word count will appear in the terminal output when rendering the document. It shows multiple values: + +- **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. + + 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) + +- **Individual section totals**: counts for the (1) text body, (2) notes, (3) references, and (4) appendix ```text -133 total words ------------------------------ -76 words in text body -57 words in reference section +Overall totals: +-------------------------------- +• 451 total words +• 378 words in body and notes + +Section totals: +-------------------------------- +• 315 words in text body +• 63 words in notes +• 53 words in reference section +• 20 words in appendix section ``` ### Shortcodes @@ -127,16 +140,6 @@ More words here ::: ```` -That will create this word count: - -``` -5 in the main text + references, with 4 in the appendix -------------------------------------------------------- -5 words in text body -0 words in reference section -4 words in appendix section -``` - ## Example diff --git a/_extensions/wordcount/_extension.yml b/_extensions/wordcount/_extension.yml index 9bdf618..a987279 100644 --- a/_extensions/wordcount/_extension.yml +++ b/_extensions/wordcount/_extension.yml @@ -4,7 +4,7 @@ authors: orcid: 0000-0003-1866-860X - name: Justin Landis orcid: 0000-0001-5501-4934 -version: 1.2.0 +version: 1.3.0 quarto-required: ">=1.3.0" contributes: shortcodes: