Technical Stuff

1

**Table of Contents**

2

= Use LaTeX and the KCSS Style =

8

9

Before you do anything else for your thesis work, you should get the technical issues for writing your thesis out of the way. Ie, you should create a git repository for your thesis, familiarize yourself with [[LaTeX>>url:http://de.wikipedia.org/wiki/LaTeX||rel="nofollow" style="text-decoration: none;" shape="rect" class="external-link"]] and the [[KCSS>>url:http://www.informatik.uni-kiel.de/kcss/||shape="rect"]] style, and adapt/fill in the KCSS thesis template for your needs. This way, you can fill your thesis with contents as you work along on your thesis topic, instead of keeping notes in various ways and having to consolidate it all later.

= Use Git =

Our shared repositories are managed with Git. The files associated with the thesis should be kept in the group's Git installation, as a separate repository that your advisor will create for you. The main purpose is to prevent loss of data, but it also facilitates access for fellow group members if needed, and to allow on-line publication. If you haven't used Git yet, there's a few excellent introductions to be found on the internet, for example:

14

15

* [[The Git book>>url:http://git-scm.com/book/||shape="rect"]]

16

* [[The excellent Git tutorial>>url:https://www.atlassian.com/git/tutorial||shape="rect"]], written by the guys at Atlassian

17

* The Git page in our KIELER Wiki: [[doc:KIELER.Using Git]]

18

19

The main tex file for a thesis should be {{code language="none"}}<name of repository>.tex{{/code}} (see also [[Git/Structure>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Git/Structure||style="text-decoration: none;" shape="rect" class="wiki"]] for the canonical naming scheme). E.g., the bachelor thesis of user xyz can be found in a repository named {{code language="none"}}xyz-bt{{/code}} [[in the Theses project of our Stash system>>url:https://git.rtsys.informatik.uni-kiel.de/projects/THESES||shape="rect"]], in a file named {{code language="none"}}xyz-bt.tex{{/code}}. If there is a talk to "defend" the thesis (Bachelor-Kolloquium, Disputation), the talk should also be included in this repository, and should be named {{code language="none"}}<name of repository>-talk.tex{{/code}} (e.g. {{code language="none"}}xyz-bt-talk.tex{{/code}}). In case your thesis should be made available on-line, the same names should be used, e.g.,{{code language="none"}} xyz.pdf{{/code}}.

20

21

See also the notes on [[preparing a paper>>doc:Writing Papers]], e.g. regarding which files should be kept in Git and which shouldn't.

= Editor/IDE =

Prof. von Hanxleden would recommend Emacs as a very flexible and powerful editor for LaTeX (and everything else). But probably you belong to a post-Emacs generation, so here are some alternatives: Hauke (haf) recommends [[Texlipse>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Texlipse||style="text-decoration: none;" shape="rect" class="wiki"]] as an easy-to use and also powerful Eclipse plug-in. Christoph Daniel (cds) recommends using Kile, a KDE LaTeX editor that is fast, powerful, and reasonably easy to understand and to use. On all platforms, including Mac, texmaker is a fine editor.

= The ToDo Package =

When writing your thesis, you will often want to make a note of something you need to add or change. The {{code language="none"}}todonotes{{/code}} package makes this easy. It lets you add placeholder graphics and notes in or next to the text. To include the package, add the following line to your document:

30

31

{{{ \usepackage{todonotes}

32

}}}

33

34

You can find a short manual [[over here>>url:http://www.tex.ac.uk/tex-archive/macros/latex/contrib/todonotes/todonotes.pdf||shape="rect"]].

= The Bibliography =

Zur Erstellung einer Bibliographie mit LaTeX ist das Beispiel-Dokument zu Rate zu ziehen. Die dort benutzte BibTeX-Datenbank cau-rt.bib wird Lehrstuhl-weit von Mitarbeitern und Studenten gemeinsam benutzt um Literatur-Daten zu sammeln und zu publizieren. Alle Literaturdaten, die in studentischen Arbeiten anfallen, müssen also in dieser Datei verwaltet werden. **Wichtig:** Bitte vermeiden Sie bibtex-Warnungen beim Hinzufügen von neuen Einträgen! Weitere Hinweise zur Beachtung finden sich [[hier>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Preparing_a_Paper#The_Bibliography_-_Guidelines_for_bibtex_Entries||style="text-decoration: none;" shape="rect" class="wiki"]]

39

40

Das Erstellen eines deutschsprachigen Literaturverzeichnisses ist mit Hilfe des Paketes //bibgerm// und dem bibliographystyle //gerplain// möglich.

41

42

{{{ \usepackage[ngerman]{babel}

\usepackage{bibgerm}

.

.

.

\bibliographystyle{gerplain}

}}}

Links zu BibTeX:

* [[(% class="icon" %) (%%)BibTeX-Tutorial>>url:http://www.din1505.informationskompetenz.net/||style="text-decoration: none;" shape="rect" class="ext-link"]] (Link ist tot)

54

* [[(% class="icon" %) (%%)Tame the BeaST - The B to X of BibTEX (Nicolas Markey)>>url:ftp://dante.ctan.org/tex-archive//info/bibtex/tamethebeast/ttb_en.pdf||style="text-decoration: none;" shape="rect" class="ext-link"]]

55

* [[(% class="icon" %) (%%)Eine Auflistung von BibTEX Styles>>url:http://www.reed.edu/cis/help/latex/bibtexstyles.html||style="text-decoration: none;" shape="rect" class="ext-link"]]

56

57

== Work Within the RTSYS Domain ==

58

59

Beim Arbeiten im Lehrstuhl-Netzwerk werden keine zusätzlichen Maßnahmen notwendig; der LaTeX-Zugriff auf die BibTeX-Datenbank ist automatisch über das Netzwerk gewährleistet. Für verändernde Zugriffe auf die Datenbank muss mit dem Versionsmanagement earbeitet werden.

60

61

== Work Outside the RTSYS Domain ==

62

63

Beim Arbeiten außerhalb des Lehrstuhl-Netzes wird es notwendig, die Datenbank dem lokal installierten LaTeX-System zur Verfügung zu stellen. Eventuell muss die dazugehörige kpse-Datenbank reinitialisiert werden.

64

65

== Accessing the Git-Repository of the BibTeX Files ==

66

67

Für Zugriff auf das [[Git-Repository >>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Git||style="text-decoration: none;" shape="rect" class="wiki"]]der BibTeX-Datenbank ist folgender Befehl zu verwenden

68

69

>git clone git@…:resources/bib.git

70

71

Nach dem Auschecken des Moduls bib steht die Datei cau-rt.bib zur Verfügung. Hinweise zur genauen Syntax sind dem Kopf der Datei und den Beschreibungen der BibTeX-Sprache zu entnehmen.

72

73

= Publishing the thesis on-line =

74

75

If your advisor has agreed that your thesis should be made available on-line, and you have signed your[[(% class="icon" %) (%%)consent>>url:http://www.informatik.uni-kiel.de/fileadmin/arbeitsgruppen/realtime_embedded/misc/Einverstaendniserklaerung.doc||style="text-decoration: none;" shape="rect" class="ext-link"]], then you can publish this as follows. Say your thesis is xyz-bt.pdf. ("bt" for Bachelor theses, "mt" for Master theses, "diss" for dissertations.) To upload this, use the command

76

77

>scp xyz-bt.pdf biblio@…:/home/biblio/public_html/downloads/theses

78

79

If you don't have the right permissions to do this, ask your advisor or the [[System Administrator >>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/System_Administrator||style="text-decoration: none;" shape="rect" class="wiki"]]to publish this for you.

80

81

Then, check that your thesis is indeed available under the URL

82

83

>[[(% class="icon" %) (%%)http:~~/~~/rtsys.informatik.uni-kiel.de/~~~~biblio/downloads/theses/xyz-bt.pdf>>url:http://rtsys.informatik.uni-kiel.de/%7Ebiblio/downloads/theses/xyz-bt.pdf||style="text-decoration: none;" shape="rect" class="ext-link"]]

84

85

Note: The name of this file should follow the canonical naming scheme used in subversion ([[Subversion/Structure >>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Subversion/Structure||style="text-decoration: none;" shape="rect" class="wiki"]]), even if your thesis is for some reason not in the subversion system.

= Source Code =

Von Ihnen im Laufe der Arbeit entwickelte Software (oder Hardware-Beschreibungen) sind Teil Ihrer Arbeit. Dies bedeutet: es sollte eine Übersicht über die Software in geeigneter Form gegeben werden, z.B. in Form von Klassendiagrammen mit Erläuterungen. Hinweise zum Einbinden von Code in LaTeX finden sich in dem[[(% class="icon" %) (%%)Beispieldokument>>url:http://www.informatik.uni-kiel.de/%7Ert-kiel/kiel/documents/papers/example.tar.gz||style="text-decoration: none;" shape="rect" class="ext-link"]] (s.o.).

Wiki source code of Technical Stuff

Navigation

Quick Links

author	version	line-number	content
		1	Table of Contents
		2
		3
		4
		5	{{toc/}}
		6
		7	= Use LaTeX and the KCSS Style =
		8
		9	Before you do anything else for your thesis work, you should get the technical issues for writing your thesis out of the way. Ie, you should create a git repository for your thesis, familiarize yourself with [[LaTeX>>url:http://de.wikipedia.org/wiki/LaTeX\|\|rel="nofollow" style="text-decoration: none;" shape="rect" class="external-link"]] and the [[KCSS>>url:http://www.informatik.uni-kiel.de/kcss/\|\|shape="rect"]] style, and adapt/fill in the KCSS thesis template for your needs. This way, you can fill your thesis with contents as you work along on your thesis topic, instead of keeping notes in various ways and having to consolidate it all later.
		10
		11	= Use Git =
		12
		13	Our shared repositories are managed with Git. The files associated with the thesis should be kept in the group's Git installation, as a separate repository that your advisor will create for you. The main purpose is to prevent loss of data, but it also facilitates access for fellow group members if needed, and to allow on-line publication. If you haven't used Git yet, there's a few excellent introductions to be found on the internet, for example:
		14
		15	* [[The Git book>>url:http://git-scm.com/book/\|\|shape="rect"]]
		16	* [[The excellent Git tutorial>>url:https://www.atlassian.com/git/tutorial\|\|shape="rect"]], written by the guys at Atlassian
		17	* The Git page in our KIELER Wiki: [[doc:KIELER.Using Git]]
		18
		19	The main tex file for a thesis should be {{code language="none"}}<name of repository>.tex{{/code}} (see also [[Git/Structure>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Git/Structure\|\|style="text-decoration: none;" shape="rect" class="wiki"]] for the canonical naming scheme). E.g., the bachelor thesis of user xyz can be found in a repository named {{code language="none"}}xyz-bt{{/code}} [[in the Theses project of our Stash system>>url:https://git.rtsys.informatik.uni-kiel.de/projects/THESES\|\|shape="rect"]], in a file named {{code language="none"}}xyz-bt.tex{{/code}}. If there is a talk to "defend" the thesis (Bachelor-Kolloquium, Disputation), the talk should also be included in this repository, and should be named {{code language="none"}}<name of repository>-talk.tex{{/code}} (e.g. {{code language="none"}}xyz-bt-talk.tex{{/code}}). In case your thesis should be made available on-line, the same names should be used, e.g.,{{code language="none"}} xyz.pdf{{/code}}.
		20
		21	See also the notes on [[preparing a paper>>doc:Writing Papers]], e.g. regarding which files should be kept in Git and which shouldn't.
		22
		23	= Editor/IDE =
		24
		25	Prof. von Hanxleden would recommend Emacs as a very flexible and powerful editor for LaTeX (and everything else). But probably you belong to a post-Emacs generation, so here are some alternatives: Hauke (haf) recommends [[Texlipse>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Texlipse\|\|style="text-decoration: none;" shape="rect" class="wiki"]] as an easy-to use and also powerful Eclipse plug-in. Christoph Daniel (cds) recommends using Kile, a KDE LaTeX editor that is fast, powerful, and reasonably easy to understand and to use. On all platforms, including Mac, texmaker is a fine editor.
		26
		27	= The ToDo Package =
		28
		29	When writing your thesis, you will often want to make a note of something you need to add or change. The {{code language="none"}}todonotes{{/code}} package makes this easy. It lets you add placeholder graphics and notes in or next to the text. To include the package, add the following line to your document:
		30
		31	{{{ \usepackage{todonotes}
		32	}}}
		33
		34	You can find a short manual [[over here>>url:http://www.tex.ac.uk/tex-archive/macros/latex/contrib/todonotes/todonotes.pdf\|\|shape="rect"]].
		35
		36	= The Bibliography =
		37
		38	Zur Erstellung einer Bibliographie mit LaTeX ist das Beispiel-Dokument zu Rate zu ziehen. Die dort benutzte BibTeX-Datenbank cau-rt.bib wird Lehrstuhl-weit von Mitarbeitern und Studenten gemeinsam benutzt um Literatur-Daten zu sammeln und zu publizieren. Alle Literaturdaten, die in studentischen Arbeiten anfallen, müssen also in dieser Datei verwaltet werden. Wichtig: Bitte vermeiden Sie bibtex-Warnungen beim Hinzufügen von neuen Einträgen! Weitere Hinweise zur Beachtung finden sich [[hier>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Preparing_a_Paper#The_Bibliography_-_Guidelines_for_bibtex_Entries\|\|style="text-decoration: none;" shape="rect" class="wiki"]]
		39
		40	Das Erstellen eines deutschsprachigen Literaturverzeichnisses ist mit Hilfe des Paketes //bibgerm// und dem bibliographystyle //gerplain// möglich.
		41
		42	{{{ \usepackage[ngerman]{babel}
		43	\usepackage{bibgerm}
		44	.
		45	.
		46	.
		47	\bibliographystyle{gerplain}
		48
		49	}}}
		50
		51	Links zu BibTeX:
		52
		53	* [[(% class="icon" %) (%%)BibTeX-Tutorial>>url:http://www.din1505.informationskompetenz.net/\|\|style="text-decoration: none;" shape="rect" class="ext-link"]] (Link ist tot)
		54	* [[(% class="icon" %) (%%)Tame the BeaST - The B to X of BibTEX (Nicolas Markey)>>url:ftp://dante.ctan.org/tex-archive//info/bibtex/tamethebeast/ttb_en.pdf\|\|style="text-decoration: none;" shape="rect" class="ext-link"]]
		55	* [[(% class="icon" %) (%%)Eine Auflistung von BibTEX Styles>>url:http://www.reed.edu/cis/help/latex/bibtexstyles.html\|\|style="text-decoration: none;" shape="rect" class="ext-link"]]
		56
		57	== Work Within the RTSYS Domain ==
		58
		59	Beim Arbeiten im Lehrstuhl-Netzwerk werden keine zusätzlichen Maßnahmen notwendig; der LaTeX-Zugriff auf die BibTeX-Datenbank ist automatisch über das Netzwerk gewährleistet. Für verändernde Zugriffe auf die Datenbank muss mit dem Versionsmanagement earbeitet werden.
		60
		61	== Work Outside the RTSYS Domain ==
		62
		63	Beim Arbeiten außerhalb des Lehrstuhl-Netzes wird es notwendig, die Datenbank dem lokal installierten LaTeX-System zur Verfügung zu stellen. Eventuell muss die dazugehörige kpse-Datenbank reinitialisiert werden.
		64
		65	== Accessing the Git-Repository of the BibTeX Files ==
		66
		67	Für Zugriff auf das [[Git-Repository >>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Git\|\|style="text-decoration: none;" shape="rect" class="wiki"]]der BibTeX-Datenbank ist folgender Befehl zu verwenden
		68
		69	>git clone git@…:resources/bib.git
		70
		71	Nach dem Auschecken des Moduls bib steht die Datei cau-rt.bib zur Verfügung. Hinweise zur genauen Syntax sind dem Kopf der Datei und den Beschreibungen der BibTeX-Sprache zu entnehmen.
		72
		73	= Publishing the thesis on-line =
		74
		75	If your advisor has agreed that your thesis should be made available on-line, and you have signed your[[(% class="icon" %) (%%)consent>>url:http://www.informatik.uni-kiel.de/fileadmin/arbeitsgruppen/realtime_embedded/misc/Einverstaendniserklaerung.doc\|\|style="text-decoration: none;" shape="rect" class="ext-link"]], then you can publish this as follows. Say your thesis is xyz-bt.pdf. ("bt" for Bachelor theses, "mt" for Master theses, "diss" for dissertations.) To upload this, use the command
		76
		77	>scp xyz-bt.pdf biblio@…:/home/biblio/public_html/downloads/theses
		78
		79	If you don't have the right permissions to do this, ask your advisor or the [[System Administrator >>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/System_Administrator\|\|style="text-decoration: none;" shape="rect" class="wiki"]]to publish this for you.
		80
		81	Then, check that your thesis is indeed available under the URL
		82
		83	>[[(% class="icon" %) (%%)http:~~/~~/rtsys.informatik.uni-kiel.de/~~~~biblio/downloads/theses/xyz-bt.pdf>>url:http://rtsys.informatik.uni-kiel.de/%7Ebiblio/downloads/theses/xyz-bt.pdf\|\|style="text-decoration: none;" shape="rect" class="ext-link"]]
		84
		85	Note: The name of this file should follow the canonical naming scheme used in subversion ([[Subversion/Structure >>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Subversion/Structure\|\|style="text-decoration: none;" shape="rect" class="wiki"]]), even if your thesis is for some reason not in the subversion system.
		86
		87	= Source Code =
		88
		89	Von Ihnen im Laufe der Arbeit entwickelte Software (oder Hardware-Beschreibungen) sind Teil Ihrer Arbeit. Dies bedeutet: es sollte eine Übersicht über die Software in geeigneter Form gegeben werden, z.B. in Form von Klassendiagrammen mit Erläuterungen. Hinweise zum Einbinden von Code in LaTeX finden sich in dem[[(% class="icon" %) (%%)Beispieldokument>>url:http://www.informatik.uni-kiel.de/%7Ert-kiel/kiel/documents/papers/example.tar.gz\|\|style="text-decoration: none;" shape="rect" class="ext-link"]] (s.o.).