diff options
author | Karl Berry <karl@freefriends.org> | 2022-04-25 20:21:48 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2022-04-25 20:21:48 +0000 |
commit | 88fc53eabd5b56b8c174319e39e3a07d5330cb92 (patch) | |
tree | 1f59372d15ed9d1f0b87f8d0c193b11f0850b873 /Master/texmf-dist | |
parent | 04e21d4c493c6d9206e1b034aed8c1fea432cc56 (diff) |
geradwp (25apr22)
git-svn-id: svn://tug.org/texlive/trunk@63134 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist')
-rw-r--r-- | Master/texmf-dist/doc/latex/geradwp/LICENSE.txt | 416 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/geradwp/README.md | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/geradwp/geradwp-fr.pdf | bin | 503393 -> 552691 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/geradwp/geradwp.pdf | bin | 460925 -> 520868 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/geradwp/geradwp.tex | 48 | ||||
-rw-r--r-- | Master/texmf-dist/source/latex/geradwp/geradwp.dtx | 550 | ||||
-rw-r--r-- | Master/texmf-dist/source/latex/geradwp/geradwp.ins | 19 | ||||
-rw-r--r-- | Master/texmf-dist/tex/latex/geradwp/geradwp.cls | 240 |
8 files changed, 1001 insertions, 274 deletions
diff --git a/Master/texmf-dist/doc/latex/geradwp/LICENSE.txt b/Master/texmf-dist/doc/latex/geradwp/LICENSE.txt new file mode 100644 index 00000000000..22443139013 --- /dev/null +++ b/Master/texmf-dist/doc/latex/geradwp/LICENSE.txt @@ -0,0 +1,416 @@ +The LaTeX Project Public License +=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- + +LPPL Version 1.3c 2008-05-04 + +Copyright 1999 2002-2008 LaTeX3 Project + Everyone is allowed to distribute verbatim copies of this + license document, but modification of it is not allowed. + + +PREAMBLE +======== + +The LaTeX Project Public License (LPPL) is the primary license under +which the LaTeX kernel and the base LaTeX packages are distributed. + +You may use this license for any work of which you hold the copyright +and which you wish to distribute. This license may be particularly +suitable if your work is TeX-related (such as a LaTeX package), but +it is written in such a way that you can use it even if your work is +unrelated to TeX. + +The section `WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE', +below, gives instructions, examples, and recommendations for authors +who are considering distributing their works under this license. + +This license gives conditions under which a work may be distributed +and modified, as well as conditions under which modified versions of +that work may be distributed. + +We, the LaTeX3 Project, believe that the conditions below give you +the freedom to make and distribute modified versions of your work +that conform with whatever technical specifications you wish while +maintaining the availability, integrity, and reliability of +that work. If you do not see how to achieve your goal while +meeting these conditions, then read the document `cfgguide.tex' +and `modguide.tex' in the base LaTeX distribution for suggestions. + + +DEFINITIONS +=========== + +In this license document the following terms are used: + + `Work' + Any work being distributed under this License. + + `Derived Work' + Any work that under any applicable law is derived from the Work. + + `Modification' + Any procedure that produces a Derived Work under any applicable + law -- for example, the production of a file containing an + original file associated with the Work or a significant portion of + such a file, either verbatim or with modifications and/or + translated into another language. + + `Modify' + To apply any procedure that produces a Derived Work under any + applicable law. + + `Distribution' + Making copies of the Work available from one person to another, in + whole or in part. Distribution includes (but is not limited to) + making any electronic components of the Work accessible by + file transfer protocols such as FTP or HTTP or by shared file + systems such as Sun's Network File System (NFS). + + `Compiled Work' + A version of the Work that has been processed into a form where it + is directly usable on a computer system. This processing may + include using installation facilities provided by the Work, + transformations of the Work, copying of components of the Work, or + other activities. Note that modification of any installation + facilities provided by the Work constitutes modification of the Work. + + `Current Maintainer' + A person or persons nominated as such within the Work. If there is + no such explicit nomination then it is the `Copyright Holder' under + any applicable law. + + `Base Interpreter' + A program or process that is normally needed for running or + interpreting a part or the whole of the Work. + + A Base Interpreter may depend on external components but these + are not considered part of the Base Interpreter provided that each + external component clearly identifies itself whenever it is used + interactively. Unless explicitly specified when applying the + license to the Work, the only applicable Base Interpreter is a + `LaTeX-Format' or in the case of files belonging to the + `LaTeX-format' a program implementing the `TeX language'. + + + +CONDITIONS ON DISTRIBUTION AND MODIFICATION +=========================================== + +1. Activities other than distribution and/or modification of the Work +are not covered by this license; they are outside its scope. In +particular, the act of running the Work is not restricted and no +requirements are made concerning any offers of support for the Work. + +2. You may distribute a complete, unmodified copy of the Work as you +received it. Distribution of only part of the Work is considered +modification of the Work, and no right to distribute such a Derived +Work may be assumed under the terms of this clause. + +3. You may distribute a Compiled Work that has been generated from a +complete, unmodified copy of the Work as distributed under Clause 2 +above, as long as that Compiled Work is distributed in such a way that +the recipients may install the Compiled Work on their system exactly +as it would have been installed if they generated a Compiled Work +directly from the Work. + +4. If you are the Current Maintainer of the Work, you may, without +restriction, modify the Work, thus creating a Derived Work. You may +also distribute the Derived Work without restriction, including +Compiled Works generated from the Derived Work. Derived Works +distributed in this manner by the Current Maintainer are considered to +be updated versions of the Work. + +5. If you are not the Current Maintainer of the Work, you may modify +your copy of the Work, thus creating a Derived Work based on the Work, +and compile this Derived Work, thus creating a Compiled Work based on +the Derived Work. + +6. If you are not the Current Maintainer of the Work, you may +distribute a Derived Work provided the following conditions are met +for every component of the Work unless that component clearly states +in the copyright notice that it is exempt from that condition. Only +the Current Maintainer is allowed to add such statements of exemption +to a component of the Work. + + a. If a component of this Derived Work can be a direct replacement + for a component of the Work when that component is used with the + Base Interpreter, then, wherever this component of the Work + identifies itself to the user when used interactively with that + Base Interpreter, the replacement component of this Derived Work + clearly and unambiguously identifies itself as a modified version + of this component to the user when used interactively with that + Base Interpreter. + + b. Every component of the Derived Work contains prominent notices + detailing the nature of the changes to that component, or a + prominent reference to another file that is distributed as part + of the Derived Work and that contains a complete and accurate log + of the changes. + + c. No information in the Derived Work implies that any persons, + including (but not limited to) the authors of the original version + of the Work, provide any support, including (but not limited to) + the reporting and handling of errors, to recipients of the + Derived Work unless those persons have stated explicitly that + they do provide such support for the Derived Work. + + d. You distribute at least one of the following with the Derived Work: + + 1. A complete, unmodified copy of the Work; + if your distribution of a modified component is made by + offering access to copy the modified component from a + designated place, then offering equivalent access to copy + the Work from the same or some similar place meets this + condition, even though third parties are not compelled to + copy the Work along with the modified component; + + 2. Information that is sufficient to obtain a complete, + unmodified copy of the Work. + +7. If you are not the Current Maintainer of the Work, you may +distribute a Compiled Work generated from a Derived Work, as long as +the Derived Work is distributed to all recipients of the Compiled +Work, and as long as the conditions of Clause 6, above, are met with +regard to the Derived Work. + +8. The conditions above are not intended to prohibit, and hence do not +apply to, the modification, by any method, of any component so that it +becomes identical to an updated version of that component of the Work as +it is distributed by the Current Maintainer under Clause 4, above. + +9. Distribution of the Work or any Derived Work in an alternative +format, where the Work or that Derived Work (in whole or in part) is +then produced by applying some process to that format, does not relax or +nullify any sections of this license as they pertain to the results of +applying that process. + +10. a. A Derived Work may be distributed under a different license + provided that license itself honors the conditions listed in + Clause 6 above, in regard to the Work, though it does not have + to honor the rest of the conditions in this license. + + b. If a Derived Work is distributed under a different license, that + Derived Work must provide sufficient documentation as part of + itself to allow each recipient of that Derived Work to honor the + restrictions in Clause 6 above, concerning changes from the Work. + +11. This license places no restrictions on works that are unrelated to +the Work, nor does this license place any restrictions on aggregating +such works with the Work by any means. + +12. Nothing in this license is intended to, or may be used to, prevent +complete compliance by all parties with all applicable laws. + + +NO WARRANTY +=========== + +There is no warranty for the Work. Except when otherwise stated in +writing, the Copyright Holder provides the Work `as is', without +warranty of any kind, either expressed or implied, including, but not +limited to, the implied warranties of merchantability and fitness for a +particular purpose. The entire risk as to the quality and performance +of the Work is with you. Should the Work prove defective, you assume +the cost of all necessary servicing, repair, or correction. + +In no event unless required by applicable law or agreed to in writing +will The Copyright Holder, or any author named in the components of the +Work, or any other party who may distribute and/or modify the Work as +permitted above, be liable to you for damages, including any general, +special, incidental or consequential damages arising out of any use of +the Work or out of inability to use the Work (including, but not limited +to, loss of data, data being rendered inaccurate, or losses sustained by +anyone as a result of any failure of the Work to operate with any other +programs), even if the Copyright Holder or said author or said other +party has been advised of the possibility of such damages. + + +MAINTENANCE OF THE WORK +======================= + +The Work has the status `author-maintained' if the Copyright Holder +explicitly and prominently states near the primary copyright notice in +the Work that the Work can only be maintained by the Copyright Holder +or simply that it is `author-maintained'. + +The Work has the status `maintained' if there is a Current Maintainer +who has indicated in the Work that they are willing to receive error +reports for the Work (for example, by supplying a valid e-mail +address). It is not required for the Current Maintainer to acknowledge +or act upon these error reports. + +The Work changes from status `maintained' to `unmaintained' if there +is no Current Maintainer, or the person stated to be Current +Maintainer of the work cannot be reached through the indicated means +of communication for a period of six months, and there are no other +significant signs of active maintenance. + +You can become the Current Maintainer of the Work by agreement with +any existing Current Maintainer to take over this role. + +If the Work is unmaintained, you can become the Current Maintainer of +the Work through the following steps: + + 1. Make a reasonable attempt to trace the Current Maintainer (and + the Copyright Holder, if the two differ) through the means of + an Internet or similar search. + + 2. If this search is successful, then enquire whether the Work + is still maintained. + + a. If it is being maintained, then ask the Current Maintainer + to update their communication data within one month. + + b. If the search is unsuccessful or no action to resume active + maintenance is taken by the Current Maintainer, then announce + within the pertinent community your intention to take over + maintenance. (If the Work is a LaTeX work, this could be + done, for example, by posting to comp.text.tex.) + + 3a. If the Current Maintainer is reachable and agrees to pass + maintenance of the Work to you, then this takes effect + immediately upon announcement. + + b. If the Current Maintainer is not reachable and the Copyright + Holder agrees that maintenance of the Work be passed to you, + then this takes effect immediately upon announcement. + + 4. If you make an `intention announcement' as described in 2b. above + and after three months your intention is challenged neither by + the Current Maintainer nor by the Copyright Holder nor by other + people, then you may arrange for the Work to be changed so as + to name you as the (new) Current Maintainer. + + 5. If the previously unreachable Current Maintainer becomes + reachable once more within three months of a change completed + under the terms of 3b) or 4), then that Current Maintainer must + become or remain the Current Maintainer upon request provided + they then update their communication data within one month. + +A change in the Current Maintainer does not, of itself, alter the fact +that the Work is distributed under the LPPL license. + +If you become the Current Maintainer of the Work, you should +immediately provide, within the Work, a prominent and unambiguous +statement of your status as Current Maintainer. You should also +announce your new status to the same pertinent community as +in 2b) above. + + +WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE +====================================================== + +This section contains important instructions, examples, and +recommendations for authors who are considering distributing their +works under this license. These authors are addressed as `you' in +this section. + +Choosing This License or Another License +---------------------------------------- + +If for any part of your work you want or need to use *distribution* +conditions that differ significantly from those in this license, then +do not refer to this license anywhere in your work but, instead, +distribute your work under a different license. You may use the text +of this license as a model for your own license, but your license +should not refer to the LPPL or otherwise give the impression that +your work is distributed under the LPPL. + +The document `modguide.tex' in the base LaTeX distribution explains +the motivation behind the conditions of this license. It explains, +for example, why distributing LaTeX under the GNU General Public +License (GPL) was considered inappropriate. Even if your work is +unrelated to LaTeX, the discussion in `modguide.tex' may still be +relevant, and authors intending to distribute their works under any +license are encouraged to read it. + +A Recommendation on Modification Without Distribution +----------------------------------------------------- + +It is wise never to modify a component of the Work, even for your own +personal use, without also meeting the above conditions for +distributing the modified component. While you might intend that such +modifications will never be distributed, often this will happen by +accident -- you may forget that you have modified that component; or +it may not occur to you when allowing others to access the modified +version that you are thus distributing it and violating the conditions +of this license in ways that could have legal implications and, worse, +cause problems for the community. It is therefore usually in your +best interest to keep your copy of the Work identical with the public +one. Many works provide ways to control the behavior of that work +without altering any of its licensed components. + +How to Use This License +----------------------- + +To use this license, place in each of the components of your work both +an explicit copyright notice including your name and the year the work +was authored and/or last substantially modified. Include also a +statement that the distribution and/or modification of that +component is constrained by the conditions in this license. + +Here is an example of such a notice and statement: + + %% pig.dtx + %% Copyright 2005 M. Y. Name + % + % This work may be distributed and/or modified under the + % conditions of the LaTeX Project Public License, either version 1.3 + % of this license or (at your option) any later version. + % The latest version of this license is in + % http://www.latex-project.org/lppl.txt + % and version 1.3 or later is part of all distributions of LaTeX + % version 2005/12/01 or later. + % + % This work has the LPPL maintenance status `maintained'. + % + % The Current Maintainer of this work is M. Y. Name. + % + % This work consists of the files pig.dtx and pig.ins + % and the derived file pig.sty. + +Given such a notice and statement in a file, the conditions +given in this license document would apply, with the `Work' referring +to the three files `pig.dtx', `pig.ins', and `pig.sty' (the last being +generated from `pig.dtx' using `pig.ins'), the `Base Interpreter' +referring to any `LaTeX-Format', and both `Copyright Holder' and +`Current Maintainer' referring to the person `M. Y. Name'. + +If you do not want the Maintenance section of LPPL to apply to your +Work, change `maintained' above into `author-maintained'. +However, we recommend that you use `maintained', as the Maintenance +section was added in order to ensure that your Work remains useful to +the community even when you can no longer maintain and support it +yourself. + +Derived Works That Are Not Replacements +--------------------------------------- + +Several clauses of the LPPL specify means to provide reliability and +stability for the user community. They therefore concern themselves +with the case that a Derived Work is intended to be used as a +(compatible or incompatible) replacement of the original Work. If +this is not the case (e.g., if a few lines of code are reused for a +completely different task), then clauses 6b and 6d shall not apply. + + +Important Recommendations +------------------------- + + Defining What Constitutes the Work + + The LPPL requires that distributions of the Work contain all the + files of the Work. It is therefore important that you provide a + way for the licensee to determine which files constitute the Work. + This could, for example, be achieved by explicitly listing all the + files of the Work near the copyright notice of each file or by + using a line such as: + + % This work consists of all files listed in manifest.txt. + + in that place. In the absence of an unequivocal list it might be + impossible for the licensee to determine what is considered by you + to comprise the Work and, in such a case, the licensee would be + entitled to make reasonable conjectures as to which files comprise + the Work. + diff --git a/Master/texmf-dist/doc/latex/geradwp/README.md b/Master/texmf-dist/doc/latex/geradwp/README.md index fa873fb414c..783aa789b79 100644 --- a/Master/texmf-dist/doc/latex/geradwp/README.md +++ b/Master/texmf-dist/doc/latex/geradwp/README.md @@ -11,7 +11,7 @@ later version. ## VERSION -1.0 +1.1 ****************************************************************** _La version française de cette description est à la suite de la diff --git a/Master/texmf-dist/doc/latex/geradwp/geradwp-fr.pdf b/Master/texmf-dist/doc/latex/geradwp/geradwp-fr.pdf Binary files differindex c64aee442cb..439eaadab07 100644 --- a/Master/texmf-dist/doc/latex/geradwp/geradwp-fr.pdf +++ b/Master/texmf-dist/doc/latex/geradwp/geradwp-fr.pdf diff --git a/Master/texmf-dist/doc/latex/geradwp/geradwp.pdf b/Master/texmf-dist/doc/latex/geradwp/geradwp.pdf Binary files differindex 3b22f85463f..d3dcd248f35 100644 --- a/Master/texmf-dist/doc/latex/geradwp/geradwp.pdf +++ b/Master/texmf-dist/doc/latex/geradwp/geradwp.pdf diff --git a/Master/texmf-dist/doc/latex/geradwp/geradwp.tex b/Master/texmf-dist/doc/latex/geradwp/geradwp.tex index 7f3db34a053..dbe20aa6fc9 100644 --- a/Master/texmf-dist/doc/latex/geradwp/geradwp.tex +++ b/Master/texmf-dist/doc/latex/geradwp/geradwp.tex @@ -8,7 +8,7 @@ %% %% This is a stripped version of the original file. %% -%% Copyright 2021 GERAD, HEC Montreal +%% Copyright 2022 GERAD, HEC Montreal %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3c @@ -27,6 +27,8 @@ %% This work consists of the files geradwp.dtx, geradwp.ins, %% geradwp.pdf and the derived files listed in the README file. %% +%% Template version 1.1 +%% %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% %%%%%%%%%% Notes pour les auteurs %%%%%%%%%%%%%%% %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -99,8 +101,10 @@ \PassOptionsToPackage{hyphens}{url} %% Choose one of the two following algorithm packages -%% \usepackage{algorithm} -\usepackage{algorithm2e} +%% \usepackage[ruled]{algorithm} +%% \usepackage{algorithmic} +\usepackage[ruled,linesnumbered]{algorithm2e} +\usepackage[french]{babel} \usepackage{hyperref} %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -110,6 +114,7 @@ %% %%% ----- DO NOT MODIFY! -------- %%%%%%%%%%%%%%% %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\GDcoverpagewhitespace{6.8cm} \graphicspath{{Figures/}} % graphicx pkg setup \hypersetup{colorlinks,% citecolor={blue}, % Change for "black" with natbib @@ -118,6 +123,20 @@ linkcolor={blue}, breaklinks={true} } +%% Algorithm caption customizations +\makeatletter +\ifthenelse{\isundefined{\ALG@name}}{}% +{% +\renewcommand{\ALG@name}{\sffamily\footnotesize Algorithm} +} +\makeatother +%% Algorithm2e caption customizations +\ifthenelse{\isundefined{\SetAlCapNameFnt}}{}% +{% +\SetAlCapNameFnt{\footnotesize} +\SetAlCapFnt{\sffamily\footnotesize} +} + %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% %%%%%% Début - commandes de l'auteur %%%%%%%%%%%% %% %%%%%%%% Start of author commands %%%%%%%%%%%%%%% @@ -132,20 +151,21 @@ breaklinks={true} %% %%%%%%%%%% Métadonnées du cahier %%%%%%%%%%%%%%% %% %%%%%%%%%% Working paper metadata %%%%%%%%%%%%%%% %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\GDtitre{This is a title} -\GDmois{Mai}{May} -\GDannee{2021} -\GDnumero{XX} -\GDauteursCourts{B. Hamel, K. H\'ebert} -\GDauteursCopyright{Hamel, H\'ebert} -\GDpostpubcitation{Hamel, Benoit, Karine H\'ebert (2021). \og Un exemple de citation \fg, \emph{Journal of Journals}, vol. X issue Y, p. n-m}{https://www.gerad.ca/fr} -\GDrevised{Mai 2021} +\GDtitle{This is a title} +\GDmonth{Mai}{May} +\GDyear{2021} +\GDnumber{XX} +\GDauthorsShort{B. Hamel, K. H\'ebert} +\GDauthorsCopyright{Hamel, H\'ebert} +\GDpostpubcitation{Hamel, Benoit, Karine H\'ebert (2021). ``Un exemple de citation'', \emph{Journal of Journals}, vol. X issue Y, p. n-m}{https://www.gerad.ca/fr} +\GDsupplementname{Internet Appendix} +\GDrevised{Mai}{May}{2021} \begin{document} -\GDpageCouverture +\GDcoverpage -\begin{GDpagetitre} +\begin{GDtitlepage} \begin{GDauthlist} \GDauthitem{Benoit Hamel \ref{affil:bib}} @@ -163,7 +183,7 @@ breaklinks={true} \GDemailitem{karine.hebert@gerad.ca} \end{GDemaillist} -\end{GDpagetitre} +\end{GDtitlepage} %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% %%%%%%%%% Résumés, mots-clés, remerciements %%%%%%%%%%% diff --git a/Master/texmf-dist/source/latex/geradwp/geradwp.dtx b/Master/texmf-dist/source/latex/geradwp/geradwp.dtx index 1f5de065b70..cde22df3870 100644 --- a/Master/texmf-dist/source/latex/geradwp/geradwp.dtx +++ b/Master/texmf-dist/source/latex/geradwp/geradwp.dtx @@ -1,6 +1,6 @@ % \iffalse % -% Copyright 2021 GERAD, HEC Montreal +% Copyright 2022 GERAD, HEC Montreal % % This work may be distributed and/or modified under the % conditions of the LaTeX Project Public License, either version 1.3c @@ -25,7 +25,7 @@ \ProvidesFile{geradwp.dtx} %</dtx> %<class>\NeedsTeXFormat{LaTeX2e} -%<class>\ProvidesClass{geradwp}[2021/08/11 v1.0 Class for the Cahiers du GERAD series] +%<class>\ProvidesClass{geradwp}[2022/04/25 v1.1 Class for the Cahiers du GERAD series] %<*driver> \documentclass[10pt,oneside,french,english]{ltxdoc} \usepackage[utf8]{inputenc} @@ -63,6 +63,7 @@ \definecolor{shadecolor}{rgb}{0.93,0.97,0.99} \definecolor{TFFrameColor}{rgb}{0,0.235,0.443} \definecolor{TFTitleColor}{rgb}{1,1,1} +\definecolor{rouge}{RGB}{234,0,42} \hypersetup{ colorlinks=true, allcolors=liens, @@ -105,6 +106,12 @@ \href{#1}{\bfseries #2~\faExternalLink} } \newcommand{\oui}{\color{green}\faCheck} +\newenvironment{GDwarning}[1]{% + \begin{leftbar} + \noindent{\Large {\color{rouge}\faExclamationCircle} \textbf{#1}} \\ + }{% + \end{leftbar} +} \makeglossary @@ -113,7 +120,7 @@ \end{document} %</driver> % \fi -% \CheckSum{922} +% \CheckSum{1052} % \changes{1.0}{2021-08-11}{Initial release} % \ifnum\frenchdoc=1 % \title{Classe de documents \LaTeX\ pour la collection \cahiers} @@ -140,11 +147,12 @@ % le gabarit initialement distribu\'e par le GERAD. % \else % The \gdwp\ document class was designed to allow researchers who are -% \lien{https://www.gerad.ca/fr}{GERAD} members to write +% \lien{https://www.gerad.ca/en}{GERAD} members to write % their working papers, preprints and technical reports in line with the presentation % standards of \cahiers\ working paper series. This class and the % associated files replace the template that GERAD initially distributed. % \fi +% \changes{1.1}{2021-11-25}{Updated GERAD URLs in abstract.} % \end{abstract} % % \ifnum\frenchdoc=1 @@ -156,11 +164,12 @@ % % \subsection{Prerequisites} % \fi +% \label{subsec:prereq} % % \ifnum\frenchdoc=1 % L'utilisation de cette classe suppose que vous avez d\'ej\`a install\'e une distribution \TeX\ et -% un \'editeur de code int\'egr\'e. Pour la conception de \gdwp, la distribution -% \lien{https://www.tug.org/texlive/}{TeX Live 2020} et l'\'editeur de code +% un \'editeur de code int\'egr\'e. Pour la conception de \gdwp, les distributions +% \lien{https://www.tug.org/texlive/}{TeX Live 2020 et 2021} et l'\'editeur de code % \lien{https://www.texstudio.org/}{TeXstudio} ont \'et\'e utilis\'es. % % Si vous utilisez la distribution TeXLive ou \lien{http://www.tug.org/mactex/}{MacTeX} et que la compilation @@ -170,10 +179,18 @@ % \emph{packages} indiqu\'es dans le \autoref{tab:pre-loaded-pkgs} avant d'utiliser la classe \gdwp. % % Les utilisateurs d'\lien{https://www.overleaf.com/}{Overleaf} peuvent \'egalement utiliser cette classe -% en r\'ecup\'erant les fichiers sur le \lien{https://www.gerad.ca/fr/cahiers-procedure}{site du GERAD}. +% en r\'ecup\'erant les fichiers sur le \lien{https://www.gerad.ca/fr/publications/papers/cahiers-procedure}{site du GERAD}. +% \begin{GDwarning}{\gdwp\ utilise la version 4 de +fancyhdr+} +% \`A partir de la version 1.1 de \gdwp, la version 4 du \emph{package} +% \lien{https://www.ctan.org/pkg/fancyhdr}{fancyhdr} est utilis\'ee. Cette version introduit de nouvelles commandes qui +% ne sont pas compatibles avec la version 3. Elle est disponible sur les \'editions 2021 +% de Tex Live et MacTeX, de m\^eme que sur Overleaf si vous utilisez la version 2021 de TeX Live. +% +% Si vous utilisez une autre distribution \TeX, assurez-vous que vous avez la bonne version de +fancyhdr+. +% \end{GDwarning} % \else % Using this class assumes you’ve already installed a \TeX\ distribution with an integrated code editor. -% In designing \gdwp, the \lien{https://www.tug.org/texlive/}{TeX Live 2020} distribution and the +% In designing \gdwp, the \lien{https://www.tug.org/texlive/}{TeX Live 2020 and 2021} distributions and the % \lien{https://www.texstudio.org/}{TeXstudio} editor were used. % % If you are using TeXLive or \lien{http://www.tug.org/mactex/}{MacTeX} and your document compilation @@ -184,8 +201,20 @@ % versions of the packages % indicated in \autoref{tab:pre-loaded-pkgs} before using the \gdwp\ class. % -% Users of \lien{https://www.overleaf.com/}{Overleaf} can also use this class by downloading the necessary files from % the \lien{https://www.gerad.ca/fr/cahiers-procedure}{GERAD website}. +% Users of \lien{https://www.overleaf.com/}{Overleaf} can also use this class by downloading the necessary files from +% the \lien{https://www.gerad.ca/en/publications/papers/cahiers-procedure}{GERAD website}. +% \begin{GDwarning}{\gdwp\ makes use of +fancyhdr+ version 4} +% Starting at \gdwp\ version 1.1, version 4 of the \lien{https://www.ctan.org/pkg/fancyhdr}{fancyhdr} is +% used. This version introduces new commands that are not backwards compatible +% with version 3. It is available with the 2021 editions of +% Tex Live and MacTeX, as well as on Overleaf if you use the 2021 version of TeX Live. +% +% If you are using another \TeX\ distribution, please make sure that you have the right version of +% +fancyhdr+. +% \end{GDwarning} % \fi +% \changes{1.1}{2021-11-25}{Updated GERAD URLs in Prerequisites subsection.} +% \changes{1.1}{2021-12-07}{Added a warning concerning fancyhdr 4} % % \subsection{Installation} % @@ -284,6 +313,7 @@ % \fi % % \subsection{Options} +% \label{subsec:options} % \ifnum\frenchdoc=1 % Outre les options disponibles via la classe +article+, quelques options sont disponibles pour \gdwp. % \else @@ -367,15 +397,31 @@ % \fi % \end{DescribeMacro} % +% \begin{DescribeMacro}{gdsupplement} +% \ifnum\frenchdoc=1 +% Lorsqu'un auteur souhaite ajouter un suppl\'ement de recherche ou une «annexe» tr\`es importante \`a +% son cahier de recherche sans l'inclure dans le document principal, il peut ajouter cette partie dans un autre +% gabarit \gdwp\ vierge et y inclure l'option +gdsupplement+. Jumel\'ee avec la commande +\GDsupplementname+ +% (voir la \autoref{sec:metadonnees}), l'option affichera clairement le nom du suppl\'ement dans les pages titre +% et les ent\^etes du document suppl\'ementaire. +% \else +% When authors want to add extra research data or an important ``appendix'' to their working paper without +% including it in the main document, they can write that extra material in a blank \gdwp\ template with the +% +gdsupplement+ option included. Combined with the +\GDsupplementname+ command (see \autoref{sec:metadonnees}), this +% option will clearly show the supplement name on the title pages and page headers. +% \fi +% \end{DescribeMacro} +% % \begin{DescribeMacro}{gdminitabs} % \ifnum\frenchdoc=1 % Il arrive parfois que des auteurs cr\'eent des tableaux si grands que ceux-ci d\'epassent d'une -% ou plusieurs marges. Dans de tels cas, l'option +gdneedsminitabs+ est utilis\'ee pour mettre les +% ou plusieurs marges. Dans de tels cas, l'option +gdminitabs+ est utilis\'ee pour mettre les % tableaux du document en +footnotesize+. % \else % Authors sometimes create tables so large that they extend beyond the margins. To solve this issue, -% the +gdneedsminitabs+ option can be used to set the tables in the document to +footnotesize+. +% the +gdminitabs+ option can be used to set the tables in the document to +footnotesize+. % \fi +% \changes{1.1}{2021-12-06}{Corrected the gdminitabs typo} % \end{DescribeMacro} % % \ifnum\frenchdoc=1 @@ -395,6 +441,7 @@ % can choose to use whichever packages they will need, taking into account their features (see below). Care should % be taken not to reload any of them or to change any of the default options. % \fi +% \changes{1.1}{2022-01-28}{Changed color package for xcolor} % % \begin{table}[tbh] % \begin{tabularx}{\textwidth}{Xccl} @@ -417,10 +464,11 @@ % multirow & \oui & & \\ % array & \oui & & \\ % caption & \oui & & font=\{footnotesize,bf,sf\} \\ -% color & \oui & & \\ +% xcolor & \oui & & \\ % enumitem & \oui & & \\ % float & \oui & & \\ % algorithm & & \oui & \\ +% algorithmic & & \oui & \\ % algorithm2e & & \oui & \\ % hyperref & & \oui & colorlinks \\ % & & & citecolor=\{blue\} \\ @@ -438,46 +486,68 @@ % % \subsubsection{babel} % \ifnum\frenchdoc=1 -% L'auteur de ces lignes ayant \'et\'e inform\'e par la maintenanci\`ere du gabarit originel que l'utilisation de babel +% L'auteur de ces lignes ayant \'et\'e inform\'e par la maintenanci\`ere du gabarit originel que l'utilisation de +% babel % avec ce dernier causait de nombreux probl\`emes, il vous serait gr\'e de \textbf{ne pas utiliser le -% \emph{package} babel avec ce nouveau gabarit}, et ce, jusqu'\`a ce que lesdits probl\`emes lui soient pr\'esent\'es +% \emph{package} babel avec ce nouveau gabarit}, et ce, jusqu'\`a ce que lesdits probl\`emes lui soient +% pr\'esent\'es % afin d'\^etre corrig\'es. Une version ult\'erieure de la classe vous permettra peut-\^etre de vous en servir. % \else -% The person maintaining the original template advised the author of this document class that using babel with the template -% causes a number of problems, +% The person maintaining the original template advised the author of this document class that using babel with the +% template causes a number of problems, % so \textbf{please do not use the babel package with this new template}, until these issues have been fixed. % A future release of the class may allow you to use it. % \fi % -% \subsubsection{algorithm, algorithm2e} +% \subsubsection{algorithm, algorithmic, algorithm2e} % % \ifnum\frenchdoc=1 -% \lien{https://www.ctan.org/pkg/algorithms}{algorithm} et \lien{https://www.ctan.org/pkg/algorithm2e}{algorithm2e} sont -% deux \emph{packages} ayant leurs aficionados respectifs parmi les auteurs de \emph{Cahiers du GERAD}. Tous deux sont -% accept\'es et charg\'es dans le pr\'eambule du gabarit. Il suffit de mettre en commentaire celui des deux qui ne -% sera pas utilis\'e. +% \lien{https://www.ctan.org/pkg/algorithms}{algorithm, algorithmic} et +% \lien{https://www.ctan.org/pkg/algorithm2e}{algorithm2e} sont +% trois \emph{packages} ayant leurs aficionados respectifs parmi les auteurs de \emph{Cahiers du GERAD}. Tous trois +% sont +% accept\'es et charg\'es dans le pr\'eambule du gabarit. Il suffit de mettre en commentaire ceux des trois qui ne +% seront pas utilis\'es. \textbf{Notez que +algorithm+ et +algorithmic+ doivent toujours \^etre charg\'es ensemble}, +% l'un ne fonctionnant pas sans l'autre. +algorithm2e+, quant \`a lui, est autosuffisant. % -% Les deux \emph{packages} ne peuvent cependant pas \^etre charg\'es ensemble puisqu'ils entrent en conflit et cr\'eent -% des bogues. +% +algorithm+ et +algorithm2e+ ne peuvent pas \^etre charg\'es ensemble puisqu'ils entrent en conflit et +% cr\'eent des bogues. +% +% Finalement, lorsque vous utilisez le couple +algorithm+ et +algorithmic+, veuillez s'il vous pla\^it mettre les +% +\caption+ de vos algorithmes en +\footnotesize+. % \else -% \lien{https://www.ctan.org/pkg/algorithms}{algorithm} and \lien{https://www.ctan.org/pkg/algorithm2e}{algorithm2e} are -% two different packages, each of which has its fans among the \emph{Cahiers du GERAD} authors. Both are accepted and -% loaded in the preamble of the template. Simply comment out the one that will not be used. +% \lien{https://www.ctan.org/pkg/algorithms}{algorithm, algorithmic} and \lien{https://www.ctan.org/pkg/algorithm2e}{algorithm2e} are +% three different packages, each of which has its fans among the \emph{Cahiers du GERAD} authors. All are accepted +% and loaded in the preamble of the template. Simply comment out those that will not be used. +% \textbf{Bear in mind that +algorithm+ and +algorithmic+ must be loaded together} as they don't work +% independently. +algorithm2e+, on the other hand, il self-sufficient. +% +% +algorithm+ and +algorithm2e+ are mutually exclusive and cannot be both loaded at once without causing bugs. % -% The two packages are mutually exclusive and cannot both be loaded at once without causing bugs. +% Finally, when using the +algorithm+ and +algorithmic+ duo, please put your algorithms' +\caption+ in +% +\footnotesize+. % \fi +% \changes{1.1}{2021-12-07}{Included algorithmic package in documentation} +% \changes{1.1}{2021-12-07}{Added the caption footnotesize note} % % \subsubsection{float} % % \ifnum\frenchdoc=1 % Le \emph{package} +float+ est charg\'e avec la classe \textbf{uniquement lorsque l'option +gdminitabs+ est utilis\'ee}, et ce, -% afin de transformer les tableaux en +footnotesize+. Si vous avez besoin de ce \emph{package} et que vos tableaux +% afin de transformer les tableaux en +footnotesize+. Si vous avez besoin de ce \emph{package} même si vos tableaux % sont raisonnablement petits, chargez-le dans le pr\'eambule de votre document. +% +% Si vous utilisez le \emph{package} +algorithm+, +float+ est charg\'e par ce dernier. Il est donc inutile de le +% charger dans le pr\'ambule. % \else % The +float+ package is loaded with the class \textbf{only when the +gdminitabs+ option is enabled}. When loaded, it resizes -% the tables in +footnotesize+. If you need this package and the tables are reasonably small, you can load it in the preamble +% the tables in +footnotesize+. If you need this package even if your tables are reasonably small, you can load it in the preamble % of the document. +% +% If you are using the +algorithm+ package, please note that it loads +float+, so there is no need to load it in +% the preamble. % \fi +% \changes{1.1}{2021-12-07}{Added the fact that algorithm loads float package} % % \subsubsection{cleveref} % @@ -502,9 +572,11 @@ % Les quelques commandes publiques qui ont \'et\'e cr\'e\'ees pour cette classe ont deux fonctions : renseigner les % m\'etadonn\'ees du cahier de recherche et faire de la mise en page. % \else -% The handful of public commands that were created for this class have two purposes: formatting and filling in metadata +% The handful of public commands that were created for this class have two purposes: document layout and filling in metadata % for the working paper. % \fi +% \changes{1.1}{2021-12-07}{All public commands have been translated in English} +% % % \ifnum\frenchdoc=1 % \subsubsection{M\'etadonn\'ees} @@ -522,7 +594,7 @@ % data that will be found on the cover and title pages of the paper. % \fi % -% \begin{DescribeMacro}{\GDtitre} +% \begin{DescribeMacro}{\GDtitle} % \ifnum\frenchdoc=1 % Le titre du cahier de recherche. Celui-ci se retrouve \`a la fois sur la page couverture et la page titre. % \else @@ -530,7 +602,7 @@ % \fi % \end{DescribeMacro} % -% \begin{DescribeMacro}{\GDauteursCourts} +% \begin{DescribeMacro}{\GDauthorsShort} % \ifnum\frenchdoc=1 % La liste des auteurs du cahier sous la forme \emph{[Initiale du pr\'enom]. [Nom de famille]} % (ex. : B. Hamel, K. H\'ebert). Le contenu de cette commande se retrouve sur la page couverture, sous le titre. @@ -540,7 +612,7 @@ % \fi % \end{DescribeMacro} % -% \begin{DescribeMacro}{\GDauteursCopyright} +% \begin{DescribeMacro}{\GDauthorsCopyright} % \ifnum\frenchdoc=1 % La liste des noms de famille des auteurs \`a la mention des droits d'auteurs au bas de la page titre. % \else @@ -548,7 +620,7 @@ % \fi % \end{DescribeMacro} % -% \begin{DescribeMacro}{\GDmois} +% \begin{DescribeMacro}{\GDmonth} % \ifnum\frenchdoc=1 % Le mois de publication du cahier de recherche dans ses formes fran\c{c}aise et anglaise. Le mois en fran\c{c}ais % est inscrit entre les premi\`eres accolades, celui en anglais, entre les deuxi\`emes. @@ -558,7 +630,7 @@ % \fi % \end{DescribeMacro} % -% \begin{DescribeMacro}{\GDannee} +% \begin{DescribeMacro}{\GDyear} % \ifnum\frenchdoc=1 % L'ann\'ee de publication du cahier sous la forme \emph{AAAA}. % \else @@ -566,7 +638,7 @@ % \fi % \end{DescribeMacro} % -% \begin{DescribeMacro}{\GDnumero} +% \begin{DescribeMacro}{\GDnumber} % \ifnum\frenchdoc=1 % Le num\'ero du cahier de recherche. Ce num\'ero est assign\'e par l'\'equipe du GERAD. % \else @@ -584,6 +656,19 @@ % \fi % \end{DescribeMacro} % +% \begin{DescribeMacro}{\GDsupplementname} +% \ifnum\frenchdoc=1 +% Si vous r\'edigez un suppl\'ement de recherche ou une annexe \`a l'aide du gabarit \gdwp\ et que vous +% l'indiquez avec l'option +gdsupplement+ (voir \autoref{subsec:options}), la commande +% +\GDsupplementname+ servira \`a nommer ledit suppl\'ement et la classe imprimera ce nom dans les pages +% titre et les ent\^etes du document. +% \else +% If you write extra research data or an appendix using the \gdwp\ template and the +gdsupplement+ option +% (see \autoref{subsec:options}), the +\GDsupplementname+ command will serve as place holder for the +% supplement's name and the class will output it on the title pages and on page headers. +% \fi +% \end{DescribeMacro} +% % \begin{DescribeMacro}{\GDpostpubcitation} % \ifnum\frenchdoc=1 % Lorsque le contenu du cahier de recherche est publi\'e chez un \'editeur, l'\'equipe du GERAD @@ -604,22 +689,22 @@ % supprim\'ees par des auteurs, des commandes ont \'et\'e cr\'e\'ees. Celles-ci marquent en m\^eme temps % les subdivisions du document. % \else -% \subsubsection{Formatting} +% \subsubsection{Document Layout} % % To keep the template from getting cluttered and to keep authors from deleting critical formatting commands, % commands were created to mark each subdivision of the document. % \fi % -% \begin{DescribeMacro}{\GDpageCouverture} +% \begin{DescribeMacro}{\GDcoverpage} % \ifnum\frenchdoc=1 % Toute la page couverture d'un cahier de recherche est g\'en\'er\'ee \`a partir de cette commande. % Elle est entre autres mise en forme avec les m\'etadonn\'ees des commandes cit\'ees \`a la % \autoref{sec:metadonnees}. La page titre qui suit la page couverture est quant \`a elle g\'en\'er\'ee -% par l'environnement +GDpagetitre+ d\'ecrit \`a la \autoref{sec:environnements}. +% par l'environnement +GDtitlepage+ d\'ecrit \`a la \autoref{sec:environnements}. % \else % The entire cover page is generated with this command. It is largely formatted with the formatting % commands listed in \autoref{sec:metadonnees}. The title page that follows the cover is generated -% by the +GDpagetitre+ environment described in \autoref{sec:environnements}. +% by the +GDtitlepage+ environment described in \autoref{sec:environnements}. % \fi % \end{DescribeMacro} % @@ -668,7 +753,7 @@ % \subsubsection{Title page} % \fi % -% \begin{DescribeEnv}{GDpagetitre} +% \begin{DescribeEnv}{GDtitlepage} % \ifnum\frenchdoc=1 % Toute la page titre est g\'en\'er\'ee par le biais de cet environnement. Les auteurs n'ont qu'\`a inscrire % leurs informations personnelles dans les environnements +GDauthlist+, +GDaffillist+ et +GDemaillist+ d\'ecrits @@ -814,7 +899,7 @@ % \fi % % \ifnum\frenchdoc=1 -% \subsection{\emph{Packages} par d\'efaut du cahier (lignes 104-117)} +% \subsection{\emph{Packages} par d\'efaut du cahier (lignes 92-106)} % % Tous les \emph{packages} qui ne sont pas charg\'es par d\'efaut dans le fichier de classe (voir le % \autoref{tab:pre-loaded-pkgs}) sont charg\'es dans cette section. C'est dans cette section que vous pourrez @@ -822,7 +907,7 @@ % vous devrez charger les \emph{packages} qui ont tendance \`a ne pas fonctionner ad\'equatement s'ils sont % charg\'es apr\`es le \emph{package} +hyperref+. % \else -% \subsection{Default packages (lines 104-117)} +% \subsection{Default packages (lines 92-106)} % % All the packages that are not loaded by default in the class (see \autoref{tab:pre-loaded-pkgs}) % are loaded in this section. It’s in this section that the choice between the +algorithm+ and +algorithm2e+ @@ -831,7 +916,7 @@ % \fi % % \ifnum\frenchdoc=1 -% \subsection{Options par d\'efaut du cahier (lignes 118-132)} +% \subsection{Options par d\'efaut du cahier (lignes 107-136)} % % Si vous nommez le r\'epertoire dans lequel vous compilerez vos figures diff\'eremment que le nom que nous % lui avons donn\'e par d\'efaut ou si vous avez plus d'un r\'epertoire de figures, vous pourrez inscrire @@ -842,7 +927,7 @@ % % Dans tous les autres cas, veuillez ne pas modifier cette section. % \else -% \subsection{Default options (lines 118-132)} +% \subsection{Default options (lines 107-136)} % % If the name of your folder containing your paper’s figures is named differently than the default name, % or if there are multiple folders with figures in them, this is where you can enter that information. @@ -853,7 +938,7 @@ % \fi % % \ifnum\frenchdoc=1 -% \subsection{Commandes de l'auteur (lignes 133-141)} +% \subsection{Commandes de l'auteur (lignes 137-145)} % % Cette section vous appartient enti\`erement. Vous pouvez y charger les \emph{packages} n\'ecessaires \`a % votre r\'edaction de m\^eme que leurs options. @@ -861,7 +946,7 @@ % C'est \'egalement dans cette section que vous pouvez inscrire vos commandes, environnements et % th\'eor\`emes personnalis\'es. % \else -% \subsection{Author commands (lines 133-141)} +% \subsection{Author commands (lines 137-145)} % % This section belongs entirely to the author. This is where all the packages needed for the paper can be loaded, % as well as their options. @@ -870,26 +955,26 @@ % \fi % % \ifnum\frenchdoc=1 -% \subsection{Métadonn\'ees du cahier (lignes 143-155)} +% \subsection{Métadonn\'ees du cahier (lignes 147-183)} % -% Cette section, dont une partie est à la fin du pr\'eambule et l'autre dans l'environnement +GDpagetitre+, au +% Cette section, dont une partie est à la fin du pr\'eambule et l'autre dans l'environnement +GDtitlepage+, au % d\'ebut du document, est l'endroit o\`u vous devrez inscrire toutes les m\'etadonn\'ees bibliographiques % de votre cahier. % \else -% \subsection{Metadata (lines 143-155)} +% \subsection{Metadata (lines 147-183)} % -% This section is divided in two: the first is at the end of the preamble, and the second in the +GDpagetitre+ +% This section is divided in two: the first is at the end of the preamble, and the second in the +GDtitlepage+ % environment located at the beginning of the document. This is where all the bibliographical metadata for the % paper should be. % \fi % % \ifnum\frenchdoc=1 -% \subsection{R\'esum\'es, mots-cl\'es, remerciements, article (lignes 156 et suivantes)} +% \subsection{R\'esum\'es, mots-cl\'es, remerciements, article (lignes 185 et suivantes)} % % Ces deux derni\`eres sections sont, bien entendu, les endroits o\`u vous r\'edigerez votre cahier de % recherche... % \else -% \subsection{Abstracts, keywords, acknowledgements, article (starting at line 156)} +% \subsection{Abstracts, keywords, acknowledgements, article (starting at line 185)} % % These last two sections are, of course, where the body of the article will be. % \fi @@ -931,6 +1016,7 @@ % it configures some parts of the formatting. Once the variables have been created, default values % are set. % \fi +% \changes{1.1}{2021-12-03}{Added isSupplement boolean and default value} % % \begin{macrocode} %<*class> @@ -943,6 +1029,7 @@ \newboolean{GD@needsSmallHeadSep} \newboolean{GD@isFinalImpression} \newboolean{GD@isPostPublication} +\newboolean{GD@isSupplement} \newboolean{GD@isRevised} \newboolean{GD@needsminitabs} @@ -952,6 +1039,7 @@ \setboolean{GD@needsSmallHeadSep}{false} \setboolean{GD@isFinalImpression}{false} \setboolean{GD@isPostPublication}{false} +\setboolean{GD@isSupplement}{false} \setboolean{GD@isRevised}{false} \setboolean{GD@needsminitabs}{false} % \end{macrocode} @@ -967,6 +1055,7 @@ % The few class options are declared here. They essentially change some boolean values % and pass some options to the +article+ class. % \fi +% \changes{1.1}{2021-12-03}{Added new gdsupplement option} % % \begin{macrocode} @@ -998,6 +1087,9 @@ \DeclareOption{gdpostpub}{% \setboolean{GD@isPostPublication}{true} } +\DeclareOption{gdsupplement}{% + \setboolean{GD@isSupplement}{true} +} \DeclareOption{gdrevised}{% \setboolean{GD@isRevised}{true} } @@ -1055,14 +1147,13 @@ \RequirePackage{multirow} \RequirePackage{array} \RequirePackage[font={footnotesize,bf,sf}]{caption} -\RequirePackage{color} +\RequirePackage{xcolor} \RequirePackage{enumitem} \ifthenelse{\boolean{GD@needsminitabs}}{% \RequirePackage{float} }{} % Required Packages Setup % -\definecolor{gris}{rgb}{0.44,0.44,0.44} % color pkg setup \captionsetup[table]{skip=5pt} % caption pkg setup % \end{macrocode} % @@ -1077,6 +1168,7 @@ % We begin by defining the lengths of the document. These can change from % one version of the paper to another. % \fi +% \changes{1.1}{2021-12-02}{Added new cover page vspace length} % % \begin{macrocode} @@ -1086,6 +1178,7 @@ \newlength{\GD@affilitemsep} \newlength{\GD@affiltopsep} \newlength{\GD@titleminipage@hspace} +\newlength{\GD@coverpage@vspace} \ifthenelse{\boolean{GD@isPlainVersion}}{% \setlength{\GD@authitemsep}{0pt} \setlength{\GD@authtopsep}{12pt} @@ -1111,7 +1204,7 @@ % \else % We then set up the geometry of the document, which varies from one version to another. % \fi -% +% \changes{1.1}{2022-01-18}{Removed nofoot option from plain geometry}% % \begin{macrocode} % Geometry % @@ -1129,7 +1222,6 @@ bmargin=2cm,% lmargin=3cm,% rmargin=3cm,% - nofoot,% headsep=30pt,% includehead} }{} @@ -1274,21 +1366,26 @@ % commands and populate different parts of the paper such as the headers, % cover page and title page. % \fi +% \changes{1.1}{2021-12-03}{Added internal supplement name command} +% \changes{1.1}{2021-12-07}{Translated all commands to english} % % \begin{macrocode} % Class Private Commands % % Metadata % -\newcommand{\gd@annee}{} -\newcommand{\gd@mois}{} -\newcommand{\gd@month}{} -\newcommand{\gd@numero}{} -\newcommand{\gd@titre}{} -\newcommand{\gd@auteurs@short}{} -\newcommand{\gd@auteurs@copyright}{} +\newcommand{\gd@year}{} +\newcommand{\gd@month@fr}{} +\newcommand{\gd@month@en}{} +\newcommand{\gd@number}{} +\newcommand{\gd@title}{} +\newcommand{\gd@authors@short}{} +\newcommand{\gd@authors@copyright}{} \newcommand{\gd@postpubcitation}{} \newcommand{\gd@postpubcitation@url}{} -\newcommand{\gd@revised}{} +\newcommand{\gd@supplementname}{} +\newcommand{\gd@revised@year}{} +\newcommand{\gd@revised@month@fr}{} +\newcommand{\gd@revised@month@en}{} % \end{macrocode} % % \ifnum\frenchdoc=1 @@ -1317,6 +1414,11 @@ % The following commands define its appearance. The bottom part of the page % is different if the +gdpostpub+ option is used. % \fi +% \changes{1.1}{2021-12-02}{Added new vspace length for paper version only} +% \changes{1.1}{2021-12-02}{Added vfill for web version only} +% \changes{1.1}{2012-12-03}{Added supplement name to web version cover page} +% \changes{1.1}{2021-12-03}{Added supplement name in paper cover page minipage} +% \changes{1.1}{2021-12-13}{Fixed GDcover@bottom@postpub} % % \begin{macrocode} @@ -1338,13 +1440,18 @@ \ifthenelse{\boolean{GD@isWebVersion}}{% \vspace*{54pt} - {\noindent\LARGE\bfseries \gd@titre\par} %Title - + {\noindent\LARGE\bfseries \gd@title\par} %Title + \ifthenelse{\boolean{GD@isSupplement}}% + {{\noindent\LARGE\gd@supplementname\par}}{} \vspace*{18pt} - {\noindent\Large\gd@auteurs@short\par} + {\noindent\Large\gd@authors@short\par} + + \vfill }{} - \vfill + \ifthenelse{\boolean{GD@isPaperVersion}}{% + \vspace*{\GD@coverpage@vspace} + }{} \hspace*{\GD@titleminipage@hspace} \begin{minipage}[c][5.4cm][c]{7cm} {\ifthenelse{\boolean{GD@isWebVersion}}% @@ -1366,14 +1473,14 @@ % Cover page minipage table (web version) \newcommand{\GDcover@minipagetable@web}{% \begin{tabular}{p{.5cm}|p{5.5cm}} - & \normalsize G--\gd@annee--\gd@numero + & \normalsize G--\gd@year--\gd@number \ifthenelse{\boolean{GD@needsminitabs}}% {\\*[10pt]}% {\\*[8pt]} - & \normalsize\gd@month\ \gd@annee + & \normalsize\gd@month@en\ \gd@year \ifthenelse{\boolean{GD@isRevised}}{% \\ - &\normalsize Revised: \gd@revised + &\normalsize Revised: \gd@revised@month@en\ \gd@revised@year }{} \end{tabular} } @@ -1381,22 +1488,24 @@ % Cover page minipage table (paper version) \newcommand{\GDcover@minipagetable@paper}{% \begin{tabular}{p{.5cm}|p{5.5cm}} - \multicolumn{2}{p{6.5cm}}{\normalsize\bfseries \gd@titre + \multicolumn{2}{p{6.5cm}}{\normalsize\bfseries \gd@title \ifthenelse{\boolean{GD@needsminitabs}}% {\vspace*{12.5pt}}% {\vspace*{10pt}}}\\ - & \normalsize\gd@auteurs@short \\ %Initials. Name + \ifthenelse{\boolean{GD@isSupplement}}% + {& \gd@supplementname\\*[10pt]}{} + & \normalsize\gd@authors@short \\ %Initials. Name & \ifthenelse{\boolean{GD@needsminitabs}}% {\\*[15pt]}% {\\*[12pt]} - & \normalsize G--\gd@annee--\gd@numero + & \normalsize G--\gd@year--\gd@number \ifthenelse{\boolean{GD@needsminitabs}}% {\\*[10pt]}% {\\*[8pt]} - & \normalsize\gd@month\ \gd@annee + & \normalsize\gd@month@en\ \gd@year \ifthenelse{\boolean{GD@isRevised}}{% \\ - &\normalsize Revised: \gd@revised + &\normalsize Revised: \gd@revised@month@en\ \gd@revised@year }{} \end{tabular} } @@ -1417,12 +1526,16 @@ \medskip \scriptsize - \textbf{Citation sugg\'{e}r\'{e}e :} \gd@auteurs@short~(\gd@mois\ - \gd@annee). \gd@titre, Rapport technique, Les Cahiers du GERAD G-- - \gd@annee--\gd@numero, GERAD, HEC Montr\'{e}al, Canada.\\ + \textbf{Citation sugg\'{e}r\'{e}e :} \gd@authors@short~(\gd@month@fr\ + \gd@year). \gd@title, + \ifthenelse{\boolean{GD@isSupplement}}{\gd@supplementname .}{} + Rapport technique, Les Cahiers du GERAD G-- + \gd@year--\gd@number, GERAD, HEC Montr\'{e}al, Canada. + \ifthenelse{\boolean{GD@isRevised}}% + { Version r\'evis\'ee: \gd@revised@month@fr\ \gd@revised@year}{}\\ \textbf{Avant de citer ce rapport technique,} veuillez visiter notre - site Web (\url{https://www.gerad.ca/fr/papers/G-\gd@annee-\gd@numero}) + site Web (\url{https://www.gerad.ca/fr/papers/G-\gd@year-\gd@number}) afin de mettre \`a jour vos donn\'ees de r\'ef\'erence, s'il a \'et\'e publi\'e dans une revue scientifique.\par \end{minipage} @@ -1436,12 +1549,16 @@ added.\\ \\ \scriptsize - \textbf{Suggested citation:} \gd@auteurs@short~(\gd@month\ \gd@annee). - \gd@titre, Technical report, Les Cahiers du GERAD G--\gd@annee--\gd@numero, - GERAD, HEC Montr\'{e}al, Canada.\\ + \textbf{Suggested citation:} \gd@authors@short~(\gd@month@en\ \gd@year). + \gd@title, + \ifthenelse{\boolean{GD@isSupplement}}{\gd@supplementname .}{} + Technical report, Les Cahiers du GERAD G--\gd@year--\gd@number, + GERAD, HEC Montr\'{e}al, Canada. + \ifthenelse{\boolean{GD@isRevised}}% + { Revised version: \gd@revised@month@en\ \gd@revised@year}{}\\ \textbf{Before citing this technical report,} please visit our website - (\url{https://www.gerad.ca/en/papers/G-\gd@annee-\gd@numero}) to update + (\url{https://www.gerad.ca/en/papers/G-\gd@year-\gd@number}) to update your reference data, if it has been published in a scientific journal. \par \end{minipage} @@ -1459,8 +1576,8 @@ \medskip D\'ep\^ot l\'egal -- Biblioth\`eque et Archives nationales du Qu\'ebec, - \gd@annee\\ - \phantom{Depot legal} -- Biblioth\`eque et Archives Canada, \gd@annee + \gd@year\\ + \phantom{Depot legal} -- Biblioth\`eque et Archives Canada, \gd@year \par \end{minipage} \hfill @@ -1473,8 +1590,8 @@ \medskip Legal deposit -- Biblioth\`eque et Archives nationales du Qu\'ebec, - \gd@annee\\ - \phantom{Legal deposit} -- Library and Archives Canada, \gd@annee\par + \gd@year\\ + \phantom{Legal deposit} -- Library and Archives Canada, \gd@year\par \end{minipage} \hrule @@ -1546,10 +1663,8 @@ \hrule \smallskip - \noindent - \begin{minipage}[t][2.1cm][l]{7.5cm} + \noindent\begin{minipage}[t][2.1cm][l]{7.5cm} \scriptsize - \medskip La publication de ces rapports de recherche est rendue possible gr\^ace au soutien de HEC Montr\'eal, Polytechnique Montr\'eal, Universit\'e McGill, Universit\'e du Qu\'ebec \`a Montr\'eal, ainsi que du Fonds de @@ -1557,13 +1672,13 @@ \medskip D\'ep\^ot l\'egal -- Biblioth\`eque et Archives nationales du Qu\'ebec, - 2020\\ - \phantom{Depot legal} -- Biblioth\`eque et Archives Canada, 2020\par + \gd@year\\ + \phantom{Depot legal} -- Biblioth\`eque et Archives Canada, \gd@year + \par \end{minipage} \hfill \begin{minipage}[t][2.1cm][l]{7.5cm} \scriptsize - \medskip The publication of these research reports is made possible thanks to the support of HEC Montr\'eal, Polytechnique Montr\'eal, McGill University, Universit\'e du Qu\'ebec \`a Montr\'eal, as well as @@ -1571,8 +1686,8 @@ \medskip Legal deposit -- Biblioth\`eque et Archives nationales du Qu\'ebec, - 2020\\ - \phantom{Legal deposit} -- Library and Archives Canada, 2020\par + \gd@year\\ + \phantom{Legal deposit} -- Library and Archives Canada, \gd@year\par \end{minipage} \hrule @@ -1609,14 +1724,17 @@ % \ifnum\frenchdoc=1 % La page titre s'affiche dans toutes les versions du cahier, mais % diffère en fonction des versions. Étant donné qu'elle est contenue -% dans l'environnement +GDpagetitre+, les commandes internes pour son +% dans l'environnement +GDtitlepage+, les commandes internes pour son % affichage sont divisées en deux parties +@begin+ et +@end+. % \else % The title page appears in all versions of the paper, but it varies -% according to the version. Given that it is contained in the +GDpagetitre+ +% according to the version. Given that it is contained in the +GDtitlepage+ % environment, the internal commands for the title page’s display are % divided into two parts: +@begin+ and +@end+. % \fi +% \changes{1.1}{2021-12-03}{Added supplement name to title page} +% \changes{1.1}{2021-12-06}{Added the Revised prefix} +% \changes{1.1}{2021-12-06}{Changed plain title page's month for english} % % \begin{macrocode} @@ -1631,7 +1749,10 @@ } \parindent=0pt \sffamily - {\LARGE\bfseries \gd@titre\par} %Title + {\LARGE\bfseries \gd@title\par} %Title + \ifthenelse{\boolean{GD@isSupplement}}% + {{\LARGE\gd@supplementname\par} + }{} \begin{minipage}[t][10cm][l]{7.5cm} \vspace*{55pt} } @@ -1640,14 +1761,14 @@ \vfill \end{minipage} \vfill -{\bfseries \gd@month\ \gd@annee}\\* +{\bfseries \gd@month@en\ \gd@year}\\* \ifthenelse{\boolean{GD@isRevised}}% - {\\ \gd@revised \\}% + {Revised: \gd@revised@month@en\ \gd@revised@year \\}% {} {\bfseries Les Cahiers du GERAD}\\ -{\bfseries G--\gd@annee--\gd@numero}\\ -{\footnotesize Copyright \copyright\ \gd@annee\ GERAD, - \gd@auteurs@copyright} +{\bfseries G--\gd@year--\gd@number}\\ +{\footnotesize Copyright \copyright\ \gd@year\ GERAD, + \gd@authors@copyright} \vspace*{0.05cm} \hrule @@ -1705,12 +1826,16 @@ \newcommand{\GD@plain@titlepage@begin}{% \thispagestyle{empty} \sffamily - {\sffamily\LARGE\bfseries\noindent\gd@titre\par} + {\sffamily\LARGE\bfseries\noindent\gd@title\par} + \ifthenelse{\boolean{GD@isSupplement}}% + {{\noindent\LARGE\gd@supplementname\par}}{} } \newcommand{\GD@plain@pagetitle@end}{% \vspace*{12pt} - {\noindent\gd@mois\ \gd@annee} + {\noindent\gd@month@en\ \gd@year} + \ifthenelse{\boolean{GD@isRevised}}% + {\\ {\noindent Revised: \gd@revised@month@en\ \gd@revised@year}}{} \vspace*{30pt} } % \end{macrocode} @@ -1729,6 +1854,32 @@ % cannot be reused or moved. % \fi % +% +% \ifnum\frenchdoc=1 +% \subsubsection{Mise en forme du document} +% La quantit\'e de versions possibles d'un gabarit \gdwp\ impose que certaines +% commandes internes de mise en forme puissent \^etre modifi\'ees simplement par +% le biais de commandes publiques, disponibles dans le pr\'eambule. Cela facilite +% le travail des responsables de l'\'edition et emp\^eche la multiplication de +% versions maison de la classe\footnote{Toute r\'ef\'erence \`a une personne r\'eelle est % +% totalement fortuite.}. +% \else +% \subsubsection{Document layout} +% The number of a \gdwp\ template's possible versions imply that some internal document +% layout commands must be easily changed via public commands, available in the template's +% preamble. This allows more efficient work on the publisher's side and prevents the +% multiplication of homemade versions of the class\footnote{Any reference to a real-life person % +% is pure coincidence.}. +% \fi +% \changes{1.1}{2021-12-02}{Added new GDcoverpagewhitespace command to change cover page vspace} +% +% \begin{macrocode} + +% Layout public commands +\newcommand{\GDcoverpagewhitespace}[1]{% + \setlength{\GD@coverpage@vspace}{#1} +} +% \end{macrocode} % \ifnum\frenchdoc=1 % \subsubsection{M\'etadonn\'ees} % Les commandes suivantes sont celles o\`u l'utilisateur saisit les donn\'ees @@ -1740,35 +1891,41 @@ % bibliographical data. They modify the values of the corresponding private % commands (see \autoref{ann:private-meta}). % \fi +% \changes{1.1}{2021-12-03}{Added public GDsupplementname command} % % \begin{macrocode} % Metadata public commands -\newcommand{\GDannee}[1]{% - \renewcommand{\gd@annee}{#1} +\newcommand{\GDyear}[1]{% + \renewcommand{\gd@year}{#1} } -\newcommand{\GDmois}[2]{% - \renewcommand{\gd@mois}{#1} - \renewcommand{\gd@month}{#2} +\newcommand{\GDmonth}[2]{% + \renewcommand{\gd@month@fr}{#1} + \renewcommand{\gd@month@en}{#2} } -\newcommand{\GDnumero}[1]{% - \renewcommand{\gd@numero}{#1} +\newcommand{\GDnumber}[1]{% + \renewcommand{\gd@number}{#1} } -\newcommand{\GDtitre}[1]{% - \renewcommand{\gd@titre}{#1} +\newcommand{\GDtitle}[1]{% + \renewcommand{\gd@title}{#1} } -\newcommand{\GDauteursCourts}[1]{% - \renewcommand{\gd@auteurs@short}{#1} +\newcommand{\GDauthorsShort}[1]{% + \renewcommand{\gd@authors@short}{#1} } -\newcommand{\GDauteursCopyright}[1]{% - \renewcommand{\gd@auteurs@copyright}{#1} +\newcommand{\GDauthorsCopyright}[1]{% + \renewcommand{\gd@authors@copyright}{#1} } \newcommand{\GDpostpubcitation}[2]{% \renewcommand{\gd@postpubcitation}{#1} \renewcommand{\gd@postpubcitation@url}{#2} } -\newcommand{\GDrevised}[1]{% - \renewcommand{\gd@revised}{#1} +\newcommand{\GDsupplementname}[1]{% + \renewcommand{\gd@supplementname}{#1} +} +\newcommand{\GDrevised}[3]{% + \renewcommand{\gd@revised@month@fr}{#1} + \renewcommand{\gd@revised@month@en}{#2} + \renewcommand{\gd@revised@year}{#3} } % \end{macrocode} % @@ -1787,16 +1944,18 @@ % multiple lines of code, a few commands and environments were created to group them % together. % \fi +% \changes{1.1}{2021-12-03}{Added supplement name in header} +% \changes{1.1}{2021-12-03}{Replaced all fancyhdr v3 commands by v4 commands} % % \begin{macrocode} % Cover page -\newcommand{\GDpageCouverture}{% +\newcommand{\GDcoverpage}{% \ifthenelse{\boolean{GD@isPlainVersion}}{}{\GD@cover} } % Title page -\newenvironment{GDpagetitre}{ +\newenvironment{GDtitlepage}{ \ifthenelse{\boolean{GD@isPlainVersion}}% {\GD@plain@titlepage@begin}% {\GD@titlepage@begin} @@ -1841,29 +2000,33 @@ \setcounter{page}{2} \renewcommand{\thepage}{\roman{page}} \pagestyle{fancy} - \lhead[ - \textcolor{gris}{\sffamily{\,}\thepage}\hfill - \textcolor{gris}{\sffamily G--\gd@annee--\gd@numero}\hfill % - \ifthenelse{\boolean{GD@isRevised}}% - {{ -- \itshape Revised}}% - {} - \textcolor{gris}{\sffamily Les Cahiers du GERAD} - {\large\strut}\color{gris}{\hrule} - ] - { - \textcolor{gris}{\sffamily{\,} Les Cahiers du GERAD}\hfill - \textcolor{gris}{\sffamily G--\gd@annee--\gd@numero}\hfill % + \fancyhead[LO]{% + \textcolor{gray}{\sffamily{\,} Les Cahiers du GERAD}\hfill + \textcolor{gray}{\sffamily G--\gd@year--\gd@number}% + \ifthenelse{\boolean{GD@isSupplement}}% + {\textcolor{gray}{\sffamily\ -- \itshape \gd@supplementname}}% + {} % \ifthenelse{\boolean{GD@isRevised}}% - {{ -- \itshape Revised}}% - {} - \textcolor{gris}{\sffamily\thepage} - {\large\strut}\color{gris}{\hrule} + {\textcolor{gray}{\sffamily\ -- \itshape Revised}}% + {}\hfill + \textcolor{gray}{\sffamily\thepage} + {\large\strut}\color{gray}{\hrule} } - \chead[]{} - \rhead[]{} - \lfoot[]{} - \cfoot[]{} - \rfoot[]{} + \fancyhead[LE]{% + \textcolor{gray}{\sffamily{\,}\thepage}\hfill + \textcolor{gray}{\sffamily G--\gd@year--\gd@number}% + \ifthenelse{\boolean{GD@isSupplement}}% + {\textcolor{gray}{\sffamily\ -- \itshape \gd@supplementname}}% + {} % + \ifthenelse{\boolean{GD@isRevised}}% + {\textcolor{gray}{\sffamily\ -- \itshape Revised}}% + {}\hfill + \textcolor{gray}{\sffamily Les Cahiers du GERAD} + {\large\strut}\color{gray}{\hrule} + } + \fancyhead[C]{} + \fancyhead[R]{} + \fancyfoot{} \renewcommand{\headrulewidth}{0pt} \renewcommand{\footrulewidth}{0pt} \rmfamily @@ -1900,6 +2063,51 @@ \rmfamily } } +% \end{macrocode} +% +% \ifnum\frenchdoc=1 +% \subsection{Commandes et environnements obsol\`etes} +% Dans la version 1.1 de \gdwp, toutes les commandes et environnements qui avaient un nom +% fran\c{c}ais ont \'et\'e traduits en anglais dans un souci d'uniformit\'e +% et pour faciliter la compr\'ehension des noms par le plus grand nombre +% d'utilisateurs. +% +% Les commandes et environnements fran\c{c}ais sont maintenus, mais seulement pour permettre +% la r\'etrocompatibilit\'e du gabarit de la version 1.0 avec la d\'efinition +% de classe des versions subs\'equentes. Une fois que cette version du gabarit +% ne sera plus en circulation, tout ce qui est obsol\`ete sera retir\'e +% de la classe. +% \else +% \subsection{Deprecated commands and environments} +% In \gdwp\ version 1.1, all commands and environments that had French names have been translated +% in English for consistency reasons and to make sure that the they could +% be directly understood by most users. +% +% The French commands and environments are preserved only to ensure backwards compatibility +% between version 1.0 of the template and subsequent versions of the class. +% Once that version of the template stops circulating, everything that is deprecated will be +% removed from the class. +% \fi +% +% \begin{macrocode} + +\newcommand{\GDtitre}[1]{\GDtitle{#1}} +\newcommand{\GDmois}[2]{\GDmonth{#1}{#2}} +\newcommand{\GDannee}[1]{\GDyear{#1}} +\newcommand{\GDnumero}[1]{\GDnumber{#1}} +\newcommand{\GDauteursCourts}[1]{\GDauthorsShort{#1}} +\newcommand{\GDauteursCopyright}[1]{\GDauthorsCopyright{#1}} +\newcommand{\GDpageCouverture}{\GDcoverpage} +\newenvironment{GDpagetitre}{ + \ifthenelse{\boolean{GD@isPlainVersion}}% + {\GD@plain@titlepage@begin}% + {\GD@titlepage@begin} +}{ + \ifthenelse{\boolean{GD@isPlainVersion}}% + {\GD@plain@pagetitle@end}% + {\GD@titlepage@end} +} + %</class> % \end{macrocode} % @@ -1909,6 +2117,8 @@ % \iffalse % ^^A Code du gabarit %<*template> +%% Template version 1.1 +%% %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% %%%%%%%%%% Notes pour les auteurs %%%%%%%%%%%%%%% %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -1983,8 +2193,12 @@ \PassOptionsToPackage{hyphens}{url} %% Choose one of the two following algorithm packages -%% \usepackage{algorithm} -\usepackage{algorithm2e} +%% \usepackage[ruled]{algorithm} +%% \usepackage{algorithmic} +% \changes{1.1}{2021-12-07}{Added package algorithmic in preamble} +\usepackage[ruled,linesnumbered]{algorithm2e} +% \changes{1.1}{2021-12-06}{Added options to algorithm packages} +\usepackage[french]{babel} \usepackage{hyperref} %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -1994,6 +2208,8 @@ %% %%% ----- DO NOT MODIFY! -------- %%%%%%%%%%%%%%% %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\GDcoverpagewhitespace{6.8cm} +% \changes{1.1}{2021-12-02}{Added new white space command for paper version} \graphicspath{{Figures/}} % graphicx pkg setup \hypersetup{colorlinks,% citecolor={blue}, % Change for "black" with natbib @@ -2002,6 +2218,21 @@ breaklinks={true} } +%% Algorithm caption customizations +\makeatletter +\ifthenelse{\isundefined{\ALG@name}}{}% +{% + \renewcommand{\ALG@name}{\sffamily\footnotesize Algorithm} +} +\makeatother +%% Algorithm2e caption customizations +\ifthenelse{\isundefined{\SetAlCapNameFnt}}{}% +{% + \SetAlCapNameFnt{\footnotesize} + \SetAlCapFnt{\sffamily\footnotesize} +} +% \changes{1.1}{2021-12-07}{Added algorithm caption customizations} + %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% %%%%%% Début - commandes de l'auteur %%%%%%%%%%%% %% %%%%%%%% Start of author commands %%%%%%%%%%%%%%% @@ -2016,20 +2247,23 @@ %% %%%%%%%%%% Métadonnées du cahier %%%%%%%%%%%%%%% %% %%%%%%%%%% Working paper metadata %%%%%%%%%%%%%%% %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\GDtitre{This is a title} -\GDmois{Mai}{May} -\GDannee{2021} -\GDnumero{XX} -\GDauteursCourts{B. Hamel, K. H\'ebert} -\GDauteursCopyright{Hamel, H\'ebert} -\GDpostpubcitation{Hamel, Benoit, Karine H\'ebert (2021). \og Un exemple de citation \fg, \emph{Journal of Journals}, vol. X issue Y, p. n-m}{https://www.gerad.ca/fr} -\GDrevised{Mai 2021} +\GDtitle{This is a title} +\GDmonth{Mai}{May} +\GDyear{2021} +\GDnumber{XX} +\GDauthorsShort{B. Hamel, K. H\'ebert} +\GDauthorsCopyright{Hamel, H\'ebert} +\GDpostpubcitation{Hamel, Benoit, Karine H\'ebert (2021). ``Un exemple de citation'', \emph{Journal of Journals}, vol. X issue Y, p. n-m}{https://www.gerad.ca/fr} +\GDsupplementname{Internet Appendix} +% \changes{1.1}{2021-12-03}{Added GDsupplementname to template preamble} +\GDrevised{Mai}{May}{2021} +% \changes{1.1}{2021-12-15}{Replaced original GDrevised by its bilingual version} \begin{document} - \GDpageCouverture + \GDcoverpage - \begin{GDpagetitre} + \begin{GDtitlepage} \begin{GDauthlist} \GDauthitem{Benoit Hamel \ref{affil:bib}} @@ -2047,7 +2281,7 @@ \GDemailitem{karine.hebert@gerad.ca} \end{GDemaillist} - \end{GDpagetitre} + \end{GDtitlepage} %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% %%%%%%%%% Résumés, mots-clés, remerciements %%%%%%%%%%% diff --git a/Master/texmf-dist/source/latex/geradwp/geradwp.ins b/Master/texmf-dist/source/latex/geradwp/geradwp.ins index 7ef7e7c993d..fa55d12649f 100644 --- a/Master/texmf-dist/source/latex/geradwp/geradwp.ins +++ b/Master/texmf-dist/source/latex/geradwp/geradwp.ins @@ -1,5 +1,5 @@ %% -%% Copyright 2021 GERAD, HEC Montréal +%% Copyright 2022 GERAD, HEC Montréal %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3c @@ -19,7 +19,7 @@ This is a stripped version of the original file. -Copyright 2021 GERAD, HEC Montreal +Copyright 2022 GERAD, HEC Montreal This work may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3c @@ -47,16 +47,15 @@ geradwp.pdf and the derived files listed in the README file. \obeyspaces \Msg{*********************************************************} -\Msg{* Classe geradwp v1.0 *} +\Msg{* Classe geradwp v1.1 *} \Msg{* *} -\Msg{* La classe geradwp est installee et prete a l'emploi. *} -\Msg{* Consultez le document geradwp.pdf afin de prendre *} -\Msg{* connaissance de toutes ses fonctionnalites. *} +\Msg{* The geradwp document class is installed and ready to *} +\Msg{* to be used. Please read the documentation in order to *} +\Msg{* understand all its features. *} \Msg{* *} -\Msg{* Pour tout commentaire, demande de correction de bogue *} -\Msg{* ou d'amelioration, ou tout simplement pour obtenir de *} -\Msg{* l'aide sur l'utilisation de la classe pour votre *} -\Msg{* travail, communiquez avec Benoit Hamel a l'adresse *} +\Msg{* If you have any comments, bug fix or feature request, *} +\Msg{* or if you need any assistance on how to use the class *} +\Msg{* and its template, please contact Benoit Hamel at *} \Msg{* benoit.2.hamel[a]hec.ca. *} \Msg{*********************************************************} diff --git a/Master/texmf-dist/tex/latex/geradwp/geradwp.cls b/Master/texmf-dist/tex/latex/geradwp/geradwp.cls index fd2bcb5fc80..d17dfaf3596 100644 --- a/Master/texmf-dist/tex/latex/geradwp/geradwp.cls +++ b/Master/texmf-dist/tex/latex/geradwp/geradwp.cls @@ -8,7 +8,7 @@ %% %% This is a stripped version of the original file. %% -%% Copyright 2021 GERAD, HEC Montreal +%% Copyright 2022 GERAD, HEC Montreal %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3c @@ -28,7 +28,7 @@ %% geradwp.pdf and the derived files listed in the README file. %% \NeedsTeXFormat{LaTeX2e} -\ProvidesClass{geradwp}[2021/08/11 v1.0 Class for the Cahiers du GERAD series] +\ProvidesClass{geradwp}[2022/04/25 v1.1 Class for the Cahiers du GERAD series] \RequirePackage{ifthen} \newboolean{GD@isWebVersion} @@ -37,6 +37,7 @@ \newboolean{GD@needsSmallHeadSep} \newboolean{GD@isFinalImpression} \newboolean{GD@isPostPublication} +\newboolean{GD@isSupplement} \newboolean{GD@isRevised} \newboolean{GD@needsminitabs} @@ -46,6 +47,7 @@ \setboolean{GD@needsSmallHeadSep}{false} \setboolean{GD@isFinalImpression}{false} \setboolean{GD@isPostPublication}{false} +\setboolean{GD@isSupplement}{false} \setboolean{GD@isRevised}{false} \setboolean{GD@needsminitabs}{false} @@ -76,6 +78,9 @@ \DeclareOption{gdpostpub}{% \setboolean{GD@isPostPublication}{true} } +\DeclareOption{gdsupplement}{% +\setboolean{GD@isSupplement}{true} +} \DeclareOption{gdrevised}{% \setboolean{GD@isRevised}{true} } @@ -100,13 +105,12 @@ \RequirePackage{multirow} \RequirePackage{array} \RequirePackage[font={footnotesize,bf,sf}]{caption} -\RequirePackage{color} +\RequirePackage{xcolor} \RequirePackage{enumitem} \ifthenelse{\boolean{GD@needsminitabs}}{% \RequirePackage{float} }{} -\definecolor{gris}{rgb}{0.44,0.44,0.44} % color pkg setup \captionsetup[table]{skip=5pt} % caption pkg setup \newlength{\GD@authitemsep} @@ -114,6 +118,7 @@ \newlength{\GD@affilitemsep} \newlength{\GD@affiltopsep} \newlength{\GD@titleminipage@hspace} +\newlength{\GD@coverpage@vspace} \ifthenelse{\boolean{GD@isPlainVersion}}{% \setlength{\GD@authitemsep}{0pt} \setlength{\GD@authtopsep}{12pt} @@ -146,7 +151,6 @@ includehead} bmargin=2cm,% lmargin=3cm,% rmargin=3cm,% -nofoot,% headsep=30pt,% includehead} }{} @@ -224,16 +228,19 @@ includehead} \popQED\endtrivlist\@endpefalse } -\newcommand{\gd@annee}{} -\newcommand{\gd@mois}{} -\newcommand{\gd@month}{} -\newcommand{\gd@numero}{} -\newcommand{\gd@titre}{} -\newcommand{\gd@auteurs@short}{} -\newcommand{\gd@auteurs@copyright}{} +\newcommand{\gd@year}{} +\newcommand{\gd@month@fr}{} +\newcommand{\gd@month@en}{} +\newcommand{\gd@number}{} +\newcommand{\gd@title}{} +\newcommand{\gd@authors@short}{} +\newcommand{\gd@authors@copyright}{} \newcommand{\gd@postpubcitation}{} \newcommand{\gd@postpubcitation@url}{} -\newcommand{\gd@revised}{} +\newcommand{\gd@supplementname}{} +\newcommand{\gd@revised@year}{} +\newcommand{\gd@revised@month@fr}{} +\newcommand{\gd@revised@month@en}{} \newcommand{\GD@cover}{% \ifthenelse{\boolean{GD@isFinalImpression}}{}{% @@ -252,13 +259,18 @@ includehead} \ifthenelse{\boolean{GD@isWebVersion}}{% \vspace*{54pt} -{\noindent\LARGE\bfseries \gd@titre\par} %Title - +{\noindent\LARGE\bfseries \gd@title\par} %Title +\ifthenelse{\boolean{GD@isSupplement}}% +{{\noindent\LARGE\gd@supplementname\par}}{} \vspace*{18pt} -{\noindent\Large\gd@auteurs@short\par} +{\noindent\Large\gd@authors@short\par} + +\vfill }{} -\vfill +\ifthenelse{\boolean{GD@isPaperVersion}}{% +\vspace*{\GD@coverpage@vspace} +}{} \hspace*{\GD@titleminipage@hspace} \begin{minipage}[c][5.4cm][c]{7cm} {\ifthenelse{\boolean{GD@isWebVersion}}% @@ -279,36 +291,38 @@ includehead} \newcommand{\GDcover@minipagetable@web}{% \begin{tabular}{p{.5cm}|p{5.5cm}} -& \normalsize G--\gd@annee--\gd@numero +& \normalsize G--\gd@year--\gd@number \ifthenelse{\boolean{GD@needsminitabs}}% {\\*[10pt]}% {\\*[8pt]} -& \normalsize\gd@month\ \gd@annee +& \normalsize\gd@month@en\ \gd@year \ifthenelse{\boolean{GD@isRevised}}{% \\ -&\normalsize Revised: \gd@revised +&\normalsize Revised: \gd@revised@month@en\ \gd@revised@year }{} \end{tabular} } \newcommand{\GDcover@minipagetable@paper}{% \begin{tabular}{p{.5cm}|p{5.5cm}} -\multicolumn{2}{p{6.5cm}}{\normalsize\bfseries \gd@titre +\multicolumn{2}{p{6.5cm}}{\normalsize\bfseries \gd@title \ifthenelse{\boolean{GD@needsminitabs}}% {\vspace*{12.5pt}}% {\vspace*{10pt}}}\\ -& \normalsize\gd@auteurs@short \\ %Initials. Name +\ifthenelse{\boolean{GD@isSupplement}}% +{& \gd@supplementname\\*[10pt]}{} +& \normalsize\gd@authors@short \\ %Initials. Name & \ifthenelse{\boolean{GD@needsminitabs}}% {\\*[15pt]}% {\\*[12pt]} -& \normalsize G--\gd@annee--\gd@numero +& \normalsize G--\gd@year--\gd@number \ifthenelse{\boolean{GD@needsminitabs}}% {\\*[10pt]}% {\\*[8pt]} -& \normalsize\gd@month\ \gd@annee +& \normalsize\gd@month@en\ \gd@year \ifthenelse{\boolean{GD@isRevised}}{% \\ -&\normalsize Revised: \gd@revised +&\normalsize Revised: \gd@revised@month@en\ \gd@revised@year }{} \end{tabular} } @@ -328,12 +342,16 @@ un lien vers l'article publi\'{e} est ajout\'{e}.\\ \medskip \scriptsize -\textbf{Citation sugg\'{e}r\'{e}e :} \gd@auteurs@short~(\gd@mois\ -\gd@annee). \gd@titre, Rapport technique, Les Cahiers du GERAD G-- -\gd@annee--\gd@numero, GERAD, HEC Montr\'{e}al, Canada.\\ +\textbf{Citation sugg\'{e}r\'{e}e :} \gd@authors@short~(\gd@month@fr\ +\gd@year). \gd@title, +\ifthenelse{\boolean{GD@isSupplement}}{\gd@supplementname .}{} +Rapport technique, Les Cahiers du GERAD G-- +\gd@year--\gd@number, GERAD, HEC Montr\'{e}al, Canada. +\ifthenelse{\boolean{GD@isRevised}}% +{ Version r\'evis\'ee: \gd@revised@month@fr\ \gd@revised@year}{}\\ \textbf{Avant de citer ce rapport technique,} veuillez visiter notre -site Web (\url{https://www.gerad.ca/fr/papers/G-\gd@annee-\gd@numero}) +site Web (\url{https://www.gerad.ca/fr/papers/G-\gd@year-\gd@number}) afin de mettre \`a jour vos donn\'ees de r\'ef\'erence, s'il a \'et\'e publi\'e dans une revue scientifique.\par \end{minipage} @@ -347,12 +365,16 @@ the original pdf is removed and a link to the published article is added.\\ \\ \scriptsize -\textbf{Suggested citation:} \gd@auteurs@short~(\gd@month\ \gd@annee). -\gd@titre, Technical report, Les Cahiers du GERAD G--\gd@annee--\gd@numero, -GERAD, HEC Montr\'{e}al, Canada.\\ +\textbf{Suggested citation:} \gd@authors@short~(\gd@month@en\ \gd@year). +\gd@title, +\ifthenelse{\boolean{GD@isSupplement}}{\gd@supplementname .}{} +Technical report, Les Cahiers du GERAD G--\gd@year--\gd@number, +GERAD, HEC Montr\'{e}al, Canada. +\ifthenelse{\boolean{GD@isRevised}}% +{ Revised version: \gd@revised@month@en\ \gd@revised@year}{}\\ \textbf{Before citing this technical report,} please visit our website -(\url{https://www.gerad.ca/en/papers/G-\gd@annee-\gd@numero}) to update +(\url{https://www.gerad.ca/en/papers/G-\gd@year-\gd@number}) to update your reference data, if it has been published in a scientific journal. \par \end{minipage} @@ -370,8 +392,8 @@ recherche du Qu\'ebec -- Nature et technologies. \medskip D\'ep\^ot l\'egal -- Biblioth\`eque et Archives nationales du Qu\'ebec, -\gd@annee\\ -\phantom{Depot legal} -- Biblioth\`eque et Archives Canada, \gd@annee +\gd@year\\ +\phantom{Depot legal} -- Biblioth\`eque et Archives Canada, \gd@year \par \end{minipage} \hfill @@ -384,8 +406,8 @@ the Fonds de recherche du Qu\'ebec -- Nature et technologies. \medskip Legal deposit -- Biblioth\`eque et Archives nationales du Qu\'ebec, -\gd@annee\\ -\phantom{Legal deposit} -- Library and Archives Canada, \gd@annee\par +\gd@year\\ +\phantom{Legal deposit} -- Library and Archives Canada, \gd@year\par \end{minipage} \hrule @@ -456,10 +478,8 @@ added.\par \hrule \smallskip -\noindent -\begin{minipage}[t][2.1cm][l]{7.5cm} +\noindent\begin{minipage}[t][2.1cm][l]{7.5cm} \scriptsize -\medskip La publication de ces rapports de recherche est rendue possible gr\^ace au soutien de HEC Montr\'eal, Polytechnique Montr\'eal, Universit\'e McGill, Universit\'e du Qu\'ebec \`a Montr\'eal, ainsi que du Fonds de @@ -467,13 +487,13 @@ recherche du Qu\'ebec -- Nature et technologies. \medskip D\'ep\^ot l\'egal -- Biblioth\`eque et Archives nationales du Qu\'ebec, -2020\\ -\phantom{Depot legal} -- Biblioth\`eque et Archives Canada, 2020\par +\gd@year\\ +\phantom{Depot legal} -- Biblioth\`eque et Archives Canada, \gd@year +\par \end{minipage} \hfill \begin{minipage}[t][2.1cm][l]{7.5cm} \scriptsize -\medskip The publication of these research reports is made possible thanks to the support of HEC Montr\'eal, Polytechnique Montr\'eal, McGill University, Universit\'e du Qu\'ebec \`a Montr\'eal, as well as @@ -481,8 +501,8 @@ the Fonds de recherche du Qu\'ebec -- Nature et technologies. \medskip Legal deposit -- Biblioth\`eque et Archives nationales du Qu\'ebec, -2020\\ -\phantom{Legal deposit} -- Library and Archives Canada, 2020\par +\gd@year\\ +\phantom{Legal deposit} -- Library and Archives Canada, \gd@year\par \end{minipage} \hrule @@ -525,7 +545,10 @@ www.gerad.ca\par } \parindent=0pt \sffamily -{\LARGE\bfseries \gd@titre\par} %Title +{\LARGE\bfseries \gd@title\par} %Title +\ifthenelse{\boolean{GD@isSupplement}}% +{{\LARGE\gd@supplementname\par} +}{} \begin{minipage}[t][10cm][l]{7.5cm} \vspace*{55pt} } @@ -534,14 +557,14 @@ www.gerad.ca\par \vfill \end{minipage} \vfill -{\bfseries \gd@month\ \gd@annee}\\* +{\bfseries \gd@month@en\ \gd@year}\\* \ifthenelse{\boolean{GD@isRevised}}% -{\\ \gd@revised \\}% +{Revised: \gd@revised@month@en\ \gd@revised@year \\}% {} {\bfseries Les Cahiers du GERAD}\\ -{\bfseries G--\gd@annee--\gd@numero}\\ -{\footnotesize Copyright \copyright\ \gd@annee\ GERAD, -\gd@auteurs@copyright} +{\bfseries G--\gd@year--\gd@number}\\ +{\footnotesize Copyright \copyright\ \gd@year\ GERAD, +\gd@authors@copyright} \vspace*{0.05cm} \hrule @@ -598,47 +621,60 @@ investigate your claim.\par \newcommand{\GD@plain@titlepage@begin}{% \thispagestyle{empty} \sffamily -{\sffamily\LARGE\bfseries\noindent\gd@titre\par} +{\sffamily\LARGE\bfseries\noindent\gd@title\par} +\ifthenelse{\boolean{GD@isSupplement}}% +{{\noindent\LARGE\gd@supplementname\par}}{} } \newcommand{\GD@plain@pagetitle@end}{% \vspace*{12pt} -{\noindent\gd@mois\ \gd@annee} +{\noindent\gd@month@en\ \gd@year} +\ifthenelse{\boolean{GD@isRevised}}% +{\\ {\noindent Revised: \gd@revised@month@en\ \gd@revised@year}}{} \vspace*{30pt} } -\newcommand{\GDannee}[1]{% -\renewcommand{\gd@annee}{#1} +\newcommand{\GDcoverpagewhitespace}[1]{% +\setlength{\GD@coverpage@vspace}{#1} } -\newcommand{\GDmois}[2]{% -\renewcommand{\gd@mois}{#1} -\renewcommand{\gd@month}{#2} + +\newcommand{\GDyear}[1]{% +\renewcommand{\gd@year}{#1} +} +\newcommand{\GDmonth}[2]{% +\renewcommand{\gd@month@fr}{#1} +\renewcommand{\gd@month@en}{#2} } -\newcommand{\GDnumero}[1]{% -\renewcommand{\gd@numero}{#1} +\newcommand{\GDnumber}[1]{% +\renewcommand{\gd@number}{#1} } -\newcommand{\GDtitre}[1]{% -\renewcommand{\gd@titre}{#1} +\newcommand{\GDtitle}[1]{% +\renewcommand{\gd@title}{#1} } -\newcommand{\GDauteursCourts}[1]{% -\renewcommand{\gd@auteurs@short}{#1} +\newcommand{\GDauthorsShort}[1]{% +\renewcommand{\gd@authors@short}{#1} } -\newcommand{\GDauteursCopyright}[1]{% -\renewcommand{\gd@auteurs@copyright}{#1} +\newcommand{\GDauthorsCopyright}[1]{% +\renewcommand{\gd@authors@copyright}{#1} } \newcommand{\GDpostpubcitation}[2]{% \renewcommand{\gd@postpubcitation}{#1} \renewcommand{\gd@postpubcitation@url}{#2} } -\newcommand{\GDrevised}[1]{% -\renewcommand{\gd@revised}{#1} +\newcommand{\GDsupplementname}[1]{% +\renewcommand{\gd@supplementname}{#1} +} +\newcommand{\GDrevised}[3]{% +\renewcommand{\gd@revised@month@fr}{#1} +\renewcommand{\gd@revised@month@en}{#2} +\renewcommand{\gd@revised@year}{#3} } -\newcommand{\GDpageCouverture}{% +\newcommand{\GDcoverpage}{% \ifthenelse{\boolean{GD@isPlainVersion}}{}{\GD@cover} } -\newenvironment{GDpagetitre}{ +\newenvironment{GDtitlepage}{ \ifthenelse{\boolean{GD@isPlainVersion}}% {\GD@plain@titlepage@begin}% {\GD@titlepage@begin} @@ -681,29 +717,33 @@ parsep=0pt} \setcounter{page}{2} \renewcommand{\thepage}{\roman{page}} \pagestyle{fancy} -\lhead[ -\textcolor{gris}{\sffamily{\,}\thepage}\hfill -\textcolor{gris}{\sffamily G--\gd@annee--\gd@numero}\hfill % +\fancyhead[LO]{% +\textcolor{gray}{\sffamily{\,} Les Cahiers du GERAD}\hfill +\textcolor{gray}{\sffamily G--\gd@year--\gd@number}% +\ifthenelse{\boolean{GD@isSupplement}}% +{\textcolor{gray}{\sffamily\ -- \itshape \gd@supplementname}}% +{} % \ifthenelse{\boolean{GD@isRevised}}% -{{ -- \itshape Revised}}% -{} -\textcolor{gris}{\sffamily Les Cahiers du GERAD} -{\large\strut}\color{gris}{\hrule} -] -{ -\textcolor{gris}{\sffamily{\,} Les Cahiers du GERAD}\hfill -\textcolor{gris}{\sffamily G--\gd@annee--\gd@numero}\hfill % +{\textcolor{gray}{\sffamily\ -- \itshape Revised}}% +{}\hfill +\textcolor{gray}{\sffamily\thepage} +{\large\strut}\color{gray}{\hrule} +} +\fancyhead[LE]{% +\textcolor{gray}{\sffamily{\,}\thepage}\hfill +\textcolor{gray}{\sffamily G--\gd@year--\gd@number}% +\ifthenelse{\boolean{GD@isSupplement}}% +{\textcolor{gray}{\sffamily\ -- \itshape \gd@supplementname}}% +{} % \ifthenelse{\boolean{GD@isRevised}}% -{{ -- \itshape Revised}}% -{} -\textcolor{gris}{\sffamily\thepage} -{\large\strut}\color{gris}{\hrule} -} -\chead[]{} -\rhead[]{} -\lfoot[]{} -\cfoot[]{} -\rfoot[]{} +{\textcolor{gray}{\sffamily\ -- \itshape Revised}}% +{}\hfill +\textcolor{gray}{\sffamily Les Cahiers du GERAD} +{\large\strut}\color{gray}{\hrule} +} +\fancyhead[C]{} +\fancyhead[R]{} +\fancyfoot{} \renewcommand{\headrulewidth}{0pt} \renewcommand{\footrulewidth}{0pt} \rmfamily @@ -737,6 +777,24 @@ parsep=0pt} \rmfamily } } + +\newcommand{\GDtitre}[1]{\GDtitle{#1}} +\newcommand{\GDmois}[2]{\GDmonth{#1}{#2}} +\newcommand{\GDannee}[1]{\GDyear{#1}} +\newcommand{\GDnumero}[1]{\GDnumber{#1}} +\newcommand{\GDauteursCourts}[1]{\GDauthorsShort{#1}} +\newcommand{\GDauteursCopyright}[1]{\GDauthorsCopyright{#1}} +\newcommand{\GDpageCouverture}{\GDcoverpage} +\newenvironment{GDpagetitre}{ +\ifthenelse{\boolean{GD@isPlainVersion}}% +{\GD@plain@titlepage@begin}% +{\GD@titlepage@begin} +}{ +\ifthenelse{\boolean{GD@isPlainVersion}}% +{\GD@plain@pagetitle@end}% +{\GD@titlepage@end} +} + \endinput %% %% End of file `geradwp.cls'. |