diff options
Diffstat (limited to 'macros/latex/contrib')
48 files changed, 4491 insertions, 644 deletions
diff --git a/macros/latex/contrib/asmeconf/README.md b/macros/latex/contrib/asmeconf/README.md index 580b0bb1ff..39f1460ad5 100644 --- a/macros/latex/contrib/asmeconf/README.md +++ b/macros/latex/contrib/asmeconf/README.md @@ -1,7 +1,7 @@ #asmeconf: A latex template for ASME conference papers# - Version 1.33 dated 2022/12/30. + Version 1.34 dated 2022/12/30. ####Overview#### This class provides a LaTeX template for ASME Conference papers formatted according to @@ -79,6 +79,9 @@ --- ####Change log#### + v1.34 (2022/12/30) + - Roll back advanced metadata feature for compatibility with pre-2022 installations + v1.33 (2022/12/30) - Update headers to 2023 IMECE - Add macro "jhmt" to asmeconf.bst for "ASME J. Heat Mass Transfer"; add sample citation and figures from jhmt. diff --git a/macros/latex/contrib/asmeconf/asmeconf-template.pdf b/macros/latex/contrib/asmeconf/asmeconf-template.pdf Binary files differindex 46dd4d02e4..06ceb434d8 100644 --- a/macros/latex/contrib/asmeconf/asmeconf-template.pdf +++ b/macros/latex/contrib/asmeconf/asmeconf-template.pdf diff --git a/macros/latex/contrib/asmeconf/asmeconf-template.tex b/macros/latex/contrib/asmeconf/asmeconf-template.tex index 4b2bf0cfa2..01191471f7 100644 --- a/macros/latex/contrib/asmeconf/asmeconf-template.tex +++ b/macros/latex/contrib/asmeconf/asmeconf-template.tex @@ -4,7 +4,7 @@ %% This file is asmeconf-template.tex, a LaTeX template to format ASME Conference papers according to %% the requirements on ASME's conference web pages, and including hypertext support for the pdf. %% -%% This file is version 1.33 dated 2022/12/30 +%% This file is version 1.34 dated 2022/12/30 %% %% As of version 1.11, this template defaults to ASME's newer conference guidelines first posted July 2019. %% Those guidelines changed the requested author block formatting to be inline. @@ -88,11 +88,11 @@ %% This change to the LaTeX kernel is being phased-in by the LaTeX3 team. Can delete if it gives you trouble. %% Under LuaLaTeX, choose pdfstandard=A-3b (and be cautious when loading extra fonts) -\DocumentMetadata{% - pdfstandard=A-3b,% A-2b, A-2u, A-3b, or A-3u - pdfversion=1.7, - lang=en-US, -} +%\DocumentMetadata{% +% pdfstandard=A-3b,% A-2b, A-2u, A-3b, or A-3u +% pdfversion=1.7, +% lang=en-US, +%} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -101,7 +101,7 @@ %% Remove the [colorlinks] option before *final* submission to ASME, to get black text for printing, %% but keep that option for other uses. -\documentclass[balance,upint,subscriptcorrection,varvw,mathalfa=cal=boondoxo,spanish,french,vietnamese,russian,greek,colorlinks]{asmeconf} +\documentclass[balance,upint,subscriptcorrection,varvw,mathalfa=cal=boondoxo,spanish,french,vietnamese,russian,greek,pdf-a,colorlinks]{asmeconf} %%%%% pdf metadata %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% diff --git a/macros/latex/contrib/asmeconf/asmeconf.cls b/macros/latex/contrib/asmeconf/asmeconf.cls index 63d78669c8..253e27d8f9 100644 --- a/macros/latex/contrib/asmeconf/asmeconf.cls +++ b/macros/latex/contrib/asmeconf/asmeconf.cls @@ -5,7 +5,7 @@ %% ASME conference requirements as represented on ASME's conference web pages in 2022. %% %% This file's version and date: - \def\versionno{1.33} + \def\versionno{1.34} \def\versiondate{2022/12/30\space} %% %% Author: John H. Lienhard, V diff --git a/macros/latex/contrib/calxxxx-yyyy/README b/macros/latex/contrib/calxxxx-yyyy/README index f97b521824..506547771b 100644 --- a/macros/latex/contrib/calxxxx-yyyy/README +++ b/macros/latex/contrib/calxxxx-yyyy/README @@ -1,4 +1,4 @@ -README for calxxxx-yyyy, 2022/01/01, v20.22a +README for calxxxx-yyyy, 2023/01/01, v20.23a TABLE OF CONTENTS @@ -17,15 +17,15 @@ TABLE OF CONTENTS ============== To print a calendar for some given years, use the \textsf{calxxxx-yyyy.tex} -file. LaTeXe it, type in the year to start with (for example 2022), the -year to end with (for example 2039), and the calendars for those years are -produced. +file. LaTeXe it, type in the year to start with (for example 2023), +the year to end with (for example 2040), and the calendars for those years +are produced. It is possible to print the calendars in different languages. Currently English (with week running from Sunday to Saturday), and Danish and German (with week running from Monday to Sunday) are supported, -but other languages can be added. (When you did a translation, please send -an e-mail with it to Martin DOT Muench AT Uni-Bonn DOT de, +but other languages can be added. (When you did a translation, +please send an e-mail with it to Martin DOT Muench AT Uni-Bonn DOT de, so that it might be included in calxxxx-yyyy.tex, thanks!) Note: The code of this "package" is based on calxxxx.tex, @@ -33,11 +33,11 @@ which is © 1999 Slobodan Janković (Thanks!). This material is published under the LPPL 1.3c: This work may be distributed and/or modified under the conditions of the LaTeX Project -Public License, either version 1.3c of this license or (at your option) any -later version. This version of this license is in -http://www.latex-project.org/lppl/lppl-1-3c.txt +Public License, either version 1.3c of this license or (at your option) +any later version. This version of this license is in +https://www.latex-project.org/lppl/lppl-1-3c.txt and the latest version of this license is in -http://www.latex-project.org/lppl.txt +https://www.latex-project.org/lppl.txt and version 1.3c or later is part of all distributions of LaTeX version 2005/12/01 or later. @@ -49,11 +49,11 @@ and version 1.3c or later is part of all distributions of LaTeX version https://www.ctan.org/pkg/calxxxx-yyyy Also a ZIP file is provided that contains the files: -the manual (calxxxx-yyyy-doc.tex, calxxxx-yyyy-doc.pdf), -the compiled examples (cal2022-2039_DE.pdf, cal2022-2039_DK.pdf, and -cal2022-2039_EN.pdf), calxxxx-yyyy.tex, +the manual (calxxxx-yyyy-doc.tex, calxxxx-yyyy-doc.pdf), +the compiled examples (cal2023-2040_DE.pdf, cal2023-2040_DK.pdf, +and cal2023-2040_EN.pdf), calxxxx-yyyy.tex, and this README: -http://mirrors.ctan.org/macros/latex/contrib/calxxxx-yyyy.zip +https://mirrors.ctan.org/macros/latex/contrib/calxxxx-yyyy.zip 3 INSTALLATION @@ -67,13 +67,13 @@ b) Install the file `calxxxx-yyyy.tex' in your TDS tree: (texmf directory). c) Create the documentation, if necessary, e.g. pdflatex calxxxx-yyyy-doc.tex -d) Update the databases if necessary, e.g. for teTeX: - mktexlsr .../texmf +e) Update the databases if necessary, e.g. for TeXLive + texhash or mktexlsr. e) Copy the documentation files to "TDS:doc/latex/calxxxx-yyyy/": README, calxxxx-yyyy-doc.tex, calxxxx-yyyy-doc.pdf - (and e.g. cal2022-2039_DE.pdf, cal2022-2039_DK.pdf, - and cal2022-2039_EN.pdf). + (and e.g. cal2023-2040_DE.pdf, cal2023-2040_DK.pdf, + and cal2023-2040_EN.pdf). 4 ADDITIONAL PACKAGES @@ -122,5 +122,5 @@ Bug reports can be send to the maintainer: 7 KNOWN PROBLEMS ================= -* If you request too many years (more than about 141) at once, +* If you request too many years (more than about 85) at once, (La)TeX will run out of memory (unless you increase that).
\ No newline at end of file diff --git a/macros/latex/contrib/calxxxx-yyyy/cal2022-2039_DE.pdf b/macros/latex/contrib/calxxxx-yyyy/cal2022-2039_DE.pdf Binary files differdeleted file mode 100644 index 58b4b82f85..0000000000 --- a/macros/latex/contrib/calxxxx-yyyy/cal2022-2039_DE.pdf +++ /dev/null diff --git a/macros/latex/contrib/calxxxx-yyyy/cal2022-2039_DK.pdf b/macros/latex/contrib/calxxxx-yyyy/cal2022-2039_DK.pdf Binary files differdeleted file mode 100644 index e03d873daf..0000000000 --- a/macros/latex/contrib/calxxxx-yyyy/cal2022-2039_DK.pdf +++ /dev/null diff --git a/macros/latex/contrib/calxxxx-yyyy/cal2022-2039_EN.pdf b/macros/latex/contrib/calxxxx-yyyy/cal2022-2039_EN.pdf Binary files differdeleted file mode 100644 index b833dd272b..0000000000 --- a/macros/latex/contrib/calxxxx-yyyy/cal2022-2039_EN.pdf +++ /dev/null diff --git a/macros/latex/contrib/calxxxx-yyyy/cal2023-2040_DE.pdf b/macros/latex/contrib/calxxxx-yyyy/cal2023-2040_DE.pdf Binary files differnew file mode 100644 index 0000000000..7bbc47c3f4 --- /dev/null +++ b/macros/latex/contrib/calxxxx-yyyy/cal2023-2040_DE.pdf diff --git a/macros/latex/contrib/calxxxx-yyyy/cal2023-2040_DK.pdf b/macros/latex/contrib/calxxxx-yyyy/cal2023-2040_DK.pdf Binary files differnew file mode 100644 index 0000000000..66caa62c6d --- /dev/null +++ b/macros/latex/contrib/calxxxx-yyyy/cal2023-2040_DK.pdf diff --git a/macros/latex/contrib/calxxxx-yyyy/cal2023-2040_EN.pdf b/macros/latex/contrib/calxxxx-yyyy/cal2023-2040_EN.pdf Binary files differnew file mode 100644 index 0000000000..2978dd9592 --- /dev/null +++ b/macros/latex/contrib/calxxxx-yyyy/cal2023-2040_EN.pdf diff --git a/macros/latex/contrib/calxxxx-yyyy/calxxxx-yyyy-doc.pdf b/macros/latex/contrib/calxxxx-yyyy/calxxxx-yyyy-doc.pdf Binary files differindex b14e6b18f1..5d93d46ec4 100644 --- a/macros/latex/contrib/calxxxx-yyyy/calxxxx-yyyy-doc.pdf +++ b/macros/latex/contrib/calxxxx-yyyy/calxxxx-yyyy-doc.pdf diff --git a/macros/latex/contrib/calxxxx-yyyy/calxxxx-yyyy-doc.tex b/macros/latex/contrib/calxxxx-yyyy/calxxxx-yyyy-doc.tex index 88d99b59b8..a14a4469ec 100644 --- a/macros/latex/contrib/calxxxx-yyyy/calxxxx-yyyy-doc.tex +++ b/macros/latex/contrib/calxxxx-yyyy/calxxxx-yyyy-doc.tex @@ -1,4 +1,7 @@ -\documentclass{article} +\NeedsTeXFormat{LaTeX2e}[2022-11-01] +\ProvidesFile{calxxxx-yyyy-doc.tex}% + [2023-01-01 v20.23a ReadMe for calxxxx-yyyy.tex] +\documentclass{article}[2022/07/02]% v1.4n \usepackage[% extension=pdf,% plainpages=false,% @@ -6,19 +9,20 @@ hyperindex=false,% pdflang={en},% pdftitle={README for calxxxx-yyyy.tex},% - pdfauthor={H.-Martin Muench},% + pdfauthor={H.-Martin Münch},% pdfsubject={README for calxxxx-yyyy.tex},% - pdfkeywords={LaTeX, calxxxx-yyyy, H.-Martin Muench},% + pdfkeywords={LaTeX, calxxxx-yyyy},% pdfview=Fit,% pdfstartview=Fit,% pdfpagelayout=SinglePage,% bookmarksopen=true% -]{hyperref}[2012/11/06]% v6.83m +]{hyperref}[2022-11-13]% v7.00u +\pagestyle{empty} \begin{document} -\section*{\texttt{ReadMe} for cal$xxxx-yyyy$.tex file} -Version: v20.22a\newline -Date: 2022/01/01\newline -\copyright{} 2010 - 2022 H.-Martin M\"{u}nch (Martin dot Muench at Uni-Bonn dot de)\newline +\section*{\texttt{ReadMe} for cal$xxxx-yyyy$.tex} +Version: v20.23a\newline +Date: 2023-01-01\newline +© 2010 - 2023 H.-Martin Münch (Martin dot Muench at Uni-Bonn dot de)\newline \noindent This file explains the use of the \textsf{calxxxx-yyyy.tex} file, available at\newline @@ -26,21 +30,21 @@ available at\newline \noindent For information about possible modifications and the mathematical background for the calculation of the calendar please see the README file of the original \textsf{calxxxx.tex} file. \textsf{calxxxx-yyyy.tex} is for \LaTeXe, and uses -the \textsf{array.sty}, \textsf{babel.sty}, and \textsf{geometry.sty} packages. +the \textsf{array}, \textsf{babel}, and \textsf{geometry} packages. \hspace*{-1.98471pt}To print a calendar for some given years, use the \textsf{calxxxx-yyyy.tex} file. \LaTeXe{} it, type in the year to start with -(for example 2022), the year to end with (for example 2039), and the calendars +(for example 2023), the year to end with (for example 2040), and the calendars for those years are produced. It is possible to print the calendars in different languages. Currently English (with week running from Sunday to Saturday), and Danish and German (with week running from Monday to Sunday) are supported, but other languages can be added. (When you did a translation, please send -an e-mail with it to {\nolinebreak Martin.Muench@Uni-Bonn.de,} +an e-mail with it to Martin dot Muench at Uni-Bonn dot de, so that it might be included in \textsf{calxxxx-yyyy.tex}, thanks!)\newline Everything else is as described in the README for \textsf{calxxxx.tex}.\newline -The \textsf{calxxxx.tex} file is \copyright{} 1999 Slobodan Jankovi\'{c}.\newline +The \textsf{calxxxx.tex} file is ©~1999 Slobodan Janković.\newline \textsf{calxxxx-yyyy.tex} is published under the LPPL~1.3c: This work may be distributed and/or modified under the conditions of the \LaTeX{} Project Public License, either version 1.3c of this license or (at your option) any @@ -51,7 +55,7 @@ and the latest version of this license is in \url{https://www.latex-project.org/lppl.txt}\newline and version 1.3c or later is part of all distributions of \LaTeX{} version -2005/12/01 or later. +2005-12-01 or later. The authors disclaim all warranties as to this software, whether expressed or implied, including without limitation any implied warranties of @@ -66,6 +70,6 @@ to \textsc{Koloskov Gleb} for reporting a bug. \item[--] \url{https://www.ctan.org/pkg/kalender} \end{description} -\noindent A list of my (H.-Martin M\"{u}nch) packages can be found at\newline +\noindent A list of my (H.-Martin Münch) packages can be found at\newline \url{https://www.ctan.org/author/muench-hm}. \end{document}
\ No newline at end of file diff --git a/macros/latex/contrib/calxxxx-yyyy/calxxxx-yyyy.tex b/macros/latex/contrib/calxxxx-yyyy/calxxxx-yyyy.tex index 8592368ebb..f766b267fa 100644 --- a/macros/latex/contrib/calxxxx-yyyy/calxxxx-yyyy.tex +++ b/macros/latex/contrib/calxxxx-yyyy/calxxxx-yyyy.tex @@ -1,19 +1,19 @@ -% calxxx-yyyy.tex -% version: v20.22a -% date: 2022/01/01 +\NeedsTeXFormat{LaTeX2e} +\ProvidesFile{calxxxx-yyyy.tex}% + [2023/01/01 v20.23a Print a calendar for a group of years (HMM)] % -% Copyright (C) 2010 - 2022 H.-Martin M\"{u}nch (Martin dot Muench at Uni-Bonn dot de) -% Portions of code copyrighted by Slobodan Jankovi\'{c}. -% This file was invented in 1999 by Slobodan Jankovi\'{c}. +% Copyright © 2010 - 2023 H.-Martin Münch (Martin dot Muench at Uni-Bonn dot de) +% Portions of code copyrighted by Slobodan Janković. +% This file was invented in 1999 by Slobodan Janković. % I was not able to reach him at slobodan@archimed.filfak.ni.ac.yu % (not surprisingly with a .yu address). % Thanks to the translators (see below) and the reporter of a bug: Koloskov Gleb. % Languages/Translations: -% - English: Slobodan Jankovi\'{c} -% - German (Deutsch): Martin M\"{u}nch +% - English: Slobodan Janković +% - German (Deutsch): Martin Münch % - Danish (Dansk): Michael Lodahl % -% I updated Jankovi\'{c}'s file, so that it is possible to print the calendars +% I updated Janković's file, so that it is possible to print the calendars % for different years and to use different languages (and therefore also use weeks % running from Monday to Sunday instead of Sunday to Saturday). % @@ -24,34 +24,34 @@ % conditions of the LaTeX Project Public License (LPPL), % either version 1.3c of this license or (at your option) any later version. % This version of this license is in -% http://www.latex-project.org/lppl/lppl-1-3c.txt +% https://www.latex-project.org/lppl/lppl-1-3c.txt % and the latest version of this license is in -% http://www.latex-project.org/lppl.txt +% https://www.latex-project.org/lppl.txt % and version 1.3c 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 H.-Martin Muench. +% The Current Maintainer of this work is H.-Martin Münch. % % This work consists of the main source files % calxxxx-yyyy.tex, README, and calxxxx-yyyy-doc.tex, % and the derived files -% calxxxx-yyyy-doc.pdf, cal2022-2039_DE.pdf, cal2022-2039_DK.pdf, -% and cal2022-2039_EN.pdf. +% calxxxx-yyyy-doc.pdf, cal2023-2040_DE.pdf, cal2023-2040_DK.pdf, +% and cal2023-2040_EN.pdf. % % In memoriam % Claudia Simone Barth + 1996/01/30 -% Tommy Muench + 2014/01/02 -% Hans-Klaus Muench + 2014/08/24 +% Tommy Münch + 2014/01/02 +% Hans-Klaus Münch + 2014/08/24 % -\documentclass[12pt,a4paper,danish,german,english]{report} +\documentclass[12pt,a4paper,danish,german,english]{report}[2022/07/02]% v1.4n % In the options you need to place the desired language at the last position. % Sorry for the inconvenience. -\usepackage{babel}[2016/02/24]% v3.9q +\usepackage{babel}[2022/12/26]% v3.84 \selectlanguage{english}% Also possible: 'english', 'german', or 'danish' -\usepackage[a4paper,textwidth=\paperwidth,textheight=\paperheight]{geometry}[2010/09/12]% v5.6 -\usepackage{array}[2014/10/28]% v2.4c +\usepackage[a4paper,textwidth=\paperwidth,textheight=\paperheight]{geometry}[2020/01/02]% v5.9 +\usepackage{array}[2022/09/04]% v2.5g \listfiles \thispagestyle{empty} @@ -96,13 +96,13 @@ \def\Sun{\textbf{S}} \def\Mon{\textbf{M}} \def\Tue{\textbf{T}} \def\Wen{\textbf{W}} \def\Thr{\textbf{T}} \def\Fri{\textbf{F}} \def\Sat{\textbf{S}} -\iflanguage{english}{% That is already the default language. Nothing to be done. +\iflanguage{english}{% English, which is already the default language. Nothing to be done. \typeout{Language \languagename ^^J} }{\iflanguage{german}{% Deutsch \typeout{Language \languagename ^^J} - \def\BC{~v.~Chr.}\def\AD{}% 'B.C.' after a negative year, nothing after a positive + \def\BC{~v.~Chr.}\def\AD{}% '~v.~Chr.' after a negative year, nothing after a positive - \def\Jan{Januar} \def\Feb{Februar}\def\Mar{M\"{a}rz}\def\Apr{April} + \def\Jan{Januar} \def\Feb{Februar}\def\Mar{März}\def\Apr{April} \def\May{Mai} \def\Jun{Juni} \def\Jul{Juli} \def\Aug{August} \def\Sep{September}\def\Oct{Oktober}\def\Nov{November}\def\Dec{Dezember} @@ -110,7 +110,7 @@ \def\Thr{\textbf{Do}} \def\Fri{\textbf{Fr}} \def\Sat{\textbf{Sa}} \def\Sun{\textbf{So}} }{\iflanguage{danish}{% Danish \typeout{Language \languagename ^^J} - \def\BC{~f.~Kr.}\def\AD{}% 'B.C.' after a negative year, nothing after a positive + \def\BC{~f.~Kr.}\def\AD{}% '~f.~Kr.' after a negative year, nothing after a positive \def\Jan{Januar} \def\Feb{Februar}\def\Mar{Marts} \def\Apr{April} \def\May{Maj} \def\Jun{Juni} \def\Jul{Juli} \def\Aug{August} @@ -121,7 +121,7 @@ }{% Not English, Danish or German. Place your translation here! % Further down there is another place in the code which needs the "translation" % for further languages, search for "Place your translation here!". - \typeout{Language \languagename \space not supported. Keeping the default: English.} + \typeout{Language \languagename\space not supported. Keeping the default: English.} } } } @@ -131,13 +131,13 @@ \def\sm{\hspace{2pt}}% space between months % Select Gregorian/Julian calendar and zero/nonzero (default are both false) -\Julianfalse % don't use Julian, use Gregorian calendar -\ZeroExistfalse% zero year doesn't exist (before 1st is -1st year) -%\Juliantrue % use Julian, don't use Gregorian calendar +\Julianfalse % do not use Julian, use Gregorian calendar +\ZeroExistfalse% zero year does not exist (before 1st is -1st year) +%\Juliantrue % use Julian, do not use Gregorian calendar %\ZeroExisttrue% zero year exists (before 1st is 0th year) % Do you wish a cm rule? (default is false) -\CmRulefalse% don't print the cm rule +\CmRulefalse% do not print the cm rule %\CmRuletrue% print the cm rule %========== End of Safe Modifications ============= @@ -183,15 +183,15 @@ % Defines all kind of rows \def\rows{% -\def\rone{&1&8&15&22&29&}%rows for a month with 31 days +\def\rone{&1&8&15&22&29&}% rows for a month with 31 days \def\rtwo{&2&9&16&23&30&}\def\btwo{&&2&9&16&23&30}% \def\rthree{&3&10&17&24&31&}\def\bthree{&&3&10&17&24&31}% \def\rfour{&4&11&18&25&&}\def\bfour{&&4&11&18&25&}% \def\rfive{&5&12&19&26&&}\def\bfive{&&5&12&19&26&}% \def\rsix{&6&13&20&27&&}\def\bsix{&&6&13&20&27&}% \def\rseven{&7&14&21&28&&}\def\bseven{&&7&14&21&28&}% -\ifnum\m=2% if February ... - \ifleap\else\def\rone{&1&8&15&22&&}\fi%if it isn't a leap year +\ifnum\m=2% if February... + \ifleap\else\def\rone{&1&8&15&22&&}\fi% if it is no leap year \def\rtwo{&2&9&16&23&&}\def\btwo{&&2&9&16&23&}% \def\rthree{&3&10&17&24&&}\def\bthree{&&3&10&17&24&}% \else% if other month with <=30 days ... @@ -206,27 +206,27 @@ \setleap\dayofweek{#1}\rows% set leap, set \x=day of the week, and define all rows \setlength{\tabcolsep}{0pt} \begin{tabular*}{7em}{|>{\centering}p{\Wd}|@{\extracolsep{\fill}}rrrrrr|} -\multicolumn{7}{l}{\sm\monthfont%print name of a month \m +\multicolumn{7}{l}{\sm\monthfont% print name of a month \m \ifcase\m \or\Jan\or\Feb\or\Mar\or\Apr\or\May\or\Jun\or\Jul\or\Aug\or\Sep\or\Oct\or\Nov\or\Dec \fi}\\ \hline \ifcase\x - \Sun\rone\\ \Mon\rtwo\\ \Tue\rthree\\ \Wen\rfour\\ \Thr\rfive\\ \Fri\rsix\\ \Sat\rseven\\ \or%if Sunday - \Sun\bseven\\ \Mon\rone\\ \Tue\rtwo\\ \Wen\rthree\\ \Thr\rfour\\ \Fri\rfive\\ \Sat\rsix\\ \or%if Monday - \Sun\bsix\\ \Mon\bseven\\ \Tue\rone\\ \Wen\rtwo\\ \Thr\rthree\\ \Fri\rfour\\ \Sat\rfive\\ \or%if Tuesday - \Sun\bfive\\ \Mon\bsix\\ \Tue\bseven\\ \Wen\rone\\ \Thr\rtwo\\ \Fri\rthree\\ \Sat\rfour\\ \or%if Wednesday - \Sun\bfour\\ \Mon\bfive\\ \Tue\bsix\\ \Wen\bseven\\ \Thr\rone\\ \Fri\rtwo\\ \Sat\rthree\\ \or%if Thursday - \Sun\bthree\\ \Mon\bfour\\ \Tue\bfive\\ \Wen\bsix\\ \Thr\bseven\\ \Fri\rone\\ \Sat\rtwo\\ \or%if Friday - \Sun\btwo\\ \Mon\bthree\\ \Tue\bfour\\ \Wen\bfive\\ \Thr\bsix\\ \Fri\bseven\\ \Sat\rone\\ \fi%if Saturday + \Sun\rone\\ \Mon\rtwo\\ \Tue\rthree\\ \Wen\rfour\\ \Thr\rfive\\ \Fri\rsix\\ \Sat\rseven\\ \or% if Sunday + \Sun\bseven\\ \Mon\rone\\ \Tue\rtwo\\ \Wen\rthree\\ \Thr\rfour\\ \Fri\rfive\\ \Sat\rsix\\ \or% if Monday + \Sun\bsix\\ \Mon\bseven\\ \Tue\rone\\ \Wen\rtwo\\ \Thr\rthree\\ \Fri\rfour\\ \Sat\rfive\\ \or% if Tuesday + \Sun\bfive\\ \Mon\bsix\\ \Tue\bseven\\ \Wen\rone\\ \Thr\rtwo\\ \Fri\rthree\\ \Sat\rfour\\ \or% if Wednesday + \Sun\bfour\\ \Mon\bfive\\ \Tue\bsix\\ \Wen\bseven\\ \Thr\rone\\ \Fri\rtwo\\ \Sat\rthree\\ \or% if Thursday + \Sun\bthree\\ \Mon\bfour\\ \Tue\bfive\\ \Wen\bsix\\ \Thr\bseven\\ \Fri\rone\\ \Sat\rtwo\\ \or% if Friday + \Sun\btwo\\ \Mon\bthree\\ \Tue\bfour\\ \Wen\bfive\\ \Thr\bsix\\ \Fri\bseven\\ \Sat\rone\\ \fi% if Saturday \hline \end{tabular*}} -\iflanguage{english}{% English. Nothing to be done, default language. +\iflanguage{english}{% English, which is already the default language. Nothing to be done. }{\iflanguage{german}{% Deutsch \def\Month#1{% #1=month \setleap\dayofweek{#1}\rows% set leap, set \x=day of the week, and define all rows \setlength{\tabcolsep}{0pt} \begin{tabular*}{7em}{|>{\centering}p{\Wd}|@{\extracolsep{\fill}}rrrrrr|} -\multicolumn{7}{l}{\sm\monthfont%print name of a month \m +\multicolumn{7}{l}{\sm\monthfont% print name of a month \m \ifcase\m \or\Jan\or\Feb\or\Mar\or\Apr\or\May\or\Jun\or\Jul\or\Aug\or\Sep\or\Oct\or\Nov\or\Dec \fi}\\ \hline \ifcase\x @@ -244,7 +244,7 @@ \setleap\dayofweek{#1}\rows% set leap, set \x=day of the week, and define all rows \setlength{\tabcolsep}{0pt} \begin{tabular*}{7em}{|>{\centering}p{\Wd}|@{\extracolsep{\fill}}rrrrrr|} - \multicolumn{7}{l}{\sm\monthfont%print name of a month \m + \multicolumn{7}{l}{\sm\monthfont% print name of a month \m \ifcase\m \or\Jan\or\Feb\or\Mar\or\Apr\or\May\or\Jun\or\Jul\or\Aug\or\Sep\or\Oct\or\Nov\or\Dec \fi}\\ \hline \ifcase\x @@ -265,9 +265,9 @@ % Enter the years. Well, could be sensitive to language, too... \def\enteryear{\typeout{} -\typeout{Enter the year (negative for B.C., 0th year does\ifZeroExist \else \space not\fi \space exist),} +\typeout{Enter the year (negative for B.C., 0th year does\ifZeroExist\else\space not\fi\space exist),} \typeout{with which to start the calendar!}\typeout{} -\typeout{For the current year, \number\year , just press the ENTER key!} +\typeout{For the current year, \number\year, just press the ENTER key!} \loop \typein[\Year]{} \ifx \Year\empty \gdef\Year{\year} \fi @@ -275,18 +275,18 @@ \leapfalse \ifnum \y=0 \ifZeroExist \else \leaptrue \fi\fi \ifleap \typeout{}\typeout{0th year doesn't exist! Maybe you want the year -1.} \repeat \typeout{}% -\typeout{Enter the year (negative for B.C., 0th year does\ifZeroExist \else \space not\fi \space exist),}% +\typeout{Enter the year (negative for B.C., 0th year does\ifZeroExist\else\space not\fi\space exist),}% \typeout{with which to end the calendar!}\typeout{}% \typeout{For the current year, \number\year , just press the ENTER key!}% -\typeout{(More than 141 years will probably exceed TeX's memory.)}% +\typeout{(More than 85 years will probably exceed TeX's memory.)}% \loop \typein[\YearZ]{} \ifx \YearZ\empty \gdef\YearZ{\year} \fi \leapfalse \ifnum \y=0 \ifZeroExist \else \leaptrue \fi\fi - \ifnum\YearZ<\Year \typeout{}\typeout{Error: (Start-)Year must be before (End-)YearZ!} \gdef\YearZ{\Year} \fi - \ifleap \typeout{}\typeout{0th year doesn't exist! Maybe you want the year -1.} \repeat + \ifnum\YearZ<\Year \typeout{}\typeout{Error: (Start-)Year must be before (End-)Year!} \gdef\YearZ{\Year} \fi + \ifleap \typeout{}\typeout{0th year does not exist! Maybe you want the year -1.} \repeat \typeout{}% -\typeout{\ifJulian Julian \else Gregorian \fi Calendar for the years \number\y -\number\YearZ. }% +\typeout{\ifJulian Julian\else Gregorian\fi\space Calendar for the years \number\y -\number\YearZ.}% \typeout{(Leap years are starred * .)}% \typeout{}} @@ -340,8 +340,8 @@ \repeat \message{^^J}\message{^^J}% \newline% -\tiny{\indent Original calxxxx.\TeX{} \copyright{} 1999/12/19 Slobodan Jankovi\'{c}; % -these calendars produced with calxxxx-yyyy 2022/01/01 v20.22a by \texttt{Martin.Muench@Uni-Bonn.de};% +\tiny{\indent Original calxxxx.\TeX{} \copyright{} 1999-12-19 Slobodan Jankovi\'{c}; % +these calendars produced with calxxxx-yyyy 2023-01-01 v20.23a by \texttt{Martin.Muench@Uni-Bonn.de};% \newline\indent% \iflanguage{english}{English by Slobodan Jankovi\'{c}.}{% \iflanguage{german}{Deutsch von H.-Martin M\"{u}nch.}{% @@ -352,5 +352,5 @@ these calendars produced with calxxxx-yyyy 2022/01/01 v20.22a by \texttt{Martin. } } -\ifCmRule\cmscale(8,35)\fi% Print cm rule +\ifCmRule\cmscale(8,35)\fi% print cm rule \end{document}
\ No newline at end of file diff --git a/macros/latex/contrib/elegantbook/README.md b/macros/latex/contrib/elegantbook/README.md index 21f5b47132..81a32d5340 100644 --- a/macros/latex/contrib/elegantbook/README.md +++ b/macros/latex/contrib/elegantbook/README.md @@ -14,6 +14,10 @@ ElegantBook 是为 LaTeX 书籍写作而设计的模板,由 [Ethan Deng](https ElegantBook is designed for writing books, created by [Ethan Deng](https://github.com/EthanDeng) and [Liam Huang](https://github.com/Liam0205), and maintained by [Ethan Deng](https://github.com/EthanDeng), [syvshc](https://github.com/syvshc) and [sikouhjw](https://github.com/sikouhjw). Just enjoy it! If you have any questions, suggestions or bug reports, you can create issues or contact us at elegantlatex2e@gmail.com. +**本模板自 2023 年 1 月 1 日开始,不再维护,不建议使用本系列模板!为了保证之前版本的用户仍然能查到说明文档,本说明文档仍然保留过去的信息。** + +**Caution: This template will no longer be maintained since January 1st, 2023.** + ## 致谢 Acknowledgement diff --git a/macros/latex/contrib/elegantbook/elegantbook-cn.pdf b/macros/latex/contrib/elegantbook/elegantbook-cn.pdf Binary files differindex 785c9c733f..28e8022c4c 100644 --- a/macros/latex/contrib/elegantbook/elegantbook-cn.pdf +++ b/macros/latex/contrib/elegantbook/elegantbook-cn.pdf diff --git a/macros/latex/contrib/elegantbook/elegantbook-cn.tex b/macros/latex/contrib/elegantbook/elegantbook-cn.tex index 89f89bd2eb..e289e77d37 100644 --- a/macros/latex/contrib/elegantbook/elegantbook-cn.tex +++ b/macros/latex/contrib/elegantbook/elegantbook-cn.tex @@ -1,15 +1,15 @@ -\documentclass[lang=cn,10pt,founder,newtx]{elegantbook} +\documentclass[lang=cn,newtx,10pt,scheme=chinese]{elegantbook} \title{ElegantBook:优美的 \LaTeX{} 书籍模板} \subtitle{Elegant\LaTeX{} 经典之作} -\author{Ethan Deng \& Liam Huang} +\author{Ethan Deng \& Liam Huang \& syvshc \& sikouhjw \& Osbert Wang} \institute{Elegant\LaTeX{} Program} -\date{Aug 15, 2022} -\version{4.4} +\date{2022/12/31} +\version{4.5} \bioinfo{自定义}{信息} -\extrainfo{要让一群人团结起来,需要的不是英明的领导,而是共同的敌人。—— 比企谷八幡} +\extrainfo{注意:本模板自 2023 年 1 月 1 日开始,不再更新和维护!} \setcounter{tocdepth}{3} @@ -38,7 +38,12 @@ \chapter{Elegant\LaTeX{} 系列模板介绍} -Elegant\LaTeX{} 项目组致力于打造一系列美观、优雅、简便的模板方便用户使用。目前由 \href{https://github.com/ElegantLaTeX/ElegantNote}{ElegantNote},\href{https://github.com/ElegantLaTeX/ElegantBook}{ElegantBook},\href{https://github.com/ElegantLaTeX/ElegantPaper}{ElegantPaper} 组成,分别用于排版笔记,书籍和工作论文。大版本改动较大,请关注版本信息,在未开始使用模板钱,建议直接选择最新正式版本! +\begin{quotation} + \textbf{\textcolor{red}{本模板自 2023 年 1 月 1 日开始,不再维护,不建议使用本系列模板!为了保证之前版本的用户仍然能查到说明文档,本说明文档仍然保留过去的信息。}} +\end{quotation} + +Elegant\LaTeX{} 项目组致力于打造一系列美观、优雅、简便的模板方便用户使用。目前由 \href{https://github.com/ElegantLaTeX/ElegantNote}{ElegantNote},\href{https://github.com/ElegantLaTeX/ElegantBook}{ElegantBook},\href{https://github.com/ElegantLaTeX/ElegantPaper}{ElegantPaper} 组成,分别用于排版笔记,书籍和工作论文。大版本改动较大,请关注版本信息,在未开始使用模板前,建议直接选择最新正式版本! + 本文将介绍本模板的一些设置内容以及基本使用方法。如果您有其他问题,建议或者意见,欢迎在 GitHub 上给我们提交 \href{https://github.com/ElegantLaTeX/ElegantBook/issues}{issues} 或者邮件联系我们。我们的联系方式如下,建议加入用户 QQ 群提问,这样能更快获得准确的反馈,加群时请备注 \LaTeX{} 或者 Elegant\LaTeX{} 相关内容。 \begin{itemize} @@ -46,17 +51,10 @@ Elegant\LaTeX{} 项目组致力于打造一系列美观、优雅、简便的模 \item GitHub 地址:\href{https://github.com/ElegantLaTeX/}{https://github.com/ElegantLaTeX/} \item CTAN 地址:\href{https://ctan.org/pkg/elegantbook}{https://ctan.org/pkg/elegantbook} \item 下载地址:\href{https://github.com/ElegantLaTeX/ElegantBook/releases}{正式发行版},\href{https://github.com/ElegantLaTeX/ElegantBook/archive/master.zip}{最新版} - \item 微博:Elegant\LaTeX{} - \item 微信公众号:Elegant\LaTeX{} \item Bilibili:\href{https://space.bilibili.com/516479629}{ElegantLaTeX} \item 用户 QQ 群:692108391 - \item 邮件:\email{elegantlatex2e@gmail.com} \end{itemize} -\begin{quotation} - \textbf{注意:} 由于 ElegantLaTeX 的模板涉及宏包和设定比较多,不建议没有 \LaTeX{} 基础的用户使用。我们会通过 \href{https://space.bilibili.com/516479629}{B 站}进行直播或者交流分享会,录屏也将发布在该账户下,如果大家在模板的使用上有问题,可以观看视频、加群咨询或者查看模板自带的文档说明(如果安装了 TeX Live,可以使用在命令行提示符下运行 \lstinline{texdoc elegantbook} 命令获得模板的说明文档。 -\end{quotation} - \section{模板安装与更新} @@ -96,20 +94,6 @@ tlmgr update --self --all --reinstall-forcibly-removed 由于宏包版本问题,本模板不支持 C\TeX{} 套装,请务必安装 TeX Live/Mac\TeX{}。更多关于 \TeX{} Live 的安装使用以及 C\TeX{} 与 \TeX{} Live 的兼容、系统路径问题,请参考官方文档以及啸行的\href{https://github.com/OsbertWang/install-latex-guide-zh-cn/releases/}{一份简短的关于安装 \LaTeX{} 安装的介绍}。 -\section{关于提交} - -由于精力有限,本人维护模板的时间并不多,考虑到模板的用户还挺多,本模板自 2022 年 8 月开始,开放特性提交(features pull requests)!不过在提交之前,请务必在 issue 区将问题、解决方式以及对应的示例(最简单的使用示例)写清楚,我们会根据 issue 的信息,接受合适的提交。 - - -\section{赞助} - -如果您非常喜爱我们的模板,你还可以选择赞助的方式支持这个项目,赞助主要用于网站域名和服务器的购买、QQ 用户群的维护以及对于管理员的奖励。赞赏费用的使用解释权归 ElegantLaTeX/EthanDeng 所有,不接受监督。 - -\begin{figure}[htbp] - \centering - \includegraphics[width=0.5\textwidth]{donate.jpg} -\end{figure} - \chapter{ElegantBook 设置说明} @@ -446,24 +430,36 @@ tlmgr update --self --all --reinstall-forcibly-removed \documentclass[thmcnt=section]{elegantbook} \end{lstlisting} +如果希望全局的定理类环境使用同一个计数器,可以使用文档类选项 \lstinline{usesamecnt}: + +\begin{lstlisting} + \documentclass[usesamecnt]{elegantbook} +\end{lstlisting} + \subsection{自定义定理类环境} 4.4 版本新增了一个自定义定理类环境的命令:\lstinline|\elegantnewtheorem|,它的参数含义如下: \begin{lstlisting} % fancy 模式(默认) -\elegantnewtheorem{env}{title}{style}{prefix} +\elegantnewtheorem{env}{title}{style}{prefix}[numbered-like] % simple 模式 -\elegantnewtheorem{env}{title}{style} +\elegantnewtheorem{env}{title}{style}[numbered-like] \end{lstlisting} 该命令可以同时定义编号环境 \lstinline|env| 和不编号环境 \lstinline|env*|。 其中 \lstinline|style| 支持的参数有:\lstinline|defstyle|,\lstinline|thmstyle|,\lstinline|prostyle|,分别对应“定义”,“定理”,“命题”三种样式。 +如果添加了可选参数 \lstinline{numbered-like},将会使该定理类环境与名为 \lstinline{numbered-like} 的定理类环境使用同一计数器。\textbf{注意}:该参数在使用 \lstinline{usesamecnt} 选项时不起作用,并且会在终端以及 \lstinline{.log} 文件中输出一个警告,来提示用户该选项不起作用: + +\begin{lstlisting} + [numbered-like] won't make sence with option + `usesamecnt'. +\end{lstlisting} \begin{itemize} - \item 在炫彩模式(\lstinline{fancy})下,需要 4 个参数来定义一个新的定理类环境,分别是: - 定理类环境名,定理类环境的标题,定理类环境的样式,该定理类环境的前缀: + \item 在炫彩模式(\lstinline{fancy})下,需要 5 个参数来定义一个新的定理类环境,分别是: + 定理类环境名,定理类环境的标题,定理类环境的样式,该定理类环境的前缀,(可选)该定理类环境继承的定理类环境: \begin{lstlisting} % 导言区 @@ -501,8 +497,8 @@ Class elegantbook Warning: Because you didn't provide a prefix. (elegantbook) on input line 3. \end{lstlisting} - \item 在简单模式(\lstinline{simple})下,需要 3 个参数来定义一个新的定理类环境,分别是: - 定理类环境名,定理类环境的标题,定理类环境的样式,该定理类环境的前缀: + \item 在简单模式(\lstinline{simple})下,需要 4 个参数来定义一个新的定理类环境,分别是: + 定理类环境名,定理类环境的标题,定理类环境的样式,该定理类环境的前缀,(可选)该定理类环境继承的定理类环境: \begin{lstlisting} % 导言区 \elegantnewtheorem{examplesimple}{自定义定理类环境}{thmstyle} @@ -582,7 +578,7 @@ Class elegantbook Warning: Because you didn't provide a prefix. 之前我们将文献调用的命令放在模板里面,然后用户反馈 \lstinline{\cite} 命令无法自动补全,因此我们新版本将其拿到外面来,新版本打印参考文献的命令的方法是,在导言区(也即 \lstinline|\begin{document}| 之前),加入: \begin{lstlisting} - \lstinline|\addbibresource[location=local]{reference.bib}|。 + \addbibresource[location=local]{reference.bib} \end{lstlisting} 然后再需要打印文献的地方使用: @@ -610,12 +606,15 @@ Class elegantbook Warning: Because you didn't provide a prefix. \documentclass[citestyle=gb7714-2015, bibstyle=gb7714-2015]{elegantbook} \end{lstlisting} -如果需要添加排序方式,可以在导言区加入下面命令: +在使用 \begin{lstlisting} - \ExecuteBibliographyOptions{sorting=ynt} + \documentclass[citestyle=gb7714-2015, bibstyle=gb7714-2015]{elegantbook} \end{lstlisting} - -如果使用的是国标,可以将 \lstinline{ynt} 改为 \lstinline{gb7714-2015},使文献按照国标规定进行文献排序。 +后,排序方式为按引用先后排序。如果不使用国标 GB7714-2015 并且需要添加排序方式,可以在导言区加入下面命令: +\begin{lstlisting} + \ExecuteBibliographyOptions{sorting=<name>} +\end{lstlisting} +其中 \lstinline{<name>} 可以是 nty, nyt, nyvt, anyt, anyvt, ynt, ydnt, none, count, debug 的其中之一,更多排序相关请参考 biblatex 宏包手册的 3.1.2.1 节。 \section{添加序章} @@ -896,8 +895,6 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 (2)若 $f(x,y)$ 是 $\mathcal{R}^p\times\mathcal{R}^q$ 上的可积函数,则对几乎处处的 $x\in\mathcal{R}^p$,$f(x,y)$ 作为 $y$ 的函数是 $\mathcal{R}^q$ 上的可积函数,并且 $g(x)=\int_{\mathcal{R}^q}f(x,y) dy$ 是 $\mathcal{R}^p$ 上的可积函数。而且~\eqref{eq:461} 成立。 \end{theorem} -\ref{thm:fubi} - \begin{note} 在本模板中,引理(lemma),推论(corollary)的样式和定理~\ref{thm:fubi} 的样式一致,包括颜色,仅仅只有计数器的设置不一样。 \end{note} @@ -927,7 +924,7 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 \end{property} \begin{conclusion} -回归分析(regression analysis) 是确定两种或两种以上变量间相互依赖的定量关系的一种统计分析方法。运用十分广泛,回归分析按照涉及的变量的多少,分为一元回归和多元回归分析;按照因变量的多少,可分为简单回归分析和多重回归分析;按照自变量和因变量之间的关系类型,可分为线性回归分析和非线性回归分析。 +回归分析(regression analysis) 是确定两种或两种以上变量间相互依赖的定量关系的一种统计分析方法。运用十分广泛,回归分析按照涉及的变量的多少,分为一元回归和多元回归分析;按照因变量的多少,可分为简单回归分析和多重回归分析;按照自变量和因变量之间的关系类型,可分为线性回归分析和非线性回归分析。 \end{conclusion} \begin{problemset} @@ -965,6 +962,14 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 根据用户的反馈,我们不断修正和完善模板。由于 3.00 之前版本与现在版本差异非常大,在此不列出 3.00 之前的更新内容。 +\datechange{2022/12/31}{版本 4.5} \textcolor{red}{\bfseries 停止维护!} + +\datechange{2022/08/17}{版本 4.5 pre} +\begin{change} + \item \textbf{重要改动}:提供了一个新的文档类选项 \lstinline|usesamecnt|,可以使全局的定理类环境使用同一个计数器。 + \item \textbf{重要改动}:修改了 \lstinline|\elegantnewtheorem| 命令,使其有第五个(可选)参数。 +\end{change} + \datechange{2022/08/15}{版本 4.4 正式发布。} \begin{change} @@ -973,7 +978,7 @@ Lebesgue 积分有几种不同的定义方式。我们将采用逐步定义非 \item \textbf{重要改动}:在 \lstinline{scheme=chinese} 下将目录中的“第 1 章”修改为“第一章”; \item 将 TeX Gyre Termes 改为 TeX Gyre TermesX,使英文部分字形与 newtx 系列宏包更相近; \item 重写了内置定理类环境的实现方法,修复了一些 bug,由于修改部分较大,如果引入了新的 bug,请及时在 QQ 群或 \href{https://github.com/ElegantLaTeX}{Github} 上进行反馈; - \item 删除 Gitee 仓库地址,恢复 GitHub 提交(pull requests); + \item 删除 Gitee 仓库地址,恢复 GitHub 提交(pull requests); \item 将参考文献命令添加到导言区,使编辑器能够对参考文献自动补全。 \end{change} diff --git a/macros/latex/contrib/elegantbook/elegantbook-en.pdf b/macros/latex/contrib/elegantbook/elegantbook-en.pdf Binary files differindex 42be810cd6..1c2fcfdeb5 100644 --- a/macros/latex/contrib/elegantbook/elegantbook-en.pdf +++ b/macros/latex/contrib/elegantbook/elegantbook-en.pdf diff --git a/macros/latex/contrib/elegantbook/elegantbook-en.tex b/macros/latex/contrib/elegantbook/elegantbook-en.tex index ee46a40015..c581abc9fe 100644 --- a/macros/latex/contrib/elegantbook/elegantbook-en.tex +++ b/macros/latex/contrib/elegantbook/elegantbook-en.tex @@ -3,13 +3,13 @@ \title{An Elegant \LaTeX{} Template for Books} \subtitle{Classic Elegant\LaTeX{} Template} -\author{Ethan Deng \& Liam Huang} +\author{Ethan Deng, Liam Huang, syvshc, sikouhjw \& Osbert Wang} \institute{Elegant\LaTeX{} Program} -\date{Aug 15, 2022} -\version{4.4} +\date{Dec. 31, 2022} +\version{4.5} \bioinfo{Bio}{Information} -\extrainfo{Victory won\rq t come to us unless we go to it. } +\extrainfo{\textcolor{red}{\bfseries Caution: This template will no longer be maintained since January 1st, 2023.}} \logo{logo-blue.png} \cover{cover.jpg} @@ -643,7 +643,7 @@ and expand the ones already used\index{keywords!used}. $R^2$ & 0.220 & 0.293 \\ \bottomrule \multicolumn{3}{l}{\scriptsize Standard errors in parentheses} \\ - \multicolumn{3}{l}{\scriptsize *** p<0.01, ** p<0.05, * p<0.1} \\ + \multicolumn{3}{l}{\scriptsize *** $p < 0.01$, ** $p<0.05$, * $p<0.1$} \\ \end{tabular}% \end{table}% @@ -692,6 +692,14 @@ We list some FAQs for users to refer to: We revised our templates now and then. This section shows the version story of ElegantBook. +\datechange{2022/12/31}{release of v4.5.} \textcolor{red}{\bfseries Stop Maintenance} + +\begin{change} + \item Add new document option \lstinline|usesamecnt| for same thm counter for all theme environments; + \item Add 5-th optional parameter for \lstinline|elegantnewtheorem|. +\end{change} + + \datechange{2022/08/15}{release of v4.4.} \begin{change} diff --git a/macros/latex/contrib/elegantbook/elegantbook.cls b/macros/latex/contrib/elegantbook/elegantbook.cls index 93f4dd9919..4fb3e3d93a 100644 --- a/macros/latex/contrib/elegantbook/elegantbook.cls +++ b/macros/latex/contrib/elegantbook/elegantbook.cls @@ -8,7 +8,7 @@ %%%%%%%%%%%%%%%%%%%%% % % !Mode:: "TeX:UTF-8" \NeedsTeXFormat{LaTeX2e} -\ProvidesClass{elegantbook}[2022/04/09 v4.3 ElegantBook document class] +\ProvidesClass{elegantbook}[2022/12/31 v4.5 ElegantBook document class] %%% @@ -16,7 +16,6 @@ \RequirePackage{etoolbox} \SetupKeyvalOptions{family=ELEGANT, prefix=ELEGANT@, setkeys=\kvsetkeys} \newcommand{\ekv}[1]{\kvsetkeys{ELEGANT}{#1}} - % ----- Colors ----- \DeclareStringOption[blue]{color} \DeclareStringOption[en]{lang} @@ -56,6 +55,7 @@ \DeclareVoidOption{fancy}{\ekv{mode=fancy}} \DeclareVoidOption{simple}{\ekv{mode=simple}} +\DeclareBoolOption[false]{usesamecnt} \DeclareVoidOption{answer}{\ekv{result=answer}} \DeclareVoidOption{noanswer}{\ekv{result=noanswer}} @@ -895,6 +895,19 @@ \RequirePackage[many]{tcolorbox} % \newlength{\normalparindent} % \setlength{\normalparindent}{\parindent} +\newcommand{\ELEGANT@tmp@tl}{} +\ifELEGANT@usesamecnt + \newcounter{ELEGANT@samecnt} + \counterwithin{ELEGANT@samecnt}{\ELEGANT@thmcnt} + \tcbset{ + new/usesamecnt/.style = {use counter = ELEGANT@samecnt} + } +\else + \tcbset{ + new/usesamecnt/.style = {} + } +\fi + \ifdefstring{\ELEGANT@mode}{fancy}{ \tcbset{ common/.style={ @@ -944,9 +957,16 @@ \textcolor{third}{$\spadesuit$}};}}, ELEGANT@title/.code n args={2} { - \ifblank{#2} - {\tcbset{title={\csname #1name\endcsname~\thetcbcounter}}} - {\tcbset{title={\csname #1name\endcsname~\thetcbcounter\ (#2)}}} + + \tcbset + { + title= + { + \csname #1name\endcsname~% + \ifdef{\thetcbcounter}{\thetcbcounter}{}% + \ifblank{#2}{}{\ (#2)} + } + } }, ELEGANT@label/.code n args={2} { @@ -962,14 +982,23 @@ % will define two environments: numbered ``theorem'' and no-numbered ``theorem*'' % WARNING FOR MULTILINGUAL: this cs will automatically find \theoremname's definition, % WARNING FOR MULTILINGUAL: it should be defined in language settings. - \newcommand{\ELEGANT@newtheorem}[3]{ + \NewDocumentCommand \ELEGANT@newtheorem { m m m O{} }{ \ifcsundef{#1name}{% \ClassError{elegantbook}{% \ #1name undefined, \MessageBreak Please check in language setting }{} }{\relax} - \DeclareTColorBox[auto counter,number within=\ELEGANT@thmcnt]{#1}{ g o t\label g }{ + \expandafter\ifblank\expandafter{#4}{ + \tcbset{ + new/usecnt/.style={} + } + }{ + \tcbset{ + new/usecnt/.style= {use counter from = #4} + } + } + \DeclareTColorBox[auto counter,number within=\ELEGANT@thmcnt,usesamecnt,usecnt]{#1}{ g o t\label g }{ common,#3, IfValueTF={##1} {ELEGANT@title={#1}{##1}} @@ -998,8 +1027,8 @@ } % define several environment % we define headers like \definitionname before - \ELEGANT@newtheorem{definition}{def}{defstyle} \ELEGANT@newtheorem{theorem}{thm}{thmstyle} + \ELEGANT@newtheorem{definition}{def}{defstyle} \ELEGANT@newtheorem{postulate}{pos}{thmstyle} \ELEGANT@newtheorem{axiom}{axi}{thmstyle} \ELEGANT@newtheorem{corollary}{cor}{thmstyle} @@ -1030,16 +1059,24 @@ % will define two environments: numbered ``theorem'' and no-numbered ``theorem*'' % WARNING FOR MULTILINGUAL: this cs will automatically find \theoremname's definition, % WARNING FOR MULTILINGUAL: it should be defined in language settings. - \newcommand{\ELEGANT@newtheorem}[2]{ + \NewDocumentCommand \ELEGANT@newtheorem { m m O{} } { \theoremstyle{#2} - \newtheorem{#1}{\csname #1name\endcsname}[\ELEGANT@thmcnt] + \ifELEGANT@usesamecnt + \newtheorem{#1}[ELEGANT@samecnt]{\csname #1name\endcsname} + \else + \ifblank{#3}{ + \newtheorem{#1}{\csname #1name\endcsname}[\ELEGANT@thmcnt] + }{ + \newtheorem{#1}[#3]{\csname #1name\endcsname} + } + \fi \newtheorem*{#1*}{\csname #1name\endcsname} } % define several environment % we define headers like \definitionname before - \ELEGANT@newtheorem{definition}{defstyle} \ELEGANT@newtheorem{theorem}{thmstyle} + \ELEGANT@newtheorem{definition}{defstyle} \ELEGANT@newtheorem{postulate}{thmstyle} \ELEGANT@newtheorem{axiom}{thmstyle} \ELEGANT@newtheorem{corollary}{thmstyle} @@ -1056,12 +1093,19 @@ % and a warning will be raised \newcommand{\ELEGANT@newtheorem@warning}{} \newcommand{\ELEGANT@newtheorem@error}{} -\NewDocumentCommand\elegantnewtheorem{ m m m g } +\newcommand{\ELEGANT@usesamecnt@warning}{} +\NewDocumentCommand\elegantnewtheorem{ m m m g O{} } { + \renewcommand{\ELEGANT@usesamecnt@warning}{ + \ClassWarning{elegantbook}{% + [#5] won't make sence with option \MessageBreak + `usesamecnt'. + } + } \renewcommand{\ELEGANT@newtheorem@warning}{ \ClassWarning{elegantbook}{% - Because you didn't provide a prefix. \MessageBreak - We use #1 as the default prefix. \MessageBreak + Because you didn't provide a prefix, \MessageBreak + we use #1 as the default prefix. \MessageBreak You have to use \MessageBreak \ref{#1:label} to refer a \MessageBreak \begin{#1}{name}{label} environment. \MessageBreak @@ -1078,11 +1122,16 @@ The 4th parameter ``prefix'' isn't allowed. } } + \ifELEGANT@usesamecnt + \ifblank{#5}{}{\ELEGANT@usesamecnt@warning} + \else + \renewcommand{\ELEGANT@tmp@tl}{#5} + \fi \expandafter\def\csname #1name\endcsname{#2} \ifdefstring{\ELEGANT@mode}{simple}{% \IfValueTF{#4} {\ELEGANT@newtheorem@error} - {\ELEGANT@newtheorem{#1}{#3}} + {\ELEGANT@newtheorem{#1}{#3}[\ELEGANT@tmp@tl]} }{\relax} \ifdefstring{\ELEGANT@mode}{fancy}{% \IfValueTF{#4} @@ -1090,13 +1139,13 @@ \def\ELEGANT@temp@prefix{#4} \ifdefempty{\ELEGANT@temp@prefix} { - \ELEGANT@newtheorem{#1}{#1}{#3} + \ELEGANT@newtheorem{#1}{#1}{#3}[\ELEGANT@tmp@tl] \ELEGANT@newtheorem@warning } - {\ELEGANT@newtheorem{#1}{#4}{#3}} + {\ELEGANT@newtheorem{#1}{#4}{#3}[\ELEGANT@tmp@tl]} } { - \ELEGANT@newtheorem{#1}{#1}{#3} + \ELEGANT@newtheorem{#1}{#1}{#3}[\ELEGANT@tmp@tl] \ELEGANT@newtheorem@warning } }{\relax} @@ -1321,9 +1370,9 @@ breaklines=true, keywordstyle=\color{winered}, commentstyle=\color{gray}, - emph={elegantpaper,fontenc,fontspec,xeCJK,citestyle,FiraMono,xunicode,figure,fig,image,img,table,itemize,enumerate,ctex,microtype,description,times,booktabs,tabular,PDFLaTeX,XeLaTeX,type1cm,BibTeX,device,color,mode,lang,amsthm,tcolorbox,titlestyle,cite,ctex,listings,base,math,scheme,toc,esint,chinesefont,amsmath,bibstyle,natbib,pgfornament}, + emph={elegantpaper,fontenc,fontspec,xeCJK,citestyle,FiraMono,xunicode,figure,fig,image,img,table,itemize,enumerate,ctex,microtype,description,times,booktabs,tabular,PDFLaTeX,XeLaTeX,type1cm,BibTeX,device,color,mode,lang,amsthm,tcolorbox,titlestyle,cite,ctex,listings,base,math,scheme,toc,esint,chinesefont,amsmath,bibstyle,natbib,pgfornament,addbibresource,printbibliography}, emphstyle={\color{frenchplum}}, - morekeywords={DeclareSymbolFont,SetSymbolFont,toprule,midrule,bottomrule,institute,version,includegraphics,setmainfont,setsansfont,setmonofont ,setCJKmainfont,setCJKsansfont,setCJKmonofont,RequirePackage,figref,tabref,email,maketitle,keywords,definecolor,extrainfo,logo,cover,subtitle,appendix,chapter,section,hypersetup,mainmatter,frontmatter,tableofcontents,elegantpar,heiti,kaishu,lstset,pagecolor,zhnumber,marginpar,part,equote,marginnote,bioinfo,datechange,listofchange,lvert,lastpage,songti,heiti,fangsong,setCJKfamilyfont,textbf,elegantnewtheorem,thmcnt,colorlet}, + morekeywords={DeclareSymbolFont,SetSymbolFont,toprule,midrule,bottomrule,institute,version,includegraphics,setmainfont,setsansfont,setmonofont ,setCJKmainfont,setCJKsansfont,setCJKmonofont,RequirePackage,figref,tabref,email,maketitle,keywords,definecolor,extrainfo,logo,cover,subtitle,appendix,chapter,section,hypersetup,mainmatter,frontmatter,tableofcontents,elegantpar,heiti,kaishu,lstset,pagecolor,zhnumber,marginpar,part,equote,marginnote,bioinfo,datechange,listofchange,lvert,lastpage,songti,heiti,fangsong,setCJKfamilyfont,textbf,elegantnewtheorem,thmcnt,colorlet,usesamecnt}, frame=single, tabsize=2, rulecolor=\color{structurecolor}, @@ -1387,7 +1436,7 @@ \renewcommand*{\cleardoublepage}{\clearpage\if@twoside \ifodd\c@page\else \hbox{}% \thispagestyle{empty}% -beforechap\newpage% +\newpage% \if@twocolumn\hbox{}\newpage\fi\fi\fi} @@ -1397,7 +1446,10 @@ beforechap\newpage% \ifdefstring{\ELEGANT@lang}{cn}{ % \renewcommand{\cftchappresnum}{\beforechap\space} % \renewcommand{\cftchapaftersnum}{\space\afterchap} - \setlength{\cftchapnumwidth}{\widthof{\textbf{附录~999}}} + % \setlength{\cftchapnumwidth}{\widthof{\textbf{附录~十一}}} + \renewcommand{\numberline}[1]{% + \@cftbsnum #1\@cftasnum~\@cftasnumb ~% + } \g@addto@macro\appendix{% % recover \thechapter in the \NR@chapter's \numberline \ifELEGANT@Hy@later diff --git a/macros/latex/contrib/elegantbook/image/donate.jpg b/macros/latex/contrib/elegantbook/image/donate.jpg Binary files differdeleted file mode 100644 index 60741efcde..0000000000 --- a/macros/latex/contrib/elegantbook/image/donate.jpg +++ /dev/null diff --git a/macros/latex/contrib/elegantnote/README.md b/macros/latex/contrib/elegantnote/README.md index fafe84ce6c..aa93fc8eb2 100644 --- a/macros/latex/contrib/elegantnote/README.md +++ b/macros/latex/contrib/elegantnote/README.md @@ -14,6 +14,11 @@ ElegantNote is designed for Notes. Just enjoy it! If you have any questions, sug 设计 ElegantNote 是为了方便记录笔记和阅读笔记。如果你有其他问题、建议或者报告 bug,可以提交 issues 或者给我们发邮件:elegantlatex2e@gmail.com。最近我们新建了一个 QQ 用户交流群(Q 群:692108391),欢迎加入。 + +**Caution: This template will no longer be maintained since January 1st, 2023.** + +**注意:本模板自 2023 年 1 月 1 日开始,不再维护,不建议使用本系列模板!** + # License This work is released under the LaTeX Project Public License, v1.3c or later. diff --git a/macros/latex/contrib/elegantnote/elegantnote-cn.pdf b/macros/latex/contrib/elegantnote/elegantnote-cn.pdf Binary files differindex 0270e665ce..8bf2257791 100644 --- a/macros/latex/contrib/elegantnote/elegantnote-cn.pdf +++ b/macros/latex/contrib/elegantnote/elegantnote-cn.pdf diff --git a/macros/latex/contrib/elegantnote/elegantnote-cn.tex b/macros/latex/contrib/elegantnote/elegantnote-cn.tex index e36b203605..92f891971c 100644 --- a/macros/latex/contrib/elegantnote/elegantnote-cn.tex +++ b/macros/latex/contrib/elegantnote/elegantnote-cn.tex @@ -2,11 +2,11 @@ \documentclass[cn,hazy,blue,14pt,screen]{elegantnote} \title{ElegantNote:一个优美的 \LaTeX{} 笔记模板} -\author{邓东升} +\author{作者} \institute{Elegant\LaTeX{} Program} -\version{2.40} -\date{\zhtoday} +\version{2.50} +\date{\zhdate{2022/12/31}} \usepackage{array} @@ -20,6 +20,8 @@ \section{ElegantNote 使用说明} +\textbf{\textcolor{red}{本模板自 2023 年 1 月 1 日开始,不再维护,不建议使用本系列模板!为了保证之前版本的用户仍然能查到说明文档,本说明文档仍然保留过去的信息。}} + 新版 ElegantNote 是基于标准的 \LaTeX{} 文类 article 重新设计的,格式更加简化的笔记模板!本模板支持两种编译方式,\hologo{pdfLaTeX} 和 \hologo{XeLaTeX},英文模式下请使用 \hologo{pdfLaTeX} 进行编译,中文模式下务必使用 \hologo{XeLaTeX}。 新模板有下面几个特性: @@ -231,7 +233,7 @@ Let $z$ be some element of $xH \cap yH$. Then $z = xa$ for some $a \in H$, and \section{致谢} -特别感谢 \href{https://github.com/sikouhjw}{sikouhjw} 和 \href{https://github.com/syvshc}{syvshc} 长期以来对于 Github 上 issue 的快速回应,以及各个社区论坛对于 ElegantLaTeX 相关问题的回复。特别感谢 ChinaTeX 以及 \href{http://www.latexstudio.net/}{LaTeX 工作室} 对于本系列模板的大力宣传与推广。 +特别感谢 \href{https://github.com/sikouhjw}{sikouhjw} 和 \href{https://github.com/syvshc}{syvshc} 长期以来对于 Github 上 issue 的快速回应,以及各个社区论坛对于 Elegant\LaTeX{} 相关问题的回复。特别感谢 China\TeX{} 以及 \href{http://www.latexstudio.net/}{\LaTeX{} 工作室} 对于本系列模板的宣传与推广。 如果你喜欢我们的模板,你可以在 Github 上收藏我们的模板。 diff --git a/macros/latex/contrib/elegantnote/elegantnote-en.pdf b/macros/latex/contrib/elegantnote/elegantnote-en.pdf Binary files differindex 271eeeeecf..7f5f18c5f4 100644 --- a/macros/latex/contrib/elegantnote/elegantnote-en.pdf +++ b/macros/latex/contrib/elegantnote/elegantnote-en.pdf diff --git a/macros/latex/contrib/elegantnote/elegantnote-en.tex b/macros/latex/contrib/elegantnote/elegantnote-en.tex index 3da57d2b29..8b61d99b15 100644 --- a/macros/latex/contrib/elegantnote/elegantnote-en.tex +++ b/macros/latex/contrib/elegantnote/elegantnote-en.tex @@ -1,12 +1,12 @@ -\documentclass[en,hazy,screen,blue,14pt]{elegantnote} +\documentclass[en,hazy,blue,screen,14pt]{elegantnote} \title{ElegantNote: An Elegant \LaTeX{} Template for Notes} -\author{Dongsheng Deng} +\author{Author} \institute{Elegant\LaTeX{} Program} -\version{2.40} -\date{\today} +\version{2.50} +\date{Dec. 31, 2022} \begin{document} \maketitle @@ -15,8 +15,12 @@ \section{ElegantNote Instructions} \thispagestyle{empty} +\textcolor{red}{\bfseries Caution: This template will no longer be maintained since January 1st, 2023.} + + The brand new ElegantNote is redesigned on the basis of \LaTeX{} article, a more elegant note template! You can use either \hologo{pdfLaTeX} or \hologo{XeLaTeX} to compile. It is recommended that \hologo{pdfLaTeX} be used for notes in English while \hologo{XeLaTeX} be used for notes in Chinese. + The new template has the following features: \begin{itemize} \item two modes: good for eye mode (geye) and hazy mode; @@ -188,7 +192,7 @@ Let's continue using our application training example. In this case, we'd want t $R^2$ & 0.220 & 0.293 \\ \bottomrule \multicolumn{3}{l}{\scriptsize Standard errors in parentheses} \\ - \multicolumn{3}{l}{\scriptsize *** p<0.01, ** p<0.05, * p<0.1} \\ + \multicolumn{3}{l}{\scriptsize *** $p<0.01$, ** $p<0.05$, * $p<0.1$} \\ \end{tabular}% \end{table}% @@ -206,7 +210,7 @@ Let's continue using our application training example. In this case, we'd want t \section{Acknowledgement} -Thank \href{https://github.com/sikouhjw}{sikouhjw} and \href{https://github.com/syvshc}{syvshc} for their quick response to Github issues and continuously support work for ElegantLaTeX. Thank ChinaTeX and \href{http://www.latexstudio.net/}{LaTeX Studio} for their promotion. +Thank \href{https://github.com/sikouhjw}{sikouhjw} and \href{https://github.com/syvshc}{syvshc} for their quick response to Github issues and continuously support work for Elegant\LaTeX{}. Thank China\TeX{} and \href{http://www.latexstudio.net/}{LaTeX Studio} for their promotion. \section{FAQ} diff --git a/macros/latex/contrib/elegantnote/elegantnote.cls b/macros/latex/contrib/elegantnote/elegantnote.cls index 872e4ff188..4dc70b15d4 100644 --- a/macros/latex/contrib/elegantnote/elegantnote.cls +++ b/macros/latex/contrib/elegantnote/elegantnote.cls @@ -4,7 +4,7 @@ % Lastest Version: https://github.com/ElegantLaTeX/ElegantNote % --- Class structure: identification part -\ProvidesClass{elegantnote}[2022/04/09 ElegantNote v2.40 class] +\ProvidesClass{elegantnote}[2022/12/31 ElegantNote v2.50 class] \NeedsTeXFormat{LaTeX2e} @@ -165,7 +165,7 @@ backend=\ELEGANT@bibend, citestyle=\ELEGANT@citestyle, bibstyle=\ELEGANT@bibstyle]{biblatex} -\defbibheading{elegantbook}[\ebibname]{#1} + \RequirePackage{appendix} diff --git a/macros/latex/contrib/elegantpaper/README.md b/macros/latex/contrib/elegantpaper/README.md index c3a0fb2ce8..75e2f84320 100644 --- a/macros/latex/contrib/elegantpaper/README.md +++ b/macros/latex/contrib/elegantpaper/README.md @@ -10,7 +10,9 @@ ![Github Version](https://img.shields.io/github/release/ElegantLaTeX/ElegantPaper.svg) ![Repo Size](https://img.shields.io/github/repo-size/ElegantLaTeX/ElegantPaper.svg) +**Caution: This template will no longer be maintained since January 1st, 2023.** +**注意:本模板自 2023 年 1 月 1 日开始,不再维护,不建议使用本系列模板!** ElegantPaper is designed for writing a working paper, especially for economics students. This template is based on the standard LaTeX article class. The goal of this template is to make the writing process easier and more comfortable. You can get rid of all the worries about the format. Just enjoy it! If you have any questions, suggestions or bug reports, you can create issues or email us at elegantlatex2e@gmail.com. diff --git a/macros/latex/contrib/elegantpaper/elegantpaper-cn.pdf b/macros/latex/contrib/elegantpaper/elegantpaper-cn.pdf Binary files differindex 3a33a72b39..9eed5768e2 100644 --- a/macros/latex/contrib/elegantpaper/elegantpaper-cn.pdf +++ b/macros/latex/contrib/elegantpaper/elegantpaper-cn.pdf diff --git a/macros/latex/contrib/elegantpaper/elegantpaper-cn.tex b/macros/latex/contrib/elegantpaper/elegantpaper-cn.tex index c858cf7a24..feb0beba62 100644 --- a/macros/latex/contrib/elegantpaper/elegantpaper-cn.tex +++ b/macros/latex/contrib/elegantpaper/elegantpaper-cn.tex @@ -1,18 +1,18 @@ %!TEX program = xelatex % 完整编译: xelatex -> biber/bibtex -> xelatex -> xelatex -\documentclass[lang=cn,11pt,a4paper]{elegantpaper} +\documentclass[lang=cn,a4paper,newtx]{elegantpaper} \title{ElegantPaper: 一个优美的 \LaTeX{} 工作论文模板} -\author{Ethan DENG \\ Fudan University \and Dongsheng DENG \\ PA Technology} +\author{作者1 \\ 某某大学/机构 \and 作者2 \\ 某某大学/机构} \institute{\href{https://elegantlatex.org/}{Elegant\LaTeX{} 项目组}} -\version{0.10} -\date{\zhtoday} - +\version{0.11} +\date{\zhdate{2022/12/31}} % 本文档命令 \usepackage{array} \newcommand{\ccr}[1]{\makecell{{\color{#1}\rule{1cm}{1cm}}}} +\addbibresource[location=local]{reference.bib} % 参考文献,不要删除 \begin{document} @@ -23,16 +23,14 @@ \keywords{Elegant\LaTeX{},工作论文,模板} \end{abstract} - \section{模板使用须知} -\subsection{注意事项} +\textcolor{red}{\bfseries 本模板自 2023 年 1 月 1 日开始,不再维护,不建议使用本系列模板!为了保证之前版本的用户仍然能查到说明文档,本说明文档仍然保留过去的信息。} -时隔两年,本模板迎来更新,中间发生了很多变化,两个主要变化是参考文献与字体设定,\textbf{使用前请务必仔细阅读本文档}。 - -\textbf{文献部分}:我们将 bibtex 的默认文献编译方式改为 biblatex,不过我们也提供了两个后端,\lstinline{bibend=biber} 和 \lstinline{bibend=bibtex}。特别需要注意的是,从 0.10 开始,文献文件改为 \lstinline{reference.bib},与 ElegantBook 保持一致,而参考文献的引文样式等更多格式,请参考后文参考文献部分,更多样式可以参考 biblatex 文档。 +\subsection{注意事项} +\textbf{文献部分}:我们将 bibtex 的默认文献编译方式改为 biblatex,不过我们也提供了两个后端,\lstinline{bibend=biber} 和 \lstinline{bibend=bibtex}。特别需要注意的是从 0.10 开始,文献文件改为 \lstinline{reference.bib},与 ElegantBook 保持一致,而参考文献的引文样式等更多格式,请参考后文参考文献部分,更多样式可以参考 biblatex 文档。 -\textbf{字体部分},我们将 newtxtext 宏包的支持方式改为了字体名称设定方式,设定英文字体为 TeX Gyre Terms/Heros,,英文字体部分,根据编译方式选择不同字体。对于一般用户而言,不太需要关心这部分内容。 +\textbf{字体部分},我们将 newtxtext 宏包的支持方式改为了字体名称设定方式,设定英文字体为 TeX Gyre Terms/Heros,英文字体部分,根据编译方式选择不同字体。对于一般用户而言,不太需要关心这部分内容。 另外,中文请务必使用 \hologo{XeLaTeX} 编译。 @@ -51,7 +49,7 @@ 此模板定义了一个语言选项 \lstinline{lang},可以选择英文模式 \lstinline{lang=en}(默认)或者中文模式 \lstinline{lang=cn}。当选择中文模式时,图表的标题引导词以及参考文献,定理引导词等信息会变成中文。你可以通过下面两种方式来选择语言模式: \begin{lstlisting} \documentclass[lang=cn]{elegantpaper} % or -\documentclass{cn}{elegantpaper} +\documentclass[cn]{elegantpaper} \end{lstlisting} \textbf{注意:} 英文模式下,由于没有添加中文宏包,无法输入中文。如果需要输入中文,可以通过在导言区引入中文宏包 \lstinline{ctex} 或者加入 \lstinline{xeCJK} 宏包后自行设置字体。 @@ -104,9 +102,9 @@ \subsection{自定义命令} -此模板并没有修改任何默认的 \LaTeX{} 命令或者环境\footnote{目的是保证代码的可复用性,请用户关注内容,不要太在意格式,这才是本工作论文模板的意义。}。另外,我自定义了 4 个命令: +此模板并没有修改任何默认的 \LaTeX{} 命令或者环境\footnote{目的是保证代码的可复用性,请用户关注内容,不要太在意格式,这才是本工作论文模板的意义。}。另外,本模板可以使用的 4 个额外命令: \begin{enumerate} - \item \lstinline{\email}:创建邮箱地址的链接,比如 \email{ddswhu@outlook.com}; + \item \lstinline{\email}:创建邮箱地址的链接,比如 \email{xxx@outlook.com}; \item \lstinline{\figref}:用法和 \lstinline{\ref} 类似,但是会在插图的标题前添加 <\textbf{图 n}> ; \item \lstinline{\tabref}:用法和 \lstinline{\ref} 类似,但是会在表格的标题前添加 <\textbf{表 n}>; \item \lstinline{\keywords}:为摘要环境添加关键词。 diff --git a/macros/latex/contrib/elegantpaper/elegantpaper-en.pdf b/macros/latex/contrib/elegantpaper/elegantpaper-en.pdf Binary files differindex 6da08d7325..89d191200f 100644 --- a/macros/latex/contrib/elegantpaper/elegantpaper-en.pdf +++ b/macros/latex/contrib/elegantpaper/elegantpaper-en.pdf diff --git a/macros/latex/contrib/elegantpaper/elegantpaper-en.tex b/macros/latex/contrib/elegantpaper/elegantpaper-en.tex index 73499dc51b..7126f03870 100644 --- a/macros/latex/contrib/elegantpaper/elegantpaper-en.tex +++ b/macros/latex/contrib/elegantpaper/elegantpaper-en.tex @@ -3,16 +3,17 @@ \documentclass[11pt,en]{elegantpaper} \title{ElegantPaper: An Elegant \LaTeX{} Template for Working Papers} -\author{Ethan DENG \\ Fudan University \and Dongsheng DENG \\ PA Technology} +\author{Author1 \\ Institute1 \and Author2 \\ Institute2} \institute{\href{https://github.com/ElegantLaTeX}{Elegant\LaTeX{} Program}} -\version{0.10} -\date{\today} +\version{0.11} +\date{Dec. 31, 2022} % cmd for this doc \usepackage{array} \newcommand{\ccr}[1]{\makecell{{\color{#1}\rule{1cm}{1cm}}}} +\addbibresource[location=local]{reference.bib} % reference file \begin{document} \maketitle @@ -22,6 +23,7 @@ This documentation illustrates the usage of the \href{https://github.com/Elegant \keywords{Elegant\LaTeX{}, Working Paper, Template} \end{abstract} +\textcolor{red}{\bfseries Caution: This template will no longer be maintained since January 1st, 2023.} \section*{Update Notes} @@ -44,7 +46,7 @@ This template is based on the standard \LaTeX{} article class, hence the argumen Language mode option \lstinline{lang} allows two alternative inputs, \lstinline{lang=en} (default) for English or \lstinline{lang=cn} for Chinese. \lstinline{lang=cn} will make the caption of figure/table, abstract name, refname etc. Chinese. You can use this option as \begin{lstlisting} \documentclass[lang=cn]{elegantpaper} % or -\documentclass{cn}{elegantpaper} +\documentclass[cn]{elegantpaper} \end{lstlisting} \textbf{Note:} Under the English mode \lstinline{lang=en}, Chinese characters are not allowed. To type in Chinese, please load \lstinline{ctex} or \lstinline{xeCJK} package at the preamble as: \begin{lstlisting} diff --git a/macros/latex/contrib/elegantpaper/elegantpaper.cls b/macros/latex/contrib/elegantpaper/elegantpaper.cls index 4b4a2a34d9..ca6a74f313 100644 --- a/macros/latex/contrib/elegantpaper/elegantpaper.cls +++ b/macros/latex/contrib/elegantpaper/elegantpaper.cls @@ -4,7 +4,7 @@ % Lastest Version: https://github.com/ElegantLaTeX/ElegantPaper % --- Class structure: identification part -\ProvidesClass{elegantpaper}[2022/04/09 v0.10 ElegantLaTeX Paper class] +\ProvidesClass{elegantpaper}[2022/12/31 v0.11 ElegantLaTeX Paper class] \NeedsTeXFormat{LaTeX2e} %%% @@ -197,7 +197,6 @@ backend=\ELEGANT@bibend, citestyle=\ELEGANT@citestyle, bibstyle=\ELEGANT@bibstyle]{biblatex} -\defbibheading{elegantbook}[\ebibname]{#1} \RequirePackage{appendix} @@ -366,7 +365,7 @@ backgroundcolor=\color{lightgrey} } -\addbibresource[location=local]{reference.bib} + % restore the tt default family to lmodern tt family \renewcommand\ttdefault{lmtt} diff --git a/macros/latex/contrib/gfdl/COPYING b/macros/latex/contrib/gfdl/COPYING new file mode 100644 index 0000000000..f288702d2f --- /dev/null +++ b/macros/latex/contrib/gfdl/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/macros/latex/contrib/gfdl/README.txt b/macros/latex/contrib/gfdl/README.txt new file mode 100644 index 0000000000..8c0a103b19 --- /dev/null +++ b/macros/latex/contrib/gfdl/README.txt @@ -0,0 +1,8 @@ +------------------------------------------------------------- +Package: gfdl +Version: v0.1 (January 1, 2023) +Author: निरंजन +Description: For using GFDL in LaTeX. +Repository: https://puszcza.gnu.org.ua/projects/gfdl-tex +License: GPLv3+, GFDLv1.3+ +------------------------------------------------------------- diff --git a/macros/latex/contrib/gfdl/gfdl-tex-1p1.tex b/macros/latex/contrib/gfdl/gfdl-tex-1p1.tex new file mode 100644 index 0000000000..447adbe850 --- /dev/null +++ b/macros/latex/contrib/gfdl/gfdl-tex-1p1.tex @@ -0,0 +1,475 @@ +% --------------------------------------------------------- +% LaTeX-Source for printing GFDL v1.1 +% Copyright © 2022, 2023 निरंजन +% +% This program is free software: you can redistribute it +% and/or modify it under the terms of the GNU General Public +% License as published by the Free Software Foundation, +% either version 3 of the License, or (at your option) any +% later version. +% +% This program is distributed in the hope that it will be +% useful, but WITHOUT ANY WARRANTY; without even the implied +% warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR +% PURPOSE. See the GNU General Public License for more +% details. +% +% You should have received a copy of the GNU General Public +% License along with this program. If not, see +% <https://www.gnu.org/licenses/>. +% --------------------------------------------------------- +\begin{center} + \textbf{\LARGE GNU Free Documentation License} + + \bigskip + + Version 1.1, March 2000 + + Copyright \copyright\ 2000 Free Software Foundation, Inc. + + \bigskip + + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + Everyone is permitted to copy and distribute verbatim + copies of this license document, but changing it is not + allowed. + + \bigskip + + \textbf{\Large Preamble} +\end{center} + +The purpose of this License is to make a manual, textbook, +or other written document \enquote{free} in the sense of +freedom: to assure everyone the effective freedom to copy +and redistribute it, with or without modifying it, either +commercially or noncommercially. Secondarily, this License +preserves for the author and publisher a way to get credit +for their work, while not being considered responsible for +modifications made by others. + +This License is a kind of \enquote{copyleft}, which means +that derivative works of the document must themselves be +free in the same sense. It complements the GNU General +Public License, which is a copyleft license designed for +free software. + +We have designed this License in order to use it for manuals +for free software, because free software needs free +documentation: a free program should come with manuals +providing the same freedoms that the software does. But this +License is not limited to software manuals; it can be used +for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this +License principally for works whose purpose is instruction +or reference. + +\medskip +\begin{center} + \textbf{\Large Applicability and Definitions} +\end{center} + +\noindent +This License applies to any manual or other work that +contains a notice placed by the copyright holder saying it +can be distributed under the terms of this License. The +\enquote{Document}, below, refers to any such manual or +work. Any member of the public is a licensee, and is +addressed as \enquote{you}. + +A \enquote{Modified Version} of the Document means any work +containing the Document or a portion of it, either copied +verbatim, or with modifications and/or translated into +another language. + +A \enquote{Secondary Section} is a named appendix or a +front-matter section of the Document that deals exclusively +with the relationship of the publishers or authors of the +Document to the Document's overall subject (or to related +matters) and contains nothing that could fall directly +within that overall subject. (For example, if the Document +is in part a textbook of mathematics, a Secondary Section +may not explain any mathematics.) The relationship could be +a matter of historical connection with the subject or with +related matters, or of legal, commercial, philosophical, +ethical or political position regarding them. + +The \enquote{Invariant Sections} are certain Secondary +Sections whose titles are designated, as being those of +Invariant Sections, in the notice that says that the +Document is released under this License. + +The \enquote{Cover Texts} are certain short passages of text +that are listed, as Front-Cover Texts or Back-Cover Texts, +in the notice that says that the Document is released under +this License. + +A \enquote{Transparent} copy of the Document means a +machine-readable copy, represented in a format whose +specification is available to the general public, whose +contents can be viewed and edited directly and +straightforwardly with generic text editors or (for images +composed of pixels) generic paint programs or (for drawings) +some widely available drawing editor, and that is suitable +for input to text formatters or for automatic translation to +a variety of formats suitable for input to text formatters. +A copy made in an otherwise Transparent file format whose +markup has been designed to thwart or discourage subsequent +modification by readers is not Transparent. A copy that is +not \enquote{Transparent} is called \enquote{Opaque}. + +Examples of suitable formats for Transparent copies include +plain ASCII without markup, Texinfo input format, +\LaTeX~input format, SGML or XML using a publicly available +DTD, and standard-conforming simple HTML designed for human +modification. Opaque formats include PostScript, PDF, +proprietary formats that can be read and edited only by +proprietary word processors, SGML or XML for which the DTD +and/or processing tools are not generally available, and the +machine-generated HTML produced by some word processors for +output purposes only. + +The \enquote{Title Page} means, for a printed book, the +title page itself, plus such following pages as are needed +to hold, legibly, the material this License requires to +appear in the title page. For works in formats which do not +have any title page as such, \enquote{Title Page} means the +text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +\medskip +\begin{center} + \textbf{\Large Verbatim Copying} +\end{center} + +\noindent +You may copy and distribute the Document in any medium, +either commercially or noncommercially, provided that this +License, the copyright notices, and the license notice +saying this License applies to the Document are reproduced +in all copies, and that you add no other conditions +whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or +further copying of the copies you make or distribute. +However, you may accept compensation in exchange for copies. +If you distribute a large enough number of copies you must +also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated +above, and you may publicly display copies. + +\medskip +\begin{center} + \textbf{\Large Copying in Quantity} +\end{center} + +\noindent +If you publish printed copies of the Document numbering more +than 100, and the Document's license notice requires Cover +Texts, you must enclose the copies in covers that carry, +clearly and legibly, all these Cover Texts: Front-Cover +Texts on the front cover, and Back-Cover Texts on the back +cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must +present the full title with all words of the title equally +prominent and visible. You may add other material on the +covers in addition. Copying with changes limited to the +covers, as long as they preserve the title of the Document +and satisfy these conditions, can be treated as verbatim +copying in other respects. + +If the required texts for either cover are too voluminous to +fit legibly, you should put the first ones listed (as many +as fit reasonably) on the actual cover, and continue the +rest onto adjacent pages. + +If you publish or distribute Opaque copies of the Document +numbering more than 100, you must either include a +machine-readable Transparent copy along with each Opaque +copy, or state in or with each Opaque copy a +publicly-accessible computer-network location containing a +complete Transparent copy of the Document, free of added +material, which the general network-using public has access +to download anonymously at no charge using public-standard +network protocols. If you use the latter option, you must +take reasonably prudent steps, when you begin distribution +of Opaque copies in quantity, to ensure that this +Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you +distribute an Opaque copy (directly or through your agents +or retailers) of that edition to the public. + +It is requested, but not required, that you contact the +authors of the Document well before redistributing any large +number of copies, to give them a chance to provide you with +an updated version of the Document. + +\medskip +\begin{center} + \textbf{\Large Modifications} +\end{center} + +\noindent +You may copy and distribute a Modified Version of the +Document under the conditions of sections 2 and 3 above, +provided that you release the Modified Version under +precisely this License, with the Modified Version filling +the role of the Document, thus licensing distribution and +modification of the Modified Version to whoever possesses a +copy of it. In addition, you must do these things in the +Modified Version: + +\begin{itemize} +\item Use in the Title Page (and on the covers, if any) a + title distinct from that of the Document, and from those + of previous versions (which should, if there were any, be + listed in the History section of the Document). You may + use the same title as a previous version if the original + publisher of that version gives permission. +\item List on the Title Page, as authors, one or more + persons or entities responsible for authorship of the + modifications in the Modified Version, together with at + least five of the principal authors of the Document (all + of its principal authors, if it has less than five). +\item State on the Title page the name of the publisher of + the Modified Version, as the publisher. +\item Preserve all the copyright notices of the Document. +\item Add an appropriate copyright notice for your + modifications adjacent to the other copyright notices. +\item Include, immediately after the copyright notices, a + license notice giving the public permission to use the + Modified Version under the terms of this License, in the + form shown in the Addendum below. +\item Preserve in that license notice the full lists of + Invariant Sections and required Cover Texts given in the + Document's license notice. +\item Include an unaltered copy of this License. +\item Preserve the section entitled \enquote{History}, and + its title, and add to it an item stating at least the + title, year, new authors, and publisher of the Modified + Version as given on the Title Page. If there is no section + entitled \enquote{History} in the Document, create one + stating the title, year, authors, and publisher of the + Document as given on its Title Page, then add an item + describing the Modified Version as stated in the previous + sentence. +\item Preserve the network location, if any, given in the + Document for public access to a Transparent copy of the + Document, and likewise the network locations given in the + Document for previous versions it was based on. These may + be placed in the \enquote{History} section. You may omit a + network location for a work that was published at least + four years before the Document itself, or if the original + publisher of the version it refers to gives permission. +\item In any section entitled \enquote{Acknowledgements} or + \enquote{Dedications}, preserve the section's title, and + preserve in the section all the substance and tone of each + of the contributor acknowledgements and/or dedications + given therein. +\item Preserve all the Invariant Sections of the Document, + unaltered in their text and in their titles. Section + numbers or the equivalent are not considered part of the + section titles. +\item Delete any section entitled \enquote{Endorsements}. + Such a section may not be included in the Modified + Version. +\item Do not retitle any existing section as + \enquote{Endorsements} or to conflict in title with any + Invariant Section. +\end{itemize} + +If the Modified Version includes new front-matter sections +or appendices that qualify as Secondary Sections and contain +no material copied from the Document, you may at your option +designate some or all of these sections as invariant. To do +this, add their titles to the list of Invariant Sections in +the Modified Version's license notice. These titles must be +distinct from any other section titles. + +You may add a section entitled \enquote{Endorsements}, +provided it contains nothing but endorsements of your +Modified Version by various parties--for example, statements +of peer review or that the text has been approved by an +organization as the authoritative definition of a standard. + +You may add a passage of up to five words as a Front-Cover +Text, and a passage of up to 25 words as a Back-Cover Text, +to the end of the list of Cover Texts in the Modified +Version. Only one passage of Front-Cover Text and one of +Back-Cover Text may be added by (or through arrangements +made by) any one entity. If the Document already includes a +cover text for the same cover, previously added by you or by +arrangement made by the same entity you are acting on behalf +of, you may not add another; but you may replace the old +one, on explicit permission from the previous publisher that +added the old one. + +The author(s) and publisher(s) of the Document do not by +this License give permission to use their names for +publicity for or to assert or imply endorsement of any +Modified Version. + +\begin{center} + \textbf{\Large Combining Documents} +\end{center} + +You may combine the Document with other documents released +under this License, under the terms defined in section 4 +above for modified versions, provided that you include in +the combination all of the Invariant Sections of all of the +original documents, unmodified, and list them all as +Invariant Sections of your combined work in its license +notice. + +The combined work need only contain one copy of this +License, and multiple identical Invariant Sections may be +replaced with a single copy. If there are multiple Invariant +Sections with the same name but different contents, make the +title of each such section unique by adding at the end of +it, in parentheses, the name of the original author or +publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list +of Invariant Sections in the license notice of the combined +work. + +In the combination, you must combine any sections entitled +\enquote{History} in the various original documents, forming +one section entitled \enquote{History}; likewise combine any +sections entitled \enquote{Acknowledgements}, and any +sections entitled \enquote{Dedications}. You must delete all +sections entitled \enquote{Endorsements}. + +\begin{center} + \textbf{\Large Collections of Documents} +\end{center} + +You may make a collection consisting of the Document and +other documents released under this License, and replace the +individual copies of this License in the various documents +with a single copy that is included in the collection, +provided that you follow the rules of this License for +verbatim copying of each of the documents in all other +respects. + +You may extract a single document from such a collection, +and distribute it individually under this License, provided +you insert a copy of this License into the extracted +document, and follow this License in all other respects +regarding verbatim copying of that document. + +\medskip +\begin{center} + \textbf{\Large Aggregation With Independent Works} +\end{center} + +\noindent +A compilation of the Document or its derivatives with other +separate and independent documents or works, in or on a +volume of a storage or distribution medium, does not as a +whole count as a Modified Version of the Document, provided +no compilation copyright is claimed for the compilation. +Such a compilation is called an \enquote{aggregate}, and +this License does not apply to the other self-contained +works thus compiled with the Document, on account of their +being thus compiled, if they are not themselves derivative +works of the Document. + +If the Cover Text requirement of section 3 is applicable to +these copies of the Document, then if the Document is less +than one quarter of the entire aggregate, the Document's +Cover Texts may be placed on covers that surround only the +Document within the aggregate. Otherwise they must appear on +covers around the whole aggregate. + +\begin{center} + \textbf{\Large Translation} +\end{center} + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of +section 4. Replacing Invariant Sections with translations +requires special permission from their copyright holders, +but you may include translations of some or all Invariant +Sections in addition to the original versions of these +Invariant Sections. You may include a translation of this +License provided that you also include the original English +version of this License. In case of a disagreement between +the translation and the original English version of this +License, the original English version will prevail. + +\medskip +\begin{samepage} + \begin{center} + \textbf{\Large Termination} + \end{center} + + \noindent + You may not copy, modify, sublicense, or distribute the + Document except as expressly provided for under this + License. Any other attempt to copy, modify, sublicense or + distribute the Document is void, and will automatically + terminate your rights under this License. However, parties + who have received copies, or rights, from you under this + License will not have their licenses terminated so long as + such parties remain in full compliance. +\end{samepage} + +\begin{center} + \textbf{\Large Future Revisions of This License} +\end{center} + +The Free Software Foundation may publish new, revised +versions of the GNU Free Documentation License from time to +time. Such new versions will be similar in spirit to the +present version, but may differ in detail to address new +problems or concerns. See +\url{https://www.gnu.org/licenses}. + +Each version of the License is given a distinguishing +version number. If the Document specifies that a particular +numbered version of this License "or any later version" +applies to it, you have the option of following the terms +and conditions either of that specified version or of any +later version that has been published (not as a draft) by +the Free Software Foundation. If the Document does not +specify a version number of this License, you may choose any +version ever published (not as a draft) by the Free Software +Foundation. + +\medskip +\begin{center} + \textbf{\Large ADDENDUM: How to use this License for your + documents} +\end{center} + +\noindent +To use this License in a document you have written, include +a copy of the License in the document and put the following +copyright and license notices just after the title page: + +\begin{quote} + Copyright \copyright\ YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify + this document under the terms of the GNU Free + Documentation License, Version 1.1 or any later version + published by the Free Software Foundation; with the + Invariant Sections being LIST THEIR TITLES, with the + Front-Cover Texts being LIST, and with the Back-Cover + Texts being LIST. A copy of the license is included in the + section entitled \enquote{GNU Free Documentation + License}. +\end{quote} + +If you have no Invariant Sections, write \enquote{with no +Invariant Sections} instead of saying which ones are +invariant. If you have no Front-Cover Texts, write +\enquote{no Front-Cover Texts} instead of +\enquote{Front-Cover Texts being LIST}; likewise for +Back-Cover Texts. + +If your document contains nontrivial examples of program +code, we recommend releasing these examples in parallel +under your choice of free software license, such as the GNU +General Public License, to permit their use in free +software.
\ No newline at end of file diff --git a/macros/latex/contrib/gfdl/gfdl-tex-1p2.tex b/macros/latex/contrib/gfdl/gfdl-tex-1p2.tex new file mode 100644 index 0000000000..7dc9e91eca --- /dev/null +++ b/macros/latex/contrib/gfdl/gfdl-tex-1p2.tex @@ -0,0 +1,552 @@ +% --------------------------------------------------------- +% LaTeX-Source for printing GFDL v1.2 +% Copyright © 2022, 2023 निरंजन +% +% This program is free software: you can redistribute it +% and/or modify it under the terms of the GNU General Public +% License as published by the Free Software Foundation, +% either version 3 of the License, or (at your option) any +% later version. +% +% This program is distributed in the hope that it will be +% useful, but WITHOUT ANY WARRANTY; without even the implied +% warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR +% PURPOSE. See the GNU General Public License for more +% details. +% +% You should have received a copy of the GNU General Public +% License along with this program. If not, see +% <https://www.gnu.org/licenses/>. +% --------------------------------------------------------- +\begin{center} + \textbf{\LARGE GNU Free Documentation License} + + \bigskip + + Version 1.2, November 2002 + + Copyright \copyright{} 2000, 2001, 2002 Free Software + Foundation, Inc. + + \bigskip + + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + \bigskip + + Everyone is permitted to copy and distribute verbatim + copies of this license document, but changing it is not + allowed. + \bigskip + + \textbf{\Large Preamble} +\end{center} + +The purpose of this License is to make a manual, textbook, +or other functional and useful document \enquote{free} in +the sense of freedom: to assure everyone the effective +freedom to copy and redistribute it, with or without +modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and +publisher a way to get credit for their work, while not +being considered responsible for modifications made by +others. + +This License is a kind of \enquote{copyleft}, which means +that derivative works of the document must themselves be +free in the same sense. It complements the GNU General +Public License, which is a copyleft license designed for +free software. + +We have designed this License in order to use it for manuals +for free software, because free software needs free +documentation: a free program should come with manuals +providing the same freedoms that the software does. But this +License is not limited to software manuals; it can be used +for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this +License principally for works whose purpose is instruction +or reference. + +\medskip +\begin{center} + \textbf{\Large 1. APPLICABILITY AND DEFINITIONS} +\end{center} + +\noindent +This License applies to any manual or other work, in any +medium, that contains a notice placed by the copyright +holder saying it can be distributed under the terms of this +License. Such a notice grants a world-wide, royalty-free +license, unlimited in duration, to use that work under the +conditions stated herein. The \textbf{\enquote{Document}}, +below, refers to any such manual or work. Any member of the +public is a licensee, and is addressed as +\textbf{\enquote{you}}. You accept the license if you copy, +modify or distribute the work in a way requiring permission +under copyright law. + +A \textbf{\enquote{Modified Version}} of the Document means +any work containing the Document or a portion of it, either +copied verbatim, or with modifications and/or translated +into another language. + +A \textbf{\enquote{Secondary Section}} is a named appendix +or a front-matter section of the Document that deals +exclusively with the relationship of the publishers or +authors of the Document to the Document's overall subject +(or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document +is in part a textbook of mathematics, a Secondary Section +may not explain any mathematics.) The relationship could be +a matter of historical connection with the subject or with +related matters, or of legal, commercial, philosophical, +ethical or political position regarding them. + +The \textbf{\enquote{Invariant Sections}} are certain +Secondary Sections whose titles are designated, as being +those of Invariant Sections, in the notice that says that +the Document is released under this License. If a section +does not fit the above definition of Secondary then it is +not allowed to be designated as Invariant. The Document may +contain zero Invariant Sections. If the Document does not +identify any Invariant Sections then there are none. + +The \textbf{\enquote{Cover Texts}} are certain short +passages of text that are listed, as Front-Cover Texts or +Back-Cover Texts, in the notice that says that the Document +is released under this License. A Front-Cover Text may be at +most 5 words, and a Back-Cover Text may be at most 25 +words. + +A \textbf{\enquote{Transparent}} copy of the Document means +a machine-readable copy, represented in a format whose +specification is available to the general public, that is +suitable for revising the document straightforwardly with +generic text editors or (for images composed of pixels) +generic paint programs or (for drawings) some widely +available drawing editor, and that is suitable for input to +text formatters or for automatic translation to a variety of +formats suitable for input to text formatters. A copy made +in an otherwise Transparent file format whose markup, or +absence of markup, has been arranged to thwart or discourage +subsequent modification by readers is not Transparent. An +image format is not Transparent if used for any substantial +amount of text. A copy that is not \enquote{Transparent} is +called \textbf{\enquote{Opaque}}. + +Examples of suitable formats for Transparent copies include +plain ASCII without markup, Texinfo input format, LaTeX +input format, SGML or XML using a publicly available DTD, +and standard-conforming simple HTML, PostScript or PDF +designed for human modification. Examples of transparent +image formats include PNG, XCF and JPG. Opaque formats +include proprietary formats that can be read and edited only +by proprietary word processors, SGML or XML for which the +DTD and/or processing tools are not generally available, and +the machine-generated HTML, PostScript or PDF produced by +some word processors for output purposes only. + +The \textbf{\enquote{Title Page}} means, for a printed book, +the title page itself, plus such following pages as are +needed to hold, legibly, the material this License requires +to appear in the title page. For works in formats which do +not have any title page as such, \enquote{Title Page} means +the text near the most prominent appearance of the work's +title, preceding the beginning of the body of the text. + +A section \textbf{\enquote{Entitled XYZ}} means a named +subunit of the Document whose title either is precisely XYZ +or contains XYZ in parentheses following text that +translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as +\textbf{\enquote{Acknowledgements}}, +\textbf{\enquote{Dedications}}, +\textbf{\enquote{Endorsements}}, or +\textbf{\enquote{History}}.) To \textbf{\enquote{Preserve + the Title}} of such a section when you modify the +Document means that it remains a section \enquote{Entitled + XYZ} according to this definition. + +The Document may include Warranty Disclaimers next to the +notice which states that this License applies to the +Document. These Warranty Disclaimers are considered to be +included by reference in this License, but only as regards +disclaiming warranties: any other implication that these +Warranty Disclaimers may have is void and has no effect on +the meaning of this License. + +\medskip +\begin{center} + \textbf{\Large 2. VERBATIM COPYING} +\end{center} + +\noindent +You may copy and distribute the Document in any medium, +either commercially or noncommercially, provided that this +License, the copyright notices, and the license notice +saying this License applies to the Document are reproduced +in all copies, and that you add no other conditions +whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or +further copying of the copies you make or distribute. +However, you may accept compensation in exchange for copies. +If you distribute a large enough number of copies you must +also follow the conditions in section~3. + +You may also lend copies, under the same conditions stated +above, and you may publicly display copies. + +\medskip +\begin{center} + \textbf{\Large 3. COPYING IN QUANTITY} +\end{center} + +\noindent +If you publish printed copies (or copies in media that +commonly have printed covers) of the Document, numbering +more than 100, and the Document's license notice requires +Cover Texts, you must enclose the copies in covers that +carry, clearly and legibly, all these Cover Texts: +Front-Cover Texts on the front cover, and Back-Cover Texts +on the back cover. Both covers must also clearly and legibly +identify you as the publisher of these copies. The front +cover must present the full title with all words of the +title equally prominent and visible. You may add other +material on the covers in addition. Copying with changes +limited to the covers, as long as they preserve the title of +the Document and satisfy these conditions, can be treated as +verbatim copying in other respects. + +If the required texts for either cover are too voluminous to +fit legibly, you should put the first ones listed (as many +as fit reasonably) on the actual cover, and continue the +rest onto adjacent pages. + +If you publish or distribute Opaque copies of the Document +numbering more than 100, you must either include a +machine-readable Transparent copy along with each Opaque +copy, or state in or with each Opaque copy a +computer-network location from which the general +network-using public has access to download using +public-standard network protocols a complete Transparent +copy of the Document, free of added material. If you use the +latter option, you must take reasonably prudent steps, when +you begin distribution of Opaque copies in quantity, to +ensure that this Transparent copy will remain thus +accessible at the stated location until at least one year +after the last time you distribute an Opaque copy (directly +or through your agents or retailers) of that edition to the +public. + +It is requested, but not required, that you contact the +authors of the Document well before redistributing any large +number of copies, to give them a chance to provide you with +an updated version of the Document. + +\medskip +\begin{center} + \textbf{\Large 4. MODIFICATIONS} +\end{center} + +\noindent +You may copy and distribute a Modified Version of the +Document under the conditions of sections 2 and 3 above, +provided that you release the Modified Version under +precisely this License, with the Modified Version filling +the role of the Document, thus licensing distribution and +modification of the Modified Version to whoever possesses a +copy of it. In addition, you must do these things in the +Modified Version: + +\begin{itemize} +\item[A.] Use in the Title Page (and on the covers, if any) + a title distinct from that of the Document, and from those + of previous versions (which should, if there were any, be + listed in the History section of the Document). You may + use the same title as a previous version if the original + publisher of that version gives permission. + +\item[B.] List on the Title Page, as authors, one or more + persons or entities responsible for authorship of the + modifications in the Modified Version, together with at + least five of the principal authors of the Document (all + of its principal authors, if it has fewer than five), + unless they release you from this requirement. + +\item[C.] State on the Title page the name of the publisher + of the Modified Version, as the publisher. + +\item[D.] Preserve all the copyright notices of the + Document. + +\item[E.] Add an appropriate copyright notice for your + modifications adjacent to the other copyright notices. + +\item[F.] Include, immediately after the copyright notices, + a license notice giving the public permission to use the + Modified Version under the terms of this License, in the + form shown in the Addendum below. + +\item[G.] Preserve in that license notice the full lists of + Invariant Sections and required Cover Texts given in the + Document's license notice. + +\item[H.] Include an unaltered copy of this License. + +\item[I.] Preserve the section Entitled \enquote{History}, + Preserve its Title, and add to it an item stating at least + the title, year, new authors, and publisher of the + Modified Version as given on the Title Page. If there is + no section Entitled \enquote{History} in the Document, + create one stating the title, year, authors, and publisher + of the Document as given on its Title Page, then add an + item describing the Modified Version as stated in the + previous sentence. + +\item[J.] Preserve the network location, if any, given in + the Document for public access to a Transparent copy of + the Document, and likewise the network locations given in + the Document for previous versions it was based on. These + may be placed in the ``History'' section. You may omit a + network location for a work that was published at least + four years before the Document itself, or if the original + publisher of the version it refers to gives permission. + +\item[K.] For any section Entitled + \enquote{Acknowledgements} or \enquote{Dedications}, + Preserve the Title of the section, and preserve in the + section all the substance and tone of each of the + contributor acknowledgements and/or dedications given + therein. + +\item[L.] Preserve all the Invariant Sections of the + Document, unaltered in their text and in their titles. + Section numbers or the equivalent are not considered part + of the section titles. + +\item[M.] Delete any section Entitled + \enquote{Endorsements}. Such a section may not be included + in the Modified Version. + +\item[N.] Do not retitle any existing section to be Entitled + \enquote{Endorsements} or to conflict in title with any + Invariant Section. + +\item[O.] Preserve any Warranty Disclaimers. +\end{itemize} + +If the Modified Version includes new front-matter sections +or appendices that qualify as Secondary Sections and contain +no material copied from the Document, you may at your option +designate some or all of these sections as invariant. To do +this, add their titles to the list of Invariant Sections in +the Modified Version's license notice. These titles must be +distinct from any other section titles. + +You may add a section Entitled \enquote{Endorsements}, +provided it contains nothing but endorsements of your +Modified Version by various parties--for example, statements +of peer review or that the text has been approved by an +organization as the authoritative definition of a standard. + +You may add a passage of up to five words as a Front-Cover +Text, and a passage of up to 25 words as a Back-Cover Text, +to the end of the list of Cover Texts in the Modified +Version. Only one passage of Front-Cover Text and one of +Back-Cover Text may be added by (or through arrangements +made by) any one entity. If the Document already includes a +cover text for the same cover, previously added by you or by +arrangement made by the same entity you are acting on behalf +of, you may not add another; but you may replace the old +one, on explicit permission from the previous publisher that +added the old one. + +The author(s) and publisher(s) of the Document do not by +this License give permission to use their names for +publicity for or to assert or imply endorsement of any +Modified Version. + +\medskip +\begin{center} + \textbf{\Large 5. COMBINING DOCUMENTS} +\end{center} + +\noindent +You may combine the Document with other documents released +under this License, under the terms defined in section~4 +above for modified versions, provided that you include in +the combination all of the Invariant Sections of all of the +original documents, unmodified, and list them all as +Invariant Sections of your combined work in its license +notice, and that you preserve all their Warranty +Disclaimers. + +The combined work need only contain one copy of this +License, and multiple identical Invariant Sections may be +replaced with a single copy. If there are multiple Invariant +Sections with the same name but different contents, make the +title of each such section unique by adding at the end of +it, in parentheses, the name of the original author or +publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list +of Invariant Sections in the license notice of the combined +work. + +In the combination, you must combine any sections Entitled +\enquote{History} in the various original documents, forming +one section Entitled \enquote{History}; likewise combine any +sections Entitled \enquote{Acknowledgements}, and any +sections Entitled \enquote{Dedications}. You must delete all +sections Entitled \enquote{Endorsements}. + +\medskip +\begin{center} + \textbf{\Large 6. COLLECTIONS OF DOCUMENTS} +\end{center} + +\noindent +You may make a collection consisting of the Document and +other documents released under this License, and replace the +individual copies of this License in the various documents +with a single copy that is included in the collection, +provided that you follow the rules of this License for +verbatim copying of each of the documents in all other +respects. You may extract a single document from such a +collection, and distribute it individually under this +License, provided you insert a copy of this License into the +extracted document, and follow this License in all other +respects regarding verbatim copying of that document. + +\medskip +\begin{center} + \textbf{\Large 7. AGGREGATION WITH INDEPENDENT WORKS} +\end{center} + +\noindent +A compilation of the Document or its derivatives with other +separate and independent documents or works, in or on a +volume of a storage or distribution medium, is called an +\enquote{aggregate} if the copyright resulting from the +compilation is not used to limit the legal rights of the +compilation's users beyond what the individual works +permit. When the Document is included in an aggregate, this +License does not apply to the other works in the aggregate +which are not themselves derivative works of the Document. + +If the Cover Text requirement of section~3 is applicable to +these copies of the Document, then if the Document is less +than one half of the entire aggregate, the Document's Cover +Texts may be placed on covers that bracket the Document +within the aggregate, or the electronic equivalent of covers +if the Document is in electronic form. Otherwise they must +appear on printed covers that bracket the whole aggregate. + +\medskip +\begin{center} + \textbf{\Large 8. TRANSLATION} +\end{center} + +\noindent +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of +section~4. Replacing Invariant Sections with translations +requires special permission from their copyright holders, +but you may include translations of some or all Invariant +Sections in addition to the original versions of these +Invariant Sections. You may include a translation of this +License, and all the license notices in the Document, and +any Warranty Disclaimers, provided that you also include the +original English version of this License and the original +versions of those notices and disclaimers. In case of a +disagreement between the translation and the original +version of this License or a notice or disclaimer, the +original version will prevail. + +If a section in the Document is Entitled +\enquote{Acknowledgements}, \enquote{Dedications}, or +\enquote{History}, the requirement (section~4) to Preserve +its Title (section~1) will typically require changing the +actual title. + +\medskip +\begin{center} + \textbf{\Large 9. TERMINATION} +\end{center} + +\noindent +You may not copy, modify, sublicense, or distribute the +Document except as expressly provided for under this +License. Any other attempt to copy, modify, sublicense or +distribute the Document is void, and will automatically +terminate your rights under this License. However, parties +who have received copies, or rights, from you under this +License will not have their licenses terminated so long as +such parties remain in full compliance. + +\medskip +\begin{center} + \textbf{\Large 10. FUTURE REVISIONS OF THIS LICENSE} +\end{center} + +\noindent +The Free Software Foundation may publish new, revised +versions of the GNU Free Documentation License from time to +time. Such new versions will be similar in spirit to the +present version, but may differ in detail to address new +problems or concerns. See +\url{https://www.gnu.org/licenses}. + +Each version of the License is given a distinguishing +version number. If the Document specifies that a particular +numbered version of this License \enquote{or any later + version} applies to it, you have the option of following +the terms and conditions either of that specified version or +of any later version that has been published (not as a +draft) by the Free Software Foundation. If the Document does +not specify a version number of this License, you may choose +any version ever published (not as a draft) by the Free +Software Foundation. + +\medskip +\begin{center} + \textbf{\Large ADDENDUM: How to use this License for your + documents} +\end{center} + +\noindent +To use this License in a document you have written, include +a copy of the License in the document and put the following +copyright and license notices just after the title page: + +\begin{quote} + Copyright \copyright{} YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify + this document under the terms of the GNU Free + Documentation License, Version 1.2 or any later version + published by the Free Software Foundation; with no + Invariant Sections, no Front-Cover Texts, and no + Back-Cover Texts. A copy of the license is included in the + section entitled \enquote{GNU Free Documentation + License}. +\end{quote} + +If you have Invariant Sections, Front-Cover Texts and +Back-Cover Texts, replace the \enquote{with \dots\ Texts.} +line with this: + +\begin{quote} + with the Invariant Sections being LIST THEIR TITLES, with + the Front-Cover Texts being LIST, and with the Back-Cover + Texts being LIST. +\end{quote} + +If you have Invariant Sections without Cover Texts, or some +other combination of the three, merge those two alternatives +to suit the situation. + +If your document contains nontrivial examples of program +code, we recommend releasing these examples in parallel +under your choice of free software license, such as the GNU +General Public License, to permit their use in free +software.
\ No newline at end of file diff --git a/macros/latex/contrib/gfdl/gfdl-tex-1p3.tex b/macros/latex/contrib/gfdl/gfdl-tex-1p3.tex new file mode 100644 index 0000000000..e79f1a2877 --- /dev/null +++ b/macros/latex/contrib/gfdl/gfdl-tex-1p3.tex @@ -0,0 +1,638 @@ +% --------------------------------------------------------- +% LaTeX-Source for printing GFDL v1.3 +% Copyright © 2022, 2023 निरंजन +% +% This program is free software: you can redistribute it +% and/or modify it under the terms of the GNU General Public +% License as published by the Free Software Foundation, +% either version 3 of the License, or (at your option) any +% later version. +% +% This program is distributed in the hope that it will be +% useful, but WITHOUT ANY WARRANTY; without even the implied +% warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR +% PURPOSE. See the GNU General Public License for more +% details. +% +% You should have received a copy of the GNU General Public +% License along with this program. If not, see +% <https://www.gnu.org/licenses/>. +% --------------------------------------------------------- +\begin{center} + \textbf{\LARGE GNU Free Documentation License} + + \bigskip + + Version 1.3, 3 November 2008 + + Copyright \copyright{} 2000, 2001, 2002, 2007, 2008 Free + Software Foundation, Inc. + + \bigskip + + \url{https://fsf.org/} + + \bigskip + + Everyone is permitted to copy and distribute verbatim + copies of this license document, but changing it is not + allowed. + + \bigskip + + \textbf{\Large Preamble} +\end{center} + +\noindent +The purpose of this License is to make a manual, textbook, +or other functional and useful document \enquote{free} in +the sense of freedom: to assure everyone the effective +freedom to copy and redistribute it, with or without +modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and +publisher a way to get credit for their work, while not +being considered responsible for modifications made by +others. + +This License is a kind of \enquote{copyleft}, which means +that derivative works of the document must themselves be +free in the same sense. It complements the GNU General +Public License, which is a copyleft license designed for +free software. + +We have designed this License in order to use it for manuals +for free software, because free software needs free +documentation: a free program should come with manuals +providing the same freedoms that the software does. But +this License is not limited to software manuals; it can be +used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this +License principally for works whose purpose is instruction +or reference. + +\medskip +\begin{center} + \textbf{\Large 1.\ APPLICABILITY AND DEFINITIONS} +\end{center} + +\noindent +This License applies to any manual or other work, in any +medium, that contains a notice placed by the copyright +holder saying it can be distributed under the terms of this +License. Such a notice grants a world-wide, royalty-free +license, unlimited in duration, to use that work under the +conditions stated herein. The \enquote{\textbf{Document}}, +below, refers to any such manual or work. Any member of the +public is a licensee, and is addressed as \enquote{% + \textbf{you}}. You accept the license if you copy, modify +or distribute the work in a way requiring permission under +copyright law. + +A \enquote{\textbf{Modified Version}} of the Document means +any work containing the Document or a portion of it, either +copied verbatim, or with modifications and/or translated +into another language. + +A \enquote{\textbf{Secondary Section}} is a named appendix +or a front-matter section of the Document that deals +exclusively with the relationship of the publishers or +authors of the Document to the Document's overall subject +(or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document +is in part a textbook of mathematics, a Secondary Section +may not explain any mathematics.) The relationship could be +a matter of historical connection with the subject or with +related matters, or of legal, commercial, philosophical, +ethical or political position regarding them. + +The \enquote{\textbf{Invariant Sections}} are certain +Secondary Sections whose titles are designated, as being +those of Invariant Sections, in the notice that says that +the Document is released under this License. If a section +does not fit the above definition of Secondary then it is +not allowed to be designated as Invariant. The Document may +contain zero Invariant Sections. If the Document does not +identify any Invariant Sections then there are none. + +The \enquote{\textbf{Cover Texts}} are certain short +passages of text that are listed, as Front-Cover Texts or +Back-Cover Texts, in the notice that says that the Document +is released under this License. A Front-Cover Text may be at +most 5 words, and a Back-Cover Text may be at most 25 +words. + +A \enquote{\textbf{Transparent}} copy of the Document means +a machine-readable copy, represented in a format whose +specification is available to the general public, that is +suitable for revising the document straightforwardly with +generic text editors or (for images composed of pixels) +generic paint programs or (for drawings) some widely +available drawing editor, and that is suitable for input to +text formatters or for automatic translation to a variety of +formats suitable for input to text formatters. A copy made +in an otherwise Transparent file format whose markup, or +absence of markup, has been arranged to thwart or discourage +subsequent modification by readers is not Transparent. An +image format is not Transparent if used for any substantial +amount of text. A copy that is not \enquote{Transparent} is +called \enquote{\textbf{Opaque}}. + +Examples of suitable formats for Transparent copies include +plain ASCII without markup, Texinfo input format, \LaTeX\ +input format, SGML or XML using a publicly available DTD, +and standard-conforming simple HTML, Post\-Script or PDF +designed for human modification. Examples of transparent +image formats include PNG, XCF and JPG. Opaque formats +include proprietary formats that can be read and edited only +by proprietary word processors, SGML or XML for which the +DTD and/or processing tools are not generally available, and +the machine-generated HTML, PostScript or PDF produced by +some word processors for output purposes only. + +The \enquote{\textbf{Title Page}} means, for a printed book, +the title page itself, plus such following pages as are +needed to hold, legibly, the material this License requires +to appear in the title page. For works in formats which do +not have any title page as such, \enquote{Title Page} means +the text near the most prominent appearance of the work's +title, preceding the beginning of the body of the text. + +The \enquote{\textbf{publisher}} means any person or entity +that distributes copies of the Document to the public. + +A section \enquote{\textbf{Entitled XYZ}} means a named +subunit of the Document whose title either is precisely XYZ +or contains XYZ in parentheses following text that +translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as \enquote{% + \textbf{Acknowledgements}}, \enquote{\textbf{% + Dedications}}, \enquote{\textbf{Endorsements}}, or +\enquote{\textbf{History}}.) To \enquote{\textbf{% + Preserve the Title}} of such a section when you modify +the Document means that it remains a section \enquote{% + \textbf{Entitled XYZ}} according to this definition. + +The Document may include Warranty Disclaimers next to the +notice which states that this License applies to the +Document. These Warranty Disclaimers are considered to be +included by reference in this License, but only as regards +disclaiming warranties: any other implication that these +Warranty Disclaimers may have is void and has no effect on +the meaning of this License. + +\medskip +\begin{center} + \textbf{\Large 2. VERBATIM COPYING} +\end{center} + +\noindent +You may copy and distribute the Document in any medium, +either commercially or noncommercially, provided that this +License, the copyright notices, and the license notice +saying this License applies to the Document are reproduced +in all copies, and that you add no other conditions +whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or +further copying of the copies you make or distribute. +However, you may accept compensation in exchange for copies. +If you distribute a large enough number of copies you must +also follow the conditions in section~3. + +You may also lend copies, under the same conditions stated +above, and you may publicly display copies. + +\medskip +\begin{center} + \textbf{\Large 3. COPYING IN QUANTITY} +\end{center} + +\noindent +If you publish printed copies (or copies in media that +commonly have printed covers) of the Document, numbering +more than 100, and the Document's license notice requires +Cover Texts, you must enclose the copies in covers that +carry, clearly and legibly, all these Cover Texts: +Front-Cover Texts on the front cover, and Back-Cover Texts +on the back cover. Both covers must also clearly and legibly +identify you as the publisher of these copies. The front +cover must present the full title with all words of the +title equally prominent and visible. You may add other +material on the covers in addition. Copying with changes +limited to the covers, as long as they preserve the title of +the Document and satisfy these conditions, can be treated as +verbatim copying in other respects. + +If the required texts for either cover are too voluminous +to fit legibly, you should put the first ones listed (as +many as fit reasonably) on the actual cover, and continue +the rest onto adjacent pages. + +If you publish or distribute Opaque copies of the Document +numbering more than 100, you must either include a +machine-readable Transparent copy along with each Opaque +copy, or state in or with each Opaque copy a +computer-network location from which the general +network-using public has access to download using +public-standard network protocols a complete Transparent +copy of the Document, free of added material. If you use +the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, +to ensure that this Transparent copy will remain thus +accessible at the stated location until at least one year +after the last time you distribute an Opaque copy +(directly or through your agents or retailers) of that +edition to the public. + +It is requested, but not required, that you contact the +authors of the Document well before redistributing any +large number of copies, to give them a chance to provide +you with an updated version of the Document. + +\medskip +\begin{center} + \textbf{\Large 4. MODIFICATIONS} +\end{center} + +\noindent +You may copy and distribute a Modified Version of the +Document under the conditions of sections 2 and 3 above, +provided that you release the Modified Version under +precisely this License, with the Modified Version filling +the role of the Document, thus licensing distribution and +modification of the Modified Version to whoever possesses +a copy of it. In addition, you must do these things in +the Modified Version: + +\begin{itemize} +\item[A.] + Use in the Title Page (and on the covers, if any) a + title distinct from that of the Document, and from those + of previous versions (which should, if there were any, + be listed in the History section of the Document). You + may use the same title as a previous version if the + original publisher of that version gives permission. + +\item[B.] + List on the Title Page, as authors, one or more persons + or entities responsible for authorship of the + modifications in the Modified Version, together with at + least five of the principal authors of the Document (all + of its principal authors, if it has fewer than five), + unless they release you from this requirement. + +\item[C.] + State on the Title page the name of the publisher of the + Modified Version, as the publisher. + +\item[D.] + Preserve all the copyright notices of the Document. + +\item[E.] + Add an appropriate copyright notice for your + modifications adjacent to the other copyright notices. + +\item[F.] + Include, immediately after the copyright notices, a + license notice giving the public permission to use the + Modified Version under the terms of this License, in the + form shown in the Addendum below. + +\item[G.] + Preserve in that license notice the full lists of + Invariant Sections and required Cover Texts given in the + Document's license notice. + +\item[H.] + Include an unaltered copy of this License. + +\item[I.] + Preserve the section Entitled \enquote{History}, Preserve + its Title, and add to it an item stating at least the + title, year, new authors, and publisher of the Modified + Version as given on the Title Page. If there is no section + Entitled \enquote{History} in the Document, create one + stating the title, year, authors, and publisher of the + Document as given on its Title Page, then add an item + describing the Modified Version as stated in the previous + sentence. + +\item[J.] + Preserve the network location, if any, given in the + Document for public access to a Transparent copy of the + Document, and likewise the network locations given in + the Document for previous versions it was based on. + These may be placed in the \enquote{History} section. You + may omit a network location for a work that was published + at least four years before the Document itself, or if the + original publisher of the version it refers to gives + permission. + +\item[K.] + For any section Entitled \enquote{Acknowledgements} or + \enquote{Dedications}, Preserve the Title of the section, + and preserve in the section all the substance and tone of + each of the contributor acknowledgements and/or + dedications given therein. + +\item[L.] + Preserve all the Invariant Sections of the Document, + unaltered in their text and in their titles. Section + numbers or the equivalent are not considered part of the + section titles. + +\item[M.] + Delete any section Entitled \enquote{Endorsements}. Such a + section may not be included in the Modified Version. + +\item[N.] + Do not retitle any existing section to be Entitled + \enquote{Endorsements} or to conflict in title with any + Invariant Section. + +\item[O.] + Preserve any Warranty Disclaimers. +\end{itemize} + +If the Modified Version includes new front-matter sections +or appendices that qualify as Secondary Sections and +contain no material copied from the Document, you may at +your option designate some or all of these sections as +invariant. To do this, add their titles to the list of +Invariant Sections in the Modified Version's license +notice. These titles must be distinct from any other +section titles. + +You may add a section Entitled \enquote{Endorsements}, +provided it contains nothing but endorsements of your +Modified Version by various parties---for example, +statements of peer review or that the text has been approved +by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover +Text, and a passage of up to 25 words as a Back-Cover Text, +to the end of the list of Cover Texts in the Modified +Version. Only one passage of Front-Cover Text and one of +Back-Cover Text may be added by (or through arrangements +made by) any one entity. If the Document already includes a +cover text for the same cover, previously added by you or by +arrangement made by the same entity you are acting on behalf +of, you may not add another; but you may replace the old +one, on explicit permission from the previous publisher that +added the old one. + +The author(s) and publisher(s) of the Document do not by +this License give permission to use their names for +publicity for or to assert or imply endorsement of any +Modified Version. + +\medskip +\begin{center} + \textbf{\Large 5. COMBINING DOCUMENTS} +\end{center} + +\noindent +You may combine the Document with other documents released +under this License, under the terms defined in section~4 +above for modified versions, provided that you include in +the combination all of the Invariant Sections of all of +the original documents, unmodified, and list them all as +Invariant Sections of your combined work in its license +notice, and that you preserve all their Warranty +Disclaimers. + +The combined work need only contain one copy of this +License, and multiple identical Invariant Sections may be +replaced with a single copy. If there are multiple Invariant +Sections with the same name but different contents, make the +title of each such section unique by adding at the end of +it, in parentheses, the name of the original author or +publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list +of Invariant Sections in the license notice of the combined +work. + +In the combination, you must combine any sections Entitled +\enquote{History} in the various original documents, forming +one section Entitled \enquote{History}; likewise combine any +sections Entitled \enquote{Acknowledgements}, and any +sections Entitled \enquote{Dedications}. You must delete all +sections Entitled \enquote{Endorsements}. + +\medskip +\begin{center} + \textbf{\Large 6. COLLECTIONS OF DOCUMENTS} +\end{center} + +\noindent +You may make a collection consisting of the Document and +other documents released under this License, and replace the +individual copies of this License in the various documents +with a single copy that is included in the collection, +provided that you follow the rules of this License for +verbatim copying of each of the documents in all other +respects. + +You may extract a single document from such a collection, +and distribute it individually under this License, provided +you insert a copy of this License into the extracted +document, and follow this License in all other respects +regarding verbatim copying of that document. + +\medskip +\begin{center} + \textbf{\Large 7. AGGREGATION WITH INDEPENDENT WORKS} +\end{center} + +\noindent +A compilation of the Document or its derivatives with other +separate and independent documents or works, in or on a +volume of a storage or distribution medium, is called an +\enquote{aggregate} if the copyright resulting from the +compilation is not used to limit the legal rights of the +compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License +does not apply to the other works in the aggregate which are +not themselves derivative works of the Document. + +If the Cover Text requirement of section~3 is applicable to +these copies of the Document, then if the Document is less +than one half of the entire aggregate, the Document's Cover +Texts may be placed on covers that bracket the Document +within the aggregate, or the electronic equivalent of covers +if the Document is in electronic form. Otherwise they must +appear on printed covers that bracket the whole aggregate. + +\medskip +\begin{center} + \textbf{\Large 8. TRANSLATION} +\end{center} + +\noindent +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of +section~4. Replacing Invariant Sections with translations +requires special permission from their copyright holders, +but you may include translations of some or all Invariant +Sections in addition to the original versions of these +Invariant Sections. You may include a translation of this +License, and all the license notices in the Document, and +any Warranty Disclaimers, provided that you also include the +original English version of this License and the original +versions of those notices and disclaimers. In case of a +disagreement between the translation and the original +version of this License or a notice or disclaimer, the +original version will prevail. + +If a section in the Document is Entitled +\enquote{Acknowledgements}, \enquote{Dedications}, or +\enquote{History}, the requirement (section~4) to Preserve +its Title (section~1) will typically require changing the +actual title. + +\medskip +\begin{center} + \textbf{\Large 9. TERMINATION} +\end{center} + +\noindent +You may not copy, modify, sublicense, or distribute the +Document except as expressly provided under this License. +Any attempt otherwise to copy, modify, sublicense, or +distribute it is void, and will automatically terminate your +rights under this License. + +However, if you cease all violation of this License, then +your license from a particular copyright holder is +reinstated (a) provisionally, unless and until the copyright +holder explicitly and finally terminates your license, and +(b) permanently, if the copyright holder fails to notify you +of the violation by some reasonable means prior to 60 days +after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you +of the violation by some reasonable means, this is the first +time you have received notice of violation of this License +(for any work) from that copyright holder, and you cure the +violation prior to 30 days after your receipt of the +notice. + +Termination of your rights under this section does not +terminate the licenses of parties who have received copies +or rights from you under this License. If your rights have +been terminated and not permanently reinstated, receipt of a +copy of some or all of the same material does not give you +any rights to use it. + +\medskip +\begin{center} + \textbf{\Large 10. FUTURE REVISIONS OF THIS LICENSE} +\end{center} + +\noindent +The Free Software Foundation may publish new, revised +versions of the GNU Free Documentation License from time to +time. Such new versions will be similar in spirit to the +present version, but may differ in detail to address new +problems or concerns. See +\url{https://www.gnu.org/licenses/}. + +Each version of the License is given a distinguishing +version number. If the Document specifies that a particular +numbered version of this License \enquote{or any later + version} applies to it, you have the option of following +the terms and conditions either of that specified version or +of any later version that has been published (not as a +draft) by the Free Software Foundation. If the Document does +not specify a version number of this License, you may choose +any version ever published (not as a draft) by the Free +Software Foundation. If the Document specifies that a proxy +can decide which future versions of this License can be +used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version +for the Document. + +\medskip +\begin{center} + \textbf{\Large 11. RELICENSING} +\end{center} + +\begingroup +\sloppy +\noindent +\enquote{Massive Multiauthor Collaboration Site} (or +\enquote{MMC Site}) means any World Wide Web server that +publishes copyrightable works and also provides prominent +facilities for anybody to edit those works. A public wiki +that anybody can edit is an example of such a server. A +\enquote{Massive Multiauthor Collaboration} (or +\enquote{MMC}) contained in the site means any set of +copyrightable works thus published on the MMC site. +\endgroup + +\enquote{CC-BY-SA} means the Creative Commons +Attribution-Share Alike 3.0 license published by Creative +Commons Corporation, a not-for-profit corporation with a +principal place of business in San Francisco, California, as +well as future copyleft versions of that license published +by that same organization. + +\enquote{Incorporate} means to publish or republish a +Document, in whole or in part, as part of another Document. + +An MMC is \enquote{eligible for relicensing} if it is +licensed under this License, and if all works that were +first published under this License somewhere other than this +MMC, and subsequently incorporated in whole or in part into +the MMC, (1) had no cover texts or invariant sections, and +(2) were thus incorporated prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained +in the site under CC-BY-SA on the same site at any time +before August 1, 2009, provided the MMC is eligible for +relicensing. + +\medskip +\begin{center} + \textbf{\Large ADDENDUM: How to use this License for your + documents} +\end{center} + +\noindent +To use this License in a document you have written, include +a copy of the License in the document and put the following +copyright and license notices just after the title page: + +\begin{quote} + Copyright \copyright{} YEAR YOUR NAME. + + Permission is granted to copy, distribute and/or modify + this document under the terms of the GNU Free + Documentation License, Version 1.3 or any later version + published by the Free Software Foundation; with no + Invariant Sections, no Front-Cover Texts, and no + Back-Cover Texts. A copy of the license is included in the + section entitled \enquote{GNU Free Documentation + License}. +\end{quote} + +If you have Invariant Sections, Front-Cover Texts and +Back-Cover Texts, replace the \enquote{with \dots\ Texts.}\ +line with this: + +\begin{quote} + with the Invariant Sections being LIST THEIR TITLES, with + the Front-Cover Texts being LIST, and with the Back-Cover + Texts being LIST. +\end{quote} + +If you have Invariant Sections without Cover Texts, or some +other combination of the three, merge those two alternatives +to suit the situation. + +If your document contains nontrivial examples of program +code, we recommend releasing these examples in parallel +under your choice of free software license, such as the GNU +General Public License, to permit their use in free +software.
\ No newline at end of file diff --git a/macros/latex/contrib/gfdl/gfdl.dtx b/macros/latex/contrib/gfdl/gfdl.dtx new file mode 100644 index 0000000000..464ba10f80 --- /dev/null +++ b/macros/latex/contrib/gfdl/gfdl.dtx @@ -0,0 +1,629 @@ +% \iffalse meta-comment +% +% File: gfdl.dtx +% ------------------------------------------------------------- +% Package: gfdl +% Version: v0.1 (January 1, 2023) +% Author: निरंजन +% Description: For using GFDL in LaTeX. +% Repository: https://puszcza.gnu.org.ua/projects/gfdl-tex +% License: GPLv3+, GFDLv1.3+ +% ------------------------------------------------------------- +% +% The LaTeX package gfdl v0.1 +% Copyright © 2022, 2023 निरंजन +% +% This program is free software: you can redistribute it +% and/or modify it under the terms of the GNU General Public +% License as published by the Free Software Foundation, +% either version 3 of the License, or (at your option) any +% later version. +% +% This program is distributed in the hope that it will be +% useful, but WITHOUT ANY WARRANTY; without even the implied +% warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR +% PURPOSE. See the GNU General Public License for more +% details. +% +% You should have received a copy of the GNU General Public +% License along with this program. If not, see +% <https://www.gnu.org/licenses/>. +% \fi +% \iffalse +%<*internal> +\iffalse +%</internal> +%<*readme> +------------------------------------------------------------- +Package: gfdl +Version: v0.1 (January 1, 2023) +Author: निरंजन +Description: For using GFDL in LaTeX. +Repository: https://puszcza.gnu.org.ua/projects/gfdl-tex +License: GPLv3+, GFDLv1.3+ +------------------------------------------------------------- +%</readme> +%<*internal> +\fi +%</internal> +%<*driver> +\documentclass{l3doc} +\usepackage{xcolor} +\usepackage{fontawesome5} +\usepackage{gfdl} +\usepackage{fontspec} +\usepackage{hyperref,hyperxmp} +\colorlet{myblue}{blue!60!black} +\colorlet{myred}{red!60!black} +\colorlet{mygreen}{green!60!black} +\hypersetup{% + unicode,% + colorlinks,% + urlcolor = {myblue},% + linkcolor = {myred},% + citecolor = {mygreen},% + pdftitle = {The gfdl package},% + pdfauthor = {निरंजन},% + pdfsubject = {For using GFDL in LaTeX.},% + pdfcreator = {निरंजन},% + pdfkeywords = {% + GFDL, LaTeX, FSF, Licensing, Documentation% + },% + pdfcopyright = {% + The LaTeX package gfdl\textLF + Copyright © 2022, 2023 निरंजन\textLF + Permission is granted to copy, distribute and/or modify + this document under the terms of the GNU Free + Documentation License, Version 1.3 or any later version + published by the Free Software Foundation; with no + Invariant Sections, no Front-Cover Texts, and no + Back-Cover Texts. A copy of the license is included in + the section entitled “GNU Free Documentation License”.% + },% + pdflicenseurl = {% + https://www.gnu.org/licenses/fdl-1.3.txt% + }% +}% +\usepackage{cleveref} +\newfontfamily\devanagari[% + Script = {Devanagari},% + Renderer = {Harfbuzz},% + Scale = {0.8}% +]% +{Shobhika} +\NewDocumentEnvironment{dedication}{ }{% + % Based on egreg's answer: + % https://tex.stackexchange.com/a/102849 + \clearpage % for a new page. + \thispagestyle{empty}% no header and footer. + \vspace*{\stretch{1}}% some space at the top. + \itshape % to get the text in italics. + \raggedleft % flush to the right margin. +}{% + \par % end the paragraph + \vspace{\stretch{3}}%% space at bottom is three times that + \clearpage %% at the top finish off the page. +} +\NewCommandCopy\oldamp\& +\renewcommand*{\&}{\textit{\oldamp}} +\gfdlcopyrightdescription{The \LaTeX\ package \pkg{gfdl}} +\gfdlcopyrightholders{\texorpdfstring{{\devanagari निरंजन}}{निरंजन}} +\gfdlcopyrightableyears{2022, 2023} + +\begin{document} +\DocInput{\jobname.dtx} +\end{document} +%</driver> +% \fi +% \title{The \pkg{gfdl} package} +% \author{^^A +% {^^A +% \devanagari +% निरंजन^^A +% }^^A +% \thanks{^^A +% \href{mailto:hi.niranjan@pm.me}^^A +% {\texttt{hi.niranjan@pm.me}}^^A +% }^^A +% } +% \date{^^A +% Version 0.1^^A +% ---^^A +% January 1, 2023\\[1ex]^^A +% {^^A +% \small\faIcon{link}\quad +% \url{https://ctan.org/pkg/gfdl}^^A +% }\\^^A +% {^^A +% \small\faIcon{bug}\quad +% \url{https://puszcza.gnu.org.ua/bugs/?group=gfdl-tex}^^A +% }^^A +% } +% +% \maketitle +% +% \begin{documentation} +% \begin{abstract} +% The GFDL is a popular license used for programming +% manuals, documentations \& various other textual works +% too, but using this license with \LaTeX\ isn't very +% convenient. This package aims to help users in easily +% using the license without violating any rules of the +% license. With a handful of commands, users can rest +% assured that their document will be perfectly licensed +% under GFDL. +% \end{abstract} +% +% \tableofcontents +% +% \begin{dedication} +% Dedicated to the FSF \& it's continuous fight for +% the freedom of software\dots +% \end{dedication} +% +% \section*{Acknowledgment} +% +% I acknowledge my friend Sahil Patel for reviewing the +% output of this package \& suggesting some corrections. +% I would also like to thank Karl Berry for pointing out +% some critical issues in my package \& suggesting +% alternative ways of dealing with them. This package +% modifies \& uses a few \LaTeX-files provided on the +% web-pages of respective versions of GFDL\footnote{^^A +% GFDLv1.3: +% \texttt{^^A +% \url{https://www.gnu.org/licenses/fdl-1.3.tex}^^A +% }.\\^^A +% GFDLv1.2: +% \texttt{^^A +% \url{https://www.gnu.org/licenses/fdl-1.2.tex}^^A +% }.\\^^A +% GFDLv1.1: +% \texttt{^^A +% \url{https://www.gnu.org/licenses/fdl-1.1.tex}^^A +% }.\\^^A +% } which are unlicensed \& their authors are unknown, but +% with a few typographic modifications I have used them in +% the package. I would like to thank FSF/GNU-hackers for +% providing a basic skeleton of the \LaTeX-files which I +% could modify. +% +% \section{Documentation} +% +% This section describes all the macros \& parameters that +% the package provides. +% +% \subsection{Macros} +% +% \begin{function}{^^A +% \gfdlcopyrightdescription,^^A +% \gfdlcopyrightableyears,^^A +% \gfdlcopyrightholders +% } +% \begin{syntax} +% \cs{gfdlcopyrightdescription}\marg{project-description} +% \cs{gfdlcopyrightableyears}\marg{copyright-able years} +% \cs{gfdlcopyrighthoders}\marg{copyright-holders} +% \end{syntax} +% The names of these macros are pretty self-explanatory. +% These macros store the information which is then printed +% automatically at necessary places. Only if one has +% loaded the |manual| option (documented in \cref{opts}); +% they will have to use the macros following this one to +% print the notice \& the license-text. +% \end{function} +% +% \begin{function}{\printgfdlnotice} +% This text prints the copyright-notice. \LaTeX's +% float-mechanism is used for printing it. It is printed +% on the first page of the document with default +% settings. With option |manual| user is free to print it +% anywhere, but not printing it will produce an error. +% \end{function} +% +% \begin{function}{\printgfdltext} +% This text prints the entire license text. In default +% settings this command is run after the last page of the +% document. With option |manual|, the user is free to use +% it anywhere, but not using it will produce an error. +% \end{function} +% +% \subsection{Options} +% \label{opts} +% +% \begin{function}{manual} +% By default the package prints the copyright-notice along +% with the license-text of GFDL in the document by +% default. The former is printed at the bottom of the +% first page whereas the latter is printed just after the +% last page. If anyone wants to suppress this behavior \& +% print both of these things anywhere in the document with +% \cs{printgfdlnotice} \& \cs{printgfdltext} as documented +% earlier. +% \end{function} +% +% \subsubsection{Legacy support} +% +% The following options are just for legacy support \& +% should be avoided for newer works. It is advised to use +% these options only when the document demands certain old +% conventions which are obsolete these days. +% +% \begin{function}{(C)} +% The \textcopyright\ symbol was at times written as (C) +% \& if someone needs to use this style, then they can use +% this package-option. The package essentially prints this +% symbol at two places. One in the actual PDF text \& one +% in it's metadata. At both of these places users will see +% the change if this option is used. By default this +% option is inactive. +% \end{function} +% +% \begin{function}{version} +% \begin{syntax} +% |version|=\marg{version-number}\hfill ^^A +% |1.1|, |1.2| \textit{or} \textcolor{myred}{|1.3|} +% \end{syntax} +% 1.3 is the current version of GFDL, but there were two +% old versions before it (i.e., 1.2 \& 1.1). By default +% the latest version is used, but with this package +% option, users can select previous versions too. It is +% important to note that as of now this option does +% \emph{not} allow any other value than |1.1|, |1.2| \& +% \textcolor{myred}{|1.3|}. +% +% If a newer version is released by the FSF, the default +% behavior of the package will most likely change to +% produce the latest version of GFDL at that time. In that +% case recompiling an old document with the new version of +% this package will break your documents, but as a +% developer I find that incompatibility reasonable \& +% desirable, because I believe using the newer versions of +% this license will only help the cause for which hackers +% are fighting. +% \end{function} +% \end{documentation} +% +% \begin{implementation} +% \section{Implementation} +% +% Provide package with its basic information. +% +% \begin{macrocode} +%<*package> +\ProvidesPackage{gfdl}[2023/01/01 v0.1 +For using the GFDL in LaTeX.] +% \end{macrocode} +% +% Load necessary packages. +% +% \begin{macrocode} +\RequirePackage{float} +\RequirePackage{expkv-def,expkv-opt} +% \end{macrocode} +% +% Define conditionals which we will be using in the package +% \& set some initial values for them. +% +% The package issues a warning if copyright-holders aren't +% declared \& it doesn't print the GFDL-notice in this case, +% because a copyright-notice without copyright-holders makes +% no sense. The following conditional is at work for this. +% +% \begin{macrocode} +\newif\ifgfdl@copyrightholdersgiven +\gfdl@copyrightholdersgivenfalse +% \end{macrocode} +% +% With the following code we first define various internal +% conditionals which we require. We also set their initial +% values here. +% +% \begin{macrocode} +\newif\ifgfdl@copyrightableyearsgiven +\gfdl@copyrightableyearsgivenfalse +\newif\ifgfdl@copyrightedmaterialdesc +\gfdl@copyrightedmaterialdescfalse +\newif\ifgfdl@licensetextnotprinted +\gfdl@licensetextnotprintedtrue +\newif\ifgfdl@noticenotprinted +\gfdl@noticenotprintedtrue +% \end{macrocode} +% +% Define package options with \pkg{expkv}. +% +% \begin{macrocode} +\ekvdefinekeys{gfdl}{ +% \end{macrocode} +% +% \begin{macro}{manual} +% +% The |invbool| type is used to define package option +% |manual|\footnote{Read the documentation of \pkg{expkv} +% for explanation.}. We define the conditional +% |\ifgfdl@printgfdl| with it. +% +% \begin{macrocode} + invbool manual = {\ifgfdl@printgfdl}, +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{(C)} +% +% The following code defines the package option |(C)| +% which defines an internally used conditional +% |\ifgfdl@bracketedcopyright|. The default value of this +% conditional is false. +% +% \begin{macrocode} + bool (C) = {\ifgfdl@bracketedcopyright}, +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{version} +% +% The following code develops the option |version| which +% takes three options seen in the documentation. By using +% the |initial| key-type, we set the initial value of this +% option to |1.3|. +% +% \begin{macrocode} + choice version = {% + 1.1 = {\def\gfdl@version{1p1}},% + 1.2 = {\def\gfdl@version{1p2}},% + 1.3 = {\def\gfdl@version{1p3}}% + }, + initial version = {1.3} +} +% \end{macrocode} +% \end{macro} +% +% After developing all the options, we set process them with +% the following code. +% +% \begin{macrocode} +\ekvoProcessLocalOptions{gfdl} +% \end{macrocode} +% +% We have used the |bool| type from \pkg{expkv} for +% developing the package option |(C)|. It defines the +% conditional |\ifgfdl@bracketedcopyright| which is by +% default false. We use an internal macro, i.e., +% |\gfdl@copyrightsymbol| for printing the copyright symbol +% with the following code. We |\let| it be |\textcopyright| +% when the aforementioned conditional is false \& it is +% defined as |(C)| when the conditional is true (i.e., when +% the option is explicitly used by the user). +% +% \begin{macrocode} +\ifgfdl@bracketedcopyright + \def\gfdl@copyrightsymbol{(C)}% +\else + \let\gfdl@copyrightsymbol\textcopyright +\fi +% \end{macrocode} +% +% \begin{macro}{\gfdlcopyrightdescription} +% The following |\NewDocumentCommand| is used to develop +% this command. +% \begin{macrocode} +\NewDocumentCommand{ \gfdlcopyrightdescription }{ m }{% + \def\@copyrightedmaterialdesc{#1}% + \gfdl@copyrightedmaterialdesctrue +} +% \end{macrocode} +% \end{macro} +% \begin{macro}{\gfdlcopyrightableyears} +% For this command we have the following code. +% \begin{macrocode} +\NewDocumentCommand{ \gfdlcopyrightableyears }{ m }{% + \def\@copyrightableyears{#1}% + \gfdl@copyrightableyearsgiventrue +} +% \end{macrocode} +% \end{macro} +% \begin{macro}{\gfdlcopyrightholders} +% And lastly, we have this command coded as follows. +% \begin{macrocode} +\NewDocumentCommand{ \gfdlcopyrightholders }{ m }{% + \def\@copyrightholders{#1}% + \gfdl@copyrightholdersgiventrue +} +% \end{macrocode} +% \end{macro} +% We issue a warning when copyright-able years are not +% given. The following code generates the warning. We define +% the internal macro containing the copyright-able years as +% |??| in bold font here itself. +% \begin{macrocode} +\AddToHook{begindocument/before}{% + \ifgfdl@copyrightableyearsgiven + \else + \def\@copyrightableyears{\textbf{??}}% + \PackageWarningNoLine{gfdl}{% + Copyright-able years not given. I can't print the + \MessageBreak + copyright notice without them. To give me this + \MessageBreak + information use the \string\gfdlcopyrightableyears\space + command.\MessageBreak Using `??' as a placeholder% + }% + \fi +% \end{macrocode} +% The following code is used to check if user has given +% information about copyright-holders. If not, then we issue +% a warning with this code \& again define the internal +% macro containing this information as bold |??|. +% \begin{macrocode} + \ifgfdl@copyrightholdersgiven + \else + \def\@copyrightholders{\textbf{??}}% + \PackageWarningNoLine{gfdl}{% + Copyright-holders not given. I can't print the + \MessageBreak + copyright notice without them. To give me this + \MessageBreak + information use the \string\gfdlcopyrightholders\space + command.\MessageBreak Using `??' as a placeholder% + }% + \fi +% \end{macrocode} +% +% With default settings of this package, \pkg{hyperref}, +% \pkg{csquotes} \& \pkg{hyperxmp} are loaded, but to avoid +% potential conflicts, we load them conditionally. With the +% following code this is achieved. +% +% \begin{macrocode} + \@ifpackageloaded{csquotes}{}{% + \RequirePackage{csquotes}% + }% + \@ifpackageloaded{hyperref}{}{% + \RequirePackage{hyperref}% + }% + \@ifpackageloaded{hyperxmp}{}{% + \RequirePackage{hyperxmp}% + }% +% \end{macrocode} +% +% For setting the metadata we use the following code. +% +% \begin{macrocode} + \hypersetup{% + pdfcopyright = {% + \ifgfdl@copyrightedmaterialdesc + \@copyrightedmaterialdesc + \textLF + \fi + Copyright + \gfdl@copyrightsymbol\ + \@copyrightableyears\ + \@copyrightholders\textLF + Permission is granted to copy, distribute and/or + modify this document under the terms of the GNU Free + Documentation License, Version 1.3 or any later + version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and + no Back-Cover Texts. A copy of the license is included + in the section entitled “GNU Free Documentation + License”.% + },% + pdflicenseurl = {% + https://www.gnu.org/licenses/fdl-1.3.txt% + }% + }% +} +% \end{macrocode} +% +% Printing the text automatically at the bottom of the first +% page is achieved with the help of a float. It is developed +% using package \pkg{float} for the following commands. +% +% \begin{macrocode} +\newfloat{gfdl@float}{b}{delme} +% \end{macrocode} +% +% \begin{macro}{\printgfdlnotice} +% This command is developed using the following code. +% \begin{macrocode} +\NewDocumentCommand{ \printgfdlnotice }{ }{% + \begin{gfdl@float}[b!] + \hrule\medskip + \ifgfdl@copyrightedmaterialdesc + \@copyrightedmaterialdesc\par + \fi + Copyright + \gfdl@copyrightsymbol\ + \@copyrightableyears\ + \@copyrightholders + + Permission is granted to copy, distribute and/or modify + this document under the terms of the GNU Free + Documentation License, Version 1.3 or any later version + published by the Free Software Foundation; with no + Invariant Sections, no Front-Cover Texts, and no + Back-Cover Texts. A copy of the license is included in + the section entitled \enquote{% + GNU Free Documentation License% + }.% + \end{gfdl@float}% + \gfdl@noticenotprintedfalse +} +% \end{macrocode} +% \end{macro} +% +% We use |\printgfdlnotice| at the first page of the +% document with the following code. +% +% \begin{macrocode} +\AddToHook{begindocument/end}{% + \ifgfdl@printgfdl + \printgfdlnotice + \fi +} +% \end{macrocode} +% +% \begin{macro}{\printgfdltext} +% +% The following code is used to define this command. +% +% \begin{macrocode} +\NewDocumentCommand{ \printgfdltext }{ }{% + \input{gfdl-tex-\gfdl@version.tex}% + \gfdl@licensetextnotprintedfalse +} +% \end{macrocode} +% \end{macro} +% +% In default settings the entire license text is printed +% with the following code. +% +% \begin{macrocode} +\AddToHook{enddocument}{% + \ifgfdl@printgfdl + \newpage + \phantomsection + \addcontentsline{toc}{section}{% + GNU Free Documentation License% + }% + \printgfdltext + \fi + \ifgfdl@noticenotprinted + \PackageError{gfdl}{% + You didn't print the copyright notice% + }{% + You are in the `manual' mode of the GFDL package and + hence you\MessageBreak are supposed to print the + copyright notice at a suitable place\MessageBreak of + your choice, but you haven't printed it at all. This + violates\MessageBreak the requirement of the GFDL. To + print it use:\MessageBreak + \space\space\string\printgfdlnotice.% + }% + \fi + \ifgfdl@licensetextnotprinted + \PackageError{gfdl}{% + You didn't print the license text% + }% + {% + You are in the `manual' mode of the GFDL package and hence you% + \MessageBreak + are supposed to print the full license text at a suitable place% + \MessageBreak + of your choice, but you haven't printed it at all. This violates% + \MessageBreak + the requirement of the GFDL. To print it use:% + \MessageBreak + \space\space\string\printgfdltext.% + }% + \fi +} +% \end{macrocode} +% +% This is the end of the package. +% +% \begin{macrocode} +%</package> +% \end{macrocode} +% \end{implementation} +% \Finale
\ No newline at end of file diff --git a/macros/latex/contrib/gfdl/gfdl.ins b/macros/latex/contrib/gfdl/gfdl.ins new file mode 100644 index 0000000000..e8bae2e677 --- /dev/null +++ b/macros/latex/contrib/gfdl/gfdl.ins @@ -0,0 +1,46 @@ +% File: linguistix.ins +\input l3docstrip.tex + +\keepsilent +\askforoverwritefalse + +\preamble +---------------------------------------------------------- +Package: gfdl +Version: v0.1 (January 1, 2023) +Author: निरंजन +Description: Enhanced support for linguistics. +Repository: https://puszcza.gnu.org.ua/projects/gfdl +License: GPLv3+, GFDLv1.3+ +---------------------------------------------------------- + +The LaTeX package gfdl v0.1 +Copyright © 2022, 2023 निरंजन + +This program is free software: you can redistribute it +and/or modify it under the terms of the GNU General Public +License as published by the Free Software Foundation, either +version 3 of the License, or (at your option) any later +version. + +This program is distributed in the hope that it will be +useful, but WITHOUT ANY WARRANTY; without even the implied +warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR +PURPOSE. See the GNU General Public License for more +details. + +You should have received a copy of the GNU General Public +License along with this program. If not, see +<https://www.gnu.org/licenses/>. +---------------------------------------------------------- +\endpreamble +\usedir{tex/latex/\jobname} +\generate{% + \file{\jobname.sty}{\from{\jobname.dtx}{package}}% +} +\nopreamble\nopostamble +\usedir{doc/latex/\jobname} +\generate{% + \file{README.txt}{\from{\jobname.dtx}{readme}}% +} +\endbatchfile diff --git a/macros/latex/contrib/gfdl/gfdl.pdf b/macros/latex/contrib/gfdl/gfdl.pdf Binary files differnew file mode 100644 index 0000000000..f240daaa63 --- /dev/null +++ b/macros/latex/contrib/gfdl/gfdl.pdf diff --git a/macros/latex/contrib/keyvaltable/README.md b/macros/latex/contrib/keyvaltable/README.md index a20a945be4..9422f8cf9d 100644 --- a/macros/latex/contrib/keyvaltable/README.md +++ b/macros/latex/contrib/keyvaltable/README.md @@ -3,7 +3,7 @@ The keyvaltable Package Copyright (C) 2016-2020 Richard Grewe -Released under the [LaTeX Project Public License](http://www.latex-project.org/lppl/) version 1.2 or later +Released under the [LaTeX Project Public License](http://www.latex-project.org/lppl/) version 1.3c or later ## Purpose @@ -52,19 +52,15 @@ might be. To build the documentation of the `keyvaltable` package, you additionally need the following classes and packages (including their dependencies) -* ltxdoc -* idxlayout -* xcolor -* showexpl -* enumitem -* xkeyval -* booktabs -* longtable -* tabu -* etoolbox -* hypdoc +* rgltxdoc +* etoc +* amssymb, gensymb, fontawesome +* xspace * xintexpr -* makecell +* makecell, cellspace +* tabularx, longtable, xltabular, tabu +* filecontents +* datatool, csvsimple as well as * pdflatex diff --git a/macros/latex/contrib/keyvaltable/keyvaltable.dtx b/macros/latex/contrib/keyvaltable/keyvaltable.dtx index f68b0bf67c..1f98c35c29 100644 --- a/macros/latex/contrib/keyvaltable/keyvaltable.dtx +++ b/macros/latex/contrib/keyvaltable/keyvaltable.dtx @@ -3,15 +3,15 @@ % Copyright (C) 2016-2020 by Richard Grewe <r-g+tex@posteo.net> % ------------------------------------------------------- % -% This file may be distributed and/or modified under the -% conditions of the LaTeX Project Public License, either version 1.2 +% Thie file may be distributed and/or modified under the +% conditions of the LaTeX Project Public License, either version 1.3c % of this license or (at your option) any later version. -% The latest version of this license is in: +% The latest version of this license is in +% https://www.latex-project.org/lppl.txt +% and version 1.3c or later is part of all distributions of LaTeX +% version 2008 or later. % -% http://www.latex-project.org/lppl.txt -% -% and version 1.2 or later is part of all distributions of LaTeX -% version 1999/12/01 or later. +% This file has the LPPL maintenance status "maintained". % % \fi % @@ -22,7 +22,7 @@ %<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01] %<package>\ProvidesPackage{keyvaltable} %<*package> - [2020/04/05 v2.2 Package for filling tables using key-value lists] + [2020/08/09 v2.3 Package for filling tables using key-value lists] %</package> % %<*driver> @@ -37,7 +37,7 @@ \newcommand\thispackage{\pkgname{keyvaltable}\xspace} % the following packages are additional for the examples \usepackage{xintexpr} -\usepackage{makecell} +\usepackage{makecell,cellspace} \usepackage{gensymb}% for \degree \usepackage{tabularx,longtable,xltabular,tabu} \usepackage{filecontents} @@ -57,11 +57,13 @@ % \usepackage{fontawesome} \makeatletter -\newcommand\NiceText[2]{% +\newenvironment{NiceText}[2]{% \medskip\par\noindent - \rgltxdoc@inmargin{\smash{\textcolor{#1}{\Large#2}}}{\quad}} -\newcommand\NiceNote{\NiceText{DarkBlue}{\faInfoCircle}} -\newcommand\NiceTipp{\NiceText{Gold}{\faLightbulbO}} + \rgltxdoc@inmargin{\smash{\textcolor{#1}{\large#2}}}{\quad}% + \ignorespaces}{\medskip\par\noindent} +\newenvironment{NiceNote}{\NiceText{DarkBlue}{\faInfoCircle}}{\endNiceText} +\newenvironment{NiceTipp}{\NiceText{DarkBlue}{\faLightbulbO}}{\endNiceText} +\newenvironment{NiceWarn}{\NiceText{DarkBlue}{\faWarning}}{\endNiceText} % \end{macrocode} \makeatother % @@ -186,10 +188,12 @@ cherries,50g,cherries,heat up and add to bowl % used in the general case and how its visual appearance can be % customized is subject of the remainder of this documentation. % -% \NiceTipp{To quickly sketch a table type, one can even omit properties -% of columns and just list their names, separated by semicolons, as the -% following example shows. All columns then get the default alignment: -% |l|.} +% \begin{NiceTipp} +% To quickly sketch a table type, one can even omit properties +% of columns and just list their names, separated by semicolons, as the +% following example shows. All columns then get the default alignment: +% |l|. +% \end{NiceTipp} % \begin{LTXexample} % \NewKeyValTable{Recipe}{amount;ingredient;step} % \begin{KeyValTable}{Recipe} @@ -234,12 +238,14 @@ cherries,50g,cherries,heat up and add to bowl % the cell. Initially (i.e., if unset for a column), this is an % empty string. % -% \NiceDescribeKey{format}{vals=\vmeta{single argument macro}, init=\cmd{\kvtStrutted}} +% \NiceDescribeKey{format}{vals=\vmeta{single argument macro}, init=\vmeta{"identity"}} % This property specifies a formatting macro for content of the cell. % The macro can take one argument and is provided with the content of % the cell as its argument. Initially, the format is defined to take -% the content as is but puts a \cmd{\strut} before and after the -% content (to yield a better vertical row spacing). +% the content as is.\footnote{Prior to version~2.3 of \thispackage, +% the initial format setting was to put \cmd{\strut} before and after +% the content to yield a better vertical row spacing in some +% situations. See also \cref{sec:VertSpacing}.} % % \NiceDescribeKey{head}{vals=\vmeta{content}, init=\vmeta{colname}} % This property specifies the \meta{content} of the column's header @@ -455,7 +461,7 @@ cherries,50g,cherries,heat up and add to bowl % \begin{LTXexample}[morekeywords={thekvtRow,thekvtTypeRow}] % \NewKeyValTable[headformat=\textbf]{Numbered}{ % line: align=r, head=\#, -% format=\kvtStrutted[\textbf], +% format=\textbf, % default=\thekvtRow; % text: align=l, head=Text} % \begin{KeyValTable}{Numbered} @@ -491,7 +497,7 @@ cherries,50g,cherries,heat up and add to bowl % % \begin{LTXexample}[morekeywords={uncounted}, % morepreset={\NewKeyValTable[headformat=\textbf]{Numbered}{ -% line: align=r,head=\#,format=\kvtStrutted[\textbf],default=\thekvtRow; +% line: align=r,head=\#,format=\textbf,default=\thekvtRow; % text: align=l,head=Text}}] % \begin{KeyValTable}{Numbered} % \Row{text=First row} @@ -542,10 +548,12 @@ cherries,50g,cherries,heat up and add to bowl % % \subsection{Referencing in Collected Rows}\label{sec:referencing} % -% The example in \cref{sec:collected} illustrates well a situation in -% which referencing the locations in the document at which rows are -% collected. The following example augments the original example to -% achieve exactly this. +% The previous sections show examples of referencing row numbers. +% In tables of collected rows, it may be desirable to reference the +% point in the document at which a row was collected. +% The example in \cref{sec:collected} illustrates such a situation. +% In the following, we augment that example by references to section and +% page numbers. % % \begin{LTXexample}[width=0.5\hsize,morekeywords={NewCollectedTable,CollectRow,ShowCollectedTable}] % \NewKeyValTable{Notes2}{ @@ -566,13 +574,34 @@ cherries,50g,cherries,heat up and add to bowl % Lorem ipsum dolor sit amet, \ldots % \end{LTXexample} % -% The \thispackage package is carefully designed to take the values of -% counters such as the page counter and the section counter from the -% point in the document where |\CollectRow| is used. -% At the same time, the table row counters are taken from the point -% inside the respective table. This applies to |\thekvtRow| as well as -% to |\arabic{kvtRow}| and other counter formats. -% For customizing this behavior, the following three macros can be used. +% The above example demonstrates that the correct section number is +% referenced. Since the whole example is contained on a single page, the +% example does not demonstrate that the page number (|\thepage|) in the +% "where" column actually references the page in the document on which +% the |\CollectRow| takes place. Note that the correct page will be +% produced even when the |\CollectRow| is placed in a float, such as a +% figure or table. +% \begin{NiceWarn} +% \hologo{LaTeX} internally implements a special treatment of +% |\thepage| to make page references possible. For this reason, using +% something like |\arabic{page}| to produce the page number will +% presumably not work correctly. +% \end{NiceWarn} +% +% The \thispackage package +% \begin{itemize}[nosep] +% \item takes the values of row counters (like |\thekvtRow|) from the +% position of \emph{the row in the table} +% but +% \item takes the values of other counters such as the page counter and +% the section counter from the \emph{point in the document where +% \cmd{\CollectRow} is used}. +% \end{itemize} +% This takes into account that counter values can be obtained via +% \cmd{\the\meta{ctrname}} (like |\thekvtRow| or |\thepage|) as well as +% via macros like |\arabic|, |\roman| etc. +% The following macros allow for declaring additional counters and +% formatting macros to be taken into account by \thispackage. % % \NiceDescribeMacros{2} % {\kvtDeclareTableMacros}{\marg{macro-list}} @@ -663,8 +692,9 @@ cherries,50g,cherries,heat up and add to bowl % value |true| hides the rules and the value |false| causes the rules to % be drawn. % Note that both properties only affect the rules that \thispackage -% produces automatically; rules manually added, e.g., via |\hline| or -% |\midrule| are not affected by the properties. +% produces automatically; rules manually added, e.g., via |\hline|, +% |\midrule|, or |\MidRule| (see Section~\ref{sec:rules}) are not +% affected by the properties. % % \NiceDescribeKey{headalign}{vals={\vmeta{empty} or \vmeta{coltype}}, init=\vmeta{empty}} % This property specifies the alignment for header cells. If left @@ -783,11 +813,13 @@ cherries,50g,cherries,heat up and add to bowl % \end{KeyValTable} % \end{LTXexample} % -% \NiceNote{The \meta{options} in |\kvtNewTableStyle| can be left empty. -% In this case, the table style does not have any effect on the appearance -% of tables. However, the style can already be used for "tagging" tables -% and table types, while the final options for the style can be -% configured at a later point in time.} +% \begin{NiceNote} +% The \meta{options} in |\kvtNewTableStyle| can be left +% empty. In this case, the table style does not have any effect on the +% appearance of tables. However, the style can already be used for +% "tagging" tables and table types, while the final options for the +% style can be configured at a later point in time. +% \end{NiceNote} % % Even without table styles, the appearance of the previous % |KeyValTable| can be used again through the following option. @@ -807,17 +839,6 @@ cherries,50g,cherries,heat up and add to bowl % % Column appearance is configured through the parameters |align|, % |head|, |format|, and |default| of columns in |\NewKeyValTable|. -% For the |format|, the following macro exists to ensure proper height -% and depth of rows even if the content itself is more narrow. -% -% \NiceDescribeMacro{\kvtStrutted}{\oarg{inner}\marg{arg}} -% This macro places a |\strut| before \meta{arg} and a |\strut| after -% \meta{arg}. This has the effect that the first and last row of -% \meta{arg} obtain a "natural" height and depth even if their content -% is smaller. -% The second |\strut| is omitted when it would cause a new line to be -% produced. -% See \cref{sec:row-numbering} for an example. % % % \subsection{Row Appearance}\label{sec:RowOptions} @@ -871,20 +892,11 @@ cherries,50g,cherries,heat up and add to bowl % cells is then set to the values of the table's |headalign|, % |headbg|, and |headformat| properties. % -% \NiceDescribeKeys{3} -% {above}{vals=\vmeta{dimension}, init=\vmeta{empty}} -% {below}{vals=\vmeta{dimension}, init=\vmeta{empty}} -% {around}{vals=\vmeta{dimension}, init=\vmeta{empty}} -% These properties specify extra vertical space above and, -% respectively, below the row. The |around| property is a short-hand -% for setting both, |above| and |below|, to the same value. -% Note that the vertical space is currently not colored with the -% row's background color but with the page's background color. -% The argument, if provided, is directly passed to |\vspace|. -% -% \NiceNote{Initial values for all row options can be set with +% \begin{NiceNote} +% Initial values for all row options can be set with % |\kvtSet{Row/|\meta{option}|=|\meta{value}|}| (see also -% \cref{sec:kvtSet}).} +% \cref{sec:kvtSet}). +% \end{NiceNote} % % The following example demonstrates some of the options. % \begin{LTXexample}[morepreset=\RecipePreset,morekeywords={hidden,above,bg,format}] @@ -900,6 +912,58 @@ cherries,50g,cherries,heat up and add to bowl % \end{KeyValTable} % \end{LTXexample} % +% +% \subsubsection{Vertical Row Size \& Spacing}\label{sec:VertSpacing} +% +% When rows are narrow or appear to be narrow, extra spacing above and +% below can be configured. There are (at least) three options for this. +% +% The first option is to use the following |\Row| options. +% \NiceDescribeKeys{3} +% {above}{vals=\vmeta{dimension}, init=\vmeta{empty}} +% {below}{vals=\vmeta{dimension}, init=\vmeta{empty}} +% {around}{vals=\vmeta{dimension}, init=\vmeta{empty}} +% These properties specify extra vertical space above and, +% respectively, below the row. The |around| property is a short-hand +% for setting both, |above| and |below|, to the same value. +% Note that the vertical space is currently not colored with the +% row's background color but with the page's background color. +% The argument, if provided, is directly passed to |\vspace|. +% +% The second option is to use the row |format| or a column's |format| +% property to insert |\strut| macros around cell content. +% For the |format|, the following macro exists. +% +% \NiceDescribeMacro{\kvtStrutted}{\oarg{inner}\marg{arg}} +% This macro places a |\strut| before \meta{arg} and a |\strut| after +% \meta{arg}. This has the effect that the first and last row of +% \meta{arg} obtain a "natural" height and depth even if their content +% is smaller. +% The second |\strut| is omitted when it would cause a new line to be +% produced. +% See \cref{sec:row-numbering} for an example. +% +% The third option is using the \pkgname{cellspace} package and its +% column alignments (e.g., |Sl| instead of |l|) along with the configurable dimensions |\cellspacetoplimit| and |\cellspacebottomlimit|. +% The following example shows the second and the third option. +% +% \begin{LTXexample}[morekeywords={cellspace,kvtStrutted,cellspacetoplimit}] +% \usepackage{cellspace} +% \setlength{\cellspacetoplimit}{3pt} +% \NewKeyValTable{VertSpacing}{ +% normal; +% struts: format=\kvtStrutted; +% cellspace: align=Sl; +% } +% \begin{KeyValTable}{VertSpacing} +% \Row{normal=normal size} +% \Row{normal=\large Large} +% \Row{struts=\large Large} +% \Row{cellspace=\large Large} +% \end{KeyValTable} +% \end{LTXexample} +% +% % \subsubsection{Row Styles} % % Rather than specifying properties for individual rows, \thispackage @@ -935,29 +999,86 @@ cherries,50g,cherries,heat up and add to bowl % \end{KeyValTable} % \end{LTXexample} % -% \NiceNote{The \meta{row-options} in |\kvtNewRowStyle| can be left empty. -% In this case, the row style does not have any effect on the appearance -% of rows. However, the style can already be used for "tagging" rows and -% the final options for the style can be configured at a later point in -% time.} +% \begin{NiceNote} +% The \meta{row-options} in |\kvtNewRowStyle| can be left empty. +% In this case, the row style does not have any effect on the appearance +% of rows. However, the style can already be used for "tagging" rows and +% the final options for the style can be configured at a later point in +% time. +% \end{NiceNote} +% % +% \subsubsection{Rules Between Rows}\label{sec:rules} % -% \subsubsection{Rules Between Rows} +% For placing additional horizontal rules between rows, the +% \thispackage package provides the following two macros that are +% available in |KeyValTable| environments. % -% Additional horizontal rules between rows can simply be added by -% placing the respective rule command between |\Row| commands. -% The following example demonstrates this possibility. -% \begin{LTXexample}[morepreset=\RecipePreset,morekeywords={midrule}] +% \NiceDescribeMacro{\MidRule}{\oarg{width}} +% This macro puts a horizontal rule over the full width of the table, +% with line width \meta{width}. The macro puts the same vertical +% spacing above and below the rule, just like |\midrule| of the +% \pkgname{booktabs} package. The difference to |\midrule| is that row +% colors (as specified by the |rowbg| property) are respected. +% The following example demonstrates the use of |\MidRule|. +% +% \begin{LTXexample}[morepreset=\RecipePreset,morekeywords={MidRule}] % \begin{KeyValTable}{Recipe} % \Row{amount=150g, ingredient=ice cream, % step=put into bowl} % \Row{amount= 50g, ingredient=cherries, % step=heat up and add to bowl} -% \midrule +% \MidRule % \Row{step=serve with a smile} % \end{KeyValTable} % \end{LTXexample} % +% \NiceDescribeMacro{\CMidRule}{\oarg{width}\marg{columns}} +% This macro puts horizontal rules below each of the columns in the +% comma-separated list \meta{columns}. This comma-separated list can +% also contain names of column groups. The rules all have line width +% \meta{width}. The outcome is similar to what a set of |\cmidrule|'s +% would produce, except that row colors are respected and that column +% indexes need not be counted. +% The following example demonstrates the use of |\CMidRule|. +% +% \begin{LTXexample}[morekeywords={CMidRule}] +% \NewKeyValTable[headformat=\textbf]{Prices}{ +% part; min: align=r; max: align=r}[ +% headers={min+max: head=price}, +% colgroups={price: span=min+max}] +% \begin{KeyValTable}{Prices} +% \Row{part=engine, min=2500\$, max=3000\$} +% \Row{part=tires, min=500\$, max=700\$} +% \CMidRule[2pt]{price} +% \Row{part=$\Sigma$, min=3000\$, max=3700\$} +% \end{KeyValTable} +% \end{LTXexample} +% +% The following macros are provided for general use, in +% normal table environments. +% \newcommand\kvtparg[1]{\texttt{(}\meta{#1}\texttt{)}}% +% \NiceDescribeMacros{4} +% {\kvtRuleTop}{\oarg{width}\marg{color2}} +% {\kvtRuleBottom}{\oarg{width}\marg{color1}} +% {\kvtRuleMid}{\oarg{width}\marg{color1}\marg{color2}} +% {\kvtRuleCMid}{\oarg{width}\kvtparg{trim}\marg{a-b}\marg{color1}\marg{color2}} +% These macros are replacements for the macros |\toprule|, +% |\bottomrule|, |\midrule|, and |\cmidrule| of the \pkgname{booktabs} +% package, which do not integrate well with background colors of rows. +% The arguments \meta{color1} and \meta{color2} take the background +% color above and, respectively, below the rule. +% +% Note that while multiple |\cmidrule|s can follow each other and +% produce rules at the same horizontal position, this is not possible +% with |\kvtRuleCMid|. Instead, if multiple |\kvtRuleCMid|s are desired, +% one can use the following macro: +% \NiceDescribeMacro{\kvtRulesCMid}{\oarg{width}\marg{rlist}\marg{color1}\marg{color2}} +% In this macro, \meta{rlist} is a comma-separated list of +% "\kvtparg{trim}\marg{a-b}" pairs, where each \meta{trim} is optional. +% Consider the \pkgname{booktabs} documentation for more information +% about \meta{trim}. +% % % \subsection{Cell Appearance} % @@ -1043,23 +1164,23 @@ cherries,50g,cherries,heat up and add to bowl % The second example shows how multiple header rows can be specified % and, particularly, how the normal column headers can be displayed % through the use of "|::|". -% \begin{LTXexample}[width=0.475\hsize] -% \NewKeyValTable{Headers2}{ -% date: align=r, head=\textbf{date}; -% min/Berlin: align=r, head=min; -% max/Berlin: align=r, head=max; -% min/Paris: align=r, head=min; -% max/Paris: align=r, head=max; -% }[headers={ -% min/Berlin+max/Berlin+min/Paris+max/Paris: -% head=\textbf{temperature}\\ -% min/Paris+max/Paris: head=\textbf{Paris}; -% min/Berlin+max/Berlin: head=\textbf{Berlin}\\ -% ::} -% ] +% \begin{LTXexample}[width=0.5\hsize] +% \NewKeyValTable[headformat=\textbf,headalign=c] +% {Headers2}{ +% date: align=r, head=date; +% Berlin/min: align=r, head=min; +% Berlin/max: align=r, head=max; +% Paris/min: align=r, head=min; +% Paris/max: align=r, head=max; +% }[headers={ +% Berlin/min+Berlin/max+Paris/min+Paris/max: +% head=temperature\\ +% Paris/min+Paris/max: head=Paris, underline; +% Berlin/min+Berlin/max: head=Berlin, underline\\ +% ::}] % \begin{KeyValTable}{Headers2} % \Row{date=01.01.1970, -% min/Berlin=0\degree C, max/Berlin=...} +% Berlin/min=0\degree C, Berlin/max=...} % \end{KeyValTable} % \end{LTXexample} % @@ -1100,6 +1221,11 @@ cherries,50g,cherries,heat up and add to bowl % The initial value for this property is the column specification, % i.e., "\meta{col}|+|\ldots|+|\meta{col}". % +% \NiceDescribeKey{underline}{vals={true,false}, init=false, def=true} +% This property specifies whether the header cell shall be underlined, +% to visually indicate that the columns in the header cell form a +% logical group. +% % % \subsection{Column Spanning} % @@ -1123,7 +1249,7 @@ cherries,50g,cherries,heat up and add to bowl % step=put into bowl} % \Row{amount= 50g, ingredient=cherries, % step=heat up and add to bowl} -% \midrule +% \MidRule % \Row{all=serve with a smile} % \end{KeyValTable} % \end{LTXexample} @@ -1145,14 +1271,16 @@ cherries,50g,cherries,heat up and add to bowl % % \NiceDescribeKeys{2} % {align}{vals={\vmeta{alignment-letter},\vmeta{empty}}, init=c} -% {format}{vals=\vmeta{single argument macro}, init=\cmd\kvtStrutted} +% {format}{vals=\vmeta{single argument macro}, init=\vmeta{"identity"}} % These properties are analogous to the respective properties of normal % columns. The only difference is that the initial column alignment of % column groups is "|c|" while the alignment of normal columns is "|l|". % -% \NiceNote{Initial values for all the |align| and |format| options can be +% \begin{NiceNote} +% Initial values for all the |align| and |format| options can be % set with |\kvtSet|, via the |ColGroup/align| and, respectively -% |ColGroup/format| keys (see also \cref{sec:kvtSet}).} +% |ColGroup/format| keys (see also \cref{sec:kvtSet}). +% \end{NiceNote} % % % \subsubsection{Manual Column Spanning} @@ -1285,11 +1413,11 @@ cherries,50g,cherries,heat up and add to bowl % \begin{KeyValTable}{ShapeProps} % \Row{shape=onepage, env=tabular/tabularx, multipage=no, caption=no, Xcols=yes, width=yes, align=v, packages=tabularx} % \Row{shape=multipage, env=longtable/xltabular, multipage=yes, caption=yes, Xcols=yes, width=yes, align=h, packages={longtable, xltabular}} -% \midrule +% \MidRule % \noalign{\footnotesize with package option |compat=1.0|:} % \Row{shape=onepage, env=tabu, multipage=no, caption=no, Xcols=yes, width=yes, align=v, packages=tabu} % \Row{shape=multipage, env=longtabu, multipage=yes, caption=yes, Xcols=yes, width=yes, align=h, packages={tabu, longtable}} -% \midrule +% \MidRule % \Row{ env=tabular, multipage=no, caption=no, Xcols=no, width=no, align=v} % \Row{ env=tabularx, multipage=no, caption=no, Xcols=yes, width=yes, align=v, packages={tabularx}} % \Row{ env=longtable, multipage=yes, caption=yes, Xcols=no, width=no, align=h, packages={longtable}} @@ -1539,9 +1667,8 @@ cherries,50g,cherries,heat up and add to bowl % \item support for different headers on the first page vs.\@ on % subsequent pages of a multipage table; support configurable spacing % between and above/below header rows -% \item support for more flexibility with regards to captions position -% (top vs.\@ bottom) and distinct captions on first/middle/last page -% of the table. +% \item support for more flexibility with regards to specifying +% distinct captions on first/middle/last page of the table. % \item improved row coloring that makes sure that the alternation % re-starts on continued pages of a table that spans several pages % \item rerun detection for recorded rows (possibly via @@ -1573,11 +1700,14 @@ cherries,50g,cherries,heat up and add to bowl \RequirePackage{xkeyval} \RequirePackage{trimspaces} % \end{macrocode} -% We use \pkgname{booktabs} for nice horizontal lines and -% \pkgname{xcolor} for row coloring. +% We use \pkgname{booktabs} for nice horizontal lines, +% \pkgname{colortbl} for row coloring, and \pkgname{xcolor} for color +% names. To avoid package option clashes with \pkgname{xcolor}, we +% load it at the end of the preamble.. +% \changes{v2.3}{2020/06/13}{Delayed loading of \pkgname{xcolor}} % \begin{macrocode} -\PassOptionsToPackage{table}{xcolor} -\RequirePackage{xcolor} +\RequirePackage{colortbl} +\AtBeginDocument{\@ifpackageloaded{xcolor}{}{\RequirePackage{xcolor}}} \RequirePackage{booktabs} % \end{macrocode} % @@ -1928,6 +2058,8 @@ cherries,50g,cherries,heat up and add to bowl \csdef{kvt@@hdcell@head@\kvt@@hdcell}{#1}} \define@key[kvt]{HeadCell}{align}{% \csdef{kvt@@hdcell@align@\kvt@@hdcell}{#1}} +\define@boolkey[kvt]{HeadCell}{underline}[true]{% + \csdef{kvt@@hdcell@underline@\kvt@@hdcell}{#1}} \kvt@def@globalopts{HeadCell}{align} % \end{macrocode} % @@ -1982,6 +2114,7 @@ cherries,50g,cherries,heat up and add to bowl % The following sets the default values for the options. This is done % only after the package is otherwise completely processed, to ensure % that all features are already defined/registered at that point. +% \changes{v2.3}{2020/07/30}{Removed \cmd{\kvtStrutted} from default format} % \begin{macrocode} \AtEndOfPackage{\kvtSet{% rowbg=white..black!10, @@ -1997,7 +2130,7 @@ cherries,50g,cherries,heat up and add to bowl % Column options % \begin{macrocode} default=, - format=\kvtStrutted, + format=\@firstofone, align=l, head=, hidden=false, @@ -2009,7 +2142,7 @@ cherries,50g,cherries,heat up and add to bowl Row/expand=false, Row/expandonce=false, ColGroup/align=c, - ColGroup/format=\kvtStrutted, + ColGroup/format=\@firstofone, HeadCell/align=c, }} % \end{macrocode} @@ -2066,6 +2199,7 @@ cherries,50g,cherries,heat up and add to bowl \csdef{kvt@alignments@#2}{}% \csdef{kvt@allcolumns@#2}{}% \csdef{kvt@displaycols@#2}{}% + \csdef{kvt@ndisplaycols@#2}{0}% \csdef{kvt@rowcount@#2}{0}% \csdef{kvt@rows@#2}{}% \csdef{kvt@headings@#2}{\kvt@defaultheader}% @@ -2137,6 +2271,8 @@ cherries,50g,cherries,heat up and add to bowl {\csappto{kvt@headings@#1}{{#2}}}% {\cseappto{kvt@headings@#1}{{\csexpandonce{kvt@col@head@#1@#2}}}}% \listcsadd{kvt@displaycols@#1}{#2}% + \csedef{kvt@ndisplaycols@#1}{% + \the\numexpr\csuse{kvt@ndisplaycols@#1}+1\relax}% }% % \end{macrocode} % The following creates the column key that can be used by the row @@ -2263,6 +2399,11 @@ cherries,50g,cherries,heat up and add to bowl \kvt@setkeys{#3}{ColGroup}% \kvt@checkcolgroupcs{kvt@colgrp@span@#1@#2}{#1}{#2}% % \end{macrocode} +% Store the result of |\kvt@checkcolgroupcs| for later use. +% \begin{macrocode} + \csxdef{kvt@colgrp@first@#1@#2}{\kvt@@colgrp@first}% + \csxdef{kvt@colgrp@count@#1@#2}{\kvt@@colgrp@n}% +% \end{macrocode} % The following defines the |\Row| key for \meta{cgname}, as an % abbreviation for setting the value of the first displayed column of % \meta{cgname} (|\kvt@@colgrp@first| to a |\multicolumn| that spans the @@ -2484,15 +2625,20 @@ cherries,50g,cherries,heat up and add to bowl % \end{macrocode} % Initialize variables for the subsequent loop. % The |\kvt@@tmpgrphd| macro collects the code for the cells of the -% current header row. The |\kvt@@span| counter specifies how many -% columns the current cell shall span. +% current header row. +% The |\kvt@@tmpunderline| macro collects the rules (|\cmidrule|-like) +% from header cells, in an \pkgname{etoolbox} list. +% The |\kvt@@span| counter specifies how many columns the current cell +% shall span. % Finally, |\kvt@@curhd| and |\kvt@@lasthd| hold the name of the % header cell in which the current column and, respectively, previous % column are in. Each of the two macros is undefined if there is no % such header cell. % \begin{macrocode} \let\kvt@@tmpgrphd\@empty - \kvt@@span\z@ + \let\kvt@@tmpunderlines\@empty + \letcs\kvt@@tmpncols{kvt@ndisplaycols@#1}% + \kvt@@span\z@ \kvt@@coln\@ne \undef\kvt@@curhd \undef\kvt@@lasthd \kvt@def@atseconduse\kvt@@switchcol{\appto\kvt@@tmpgrphd{&}}% % \end{macrocode} @@ -2521,6 +2667,7 @@ cherries,50g,cherries,heat up and add to bowl consecutive columns, but it is not}% {Compare `\string\kvt@@curhd' to the column ordering as specified in `\string\NewKeyValTable{#1}'}}{}}% + \advance\kvt@@coln\kvt@@span\relax \kvt@@span\@ne \let\kvt@@lasthd\kvt@@curhd}% }\dolistcsloop{kvt@displaycols@#1}% \kvt@concludehdcolumn @@ -2530,6 +2677,12 @@ cherries,50g,cherries,heat up and add to bowl % while ending the current \hologo{TeX} group. % \begin{macrocode} \appto\kvt@@tmpgrphd{\tabularnewline}% + \ifdefempty\kvt@@tmpunderlines{}{% + \eappto\kvt@@tmpgrphd{% + \noexpand\kvtRule@cmid{\noexpand\cmidrulewidth} + {\expandonce\kvt@@tmpunderlines} + {\expandonce\cmdkvt@Table@headbg} + {\expandonce\cmdkvt@Table@headbg}}}% \edef\do{\noexpand\csappto{kvt@@custheadrows@#1}{% \unexpanded{\noexpand\kvt@rowcolorornot{\cmdkvt@Table@headbg}}% \noexpand\unexpanded{\expandonce{\kvt@@tmpgrphd}}}}% @@ -2563,7 +2716,7 @@ cherries,50g,cherries,heat up and add to bowl % collecting counterparts. Header rows as well as manually inserted % rows, including those produced by macros like |\midrule| in a % |longtable| environment, are not counted (as opposed by the internal -% counter of |\rowcolors|. +% counter of |\rowcolors|). % \begin{macrocode} \newcount\kvt@@bodyrow % \end{macrocode} @@ -2572,8 +2725,11 @@ cherries,50g,cherries,heat up and add to bowl % \begin{macro}{\kvt@@span} % The counter |\kvt@@span| is used temporarily in macros for counting % how many columns are spanned by column groups. +% The counter |\kvt@@coln| is used temporarily in macros for counting +% column indexes. % \begin{macrocode} \newcount\kvt@@span +\newcount\kvt@@coln % \end{macrocode} % \end{macro} % @@ -2591,6 +2747,18 @@ cherries,50g,cherries,heat up and add to bowl {\noexpand\cmdkvt@Table@headformat {\csexpandonce{kvt@@hdcell@head@\kvt@@lasthd}}}}% % \end{macrocode} +% The following adds a pair of trim and spanned columns to +% |\kvt@@tmpunderlines| for later drawing all the horizontal rules that +% underline column groups. +% A rule is trimmed left if it's not the first column and +% a rule is trimmed right if it's not the last column. +% \begin{macrocode} + \ifcsstring{kvt@@hdcell@underline@\kvt@@lasthd}{true} + {\listeadd\kvt@@tmpunderlines{% + {\ifnumgreater{\kvt@@coln}{1}{l}{}% + \ifnumless{\kvt@@coln+\kvt@@span-1}{\kvt@@tmpncols}{r}{}}% + {\the\kvt@@coln-\the\numexpr\kvt@@coln+\kvt@@span-1\relax}}}{}% +% \end{macrocode} % Mark the header cell as already used and concluded, such that another % use of the same header cell can be detected and raise an error. % \begin{macrocode} @@ -2701,6 +2869,330 @@ cherries,50g,cherries,heat up and add to bowl % \end{macrocode} % \end{macro} % +% +% \subsection{Rules} +% +% This section exists because drawing rules with proper spacing and +% proper consideration of row background colors requires some effort. +% \changes{v2.3}{2020/08/09}{Made rules aware of row background colors} +% +% \begin{macro}{\kvt@RuleTop} +% The |\kvt@RuleTop| macro produces a |\kvtRuleTop| rule that fits with +% the header background color or, if no headers are shown, the +% alternating row background colors. +% \begin{macrocode} +\newcommand\kvt@RuleTop{\noalign{% + \edef\kvt@@do{\noexpand\kvtRuleTop{\ifbool{kvt@Table@showhead} + {\expandonce\cmdkvt@Table@headbg}{\expandonce\kvt@@bgcolor@odd}}}% + \expandafter}\kvt@@do} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\kvt@RuleBottom} +% The |\kvt@RuleBottom| macro produces a |\kvtRuleBottom| rule that fits +% with the alternating row background colors. +% \begin{macrocode} +\newcommand\kvt@RuleBottom{\noalign{% + \edef\kvt@@do{\noexpand\kvtRuleBottom{\ifnumodd{\the\kvt@@bodyrow} + {\expandonce\kvt@@bgcolor@odd}{\expandonce\kvt@@bgcolor@even}}}% + \expandafter}\kvt@@do} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\kvt@RuleMid} +% The |\kvt@RuleMid|\oarg{wd} macro produces a |\kvtRuleMid| rule that +% fits with the alternating row background colors. +% \begin{macrocode} +\newcommand\kvt@RuleMid{\noalign{\ifnum0=`}\fi + \@ifnextchar[{\kvt@RuleMid@i}{\kvt@RuleMid@i[\lightrulewidth]}} +\long\def\kvt@RuleMid@i[#1]{% + \edef\kvt@@do{\unexpanded{\ifnum0=`{\fi}\kvtRuleMid[{#1}]}% + \ifnumodd{\the\kvt@@bodyrow} + {{\expandonce\kvt@@bgcolor@odd}{\expandonce\kvt@@bgcolor@even}} + {{\expandonce\kvt@@bgcolor@even}{\expandonce\kvt@@bgcolor@odd}}}% + \kvt@@do} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\kvt@RuleSubHead} +% The |\kvt@RuleSubHead| macro is very similar to |\kvt@RuleMid|. +% The latter is to be placed between body rows of a table. +% The former is to be placed between the header row(s) and the body +% rows. +% \begin{macrocode} +\newcommand\kvt@RuleSubHead{\noalign{% + \edef\kvt@@do{\noexpand\kvtRuleMid + {\expandonce\cmdkvt@Table@headbg}{\expandonce\kvt@@bgcolor@odd}}% + \expandafter}\kvt@@do} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\kvt@RuleCMid} +% The |\kvt@RuleCMid|\marg{tname}\oarg{wd}\marg{cglist} macro draws a +% set of horizontal rules for a given comma-separated list of names of +% columns and/or column groups, \meta{cglist}. +% \begin{macrocode} +\newcommand\kvt@RuleCMid[1]{\noalign{\ifnum0=`}\fi + \@ifnextchar[{\kvt@RuleCMid@i{#1}} + {\kvt@RuleCMid@i{#1}[\cmidrulewidth]}} +\long\def\kvt@RuleCMid@i#1[#2]#3{% + \let\kvt@@rules\@empty + \def\kvt@@do##1{% + \ifcsdef{kvt@colgrp@first@#1@##1} + {\kvt@RuleCMid@cg{#1}{##1}} + {\kvt@RuleCMid@cc{#1}{##1}{1}}}% + \forcsvlist\kvt@@do{#3}% +% \end{macrocode} +% The above collected the second argument of |\kvtRule@cmid| in +% |\kvt@@rules|. The remaining lines now add the remaining arguments. +% \begin{macrocode} + \edef\kvt@@rules{\unexpanded{\ifnum0=`{\fi}\kvtRule@cmid}% + {\unexpanded{#2}}% + {\expandonce\kvt@@rules} + \ifnumodd{\the\kvt@@bodyrow} + {{\expandonce\kvt@@bgcolor@odd}{\expandonce\kvt@@bgcolor@even}} + {{\expandonce\kvt@@bgcolor@even}{\expandonce\kvt@@bgcolor@odd}}}% + \kvt@@rules} +% \end{macrocode} +% The |\kvt@RuleCMid@cg|\marg{tname}\marg{colgrp} macro +% takes the first column of \meta{colgrp} and column count of this +% column group and passes them on to |\kvt@RuleCMid@c|. +% \begin{macrocode} +\newcommand\kvt@RuleCMid@cg[2]{\bgroup% + \edef\kvt@@do{\egroup + \unexpanded{\kvt@RuleCMid@c{#1}}% + {\csuse{kvt@colgrp@first@#1@#2}} + {\csuse{kvt@colgrp@count@#1@#2}}}% + \kvt@@do} +% \end{macrocode} +% The |\kvt@RuleCMid@c|\marg{tname}\marg{cname}\marg{count} +% macro determines the index $a$ of column \meta{cname} and adds a rule +% from this column to $a+\meta{count}-1$. +% The |\kvt@RuleCMid@cc| macro takes the same arguments but additionally +% checks whether \meta{cname} is a valid column name. +% \begin{macrocode} +\newcommand\kvt@RuleCMid@cc[3]{% + \ifinlistcs{#2}{kvt@allcolumns@#1} + {\ifinlistcs{#2}{kvt@displaycols@#1} + {\kvt@RuleCMid@c{#1}{#2}{#3}} +% \end{macrocode} +% Rules below known but hidden columns are silently skipped by the below +% line. +% \begin{macrocode} + {}} + {\kvt@error + {Column or column group `#2' for `\string\CMidRule' + not known in table type `#1'} + {Check the \string\NewKeyValTable{#1} for + the names of known columns and check `#2' for a typo.}}} +\newcommand\kvt@RuleCMid@c[3]{% +% \end{macrocode} +% Find index of column \meta{cname} and store it in |\@tempcnta|. +% Fixme: Column indexes could also be precomputed. +% \begin{macrocode} + \@tempcnta\z@ + \def\do##1{\advance\@tempcnta\@ne + \ifstrequal{#2}{##1}{\listbreak}{}}% + \dolistcsloop{kvt@displaycols@#1}% +% \end{macrocode} +% Now add new rule pair (trim and columns) to the list stored in +% |\kvt@@rules|. +% \begin{macrocode} + \listeadd\kvt@@rules{% + {\ifnumgreater{\@tempcnta}{1}{l}{}% + \ifnumless{\@tempcnta+#3-1}{\csuse{kvt@ndisplaycols@#1}}{r}{}}% + {\the\@tempcnta-\the\numexpr\@tempcnta+#3-1\relax}}} +% \end{macrocode} +% \end{macro} +% +% \paragraph{Candidate for separate package.} +% The following macros are independent of the remaining \thispackage +% macros and could be factored out into their own small macro package +% (|kvtrule|?) as a solution to reoccurring questions about row colors +% with \pkgname{booktabs} (e.g., +% \url{https://tex.stackexchange.com/questions/177202/booktabs-and-row-color}). +% +% The macros below act as alternatives to rule macros of the +% \pkgname{booktabs} package. +% The \pkgname{booktabs} rule macros draw horizontal rules with some +% spacing above and below the rule. Their spacing does not take into +% account row colors. +% The replacement macro allow specifying the row color above +% (\meta{c-above}) and below (\meta{c-below}) of rule. +% +% \begin{macro}{\kvtRuleTop} +% The |\kvtRuleTop|\oarg{wd}\marg{c-below} macro acts as a replacement +% macro for \pkgname{booktabs}'s |\toprule|\oarg{wd} macro. +% \begin{macrocode} +\newcommand\kvtRuleTop{\noalign{\ifnum0=`}\fi + \@ifnextchar[{\kvtRuleTop@i}{\kvtRuleTop@i[\heavyrulewidth]}} +\long\def\kvtRuleTop@i[#1]#2{\ifnum0=`{\fi}% + \specialrule{#1}{\abovetopsep}{0pt}% + \kvtRule@ColorRule{#2}{2\belowrulesep}{0pt}{-\belowrulesep}} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\kvtRuleBottom} +% The |\kvtRuleBottom|\oarg{wd}\marg{c-above} macro acts as a +% replacement for \pkgname{booktabs}'s |\bottomrule|\oarg{wd} macro. +% \begin{macrocode} +\newcommand\kvtRuleBottom{\noalign{\ifnum0=`}\fi + \@ifnextchar[{\kvtRuleBottom@i}{\kvtRuleBottom@i[\heavyrulewidth]}} +\long\def\kvtRuleBottom@i[#1]#2{\ifnum0=`{\fi}% + \kvtRule@ColorRule{#2}{\aboverulesep}{0pt}{0pt}% + \specialrule{#1}{0pt}{\belowbottomsep}} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\kvtRuleMid} +% The |\kvtRuleMid|\oarg{wd}\marg{c-above}\marg{c-below} macro acts as a +% replacement for \pkgname{booktabs}'s |\midrule|\oarg{wd} macro. +% \begin{macrocode} +\newcommand\kvtRuleMid{\noalign{\ifnum0=`}\fi + \@ifnextchar[{\kvtRuleMid@i}{\kvtRuleMid@i[\lightrulewidth]}} +\long\def\kvtRuleMid@i[#1]#2#3{\ifnum0=`{\fi}% + \kvtRule@ColorRule{#2}{\aboverulesep}{0pt}{0pt}% + \specialrule{#1}{0pt}{0pt}% +% \end{macrocode} +% For some reason, without the doubling of |\belowrulesep| below, +% there is a white space below the |\specialrule|. (Fixme?) +% \begin{macrocode} + \kvtRule@ColorRule{#3}{2\belowrulesep}{0pt}{-\belowrulesep}} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\kvtRuleCMid} +% The +% |\kvtRuleCMid|\oarg{wd}|(|\meta{trim}|)|\marg{a-b}\marg{c-above}\marg{c-below} +% macro acts as a replacement for \pkgname{booktabs}'s +% |\cmidrule|\oarg{wd}|(|\meta{trim}|)|\marg{a-b} macro. +% \begin{macrocode} +\newcommand\kvtRuleCMid{\noalign{\ifnum0=`}\fi + \@ifnextchar[{\kvtRuleCMid@i}{\kvtRuleCMid@i[\cmidrulewidth]}} +\long\def\kvtRuleCMid@i[#1]{% + \@ifnextchar({\kvtRuleCMid@ii{#1}}{\kvtRuleCMid@ii{#1}()}} +\long\def\kvtRuleCMid@ii#1(#2)#3{\ifnum0=`{\fi}% + \kvtRule@cmid{#1}{{#2}{#3}}} +% \end{macrocode} +% The +% |\kvtRule@cmid|\marg{wd}\marg{r-list}\marg{c-above}\marg{c-below} +% macro does the actual work. +% The \meta{r-list} parameter is a \pkgname{etoolbox} list of pairs +% "\marg{trim}\marg{a-b}". +% \begin{macrocode} +\newcommand\kvtRule@cmid[4]{% +% \end{macrocode} +% The "\meta{wd}/2" (i.e., |#1/2|) occurring twice below "splits" the +% later rule vertically into the upper half (on \meta{c-above} +% background) and the lower half (on \meta{c-below} background). +% \begin{macrocode} + \kvtRule@ColorRule{#3} + {\the\dimexpr\aboverulesep+#1/2\relax} + {0pt} + {\the\dimexpr-#1/2\relax}% +% \end{macrocode} +% Draw the "below" color already here such that the rule can be drawn in +% the middle on top of the "above" and "below" color. +% \begin{macrocode} + \kvtRule@ColorRule{#4} + {\the\dimexpr\belowrulesep+#1/2\relax}{0pt} + {\the\dimexpr-\belowrulesep-#1\relax}% +% \end{macrocode} +% Now collect the rules to be drawn in a single macro |\kvt@@rules|. +% \begin{macrocode} + \noalign{% + \let\kvt@@rules\@empty% + \def\kvt@@do##1{\appto\kvt@@rules{\kvtRule@cmid@i{#1}##1}}% + \forlistloop\kvt@@do{#2}% + \expandafter}% + \kvt@@rules +% \end{macrocode} +% In the spacing below, cancel out the negative spacing from +% |\kvtRule@cmid@i|. +% \begin{macrocode} + \noalign{\vskip\dimexpr\belowrulesep+#1\relax}} +% \end{macrocode} +% +% The |\kvtRule@cmid@i|\marg{wd}\marg{trim}\marg{a-b} macro produces a +% single |\cmidrule|-like rule from a set of such rules. The arguments +% are the same as for |\cmidrule|. +% \begin{macrocode} +\newcommand\kvtRule@cmid@i[3]{% +% \end{macrocode} +% The following three lines locally inject zero |\aboverulesep| into +% |\cmidrule|. Due to grouping within |\@cmidrule|, this is not possible +% for |\belowrulesep|; hence, we have to fix |\belowrulesep| in the +% |\vskip| later in this macro. +% Note that the |\noalign| started below is ended within |\@cmidrule|. +% \begin{macrocode} + \noalign{\ifnum0=`}\fi + \aboverulesep=0pt\relax + \@cmidrule[#1](#2){#3}% +% \end{macrocode} +% The imitates the code from |\xcmidrule| for when further |\cmidrule|s +% follow. It additionally cancels out the superfluous |\belowrulesep| as +% described before. +% \begin{macrocode} + \noalign{% + \vskip-\dimexpr #1+\belowrulesep\relax + \global\@lastruleclass\@ne}} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\kvtRulesCMid} +% The |\kvtRulesCMid|\oarg{width}\marg{r-list}\marg{color1}\marg{color2} +% macro is the user interface for |\kvtRule@cmid| with multiple rules. +% Here, \meta{r-list} is a comma-separated list of optional trim (in +% parentheses) and column range -- and the code below essentially just +% transforms this syntax into the syntax expected by |\kvtRule@cmid|. +% \begin{macrocode} +\newcommand\kvtRulesCMid{\noalign{\ifnum0=`}\fi + \@ifnextchar[{\kvtRulesCMid@i}{\kvtRulesCMid@i[\cmidrulewidth]}} +\long\def\kvtRulesCMid@i[#1]#2#3#4{% + \let\kvt@@rules\@empty + \forcsvlist\kvtRulesCMid@ii{#2}% + \ifnum0=`{\fi\expandafter}\expandafter + \kvtRulesCMid@v\expandafter{\kvt@@rules}{#1}{#3}{#4}} +\newcommand\kvtRulesCMid@ii[1]{\kvtRulesCMid@iii#1\@undefined} +\newcommand\kvtRulesCMid@iii{% + \@ifnextchar({\kvtRulesCMid@iv}{\kvtRulesCMid@iv()}} +\long\def\kvtRulesCMid@iv(#1)#2\@undefined{% + \listadd\kvt@@rules{{#1}{#2}}} +\newcommand\kvtRulesCMid@v[4]{\kvtRule@cmid{#2}{#1}{#3}{#4}} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\kvtRule@ColorRule} +% The |\kvtRule@ColorRule|\marg{color}\marg{wd}\marg{above}\marg{below} +% macro draws a full-width horizontal table rule of width \meta{wd} in +% color \meta{color} and spacing \meta{above} above and \meta{below} +% below the rule. +% If \meta{color} is empty, the current background color is used. +% \begin{macrocode} +\newcommand\kvtRule@ColorRule[4]{% + \ifstrempty{#1} + {\noalign{\expandafter\vskip\the\dimexpr #2+#3+#4\relax}} + {\kvtRule@SaveRuleColor + \arrayrulecolor{#1}% + \specialrule{#2}{#3}{#4}% + \kvtRule@RestoreRuleColor}} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\kvtRule@SaveRuleColor} +% \begin{macro}{\kvtRule@RestoreRuleColor} +% These macros save and, respectively, restore the current rule color, +% as provided by the \pkgname{colortbl} package in |\CT@arc@|. +% \begin{macrocode} +\newcommand\kvtRule@SaveRuleColor{% + \noalign{\global\let\kvt@@ctarc\CT@arc@}} +\newcommand\kvtRule@RestoreRuleColor{% + \noalign{\global\let\CT@arc@\kvt@@ctarc}} +% \end{macrocode} +% \end{macro} +% \end{macro} +% +% % \subsection{Key-Value Table Content} % % \begin{environment}{KeyValTable} @@ -2716,6 +3208,8 @@ cherries,50g,cherries,heat up and add to bowl % \begin{macrocode} \def\Row{\kvt@AddKeyValRow {\noalign\bgroup}{\expandafter\egroup\kvt@@row}{#2}}% + \def\MidRule{\kvt@RuleMid}% + \def\CMidRule{\kvt@RuleCMid{#2}}% % \end{macrocode} % \end{macro} % \begin{macrocode} @@ -2825,7 +3319,7 @@ cherries,50g,cherries,heat up and add to bowl % \begin{macro}{\metatblHasCaption} % \begin{macro}{\metatblCanVAlign} % \begin{macro}{\metatblCanHAlign} -% All macros in the following block expect three arguments, +% The following macros all expect the three arguments % \marg{env-name}\marg{iftrue}\marg{iffalse}. % The macro % |\metatblRegistered| @@ -3000,10 +3494,10 @@ cherries,50g,cherries,heat up and add to bowl \let\kvt@@endhook\@empty \let\kvt@@prehook\@empty \ifbool{kvt@Table@showrules} - {\def\kvt@@rule##1{\csuse{##1rule}}} + {\def\kvt@@rule##1{\csuse{kvt@Rule##1}}} {\def\kvt@@rule##1{}}% - \appto\kvt@@prehook{\kvt@@rule{top}}% - \appto\kvt@@endhook{\kvt@@rule{bottom}}% + \appto\kvt@@prehook{\kvt@@rule{Top}}% + \appto\kvt@@endhook{\kvt@@rule{Bottom}}% % \end{macrocode} % The following saves the row counter value for the table type globally, % such that subsequent tables of the same \meta{tname} can start counting @@ -3039,12 +3533,17 @@ cherries,50g,cherries,heat up and add to bowl {Consider placing the KeyValTable environment inside a 'table' environment and use the \string\caption\space macro inside.}}}% \ifdefstring{\cmdkvt@Table@captionpos}{t} - {\let\kvt@@caption@headmain\kvt@@caption@main\let\kvt@@caption@footmain\@empty - \let\kvt@@caption@headalt\kvt@@caption@alt \let\kvt@@caption@footalt\@empty} - {\let\kvt@@caption@footmain\kvt@@caption@main\let\kvt@@caption@headmain\@empty - \let\kvt@@caption@footalt\kvt@@caption@alt \let\kvt@@caption@headalt\@empty}% + {\let\kvt@@caption@headmain\kvt@@caption@main + \let\kvt@@caption@footmain\@empty + \let\kvt@@caption@headalt\kvt@@caption@alt + \let\kvt@@caption@footalt\@empty} + {\let\kvt@@caption@footmain\kvt@@caption@main + \let\kvt@@caption@headmain\@empty + \let\kvt@@caption@footalt\kvt@@caption@alt + \let\kvt@@caption@headalt\@empty}% \ifbool{kvt@Table@showhead} - {\eappto\kvt@@prehook{\csuse{kvt@headings@#2}\noexpand\kvt@@rule{mid}}} + {\eappto\kvt@@prehook{\csuse{kvt@headings@#2}% + \noexpand\kvt@@rule{SubHead}}} {}% % \end{macrocode} % The following lines perform some checks before the table environment @@ -3161,8 +3660,11 @@ cherries,50g,cherries,heat up and add to bowl % If \meta{colors} is empty, then no row colors are setup. % \begin{macrocode} \newcommand\kvt@setrowcolors[1]{% - \ifstrempty{#1}{}{\kvt@setrowcolors@i#1\@nil}} + \ifstrempty{#1}{\kvt@setrowcolors@ii{}{}} + {\kvt@setrowcolors@i#1\@nil}} \def\kvt@setrowcolors@i#1..#2\@nil{% + \kvt@setrowcolors@ii{#1}{#2}} +\newcommand\kvt@setrowcolors@ii[2]{% \def\kvt@@bgcolor@odd{#1}% \def\kvt@@bgcolor@even{#2}} % \end{macrocode} @@ -3271,7 +3773,7 @@ cherries,50g,cherries,heat up and add to bowl % \end{macrocode} % \end{macro} % -% The following lines define the macros for the various table +% The following lines define the macros for the various table % environments. % \begin{macrocode} \kvt@RegisterBackend{tabular} @@ -3350,9 +3852,9 @@ cherries,50g,cherries,heat up and add to bowl % enabled for the row's cells. % \begin{macrocode} \ifdefvoid\cmdkvt@Row@align - {\let\kvt@@rowmkmulticolumn\@empty} + {\def\kvt@@rowmkmulticolumn{\kvt@unicolumn}} {\edef\kvt@@rowmkmulticolumn{% - \noexpand\multicolumn{1}{\expandonce\cmdkvt@Row@align}}}% + \noexpand\kvt@multicolumn{1}{\expandonce\cmdkvt@Row@align}}}% % \end{macrocode} % The following defines a macro % |\kvt@@cellfmtbuilder|\marg{cmd}\marg{csname}. @@ -3361,7 +3863,7 @@ cherries,50g,cherries,heat up and add to bowl % row formatting options. % Through this "builder" macro, the row format options need only be % considered once and the column format options can then be included -% when the displayed columns are iterated over. +% when the displayed columns are iterated over. % \begin{macrocode} \ifcsvoid{cmdkvt@Row@format!} {\edef\kvt@@cellfmtbuilder##1##2{% @@ -3440,7 +3942,7 @@ cherries,50g,cherries,heat up and add to bowl % \begin{macrocode} \ifcsvoid{kvt@@noformat@#2@##1} {\kvt@@cellfmtbuilder\kvt@@formatter{kvt@@curcolformat}}% - {\let\kvt@@formatter\@firstofone}% + {\let\kvt@@formatter\kvt@unicolumn}% \csundef{kvt@@noformat@#2@##1}% \edef\kvt@@fmtcell{\expandafter\expandonce\expandafter{% \expandafter\kvt@@formatter\expandafter{% @@ -3490,11 +3992,15 @@ cherries,50g,cherries,heat up and add to bowl % Note that the alternative of avoiding the conditional (|\ifdefequal|) % in the above code and using |\@firstofone| instead of |\@empty| for a % noop in \meta{cmd} does not work: -% Using `|\expandonce|\marg{cmd}\marg{arg}' would expand to -% `|\unexpanded\expandafter{\@firstofone}|' and produces the error -% `Argument of |\@firstofone| has an extra |}|'. -% Using `|\expandonce{|\meta{cmd}\marg{arg}|}|' would expand to -% `|\unexpanded|\marg{arg}' and, thus, prevent expansion of \meta{arg}. +% \begin{itemize}[nosep] +% \item Using `|\expandonce|\marg{cmd}\marg{arg}' would, by definition +% of |\expandonce|, expand to +% `|\unexpanded\expandafter{\@firstofone}|' and produces the error +% `Argument of |\@firstofone| has an extra |}|'. +% \item Using `|\expandonce{|\meta{cmd}\marg{arg}|}|' would expand to +% `|\unexpanded|\marg{arg}' and, thus, prevent expansion of +% \meta{arg}. +% \end{itemize} % \end{macro} % % \begin{macro}{\kvt@stepcounters} @@ -3597,9 +4103,27 @@ cherries,50g,cherries,heat up and add to bowl % cell formatting has been applied. % \begin{macrocode} \def\kvt@@cell{#3}% - \def\kvt@@mkmulticolumn{\multicolumn{#2}{#1}}} + \def\kvt@@mkmulticolumn{\kvt@multicolumn{#2}{#1}}} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\kvt@unicolumn} +% \begin{macro}{\kvt@multicolumn} +% The |\kvt@unicolumn|\marg{content} macro is the central macro for +% creating a "normal" (non-multicolumn) cell holding the given +% \meta{content}. +% Analogously, the macro +% |\kvt@multicolumn|\marg{align}\marg{n}\marg{content} +% is the central macro for creating a multi-column cell with +% \meta{content}. +% The two macros are only meant to improve code legibility and to +% simplify certain future modifications. +% \begin{macrocode} +\newcommand\kvt@unicolumn[1]{#1} +\newcommand\kvt@multicolumn[3]{\multicolumn{#1}{#2}{#3}} % \end{macrocode} % \end{macro} +% \end{macro} % % \subsubsection{Table and Row Styles} % @@ -3614,10 +4138,12 @@ cherries,50g,cherries,heat up and add to bowl % specifying \meta{row-options} directly in the optional argument of % |\Row|. The macro fails if \meta{name} is already declared as a row % style. +% \begin{macrocode} +\newcommand\kvtNewRowStyle{\kvt@NewStyle{row}{\kvtRenewRowStyle}} +% \end{macrocode} % The |\kvtRenewRowStyle|\marg{name}\marg{row-options} macro re-defines % an already existing row style with new \meta{row-options}. % \begin{macrocode} -\newcommand\kvtNewRowStyle{\kvt@NewStyle{row}{\kvtRenewRowStyle}} \newcommand\kvtRenewRowStyle{\kvt@RenewStyle{row}{\kvtNewRowStyle}} % \end{macrocode} % \end{macro} @@ -3632,10 +4158,12 @@ cherries,50g,cherries,heat up and add to bowl % specifying \meta{options} directly in the optional argument of % a |KeyValTable| environment or of a |\NewKeyValTable|. The macro fails % if \meta{name} is already declared as a table style. +% \begin{macrocode} +\newcommand\kvtNewTableStyle{\kvt@NewStyle{table}{\kvtRenewTableStyle}} +% \end{macrocode} % The |\kvtRenewTableStyle|\marg{name}\marg{options} macro re-defines % an already existing table style with new \meta{options}. % \begin{macrocode} -\newcommand\kvtNewTableStyle{\kvt@NewStyle{table}{\kvtRenewTableStyle}} \newcommand\kvtRenewTableStyle{\kvt@RenewStyle{table}{\kvtNewTableStyle}} % \end{macrocode} % \end{macro} @@ -3778,8 +4306,8 @@ cherries,50g,cherries,heat up and add to bowl % % \begin{macro}{\CollectRow} % The |\CollectRow|\oarg{options}\marg{cname}\marg{content} writes a -% |\kvt@RecordedRow| entry to the aux file. Fragile parts of -% \meta{content} are protected through |\protected@write|. +% |\kvt@RecordedRow| entry to the aux file, protecting fragile parts of +% \meta{content} through |\protected@write|. % \changes{v2.0}{2019/04/09}{Added the macro} % \begin{macrocode} \newcommand\CollectRow[3][]{% diff --git a/macros/latex/contrib/keyvaltable/keyvaltable.ins b/macros/latex/contrib/keyvaltable/keyvaltable.ins index 077ef3f629..65e5f84159 100644 --- a/macros/latex/contrib/keyvaltable/keyvaltable.ins +++ b/macros/latex/contrib/keyvaltable/keyvaltable.ins @@ -1,15 +1,22 @@ %% %% Copyright (C) 2016-2020 by Richard Grewe <r-g+tex@posteo.net> %% -%% This file may be distributed and/or modified under the conditions of -%% the LaTeX Project Public License, either version 1.2 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.2 or later is part of all distributions of LaTeX version -%% 1999/12/01 or later. +%% This file may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either version 1.3c +%% of this license or (at your option) any later version. +%% The latest version of this license is in +%% https://www.latex-project.org/lppl.txt +%% and version 1.3c or later is part of all distributions of LaTeX +%% version 2008 or later. +%% +%% This file has the LPPL maintenance status "maintained". +%% +%% As this file contains legal notices, it is NOT PERMITTED to modify +%% this file in any way that the legal information placed into +%% generated files is changed (i.e., the files generated when the +%% original file is executed). This restriction does not apply if +%% (parts of) the content is reused in a different WORK producing its +%% own generated files. %% \input docstrip.tex \keepsilent @@ -19,15 +26,22 @@ Copyright (C) 2016-2020 by Richard Grewe <r-g+tex@posteo.net> -This file may be distributed and/or modified under the conditions of -the LaTeX Project Public License, either version 1.2 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.2 or later is part of all distributions of LaTeX version -1999/12/01 or later. +This file may be distributed and/or modified under the +conditions of the LaTeX Project Public License, either version 1.3c +of this license or (at your option) any later version. +The latest version of this license is in + https://www.latex-project.org/lppl.txt +and version 1.3c or later is part of all distributions of LaTeX +version 2008 or later. + +This file has the LPPL maintenance status "maintained". + +As this file contains legal notices, it is NOT PERMITTED to modify +this file in any way that the legal information placed into +generated files is changed (i.e., the files generated when the +original file is executed). This restriction does not apply if +(parts of) the content is reused in a different WORK producing its +own generated files. \endpreamble diff --git a/macros/latex/contrib/keyvaltable/keyvaltable.pdf b/macros/latex/contrib/keyvaltable/keyvaltable.pdf Binary files differindex 255a564925..227ab91534 100644 --- a/macros/latex/contrib/keyvaltable/keyvaltable.pdf +++ b/macros/latex/contrib/keyvaltable/keyvaltable.pdf diff --git a/macros/latex/contrib/proflycee/doc/ProfLycee-doc.pdf b/macros/latex/contrib/proflycee/doc/ProfLycee-doc.pdf Binary files differindex 17413e1834..2d01148be5 100644 --- a/macros/latex/contrib/proflycee/doc/ProfLycee-doc.pdf +++ b/macros/latex/contrib/proflycee/doc/ProfLycee-doc.pdf diff --git a/macros/latex/contrib/proflycee/doc/ProfLycee-doc.tex b/macros/latex/contrib/proflycee/doc/ProfLycee-doc.tex index a71a941920..83a859b12b 100644 --- a/macros/latex/contrib/proflycee/doc/ProfLycee-doc.tex +++ b/macros/latex/contrib/proflycee/doc/ProfLycee-doc.tex @@ -62,8 +62,8 @@ \setlength{\parindent}{0pt} \definecolor{LightGray}{gray}{0.9} -\def\PLversion{2.1.1} -\def\PLdate{28 Décembre 2022} +\def\PLversion{2.1.3} +\def\PLdate{30 Décembre 2022} \tcbset{vignettes/.style={% nobeforeafter,box align=base,boxsep=0pt,enhanced,sharp corners=all,rounded corners=southeast,% @@ -141,15 +141,15 @@ \newcommand\genfenetre{% %styles \tikzset{noeudexpl/.style={purple,font=\sffamily\small}} - \tikzset{portionexpl/.style={orange,thick,<->}} + \tikzset{portionexpl/.style={orange,thick,<->,>=latex}} \tikzset{expl/.style={midway,inner sep=1pt,above right=0,orange,font=\sffamily\scriptsize,rotate=45}} \tikzset{coeffs/.style={CadetBlue!50!black,circle,draw=CadetBlue,thick,fill=CadetBlue!5,font=\small\ttfamily}} \tikzset{tangente/.style={teal,line width=1pt,dashed}} %grilles & axes \tgrilles[line width=0.3pt,lightgray!50] \tgrillep[line width=0.6pt,lightgray!50] - \draw[line width=1.5pt,->,gray] (\xmin,0)--(\xmax,0) ; - \draw[line width=1.5pt,->,gray] (0,\ymin)--(0,\ymax) ; + \draw[line width=1.5pt,->,gray,>=latex] (\xmin,0)--(\xmax,0) ; + \draw[line width=1.5pt,->,gray,>=latex] (0,\ymin)--(0,\ymax) ; \foreach \x in {0,1,...,10} {\draw[gray,line width=1.5pt] (\x,4pt) -- (\x,-4pt) ;} \foreach \y in {0,1,...,6} {\draw[gray,line width=1.5pt] (4pt,\y) -- (-4pt,\y) ;} } @@ -221,51 +221,32 @@ \thispagestyle{empty} -{\large {\bfseries Résumé} : Quelques commandes pour faciliter l'utilisation de \LaTeX{} pour les enseignants de mathématiques en lycée.} +{\sffamily{\bfseries Résumé} :\\ +Quelques commandes pour faciliter l'utilisation de \LaTeX{} pour les enseignants de mathématiques en lycée.} \medskip -\noindent Quelques commandes pour des courbes \textit{lisses} avec gestion des extrema et des dérivées. - -Quelques commandes pour simuler une fenêtre de logiciel de calcul formel, en \TikZ. - -Quelques environnements (\textsf{tcbox}) pour présenter du code \textsf{python} ou \textsf{pseudocode}. - -Quelques environnements (\textsf{tcbox}) pour présenter des commandes dans un terminal (\textsf{win} ou \textsf{mac} ou \textsf{linux}). - -Un cartouche (\textsf{tcbox}) pour présenter des codes de partage \textsf{capytale}. - -Une commande pour tracer un pavé en droit, en \TikZ, avec création des nœuds liés aux sommets. - -Une commande pour simplifier des calculs sous forme fractionnaire. - -Une commande pour simplifier l'écriture d'un ensemble, avec espaces \og automatiques \fg. - -Des commandes pour effectuer des calculs avec des suites récurrentes. - -Une commande pour créer, en \TikZ, la \textit{toile} pour une suite récurrente. - -Une commande pour créer, en \TikZ, un cercle trigo avec options. - -Une commande pour afficher un petit schéma, en \TikZ, sur le signe d'une fonction affine ou d'un trinôme. - -Deux commandes pour, en \TikZ, créer des petits schémas \og de signe \fg. - -Une commande pour travailler sur les statistiques à deux variables (algébriques et graphiques). - -Quelques commandes pour convertir bin/dec/hex avec certains détails. - -Une commande pour, en \TikZ, créer un pixelart avec correction éventuelle. - -Une commande pour, en \TikZ, créer un SudoMaths non forcément $9\times9$. - -Des commandes pour effectuer des calculs de probas (lois binomiale, exponentielle, de Poisson, normale). - -Une commande pour, en \TikZ, créer des arbres de probas \og classiques \fg. - -Une commande pour générer des listes d'entiers aléatoires (avec ou sans répétitions). - -\ldots +{\small\noindent Quelques commandes pour des courbes \textit{lisses} avec gestion des extrema et des dérivées.\\ +Quelques commandes pour simuler une fenêtre de logiciel de calcul formel, en \TikZ.\\ +Quelques environnements (\textsf{tcbox}) pour présenter du code \textsf{python} ou \textsf{pseudocode}.\\ +Quelques environnements (\textsf{tcbox}) pour présenter des commandes dans un terminal (\textsf{win} ou \textsf{mac} ou \textsf{linux}).\\ +Un cartouche (\textsf{tcbox}) pour présenter des codes de partage \textsf{capytale}.\\ +Une commande pour tracer un pavé en droit, en \TikZ, avec création des nœuds liés aux sommets.\\ +Une commande pour simplifier des calculs sous forme fractionnaire, des racines.\\ +Une commande pour simplifier l'écriture d'un ensemble, avec espaces \og automatiques \fg.\\ +Des commandes pour effectuer des calculs avec des suites récurrentes.\\ +Une commande pour créer, en \TikZ, la \textit{toile} pour une suite récurrente.\\ +Une commande pour créer, en \TikZ, un cercle trigo avec options.\\ +Une commande pour afficher un petit schéma, en \TikZ, sur le signe d'une fonction affine ou d'un trinôme.\\ +Deux commandes pour, en \TikZ, créer des petits schémas \og de signe \fg.\\ +Une commande pour travailler sur les statistiques à deux variables (algébriques et graphiques).\\ +Quelques commandes pour convertir bin/dec/hex avec certains détails.\\ +Une commande pour, en \TikZ, créer un pixelart avec correction éventuelle.\\ +Une commande pour, en \TikZ, créer un SudoMaths non forcément $9\times9$.\\ +Des commandes pour effectuer des calculs de probas (lois binomiale, exponentielle, de Poisson, normale).\\ +Une commande pour, en \TikZ, créer des arbres de probas \og classiques \fg.\\ +Une commande pour générer des listes d'entiers aléatoires (avec ou sans répétitions).\\ +\ldots} ~ @@ -415,6 +396,13 @@ Les options précédentes sont cumulables, et, pour info, elles conditionnent le \end{itemize} \end{codeinfo} +\begin{codetex}[listing only] +... +%chargement de ProfLycee sans minted, et avec pythontex +\usepackage[pythontex,nonshellescape]{ProfLycee} +... +\end{codetex} + \pagebreak \section{Compléments} @@ -437,7 +425,7 @@ Je préfère faire ces ajustements tant que le package est assez \textit{jeune} \begin{codetex}[listing only] ... -\usepackage[<options>]{ProfLycee-old} %nouveautés non disponibles par contre... +\usepackage[options]{ProfLycee-old} %nouveautés non disponibles par contre... ... \end{codetex} @@ -559,84 +547,83 @@ Elles sont présentées de manière \textit{succincte}, mais elles sont présent \begin{codetex}[listing only] %fenêtre de repérage en tikz et courbe -\GrilleTikz[<options>][<options grille ppale>][<options grille second.>] -\AxesTikz[<options>] -\AxexTikz[<options>]{<valeurs>} -\AxeyTikz[<options>]{<valeurs>} -\CourbeTikz[<options>]{<fonction>}{<valxmin:valxmax>} +\GrilleTikz[options][options grille ppale][options grille second.] +\AxesTikz[options] \AxexTikz[options]{valeurs} \AxeyTikz[options]{valeurs} +\FenetreSimpleTikz[options](opt axes)<opt axe Ox>{liste valx}<opt axe Oy>{liste valy} +\CourbeTikz[options]{fonction}{valxmin:valxmax} %courbe d'interpolation, tangente, dans un environnement tikz -\SplineTikz[<options>]{<liste>} -\TangenteTikz[<options>]{<liste>} +\SplineTikz[options]{liste} +\TangenteTikz[options]{liste} %Présentation d'une solution par balayage (TVI) -\SolutionTVI[<options>]{<fonction>}{<valeur>} +\SolutionTVI[options]{fonction}{valeur} %schémas pour le signe affine/trinôme, dans un environnement tikz -\MiniSchemaSignes[<clés>] -\MiniSchemaSignesTkzTab[<options>]{<numligne>}[<echelle>][<décalage horizontal>] +\MiniSchemaSignes[clés] +\MiniSchemaSignesTkzTab[options]{numligne}[échelle][décalage horizontal] %Calculer le terme d'une suite récurrente simple, toile pour une suite récurrente simple -\CalculTermeRecurrence[<options>]{<fonction associée>} -\ToileRecurrence[<clés>][<options du tracé>][<option supplémentaire des termes>] +\CalculTermeRecurrence[options]{fonction associée} +\ToileRecurrence[clés][options du tracé][option supplémentaire des termes] %Mise en forme de la conclusion d'un seuil -\SolutionSeuil[<options>]{<fonction associée>}{<seuil>} +\SolutionSeuil[options]{fonction associée}{seuil} \end{codetex} \begin{codetex}[listing only] %présentation type calcul formel, dans un environnement tikz -\CalculFormelParametres[<options>] -\CalculFormelLigne[<options>]{<commande>}{<résultat>} +\CalculFormelParametres[options] +\CalculFormelLigne[options]{commande}{résultat} %présentation de code Python -\begin{CodePythonLst}(*)[<largeur>]{<commandes tcbox>}...\end{CodePythonLst} -\begin{CodePiton}[<options>]...\end{CodePiton} -\begin{CodePythontex}[<options>]...\end{CodePythontex} %avec l'option [pythontex] -\begin{CodePythonMinted}(*)[<largeur>][<options>]...\end{CodePythonMinted} +\begin{CodePythonLst}(*)[largeur]{commandes tcbox}...\end{CodePythonLst} +\begin{CodePiton}[options]...\end{CodePiton} +\begin{CodePythontex}[options]...\end{CodePythontex} %avec l'option [pythontex] +\begin{CodePythonMinted}(*)[largeur][options]...\end{CodePythonMinted} %console Python avec l'option [pythontex] -\begin{ConsolePythontex}[<options>]...\end{ConsolePythontex} +\begin{ConsolePythontex}[options]...\end{ConsolePythontex} %présentation de pseudocode -\begin{PseudoCode}(*)[<largeur>][<options>]...\end{PseudoCode} +\begin{PseudoCode}(*)[largeur][options]...\end{PseudoCode} %terminal OS -\begin{TerminalWin}[<largeur>]{<clés>}[<options>]...\end{TerminalWin} -\begin{TerminalUnix}[<largeur>]{<clés>}[<options>]...\end{TerminalUnix} -\begin{TerminalOSX}[<largeur>]{<clés>}[<options>]...\end{TerminalOSX} +\begin{TerminalWin}[largeur]{clés}[options]...\end{TerminalWin} +\begin{TerminalUnix}[largeur]{clés}[options]...\end{TerminalUnix} +\begin{TerminalOSX}[largeur]{clés}[options]...\end{TerminalOSX} %code Capytale -\CartoucheCapytale(*)[<options<]{<code capytale>} +\CartoucheCapytale(*)[options]{code capytale} \end{codetex} \begin{codetex}[listing only] %pavé et tétraèdre, dans un environnement tikz -\PaveTikz[<options>] -\TetraedreTikz[<options>] +\PaveTikz[options] +\TetraedreTikz[options] %cercle trigo, dans un environnement tikz -\CercleTrigo[<clés>] +\CercleTrigo[clés] \end{codetex} \begin{codetex}[listing only] %paramètres d'une régression linéaire, nuage de points -\CalculsRegLin[<clés>]{<listeX>}{<listeY>} -\PointsRegLin[<clés>]{<listeX>}{<listeY>} +\CalculsRegLin[clés]{listeX}{listeY} +\PointsRegLin[clés]{listeX}{listeY} %stats à 2 variables, dans un environnement tikz -\GrilleTikz[<options>][<options grille ppale>][<options grille second.>] -\AxesTikz[<options>] -\AxexTikz[<options>]{<valeurs>} \AxeyTikz[<options>]{<valeurs>} +\GrilleTikz[options][options grille ppale][options grille second.] +\AxesTikz[options] +\AxexTikz[options]{valeurs} \AxeyTikz[options]{valeurs} \FenetreTikz \OrigineTikz -\FenetreSimpleTikz<options axe Ox>{liste abscisses}<options axe Oy>{liste ordonnées} -\NuagePointsTikz[<options>]{<listeX>}{<listeY>} -\PointMoyenTikz[<options>] -\CourbeTikz[<options>]{<formule>}{<domaine>} +\FenetreSimpleTikz[options](opt axes)<opt axe Ox>{liste valx}<opt axe Oy>{liste valy} +\NuagePointsTikz[options]{listeX}{listeY} +\PointMoyenTikz[options] +\CourbeTikz[options]{formule}{domaine} %boîte à moustaches, dans un environnement tikz -\BoiteMoustaches[<options>] -\BoiteMoustachesAxe[<options>] +\BoiteMoustaches[options] +\BoiteMoustachesAxe[options] \end{codetex} \begin{codetex}[listing only] @@ -675,8 +662,8 @@ Elles sont présentées de manière \textit{succincte}, mais elles sont présent \ExpoC(*)[prec]{l}{a}{b} %arbres de probas -\ArbreProbasTikz[<options>]{<donnees>} -\begin{EnvArbreProbasTikz}[<options>]{<donnees>}...\end{EnvArbreProbasTikz} +\ArbreProbasTikz[options]{donnees} +\begin{EnvArbreProbasTikz}[options]{donnees}...\end{EnvArbreProbasTikz} %schémas lois continues \LoiNormaleGraphe[options]<options tikz>{m}{s}{a}{b} @@ -685,46 +672,49 @@ Elles sont présentées de manière \textit{succincte}, mais elles sont présent \begin{codetex}[listing only] %entier aléatoire entre a et b -\NbAlea{a}{b}{<macro>} +\NbAlea{a}{b}{macro} %nombre décimal (n chiffres après la virgule) aléatoire entre a et b+1 (exclus) -\NbAlea[n]{a}{b}{<macro>} +\NbAlea[n]{a}{b}{macro} %création d'un nombre aléatoire sous forme d'une macro -\VarNbAlea{<macro>}{<calculs>} +\VarNbAlea{macro}{calcul} %liste d'entiers aléatoires -\TirageAleatoireEntiers[<options>]{<macro>} +\TirageAleatoireEntiers[options]{macro} \end{codetex} \begin{codetex}[listing only] %conversions -\ConversionDecBin(*)[<clés>]{<nombre>} -\ConversionBinHex[<clés>]{<nombre>} -\ConversionVersDec[<clés>]{<nombre>} -\ConversionBaseDix[<clés>]{<nombre>}{<base de départ>} -\ConversionDepuisBaseDix[<options>]{<nombre en base 10>}{<base d'arrivée>} +\ConversionDecBin(*)[clés]{nombre} +\ConversionBinHex[clés]{nombre} +\ConversionVersDec[clés]{nombre} +\ConversionBaseDix[clés]{nombre}{base de départ} +\ConversionDepuisBaseDix[options]{nombre en base 10}{base d'arrivée} %PGCD présenté -\PresentationPGCD[<options>]{a}{b} +\PresentationPGCD[options]{a}{b} \end{codetex} \begin{codetex}[listing only] %conversion en fraction, simplification de racine -\ConversionFraction[<option>]{<argument>} -\SimplificationRacine{<expression>} +\ConversionFraction[option]{argument} +\SimplificationRacine{expression} %ensemble d'éléments -\EcritureEnsemble[<clés>]{<liste>} +\EcritureEnsemble[clés]{liste} %trinôme, trinôme aléatoire -\EcritureTrinome[<options>]{a}{b}{c} +\EcritureTrinome[options]{a}{b}{c} + +%mesure principale +\MesurePrincipale[options]{angle} \end{codetex} \begin{codetex}[listing only] %pixelart, dans un environnement tikz -\PixelArtTikz[<clés>]{<fichier>.csv} +\PixelArtTikz[clés]{fichier.csv} %sudomaths -\SudoMaths[<options>]{<liste>}. -\begin{EnvSudoMaths}[<options>]{<grille>}...\end{EnvSudoMaths} +\SudoMaths[options]{liste} +\begin{EnvSudoMaths}[options]{grille}...\end{EnvSudoMaths} \end{codetex} \newpage @@ -755,14 +745,14 @@ Au niveau du code, il y aura donc plusieurs \textit{aspects} : \begin{codetex}[listing only] %version basique -\begin{tikzpicture}[<paramètres>] +\begin{tikzpicture}[paramètres] %grille et axes - \GrilleTikz[<options>][<options grille ppale>][<options grille second.>] - \AxesTikz[<options>] - \AxexTikz[<options>]{<valeurs>} - \AxeyTikz[<options>]{<valeurs>} + \GrilleTikz[options][options grille ppale][options grille second.] + \AxesTikz[options] + \AxexTikz[options]{valeurs} + \AxeyTikz[options]{valeurs} %courbe - \CourbeTikz[<options>]{<fonction>}{<valxmin:valxmax>} + \CourbeTikz[options]{fonction}{valxmin:valxmax} \end{tikzpicture} \end{codetex} @@ -770,9 +760,9 @@ Au niveau du code, il y aura donc plusieurs \textit{aspects} : %version simplifiée \begin{tikzpicture}[<paramètres>] %grille et axes - \FenetreSimpleTikz[<options>]<opt axe Ox>{liste abscisses}<opt axe Oy>{liste ordonnées} + \FenetreSimpleTikz[opt](opt axes)<opt axe Ox>{liste valx}<opt axe Oy>{liste valy} %courbe - \CourbeTikz[<options>]{<fonction>}{<valxmin:valxmax>} + \CourbeTikz[options]{fonction}{valxmin:valxmax} \end{tikzpicture} \end{codetex} @@ -783,7 +773,7 @@ Au niveau du code, il y aura donc plusieurs \textit{aspects} : ymin=0,ymax=240,ygrille=30,ygrilles=30] %axe Oy \FenetreSimpleTikz<Police=\small>{0,5,...,55}<Police=\small>{0,30,...,210} %repère \CourbeTikz[line width=1.25pt,ForestGreen,samples=250]% - {\x*\x*exp(-0.05*\x)+1}{0:60} %courbe + {\x*\x*exp(-0.05*\x)+1}{0:60} %courbe \end{tikzpicture} \end{codesortie} @@ -802,7 +792,7 @@ Les \Cle{paramètres} nécessaires à la bonne utilisation des commandes suivant \item \Cle{xgrilles}, stockée dans \ctex{\textbackslash{}xgrilles}, graduation secondaire.\hfill{}défaut \Cle{0.5} \end{itemize} -La fenêtre d'affichage (de sortie) sera donc \textit{portée} par le rectangle de coins $(\text{xmin}\,;\,\text{ymin})$ et $(\text{xmax}\,;\,\text{ymax})$ ; ce qui correspond en fait à la fenêtre \TikZ{} \textit{portée} par le rectangle de coins $(xmin-Ox\,;\,ymin-Oy)$ et $(\text{xmax-Ox}\,;\,\text{ymax-Oy})$. +La fenêtre d'affichage (de sortie) sera donc \textit{portée} par le rectangle de coins $(\text{xmin}\,;\,\text{ymin})$ et $(\text{xmax}\,;\,\text{ymax})$ ; ce qui correspond en fait à la fenêtre \TikZ{} \textit{portée} par le rectangle de coins $(\text{xmin-Ox}\,;\,\text{ymin-Oy})$ et $(\text{xmax-Ox}\,;\,\text{ymax-Oy})$. \smallskip @@ -811,7 +801,7 @@ Les commandes ont -- pour certaines -- pas mal de \Cle{clés} pour des réglages \begin{codetex}[listing only] %...code tikz -\GrilleTikz[<options>][<options grille ppale>][<options grille second.>] +\GrilleTikz[options][options grille ppale][options grille second.] \end{codetex} \begin{codecles} @@ -859,7 +849,7 @@ Cette commande permet de tracer une grille principale et/ou une grille secondair \begin{codetex}[listing only] %...code tikz -\AxesTikz[<options>] +\AxesTikz[options] \end{codetex} \begin{codecles} @@ -868,13 +858,15 @@ Cette commande permet de tracer les axes, avec des \Cle{clés} : \begin{itemize} \item \Cle{Epaisseur} qui est l'épaisseur des axes ; \hfill~défaut \Cle{1pt} \item \Cle{Police} qui est le style des labels des axes ; \hfill~défaut \Cle{\textbackslash{}normalsize\textbackslash{}normalfont} + \item \cmaj{2.1.2} \Cle{ElargirOx} qui est le \% l'élargissement \Cle{global} ou \Cle{G/D} de l'axe $(Ox)$ ;\hfill~défaut \Cle{0/0.05} + \item \cmaj{2.1.2} \Cle{ElargirOy} qui est le \% l'élargissement \Cle{global} ou \Cle{B/H} de l'axe $(Oy)$ ;\hfill~défaut \Cle{0/0.05} \item \Cle{Labelx} qui est le label de l'axe $(Ox)$ ; \hfill~défaut \Cle{\${}x\$} \item \Cle{Labely} qui est le label de l'axe $(Oy)$ ; \hfill~défaut \Cle{\${}y\$} \item \Cle{AffLabel} qui est le code pour préciser quels labels afficher, entre \Cle{x}, \Cle{y} ou \Cle{xy} ; \hfill~défaut \Cle{vide} \item \Cle{PosLabelx} pour la position du label de $(Ox)$ en bout d'axe ; \hfill~défaut \Cle{right} \item \Cle{PosLabely} pour la position du label de $(Oy)$ en bout d'axe ; \hfill~défaut \Cle{above} \item \Cle{EchelleFleche} qui est l'échelle de la flèche des axes ; \hfill~défaut \Cle{1} - \item \Cle{TypeFleche} qui est le type de la flèche des axes.\hfill~défaut \Cle{>} + \item \Cle{TypeFleche} qui est le type de la flèche des axes.\hfill~défaut \Cle{latex} \end{itemize} \end{codecles} @@ -886,7 +878,7 @@ Cette commande permet de tracer les axes, avec des \Cle{clés} : \AxesTikz% [AffLabel=xy,Labelx={Nombre de jours},Labely={Nombre d'individus infectés, en centaines},% PosLabelx={above left},PosLabely={above right},% - Police=\small\sffamily] + Police=\small\sffamily,ElargirOx=0,ElargirOy=0] \end{codetex} \begin{codesortie} @@ -906,6 +898,7 @@ Cette commande permet de tracer les axes, avec des \Cle{clés} : [AffLabel=xy,Labelx={Nombre de jours}, Labely={Nombre d'individus infectés, en centaines},% PosLabelx={above left},PosLabely={above right},% + ElargirOx=0,ElargirOy=0, Police=\small\sffamily] \end{tikzpicture} \hfill~ @@ -915,8 +908,8 @@ Cette commande permet de tracer les axes, avec des \Cle{clés} : \begin{codetex}[listing only] %...code tikz -\AxexTikz[<options>]{valeurs} -\AxeyTikz[<options>]{valeurs} +\AxexTikz[options]{valeurs} +\AxeyTikz[options]{valeurs} \end{codetex} \begin{codecles} @@ -951,8 +944,8 @@ Ces commande permet de tracer les graduations des axes, avec des \Cle{clés} ide [x=0.1cm,y=0.0167cm, %unités xmin=0,xmax=60,xgrille=5,xgrilles=5, %axe Ox ymin=0,ymax=240,ygrille=30,ygrilles=30] %axe Oy - \draw[gray,line width=1.25pt,->] ({\xmin-\axexOx},0) -- ({\xmax-\axexOx},0) ; - \draw[gray,line width=1.25pt,->] (0,{\ymin-\axeyOy}) -- (0,{\ymax-\axeyOy}) ; + \draw[gray,line width=1.25pt,->,>=latex] ({\xmin-\axexOx},0) -- ({\xmax-\axexOx},0) ; + \draw[gray,line width=1.25pt,->,>=latex] (0,{\ymin-\axeyOy}) -- (0,{\ymax-\axeyOy}) ; \AxexTikz[Police=\small]{0,5,...,55} \AxeyTikz[Police=\small]{0,30,...,210} \end{tikzpicture} @@ -961,8 +954,8 @@ Ces commande permet de tracer les graduations des axes, avec des \Cle{clés} ide [x=0.1cm,y=0.0167cm, %unités xmin=0,xmax=60,xgrille=5,xgrilles=5, %axe Ox ymin=0,ymax=240,ygrille=30,ygrilles=30] %axe Oy - \draw[gray,line width=1.25pt,->] ({\xmin-\axexOx},0) -- ({\xmax-\axexOx},0) ; - \draw[gray,line width=1.25pt,->] (0,{\ymin-\axeyOy}) -- (0,{\ymax-\axeyOy}) ; + \draw[gray,line width=1.25pt,->,>=latex] ({\xmin-\axexOx},0) -- ({\xmax-\axexOx},0) ; + \draw[gray,line width=1.25pt,->,>=latex] (0,{\ymin-\axeyOy}) -- (0,{\ymax-\axeyOy}) ; \AxexTikz[Police=\small,HautGrad=0pt/4pt]{0,5,...,55} \AxeyTikz[AffGrad=false,HautGrad=6pt]{0,30,...,210} \end{tikzpicture} @@ -985,7 +978,7 @@ Il existe, de manière marginale, quelques commandes complémentaires qui ne ser %code tikz \FenetreTikz %on restreint les tracés \FenetreSimpleTikz% - [<options>]<options axe Ox>{liste abscisses}<options axe Oy>{liste ordonnées} + [options](opt axes)<opt axe Ox>{valeurs Ox}<opt axe Oy>{valeurs Oy} \end{codetex} \begin{codeidee} @@ -994,7 +987,7 @@ L'idée est de proposer, en \textit{complément}, une commande simplifiée pour \begin{codetex}[listing only] %...code tikz -\CourbeTikz[<options>]{formule}{domaine} +\CourbeTikz[options]{formule}{domaine} \end{codetex} \begin{codecles} @@ -1008,13 +1001,14 @@ Cette commande permet de rajouter une courbe sur le graphique (sans se soucier d \end{codecles} \begin{codetex}[listing only] -\begin{tikzpicture}% - [x=0.1cm,y=0.0167cm, %unités +\begin{tikzpicture}[x=0.1cm,y=0.0167cm, %unités xmin=0,xmax=60,xgrille=5,xgrilles=5, %axe Ox ymin=0,ymax=240,ygrille=30,ygrilles=30] %axe Oy - \FenetreSimpleTikz<Police=\small>{0,5,...,55}<Police=\small>{0,30,...,210} %repère + \FenetreSimpleTikz% + <Police=\small>{0,5,...,60}% + <Police=\small>{0,30,...,240} %repère \CourbeTikz[line width=1.25pt,ForestGreen,samples=250]% - {\x*\x*exp(-0.05*\x)+1}{0:60} %courbe + {\x*\x*exp(-0.05*\x)+1}{0:60} %courbe \end{tikzpicture} \end{codetex} @@ -1022,7 +1016,8 @@ Cette commande permet de rajouter une courbe sur le graphique (sans se soucier d \begin{tikzpicture}% [x=0.1cm,y=0.0167cm, %unités xmin=0,xmax=60,xgrille=5,xgrilles=5,ymin=0,ymax=240,ygrille=30,ygrilles=30] - \FenetreSimpleTikz<Police=\small>{0,5,...,55}<Police=\small>{0,30,...,210} %repère + \FenetreSimpleTikz% + <Police=\small>{0,5,...,60}<Police=\small>{0,30,...,240} %repère \CourbeTikz[line width=1.25pt,ForestGreen,samples=250]% {\x*\x*exp(-0.05*\x)+1}{0:60} %courbe \end{tikzpicture} @@ -1039,8 +1034,7 @@ L'idée est donc d'utiliser les commandes précédentes, sans se soucier des év \end{codeidee} \begin{codetex}[] -\begin{tikzpicture}% - [x=0.35cm,y=0.07cm,Ox=1992,xmin=1992,xmax=2010,% +\begin{tikzpicture}[x=0.35cm,y=0.07cm,Ox=1992,xmin=1992,xmax=2010,% xgrille=2,xgrilles=1,Oy=1640,ymin=1640,ymax=1710,ygrille=10,ygrilles=5] \FenetreSimpleTikz<Annee,Police=\small>{1992,1994,...,2008}{1640,1650,...,1700} \FenetreTikz @@ -1085,7 +1079,7 @@ Pour déclarer les paramètres : \begin{codetex}[listing only] \begin{tikzpicture} ... - \SplineTikz[<options>]{<liste>} + \SplineTikz[options]{liste} ... \end{tikzpicture} \end{codetex} @@ -1134,8 +1128,8 @@ Si jamais il existe (un ou) des points \textit{anguleux}, le plus simple est de \def\ymin{-1}\def\ymax{5}\def\ygrille{1}\def\ygrilles{0.5} %axes et grilles \draw[xstep=\xgrilles,ystep=\ygrilles,line width=0.6pt,lightgray!50] (\xmin,\ymin) grid (\xmax,\ymax); -\draw[line width=1.5pt,->,gray] (\xmin,0)--(\xmax,0) ; -\draw[line width=1.5pt,->,gray] (0,\ymin)--(0,\ymax) ; +\draw[line width=1.5pt,->,gray,>=latex] (\xmin,0)--(\xmax,0) ; +\draw[line width=1.5pt,->,gray,>=latex] (0,\ymin)--(0,\ymax) ; \foreach \x in {0,1,...,10} {\draw[gray,line width=1.5pt] (\x,4pt) -- (\x,-4pt) ;} \foreach \y in {0,1,...,4} {\draw[gray,line width=1.5pt] (4pt,\y) -- (-4pt,\y) ;} \draw[darkgray] (1,-4pt) node[below,font=\sffamily] {1} ; @@ -1201,8 +1195,8 @@ On peut dans ce cas \textit{jouer} sur les coefficients de cette portion pour \t %axes et grilles \draw[xstep=\xgrilles,ystep=\ygrilles,line width=0.3pt,lightgray!50] (\xmin,\ymin) grid (\xmax,\ymax); \draw[xstep=\xgrilles,ystep=\ygrilles,line width=0.6pt,lightgray!50] (\xmin,\ymin) grid (\xmax,\ymax); - \draw[line width=1.5pt,->,gray] (\xmin,0)--(\xmax,0) ; - \draw[line width=1.5pt,->,gray] (0,\ymin)--(0,\ymax) ; + \draw[line width=1.5pt,->,gray,>=latex] (\xmin,0)--(\xmax,0) ; + \draw[line width=1.5pt,->,gray,>=latex] (0,\ymin)--(0,\ymax) ; \foreach \x in {0,1,...,10} {\draw[gray,line width=1.5pt] (\x,4pt) -- (\x,-4pt) ;} \foreach \y in {0,1,...,4} {\draw[gray,line width=1.5pt] (4pt,\y) -- (-4pt,\y) ;} \draw[darkgray] (1,-4pt) node[below,font=\sffamily] {1} ; @@ -1244,7 +1238,7 @@ NB : il peut fonctionner indépendamment de l'outil \ctex{SplineTikz} puisque la \begin{codetex}[listing only] \begin{tikzpicture} ... - \TangenteTikz[<options>]{<liste>} + \TangenteTikz[options]{liste} ... \end{tikzpicture} \end{codetex} @@ -1282,8 +1276,8 @@ On obtient le résultat suivant (avec les éléments rajoutés utiles à la comp \begin{tikzpicture}[x=3cm,y=2cm,xmin=0,xmax=2,xgrilles=0.25,ymin=0,ymax=2.25,ygrilles=0.25] \tikzset{noeudexpl/.style={purple,font=\sffamily\small}} \tgrilles - \draw[line width=1.5pt,->,darkgray] (\xmin,0)--(\xmax,0) ; - \draw[line width=1.5pt,->,darkgray] (0,\ymin)--(0,\ymax) ; + \draw[line width=1.5pt,->,darkgray,>=latex] (\xmin,0)--(\xmax,0) ; + \draw[line width=1.5pt,->,darkgray,>=latex] (0,\ymin)--(0,\ymax) ; \draw (0,1.5) node[noeudexpl,below] {point 1} ; \draw (1,2) node[noeudexpl,below] {point 2} ; \draw (2,0) node[noeudexpl,above left] {point 3} ; @@ -1320,8 +1314,8 @@ On obtient le résultat suivant (avec les éléments rajoutés utiles à la comp \begin{tikzpicture}[x=0.5cm,y=0.5cm,xmin=0,xmax=16,xgrilles=1,ymin=0,ymax=16,ygrilles=1] \draw[xstep=\xgrilles,ystep=\ygrilles,line width=0.3pt,lightgray] (\xmin,\ymin) grid (\xmax,\ymax) ; - \draw[line width=1.5pt,->,darkgray] (\xmin,0)--(\xmax,0) ; - \draw[line width=1.5pt,->,darkgray] (0,\ymin)--(0,\ymax) ; + \draw[line width=1.5pt,->,darkgray,>=latex] (\xmin,0)--(\xmax,0) ; + \draw[line width=1.5pt,->,darkgray,>=latex] (0,\ymin)--(0,\ymax) ; \foreach \x in {0,2,...,14} {\draw[darkgray,line width=1.5pt] (\x,4pt) -- (\x,-4pt) ;} \foreach \y in {0,2,...,14} {\draw[darkgray,line width=1.5pt] (4pt,\y) -- (-4pt,\y) ;} %la liste pour la courbe d'interpolation @@ -1340,8 +1334,8 @@ On obtient le résultat suivant (avec les éléments rajoutés utiles à la comp \begin{center} \begin{tikzpicture}[x=0.5cm,y=0.5cm,xmin=0,xmax=16,xgrilles=1,ymin=0,ymax=16,ygrilles=1] \draw[xstep=\xgrilles,ystep=\ygrilles,line width=0.3pt,lightgray] (\xmin,\ymin) grid (\xmax,\ymax) ; - \draw[line width=1.5pt,->,darkgray] (\xmin,0)--(\xmax,0) ; - \draw[line width=1.5pt,->,darkgray] (0,\ymin)--(0,\ymax) ; + \draw[line width=1.5pt,->,darkgray,>=latex] (\xmin,0)--(\xmax,0) ; + \draw[line width=1.5pt,->,darkgray,>=latex] (0,\ymin)--(0,\ymax) ; \foreach \x in {0,2,...,14} {\draw[darkgray,line width=1.5pt] (\x,4pt) -- (\x,-4pt) ;} \foreach \y in {0,2,...,14} {\draw[darkgray,line width=1.5pt] (4pt,\y) -- (-4pt,\y) ;} \draw[darkgray] (2,-4pt) node[below,font=\sffamily] {2} ; @@ -1374,7 +1368,7 @@ Le code ne trouve pas la solution, il met \textit{juste} en forme mais effectue \end{codeattention} \begin{codetex}[listing only] -\SolutionTVI[<options>]{<fonction>}{<valeur>} +\SolutionTVI[options]{fonction}{valeur} \end{codetex} \subsection{Clés et arguments} @@ -1430,7 +1424,7 @@ Comme pour les autres commandes \TikZ, l'idée est de laisser l'utilisateur déf \begin{codetex}[tikz lower] %code tikz -\MiniSchemaSignes[<clés>] +\MiniSchemaSignes[clés] \end{codetex} \subsection{Commandes} @@ -1439,13 +1433,13 @@ Comme pour les autres commandes \TikZ, l'idée est de laisser l'utilisateur déf ... \begin{tikzpicture}[<options>] ... - \MiniSchemaSignes[<clés>] + \MiniSchemaSignes[clés] ... \end{tikzpicture} \end{codetex} \begin{codetex}[listing only] -... {\tikz[<options>] \MiniSchemaSignes[<clés>]}... +... {\tikz[options] \MiniSchemaSignes[clés]}... \end{codetex} \begin{codecles} @@ -1570,7 +1564,7 @@ Pour des raisons internes, le fonctionnement de la commande \ctex{aidesignetkzta \begin{codetex}[listing only] \begin{tikzpicture} %commandes tkztab - \MiniSchemaSignesTkzTab[<options>]{<numligne>}[<echelle>][<décalage horizontal>] + \MiniSchemaSignesTkzTab[options]{numligne}[echelle][décalage horizontal] \end{tikzpicture} \end{codetex} @@ -1641,10 +1635,10 @@ En ce qui concerne les autres arguments : \begin{codetex}[listing only] %commande pour calculer et formater -\CalculTermeRecurrence[<options>]{<fonction associée>} +\CalculTermeRecurrence[options]{fonction associée} %mise en forme de la conclusion d'un seuil -\SolutionSeuil[<options>]{<fonction associée>}{<seuil>} +\SolutionSeuil[options]{fonction associée}{seuil} \end{codetex} \subsection{Clés et arguments} @@ -1752,9 +1746,9 @@ Comme pour les autres commandes \TikZ, l'idée est de laisser l'utilisateur déf \begin{codetex}[listing only] ... -\begin{tikzpicture}[<options>] +\begin{tikzpicture}[options] ... - \ToileRecurrence[<clés>][<options du tracé>][<options supplémentaires des termes>] + \ToileRecurrence[clés][options du tracé][options supplémentaires des termes] ... \end{tikzpicture} \end{codetex} @@ -1811,8 +1805,8 @@ On va tracer la \textit{toile} des 4 premiers termes de la suite récurrente $\b \def\ymin{0}\def\ymax{8}\def\ygrille{1}\def\ygrilles{0.5} %axes et grilles \draw[xstep=\xgrilles,ystep=\ygrilles,line width=0.6pt,lightgray!50] (\xmin,\ymin) grid (\xmax,\ymax); -\draw[line width=1.5pt,->,darkgray] (\xmin,0)--(\xmax,0) ; -\draw[line width=1.5pt,->,darkgray] (0,\ymin)--(0,\ymax) ; +\draw[line width=1.5pt,->,darkgray,>=latex] (\xmin,0)--(\xmax,0) ; +\draw[line width=1.5pt,->,darkgray,>=latex] (0,\ymin)--(0,\ymax) ; \foreach \x in {0,1,...,9} {\draw[darkgray,line width=1.5pt] (\x,4pt) -- (\x,-4pt) ;} \foreach \y in {0,1,...,7} {\draw[darkgray,line width=1.5pt] (4pt,\y) -- (-4pt,\y) ;} %fonction définie et réutilisable @@ -1851,8 +1845,8 @@ Peut-être que -- ultérieurement -- des options \textit{booléennes} seront dis \begin{center} \begin{tikzpicture}[x=4cm,y=3cm] \draw[xstep=0.25,ystep=0.25,line width=0.3pt,lightgray!50] (0,0) grid (2.5,1.25); - \draw[thick,->] (0,0)--(2.5,0) ; - \draw[thick,->] (0,0)--(0,1.25) ; + \draw[thick,->,>=latex] (0,0)--(2.5,0) ; + \draw[thick,->,>=latex] (0,0)--(0,1.25) ; \foreach \x in {0,1,2} \draw[line width=1.25pt] (\x,4pt) -- (\x,-4pt) node[below] {\num{\x}} ; \foreach \y in {0,0.5,1.0} @@ -1889,8 +1883,8 @@ Peut-être que -- ultérieurement -- des options \textit{booléennes} seront dis \begin{tikzpicture}[x=5cm,y=1.5cm] %axes et grille \draw[xstep=0.5,ystep=0.25,line width=0.3pt,lightgray!50] (0,0) grid (2.5,2.25); - \draw[thick,->] (0,0)--(2.5,0) ; - \draw[thick,->] (0,0)--(0,2.25) ; + \draw[thick,->,>=latex] (0,0)--(2.5,0) ; + \draw[thick,->,>=latex] (0,0)--(0,2.25) ; \foreach \x in {0,0.5,...,2} \draw[line width=1.25pt] (\x,4pt) -- (\x,-4pt) node[below] {\num{\x}}; \foreach \y in {0,0.5,...,2} @@ -1936,7 +1930,7 @@ La première chose à définir est l'ensemble des paramètres \textit{globaux} d \begin{codetex}[listing only] ... \begin{tikzpicture}[...] - \CalculFormelParametres[<options>] + \CalculFormelParametres[options] ... \end{tikzpicture} \end{codetex} @@ -1969,8 +1963,8 @@ Une fois les paramètres déclarés, il faut créer les différentes lignes, gr \begin{codetex}[listing only] \begin{tikzpicture}[...] - \CalculFormelParametres[<options>] - \CalculFormelLigne[<options>]{<commande>}{<résultat>} + \CalculFormelParametres[options] + \CalculFormelLigne[options]{commande}{résultat} ... \end{tikzpicture} \end{codetex} @@ -2016,18 +2010,18 @@ Pour \textit{illustrer} un peu les \Cle{clés}, un petit schéma, avec les diff \CalculFormelLigne{COMMANDE 1}{RÉSULTAT 1} \CalculFormelLigne[HautCmd=0.85,HautRes=1.05]{COMMANDE 2}{RÉSULTAT 2} %explications - \draw[CadetBlue,<->] ($(A22) + (0,-12pt)$) -- ($(A52) + (0,-12pt)$) node[midway,below,font=\footnotesize\sffamily] {\Cle{Largeur}} ; - \draw[CadetBlue,<->] ($(A51) + (12pt,0)$) -- ($(A32) + (12pt,0)$) node[midway,right,font=\footnotesize\sffamily] {\Cle{EsapceLg}} ; - \draw[CadetBlue,<->] ($(A02) + (0,2pt)$) -- ($(A02) + (0,2pt) + ({-\CFpremcol},0) $) node[midway,above,font=\footnotesize\sffamily] {\Cle{PremCol}} ; - \draw[CadetBlue,<->] ($(A02) + ({-\CFpremcol},0) + (-2pt,0)$) -- ($(A02) + ({-\CFpremcol},{-\CFhpremcol}) +(-2pt,0)$) node[midway,left,font=\footnotesize\sffamily] {\Cle{HautPremCol}} ; - \draw[CadetBlue,<->] ($(A31) + (12pt,0)$) -- ($(A41) + (12pt,0)$) node[midway,right,font=\footnotesize\sffamily] {\Cle{HautCom}} ; - \draw[CadetBlue,<->] ($(A41) + (12pt,0)$) -- ($(A51) + (12pt,0)$) node[midway,right,font=\footnotesize\sffamily] {\Cle{HautRes}} ; - \draw[CadetBlue,<->] ($(A32) + (12pt,0)$) -- ($(A42) + (12pt,0)$) node[midway,right,font=\footnotesize\sffamily] {\Cle{HautCom}} ; - \draw[CadetBlue,<->] ($(A42) + (12pt,0)$) -- ($(A52) + (12pt,0)$) node[midway,right,font=\footnotesize\sffamily] {\Cle{HautRes}} ; - \draw[CadetBlue,->] ($(A12) + (0,-12pt)$) to[bend left=10] ($(A12) + (0,-12pt) + (-18pt,-12pt)$) node[below left,font=\footnotesize\sffamily] {\Cle{Couleur}} ; - \draw[CadetBlue,->] ($(A52) + (-0.65,0.25)$) to[bend left=10] ($(A52) + (-0.65,0.25) + (-18pt,12pt)$) node[inner sep=0pt,above left=1pt,font=\footnotesize\sffamily] {\Cle{Menu}} ; - \draw[CadetBlue,->] ($(A12) + (16pt,0)$) to[bend left=10] ($(A12) + (16pt,0) + (18pt,-12pt)$) node[inner sep=0pt,below right=1pt,font=\footnotesize\sffamily] {\Cle{Sep}} ; - \draw[CadetBlue,->] ($(A01) + (8pt,2pt) + (0,1em)$) to[bend left=10] ($(A01) + (8pt,2pt) + (0,1em) + (-18pt,12pt)$) node[inner sep=0pt,above=1pt,font=\footnotesize\sffamily] {\Cle{Titre} \& \Cle{TailleTitre} \& \Cle{LabelTitre}} ; + \draw[CadetBlue,<->,>=latex] ($(A22) + (0,-12pt)$) -- ($(A52) + (0,-12pt)$) node[midway,below,font=\footnotesize\sffamily] {\Cle{Largeur}} ; + \draw[CadetBlue,<->,>=latex] ($(A51) + (12pt,0)$) -- ($(A32) + (12pt,0)$) node[midway,right,font=\footnotesize\sffamily] {\Cle{EsapceLg}} ; + \draw[CadetBlue,<->,>=latex] ($(A02) + (0,2pt)$) -- ($(A02) + (0,2pt) + ({-\CFpremcol},0) $) node[midway,above,font=\footnotesize\sffamily] {\Cle{PremCol}} ; + \draw[CadetBlue,<->,>=latex] ($(A02) + ({-\CFpremcol},0) + (-2pt,0)$) -- ($(A02) + ({-\CFpremcol},{-\CFhpremcol}) +(-2pt,0)$) node[midway,left,font=\footnotesize\sffamily] {\Cle{HautPremCol}} ; + \draw[CadetBlue,<->,>=latex] ($(A31) + (12pt,0)$) -- ($(A41) + (12pt,0)$) node[midway,right,font=\footnotesize\sffamily] {\Cle{HautCom}} ; + \draw[CadetBlue,<->,>=latex] ($(A41) + (12pt,0)$) -- ($(A51) + (12pt,0)$) node[midway,right,font=\footnotesize\sffamily] {\Cle{HautRes}} ; + \draw[CadetBlue,<->,>=latex] ($(A32) + (12pt,0)$) -- ($(A42) + (12pt,0)$) node[midway,right,font=\footnotesize\sffamily] {\Cle{HautCom}} ; + \draw[CadetBlue,<->,>=latex] ($(A42) + (12pt,0)$) -- ($(A52) + (12pt,0)$) node[midway,right,font=\footnotesize\sffamily] {\Cle{HautRes}} ; + \draw[CadetBlue,->,>=latex] ($(A12) + (0,-12pt)$) to[bend left=10] ($(A12) + (0,-12pt) + (-18pt,-12pt)$) node[below left,font=\footnotesize\sffamily] {\Cle{Couleur}} ; + \draw[CadetBlue,->,>=latex] ($(A52) + (-0.65,0.25)$) to[bend left=10] ($(A52) + (-0.65,0.25) + (-18pt,12pt)$) node[inner sep=0pt,above left=1pt,font=\footnotesize\sffamily] {\Cle{Menu}} ; + \draw[CadetBlue,->,>=latex] ($(A12) + (16pt,0)$) to[bend left=10] ($(A12) + (16pt,0) + (18pt,-12pt)$) node[inner sep=0pt,below right=1pt,font=\footnotesize\sffamily] {\Cle{Sep}} ; + \draw[CadetBlue,->,>=latex] ($(A01) + (8pt,2pt) + (0,1em)$) to[bend left=10] ($(A01) + (8pt,2pt) + (0,1em) + (-18pt,12pt)$) node[inner sep=0pt,above=1pt,font=\footnotesize\sffamily] {\Cle{Titre} \& \Cle{TailleTitre} \& \Cle{LabelTitre}} ; \end{tikzpicture} \end{center} \end{codeinfo} @@ -2063,7 +2057,7 @@ L'environnement \ctex{CodePythonLst} permet de présenter du code python, dans u \end{codeidee} \begin{codetex}[listing only] -\begin{CodePythonLst}(*)[<largeur>]{<commandes tcbox>} +\begin{CodePythonLst}(*)[largeur]{commandes tcbox} ... \end{CodePythonLst} \end{codetex} @@ -2097,7 +2091,7 @@ Si cette méthode est utilisée, il ne faut oublier de charger le package \ctex{ \begin{codetex}[listing only] \usepackage{scontents} %si script déclaré dans le fichier tex ... -\CodePythonLstFichier(*)[<largeur>]{<commandes tcbox>}{<script>} +\CodePythonLstFichier(*)[largeur]{commandes tcbox}{script} \end{codetex} \subsection{Exemples} @@ -2233,6 +2227,10 @@ En \textit{partenariat} avec \ctex{tcolorbox}, on peut avoir une présentation d \smallskip \cmaj{2.0.2} Depuis la version \ctex{0.95} du package \ctex{piton}, \Cle{left-margin=auto} est disponible et activée dans \ctex{ProfLycee}. + +\cmaj{2.1.2} Depuis la version \ctex{0.99} du package \ctex{piton}, \Cle{break-lines} est disponible et activée dans \ctex{ProfLycee}. + +\cmaj{2.1.3} Depuis la version \ctex{1.0} du package \ctex{piton}, \Cle{tabs-auto-gobble} est disponible et activée dans \ctex{ProfLycee}. \end{codeinfo} \begin{codeattention} @@ -2244,21 +2242,22 @@ Le package \ctex{piton} nécessite donc obligatoirement l’emploi de \LuaLaTeX{ \subsection{Présentation de code Python} \begin{codetex}[listing only] -\begin{CodePiton}[<options>] +\begin{CodePiton}[options] ... ... \end{CodePiton} \end{codetex} -\begin{codeattention} -Les environnements créés par \ctex{piton} et \ctex{tcolorbox} ne sont -- a priori -- pas compatibles avec les options de type \Cle{gobble} (pour supprimer les tabulations d'environnement), donc il faut bien penser à \og aligner \fg{} le code à gauche, pour éviter des tabulations non esthétiques ! -\end{codeattention} +%\begin{codeattention} +%Les environnements créés par \ctex{piton} et \ctex{tcolorbox} ne sont -- a priori -- pas compatibles avec les options de type \Cle{gobble} (pour supprimer les tabulations d'environnement), donc il faut bien penser à \og aligner \fg{} le code à gauche, pour éviter des tabulations non esthétiques ! +%\end{codeattention} \begin{codecles} Plusieurs \Cle{clés} sont disponibles : \begin{itemize} \item la clé booléenne \Cle{Lignes} pour afficher ou non les numéros de lignes ; \hfill{}défaut \Cle{true} + \item \cmaj{2.1.3} la clé booléenne \Cle{Gobble} pour activer les options liées au \textsf{gobble} (v1.0 du package !) ; \hfill{}défaut \Cle{true} \item la clé \Cle{Largeur} qui correspond à la largeur de la \ctex{tcbox} ; \hfill{}défaut \Cle{\textbackslash linewidth} \item la clé \Cle{TaillePolice} pour la taille des caractères ; \hfill{}défaut \Cle{\textbackslash footnotesize} \item la clé \Cle{Alignement} qui paramètre l'alignement de la \ctex{tcbox}. \hfill{}défaut \Cle{center} @@ -2268,18 +2267,26 @@ Plusieurs \Cle{clés} sont disponibles : \begin{codetex}[listing only] \begin{CodePiton} #environnement piton avec numéros de ligne, pleine largeur -def f(x) : - """fonction qui renvoie le carré d'un réel""" - return x**2 +def arctan(x,n=10): + if x < 0: + return -arctan(-x) #> (appel récursif) + elif x > 1: + return pi/2 - arctan(1/x) #> (autre appel récursif) + else: + return sum( (-1)**k/(2*k+1)*x**(2*k+1) for k in range(n) ) \end{CodePiton} \end{codetex} \begin{codesortie} \begin{CodePiton} #environnement piton avec numéros de ligne, pleine largeur -def f(x) : - """fonction qui renvoie le carré d'un réel""" - return x**2 +def arctan(x,n=10): + if x < 0: + return -arctan(-x) #> (appel récursif) + elif x > 1: + return pi/2 - arctan(1/x) #> (autre appel récursif) + else: + return sum( (-1)**k/(2*k+1)*x**(2*k+1) for k in range(n) ) \end{CodePiton} \end{codesortie} @@ -2289,46 +2296,62 @@ def f(x) : \begin{CodePiton}[Lignes=false,Largeur=15cm] #sans numéro, de largeur 15cm def f(x) : - """fonction qui renvoie le carré d'un réel""" return x**2 \end{CodePiton} \begin{CodePiton}[Alignement=flush right,Largeur=13cm] #avec numéros, de largeur 13cm, aligné à droite def f(x) : - """fonction qui renvoie le carré d'un réel""" return x**2 \end{CodePiton} \begin{CodePiton}[Alignement=flush left,Largeur=11cm] #avec numéros, de largeur 11cm, aligné à gauche def f(x) : - """fonction qui renvoie le carré d'un réel""" return x**2 \end{CodePiton} + +Avec des indentations d'environnement : + +\begin{itemize} + \item On essaye avec un \texttt{itemize} : + + \begin{CodePiton}[Largeur=7cm] + #avec numéros, de largeur 7cm, centré + def f(x) : + return x**2 + \end{CodePiton} +\end{itemize} \end{codetex} \begin{codesortie} \begin{CodePiton}[Lignes=false,Largeur=15cm] #sans numéro, de largeur 15cm def f(x) : - """fonction qui renvoie le carré d'un réel""" return x**2 \end{CodePiton} \begin{CodePiton}[Alignement=flush right,Largeur=13cm] #avec numéros, de largeur 13cm, aligné à droite def f(x) : - """fonction qui renvoie le carré d'un réel""" return x**2 \end{CodePiton} \begin{CodePiton}[Alignement=flush left,Largeur=11cm] #avec numéros, de largeur 11cm, aligné à gauche def f(x) : - """fonction qui renvoie le carré d'un réel""" return x**2 \end{CodePiton} + +\begin{itemize} + \item On essaye avec un \texttt{itemize} : + + \begin{CodePiton}[Largeur=7cm] + #avec numéros, de largeur 7cm, centré + def f(x) : + return x**2 + \end{CodePiton} +\end{itemize} \end{codesortie} \pagebreak @@ -2368,7 +2391,7 @@ L'environnement \ctex{CodePythontex} est donc lié à \ctex{pythontex} (chargé \end{codeidee} \begin{codetex}[listing only] -\begin{CodePythontex}[<options>] +\begin{CodePythontex}[options] ... \end{CodePythontex} \end{codetex} @@ -2428,7 +2451,7 @@ Le package \ctex{minted} nécessite quand même une compilation avec l'option \c \end{codeattention} \begin{codetex}[listing only] -\begin{CodePythonMinted}(*)[<largeur>][<options>] +\begin{CodePythonMinted}(*)[largeur][options] ... \end{CodePythonMinted} \end{codetex} @@ -2486,7 +2509,7 @@ C'est l'environnement \ctex{ConsolePythontex} qui permet de le faire. \end{codeidee} \begin{codetex}[listing only] -\begin{ConsolePythontex}[<options>] +\begin{ConsolePythontex}[options] ... \end{ConsolePythontex} \end{codetex} @@ -2576,7 +2599,7 @@ De plus, le package \ctex{listings} avec \ctex{tcolorbox} ne permet pas de gére \end{codeattention} \begin{codetex}[listing only] -\begin{PseudoCode}(*)[<largeur>][<options>] +\begin{PseudoCode}(*)[largeur][options] %attention à l'indentation, gobble ne fonctionne pas... ... \end{PseudoCode} @@ -2697,15 +2720,15 @@ Comme pour le pseudo-code, pas d'\textsf{autogobble}, donc commandes à aligner \subsection{Commandes} \begin{codetex}[listing only] -\begin{TerminalWin}[<largeur>]{<titre=...>}[<options>] +\begin{TerminalWin}[largeur]{titre=...}[options] ... \end{TerminalWin} -\begin{TerminalUnix}[<largeur>]{<titre=...>}[<options>] +\begin{TerminalUnix}[largeur]{titre=...}[options] ... \end{TerminalUnix} -\begin{TerminalOSX}[<largeur>]{<titre=...>}[<options>] +\begin{TerminalOSX}[largeur]{titre=...}[options] ... \end{TerminalOSX} \end{codetex} @@ -2806,7 +2829,7 @@ L'idée est d'obtenir des \textsf{cartouches} tels que \textsf{Capytale} les pr \subsection{Commandes} \begin{codetex}[listing only] -\CartoucheCapytale(*)[<options>]{<code capytale>} +\CartoucheCapytale(*)[options]{code capytale} \end{codetex} \begin{codecles} @@ -2871,7 +2894,7 @@ Il s'agir d'un environnement créé en \ctex{tcolorbox}, et utilisant la présen \subsection{Commandes} \begin{codetex}[listing only] -\begin{PresentationCode}[<Couleur>]{<options tcbox>} +\begin{PresentationCode}[Couleur]{options tcbox} ... \end{PresentationCode} \end{codetex} @@ -2922,8 +2945,8 @@ L'idée est d'obtenir un pavé droit, dans un environnement \TikZ, avec les nœu \begin{codetex}[listing only] ... -\begin{tikzpicture}[<options tikz>] - \PaveTikz[<options>] +\begin{tikzpicture}[options tikz] + \PaveTikz[options] ... \end{tikzpicture} \end{codetex} @@ -3009,8 +3032,8 @@ L'idée est d'obtenir un tétraèdre, dans un environnement \TikZ, avec les nœu \begin{codetex}[listing only] ... -\begin{tikzpicture}[<options tikz>] - \TetraedreTikz[<options>] +\begin{tikzpicture}[options tikz] + \TetraedreTikz[options] ... \end{tikzpicture} \end{codetex} @@ -3075,7 +3098,7 @@ Pour \textit{illustrer} un peu les \Cle{clés}, un petit schéma, avec les diff \begin{center} \begin{tikzpicture}[line join=bevel] \TetraedreTikz[Aff,Largeur=7,Profondeur=3,Hauteur=5,Epaisseur={ultra thick},Alpha=20,Beta=30] - \draw[very thick,ForestGreen,<->] ($(A)!0.5!(D)$)--($(B)!0.5!(D)$) ; + \draw[very thick,ForestGreen,<->,>=latex] ($(A)!0.5!(D)$)--($(B)!0.5!(D)$) ; \end{tikzpicture} \end{center} \end{codetex} @@ -3084,7 +3107,7 @@ Pour \textit{illustrer} un peu les \Cle{clés}, un petit schéma, avec les diff \begin{center} \begin{tikzpicture}[line join=bevel] \TetraedreTikz[Aff,Largeur=7,Profondeur=3,Hauteur=5,Epaisseur={ultra thick},Alpha=20,Beta=30] - \draw[very thick,ForestGreen,<->] ($(A)!0.5!(D)$)--($(B)!0.5!(D)$) ; + \draw[very thick,ForestGreen,<->,>=latex] ($(A)!0.5!(D)$)--($(B)!0.5!(D)$) ; \end{tikzpicture} \end{center} \end{codesortie} @@ -3136,9 +3159,9 @@ Comme pour les autres commandes \TikZ, l'idée est de laisser l'utilisateur déf \begin{codetex}[listing only] ... -\begin{tikzpicture}[<options tikz>] +\begin{tikzpicture}[options tikz] ... - \CercleTrigo[<clés>] + \CercleTrigo[clés] ... \end{tikzpicture} \end{codetex} @@ -3352,7 +3375,7 @@ L'idée est que cette macro calcule et stocke les paramètres dans des variables \begin{codetex}[listing only] ... -\CalculsRegLin[<clés>]{<listeX>}{<listeY>} %listes avec éléments séparés par des , +\CalculsRegLin[clés]{listeX}{listeY} %listes avec éléments séparés par des , ... \end{codetex} @@ -3497,7 +3520,7 @@ La commande étant \og autonome \fg{}, elle va pouvoir être intégrée dans des \begin{codetex}[listing only] \begin{tikzpicture} - \begin{axis}[<options des axes, non présentées ici...>] + \begin{axis}[options des axes, non présentées ici...] \addplot[teal, only marks] table{ X Y 1994 1718 1995 1710 1996 1708 1997 1700 1998 1698 1999 1697 2000 1691 2001 1688 @@ -3572,7 +3595,7 @@ Il existe également une commande auxiliaire, \ctex{PointsRegLin} pour afficher ... \begin{tikzpicture}[<options>] ... - \PointsRegLin[<clés>]{<listeX>}{<listeY>} + \PointsRegLin[clés]{listeX}{listeY} ... \end{tikzpicture} \end{codetex} @@ -3592,8 +3615,8 @@ Quelques \Cle{Clés} sont disponibles pour cette commande, essentiellement pour \begin{tikzpicture}[x=0.5cm,y=0.05cm] \draw[xstep=1,ystep=5,lightgray!50,very thin] (0,0) grid (20,100); \draw[xstep=2,ystep=10,lightgray,thin] (0,0) grid (20,100); - \draw[thick,->] (0,0)--(20,0) ; - \draw[thick,->] (0,0)--(0,100) ; + \draw[thick,->,>=latex] (0,0)--(20,0) ; + \draw[thick,->,>=latex] (0,0)--(0,100) ; \foreach \x in {1992,1994,...,2010} \draw[thick] ({\x-1992},4pt)--({\x-1992},-4pt) node[below] {$\x$} ; \foreach \y in {1640,1650,...,1730} \draw[thick] (4pt,{\y-1640})--(-4pt,{\y-1640}) node[left] {$\y$} ; \def\LLX{1994,1995,1996,1997,1998,1999,2000,2001,2002,2004,2005,2006,2007,2008,2009,2010} @@ -3613,8 +3636,8 @@ Quelques \Cle{Clés} sont disponibles pour cette commande, essentiellement pour \begin{tikzpicture}[x=0.5cm,y=0.05cm] \draw[xstep=1,ystep=5,lightgray!50,very thin] (0,0) grid (20,100); \draw[xstep=2,ystep=10,lightgray,thin] (0,0) grid (20,100); - \draw[thick,->] (0,0)--(20,0) ; - \draw[thick,->] (0,0)--(0,100) ; + \draw[thick,->,>=latex] (0,0)--(20,0) ; + \draw[thick,->,>=latex] (0,0)--(0,100) ; \foreach \x in {1992,1994,...,2010} \draw[thick] ({\x-1992},4pt)--({\x-1992},-4pt) node[below] {$\x$} ; \foreach \y in {1640,1650,...,1730} \draw[thick] (4pt,{\y-1640})--(-4pt,{\y-1640}) node[left] {$\y$} ; \def\LLX{1994,1995,1996,1997,1998,1999,2000,2001,2002,2004,2005,2006,2007,2008,2009,2010} @@ -3747,7 +3770,7 @@ Pour illustrer les commandes et options de ce paragraphe, la base sera le graphi \begin{codetex}[listing only] %...code tikz - \GrilleTikz[<options>][<options grille ppale>][<options grille second.>] + \GrilleTikz[options][options grille ppale][options grille second.] \end{codetex} \begin{codecles} @@ -3795,7 +3818,7 @@ Cette commande permet de tracer une grille principale et/ou une grille secondair \begin{codetex}[listing only] %...code tikz - \AxesTikz[<options>] + \AxesTikz[options] \end{codetex} \begin{codecles} @@ -3804,13 +3827,15 @@ Cette commande permet de tracer les axes, avec des \Cle{clés} : \begin{itemize} \item \Cle{Epaisseur} qui est l'épaisseur des traits ; \hfill~défaut \Cle{1.25pt} \item \Cle{Police} qui est le style des labels des axes ; \hfill~défaut \Cle{\textbackslash{}normalsize\textbackslash{}normalfont} + \item \cmaj{2.1.2} \Cle{ElargirOx} qui est le \% l'élargissement \Cle{global} ou \Cle{G/D} de l'axe $(Ox)$ ;\hfill~défaut \Cle{0/0.05} + \item \cmaj{2.1.2} \Cle{ElargirOy} qui est le \% l'élargissement \Cle{global} ou \Cle{B/H} de l'axe $(Oy)$ ;\hfill~défaut \Cle{0/0.05} \item \Cle{Labelx} qui est le label de l'axe $(Ox)$ ; \hfill~défaut \Cle{\${}x\$} \item \Cle{Labely} qui est le label de l'axe $(Oy)$ ; \hfill~défaut \Cle{\${}y\$} \item \Cle{AffLabel} qui est le code pour préciser quels labels afficher, entre \Cle{x}, \Cle{y} ou \Cle{xy} ; \hfill~défaut \Cle{vide} \item \Cle{PosLabelx} pour la position du label de $(Ox)$ en bout d'axe ; \hfill~défaut \Cle{right} \item \Cle{PosLabely} pour la position du label de $(Oy)$ en bout d'axe ; \hfill~défaut \Cle{above} \item \Cle{EchelleFleche} qui est l'échelle de la flèche des axes ; \hfill~défaut \Cle{1} - \item \Cle{TypeFleche} qui est le type de la flèche des axes.\hfill~défaut \Cle{>} + \item \Cle{TypeFleche} qui est le type de la flèche des axes.\hfill~défaut \Cle{latex} \end{itemize} \end{codecles} @@ -3850,8 +3875,8 @@ Cette commande permet de tracer les axes, avec des \Cle{clés} : \begin{codetex}[listing only] %...code tikz - \AxexTikz[<options>]{valeurs} - \AxeyTikz[<options>]{valeurs} + \AxexTikz[options]{valeurs} + \AxeyTikz[options]{valeurs} \end{codetex} \begin{codecles} @@ -3886,8 +3911,8 @@ Ces commande permet de tracer les graduations des axes, avec des \Cle{clés} ide [x=0.35cm,y=0.07cm,% Ox=1992,xmin=1992,xmax=2012,xgrille=2,xgrilles=1,% Oy=1640,ymin=1640,ymax=1730,ygrille=10,ygrilles=5] - \draw[gray,line width=1.25pt,->] ({\xmin-\axexOx},0) -- ({\xmax-\axexOx},0) ; - \draw[gray,line width=1.25pt,->] (0,{\ymin-\axeyOy}) -- (0,{\ymax-\axeyOy}) ; + \draw[gray,line width=1.25pt,->,>=latex] ({\xmin-\axexOx},0) -- ({\xmax-\axexOx},0) ; + \draw[gray,line width=1.25pt,->,>=latex] (0,{\ymin-\axeyOy}) -- (0,{\ymax-\axeyOy}) ; \AxexTikz[Police=\small]{1992,1994,...,2010} \AxeyTikz{1640,1650,...,1720} \end{tikzpicture} @@ -3896,8 +3921,8 @@ Ces commande permet de tracer les graduations des axes, avec des \Cle{clés} ide [x=0.35cm,y=0.07cm,% Ox=1992,xmin=1992,xmax=2012,xgrille=2,xgrilles=1,% Oy=1640,ymin=1640,ymax=1730,ygrille=10,ygrilles=5] - \draw[gray,line width=1.25pt,->] ({\xmin-\axexOx},0) -- ({\xmax-\axexOx},0) ; - \draw[gray,line width=1.25pt,->] (0,{\ymin-\axeyOy}) -- (0,{\ymax-\axeyOy}) ; + \draw[gray,line width=1.25pt,->,>=latex] ({\xmin-\axexOx},0) -- ({\xmax-\axexOx},0) ; + \draw[gray,line width=1.25pt,->,>=latex] (0,{\ymin-\axeyOy}) -- (0,{\ymax-\axeyOy}) ; \AxexTikz[Police=\small,Annee,HautGrad=0pt/4pt]{1992,1994,...,2010} \AxeyTikz[AffGrad=false,HautGrad=6pt]{1640,1650,...,1720} \end{tikzpicture} @@ -3918,8 +3943,8 @@ Il existe, de manière marginale, quelques commandes complémentaires qui ne ser \begin{codetex}[listing only] %code tikz - \FenetreTikz %on restreint les tracés - \FenetreSimpleTikz<options axe Ox>{liste abscisses}<options axe Oy>{liste ordonnées} + \FenetreTikz %on restreint les tracés + \FenetreSimpleTikz[opt](opt axes)<opt axe Ox>{liste valx}<opt axe Oy>{liste valy} \end{codetex} %%l'origine @@ -3933,7 +3958,7 @@ Il existe, de manière marginale, quelques commandes complémentaires qui ne ser \begin{codetex}[listing only] %...code tikz - \NuagePointsTikz[<options>]{listeX}{listeY} + \NuagePointsTikz[options]{listeX}{listeY} \end{codetex} \begin{codecles} @@ -3982,7 +4007,7 @@ Cette commande, liée à la commande \ctex{CalculsRegLin} permet de représenter %point moyen \begin{codetex}[listing only] %...code tikz - \PointMoyenTikz[<options>] + \PointMoyenTikz[options] \end{codetex} \begin{codecles} @@ -4043,7 +4068,7 @@ Cette commande permet de rajouter le point moyen du nuage, calculé par la comma %courbe \begin{codetex}[listing only] %...code tikz - \CourbeTikz[<options>]{formule}{domaine} + \CourbeTikz[options]{formule}{domaine} \end{codetex} \begin{codecles} @@ -4081,7 +4106,7 @@ L'idée principale est de récupérer les variables de la régression linéaire \CalculsRegLin{\LLX}{\LLY} \begin{tikzpicture}[x=0.35cm,y=0.07cm,Ox=1992,xmin=1992,xmax=2012,xgrille=2,xgrilles=1,Oy=1640,ymin=1640,ymax=1730,ygrille=10,ygrilles=5] - \GrilleTikz \AxesTikz + \GrilleTikz \AxesTikz[ElargirOx=0,ElargirOy=0] \AxexTikz[Annee,Police=\small]{1992,1994,...,2010} \AxeyTikz{1640,1650,...,1720} \NuagePointsTikz[Couleur=blue/red]{\LLX}{\LLY} \PointMoyenTikz @@ -4104,7 +4129,7 @@ L'idée principale est de récupérer les variables de la régression linéaire \def\LLY{1718,1710,1708,1700,1698,1697,1691,1688,1683,1679,1671,1670,1663,1661,1656,1649} \begin{tikzpicture}[x=0.35cm,y=0.07cm,Ox=1992,xmin=1992,xmax=2012,xgrille=2,xgrilles=1,Oy=1640,ymin=1640,ymax=1730,ygrille=10,ygrilles=5] - \GrilleTikz \AxesTikz + \GrilleTikz \AxesTikz[ElargirOx=0,ElargirOy=0] \AxexTikz[Annee,Police=\small]{1992,1994,...,2010} \AxeyTikz{1640,1650,...,1720} \NuagePointsTikz[Couleur=blue/red]{\LLX}{\LLY} \FenetreTikz @@ -4528,11 +4553,11 @@ Les (deux) commandes sont donc liées à un environnement \ctex{tikzpicture}, et \begin{codetex}[listing only] %commande simple pour tracé de l'arbre -\ArbreProbasTikz[<options>]{<donnees>} +\ArbreProbasTikz[options]{donnees} %environnement pour tracé et exploitation éventuelle -\begin{EnvArbreProbasTikz}[<options>]{<donnees>} - <code tikz supplémentaire> +\begin{EnvArbreProbasTikz}[options]{donnees} + code tikz supplémentaire \end{EnvArbreProbasTikz} \end{codetex} @@ -4588,11 +4613,11 @@ Quelques \Cle{Clés} (communes) pour les deux commandes : \draw[lightgray] (A22) node[below,font=\ttfamily\small] {(A22)} ; \draw[lightgray] (A23) node[below,font=\ttfamily\small] {(A23)} ; \draw[lightgray] (A24) node[below,font=\ttfamily\small] {(A24)} ; - \draw[lightgray,<->] (0,-4) -- (3.25,-4) node[midway,below,font=\ttfamily\small] {EspaceNiveau} ; - \draw[lightgray,<->] (3.25,-4) -- (6.5,-4) node[midway,below,font=\ttfamily\small] {EspaceNiveau} ; - \draw[lightgray,<->] (7,0) -- (7,-1) node[midway,right,font=\ttfamily\small] {EspaceFeuille} ; - \draw[lightgray,<->] (7,-1) -- (7,-2) node[midway,right,font=\ttfamily\small] {EspaceFeuille} ; - \draw[lightgray,<->] (7,-2) -- (7,-3) node[midway,right,font=\ttfamily\small] {EspaceFeuille} ; + \draw[lightgray,<->,>=latex] (0,-4) -- (3.25,-4) node[midway,below,font=\ttfamily\small] {EspaceNiveau} ; + \draw[lightgray,<->,>=latex] (3.25,-4) -- (6.5,-4) node[midway,below,font=\ttfamily\small] {EspaceNiveau} ; + \draw[lightgray,<->,>=latex] (7,0) -- (7,-1) node[midway,right,font=\ttfamily\small] {EspaceFeuille} ; + \draw[lightgray,<->,>=latex] (7,-1) -- (7,-2) node[midway,right,font=\ttfamily\small] {EspaceFeuille} ; + \draw[lightgray,<->,>=latex] (7,-2) -- (7,-3) node[midway,right,font=\ttfamily\small] {EspaceFeuille} ; \end{EnvArbreProbasTikz} \end{codesortie} @@ -4772,16 +4797,16 @@ Pour chacune des commandes, le ou les résultats sont stockés dans une \textsf{ \begin{codetex}[listing only] %entier aléatoire entre a et b -\NbAlea{a}{b}{<macro>} +\NbAlea{a}{b}{macro} %nombre décimal (n chiffres après la virgule) aléatoire entre a et b+1 (exclus) -\NbAlea[n]{a}{b}{<macro>} +\NbAlea[n]{a}{b}{macro} %création d'un nombre aléatoire sous forme d'une macro -\VarNbAlea{<macro>}{<calculs>} +\VarNbAlea{macro}{calculs} %liste d'entiers aléatoires -\TirageAleatoireEntiers[<options>]{<macro>} +\TirageAleatoireEntiers[options]{macro} \end{codetex} \begin{codetex}[] @@ -4902,7 +4927,7 @@ Les macros présentées ici ne font que les intégrer dans un environnement adap \subsection{Conversion décimal vers binaire} \begin{codetex}[listing only] -\ConversionDecBin(*)[<clés>]{<nombre>} +\ConversionDecBin(*)[clés]{nombre} \end{codetex} \begin{codecles} @@ -4962,7 +4987,7 @@ L'idée est ici de présenter la conversion, grâce à la conversion \og directe \end{codeinfo} \begin{codetex}[listing only] -\ConversionBinHex[<clés>]{<nombre>} +\ConversionBinHex[clés]{nombre} \end{codetex} \begin{codecles} @@ -5009,14 +5034,14 @@ L'idée est ici de présenter la conversion, grâce à l'écriture polynômiale \end{codeinfo} \begin{codetex}[listing only] -\ConversionVersDec[<clés>]{<nombre>} +\ConversionVersDec[clés]{nombre} \end{codetex} \begin{codecles} Quelques \Cle{clés} sont disponibles pour cette commande : \begin{itemize} - \item la clé \Cle{BaseDp} qui est la base de départ (2 ou 16 !) ; \hfill{}défaut \Cle{2} + \item la clé \Cle{BaseDep} qui est la base de départ (2 ou 16 !) ; \hfill{}défaut \Cle{2} \item le booléen \Cle{AffBase} qui permet d'afficher ou non la base des nombres ; \hfill{}défaut \Cle{true} \item le booléen \Cle{Details} qui permet d'afficher ou le détail par bloc de 4 ; \hfill{}défaut \Cle{true} \item le booléen \Cle{Zeros} qui affiche les chiffres 0 dans la somme. \hfill{}défaut \Cle{true} @@ -5086,7 +5111,7 @@ La \og tableau \fg, qui est géré par \ctex{array} est inséré dans un \ctex{e \end{codeinfo} \begin{codetex}[listing only] -\ConversionDepuisBaseDix[<options>]{<nombre en base 10>}{<base d'arrivée>} +\ConversionDepuisBaseDix[options]{nombre en base 10}{base d'arrivée} \end{codetex} \begin{codecles} @@ -5155,7 +5180,7 @@ Le package \ctex{xintgcd} permet déjà de le faire, il s'agit ici de travailler \end{codeidee} \begin{codetex}[listing only] -\PresentationPGCD[<options>]{a}{b} +\PresentationPGCD[options]{a}{b} \end{codetex} \begin{codetex}[listing only] @@ -5245,7 +5270,7 @@ L'idée est d'obtenir une commande pour \textit{simplifier} un calcul sous forme \end{codeidee} \begin{codetex}[listing only] -\ConversionFraction[<option>]{<argument>} +\ConversionFraction[option]{argument} \end{codetex} \subsection{Commande et options} @@ -5340,7 +5365,7 @@ Les délimiteurs de l'ensemble créé sont toujours \textsf{\{~~\}}. \end{codeidee} \begin{codetex}[listing only] -\EcritureEnsemble[<clés>]{<liste>} +\EcritureEnsemble[clés]{liste} \end{codetex} \subsection{Commande et options} @@ -5410,7 +5435,7 @@ L'affichage des monômes est géré par le package \ctex{siunitx} et le tout est \end{codeidee} \begin{codetex}[listing only] -\EcritureTrinome[<options>]{a}{b}{c} +\EcritureTrinome[options]{a}{b}{c} \end{codetex} \begin{codetex}[] @@ -5460,7 +5485,7 @@ Avec $a$ entre 1 et 10 (forcément positif) puis $b$ entre $-2$ et 2 puis $c$ en \end{codeidee} \begin{codetex}[listing only] -\SimplificationRacine{<expression ou calcul>} +\SimplificationRacine{expression ou calcul} \end{codetex} \begin{codetex}[] @@ -5496,6 +5521,81 @@ $\sqrt{\num{150}\times\num{0.35}\times(1-\num{0.35})}=\displaystyle\Simplificati \newpage +\section{Mesure principale d'un angle}\label{mesureprincipale} + +\subsection{Idée} + +\begin{codeidee} +\cmaj{2.1.2} L'idée est de proposer (sur une suggestion de Marylyne Vignal) une commande pour déterminer la mesure principale d'un angle en radian. +\end{codeidee} + +\begin{codetex}[listing only] +\MesurePrincipale[booléens]{angle} %dans un mode mathématique +\end{codetex} + +\begin{codeinfo} +La commande est à insérer dans un environnement mathématique, via \ctex{\$...\$} ou \ctex{\textbackslash[...\textbackslash]}. + +L'angle peut être donné sous forme \textit{explicite} avec la chaîne \ctex{pi}. +\end{codeinfo} + +\subsection{Exemples} + +\begin{codecles} +Pour cette commande : + +\begin{itemize} + \item le booléen \Cle{d} permet de forcer l'affichage en \ctex{displaystyle} ;\hfill{}défaut \Cle{false} + \item le booléen \Cle{Crochets} permet d'afficher le \textit{modulo} entre crochets plutôt qu'entre parenthèses ;\hfill{}défaut \Cle{false} + \item l'argument mandataire est en écriture \textit{en ligne}. +\end{itemize} +\end{codecles} + +\begin{codetex}[listing only] +$\MesurePrincipale[d]{54pi/7}$ +$\MesurePrincipale[d]{-128pi/15}$ +$\MesurePrincipale{3pi/2}$ +$\MesurePrincipale[Crochets]{5pi/2}$ +$\MesurePrincipale{-13pi}$ +$\MesurePrincipale{28pi}$ +$\MesurePrincipale[d]{14pi/4}$ +$\MesurePrincipale[Crochets]{14pi/7}$ +\end{codetex} + +\begin{codesortie} +$\MesurePrincipale[d]{54pi/7}$ + +\medskip + +$\MesurePrincipale{-128pi/15}$ + +\medskip + +$\MesurePrincipale{3pi/2}$ + +\medskip + +$\MesurePrincipale[Crochets]{5pi/2}$ + +\medskip + +$\MesurePrincipale{-13pi}$ + +\medskip + +$\MesurePrincipale{28pi}$ + +\medskip + +$\MesurePrincipale[d]{14pi/4}$ + +\medskip + +$\MesurePrincipale[Crochets]{14pi/7}$ +\end{codesortie} + +\pagebreak + \part{Jeux et récréations} \section{PixelART via un fichier csv, en \TikZ}\label{pixelart} @@ -5627,7 +5727,7 @@ La commande \ctex{PixelArtTikz} nécessite de connaître : \begin{codetex}[listing only] %environnement tikz -\PixelArtTikz[<clés>]{<fichier>.csv} +\PixelArtTikz[clés]{<fichier>.csv} \end{codetex} \begin{codecles} @@ -5748,7 +5848,7 @@ Les symboles affichés dans les cases sont situés aux nœuds de coordonnées $( \PixelArtTikz[Codes=123469,Couleurs={Red,Brown,Yellow,Black,Blue,White},Correction]{perroquet.csv} \filldraw[Blue] (14,-1) circle[radius=1] ; \filldraw[Yellow] (14,-1) circle[radius=0.8] ; - \draw[ForestGreen,very thick,<-] (15,-1) to[bend left=30] (18,-2) node[right,font=\scriptsize\sffamily] {rajouté en \TikZ} ; + \draw[ForestGreen,very thick,<-,>=latex] (15,-1) to[bend left=30] (18,-2) node[right,font=\scriptsize\sffamily] {rajouté en \TikZ} ; \end{tikzpicture} \end{center} \end{codesortie} @@ -5757,7 +5857,8 @@ Les symboles affichés dans les cases sont situés aux nœuds de coordonnées $( %code tikz et pixelart \filldraw[Blue] (14,-1) circle[radius=1] ; \filldraw[Yellow] (14,-1) circle[radius=0.8] ; -\draw[ForestGreen,very thick,<-] (15,-1) to[bend left=30] (18,-2) node[right,font=\scriptsize\sffamily] {rajouté en \TikZ} ; +\draw[ForestGreen,very thick,<-,>=latex] (15,-1) to[bend left=30] (18,-2) + node[right,font=\scriptsize\sffamily] {rajouté en \TikZ} ; \end{codetex} \pagebreak @@ -5868,11 +5969,11 @@ Si on veut exploiter le tracé de la grille, on peut utiliser l'\textit{environn \begin{codetex}[listing only] %grille "toute seule" -\SudoMaths[<options>]{<liste>} +\SudoMaths[options]{liste} %grille avec ajout de code -\begin{EnvSudoMaths}[<options>]{<grille>} - <commandes tikz> ; +\begin{EnvSudoMaths}[options]{grille} + commandes tikz \end{EnvSudoMaths} \end{codetex} @@ -5966,7 +6067,7 @@ La grille, créée en \TikZ, est portée par le rectangle de \og coins \fg{} $(0 \begin{EnvSudoMaths}[% Unite=0.66cm,Police=\footnotesize\bfseries\ttfamily,CouleurCase=ForestGreen!50,% ListeLegV=QSDFGHJKL,ListeLegH=poiuytrez]{\grilleSuMaB} - \draw[red,very thick,<-] (7.5,-4.5) to[bend right] ++ (4,-1) node[right] {code rajouté...} ; + \draw[red,very thick,<-,>=latex] (7.5,-4.5) to[bend right] ++ (4,-1) node[right] {code rajouté...} ; \end{EnvSudoMaths} \end{codetex} @@ -5986,7 +6087,7 @@ La grille, créée en \TikZ, est portée par le rectangle de \og coins \fg{} $(0 \begin{EnvSudoMaths}[% Unite=0.66cm,Police=\footnotesize\bfseries\ttfamily,CouleurCase=ForestGreen!50,% ListeLegV=QSDFGHJKL,ListeLegH=poiuytrez]{\grilleSuMaB} - \draw[red,very thick,<-] (7.5,-4.5) to[bend right] ++ (4,-1) node[right] {code rajouté pour montrer la case \textsf{Ge}} ; + \draw[red,very thick,<-,>=latex] (7.5,-4.5) to[bend right] ++ (4,-1) node[right] {code rajouté pour montrer la case \textsf{Ge}} ; \foreach \x in {0,1,...,9} \draw[lightgray] (\x,-9) node[below,font=\scriptsize\ttfamily] {\x} ; \foreach \y in {-1,-2,...,-9} \draw[lightgray] (9,\y) node[right,font=\scriptsize\ttfamily] {\y} ; \draw[lightgray] (9,0) node[right,font=\scriptsize\ttfamily] {~0} ; @@ -5997,6 +6098,10 @@ La grille, créée en \TikZ, est portée par le rectangle de \og coins \fg{} $(0 \part{Historique} +{\small \bverb|v 2.1.3|~:~~~~Améliorations dans les présentations \textsf{Piton} (page \pageref{pythonpiton}) + +{\small \bverb|v 2.1.2|~:~~~~Ajout d'une commande pour la mesure principale d'un angle (page \pageref{mesureprincipale}) + {\small \bverb|v 2.1.1|~:~~~~Ajout d'une section pour des repères en \TikZ{} (page \pageref{reperagetikz}) {\small \bverb|v 2.1.0|~:~~~~Calcul du seuil, en interne désormais (page \pageref{calcrecurr}) diff --git a/macros/latex/contrib/proflycee/tex/ProfLycee.sty b/macros/latex/contrib/proflycee/tex/ProfLycee.sty index dd2d5b02f0..c16b078219 100644 --- a/macros/latex/contrib/proflycee/tex/ProfLycee.sty +++ b/macros/latex/contrib/proflycee/tex/ProfLycee.sty @@ -3,7 +3,9 @@ % or later, see http://www.latex-project.org/lppl.txtf \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{ProfLycee}[2022/12/28 2.1.1 Aide pour l'utilisation de LaTeX en lycee] +\ProvidesPackage{ProfLycee}[2022/12/30 2.1.3 Aide pour l'utilisation de LaTeX en lycee] +% 2.1.3 Ajout de l'option auto-tabs-gobble sur piton (v1.0) + correction d'un bug sur CodePiton +% 2.1.2 Ajout d'une commande pour déterminer la mesure principale d'un angle + option <ElargirOx/y> pour les axes % 2.1.1 Ajout d'une section pour les tracés de repère et courbe, en tikz % 2.1.0 Ajout du calcul du seuil pour les suites récurrentes + racines de nombres décimaux + option pour pythontex % 2.0.9 Ajouts de commandes pour générer des nombres et listes aléatoires @@ -632,8 +634,29 @@ Largeur=\linewidth,% Alignement=center,% Lignes=true,% + Gobble=true,% TaillePolice=\footnotesize } + +\tcbset{stylepiton/.style={% + enhanced,boxrule=1.25pt,% + sharp corners=downhill,arc=12pt, + before skip=12pt,after skip=12pt,% + top=10pt,bottom=1mm,rightupper=4pt,%leftupper=25pt, + attach boxed title to top right={yshift=-\tcboxedtitleheight}, + boxed title style={ + size=small,colback=ForestGreen!25,boxrule=1.25pt, + colframe=Green,boxsep=1.25pt, + sharp corners=downhill, + arc=12pt, + top=2pt,bottom=1pt,left=6pt,right=6pt + }, + fonttitle=\color{ForestGreen}\itshape\ttfamily\footnotesize, + title={\scriptsize\faPython}\:Code Python\vphantom{p}, + watermark text={\faPython},watermark opacity=0.175,watermark zoom=0.50, + } +} + \ifluatex \RequirePackage{piton} \NewPitonEnvironment{CodePiton}{ O{} }% @@ -641,13 +664,17 @@ \useKVdefault[envpiton]% \setKV[envpiton]{#1}% on paramètres les nouvelles clés et on les simplifie \ifboolKV[envpiton]{Lignes}%si lignes=true - {\PitonOptions{left-margin=auto,line-numbers}}% - {\PitonOptions{}}% - \begin{tcolorbox}[stylepythontex,leftupper=8pt,colframe=Green,colback=ForestGreen!5,width=\CODPITlargeur,fontupper=\CODPITfonte,fontlower=\CODPITfonte,\CODPITalign] + {\PitonOptions{left-margin=auto,all-line-numbers}}% + {}% + \ifboolKV[envpiton]{Gobble}%si gobble=true + {\PitonOptions{tabs-auto-gobble}}% + {}% + \PitonOptions{break-lines,indent-broken-lines}% + \begin{tcolorbox}[stylepiton,leftupper=8pt,colframe=Green,colback=ForestGreen!5,width=\CODPITlargeur,fontupper=\CODPITfonte,fontlower=\CODPITfonte,\CODPITalign] }% {% \end{tcolorbox}% - } + }% \fi %=========PSEUDOCODE=========== OK !! @@ -1156,8 +1183,8 @@ }% {} %tracés - \draw[\PLcerclethick,->] ({-\PLcerclerayon-\PLcerclemarge},0)--({\PLcerclerayon+\PLcerclemarge},0) ; - \draw[\PLcerclethick,->] (0,{-\PLcerclerayon-\PLcerclemarge})--(0,{\PLcerclerayon+\PLcerclemarge}) ; + \draw[\PLcerclethick,->,>=latex] ({-\PLcerclerayon-\PLcerclemarge},0)--({\PLcerclerayon+\PLcerclemarge},0) ; + \draw[\PLcerclethick,->,>=latex] (0,{-\PLcerclerayon-\PLcerclemarge})--(0,{\PLcerclerayon+\PLcerclemarge}) ; \draw[\PLcerclethick] (0,0) circle[radius=\PLcerclerayon] ; \draw (0,0) node[below left=2pt,PLval] {0} ; %equations @@ -1880,7 +1907,9 @@ PosLabely=\def\axesposlabely{#1},% EchelleFleche=\def\axesechellefleche{#1},% TypeFleche=\def\axestypefleche{#1},% - AffLabel=\def\axesafflabel{#1} + AffLabel=\def\axesafflabel{#1},% + ElargirOx=\def\axeselargx{#1},% + ElargirOy=\def\axeselargy{#1} } \setKVdefault[PLaxestkz]{% @@ -1892,15 +1921,28 @@ PosLabelx=right,% PosLabely=above,% EchelleFleche=1,% - TypeFleche=> + TypeFleche=latex,% + ElargirOx=0/0.05,% + ElargirOy=0/0.05 } \DeclareDocumentCommand\AxesTikz{ O{} }{% \useKVdefault[PLaxestkz] \setKV[PLaxestkz]{#1}% + %les petits élargissements + \IfSubStr{\axeselargx}{/} + {\StrCut{\axeselargx}{/}{\axeselargxG}{\axeselargxD}} + {\def\axeselargxG{\axeselargx}\def\axeselargxD{\axeselargx}} + \def\axesenlargxG{\fpeval{\axeselargxG*(\xmax-\xmin)}} + \def\axesenlargxD{\fpeval{\axeselargxD*(\xmax-\xmin)}} + \IfSubStr{\axeselargy}{/} + {\StrCut{\axeselargy}{/}{\axeselargyG}{\axeselargyD}} + {\def\axeselargyG{\axeselargy}\def\axeselargyD{\axeselargy}} + \def\axesenlargyG{\fpeval{\axeselargyG*(\ymax-\ymin)}} + \def\axesenlargyD{\fpeval{\axeselargyD*(\ymax-\ymin)}} %on affiche les deux axes - \draw[line width=\axeswidth,-{\axestypefleche[scale=\axesechellefleche]}] ({\xmin-\axexOx},0) -- ({\xmax-\axexOx},0) ; - \draw[line width=\axeswidth,-{\axestypefleche[scale=\axesechellefleche]}] (0,{\ymin-\axeyOy}) -- (0,{\ymax-\axeyOy}) ; + \draw[line width=\axeswidth,-{\axestypefleche[scale=\axesechellefleche]}] ({\xmin-\axexOx-\axesenlargxG},0) -- ({\xmax-\axexOx+\axesenlargxD},0) ; + \draw[line width=\axeswidth,-{\axestypefleche[scale=\axesechellefleche]}] (0,{\ymin-\axeyOy-\axesenlargyG}) -- (0,{\ymax-\axeyOy++\axesenlargyD}) ; %les labels éventuels \IfSubStr{\axesafflabel}{x}% {\draw ({\xmax-\axexOx},0) node[\axesposlabelx,font=\axesfont] {\axeslabelx} ;} @@ -2076,14 +2118,16 @@ Grille=true,% } -\DeclareDocumentCommand\FenetreSimpleTikz{ O{} D<>{} m D<>{} m }{% +\DeclareDocumentCommand\FenetreSimpleTikz{ O{} D(){} D<>{} m D<>{} m }{% \useKVdefault[PLsimplewindow]% \setKV[PLsimplewindow]{#1}% on paramètres les nouvelles clés et on les simplifie \ifboolKV[PLsimplewindow]{Grille}% {\GrilleTikz}% {}% \ifboolKV[PLsimplewindow]{Axes}% - {\AxesTikz\AxexTikz[#2]{#3}\AxeyTikz[#4]{#5}}% + {\AxesTikz[#2]% + \AxexTikz[#3]{#4} + \AxeyTikz[#5]{#6}}% {}% } @@ -2136,7 +2180,7 @@ \def\BaMaxelargeur{\fpeval{\BaMAxeMax-\BaMAxeMin}} \def\BaMaxexmin{\fpeval{\BaMAxeMin-\BaMAxeElarg*\BaMaxelargeur}} \def\BaMaxexmax{\fpeval{\BaMAxeMax+\BaMAxeElarg*\BaMaxelargeur}} - \draw[\BaMAxeEpaisseur,->] (\BaMaxexmin,0) -- (\BaMaxexmax,0) ; + \draw[\BaMAxeEpaisseur,->,>=latex] (\BaMaxexmin,0) -- (\BaMaxexmax,0) ; \ifboolKV[boiteamoustachesaxe]{AffValeurs} {\foreach \x in \BaMAxeValeurs \draw[\BaMAxeEpaisseur] (\x,3pt)--(\x,-3pt) node[below=3pt] {\num{\x}} ;} {} @@ -3033,7 +3077,7 @@ {} \clip (-4,-0.075) rectangle (4,0.425) ; \draw[black,semithick,fill=\GRPHPROBcoulsurf] ({\BorneInf},0) -- plot [domain={\BorneInf}:{\BorneSup},samples=100] (\x,{\densnorm{\x}}) -- ({\BorneSup},0) -- cycle; - \draw[thick,->,>=stealth] (-4,0)--(4,0) ; + \draw[thick,->,>=latex] (-4,0)--(4,0) ; \draw[thick,densely dotted] (0,0)--(0,0.39894) ; \draw[thick,domain=-4:4,samples=100,\GRPHPROBcoulcbe] plot (\x,{\densnorm{\x}}) ; \end{tikzpicture} @@ -3061,8 +3105,8 @@ {\draw (1,-0.075) node[font=\tiny,scale={\UNITEX}] {\MOYENNE} ; \draw[thick,densely dotted] (1,0)--(1,{0.7*\densexpo{1}}) ;} {} - \draw[thick,->,>=stealth] (-0.2,0)--(3.8,0) ; - \draw[thick,->,>=stealth] (0,-0.15)--(0,0.85) ; + \draw[thick,->,>=latex] (-0.2,0)--(3.8,0) ; + \draw[thick,->,>=latex] (0,-0.15)--(0,0.85) ; \draw[thick,domain=0:3.8,samples=100,\GRPHPROBcoulcbe] plot (\x,{0.7*\densexpo{\x}}) ; \end{tikzpicture} } @@ -3480,4 +3524,54 @@ }% } +%================MESUREPPALE============= OK! +\setKVdefault[MesurePpale]{% + Crochets=false, + d=false +} + +\newcommand{\MesurePrincipale}[2][]{%fraction sous la forme a/b ou entier :-) + \useKVdefault[MesurePpale]% + \setKV[MesurePpale]{#1}% + \StrDel{#2}{pi}[\MPargument]% + %on conserve les données initiales + \IfSubStr{\MPargument}{/}%on coupe numérateur/dénominateur + { \StrCut{\MPargument}{/}\MPnumerateurinit\MPdenominateurinit }% + { \xdef\MPnumerateurinit{\MPargument}\xdef\MPdenominateurinit{1} }% + %on affiche le début, avant simplification + \ifboolKV[MesurePpale]{d}% + {\displaystyle}% + {}% + \xintifboolexpr{\MPdenominateurinit == 1}% + { \num{\MPnumerateurinit}\pi = }% + { \frac{\num{\MPnumerateurinit}\pi}{\num{\MPdenominateurinit}}= }% + %on simplifie puis on réduit + \xdef\MPsimpl{\xintPRaw{\xintIrr{\MPargument}}}% + %test si l'argument est une fraction ou un entier + \IfSubStr{\MPsimpl}{/}% + { \StrCut{\MPsimpl}{/}\MPnumerateur\MPdenominateur }% + { \xdef\MPnumerateur{\MPsimpl}\xdef\MPdenominateur{1} }% + %calculs + \xdef\MPtour{\inteval{2*\MPdenominateur}}% + \xdef\MPreste{\xintiiRem{\MPnumerateur}{\MPtour}}%reste + \xintifboolexpr{\MPreste>\MPdenominateur}% + {\xdef\MPreste{\inteval{\MPreste-\MPtour}}}{}% + \xintifboolexpr{\MPreste<-\MPdenominateur}% + {\xdef\MPreste{\inteval{\MPreste+\MPtour}}}{}% + %sortie suivant fraction ou non... + \xintifboolexpr{\MPdenominateur == 1}% + {%entier + \xintifboolexpr{\MPreste == 1}{\pi \: \ifboolKV[MesurePpale]{Crochets}{[2\pi]}{(2\pi)} }{}% + \xintifboolexpr{\MPreste == 0}{0 \: \ifboolKV[MesurePpale]{Crochets}{[2\pi]}{(2\pi)} }{}% + \xintifboolexpr{\MPreste != 0 && \MPreste != 1}{\MPreste\pi \: \ifboolKV[MesurePpale]{Crochets}{[2\pi]}{(2\pi)} }{}% + }% + {%fraction + \frac{% + \xintifboolexpr{\xinteval{\MPreste == 1}}{}{}% + \xintifboolexpr{\xinteval{\MPreste == -1}}{-}{}% + \xintifboolexpr{\xinteval{abs(\MPreste) != 1}}{\num{\MPreste}}{}% + \pi}{\num{\MPdenominateur}} \: \ifboolKV[MesurePpale]{Crochets}{[2\pi]}{(2\pi)}% + }% +} + \endinput
\ No newline at end of file |