diff options
Diffstat (limited to 'macros/latex/contrib/se2thesis/se2thesis.dtx')
-rw-r--r-- | macros/latex/contrib/se2thesis/se2thesis.dtx | 113 |
1 files changed, 89 insertions, 24 deletions
diff --git a/macros/latex/contrib/se2thesis/se2thesis.dtx b/macros/latex/contrib/se2thesis/se2thesis.dtx index 0a6705aaa5..4bd04fdcba 100644 --- a/macros/latex/contrib/se2thesis/se2thesis.dtx +++ b/macros/latex/contrib/se2thesis/se2thesis.dtx @@ -62,7 +62,7 @@ % internet, causing each thesis looking differently. % % The author of this package provided a template, -% which he initially created for his bachelor and master thesis, +% which he initially created for his bachelor's and master's thesis, % that was recommended and used by many students. % The implementation of that template, however, was very hacky and required % some changes over time. @@ -74,7 +74,7 @@ % The bundle itself consists of several \LaTeX{} classes and packages % that also allow reuse of various parts of it. % Its main class is the \pkg{se2thesis} document class, -% an extension of the \KOMAScript{} |scrreprt| document class. +% an extension of the \KOMAScript{} |scrbook| document class. % The packages \pkg{se2colors} and \pkg{se2fonts} provide necessary % colour and font settings for the \pkg{se2thesis} class; % the \pkg{se2packages} allows to load several recommended packages~(see @@ -144,6 +144,19 @@ % available from some time in autumn 2024. We will update this documentation % accordingly, as soon as the new version is available. % +%\subsection{Availability in MonsterWriter}\label{sec:doc-intro-mosterwriter} +% +% Since October 2024, \pkg{se2thesis} is also part of \textsc{MonsterWriter}, +% a graphical tool that assists students to write academic papers. The +% \textsc{MonsterWriter} GUI allows to focus on the content of a work and allows +% to export it in various common publisher styles and formats. +% +% The \textsc{MonsterWriter} website +% \href{https://www.monsterwriter.com}{monsterwriter.com} provides more details +% on the tool, and a YouTube video +% (\href{https://youtube.com/watch?v=BWOumwmh18g}{youtu.be/BWOumwmh18g}) +% demonstrates some of the features of their \pkg{se2thesis} integration. +% % \subsection{General Macros}\label{sec:doc-intro-macros} % % They all have in common one macro, \cs{IfFormatAtLeastTF}; @@ -186,9 +199,9 @@ % \pkg{expl3}, \pkg{l3keys2e} in case one uses a \LaTeX{} kernel from before % 2022--06--01, \pkg{graphicx}, \pkg{translations}, \KOMAScript, \pkg{xcolor}, % \pkg{ifthen}, as well as \pkg{fontspec}, \pkg{unicode-math}, -% and \pkg{libertinus-otf} if one uses \LuaTeX{}; +% \pkg{inconsolata-nerd-font} and \pkg{libertinus-otf} if one uses \LuaTeX{}; % for \pdfLaTeX{} we load \pkg{fontenc}, \pkg{libertinus-type1}, and -% \pkg{AnonymousPro} instead of the latter three. +% \pkg{inconsolata} instead of the latter three. % Furthermore, we load \pkg{microtype}; % when using \LuaTeX{}, we also load \pkg{lua-widow-control} and \pkg{selnolig}. % @@ -220,6 +233,11 @@ % \emph{Note:} you cannot use \cls{scrartcl} because it does not provide % the required |chapter| sectioning. % Default is |scrbook|. +% +% Please note that if you want to have the bibliography numbered or use an +% appendix with alpha-numbering (A, B, \dots), you want to explicitly use +% |scrreprt| as the base class; for some (currently unknown) reason this does +% not work with the default |scrbook|. % \end{function} % \begin{function}{paper} % \begin{syntax} @@ -243,9 +261,9 @@ % \end{syntax} % Defines the type of the thesis. % Possible values are: -% |bachelor| for a bachelor thesis, |bachelorproposal| for a proposal to -% a bachelor thesis, |master| for a master thesis, |masterproposal| for -% a proposal to a master thesis, |phdproposal| for a proposal to a PhD thesis, +% |bachelor| for a bachelor's thesis, |bachelorproposal| for a proposal to +% a bachelor's thesis, |master| for a master's thesis, |masterproposal| for +% a proposal to a master's thesis, |phdproposal| for a proposal to a PhD thesis, % |phd| for a PhD thesis in the natural sciences, |phdeng| for a PhD thesis % in engineering, and |phdphil| for a PhD thesis in natural philosophy. % \end{function} @@ -307,7 +325,7 @@ % \cmd{\matrnumber} \marg{matriculation-number} % \end{syntax} % Specify the matriculation number of the student writing the thesis. -% This is required for Bachelor and Master theses. +% This is required for bachelor's and master's theses. % \end{function} % % \begin{function}{\supervisor, \cosupervisor} @@ -437,7 +455,7 @@ % We provide the \env{acknowledgements} environment to typeset acknowledgements % for your thesis. % Using this environment is optional. -% Usually, bachelor and master thesis do not contain such an acknowledgements +% Usually, bachelor's and master's thesis do not contain such an acknowledgements % section, however, there is no general rule to this. % \begin{verbatim} % \begin{acknowledgements}[language] @@ -540,6 +558,48 @@ % question; % however, this can also be arbitrary text. % +% \subsection{Language Support and Hyphenation}\label{sec:doct-se2thesis-lang} +% +% The study regulations of the University of Passau require students to write +% their thesis in either German or English. For both cases it is recommended +% to load a package for the correct hyphenation patters. Usually, one can +% either choose between the \pkg{babel} and \pkg{polyglossia} package. For a +% detailed discussion in the differences and which to choose, please use the +% search engine of your choice. +% +% For this documentation we stick with the \pkg{babel} package, which is often +% considered to be the standard package. +% +% If you write your thesis in German, load \pkg{babel} in your preamble like +% follows +% \begin{verbatim} +% \usepackage[ngerman]{babel} +% \end{verbatim} +% For a thesis in English, you have to also load the German variant plus the +% English one as the default (see \cref{sec:doc-se2thesis-authorship} for an +% explanation) +% \begin{verbatim} +% \usepackage[ngerman,main=UKenglish]{babel} +% \end{verbatim} +% +% Note that by default, \LaTeX{} does not provide hyphenation for compound +% words, which is explained in the \TeX{} Book~\cite[p.~454]{Knu86} and a +% StackExchange post\footnote{\href{https://tex.stackexchange.com/a/63234/14622}{https://tex.stackexchange.com/a/63234/14622}}. The \pkg{babel} package +% provides a way (called shorthands) for German, which allows to reenable +% hyphenation for compound words (as they are common on German). These +% shorthands are by default not available for English, but they can easily be +% added by adding +% \begin{verbatim} +% \useshorthands{"} +% \addto\extrasUKenglish{\languageshorthands{ngerman}} +% \end{verbatim} +% after loading \pkg{babel} with the aforementioned \cmd{\usepackage} +% macro\footnote{see https://tex.stackexchange.com/a/298844/14622}. +% +% \emph{Please note:} loading the \pkg{hyphenat} package is strongly discouraged +% by the \pkg{se2thesis} maintainer because it conflicts with the \env{hyp} +% environment provided by \pkg{se2thesis} (see \cref{sec:doc-se2thesis-summaries}). +% % \end{documentation} % % \clearpage @@ -607,7 +667,7 @@ % % Identify the class and give the overall version number. % \begin{macrocode} -\ProvidesExplClass {se2thesis} {2024-06-25} {4.2.0} +\ProvidesExplClass {se2thesis} {2024-10-16} {4.4.0} {A thesis class for the Chair of Software Engineering II} % \end{macrocode} % @@ -992,11 +1052,11 @@ { \areaset[current]{350pt}{567pt} \setlength{\marginparsep}{8.5cm} - \setlength{\marginparsep}{1em} + \setlength{\marginparsep}{1.5em} }{ \areaset[current]{350pt}{567pt} \setlength{\marginparsep}{7.4cm} - \setlength{\marginparsep}{0.87em} + \setlength{\marginparsep}{1.5em} } % \end{macrocode} % @@ -1124,10 +1184,9 @@ \DeclareNewLayer[ mode=picture, foreground, - align=tr, - hoffset=\oddsidemargin+1.5in+\textwidth, + hoffset=\paperwidth-\coverpagerightmargin-\box_wd:N \l_@@_logo_box, voffset=\coverpagetopmargin+1.5in+\ht\strutbox, - width=\textwidth - \box_wd:N \l_@@_logo_box, + width=\box_wd:N \l_@@_logo_box, height=\box_ht:N \l_@@_logo_box, contents={\putUL{\box_use:N \l_@@_logo_box}}, ]{title.seii.logo} @@ -1246,7 +1305,7 @@ % \end{macrocode} % The next block generates the text that describes the thesis. % In case of a PhD thesis, this text is predefined to match the requirements. -% In case of a bachelor or master thesis, or a proposal thereof, we generate +% In case of a bachelor's or master's thesis, or a proposal thereof, we generate % a text based on the values of the |thesistype| load-time option and the % values of the \cmd{\degreeprogramme}, \cmd{\department}, and % \cmd{\institute} variables. @@ -1362,12 +1421,18 @@ % \end{macrocode} % % \begin{macro}{\@lowertitleback} -% Afterwards, override the definition of \cs{@lowertitleback}. +% Afterwards, override the definition of \cs{@lowertitleback}. To prevent +% line breaks in the title (that might be necessary to layout it properly on +% the front title page), we place a group around \cs{@title} and temporarily +% redefine \cmd{\\} to do nothing. % \begin{macrocode} \renewcommand*{\@lowertitleback}{% \group_begin: \noindent\textbf{\@author}:\\ - \emph{\@title}\\ + \group_begin: + \let\\\relax + \emph{\@title} + \group_end:\\ \tl_if_eq:NnT \l_@@_thesis_type_tl { bachelor } { \GetTranslation{Bachelor-thesis},~ } \tl_if_eq:NnT \l_@@_thesis_type_tl { master } @@ -1678,7 +1743,7 @@ % We provide the following English translations. % % \begin{macrocode} -\ProvideDictionaryFor{English}{se2translations}[2024/06/25] +\ProvideDictionaryFor{English}{se2translations}[2024/10/16] \ProvideDictTranslation{abstract}{abstract} \ProvideDictTranslation{Abstract}{Abstract} \ProvideDictTranslation{acknowledgement}{acknowledgement} @@ -1703,10 +1768,10 @@ \ProvideDictTranslation{External}{External Examiner} \ProvideDictTranslation{degreeprogramme}{programme} \ProvideDictTranslation{Degreeprogramme}{Programme} -\ProvideDictTranslation{Bachelor-thesis}{Bachelor Thesis} -\ProvideDictTranslation{Bachelor-thesis-proposal}{Bachelor Thesis Proposal} -\ProvideDictTranslation{Master-thesis}{Master Thesis} -\ProvideDictTranslation{Master-thesis-proposal}{Master Thesis Proposal} +\ProvideDictTranslation{Bachelor-thesis}{Bachelor's Thesis} +\ProvideDictTranslation{Bachelor-thesis-proposal}{Bachelor's Thesis Proposal} +\ProvideDictTranslation{Master-thesis}{Master's Thesis} +\ProvideDictTranslation{Master-thesis-proposal}{Master's Thesis Proposal} \ProvideDictTranslation{PhD-thesis}{PhD Thesis} \ProvideDictTranslation{PhD-thesis-proposal}{PhD Thesis Proposal} \ProvideDictTranslation{date}{date} @@ -1729,7 +1794,7 @@ % We provide the following German translations. % % \begin{macrocode} -\ProvideDictionaryFor{German}{se2translations}[2024/06/25] +\ProvideDictionaryFor{German}{se2translations}[2024/10/16] \ProvideDictTranslation{abstract}{Zusammenfassung} \ProvideDictTranslation{Abstract}{Zusammenfassung} \ProvideDictTranslation{acknowledgement}{Danksagung} |