Commit edcb5545 authored by Christoph Daniel Schulze's avatar Christoph Daniel Schulze
Browse files

Started a major overhaul of the publishing guidelines.

parent cefbf450
\documentclass[11pt,twoside]{article}
\usepackage[compact=,paper=a4paper,largepaper=true,bibresource=manual.bib,hcenter=true]{ifiseries}
\usepackage{todonotes}
\newcommand{\term}[1]{\emph{#1}}
\newcommand{\emphasis}[1]{\emph{#1}}
......@@ -144,7 +145,24 @@ We thus recommend to use this style right away, and to contact the style authors
\par
Following the open\-/access spirit of the KCSS, the KCSS style itself may be freely used outside the KCSS as well.
In particular, it is recommended to use this style also for Bachelor's and Master's theses,
and the KCSS style provides specific package options for these use cases (see \autoref{sec:student}).
and the KCSS style provides specific package options for these use cases
(see \autoref{sub:examples} for details on where to find appropriate examples).
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Where Are Things?}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\label{sub:where}
The KCSS style itself is currently available at the following Git repository:
\url{https://git.informatik.uni-kiel.de/kcss/kcss-style}
\noindent
The manual and various other documentation files are available at the following Git repository:
\url{https://git.informatik.uni-kiel.de/kcss/kcss-public}
......@@ -162,8 +180,166 @@ and the KCSS style provides specific package options for these use cases (see \a
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{The Publishing Process}
\subsection{The Process}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Writing and publishing your thesis is a considerable undertaking.
This part of our document will walk you through the different stages
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.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Preparations}
Before you even start writing your thesis,
you need to obtain the KCSS style and set everything up properly.
Once that is done, you are ready to start the real work:
writing the dissertation that will earn you that PhD thing you want.
\begin{enumerate}
\item
Get the KCSS style from its Git repository (see \autoref{sub:where}).
The best idea is probably to clone the repository
to be able to follow any updates to the style.
\item
Setup the repository you will be using for your thesis.
Copy the required style files over to that repository
(this will usually be all \texttt{.sty} files).
\item
Review the University Library's content and cover requirements
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
Find a printing service that complies with the University Library's requirements
(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.
\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}.
\item
It might feel a bit early,
but it is also a good idea to start setting up the cover now.
Of course, you cannot finish that yet.
\end{enumerate}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Writing}
This is the stage where you will (hopefully) spend most of your time at.
\begin{enumerate}
\item
Do science!
\item
Write about the science you did!
\end{enumerate}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Submitting}
This is where things start to get slightly complicated.\footnote{%
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.
We will talk about that version in the later stages.
\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.
This page should be properly prepared and included.
\item
Produce four printed copies of the submission version of your thesis.
Note that this is not your final KCSS version
and is thus not the one produced by the printing service you selected previously!
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.
Follow the examination process and ace the defense!
\end{enumerate}
\todo[inline]{More details on what needs to be handed in?}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Creating the Book Cover}
\todo[inline]{Write this section.}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Creating the Publishing Version}
\todo[inline]{Write this section.}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Quality Assurance}
\todo[inline]{Write this section.}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Publishing and Printing}
\todo[inline]{Write this section.}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{OLD PROCESS DESCRIPTION}
\begin{enumerate}
\item Prepare your document using the \LaTeX\ style explained below.
......@@ -188,7 +364,7 @@ and the KCSS style provides specific package options for these use cases (see \a
\item From the files approved by QA,
produce printed copies using a printing service of your choice.
You may ask QA for recommendations which service to use;
see also \autoref{sec:print}.
see also \autoref{sub:print}.
In addition to the printed copies intended for your own use,
the following statutionary copies are required:
\begin{compactenumerate}[label=\arabic*)]
......@@ -238,7 +414,7 @@ So a particular work can be referred to by giving its year and that counter with
\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.
\par
The number of a work never changes, even when its content is revised.
To indicate a new revision, a version number is used.
When the work is first published, it must have version at least 1.0
......@@ -259,8 +435,15 @@ then we write \enquote{2011/7 v1.2 dated 2011-11-15}.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Document Structure}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\label{sub:structure}
\todo[inline]{Include the legal page into the document structure (and the summarizing table).}
Documents published in the Series should follow a particular structure:
Documents published in the Series should follow a particular structure.
If you are in the process of writing a dissertation,
some of the elements below differ for the submission and for the publishing version
of your dissertation.
The differences are summarized in \autoref{tab:structure}.
\begin{enumerate}
\item Title page.
A macro \lstinline|\gentitlepage| is provided for generic title pages.
......@@ -273,6 +456,7 @@ Documents published in the Series should follow a particular structure:
Alternatively, \lstinline|\makegentitlepage|, \lstinline|\makedisstitlepage|,
or \lstinline|\makestudtitlepage| can be used after setting parameters
by appropriate \lstinline|\renewcommand|s, explained later.
\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|
......@@ -280,10 +464,12 @@ Documents published in the Series should follow a particular structure:
In particular, this macro prints the correct ISSNs.
Its use is demonstrated below
and explained in more detail in \autoref{sub:features}.
\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.
\item For dissertations,
a page naming the reviewers and date of disputation.
This page can be generated using the \lstinline|\dissreviewerpage| macro
......@@ -291,14 +477,18 @@ Documents published in the Series should follow a particular structure:
as explained later.
For a student's thesis, a macro \lstinline|\eidesstatt| is provided
to be called at this point.
\item Summary. For dissertations and habilitation treatises,
it is common to give the summary in German,
even if the rest of the work is in English.
\item Abstract. This is a very compact summary.
\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.
\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},
......@@ -306,22 +496,41 @@ Documents published in the Series should follow a particular structure:
\par
This preface may contain acknowledgements in a section
titled \enquote{Acknowledgements}.
\item The table of contents, generated with \lstinline!\tableofcontents!.
\item If applicable, the list of figures, generated with \lstinline!\listoffigures!.
\item If applicable, the list of tables, generated with \lstinline!\listoftables!.
\item The main part of the work, divided into chapters.
Additional divisions may be introduced using parts.
\item Appendices, if any.
\item Bibliography.
More information on bibliographies can be found in \autoref{sub:bibliography}.
\end{enumerate}
\begin{table}
\begin{tabular}{lcc} \toprule
Element & Submission & Publishing \\ \midrule
Meta information & & \checkmark \\
About this series & & \checkmark \\
Reviewers & & \checkmark \\
Copyright / legal note & \checkmark & \\
Prefaces & & \checkmark \\\bottomrule
\end{tabular}
\caption{Differences between the publishing and the submission version of a dissertation.}
\label{tab:structure}
\end{table}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Choosing a Printing Service}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\label{sec:print}
\label{sub:print}
In general, each author can choose a printing service of his or her choice,
because the Department of Computer Science has no interest
......@@ -614,8 +823,8 @@ See \autoref{sub:bibliography} for more details on bibliographies.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\label{sub:examples}
Several examples for using the style are available in its Git repository.\footnote{%
Currently to be found at: \url{https://git.informatik.uni-kiel.de/kcss/kcss-style}}
Several examples for using the style are available in its Git repository
(see \autoref{sub:where}).
These include both examples for dissertations
as well as examples for using the style for student theses.
......@@ -745,15 +954,7 @@ Another possibility is to change the page layout such that inner and outer margi
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.
\par
In order to \emphasis{scale} the document to a new paper size,
do not modify any parameters, but use \lstinline|pdfjam| on the PDF file,
like so, here scaling to A4:
\begin{lstlisting}
pdfjam --paper a4 file.pdf
\end{lstlisting}
This should however better not be used for final publication,
but it can be useful, \eg when preparing copies for the reviewers of a dissertation.
......
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