diff --git a/src/.gitignore b/src/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..ae5f986cc4c6cb57960442f5f6c976294a2879b5 --- /dev/null +++ b/src/.gitignore @@ -0,0 +1,19 @@ +HsH-classes.ins + +*.synctex.gz +*.synctex(busy) +*.log + +*.aux +*.toc +*.lof +*.lot +*.fls +*.idx +*.ind +*.glo +*.gls +*.ilg +*.hd +*.fdb_latexmk +*.out diff --git a/src/.latexmkrc b/src/.latexmkrc new file mode 100644 index 0000000000000000000000000000000000000000..335a4d22a0fcf90823f6c1bfa37cf3654568274e --- /dev/null +++ b/src/.latexmkrc @@ -0,0 +1,18 @@ +@default_files = ('HsH-classes.dtx'); + +# generall settings: +$pdf_mode = 1; # use pdflatex + +push @final_output_exts, 'ins', 'cls', 'cfg'; +push @generated_exts, 'hd'; + + +$makeindex = 'makeindex -s gind.ist %S'; +add_cus_dep( 'glo', 'gls', 0, 'makeglo2gls' ); +push @generated_exts, 'glo', 'gls'; +sub makeglo2gls { + my ($base_name, $path) = fileparse( $_[0] ); + pushd( $path ); + system "makeindex", "-s", "gglo.ist", "-o", "$base_name.gls", "$base_name.glo" ; + popd(); +} diff --git a/src/HsH-article.cls b/src/HsH-article.cls index 433b198bb254ca09cf70811adddfa5afcb8395f4..a0c5bdf1da208a66e41c58d6df43fac3ac7407ca 100644 --- a/src/HsH-article.cls +++ b/src/HsH-article.cls @@ -6,31 +6,26 @@ %% %% HsH-classes.dtx (with options: `article') %% -%% This is a generated file. +%% Copyright (C) 2024 by Jan Wille <mail@janiwlle.de> %% -%% Copyright (C) 2021 by Jan Wille <mail@janwille.de> +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License (LPPL), either +%% version 1.3c of this license or (at your option) any later +%% version. The latest version of this license is in the file: %% -%% This file may be distributed and/or modified under the conditions of -%% the LaTeX Project Public License, either version 1.3 of this license -%% or (at your option) any later version. The latest version of this -%% license is in: -%% -%% http://www.latex-project.org/lppl.txt -%% -%% and version 1.3 or later is part of all distributions of LaTeX version -%% 2021/01/01 or later. +%% http://www.latex-project.org/lppl.txt %% \typeout{Adapted from KOMA script for use in Hochschule Hannover <2023-08-12> Jan Wille} \NeedsTeXFormat{LaTeX2e} -\newcommand{\myClassName}{HsH-article} -\ProvidesClass{\myClassName}[2023/08/12 v2.1 HsH-Class based on KOMA] +\newcommand{\HsHClassName}{HsH-article} +\ProvidesClass{\HsHClassName}[2023/08/12 v2.1 HsH-Class based on KOMA] %% commands for HsH-logo \newcommand{\HsHlogoPath}{HSH-Logo.pdf} \newcommand{\HsHlogoPage}{1} \newcommand{\includeHsHlogohere}[1][5cm]{ \IfFileExists{\HsHlogoPath}{}{ - \ClassError{\myClassName}{HsH-Logo.pdf not found!}{ + \ClassError{\HsHClassName}{HsH-Logo.pdf not found!}{ The HsH Logo is necasary for the titlepage! Try putting it next to your source file or use \HsHlogoPath to define the file location } } @@ -238,10 +233,10 @@ \@ifpackageloaded{subfigure}{ \newcommand{\subfigureautorefname}{\figureautorefname} }{} - \InputIfFileExists{config.tex}{ - \ClassInfo{\myClassName}{config.tex was found. Using it...} + \InputIfFileExists{HsH-classes.cfg}{ + \ClassInfo{\HsHClassName}{HsH-classes.cfg was found. Using it...} }{ - \ClassInfo{\myClassName}{no config.tex!! I hope you configered it yourself.} + \ClassInfo{\HsHClassName}{no HsH-classes.cfg!! I hope you configered it yourself.} } %% provide some usefull commands: \providecommand{\abs}[1]{\ensuremath{\left\vert#1\right\vert}} @@ -334,7 +329,7 @@ \begingroup \let\@param#1 \ifx\@param\@empty - \ClassError{\myClassName}{\maketitle\space with empty option}{ + \ClassError{\HsHClassName}{\maketitle\space with empty option}{ \maketitle[] has been called with an empty parameter, this doesn't work. Use \maketitle instead. } \fi diff --git a/src/HsH-classes.dtx b/src/HsH-classes.dtx index 47eee043a390a714d42f07a40dd2792d29c54127..dde6b40cd9446566cfce2e15863552912d538302 100644 --- a/src/HsH-classes.dtx +++ b/src/HsH-classes.dtx @@ -1,35 +1,92 @@ +%^^A !TeX root = ./HsH-classes.dtx % \iffalse meta-comment -% -% Copyright (C) 2020 by Jan Wille <mail@janwille.de> -% ------------------------------------------------------- -% -% This file may be distributed and/or modified under the -% conditions of the LaTeX Project Public License, either version 1.3 -% of this license or (at your option) any later version. -% The latest version of this license is in: -% -% http://www.latex-project.org/lppl.txt -% -% and version 1.3 or later is part of all distributions of LaTeX -% version 2021-01-01 or later. -% +%<*internal> +\iffalse +%</internal> +%<*readme> ^^A ---------- README ------------------------------------------------------- + HsH-classes | LaTeX for the Hochschule Hannover + -----------:| ------------------------------------------------------------ + Author | Jan Wille + E-mail | <mail@janiwlle.de> + License | Released under the LaTeX Project Public License v1.3c or later + See | <http://www.latex-project.org/lppl.txt> + +This Project containes classes to create documents for the Hochschule Hannover. + +To use them in you projects bring this folder on you `TEXINPUTS`. +%</readme> +%<*internal> +\fi +\def\nameofplainTeX{plain} +\ifx\fmtname\nameofplainTeX\else + \expandafter\begingroup +\fi +%</internal> +%<*install> ^^A ---------- HsH-Classes.ins --------------------------------------------- +\input docstrip.tex +\keepsilent +\askforoverwritefalse +\preamble + +Copyright (C) 2024 by Jan Wille <mail@janiwlle.de> + +This work may be distributed and/or modified under the +conditions of the LaTeX Project Public License (LPPL), either +version 1.3c of this license or (at your option) any later +version. The latest version of this license is in the file: + +http://www.latex-project.org/lppl.txt + +\endpreamble + +\usedir{tex/latex/HsH-classes} +\generate{ + \file{HsH-article.cls}{\from{\jobname.dtx}{article}} + \file{HsH-report.cls}{\from{\jobname.dtx}{report}} + \file{HsH-standalone.cls}{\from{\jobname.dtx}{standalone}} +} +%</install> +%<install>\endbatchfile +%<*internal> ^^A ---------- self-extract ----------------------------------------------- +\usedir{source/latex/HsH-classes} +\generate{ + \file{\jobname.ins}{\from{\jobname.dtx}{install}} +} +\nopreamble\nopostamble +\usedir{doc/latex/HsH-classes} +\generate{ + \file{README.md}{\from{\jobname.dtx}{readme}} +} +\ifx\fmtname\nameofplainTeX + \expandafter\endbatchfile +\else + \expandafter\endgroup +\fi +%</internal> % \fi % +% \iffalse +%<*driver> +\documentclass{ltxdoc} +\begin{document} +\end{document} +%</driver> +% \fi %<*article|report|standalone> \typeout{Adapted from KOMA script for use in Hochschule Hannover <2023-08-12> Jan Wille} \NeedsTeXFormat{LaTeX2e} % -%<article>\newcommand{\myClassName}{HsH-article} -%<report>\newcommand{\myClassName}{HsH-report} -%<standalone>\newcommand{\myClassName}{HsH-standalone} -\ProvidesClass{\myClassName}[2023/08/12 v2.1 HsH-Class based on KOMA] +%<article>\newcommand{\HsHClassName}{HsH-article} +%<report>\newcommand{\HsHClassName}{HsH-report} +%<standalone>\newcommand{\HsHClassName}{HsH-standalone} +\ProvidesClass{\HsHClassName}[2023/08/12 v2.1 HsH-Class based on KOMA] %% commands for HsH-logo \newcommand{\HsHlogoPath}{HSH-Logo.pdf} \newcommand{\HsHlogoPage}{1} \newcommand{\includeHsHlogohere}[1][5cm]{ \IfFileExists{\HsHlogoPath}{}{ - \ClassError{\myClassName}{HsH-Logo.pdf not found!}{ + \ClassError{\HsHClassName}{HsH-Logo.pdf not found!}{ The HsH Logo is necasary for the titlepage! Try putting it next to your source file or use \HsHlogoPath to define the file location } } @@ -341,9 +398,9 @@ }{} %</!standalone> \InputIfFileExists{HsH-classes.cfg}{ - \ClassInfo{\myClassName}{HsH-classes.cfg was found. Using it...} + \ClassInfo{\HsHClassName}{HsH-classes.cfg was found. Using it...} }{ - \ClassInfo{\myClassName}{no HsH-classes.cfg!! I hope you configered it yourself.} + \ClassInfo{\HsHClassName}{no HsH-classes.cfg!! I hope you configered it yourself.} } %% provide some usefull commands: % Makro for vertical lines around absolute values @@ -470,7 +527,7 @@ %<article> \begingroup \let\@param#1 \ifx\@param\@empty - \ClassError{\myClassName}{\maketitle\space with empty option}{ + \ClassError{\HsHClassName}{\maketitle\space with empty option}{ \maketitle[] has been called with an empty parameter, this doesn't work. Use \maketitle instead. } \fi diff --git a/src/HsH-classes.ins b/src/HsH-classes.ins deleted file mode 100644 index 64a0dd7b977983f439fc868575a5bedd5ce58a74..0000000000000000000000000000000000000000 --- a/src/HsH-classes.ins +++ /dev/null @@ -1,64 +0,0 @@ -%% -%% Copyright (C) 2021 by Jan Wille <mail@janwille.de> -%% -%% This file may be distributed and/or modified under the conditions of -%% the LaTeX Project Public License, either version 1.3 of this license -%% or (at your option) any later version. The latest version of this -%% license is in: -%% -%% http://www.latex-project.org/lppl.txt -%% -%% and version 1.3 or later is part of all distributions of LaTeX version -%% 2005/12/01 or later. -%% - -\input docstrip.tex -\keepsilent -\askforoverwritefalse - -\preamble - -This is a generated file. - -Copyright (C) 2021 by Jan Wille <mail@janwille.de> - -This file may be distributed and/or modified under the conditions of -the LaTeX Project Public License, either version 1.3 of this license -or (at your option) any later version. The latest version of this -license is in: - - http://www.latex-project.org/lppl.txt - -and version 1.3 or later is part of all distributions of LaTeX version -2021/01/01 or later. - -\endpreamble - -%\BaseDirectory{.} \UseTDS - -\usedir{tex/latex/HsH-Classes} -\generate{ - \file{HsH-article.cls}{\from{HsH-classes.dtx}{article}} - \file{HsH-report.cls}{\from{HsH-classes.dtx}{report}} - \file{HsH-standalone.cls}{\from{HsH-classes.dtx}{standalone}} - \nopreamble\nopostamble - \file{config.tex}{\from{HsH-classes.dtx}{config}} -} - -\obeyspaces -\Msg{*************************************************************} -\Msg{* *} -\Msg{* To finish the installation you have to move the following *} -\Msg{* file into a directory searched by TeX: *} -\Msg{* *} -\Msg{* HsH-logo.pdf *} -\Msg{* HsH-article.cls *} -\Msg{* HsH-report.cls *} -\Msg{* HsH-standalone.cls *} -\Msg{* config.tex *} -\Msg{* *} -\Msg{* Happy TeXing! *} -\Msg{* *} -\Msg{*************************************************************} - -\endbatchfile diff --git a/src/HsH-report.cls b/src/HsH-report.cls index b36c9a226e114834f2e23afed0537be995a14e29..6d9dd63a22b195f9ba810faea554cc9b9d10f53c 100644 --- a/src/HsH-report.cls +++ b/src/HsH-report.cls @@ -6,31 +6,26 @@ %% %% HsH-classes.dtx (with options: `report') %% -%% This is a generated file. +%% Copyright (C) 2024 by Jan Wille <mail@janiwlle.de> %% -%% Copyright (C) 2021 by Jan Wille <mail@janwille.de> +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License (LPPL), either +%% version 1.3c of this license or (at your option) any later +%% version. The latest version of this license is in the file: %% -%% This file may be distributed and/or modified under the conditions of -%% the LaTeX Project Public License, either version 1.3 of this license -%% or (at your option) any later version. The latest version of this -%% license is in: -%% -%% http://www.latex-project.org/lppl.txt -%% -%% and version 1.3 or later is part of all distributions of LaTeX version -%% 2021/01/01 or later. +%% http://www.latex-project.org/lppl.txt %% \typeout{Adapted from KOMA script for use in Hochschule Hannover <2023-08-12> Jan Wille} \NeedsTeXFormat{LaTeX2e} -\newcommand{\myClassName}{HsH-report} -\ProvidesClass{\myClassName}[2023/08/12 v2.1 HsH-Class based on KOMA] +\newcommand{\HsHClassName}{HsH-report} +\ProvidesClass{\HsHClassName}[2023/08/12 v2.1 HsH-Class based on KOMA] %% commands for HsH-logo \newcommand{\HsHlogoPath}{HSH-Logo.pdf} \newcommand{\HsHlogoPage}{1} \newcommand{\includeHsHlogohere}[1][5cm]{ \IfFileExists{\HsHlogoPath}{}{ - \ClassError{\myClassName}{HsH-Logo.pdf not found!}{ + \ClassError{\HsHClassName}{HsH-Logo.pdf not found!}{ The HsH Logo is necasary for the titlepage! Try putting it next to your source file or use \HsHlogoPath to define the file location } } @@ -254,10 +249,10 @@ \@ifpackageloaded{subfigure}{ \newcommand{\subfigureautorefname}{\figureautorefname} }{} - \InputIfFileExists{config.tex}{ - \ClassInfo{\myClassName}{config.tex was found. Using it...} + \InputIfFileExists{HsH-classes.cfg}{ + \ClassInfo{\HsHClassName}{HsH-classes.cfg was found. Using it...} }{ - \ClassInfo{\myClassName}{no config.tex!! I hope you configered it yourself.} + \ClassInfo{\HsHClassName}{no HsH-classes.cfg!! I hope you configered it yourself.} } %% provide some usefull commands: \providecommand{\abs}[1]{\ensuremath{\left\vert#1\right\vert}} @@ -351,7 +346,7 @@ \begin{titlepage} \let\@param#1 \ifx\@param\@empty - \ClassError{\myClassName}{\maketitle\space with empty option}{ + \ClassError{\HsHClassName}{\maketitle\space with empty option}{ \maketitle[] has been called with an empty parameter, this doesn't work. Use \maketitle instead. } \fi diff --git a/src/HsH-standalone.cls b/src/HsH-standalone.cls index fe7782eb62ffcba27ae6f3fd87b0e2c83b9bb23b..5a09a95bafb8756ea7b3b688d47854938a60bcd1 100644 --- a/src/HsH-standalone.cls +++ b/src/HsH-standalone.cls @@ -6,31 +6,26 @@ %% %% HsH-classes.dtx (with options: `standalone') %% -%% This is a generated file. +%% Copyright (C) 2024 by Jan Wille <mail@janiwlle.de> %% -%% Copyright (C) 2021 by Jan Wille <mail@janwille.de> +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License (LPPL), either +%% version 1.3c of this license or (at your option) any later +%% version. The latest version of this license is in the file: %% -%% This file may be distributed and/or modified under the conditions of -%% the LaTeX Project Public License, either version 1.3 of this license -%% or (at your option) any later version. The latest version of this -%% license is in: -%% -%% http://www.latex-project.org/lppl.txt -%% -%% and version 1.3 or later is part of all distributions of LaTeX version -%% 2021/01/01 or later. +%% http://www.latex-project.org/lppl.txt %% \typeout{Adapted from KOMA script for use in Hochschule Hannover <2023-08-12> Jan Wille} \NeedsTeXFormat{LaTeX2e} -\newcommand{\myClassName}{HsH-standalone} -\ProvidesClass{\myClassName}[2023/08/12 v2.1 HsH-Class based on KOMA] +\newcommand{\HsHClassName}{HsH-standalone} +\ProvidesClass{\HsHClassName}[2023/08/12 v2.1 HsH-Class based on KOMA] %% commands for HsH-logo \newcommand{\HsHlogoPath}{HSH-Logo.pdf} \newcommand{\HsHlogoPage}{1} \newcommand{\includeHsHlogohere}[1][5cm]{ \IfFileExists{\HsHlogoPath}{}{ - \ClassError{\myClassName}{HsH-Logo.pdf not found!}{ + \ClassError{\HsHClassName}{HsH-Logo.pdf not found!}{ The HsH Logo is necasary for the titlepage! Try putting it next to your source file or use \HsHlogoPath to define the file location } } @@ -98,10 +93,10 @@ %% load config at beginning of document \AtBeginDocument{ \makeatletter - \InputIfFileExists{config.tex}{ - \ClassInfo{\myClassName}{config.tex was found. Using it...} + \InputIfFileExists{HsH-classes.cfg}{ + \ClassInfo{\HsHClassName}{HsH-classes.cfg was found. Using it...} }{ - \ClassInfo{\myClassName}{no config.tex!! I hope you configered it yourself.} + \ClassInfo{\HsHClassName}{no HsH-classes.cfg!! I hope you configered it yourself.} } %% provide some usefull commands: \providecommand{\abs}[1]{\ensuremath{\left\vert#1\right\vert}} diff --git a/src/README.md b/src/README.md index 768541f69ff38c131774b57337e889b6d342abda..e97a3413a542e91d495cf2242be68f8d08236218 100644 --- a/src/README.md +++ b/src/README.md @@ -1,3 +1,10 @@ -# The sources Folder + HsH-classes | LaTeX for the Hochschule Hannover + -----------:| ------------------------------------------------------------ + Author | Jan Wille + E-mail | <mail@janiwlle.de> + License | Released under the LaTeX Project Public License v1.3c or later + See | <http://www.latex-project.org/lppl.txt> -This folder is for additional source files. It provides the custom classes and support files. \ No newline at end of file +This Project containes classes to create documents for the Hochschule Hannover. + +To use them in you projects bring this folder on you `TEXINPUTS`.