Minor change
[u/philim/db2osl_thesis.git] / cs-cover / README.md
1 # About
2
3 Unofficial LaTeX package for the required **cover page** for work at the University of Stuttgart, Computer Science.
4
5 This package is a replacement for the old diplomtitel.sty
6
7 ## Features
8
9 - utf8 
10 - options for all required text on the coverpage
11
12 ## Installation
13
14 - Download `uni-stuttgart-cs-cover.sty` or 
15 - Clone this repository with `git clone https://github.com/latextemplates/uni-stuttgart-cs-cover.git` or
16 - Use it as git submodule via `git submodule add https://github.com/latextemplates/uni-stuttgart-cs-cover.git uni-stuttgart-cs-cover`
17
18 ## Usage Example
19
20 An example can be found in [thesis.tex](thesis.tex).
21
22 ## Usage 
23
24 Just include the package with all options specified:
25
26     \usepackage[
27     title={Super relevant evaluation of new blackhole-generation method},
28     author={Max Musterjunge},
29     type=bachelor,
30     institute=iaas,
31     number=12345,
32     course=cs,
33         examiner={Prof.\ Dr.\ Hans Mustermann},
34         supervisor={Otto Normalverbraucher, M.Sc.},
35         startdate={2012/06/01},
36         enddate={2012/12/01},
37         crk={A.1, A.2},
38         language=english
39         ]{uni-stuttgart-cs-cover}
40
41 Afterwards you can create the cover using `\Coverpage` and get the affirmation text by using `\Affirmation`
42
43 ## Supported Options
44
45 This package supports the following options:
46
47 - language: Language used for all labels and text.
48         - `language=german` will use german (default)
49         - `language=english` will use english
50
51 - title: Title of work. Should be placed in curly braces:
52
53         - `title={My thesis title}`
54         - `title={My very long thesis title}`
55
56 - author: Author of work. Should be placed in curly braces. May contain more than one author seperated by commas:
57         - `author={Peter Lustig}`
58         - `author={Peter Lustig, Franz Josef, Vladimir Sixth}`
59
60 - type: Type of work. May be set to one of the following values or arbitrary text in curly braces:
61         - `type=bachelor` will label your work as Bachelor's Thesis
62         - `type=master` will label your work as Masters's Thesis
63         - `type=diplom` will label your work as Diploma Thesis
64         - `type=study` will label your work as Student Research Project
65         - `type=projectinf` will label your work as Projekt-INF
66         - `type={research project}` will label your work as research project
67         
68 - institute: States for which institute you are doing this work. May be set to one of the following values or arbitrary text in curly braces:
69         - `institute=iaas` will state Institute of Architecture of Application Systems
70         - `institute=ipvs` will state Institute of Parallel and Distributed Systems
71         - `institute=fmi` will state Institute of Formal Methods in Computer Science
72         - `institute=iste` will state Institute of Software Technology
73         - `institute=iti` will state Institute of Computer Architecture and Computer Engineering
74         - `institute=iris` will state Institute of Computer-aided Product Development Systems
75         - `institute=vis` will state Institute of Visualization and Interactive Systems
76         - `institute=visus` will state Visualisation Research Center Stuttgart
77         - `institute=fac` will state Faculty of Computer Science
78         - `institute={Custom fictional institute}` will state Custom fictional institute
79
80 - number: Running number of work. May contain arbitrary text. Should contain the number you got for your work.
81         - `number=1234` will label your work to have number 1234
82
83 - course: Type of study. May be set to one of the following values or arbitrary text in curly braces:
84         - `course=cs` will state that your course of study is Computer Science
85         - `course=se` will state that your course of study is Software Engineering
86         - `course=mcl` will state that your course of study is Master Computational Linguistics
87         - `course=msv` will state that your course of study is Maschinelle Sprachverarbeitung
88         - `course=bis` will state that your course of study is Business Information Systems
89         - `course=simtech` will state that your course of study is Simulation Technology
90         - `course={New Study course}` will state that your course of study is New Study course
91
92 - examiner: Your examiner. 
93         - `examiner={Prof.\ Dr.\ Hans Mustermann}`
94
95 - supervisor: Your supervisor.
96         - `supervisor={Otto Normalverbraucher, M.Sc.}`
97
98 - startdate: Startdate of your work.
99         - `startdate={2012/06/01}`
100
101 - enddate: Enddate of your work.        
102         - `enddate={2012/12/01}`
103
104 - crk: CR-Classification codes of your work. May be seperated by commas:
105         - `crk={A.1, A.2}`
106
107 ## Additional Optional Options
108
109 - `setPageNumberToOne=true` will set the page after the cover to `1` (default false)
110 - `setCoverPageNumberToMinusOne=true` will set `-1` as the page number for the cover page (default false)
111
112 ## Known Problems
113
114 Multiline/Commands in option values are currently only supported if you load `kvoptions-patch` **before** the documentclass defintion like this:
115
116         \RequirePackage{kvoptions-patch}
117         \documentclass[twoside]{article}
118
119