From 6809ce56c76ce49653a6fd4f5a8c3219df10fb72 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sun, 13 May 2018 21:35:54 +0000 Subject: toptesi (13may18) git-svn-id: svn://tug.org/texlive/trunk@47699 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/source/latex/toptesi/toptesi.dtx | 1517 +++++++++++--------- 1 file changed, 844 insertions(+), 673 deletions(-) (limited to 'Master/texmf-dist/source/latex/toptesi') diff --git a/Master/texmf-dist/source/latex/toptesi/toptesi.dtx b/Master/texmf-dist/source/latex/toptesi/toptesi.dtx index 84e2f22265c..e59edd7f8ed 100644 --- a/Master/texmf-dist/source/latex/toptesi/toptesi.dtx +++ b/Master/texmf-dist/source/latex/toptesi/toptesi.dtx @@ -1,4 +1,6 @@ % \iffalse meta-comment +% !TEX TS-program = pdflatex +% !TEX encoding = UTF-8 Unicode %<*internal> \begingroup \input docstrip.tex @@ -8,7 +10,7 @@ \preamble ______________________________________________________ The TOPtesi bundle - Copyright (C) 2015-2017 Claudio Beccari + Copyright (C) 2015-2018 Claudio Beccari All rights reserved License information appended @@ -16,7 +18,7 @@ \endpreamble \postamble -Copyright 2005-2017 Claudio Beccari +Copyright 2005-2018 Claudio Beccari Distributable under the LaTeX Project Public License, version 1.3c or higher (your choice). The latest version of @@ -97,7 +99,7 @@ School of Turin. \endgroup % % -% Copyright 1989--2017 Claudio Beccari +% Copyright 1989--2018 Claudio Beccari % % This file is part of the TOPtesi bundle % ------------------------------------------- @@ -137,7 +139,7 @@ School of Turin. %\ProvidesPackage{toptesi-magistrale}[% %\ProvidesPackage{toptesi-dottorale}[% %<*driver,class,topsty,topcmn,topfrn,topscu,topmon,topsss,topmag,topdoc> -2018/01/12 v.~6.1.12 +2018/05/06 v.~6.2.04 %Class for typesetting university theses] %Extension for toptesi.cls] %Additional commands for the TOPtesi bundle] @@ -156,8 +158,9 @@ School of Turin. \GetFileInfo{toptesi.dtx} \title{The TOPtesi bundle} \date{\fileversion\space--- \filedate} - \author{Claudio Beccari\thanks{E-mail: \texttt{claudio dot beccari at gmail dot com}}} - + \author{\makebox[\textwidth]{Claudio Beccari --- mail: \texttt{claudio dot beccari at gmail dot com}}} +\usepackage[utf8]{inputenc} +\usepackage[LGR,T1]{fontenc} \usepackage{metalogo,multicol,enumitem,xspace, xparse,curve2e,etoolbox,textcomp} \let\originalmeta\meta @@ -250,12 +253,12 @@ School of Turin. % % \fi % -% \CheckSum{7526} +% \CheckSum{7540} % % \begin{abstract} % This file describes the TOPtesi bundle; it is a set of files % designed to typeset a university final report that in Italian -% is generally called ``tesi''; it was originally developed at +% is generally called “tesi”; it was originally developed at % the Technical University of Turin (Politecnico di Torino) but % it was adapted for typesetting theses in any Italian university. % Well\dots\ since the Erasmus student mobility is very extended @@ -286,7 +289,7 @@ School of Turin. % version~5.xx functionalities are still available. % % A totally new module is the one that allows to typeset the Italian -% high school ``tesina'', a document that is examined by the +% high school “tesina”, a document that is examined by the % graduation exam committee at the end of secondary studies. % % The user should not be scared by the number of pages of this @@ -294,22 +297,22 @@ School of Turin. % those that concern his/her thesis. The rest is just the code % and its documentation; it is useful mostly for me, as the % author, and to other programmers and/or curious users. -% The ``normal'' user should not spend his/her time to read +% The “normal” user should not spend his/her time to read % unnecessary information. % \end{abstract} % % \section{History} % The TOPtesi bundle at its very beginning in the early nineties -% was just one |.sty| file to ben used with the|report| class. +% was just one |.sty| file to be used with the |report| class. % At that time there was only \LaTeX{\,209} and extension -% packages were called ``style files''; The |.sty| extension -% is still used to day for backwards compatibility, but |.sty| +% packages were called “style files”; the |.sty| extension +% is still used today for backwards compatibility, but |.sty| % files are not any more used to change the style of the document. % % With version 2.x, suitable for \LaTeXe, the bundle was % modified in order to have a class of its own, % |toptesi.cls|, which provided to collecting the necessary -% options and to pass them to the |report| class and +% options and to pass them to the |report| class; it % loaded the |toptesi.sty| just afterwords. % The latter file was not monolithic any more; it was split % in three parts: |toptesi.sty| contained most settings and @@ -321,7 +324,9 @@ School of Turin. % useful commands; actually this module could be used without % reference to the TOPtesi bundle, being suitable as an % extension to any class. -% The general scheme may be represented by the flow diagram in figure~\ref{fig:simple-flow-diagram}. +% +% The general scheme may be represented by the flow diagram +% in figure~\ref{fig:simple-flow-diagram}. %\begin{figure}\centering %\unitlength=0.00925\textwidth %\begin{picture}(106,20) @@ -345,18 +350,18 @@ School of Turin. % possibility of typesetting the thesis title page with a package % totally independent from the TOPtesi bundle. In particular the % |frontespizio| package by Enrico Gregorio was considered -% a fancy choice for most Italian user, but the approach +% a fancy choice for most Italian users, but the new approach % was open to any other package. The choice was made by % setting suitable switches (boolean variables). The solution % opened the bundle to other external contributions, although % the mechanism was sort of tricky. The bundle was made % compatible with other packages, for example |caption| -% and/or |geometry|, while before such packages produced -% options clashes and or other errors, so that their use +% and/or |geometry|, while before this change such packages produced +% options clashes and/or other errors, so that their use % was explicitly forbidden. Meanwhile the |topfront| module % was configured to be loaded just after the preamble end, -% so as to be able to check if the user loaded packages -% required special special attention in order to avoid conflicts; +% so as to be able to check if the user loaded packages that +% required special attention in order to avoid conflicts; % see figure~\ref{fig:toptesi+frontspizio}. % %\begin{figure}\centering\unitlength=0.009\textwidth @@ -384,7 +389,7 @@ School of Turin. %\label{fig:toptesi+frontspizio} %\end{figure} % -% Version 5.x introduced a new feature; the specific settings +% Version 5.x introduced a new feature: the specific settings % for the doctoral theses written at Politecnico di Torino % (Technical Institute od Turin); after all the bundle was % born in that university. The switching mechanism to select @@ -403,7 +408,7 @@ School of Turin. % The new situation flow diagram is represented in % figure~\ref{fig:key-value-option}; the diagram is % complicated but, once selected a specific option -% for the thesis type, the diagram reduce to a linear one. +% for the thesis type, the diagram reduces to a linear one. % %\begin{figure}[p]\centering %\unitlength=0.008\textwidth @@ -448,7 +453,7 @@ School of Turin. %\end{figure} % % Special care was paid to maintain backwards compatibility; -% the various (|.sty| module files with descriptive names) +% the various |.sty| module-files (with descriptive names) % should be usable also with other classes, if desired. % It is possible to specify a |custom| value for a thesis type; % in this case the user is required to explicitly load his/her @@ -466,26 +471,26 @@ School of Turin. % in |toptesi-it.pdf|, is also part of this bundle; it is % partly written in English for the benefit of the many foreign % students that study in the doctoral school of Politecnico di -% Torino); it contains many examples enriched with graphic -% ``demonstrations''. These two documentation files complement +% Torino; it contains many examples enriched with graphic +% “demonstrations”. These two documentation files complement % one another. % % \section{Introduction} -% The TOPtesi bundle contains a certain number of files. +% The new TOPtesi bundle contains a certain number of files. % \begin{enumerate}[noitemsep] % \item % A class file \texttt{toptesi.cls} to be used as the main % document class; the main document may be any of a certain % number of reports that in Italy are called with various names: -% ``monografia'', ``monografia di laurea'', ``tesi di laurea'', -% ``tesi di laurea triennale'', ``tesi di laurea specialistica'', -% ``tesi di laurea magistrale'', ``tesi di dottorato'', -% ``dissertazione di dottorato'', and so on. +% “monografia”, “monografia di laurea”, “tesi di laurea”, +% “tesi di laurea triennale”, “tesi di laurea specialistica”, +% “tesi di laurea magistrale”, “tesi di dottorato”, +% “dissertazione di dottorato”, and so on. % All these documents have in common the fact that they all % conclude a period of university education. Moreover since they % may conclude a double degree university program, they may receive -% foreign names such as, for example, ``Projet de fin d'\'etudes'', -% ``Master thesis'', and the like. +% foreign names such as, for example, “Projet de fin d'\'etudes”, +% “Master thesis”, and the like. % \item % An extension package \texttt{toptesi.sty} that contains most % of the code for the real typesetting; it might be used as an @@ -502,52 +507,65 @@ School of Turin. % |tipotesi=|\meta{thesis type} option to the class; if the % |toptesi=frontespizio| option is specified, the external package % |frontespizio| gets loaded; if the |toptesi=custom| option is -% specified the user should everything by him/herself. +% specified the user should do everything by him/herself. % The |tipotesi=custom| is very tolerant; in the sense that the user % is allowed to avoid loading any custom package, and simply create % the title page by means of the standard |titlepage| environment. +% The available thesis kinds are the following; for each value of +% the |tipotesi|key e differnet titlepage is typeset as the following +% list specifies. % \begin{itemize}[noitemsep] % \item \opz{tipotesi=triennale} (or \opz{monografia} for % backwards compatibility) for the bachelor degree final work; % \item \opz{tipotesi=magistrale} for the master thesis; -% \item \opz{tipotesi=dottorale} for the Ph.D.\ thesis; +% \item \opz{tipotesi=dottorale} for a generic Ph.D.\ thesis; % \item \opz{tipotesi=scudo} for the special version of the Ph.D.\ % thesis at Politecnico di Torino; -% \item \opz{tipotesi=secondaria} for the high school ``tesina''; +% \item \opz{tipotesi=secondaria} for the high school “tesina”; % \item \opz{tipotesi=custom} for using another title page package, % possibly a customised one the user may create in % accordance with a certain template that implements his/her % university requirements. % \item \opz{tipotesi=frontespizio} for typesetting a -% frontispiece according to the style of the |frontespizio| -% package. +% title page according to the style of the |frontespizio| package. % \end{itemize} -% Without using a custom module, we suggest to use the package -% |frontespizio| and we address the user to its documentation. +% The user who needs a different title page style is neither +% obliged to create a custom module, nor to create his/her title +% page “by hand” within the |titlepage| environment: before this +% decision we suggest to use the package |frontespizio| and we +% address the user to its documentation. % % It is important to recall that if the |topfront| package has % to be loaded, it is only at the execution of the |\begin{document}| % command. Therefore no title page commands of any kind (those -% defined by |topfront| or the other modules) can be used in the +% defined by |topfront| or by the other modules) can be used in the % preamble. % \item % A third extension package \texttt{topcoman.sty} that defines % a certain number of user commands suitable for typesetting % technical matters. % \item -% Several extension files are available: -% \texttt{toptesi-\meta{module}.sty} where \meta{module} is one -% of |monografia|, |magistrale|, |dottorale|, |scudo|, |sss|; -% these are specifically designed to typeset particular +% Several extension files are available by means of the +% |toptesi=|\meta{module} option. They share the \meta{module} +% name in the form \texttt{toptesi-\meta{module}.sty}. +% The \meta{module} may assume the following values: +% \begin{itemize} +% \item |monografia| or |triennale|, +% \item |magistrale|, +% \item |dottorale|, +% \item |scudo|, +% \item |sss|. +% \end{itemize} +% These modules are specifically designed to typeset particular % thesis kinds; |scudo| refers to the particular doctoral school % of Politecnico di Torino, whose official name is \emph{Scuola di -% Dottorato}, whence the acronym ``ScuDo''. Such ScuDo theses must -% be typeset in English only, and must have a special title page, -% very different from the other title pages that can be typeset with -% the various options of the TOPtesi bundle and by the +% Dottorato}, whence the acronym “ScuDo”. Such ScuDo theses must +% be typeset only in English, and must have a special title page, +% very different from the other ones that can be typeset with +% the various options of the TOPtesi bundle, and by the % commands contained in the various modules. In all cases where -% specific modules exists, a specific module option is available for -% the class such that \texttt{topfront.sty} does not get loaded, and +% specific modules exists, a specific module switch is set such +% that \texttt{topfront.sty} does not get loaded, and % another set of commands is made available to set up % the necessary information. % \item @@ -555,12 +573,12 @@ School of Turin. % a set of universities; these logos are not distributed anymore % because of legal constraints. Every user who is working on % his/her degree course final report may retrieve the logo of -% his/her university, but s/he should pay attention to use it -% according to the rules and limitations of the university. +% his/her university, but s/he should pay attention to use it in +% accordance with the rules and limitations of the university. % \item % A documentation file \texttt{toptesi-it.pdf} written mostly % in Italian, explains in detail every feature; essential information -% is given in this English documentation. The source file of the +% is given in this Italian documentation. The source file of the % documentation \texttt{toptesi-it.tex} may be used as a sample % or template for typesetting one's thesis with any of \pdfLaTeX, % \XeLaTeX, or \LuaLaTeX. @@ -599,7 +617,7 @@ School of Turin. % \LuaLaTeX\ can produce \sigla{ISO}-compliant archivable-documents more % easily than the other typesetting engines; but the user does not % have to learn too many more concepts in order to typeset a -%``normal'' thesis. +%“normal” thesis. % % This version of TOPtesi has been tested also with \XeLaTeX\ and % \LuaLaTeX. Some conflicts have been spotted and solved; may @@ -620,17 +638,17 @@ School of Turin. % standard class \texttt{report.cls}; it redefines the page % typesetting grid, the headers and the footers, and the title % page layout and commands. \texttt{toptesi.cls} does not set -% such crazy settings as ``double spaced'' text; it is intended +% such crazy settings as “double spaced” text; it is intended % to typeset the thesis with the quality of a \LaTeX\ well typeset % document, not as a typewriter written one. % -% Theses very often are full of specialised material: formulas, +% Very often theses are full of specialised material: formulas, % diagrams and pictures, texts written in non Latin alphabets, % special symbols for philological mark-up, and the like; a -% common typewriter would not be suitable and the quality of -% the contents requires professional typesetting; this is why +% common typewriter would not be suitable because the specific +% contents requires professional typesetting; this is why % I strongly believe that instructions on typesetting styles that -% refer to the ``good old gone-by times'' of mechanical typewriters +% refer to the “good, old, gone-by times” of mechanical typewriters % should be banned. % % At the same time the class allows to typeset theses on any paper @@ -640,23 +658,23 @@ School of Turin. % require some more attention. The default paper size is A4, but % the user can set any paper size among those accepted by the % |report| standard class. If the \opz{tipotesi=frontespizio} -% option was specified so that package |frontespizio| gets +% option is specified so that package |frontespizio| gets % loaded, it is necessary to remind that it can easily create % pretty nice title pages, but by default it is preset to use A4 -% paper where it can typeset the title page in two styles, one so -% called ``standard'' and the other called ``elements'', that +% paper, onto which it can typeset the title page in two styles, one so +% called “standard”, and the other called “elements”; the latter one % mimics that of the famous book \emph{Elements of typographic % style} by Robert Bringhurst; this is so at least with -% |frontespizio|'s version 1.4a of 2011/09/21 or earlier. It is +% |frontespizio| version dated 2011/09/21 or earlier. It is % possible to use |frontespizio| to use a different paper size, -% but it's necessary to use certain customisation commands +% but it is necessary to use certain customisation commands % described in its documentation. % % Therefore if you want to typeset your thesis while typesetting % the title page by means of the functionalities of package % |frontespizio|, you have to follow carefully how to use that -% package's options in the proper way as to bypass the two fixed -% styles it can produce. See also the Italian documentation +% package options in the proper way as to bypass the two fixed +% styles it can produce. See also the Italian documentation % contained in the document |toptesi-it.pdf|. % % Most new commands refer themselves to the information that should @@ -670,13 +688,19 @@ School of Turin. % For theses to be typeset for the ScuDo doctoral school, % all necessary commands become available when the class % option \opz{tipotesi=scudo} is specified; such commands are -% available \emph{only} with that option. See the documentation -% in the suitable section~\ref{sec:scudo}. Similarly see the suitable -% sections for the special thesis modules available with their +% available \emph{only} with that option. + +% Notice that only the ScuDo module of TOPtesi contains a setup +% for typesetting the bibliography. For other thesis kinds +% the user is in charge of loading the suitable extension +% packages s/he likes best in order to customise his/her +% bibliography/ies. Instructions for customisation are given +% only in the specific section~\ref{sec:scudo}. Other suitable +% sections describe the other special thesis modules and their % specific options. % % \subsection{Class options} -% The class accepts all the options accepted by the |report| +% The class honors all the options accepted by the |report| % document class plus the ones defined here: % \begin{description}[noitemsep]\def\Item[#1]{\item[\opz{#1}]} % \Item[chapterbib] Allows to typeset a list of references at the @@ -686,17 +710,17 @@ School of Turin. % |thebibliography| environment. This work may be avoided if the % user relies on the various packages already available in any % complete \TeX\ system distribution and the facilities offered -% by packages such as \pack{biblatex} and sorting and formatting -% engines such as \prog{biber}. The use of this option, kept for +% by packages such as \pack{biblatex}, and on the sorting and formatting +% engines such as \prog{biber}. The use of this option, retained for % backwards compatibility, is strongly deprecated. % -% \Item[classica] Specifies a general modification of certain -% details that are supposed to be more adequate for theses in +% \Item[stile=classica] Specifies a general modification of certain +% details that are supposed to be more adequate for theses in % humanities; specifically this option lets old style numbers to % be used for some numerical pieces of information; some variations % are also introduced in the title page. This option is active also % when using some of the modules for specific theses, in particular -% with the \textsf{dottorale} thesis option. +% with the |dottorale| thesis option. % % \Item[cucitura=\meta{displacement}] In two sided printing % it is better to move the typesetting grid towards the outer @@ -713,55 +737,54 @@ School of Turin. % \Item[corpo=\meta{font size}] Extends the normal size % choice to the chosen \meta{font size}; it is % appreciated in certain fields of humanities, but I would -% discourage this use in a technical thesis, where 10 point -% perhaps is too small, but 11 point or 12 point typesetting -% may be adequate. In any case the \meta{font size} may be -% specified in any units the \TeX\ system accepts, and any -% value, even fractional, may be used. Please, do not -% exaggerate with small sized normal fonts, where I would -% say that 9.5pt is the absolute minimum acceptable size for -% normal text. Do not exaggerate with large sizes; 14pt is +% discourage this use in a technical thesis, where the default +% 10 point size sometimes might be too small, but 11 point or +% 12 point typesetting may be adequate. In any case the +% \meta{font size} may be specified in any units the \TeX\ +% system accepts, and any value, even fractional, may be used. +% Please, do not exaggerate with small sized normal fonts, where +% I would say that 9.5pt is the absolute minimum acceptable size +% for normal text. Do not exaggerate with large sizes; 14pt is % acceptable for certain theses where unusual signs are -% used above or below some letter strings, otherwise 14pt +% used above or below some alphabetic strings, otherwise 14pt % is already too much; let us say that 12.5pt or 13pt are % the maximum normally accepted; larger sizes are used only % for books to be used in the first years of the elementary -% school or for people with various kinds of visual impairment. +% school or for people with various types of visual impairment. % % \Item[autoretitolo] This option modifies the left hand (even % numbered) pages in two side typesetting; normally the even % numbered page headings contain the chapter title, while the % odd numbered ones contain the current section title. -% If the \opz{classica} option has been specified, then -% with this option (that is effectively working only with the -% \opz{classica} option in force) it is possible to have even -% numbered page headings contain the author's name and the thesis -% title, while the odd numbered ones contain the chapter title. -% Since the thesis title might be too long to fit in the header +% If and only if the \opz{classica} option has been specified, then +% the |autoretitolo| option makes even numbered page headings +% contain the author's name and the thesis title, while the odd +% numbered ones contain the chapter title. +% Since the thesis title might be too long to fit into the header % together with the author's name, the |\title| macro as been -% redefined so as to accept an optional short title, similarly -% to the ordinary sectioning commands. +% redefined so as to accept an optional short title: this feature +% mimics the ordinary sectioning commands. % % \Item[oldstyle] Also this option works only if \opz{classica} % had already been specified; it typesets several numerical data % with the old style numbers. % -% \Item[numerazioneromana] Sets the front matter folios in roman -% numerals; if this option is not used, the folios are in arabic +% \Item[numerazioneromana] Sets the front matter folios in Roman +% numerals; if this option is not used, the folios are in Arabic % numerals and do not restart from~1 when the first main matter -% chapter is typeset. The traditional roman numbering of front +% chapter is typeset. The traditional Roman numbering of front % matter folios had its explanation when typesetters used metal -% type; therefore they could produce all the front matter material, -% including reference, tables of contents, and the like, only -% when the main matter was complete, corrected and stable. -% Nowadays with electronic typesetting there is no need to need -% to use this artifice, but in some disciplines it is still -% highly appreciated. +% type; with this technique they could produce all the front +% matter material, including references, tables of contents, and +% the like, only when the main matter was complete, corrected +% and stable. Nowadays with electronic typesetting there is no +% need to to use this artifice, but in some disciplines it is +% still considered an elegant touch. %\end{description} % -% Since version 6.xx.yy options to the TOPtesi class have the -% syntax \emph{key${}={}$value}; depending on the kind of thesis, -% there there are some vlues that are particularly significant; +% Since version 6.xx.yy options to the TOPtesi class follow the +% syntax \emph{key${}={}$value}; depending on the kind of thesis +% there there are some values that are particularly significant; % the key for all of them is |tipotesi| (\emph{thesis kind}); % the values are indicated hereafter. % @@ -784,7 +807,7 @@ School of Turin. % some other packages get preloaded; the user can read further % on what actually becomes available with this option; the most % relevant difference is that the default language becomes English -% also for the naming of the user commands.. +% also for the naming of the user commands. % % \Item[tipotesi=triennale] and \opz{tipotesi=monografia} % (aliases of one another) load the specific module to @@ -795,14 +818,14 @@ School of Turin. % \Item[tipotesi=magistrale] loads the specific module % to typeset the master degree thesis title-page. This module % is substantially equivalent to the generic module |topfront| -% except that typesets only the master degree thesis title page. +% except that typesets only the master-degree thesis title-page. % % \Item[tipotesi=dottorale] loads the specific % module to typeset doctoral thesis title-pages. This module is % very basilar and has nothing to do with the module for the % ScuDo doctoral theses that require a particular title-page % layout; we suggest to customise this module through a suitable -% configuration file, rather then tweaking the ScuDo module. +% configuration file, rather than tweaking the ScuDo module. % % \Item[tipotesi=secondaria] loads the module to typeset the % secondary school (high school) final work title page. The @@ -818,20 +841,26 @@ School of Turin. % If the user explicitly loads one before the |\begin{document}| % statement, this file becomes the one that the user must follow % to create his/her own title page; otherwise if the user wants -% a custom title page s/he uses the |titlepage| environment; +% a custom title page s/he may use the |titlepage| environment; % in this case the user is completely free to write what s/he % wants, where s/he prefers, using the fonts s/he likes, and % so on. In alternative the user prepares the title page in % \sigla{pdf} format with some other program and includes it % in his/her thesis by means of the functionalities of the % |pdfpages| package. In any case the user is not forced by -% this TOPtesi bundle to use any of its title page facilities. +% this TOPtesi bundle to use any of its title page facilities; +% its title page facilities are highly recommended for theses +% to be submitted to the Student Office of Politecnico di Torino, +% and for the ScuDo doctoral theses; in other universities and +% in disciplines different from those connected with Politecnico +% di Torino, the user is free to follow his/her University +% prescriptions without any constraint by the TOPtesi bundle. % % \item[Attention!] It goes by itself that each one of the last % options does not load the generic module |topfront|, therefore % the commands provided by this standard module are not available % any more. Every effort has been made in the various modules to -% maintain the same commands, but in certain thesi kinds they +% maintain the same commands, but in certain thesis kinds they % might behave differently than expected. % % The user therefore is strongly urged to consult the documentation @@ -852,19 +881,20 @@ School of Turin. % in order to have the title page contain all the required % information. It must be specified that most of these commands % may be used in the configuration file so as to avoid repeating -% the same data for different ``final reports'': a university -% student might write a bachelor's ``monografia'', then a master +% the same data for different “final reports”: a university +% student might write a bachelor's “monografia”, then a master % thesis and finally a doctoral dissertation; why should s/he % repeat his/her name, the name of the institution, and so on? % -% All the user commands for the title page redefine default -% values or strings; therefore if none of the required information +% Many user commands for the title page redefine default +% values or strings; they are particularly usefull when the thesis is +% typeset in a different language; if none of the required information % is given, the default values and strings are typeset, possibly % with hilarious results\dots % % Except for the self made customised module for the title-page, % all the modules accept the same commands as those available in -% the |TOPfront| module. Pay attention that some commands are +% the |TOPfront| module. Pay attention, though, that some commands are % meaningless in certain theses, therefore do not reverse the % statement: for example the doctoral cycle command (|\cycle|) % is meaningless in a bachelor degree final-work title-page. @@ -881,7 +911,7 @@ School of Turin. % \] % Since the only language allowed in the ScuDo doctoral thesis is % English, all its commands are in English; this was done to help -% the high number of foreign Ph.D. students in that school. +% the high number of foreign Ph.D.\ students in that school. % Therefore, for example, the general environment |frontespizio| % becomes |ThesisTitlePage|\footnote{Actually % \texttt{ThesisTitlePage} is a wrapper to a particular instance @@ -893,6 +923,7 @@ School of Turin. % \begin{description}[noitemsep] % \def\cs#1{\texttt{\char92#1}} % \def\Item[#1]{\item[\normalfont\cs{#1}]} +%^^A % \item[\textnormal{\ttfamily frontespizio}] and % \texttt{frontespizio*} are two environments that typeset the % title page with two opposite styles: with the university logo @@ -922,7 +953,7 @@ School of Turin. % % \Item[sottotitolo] gets the thesis subtitle if any. % -% \Item[materia] gets the name of the subject the thesis deals with. +% \Item[materia] gets the name of the discipline the thesis deals with. % % \Item[Materia] alias for \cs{materia}. % @@ -933,10 +964,10 @@ School of Turin. % \Item[QualificaDirettore] gets the phrase that describes the % director or coordinator official position; by % using the command \cs{direttore} the default phrase -% ``Direttore della Scuola di Dottorato'' is printed -% above the ``director's'' name; if \cs{coordinatore} -% is used the default phrase ``Coordinatore della -% Scuola di Dottorato'' is printed instead. +% “Direttore della Scuola di Dottorato” is printed +% above the “director's” name; if \cs{coordinatore} +% is used the default phrase “Coordinatore della +% Scuola di Dottorato” is printed instead. % If neither one is applicable or a description % in another language is required, this macro is % available for specifying such position. @@ -953,32 +984,32 @@ School of Turin. % order to manage such situation. % \Item[tutore] gets the name of the doctorate tutor; there is no % difference with regards to the \cs{relatore}, but -% the default phrase ``Tutore'' is printed above this +% the default phrase “Tutore” is printed above this % person's name. % \Item[TutorName] gets the phrase that describes the tutor % position, possibly in a different language. % \Item[AdvisorName] gets the string that qualifies the % supervisor(s); the default string -% is ``Relatore:'' or ``Relatori:'' for the plural; +% is “Relatore:” or “Relatori:” for the plural; % in another language this command is used to -% define the string, say, ``Supervisors:'' if the +% define the string, say, “Supervisors:” if the % thesis has been supervised by more than one % person. % \Item[CoAdvisorName] gets the string that qualifies the % co-supervisor(s); the default string is -% ``Correlatore:'' or ``Correlatori:'' in the +% “Correlatore:” or “Correlatori:” in the % plural; this command may be used to define the -% string, say, ``Corapporteur:'' in a French Projet +% string, say, “Corapporteur:” in a French Projet % de fin d'\'etudes. This command may be used also % for setting an Italian singular name when the % tricks exemplified in file % \file{toptesi-example.tex} are used. -% \Item[candidato] gets the name of the male author -% \Item[candidata] gets the name of the female author -% \Item[secondocandidato] gets the name of the second male author -% \Item[secondacandidata] gets the name of the second female author -% \Item[terzocandidato] gets the name of the third male author -% \Item[terzacandidata] gets the name of the third female author; +% \Item[candidato] gets the name and surname of a male author (M). +% \Item[candidata] gets the name and surname name of a female author (F). +% \Item[secondocandidato] gets the name and surname of the second M author. +% \Item[secondacandidata] gets the name and surname of the second F author. +% \Item[terzocandidato] gets the name and surname of the third M author. +% \Item[terzacandidata] gets the name and surname of the third F author; % most often the thesis author is just one person; % but there are some institutions where group final % works are accepted; it is assumed that the group @@ -988,14 +1019,14 @@ School of Turin. % the proper gender and proper number. % For different languages there might be no % difference in gender but there is a difference -% in the plural ending. +% in plural. % \Item[CandidateName] gets the string that describes the student % status in a foreign % language or even in Italian; the default string -% is `Candidato:'' (with colons) adjusted to +% is `Candidato:” (with colons) adjusted to % masculine or feminine, singular or plural; with % option \opz{classica} the string becomes -% ``Laureando:''; in other languages it is +% “Laureando:”; in other languages it is % necessary to specify this string in the proper % gender and number. % \Item[sedutadilaurea] gets the date of the final exam, or @@ -1008,35 +1039,35 @@ School of Turin. % \Item[ciclodidottorato] gets the roman numeral that specifies % the doctoral cycle. % \Item[CycleName] redefines the string that expresses the name of -% the doctoral cycle; by default this is ``ciclo'' +% the doctoral cycle; by default this is “ciclo” % but this command is useful to set the name in a % different language. % \Item[corsodilaurea] gets the proper name of the degree course; % the phrase that describes the degree course is % specified, if necessary, with the next command; % with this one you specify just, say, -% ``Electrical Engineering''. +% “Electrical Engineering”. % \Item[CorsoDiLaureaIn] gets the generic name of the degree course, -% for example ``Bachelor Degree in''. +% for example “Bachelor Degree in”. % \Item[TesiDiLaurea] gets the generic phrase that describes the -% thesis; by default it is ``Tesi di Laurea''; in -% English one might set it to ``Master Thesis''. +% thesis; by default it is “Tesi di Laurea”; in +% English one might set it to “Master Thesis”. % \Item[NomeMonografia] gets the phrase that describes the -% bachelor's report; by default it is ``Monografia -% di Laurea''. In some Italian universities -% iˀt might be called -% ``Tesi di Laurea'', so that the master thesis +% bachelor's report; by default it is “Monografia +% di Laurea”. In some Italian universities +% it might be called +% “Tesi di Laurea”, so that the master thesis % should be given another qualification, for -% example`Tesi di Laurea Magistrale''. -% \Item[NomeDissertazione] gets the phrase that describes the -% doctoral thesis; by default it is ``Tesi di -% Dottorato''. +% example “Tesi di Laurea Magistrale”. +% \Item[NomeDissertazione] gets the phrase that describes the +% doctoral thesis; by default it is “Tesi di +% Dottorato”. % \Item[InName] infix strings often require adjusting of the % prepositions; this macro gets the preposition -% that stands for ``in'' (the default). In German -% it might become ``auf''. +% that stands for “in” (the default). In German +% it might become “auf”. % \Item[NomeAnnoAccademico] defines the infix string that stands for -% ``Academic year''. This macro is defined only if +% “Academic year”. This macro is defined only if % the option \opz{classica} is in force; % after all the command |\annoaccademico| is % defined only with that option. In any case, even @@ -1051,7 +1082,7 @@ School of Turin. % when a thesis is carried on in a multiple % University environment such as, for example, in % a double degree Erasmus program; or under the -% Erasmus Mundus program. The ``string'' of +% Erasmus Mundus program. The “string” of % logos is scaled properly so that they may fit % in |\textwidth|. % \Item[setbindingcorrection] sets up the length to displace the text @@ -1065,7 +1096,7 @@ School of Turin. % \Item[retrofrontespizio] with its argument, made up of one or more % paragraphs, defines what should be printed on the % verso of the title page, generally named -% ``copyright page''; if this command is specified +% “copyright page”; if this command is specified % with an empty text or if it is not used at all, % no copyright page is assumed. % \end{description} @@ -1092,6 +1123,7 @@ School of Turin. % that are described in the code description section; here we % focus on the title page. % +% \subsection{The ScuDo titlepage} % The title page for such special theses is typeset by making % use of a specific environment within which the following % commands are available to set up the necessary information. @@ -1108,23 +1140,23 @@ School of Turin. % preset value is specified, the user does not need to use the % command, unless s/he wants to change the preset value. If an % empty preset value is specified, the command and its value -% may be optional; but personal data are never preset because -% they are, obviously, mandatory. +% may be optional; but personal data are never preset because, +% obviously, they are mandatory. % % \Item[PhDschoolLogo]\marg{logo file name} (preset: Logo-Scudo) % selects an image % specified by \meta{logo file name} to insert the school logo; % a file logo \file{Logo-Scudo.jpg} is available from the ScuDo % doctoral school; the students must ask such logo file from -% the Secretary Office, because such file is legal property of +% the Student Office, because such file is a legal property of % the School and can be used only with permission. In any case -% the logo file must be of one of the allowed formats: \sigla{PDF}, \sigla{EPS}, -% \sigla{JPG}, \sigla{PNG}; vector files are generally preferred, but they -% might not be available; raster files should be of a minimum -% definition of 150 pixel per inch. +% the logo file must be of one of the allowed formats: \sigla{PDF}, +% \sigla{EPS}, \sigla{JPG}, \sigla{PNG}; vector files are generally +% preferred, but they might not be available; raster files should +% be of a minimum definition of 150 pixels per inch. % % \Item[Ndissertation]\marg{dissertation name} (preset: Doctoral -% Dissertation) Specifies the specific name of the document. +% Dissertation) specifies the specific name of the document. % % \Item[Ndoctoralprogram]\marg{doctoral program} (preset: Doctoral % Program in) specifies the degree course name prefix. @@ -1152,7 +1184,7 @@ School of Turin. % Supervisor:) specifies the short heading labelling the list % of supervisors; the preset value is singular and followed by % a colon. In case of more than one supervisor, it is necessary -% to specify a plural name; the colon mark is optional. +% to specify a plural name; the colon sign is optional. % % \Item[SupervisorList]\marg{list of supervisors} (mandatory: % preset empty) specifies the list of supervisors, one per line, @@ -1185,32 +1217,33 @@ School of Turin. % in different universities. % % \Item[Signature]\marg{the author's signature} (preset: a few -% lines where the city is preset to ``Turin'', and the date is +% lines where the city is preset to “Turin”, and the date is % assumed to be equal to the examination date; also the signer % name is assumed equal to that of the dissertation author) % specifies a different layout of the signature field. % % \end{description} +% % Several examples of thesis title-page are shown in the % \texttt{toptesi-it.pdf} Italian"-English documentation. % -% \subsection{Typesetting commands} +% \subsection{Languages} % The TOPtesi bundle and the |toptesi| document class accept % all \LaTeX\ commands provided by the \LaTeX\ \texttt{kernel}, % the \texttt{report} document class, and the \texttt{graphicx} % extension package, besides those provided by the \texttt{babel} % package. If the source thesis file is being typeset by means -% of \XeLaTeX\ and \LuaLaTeX\ the \texttt{babel} package is not +% of \XeLaTeX\ or \LuaLaTeX\ the \texttt{babel} package is not % loaded; in its place the \texttt{polyglossia} package gets % loaded that should implement in \XeLaTeX\ and \LuaLaTeX\ most of % the functionality provided by \texttt{babel} in \LaTeX. -% ``Most'' means that not all the functionality is available, +% “Most” means that not all the functionality is available, % therefore it is better to consult the documentation of -% \texttt{polyglossia} before using its built in commands. +% \texttt{polyglossia} before using its built-in commands. % % With this respect it must be underlined that the Italian and % English languages are specified by default, the Italian one -% being the main language. Only with the \opz{scudo} option +% being the main language. Only with the \opz{tipotesi=scudo} option % in force, the main language is English. An initial specification % of |\selectlanguage{english}| sets the English language as the % default (unnecessary when \opz{scudo} is in force). @@ -1253,15 +1286,15 @@ School of Turin. % distributions also the language hyphenation rules known to % \XeLaTeX\ are all preloaded. On the opposite \LuaLaTeX\ % loads the hyphenation rules at run time and only for the -% declared languages for the current document. +% declared languages of the current document. % % Remember that \texttt{babel} and \texttt{polyglossia} macros % select the language typesetting rules, but hyphenation is % activated only if the program format file has been generated % with the pertinent language hyphenation rules. You can check % this detail by reading the first dozen lines of your thesis -% \texttt{.log} file; there the list of all language hyphenation -% rules that are available in the format file is being shown. +% \texttt{.log} file; it contains the list of all language +% hyphenation rules that are available in the format file. % % While (American) English is the default language and almost % any \emph{basic} distribution of the \TeX\ system has several @@ -1288,25 +1321,41 @@ School of Turin. % proper places. % \end{enumerate} % -% The TOPtesi bundle adds very little to the user commands; -% nevertheless the package \texttt{topcoman.sty}, that is part -% of this bundle and is automatically loaded, defines some useful -% commands for typesetting technical matters in such a way as to +% \subsection{Bibliography} +% \textcolor{red}{The ScuDo module is the only one that preloads some +% suitable packages to typeset one or more bibliographies. None of the +% other modules preload any bibliography management utility.} This is due +% to the fact that the module was originally developed for +% typesetting PhD theses in the scientific domains related to the +% Institute of Electrical and Electronics Engineers (IEEE); such +% module was in facts used primarily by PhD students in those fields. +% The ScuDo doctoral School does not manage doctoral curriculums only +% for the “electrically oriented doctorands”, therefore alternatives +% had to be offered to the other PhD students in order to typeset +% their bibliographies according to the styles normally used in their +% scientific domains. The procedure is better described in +% section~\ref{sec:scudo} but it is suitable with minimal +% modifications also for the other thesis types. +% +%\subsection{Typesetting commands provided by \pack{topcoman}} +% The TOPtesi bundle adds very little to the user commands defined +% by the |report| class; nevertheless the package \texttt{topcoman.sty}, +% that is part of this bundle and is automatically loaded, defines some +% useful commands for typesetting technical matters in such a way as to % fulfil some (not all) \sigla{ISO} regulations. -% Some of these commands are already -% defined with the \texttt{babel} Italian option, but if your -% thesis is written in different languages it may happen that such -% commands are not available any more when you select another -% language; with the presence of the definitions contained in -% \texttt{topcoman.sty} such useful commands should remain available +% Some of these commands are already defined with the \texttt{babel} +% Italian option, but if your thesis is written in different languages +% it may happen that such commands are not available any more when you +% select another language; with the presence of the definitions contained +% in \texttt{topcoman.sty} such useful commands should remain available % with every language. The \texttt{polyglossia} package does not -% produce any useful additional command for writing in an almost \sigla{ISO} -% compliant way\footnote{Nevertheless, when typesetting with +% produce any useful additional command for writing in an almost +% \sigla{ISO} compliant way\footnote{Nevertheless, when typesetting with % \XeLaTeX\ or \LuaLaTeX\ and using OpenType fonts, even for -% typesetting math, the calling of the |unicode-math| package -% with option \opz{mathstyle=\sigla{ISO}} lets you typeset in an \sigla{ISO} +% typesetting math, the calling of the |unicode-math| package with +% option \opz{mathstyle=\sigla{ISO}} lets you typeset in an \sigla{ISO} % compliant way almost everything you need.}, therefore the macros -% contained in the \texttt{topcoman.sty} package may come very handy. +% contained in the \texttt{topcoman.sty} package may come handy. % % The following description specifies these particular commands. % \begin{description}[noitemsep] @@ -1314,7 +1363,7 @@ School of Turin. % % \Item[DeclareSlantedCapitalGreekLetters] does exactly what % its name means: it changes the definitions of the mathematical -% capital Greek letters so that they are typeset in ``italics''; +% capital Greek letters so that they are typeset in “italics”; % they are actually taken from the math italic alphabet, % instead of the default roman one. This command is useful with % \LaTeX, while with \XeLaTeX\ and \LuaLaTeX\ it is unnecessary @@ -1352,81 +1401,85 @@ School of Turin. % source file; it's necessary to typeset, say, |35\unit{km}| % while avoiding a form such as \verb*+35 \unit{km}+. % This command, as it is defined, conflicts with the definition -% of the homonymous command |\unit| as defined by the -% \texttt{unitx} package, but since this latter package is +% of the homonymous command |\unit| as defined by some packages such as +% \texttt{unitx}, \texttt{siunitx}, etc., but since this latter package is % necessarily input in the preamble, while \texttt{topcomand.sty} -% is read at the execution of |\begin{document}|, the latter -% file has provisions to test if |unitx| has already been loaded, +% is read at the execution of |\begin{document}|, the latter file has +% provisions to test if any of those packages has already been loaded, % so as not to overwrite the latter package definition and to avoid % every possible conflict. % % % \Item[micro] sets the decimal prefix $\mu$ (providing, if % possible, the sign with serifs, \textmu, taken from the Text % Companion font or any other font that contains this variety -% of the Greek letter $\mu$) when typesetting units of measure. +% of the Greek letter {\usefont{LGR}{lmr}{m}{rs}m}) when typesetting +% units of measure. % % % \Item[gradi] sets the small circle that defines the sexagesimal % degrees, for example $35^\circ$; it may be used also for the % celsius degrees by writing in the source file, say, % |35\unit{\gradi C}| in order to get $35\,^\circ\mathrm{C}$; % notice the difference with |35\gradi|, that yields $35^\circ$ -% without any space between the measure and the ``degree'' little +% without any space between the measure and the “degree” little % circle; this is what the \sigla{ISO} regulations require; the small % space inserted by |\unit| is required when the unit of measure % symbol contains at least one letter. % % % \Item[gei] inserts the imaginary unit in upright type with the -% ``spelling'' used by the technologists: ``j''. This command may be -% redefined, of course, but this strange name is due to the fact that -% nowadays the letter ``j'' in Italian is called with the +% “spelling” used by the Italian technologists: “j”. This command +% may be redefined, of course, but this strange name is due to the fact +% that nowadays the letter “j” in Italian is called with the % one-syllable English name (much shorter than the traditional -% Italian three syllable name ``i~lunga'') and the indicated spelling -%``gei'' is the phonetic Italian rendering of the English word. +% Italian three syllable name “i~lunga”) and the indicated spelling +%“gei” is the phonetic Italian rendering of the English word. % The imaginary unit is not a variable, and the \sigla{ISO} regulations -% require it is typed with an upright serifed font, just as -% operators are. +% require it is typeset with an upright serifed font. % % -% \Item[eu] inserts the Napier number symbol ``e'' in upright +% \Item[eu] inserts the Napier number symbol “e” in upright % type; since this entity is not a variable, but it is % a mathematical constant, the \sigla{ISO} regulations require it to -% be written in upright type. The \sigla{ISO} regulations require the -% upright type for ``e'' and any other mathematical constant, -% but the electron charge $e$ is typeset in math italics because -% this is a physical ``constant'', not a mathematical one. +% be typeset in upright type. The \sigla{ISO} regulations require the +% upright type for “e” and any other mathematical constant, +% but requires the electron charge $e$ is typeset in math italics because +% this is a physical “constant”, not a mathematical one. % \XeTeX\ and \LuaLaTeX\ allow to typeset upright math Greek % letters, so there is the facility to typeset an upright -% ``pi'' (the number) to be distinguished from an slanted -% ``pi'' (the angle). +% “{\usefont{LGR}{lmr}{m}{rs}p}” (the number) to be distinguished +% from a slanted “$\pi$” (the angle). % % % \Item[goodpagebreak] inserts a conditional page break after % the point where this command appears; it is not equivalent to % the |\raggedbottom| declaration that does not vertically -% justify any page, but tests the amount of space remaining -% on the page, and if it is less than a given number of lines, -% it inserts a page break; the result is a ragged -% bottom single page, that sometimes is better than excessive +% justify \emph{any} page; this command tests the amount of space +% remaining on the page, and if it is less than a given number +% of lines, it inserts a page break; the result is a ragged +% bottom \emph{single} page, that sometimes is better than excessive % spacing between paragraphs, or within items of a list, or % before or after displayed material. It is handy also to use % before starting a new section, because at least four % lines are required by \LaTeX\ in order to avoid orphan lines. +% \cs{goodpagebreak} accepts an optional argument that sets the +% number of lines to test the necessary space for a break; +% by default this number is~4. % % \Item[listing] requires for its argument the name of a file % and typesets it in verbatim mode; this command is very useful % for typesetting the listings of the programs that were written % for the thesis; for best results it is recommended that the -% source program has lines not longer than 80 characters. The -% original definition of command |\listing| dates back to the -% old times of \LaTeX\,209; it has become obsolete; for -% backwards compatibility it is maintained as an alias to the -% command |\VerbatimInput| of package |fancyvrb|; its +% source program has lines not longer than 80 characters. +% +% The original definition of command |\listing| dates back to the +% old times of \LaTeX\,209; it has become \textcolor{red}{obsolete}; for +% backwards compatibility it is maintained but as {\color{red}an alias +% to the command |\VerbatimInput| of package |fancyvrb|}; its % functionality may be configured with the same commands % specified in the |fancyvrb| documentation for the original % command. The |fancyvrb| package was preferred to the |listings| -% package, because it typesets verbatim material even while +% one, because it typesets verbatim material even while % using font with multibyte encoding (therefore it works fine % with \XeLaTeX\ and \LuaLaTeX), while the fancier package % |listings| performs correctly only with \sigla{ascii} -% characters and requires special settings to use characters +% characters and requires special settings to use selected characters % encoded with more than 7~bits. % \end{description} % @@ -1451,7 +1504,7 @@ School of Turin. % and some options are defined. % % The rest of the module is a subset of the |topfront| package; -% all commands that refer to information used for other kinds +% all commands that refer to information used for other types % of theses are eliminated and the title page is typeset by means % of another environment that does not rely on the environment % |frontespizio| (with or without asterisk). The new environment @@ -1465,8 +1518,8 @@ School of Turin. % \begin{enumerate}[noitemsep] % \item % The commands to define the infix words, so as to use them -% explicitly within the |ThesisTitlePage| environment or -% within a configuration file either to change the default +% explicitly within the |ThesisTitlePage| environment or +% within a configuration file either to change the default % strings or to define them for languages different from % Italian; no attempt was made to establish such strings % for English, because is is supposed the most often than @@ -1475,7 +1528,7 @@ School of Turin. % nevertheless the possibility to change these strings is % always available. % \item -% The commands that defines the default values for every +% The commands that define the default values for every % command that may be used or may be skipped while setting % up the title page. % \item @@ -1484,7 +1537,7 @@ School of Turin. % \end{enumerate} % As explained above the first group is used essentially to % define or redefine the infix strings. The second group is to -% define mosts default values for information that might or +% define most default values for information that might or % might not be entered by the user; these values are tested % against the |\empty| value in order to decide if using or % neglecting them. The third group is the one that the user @@ -1505,7 +1558,7 @@ School of Turin. % for the infix strings, and/or the other commands that can be % used within the |ThesisTitlePage| environment. % -% If a configuration file was loaded, the commands its contains +% If a configuration file was loaded, the commands it contains % are overwritten by those that are specified within the % |ThesisTitlePage| environment. So the user should pay attention % to what the configuration file contains and to what s/he writes @@ -1524,9 +1577,9 @@ School of Turin. % \begin{description}[noitemsep] %\def\Item[#1]{\item[\opz{#1}]} % -% \Item[evenboxes] The boxes containing the supervisor name(s) -% and containing the candidate name(s) are typeset with -% their first lines aligned; if this option is not specified +% \Item[evenboxes] The boxe containing the supervisor name(s) +% and that containing the candidate name(s) are typeset by +% aligning their first lines; if this option is not specified % the boxes are skewed, so that there is enough place to set % the supervisor signature(s) on the right and the candidate % signature on the left; if the bachelor degree final work does @@ -1563,13 +1616,13 @@ School of Turin. % The only user environment defined by this module is % |ThesisTitlePage|. It plays the same role as the |frontespizio| % environment, but it is incompatible with the |\frontespizio| -% command. In other words, if this module is used the user must +% command. In other words if this module is used, the user must % use the |ThesisTitlePage| environment only and does not have % available the various title page environments and commands % available with the |topfont| package. % % This environment accepts an optional asterisk as an argument; -% that is the syntax is the following: +% the syntax is the following: %\begin{ttsintassi} %\cs{begin}\Marg{ThesisTitlePage}\meta{*} %\meta{thesis definition commands} @@ -1591,51 +1644,52 @@ School of Turin. % \item[String settings] % \begin{description}[noitemsep] % \Item[NomeAnnoAccademico] Sets the default string for the -% ``Academic Year''; by default it is ``Anno accademico''. -% \Item[NomeCorso] sets the default string ``Corso di laurea -% in'' followed by an intelligent space. +% “Academic Year”; by default it is “Anno accademico”. +% \Item[NomeCorso] sets the default string “Corso di laurea +% in” followed by an intelligent space. % \Item[AnnoAccademico] sets a different string in place -% of the default ``Anno Accademico'' one. +% of the default “Anno Accademico” one. % \Item[Struttura di] sets the default structure prefix; -% for example this prefix might be ``Department of'', +% for example this prefix might be “Department of”, % and the structure name entered with \cs{struttura} -% might be ``Electrical Engineering''; therefore the +% might be “Electrical Engineering”; therefore the % title page is typeset with the complete string -% ``Department of Electrical Engineering. The default +% “Department of “Electrical Engineering”. The default % string is in Italian, but by using this command, % remember to enter the string you need terminated by % the intelligent space macro \cs{xspace}. % \Item[CorsoDiStudi] sets the default string for the -% degree corse type; it might be ``Laurea triennale'', -% or ``Bachelor degree'' or similar strings in other +% degree course type; it might be “Laurea triennale”, +% or “Bachelor degree” or similar strings in other % languages. It replaces the obsolete following command: % \Item[CorsoDiLaureaIn] that remains available with the backwards -% compatible standard |topfront| module. +% compatible |topfront| standard module. % \Item[NomeElaborato] Sets the name that qualifies the -% document; by default it is ``Monografia'', but this +% document; by default it is “Monografia”, but this % user command may be used to set it, for example, to -% ``Tesi di laurea triennale'', or anything else in +% “Tesi di laurea triennale”, or anything else in % Italian, in English, or the used main language. -% The |topfront| command |\NomeMonografia| il let to -% to |\NomeElaborato| for backwards compatibility; its +% The |topfront| command |\NomeMonografia| is let to +% to |\NomeElaborato| for backwards compatibility and its % use is evidently discouraged. % \Item[CandidateNames] sets the labelling command for the % box that lists the candidate names; by default these names are the % masculine, feminine, singular and plural Italian names -% starting with ``Candidato''; if the \opz{classica} option -% is in force they start with ``Laureando''; -% the user can use this command which it hass a non standard syntax -% (delimited arguments); therefore it should be avoided by the -% end users. +% starting with “Candidato”; if the \opz{classica} option +% is in force they start with “Laureando”; +% the user couldn use this command which it has a non standard syntax +% (delimited arguments); therefore it is suggested that +% end users refrain from using it, unless they know how to handle +% the delimited argument commands. % This command sets the four strings to any desired value, % if, as in English, there is no difference between masculine % and feminine, repeat the same name for the feminine positions, -% the last ones; the syntax is in facts: +% the last ones; the syntax in facts is the following: %\begin{ttsintassi} %\cs{CandidateNames},\% %\qquad\marg{masculine singular},\% %\qquad\marg{masculine plural},\% -%\qquad\marg{feminine singular}\% +%\qquad\marg{feminine singular},\% %\qquad\marg{feminine plural},! %\end{ttsintassi} % \Item[TitoloListaCandidati] is a much simpler command the user @@ -1655,29 +1709,29 @@ School of Turin. % singular/plural and masculine/feminine variants) to substitute % the default ones. Please notice that this command is not % available with the other thesis type options. -% \Item[Relatore] Sets the supervisor string that labels +% \Item[Relatore] Sets the string that labels % the supervisor box; by default it is the Italian -% name ``Relatore''; the command my be used to set +% name “Relatore”; the command my be used to set % any different string. -% \Item[Correlatore] set the co-supervisor string that +% \Item[Correlatore] sets the string that % labels the list of co-superpervisors when there is -% only one ``second'' supervisor. -% \Item[Correlatori] sets the co-supervisor string that +% just one “second” supervisor. +% \Item[Correlatori] sets the string that % labels the list of co-supervisors when there are -% three supervisors, one principal and two co-supervisors. +% three supervisors, a supervisor and two co-supervisors. % \end{description} % \item[Variable data settings] % \begin{description}[noitemsep] % \Item[titolo] sets the bachelor degree final work title. % The main module |topfront| uses in its place the command -% \cs{monografia}; the user can still use this command, +% \cs{monografia}; the user can still use the old command, % but |\titolo| is more descriptive. -% \Item[sottotitolo] Sets the optional subtitle. +% \Item[sottotitolo] sets the optional subtitle. % \Item[corsodistudi] and \cs{corsodilaurea} specify the actual % name of the degree course; \cs{corsodistudi} should be % preferred; \cs{corsodilaurea} is deprecated, but is maintained % for backwards compatibility. -% \Item[materia] and \cs{Materia} set the optional subject +% \Item[materia] and \cs{Materia} set the optional discipline % the thesis deals with. % \Item[relatore] sets the name of the only or the principal % supervisor. @@ -1685,21 +1739,26 @@ School of Turin. % if any. % \Item[terzorelatore] sets the name of a third supervisor, % if any. -% \Item[candidato] sets the name of the first or only male +% \Item[candidato] sets the name of the first or only ‘M’ % candidate; in general bachelor degree final works are -% done by just one candidate, but in case there are +% done by just one candidate but, in case, there are % available also the commands for a second and a third % candidate. Masculine and feminine commands are available % and the heading of the candidates box il labelled accordingly. -% \Item[candidata] sets the name of the first or only female +% \Item[candidata] sets the name of the first or only ‘F’ % candidate. % \item[\normalfont\cs{secondocandidato} or \cs{secondacanddata}] -% set the names of a possible second male or female candidate. +% set the names of a possible second ‘M’ or ‘F’ candidate. % \item[\normalfont\cs{terzocandidato} or \cs{terzacandidata}] -% set the names of a possible male or female third candidate. +% set the names of a possible ‘M’ or ‘F’ third candidate. % \Item[ID] to be used just after the candidate's name, but as % part of the setting command argument, establishes the -% candidate's ID number (or matricola). +% candidate's ID label string |\IDlabel| that prefixes the +% candidate's ID number. The user should not worry about this string, +% unless s/he wants to modify it; by default it is set to +% |\\\quad matricola\ |; in other words, the ID number is set +% indented under the candidate's name and a space is put between +% the string and the number. % \Item[sedutadilaurea] sets the date of the final examination; % by default the current month and year are typeset if this % command is not specified; but the user can specify anything; @@ -1707,7 +1766,7 @@ School of Turin. % \cs{AnnoAccademico} command, that typesets (in the current % language if localisation has been made by means of the % suitable command of group~1) a string equivalent to -% ``Academic Year''; in any case the user can write down what +% “Academic Year”; in any case the user can write down what % s/he likes best in place of the predefined value. % \Item[NomeAteneo] sets the proper name of a specific % university; it will be typeset in suitable uppercase type @@ -1715,7 +1774,7 @@ School of Turin. % is not used, no name gets typeset in the title page. % \Item[struttura] sets the name of the university entity % that supervises the development of the degree course; -% it may be a ``faculty'', a ``department'', a ``school'', +% it may be a “faculty”, a “department”, a “school”, % it depends from the specific university. Some universities % do not require this information on the title page. In any % case if this command is used it accepts two arguments: @@ -1724,12 +1783,13 @@ School of Turin. % the second argument is the complete structure name. % \Item[setlogodistance] sets the distance between adjacent % university logos, if more then one is used. -% \Item[logosede] Sets the name of a graphics file that +% \Item[logosede] sets the name of a graphics file that % contains the logo of the university; the default value of % this command il \cs{empty}; this macro may be used several % times, in case the bachelor degree final work is developed % within a multiple degree Erasmus program; this might be -% unusual but not impossible. In any case if no logo file +% unusual with bachelor degree courses but not impossible. +% In any case if no logo file % name is specified, no logos are printed and no space % is used in the title page; if one or more logos are used % they are assembled with the same height into a horizontal @@ -1738,7 +1798,7 @@ School of Turin. % preserving the aspect ratio so as to fit it inside the % text width; after these tests and possible scaling down, % the logo box is printed. The logo distance my be varied -% from the 3em default value by using \cs{setlogodistance}, but +% from its 3em default value by using \cs{setlogodistance}, but % it is suggested not to vary it too much. The \cs{logosede} % accepts an optional value that is the common height of the % logos; this possibility does exist but it is strongly @@ -1770,11 +1830,11 @@ School of Turin. % and this specific module |toptesi-magistrale|. %\begin{enumerate}[noitemsep] %\item -% With enumerate each tome title page is realised by means +% Setting the tome number on each tome title-page is realised by means % of the |\tomo| command that requires a preliminary % specification of all the necessary data before |\tomo| % can play its role; it actually uses the |\frontespizio| -% command, but before the |tomo| counter is stepped up. +% environmnet, but before the |tomo| counter is stepped up. % % This allows to typeset the various tomes in a single % document, so that the user can cross-reference elements @@ -1786,10 +1846,10 @@ School of Turin. % the single document file may be completely hyperlinked; % reading the printed tomes is correct, and reading the % whole thesis in a single document on the screen allows -% the easy navigation from one point to another. +% the cross-linked navigation from one point to another. % % The draw back of this procedure is that splitting the -% single \sigla{PDf} file in several file require another processing +% single \sigla{PDf} file in several files require another processing % job, and any editing of the source thesis files may require % repeating this splitting job because the number of pages % may be modified and/or cross references do not point @@ -1804,15 +1864,15 @@ School of Turin. % % In this way it is necessary to typeset each tome with % its own source file(s) to produce different output \sigla{PDF} -% files; when printed the are substantially identica to +% files; when printed they are substantially identical to % the split documents obtained with the previous approach -% and simply avoids splitting the single document file -% in several files. But if hyperlinked cross-referencing +% but it simply avoids splitting the single document file +% in several files. The drawback is thet if hyperlinked cross-referencing % is used, each tome is correctly hyperlinked to its % internal targets, but no cross-referencing can be -% automatically dono to items in other tomes. I do not +% automatically done to items in other tomes. I do not % think this is a real draw back in practical situations, -% but of course its produces a limitation to reading the +% but of course it produces a limitation to reading the % tomes on the screen. %\end{enumerate} % @@ -1830,11 +1890,11 @@ School of Turin. % % In summary this |toptesi-magistrale| module keeps all the % commands defined on the |topfront| module; modifies the -% definition of the |\tomo| command; adds the |ThesiTitlePage| -% environment within which the configuration file is read and all +% definition of the |\tomo| command; adds the |ThesisTitlePage| +% environment within which the configuration file is read and where all % commands for the title page data are to be inserted. The -% peculiarity of theis environment is that the possible asterisk -% necessary to switch from the the logos at the title page +% peculiarity of thes environment is that the possible asterisk +% necessary to switch from the the logos set in the title page % lower half (no asterisk) to the logos at the page top % (asterisk) must be inserted the same way as in the other % modules, that is as the first token at the beginning of @@ -1845,22 +1905,22 @@ School of Turin. % specified the necessary requirements for both contents % and appearance of the title page, we provide a generic % module for Ph.D.\ theses for other universities. It goes -% by itself the if the specifications cannot be customised +% by itself that if the specifications cannot be customised % by using the customising commands of the ScuDo module, -% nor by this module, it is necessari to use a custom +% nor by this module, it is necessary to use a custom % module that the user must create as specified in the next % section. % % This module is generic as much as the |topfront| one. -% It differs only for the elimination of the other thesis -% kinds and the only addition is the |ThesisTitlePage| -% environment, just as it has been done for the other -% bundle modules. +% It differs only for the elimination of the title page commands +% that refer to other thesis types and the only addition is +% the |ThesisTitlePage| environment, just as it has been done +% for the other bundle modules. % % The data insertion or modification commands are a subset % of those described in subsection~\ref{sec:topfront}, -% of course without those tha are specific of other thesis -% kinds; therefore we do not repeat them here. +% of course without those that are specific to other thesis +% types; therefore we do not repeat them here. % % Special care should be dedicated to the university % specifications; in some universities the supervisor(s) @@ -1869,11 +1929,11 @@ School of Turin. % it. The University logo might already contain the explicit % wording with the the university name and in this case % repeating the name would be pleonastic. At my level I -% cannot foresee the user requirements therefore it must -% be the user that takes care of inputting the correct +% cannot foresee the user requirements therefore it is up +% to the user to take care of inputting the correct % fixed word data and the specific thesis data. I hope % this module is useful for most Ph.D.\ students, but if -% the user comparer the title page requirements with those +% the user compares the title page requirements with those % prescribed for the ScuDo theses, s/he sees how much such % requirement might be different from one university to the other. % @@ -1891,7 +1951,7 @@ School of Turin. % needs. Of course this is an understatement; in facts s/he % should select a package form the many existing ones, s/he % can create him/herself a new package branched on other existing -% software; s/he mai refrains form using external packages, +% software; s/he may refrain form using external packages, % and simply insert his/her title page data within a |titlepage| % environment where s/he wants, with the fonts families, series, % shapes, and sizes s/he prefers and so on. @@ -1908,25 +1968,25 @@ School of Turin. % % We don't go further in describing the |tipotesi=custom| option, % except remembering the this option just inhibits loading both -% the standard default module, and any other module, unless the -% user loads it directly with or without the specific module options. +% the standard default module, and any other predefined module, unless the +% user directly loads one with or without the specific module options. % % \section{The high school final work module} % % The suffix |sss| is the acronym for the Italian name of -% ``High School'', \emph{Scuola Secondaria Superiore}. +% “High School”, \emph{Scuola Secondaria Superiore}. % Elegance of bureaucratic language; the elementary school % now is `Scuola Primaria', and junior high school is `Scuola % Secondaria Inferiore'. As well as it was in Germany and % in some Swiss Cantons, the total number of school years % is 13 instead of 12, as it is in most countries. The advantage % is that no general education is taught in university, no -% \emph{classes préparatoires}, because it is assumed that +% \emph{classes pr\'eparatoires}, because it is assumed that % the high school diploma assures a sufficient level of general % education. % % Differently from most high school systems in the world, -% in Italy each school has a special ``mission'' and receives +% in Italy each school has a special “mission” and receives % different names, all under the general definition of Scuola % Secondaria Superiore. But it s possible to distinguish % between Licei (University preparatory), Istituti tecnici @@ -1945,18 +2005,18 @@ School of Turin. % understand the importance of the \emph{esame di maturità} % and the important role that the high school final work % (nicknamed \emph{thesina}, `little thesis') plays in this -% generally difficult exam; statistics say that the number of -% flunking students is very low, but the final numerical grade -% (passing grade; from 60 to 100 with honours) plays also an -% important role in the following career, therefore students -% work very hard to pass with good grades. +% generally difficult exam; statistics say that the percentage of +% flunking students is very low, but the final passing grade +% (a numerical value in the range from 60 to 100 with honours) +% plays also an important role in the following career, therefore +% students work very hard to pass with good grades. % % The above off topic explains why in Italy the final high % school state exam includes the evaluation of a personal % written report on some subject chosen by each student; % this choice is often performed with -% an initial support by each student teachers, that give help in -% choosing the subject, and, maybe, offer some initial input. +% an initial support by a teacher, that gives help in +% choosing the subject, and, maybe, offers some initial input. % They do not supervise the student work; but this work is % submitted to the examining committee (the members of which % are external to the specific school) that after due reading, @@ -1994,7 +2054,7 @@ School of Turin. % look if the students do not tickle the typesetting program % to behave as a word processor. Several guides are available % for high school students, as well for university ones, to -% recall how a ``technical report'' should be properly written; +% recall how a “technical report” should be properly written; % unfortunately today students prefer to read their smartphones, % rather than real printed or electronic books; but those % students who use \LaTeX\ know very well that they need reading @@ -2004,7 +2064,7 @@ School of Turin. % Mirko Mondini suggested to extend the TOPtesi bundle to % include the title page for high school final works. He % also suggested the layout of the page. This module may be -% considered ``work in progress'' because we both have little +% considered “work in progress” because we both have little % experience with the requirements of such final works. % As the maintainer of this bundle I thank him very much; % Marco may suggest specific changes in the near future; @@ -2023,7 +2083,7 @@ School of Turin. % I think that \TeXLive may be updated more easily than MiKTeX % and, not negligibly, its default installation is complete, % while MiKTeX by default has a basic installation, so that very -% often offline MiKTeX users suffer from ``missing package'' errors. +% often offline MiKTeX users suffer from “missing package” errors. % % Since this module is going to be used only by Italian high % school students, all user commands are in Italian. @@ -2036,8 +2096,8 @@ School of Turin. % Packages |amsmath|, |amssymb| (only \pdfLaTeX) and |amsthm| % are already loaded, but a test is made to verify if the user % has loaded in his/her preamble the math packages |newtxmath| -% or |newpsmath| (possibly together with their companions -% |new..text|), because the latter packages already provide +% or |newpxmath| (possibly together with their companions +% |new...text|), because the latter packages already provide % for their functionalities. %\item % If they typeset with \LuaLaTeX\ or \XeLaTeX, the suitable @@ -2051,7 +2111,7 @@ School of Turin. % mostly those of |xcolor|. %\item % Packages |calc| and |ifthen| are functional for the module; -% supposedly the end user should not have any necessity to use +% supposedly the end users should not have any necessity to use % them, but, of course, they can if they need to. %\item % Package |multirow| has been loaded, because many users like @@ -2065,8 +2125,8 @@ School of Turin. % No particular package has been loaded to create a specialised % bibliography; either the student directly uses its own % |thebibliography| environment, or provides to chose whatever -% style s/he likes best and, s/he decides to load package -% |biblatex| and specifies the desired options. In the first +% style s/he likes best and, if s/he decides to load package +% |biblatex|, s/he should specify the desired options. In the first % case one of the most useful packages is |natbib|; in the % second case |biblatex| supports other bibliographic style % files. Both approaches require the preparation of a @@ -2079,6 +2139,7 @@ School of Turin. %\end{enumerate} % % The commands the user can use for the title page follow. +% % Remember that they may be used directly within the % |FrontespizioTesina| environment; if the user prefers, s/he % can write them in a configuration file; such file must be @@ -2108,13 +2169,13 @@ School of Turin. % the second two are bitmapped, therefore their rendering % depends very much on the pixel density of the file contents. %\Item[NomeTesina] sets the name of the document; the default value -% is ``Tesina di maturità''. Syntax: +% is “Tesina di maturità”. Syntax: % \begin{ttsintassi} % \cs{NomeTesina}\marg{nome dell'elaborato} % \end{ttsintassi} %\Item[NomeCandidato] % is used to set the label to typeset over the author's name; -% default ``Studente'' or ``Studentessa'' depending on the +% default “Studente” or “Studentessa” depending on the % state of the boolean switch |femminile|, but if this command % is used for the user tesina, s/he needs not to specify any % switch and uses the only name necessary for his/her document. @@ -2140,8 +2201,8 @@ School of Turin. %\Item[TipoScuola] % sets the specific generic name of the school; default % none; therefore use of this commands is mandatory; -% the user might specify ``Liceo classico'', or ``Istituto -% tecnico industriale di stato'', or whatever applies for +% the user might specify “Liceo classico”, or “Istituto +% tecnico industriale di stato”, or whatever applies for % the students' specific school. Syntax: % \begin{ttsintassi} % \cs{TipoScuola}\marg{generic school name} @@ -2149,13 +2210,13 @@ School of Turin. %\Item[NomeScuola] % sets the specific name of the school; generally schools % are dedicated to famous scientists or heroes, or presidents, -% or kings/queens, or writers, et cetera; default ``empty''. +% or kings/queens, or writers, et cetera; default “empty”. % Syntax: % \begin{ttsintassi} % \cs{NomeScuola}\marg{specific school name} % \end{ttsintassi} %\Item[SedeScuola] -% set the actual location of the school it may be just the +% sets the actual location of the school; it may be just the % city or a full postal address; it may contain new line % commands in order to format a full address of several lines; % no default. Syntax: @@ -2202,7 +2263,7 @@ School of Turin. % set the proper status to the |femminile| switch, so that the % proper default label is used. %\Item[Presidente] -% sets the name of the chairperson of th examining committee; +% sets the name of the chairperson of the examining committee; % no default. Syntax: % \begin{ttsintassi} % \cs{Presidente}\marg{examining committee chairperson full name} @@ -2254,7 +2315,7 @@ School of Turin. % % \section{\sigla{PDF/A} archivable format} % This section in general applies also if the thesis is typeset -% by means of \LuaLaTeX\ or \XeLaTeX, but with\XeLaTeX\ special +% by means of \LuaLaTeX\ or \XeLaTeX, but with \XeLaTeX\ special % attention should be paid to the details of the procedure as % described in the documentation of the \pack{pdfx} package. Even % better, \LuaLaTeX, whose source file is practically the same as @@ -2270,15 +2331,16 @@ School of Turin. % Politecnico di Torino and several other Italian and foreign % universities are moving towards archiving theses in electronic % format, specifically in the \sigla{PDF} one. The problem of -% course is: ``Will it be possible to read the archived documents, -% say, fifty years from now?'' +% course is: “Will it be possible to read the archived documents, +% say, fifty years from now?” % % This essential question has been answered by the International % Standards Organisation (\sigla{ISO}) that in 2005 published the % regulation \sigla{ISO}~19005-1; in 2011 and 2012 enhancements of % this regulation have been published. This regulation defines % a \sigla{PDF} variant suitable for archiving, named \sigla{PDF/A}, that -% has two sub-formats distinguished as \sigla{PDF/A}-1a, and \sigla{PDF/A}-1b. +% has two sub-formats distinguished as \sigla{PDF/A}-1a, and +% \sigla{PDF/A}-1b. % The `a' sub-format is more exacting, while the `b' one is less % stringent. In spite of the recently published upgrades, % here we stick to the older ones, that are a sub set of the @@ -2300,11 +2362,9 @@ School of Turin. % % Since version 1.40, the program \texttt{pdflatex} is capable % of producing \sigla{PDF/A}-1b compliant files, provided that some -% attention is put into editing of the thesis source file. -% -% With the distribution of the 2008 version of the \TeX\ system, -% the executable \texttt{pdflatex} has version number 1.40.9 -% (or higher) and is capable of producing \sigla{PDF/A}-1b files. +% attention is put into editing of the thesis source file. Since the +% year 2008 the \TeX\ system, the executable \texttt{pdflatex} has +% version number 1.40.9 (or higher); therefore today there should not be any dificulty in producing \sigla{pdf/a} compliant documents. % % The particular attention needed to avoid problems with the % \sigla{PDF/A} compliance is summarised as follows: @@ -2329,7 +2389,7 @@ School of Turin. % procedures described in the Italian documentation; such % documentation describes several more or less effective % methods to transform a non compliant \sigla{PDF/A} file into a -% compliant one, and how to correct the ``imperfections'' +% compliant one, and how to correct the “imperfections” % that forbid any valid transformation. % % \item @@ -2354,8 +2414,8 @@ School of Turin. % \texttt{JohnSmithMasterThesis.xmpdata} that contains the % \emph{metadata} relative to the thesis; pay attention % to follow the stringent syntax described and exemplified -% in the \textsf{pdfx} documentation. A minimal set of -% \emph{metadata} example would be the following one: +% in the \textsf{pdfx} documentation. A minimal example set of +% \emph{metadata} would be the following one: % \begin{verbatim} % \Title{Experiments in Trichotetratomy} % \Author{John Smith} @@ -2376,9 +2436,9 @@ School of Turin. % by \XeLaTeX\ and \LuaLaTeX\ do not require any patch. % % \item -% Use only \sigla{PNG} and \sigla{JPG} images with \sigla{RGB} color profiles. -% If a \sigla{PNG} image file contains some transparencies, the -% document \sigla{PDF} cannot be validated as \sigla{PDF/A} compliant. +% Use only \sigla{PNG} and \sigla{JPG} images with \sigla{RGB} color +% profiles. But if a \sigla{PNG} image file contains some transparencies, +% the document \sigla{PDF} cannot be validated as \sigla{PDF/A} compliant. % % \item % If you include \sigla{PDF} images that contain some text, be sure @@ -2393,11 +2453,10 @@ School of Turin. % because Inkscape might save your file with some % specifications for transparency; but transparency % specifications destroy the \sigla{PDF/A} compliance. -% % Should this inconvenience take place, instead of asking -% \texttt{inkscape} to save in \sigla{PDF} format, ask to save in \sigla{EPS} -% format; this one does not support transparencies, therefore -% they get abolished from the very beginning. This is useful +% \texttt{inkscape} to save in \sigla{PDF} format, ask to save in +% \sigla{EPS}% format; this one does not support transparencies, +% therefore they get abolished from the very beginning. This is useful % also when \texttt{inkscape} is used to change the color % profile of an image. Once used this program to convert an % image to \sigla{EPS} format without transparencies and/or with the @@ -2418,8 +2477,7 @@ School of Turin. % university has special facilities for this task. In any % case you can install the \prog{veraPDF} free software % from the Internet, and use this handy verification program -% (it is still in beta stage until the official stable release that -% is due during the year 2017). +% (in 2017 the stable release was made available). % %\end{enumerate} % @@ -2428,11 +2486,11 @@ School of Turin. % header stating that the file claims to be \sigla{PDF/A} compliant; % maybe it's true, but do not trust this information too much, % at least don't believe that this information is a -% ``certification'' of the \sigla{PDF/A} compliance. I have seen +% “certification” of the \sigla{PDF/A} compliance. I have seen % files with this comforting information that did not pass % the Preflight test! Actually the Reader is correct in saying -% that ``\dots\ the program claims to be \sigla{PDF/A} compliant\dots''; -% the Reader just notices that the metadata contains such a claim, +% that “\dots\ the program claims to be \sigla{PDF/A} compliant\dots”; +% the Reader just notices that the metadata contain such a claim, % but this does not imply that the claim is true. % % Up to today the realisation of \sigla{PDF/A} conforming files sets @@ -2463,7 +2521,7 @@ School of Turin. %<*class> % \fi % -% The class itself is very simple since it requires just the +% The class itself is very simple since it loads just the % \texttt{report} document class and some packages with some % default options. All options specified to the \texttt{toptesi} % class are passed on to the \texttt{report} class; the @@ -2553,15 +2611,16 @@ School of Turin. % compatibility. % % The option \opz{scudo} is used only to typeset doctoral -% dissertations with the special look required by the ``Scuola -% di Dottorato'' of Politecnico di Torino. The other options for +% dissertations with the special look required by the “Scuola +% di Dottorato” of Politecnico di Torino. The other options for % specific types of thesis, \opz{triennale}, \opz{monografia}, % \opz{magistrale}, \opz{dottorale}, \opz{secondaria}, are % described further on; options \opz{frontespizio} and -% \opz{custom} are avoid loading the default module |topfront| or any of the previous listed modules; the are used to create title pages +% \opz{custom} avoid loading the default module |topfront| or any +% of the previous listed modules; the are used to create title pages % different from the ones that are available with TOPtesi. - -% The |corpo = value| option can receive ``any'' value; if this +% +% The |corpo = value| option can receive “any” value; if this % value is not lower than 14\,pt , the |\if@xixpt| switch is % set to true; the value assigned to |corpo| specifies the normal % size; the TOPtesi bundle uses the |\changefontsizes| macro @@ -2569,14 +2628,14 @@ School of Turin. % system complete and up-to-date TeXLive or MiKTeX installation. % % Option \opz{chapterbib} allows to set a list of references at -% the end of each chapter. The option is maintained fore backward +% the end of each chapter. The option is maintained for backward % compatibility, but we discourage its use, because of the amount % of manual work involved; it is much better to use the |biblatex| -% functionalities and other packages created for this purpose. +% functionalities and/or other packages created for this purpose. % % For other options some boolean variables are % defined and the option definitions set some of them to the value -% ``true''. +% “true”. % \begin{macrocode} \newif\ifevenboxes \evenboxesfalse \newif\if@utoretitolo \@utoretitolofalse @@ -2605,11 +2664,14 @@ School of Turin. % using the specific command |\setbindingcorrection|. % The recommendation to the user is to not exaggerate with this % correction. In particular the user is warned not to use this -% option in order to mode che taxt body grid towards the outer +% option in order to move che text body grid towards the outer % edge, simply because s/he does not understand why two side % typesetting uses an inner margin smaller than the outer one. +% In any case see further on a deeper explanation about margins +% and binding correction. % -% The options |usefrontespizio| and |noTOPfront| are set by the specific ``function'' executed by the |tipotesi=|~value options. +% The options |usefrontespizio| and |noTOPfront| are set by the +% specific “function” executed by the |tipotesi=|\meta{value} options. % \begin{macrocode} \newlength\T@Pbinding \def\setbindingcorrection#1{\T@Pbinding=#1} @@ -2667,7 +2729,7 @@ School of Turin. \TOPfrontfalse\T@Pfrontespiziofalse \ifstrequal{#1}{custom}{\relax}{% \ifstrequal{#1}{triennale}{% - \def\TPT@tipo{toptesi-monografia}% opz:monografia + \def\TPT@tipo{toptesi-monografia}% opz: monografia }{\ifstrequal{#1}{secondaria}{% opz: secondaria \edef\TPT@tipo{toptesi-sss}% }{% @@ -2686,7 +2748,7 @@ School of Turin. % \end{macrocode} % The \texttt{graphicx} package is loaded by default; it is -% required for inserting the university logo(s); if the user +% required to insert the university logo(s); if the user % forgets that this package has already been loaded nothing % dramatic happens, because the |\usepackage| and |\RequirePackage| % macros perform the necessary tests in order to avoid @@ -2699,7 +2761,7 @@ School of Turin. % |\ifcsvoid|, because sometimes it is a macro and in any case % there might be situations when the argument string happens % to equal an existing control sequence name; therefore first -% we expand the possibly argument into an internal macro, then we test +% we expand the possible argument into an internal macro, then we test % such macro for emptiness. % % \begin{macrocode} @@ -2755,7 +2817,11 @@ School of Turin. % to define the other text-body-grid dimensions. % Without binding correction the inner and outer margin % are chosen equal, but the grid is moved outwards if the -% binding correction option is specified. +% binding correction option is specified. With the |libro| +% option in force, the outer, lower margin are larger than +% the corresponding inner and top margins. Without such +% option, the margins are initially set equal, unless the +% binding correction is specified. % \begin{macrocode} \iflibro \interno=\dimexpr\paperwidth-\textwidth\relax @@ -2785,9 +2851,9 @@ School of Turin. % \end{macrocode} % % We now establish the page style. We start by setting to -% ``empty'' the tokens that keep the left and the right +% “empty” the tokens that keep the left and the right % marks; we define a box so as to set the headers inside -% this box; we redefine also the plain page styles; it is +% this box; we redefine also the plain page style; it is % actually a leftover from the previous versions when the % page number was set at the foot in bold face, but we leave % it here without the bold face specification, so that in @@ -2879,8 +2945,8 @@ School of Turin. % require some boolean variables to be defined; in facts, % although the \sigla{ISO} regulations require that every technical % report contains the list of figures and/or tables, -% in Italy theses rarely contain these lists; but is a -% thesis a technical report? +% in Italy theses rarely contain these lists; the question is: “is a +% thesis a technical report?”. In Italy, in most cases, the answer is “no”. % We require also some other boolean variables to handle the % difference between front matter and main matter; this % differences are already defined in the \texttt{book} @@ -2919,7 +2985,7 @@ School of Turin. % The main matter is automatically established with the % first |\chapter| command issued by the user; this means % that every command that starts a section at the -% ``chapter'' level within the front matter must be +% “chapter” level within the front matter must be % executed without an explicit call to |\chapter|. This % refers especially to the |\sommario|/|\summary| and % |\ringraziamenti|/|\acknowledgements| sections. On the @@ -2938,7 +3004,7 @@ School of Turin. % command so that it uses by default the plain page style % for the blank page to be possibly inserted if chapters % should start on an odd page: but with the |\blankpagestyle| -% command it can be set to any other style, for example the +% command can be set to any other style, for example the % |empty| page style. % \begin{macrocode} \let\ps@blank\ps@plain @@ -2980,7 +3046,7 @@ School of Turin. % |\chapter| commands to typeset the Summary and the % Acknowledgements chapters, as defined above, are regularly % typeset in the front matter style, opening on any page -% (even or odd) and numbered with small caps roman numerals. +% (even or odd) and possibly numbered with small caps roman numerals. % \begin{macrocode} \def\@chapter[#1]#2{\iffrontmatter\mainmatter\fi \ifnum \c@secnumdepth >\m@ne @@ -3134,10 +3200,10 @@ School of Turin. } % \end{macrocode} % Since we are at it we define the floating bodies placing -% parameters; not only the values ``here'', ``page top'' -% and ``page bottom'', that we set as the default ones +% parameters; not only the values “here”, “page top” +% and “page bottom”, that we set as the default ones % leaving to the user to explicitly specify the -% ``page of floats'', but also the numerical and geometrical +% “page of floats”, but also the numerical and geometrical % parameters that control the float placements. % These geometrical parameters are critical and everybody % has his/her own ideas of what are the best values for them. @@ -3182,7 +3248,7 @@ School of Turin. % or the right segment of an hyphenated last word. If one % sets the |\finalhyphendemerits| parameter to an extremely % high value, one might succeed in avoiding a hyphenated -% penultimate caption line, but this might lead to a very +% penultimate caption line, but this might lead to a very % loose typesetting of the caption paragraph, especially % if the horizontal box that contains it hardly exceeds the % caption width. I initially set the caption width (a new @@ -3329,11 +3395,11 @@ School of Turin. % this little repetition is for using the correct prefix to % the caption text even when the environment is used outside % a formal floating one. In the following paragraphs we speak -% about an ``image'' to mean the ``environment main contents''. +% about an “image” to mean the “environment main contents”. % % This new special environment box gets actually floated if % explicitly inserted within a formal floating environment; -% But this special environment box is usable even as +% but this special environment box is usable even as % a standalone environment, or as an object in a fixed position, % such as when it is set within a mini-page or another similar % environment; in such situations it is not required to use @@ -3361,8 +3427,8 @@ School of Turin. % fraction of the current object width that is dedicated to the % caption, the remaining space being dedicated to the image; % actually both widths are reduced a little bit to allow a space -% between the caption and image boxes. But remember: a small -% value of this \meta{fraction} implies a narrow caption. +% between the caption and image boxes. But remember this simple +% rule: a small value of this \meta{fraction} implies a narrow caption. % % Since it is necessary to maintain in separate independent % areas the picture and the caption, and we need to shuffle @@ -3376,9 +3442,9 @@ School of Turin. % used within a a floating environment; a picture, a tabular, % a drawing, a box, any command to place the object in the % correct position within the dedicated space; any argument -% is substantially valid with the caution that this ``anything'' -% remains local to that particular ``image''. In any case when -% the ``mage'' is a real picture and has to be resized to a +% is substantially valid with the caution that this “anything” +% remains local to that particular “image”. In any case when +% the “mage” is a real picture and has to be resized to a % relative dimension, remember that both the picture and its % caption are typeset within boxes narrower than the total text % width or the total environment width; the best way to access @@ -3393,7 +3459,7 @@ School of Turin. %\begin{enumerate} %\item The \oarg{lof entry} optional bracket delimited argument % contains the usual short caption entry for the list of -% figures. +% figures or tables or specific other floats. %\item The \marg{caption} mandatory brace delimited argument % contains the image caption. %\item The \marg{label} mandatory brace delimited argument @@ -3408,7 +3474,7 @@ School of Turin. % string is globally saved into a suitable macro so as to use % it at the right moment. %\end{enumerate} -% Remember: the TOPtesi caption setting differs forme the +% Remember: the TOPtesi caption setting differs from the % standard one and from its redefinitions with other packages % such as the |caption| one. The TOPtesi particular redefinition % tries to adjust the caption with in such a way as to avoid an @@ -3449,7 +3515,7 @@ School of Turin. % explained does not require to be cross referenced. %^^A CONFLITTO CON \CAPTION* DI LONGTABLE? -- CONTROLLARE<<<< ! % \begin{macrocode} -\NewDocumentCommand\captionSD{s O{} m}{% o: optionale fra graffe +\NewDocumentCommand\captionSD{s O{} m}{% O: optional arg. with null default \IfBooleanTF{#1}% {% \@makecaption{}{#3}% @@ -3466,13 +3532,15 @@ School of Turin. % Then the environment |SDbox| is defined by means of the % facilities of the |xparse| package; this allows the use of -% the ``non delimited'' asterisk argument. It also requires other +% the “non delimited” asterisk argument. It also requires other % arguments, the first of which is mandatory and specifies the % contents kind, be it a figure, or a table, or an algorithm, % or anything else that has been introduced with the facilities -% of the |float| package. -% Among the opening the commands we -% deal with the (optional) asterisk dependent box width. +% of the |float| package; \dots\ or nothing, in the sense that +% the float should not be numbered and therefore its caption +% should have no number.. Among the opening commands we deal +% with the (optional) asterisk dependent box width; with the +% asterisk the SD environment protrudes into the external margin. % \begin{macrocode} \DeclareDocumentEnvironment{SDbox}{ G{} s O{0.5} }{%------OPENING \NumberFloattrue @@ -3499,18 +3567,18 @@ School of Turin. % \end{macrocode} % We add some test to verify if the environment is used within % the |figure| floating environment, or it is used ad a fixed -% object; we first est if we are within a floating environment; +% object; we first test if we are within a floating environment; % if not we define |\@captype| to contain the string `figure'; % if yes we have to test if we are really within the |figure| -% environment; if not, we locally define |\@captype|; if yes +% environment: if not, we locally define |\@captype| else % we relax. This means that we can insert the |SDfigure| even % within a |table| environment as sometimes a tabular and a % drawing should float together (may be because a drawing with % its own caption represents the tabular entries). % % And this is all for the opening commands; all these settings -% shall be used by |\SDimage| and |\SDcaption| described in the -% sequel; here we describe the environment closing commands, +% shall be used by |\SDimage| and |\SDcaption| described hereafter; +% here we describe the environment closing commands, % taking into account that the above commands have saved the % \meta{label} string into the |\@tempSD| macro and have set % their image and caption-text respectively into boxes @@ -3518,15 +3586,16 @@ School of Turin. % % The code tests if the saved \meta{label} string is empty; % this should never take place, but it is better to perform -% such task' If the string is empty, a fall back value equal +% such task. If the string is empty, a fall back value equal % to the page number of the page that is still open at % processing time is used; may be a warning message would % be helpful, but since this empty string should never be % empty, it appears as a super luxury feature, that we can % do without. -% But if the string ss not empty, we test if the saved +% +% But if the string is not empty, we test if the saved % |\label| data, possibly read from the |.aux| file on a second -% typesetting run, gas the normal \LaTeX\ structure or the +% typesetting run, has the normal \LaTeX\ structure or the % |hyperref| modified one; the former contains two braced % arguments, while the latter contains five such arguments; % in both cases the interesting page number is the second @@ -3586,9 +3655,9 @@ School of Turin. % % The |\SDcaption| code appears to be strangely complicated; % but it actually performs several actions; the first -% (optional) argument is intended to collect the ``short -% caption'' to be used, if specified, for the list of floats -% entry; if not specified ,as usual, the ``long caption'' +% (optional) argument is intended to collect the “short +% caption” to be used, if specified, for the list of floats +% entry; if not specified ,as usual, the “long caption” % second argument is used for this entry. The (optional) % brace delimited argument, on the contrary, is the label % string that usually is passed as the argument of the @@ -3659,7 +3728,7 @@ School of Turin. % \end{macrocode} % % We call the object to be shown within the |SDbox| with the -% name ``image'' wich can be anything that can be enclosed +% name “image” which can be anything that can be enclosed % in a parbox or a minipage; it can be an actual picture % imported with an |includegraphics| command, it can be a % drawing or a diagram created with the |picture|, or |tikz|, @@ -3675,7 +3744,7 @@ School of Turin. % have both caption and image boxes aligned at the top, we % must be sure that such boxes have their reference points % at their top left corner; due to the heterogeneity of such -% ``images'', we need to lower the image box to have the +% “images”, we need to lower the image box to have the % upper left corner raised with respect to the base line the % amount of a capital `M' in the current font. % \begin{macrocode} @@ -3687,7 +3756,7 @@ School of Turin. } \let\SDtabular\SDimage % \end{macrocode} -% We would not suggest to use a floating or a fixed |SDbox| +% We do not suggest to use a floating or a fixed |SDbox| % environment for all figures, tables or what else; its % use simply depends on the box contents; this environment % may be useful when a normal setting would cause a lot of white @@ -3702,7 +3771,7 @@ School of Turin. % a |\vadjust| element should be inserted so that a page % break takes place after the current line has been typeset. % The command accepts an optional argument that represents -% the maximum number of lines that should be present on +% the maximum number of lines that should be available on % the page in order to issue a |\newpage| command; in other % words if the number of lines available on the page are % less or equal to the optional number, then a |\newpage| @@ -3766,7 +3835,7 @@ School of Turin. \@makefntext{\rule{\z@}{\footnotesep}\ignorespaces#1\strut}}} % \end{macrocode} % -% These last heterogeneous definitions are partly important +% The following last heterogeneous definitions are partly important % and partly residues of the good old times of MS-DOS~v.3 % when a Ctrl-Z character would be placed at the end of files. % It's a long time that such DOS version is not being used, @@ -3786,7 +3855,7 @@ School of Turin. % for example \verb*+$\forall i=0, 1, 2, 3,n$+. The space % before the |n| is not necessary (but it wouldn't hurt) % because |n| is not recognised as a digit, therefore the -% ``intelligent'' comma inserts the necessary space by itself. +% “intelligent” comma inserts the necessary space by itself. % % \begin{macrocode} \DeclareMathSymbol{\virgola}{\mathpunct}{letters}{"3B} @@ -3808,7 +3877,7 @@ School of Turin. % The infix strings that start these sections depend on the % used language. % -% Because of this it is necessary to extend the list of infix +% Because of this, it is necessary to extend the list of infix % string definitions provided by the |\captions|\meta{language} % macros defined by the \texttt{babel} or \texttt{polyglossia} % language description files; for this purpose we define @@ -3925,8 +3994,8 @@ Skipping any redefinition\MessageBreak}% % \texttt{topcoman} and \texttt{topfront} are requested % for input; the latter is loaded only when the % |documentclass| option |noTOPfront| has NOT been declared. -% This action, therefore has to be delayed till the ``begin -% document'' step, in order to be sure that other packages +% This action, therefore has to be delayed till the “begin +% document” step, in order to be sure that other packages % have possibly been loaded to typeset the title page, and/or % other packages have been loaded to properly use the units % of measure. This delayed loading implies that the @@ -3935,7 +4004,7 @@ Skipping any redefinition\MessageBreak}% % option implies that the title page is typeset with its % special commands and environments, therefore it sets the % suitable switches so as to avoid loading the |topfront| -% extension file. This applies also to the other modules particular to special kinds of thesis. +% extension file. This applies also to the other modules particular to special thesis types. % \begin{macrocode} \AtBeginDocument{% \unless\ifT@Pfrontespizio\ifTOPfront @@ -4023,16 +4092,16 @@ Skipping any redefinition\MessageBreak}% % strings. % % The singular and plural masculine and feminine strings -% for ``candidate'' are redefined in the |topfront| module. +% for “candidate” are redefined in the |topfront| module. % For other languages the configuration file is very handy. % % Since theses in humanities may end up to occupy several -% volumes\footnote{Classically ``tomo'' in Italian means ``volume'', +% volumes\footnote{Classically “tomo” in Italian means “volume”, % although the latter word is valid also in Italian with % the same meaning but appears to be neglected by the -% humanists; in English ``tome'' indicates a ``large book''; -% in Italian the meaning nuance of ``tomo'' is a little -% different because it is used to indicate the volumes into +% humanists; in English “tome” indicates a “large book”; +% in Italian the meaning nuance of “tomo” is a little +% different because it is used to indicate each of the volumes into % which a large printed work is divided; the humanists, as % usual, know well their words and use them properly!} a % mechanism is set up to create a different title page for @@ -4053,8 +4122,8 @@ Skipping any redefinition\MessageBreak}% % \end{macrocode} % Folios as well are to be redefined and also the page styles % require a redefinition so as to being able to use old style -% numbers. The macro |\lapagina| (it's not a case the this -% macro name is the direct translation of ``thepage'') +% numbers. The macro |\lapagina| (it's not a case that this +% macro name is the direct translation of “thepage”) % contains the folio number; if it is in roman numerals % nothing happens, but if the old style numbers are required % the folio is surrounded by the proper macros so as to expand @@ -4084,11 +4153,11 @@ Skipping any redefinition\MessageBreak}% % (short) title; if this option is not in force, headings % appear as usual. The redefinition of the \texttt{headings} % page style is made only if this option is in force. In case -% of two-side printing where the left head and the right +% of two-sided printing where the left head and the right % heads are different, the left heading contains the author % name and the short title name; if there are other authors -% the first author name is printed followed by ``et al.''; -% if the over all header string exceeds the text width, a +% the first author name is printed followed by “et al.”; +% if the overall header string exceeds the text width, a % message is printed so as to suggest the user to % use the optional |\titolo| argument, the one that is % supposed to contain the short title. In the right heading @@ -4097,7 +4166,7 @@ Skipping any redefinition\MessageBreak}% % % More complicated things are done when typesetting on one % side; in facts the author name (possibly followed by -% ``et al.'') and the short thesis title are typeset on the +% “et al.”) and the short thesis title are typeset on the % left of the only header while the chapter title is typeset % on the right; in the unlikely situation where these two % elements separated by at least 2em of white space do not @@ -4105,7 +4174,7 @@ Skipping any redefinition\MessageBreak}% % as it is likely to happen, then my suggestion would be not % to use the \opz{autoretitolo} option; but if the user % absolutely wants this layout, then the author's name, -% possibly followed by ``et al.'', and the short thesis title +% possibly followed by “et al.”, and the short thesis title % are set in a vertical box; the same happens for the % chapter title in another box; these texts are set with % ragged margins, and eventually these boxes are set one @@ -4272,7 +4341,7 @@ Skipping any redefinition\MessageBreak}% % extension module with (hopefully) any document class. % % It contains all the definition for the composition of just -% the title page od ``standard'' theses along the style +% the title page of “standard” theses along the style % requirements of \texttt{toptesi}, version 5.x or higher. It is not % loaded by |toptesi| even when typesetting the title page % for theses made according the requirements of the ScuDo @@ -4304,7 +4373,7 @@ Skipping any redefinition\MessageBreak}% % since this test is defined in the |toptesi| class, % here we need to verify its existence and, in case, to set % its value to |false|. This implies two points: we need a -% powerful macro package to test a ``switch'', and, when this +% powerful macro package to test a “switch”, and, when this % |topfront| module is used as a stand-alone one, the settings % of the \opz{classica} options are not available. This requires % to define switches and counters, besides options for this @@ -4316,6 +4385,7 @@ Skipping any redefinition\MessageBreak}% \@ifpackageloaded{etoolbox}{}{\RequirePackage{etoolbox}} \@ifpackageloaded{xspace}{}{\RequirePackage{xspace}} \@ifpackageloaded{xparse}{}{\RequirePackage{xparse}} + \ifcsundef{ifclassica}{\newif\ifclassica \classicafalse}{} \ifcsundef{if@utoretitolo}{\newif\if@utoretitolo\@utoretitolofalse}{} \ifcsundef{if@ldstyle}{\newif\if@ldstyle\@ldstylefalse}{} @@ -4328,12 +4398,12 @@ Skipping any redefinition\MessageBreak}% \ifcsundef{ifdottorale}{\newif\ifdottorale\dottoralefalse}{} \ifcsundef{ifsecondaria}{\newif\ifsecondaria\secondariafalse}{} \ifcsundef{ifplurale}{\newif\ifplurale\pluralefalse}{} -%\ifcsundef{iffrontspizio}{\newif\iffrontespizio\frontespiziofalse}{} -%\ifcsundef{}{\newif false}{} \ifcsundef{ifTOPfront}{\newif\ifTOPfront \TOPfronttrue \newif\ifevenboxes \evenboxesfalse}{} + \ifcsundef{c@tomo}{\newcounter{tomo}}{} + \DeclareOption{evenboxes}{\evenboxestrue} \DeclareOption{cucitura}{\@bindingtrue} \DeclareOption{14pt}{\@xivpttrue} @@ -4378,7 +4448,8 @@ Skipping any redefinition\MessageBreak}% } \fi\par \ifcsvoid{@ateneo}{}{% - \hbox to\textwidth{\hss\LARGE\rule[-1ex]{0pt}{3.3ex}\MakeUppercase{\@ateneo}\hss}} + \hbox to\textwidth{\hss\LARGE\rule[-1ex]{0pt}{3.3ex}% + \MakeUppercase{\@ateneo}\hss}} \vss }% }% @@ -4387,7 +4458,7 @@ Skipping any redefinition\MessageBreak}% } % \end{macrocode} % -% Similarly a different title page style for typesetting +% Similarly a different title page style for typesetting % the logos in the lower half of the page is defined; since % it is the only style usable with the \opz{classica} option, we % call it the |classica| page style: @@ -4417,7 +4488,7 @@ Skipping any redefinition\MessageBreak}% }% % \end{macrocode} % -% The title page information depends on the type of ``thesis'' +% The title page information depends on the type of “thesis” % that is being typeset. The following commands specify the % kind of information that is going to be typeset. Some boolean % variables are automatically set by the commands in order @@ -4429,7 +4500,7 @@ Skipping any redefinition\MessageBreak}% % particular when there is a multitude of authors (maximum % three) of different gender, the adjectives or qualifications % are set as masculine plural names, while when there is just -% one autho0.79549875r or the authors are of the same gender the +% one author or the authors are of the same gender the % adjectives or qualifications are set according to number % and gender. All this is done by setting or resetting the % truth value associated to the boolean variable @@ -4465,7 +4536,7 @@ Skipping any redefinition\MessageBreak}% % still be inconsistent if the commands are given in the % wrong order. % -% |\titolo| accepts an optional argument, the ``short title'', +% |\titolo| accepts an optional argument, the “short title”, % more or less as the standard sectioning commands; this is % due to the fact that with the class option \opz{autoretitolo} % the thesis title is written together with the author's @@ -4523,15 +4594,15 @@ Skipping any redefinition\MessageBreak}% % Things get more complicated for doctoral theses; in general % there is no supervisor; at most if a professor is assigned to supervise or control the PhD student's work this may be called % in whatever mode but here we assume his name is input -% with the command |\tutore| even if ``tutor'' does not appear -% as the best choice; in any case in Italian ``tutore'' does -% not have the same meaning as the English ``tutor''. +% with the command |\tutore| even if “tutor” does not appear +% as the best choice; in any case in Italian “tutore” does +% not have the same meaning as the English word “tutor”. % % Most Doctoral Schools require to name the School's director % or coordinator instead of the tutor. This is why this % person's name can be introduced with |\direttore| or % |\coordinatore|; the actual label printed over this person -% name is ``Direttore'' or ``Coordinatore'' but it can be +% name is “Direttore” or “Coordinatore” but it can be % changed with |\QualificaDirettore|. % \begin{macrocode} \newif\ifDirettore \Direttorefalse @@ -4541,7 +4612,7 @@ Skipping any redefinition\MessageBreak}% \def\QualificaDirettore#1{\gdef\@PhDdirector{#1}}% % \end{macrocode} % -% For ``normal'' theses we may have from one to three +% For “normal” theses we may have from one to three % supervisors and from one to three authors; not all % universities accept a multitude of supervisors and/or % authors of the same thesis, but some do; this is why @@ -4551,7 +4622,7 @@ Skipping any redefinition\MessageBreak}% % there are different commands to input ladies or gentlemen % names; according to the masculine (ending in `o') % or feminine (ending in `a') commands, the appropriate -% truth values are assigned to the boolean variable +% true or false values are assigned to the boolean variable % \texttt{femminile} and the labels are set accordingly. % % Notice that in the case of bachelor degree final report @@ -4566,16 +4637,16 @@ Skipping any redefinition\MessageBreak}% \def\terzorelatore#1{\gdef\@thirdadviser{#1}} % \end{macrocode} % -% The next set of macros is used to typeset the ``date'' of +% The next set of macros is used to typeset the “date” of % the thesis defence or presentation or whatever is done % for the final exam. The macro is sort of complicated -% because the input format for this ``date'' may vary from +% because the input format for this “date” may vary from % a single year, to a year range, to a month and year % specification so that different actions must be taken; -% if the option \texttt{classica} is in force then the -% formatting of the ``date'' may be still different. +% if the option \texttt{classica} is in force, then the +% formatting of the “date” may be still different. % This command is aliased with |\esamendidottorato| -% which literally means ``defence of the doctoral dissertation''; +% which literally means “defence of the doctoral dissertation”; % nevertheless both commands refer to a simple date % in one of those formats. % @@ -4640,8 +4711,8 @@ Skipping any redefinition\MessageBreak}% \def\s@paranumeri#1-#2!{\def\1{#1}\def\2{#2}}% \let\esamedidottorato\sedutadilaurea % \end{macrocode} -% Here |\annoaccademico| is defined to typesets the infix -% string corresponding to ``Anno accademico'' followed by +% Here |\annoaccademico| is defined to typeset the infix +% string corresponding to “Anno accademico” followed by % the year range in old style numbers (irrespective of the % \texttt{oldstyle} option); localisation commands are % provided so as to set a different string, possibly @@ -4656,7 +4727,7 @@ Skipping any redefinition\MessageBreak}% % special format is chosen. Therefore the user has to use % only one of these two commands, and if s/he uses % |\annoaccademico| while the |classica| option is not -% in force, s/he gets an warning and the ``date'' gets +% in force, s/he gets an warning and the “date” gets % formatted in a special way so as to remember the user % that |\annoaccademico| requires the |classica| option. % \begin{macrocode} @@ -4685,11 +4756,11 @@ Skipping any redefinition\MessageBreak}% % literal information to be typeset in the title page. % |\ciclodidottorato| requires an uppercase roman numeral % (in Italy), but it can accept anything that can precede -% the infix word ``cycle''. +% the infix word “cycle”. % Macros |\corsodilaurea| and |\corsodidottorato| specify % the degree course qualification; you would specify just -% ``Elettronica'', for example, and the module will write -% in the title page ``Corso di Laurea in Elettronica''. +% “Elettronica”, for example, and the module will write +% in the title page “Corso di Laurea in Elettronica”. % The infix part may be changed depending on the default % language and the configuration file. % @@ -4699,20 +4770,20 @@ Skipping any redefinition\MessageBreak}% % In Italy Universities are generally named after the city they % are in; in large cities where there are several % universities, each one of them has a proper name. -% For example the generic name might be ``Universit\`a di -% Roma'' and the proper name might be ``La Sapienza''. +% For example the generic name might be “Universit\`a di +% Roma” and the proper name might be “La Sapienza”. % % |\facolta| may receive an optional argument that is the % uppercase roman numeral specific of the faculty and % a compulsory argument that corresponds to the type of % faculty; for example, with |\facolta[II]{Ingegneria}| -% the package typesets in the title page ``II Facolt\`a di -% Ingegneria''; if the optional argument is not specified, +% the package typesets in the title page “II Facolt\`a di +% Ingegneria”; if the optional argument is not specified, % no roman numeral is typeset; the infix string % \verb*+Facolt\`a di + may be changed with the configuration % file depending on the default language. % It might be necessary to define another name in place of -% ``Facolt\`a di\textvisiblespace'', since with recent bills, +% “Facolt\`a di\textvisiblespace”, since with recent bills, % the administrative structure of all Italian universities % has been changed and the activities formally assigned % to the Faculties may be now the responsibility of other @@ -4770,7 +4841,7 @@ Skipping any redefinition\MessageBreak}% % The analysis and processing to the possible list of logo % file names is done through the usual means of the delimited % argument extraction of the single names from the list; -% the ``string'' of logos is then composed in a save box; +% the “string” of logos is then composed in a save box; % as the list has been completely processed, the box is % measured; if its width is shorter than the |\textwidth| % it is typeset without further processing; if it is larger, @@ -4845,35 +4916,35 @@ Skipping any redefinition\MessageBreak}% % commands can be put in the configuration file so as % to specify what is desired as a default. % If these commands are specifically used to redefine -% something before issuing the |\frontespizio| command, -% the command that actually typesets the title -% page, the new definitions override the configuration ones. +% something before issuing the |\frontespizio| command +% or one of the title page environments, the new definitions +% override the configuration ones. % % \begin{description}[noitemsep] % \def\Item[#1]{\item[\normalfont\texttt{\char92#1}] % sets or changes the string} -% \Item[FacoltaDi] ``Facolt\`a di'' in, say, ``Faculty of'' -% \Item[DottoratoIn] ``Dottorato in'' in, say, ``PhD in'' -% \Item[CorsoDiLaureaIn] ``Corso di Laurea in'' in, say, -% ``Master of Science in'' -% \Item[TesiDiLaurea] ``Tesi di Laurea'' in, say, -% ``Tesi di Laurea Magistrale'' -% \Item[NomeMonografia] ``Monografia di Laurea'' in, say, -% ``Tesi di Laurea'' -% \Item[NomeDissertazione] ``Dissertazione'' in, say, -% ``PhD dissertation'' -% \Item[InName] ``in'' in, say, ``auf'' -% \Item[CandidateName] ``Candidato'' in, say, ``Laureando'' -% \Item[AdvisorName] ``Relatore'' in, say, ``Supervisors'' -% \Item[CoAdvisorName] ``Correlatore'' in, say, ``Corapporteur'' -% \Item[NomeTutoreAziendale] ``Supervisore aziendale'' in, say, -% ``XYZ Company Supervisor'' -% \Item[TutorName] ``Tutore'' in, say, ``Supervisor'' -% \Item[CycleName] ``ciclo'' in, say, ``cycle'' -% \Item[NomePrimoTomo] ``Tomo primo'' in, say, ``First volume'' -% \Item[NomeSecondoTomo] ``Tomo secondo'' in, say, ``Second volume'' -% \Item[NomeTerzoTomo] ``Tomo terzo'' in, say, ``Third volume'' -% \Item[NomeQuartoTomo] ``Tomo quarto'' in, say, ``Fourth volume'' +% \Item[FacoltaDi] “Facolt\`a di” in, say, “Faculty of” +% \Item[DottoratoIn] “Dottorato in” in, say, “PhD in” +% \Item[CorsoDiLaureaIn] “Corso di Laurea in” in, say, +% “Master of Science in” +% \Item[TesiDiLaurea] “Tesi di Laurea” in, say, +% “Tesi di Laurea Magistrale” +% \Item[NomeMonografia] “Monografia di Laurea” in, say, +% “Tesi di Laurea” +% \Item[NomeDissertazione] “Dissertazione” in, say, +% “PhD dissertation” +% \Item[InName] “in” in, say, “auf” +% \Item[CandidateName] “Candidato” in, say, “Laureando” +% \Item[AdvisorName] “Relatore” in, say, “Supervisors” +% \Item[CoAdvisorName] “Correlatore” in, say, “Corapporteur” +% \Item[NomeTutoreAziendale] “Supervisore aziendale” in, say, +% “XYZ Company Supervisor” +% \Item[TutorName] “Tutore” in, say, “Supervisor” +% \Item[CycleName] “ciclo” in, say, “cycle” +% \Item[NomePrimoTomo] “Tomo primo” in, say, “First volume” +% \Item[NomeSecondoTomo] “Tomo secondo” in, say, “Second volume” +% \Item[NomeTerzoTomo] “Tomo terzo” in, say, “Third volume” +% \Item[NomeQuartoTomo] “Tomo quarto” in, say, “Fourth volume” % \end{description} % In the above description the first string is generally % the default one, while the second string is just an example @@ -4909,11 +4980,11 @@ Skipping any redefinition\MessageBreak}% % configuration file must not be redefined in the following % Lines and this is why everything is subject to the test % |\@ifundefined|. Most default definitions are simply -% ``blank''; the others are in Italian. All of them, except +% “blank”; the others are in Italian. All of them, except % the supervisor and candidate strings may be individually % redefined in the configuration file or in the preamble. % Those that cannot be redefined such as the four -% ``candidate'' strings may be actually redefined through +% “candidate” strings may be actually redefined through % the single |\CandidateName| that should be used in a % language depended way and with the correct number and % gender once for all. @@ -5004,18 +5075,20 @@ Skipping any redefinition\MessageBreak}% % The infix word for the |classica| option are redefined. % \begin{macrocode} \ifTOPfront -\ifclassica -\def\Candidato{Laureando} -\def\Candidata{Laureanda} -\def\Candidati{Laureandi} -\def\Candidate{Laureande} -\fi\fi + \ifclassica + \def\Candidato{Laureando} + \def\Candidata{Laureanda} + \def\Candidati{Laureandi} + \def\Candidate{Laureande} + \fi +\fi % \end{macrocode} -% If the final exam date is not given the default value is +% If the final exam date is not given, the default value is % the current month and the current year typeset in Italian; % therefore the user is strongly requested to enter a date % either with the |\sedutadilaurea| or the |\esamedidottorato| -% commands. The default value of the university logo command has already been defined ``empty''. +% commands. The default value of the university logo command has +% already been defined “empty”. % \begin{macrocode} \@ifundefined{@submitdate}{\def\@submitdate{\ifcase\the\month\or% Gennaio\or Febbraio\or Marzo\or Aprile\or Maggio\or Giugno\or @@ -5040,9 +5113,9 @@ Skipping any redefinition\MessageBreak}% % still usable. The principle on which these environments % work is that the |frontespizio| environment typesets the % title page with logo(s) set in the page header, while the -% |frontspizio*| environment typesets the logos after the +% |frontespizio*| environment typesets the logos after the % information on the title, the possible sub title and tome -% information, that is in the lower half of the title page. +% information, i.e.\ in the lower half of the title page. % In order to achieve this result each environment sets the % boolean variable |topTPTlogos| to either value |true| % (for header logos) or |false| (otherwise). @@ -5060,14 +5133,14 @@ Skipping any redefinition\MessageBreak}% % closing the last opened environment. % % If the |\frontespizio| command is directly used, the -% |\@currenvir| macro does not contain the name ``frontespizio''; +% |\@currenvir| macro does not contain the name “frontespizio”; % therefore if in the opening environment definition we check % the contents of |\@currenvir| against the string % |frontespizio| we can decide if the user resorted to % the legacy command, or the environment was correctly % opened by means of |\begin|. % If the user resorted to the legacy command, the -% service macro |\fr@ontespizio| is called that typesets +% service macro |\fr@ntespizio| is called that typesets % the title page according to the current status of the % boolean |topTPTlogos|, a boolean that has a default % value but the user can set at its will. Otherwise the @@ -5115,7 +5188,7 @@ Skipping any redefinition\MessageBreak}% % environment, we have to behave as with the |\frontespizio| % command, but we must test for a possible asterisk following % the command; for this reason we defined the |\TPTmaybestar| -% that% absorbs une following token: if the token is an +% that% absorbs one following token: if the token is an % asterisk, we set the appropriate settings for the previous % behaviour of the isolated command, but if it is % not an asterisk we must set it back into the list after @@ -5163,8 +5236,8 @@ Skipping any redefinition\MessageBreak}% % Depending on the style of the title page a different % |\pagestyle| is set with appropriate switches and settings. % If with the classica style a university name is blank, -% it is set to an explicit string that the setting of the -% university name has been forgotten. +% it is set to an explicit string equivalent to “The +% university name is missing”. % \begin{macrocode} \ifclassica \boolfalse{topTPTlogos} @@ -5231,9 +5304,9 @@ Skipping any redefinition\MessageBreak}% % \end{macrocode} % Further specification: it inserts the field of the PhD % research or the degree course name; it inserts a line -% such as, for example, ``Philosophy Degree in Applied -% Tetratricotomy~--~XVI~cycle'' or ``Master of Science -% in Applied Tetratricotomy''. +% such as, for example, “Philosophy Degree in Applied +% Tetratricotomy~--~XVI~cycle” or “Master of Science +% in Applied Tetratricotomy”. % \begin{macrocode} \ifcsvoid{@corso}{}{{\large \ifdottorato @@ -5245,8 +5318,8 @@ Skipping any redefinition\MessageBreak}% \par}} \end{center} % \end{macrocode} -% It now centres the name of the report, be it ``Doctoral -% Dissertation'' or ``Master Thesis'' or whatever; in case +% It now centres the name of the report, be it “Doctoral +% Dissertation” or “Master Thesis” or whatever; in case % the command |\materia| was used, it then centres the % discipline which the thesis deals with. % \begin{macrocode} @@ -5291,7 +5364,7 @@ Skipping any redefinition\MessageBreak}% % command may be given at the beginning of every volume and the % counter \texttt{tomo} is stepped up; the volume number % is therefore printed in each title page; the infix string -% may be redefined as it was shown above. +% may be redefined as it was shown above. % \begin{macrocode} \ifclassica \ifnum\value{tomo}>\z@ @@ -5316,16 +5389,15 @@ Skipping any redefinition\MessageBreak}% \par % \end{macrocode} % Going down in the title page, now comes the optional -% insertion of the university logo(s); ``optional'' in both +% insertion of the university logo(s); “optional” in both % meanings: one or more university logos are not generally % required in a thesis, and in case it depends if the % logo(s) have to be put in the header or here. % This is a simple task since the |\logosede| already % defined the contents to the box |\TPT@logobox|, and this -% was done either with an explicit command |\logosede| -% with its argument in the preamble, or with a specific -% line in the configuration file or within the |frontespizio| -% environment. +% was done either with the explicit command |\logosede| +% with its argument in a specific line of the configuration +% file or within the |frontespizio| environment. % If such box |\TPT@logobox| is void, the already defined % |\printloghi| macro does not do anything. % \begin{macrocode} @@ -5362,7 +5434,7 @@ Skipping any redefinition\MessageBreak}% % \end{macrocode} % Similarly the label names for the exam candidates are % chosen; in Italian such names are infix strings that are -% selected according the gender and the number; if these +% selected according to the gender and the number; if these % labels have to be set in a different language it is % necessary to define one string that has to be selected % by the user according to number and gender. @@ -5387,7 +5459,7 @@ Skipping any redefinition\MessageBreak}% \fi % \end{macrocode} % -% For the supervisor(s) and of the candidate(s) name(s) +% For the supervisor(s) and the candidate(s) name(s) % a different approach is used for each one of the three % categories of theses. If a bachelor degree % report is dealt with, the name of the \emph{single} @@ -5400,7 +5472,7 @@ Skipping any redefinition\MessageBreak}% % \end{macrocode} % For doctoral and master theses two virtual boxes % (actually macros) are filled up so as to align the -% supervisor name(s) and, in a second virtual box, +% supervisor name(s) and, respectively, % the candidate name(s). The label is set in the first % line with proper number and gender; in the second line % the first name, and in the subsequent lines, @@ -5424,15 +5496,13 @@ Skipping any redefinition\MessageBreak}% % The optional argument contains the ID number of the candidate; % if it is specified, it is typeset below the candidate name, % with an indentation, and prefixed with the \verb*|matricola | -% label; of corse if the optional ID number is not specified, -% nor are the enclosing braces, nothing is printed after or +% label; of course if the optional ID number (and the enclosing +% brackets) is not specified, nothing is printed after or % below the candidate's name. -% If the user wants it typeset on the same line and or -% with a different label s/he has to redefine the macro |\IDlabel|; -% its default definition is -%\begin{verbatim*} -%\newcommand*\IDlabel{\\\quad matricola\ } -%\end{verbatim*} +% If the user wants it typeset on the same line and or with a +% different label s/he has to redefine the macro |\IDlabel| by +% means of the \cs{ID} macro described in previous sections; +% % Example redefinitions are shown in the sample files. % Notice that with the new definition of the candidates' setting % macros it is guaranteed that the ID number, if specified, is @@ -5446,7 +5516,8 @@ Skipping any redefinition\MessageBreak}% % % \begin{macrocode} \else -% For theses of any kind that expect the supervisor and co-supervisor names... +% For theses of any kind that expect the supervisor and co-supervisor +% names: \def\BoxRelatori{% \begin{tabular}[t]{l}% \hbox{\ifclassica\else\large\fi @@ -5599,7 +5670,8 @@ Skipping any redefinition\MessageBreak}% % copyright and disclaimer sentence on its verso page. % % It produces also a colophon where some data concerning -% the thesis typesetting details are given. +% the thesis typesetting details are given. This colophon +% is saved and used on the last even page of the complete thesis. % % Some if not all the data required for the title page may % be entered by means of a configuration file |\jobname.cfg| @@ -5612,8 +5684,8 @@ Skipping any redefinition\MessageBreak}% % % This |toptesi-scudo.sty| module is meant to load a certain % number of packages in order to ease the user work when -% typesetting a dissertation on an engineering doctorate -% school as ScuDo. +% typesetting a dissertation in an engineering doctorate +% school such as ScuDo. % % The chosen packages are supposed to be sufficient to % typeset any technical thesis or dissertation; but this @@ -5630,11 +5702,11 @@ Skipping any redefinition\MessageBreak}% %\fi % We start by loading the math packages produced by the % American Mathematical Society, differentiating what is -% necessary to load when using \pdfLaTeX\ or the OpenType -% aware programs \XeLaTeX\ or \LuaLaTeX. The extension file -% |iftex| that defines the switches \cs{ifPDFTeX}, -% \cs{ifXeTeX}, and \cs{ifLuaTeX}, -% has already been loaded. In particular AMS fonts should +% necessary to load when using \pdfLaTeX\ or the +% OpenType-aware programs \XeLaTeX\ or \LuaLaTeX. +% The extension file |iftex| that defines the switches +% \cs{ifPDFTeX},, \cs{ifXeTeX}, and \cs{ifLuaTeX}, +% has already been loaded. The AMS fonts should % not be used when typesetting with \XeLaTeX\ or \LuaLaTeX, % because these programs get them directly from the % \sigla{UNICODE} math fonts, so that package |amssymb| has @@ -5661,38 +5733,69 @@ Skipping any redefinition\MessageBreak}% % \end{macrocode} % Such a definition allows to typeset math expression containing % integrals with a small space between the integrand and the -% integrating differential; on the contrary no space -% disturbs typesetting differential equations. The above +% integrating differential; on the contrary the leading space does +% not disturb typesetting differential equations. The above % definitions include also the \sigla{ISO} compliant ways of writing % the Napier number `e', and the imaginary unit |\iu| that % sets an operator-like roman `j' as it is customary in -% most engineering disciplines. +% most engineering disciplines. The alias |\iu| to the |\gei| +% command may be redefined if the PhD student wants to use for +% example ‘i’; the example file \texttt{toptesi-scudo-example.tex} +% uses the Greek ‘iota’ and specifies that this use is \emph{wrong}! +% +% Next an option is defined, |mybibliostyle| which allows the user to +% establish his own style for the bibliography. By default the +% |toptesi-scudo| module loads |biblatex| with a set of options that +% allow numerical listing and numerical citation according to the IEEE +% standards for its Transaction. PhD students doing their theses in +% other scientific domains may use different styles for bibliographics +% listings and citation methods. By setting this option |mybibliostyle| +% among the class ones, it is automatically treated as a global option +% so that it is passed on to the called packages; in particular this +% option reaches this |toptesi-scudo| module, that has the following +% definition and handling lines: +% \begin{macrocode} + +\ifcsundef{ifmybibstyle}{\newif\ifmybibstyle\mybibstylefalse}{} +\DeclareOption{mybibliostyle}{\mybibstyletrue} +\ProcessOptions*\relax + +% \end{macrocode} +% The switch |mybibstyle| is used below when the |biblatex| +% package is possibly loaded. Actually when this option is active +% (i.e. when this switch is `true') nothing is loaded, and the user +% is free to load the packages s/he likes best in order to handle the +% bibliographic databases and to typeset one or more bibliographies +% with different styles. Since in the other thesis types nothing +% is preloaded for customising the user's bibliography, the user +% does not need to specify the above |mybibliostyle| option, and +% can proceed loading his/her preferred packages for bibliographic +% styles. With the other thesis types if the user specifies this option, +% nothing is done and it remains in the list of ‘unused options’. % -% Other packages are loaded next. Please take notice that +% Some other packages are loaded next. Please take notice that % |xparse| is very useful to define advanced commands and % environments containing different kind of delimited % arguments; parameters entered as arguments to the % opening statement of an environment are available also % for the closing commands; read the documentation if you -% want to use this package facilities. The loading command is -% commented out, because as long as this module is used with the -% |toptesi| class, this package is already available. The -% commented line remains there to remember that this module -% has this dependence; should this module be used with another -% class, the user is reminded to expressly load it. +% want to use this package facilities. Since this package is +% already loaded by the |toptesi| class, a test is performed +% as to avoid reloading; but if this module is used independently +% from the |toptesi| class, the package is actually loaded. % % Using the facilities of |setspace| may be tolerated only % while typesetting a thesis draft. It is bad typography -% to use it in the final printing. +% to use its facilities when doing the thesis final printing. % % Packages |ifthen| and |calc|, in spite of being the % standard traditional ones for accomplishing their tasks, % are preferred by many users who are not aware that % computations are now native of modern typesetting -% programs\footnote{All the three programs we are dealing -% with here; \LuaLaTeX\ can do also floating point computations +% programs\footnote{All the three typesetting programs we are dealing +% with here. \LuaLaTeX\ can do also floating point computations % thanks to the language Lua; all programs may benefit from the -% advances of the \LaTeX3 language, that has a special facility +% advances of the \LaTeX3 language, that has a special facilities % to perform floating point calculations.}; also advanced % tests are natively available with such programs, but % since this class loads the |etooolbox|, its powerful @@ -5702,11 +5805,11 @@ Skipping any redefinition\MessageBreak}% % % Packages |caption| and |subcaption| have been optional % for several TOPtesi versions before version 6.x; here they -% are pre-loaded only for the \textsf{tipotesi=scudo} option. +% are pre-loaded only with the \textsf{tipotesi=scudo} option. % % Package |tabularx| provides an alternative way to produce % tables of specified width by means of a new column type -% |X|; this column type behaves as |p|\marg{width}, where +% |X|; this column type behaves as |p|\marg{width}, where % \meta{width} is computed by the package in order to expand % the column(s) so as to fill the specified table % width. It is very handy in a number of situations. @@ -5715,10 +5818,10 @@ Skipping any redefinition\MessageBreak}% % is highly recommended; we load also package |multirow|, % although its use is deprecated by many professionals. % -% The sample template file |toptesi-scudo.tex| shows a +% The sample template file |toptesi-scudo-example.tex| shows a % couple of tables typeset with and without using % |multirow|; the results without using this package are -% marginally more elegant, but the user is free to specify +% marginally more elegant, but the user is more free to specify % every detail, without the support of automatic (and % limited) typesetting macros. % @@ -5734,7 +5837,8 @@ Skipping any redefinition\MessageBreak}% % especially while using this TOPtesi class, where % provisions for large floats are already taken care of. % \begin{macrocode} -%\RequirePackage{xparse} % Command and environment advanced definitions +\@ifpackageloaded{xparse}{}{% + \RequirePackage{xparse}}% Command and environment advanced definitions \RequirePackage{lscape} % Supports landscape Layout \RequirePackage{setspace} % Define line spacing in paragraph. Don't use! \RequirePackage{calc} % Calculation macros @@ -5743,15 +5847,13 @@ Skipping any redefinition\MessageBreak}% \RequirePackage{subcaption}% Defines env. subfigure and its caption \RequirePackage{tabularx} % Tables with expandable columns \RequirePackage{booktabs} % professional rules in tables -\RequirePackage{multirow} % It's more professional avoiding tables with - % cells spanning several rows +\RequirePackage{multirow} % Multirow cells are not professional \RequirePackage{siunitx} % advanced management of units of measure -\RequirePackage{float} % Never ever use its code position H ! - % Use only to define new floating objects +\RequirePackage{float} % Use only to define new floating objects! % \end{macrocode} % % Package |nomencl| is loaded and a sample of nomenclature -% groups is defined; they are mostly examples of ``how to''; +% groups is defined; they are mostly examples of “how to”; % and in particular they are models to define other % nomenclature groups. Notice that the string comparison % tests are made through the testing robust commands @@ -5785,7 +5887,7 @@ Skipping any redefinition\MessageBreak}% %\par} % Afterwards you should have your processed nomenclature % ready and up to date, so that by running again the -% typesetting program your nomenclature appears in the +% typesetting program your nomenclature appears in the % back matter; a second typesetting run, as usual, updates % the table of contents with the entry and page number of % the Nomenclature section. It is important to do this @@ -5799,7 +5901,9 @@ Skipping any redefinition\MessageBreak}% % procede by closing the auxiliary file that collect % nomenclature entries, and run \prog{makeindex} with % the proper options and file names directly through the -% ``magic command'' |\write18|. We then define a new command +% “magic command” |\write18|. +% +% We then define a new command % to process the nomenclature files and print them out. % % Again the test for an empty optional argument is made by @@ -5829,24 +5933,39 @@ Skipping any redefinition\MessageBreak}% % The result is a synchronous typesetting of the nomenclature % in the same way as for the index. % -% The bibliography is typeset through the facilities of +% The bibliography by default is typeset through the facilities of % package |biblatex| with suitable options; in particular, -% according to the tradition in scientific works, the +% according to the tradition in scientific works, in particular +% of the IEEE standards for its Transactions, the % references are labelled with bracketed numbers as well -% as citations. -% \begin{macrocode} -\usepackage[autostyle]{csquotes} % necessary for biblatex -\usepackage[backend=biber, - style=numeric-comp, - citestyle=numeric, - sorting=nty, - natbib]{biblatex} % LaTeX specific bibliography handler -\addbibresource{references.bib}% bibliographic data base(s} +% as citations. Nevertheless some PhD students working in other +% scientific domains ask for different styles for using |BiBTeX| +% compatible bibliographies to be run also with |pdflatex|, or +% bibliographies styled in a more humanistic way. +% In this case they should specify the specific option |mybibliostyle| +% to the |toptesi| class, and the following code will not be loaded, +% since the switch |mybibstyle| is set to `true' only when using +% such an option. Therefore if the user uses the above option, the code +% loads neither |biblatex| with its options, nor |csquotes|; furthermore +% the bibliographic database remains unspecified. It is the user +% responsibility to insert in his/her thesis preamble whatever necessary +% to typeset his/her bibliography or bibliographies the way s/he prefers. +% +% \begin{macrocode} +\unless\ifmybibstyle + \usepackage[autostyle]{csquotes} % necessary for biblatex + \usepackage[backend=biber, + style=numeric-comp, + citestyle=numeric, + sorting=nty, + natbib]{biblatex} % LaTeX specific bibliography handler + \addbibresource{references.bib}% bibliographic data base(s} +\fi % \end{macrocode} % % Package |imakeidx| is loaded, but it is up to the user % to specify command \texttt{\string\makeindex} with its -% options; in the sample template file |toptesi-scudo.tex| +% options; in the sample template file |toptesi-scudo-example.tex| % the index is made by configuring \cs{makeindex} % by specifying only the \textsf{intoc} option, so as to % have an entry for the index in the table of contents. @@ -5917,7 +6036,7 @@ security of personal data.} % data may be changed, but don't need to be changed: it % depends on the university specifications, if any are given. % -% In any case if the ``examiner list'' is not specified, so +% In any case if the “examiner list” is not specified, so % that the default list remains empty, no label and no list % is typeset; therefore leaving this list empty is an easy % and logical method for completely omitting such a list. @@ -5970,11 +6089,18 @@ security of personal data.} % macros, the name of the person who undersigns the disclaimer % text is assumed to be the thesis author and the signature % date is assumed to equal the examination date. +% The \cs{Signature} macro is intended to modify the signature layout +% contained in the internal macro \cs{@signature}; the PhD student +% can layout the signature part of the copyright page the way s/he +% likes best; the default definition of \cs{@signature} is an example +% from which the student can get a general idea of what is compulsory +% in this field. The sample file \texttt{toptesi-scudo-example.tex} +% contains also an example of modified signature. % % Remember: the disclaimer text is very important, in the % sense that the student writing his/her Ph.D.\ thesis must -% be completely aware that by undesigning that statement -% he/she assumes any legal liability for any event that +% be completely aware that by undersigning that statement +% s/he assumes any legal liability for any event that % might betray other people rights. A kind of % infringement, of course, is plagiarism. Therefore the % under signer must be completely aware that his/her signature @@ -5997,6 +6123,7 @@ Turin, \@examinationdate % this file may contain any kind of definition or % redefinition by using the above commands with suitable % arguments. +% % The data possibly read from the configuration file now % are available, or they may be entered in the body of the % title page environment |ThesisTitlePage|. If some commands @@ -6084,7 +6211,9 @@ Turin, \@examinationdate % % The School required also a colophon where it is explained % how the thesis has been typeset and who are the authors -% of the \LaTeX\ code. +% of the \LaTeX\ code; my name appears there because the School +% requested it in a formal way; mentioning the TOPtesi bundle +% might have been sufficient for this colophon. % % Of course this colophon must be typeset in the last page, % possibly an even one if the thesis is typeset with the @@ -6152,17 +6281,18 @@ This class is available in every up-to-date and complete %%================================================================ %% \ifmagistrale - \ateneo{Politecnico di Torino} - \facolta{}% nessun nome di default/ no default name for PoliTO - \FacoltaDi{}% nessun prefisso per la facoltà/no default faculty label for PoliTO - \CorsoDiLaureaIn{Corso di Laurea in} + \ateneo{}%% The PoliTO name is contained in its logo + \facolta{}%% nessun nome di default/ no default name for PoliTO + \FacoltaDi{}%% nessun prefisso per la facolta'/no default faculty + %% label for PoliTO + \CorsoDiLaureaIn{Corso di Laurea in\xspace}%% \TesiDiLaurea{Tesi di Laurea Magistrale} \InName{in} - %%\retrofrontespizio{Questo testo è soggetto alla + %%\retrofrontespizio{Questo testo e' soggetto alla %% Creative Commons Licence} \fi \ifsecondaria - + \relax \fi \ifScuDo \PhDschoolLogo{Logo-Scudo} @@ -6208,27 +6338,27 @@ This class is available in every up-to-date and complete % commands for setting any Latin or Greek mathematical % letter in any possible font shape and series. % Actually with \XeLaTeX\ and \LuaLaTeX\ it is possible to -% invoke the |unicode-math| package wit the |style=\sigla{ISO}| -% option; in this way the \sigla{ISO} math typesetting become +% invoke the |unicode-math| package with the |style=\sigla{ISO}| +% option; in this way the \sigla{ISO} math typesetting becomes % available; this includes the slanted Greek letters and % many other facilities necessary to fulfil the \sigla{ISO} -% regulations for ``physical sciences and technology''. +% regulations for “physical sciences and technology”. % % With \pdfLaTeX\ there are available several packages -% and font suitable for typesetting math according to +% and fonts suitable for typesetting math according to % the \sigla{ISO} regulations. The fonts Libertinus together -% with the math font LibertinusT1math are the best +% with the math fonts LibertinusT1math are the best % choice for this task; the |isomath| package can do -% an excellent work with other fonts; a ``poor man'' +% an excellent work with other fonts; a “poor man” % solution with the \pdfLaTeX\ typesetting program is % given by the |pm-isomath| package; this latter package % is, in facts, a poor man approach to the problem, so -% it has several limitations, but it avoids completely +% it has several limitations, but it completely avoids % the problem of loading several other math alphabets, % therefore avoiding to exhaust the limited number of % math alphabets \pdfLaTeX\ can handle. % -% This |topcoman| module offers another ``poor man'' +% This |topcoman| module offers another “poor man” % solution only for using by default slanted capital % Greek letters taken from the math italic font; the % upright ones are still available within the |\mathrm| @@ -6277,7 +6407,7 @@ This class is available in every up-to-date and complete \providecommand*\textsubscript{\raisebox{-0.5ex}} \ifPDFTeX -\RequirePackage{textcomp} +\@ifpackageloaded{textcomp}{}{\RequirePackage{textcomp}} \fi % \end{macrocode} % The following commands may be already defined; should @@ -6295,7 +6425,7 @@ This class is available in every up-to-date and complete % no problem: if they already defined they don't get redefined. % \begin{macrocode} \providecommand{\ohm}{\textormath{\textohm}{\mathrm{\Omega}}} -\@ifpackageloaded{toptesi}{ +\@ifpackageloaded{toptesi}{% \providecommand\ped{}\providecommand\ap{} \renewcommand*{\ped}[1]{\textormath{\textsubscript{#1}}{_{\mathrm{#1}}}} \renewcommand*{\ap}[1]{\textormath{\textsuperscript{#1}}{^{\mathrm{#1}}}}}{% @@ -6340,13 +6470,13 @@ This class is available in every up-to-date and complete \let\listing\VerbatimInput % \end{macrocode} % Of course before using |\listing| the user can set any other -% special configuration s/he desiders among those usable with +% special configuration s/he desires among those usable with % package |fancyvrb|; the default set up shown above is good -% for \LaTeX\ code input, as wel as for any language, whose +% for \LaTeX\ code input, as well as for any programming language, whose % source lines are shorter than 75--80 characters, depending % on the normal font size and the document text width; the user % can edit the source file as well as setting a smaller font -% size that |\small|. In certain circumstances the user +% size than |\small|. In certain circumstances the user % should accept protruding lines as well as a compromise % between editing the source file and selecting a smaller % font size. This is not a bug of the package, nor a fault @@ -6360,7 +6490,7 @@ This class is available in every up-to-date and complete % required for all languages except English. If you % use this module outside TOPtesi, but as an extension % of other classes or modules, it's up to you to define -% an ``intelligent comma'' macro or to load either the +% an “intelligent comma” macro or to load either the % |icomma.sty| or the |ncccomma.sty| modules that define % such a macro: the |icomma| package defines the comma % as a mathematical active character that recognises if the @@ -6372,14 +6502,14 @@ This class is available in every up-to-date and complete % This particular package |topcoman| does not define any % intelligent comma command; therefore it does not do % anything for other packages; the main |toptesi.sty| -% packages already defines a form of intelligent comma, +% packages already define a form of intelligent comma, % therefore |topcomand| does not have to add anything to % |toptesi|. But if this package is used independently -% from |toptesi|, the user has two coices: either loads +% from |toptesi|, the user has two choices: either loads % one of the two packages mentioned above, or, if s/he % is typesetting in Italian, the |italian| module for % |babel| already defines the intelligent comma, but its -% definition is disabled by default; the use can turn it +% definition is disabled by default; the user can turn it % on and off by using the commands |\IntelligentComma| % and |\NoIntelligentComma|. % @@ -6394,7 +6524,7 @@ This class is available in every up-to-date and complete % a good idea if the user loads that excellent package. % % The following commands are used to write the -% ``lower case'' roman numerals with the small-caps font; +% “lower case” roman numerals with the small-caps font; % in order to avoid complications with missing fonts % or with math environments, we make sure to typeset these % numerals with script size capitals; this solution is @@ -6405,11 +6535,28 @@ This class is available in every up-to-date and complete % this new macro for folios; in other situations there % are no problems with the choice of font shapes and % series. We need a robust command in order to set the -% script math size -% \begin{macrocode} -\DeclareRobustCommand*{\simulatedSC}[1]{% - {\mbox{$\relax$}\fontsize{\sf@size}{\f@baselineskip}\selectfont#1}}% -% \end{macrocode} +% script math size and some attention to turn the operand +% into uppercase letters to be typeset in script size. +% \begin{macrocode} +\DeclareRobustCommand*{\fakeSC}[1]{% +{\dimen@=\f@size\p@\dimen@=0.75\dimen@ +\fontsize{\dimen@}{\f@baselineskip}\selectfont +\expandafter{\uppercase{#1}}}}% +\ifPDFTeX\let\simulatedSC\fakeSC\else\let\simulatedSC\textsc\fi +% \end{macrocode} +% For example, the \textsc{Bib\TeX} contains the string ‘ib’ +% in lowercase serifed small caps; if one wants to typeset it +% with sans serif fonts, that lack the small caps shape, +% the user could use the code +%\begin{verbatim} +%\textsf{B\simulatedSC{ib}\TeX} +%\end{verbatim} +% in order to get a decent approximation of small caps; this +% poor man solution should not be necessary when using OpenType +% fonts that have their facilities to use fake small caps in case +% this shape was missing from the collection. This is why the +% \cs{simulatedSC} macro is defined only if |pdfLaTeX| is being +% used for typesetting. % % A user, Antonio Mele, suggested and requested the % possibility of having the figure and table names @@ -6452,9 +6599,9 @@ This class is available in every up-to-date and complete %<*topmon>^^A MONOGRAFIA -- TRIENNALE %\fi %\subsection{The \texttt{monografia} module code} -% We start by checking if certain file have ben loaded and in -% case they get loaded. We check if certain switches are defined, -% and in case such switches are defined. +% We start by checking if certain files have ben loaded and in +% case we load then. We check if certain switches are defined, +% and in case we define such switches. % \begin{macrocode} \monografiatrue \@ifpackageloaded{etoolbox}{}{\RequirePackage{etoolbox}} @@ -6477,11 +6624,10 @@ This class is available in every up-to-date and complete \DeclareOption{classica}{\classicatrue} \DeclareOption{autoretitolo}{\ifclassica\@utoretitolotrue\fi} \DeclareOption{oldstyle}{\ifclassica\@ldstyletrue\fi} -%\ProcessOptions*\relax \ProcessOptions\relax % \end{macrocode} -% We define the titling commands... +% We define the titling commands\dots % \begin{macrocode} \def\monografia#1{\gdef\@titolo{#1}} \let\titolo\monografia @@ -6490,7 +6636,7 @@ This class is available in every up-to-date and complete \def\sottotitolo#1{\gdef\@subtitle{#1}} % \end{macrocode} % \dots and the other setting or resetting commands to be used -% within the |ThesiTitlePage| environment. Remember that all +% within the |ThesisTitlePage| environment. Remember that all % these commands may be used within the configuration file, % if the user wants to use such file. % \begin{macrocode} @@ -6590,21 +6736,22 @@ This class is available in every up-to-date and complete % \end{macrocode} % The following command accepts a first optional argument that % should contain an ordinal number, in general an uppercase -% roman numeral, that optionally qualifies the ``academic -% structure'' in charge of the degree course. The user might, +% roman numeral, that optionally qualifies the “academic +% structure” in charge of the degree course. The user might, % for example specify something as % |\struttura[III]{Faculty of Engineering}|, if such kind of % information is required. % \begin{macrocode} \providecommand\@strutturadi{} \newcommand\StrutturaDi[1]{\gdef\@strutturadi{#1\unskip\xspace}} -\newcommand\struttura[2][]{\gdef\@struttura{\ifempty{#1}{}{#1 }\@strutturadi #2}} +\newcommand\struttura[2][]{\gdef\@struttura{\ifempty{#1}{}{#1 }% + \@strutturadi #2}} % \end{macrocode} % Generally bachelor degree courses are not developed within % international agreements such as Erasmus, but it may not be % excluded; therefore several University names and several % university logos might be necessary. The following is the -% general machinery for queuing several logos within a horizontal +% general machinery for lining several logos within a horizontal % box to be output at the proper moment. Remember, though, that % if the logos are output in the lower half of the page, the % top of the title page should contain the university name @@ -6648,14 +6795,14 @@ This class is available in every up-to-date and complete \providecommand\@tutoreaziendalename{Supervisore Aziendale} \def\NomeTutoreAziendale#1{\gdef\@tutoreaziendalename{#1}} % \end{macrocode} -% The following command set up the information for a legal or +% The following command sets up the information for a legal or % copyright page; this information might contain just a simple % statement that indicates a copyright notice or a licence that % specifies the clauses for the intellectual property of the % work. But it might also contain a disclaimer where the only % author takes his/her responsibility and liability for not % infringing any applicable law on intellectual property; -% such disclaimer should be dated and undersigned by the (only) +% such disclaimer should be dated and undersigned by the (single) % author. Therefore within this |\retrofrontespizio| command % two more commands are optionally used: |\luogo| to establish % the location of the signature, and |\giorno| to establish a @@ -6701,8 +6848,8 @@ This class is available in every up-to-date and complete %\begin{ttsintassi} %\cs{TitoloListaCandidati}\Marg{} %\cs{TitoloListaCandidati}\Marg{Estudiante,Estudiantes} -%\cs{TitoloListaCandidati}\Marg{ExamenKandidat,ExamenKandidaten\% -%\qquad,ExamenKandidatin,ExamenKandidatinen} +%\cs{TitoloListaCandidati}\Marg{ExamenKandidat,ExamenKandidaten,\% +%\qquad ExamenKandidatin,ExamenKandidatinen} %\end{ttsintassi} % This command, as it may be seen, may be used also to set the % name list in languages different from Italian. @@ -6730,24 +6877,25 @@ This class is available in every up-to-date and complete \newcommand\CoAdvisorName[2]{\gdef\Correlatore{#1}% \gdef\Correlatori{#2}} % \end{macrocode} -% A new boolean is defined in order to have a suitable switch to set the logo(s) ``string'' at the top or in the second half of the page. +% A new boolean is defined in order to have a suitable switch to set +% the logo(s) “string” at the top or in the second half of the page. % \begin{macrocode} \ifcsundef{iftopTPTlogos}{\newbool{topTPTlogos} \booltrue{topTPTlogos}}{} % \end{macrodoe} % We eventually define the whole construction of the title % page with this new command defined by means of the |xparse| % package facilities. This environment accepts an optional -% asterisk; its presence means th the logo(s) string should +% asterisk; its presence means that the logo(s) string should % be typeset in the lower half of the title page; differently -% from the \LaTeX\ kernel environments that accept an optional +% from the \LaTeX\ kernel environments that accepts an optional % asterisk that becomes part of the environment name, and must % be repeated in the closing environment statement, with the % |xparse| facilities the asterisk is just an argument to the % argument list of the opening command: therefore the source % file contains an opening statement of the form % |\begin{environment}*|, not |\begin{environment*}|. The user -% should remember tis peculiar way of specifying certain optional -% arguments, in particular the optional ``star'' one. +% should remember this peculiar way of specifying certain optional +% arguments, in particular the optional “star” one. % % Another important difference is that environments defined % with the |xparse| facilities may receive optional and @@ -6895,7 +7043,7 @@ This class is available in every up-to-date and complete %\iffalse %<*topmag>^^A MAGISTRALE %\fi -% \subsection{Code for \opz{magistrale}} +% \subsection{Code for \texttt{master} thesis} % Here we document the code for the \opz{magistrale} option. % It is a little more complicated than the code for other % thesis types, because the title page may be typeset in different @@ -6907,7 +7055,7 @@ This class is available in every up-to-date and complete % Nevertheless this module may be used as a standalone one, % i.e.\ a package loaded by a different class; may be not % always and not with any class, but the idea is this one. -% In facts it this module does not receive the suitable +% In facts if this module does not receive the suitable % settings from package |toptesi|,it is possible to call it % with the suitable options as explained below. % \begin{macrocode} @@ -6934,16 +7082,16 @@ This class is available in every up-to-date and complete \newif\ifevenboxes \evenboxesfalse}{} % \end{macrocode} -% We provide for the counter |tomo| and for a new definition +% We provide for the counter |tomo| and for a new definition of % the command |\tomo|; this new definition does not trigger % the production of a title page as it does with the definition -% of package |toptesi.sty|; it accepts an optional argument, +% of package |topfront.sty|; it accepts an optional argument, % the tome (arabic) number (that shall be transformed into a % capital roman one while typesetting the title page); if this % number is not specified the counter value is stepped up % with the |\refstepconter| macro that renders it accessible % to the |\label| command; otherwise a value equal to the -% given number minus one is loaded and afterwars ``refstepped'' +% given number minus one is loaded and afterwards “refstepped” % up in the same way. % % Since \LaTeX\ counter settings are global, the value kept @@ -6978,11 +7126,11 @@ This class is available in every up-to-date and complete % or when the |classica| option is in force. Both redefine % the text grid to be more or less centred on the physical % page; since it is the first page, no binding correction -% is possibly taken care of, because the first page does +% is taken care of, because the first page does % not suffer from the curvature and thickness of the bound % thesis. The headings and footers in both cases are already % filled up with suitable title page data, therefore their -% space is used instead of wasted. +% space is used instead of being “wasted”. % \begin{macrocode} \def\headstrut{\vrule \@depth4\p@ \@height\z@ \@width\z@} \def\ps@titlepage{\let\@mkboth\@gobbletwo @@ -7033,8 +7181,6 @@ This class is available in every up-to-date and complete % the authors block and the proper gender of such names. % \begin{macrocode} \newif\iffemminile -%\newif\ifdottorato \dottoratofalse -%\newif\iftriennale \triennalefalse \ifTOPfront\ifclassica \def\Candidato{Laureando} @@ -7070,7 +7216,7 @@ This class is available in every up-to-date and complete % and the variable data strings are defined; somewhere % these strings receive also the preset values; some of the % following strings are used to modify such preset values, -% very useful to localise such strings for a particular language. +% very useful to localise these strings for a particular language. % \begin{macrocode} \let\@materia\empty \def\Materia#1{\def\@materia{#1}}\let\materia\Materia @@ -7135,7 +7281,7 @@ This class is available in every up-to-date and complete % \end{macrocode} % % Here we define the necessary commands to fill up a comma -% separated list of logo graphic file names; we define +% separated list of logo graphic-file names; we define % everything up to the |\printlogos| command that provides % to printing a list of images, duly separated by adequate % space, all scaled to the same height, and, possibly, even @@ -7144,12 +7290,12 @@ This class is available in every up-to-date and complete % times with different logo file names, accepts an optional % argument consisting in a dimension; it is used to scale the % height of the logo image to the desired value, so that the -% whole string of images does not have unusual differences -% logo heights. This dimension id preset to one seventh of +% whole string of images does not have unusual different +% logo heights. This dimension is preset to one seventh of % the |\textwidth| and on the average it is well suited. With % the standard |toptesi| class printed on A4 paper, such height % equals 25\,mm; of course on smaller paper it is proportionally -% small; on American sized sheets it may be a little larger, +% smaller; on American sized sheets it may be a little larger, % but in general it is adequate to the page size. % \begin{macrocode} \newlength{\TPT@logospace}\TPT@logospace=3em\relax @@ -7201,7 +7347,7 @@ This class is available in every up-to-date and complete {\IfFileExists{toptesi.cfg}{\input{toptesi.cfg}}{}} % \end{macrocode} % -% Here we define the preset strings; most of the are empty +% Here we define the preset strings; most of them are empty % strings, but some are real words; the setting commands % listed before can easily be used to localise such string % in different languages. @@ -7286,7 +7432,7 @@ This class is available in every up-to-date and complete % |frontespizio| and |frontespizio*| are still usable, but % we discourage them. Even the commands |\frontespizio| and % |\frontespizio*| are still usable but for even more reasons -% we discourage their use; they reman available for a sort +% we discourage their usage; they remain available for a sort % of backwards compatibility. % % A new environment |ThesisTitlePage| is defined that actually @@ -7312,6 +7458,7 @@ This class is available in every up-to-date and complete %\end{ThesisTitlePage*} %\end{verbatim} % is wrong. +% % This choice was made because its programming is simpler, % but in view of the end user it is simpler to use: for % example, if the user does not use the asterisk for typesetting @@ -7336,6 +7483,7 @@ This class is available in every up-to-date and complete \PackageInfo{toptesi-magistrale}{No configuration file found}} }{\fr@ntespizio} % \end{macrocode} +% % The following code is substantially identical to that of the % |topfront| package; just the statements concerning the % bachelor degree and the Ph.D.~degree theses have been deleted. @@ -7524,14 +7672,15 @@ This class is available in every up-to-date and complete % It is useful to remind that the legal page in general is not % compulsory, but it is becoming frequently requested by more % and more universities. The user can fill up the -% |\retrofrontespizio| argument with as many paragraphs s/he -% is subject in accordance with his/her university requirements. +% |\retrofrontespizio| argument with as many paragraphs as are +% necessary by his/her university requirements. +% % In general there is a statement claiming the intellectual -% property if the thesis contents; very often it makes reference +% property of the thesis contents; very often it makes reference % to the Creative Commons licence that is internationally well % known; other international licences may me used. At the same % time very often a statement is needed where the thesis author -% assume the necessary liability for any violation of other +% assumes the necessary liability for any violation of other % people intellectual property and/or copyright. Plagiarism and % lack od attribution of other people rights are the most common % illegal actions done by students writing their theses, and it @@ -7552,7 +7701,7 @@ This class is available in every up-to-date and complete %\fi % \subsection{The \texttt{toptesi-dottorale} module} % What follows is mainly a replica of the |topfront| module -% where useless commands have been eliminated; ``useless'' +% where useless commands have been eliminated; “useless” % in view of creating a title page for a Ph.D.~thesis. % % First we load the necessary packages. @@ -7561,9 +7710,9 @@ This class is available in every up-to-date and complete \@ifpackageloaded{xspace}{}{\RequirePackage{xspace}} \@ifpackageloaded{xparse}{}{\RequirePackage{xparse}} % \end{macrocode} -% The we define, if they are not already defined some boolean +% Then we define, if they are not already defined, some boolean % switches related to the possible options. The above packages, -% and the following switches are necessary in case thei module +% and the following switches are necessary in case this module % is used by itself with a different class. The module accepts % some options, that are declared just after these preliminary % definitions. @@ -7587,8 +7736,9 @@ This class is available in every up-to-date and complete \newif\ifdottorato \dottoratotrue % \end{macrocode} +% % Here are the option declarations and their processing. Notice -% that the |14pt| option implies the the calling class loads +% that the |14pt| option implies that the calling class loads % some package that can set a normal size to 14pt or 14.4pt, % otherwise this option may produce an error or a warning; % in the best case it does not do anything. The |toptesi| @@ -7597,14 +7747,14 @@ This class is available in every up-to-date and complete % the user who wants to use a normal size larger than 12pt % or smaller than 10pt, can resort to that package; possibly % that is not the only package suited for such acrobatic -% settings, but the important point is to avoid ``acrobatics''; +% settings, but the important point is to avoid “acrobatics”; % scientific books, reports, theses, and other such documents % are supposed to be read by adults, not by children while % normal sizes from 14pt on are more suited for elementary % school pupils. On the opposite, normal sizes smaller than % 10pt are difficult to read and should be avoided for -% documents to be read continuously; It is possible to use -% such small font sizes in foot notes, or in dictionaries, +% documents to be read continuously; it is possible to use +% such small font sizes in footnotes, or in dictionaries, % but both footnotes and dictionary entries do not generally % occupy dozens of pages. % \begin{macrocode} @@ -7617,8 +7767,8 @@ This class is available in every up-to-date and complete \ProcessOptions*\relax % \end{macrocode} % -% We now define two specific page styles, one for ``normal'' -% title pages, and one for theses typeset wit the |classica| +% We now define two specific page styles, one for “normal” +% title pages, and one for theses typeset with the |classica| % option in force: they are |\ps@titlepge| and |\ps@classica|. % \begin{macrocode} \def\headstrut{\vrule \@depth4\p@ \@height\z@ \@width\z@} @@ -7667,7 +7817,7 @@ This class is available in every up-to-date and complete % \end{macrocode} % % We provide also the variant settings for when the |classica| -% option is in force toghether with the |autoretitolo| one. +% option is in force together with the |autoretitolo| one. % \begin{macrocode} \if@utoretitolo \if@twoside @@ -7720,7 +7870,7 @@ This class is available in every up-to-date and complete % \end{macrocode} % Now we define the title setting commands for both % title (|\titolo|) and subtitle (|\sottotitolo|) and -% all the other command for setting the fixed strings. +% all the other commands for setting the fixed strings. % \begin{macrocode} \let\@stitle\empty @@ -7800,23 +7950,24 @@ This class is available in every up-to-date and complete \newcommand\facolta[2][]{\gdef\@facname{#2}\gdef\@facnumber{#1}} \let\struttura\facolta % \end{macrocode} -% Here we define how to handle one or more logos; even in -% PH.D.%schools there might be situations where the Ph.D.~program +% +% next we define how to handle one or more logos; even in +% PH.D. schools there might be situations where the Ph.D.~program % has been carried on in several universities; it might be -% required to set the logos where the research program -% leading to the Ph.D. has been developed. The user commands +% required to set the logos of the universities where the research +% program leading to the Ph.D. has been developed. The user commands % are |\logosede| and |\printloghi|; the latter does what % its name suggests, i.e. it prints the string of logos; % the former command accepts one logo file name, and queues % it into a logo list; this command may be used multiple times; -% of course if there are several logos, their ``string'' +% of course if there are several logos, their “string” % may become larger than the text width, and in this case % |\printloghi| shrinks the whole string (maintaining the % aspect ratio) so as to fit it within the measure. If the % logos are too many and/or they are too wide, this % shrinking may reduce them too much; there is no work -% around this problem except avoiding using too many and/or -% too wide logos. +% around to avoid this problem except refraining from using too +% many and/or too wide logos. % \begin{macrocode} \newlength{\TPT@logospace}\TPT@logospace=3em\relax \newsavebox{\TPT@logobox} @@ -7842,7 +7993,7 @@ This class is available in every up-to-date and complete \newcommand\printloghi{\unless\ifvoid\TPT@logobox\usebox{\TPT@logobox}\fi} % \end{macrocode} % -% We keep defining macros to set fixed string or variable data. +% We keep defining macros to set fixed strings and/or variable data. % \begin{macrocode} \def\tutoreaziendale#1{\gdef\@tutoreaziendale{#1}} \newcommand\retrofrontespizio[1]{\long\gdef\@retrofrontespizio{#1}} @@ -7946,7 +8097,7 @@ This class is available in every up-to-date and complete % We now start setting the |ThesisTitlePage| environment; % we use the |xparse| functionality to define it; the % environment accepts an optional asterisk as its first -% and only argument, that as a single token may be entered +% and only argument, that is a single token may be entered % without brackets as the very first token after the % environment opening statement. If the user wants to use % this optional argument, s/he must enter @@ -7955,22 +8106,22 @@ This class is available in every up-to-date and complete % logo position to the title page lower half, while its % absence sets such position to the title page top. % -% The opening commands provide also to reading a configuration +% The opening commands provide also to read a configuration % file, if it exists in the same folder as the thesis main % file; such configuration file must be named \meta{thesis % main file name}|.cfg|. The environment body, besides the -% possible data already got from the configuration file +% possible data already retrieved from the configuration file, % accepts other setting commands for the title page necessary % and optional data; if some commands are repeated with % different data, the last ones prevail on the previous ones. -% The actual title page typesetting is done by the closing -% commands through the |\fr@ntespizio| command. +% The actual title page typesetting is done by the closing +% environment command. % % Among the setting commands there might be also the legal % page |\retrofrontespizio| command; it closes the recto % title page, and on the verso, if the command argument % is void, nothing is printed except the blank verso page, -% but if it contains something the legal notice is printed +% but if it contains something, the legal notice is printed % at the verso page bottom. % \begin{macrocode} \newbool{topTPTlogos}\newbool{AteneoInHead} @@ -7985,9 +8136,9 @@ This class is available in every up-to-date and complete \fr@ntespizio } % \end{macrocode} -% Here we define the actual typesetting of the title page. +% Next we define the actual typesetting of the title page. % The code is substantially that of the generic module -% |topfront|where we deleted the commands and the settings +% |topfront| where we deleted the commands and the settings % related to thesis kinds that have nothing to do with % a generic doctoral thesis. % \begin{macrocode} @@ -8200,8 +8351,8 @@ This class is available in every up-to-date and complete %\fi % % \subsection{The \texttt{toptesi-sss} module code} -% The module for typesetting high school final work -% title pages starts here. We avoid using a |.def| file and put +% The module for typesetting the high-school final-work +% title-page starts here. We avoid using a |.def| file and put % all necessary commands in one file. % % First we load the described packages using different loading @@ -8212,7 +8363,7 @@ This class is available in every up-to-date and complete %\fi % \begin{macrocode} %% -%%%% Math fonts and AMS extensions (fontspec is already loaded) +%%%% Math fonts and AMS extensions (|fontspec| is already loaded) \secondariatrue \ifPDFTeX \@ifpackageloaded{newtxmath}{}% @@ -8231,8 +8382,7 @@ This class is available in every up-to-date and complete \RequirePackage{calc} % Calculation macros \RequirePackage{ifthen} % Conditional statements \RequirePackage{booktabs} % professional rules in tables -\RequirePackage{multirow} % It's more professional avoiding tables - % with cells spanning several rows +\RequirePackage{multirow} % Multirow table cells are not professional \RequirePackage[autostyle]{csquotes} % necessary for biblatex \ifPDFTeX \RequirePackage{indentfirst}\fi \raggedbottom @@ -8286,12 +8436,13 @@ This class is available in every up-to-date and complete \newcommand*\Presidente[1]{\gdef\@presidente{#1}} \newcommand*\NumeroCommissione[1]{\gdef\@numerocommissione{#1}} % \end{macrocode} +% % The following code certainly does not hurt, but it was % necessary during the preliminary testing. % \begin{macrocode} \newcommand*\ifBlank{\expandafter\ifblank\expandafter} % \end{macrocode} -% The environmnet |FrontespizioTesina| is being defined here. +% The environment |FrontespizioTesina| is being defined here. % No optional arguments are requested, therefore it is not % necessary to use the defining commands of package |xparse|. % The environment starts by reading the configuration file @@ -8303,15 +8454,16 @@ This class is available in every up-to-date and complete \InputIfFileExists{\jobname.cfg}{\relax}{\relax} }{% % \end{macrocode} +% % After this preliminary test the |titlepage| environment is % opened and the layout assembly starts. First the information % on the school; if the school generic name has been omitted -% among the mandatory user commands, the string `Manca il tipo -% di scuola' is printed in its place, so that the user is +% among the mandatory user commands, the string “Manca il tipo +% di scuola” is printed in its place, so that the user is % directly reminded of the mandatory nature of this piece of % data. On the opposite if the Ministry of education data are % missing, nothing is done. After these mandatory and optional -% data are printed a couple of horizontal lines are typed so +% data are printed, a couple of horizontal lines are typed so % as to mark the end of the title page heading. % \begin{macrocode} \begin{titlepage}\parindent=0pt @@ -8326,6 +8478,7 @@ This class is available in every up-to-date and complete \vspace{-1.5ex} \makebox[0.25\textwidth]{\rule{0.25\textwidth}{0.8\p@}}\par % \end{macrocode} +% % After this heading the proper name of the school is printed, % possibly with its real address. % \begin{macrocode} @@ -8338,7 +8491,7 @@ This class is available in every up-to-date and complete \vspace{\stretch{1}} % \end{macrocode} % -% next the name of the document and its title and subtitle +% Next the name of the document and its title and subtitle % are set: the title in |\Large| boldface font, while the subtitle % in normal size. % \begin{macrocode} @@ -8348,8 +8501,9 @@ This class is available in every up-to-date and complete {\Large\textbf{\@title}\par} {\vspace{0.5\baselineskip} -\normalsize\@subtitle\par}% uno \stretch{1} è già stato fatto +\normalsize\@subtitle\par} % \end{macrocode} +% % If a file name is specified for the graphic file that % contains the school logo, such image is inserted in the % title page. @@ -8358,9 +8512,10 @@ This class is available in every up-to-date and complete {\vspace{\stretch{1}}}% {\includegraphics[height=30mm]{\@SSSLogo}}\par\vspace{\stretch{1}} % \end{macrocode} +% % The examining committee chairperson name and the Ministry % of education committee ID number are typeset within a -% |minipage|. Another |minipage| contain the student's name. +% |minipage|. Another |minipage| contains the student's name. % Pay attention: the names of the student and of the president % are typeset in bold face small caps if the default fonts have % this typeface; if the chosen fonts do not have this typeface @@ -8383,6 +8538,7 @@ This class is available in every up-to-date and complete \vspace{\stretch{1}} % \end{macrocode} +% % Eventually the school year is printed with an initial string % `Anno scolastico'. This terminates the title page; the % environment is closed and the page ejected. @@ -8406,6 +8562,21 @@ Anno scolastico \@annoscolastico}} % \endinput %%%%%% Recent progress +%%% (version 6.2.04 2018-05-05) With TeXLive 2018 diagnostic messages +% on errors in the LaTeX kernel are more efficiente and some of them +% were notified, while until 2017 no notice was issued. The source +% code was revised in order to eliminate those little nasty bugs. +% +%%% (version 6.2.01 2018-04-30) The main structure introduced with +% previous versions and their minor versions remains untouched, +% but a neu option has been added in order to modify the bibliography +% style when typesetting theses for the PoliTO Doctoral School ScuDo. +% The specific module was developed having in mind theses in the +% scientific domains covered by the IEEE Transactions; of course +% not all doctoral theses deal with thos domains, therefore the +% bibliography style should be changeable according to the styles +% used in other scientific domains. +% %%% (version 6.1.8 -- 2017-10-15) Extended version 5.92.xx in order % to modularise the whole bundle; this requires the key=value options % in order to smoothly handle the various new options, especially those -- cgit v1.2.3