Skip to Content

Changes for page Technical Stuff

Last modified by Alexander Schulz-Rosengarten on 2025/10/21 14:40
From version 2.1
edited by Reinhard von Hanxleden
on 2013/09/12 16:38
Change comment: There is no comment for this version
To version 19.1
edited by cds
on 2023/07/06 14:34
Change comment: Renamed back-links.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +RTSYS.Rtsys Group Wiki.Writing Guides.Writing and Grading Theses.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.rvh
1 +XWiki.cds
Content
... ... @@ -1,77 +1,38 @@
1 -= Editor/IDE =
1 +**Table of Contents**
2 2  
3 -Prof. von Hanxleden would recommend Emacs as a very flexible and powerful Latex editor. 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.
4 4  
5 -= Using Git =
6 6  
7 -The files associated with the thesis should be kept in the group's [[Git>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Git||style="text-decoration: none;" shape="rect" class="wiki"]] repository. The main purpose is to prevent loss of data. It also facilitates access for fellow group members if needed, and to allow on-line publication.
5 +{{toc/}}
8 8  
9 -The main tex file for a thesis should be <name of directory>.tex. 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. Eg, the bachelor thesis of user xyz can be found in a repository named xyz-bt in the Thesss project of our [[(% class="icon" %) (%%)Gitorious>>url:https://git.rtsys.informatik.uni-kiel.de/projects||style="text-decoration: none;" shape="rect" class="ext-link"]] system, in a file named xyz-bt.tex. 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 <name of directory>-talk.tex; eg xyz-bt-talk.tex. In case your thesis should be made available on-line, the same names should be used, eg, xyz.pdf.
7 += Use LaTeX and the KCSS Style =
10 10  
11 -See also the notes on [[preparing a paper>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Preparing_a_Paper||style="text-decoration: none;" shape="rect" class="wiki"]], eg regarding which files should be kept in revision management (ie, should be checked into Git) and which shouldn't.
9 +Before you do anything else for your thesis work, you should get the technical issues for writing your thesis out of the way. That is, you should have your advisor create a Git repository for your thesis, familiarize yourself with [[LaTeX>>url:http://de.wikipedia.org/wiki/LaTeX||style="text-decoration: none;" rel="nofollow" shape="rect" class="external-link"]] and the [[KCSS>>url:https://www.inf.uni-kiel.de/de/forschung/publikationen/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.
12 12  
13 -= The ToDo Package =
11 += Use Git =
14 14  
15 -Es kommt häufig vor dass man sich während des Schreibens Anmerkungen zum Text machen oder Dinge später hinzufügen möchte. Damit dies einfacher zu verwalten ist, steht ein extra ToDo-Paket zur Verfügung. Mit diesem Paket lassen sich Platzhalter für Grafiken, Anmerkungen zum Text in verschiedenen Farben oder einfache ToDo-Kommentare mit Referenz zum Text schnell und unkompliziert realisieren. Eingebunden wird das Paket wie folgt.
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. If you haven't used Git yet, there's a few excellent introductions to be found on the internet, for example:
16 16  
17 -{{{ \usepackage{todonotes}
18 -}}}
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.Home.Development.Guidelines.Using Git.WebHome]]
19 19  
20 -Eine kurze, detaillierte Anleitung kann man hier nachlesen:
19 +The main tex file for a thesis should be {{code language="none"}}<name of repository>.tex.{{/code}} 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 GitLab system>>url:https://git.informatik.uni-kiel.de/ag-rtsys/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}}.
21 21  
22 ->[[(% class="icon" %) (%%)http:~~/~~/www.tex.ac.uk/tex-archive/macros/latex/contrib/todonotes/todonotes.pdf>>url:http://www.tex.ac.uk/tex-archive/macros/latex/contrib/todonotes/todonotes.pdf||style="text-decoration: none;" shape="rect" class="ext-link"]]
21 +See also the notes on [[preparing a paper>>doc:RTSYS.Rtsys Group Wiki.Writing Guides.Writing Papers.WebHome]], e.g. regarding which files should be kept in Git and which shouldn't.
23 23  
24 -= The Bibliography =
23 += Editor/IDE =
25 25  
26 -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"]]
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:
27 27  
28 -Das Erstellen eines deutschsprachigen Literaturverzeichnisses ist mit Hilfe des Paketes //bibgerm// und dem bibliographystyle //gerplain// möglich.
27 +* On all platforms, including Mac, texmaker is a fine editor.
28 +* Atom and Sublime have plug-ins that provide LaTeX syntax highlighting and an integrated compilation workflow.
29 +* Kile is a LaTeX IDE which runs on KDE and is powerful and reasonably easy to understand and to use
29 29  
30 -{{{ \usepackage[ngerman]{babel}
31 - \usepackage{bibgerm}
32 - .
33 - .
34 - .
35 - \bibliographystyle{gerplain}
31 += The ToDo Notes Package =
36 36  
33 +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:
34 +
35 +{{{ \usepackage{todonotes}
37 37  }}}
38 38  
39 -Links zu BibTeX:
40 -
41 -* [[(% class="icon" %) (%%)BibTeX-Tutorial>>url:http://www.din1505.informationskompetenz.net/||style="text-decoration: none;" shape="rect" class="ext-link"]] (Link ist tot)
42 -* [[(% 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"]]
43 -* [[(% 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"]]
44 -
45 -== Work Within the RTSYS Domain ==
46 -
47 -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.
48 -
49 -== Work Outside the RTSYS Domain ==
50 -
51 -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.
52 -
53 -== Accessing the Git-Repository of the BibTeX Files ==
54 -
55 -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
56 -
57 ->git clone git@…:resources/bib.git
58 -
59 -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.
60 -
61 -= Publishing the thesis on-line =
62 -
63 -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
64 -
65 ->scp xyz-bt.pdf biblio@…:/home/biblio/public_html/downloads/theses
66 -
67 -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.
68 -
69 -Then, check that your thesis is indeed available under the URL
70 -
71 ->[[(% 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"]]
72 -
73 -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.
74 -
75 -= Source Code =
76 -
77 -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.).
38 +You can find a short manual [[over here>>url:http://www.tex.ac.uk/tex-archive/macros/latex/contrib/todonotes/todonotes.pdf||shape="rect"]].
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -7700979
1 +7700977
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/RTSYS/pages/7700979/Technical Stuff
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/RTSYS/pages/7700977/Technical Stuff