diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/nwejm/french/documentation/nwejm-fr.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/nwejm/french/documentation/nwejm-fr.tex | 266 |
1 files changed, 183 insertions, 83 deletions
diff --git a/Master/texmf-dist/doc/latex/nwejm/french/documentation/nwejm-fr.tex b/Master/texmf-dist/doc/latex/nwejm/french/documentation/nwejm-fr.tex index 7c898063a93..a004e1facf5 100644 --- a/Master/texmf-dist/doc/latex/nwejm/french/documentation/nwejm-fr.tex +++ b/Master/texmf-dist/doc/latex/nwejm/french/documentation/nwejm-fr.tex @@ -1,7 +1,7 @@ \documentclass[french,nolocaltoc]{nwejmart} % -\DTMsavedate{release-date}{2017-02-14} -\newcommand{\releaseversion}{0.98d} +\DTMsavedate{release-date}{2018-04-07} +\newcommand{\releaseversion}{0.98e} % \usepackage{denisbdoc} \usepackage{tabulary} @@ -30,6 +30,7 @@ \newacronym{bap}{bap}{bounded approximation property} \newacronym{msc}{msc}{Mathematical Subject Classification} \newacronym{url}{url}{Uniform Resource Locator} +\newacronym{tdm}{tdm}{table des matières} % \newtheorem{article} \newtheorem[title=Fait,style=definition]{fact} @@ -104,7 +105,7 @@ classe a pour but : \begin{itemize} \item elle charge le \Package{inputenc}\footnote{% Il convient donc de \emph{ne pas} charger ce package : on se reportera - à la \vref{sec-canevas-de-fichier} pour un canevas de fichier source + à l'\vref{sec-canevas-de-fichier} pour un canevas de fichier source destiné à la \nwejm{} et notamment pour un préambule typique.% % } @@ -210,25 +211,67 @@ finale. \subsection{Titre, sous-titre} \label{sec-titre} -\begin{docCommand}[doc description=\mandatory]{title}{\oarg{titre court}\marg{titre}} - Cette commande définit le \meta{titre} de l'article qui apparaît : +\begin{docCommand}[doc new=2017-10-23]{title}{\oarg{titre alternatif {\normalfont\ttfamily\acrshort*{tdm}}}\oarg{titre alternatif entête}\marg{titre}} + Cette commande définit, pour l'article en cours : \begin{itemize} - \item en début d'article ; - \item en titre courant\footnote{En entête.} sur les pages paires ; - \item comme métadonnée \enquote{Titre} du fichier \textsc{pdf} correspondant ; - \item dans la table des matières du volume où sera publié l'article. + \item son \meta{titre} figurant en 1\iere{} page ; + \item son \emph{éventuel} \meta{titre alternatif + {\normalfont\ttfamily\acrshort*{tdm}}} figurant : + \begin{itemize} + \item dans le volume où l'article sera publié : + \begin{itemize} + \item en \gls{tdm} ; + \item en signet ; + \end{itemize} + \item dans le fichier \textsc{pdf} de l'article autonome, en métadonnée + \enquote{Titre} ; + \end{itemize} + \item son \emph{éventuel} \meta{titre alternatif entête} figurant en + entête\footnote{\Ie{} en titre courant.} sur les pages paires. \end{itemize} + L'usage précis de cette commande est synthétisé à la + \vref{tab-commande-title}. \end{docCommand} -\begin{docCommand}{subtitle}{\oarg{sous-titre court}\marg{sous-titre}} - Cette commande définit l'éventuel \meta{sous-titre} de l'article. Celui-ci - est automatiquement ajouté au titre. -\end{docCommand} +\begin{table}[htb] + \centering + \caption{Usage (des deux arguments optionnels) de la commande + \protect\refCom{title} } + \label{tab-commande-title} +\footnotesize% +\lstset{% + deletekeywords={title},deletekeywords={[3]title},% +} +\begin{tabular}{|l|c|c|c|} + \cline{2-4} + \multicolumn{1}{c|}{} & 1\iere{} page & \gls{tdm} & entête \\\hline + \lstinline+\title{+\meta{titre}\lstinline+}+ & \multicolumn{3}{c|}{\meta{titre}} \\\hline + \lstinline+\title[+\meta{alt. {\normalfont\ttfamily\acrshort*{tdm}}}\lstinline+]{+\meta{titre}\lstinline+}+ & \meta{titre} & \multicolumn{2}{c|}{\meta{alt. {\normalfont\ttfamily\acrshort*{tdm}}}} \\\hline + \lstinline+\title[][+\meta{alt. entête}\lstinline+]{+\meta{titre}\lstinline+}+ & \multicolumn{2}{c|}{\meta{titre}} & \meta{alt. entête} \\\hline + \lstinline+\title[+\meta{alt. {\normalfont\ttfamily\acrshort*{tdm}}}\lstinline+][+\meta{alt. entête}\lstinline+]{+\meta{titre}\lstinline+}+ & \meta{titre} & \meta{alt. {\normalfont\ttfamily\acrshort*{tdm}}} & \meta{alt. entête} \\\hline +\end{tabular} +\end{table} -Les commandes \refCom{title} et \refCom{subtitle} admettent un argument -optionnel permettant de spécifier un \meta{(sous-)titre court} de l'article qui -figure alors à la place du (sous-)titre \enquote{normal} en titre courant et -dans la table des matières. +\begin{docCommand}{subtitle}{\oarg{sous-titre alternatif {\normalfont\ttfamily\acrshort*{tdm}}}\marg{sous-titre}} + Cette commande définit \emph{éventuellement}, pour l'article en cours : + \begin{itemize} + \item son \meta{sous-titre} figurant en 1\iere{} page à la suite + du \meta{titre} ; + \item son \emph{éventuel} \meta{sous-titre alternatif + {\normalfont\ttfamily\acrshort*{tdm}}} figurant à la suite du + \meta{titre}\footnote{Ou éventuel \meta{titre alternatif + {\normalfont\ttfamily\acrshort*{tdm}}}.} : + \begin{itemize} + \item dans le volume où l'article sera publié : + \begin{itemize} + \item en \gls{tdm} ; + \item en signet ; + \end{itemize} + \item dans le fichier \textsc{pdf} de l'article autonome, en métadonnée + \enquote{Titre}. + \end{itemize} + \end{itemize} +\end{docCommand} \begin{bodycode} \title[Le Traité du calcul des probabilités]{Le Traité du calcul des @@ -269,6 +312,9 @@ suivante. En cas d'auteurs multiples, il suffit de (et il faut) recourir ou les majuscules)\footnote{Dans les articles en français, ce nom sera automatiquement composé en petites capitales.}. \end{enumerate} + + La métadonnée \enquote{Auteur} du \File{PDF} produit contient automatiquement + le ou les auteurs spécifiés. \end{dbwarning} La commande \refCom{author} admet un argument optionnel permettant de spécifier @@ -349,11 +395,11 @@ et \refKey{affiliationtagged} suivantes. Cette commande permet de spécifier les \meta{mots clés} de l'article sous la forme d'une liste séparée par des virgules. - La propriété \enquote{\texttt{pdfkeywords}} du \File{PDF} produit contient - automatiquement les \meta{mots clés} spécifiés. Dans le cas où ceux-ci - contiennent des caractères non admis en propriétés des fichiers \file{PDF} - (notamment des mathématiques), on spécifiera en argument optionnel une - \meta{variante des mots clés} ne contenant que des caractères autorisés. + La métadonnée \enquote{Mots-clés} du \File{PDF} produit contient + automatiquement les \meta{mots clés} spécifiés. % Dans le cas où ceux-ci + % contiennent des caractères non admis en métadonnées des fichiers \file{PDF} + % (notamment des mathématiques), on spécifiera en argument optionnel une + % \meta{variante des mots clés} ne contenant que des caractères autorisés. \end{docCommand} \begin{bodycode}[listing options={deletekeywords={[5]keywords}}] @@ -438,6 +484,50 @@ Le titre proprement dit de l'article, regroupant tous les éléments saisis à l commande \refCom{printbibliography} destinée à être utilisée en fin d'article. \end{dbremark} +\section{Commandes de structuration} + +La \nwejmauthorcl{} modifie la commande usuelle de structuration +\docAuxCommand{section} pour permettre d'en différencier le titre alternatif +figurant en \gls{tdm} de celui figurant en entête\footnote{On notera, de ce + point de vue, la similitude avec la commande \protect\refCom{title}.}. + +\begin{docCommand}[doc new=2017-10-23]{section}{\oarg{titre alternatif {\normalfont\ttfamily\acrshort*{tdm}}}\oarg{titre alternatif entête}\marg{titre}} + Cette commande définit, pour la section en cours : + \begin{itemize} + \item son \meta{titre} figurant au fil du texte ; + \item son \emph{éventuel} \meta{titre alternatif + {\normalfont\ttfamily\acrshort*{tdm}}} figurant, dans le volume où + l'article sera publié : + \begin{itemize} + \item en \gls{tdm} ; + \item en signet. + \end{itemize} + \item son \emph{éventuel} \meta{titre alternatif entête} figurant en + entête\footnote{\Ie{} en titre courant.} sur les pages impaires. + \end{itemize} + L'usage précis de cette commande est synthétisé à la + \vref{tab-commande-section}. +\end{docCommand} + +\begin{table}[htb] + \centering + \caption{Usage (des deux arguments optionnels) de la commande + \protect\refCom{section} } + \label{tab-commande-section} +\footnotesize% +\lstset{% + deletekeywords={section},deletekeywords={[3]section},% +} +\begin{tabular}{|l|c|c|c|} + \cline{2-4} + \multicolumn{1}{c|}{} & fil du texte & \gls{tdm} & entête \\\hline + \lstinline+\section{+\meta{titre}\lstinline+}+ & \multicolumn{3}{c|}{\meta{titre}} \\\hline + \lstinline+\section[+\meta{alt. {\normalfont\ttfamily\acrshort*{tdm}}}\lstinline+]{+\meta{titre}\lstinline+}+ & \meta{titre} & \multicolumn{2}{c|}{\meta{alt. {\normalfont\ttfamily\acrshort*{tdm}}}} \\\hline + \lstinline+\section[][+\meta{alt. entête}\lstinline+]{+\meta{titre}\lstinline+}+ & \multicolumn{2}{c|}{\meta{titre}} & \meta{alt. entête} \\\hline + \lstinline+\section[+\meta{alt. {\normalfont\ttfamily\acrshort*{tdm}}}\lstinline+][+\meta{alt. entête}\lstinline+]{+\meta{titre}\lstinline+}+ & \meta{titre} & \meta{alt. {\normalfont\ttfamily\acrshort*{tdm}}} & \meta{alt. entête} \\\hline +\end{tabular} +\end{table} + \section{Bibliographie} \label{sec-bibliographie} @@ -568,7 +658,7 @@ La \nwejmauthorcl{} : \item \package*{mathtools} qui lui-même charge \package*{amsmath} (mais en l'étendant et en corrigeant certains de ses défauts), si bien que toutes les commandes de ces deux packages sont disponibles ; - \item \package*{mathrsfs} qui fournit de jolies lettres calligraphiques (via + \item \package*{rsfso} qui fournit de jolies lettres calligraphiques (via la commande \docAuxCommand{mathscr}) ; \end{itemize} \item redéfinit certaines commandes et en fournit quelques nouvelles, listées @@ -739,7 +829,7 @@ La \nwejmauthorcl{} : \subsubsection{Commandes prédéfinies} -La classe offre un certain nombre de commandes listées dans le \vref{com-paired} +La classe offre un certain nombre de commandes listées \vref{com-paired}, facilitant la saisie de paires de délimiteurs courants, par exemple pour les normes, les valeurs absolues, etc. @@ -977,7 +1067,7 @@ créer de nouveaux si besoin est (cf. commande \refCom{newtheorem}). \subsubsection{Environnements de type \enquote{théorème} prédéfinis} \label{sec:envir-de-type} -Le \vref{env-theorems} liste les théorèmes et objets analogues prédéfinis par la +La \vref{env-theorems} liste les théorèmes et objets analogues prédéfinis par la \nwejmauthorcl{} avec : \begin{description} \item[en colonne~1] le nom des environnements correspondants ; @@ -1006,7 +1096,7 @@ Le \vref{env-theorems} liste les théorèmes et objets analogues prédéfinis pa \end{table} \begin{dbremark}{\enquote{Théorèmes} non numérotés}{} - Chacun des environnements du \vref{env-theorems} admet une version étoilée + Chacun des environnements de la \vref{env-theorems} admet une version étoilée créant une version non numérotée de l'objet de type \enquote{théorème} correspondant. \end{dbremark} @@ -1034,7 +1124,7 @@ Le \vref{env-theorems} liste les théorèmes et objets analogues prédéfinis pa On remarque dans l'exemple précédent que les \enquote{théorèmes} ont des mises en forme variables. La \nwejmauthorcl{} fournit effectivement trois styles de \enquote{théorèmes}, \docValue{theorem}, \docValue{definition} et -\docValue{proof}, dont les caractéristiques sont indiquées au +\docValue{proof}, dont les caractéristiques sont indiquées à la \vref{env-theorems-styles}. \begin{table} @@ -1138,7 +1228,7 @@ hypothèse est introduite par la commande \docAuxCommand{item}. \begin{bodycode}[listing and text] \begin{axiom}\label{mon-axiome} - Chaque assertion suivante est admise. + Chacune des assertions suivantes est admise. \begin{assertions} \item\label{rare-cher} Tout ce qui est rare est cher. \item\label{cheval} Un cheval bon marché est rare. @@ -1223,9 +1313,9 @@ On soupçonne que non \aside*{par exemple on s'attend à ce que \section{Sélection d'outils fournis par des packages tiers} Cette section donne une liste d'outils (commandes et environnements) fournis par -des packages automatiquement chargés par la \nwejmauthorcl\footnote{La - \vref{sec-packages-charges-ou-pas} liste ceux dont les fonctionnalités peuvent - être utiles aux auteurs.}. +des packages automatiquement chargés par la +\nwejmauthorcl\footnote{L'\vref{sec-packages-charges-ou-pas} liste ceux dont les + fonctionnalités peuvent être utiles aux auteurs.}. \begin{dbwarning}{Liste des fonctionnalités des packages tiers non exhaustive}{} Cette liste est \emph{non exhaustive} : @@ -1272,52 +1362,52 @@ canevas de fichier source [...] % à \refCom{vref}. % \end{dbremark} -\subsection{\enquote{Équations} (non-)numérotées} -\label{sec:equat-non-numer} - -Le lecteur, rompu à la composition de formules de mathématiques, connaît -certainement le \Package*{amsmath} et les environnements qu'il fournit : -\begin{itemize} -\item |equation|, |align|, |gather|, |multline| et |flalign| qui numérotent - leur contenu ; -\item |equation*|, |align*|, |gather*|, |multline*| et |flalign*| qui \emph{ne} - numérotent \emph{pas} leur contenu ; -\end{itemize} -et utilise les premiers si (et seulement si, théoriquement) les contenus -correspondants font l'objet de références croisées. - -Avoir à choisir entre les versions numérotées ou pas présente au moins deux -inconvénients pour l'utilisateur : -\begin{enumerate} -\item cela l'oblige à se poser à chaque fois la question de la pertinence de la - numérotation de sa formule ; -\item son choix peut ultérieurement s'avérer caduc\footnote{Et donc nécessiter - de passer par exemple d'un environnement étoilé à un non-étoilé \aside*{donc - avec ajout d'un label}.}. -\end{enumerate} -Pour pallier cela, la \nwejmauthorcl{} charge automatiquement le -\Package{autonum} qui : -\begin{enumerate} -\item permet de ne recourir qu'aux environnements non-étoilés ; -\item assure automatiquement que les formules effectivement numérotées seront - celles, et seulement celles, s'avérant faire l'objet de références croisées au - sein du document. -\end{enumerate} - -\begin{bodycode}[listing and text] -L'\vref{euler-identity} mérite une référence croisée. -\begin{equation}\label{euler-identity} - \E[\I\pi]+1=0 -\end{equation} -C'est bien la seule ici. -\begin{equation}\label{not-interesting} - 0=0 -\end{equation} -Malheureusement. -\begin{equation} - 1=1 -\end{equation} -\end{bodycode} +% \subsection{\enquote{Équations} (non-)numérotées} +% \label{sec:equat-non-numer} +% +% Le lecteur, rompu à la composition de formules de mathématiques, connaît +% certainement le \Package*{amsmath} et les environnements qu'il fournit : +% \begin{itemize} +% \item |equation|, |align|, |gather|, |multline| et |flalign| qui numérotent +% leur contenu ; +% \item |equation*|, |align*|, |gather*|, |multline*| et |flalign*| qui \emph{ne} +% numérotent \emph{pas} leur contenu ; +% \end{itemize} +% et utilise les premiers si (et seulement si, théoriquement) les contenus +% correspondants font l'objet de références croisées. +% +% Avoir à choisir entre les versions numérotées ou pas présente au moins deux +% inconvénients pour l'utilisateur : +% \begin{enumerate} +% \item cela l'oblige à se poser à chaque fois la question de la pertinence de la +% numérotation de sa formule ; +% \item son choix peut ultérieurement s'avérer caduc\footnote{Et donc nécessiter +% de passer par exemple d'un environnement étoilé à un non-étoilé \aside*{donc +% avec ajout d'un label}.}. +% \end{enumerate} +% Pour pallier cela, la \nwejmauthorcl{} charge automatiquement le +% \Package{autonum} qui : +% \begin{enumerate} +% \item permet de ne recourir qu'aux environnements non-étoilés ; +% \item assure automatiquement que les formules effectivement numérotées seront +% celles, et seulement celles, s'avérant faire l'objet de références croisées au +% sein du document. +% \end{enumerate} +% +% \begin{bodycode}[listing and text] +% L'\vref{euler-identity} mérite une référence croisée. +% \begin{equation}\label{euler-identity} +% \E[\I\pi]+1=0 +% \end{equation} +% C'est bien la seule ici. +% \begin{equation}\label{not-interesting} +% 0=0 +% \end{equation} +% Malheureusement. +% \begin{equation} +% 1=1 +% \end{equation} +% \end{bodycode} \subsection{Acronymes} \label{sec:acronymes} @@ -1546,9 +1636,10 @@ différents packages sont donc à disposition des auteurs de la \nwejm{}. \end{description} \item[\package{kpfonts} :] police principale du document : \begin{description} - \item[option par défaut :] \docAuxKey{noDcommand} ; + \item[options par défaut :] \docAuxKey{noDcommand}, \docAuxKey{easyscsl} ; \end{description} \item[\package{graphicx} :] inclusion d'images ; +\item[\package{subcaption} :] sous-figures et sous-tableaux ; \item[\package{adjustbox} :] ajustement de la position de boîtes, par exemple d'images ; \item[\package{xspace} :] définition de commandes qui ne \enquote{mangent} pas @@ -1561,7 +1652,8 @@ différents packages sont donc à disposition des auteurs de la \nwejm{}. cf. \vref{sec-guillemets-citations}.} : \begin{description} \item[option par défaut :] \docAuxKey{autostyle} ; - \item[réglage par défaut] |\SetCiteCommand{\autocite}| ; + \item[réglage par défaut :] + \lstinline[alsolanguage={[csquotes]TeX},alsolanguage={[biblatex]TeX}]|\SetCiteCommand{\autocite}| ; \end{description} \item[\package{biblatex} :] gestion puissante de la bibliographie ; \item[\package{datetime2} :] formats de dates et de (zones de) temps : @@ -1572,14 +1664,22 @@ différents packages sont donc à disposition des auteurs de la \nwejm{}. hypertextes\footnote{Cf. \vref{sec-url}.} : \begin{description} \item[option par défaut :] \docAuxKey{hidelinks}, - \docAuxKey{hypertexnames}(|=false|) ; + \docAuxKey{pdfencoding}\lstinline[alsolanguage={[hyperref]TeX}]|=unicode|, + \docAuxKey{final}, \docAuxKey{breaklinks}, + \docAuxKey{hypertexnames}|=false| ; \end{description} \item[\package{glossaries} :] création de glossaires et (listes d')acronymes : \begin{description} \item[option par défaut :] \docAuxKey{nowarn} ; \end{description} -\item[\package{varioref} et \package{cleveref} :] références croisées - intelligentes\footnote{Cf. \vref{sec-references-croisees}.}. +\item[\package{varioref} :] références de pages intelligentes. +\item[\package{cleveref} :] références croisées + intelligentes\footnote{Cf. \vref{sec-references-croisees}.} ; + \begin{description} + \item[option par défaut :] \docAuxKey{french}, \docAuxKey{ngerman}, + \docAuxKey{dutch}, \docAuxKey{english}, \docAuxKey{noabbrev}, + \docAuxKey{capitalize}. + \end{description} \end{description} \subsection{Packages non chargés par la classe}\label{sec:packages-non-charges} @@ -1593,7 +1693,7 @@ notables sont précisés. \begin{description} \item[\package{tikz-cd} :] création simple de diagrammes commutatifs de très haute qualité\footnote{Le \Package{xy}, souvent utilisé pour de tels - diagrammes, est incomptible avec la présente : + diagrammes, est incomptible avec la présente classe : cf. \vref{sec-incompatibilites}.} ; \item[\package{pgfplots} :] création simple de graphiques (de dimensions~$2$ ou~$3$) de très haute qualité pour représenter des fonctions ou des données |