Skip to content

Commit 538410b

Browse files
desautmjjallaire
authored andcommitted
Add a template for *Bulletin de l'AMQ*. (#145)
* Added directory for Bulletin AMQ * First try for AMQ template * Template Bulletin AMQ presque complet * Modified Readme * Created some .tex files * I don't know how a YAML works! * Add README * Ajout du README * Modified the README * Uncommented testthat
1 parent eac2005 commit 538410b

File tree

20 files changed

+723
-5
lines changed

20 files changed

+723
-5
lines changed

DESCRIPTION

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Authors@R: c(
2222
person("Oliver", "Keyes", role = c("aut", "cph"), email = "okeyes@wikimedia.org"),
2323
person("Miao", "Yu", role = c("aut", "cph"), email = "yufreecas@gmail.com"),
2424
person("Daniel", "Emaasit", role = c("aut", "cph"), email = "daniel.emaasit@gmail.com"),
25-
person("Thierry", "Onkelinx", role = c("aut", "cph"), email = "thierry.onkelinx@inbo.be")
25+
person("Thierry", "Onkelinx", role = c("aut", "cph"), email = "thierry.onkelinx@inbo.be"),
26+
person("Marc-Andre", "Desautels", role = c("aut", "cph"), email = "marc-andre.desautels@cstjean.qc.ca")
2627
)
2728
Description: A suite of custom R Markdown formats and templates for
2829
authoring journal articles and conference submissions.

NAMESPACE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
export(acm_article)
44
export(acs_article)
55
export(aea_article)
6+
export(amq_article)
67
export(ams_article)
78
export(asa_article)
89
export(ctex)

R/amq_article.R

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
#' Format pour Bulletin de l'AMQ.
2+
#'
3+
#' Ce format a été adapté du format du bulletin de l'AMQ
4+
#'
5+
#' @inheritParams rmarkdown::pdf_document
6+
#' @param ... Arguments to \code{rmarkdown::pdf_document}
7+
#' @return R Markdown output format to pass to \code{\link[rmarkdown:render]{render}}
8+
#' @examples
9+
#' \dontrun{
10+
#' rmarkdown::draft("MyArticle.Rmd", template = "amq_article", package = "rticles")
11+
#' }
12+
#'
13+
#' @export
14+
amq_article <- function(...,
15+
latex_engine = 'xelatex',
16+
keep_tex = TRUE,
17+
md_extensions = c("-autolink_bare_uris"),
18+
fig_caption = TRUE){
19+
pdf_document_format(...,
20+
latex_engine = latex_engine,
21+
highlight = NULL,
22+
keep_tex = keep_tex,
23+
md_extensions = md_extensions,
24+
format = "amq_article",
25+
template = "template.tex",
26+
csl = "",
27+
fig_caption = fig_caption)
28+
}

R/utils.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ template_pandoc <- function(metadata, template, output, verbose = FALSE) {
4848
}
4949

5050

51-
# Call rmarkdown::pdf_documet and mark the return value as inheriting pdf_document
51+
# Call rmarkdown::pdf_document and mark the return value as inheriting pdf_document
5252
inherit_pdf_document <- function(...) {
5353
fmt <- rmarkdown::pdf_document(...)
5454
fmt$inherits <- "pdf_document"

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ The **rticles** package provides a suite of custom [R Markdown](http://rmarkdown
4242

4343
- [Royal Society Open Science](http://rsos.royalsocietypublishing.org/) journal submissions
4444

45+
- [Bulletin de l'AMQ](https://www.amq.math.ca/bulletin/) journal submissions
46+
4547
Under the hood, LaTeX templates are used to ensure that documents conform precisely to submission standards. At the same time, composition and formatting can be done using lightweight [markdown](http://rmarkdown.rstudio.com/authoring_basics.html) syntax, and R code and its output can be seamlessly included using [knitr](http://yihui.name/knitr/).
4648

4749
Using **rticles** requires the prerequisites described below. You can get most of these automatically by installing the latest release of RStudio (instructions for using **rticles** without RStudio are also provided).
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Comment utiliser l'extension `amq_article`?
2+
3+
## Ajouter des packages
4+
5+
Vous pouvez ajouter des packages utiles pour vous dans le fichier `authorpackages.tex`. Vous pouvez laisser le fichier vide si vous n'avez aucun package à ajouter.
6+
7+
Voici quelques exemples de packages que vous pouvez ajouter:
8+
9+
```
10+
\usepackage{pstricks}
11+
\usepackage{enumitem}
12+
```
13+
14+
15+
## Ajouter des commandes
16+
17+
Vous pouvez ajouter des commandes utiles pour vous dans le fichier `authorcommands.tex`. Vous pouvez laisser le fichier vide si vous n'avez aucune commande à ajouter.
18+
19+
Voici quelques exemples de commandes que vous pouvez ajouter:
20+
21+
```
22+
\newcommand{\lr}[1]{\left(#1\right)}
23+
\newcommand{\abs}[1]{\left\vert#1\right\vert}
24+
```
25+
26+
## Bibliographie
27+
28+
Le bulletin de l'AMQ ne vous permet pas d'utiliser `Bibtex` pour votre bibliographie. Vous devez donc entrer vos bibliographies dans le fichiers `mybibliography.tex`.
29+
30+
La liste des références apparaîtra entre les commandes `\begin{thebibliography}{10}` et `\end{thebibliography}{10}`, par ordre alphabétique du premier auteur.
31+
32+
Toutes les références bibliographiques apparaissant dans la liste des références devraient être citées dans le corps du texte. Réciproquement, toutes les références citées dans le corps du texte devraient apparaître en fin de texte dans la liste des
33+
références.
34+
35+
Chaque item de cette liste sera entré grâce à la commande `\bibitem`.
36+
37+
- Pour un livre: `\bibitem{étiquette} Nom de l'auteur, Initiale. (année de publication). {\em Titre du livre} (Numéro d'édition Éd.) (vol. numéro de volume) (Nom du traducteur trad.). Ville, Pays (sauf pour les USA où on mettra Ville, abr. postale de l'État): Éditeur.`
38+
39+
- Pour un article publié dans une revue: `\bibitem{étiquette} Nom de l'auteur, Initiale. (année de publication). Titre de l'article, {\em Nom de la revue, Numéro du volume} (no. numéro de fascicule), numéro de la première page--numéro de la dernière page.`
40+
41+
- Pour un chapitre dans un ouvrage collectif (plusieurs auteurs): `\bibitem{étiquette} Nom de l'auteur, Initiale. (année de publication). Titre du chapitre, Dans Initiale. Nom du directeur (dir.) {\em Titre de l'ouvrage}, (numéro d'édition ou de chapitre, p. numéro de la première page--numéro de la dernière page), Ville, Pays: Éditeur.`
42+
43+
- Pour un document en ligne: `\bibitem{étiquette} Nom de l'auteur, Initiale. (date de création, ou année de création mise à jour date de mise à jour). Titre du document (pour une section d'un document long, traiter comme pour un chapitre de livre en remplaçant les numéros de pages par le numéro de chapitre ou de section)`.
44+
45+
Pour invoquer une référence dans le texte, utiliser la commande `\cite{étiquette}`
46+
47+
Pour plus de renseignements, consultez [normes](http://benhur.teluq.uqam.ca/~mcouture/apa/normes_apa_francais.pdf). Pour les informations de localisation, consulter le même document
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.pdfsync
2+
.bbl
3+
.aux
4+
.out
5+
.log
6+
.synctex.gz

0 commit comments

Comments
 (0)