Skip to content

Commit

Permalink
Add a template for *Bulletin de l'AMQ*. (#145)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
desautm authored and jjallaire committed Dec 7, 2017
1 parent eac2005 commit 538410b
Show file tree
Hide file tree
Showing 20 changed files with 723 additions and 5 deletions.
3 changes: 2 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ Authors@R: c(
person("Oliver", "Keyes", role = c("aut", "cph"), email = "okeyes@wikimedia.org"),
person("Miao", "Yu", role = c("aut", "cph"), email = "yufreecas@gmail.com"),
person("Daniel", "Emaasit", role = c("aut", "cph"), email = "daniel.emaasit@gmail.com"),
person("Thierry", "Onkelinx", role = c("aut", "cph"), email = "thierry.onkelinx@inbo.be")
person("Thierry", "Onkelinx", role = c("aut", "cph"), email = "thierry.onkelinx@inbo.be"),
person("Marc-Andre", "Desautels", role = c("aut", "cph"), email = "marc-andre.desautels@cstjean.qc.ca")
)
Description: A suite of custom R Markdown formats and templates for
authoring journal articles and conference submissions.
Expand Down
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
export(acm_article)
export(acs_article)
export(aea_article)
export(amq_article)
export(ams_article)
export(asa_article)
export(ctex)
Expand Down
28 changes: 28 additions & 0 deletions R/amq_article.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
#' Format pour Bulletin de l'AMQ.
#'
#' Ce format a été adapté du format du bulletin de l'AMQ
#'
#' @inheritParams rmarkdown::pdf_document
#' @param ... Arguments to \code{rmarkdown::pdf_document}
#' @return R Markdown output format to pass to \code{\link[rmarkdown:render]{render}}
#' @examples
#' \dontrun{
#' rmarkdown::draft("MyArticle.Rmd", template = "amq_article", package = "rticles")
#' }
#'
#' @export
amq_article <- function(...,
latex_engine = 'xelatex',
keep_tex = TRUE,
md_extensions = c("-autolink_bare_uris"),
fig_caption = TRUE){
pdf_document_format(...,
latex_engine = latex_engine,
highlight = NULL,
keep_tex = keep_tex,
md_extensions = md_extensions,
format = "amq_article",
template = "template.tex",
csl = "",
fig_caption = fig_caption)
}
2 changes: 1 addition & 1 deletion R/utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ template_pandoc <- function(metadata, template, output, verbose = FALSE) {
}


# Call rmarkdown::pdf_documet and mark the return value as inheriting pdf_document
# Call rmarkdown::pdf_document and mark the return value as inheriting pdf_document
inherit_pdf_document <- function(...) {
fmt <- rmarkdown::pdf_document(...)
fmt$inherits <- "pdf_document"
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ The **rticles** package provides a suite of custom [R Markdown](http://rmarkdown

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

- [Bulletin de l'AMQ](https://www.amq.math.ca/bulletin/) journal submissions

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/).

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).
Expand Down
47 changes: 47 additions & 0 deletions inst/rmarkdown/templates/amq_article/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Comment utiliser l'extension `amq_article`?

## Ajouter des packages

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.

Voici quelques exemples de packages que vous pouvez ajouter:

```
\usepackage{pstricks}
\usepackage{enumitem}
```


## Ajouter des commandes

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.

Voici quelques exemples de commandes que vous pouvez ajouter:

```
\newcommand{\lr}[1]{\left(#1\right)}
\newcommand{\abs}[1]{\left\vert#1\right\vert}
```

## Bibliographie

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`.

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.

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
références.

Chaque item de cette liste sera entré grâce à la commande `\bibitem`.

- 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.`

- 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.`

- 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.`

- 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)`.

Pour invoquer une référence dans le texte, utiliser la commande `\cite{étiquette}`

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
6 changes: 6 additions & 0 deletions inst/rmarkdown/templates/amq_article/resources/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.pdfsync
.bbl
.aux
.out
.log
.synctex.gz
Loading

0 comments on commit 538410b

Please sign in to comment.