Added support for the acro package. (1cd0b81a) · Commits · kcss / kcss-style

ifiseries.sty

+55 −1

Original line number	Diff line number	Diff line
		@@ -24,7 +24,9 @@
		\DeclareStringOption[1.3]{pgfplotscompat}
		\DeclareBoolOption[true]{algorithmForwardCompatibility}
		\DeclareBoolOption[true]{algorithmBackwardCompatibility}
		\DeclareStringOption[acronym]{acronymPackage}
		\DeclareStringOption[smaller,nohyperlinks,printonlyused]{acronymOptions}
		\DeclareStringOption[4em]{acroLabelWidth}
		\DeclareStringOption[]{hyphenatOptions}
		\DeclareStringOption[caption=false,font=footnotesize]{subfigOptions}
		\DeclareStringOption[]{theorems}
		@@ -267,7 +269,59 @@
		\RequirePackage{changes}
		\normalem

		\RequirePackage[\ifiseries@acronymOptions]{acronym}
		\ExplSyntaxOn
		\str_case:onF{\ifiseries@acronymPackage}{
		{acronym} {
		\RequirePackage[\ifiseries@acronymOptions]{acronym}%
		}
		{acro} {
		\RequirePackage{acro}%
		% We need a custom list to make sure the list item indentation works properly with extra information
		\newlist{kcssacronyms}{description}{1}
		\setlist[kcssacronyms]{
		leftmargin = !,
		labelwidth=\ifiseries@acroLabelWidth
		}
		% Define custom list and extra styles
		\DeclareAcroListStyle{kcssacrolist}{list}{
		list = kcssacronyms
		}
		\DeclareAcroExtraStyle{newline}{inline}{
		brackets = false,
		punct = true,
		punct-symbol = \\
		}
		% Basic acro setup with sensible defaults
		\acsetup{
		extra-format = {\footnotesize},
		extra-style = newline,
		label-prefix = lbl:,
		list-caps = true,
		list-heading = chapter*,
		list-short-width = 10em,
		list-style = kcssacrolist,
		hyperref = false,
		page-style = none,
		short-format = {\smaller},
		sort = true,
		}
		% Our list name depends on the language
		\str_case:on{\ifiseries@language}{
		{english} {
		\acsetup{
		list-name = List\ of\ Acronyms,
		}
		}
		{german} {
		\acsetup{
		list-name = Akronymverzeichnis,
		}
		}
		}
		}
		}{\PackageError{ifiseries}{Unsupported~acronyms~package:~\ifiseries@acronymPackage}\@ehc}
		\ExplSyntaxOff

		\RequirePackage{xspace}
		\RequirePackage[\ifiseries@hyphenatOptions]{hyphenat}
		\RequirePackage[shortcuts]{extdash}

manual.tex

+43 −1

Original line number	Diff line number	Diff line
		@@ -942,6 +942,8 @@ See \autoref{sub:bibliography} for more details on bibliographies.
		about acronyms such as a list of acronyms or providing a long version of the acronym when it is
		used for the first time such as for \ac{XML} and \ac{UML} above. Additionally acronyms are
		typeset a little bit smaller in order to better integrate into normal text.
		As an alternative to \lstinline\|acronyms\|, the style also supports the \lstinline\|acro\| package,
		as explained in \autoref{sub:acronyms}.
		\item[Generic Title Page:]
		For the generic title pages,
		the macro \lstinline\|\gentitlepage\| is provided.
		@@ -1281,6 +1283,36 @@ You may choose between the following:



		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
		\subsection{Choosing an Acronyms System}
		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
		\label{sub:acronyms}

		The acronyms system provides a way to handle acronyms
		and have the system handle all the details,
		such as when to fully spell it out or producing a handy list of used acronyms.
		You may choose between the following:
		\begin{description}[font=\tt]
		\item[acronymPackage=acronym]
		The \lstinline!acronym! package is used.
		This is the default.
		The package is configured to use a smaller font
		for printing the acronyms.
		\item[acronymPackage=acro]
		The \lstinline!acro! package is used.
		This package has more features than the other one.
		We provide a reasonable standard configuration,
		but that configuration can be changed by using the package's
		\lstinline\|\acsetup\| command.
		The list of acronyms is setup in a way
		that extra information provided for acronyms
		are printed on a separate line in a smaller font.
		You should use the style's \lstinline\|acroLabelWidth\| option
		to make sure that the list of acronyms renders properly.
		\end{description}



		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
		\subsection{Reducing Margins}
		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
		@@ -2104,9 +2136,18 @@ combined with the \lstinline\|article\| class.
		%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

		\begin{description}[font=\tt]
		\item[acronymPackage]
		Which package to use for handling acronyms.
		Valid options are \lstinline\|acronyms\| and \lstinline\|acro\|.
		\item[acronymOptions]
		Options to be passed to the \lstinline\|acronym\| package.
		The default is \\\lstinline\|smaller,nohyperlinks,printonlyused\|.
		\item[acroLabelWidth]
		If the \lstinline\|acro\| package is used,
		this specified the amount of space reserved for the acronyms
		on the left side of the list of acronyms.
		The default is \lstinline\|4em\|, and may have to be increased
		to suit your particular list of acronyms.
		\item[babelOptions]
		Options to pass to the \lstinline\|babel\| package.
		Default is \lstinline\|ngerman,english\|,
		@@ -2210,6 +2251,7 @@ An article on A4 paper:
		Removed support for the \lstinline\|legacytexlive\| option
		and updated the style to work with current installations.
		We now recommend to use at least \TeX\ Live 2015.
		Also added support for the \lstinline\|acro\| package.

template-bachelormaster.tex

+4 −5

Original line number	Diff line number	Diff line
		@@ -5,15 +5,14 @@
		%%% then Ctrl-j should navigate to the next such field.

		\documentclass[10pt]{book}
		\usepackage[theorems=numbersfirst,bibresource={template-bachelormaster.bib}]{ifiseries}
		\usepackage[language=english,theorems=numbersfirst,bibresource={template-bachelormaster.bib}]{ifiseries}
		% <++PERHAPS CHANGE NAME OF BIBLIOGRAPHY RESOURCE ON LINE ABOVE++>
		\begin{document}
		% <++USE language=german IF YOUR DOCUMENT WILL BE IN GERMAN ++>

		% the language has to be selected before the title page is created
		\selectlanguage{english}
		%\selectlanguage{ngerman} % Falls Deutsch die Sprache der Wahl sein soll
		\begin{document}

		\frontmatter

		\studtitlepage%
		{<++TITLE++> \\[.1em]
		<++OVER TWO LINES++>}%