diff options
author | Karl Berry <karl@freefriends.org> | 2015-11-05 00:01:47 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2015-11-05 00:01:47 +0000 |
commit | 42a577ac94f87e590dbafc8bcc466fbf1cf7618c (patch) | |
tree | 98024247df5a3207bf2c4a0158fd5b7c00258f27 /Master/texmf-dist/source/latex | |
parent | e6cb7eab17b3ef76d3f96c8e23782a91190102a8 (diff) |
toptesi (4nov15)
git-svn-id: svn://tug.org/texlive/trunk@38777 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex')
-rw-r--r-- | Master/texmf-dist/source/latex/toptesi/toptesi.dtx | 200 |
1 files changed, 108 insertions, 92 deletions
diff --git a/Master/texmf-dist/source/latex/toptesi/toptesi.dtx b/Master/texmf-dist/source/latex/toptesi/toptesi.dtx index b617955cabd..cd1653a9182 100644 --- a/Master/texmf-dist/source/latex/toptesi/toptesi.dtx +++ b/Master/texmf-dist/source/latex/toptesi/toptesi.dtx @@ -95,7 +95,7 @@ its source file is another example of how to use toptesi. % \iffalse %<*driver> \documentclass{ltxdoc} -\ProvidesFile{toptesi.dtx}[2014/12/13 v.5.86f Documented TeX file for +\ProvidesFile{toptesi.dtx}[2015/11/03 v.5.86g Documented TeX file for the TOPtesi bundle] \GetFileInfo{toptesi.dtx} \title{The TOPtesi bundle} @@ -149,7 +149,7 @@ the TOPtesi bundle] % experimentally 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 additions. The most important feature with \XeLaTeX\ is that the option pdfa -% cannot be used any more; this id due to the fact that +% cannot be used any more; this is due to the fact that % the typesetting engine \XeTeX\ does not produce directly any PDF output but % a modified, extended DVI output, that is immediately converted into a PDF file % through xdvipdfmx, a special version of the conversion program. Another minor @@ -159,9 +159,9 @@ the TOPtesi bundle] % \end{abstract} % % \section{Introduction} -% The TOPtesi bundle contains a certain number of files, specifically +% The TOPtesi bundle contains a certain number of files. % \begin{enumerate} -% \item a class file \texttt{toptesi.cls} to be used as the main document class; the main +% \item A class file \texttt{toptesi.cls} to be used as the main document class; the main % document may be any of a certain number of reports that in Italy % are called with various names: ``monografia'', ``monografia di laurea'', % ``tesi di laurea'', ``tesi di laurea specialistica'', ``tesi di laurea @@ -170,8 +170,8 @@ the TOPtesi bundle] % university education. Moreover since they may conclude a double degree university % program, they may receive foreign names such as, for example, ``Projet de fin d'\'etudes'', ``Master thesis'', and the like. % \item An extension package \texttt{toptesi.sty} that contains most of the code -% for the real typesetting; it might be used as an extension to the report class file, -% although this use is discouraged. +% for the real typesetting; it might be used as an extension to other classes, +% although this use is seldom necessary. % \item A second extension package \texttt{topfront.sty} that contains the % commands and the typesetting macros for the title page; this file may be % used as an independent extension package to be added to, say, the report @@ -185,7 +185,7 @@ the TOPtesi bundle] % |frontespizio| and we address the user to its documentation. It is important % to recall that if the |topfront| package has to be loaded, is is only at % the execution of the |\begin{document}| command. There fore no title page -% commands of any kind (those defined by |topfront| can be used in the preamble. +% commands of any kind (those defined by |topfront|) can be used in the preamble. % \item A third extension package \texttt{topcoman.sty} that defines a certain % number of user commands suitable for typesetting technical matters. % \item Previous versions of this bundle contained also the logos of a set of @@ -254,7 +254,8 @@ the TOPtesi bundle] % accepted by the |report| standard class. If the |noTOPfront| option % was specified and the package |frontepsizio| was loaded by the user, it % is necessary to remind that it can easily create pretty nice title pages, but -% by default it is preset to use A4 paper where it can typeset the tytle page in teo styles, one so called ``standard'' and the other called ``elements'', that +% by default it is preset to use A4 paper where it can typeset the tytle page in +% two styles, one so called ``standard'' and the other called ``elements'', that % mimics that of the famous book \emph{Elements of typographic style} by % Robert Bringhurst; this is so at least with |frontespizio|'s version % 1.4a of 2011/09/21 or earlier. It is possible to use |frontespizio| to use @@ -360,19 +361,20 @@ the TOPtesi bundle] % \begin{description} % \def\cs#1{\texttt{\char92#1}} % \def\Item[#1]{\item[\normalfont\cs{#1}]} -% \item[\textnormal{ttfamily fontespizio}] and \texttt{frontespizio*} are two +% \item[\textnormal{\ttfamily fontespizio}] and \texttt{frontespizio*} are two % environments that typeset the title page with two opposite styles: with the % university logo in the header vs the university logo in the lower part of % the front page. The commands described in the following items shall be used % either in the configuration file or within the body of these environments. %^^A -% \Item[frontespizio] Even if the above environments are recommended, the +% \Item[frontespizio] {\tolerance=6000 Even if the above environments are +% recommended, the % command |\frontespizio|, defined in the previous versions of the TOPtesi % bundle, is still usable. It typesets the title page 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 -% |\booltrue{topTPTlogos}| and |\boolfalse{topTPTlogos|. +% |\booltrue{topTPTlogos}| and |\boolfalse{topTPTlogos}|.\par} %^^A % \Item[monografia] sets the bachelor's report style and retrieves its title % \Item[titolo] gets the master or PhD thesis title and an optional thesis short title @@ -597,10 +599,10 @@ the TOPtesi bundle] % information on something that is not variable. This means that $V_i$ % requires an italic index to imply that the object $V$ is the $i$-th in % a set, while, say, $V_{\mathrm{max}}$ indicates the maximum value of the -% variable $V$. This command |\ped| may be used both in math and in text mode. +% variable $V$. This command |\ped| may be used in both math and text mode. % % -% \Item[ap] similarly |\ap| inserts an apex in upright type, both in math -% and in text mode. +% \Item[ap] similarly |\ap| inserts an apex in upright type, in both math +% and text mode. % % % \Item[unit] sets the unit of measure close to the numerical measure value by % inserting a non breakable thin space and by setting the units of @@ -610,10 +612,11 @@ the TOPtesi bundle] % |35\unit{km}| and to avoid writing \verb*+35 \unit{km}+. This command, % as it is defined, conflicts with the definition of the homonymous % command |\unit| as defined by the \texttt{unitsx} package, but since -% this latter package is necessarily input \emph{after} -% \texttt{topcomand.sty} is read, the last definition is the one in -% force, therefore if one wishes to use the \texttt{unitsx} package s/he -% should not encounter any inconsistencies. +% this latter package is necessarily input in the preamble, while +% \texttt{topcomand.sty} is read at the execution of |\begin{document}|, +% the latter file ha provisions to test if |unitsx| 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$ when typesetting units of % measure. @@ -621,7 +624,11 @@ the TOPtesi bundle] % \Item[gradi] sets the small circle that defines the sexagesimal degrees, for % example $35^\circ$; it may be used also for the celsius degrees by writing in the % source file, say, |35\unit{\gradi C}| in order to get -% $35\,^\circ\mathrm{C}$. +% $35\,^\circ\mathrm{C}$; notice the difference with |35\gradi|, that yields +% $35^\circ$ without any space between the measure and the ``degree'' little +% circle; this is what the ISO regulations require; The small space inserted +% by |\unit| is required when the unit of measure symbol contains at least +% one letter. % % % \Item[gei] inserts the imaginary unit in upright type with the % ``spelling'' used by the technologists: ``j''. This command may be @@ -633,46 +640,48 @@ the TOPtesi bundle] % require it is typed with an upright serifed font, just as operators are. % % % \Item[eu] inserts the Napier number symbol ``e'' in upright type; since -% this entity is not a variable, but it is a mathematical constant, the -% ISO regulations require it to be written in upright type. The ISO regulations require -% the upright type for ``e'' and any mathematical constant, but +% this entity is not a variable, but it is a mathematical constant, the ISO +% regulations require it to be written in upright type. The ISO regulations +% require the upright type for ``e'' and any other mathematical constant, but % the electron charge $e$ is typeset in math italics because this is physical -% ``constant'', not a mathematical one. \XeTeX\ allows to typeset upright Greek letters, -% so there is the facility to typeset an upright ``pi'' (the number) to be distinguished -% from an slanted ''pi'' (the angle). +% ``constant'', not a mathematical one. \XeTeX\ allows to typeset upright +% math Greek letters, so there is the facility to typeset an upright ``pi'' +% (the number) to be distinguished from an slanted ''pi'' (the angle). % % -% \Item[listing] requires for its argument the name of a file and typesets it in verbatim -% mode; this command is very useful for typesetting the listings of the programs that -% were written for the thesis; for best results it is recommended that the source -% program has lines not longer than 80 characters. There exists an external package -% \texttt{listings}, that the user might want to load, that does a similar work in -% a more professional and configurable way; this package simpler command might be -% preferable for its simplicity, but of course it is not compulsory. +% \Item[listing] requires for its argument the name of a file and typesets +% it in verbatim mode; this command is very useful for typesetting the +% listings of the programs that were written for the thesis; for best results +% it is recommended that the source program has lines not longer than +% 80 characters. There exists an external package \texttt{listings}, that +% the user might want to load, that does a similar work in a more professional +% and configurable way; this package simpler command might be preferable for +% its simplicity, but of course it is not compulsory. % \end{description} % % All these commands are defined into the separate package \texttt{topcoman.sty} % that might be used as an independent extension package with any document class. % % \section{PDF format suitable for archiving} -% This section in general does not apply if the thesis is typeset by means of \XeLaTeX, -% because the typesetting engine in this case cannot directly produce a PDF formatted -% output file. For this reason the option \texttt{pdfa}, that shall be described -% shortly, should not specified to the class |toptesi|; at the same time if this -% option is specified, but the thesis is typeset by means of \XeLaTeX, the effects -% of this options are be disabled. -% -% Politecnico di Torino as well as many other Italian and foreign universities are -% moving towards archiving theses in electronic format, specifically in the PDF one. The -% problem of course is: ``Will it be possible to read the archived documents, say, fifty -% years from now?'' -% -% This essential question has been answered by the International Standards Organisation -% (ISO) that in 2005 published the regulation ISO~19005-1. This regulation defines a -% PDF variant suitable for archiving, named PDF/A, that has two sub-formats -% distinguished as PDF/A-1a, and PDF/A-1b. The `a' sub-format is more exacting, while -% the `b' one is less stringent. Recently ISO has published an upgrade to these -% regulations, but here we stick to the older ones, that are a sub set of the newer ones, -% and for which suitable software is available. +% This section in general does not apply if the thesis is typeset by means +% of \XeLaTeX, because the typesetting engine in this case cannot directly +% produce a PDF formatted output file. For this reason the option |pdfa|, that +% shall be described shortly, should not specified to the class |toptesi|; +% at the same time if this option is specified, but the thesis is typeset by +% means of \XeLaTeX, the effects of this options are disabled. +% +% Politecnico di Torino as well as many other Italian and foreign universities +% are moving towards archiving theses in electronic format, specifically in the +% PDF one. The problem of course is: ``Will it be possible to read the archived +% documents, say, fifty years from now?'' +% +% This essential question has been answered by the International Standards +% Organisation (ISO) that in 2005 published the regulation ISO~19005-1. This +% regulation defines a PDF variant suitable for archiving, named PDF/A, that +% has two sub-formats distinguished as PDF/A-1a, and PDF/A-1b. The `a' +% sub-format is more exacting, while the `b' one is less stringent. Recently +% ISO has published an upgrade to these regulations, but here we stick to the +% older ones, 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 imposed on the `b' one, % but also that all characters are conforming to UNICODE and that the logical structure @@ -697,7 +706,8 @@ the TOPtesi bundle] % to typeset the thesis be sufficiently recent to support the 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' \LaTeX; you \emph{must} process the -% input thesis file(s) with \texttt{pdflatex} or with \prog{xelatex}; in the following, +% input thesis file(s) with \texttt{pdflatex} or with \prog{xelatex} or with +% \prog{lualatex}; in the following, % no specific check will be made in order to verify if you are actually using % \texttt{pdflatex}. If you really need to use the `old' \LaTeX, you get a DVI % file and you need to transform it with |dvips| into a PS file; at this point you @@ -761,16 +771,17 @@ the TOPtesi bundle] % \texttt{JohnSmithMasterThesis-def.ps} and fill in the necessary metadata and other % technical information into this file in the lines marked with |% Customize|. Then run % the \prog{ghostscript} program with the proper name (different for Windows or UNIX-like -% platforms) with the proper input parameters and options. There are strong chances that -% if you follow the general recommendations shown here and in the document +% platforms) with the proper input parameters and options as the |PS2PD.hhtml| file explains. There are strong chances that +% if you follow the general recommendations shown here and in this document % |toptesi-it-xetex.pdf| file, the output file will be PDF/A compliant. %\end{enumerate} % -% Let's warn you: if you are using Adobe Reader X (or later), this program will open -% a PDF file beginning with an information header claiming that the file is PDF/A -% compliant; maybe it's true, but do not trust this information too much, at least don't -% believe that this information is a ``certification'' of the PDF/A compliance. I have -% seen files with this comforting information that did not pass the Preflight test! +% Warning: if you are using Adobe Reader X (or later), this program will open +% a PDF file beginning with an information header stating that the file is +% PDF/A claims to be compliant; maybe it's true, but do not trust this +% information too much, at least don't believe that this information is a +% ``certification'' of the PDF/A compliance. I have seen files with this +% comforting information that did not pass the Preflight test! % % Up to today the realisation of PDF/A conforming files sets forth several problems % that are of great concern for the large Institutions that have thousands of documents @@ -795,7 +806,7 @@ the TOPtesi bundle] % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} \ProvidesClass{toptesi}% -[2014/12/13 v.5.86f Class for typesetting university theses] +[2015/11/03 v.5.86g Class for typesetting university theses] % \end{macrocode} % % The class itself is very simple since it requires just the \texttt{report} document @@ -837,11 +848,13 @@ the TOPtesi bundle] %</class> % \fi % \subsection{The \texttt{toptesi.sty} code} -% The greatest part of the \texttt{toptesi} class code is saved into a separate file -% partly for backward compatibility 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, although, take notice, it might interfere with the \texttt{book} -% class code while certainly it is incompatible with the \texttt{article} class. This +% The greatest part of the \texttt{toptesi} class code is saved into a separate +% file partly for backward compatibility 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, although, take +% notice, it might create some conflicts with with the \texttt{book} class code +% (although with the latest versions of |toptesi| we did not notice any conflict) +% while certainly it is incompatible with the \texttt{article} class. This % package must contain its own \TeX\ format declaration and might have different % version and subversion numbers compared to the class file and the other invoked % packages that are part of the same bundle. @@ -852,7 +865,7 @@ the TOPtesi bundle] % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} \ProvidesPackage{toptesi}% -[2014/12/13 v.5.86f Extension for toptesi.cls]% +[2015/11/03 v.5.86g Extension for toptesi.cls]% % \end{macrocode} % % We start with defining the debugging macros; these trace commands and macros @@ -864,9 +877,9 @@ the TOPtesi bundle] \let\TROF\TROFF % \end{macrocode} % -% Now we define the specific package macros: \texttt{classica} and \texttt{trieste} -% are identical; the use of \texttt{trieste} is discouraged, but this option is -% maintained for backward compatibility. +% Now we define the specific package options: \texttt{classica} and +% \texttt{trieste} are identical; the use of \texttt{trieste} is discouraged, +% but this option is maintained for backward compatibility. % The option \texttt{14pt} is for choosing a normal size of 14pt; the class option % file \texttt{size14.clo} is distributed with the \pack{extsizes} package and % is already included in any complete distribution of the major \TeX\ system ones; @@ -874,7 +887,8 @@ the TOPtesi bundle] % this large size, but with the latest complete distributions available, there % is no chance that the existing option file is missing. % -% \texttt{chapterbib} allows to set a list of references at the end of each chapter. +% \texttt{chapterbib} allows to set a list of references at the end of each +% chapter. % % For the options some boolean variables are % defined and the option definitions set some of them to the value ``true''. @@ -915,11 +929,11 @@ the TOPtesi bundle] % \ProcessOptions\relax % \end{macrocode} -% The \texttt{graphicx} package is loaded by default; it is required for inserting the -% university logo(s); if the user forgets that this package has already been loaded -% nothing dramatic happens, because the |\usepackage| and |\RequirePackage| macros -% perform the necessary tests in order to avoid reloading the same packages again -% and again. +% The \texttt{graphicx} package is loaded by default; it is required for +% inserting the university logo(s); if the user forgets that this package has +% already been loaded nothing dramatic happens, because the |\usepackage| +% and |\RequirePackage| macros perform the necessary tests in order to avoid +% reloading the same packages again and again. % \begin{macrocode} \RequirePackage{graphicx} \RequirePackage{etoolbox} @@ -940,7 +954,8 @@ the TOPtesi bundle] % \end{macrocode} % The inner margin is parametrised to the paper width, but a small correction % is made if the extra size of 14pt is chosen. Also |\footskip| is parametrised -% to the paper height in a slightly different way when the large |14pt| size is chosen. +% to the paper height in a slightly different way when the large |14pt| size is +% chosen. % \begin{macrocode} \ifx\f@size\@xivpt \setlength\interno{\dimexpr\paperwidth/6} @@ -950,8 +965,9 @@ the TOPtesi bundle] \footskip=2\baselineskip \fi % \end{macrocode} -% The convenience of holding the spine margin width in a dimensional register -% becomes really useful now in order to define the other text body grid dimensions. +% The convenience of holding the spine margin widthin a dimensional register +% becomes really useful now in order to define the other text-body +% grid-dimensions. % Without binding correction the inner and outer margin are chosen equal, but % the grid is moved outwards if the binding correction option is specified. % \begin{macrocode} @@ -975,13 +991,13 @@ the TOPtesi bundle] % \end{macrocode} % -% 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 styles; 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. +% 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 styles; 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. % 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}. @@ -995,11 +1011,11 @@ the TOPtesi bundle] \def\@evenhead{}\let\@evenfoot\@oddfoot} % \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 the header is set without the uppercasing -% that is done in all the default document classes, and it is underlined at a fixed -% distance from the base line. If the chapter or section heading exceed the -% |\textwidth| a warning is issued so as to invite the user to exploit the -% sectioning commands optional short argument. +% one side or two side printing. In any case the header is set without the +% uppercasing that is done in all the default document classes, and it is +% underlined at a fixed distance from the base line. If the chapter or section +% heading exceed the |\textwidth| a warning is issued so as to invite the user +% to exploit the sectioning commands optional short argument. % \begin{macrocode} \if@twoside \def\ps@headings{\let\@mkboth\markboth% @@ -1921,7 +1937,7 @@ Skipping any redefinition\MessageBreak}% % \fi % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{topfront}[2014/12/13 v.5.86f Title page for TOPtesi and other classes] +\ProvidesPackage{topfront}[2015/11/03 v.5.86g Title page for TOPtesi and other classes] % \end{macrocode} % In oder to use |topfront| as a stand-alone extension package with other % classes it is necessary to verify if the |classica| option corresponds @@ -2975,7 +2991,7 @@ Skipping any redefinition\MessageBreak}% % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} % lavora solo con LaTeX 2e \ProvidesPackage{topcoman}% - [2014/12/13 v.5.86f Additional commands for the TOPtesi bundle] + [2015/11/03 v.5.86g Additional commands for the TOPtesi bundle] % \end{macrocode} % The new command |\DeclareSlantedCapitalGreekLetters| optionally sets the capital % Greek letters in math mode with the glyphs taken from the math italic fonts, not from |