summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/udes-genie-these/udes-genie-these.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/udes-genie-these/udes-genie-these.dtx')
-rw-r--r--macros/latex/contrib/udes-genie-these/udes-genie-these.dtx76
1 files changed, 50 insertions, 26 deletions
diff --git a/macros/latex/contrib/udes-genie-these/udes-genie-these.dtx b/macros/latex/contrib/udes-genie-these/udes-genie-these.dtx
index 9b8282eb1b..25fa39a50e 100644
--- a/macros/latex/contrib/udes-genie-these/udes-genie-these.dtx
+++ b/macros/latex/contrib/udes-genie-these/udes-genie-these.dtx
@@ -16,7 +16,7 @@
% can be contacted at Charles-Antoine.Brunet@USherbrooke.ca
%
% This work consists of the files udes-genie-these.dtx and udes-genie-these.ins
-% and the derived files udes-genie-these.cls and udes-genie-protocole.cls.
+% and the derived files udes-genie-these.cls.
% \fi
%
% \iffalse
@@ -26,9 +26,9 @@
%<these|protocole>%%--- IDENTIFICATION ------------------------------------------------------
%<these|protocole>%%-----------------------------------------------------------------------------
%<these|protocole>
-%<these>\ProvidesExplClass{udes-genie-these}{2022/09/19}{3.0}
+%<these>\ProvidesExplClass{udes-genie-these}{2022/11/17}{3.0.1}
%<these> {Université de Sherbrooke, Faculté de génie: classe de document pour thèses, mémoires, DPR et essais}
-%<protocole>\ProvidesExplClass{udes-genie-protocole}{2022/09/19}{3.0}
+%<protocole>\ProvidesExplClass{udes-genie-protocole}{2022/11/17}{3.0.1}
%<protocole> {Université de Sherbrooke, Faculté de génie: classe de document pour le protocole de rédaction}
%<these|protocole>
%<*driver>
@@ -37,7 +37,7 @@
\usepackage{kpfonts}
\usepackage[scaled=0.7881]{DejaVuSansMono}
\usepackage[french]{babel}
-\usepackage{hologo,setspace,parskip,microtype,xspace,tabularx,xcolor,pifont,bookmark}
+\usepackage{setspace,xspace,hologo,bookmark}
\hypersetup{colorlinks=true,linkcolor=blue,citecolor=blue,urlcolor=blue,linktocpage=true}
\setlength{\parskip}{1ex plus0.25ex minus0ex}
\setlength{\parindent}{0em}
@@ -69,11 +69,12 @@
\newcommand{\xelatex}{\hologo{XeLaTeX}\xspace}
\newcommand{\bibtex}{\hologo{BibTeX}\xspace}
\newcommand{\fac}{Faculté de génie\xspace}
+\newcommand{\overleaf}{\textsf{Overleaf}\xspace}
\newcommand{\protocole}{protocole\xspace}
\newcommand{\protocoleit}{\textit{protocole}\xspace}
\newcommand{\protlgu}{\textit{Protocole de rédaction aux études supérieures} de la Faculté de génie de l'Université de Sherbrooke\xspace}
-\newcommand{\package}{\textit{package}\xspace}
-\newcommand{\packages}{\textit{packages}\xspace}
+\newcommand{\package}{package\xspace}
+\newcommand{\packages}{packages\xspace}
\newcommand{\encodage}{UTF-8\xspace}
\newcommand{\enchamp}{\textbf{Nom} & \textbf{Requis} & \textbf{\bibtex}}
\newcommand{\non}{}
@@ -81,11 +82,12 @@
\newcommand{\bipm}{\textit{Bureau international des poids et mesures} (BIPM)\xspace} \newcommand{\siunitx}{\pkg{siunitx}\xspace}
\newcommand{\windows}{\textsf{Windows}\xspace}
\newcommand{\macos}{\textsf{MacOS}\xspace}
-\newcommand{\linux}{\textsf{Linux} (ou \textsf{UNIX})\xspace}
+\newcommand{\linux}{\textsf{Linux}\xspace}
\newcommand{\miktex}{\textsf{MiKTeX}\xspace}
\newcommand{\texlive}{\textsf{TeX Live}\xspace}
\newcommand{\tlmgr}{\textsf{TeX Live Manager}\xspace}
\newcommand{\ctan}{\textsf{CTAN}\xspace}
+\newcommand{\ctanurl}{\url{https://www.ctan.org/pkg/udes-genie-these}}
\addto\captionsfrench
{
@@ -122,17 +124,18 @@
% Grave accent \` Left brace \{ Vertical bar \|
% Right brace \} Tilde \~}
%
-% \changes{v1.0}{2017/01/18}{Première version}
-% \changes{v1.1}{2017/07/18}{Adaptation à la nouvelle version de babel (changements internes).}
-% \changes{v1.2}{2017/12/21}{Adaptation à la nouvelle version de \latexiii (changements internes).}
-% \changes{v2.0}{2018/09/26}{Adaptations pour respecter la nouvelle version du protocole de rédaction.}
-% \changes{v2.0.1}{2020/04/17}{(Aussi connue comme v2.0a) Correction de bugs. Changements internes. Changements à la documentation.}
-% \changes{v2.0.2}{2022/09/15}{Maintenance (LaTeX2e 2020-02-02 à 2022-06-01). Distribution sur CTAN. Adaptations à la documentation.}
-% \changes{v3.0}{2022/09/19}{Support pour \pkg{biblatex}. Ajustements à la documentation.}
+% \changes{v1.0}{2017-01-18}{Première version}
+% \changes{v1.1}{2017-07-18}{Adaptation à la nouvelle version de babel (changements internes).}
+% \changes{v1.2}{2017-12-21}{Adaptation à la nouvelle version de \latexiii (changements internes).}
+% \changes{v2.0}{2018-09-26}{Adaptations pour respecter la nouvelle version du protocole de rédaction.}
+% \changes{v2.0.1}{2020-04-17}{(Aussi connue comme v2.0a) Correction de bugs. Changements internes. Changements à la documentation.}
+% \changes{v2.0.2}{2022-09-15}{Maintenance (LaTeX2e 2020-02-02 à 2022-06-01). Distribution sur CTAN. Adaptations à la documentation.}
+% \changes{v3.0}{2022-09-19}{Support pour \pkg{biblatex}. Ajustements à la documentation.}
+% \changes{v3.0.1}{2022-11-17}{Ajustements à la documentation et à l'exemple. Changements internes pour les formats LaTeX antérieurs à 2022-06-01.}
%
% \GetFileInfo{udes-genie-these.dtx}
%
-% \title{CLASSE DE DOCUMENT \latex POUR LA RÉDACTION AUX ÉTUDES SUPÉRIEURES À LA FACULTÉ DE GÉNIE DE L'UNIVERSITÉ DE SHERBROOKE\\{\large \laclassetitre, version 3.0}}
+% \title{CLASSE DE DOCUMENT \latex POUR LA RÉDACTION AUX ÉTUDES SUPÉRIEURES À LA FACULTÉ DE GÉNIE DE L'UNIVERSITÉ DE SHERBROOKE\\{\large \laclassetitre, version 3.0.1}}
% \author{Charles-Antoine Brunet}
% \date{\today}
% \maketitle
@@ -155,11 +158,34 @@
% Le style de références est maintenant spécifié par le nouveau champ de configuration |style-references| et non plus dans le préambule avec la macro |\bibliographystyle|. Il faut donc retirer une macro du style |\bibliographystyle{AAA}| et la remplacer par un champ de configuration du genre |style-references = AAA|. C'est tout!
%
%\section{Installation et vérification}\label{sec:inst}
-% La classe \laclasse peut être installée comme tout autre \package \latex avec le gestionnaire de \packages de votre distribution, comme avec la console de \miktex ou le \tlmgr. Du même coup, il faut s'assurer d'avoir une version à jour de la distribution \latex, car \laclasse utilise des fonctionnalités qui sont relativement récentes. Si vous optez pour une installation manuelle, la classe \laclasse est disponible sur \href{https://www.ctan.org/pkg/udes-genie-these/}{\ctan} et s'installe en accord avec les procédures spécifiées dans la documentation de votre distribution \latex.
+% La classe \laclasse utilise des fonctionnalités récentes de \latex. Il faut donc vous assurer d'avoir une version à jour de votre distribution \latex (\texlive ou \miktex). Si vous utilisez \overleaf, il faut vous assurer que votre projet compile avec la version la plus récente de \texlive.
%
-% Afin de vérifier que l'installation s'est bien passée, il vous est suggéré de compiler l'exemple distribué avec \laclasse. C'est le meilleur moyen de savoir si votre installation \latex a tout ce qu'il faut pour utiliser \laclasse. L'exemple se trouve dans le même répertoire que la documentation.
+% Selon votre distribution \latex, choisissez l'option qui vous convient.
+% la classe
+% \subsection*{\texlive et \miktex}
+% La classe \laclasse est disponible sur \ctan et fait donc partie des deux distributions. Il y a deux options d'installation: pour une utilisation à \textit{long terme} et pour une utilisation à \textit{court terme}.
%
-% L'exemple distribué avec \laclasse a été compilé avec succès sous \windows, \macos et \linux avec les distributions \miktex et \texlive. Si des erreurs surviennent avec l'exemple, c'est que l'installation de \laclasse n'a pas été faite correctement ou que l'installation de \latex qui est utilisée est incomplète ou désuète.
+% \textbf{Long terme:}\\ Si vous pensez utiliser \laclasse pour les prochaines années, alors vous pouvez installer \laclasse comme tout autre \package \latex: à partir de la console de \miktex ou du \tlmgr. Si vous utilisez \miktex, n'oubliez pas d'installer aussi la documentation, car elle est installée séparément. Une fois la classe \laclasse installée, les mises à jour de \laclasse seront faites en même temps que les autres \packages à chaque fois que vous faites une mise à jour de votre distribution \latex.
+%
+% Notez que la documentation de \laclasse est disponible avec la commande |texdoc|, comme tous les autres \packages \latex. Sur la ligne de commande, il suffit d'utiliser la commande suivante:
+%
+% |texdoc udes-genie-these|
+%
+% L'exemple d'utilisation qui est distribué avec \laclasse est situé dans le même répertoire que la documentation, donc dans un sous-répertoire de votre distribution \latex.
+%
+% \textbf{Court terme:}\\ Si vous pensez utiliser \laclasse à court terme, alors procédez comme avec \overleaf, comme ce qui suit.
+%
+% \subsection*{\overleaf}
+% Pour utiliser \laclasse, vous pouvez récupérer une archive sur l'intranet de la Faculté de génie qui contient tout ce qu'il faut pour compiler un document. L'archive contient aussi la documentation et un exemple d'utilisation. Il suffit d'extraire les fichiers de l'archive dans un répertoire et de compiler avec votre variante favorite de \latex. Cette méthode fonctionne pour \overleaf et aussi toutes les autres distributions \latex.
+%
+% Cette manière de fonctionner fait en sorte que vous êtes responsables de faire les mises à jour, car elles ne se feront pas automatiquement. Cela veut aussi dire qu'au cours du temps, si vous n'êtes pas vigilants, vous pourriez avoir plusieurs projets qui utilisent \laclasse, mais qui utilisent des versions différentes.
+%
+% Dans \overleaf, la classe \laclasse ne fait pas partie des \packages préinstallés et il n'est pas possible non plus de l'installer de manière standard, comme avec les autres distributions \latex (\miktex et \texlive). Il reste deux options: avoir une copie de \laclasse présente dans chaque projet ou utiliser le mécanisme de partage de fichiers entre vos différents projets afin d'éviter d'en avoir plusieurs copies.
+%
+% \subsection*{Vérification}
+% Afin de vérifier que l'installation s'est bien passée, il vous est suggéré de compiler l'exemple distribué avec \laclasse. C'est le meilleur moyen de savoir si vous avez tout ce qu'il faut.
+%
+% L'exemple a été compilé avec succès avec \overleaf et les distributions \miktex et \texlive sous \windows, \macos et \linux. Si des erreurs surviennent avec l'exemple, typiquement, c'est que l'installation de \laclasse n'a pas été faite correctement ou que la distribution de \latex qui est utilisée est incomplète ou désuète.
%
%\section{Contact et support technique}\label{sec:support}
% Une personne est responsable du support de \laclasse. Vous pouvez contacter cette personne uniquement dans les situations suivantes:
@@ -346,35 +372,32 @@
%%-----------------------------------------------------------------------------
%%--- OPTIONS DE CLASSE ---------------------------------------------------
%%-----------------------------------------------------------------------------
-\DeclareKeys {
+\keys_define:nn { udes-genie-these }
+{
biblatex .code:n = {\tl_gset_eq:NN \g_@@_references_engin_tl \c_@@_references_biblatex_tl},
- biblatex .usage:n = load,
bibtex .code:n = {\tl_gset_eq:NN \g_@@_references_engin_tl \c_@@_references_bibtex_tl},
- bibtex .usage:n = load,
livre .code:n = {
\PassOptionsToClass{twoside,openright}{book}
\PassOptionsToPackage{twoside=true}{geometry}
\tl_gset_eq:NN \g_@@_format_tl \c_@@_format_livre_tl
},
- livre .usage:n = load,
simple .code:n = {
\PassOptionsToClass{oneside,openany}{book}
\PassOptionsToPackage{twoside=false}{geometry}
\tl_gset_eq:NN \g_@@_format_tl \c_@@_format_simple_tl
},
- simple .usage:n = load,
unknown .code:n = {\PassOptionsToClass{\CurrentOption}{book}},
}
-\SetKeys{livre}
+\keys_set:nn { udes-genie-these } {livre}
\IfFormatAtLeastTF {2022-06-01}
{
- \ProcessKeyOptions
+ \ProcessKeyOptions[udes-genie-these]
}
{
\RequirePackage {l3keys2e}
- \ProcessKeysOptions
+ \ProcessKeysOptions{udes-genie-these}
}
%%-----------------------------------------------------------------------------
@@ -411,6 +434,7 @@
% fichier-symboles = {symboles},
% fichier-acronymes = {acronymes},
% fichiers-references = {journaux,conferences},
+% style-references = plain,
% }
%\end{verbatim}
%\end{syntax}