manual.tex 102 KB
Newer Older
Lasse Kliemann's avatar
Lasse Kliemann committed
1 2
\documentclass[11pt,twoside]{article}
\usepackage[compact=,paper=a4paper,largepaper=true,bibresource=manual.bib,hcenter=true]{ifiseries}
3
\usepackage{todonotes}
Lasse Kliemann's avatar
Lasse Kliemann committed
4 5 6 7

\newcommand{\term}[1]{\emph{#1}}
\newcommand{\emphasis}[1]{\emph{#1}}
\newcommand{\fnt}[1]{\emph{#1}}
8
\newcommand{\urnnbn}{URN:NBN\xspace}
Lasse Kliemann's avatar
Lasse Kliemann committed
9 10 11 12 13 14 15 16

%% TODO
%
% - rename ifiseries.sty --> kcssStyle.sty ?
% - include texteqn, etc. into ifiseries.sty and document them
% - document "onemargin" option
% - document "margincontrol" option
% - document "mathabx" option
Lasse Kliemann's avatar
Lasse Kliemann committed
17
% - document "txfonts" option
18
% - document "PalatinoSC" option
19
% - document "pgfplotscompat" option
20 21
% - document "xcolor" option and explain that the "xcolor" package conflicts with the "trackchanges" package
%   maybe write a bit about collaborative editing
Lasse Kliemann's avatar
Lasse Kliemann committed
22
% - hint more in direction of BoD's paper format
Lasse Kliemann's avatar
Lasse Kliemann committed
23 24 25 26 27 28 29 30 31

\begin{document}
\raggedbottom

\title{Kiel Computer Science Series\\
{\smaller Manual}}
\date{ }
\maketitle

32 33 34 35 36 37 38 39 40 41 42



   %
  % %   %%%%%   %%%%  %%%%% %%%%%    %%    %%%%  %%%%%
 %   %  %    % %        %   %    %  %  %  %    %   %
%     % %%%%%   %%%%    %   %    % %    % %        %
%%%%%%% %    %      %   %   %%%%%  %%%%%% %        %
%     % %    % %    %   %   %   %  %    % %    %   %
%     % %%%%%   %%%%    %   %    % %    %  %%%%    %

Lasse Kliemann's avatar
Lasse Kliemann committed
43
\begin{abstract}
44
  This manual describes the \enquote{Kiel Computer Science Series}, the
Lasse Kliemann's avatar
Lasse Kliemann committed
45
  Institution Series of the Department of Computer Science
46
  (Institut für Informatik) at Kiel University (Christian\-/Albrechts\-/Universität zu Kiel),
Lasse Kliemann's avatar
Lasse Kliemann committed
47 48
  in the following called \term{Series}.
  \par
49 50
  Advanced users of the Series' \LaTeX\ style
  can consult \autoref{sec:news} at the very end of this manual
Lasse Kliemann's avatar
Lasse Kliemann committed
51 52 53 54 55
  in order to follow recent development.
\end{abstract}

\tableofcontents

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73



%%%%%%%                  %    %  %%%%%   %%%%%   %%%%%
   %    %    % %%%%%%    %   %  %     % %     % %     %
   %    %    % %         %  %   %       %       %
   %    %%%%%% %%%%%     %%%    %        %%%%%   %%%%%
   %    %    % %         %  %   %             %       %
   %    %    % %         %   %  %     % %     % %     %
   %    %    % %%%%%%    %    %  %%%%%   %%%%%   %%%%%

\section{The Kiel Computer Science Series}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Scope}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Lasse Kliemann's avatar
Lasse Kliemann committed
74 75 76
The following works written at the Department of Computer Science
are eligible to be published in the Series:
\begin{itemize}
77 78 79 80 81 82
  \item Dissertations\footnote{%
        Note that the electronic publication in this series
        is not the electronic publication the ``Promotionsordnung'' requires.
        However, you can simply submit the PDF produced for this series
        at the University Library to fulfill your obligations.}
        and habilitation treatises.
Lasse Kliemann's avatar
Lasse Kliemann committed
83 84 85
  \item Lecture notes and textbooks of sufficient quality.
  \item Surveys, collections, handbooks, and alike of sufficient quality.
\end{itemize}
86
\smallskip
Lasse Kliemann's avatar
Lasse Kliemann committed
87 88 89 90
The following works are \emphasis{not} eligible to be published in the Series:
\begin{itemize}
  \item Student's thesis, \eg Bachelor's, Master's, and Diploma theses.
  \item Technical reports.
91
	There is a separate infrastructure for technical reports
Lasse Kliemann's avatar
Lasse Kliemann committed
92 93 94 95 96
  at the Department of Computer Science in Kiel.\footnote{\url{http://www.informatik.uni-kiel.de/ifi/forschung/technische-berichte/}}
  \item Yet unpublished original research, save dissertations and habilitation treatises.
\end{itemize}
\par\smallskip
The Series' \LaTeX\ style may be used also for works not published in the Series.
97
However, only works published in the Series
Lasse Kliemann's avatar
Lasse Kliemann committed
98 99 100 101 102
(which includes approval by our Quality Assurance, explained below)
are allowed to bear the name \enquote{Kiel Computer Science Series}
and its acronym KCSS.
Also, the KCSS book cover may only be used when publishing in the Series.

103 104 105 106 107 108


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Rationale}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Lasse Kliemann's avatar
Lasse Kliemann committed
109 110
The aims of this series are twofold.
\begin{enumerate}[label=(\roman*)]
111
  \item
Lasse Kliemann's avatar
Lasse Kliemann committed
112
    It shall provide technical and administrative support to authors.
113
    It shall help and encourage authors to create high\-/quality documents
Lasse Kliemann's avatar
Lasse Kliemann committed
114 115 116 117 118 119
    with a unified appearance,
    and publish them in printed and electronic form.
  \item
    It shall provide a means for authors to emphasize the quality
    and maturity of their work.
    This is particularly interesting for lecture notes, text books, surveys, \etc.
120
    The Series provides an alternative to the `traditional' way
Lasse Kliemann's avatar
Lasse Kliemann committed
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
    of using a commercial publisher.
    Note that with the Series, all rights remain with the author
    -- the Department of Computer Science merely demands that
    the author gives his or her permission to the Department to publish the work
    electronically (as PDF) without charge.
    This way it is ensured that a maximum number of people can benefit from the work,
    students in particular.
\end{enumerate}
\par
A \LaTeX\ style was developed for the Series.
This style is intended to 1) spare the author the burden of having to design a style from scratch,
and to 2) achieve a common look and feel for all works published in the Series.
This covers basic settings such as paper size and fonts but also details such as heading and enumeration styles.
This style is carefully developed with an eye on good typography, or what at least a majority of literature presents as good typography.
Thus we recommend to use the default settings, also in line with the objective of a common look and feel for the Series.
However, the intention is that the KCSS and its style should serve the authors and not the other way around.
Thus, the KCSS style provides many options to adjust the layout,
138
and if an author \emph{strongly} wishes to deviate from the default,
Lasse Kliemann's avatar
Lasse Kliemann committed
139 140 141 142
for example to reduce the overall number of pages (see \autoref{sec:efficient-pages}), the author should feel free to do so.
\par
Experience has shown that the KCSS style is quite easy to use if it is used from the beginning on,
rather than converting a document that is originally written in another style.
143
We thus recommend to use this style right away, and to contact the style authors immediately if there are questions or comments.
Lasse Kliemann's avatar
Lasse Kliemann committed
144
\par
145
Following the open\-/access spirit of the KCSS, the KCSS style itself may be freely used outside the KCSS as well.
Lasse Kliemann's avatar
Lasse Kliemann committed
146
In particular, it is recommended to use this style also for Bachelor's and Master's theses,
147 148 149 150 151 152
and the KCSS style provides specific package options for these use cases
(see \autoref{sub:examples} for details on where to find appropriate examples).



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
153
\subsection{Contacts and Locations}
154 155 156
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\label{sub:where}

157 158 159 160 161 162 163 164 165 166 167 168
If you need help, the following people are available to help you:

\begin{itemize}
  \item Reinhard von~Hanxleden \href{mailto:rvh@informatik.uni-kiel.de}{rvh@informatik.uni-kiel.de}
        (Organization and QA)
  \item Christoph Daniel Schulze \href{mailto:cds@informatik.uni-kiel.de}{cds@informatik.uni-kiel.de}
        (QA, \LaTeX\ questions, website, and other technical questions)
  % \item Lasse Kliemann \href{mailto:lki@informatik.uni-kiel.de}{lki@informatik.uni-kiel.de} (QA, \LaTeX\ questions, website, other technical questions)
  % \item Hauke Fuhrmann \href{mailto:haf@informatik.uni-kiel.de}{haf@informatik.uni-kiel.de} (Printing service, ISBN)
\end{itemize}

\noindent
169 170
The KCSS style itself is currently available at the following Git repository:

171 172 173
\begin{center}
  \url{https://git.informatik.uni-kiel.de/kcss/kcss-style}
\end{center}
174 175

\noindent
176 177 178 179
The manual and various other documentation files
(including a declaration of consent you need to sign
to publish a book as part of the Series)
are available at the following Git repository:
180

181 182 183
\begin{center}
  \url{https://git.informatik.uni-kiel.de/kcss/kcss-public}
\end{center}
Lasse Kliemann's avatar
Lasse Kliemann committed
184

185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200



%%%%%%
%     % %    % %%%%%  %      %  %%%%  %    % % %    %  %%%%
%     % %    % %    % %      % %      %    % % %%   % %    %
%%%%%%  %    % %%%%%  %      %  %%%%  %%%%%% % % %  % %
%       %    % %    % %      %      % %    % % %  % % %  %%%
%       %    % %    % %      % %    % %    % % %   %% %    %
%        %%%%  %%%%%  %%%%%% %  %%%%  %    % % %    %  %%%%

\section{Publishing in the Series}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
201 202
\subsection{The Process}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
203
\label{sec:publishing_process}
204

205 206
Writing and publishing your book is a considerable undertaking.
This part of the manual will walk you through the different stages
207 208 209 210
in quite a bit of detail.
Each stage starts with a short description of what it is about,
followed by a list of steps for you to follow.

211 212 213 214
Feel free to contact people if you want further information
before starting on your quest.
See \autoref{sub:where} for details on who you should contact.

215 216 217 218

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Preparations}

219
Before you even start writing your book,
220
you need to obtain the KCSS style and set everything up properly.
221 222
Once that is done, you are ready to start the real work
of writing your book.
223 224 225 226

\begin{enumerate}
  \item
    Get the KCSS style from its Git repository (see \autoref{sub:where}).
227
    The best idea is to clone the repository
228 229 230
    to be able to follow any updates to the style.

  \item
231
    Setup the repository you will be using for your book.
232
    Copy the required style files over to that repository
233 234
    (this will usually be all \texttt{.sty} files,
    but see the repository's readme file for details).
235 236

  \item
237 238
    If you are writing a dissertation,
    review the University Library's content and cover requirements
239 240 241 242 243 244 245
    and read about the dissertation publication process there.%
    \footnote{\url{http://macau.uni-kiel.de/content/main/publicateDiss.xml}}
    This may also be a good time to familiarize yourself
    with the process of getting your PhD as described by the faculty.%
    \footnote{\url{http://www.tf.uni-kiel.de/de/promotionen-und-habilitationen}}

  \item
246 247 248 249 250 251
    Think about whether you want to produce printed copies of your book
    and find one if you do.
    Note that for dissertations,
    there is no way around producing printed copies.
    Furthermore,
    the printed copies must comply with the University Library's requirements
252 253 254 255
    (see \autoref{sub:print} for details).
    Which printing service you choose will influence the page size you will be using.
    Making this decision early on will spare you the trouble of having to change the page size later,
    which would wreak havoc with your page layout.
256 257
    If you are not sure which printing service to choose,
    feel free to contact QA for suggestions.
258 259 260 261 262 263 264 265

  \item
    Setup your document, possibly based on the example dissertation we provide
    (see \autoref{sub:examples}).
    In particular,
    setup the page size properly
    and make sure you follow the general document structure
    outlined in \autoref{sub:structure}.
266 267
    If you are unsure how the structure applies to the book you are writing,
    feel free to contact QA.
268 269 270 271

  \item
    It might feel a bit early,
    but it is also a good idea to start setting up the cover now.
272 273
    Of course, you cannot finish that yet
    because you do not have all of the necessary information at this point.
274 275 276 277 278 279 280

\end{enumerate}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Writing}

281 282 283 284 285
Well, this stage is rather self-evident:
do science and write about it!
Collect conference papers and stick them together!
Write the book you have always dreamed of writing!
Whatever you do, produce text.
286 287


288
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
289
\subsubsection{Submitting (Dissertations Only)}
290

291 292
If what you are writing is a dissertation,
this is where things start to get slightly complicated.\footnote{%
293 294 295 296 297 298 299 300 301 302 303 304
  Since things are complicated,
  you should \emph{under no circumstances} rely only on the information given here.
  We have put those together based on the experience of former PhD students
  (successful ones, we should note),
  but things may be inaccurate or may simply have changed since then.
}
Over the course of the whole process,
you will produce two distinct versions of your thesis.
The first is the one you will submit to the reviewers
to start the actual examination process.
This stage is about producing that version.
The second is the one you will publish in the Kiel Computer Science Series.
305
We will talk about that version in upcoming stages.
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321

\begin{enumerate}
  \item
    \autoref{sub:structure} contains a table that lists which parts of the structure
    are required for each of the two versions.
    Make sure to remove all unnecessary parts
    and to prepare all necessary parts
    for the submission version.
    For example,
    at this stage you do not have enough data
    to generate the metadata page yet.
    Hence, that page should be removed.
    On the other hand,
    the University requires the submission version to contain a page
    on which you guarantee that you adhered to proper scientific conduct
    while producing the thesis.
322
    This page must be prepared and included.
323 324 325 326

  \item
    Produce four printed copies of the submission version of your thesis.
    Note that this is not your final KCSS version
327
    \emph{and is thus not the one produced by the printing service you selected previously}.
328 329 330 331 332 333 334 335 336 337 338 339 340
    Much rather, this will be a simple A4 printout
    printed by one of the local printing shops found around the University.
    Since the page size of your thesis will probably be smaller,
    you will need to scale it up to A4.
    Instead of setting a new page size on your thesis and thereby wrecking everything
    you have worked so hard to create,
    use \lstinline|pdfjam| on the PDF file:
    \begin{lstlisting}
        pdfjam --paper a4 file.pdf
    \end{lstlisting}

  \item
    Hand in your four copies, along with all the documents the faculty requires you to hand in.
341
    See the ``Promotionsordnung'' for further details on what exactly you will have to submit.
342 343 344 345 346 347 348 349
    Follow the examination process and ace the defense!

\end{enumerate}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Creating the Book Cover}

350
Once you start to think about producing the final version of your book,
351 352 353 354 355 356
it is time to announce this intention to the KCSS QA people
to obtain information you need for your printing version.

\begin{enumerate}

  \item
357 358
    Contact QA to announce your intention to publish a KCSS book
    (see \autoref{sub:where} for contact details).
359
    They will respond by issuing you a number
360
    (see \autoref{sub:numbers_versions}).
361 362 363 364 365 366 367 368

  \item
    Now that you have the KCSS number for your book,
    send the signed ``Einverständniserklärung'' (``Declaration of Consent'') to QA.
    This form gives the Department of Computer Science the rights
    to publish electronic versions of your work (as PDF) without charge.
    See \autoref{sub:where} for where to obtain the form.

369 370 371 372 373 374 375 376
    The library would also like to record author information.
    To make this easier,
    please also submit information such as
    your degree,
    the working group you are part of,
    and alternative spellings of your name.
    Optionally, your birthday or birth year.

377
  \item
378 379
    If you want your book to have its own ISBN number,
    it is your responsibility to request one.
380
    Your printing service may offer an ISBN number
381 382
    as part of your printing package
    (of course, all ISBN fees have to be covered by the author).
383
    Be sure to check with your printing service whether having a custom ISBN
384 385 386
    changes the way the printing service handles publishing rights.
    Some services require you to transfer copying rights,
    which is not a good idea since the printing service
387 388 389 390
    is not the only outlet where you will publish your thesis.\footnote{%
      Remember that the whole point of KCSS
      is to make information freely available.
    }
391 392 393 394 395 396 397

  \item
    Remember which printing service you selected when you started your quest.
    Go to its website and review its requirements for the book cover,
    including the size, bleeds, and so on.
    Setup the configuration of your book cover accordingly
    as described in \autoref{sec:cover}.
398 399 400
    If you have not chosen a printing service
    and are unsure how to setup your cover,
    feel free to contact QA.
401 402 403 404

  \item
    Write an interesting summary for your book to be printed on the cover's back,
    along with a short description of who you actually are.
405
    The summary may actually be an excerpt from your abstract.
406 407 408

  \item
    Draw a fancy picture to be printed on the cover's front.\footnote{%
409
      As one former PhD student notes:
410
      the picture should not be too fancy
Christoph Daniel Schulze's avatar
Christoph Daniel Schulze committed
411
      or else the existing covers would look lame in comparison\ldots}
412 413

  \item
414
    Make sure that you include the correct KCSS number on your cover.
415 416 417 418 419
    If you have an ISBN, include that as well;
    if you do not, leave the ISBN field blank.
    In particular, do not produce a bar code of the series' ISSN instead!

\end{enumerate}
420 421 422 423 424


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Creating the Publishing Version}

425 426 427 428 429 430 431 432
Having finished your book's cover,
we now turn to configuring the book's content properly.

\begin{enumerate}

  \item
    Activate or deactivate the different parts of your book
    according to \autoref{tab:structure}.
433 434 435
    For a dissertation,
    this includes listing your reviewers and your supervisor.
    Be sure to update your meta data page
436
    with the KCSS number you were given.
437
    The \urnnbn the meta data page requires
438
    will be issued in a later step.
439 440 441 442 443 444 445

  \item
    Your printing service may require your book's page count to be divisible by four.
    If so, make sure you include enough blank pages at the end.

\end{enumerate}

446 447 448 449

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Quality Assurance}

450
Your book is almost finished.
451
It is now time to check back with QA.
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472

\begin{enumerate}

  \item
    Check the QA checklist which is part of the KCSS documentation files
    (see \autoref{sub:where}).
    The list mentions the most common problems QA finds with KCSS submissions.
    Be sure to have those covered.

  \item
    Some printing services allow you to upload your cover and content
    prior to its submission for printing to check for problems.
    If that is possible with your printing service,
    make use of this feature now and fix any problems the printing service finds.

  \item
    Submit your book and cover PDF files to QA for approval.
    This will usually start a number of iterations of QA asking for changes
    and you implementing those changes
    until your book is ready to be published.

473 474
  \item
    Once QA is happy,
475
    they will issue a \urnnbn number
476 477 478 479 480
    to be included in your meta data page.
    Update that page accordingly
    and compile the final version
    of your book.
    Note that from now on
Christoph Daniel Schulze's avatar
Christoph Daniel Schulze committed
481
    your should not change the number of pages in your book.
482

483
\end{enumerate}
484 485 486 487 488


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Publishing and Printing}

489 490 491 492 493 494
It is almost over.
Here's what you need to do to finish this.

\begin{enumerate}

  \item
495 496 497 498
    Upload the files approved by QA to your printing service
    and produce the required number of printed copies.
    This number changes depending on what your are printing,
    as explained below.
499 500 501 502 503
    It is not important whether you produce soft covers or hard covers,
    but what is important is that you do not mix the two.
    Of course,
    you can skip this step if you have not chosen a printing service
    because you are not required to produce printed copies.
504 505

  \item
506 507 508 509 510 511 512 513 514
    Send the final version of your book to QA as PDF files
    (one for the content, one for the cover)
    to be made available in the Journals system.\footnote{%
      It used to be the case
      that we asked for two versions
      of your content PDF:
      one to be printed,
      and one with reduced margins for electronic viewing.
      This is not the case anymore.
515
      We only ask for the printable version now.
516 517 518 519
    }
    If printed copies can be ordered online,
    inform QA where orders can be placed,
    so that appropriate pointers can be put on the Series' website.
520 521 522

\end{enumerate}

523 524
How many copies you need to produce and hand in
depends on what kind of book you have written.
525

526
\begin{description}
527

528 529 530 531
  \item[Dissertation]
    If your book is your dissertation,
    there are a few copies you \emph{have} to produce
    and a few more you will probably \emph{want} to produce.
532

533 534 535
    \begin{itemize}
      \item
        4 copies to to be submitted for the university's library,
536 537 538 539
        as specified by the ``Promotionsordnung''.
        This is mandatory,
        along with submitting an electronic version of your dissertation
        to the university's library\footnote{%
540 541 542
        See \url{https://macau.uni-kiel.de/content/main/publicateDiss.xml}}
        since the KCSS publication is not the official electronic publication
        that the ``Promotionsordnung'' requires!
543 544
        See the link in the footnote
        for where to submit the printed copies.
545

546 547
      \item
        1 copy each for your supervisor and your reviewers (optional)
548

549 550
      \item
        1 copy for yourself (optional)
551

552 553
      \item
        1 copy for each relative that might be interested in your academic career (very optional)
554

555
    \end{itemize}
556 557


558 559 560 561
  \item[Something else]
    If your book is not a dissertation,
    but you want to make printed copies available,
    what you have to do depends on your deal with the printing service.
562

563 564
    If your printing service acts as your publisher,
    the printing service is required by law
565 566
    to send copies of your book to the National Library,
    so you don't need to do anything.
567

568 569 570
    If your printing service does not act as your publisher,
    the responsibility lies with you
    to submit enough copies to fulfill the legal obligations:
571

572
    \begin{itemize}
573

574 575
      \item
        2 copies for the German National Library (mandatory)
576

577 578
      \item
        1 copy for the university's library (mandatory)
579

580
    \end{itemize}
581

582 583 584
    All copies can be submitted to Birgit Mähl or Grit Reich
    at the institute's ``Fachbibliothek'',
    who will pass them on to the relevant institutions.
585

586 587
    If you are not sure which of these options applies to you,
    feel free to contact QA or your printing service.
588

589
\end{description}
590

591 592 593 594
% Note that softcover and hardcover are treated separately.
% For example, if you offer a softcover and a hardcover,
% and if softcover copies were given to the University Library as per item \ref{copies:1},
% then still three hardcover copies are required as per item~\ref{copies:2}.
595

596 597 598
Regardless of what you are printing,
the following copies are optional,
but have a certain potential to make people happy:
599

600 601 602 603 604 605 606 607 608 609 610 611 612
\begin{itemize}

  \item
    1 copy for the library of Schloss Dagstuhl,\footnote{\url{http://www.dagstuhl.de/en/library/}}
    the Leibniz Center for Informatics,
    which aims for an in\-/depth coverage of literature on computer science.\footnote{%
      Should you attend a future Dagstuhl seminar,
      this copy will be on display on a special shelf in the library during the seminar.}

  \item
    1 copy for Kiel University's Fachbibliothek for Mathematics and Computer Science

\end{itemize}
Lasse Kliemann's avatar
Lasse Kliemann committed
613

614 615 616


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
617
\subsection{Numbers and Revised Versions}
618
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
619
\label{sub:numbers_versions}
620 621 622 623 624 625 626

Works in the Series are numbered consecutively for each year,
starting with 1 in each new year.
So a particular work can be referred to by giving its year and that counter within the year,
\eg the number \enquote{2011/7} designates the 7th work in year 2011.
The number of a work is placed on the book cover at two locations:
on the spine and on the front.
627

628 629 630 631 632 633 634 635
The number of a work never changes
because its content can never change
once it has been published.
Nevertheless,
there is the possibility of publishing a revised edition
under a new KCSS number.\footnote{%
  In the old days,
  published edition could be replaced
636
  by a new \emph{version}.
637 638 639 640 641 642 643 644 645 646 647 648 649
  This is not possible any more.
  As explained, a revision requires
  a new document to be published,
  along with a new KCSS number.}
To do so,
simply announce your intention
to publish a revised edition to QA.
The process will for the most part
be similar to the publishing process
as described in \autoref{sec:publishing_process}.

The KCSS number appears at the beginning of the work on a page with meta data,
for example as \enquote{2011/7}.
650 651 652
This information optionally may be followed by the word \enquote{dated}
and then a date on which the version was published,
in order to give the reader an idea of how recent the version is,
653
how much time went by during two revisions, \etc.
654
If a date is given, it should be specified in ISO 8601 form, \ie \mbox{YYYY-MM-DD}.
655 656 657 658 659 660
For example, when work 2011/7 was first published on the 15th of November 2011,
then we write \enquote{2011/7 dated 2011-11-15}.
If the work is a revision of a previous work,
the previous work's KCSS number must be mentioned.
The KCSS style's \lstinline|\metapage| command
provides an argument to do so.
661 662 663 664 665 666



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Document Structure}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
667 668 669 670
\label{sub:structure}

Documents published in the Series should follow a particular structure.
If you are in the process of writing a dissertation,
671 672 673 674 675 676 677
some of the elements below are required for the final publication version,
but not for the version of your dissertation you submit for review.
This manual does not impose restrictions
on the structure of Bachelor's or Master's theses
since they are not published in the Series.
However, many of the parts mentioned in the following lists
simply do not make sense for them.
678
The differences are summarized in \autoref{tab:structure}.
679 680 681 682 683 684 685 686 687 688 689 690
\begin{enumerate}
  \item Title page.
    A macro \lstinline|\gentitlepage| is provided for generic title pages.
    For dissertations,
    a more specific title page can be generated with a macro \lstinline!\disstitlepage!.
    The use of those macros is demonstrated below
    and explained in more detail in \autoref{sub:features}.
    For a student's thesis, a macro \lstinline|\studtitlepage| is provided.
    See the examples referenced in \autoref{sub:examples}.
    Alternatively, \lstinline|\makegentitlepage|, \lstinline|\makedisstitlepage|,
    or \lstinline|\makestudtitlepage| can be used after setting parameters
    by appropriate \lstinline|\renewcommand|s, explained later.
691

692 693 694 695 696 697 698
  \item Meta information, on one page.
    This page should be generated using the \lstinline|\metapage| macro
    or alternatively by \lstinline|\makemetapage| after setting parameters via \lstinline|\renewcommand|
    as explained later.
    In particular, this macro prints the correct ISSNs.
    Its use is demonstrated below
    and explained in more detail in \autoref{sub:features}.
699 700 701 702 703 704 705
  
  \item A declaration of originality (for lack of a better word)
    to assert that the thesis is the author's own work.
    For bachelor's or master's theses,
    use the \lstinline|\studeidesstatt| command.
    For dissertations,
    use the \lstinline|\disseidesstatt| command.
706

707 708 709 710
  \item A chapter titled \enquote{About this Series}.
    The text for this chapter is the same for all works
    and is provided as a file \lstinline!about-this-series.tex!,
    which can be included.
711

712 713 714 715 716 717 718
  \item For dissertations,
    a page naming the reviewers and date of disputation.
    This page can be generated using the \lstinline|\dissreviewerpage| macro
    or alternatively the \lstinline|\makedissreviewerpage| macro after setting parameters via \lstinline|\renewcommand|
    as explained later.
    For a student's thesis, a macro \lstinline|\eidesstatt| is provided
    to be called at this point.
719

720 721 722
  \item Abstract. For dissertations and habilitation treatises,
    it is common to include both an English and a German version
    of the abstract if the rest of the work is in English.
723

724 725 726 727
  \item For dissertation and habilitation treatises,
    a preface written by the supervisor.
    This preface should be titled \enquote{Preface by \textit{SUPERVISOR}},
    where it would be a splendid idea to replace \textit{SUPERVISOR} by the supervisor's actual  name.
728

729 730 731 732 733 734 735
  \item A preface written by the author.
    If there is a preface by the supervisor,
    the preface by the author should be titled \enquote{Preface by the Author},
    otherwise just \enquote{Preface}.
    \par
    This preface may contain acknowledgements in a section
    titled \enquote{Acknowledgements}.
736

737
  \item The table of contents, generated with \lstinline!\tableofcontents!.
738

739
  \item If applicable, the list of figures, generated with \lstinline!\listoffigures!.
740

741
  \item If applicable, the list of tables, generated with \lstinline!\listoftables!.
742

743 744
  \item The main part of the work, divided into chapters.
    Additional divisions may be introduced using parts.
745

746
  \item Appendices, if any.
747

748 749 750 751
  \item Bibliography.
    More information on bibliographies can be found in \autoref{sub:bibliography}.
\end{enumerate}

752
\begin{table}
753 754 755 756
  \begin{tabular}{lccc} \toprule
    Element                      & Review Diss. & Final Diss.  & Student Thesis \\ \midrule
    Title page                   & \checkmark   & \checkmark   & \checkmark \\
    Meta information             &              & \checkmark   & \\
757
    Declaration of originality   & \checkmark   &              & \checkmark \\
758 759 760
    About this series            &              & \checkmark   & \\
    Reviewers                    &              & \checkmark   & \\
    Abstract                     & \checkmark   & \checkmark   & \checkmark \\
761
    Prefaces and acknowledgments & (\checkmark) & (\checkmark) & (\checkmark) \\
762 763 764 765 766
    Table of contents            & \checkmark   & \checkmark   & \checkmark \\
    List of figures and tables   & (\checkmark) & (\checkmark) & (\checkmark) \\
    Main content                 & \checkmark   & \checkmark   & \checkmark \\
    Appendices                   & (\checkmark) & (\checkmark) & (\checkmark) \\
    Bibliography                 & \checkmark   & \checkmark   & \checkmark \\\bottomrule
767
  \end{tabular}
768 769 770 771 772
  \caption{Differences between the review and final version of a dissertation
           as well as student's theses (Bachelor's and Master's thesis).
           A check mark indicates mandatory elements;
           a check mark in parentheses indicates optional elements;
           the absence of a check mark indicates that an element should not be present.}
773 774 775
  \label{tab:structure}
\end{table}

776 777 778 779 780


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Choosing a Printing Service}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
781
\label{sub:print}
782

Lasse Kliemann's avatar
Lasse Kliemann committed
783 784
In general, each author can choose a printing service of his or her choice,
because the Department of Computer Science has no interest
785
in creating any frame contract with a specific service provider
Lasse Kliemann's avatar
Lasse Kliemann committed
786 787 788 789
and does not want to profit financially.
Sales revenues are only to be used by the author and hence,
any legal contract is only between the author and the printing service.
\par
790
However, publishing in the Series means that the Department of Computer Science
791
at Kiel University is the \emphasis{editor} of the work and thus wants to achieve a common
Lasse Kliemann's avatar
Lasse Kliemann committed
792
look and feel of all issues. Hence, there are certain requirements to a printing service
793
listed below. As there is not the one\-/and\-/only perfect printing service,
Lasse Kliemann's avatar
Lasse Kliemann committed
794 795
recommendations of possible printing services can be obtained from QA.
Services differ in conditions, in particular concerning the rights of the author.
796 797 798 799
Another important detail is the pricing for printing in color.
Some services will only charge extra for each page that contains color,
whereas others will charge a higher price for \emphasis{every} page in the book
as soon as there is at least one page containing color.
Lasse Kliemann's avatar
Lasse Kliemann committed
800

801 802 803
Whatever printing service an author chooses,
it should meet the following criteria:

Lasse Kliemann's avatar
Lasse Kliemann committed
804 805 806 807
\begin{itemize}
  \item Paper format of a book in the Series is US Trade,
    which is $\unit[15.24]{cm} \times \unit[22.86]{cm}$
    and supported by at least one major printing service.
808
    The printing service should support this format
Lasse Kliemann's avatar
Lasse Kliemann committed
809 810 811 812
    or at least a format very close to this,
    \eg $\unit[15.5]{cm} \times \unit[22]{cm}$,
    as provided by another major printing service.
    This should be taken into consideration when you prepare the document,
813
    since paper format may have implications on layout.
Lasse Kliemann's avatar
Lasse Kliemann committed
814
  \item All works in the Series are also made available electronically (without charge)
815
    from a server run by the University.
816
    Hence it is required that the printing service allows that
Lasse Kliemann's avatar
Lasse Kliemann committed
817
    in the given circumstances.
818
  \item Authors may well make printed copies available for order online.
819 820
    If this is intended, the printing service needs to provide
    the necessary sales and distribution infrastructure for the book.
Lasse Kliemann's avatar
Lasse Kliemann committed
821
  \item If printed copies shall be made available for order,
822
    they should be offered as a laminated hardcover \emphasis{and}
Lasse Kliemann's avatar
Lasse Kliemann committed
823
    as a paperback version.
824
    The latter is intended to provide a low\-/priced version affordable for students.
Lasse Kliemann's avatar
Lasse Kliemann committed
825 826 827 828 829 830
  \item The hardcover should be a casewrap, not a dustjacket one.
  \item The background for the book cover should be white.
    The book cover should be matte, but at least not high gloss.
  \item If the option is given, a round spine should be preferred over a flat one.
\end{itemize}

831 832 833 834 835 836


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Choosing a Price for Printed Copies}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Lasse Kliemann's avatar
Lasse Kliemann committed
837 838 839 840 841 842 843
Usually, the price charged to customers who buy a printed copy
through the printing service can be set by the author.
The Department of Computer Science does not impose any hard limits
on how the author should choose that price.
However, the Series' focus is on \emphasis{maximum dissemination},
so authors are encouraged to choose a moderate price.
Note also that everyone in principle is able and allowed to
844 845
produce a printed copy for himself or herself from the PDF files
available on the University's servers;
Lasse Kliemann's avatar
Lasse Kliemann committed
846 847 848
this is intended.


849 850 851 852 853 854 855 856 857


%%%%%%                            %     %
%     %   %%    %%%%  %  %%%%     %     %  %%%%    %%    %%%%  %%%%%%
%     %  %  %  %      % %    %    %     % %       %  %  %    % %
%%%%%%  %    %  %%%%  % %         %     %  %%%%  %    % %      %%%%%
%     % %%%%%%      % % %         %     %      % %%%%%% %  %%% %
%     % %    % %    % % %    %    %     % %    % %    % %    % %
%%%%%%  %    %  %%%%  %  %%%%      %%%%%   %%%%  %    %  %%%%  %%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
858 859

\section{Basic Usage of the \LaTeX\ Style}
860

Lasse Kliemann's avatar
Lasse Kliemann committed
861 862 863 864 865 866 867 868 869 870 871 872 873 874
The style consists of two files \lstinline!ifiseries.sty! and \lstinline!localTheorem.sty!.
Compilation should be done with \lstinline!pdflatex!.
The most basic usage is like so:
\begin{lstlisting}
\documentclass[10pt]{book}
\usepackage{ifiseries}
\begin{document}
\end{document}
\end{lstlisting}
\par
A multitude of useful packages is loaded by the style,
so commonly you will only need a very few additional \lstinline|\usepackage| commands.
\par
By default, no theorem environments are defined.
875
To have a broad set of theorem environments available,
Lasse Kliemann's avatar
Lasse Kliemann committed
876 877 878 879 880 881 882 883 884 885 886
use the \lstinline|theorems| option.
It can be set to \lstinline|numbersfirst| or \lstinline|numberslast|.
Details are explained below.
Here is a short example with theorems enabled:
\begin{lstlisting}
\documentclass[10pt]{book}
\usepackage[theorems=numbersfirst]{ifiseries}
\begin{document}
\end{document}
\end{lstlisting}

887 888 889


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
890
\subsection{Compilation}
891 892
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
Suppose the main file is \lstinline|document.tex|.
When using \lstinline|biblatex|, the following sequence will compile everything:
\begin{lstlisting}
  pdflatex document
  biber --output_safechars document
  pdflatex document
\end{lstlisting}
The \lstinline|--output_safechars| option may or may not be required in your case, but usually does not hurt.
\par
When using \lstinline|bibtex|, use the following sequence:
\begin{lstlisting}
  pdflatex document
  bibtex document
  pdflatex document
  pdflatex document
\end{lstlisting}
\par
Sometimes, in particular when switching between bibliography systems,
temporary and auxiliary files need to be deleted.
This can be done by hand, or automated with a script or makefile.
Many version control systems have an option to delete all non-tracked files,
which can also be used for this
(see Mercurial's \lstinline|purge| command or Git's \lstinline|clean| command).
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
See \autoref{sub:bibliography} for more details on bibliographies.



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Helpful Features}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\label{sub:features}

\begin{description}
  \item[Latin Abbreviations:]
    Smart macros for common abbreviations are provided:
    \lstinline!\eg!,
    \lstinline!\ie!,
    \lstinline!\cf!,
    \lstinline!\Eg!,
    \lstinline!\Ie!,
    \lstinline!\Cf!,
    \lstinline!\etal!,
    \lstinline!\etc!,
    \lstinline!\vs!.
    The first six will automatically insert a comma and an \lstinline!\xspace!
    if not followed by a comma already.
    The last three will insert a dot and an \lstinline!\xspace!
    when not followed by a dot already.
    Any dots inserted by the macro, are also followed by \lstinline!\@!,
    which signals that here is not the end of a sentence.
    This is important for horizontal spacing.
  \item[Enumerations:]
    Compact versions of all three enumeration environments are provided:
    \begin{lstlisting}
      compactitemize
      compactenumerate
      compactdescription
    \end{lstlisting}
    They are often more appropriate when the enumeration
    semantically is part of a paragraph.
    \par
    (These environments are still provided when using \lstinline!layout=false!,
    but then they are not compact anymore.
    The \lstinline|layout| option is explained in \autoref{sec:options}
    and is not required for publishing in the Series.)
  \item[Smart References:]
    The \lstinline!hyperref! package's \lstinline!\autoref! feature is configured.
    Instead of \lstinline!\ref! you can use \lstinline!\autoref!
    and have the words \enquote{Chapter}, \enquote{Section}, \enquote{Theorem}, \etc
    automatically inserted.
    \newacro{XML}{Extensible Markup Language}
    \newacro{UML}{Unified Modeling Language}
  \item[Acronyms:] Acronyms like the \ac{XML} or \ac{UML} should be used with the \lstinline!acronym!
    package, which is already loaded and configured by default. It handles many useful features
    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.
970 971
    As an alternative to \lstinline|acronyms|, the style also supports the \lstinline|acro| package,
    as explained in \autoref{sub:acronyms}.
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
  \item[Generic Title Page:]
    For the generic title pages,
    the macro \lstinline|\gentitlepage| is provided.
    It takes the following $4$ arguments:
    \begin{enumerate}
      \item Title
      \item Subtitle
      \item Author(s)
      \item A text to be set at the bottom of the title page
    \end{enumerate}
  Alternatively, the title page can be generated with \lstinline|\makegentitlepage|
  after using \lstinline|\renewcommand| on the following commands:
  \lstinline|\titlepagetitle|,
  \lstinline|\titlepagesubtitle|,
  \lstinline|\titlepageauthor|,
  \lstinline|\titlepagetext|.
  \item[Dissertation Title Page:]
    For the mandatory title page for dissertations,
    the macro \lstinline|\disstitlepage| is provided
    (it performs an appropriate call to \lstinline|\gentitlepage|).
    It takes the following $5$ arguments:
    \begin{enumerate}
      \item Title
      \item Subtitle
      \item Name of candidate
      \item Indicator for the type of degree: either \lstinline!nat! or \lstinline!ing!
      \item Year of submission
    \end{enumerate}
  Alternatively, the title page can be generated with \lstinline|\makedisstitlepage|
  after using \lstinline|\renewcommand| on the following commands:
  \lstinline|\titlepagetitle|,
  \lstinline|\titlepagesubtitle|,
  \lstinline|\titlepageauthor|,
  \lstinline|\disstitlepagedegree| (defaults to \lstinline|nat|),
  \lstinline|\disstitlepageyear|.
  \item[Meta Data Page:]
    Each work must have a page with meta data.
    It can be created with the \lstinline|\metapage| macro.
1010
    It takes the following $9$ arguments:
1011
    \begin{enumerate}
1012
      \item Number of the work in the Series and an optional date.
1013
        \Eg, if the number of the work is 2011/99
1014
        and it was released on 2011-11-12,
1015 1016
        then the first argument would be:
        \begin{lstlisting}
1017
          2011/99 dated 2011-11-12
1018 1019
        \end{lstlisting}
        Or, if omitting the date is preferred by the author,
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
        then just: \lstinline|2011/99|
      \item The number of a previous work
        the current work replaces,
        if any.
        \Eg, if the new work replaces 2011/99,
        then the second argument would be:
        \begin{lstlisting}
          2011/99
        \end{lstlisting}
        If the current work does not replace a previous one,
        simply leave this argument empty.
      \item A \urnnbn issued by QA during the publication process.
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
      \item Contact information of the author,
        \eg a permanent web or e-mail address.
        If no contact information shall be provided, leave this argument empty.
      \item Name of the research group in the Department
        with which the author is affiliated.
      \item An example how to cite this work.
      \item The name of a file with an example BibTeX entry for the work.
        This will be included using \lstinline|\lstinputlisting|.
      \item Year of copyright and name of author.
      \item Some additional text to be put below the other information.
        This argument may be left empty.
    \par
    When choosing \textit{Books on Demand} as a printing service,
    the following text is required here:
    \enquote{Herstellung: Books on Demand GmbH, Norderstedt}.
    Do not use the word \enquote{Verlag} here, it will cause confusion.
  \end{enumerate}
  Alternatively, this page can be generated with \lstinline|\makemetapage|
  after using \lstinline|\renewcommand| on the following commands:
  \lstinline|\metapageversion|,
1052 1053
  \lstinline|\metapagereplacedversion|,
  \lstinline|\metapageurnnbn|,
1054 1055 1056 1057 1058 1059
  \lstinline|\metapagecontact|,
  \lstinline|\metapagegroup|,
  \lstinline|\metapagecite|,
  \lstinline|\metapagebibfile|,
  \lstinline|\metapagecopyright|,
  \lstinline|\metapagetext|.
1060 1061 1062 1063 1064 1065
  \item[Declaration of Originality Page:]
  For the mandatory page that the thesis is the author's own work,
  the macros \lstinline|\studeidesstatt| (for bachelor's and master's theses)
  and \lstinline|\disseidesstatt| (for dissertations)
  produce an appropriately worded page
  for you to sign later. 
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
  \item[Dissertation Reviewer Page:]
  For the mandatory page stating the reviewers
  and date of disputation for dissertations,
  the macro \lstinline|\dissreviewerpage| is provided.
  It takes the following $4$ arguments:
  \begin{enumerate}
    \item First reviewer. To have a rule drawn, write an underscore: \lstinline!_!
    \item Second reviewer. The underscore works here as well.
    \item Third reviewer. The underscore works here as well.
    In addition, this field can be left completely empty,
    for no third reviewer at all.
    \item Date of disputation. The underscore works here as well.
  \end{enumerate}
  Alternatively, this page can be generated with \lstinline|\makedissreviewerpage|
  after using \lstinline|\renewcommand| on the following commands:
  \lstinline|\dissreviewerpagei| (defaults to underscore),
  \lstinline|\dissreviewerpageii| (defaults to underscore),
  \lstinline|\dissreviewerpageiii| (defaults to empty),
  \lstinline|\dissreviewerpagedate|.
\end{description}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Examples}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\label{sub:examples}

1094 1095
Several examples for using the style are available in its Git repository
(see \autoref{sub:where}).
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
These include both examples for dissertations
as well as examples for using the style for student theses.




%%%                                                          %%%%%%%
 %  %    % %%%%%   %%%%  %%%%%  %%%%%   %%   %    % %%%%%    %     % %%%%%  %%%%% %  %%%%  %    %  %%%%
 %  %%  %% %    % %    % %    %   %    %  %  %%   %   %      %     % %    %   %   % %    % %%   % %
 %  % %% % %    % %    % %    %   %   %    % % %  %   %      %     % %    %   %   % %    % % %  %  %%%%
 %  %    % %%%%%  %    % %%%%%    %   %%%%%% %  % %   %      %     % %%%%%    %   % %    % %  % %      %
 %  %    % %      %    % %   %    %   %    % %   %%   %      %     % %        %   % %    % %   %% %    %
%%% %    % %       %%%%  %    %   %   %    % %    %   %      %%%%%%% %        %   %  %%%%  %    %  %%%%
1109

Lasse Kliemann's avatar
Lasse Kliemann committed
1110 1111
\section{Important Options for the \LaTeX\ Style}
\label{sec:important-options}
1112

Lasse Kliemann's avatar
Lasse Kliemann committed
1113 1114 1115 1116 1117
If in doubt, most of the default options are fine.
In this section, a few options are presented that however commonly need to be adjusted.
Any modifications beyond this which noticeably influence the layout
must be approved by QA when publishing in the Series.

1118 1119 1120


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1121
\subsection{When Using an Outdated \TeX\ Live}
1122 1123
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

1124 1125 1126 1127 1128
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.

Lasse Kliemann's avatar
Lasse Kliemann committed
1129
Many Linux distributions offer \LaTeX\ as packages,
1130 1131 1132
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.
Lasse Kliemann's avatar
Lasse Kliemann committed
1133 1134
When using Ubuntu, be sure to install the \lstinline|texlive-full| package.

1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Choosing a Bibliography Package}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\label{sub:bibliography}

A reoccurring topic is which bibliography package to use
and how to properly configure it.
In general, the style supports \lstinline|bibtex|
as well as its more modern replacement, \lstinline|biblatex|.\footnote{%
\enquote{BibTeX} is not to be confused
with \enquote{\lstinline|bibtex|}.
Roughly speaking, the former denotes a biblio\-graphy system,
which we use in any case.
The latter denotes a specific way to handle this system.
A~modern replacement for \lstinline|bibtex| is \lstinline|biblatex|.}
The latter is the default.
To choose the former anyway,
use \lstinline|biblatex=false,natbib=true| when including the style.
Note that the only reason to do so should be
if you are forced to use an old \LaTeX\ system.

Regardless of the package you use,
the main bibliography should be created with \lstinline|\tocbibliography|
instead of \lstinline|\bibliography|.
The former takes care of a correct entry in the table of contents
and the PDF bookmarks.
The name of the bibliography (as it appears in the heading and table of contents)
is \enquote{Bibliography} by default
and \enquote{Bibliografie} if \lstinline|language=german|.
It can be adjusted using the \lstinline|refname| option.

The \lstinline|\tocbibliography| command does not take any arguments
(contrary to \lstinline|\bibliography|).
The name of the BibTeX database can be given using the
\lstinline|bibresource| option to the style, \eg:
\begin{lstlisting}
  \usepackage[bibresource={my/database.bib}]{ifiseries}
\end{lstlisting}
With newer \TeX\ systems, it is mandatory to specify the \lstinline|.bib| suffix.
When \lstinline|biblatex| is used, additional bibliography databases
can be specified in the preamble with \lstinline|\addbibresource|,
see the \lstinline|biblatex| documentation.
It is also admissable to leave the \lstinline|bibresource| option empty
and only use \lstinline|\addbibresource| manually.

1182 1183 1184 1185 1186 1187
The font size of the bibliography can be influenced
by redefining the \lstinline|\bibfont| command like this:
\begin{lstlisting}
  \renewcommand*{\bibfont}{\small}
\end{lstlisting}

1188 1189 1190


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1191
\subsection{Setting the Paper Size and Binding Correction}
1192 1193
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

1194
The default paper size is US Trade,
Lasse Kliemann's avatar
Lasse Kliemann committed
1195 1196 1197 1198
which is $\unit[15.24]{cm} \times \unit[22.86]{cm}$.
The $\unit[15.5]{cm} \times \unit[22]{cm}$ format can be chosen
by \lstinline|paper=15522|.
Paper sizes can also be specified explicitly,
1199
\eg \lstinline|paperwidth=15.5cm,paperheight=22cm|
Lasse Kliemann's avatar
Lasse Kliemann committed
1200 1201 1202
would do the same as \lstinline|paper=15522|.
\par
A binding correction can be set via \lstinline|bindingcorrection|.
1203 1204
The text block will be shifted outside (on left\-/hand side pages to the left,
on right\-/hand side pages to the right) by this amount.
Lasse Kliemann's avatar
Lasse Kliemann committed
1205 1206
The default is $\unit[0]{mm}$.
This parameter has no influence on the width of the text block.
1207 1208 1209 1210 1211
The printing service should provide indication on how large the binding correction should be
for a given number of pages.
If not, then the following simple and rough rule can help:
if the number of logical pages is $n$, then the binding correction should be between $\unit[n/100]{mm}$ and $\unit[n/80]{mm}$.
For example, for a 300 pages book, this rule recommends the range between $\unit[3]{mm}$ and $\unit[3.75]{mm}$.
Lasse Kliemann's avatar
Lasse Kliemann committed
1212 1213 1214 1215 1216 1217
\par
The default page layout makes the outer margins twice the size of the inner margins.
There are good reasons for this choice.
However, for larger numbers of pages (say, 300 pages or more)
it can lead to the inner margins appearing too small in the middle of the book,
or even text being difficult to read.
1218
This can be counter\-/acted by using a binding correction.
Lasse Kliemann's avatar
Lasse Kliemann committed
1219 1220 1221 1222
Another possibility is to change the page layout such that inner and outer margins
have the same size.
This is done using the \lstinline|hcenter=true| option.
This parameter also has no influence on the width of the text block.
1223

Lasse Kliemann's avatar
Lasse Kliemann committed
1224

1225 1226 1227


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1228
\subsection{Creating More Efficient Pages}
1229
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1230
\label{sec:efficient-pages}
1231

Lasse Kliemann's avatar
Lasse Kliemann committed
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249
The KCSS defaults have been chosen such that they adhere to good, widely acknowledged typographical practice.
For example, a typical recommendation is to not put more than 75 characters per line (Bring\-hurst~\cite[p.\,26]{Bri08}).
However, some authors prefer to put more content on a single page, resulting in fewer pages overall.
The KCSS defaults already give slightly longer lines, namely close to 77 characters per line on average.
There are several ways to achieve substantially more efficient pages, as outlined in the following.
\begin{compactitemize}
\item Increase \lstinline|marginfrac|.
  The default is $12$, and a higher value gives smaller margins.
  When increasing this value, use of \lstinline|hcenter| should be considered.
  Increasing \lstinline|marginfrac| beyond $24$ is perhaps not a good idea.
\item Use a more efficient font, like \lstinline|font=TX|.
  This should only be done if reducing margins alone is not enough.
  The extreme setting \lstinline|marginfrac=24,font=TX| leads to almost $100$ characters per line on average
  (with the default paper size),
  which may be considered typographically questionable.
\item Use a larger paper size.
\end{compactitemize}

1250 1251 1252


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1253
\subsection{Declaring the Main Language}
1254 1255
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Lasse Kliemann's avatar
Lasse Kliemann committed
1256 1257
By default, English will be assumed to be the main language of the document.
The language can be switched inside the document using the \lstinline|\selectlanguage| command
1258
or the \lstinline|otherlanguage| environment,
Lasse Kliemann's avatar
Lasse Kliemann committed
1259 1260 1261 1262
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.
1263

Lasse Kliemann's avatar
Lasse Kliemann committed
1264 1265 1266 1267 1268 1269
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|.
1270

Lasse Kliemann's avatar
Lasse Kliemann committed
1271 1272 1273 1274
When using \lstinline|biblatex|,
be sure to add appropriate \lstinline|hyphenation| fields in your BibTeX database
to declare the language of each bibliography entry.

1275 1276 1277


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1278
\subsection{Choosing a Theorem System}
1279 1280
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Lasse Kliemann's avatar
Lasse Kliemann committed
1281 1282 1283 1284 1285
A theorem system may be specified via the \lstinline|theorems| option.
The following two possibilities exist:
\begin{description}[font=\tt]
  \item[theorems=numbersfirst]
    Theorems start with the number first, \eg \enquote{3.2.7~Theorem}.
1286
    All theorem types (theorem, proposition, \etc)
Lasse Kliemann's avatar
Lasse Kliemann committed
1287
    and equations share the same counter.
1288
    Third\-/level numbers are reset in each section.
Lasse Kliemann's avatar
Lasse Kliemann committed
1289 1290 1291 1292
    Numbering is within sections, \eg
    theorems in a section with number 3.2 are numbered 3.2.1, 3.2.2, and so on.
    To avoid confusion, numbering of subsections and below is disabled.
    \par
1293
    This numbering scheme makes it very comfortable
Lasse Kliemann's avatar
Lasse Kliemann committed
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
    to find a particular theorem or equation, given its number.
    It is also suited for numbering each paragraph.
  \item[theorems=numberslast]
    The number comes second, \eg \enquote{Theorem~3.2.7}.
    All theorem types (theorem, proposition, \etc) share the same counter,
    but equations have their own counter.
    Numbering is within chapters.
\end{description}
The language for the theorem system (\eg \enquote{Theorem} vs.\@ \enquote{Satz})
is deduced from the main language of the document, explained above.
\par
The environment in which theorems are numbered is set to a reasonable default.
The \lstinline|theoremswithin| option can be used to change it.
When there are no numbered sections, it should be set to \lstinline|chapter|
in order to avoid redundant \enquote{0} components in theorem designators.

1310 1311 1312


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1313
\subsection{Choosing a Figure System}
1314 1315
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Lasse Kliemann's avatar
Lasse Kliemann committed
1316 1317 1318 1319 1320 1321 1322 1323
The figure system provides means to format figures and their captions.
You may choose between the following:
\begin{description}[font=\tt]
  \item[figure=floatrow]
    The \lstinline!floatrow! package is used.
    This is the default.
  \item[figure=subfig]
    The \lstinline!subfig! package is used.
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
	  Additionally, the \lstinline|sidecap| package is loaded.
\end{description}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\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.
Lasse Kliemann's avatar
Lasse Kliemann committed
1355 1356
\end{description}

1357 1358 1359


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1360
\subsection{Reducing Margins}
1361 1362 1363 1364
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

While working on a thesis,
producing a PDF without margins can help use the available screen space more efficiently.
Lasse Kliemann's avatar
Lasse Kliemann committed
1365 1366 1367
This is achieved easily with the \lstinline|compact| option.
Setting \lstinline|compact=strong| creates the required PDF.

1368 1369 1370
Note that publishing in the Series used to require
providing a PDF for screen viewing, produced using the above mentioned option.
This is not the case any more.
Lasse Kliemann's avatar
Lasse Kliemann committed
1371 1372


1373 1374 1375 1376 1377 1378 1379 1380 1381


%%%%%%                           %%%%%
%     %  %%%%   %%%%  %    %    %     %  %%%%  %    % %%%%%% %%%%%
%     % %    % %    % %   %     %       %    % %    % %      %    %
%%%%%%  %    % %    % %%%%      %       %    % %    % %%%%%  %    %
%     % %    % %    % %  %      %       %    % %    % %      %%%%%
%     % %    % %    % %   %     %     % %    %  %  %  %      %   %
%%%%%%   %%%%   %%%%  %    %     %%%%%   %%%%    %%   %%%%%% %    %
Lasse Kliemann's avatar
Lasse Kliemann committed
1382 1383

\section{Book Cover}
1384
\label{sec:cover}
1385

Lasse Kliemann's avatar
Lasse Kliemann committed
1386 1387
The package for the book cover is in the file \lstinline|kcssCover.sty|.
Several lengths and a few other options can be set when it is loaded.
1388
The contents of the cover (title, author, text on the back, \etc)
Lasse Kliemann's avatar
Lasse Kliemann committed
1389
can be specified by \lstinline|\renewcommand|\,ing certain commands.
1390 1391
The KCSS repository contains example covers
that you can use to get started with your own cover.
Lasse Kliemann's avatar
Lasse Kliemann committed
1392

1393 1394 1395


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1396
\subsection{Common Length Options}
1397 1398
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Lasse Kliemann's avatar
Lasse Kliemann committed
1399
The following length options commonly have to be given.
1400 1401 1402
The repository contains a file called \lstinline!cover-help.pdf!
which explains the meaning of most options.
If still unsure, you can experiment with different values and observe how the cover changes.
Lasse Kliemann's avatar
Lasse Kliemann committed
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415
All those values should be based on information given by the printing service.
\begin{description}[font=\tt]
  \item[coverwidth] Width of the cover (when the book is closed and without the binding).
  \item[coverheight] Height of the cover.
  \item[smallercoverwidth, smallercoverheight]
    The cover for the hardcover usually is slightly wider and higher than
    for the paperback.
    The cover style tries to make both versions look as similar as possible.
    To this end, the width and height of the paperback has to be specified.
    This is done via options \lstinline|smallercoverwidth| and \lstinline|smallercoverheight|.
    They must always be specified.
    When creating the paperback cover, they are the same as
    \lstinline|coverwidth| and \lstinline|coverheight|, respectively.
1416
  \item[spinewidth] Width of the spine.
Lasse Kliemann's avatar
Lasse Kliemann committed
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
	It depends on the number of pages.
	The printing service should offer some way to calculate the spine width.
  \item[spinecorr] Spine correction.
	This should reflect the width of the binding on each the front and the back.
	% Usually, this is a few $\unit{mm}$.
  \item[bleed] Width of an additional margin all around the cover.
	Colored areas should extend fully into the bleed.
	The packages takes care of this with regard to the colored boxes,
	provided the correct bleed is specified.
	% Usually, this is a few $\unit{mm}$ for paperbacks
	% and a few $\unit{cm}$ for hardcovers.
1428
  \item[safety] Width of a margin inside the cover,
Lasse Kliemann's avatar
Lasse Kliemann committed
1429 1430
	where no important information should be placed.
	This option has no effect on layout,
1431
	but it determines the positions of green help lines
Lasse Kliemann's avatar
Lasse Kliemann committed
1432 1433 1434 1435 1436 1437 1438 1439
	shown when \lstinline|safetylines=true| is given.
	Those lines provide a way to check that no contents extends into the safety margin.
  \item[frontgraphicxshift, frontgraphicyshift]
	Amount by which the graphic on the front is shiftet in x and y direction, respectively.
	Adjust that until you find the result pleasing.
	Giving zero values puts the graphic in the center of the front.
\end{description}

1440 1441 1442


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1443
\subsection{Boolean Options}
1444 1445
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Lasse Kliemann's avatar
Lasse Kliemann committed
1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
\begin{description}[font=\tt]
  \item[showlayoutlines] Whether to show black lines which mark key features of the layout.
	This can be helpful to get an idea of the logic of the layout,
	which in turn can help, \eg to decide how to position the graphic on the front.
	Default is \lstinline|false|.
  \item[showsafetylines] Whether to show green lines which mark the safety margin.
	Default is \lstinline|false|.
  \item[showbleedlines] Whether to show red lines which mark the border of the cover
	and thus the beginning of the bleed area.
	Default is \lstinline|true|, but it should be set to \lstinline|false| for production.
  \item[germantext] Whether to use the German version of the text about the Series
	on the back.
	Default is \lstinline|false|, so the English text is used.
  \item[twolineresearchgroup] Whether the name of the research group
  stretches accross two lines.
1461
  The default is \lstinline|false|,
Lasse Kliemann's avatar
Lasse Kliemann committed
1462 1463 1464 1465 1466
  which indicates that the name of the research group
  occupies just a single line.
  This information is required to adjust the layout by a few millimeters.
\end{description}

1467 1468 1469


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1470
\subsection{Commands to be Redefined}
1471 1472
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

1473
Modest deviations from the text sizes given below
Lasse Kliemann's avatar
Lasse Kliemann committed
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492
(\lstinline|\Large|, \lstinline|\Huge|, \etc) are allowed
if the text otherwise would not fit nicely.
\begin{description}[font=\tt]
  \item[\textbackslash spinetitle]
    The title how it appears on the spine.
    It should be \lstinline|\Large| and \lstinline|\textbf|.
    Example:
    \begin{lstlisting}
      \renewcommand{\spinetitle}{\Large\textbf{My Fake Dissertation}}
    \end{lstlisting}
  \item[\textbackslash spineauthor]
    The author how it appears on the spine.
    It should be \lstinline|\Large|.
  \item[\textbackslash kcssnumber]
    The KCSS number, \eg 2011/1.
    It should be given without any size modifiers.
  \item[\textbackslash fronttitle]
    The title how it appears on the front.
    It should be \lstinline|\Huge| and \lstinline|\textbf|.
1493
    If it stretches over multiple lines,
Lasse Kliemann's avatar
Lasse Kliemann committed
1494 1495 1496 1497 1498 1499 1500 1501
    it may be a good idea to increase spacing between lines,
    \eg by using \lstinline|\\[.5m]| to end the line.
  \item[\textbackslash frontauthor]
    The author how it appears on the front.
    It should be \lstinline|\LARGE|.
  \item[\textbackslash backtext]
    The text in the blue box on the back.
    It should be given without any size modifiers.
1502
    The length of this text should be adjusted in order to
1503
    fill an amount of space that makes the back of the book good\-/looking.
Lasse Kliemann's avatar
Lasse Kliemann committed
1504 1505 1506 1507
    The blue area should stretch far enough to the bottom,
    but should not get too close to the text about the Series,
    outside of the blue~area.
    \par
1508 1509
    The text should in large part (about $\frac{3}{4}$ to $\frac{2}{3}$)
    be a summary of the book's contents
Lasse Kliemann's avatar
Lasse Kliemann committed
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
    so designed to gain the potential reader's interest.
    The last part (about $\frac{1}{4}$ to $\frac{1}{3}$)
    should be a short CV of the author.
    \par
    The CV may contain a photograph of the author.
    The text should be wrapped around the photograph.
    This can be achieved by means of the \lstinline|wrapfigure| environment.
    Let us look at an example:
\begin{lstlisting}
\par\medskip%
\begin{wrapfigure}[6]{l}{2.35cm}
  \vspace{-\baselineskip}
  \includegraphics[width=2.35cm]{no_photo}
\end{wrapfigure}%
\color{white}%
\end{lstlisting}
    First, we introduce some vertical space to the rest of the test
    with a \lstinline|\medskip|.
    Then the \lstinline|wrapfigure| environment starts.
    It contains a photo scaled to $\unit[2.35]{cm}$ width;
    this width is also passed to the \lstinline|wrapfigure| environment.
    A negative vertical space is necessary sometimes,
    here of length \lstinline|-\baselineskip|.
    The \lstinline|wrapfigure| environment takes two more arguments
    besides the width.
1535
    First, we have to tell it the number of lines of text
Lasse Kliemann's avatar
Lasse Kliemann committed
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554
    that shall be displayed to the side of the picture;
    this cannot be computed accurately enough  in an automatic way.
    Then we have to specify whether the picture shall be left or right;
    it should be chosen to put it left.
    After the \lstinline|wrapfigure| environment,
    it is necessary to explicitly switch back to white text color.
  \item[\textbackslash isbn]
    The ISBN bar code to be displayed on the back, if any.
    If none shall be displayed, define this command to be empty.
    If an ISBN bar code shall be displayed,
    this command usually will be a single \lstinline|\includegraphics| command.
  \item[\textbackslash researchgroup]
    The name of the research group, to be displayed on the back
    below the Department's logo.
    It should be given without any size modifiers.
    It can be a single line or two lines, separated by \lstinline|\\|.
    In the latter case, also set \lstinline|twolineresearchgroup=true|.
\end{description}

1555 1556 1557


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1558
\subsection{Document Class and Packages}
1559 1560
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Lasse Kliemann's avatar
Lasse Kliemann committed
1561
The document class should be \lstinline|standalone|,
1562
and besides the \lstinline|kcssCover|,
Lasse Kliemann's avatar
Lasse Kliemann committed
1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593
the \lstinline|ifiseries| package should also be loaded
with the \lstinline|pagelayout=false| option to prevent interference with the layout.
The base font size should be 12.
Here is an example preamble:
\begin{lstlisting}
  \documentclass[12pt]{standalone}
  \usepackage[pagelayout=false]{ifiseries}
  \usepackage[%
  showbleedlines=false,%
  coverwidth=15.56cm,%
  coverheight=23.50cm,%
  bleed=1.905cm,%
  smallercoverwidth=15.24cm,%
  smallercoverheight=22.86cm,%
  spinewidth=2cm,%
  spinecorr=5mm,%
  safety=5mm,%
  frontgraphicxshift=0cm,%
  frontgraphicyshift=-3cm,%
  ]{kcssCover}
\end{lstlisting}
\par
After the preamble, \lstinline|\renewcommand|s follow.
The actual cover is created using \lstinline|\makecover|.
The body of the document should look simply like this:
\begin{lstlisting}
  \begin{document}
  \makecover
  \end{document}
\end{lstlisting}

1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604



%%%%%%%
   %    %%%%%   %%%%  %    % %%%%%  %      %%%%%%  %%%%  %    %  %%%%   %%%%  %%%%% % %    %  %%%%
   %    %    % %    % %    % %    % %      %      %      %    % %    % %    %   %   % %%   % %    %
   %    %    % %    % %    % %%%%%  %      %%%%%   %%%%  %%%%%% %    % %    %   %   % % %  % %
   %    %%%%%  %    % %    % %    % %      %           % %    % %    % %    %   %   % %  % % %  %%%
   %    %   %  %    % %    % %    % %      %      %    % %    % %    % %    %   %   % %   %% %    %
   %    %    %  %%%%   %%%%  %%%%%  %%%%%% %%%%%%  %%%%  %    %  %%%%   %%%%    %   % %    %  %%%%

Lasse Kliemann's avatar
Lasse Kliemann committed
1605 1606
\section{Troubleshooting}

1607 1608 1609


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1610
\subsection{Embedding Fonts}
1611 1612
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Lasse Kliemann's avatar
Lasse Kliemann committed
1613 1614
Printing services require that all fonts are embedded in the PDF,
and that should also be so for the PDFs offered on the Department's website.
1615
Under most circumstances, fonts are already embedded
Lasse Kliemann's avatar
Lasse Kliemann committed
1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635
after a normal run of \lstinline|pdflatex|.
This can be checked using the command line utility \lstinline|pdffonts|.
\par
If graphics are included that were created with programs that do not embed fonts,
some fonts may be missing.
We made good experiences with the following command in such cases:
\begin{lstlisting}
gs -sDEVICE=pdfwrite -q -dBATCH -dNOPAUSE -dSAFER \
-dPDFX \
-dPDFSETTINGS=/prepress \
-dAutoFilterColorImages=false \
-dColorImageFilter=/FlatEncode \
-dAutoFilterGrayImages=false \
-dGrayImageFilter=/FlatEncode \
-sOutputFile=myDiss-out.pdf \
-c `>setdistillerparams` \
-f myDiss.pdf \
-c quit
\end{lstlisting}

1636 1637 1638


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Lasse Kliemann's avatar
Lasse Kliemann committed
1639
\subsection{Lines Extending into Margins}
1640 1641
%%%%%%%%%%%%%%%%%%%%%%%%%%%