diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..eeb955e --- /dev/null +++ b/Makefile @@ -0,0 +1,109 @@ +## please modify the following line for naming the end products (PDFs, ZIPs, ...) +PROJECTNAME = "Projectname" + +## ----------------------------------------- +## DO NOT EDIT BELOW THIS LINE +## ----------------------------------------- + +## Makefile von Karl Voit (Karl@Voit.net) + +## some Makefile-hints taken from: +## http://www.ctan.org/tex-archive/help/uk-tex-faq/Makefile + + +MAINDOCUMENTBASENAME = main +MAINDOCUMENTFILENAME = ${MAINDOCUMENTBASENAME}.tex +## COMMANDS: +PDFLATEX_CMD = pdflatex +#BIBTEX_CMD = bibtex +BIBTEX_CMD = biber +MAKEIDX_CMD = makeindex +DATESTAMP = `/bin/date +%Y-%m-%d` +DATESTAMP_AND_PROJECT = ${DATESTAMP}_${PROJECTNAME} +#PDFVIEWER = xpdf +PDFVIEWER = acroread +TEMPLATEDOCUBASENAME = Template-Documentation +TEMPLATEDOCUFILE = ${TEMPLATEDOCUBASENAME}.tex + +#help +#helpThe main targets of this Makefile are: +#help help this help +.PHONY: help +help: + @sed -n 's/^#help//p' < Makefile + +#help all see "pdf" +.PHONY: all +all: pdf + +#help pdf creates a pdf file using pdflatex +.PHONY: pdf +pdf: + ${PDFLATEX_CMD} ${MAINDOCUMENTFILENAME} + -${BIBTEX_CMD} ${MAINDOCUMENTBASENAME} + ${PDFLATEX_CMD} ${MAINDOCUMENTFILENAME} + ${PDFLATEX_CMD} ${MAINDOCUMENTFILENAME} + -mv ${MAINDOCUMENTBASENAME}.pdf ${DATESTAMP_AND_PROJECT}.pdf + +#help wc counts the words from the PDF generated +wc: pdf + pdftops ${DATESTAMP_AND_PROJECT}.pdf + ps2ascii ${DATESTAMP_AND_PROJECT}.ps > ${DATESTAMP_AND_PROJECT}.txt + wc -w ${DATESTAMP_AND_PROJECT}.txt + + +# -------------------------------------------------------- + +#help view view the PDF-file +.PHONY: view +view: pdf + ${PDFVIEWER} *_${PROJECTNAME}.pdf + +# -------------------------------------------------------- + + +#help clean clean up temporary files +.PHONY: clean +clean: + -rm -r *.bcf *.run.xml _*_.* *~ *.aux *-blx.bib *.bbl ${MAINDOCUMENTBASENAME}.dvi *.ps *.blg *.idx *.ilg *.ind *.toc *.log *.log *.brf *.out *.lof *.lot *.gxg *.glx *.gxs *.glo *.gls *.tdo -f + +#help purge cleaner than clean ;-) +.PHONY: purge +purge: clean + -rm 20*.pdf *.ps -f + +#help force force rebuild next run +.PHONY: force +force: + touch *tex + +# TOOLS: + +#help zip create ZIP-file +.PHONY: zip +zip: purge pdf clean + zip -r ../${PROJECTNAME}_${TIMESTAMP}.zip * + +.PHONY: publish +publish: templatedocu pdf clean + -rm 20*.pdf ${TEMPLATEDOCUFILE} -f + git status + +#help templatedocu updates tex-files for the documentation of this template +#help needs: echo, sed, grep +.PHONY: templatedocu +templatedocu: + grep "%doc%" template/preamble.tex | sed 's/^.*%doc% //' > ${TEMPLATEDOCUFILE} + grep "%doc%" template/mycommands.tex | sed 's/^.*%doc% //' >> ${TEMPLATEDOCUFILE} + grep "%doc%" template/typographic_settings.tex | sed 's/^.*%doc% //' >> ${TEMPLATEDOCUFILE} + grep "%doc%" template/pdf_settings.tex | sed 's/^.*%doc% //' >> ${TEMPLATEDOCUFILE} + echo "%%---------------------------------------%%" >>${TEMPLATEDOCUFILE} + echo "\printbibliography\end{document}" >>${TEMPLATEDOCUFILE} + ${PDFLATEX_CMD} ${TEMPLATEDOCUFILE} + ${PDFLATEX_CMD} ${TEMPLATEDOCUFILE} + ${BIBTEX_CMD} ${TEMPLATEDOCUBASENAME} + ${PDFLATEX_CMD} ${TEMPLATEDOCUFILE} + + +#end + diff --git a/README.org b/README.org new file mode 100644 index 0000000..34464e7 --- /dev/null +++ b/README.org @@ -0,0 +1,75 @@ + +* LaTeX-KOMA-template + +** Purpose of this project + +This is a generic template for [[http://en.wikipedia.org/wiki/LaTeX][LaTeX]] documents using [[http://www.komascript.de/][KOMA Script]] classes +which are pretty common at least in German spoken countries. + +The template does *not* want to contain each and every trick but should +provide a *clean*, *consistent* and *well documented* starting point for any +document exceeding a few pages. So if you plan to write a longer report, +a diploma thesis, a PhD thesis, or similar, this template should give you +a good basis. + +The focus is that you - the author - is able to concentrate on the *content* +of your work rather than start fiddling around with the look of the document. +Several typographic optimizations are included in order to get a final document +that is optimized to deliver your content. + +Please do read [[https://github.com/novoid/LaTeX-KOMA-template/blob/master/Template-Documentation.pdf][Template-Documentation.pdf]]. + +** Requirements + +This template uses up-to-date technology like pdflatex, [[http://www.tex.ac.uk/tex-archive/info/translations/biblatex/de/][biblatex]] +(instead of BibTeX-Format), [[http://en.wikipedia.org/wiki/Biber_(LaTeX)][biber]] (instead of bibtex-compiler), and +optionally [[http://www.gnu.org/s/make/][GNU make.]] You should be familiar with compiling LaTeX +documents by yourself. If you are new to LaTeX please get basic +knowledge from tutorial pages such as [[http://LaTeX.TUGraz.at][this one]]. + +You can find out more in [[https://github.com/novoid/LaTeX-KOMA-template/blob/master/Template-Documentation.pdf][Template-Documentation.pdf]]. + +** What makes this template special? + +The speciality of this consistent template is, that every setting in +the preamble is *well documented* (in LaTeX). You can generate the +documentation file "Template-Documentation.pdf" on your own by not +removing the template documentation include command in the main LaTeX +file and using [[http://www.gnu.org/software/make/][GNU make]] with the rule "templatedocu": + +#+begin_src sh +make templatedocu +#+end_src + +This command results in the "[[https://github.com/novoid/LaTeX-KOMA-template/blob/master/Template-Documentation.pdf][Template-Documentation.pdf]]" file +containing the most current documentation of this template. Please +refer to this PDF file for further information about the template. + +** How to start? + +Please do read the "[[https://github.com/novoid/LaTeX-KOMA-template/blob/master/Template-Documentation.pdf][Template-Documentation.pdf]]" file which contains a +"How to use this LaTeX template" section. + +** License + +This template is licensed under a [[https://creativecommons.org/licenses/by-sa/3.0/][Creative Commons + Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) license]]: + +- You can share (to copy, distribute and transmit) this template. +- You can remix (adapt) this template. +- You can make commercial use of the template. +- In case you modify this template and share the derived template: You + must attribute the template such that you do not remove + (co-)authorship of Karl Voit and you must not remove the URL to [[https://github.com/novoid/LaTeX-KOMA-template][the + original repository on github]]. +- If you alter, transform, or build a new template upon this template, + you may distribute the resulting template only under the same or + similar license to this one. +- There are *no restrictions* of any kind, however, related to the + resulting (PDF) document! +- You may remove the colophon (but it's not recommended). + +** What is still work in progress? + +Please have a look at the file "[[https://github.com/novoid/LaTeX-KOMA-template/blob/master/template/todos.org][template/todos.org]]". + diff --git a/Template-Documentation.pdf b/Template-Documentation.pdf new file mode 100644 index 0000000..4c2a2d1 Binary files /dev/null and b/Template-Documentation.pdf differ diff --git a/abstract.tex b/abstract.tex new file mode 100644 index 0000000..d24c166 --- /dev/null +++ b/abstract.tex @@ -0,0 +1,23 @@ +%%%% Time-stamp: <2013-02-25 10:31:01 vk> + + +\chapter*{Abstract} +\label{cha:abstract} + + +This is a placeholder for the abstract. It summarizes the whole thesis +to give a very short overview. Usually, this the abstract is written +when the whole thesis text is finished. + + + +%\glsresetall %% all glossary entries should be used in long form (again) +%% vim:foldmethod=expr +%% vim:fde=getline(v\:lnum)=~'^%%%%\ .\\+'?'>1'\:'=' +%%% Local Variables: +%%% mode: latex +%%% mode: auto-fill +%%% mode: flyspell +%%% eval: (ispell-change-dictionary "en_US") +%%% TeX-master: "main" +%%% End: diff --git a/colophon.tex b/colophon.tex new file mode 100644 index 0000000..4a1c009 --- /dev/null +++ b/colophon.tex @@ -0,0 +1,30 @@ +%%%% Time-stamp: <2013-03-18 14:35:00 vk> +%% ======================================================================== +%%%% Disclaimer +%% ======================================================================== +%% +%% created by +%% +%% Karl Voit + + +\newcommand{\mycolophon}{%% + This document + %% was written with \myacro{GNU}~Emacs, + is set in Palatino, compiled with + \href{http://LaTeX.TUGraz.at}{pdf\LaTeX2e} and + \href{http://en.wikipedia.org/wiki/Biber_(LaTeX)}{\texttt{Biber}}. + + The \LaTeX{} template from Karl Voit is based on + \href{http://www.komascript.de/}{KOMA script} and can be found + online: \href{https://github.com/novoid/LaTeX-KOMA-template}{https://github.com/novoid/LaTeX-KOMA-template} +} + + +%%% Local Variables: +%%% mode: latex +%%% mode: auto-fill +%%% mode: flyspell +%%% eval: (ispell-change-dictionary "en_US") +%%% TeX-master: "../main" +%%% End: diff --git a/example-short-chapter.tex b/example-short-chapter.tex new file mode 100644 index 0000000..440b22d --- /dev/null +++ b/example-short-chapter.tex @@ -0,0 +1,33 @@ +%%%% Time-stamp: <2012-08-20 17:41:39 vk> + +%% example text content +%% scrartcl and scrreprt starts with section, subsection, subsubsection, ... +%% scrbook starts with part (optional), chapter, section, ... +\chapter{Example Chapter} + +This is my text with an example Figure~\ref{fig:example} and example +citation~\cite{StrunkWhite} or \textcite{Bringhurst1993}. And there is another +\enquote{citation} which is located at the bottom\footcite{tagstore}. + +\myfig{TU_Graz_Logo}%% filename in figures folder + {width=0.1\textwidth,height=0.1\textheight}%% maximum width/height, aspect ratio will be kept + {Example figure.}%% caption + {}%% optional (short) caption for table of figures + {fig:example}%% label + +Now you are able to write your own document. Always keep in mind: it's +the \emph{content} that matters, not the form. But good typography is +able to deliver the content much better than information set with bad +typography. This template allows you to focus on writing good content +while the form is done by the template definitions. + + +%% vim:foldmethod=expr +%% vim:fde=getline(v\:lnum)=~'^%%%%\ .\\+'?'>1'\:'=' +%%% Local Variables: +%%% mode: latex +%%% mode: auto-fill +%%% mode: flyspell +%%% eval: (ispell-change-dictionary "en_US") +%%% TeX-master: "main" +%%% End: diff --git a/example-style-chapter.tex b/example-style-chapter.tex new file mode 100644 index 0000000..4940ad6 --- /dev/null +++ b/example-style-chapter.tex @@ -0,0 +1,553 @@ +%---------------------------------------------------------------- +% +% File : thesis-style.tex +% +% Author : Keith Andrews, IICM, TU Graz, Austria +% +% Created : 27 May 93 +% +% Changed : 19 Feb 2004 +% +% styling and technical implementation adopted 2011 by Karl Voit +%---------------------------------------------------------------- + +%% defined an anvironment for the style Keith used to use: +\newenvironment{mykeithtabbing}[1]{%% +\begin{tabular}{lp{0.9\hsize}} +}{%% +\end{tabular} +} + +\newcommand{\mybadgood}[2]{%% +\begin{mykeithtabbing} +{}\emph{Bad:} & \sout{#1} \\ +\emph{Good:} & #2 \\ +\end{mykeithtabbing} + +} + +\chapter{Language and Writing Style} +\label{chap:Style} + +\begin{framed} + + This chapter is an adopted version of a single chapter of + \citeauthor{KeithThesis} thesis template \cite{KeithThesis} in its + version from 2011-12-11. + + The reason why \cite{KeithThesis} is not recommended to be used instead + of this template is its more \enquote{traditional} \LaTeX{} + implementation. But the information contained regarding \enquote{How + to write a thesis} is generally brilliant and worth reading. + + Using this chapter here is meant as a teaser. If you do like this + chapter, please go and download the full template to read its + content:~\cite{KeithThesis}. + + What was modified from the original chapter: + \begin{itemize} + \item strikethrough of bad examples + \item minor typographical details + \item technical modifications + \begin{itemize} + \item moved citations from \verb+\citet{}+ and + \verb+\citep{}+ to \verb+\textcite{}+ and \verb+\cite{}+ + \item changed quoting style to \verb+\enquote{}+ + \item created various commands and environments to encapsulate + format + \end{itemize} + \end{itemize} +\end{framed} + +The classic reference for English writing style and grammar is +\textcite{StrunkWhite}. The original text is now available for free +online \cite{Strunk}, so there is no excuse at all for writing poor +English. Readers should consult it first, then continue reading this +chapter. Another good free guide is \textcite{NASAGuide}. + +%orig% The classic reference for English writing style and grammar is +%orig% \citet{StrunkWhite}. The original text is now available for free +%orig% online \citep{Strunk}, so there is no excuse at all for writing poor +%orig% English. Readers should consult it first, then continue reading this +%orig% chapter. Another good free guide is \citet{NASAGuide}. + + +\textcite{Zobel-WritingCompSci} and \textcite{BugsInWriting} are guides +specifically aimed at computer science students. +\textcite{Phillips-HowGetPhD} gives practical advice for PhD +students. + +The following Sections~\ref{sec:Clear} and \ref{sec:Gender} are +adapted from the CHI'94 language and writing style guidelines. + + + + + + + +\section{Some Basic Rules of English} + +There are a few basic rules of English for academic writing, which are +broken regularly by my students, particularly if they are non-native +speakers of English. Here are some classic and often encountered +examples: + +\begin{itemize} + +\item \emph{Never} use I, we, or you. + +Write in the passive voice (third person). + +\mybadgood{You can do this in two ways.}{There are two ways this can be done.} + + +\item \emph{Never} use he or she, his or her. + +Write in the passive voice (third person). + +\mybadgood{The user speaks his thoughts out loud.}{The thoughts of the user are spoken out loud.} + + +See Section~\ref{sec:Gender} for many more examples. + + + +\item Stick to a consistent dialect of English. Choose either + British or American English and keep to it throughout the + whole of your thesis. + + + +\item Do \emph{not} use slang abbreviations such as \enquote{it's}, + \enquote{doesn't}, or \enquote{don't}. + +Write the words out in full: \enquote{it is}, \enquote{does not}, and \enquote{do not}. + +\mybadgood{It's very simple to\ldots}{It is very simple to\ldots} + + + + +\item Do \emph{not} use abbreviations such as \enquote{e.\,g.} or + \enquote{i.\,e.}. + +Write the words out in full: \enquote{for example} and \enquote{that is}. + +\mybadgood{\ldots in a tree, e.\,g.\xspace{}the items\ldots}{\ldots in a tree, for example the items\ldots} + + + +\item Do \emph{not} use slang such as \enquote{a lot of}. + +\mybadgood{There are a lot of features\ldots}{There are many features\ldots} + + + +\item Do \emph{not} use slang such as \enquote{OK} or \enquote{big}. + +\mybadgood{\ldots are represented by big areas.}{\ldots are represented by large areas.} + + + +\item Do \emph{not} use slang such as \enquote{gets} or \enquote{got}. + +Use \enquote{becomes} or \enquote{obtains}, or use the passive voice (third +person). + +\mybadgood{The radius gets increased\ldots}{The radius is increased\ldots} + +\mybadgood{The user gets disoriented\ldots}{The user becomes disoriented\ldots} + + + + +\item \emph{Never} start a sentence with \enquote{But}. + +Use \enquote{However,} or \enquote{Nevertheless,}. Or consider joining the +sentence to the previous sentence with a comma. + +\mybadgood{But there are numerous possibilities\ldots}{However, there are numerous possibilities\ldots} + + + +\item \emph{Never} start a sentence with \enquote{Because}. + +Use \enquote{Since}, \enquote{Owing to}, or \enquote{Due to}. Or turn the two +halves of the sentence around. + + + + +\item \emph{Never} start a sentence with \enquote{Also}. Also should +be placed in the middle of the sentence. + +\mybadgood{Also the target users are considered.}{The target users are also considered.} + + + +\item Do \emph{not} use \enquote{that} as a connecting word. + +Use \enquote{which}. + +\mybadgood{\ldots a good solution that can be computed easily.}{\ldots a good solution which can be computed easily.} + + + + +\item Do \emph{not} write single-sentence paragraphs. + +Avoid writing two-sentence paragraphs. A paragraph should contain at +least three, if not more, sentences. + + +\end{itemize} + + + +% rules on the use of a comma in lists +% http://en.wikipedia.org/wiki/Serial_comma + + + + + + + + +\section{Avoid Austrianisms} +\label{sec:Austrianisms} + + +I see these mistakes time and time again. Please do not +let me read one of them in your work. + + + +\begin{itemize} + + +\item \enquote{actual}~$\ne$~\enquote{current} + +If you mean \enquote{aktuell} in German, you probably mean +\enquote{current} in English. + +\mybadgood{The actual selection is cancelled.}{The current selection is cancelled.} + + + + +\item \enquote{allows to} is not English. + +\mybadgood{The prototype allows to arrange components\ldots}%% +{The prototype supports the arrangement of components\ldots} + +% they allow to achieve + + + +\item \enquote{enables to} is not English. + +\mybadgood{it enables to recognise meanings\ldots}{it enables the recognition of meanings\ldots} + + + +\item \enquote{according}~$\ne$~\enquote{corresponding} + +\mybadgood{For each browser, an according package is created.}{For each browser, a corresponding package is created.} + + + +\item \enquote{per default} is not English. + +Use \enquote{by default}. + +\mybadgood{Per default, the cursor is red.}{By default, the cursor is red.} + + + + +\item \enquote{As opposed to} is not English. + +Use \enquote{In contrast to}. + +\mybadgood{As opposed to C, Java is object-oriented.}{In contrast to C, Java is object-oriented.} + + +\item \enquote{\emph{anything}-dimensional} is spelt with a hyphen. + +For example: two-dimensional, three-dimensional. + + + +\item \enquote{\emph{anything}-based} is spelt with a hyphen. + +For example: tree-based, location-based. + + + +\item \enquote{\emph{anything}-oriented} is spelt with a hyphen. + +For example: object-oriented, display-oriented. + + +\item \enquote{\emph{anything}-side} is spelt with a hyphen. + +For example: client-side, server-side. + + +\item \enquote{\emph{anything}-friendly} is spelt with a hyphen. + +For example: user-friendly, customer-friendly. + + +\item \enquote{\emph{anything}-to-use} is spelt with hyphens. + +For example: hard-to-use, easy-to-use. + + + +\item \enquote{realtime} is spelt with a hyphen if used as + an adjective, or as two separate words if used as a noun. + +\mybadgood{\ldots using realtime shadow casting.}{\ldots using real-time shadow casting.} +\mybadgood{\ldots display the object in realtime.}{\ldots display the object in real time.} + + +\end{itemize} + + + + + + + + + + + + +\section{Clear Writing} +\label{sec:Clear} + +The written and spoken language of your thesis is English as +appropriate for presentation to an international audience. Please take +special care to ensure that your work is adapted to such an audience. +In particular: + +\begin{itemize} +\item Write in a straight-forward style, using simple sentence + structure. + +\item Use common and basic vocabulary. For example, use \enquote{unusual} + for \enquote{arcane}, and \enquote{specialised} for \enquote{erudite}. + +\item Briefly define or explain all technical vocabulary the first + time it is mentioned, to ensure that the reader understands it. + +\item Explain all acronyms and abbreviations. For example, the first + time an acronym is used, write it out in full and place the acronym + in parentheses. + +\mybadgood{\ldots When using the \myacro{GUI} version, the use may\ldots}%% +{\ldots When using the Graphical User Interface (\myacro{GUI}) version, the use may\ldots} + + +\item Avoid local references. For example, not everyone knows the + names of all the provincial capitals of Austria. If local context is + important to the material, describe it fully. + +\item Avoid \enquote{insider} comments. Ensure that your whole audience + understands any reference whose meaning you do not describe. For + example, do not assume that everyone has used a Macintosh or a + particular application. + +\item Do not \enquote{play on words}. For example, do not use \enquote{puns}, + particularly in the title of a piece. Phrases such as ``red + herring'' require cultural as well as technical knowledge of + English. + +\item Use unambiguous formats to represent culturally localised things + such as times, dates, personal names, currencies, and even + numbers. 9/11 is the 9th of November in most of the world. + +\item Be careful with humour. In particular, irony and sarcasm can be + hard to detect if you are not a native speaker. + +\item If you find yourself repeating the same word or phrase too often, + look in a thesaurus such as \textcite{Roget,RogetII} for an + alternative word with the same meaning. +\end{itemize} + + +Clear writing experts recognise that part of writing understandable +documents is understanding and responding to the needs of the intended +audience. It is the writer's job to maintain the audience's +willingness to go on reading the document. Readers who are continually +stumped by long words or offended by a pompous tone are likely to stop +reading and miss the intended message. + + + + + + + + +\section{Avoiding Gender Bias} +\label{sec:Gender} + +Part of striking the right tone is handling gender-linked terms +sensitively. Use of gender terms is controversial. Some writers use +the generic masculine exclusively, but this offends many readers. +Other writers are experimenting with ways to make English more +neutral. Avoiding gender bias in writing involves two kinds of +sensitivity: +\begin{enumerate} +\item being aware of potential bias in the kinds of observations and + characterisations that it is appropriate to make about women and men, + and + +\item being aware of certain biases that are inherent in the language + and of how you can avoid them. +\end{enumerate} + + +The second category includes using gender-specific nouns and pronouns +appropriately. Here are some guidelines for handling these +problems: +\begin{itemize} + +\item Use a gender-neutral term when speaking generically of people: + +\begin{tabular}{ll} + man & the human race \\ + mankind & humankind, people \\ + manpower & workforce, personnel \\ + man on the street & average person \\ +\end{tabular} + + +\item Avoid clearly gender-marked titles. Use neutral terms when +good ones are available. For example: + +\begin{tabular}{ll} + chairman & chairperson \\ + spokesman & speaker, representative \\ + policeman & police officer \\ + stewardess & flight attendant \\ +\end{tabular} + + + +\item If you are speaking of the holder of a position and you know the + gender of the person who currently occupies the position, use the + appropriate gender pronoun. For example, suppose the \enquote{head nurse} + is a man: + +\mybadgood{The head nurse must file her report every Tuesday.}{The head nurse must file his report every Tuesday.} + + + +\item Rewrite sentences to avoid using gender pronouns. For example, + use the appropriate title or job name again: + +\mybadgood{Interview the user first and then ask him to fill out a questionnaire.}%% +{Interview the user first and then ask the user to fill out a questionnaire.} + + + +\item To avoid using the third person singular pronoun (his or her), + recast your statement in the plural: + +\mybadgood{Each student should bring his text to class.}{All students should bring their texts to class.} + + + +\item Address your readers directly in the second person, if it is + appropriate to do so: + +\mybadgood{The student must send in his application by the final deadline date.}%% +{Send in your application by the final deadline date.} + + + + +\item Replace third person singular possessives with articles. + +\mybadgood{Every student must hand his report in on Friday.}{Every student must hand the report in on Friday.} + + + +\item Write your way out of the problem by using the passive voice. + +\mybadgood{Each department head should do his own projections.}{Projections should be done by each department head.} + + + +\item Avoid writing awkward formulations such as \enquote{s/he}, \enquote{he/she}, + or \enquote{his/her}. They interfere when someone is trying to read a + text aloud. If none of the other guidelines has been helpful, use + the slightly less awkward forms \enquote{he or she}, and \enquote{his or hers}. + +\end{itemize} +Remember, the goal is to avoid constructions that will offend your +readers so much as to distract them from the content of your work. + + + + +\section{Titles and Headings in Initial Caps} + +% Capitalization in Titles +% http://www.writersblock.ca/tips/monthtip/tipmar98.htm + + + + + + + + +\section{Use a Spelling Checker} + +In these days of high technology, spelling mistakes and typos are +inexcusable. It is \emph{very} irritating for your supervisor to have +to read through and correct spelling mistake after spelling mistake +which could have been caught by an automated spelling checker. +Believe me, irritating your supervisor is not a good idea. + +So, use a spelling checker \emph{before} you hand in \emph{any} +version, whether it is a draft or a final version. +Since this is apparently often forgotten, and sometimes even wilfully +ignored, let me make it absolutely clear: +\begin{quote} +\begin{em} +Use a spelling checker, please. \\ +Use a spelling checker! \\ +Use a spelling checker, you moron. \\ +\end{em} +\end{quote} + + + + + +\section{Use a Dictionary} + +If you are not quite sure of the meaning of a word, then use a +dictionary. \textcite{DictionaryCom} is a free English dictionary, +\textcite{DictChemnitz} and \textcite{DictLeoOrg} are two very good +English-German dictionaries. + + + + +\section{Use a Thesaurus} + +If a word has been used several times already, and using another +equivalent word might improve the readability of the text, then +consult a thesaurus. \textcite{Roget} and \textcite{RogetII} are free +English thesauri. + + diff --git a/figures/TU_Graz_Logo.pdf b/figures/TU_Graz_Logo.pdf new file mode 100644 index 0000000..57aa664 --- /dev/null +++ b/figures/TU_Graz_Logo.pdf @@ -0,0 +1,219 @@ +%PDF-1.3 +% +2 0 obj +<< +/Length 2930 +>> +stream +0 0.957 0.569 0 k +/GS1 gs +0 31.119 20.745 -20.746 re +f +22.819 31.119 20.746 -20.746 re +f +q +1 i +0 41.492 112.876 -41.432 re +W n +45.641 31.119 20.744 -20.746 re +f +10.372 20.746 20.747 -20.686 re +f +Q +35.268 41.492 20.744 -20.746 re +f +0.941 0.82 0.808 0.894 k +1 i +75.104 27.791 m +68.462 27.791 l +68.462 31.11 l +85.581 31.11 l +85.581 27.791 l +78.94 27.791 l +78.94 10.417 l +75.104 10.417 l +75.104 27.791 l +f +q +0 41.492 112.876 -41.432 re +W n +104.828 18.021 m +104.828 16.774 104.604 15.649 104.156 14.646 c +103.708 13.643 103.097 12.79 102.321 12.09 c +101.546 11.387 100.631 10.848 99.57 10.469 c +98.511 10.088 97.359 9.898 96.115 9.898 c +94.873 9.898 93.722 10.088 92.661 10.469 c +91.601 10.848 90.678 11.387 89.895 12.09 c +89.109 12.79 88.497 13.643 88.061 14.646 c +87.621 15.649 87.403 16.774 87.403 18.021 c +87.403 31.11 l +91.241 31.11 l +91.241 18.153 l +91.241 17.648 91.321 17.117 91.485 16.562 c +91.648 16.008 91.919 15.497 92.298 15.029 c +92.676 14.563 93.177 14.178 93.801 13.877 c +94.423 13.576 95.194 13.425 96.115 13.425 c +97.035 13.425 97.808 13.576 98.431 13.877 c +99.054 14.178 99.556 14.563 99.934 15.029 c +100.312 15.497 100.582 16.008 100.746 16.562 c +100.909 17.117 100.991 17.648 100.991 18.153 c +100.991 31.11 l +104.828 31.11 l +104.828 18.021 l +f +83.257 7.566 m +82.496 7.895 81.511 8.052 80.723 8.052 c +78.43 8.052 77.162 6.609 77.162 4.734 c +77.162 2.873 78.401 1.471 80.497 1.471 c +81.032 1.471 81.456 1.523 81.793 1.602 c +81.793 3.987 l +79.71 3.987 l +79.71 5.43 l +83.679 5.43 l +83.679 0.5 l +82.638 0.238 81.553 0.028 80.497 0.028 c +77.316 0.028 75.106 1.51 75.106 4.604 c +75.106 7.737 77.162 9.494 80.497 9.494 c +81.638 9.494 82.538 9.35 83.383 9.113 c +83.257 7.566 l +f +85.62 6.938 m +87.296 6.938 l +87.296 5.403 l +87.324 5.403 l +87.408 6.033 88.182 7.095 89.308 7.095 c +89.491 7.095 89.689 7.095 89.885 7.042 c +89.885 5.272 l +89.717 5.363 89.379 5.416 89.04 5.416 c +87.507 5.416 87.507 3.633 87.507 2.664 c +87.507 0.186 l +85.62 0.186 l +85.62 6.938 l +f +93.587 1.312 m +94.164 1.312 94.614 1.549 94.909 1.916 c +95.219 2.296 95.304 2.781 95.304 3.306 c +94.487 3.306 l +93.644 3.306 92.391 3.175 92.391 2.139 c +92.391 1.563 92.911 1.312 93.587 1.312 c +h +91.376 6.583 m +92.107 6.898 93.094 7.095 93.896 7.095 c +96.105 7.095 97.021 6.242 97.021 4.249 c +97.021 3.384 l +97.021 2.703 97.035 2.191 97.049 1.693 c +97.063 1.182 97.091 0.71 97.134 0.186 c +95.473 0.186 l +95.402 0.539 95.402 0.985 95.389 1.195 c +95.359 1.195 l +94.924 0.448 93.979 0.028 93.122 0.028 c +91.842 0.028 90.588 0.749 90.588 2.034 c +90.588 3.043 91.108 3.633 91.827 3.961 c +92.546 4.289 93.474 4.355 94.263 4.355 c +95.304 4.355 l +95.304 5.442 94.783 5.81 93.671 5.81 c +92.869 5.81 92.066 5.522 91.434 5.076 c +91.376 6.583 l +f +98.569 6.938 m +104.312 6.938 l +104.312 5.495 l +100.707 1.549 l +104.438 1.549 l +104.438 0.186 l +98.414 0.186 l +98.414 1.615 l +102.087 5.574 l +98.569 5.574 l +98.569 6.938 l +f +0 0.957 0.569 0 k +105.965 6.911 6.911 -6.851 re +f +Q +endstream +endobj +3 0 obj +<< +/ProcSet [/PDF ] +/ExtGState << +/GS1 4 0 R +>> +>> +endobj +4 0 obj +<< +/Type /ExtGState +/SA false +/SM 0.02 +/OP false +/op false +/OPM 1 +/BG2 /Default +/UCR2 /Default +/HT /Default +/TR2 /Default +>> +endobj +1 0 obj +<< +/Type /Page +/Parent 5 0 R +/Resources 3 0 R +/Contents 2 0 R +>> +endobj +6 0 obj +<< +/S /D +>> +endobj +7 0 obj +<< +/Nums [0 6 0 R ] +>> +endobj +5 0 obj +<< +/Type /Pages +/Kids [1 0 R] +/Count 1 +/MediaBox [0 0 113 42] +>> +endobj +8 0 obj +<< +/CreationDate (D:20060111234722+13'00') +/ModDate (D:20060111234722+13'00') +/Producer (PSNormalizer.framework) +>> +endobj +9 0 obj +<< +/Type /Catalog +/Pages 5 0 R +/PageLabels 7 0 R +>> +endobj +xref +0 10 +0000000000 65535 f +0000003204 00000 n +0000000016 00000 n +0000002998 00000 n +0000003064 00000 n +0000003349 00000 n +0000003284 00000 n +0000003311 00000 n +0000003429 00000 n +0000003560 00000 n +trailer +<< +/Size 10 +/Root 9 0 R +/Info 8 0 R +/ID [<99444215e2a4a31d5c4ca09b38102d5e><99444215e2a4a31d5c4ca09b38102d5e>] +>> +startxref +3627 +%%EOF diff --git a/figures/institution.pdf b/figures/institution.pdf new file mode 100644 index 0000000..57aa664 --- /dev/null +++ b/figures/institution.pdf @@ -0,0 +1,219 @@ +%PDF-1.3 +% +2 0 obj +<< +/Length 2930 +>> +stream +0 0.957 0.569 0 k +/GS1 gs +0 31.119 20.745 -20.746 re +f +22.819 31.119 20.746 -20.746 re +f +q +1 i +0 41.492 112.876 -41.432 re +W n +45.641 31.119 20.744 -20.746 re +f +10.372 20.746 20.747 -20.686 re +f +Q +35.268 41.492 20.744 -20.746 re +f +0.941 0.82 0.808 0.894 k +1 i +75.104 27.791 m +68.462 27.791 l +68.462 31.11 l +85.581 31.11 l +85.581 27.791 l +78.94 27.791 l +78.94 10.417 l +75.104 10.417 l +75.104 27.791 l +f +q +0 41.492 112.876 -41.432 re +W n +104.828 18.021 m +104.828 16.774 104.604 15.649 104.156 14.646 c +103.708 13.643 103.097 12.79 102.321 12.09 c +101.546 11.387 100.631 10.848 99.57 10.469 c +98.511 10.088 97.359 9.898 96.115 9.898 c +94.873 9.898 93.722 10.088 92.661 10.469 c +91.601 10.848 90.678 11.387 89.895 12.09 c +89.109 12.79 88.497 13.643 88.061 14.646 c +87.621 15.649 87.403 16.774 87.403 18.021 c +87.403 31.11 l +91.241 31.11 l +91.241 18.153 l +91.241 17.648 91.321 17.117 91.485 16.562 c +91.648 16.008 91.919 15.497 92.298 15.029 c +92.676 14.563 93.177 14.178 93.801 13.877 c +94.423 13.576 95.194 13.425 96.115 13.425 c +97.035 13.425 97.808 13.576 98.431 13.877 c +99.054 14.178 99.556 14.563 99.934 15.029 c +100.312 15.497 100.582 16.008 100.746 16.562 c +100.909 17.117 100.991 17.648 100.991 18.153 c +100.991 31.11 l +104.828 31.11 l +104.828 18.021 l +f +83.257 7.566 m +82.496 7.895 81.511 8.052 80.723 8.052 c +78.43 8.052 77.162 6.609 77.162 4.734 c +77.162 2.873 78.401 1.471 80.497 1.471 c +81.032 1.471 81.456 1.523 81.793 1.602 c +81.793 3.987 l +79.71 3.987 l +79.71 5.43 l +83.679 5.43 l +83.679 0.5 l +82.638 0.238 81.553 0.028 80.497 0.028 c +77.316 0.028 75.106 1.51 75.106 4.604 c +75.106 7.737 77.162 9.494 80.497 9.494 c +81.638 9.494 82.538 9.35 83.383 9.113 c +83.257 7.566 l +f +85.62 6.938 m +87.296 6.938 l +87.296 5.403 l +87.324 5.403 l +87.408 6.033 88.182 7.095 89.308 7.095 c +89.491 7.095 89.689 7.095 89.885 7.042 c +89.885 5.272 l +89.717 5.363 89.379 5.416 89.04 5.416 c +87.507 5.416 87.507 3.633 87.507 2.664 c +87.507 0.186 l +85.62 0.186 l +85.62 6.938 l +f +93.587 1.312 m +94.164 1.312 94.614 1.549 94.909 1.916 c +95.219 2.296 95.304 2.781 95.304 3.306 c +94.487 3.306 l +93.644 3.306 92.391 3.175 92.391 2.139 c +92.391 1.563 92.911 1.312 93.587 1.312 c +h +91.376 6.583 m +92.107 6.898 93.094 7.095 93.896 7.095 c +96.105 7.095 97.021 6.242 97.021 4.249 c +97.021 3.384 l +97.021 2.703 97.035 2.191 97.049 1.693 c +97.063 1.182 97.091 0.71 97.134 0.186 c +95.473 0.186 l +95.402 0.539 95.402 0.985 95.389 1.195 c +95.359 1.195 l +94.924 0.448 93.979 0.028 93.122 0.028 c +91.842 0.028 90.588 0.749 90.588 2.034 c +90.588 3.043 91.108 3.633 91.827 3.961 c +92.546 4.289 93.474 4.355 94.263 4.355 c +95.304 4.355 l +95.304 5.442 94.783 5.81 93.671 5.81 c +92.869 5.81 92.066 5.522 91.434 5.076 c +91.376 6.583 l +f +98.569 6.938 m +104.312 6.938 l +104.312 5.495 l +100.707 1.549 l +104.438 1.549 l +104.438 0.186 l +98.414 0.186 l +98.414 1.615 l +102.087 5.574 l +98.569 5.574 l +98.569 6.938 l +f +0 0.957 0.569 0 k +105.965 6.911 6.911 -6.851 re +f +Q +endstream +endobj +3 0 obj +<< +/ProcSet [/PDF ] +/ExtGState << +/GS1 4 0 R +>> +>> +endobj +4 0 obj +<< +/Type /ExtGState +/SA false +/SM 0.02 +/OP false +/op false +/OPM 1 +/BG2 /Default +/UCR2 /Default +/HT /Default +/TR2 /Default +>> +endobj +1 0 obj +<< +/Type /Page +/Parent 5 0 R +/Resources 3 0 R +/Contents 2 0 R +>> +endobj +6 0 obj +<< +/S /D +>> +endobj +7 0 obj +<< +/Nums [0 6 0 R ] +>> +endobj +5 0 obj +<< +/Type /Pages +/Kids [1 0 R] +/Count 1 +/MediaBox [0 0 113 42] +>> +endobj +8 0 obj +<< +/CreationDate (D:20060111234722+13'00') +/ModDate (D:20060111234722+13'00') +/Producer (PSNormalizer.framework) +>> +endobj +9 0 obj +<< +/Type /Catalog +/Pages 5 0 R +/PageLabels 7 0 R +>> +endobj +xref +0 10 +0000000000 65535 f +0000003204 00000 n +0000000016 00000 n +0000002998 00000 n +0000003064 00000 n +0000003349 00000 n +0000003284 00000 n +0000003311 00000 n +0000003429 00000 n +0000003560 00000 n +trailer +<< +/Size 10 +/Root 9 0 R +/Info 8 0 R +/ID [<99444215e2a4a31d5c4ca09b38102d5e><99444215e2a4a31d5c4ca09b38102d5e>] +>> +startxref +3627 +%%EOF diff --git a/license.txt b/license.txt new file mode 100644 index 0000000..67de19a --- /dev/null +++ b/license.txt @@ -0,0 +1 @@ +Please take a look at the license in README.org! diff --git a/main.tex b/main.tex new file mode 100644 index 0000000..fefbb80 --- /dev/null +++ b/main.tex @@ -0,0 +1,275 @@ +%%%% Time-stamp: <2013-09-18 19:27:11 vk> +%% ======================================================================== +%%%% Disclaimer +%% ======================================================================== +%% +%% created by +%% +%% Karl Voit +%% + +%% ======================================================================== +%%%% Basic settings +%% ======================================================================== +%% (idea of using newcommands for basic documentclass settings from: Thomas Schlager) + +\newcommand{\mypapersize}{A4} +%% e.g., "A4", "letter", "legal", "executive", ... +%% The size of the paper of the resulting PDF file. + +\newcommand{\mylaterality}{twoside} +%% "oneside" or "twoside" +%% Either you are creating a document which is printed on both, left pages +%% and right pages (twoside) or you create a document which is printed +%% on right pages only (oneside). + +\newcommand{\mydraft}{false} +%% "true" or "false" +%% Use draft mode? If true, included graphics are replaced by empty +%% rectangles (of same size) and overfull boxes (in margin space) are +%% marked with black box (-> easy to spot!) + +\newcommand{\myparskip}{half} +%% e.g., "no", "full", "half", ... +%% How to separate paragraphs: indention ("no") or spacing ("half", +%% "full", ...). + +\newcommand{\myBCOR}{0mm} +%% Inner binding correction. This value depends on the method which is +%% being used to bind your printed result. Some techniques do not +%% require a binding correction at all ("0mm"), other require for +%% example "5mm". Refer to KOMA script documentation for a detailed +%% explanation what a binding correction is and how to measure it. + +\newcommand{\myfontsize}{12pt} +%% e.g., 10pt, 11pt, 12pt +%% The font size of the main text in pt (points). + +\newcommand{\mylinespread}{1.0} +%% e.g., 1.0, 1.5, 2.0 +%% Line spacing in %/100. For example 1.5 means 150% of the usual line +%% spacing. Please use with caution: 100% ("1.0") is fine because the +%% font was designed for it. + +\newcommand{\mylanguage}{ngerman,american} +%% "english,ngerman", "ngerman,english", ... +%% NOTE: The *last* language is the active one! +%% See babel documentation for further details. + +%% BibLaTeX-settings: (see biblatex reference for further description) +\newcommand{\mybiblatexstyle}{authoryear} +%% e.g., "alphabetic", "authoryear", ... +%% The biblatex style which is being used for referencing. See +%% biblatex documentation for further details and more values. +%% +%% CAUTION: if you change the style, please check for (in)compatible +%% "biblatex" package options in the file +%% "template/preamble.tex"! For example: "alphabetic" does +%% not have an option "dashed=..." and causes an error if it +%% does not get removed from the list of options. + +\newcommand{\mybiblatexdashed}{false} %% "true" or "false" +%% If true: replace recurring reference authors with a dash. + +\newcommand{\mybiblatexbackref}{true} %% "true" or "false" +%% If true: create backward links from reference to citations. + +\newcommand{\mybiblatexfile}{references-biblatex.bib} +%% Name of the biblatex file that holds the references. + +\newcommand{\mydispositioncolor}{30,103,182} +%% e.g., "30,103,182" (blue/turquois), "0,0,0" (black), ... +%% Color of the headings and so forth in RGB (red,green,blue) values. +%% NOTE: if you are using "0,0,0" for black, printers might still +%% recognize pages as color pages. In case this is a problem +%% (paying for color print-outs vs. paying for b/w-printouts) +%% please edit file "template/preamble.tex" and change +%% "\definecolor{DispositionColor}{RGB}{\mydispositioncolor}" +%% to "\definecolor{DispositionColor}{gray}{0}" and thus +%% overwriting the value of \mydispositioncolor above. + +\newcommand{\mycolorlinks}{true} %% "true" or "false" +%% Enables or disables colored links (hyperref package). + +\newcommand{\mytitlepage}{template/title_Thesis_TU_Graz} +%% Your own or one of following pre-defined title pages: +%% "template/title_plain_maketitle": simple maketitle page +%% "template/title_Diplomarbeit_KF_Uni_Graz.tex": fancy (german) title page for KF Uni Graz +%% "template/title_Thesis_TU_Graz": titlepage for Graz University of Technology (correct Corporate Design) +%% "template/title_VWA": titlepage for Vorwissenschaftliche Arbeit + +\newcommand{\mytodonotesoptions}{} +%% e.g., "" (empty), "disable", ... +%% Options for the todonotes-package. If "disable", all todonotes will +%% be hidden (including listoftodos). + +%% Load main settings for document preamble: +\input{template/preamble}%% DO NOT REMOVE THIS LINE! + +\setboolean{myaddcolophon}{true} %% "true" or "false" +%% If set to "true": a colophon (with notes about this document +%% template, LaTeX, ...) is added after the title page. +%% Please do not set to "false" without a good reason. The colophon +%% helps your readers to get in touch with LaTeX and to find this template. + +\setboolean{myaddlistoftodos}{false} %% "true" or "false" +%% If set to "true": the current list of open todos is added after the +%% table of contents. If \mytodonotesoptions is set to "disable", no +%% list of todos is added, independent of this setting here. + + + +%% ======================================================================== +%%%% Document metadata +%% ======================================================================== + +%% general metadata: +\newcommand{\myauthor}{AUTHOR} %% also used for PDF metadata (hyperref) +\newcommand{\mytitle}{TITLE} %% also used for PDF metadata (hyperref) +\newcommand{\mysubject}{SUBJECT} %% also used for PDF metadata (hyperref) +\newcommand{\mykeywords}{KEYWORDS} %% also used for PDF metadata (hyperref) + +%% this information is used only for generating the title page: +\newcommand{\myworktitle}{Master's Thesis} %% official type of work like ``Master theses'' +\newcommand{\mygrade}{Master of Science} %% title you are getting with this work like ``Master of ...'' +\newcommand{\mystudy}{Telematik} %% your study like ``Arts'' +\newcommand{\myuniversity}{Graz University of Technology} %% your university/school +\newcommand{\myinstitute}{Institute for Softwaretechnology} %% affiliation +\newcommand{\myinstitutehead}{Univ.-Prof.\,Dipl-Ing.\,Dr.techn.~Some One} %% head of institute +\newcommand{\mysupervisor}{Dr.~Some Body} %% your supervisor +\newcommand{\myevaluator}{Prof.~Some Genius} %% your evaluator +\newcommand{\myhomestreet}{Street~42} %% your home street (with house number) +\newcommand{\myhometown}{Graz} %% your home town +\newcommand{\myhomepostalnumber}{8010} %% your postal number of home town +\newcommand{\mysubmissionmonth}{November} %% month you are handing in +\newcommand{\mysubmissionyear}{2013} %% year you are handing in +\newcommand{\mysubmissiontown}{\myhometown} %% town of handing in (or \myhometown) + +%% additional information for generic_documentation title page +\newcommand{\myid}{1234567} %% Matrikelnummer +\newcommand{\mylecture}{LECTURE} %% + + +%% ======================================================================== +%%%% MISC command definitions +%% ======================================================================== +\input{template/mycommands} + +%% ======================================================================== +%%%% Typographic settings +%% ======================================================================== +\input{template/typographic_settings} + + +%% ======================================================================== +%%%% MISC usepackages +%% ======================================================================== + +%% ... it's OK to put here your own usepackage commands ... + + + + +%% ======================================================================== +%%%% MISC self-defined commands and settings +%% ======================================================================== + +%% ... it's OK to put here your own newcommand/newenvironment-definitions ... + + + + +\newcommand{\myLaT}{\LaTeX{}@TUG\xspace} %% LaTeX@TUG text "logo" + +\hyphenation{ex-am-ple hy-phen-ate} %% in order to use German umlauts +%% here (Ver-\"of-fent-li-chung), you have to check for +%% activated \usepackage[T1]{fontenc} in the preamble + +%% override default language of babel: (be sure to know, what you're +%% doing here) +%\selectlanguage{american} +%\selectlanguage{ngerman} + +%% ======================================================================== +%%%% Templates +%% ======================================================================== + +%% template for inserting figures: +% \myfig{}%% filename +% {}%% width/height +% {}%% caption +% {}%% optional (short) caption for list of figures +% {fig:}%% label + +%% acronyms in small caps: \myacro{UNESCO} + + +\input{template/pdf_settings} %% should be *last* definitions in preamble! +%% ======================================================================== +%%%% begin{document} +%% ======================================================================== +\begin{document} + +\frontmatter %% KOMA: roman page numbers and such; only available in scrbook + +\input{colophon} %% defines information about editor, LaTeX, font, ... + +%% Choose your desired title page: +\input{\mytitlepage} %% include title page + + +\input{template/declaration_TU_Graz} %% Statutory Declaration +% \input{thanks} %% this is a suggestion: you have to create this file on demand +% \input{foreword} %% this is a suggestion: you have to create this file on demand + + +%% include the abstract without chapter number but include it on table of contents: +\cleardoublepage +\addcontentsline{toc}{chapter}{Abstract} +\include{abstract} %% Abstract + + +\tableofcontents %% this produces the table of contents - you might have guessed :-) + +\listoffigures + +%% if myaddlistoftodos is set to "true", the current list of open todos is added: +\ifthenelse{\boolean{myaddlistoftodos}}{ + \newpage\listoftodos %% handy if you are using todonotes with \todo{} +}{} %% with todonotes-package option "disable" you can get rid of any todo in the output + +\mainmatter %% KOMA: marks main part using arabic page numbers and such; only available in scrbook + + +\input{example-short-chapter} %% remove this line to get rid of the example chapter +\input{example-style-chapter} %% remove this line to get rid of the style chapter + +%% include tex file chapters: +% \include{introduction} %% this is a suggestion: you have to create this file on demand +% \include{problem} %% this is a suggestion: you have to create this file on demand +% \include{solution} %% this is a suggestion: you have to create this file on demand +% \include{evaluation} %% this is a suggestion: you have to create this file on demand +% \include{outlook} %% this is a suggestion: you have to create this file on demand + +\appendix %% closes main document, appendix follows until end; only available in book-classes +\addpart*{Appendix} %% adding Appendix to tableofcontents + +\printbibliography %% remove, if using BibTeX instead of biblatex +% \include{further_ressources} %% this is a suggestion: you have to create this file on demand + + + + + + +%%%% end{document} +\end{document} +%% vim:foldmethod=expr +%% vim:fde=getline(v\:lnum)=~'^%%%%\ .\\+'?'>1'\:'=' +%%% Local Variables: +%%% mode: latex +%%% mode: auto-fill +%%% mode: flyspell +%%% eval: (ispell-change-dictionary "en_US") +%%% TeX-master: "main" +%%% End: diff --git a/references-biblatex.bib b/references-biblatex.bib new file mode 100644 index 0000000..16ea050 --- /dev/null +++ b/references-biblatex.bib @@ -0,0 +1,206 @@ + +@Online{tagstore, + OPTkey = {}, + author = {Karl Voit}, + title = {tagstore --- Project home page}, + URL = {http://tagstore.org}, + urldate = {2011-12-10}, + month = dec, + year = 2011, + OPTnote = {}, + OPTannote = {} +} + + +@Proceedings{PIM2009, + title = {PIM09 ASIS\&T 2009 Workshop, Vancouver, BC, Canada}, + year = 2009, + OPTeditor = {}, + OPTvolume = {}, + OPTnumber = {}, + OPTseries = {}, + address = {Vancouver, Canada}, + month = nov, + OPTorganization = {}, + OPTpublisher = {}, + OPTnote = {}, + URL = {http://pimworkshop.org/2009/index.php?page=acceptedpapers}, + OPTannote = {} +} + +@InProceedings{Voit2009, + crossref = {PIM2009}, + author = {Karl Voit and Keith Andrews and Wolfgang Slany}, + title = {Why Personal Information Management (PIM) Technologies Are Not Widespread}, + OPTkey = {}, + pages = {60--64}, + OPTeditor = {}, + OPTvolume = {}, + OPTnumber = {}, + OPTseries = {}, + OPTaddress = {}, + OPTorganization = {}, + OPTpublisher = {}, + OPTnote = {}, + URL = {http://pimworkshop.org/2009/index.php?page=acceptedpapers}, + OPTannote = {} +} + +@Proceedings{USAB2011, + title = {Proc.\ 7\textsuperscript{th} Conference of the + Austrian Computer Society Workgroup: Human-Computer + Interaction (Usab 2011)}, + location = {Graz, Austria}, + series = {LNCS}, + volume = {7058}, + publisher = {Springer}, + isbn = {3642253636}, + year = 2011, + month = nov, + doi = {10.1007/978-3-642-25364-5_33} +} + +@inproceedings{Voit2011, + crossref = {USAB2011}, + author = {Karl Voit and Keith Andrews and Wolfgang Slany}, + title = {{TagTree}: Storing and Re-finding Files Using Tags}, + pages = {471--481} +} + +@online{KeithThesis, + author = {Keith Andrews}, + title = {Writing a Thesis: Guidelines for Writing a Master's Thesis + in Computer Science}, + howpublished = {Graz University of Technology, Austria}, + month = dec, + year = 2011, + url = {http://ftp.iicm.edu/pub/keith/thesis/} +} + +@Book{Bringhurst1993, + author = {Robert Bringhurst}, + ALTeditor = {}, + title = {The Elements of Typographic Style}, + publisher = {Hartley & Marks Publishers}, + year = 1993, + OPTkey = {}, + OPTvolume = {}, + OPTnumber = {}, + OPTseries = {}, + OPTaddress = {}, + edition = {first edition}, + OPTmonth = {}, + OPTnote = {}, + OPTannote = {} +} + +@Book{Eijkhout2008, + author = {Victor Eijkhout}, + ALTeditor = {}, + title = {\TeX{} by Topic, a \TeX{}nician's Reference}, + publisher = {}, + year = 2008, + OPTkey = {}, + OPTvolume = {}, + OPTnumber = {}, + OPTseries = {}, + OPTaddress = {}, + edition = {document revision 1.2}, + month = may, + url = {http://www.eijkhout.net/texbytopic/texbytopic.html}, + OPTnote = {}, + OPTannote = {} +} + +@book{StrunkWhite, + author = {Strunk, Jr, William and Elwyn Brooks White}, + title = {The Elements of Style}, + publisher = {Longman}, + edition = {Fourth}, + year = 1999, + isbn = {020530902X}, +} + +@booklet{Strunk, + author = {Strunk, Jr, William}, + title = {The Elements of Style}, + edition = {First}, + year = 1918, + url = {http://www.bartleby.com/141/}, +} + +@booklet{NASAGuide, + author = {Mary K. McCaskill}, + title = {Grammar, Punctuation, and Capitalization: + A Handbook for Technical Writers and Editors}, + howpublished = {NASA Langley Research Center SP-7084}, + day = 3, + month = aug, + year = 1998, + url = {http://stipo.larc.nasa.gov/sp7084/}, +} + +@book{Zobel-WritingCompSci, + author = {Justin Zobel}, + title = {Writing for Computer Science}, + edition = {Second}, + publisher = {Springer}, + year = 2004, + isbn = {1852338024}, +} + +@book{BugsInWriting, + author = {Lyn Dupré}, + title = {Bugs in Writing: A Guide to Debugging Your Prose}, + publisher = {Addison-Wesley}, + edition = {Second}, + year = 1998, + isbn = {020137921X}, +} + +@book{Phillips-HowGetPhD, + author = {Estelle M. Phillips and Derek S. Pugh}, + title = {How to Get a PhD}, + edition = {Fourth}, + publisher = {Open University Press}, + year = 2005, + isbn = {0335216846}, +} + +@online{Roget, + author = {Roget}, + title = {Roget's Interactive Thesaurus}, + year = 2004, + url = {http://www.thesaurus.com/}, +} + +@online{RogetII, + author = {Roget}, + title = {Roget's II: The New Thesaurus}, + edition = {Third}, + year = 1995, + url = {http://www.bartleby.com/62/}, +} + + +@online{DictionaryCom, + author = {dictionary.com}, + title = {dictionary.com}, + year = 2004, + url = {http://dictionary.com/}, +} + +@online{DictLeoOrg, + author = {Leo}, + title = {Leo English-German Dictionary}, + year = 2004, + url = {http://dict.leo.org/}, +} + +@online{DictChemnitz, + author = {TU Chemnitz}, + title = {German-English Dictionary}, + year = 2004, + url = {http://dict.tu-chemnitz.de/}, +} + diff --git a/references-bibtex.bib b/references-bibtex.bib new file mode 100644 index 0000000..3ef0c98 --- /dev/null +++ b/references-bibtex.bib @@ -0,0 +1,96 @@ + +@Misc{tagstore, + OPTkey = {}, + author = {Karl Voit}, + title = {tagstore --- Project home page}, + howpublished = {http://tagstore.org}, + month = dec, + year = 2011, + OPTnote = {}, + OPTannote = {} +} + + +@InProceedings{Voit2009, + author = {Karl Voit and Keith Andrews and Wolfgang Slany}, + title = {{Why Personal Information Management (PIM) Technologies Are Not Widespread}}, + OPTcrossref = {}, + OPTkey = {}, + booktitle = {PIM09 ASIS\&T 2009 Workshop, Vancouver, BC, Canada}, + pages = {60--64}, + year = {2009}, + OPTeditor = {}, + OPTvolume = {}, + OPTnumber = {}, + OPTseries = {}, + OPTaddress = {}, + OPTmonth = nov, + OPTorganization = {}, + OPTpublisher = {}, + OPTnote = {}, + URL = {http://pimworkshop.org/2009/index.php?page=acceptedpapers}, + OPTannote = {} +} + +@inproceedings{Voit2011, + author = "Karl Voit and Keith Andrews and Wolfgang Slany", + title = "{TagTree}: Storing and Re-finding Files Using Tags", + booktitle = "Proc.\ 7\textsuperscript{th} Conference of the + Austrian Computer Society Workgroup: Human-Computer + Interaction (Usab 2011)", + location = "Graz, Austria", + series = "LNCS", + volume = "7058", + publisher = "Springer", + isbn = "3642253636", + year = 2011, + month = nov, + pages = "471--481", + doi = "10.1007/978-3-642-25364-5_33", +} + +@booklet{KeithThesis, + author = {Keith Andrews}, + title = {Writing a Thesis: Guidelines for Writing a Master's Thesis + in Computer Science}, + howpublished = {Graz University of Technology, Austria}, + month = dec, + year = 2011, + url = {http://ftp.iicm.edu/pub/keith/thesis/} +} + +@Book{Bringhurst1993, + author = {Robert Bringhurst}, + ALTeditor = {}, + title = {The Elements of Typographic Style}, + publisher = {}, + year = 1993, + OPTkey = {}, + OPTvolume = {}, + OPTnumber = {}, + OPTseries = {}, + OPTaddress = {}, + edition = {first edition}, + OPTmonth = {}, + OPTnote = {}, + OPTannote = {} +} + +@Book{Eijkhout2008, + author = {Victor Eijkhout}, + ALTeditor = {}, + title = {\TeX{} by Topic, a \TeX{}nician's Reference}, + publisher = {}, + year = 2008, + OPTkey = {}, + OPTvolume = {}, + OPTnumber = {}, + OPTseries = {}, + OPTaddress = {}, + edition = {document revision 1.2}, + month = may, + url = {http://www.eijkhout.net/texbytopic/texbytopic.html}, + OPTnote = {}, + OPTannote = {} +} + diff --git a/template/declaration_TU_Graz.tex b/template/declaration_TU_Graz.tex new file mode 100644 index 0000000..03328f4 --- /dev/null +++ b/template/declaration_TU_Graz.tex @@ -0,0 +1,62 @@ +%%%% Time-stamp: <2013-01-02 14:43:58 vk> +%% ======================================================================== +%%%% Disclaimer +%% ======================================================================== +%% +%% created by +%% +%% Karl Voit +%% + +\section*{Statutory Declaration} + +I declare that I have authored this thesis independently, that I have +not used other than the declared sources/resources, and that I have +explicitly marked all material which has been quoted either literally +or by content from the used sources. + +\vfill + +%% definition of the block tat contains date and signature +\newcommand{\mysignatureblock}[3]{% + %% Sorry, this is a "bit" of a hack. Maybe someone knows a more elegant method? + \begin{tabular}{llp{2em}l} + #1 & \hspace{5cm} & & \hspace{6cm} \\\cline{2-2}\cline{4-4} + & & & \\[-3mm] + & {\footnotesize #2} & & {\footnotesize #3} + \end{tabular} +} + +\mysignatureblock{Graz,}{Date}{Signature} + +\vfill +\vfill +\vfill +\vfill + +\section*{Eidesstattliche Erklärung\footnote{% +\foreignlanguage{ngerman}{Beschluss der Curricula-Kommission für Bachelor-, Master- und +Diplomstudien vom 10.11.2008; +Genehmigung des Senates am 1.12.2008}}} + +\foreignlanguage{ngerman}{% +Ich erkläre an Eides statt, dass ich die +vorliegende Arbeit selbstständig verfasst, andere als die angegebenen +Quellen/Hilfsmittel nicht benutzt, und die den benutzten Quellen +wörtlich und inhaltlich entnommenen Stellen als solche kenntlich +gemacht habe.} + +\vfill + +\mysignatureblock{Graz, am}{Datum}{Unterschrift} + + +\newpage +\newpage + +%%% Local Variables: +%%% mode: latex +%%% mode: auto-fill +%%% mode: flyspell +%%% TeX-master: "../main" +%%% End: diff --git a/template/mycommands.tex b/template/mycommands.tex new file mode 100644 index 0000000..8093aea --- /dev/null +++ b/template/mycommands.tex @@ -0,0 +1,118 @@ +%% Time-stamp: <2013-02-07 11:51:00 vk> +%%%% === Disclaimer: ======================================================= +%% created by +%% +%% Karl Voit +%% +%% using GNU/Linux, GNU Emacs & LaTeX 2e +%% + +%doc% +%doc% \section{\texttt{mycommands.tex} --- various definitions}\myinteresting +%doc% \label{sec:mycommands} +%doc% +%doc% In file \verb#template/mycommands.tex# many useful commands are being +%doc% defined. +%doc% +%doc% \paragraph{What should I do with this file?} Please take a look at its +%doc% content to get the most out of your document. +%doc% + +%doc% +%doc% One of the best advantages of \LaTeX{} compared to \myacro{WYSIWYG} software products is +%doc% the possibility to define and use macros within text. This empowers the user to +%doc% a great extend. Many things can be defined using \verb#\newcommand{}# and +%doc% automates repeating tasks. It is recommended to use macros not only for +%doc% repetitive tasks but also for separating form from content such as \myacro{CSS} +%doc% does for \myacro{XHTML}. Think of including graphics in your document: after +%doc% writing your book, you might want to change all captions to the upper side of +%doc% each figure. In this case you either have to modify all +%doc% \texttt{includegraphics} commands or you were clever enough to define something +%doc% like \verb#\myfig#\footnote{See below for a detailed description}. Using a +%doc% macro for including graphics enables you to modify the position caption on only +%doc% \emph{one} place: at the definition of the macro. +%doc% +%doc% The following section describes some macros that came with this document template +%doc% from \myLaT and you are welcome to modify or extend them or to create +%doc% your own macros! +%doc% + +%doc% +%doc% \subsection{\texttt{myfig} --- including graphics made easy} +%doc% +%doc% The classic: you can easily add graphics to your document with \verb#\myfig#: +%doc% \begin{verbatim} +%doc% \myfig{flower}%% filename w/o extension in the folder figures +%doc% {width=0.7\textwidth}%% maximum width/height, aspect ratio will be kept +%doc% {This flower was photographed at my home town in 2010}%% caption +%doc% {Home town flower}%% optional (short) caption for list of figures +%doc% {fig:flower}%% label +%doc% \end{verbatim} +%doc% +%doc% There are many advantages of this command (compared to manual +%doc% \texttt{figure} environments and \texttt{includegraphics} commands: +%doc% \begin{itemize} +%doc% \item consistent style throughout the whole document +%doc% \item easy to change; for example move caption on top +%doc% \item much less characters to type (faster, error prone) +%doc% \item less visual clutter in the \TeX{}-files +%doc% \end{itemize} +%doc% +%doc% +\newcommand{\myfig}[5]{ +%% example: +% \myfig{}%% filename in figures folder +% {width=0.5\textwidth,height=0.5\textheight}%% maximum width/height, aspect ratio will be kept +% {}%% caption +% {}%% optional (short) caption for list of figures +% {}%% label +\begin{figure}%[htp] + \begin{center} + \includegraphics[keepaspectratio,#2]{figures/#1} + \caption[#4]{#3} + \label{#5} %% NOTE: always label *after* caption! + \end{center} +\end{figure} +} + + +%doc% +%doc% \subsection{\texttt{myclone} --- repeat things!} +%doc% +%doc% Using \verb#\myclone[42]{foobar}# results the text \enquote{foobar} printed 42 times. +%doc% But you can not only repeat text output with \texttt{myclone}. +%doc% +%doc% Default argument +%doc% for the optional parameter \enquote{number of times} (like \enquote{42} in the example above) +%doc% is set to two. +%doc% +%% \myclone[x]{text} +\newcounter{myclonecnt} +\newcommand{\myclone}[2][2]{% + \setcounter{myclonecnt}{#1}% + \whiledo{\value{myclonecnt}>0}{#2\addtocounter{myclonecnt}{-1}}% +} + +%old% %d oc% +%old% %d oc% \subsection{\texttt{fixxme} --- sidemark something as unfinished} +%old% %d oc% +%old% %d oc% You know it: something has to be fixed and you can not do it right +%old% %d oc% now. In order to \texttt{not} forget about it, you might want to add a +%old% %d oc% note like \verb+\fixxme{check again}+ which inserts a note on the page +%old% %d oc% margin such as this\fixxme{check again} example. +%old% %d oc% +%old% \newcommand{\fixxme}[1]{%% +%old% \textcolor{red}{FIXXME}\marginpar{\textcolor{red}{#1}}%% +%old% } + + +%%%% End +%%% Local Variables: +%%% mode: latex +%%% mode: auto-fill +%%% mode: flyspell +%%% eval: (ispell-change-dictionary "en_US") +%%% TeX-master: "../main" +%%% End: +%% vim:foldmethod=expr +%% vim:fde=getline(v\:lnum)=~'^%%%%'?0\:getline(v\:lnum)=~'^%doc.*\ .\\%(sub\\)\\?section{.\\+'?'>1'\:'1': diff --git a/template/pdf_settings.tex b/template/pdf_settings.tex new file mode 100644 index 0000000..a56e953 --- /dev/null +++ b/template/pdf_settings.tex @@ -0,0 +1,83 @@ +%%%% Time-stamp: <2014-03-23 13:40:59 vk> +%%%% === Disclaimer: ======================================================= +%% created by +%% +%% Karl Voit +%% +%% using GNU/Linux, GNU Emacs & LaTeX 2e +%% + +%doc% +%doc% \section{\texttt{pdf\_settings.tex} --- Settings related to PDF output} +%doc% \label{sec:pdf} +%doc% +%doc% The file \verb#template/pdf_settings.tex# basically contains the definitions for +%doc% the \href{http://tug.org/applications/hyperref/}{\texttt{hyperref} package} +%doc% including the +%doc% \href{http://www.ctan.org/tex-archive/macros/latex/required/graphics/}{\texttt{graphicx} +%doc% package}. Since these settings should be the last things of any \LaTeX{} +%doc% preamble, they got their own \TeX{} file which is included in \texttt{main.tex}. +%doc% +%doc% \paragraph{What should I do with this file?} The settings in this file are +%doc% important for \myacro{PDF} output and including graphics. Do not exclude the +%doc% related \texttt{input} command in \texttt{main.tex}. But you might want to +%doc% modify some settings after you read the +%doc% \href{http://tug.org/applications/hyperref/}{documentation of the \texttt{hyperref} package}. +%doc% + + +%% Fix positioning of images in PDF viewers. (disabled by +%% default; see https://github.com/novoid/LaTeX-KOMA-template/issues/4 +%% for more information) +%% I do not have time to read about possible side-effect of this +%% package for now. +% \usepackage[hypcap]{caption} + +%% Declarations of hyperref should be the last definitions of the preamble: +%% FIXXME: black-and-white-version for printing! + +\pdfcompresslevel=9 + +\usepackage[% +unicode=true, % loads with unicode support +%a4paper=true, % +pdftex=true, % +backref, % +pagebackref=false, % creates backward references too +bookmarks=false, % +bookmarksopen=false, % when starting with AcrobatReader, the Bookmarkcolumn is opened +pdfpagemode=None,% None, UseOutlines, UseThumbs, FullScreen +plainpages=false, % correct, if pdflatex complains: ``destination with same identifier already exists'' +%% colors: https://secure.wikimedia.org/wikibooks/en/wiki/LaTeX/Colors +urlcolor=DispositionColor, %% +linkcolor=DispositionColor, %% +pagecolor=DispositionColor, %% +citecolor=DispositionColor, %% +anchorcolor=DispositionColor, %% +colorlinks=\mycolorlinks, % turn on/off colored links (on: better for + % on-screen reading; off: better for printout versions) +]{hyperref} + +%% all strings need to be loaded after hyperref was loaded with unicode support +%% if not the field is garbled in the output for characters like ČŽĆŠĐ +\hypersetup{ +pdftitle={\mytitle}, % +pdfauthor={\myauthor}, % +pdfsubject={\mysubject}, % +pdfcreator={Accomplished with: pdfLaTeX, biber, and hyperref-package. No animals, MS-EULA or BSA-rules were harmed.}, +pdfproducer={\myauthor}, +pdfkeywords={\mykeywords} +} + +%\DeclareGraphicsExtensions{.pdf} + +%%%% END +%%% Local Variables: +%%% TeX-master: "../main" +%%% mode: latex +%%% mode: auto-fill +%%% mode: flyspell +%%% eval: (ispell-change-dictionary "en_US") +%%% End: +%% vim:foldmethod=expr +%% vim:fde=getline(v\:lnum)=~'^%%%%'?0\:getline(v\:lnum)=~'^%doc.*\ .\\%(sub\\)\\?section{.\\+'?'>1'\:'1': diff --git a/template/pdflatex+biber.bat b/template/pdflatex+biber.bat new file mode 100644 index 0000000..6f938be --- /dev/null +++ b/template/pdflatex+biber.bat @@ -0,0 +1,39 @@ +REM ===================================================== +REM This is a batch file to compile using pdflatex and biber (biblatex). +REM When used with TeXworks, add it as batch tool: +REM ===================================================== +REM English: +REM Edit > Preferences ... > Typesetting > Processing tools +REM + (new tool): +REM Name: pdflatex+biber +REM Program: (find this pdflatex+biber.bat on your disk and use it here) +REM Arguments: +REM $fullname +REM $basename +REM [x] View PDF after running +REM ===================================================== +REM German: +REM Bearbeiten > Einstellungen ... > Textsatz > Verarbeitungsprogramme +REM + (neues Verarbeitungsprogramm): +REM Name: pdflatex+biber +REM Befehl/Datei: (diese pdflatex+biber.bat im Laufwerk suchen und einbinden) +REM Argumente: +REM $fullname +REM $basename +REM [x] PDF nach Beendigung anzeigen +REM ===================================================== +REM idea from: http://tex.stackexchange.com/questions/69705/how-to-automate-using-biber-in-miktex-texworks +REM adopted by: Karl Voit, 2013-02-02 +REM ===================================================== + +REM call pdflatex using parameters suitable for miktex: +miktex-pdftex.exe -synctex=1 -undump=pdflatex "%1" + +REM generate the references metadata for biblatex (using biber): +biber.exe "%2" + +REM call pdflatex twice to compile the references and finalize PDF: +miktex-pdftex.exe -synctex=1 -undump=pdflatex "%1" +miktex-pdftex.exe -synctex=1 -undump=pdflatex "%1" + +REM end \ No newline at end of file diff --git a/template/preamble.tex b/template/preamble.tex new file mode 100644 index 0000000..0f1e30a --- /dev/null +++ b/template/preamble.tex @@ -0,0 +1,697 @@ +%% Time-stamp: <2013-12-20 19:58:51 vk> +%%%% === Disclaimer: ======================================================= +%% created by +%% +%% Karl Voit +%% +%% using GNU/Linux, GNU Emacs & LaTeX 2e +%% + +%doc% %% overriding preamble/preamble.tex %% +%doc% \newcommand{\mylinespread}{1.0} \newcommand{\mycolorlinks}{true} +%doc% \documentclass[12pt,paper=a4,parskip=half,DIV=calc,oneside,%% +%doc% headinclude,footinclude=false,open=right,bibliography=totoc]{scrartcl} +%doc% \usepackage[utf8]{inputenc}\usepackage[ngerman,american]{babel}\usepackage{scrpage2} +%doc% \usepackage{ifthen}\usepackage{eurosym}\usepackage{xspace}\usepackage[usenames,dvipsnames]{xcolor} +%doc% \usepackage[protrusion=true,factor=900]{microtype} +%doc% \usepackage{enumitem} +%doc% \usepackage[pdftex]{graphicx} +%doc% \usepackage{todonotes} +%doc% \usepackage{dingbat,bbding} %% special characters +%doc% \definecolor{DispositionColor}{RGB}{30,103,182} +%doc% +%doc% \usepackage[backend=biber,style=authoryear,dashed=false,natbib=true,hyperref=true%% +%doc% ]{biblatex} +%doc% +%doc% \addbibresource{references-biblatex.bib} %% remove, if using BibTeX instead of biblatex +%doc% +%doc% %% overriding userdata %% +%doc% \newcommand{\myauthor}{Karl Voit}\newcommand{\mytitle}{LaTeX Template Documentation} +%doc% \newcommand{\mysubject}{A Comprehensive Guide to Use the +%doc% Template from https://github.com/novoid/LaTeX-KOMA-template} +%doc% \newcommand{\mykeywords}{LaTeX, pdflatex, template, documentation, biber, biblatex} +%doc% +%doc% \newcommand{\myLaT}{\LaTeX{}@TUG\xspace} +%doc% +%doc% %% for future use? +%doc% % \usepackage{filecontents} +%doc% % \begin{filecontents}{filename.example} +%doc% % +%doc% % \end{filecontents} +%doc% +%doc% +%doc% %% using existing TeX files %% +%doc% \input{template/mycommands} +%doc% \input{template/typographic_settings} +%doc% \input{template/pdf_settings} +%doc% +%doc% \begin{document} +%doc% %% title page %% +%doc% \title{\mytitle}\subtitle{\mysubject} +%doc% \author{\myauthor} +%doc% \date{\today} +%doc% +%doc% \maketitle\newpage +%doc% +%doc% \tableofcontents\newpage +%doc% %%---------------------------------------%% + +%doc% +%doc% \section{How to use this \LaTeX{} document template} +%doc% +%doc% This \LaTeX{} document template from +%doc% \myLaT\footnote{\url{http://LaTeX.TUGraz.at}} is based on \myacro{KOMA} +%doc% script\footnote{\url{http://komascript.de/}}. You don't need any +%doc% special \myacro{KOMA} knowledge (but it woun't hurt either). It provides an easy to use and +%doc% easy to modify template. All settings are documented and many references to +%doc% additional information sources are given. +%doc% + +%doc% In general, there should not be any reason to modify a file in +%doc% the \texttt{template} folder. \emph{All important settings are +%doc% accessible in the main folder, mostly in the \texttt{main.tex} +%doc% file.} This way, it is easy to get what you need and you can update +%doc% the template independent of the content of the document. +%doc% +%doc% \newcommand{\myimportant}{%% mark important chapters +%doc% \marginpar{\vspace{-1em}\rightpointleft} +%doc% } +%doc% \newcommand{\myinteresting}{\marginpar{\vspace{-2em}\PencilLeftDown}} + +%doc% +%doc% The \emph{absolute minimum you should read} is listed below and +%doc% marked with the hand symbol:\myimportant +%doc% \begin{itemize} +%doc% \item Section~\ref{sec:modifytemplate}: basic configuration of this template. +%doc% \item Section~\ref{sec:howtocompile}: how to generate the \myacro{PDF} file +%doc% \item Section~\ref{sec:references}: using biblatex (instead of bibtex) +%doc% \end{itemize} +%doc% +%doc% In order to get a perfect resulting document and to get an +%doc% exciting experience with this template, you should definitely consider reading +%doc% following sections which are also marked with the pencil symbol:\myinteresting +%doc% \begin{itemize} +%doc% \item Section~\ref{sec:extending-template}: extend the template with +%doc% your own usepackages, newcommands, and so forth +%doc% \item Section~\ref{sec:mycommands}: pre-defined commands to make your life easier (e.g., including graphics) +%doc% \item Section~\ref{sec:myacro}: how to do acronyms (like \myacro{ACME}) beautifully +%doc% \item Section~\ref{sub:csquotes}: how to \enquote{quote} text and use parentheses correctly +%doc% \end{itemize} +%doc% +%doc% The other sections describe all other settings for the sake of completeness. This is +%doc% interesting for learning more about \LaTeX{} and modifying this template to a higher level of detail. + +%doc% +%doc% \newpage +%doc% \subsection{Six Steps to Customize Your Document}\myimportant +%doc% \label{sec:modifytemplate} +%doc% +%doc% This template is optimized to get to the first draft of your thesis +%doc% very quickly. Follow these instructions and you get most of your +%doc% customizing done in a few minutes: +%doc% +%doc% \newcommand{\myfile}[1]{\texttt{\href{file:#1}{#1}}} +%doc% +%doc% \begin{enumerate} +%doc% \item Modify settings in \texttt{main.tex} to meet your requirements: +%doc% \begin{itemize} +%doc% \item Basic settings +%doc% \begin{itemize} +%doc% \item Paper size, languages, font size, citation style, +%doc% title page, and so forth +%doc% \end{itemize} +%doc% \item Document metadata +%doc% \begin{itemize} +%doc% \item Preferences like \verb+myauthor+, \verb+mytitle+, and so forth +%doc% \end{itemize} +%doc% \end{itemize} +%doc% \item Replace \myfile{figures/institution.pdf} with the logo of +%doc% your institution in either \myacro{PDF} or \myacro{PNG} +%doc% format.\footnote{Avoid \myacro{JPEG} format for +%doc% computer-generated (pixcel-oriented) graphics like logos or +%doc% screenshots in general. The \myacro{JEPG} format is for +%doc% photographs \emph{only}.} +%doc% \item Further down in \myfile{main.tex}: +%doc% \begin{itemize} +%doc% \item Create your desired structure for the chapters +%doc% (\verb+\include{introduction}+, \verb+\include{evaluation}+, \ldots) +%doc% \end{itemize} +%doc% \item Create the \TeX{} files and fill your content into these files you defined in the previous step. +%doc% \item Optionally: Modify \myfile{colophon.tex} to meet your situation. +%doc% \begin{itemize} +%doc% \item Please spend a couple of minutes and think about putting your work +%doc% under an open license\footnote{\url{https://creativecommons.org/licenses/}} +%doc% in order to follow the spirit of Open Science\footnote{\url{https://en.wikipedia.org/wiki/Open_science}}. +%doc% \end{itemize} +%doc% \item In case you are using \myacro{GNU} make\footnote{If you +%doc% don't know, what \myacro{GNU} make is, you are not using it (yet).}: +%doc% Put your desired \myacro{PDF} file name in the second line of file +%doc% \myfile{Makefile} +%doc% \begin{itemize} +%doc% \item replace \enquote{Projectname} with your filename +%doc% \item do not use any file extension like \texttt{.tex} or \texttt{.pdf} +%doc% \end{itemize} +%doc% \end{enumerate} +%doc% +%doc% + +%doc% +%doc% \subsection{License}\myimportant +%doc% \label{sec:license} +%doc% +%doc% This template is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) +%doc% license\footnote{\url{https://creativecommons.org/licenses/by-sa/3.0/}}: +%doc% \begin{itemize} +%doc% \item You can share (to copy, distribute and transmit) this template. +%doc% \item You can remix (adapt) this template. +%doc% \item You can make commercial use of the template. +%doc% \item In case you modify this template and share the derived +%doc% template: You must attribute the template such that you do not +%doc% remove (co-)authorship of Karl Voit and you must not remove +%doc% the URL to the original repository on +%doc% github\footnote{\url{https://github.com/novoid/LaTeX-KOMA-template}}. +%doc% \item If you alter, transform, or build a new template upon +%doc% this template, you may distribute the resulting +%doc% template only under the same or similar license to this one. +%doc% \item There are \emph{no restrictions} of any kind, however, related to the +%doc% resulting (PDF) document! +%doc% \item You may remove the colophon (but it's not recommended). +%doc% \end{itemize} + + +%doc% +%doc% +%doc% \subsection{How to compile this document}\myimportant +%doc% \label{sec:howtocompile} +%doc% +%doc% I assume that compiling \LaTeX{} documents within your software +%doc% environment is something you have already learned. This template is +%doc% almost like any other \LaTeX{} document except it uses +%doc% state-of-the-art tools for generating things like the list of +%doc% references using biblatex/biber (see +%doc% Section~\ref{sec:references} for details). Unfortunately, some \LaTeX{} editors +%doc% do not support this much better way of working with bibliography +%doc% references yet. This section describes how to compile this template. +%doc% +%doc% \subsubsection{Compiling Using a \LaTeX{} Editor} +%doc% +%doc% Please do select \myfile{main.tex} as the \enquote{main project file} or make +%doc% sure to compile/run only \myfile{main.tex} (and not \myfile{introduction.tex} +%doc% or other \TeX{} files of this template). +%doc% +%doc% Choose \texttt{biber} for generating the references. Modern LaTeX{} +%doc% environments offer this option. Older tools might not be that up to +%doc% date yet. +%doc% + +%doc% \subsubsection{Activating \texttt{biber} in the \LaTeX{} editor TeXworks} +%doc% \label{sec:biberTeXworks} +%doc% +%doc% The \href{https://www.tug.org/texworks/}{TeXworks} editor is a very +%doc% basic (but fine) \LaTeX{} editor to start with. It is included in +%doc% \href{http://miktex.org/}{MiKTeX} and +%doc% \href{http://miktex.org/portable}{MiKTeX portable} and supports +%doc% \href{https://en.wikipedia.org/wiki/Syntax_highlighting}{syntax +%doc% highlighting} and +%doc% \href{http://itexmac.sourceforge.net/SyncTeX.html}{SyncTeX} to +%doc% synchronize \myacro{PDF} output and \LaTeX{} source code. +%doc% +%doc% Unfortunately, TeXworks shipped with MiKTeX does not support compiling +%doc% using \texttt{biber} (biblatex) out of the box. Here is a solution to +%doc% this issue. Go to TeXworks: \texttt{Edit} $\rightarrow$ +%doc% \texttt{Preferences~\ldots} $\rightarrow$ \texttt{Typesetting} $\rightarrow$ +%doc% \texttt{Processing tools} and add a new entry (using the plus icon): +%doc% +%doc% \begin{tabbing} +%doc% Arguments: \= foobar \kill +%doc% Name: \> \verb#pdflatex+biber# \\ +%doc% Program: \> \emph{find the \texttt{template/pdflatex+biber.bat} file from your disk} \\ +%doc% Arguments: \> \verb+$fullname+ \\ +%doc% \> \verb+$basename+ +%doc% \end{tabbing} +%doc% +%doc% Activate the \enquote{View PDF after running} option. +%doc% +%doc% Close the preferences dialog and you will now have an additional +%doc% choice in the drop down list for compiling your document. Choose the +%doc% new entry called \verb#pdflatex+biber# and start a happier life with +%doc% \texttt{biber}. +%doc% +%doc% In case your TeXworks has a German user interface, here the key +%doc% aspects in German as well: +%doc% +%doc% \begin{otherlanguage}{ngerman} +%doc% +%doc% \texttt{Bearbeiten} $\rightarrow$ \texttt{Einstellungen~\ldots} $\rightarrow$ +%doc% \texttt{Textsatz} $\rightarrow$ \texttt{Verarbeitungsprogramme} $\rightarrow$ +%doc% + \emph{(neues Verarbeitungsprogramm)}: +%doc% +%doc% \begin{tabbing} +%doc% Befehl/Datei: \= foobar \kill +%doc% Name: \> pdflatex+biber \\ +%doc% Befehl/Datei: \> \emph{die \texttt{template/pdflatex+biber.bat} im Laufwerk suchen} \\ +%doc% Argumente: \> \verb+$fullname+ \\ +%doc% \> \verb+$basename+ +%doc% \end{tabbing} +%doc% +%doc% \enquote{PDF nach Beendigung anzeigen} aktivieren. +%doc% +%doc% \end{otherlanguage} +%doc% + +%doc% \subsubsection{Compiling Using \myacro{GNU} make} +%doc% +%doc% With \myacro{GNU} +%doc% make\footnote{\url{https://secure.wikimedia.org/wikipedia/en/wiki/Make\_\%28software\%29}} +%doc% it is just simple as that: \texttt{make pdf} +%doc% +%doc% Several other targets are available. You can check them out by +%doc% executing: \texttt{make help} +%doc% +%doc% In case you are using TeXLive (instead of MiKTeX as I do), you might +%doc% want to modify the line \texttt{PDFLATEX\_CMD = pdflatex} within +%doc% the file \texttt{Makefile} to: \texttt{PDFLATEX\_CMD = pdflatex -synctex=1 -undump=pdflatex} +%doc% +%doc% + +%doc% \subsubsection{Compiling in a Text-Shell} +%doc% +%doc% To generate a document using \texttt{Biber}, you can stick to +%doc% following example: +%doc% \begin{verbatim} +%doc% pdflatex main.tex +%doc% biber main +%doc% pdflatex main.tex +%doc% pdflatex main.tex +%doc% \end{verbatim} +%doc% +%doc% Users of TeXLive with Microsoft Windows might want to try the +%doc% following script\footnote{Thanks to Florian Brucker for provinding +%doc% this script.} which could be stored as, e.g., \texttt{compile.bat}: +%doc% \begin{verbatim} +%doc% REM call pdflatex using parameters suitable for TeXLive: +%doc% pdflatex.exe "main.tex" +%doc% REM generate the references metadata for biblatex (using biber): +%doc% biber.exe "main" +%doc% REM call pdflatex twice to compile the references and finalize PDF: +%doc% pdflatex.exe "main.tex" +%doc% pdflatex.exe -synctex=-1 -interaction=nonstopmode "main.tex" +%doc% \end{verbatim} +%doc% + + +%doc% +%doc% \subsection{How to get rid of the template documentation} +%doc% +%doc% Simply remove the files \verb#Template_Documentation.pdf# and +%doc% \verb#Template_Documentation.tex# (if it exists) in the main folder +%doc% of this template. +%doc% +%doc% \subsection{What about modifying or extending the template?}\myinteresting +%doc% \label{sec:extending-template} +%doc% +%doc% This template provides an easy to start \LaTeX{} document template with sound +%doc% default settings. You can modify each setting any time. It is recommended that +%doc% you are familiar with the documentation of the command whose settings you want +%doc% to modify. +%doc% +%doc% It is recommended that for \emph{adding} things to the preambel (newcommands, +%doc% setting variables, defining headers, \dots) you should use the file +%doc% \texttt{main.tex}. +%doc% There are comment lines which help you find the right spot. +%doc% This way you still have the chance to update your \texttt{template} +%doc% folder from the template repository without losing your own added things. +%doc% +%doc% The following sections describe the settings and commands of this template and +%doc% give a short overview of its features. + +%doc% \subsection{How to change the title page} +%doc% +%doc% This template comes with a variety of title pages. They are located in +%doc% the folder \texttt{template}. You can switch to a specific title +%doc% page by including the corresponding title page file in the file +%doc% \texttt{main.tex}. +%doc% +%doc% Please note that you may not need to modify any title page document by +%doc% yourself since all relevant information is defined in the file +%doc% \texttt{main.tex}. + +%doc% +%doc% \section{\texttt{preamble.tex} --- Main preamble file} +%doc% +%doc% In the file \verb#preamble/preamble.tex# you will find the basic +%doc% definitions related to your document. This template uses the \myacro{KOMA} script +%doc% extension package of \LaTeX{}. +%doc% +%doc% There are comments added to the \verb#\documentclass{}# definitions. Please +%doc% refer to the great documentation of \myacro{KOMA}\footnote{\texttt{scrguide.pdf} for +%doc% German users} for further details. +%doc% +%doc% \paragraph{What should I do with this file?} For standard purposes you might +%doc% use the default values it provides. You must not remove its \texttt{include} command +%doc% in \texttt{main.tex} since it contains important definitions. This file contains +%doc% settings which are documented well and can be modified according to your needs. +%doc% It is recommended that you fully understand each setting you modify in order to +%doc% get a good document result. However, you can set basic values in the +%doc% \texttt{main.tex} file: font size, paper size, +%doc% paragraph separation mode, draft mode, binding correction, and whether +%doc% your document will be a one sided document or you are planning to +%doc% create a document which is printed on both, left side and right side. +%doc% + +\documentclass[% +fontsize=\myfontsize,%% size of the main text +paper=\mypapersize, %% paper format +parskip=\myparskip, %% vertical space between paragraphs (instead of indenting first par-line) +DIV=calc, %% calculates a good DIV value for type area; 66 characters/line is great +headinclude=true, %% is header part of margin space or part of page content? +footinclude=false, %% is footer part of margin space or part of page content? +open=right, %% "right" or "left": start new chapter on right or left page +appendixprefix=true, %% adds appendix prefix; only for book-classes with \backmatter +bibliography=totoc, %% adds the bibliography to table of contents (without number) +draft=\mydraft, %% if true: included graphics are omitted and black boxes + %% mark overfull boxes in margin space +BCOR=\myBCOR, %% binding correction (depends on how you bind + %% the resulting printout. +\mylaterality %% oneside: document is not printed on left and right sides, only right side + %% twoside: document is printed on left and right sides +]{scrbook} %% article class of KOMA: "scrartcl", "scrreprt", or "scrbook". + %% CAUTION: If documentclass will be changed, *many* other things + %% change as well like heading structure, ... + + + +% FIXXME: adopting class usage: +% from scrbook -> scrartcl OR scrreport: +% - remove appendixprefix from class options +% - remove \frontmatter \mainmatter \backmatter \appendix from main.tex + +% FIXXME: adopting language: +% add or modify language parameter of package »babel« and use language switches described in babel-documentation + +%doc% +%doc% \subsection{\texttt{inputenc}: UTF8 as input charset} +%doc% +%doc% You are able and should use \myacro{UTF8} character settings for writing these \TeX{}-files. +%doc% +%\usepackage{ucs} %% UTF8 as input characters; UCS incompatible to biblatex +\usepackage[utf8]{inputenc} %% UTF8 as input characters +%% Source: http://latex.tugraz.at/latex/tutorial#laden_von_paketen + + +%doc% +%doc% \subsection{\texttt{babel}: Language settings} +%doc% +%doc% The default setting of the language is American. Please change settings for +%doc% additional or alternative languages used in \texttt{main.tex}. +%doc% +%doc% Please note that the default language of the document is the \emph{last} language +%doc% which is added to the package options. +%doc% +%doc% To set only parts of your document in a different language as the rest, use for example +%doc% \verb+\foreignlanguage{ngerman}{Beispieltext in deutscher Sprache}+. +%doc% For using foreign language quotes, please refer to the \verb+\foreignquote+, +%doc% \verb+\foreigntextquote+, or \verb+\foreignblockquote+ provided by +%doc% \texttt{csquotes} (see Section~\ref{sub:csquotes}). +%doc% +\usepackage[\mylanguage]{babel} %% used languages; default language is *last* language of options + +%doc% +%doc% \subsection{\texttt{scrpage2}: Headers and footers} +%doc% +%doc% Since this template is based on \myacro{KOMA} script it uses its great \texttt{scrpage2} +%doc% package for defining header and footer information. Please refer to the \myacro{KOMA} +%doc% script documentation how to use this package. +%doc% +\usepackage{scrpage2} %% advanced page style using KOMA + + +%doc% +%doc% \subsection{References}\myimportant +%doc% \label{sec:references} +%doc% +%doc% This template is using +%doc% \href{http://www.tex.ac.uk/tex-archive/info/translations/biblatex/de/}{\texttt{biblatex}} +%doc% and \href{http://en.wikipedia.org/wiki/Biber_(LaTeX)}{\texttt{Biber}} +%doc% instead of +%doc% \href{http://en.wikipedia.org/wiki/BibTeX}{\textsc{Bib}\TeX{}}. This has the following +%doc% advantages: +%doc% \begin{itemize} +%doc% \item better documentation +%doc% \item Unicode-support like German umlauts (ö, ä, ü, ß) for references +%doc% \item flexible definition of citation styles +%doc% \item multiple bibliographies e.\,g. for printed and online resources +%doc% \item cleaner reference definition e.\,g. inheriting information from +%doc% \texttt{Proceedings} to all related \texttt{InProceedings} +%doc% \item modern implementation +%doc% \end{itemize} +%doc% +%doc% In short, \texttt{biblatex} is able to handle your \texttt{bib}-files +%doc% and offers additional features. To get the most out of +%doc% \texttt{biblatex}, you should read the very good package +%doc% documentation. Be warned: you'll probably never want to change back +%doc% to \textsc{Bib}\TeX{} again. +%doc% +%doc% Take a look at the files \texttt{references-bibtex.bib} and +%doc% \texttt{references-biblatex.bib}: they contain the three +%doc% references \texttt{tagstore}, \texttt{Voit2009}, and +%doc% \texttt{Voit2011}. +%doc% The second file is optimized for \texttt{biblatex} and +%doc% takes advantage of some features that are not possible with +%doc% \textsc{Bib}\TeX{}. +%doc% +%doc% This template is ready to use \texttt{biblatex} with \texttt{Biber} as +%doc% reference compiler. You should make sure that you have installed an up +%doc% to date binary of \texttt{Biber} from its +%doc% homepage\footnote{\url{http://biblatex-biber.sourceforge.net/}}. +%doc% +%doc% +%doc% In \texttt{main.tex} you can define several general \texttt{biblatex} +%doc% options: citation style, whether or not multiple occurrences of +%doc% authors are replaced with dashes, or if backward references (from +%doc% references to citations) should be added. +%doc% +%doc% +%doc% If you are using the LaTeX{} editor TeXworks, please make sure that +%doc% you have read Section~\ref{sec:biberTeXworks} in order to use +%doc% \texttt{biber}. +%doc% + +%doc% \subsubsection{Example citation commands} +%doc% +%doc% This section demonstrates some example citations using the style \texttt{authoryear}. +%doc% You can change the citation style in \texttt{main.tex} (\texttt{mybiblatexstyle}). +%doc% +%doc% \begin{itemize} +%doc% \item cite \cite{Eijkhout2008} and cite \cite{Bringhurst1993, Eijkhout2008}. +%doc% \item citet \citet{Eijkhout2008} and citet \citet{Bringhurst1993, Eijkhout2008}. +%doc% \item autocite \autocite{Eijkhout2008} and autocite \autocite{Bringhurst1993, Eijkhout2008}. +%doc% \item autocites \autocites{Eijkhout2008} and autocites \autocites{Bringhurst1993, Eijkhout2008}. +%doc% \item citeauthor \citeauthor{Eijkhout2008} and citeauthor \citeauthor{Bringhurst1993, Eijkhout2008}. +%doc% \item citetitle \citetitle{Eijkhout2008} and citetitle \citetitle{Bringhurst1993, Eijkhout2008}. +%doc% \item citeyear \citeyear{Eijkhout2008} and citeyear \citeyear{Bringhurst1993, Eijkhout2008}. +%doc% \item textcite \textcite{Eijkhout2008} and textcite \textcite{Bringhurst1993, Eijkhout2008}. +%doc% \item smartcite \smartcite{Eijkhout2008} and smartcite \smartcite{Bringhurst1993, Eijkhout2008}. +%doc% \item footcite \footcite{Eijkhout2008} and footcite \footcite{Bringhurst1993, Eijkhout2008}. +%doc% \item footcite with page \footcite[p.42]{Eijkhout2008} and footcite with page \footcite[compare][p.\,42]{Eijkhout2008}. +%doc% \item fullcite \fullcite{Eijkhout2008} and fullcite \fullcite{Bringhurst1993, Eijkhout2008}. +%doc% \end{itemize} +%doc% +%doc% Please note that the citation style as well as the bibliography style +%doc% can be changed very easily. Refer to the settings in +%doc% \texttt{main.tex} as well as the very good documentation of \texttt{biblatex}. +%doc% + +%doc% \subsubsection{Using this template with \myacro{APA} style} +%doc% +%doc% First, you have to have the \myacro{APA} biblatex style +%doc% installed. Modern \LaTeX{} distributions do come with +%doc% \texttt{biblatex} and \myacro{APA} style. If so, you will find the +%doc% files \texttt{biblatex-apa.pdf} (style documentation) and +%doc% \texttt{biblatex-apa-test.pdf} (file with citation examples) on your +%doc% hard disk. +%doc% +%doc% \begin{enumerate} +%doc% \item Change the style according to \verb#\newcommand{\mybiblatexstyle}{apa}# +%doc% \item Add \verb#\DeclareLanguageMapping{american}{american-apa}# or \\ +%doc% \verb#\DeclareLanguageMapping{german}{german-apa}# to your +%doc% preamble\footnote{You might want to use section \enquote{MISC +%doc% self-defined commands and settings} for this.} +%doc% \end{enumerate} +%doc% +%doc% These steps change the biblatex style to \myacro{APA} style + +%doc% +%doc% \subsubsection{Using this template with \textsc{Bib}\TeX{}} +%doc% +%doc% If you do not want to use \texttt{Biber} and \texttt{biblatex}, you +%doc% have to change several things: +%doc% \begin{itemize} +%doc% \item in \verb#preamble/preamble.tex# +%doc% \begin{itemize} +%doc% \item remove the usepackage command of \texttt{biblatex} +%doc% \item remove the \verb#\addbibresource{...}# command +%doc% \end{itemize} +%doc% \item in \verb#main.tex# +%doc% \begin{itemize} +%doc% \item replace \verb=\printbibliography= with the usual +%doc% \verb=\bibliographystyle{yourstyle}= and \verb=\bibliography{yourbibfile}= +%doc% \end{itemize} +%doc% \item if you are using \myacro{GNU} \texttt{make}: modify \verb=Makefile= +%doc% \begin{itemize} +%doc% \item replace \verb#BIBTEX_CMD = biber# with \verb#BIBTEX_CMD = bibtex# +%doc% \end{itemize} +%doc% \item Use the reference file \texttt{references-bibtex.bib} +%doc% instead of \texttt{references-biblatex.bib} +%doc% \end{itemize} +%doc% +%doc% +\usepackage[backend=biber, %% using "biber" to compile references (instead of "biblatex") +style=\mybiblatexstyle, %% see biblatex documentation +%style=alphabetic, %% see biblatex documentation +dashed=\mybiblatexdashed, %% do *not* replace recurring reference authors with a dash +backref=\mybiblatexbackref, %% create backlings from references to citations +natbib=true, %% offering natbib-compatible commands +hyperref=true, %% using hyperref-package references +]{biblatex} %% remove, if using BibTeX instead of biblatex + +\addbibresource{\mybiblatexfile} %% remove, if using BibTeX instead of biblatex + + + +%doc% +%doc% \subsection{Miscellaneous packages} \label{subsec:miscpackages} +%doc% +%doc% There are several packages included by default. You might want to activate or +%doc% deactivate them according to your requirements: +%doc% +%doc% \begin{enumerate} + +%doc% \item[\texttt{\href{http://www.ctan.org/pkg/graphicx}{%% +%doc% graphicx%% +%doc% }}] +%doc% The widely used package to use graphical images within a \LaTeX{} document. +\usepackage[pdftex]{graphicx} + +%doc% \item[\texttt{\href{https://secure.wikimedia.org/wikibooks/en/wiki/LaTeX/Formatting\#Other\_symbols}{%% +%doc% pifont%% +%doc% }}] +%doc% For additional special characters available by \verb#\ding{}# +\usepackage{pifont} + + +%doc% \item[\texttt{\href{http://ctan.org/pkg/ifthen}{%% +%doc% ifthen%% +%doc% }}] +%doc% For using if/then/else statements for example in macros +\usepackage{ifthen} + +%% pre-define ifthen-boolean variables: +\newboolean{myaddcolophon} +\newboolean{myaddlistoftodos} + + +%doc% \item[\texttt{\href{http://www.ctan.org/tex-archive/fonts/eurosym}{%% +%doc% eurosym%% +%doc% }}] +%doc% Using the character for Euro with \verb#\officialeuro{}# +%\usepackage{eurosym} + +%doc% \item[\texttt{\href{http://www.ctan.org/tex-archive/help/Catalogue/entries/xspace.html}{%% +%doc% xspace%% +%doc% }}] +%doc% This package is required for intelligent spacing after commands +\usepackage{xspace} + +%doc% \item[\texttt{\href{https://secure.wikimedia.org/wikibooks/en/wiki/LaTeX/Colors}{%% +%doc% xcolor%% +%doc% }}] +%doc% This package defines basic colors. If you want to get rid of colored links and headings +%doc% please change corresponding value in \texttt{main.tex} to \{0,0,0\}. +\usepackage[usenames,dvipsnames]{xcolor} +\definecolor{DispositionColor}{RGB}{\mydispositioncolor} %% used for links and so forth in screen-version + +%doc% \item[\texttt{\href{http://www.ctan.org/pkg/ulem}{%% +%doc% ulem%% +%doc% }}] +%doc% This package offers strikethrough command \verb+\sout{foobar}+. +\usepackage[normalem]{ulem} + +%doc% \item[\texttt{\href{http://www.ctan.org/pkg/framed}{%% +%doc% framed%% +%doc% }}] +%doc% Create framed, shaded, or differently highlighted regions that can +%doc% break across pages. The environments defined are +%doc% \begin{itemize} +%doc% \item framed: ordinary frame box (\verb+\fbox+) with edge at margin +%doc% \item shaded: shaded background (\verb+\colorbox+) bleeding into margin +%doc% \item snugshade: similar +%doc% \item leftbar: thick vertical line in left margin +%doc% \end{itemize} +\usepackage{framed} + +%doc% \item[\texttt{\href{http://www.ctan.org/pkg/eso-pic}{%% +%doc% eso-pic%% +%doc% }}] +%doc% For example on title pages you might want to have a logo on the upper right corner of +%doc% the first page (only). The package \texttt{eso-pic} is able to place things on absolute +%doc% and relative positions on the whole page. +\usepackage{eso-pic} + +%doc% \item[\texttt{\href{http://ctan.org/pkg/enumitem}{%% +%doc% enumitem%% +%doc% }}] +%doc% This package replaces the built-in definitions for enumerate, itemize and description. +%doc% With \texttt{enumitem} the user has more control over the layout of those environments. +\usepackage{enumitem} + +%doc% \item[\texttt{\href{http://www.ctan.org/tex-archive/macros/latex/contrib/todonotes/}{%% +%doc% todonotes%% +%doc% }}] +%doc% This packages is \emph{very} handy to add notes\footnote{\texttt{todonotes} replaced +%doc% the \texttt{fixxme}-command which previously was defined in the +%doc% \texttt{preamble\_mycommands.tex} file.}. Using for example \verb#\todo{check}# +%doc% results in something like this \todo{check} in the document. Do read the +%doc% great package documentation for usage of other very helpful commands such as +%doc% \verb#\missingfigure{}# and \verb#\listoftodos#. The latter one creates an index of all +%doc% open todos which is very useful for getting an overview of open issues. +%doc% The package \texttt{todonotes} require the packages \texttt{ifthen}, \texttt{xkeyval}, \texttt{xcolor}, +%doc% \texttt{tikz}, \texttt{calc}, and \texttt{graphicx}. Activate +%doc% and configure \verb#\listoftodos# in \texttt{main.tex}. +%\usepackage{todonotes} +\usepackage[\mytodonotesoptions]{todonotes} %% option "disable" removes all todonotes output from resulting document + +%disabled% \item[\texttt{\href{http://www.ctan.org/tex-archive/macros/latex/contrib/blindtext}{%% +%disabled% blindtext%% +%disabled% }}] +%disabled% This package is used to generate blind text for demonstration purposes. +%disabled% %% This is undocumented due to problems using american english; author informed +%disabled% \usepackage{blindtext} %% provides commands for blind text: +%disabled% %% \blindtext creates some text, +%disabled% %% \Blindtext creates more text. +%disabled% %% \blinddocument creates a small document with sections, lists... +%disabled% %% \Blinddocument creates a large document with sections, lists... +%% 2012-03-10: vk: author published a corrected version which is able to handle "american english" as well. Did not have time to check new package version for this template here. + +%doc% \item[\texttt{\href{http://ctan.org/tex-archive/macros/latex/contrib/units}{%% +%doc% units%% +%doc% }}] +%doc% For setting correctly typesetted units and nice fractions with \verb+\unit[42]{m}+ and \verb+\unitfrac[100]{km}{h}+. +\usepackage{units} + + +%doc% \end{enumerate} + + + + +%%%% End +%%% Local Variables: +%%% TeX-master: "../main" +%%% mode: latex +%%% mode: auto-fill +%%% mode: flyspell +%%% eval: (ispell-change-dictionary "en_US") +%%% End: +%% vim:foldmethod=expr +%% vim:fde=getline(v\:lnum)=~'^%%%%'?0\:getline(v\:lnum)=~'^%doc.*\ .\\%(sub\\)\\?section{.\\+'?'>1'\:'1': diff --git a/template/title_Diplomarbeit_KF_Uni_Graz.tex b/template/title_Diplomarbeit_KF_Uni_Graz.tex new file mode 100644 index 0000000..9d811d6 --- /dev/null +++ b/template/title_Diplomarbeit_KF_Uni_Graz.tex @@ -0,0 +1,70 @@ +%%%% Time-stamp: <2013-02-02 21:30:07 vk> +%% ======================================================================== +%%%% Disclaimer +%% ======================================================================== +%% +%% created by +%% +%% Karl Voit +%% + + +\thispagestyle{empty} %% no page header or footer +\large %% basic font size of the titlepage + +\begin{center} +{\LARGE\bfseries\myworktitle} + +\vfill + +zur Erlangung des akademischen Grades eines\\[5mm] +{\LARGE\mygrade}\\[5mm] +der Studienrichtung \mystudy\\ +an der \myuniversity + +\vfill + +über das Thema\\[10mm] + +{\LARGE\bfseries\mytitle} + +\vfill + +eingereicht am\\ +\myinstitute + +Begutachter: \mysupervisor + +von\\[5mm] +{\Large\bfseries\myauthor}\\[5mm] +\myhomestreet\\ +\myhomepostalnumber~\myhometown + +\vfill + +\mysubmissiontown, \mysubmissionmonth~\mysubmissionyear + +\end{center} +\normalsize %% new page, reset font size + +\newpage + +%% if myaddcolophon is set to "true", colophon is added: +\ifthenelse{\boolean{myaddcolophon}}{ + \newpage + \thispagestyle{empty} %% no page header or footer + + ~ + \vfill + \mycolophon +}{} +\newpage + +%% end of title page +%%% Local Variables: +%%% mode: latex +%%% mode: auto-fill +%%% mode: flyspell +%%% eval: (ispell-change-dictionary "de_AT") +%%% TeX-master: "../main" +%%% End: diff --git a/template/title_Thesis_TU_Graz.tex b/template/title_Thesis_TU_Graz.tex new file mode 100644 index 0000000..43df24a --- /dev/null +++ b/template/title_Thesis_TU_Graz.tex @@ -0,0 +1,83 @@ +%%%% Time-stamp: <2013-02-02 21:28:44 vk> +%% ======================================================================== +%%%% Disclaimer +%% ======================================================================== +%% +%% created by +%% +%% Stefan Kroboth and Karl Voit +%% +%% this title page fulfills the requirements of the corporate design +%% of Graz University of Technology (correct placement of logo) + +\begin{titlepage} + +%\large %% basic font size of the titlepage + +%% placing the TU Graz logo exactly as Corporate Design demands: +%% 40mm of Logo (here: 2mm margin in picture!) +%% 8mm from top and from right +%% Source: http://portal.tugraz.at/portal/page/portal/TU_Graz/Services/BDR/Oeffentlichkeitsarbeit/CD/Logo%20Anwendungsrichtlinien +\AddToShipoutPicture*{% + \AtPageUpperLeft{% + \hspace{\paperwidth}% + \raisebox{-19mm}{%\baselineskip}{% + \makebox[-4mm][r]{\includegraphics[width=42mm]{figures/TU_Graz_Logo}} +}}}% + +\begin{center} +~ +\vfill\vfill\vfill + +\myauthor + +\vfill + +{\LARGE\bfseries\mytitle} + +\vfill\vfill\vfill + +{\bfseries\myworktitle} + +\vfill\vfill\vfill +\vfill\vfill\vfill +\vfill\vfill\vfill + +\myuniversity + +\vfill + +\myinstitute\\ +Head: \myinstitutehead\\ + +\vfill + +Supervisor: \mysupervisor\\ +%usually not mentioned on titlepage:% Evaluator: \myevaluator + +\vfill + +\mysubmissiontown, \mysubmissionmonth~\mysubmissionyear + +\end{center} +\end{titlepage} + +%% if myaddcolophon is set to "true", colophon is added: +\ifthenelse{\boolean{myaddcolophon}}{ + \newpage + \thispagestyle{empty} %% no page header or footer + + ~ + \vfill + \mycolophon +}{} +\newpage + +%% end of title page +%%% Local Variables: +%%% mode: latex +%%% mode: auto-fill +%%% mode: flyspell +%%% eval: (ispell-change-dictionary "en_US") +%%% TeX-master: "../main" +%%% End: diff --git a/template/title_VWA.tex b/template/title_VWA.tex new file mode 100644 index 0000000..8e4ca52 --- /dev/null +++ b/template/title_VWA.tex @@ -0,0 +1,62 @@ +%%%% Time-stamp: <2013-02-25 16:05:46 vk> +%% ======================================================================== +%%%% Titelseite für eine Vorwissenschaftliche Arbeit +%% ======================================================================== +%% +%% created by +%% +%% Karl Voit +%% + + +\thispagestyle{empty} %% no page header or footer +\large %% basic font size of the titlepage + +\begin{center} + +{\LARGE\bfseries\mytitle} + +\vfill + +Vorwissenschaftliche Arbeit verfasst von\\[5mm] +{\Large\bfseries\myauthor}\\[5mm] +Klasse \mystudy\\[50mm] + +\vfill + +\includegraphics[width=3cm]{figures/institution}\\[5mm] + +Betreuer: \mysupervisor + +\vfill + +\myinstitute\\ +\myhomestreet\\ +\myhomepostalnumber~\myhometown + +\vfill + +\mysubmissiontown, \mysubmissionmonth~\mysubmissionyear +\end{center} +\normalsize %% new page, reset font size +\newpage + +%% if myaddcolophon is set to "true", colophon is added: +\ifthenelse{\boolean{myaddcolophon}}{ + \newpage + \thispagestyle{empty} %% no page header or footer + + ~ + \vfill + \mycolophon +}{} +\newpage + +%% end of title page +%%% Local Variables: +%%% mode: latex +%%% mode: auto-fill +%%% mode: flyspell +%%% eval: (ispell-change-dictionary "de_AT") +%%% TeX-master: "../main" +%%% End: diff --git a/template/title_plain_maketitle.tex b/template/title_plain_maketitle.tex new file mode 100644 index 0000000..108a7d7 --- /dev/null +++ b/template/title_plain_maketitle.tex @@ -0,0 +1,47 @@ +%%%% Time-stamp: <2013-02-25 10:52:27 vk> +%% ======================================================================== +%%%% Disclaimer +%% ======================================================================== +%% +%% created by +%% +%% Karl Voit +%% +%% using grml GNU/Linux, vim & LaTeX 2e + +%% this is a very simple title page using LaTeX maketitle + +%% if myaddcolophon is set to "true", colophon is added: +\ifthenelse{\boolean{myaddcolophon}}{ + \lowertitleback{ + \mycolophon + }%% end lowertitleback +}{} + +\title{%% +~\hfill\includegraphics[width=3cm]{figures/institution}\\[5mm] %% a logo at the upper right corner +\mytitle} + +\subtitle{\mysubject} + +\author{\myauthor + \thanks{\href{http://LaTeX.TUGraz.at}{http://LaTeX.TUGraz.at}}\\ + \date{\today} +} + +\maketitle + + +%\thispagestyle{empty} %% no page number, header or footer + + + +%% vim:foldmethod=expr +%% vim:fde=getline(v\:lnum)=~'^%%%%\ .\\+'?'>1'\:'=' +%%% Local Variables: +%%% mode: latex +%%% mode: auto-fill +%%% mode: flyspell +%%% eval: (ispell-change-dictionary "en_US") +%%% TeX-master: "../main" +%%% End: diff --git a/template/todos.org b/template/todos.org new file mode 100644 index 0000000..134fd0a --- /dev/null +++ b/template/todos.org @@ -0,0 +1,255 @@ +## Time-stamp: <2013-02-25 11:04:54 vk> +## This file is best viewed with GNU Emacs Org-mode: http://orgmode.org/ +#+TODO: TODO(t) NEXT(n) WISH(w) | DONE(d) CANCELED(c) +#+TAGS: KarlVoit(k) + + +* NEXT pointers to [[http://en.wikibooks.org/wiki/LaTeX/Packages#Packages_list][other packages]] (not included in this template): +:PROPERTIES: +:CREATED: [2011-12-10 Sat 21:31] +:END: +- listings +- sidewaystable +- paralist (compact version of itemize and enumerate) +- ... + +* NEXT index (makeindex) +:PROPERTIES: +:CREATED: [2011-12-10 Sat 21:30] +:END: + +* NEXT acronyms +:PROPERTIES: +:CREATED: <2010-12-22 Fri 15:49> +:END: + +* WISH try [[http://www.komascript.de/titlepage]] for title pages +:PROPERTIES: +:CREATED: [2011-12-11 Sun 12:49] +:END: + +* WISH how to switch to scrreprt or scrartcle +:PROPERTIES: +:CREATED: [2011-12-10 Sat 21:31] +:END: + +* WISH pointers to other LaTeX templates +:PROPERTIES: +:CREATED: [2011-12-10 Sat 21:31] +:END: + +* WISH Look at template of matthiaspospiech and adopt things +:PROPERTIES: +:CREATED: <2010-12-26 Fri 15:51> +:END: + +/home/vk/src/diss_da_template/matthiaspospiech.de/LaTeX-Vorlage3/preambel + +* WISH look at creation of own sty-file +:PROPERTIES: +:CREATED: <2010-12-22 Fri 15:50> +:END: +* WISH translate German comments +:PROPERTIES: +:CREATED: <2010-12-22 Fri 15:50> +:END: +* DONE define prerequisites +CLOSED: [2013-02-25 Mon 11:04] +:PROPERTIES: +:CREATED: <2011-07-26 Tue 18:03> +:END: + +- user knowledge +- software dependencies + - for compiling PDF + - pdflatex + - biber + - biblatex + - for using make to compile + - GNU make + - for generating template documentation + - GNU make + - sed + - grep + - LaTeX packages + - necessary + - optional + +* DONE how to switch language +CLOSED: [2013-02-25 Mon 11:04] +:PROPERTIES: +:CREATED: [2011-12-10 Sat 21:31] +:END: + +* DONE document example usage with MikTex 2.8 and TeXworks :KarlVoit: +CLOSED: [2013-02-02 Sat 22:28] +:PROPERTIES: +:CREATED: [2012-03-06 Tue 17:52] +:END: + +- see id:2012-02-25latex +- see id:2013-02-02TeXworksbiber + +* DONE document how to move to one sided document :KarlVoit: +CLOSED: [2013-02-02 Sat 22:00] +:PROPERTIES: +:CREATED: [2012-03-06 Tue 17:53] +:END: + +* DONE document how to generate a draft document version +CLOSED: [2013-02-02 Sat 22:00] +:PROPERTIES: +:CREATED: [2012-03-06 Tue 17:53] +:END: + +* DONE move some settings from template/* to main.tex as newcommand-definitions :KarlVoit: +CLOSED: [2013-02-02 Sat 22:00] +:PROPERTIES: +:CREATED: [2013-02-02 Sat 18:37] +:END: + +- like http://ufo.tugraz.at/assets/Downloads/UFO-Vorlage.zip + +* DONE replace \fixxme{} with package «todonotes» +CLOSED: [2012-03-25 Sun 17:08] +:PROPERTIES: +:CREATED: [2012-03-14 Wed 09:51] +:END: + +- add dependencies to the documentation + - ifthen + - xkeyval + - xcolor + - tikz + - calc + - graphicx +- in combination with [[http://orgmode.org][Org-mode]]: http://lists.gnu.org/archive/html/emacs-orgmode/2011-09/msg00157.html + +* DONE Template documentation should be static [3/3] +DEADLINE: <2011-07-23 Sat> +:PROPERTIES: +:CREATED: <2011-07-23 Sat 12:44> +:END: +** DONE Makefile: documentation should end up in same PDF filename +CLOSED: [2011-07-24 Sun 14:04] +:PROPERTIES: +:CREATED: <2011-07-24 Sun 14:04> +:END: + +** DONE adopt comments/documentation to this change +CLOSED: [2011-07-24 Sun 14:04] +:PROPERTIES: +:CREATED: <2011-07-23 Sat 12:45> +:END: + +** DONE separate main.tex from Template-Documentation.tex +CLOSED: [2011-07-24 Sun 16:27] +:PROPERTIES: +:CREATED: <2011-07-24 Sun 16:26> +:END: + +- no need to comment out/in include command of template definition +- duplicate most important things from: + - preamble.tex + - userdata.tex +- include rest of the tex-files and misc things from main.tex + +* DONE Title page KF Uni Graz +CLOSED: [2011-07-22 Fri 12:46] +:PROPERTIES: +:CREATED: <2011-07-22 Fri 12:46> +:END: + +for Petra + +* DONE move almost *all* user-specific data into separate file +CLOSED: [2011-07-24 Sun 16:26] +:PROPERTIES: +:CREATED: <2011-07-23 Sat 12:46> +:END: + +- in order to differ between template and content + +userdata.tex +* DONE title page(s) +CLOSED: [2011-07-24 Sun 16:45] +:PROPERTIES: +:CREATED: <2010-12-22 Wed 15:48> +:END: + +- probably own folder called "titlepages" where all possible + titlepages are located: + - TU Graz + - KF +- simple title page using maketitle + +* DONE maketitle example +CLOSED: [2011-07-24 Sun 16:45] +:PROPERTIES: +:CREATED: <2011-07-22 Fri 17:08> +:END: + +* DONE adopt biblatex +CLOSED: [2011-12-10 Sat 21:29] +:PROPERTIES: +:CREATED: <2011-07-26 Tue 18:03> +:END: + +http://ftp.univie.ac.at/packages/tex/help/Catalogue/entries/biblatex.html + +* DONE adopt biber +CLOSED: [2011-12-10 Sat 21:29] +:PROPERTIES: +:CREATED: <2011-07-26 Tue 18:03> +:END: + +http://biblatex-biber.sourceforge.net/ + +* DONE add biblatex example +CLOSED: [2011-12-10 Sat 21:29] +:PROPERTIES: +:CREATED: <2011-07-26 Tue 18:04> +:END: + +* DONE HowTo change titlepage +CLOSED: [2011-12-11 Sun 14:07] +:PROPERTIES: +:CREATED: [2011-12-11 Sun 12:16] +:END: +* DONE list of figures +CLOSED: [2011-12-11 Sun 14:07] +:PROPERTIES: +:CREATED: [2011-12-10 Sat 21:30] +:END: +* DONE example content from the template of [[http://ftp.iicm.tugraz.at/pub/keith/thesis/thesis.zip][Keith Andrews]] +CLOSED: [2011-12-12 Mon 00:15] +:PROPERTIES: +:CREATED: [2011-12-10 Sat 21:30] +:END: + +see reference {KeithThesis} + +* DONE merge myquote & csquotes +CLOSED: [2011-12-12 Mon 18:42] +:PROPERTIES: +:CREATED: [2011-12-12 Mon 15:01] +:END: +* DONE more titlepage templates +CLOSED: [2012-03-06 Tue 17:50] +:PROPERTIES: +:CREATED: [2011-12-10 Sat 21:30] +:END: + +* DONE add FIXXME-marker with [[http://www.komascript.de/marginnote]] +CLOSED: [2012-03-06 Tue 17:54] +:PROPERTIES: +:CREATED: [2011-12-11 Sun 13:11] +:END: + +see \fixxme{} + +* CANCELED add BibTeX to the template +CLOSED: [2011-12-10 Sat 21:31] +:PROPERTIES: +:CREATED: <2011-07-22 Fri 15:53> +:END: diff --git a/template/typographic_settings.tex b/template/typographic_settings.tex new file mode 100644 index 0000000..b7d93d6 --- /dev/null +++ b/template/typographic_settings.tex @@ -0,0 +1,321 @@ +%%%% Time-stamp: <2013-02-26 12:18:29 vk> +%%%% === Disclaimer: ======================================================= +%% created by +%% +%% Karl Voit +%% +%% using GNU/Linux, GNU Emacs & LaTeX 2e +%% +%doc% +%doc% \section{\texttt{typographic\_settings.tex} --- Typographic finetuning} +%doc% +%doc% The settings of file \verb#template/typographic_settings.tex# contain +%doc% typographic finetuning related to things mentioned in literature. The +%doc% settings in this file relates to personal taste and most of all: +%doc% \emph{typographic experience}. +%doc% +%doc% \paragraph{What should I do with this file?} You might as well skip the whole +%doc% file by excluding the \verb#\input{template/typographic_settings.tex}# command +%doc% in \texttt{main.tex}. For standard usage it is recommended to stay with the +%doc% default settings. +%doc% +%doc% +%% ======================================================================== + +%doc% +%doc% Some basic microtypographic settings are provided by the +%doc% \texttt{microtype} +%doc% package\footnote{\url{http://ctan.org/pkg/microtype}}. This template +%doc% uses the rather conservative package parameters: \texttt{protrusion=true,factor=900}. +\usepackage[protrusion=true,factor=900]{microtype} + +%doc% +%doc% \subsection{French spacing} +%doc% +%doc% \paragraph{Why?} see~\textcite[p.\,28, p.\,30]{Bringhurst1993}: `2.1.4 Use a single word space between sentences.' +%doc% +%doc% \paragraph{How?} see~\textcite[p.\,185]{Eijkhout2008}:\\ +%doc% \verb#\frenchspacing %% Macro to switch off extra space after punctuation.# \\ +\frenchspacing %% Macro to switch off extra space after punctuation. +%doc% +%doc% Note: This setting might be default for \myacro{KOMA} script. +%doc% + + +%doc% +%doc% \subsection{Font} +%doc% +%doc% This template is using the Palatino font (package \texttt{mathpazo}) which results +%doc% in a legible document and matching mathematical fonts for printout. +%doc% +%doc% It is highly recommended that you either stick to the Palatino font or use the +%doc% \LaTeX{} default fonts (by removing the package \texttt{mathpazo}). +%doc% +%doc% Chosing different fonts is not +%doc% an easy task. Please leave this to people with good knowledge on this subject. +%doc% +%doc% One valid reason to change the default fonts is when your document is mainly +%doc% read on a computer screen. In this case it is recommended to switch to a font +%doc% \textsf{which is sans-serif like this}. This template contains several alternative +%doc% font packages which can be activated in this file. +%doc% + +% for changing the default font, please go to the next subsection! + +%doc% +%doc% \subsection{Text figures} +%doc% +%doc% \ldots also called old style numbers such as 0123456789. +%doc% (German: \enquote{Mediäval\-ziffern\footnote{\url{https://secure.wikimedia.org/wikibooks/de/wiki/LaTeX-W\%C3\%B6rterbuch:\_Medi\%C3\%A4valziffern}}}) +%doc% \paragraph{Why?} see~\textcite[p.\,44f]{Bringhurst1993}: +%doc% \begin{quote} +%doc% `3.2.1 If the font includes both text figures and titling figures, use +%doc% titling figures only with full caps, and text figures in all other +%doc% circumstances.' +%doc% \end{quote} +%doc% +%doc% \paragraph{How?} +%doc% Quoted from Wikibooks\footnote{\url{https://secure.wikimedia.org/wikibooks/en/wiki/LaTeX/Formatting\#Text\_figures\_.28.22old\_style.22\_numerals.29}}: +%doc% \begin{quote} +%doc% Some fonts do not have text figures built in; the textcomp package attempts to +%doc% remedy this by effectively generating text figures from the currently-selected +%doc% font. Put \verb#\usepackage{textcomp}# in your preamble. textcomp also allows you to +%doc% use decimal points, properly formatted dollar signs, etc. within +%doc% \verb#\oldstylenums{}#. +%doc% \end{quote} +%doc% \ldots but proposed \LaTeX{} method does not work out well. Instead use:\\ +%doc% \verb#\usepackage{hfoldsty}# (enables text figures using additional font) or \\ +%doc% \verb#\usepackage[sc,osf]{mathpazo}# (switches to Palatino font with small caps and old style figures enabled). +%doc% +%\usepackage{hfoldsty} %% enables text figures using additional font +%% ... OR use ... +\usepackage[sc,osf]{mathpazo} %% switches to Palatino with small caps and old style figures + +%% Font selection from: +%% http://www.matthiaspospiech.de/latex/vorlagen/allgemein/preambel/fonts/ +%% use following lines *instead* of the mathpazo package above: +%% ===== Serif ========================================================= +%% for Computer Modern (LaTeX default font), simply remove the mathpazo above +%\usepackage{charter}\linespread{1.05} %% Charter +%\usepackage{bookman} %% Bookman (laedt Avant Garde !!) +%\usepackage{newcent} %% New Century Schoolbook (laedt Avant Garde !!) +%% ===== Sans Serif ==================================================== +%\renewcommand{\familydefault}{\sfdefault} %% this one in *combination* with the default mathpazo package +%\usepackage{cmbright} %% CM-Bright (eigntlich eine Familie) +%\usepackage{tpslifonts} %% tpslifonts % Font for Slides + + +%doc% +%doc% \subsection{\texttt{myacro} --- Abbrevations using \textsc{small caps}}\myinteresting +%doc% \label{sec:myacro} +%doc% +%doc% \paragraph{Why?} see~\textcite[p.\,45f]{Bringhurst1993}: `3.2.2 For abbrevations and +%doc% acronyms in the midst of normal text, use spaced small caps.' +%doc% +%doc% \paragraph{How?} Using the predefined macro \verb#\myacro{}# for things like +%doc% \myacro{UNO} or \myacro{UNESCO} using \verb#\myacro{UNO}# or \verb#\myacro{UNESCO}#. +%doc% +\DeclareRobustCommand{\myacro}[1]{\textsc{\lowercase{#1}}} %% abbrevations using small caps + + +%doc% +%doc% \subsection{Colorized headings and links} +%doc% +%doc% This document template is able to generate an output that uses colorized +%doc% headings, captions, page numbers, and links. The color named `DispositionColor' +%doc% used in this document is defined near the definition of package \texttt{color} +%doc% in the preamble (see section~\ref{subsec:miscpackages}). The changes required +%doc% for headings, page numbers, and captions are defined here. +%doc% +%doc% Settings for colored links are handled by the definitions of the +%doc% \texttt{hyperref} package (see section~\ref{sec:pdf}). +%doc% +\setheadsepline{.4pt}[\color{DispositionColor}] +\renewcommand{\headfont}{\normalfont\sffamily\color{DispositionColor}} +\renewcommand{\pnumfont}{\normalfont\sffamily\color{DispositionColor}} +\addtokomafont{disposition}{\color{DispositionColor}} +\addtokomafont{caption}{\color{DispositionColor}\footnotesize} +\addtokomafont{captionlabel}{\color{DispositionColor}} + +%doc% +%doc% \subsection{No figures or tables below footnotes} +%doc% +%doc% \LaTeX{} places floating environments below footnotes if \texttt{b} +%doc% (bottom) is used as (default) placement algorithm. This is certainly +%doc% not appealing for most people and is deactivated in this template by +%doc% using the package \texttt{footmisc} with its option \texttt{bottom}. +%doc% +%% see also: http://www.komascript.de/node/858 (German description) +\usepackage[bottom]{footmisc} + +%doc% +%doc% \subsection{Spacings of list environments} +%doc% +%doc% By default, \LaTeX{} is using vertical spaces between items of enumerate, +%doc% itemize and description environments. This is fine for multi-line items. +%doc% Many times, the user does just write single-line items where the larger +%doc% vertical space is inappropriate. The \href{http://ctan.org/pkg/enumitem}{enumitem} +%doc% package provides replacements for the pre-defined list environments and +%doc% offers many options to modify their appearances. +%doc% This template is using the package option for \texttt{noitemsep} which +%doc% mimimizes the vertical space between list items. +%doc% +\usepackage{enumitem} +\setlist{noitemsep} %% kills the space between items + +%doc% +%doc% \subsection{\texttt{csquotes} --- Correct quotation marks}\myinteresting +%doc% \label{sub:csquotes} +%doc% +%doc% \emph{Never} use quotation marks found on your keyboard. +%doc% They end up in strange characters or false looking quotation marks. +%doc% +%doc% In \LaTeX{} you are able to use typographically correct quotation marks. The package +%doc% \href{http://www.ctan.org/pkg/csquotes}{\texttt{csquotes}} offers you with +%doc% \verb#\enquote{foobar}# a command to get correct quotation marks around \enquote{foobar}. +%doc% Please do check the package options in order to modify +%doc% its settings according to the language used\footnote{most of the time in +%doc% combination with the language set in the options of the \texttt{babel} package}. +%doc% +%doc% \href{http://www.ctan.org/pkg/csquotes}{\texttt{csquotes}} is also recommended +%doc% by \texttt{biblatex} (see Section~\ref{sec:references}). +\usepackage[babel=true,strict=true,english=american,german=guillemets]{csquotes} + +%doc% +%doc% \subsection{Line spread} +%doc% +%doc% If you have to enlarge the distance between two lines of text, you can +%doc% increase it using the \texttt{\mylinespread} command in \texttt{main.tex}. By default, it is +%doc% deactivated (set to 100~percent). Modify only with caution since it influences the +%doc% page layout and could lead to ugly looking documents. +\linespread{\mylinespread} + +%doc% +%doc% \subsection{Optional: Lines above and below the chapter head} +%doc% +%doc% This is not quite something typographic but rather a matter of taste. +%doc% \myacro{KOMA} Script offers \href{http://www.komascript.de/node/24}{a method to +%doc% add lines above and below chapter head} which is disabled by +%doc% default. If you want to enable this feature, remove corresponding +%doc% comment characters from the settings. +%doc% +%% Source: http://www.komascript.de/node/24 +%disabled% %% 1st get a new command +%disabled% \newcommand*{\ORIGchapterheadstartvskip}{}% +%disabled% %% 2nd save the original definition to the new command +%disabled% \let\ORIGchapterheadstartvskip=\chapterheadstartvskip +%disabled% %% 3rd redefine the command using the saved original command +%disabled% \renewcommand*{\chapterheadstartvskip}{% +%disabled% \ORIGchapterheadstartvskip +%disabled% {% +%disabled% \setlength{\parskip}{0pt}% +%disabled% \noindent\color{DispositionColor}\rule[.3\baselineskip]{\linewidth}{1pt}\par +%disabled% }% +%disabled% } +%disabled% %% see above +%disabled% \newcommand*{\ORIGchapterheadendvskip}{}% +%disabled% \let\ORIGchapterheadendvskip=\chapterheadendvskip +%disabled% \renewcommand*{\chapterheadendvskip}{% +%disabled% {% +%disabled% \setlength{\parskip}{0pt}% +%disabled% \noindent\color{DispositionColor}\rule[.3\baselineskip]{\linewidth}{1pt}\par +%disabled% }% +%disabled% \ORIGchapterheadendvskip +%disabled% } + +%doc% +%doc% \subsection{Optional: Chapter thumbs} +%doc% +%doc% This is not quite something typographic but rather a matter of taste. +%doc% \myacro{KOMA} Script offers \href{http://www.komascript.de/chapterthumbs-example}{a method to +%doc% add chapter thumbs} (in combination with the package \texttt{scrpage2}) which is disabled by +%doc% default. If you want to enable this feature, remove corresponding +%doc% comment characters from the settings. +%doc% +%disabled% % Safty first +%disabled% \@ifundefined{chapter}{\let\chapter\undefined +%disabled% \chapter must be defined to use chapter thumbs!}{% +%disabled% +%disabled% % Two new commands for the width and height of the boxes with the +%disabled% % chapter number at the thumbs (use of commands instead of lengths +%disabled% % for sparing registers) +%disabled% \newcommand*{\chapterthumbwidth}{2em} +%disabled% \newcommand*{\chapterthumbheight}{1em} +%disabled% +%disabled% % Two new commands for the colors of the box background and the +%disabled% % chapter numbers of the thumbs +%disabled% \newcommand*{\chapterthumbboxcolor}{black} +%disabled% \newcommand*{\chapterthumbtextcolor}{white} +%disabled% +%disabled% % New command to set a chapter thumb. I'm using a group at this +%disabled% % command, because I'm changing the temporary dimension \@tempdima +%disabled% \newcommand*{\putchapterthumb}{% +%disabled% \begingroup +%disabled% \Large +%disabled% % calculate the horizontal possition of the right paper border +%disabled% % (I ignore \hoffset, because I interprete \hoffset moves the page +%disabled% % at the paper e.g. if you are using cropmarks) +%disabled% \setlength{\@tempdima}{\@oddheadshift}% (internal from scrpage2) +%disabled% \setlength{\@tempdima}{-\@tempdima}% +%disabled% \addtolength{\@tempdima}{\paperwidth}% +%disabled% \addtolength{\@tempdima}{-\oddsidemargin}% +%disabled% \addtolength{\@tempdima}{-1in}% +%disabled% % putting the thumbs should not change the horizontal +%disabled% % possition +%disabled% \rlap{% +%disabled% % move to the calculated horizontal possition +%disabled% \hspace*{\@tempdima}% +%disabled% % putting the thumbs should not change the vertical +%disabled% % possition +%disabled% \vbox to 0pt{% +%disabled% % calculate the vertical possition of the thumbs (I ignore +%disabled% % \voffset for the same reasons told above) +%disabled% \setlength{\@tempdima}{\chapterthumbwidth}% +%disabled% \multiply\@tempdima by\value{chapter}% +%disabled% \addtolength{\@tempdima}{-\chapterthumbwidth}% +%disabled% \addtolength{\@tempdima}{-\baselineskip}% +%disabled% % move to the calculated vertical possition +%disabled% \vspace*{\@tempdima}% +%disabled% % put the thumbs left so the current horizontal possition +%disabled% \llap{% +%disabled% % and rotate them +%disabled% \rotatebox{90}{\colorbox{\chapterthumbboxcolor}{% +%disabled% \parbox[c][\chapterthumbheight][c]{\chapterthumbwidth}{% +%disabled% \centering +%disabled% \textcolor{\chapterthumbtextcolor}{% +%disabled% \strut\thechapter}\\ +%disabled% }% +%disabled% }% +%disabled% }% +%disabled% }% +%disabled% % avoid overfull \vbox messages +%disabled% \vss +%disabled% }% +%disabled% }% +%disabled% \endgroup +%disabled% } +%disabled% +%disabled% % New command, which works like \lohead but also puts the thumbs (you +%disabled% % cannot use \ihead with this definition but you may change this, if +%disabled% % you use more internal scrpage2 commands) +%disabled% \newcommand*{\loheadwithchapterthumbs}[2][]{% +%disabled% \lohead[\putchapterthumb#1]{\putchapterthumb#2}% +%disabled% } +%disabled% +%disabled% % initial use +%disabled% \loheadwithchapterthumbs{} +%disabled% \pagestyle{scrheadings} +%disabled% +%disabled% } +%disabled% + +%%%% END +%%% Local Variables: +%%% mode: latex +%%% mode: auto-fill +%%% mode: flyspell +%%% eval: (ispell-change-dictionary "en_US") +%%% TeX-master: "../main" +%%% End: +%% vim:foldmethod=expr +%% vim:fde=getline(v\:lnum)=~'^%%%%'?0\:getline(v\:lnum)=~'^%doc.*\ .\\%(sub\\)\\?section{.\\+'?'>1'\:'1':