diff options
author | Norbert Preining <norbert@preining.info> | 2024-12-13 03:02:51 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2024-12-13 03:02:51 +0000 |
commit | 51ff03f60cfca1dcc5845978233ed9d35f5ec9b0 (patch) | |
tree | 39fe129f8c9a3d450a5f5bebeb35b04e483bc5f6 /macros/latex/contrib/rub-kunstgeschichte | |
parent | fe5c519618513f27a0f339adddc3876f62aacbdf (diff) |
CTAN sync 202412130302
Diffstat (limited to 'macros/latex/contrib/rub-kunstgeschichte')
-rw-r--r-- | macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte-example.pdf | bin | 162167 -> 208098 bytes | |||
-rw-r--r-- | macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte.dtx | 129 | ||||
-rw-r--r-- | macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte.pdf | bin | 346720 -> 352799 bytes |
3 files changed, 120 insertions, 9 deletions
diff --git a/macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte-example.pdf b/macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte-example.pdf Binary files differindex fb39e43845..2be3fbdff8 100644 --- a/macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte-example.pdf +++ b/macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte-example.pdf diff --git a/macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte.dtx b/macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte.dtx index f8b7415396..6fb48ea319 100644 --- a/macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte.dtx +++ b/macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte.dtx @@ -29,7 +29,7 @@ %<class>\NeedsTeXFormat{LaTeX2e}[2022-06-01] %<class>\ProvidesClass{rub-kunstgeschichte} %<*class> - [2024-10-30 v0.3.0 RUB Kunstgeschichte class] + [2024-12-11 v0.4.0 RUB Kunstgeschichte class] %</class> %<*driver> \documentclass{ltxdoc} @@ -199,6 +199,18 @@ % Note, that in contrast to e.g. the headers of the bibliography, the title page is not translated into the document language. % The guidleines specify that exactly this template should be used and to our understanding this means that it should always be written in german, regardless of the document language. % +% \DescribeMacro{\appendix} +% +% To indicate the end of the main content and start of the appendix, the \cs{appendix} command is used in \LaTeX. Here, the command was redefined to automatically disable section numbering for the appendix as suggested in the guidelines. This means you can just use normal section commands such as +% \begin{sourceverb} +% \section{Figures} +% \end{sourceverb} +% after calling +% \begin{sourceverb} +% \appendix +% \end{sourceverb} +% and it will not have a section number. +% % \subsection{Translations}\label{sec:usage:translations} % % The class uses the \pkg{translations} package to allow multi-lingual strings. The default language is english. To tell it which language it should use, you can load a package like \pkg{babel} with the corresponding language as the package option in the preamble. E.g. for german using the new spelling rules @@ -477,6 +489,7 @@ % \fi % % \begin{macro}{\printbibliographies} +% \changes{v0.4.0}{2024-12-11}{Fix: Unwanted space before bibliography headings}^^A % \changes{v0.3.0}{2024-10-30}{was added}^^A % Prints the bibliography using the native \cs{printbibliography} macro, but divides it into sections for primary sources and secondary literature. The keyword \texttt{source} is used to sort entries into the primary sources section. % @@ -511,13 +524,13 @@ % \end{macrocode} % For greater flexibility we define the heading strings as internal macros that can be redefined by the user with key-value options and use the \pkg{translations} package for the default strings. See \autoref{sec:implementation:translations} for the implementation of the translations. We don't want heading strings to include paragraphs, this is why we use the starred variant of \cs{newcommand}. % \begin{macrocode} -\newcommand*{\@rubkgi@bibheading}{ +\newcommand*{\@rubkgi@bibheading}{% \GetTranslationWarn{Bibliography} } -\newcommand*{\@rubkgi@bibheading@primary}{ +\newcommand*{\@rubkgi@bibheading@primary}{% \GetTranslationWarn{Primary Bibliography} } -\newcommand*{\@rubkgi@bibheading@secondary}{ +\newcommand*{\@rubkgi@bibheading@secondary}{% \GetTranslationWarn{Secondary Bibliography} } % \end{macrocode} @@ -672,6 +685,33 @@ % \end{macrocode} % \end{macro} % +% \begin{macro}{\appendix} +% \changes{v0.4.0}{2024-12-11}{redefined to disable section numbering} +% To automatically disable section numbering in appendix sections, +% we redefine \cs{appendix} to include setting the section numbering depth to zero. +% \iffalse +%% Extend \appendix to disable section numbering +% \fi +% First, we save the old appendix definition in a different macro. +% \begin{macrocode} +\let\oldappendix\appendix% +% \end{macrocode} +% Then we redefine the \cs{appendix} command +% \begin{macrocode} +\renewcommand{\appendix}{% +% \end{macrocode} +% starting with the old appendix macro +% \begin{macrocode} + \oldappendix% +% \end{macrocode} +% and extending it with setting the section numbering depth to zero, +% which will result in disabled section numbers. +% \begin{macrocode} + \setcounter{secnumdepth}{0}% +} +% \end{macrocode} +% \end{macro} +% % \subsection{Translations}\label{sec:implementation:translations} % \changes{v0.3.0}{2024-10-30}{Use translations package for multi-lingual support.}^^A % @@ -733,6 +773,14 @@ % \fi % \begin{macrocode} \begin{filecontents}{rub-kunstgeschichte-example.bib} +@manual{guidelines, + author = {{Kunstgeschichtliches Institut}}, + year = {2023}, + title = {Anleitung zur Erstellung von Hausarbeiten im Fach Kunstgeschichte}, + organization = {Ruhr University Bochum}, + url = {https://kgi.ruhr-uni-bochum.de/wp-content/uploads/2023/04/Anleitung-zum-Erstellen-von-Hausarbeiten-im-Fach-Kunstgeschichte_Fassung-Juli-2023.pdf}, + urldate = {2024-11-04} +} @article{exampleArticle, author = {Maxi Mustermann}, title = {A very interesting article}, @@ -795,6 +843,11 @@ % \begin{macrocode} \usepackage[ngerman]{babel} % Sets the language of the document % \end{macrocode} +% For including the graphics and placing them where we want them, we load the \pkg{graphicx} and \pkg{float} packages. +% \begin{macrocode} +\usepackage{graphicx} +\usepackage{float} +% \end{macrocode} % \iffalse % \fi @@ -822,7 +875,7 @@ so that the typeset text has 12pt font size, there is a 1.5 times line-spacing present and the page size is A4 with 2cm margins at top, left and bottom, - as well as a 4cm margin on the right. + as well as a 4cm margin on the right.\autocite[See:][11]{guidelines} Also, paragraphs don't have an indentation in the first line by default, @@ -831,9 +884,23 @@ is automatically loaded to enable clickable links and references. - Notably, the first page is a custom title page that aims to recreate the titlepage template of the guidelines in \LaTeX. Note, how the fields have descriptive default values in CAPS, so that you can easily see which information is still missing for the title page. As the documentation of this class states, you can either pass the corresponding key-value options into an optional argument of \verb|\maketitle|, or use the \verb|\configureTitlepage| macro in the preamble.\footnote{For a full list of titlepage options refer to the \texttt{rub-kunstgeschichte} class documentation.} + Notably, the first page is a custom title page + that aims to recreate the titlepage template + of the guidelines in \LaTeX. + Note, how the fields have descriptive default values in CAPS, + so that you can easily see which information is still missing + for the title page. + As the documentation of this class states, + you can either pass the corresponding key-value options + into an optional argument of \verb|\maketitle|, + or use the \verb|\configureTitlepage| macro + in the preamble.\footnote{For a full list of titlepage options + refer to the \texttt{rub-kunstgeschichte} class documentation.} - We use the \texttt{babel} package to set the language to german (even though this example document is actually written in english) to showcase how headings are automatically translated. + We use the \texttt{babel} package + to set the language to german + (even though this example document is actually written in english) + to showcase how headings are automatically translated. \section{How to cite sources} This class automatically loads the \texttt{biblatex} package @@ -860,11 +927,55 @@ or the biblatex cheatsheet \autocite{biblatexCheatsheet}. - At the end of the document we can include a bibliography - containing all cited sources, divided into primary and secondary literature, with \verb|\printbibliographies|. Primary literature (also called a \textit{source}) is something like the bible\autocite{bible}, letters, treatises etc. We put the bibliography on a new page by using \verb|\clearpage| before printing it. Note, that since we used \verb|\usepackage[ngerman]{babel}| in the preamble, the headings of the bibliography are typed in german. + \clearpage + \appendix + + \section{The appendix} + + We finished the main content of the example document + so we call \verb|\appendix| before this first appendix section. + It will automatically disable section numbering + for any appendix sections. + + Here, we can include a bibliography + containing all cited sources, + divided into primary and secondary literature, + with \verb|\printbibliographies|. + Primary literature (also called a \textit{source}) + is something like the bible\autocite{bible}, + letters, treatises etc. + We put the bibliography on a new page + by using \verb|\clearpage| before printing it. + Note, that since we used + \verb|\usepackage[ngerman]{babel}| in the preamble, + the headings of the bibliography are typed in german. \clearpage \printbibliographies + + \clearpage + \section{Figures} + + The guidelines suggest putting all figures + in a dedicated appendix section + after the bibliography instead of in between the + main content text.\autocite[10,25]{guidelines} + + We can include figures with \verb|\includegraphics| + inside a \texttt{figure} environment. + We also add a caption with the meta information + of the shown artwork,\autocite[25--26]{guidelines} + as well as a short caption in square brackets + and a label for back-referencing. + + \begin{figure}[H] + \centering + \includegraphics[width=0.8\linewidth]{example-image-golden} + \caption{An Artist, The artwork title, Where was it made?, + The year, Material, Measurements, Where is it kept?, + Inventory number.} + \label{fig:exampleArtwork} + \end{figure} % \end{macrocode} % % Finally we end the document environment diff --git a/macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte.pdf b/macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte.pdf Binary files differindex 22fc8ba8d0..a006c94626 100644 --- a/macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte.pdf +++ b/macros/latex/contrib/rub-kunstgeschichte/rub-kunstgeschichte.pdf |