diff options
Diffstat (limited to 'macros/latex/contrib/cjs-rcs-article/cjs-rcs-article.dtx')
| -rw-r--r-- | macros/latex/contrib/cjs-rcs-article/cjs-rcs-article.dtx | 1038 |
1 files changed, 757 insertions, 281 deletions
diff --git a/macros/latex/contrib/cjs-rcs-article/cjs-rcs-article.dtx b/macros/latex/contrib/cjs-rcs-article/cjs-rcs-article.dtx index 9376ddbbf3..a750c136f5 100644 --- a/macros/latex/contrib/cjs-rcs-article/cjs-rcs-article.dtx +++ b/macros/latex/contrib/cjs-rcs-article/cjs-rcs-article.dtx @@ -3,7 +3,7 @@ % Article class for The Canadian Journal of Statistics | La revue % canadienne de statistique % -% Copyright (C) Statistical Society of Canada | Société +% Copyright (C) 2023-2024 Statistical Society of Canada | Société % canadienne de statistique % % The class file and templates derived from this file are licenced @@ -25,10 +25,10 @@ %<*driver> \ProvidesFile{cjs-rcs-article.dtx} %</driver> -%<class>\NeedsTeXFormat{LaTeX2e}[2009/09/24] +%<class>\NeedsTeXFormat{LaTeX2e}[2021/06/01] %<class>\ProvidesClass{cjs-rcs-article}% %<*class> - [2023/11/29 v1.0 Article class for The Canadian Journal of +[2024/07/30 v1.1a Article class for The Canadian Journal of Statistics | La revue canadienne de statistique] %</class> %<*driver> @@ -122,6 +122,10 @@ \OnlyDescription \fi + %% Additional colors + \colorlet{codebg}{LightYellow1} % code background + \colorlet{prompt}{Orchid4} % command prompt + %% New \DescribeMacro type environments for class options and lengths \NewDocElement[envlike,notoplevel,printtype=\emph{option}]{Option}{option} \NewDocElement[macrolike,notoplevel,printtype=$\ell$]{Length}{length} @@ -139,9 +143,12 @@ \newcommand*\CJSbstfr{\code{cjs-rcs-fr}} \makeatother + %% URL of the project repository + \newcommand*\reposurl{https://gitlab.com/cjs-rcs/cjs-rcs-article} + %% Redefine \year using information from \filedate instead of using %% compilation time - \def\parsedate#1/#2/#3\relax{\def\year{#1}} + \def\parsedate#1/#2/#3\relax{\def\year{#1}\def\isodate{#1-#2-#3}} %% Definition of a shorthand to either hyphenate a word or insert a %% regular dash. Use in the long names of Creative Commons licences. @@ -149,6 +156,26 @@ \useshorthands*{"} \defineshorthand{"-}{\discretionary{-}{}{-}} + %% Source code + \usepackage{listings} + \lstset{% + basicstyle=\ttfamily\NoAutoSpacing, + moredelim=[is][\color{prompt}]{---}{-}, + escapeinside=`', + showstringspaces=false, + backgroundcolor=\color{codebg}, + frame=leftline, + framerule=2pt, + framesep=5pt, + xleftmargin=7.4pt + } + + %% The \meta command from memoir needs an additionnel \normalfont to + %% use the document font in listings. + \makeatletter + \def\meta@font@select{\normalfont\itshape} + \makeatother + \begin{document} \DocInput{cjs-rcs-article.dtx} \end{document} @@ -257,6 +284,22 @@ % CTAN.} % \changes{1.0}{2023-11-29}{Fix various typos and cosmetic issues in % the documentation.} +% \changes{1.1}{2024-06-26}{Provide support to acknowledge usage of +% data from the Alzheimer’s Disease Neuroimaging Initiative (ADNI) and +% the Alzheimer’s Disease Neuroimaging Metabolomics Consortium +% (ADMC).} +% \changes{1.1}{2024-06-26}{Introduce new commands \cs{specialack} and +% \cs{specialackmark} for the editors.} +% \changes{1.1}{2024-06-23}{Improve the documentation, in particular +% the installation instructions and access to the templates.} +% \changes{1.1}{2024-07-02}{Add the References section to the table of +% contents of the PDF.} +% \changes{1.1}{2024-07-13}{Add the command \cs{matit} to typeset bold +% italic in math in a portable way.} +% \changes{1.1a}{2024-07-25}{Fix the command \cs{proglang} that would +% disable hyphenation for the rest of the document. With thanks to +% Enrico Gregorio (egreg) for the heads up in person at TUG 2024.} +% \changes{1.1a}{2024-07-25}{Make the command \cs{proglang} robust.} % % \ifenglish% % \title[Guide to the class {\CJSclass}]{% @@ -353,11 +396,9 @@ % {\CJSclass} requiert une distribution {\TeX} récente et % à jour. Nous recommandons les distributions % % \fi -% \href{https://tug.org/texlive}{{\TeX}~Live} % -% --- % +% \href{https://tug.org/texlive}{{\TeX}~Live}\ifenglish---\else~--- \fi% % \ifenglish or its variant for macOS \else ou sa variante pour macOS \fi% -% \href{https://tug.org/mactex}{Mac{\TeX}} % -% --- % +% \href{https://tug.org/mactex}{Mac{\TeX}}\ifenglish---\else~--- \fi% % \ifenglish and \else et \fi% % \href{https://miktex.org}{MiK{\TeX}}. % % \ifenglish% @@ -425,17 +466,28 @@ % \section{Démarrage rapide} % \fi % \label{sec:quick-start} +% \changes{1.1}{2024-06-05}{Documentation: add a link to obtain the +% templates in the \emph{Quick start} section.} % % \ifenglish% % The class ships with templates for articles in English and in % French. In {\TeX}~Live, these are located with the -% documentation of the class. To quickly start writing your article, -% copy the appropriate template to your working directory and follow -% the brief instructions therein. % +% documentation of the class. You may also obtain the templates from +% the % % \else% % La classe est livrée avec des gabarits pour des articles en français % et en anglais. Dans la distribution {\TeX}~Live, ceux-ci sont -% classés avec la documentation. Pour débuter rapidement la rédaction +% classés avec la documentation. Vous pouvez aussi les récupérer +% depuis le % +% \fi% +% \href{\reposurl/-/releases/\fileversion}{% +% \ifenglish project repository\else dépôt du projet\fi}. % +% \ifenglish% +% To quickly start writing your article, copy the appropriate template +% to your working directory and follow the brief instructions +% therein. % +% \else% +% Pour débuter rapidement la rédaction % de votre article, copiez le gabarit approprié dans votre dossier de % travail et suivez les directives succinctes qui s'y trouvent. % % \fi @@ -490,6 +542,9 @@ % \changes{0.91}{2023-10-16}{Change the name of the archive containing % a ``local'' installation of the class from % \texttt{-no-local-tex.zip} to \texttt{-project-install.zip}.} +% \changes{1.1}{2024-06-05}{Documentation: provide a direct link to +% the release corresponding to the version of the documentation in the +% \emph{Installation} section.} % % \ifenglish% % The class {\CJSclass} is distributed as the package % @@ -507,21 +562,33 @@ % the command line: % % \else% % via le réseau de sites \emph{Comprehensive {\TeX} Archive Network} -% (CTAN). Elle fait partie des distributions {\TeX} standards telles -% que {TeX}~Live, Mac{\TeX} et MiK{\TeX}. Nous recommandons fortement -% d'installer ou de mettre à jour le paquetage à l'aide du +% (CTAN). Celui-ci fait partie des distributions {\TeX} standards +% telles que {TeX}~Live, Mac{\TeX} et MiK{\TeX}. Nous recommandons +% fortement d'installer ou de mettre à jour le paquetage à l'aide du % gestionnaire de paquetages de votre distribution {\TeX}. Par -% exemple, avec {\TeX}~Live, vous pouvez effectuer ces opérations dans -% l'assistant graphique, ou encore avec l'une ou l'autre des commandes -% ci-dessous: % +% exemple, avec {\TeX}~Live, vous pouvez effectuer ces opérations +% dans l'assistant graphique, ou encore avec l'une ou l'autre des +% commandes ci-dessous: % +% \fi +% \iffalse +%<*example> +% \fi +\begin{lstlisting} +---$- tlmgr install cjs-rcs-article +\end{lstlisting} +% \iffalse +%</example> % \fi -% \begin{quote} -% \code{tlmgr install cjs-rcs-article} -% \end{quote} % \ifenglish or\else ou\fi -% \begin{quote} -% \code{tlmgr update cjs-rcs-article} -% \end{quote} +% \iffalse +%<*example> +% \fi +\begin{lstlisting} +---$- tlmgr update cjs-rcs-article +\end{lstlisting} +% \iffalse +%</example> +% \fi % % \ifenglish% % If you are not in position to install packages or update the {\TeX} @@ -530,23 +597,23 @@ % limited in scope to your project. Download the archive % % \else% % S'il vous est impossible d'installer des paquetages ou de mettre à -% jour la distribution {\TeX} --- notamment si vous utilisez une -% plateforme de rédaction en ligne --- vous pouvez procéder à une +% jour la distribution {\TeX}~--- notamment si vous utilisez une +% plateforme de rédaction en ligne~--- vous pouvez procéder à une % installation simplifiée de la classe, mais dont la portée sera % limitée à votre projet. Pour ce faire, téléchargez l'archive % % \fi% % \code{cjs-rcs-article-project-install.zip} % % \ifenglish from the \else depuis le \fi% -% \href{https://gitlab.com/cjs-rcs/cjs-rcs-article/-/releases}{% -% \ifenglish project repository\else dépôt du projet\fi} % +% \href{\reposurl/-/releases/\fileversion}{% +% \ifenglish project repository\else dépôt du projet\fi}, % % \ifenglish% -% and uncompress it in the directory of your project. You will then -% have access to all the essential files of the class within this -% project. % +% uncompress it and place its contents in the directory of your +% project. You will then have access to all the essential files of the +% class within this project. % % \else% -% et décompressez celle-ci dans le répertoire de votre projet. Vous -% disposerez alors de tous les fichiers essentiels de la classe à -% l'intérieur de ce projet. % +% décompressez celle-ci et placez son contenu dans le répertoire de +% votre projet. Vous disposerez alorsà l'intérieur de ce projet de +% tous les fichiers essentiels de la classe. % % \fi % % \ifenglish% @@ -631,7 +698,7 @@ % {pdf\LaTeX} utilise les versions Type~1 des polices STIX~Two et % Fira. Or, la technologie Type~1 PostScript étant aujourd'hui % obsolète, ces polices ne sont plus mises à jour. Le moteur -% {\XeLaTeX} utilise les plus modernes --- et complètes --- versions +% {\XeLaTeX} utilise les plus modernes~--- et complètes~--- versions % OpenType des polices.}, % % nous recommandons de compiler votre manuscript avec le plus moderne % moteur {\XeLaTeX}. % @@ -643,24 +710,34 @@ % \subsection{Gabarits} % \fi % \label{sec:usage:templates} +% \changes{1.1}{2024-06-05}{Documentation: add a link to the templates +% in the \emph{Templates} sub-section.} % % \ifenglish% % The class is distributed with templates for articles in English % and in French. If you are using the version of the class included % with your {\TeX} distribution, the templates may be located with the -% documentation (this is the case in {\TeX}~Live). If you installed -% the class manually by following the instructions in -% \autoref{sec:installation}, the templates reside in your working -% directory. % +% documentation (this is the case in {\TeX}~Live). You may also obtain +% them from the % % \else % La classe est distribuée avec des gabarits pour des articles en français % et en anglais. Si vous utilisez la version de la classe fournie avec % votre distribution {\TeX}, les gabarits peuvent être classés avec -% la documentation (c'est le cas dans {\TeX}~Live). Si vous avez +% la documentation (c'est le cas dans {\TeX}~Live). Vous pouvez aussi +% les récupérer depuis le % +% \fi +% \href{\reposurl/-/releases/\fileversion}{% +% \ifenglish project repository\else dépôt du projet\fi}. %% +% \ifenglish +% If you installed the class manually by following the instructions in +% \autoref{sec:installation}, the templates reside in your working +% directory. % +% \else% +% Si vous avez % plutôt installé la classe manuellement en suivant les instructions % de la \autoref{sec:installation}, les gabarits se trouvent dans % votre dossier de travail. % -% \fi +% \fi% % % \ifenglish% % We strongly encourage to start from a template to write your @@ -705,13 +782,19 @@ % \label{sec:usage:options} % % \ifenglish% -% The class is loaded with the command % +% The class is loaded with the command: % % \else% -% On charge la classe avec la commande % +% On charge la classe avec la commande: % +% \fi +% \iffalse +%<*example> +% \fi +\begin{lstlisting} +\documentclass`\oarg{options}\marg{cjs-rcs-article}' +\end{lstlisting} +% \iffalse +%</example> % \fi -% \begin{quote} -% \cmdprint{\documentclass}\oarg{options}\code{\{cjs-rcs-article\}} -% \end{quote} % \ifenglish% % Some \meta{options} of the class are intended for the authors, % whereas others are instead intended for the editors of {\TheCJS*}. @@ -931,22 +1014,28 @@ % du titre qui sera utilisée dans les entêtes. La syntaxe de la % commande est donc: % % \fi -% \begin{quote} -% \def\OPT{\ifenglish Short title\else Titre court\fi} -% \def\ARG{\ifenglish Full title\else Titre complet\fi} -% \cmdprint{\title}\oarg{\OPT}\marg{\ARG} -% \end{quote} -% \ifenglish% -% Write the title in sentence style, that is, with only an initial -% capital. In English, also capitalize the first word after a colon. -% Break a long title needing more than one line using \code{\bs\bs} -% or \cmdprint{\newline}. % -% \else% -% Entrez le titre en minuscules (sauf pour la majuscule initiale). -% En anglais, utilisez toutefois une majuscule initiale après un -% deux-points. Vous devez couper manuellement avec \code{\bs\bs} ou -% \cmdprint{\newline} un titre qui nécessite plus d'une ligne. -% \fi +% \iffalse +%<*example> +% \fi +\def\OPT{\ifenglish Short title\else Titre court\fi} +\def\ARG{\ifenglish Full title\else Titre complet\fi} +\begin{lstlisting} +\title`\oarg{\OPT}\marg{\ARG}' +\end{lstlisting} +% \iffalse +%</example> +% \fi +% \ifenglish% +% Write the title in sentence style, that is, with only an initial +% capital. In English, also capitalize the first word after a colon. +% Break a long title needing more than one line using \code{\bs\bs} +% or \cmdprint{\newline}. % +% \else% +% Entrez le titre en minuscules (sauf pour la majuscule initiale). +% En anglais, utilisez toutefois une majuscule initiale après un +% deux-points. Vous devez couper manuellement avec \code{\bs\bs} ou +% \cmdprint{\newline} un titre qui nécessite plus d'une ligne. +% \fi % \end{DescribeMacro} % % \ifenglish% @@ -994,11 +1083,17 @@ % informations relatives à un auteur de l'article. Sa syntaxe % générale est la suivante: % % \fi -% \begin{quote} -% \def\FORENAME{\ifenglish Forename\else Prénom\fi} -% \def\SURNAME{\ifenglish Surname\else Nom\fi} -% \cmdprint{\author}\oarg{options}\code{\{}\meta{\FORENAME}\code{ }\cmdprint{\surname}\marg{\SURNAME}\code{\}} -% \end{quote} +% \iffalse +%<*example> +% \fi +\def\FORENAME{\ifenglish Forename\else Prénom\fi} +\def\SURNAME{\ifenglish Surname\else Nom\fi} +\begin{lstlisting} +\author`\oarg{options}'{`\meta{\FORENAME}' \surname`\marg{\SURNAME}'} +\end{lstlisting} +% \iffalse +%</example> +% \fi % \ifenglish% % The \meta{Surname} must be entered using the command % \cmd{\surname}. Write the \meta{Forename} and \meta{Surname} in @@ -1113,15 +1208,27 @@ % \def\FORENAME{\ifenglish Forename\else Prénom\fi} % \def\SURNAME{\ifenglish Surname\else Nom\fi} % \item \ifenglish For the corresponding author\else Pour l'auteur correspondant\fi: -% \begin{quote} -% \cmdprint{\author}\code{[orcid=}\meta{id}\code{, email=}\meta{\EMAIL}\code{, corresponding]} \\ -% \verb+ +\code{\{}\meta{\FORENAME}\code{ }\cmdprint{\surname}\marg{\SURNAME}\code{\}} -% \end{quote} +% \iffalse +%<*example> +% \fi +\begin{lstlisting} +\author[orcid=`\meta{id}', email=`\meta{\EMAIL}', corresponding] + {`\meta{\FORENAME}' \surname`\marg{\SURNAME}'} +\end{lstlisting} +% \iffalse +%</example> +% \fi % \item \ifenglish For all other authors\else Pour tous les autres auteurs\fi: -% \begin{quote} -% \cmdprint{\author}\code{[orcid=}\meta{id}\code{, email=}\meta{\EMAIL}\code{]} \\ -% \verb+ +\code{\{}\meta{\FORENAME}\code{ }\cmdprint{\surname}\marg{\SURNAME}\code{\}} -% \end{quote} +% \iffalse +%<*example> +% \fi +\begin{lstlisting} +\author[orcid=`\meta{id}', email=`\meta{\EMAIL}'] + {`\meta{\FORENAME}' \surname`\marg{\SURNAME}'} +\end{lstlisting} +% \iffalse +%</example> +% \fi % \end{itemize} % \end{DescribeMacro} % \end{DescribeMacro} @@ -1136,11 +1243,17 @@ % mentionné dans la commande \cmd{\author} qui la précède. La forme % générale de l'affiliation est: % % \fi -% \begin{quote} -% \def\AFFIL{\ifenglish Department, University, City, Country\else% -% Département, Université, Ville, Pays\fi} -% \cmd{\affil}\marg{\AFFIL} -% \end{quote} +% \iffalse +%<*example> +% \fi +\def\AFFIL{\ifenglish Department, University, City, Country\else% + Département, Université, Ville, Pays\fi} +\begin{lstlisting} +\affil`\marg{\AFFIL}' +\end{lstlisting} +% \iffalse +%</example> +% \fi % \ifenglish% % Give the country name in the main language of the article. % % \else% @@ -1164,13 +1277,19 @@ % premier auteur suivi de la locution «et collab.» (en français) ou % «et al.» (en anglais): % % \fi -% \begin{quote} -% \def\SURNAME{\ifenglish Surname\else Nom\fi} -% \def\ETAL{\ifenglish et al.\else et collab.\fi} -% \def\ETCOLLAB{\ifenglish et collab.\else et al.\fi} -% \cmdprint{\runningauthor}\code{\{}\meta{\SURNAME}\code{ \ETAL\}} \\ -% \cmdprint{\runningauthor}\code{\{}\meta{\SURNAME}\code{ \ETCOLLAB\}} -% \end{quote} +% \iffalse +%<*example> +% \fi +\def\SURNAME{\ifenglish Surname\else Nom\fi} +\def\ETAL{\ifenglish et al.\else et collab.\fi} +\def\ETCOLLAB{\ifenglish et collab.\else et al.\fi} +\begin{lstlisting} +\runningauthor{`\meta{\SURNAME} \ETAL'} +\runningauthor{`\meta{\SURNAME} \ETCOLLAB'} +\end{lstlisting} +% \iffalse +%</example> +% \fi % \end{DescribeMacro} % % \ifenglish% @@ -1224,16 +1343,22 @@ % mots-clés de l'article. Il s'utilise comme une liste % \code{itemize} ou \code{enumerate}: % % \fi -% \begin{quote} -% \def\KEYWORDC{\ifenglish Key word\else Mot-clé\fi} -% \def\KEYWORD{\ifenglish key word\else mot-clé\fi} -% \cmdprint{\begin}\code{\{keywords\}} \\ -% \cmdprint{\item} \emph{{\KEYWORDC} 1} \\ -% \cmdprint{\item} \emph{{\KEYWORD} 2} \\ -% \cmdprint{\item} \emph{{\KEYWORD} 3} \\ -% \code{...} \\ -% \cmdprint{\end}\code{\{keywords\}} -% \end{quote} +% \iffalse +%<*example> +% \fi +\def\KEYWORDC{\ifenglish Key word\else Mot-clé\fi} +\def\KEYWORD{\ifenglish key word\else mot-clé\fi} +\begin{lstlisting} +\begin{keywords} +\item `\normalfont\itshape{\KEYWORDC} 1' +\item `\normalfont\itshape{\KEYWORD} 2' +\item `\normalfont\itshape{\KEYWORD} 3' +... +\end{keywords} +\end{lstlisting} +% \iffalse +%</example> +% \fi % \ifenglish% % As shown above, use an initial capital for the first key word % only. Punctuation will be added automatically. % @@ -1261,15 +1386,21 @@ % classification mathématique par matières de l'article. Son % interface est la suivante: % % \fi -% \begin{quote} -% \def\LEVEL{\ifenglish level\else niveau\fi} -% \def\CODE{\ifenglish code\else rubrique\fi} -% \cmdprint{\begin}\code{\{classification\}}\oarg{type} \\ -% \cmdprint{\item}\oarg{\LEVEL} \emph{{\CODE} 1}, \emph{{\CODE} 2}, \dots \\ -% \cmdprint{\item}\oarg{\LEVEL} \emph{{\CODE} 1}, \emph{{\CODE} 2}, \dots \\ -% \code{...} \\ -% \cmdprint{\end}\code{\{classification\}} -% \end{quote} +% \iffalse +%<*example> +% \fi +\def\LEVEL{\ifenglish level\else niveau\fi} +\def\CODE{\ifenglish code\else rubrique\fi} +\begin{lstlisting} +\begin{classification}`\oarg{type}' +\item`\oarg{\LEVEL} \normalfont\itshape{\CODE} 1, {\CODE} 2, \dots' +\item`\oarg{\LEVEL} \normalfont\itshape{\CODE} 1, {\CODE} 2, \dots' +... +\end{classification} +\end{lstlisting} +% \iffalse +%</example> +% \fi % \ifenglish% % The classification system used is % % \else% @@ -1331,7 +1462,53 @@ % les options \code{review}, \code{supplement} et \code{nocjs}, % l'espace est remplacé par un pied de page contenant le numéro de % page. % -% \fi% +% \fi +% +% \ifenglish% +% \subsubsection{ADNI data use agreement} +% \else% +% \subsubsection{Contrat d'utilisation des données de l'ADNI} +% \fi +% \label{sec:usage:titling:adni} +% +% \ifenglish% +% The Alzheimer’s Disease Neuroimaging Initiative (ADNI) % +% \else% +% Le % +% \fi +% \href{https://adni.loni.usc.edu/wp-content/uploads/how_to_apply/ADNI_DSP_Policy.pdf}{\ifenglish Data Sharing and Publication Policy\else contrat d'utilisation des données\fi} % +% \ifenglish% +% requires authors using their data to acknowledge ADNI in the list of +% authors and give a specific statement on the title page. % +% \else% +% de l'Alzheimer’s Disease Neuroimaging Initiative (ADNI) stipule que +% les auteurs qui ont recours à leurs données doivent reconnaitre la +% contribution de l'ADNI parmi les auteurs et inclure une déclaration +% spécifique sur la page de titre de l'article. % +% \fi +% +% \begin{DescribeMacro}{\ADNIacknowledgement} +% \ifenglish% +% The command \cmd{\ADNIacknowledgement} adds these two +% requirements. The command has no arguments; simply insert it after +% the declarations of the authors. % +% \else% +% La commande \cmd{\ADNIacknowledgement} ajoute ces deux exigences. +% La commande n'a aucun argument; insérez simplement celle-ci après +% toutes les autres définitions des auteurs. % +% \fi +% \end{DescribeMacro} +% +% \begin{DescribeMacro}{\ADMCacknowledgement} +% \ifenglish% +% Similarly, the command \cmd{\ADMCacknowledgement} acknowledges the +% Alzheimer’s Disease Meta\-bo\-lomics Consortium (ADMC). % +% \else% +% De manière analogue, la commande \cmd{\ADMCacknowledgement} +% reconnait la contribution du +% Alzheimer’s Disease Metabolomics Consortium (ADMC). % +% \fi +% \end{DescribeMacro} % % \ifenglish% % \subsection{Back matter information} @@ -1342,17 +1519,19 @@ % % \ifenglish% % Articles in {\TheCJS} end with elements forming the so-called back -% matter: supplementary material available online, acknowledgements, -% etc. The class {\CJSclass} provides specialized environments to -% enter this information. See \autoref{tab:titling} for a summary; the -% detailed descriptions follow. % +% matter: supplementary material available online, data sharing +% statement, acknowledgements, etc. The class {\CJSclass} provides +% specialized environments to enter this information. See +% \autoref{tab:titling} for a summary; the detailed descriptions +% follow. % % \else% % Un article de {\LaRevue} se termine par la présentation d'un % ensemble d'informations dans des parties annexes: matériel -% additionnel disponible en ligne, remerciements, etc. La classe -% {\CJSclass} définit des environnements pour entrer ce type -% d'information de manière uniforme. Le \autoref{tab:backmatter} en -% présente un sommaire; les descriptions détaillées suivent. \fi +% additionnel disponible en ligne, conditions de partage des données, +% remerciements, etc. La classe {\CJSclass} définit des environnements +% pour entrer ce type d'information de manière uniforme. Le +% \autoref{tab:backmatter} en présente un sommaire; les descriptions +% détaillées suivent. \fi % % \begin{table}[t] % \centering @@ -1428,18 +1607,34 @@ % \fi % \end{DescribeEnv} % +% \changes{1.1}{2024-01-23}{Documentation: revise the description of +% the \texttt{sharing} environment now that the CJS adhered to the +% Expects Data Sharing editorial policy of Wiley.} % \begin{DescribeEnv}{sharing} +% \def\POLICYNAME{\ifenglish Expects Data Sharing\else \emph{Expects Data Sharing}\fi} +% \ifenglish% +% {\TheCJS} adheres to the % +% \else% +% {\LaRevue} respecte la politique éditoriale % +% \fi% +% \href{https://authorservices.wiley.com/author-resources/Journal-Authors/open-access/data-sharing-citation/data-sharing-policy.html}{\POLICYNAME} % % \ifenglish% -% If you wish to share data or the code, use the environment -% \code{sharing} to describe how to access this material, providing -% a persistent identifier, such as a digital object identifier (DOI) -% or a URL. % +% editorial policy of Wiley. Therefore, you must use the environment +% \code{sharing} to make a statement about the availability or +% absence of shared data. In case of ethical or legal concerns, we +% encourage you to provide synthetic data instead if possible. +% Provide a persistent identifier to access the data, such as a +% digital object identifier (DOI) or a URL. You may also use the +% environment to describe how to access shared computer code. % % \else% -% Si vous mettez les données ou le code de votre article à -% disposition, utilisez l'environnement \code{sharing} pour -% expliquer comment accéder à ce matériel et pour indiquer un lien -% permanent, comme un identificateur d'objets numériques (DOI) ou -% une adresse URL. % +% de Wiley. Par conséquent, vous devez utiliser l'environnement +% \code{sharing} pour préciser les conditions de partage des données +% de recherche, ou encore leur absence, le cas échéant. En cas +% d'enjeux éthiques ou légaux, veuillez utiliser si possible des +% données de synthèse. Indiquez un lien permanent pour accéder aux +% données, comme un identificateur d'objets numériques (DOI) ou une +% adresse URL. Vous pouvez aussi utiliser l'environnement pour +% indiquer comment accéder à du code informatique partagé. % % \fi % \end{DescribeEnv} % @@ -1644,10 +1839,16 @@ % la page de titre du présent document a été composée avec la commande % suivante: % % \fi -% \begin{quote} -% \cmd{\licence}\code{\{\{}\cmdprint{\ccbysa*}\code{\} {\year}, Statistical Society of Canada \{}\cmdprint{\textbar}\code{\}} \\ -% \verb+ +\code{Société canadienne de statistique\}} -% \end{quote} +% \iffalse +%<*example> +% \fi +\begin{lstlisting} +\licence{{\ccbysa*} `\year', Statistical Society of Canada {\textbar} + Société canadienne de statistique} +\end{lstlisting} +% \iffalse +%</example> +% \fi % % \ifenglish% % \subsection{Mathematics} @@ -1655,6 +1856,8 @@ % \subsection{Mathématiques} % \fi % \label{sec:usage:mathematics} +% \changes{1.1}{2024-01-23}{Documentation: specify that the class is +% not compatible with the package \textbf{amssymb}.} % % \ifenglish% % The class automatically loads the packages % @@ -1666,16 +1869,18 @@ % \ifenglish% % and, when the document is compiled with {\XeLaTeX}, % % \else% -% et, lorsque le document est compilé avec {\XeLaTeX}, +% et, lorsque le document est compilé avec {\XeLaTeX}, % % \fi% % \href{https://ctan.org/pkg/unicode-math}{\pkg{unicode-math}}. % % \ifenglish% -% The class also defines a number of commands and environments to -% standardize the typesetting of mathematical content in {\TheCJS}. +% Note that it is not compatible with the package \pkg{amssymb}. The +% class also defines a number of commands and environments to +% standardize the typesetting of mathematical content in {\TheCJS}. % % \else% -% Elle définit également des commandes et des environnements pour -% assurer une mise en forme standardisée des mathématiques dans -% {\LaRevue}. +% En revanche, elle n'est pas compatible avec le paquetage +% \pkg{amssymb}. La classe définit également des commandes et des +% environnements pour assurer une mise en forme standardisée des +% mathématiques dans {\LaRevue}. % % \fi % % \ifenglish% @@ -1724,6 +1929,9 @@ % \cmd{\mat} & % \ifenglish matrix or vector \else matrice ou vecteur \fi & % \cmdprint{\mat}\code{\{A\}} & $\mat{A}$ \\ +% \cmd{\matit} & +% \ifenglish matrix or vector (italic) \else matrice ou vecteur (italique) \fi & +% \cmdprint{\matit}\code{\{x\}} & $\matit{x}$ \\ % \cmd{\trsp} & % \ifenglish transposition \else transposée \fi & % \cmdprint{\mat}\code{\{A\}}\cmdprint{\trsp} & $\mat{A}\trsp$ \\ @@ -1800,7 +2008,7 @@ % \begin{tabbing} % \hspace*{2.5em}\=\cmd{\prdist}\code{\{E\}(\cmd{\lambda})}% % \quad\=$\rightarrow$ \quad\=$\prdist{N}(0, 1)$ \quad\=\kill -% \>\cmd{\prdist}\code{\{N\}(0, 1)}% +% \>\cmd{\prdist}\code{\{N\}(0, 1)} % % \>$\rightarrow$ % % \>$\prdist{N}(0, 1)$ % % \>(\ifenglish Normal\else normale\fi) \\ @@ -1816,26 +2024,36 @@ % \end{DescribeMacro} % % \begin{DescribeMacro}{\mat} -% \begin{DescribeMacro}{\trsp} -% \begin{DescribeMacro}{\tr} -% \begin{DescribeMacro}{\diag} +% \begin{DescribeMacro}{\matit} % \ifenglish% % The command \cmd{\mat} typesets a variable in roman bold, a style % often used for matrices and vectors (hence the name of the -% command). To indicate matrix transposition, use only the command -% \cmd{\trsp}. The commands \cmd{\tr} and \cmd{\diag} define two -% other common linear algebra operators, the trace and the -% diagonal. % +% command). The command \cmd{\matit} is similar, but for a variable +% in bold italic. % \else% % La commande \cmd{\mat} compose une variable en romain gras, ce qui % est souvent utilisé pour les matrices et les vecteurs (d'où le nom -% de la commande). Pour indiquer la transposée d'une matrice, -% utilisez uniquement la commande \cmd{\trsp}. Les commandes -% \cmd{\tr} et \cmd{\diag} définissent deux autres opérateurs -% courants en algèbre linéaire, la trace et la diagonale. % +% de la commande). La commande \cmd{\matit} produit plutôt une +% variable en gras italique. % \fi % \end{DescribeMacro} % \end{DescribeMacro} +% +% \begin{DescribeMacro}{\trsp} +% \begin{DescribeMacro}{\tr} +% \begin{DescribeMacro}{\diag} +% \ifenglish% +% To indicate matrix transposition, use only the command +% \cmd{\trsp}. The commands \cmd{\tr} and \cmd{\diag} define +% two other common linear algebra operators, the trace and the +% diagonal. % +% \else% +% Pour indiquer la transposée d'une matrice, utilisez uniquement la +% commande \cmd{\trsp}. Les commandes \cmd{\tr} et \cmd{\diag} +% définissent deux autres opérateurs courants en algèbre linéaire, +% la trace et la diagonale. % +% \fi +% \end{DescribeMacro} % \end{DescribeMacro} % \end{DescribeMacro} % @@ -1999,6 +2217,23 @@ % Évitez si possible les indices doubles et n'utilisez jamais % d'indices triples. % % \fi +% \changes{1.1}{2024-03-06}{Documentation: add an advice on the +% typesetting of bold symbols in mathematics.} +% \item % +% \ifenglish% +% Bold in mathematics is a tricky issue. Use the aforementioned +% class commands \cmdprint{\mat} and \cmdprint{\matit} to generate +% bold symbols reliably across {\TeX} engines. With {\XeLaTeX}, +% \cmdprint{\mat} also works with Greek letters (that will be +% typeset in italic). % +% \else% +% La composition en gras en mathématiques est une opération +% délicate. Utilisez les commandes de la classe \cmdprint{\mat} et +% \cmdprint{\matit} mentionnées précédemment pour composer +% automatiquement des symboles en gras quelque soit le moteur +% {\TeX}. Avec {\XeLaTeX}, \cmdprint{\mat} fonctionne aussi avec les +% lettres grecques (qui sont alors composées en italique). % +% \fi % \item % % \ifenglish% % Always use the command \cmdprint{\ell} to obtain the symbol @@ -2094,13 +2329,19 @@ % («équation», «inégalité», «relation», etc.), ainsi que par une % espace insécable: % % \fi -% \begin{quote} -% \def\LABEL{\ifenglish label\else étiquette\fi} -% \def\EQN{\ifenglish equation\else équation\fi} -% \def\INEQ{\ifenglish inequalities\else inégalités\fi} -% \code{\EQN~}\cmdprint{\eqref}\marg{\LABEL} \\ -% \code{\INEQ~}\cmdprint{\eqref}\marg{\LABEL}\code{{-}{-}}\cmdprint{\eqref}\marg{\LABEL} -% \end{quote} +% \iffalse +%<*example> +% \fi + \def\LABEL{\ifenglish label\else étiquette\fi} + \def\EQN{\ifenglish equation\else équation\fi} + \def\INEQ{\ifenglish inequalities\else inégalités\fi} +\begin{lstlisting} +`\EQN'~\eqref`\marg{\LABEL}' +`\INEQ'~\eqref`\marg{\LABEL}'--\eqref`\marg{\LABEL}' +\end{lstlisting} +% \iffalse +%</example> +% \fi % \end{itemize} % % \ifenglish% @@ -2533,72 +2774,137 @@ % description pour un nouvel environnement \meta{env}, insérez la % commande suivante dans le préambule de votre document: % % \fi -% \begin{quote} -% \cmdprint{\addto}\cmdprint{\extras}\code{\languagename}\code{\{}\cmdprint{\def}\code{\bs}\meta{env}\code{autorefname}\marg{description}\code{\}} -% \end{quote} +% \iffalse +%<*example> +% \fi +\begin{lstlisting} +\addto\extras`\languagename'{\def\`\meta{env}'autorefname`\marg{description}'} +\end{lstlisting} +% \iffalse +%</example> +% \fi % \ifenglish% % (If the main language of the article is French, replace % \cmdprint{\extras}\code{\languagename} by -% \cmdprint{\extrasfrench}.)\footnote{% +% \cmdprint{\extrasfrench}.\footnote{% % For further details, see Section~6 of the documentation of -% \pkg{hyperref}.} % +% \pkg{hyperref}.}) % % \else% % (Si la langue principale de l'article est l'anglais, remplacez % \cmdprint{\extras}\code{\languagename} par -% \cmdprint{\extrasenglish}.)\footnote{% +% \cmdprint{\extrasenglish}.\footnote{% % Consultez au besoin la section~6 de la documentation de -% \pkg{hyperref}.} % +% \pkg{hyperref}.}) % % \fi % % \begin{DescribeMacro}{\texorpdfstring} % \changes{0.93}{2023-11-07}{Fix the name of a command from % \cs{textorpdfstring} to the correct \cs{texorpdfstring} in the -% documentation.} +% documentation.}% +% \changes{1.1}{2024-03-12}{Documentation: mention to also use +% \cs{texorpdfstring} to fix \texttt{Token not allowed in a PDF +% string} warnings.} % \ifenglish% -% The compilation of your manuscript may halt with the error message +% The package \pkg{hyperref} builds the table of contents of the +% PDF. If you use mathematical notation or symbols in a section +% title, compilation of your manuscript may either result in +% warnings of the form % +% \else% +% Le paquetage \pkg{hyperref} se charge de produire la table des +% matières du fichier PDF. Si vous utilisez de la notation ou des +% symboles mathématiques dans un titre de section, la compilation de +% votre article pourrait soit résulter en des avertissements de la +% forme % +% \fi% % \begin{quote} -% \code{Improper alphabetic constant} +% Token not allowed in a PDF string % \end{quote} -% The reason is most likely that you use a mathematical symbol in a -% section title that \pkg{hyperref} is not able to properly -% translate for the table of contents of the PDF. If you need -% the symbol, try wrapping it in \cmd{\texorpdfstring}. This -% command takes two arguments: the symbol that should appear in the -% document, and the replacement text for the table of contents. For -% example, you would replace % +% \ifenglish% +% or halt with the error message % % \else% -% Il se pourrait que la compilation de votre article échoue avec le -% message d'erreur +% ou échouer avec le message d'erreur % +% \fi% % \begin{quote} % \code{Improper alphabetic constant} % \end{quote} -% La cause en est probablement un symbole mathématique placé dans un -% titre de section que \pkg{hyperref} n'arrive pas à traduire pour -% la table des matières du fichier PDF. Si vous ne pouvez vous -% passer du symbole dans le titre, essayez d'utiliser la commande -% \cmd{\texorpdfstring} dans celui-ci. Cette commande requiert deux -% arguments: le texte qui doit apparaitre dans le document et celui -% qui peut figurer dans la table des matières. Par exemple, vous -% devriez remplacer % +% \ifenglish% +% If you need the notation or symbol in the title, wrap it in +% \cmd{\texorpdfstring}. This command takes two arguments: the +% notation or symbol that should appear in the document, and the +% replacement text for the table of contents. For example, you would +% replace % +% \else% +% Si vous ne pouvez vous passer de la notation ou du symbole dans le +% titre, utilisez la commande \cmd{\texorpdfstring} dans celui-ci. +% Cette commande requiert deux arguments: le texte qui doit +% apparaitre dans le document et celui qui peut figurer dans la +% table des matières. Par exemple, vous devriez remplacer % % \fi% -% \def\TEXT{Contribution \ifenglish of \else de \fi} -% \begin{quote} -% \cmdprint{\subsection}\code{\{\TEXT $}\cmdprint{\beta}\code{$\}} -% \end{quote} +% \iffalse +%<*example> +% \fi +\def\TEXT{\ifenglish Algorithm for\else Algorithme pour\fi} +\begin{lstlisting} +\section{`\TEXT' $U_n$} +\end{lstlisting} +% \iffalse +%</example> +% \fi +% \ifenglish% +% by something along the lines of % +% \else% +% par quelque chose comme % +% \fi% +% \iffalse +%<*example> +% \fi +\begin{lstlisting} +\section{`\TEXT' \texorpdfstring{$U_n$}{U[n]}} +\end{lstlisting} +% \iffalse +%</example> +% \fi +% \ifenglish% +% You would also replace % +% \else +% De même, vous devriez remplacer % +% \fi% +% \iffalse +%<*example> +% \fi +\def\TEXT{Contribution \ifenglish of\else de\fi} +\begin{lstlisting} +\subsection{`\TEXT' $\beta$} +\end{lstlisting} +% \iffalse +%</example> +% \fi % \ifenglish by\else par\fi -% \begin{quote} -% \cmdprint{\subsection}\code{\{\TEXT}\cmdprint{\texorpdfstring}\code{\{$}\cmdprint{\beta}\code{$\}\{beta\}\}} -% \end{quote} +% \iffalse +%<*example> +% \fi +\begin{lstlisting} +\subsection{`\TEXT' \texorpdfstring{$\beta$}{beta}} +\end{lstlisting} +% \iffalse +%</example> +% \fi +% \ifenglish or even\else ou encore\fi +% \iffalse +%<*example> +% \fi +\begin{lstlisting} +\subsection{`\TEXT' \texorpdfstring{$\beta$}{`β'}} +\end{lstlisting} +% \iffalse +%</example> +% \fi % \ifenglish% -% or, even better if you can enter Unicode characters on the -% keyboard, by % +% if you can enter Unicode characters on the keyboard. % % \else% -% ou même, si vous pouvez entrer des caractères Unicode au clavier, -% par % +% si vous êtes en mesure d'entrer des caractères Unicode au +% clavier. % % \fi -% \begin{quote} -% \cmdprint{\subsection}\code{\{\TEXT}\cmdprint{\texorpdfstring}\code{\{$}\cmdprint{\beta}\code{$\}\{β\}\}} -% \end{quote} % \end{DescribeMacro} % % \warningbox{% @@ -2782,12 +3088,12 @@ % \fi % \item % % \ifenglish% -% (Optional) Appendices --- sections numbered A, B, \dots\ after the -% command \cmd{\appendix} --- for proofs and longer mathematical +% (Optional) Appendices---sections numbered A, B, \dots\ after the +% command \cmd{\appendix}---for proofs and longer mathematical % arguments. Each appendix must be cited in the main article. % % \else% -% (Optionnel) Les annexes --- des sections numérotées A, B, \dots\ -% suite à la commande \cmd{\appendix} ---- pour les démontrations de +% (Optionnel) Les annexes~--- des sections numérotées A, B, \dots\ +% suite à la commande \cmd{\appendix}~--- pour les démontrations de % théorèmes ou autres longs développements mathématiques. Chaque % annexe doit être citée dans l'article. % % \fi @@ -2871,10 +3177,11 @@ % \end{itemize} % Les informations de la page de titre et des parties annexes peuvent % toujours figurer dans le code source. Autrement dit, vous pouvez -% créer le matérial additionnel directement à partir du même préambule -% --- ou gabarit --- que votre article principal; il suffit d'ajouter +% créer le matérial additionnel directement à partir du même +% préambule que votre article principal; il suffit d'ajouter % \code{supplement} aux options de la classe. % -% \fi \endgroup +% \fi +% \endgroup % % \ifenglish% % The option \code{supplement} is compatible with the option @@ -2955,7 +3262,7 @@ % at the bottom of the first page. The option has no other effect on % the rendering of the article. % % \else% -% L'option \code{final} --- qui a préséance sur \code{review} --- +% L'option \code{final}~--- qui a préséance sur \code{review}~--- % active la vérification que les informations de publication et que % l'historique de révision sont fournis. De plus, si les % informations d'octroi de licence sont fournies à l'aide des @@ -3006,10 +3313,79 @@ % \else% % AAAA-MM-JJ. Par exemple: % % \fi +% \iffalse +%<*example> +% \fi +\begin{lstlisting} +\received{`\isodate'} +\end{lstlisting} +% \iffalse +%</example> +% \fi +% \end{DescribeMacro} +% \end{DescribeMacro} +% +% \begin{DescribeMacro}{\specialack} +% \ifenglish% +% The command \cmd{\specialack} provides a generic interface to +% give special acknowledgement on the title page, such as the one +% required by ADNI (\autoref{sec:usage:titling:adni}). The +% command takes two arguments: % +% \else% +% La commande \cmd{\specialack} permet de reconnaitre une +% contribution spéciale sur la page de titre, telle que celle exigée +% par l'ADNI (\autoref{sec:usage:titling:adni}). La commande requiert +% deux arguments: % +% \fi% % \begin{quote} -% \cmdprint{\received}\code{\{2023-06-20\}} +% \cmdprint{\specialack}\marg{\ifenglish by-line\else signature\fi}\marg{\ifenglish statement\else déclaration\fi} % \end{quote} +% \ifenglish% +% The \meta{by-line} is inserted in the list of authors, whereas the +% \meta{statement} is typeset at the bottom of the title page, with +% the licensing information. Each argument may be empty, in which +% case the corresponding information is not printed. For example, +% the command \cmd{\ADNIacknowledgement} is effectively defined +% as: % +% \else% +% La \meta{signature} est ajoutée à la liste des auteurs, alors que +% la \meta{déclaration} est affichée au bas de la page de titre, +% avec la déclaration de licence. Chaque argument peut être vide, +% auquel cas l'information correspondante n'est pas affichée. À +% titre d'exemple, la commande \cmd{\ADNIacknowledgement} est +% définie ainsi: % +% \fi% +% \begin{quote} +% \cmdprint{\specialack}\code{\{}\cmdprint{\CJS@adnibyline}\code{\}\{}\cmdprint{\CJS@adnistatement}\code{\}} +% \end{quote} +% \ifenglish% +% (The internal commands \cmd{\CJS@adnibyline} and +% \cmd{\CJS@adnistatement} typeset the official ADNI by-line and +% statement. The analogous commands \cmd{\CJS@admcbyline} and +% \cmd{\CJS@admcstatement} serve the same purpose for the +% Alzheimer’s Disease Metabolomics Consortium.) % +% \else% +% (Les commandes internes \cmd{\CJS@adnibyline} et +% \cmd{\CJS@adnistatement} contiennent le texte officiel de la +% signature et de la déclaration de l'ADNI. Les commandes analogues +% \cmd{\CJS@admcbyline} et \cmd{\CJS@admcstatement} pour +% l'Alzheimer’s Disease Metabolomics Consortium sont également +% définies dans la classe.) % +% \fi% % \end{DescribeMacro} +% +% \begin{DescribeMacro}{\specialackmark} +% \ifenglish% +% The command \cmd{\specialackmark} sets the footnote marker used by +% \cmd{\specialack}. The default definition of the marker is: % +% \else% +% La commande \cmd{\specialackmark} permet de modifier l'appel de +% note de bas de page utilisé par \cmd{\specialack}. La définition +% par défaut de l'appel de note est: % +% \fi% +% \begin{quote} +% \cmdprint{\textsuperscript}\code{\{}\cmdprint{\ensuremath}\code{\{*\}\}} +% \end{quote} % \end{DescribeMacro} % % \ifenglish% @@ -3118,6 +3494,7 @@ \newif\ifCJS@final \CJS@finalfalse % final version? \newif\ifCJS@titlingfooter \CJS@titlingfooterfalse % footer on title page? \newif\ifCJS@journalinfo \CJS@journalinfotrue % display journal info? +\newif\ifCJS@specialack \CJS@specialackfalse % special acknowledgement? \newif\ifCJS@fancybreak \CJS@fancybreaktrue % display fancy break? \newif\ifCJS@history \CJS@historyfalse % history present? \newif\ifCJS@corrauth \CJS@corrauthfalse % corresponding author? @@ -3198,13 +3575,6 @@ % Useful packages like \pkg{iftex} and \pkg{etoolbox} are already % loaded by \class{memoir}. % -% The package \pkg{iflang} provides expandable checks for the current -% language based on the macro \cmdprint{\languagename} or hyphenation -% patterns. -% \begin{macrocode} -\RequirePackage{iflang} -% \end{macrocode} -% % We rely on \pkg{natbib} for author-year citations. This package must % be loaded before \pkg{babel}. The option \code{sectionbib} ensures % that the bibliography (or list of references) is typeset as a @@ -3369,6 +3739,9 @@ % {\LuaTeX}, commands from \pkg{fontspec} and \pkg{unicode-math} load % the OpenType variants of the fonts. The encoding is UTF-8 by default % for these engines. +% \changes{1.1}{2024-03-06}{Implementation: explicitly set the option +% \texttt{bold-style!=TeX} when loading the math font with the modern +% engines.} % \begin{macrocode} \iftutex \RequirePackage[babel=true]{microtype} @@ -3388,7 +3761,7 @@ [ Extension = .otf, Scale = 1, - Ligatures = TeX + bold-style = TeX ] \setmathfont{FiraMath-Regular} [ @@ -3436,7 +3809,8 @@ % \label{sec:implementation:layout:colours} % % We define some colours used by the class. First, the three main -% colours of {\TheCJS} logo: % +% colours of {\TheCJS} logo, hand-picked from the SVG code of the +% latter: % % \textcolor{CJSpink}{\rule{1.5em}{1.2ex}} % % \textcolor{CJSred}{\rule{1.5em}{1.2ex}} % % \textcolor{CJSyellow}{\rule{1.5em}{1.2ex}}\,. @@ -3455,8 +3829,8 @@ \definecolor{CJSurl}{rgb}{0.6,0,0} % external links \definecolor{CJScitation}{rgb}{0,0.5,0} % citations % \end{macrocode} -% Finally, the colour of the ORCID icon\footnote{% -% See \url{https://info.orcid.org/brand-guidelines}.}: % +% Finally, the colour of the % +% \href{https://info.orcid.org/brand-guidelines}{ORCID icon}: % % \textcolor{CJSorcid}{\rule{1.5em}{1.2ex}}\,. % \begin{macrocode} \definecolor{CJSorcid}{HTML}{A6CE39} @@ -3497,12 +3871,12 @@ % The decorative element is created using plain {\TeX} rules. Its % height and depth are identical to the journal information. % \begin{macrocode} -\setbox\z@=\vbox{\sffamily\hbox{\CJS@journalname}\hbox{\bfseries V,}} \newsavebox\CJS@journalornament \setbox\CJS@journalornament=\vbox{% + \setbox\z@=\vbox{\sffamily\hbox{\CJS@journalname}\hbox{\bfseries V,}} \setbox\tw@\hbox{\vrule \@width4pt\@height\ht\z@\@depth\dp\z@} - \hbox{\textcolor{CJSpink}{\copy\tw@}\kern2pt% - \textcolor{CJSred}{\copy\tw@}\kern2pt% + \hbox{\textcolor{CJSpink}{\copy\tw@}\kern2pt + \textcolor{CJSred}{\copy\tw@}\kern2pt \textcolor{CJSyellow}{\copy\tw@}\kern6pt}} % \end{macrocode} % @@ -3535,7 +3909,7 @@ % % First, a command to set the font. % \begin{macrocode} -\newcommand*\CJS@setheadfootfont{% +\def\CJS@setheadfootfont{% \firalining\fontsize{9}{13}\selectfont} % \end{macrocode} % @@ -3545,7 +3919,7 @@ \newlength\CJS@headdivheight \settoheight\CJS@headdivheight{\CJS@setheadfootfont 1} \setlength\CJS@headdivheight{0.9\CJS@headdivheight} -\newcommand*\CJS@headdivrule{% +\def\CJS@headdivrule{% \rule[0.05\CJS@headdivheight]{0.75\normalrulethickness}{\CJS@headdivheight}} % \end{macrocode} % @@ -3614,7 +3988,7 @@ % \label{sec:implementation:layout:titles} % % The \class{memoir} class assumes that sectioning starts at the -% chapter level --- even with the \code{article} option. To get around +% chapter level---even with the \code{article} option. To get around % this requirement, we disable the effect of \cmdprint{\chapter}. A % desirable side effect is to make \cmd{\autoref} work correctly for % appendices. @@ -4160,6 +4534,11 @@ \fancybreak{\pfbreakdisplay} \fi % \end{macrocode} +% \changes{1.1}{2024-06-19}{Implementation: fix the positioning of the +% licensing information at the bottom of the title page.} +% \changes{1.1}{2024-06-26}{Implementation: include the special +% acknowledgement statement in the licensing information, if +% required.} % Finally, unless overridden by a class option, allocate space % for the licence statement at the bottom of the title page. By % default, a notice indicates that the licence will appear @@ -4173,11 +4552,12 @@ \iflanguage{french}{Futur emplacement de la déclaration de licence.}% {Licence statement to appear here.}} \begin{figure}[!b] - \raisebox{0pt}[0pt][\footskip]{% + \raisebox{0pt}[0pt][\dimexpr\CJS@licenceht-\footskip\relax]{% \vbox{% \CJS@setlicencefont \rule{\textwidth}{\normalrulethickness} \parbox[t][\CJS@licenceht][t]{\textwidth}{% + \ifCJS@specialack\CJS@specialackstatement\fi \ifCJS@final\CJS@licence \else\textit\CJS@notice \fi}}} \end{figure} \fi @@ -4185,6 +4565,45 @@ % \end{macrocode} % \end{macro} % +% \subsubsection{ADNI data use agreement} +% \label{sec:implementation:titling:adni} +% +% \changes{1.1}{2024-06-26}{Implementation: define the new commands +% \cs{ADNIacknowledgement} and \cs{ADMCacknowledgement}.} +% \begin{macro}{\ADNIacknowledgement} +% \begin{macro}{\ADMCacknowledgement} +% The commands \cmd{\ADNIacknowledgement} and +% \cmd{\ADMCacknowledgement} automatically create special +% acknowledgements for the Alzheimer’s Disease Neuroimaging +% Initiative (ADNI) and the Alzheimer’s Disease Metabolomics +% Consortium (ADMC), respectively. +% \begin{macrocode} +\newcommand*\CJS@adnibyline{for the Alzheimer’s Disease Neuroimaging Initiative} +\newcommand*\CJS@adnistatement{% + Data used in preparation of this article were obtained + from the \href{https://adni.loni.usc.edu}{Alzheimer’s Disease Neuroimaging Initiative} + (ADNI) database. As such, the investigators within the ADNI + contributed to the design and implementation of ADNI and/or provided + data but did not participate in the analysis or writing of this + report. A complete listing of ADNI investigators can be found at: + \url{https://adni.loni.usc.edu/wp-content/uploads/how_to_apply/ADNI_Acknowledgement_List.pdf}.} +\newcommand*\CJS@admcbyline{for the Alzheimer’s Disease Metabolomics Consortium} +\newcommand*\CJS@admcstatement{% + Data used in preparation of this article were generated by the + Alzheimer’s Disease Metabolomics Consortium (ADMC). As such, the + investigators within the ADMC provided data but did not participate + in analysis or writing of this report. A complete listing of ADMC + investigators can be found at: + \url{https://sites.duke.edu/adnimetab/team/}.} +\newcommand*\ADNIacknowledgement{% + \specialack{\CJS@adnibyline}{\CJS@adnistatement}} +\newcommand*\ADMCacknowledgement{% + \renewcommand*\CJS@specialackmark{\textsuperscript{\ensuremath{**}}} + \specialack{\CJS@admcbyline}{\CJS@admcstatement}} +% \end{macrocode} +% \end{macro} +% \end{macro} +% % \subsection{Back matter} % \label{sec:implementation:backmatter} % @@ -4292,20 +4711,20 @@ % % First, set the font for the licence statement. % \begin{macrocode} -\newcommand*\CJS@setlicencefont{% +\def\CJS@setlicencefont{% \firalining\fontsize{8pt}{9pt}\selectfont} % \end{macrocode} % % \begin{macro}{\CJS@measurelicence} -% We need to compute the required space for a licence statement. The -% internal command \cmd{\CJS@measurelicence} measures the total -% height of either the licence statement provided with -% \cmd{\licence}, or the seemingly longest version of the license -% statement used by the publisher. The command is used inside -% \cmd{\maketitle}. +% We need to compute the required space for a licence statement and, +% possibly, the ADNI statement. The internal command +% \cmd{\CJS@measurelicence} measures the total height required using +% either the licence statement provided with \cmd{\licence}, or the +% seemingly longest version of the license statement used by the +% publisher. The command is used inside \cmd{\maketitle}. % \begin{macrocode} \newlength\CJS@licenceht -\newcommand\CJS@licencesample{% +\def\CJS@licencesample{% {\ccbyncnd*} 2023 The Authors. The Canadian Journal of Statistics~{\textbar}~La revue canadienne de statistique published by Wiley Periodicals LLC on behalf of Statistical Society of @@ -4319,7 +4738,8 @@ \newcommand\CJS@measurelicence{% \setbox\CJS@licencebox=\vbox{% \CJS@setlicencefont - \ifdefempty{\CJS@licence}{\CJS@licencesample}{\CJS@licence}} + \ifCJS@specialack\CJS@specialackstatement\fi + \ifdefempty{\CJS@licence}{\CJS@licencesample}{\CJS@licence}}% \setlength\CJS@licenceht{\dimexpr\ht\CJS@licencebox+\dp\CJS@licencebox}} % \end{macrocode} % \end{macro} @@ -4343,14 +4763,17 @@ % Inspired by the package \pkg{ccicons} (not used by the class since % \pkg{fontawesome5} contains all the Creative Commons icons). % +% \changes{1.1a}{2024-07-25}{Implementation: fix the generation of +% spacing in the \cs{ccby*} commands.} % \begin{macro}{\ccby,\ccby*} % The command \cmd{\ccby} typesets the icons for the Attribution % licence: {\ccby}. % \begin{macrocode} \newcommand*\ccby{\ccby@\@ifstar{~\faCopyright[regular]}\relax} -\newcommand*\ccby@{\mbox{% - \faCreativeCommons\kern0.1em% - \faCreativeCommonsBy\kern0.1em}} +\def\CJS@fakern{\kern0.1em} +\def\ccby@{\mbox{% + \faCreativeCommons\CJS@fakern + \faCreativeCommonsBy\CJS@fakern}} % \end{macrocode} % \end{macro} % @@ -4359,9 +4782,9 @@ % Attribution"-ShareAlike licence: {\ccbysa}. % \begin{macrocode} \newcommand*\ccbysa{\ccbysa@\@ifstar{~\faCopyright[regular]}\relax} -\newcommand*\ccbysa@{\mbox{% - \faCreativeCommons\kern0.1em% - \faCreativeCommonsBy\kern0.1em% +\def\ccbysa@{\mbox{% + \faCreativeCommons\CJS@fakern + \faCreativeCommonsBy\CJS@fakern \faCreativeCommonsSa}} % \end{macrocode} % \end{macro} @@ -4371,9 +4794,9 @@ % Attribution"-NonCommercial licence: {\ccbync}. % \begin{macrocode} \newcommand*\ccbync{\ccbync@\@ifstar{~\faCopyright[regular]}\relax} -\newcommand*\ccbync@{\mbox{% - \faCreativeCommons\kern0.1em% - \faCreativeCommonsBy\kern0.1em% +\def\ccbync@{\mbox{% + \faCreativeCommons\CJS@fakern + \faCreativeCommonsBy\CJS@fakern \faCreativeCommonsNc}} % \end{macrocode} % \end{macro} @@ -4384,10 +4807,10 @@ % {\ccbyncsa}. % \begin{macrocode} \newcommand*\ccbyncsa{\ccbyncsa@\@ifstar{~\faCopyright[regular]}\relax} -\newcommand*\ccbyncsa@{\mbox{% - \faCreativeCommons\kern0.1em% - \faCreativeCommonsBy\kern0.1em% - \faCreativeCommonsNc\kern0.1em% +\def\ccbyncsa@{\mbox{% + \faCreativeCommons\CJS@fakern + \faCreativeCommonsBy\CJS@fakern + \faCreativeCommonsNc\CJS@fakern \faCreativeCommonsSa}} % \end{macrocode} % \end{macro} @@ -4397,9 +4820,9 @@ % Attribution"-NoDerivatives licence: {\ccbynd}. % \begin{macrocode} \newcommand*\ccbynd{\ccbynd@\@ifstar{~\faCopyright[regular]}\relax} -\newcommand*\ccbynd@{\mbox{% - \faCreativeCommons\kern0.1em% - \faCreativeCommonsBy\kern0.1em% +\def\ccbynd@{\mbox{% + \faCreativeCommons\CJS@fakern + \faCreativeCommonsBy\CJS@fakern \faCreativeCommonsNd}} % \end{macrocode} % \end{macro} @@ -4409,10 +4832,10 @@ % Attribution"-NonCommercial"-NoDerivatives licence: {\ccbyncnd}. % \begin{macrocode} \newcommand*\ccbyncnd{\ccbyncnd@\@ifstar{~\faCopyright[regular]}\relax} -\newcommand*\ccbyncnd@{\mbox{% - \faCreativeCommons\kern0.1em% - \faCreativeCommonsBy\kern0.1em% - \faCreativeCommonsNc\kern0.1em% +\def\ccbyncnd@{\mbox{% + \faCreativeCommons\CJS@fakern + \faCreativeCommonsBy\CJS@fakern + \faCreativeCommonsNc\CJS@fakern \faCreativeCommonsNd}} % \end{macrocode} % \end{macro} @@ -4447,16 +4870,20 @@ % \end{macrocode} % \end{macro} % -% \begin{macro}{\mat,\trsp,\tr,\diag} +% \changes{1.1}{2024-07-13}{Implementation: simpler definition of +% \cs{mat} and \cs{matit} using \cs{let} instead of \cs{newcommand*}.} +% \begin{macro}{\mat,\matit,\trsp,\tr,\diag} % The class provides special commands to typeset matrix and vector % names, a carefully designed transpose symbol, and the most common % linear algebra operators. % \begin{macrocode} \iftutex - \newcommand*\mat[1]{\symbf{#1}} + \let\mat\symbf + \let\matit\symbfit \newcommand*\trsp{^{\mkern-1.5mu\symsfup{T}}} \else - \newcommand*\mat[1]{\mathbf{#1}} + \let\mat\mathbf + \let\matit\mathbfit \newcommand*\trsp{^{\mkern-1.5mu\mathsf{T}}} \fi \DeclareMathOperator{\tr}{tr} @@ -4530,6 +4957,8 @@ % \subsection{Computer code and software} % \label{sec:implementation:software} % +% \changes{1.1a}{2024-07-25}{Implementation: prevent hyphenation in +% \cs{proglang} using a simple \cs{mbox}.} % \begin{macro}{\proglang} % The command \cmd{\proglang} provides a means to uniformly typeset % the name of a software or programming language. The command also @@ -4537,7 +4966,7 @@ % shortcuts to the most common languages. Notice that the % \cmd{\Cpplang} case is specially crafted. % \begin{macrocode} -\newcommand*\proglang[1]{{\hyphenchar\font=-1 #1}} +\newrobustcmd*\proglang[1]{\mbox{#1}} \newcommand*\Rlang{\proglang{R}} \newcommand*\SASlang{\proglang{SAS}} \newcommand*\SPSSlang{\proglang{SPSS}} @@ -4545,13 +4974,13 @@ \newcommand*\Pylang{\proglang{Python}} \newcommand*\Julialang{\proglang{Julia}} \newcommand*\Clang{\proglang{C}} -\newcommand*\CJS@plus{% +\newcommand*\Cpplang{\proglang{C\CJS@plus\CJS@plus}} +\def\CJS@plus{% \ifx\f@family\sfdefault% \protect\hspace{-.04em}\protect\raisebox{-.125ex}{\larger+}% \else% \protect\hspace{-.03em}\protect\raisebox{.25ex}{\smaller+}% \fi} -\newcommand*\Cpplang{\proglang{C\CJS@plus\CJS@plus}} % \end{macrocode} % \end{macro} % @@ -4595,10 +5024,18 @@ % is handled by \pkg{natbib}. We loaded the package with the option % \code{sectionbib} to obtain the list of references as a section, but % \class{memoir} will use \cmd{\section} in such instances. We want an -% unnumbered section. To achieve this efficiently, we redefine -% the internal command of \class{memoir}. +% unnumbered section (yet showing in the virtual table of contents of +% the PDF). To achieve this efficiently, we redefine the internal +% command of \class{memoir}. +% \changes{1.1}{2024-07-02}{Implementation: add a +% \cs{addtocontentsline} command to the redefinition of +% \cs{@memb@bsec} to include the References section in the virtual +% table of contents of the PDF.} % \begin{macrocode} -\renewcommand{\@memb@bsec}{\section*{\bibname}\prebibhook} +\renewcommand{\@memb@bsec}{% + \section*{\bibname}% + \addcontentsline{toc}{section}{\bibname}% + \prebibhook} % \end{macrocode} % % Furthermore, we need to redefine the title of the section, because @@ -4706,14 +5143,14 @@ % \end{macro} % % \begin{macro}{\received,\accepted} -% The article history --- dates when the article was received and -% accepted --- is printed at the very end of the article when present. +% The article history---dates when the article was received and +% accepted---is printed at the very end of the article when present. % Its treatment involves a number of steps. % % First, the dates themselves are input in ISO format YYYY-MM-DD and % converted in language dependent strings using the package % \pkg{datetime2}. In English, we want to use the British format -% without the ordinal for the day: ``1 January 1970''. In French, we +% without the ordinal for the day: 1 January 1970. In French, we % can simply rely on the default format. % \begin{macrocode} \DTMlangsetup[en-GB]{ord=omit} @@ -4750,36 +5187,73 @@ % \end{macrocode} % \end{macro} % +% \changes{1.1a}{2024-07-25}{Implementation: replace box registers +% \cs{@ne} and \cs{thr@@} by \cs{z@} and \cs{tw@}.} % We also define a decorative element similar to the one used on the % title page, only adapted for a single line content. To create a % balanced element, we use the height of a letter with an ascender and % the depth of the old-style number 4. % \begin{macrocode} -\setbox\@ne=\vbox{\hbox{\firaoldstyle\small l4}} \newsavebox\CJS@historyornament \setbox\CJS@historyornament=\vbox{% - \setbox\thr@@\hbox{\vrule \@width1.5pt\@height\ht\@ne\@depth\dp\@ne} - \hbox{\textcolor{CJSpink}{\copy\thr@@}\kern.75pt% - \textcolor{CJSred}{\copy\thr@@}\kern.75pt% - \textcolor{CJSyellow}{\copy\thr@@}\kern3pt}} + \setbox\z@=\vbox{\hbox{\firaoldstyle\small l4}} + \setbox\tw@\hbox{\vrule \@width1.5pt\@height\ht\z@\@depth\dp\z@} + \hbox{\textcolor{CJSpink}{\copy\tw@}\kern.75pt + \textcolor{CJSred}{\copy\tw@}\kern.75pt + \textcolor{CJSyellow}{\copy\tw@}\kern3pt}} % \end{macrocode} % % Finally, the history information, when present, is printed at the % end of the article. % \begin{macrocode} -\newcommand*\CJS@historybox{ +\def\CJS@historybox{ \par\addvspace{2\baselineskip}\noindent% \smash{\box\CJS@historyornament \CJS@history}\par% \vspace*{40pt}} \AtEndDocument{\ifCJS@journalinfo\ifCJS@history\CJS@historybox\fi\fi} % \end{macrocode} % \end{macro} +% +% \changes{1.1}{2024-06-26}{Implementation: define the new command +% \cs{specialack}.} +% \begin{macro}{\specialack} +% The command \cmd{\specialack} is the generic interface to give +% special acknowledgement on the title page. The command inserts its +% first argument in the list of authors, and its second argument at +% the bottom of the title page, with the licensing information. Each +% argument may be empty, in which case the corresponding information +% is not displayed. +% \begin{macrocode} +\def\CJS@specialackstatement{} +\newcommand*\specialack[2]{% + \ifstrempty{#1}{}{% + \author{#1\CJS@specialackmark}} + \ifstrempty{#2}{}{% + \CJS@specialacktrue + \renewcommand*\CJS@specialackstatement{\CJS@specialackmark\,#2\medskip\newline}}} +% \end{macrocode} +% \end{macro} +% +% \changes{1.1}{2024-06-26}{Implementation: define the new command +% \cs{specialackmark}.} +% \begin{macro}{\specialackmark} +% The command \cmd{\specialackmark} changes the footnote marker used +% by \cmd{\specialack} from its default definition. +% \begin{macrocode} +\def\CJS@specialackmark{\textsuperscript{\ensuremath{*}}} +\newcommand*\specialackmark[1]{% + \renewcommand*\CJS@specialackmark{#1}} +% \end{macrocode} +% \end{macro} +% %</class> % ^^A <<<<< End of the code of the class % % ^^A Change notes for the templates must appear before \Finale % \changes{0.93}{2023-11-07}{Templates: fix a missing closing brace in % \cs{author} commands.} +% \changes{1.1}{2024-01-23}{Templates: revise the description of the +% \texttt{sharing} environment.} % \Finale % % \iffalse @@ -4893,18 +5367,18 @@ %<fr> %% la page de titre automatiquement. \begin{englishabstract} <Insert your English abstract here. The abstract should be concise - --- up to 10 lines long --- and descriptive. Avoid symbols as much - as possible. Formulas are strongly discouraged, and citations - should be avoided.> + (up to 10 lines long) and descriptive. Avoid symbols as much as + possible. Formulas are strongly discouraged, and citations should + be avoided.> %<fr> [Un résumé en anglais sera fourni pour les auteurs qui ne peuvent %<fr> le préparer eux-mêmes.] \end{englishabstract} \begin{frenchabstract} <Insérer le texte du résumé en français ici. Le résumé doit être - concis --- une dizaine de lignes --- et descriptif. Éviter autant - que possible les symboles. Les équations mathématiques sont - fortement découragées et les citations sont à éviter.> + concis (une dizaine de lignes) et descriptif. Éviter autant que + possible les symboles. Les équations mathématiques sont fortement + déconseillées et les citations sont à éviter.> %<en> [We will supply a French abstract for those authors who %<en> can't prepare it themselves.] \end{frenchabstract} @@ -4958,13 +5432,15 @@ %<fr> <Texte libre> \end{supplement} -%<en> %% DATA SHARING (optional - comment out if unused). Describe how to -%<en> %% access data that you wish to share. Provide a permanent link such -%<en> %% as a Document Object Identifier (DOI) or an URL. -%<fr> %% PARTAGE DES DONNÉES (optionnel - commenter si inutilisé). -%<fr> %% Expliquer comment accéder à des données de l'article mises à -%<fr> %% disposition. Fournir un lien permanent, comme un identificateur -%<fr> %% d'objets numériques (DOI) ou une adresse URL. +%<en> %% DATA SHARING (mandatory). In accordance with the Expect Data +%<en> %% Sharing editorial policy of Wiley, make a statement about the +%<en> %% availability or absence of shared data. Provide a permanent link +%<en> %% such as a Document Object Identifier (DOI) or an URL. +%<fr> %% PARTAGE DES DONNÉES (obligatoire). Conformément à la politique +%<fr> %% éditoriale «Expect Data Sharing» de Wiley, vous devez indiquer +%<fr> %% les conditions de partage des données de recherche, ou l'absence +%<fr> %% de celles-ci, le cas échéant. Fournir un lien permanent, comme un +%<fr> %% identificateur d'objets numériques (DOI) ou une adresse URL. \begin{sharing} %<en> <Free form text> %<fr> <Texte libre> |