Documented more options.

parent 6cd831fd
......@@ -11,14 +11,9 @@
%
% - rename ifiseries.sty --> kcssStyle.sty ?
% - include texteqn, etc. into ifiseries.sty and document them
% - document "algorithm=" option
% - document "biblatexAdditionalOptions=" option
% - document how to change font in bibliography, namely by \renewcommand*{\bibfont}{\small}
% - document "includehead" option
% - document "onemargin" option
% - document "margincontrol" option
% - document "mathabx" option
% - document "hyphenatOptions" option
% - document "txfonts" option
% - document "PalatinoSC" option
% - document "pgfplotscompat" option
......@@ -1081,23 +1076,15 @@ must be approved by QA when publishing in the Series.
\subsection{When Using an Outdated \TeX\ Live}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
When using \TeX\ Live version 2009 or earlier
(perhaps this also applies to version 2010),
it may be necessary to use the \lstinline|legacytexlive=true| option.
You should first try to get away without it,
but if problems arise then try using this option.
One of the major effects of this option is
that \lstinline|bibtex| will be used for the bibliography (if any)
instead of the newer and recommended \lstinline|biblatex|.
\par
To use this style,
we recommend a \TeX\ Live at least as recent as version 2015.
If something does not work because your \TeX installation is too old,
the first step should be to install a more recent version.
Many Linux distributions offer \LaTeX\ as packages,
but those are most often outdated and not good enough.
Installing \TeX\ Live\footnote{\url{http://www.tug.org/texlive/}}
manually is easy and gives an up\-/to\-/date \LaTeX\ system.
At the time of writing, Ubuntu still ships with the heavily outdated \TeX\ Live 2009.
Although we recommend a more recent version (at least version 2011)
it is possible to use the Series' style with \TeX\ Live 2009,
using the \lstinline|legacytexlive=true| option.
but those can be outdated and not good enough.
Installing \TeX\ Live\footnote{\url{http://www.tug.org/texlive/}} manually
is easy and gives an up\-/to\-/date \LaTeX\ system.
When using Ubuntu, be sure to install the \lstinline|texlive-full| package.
......@@ -1147,6 +1134,12 @@ see the \lstinline|biblatex| documentation.
It is also admissable to leave the \lstinline|bibresource| option empty
and only use \lstinline|\addbibresource| manually.
The font size of the bibliography can be influenced
by redefining the \lstinline|\bibfont| command like this:
\begin{lstlisting}
\renewcommand*{\bibfont}{\small}
\end{lstlisting}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
......@@ -1222,19 +1215,14 @@ see the documentation of the \lstinline|babel| package for details.
In case that German is the main language, the option \lstinline|language=german| should be used.
This makes German the default language and takes care of some additional adjustments,
like dotted numbers in section headings.
\par
Another important change concerns the bibliography if
\lstinline|bibtex| is used instead of \lstinline|biblatex|.
Then the style attempts to provide support for a German bibliography
using \lstinline|babelbib|.
The default and recommended way however
is to let the style use \lstinline|biblatex| and \emphasis{not} \lstinline|bibtex|.
When \lstinline|legacytexlive| is given,
then this default automatically changes in favor of \lstinline|bibtex|,
since \lstinline|biblatex| is not available under older \TeX\ Live versions.
So the combination of \lstinline|legacytexlive=true| and \lstinline|language=german|
effects some profound changes on the bibliography.
\par
When using \lstinline|biblatex|,
be sure to add appropriate \lstinline|hyphenation| fields in your BibTeX database
to declare the language of each bibliography entry.
......@@ -1867,6 +1855,12 @@ combined with the \lstinline|article| class.
\item[bindingcorrection]
This text block is shifted outwards by this amount.
The default is $\unit[0]{mm}$.
\item[includehead]
If \lstinline|true|, headers and footers are part of the text block,
reducing the amount of space available for the actual text,
but keeping the page margins free.
If \lstinline|false|, the header and the footer will be part of the margins.
Default is \lstinline|true|.
\item[hcenter]
A Boolean option.
If \lstinline|true|, the inner and outer margins are made equally wide
......@@ -1972,7 +1966,7 @@ combined with the \lstinline|article| class.
\begin{description}[font=\tt]
\item[biblatex]
A Boolean option controlling whether the \lstinline!biblatex! package is loaded.
The default is \lstinline!true!, unless \lstinline|legacytexlive| is given.
The default is \lstinline!true!.
\item[biblatexstyle]
The style to use with \lstinline|biblatex|, if using \lstinline|biblatex|.
The value of this option is passed to the \lstinline|style=| option of \lstinline|biblatex|.
......@@ -1990,19 +1984,18 @@ combined with the \lstinline|article| class.
plus some additional options.
\item[babelbib]
A Boolean option controlling whether the \lstinline|babelbib| package is loaded.
The default is \lstinline|false|,
unless \lstinline|legacytexlive| and \lstinline|language=german| is given.
The default is \lstinline|false|. Only change this option to \lstinline|true|
when you need to use \lstinline|bibtex| instead of \lstinline|biblatex|
and the document's language is German.
\item[natbib]
A Boolean option controlling whether the \lstinline!natbib! package is loaded.
The default is \lstinline!false!, unless \lstinline|legacytexlive| is given.
The default is \lstinline!false!.
\item[natbibOptions]
Options to pass to the \lstinline!natbib! package, if loaded.
The default is \lstinline!sort,numbers!.
\item[bibliographystyle]
The bibliography style to use for \lstinline|bibtex|.
Default is \lstinline|alphaurl|,
but when \lstinline|language=german| and \lstinline|legacytexlive| are given,
the default is \lstinline|babalpha|.
Default is \lstinline|alphaurl|.
This option is ignored when using \lstinline|biblatex|;
then \lstinline|biblatexstyle| and\linebreak
\lstinline|biblatexOptions| can be used to tune the bibliography style
......@@ -2023,6 +2016,9 @@ combined with the \lstinline|article| class.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{description}[font=\tt]
\item[algorithm]
Whether the \lstinline|algorithm2e| package should be loaded.
Default is \lstinline|true|.
\item[algorithmOptions]
Options to pass to the \lstinline|algorithm2e| package.
Default is:
......@@ -2110,7 +2106,7 @@ combined with the \lstinline|article| class.
\begin{description}[font=\tt]
\item[acronymOptions]
Options to be passed to the \lstinline|acronym| package.
The default is \lstinline|smaller,nohyperlinks,printonlyused|.
The default is \\\lstinline|smaller,nohyperlinks,printonlyused|.
\item[babelOptions]
Options to pass to the \lstinline|babel| package.
Default is \lstinline|ngerman,english|,
......@@ -2120,6 +2116,9 @@ combined with the \lstinline|article| class.
the default is \lstinline|english,ngerman|.
The language can be switched inside the document using the \lstinline|\selectlanguage| command
or the \lstinline|otherlanguage| environment.
\item[hyphenatOptions]
Options to pass to the \lstinline|hyphenat| package.
Default is empty.
\item[inputencOptions]
The input encoding to choose.
Default is \lstinline|utf8|.
......@@ -2127,18 +2126,8 @@ combined with the \lstinline|article| class.
Controls defaults for
\lstinline|babelOptions|, \lstinline|variorefOptions|, \lstinline|refname|,
and\linebreak \lstinline|dottednumbers|.
If \lstinline|legacytexlive| is given, also controls defauls for
\lstinline|babelbib| and \lstinline|bibliographystyle|.
Possible values are \lstinline|language=english| (the default)
and \lstinline|language=german|.
\item[legacytexlive]
A Boolean option controlling whether certain features not available
in older \TeX\ Live versions shall be avoided.
Default is \lstinline|false|, which assumes \TeX\ Live version 2011 or newer.
Setting to \lstinline|true| has the following effects:
default to \lstinline|natbib=true| and \lstinline|biblatex=false|.
If \lstinline|language=german|, then also load the \lstinline|babalpha| package
and make \lstinline|bibliographystyle=babalpha| default.
\item[variorefOptions]
Options to pass to the \lstinline|varioref| package.
Default are no options if \lstinline|language=english|.
......@@ -2214,6 +2203,16 @@ An article on A4 paper:
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection*{2017-04-13}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
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.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection*{2017-04-12}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
......
......@@ -7,7 +7,6 @@
\documentclass[10pt]{book}
\usepackage[theorems=numbersfirst,bibresource={template-bachelormaster.bib}]{ifiseries}
% <++PERHAPS CHANGE NAME OF BIBLIOGRAPHY RESOURCE ON LINE ABOVE++>
% <++ALSO, TRY ADDING 'legacytexlive=true' IF BIBLATEX IS NOT FOUND++>
\begin{document}
% the language has to be selected before the title page is created
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment