rstudio / rticles

LaTeX Journal Article Templates for R Markdown
https://pkgs.rstudio.com/rticles/
1.46k stars 516 forks source link

ieee_article() add journal support #375

Open Karel-Kroeze opened 3 years ago

Karel-Kroeze commented 3 years ago

Added support for IEEE journals (so far it only supported conference papers). This is primarily visible in the author/affiliations, and some minor other tweaks to the front page (e.g. , instead of ; in the keyword list).

I've also added ieee.csl and enabled it by default so that pandoc-style (@cite) citations are a viable alternative to the latex-style citations (\cite) that are currently enforced. Latex style citations should still work as before for those that desire them.

Note that there are a lot of IEEE flavours for its various journals, providing a one-size-fits-all template might be more trouble than it's worth.

CLAassistant commented 3 years ago

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

:white_check_mark: cderv
:x: FluffierThanThou
You have signed the CLA already but the status is still pending? Let us recheck it.

Karel-Kroeze commented 3 years ago

Hi @cderv,

Thank you for taking the time for the thorough review. As you may have noticed I have little experience with pandoc and the innards of rticles, but I've learned quite a few new things from your comments alone.

As for this PR. Honestly, my experience with IEEE requirements has been a nightmare. This template will not work with all journals, because many have exceptions to the 'main' IEEE template. The author guidelines are often confusing or plain self-contradictory. I crafted this template to fit the guidelines for IEEE transactions on Learning Technology, but still received comments on several deviations (I can't recall the details at the moment).

I'm not sure that a single template is ever going to be able to fit all IEEE journals, and any attempt is likely to be so full of special cases that it will be difficult to write, let alone maintain. IEEE covers a wide range of journals and conferences, and I do not have enough experience to make any statements about which is more common, or if the differences between journal guidelines are more structured than I perceived. If the template as it is works for conference papers, I would honestly suggest keeping it that way. In either case, I would urge waiting for reviews by the other contributors to this template.

Personally, I fell back on manually editing a Word (😱) render of my manuscript and the template provided by the journal, rather than trying to integrate IEEE's boutique set of latex dependencies into my bookdown and rticles workflow.

cderv commented 3 years ago

Thanks for the feedback !

From reading you ☝️, this makes me think that we could also provide a template for each journal. Something closer to other formats and THE ieee template but maybe one per journal. This would be something like ieee_article(journal="TLT") that would use a template for IEEE Transaction on Learning Technology that is known to have work. What do you think ?

Unless you really think this would still lead to a lot of editor feedbacks and it will be hard to help comply with rticle template.

We'll see if we'll have feedback from past contributors - it is possible we don't 😅

Also,

As you may have noticed I have little experience with pandoc and the innards of rticles, but I've learned quite a few new things from your comments alone.

Everyone starts with a few knowledge, but it surely grows with practice and contributing PR is one of them. We really appreciate contributing PR !! Thanks again.