Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ieee_article() add journal support #375

Open
wants to merge 32 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
dc3cd5c
initial changes. Is it my tex that is breaking numeric refs?
FluffierThanThou Feb 17, 2021
f6f6249
add IEEE abbreviations bib
FluffierThanThou Feb 22, 2021
03c4825
add IEEE csl, let pandoc sort out the citation mess
FluffierThanThou Feb 22, 2021
dfb06d2
default to using csl (pandoc) for citations instead of latex (bib[la]…
FluffierThanThou Feb 22, 2021
2414372
fix typos, cleanup docs.
FluffierThanThou Feb 24, 2021
1f398c3
add news line and contributor info
FluffierThanThou Feb 24, 2021
9edfd94
remove abbreviations bib file
FluffierThanThou Feb 24, 2021
5eec91b
Merge branch 'master' into Karel-Kroeze-master
cderv Nov 29, 2021
81120b3
Missing comma in description file
cderv Nov 29, 2021
fe30daf
Add the number_section default logic in the R function
cderv Nov 29, 2021
d73b061
Precise the message
cderv Nov 29, 2021
f9db267
Adapt skeleton to new journal mode toggling
cderv Nov 29, 2021
c5f4fb9
Move variable definition in function as it is supported
cderv Nov 29, 2021
2580457
comment out journal mode only YAML param
cderv Nov 29, 2021
c5e813d
Use the CSL as url
cderv Nov 29, 2021
a7020e5
Adapt the affiliation section
cderv Nov 29, 2021
365ead0
Show how to use the pandoc variable instead
cderv Nov 29, 2021
5bbead1
remove duplicate argument
cderv Nov 29, 2021
74c7d69
Support biblatexoption in template
cderv Nov 29, 2021
b68819a
Support citation_package explicitly
cderv Nov 29, 2021
ef6e881
Prevent pandoc error early regarding template syntax
cderv Nov 29, 2021
fe37892
remove empty line
cderv Nov 29, 2021
bdde76c
Update documentation
cderv Nov 29, 2021
5205bff
Update CSL ref part in template
cderv Nov 29, 2021
e44e93d
missing $ in template
cderv Nov 29, 2021
4965d54
Missing command in template
cderv Nov 29, 2021
5d5d9c5
Missing the negation in test
cderv Nov 29, 2021
52765e0
Add an example specific for Journal output in the template bundle
cderv Nov 29, 2021
0315917
Add special case for testing other demo file in bundle
cderv Nov 29, 2021
097e2d0
Update requirement as template requires 2.8
cderv Nov 29, 2021
baeb407
Use character version in pandoc_available()
cderv Nov 29, 2021
54e8118
Update NEWS and bump version
cderv Nov 30, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Authors@R: c(
person("Alfredo", "Hernández", role = c("ctb"), email = "[email protected]", comment = c(ORCID = "0000-0002-2660-4545")),
person("Christophe", "Dervieux", role = c("aut"), email = "[email protected]", comment = c(ORCID = "0000-0003-4474-2498")),
person("Stefano", "Coretta", role = c("ctb"), email = "[email protected]", comment = c(ORCID = "0000-0001-9627-5532", github = "stefanocoretta"))
person("Karel", "Kroeze", role = c("ctb"), email = "[email protected]" comment = c(ORCID = "0000-0002-7000-7377", github = "karel-kroeze"))
cderv marked this conversation as resolved.
Show resolved Hide resolved
)
Description: A suite of custom R Markdown formats and templates for
authoring journal articles and conference submissions.
Expand Down
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
- `ieee_article()` now supports both conference papers and journal articles (thanks, @Karel-Kroeze).
cderv marked this conversation as resolved.
Show resolved Hide resolved

rticles 0.19
---------------------------------------------------------------------
- Update Copernicus Publications template to version 6.2 from 2021-01-15 (thanks, @RLumSK, #366).
Expand Down
5 changes: 3 additions & 2 deletions R/ieee_article.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
#' Format for creating submissions to IEEE Transaction journals. Adapted from
#' \url{http://www.ieee.org/publications_standards/publications/authors/author_templates.html}.
#'
#' Presently, only the \code{"conference"} paper mode offered by the
#' \code{IEEEtran.cls} is supported.
#' Presently, only the \code{"conference"} paper mode offered by
#' \code{IEEEtran.cls} is fully supported, with experimental support for the
#' \code{"journal"} mode.
cderv marked this conversation as resolved.
Show resolved Hide resolved
#'
#' @inheritParams rmarkdown::pdf_document
#' @param draftmode Specify the draft mode to control spacing and whether images
Expand Down
42 changes: 29 additions & 13 deletions inst/rmarkdown/templates/ieee/resources/template.tex
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,11 @@
% The testflow support page is at:
% http://www.michaelshell.org/tex/testflow/

\documentclass[conference,$if(fontsize)$$fontsize$,$endif$$if(draftmode)$$draftmode$,$endif$$if(papersize)$$papersize$,$endif$$for(classoption)$$classoption$$sep$,$endfor$]{IEEEtran}
% *** rticle changes for journal/conference mode.
% adding journal as an override for conference mode to maintain backwards
% compatibility. Any future expansions to further modes will have to come up with
% a cleverer solution, or introduce breaking changes.
\documentclass[$if(journal)$journal$else$conference$endif$,$if(fontsize)$$fontsize$,$endif$$if(draftmode)$$draftmode$,$endif$$if(papersize)$$papersize$,$endif$$for(classoption)$$classoption$$sep$,$endfor$]{IEEEtran}
cderv marked this conversation as resolved.
Show resolved Hide resolved
% Some Computer Society conferences also require the compsoc mode option,
% but others use the standard conference format.
%
Expand Down Expand Up @@ -382,9 +386,11 @@
breaklinks=true}
\urlstyle{same} % don't use monospace font for urls

% Pandoc toggle for numbering sections (defaults to be off)
% Pandoc toggle for numbering sections (defaults to be off in conference, on in journal)
$if(numbersections)$
\setcounter{secnumdepth}{$if(secnumdepth)$$secnumdepth$$else$5$endif$}
$elseif(journal)$
\setcounter{secnumdepth}{$if(secnumdepth)$$secnumdepth$$else$5$endif$}
cderv marked this conversation as resolved.
Show resolved Hide resolved
$else$
\setcounter{secnumdepth}{0}
$endif$
Expand Down Expand Up @@ -447,6 +453,24 @@
% Do not put math or special symbols in the title.
\title{$title$}


% split author affiliations for journal and conference layouts
$if(journal)$

$if(affiliation.author)$
\author{
$for(affiliation.author)$$if(it.last)$and $endif$$it.name$$if(it.member)$, \IEEEmembership{$it.member$}$endif$$sep$, $endfor$
$if(affiliation.thanks)$$for(affiliation.thanks)$\thanks{$affiliation.thanks$}$endfor$$endif$
}
cderv marked this conversation as resolved.
Show resolved Hide resolved
$else$
$~$!!! Only 'affiliation.author' is supported for the journal mode.$~$
$endif$
cderv marked this conversation as resolved.
Show resolved Hide resolved

\markboth{$journal$$~$, Vol. XX, No. X, XXXXXX 20XX$~$}%
{$title$}

$else$ % -- end if/journal
cderv marked this conversation as resolved.
Show resolved Hide resolved

% author names and affiliations
% use a multiple column layout for up to three different
% affiliations
Expand Down Expand Up @@ -563,6 +587,8 @@
$endif$
}

$endif$ %% -- end else/journal

% conference papers do not typically use \thanks and this command
% is locked out in conference mode. If really needed, such as for
% the acknowledgment of grants, issue a \IEEEoverridecommandlockouts
Expand All @@ -586,14 +612,6 @@
%\IEEEauthorblockA{\IEEEauthorrefmark{4}Tyrell Inc., 123 Replicant Street, Los Angeles, California 90210--4321}}




% use for special paper notices
%\IEEEspecialpapernotice{(Invited Paper)}




% make the title area
\maketitle

Expand All @@ -606,7 +624,7 @@
% keywords
$if(keywords)$
\begin{IEEEkeywords}
$for(keywords)$$keywords$$sep$; $endfor$
$for(keywords)$$keywords$$sep$$if(journal)$, $else$; $endif$$endfor$
cderv marked this conversation as resolved.
Show resolved Hide resolved
\end{IEEEkeywords}
$endif$

Expand Down Expand Up @@ -661,5 +679,3 @@

$endfor$
\end{document}


Loading