wjschne / apaquarto

A quarto extension for creating APA7 documents in .docx, .html, and .pdf formats
https://wjschne.github.io/apaquarto/
Creative Commons Zero v1.0 Universal
163 stars 13 forks source link

Minor things #27

Closed DominiqueMakowski closed 8 months ago

DominiqueMakowski commented 9 months ago

Hey, just wanted to mention a few little potential improvements :)

  1. In jou mode, increase space between authors and affiliations (and make affiliations smaller)

For comparison, this is papaja:

image

And here apaquarto

image


  1. Make the title bold (see above) looks arguably better

  1. Clean-up the repo

A few images are lying at the base of the repo, which makes it look slightly messy (an orcid image, a badge etc.). I would recommend either removing them if possible (badges are typically directly copied from a shield.io URL, and for the Orcid I think there is another image under /_extensions/) or putting them in an "/img/" or "/assets/" folder.

There is also an empty .R file that should be removed


  1. I would add a screenshot of a rendered PDF / Word and put it in the README to give users an illustration of what the "final product" looks like.

  1. Restart line numbering (#25) at the beginning of body so that the line numbers don't change depending on whether it is masked or not

  1. jou mode has this "ADD LEFTHEADER COMMAND" showing, not sure if that's expected

image


  1. Add the option to add the OrcID logo after the affiliation number in the author list; e.g.,

image

There seems to be a trend for that amongst most publishers.


  1. Put the fontsize default value as a character "12pt" to avoid lintr syntax warning

image


  1. Currently there are a lot of boolean variables to change the font type (hrlv, tt, etc.), and it makes it slightly confusing. I wonder if it would be helpful to streamline all that with a character argument; e.g., fonttype: "typewriter"

I'd be happy to take a stab at some of it but I have no idea where to edit the template...

wjschne commented 8 months ago

Thanks for the thorough suggestions. They have made this extension much better.

  1. In jou mode, increase space between authors and affiliations (and make affiliations smaller)

This is governed by the apa7 package. APA journals in practice have a variety of formats for the title page. It appears that the apa7 package's small space does in fact mimic the Journal of Educational Psychology as it claims to. See this example.

The papaja package follows the APA 6th Edition format. I am not sure if the extra space was required at the time.

If you think a spacing option should be included, let me know.

For comparison, this is papaja:

  1. Make the title bold (see above) looks arguably better

The problem was that the Times font was not loading and Computer Modern's regular face looks thin compared to that of Times. I think I have fixed the problem. If you think a bold option should be included, let me know.

  1. Clean-up the repo

A few images are lying at the base of the repo, which makes it look slightly messy (an orcid image, a badge etc.). I would recommend either removing them if possible (badges are typically directly copied from a shield.io URL, and for the Orcid I think there is another image under /_extensions/) or putting them in an "/img/" or "/assets/" folder.

I have replaced the orcid image with a better one. I have removed the badge and use shield.io instead. I need the orcid image in the /_extensions/ folder to create HTML documents.

There is also an empty .R file that should be removed

Removed.

  1. I would add a screenshot of a rendered PDF / Word and put it in the README to give users an illustration of what the "final product" looks like.

Great idea. Done.

  1. Restart line numbering (Numbered lines #25) at the beginning of body so that the line numbers don't change depending on whether it is masked or not

Done.

  1. jou mode has this "ADD LEFTHEADER COMMAND" showing, not sure if that's expected

Done.

  1. Add the option to add the OrcID logo after the affiliation number in the author list; e.g.,

This is done by the apa7 package. I am not sure how to override it.

  1. Put the fontsize default value as a character "12pt" to avoid lintr syntax warning

Done.

  1. Currently there are a lot of boolean variables to change the font type (hrlv, tt, etc.), and it makes it slightly confusing. I wonder if it would be helpful to streamline all that with a character argument; e.g., fonttype: "typewriter"

I agree that it is confusing. The options come straight from the apa7 package. I was not really sure why so many options exist, so I was reluctant to mess with it. If you have suggestions for a complete implementation, l am open to ideas.