From 4fee29360f7566a474b6143951b0744fa151edc9 Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Wed, 30 Aug 2023 03:01:17 +0000 Subject: CTAN sync 202308300301 --- macros/latex/contrib/schooldocs/README.md | 10 +- .../contrib/schooldocs/schooldocs-examples.pdf | Bin 400369 -> 397588 bytes macros/latex/contrib/schooldocs/schooldocs.dtx | 456 +++++++++++---------- macros/latex/contrib/schooldocs/schooldocs.ins | 4 +- macros/latex/contrib/schooldocs/schooldocs.pdf | Bin 154926 -> 156220 bytes 5 files changed, 241 insertions(+), 229 deletions(-) (limited to 'macros/latex/contrib/schooldocs') diff --git a/macros/latex/contrib/schooldocs/README.md b/macros/latex/contrib/schooldocs/README.md index ecb91d93da..38c16f1a87 100644 --- a/macros/latex/contrib/schooldocs/README.md +++ b/macros/latex/contrib/schooldocs/README.md @@ -3,12 +3,10 @@ ## Presentation -The purpose of this package is to provide several layout styles for school documents. -It is usefull for exercices sheets, exams, course materials. -The package sets the page geometry (dimensions of text and margins) -and the title typesetting; -the various styles define the header, footer and title formatting, -Many features are freely configurable. +The aim of this package is to offer diverse layout styles for school-related documents. +It serves well in creating exercices sheets, exams, course materials. +The package defines page geometry (text and margins dimensions) and the title formatting. +Various styles are available defining settings for headers, footers or alternative title formatting, providing many customizable features. ## Installation diff --git a/macros/latex/contrib/schooldocs/schooldocs-examples.pdf b/macros/latex/contrib/schooldocs/schooldocs-examples.pdf index e214571230..ec6210a259 100644 Binary files a/macros/latex/contrib/schooldocs/schooldocs-examples.pdf and b/macros/latex/contrib/schooldocs/schooldocs-examples.pdf differ diff --git a/macros/latex/contrib/schooldocs/schooldocs.dtx b/macros/latex/contrib/schooldocs/schooldocs.dtx index 9aed8e6cf8..04c468b3dd 100644 --- a/macros/latex/contrib/schooldocs/schooldocs.dtx +++ b/macros/latex/contrib/schooldocs/schooldocs.dtx @@ -1,6 +1,6 @@ % \iffalse meta-comment % -% Copyright (C) 2020-2021 by Antoine Missier +% Copyright (C) 2020-2023 by Antoine Missier % ---------------------------------------------------------------------- % % This file may be distributed and/or modified under the @@ -22,7 +22,7 @@ %\NeedsTeXFormat{LaTeX2e}[2005/12/01] %\ProvidesPackage{schooldocs} %<*package> - [2023/01/25 v1.2 .dtx schooldocs file] + [2023/08/28 v1.3 .dtx schooldocs file] % % %<*driver> @@ -32,12 +32,11 @@ \usepackage[english]{babel} \usepackage{charter} \usepackage{lipsum} -\usepackage{hyperref} \usepackage{boxedminipage2e} \usepackage{sectsty} \usepackage{spacingtricks} -\usepackage{centeredline} \usepackage{schooldocs} +\usepackage{hyperref} %\usepackage{geometry} \geometry{textwidth=355pt,vmarginratio=1:1,hmarginratio=3:2} % modified by schoodocs loading, very close from the default geometry used by ltxdoc @@ -112,6 +111,8 @@ % \changes{v1.2}{2023/01/24}{ % Small changes in documentation (charter font is now used) % and examples files (with several fonts)} +% \changes{v1.3}{2023/08/28}{ +% - English documentation corrections} % % \GetFileInfo{schooldocs.dtx} % @@ -119,97 +120,101 @@ % % \section{Introduction} % -% The purpose of this package is to provide several layout styles for school documents. -% It can be used for exercises sheets, exams, course materials. -% The package sets the page geometry (dimensions of text and margins) -% and the title typesetting; -% various \emph{styles} define header, footer and title formatting, -% Many features are freely configurable. -% Six different styles are proposed which are named: +% The aim of this package is to offer diverse layout styles +% for school-related documents. +% It serves well in creating exercise sheets, exams, and course materials. +% The package defines page geometry (text and margins dimensions) +% and title formatting. +% Various \emph{styles} are available defining settings for headers, footers +% or alternative title formatting, providing many customizable features. +% Six different styles are proposed that are named: % \begin{center} \bfseries % \hfill classic \hfill elegant \hfill modern \hfill soft % \hfill exam \hfill collection \hfill \mbox{} % \end{center} -% If the document is an exam subject to be completed and returned, -% we have a particular style, \textbf{identity}, in which -% left part of the header is replaced by -% ``\identityname'', whereas center and right parts are empty. +% Furthermore, a specific style named \textbf{identity} is provided +% for documents like exam sheets that need to be completed and returned. +% This style replaces the left header with ``\identityname'', +% while keeping the center and right parts empty. % % \medskip -% The styles are presented in paragraph \ref{par:styles} -% and the file \href{run:schooldocs-examples.pdf}{\textsf{schooldocs-examples.pdf}} -% shows the result of each. +% An overview of these styles is presented in section \ref{par:styles} +% and you can observe the visual outcomes of each style in the file +% \href{run:schooldocs-examples.pdf}{\textsf{schooldocs-examples.pdf}}. % % \section{Usage} % % \subsection{Choosing a style} % After loading the package with |\usepackage{schooldocs}|, % the style is defined by placing |\pagestyle|\marg{style} in the preamble. -% This command comes from the package \textsf{fancyhdr} by Piet van Oostrum. -% It can be placed before of after entering information described in the next subsection. +% This command comes from the \textsf{fancyhdr} package by Piet van Oostrum. +% It can be placed before of after entering the information described in the next subsection. % % \medskip -% In the text body, you can change the style of a particular page by placing -% |\thispagestyle|\marg{style} at the page you want. -% For example, you can place the command |\thispagestyle{identity}| -% in an appendix page to render. +% You can change the style of a particular page by placing +% |\thispagestyle|\marg{style} on the page you desire. +% For example, on an appendix page that needs to be rendered +% you can use the command |\thispagestyle{identity}|. +% % \subsection{Information fields} % % \DescribeMacro{\title} -% Usually a \LaTeX\ document title is made up of information -% provided by the macros -% |\title|, |\date| and |\author|. -% The |\title| macro has been redefined with an enriched syntax: +% Typically a \LaTeX\ document title is assembled using information +% from the macros |\title|, |\date|, and |\author|. +% The |\title| macro has been extended with an enriched syntax: % |\title|\oarg{head}\marg{title}. % The optional parameter \meta{head} corresponds to the text displayed in the header % instead of \meta{title}. % When not provided, the mandatory argument \meta{title} will be used in headers. % -% The macros |\date| and |\author| have not been redefined but information provided +% The macros |\date| and |\author| have not been altered, but the provided information % is also used in titles, headers or footers -% (depending on the style used) +% (depending on the chosen style) % \footnote{The macro \texttt{\bslash and}, -% sometimes used in \texttt{\bslash author} -% to typeset a title with several authors, doesn't work here, -% except in the \textbf{collection} style. It produces a compilation error. -% The macro \texttt{\bslash thanks} also doesn't work but without producing error.}. +% which can be employed in the \texttt{\bslash author} command +% to typeset a title with several authors, does not function here, +% except in the \textbf{collection} style. Attempting to use it will result +% in a compilation error. The \texttt{\bslash thanks} macro also +% doesn't work, although it does not generate an error.}. % % \pagebreak % \medskip % \DescribeMacro{\subject} \DescribeMacro{\school} \DescribeMacro{\institute} -% In addition to the previous ones, two other information macros are provided, -% used in the title, headers or footers, depending on the style: +% Two additional information macros +% are provided for use in titles, headers or footers, depending on the style: % |\subject| and |\school| (or its alias |\institute|). -% The macro |\subject| has an optional argument, like in |\title|: -% |\subject|\oarg{head}\marg{title} which allows to place an alternative text -% in header, different from the one displayed in the title. +% The |\subject| macro includes an optional argument, similar to |\title|: +% |\subject|\oarg{head}\marg{title}. This enables the placement of an alternative text +% in the header, distinct from the text displayed in the title. % % \medskip -% Information macros have to be called in the preamble -% \footnote{Nevertheless, the macros \texttt{\bslash date} and \texttt{\bslash author} -% can be used in the document body.}, -% they are optional. If omitted, the corresponding field will be empty, -% except for the date which will display today's date. -% So, if you do not want any date, just write |\date{}|. -% When title elements like subject or date are missing, the title height +% Information macros must be invoked in the preamble +% \footnote{However, the macros \texttt{\bslash date} and \texttt{\bslash author} +% can be used within the document body.}, +% they are optional. In cases of omission, the corresponding field will remain empty -- +% except for the date field, which will display today's date. +% Therefore, if you wish to exclude the date, you can simply enter |\date{}|. +% If certain title elements, such as subject or date, are absent, the title height % will be reduced accordingly. % -% Except for |\date|, all these information macros accept multi-line arguments, -% for example |\school{Royal College of Pataphysics\\London}|. -% To typeset the main title on two (or more) lines, use |\\[1ex]| -% for a good vertical spacing. -% -% When using the \textsf{hyperref} package (by Sebastian Rahtz and Heiko Oberdiek) -% to produce a pdf output, information provided by |\title|, |\subject| and |\author| -% (and |\school| -% \footnote{The \emph{author} field of the pdf properties will be filled -% like this: \textsf{author (school)}, -% but \texttt{\bs author} should be called before \texttt{\bs school} in the preamble. +% All of these information macros, except for |\date|, accept multi-line arguments, \eg +% |\school{Royal College of Pataphysics\\London}|. +% Within the |\title| macro, if you wish to typeset two (or more) lines, use |\\[1ex]| +% for a proper vertical spacing. +% +% When employing the \textsf{hyperref} package +% (developed by Sebastian Rahtz and Heiko Oberdiek), +% the information provided via |\title|, |\subject|, and |\author| +% (as well as |\school| +% \footnote{The \emph{author} field of the PDF properties will be filled +% as follows: \textsf{author (school)}. +% However \texttt{\bs author} should be called before \texttt{\bs school} in the preamble. % }) -% will be written in the pdf properties also. +% will also be included in the PDF properties. % % \medskip -% The file \textsf{schooldocs-examples.pdf} uses the examples of the following table. +% The file \textsf{schooldocs-examples.pdf} utilizes the information fields +% outlined in the following table. % \begin{center} % \begin{tabular}{ll} % \hline @@ -225,84 +230,85 @@ % \end{center} % % \DescribeMacro{\subtitle} -% In the \textbf{exam} style, the title uses an additional field -% provided by the macro |\subtitle|\marg{text}. The parameter \meta{text} -% will be placed under the other title elements and before the separation rule, -% if there is one. For instance |\subtitle{Duration of the test: 2\,h}|. -% For a multi-line argument, the line break instruction must be -% |\par| and not |\\|. +% Within the \textbf{exam} style, the title includes an additional field +% provided by the macro |\subtitle|\marg{text}. The \meta{text} argument +% will be positioned beneath the other title elements and above the separation rule, +% if present. For instance, |\subtitle{Duration of the test: 2\,h}|. +% For a multi-line argument, use |\par| for line breaks instead of |\\|. % % \subsection{Making the title} % % \DescribeMacro{\maketitle} -% As in \LaTeX\ standard classes, the title is produced -% by the macro |\maketitle|, which should be placed after |\begin{document}|. -% This command has been redefined by the package. -% Indeed, the standard title produced by the \LaTeX\ class \texttt{article}, -% seems inappropriate for school documents like exercise sheets for example. -% Vertical space before the title is reduced and -% an horizontal rule is typeset to separate the title from the following text. -% By default, the title is centered but one can change this, -% as presented in section \ref{par:title-set}, to get -% a left or right-aligned title (an also boxed). -% Various titles are presented in the file +% Just like in the standard \LaTeX\ classes, the title is generated +% using the |\maketitle| macro, which is placed after |\begin{document}|. +% This macro has been redefined by the package. +% In fact, the default title produced by the \LaTeX\ \texttt{article} class +% appears unsuitable for school documents such as exercise sheets. +% Vertical spacing before the title has been reduced and, +% a horizontal rule is inserted to separate the title from the subsequent text. +% By default, the title is centered, but this can be altered, +% as demonstrated in section \ref{par:title-set}, to achieve +% a left or right alignment (or even boxing). +% Various title examples can be found in the file % \href{run:schooldocs-examples.pdf}{\textsf{schooldocs-examples.pdf}}. % % The macro has on optional parameter |\maketitle|\oarg{rulelength} -% to set the length of the separation rule, by default 2.5\,cm. -% The rule can be totally removed by setting the -% optional argument to 0\,cm; you can also typeset a rule of -% whole line width with |\maketitle[\linewidth]| or |\maketitle[\textwidth]|. +% to define the length of the separation rule, which is 2.5\,cm by default. +% The rule can be completely removed by setting the +% optional argument to 0\,cm. Alternatively, you can typeset a rule spanning +% the entire line using |\maketitle[\linewidth]|. ^^A or |\maketitle[\textwidth]|. % -% Each style has its own title formatting. Nevertheless the package provides -% a ``standard'' title when no style is loaded or with +% Each style has its own title formatting. Nevertheless the package offers +% a ``standard'' title formatting when no specific style is loaded or when using % the \LaTeX\ styles \textbf{empty} or \textbf{plain}. -% The \textbf{elegant} style keeps also this ``standard'' title style. +% The \textbf{elegant} style also retains this ``standard'' title formatting. % % \medskip % \DescribeMacro{\seprule} -% As in the title, a rule can also be used in the text body to make separations. -% This is done by the macro |\seprule|\oarg{length} which -% produces an horizontal centered rule of (optional) \meta{length}, by default 2.5\,cm. +% Just like in the title, a rule can also be used within +% the text body for creating separations. +% This is achieved using the |\seprule|\oarg{length} macro, +% producing a horizontal and centered rule of optional \meta{length}, +% with a default of 2.5\,cm. % % \medskip % \DescribeMacro{\correct} -% For typesetting a correct version of an exercise sheet, we provide the macro |\correct|, -% which adds ``-- Correct Version'' to the title. +% To typeset a correct version of an exercise sheet, we provide the |\correct| macro, +% which adds `` -- Correct Version'' to the title. % It should be placed in the preamble. -% Combined with packages that deal with multiple versions of a document, -% this macro avoids to define different titles for a an exercise sheet an its correct version. +% When used with packages that manage multiple versions of a document, +% this macro eliminates the need to define distinct titles for an exercise sheet +% an its correct version. % However in the \textbf{exam} style, the text ``Correct version'' -% will not be added in the title (except in headers), but will be substituted for -% the subtitle. +% replaces the subtitle instead of being added in the main title (except in headers). % % \medskip % \DescribeMacro{\makesmalltitle} -% As in the package \textsf{phfnote} by Philippe Faist, it seems wisely -% to propose a compact title, where information -% provided by |\title|, |\subject| and |\date| are presented -% on a single line, depending on the selected style (see \textsf{schooldocs-examples.pdf}). -% The rule is always displayed and expands on the whole line width. +% Inspired by the package \textsf{phfnote} by Philippe Faist, we also offer +% a compact title format. This format combines the details from +% |\title|, |\subject| and |\date| into a single line, +% depending on the chosen style (see \textsf{schooldocs-examples.pdf}). +% The rule is always displayed and spans the entire line width. % % \subsection{Style layouts} \label{par:styles} % -% According to good typographic practice, the header on the title page should be empty +% In accordance with typographic good practices, +% the header on the title page is usually left empty % (see The \LaTeX\ Companion). -% This ``rule'' is seldom observed in school documents, -% and, on the first page, we find often information (author, school, etc.) -% on top left and the date on top right, as for a letter. -% Except for the \textbf{classic} style, that we present first, -% we wanted to comply with good practice, -% but we keep some information in the footer yet. -% -% We present below miniature views to show the layout of the different styles. +% However, this ``rule'' is often disregarded in school documents. +% On the first page, it is common to find information such as author, school, etc., +% at the top left and the date at the top right, resembling the layout of a letter. +% While we adhere to good practices for the headers (except in the \textbf{classic} style), +% we still include certain information in the footer. +% +% Below, we present miniature previews illustrating the six styles layout. % The file \href{run:schooldocs-examples.pdf}{\textsf{schooldocs-examples.pdf}} -% gives a real view of them. -% For several styles, a rule is typeset under the header. -% It can be displayed or discarded by setting its width, and likewise for a rule -% over the footer. -% The format of each element and also some space settings -% are freely configurable, see section \ref{par:head-settings}. +% provides an actual representation. +% In several styles, a rule is placed below the header. +% It can be displayed or removed by setting its width, and the same applies to a rule +% above the footer. +% The formatting of each element, as well as specific spacing settings, +% can be freely customized as detailed in \ref{par:head-settings}. % % \medskip % \begin{stylex} @@ -423,63 +429,66 @@ % \end{stylex} % \bigskip % -% The \textbf{collection} style is useful for longer documents. -% In it the name of the current section appears in the right header -% and changes as things progress, as in the \LaTeX\ \textbf{book} class. +% The \textbf{collection} style is well-suited for longer documents. +% In this style the name of the current section is displayed in the right header +% and updates as the content progresses, similar to the behavior +% in the \LaTeX\ \textbf{book} class. % % \section{Settings} % % \subsection{Page layout} % -% The page layout is set in the same way, for all styles. -% It is defined by the macro |\geometry| of the package +% The page layout is set in the same way for all styles. +% It is defined by the |\geometry| macro of the package % \textsf{geometry} (by Hideo Umeki and David Carlisle). -% According to good typographic practice (see the \LaTeX\ Companion, -% the \textsf{typearea} package or \textsf{KOMA-Script} bundle documentation) -% the ratio between the text body (the type area as named by typographers) +% Following good typographic practice (see the \LaTeX\ Companion, +% the \textsf{typearea} package or the \textsf{KOMA-Script} bundle documentation), +% the ratio between the text body (referred to as the ``type area'' by typographers) % and the page size must be the same horizontally and vertically. % This ratio gauges the ``shade of gray'' of a page. % The default scale in the \textsf{geometry} package is 0.7. -% For school documents, it seems that this setting leaves too much white -% space in margins, thus this ratio has been set to 0.75. -% It can be redefined with the |\newgeometry| command +% However, for school documents, this setting seems to result in excessive white +% space in the margins. Thus we have adjusted this ratio to 0.75. +% You can modify it using the |\newgeometry| command % \footnote{You can also call \textsf{geometry} before \textsf{schooldocs}. % Setting the scale factor several times doesn't work.}. -% Furthermore, according to ``canons of page construction'', in a one-sided document, +% +% Moreover, in accordance with ``canons of page construction'', in a one-sided document, % the ratio between the left and right margins should be 1:1, % while the ratio between top and bottom margins should be 1:2. -% It seems that this recommended ratio of 1:2 is seldom observed -% and it produces a very wide bottom margin. -% Besides, when loading the \textsf{geometry} package, the default vertical -% ratio is 2:3 and not 1:2. -% To get more balanced margins, we have prefer to set it at 3:4: +% It appears that this recommended 1:2 ratio is rarely observed, +% as it results in an overly wide bottom margin. +% Additionally, when loading the \textsf{geometry} package, the default vertical +% ratio is set at 2:3 and not 1:2. +% To achieve more balanced margins, we have preferred to set it at 3:4, using % |\geometry{scale=0.75,vmarginratio=3:4,heightrounded}| -% \footnote{The option \texttt{heightrounded} rounds text height to $n$-times -% ($n$ an integer) the height of a line, to avoid ``underfull vbox'' in some cases.}. +% \footnote{The \texttt{heightrounded} option rounds text height to a multiple of $n$ times +% the height of a line (where $n$ is an integer), preventing occurrences +% of ``underfull vbox'' at times.}. % % \subsection{Title settings} \label{par:title-set} % -% Several parameters allow to customize the title composition. -% They are presented in the following table with their default settings. -% Colors can be changed with |\definecolor|, macros with |\renewcommand| -% and lengths with |\setlength|. -% Most of command names are explicit and don't need to give any information about their use. -% |\titleflush| manages the alignment: -% centered by default, it can be left-aligned with -% |\renewcommand{\titleflush}{flushleft}| or right-aligned with -% |\renewcommand{\titleflush}{flushright}| +% Several parameters allow for customizing the title composition. +% They are presented in the table below along with their default settings. +% Colors can be altered using |\definecolor|, macros using |\renewcommand| +% and lengths using |\setlength|. +% Most command names are self-explanatory and don't require additional information +% about their usage. +% The |\titleflush| command handles alignment: +% it is centered by default, but can be left-aligned using +% |\renewcommand{\titleflush}{flushleft}| (\texttt{flushright} for right alignment) % \footnote{This macro has no effect % with the \textbf{exam} and \textbf{collection} styles, -% the title is always centered.}. +% where the title is always centered.}. % -% The length |\titlesep| sets the vertical spacing between the fields \emph{title} -% and \emph{subject}, except for the \textbf{classic} and \textbf{soft} styles, -% witch contain only the field \emph{title}, or if the field \emph{subject} -% is not given. -% Vertical space between other title fields is defined in relation to +% The length |\titlesep| determines the vertical spacing between the \emph{title} +% and \emph{subject} fields, except for the \textbf{classic} and \textbf{soft} styles, +% witch contain only the \emph{title} field, or when the \emph{subject} field +% is not provided. +% Vertical space between other title fields is defined relative to % |\titlesep| (|0.5\titlesep| for most). % -% Unless otherwise stated, the column ``special settings'' of the following table +% Unless specified otherwise, the ``special settings'' column in the following table % applies to the \textbf{exam} and \textbf{collection} styles. % % \begin{center} \small @@ -506,44 +515,47 @@ % \DescribeMacro{\subtitlestyle}\DescribeMacro{\titlecorrectstyle} % The \textbf{exam} style has two additional setting macros: % |\subtitlestyle|, set by default to |\large\slshape|, -% and |\titlecorrectstyle|, for the composition of \textsf{Correct Version} -% produced by |\correct|, set by default to |\color{red}\large\scshape|. +% and |\titlecorrectstyle|, for the ``\textsf{Correct Version}'' composition +% via |\correct|, with the default being |\color{red}\large\scshape|. % -% In the \textbf{collection} style, the fields -% \emph{school} and \emph{author} are included into the title. Their features are then -% controlled by |\authorstyle| -% \footnote{For other styles, the macro \texttt{\bs authorstyle} -% belongs to headers or footers parameters.} set to |\Large|. +% \DescribeMacro{\authorstyle} +% In the \textbf{collection} style, the +% \emph{school} and \emph{author} fields are incorporated into the title. +% Their attributes are governed by |\authorstyle| +% \footnote{In other styles, the \texttt{\bs authorstyle} macro +% (set to \texttt{\bs textnormal}) +% is utilized within header or footer.} which is set to |\Large|. % -% To create a separate page for the title -% (in particular for \textbf{exam} or \textbf{collection}), you can place |\maketitle| into -% an environment |titlepage| provided by \LaTeX. +% To create a separate title page +% (especially for the \textbf{exam} or \textbf{collection} styles), +% you can enclose |\maketitle| within the |titlepage| environment provided by \LaTeX. % % \medskip % \DescribeMacro{\boxedshape} -% A particular formatting has been predefined to produce a slightly +% A specific formatting has been predefined to create a lightly % shaded box around the title: |\boxedshape|\marg{text} % (thanks to the \textsf{fancybox} package by Timothy Van Zandt). -% It can be used within the -% command |\titlestyle| if we want to get this kind of effect, \eg +% It can be used within the command |\titlestyle| +% if you want to achieve this kind of effect, for instance: % \centeredline{|\renewcommand{\titlestyle}{\LARGE\sffamily\bfseries\boxedshape}|.} % % \subsection{Headers and footers} \label{par:head-settings} % -% The typeset of headers and footers is produced thanks to dedicated macros -% \footnote{The \textsf{fancyhdr} package -% provides the commands \texttt{\bs lhead}, \texttt{\bs chead}, \texttt{\bs rhead} -% for the left, center and right parts of the header, and the same for the footer: +% The typesetting of headers and footers is achieved using specialized macros +% \footnote{The \textsf{fancyhdr} package offers +% the commands \texttt{\bs lhead}, \texttt{\bs chead}, \texttt{\bs rhead} +% for the left, center and right portions of the header, and similarly for the footer: % \texttt{\bs lfoot}, \texttt{\bs cfoot} and \texttt{\bs rfoot}.} -% of the \textsf{fancyhdr} package. -% As for the title, several macros allow to customize some settings. -% They are presented in the table below. -% Let us specify that |\pagenamestyle| defines the format of the word ``\emph{page}'' -% used in front of the page number. -% -% The |\headstyle| and |\footstyle| commands are generic for all elements -% of headers and footers. They are combined with macros giving -% specific settings for each field. +% from the \textsf{fancyhdr} package. +% Similar to the title, various macros enable customization of specific settings. +% They are outlined in the table below. +% Note that |\pagenamestyle| determines the format of the word ``\emph{page}'' +% displayed preceding the page number. +% +% The |\headstyle| and |\footstyle| commands are common for all +% headers and footers components, respectively. +% These commands are combined with macros that provide +% distinct settings for each individual field. % \begin{center} % \begin{tabular}{cc} % \hline @@ -563,33 +575,33 @@ % \end{center} % % The \textbf{exam} and \textbf{collection} styles have a specific setting for -% |\headtitlestyle|, defined by |\renewcommand{\headtitlestyle}{\MakeUppercase}|. +% |\headtitlestyle|, which is defined by |\renewcommand{\headtitlestyle}{\MakeUppercase}|. % % \medskip -% Macros that allow to display (or remove) the rule in the header -% \footnote{Indeed we have redefined the \texttt{\bs headrule} macro -% such that the rule never appears on the first page.} -% or the footer -% come from the \textsf{fancyhdr} package. For example, in any style, -% the rule in the header is removed with: +% Macros that enable the display (or removal) of the rule in the header +% \footnote{In fact, we have redefined the \texttt{\bs headrule} macro +% so that the rule never appears on the first page.} +% or the footer are provided +% by the \textsf{fancyhdr} package. For example, in any style, +% the header rule can be removed using: % |\renewcommand{\headrulewidth}{0pt}|, -% and displayed in the footer with: -% |\renewcommand\footrulewidth{0.4pt}| +% and it can be displayed in the footer with: +% |\renewcommand\footrulewidth{0.4pt}|. % % \subsection{Internationalization} -% Three keywords are used by the package: \emph{page}, \emph{Correct version}, +% Three keywords are utilized by the package: \emph{page}, \emph{Correct version}, % and \emph{Name}, % defined by the macros |\pagename|, |\correctname| and |\identityname|. -% |\pagename| is used in the header or the footer, |\correctname| by the macro |\correct| -% and |\identityname| by the \textbf{identity} style. -% These keywords get automatic translation in a few languages -% \footnote{Translation is currently integrated into the package +% |\pagename| is used in the header or footer, |\correctname| by the |\correct| +% macro and |\identityname| by the \textbf{identity} style. +% These keywords are automatically translated into a few languages +% \footnote{Translation is currently built into the package % for the following languages: % French, German, Spanish, Italian, Portuguese.} -% according to the selected language by the \textsf{babel} or \textsf{polyglossia} package. -% They can be redefined, with |\renewcommand|, -% or else you can use macros from the \textsf{translations} package by Clemens Niederberger -% (allowing dynamic language change), \eg +% based on the selected language using the \textsf{babel} or \textsf{polyglossia} package. +% They can be redefined using |\renewcommand|, +% or you can also utilize macros from Clemens Niederberger's \textsf{translations} package +% (allowing dynamic language changes), such as % |\DeclareTranslation{romanian}{pagin\u{a}}| (in the preamble). % % @@ -601,7 +613,7 @@ % % \begin{macrocode} \@ifpackageloaded{geometry}{}{\RequirePackage{geometry}} -\let\footruleskip\relax % because memoir class uses it +\let\footruleskip\relax % because the memoir class uses it \RequirePackage{fancyhdr} \RequirePackage{ifthen} \RequirePackage{lastpage} @@ -612,11 +624,11 @@ \geometry{scale=0.75,vmarginratio=3:4,heightrounded} % \end{macrocode} -% If the \textsf{geometry} package has been loaded before, -% we don't load it to avoid option clash. +% If the \textsf{geometry} package has been previously loaded, +% we do not load it again to prevent conflict with options. % -% To change the scale factor, use |\newgeometry| because -% the |\geometry| command will not do it when the scale is already defined. +% To modify the scale factor, utilize |\newgeometry| as the +% |\geometry| command will not function when the scale is already set. %\medskip % \subsection{Internationalization} % @@ -657,8 +669,8 @@ % % \subsection{Information fields} % -% After being defined, information fields are set to empty, -% to make tests with them work well. +% Once defined, information fields are initially set to empty +% to ensure that tests for empty fields work correctly. % % \begin{macrocode} \renewcommand{\title}[2][]{\long\def\@title{#2} @@ -683,10 +695,11 @@ \def\@subject{} \def\@headsubject{} % \end{macrocode} -% Because \textsf{KOMA-Script} package also uses the |\subject| macro, -% we make a |\relax| on this command. +% Due to the usage of the |\subject| macro by the \textsf{KOMA-Script} package, +% we include a |\relax| command before defining this macro. % -% |\subject{}| doesn't work with the |\@empty| test used below in |\maketitle|, thus +% The |\subject{}| command doesn't function properly with the |\@empty| test +% employed below in the |\maketitle| command. Consequently, % we define |\@subject| and |\@headsubject| as empty by default. % % \subsection{Settings} @@ -714,11 +727,11 @@ } % \end{macrocode} -% Default value for |\fboxsep| is 3\,pt and for |\shadowsize| is 4\,pt. -% These settings are local. +% The default value for |\fboxsep| is 3\,pt and for |\shadowsize| it's 4\,pt. +% These settings have a local scope. % % \medskip -% Next the headers and footers settings. +% Then, we move on to the settings for headers and footers. % \begin{macrocode} \definecolor{headingcolor}{named}{black} \newcommand{\headstyle}{\small\color{headingcolor}} @@ -736,11 +749,12 @@ } % \end{macrocode} -% The |\headrule| macro redefinition allow to remove the rule on the first page. +% The redefinition of the |\headrule| macro allows for the removal +% of the rule on the first page. % -% The header height is set to |\baselineskip| to avoid +% The header height is set to |\baselineskip| to prevent % error messages (``\texttt{headheight too small}'') when the text size is -% greater than or equal to |\small|. +% equal to or greater than |\small|. % % \subsection{Title composition} % @@ -789,18 +803,18 @@ \raisebox{0.25\baselineskip}{\rule{#1}{\seprulewidth}}\end{center}} % \end{macrocode} -% |\AtBeginDocument| is necessary in the |\correct| macro because -%|\correctname| can be redefined by \textsf{babel} at |\begin{document}|. +% The use of |\AtBeginDocument| is necessary in the |\correct| macro because +% |\correctname| could be redefined by \textsf{babel} at |\begin{document}|. % -% \medskip +% \bigskip % \subsection{Basic styles} % -% The header in the \textbf{classic} style is displayed on two lines, therefore we have to increase the height -% |\headheight|. +% In the \textbf{classic} style, the header is displayed on two lines, +% thus requiring an increase in the |\headheight|. % -% If we want to include header or footer in the total body, -% we can add the command |\geometry{includehead}| respectively -% |\geometry{includefoot}| in the preamble. +% To include the header or footer into the total body, +% add |\geometry{includehead}| or |\geometry{includefoot}| +% in the preamble. % \begin{macrocode} \fancypagestyle{classic}{% \renewcommand{\headrulewidth}{0pt} @@ -1022,14 +1036,14 @@ % \end{macrocode} % % In the \textbf{collection} style, -% we redefine |\sectionmark| with |\AtBeginDocument| to prevent |\MakeUppercase| -% from eliminating the section number -% (or you can use |\nouppercase| here). +% we redefine |\sectionmark| using |\AtBeginDocument| to prevent |\MakeUppercase| +% from removing the section number +% (alternatively, you can use |\nouppercase| here). % -% |\ifthenelse| doesn't work when |\and| is used within |\author|. +% The |\ifthenelse| command doesn't function properly when |\and| is used within |\author|. % -% Notice the |\pagestyle{empty}| in |\maketitle| which prevents -% any header on the first page. +% Note the |\pagestyle{empty}| command in |\maketitle|, which ensures that there is +% no header on the first page. % % \Finale \endinput diff --git a/macros/latex/contrib/schooldocs/schooldocs.ins b/macros/latex/contrib/schooldocs/schooldocs.ins index cc1b62e92c..ec68fae155 100644 --- a/macros/latex/contrib/schooldocs/schooldocs.ins +++ b/macros/latex/contrib/schooldocs/schooldocs.ins @@ -1,5 +1,5 @@ %% -%% Copyright (C) 2020-2021 by Antoine Missier +%% Copyright (C) 2020-2023 by Antoine Missier %% %% This file may be distributed and/or modified under the conditions of %% the LaTeX Project Public License, either version 1.3 of this license @@ -21,7 +21,7 @@ This is a generated file. -Copyright (C) 2020-2021 by Antoine Missier +Copyright (C) 2020-2023 by Antoine Missier This file may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3 of this license diff --git a/macros/latex/contrib/schooldocs/schooldocs.pdf b/macros/latex/contrib/schooldocs/schooldocs.pdf index a15ad07bf3..f46c1774f3 100644 Binary files a/macros/latex/contrib/schooldocs/schooldocs.pdf and b/macros/latex/contrib/schooldocs/schooldocs.pdf differ -- cgit v1.2.3