diff options
Diffstat (limited to 'macros/latex/contrib')
22 files changed, 1344 insertions, 1063 deletions
diff --git a/macros/latex/contrib/toptesi/README.txt b/macros/latex/contrib/toptesi/README.txt index 220bda5eaf..05c2a00f18 100644 --- a/macros/latex/contrib/toptesi/README.txt +++ b/macros/latex/contrib/toptesi/README.txt @@ -1,5 +1,5 @@ -con-TOPtesi bundle version 6.x -Copyright 2008-2019 Claudio Beccari +TOPtesi bundle version 6.x +Copyright 2008-2020 Claudio Beccari LaTeX Project Public Licence LPPL v.1.3c (or later) This work may be distributed and/or modified under the conditions of @@ -27,7 +27,7 @@ This work consists of the following files: toptesi-example-dottorale.tex toptesi-example-magistrale.tex toptesi-scudo-example.zip - README + README.txt toptesi-it.tex The files derived from the work are the following: @@ -55,14 +55,15 @@ pdf file. The Italian documentation is obtained by running LuaLaTeX on toptesi-it.tex; this documentation has been completely redone compared to previous versions. With this compiler the result -should be PDF/A-1b compliant. The compilation of this file +is PDF/A-2b compliant. The compilation of this file requires input of various .pdf files, mostly obtained by processing the .tex files belonging to the bundle. It requires also the FAKE logos of Politecnico di Torino and of its doctoral school. See below. The two documentations pdf files, toptesi.pdf and toptesi-it.pdf, -are complementary to one another. +are complementary to one another and both should be stored in the +doc/latex/toptesi/ folder. The various files @@ -112,14 +113,24 @@ As a new feature compared to versions 5.x, among the various thesis types there is also the one that Italian students submit to the examining committee of their final high-school State Exam. +Version 6.4.x is further upgraded in order to customise header positions +and folios. It it also upgraded to allow compliance with level 2 of the +ISO PDF/A regulations on long term archivability. Because the filecontents +*package* functionalities have been embedded into the LaTeX *kernel* +environment, in a way backwards compatible with the previous definition +of that environment, the now obslete package filecontents functionalities may +still be obtained, but with a different syntax; therefore a new TOPtesi +specific metadata environment has been defined so as to bypass such syntax +changes. + Version 6.3.x contains some enhancements and corrections, especially in view of the 2019 Italian TUG meeting that contained a tutorial on this bundle. For what concerns PDF/A compliant files, the documentation gives instructions that are up to date with package pdfx dated February 2019, version 1.6.3. -Version 6.1.12 just differs from the previous 6.x versions because some -little bugs were corrected and the documentation was upgraded. +Version 6.x derives from the previous version by using several features +of the LaTeX3 language. Version 5.92 of TOPtesi was intended to be compliant also with XeLaTeX and LuaLaTeX; the documentation explains also how to obtain PDF/A-1b @@ -136,10 +147,15 @@ Italian documentation file toptesi-it.pdf. -------------------------------------------------------------------- -For installation, if the package is not already contained in the -installed TeX system distribution, on your platform either read -the Italian documentation toptesi-it.pdf or move the toptesi.zip -file to +You might have your valid reasons for not upgrading your installed TeX +system distribution, but in order to have available some new +functionalities, you might consider upgrading your installation; +otherwise you have to install the whole TOPtesi bundle by yourself. +You can get some help by carefully reading the Italian documentation +file toptesi. + +In this case you have to download the toptesi.zip file from a CTAN archive +and save it to this (possibly created on purpose) folder: .../texmf/source/latex/toptesi. @@ -147,23 +163,9 @@ and decompress it. Then run pdflatex on toptesi.dtx in order to get the class, style and configuration files (and the pdf documentation in English) and move -the .tex, .cls, .sty, and .cfg files (including the -example .tex and .pdf files) to .../texmf/tex/latex/toptesi/. - -Two fake logos of the "Institute of Technology of Turin" and its Doctoral -School are provided, in substitution of the legal official ones. They both -have a "FAKE LOGO" watermark so as to be sure they are not used in place -of the official ones. In the documentation of this bundle they are used -as examples of possible logos, but they do not represent in any way any -official logo. Even the fake institutional name, the translation in English -of the official Italian one, has nothing to do with the trademarked one, -the only one the Politecnico of Torino bachelor, master, and PH.D. students -should use for their actual theses; they have to get the official logos -from their Student Office, or from the official restricted Web site where -only institutional students have access. - -Move the .txt and the remaining .pdf files plus this README file to -.../texmf/doc/latex/toptesi. +the .tex, .cls, .sty, and .cfg files (including the example .tex files) +to .../texmf/tex/latex/toptesi/. Move the two pdf files +toptesi.pdf and toptesi-it.pdf to .../texmf/doc/latex/toptesi/. If the mentioned folders do not exist, create them. @@ -176,12 +178,28 @@ C:\Users\<your login name>. If you are running a Windows platform change the slashes into backslashes and prefix all paths with the drive letter and any other specific prefix -that is actually used in your texmf tree. +that is actually used in your personal texmf tree. Remember to refresh the filename database if you are using a MiKTeX installation! This operation is not required if you have a TeXLive installation. +------------------------------------------------------------------------ + +Two fake logos of the "Institute of Technology of Turin" and its Doctoral +School are provided, in substitution of the legal official ones. They both +have a "FAKE LOGO" watermark so as to be sure they are not used in place +of the official ones. In the documentation of this bundle they are used +as examples of possible logos, but they do not represent in any way any +official logo. Even the fake institutional name, the translation in English +of the official Italian one, has nothing to do with the trademarked one, +the only one the Politecnico of Torino bachelor, master, and PH.D. students +should use for their actual theses; they have to get the official logos +from their Student Office, or from the official restricted Web site where +only institutional students have access. + +------------------------------------------------------------------------- + The package is already installed with *complete* TeXLive, MacTeX or MiKTeX distributions. In this case you don't need to decompress anything and move files around; in case of TeX system upgrades your diff --git a/macros/latex/contrib/toptesi/Toptesi-con-topfront.pdf b/macros/latex/contrib/toptesi/Toptesi-con-topfront.pdf Binary files differindex f36657e45a..17d982deca 100644 --- a/macros/latex/contrib/toptesi/Toptesi-con-topfront.pdf +++ b/macros/latex/contrib/toptesi/Toptesi-con-topfront.pdf diff --git a/macros/latex/contrib/toptesi/Toptesi-con-topfront.tex b/macros/latex/contrib/toptesi/Toptesi-con-topfront.tex index 530714cb8b..5faff32bba 100644 --- a/macros/latex/contrib/toptesi/Toptesi-con-topfront.tex +++ b/macros/latex/contrib/toptesi/Toptesi-con-topfront.tex @@ -2,7 +2,10 @@ % !TEX TS-program = pdflatex % % File per collaudare gli ambienti frontespizio e frontespizio* -\documentclass[% +% Il laureando/dottorando preferisca usare l'opzione tipotesi=... per la +% classe toptesi, piuttosto che seguire questo modello. +% +\documentclass[% OPZIONI PER LA CLASSE %b5paper % Il formato della carta si può specificare anche così. %formato=b5paper % Versione per specificare il formato della carta %a4paper % Non necessario perché è il default @@ -20,8 +23,8 @@ % \usepackage{teubner}% per le notazioni filologiche greche % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% per macchine Linux/Mac/UNIX/Windows; sarebbe meglio utf8 -%\usepackage[latin1]{inputenc} +% Per macchine Linux/Mac/UNIX/Windows: usare solo utf8, anche se con +%pdfLaTeX si potrebbero usare anche altre codifiche \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} \usepackage{lmodern} @@ -92,9 +95,12 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% Questo codice serve per collaudare gli ambienti frontespizio e frontespizio* -% con l'asterisco il logo dell'ateneo va a finire sotto il titolo nella seconda -% metà della pagina; senza asterisco va a finire in testa. +% Questo codice serve per collaudare gli ambienti frontespizio e +% frontespizio*; con l'asterisco il logo dell'ateneo va a finire sotto il +% titolo nella seconda metà della pagina; senza asterisco va a finire in +% testa. +% Tuttavia, sebbene con topfront TOPtesi possa compilare ogni tipo di tesi +% si consiglia di specificare fra le opzioni \begin{frontespizio} \ateneo{Università di Marconia}% nome generico dell'universita' diff --git a/macros/latex/contrib/toptesi/logoguittondo.pdf b/macros/latex/contrib/toptesi/logoguittondo.pdf Binary files differnew file mode 100644 index 0000000000..b049d85afd --- /dev/null +++ b/macros/latex/contrib/toptesi/logoguittondo.pdf diff --git a/macros/latex/contrib/toptesi/topfront-example.pdf b/macros/latex/contrib/toptesi/topfront-example.pdf Binary files differindex 71f52e05e4..9374518f30 100644 --- a/macros/latex/contrib/toptesi/topfront-example.pdf +++ b/macros/latex/contrib/toptesi/topfront-example.pdf diff --git a/macros/latex/contrib/toptesi/topfront-example.tex b/macros/latex/contrib/toptesi/topfront-example.tex index 18cde3f939..21302dce1c 100644 --- a/macros/latex/contrib/toptesi/topfront-example.tex +++ b/macros/latex/contrib/toptesi/topfront-example.tex @@ -28,7 +28,7 @@ \documentclass[ a4paper, 11pt, -twoside]{report}% it works also with book and article +twoside]{book}% it works also with book and article \usepackage{iftex}% Which typesetting engine? pdflatex, xelatex or lualatex diff --git a/macros/latex/contrib/toptesi/toptesi-example-con-frontespizio.pdf b/macros/latex/contrib/toptesi/toptesi-example-con-frontespizio.pdf Binary files differindex 932d09b206..64f62826b4 100644 --- a/macros/latex/contrib/toptesi/toptesi-example-con-frontespizio.pdf +++ b/macros/latex/contrib/toptesi/toptesi-example-con-frontespizio.pdf diff --git a/macros/latex/contrib/toptesi/toptesi-example-dottorale.pdf b/macros/latex/contrib/toptesi/toptesi-example-dottorale.pdf Binary files differindex 39ce0b8eb0..2ce96788c3 100644 --- a/macros/latex/contrib/toptesi/toptesi-example-dottorale.pdf +++ b/macros/latex/contrib/toptesi/toptesi-example-dottorale.pdf diff --git a/macros/latex/contrib/toptesi/toptesi-example-luatex.pdf b/macros/latex/contrib/toptesi/toptesi-example-luatex.pdf Binary files differindex 54fb4bae2c..2ef3755792 100644 --- a/macros/latex/contrib/toptesi/toptesi-example-luatex.pdf +++ b/macros/latex/contrib/toptesi/toptesi-example-luatex.pdf diff --git a/macros/latex/contrib/toptesi/toptesi-example-magistrale.pdf b/macros/latex/contrib/toptesi/toptesi-example-magistrale.pdf Binary files differindex 3f10b31602..428365af66 100644 --- a/macros/latex/contrib/toptesi/toptesi-example-magistrale.pdf +++ b/macros/latex/contrib/toptesi/toptesi-example-magistrale.pdf diff --git a/macros/latex/contrib/toptesi/toptesi-example-sss.pdf b/macros/latex/contrib/toptesi/toptesi-example-sss.pdf Binary files differindex 6780bcdcae..7e29427a8f 100644 --- a/macros/latex/contrib/toptesi/toptesi-example-sss.pdf +++ b/macros/latex/contrib/toptesi/toptesi-example-sss.pdf diff --git a/macros/latex/contrib/toptesi/toptesi-example-sss.tex b/macros/latex/contrib/toptesi/toptesi-example-sss.tex index bda97d1455..79bbcbe56a 100644 --- a/macros/latex/contrib/toptesi/toptesi-example-sss.tex +++ b/macros/latex/contrib/toptesi/toptesi-example-sss.tex @@ -82,7 +82,7 @@ sul rilevamento telescopico della pressione. \ringraziamenti -I candidati ringraziano vivamente il Granduca di Toscana per i mezzi +Il candidato ringraziano vivamente il Granduca di Toscana per i mezzi messi loro a disposizione, ed il signor Von Braun, assistente del prof.~Albert Einstein, per le informazioni riservate che egli ha gentilmente fornito loro, e per le utili discussioni che hanno permesso @@ -145,11 +145,11 @@ $\Omega$ velocit\`a istantanea di rotazione; si ricorda che \`e $[\Omega]=% \end{enumerate} % -Le grandezze in gioco sono evidenziate nella figura \ref{fig1}. +Le grandezze in gioco sono evidenziate nella figura~\ref{fig1}. \begin{figure}[ht]\centering \setlength{\unitlength}{0.01\textwidth} \begin{picture}(40,30)(30,0) -\put(50,15){\circle{20}} +\put(50,15){\scalebox{5}[4]{\circle{5}}} \put(47,15){\circle*{1}} \put(30,0){\line(0,1){30}} \put(30,30){\line(1,0){40}} diff --git a/macros/latex/contrib/toptesi/toptesi-example-triennale.pdf b/macros/latex/contrib/toptesi/toptesi-example-triennale.pdf Binary files differindex 659043341e..4095de8e65 100644 --- a/macros/latex/contrib/toptesi/toptesi-example-triennale.pdf +++ b/macros/latex/contrib/toptesi/toptesi-example-triennale.pdf diff --git a/macros/latex/contrib/toptesi/toptesi-example-xetex.pdf b/macros/latex/contrib/toptesi/toptesi-example-xetex.pdf Binary files differindex 9b97a99f6c..40bba2113c 100644 --- a/macros/latex/contrib/toptesi/toptesi-example-xetex.pdf +++ b/macros/latex/contrib/toptesi/toptesi-example-xetex.pdf diff --git a/macros/latex/contrib/toptesi/toptesi-example-xetex.tex b/macros/latex/contrib/toptesi/toptesi-example-xetex.tex index ba959edbb3..8974874ea5 100644 --- a/macros/latex/contrib/toptesi/toptesi-example-xetex.tex +++ b/macros/latex/contrib/toptesi/toptesi-example-xetex.tex @@ -5,12 +5,14 @@ \documentclass[% % 10pt % 11pt -12pt, +corpo=12pt, twoside, -%,classica -%,autoreanno -%,oldstile -%,cucitura +stile=classica, +%autoreanno, +%oldstile, +%cucitura, +tipotesi=magistrale, +folioinhead, ]{toptesi} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -30,6 +32,7 @@ twoside, %%%%%%%%% da caricare per ultimo e solo se non e' gia' stato caricato \expandafter\csname @ifpackageloaded\endcsname{hyperref}{}{\usepackage{hyperref}} + \hypersetup{% pdfpagemode={UseOutlines}, bookmarksopen, @@ -45,7 +48,9 @@ twoside, % \english % la lingua di default e' l'italiano - +% qui si usa l'ambiente frontespizio perché non si è specificata nessuna +% opzione realtiva al tipo di tesi. +\begin{ThesisTitlePage} \ateneo{Università degli Studi di Einstenia}% nome generico dell'Universita' \nomeateneo{Weiss Turm}% eventuale nome proprio dell'universita' \logosede{logouno}% logo dell'universita' @@ -79,13 +84,13 @@ twoside, % %\chapterbib %solo per sperimentare; e' preferibile comporre una sola bibliografia %\AdvisorName{Supervisors} -\retrofrontespizio{Questo testo è sottoposto alla Creative Common Licence +\retrofrontespizio{Questo testo è sottoposto alla Creative Common Licence \dots \vspace{2\baselineskip} Stampato il \today } - +\end{ThesisTitlePage} \newtheorem{osservazione}{Osservazione}% Standard LaTeX @@ -94,17 +99,17 @@ twoside, %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Solo per collaudare -\ifclassica - \tomo - \paginavuota% Per avere la dedica sul recto, ma non subito dopo il retrofrontepsizio - \begin{dedica} - A mio padre - - \textdagger\ A mio nonno Pino - \end{dedica} -\else - \frontespizio* -\fi +%\ifclassica +% \tomo +% \paginavuota% Per avere la dedica sul recto, ma non subito dopo il retrofrontepsizio +% \begin{dedica} +% A mio padre +% +% \textdagger\ A mio nonno Pino +% \end{dedica} +%\else +% \frontespizio* +%\fi % In una tesi vera usare solo a seconda dei casi \frontespizio o \tomo %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -115,7 +120,7 @@ La pressione barometrica di Giove viene misurata mediante un metodo originale messo a punto dai candidati, che si basa sul rilevamento telescopico della pressione. -\ringraziamenti% compone i ringraziamanti che di solito sono inutili +\ringraziamenti% compone i ringraziamenti che di solito sono inutili I candidati ringraziano vivamente il Granduca di Toscana per i mezzi messi loro a disposizione, ed il signor Von Braun, assistente del @@ -152,10 +157,7 @@ ai candidati di evitare di riscoprire l'acqua calda. \chapter{Introduzione generale} \section{Principi generali} -Il problema della determinazione della pressione barometrica dell'atmosfera di -Giove non ha ricevuto finora una soluzione soddisfacente, per l'elementare -motivo che il pianeta suddetto si trova ad una distanza tale che i mezzi attuali -non consentono di eseguire una misura \emph{in loco}. +Il problema della determinazione della pressione barometrica dell'atmosfera di Giove non ha ricevuto finora una soluzione soddisfacente, per l'elementare motivo che il pianeta suddetto si trova ad una distanza tale che i mezzi attuali non consentono di eseguire una misura \emph{in loco}. Conoscendo però con grande precisione le orbite dei satelliti principali di Giove, e segnatamente le orbite dei satelliti medicei, è possibile eseguire @@ -196,12 +198,10 @@ Le grandezze in gioco sono evidenziate nella figura \ref{fig1}. \end{figure} Per misurare le grandezze che compaiono in questa formula è necessario -ricorrere ad un pirometro con una resistenza di 120\unit{M\ohm}, altrimenti gli -errori di misura sono troppo grandi, ed i risultati completamente falsati. +ricorrere ad un pirometro con una resistenza di 120\unit{M\ohm}, altrimenti gli errori di misura sono troppo grandi, ed i risultati completamente falsati. \section{I satelliti medicei} -I satelliti medicei, come noto, sono quattro ed hanno dei periodi di rivoluzione -attorno al pianeta Giove che vanno dai sette giorni alle tre settimane. +I satelliti medicei, come noto, sono quattro ed hanno dei periodi di rivoluzione attorno al pianeta Giove che vanno dai sette giorni alle tre settimane. Essi furono per la prima volta osservati da uno dei candidati mentre sperimentava l'efficacia del tubo occhiale che aveva appena inventato diff --git a/macros/latex/contrib/toptesi/toptesi-example.pdf b/macros/latex/contrib/toptesi/toptesi-example.pdf Binary files differindex 53cc036726..e33aaa2baa 100644 --- a/macros/latex/contrib/toptesi/toptesi-example.pdf +++ b/macros/latex/contrib/toptesi/toptesi-example.pdf diff --git a/macros/latex/contrib/toptesi/toptesi-example.tex b/macros/latex/contrib/toptesi/toptesi-example.tex index 23aadde79f..9b914dbce9 100644 --- a/macros/latex/contrib/toptesi/toptesi-example.tex +++ b/macros/latex/contrib/toptesi/toptesi-example.tex @@ -14,6 +14,10 @@ %%%%%%% in italiano quali opzioni accettano un valore, e quali %%%%%%% opzioni accettano delle scelte. +%%%%%%% Con la chiave tipotesi= assente o senza valore o col valore +%%%%%%% magistrale, queso file di esempio funziona, ma con dottorale +%%%%%%% o con triennale o monografia non funziona. Vedere gli altri esempi. + %%%%%%% L'opzione per il corpo accetta qualsiasi valore, anche fratto %%%%%%% (per esempio: corpo=11.5pt) e va sempre scritto con una %%%%%%% unità di misura fra quelle che vengono riconosciute dal @@ -34,7 +38,10 @@ autoretitolo, greek, evenboxes, -% tipotesi, +% tipotesi=magistrale,% si può anche commentare + nocenterfolio, +% folioinhead, + nocenterhead, ]{toptesi} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -54,7 +61,7 @@ citecolor={blue}, urlcolor={blue} } -% + %%%%%%% Esempio di composizione di tesi di laurea con PDFLATEX % % @@ -65,8 +72,7 @@ %%%%%%% Definizioni locali \newtheorem{osservazione}{Osservazione}% Standard LaTeX - -\begin{document} +\begin{document}\errorcontextlines=100 %%%%%%% Questi comandi è meglio metterli dentro l'ambiente %%%%%%% frontespizio o frontespizio*, oppure in un file di %%%%%%% configurazione personale visto che fra le opzioni @@ -86,7 +92,6 @@ % %%%%%%% Corso degli studi \corsodilaurea{Astronomia Applicata}% per la laurea -%\corsodidottorato{Meccanica}% per il dottorato %%%%%%% Per inserire la matricola rientrato sotto il nome di ogni %%%%%%% candidato. Questo comando non è predefinito secondo lo @@ -152,10 +157,9 @@ %\sedutadilaurea{Agosto 1615}% per la laurea quinquennale (obsoleta); %%%%%%% oppure: \sedutadilaurea{\textsc{Anno~accademico} 1615-1616}% per la laurea magistrale -%\esamedidottorato{Novembre 1610}% per il dottorato %\annoaccademico{1615-1616}% solo con l'opzione classica %\annoaccademico{2006-2007}% idem -\ciclodidottorato{XV}% solo per il dottorato + %%%%%%% Logo della sede \logosede{logodue}% questo e' ovviamente facoltativo, ma e' @@ -256,6 +260,7 @@ ai candidati di evitare di riscoprire l'acqua calda. %%%%%%%% fine esperimento % qui comincia automaticamente la main matter +%\expandafter\show\csname NR@part\endcsname \part{Prima Parte} \chapter{Introduzione generale} @@ -332,7 +337,7 @@ misurare la pesantezza; pi\`u precisamente la pesantezza dell'aria riferita all'unit\`a di superficie. \end{interlinea} -\begin{interlinea}{2} Studiando il fenomeno fisico si pu\`o concludere +\begin{interlinea}{1.5} Studiando il fenomeno fisico si pu\`o concludere che in un dato punto grava il peso della colonna d'aria che lo sovrasta, e che tale colonna \`e tanto pi\`u grave quanto maggiore \`e la superficie della sua base; il rapporto fra il peso e la base @@ -379,7 +384,6 @@ terrestre% \dots e che va a capo. }\fi. - La densit\`a del mercurio \`e molto alta e varia con la temperatura come pu\`o desumersi dalla tabella \ref{t:1}. diff --git a/macros/latex/contrib/toptesi/toptesi-it.pdf b/macros/latex/contrib/toptesi/toptesi-it.pdf Binary files differindex 25fb521d83..50bcb44e37 100644 --- a/macros/latex/contrib/toptesi/toptesi-it.pdf +++ b/macros/latex/contrib/toptesi/toptesi-it.pdf diff --git a/macros/latex/contrib/toptesi/toptesi-it.tex b/macros/latex/contrib/toptesi/toptesi-it.tex index 0cb2139025..8798f34e19 100644 --- a/macros/latex/contrib/toptesi/toptesi-it.tex +++ b/macros/latex/contrib/toptesi/toptesi-it.tex @@ -26,46 +26,44 @@ % numerazioneromana,% % libro% ]{toptesi}\errorcontextlines=100 -\ProvidesFile{toptesi-it.tex}[2019-07-04 v.0.9.42 TOPtesi Italian Documentation] +\ProvidesFile{toptesi-it.tex}[2020-05-12 v.0.9.47 TOPtesi Italian Documentation] %%% Il pacchetto imakeidx va caricato prima di pdfx, %%% altrimenti non funziona bene \usepackage{imakeidx}% Vedi documentazione \indexsetup{headers={\indexname}{\indexname}} - -% Avendo caricato il pacchetto filecontents.sty nella classe -% questo ambiente va caricato dopo \documenclass e prima di -% caricare pdfx. -% Viene riscritto tranquillamente ad ogni compilazione. -% -\begin{filecontents*}{\jobname.xmpdata} +%%%% Dal 2020 non c è più bisogno di caricare il pacchetto filecontents.sty +%%%% Basta usare l'ambiente pdsfxmetadata proprio come viene fatto +%%%% qui sotto, prima di caricare il pacchetto pdfx. +\begin{pdfxmetadata} \Title{La classe TOPtesi} \Author{Claudio Beccari} \Publisher{Claudio Beccari} -\Keywords{Monografia di laurea\sep +\Keywords{Manuale di TOPtesi\sep Tesi di laurea\sep Tesi di dottorato\sep classe TOPtesi\sep pdfLaTeX\sep XeLaTeX\sep LuaLaTeX} +\end{pdfxmetadata} -\end{filecontents*} -% \unless\ifXeTeX \usepackage[a-1b]{pdfx}% vedi documentazione \fi \ifPDFTeX \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} - \usepackage{newtxtext,newtxmath,textcomp,textalpha} \usepackage{amsmath,amssymb} + \usepackage{newtxtext,newtxmath,textcomp,textalpha} \setactivedoublequote \else \usepackage{fontspec} - \usepackage{xcolor} - \setmainfont[Ligatures=TeX]{TeX Gyre Termes} - \setsansfont[Ligatures=TeX, Scale=MatchLowercase]{TeX Gyre Heros} + \setmainfont[Ligatures=TeX]{Libertinus Serif} + \setsansfont[Ligatures=TeX]{Libertinus Sans} \setmonofont{UM Typewriter} +% \setmonofont[StylisticSet={1,3}]{Inconsolatazi4} +% \newfontfamily{\greektt}{CMU Typewriter Text} + \setmonofont{NewComputerModern Mono} \newfontfamily{\fetamont}{Fetamont} \newcommand*\MP{{\fetamont METAPOST}\xspace} \newcommand\GuIT{{\fontfamily{lmr}\scshape @@ -79,8 +77,8 @@ LuaLaTeX} \newfontfamily{\greekfont}{GFS Bodoni} \fi -\usepackage{metalogo,longtable,booktabs,array, -tabularx,enumitem,ragged2e,siunitx,curve2e,microtype,wrapfig} +\usepackage{metalogo,longtable,booktabs,array,xcolor, +tabularx,enumitem,ragged2e,siunitx,curve2e,microtype} \usepackage{afterpage,wrapfig} @@ -91,8 +89,8 @@ tabularx,enumitem,ragged2e,siunitx,curve2e,microtype,wrapfig} \newcommand*\Oarg[1]{\texttt{[#1]}} -\NewDocumentCommand\prog{s m}{\textsf{#2}% - \IfBooleanTF{#1}{}{\index{programma!#2@\textsf{#2}}}} +\NewDocumentCommand\prog{s m}{\textsf{\bfseries#2}% + \IfBooleanTF{#1}{}{\index{programma!#2@\textsf{\bfseries#2}}}} \NewDocumentCommand\pack{s m}{\textsf{\slshape#2}% \IfBooleanTF{#1}{}{\index{pacchetto!#2@\textsf{\slshape#2}}}} \NewDocumentCommand\class{s m}{\textsf{\slshape#2}% @@ -153,6 +151,7 @@ tabularx,enumitem,ragged2e,siunitx,curve2e,microtype,wrapfig} \renewcommand\TeXShop{\originalTeX\discretionary{-}{}{}Shop\xspace} \providecommand\TeXworks{} \renewcommand\TeXworks{\originalTeX\discretionary{-}{}{}works\xspace} +\providecommand\TeXLive{\originalTeX\ Live\xspace} \providecommand*\MiKTeX{\mbox{MiK\TeX}\xspace} \providecommand*\TeXLive{\mbox{\originalTeX}\discretionary{-}{}{\,}Live\xspace} @@ -197,7 +196,9 @@ tabularx,enumitem,ragged2e,siunitx,curve2e,microtype,wrapfig} \def\bottomfraction{1} \newcommand*\tasto[1]{\fbox{\sffamily#1}} - +% Questa macro compone le note marginali in bandiera diversa +% a seconda che si trovino sempre nel margine esterno, nelle +% pagine di destra o di sinistra \newcommand*\LRmarginpar[1]{\marginpar[\RaggedLeft#1]{\RaggedRight#1}} @@ -293,6 +294,9 @@ tabularx,enumitem,ragged2e,siunitx,curve2e,microtype,wrapfig} \makeindex[intoc,columns=2] \begin{document} +\hfuzz=10pt +\frenchspacing + % \thispagestyle{empty} @@ -340,13 +344,13 @@ Questo testo serve per descrivere come comporre tipograficamente la tesi di lau \english \sommario -This text describes how to typeset a university master thesis, or the bachelor final report, or the PhD dissertation through the well known typesetting program \LaTeX, or rather through its variants \pdfLaTeX, \XeLaTeX, or \LuaLaTeX; in order to produce the final document in a PDF archivable format according to the ISO regulation \mbox{19005-1} it's necessary to proceed as described in section~\ref{sec:XePDFA}. A PDFA archivable output file is more easily obtained with \LuaLaTeX and \pdfLaTeX. +This text describes how to typeset a university master thesis, or the bachelor final report, or the PhD dissertation through the well known typesetting program \LaTeX, or rather through its variants \pdfLaTeX, \XeLaTeX, or \LuaLaTeX; in order to produce the final document in a PDF archivable format according to the ISO regulation \mbox{19005-1} it's necessary to proceed as described in section~\ref{sec:XePDFA}. A PDF archivable output file is more easily obtained with \LuaLaTeX and \pdfLaTeX. \italiano \ringraziamenti -Ringrazio gli studenti del Politecnico di Torino che mi hanno sollecitato a mettere la mia esperienza a loro disposizione per predisporre e rendere disponibile il software necessario per preparare le loro tesi, monografie o dissertazioni con la qualità che solo \pdfLaTeX, \XeLaTeX\ o \LuaLaTeX\ riescono a produrre.\footnote{La composizione di questo testo di documentazione è stata eseguita con \ifPDFTeX\pdfLaTeX\else \ifLuaTeX\LuaLaTeX\else \XeLaTeX\fi\fi. Il programma di composizione \XeLaTeX\ presenta numerosi vantaggi su \prog*{pdflatex} per quel che riguarda l'uso dei font, anche per la matematica, ma non è ancora (2017) in grado di produrre l'uscita direttamente nel formato PDF, anche se apparentemente lo fa. In realtà la sua uscita è in un formato intermedio che viene poi trasformato automaticamente in PDF. L'esperienza mi insegna che in realtà le limitazioni di \XeLaTeX\ sono pochissime e, con la classe \pack*{toptesi}, la limitazione forse più importante, ma risolvibile, riguarda il formato PDF archiviabile che non è ottenibile direttamente, tanto che bisogna procedere come indicato nel paragrafo~\ref{sec:XePDFA}. Con \LuaLaTeX\ non ci sono le limitazioni di \XeLaTeX, quindi nel seguito si darà sempre la preferenza a \LuaLaTeX.} +Ringrazio gli studenti del Politecnico di Torino che mi hanno sollecitato a mettere la mia esperienza a loro disposizione per predisporre e rendere disponibile il software necessario per preparare le loro tesi, monografie o dissertazioni con la qualità che solo \pdfLaTeX, \XeLaTeX\ o \LuaLaTeX\ riescono a produrre.\footnote{La composizione di questo testo di documentazione è stata eseguita con \ifPDFTeX\pdfLaTeX\else \ifLuaTeX\LuaLaTeX\else \XeLaTeX\fi\fi. Il programma di composizione \XeLaTeX\ presenta numerosi vantaggi su \prog*{pdflatex} per quel che riguarda l'uso dei font, anche per la matematica, ma non è ancora (2020) in grado di produrre l'uscita direttamente nel formato PDF, anche se apparentemente lo fa. In realtà la sua uscita è in un formato intermedio che viene poi trasformato automaticamente in PDF. L'esperienza mi insegna che in realtà le limitazioni di \XeLaTeX\ sono pochissime e, con la classe \pack*{toptesi}, la limitazione forse più importante, ma risolvibile, riguarda il formato PDF archiviabile che non è ottenibile direttamente, tanto che bisogna procedere come indicato nel paragrafo~\ref{sec:XePDFA}. Con \LuaLaTeX\ non ci sono le limitazioni di \XeLaTeX, quindi nel seguito si darà sempre la preferenza a \LuaLaTeX.} \pagestyle{headings} \figurespagetrue @@ -357,7 +361,7 @@ Ringrazio gli studenti del Politecnico di Torino che mi hanno sollecitato a mett %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \chapter{Questo manuale: cosa fare e cosa non fare} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -Prima di prendere ironicamente l'aggettivo `rapida' attribuito a questa guida di più di 170 pagine, vorrei sottolineare che essa è lunga perché TOPtesi permette di svolgere moltissimi compiti. E per comporre bene la propria tesi, le cose da fare sono moltissime e non sono descritte tutte in questa guida. Ma c'è un altro aspetto: comporre tipograficamente non consiste solo nel seguire certe regole tali da far diventare questa operazione una cosa che potrebbe fare qualunque macchina; c'è di mezzo il gusto estetico personale; la materia di cui si tratta nella tesi; il fatto che ogni problema di composizione non ha mai un'unica soluzione; e via di questo passo. Non è un caso che il sistema \TeX offra una moltitudine di pacchetti per comporre tesi, ognuno di quali risolve certi problemi di composizione secondo i gusti di chi ha scritto quella classe, o quel pacchetto, o quel modello. +Prima di prendere ironicamente l'aggettivo `rapida' attribuito a questa guida di più di 170 pagine, vorrei sottolineare che essa è lunga perché \TOPtesi permette di svolgere moltissimi compiti. E per comporre bene la propria tesi, le cose da fare sono moltissime e non sono descritte tutte in questa guida. Ma c'è un altro aspetto: comporre tipograficamente non consiste solo nel seguire certe regole tali da far diventare questa operazione una cosa che potrebbe fare qualunque macchina; c'è di mezzo il gusto estetico personale; la materia di cui si tratta nella tesi; il fatto che ogni problema di composizione non ha mai un'unica soluzione; e via di questo passo. Non è un caso che il sistema \TeX offra una moltitudine di pacchetti per comporre tesi, ognuno di quali risolve certi problemi di composizione secondo i gusti di chi ha scritto quella classe, o quel pacchetto, o quel modello. Ecco, questa guida è lunga perché cerco di spiegare in dettaglio come certi problemi siano stati affrontati in modo che il laureando possa capire come li ho affrontati e quali alternative esistono. @@ -385,7 +389,7 @@ Detto in altre parole, non si cominci nemmeno a leggere questo manuale e non si \end{description} -\section{A cosa serve TOPtesi} +\section{A cosa serve \TOPtesi} Serve per comporre una tesi, sia essa la \emph{monografia} (detta anche \emph{elaborato finale} o \emph{tesi di laurea triennale}) preparata alla fine della laurea triennale, oppure la \emph{tesi di laurea} predisposta alla fine della laurea magistrale, o della laurea a ciclo unico, oppure la \emph{dissertazione di dottorato}. Ciascuna tesi può essere scritta in italiano o in un'altra lingua. @@ -403,13 +407,13 @@ Con la versione 6.x di \TOPtesi il pacchetto viene esteso anche alla compilazion Come tutti i pacchetti che estendono le funzionalità di \LaTeX, \TOPtesi definisce la geometria della pagina e dispone le informazioni accessorie come le testatine e i piedini. Queste impostazioni non sono modificabili né con \TOPtesi né con la maggior parte degli altri pacchetti destinati alle tesi. Più o meno vale il concetto “prendere o lasciare”. Questo è un aspetto importante: \textcolor{red}{la licenza \LaTeX Project Public Licence (LPPL), riportata per esteso nell'appendice della pagina~\pageref{ch:LPPL} consente di apportare modifiche ai file di questo pacchetto, ma solo a certe condizioni. Per non violare queste condizioni, nel caso che si vogliano apportare modifiche ai file del pacchetto, si veda il capitolo~\ref{ch:customise}}. -{\tolerance=3000 Prima di usare \TOPtesi si esaminino i semplici esempi contenuti nei file accessori di questo pacchetto: \file{toptesi-example.pdf}, \file{toptesi-example-luatex.pdf}, \file{topfront.example.pdf}, \texttt{toptesi-example-con-frontespizio.pdf}\index{file!toptesi-example-con-frontespizio.pdf@\texttt{toptesi\discretionary{-}{}{-}example\discretionary{-}{}{-}con\discretionary{-}{}{-}frontespizio.pdf}} e diversi altri che sono variazioni dei precedenti. Si potrà vedere se l'impaginazione aggrada oppure se si desidera un'altra impaginazione; in questo secondo caso ci si rivolga ad altre classi e ad altri pacchetti: in rete non è difficile usare un motore di ricerca per trovare il pacchetto \pack{frontespizio}, le classi \class{sapthesis}, \class {suftesi}, i modelli \file{TesiModerna}, \file{TesiClassica} e diverse altre classi che non cito per brevità, ma segnalo che sono prodotte specialmente nel mondo angloamericano e sono ancor meno adatte ad una personalizzazione multilingue. Alcune di queste classi sono dotate di eccellenti file di documentazione, altre sono usabili grazie a “template” o modelli di tesi scritte facendo uso di testo fittizio, ma tali da rendere immediatamente l'idea di come usare quei software.\par} +{\tolerance=3000 Prima di usare \TOPtesi si esaminino i semplici esempi contenuti nei file accessori di questo pacchetto: \file{toptesi-example.pdf}, \file{toptesi-example-luatex.pdf}, \file{topfront\discretionary{.}{}{.}example.pdf}, \texttt{toptesi-example-con-frontespizio.pdf}\index{file!toptesi-example-con-frontespizio.pdf@\texttt{toptesi\discretionary{-}{}{-}example\discretionary{-}{}{-}con\discretionary{-}{}{-}frontespizio.pdf}} e diversi altri che sono variazioni dei precedenti. Si potrà vedere se l'impaginazione aggrada oppure se si desidera un'altra impaginazione; in questo secondo caso ci si rivolga ad altre classi e ad altri pacchetti: in rete non è difficile usare un motore di ricerca per trovare il pacchetto \pack{frontespizio}, le classi \class{sapthesis}, \class {suftesi}, i modelli \file{TesiModerna}, \file{TesiClassica} e diverse altre classi che non cito per brevità, ma segnalo che sono prodotte specialmente nel mondo angloamericano e sono ancor meno adatte ad una personalizzazione multilingue. Alcune di queste classi sono dotate di eccellenti file di documentazione, altre sono usabili grazie a “template” o modelli di tesi scritte facendo uso di testo fittizio, ma tali da rendere immediatamente l'idea di come usare quei software.\par} Volendo, anche i file sorgente di questi esempi d'uso di \TOPtesi, elencati sopra con i nomi dei corrispondenti file PDF, possono essere usati come modelli; persino il file sorgente di questo manuale può essere usato come modello; basta cercare nelle cartelle dell'installazione di \TOPtesi i file \file{.tex}, copiarseli in una propria cartella personale, cambiare loro il nome (attenzione, questo è importantissimo) e modificarne il contenuto a proprio piacimento. Con un minimo di attenzione si possono eliminare quelle parti che non servono; si possono modificare le opzioni della classe, si possono compilare con diversi motori di tipocomposizione del sistema \TeX. Non è forse fuori luogo sottolineare che l'uso dei modelli può essere molto utile per cominciare, ma fa perdere di vista il fatto che \LaTeX può fare molte più cose di quelle che si inseriscono solitamente negli esempi. Per le tesi di dottorato da svolgere presso la \emph{SCUola di DOttorato} (ScuDo) del Politecnico di Torino esiste un'opzione specifica per invocare altri pacchetti, in aggiunta o al posto di alcuni presenti nella funzionamento ordinario di \TOPtesi, per impostare la lingua inglese per l'intero documento, e per soddisfare le specifiche richieste di questa scuola per il frontespizio e il retrofrontespizio. -Esistono opzioni specifiche anche per le normali tesi triennale, magistrale e dottorale (quest'ultima di tipo generico, non riferita alla scuola di dottorato del Politecnico di Torino), oltre all'opzione per la tesina e a un'opzione di personalizzazione quasi totale, che permette di comporre il frontespizio e il retrofrontespizio della tesi in modo assolutamente libero; questa personalizzazione quasi assoluta si riferisce al solo frontespizio, non agli altri aspetti della tesi, ma per usarla bisogna conoscere l'uso di \LaTeX molto bene. +{\tolerance=1000 Esistono opzioni specifiche anche per le normali tesi triennale, magistrale e dottorale (quest'ultima di tipo generico, non riferita alla scuola di dottorato del Politecnico di Torino), oltre all'opzione per la tesina e a un'opzione di personalizzazione quasi totale, che permette di comporre il frontespizio e il retrofrontespizio della tesi in modo assolutamente libero; questa personalizzazione quasi assoluta si riferisce al solo frontespizio, non agli altri aspetti della tesi, ma per usarla bisogna conoscere l'uso di \LaTeX molto bene.\par} \section{Cosa leggere} Un manuale di solito non è da leggere dalla prima pagina all'ultima. Se ne possono saltare diverse sezioni, ma è bene sapere che cosa si salta, quindi sfogliare rapidamente le pagine che si saltano non fa male. @@ -434,11 +438,15 @@ La codifica di entrata \opt{utf8} è consigliabile anche se si usa \pdfLaTeX, ma Infine il capitolo~\ref{cap:comandispecifici} contiene tutti i comandi e gli ambienti introdotti da \TOPtesi per la composizione del frontespizio e per la sua personalizzazione, per la composizione di strutture di testo o di figure in estensione a quelle normali di \LaTeX, e via di questo passo. +\ifLuaTeX +Questo testo è stato composto scrivendo sia in italiano sia in inglese con alcuni esempi in alte lingue compreso il greco che, appunto, non usa l'alfabeto latino. È stato composto con \LuaLaTeX usando font OpenType distribuiti con l'installazione \TeXLive del sistema \TeX. In particolare, non si sono usati i font di default, che sono costituiti dalla tre famiglie con grazie, senza grazie e a spaziatura fissa della collezione Latin Modern. Invece è stato composto con il Libertinus Serif per il font con grazie; il Libertinus Sans per il font senza grazie, e il New Computer Modern Mono per il font a spaziatura fissa. Più avanti si vedrà come sono stati invocati nel preambolo del file sorgente di questa documentazione. +\fi + \section{Errori da evitare} -Tuttavia si abbia anche cura di \textcolor{red}{non copiare nel preambolo di una tesi da comporre con \TOPtesi un preambolo recuperato dalla tesi di un amico o, peggio ancora, da siti generici della rete!}. Sarebbe una operazione fonte di molte delusioni, perché da una parte potrebbero venire caricati pacchetti incompatibili con \TOPtesi, dall'altro alcuni comandi di \TOPtesi ne potrebbero venire modificati con funzionalità diverse da quelle previste; infine nei siti “non certificati” della rete si trovano versioni obsolete, fonte di innumerevoli delusioni. Potrebbero anche manifestarsi dei conflitti fra pacchetti caricati nel preambolo e quelli già caricati da \TOPtesi. Un modello di tesi copiato da un amico può esporre anche a delusioni incredibili, mancanza di supporto on line e incomprensioni di vario genere e a notevoli perdite di tempo anche quando l'aiuto viene richiesto direttamente a me (per favore, passare sempre attraverso il Forum del \GuIT); a questo proposito si veda quanto scritto nel capitolo~\ref{ch:customise}. \emph{Per questo motivo da questa versione di \TOPtesi, viene fatto un controllo e se la classe non carica la giusta versione del modulo \pack{toptesi.sty}, emette un messaggio molto visibile e termina la compilazione immediatamente} +Tuttavia si abbia anche cura di \textcolor{red}{non copiare nel preambolo di una tesi da comporre con \TOPtesi un preambolo recuperato dalla tesi di un amico o, peggio ancora, da siti generici della rete!}. Sarebbe una operazione fonte di molte delusioni, perché da una parte potrebbero venire caricati pacchetti incompatibili con \TOPtesi, dall'altro alcuni comandi di \TOPtesi ne potrebbero venire modificati con funzionalità diverse da quelle previste; infine nei siti “non certificati” della rete si trovano versioni obsolete, fonte di innumerevoli delusioni. Potrebbero anche manifestarsi dei conflitti fra pacchetti caricati nel preambolo e quelli già caricati da \TOPtesi. Un modello di tesi copiato da un amico può esporre anche a delusioni incredibili, mancanza di supporto on line e incomprensioni di vario genere e a notevoli perdite di tempo anche quando l'aiuto viene richiesto direttamente a me (per favore, passare sempre attraverso il Forum del \GuIT); a questo proposito si veda quanto scritto nel capitolo~\ref{ch:customise}. \emph{Per questo motivo da questa versione~6 di \TOPtesi, viene fatto un controllo e se la classe non carica la giusta versione del modulo \pack{toptesi.sty}, emette un messaggio molto visibile e termina la compilazione immediatamente} -\section{Pacchetti già caricati da TOPtesi} +\section{Pacchetti già caricati da \TOPtesi} Vale la pena di elencare i pacchetti o moduli già caricati dalla classe \class{toptesi}, al fine di evitare di ricaricarli nel preambolo della propria tesi. \begin{description}[noitemsep]\def\Item[#1]{\item[\normalfont\pack{#1}]} \Item[toptesi] è il file di macro di \TOPtesi; potrebbe anche essere usato con una classe diversa da \class{toptesi}; la classe \class{toptesi} però lo carica specificandone la data in modo che se la versione presente sul proprio calcolatore fosse obsoleta, verrebbe almeno generato un avviso (Warning) che lo segnala. @@ -452,7 +460,8 @@ Vale la pena di elencare i pacchetti o moduli già caricati dalla classe \class{ % \Item[xparse] mette a disposizione dell'utente delle macro potentissime per definire altre macro; le sue funzionalità sono state usate in diversi moduli di questo pacchetto; un utente esperto, dopo averne letto la documentazione ed averla capita a fondo, può usare questo pacchetto senza bisogno di andarlo a cercare in rete. % -\Item[fancyvrb] serve per comporre testo verbatim in modo più personalizzabile che con i semplici comandi del nucleo di \LaTeX; tuttavia quando il laureando deve listare i programmi che ha scritto per svolgere le ricerche connesse con la sua tesi, è comodo disporre di un comando che importi un file esterno inserendolo direttamente in modo verbatim nel file della propria tesi. Esistono altri pacchetti che permettono di eseguire questa operazione, ma questo ha la proprietà di lavorare correttamente anche con testi codificati~\opz{utf8}. +\Item[fancyvrb] serve per comporre testo verbatim in modo più personalizzabile che con i semplici comandi del nucleo di \LaTeX; tuttavia quando il laureando deve listare i programmi che ha scritto per svolgere le ricerche connesse con la sua tesi, è comodo disporre di un comando che importi un file esterno inserendolo direttamente in modo verbatim nel file della propria tesi. Esistono altri pacchetti che permettono di eseguire questa operazione, ma questo ha la proprietà di lavorare correttamente anche con testi codificati~\opz{utf8}. In \TOPtesi serve anche per creare un ambiente \amb{pdfxmetadata} in grado di produrre il file che serve al pacchetto \pack{pdfx} per introdurre nel file PDF finale i metadati relativi al particolare documento che si vuole comporre; quei metadati sono richiesti dalle norme ISO sull'archiviabilità. Nel seguito si mostreranno degli esempi. + % \Item[xkeyval] serve per gestire le opzioni con la sintassi \emph{chiave\,$=$\,valore}; è funzionale al lavoro della classe, ma se l'utente sa come gestire queste cose, e ne ha letto la documentazione, può usarlo anche per la definizione di comandi personali dotati di opzioni a chiave. % @@ -466,12 +475,9 @@ Vale la pena di elencare i pacchetti o moduli già caricati dalla classe \class{ % \Item[babel] viene caricato con le opzioni \opt{english} e \opt{italian}, cosicché l'italiano risulta svolgere le funzioni della lingua principale; questo pacchetto viene caricato solo se si compone la tesi con \prog{pdflatex}, che \TOPtesi riconosce da solo grazie all'uso del pacchetto \pack{iftex}. Con l'opzione \chiave{tipotesi}{scudo}, invece, l'inglese viene impostato come lingua principale. % -\Item[polyglossia] viene caricato solo se la tesi viene composta con \XeLaTeX\ o \LuaLaTeX. L'italiano viene specificato come lingua principale, e l'inglese come altra lingua. Con l'opzione \chiave{tipotesi}{scudo} l'inglese viene viene invece impostato come lingua principale. - -% -\Item[pdfx] ora deve venire caricato esplicitamente dall'utente per produrre un file possibilmente conforme al formato PDF/A; nelle versioni precedenti esso veniva caricato specificando l'opzione \opt{pdfa}. Ora l'opzione è ancora attiva, ma il suo scopo è solo quello di emettere l'avviso di consultare la documentazione. Per usare correttamente \pack{pdfx} \TOPtesi carica anche il pacchetto che segue e lo fa indipendentemente dal fatto che si voglia usare \pack{pdfx}. +\Item[polyglossia] viene caricato solo se la tesi viene composta con \XeLaTeX\ o \LuaLaTeX. L'ita"liano viene specificato come lingua principale, e l'inglese come altra lingua. Con l'opzione \chiave{tipotesi}{scudo} l'inglese viene viene invece impostato come lingua principale. % -\Item[filecontents] serve per ridefinire gli ambienti \amb{filecontents} e \amb{filecontents*} in modo che non siano soggetti alle limitazioni degli omonimi ambienti del nucleo di \LaTeX. Quelli originali non si possono usare fuori del preambolo ma si possono usare anche prima della dichiarazione di classe; inoltre gli ambienti originali non permettono di ridefinire il loro contenuto se non dopo aver cancellato a mano il file che l'ambiente creerebbe. Per i file da comporre con \TOPtesi è necessario creare i corrispondenti file con i metadati; ad ogni modifica dei metadati diventerebbe troppo complesso ricordarsi di cancellare i file precedentemente creati; non che sia difficile, ma è facile dimenticarsene e finire con trovare messaggi d'errore incomprensibili oppure file non conformi con le norme PDF/A. +\Item[pdfx] ora deve venire caricato esplicitamente dall'utente per produrre un file possibilmen"te conforme al formato PDF/A; nelle versioni precedenti esso veniva caricato specifi"cando l'opzione \opt{pdfa}. Ora l'opzione è ancora attiva, ma il suo scopo è solo quello di emettere l'avviso di consultare la documentazione. Per usare correttamente \pack{pdfx} \TOPtesi carica anche il pacchetto che segue e lo fa indipendentemente dal fatto che si voglia usare \pack{pdfx}. % \Item[hyperref] serve per comporre i collegamenti ipertestuali. Non è il caso di preoccuparsi di quando \TOPtesi carica \pack{hyperref} perché ci pensa lui a usarlo al momento opportuno. Si veda più avanti per sapere come e quando eventualmente configurare \pack{hyperref} con le sue opzioni. \end{description} @@ -490,7 +496,7 @@ Si noti: usando \prog{pdflatex}, non sono precaricati i pacchetti \pack{inputenc È voluto: \pack{inputenc} non deve essere caricato se si usano \XeLaTeX\ o \LuaLaTeX, ma in entrambi i casi l'editor che si usa per comporre il file sorgente \emph{deve} essere configurato in modo che salvi i file sorgente con la codifica \opt{utf8}. Con \pdfLaTeX\ ci sarebbe una certa libertà nello scegliere la codifica d'entrata, ma, insisto, sarebbe meglio in ogni caso evitare di usare qualunque altra codifica diversa da \opt{utf8}. -Per i font di uscita la o le codifiche da specificare dipendono dalle lingue usate; ripeto la raccomandazione di preferire i font espressamente creati per l'uso con \pdfLaTeX, quando si compone con questo programma; se si usano i programmi \XeLaTeX\ o \LuaLaTeX\ si abbia l'accortezza di usare il pacchetto \pack{fontspec} (che \emph{non} è precaricato) specificandogli le opzioni giuste e caricando poi, mediante le sue funzionalità, i font OpenType di cui si sia accertata la presenza sulla propria macchina e si sia verificato che contengano tutti i glifi che si intendono usare nella tesi. Tanto per sottolineare l'importanza di questa verifica, questi programmi lavorano di default con i font Latin Modern, che, come dice il nome, contengono \emph{solo} i caratteri latini. Se ci fosse bisogno di scrivere in greco o in cirillico, per esempio, allora i font OpenType \Font{CMU}\footnote{Questi font sono distribuiti con il sistema \TeX completo e aggiornato; la sigla CMU sta per \Font{Computer Modern Unicode}; contiene un solo corpo che può essere ingrandito o rimpicciolito a piacere; contiene sia i font latini, sia quelli greci e quelli cirillici; sostanzialmente contiene tutti i glifi greci che sono disponibili con la collezione CBfonts, anche quelli insoliti come `qoppa", `stigma' e `sampi". I font OpenType CMU contengono gli stili Bright, Classical Serif, Concrete, Sans Serif, Sans Serif Demi Condensed, Serif, Serif Extra (sostanzialmente i font della forma slanted), Serif Upright Italic, Typewriter Text, Typewriter Text Variable Width. La collezione è quindi molto completa. Per caricarli con \pack{fontspec} bisogna farlo per nome dei singoli font, e non per famiglia, come si fa abitualmente; bisogna leggere attentamente la documentazione di \amb{fontspec}, perché la cosa non è difficile ma è delicata.} contengono anche questi alfabeti. +Per i font di uscita la o le codifiche da specificare dipendono dalle lingue usate; ripeto la raccomandazione di preferire i font espressamente creati per l'uso con \pdfLaTeX, quando si compone con questo programma; se si usano i programmi \XeLaTeX\ o \LuaLaTeX\ si abbia l'accortezza di usare il pacchetto \pack{fontspec} (che \emph{non} è precaricato) specificandogli le opzioni giuste e caricando poi, mediante le sue funzionalità, i font OpenType di cui si sia accertata la presenza sul proprio calcolatore e si sia verificato che contengano tutti i glifi che si intendono usare nella tesi. Tanto per sottolineare l'importanza di questa verifica, questi programmi lavorano di default con i font Latin Modern, che, come dice il nome, contengono \emph{solo} i caratteri latini. Se ci fosse bisogno di scrivere in greco o in cirillico, per esempio, allora i font OpenType \Font{CMU}\footnote{Questi font sono distribuiti con il sistema \TeX completo e aggiornato; la sigla CMU sta per \Font{Computer Modern Unicode}; contiene un solo corpo che può essere ingrandito o rimpicciolito a piacere; contiene sia i font latini, sia quelli greci e quelli cirillici; sostanzialmente contiene tutti i glifi greci che sono disponibili con la collezione CBfonts, anche quelli insoliti come `qoppa", `stigma' e `sampi". I font OpenType CMU contengono gli stili Bright, Classical Serif, Concrete, Sans Serif, Sans Serif Demi Condensed, Serif, Serif Extra (sostanzialmente i font della forma slanted), Serif Upright Italic, Typewriter Text, Typewriter Text Variable Width. La collezione è quindi molto completa. Per caricarli con \pack{fontspec} bisogna farlo per nome dei singoli font, e non per famiglia, come si fa abitualmente; bisogna leggere attentamente la documentazione di \amb{fontspec}, perché la cosa non è difficile ma è delicata.} contengono anche questi alfabeti. Ecco quindi che la specificazione delle codifiche dei font di uscita è importante per \pdfLaTeX\ perché con questo programma i font predefiniti sono i \Font{Computer Modern} codificati in \opt{OT1}; questi infatti mancano di qualunque segno accentato e non sono nemmeno completamente compatibili con la codifica \acro{ascii}. Questi font preimpostati potevano (forse) andare bene ai primordi dell'esistenza del sistema \TeX ma non vanno bene oggi nemmeno per l'inglese, visto che anche in inglese si fanno citazioni di testi o di nomi di persone o di luoghi in lingue straniere che usano caratteri latini accentati. @@ -502,24 +508,24 @@ Non si è caricato nulla per comporre la bibliografia (eccetto per il modulo Scu Non si sono caricati nemmeno i pacchetti per il disegno programmato come, per esempio, \pack{tikz}; a un laureando in ingegneria certamente servono, a un laureando in letteratura medievale difficilmente potrebbero servire. -Non venga in mente al laureando in discipline che fanno uso della matematica delle grandezze, di caricare quei font che non gli permettono di comporla secondo le norme ISO-UNI; fra questi font incompatibili con le norme ci sono i font \Font{euler}, certamente molto belli, ma non consentono di rispettare le norme ISO-UNI, perché i caratteri non sono sufficientemente inclinati come invece deve essere un buon corsivo matematico (\emph{math italics}) e molti caratteri non sono facilmente distinguibili da quelli da comporre in tondo (\emph{roman}). Le norme ISO-UNI, applicabili alle discipline che usano la matematica delle grandezze, prescrivono un uso molto specifico di font di famiglie e serie diverse, in quanto queste assumono significati particolari per questo tipo di matematica. +Non venga in mente al laureando in discipline che fanno uso della matematica delle grandezze, di caricare quei font che non gli permettono di comporla secondo le norme ISO-UNI; fra questi font incompatibili con le norme ci sono i font \Font{euler}, certamente molto belli, ma non consentono di rispettare le norme ISO-UNI, perché i caratteri non sono sufficientemente inclinati come invece deve essere un buon corsivo matematico (\emph{math italics}) e molti caratteri non sono facilmente distinguibili da quelli da comporre in tondo (\emph{roman}). Le norme ISO-UNI, applicabili alle discipline che usano la matematica delle grandezze, prescrivono un uso molto specifico di font di famiglie, serie e forme diverse, in quanto queste assumono significati particolari per questo tipo di matematica. \section{Pacchetti da non caricare affatto} \textcolor{red}{Non si devono assolutamente caricare pacchetti che modifichino l'aspetto della pagina, né caricare pacchetti che modifichino la composizione dei titoli o delle didascalie o delle note}; eccezionalmente si può caricare il pacchetto \pack{caption}; \TOPtesi verifica se tale pacchetto è stato effettivamente caricato e, nel caso, non definisce nemmeno le macro che esso userebbe per le sue didascalie. -Se si vuole fare questo genere di modifiche, stile della pagina, testatine, piedini, note,~\dots\ è meglio rivolgersi ad altre classi diversamente configurabili; cito fra le tante \class{suftesi}, \class{sapthesis}; ma quando si va a leggerne la documentazione si scopre che tutti vietano la modifica dell'aspetto della pagina o dei titoli o delle didascalie, a meno che quelle stesse classi non dispongano di comandi già predisposti per la personalizzazione di alcuni di quegli elementi. In particolare \class{sufftesi} consente moltissime personalizzazioni che riguardano prevalentemente il testo, oltre alla geometria della pagina; esso è una validissima alternativa a TOPtesi. +Se si vuole fare questo genere di modifiche, stile della pagina, testatine, piedini, note,~\dots\ è meglio rivolgersi ad altre classi diversamente configurabili; cito fra le tante \class{suftesi}, \class{sapthesis}, \class{unifith}; ma quando si va a leggerne la documentazione si scopre che tutti vietano la modifica dell'aspetto della pagina o dei titoli o delle didascalie, a meno che quelle stesse classi non dispongano di loro comandi già predisposti per la personalizzazione di alcuni di quegli elementi. In particolare \class{sufftesi} consente moltissime personalizzazioni che riguardano prevalentemente il testo, oltre alla geometria della pagina; esso è una validissima alternativa a \TOPtesi. Se il laureando va a cercare in rete altri pacchetti per comporre tesi, si trova davanti allo stesso ostacolo. Se la propria università prescrive stili di pagina diversi o mette a disposizione file di classe appositi (di solito piuttosto datati e costruiti male), si renderebbe necessario creare una classe apposita per soddisfare quelle esigenze. Non saprei cosa consigliare, se non ricorrere ad una classe generica, per esempio \class{book}, e caricare tutti i possibili pacchetti di configurazione che si considerino necessari, per arrivare ad un risultato come quello richiesto dalla propria sede universitaria; i pacchetti preconfezionati come \TOPtesi, e gli altri citati sopra, risparmiano questo lavoro, ma sono rigidi. In fondo anche \TOPtesi è costruito così: parte dalla classe \class{report} e vi costruisce attorno quello che si è voluto fare in base a prescrizioni valide per il Politecnico di Torino, ma lungamente discusse e concordate con l'ateneo e poi rese compatibili con le prescrizioni di diverse altre università. Non è certo perfetto, ma è un buon compromesso. -\goodpagebreak[5] +%\goodpagebreak[5] -\section{Comandi e ambienti di TOPtesi} +\section{Comandi e ambienti di \TOPtesi} Nel capitolo~\ref{cap:comandispecifici} sono descritti i comandi specifici e gli ambienti introdotti da \TOPtesi in aggiunta a quelli della classe \class{report} originali o modificati da \TOPtesi. -In particolare, anche se \TOPtesi è costruita sopra la classe \class{report}, dispone dei comandi di ‘super\-zionamento’ \cs{frontmatter},\cs{mainmatter} e \cs{backmatter}, specifici della classe \class{book}, e qui adattati per lo scopo della tesi. Vale la pena ricordare come sono adattati. +In particolare, anche se \TOPtesi è costruita sopra la classe \class{report}, dispone dei comandi di ‘super"zionamento’ \cs{frontmatter},\cs{mainmatter} e \cs{backmatter}, specifici della classe \class{book}, e qui adattati per lo scopo della tesi. Vale la pena ricordare come sono adattati. \begin{description}[noitemsep] \item[\cs{frontmatter}] è l'impostazione di default; non è necessario specificare questo comando; la differenza rispetto alla definizione della classe \class{book} consiste nel fatto che per impostazione predefinita \emph{non} usa la numerazione romana per le pagine; questo tipo di numerazione si può ottenere solo con l'opzione della classe \chiave{numerazioneromana} che, se impostata, modifica l'aspetto dei numeri usando il maiuscoletto per quelli romani, invece delle cifre arabe. I comandi di sezionamento non asteriscati non sono numerati ma sono elencati nell'indice; tuttavia al primo comando \cs{chapter} che il compilatore incontra, passa automaticamente alla \cs{mainmatter}. Per questo i capitoli corrispondenti ai ringraziamenti e al sommario sono ottenuti mediante comandi specifici proprio per non commutare alla \cs{mainmatter}. % @@ -573,10 +579,9 @@ detti anche “word processor”, che fanno parte più o meno di default di ogni dotazione iniziale di qualsiasi PC di qualunque marca e con qualunque sistema operativo. -Fra i vari programmi disponibili, uno in particolare spicca per la sua particolarità: \LaTeX. Veramente esso non è un word processor, anche se a prima vista lo sembrerebbe; il suo scopo non è finalizzato al testo in quanto tale, bensì alla sua composizione tipografica; esso è un programma di \emph{tipocomposizione}. +Fra i vari programmi disponibili per la composizione di testi, uno in particolare spicca per la sua particolarità: \LaTeX. Veramente esso non è un word processor, ma è un programma di \emph{ipocomposizione}: il suo scopo non è finalizzato al testo in quanto tale, bensì alla sua composizione tipografica. Ma il processo avviene in modo sequenziale: l'autore scrive il suo testo badando al contenuto; successivamente il programma lo mette in forma tipografica. -\LaTeX è una specie di linguaggio di programmazione che viene interpretato da altri programmi, come \prog{pdftex}, \prog{xetex}, e \prog{luatex}. La prima versione del sistema \TeX è stata creata nel -1978, ma il programma è usatissimo ancora oggi, naturalmente molto aggiornato e ampliato, e questo fatto è una cosa insolita nel panorama turbolento di novità dell'informatica. +{\tolerance 3000 \LaTeX è un linguaggio di mark-up, una specie di linguaggio di programmazione, che viene interpretato da altri programmi, come \prog{pdftex}, \prog{xetex}, e \prog{luatex}. La prima versione del sistema \TeX è stata creata nel 1978, ma il programma è usatissimo ancora oggi, naturalmente molto aggiornato e ampliato, e questo fatto è una cosa insolita nel panorama turbolento di novità dell'informatica.\par} Secondo me, il suo successo è dovuto a due fatti: (a) esso è stato progettato e implementato da un matematico per comporre i suoi @@ -681,7 +686,7 @@ Si faccia però attenzione alle distribuzioni Debian; sono eccellenti e ne è ga Non solo; \TeXShop ha una impostazione, attivabile e disattivabile in qualunque momento, con la quale le due finestre, quella di editing e quella che mostra il file PDF composto, normalmente indipendenti, possono essere riunite in un unica finestra, ed essere spostate, ridimensionate, abbattute nella task bar, recuperate dalla task bar, come se fossero un oggetto solo. Personalmente trovo questa funzionalità molto comoda specialmente su un laptop. \end{description} -Merita segnalare che per tutte e tre le piattaforme è disponibile e, talvolta, è già installato di default anche l'editor \TeXworks (multipiattaforma) che, con il suo visualizzatore interno, consente di eseguire la ricerca diretta e inversa. Ad alcuni, abituati a interfacce grafiche fornite di molte barre piene di icone per eseguire il possibile e l'impossibile, \TeXworks piace poco perché la sua schermata è minimale, ma c'è un motivo: nei moderni schermi larghi, con rapporto di forma 16:9, lo schermo contiene accostate e senza sovrapposizioni sia la finestra di editing sia quella del testo composto; questo è molto comodo, più di quanto si possa immaginare, per “lavorare” agevolmente il documento da comporre. Benché anche Texmaker e TeXstudio siano in grado di accostare le due schermate, essi consumano molto spazio per le barre superiori, inferiori e laterali, cosicché le vere aree destinate all'editing o alla visualizzazione ne risultano corrispondentemente ristrette, tanto da far preferire \TeXworks sui laptop e ancor di più sui netbook. +Merita segnalare che per tutte e tre le piattaforme è disponibile e, talvolta, è già installato di default anche l'editor \TeXworks (multipiattaforma) che, con il suo visualizza"tore interno, consente di eseguire la ricerca diretta e inversa. Ad alcuni, abituati a interfacce grafiche fornite di molte barre piene di icone per eseguire il possibile e l'impossibile, \TeXworks piace poco perché la sua schermata è minimale, ma c'è un motivo: nei moderni schermi larghi, con rapporto di forma 16:9, lo schermo contiene accostate e senza sovrapposizioni sia la finestra di editing sia quella del testo composto; questo è molto comodo, più di quanto si possa immaginare, per “lavorare” agevolmente il documento da comporre. Benché anche Texmaker e TeXstudio siano in grado di accostare le due schermate, essi consumano molto spazio per le barre superiori, inferiori e laterali, cosicché le vere aree destinate all'editing o alla visualizzazione ne risultano corrisponden"temente ristrette, tanto da far preferire \TeXworks sui laptop e ancor di più sui netbook. Poi sono necessari i programmi accessori per visualizzare sullo schermo e/o stampare su carta i prodotti della composizione. Ognuna delle tre piattaforme tipo può avere già installati sia i visualizzatori dei file in formato \texttt{.dvi}, \texttt{.ps} o \texttt{.pdf}. Il formato \texttt{.dvi} è il formato nativo del sistema \TeX quindi il software per visualizzare e stampare arriva insieme alla distribuzione già installata, però oggi è un formato che non si usa quasi più. Per il formato \texttt{.ps} bisogna disporre di qualcosa come \prog{ghostscript} e/o \prog{GSView} o altri simili software che con Linux sono solitamente già disponibili insieme al sistema. In ogni caso non è difficile trovare in rete i luoghi da dove scaricarli anche per gli altri sistemi operativi. Per il formato \texttt{.pdf} Linux, come al solito, è già attrezzato, ma non è male per tutti e tre i tipi di piattaforma il programma \prog{Adobe Reader} che la Adobe mette a disposizione di chiunque gratuitamente e per tutte le possibili piattaforme\footnote{Sembra che con Linux le cose non siano più così, ma in rete si trovano ancora delle installazioni non recentissime, ma funzionanti, anche per Linux.}. Naturalmente l'\prog{Adobe Reader} è una specie di programma dimostrativo, per altro eccellente; ma credo che la Adobe lo metta a disposizione per far venire l'acquolina in bocca e per invogliare a comperare il prodotto commerciale completo \prog{Adobe Acrobat}; per gli studenti non costa molto in accordo con il programma Education di quell'azienda. Secondo me vale ogni dollaro che costa, ma ovviamente questo giudizio dipende dall'uso che se ne fa. @@ -691,7 +696,7 @@ Anche Emacs (ne esistono versioni per ogni piattaforma), arricchito con il plug- Per le piattaforme Windows il programma di installazione di \MiKTeX\ offriva la possibilità di installare \prog{TeXnicCenter}, ma lo sconsiglio vivamente, perché non è all'altezza delle distribuzioni moderne di \MiKTeX\ e di \TeXLive; oggi mi pare che \MiKTeX\ venga distribuito con TeXstudio. C'è anche lo \emph{shell editor} WinEdt (shareware), ottimo e dalla versione 8 in poi sembra che sia dotato di un visualizzatore integrato PDF (comunque è sincronizzabile con il visualizzatore SumatraPDF). -A me sembra che sul Mac il miglior editor di tutti sia \TeXShop, automaticamente installato quando si usa la distribuzione Mac\TeX. “Migliore” significa qui il giusto compromesso fra la semplicità e l'efficienza e la validissima integrazione con il suo visualizzatore interno che consente di eseguire con un semplice click del mouse il passaggio da un punto della finestra di composizione del file sorgente al punto corrispondente nella finestra del documento composto in formato PDF, e viceversa. Suo “figlio” \TeXworks (multipiattaforma) sembra avere qualche funzionalità in meno (non è così vero), ma ha una interfaccia comodissima per scoprire la codifica di un file \file{.tex} e per convertire il file in un'altra codifica; \TeXShop e \TeXworks sono auto"configurabili per ciascun file \file{.tex} grazie ad alcune righe di commenti speciali da scrivere in testa al file, cosa che rende il loro uso incredibilmente comodo. TeXstudio dalla versione 2.5 in poi è in grado di interpretare le stesse righe speciali di \TeXShop e di autoconfigurarsi di conseguenza (da settembre 2012). Anche \prog{emacs} con il plug in Auctex è in grado di usare righe di autoconfigurazione che però hanno una sintassi diversa da quelle di \TeXShop. Questa affermazione vale anche per \prog{Aquamacs}, che è una applicazione per Mac che integra direttamente \prog{emacs} e Auctex.\looseness=-1 +A me sembra che sul Mac il miglior editor di tutti sia \TeXShop, automaticamente installato quando si usa la distribuzione Mac\TeX. “Migliore” significa qui il giusto compromesso fra la semplicità e l'efficienza e la validissima integrazione con il suo visualizzatore interno che consente di eseguire con un semplice click del mouse il passaggio da un punto della finestra di composizione del file sorgente al punto corrispon"dente nella finestra del documento composto in formato PDF, e viceversa. Suo “figlio” \TeXworks (multipiattaforma) sembra avere qualche funzionalità in meno (è vero, ma sono poche le funzionalità mancanti), ma ha una interfaccia comodissima per scoprire la codifica di un file \file{.tex} e per convertire il file in un'altra codifica; \TeXShop e \TeXworks sono auto"configurabili per ciascun file \file{.tex} grazie ad alcune righe di commenti speciali da scrivere in testa al file, cosa che rende il loro uso incredibilmente comodo. TeXstudio dalla versione 2.5 in poi è in grado di interpretare le stesse righe speciali di \TeXShop e di autoconfigurarsi di conseguenza (da settembre 2012). Anche \prog{emacs} con il plug in Auctex è in grado di usare righe di autoconfigurazione che però hanno una sintassi diversa da quelle di \TeXShop. Questa affermazione vale anche per \prog{Aquamacs}, che è una applicazione per Mac che integra direttamente \prog{emacs} e Auctex.\looseness=-1 Per tutte e tre le piattaforme principali \prog{TeXStudio} offre certi vantaggi che è bene non trascurare; per esempio, la visualizzazione di parti composte del testo da comporre che richiedano più interazione fra il compositore e il software. Permette anche di disporre di una finestra laterale che contiene tutta la struttura ad albero del documento da comporre; cliccando su ogni ramo o rametto di questo albero, il programma sposta la finestra sul punto del file sorgente dove quella sezione comincia. Quasi tutti gli editor disponibili \emph{non} consentono di fare la ricerca inversa con il formato di uscita PDF, ma solo con il formato DVI. \prog{TeXShop} per Mac, e \prog{TeXworks}, \prog{TeXStudio} e \prog{TeXmaker} per tutte le piattaforme permettono di eseguire nativamente la ricerca inversa anche con il formato PDF, e questa particolarità è estremamente comoda. Per le piattaforme Windows esiste il visualizzatore PDF \prog{SumatraPDF} che può essere configurato per interagire con molti editor per poter essere usati assieme sia con la ricerca diretta sia con quella inversa. Va da sé, che se non ci sono esigenze diverse, il formato di uscita PDF è sicuramente quello da preferire. @@ -719,12 +724,13 @@ Il difetto maggiore di questi programmi di composizione sincrona è che distragg \textcolor{red}{Nel seguito partirò dal presupposto che si abbia già una certa conoscenza di \LaTeX e che si conosca la differenza fra \LaTeX, \pdfLaTeX, \XeLaTeX\ e \LuaLaTeX.} -È possibile che qualcuno non abbia conoscenze sufficientemente approfondite a proposito dei programma e del mark-up \XeLaTeX\ e \LuaLaTeX; è un tipo di mark-up molto simile a quello di \pdfLaTeX, ma ha una gestione dei font diversa e può usare anche i font del sistema operativo, senza dover fare nessuna acrobazia per installarli e configurarli. \XeLaTeX\ ha bisogno di attenzioni particolari per quel che riguarda la creazione dei file in formato PDF archiviabile, anche se l'uscita finale è in formato PDF, mentre con \LuaLaTeX\ non è necessaria nessuna specifica attenzione riferita a questo programma di composizione; si possono dare loro in pasto le figure nei formati PDF, PNG, JPG ed EPS ed altri meno noti. Per la gestione delle lingue dispongono di un loro pacchetto \pack{polyglossia} che è specifico per questi programmi. L'uso di \XeLaTeX\ sta guadagnando terreno specialmente fra i linguisti; certamente è un motore di composizione adatto alle tesi di carattere letterario, in particolare se contengono estesi brani composti con “lettere” non appartenenti all'alfabeto latino. Oggi \LuaLaTeX\ può sostituire completamente \XeLaTeX\ anche se talvolta è leggermente più lento nel suo lavoro; in compenso la sua integrazione con il linguaggio di scripting Lua gli permette di fare cose impossibili con gli altri programmi citati. Vedremo più avanti che \LuaLaTeX è indispensabile per creare file archiviabili. +È possibile che qualcuno non abbia conoscenze sufficientemente approfondite a proposito dei programma e del mark-up \XeLaTeX\ e \LuaLaTeX; è un tipo di mark-up molto simile a quello di \pdfLaTeX, ma ha una gestione dei font diversa e può usare anche i font del sistema operativo, senza dover fare nessuna acrobazia per installarli e configurarli. \XeLaTeX\ ha bisogno di attenzioni particolari per quel che riguarda la creazione dei file in formato PDF archiviabile, anche se l'uscita finale è in formato PDF, mentre con \LuaLaTeX\ non è necessaria nessuna specifica attenzione riferita a questo programma di composizione; si possono dare loro in pasto le figure nei formati PDF, PNG, JPG ed EPS ed altri meno noti. Per la gestione delle lingue dispongono di un loro pacchetto \pack{polyglossia} che è specifico per questi programmi. L'uso di \XeLaTeX\ sta guadagnando terreno specialmente fra i linguisti; certamente è un motore di composizione adatto alle tesi di carattere letterario, in particolare se contengono estesi brani composti con “lettere” non appartenenti all'alfabeto latino. Oggi \LuaLaTeX\ può sostituire completamente \XeLaTeX\ anche se talvolta è leggermente più lento nel suo lavoro; in compenso la sua integrazione con il linguaggio di scripting Lua gli permette di fare cose impossibili con gli altri programmi citati. Vedremo più avanti che \LuaLaTeX è praticamente insostituibile per creare file archiviabili. Merita qui segnalare con una tabellina le principali differenze fra \pdfLaTeX, \XeLaTeX\ e \LuaLaTeX, tabella~\ref{tab:pdflatex-vs-xelatex} nella pagina~\pageref{tab:pdflatex-vs-xelatex}. -\begin{table}[!tb]{\centering +\begin{table}[!tb]%\centering \caption[Le principali differenze fra \textsf{pdflatex}, \textsf{xelatex} e \textsf{lualatex}]{Le principali differenze fra \pdfLaTeX, \protect\XeLaTeX\ e \protect\LuaLaTeX }\label{tab:pdflatex-vs-xelatex} +\makebox[\textwidth]{ \begin{tabular}{lp{.3\textwidth}p{.35\textwidth}} \toprule & \centering pdf\LaTeX & \parbox{.35\textwidth}{\centering \XeLaTeX\\ \LuaLaTeX} \tabularnewline @@ -744,7 +750,7 @@ Possibilità di scontornare&\centering SI & \raggedright Ridotta per \XeLaTeX\ m Microgiustificazione& \centering Completa & {\centering Solo protrusione per \XeLaTeX;\par completa per \LuaLaTeX \par}\tabularnewline Formato archiviabile& \centering PDF/A-1b & \centering PDF/A laboriosa con \XeLaTeX;\newline normale con~\LuaLaTeX (*) \tabularnewline \bottomrule -\end{tabular}\par} +\end{tabular}}\par \vspace*{\medskipamount} \small \noindent (*) \XeLaTeX\ con la distribuzione 2016 di \TeXLive, consente la produzione diretta del formato PDF/A, ma richiede delle attenzioni particolari che verranno descritte nel seguito; con \LuaLaTeX\ non ci sono problemi. @@ -852,12 +858,12 @@ Era stata avanzata anche la richiesta di comporre frontespizi inusuali che conse Chiarito il modo di funzionare della versione 6.x di \TOPtesi, merita comunque rilevare ancora altri dettagli. -Ci si ricordi infatti che l'aspetto generale dalla pagina, i font usati o gli altri font alternativi che si possono usare, il frontespizio, e altri elementi che costituiscono il “look” della tesi composta con questa classe, sono abbastanza rigidi; non dico che questa classe sia rigorosamente del tipo “prendere o lasciare”, ma sicuramente non è una classe generica da poter personalizzare a piacere in ogni dettaglio. Ci sono altre classi disponibili già distribuite con il sistema \TeX (aggiornato e completo); ne cito alcune: la classe \class{sapthesis}, impostata sulle prescrizioni dell'università di Roma La~Sapienza, la classe \class{suftesi}, che in realtà non serve solo per comporre tesi, ma serve anche per comporre diversi altri tipi di documenti in diversi formati e con diversi stili. Nessuna di queste classi è configurabile a piacere, ma solo nei limiti delle personalizzazioni previste. Quella più configurabile mi pare sia la classe \class{suftesi}, ma anche questa, esplicitamente predisposta per tesi nel campo delle scienze umane, forse è meno flessibile per le scienze sperimentali. +Ci si ricordi infatti che l'aspetto generale dalla pagina, i font usati o gli altri font alternativi che si possono usare, il frontespizio, e altri elementi che costituiscono il “look” della tesi composta con questa classe, sono abbastanza rigidi; non dico che questa classe sia rigorosamente del tipo “prendere o lasciare”, ma sicuramente non è una classe generica da poter personalizzare a piacere in ogni dettaglio. Ci sono altre classi disponibili già distribuite con il sistema \TeX (aggiornato e completo); ne cito alcune: la classe \class{sapthesis}, impostata sulle prescrizioni dell'università di Roma La~Sapienza; la classe \class{unifith} impostata sulle prescrizioni dell'università di Firenze; la classe \class{suftesi}, che in realtà non serve solo per comporre tesi, ma serve anche per comporre diversi altri tipi di documenti in diversi formati e con diversi stili. Nessuna di queste classi è configurabile a piacere, ma solo nei limiti delle personalizzazioni previste. Quella più configurabile mi pare sia la classe \class{suftesi}, ma anche questa, esplicitamente predisposta per tesi nel campo delle scienze umane, forse è meno flessibile per le scienze sperimentali. \section{Impostazioni standard di \texorpdfstring{\TOPtesi}{TOPtesi}} L'insieme di macro contenute in \TOPtesi realizza esattamente -le specifiche di composizione per le monografie, tesi di laurea e +le specifiche di composi"zione per le monografie, le tesi di laurea e le dissertazioni di dottorato da comporre presso il Politecnico di Torino; l'acronimo TOP sta per \textcolor{red}{TO}rino \textcolor{red}{P}olitecnico e naturalmente gioca un po' anche sull'altro significato della parola inglese “top”. Tuttavia il pacchetto non è stato creato solo per il Politecnico @@ -917,16 +923,16 @@ La classe \class{toptesi} richiede un semplice preambolo e nient'altro. In altre Questo particolare documento contiene un lungo preambolo nel quale sono anche definiti molti comandi che mi sono serviti per comporlo. La parte essenziale, visto che ho compilato il documento con \LuaLaTeX, è la seguente: -\begin{verbatim} +\begin{Verbatim}[fontsize=\setfontsize{10.5}] \documentclass[% corpo=12pt, tipotesi=monografia, twoside ]{toptesi} -\ProvidesFile{toptesi-it.tex}[2019-07-01 v.0.9.42] +\ProvidesFile{toptesi-it.tex}[[2020-05-12 v.0.9.47 TOPtesi Italian Documentation] \usepackage{imakeidx}% Vedi documentazione \indexsetup{headers={\indexname}{\indexname}} -\usepackage[a-1b]{pdfx}%%%% Vedi documentazione +\usepackage[a-1b]{pdfx}%%%% oppure [a-2b] \usepackage{fontspec} \usepackage{xcolor} @@ -935,9 +941,10 @@ Questo particolare documento contiene un lungo preambolo nel quale sono anche de \newcommand\GuIT{{\fontfamily{lmr}\scshape \mbox{{g\raisebox{-0.308em}{\kern-0.562ex u}% \kern-0.15em{I}\kern-0.14em t}}}\xspace} -\setmainfont[Ligatures=TeX]{TeX Gyre Termes} -\setsansfont[Ligatures=TeX, Scale=MatchLowercase]{TeX Gyre Heros} -\setmonofont{UM Typewriter} + +\setmainfont[Ligatures=TeX]{Libertinus Serif} +\setsansfont[Ligatures=TeX]{Libertinus Sans} +\setmonofont{NewComputerModern Mono} \setmainlanguage[babelshorthands]{italian} \setotherlanguage[variant=ancient]{greek} @@ -948,9 +955,9 @@ Questo particolare documento contiene un lungo preambolo nel quale sono anche de \setmathfont{XITS Math} \usepackage{metalogo,longtable,booktabs,array,tabularx, -enumitem,ragged2e,siunitx,curve2e,microtype,wrapfig} +enumitem,ragged2e,siunitx,curve2e,microtype} -\usepackage{afterpage} +\usepackage{afterpage,wrapfig} \unless\ifcsname ver@hyperref.sty\endcsname\usepackage{hyperref}\fi \hypersetup{% @@ -964,7 +971,7 @@ enumitem,ragged2e,siunitx,curve2e,microtype,wrapfig} } ... \makeindex[intoc,columns=2] -\end{verbatim} +\end{Verbatim} Qualche commento non guasta. @@ -972,19 +979,17 @@ Qualche commento non guasta. % \item Le opzioni specificate oltre a \opz{twoside}, che fa parte delle opzioni proprie della classe \class{report}, sono le due nuove opzioni \chiave{tipotesi}{monografia} e \chiave{corpo}{12pt}. Il loro significato è ovvio; la prima specifica che si sta componendo una monografia e la seconda specifica il corpo normale per l'intero documento; i valori \tipotesi{monografia} e \tipotesi{triennale} sono equivalenti; ma siccome non sto scrivendo una tesi triennale, ho preferito usare il valore \tipotesi{monografia}. % -\item Per il corpo avrei potuto specificare un valore qualsiasi (compreso fra 9.5pt e 13.5pt - non per obbligo ma per decenza; usare corpi minori vuol dire rendere quasi illeggibile questa documentazione; usare valori maggiori significherebbe scrivere un testo adatto alla pratica di lettura di un bambino di seconda elementare). Piuttosto si noti che \TOPtesi accetta valori del corpo normale anche fratti; l'utente potrebbe voler specificare, per esempio il \verb|corpo=11.25| e \TOPtesi provvederebbe in merito senza protestare perché usa i font Latin Modern scalabili con continuità a tratti; lo stesso sarebbe possibile usando altri font vettoriali; non è possibile usando i font Computer Modern (codificati in \opz{OT1}) e i font CM-Super (codificati in \opz{T1}), che vengono usati da \pdfLaTeX di default. Con \pdfLaTeX è importantissimo usare almeno i font Latin Modern che, grazie ai corpi ottici, in generale sono migliori dei Times, dei Palatino e di tanti altri font commerciali o gratuiti. Non è vietato usare font diversi, ma lo sconsiglierei se la tesi contiene molta matematica; tutt'al più sarebbero interessanti i font Libertinus che sono associati a una collezione di font matematici in grado di rispettare le norme ISO per i documenti che vertono sulle scienze sperimentali. +\item Per il corpo avrei potuto specificare un valore qualsiasi (compreso fra 9.5pt e 13.5pt - non per obbligo ma per decenza; usare corpi minori vuol dire rendere molto faticosa la lettura di questa documentazione; usare valori maggiori significherebbe scrivere un testo adatto alla pratica di lettura di un bambino di seconda elementare). Piuttosto si noti che \TOPtesi accetta valori del corpo normale anche fratti; l'utente potrebbe voler specificare, per esempio il \verb|corpo=11.25| e \TOPtesi provvederebbe in merito senza protestare perché usa i font Latin Modern scalabili con continuità a tratti; lo stesso sarebbe possibile usando altri font vettoriali; non è possibile usando i font Computer Modern (codificati in \opz{OT1}) e i font CM-Super (codificati in \opz{T1}), che vengono usati da \pdfLaTeX di default. Con \pdfLaTeX è importantissimo usare almeno i font Latin Modern che, grazie ai corpi ottici, in generale sono migliori dei Times, dei Palatino e di tanti altri font commerciali o gratuiti. Non è vietato usare font diversi, ma lo sconsiglierei se la tesi contiene molta matematica; tutt'al più sarebbero interessanti i font Libertinus\footnote{È per questo che ho composto questa documentazione con i font Libertinus, salvo che per i font monospaziati.} che sono associati a una collezione di font matematici in grado di rispettare le norme ISO per i documenti che vertono sulle scienze sperimentali. % \item Il comando \cs{ProvidesFile} non è obbligatorio, ma è sempre conveniente usarlo per identificare non solo il nome del file, ma anche la data dell'ultima modifica e l'eventuale versione. Sono valori che per questa documentazione debbono essere recuperati e scritti nel frontespizio, proprio per l'utilità del lettore. Per una tesi non credo che siano interessanti, ma è buona abitudine scrivere sempre in ogni file queste informazioni che tornano utili all'autore in molte circostanze. % \item Il pacchetto \pack{imakeidx} serve per comporre uno o più indici analitici in modo sincrono; in altre parole basta una sola compilazione per ottenere il documento tipocomposto insieme al suo indice analitico aggiornato al momento della compilazione. -Va caricato prima di \pack{pdfx} perché questo ridefinisce alcune strutture sulle quali \pack{imakeidx} non può più intervenire. +Va caricato prima di \pack{pdfx} perché questo usa il pacchetto \pack{hyperref} e \pack{imakeidx} necessita di modificare alcune strutture che \pack{hyperef} modifica e sulle quali, quindi, \pack{imakeidx} non può più intervenire. % \item Il pacchetto \pack{pdfx} serve per introdurre nel file PDF di uscita anche i metadati richiesti per l'archiviabilità a lungo termine; sono necessari, ma non sono assolutamente sufficienti; essi vanno completati con i metadati specifici del documento da comporre. Si veda l'apposita sezione sull'archiviabilità. - -Tuttavia si noti che ad oggi questo pacchetto è incompatibile con \pack{imakeidx}; per aggirare questa incompatibilità, se si deve produrre un file archiviabile secondo le norme, si proceda come descritto poco sopra in merito all'uso di \pack{imakeidx} caricandolo prima di \pack{pdfx}. % -\item Il pacchetto \pack{fontspec} serve per caricare i font OpenType usati in questa documentazione. +\item Il pacchetto \pack{fontspec} serve per caricare i font OpenType usati in questa documenta"zione. % \item Il pacchetto \pack{xcolor} serve per gestire i colori in modo avanzato. % @@ -992,35 +997,36 @@ Tuttavia si noti che ad oggi questo pacchetto è incompatibile con \pack{imakeid % \item Un discorso simile vale per il comando \cs{GuIT}. % -\item Come font principale con grazie viene scelto un clone dei font \Font{Times}; quelli denominati \Font{TeX Gyre Termes} sono specifici del sistema \TeX. +\item Come font principale con grazie viene scelto il font Libertinus Serif, distribuito e installato con \TeXLive. % -\item Come font lineare, senza grazie, viene specificato un clone dei font \Font{Helvetica}; nuovamente i font \Font{TeX Gyre Heros} fanno parte del sistema \TeX. +\item Come font lineare, senza grazie, viene specificato il font Libertinus Sans, anche questo facente parte del sistema \TeX. % -\item Per i font a spaziatura fissa vengono invece invocati gli \Font{UM Typewriter}, una versione OpenType dei font standard del sistema \TeX; dispongono anche degli alfabeti cirillico e greco, oltre a numerosissimi simboli. +\item Per i font a spaziatura fissa vengono invece invocati i font New Computer Modern Mono che dispongono anche dei caratteri greci e cirillici; anche questi font fanno parte del sistema \TeX. % \item Il pacchetto \pack{polyglossia} per gestire le lingue è già caricato dalla classe; qui si specificano l'italiano e l'inglese, con la prima lingua dichiarata come principale. % \item Si specifica anche la lingua greca, nella sua varietà antica come lingua secondaria. Viene specificata anche questa lingua perché in questa documentazione si parla anche di tesi nelle scienze umane e si fanno esempi in greco antico. % -\item Il pacchetto \pack{amsmath} serve per comporre la matematica avanzata; \pack{unicode-math} serve per accedere non solo ai font matematici OpenType (in questo caso vengono selezionati i font \Font{XITS Math}) ma fornisce tutte le macro compatibili con quelli del sistema \TeX per scrivere la matematica; non occorre invocare altri pacchetti per font matematici, come sarebbe necessario fare se si usasse il programma di composizione \pdfLaTeX. L'opzione \chiave{math-style}{TeX} serve a questo pacchetto per comporre i vari simboli secondo lo standard del sistema \TeX; in alternativa si potrebbero specificare le opzioni \chiave{math-style}{ISO}, per comporre nello stile prescritto dalle norme ISO; \chiave{math-style}{french}, per comporre secondo lo stile francese; \chiave{math-style}{upright}, per comporre tutta la matematica con font non inclinati. Va da sé che gli ultimi due stili sono da evitare accuratamente; lo stile ISO è raccomandato per le tesi in discipline che fanno uso della matematica delle grandezze. +\item Il pacchetto \pack{amsmath} serve per comporre la matematica avanzata; \pack{unicode-math} serve per accedere non solo ai font matematici OpenType (in questo caso vengono selezionati i font \Font{Libertinus Math}) ma fornisce tutte le macro compatibili con quelli del sistema \TeX per scrivere la matematica; non occorre invocare altri pacchetti per font matematici, come sarebbe necessario fare se si usasse il programma di composizione \pdfLaTeX. L'opzione \chiave{math-style}{TeX} serve a questo pacchetto per comporre i vari simboli secondo lo standard del sistema \TeX; in alternativa si potrebbero specificare le opzioni \chiave{math-style}{ISO}, per comporre nello stile prescritto dalle norme ISO; \chiave{math-style}{french}, per comporre secondo lo stile francese; \chiave{math-style}{upright}, per comporre tutta la matematica con font non inclinati. Va da sé che gli ultimi due stili sono da evitare accuratamente; lo stile ISO è necessario per le tesi in discipline che fanno uso della matematica delle grandezze. % \item Si invocano altri pacchetti necessari per la composizione di questa documentazione; \pack{metalogo} serve per scrivere in modo corretto i loghi dei vari programmi; esso è particolarmente importante per il logo \XeLaTeX, che, come si vede, contiene un simbolo particolare, la `E' speculare rispetto alla `E' normale. -I pacchetti \pack{longtaable}, \pack{array}, \pack{booktabs}, \pack{tabularx} servono per gestire tabelle particolari in modo professionale. Il pacchetto \pack{enumitem} serve per configurare le liste; il lettore avrà notato, infatti, che le liste di questa documentazione, compresa quella che si sta leggendo, non hanno le varie voci distanziate verticalmente. Il pacchetto \pack{ragged2e} serve per configurare la composizione in bandiera, in modo che il margine non giustificato non sia troppo seghettato. Il pacchetto \pack{siunitx} serve per gestire i numeri e le unità di misura. Il pacchetto \pack{curve2e} serve per eseguire disegni avanzati nell'ambiente \amb{picture}. Il pacchetto \pack{microtype} serve per gli aggiustamenti fini della composizione dei capoversi. Il pacchetto \pack{wrapfig} mi è servito per includere il logo tondo del \GuIT, come mostrato nella figura~\ref{fig:logotondo}. +I pacchetti \pack{longtaable}, \pack{array}, \pack{booktabs}, \pack{tabularx} servono per gestire tabelle particolari in modo professio"nale. Il pacchetto \pack{enumitem} serve per configurare le liste; il lettore avrà notato, infatti, che le liste di questa documentazione, compresa quella che si sta leggendo, non hanno le varie voci distanziate verticalmente. Il pacchetto \pack{ragged2e} serve per configurare la composizione in bandiera, in modo che il margine non giustificato non sia troppo seghettato. Il pacchetto \pack{siunitx} serve per gestire i numeri e le unità di misura. Il pacchetto \pack{curve2e} serve per eseguire disegni avanzati nell'ambiente \amb{picture}. Il pacchetto \pack{microtype} serve per gli aggiustamenti fini della composizione dei capoversi. Il pacchetto \pack{wrapfig} è servito per includere il logo tondo del \GuIT circondato dal testo, come mostrato nella figura~\ref{fig:logotondo}. % \item Il pacchetto \pack{afterpage} serve per ritardare la composizione dell'argomento del comando \cs{afterpage} proprio alla fine della pagina corrente, prima che si inizi a comporre la pagina successiva. % -\item Successivamente si chiama il pacchetto \pack{hyperref}; in realtà potrebbe essere già stato chiamato dal pacchetto \pack{pdfx} ed è per questo che si usa quello strano test scritto con comandi primitivi di \eTeX, ma non succederebbe niente se lo si chiamasse in questa posizione purché la chiamata sia priva di opzioni; queste però si possono specificare con il successivo comando \cs{hypersetup}. +\item Successivamente si chiama il pacchetto \pack{hyperref}; in realtà è già stato chiamato dal pacchetto \pack{pdfx} ed è per questo che si usa quello strano test scritto con comandi primitivi di \eTeX, ma non succederebbe niente se lo si chiamasse in questa posizione purché la chiamata sia priva di opzioni; queste però si possono specificare con il successivo comando \cs{hypersetup}. % -\item Il preambolo termina con la configurazione dell'indice analitico di questa documentazione. Il comando \cs{makeindex} attiva la raccolta delle informazioni da mettere nell'indice analitico; le sue opzioni specificano alcune impostazioni che si vogliono per la composizione di questo indice; in particolare \opz{intoc} specifica che si desidera l'inserimento della voce “Indice analitico” nell'indice generale. Le opzioni sono per la configurazione sia del comando \cs{index} che raccoglie le voci da indicizzare, e il comando \cs{printindex} che provvede a comporre l'indice analitico e a spedirlo al file di uscita. +\item Il preambolo termina con la configurazione dell'indice analitico di questa documenta"zione. Il comando \cs{makeindex} attiva la raccolta delle informazioni da mettere nell'indice analitico; le sue opzioni specificano alcune impostazioni che si vogliono per la composizione di questo indice; in particolare \opz{intoc} specifica che si desidera l'inseri"mento della voce “Indice analitico” nell'indice generale. Le opzioni sono per la configurazione sia del comando \cs{index}, che raccoglie le voci da indicizzare, sia del comando \cs{printindex}, che provvede a comporre l'indice analitico e a spedirlo al file di uscita. \end{enumerate} In generale per una tesi di qualunque tipo non è necessario ricorrere al caricamento di tanti pacchetti. In ogni caso il laureando caricherà solo quelli che gli servono davvero, senza esagerare con cose del tipo “potrebbe servirmi”. \section{Le opzioni} La classe \class*{toptesi} accetta diverse opzioni sue specifiche, oltre a quelle che si possono specificare per la classe \class*{report}; esse seguono con la sintassi \emph{chiave${}={}$valore}; le chiavi booleane non richiedono espressamente il valore \texttt{true}; di default il loro stato è \texttt{false}. -\begin{description}[noitemsep]\let\Item\item +\begin{description}[noitemsep]%\let\Item\item +\def\Item[#1]{\item[\normalfont#1]} \Item[\chiave{corpo}] - Imposta il corpo del testo normale; il valore preimpostato è + Imposta il corpo del testo normale; il valore preimpostato è \texttt{10pt}, ma si può specificare qualunque valore, anche fratto, non troppo distante da \texttt{11pt}; sotto 9.5\,pt il testo diventa difficile da leggere; sopra 13.5\,pt il testo assume @@ -1033,8 +1039,8 @@ La classe \class*{toptesi} accetta diverse opzioni sue specifiche, oltre a quell nessun valore o specificando \chiave{tipotesi}{topfront}, il frontespizio viene composto con le funzionalità del modulo \pack{topfront}, quello tradizionale usato anche dalle versioni - precedenti di TOPtesi. Gli altri valori possibili sono: - \texttt{custom} per comporre il frontespizio in modo autonomo + precedenti di \TOPtesi. Gli altri valori possibili sono: + \texttt{custom} per comporre il frontespizio in modo autonomo; \texttt{frontespizio} per comporre il frontespizio facendo uso delle funzionalità del pacchetto esterno \pack{frontespizio}; \texttt{triennale} e \texttt{monografia}, alias l'uno dell'altro, @@ -1063,7 +1069,7 @@ La classe \class*{toptesi} accetta diverse opzioni sue specifiche, oltre a quell \Item[\chiave{oldstyle}] Chiave booleana che permette di comporre i numeri con le cifre minuscole, invece che con quelle maiuscole; si può usare solo se è in - vigore l'opzione \chiave{stile}{classica}. + vigore lo stile classico selezionato con l'opzione \chiave{stile}{classica}. \Item[\chiave{autoretitolo}] Chiave booleana che modifica le testatine in modo da farvi comparire il nome dell'autore e il titolo della tesi. Si può @@ -1071,9 +1077,9 @@ La classe \class*{toptesi} accetta diverse opzioni sue specifiche, oltre a quell \chiave{stile}{classica}. \Item[\chiave{numerazioneromana}] Chiave booleana che imposta la numerazione romana dei numeri di - pagina nella parte preliminare del corpo della tesi; la numerazione + pagina nella parte preliminare della tesi; la numerazione cambia in cifre arabe con il primo uso del comando \cs{chapter}. Per - questo motivo i ringraziamenti e il sommanrio vanno composti con i + questo motivo i ringraziamenti e il sommario vanno composti con i comandi appositi \cs{ringraziamenti} e \cs{sommario}; ricordo che i ringraziamenti non dovrebbero mai apparire in una tesi, se non in alcune situazioni particolari; il sommario non è inteso come @@ -1103,7 +1109,7 @@ La classe \class*{toptesi} accetta diverse opzioni sue specifiche, oltre a quell Se non viene specificato nulla, questa chiave non imposta nessuna “binding correction”; se impostata senza specificare un valore, imposta una correzione di 7\,mm (che è già tanto); se si - specifica un valore quello viene preso per spostare verso + specifica un valore, quello viene preso per spostare verso l'esterno la gabbia di stampa. Non usare questa correzione con l'opzione \chiave{libro} a meno che il “libro” non venga rilegato con cucitura trasversale; usare con valori @@ -1124,34 +1130,55 @@ La classe \class*{toptesi} accetta diverse opzioni sue specifiche, oltre a quell può usare questa opzione per impedire al modulo \pack{toptesi-scudo} di caricare automaticamente qualsiasi cosa riguardi la bibliografia; del resto qualunque altro laureando e diplomando deve provvedere - autonomamente ai pacchetti necessari per comporre la o le sue - bibliografie. + autonomamente ai pacchetti necessari per comporre la sua + bibliografia. \Item[\chiave{chapterbib}] Chiave booleana conservata per compatibilità con il passato; sarebbe servita per predisporre una bibliografia particolare alla fine di ogni capitolo. Andava bene all'inizio degli anni novanta; oggi si ottengono risultati migliori usando il pacchetto \pack{biblatex} con le sue particolari opzioni. +\Item[\chiave{nocenterfolio}] + Il numero della pagina (\emph{folio} in inglese) viene normalmente + inserito al centro del piedino; specificando questa opzione booleana il + numero della pagina viene collocato adiacente al margine esterno + nel piedino. +\Item[\chiave{nocenterhead}] + Normalmente il testo per le testatine viene composto centrato; se si + specifica questa opzione booleana quel testo viene composto adiacente + al margine esterno. +\Item[\chiave{folioinhead}] + Normalmente il numero della pagina si trova nel piedino; specificando + questa opzione booleana il numero della pagina viene composto nel + margine esterno fuori della testatina, distanziato ma allineato + col testo della testatina. Questa opzione è di utilità discutibile; + ma se il testo della testatina è centrato, si può usare questa + collocazione del numero della pagina, anche se sarebbe preferibile + non farlo; se invece il testo della testatina è adiacente al + margine esterno, il risultato è decisamente brutto, nonostante + lo spazio che separa il numero della pagina dalla testatina. + Perciò si raccomanda di non usare mai contemporaneamente le + opzioni booleane \chiave{folioinhead} e \chiave{nocenterhead}. \end{description} Di tutte queste chiavi si parlerà più diffusamente nell'ultimo capitolo dove si mostrano e si commentano tutti i comandi e le opzioni disponibili con \TOPtesi. Anche nei paragrafi dove si descrivono i vari tipi di tesi si esaminano alcune opzioni specifiche. -\section{I file accessori} +\section{I moduli accessori} -Qui verranno descritti alcuni usi del modulo \pack{topfront} e degli altri moduli specifici per determinati tipi di tesi; si descrive brevemente anche il modulo \pack{topcoman}. I primi servono per comporre il frontespizio; il secondo mette a disposizione alcuni comandi utili. Né gli uni né l'altro sono indispensabili, ma sono utili. Questi pacchetti sono sempre caricati da \TOPtesi, tranne in alcuni casi specificati meglio più avanti. Ma il fatto di venire o non venire caricati dipende dall'utente, cioè dalle opzioni che egli specifica alla classe \class{toptesi} e dai pacchetti aggiuntivi che egli vuole usare; in altre parole l'utente non ha mai bisogno di caricare esplicitamente questi due pacchetti ma può solo esplicitamente specificare azioni che ne impediscono il caricamento. +Qui verranno descritti alcuni usi del modulo \pack{topfront} e degli altri moduli specifici per determinati tipi di tesi; si descrive brevemente anche il modulo \pack{topcoman}. I primi servono per comporre il frontespizio; il secondo mette a disposizione alcuni comandi utili. Né gli uni né l'altro sono indispensabili, ma sono utili. Questi pacchetti sono sempre caricati da \TOPtesi, tranne in alcuni casi specificati meglio più avanti. Ma il fatto di venire o non venire caricati dipende dall'utente, cioè dalle opzioni che egli specifica alla classe \class{toptesi} e dai pacchetti aggiuntivi che egli vuole usare; in altre parole l'utente non ha mai bisogno di caricare esplicitamente questi moduli ma può solo esplicitamente specificare azioni che ne impediscono il caricamento. %\goodpagebreak \subsection{La composizione del frontespizio} Questo paragrafo tratta di diversi modi per comporre il frontespizio della tesi; per il frontespizio della tesi dottorale della ScuDo si rinvia ad un paragrafo specifico per tutto quanto riguarda la tesi di quella scuola (paragrafo~\ref{sec:scudo}). -Non è generalmente necessario inserire nel frontespizio il logo dell'ateneo; si controllino presso la propria segreteria competente le regole fissate per la composizione del frontespizio. Se il logo è richiesto, allora la segreteria dice anche quale logo usare e da dove scaricarne il file che ne contiene la descrizione grafica; \textcolor{red}{bisogna essere precisi nel richiedere le limitazioni legali per l'uso del logo dell'ateneo, perché esso è proprietà esclusiva dell'ateneo e l'uso indebito potrebbe essere fonte di problemi legali non indifferenti.} Siccome tali limitazioni esistono, il pacchetto \TOPtesi viene distribuito senza i file dei loghi di diversi atenei, come veniva fatto nelle prime edizioni. +Non è generalmente necessario inserire nel frontespizio il logo dell'ateneo; si controlli"no presso la propria segreteria competente le regole fissate per la composizione del frontespizio. Se il logo è richiesto, allora la segreteria dice anche quale logo usare e da dove scaricarne il file che ne contiene la descrizione grafica; \textcolor{red}{bisogna essere precisi nel richiedere le limitazioni legali per l'uso del logo dell'ateneo, perché esso è proprietà esclusiva dell'ateneo stesso e l'uso indebito potrebbe essere fonte di problemi legali non indifferenti.} Siccome tali limitazioni esistono, il pacchetto \TOPtesi viene distribuito senza i file dei loghi di diversi atenei, come veniva fatto nelle prime edizioni. Si controlli se il file del logo è vettoriale (estensione \file{.pdf} oppure \file{.eps}), oppure bitmapped (estensione \file{.jpg}, \file{.png}, \file{.bmp}, \file{.wmf}, \file{.tiff},~\dots). Ci si ricordi che \prog{pdflatex}, \prog{xelatex} e \prog{lualatex} possono incorporare solo i formati \file{.pdf}, \file{.eps}, \file{.jpg}, \file{.png} o \file{.mps}\footnote{I file vettoriali in formato \file{.mps} sono ottenuti con il programma \MP; il lettore potrà interessarsi a questo formato quando sarà un utente avanzato di \LaTeX; non se ne preoccupi per la tesi.}. Se il file bitmapped viene fornito in un formato diverso da questi cinque, è necessario convertirlo in uno dei formati accettati. -Vale la pena di ricordare che il formato \file{.jpg} va bene per immagini a colori sfumati come le fotografie, mentre il formato \file{.png} è più adatto per disegni al tratto con righe fortemente contrastate rispetto allo sfondo. Per le fotografie, tranne rarissime eccezioni, il formato \file{.jpg} va benissimo; è sconsigliabile, al contrario, usare il formato \file{.png} per una fotografia perché con la sua compressione lossless la sua dimensione in byte potrebbe essere anche una decina di volte maggiore della corrispondente fotografia nel suo formato \file{.jpg}, che beneficia di una compressione di tipo lossy, generalmente con pochi effetti su una immagine priva di forti contrasti di colore, come succede, invece, per un disegno al tratto. In generale, quindi, sarebbe meglio convertire nel formato \file{.png} un logo bitmapped fornito in un formato diverso da quelli elencati sopra, ma il formato \file{.png} potrebbe contenere delle “trasparenze” che non sono accettabili con le prescrizioni PDF/A dei documenti archiviabili e in questo caso bisogna ricorrere al formato \file{.jpg}. Potendone disporre, sarebbe sempre meglio usare un disegno veramente vettoriale del logo. +Vale la pena di ricordare che il formato \file{.jpg} va bene per immagini a colori sfumati come le fotografie, mentre il formato \file{.png} è più adatto per disegni al tratto con righe fortemente contrastate rispetto allo sfondo. Per le fotografie, tranne rarissime eccezioni, il formato \file{.jpg} va benissimo; è sconsigliabile, al contrario, usare il formato \file{.png} per una fotografia perché con la sua compressione lossless la sua dimensione in byte potrebbe essere anche una decina di volte maggiore della corrispondente fotografia nel suo formato \file{.jpg}, che beneficia di una compressione di tipo lossy; questo tipo di compressione generalmente ha pochi effetti su una immagine priva di forti contrasti di colore, come succede, invece, per un disegno al tratto. In generale, quindi, sarebbe meglio convertire nel formato \file{.png} un logo bitmapped fornito in un formato diverso da quelli elencati sopra, ma il formato \file{.png} potrebbe contenere delle “trasparenze” che non sono accettabili con le prescrizioni PDF/A di livello~1 dei documenti archiviabili e in questo caso bisogna ricorrere al formato \file{.jpg}. Potendone disporre, sarebbe sempre meglio usare un disegno veramente vettoriale del logo. -Merita segnalare che le tesi svolte nell'ambito di collaborazioni fra atenei possono richiedere i loghi dei diversi atenei partecipanti all'accordo; segnalo la Scuola Interpolitecnica di Dottorato condotta nell'ambito di un accordo fra i politecnici di Bari, Milano e Torino. Ricordo i programmi di doppia laurea condotti nell'ambito di accordi fra l'ateneo di appartenenza e un altro ateneo, generalmente europeo. Ricordo il programma europeo Erasmus Mundus dove il titolo di studio viene rilasciato da consorzi di almeno quattro atenei di nazioni europee diverse. In queste circostanze è spesso necessario inserire nel frontespizio i loghi di tutti gli atenei partecipanti alla convenzione. +Merita segnalare che le tesi svolte nell'ambito di collaborazioni fra atenei possono richiedere i loghi dei diversi atenei partecipanti all'accordo; segnalo la Scuola Interpolitec"nica di Dottorato condotta nell'ambito di un accordo fra i politecnici di Bari, Milano e Torino. Ricordo i programmi di doppia laurea condotti nell'ambito di accordi fra l'ateneo di appartenenza e un altro ateneo, generalmente europeo. Ricordo il programma europeo Erasmus Mundus dove il titolo di studio viene rilasciato da consorzi di almeno quattro atenei di nazioni europee diverse. In queste circostanze è spesso necessario inserire nel frontespizio i loghi di tutti gli atenei partecipanti alla convenzione. \subsection{Il logo dell'ateneo per l'uso con \TOPtesi}\label{ssec:loghi} @@ -1163,21 +1190,21 @@ oppure \medskip \cs{logosede}\oarg{altezza}\marg{lista di nomi di file di loghi separati da virgole} \end{flushleft} -dove il valore prefissato per l'\meta{altezza} del logo è 25\,mm per la carta A4, ed è scalato proporzionalmente per carte di formato diverso; con l'argomento facoltativo si può specificare un'altezza leggermente maggiore o minore del valore predefinito. L'argomento \meta{nome del file del logo} o \meta{lista di nomi di file di loghi separati da virgole} è costituito da un solo nome di file o da una lista di nomi di file separati da virgole, corrispondenti ciascuno al logo di un diverso ateneo. Questi file devono avere i formati corrispondenti a una delle cinque estensioni consentite, ma non è necessario specificare il nome del file completo di estensione; questa specificazione potrebbe essere necessaria solo nel caso in cui si disponga del logo di uno stesso ateneo in diversi formati grafici (o, cosa da non fare mai, immagini o loghi diversi con il nome del loro file uguale e l'estensione diversa; questo genere di pasticci è fonte di numerosi errori, facilmente evitabili se si mantiene in ordine la scelta dei nomi e delle estensioni). +dove il valore prefissato per l'\meta{altezza} del logo è 25\,mm per la carta A4, ed è scalato proporzionalmente per carte di formato diverso; con l'argomento facoltativo si può specificare una \meta{altezza} leggermente maggiore o minore del valore predefinito. L'argomento \meta{nome del file del logo} o \meta{lista di nomi di file di loghi separati da virgole} è costituito da un solo nome di file o da una lista di nomi di file separati da virgole, corrispondenti ciascuno al logo di un diverso ateneo. Questi file devono avere i formati corrispondenti a una delle cinque estensioni consentite, ma non è necessario specificare il nome del file completo di estensione; questa specificazione potrebbe essere necessaria solo nel caso in cui si disponga del logo di uno stesso ateneo in diversi formati grafici (o, cosa da non fare mai, immagini o loghi diversi con il nome del loro file uguale e l'estensione diversa; questo genere di pasticci è fonte di numerosi errori, facilmente evitabili se si mantiene in ordine la scelta dei nomi e delle estensioni). Il programma codificato nel modulo \pack{topfront} provvede a scalare tutti i loghi all'\meta{altezza} specificata e li compone affiancati su una sola riga distanziati mediante uno spazio predefinito di 3\,em; lo si può impostare ad un valore leggermente maggiore o minore tramite il comando \cs{setlogodistance}, per esempio: \begin{verbatim} \setlogodistance{2em} \end{verbatim} -Se la riga di loghi, eventualmente scalati in altezza e distanziati dello spazio predefinito o esplicitamente specificato, risultasse più larga della giustezza della pagina del titolo, il programma provvede ad uno scalamento dell'intera riga di loghi in modo che non superi la giustezza della pagina. Un solo logo viene composto centrato; due o più loghi vengono ugualmente composti centrati ma distanziati come si è detto. Seguono alcuni esempi, ma si tenga presente che i loghi usati per questi esempi sono solo dei disegni creati in modo tale da avere la forma di un logo; loghi veri di diverse università non sono distribuiti insieme a \TOPtesi, a causa delle restrizioni sulla loro proprietà legale; anche un logo \emph{finto} del Politecnico di Torino appare nel frontespizio; il logo è finto, ed è marcato nello sfondo con la dicitura “FAKE LOGO”, per i motivi legali detti sopra. Un solo logo appare come nel frontespizio di questo manuale; due loghi appaiono così:\\*[2pt] +Se la riga di loghi, eventualmente scalati in altezza e distanziati dello spazio predefinito o esplicitamente specificato, risultasse più larga della giustezza della pagina del titolo, il programma provvede ad uno scalamento dell'intera riga di loghi in modo che non superi la giustezza della pagina. Un solo logo viene composto centrato; due o più loghi vengono ugualmente composti centrati ma distanziati come si è detto. Seguono alcuni esempi, ma si tenga presente che i loghi usati per questi esempi sono solo dei disegni creati in modo tale da avere la forma di un logo; loghi veri di diverse università non sono distribuiti insieme a \TOPtesi, a causa delle restrizioni sulla loro proprietà legale; anche il logo del Politecnico di Torino che appare nel frontespizio è finto, ed è marcato nello sfondo con la dicitura “FAKE LOGO”, per i motivi legali detti sopra. Un solo logo appare come nel frontespizio di questo manuale; due loghi appaiono così:\\*[2pt] \makebox[\textwidth]{\logosede{logouno.pdf,logodue.pdf}\printloghi} \noindent Tre loghi appaiono così:\\*[\medskipamount] \makebox[\textwidth]{\logosede{logodue.pdf,logotre.pdf,logoquattro.pdf} \printloghi} -\noindent Quattro loghi, nonostante sia stata conservata l'\meta{altezza} predefinita, producono automaticamente una riga di loghi di altezza e larghezza ridotte per consentire che appaiano tutti e quattro nella stessa riga:\\*[\medskipamount] +\noindent Quattro loghi, nonostante sia stata conservata l'\meta{altezza} predefinita, producono automati"camente una riga di loghi di altezza e larghezza ridotte per consentire che appaiano tutti e quattro nella stessa riga:\\*[\medskipamount] \makebox[\textwidth]{\logosede{logoquattro.pdf,logouno.pdf,logotre.pdf,logodue.pdf} \printloghi} @@ -1193,13 +1220,13 @@ Di \tipotesi{custom} si è già detto; però nel seguito si mostrerà un esempio Lo si ripete: il modulo \pack{topfront} rimane per compatibilità con il passato; secondo me è più comodo servirsi dei moduli dedicati, ma nessuno vieta di usarlo. Tuttavia, visto che è onnicomprensivo e servirebbe per comporre i frontespizi di tutti e tre i tipi di tesi universitarie, \tipotesi{triennale}, \tipotesi{magistrale} e \tipotesi{dottorale}, esso ha un codice complesso per gestire correttamente tre varietà diverse. -Gli altri moduli hanno il codice decisamente più semplice, quindi più facile da tenere in ordine, correggere e aggiornare; ma sono anche più semplici da usare per l'utente finale. +Gli altri moduli hanno il codice decisamente più semplice, quindi più facile da tenere in ordine, correggere e aggiornare e, ancora più importante, sono anche più semplici da usare per l'utente finale. \subsection{Comporre il frontespizio con topfront}\label{sec:frontespizi} -Il pacchetto \TOPtesi contiene fra le sue parti il file \pack{topfront} che serve solo per comporre il frontespizio; può essere usato per comporre il solo frontespizio separatamente dalla tesi, ma in questo caso, talvolta, può essere meglio ricorrere a quanto esposto nel paragrafo~\ref{sec:solofrontespizio}. Attenzione: qui si sta parlando del modulo \pack{topfront} non degli altri moduli specializzati. +Il pacchetto \TOPtesi contiene fra le sue parti il file \pack{topfront} che serve solo per comporre il frontespizio; può essere usato per comporre il solo frontespizio separatamente dalla tesi, ma in questo caso, talvolta, può essere meglio ricorrere a quanto esposto nel paragrafo~\ref{sec:solofrontespizio}. Attenzione: qui si sta parlando del modulo \pack{topfront} non degli altri moduli specializzati. -In questo paragrafo, comunque, spiego come comporre il frontespizio indipendentemente dal fatto che rappresenti il frontespizio isolato della tesi o sia quello della tesi intera. Questo pacchetto in effetti, oltre a leggere l'eventuale file di configurazione, contiene solo i comandi per definire gli elementi del frontespizio e per comporlo. +In questo paragrafo, comunque, spiego come comporre il frontespizio indipendente"mente dal fatto che rappresenti il frontespizio isolato della tesi o sia quello della tesi intera. Questo pacchetto in effetti, oltre a leggere l'eventuale file di configurazione, contiene solo i comandi per definire gli elementi del frontespizio e per comporlo. Basta predisporre un piccolo file come questo, salvandolo con un nome a piacere, per esempio, con grande fantasia, \file{myfile.tex}: @@ -1211,7 +1238,7 @@ un nome a piacere, per esempio, con grande fantasia, \file{myfile.tex}: \verb|%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%| \% Impostazioni per comporre con XeLaTeX o LuaLaTeX \verb|\setmainfont[Ligatures=TeX]{TeX Gyre Termes}% o altro font| -\verb|\setotherlanguage{french}% o altra lingua| +\verb|\setotherlanguage{french}% o altra lingua| \verb|%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%| ~ \meta{\color{red}il resto del preambolo} @@ -1239,24 +1266,23 @@ un nome a piacere, per esempio, con grande fantasia, \file{myfile.tex}: La parte che ho indicato con \meta{il resto del preambolo} e \meta{il resto della tesi} sono facoltative; certo sono necessarie quando si compone l'intera tesi; per comporre il solo frontespizio si possono omettere. -Perciò bisogna fare attenzione: se si compone il frontespizio separatamente dalla tesi, la riga \cs{documentclass} deve essere identica alla corrispondente riga del main file della tesi; siccome \pack{toptesi} può usare diversi formati di carta, è necessario che il frontespizio sia composto su carta dello stesso formato. Non è invece necessario usare come font normale un font dello stesso corpo della tesi; con carte particolarmente piccole potrebbe essere più opportuno usare il corpo di 10\,pt invece che quello di 12\,pt. Se si deve scrivere in un'altra lingua diversa dall'italiano e dall'inglese lo si specifica con \cs{setotherlanguage} con le modalità che verranno esposte più avanti. Si noti che l'esempio precedente è impostato per comporre il frontespizio con \XeLaTeX o con \LuaLaTeX, ma se si lavora con \pdfLaTeX, allora vanno specificati i font da usare, e le codifiche di entrata e di uscita; bisogna anche impostare la lingua nella maniera specifica di \pack{babel}. Non scendo nei dettagli, perché fra i vari modelli forniti con il pacchetto \TOPtesi, ce ne sono alcuni predisposti per lavorare con \pdfLaTeX\ e altri con \XeLaTeX\ o \LuaLaTeX. +Perciò bisogna fare attenzione: se si compone il frontespizio separatamente dalla tesi, la riga \cs{documentclass} deve essere identica alla corrispondente riga del main file della tesi; siccome \pack{toptesi} può usare diversi formati di carta, è necessario che il frontespizio sia composto su carta dello stesso formato. Non è invece necessario usare come font normale un font dello stesso corpo della tesi; con carte particolarmente piccole potrebbe essere più opportuno usare il corpo di 10\,pt invece che quello di 12\,pt. Se si deve scrivere in un'altra lingua diversa dall'italiano e dall'inglese lo si specifica con \cs{setotherlanguage} con le modalità che verranno esposte più avanti. Si noti che l'esempio precedente è impostato per comporre il frontespizio con \XeLaTeX o con \LuaLaTeX, ma se si lavora con \pdfLaTeX, allora vanno specificati i font da usare, e le codifiche di entrata e di uscita; bisogna anche impostare la lingua nella maniera specifica di \pack{babel}. Non scendo nei dettagli, perché fra i vari modelli forniti con \TOPtesi, ce ne sono alcuni predisposti per lavorare con \pdfLaTeX\ e altri con \XeLaTeX\ o \LuaLaTeX. -Comunque, se si vuole usare \prog{pdflatex}, la parte fra le prime due righe \verb|%%%| -va sostituita, per esempio, con: +Comunque, se si vuole usare \prog{pdflatex}, la parte fra le prime due righe \verb|%%%| va sostituita, per esempio, con: \begin{verbatim} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % Impostazioni per comporre con pdfLaTeX \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} -\usepackage{newtxtext}% o altro font +\usepackage{newtxtext}% o altro font %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \end{verbatim} -Ma se si deve scrivere il frontespizio in un'altra lingua bisogna agire come spiegato poco più avanti. +Se si deve scrivere il frontespizio in un'altra lingua bisogna agire come spiegato poco più avanti. In realtà il pacchetto \pack{topfront} lavora bene in italiano e distingue i singolari dai plurali, i maschili dai femminili; non fa nulla di particolare se la lingua di composizione del frontespizio è l'inglese o un'altra lingua; ci si ricordi che l'inglese è già impostato ma non attivato (tranne per le tesi della ScuDo, per le quali la lingua principale è l'inglese, ovviamente già attivata); lo si attiva nel main file con il comando \cs{english}. Se si vuole comporre il frontespizio in un'altra lingua, diversa dalle due preimpostate, allora, usando \prog{xelatex} o \prog{lualatex}, la si specifica mediante il comando \cs{setotherlanguage}; invece usando \pdfLaTeX\ la si indica fra le opzioni di \cs{documentclass} e poi, prima di usare l'ambiente \amb{frontespizio} o \amb{frontespizio*} o i comandi corrispondenti, la si imposta con \cs{selectlanguage}. Poi si inseriscono i seguenti comandi, modificando gli argomenti in accordo con le restrizioni burocratiche per i frontespizi delle tesi nella propria università\footnote{Le parole fisse in questo esempio sono in inglese; bisogna fare altrettanto per qualunque altra lingua.}: \begin{Verbatim}[fontsize=\small] \retrofrontespizio{This work is subject to the Creative Commons Licence} -\DottoratoIn{Ph.D.\ Course in} +\DottoratoIn{Ph.D.\ Course in } \NomeMonografia{Bachelor Degree Thesis} \TesiDiLaurea{Master Degree Thesis} \NomeDissertazione{Ph.D.\ Dissertation} @@ -1339,18 +1365,18 @@ un programma sconosciuto\fi\fi\fi\ il \today \vspace*{5\baselineskip}} \end{verbatim} -Tutti i test che compaiono nell'ultimo capoverso sono funzionali per questa documentazione il cui file è predisposto per essere compilato con tutti e tre i programmi disponibili. Chiaramente una tesi non deve avere questa versatilità e può avere il preambolo concepito per un solo tipo di programma di composizione. +Tutti i test che compaiono nell'ultimo capoverso sono funzionali per questa documen"tazione il cui file è predisposto per essere compilato con tutti e tre i programmi disponibili. Chiaramente una tesi non deve avere questa versatilità e può avere il preambolo concepito per un solo tipo di programma di composizione. Non bisogna dimenticare che, se si vuole usare \prog{xelatex} o \prog{lualatex}, l'editor con cui vengono scritti i file sorgente deve essere configurato per registrarli sul disco fisso con la codifica \texttt{UTF-8}. Mi sono ripetuto? Sì, l'ho fatto apposta, perché è molto facile dimenticarsene. -Nell'esempio di frontespizio presentato nella pagina~\pageref{fig:altri4frontespizi} si è usato l'ambiente \amb{frontespizio*} che è disponibile a partire dalla versione~ 5.85 del pacchetto \TOPtesi. I comandi omonimi \cs{frontespizio} e \cs{frontespizio*} funzionano ancora, ma si suggerisce di usare gli ambienti. +Nell'esempio presentato nella pagina~\pageref{fig:altri4frontespizi} si è usato l'ambiente \amb{frontespizio*} che è disponibile a partire dalla versione~ 5.85 del pacchetto \TOPtesi. I comandi omonimi \cs{frontespizio} e \cs{frontespizio*} funzionano ancora, ma si suggerisce di usare gli ambienti. I moduli speciali per i vari tipi di tesi definiscono un ambiente speciale che si chiama \amb{ThesisTitlePage} configurato apposta per quei tipi di tesi e solo per quelli. Il modulo \pack{topfront} coi suoi ambienti \amb{frontespizio} e \amb{frontespizio*} è generico e non contiene la definizione dell'ambiente \amb{ThesisTitlePage} disponibile, invece, con gli altri moduli disponibili con \TOPtesi. Vediamo le differenze: nella figura~\ref{fig:4frontespizi} si vedono sempre i loghi all'inizio della pagina; non ci sono filetti di nessun genere, il nome dell'università ci può essere o può mancare, le diverse tipologie di tesi hanno informazioni diverse. La differenza di posizione dei loghi dipende dall'usare l'ambiente \amb{frontespizio} che mette i loghi in testa, o l'ambiente \amb{frontespizio*} che mette i loghi nella parte inferiore della pagina; la figura~\ref{fig:frontespizi} nella pagina~\pageref{fig:frontespizi}, infatti, mostra i frontespizi di sinistra che sono stati composti con l'ambiente \amb{frontespizio} e quelli di destra composti con l'ambiente \amb{frontespizio*}. Il nome dell'ateneo appare o non appare a seconda che il comando \cs{ateneo} contenga un argomento vuoto o un argomento con un nome esplicito. Le altre informazioni dipendono da quali comandi si sono usati per caratterizzare la tesi triennale, magistrale o dottorale. Questi comandi verrano descritti dettagliatamente più avanti. Si noti che lo stile dei frontespizi di destra della figura~\ref{fig:frontespizi} nella pagina~\pageref{fig:frontespizi} è stato composto con l'ambiente asteriscato; salvo alcuni dettagli esso è quello che si ottiene indifferentemente con entrambi gli ambienti quando si imposta \chiave{stile}{classica}; la piccola differenza che si vede nel frontespizio eseguito con questa opzione è che l'etichetta che appare sopra il nome del candidato è “Laureando”, mentre senza l'opzione essa è “Candidato”. Si nota invece che nei frontespizi di sinistra il blocco dei relatori e quello dei candidati sono disallineati, mentre a destra sono allineati. Volendo averli allineati anche senza l'opzione \chiave{stile}{classica} basta aggiungere l'opzione \opz{evenboxes} alle opzioni date alla classe. -Pertanto per comporre i frontespizi, il modulo \pack{topfront} con le varie opzioni e l'asterisco permette di avere molte varianti: +Pertanto per comporre i frontespizi, il modulo \pack{topfront} con le varie opzioni e con o senza l'asterisco permette di avere molte varianti: \begin{enumerate}[noitemsep] \item L'asterisco manca: i loghi sono in testa, tranne con l'opzione @@ -1453,7 +1479,7 @@ filetti & assenti & presenti \tabularnewline Gli ambienti \amb{ThesisTitlePage} e \amb{FrontespizioTesina} definiti negli altri moduli, si comportano come l'ambiente \amb{frontespizio}; in alcuni di questi moduli l'ambiente accetta anche l'asterisco, con una sintassi particolare, ma con la stessa funzione che svolge nell'ambiente \amb{frontespizio*}. \end{table} -\goodpagebreak[6] +%\goodpagebreak[6] \begin{figure}[p]\centering @@ -1461,7 +1487,7 @@ Gli ambienti \amb{ThesisTitlePage} e \amb{FrontespizioTesina} definiti negli alt \caption[Frontespizi composti con lo stile \texttt{classica}]{Frontespizi composti con lo stile \texttt{classica}. Con questo stile si ha una disposizione diversa delle varie informazioni e i loghi sono sempre posti nella parte inferiore della pagina. Il nome dell'università è sempre presente.}\label{fig:altri4frontespizi} \end{figure} -\clearpage +%\clearpage \subsection{Comporre il frontespizio della tesi di dottorato della ScuDo} @@ -1502,9 +1528,8 @@ Prof.~I.J., University of \dots} \end{ThesisTitlePage} \end{verbatim} - \subsection{Il frontespizio della tesi triennale} -Per la tesi triennale il frontespizio viene composto specificando alla classe l'opzione \chiave{tipotesi}{triennale} (oppure \chiave{tipotesi}{monografia} -- il nome di questa seconda opzione è conservato per retrocompatibilità, ma in questo manuale viene usato proprio il secondo valore). +Per la tesi triennale il frontespizio viene composto specificando alla classe l'opzione \chiave{tipotesi}{triennale} (oppure \chiave{tipotesi}{monografia} -- il nome di questa seconda opzione è conservato per retrocompatibilità, ma in questo manuale viene usato proprio questo secondo valore). I comandi usabili per impostare le parole fisse e i dati variabili sono sostanzialmente gli stessi indicati per il modulo \pack{topfront}; un cambiamento importante è costituito dal fatto che il titolo della tesi si descrive con lo stesso comando \cs{titolo} usato per le altre tesi, al posto del comando \cs{monografia} (che però è conservato per retrocompatibilità e quindi è ancora usabile con questo modulo). @@ -1552,20 +1577,20 @@ un programma sconosciuto\fi\fi\fi\ il \today \end{ThesisTitlePage} \end{verbatim} -Naturalmente in una vera tesi triennale la composizione del frontespizio e dell'eventuale retrofrontespizio è in generale molto più semplice; ma anche nel frontespizio di questo documento sono bastati meno di una dozzina di comandi per definire tutto il frontespizio e il retro del frontespizio. +Naturalmente in una vera tesi triennale la composizione del frontespizio e, se presente, del retrofrontespizio è in generale molto più semplice; ma anche nel frontespizio di questo documento sono bastati meno di una dozzina di comandi per definire tutto il frontespizio e il retro del frontespizio. \subsection{Il frontespizio della tesi magistrale} Per la tesi magistrale il frontespizio viene composto specificando alla classe l'opzione \chiave{tipotesi}{magistrale}. I comandi usabili sono sostanzialmente gli stessi che fornisce il modulo \pack{topfront}, con alcune differenze. Innanzi tutto, e in modo del tutto ovvio, non sono disponibili i comandi di \pack{topfront} che si riferiscono specificatamente agli altri tipi di tesi triennale e dottorale. Poi è disponibile l'ambiente \amb{ThesisTitlePage} con le stesse caratteristiche descritte per l'omonimo ambiente per il modulo relativo alla tesi triennale. Si richiama l'attenzione sull'uso dell'asterisco da usare facoltativamente come primo token dopo l'apertura dell'ambiente. -In realtà per retro compatibilità gli ambienti \amb{frontespizio} con o senza asterisco e i comandi \cs{frontespizio} con o senza asterisco, sarebbero ancora disponibili, ma se ne sconsiglia l'uso, raccomandando la preferenza per il nuovo ambiente \amb{ThesisTitlePage}. +In realtà per retro compatibilità gli ambienti \amb{frontespizio} con o senza asterisco e i comandi \cs{frontespizio} con o senza asterisco, sarebbero ancora disponibili, ma se ne sconsiglia l'uso, raccomandando di dare la preferenza al nuovo ambiente \amb{ThesisTitlePage}. Nulla cambia in merito all'opzione \chiave{stile}{classica} e all'opzione specificata con \opz{evenboxes} e ai diversi aspetti che queste opzioni, unite all'asterisco facoltativo, producono sul frontespizio della tesi magistrale. \subsection{Il frontespizio della tesi dottorale} -La tesi dottorale di cui si parla in questa sezione non riguarda la tesi della scuola di dottorato del Politecnico di Torino, per la quale esiste l'apposita opzione e l'apposito modulo. Qui si parla di tesi dottorali da comporre secondo regole di altri atenei, se queste sono compatibili con gli stili disponibili in \TOPtesi; qualora non lo fossero, bisogna ricorrere a un frontespizio completamente personalizzato mediante l'opzione \chiave{tipotesi}{custom}. +La tesi dottorale di cui si parla in questa sezione non riguarda la tesi della scuola di dottorato del Politecnico di Torino, per la quale esiste l'apposita opzione e l'apposito modulo. Qui si parla di tesi dottorali da comporre secondo regole di altri atenei, se queste sono compatibili con gli stili disponibili di \TOPtesi; qualora non lo fossero, bisogna ricorrere a un frontespizio completamente personalizzato mediante l'opzione \chiave{tipotesi}{custom}. In ogni caso il modulo per la composizione delle tesi dottorali “generiche” si invoca specificando l'opzione \chiave{tipotesi}{dottorale}. Questo modulo non differisce granché dal modulo generico \pack{topfront}, salvo il fatto che manca di tutti i comandi che si riferiscono specificatamente alle tesi triennali e magistrali. @@ -1584,7 +1609,8 @@ Per la tesina da presentare all'esame di stato per il conseguimento del diploma Per comporre la tesina bisogna specificare l'opzione \chiave{tipotesi}{sss}; questa chiave implica il caricamento di alcuni pacchetti aggiuntivi e la necessità di usare dei comandi specifici per immettere i dati necessari. -Senza specificare altro \TOPtesi usa i font CM-Super; sarebbe meglio richiedere nel preambolo i font Latin Modern mediante il pacchetto \pack{lmodern}; meglio ancora con il pacchetto \pack{cfr-lm} che dispone di molte opzioni e usa meglio le potenzialità dei font Latin Modern. Abituati come sono ad usare i comuni word processor, i maturandi preferiscono usare i font Times; in questo caso raccomanderei di usare i Times extended, mediante il pacchetti \pack{newtxtext} e \pack{newtxmath}, rispettivamente per i font testuali e per quelli matematici; invece, preferendo un font più facilmente leggibile e un pochino più largo, suggerirei i font Palatino extended da richiamare con i pacchetti \pack{newpxtext} e \pack{newpxmath}. +Senza specificare altro e se si vuole comporre la tesi con il programma \prog{pdflatex}, \TOPtesi usa i font CM-Super; sarebbe meglio richiedere nel preambolo i font Latin Modern mediante il pacchetto \pack{lmodern}; meglio ancora con il pacchetto \pack{cfr-lm} che dispone di molte opzioni e usa meglio le potenzialità dei font Latin Modern. Abituati come sono ad usare i comuni word processor, i maturandi preferiscono usare i font Times; in questo caso raccomanderei di usare i Times extended, mediante il pacchetti \pack{newtxtext} e \pack{newtxmath}, rispettivamente per i font testuali e per quelli matematici; invece, preferendo un font più facilmente leggibile e un pochino più largo, suggerirei i font Palatino extended da richiamare con i pacchetti \pack{newpxtext} e \pack{newpxmath}. +Componendo la tesi con il programma \prog{lualatex} i font OpenType Latin Modern e Latin Modern Math vengono usati di default. Volendo se ne possono specificare altri, ma questi dovrebbero essere quelli che offrono le prestazioni migliori. Va notato subito che è possibile inserire il logo della scuola, ma ovviamente bisogna richiederlo alla scuola, la quale potrebbe negarlo; non è cattiveria; semplicemente il logo è un suo simbolo legale e potrebbe venirne fatto un uso improprio; la scuola potrebbe però disporre di un logo secondario per l'inserimento nel frontespizio della tesina. Nella figura~\ref{fig:frontepizio-tesina} è stato usato un disegno di fantasia, solo per mostrare dove verrebbe inserito; se non si usa il logo, lo spazio inutilizzato viene automaticamente ridistribuito fra gli altri spazi. @@ -1633,7 +1659,7 @@ Vediamo subito i pacchetti aggiuntivi che bisogna \emph{evitare di ricaricare}. \textcolor{red}{Non si sono caricati pacchetti particolari per la composizione della bibliografia}; lo studente ha comunque tre - possibilità: + possibilità:\enlargethispage*{1\baselineskip} \begin{enumerate}[noitemsep] \item Compone la bibliografia a mano servendosi dell'ambiente \amb{thebibliography}; non è complicato se la bibliografia @@ -1643,11 +1669,12 @@ Vediamo subito i pacchetti aggiuntivi che bisogna \emph{evitare di ricaricare}. disuniformità della composizione delle singole voci. \item Usa il pacchetto \pack{natbib} e crea un database bibliografico con il programma \prog{jabref} o con - \prog{bibdesk} (quest'ultimo, solo per il Mac; è già - installato solo per il fatto di avere installato il sistema - \TeX usando Mac\TeX). Predisposto il database bibliografico, + \prog{bibdesk} (quest'ultimo, solo per il Mac\footnote{Con la + distribuzione 2020 di Mac\TeX l'app \prog{bibdesk.app} non è + preinstallata, ma la documentazione di Mac\TeX dice da dove + la si può scaricare.}). Predisposto il database bibliografico, usa il programma \prog{bibtex} per estrarre i riferimenti - e usa il comando \cs{printbibliography} per comporre la + e usa \cs{printbibliography} per comporre la bibliografia; userà poi i vari tipi di comandi \cs{cite} predisposti da \pack{natbib} che permettono di citare correttamente le opere elencate. Conviene leggere la documentazione relativa ai database @@ -1656,7 +1683,7 @@ Vediamo subito i pacchetti aggiuntivi che bisogna \emph{evitare di ricaricare}. \item Usa il database bibliografico come nel caso precedente, ma usa il pacchetto \pack{biblatex} e l'elaboratore di database \prog{biber} per ottenere un risultato impeccabile; - la documentazione di \pack{biblatex} va letta con attenzione, + la documenta"zione di \pack{biblatex} va letta con attenzione, perché questo è un pacchetto dotato di moltissime funzionalità e perciò richiede di essere usato con assoluta precisione. \end{enumerate} @@ -1672,7 +1699,7 @@ Qui si ripetono con una descrizione a parole, non nella forma stringata delle ta non viene dato, non viene inserito nulla nel frontespizio. Il file può avere solo certi formati di immagine corrispondenti alle estensioni \file{.pdf}, \file{.eps}, \file{.png}, e - \file{.ipg}; i primi due formati possono essere vettoriali + \file{.jpg}; i primi due formati possono essere vettoriali e, se lo sono davvero\footnote{Potrebbero contenere al loro interno una matrice di punti colorati, come i formati del secondo tipo, quindi non sarebbero dei veri formati @@ -1695,7 +1722,7 @@ Qui si ripetono con una descrizione a parole, non nella forma stringata delle ta \end{sintassi} \Item[NomeCandidato] Imposta l'indicazione da scrivere sopra il nome dello studente; - l'impostazione di default scrive “Studente” oppure + l'impo"stazione di default scrive “Studente” oppure “Studentessa” a seconda che il nome del maturando venga introdotto mediante il comando \cs{studente} o \cs{studentessa}; l'utente che usa questo comando @@ -1704,19 +1731,19 @@ Qui si ripetono con una descrizione a parole, non nella forma stringata delle ta scrivere comandi complessi per distinguere il maschile dal femminile; il maturando sa sicuramente di che genere è, quindi mette un nome del genere corrispondente. - La sintassi è: + La sintassi~è: \begin{sintassi} \cs{NomeCandidato}\marg{Etichetta del maturando} \end{sintassi} \Item[IndirizzoMiur] imposta l'indirizzo speciale della scuola come risulta al Ministero. Questa indicazione è facoltativa. - Se si vuole impostare questo indirizzo, la sintassi è: + Se si vuole impostare questo indirizzo, la sintassi~è: \begin{sintassi} \cs{IndirizzoMiur}\marg{Indirizzo speciale del Ministero} \end{sintassi} \Item[OpzioneMiur] è un'indicazione facoltativa che specifica la destinazione culturale - come risulta al Ministero; se la si vuole indicare, la sintassi è: + come risulta al Ministero; se la si vuole indicare, la sintassi~è: \begin{sintassi} \cs{OpzioneMiur}\marg{opzione ministeriale} \end{sintassi} @@ -1776,7 +1803,7 @@ Qui si ripetono con una descrizione a parole, non nella forma stringata delle ta \end{sintassi} Di nuovo si raccomanda di andare a capo solo prima di articoli, preposizioni, congiunzioni e simili brevi - parole usando esplicitamente il comando\verb|\\|. + parole usando esplicitamente il comando~\verb|\\|\,. \Item[studente] o \textbf{\cs{studentessa}} imposta il nome e cognome del maturando; si raccomanda di mettere sempre il cognome dopo il nome; la sintassi valida per entrambi @@ -1836,9 +1863,9 @@ Per seguire questa strada, qui posso dare solo delle indicazioni generiche. \end{flushleft} dove \meta{stile} è stato precedentemente definito usando il pacchetto \pack{geometry} o altri pacchetti. Sarebbe opportuno ridefinire i due margini interno ed esterno in modo che siano uguali. Qualcuno desidera apportare un piccolo spostamento verso l'esterno di non più di 5\,mm per compensare la curvatura della prima pagina; questa curvatura dipenderebbe dal modo di confezionare/legare la tesi; di solito con una brossura ben eseguita o una legatura a filo, non è necessario apportare questa correzione; con una tesi spillata con punti metallici, probabilmente una piccola correzione non guasterebbe; però questa correzione è concepita per le pagine interne e, siccome il frontespizio è la prima pagina della tesi, la curvatura della pagina è irrilevante e questo piccolo spostamento è del tutto superfluo. % -\item Non è necessario che i margini laterali siano complessivamente equivalenti ai margini del corpo della tesi, ma non guasta se lo sono. +\item Non è necessario che la gabbia di stampa sia uguale a quella del corpo della tesi, ma non guasta se lo è. In realtà sarebbe preferibile che la gabbia di stampa del frontespizio comprendesse anche lo spazio che nel corpo della tesi viene occupato dalla testatina e dal piedino. % -\item Per la disposizione verticale del testo, sarebbe preferibile che i margini superiore e inferiore siano otticamente equivalenti; questo dipende dal fatto che il primo elemento in alto sia, per esempio, il nome dell'ateneo scritto con caratteri relativamente alti e neri, oppure sia il logo dell'università, che può essere alto, ma di solito non è tanto largo. Inoltre lo stile della pagina non deve presentare né testatina con il suo spazio di separazione del testo, né piedino, con il suo spazio di separazione dal testo, e non deve contenere il numero della pagina. +\item Per la disposizione verticale del testo, sarebbe preferibile che i margini superiore e inferiore siano otticamente equivalenti; questo dipende dal fatto che il primo elemento in alto sia, per esempio, il nome dell'ateneo scritto con caratteri relativa"men"te alti e neri, oppure sia il logo dell'università, che può essere alto, ma di solito non è tanto largo. Inoltre lo stile della pagina non deve presentare né testatina con il suo spazio di separazione dal testo, né piedino, con il suo spazio di separazione dal testo, e non deve contenere il numero della pagina. % \item Il laureando deve provvedere autonomamente alle spaziature verticali fra un elemento e l'altro; deve decidere se certe parti siano da comporre in modo centrato, oppure in bandiera col palo a sinistra o a destra, se certe parti debbano essere affiancate e come debbano essere distanziate. % @@ -1846,7 +1873,7 @@ dove \meta{stile} è stato precedentemente definito usando il pacchetto \pack{ge \begin{flushleft}\ttfamily \cs{fontsize}\Marg{15}\Marg{17}\cs{usefont}\Marg{T1}\Marg{iwona}\Marg{m}\Marg{n} \end{flushleft} -quando compone quell'informazione; dovrebbe curare di fare questa operazione dentro un gruppo al fine di mantenere queste impostazioni solo per la scrittura di quella informazione. Sarebbe meglio definirsi un comando personale per evitare di dover ogni volta introdurre quella serie di istruzioni, con il rischio di commettere anche il più piccolo errore di battitura e quindi di generare fastidiosi messaggi d'errore. +quando compone quell'informazione; dovrebbe curare di fare questa operazione dentro un gruppo al fine di mantenere queste impostazioni solo per la scrittura di quella informazione. Sarebbe meglio definirsi un comando personale per evitare di dover ogni volta introdurre quella serie di istruzioni, con il rischio di commettere anche il più piccolo errore di battitura e quindi di generare fastidiosi messaggi d'errore. Naturalmente se il laureando compone la tesi con il programma \prog{pdflatex}, segue le indicazioni appena date; se usa uno dei programmi \prog{lualtex} o \prog{xelatex} deve scegliere autonomamente i font da usare nel frontespizio e da dichiarare con il comando \cs{fontfamily} del pacchetto \pack{fontspec}; per le impostazioni di serie, forme, corpi e scartamenti deve procedere come indicato sopra. \end{enumerate} Non scendo in ulteriori dettagli; l'utente che volesse comporre un frontespizio molto personalizzato per questa via, deve sapere quello che sta facendo e deve farlo con la dovuta competenza tipografica e del linguaggio \LaTeX. I risultati estetici dipendono fortemente da queste sue capacità. @@ -1919,7 +1946,7 @@ Un esempio di un frontespizio costruito per questa via è quello che un utente h \end{document} \end{verbatim} -Nel codice precedente appaiono alcuni comandi per i font i cui nomi per le corrispondenti dichiarazioni sono ispirati a quelli contenuti nel pacchetto \pack{frontespizio}, ma i nomi sono irrilevanti, nel senso che qualunque altro nome sarebbe stato altrettanto valido; però è utile che i nomi dei dei comandi relativi ai font siano scelti in modo che ricordino la funzione per la quale sono stati definiti. +Nel codice precedente appaiono alcuni comandi per i font i cui nomi per le corrispon"den"ti dichiarazioni sono ispirati a quelli contenuti nel pacchetto \pack{frontespizio}, ma i nomi sono irrilevanti, nel senso che qualunque altro nome sarebbe stato altrettanto valido; però è utile che i nomi dei dei comandi relativi ai font siano scelti in modo che ricordino la funzione per la quale sono stati definiti. La pagina che l'utente ha ottenuto è contenuta nella figura~\ref{fig:frontespizio-landscape}. Per inserirla come frontespizio della tesi egli ha poi usato il pacchetto @@ -1943,7 +1970,7 @@ Potrebbe essere necessario comporre il frontespizio in modo diverso da come vien Ci sono diversi motivi per i quali un laureando o dottorando vorrebbe comporre un frontespizio diverso da quelli predefiniti dai moduli di \TOPtesi. \begin{enumerate}[noitemsep] -\item Le specifiche per le tesi di una data università sono inconciliabili con quelle impostate da tutti i moduli di \TOPtesi. +\item Le specifiche per le tesi di una data università sono inconciliabili con quelle impostate da qualsiasi modulo di \TOPtesi. \item Le informazioni da inserire nel frontespizio sono diverse da quelle impostate dai moduli di \TOPtesi. \item Il laureando non deve soddisfare a specifiche particolari ma vuole comporre un frontespizio personalizzato a suo piacimento. \end{enumerate} @@ -1954,19 +1981,19 @@ Questa seconda via può dare risultati buoni, grazie alla possibilità di person Esistono altri pacchetti, oltre a \pack{frontespizio}, per comporre pagine di titoli; ma per le tesi questo pacchetto sembra il più indicato. Definisce comandi per inserire virtualmente qualsiasi informazione necessaria per un frontespizio di tesi di laurea triennale, magistrale o dottorale; per impostazione predefinita tutte le informazioni fisse sono in italiano, ma ciascuna può essere modificata come si vuole in qualsiasi lingua. -Per seguire questa strada bisogna specificare l'opzione \chiave{tipotesi}{frontespizio} alla classe. Questa opzione imposta tutte le variabili booleane necessarie per evitare dimenticanze e possibili errori, impedisce il caricamento di ogni altro modulo relativo ai vari tipi di tesi, e richiama il pacchetto esterno \pack{frontespizio} di cui è necessario conoscere i dettagli dalla sua documentazione. +Per seguire questa strada bisogna specificare l'opzione \chiave{tipotesi}{frontespizio} alla classe. Questa opzione imposta tutte le variabili booleane necessarie per evitare dimenticanze e possibili errori, impedisce il caricamento di ogni altro modulo relativo ai vari tipi di tesi, e invece carica il pacchetto esterno \pack{frontespizio}, di cui è necessario conoscere i dettagli d'uso dalla sua documentazione. Questo pacchetto \pack{frontespizio} produce un file ausiliario \meta{nome del main file della tesi}\file{-frn.tex} per comporre il frontespizio vero e proprio; questo implica che per disporne come frontespizio del documento finito, bisogna comporre anche questo file ausiliario. Precisamente tutte le informazioni riguardanti il frontespizio devono essere messe dentro un ambiente \amb{frontespizio} collocato dopo l'istruzione \Bambiente{document}. Qui si metteranno i comandi per definire il nome del o dei candidati, il nome del o dei relatori e degli eventuali correlatori, il nome dell'università, il nome del corso di laurea, il nome del tipo di tesi, il titolo e il sottotitolo della tesi, eccetera. -Eseguendo \prog{pdflatex} oppure \prog{xelatex} o \prog{lualatex} viene prodotto il file ausiliario; se la tesi ha il main file che si chiama \texttt{MarioRossiTesiMagistrale.tex}, dopo averlo compilato, nella cartella di lavoro ci sarà anche il file ausiliario \texttt{MarioRossiTesi\discretionary{}{}{}Magistrale-frn.tex}; bisognerà dunque compilare questo file ausiliario, e poi ricompilare il documento che \emph{riscriverà il file ausiliario} con i nuovi eventuali dati modificati, ma intanto ingloberà il file PDF appena prodotto. La sequenza delle compilazioni sarà dunque: +Eseguendo \prog{pdflatex} oppure \prog{xelatex} o \prog{lualatex} viene prodotto il file ausiliario; se la tesi ha il main file che si chiama \texttt{MarioRossiTesiMagistrale.tex}, dopo averlo compilato, nella cartella di lavoro ci sarà anche un altro file che serve solo per comporre il frontespizio: \texttt{MarioRossiTesiMagistrale-frn.tex}; bisognerà dunque compilare questo file ausiliario, e poi ricompilare il documento che \emph{riscriverà il file ausiliario} con i nuovi eventuali dati modificati, ma intanto ingloberà il file PDF appena prodotto. La sequenza delle compilazioni sarà dunque: \begin{verbatim} pdflatex MarioRossiTesiMagistrale pdflatex MarioRossiTesiMagistrale-frn pdflatex MarioRossiTesiMagistrale \end{verbatim} -Queste operazioni generalmente sono semplificate dall'uso di uno shell editor adeguato. Ancor meglio, disponendo di un editor adeguato, si può usare il programma Java \prog{arara}, di Paulo Massa Cereda, che provvede da solo ad eseguire tutte le operazioni necessarie; nella documentazione di \pack{arara} (terminale: texdoc arara; \tasto{invio}) c'è scritto come fare; leggere in dettaglio la regola “frontespizio” descritta nella pagina~112 della documentazione di \prog{arara}~4.0. +Queste operazioni generalmente sono semplificate dall'uso di uno shell editor adeguato. Ancor meglio, disponendo di un editor adeguato, si può usare il programma \prog{arara}, di Paulo Massa Cereda, già installato insieme al sistema \TeX, che provvede da solo ad eseguire tutte le operazioni necessarie; nella documentazione di \pack{arara} (terminale: texdoc arara; \tasto{invio}) c'è scritto come fare; leggere in dettaglio la regola “frontespizio” descritta nella pagina~112 della documentazione di \prog{arara}~4.0. Se il frontespizio deve essere composto con font diversi da quelli di default, con codifiche particolari, con altre impostazioni particolari è meglio che il file ausiliario sia dotato di un preambolo \emph{ad hoc}; quindi il file principale avrà la struttura seguente: @@ -2005,13 +2032,13 @@ Se il frontespizio deve essere composto con font diversi da quelli di default, c \end{flushleft} -Il contenuto dell'ambiente \amb{Preambolo*} può essere molto vario e dipende dal programma usato per la compilazione del frontespizio, da scelte particolari dei font, da comandi da ridefinire, eccetera. La documentazione di \pack{frontespizio} espone diversi esempi che danno un'ottima visione d'insieme per tutte le operazioni che si possono fare e dei risultati che si possono ottenere. +Il contenuto dell'ambiente \amb{Preambolo*} può essere molto vario e dipende dal program"ma usato per la compilazione del frontespizio, da scelte particolari dei font, da comandi da ridefinire, eccetera. La documentazione di \pack{frontespizio} espone diversi esempi che danno un'ottima visione d'insieme per tutte le operazioni che si possono fare e dei risultati che si possono ottenere. Però, come già detto, questo pacchetto compone di default il frontespizio in una pagina A4, e in due stili, quello “standard” e quello per lo stile “elements” della classe \class{suftesi}. -Se si volesse comporre la tesi in formato B5, per esempio, bisogna sfruttare adeguatamente il contenuto dell'ambiente \amb{Preambolo*}. +Se si volesse comporre la tesi in formato B5, per esempio, bisogna sfruttare adeguata"mente il contenuto dell'ambiente \amb{Preambolo*}. -La procedura da seguire, dunque dovrebbe essere modificata come segue. Assumiamo che non si debbano apportare modifiche al contenuto del frontespizio; in caso contrario bisogna ripetere la procedura dopo ogni modifica del suo contenuto all'interno dell'ambiente \amb{frontespizio}. +La procedura da seguire, dunque dovrebbe essere modificata come segue. Assumiamo che non si debbano apportare modifiche al contenuto del frontespizio; in caso contrario bisogna ripetere la procedura dopo ogni modifica del suo contenuto all'interno dell'am"biente \amb{frontespizio}. \begin{Verbatim}[fontsize=\normalsize] \documentclass [11pt,b5paper]{book} @@ -2051,7 +2078,7 @@ In questi casi se il nome dell'ateneo va in testa al frontespizio in corpo \verb Questa operazione funziona automaticamente in modo decisamente accettabile se il nome dell'ateneo eccede la giustezza di 10 o 15 punti percentuali, ma con nomi così lunghi come quelli elencati sopra, il meccanismo funziona ma il risultato lascia molto a desiderare perché i font con cui è composto il nome dell'ateneo, ridotti di una grossa percentuale, diventano più chiari e inaccettabilmente piccoli per la funzione che il nome dell'ateneo svolge nel frontespizio di una tesi. -In questi casi sarebbe più consono usare una immagine, come quella del logo dell'Università di Bolzano dove, accanto al “timbro” dell'università, i tre nomi sono elencati in colonna invece che su un'unica riga. Sono scritti con un carattere piccolo, ma affiancando il “timbro” l'insieme è giusto. Ovviamente, usando il logo, non è poi necessario usarlo di nuovo come simbolo dell'ateneo a metà della pagina. +In questi casi sarebbe più consono usare una immagine, come quella del logo dell'Uni"versità di Bolzano dove, accanto al “timbro” dell'università, i tre nomi sono elencati in colonna invece che su un'unica riga. Sono scritti con un carattere piccolo, ma affiancando il “timbro” l'insieme è giusto. Ovviamente, usando il logo, non è poi necessario usarlo di nuovo come simbolo dell'ateneo a metà della pagina. Con i nomi in due sole lingue, come per l'università valdostana, si potrebbe anche pensare ad una soluzione di questo tipo: \begin{verbatim} @@ -2089,22 +2116,22 @@ usando poi \cs{uniModenaReggio} come argomento del comando \cs{ateneo}; il nome è inserito in una scatola \LaTeX di larghezza pari alla giustezza, per cui la sua larghezza vera viene mascherata da quella della scatola e il meccanismo di ridimensionamento non entra in funzione. \section{Il comando \cs*{chapter}} -The comand \cs{chapter} was redefined in a global way in this package \TOPtesi. The purpose of the redefinition was to extend its native functionalites and to accept a syntax such as this: +Il comando\cs{chapter} è stato ridefinito In \TOPtesi in modo globale. Lo scopo della ridefinizione è stato quella di estenderne le funzionalità in modo che accetti una sintassi come questa: \begin{sintassi} \cs{chapter}\meta{$\star$}\oarg{indice}\oarg{testatina}\marg{titolo}\oarg{stile} \end{sintassi} -dove i vari parametri hanno i significati e le funzioni seguenti; cominciamo dal fondo. +dove i vari parametri hanno i significati e le funzioni seguenti; cominciando dal fondo si ha quanto segue. \begin{description}[noitemsep] % \item[\meta{stile}] è facoltativo; esso specifica lo stile di composizione della pagina iniziale di un capitolo; il valore predefinito è \texttt{plain}, ma spesso è richiesta una prima pagina priva del numero di pagina; in questo caso si specifica \texttt{empty}. Senza questa funzionalità la definizione originale richiedeva complicati trucchi per ottenere il risultato. % \item[\meta{titolo}] è evidentemente obbligatorio, e serve per comporre il titolo nella pagina iniziale del capitolo. % -\item[\meta{testatina}] è facoltativo e specifica la stringa da inserire nella testatina; di default è la stessa stringa che può essere inviata all'indice generale. Di default, però, con gli stili di pagina “normali”, cioè che accettano informazioni correnti nelle testatine di destra o di sinistra, questo nuovo comando le intesta entrambe; ciò è utile sia per capitoli della parte iniziale che possono prevedere, per esempio, un sommario relativamente lungo, sia per cose come l'indice general, di diverse pagine, o la bibliografia di diverse pagine. Questo `ha implicato la ridefinizione dei comandi nativi \cs{tableofcontents}, \cs{listoftables} e \cs{listoffigures}, oltre che gli ambienti \amb{theindex} e \amb{thebobliography}. L'utente, quindi, deve fare un poco di attenzione come si specificherà qui nel seguito. +\item[\meta{testatina}] è facoltativo e specifica la stringa da inserire nelle testatine delle pagine pari (se si compone fronte"/retro) all'interno del capitolo; di default è la stessa stringa che può essere inviata all'indice generale. Di default, però, con gli stili di pagina “normali”, cioè che accettano informazioni correnti nelle testatine di destra o di sinistra, questo nuovo comando le intesta entrambe; ciò è utile sia per capitoli della parte iniziale che possono prevedere, per esempio, un sommario relativamente lungo, sia per oggetti di diverse pagine come l'indice generale o la bibliografia. Questo ha implicato la ridefinizione dei comandi nativi \cs{tableofcontents}, oltre a \cs{listoftables} e \cs{listoffigures}, e gli ambienti \amb{theindex} e \amb{thebobliography}. L'utente, quindi, deve fare un poco di attenzione come si specificherà qui nel seguito. % \item[\meta{indice}] è facoltativo e contiene la stringa da inviare all'indice generale; di default è la stessa stringa da usare per il titolo della pagina iniziale del capitolo. % -\item[\meta{$\star$}] è facoltativo, ma gioca lo stesso ruolo che l'asterisco svolgeva nel comando nativo del nucleo di \LaTeX, cioè serve per non numerare il capitolo e non mandarne le informazioni all'indice generale. Benché il comando asteriscato accetti tutti gli altri parametri del comando non asteriscato, non li usa tutti; in particolare basta inserire uno solo dei due \meta{indice} o \meta{testatina}, ma non è vietato specificarli entrambi; se le stringhe sono diverse viene usata solo quella per la \meta{testatina}; se si specifica uno solo dei due argomenti facoltativi, esso viene inteso come il primo, che per suo conto trasferisce la sua stringa al secondo, quini, la stringa non trasferisce nulla all'indice, ma ha trasferito la sua stringa a entrambe testatine. Perciò i comandi \cs{section} (se presenti) devono essere usati nella forma asteriscata, altrimenti i loro numeri sono errati. +\item[\meta{$\star$}] è facoltativo, ma gioca lo stesso ruolo che l'asterisco svolgeva nel comando nativo del nucleo di \LaTeX, cioè serve per non numerare il capitolo e non mandarne le informazioni all'indice generale. Benché il comando asteriscato accetti tutti gli altri parametri del comando non asteriscato, non li usa tutti; in particolare basta inserire uno solo dei due \meta{indice} o \meta{testatina}, ma non è vietato specificarli entrambi; se le stringhe sono diverse viene usata solo quella per la \meta{testatina}; se si specifica uno solo dei due argomenti facoltativi, esso viene inteso come il primo, che per suo conto trasferisce la sua stringa al secondo, quindi, la stringa non trasferisce nulla all'indice, ma trasferisce la sua stringa a entrambe testatine. Perciò i comandi \cs{section} (se presenti) devono essere usati nella forma asteriscata, altrimenti i loro numeri sono errati; d'altra parte un capitolo non numerato non deve contenere sezioni numerate che poi saranno elencate nell'indice. Inoltre, se si vuole mandare l'informazione del capitolo non numerato all'indice, bisogna farlo con i comandi nativi; per esempio: \begin{verbatim} @@ -2119,14 +2146,14 @@ Analogamente si deve procedere per capitoli non numerati nella front matter: \chapter*{Prologo}} \addcontentsline{toc}{chapter}{Prologo} \end{verbatim} -dove \cs{frontmattertrue} mantiene lo stile di composizione della front matter, anche se\cs{chapter} di suo farebbe passare dalla parte inziale a quella centrale. +dove \cs{frontmattertrue} mantiene lo stile di composizione della front matter, anche se\cs{chapter} di suo farebbe passare dalla parte inziale a quella principale. -Queste osservazioni non dipendono tanto dalla nuova definizione del comando \cs{chapter}, perché anche nelle precedenti versioni era così, mon non era sottolineato abbastanza. +Queste osservazioni non dipendono tanto dalla nuova definizione del comando \cs{chapter}, perché anche nelle precedenti versioni era così, ma non era sottolineato abbastanza. \end{description} -I comandi \cs{sommario} e \cs{ringraziamenti}, come i loro alias, in teroria funziano come descritto; ma siccome sono composti nella parte inziale della tesi, composta con lo stile di pagina \texttt{plain}, non si rimarca nessun effetto dalla nuova funzionalità del comando \cs{chapter}. -Se però si vuole scrivere un capitolo non numerato nella parte centrale della tesi, l'argomento facoltativo del comando asteriscato passa nelle testatine, ma nulla vien inviato all'indice. Inoltre, nella parte centrale della tesi, non viene numerato il capitolo, ma eventuali opzioni sono numerate +I comandi \cs{sommario} e \cs{ringraziamenti}, come i loro alias, in teoria funzionano come descritto; ma siccome sono composti nella parte iniziale della tesi, composta con lo stile di pagina \texttt{plain}, non si rimarca nessun effetto dalla nuova funzionalità del comando \cs{chapter}. +Se però si vuole scrivere un \textcolor{red}{capitolo non numerato} nella parte centrale della tesi, l'argomento facoltativo del comando asteriscato passa nelle testatine, ma nulla viene inviato all'indice. Inoltre, nella parte centrale della tesi, non viene numerato il capitolo, ma eventuali \textcolor{red}{sezioni sono numerate, ma come già detto e lo si ripete, con numeri errati se non si usano i comandi asteriscati}. \section{Il file accessorio \texorpdfstring{\pack*}{}{topcoman}} @@ -2149,14 +2176,14 @@ ancora, fuori dalla carta, sarebbe opportuno che le righe del programma non fossero più lunghe di una ottantina di caratteri per la carta A4, proporzionalmente di meno per formati di carta più piccoli. -Più avanti, nella descrizione del codice, si è abbandonata la definizione iniziale di \cs{listing}, ma la si è ridefinita come sostituto per lanciare un comando del pacchetto \pack{fancyvrb}; si è scelto questo piuttosto che il pacchetto \pack{listings} perché lavorando con \LuaLaTeX o \XeLaTeX non si hanno problemi con i caratteri con codifica multibyte. \pack{listings}, invece, lavora bene solo con caratteri \sigla{ascii} codificati a 7~bit e ha certe rigidezze con le codifiche a 8~bit; può lavorare con \LuaLaTeX o \XeLaTeX, ma bisogna che il programma da listare contenga solo caratteri \sigla{ascii}. +Più avanti, nella descrizione del codice, si è abbandonata la definizione iniziale di \cs{listing}, ma la si è ridefinita come sostituto per lanciare un comando del pacchetto \pack{fancyvrb}; si è scelto questo piuttosto che il pacchetto \pack{listings} perché lavorando con \LuaLaTeX o \XeLaTeX non si hanno problemi con i caratteri con codifica multibyte. \pack{listings}, invece, lavora bene solo con caratteri \sigla{ascii} codificati a 7~bit e per codifiche a 8~bit deve essere espressamente abilitato con la sua opzione \opz{extendedchars=true}; può lavorare con \LuaLaTeX o \XeLaTeX, ma bisogna che il programma da listare contenga solo caratteri \sigla{ascii}; per listare caratteri di lingue orientali ha bisogno di trattamenti speciali descritti nella sua documentazione. In sostanza la soluzione trovata ricorrendo a \pack{fancyvrb} sembra molto più semplice da usare, anche se manca dei molti abbellimenti di \pack{listings}. \begin{otherlanguage}{english} \section[Doctoral dissertation for the ScuDo school of Politecnico di Torino]{\raggedright Doctoral dissertation for~the~ScuDo school of~Politecnico di~Torino} \label{sec:scudo} When you specify the \chiave{tipotesi}{scudo} option to the class, some extra files are loaded and the \pack{topfront} module loading is inhibited. -The main module file is \pack{toptesi-scudo.sty} which, differently from other \TOPtesi modules, loads several other packages. +The main module file is \pack{toptesi-scudo.sty} which, differently from other \TOPtesi modules, sets English as the main language and loads several other packages. \subsection{Further packages loaded for typesetting ScuDo theses} @@ -2172,7 +2199,7 @@ The \chiave{tipotesi}{scudo} option loads some other packages. If it was for me, % \Item[xparse] allows advanced definitions of commands and environments; it is functional for the definitions of some internal bundle macros, but may be used also by the end user, provided s/he reads with great attention its documentation. % -\Item[lscape] allows to typeset full pages in landscape orientation. It may be useful to insert large tables and/or figures; when typesetting with a LuaTeX engine version lower than 1.0.4, this landscape orientation does not work. +\Item[lscape] allows to typeset full pages in landscape orientation. It may be useful to insert large tables and/or figures. When typesetting with a LuaTeX engine version lower than 1.0.4, this landscape orientation does not work. % \Item[setspace] is used to typeset draft versions of the dissertation, but it should not be used at all for the final version; if a particular paragraph required some extra leading, the regular \amb{interlinea} environment of \TOPtesi will do the job. But remember: the paragraph must be really special to require extra leading. In general extra leading is poor typography. @@ -2194,7 +2221,7 @@ The example file \file{toptesi-scudo-example.tex} shows how to avoid the use of % \Item[siunitx] offers special functionalities to handle units of measure and to format numerical fractional values; it also defines some efficient facilities to format numerical table columns so as to align the numerical data on the basis of their decimal separator. % -\Item[float] allows to define other floating environments in addition to \amb{figure} and \amb{table}. Unfortunately it defines also the \texttt{H} position option that kills the floating property and produces typographic results that are absolutely not acceptable. +\Item[float] allows to define other floating environments in addition to \amb{figure} and \amb{table}. Unfortunately it defines also the \texttt{H} position that kills the floating property and produces typographic results that are \textcolor{red}{absolutely not acceptable}. % \Item[imakeidx] allows to generate one or more indices in a synchronous way. This means that the indices are produced with one run of the typesetting program, thus avoiding any manual intervention. % @@ -2224,7 +2251,7 @@ Among real new commands it is better to recall that the ISO standards on math ty \end{verbatim} were the first argument is the \LaTeX function macro, while the second argument is the actual name that is being typeset with the “operators” font (roman). -For what concerns the base of natural logarithms and the imaginary unit, commands \cs{eu} and \cs{gei} are already provided; \cs{iu} is an alias to \cs{gei}; if you do not like “j” as the symbol of the imaginary unit (in spite of the fact the “j” is generally used in engineering disciplines), you can redefine \cs{iu} to generate “i” and avoiding the math Greek \texttt{\string\iota} that is not an ISO official symbol. +For what concerns the base of natural logarithms and the imaginary unit, commands \cs{eu} and \cs{gei} are already provided; \cs{ju} is an alias to \cs{gei}; if you do not like “j” as the symbol of the imaginary unit (in spite of the fact the “j” is generally used in engineering disciplines), you can use \cs{iu} to produce “i”; please avoid the math Greek \texttt{\string\iota} that is not an ISO official symbol. For the differential symbol this extension file contains the definition: \begin{verbatim} @@ -2251,7 +2278,7 @@ This extension file contains also some patches for composing a nomenclature; the \end{verbatim} It can be used as a model to define a larger collection of nomenclature groups. -The user may not be interested in the fine points of automatic rendering of the nomenclature list; but it is sufficient to know that to print it out, it is necessary to use a new defined command that extends the original \cs{printnomenclature} one; this new extension is called simply \cs{printnomencl} and accepts an optional argument, as the original command does, but provides the necessary variants to let \pdfLaTeX\ and \XeLaTeX\ exploit the typesetting program functionality \emph{shell escape}, while letting \LuaLaTeX\ exploit its particular Lua interpreter to do the same job. Whatever these tricks, the user finds out that the nomenclature list appears where it should, with just one typesetting run, in the back matter section where the \cs{printnomencl} command was used. +The user may not be interested in the fine points of automatic rendering of the nomenclature list; but it is sufficient to know that to print it out, it is necessary to use a new defined command that extends the original \cs{printnomenclature} one; this new extension is called simply \cs{printnomencl} and accepts an optional argument, as the original command does, but provides the necessary variants to let \pdfLaTeX\ and \XeLaTeX\ exploit the typesetting program functionality \emph{shell escape}, while letting \LuaLaTeX\ exploit its particular Lua interpreter to do the same task. Whatever these tricks, the user finds out that the nomenclature list appears where it should, with just one typesetting run, in the back matter section where the \cs{printnomencl} command was used. For the ScuDo title page see section~\ref{sec:frontescudo}. @@ -2259,20 +2286,18 @@ For the ScuDo title page see section~\ref{sec:frontescudo}. \section{Come si comincia}\label{sec:cominciare} -Non dico niente su come si scrive una tesi; so per -esperienza che all'inizio ci si sente sperduti davanti allo -schermo vuoto. +Non dico niente su come si scrive una tesi; so per esperienza che all'inizio ci si sente sperduti davanti allo schermo vuoto. -Ma i laureandi possono scaricare dal sito -del \GuIT\footnote{Fino a qualche anno fa questo opuscoletto, prodotto da un'apposita commissione di docenti del Politecnico, era scaricabile dal portale della didattica del Politecnico di Torino. Ora un'altra commissione è al lavoro per fornire ai suoi studenti un manuale completamente nuovo che, però, non è ancora disponibile; nel frattempo la versione di \emph{Saper comunicare} presente nel portale della didattica è ormai diventata obsoleto in alcune sue parti. La versione presente nel sito del \GuIT, invece, continua ad essere aggiornata.} \url{https://www.guitex.org/home/images/doc/} l'opuscoletto \emph{Saper Comunicare --- Cenni di scrittura tecnico-scientifica} dove c'è scritto più o meno tutto quel che bisogna sapere per impostare e scrivere un rapporto tecnico-scientifico qual è la tesi, la monografia o la dissertazione. +Ma i laureandi possono scaricare dal sito +del \GuIT\footnote{Fino a qualche anno fa questo opuscoletto, prodotto da un'apposita commissione di docenti del Politecnico, era scaricabile dal portale della didattica del Politecnico di Torino. Ora un'altra commissione è al lavoro per fornire ai suoi studenti un manuale completamente nuovo che, però, non è ancora disponibile; nel frattempo la versione di \emph{Saper comunicare} presente nel portale della didattica è ormai diventata obsoleta in alcune sue parti. La versione presente nel sito del \GuIT, invece, continua ad essere aggiornata.} \url{https://www.guitex.org/home/images/doc/} l'opuscoletto \emph{Saper Comunicare --- Cenni di scrittura tecnico-scientifica} dove c'è scritto più o meno tutto quel che bisogna sapere per impostare e scrivere un rapporto tecnico-scientifico qual è la tesi, la monografia o la dissertazione. -Qui dirò solo come si comincia a scrivere il file sorgente della tesi. Ci sono essenzialmente due vie, ognuna delle quali offre vantaggi e svantaggi, quindi non si può dire a priori quale sia la via più indicata. +Qui dirò solo come si comincia a scrivere il file sorgente della tesi. Ci sono essenzial"mente due vie, ognuna delle quali offre vantaggi e svantaggi, quindi non si può dire a priori quale sia la via più indicata. \begin{enumerate}[noitemsep] \item {\tolerance=3000 Si compone un unico file come esemplificato con i file \file{toptesi-example.tex}, \file{toptesi-example-xetex.tex} e \texttt{toptesi-example-con-frontespizio\discretionary{}{.}{.}tex}\index{file!toptesi-example-con-frontespiziotex@\texttt{toptesi\discretionary{}{-}{-}example\discretionary{}{-}{-}con\discretionary{}{-}{-}frontespizio\discretionary{}{.}{.}tex}} - allegati alla documentazione di \TOPtesi. Questi file permettono + alle"gati alla documentazione di \TOPtesi. Questi file permettono di sperimentare diverse cose semplicemente mettendo o togliendo dei segni di commento all'inizio delle righe del preambolo che contengono alcuni comandi particolari. Essi sono completi di @@ -2312,7 +2337,7 @@ si predispone un master file con un nome “diverso” da mnemonico e ricordi subito a che cosa ci si riferisce. Questo master file sarà dunque composto, per esempio, così: \begin{flushleft}\ttfamily\obeyspaces\obeylines -\cs{documentclass}\Oarg[\% +\cs{documentclass}[\% \quad b5paper, \% carta B5 \quad corpo=11pt, \% corpo normale 11pt \quad tipotesi=triennale \% laurea triennale @@ -2323,7 +2348,7 @@ master file sarà dunque composto, per esempio, così: \qquad capitolo1,\% \qquad capitolo2,\% \qquad capitolo3,\% -\qquad appendici,\% +\qquad appendici,\% \textnormal{oppure} appendice,\% \qquad bibliografia\% \quad} \Bambiente{document} @@ -2331,8 +2356,7 @@ master file sarà dunque composto, per esempio, così: \quad \cs{ateneo}\Marg{Università di Bengodi} \quad \cs{nomeateneo}\Marg{La Saggezza} \quad \cs{titolo}\Marg{Studi di tricotetratomia applicata} -\quad \cs{sottotitolo}\Marg{Cosa succede quando si spacca -\qquad un capello in quattro} +\quad \cs{sottotitolo}\Marg{Cosa succede quando si spacca un capello in quattro} \quad \cs{candidata}\Marg{Maria Chiomafolta} \quad \cs{relatore}\Marg{prof.\ Piero Scapigliati} \quad \cs{sedutadilaurea}\Marg{Maggio 2345} @@ -2343,14 +2367,14 @@ master file sarà dunque composto, per esempio, così: \quad \cs{include}\Marg{capitolo2} \quad \cs{include}\Marg{capitolo3} \quad \cs{appendix} -\quad \cs{include}\Marg{appendici}% diverse appendici +\quad \cs{include}\Marg{appendici}\% diverse appendici \cs{backmatter} -\quad \cs{include}\Marg{appendice}% una sola appendice +\quad \cs{include}\Marg{appendice}\% una sola appendice \quad \cs{include}\Marg{bibliografia} \Eambiente{document} \end{flushleft} -L'\meta{ambiente per la pagina del titolo} sarà uno dei vari ambienti descritti nei paragrafi precedenti; nell'esempio della laurea triennale riportato sopra, l'ambiente è \amb{ThesisTitlePage}. +L'\meta{ambiente per la pagina del titolo} sarà uno dei vari ambienti descritti nei paragrafi precedenti; nell'esempio della laurea triennale riportato sopra, esso è \amb{ThesisTitlePage}. È da osservare in particolare che l'aver scritto l'argomento di \cs{includeonly} nel modo esemplificato sopra, cioè con un solo nome di file in ogni riga, permette di inserire dei segni di commento all'inizio di alcune delle righe in modo da eseguire, per esempio, la compilazione selettiva di un solo capitolo conservando tutte le informazioni incrociate relative agli altri capitoli già compilati. Con i PC di oggi la compilazione è rapidissima, quindi lo scopo di risparmiare tempo di compilazione non è il motivo per il quale raccomando di seguire questa procedura; faccio invece notare che tenere separate le varie parti della tesi permette di lavorare con più ordine e di risparmiare non poco tempo per la gestione dei vari file sorgente e per le loro correzioni. @@ -2364,9 +2388,9 @@ vale la pena di ripassare l'argomento nella guida \emph{L'Arte di scrivere con LaTeX} da scaricare dalla sezione Documentazione del sito \url{https://www.guitex.org}. -Il file \texttt{preliminari.tex} conterrà presumibilmente il sommario, molto facoltativamente i ringraziamenti\footnote{I ringraziamenti in una tesi non sono quasi mai necessari; lo sono quando bisogna ringraziare una istituzione o una o più persone \emph{esterne} alla propria università che hanno messo a disposizione le loro strutture o le loro competenze per lo svolgimento della tesi. Non si ringraziano genitori, fidanzati/e, amici, e tutti i parenti di ogni grado, il quali saranno più che contenti di sapervi laureati, piuttosto che vedere il loro nome scritto sulla tesi\dots\ Inoltre rappresenta un atto di piaggeria ringraziare il o i propri relatori; essi hanno svolto un loro compito istituzionale, non vi hanno fatto un piacere. Naturalmente questo non vieta che la consuetudine del lavoro assieme non abbia dato origine a sentimenti di reciproca stima e anche di amicizia, ma questa è un'altra faccenda.} e gli indici. +\noindent Il file \texttt{preliminari.tex} conterrà presumibilmente il sommario, molto facoltativamente i ringraziamenti\footnote{I ringraziamenti in una tesi non sono quasi mai necessari; lo sono quando bisogna ringraziare una istituzione o una o più persone \emph{esterne} alla propria università che hanno messo a disposizione le loro strutture o le loro competenze per lo svolgimento della tesi. Non si ringraziano genitori, fidanzati/e, amici, e tutti i parenti di ogni grado, il quali saranno più che contenti di sapervi laureati, piuttosto che vedere il loro nome scritto sulla tesi\dots\ Inoltre rappresenta un atto di piaggeria ringraziare il o i propri relatori; essi hanno svolto un loro compito istituzionale, non vi hanno fatto un piacere. Naturalmente questo non vieta che la consuetudine del lavoro assieme non abbia dato origine a sentimenti di reciproca stima e anche di amicizia, ma questa è un'altra faccenda.} e gli indici. -Mentre per i ringraziamenti si è già sottolineata la loro utilità solo in certe circostanze e la loro inutilità quando quelle circostanze non sussistono; per il “sommario” la questione è diversa. Infatti in italiano la parola “sommario” può voler dire diverse cose; può indicare una breve descrizione del contenuto di un documento e in questo caso la lingua inglese è più precisa perché indica questa descrizione col nome di \emph{abstract}. “Sommario” può indicare un riassunto o una sinossi piuttosto approfonditi e in questo caso l'inglese usa il nome di \emph{summary}. Inoltre “sommario” può essere usato in italiano come sinonimo di “indice generale”, mentre l'inglese usa solamente la locuzione nominale \emph{table of contents}. Con \TOPtesi l'abstract si crea con l'ambiente \amb{abstract} con un'avvertenza: se lo si scrive in italiano bisogna cambiargli il nome da “Sommario” in qualcosa d'altro che personalmente non saprei come scegliere; se lo si volesse chiamare “Breve descrizione”, per esempio, bisognerebbe aggiungere nel preambolo l'istruzione +Per i ringraziamenti si è già sottolineata la loro utilità solo in certe circostanze e la loro inutilità quando quelle circostanze non sussistono; per il “sommario” la questione è diversa. Infatti in italiano la parola “sommario” può voler dire diverse cose; può indicare una breve descrizione del contenuto di un documento e in questo caso la lingua inglese è più precisa perché indica questa descrizione col nome di \emph{abstract}. “Sommario” può indicare un riassunto o una sinossi piuttosto approfonditi e in questo caso l'inglese usa il nome di \emph{summary}. Inoltre “sommario” può essere usato in italiano come sinonimo di “indice generale”, mentre l'inglese usa solamente la locuzione nominale \emph{table of contents}. Con \TOPtesi l'abstract si crea con l'ambiente \amb{abstract} con un'avvertenza: se lo si scrive in italiano bisogna cambiargli il nome da “Sommario” in qualcosa d'altro che personalmente non saprei come scegliere; se lo si volesse chiamare “Breve descrizione”, per esempio, bisognerebbe aggiungere nel preambolo l'istruzione \begin{sintassi} \cs{addto}\Marg{\cs{captionsintalian}}\Marg{\cs{renewcommand}\cs{abstractname}\Marg{Breve descrizione}} \end{sintassi} @@ -2374,7 +2398,7 @@ mentre componendo in inglese (e probabilmente anche in altre lingue) non è nece Per l'indice generale e gli altri indici non occorre fare nulla se non quanto è descritto più avanti in merito al comando \cs{indici}. -Per il riassunto o la sinossi approfonditi (da comporsi solo se \emph{non} si è usato l'ambiente \amb{abstract}) lo si introduce con il comando \cs{sommario}, che compone un capitolo non numerato intitolato Sommario in italiano e Summary in inglese. Un capitolo implica non solo un titolo ma anche alcune pagine di testo; il capitolo può anche essere strutturato in paragrafi, sottoparagrafi e contenere anche delle figure; sarebbe preferibile evitare qualunque numerazione. In ogni caso un riassunto deve essere significativamente più breve della tesi. Se il sommario è lungo abbastanza da meritare di essere strutturato in paragrafi, sottoparagrafi, eccetera, allora il tutto deve essere adeguatamente numerato; per quel che si ègià detto in precedenza, se il sommario è inserito nella parte iniziale (front matter) i comandi \cs{chapter} asteriscati non numerano niente e non inviano nulal all'indice generale; quindi sarebbe meglio che un sommario strutturato sia composto come un capitolo ordinario avente per titolo la parola “Sommario”; inoltre va inserito nella parte principale. +Per il riassunto o la sinossi approfonditi (da comporsi solo se \emph{non} si è usato l'ambiente \amb{abstract}) lo si introduce con il comando \cs{sommario}, che compone un capitolo non numerato intitolato Sommario in italiano e Summary in inglese. Un capitolo implica non solo un titolo ma anche alcune pagine di testo; il capitolo può anche essere strutturato in paragrafi, sottoparagrafi e contenere anche delle figure; sarebbe preferibile evitare qualunque numerazione. In ogni caso un riassunto deve essere significativamente più breve della tesi. Se il sommario è lungo abbastanza da meritare di essere strutturato in paragrafi, sottoparagrafi, eccetera, allora il tutto deve essere adeguatamente numerato; per quel che si è già detto in precedenza, se il sommario è inserito nella parte iniziale (front matter) i comandi \cs{chapter} asteriscati non numerano niente e non inviano nulla all'indice generale; quindi sarebbe meglio che un sommario strutturato sia composto come un capitolo ordinario avente per titolo la parola “Sommario”; inoltre va inserito nella parte principale. In alcuni corsi di studio il riassunto è richiesto come documento separato da consegnare in segreteria insieme alla tesi, affinché sia distribuito fra i commissari dell'esame di laurea insieme alla convocazione per lo svolgimento di questo esame. I commissari hanno quindi la possibilità di sapere con una certa precisione quello che sentiranno esposto dal laureando durante l'esame e avranno quindi anche il tempo e la possibilità di annotarsi possibili domande da rivolgere al candidato dopo la sua esposizione. Presso il Politecnico di Torino, alcuni corsi di studi richiedono questo riassunto ma raccomandano che non superi le due o tre pagine. Il laureando dovrebbe informarsi dettagliatamente presso la segreteria competente. @@ -2384,7 +2408,7 @@ Il file \texttt{capitolo1.tex} conterrà l'introduzione e in pratica esporrà lo I file \texttt{capitolo2.tex}, \texttt{capitolo3.tex}, eccetera, conterranno la descrizione del lavoro svolto e l'analisi critica dei risultati via via ottenuti; l'ultimo file prima delle appendici conterrà i commenti finali, quali ad esempio un sunto dei risultati raggiunti, una breve esposizione degli ulteriori sviluppi, possibili approfondimenti, eccetera. -Per e appendici il discorso è delicato: se, come evidenziato nel modello il file ne contiene una sola, sta bene che esso sia caricato dopo \cs{backmatter} dove i «capitoli» non sono numerati in nessun modo; se invece sono più d'una, è necessario che siano numerate, quindi il file che le contiene deve essere incluso fra \cs{appendix} e \cs{backmatter}. Il comando \cs{appendix} cambia il nome dell «capitolo» da “Capitolo” ad “Appendice” (nella lingua principale della tesi) e ne cambia la numerazione da numerica ad alfabetica. +Per le appendici il discorso è delicato: se, come evidenziato nel modello, il file ne contiene una sola, sta bene che esso sia caricato dopo \cs{backmatter} dove i «capitoli» non sono numerati in nessun modo; se invece sono più d'una, è necessario che siano numerate, quindi il file che le contiene deve essere incluso fra \cs{appendix} e \cs{backmatter}. Il comando \cs{appendix} cambia il nome dell «capitolo» da “Capitolo” ad “Appendice” (nella lingua principale della tesi) e ne cambia la numerazione da numerica ad alfabetica. Nelle varie appendici verranno raccolte le misure eseguite, gli sviluppi matematici, i listati dei programmi, le note critiche, le lunghe citazioni e tutte le altre cose che rovinerebbero la fluidità del testo, se fossero inserite direttamente nel corpo della tesi. @@ -2392,14 +2416,15 @@ La bibliografia conclude la tesi. A seconda del campo disciplinare in cui si svo Dopo la bibliografia possono trovare posto la nomenclatura, l'indice analitico e altri simili sezioni di consultazione particolare. +\goodpagebreak[5] \subsection{La scelta della codifica per il file sorgente}\label{sec:codifica} -Si noti che per comporre i file del corpo della tesi si possono usare direttamente le lettere accentate della tastiera italiana o quelle che si possono ottenere con combinazioni di tasti sia sotto Windows sia sotto Linux o Mac~OS~X; per default \textsf{TOPtesi} non specifica nessuna particolare codifica per l'input; ma perché il programma di tipocomposizione elabori correttamente i file sorgente, o si usa \prog{xelatex} o \prog{lualatex} ricordando di salvare i file con la codifica UTF-8\footnote{Ci si ricordi che UTF-8\index{UTF-8} è il nome della codifica, mentre \opz{utf8} è la sua sigla da usare come opzione per il pacchetto \pack{inputenc}; in linguaggio corrente anche \opz{utf8} viene chiamata codifica, ma è solo una transcodifica.}, oppure non si specifica nessuna particolare codifica ma si usano solo i caratteri ASCII a 7~bit; oppure ancora si usano i caratteri nazionali direttamente da tastiera ma si specifica la codifica che l'editor ha impiegato per salvare nei file i codici dei caratteri non ASCII, per esempio le lettere accentate; se si usa \prog{pdflatex}, suggerisco di specificare esplicitamente la codifica mediante il comando +Si noti che per comporre i file del corpo della tesi si possono usare direttamente le lettere accentate della tastiera italiana o quelle che si possono ottenere con combinazioni di tasti sia sotto Windows sia sotto Linux o Mac~OS~X; per default \textsf{TOPtesi} non specifica nessuna particolare codifica per l'input; ma perché il programma di tipocomposizione elabori correttamente i file sorgente, o si usa \prog{xelatex} o \prog{lualatex} ricordando di salvare i file con la codifica UTF-8\footnote{Ci si ricordi che UTF-8\index{UTF-8} è il nome della codifica, mentre \opz{utf8} è la sua sigla da usare come opzione per il pacchetto \pack{inputenc}; in linguaggio corrente anche \opz{utf8} viene chiamata codifica, ma è solo una transcodifica.}, oppure non si specifica nessuna particolare codifica ma si usano solo i caratteri ASCII a 7~bit; oppure ancora si usano i caratteri nazionali direttamente da tastiera ma si specifica la codifica che l'editor ha impiegato per salvare nei file i codici dei caratteri non ASCII, per esempio le lettere accentate; se si usa \prog{pdflatex}, suggerisco di specificare esplicitamente la codifica sempre mediante il comando \begin{verbatim} \usepackage[utf8]{inputenc} \end{verbatim} -che va bene sia per le macchine Windows, sia per quelle basate su UNIX. Dal 2018 il sistema \TeX\ parte dal presupposto che i file siano codificati in UTF-8\index{UTF-8}, ma bisogna comunque dirlo al programma di composizione perché \prog{pdflatex} non lo sa non è in grado di ricavarlo dal contenuto dei file -- se si usa \prog{xelatex} o \prog{lualatex} questa codifica è necessaria ma non bisogna esplicitarla nel file sorgente. +che va bene sia per le macchine Windows, sia per quelle basate su UNIX. Dal 2018 il sistema \TeX\ parte dal presupposto che i file siano codificati in UTF-8\index{UTF-8}, ma bisogna comunque dirlo al programma di composizione perché, se \prog{pdflatex} non lo sa, non è in grado di ricavarlo dal contenuto dei file -- se si usa \prog{xelatex} o \prog{lualatex} questa codifica è necessaria ma non bisogna esplicitarla nel file sorgente. Gli editor \TeXShop, \TeXworks, TeXstudio, Texmaker, e qualcun altro, consentono di usare la codifica \opt{utf8} che permette di inserire qualunque segno fra le decine o centinaia di migliaia che la codifica UNICODE consente. @@ -2423,7 +2448,7 @@ L'uso del pacchetto \pack{xspace} fa sì che esso, tramite il comando \cs{xspace Se l'editor consente di selezionare le maiuscole accentate da una tabella oppure consente di usare combinazioni di tasti per inserire direttamente le maiuscole accentate nel file sorgente, se ne faccia uso, perché la lettura del file sorgente ne guadagna moltissimo. Se si vuole o si deve usare \prog{pdflatex}, si deve caricare nel -preambolo tutto quello che è necessario per gestire quelle lingue scritte con alfabeti diversi, ma non mi si chieda come si fa, perché so dirlo solo per il greco. Per questa lingua, se si usa l'ortografia monotonica, basta inserire l'opzione della lingua \opt{greek} fra le opzioni \emph{della classe}; se si usa l'ortografia politonica\footnote{Il greco moderno può essere politonico o monotonico; quello antico è sempre e solo politonico, però le regole di sillabazione sono diverse; con \pack{polyglossia} non ci sono problemi; con \pack{babel} a tutt'oggi (2019) esiste l'attributo \opt{ancient} per selezionare la sillabazione antica oltre alla grafia politonica, ma non è ancora possibile disporre effettivamente della sillabazione antica completa.}, allora si deve richiedere per \pack{babel} lo specifico attributo seguendo questo procedimento (per \pack{polyglossia} si veda più avanti): +preambolo tutto quello che è necessario per gestire quelle lingue scritte con alfabeti diversi, ma non mi si chieda come si fa, perché so dirlo solo per il greco. Per questa lingua, se si usa l'ortografia monotonica, basta inserire l'opzione della lingua \opt{greek} fra le opzioni \emph{della classe}; se si usa l'ortografia politonica\footnote{Il greco moderno può essere politonico o monotonico; quello antico è sempre e solo politonico, però le regole di sillabazione sono diverse; con \pack{polyglossia} non ci sono problemi; con \pack{babel} esiste l'attributo \opt{ancient} per selezionare, tra l'altro, la sillabazione antica oltre alla grafia politonica, ma fino al 2019 non era ancora possibile disporre effettivamente della sillabazione antica completa.}, allora si deve richiedere per \pack{babel} lo specifico attributo seguendo questo procedimento (per \pack{polyglossia} si veda più avanti): \begin{verbatim} \documentclass[...,greek.ancient,...]{toptesi} ... @@ -2442,13 +2467,13 @@ oppure \end{verbatim} Al posto di \opt{ancient} si può specificare \opt{polutoniko}; \opt{polutoniko} si riferisce al greco moderno scritto con tutta la varietà di accenti e diviso in sillabe con i criteri adatti alla lingua moderna; \opt{ancient} si riferisce al greco classico che, oltre ad usare la solita varietà di accenti, usa altre regole per la sillabazione di questa varietà di lingua. -Per una tesi che tratti il greco antico in forma filologica, consiglio l'uso del pacchetto \pack{teubner}; visto che l'ho scritto io, un po' di réclame non guasta~\dots\ Bisogna però leggerne la documentazione con attenzione. In particolare conviene ricordare che \pack{teubner} non viene caricato se non è stato precedentemente specificata la lingua greca fra le opzioni, ma poi provvede da solo ad impostare l'attributo \opt{ancient} e tutte le altre caratteristiche necessarie per comporre in greco con il \emph{mark-up} filologico. A tutt'oggi (2019) il pacchetto \pack{teubner} non è stato adeguatamente controllato sotto \XeLaTeX\ e \LuaLaTeX. Probabilmente non è completamente compatibile, ma non sono ancora in grado di dire niente né in positivo né in negativo. +Per una tesi che tratti il greco antico in forma filologica, consiglio l'uso del pacchetto \pack{teubner}; visto che l'ho scritto io, un po' di réclame non guasta~\dots\ Bisogna però leggerne la documentazione con attenzione. In particolare conviene ricordare che \pack{teubner} non viene caricato se non è stato precedentemente specificata la lingua greca fra le opzioni, ma poi provvede da solo ad impostare l'attributo \opt{ancient} e tutte le altre caratteristiche necessarie per comporre in greco con il \emph{mark-up} filologico. A tutt'oggi (\the\year) il pacchetto \pack{teubner} non è stato adeguatamente controllato sotto \XeLaTeX\ e \LuaLaTeX. Probabilmente non è completamente compatibile, ma non sono ancora in grado di dire niente né in positivo né in negativo. %%% MODIFICARE LA FRASE PRECEDENTE QUANDO TEUBNER SARÀ A POSTO!!!! Immagino che per usare le lingue che si scrivono in cirillico, basti specificare l'opzione della lingua, come si fa per il greco. Per alcune altre lingue bisogna invece caricare l'apposito pacchetto, il quale provvede a tutte le impostazioni necessarie; in questi casi bisogna leggere con attenzione la documentazione di quel pacchetto. -Suggerisco di riferirsi al documento \emph{L'Arte di scrivere in diverse lingue con (Xe|Lua)LaTeX}, liberamente scaricabile dalla sezione Documentazione del sito \url{www.guitex.org}. Questa guida tratta molti argomenti utili per comporre in lingue straniere comprese alcune di quelle che si scrivono con insiemi di caratteri diversi da quelli latini; descrive anche molte caratteristiche delle tradizioni tipografiche in uso in nazioni diverse dall'Italia oltre, ovviamente, quelle della tradizione italiana. +Suggerisco di riferirsi al testo \emph{L'Arte di scrivere in diverse lingue con (Xe|Lua)LaTeX}, liberamente scaricabile dalla sezione Documentazione del sito \url{www.guitex.org}. Questa guida tratta molti argomenti utili per comporre in lingue straniere comprese alcune di quelle che si scrivono con insiemi di caratteri diversi da quelli latini; descrive anche molte caratteristiche delle tradizioni tipografiche in uso in nazioni diverse dall'Italia oltre, ovviamente, quelle della tradizione italiana. Ma, tornando alla codifica UTF-8, il problema non è tanto l'editor che consenta o non consenta di usare quella codifica; quasi tutti i sistemi operativi consentono di installare diversi driver per la tastiera del PC, cosicché con un semplice click del mouse si può passare da un alfabeto all'altro; il problema sono i tasti della tastiera sulla cui faccia è riportato il segno che si ottiene premendo quel tasto quando è attivo il driver corrispondente a quella specifica tastiera. Non è ovviamente possibile cambiare il disegno che appare sui tasti semplicemente cliccando per cambiare driver; forse lo si può fare con le tastiere virtuali dei PC \emph{touch screen}, ma con i PC normali questo non è possibile. Ecco quindi che la difficoltà di scrivere con un alfabeto diverso richiede una memoria ferrea per ricordare a quale segno dell'altro alfabeto corrisponda il tasto della propria tastiera. @@ -2464,13 +2489,13 @@ Sembra che sulle macchine Linux l'editor \prog{Vim} e, su tutte le macchine, l'e \subsection{La scelta della codifica per il file di uscita} -Quando si usa \prog{pdflatex}, solo per scrivere in inglese non è necessario specificare nessuna codifica per i font da usare per comporre la tesi; questo è parzialmente vero in quanto l'inglese, fra le lingue più comuni nel mondo occidentale, è l'unica che non fa uso di accenti o altri segni diacritici. Perciò la codifica di default \opt{OT1} per i font di uscita adatti per scrivere in inglese va benissimo e non è necessario specificare nulla. Ma attenzione: come ho già detto, se si deve inserire anche una sola parola diversa dall'inglese e che contenga un accento, o se si deve scrivere in “middle English”, che usava gli accenti, questa vecchia codifica non va assolutamente bene per produrre file PDF/A compatibili. Quindi anche per l'inglese sarebbe opportuno usare una codifica più avanzata. +Quando si usa \prog{pdflatex}, solo per scrivere in inglese non è necessario specificare nessuna codifica per i font da usare per comporre la tesi; questo è parzialmente vero in quanto l'inglese, fra le lingue più comuni nel mondo occidentale, è l'unica che non fa uso di accenti o altri segni diacritici. Perciò la codifica di default \opt{OT1} per i font di uscita adatti per scrivere in inglese va benissimo e non è necessario specificare nulla. Ma attenzione: come ho già detto, se si deve inserire anche una sola parola diversa dall'inglese e che contenga un accento, oppure se si deve scrivere in “middle English”, che usava gli accenti, questa vecchia codifica non va assolutamente bene per produrre file PDF composti con la cesura in fin di riga efficacemente eseguita. Quindi anche per l'inglese sarebbe opportuno usare una codifica più avanzata. Inoltre con la codifica \opt{OT1} la presenza di macro per gli accenti impedisce la divisione in sillabe o ne riduce molto l'efficacia; per l'italiano il problema è relativamente modesto perché normalmente gli accenti compaiono solo sull'ultima vocale delle parole \emph{tronche}. Quindi con questa codifica la parola \emph{qualità} viene divisa in “qua-lità” invece che in “qua-li-tà”. Invece in francese una parola come \emph{électricité} non viene divisa per niente a causa dell'accento sulla prima vocale. -Allora per tutte le lingue diverse dall'inglese, ma anche per l'inglese, è quanto mai opportuno specificare per i font di uscita la codifica \opt{T1}. C'è però un problemino, facilmente risolubile, ma bisogna pensarci: fino ad oggi (2018) i font di default usati da \pdfLaTeX\ sono i font della collezione Computer Modern con codifica \opt{OT1}; e ogni installazione del sistema \TeX li può usare sia nella versione “bitmapped” sia in quella PostScript Type~1. Quest'ultimo formato dei font dovrebbe essere quello da usare sempre con qualunque font per il formato PDF del file di uscita, perché questo formato è portabile da una macchina all'altra, indipendentemente dal sistema operativo usato. Se poi il file deve essere archiviato, esso deve essere in formato PDF, quindi, di fatto, non ci sono scelte. +Allora per tutte le lingue diverse dall'inglese, ma anche per l'inglese, è quanto mai opportuno specificare per i font di uscita la codifica \opt{T1}. C'è però un problemino, facilmente risolubile, ma bisogna pensarci: fino ad oggi (\the\year) i font di default usati da \pdfLaTeX\ sono i font della collezione Computer Modern con codifica \opt{OT1}; e ogni installazione del sistema \TeX li può usare sia nella versione “bitmapped” sia in quella PostScript Type~1. Quest'ultimo formato dei font dovrebbe essere quello da usare sempre con qualunque font per il formato PDF del file di uscita, perché questo formato è portabile da una macchina all'altra, indipendentemente dal sistema operativo usato. Se poi il file deve essere archiviato, esso deve essere in formato PDF, quindi, di fatto, non ci sono scelte. -I file della collezione Computer Modern con codifica \opt{T1}, conosciuti anche come font EC, sono invece distribuiti solo nella forma bitmapped, la quale, oltre ad essere vietata nei file PDF archiviabili, si legge molto male sullo schermo, se il programma di visualizzazione non è molto ben adattato ai font bitmapped. Esiste la collezione di font \Font{CM-Super} per ovviare a questo inconveniente (questa collezione è installata di default in ogni installazione \emph{completa} del sistema \TeX), ma questi font soffrono di un inconveniente che i font Latin Modern non hanno. Perciò è meglio usare i font della collezione Latin Modern, per cui nel preambolo del file da gestire con \prog{pdflatex} si specificherà: +I file della collezione Computer Modern con codifica \opt{T1}, conosciuti come font EC, sono invece distribuiti solo nella forma bitmapped, la quale, oltre ad essere vietata nei file PDF archiviabili, si legge molto male sullo schermo, se il programma di visualizzazione non è molto ben adattato ai font bitmapped. Esiste la collezione di font \Font{CM-Super} per ovviare a questo inconveniente (questa collezione è installata di default in ogni installazione \emph{completa} del sistema \TeX), ma questi font soffrono di un inconveniente che i font Latin Modern non hanno. Perciò è meglio usare i font della collezione Latin Modern, per cui nel preambolo del file da gestire con \prog{pdflatex} si specificherà: \begin{verbatim} \documentclass[...]{toptesi} ... @@ -2486,9 +2511,10 @@ Se invece il file viene gestito con \prog{xelatex} o \prog{lualatex}, oltre alla Naturalmente per gli utenti esperti di \LaTeX ci sono anche altri pacchetti usabili per impiegare altri font diversi da quelli della collezione Latin Modern; questi comunque, secondo me, sono i migliori per la loro completezza; inoltre, grazie al diverso disegno dei corpi minori, la lettura dei pedici e degli apici ne risulta agevolata. -Qui, per la composizione della tesi con \prog{pdflatex} segnalo solo la collezione dei font Times eXtended, richiamabili con i pacchetti \pack{newtxtext} e \pack{newtxmath}, e la collezione dei font Palatino eXtended, richiamabili con i pacchetti \pack{newpxtext} e \pack{newpxmath}. I Times sono font più stretti di quelli della collezione Latin Modern e sono forse indicati per rendere più compatta una tesi un po' voluminosa. I Palatino sono un po' più larghi dei font della collezione Latin Modern e talvolta allungano la tesi di qualche pagina. I nuovi pacchetti \pack{newtx...} e \pack{newpx...} sono configurabili con diverse opzioni; li consiglio a coloro che vogliono usare i font Times o Palatino, ma se posso dare un consiglio, direi che sia sempre preferibile usare i font Latin Modern dalle prestazioni migliori grazie ai corpi ottici; volendo si può usare il pacchetto \pack{cfr-lm} che consente di personalizzare fortemente le proprietà dei font Latin Modern da usare, per esempio permettendo l'uso delle cifre minuscole \ifPDFTeX\oldstylenums{1234567890}\else {\addfontfeature{Numbers=OldStyle}{1234567890}}\fi\ nel testo, e le cifre maiuscole 1234567890 nella composizione della matematica. +Qui, per la composizione della tesi con \prog{pdflatex} segnalo solo la collezione dei font Times eXtended, richiamabili con i pacchetti \pack{newtxtext} e \pack{newtxmath}, e la collezione dei font Palatino eXtended, richiamabili con i pacchetti \pack{newpxtext} e \pack{newpxmath} e la collezione dei font Libertinus testuali e matematici richiamabili con i pacchetti \pack{libertinus} e \pack{linetrtinust1math}. I Times sono font più stretti di quelli della collezione Latin Modern e sono forse indicati per rendere più compatta una tesi un po' voluminosa. I Palatino sono un po' più larghi dei font della collezione Latin Modern e talvolta allungano la tesi di qualche pagina. I nuovi pacchetti \pack{newtx...} e \pack{newpx...} sono configurabili con diverse opzioni; li consiglio a coloro che vogliono usare i font Times o Palatino, ma se posso dare un consiglio, direi che sia sempre preferibile usare i font Latin Modern dalle prestazioni migliori grazie ai corpi ottici; volendo si può usare il pacchetto \pack{cfr-lm} che consente di personalizzare fortemente le proprietà dei font Latin Modern da usare, per esempio permettendo l'uso delle cifre minuscole \ifPDFTeX\oldstylenums{1234567890}\else {\addfontfeature{Numbers=OldStyle}{1234567890}}\fi\ nel testo, e le cifre maiuscole 1234567890 nella composizione della matematica. I font Libertinus testuali e matematici, sono quelli usati nella composizione di questa guida. Sono molto compatti; la famiglia dei font a spaziatura fissa non si distingue tanto dai normali font tondi, anche se a ben guardare la spaziatura fissa è visibile; è che le singole lettere non sono sufficientemente diverse da quelle del tondo normale; in questo documento ho preferito sostituirli con i font New Computer Modern Mono, e mi pare che la scelta sia abbastanza funzionale; inoltre contengono anche i caratteri greci e cirillici. + -Tanto per confronto, questo testo di documentazione su \TOPtesi, quando è composto con il motore di composizione \prog{lualatex}, usa i font OpenType TeX Gyre Termes con codifica UNICODE presenti nella distribuzione \emph{completa} del sistema \TeX; come si vede la divisione delle parole in fin di riga non presenta inconvenienti particolari; forse con un testo di altro genere, con composizione in colonne strette o all'interno di tabelle, si potrebbe verificare la presenza di righe molto lasche, dove è stato allargato troppo lo spazio interparola. Per questa eventualità di ottenere righe lasche, quando si usa il programma di composizione \prog{pdflatex}, si consiglia sempre di usare la codifica \opt{T1}, perché certamente con questa codifica si hanno meno inconvenienti e le lettere accentate sono disegnate meglio. Se inoltre si usano i programmi \prog{pdflatex} o \prog{lualatex}, è conveniente invocare anche il pacchetto di estensione \pack{microtype} che consente di comporre ancora meglio le righe del testo; invece con \prog{xelatex} le funzionalità di questo pacchetto sono solo parzialmente usabili; comunque si può usare \pack{microtype} anche compilando con \prog{xelatex} sebbene i miglioramenti siano meno “vistosi” che con \prog{pdflatex} o \prog{lualatex}\footnote{“Vistosi” è fra virgolette, perché il compito di \pack{microtype} è quello di \emph{non far vedere} i piccolissimi difetti che si hanno quando non lo si usa; troppe righe con cesura alla fine, ruscelletti bianchi che serpeggiano fra le righe; spazi interparola disomogenei e altri simili difettucci. Voglio segnalare che con i normali word processor la divisione in sillabe in fin di riga è consentita, ma di solito non viene attivata dall'utente; inoltre anche impostando questa funzionalità, lavorando in italiano l'apostrofo impedisce la sillabazione, quindi in certe circostanze gli spazi interparola diventano immensi. Ecco perché con i word processor il risultato della composizione non è di qualità tipografica.}. +Se si usano i programmi \prog{pdflatex} o \prog{lualatex}, è conveniente invocare anche il pacchetto di estensione \pack{microtype} che consente di comporre ancora meglio le righe del testo; invece con \prog{xelatex} le funzionalità di questo pacchetto sono solo parzialmente usabili; comunque si può usare \pack{microtype} anche compilando con \prog{xelatex} sebbene i miglioramenti siano meno “vistosi” che con \prog{pdflatex} o \prog{lualatex}\footnote{“Vistosi” è fra virgolette, perché il compito di \pack{microtype} è quello di \emph{non far vedere}, eliminandoli, i piccolissimi difetti che si hanno quando non lo si usa; troppe righe con cesura alla fine, ruscelletti bianchi che serpeggiano fra le righe; spazi interparola disomogenei e altri simili difettucci. Voglio segnalare che con i normali word processor la divisione in sillabe in fin di riga è consentita, ma di solito deve essere esplicitamente attivata dall'utente; inoltre anche impostando questa funzionalità, lavorando in italiano l'apostrofo impedisce la sillabazione, quindi in certe circostanze gli spazi interparola diventano immensi. Ecco un altro motivo per il quale con i word processor il risultato della composizione non è di qualità tipografica.}. %\enlargethispage{\baselineskip} @@ -2500,17 +2526,17 @@ In un foglio A4, di 210\unit{mm} per 297\unit{mm} quello spazio lascia complessi Quelle erano le prescrizioni della segreteria del Politecnico; e continuano ad essere valide, specialmente in vista dell'archiviazione elettronica che viene fatta per tutte le tesi. In altri Atenei vengono accettati anche altri formati, specialmente il formato B5 in molte facoltà umanistiche. \TOPtesi, pertanto accetta anche altre opzioni di formato di carta e provvede alle giuste impostazioni anche per quel che riguarda questo tipo di informazioni all'interno del file PDF di uscita; questo in vista della stampa, ma più ancora per le lettura a video. Ovviamente con i formati di carta più piccoli le dimensioni sono ridotte proporzionalmente, tranne lo scartamento delle righe di testo che viene mantenuto uguale a quello che si sarebbe usato con la carta~A4; il numero di righe di una pagina di solo testo, evidentemente, su fogli di minori dimensioni diminuisce quasi proporzionalmente. -Per questi motivi \TOPtesi, qualunque sia il formato della carta, divide lo spazio complessivo in parti uguali fra i margini laterali quando si desidera produrre una versione del file PDF da leggere a video. Invece divide lo spazio complessivo in parti diverse se il file PDF deve essere stampato; in particolare la proporzioni fra il margine interno e quello esterno sono uguali a quelle fra la giustezza e la larghezza della carta e questa stessa proporzione viene usata fra il margine superiore e quello inferiore; ne consegue che, se non si usano caratteri troppo grandi, una delle diagonali dello specchio di stampa coincide con la corrispondente diagonale della pagina. Questa disposizione coincide con uno dei disegni classici del layout di pagina. +Per questi motivi \TOPtesi, qualunque sia il formato della carta, divide lo spazio complessivo in parti uguali fra i margini laterali quando si desidera produrre una versione del file PDF da leggere a video. Invece divide lo spazio complessivo in parti diverse se il file PDF deve essere stampato; in particolare la proporzioni fra il margine interno e quello esterno sono uguali a quelle fra la giustezza e la larghezza della carta e questa stessa proporzione viene usata fra il margine superiore e quello inferiore; ne consegue che, se non si usano caratteri troppo grandi, una delle diagonali dello specchio di stampa coincide con la corrispondente diagonale della pagina. Questa disposizione coincide con uno dei disegni classici del layout di pagina\footnote{Si veda la documentazione del pacchetto \pack{dlassiclayout}; le disposizioni del Politecnico di Torino non sono quindi quelle solite legate alla tradizione dattilografica, ma sono piuttosto classiche. Certo esistono pacchetti che permettono di ottenere pagine che possono piacere di più, e proprio per questo si sono indicate nella prefazione altre classi con cui si possono ottenere stili diversi.}. -Ora si tenga presente che per la leggibilità confortevole del testo sarebbe opportuno che in ogni riga fossero presenti tanti caratteri, spazi e segni di interpunzione compresi, in numero compreso nella fascia di $66\pm6$. Ovviamente a pari giustezza del testo il numero di caratteri varia a seconda del loro corpo e del loro disegno; una buona indicazione approssimata della “larghezza” di un font è dato dalla lunghezza della stringa che contiene l'alfabeto minuscolo. Secondo Bringhurst (vedi la guida tematica \url{https://guitex.org/home/images/doc/GuideGuIT/IntroPageDesign.pdf} nella pagina~6) la lunghezza ottima di una riga di stampa (la giustezza) dovrebbe essere pari a due volte e mezza la lunghezza dell'alfabeto; si vede anche nella figura~1.1 di quella guida, che i font di default di \TOPtesi, i Latin Modern, sono lunghi 128\unit{pt} pari a 45\unit{mm}; quindi la giustezza ottimale dovrebbe essere di 113\unit{mm} invece dei 150\unit{mm} prescritti dalla segreteria\footnote{Questi conti e quelli immediatamente successivi sono arrotondati al millimetro; non è importantissimo fare i conti con grande precisione, visto che la regola di Bringhurst concede circa il 10\% di tolleranza.}. Con i Times che hanno una larghezza dell'alfabeto di 119\unit{pt} pari a 42\unit{mm} la giustezza ottimale dovrebbe essere di 105\unit{mm}; con i Palatino l'alfabeto è lungo 133\unit{pt} pari a 47\unit{mm} e la giustezza ottimale sarebbe di 118\unit{mm}. Aumentando il corpo a 12\unit{pt} le tre giustezze ottimali appena determinate diventano rispettivamente di 136\unit{mm}, 126\unit{mm} e 142\unit{mm}. come si vede solo componendo in corpo 12\unit{pt} con i font Palatino si resterebbe dentro i margini indicati (verso il limite superiore) dalla regola di Bringhurst; con i Times usati in questo testo e la giustezza di 150\unit{mm} si arriva ad una numero medio di caratteri per ogni riga di circa 79 caratteri, fuori del margine superiore indicato dalla regola di Bringhurst. Non è un eccesso terribile, ed è sopportabile; ma le esigenze di archiviazione dell'Ateneo richiedono di non sprecare spazio nelle pagine senza però sacrificare il contenuto. +Ora si tenga presente che per la leggibilità confortevole del testo sarebbe opportuno che in ogni riga fossero presenti tanti caratteri, spazi e segni di interpunzione compresi, in numero compreso nella fascia di $66\pm6$. Ovviamente a pari giustezza del testo il numero di caratteri varia a seconda del loro corpo e del loro disegno; una buona indicazione approssimata della “larghezza” di un font è dato dalla lunghezza della stringa che contiene l'alfabeto minuscolo. Secondo Bringhurst (vedi la guida tematica \url{https://guitex.org/home/images/doc/GuideGuIT/IntroPageDesign.pdf} nella pagina~6) la lun"ghezza ottimale di una riga di stampa (la giustezza) dovrebbe essere pari a due volte e mezza la lunghezza dell'alfabeto; si vede anche nella figura~1.1 di quella guida, che i font di default di \TOPtesi, i Latin Modern, sono lunghi 128\unit{pt} pari a 45\unit{mm}; quindi la giustezza ottimale dovrebbe essere di 113\unit{mm} invece dei 150\unit{mm} prescritti dalla segreteria\footnote{Questi conti e quelli immediatamente successivi sono arrotondati al millimetro; non è importantissimo fare i conti con grande precisione, visto che la regola di Bringhurst concede circa il 10\% di tolleranza.}. Con i Times che hanno una larghezza dell'alfabeto di 119\unit{pt} pari a 42\unit{mm} la giustezza ottimale dovrebbe essere di 105\unit{mm}; con i Palatino l'alfabeto è lungo 133\unit{pt} pari a 47\unit{mm} e la giustezza ottimale sarebbe di 118\unit{mm}; con i Libertinus l'alfabeto è lungo 122\unit{pt} pari a 43\unit{mm} e la giustezza ottimale sarebbe di 108\unit{mm.} Aumentando il corpo a 12\unit{pt} le quattro giustezze ottimali appena determinate diventano rispettivamente di 136\unit{mm}, 126\unit{mm}, 142\unit{mm} e 130\unit{mm}. Come si vede solo componendo in corpo 12\unit{pt} con i font Palatino si resterebbe dentro i margini indicati (verso il limite superiore) dalla regola di Bringhurst; con i Libertinus usati in questo testo e la giustezza di 150\unit{mm} si arriva ad un numero medio di caratteri per ogni riga di circa 76 caratteri, fuori del margine superiore indicato dalla regola di Bringhurst. Non è un eccesso terribile, ed è sopportabile; ma le esigenze di archiviazione dell'Ateneo richiedono di non sprecare spazio nelle pagine senza però sacrificare il contenuto. Queste sarebbero le regole; naturalmente le impostazioni della classe permettono di scegliere il corpo normale come si desidera entro limiti ragionevoli in modo da avvicinarsi alle dimensioni ottimali legate alla regola di Bringhurst; visto che non si archivia più in forma cartacea, fissare il formato della pagina al B5 per la versione da depositare in segreteria sarebbe forse la soluzione migliore; per la stampa ognuno si regoli come preferisce. -Con il formato B5 i problemi di leggibilità indicati sopra non esistono; meno che mai con il formato A5; tuttavia i formati più piccoli a pari contenuto richiedono più pagine, quindi i problemi di archiviazione “cartacea” si ripresentano. Inoltre i formati più piccoli richiedono una paziente messa a punto delle singole pagine, perché in una tesi con molta matematica ed altri oggetti “ingombranti” potrebbero esserci molte pagine mal composte; suggerirei di non scendere mai sotto il formato~B5. +Con il formato B5 i problemi di leggibilità indicati sopra non esistono; meno che mai con il formato A5; tuttavia i formati più piccoli a pari contenuto richiedono più pagine. Inoltre i formati più piccoli richiedono una paziente messa a punto delle singole pagine, perché in una tesi con molta matematica ed altri oggetti “ingombranti” potrebbero esserci molte pagine mal composte; suggerirei di non scendere mai sotto il formato~B5. Insomma \TOPtesi sacrifica un poco la leggibilità, ma viene incontro ad altre esigenze. Altre classi possono avere layout più consoni alle regole di Bringhurst, ma anche in formato A4 usano più pagine. -Alla luce di quanto sopra descritto, \TOPtesi non solo usa uno scartamento leggermente minore di quello ritenuto ottimale per i font in uso, ma richiede che l'utente non metta mano ad allontanare le righe; per lo stesso motivo \TOPtesi invita gli utenti a servirsi della stampa fronte/retro. +Alla luce di quanto sopra descritto, \TOPtesi non solo usa uno scartamento leggermente minore di quello ritenuto ottimale per i font in uso, ma richiede che l'utente non metta mano ad allontanare le righe; per questo ed altri motivi \TOPtesi invita gli utenti a servirsi della stampa fronte/retro. -Il pacchetto \textsf{TOPtesi} accetta anche l'opzione di composizione in \emph{bianca e volta}, ma di default compone su una facciata sola della pagina cartacea (impostazione di default della sottostante classe \class{report}; anche il formato della carta, di default \texttt{letter}) richiama i formati di carta americani; resta responsabilità dell'utente quella di specificare l'opzione \opz{twoside} al fine di ottimizzare lo spazio disponibile stampando su entrambe le facciate di ogni pagina, e una delle opzioni \opz{a4paper} (default di \textsf{TOPtesi}) o \opz{b5paper}, o qualsiasi altra opzione di formato di carta accettata dalla classe \class{report} per confezionare lo specchio di stampa in modo più consono al formato della carta; in realtà \TOPtesi provvede a realizzare uno specchio di stampa che si adatta particolarmente bene ai formati ISO, mentre non rispetta i formati americani, anche se gli specchi di stampa tutto sommato vanno bene anche per questi formati. In Italia i formati americani non sono in commercio, però potrebbero servire per gli studenti che seguono un programma di doppio titolo in congiunzione con un'università statunitense. +Il pacchetto \textsf{TOPtesi} accetta anche l'opzione di composizione in \emph{bianca e volta}, ma di default compone su una facciata sola della pagina cartacea, impostazione di default della sottostante classe \class{report}; resta responsabilità dell'utente quella di specificare l'opzione \opz{twoside} al fine di ottimizzare lo spazio disponibile stampando su entrambe le facciate di ogni pagina, e una delle opzioni \opz{a4paper} (default di \textsf{TOPtesi}) o \opz{b5paper}, o qualsiasi altra opzione di formato di carta accettata dalla classe \class{report} per confezionare lo specchio di stampa in modo più consono al formato della carta; in realtà \TOPtesi provvede a realizzare uno specchio di stampa che si adatta particolarmente bene ai formati ISO, mentre lo è n o' di meno con i formati americani. In Italia i formati americani non sono in commercio, però potrebbero servire per gli studenti che seguono un programma di doppio titolo in congiunzione con un'università statunitense. Inoltre qual è la differenza fra la stampa in bianca e quella in bianca e volta? È quella che si osserva nei libri composti meglio: cioè, nelle testatine delle pagine stampate solo in bianca compare sempre e solo il titolo del capitolo corrente, mentre stampando in bianca e volta nelle testatine delle pagine \emph{pari} compare il titolo del capitolo, mentre nelle pagine \emph{dispari} compare il titolo del paragrafo con cui comincia quella pagina. Cercare qualche argomento nel testo stampato risulta molto più facile se le testatine delle pagine pari e di quelle dispari contengono tutta l'informazione necessaria. @@ -2537,13 +2563,7 @@ lingue ci si vuole servire \textcolor{red}{oltre all'italiano e all'inglese che \subsection{Configurazione iniziale} -Per la prima parte, cioè per configurare il sistema \TeX per -gestire diverse lingue, subito dopo l'installazione si lanci -\LaTeX su un file di prova qualunque, per esempio -\file{sample.tex} (facente parte della distribuzione del sistema \TeX), poi se ne apra il file \texttt{.log}, -nell'esempio: \texttt{sample.log}; nelle prime righe di questo file -si trovano le lingue per le quali il sistema \TeX è già -configurato. +Per la prima parte, cioè per configurare il sistema \TeX per gestire diverse lingue, subito dopo l'installazione si lanci \LaTeX su un file di prova qualunque, per esempio \file{sample.tex} (facente parte della distribuzione del sistema \TeX), poi se ne apra il file \texttt{.log}, nell'esempio: \texttt{sample.log}; nelle prime righe di questo file si trovano le lingue per le quali il sistema \TeX è già configurato. Componendo con \prog{pdflatex} questo file di documentazione, il file \texttt{toptesi\discretionary{}{-}{-}it.log} nel 2012 conteneva nelle prime righe quanto segue: @@ -2578,20 +2598,20 @@ Babel <3.9k> and hyphenation patterns for 81 languages loaded. \end{verbatim} Non c'è bisogno di preoccuparsi; nella mia macchina sono installate alcune lingue in più rispetto a quelle di default, ma se il numero è così alto, vuol dire che sono installate tutte le lingue che i programmi di composizione del sistema \TeX sono capaci di gestire; fra queste c'è l'italiano, tre versioni di greco, tre versioni di latino, eccetera. L'elenco completo può venire letto nei file \file{pdflatex.log}, \file{xelatex.log} che si trovano in uno degli alberi del sistema \TeX. La lettura è un po' criptica, anche perché il file è piuttosto lungo, ma basta cercare la stringa \texttt{l@english}, e di lì in avanti è registrato tutto quello che serve conoscere per l'elenco delle lingue installate. \LuaLaTeX, diversamente da \pdfLaTeX\ e da \XeLaTeX, carica le impostazioni per le lingue del documento, sillabazione compresa, solo al momento di compilare quel dato documento; per questo compilatore solo l'inglese è precaricato, ma al momento opportuno esso si carica tutto ciò che è necessario per comporre il testo in ciascuna dell'ottantina di lingue che riesce a gestire, o meglio in ciascuna delle lingue specificate per la composizione di ogni particolare documento, massimo un'ottantina (dovrebbero essere sufficienti\dots). -Quel listato o quella riga è quanto appare sempre quando si usa la distribuzione \TeXLive completa o quando si usa la distribuzione \MiKTeX~2.9 (o successiva) completa; serve per dare un'idea di quello che contengono le prime righe del file in questione. Se, come è possibile, dopo la prima installazione il vostro primo file \texttt{.log} non contiene fra le lingue elencate anche l'italiano (oppure sono elencate solo una mezza dozzina di lingue, oppure si dice che le lingue installate sono in un numero molto inferiore a 80), allora questa è la cosa più urgente da fare; non vorrete mica che la vostra tesi, scritta in italiano, abbia le parole divise in sillabe in fin di riga con le regole angloamericane? Se poi siete su un programma di doppia laurea e dovete scrivere parte della tesi nella lingua dell'università straniera di cui prendete l'altro titolo, allora è necessario avere disponibile almeno anche quella lingua. Questo inconveniente si manifesta quando si installa una versione ridotta delle distribuzioni del sistema \TeX, oppure quando si usa la distribuzione \TeXLive/Debian (sempre sconsigliabile per vari motivi, non escluso il fatto che l'installazione di default di solito prevede solo la sillabazione per l'inglese). +Quel listato o quella riga è quanto appare sempre quando si usa la distribuzione \TeXLive completa o quando si usa la distribuzione \MiKTeX~2.9 (o successiva) completa; serve per dare un'idea di quello che contengono le prime righe del file in questione. Se, come è possibile, dopo la prima installazione il vostro primo file \texttt{.log} non contiene fra le lingue elencate anche l'italiano (oppure sono elencate solo una mezza dozzina di lingue, oppure si dice che il numero delle lingue installate è molto inferiore a 80), allora questa è la cosa più urgente da fare; non vorrete mica che la vostra tesi, scritta in italiano, abbia le parole divise in sillabe in fin di riga con le regole angloamericane? Se poi siete su un programma di doppia laurea e dovete scrivere parte della tesi nella lingua dell'università straniera di cui prendete l'altro titolo, allora è necessario avere disponibile almeno anche quella lingua. Questo inconveniente si manifesta quando si installa una versione ridotta delle distribuzioni del sistema \TeX, oppure quando si usa la distribuzione \TeXLive/Debian (sempre sconsigliabile per vari motivi, non escluso il fatto che l'installazione di default di solito prevede solo la sillabazione per l'inglese). -Le regole per inizializzare le lingue gestibili differiscono da distribuzione a distribuzione del sistema \TeX. Bisogna quindi leggere la documentazione che accompagna la distribuzione che si sta usando; qui darò alcuni cenni relativi alle distribuzioni che io conosco. +{\tolerance=3000 Le regole per inizializzare le lingue gestibili differiscono da distribuzione a distribu"zio"ne del sistema \TeX. Bisogna quindi leggere la documentazione che accompagna quella che si sta usando; qui darò alcuni cenni relativi alle distribuzioni che io conosco.\par} \subsubsection{\MiKTeX} Questa distribuzione è forse quella che più sovente viene installata nella forma “basic” (errore! mai installare la versione di base, perché è tutt'altro che completa) e perciò è fra quelle che hanno bisogno di essere gestite. Si apre il wizard da \texttt{Avvio\discretionary{}{|}{|}Programmi\discretionary{}{|}{|}MiKTeX\discretionary{}{|}{|}MiKTeX\textvisiblespace Settings}. Esso apre una finestra di dialogo con diverse linguette; si clicca sulla linguetta \textsf{Languages} e viene aperta un'altra finestra con l'elenco di tutte le lingue gestibili, alcune già con il segno di spunta alla loro sinistra nell'apposito quadratino, altre senza il segno di spunta. Potete cliccare per togliere il segno di spunta sulle lingue già spuntate ma che non userete mai (ma lo sconsiglio) e potete aggiungere il segno di spunta cliccando nel quadratino corrispondente alle lingue desiderate (ma consiglio di spuntarle tutte). -Poi, usciti dal dialogo per la scelta delle lingue, si clicca \texttt{OK} e si torna sulla linguetta \textsf{General}; qui si trovano due bottoni il primo dei quali serve per aggiornare il database dei nomi dei file, mentre il secondo serve per re-inizializzare i file di formato, cioè quei file che contengono già la traduzione in linguaggio macchina di tutte le operazioni che la distribuzione del sistema \TeX è capace di compiere con i suoi vari applicativi. La divisione in sillabe è una di quelle operazioni che deve essere inizializzata, perché richiede strutture dati particolari che sarebbe troppo lungo generare di volta in volta (\LuaLaTeX, però ci riesce). Si clicchi sul bottone per re-inizializzare i file di formato; alla fine di questa operazione si può chiudere il wizard e controllare, dopo aver ricomposto, per esempio, \file{sample.tex} che le prime righe del file \texttt{.log} contengano tutte le lingue che volete usare. +Poi, usciti dal dialogo per la scelta delle lingue, si clicca \texttt{OK} e si torna sulla linguetta \textsf{General}; qui si trovano due bottoni il primo dei quali serve per aggiornare il database dei nomi dei file, mentre il secondo serve per re-inizializzare i file di formato, cioè quei file che contengono già la traduzione in linguaggio macchina di tutte le operazioni che la distribuzione del sistema \TeX è capace di compiere con i suoi vari applicativi. La divisione in sillabe è una di quelle operazioni che deve essere inizializzata, perché richiede strutture dati particolari che sarebbe troppo lungo generare di volta in volta (\LuaLaTeX, però ci riesce). Si clicchi sul bottone per re-inizializzare i file di formato; alla fine di questa operazione si può chiudere il wizard e controllare, dopo aver ricomposto, per esempio, \file{sample.tex}, che le prime righe del file \texttt{.log} contengano tutte le lingue che volete usare. \subsubsection{\TeXLive} -La distribuzione \TeXLive completa distribuita sul circuito \sigla{ctan} nasce già configurata per tutte le lingue che \LaTeX è capace di gestire, quindi anche l'italiano; bisogna ricorrere ai suoi comandi di configurazione solo se si vuole aggiungere una lingua la cui sillabazione non sia distribuita insieme a \TeX Live. Questo evento è talmente raro che non vale la pena di insistervi sopra. Tuttavia un laureando che svolga la sua tesi sull'ostrogoto altomedievale e disponesse solo della sillabazione per l'ostrogoto classico e per l'ostrogoto contemporaneo, si troverebbe in difficoltà; infatti, prima ancora di inserire le regole per l'ostrogoto altomedievale, dovrebbe scriversi le regole di sillabazione e codificarle nel linguaggio specifico richiesto dal sistema \TeX; questo è tutt'altro che facile ed è riservato a specialisti molto avanzati. +La distribuzione \TeXLive completa distribuita sul circuito \sigla{ctan} nasce già configurata per tutte le lingue che \LaTeX è capace di gestire, quindi anche l'italiano. Bisogna ricorrere ai suoi comandi di configurazione solo se si vuole aggiungere una lingua la cui sillabazione non sia distribuita insieme a \TeX Live. Questo evento è talmente raro che non vale la pena di insistervi sopra. Tuttavia un laureando che svolga la sua tesi sull'ostrogoto altomedievale e disponesse solo della sillabazione per l'ostrogoto classico e per l'ostrogoto contemporaneo, si troverebbe in difficoltà; infatti, prima ancora di inserire le regole per l'ostrogoto altomedievale, dovrebbe scriversi le regole di sillabazione e codificarle nel linguaggio specifico richiesto dal sistema \TeX; questo è tutt'altro che facile ed è riservato a specialisti molto avanzati. -Per la distribuzione \TeXLive/Debian, che nella versione di base è predisposto solo per la sillabazione solo in inglese, basta caricare (con gli strumenti specifici della particolare piattaforma Linux conforme alle prescrizioni del consorzio Debian) il pacchetto di estensione delle lingue, l'installazione del quale permette di gestire l'insieme completo dele lingue che \LaTeX sa gestire. +Per la distribuzione \TeXLive/Debian, che nella versione di base è predisposto solo per la sillabazione in inglese, basta caricare (con gli strumenti specifici della particolare piattaforma Linux conforme alle prescrizioni del consorzio Debian) il pacchetto di estensione delle lingue, l'installazione del quale permette di gestire l'insieme completo dele lingue che \LaTeX sa gestire. \subsubsection{Mac\TeX} @@ -2609,8 +2629,7 @@ Poi nel corpo della tesi si includeranno i brani in francese dentro l'ambiente \ \begin{verbatim} I primi versi della Marsigliese sono i seguenti: «\begin{otherlanguage*}{french} -Allons enfants de la Patrie / Les jours de la gloire -sont arrivés. +Allons enfants de la Patrie / Les jours de la gloire sont arrivés. \end{otherlanguage*}» \end{verbatim} L'ambiente \amb{otherlanguage*}\marg{lingua} è definito sia da \pack{babel} sia da \pack{polyglossia}; la versione asteriscata attiva la sillabazione e altre peculiarità della lingua francese, ma non cambia le impostazioni generali valide per l'intero documento. @@ -2655,15 +2674,16 @@ Oppure, se la lingua richiede un alfabeto speciale, se ne può specificare il fo \newfontfamily{\greekfont}{GFS Bodoni} \end{verbatim} Ciò fatto si dispone per ogni lingua, tranne quella principale, di un ambiente col nome uguale alla lingua, che all'occorrenza seleziona anche il font specifico, la cui famiglia abbia un nome che comincia con lo stesso nome della lingua. Per esempio: -\begin{verbatim} -\begin{greek} +% Arrampicata sui vetri per ovviare a Inconsolata che non ha il greco +\begin{flushleft}\fontspec{CMU Typewriter Text Light}\obeylines +\Bambiente{greek} Οἰόνται τινές, βασιλεῦ Γέλων, τοῦ ψάμμον τὸν ἀριθμὸν ἄπειρον εἶμεν τῷ πλήθει· λέγω δὲ οὐ μόνον τοῦ περὶ Συρακούσας τε καὶ τὰν ἄλλαν Σικελίαν ὑπάρχοντος, ἀλλὰ καὶ τοῦ κατὰ πᾶσαν χώραν τάν τε οἰκημέναν καὶ τὰν ἀοὶκητον. -\end{greek} -\end{verbatim} -permette di comporre la citazione: +\Eambiente{greek} +\end{flushleft} +permette di comporre con il font associato alla lingua greca (\Font{GFS Bodoni}) la citazione: \begin{quote} \begin{greek} Οἰόνται τινές, βασιλεῦ Γέλων, τοῦ ψάμμον τὸν ἀριθμὸν ἄπειρον @@ -2672,7 +2692,7 @@ permette di comporre la citazione: χώραν τάν τε οἰκημέναν καὶ τὰν ἀοὶκητον. \end{greek} \end{quote} -con il font associato alla lingua greca: \Font{GFS Bodoni}. +. Anche usando \prog{xelatex} e \prog{lualatex} bisogna definire \cs{sommario} e \cs{ringraziamenti} nella stessa maniera illustrata qui di seguito per comporre con il programma \prog{pdflatex}. @@ -2708,7 +2728,7 @@ I programmi \prog{xelatex} e \prog{lualatex} sono in grado di gestire le lingue \subsubsection{Comporre la tesi di dottorato secondo il modello della Scuola di Dottorato del Politecnico di Torino} -La Scuola di Dottorato (ScuDo) del Politecnico di Torino richiede un ulteriore impostazione, che riguarda specialmente il frontespizio e il retrofrontespizio. Tuttavia in questi paragrafi che riguardano le lingue si precisa subito che in quella Scuola la tesi deve essere composta in inglese e solo in inglese. Per la classe \TOPtesi non ci sono problemi nel comporre in inglese, ma le altre particolari specifiche richiedono ulteriori pacchetti di estensione; nel crearli si è già impostata la lingua inglese per il corpo del documento. Tutto ciò è automatico quando si specifichi alla classe l'opzione \chiave{tipotesi}{scudo}. +La Scuola di Dottorato (ScuDo) del Politecnico di Torino richiede un ulteriore imposta"zione, che riguarda specialmente il frontespizio e il retrofrontespizio. Tuttavia in questi paragrafi che riguardano le lingue si precisa subito che in quella Scuola la tesi deve essere composta in inglese e solo in inglese. Per la classe \TOPtesi non ci sono problemi nel comporre in inglese, ma le altre particolari specifiche richiedono ulteriori pacchetti di estensione; nel crearli si è già impostata la lingua inglese per il corpo del documento. Tutto ciò è automatico quando si specifichi alla classe l'opzione \chiave{tipotesi}{scudo}. Più avanti si daranno indicazioni sull'uso di questi ulteriori pacchetti e saranno scritte in inglese a beneficio anche dei numerosi dottorandi stranieri che frequentano quella Scuola. @@ -2718,25 +2738,26 @@ Il Politecnico di Torino, come anche molte università italiane e straniere, int Il problema dell'archiviazione elettronica è che il materiale archiviato deve essere reperibile, leggibile e stampabile per un tempo indefinito, anche secoli! Per questo è necessario che esso sia archiviato in un formato standard e che nel futuro continuino ad esistere i programmi per la visualizzazione e la stampa di questo formato, non necessariamente quelli che esistono oggi. -L'International Standards Organization (ISO) ha pubblicato nel 2005 uno standard per l'archiviazione dei file con la norma ISO 19005-1:2005 (nel 2011 e poi ancora nel 2012 sono stati approvati due aggiornamenti dello standard, ma per quello che interessa qui non è necessario vederne le modifiche in dettaglio). Secondo questa norma i file archiviabili devono avere il formato PDF, con il linguaggio PDF di livello 1.4, e devono soddisfare ad altri requisiti, oltre a contenere un certo numero di \emph{metadati} specificati dalla norma stessa. Negli aggiornamenti successivi il livello del linguaggio PDF è stato portato a 1.7, ma questo è un dettaglio relativamente poco importante: sono gli altri requisiti che rendono le norme aggiornate più o meno stringenti rispetto a quanto descrivo in questo paragrafo riferendomi alla prima stesura delle norme codificate con le sigle PDF/A-1a e PDF/A-1b. +L'International Standards Organization (ISO) ha pubblicato nel 2005 uno standard per l'archiviazione dei file con la norma ISO 19005-1:2005 (nel 2011 e poi ancora nel 2012 sono stati approvati due aggiornamenti"/estensioni dello standard, ma per quello che interessa qui non è necessario vederne le modifiche in dettaglio). Secondo questa norma i file archiviabili devono avere il formato PDF, con il linguaggio PDF di livello 1.4, e devono soddisfare ad altri requisiti, oltre a contenere un certo numero di \emph{metadati} specificati dalla norma stessa. Negli aggiornamenti successivi il livello del linguaggio PDF è stato portato a 1.7, ma questo è un dettaglio relativamente poco importante: sono gli altri requisiti che rendono le norme aggiornate più o meno stringenti rispetto a quanto si descrive in questo paragrafo con riferimento alle norme codificate con le sigle PDF/A-1a, PDF/A-1b, PDF/A-2a e PDF/A-2b. + +I formati~1a e~2a devono rispondere ai requisiti dei formati~1b e~2b, oltre ad altri requisiti specifici, in particolare che i font siano tutti inclusi nel file ed abbiano codifica UNICODE, che il file debba mantenere le informazioni relative alla sua struttura logica, e che queste possano essere esaminate con i motori di ricerca biblioteconomici. Viceversa il formati~1b e~2b, con meno pretese, richiedono che i font siano tutti inclusi nel file, anche se usano altre specifiche codifiche diverse da quella UNICODE, e che il file sia riproducibile a schermo e sia stampabile esattamente nello stesso modo di quando il file è stato archiviato. -Il formato PDF/A-1a deve rispondere ai requisiti del formato PDF/A-1b oltre ad altri requisiti specifici, in particolare che i font siano tutti inclusi nel file ed abbiano codifica UNICODE, che il file debba mantenere le informazioni relative alla sua struttura logica, e che queste possano essere esaminate con i motori di ricerca biblioteconomici. Viceversa il formato PDF/A-1b, con meno pretese, richiede che i font siano tutti inclusi nel file, anche se usano altre specifiche codifiche diverse da quella UNICODE, e che il file sia riproducibile a schermo e sia stampabile esattamente nello stesso modo di quando il file è stato archiviato. + Per il Politecnico sono accettabili i formati~1b e~2b, o superiori. Per ragioni di retrocompatibilità, nel seguito parlerò maggiormente della conformità PDF/A-1b; ma indicherò sempre nei listati dei codici anche la possibilità di specificare la conformità PDF/A-2b. Qual è la differenza? La norma di livello~2 sembra meno vincolata e più facile da rispettare rispetto alla norma di livello~1, ma anche lei ha le sue idiosincrasie. Complessivamente consiglierei di usare sempre la conformità con il livello~2. -Per il Politecnico, per ora, sarebbe sufficiente il sotto"formato PDF/A-1b. Come ho già detto, mi risulta che sia allo studio da parte del Politecnico la possibilità di richiedere il rispetto di una norma molto più restrittiva, che garantisca l'accessibilità e la fruibilità dei documenti archiviati anche a coloro che hanno alcune forme di disabilità; tuttavia a tutt'oggi (2018) l'ISO non ha ancora messo a punto tale norma, quindi l'apposita commissione del Politecnico sta giustamente precorrendo i tempi perché l'Ateneo sia pronto ad attuare la futura norma. Nel frattempo l'apposito gruppo di lavoro del TUG sta cercando di estendere i suoi pacchetti per l'archiviabilità anche per la norma PDF/A-1a, che richiede di disporre di file PDF classificati come \emph{tagged PDF}. +Come ho già detto, mi risulta che sia allo studio da parte del Politecnico la possibilità di richiedere il rispetto di una norma molto più restrittiva, che garantisca l'accessibilità e la fruibilità dei documenti archiviati anche a coloro che hanno alcune forme di disabilità; tuttavia a tutt'oggi (2020) l'ISO ha già messo a punto tale norma ma non ancora i criteri di verifica, quindi l'apposita commissione del Politecnico sta giustamente precorrendo i tempi perché l'Ateneo sia pronto ad attuare la futura norma. Nel frattempo l'apposito gruppo di lavoro del TUG sta cercando di estendere i suoi pacchetti per l'archiviabilità anche per i formati~1a e~2a, che richiedono di disporre di file PDF classificati come \emph{tagged PDF}. Le istruzioni che seguono per la produzione di un file conforme alla normativa PDF/A sono applicabili se si compone la tesi sia con il programma \prog{pdflatex}, sia con \prog{xelatex}, sia con \prog{lualatex}. In particolare, per sfruttare al meglio le possibilità offerte da \prog{xelatex} e \prog{lualatex} è necessario usare il pacchetto \pack{fontspec} che, senza ulteriori opzioni o specificazioni, usa di default i font Latin Modern nella versione OpenType; volendo si possono usare i comandi specifici disponibili con quel pacchetto per caricare font diversi. Notare che se si è predisposto il preambolo del file sorgente per la tesi in modo da poterlo compilare con \prog{pdflatex}, si può ugualmente compilare il documento anche con \prog{xelatex} o \prog{lualatex}, perché \TOPtesi è perfettamente conscio del motore di composizione che si sta usando e sa che il file sorgente parte dal presupposto che si volevano creare gli hyperlink. In altre parole, non c'è bisogno di modificare sostanzialmente il file sorgente per passare da \prog{pdflatex} a \prog{xelatex} o \prog{lualatex}, se non eventualmente usando solo il ramo \emph{vero} oppure \emph{falso} del test indicato qui sotto. Però il file prodotto con \prog{xelatex} necessita di ulteriore elaborazione (\emph{postprocessing}) per soddisfare le specifiche richieste dalla norma ISO relativa al formato archiviabile. Con \prog{pdflatex} e \prog{lualatex} non è necessaria nessuna operazione di post"processing; è per questo che qui si è aggiunto un test per evitare di caricare il pacchetto \pack{pdfx} quando si compila con \prog{xelatex}; ma si veda più avanti. Come esempio si può comunque fare riferimento alla parte iniziale del preambolo del file usato per comporre questo stesso manuale, che si riporta a partire dalla pagina~\pageref{pag:preambolo-pdfa}. -\label{pag:preambolo-pdfa} -\begin{Verbatim}[fontsize=\small,numbers=left,numbersep=3pt] +\begin{Verbatim}[reflabel=pag:preambolo-pdfa, fontsize=\setfontsize{10.125}, numbers=left,numbersep=3pt] % !TEX encoding = UTF-8 Unicode % !TEX TS-program = LuaLaTeX \documentclass[corpo=12pt,twoside,tipotesi=monografia]{toptesi} -\ProvidesFile{toptesi-it.tex}[2019-07-04 v.0.9.42] +\ProvidesFile{toptesi-it.tex}[2020-05-12 v.0.9.47 TOPtesi Italian Documentation] \usepackage{imakeidx}% da caricare prima di pdfx \indexsetup{headers={\indexname}{\indexname}} -\begin{filecontents*}{\jobname.xmpdata} +\begin{pdfxmetadata} \Title{La classe TOPtesi} \Author{Claudio Beccari} \Publisher{Claudio Beccari} @@ -2747,10 +2768,10 @@ classe TOPtesi\sep pdfLaTeX\sep XeLaTeX\sep LuaLaTeX} -\end{filecontents*} +\end{pdfxmetadata} \unless\ifXeTeX - \usepackage[a-1b]{pdfx} + \usepackage[a-1b]{pdfx}% oppure [a-2b] \fi % \ifPDFTeX @@ -2764,9 +2785,9 @@ LuaLaTeX} \else \usepackage{fontspec} \usepackage{xcolor} - \setmainfont[Ligatures=TeX]{TeX Gyre Termes} - \setsansfont[Ligatures=TeX, Scale=MatchLowercase]{TeX Gyre Heros} - \setmonofont{UM Typewriter} + \setsansfont[Ligatures=TeX]{Libertinus Sans} + \setmonofont{NewComputerModern Mono} +... \setmainlanguage[babelshorthands]{italian} \usepackage{amsmath} \usepackage{unicode-math} @@ -2775,7 +2796,8 @@ LuaLaTeX} \newfontfamily{\greekfont}{GFS Didot} \fi \usepackage{metalogo,longtable,booktabs,array,tabularx, -enumitem,ragged2e,siunitx,curve2e,microtype,wrapfig} + enumitem,ragged2e,siunitx,curve2e,microtype} +\usepackage{afterpage,wrapfig} % \unless\ifcsname ver@hyperref.sty\endcsname\usepackage{hyperref}\fi \hypersetup{% @@ -2794,38 +2816,37 @@ enumitem,ragged2e,siunitx,curve2e,microtype,wrapfig} \includegraphics[height=\dimexpr\ht0+\dp0]{GuITlogo}}}} \end{Verbatim} -Un commento va fatto subito: il lettore non si spaventi di una prima parte di preambolo così complessa, e non ha nessun bisogno di copiarla integralmente. Per questo documento ho predisposto un test per verificare con quale programma di composizione lo compilo e, come si vede, imposto i font e le lingue come specificato sopra, ma nel ramo \emph{falso} (cioè non si sta compilando con \prog{pdflatex} ma con \prog{lualatex} oppure \prog{xelatex}) ho inserito gli specifici comandi per gestire le lingue e per scegliere i font tenendo presente che \pack{polyglossia} e \pack{fontspec} sono già caricati dalla classe; tuttavia se il programma con cui si compila è \prog{xelatex}, si evita di caricare il pacchetto speciale \pack{pdfx}, necessario per produrre file PDF/A compatibili. +Un commento va fatto subito: il lettore non si spaventi di una prima parte di preambolo così complessa, e non ha nessun bisogno di copiarla integralmente. Per questo documento si è predisposto un test per verificare con quale programma di composizione si esegue la compilazione e, come si vede, si impostano i font e le lingue come specificato sopra, ma nel ramo \emph{falso} (cioè non si sta compilando con \prog{pdflatex}, bensì con \prog{lualatex} oppure \prog{xelatex}), sono inseriti gli specifici comandi per gestire le lingue e per scegliere i font tenendo presente che \pack{polyglossia} e \pack{fontspec} sono già caricati dalla classe; tuttavia se il programma con cui si compila è \prog{xelatex}, si evita di caricare il pacchetto speciale \pack{pdfx}, necessario per produrre file PDF/A compatibili. Il lettore sa perfettamente con quale programma vuole compilare la sua tesi e può tranquillamente mettere nel suo preambolo solo il ramo \emph{vero} del test se compila con \prog{pdflatex} o solo il ramo \emph{falso} se compila con \prog{lualatex} o con \prog{xelatex}. Se vuol produrre un file PDF/A compatibile con \prog{xelatex} ha due vie: \begin{itemize}[noitemsep] \item o lascia perdere \prog{xelatex} e compila con \prog{lualatex}; il frutto della compilazione è persino migliore, visto che \prog{lualatex} usa le funzionalità del pacchetto \pack{microtype} in modo più avanzato rispetto a \prog{xelatex}; oppure % -\item se proprio non può fare a meno di usare \prog{xelatex}, toglie il test \cs{ifXeTeX}, conservando solo \cs{usepackage}\Marg{pdfx}, e usa solo il ramo \emph{falso} del test \verb|\ifPDFTeX|; tuttavia ciò non sufficiente perché deve poi procedere ad una certa dose di postprocessing come specificato nel paragrafo~\ref{sec:XePDFA}. +\item se proprio non può fare a meno di usare \prog{xelatex}, toglie il test \cs{ifXeTeX}, conservando solo \cs{usepackage}\Marg{pdfx}, e usa solo il ramo \emph{falso} del test \verb|\ifPDFTeX|; tuttavia ciò non è sufficiente perché deve poi procedere ad una certa dose di postprocessing come specificato nel paragrafo~\ref{sec:XePDFA}. \end{itemize} Nel codice precedente le prime due righe sono solo dei commenti per il programma di compilazione, ma per il programma di editing sono comandi di autoconfigurazione; essi dicono al programma di editing di salvare il documento dopo la prima creazione e dopo ogni modifica con la codifica \opz{utf8}; la seconda riga dice che quando si clicca il bottone per la compilazione l'editor deve inviare al sistema operativo il comando di lanciare il programma \prog{lualatex}. Ricordo che questo tipo di commenti di autoconfigurazione sono interpretati correttamente dagli editor \TeXShop, \TeXworks e TeXstudio (forse anche da altri editor, ma questi tre sono quelli che io consiglieri per ogni utente). -Le righe dalla 8 alla 19 contengono l'ambiente \amb{filecontents*} che provvede a generare la lista dei metadati che ho usato per questo documento\footnote{\label{nota:colorprofileerror}In realtà, almeno fino alla fine di ottobre 2018 c'era un problema facilmente risolvibile. Il profilo di colore precedentemente usato per descrivere i colori RGB era protetto da una clausola che ne impediva la distribuzione; evidentemente qualcuno si è fatto vivo per segnalare questa violazione. Verso la fine di dicembre 2018 è stata resa disponibile la versione 1.6.1 di \pack{pdfx} che non soffre più di questo problema. Si consiglia quindi di aggiornare la propria installazione o, almeno, di aggiornare il pacchetto \pack{pdfx} e il problema sparisce.}. +Le righe dalla 8 alla 19 contengono l'ambiente \amb{pdfxmetadata}; esso provvede a generare il file che contiene la lista dei metadati che si sono usati per questo documento. Si ricorda solo che l'ambiente \amb{pdfxmetadata} va inserito dopo la riga che contiene \cs{documentclass} e prima della riga che contiene \cs{usepackage}\Oarg{a-1b}\Marg{pdfx}. -Si noti che in contrasto con le versioni precedenti di \TOPtesi, è meglio che questo ambiente si trovi dopo e non prima di \cs{documentclass}; questa lieve modifica (retrocompatibile) è stata introdotta per ovviare ad un inconveniente piccolo, ma che lascia interdetti gli utenti alle prime armi: l'ambiente originale non sovrascrive i file se già esistono. Questo implica che qualunque modifica si esegua fra i dati contenuti in questo ambiente non viene di fatto memorizzata nel file \verb|\jobname.xmpdata| se non dopo averne cancellato una eventuale versione precedente. Con la presente versione di \TOPtesi viene caricato direttamente dalla classe il pacchetto \pack{filecontents} che ridefinisce gli ambienti \amb{filecontents} e \amb{filecontents*} in modo da eliminare questa loro limitazione; questa funzionalità è operativa se si sposta il codice di questo ambiente ad un punto che preceda il caricamento di \pack{pdfx}, ma dopo aver caricato \pack{filecontents}, che, essendo a sua volta già caricato dalla classe, equivale a dire \emph{dopo} la dichiarazione della classe. Quindi l'utente può mettere l'ambiente prima della dichiarazione di classe, come in passato ma rinuncia alla nuova funzionalità, che invece è disponibile solo se l'ambiente si trova, come indicato, dopo la dichiarazione di classe ma prima di invocare il pacchetto \pack{pdfx}. -La riga 3 contiene la dichiarazione della classe; come si vede, specifico solo il corpo normale dei font al valore di 12\,pt, e seleziono la composizione in bianca e volta, successivamente non specifico nessuna correzione per la cucitura delle segnature; specifico solo che il tipo di documento è quello che corrisponde alla opzione \chiave{tipotesi}{monografia}, dove ho preferito usare il nome \texttt{monografia} piuttosto che l'equivalente nome \texttt{triennale}, visto che questo documento non è una tesi. +La riga 3 contiene la dichiarazione della classe; come si vede, si specifica solo il corpo normale dei font al valore di 12\,pt, e si seleziona la composizione in bianca e volta, successivamente non si specifica nessuna correzione per la cucitura delle segnature; si specifica solo che il tipo di documento è quello che corrisponde a \chiave{tipotesi}{monografia}, dove si è preferito usare il nome \texttt{monografia} piuttosto che l'equivalente nome \texttt{triennale}, visto che questo documento non è una tesi. -Importante per questo documento è la riga 4, dove specifico il nome del file, ma ne specifico anche la data e la versione; così sono sempre sicuro di sapere quale versione sto componendo e i lettori, che trovano questo file fra la documentazione di \class{toptesi}, sanno subito se si tratta di documentazione aggiornata o se non sia il caso di aggiornare la propria installazione. +Importante per questo documento è la riga 4, dove si specifica non solo il nome del file, ma anche la data e la versione; così chi lavora sul file sorgente e chi legge il documento finale è sempre sicuro di sapere quale versione si sta componendo e i lettori, che trovano questo file fra la documentazione di \class{toptesi}, sanno subito se si tratta di documentazione aggiornata o se non sia il caso di aggiornare la propria installazione. -Con le righe 5 e 6 carico il pacchetto \pack{imakeidx} e lo configuro. Questo pacchetto va caricato prima di \pack{pdfx}, perché questo ridefinisce alcuni comandi sui quali \pack{imakeidx} non può più intervenire. +Con le righe 5 e 6 si carica il pacchetto \pack{imakeidx} e lo si configura. Questo pacchetto va caricato prima di \pack{pdfx}, perché questo ridefinisce alcuni comandi sui quali \pack{imakeidx} non può più intervenire. -Con le righe 21--23 eseguo il test per sapere se sto componendo con \prog{xelatex} (il cui interprete si chiama \prog{xetex}) così da \emph{non} caricare il pacchetto \pack{pdfx}. +Con le righe 21--23 si esegue il test per sapere se si sta componendo con \prog{xelatex} (il cui interprete si chiama \prog{xetex}) così da \emph{non} caricare il pacchetto \pack{pdfx}. Poi dalla riga 25 comincia il test importante per configurare il preambolo correttamente secondo le necessità di compilazione; dalla riga 26 alla riga 32 si ha il ramo \emph{vero} da usarsi quando si compila con \prog{pdflatex}; invece dalla riga 34 alla riga 44 si ha il ramo \emph{falso} da usarsi quando si compila con \prog{lualatex}; per compilare con \prog{xelatex}, ho già detto che oltre a togliere le righe 21 e 23 (ma non la riga 22) bisogna poi procedere come specificato nel paragrafo~\ref{sec:XePDFA}. -Le righe successive dalla 46 alla 63 servono per mostrare non solo i pacchetti che ho caricato, ma anche come ho configurato le opzioni per \pack{hyperref}: un test serve per verificare (tramite l'esistenza della macro il cui nome contiene una stringa col nome completo del pacchetto adeguatamente prefissato con \texttt{ver@}) se \pack{hyperref} è già stato caricato; se non lo è, lo si carica e poi si impostano le opzioni. Infine si impostano i comandi \cs{MP} e \cs{GuIT} per importare due piccoli file che contengono il logo di \MP\ e quello del \GuIT. Questo artificio è stato usato per evitare di usare certi font che potrebbero dare luogo a problemi per l'archiviabilità +Le righe successive dalla 46 alla 64 servono per mostrare non solo i pacchetti che si sono caricati, ma anche come si sono configurate le opzioni per \pack{hyperref}: un test serve per verificare (tramite l'esistenza della macro il cui nome contiene una stringa col nome completo del pacchetto adeguatamente prefissato con \texttt{ver@}) se \pack{hyperref} è già stato caricato; se non lo è, lo si carica e poi si impostano le opzioni. Infine si impostano i comandi \cs{MP} e \cs{GuIT} per importare due piccoli file che contengono il logo di \MP\ e quello del \GuIT. Questo artificio è stato usato per evitare di usare certi font che potrebbero dare luogo a problemi per l'archiviabilità -Per la compilazione del documento in modo che sia conforme con lo standard PDF/A vorrei sottolineare l'opportunità di specificare i metadati richiesti come indicato nel codice precedente. Non è obbligatorio, ma in questo modo si è sicuri che il file dei metadati abbia l'estensione giusta e il nome assolutamente coincidente con il nome del main file del documento, cioè della tesi. +Per la compilazione del documento in modo che sia conforme con lo standard PDF/A si sottolinea l'opportunità di specificare i metadati richiesti come indicato nel codice precedente. Non è obbligatorio, ma in questo modo si è sicuri che il file dei metadati abbia l'estensione giusta e il nome assolutamente coincidente con il nome del main file del documento, cioè della tesi. Non è obbligatorio farlo in questo modo, ma i metadati in un modo o nell'altro devono essere disponibili perché il pacchetto \pack{pdfx} li possa usare. Facendolo in questo modo si è sicuri che \pack{pdfx} li trova nel file giusto e nella cartella giusta. L'utente in ogni caso è tenuto ad usare le chiavi corrette e la sintassi corretta. -L'altro punto importante è non solo caricare il pacchetto \pack{pdfx}, ma è necessario caricarlo nell'ordine indicato, cioè, se lo si usa, subito dopo il pacchetto \pack{imakeidx} e l'ambiente che contiene i metadati. +L'altro punto importante è non solo caricare il pacchetto \pack{pdfx}, ma è necessario caricarlo nell'ordine indicato, cioè, se lo si usa, subito dopo il pacchetto \pack{imakeidx} e l'ambiente che contiene i metadati.\enlargethispage*{2\baselineskip} -Ho collaudato questo preambolo compilando sia con \prog{pdflatex} sia con \prog{lualatex}. Volendo, avrei potuto seguire le raccomandazioni che scrivo nel paragrafo~\ref{sec:XePDFA} ma non l'ho fatto e, visto che ottengo lo stesso risultato, anzi un risultato migliore, con \prog{lualatex}, mi è parso un collaudo superfluo. Con questo non voglio dire che \prog{xelatex} sia diventato inutile; esso, come \prog{pdflatex}, ha un file di formato che contiene tutte le impostazioni per tutte le lingue che il sistema \TeX può gestire, mentre \prog{lualatex} in questo momento (2018) di ogni lingua può gestire una sola impostazione; per esempio, il greco ha tre varianti e il file di formato di \prog{xelatex} le potrebbe gestire tutte e tre come ci riesce \prog{pdflatex}; lo stesso vale per il latino e per diverse altre lingue; \prog{lualatex} al momento può gestire una sola variante di ciascuna lingua. Perciò in questo momento\footnote{Sono al corrente che per il greco il gruppo di lavoro sta lavorando per superare questo piccolo scoglio; è possibile che quando si legge questa documentazione lo scoglio sia superato e il file \file{gloss-greek.ldf} sia già in grado di gestire le tre varianti del greco come gli altri due programmi.} \prog{xelatex} potrebbe essere preferibile a \prog{lualatex} per le tesi di carattere linguistico, filologico, o umanistico in generale\footnote{Recentemente è apparso il nuovo pacchetto \pack{luahyphenrules} che dovrebbe permettere di accettare le varianti anche compilando con \LuaLaTeX, ma come ho specificato, al momento di scrivere questa documentazione questa funzionalità non è ancora completamente operativa e non è disponibile per la generalità degli utenti.}. +Questo preambolo è stato collaudato compilando sia con \prog{pdflatex} sia con \prog{lualatex}. Volendo, si sarebbero potute seguire le raccomandazioni scritte nel paragrafo~\ref{sec:XePDFA} ma non non è stato fatto e, visto che si ottiene lo stesso risultato, anzi un risultato migliore, con \prog{lualatex}, è parso un collaudo superfluo. Con questo non si vuol dire che \prog{xelatex} sia diventato inutile; esso, come \prog{pdflatex}, ha un file di formato che contiene tutte le impostazioni per tutte le lingue che il sistema \TeX può gestire, mentre \prog{lualatex} (almeno fino al 2018) di ogni lingua può gestire una sola impostazione; per esempio, il greco ha tre varianti e il file di formato di \prog{xelatex} le potrebbe gestire tutte e tre come ci riesce \prog{pdflatex}; lo stesso vale per il latino e per diverse altre lingue; \prog{lualatex} poteva gestire una sola variante di ciascuna lingua. Perciò \prog{xelatex} potrebbe essere preferibile a \prog{lualatex} per le tesi di carattere linguistico, filologico, o umanistico in generale. %\goodpagebreak @@ -2833,27 +2854,27 @@ Ho collaudato questo preambolo compilando sia con \prog{pdflatex} sia con \prog Usando \prog{pdflatex} è necessario usare il pacchetto specifico \pack{pdfx} richiamandolo con l'opzione giusta; precisamente il preambolo deve contenere la richiesta: \begin{verbatim} -\usepackage[a-1b]{pdfx} +\usepackage[a-1b]{pdfx}% oppure [a-2b] \end{verbatim} come è stato mostrato precedentemente nelle pagine~\pageref{pag:preambolo-pdfa} e seguenti; quando si usa \prog{pdflatex} non è molto importante l'ordine con cui si caricano i vari pacchetti, ma la documentazione di \pack{pdfx} raccomanda di caricarlo il più presto possibile; tuttavia, poiché sarebbe meglio caricarlo dopo aver specificato tutti i pacchetti aggiuntivi che potrebbero influire sui collegamenti ipertestuali, cioè i pacchetti che modificano i comandi di sezionamento, la composizione delle didascalie e simili, \pack{pdfx} carica già \pack{hyperref} per configurarne i collegamenti ipertestuali in modo conforme alle specifiche della norma PDF/A. Questo implica, però, che il pacchetto \pack{pdfx} venga caricato prima che nel preambolo venga caricato \pack{hyperref}; anzi, avendo caricato \pack{pdfx} non è necessario caricare \pack{hyperref}, ma basta configurarlo con \cs{hypersetup} per le esigenze specifiche del documento. Non è vietato caricarlo di nuovo, purché nel preambolo, dopo aver caricato \pack{pdfx}, \pack{hyperref} sia caricato senza opzioni proprio per evitare l'errore “option clash”. Questa possibilità di tenere separato il caricamento di \pack{hyperref} dalla sua configurazione mediante \cs{hypersetup}, è comoda perché consente di aggiungere la chiamata di \pack{pdfx} in un secondo tempo, quando si vuole aggiungere la compatibilità con le norme PDF/A. Ma in questo documento si è preferito eseguire direttamente il test per sapere se il pacchetto sia o non sia stato precedentemente caricato, così da non correre nessun rischio di “option clash”. -Il pacchetto \pack{pdfx} è già presente con ogni installazione completa e aggiornata del sistema \TeX; se si disponesse di una installazione di base o, comunque, parziale e il pacchetto non fosse già installato, bisogna provvedere con i metodi specifici di ciascuna installazione. Si consiglia la lettura della documentazione di \pack{pdfx}, perché consente una certa dose di personalizzazione. +Il pacchetto \pack{pdfx} è già presente in ogni installazione completa e aggiornata del sistema \TeX; se si disponesse di una installazione di base o, comunque, parziale e il pacchetto non fosse già installato, bisogna provvedere con i metodi specifici di ciascuna installazione. Si consiglia la lettura della documentazione di \pack{pdfx}, perché consente una certa dose di personalizzazione. Il pacchetto \pack{pdfx} con l'opzione \opz{a-1b} provvede a quasi tutto il necessario, per esempio, a definire un profilo di colore, ma non provvede ai metadati specifici di ogni particolare documento, che invece descrivo qui di seguito. -I {metadati} di carattere generale sono inseriti nel file di uscita dall'azione diretta del file \file{pdfx.sty}; ma per i {metadati} specifici del documento che si sta componendo è necessario predisporre nella cartella dove risiede il file principale della tesi (quello sul quale opera il programma di composizione) un file contenente questi {metadati}. Il metodo migliore per farlo è mostrato nel codice della pagina~\pageref{pag:preambolo-pdfa}: si tratta di inserire i metadati all'interno dell'ambiente \amb{filecontents*} subito dopo la dichiarazione della classe. +I {metadati} di carattere generale sono inseriti nel file di uscita dall'azione diretta del file \file{pdfx.sty}; ma per i {metadati} specifici del documento che si sta componendo è necessario predisporre nella cartella dove risiede il file principale della tesi (quello sul quale opera il programma di composizione) un file contenente questi {metadati}. Il metodo migliore per farlo è mostrato nel codice della pagina~\pageref{pag:preambolo-pdfa}: si tratta di inserire i metadati all'interno dell'ambiente \amb{pdfxmetadata} subito dopo la dichiarazione della classe. -Ci si ricordi che il pacchetto \pack{toptesi} controlla solo se si sta usando \prog{pdflatex} e assume che, se non si sta componendo con \prog{pdflatex}, allora si sta usando \prog{xelatex} oppure \prog{lualatex}. In particolare si ottiene un errore se si compila con \prog{latex} (il programma è ancora esistente ma io lo considero obsoleto) con il quale si produce un file di uscita in formato DVI, ormai quasi estinto. Si noti che, in effetti, sebbene il programma \prog{latex} esista ancora, il motore di composizione di \prog{latex} e di \prog{pdflatex} è lo stesso, ma ne differiscono le impostazioni; il test \cs{ifPDFTeX} che usa \TOPtesi per conoscere se si sta usando \prog{pdftex} per produrre un file in formato PDF piuttosto che in formato DVI, non è detto che riesca a distinguere questi due casi. Non ho mai verificato, perché usando un Mac, il mio formato di default è sempre PDF; per ottenere il formato DVI devo dare comandi specifici mediante il terminale, cosa che evidentemente non faccio mai perché, oltretutto, non dispongo di un visualizzatore per il formato DVI (sono capace di aggirare questi ostacoli grazie al Mac stesso, ma non lo faccio mai, perché il formato DVI non è adatto a quanto solitamente scrivo). +Ci si ricordi che il pacchetto \pack{toptesi} controlla solo se si sta usando \prog{pdflatex} e assume che, se non si sta componendo con \prog{pdflatex}, allora si sta usando \prog{xelatex} oppure \prog{lualatex}. In particolare si ottiene un errore se si compila con \prog{latex} (il programma è ancora esistente ma io lo considero obsoleto) con il quale si produce un file di uscita in formato DVI, ormai quasi estinto. Si noti che, in effetti, sebbene il programma \prog{latex} esista ancora, il motore di composizione di \prog{latex} e di \prog{pdflatex} è lo stesso, ma ne differiscono le impostazioni; il test \cs{ifPDFTeX} che usa \TOPtesi per conoscere se si sta usando \prog{pdftex} per produrre un file in formato PDF piuttosto che in formato DVI, non è detto che riesca a distinguere questi due casi. Non ho mai verificato, perché usando un Mac, il mio formato di default è sempre PDF; per ottenere il formato DVI devo operare a mano con comandi specifici mediante il terminale, cosa che evidentemente non faccio mai perché, oltretutto, non dispongo di un visualizzatore per il formato DVI (sono capace di aggirare questi ostacoli grazie al Mac stesso, ma non lo faccio mai, perché il formato DVI non è adatto a quanto solitamente scrivo). Nei rarissimi casi in cui esistono validi motivi per non usare \prog{pdflatex}, allora bisogna usare il semplice \prog{latex}, e poi convertire il file DVI ottenuto in un file PDF; per la conversione in file PDF/A, bisogna poi procedere come indicato sotto nel paragrafo~\ref{sec:XePDFA}. È meglio evitare di usare quei pacchetti che richiedono comandi PostScript, come per esempio \pack{PSTricks} o \pack{XYpic}, ma è preferibile usare i pacchetti di grafica, come \pack{pgf} con il suo modulo \pack{tikz}, che consentono di fare quasi tutto quello che si può fare con gli altri pacchetti che richiedono il linguaggio PostScript. -All'occorrenza, però, esistono pacchetti da usare con \prog{pdflatex} che permettono (almeno) di usare il potentissimo PSTricks anche con \prog{pdflatex}; questi pacchetti, lavorando in background senza che l'utente debba metterci mano, estraggono il codice di PSTricks dal file sorgente, lo salvano in un nuovo file \file{.tex} di servizio che compilano con \prog{latex} e ne trasformano il file di uscita in formato PDF per poi importarlo già scontornato nel file che interessa all'utente. Se fra una compilazione e l'altra non sono state eseguite modifiche al codice PSTricks, questa operazione in background viene tranquillamente saltata, quindi non si nota nemmeno nessun rallentamento nell'elaborazione del documento. Vale comunque il consiglio di non usare questi moduli che richiedono l'uso del linguaggio PostScript, perché i moduli che lavorano direttamente con il linguaggio PDF lavorano altrettanto bene nella stragrande maggioranza dei casi. +All'occorrenza, però, esistono pacchetti da usare con \prog{pdflatex} che permettono (almeno) di usare il potentissimo PSTricks anche con \prog{pdflatex}; questi pacchetti, lavoran"do in background senza che l'utente debba metterci mano, estraggono il codice di PSTricks dal file sorgente, lo salvano in un nuovo file \file{.tex} di servizio che compilano con \prog{latex} e ne trasformano il file di uscita in formato PDF per poi importarlo già scontornato nel file che interessa all'utente. Se fra una compilazione e l'altra non sono state eseguite modifiche al codice PSTricks, questa operazione in background viene tranquillamente saltata, quindi non si nota nemmeno nessun rallentamento nell'elaborazione del docu"mento. Vale comunque il consiglio di non usare questi moduli che richiedono l'uso del linguaggio PostScript, perché i moduli che lavorano direttamente con il linguaggio PDF lavorano altrettanto bene nella stragrande maggioranza dei casi. -Bisogna ricordare che produrre un file PDF/A non è semplice, ma se si usa \prog{pdflatex} con i font di default con codifica \opz{T1} (se si usa \prog{lualatex} con i font OpenType si veda sotto), se si incorporano solo figure PNG (senza trasparenze) e JPEG con profilo di colore RGB (red, green, blue), se ogni file PDF da incorporare contiene al suo interno anche i font che eventualmente sono necessari per comporre il suo testo, se sono presenti tutti i metadati necessari, non si dovrebbero incontrare problemi di certificazione della conformità PDF/A del file della tesi. +Bisogna ricordare che produrre un file PDF/A non è semplice, ma se si usa \prog{pdflatex} con i font di default con codifica \opz{T1} (se si usa \prog{lualatex} con i font OpenType si veda sotto), se si incorporano solo figure PNG (senza trasparenze) e JPG con profilo di colore RGB (red, green, blue), se ogni file PDF da incorporare contiene al suo interno anche i font che eventualmente sono necessari per comporre il suo testo, se sono presenti tutti i metadati necessari, non si dovrebbero incontrare problemi di certificazione della conformità PDF/A del file della tesi. Più avanti c'è un paragrafo dedicato al caso che un file così prodotto non risulti conforme alla norma PDF/A. @@ -2868,13 +2889,13 @@ Per il resto valgono le stesse indicazioni scritte per l'uso del programma \prog Se i metadati devono essere usati da programmi di biblioteconomia per la ricerca dei contenuti, delle parole chiave, e simili, suggerirei di scrivere i metadati in inglese sia perché probabilmente la ricerca delle informazioni biblioteconomiche risulta facilitata anche all'estero, in quanto si evitano i caratteri accentati; consiglio l'inglese almeno in tutti i campi in cui l'italiano non è essenziale, come lo è invece nel titolo (se è in italiano) e nei nomi propri italiani. -Come si legge nella parte di preambolo che appare nella pagina~\pageref{pag:preambolo-pdfa}, questo stesso file è stato composto con \prog{lualatex} e la verifica della conformità ha dato esito positivo. +Come si legge nella parte di preambolo che appare nella pagina~\pageref{pag:preambolo-pdfa}, questo stesso file è stato composto con \prog{lualatex}; poi la verifica della conformità ha dato esito positivo. \subsection{\texorpdfstring{\prog*}{}{xelatex} e il formato PDF/A}\label{sec:XePDFA} Con \prog{xelatex} le cose sono un po' più complesse che con \prog{lualatex}, ed è per questo motivo che consiglio di usare direttamente \prog{lualatex}. -Il motivo è dovuto al fatto che \prog{xelatex} non produce direttamente la sua uscita nel formato PDF, ma in un formato DVI esteso che viene trasformato in PDF dal programma \prog{xdvipdfmx} che, di per sé, non sa nulla in merito al fatto che il file da trasformare contenga o non contenga dei metadati. +Il motivo è dovuto al fatto che \prog{xelatex} non produce direttamente la sua uscita nel formato PDF, ma in una variante del formato DVI esteso che viene trasformato in PDF dal programma \prog{xdvipdfmx} che, di per sé, non sa nulla in merito al fatto che il file da trasformare contenga o non contenga dei metadati. Per questo motivo si deve compilare “a mano”, dando il comando di compilazione dal terminale nel modo seguente: \begin{flushleft}\ttfamily @@ -2882,15 +2903,15 @@ xelatex -shell-escape -output-driver="xdvipdfmx -z 0" \meta{filename} \end{flushleft} Come si vede \prog{xelatex} deve lavorare con l'opzione \opz{-shell-escape} che consente di lanciare un programma esterno; in questo caso l'uscita di \prog{xelatex} viene inviata al driver di uscita \prog{xdvipdfmx} (e fin qui non ci sono sorprese rispetto a quello che \prog{xelatex} fa di solito), ma la differenza consiste nell'opzione passata a \prog{xdvipdfmx}: \opz{-z 0}. Questa opzione dice al programma di non comprimere il suo file di uscita; questo fatto produce due effetti: quello “buono” è che non comprime i metadati; quello “cattivo” è che il file di uscita è enormemente più grande, fino a circa 10 volte più grande di quanto sarebbe se fosse compresso. -Per il resto, avendo predisposto il main file della tesi come se si dovesse lavorare con \prog{lualatex} e avendo osservato le stesse cautele per i font, i colori, eccetera, il file ottenuto, nonostante le sue dimensioni, può venire sottoposto a verifica attraverso il modulo Preflight di Adobe Acrobat Pro, come bisogna fare anche quando il file PDF fosse ottenuto con \prog{pdflatex} o \prog{lualatex}; ma il buono, questa volta, è che, se il file ottenuto passa la verifica di conformità, Adobe Acrobat è anche in grado di comprimere il file, lasciando inalterati (non compressi) i metadati. +Per il resto, avendo predisposto il main file della tesi come se si dovesse lavorare con \prog{lualatex} e avendo osservato le stesse cautele per i font, i colori, eccetera, il file ottenuto, nonostante le sue dimensioni, può venire sottoposto a verifica attraverso il modulo Preflight di Adobe Acrobat Pro, come bisogna fare anche quando il file PDF fosse ottenuto con \prog{pdflatex} o \prog{lualatex}; ma il buono, questa volta, è che, se il file ottenuto passa la verifica di conformità, Adobe Acrobat Pro è anche in grado di comprimere il file, lasciando inalterati (non compressi) i metadati. -Vista questa trafila di post"processing, si capisce anche perché sconsiglio di comporre la tesi con \prog{xelatex} ma consiglio di usare direttamente \prog{lualatex}. +Vista questa trafila di post"processing, si capisce anche perché si sconsiglia di comporre la tesi con \prog{xelatex} ma consiglio di usare direttamente \prog{lualatex}. \subsection[Uso di pdfpages o ghostscript]{Uso di \texorpdfstring{\pack*}{}{pdfpages} o di \texorpdfstring{\prog*}{}{ghostscript}} Esistono altri metodi per ottenere la produzione di file conformi alla norma PDF/A. Uno è quello che consiste nel produrre un secondo file importando le pagine del primo mediante il pacchetto \pack{pdfpages}; un altro è quello di ottenere la trasformazione mediante il programma \prog{ghostscript}. Nel seguito si illustrerà il primo metodo; anche se nel seguito continuerò ad esemplificare parlando della tesi, ritengo che questi due metodi siano più utili per i lettori proprio allo scopo di controllare singoli file esterni da importare nella tesi. -Infatti è meglio creare un piccolo file presumibilmente PDF/A compatibile e verificarne la compatibilità: se è compatibile, non ci sono problemi ad importarlo nella tesi; se è incompatibile prima si esaminano le cause dell'incompatibilità, poi lo si può correggere per renderlo compatibile, oppure si possono prendere decisioni su cosa farne per importarlo validamente nella tesi. +Infatti è meglio creare un piccolo file presumibilmente PDF/A compatibile e verificarne la compatibilità: se è compatibile, non ci sono problemi ad importarlo nella tesi; se è incompatibile, prima si esaminano le cause dell'incompatibilità, poi lo si può correggere per renderlo compatibile, oppure si possono prendere decisioni su cosa farne per impor"tar"lo validamente nella tesi. Dopo aver ottenuto un file PDF della tesi, se ci si ritrova con un file che non è ancora conforme allo standard PDF/A, si può provvedere con altri programmi. Qui indicherò un metodo che può avere vantaggi o svantaggi; nessuno è perfetto, ma funziona. Accennerò appena ad un altro metodo solo per segnalare che il primo non è l'unico; tuttavia ho usato questo secondo metodo per anni prima di “scoprire” come fare con il primo (l'uovo di Colombo), ma siccome il secondo è decisamente più complesso, ritengo che il primo sia da preferire. @@ -2899,50 +2920,45 @@ Dopo aver ottenuto un file PDF della tesi, se ci si ritrova con un file che non \addcontentsline{toc}{subsection}{\numberline{\relax}Conformità con \TOPtesi} I file di esempio che fan parte del bundle di \TOPtesi sono tutti conformi allo standard ISO per l'archiviabilità, qualunque sia il programma con cui sono stati composti. -Come è stato già osservato, anche con \XeLaTeX sarebbe possibile ottenere file archiviabili, ma la laboriosità e delicatezza del postprocessing, incluso il fatto che è necessario disporre del programma commerciale Adobe Acrobat Pro~XI, o successivo, rende sconsigliabile l'uso di \XeLaTeX\ per comporre qualunque tesi da archiviare. +Come è stato già osservato, anche con \XeLaTeX sarebbe possibile ottenere file archivia"bili, ma la laboriosità e delicatezza del postprocessing, incluso il fatto che è necessario disporre del programma commerciale Adobe Acrobat Pro~XI, o successivo, rende sconsi"glia"bile l'uso di \XeLaTeX\ per comporre qualunque tesi da archiviare. \subsubsection{Conformity when using \TOPtesi with option \texorpdfstring{\chiave{tipotesi}}{}{scudo}} \addcontentsline{toc}{subsection}{\numberline{\relax}Conformity when using \TOPtesi for ScuDo doctoral theses} -The example file \file{toptesi-scudo-example.tex} included in this \TOPtesi bundle shows exactly how to produce an ISO PDF/A-1b conforming output PDF file. - -Of course the procedure is correct, but the difficulty to produce a PDF/A conforming output depends on correct metadata, on the correct color profile, on the used fonts, on the quality and contents of the imported figures. The rules to follow are described both in the previous sections in Italian, and in the English documentation of the the \TOPtesi bundle: \file{toptesi.pdf}. - -\textcolor{red}{Please, if you get an error implying \texttt{sRGB} color profile, check the following. This error is temporary and does not depend on \TOPtesi. By the end of 2018 version 1.6.1 of \pack{pdfx} has been released and the error flag is not raised anymore, unless you have a \TeXLive installation that is not up to date. You have two different solutions to this problem; either you update \TeXLive, or you load and install at least the new version of \pack{pdfx}; such new version can take care also of the glitch that was present in the previous version and provides directly the workarounds that are necessary to load a valid color profile.} - +The example file \file{toptesi-scudo-example.tex} included in this \TOPtesi bundle shows exactly how to produce an ISO PDF/A-1b or PDF/A-2b conforming output PDF~file. +Of course the procedure is correct, but the difficulty to produce a PDF/A conforming output depends on correct metadata, on the color profile, on the used fonts, on the quality and contents of the imported figures. The rules to follow are described both in the previous sections in Italian, and in the English documentation of the the \TOPtesi bundle: \file{toptesi.pdf}. \subsubsection{Uso di \texorpdfstring{\pack*}{}{pdfpages}} -Il metodo, con il quale ho avuto risultati positivi, ricorre al pacchetto \pack{pdfpages}, ma ha il difetto di perdere gli eventuali collegamenti ipertestuali interni. Considero questo un male minore e un piccolo prezzo da pagare per disporre di un metodo che riesce quasi sempre a produrre un file PDF/A compatibile, quando si parte da un file PDF ottenuto com mezzi diversi dall'uso del sistema \TeX e che non risulta compatibile. +Il metodo, con il quale si sono avuti risultati positivi, ricorre al pacchetto \pack{pdfpages}, ma ha il difetto di perdere gli eventuali collegamenti ipertestuali interni. Questo è un male minore e un piccolo prezzo da pagare per disporre di un metodo che riesce quasi sempre a produrre un file PDF/A compatibile, quando si parte da un file PDF ottenuto com mezzi diversi dall'uso del sistema \TeX e che non risulta compatibile. -Supponiamo quindi di disporre di un file PDF composto secondo le raccomandazioni indicate nei paragrafi precedenti. Tanto per mettere i puntini sulle ‘i’, il lettore attento ha notato che per i loghi \GuIT\ e \MP\ ho creato le definizioni per produrre questi loghi importando e scalando due file PDF opportunamente scontornati e appositamente predisposti (con \prog{pdflatex}), conformi alla norma PDF/A. Li ho creati con i loghi molto grandi, ma pur sempre vettoriali, in modo che possano venire ingranditi o rimpiccioliti a piacere. Le due macro \cs{GuIT} e \cs{MP}, infatti, scalano quelle due immagini PDF in modo che siano grandi come il testo circostante e abbiano la linea di base esattamente allineata con quella del testo. In quanto file PDF/A, essi contengono tutte le informazioni che devono contenere, metadati e font esattamente come la norma richiede; presi a sé, essi passano le verifiche eseguite con Adobe Acrobat Pro~XI\footnote{Avevo seguito questa procedura nella versione precedente di \TOPtesi. Ora, avendo aggiornato tutta l'installazione alla versione di \TeXLive 2019, ho rifatto tutto con il software aggiornato e non è stato più necessario ricorrere a quegli espedienti.}. +Supponiamo quindi di disporre di un file PDF composto secondo le raccomandazioni indicate nei paragrafi precedenti. Tanto per mettere i puntini sulle ‘i’, il lettore attento ha notato che per i loghi \GuIT\ e \MP\ si sono create le definizioni per produrre questi loghi importando e scalando due file PDF opportunamente scontornati e appositamente predisposti (con \prog{pdflatex}), conformi alla norma PDF/A. Sono stati creati con i loghi molto grandi e vettoriali, in modo che possano venire ingranditi o rimpiccioliti a piacere. Le due macro \cs{GuIT} e \cs{MP}, infatti, scalano quelle due immagini PDF in modo che siano grandi come il testo circostante e abbiano la linea di base esattamente allineata con quella del testo. In quanto file PDF/A, essi contengono tutte le informazioni che devono contenere, metadati e font esattamente come la norma richiede; presi a sé, essi passano le verifiche eseguite con Adobe Acrobat Pro~XI\footnote{Si era seguita questa procedura nella versione precedente di \TOPtesi. Ora, avendo aggiornato tutta l'installazione alla versione di \TeXLive 2019, si è rifatto tutto con il software aggiornato e non è stato più necessario ricorrere a quegli espedienti.}. -{\tolerance=3000 Si supponga di disporre di questo stesso documento composto ricorrendo a \prog{latex} e di averlo trasformato mediante \prog{dvips} e \prog{pstopdf}, oppure mediante \prog{dvipdfm}, nel file \file{toptesi-it.pdf}. -Si prepara ora un altro semplicissimo file che viene chiamato, per esempio, \file{toptesi-it\discretionary{-}{}{-}pages.tex} con il seguente contenuto: +{\tolerance=3000 Si supponga di disporre di questo un documento composto ricorrendo a \prog{latex} e di averlo trasformato mediante \prog{dvips} e \prog{pstopdf}, oppure mediante \prog{dvipdfm}; il nome del file sia \file{filelatex.pdf}. Si prepara ora un altro semplicissimo file che viene chiamato, per esempio, \file{filelatex-pages.tex} con il seguente contenuto: \begin{verbatim} % !TEX encoding = UTF-8 Unicode % !TEX TS-program = pdflatex \documentclass[a4paper]{report} \usepackage{pdfpages} -\usepackage[a-1b]{pdfx} +\usepackage[a-1b]{pdfx}% oppure [a-1b] \nofiles \begin{document}\pagestyle{empty} -\includepdf[pages=-]{toptesi-it.pdf} +\includepdf[pages=-]{filelatex.pdf} \end{document} \end{verbatim} -e lo si affianca con il corrispondente file \file{toptesi-it-pages.xmpdata} il cui contenuto è identico al file \file{toptesi-it.xmpdata} che si sarebbe preparato per comporre l'analogo file se lo si fosse potuto comporre con \prog{pdflatex}.\par} +e lo si affianca con il corrispondente file \file{filelatex-pages.xmpdata} il cui contenuto è identico al file \file{filelatex.xmpdata} che si sarebbe preparato per comporre l'analogo file se lo si fosse potuto comporre con \prog{pdflatex}.\par} -Il piccolo file precedente è in grado di produrre un file PDF/A perché il suo preambolo è correttamente predisposto per questo scopo; carica il pacchetto \pack{pdfpages} che serve per importare tutte le pagine (o una loro selezione) di un file PDF comunque composto, dentro il file che si ottiene elaborandolo con \textcolor{red}{\prog{pdflatex}}. Se il file \file{toptesi-it.pdf} non contiene file importati con caratteristiche incompatibili, il file PDF ottenuto risulta conforme alla norma PDF/A, ma se il file di partenza conteneva collegamenti ipertestuali, il file finale ottenuto ne è privo. +Il piccolo file precedente è in grado di produrre un file PDF/A perché il suo preambolo è correttamente predisposto per questo scopo; carica il pacchetto \pack{pdfpages} che serve per importare tutte le pagine (o una loro selezione) di un file PDF comunque composto, dentro il file che si ottiene elaborandolo con \textcolor{red}{\prog{pdflatex}}. Se il file \file{filelatex.pdf} non contiene file importati con caratteristiche incompatibili, il file PDF ottenuto risulta conforme alla norma PDF/A, ma se il file di partenza conteneva collegamenti ipertestuali, il file finale ottenuto ne è privo. -Ho usato come esempio il nome di questo stesso file di documentazione; il lettore capisce che si tratta solo di un esempio, perché questo documento si compila perfettamente in formato PDF/A senza ricorrere a questo procedimento. Ma, se per esempio, si fosse composta la tesi con un word processor e la si fosse esportata in formato PDF, questo procedimento potrebbe crearne la versione PDF/A compatibile senza sforzo e con la sola spesa di perdere i collegamenti ipertestuali interni. +Ho usato come esempio un nome di file di fantasia che ovviamente deve essere sostituito col vero nome del file da elaborare. Ma, se per esempio, si fosse composta la tesi con un word processor e la si fosse esportata in formato PDF, questo procedimento potrebbe crearne la versione PDF/A compatibile senza sforzo e con la sola spesa di perdere i collegamenti ipertestuali interni. Più comodamente il procedimento descritto in questo paragrafo può servire per aggiungere quanto manca, per esempio, ad una figura PDF per verificarne la conformità oppure per scoprirne le cause di non conformità, eventualmente per modificarla in modo che sia compatibile tanto da poterla includere nella tesi vera e propria. -Per esperienza diretta, come ho già detto, quando devo convertire un file PDF comunque ottenuto io ora preferisco seguire questo procedimento che ricorre al pacchetto \pack{pdfpages} e lo consiglio vivamente rispetto ad altri metodi. +Per esperienza diretta, come ho già detto, quando devo convertire un qualunque file PDF, io ora preferisco seguire questo procedimento che ricorre al pacchetto \pack{pdfpages}; lo consiglio vivamente rispetto ad altri metodi. \subsubsection{Uso di \texorpdfstring{\prog*}{}{ghostscript}} -Si potrebbe anche usare \prog{ghostscript} per trasformare un file PDF in un altro conforme alla norma PDF/A. L'operazione non è semplice ed è, secondo me, mal descritta nella documentazione di \prog{ghostscript}. Se ci si sente a proprio agio con il linguaggio PostScript e si padroneggia bene il suddetto programma, si può provare. Tuttavia, pur essendomi servito di questo procedimento per diversi anni prima di poter disporre del metodo descritto nel paragrafo precedente, non lo consiglio e rimando il lettore alla documentazione di \prog{ghostscript}. +Si potrebbe anche usare \prog{ghostscript} per trasformare un file PDF in un altro conforme alla norma PDF/A. L'operazione non è semplice ed è, secondo me, mal descritta nella documentazione di \prog{ghostscript}. Se ci si sente a proprio agio con il linguaggio PostScript e si padroneggia bene il suddetto programma, si può provare. Tuttavia, pur essendomi servito di questo procedimento per diversi anni prima di poter disporre del metodo descritto nel paragrafo precedente, non lo consiglio e rimando il lettore interessato alla documentazione di \prog{ghostscript}. \subsubsection[Non usare \texorpdfstring{\pack}{}{pax} e \texorpdfstring{\pack}{}{pdfpages} assieme]{Non usare i due pacchetti \pack{pax} e \pack{pdfpages} assieme allo scopo di conservare i collegamenti ipertestuali} @@ -2959,13 +2975,13 @@ Per verificare in modo serio la conformità ci sono alcune strade che non si esc \begin{enumerate}[noitemsep] \item Ci si procura la versione del programma \prog{veraPDF}; questo software nel 2016 era ancora in fase di sviluppo e per questo era considerato sperimentale; dal 2017 il programma non è più sperimentale ma, senza escludere possibili aggiornamenti, ora è stabile. L'azienda che se ne occupa è sostenuta dalla Unione Europea proprio affinché la versione definitiva sia aperta e libera. Funziona benissimo e i suoi verdetti, secondo l'esperienza già fatta, sono praticamente sempre concordi con quelli del modulo Preflight di Adobe Acrobat Pro~XI. Questo programma è disponibile per le tre piattaforme Windows, Mac, Linux. % -\item Si cerca in dipartimento una stazione di lavoro dove un computer sia dotato del programma commerciale {Adobe Acrobat Pro XI}; spesso i dipartimenti dispongono di licenze multiple, oppure è possibile che un ricercatore dia una mano lasciando usare un suo calcolatore sul quale è montato il software indicato. Si procede poi come indicato tra poco. +\item Si cerca in dipartimento una stazione di lavoro dove un computer sia dotato del programma commerciale {Adobe Acrobat Pro XI}; spesso i dipartimenti dispongono di licenze multiple, oppure è possibile che un ricercatore dia una mano lasciando usare un suo calcolatore sul quale sia montato il software indicato. Si procede poi come indicato tra poco. %. -\item La Adobe, come molte altre imprese produttrici di software, dispone di un programma \emph{Education} che consente agli studenti e ai docenti di università e scuole secondarie superiori di acquistare i loro software a prezzi molto, molto vantaggiosi. Io come privato cittadino non mi sarei mai comprato l'Adobe Acrobat Pro~XI se non avessi avuto la possibilità di avvantaggiarmi di questa offerta vantaggiosissima ma, come professore, ho potuto farlo senza bisogno di ricorrere a nessuno per usarne una copia acquistata regolarmente. +\item La Adobe, come molte altre imprese produttrici di software, dispone di un program"ma \emph{Education} che consente agli studenti e ai docenti di università e scuole secondarie superiori di acquistare i loro software a prezzi molto, molto vantaggiosi. Io come privato cittadino non mi sarei mai comprato l'Adobe Acrobat Pro~XI se non avessi avuto la possibilità di sfruttare questa offerta vantaggiosissima ma, come professore, ho potuto farlo senza bisogno di ricorrere a nessuno per usarne una copia acquistata regolarmente. \end{enumerate} \subsection{Verifica con veraPDF} -Nell'installare \prog{veraPDF} si sarà avuto attenzione di creare anche un link simbolico verso la componente \prog{verapdf-gui} che è l'applicazione da usare; il link simbolico si troverà in una cartella che sia sul percorso di ricerca dei programmi da eseguire secondo le impostazioni della propria macchina; comunque tutti i sistemi operativi consentono di impostare il percorso di ricerca attraverso i loro propri comandi o attraverso interfacce grafiche. +Nell'installare \prog{veraPDF} si sarà avuta attenzione di creare anche un link simbolico verso la componente \prog{verapdf-gui} che è l'applicazione da usare; il link simbolico si troverà in una cartella che sia sul percorso di ricerca dei programmi da eseguire secondo le impostazioni della propria macchina; comunque tutti i sistemi operativi consentono di impostare il percorso di ricerca attraverso i loro propri comandi o attraverso interfacce grafiche. Fatto questo, si apre un terminale e si dà il comando \texttt{verapdf-gui}; si apre una finestra come quella che appare nella figura~\ref{fig:veraPDFinitial}. @@ -2999,7 +3015,7 @@ Disponendo di Adobe Acrobat Pro XI, si apre il file PDF, si va nella voce di men Se invece l'analisi indicasse errori, bisogna provvedere a correggerli; è vero che nella stessa finestrina c'è anche il bottone \textsf{Analyse and fix}, ma l'operazione di “aggiustamento” di solito riesce a correggere errori molto veniali, quindi con i programmi di composizione del sistema \TeX (col quale non si compiono errori veniali) questo aggiustamento è raro che abbia successo. Tuttavia nella versione di Acrobat Pro~XI c'è la possibilità di correggere alcuni errori specifici; per esempio se viene lamentata la presenza di trasparenze, esiste la possibilità di cliccare l'azione \textsf{Flatten} e le trasparenze svaniscono. Dopo la versione XI, la Adobe ha creato la versione che lavora in rete con un modico abbonamento mensile; conviene se si usa Acrobat molto spesso e si ha il vantaggio di usare sempre la versione più aggiornata. Con questa versione ad abbonamento le possibilità di correzione sono maggiori e quasi sempre permettono di evitare di servirsi di \prog{Inkscape}. -Ma non bisogna dimenticare che questo genere di piccoli errori spesso si presentano quando si importano file esterni; quindi tanto vale, invece, selezionare nella finestra di dialogo di Preflight la funzione Fixup; che parte e richiede con che nome si vuole salvare il file “difettoso”; si può tranquillamente specificare di sovrascrivere il file da sistemare; fra le altre operazioni che Fixup può fare c'è anche quella di modificare il profilo di colore dei file che ne hanno uno errato, e questa, fra le altre è una operazione da fare piuttosto spesso quando si importano file esterni. L'ho dovuto fare anche con questo file di documentazione a causa di alcune figure create da me stesso per le quali non avevo controllato che avessero il profilo di colore corretto, cioè~RGB. +Ma non bisogna dimenticare che questo genere di piccoli errori spesso si presentano quando si importano file esterni; quindi tanto vale, invece, selezionare nella finestra di dialogo di Preflight la funzione Fixup, che parte e richiede con che nome si vuole salvare il file “difettoso”; si può tranquillamente specificare di sovrascrivere il file da sistemare; fra le altre operazioni che Fixup può fare c'è anche quella di modificare il profilo di colore dei file che ne hanno uno errato, e questa, fra le altre è una operazione da fare piuttosto spesso quando si importano file esterni. L'ho dovuto fare anche con questo file di documentazione a causa di alcune figure create da me stesso per le quali non avevo controllato che avessero il profilo di colore corretto, cioè~RGB. \subsection{Correzione degli errori} @@ -3007,17 +3023,17 @@ Bisogna avere pazienza e cercare di leggere con attenzione i messaggi di diagnos Gli errori che restano sono di solito dei tipi seguenti. \begin{enumerate}[noitemsep] -\item Se è stato specificato un profilo di colore CMYK (celeste, lilla, giallo, nero) si è fatto un errore nello specificare il profilo di colore oppure si è inserita un'immagine a colori che è colorata con lo schema CMYK. Nel primo caso è bene verificare di avere specificato il profilo giusto. Nel secondo caso bisogna convertire il profilo di colore mediante qualsiasi programma di fotoritocco; segnalo il programma aperto e libero GIMP (GNU Image Management Program), disponibile per le tre piattaforme più comuni e i sistemi operativi Mac, Windows e Linux. Esso è in grado di aprire immagini in “qualsiasi” formato bitmapped o vettoriale, di elaborarne il file secondo i desideri dell'utente, per poi salvarlo in qualsiasi formato bitmapped, ma non nei formati vettoriali. -% +\item Se è stato specificato un profilo di colore CMYK (celeste, lilla, giallo, nero; Cyan, Magenta, Yellow, blacK) si è fatto un errore nello specificare il profilo di colore oppure si è inserita un'immagine a colori che è colorata con lo schema CMYK. Nel primo caso è bene verificare di avere specificato il profilo giusto. Nel secondo caso bisogna convertire il profilo di colore mediante qualsiasi programma di fotoritocco; segnalo il programma aperto e libero GIMP (GNU Image Management Program), disponibile per le tre piattaforme più comuni e i sistemi operativi Mac, Windows e Linux. Esso è in grado di aprire immagini in “qualsiasi” formato bitmapped o vettoriale, di elaborarne il file secondo i desideri dell'utente, per poi salvarlo in qualsiasi formato bitmapped, ma non nei formati vettoriali. +%>>>> \item Alcuni font hanno glifi di larghezza nulla, fra questi ci sono almeno due glifi della famiglia matematica \texttt{cmsym}; \pack{toptesi} provvede già da solo a sostituire questi glifi con altri simili o con disegni, in modo da correggere l'errore; tuttavia questi glifi potrebbero essere presenti in alcuni dei file importati. % -\item Alcune figure sia raster (a cui siano state sovrapposte legende testuali con caratteri vettoriali) sia vettoriali (che contengono legende testuali) possono mancare dell'inclusione dei font; per cui quando queste immagini vengono immesse nel file PDF che si vorrebbe conforme alla norma, questa conformità viene a mancare. Se si sono prodotti personalmente tali file da includere, bisogna avere cura di far sì che tutti i glifi dei font usati nel file da includere siano essi stessi inclusi direttamente; esattamente come ho fatto con i loghi \GuIT\ e \MP\ di cui ho detto prima. Purtroppo questo è un caso molto frequente; quindi capita sovente di dover procedere alla correzione di questo genere di file. +\item Alcune figure sia raster (a cui siano state sovrapposte legende testuali con caratteri vettoriali) sia vettoriali (che contengono legende testuali) possono mancare dell'in"clu"sione dei font; per cui quando queste immagini vengono immesse nel file PDF che si vorrebbe conforme alla norma, questa conformità viene a mancare. Se si sono prodotti personalmente tali file da includere, bisogna avere cura di far sì che tutti i glifi dei font usati nel file da includere siano essi stessi inclusi direttamente; esattamente come ho fatto con i loghi \GuIT\ e \MP\ di cui ho detto prima. Purtroppo questo è un caso molto frequente; quindi capita sovente di dover procedere alla correzione di questo genere di file. Per le figure con legende testuali, basta convertire l'intera figura nel formato \file{.png} (se contiene disegni al tratto e purché non contenga trasparenze) oppure \file{.jpg} se contiene colori sfumati), e il gioco è fatto. -Ma se si vuole mantenere la natura vettoriale si potrebbe usare il programma gratuito \prog{Inkscape} che è in grado di aprire file vettoriali (PDF, EPS, PS) e di trasformarli in file con le estensioni vettoriali, avendo trasformato nel contempo i caratteri nelle loro outline, cioè nei disegni dei contorni dei glifi, riempiti dello stesso colore che avevano quei glifi nella figura originale. Spesso questa trasformazione va a buon fine. +Ma se si vuole mantenere la natura vettoriale si potrebbe usare il programma gratuito \prog{Inkscape}, che è in grado di aprire file vettoriali (PDF, EPS, PS) e di trasformarli in file con le estensioni vettoriali, avendo trasformato nel contempo i caratteri nelle loro outline, cioè nei disegni dei contorni dei glifi, riempiti dello stesso colore che avevano quei glifi nella figura originale. Spesso questa trasformazione va a buon fine. -Come esperienza personale ritengo che sia opportuno convertire ogni figura vettoriale con i glifi sostituiti dai loro contorni, solo nel formato EPS, che non gestisce le trasparenze, che sono invece gestite dal formato \file{.pdf}. In questo modo i tre programmi che ci interessano, \prog{pdflatex}, \prog{xelatex} e \prog{lualatex}, sono tutti e tre in grado di ricevere figure in formato \file{.eps}, e di incorporarlo nel file PDF in uscita. In questo modo si è sicuri di poter evitare le trasparenze, che sono vietate con lo standard PDF/A-1b. Alternativamente si riapre il file \file{.eps} sempre cn \prog{Inkscape} e lo si salva in formato \file{.pdf}; il file \file{.eps} non conteneva trasparenze, quindi nemmeno il nuovo file \file{.pdf} ne contiene. +Per esperienza personale ritengo che sia opportuno convertire ogni figura vettoriale con i glifi sostituiti dai loro contorni, solo nel formato EPS, che non gestisce le trasparenze, che sono invece gestite dal formato \file{.pdf}. In questo modo i tre programmi che ci interessano, \prog{pdflatex}, \prog{xelatex} e \prog{lualatex}, sono tutti e tre in grado di ricevere figure in formato \file{.eps}, e di incorporarlo nel file PDF in uscita. In questo modo si è sicuri di poter evitare le trasparenze, che sono vietate con lo standard PDF/A-1b. Alternativamente si riapre il file \file{.eps} sempre cn \prog{Inkscape} e lo si salva in formato \file{.pdf}; il file \file{.eps} non conteneva trasparenze, quindi nemmeno il nuovo file \file{.pdf} ne contiene. \end{enumerate} @@ -3048,26 +3064,27 @@ Le opzioni che si possono specificare per la classe \class{toptesi} sono tutte d % \item[corpo] nella forma \chiave{corpo}{\meta{corpo normale}} accetta un valore anche fratto compreso fra ampi limiti, ma si consiglia di restare nell'intervallo fra $9,5\unit{pt}$ e $13.5\unit{pt}$, se non si specifica l'unità di misura vengono assunte pari a $1\unit{pt}$, altrimenti qualunque altra unità di misura accettata dai programmi di composizione del sistema \TeX\ è valida, purché si resti preferibilmente entro l'intervallo specificato sopra. Se il \meta{corpo normale} venisse specificato con un valore superiore a $13.5\unit{pt}$ anche la gabbia di stampa viene modificata per non comporre righe troppo corte in relazione al corpo. Questo è un altro motivo che sconsiglia vivamente di specificare corpi troppo grandi per il testo normale % -\item[tipotesi] nella forma \chiave{tipotesi}{\meta{tipo della tesi}} accetta molti valori; il valore nullo \chiave{tipotesi}{} o il valore di default \chiave{tipotesi}{topfront}, fra loro equivalenti, per comporre una tesi in maniera retrocompatibile con le funzionalità del pacchetto \TOPtesi fino alla versione~5; \chiave{tipotesi}{custom} per un frontespizio personalizzato a mano dall'utente; inoltre \chiave{tipotesi}{frontespizio} per comporre il frontespizio con le funzionalità del pacchetto \pack{frontespizio} che l'utente deve caricare espressamente; \chiave{tipotesi}{sss} per la tesina delle scuole secondarie superiori; \chiave{tipotesi}{scudo}, per la dissertazione dottorale presso la Scuola di Dottorato del Politecnico di Torino; \chiave{tipotesi}{triennale} o \chiave{tipotesi}{monografia} per comporre una tesi di laurea triennale; l'opzione \chiave{tipotesi}{magistrale} per comporre una tesi magistrale o a ciclo unico; \chiave{tipotesi}{dottorale} per comporre una tesi dottorale senza le caratteristiche della dissertazione della scuola ScuDo. +\item[tipotesi] nella forma \chiave{tipotesi}{\meta{tipo della tesi}} accetta molti valori; il valore nullo \chiave{tipotesi}{} o il valore di default \chiave{tipotesi}{topfront}, fra loro equivalenti, per comporre una tesi in maniera retrocompatibile con le funzionalità del pacchetto \TOPtesi fino alla versione~5; \chiave{tipotesi}{custom} per un frontespizio personalizzato a mano dall'utente; inoltre \chiave{tipotesi}{frontespizio} per comporre il frontespizio con le funzionalità del pacchetto \pack{frontespizio} che con questa opzione la classe carica direttamente; \chiave{tipotesi}{sss} per la tesina delle scuole secondarie superiori; \chiave{tipotesi}{scudo}, per la dissertazione dottorale presso la Scuola di Dottorato del Politecnico di Torino; \chiave{tipotesi}{triennale} o \chiave{tipotesi}{monografia} per com"porre una tesi di laurea triennale; l'opzione \chiave{tipotesi}{magistrale} per comporre una tesi magistrale o a ciclo unico; \chiave{tipotesi}{dottorale} per comporre una tesi dottorale senza le caratteristiche della dissertazione della scuola ScuDo. % \item[libro] Serve per impostare i margini interno ed esterno, superiore e inferiore, in modo che siano diversi e due pagine affacciate si presentino come un libro stampato correttamente. Senza usare questa opzione, i margini sono preimpostati uguali in vista di una lettura a schermo. % -\item[cucitura] nella forma \chiave{cucitura}{\meta{spostamento}}, serve per specificare lo \meta{spostamento} verso l'esterno della gabbia del testo in vista di una rilegatura della copia stampata legata con un procedimento piuttosto rigido; lo \meta{spostamento}, se non se ne specifica il valore, è assunto pari a $7\unit{mm}$; se non si specifica nemmeno la chiave lo \meta{spostamento} è nullo. +\item[cucitura] nella forma \chiave{cucitura}{\meta{spostamento}}, serve per specificare lo \meta{spostamento} verso l'esterno della gabbia del testo in vista di una rilegatura della copia stampata legata con un procedimento piuttosto rigido; lo \meta{spostamento}, se non se ne specifica il valore, è assunto pari a $7\unit{mm}$; lo \meta{spostamento} è nullo se non si specifica nemmeno la chiave. % -\item[stile] nella forma \chiave{stile}{\meta{stile della composizione}} può ricevere i valori \chiave{stile}{standard} per comporre in modo predefinito i frontespizi e le testatine; \chiave{stile}{classica} oppure \chiave{stile}{trieste} (questa deprecata, ma conservata per retrocompatibilità) compone in modo `classico' il frontespizio e accetta che vengano specificate anche altre opzioni per configurare le testatine. +\item[stile] nella forma \chiave{stile}{\meta{stile della composizione}} può ricevere i valori tre valori diversi; con \chiave{stile}{standard} i frontespizi e le testatine vengono ocmposte nel modo modo predefinito; invece con \chiave{stile}{classica} oppure \chiave{stile}{trieste} (questa deprecata, ma conservata per retrocompatibilità) il frontespizio viene composto nel modo ‘classico’ e vengono accettate anche altre opzioni per configurare le testatine. % -\item[autoretitolo] accettabile solo con l'opzione \chiave{stile}{classica}, serve per comporre le testatine in modo diverso, con il nome dell'autore e il titolo (breve) della tesi nella testatina di sinistra e il titolo del capitolo nella testatina di destra. Sconsiglio vivamente di usare questa opzione (richiestami dai classicisti) perché vanifica in parte l'utilità delle testatine; inoltre, se non si specifica il titolo breve mediante l'argomento facoltativo del comando \cs{titolo} o \cs{title}, la probabilità che la testatina di sinistra esca dalla gabbia di composizione o anche dalla larghezza della pagina è elevata. +\item[autoretitolo] accettabile solo con l'opzione \chiave{stile}{classica}, serve per comporre le testatine in modo diverso, con il nome dell'autore e il titolo (breve) della tesi nella testatina di sinistra e il titolo del capitolo nella testatina di destra. Sconsiglio vivamente di usare questa opzione (richiestami dai classicisti) perché vanifica in parte l'utilità delle testatine; inoltre, se non si specifica il titolo breve mediante l'argomento facoltativo del comando \cs{titolo} o \cs{title}, la probabilità che la testatina di sinistra esca dalla gabbia di composizione o anche dalla larghezza del foglio è elevata. % -\item[oldstyle] valido solo con l'opzione \chiave{tipotesi}{classica}, serve per usare le cifre minuscole nella composizione del frontespizio. +\item[oldstyle] valido solo con l'opzione \chiave{tipotesi}{classica}, serve per usare le cifre minu"scole nella composizione del frontespizio. % -\item[numerazioneromana] serve per comporre il numero della pagine in numeri romani in maiuscoletto nella parte iniziale della tesi, prima di emettere il primo comando \cs{chapter} con o senza asterisco. È un dettaglio stilistico, che oggi appare un po' troppo desueto e comunque privo di ogni motivazione (questa esisteva quando si componeva a mano o a macchina con caratteri metallici). Si ricorda che \cs{chapter*} non mette nulla nell'indice generale, ma modifica entrambe le testatine mediante il suo argomento facoltativo. +\item[numerazioneromana] serve per comporre il numero della pagine in numeri romani in maiuscoletto nella parte iniziale della tesi, prima di emettere il primo comando \cs{chapter} senza asterisco. È un dettaglio stilistico, che oggi appare un po' troppo desueto e comunque privo di ogni motivazione (questa esisteva quando si compo"neva a mano o a macchina con caratteri metallici). Si ricorda che \cs{chapter*} non mette nulla nell'indice generale, ma modifica entrambe le testatine mediante il suo argomento facoltativo. % -\item[evenboxes] serve per specificare che nello \chiave{stile}{standard} si vogliono comporre le due `scatole' contenti i nomi dei relatori e dei candidati affiancate ma allineate superiormente. Senza questa opzione, in questo stile, le due `scatole' sono collocate disallineate in modo tale da poter inserire le firme degli uni e degli altri sulla stessa riga del loro nome. +\item[evenboxes] serve per specificare che nello \chiave{stile}{standard} si vogliono comporre le due `scatole' contenti i nomi dei relatori e dei candidati affiancate ed allineate superiormente. Senza questa opzione, in questo stile, le due ‘scatole’ sono disallineate in modo tale da poter inserire le firme degli uni e degli altri sulla stessa riga del loro nome. % \item[mybibliostyle] serve solo quando si compone con l'opzione \chiave{tipotesi}{scudo} per evitare il caricamento automatico dei pacchetti di gestione della bibliografia in modo che l'utente possa caricarsi i pacchetti che preferisce, senza incorrere in errori di tipo “Option clash”. % -\item[chapterbib] questa opzione è conservata per retrocompatibilità e per quando si compone la bibliografia a mano; siccome oggi questo metodo, benché usabile, di fatto non si usa più, ma si usano i database bibliografici e i programmi di gestione come \BibTeX\ e \prog{biber}, se si volesse davvero comporre una bibliografia distinta alla fine di ogni capitolo, si suggerisce di servirsi delle funzionalità del pacchetto \pack{biblatex} e del programma \prog{biber}, che consentono di estrarre e di comporre le diverse bibliografie estraendo dai database bibliografici solo le informazioni relative alle opere citate in ciascun capitolo. Sconsiglio di comporre bibliografie separate per ogni capitolo quando si compone qualunque tesi, tuttavia è possibile farlo. Potrebbe avere qualche senso in una tesi compilativa dove si citano e si commentano molte decine, talvolta centinaia di riferimenti. +\item[chapterbib] questa opzione è conservata per retrocompatibilità e per quando si compone la bibliografia a mano; siccome oggi questo metodo, benché usabile, di fatto non si usa più, ma si usano i database bibliografici e i programmi di gestione come \BibTeX\ e \prog{biber}, se si volesse davvero comporre una bibliografia distinta alla fine di ogni capitolo, si suggerisce di servirsi delle funzionalità di quel pacchetto e di quel programma, che consentono di estrarre e di comporre le diverse bibliografie estraendo dai database bibliografici solo le informazioni relative alle opere citate in ciascun capitolo. Sconsiglio di comporre bibliografie separate per ogni capitolo quando si compone qualunque tesi, tuttavia è possibile farlo. Potrebbe avere qualche senso in una tesi compilativa dove si citano e si commentano molte decine, talvolta centinaia di riferimenti. % +\item[folioinhead\textnormal{ e }nocenterhead\textnormal{ e }nocenterfolio] riguardano alcune diverse posizioni per il numero di pagina (folio) e per il testo (head) delle testatine; il numero di pagina di solito sta al centro del piedino, ma con l'opzione \texttt{nocenterfolio} si può spostare tale numero a in modo che sia adiacente al margine esterno se sta nel piedino, ma se è in vigore \texttt{folioinhead} viene fatto protrudere nel margine esterno accanto e allineato con la testatina; la chiave \texttt{nocenterhead} sposta il testo della testatina fino ad essere adiacente al margine esterno. Dovrebbe essere chiaro che con queste impostazioni con il testo al margine esterno e il numero accanto, sia pure sporgente nel margine, la testatina non è gradevole e probabilmente non soddisfa i cannoni della tipografia. L'utente è avvisato affinché non scelga chiavi che contrastano esteticamente. \end{description} @@ -3134,24 +3151,24 @@ tabella~\ref{tab:generale}. \string\ped\{eff\}\string$} \\ \cs{ap}\Arg{...}& nessuno & Apice in tondo\newline Modi testo e matematico - & \texttt{\string$M\relax + & \texttt{\string$M\relax \string\ap\{T\}\string$} \\ \cs{unit}\Marg{...}&nessuno & Unità di misura in tondo unite al numero\newline Modi testo e matematico - & \texttt{15\string + & \texttt{15\string \unit\Arg{k\string\ohm}} \\ -\cs{gei} & & Unità immaginaria in +\cs{gei} o\cs{ju} o \cs{iu} + & & Unità immaginaria in tondo \newline Solo modo matematico - & \texttt{\string$ - \string\eu\string^\string{\string\gei - \string\omega\ t\string}\string$} \\ + & \texttt{\$ \cs{eu}\string^\{\cs{gei}% + \cs{omega} t\} \$} \\ \cs{eu} & & Numero “e” in tondo\newline Solo modo matematico & \texttt{\string$ \string\eu\string^\Arg{\string\gei - \string\omega\ t}\string$} \\ + \string\omega\ t} \string$} \\ \cs{gradi} & & circoletto alzato\newline Modo testo e matematico & \texttt{27\string\unit \Arg{\string\gradi\ C}} \\ @@ -3191,7 +3208,7 @@ stesso formato; il secondo agisce come una dichiarazione che resta in vigore finché una dichiarazione contraria non ne modifichi il valore. \textcolor{red}{Tuttavia sia l'ambiente sia il comando non dovrebbero mai essere usati!}\par} -La composizione tipografica non ha nulla a che vedere con la composizione dattilografica. Quest'ultima si faceva con mezzi avanzati per l'epoca, ma oggi quei mezzi sono del tutto obsoleti; le poche macchine da scrivere meccaniche o elettromeccaniche che esistono ancora fuori da qualche museo, vengono usate per riempire formulari o compilare le informazioni sui documenti cartacei che sopravvivono alla invasione delle carte plastificate; ma tolti gli usi burocratici non mi viene in mente nessun altro uso degno di nota. +La composizione tipografica non ha nulla a che vedere con la composizione dattilogra"fica. Quest'ultima si faceva con mezzi avanzati per l'epoca, ma oggi quei mezzi sono del tutto obsoleti; le poche macchine da scrivere meccaniche o elettromeccaniche che esistono ancora fuori da qualche museo, vengono usate per riempire formulari o compilare le informazioni sui documenti cartacei che sopravvivono alla invasione delle carte plastificate; ma tolti gli usi burocratici non mi viene in mente nessun altro uso degno di nota. La composizione tipografica esige un perfetto equilibrio fra il corpo del font usato e la distanza fra le righe su cui sono appoggiati i caratteri di due righe consecutive di testo; questa distanza prende il nome tecnico di \emph{scartamento} o \emph{avanzamento di riga}, ma spesso viene chiamato impropriamente \emph{interlinea}; questo scartamento a seconda del font in uso può essere dal 10\% al 20\% maggiore del corpo del font usato. @@ -3216,12 +3233,14 @@ Se proprio si vogliono stampare su carta delle bozze scritte abbastanza larghe a mano, allora si imposti il fattore di \amb{interlinea} al massimo a \texttt{1.5}, ma quando si stampa la bella copia, la versione finale, ci si ricordi di re-impostare per \amb{interlinea} il valore unitario -di default. +di default.\enlargethispage*{1\baselineskip} Tra l'altro non si vuole mica usare l'espediente di un grande fattore di interlinea solo per rimpolpare una tesi dal volume modesto? Esso sarebbe un espediente talmente puerile che sarebbe scoperto al primo -sguardo. Ci si ricordi che alcune tesi svolte al Politecnico di Torino all'inizio degli anni 20 del XX secolo non superavano le 30~pagine dattiloscritte o scritte a mano (!), ma ricevettero la dignità di stampa\footnote{Una era del candidato Carlo Alberto Castigliano e vi veniva enunciato il teorema di Castigliano; un'altra era di Placido Cicala e vi si svolgeva la teoria delle volte sottili, teoria che gli strutturisti considerano assolutamente fondamentale ancora oggi.}; le si sta studiando ancora oggi dopo circa un secolo! +sguardo. Ci si ricordi che alcune tesi svolte al Politecnico di Torino all'inizio degli anni 20 del XX secolo non superavano le 30~pagine dattiloscritte o scritte a mano (!), ma ricevettero la dignità di stampa\footnote{Una era quella di Carlo Alberto Castigliano e vi veniva enunciato e provato il teorema di Castigliano, noto a tutti gli ingegneri civili ed edili; un'altra era di Placido Cicala e vi si svolgeva la teoria delle volte sottili, teoria che gli strutturisti considerano assolutamente fondamentale ancora oggi.}; le si sta studiando ancora oggi dopo circa un secolo! + + \subsubsection{La misteriosa pagina bianca} Vale la pena di commentare il misterioso comando \cs{blankpagestyle}. Quando si compone fronte e retro senza usare l'opzione di classe \opt{openany}, i capitoli vengono sempre aperti nelle pagine di destra, cioè nelle pagine dispari. Per fare questo il comando \cs{chapter} agisce eseguendo subito il comando \cs{cleardoublepage} che, fra le altre cose, controlla se la nuova pagina su cui scrivere il titolo del capitolo sia dispari. Se non lo fosse provocherebbe la stampa di una pagina “bianca”; bianca nel senso che non contiene testo ma contiene la testatina e il piedino. @@ -3230,11 +3249,11 @@ Fino alla versione “antica” 0.62 di \TOPtesi, questa eventuale pagina bianca \begin{flushleft}\ttfamily \cs{blankpagestyle}\Marg{empty} \end{flushleft} -e il problema è risolto. Volendo si potrebbe specificare il nome di qualunque altro stile di pagina già definito ma, ad essere franchi, non vedo alternative fra i due stili \texttt{plain} e \texttt{empty} rispetto agli altri stili che contengono sempre le testatine, eventualmente ridotte al solo loro filetto. +e il problema è risolto. Volendo si potrebbe specificare il nome di qualunque altro stile di pagina già definito ma, ad essere franchi, non si vedono alternative fra i due stili \texttt{plain} e \texttt{empty} rispetto agli altri stili che contengono sempre le testatine, eventualmente ridotte al solo loro filetto. -Se lo si vuole usare, consiglio di farlo subito dopo \Bambiente{document}. +Se lo si vuole usare, si consiglia di farlo subito dopo \Bambiente{document}. -Se invece si desidera lasciare il valore di default a \texttt{plain} e usare saltuariamente un altro stile, si usi esplicitamente il comando \cs{cleradoublepage} specificandogli lo stile desiderato come argomento facoltativo, per esempio: +Se invece si desidera lasciare il valore di default a \texttt{plain} e usare saltuariamente un altro stile, si usi esplicitamente il comando \cs{cleardoublepage} specificandogli lo stile desiderato come argomento facoltativo, per esempio: \begin{verbatim} \cleardoublepage[empty] \end{verbatim} @@ -3254,7 +3273,7 @@ Si tratta di un ambiente non flottante, per cui può apparire in mezzo al testo Per usare questo ambiente bisogna seguire una sintassi particolare che richiede argomenti non delimitati o delimitati in modo particolare, per cui è opportuno specificare la sintassi in modo dettagliato. \begin{flushleft}\obeylines -\Bambiente{\meta{foat}} +\Bambiente{\meta{float}} \qquad\Bambiente{SDbox}\marg{tipo}\meta{asterisco facoltativo}% \oarg{frazione} \qquad\qquad\cs{SDimage}\meta{comandi per l'immagine} @@ -3268,7 +3287,7 @@ dove i vari argomenti hanno il seguente significato. \item Il \meta{tipo} indica il tipo di oggetto da presentare con la didascalia accanto; deve coincidere con uno dei nomi degli - ambienti che fanno flottare gli oggetti; quindi normalmente + ambienti flottanti; quindi normalmente \meta{tipo} può valere “figure”, oppure “table” e, se sono stati definiti altri ambienti flottanti con le funzionalità del pacchetto \pack{float}, i nomi di questi @@ -3404,7 +3423,7 @@ dove i vari argomenti hanno il seguente significato. Il terzo argomento del comando \cs{SDcaption} termina con l'\meta{etichetta} da assegnare alla figura; questa etichetta è quella che solitamente costituisce l'argomento del comando - \cs{label} qui non lo si usa direttamente perché ci pensa + \cs{label}; qui non lo si usa direttamente perché ci pensa \cs{SDcaption} a usare \cs{label} al momento opportuno e a conservare l'etichetta in un dato registro perché i comandi di chiusura dell'ambiente possano gestire correttamente @@ -3419,7 +3438,7 @@ dove i vari argomenti hanno il seguente significato. a quelli descritti sopra. Bisogna ricordare che la scatola SD può contenere una didascalia numerata col suo prefisso, oppure una didascalia non numerata e priva di prefisso. Se - l'\meta{etichetta} (facoltativa) non viene specificata e se il + l'\meta{etichetta} (facoltativa) non viene specificata e se il \meta{tipo} non è noto la didascalia non viene numerata; se il \meta{tipo} (opzionale) viene specificato, può essere anche diverso da quello dell'ambiente flottante circostante, @@ -3438,16 +3457,16 @@ Questa lunga descrizione si è resa necessaria per consentire al lettore di usar \subsubsection{Il comando \texorpdfstring{\cs*}{}{goodpagebreak}} Qualche annotazione va fatta per il comando \cs{goodpagebreak}. Il nucleo di \LaTeX contiene il comando \cs{goodbreak} che dovrebbe impostare un consenso di eseguire un fine pagina impostando una penalità molto piccola negativa, più o meno simile a quello che fa il comando \cs{pagebreak}\Oarg{1}. In realtà questo comando nativo di Plain \TeX, conservato in \LaTeX, di fatto non funziona come ci si aspetterebbe. Il comando di questa classe, \cs{goodpagebreak} procede in un altro modo, anche perché si comporta in modo diverso se viene specificato in modo verticale o in modo orizzontale. -Infatti in modo orizzontale inserisce d'ufficio un comando \cs{vadjust}, il cui argomento vale esattamente \cs{newpage}, e che agisce in modo incondizionato quando la \emph{riga} che lo contiene viene scritta nel file di uscita; si dovrà porre un minimo di attenzione a fare sì che lo spazio alla fine della macro non elimini spazi interparola, né introduca spazi spuri; quando lo si usa, quindi, sarà opportuno lasciare uno spazio prima e dopo la macro, per esempio +Infatti in modo orizzontale, cioè all'interno di un capoverso, inserisce d'ufficio un comando \cs{vadjust}, il cui argomento vale esattamente \cs{newpage}, e che agisce in modo incondizionato quando la \emph{riga} che lo contiene viene scritta nel file di uscita; si dovrà porre un minimo di attenzione a fare sì che lo spazio alla fine della macro non elimini spazi interparola, né introduca spazi spuri; quando lo si usa, quindi, sarà opportuno lasciare uno spazio prima e dopo la macro, per esempio \begin{flushleft}\verb*|...prima \goodpagebreak di...|\end{flushleft} Vale la pena di usare questo comando in certi casi in cui la bozza (non interlineata) mostra un salto pagina prima dell'ultima riga di un capoverso, cioè quando viene prodotta una riga vedova; quando si corregge la bozza si cerca il testo della riga prima di quella vedova e si inserisce la macro fra due parole qualsiasi di quel testo. È evidente che, se si modifica il capoverso e non c'è più bisogno del salto pagina incondizionato, bisogna cancellare la macro da quella posizione. In modo verticale, invece, viene calcolata la differenza fra le lunghezze \cs{pagegoal} e \cs{pagetotal}; la prima corrisponde più o meno a \cs{textheight} diminuita dello spazio riservato alle note in calce e del loro spazio di separazione dal testo; è insomma l'obbiettivo per raggiungere la giusta altezza del testo; la seconda lunghezza è la lunghezza netta del testo raggiunta fino a quel momento; se questa differenza è \emph{non maggiore} (che per la sintassi nativa di \TeX vuol dire \emph{minore o uguale}) al numero di righe specificate di default (4 righe), o specificate mediante l'argomento facoltativo, allora viene inserito un salto pagina incondizionato. Vale la pena servirsi di questo comando in modo verticale quando un oggetto relativamente grande e indivisibile viene rinviato alla pagina successiva, così che obbligherebbe \LaTeX a stiracchiare lo spazio elastico verticale al fine di giustificare la pagina che precede il salto pagina. -Questa spiegazione contorta descrive una situazione piuttosto frequente che si manifesta prima dei titoli di sezioni, sottosezioni, e simili. Infatti ogni titolo è separato da un certo spazio dal testo che inizia la sezione e siccome le righe orfane sono tipograficamente molto sgradevoli (meno delle righe vedove, ma comunque sgradevoli), il titolo della sezione deve essere seguito da almeno due righe di testo. Quindi il titolo della sezione, lo spazio verticale di separazione e le due righe di testo formano un blocco di almeno 4~righe; se non ci stanno in fondo alla pagina, \LaTeX manda tutto questo blocco alla pagina successiva, stiracchiando gli spazi verticali della pagina corrente. Mettendo la macro \cs{goodpagebreak} prima del titolo di quella sezione che viene rinviata alla pagina successiva, si produce una pagina mozza, ma non troppo, e senza spazi stiracchiati, seguita da una pagina che inizia con il titolo della nuova sezione; ecco come fare. +Questa spiegazione contorta descrive una situazione piuttosto frequente che si manifesta prima dei titoli di sezioni, sottosezioni, e simili. Infatti ogni titolo è separato da un certo spazio dal testo che inizia la sezione e siccome le righe orfane sono tipografica"mente molto sgradevoli (meno delle righe vedove, ma comunque sgradevoli), il titolo della sezione deve essere seguito da almeno due righe di testo. Quindi il titolo della sezione, lo spazio verticale di separazione e le due righe di testo formano un blocco di almeno 4~righe; se non ci stanno in fondo alla pagina, \LaTeX manda tutto questo blocco alla pagina successiva, stiracchiando gli spazi verticali della pagina corrente. Mettendo la macro \cs{goodpagebreak} prima del titolo di quella sezione che viene rinviata alla pagina successiva, si produce una pagina mozza, ma non troppo, e senza spazi stiracchiati, seguita da una pagina che inizia con il titolo della nuova sezione; ecco come fare. \begin{verbatim} -... fine dell'ultimo capoverso. +... fine dell'ultimo capoverso prima della nuova sezione. \goodpagebreak @@ -3476,7 +3495,7 @@ Il pacchetto \pack{caption} lo definisce, ma se l'utente di \TOPtesi non lo ha c I comandi di questa sezione possono essere introdotti in un ordine qualunque, ma è più chiaro se sono introdotti nell'ordine in cui sono elencati nelle tabelle~\ref{tab:front1}-\ref{tab:front4} riportate dalla pagina~\pageref{tab:front1} alla pagina~\pageref{tab:front4}. -Alcuni comandi sono generali; altri si riferiscono specificatamente alla monografia di laurea, o alla tesi laurea, o alla dissertazione dottorato. In una colonna di queste tabelle vi è indicata la sigla del modulo per il quale quel comando è valido; se manca questa sigla, il comando vale per tutti i moduli. \textcolor{red}{Le sigle sono: `t' per la triennale, `m' per la magistrale, `d' per la dottorale, `S' per la tesi dottorale della ScuDo, `n' per usare il modulo di default, e `s' per la tesina della scuola secondaria}. +Alcuni comandi sono generali; altri si riferiscono specificatamente alla monografia di laurea, o alla tesi laurea, o alla dissertazione di dottorato. In una colonna di queste tabelle vi è indicata la sigla del modulo per il quale quel comando è valido; se manca questa sigla, il comando vale per tutti i moduli. \textcolor{red}{Le sigle sono: `t' per la triennale, `m' per la magistrale, `d' per la dottorale, `S' per la tesi dottorale della ScuDo, `n' per usare il modulo di default, e `s' per la tesina della scuola secondaria}. Per le tesi dottorali della ScuDo si veda più avanti il paragrafo~\ref{sec:frontescudo}. @@ -3519,7 +3538,7 @@ tabelle citate: \end{ThesisTitlePage} \end{Verbatim} -Naturalmente per usare l'ambiente \amb{ThesisTitlePage} ho usato il modulo per le tesi triennali/monografie specificando \chiave{tipotesi}{monografia} fra le opzioni della classe. Inoltre ho usato il comando \cs{titolo} che, lo si ricorda, per le monografie non è disponibile con il pacchetto di default \pack{topfront}. +Naturalmente per usare l'ambiente \amb{ThesisTitlePage} ho usato il modulo per le tesi triennali/monografie specificando \chiave{tipotesi}{monografia} fra le opzioni della classe. Inoltre ho usato il comando \cs{titolo} che, lo si ricorda, non è disponibile per le monografie con il pacchetto di default \pack{topfront}. \begin{figure}[p]\centering \includegraphics[height=.9\textheight]{FrontespiziAssemblati} @@ -3528,13 +3547,13 @@ Naturalmente per usare l'ambiente \amb{ThesisTitlePage} ho usato il modulo per l Vale la pena di fare le seguenti osservazioni. \begin {enumerate}[noitemsep] -\item Il comando \cs{NomeElaborato} può servire per diversi scopi. In questo particolare documento che non è una tesi di laurea triennale, lo si è usato per qualificare il contenuto con il nome “Manuale d'uso”. In altre circostanze può servire per impostare il nome del documento in una lingua straniera; oppure per una laurea triennale che richieda l'indicazione anche di uno o più relatori, è possibile usare il modulo per la laurea magistrale, cambiando il nome dell'elaborato in “Tesi di laurea triennale” e cambiando il nome del corso degli studi con \cs{NomeCorsoDiStudi} in “Corso di laurea triennale”. +\item Il comando \cs{NomeElaborato} può servire per diversi scopi. In questo particolare documento che non è una tesi di laurea triennale, lo si è usato per qualificare il contenuto con il nome “Manuale d'uso”. In altre circostanze può servire per impostare il nome del documento in una lingua straniera; oppure per una laurea triennale, che richieda l'indicazione anche di uno o più relatori, è possibile usare il modulo per la laurea magistrale, cambiando il nome dell'elaborato in “Tesi di laurea triennale” e cambiando il nome del corso degli studi con \cs{NomeCorsoDiStudi} in “Corso di laurea triennale”. % \item Se per comporre la pagina del titolo si usa un ambiente senza asterisco, il logo viene messo in testa; se si usa la forma asteriscata il logo viene messo nella metà inferiore della pagina del titolo. Se il logo dell'ateneo contiene per disteso il logotipo, cioè il nome per disteso, allora l'uso del comando \cs{ateneo} contenente il nome generico dell'ateneo implica una ridondanza di informazioni che potrebbe anche essere antiestetica; quindi se si usa il comando \cs{ateneo} sarebbe meglio usare un ambiente asteriscato, e viceversa. Ma questa possibilità di scelta per la posizione del logo e la presenza del nome dell'ateneo consente di rispettare le diverse specifiche indicate dalle segreterie didattiche degli atenei; si veda la tabella riassuntiva~\ref{tab:modalitaperfrontespizi} nella pagina~\pageref{tab:modalitaperfrontespizi}. % -\item Il comando \cs{titolo} non è disponibile per la monografia nel modulo di default \pack{topfront}, mentre negli altri moduli esso è definito e si può usare tranquillamente anche per la monografia. +\item Il comando \cs{titolo} non è disponibile per la monografia nel modulo di default \pack{topfront}, mentre negli altri moduli esso è definito e si può usare tranquillamente anche per la monografia. % -\item Il comando \cs{titolo} accetta un argomento facoltativo, la versione breve del titolo del frontespizio; serve con \chiave{stile}{classica} e l'opzione \opt{autoretitolo}, perché il titolo breve appaia nella testatina delle pagine di sinistra; se il titolo del frontespizio fosse troppo lungo la testatina verrebbe molto, molto male! +\item Il comando \cs{titolo} accetta un argomento facoltativo, la versione breve del titolo del frontespizio; serve con \chiave{stile}{classica} e l'opzione \opt{autoretitolo}, perché il titolo breve appaia nella testatina delle pagine di sinistra; se il titolo del frontespizio fosse troppo lungo la testatina verrebbe molto, molto male! % \item Se non si danno i comandi \cs{relatore}, \cs{secondorelatore} e \cs{terzorelatore} non viene scritto nulla nel frontespizio che riguardi questi ruoli; di solito né per la dissertazione di dottorato né per la monografia si hanno le figure dei relatori, ma “di solito” non vuol dire né “sempre” né “mai”. @@ -3605,15 +3624,13 @@ Per quanto riguarda i loghi, essi implicano l'uso del pacchetto \pack{graphicx}, \textcolor{red}{Per i formati dei file grafici da includere, le versioni recenti di \pdfLaTeX, di \XeLaTeX e di \LuaLaTeX accettano i formati PDF, PNG, JPG, MPS, EPS. La cosa è scritta a chiare lettere nella guida \file{grfguide.pdf} (già presente nella propria installazione del sistema \TeX aggiornata e completa), ma è un fatto che viene dimenticato troppo spesso e che obbliga a cercare aiuto da chi ne sa di più, compagni o professori, ma che anche loro talvolta dimenticano.} -\textcolor{red}{Esistono programmi per passare da un formato all'altro, ma anche disponendo di quei programmi e conoscendo i vantaggi e gli svantaggi di un formato rispetto ad un altro, questa operazione viene dimenticata troppo spesso, perché troppo spesso ci si dimentica di queste limitazioni sui formati.} +\textcolor{red}{Esistono programmi per passare da un formato di immagine all'altro, ma anche disponendo di quei programmi e conoscendo i vantaggi e gli svantaggi di un formato rispetto ad un altro, questa operazione viene dimenticata troppo spesso, perché troppo spesso ci si dimentica di queste limitazioni sui formati.} Per questo io preferisco usare sempre e solamente i compilatori \pdfLaTeX, \XeLaTeX\ o \LuaLaTeX. L'unico inconveniente è che non posso usare direttamente il pacchetto \pack{PSTricks}; ma finora me la sono cavata molto bene anche senza fruire delle prestazioni di questo bellissimo pacchetto. D'altra parte esistono pacchetti che consentono di usare \pack{PSTricks} anche con \pdfLaTeX e gli altri programmi; l'operazione diventa un po' più complicata ma se ne occupa direttamente il programma di tipocomposizione usato; l'utente deve solo caricare uno di quei pacchetti e seguirne le indicazioni specificate nella documentazione (vedi per esempio il pacchetto \pack{pdftricks} già presente in ogni installazione aggiornata e completa di \TeXLive; documentazione: \texttt{texdoc pdftricks}). -%\goodpagebreak - \section{Altri comandi} -La classe \class{toptesi} richiede l'uso di altri comandi; con i suoi moduli specializzati compone i frontespizi con ambienti adatti allo scopo; con il suo modulo di default \pack{topfront} ci sono diversi ambienti e programmi per comporre i vari frontespizi dei diversi tipi di tesi. Diciamo che questo modulo di default andrebbe usato il meno possibile perché è conservato per retrocompatibilità e come fallback quando non si usano correttamente le opzioni relative alla chiave \chiave{tipotesi} +La classe \class{toptesi} richiede l'uso di altri comandi; con i suoi moduli specializzati compone i frontespizi con ambienti adatti allo scopo; con il suo modulo di default \pack{topfront} ci sono diversi ambienti e comandi per comporre i vari frontespizi dei diversi tipi di tesi. Diciamo che questo modulo di default andrebbe usato il meno possibile perché è conservato per retrocompatibilità e come rimedio quando non si usano correttamente le opzioni relative alla chiave \chiave{tipotesi} Tuttavia se si è costretti ad usare quei comandi o quegli ambienti, quando è in vigore il modulo di default \pack{topfront}, si usi solo l'ambiente \amb{frontespizio}, con o senza asterisco integrato nel nome, inserendo i dati relativi al frontespizio all'interno dell'ambiente. @@ -4049,12 +4066,12 @@ Comando &sigla& Default & Scopo & Esempio d'uso \\ \section{ ScuDo title page commands}\label{sec:frontescudo} -The \file{toptesi-scudo.sty} module contains all the necessary definitions to typeset the thesis title page. Some of the commands just set the “fixed” parts of the title page; other are used to enter the variable parts, i.e. pieces of information such as the thesis author, title, defence date, and the like. All parts, fixed or variable, have specific default values. Here we describe the two sets of the user commands: the most important and compulsory variant data, and the customisation of “fixed” data. +The \file{toptesi-scudo.sty} module contains all the necessary definitions to typeset the thesis title page. Some of the commands just set the “fixed” parts of the title page; other ones are used to enter the variable parts, i.e. pieces of information such as the thesis author, title, defence date, and the like. All parts, fixed or variable, have specific default values. Here we describe the two sets of the user commands: the most important and compulsory variant data, and the customisation of “fixed” data. \subsection{Variant data} All commands to insert variant data accept one mandatory argument. The expression “Default empty” implies that, if the command is not used, its default value, an empty string, is assumed; in some cases this string is tested for emptiness and specific actions may be taken as specified below. \begin{description}[noitemsep] -\def\Item[#1]{\item[\normalfont\cs{#1}]} +\def\Item[#1]{\item[\cs{#1}]} % \Item[Cyclenumber] Defines a string that represents the ordinal number of the cycle program. This number may be written in a variety of ways, from “29\ap{th}”, to “29.th”; from “Twenty\-ninth”, to “XXIX”. If the ordinal number string is not specified, its label “cycle” is omitted. % @@ -4089,7 +4106,7 @@ Default empty. \Item[ExaminationDate] Defines the full date of the examination: “\meta{location}, \meta{day} of \meta{month} \meta{year}” in European style; “\meta{location}, \meta{month} \meta{day} \meta{year}” in USA style. Default empty. Example in both styles: \begin{verbatim} \ExaminationDate{Turin, 29 of February 2345}% EU -\ExaminationDate{Turin, February 29 2345}% USA +\ExaminationDate{Turin, February 29 2345}% USA \end{verbatim} % \end{description} @@ -4099,13 +4116,13 @@ Default empty. Most of the fixed data have a default value consisting in a character-string. \begin{description}[noitemsep] -\def\Item[#1]{\item[\normalfont\cs{#1}]} +\def\Item[#1]{\item[\cs{#1}]} % \Item[PhDschoolLogo] Specifies the name of the file that contains the School Logo. Default none; the file extension may be omitted, but the real extension should be one of \file{.pdf}, \file{.eps}, \file{.png}, \file{.jpg}. Actually this command accepts a list of comma separated names of Doctoral School logos, even if they are under control of the ScuDo school. We refer to the partnerships that ScuDo has with Università di Torino and with Istituto Nazionale di Ricerca Metrologica (INRiM). When a doctoral thesis is supported by INRiM or is a joint Doctoral Thesis with the University of Turin, their logos are supposed to be set in the title page; such logos, as well as the ScuDo one, are available from the Students Office or may be downloaded from a specific reserved Web site. -Please, take notice that ScuDo has available four different logos (to be asked for at the Student Office); the four variants of the school logo are: $(a)$ \texttt{Logo-ScuDo.pdf} (a black and white logo without any decoration at its sides; may be it is an old school logo); $(b)$ \texttt{Logo-ScuDo-RGB.pdf} (an inverted color logo with decoration at its right, with white and yellow inscriptions over a blue background); $(c)$ \texttt{Logo-ScuDo-BN-RGB\discretionary{}{.}{.}pdf} (a black and white logo with decorations at its right; a new logo, the one you probably should use); $(d)$ \texttt{Logo-ScuDo-blu-RGB\discretionary{}{.}{.}pdf} (a blue on white logo with decorations at its right; the blue tint is the official blue required by most official documents of Politecnico di Torino). This bundle TOPtesi does not contain any real logo, because these trademarked images are property of the respective entities, and cannot be freely distributed under the permissive LPPL licence common to most of \TeX-system software, see page~\pageref{ch:LPPL}. +Please, take notice that ScuDo has available four different logos (to be asked for at the Student Office); the four variants of the school logo are: $(a)$ \texttt{Logo-ScuDo.pdf} (a black and white logo without any decoration at its sides; may be it is an old school logo); $(b)$ \texttt{Logo-ScuDo-RGB.pdf} (an inverted color logo with decoration at its right, with white and yellow inscriptions over a blue background); $(c)$ \texttt{Logo-ScuDo-BN-RGB\discretionary{}{.}{.}pdf} (a black and white logo with decorations at its right; a new logo, the one you probably should use); $(d)$ \texttt{Logo-ScuDo-blu-RGB\discretionary{}{.}{.}pdf} (a blue on white logo with decorations at its right; the blue tint is the official blue required by most official documents of Politecnico di Torino). This bundle \TOPtesi does not contain any real logo, because these trademarked images are property of the respective entities, and cannot be freely distributed under the permissive LPPL licence common to most of \TeX-system software, see page~\pageref{ch:LPPL}. -The last three logos were provided by the specific office of Politecnico di Torino in EPS format and CMYK color profile; very large files due to the verbosity of the PostScript commands and to the fact that such files contained both the EPS code and the compressed bitmapped image. By using the \prog{Inkscape} program as described in the English documentation \file{toptesi.pdf}, these PDF/A incompatible images were converted to pure EPS code and RGB profile; they were further processed to transform them in PDF/A compliant format. Hopefully these transformations should be much handier than the original images. In any case, remember that these four logos are not part of this bundle, but you have to ask the school Student Office in order to receive the logo file directly or the authorisation to download it from a reserved Web site. +The last three logos were provided by the specific office of Politecnico di Torino in EPS format and CMYK color profile; very large files due to the verbosity of the PostScript commands and to the fact that such files contained both the EPS code and the compressed bitmapped image. By using the \prog{Inkscape} program as described in the English documentation \file{toptesi.pdf}, these PDF/A incompatible images were converted to pure EPS code and RGB profile; they were further processed to transform them in PDF/A compliant format. Hopefully these transformations should be much handier than the original images. In any case, remember that these four processed PDF logos are not part of this bundle, but you have to ask the school Student Office in order to receive the logo file directly or the authorisation to download it from a reserved Web site. % \Item[Ndissertation] Specifies the name of the dissertation. Default “Doctoral Disseration”. % @@ -4113,16 +4130,16 @@ The last three logos were provided by the specific office of Politecnico di Tori % \Item[Nsupervisor] Specifies through two separate arguments the singular and the plural name to label the supervisor list. Default “Supervisor” and “Supervisors”. % -\Item[SupervisorNumber] Specifies the number of supervisors with three alternatives. With the default “0” (zero) value or an empty argument no label is set above the list of supervisors; the real turning point is the value “1” when the singular label is used; any other value greater than “1”, is treated as “many” and implies the plural label.%%%%!!! +\Item[SupervisorNumber] Specifies the number of supervisors with three alternatives. With the default “0” (zero) value or an empty argument no label is set above the list of supervisors; the real turning point is the value “1” when the singular label is used; any other value greater than “1”, is treated as “many” and implies the plural label. % \Item[Nexaminationcommittee] Specifies the label to print above the list of examiners. Default “Doctoral Examination Committee”. % -\Item[Nlocation] Specifies the full official name of the institution where the doctoral examination is going to be held. Default “Politecnico di Torino”. This suffices for the ScuDo dissertation, but for other doctoral schools it might be necessary to specify also the city, the province"/state and sometimes the nation. +\Item[Nlocation] Specifies the full official name of the institution where the doctoral examination is going to be held. Default “Politecnico di Torino”. This suffices for the ScuDo dissertation, but for other doctoral schools it might be necessary to specify also the city, the province"/state and sometimes the country. % -\Item[Property] Specifies the claim for the intellectual property of the Ph.D.\ dissertation contents. Default “This thesis is licensed under a Creative Commons License, Attribution - Noncommercial- NoDerivative Works - 4.0 International: see \begin{center}\url{www.creativecommons.org}.\end{center} -The text may be reproduced for non-commercial purposes, provided that credit is given to the original author.” +\Item[Property] Specifies the claim for the intellectual property of the Ph.D.\ dissertation contents. Default: \begin{quote}This thesis is licensed under a Creative Commons License, Attribution - Noncommercial- NoDerivative Works - 4.0 International: see \begin{center}\url{www.creativecommons.org}.\end{center} +The text may be reproduced for non-commercial purposes, provided that credit is given to the original author.\end{quote} % -\Item[Disclaimer] Specifies the text of the disclaimer statement. Default: “\cs{noindent} I hereby declare that the contents and organisation of this dissertation constitute my own original work and do not compromise in any way the rights of third parties, including those relating to the security of personal data.” +\Item[Disclaimer] Specifies the text of the disclaimer statement. Default: \begin{quote}I hereby declare that the contents and organisation of this dissertation constitute my own original work and do not compromise in any way the rights of third parties, including those relating to the security of personal data.\end{quote} % \Item[Signature] Specifies the signature field with a dotted line to hand-sign the statement, the signer's name, the place of signature and the signature date. The signer's name defaults to the author's name, and the date defaults to the examination date. This latter default perhaps should be modified. In any case the command definition provides a default layout as such: \begin{verbatim} @@ -4170,20 +4187,20 @@ An example title page is shown in figure~\ref{fig:frontescudo} on page~\pageref{ Le personalizzazioni, diverse da quelle già previste da questo insieme di file di \TOPtesi, sono vivamente scoraggiate. Ci si ricordi che lo stile tipografico, sia la geometria della pagina, sia lo stile scelto per la maggior parte dei caratteri usati, sono i risultati precisi di accordi fatti con gli organi competenti di diverse università. Modificare queste cose vuol dire non rispettare le norme emesse da quegli organi competenti: segreterie studenti degli atenei o delle facoltà, dei corsi di studi, delle scuole, eccetera. -Tuttavia, di principio per TOPtesi le modifiche non sono vietate, ma sono solo scoraggiate. +Tuttavia, di principio per \TOPtesi le modifiche non sono vietate, ma sono solo scoraggiate. La licenza LPPL della pagina~\pageref{ch:LPPL} è molto permissiva, ma pone alcuni limiti. Quello più importante è che i file originali non possono essere modificati, ma non è vietato modificarne delle copie a cui sia stato cambiato il nome e dalle quali sia stato eliminato il nome della persona che esegue la manutenzione degli originali; questo nome deve essere sostituito con quello della persona che ne esegue qualsiasi modifica, pur lasciando la stessa indicazione di licenza e la paternità dell'autore originale. In questo modo chiunque usi la versione modificata sa a chi rivolgersi perché l'autore originale non è più responsabile “dell'assistenza” agli utenti. Siccome \TOPtesi è modulare e i suoi vari moduli sono richiamati in cascata, questo significa che bisogna cambiare nome e commenti iniziali all'indietro fino al file di classe; in pratica di tutti i file di cui è composto \TOPtesi. L'operazione è abbastanza delicata, perché non bisogna dimenticare le necessarie modifiche a tutti i file della catena; tuttavia, una volta eseguita questa operazione, si ha la massima libertà di modificare qualsiasi cosa senza violare nessuna licenza. -Siccome è già successo che qualcuno mi chiedesse assistenza attraverso il Forum del \GuIT, mentre stava lavorando su una versione obsoleta e forse modificata da chissà chi, abbiamo avuto una serie di dialoghi “fra sordi”, perché io non riuscivo a replicare gli inconvenienti che quella persona lamentava; ci abbiamo messo almeno tre giorni attraverso i messaggi del forum per arrivare a scoprire che gli inconvenienti lamentati erano il frutto dell'uso di una versione obsoleta (forse anche modificata senza rispettare i vincoli suddetti). Ci saremmo risparmiati le incomprensioni generate dal fatto che stavamo parlando di due cose diverse che però avevano lo stesso nome. Ora l'inconveniente non dovrebbe presentarsi più, perché la classe esegue un controllo sulle versioni dei pacchetti usati e se non fossero conformi interromperebbe immediatamente la compilazione emettendo un messaggio molto evidente cosicché l'utente sarebbe costretto a verificare lo stato dei suoi file. +Siccome è già successo che qualcuno mi chiedesse assistenza attraverso il Forum del \GuIT, mentre stava lavorando su una versione obsoleta e forse modificata da chissà chi, abbiamo avuto una serie di dialoghi “fra sordi”, perché io non riuscivo a replicare gli inconvenienti che quella persona lamentava; ci abbiamo messo almeno tre giorni attraverso i messaggi del forum per arrivare a scoprire che gli inconvenienti lamentati erano il frutto dell'uso di una versione obsoleta (forse anche modificata senza rispettare i vincoli suddetti). Ci saremmo risparmiati le incomprensioni generate dal fatto che stavamo parlando di due cose diverse che però avevano lo stesso nome. Ora l'inconvenien"te non dovrebbe presentarsi più, perché la classe esegue un controllo sulle versioni dei pacchetti usati e se non fossero conformi interromperebbe immediatamente la compila"zio"ne emettendo un messaggio molto evidente cosicché l'utente sarebbe costretto a verificare lo stato dei suoi file. Secondo me ci sono altri due modi per eseguire certe personalizzazioni senza violare la licenza pur mantenendo invariati i file originali. \begin{enumerate}[noitemsep] \item Un primo metodo consiste nel crearsi un file di macro personali, dove inserire tutto o quasi tutto quanto generalmente si mette nel preambolo del proprio documento; anche senza modificare nulla, questo semplice fatto svuota il preambolo lasciando più facilmente leggibile il file sorgente della tesi o di qualsiasi altro documento. -In ogni caso in questo file si possono copiare le definizioni dei comandi o degli ambienti di \TOPtesi che si vogliono modificare; questi comandi e questi ambienti possono venire modificati, ricordando di usare \cs{renewcommand} al posto di \cs{newcommand} e \cs{renewenvironment} al posto di \cs{newenvironment} e apportando tutte le modifiche che si vogliono al testo sostitutivo di quei comandi e di quegli ambienti. Ovviamente bisogna conoscere il linguaggio \LaTeX sufficientemente a fondo per fare una operazione del genere, ma spesso le modifiche desiderate sono piuttosto semplici e quindi, se è così, l'operazione non è difficile. +{\tolerance=3000 In ogni caso in questo file si possono copiare le definizioni dei comandi o degli ambienti di \TOPtesi che si vogliono modificare; questi comandi e questi ambienti possono venire modificati, ricordando di usare \cs{renewcommand} al posto di \cs{newcommand} e \cs{renewenvironment} al posto di \cs{newenvironment} e apportando tutte le modifiche che si vogliono al testo sostitutivo di quei comandi e di quegli ambienti. Ovviamente bisogna conoscere il linguaggio \LaTeX sufficientemente a fondo per fare una operazione del genere, ma spesso le modifiche desiderate sono piuttosto semplici e quindi, se è così, l'operazione non è difficile.\par} Tuttavia c'è un problema: molti moduli di \TOPtesi vengono letti solo durante l'esecuzione dell'istruzione \Bambiente{document}, quindi il file di macro personali non può venire letto durante l'elaborazione del preambolo; dimenticarsi di questo fatto vuol dire ricevere una quantità di messaggi d'errore di difficile interpretazione per molti utenti. @@ -4195,7 +4212,7 @@ La cosa migliore da fare, quindi, è quella di inserire il file delle macro pers il comando \cs{input}, assolutamente non con il comando \cs{include} e meno che mai con il comando \cs{usepackage}; meglio ancora: si può mettere tutto nel preambolo ma inserendo \cs{input} col suo argomento - in quello del comando \cs{AfterEndPreamble}, già disponibile, visto + in quello di \cs{AfterEndPreamble}, già disponibile, visto che la classe già carica il pacchetto \pack{etoolbox}; \item il file deve cominciare con il comando \cs{makeatletter} @@ -4208,7 +4225,7 @@ In questo modo i file originali di \TOPtesi restano immutati e le modifiche rigu \item Un altro modo consiste nell'uso dele funzionalità dei comandi definiti nel pacchetto \pack{etoolbox}; questi comandi permettono di “rattoppare” (traduzione letterale di \emph{to patch}), cioè di modificare comandi esistenti e, con una buona conoscenza del funzionamento interno di \LaTeX, anche degli ambienti. Il lettore si riferisca alla documentazione di \pack{etoolbox} per maggiori dettagli. Qui accenno solo al fatto che il comando di \pack{etoolbox} \cs{pretocmd} permette di aggiungere codice all'inizio del testo sostitutivo della definizione di una macro; \cs{addtocmd} permette di aggiungere codice in coda al testo sostitutivo; e \cs{patchcmd} permette di cercare una data stringa nel testo sostitutivo di un comando e di sostituirla con un'altra stringa. Ricordo che “testo sostitutivo” in questo contesto indica tutto quello che costituisce la definizione di una macro, quindi in generale non è “testo” nel senso stretto della parola, ma quasi sempre è solo codice in linguaggio \LaTeX o in linguaggio nativo \TeX. -Non nascondo che questo secondo metodo è molto più elegante del primo, ma richiede conoscenze approfondite del linguaggio \LaTeX e \TeX, quindi lo segnalo solo per utenti esperti. +Non nascondo che questo secondo metodo è molto più elegante del primo, ma richiede conoscenze approfondite del linguaggio \LaTeX e \TeX, quindi lo raccomando solo agli utenti esperti. \item {\tolerance=3000 Spesso le modifiche desiderate sono già previste da altri pacchetti; per essere sicuri che questi pacchetti siano caricati al momento giusto è meglio invocarli con \cs{usepackage}, inserendo il comando e il suo argomento dentro quello di \cs{AfterPreamble}.\par} @@ -4231,7 +4248,7 @@ Da un lato alcuni utenti devono adattarsi a quello che è disponibile, magari da Il modo di localizzare le stringhe fisse dovrebbe risultare semplificato rispetto alle versioni fino alla 5.x.xx di \TOPtesi, grazie ai moduli separati per i vari tipi di tesi; ogni frontespizio richiede un numero ristretto di stringhe fisse rispetto al caso generale; quindi il lavoro di localizzazione riguarda, a seconda delle tesi, fino a una dozzina di parole o di locuzioni nominali. \textcolor{red}{% -\english For the ScuDo doctoral school some packages are preloaded in addition to those already loaded by the \TOPtesi bundle. The title page for this doctoral school is obtained with its own commands and environment. The appearance of this title page was shown in figure~\ref{fig:frontescudo} on page~\pageref{fig:frontescudo}, and the general instructions for this title page are given in section~\ref{sec:frontescudo}. Doctoral students benefit from examining the source file \file{toptesi-scudo-example.tex} (already part of this bundle) where many details are added for using this particular variant.} +\english For the ScuDo doctoral school some packages are preloaded in addition to those already loaded by the \TOPtesi bundle. The title page for this doctoral school is obtained with its own commands and environments. The appearance of this title page was shown in figure~\ref{fig:frontescudo} on page~\pageref{fig:frontescudo}, and the general instructions for this title page are given in section~\ref{sec:frontescudo}. Doctoral students benefit from examining the source file \file{toptesi-scudo-example.tex} (already part of this bundle) where many details are added for using this particular variant.} Il pacchetto \textsf{TOPtesi} carica di default sia \texttt{babel} o \texttt{polyglossia} sia \texttt{graphicx}; certo potrebbe caricare di default anche \texttt{amsmath} e i suoi compagni, ma non tutti hanno bisogno di scrivere e comporre matematica avanzata e se non vengono usati essi comportano uno risparmio di memoria e un sia pur piccolo miglioramento nella velocità di esecuzione. Ritengo quindi che sia meglio che ognuno si carichi i pacchetti che intende davvero usare. @@ -4239,13 +4256,13 @@ Il pacchetto \textsf{TOPtesi} carica di default sia \texttt{babel} o \texttt{pol Consiglierei l'uso di \XeLaTeX o \LuaLaTeX solo per quelle tesi, specialmente di carattere umanistico, che hanno bisogno di maneggiare agevolmente font di diversi tipi per scrivere con alfabeti o sillabari o sistemi di ideogrammi per i quali \pdfLaTeX\ è, sì, attrezzato, ma rende molto più faticosa l'intera operazione. -È molto interessante il programma di composizione \LuaLaTeX, che incorpora una buona parte del linguaggio di scripting Lua; questo a sua volta permette di compiere diverse azioni esternamente al programma di tipocomposizione (mi risulta che sia usato per impostazione predefinita per comporre la musica gregoriana con il pacchetto \pack{GregorioTeX}); in certi casi esso si può considerare una estensione molto utile del programma \pdfLaTeX. Benché questo programma possa usare la microtipografia come \pdfLaTeX\ e i font OpenType come \XeLaTeX, vale la pena di usarlo al posto di quest'ultimo, se non altro perché ne è un superset che riesce a fare altre cose oltre quelle che \XeLaTeX\ è in grado di fare; in particolare può produrre file archiviabili secondo le norme ISO senza bisogno di nessun tipo di post"processing. +È molto interessante il programma di composizione \LuaLaTeX, che incorpora una buona parte del linguaggio di scripting Lua; questo a sua volta permette di compiere diverse azioni esternamente al programma di tipocomposizione (mi risulta che sia usato per impostazione predefinita per comporre la musica gregoriana con il pacchetto \pack{GregorioTeX}); in certi casi esso si può considerare una estensione molto utile del program"ma \pdfLaTeX. Benché questo programma possa usare la microtipografia come \pdfLaTeX\ e i font OpenType come \XeLaTeX, vale la pena di usarlo al posto di quest'ultimo, se non altro perché ne è un superset che riesce a fare altre cose oltre quelle che \XeLaTeX\ è in grado di fare; in particolare può produrre file archiviabili secondo le norme ISO senza bisogno di nessun tipo di post"processing. So per certo che le tesi di filologia classica possono essere composte molto bene con \pdfLaTeX\ e \textsf{TOPtesi}; se bisogna usare una buona dose di lingua greca classica è conveniente caricare il pacchetto \pack{teubner}\footnote{A tutt'oggi (\the\year) il pacchetto \pack{teubner} funziona correttamente solo con \pdfLaTeX.}; gli intenditori sanno perfettamente che i font greci della casa editrice Teubner di Lipsia sono fra i più gradevoli che esistano; il pacchetto \texttt{teubner} fa uso di un'ottima imitazione di quei font e mette a disposizione una miriade di comandi per comporre quei segni “strani” che i filologi usano per scrivere le loro opere. Per le edizioni critiche esistono i pacchetti \texttt{eledmac} e \pack{reledmac}; io non li ho mai usati, ma sembra che siano di grande aiuto per gli umanisti. -Per gli scienziati e i tecnologi esistono troppi pacchetti specializzati e sarebbe impossibile, e forse inutile, elencarli tutti o anche elencare solo i più importanti. +Per gli scienziati e i tecnologi esistono troppi pacchetti specializzati e sarebbe impossi"bile, e forse inutile, elencarli tutti o anche elencare solo i più importanti. Non resta che augurare: \begin {center}\cambiacorpo{16}\bfseries @@ -4258,10 +4275,7 @@ Happy \TeX{ing} with \pdfLaTeX, or \LuaLaTeX, or~\XeLaTeX! \end{center} \english\newpage -%\appendix -%\input{LPPL} \phantomsection -%\addcontentsline{toc}{chapter}{The \LaTeX Project Public License} \input{lppl-1.3}% il label ch:LPPL è già definito nel file lppl-1.3.tex \italiano diff --git a/macros/latex/contrib/toptesi/toptesi.dtx b/macros/latex/contrib/toptesi/toptesi.dtx index ef86c19b16..843f5659b1 100644 --- a/macros/latex/contrib/toptesi/toptesi.dtx +++ b/macros/latex/contrib/toptesi/toptesi.dtx @@ -142,7 +142,7 @@ School of Turin. %<topmag>\ProvidesPackage{toptesi-magistrale}[% %<topdoc>\ProvidesPackage{toptesi-dottorale}[% %<*driver,class,topsty,topcmn,topfrn,topscu,topmon,topsss,topmag,topdoc> -2019-07-26 v.6.3.06 +2020-05-12 v.6.4.02 %<class>Class for typesetting university theses] %<topsty>Extension for toptesi.cls] %<topcmn>Additional commands for the TOPtesi bundle] @@ -168,10 +168,12 @@ School of Turin. xparse,curve2e,etoolbox,textcomp} \let\originalmeta\meta \renewcommand\meta[1]{{\normalfont\originalmeta{#1}}} +\providecommand\cs{} +\def\cs#1{\textnormal{\ttfamily\char92 #1}} \def\prog#1{\textsf{#1}} \def\pack#1{\textsf{\slshape#1}} \def\env#1{\textit{#1}}\let\amb\env -\def\file#1{\texttt{#1}} +\def\file#1{\texttt{#1}}\let\class\file \def\marg#1{{\normalfont\texttt{\{}\meta{#1}\texttt{\}}}} \def\Marg#1{{\texttt{\{#1\}}}} \def\opz#1{{\normalfont\textsl{#1}}} @@ -256,7 +258,7 @@ School of Turin. %</driver> % \fi % -% \CheckSum{7660} +% \CheckSum{7981} % % \begin{abstract} % This file describes the TOPtesi bundle; it consists of a set of files @@ -272,7 +274,7 @@ School of Turin. % files has the ambition to be suited for typesetting theses in % any university in the world\dots\ This ambition can't be % fulfilled, though, because of the complexity of the title -% page (and possibly of the legal page) requirements. This +% page (and possibly of the copyright page) requirements. This % version is compliant with the \XeLaTeX\ and the \LuaLaTeX\ % programs. Up to now the few conflicts that have % been spotted have been solved with suitable corrections or @@ -307,7 +309,8 @@ School of Turin. % Public Licence (LPPL) which is appended to the Italian documentation % file \texttt{toptesi-it.pdf} included in this bundle; personal % customisation of parts of this bundle are discouraged but are -% permitted only in conformance with the LPPL. See also section~\ref{sec:LPPL}.} +% permitted only in conformance with the LPPL. See also +% section~\ref{sec:LPPL} in this document.} % \end{abstract} % % \section{History} @@ -472,7 +475,7 @@ School of Turin. % the |pdfpages| package), or even create his/her personal % title page by means of the standard |titlepage| environment. % -% All this implied the rewriting of both the English and +% All this implied rewriting both the English and % Italian documentation files; the user can find useful % information in the English file |toptesi.pdf| included % in the bundle; this file is pretty lengthy because it @@ -709,9 +712,10 @@ School of Turin. % specific options. % % \subsection{Class options} -% The class honors all the options accepted by the |report| +% The class accepts all the options valid for 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 % end of each chapter and the bibliography items are numbered with % a \emph{chapter.item} indication. This implies a manual build @@ -721,7 +725,7 @@ School of Turin. % complete \TeX\ system distribution and the facilities offered % 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. +% backwards compatibility, is \emph{strongly deprecated}. % % \Item[stile=classica] Specifies a general modification of certain % details that are supposed to be more adequate for theses in @@ -729,10 +733,11 @@ School of Turin. % 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 |dottorale| thesis option. +% with the |dottorale| thesis option. Some of the following options +% may be valid or may remain inactive when this thesis style is specified. % % \Item[cucitura=\meta{displacement}] In two sided printing -% it is better to move the typesetting grid towards the outer +% it might be necessary to move the typesetting grid towards the outer % edge so as to cope with the thesis binding that is generally % not made up by sewing together a number of signatures; the % default outer displacement is fixed to~7mm, but it can be @@ -788,12 +793,33 @@ School of Turin. % 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. +% still considered a touch of elegance. +% \Item[folioinhead] Folios by default are typeset at the center +% of the footer. With thei options they are placed in the margin, +% aligned with the header; thei feature has been requested in some +% universities, but admittedly is not particularly elegant; may be +% it can be used only when the header is centred in the measure, +% certainly not when is is moved to the outer side of the header. +% No particular functionality is provided to avoid this particular +% choice; it is up to the user to avoid this error. Ineffective is +% the |stile=classica| option is specified. +% +% \Item[nocenterhead] The header text is normally centred in the +% measure. If this option is specified, the header text is moved +% to the outer side. No option has been requested to move the header +% text towards the inner side; therefore do not look for any such +% keyword. Ineffective is the |stile=classica| option is specified. +% +% \Item[nocenterfolio] Normally the folio is typeset centred in the +% footer; by specifying the option the folio is flushed to the outer +% side of the footer. Ineffective is the |stile=classica| option is +% specified. These last three options comply with the |oneside| or +% |twoside| global class options. %\end{description} % % 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; +% there are some values that are particularly significant; % the key for all of them is |tipotesi| (\emph{thesis kind}); % the values are indicated hereafter. % @@ -844,6 +870,21 @@ School of Turin. % case, except for few additional packages, the body of the % TOPtesi functionality is maintained intact. % +%\Item[topotesi=frontespizio] By specifying this option the default +% module |topfront| to typeset the title page is not loaded; in its +% place the \pack{frontespizio} package is loaded, and the user can +% directly use this latter package commands. Of course the user must +% know pretty well ho this particular package works; if not s/he +% should reat its documentation. Notice: the documentation is written +% in Italian; probably its author assumed that it would be used only +% by Italian students; actually the author provided commands to +% customise the infix words in other languages. Again the author +% assumed that some Italian students had to typeset their theses in +% various languages; this is generally true for doctoral theses that +% are requested in English; but this is true also for Erasmus student +% who might need to write their theses in the language of the host +% universities. +% % \Item[tipotesi=custom] % is a very simple option: sets the various internal switches % so as not to load any internal module or external file. @@ -865,11 +906,11 @@ School of Turin. % 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 +% \item[Warning!] It goes without saying 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 +% some 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 thesis kinds they +% maintain the same commands, but in certain thesis types they % might behave differently than expected. % % The user therefore is strongly urged to consult the documentation @@ -880,10 +921,10 @@ School of Turin. % \end{description} % % \subsection{Title page commands} -% Note: Skip this section if you decide to load an external -% package, such as, for example, |frontespizio|, for typesetting the -% title~page. Notice also that if you want to load an external -% package for this task, you should load it \emph{after} +% Note: Skip this section if you decide to use external package +% |frontespizio|, or you selected the |tipotesi=custom| option for +% typesetting the title~page. Notice also that if you want to load +% an external package for this task, you should load it \emph{after} % specifying the input encoding you use for your text files.\bigskip % % \noindent The user must specify a certain number of commands @@ -896,14 +937,14 @@ School of Turin. % repeat his/her name, the name of the institution, and so on? % % Many user commands for the title page redefine default -% values or strings; they are particularly usefull when the thesis is +% values or strings; they are particularly useful 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, though, 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. @@ -930,8 +971,8 @@ School of Turin. % other ones use mostly the same commands for the same purposes. % % \begin{description}[noitemsep] -% \def\cs#1{\texttt{\char92#1}} -% \def\Item[#1]{\item[\normalfont\cs{#1}]} +%^^A \def\cs#1{\texttt{\char92#1}} +% \def\Item[#1]{\item[\cs{#1}]} %^^A % \item[\textnormal{\ttfamily frontespizio}] and % \texttt{frontespizio*} are two environments that typeset the @@ -948,29 +989,31 @@ School of Turin. % according to the actual status of the boolean |\topTPTlogos|; % the user, before issuing the |\frontespizio| command, may set % this boolean by means of the |\topTPTlogostrue| -% or |\topTPTlogosfalse|, or with either one of the commands +% or |\topTPTlogosfalse|, or with either one of the equivalent commands % |\booltrue{topTPTlogos}| and |\boolfalse{topTPTlogos}|.\par} % -% \Item[monografia] sets the bachelor's report style and retrieves -% its title; the command\cs{titolo} that is not available for this -% purpose with the standard module |TOPfront|, is available when +% \Item[monografia\marg{title}] sets the bachelor's report style and +% retrieves its title; the command\cs{titolo} that is not available for +% this purpose with the standard module |TOPfront|, is available when % the specific module has been loaded by means of the % \opz{monografia} or \opz{triennale} options. % -% \Item[titolo] gets the master or PhD thesis title and an -% optional thesis short title. -% -% \Item[sottotitolo] gets the thesis subtitle if any. +% \Item[titolo\oarg{shorttitle}\marg{title}] gets the master +% or PhD thesis title and an optional thesis short title. % -% \Item[materia] gets the name of the discipline the thesis deals with. +% \Item[sottotitolo\marg{subtitle}] gets the thesis subtitle if any. % -% \Item[Materia] alias for \cs{materia}. +% \Item[materia\marg{discipline}] or the alias +% \cs{Materia}\marg{discipline} get the name of the discipline the +% thesis deals with. % -% \Item[direttore] gets the name of the Doctoral School Director. +% \Item[direttore\marg{director's name}] gets the name of the +% Doctoral School Director. % -% \Item[coordinatore] gets the name of the Doctoral School -% Coordinator -% \Item[QualificaDirettore] gets the phrase that describes the +% \Item[coordinatore\marg{coordinator's name}] gets the name +% of the Doctoral School Coordinator +% \Item[QualificaDirettore\marg{director's function}] +% 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 @@ -981,30 +1024,36 @@ School of Turin. % in another language is required, this macro is % available for specifying such position. % -% \Item[relatore] gets the name of the thesis principal supervisor. +% \Item[relatore\marg{supervisor name}] gets the name of the +% thesis principal supervisor. % -% \Item[secondorelatore] gets the name of the second supervisor, -% if any. -% \Item[terzorelatore] gets the name of the third supervisor, +% \Item[secondorelatore\marg{second supervisor's name}] gets the name +% of the second supervisor if any. +% \Item[terzorelatore\marg{third supervisor's name}] +% gets the name of the third supervisor, % if any; it is assumed that the number of % supervisors never exceeds three; in case follow % one of the tricks exemplified % in the example file \file{toptesi-example.tex} in % order to manage such situation. -% \Item[tutore] gets the name of the doctorate tutor; there is no +% \Item[tutore\marg{tutor's name}] +% 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 % person's name. -% \Item[TutorName] gets the phrase that describes the tutor +% \Item[TutorName\marg{tutor's position}] +% gets the phrase that describes the tutor % position, possibly in a different language. -% \Item[AdvisorName] gets the string that qualifies the +% \Item[AdvisorName\marg{supervisors' formal title}] +% gets the string that qualifies the % supervisor(s); the default string % is “Relatore:” or “Relatori:” for the plural; % in another language this command is used to % define the string, say, “Supervisors:” if the % thesis has been supervised by more than one % person. -% \Item[CoAdvisorName] gets the string that qualifies the +% \Item[CoAdvisorName\marg{co-supervisors' formal title}] +% gets the string that qualifies the % co-supervisor(s); the default string is % “Correlatore:” or “Correlatori:” in the % plural; this command may be used to define the @@ -1013,12 +1062,18 @@ School of Turin. % for setting an Italian singular name when the % tricks exemplified in file % \file{toptesi-example.tex} are used. -% \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; +% \Item[candidato\marg{candidate' name (man)}] +% gets the name and surname of an author (M). +% \Item[candidata\marg{candate's name (woman))}] +% gets the name and surname name of an author (W). +% \Item[secondocandidato\marg{second candidate's name (man)}] +% gets the name and surname of the second M author. +% \Item[secondacandidata\meta{second candidate's name (woman)}] +% gets the name and surname of the second W author. +% \Item[terzocandidato\marg{third candidate's name (man)}] +% gets the name and surname of the third M author. +% \Item[terzacandidata\marg{third candidate's name ()woman}] +% gets the name and surname of the third W 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 @@ -1029,7 +1084,8 @@ School of Turin. % For different languages there might be no % difference in gender but there is a difference % in plural. -% \Item[CandidateName] gets the string that describes the student +% \Item[CandidateName\marg{candate's status}] +% 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 @@ -1038,51 +1094,63 @@ School of Turin. % “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 +% \Item[sedutadilaurea\marg{thsis defense date}] +% gets the date of the final exam, or % presentation, or defence of the thesis; if this % date is omitted the default date is the current % month and year in the current language (generally -% Itallian). -% \Item[esamedidottorato] an alias for \cs{sedutadilaurea} to be used +% Italian). +% \Item[esamedidottorato\marg{Ph.D. defense date}] +% an alias for \cs{sedutadilaurea} to be used % for doctoral dissertations. -% \Item[ciclodidottorato] gets the roman numeral that specifies +% \Item[ciclodidottorato\marg{cycle}] +% gets the ordinal numeral that specifies % the doctoral cycle. -% \Item[CycleName] redefines the string that expresses the name of +% \Item[CycleName\marg{cycle name}] +% redefines the string that expresses the name of % 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; +% \Item[corsodilaurea\marg{degree course proper name}] +% 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”. -% \Item[CorsoDiLaureaIn] gets the generic name of the degree course, +% “Electrical Engineering”. +% \Item[CorsoDiLaureaIn\marg{degree course generic name}] +% gets the generic name of the degree course, % for example “Bachelor Degree in”. -% \Item[TesiDiLaurea] gets the generic phrase that describes the +% \Item[TesiDiLaurea\marg{thesis generic name}] +% gets the generic phrase that describes the % 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 -% it might be called +% \Item[NomeMonografia\marg{bachelor's report name}] +% gets the phrase that describes the +% bachelor's final report; by default this +% package sets it tois “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”. -% \Item[InName] infix strings often require adjusting of the -% prepositions; this macro gets the preposition +% \Item[NomeDissertazione\marg{Ph.D. thesis name}] +% gets the phrase that describes the +% doctoral thesis; by default this package sets it to +% “Tesi di Dottorato”. +% \Item[InName\marg{‘in’ name}] +% infix strings often require that their prepositions +% are adjusted the; this macro gets the preposition % that stands for “in” (the default). In German % it might become “auf”. -% \Item[NomeAnnoAccademico] defines the infix string that stands for +% \Item[NomeAnnoAccademico\marg{academic year name}] +% defines the infix string that stands for % “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 % without the \opz{classica} option you can use % any string in the field of \cs{sedutadilaurea}. -% \Item[logosede] specifies the name of the file or the files that +% \Item[logosede\marg{logo file name}] +% specifies the name of the file or the files that % contain the university logos; no default is % defined; rather a warning message is issued if % no name is given or the file is missing, but @@ -1094,7 +1162,8 @@ School of Turin. % 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 +% \Item[setbindingcorrection\marg{binding correction}] +% sets up the length to displace the text % block to the external margin so as to have a % wider internal margin to accommodate the binding % correction. Its argument is not optional and is @@ -1102,7 +1171,8 @@ School of Turin. % Notice that 7\,mm is already a large % displacement; most often than not the binding % correction is unnecessary. -% \Item[retrofrontespizio] with its argument, made up of one or more +% \Item[retrofrontespizio\marg{copyright page text}] +% 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 @@ -1137,8 +1207,7 @@ School of Turin. % use of a specific environment within which the following % commands are available to set up the necessary information. % \begin{description}[noitemsep] -% \def\cs#1{\texttt{\char92#1}} -% \def\Item[#1]{\item[\normalfont\cs{#1}]} +% \def\Item[#1]{\item[\cs{#1}]} % % \item[\normalfont\ttfamily ThesisTitlePage] is the environment % within which the title page data are specified; some data are @@ -1152,11 +1221,10 @@ School of Turin. % 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 +% \Item[PhDschoolLogo\meta{logo file name}] (preset: Logo-Scudo) +% selects an image specified with \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 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}, @@ -1164,48 +1232,48 @@ School of Turin. % 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 +% \Item[Ndissertation\marg{dissertation name}] (preset: Doctoral % Dissertation) specifies the specific name of the document. % -% \Item[Ndoctoralprogram]\marg{doctoral program} (preset: Doctoral +% \Item[Ndoctoralprogram\marg{doctoral program}] (preset: Doctoral % Program in) specifies the degree course name prefix. % -% \Item[ProgramName]\marg{program name} (mandatory: preset empty) +% \Item[ProgramName\marg{program name}] (mandatory: preset empty) % specifies the degree course name. % -% \Item[CycleNumber]\meta{ordinal number} (optional; preset +% \Item[CycleNumber\oarg{ordinal number}] (optional; preset % empty) specifies the ordinal number of the program cycle; at % ScuDo it is a mandatory information. In other doctoral schools % it might be useless. % -% \Item[title]\marg{dissertation title} (preset empty) sets the +% \Item[title\marg{dissertation title}] (preset empty) sets the % specific title of the dissertation; it is better to keep it % short, and use the sub title to add further titling information. % -% \Item[subtitle]\marg{dissertation subtitle} (optional: preset -% empty) adds a possible subtitle. +% \Item[subtitle\marg{dissertation subtitle}] (the whole command with its +% argument is optional) if used, it adds a subtitle. % -% \Item[author]\marg{author's name} (mandatory: preset +% \Item[author\marg{author's name}] (mandatory: preset % empty); it is recommended to pay attention to insert proper % name(s) first and surname(s) second. % -% \Item[Nsupervisor]\meta{Supervisor(s) heading} (preset: -% Supervisor:) specifies the short heading labelling the list +% \Item[Nsupervisor\meta{Supervisor(s) heading}] (preset: +% Supervisor:) specifies the short heading to 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 sign is optional. % -% \Item[SupervisorList]\marg{list of supervisors} (mandatory: +% \Item[SupervisorList\marg{list of supervisors}] (mandatory: % preset empty) specifies the list of supervisors, one per line, % with a |\\| at the end of each line; the name(s) and surname(s) % are preceded by their academic title, and followed by their % role as supervisor, or co-supervisor. % -% \Item[NExaminationCommittee]\marg{examination committee -% heading} (preset: Doctoral Examination Committee:) specifies -% the heading of the list of examiners. +% \Item[NExaminationCommittee\marg{examination committee +% heading}] (preset: Doctoral Examination Committee:) specifies +% the list-of-examiners heading. % -% \Item[ExaminerList]\marg{list of examiners} (preset empty) +% \Item[ExaminerList\marg{list of examiners}] (preset empty) % specifies the list of examiners, one per line, each line % terminated by |\\|; each line contains the academic title, % the name(s) and surname(s), the role (referee for the @@ -1213,19 +1281,19 @@ School of Turin. % institution they belong to -- full official institution name, % city and country. % -% \Item[Nlocation]\marg{examination location} (preset: +% \Item[Nlocation\marg{examination location}] (preset: % Politecnico di Torino) specifies the institution where the % examination takes place. % -% \Item[ExaminationDate]\marg{examination date} (preset empty) +% \Item[ExaminationDate\marg{examination date}] (preset empty) % specifies the date when the examination is to take place. % -% \Item[Disclaimer]\marg{disclaimer statement} (preset: some long -% sentences agreed upon by the ScuDo doctoral school) mandatory +% \Item[Disclaimer\marg{disclaimer statement}] (preset: some long +% sentences agreed upon with the ScuDo doctoral school) mandatory % in most universities; the specific statement(s) may be different % in different universities. % -% \Item[Signature]\marg{the author's signature} (preset: a few +% \Item[Signature\marg{the author's signature field}] (preset: a few % 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) @@ -1244,8 +1312,8 @@ School of Turin. % package. If the source thesis file is being typeset by means % 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. +% loaded; it should implement in \XeLaTeX\ and \LuaLaTeX\ most of +% the functionality provided by \texttt{babel} in \pdfLaTeX. % “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. @@ -1333,7 +1401,7 @@ School of Turin. % \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 +% other modules preloads 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 @@ -1368,7 +1436,7 @@ School of Turin. % % The following description specifies these particular commands. % \begin{description}[noitemsep] -% \def\Item[#1]{\item[\normalfont\texttt{\char92#1}]} +% \def\Item[#1]{\item[\cs{#1}]} % % \Item[DeclareSlantedCapitalGreekLetters] does exactly what % its name means: it changes the definitions of the mathematical @@ -1376,13 +1444,12 @@ School of Turin. % 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 -% due to the larger set of math alphabets and math font commands +% due to the larger set of glyphs and math font commands % that are available with proper \sigla{UNICODE} math fonts and % options. % % \Item[ensuremath] should be already defined in the \LaTeX\ kernel; -% should one still be using an obsolete version, this command gets -% available anyhow. +%should you miss it for any reason, thei package provides it. % % % \Item[ohm] typesets an upright capital omega even if the % capital Greek letters are in italics; another good point @@ -1411,12 +1478,12 @@ School of Turin. % 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 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 any of those packages has already been loaded, -% so as not to overwrite the latter package definition and to avoid -% every possible conflict. +% \texttt{unitx}, \texttt{siunitx}, etc., but since one of these +% packages 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 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 @@ -1448,18 +1515,18 @@ School of Turin. % type; since this entity is not a variable, but it is % a mathematical constant, the \sigla{ISO} regulations require it to % 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. +% upright type for “e” and any other mathematical constant, but +% requires that 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 % “{\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 +% \Item[goodpagebreak\oarg{n}] 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 \emph{any} page; this command tests the amount of space +% justify \emph{any single} 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 @@ -1467,11 +1534,11 @@ School of Turin. % 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 +% \cs{goodpagebreak} accepts an optional argument\meta{n} 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 +% \Item[listing\meta{filename}] 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 @@ -1485,7 +1552,7 @@ School of Turin. % specified in the |fancyvrb| documentation for the original % command. The |fancyvrb| package was preferred to the |listings| % one, because it typesets verbatim material even while -% using font with multibyte encoding (therefore it works fine +% using font with multibyte encoded characters (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 selected characters @@ -1523,7 +1590,7 @@ School of Turin. % the due differences, this environment mimics the one defined % in the |toptesi-scudo| module. % -% The commands contained in this module are divided in there sorts. +% The commands contained in this module are divided in three sorts. % \begin{enumerate}[noitemsep] % \item % The commands to define the infix words, so as to use them @@ -1531,7 +1598,7 @@ School of Turin. % 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 +% for English, because is is supposed that most often than % not this module is used by Italian students to write their % bachelor degree final works in Italian universities; % nevertheless the possibility to change these strings is @@ -1569,7 +1636,7 @@ School of Turin. % % 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 +% |ThesisTitlePage| environment body. So the user should pay attention % to what the configuration file contains and to what s/he writes % within the |ThesisTilePage| environment, but if s/he uses again % a command already used in the configuration file, it should be @@ -1586,7 +1653,7 @@ School of Turin. % \begin{description}[noitemsep] %\def\Item[#1]{\item[\opz{#1}]} % -% \Item[evenboxes] The boxe containing the supervisor name(s) +% \Item[evenboxes] The box 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 @@ -1628,7 +1695,7 @@ School of Turin. % 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. +% available with the |topfront| package. % % This environment accepts an optional asterisk as an argument; % the syntax is the following: @@ -1649,62 +1716,68 @@ School of Turin. % The commands available with this module, divided into the three % groups described above, are the following. % \begin{description}[noitemsep] -% \def\Item[#1]{\item[\normalfont\cs{#1}]} +% \def\Item[#1]{\item[\cs{#1}]} % \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. -% \Item[AnnoAccademico] sets a different string in place -% of the default “Anno Accademico” one. -% \Item[Struttura di] sets the default structure prefix; -% for example this prefix might be “Department of”, -% and the structure name entered with \cs{struttura} +% \Item[NomeAnnoAccademico\marg{academicyear string}] +% Sets the default string for the +% “Academic Year”; by default it is “Anno accademico”. +% \Item[NomeCorso\marg{Degree course name}] sets the default string +% “Corso di laurea in” followed by an intelligent space |\xspace|. +% \Item[AnnoAccademico\marg{substitute string for academic year}] +% Sets a different string in place of the default “Anno Accademico” +% one. +% \Item[Struttura di\marg{structure prefix}] sets the default +% structure prefix; for example, this prefix might be “Department of”, +% while the structure name entered with \cs{struttura} % 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 course type; it might be “Laurea triennale”, +% \Item[CorsoDiStudi\marg{degree course name}] sets the default +% string for the 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 |topfront| standard module. -% \Item[NomeElaborato] Sets the name that qualifies the +% languages. It replaces the \emph{obsolete} following command: +% \Item[CorsoDiLaureaIn\marg{degree course name}] +% Remains available to be backwards compatible with +% |topfront| standard module command; its use is \emph{discouraged}. +% \Item[NomeElaborato\marg{thesis name}] +% Sets the name that qualifies the % 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 % Italian, in English, or the used main language. % 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 +% use is evidently \emph{discouraged}. +% \Item[CandidateNames\marg{candidate list headings}] +% Sets the labelling command for the +% list of 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 couldn use this command which it has a non standard syntax +% the user could use this command which 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, +% and feminine, repeat the same names for the feminine positions, % the last ones; the syntax in facts is the following: %\begin{ttsintassi} -%\cs{CandidateNames},\% +%\cs{CandidateNames}\% %\qquad\marg{masculine singular},\% %\qquad\marg{masculine plural},\% %\qquad\marg{feminine singular},\% %\qquad\marg{feminine plural},! %\end{ttsintassi} -% \Item[TitoloListaCandidati] is a much simpler command the user -% should prefer to the previous one; in facts it accepts a single -% argument formed by a comma separated list of names; from zero -% up to four names (in the same order as described above). +% \Item[TitoloListaCandidati\marg{candidate list headings}] +% is a much simpler command the user should prefer to the +% previous one; in facts it accepts a single argument formed +% by a comma separated list of names; from zero up to four names +% (in the same order as described above). % Therefore the following commands are all valid ones: %\begin{ttsintassi}\small% %\cs{TitoloListaCandidati}\Marg{} @@ -1712,63 +1785,68 @@ School of Turin. %\cs{TitoloListaCandidati}\Marg{Estudiante,Estudiantes} %\cs{TitoloListaCandidati}\Marg{Kandidat,Kandidaten,Kandidatin,Kandidatinen} %\end{ttsintassi} -% \Item[CandidateName] this command used to be the default one +% \Item[CandidateName\marg{candidate list heading}] +% This command used to be the default one % with the standard |topfront| module, and remains available -% with this package; it sets just one name (disregarding -% singular/plural and masculine/feminine variants) to substitute +% with this package; it sets just one name to substitute % the default ones. Please notice that this command is not % available with the other thesis type options. -% \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 +% \Item[Relatore\marg{advisor list heading}] +% Sets the string that labels the supervisor box; by default +% it is the Italian name “Relatore”; the command may be used to set % any different string. -% \Item[Correlatore] sets the string that -% labels the list of co-superpervisors when there is -% just one “second” supervisor. -% \Item[Correlatori] sets the string that -% labels the list of co-supervisors when there are -% three supervisors, a supervisor and two co-supervisors. +% \Item[Correlatore\marg{co-advisor list heading}] +% Sets the string that labels the list of co-superpervisor when +% there is just one “second” supervisor; in facts, with just one +% co-supervisor the heading it the singular name “Correlatore”. +% \Item[Correlatori\marg{co-advisor list heading}] +% Sets the heading of the list of co-supervisors when there are +% a supervisor and two co-supervisors. % \end{description} % \item[Variable data settings] % \begin{description}[noitemsep] -% \Item[titolo] sets the bachelor degree final work title. +% \Item[titolo\marg{title}] +% Sets the bachelor degree final work title. % The main module |topfront| uses in its place the command % \cs{monografia}; the user can still use the old command, % but |\titolo| is more descriptive. -% \Item[sottotitolo] sets the optional subtitle. +% \Item[sottotitolo\marg{subtitle}] Sets an 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 discipline -% the thesis deals with. -% \Item[relatore] sets the name of the only or the principal -% supervisor. -% \Item[secondorelatore] sets the name of a second supervisor, -% if any. -% \Item[terzorelatore] sets the name of a third supervisor, -% if any. -% \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 +% preferred; \cs{corsodilaurea} is \emph{deprecated}, but is +% maintained for backwards compatibility. +% \Item[materia\marg{discipline}] and \cs{Materia}\marg{discipline} +% set the optional discipline the thesis deals with. +% \Item[relatore\marg{advisor's name}] sets the name of the only +% or the principal supervisor. +% \Item[secondorelatore\marg{second advisor's name}] sets the +% name of a second supervisor, if any. +% \Item[terzorelatore\marg{third advisor name}] sets the name of +% a third supervisor, if any. +% \Item[candidato\marg{candidate name (man)}] 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 % 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 ‘F’ -% candidate. -% \item[\normalfont\cs{secondocandidato} or \cs{secondacanddata}] -% set the names of a possible second ‘M’ or ‘F’ candidate. -% \item[\normalfont\cs{terzocandidato} or \cs{terzacandidata}] -% 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 +% and the heading of the candidates list is labelled accordingly. +% \Item[candidata\marg{candidate name (woman)}] sets the name of the +% first or only ‘W’ candidate. +% \Item[secondocandidato\marg{second M candidate}] or +% \cs{secondacanddata}\marg{second W candidate} +% set the name for a possible second ‘M’ or ‘W’ candidate. +% \Item[terzocandidato\marg{third M candidate}] or +% \cs{terzacandidata}\marg{third W can\-didate} +% set the name for a possible ‘M’ or ‘W’ third candidate. +% \Item[ID\marg{ID code}] to be used just after the candidate's name, +% but as part of the setting command argument, establishes the % 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 +% \verb+\\\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; +% \Item[sedutadilaurea\marg{examination date}] +% 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; % s/he can even prefix the year range with the @@ -1777,22 +1855,25 @@ School of Turin. % suitable command of group~1) a string equivalent to % “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 -% under the generic name of the university; if this command -% is not used, no name gets typeset in the title page. -% \Item[struttura] sets the name of the university entity +% \Item[NomeAteneo\marg{University name}] +% sets the proper name of a specific university; it will be +% typeset in suitable uppercase type under the generic name of the +% university; if this command is not used, no name gets typeset +% in the title page. +% \Item[struttura\oarg{ordinal number}\marg{Structure name}] +% 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 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: % the first one is optional, and, if used, is an uppercase -% roman numeral that indicates the ordinal of the structure; +% roman ordinal numeral that distinguishes the structure; % 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[setlogodistance\marg{distance}] sets the distance between +% adjacent university logos, if more than one are used. +% \Item[logosede\oarg{height}\marg{logo file name}] +% 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 @@ -1811,22 +1892,21 @@ School of Turin. % 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 -% discouraged. -% \Item[tutoreaziendale] set the name of a possible company -% tutor, in case the final work is developed in a Company -% external to the university +% \emph{discouraged}. +% \Item[tutoreaziendale\marg{company tutor name}] +% set the name of a possible company tutor, in case the final +% work is developed in a Company external to the university % \end{description} % \end{description} % % \section{The module for a master degree thesis} %\label{sec:topmagistrale} % -% The module for the master degree thesis, -% |toptesi-magistrale.sty| is almost identical to the generic -% module |topfront|; the obvious differences are that it -% lacks the latter module commands that refer to the bachelor -% degree or the Ph.D.~theses. Evidently such specific commands -% are useless in a master degree thesis. +% The module for the master degree thesis, |toptesi-magistrale.sty| +% is almost identical to the generic module |topfront|; the obvious +% differences are that it lacks the latter module commands that refer +% to the bachelor degree or the Ph.D.~theses. Evidently such specific +% commands are useless in a master degree thesis. % % \begin{sloppypar} % Such eliminated commands include |\manografia|, @@ -1843,7 +1923,7 @@ School of Turin. % 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| -% environmnet, but before the |tomo| counter is stepped up. +% environment, 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 @@ -1858,7 +1938,7 @@ School of Turin. % 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 files require another processing +% single \sigla{PDf} file in several files requires 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 @@ -1876,10 +1956,10 @@ School of Turin. % files; when printed they are substantially identical to % the split documents obtained with the previous approach % but it simply avoids splitting the single document file -% in several files. The drawback is thet if hyperlinked cross-referencing +% in several files. The drawback is that if hyperlinked cross-referencing % is used, each tome is correctly hyperlinked to its -% internal targets, but no cross-referencing can be -% automatically done to items in other tomes. I do not +% internal targets, but no cross-referencing can +% automatically be done to items in other tomes. I do not % think this is a real draw back in practical situations, % but of course it produces a limitation to reading the % tomes on the screen. @@ -1902,7 +1982,7 @@ School of Turin. % 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 thes environment is that the possible asterisk +% peculiarity of this 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 @@ -1910,6 +1990,7 @@ School of Turin. % the environment. % % \section{The Ph.D.\ module for general use} +% % Except for the ScuDo theses, for which the University % specified the necessary requirements for both contents % and appearance of the title page, we provide a generic @@ -1950,9 +2031,10 @@ School of Turin. % his/her custom title page and would not use this module at all. % % \section{The custom module for the title-page}\label{sec:custom} +% % The construction of the customised title page module is the full % responsibility of the user. -% In facts the user, beyond specifying the |tipotesi=custom| +% In facts the user, beyond specifying the |tipotesi=custom| option % to the |toptesi| class class, at the beginning of the % document explicitly inputs a personal package file, say % |mycustomfile.sty| by means of the simple @@ -1976,7 +2058,7 @@ School of Turin. % a custom title page. % % We don't go further in describing the |tipotesi=custom| option, -% except remembering the this option just inhibits loading both +% except remembering that this option just inhibits loading both % the standard default module, and any other predefined module, unless the % user directly loads one with or without the specific module options. % @@ -1984,7 +2066,7 @@ School of Turin. % % The suffix |sss| is the acronym for the Italian name of % “High School”, \emph{Scuola Secondaria Superiore}. -% Elegance of bureaucratic language; the elementary school +% 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 @@ -2047,7 +2129,7 @@ School of Turin. % % Of course their title page must be very different from those % suitable for university theses, therefore a special module is -% necessary, and I decided to to add such a module to this bundle. +% necessary, and we decided to to add such a module to this bundle. % % Actually high school students require less information on the % title page; the school generic and proper names, obviously the @@ -2117,7 +2199,7 @@ School of Turin. % Service packages such as |xparse|, |xspace|, and |xcolor| % are already loaded for the benefit of this bundle and this % module, but the user is free to use their functionalities, -% mostly those of |xcolor|. +% in particular those of |xcolor|. %\item % Packages |calc| and |ifthen| are functional for the module; % supposedly the end users should not have any necessity to use @@ -2163,135 +2245,90 @@ School of Turin. % saved in the same folder. % % The title page commands are the following: -%\begin{description}\def\Item[#1]{\item[\normalfont\cs{#1}]} -%\Item[SSSLogo] +%\begin{description}\def\Item[#1]{\item[\cs{#1}]} +%\Item[SSSLogo\marg{school logo file name}] % is used to define the name of the graphic file containing % the high school logo; not necessarily the school allows to % use its logo; in any case if such command is not used, the -% logo information is ignored. The syntax is -% \begin{ttsintassi} -% \cs{SSSLogo}\marg{file name} -% \end{ttsintassi} +% logo information is ignored. % Remember that the graphic file must have one of these % extensions: |.pdf|, |.eps|, |.png|, or |.jpg|; the first % two may contains vector images and give the best results; % 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: -% \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 -% 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. -% Syntax: -% \begin{ttsintassi} -% \cs{NomeCandidato}{examinand label} -% \end{ttsintassi} -% This command might be used to set the label with a different +%\Item[NomeTesina\marg{document name}] +% sets the name of the document; the default value +% is “Tesina di maturità”. +%\Item[NomeCandidato\marg{heading over the candidate name}] +% is used to set the heading over the author's name; since +% the “tesina” is individual, the default value is +% “Studente” or “Studentessa” depending on his/her gender. +% See below the \cs{studente} and \cs{studentessa} command descriptions. +% This command might be used also to set the heading with a different % name in the correct gender. -%\Item[IndirizzoMiur] +%\Item[IndirizzoMiur\marg{Ministry of Education special address}] % sets the Ministry of Education special address. If this % command is omitted, this address, considered optional, -% is neglected. Syntax: -% \begin{ttsintassi} -% \cs{IndirizzoMiur}\marg{Ministry of Education special address} -% \end{ttsintassi} -%\Item[OpzioneMiur] +% is neglected. +%\Item[OpzioneMiur\marg{Ministry of Education option}] % sets the specification that distinguishes the school -% mission, if any. Syntax: -% \begin{ttsintassi} -% \cs{OpzioneMiur}\marg{Ministry of Education option} -% \end{ttsintassi} -%\Item[TipoScuola] +% mission, if any. +%\Item[TipoScuola\marg{generic school name}] % 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 students' specific school. Syntax: -% \begin{ttsintassi} -% \cs{TipoScuola}\marg{generic school name} -% \end{ttsintassi} -%\Item[NomeScuola] +% the students' specific school. +%\Item[NomeScuola\marg{specific school name}] % 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”. -% Syntax: -% \begin{ttsintassi} -% \cs{NomeScuola}\marg{specific school name} -% \end{ttsintassi} -%\Item[SedeScuola] +%\Item[SedeScuola\marg{school address}] % 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: -% \begin{ttsintassi} -% \cs{SedeScuola}\marg{the school basic or full address} -% \end{ttsintassi} -%\Item[AnnoScolastico] +% no default. +%\Item[AnnoScolastico\marg{school year}] % sets the school year at the end of which the state -% examination is undertaken; no default. Syntax: -% \begin{ttsintassi} -% \cs{AnnoScolastico}\marg{school year} -% \end{ttsintassi} -%\Item[titolo] +% examination is undertaken; no default. +%\Item[titolo\marg{document main title}] % sets the title of the document; please don't use long titles; % if a short sentence is not descriptive enough, use the % |\sottotitolo| argument to add specifications to the title; -% no default. Syntax: -% \begin{ttsintassi} -% \cs{titolo}\marg{main title} -% \end{ttsintassi} -%\Item[sottotitolo] +% no default. +%\Item[sottotitolo\marg{document substitle}] % sets an optional subtitle; if this command is not used -% the subtitle field is ignored; no default. Syntax: -% \begin{ttsintassi} -% \cs{sottotitolo}\marg{optional subtitle} -% \end{ttsintassi} +% the subtitle field is ignored; no default. % The subtitle, if any, is typeset in a normal sized font, % therefore it can be several lines long; nevertheless pay % attention to use the tie command |~| to connect with an % unbreakable space to the following ones such words as % prepositions, articles, short adverbs, and such similar % items. -%\Item[studente] or \cs{studentessa}, depending on the gender +%\Item[studente\marg{student name (Man)}] or +% \cs{studentessa}\marg{student name {Woman}}, depending on the gender % of the student, sets the name of the author of the % document, i.e.\ the name of the student undergoing the -% examination; no default. Syntax: -% \begin{ttsintassi} -% \cs{studente}\marg{proper name(s) followed by the surname(s)} -% \cs{studentessa}\marg{proper name(s) followed by the surname(s)} -% \end{ttsintassi} -% Remember: \textbf{never ever use the surname(s) before -% the name(s)}. +% examination; no default. +% Remember: \textbf{never ever use the surname(s) before the name(s)}. % If the \cs{NomeCandidato} macro has not been used, these commands % set the proper status to the |femminile| switch, so that the -% proper default label is used. -%\Item[Presidente] +% proper default heading is used. +%\Item[Presidente\marg{chairperson name}] % sets the name of the chairperson of the examining committee; -% no default. Syntax: -% \begin{ttsintassi} -% \cs{Presidente}\marg{examining committee chairperson full name} -% \end{ttsintassi} +% no default. % Again remember to write the necessary academic titles -% in lowercase, end the name(s) before the surname(s). -%\Item[NumeroCommissione] -% sets the examining committee ID number; no default.Syntax: -% \begin{ttsintassi} -% \cs{NumeroCommissione}\marg{Examing committee ID number} -% \end{ttsintassi} +% in lowercase, and the name(s) before the surname(s). +%\Item[NumeroCommissione\marg{Examining committee ID number}] +% sets the examining committee ID number; no default. %\end{description} % % The actual title page is created within the environment % |FrontespizioTesina|. This environment first reads a the % configuration file if one exists, then it analyses the -% commands possibly set within the environment by the author, +% commands set within the environment by the author, % possibly superseding the information read from the -% configuration file; the closing commands actually typeset +% configuration file; the environment closing command actually typesets % the title page; the schematic working is the following: %\begin{flushleft}\ttfamily\obeylines %\Bambiente{FrontespizioTesina} \% reads the config.\ file if any @@ -2304,7 +2341,7 @@ School of Turin. % up the text grid in a sensible way. No doubt some users may % complain that the title page does not allow to do this or % that; that the spacings should be different from what they -% actually are. +% actually are; and so on. % % There are work-arounds to these complains. %\begin{enumerate}[noitemsep] @@ -2349,10 +2386,10 @@ School of Turin. % 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. +% \sigla{PDF/A}-1b, \sigla{PDF/A-2a}, \sigla{PDF/A-2b}. and so on. % 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 +% here we stick to the PFD/A-b and PDF/A-2b, that are a sub set of the % newer ones, and for which suitable software is available. % % The requirements for the `a' sub-format imply not only those @@ -2360,7 +2397,7 @@ School of Turin. % of the document be accessible from outside (Tagged \sigla{PDF}). % The requirements for the `b' sub-format are that the % document must be reproducible without modifications exactly -% as it was at the moment of archiving. Both sub-formats must +% as it was at the moment of archiving. All sub-formats must % contain \emph{metadata} that are searchable even without % decompressing the normally compressed \sigla{PDF} file, and that % contain information useful for archive maintenance; among @@ -2373,16 +2410,18 @@ School of Turin. % of producing \sigla{PDF/A}-1b compliant files, provided that some % 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 difficulty in producing \sigla{pdf/a} compliant documents. +% version number 1.40.9 (or higher); therefore today there is no +% difficulty in producing \sigla{pdf/a} compliant documents, even at +% level~2. % % The particular attention needed to avoid problems with the % \sigla{PDF/A} compliance is summarised as follows: % \begin{enumerate}[noitemsep] % \item % The preliminary essential requirement is that the -% \texttt{pdflatex} engine used to typeset the thesis be -% sufficiently recent to support the \sigla{PDF/A} requirements. +% \texttt{pdflatex} or \texttt{lualatex} engine used +% to typeset the thesis be sufficiently recent to support +% the \sigla{PDF/A} requirements. % It's better to have the most recent distribution of % the \TeX\ system installed on your PC. Do not try to % typeset the thesis with the `old' \prog{latex}; you @@ -2415,21 +2454,8 @@ School of Turin. % contain the package \textsf{pdfx}; if it does not, % upgrade your \TeX\ system complete distribution. Be sure % that the version number of the \pack{pdfx} package has -% version number~1.5.8 or higher. +% version number~1.6.0 or higher. % -% \item -% In the 2018 version of \TeXLive, with the upgrade of |pdfx| -% a glitch emerged due to licence questions; the |sRGB.icc| distributed -% with earlier versions was under a limited licence that is not -% compliant with the free nature of the \TeX\ system. The maintainers -% are aware of this problem and, while they are further upgrading the -% \pack{pdfx} file, they suggest a work-around (that will be described -% below); it is possible that when you read this documentations the -% work-around, described below, is not necessary any more. -% With version 1.61 of \pack{pdfx} the problem is solved even if one uses -% a \TeXLive\ installation prior to the one distributed in the year 2018. -% In any case the most recent version 1.61 or higher of |pdfx| is -% necessary. % % \item % If your thesis main file, the one you run your typesetting @@ -2447,40 +2473,31 @@ School of Turin. % The keyword list requires a specific format that can be % examined in the |pdfx| package documentation. The best way to % be sure that this file accompanies the thesis main file, -% is to put its contents in a \env{filecontents*} environment. +% is to put its contents inside a \env{filecontents*} environment. % The details are in the documentation of the \pack{pdfx} package and % examples are shown in the Italian documentation of |TOPtesi|. -% In order to override the constraints of the \LaTeX\ kernel -% |filecontents| environment, TOPtesi loads the package |filecontents| -% that eliminates the mentioned constraints, but requires that the -% environment be used within the preamble, in any case before +% The environment may used within the preamble, in any case before % loading the |pdfx| package. Actually this does not forbid to use the % environment before the |\documentclass| statement, as it was in the -% previous versions of TOPtesi. The new version is backwards compatible -% with the previous ones with this simple difference: when the environment -% is used before the |\documentclass| statement, any modification of -% its contents does not take place unless the previous |xmpdata| file -% is deleted, because the kernel environment does not overwrite existing -% files; on the opposite, if the environment is used after the -% |\documentclass| statement ,the |xmpdata| file is simply overwritten -% without the need to delete a previous version. -% -% The work-around mentioned above consists in adding another line -% at the very end of the metadata file; it looks like this: -%\begin{verbatim} -%\setRGBcolorprofile{sRGB.icc}{sRGB}{Argyll CMS, sRGB color profile}% -%{https://www.argyllcms.com/} -%\end{verbatim} -% Thanks to the new |filecontents| functionalities there is no need -% to delete a previous |.xmpdata| file. But, as specified above, this -% work-around is not necessary anymore if the most recent version 1.6.1 -% or later of \pack{pdfx} is used; this work-around information is -% maintained in this documentation just for backwards compatibility. -% -% This work-around is required if you get an error message that -% refers to line 1084 of the |pdfx.sty| file; if you don't patch -% the metadata file and you do not get the above error, it means -% that the |pdfx| package has already been corrected. +% previous versions of TOPtesi. The new version of environment +% \env{filecontents} is backwards compatible with the previous +% ones with this “simple” difference: it accepts some options +% the most important of which are \opz{overwrite} and \opz{noheader}; +% the latter avoids inserting header comment lines into the saved +% file, while the former allows overwriting it at each +% compilation. Omitting \opz{overwrite} the environment does not +% overwrite an existing |.xmpdata| file; so that if some modification +% has been made to the source lines within the environment, such +% modifications do not get saved in the metadata file. \textcolor{red}{Such +% behaviour of the |filecontents| environment was introduced by the +% end of 2019; therefore if you are using the options but have a +% vintage version of the \TeX system you get errors. You are warned: +% never use vintage versions of the \TeX system, but be careful to +% maintain your (complete) installation up to date}. To avoid this +% situation and be totally transparent with respect to the date of +% the \LaTeX kernel date, we introduce a new environment named +% \env{pdfxmetadata} that performs the necessary controls and hides +% such differences to the user. % % \item % Some mathematical symbol commands obtained from the standard @@ -2488,30 +2505,31 @@ School of Turin. % some patching that is already included in this \texttt{TOPtesi} % bundle; but it is not excluded that with other fonts similar % patches might be requested. The \sigla{UNICODE} math fonts used -% by \XeLaTeX\ and \LuaLaTeX\ do not require any patch. +% by \XeLaTeX\ and \LuaLaTeX\ do not require any patch. If you seek +% conformance with level~2, this patch is not needed. % % \item % 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}-1b -% compliant. +% compliant, but it can with \sigla{pdf/a-2b}. % % \item % If you include \sigla{PDF} images that contain some text, be sure % that the fonts for this text are completely embedded in -% the included files. Should the \sigla{PDF} files come from an external -% drawing program be sure to configure that program so that +% the included files. Should the \sigla{PDF} files come from external +% drawing programs, be sure to configure that program so that % it embeds all the fonts used in each image. If you don't % succeed, open the \sigla{PDF} file with the free software % \texttt{inkscape} and save it back in \sigla{PDF} format; the % missing fonts will be replaced with their outlines and % this will not disturb the \sigla{PDF/A} conformity. Pay attention, % because Inkscape might save your file with some -% specifications for transparency; but transparency -% specifications destroy the \sigla{PDF/A} compliance. +% specifications for transparency; but transparency specifications +% destroy the \sigla{PDF/A-1b} compliance, not the \sigla{pdf/a-2b} one. % 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, +% \sigla{EPS} format; this format 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 this program is used to convert an @@ -2520,9 +2538,9 @@ School of Turin. % |\includegraphics|; all the suggested typesetting programs, % \prog{pdflatex} included, can import \sigla{EPS} files, therefore % these problems, thanks \texttt{inkscape} may be easily overridden. -% Once you got the corrected EPS file, you might distill it to PDF, -% so as to compress it in a compatible way; EPS files are generally -% human readable so they are very large in terms of memory size. +% Even better, once you got the corrected EPS file, you might distill +% it to PDF, so as to compress it in a compatible way; EPS files are +% generally human readable so they are very large in terms of memory size. % % \item % Verify your final \sigla{PDF} file with a suitable program and @@ -2530,12 +2548,12 @@ School of Turin. % modifications while the verification program keeps saying % that this or that is not compliant with the \sigla{PDF/A} % specification. A suitable program is the Preflight module -% of Adobe Acrobat Pro~XI (or later), but this, although the most -% authoritative, is a commercial program; probably your +% of Adobe Acrobat Pro~XI (or later); this is the most +% authoritative, but it is a commercial program; probably your % university has special facilities for this task. In any -% case you can install the \prog{veraPDF} free software +% case you can install the \prog{veraPDF} free and open software % from the Internet, and use this handy verification program -% (in 2017 the stable release was made available). +% (since 2017 the program is stable). % %\end{enumerate} % @@ -2559,8 +2577,8 @@ School of Turin. % programs, that, on the opposite, according to my experience, % have a very high rate of success in producing \sigla{PDF/A} % compliant documents. If you stick to the default \TeX\ system -% Type~1, 256-glyph fonts, or to the \sigla{UNICODE} encoded otf -% or ttf fonts and use this version of the TOPtesi bundle +% Type~1, 256-glyph fonts, or to the \sigla{UNICODE} encoded OpenType +% or TrueType fonts and use this version of the TOPtesi bundle % you should be able to avoid most problems. % % \section{Customisation}\label{sec:LPPL} @@ -2579,7 +2597,7 @@ School of Turin. % |\mainmatter|, and |\backmatter|; what appears in the table of % contents; and so on. % -% Nevertheless, in spite of being discouraged, some user might +% Nevertheless, in spite of being discouraged, some user might % want to customise some details. There are several ways to do % such customisation that conform the LPPL. % @@ -2588,21 +2606,21 @@ School of Turin. % although the original author and licence are maintained in their % initial comments, and that the file maintainer name is changed so % that any user of the modified version knows to whom address -% him/herself in case of need; the original author is not responsible +% him/herself in case of need; the original author is not responsible % of any modified file.} % % \paragraph{Direct modification} % In order to make a direct modification to any original file, first % duplicate the original file and change name to the duplicated file; -% the modify this copy name and make the changes that are deemed +% then modify this copy name and make the changes that are deemed % necessary, without forgetting to delete my name as the maintainer % while adding your name; it would be useful if some comments are -% added so as to describe what has benne modified, why and how. +% added so as to describe what has been modified, why and how. % % Remember to change accordingly the references to the modified % file(s) in the other bundle files; this implies that all the % bundle files get modified and that their names must be changed -% accordingly while modifying the initial comment lines so as to +% accordingly while modifying the initial comment lines so as to % delete my name as the maintainer. % % \paragraph{Modification of single commands and/or environments} @@ -2615,7 +2633,7 @@ School of Turin. % input with a |\usepackage| command inside the argument of % another |\AtBeginDocument| command; modify your personal file % the way you like, and test the result. - +% % If your modifications do not produce any difference in the % output PDF file, then you have to load your modified file after % the |\begin{document}| line. In this case you have to change @@ -2624,8 +2642,9 @@ School of Turin. % finish it with a |\makeatother| commands, since many macros % used inside the original code are “protected” with an |@| sign % with its category code changed to “letter”. Needless to say that -% in order to suse thei |.tex| file, the |\input| command must be -% used in place of the |\usepackage| one. +% in order to use this |.tex| file after the |begin{document}| +% statement, the |\input| command must be used in place of the +% |\usepackage| one. % % \paragraph{Command patching} % A third way to modify some commands and/or environments is to @@ -2653,7 +2672,7 @@ School of Turin. % \TeX\ format and for sharing some code between the driver % and the class part of the code, since they are supposed to % carry the same date and version number, besides their specific -% description string. +% description string.For these reasons such machinery has already been set at the very beginning of this \file{.dtx} file. % \iffalse %<*class> % \fi @@ -2685,27 +2704,33 @@ School of Turin. % be specified with their |\setotherlanguage| or |\setotherlanguages| % commands which do not change the preset main language. % -% The |filecontents| package is loaded: it removes the constraints -% the original kernel environment |filecontents|, with or without -% the asterisk, sets up for its use. In particular that what is -% contained in the environment gets saved in the named file, only -% if the named file does not exist. This implies that if some -% changes are introduced in the environment contents, such changes -% do not get saved in the named file unless a pre\-existing file is -% deleted. +% The |filecontents| package used to be loaded in the previous versions +% of TOPtesi, in oder to create the |.xmpdata| file containing the +% metadata necessary to produce PDF/A compliant files. Its +% functionalities are now included in the \LaTeX kernel |filecontents| +% environment; therefore it is no longer needed; in any case it is +% easier to use environment defined in TOPtesi for this specific +% task; it relies on some low level native \TeX code contained +% in package |fancyvfb|; here we load it: the new environment +% |pdfxmetadata| is defined further on. +% \begin{macrocode} +\RequirePackage{fancyvrb} +% \end{macrocode} +% Remember: this new environment must be loaded between the +% |\documentclass| and the |usepackage[a-1b]{pdfx}| statements. % % Another piece of code follows in order to abort the job if the % |toptesi| date, contained in it |\ProvidePacckage| argument is % older than the class date. Should this happen, the job is aborted % with a strong message on the console. In order to work properly % the |toptesi| package is loaded and its date is fetched by means -% of the defined |\GetFileInfo|macro. This macro is almost identical +% of the defined |\GetFileInfo| macro. This macro is almost identical % to the one that is available when this documented file is processed; % it simply differs in the sense that the |v.| prefix to the file % version number is taken as a separator; should be necessary to % compare also the version number, the |\fileversion| macro gets % defined properly without any prefix. The |\@parse@version| macro -% is a \LaTeX\ kernel one; in spite spite of its name, it extracts +% is a \LaTeX\ kernel one; in spite of its name, it extracts % from the first macro token the data in a form suitable for comparison % with the second macro token, so that a numerical test can be performed % without the intervention of non digit symbols. The prominent class @@ -2737,7 +2762,6 @@ School of Turin. \expandafter\@firstoftwo\else \expandafter\@secondoftwo\fi} \fi -\RequirePackage{filecontents} \providecommand\GetFileInfo[1]{% \def\filename{#1}% \def\@tempb##1 v.##2 ##3\relax##4\relax{% @@ -2779,7 +2803,7 @@ School of Turin. % reasons (before version 3.x \texttt{toptesi} was just an % extension to the \texttt{report} class) and partly because % it might be used as a stand alone package, but, take -% notice, it might create some conflicts with with other +% notice, it might create some conflicts with other % classes internal code, although with the latest versions % of |toptesi| we did not notice any conflict with the |book| % class; it is certainly incompatible with the \texttt{article} @@ -2817,7 +2841,7 @@ School of Turin. % \opz{magistrale}, \opz{dottorale}, \opz{secondaria}, are % described further on; options \opz{frontespizio} and % \opz{custom} avoid loading the default module |topfront| or any -% of the previous listed modules; the are used to create title pages +% of the previous listed modules; they 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 @@ -2853,6 +2877,9 @@ School of Turin. \newif\ifsecondaria\secondariafalse \newif\ifcustom\customfalse \newif\ifTOPnumerazioneromana\TOPnumerazioneromanafalse +\newif\ifTOPnocenterfolio \TOPnocenterfoliofalse +\newif\ifTOPnocenterhead \TOPnocenterheadfalse +\newif\ifTOPfolioinhead \TOPfolioinheadfalse % \end{macrocode} % % A binding correction is established; its default value is @@ -2870,6 +2897,12 @@ School of Turin. % In any case see further on a deeper explanation about margins % and binding correction. % +% The options concerning the folio position and the header text +% position have been requested after version 6.3.06. Beware! While +% the folio position close to the outer edge is acceptable, it turns +% to be quite bad looking if also the header text is moved to the +% fore edge; therefore avoid this position pair. +% % The options |usefrontespizio| and |noTOPfront| are set by the % specific “function” executed by the |tipotesi=|\meta{value} options. % \begin{macrocode} @@ -2904,6 +2937,11 @@ School of Turin. \fi} \DeclareOptionX{autoretitolo}[true]{\ifclassica\@utoretitolotrue\fi} \DeclareOptionX{oldstyle}[true]{\ifclassica\@ldstyletrue\fi} +\DeclareOptionX{nocenterfolio}[true]% + {\unless\ifclassica\TOPnocenterfoliotrue\fi} +\DeclareOptionX{nocenterhead}[true]% + {\unless\ifclassica\TOPnocenterheadtrue\fi} +\DeclareOptionX{folioinhead}[true]{\unless\ifclassica\TOPfolioinheadtrue\fi} \DeclareOptionX{pdfa}{\PackageWarning{toptesi}{% ***********************************************\MessageBreak% Option pdfa ignored.\MessageBreak% @@ -3018,7 +3056,7 @@ School of Turin. % Without binding correction the inner and outer margin % are chosen equal, but the grid is moved outwards if the % binding correction option is specified. With the |libro| -% option in force, the outer, lower margin are larger than +% option in force, the outer and the 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. @@ -3053,25 +3091,42 @@ School of Turin. % We now establish the page style. We start by setting to % “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 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 -% future versions folios may be redefined in a common way -% with the other page styles. Notice that in all page styles -% folios are always in the footers. +% this box. % % By defining |\lapagina| to be equivalent to |\thepage| % we can later on redefine |\lapagina| the way we like; we -% actually do so with the option \texttt{classica}. +% actually do so with option \texttt{classica}. +% Since there are options for setting the head information in a +% centred or lateral (external) position and similarly for the folios, +% plus the possibility to have the folio in the head or in the foot, +% we need to redefine the |plain| and |headings| page styles according +% to the options chosen by the user through the available keys. % \begin{macrocode} \def\lapagina{\thepage} \mark{{}{}} \newbox\@intesta % \def\ps@plain{\let\@mkboth\@gobbletwo -\def\@oddfoot{\null\hfill {\scshape\lapagina}\hfill \null}\def\@oddhead{} -\def\@evenhead{}\let\@evenfoot\@oddfoot} +\let\@oddhead\@empty\let\@evenhead\@empty% +\if@twoside + \ifTOPnocenterfolio + \def\@oddfoot{\makebox[\textwidth][r]{\scshape\lapagina}} + \def\@evenfoot{\makebox[\textwidth][l]{\scshape\lapagina}} + \else + \def\@oddfoot{\makebox[\textwidth][c]{\scshape\lapagina}}% + \def\@evenfoot{\makebox[\textwidth][c]{\scshape\lapagina}}% + \fi +\else + \ifTOPnocenterfolio + \def\@oddfoot{\makebox[\textwidth][r]{\scshape\lapagina}}% + \let\@evenfoot\@oddfoot + \else + \def\@oddfoot{\makebox[\textwidth][c]{\scshape\lapagina}}% + \let\@evenfoot\@oddfoot + \fi +\fi +} + % \end{macrocode} % Other page styles are defined in a different way according % to the choice of one side or two side printing. In any case @@ -3082,35 +3137,102 @@ School of Turin. % to invite the user to exploit the sectioning commands % optional short argument. % \begin{macrocode} -\if@twoside - \def\ps@headings{\let\@mkboth\markboth% autoretitolo - \def\@oddfoot{\null\hfill {\scshape\lapagina} \hfill\null} - \let\@evenfoot\@oddfoot - % - \def\@evenhead{\setbox\@intesta\hbox{\footnotesize\slshape - \leftmark}% +\if@twoside % two side + \def\ps@headings{% + \let\@mkboth\markboth\let\@oddhead\@empty\let\@evenhead\@empty + \unless\ifTOPfolioinhead % folio in head + \ifTOPnocenterfolio + \def\@oddfoot{\makebox[\textwidth][r]{\scshape\lapagina}} + \def\@evenfoot{\makebox[\textwidth][l]{\scshape\lapagina}} + \else + \def\@oddfoot{\makebox[\textwidth][c]{\scshape\lapagina}} + \def\@evenfoot{\makebox[\textwidth][c]{\scshape\lapagina}} + \fi + \def\@oddhead{\setbox\@intesta\hbox{\footnotesize\slshape + \rightmark}% \ifdim\wd\@intesta>\textwidth \headWarn{\chapter}\fi% - \underline{\makebox[\textwidth]{\footnotesize\slshape - \strut\leftmark}}}% + \ifTOPnocenterhead + \underline{\makebox[\textwidth][r]{\footnotesize\slshape + \strut\rightmark}}% + \else + \underline{\makebox[\textwidth][c]{\footnotesize\slshape + \strut\rightmark}}% + \fi}% + \def\@evenhead{\setbox\@intesta\hbox{\footnotesize\slshape + \rightmark}% + \ifdim\wd\@intesta>\textwidth \headWarn{\section}\fi% + \ifTOPnocenterhead + \underline{\makebox[\textwidth][r]{\footnotesize\slshape + \strut\leftmark}}% + \else + \underline{\makebox[\textwidth][c]{\footnotesize\slshape + \strut\leftmark}}% + \fi}% + \else % folio in foot + \let\@oddfoot\@empty\let\@evenfoot\@empty \def\@oddhead{\setbox\@intesta\hbox{\footnotesize\slshape \rightmark}% \ifdim\wd\@intesta>\textwidth \headWarn{\section}\fi% - \underline{\makebox[\textwidth]{\footnotesize\slshape - \strut\rightmark}}}% - \def\chaptermark##1{% - \markboth{\thechapter\ -- ##1}{\thechapter\ -- ##1}} - \def\sectionmark##1{\markright{\ifnum\c@secnumdepth>\z@ - \thesection\ -- \fi ##1}}} -\else - \def\ps@headings{\let\@mkboth\markboth - \def\@oddfoot{\null\hfill {\scshape\lapagina} \hfill\null} - \def\@evenfoot{} + \ifTOPnocenterhead + \underline{\makebox[\textwidth][r]{\footnotesize\slshape + \strut\rightmark}}\rlap{\quad\scshape\lapagina}% + \else + \underline{\makebox[\textwidth][c]{\footnotesize\slshape + \strut\rightmark}}\rlap{\quad\scshape\lapagina}% + \fi} + \def\@evenhead{\setbox\@intesta\hbox{\footnotesize\slshape + \rightmark}% + \ifdim\wd\@intesta>\textwidth \headWarn{\chapter}\fi% + \ifTOPnocenterhead + \underline{\llap{\scshape\lapagina\quad}% + \makebox[\textwidth][l]{\footnotesize\slshape\strut\rightmark}}% + \else + \underline{\llap{\scshape\lapagina\quad}% + \makebox[\textwidth][c]{\footnotesize\slshape\strut\rightmark}}% + \fi} + \fi + \def\chaptermark##1{\markboth{\thechapter\ -- ##1}{\thechapter\ -- ##1}} + \def\sectionmark##1{\markright{\ifnum\c@secnumdepth>\z@ + \thesection\ -- \fi ##1}}% + } +\else% oneside + \def\ps@headings{% + \let\@mkboth\markboth\let\@oddhead\@empty\let\@evenhead\@empty + \let\@oddfoot\@empty\let\@evenfoot\@empty + \def\@evenfoot{}\def\@evenhead{}% + \unless\ifTOPfolioinhead % folio in head + \ifTOPnocenterfolio + \def\@oddfoot{\makebox[\textwidth][r]{\scshape\lapagina}} + \else + \def\@oddfoot{\makebox[\textwidth][c]{\scshape\lapagina}} + \fi + \def\@oddhead{% + \setbox\@intesta\hbox{\footnotesize\slshape + \rightmark}% + \ifdim\wd\@intesta>\textwidth \headWarn{\chapter}\fi% + \ifTOPnocenterhead + \underline{\makebox[\textwidth][r]{\footnotesize\slshape + \strut\rightmark}}% + \else + \underline{\makebox[\textwidth][c]{\footnotesize\slshape + \strut\rightmark}}% + \fi + }% + \else % folio in foot + \let\@oddfoot\@empty\let\@evenfoot\@empty \def\@oddhead{\setbox\@intesta\hbox{\footnotesize\slshape \rightmark}% \ifdim\wd\@intesta>\textwidth \headWarn{\chapter}\fi% - \underline{\makebox[\textwidth]{\footnotesize\slshape - \strut\rightmark}}}% - \def\chaptermark##1{\markright{\thechapter\ -- ##1}}} + \ifTOPnocenterhead + \underline{\makebox[\textwidth][r]{\footnotesize\slshape + \strut\rightmark}}\makebox[\z@][l]{\enspace\scshape\lapagina}% + \else + \underline{\makebox[\textwidth][c]{\footnotesize\slshape + \strut\rightmark}}\makebox[\z@][l]{\enspace\scshape\lapagina}% + \fi} + \fi + \def\chaptermark##1{\markright{\thechapter\ -- ##1}}% + } \fi \def\headWarn#1{\PackageWarning{toptesi}{% @@ -3148,7 +3270,7 @@ School of Turin. % 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 +% difference between front matter and main matter; these % differences are already defined in the \texttt{book} % document class, but not in the \texttt{report} one. % \begin{macrocode} @@ -3244,12 +3366,65 @@ School of Turin. % names for localising the package in a language different % from Italian and English. % +% When and if a PDF/A compliant file has to be produced, it is +% necessary to load the \pack{pdfx} package in the document to +% be typeset and to create a special metadata file. The Italian +% documentation |toptesi-it| explains how to do these actions, +% in particular how to generate the necessary metadata and how +% to prepare the |\jobname.xmpdata| file; it was suggested +% to use the |filecontents| environment as redefined by package +% \pack{filecontents}. But the situation has become a little clumsy +% by the end of 2019 because the functionalities of the package +% have been introduced int the \LaTeX kernel. But the new upgraded +% kernel definition of the |filecontents| environment as redefined +% by the previous version of \pack{filecontents} becomes available +% only trough suitable options. This makes previous versions of +% theses typeset with the previous versions behave as if the +% \pack{filecontents} package was not loaded. In other words what +% was made in the examples accompanying this class and package does +% not work anymore as it used to do, when they are typeset with an +% updated version of the \TeX system; today with the 2020 \TeXLive +% version, they do not perform as they used to do, since they do not +% update the metadata without deleting the previous file that +% contained the previous version. You get the previous functionality +% if you edit the files and add the suitable options: \opz{noheader} +% and \opz{overwrite} to the opening environment statement. +% For new files we suggest to use a new environment in order to +% create the proper metadata file, with the proper name and contents. +% This new environment can be used in the thesis preamble anywhere +% before using the \pack{pdfx} package. +% +% The new environment has a very descriptive name: \env{pdfxmetadata}; +% it does not require asterisks or options; its contents are the +% metadata. Its use is a such: +%\begin{flushleft}\obeylines +%\cs{documentclass}\oarg{options}\Marg{toptesi} +%\meta{special packages} +%\Bambiente{pdfxmetatada} +%\meta{metada} +%\Eambiente{pdfxmetadata} +%... +%\cs{usepackage}\Oarg[a-1b]\Marg{pdfx} +%\meta{other packages} +%\meta{settings and definitions} +%\Bambiente{document} +%\end{flushleft} +% Here is the very simple code thanks to the |VerbatimOut| +% environment defined by the |fancyvrb| package, invoked +% without the \cs{begin} and \cs{end} commands that may not perform +% correctly within other environments. +% \begin{macrocode} +\newenvironment{pdfxmetadata}{% +\VerbatimOut{\jobname.xmpdata}}{\endVerbatimOut} +% \end{macrocode} +% % We have to modify the |\chapter| and |\part| commands so % that as the user first uses one of these commands the % typesetting style is switched to that of the main matter. % But by exploiting certain facilities of the |xparse| package, % some delicate tests could be developed by |xparse| itself; therefore -% the whole command was redefined so that the new syntax is the following: +% the whole commands were redefined so that the new syntax is the +% following: %\begin{flushleft}\obeylines %\cs{chapter}\meta{$\star$}\oarg{toc entry}\oarg{headings entries}\marg{title}\oarg{pagestyle} %\end{flushleft} @@ -3302,22 +3477,25 @@ School of Turin. % %\item[\meta{title}] with no surprise is the chapter title that % is printed in its opening page. It defines also the default -% \meta{toc entry} and therefore the \meta{headings entry}. +% \meta{toc entry} and therefore the \meta{headings entry} if these +% optional arguments are not specified. % % %\item[\meta{pagestyle}] solves a problem that arises more often % than not: by default the chapter opening page is typeset with % the |plain| page style; sometimes a different style is desired, % for example the |empty| one. The use can specify this optional -% argument with |empty| to have a headerless opening page without -% a printed folio. Actually the user can specify any page style, +% argument with |empty| to have a opening page without both a header +% and a printed folio. Actually the user can specify any page style, % provided it satisfies the typographical best practice. % %\end{description} % Actually the 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 possibly numbered with small caps roman numerals. +% (even or odd) and possibly with folios numbered with small +% caps roman numerals. The |\chapter*| dos not switch from +% front to main matter; while the starred one does. % \begin{macrocode} \RenewDocumentCommand{\chapter} {s O{#4} O{#2} m O{plain}}{% @@ -3365,9 +3543,14 @@ School of Turin. } % \end{macrocode} % It would be possible to redefine in a similar manner also -% the |\part| command, but it was deemed unnecessary, since -% theses are seldom divided into parts. -% \begin{macrocode} +% the |\part| command, but originally it was deemed unnecessary, +% since theses are seldom divided into parts; now with the +% options on the folio position it is necessary to redefine +% also the |part| command. +% \begin{macrocode} +\RenewDocumentCommand\part{s O{#3} m}{\iffrontmatter\mainmatter\fi +\if@openright \cleardoublepage \else \clearpage \fi +\thispagestyle{plain}\if@twocolumn \onecolumn \@tempswatrue \else \@tempswafalse \fi \null \vfil \IfBooleanTF{#1}{\@spart{#3}}{\@part[#2]{#3}}} \def\@part[#1]#2{\iffrontmatter\mainmatter\fi \ifnum \c@secnumdepth >-2\relax \refstepcounter{part}% @@ -3386,8 +3569,17 @@ School of Turin. \fi \Huge \bfseries #2\par}% \@endpart} - % \end{macrocode} +% The syntax is the following +%\begin{ttsintassi} +%\cs{part}\meta{*}\oarg{short title}{title} +%\end{ttsintassi} +% where the optional star implies no toc entry; in absence of the +% star, the toc entry is the \meta{short title} which, in turn, +% if not specified, assumes the same value as \meta{title}. +% The starred version of |\part|, contrary to the starred version +% of |\chapter|, switches from front to main matter. +% % At the same time we have to make sure that |\tableofcontents|, % |\listoftables| and |\listoffigures| do not exit from the % front matter style. We assume these commands are issued @@ -3396,10 +3588,10 @@ School of Turin. % toc entries with the native commands. We need not define the % headers, because the default title is good for this purpose; % but since such thesis elements are typeset with the front -% matter page style (|plain|), no headers are used; With long +% matter page style (|plain|), no headers are used; with long % indices and/or lists of tables and/or figures, the user might % desire to have headers, so that the declaration -% |\pagestyle{headings}| should be specifies before using the +% |\pagestyle{headings}| should be specified before using the % |\indici| or |\allcontents| commands. % % The table of contents itself is not linked at all, but in order @@ -3440,9 +3632,10 @@ School of Turin. % We need to define |\indici| (alias |\allcontents|) that typesets % the table of contents and, optionally, the lists of tables and/or % figures while softly maintaining the front matter style for -% typesetting. In facts, if the user wants a diffferent styl s/he can select it with a suitable argument the |\pagestyle| command. +% typesetting. In facts, if the user wants a different style s/he +% can select it with a suitable argument to the |\pagestyle| command. % \begin{macrocode} -\def\indici{% If headings are desired, the pagestyle must be set in advance +\def\indici{% If headings are desired, the page style must be set in advance \iffrontmatter\else\frontmattertrue\fi \tableofcontents \iftablespage @@ -3566,7 +3759,7 @@ School of Turin. % % The issue is that I prefer a narrower justified caption % rather than one where the last line is just a short word -% or the right segment of an hyphenated last word. If one +% or the right segment of a 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 @@ -3636,7 +3829,7 @@ School of Turin. % By the way, if the package \pack{caption} has been loaded % in the preamble, this specific recalculation must not be % executed at all; it is necessary to delay this definition -% at |\AtBeginDocument| so we know for sure if that the package +% at |\AtBeginDocument| so we know for sure if that package % has been actually loaded. Of course if the \pack{caption} package % has not been loaded the |\captionsetup| macro is not % defined and its use (for example, as a leftover of some @@ -3725,8 +3918,8 @@ School of Turin. % such as when it is set within a mini-page or another similar % environment; in such situations it is not required to use % |\captionof|; actually this command is simulated within this -% very \amb{SD} environment -%. +% very \amb{SD} environment. +% % The actual commands for inserting % the picture and its caption within the |figure| environment % have names starting with |SD|, namely |\SDcaption| and @@ -3765,7 +3958,7 @@ School of Turin. % 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 +% the “image” 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 @@ -3782,7 +3975,7 @@ School of Turin. % contains the usual short caption entry for the list of % figures or tables or specific other floats. %\item The \marg{caption} mandatory brace delimited argument -% contains the image caption. +% contains the image caption text. %\item The \marg{label} mandatory brace delimited argument % contains the string that is usually passed to the |\label| % command; this string is mandatory in the sense that it @@ -3873,7 +4066,7 @@ School of Turin. {\SDlinewidth=\textwidth}% % \end{macrocode} % Then we fix our attention to the correct use of the optional third -% argument, whose descriptor assigns it a default value of |0.5|: +% argument, whose descriptor assigns it a default value of |0.5|: % \begin{macrocode} \SDcaptionwidth=#3\SDlinewidth \ifdim\SDcaptionwidth<0.3\SDlinewidth @@ -3887,13 +4080,13 @@ School of Turin. \SDfigurewidth=\dimexpr\SDfigurewidth-\columnsep\relax % \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 +% the |figure| floating environment, or it is used as a fixed % 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| +% if yes, we have to test if we are really within the |figure| % 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 +% 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). % @@ -3907,7 +4100,7 @@ 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 @@ -3929,7 +4122,7 @@ School of Turin. % |.aux| file |\label| saved data, we must access the % string that contains these data but we have to expand % several times the saved macros until we have the real -% string in |\@temD|. +% string in |\@tempD|. % \begin{macrocode} }{%---------------------------------------------------CLOSING {\ifcsdef{r@\@tempSD}% @@ -3979,7 +4172,7 @@ School of Turin. % (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) +% second argument is used for this entry. The third (optional) % brace delimited argument, on the contrary, is the label % string that usually is passed as the argument of the % |\label| command. If specified it is this |\SDcaption| @@ -4192,7 +4385,7 @@ School of Turin. % \end{macrocode} % % {\tolerance=3000\relax -% The TOPtesi bundle contains two new chapter like sections +% The TOPtesi bundle contains two new chapter-like sections % activated with the commands |\sommario| (alias |\summary|) % and |\ringraziamenti| (alias |\acknowledgements|) respectively. % The infix strings that start these sections depend on the @@ -4296,11 +4489,11 @@ Skipping any redefinition\MessageBreak}% % language as the default one \emph{after} the |\begin{document}| % statement; % \item -% if XeLaTeX\ or LuaLaTeX\ is being used for typesetting, it +% if \XeLaTeX\ or LuaLaTeX\ is being used for typesetting, it % suffices to specify in the preamble the name of the other % language to be used, by means of the |setotherlanguage| % command, and to define the summary and acknowledgments names -% in the same way as with pdf\/\LaTeX; the same must be done +% in the same way as with \pdfLaTeX; the same must be done % at the beginning of the document to declare the new language % as the default one. % \end{itemize} @@ -4325,7 +4518,8 @@ 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 thesis types. +% module. This applies also to the other modules specific for +% special thesis types. % \begin{macrocode} \AtBeginDocument{% \unless\ifT@Pfrontespizio\ifTOPfront @@ -4342,12 +4536,13 @@ Skipping any redefinition\MessageBreak}% % |\mapstochar| that produce problems with that format, % because they have a declared width of 0\,pt; this % is no problem for \texttt{pdflatex}, but it is a problem -% for the \sigla{PDF/A} format. Therefore these commands must be -% replaced by equivalent ones that do not use zero-width -% glyphs. For |\not|, another slash can be used, but in -% order to have it the right size in all math typesetting -% modes it is necessary to have a different command for -% every mode; this is achieved with the |\mathchoice| +% for the \sigla{PDF/A} format. Therefore, and only when +% \texttt{pdflatex} is used for typesettiNg the document, +% these commands must be replaced by equivalent ones that +% do not use zero-width glyphs. For |\not|, another slash can +% be used, but in order to have it the right size in all math +% typesetting modes it is necessary to have a different +% command for every mode; this is achieved with the |\mathchoice| % primitive as such: % \begin{macrocode} \ifPDFTeX @@ -4391,6 +4586,7 @@ Skipping any redefinition\MessageBreak}% % of other useful packages, such as \pack{pdfpages}. % % \subsection{The \opz{classica} option} +% % As mentioned above, the \opz{classica} option was % devised in order to cope with theses in humanities and % the specifications came from Paolo Ciacchi, a student @@ -4398,7 +4594,7 @@ Skipping any redefinition\MessageBreak}% % thesis in classical Greek philology. The necessity % of the large normal size derived from the necessity of % having clear mark-up signs among the myriad signs -% philologists use, that sometimes I believe that the +% philologists use; sometimes I believe that the % philological mark-up requires typesetting environments % similar to the mathematical ones: in facts the material % to be typeset does not form linear sequences, as in plain @@ -4414,7 +4610,7 @@ Skipping any redefinition\MessageBreak}% % % The singular and plural masculine and feminine strings % for “candidate” are redefined in the |topfront| module. -% For other languages the configuration file is very handy. +% For other languages using the configuration file is very handy. % % Since theses in humanities may end up to occupy several % volumes\footnote{Classically “tomo” in Italian means “volume”, @@ -4433,14 +4629,16 @@ Skipping any redefinition\MessageBreak}% % is going to be printed in the title page. But when several % tomes are involved, instead of using the |\frontespizio| % macro or |frontespizio| environment, use the |\tomo| macro. -% There is no equivalent to the |frontespizio| environment. -% |\tomo| provides to stepping up the volume counter before -% actually printing the new tome title page. +% This |classica| thesis style does no allow to use a title page +% environment; therefore all necessary data necessary for the +% title pages of each tome must be specified before using the +% \cs{tomo} macro. This macro provides to stepping up the volume +% counter before actually printing the new tome title page. % \begin{macrocode} \newcounter{tomo} \newcommand*{\tomo}{\clearpage\stepcounter{tomo}\boolfalse{topTPTlogos}% \fr@ntespizio} -% \end{macrocode} +% \end{macrocode}^^A>>>>>>>>>>> % 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 that this @@ -4469,10 +4667,13 @@ Skipping any redefinition\MessageBreak}% % headings because the \texttt{classica} option changes % completely the left and the right headers depending on the % option \opz{autoretitolo}; in this case the left header -% contains the candidate's name and a short version of the +% contains the candidate's name and the (short) version of the % thesis title, while the right heading contains the chapter % (short) title; if this option is not in force, headings -% appear as usual. The redefinition of the \texttt{headings} +% appear as usual, but without using the settings relative to +% the folio position and the header text position. +% +% The redefinition of the \texttt{headings} % page style is made only if this option is in force. In case % of two-sided printing where the left head and the right % heads are different, the left heading contains the author @@ -4501,7 +4702,7 @@ Skipping any redefinition\MessageBreak}% % ragged margins, and eventually these boxes are set one % next to the other with an intermediate glob of infinitely % stretchable glue, and finally set in the header box with -% a rule underneath the two of them. The result might be +% a rule underneath both of them. The result might be % barely acceptable if both vertical boxes do not exceed % two lines and no words have to be hyphenated, but in % general I believe it is an ugly layout; the user is warned! @@ -4509,52 +4710,52 @@ Skipping any redefinition\MessageBreak}% % without the ID number if any. % \begin{macrocode} \if@utoretitolo - \if@twoside -% - \renewcommand*{\ps@headings}{\let\@mkboth\markboth% - \def\@oddfoot{\null \hfill \textbf{\lapagina} \hfill \null}% - \let\@evenfoot\@oddfoot - \def\@evenhead{% - \setbox\@intesta\hbox{\ifPDFTeX\latintext\fi - \footnotesize\strut\textsc{% - \@@author\ifcsvoid{@secondauthor}{\ et al.}: \@stitle}% - }% - \ifdim\wd\@intesta>\textwidth\headwrn{\titolo}\fi - \underline{\makebox[\textwidth]{\box\@intesta}}}% - \def\@oddhead{\ifPDFTeX\latintext\fi - \setbox\@intesta\hbox{% - \footnotesize\strut\textsl{\rightmark}}% - \ifdim\wd\@intesta>\textwidth \headWarn{\section}\fi% - \underline{\makebox[\textwidth]{\box\@intesta}}}% - \def\chaptermark##1{\markright{\thechapter\ -- ##1}}% - \def\sectionmark##1{}}% - \else - \renewcommand*{\ps@headings}{\let\@mkboth\markboth - \def\@oddfoot{\null \hfill \textbf{\lapagina}\hfill \null}% - \let\@evenfoot\empty\let\@evenhead\empty - \def\@oddhead{{\setbox\z@\hbox{\ifPDFTeX\latintext\fi - \footnotesize\textsc{% - \@@author\ifcsvoid{@secondauthor}{}{\ et al.}: \@stitle}}% - \setbox\tw@\hbox{\ifPDFTeX\latintext\fi - \footnotesize\textsl{\rightmark}}% - \dimen@=\dimexpr2em + \wd\z@ + \wd\tw@\relax - \ifdim\dimen@<\textwidth \relax - \else - \setbox\z@\vbox{\hsize.48\textwidth\parindent\z@ - \raggedright - \ifPDFTeX\latintext\fi\footnotesize\textsc{% - \@@author\ifcsvoid{@secondauthor}{}{\ et al.}: \@stitle - }}% - \setbox\tw@\vbox{\hsize.48\textwidth\parindent\z@ - \raggedleft - \ifPDFTeX\latintext\fi\footnotesize - \textsl{\rightmark}}% - \fi - \setbox\@intesta\vbox to\z@{% - \vss\hbox to\textwidth{\strut\box\z@\hfill\box\tw@}}% - \underline{\box\@intesta}}}% - \def\chaptermark##1{\markright{\thechapter\ -- ##1}}} + \if@twoside +% + \renewcommand*{\ps@headings}{\let\@mkboth\markboth% + \def\@oddfoot{\null \hfill \textbf{\lapagina} \hfill \null}% + \let\@evenfoot\@oddfoot + \def\@evenhead{% + \setbox\@intesta\hbox{\ifPDFTeX\latintext\fi + \footnotesize\strut\textsc{% + \@@author\ifcsvoid{@secondauthor}{\ et al.}: \@stitle}% + }% + \ifdim\wd\@intesta>\textwidth\headwrn{\titolo}\fi + \underline{\makebox[\textwidth]{\box\@intesta}}}% + \def\@oddhead{\ifPDFTeX\latintext\fi + \setbox\@intesta\hbox{% + \footnotesize\strut\textsl{\rightmark}}% + \ifdim\wd\@intesta>\textwidth \headWarn{\section}\fi% + \underline{\makebox[\textwidth]{\box\@intesta}}}% + \def\chaptermark##1{\markright{\thechapter\ -- ##1}}% + \def\sectionmark##1{}}% + \else + \renewcommand*{\ps@headings}{\let\@mkboth\markboth + \def\@oddfoot{\null \hfill \textbf{\lapagina}\hfill \null}% + \let\@evenfoot\empty\let\@evenhead\empty + \def\@oddhead{{\setbox\z@\hbox{\ifPDFTeX\latintext\fi + \footnotesize\textsc{% + \@@author\ifcsvoid{@secondauthor}{}{\ et al.}: \@stitle}}% + \setbox\tw@\hbox{\ifPDFTeX\latintext\fi + \footnotesize\textsl{\rightmark}}% + \dimen@=\dimexpr2em + \wd\z@ + \wd\tw@\relax + \unless\ifdim\dimen@<\textwidth + \setbox\z@\vbox{\hsize.48\textwidth\parindent\z@ + \raggedright + \ifPDFTeX\latintext\fi + \footnotesize\textsc{% + \@@author\ifcsvoid{@secondauthor}{}{\ et al.}: \@stitle + }}% + \setbox\tw@\vbox{\hsize.48\textwidth\parindent\z@ + \raggedleft + \ifPDFTeX\latintext\fi\footnotesize + \textsl{\rightmark}}% \fi + \setbox\@intesta\vbox to\z@{% + \vss\hbox to\textwidth{\strut\box\z@\hfill\box\tw@}}% + \underline{\box\@intesta}}}% + \def\chaptermark##1{\markright{\thechapter\ -- ##1}}} + \fi \fi % \end{macrocode} % @@ -4564,17 +4765,16 @@ Skipping any redefinition\MessageBreak}% % like to have also unnumbered notes within numbered % ones, as if they were two separate sets; of course % specialised extension modules, such as, for example, -% the |eledmac| or |reledmac| packages, are available on -% CTAN, but as a poor man solution the command |\nota| was -% introduced that inserts a note with a symbol as a note -% mark; the symbol \emph{must} be a mathematical one as -% the dagger or the double dagger; by default it is the -% asterisk. At the same time the default definition of -% the mathematical asterisk is that of a binary operator; -% I have experienced that the note symbol gets a +% the |eledmac|, |reledmac|, or |xreledmac| packages, are +% available in \TeXLive and MiKTeX, but as a poor man +% solution the command |\nota| was introduced that inserts +% a note with a symbol as a note mark; the symbol \emph{must} +% be a mathematical one as the dagger or the double dagger; +% by default it is the asterisk. At the same time the default +% definition of the mathematical asterisk is that of a binary +% operator; I have experienced that the note symbol gets a % better positioning if it is used as an ordinary symbol -% through |\mathord|. -% This is why its math code is redefined. +% through |\mathord|. This is why its math code is redefined. % % A final unusual request was to be able to put a blank % unnumbered note, as a (rather wide) note separator. @@ -4599,7 +4799,7 @@ Skipping any redefinition\MessageBreak}% % typesetting a page with one or more witty sentences. % The first request has a trivial solution, but at least % |\paginavuota| (alias |\emptypage|) is much shorter to -% type in than its expansion. +% type than its expansion. % % The environments \texttt{dedica} (alias \texttt{dedication}) % for the dedication, and \texttt{citazioni} (alias @@ -4617,7 +4817,9 @@ Skipping any redefinition\MessageBreak}% % The \texttt{citazioni}/\texttt{wittysentences} % environment typesets its material with the default font % shape series and size, so the author has to specify any -% change s/he desires. These three commands, though, are +% change s/he desires. +% +% These three commands and environments, though, are % available irrespective of the \texttt{classica} option, % so that they can be used also for theses outside the % field of humanities. @@ -4656,12 +4858,13 @@ Skipping any redefinition\MessageBreak}% % \fi % % \subsection{The \texttt{topfront.sty} code}\label{sec:topfront} +% % This file is input by \texttt{toptesi}, version 6 and higher % provided that no title page or thesis type options have been % specified by the user; it can also be used as an independent % extension module with (hopefully) any document class. % -% It contains all the definition for the composition of just +% It contains all the definitions for the composition of just % 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 @@ -4670,9 +4873,9 @@ Skipping any redefinition\MessageBreak}% % |toptesi| loading of |topfront| is inhibited and in its % place another extension module, |toptesi-scudo|, is loaded. % The same holds true with the other special thesis modules. -% This latter files are described in a subsequent sections. +% This latter files are described in subsequent sections. % -% It |topfront| makes use of an optional configuration file +% The |topfront| package makes use of an optional configuration file % where the user can define a lot of default information and % all the infix language dependent strings that are peculiar % to the title page. Among other things it can typeset @@ -4720,8 +4923,8 @@ Skipping any redefinition\MessageBreak}% \ifcsundef{ifsecondaria}{\newif\ifsecondaria\secondariafalse}{} \ifcsundef{ifplurale}{\newif\ifplurale\pluralefalse}{} -\ifcsundef{ifTOPfront}{\newif\ifTOPfront \TOPfronttrue -\newif\ifevenboxes \evenboxesfalse}{} +\ifcsundef{ifTOPfront}{\newif\ifTOPfront \TOPfronttrue}{} +\ifcsundef{ifevenboxes}{\newif\ifevenboxes \evenboxesfalse}{} \ifcsundef{c@tomo}{\newcounter{tomo}}{} @@ -4877,15 +5080,13 @@ Skipping any redefinition\MessageBreak}% \let\@stitle\empty -\newcommand*{\titolo}[2][]{% +\providecommand\titolo{} +\RenewDocumentCommand\titolo{O{#2} m}{% \ifbool{triennale}{% \PackageWarning{topfront}{Il titolo deve essere impostato con il comando \string\monografia} }{% -\def\@tempA{#1}\ifdefempty{\@tempA}% - {\gdef\@stitle{#2}}{\gdef\@stitle{#1}}% - \gdef\@titolo{#2}% - }% + \gdef\@stitle{#1}}\gdef\@titolo{#2}% } \def\sottotitolo#1{\gdef\@subtitle{#1}} % \end{macrocode} @@ -4901,22 +5102,24 @@ Skipping any redefinition\MessageBreak}% % of tetratricotomised blond hair} %\end{verbatim} % and the title page, for example, will contain something like this:\\[\bigskipamount] -% \begin{minipage}{\textwidth}\centering +% \fbox{\begin{minipage}{\textwidth}\centering % {\Large Master Thesis\\ in\\ Applied Tetratricotomy\par}\bigskip % {\huge Tetratricotomy of blond hair\par}\bigskip % {\large Accurate measurements of the four fourths\\ % of tetratricotomised blond hair} -% \end{minipage}\bigskip +% \end{minipage}}\bigskip +% % \begin{macrocode} \let\@materia\empty \def\Materia#1{\def\@materia{#1}}\let\materia\Materia % \end{macrocode} % % 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 +% 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 +% to be 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 @@ -4940,7 +5143,7 @@ Skipping any redefinition\MessageBreak}% % this bundle accepts up to three names for each category. % The |\second...| commands set the plural forms of the % labels printed above the name lists. For the candidates -% there are different commands to input ladies or gentlemen +% there are different commands to input women or men % names; according to the masculine (ending in `o') % or feminine (ending in `a') commands, the appropriate % true or false values are assigned to the boolean variable @@ -4966,7 +5169,7 @@ Skipping any redefinition\MessageBreak}% % 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. -% This command is aliased with |\esamendidottorato| +% For PhD theses this command is aliased by |\esamendidottorato| % which literally means “defence of the doctoral dissertation”; % nevertheless both commands refer to a simple date % in one of those formats. @@ -5058,7 +5261,7 @@ Skipping any redefinition\MessageBreak}% \def\annoaccademico#1{\ifclassica \def\@submitdate{{\large\textsc{\AnnoAccademico}} {\Large\s@tanno#1!}} \else - \PackageWarning{toptesi}{\string\annoaccademico\space + \PackageWarning{topfront}{\string\annoaccademico\space is usable only when the\MessageBreak `classica' option is in force}% \def\@submitdate{\AnnoAccademico\ #1 --- Needs the `classica' option} @@ -5077,7 +5280,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”. Notice: in many contries roman numerals +% are generally used as ordinal adjectives; in other countries +% roman numerals are just numbers; therefore the fortieth cycle +% in Italy is marked as “XL ciclo”, while in France it is marked +% as “XL\raise0.7ex\hbox{\scriptsize e} cycle”. % Macros |\corsodilaurea| and |\corsodidottorato| specify % the degree course qualification; you would specify just % “Elettronica”, for example, and the module will write @@ -5244,8 +5451,7 @@ Skipping any redefinition\MessageBreak}% % override the configuration ones. % % \begin{description}[noitemsep] -% \def\Item[#1]{\item[\normalfont\texttt{\char92#1}] -% sets or changes the string} +% \def\Item[#1]{\item[\cs{\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, @@ -5311,14 +5517,13 @@ Skipping any redefinition\MessageBreak}% % the single |\CandidateName| that should be used in a % language depended way and with the correct number and % gender once for all. -% The four endings in the Italian strings allow to -% exercise the correct selection only for Italian; -% a specific test is made inside the |\frontespizio| -% command; because of this, the same machinery cannot -% be used, say, for French but maybe in the future this -% feature is resolved in a proper way. The same is true -% for the supervisor and the co-supervisor strings that -% may be changed once for all with |\AdvisorName| and +% The four endings in the Italian strings used to allow +% the correct selection only for Italian. +% With the current of this TOPtesi bundle the tests work +% in a different way, so as to perform correctly also in +% other languages. The same is true for the supervisor +% and the co-supervisor strings that may be changed once +% for all with |\AdvisorName| and % |\CoAdvisorName|. % \begin{macrocode} \IfFileExists{\jobname.cfg}{\input{\jobname.cfg}}% @@ -5511,7 +5716,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 one 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 @@ -5714,7 +5919,7 @@ Skipping any redefinition\MessageBreak}% % Going down in the title page, now comes the optional % 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 +% 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 @@ -5722,7 +5927,7 @@ Skipping any redefinition\MessageBreak}% % 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. +% |\printloghi| macro does not do anything.^^A >>>>>> % \begin{macrocode} \unless\iftopTPTlogos {\vfill\centering \printloghi\par}\fi @@ -5784,7 +5989,7 @@ Skipping any redefinition\MessageBreak}% % % 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 +% categories of theses persons. If a bachelor degree % report is dealt with, the name of the \emph{single} % candidate is centred and written in caps-and-small-caps. % \begin{macrocode} @@ -5800,7 +6005,7 @@ Skipping any redefinition\MessageBreak}% % line with proper number and gender; in the second line % the first name, and in the subsequent lines, % if there are any, the other names. These virtual boxes -% actually contain a tabular environment each; these +% in reality contain a tabular environment each; these % environments shall be actually typeset when these virtual % box macros are executed. If the \texttt{classica} option % is in force no label is set over the principal advisor @@ -5824,7 +6029,7 @@ Skipping any redefinition\MessageBreak}% % 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| by -% means of the \cs{ID} macro described in previous sections; +% 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 @@ -5990,9 +6195,9 @@ Skipping any redefinition\MessageBreak}% % words and labels, and the commands to introduce the % specific thesis data; eventually it specifies the title % page layout and provides for its generation and to a -% copyright and disclaimer sentence on its verso page. +% copyright and disclaimer sentence on its page verso. % -% It produces also a colophon where some data concerning +% The module produces also a colophon where some data concerning % the thesis typesetting details are given. This colophon % is saved and used on the last even page of the complete thesis. % @@ -6049,27 +6254,29 @@ Skipping any redefinition\MessageBreak}% % \begin{macrocode} \AtBeginDocument{% \providecommand\diff{}\renewcommand{\diff}{\mathop{}\!\mathrm{d}} -\providecommand{\gei}{\ensuremath{\mathop{\mathrm{\mathstrut j}}\nolimits}} +\providecommand{\iu}{\ensuremath{\mathop{\mathrm{\mathstrut i}}\nolimits}} +\providecommand{\ju}{\ensuremath{\mathop{\mathrm{\mathstrut j}}\nolimits}} \providecommand{\eu}{\ensuremath{\mathop{\mathrm{e}}\nolimits}} -\let\iu\gei} +\let\gei\ju} % \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 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. 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}! +% the Napier number `e', and the two forms of imaginary unit |\iu| +% and |\ju| that set an operator-like roman `i' or`j' as it is customary in +% most engineering disciplines. The common alias |\gei| to the |\ju| +% command may be redefined if the PhD student wants to use a common +% phonetically transliterated name for the letter `j'; 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 +% standards for its Transactions. 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 @@ -6115,12 +6322,11 @@ Skipping any redefinition\MessageBreak}% % are preferred by many users who are not aware that % computations are now native of modern typesetting % 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 facilities +% with here. All modern programs may benefit from the +% advances of the \LaTeX3 language, that has 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 +% since this class loads the |etoolbox|, its powerful % and robust commands are already available; therefore % these packages are loaded only for the user comfort, % although they are not really required. @@ -6162,7 +6368,7 @@ Skipping any redefinition\MessageBreak}% \@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{setspace} % Define line spacing in paragraph. Don't use it! \RequirePackage{calc} % Calculation macros \RequirePackage{ifthen} % Conditional statements \RequirePackage{caption} % Configure captions @@ -6178,7 +6384,7 @@ Skipping any redefinition\MessageBreak}% % 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 +% tests are made through the robust testing commands % provided by the |etoolbox| package. % \begin{macrocode} \usepackage[intoc]{nomencl}% Generate nomenclatures or glossaries @@ -6198,10 +6404,10 @@ Skipping any redefinition\MessageBreak}% % raw file must be processed by means of program % \prog{makeindex} with special options. Assuming % that your thesis main file is named |MyPhDthesis.tex|, -% after compiling with pdfLaTeX, you have to open a +% after compiling with pdfLaTeX, you should open a % terminal, change the working directory into that % where your main file is stored, and -% issue and execute the line command +% enter and execute the line command %{\small %\begin{verbatim} %makeindex -s nomencl.ist -t MyPhDthesis.nlg -o MyPhDthesis.nls MyPhDthesis.nlo @@ -6223,9 +6429,11 @@ 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|. Again all this is automatically +% performed by the macros defined by the \file{toptesi-scudo} +% module, therefore your nomenclature is up to date at each +% run, without any need to explicitly use unusual undocumented +% native \TeX\ commands. In facts we define a new command % to process the nomenclature files and print them out. % % Again the test for an empty optional argument is made by @@ -6277,7 +6485,7 @@ Skipping any redefinition\MessageBreak}% % |resources.bib|, if it exists; since a generic name is not recommended, % we suggest to name at least one of your databases with the same name % as the user's thesis master file with extension |.bib|; the |\jobname| -% macro, actually contains the thesis master file. If neither +% macro, actually contains the thesis master file name. If neither % |resources.bib| nor |\jobname.bib| exist or the typesetting engine % cannot find them, it is the user's responsibility to create a |.bib| % file and include it in his/her master file preamble as an argument to @@ -6662,6 +6870,7 @@ This class is available in every up-to-date and complete % \fi % % \subsection{The \texttt{topcoman.sty} code} +% % This file may be used as an independent extension package % for the \texttt{report} document class, and possibly for % other classes. @@ -6705,7 +6914,7 @@ This class is available in every up-to-date and complete % Greek letters taken from the math italic font; the % upright ones are still available within the |\mathrm| % command argument. -% Attention: \cs{DeclareSlantedCapitalGreekLetters} is defined +% Warning: \cs{DeclareSlantedCapitalGreekLetters} is defined % only when using \prog{pdflatex}; with the other two engines % it is disabled and produces a warning. % \begin{macrocode} @@ -6758,7 +6967,8 @@ This class is available in every up-to-date and complete % \texttt{babel} language if the thesis is typeset with % \textsf{pdflatex} that loads that package; these commands % are not predefined if the thesis is typeset with \XeLaTeX\ -% or \LuaLaTeX\ that do not load the \texttt{babel} package; +% or \LuaLaTeX\ that often load \pack{polyglossia} instead +% of the \pack{babel} package; % but remember; this package may be used as a stand alone % one, without the initial call by the \texttt{toptesi} % document class, so that the language Italian might be @@ -6768,60 +6978,69 @@ This class is available in every up-to-date and complete % \begin{macrocode} \providecommand{\ohm}{\textormath{\textohm}{\mathrm{\Omega}}} \@ifpackageloaded{toptesi}{% -\providecommand\ped{}\providecommand\ap{}% -\renewcommand*{\ped}[1]{\textormath{\textsubscript{#1}}{_{\mathrm{#1}}}}% -\renewcommand*{\ap}[1]{\textormath{\textsuperscript{#1}}{^{\mathrm{#1}}}}}% -{\providecommand*{\ped}[1]{\textormath{\textsubscript{#1}}% - {_{\mathrm{#1}}}}% -\providecommand*{\ap}[1]{\textormath{\textsuperscript{#1}}% - {^{\mathrm{#1}}}}} -% -\@ifpackageloaded{siunitx}{\def\unit#1{\si{\,#1}}}% - {\providecommand\unit{}% - \renewcommand\unit[1]{\ensuremath{{\mathrm{\,#1}}}}% - } -\providecommand{\gei}{\ensuremath{\mathop{\mathrm{\mathstrut j}\nolimits}}} + \providecommand\ped{}\providecommand\ap{}% + \renewcommand*{\ped}[1]{\textormath{\textsubscript{#1}}{_{\mathrm{#1}}}}% + \renewcommand*{\ap}[1]{\textormath{\textsuperscript{#1}}{^{\mathrm{#1}}}}% + \providecommand\diff{}\renewcommand{\diff}{\mathop{}\!\mathrm{d}} +% +}{% + \providecommand*{\ped}[1]{\textormath{\textsubscript{#1}}% + {_{\mathrm{#1}}}}% + \providecommand*{\ap}[1]{\textormath{\textsuperscript{#1}}% + {^{\mathrm{#1}}}}% +} +% +\@ifpackageloaded{siunitx}{% + \def\unit#1{\si{\,#1}} +}{% + \providecommand\unit{}% + \renewcommand\unit[1]{\ensuremath{{\mathrm{\,#1}}}}% +} +\providecommand{\gei}{\ensuremath{\mathop{\mathrm{\mathstrut j}}\nolimits}} \providecommand{\eu}{\ensuremath{\mathop{\mathrm{e}}\nolimits}} -\providecommand{\micro}{\textormath{\textmu}{% - \ifPDFTeX - \ifdefined\muup\muup\else\mbox{\textmu}\fi - \else - \mathup{\mu}% - \fi -}} +\providecommand{\micro}{% + \textormath{\textmu}{% + \ifPDFTeX + \ifdefined\muup\muup\else\mbox{\textmu}\fi + \else + \mathup{\mu}% + \fi + }% +} \providecommand{\gradi}{\textormath{\textdegree}{^\circ}} % \end{macrocode} % -% Before this version 6.xx.yy this package used to define +% Before this major version 6, this package used to define % the command |\listing| for listing program sources; those -% definitions got very obsolete in front of several packages -% already available for this task. For example the package -% |listings|, very elegant also for the various configurations +% definitions became obsolete compared to several packages +% available for this task. For example the package +% |listings|,that is very elegant also for the various configurations % it can use; un fortunately it works fine only for verbatim % sources that contain only \textsc{ascii} characters; yes, % it is possible the definition of special commands to typeset % isolated characters not belonging to the \textsc{ascii} % table, but it is an error prone process. Giving up the -% niceties of |listings|, the |fancyvrb| works very fine +% niceties of |listings|, the |fancyvrb| works very well % with \sigla{UNICODE} and UTF-8 encoded characters. % % For backwards compatibility we maintain the command % |\listing| as a user interface to the |VerbatimInput| % of package |fancyvrb| with an initial setting of a -%|\small| font size. +% |\small| font size. % \begin{macrocode} \RequirePackage{fancyvrb} \fvset{fontsize=\small} \let\listing\VerbatimInput % \end{macrocode} +% % Of course before using |\listing| the user can set any other % special configuration s/he desires among those usable with -% package |fancyvrb|; the default set up shown above is good -% for \LaTeX\ code input, as well as for any programming language, whose -% source lines are shorter than 75--80 characters, depending +% package |fancyvrb|; the default set-up shown above is good +% 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 than |\small|. In certain circumstances the user +% can edit the source file as well as setting a font +% size smaller 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 @@ -6834,7 +7053,7 @@ This class is available in every up-to-date and complete % Remember that the comma as a decimal separator is % 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 +% to other classes or modules, it's up to you to define % 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 @@ -6858,10 +7077,10 @@ This class is available in every up-to-date and complete % on and off by using the commands |\IntelligentComma| % and |\NoIntelligentComma|. % -% The solution of the solutions would be using the |siunitx| -% package, whose command |\num| handles any fractional -% decimal number in the proper way adding also the digit -% triplets separation of digits when they exceed the number +% The best solution would be using the |siunitx| +% package; its |\num| command handles any fractional +% decimal number in the proper way and also adds the +% triplet digit separation when they exceed the number % of four before and/or after the decimal separator. In % many cases this might be a heavy burden to load a whole % complex package just for this task, but |siunitx| @@ -6897,11 +7116,11 @@ This class is available in every up-to-date and complete %\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 +% poor man solution is not 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. +% this shape was missing from the selected font 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 @@ -6943,10 +7162,16 @@ This class is available in every up-to-date and complete %\iffalse %<*topmon>^^A MONOGRAFIA -- TRIENNALE %\fi -%\subsection{The \texttt{monografia} module code} +%\subsection{The \texttt{toptesi-monografia} module code} +% % 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. +% Notice that by loading this module for bachelor theses the facilities +% for selecting the folio and/or the header text position are not +% available if this module is used with any class different from +% \class{toptesi}; after all this module defines mainly the way +% of typesetting the title page. % \begin{macrocode} \monografiatrue \@ifpackageloaded{etoolbox}{}{\RequirePackage{etoolbox}} @@ -7092,6 +7317,7 @@ This class is available in every up-to-date and complete \newcommand\StrutturaDi[1]{\gdef\@strutturadi{#1\unskip\xspace}} \newcommand\struttura[2][]{\gdef\@struttura{\ifempty{#1}{}{#1 }% \@strutturadi #2}} +\let\FacoltaDi\StrutturaDi \let\facolta\struttura % \end{macrocode} % Generally bachelor degree courses are not developed within % international agreements such as Erasmus, but it may not be @@ -7154,9 +7380,9 @@ This class is available in every up-to-date and complete % two more commands are optionally used: |\luogo| to establish % the location of the signature, and |\giorno| to establish a % signature date different from the current date. If the |\giorno| -% is not specified, its value maintains a meaningless default +% is not specified, its value is a meaningless default % string, and upon testing for such a string, no location, -% date and signature is typeset in the legal page; if the +% date and signature is typeset in the copyright page; if the % current date should be used, the user should specify % |\giorno{}|, with a really empty argument. % \begin{macrocode} @@ -7183,7 +7409,7 @@ This class is available in every up-to-date and complete % The label for the candidate list requires a list of comma % separated names, to a maximum of four names; in order they % should be the singular masculine, the plural masculine, the -% singular feminine, and the plural feminine names. No one is +% singular feminine, and the plural feminine names. No one is % mandatory, and the list may be completely empty if the label % should remain blank. The list is scanned and the names are % assigned to some internal variables that will be used according @@ -7200,13 +7426,13 @@ This class is available in every up-to-date and complete %\end{ttsintassi} % This command, as it may be seen, may be used also to set the % name list in languages different from Italian. -% It goes by itself that if the user typesets the thesis in a +% It goes without saying that if the user typesets the thesis in a % language where names are gender indifferent (as English, % Spanish, and other ones) s/he has two choices: ether s/he % uses the command with just two arguments, as shown above, % and uses only the masculine commands |\candidato|, % |\secondocandidato|, and |\terzocoandidato| even with names -% of female students, or s/he specifies the same names in the +% of student women, or s/he specifies the same names in the % arguments~3 and~4, as in arguments ~1 and~2. Lacking this % action, the corresponding titling names are blank. % \begin{macrocode} @@ -7238,7 +7464,7 @@ This class is available in every up-to-date and complete % 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 +% |xparse| facilities the asterisk is just an argument among 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 @@ -7394,7 +7620,8 @@ This class is available in every up-to-date and complete %\iffalse %<*topmag>^^A MAGISTRALE %\fi -% \subsection{Code for \texttt{master} thesis} +% \subsection{The \texttt{toptesi-magistrale} module code} + % 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 @@ -7409,6 +7636,9 @@ This class is available in every up-to-date and complete % 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. +% In any case if the module is loaded by a class different +% from \class{toptesi} the facilities for chosing the folio and/or +% the header text positions are not available. % \begin{macrocode} \@ifpackageloaded{etoolbox}{}{\RequirePackage{etoolbox}} \@ifpackageloaded{xspace}{}{\RequirePackage{xspace}} @@ -7449,8 +7679,7 @@ This class is available in every up-to-date and complete % in the counter remains available anyhow; therefore it is % not excluded that multiple tomes might be typeset in one % output \sigla{PDF} file to be split in separate files as described -% in section~\ref{sec:topmagistrale}; I did not test this -% functionality but I do not exclude it.^^A CONTROLLARE +% in section~\ref{sec:topmagistrale}. % \begin{macrocode} \ifcsundef{c@tomo}{\newcounter{tomo}{\setcounter{tomo}{0}}}{} \providecommand\tomo{} @@ -7560,10 +7789,9 @@ This class is available in every up-to-date and complete % \begin{macrocode} \let\@stitle\empty % default short title string -\newcommand*{\titolo}[2][]{% -\ifstrequal{#1}{}% - {\gdef\@stitle{#2}}{\gdef\@stitle{#1}}% - \gdef\@titolo{#2}% +\providecommand\titolo{} +\RenewDocumentCommand{\titolo}{O{#2} m}{% + \gdef\@stitle{#1}\gdef\@titolo{#2}% }% \def\sottotitolo#1{\gdef\@subtitle{#1}} @@ -7640,7 +7868,7 @@ This class is available in every up-to-date and complete % Here we define the necessary commands to fill up a comma % 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 +% printing a list of images, duly separated by adequate % space, all scaled to the same height, and, possibly, even % the whole logo string duly scaled to fit in the title page % width. The |\logosede| command, that can be used several @@ -7648,12 +7876,12 @@ This class is available in every up-to-date and complete % 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 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 -% smaller; on American sized sheets it may be a little larger, -% but in general it is adequate to the page size. +% logo heights. This dimension is preset to 80\% the mean +% width of the page margins, and on the average it is well suited. +% With the standard |toptesi| class printed on A4 paper, such +% height equals about 25\,mm; of course on smaller paper it is +% proportionally smaller; on American sized papers 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 \newsavebox{\TPT@logobox} @@ -7706,7 +7934,7 @@ This class is available in every up-to-date and complete % % 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 +% listed before can easily be used to localise such strings % in different languages. % \begin{macrocode} \@ifundefined{@titolo}{\def\@titolo{}}{} @@ -7817,7 +8045,7 @@ This class is available in every up-to-date and complete % is wrong. % % This choice was made because its programming is simpler, -% but in view of the end user it is simpler to use: for +% but also, in view of the end user, it is simpler to use: for % example, if the user does not use the asterisk for typesetting % the logos at the top of the page, and in a second time % s/he decides that the title page should be typeset with @@ -8024,7 +8252,7 @@ This class is available in every up-to-date and complete \par\clearpage % \end{macrocode} % -% It is useful to remind that the legal page in general is not +% It is useful to remind that the copyright 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 as are @@ -8054,7 +8282,7 @@ This class is available in every up-to-date and complete %\iffalse %<*topdoc>^^A DOTTORALE %\fi -% \subsection{The \texttt{toptesi-dottorale} module} +% \subsection{The \texttt{toptesi-dottorale} module code} % What follows is mainly a replica of the |topfront| module % where useless commands have been eliminated; “useless” % in view of creating a title page for a Ph.D.~thesis. @@ -8306,7 +8534,7 @@ This class is available in every up-to-date and complete \let\struttura\facolta % \end{macrocode} % -% next we define how to handle one or more logos; even in +% 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 of the universities where the research @@ -8452,10 +8680,10 @@ 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 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 +% and only (boolean type) argument, that is a single token +% is 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 % |\begin{ThesisTitlePage}*| with the asterisk after the % closing brace. The presence of the asterisk sets the % logo position to the title page lower half, while its @@ -8705,7 +8933,10 @@ This class is available in every up-to-date and complete %</topdoc> %\fi % +%^^A SCUOLA SECONDARIA SUPERIORE +% % \subsection{The \texttt{toptesi-sss} module code} +% % 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. @@ -8738,7 +8969,6 @@ This class is available in every up-to-date and complete \RequirePackage{ifthen} % Conditional statements \RequirePackage{booktabs} % professional rules in tables \RequirePackage{multirow} % Multirow table cells are not professional -\RequirePackage[autostyle]{csquotes} % necessary for biblatex \ifPDFTeX \RequirePackage{indentfirst}\fi \raggedbottom % \end{macrocode} @@ -8978,4 +9208,13 @@ Anno scolastico \@annoscolastico}} % package xparse new (may be not that new, but new for me) syntax % that allows to declare the optional argument descriptors so as to % inherit the values of other arguments.Such syntax avoids a lot of -% fragile tests, and is very handy.
\ No newline at end of file +% fragile tests, and is very handy. +%%%% (version 6.3.07) corrected "Attention!" and "It goes by itself" +% by "Warning!" and "It goes without saying" respectively. +%%%% (version 6.4.02) Besides correcting some typos, some options were +% added in order to set page headers and folios on specific positions; +% by default headers are centred, and folios are centred in footers; +% options allow to shift them towards the external margins and +% sometimes to set footers in headers. Moreover the PDF/A-2b is now +% described and suggested to set it as the preferred PDF/A conformance +% level. Documentation has been modified accordingly. diff --git a/macros/latex/contrib/toptesi/toptesi.pdf b/macros/latex/contrib/toptesi/toptesi.pdf Binary files differindex 6b16bbf05c..b2f705688b 100644 --- a/macros/latex/contrib/toptesi/toptesi.pdf +++ b/macros/latex/contrib/toptesi/toptesi.pdf diff --git a/macros/latex/contrib/toptesi/veraPDFnoconformance.pdf b/macros/latex/contrib/toptesi/veraPDFnoconformance.pdf Binary files differnew file mode 100644 index 0000000000..97db0b107b --- /dev/null +++ b/macros/latex/contrib/toptesi/veraPDFnoconformance.pdf |