Myself5 / z3_pie_doku

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

(English Version below.)

Dies ist die Vorlage für Seminar am Lehrstuhl Software Design and
Quality (SDQ) am Institut für Datenorganisation und Programmstrukturen (IPD)
des Karlsruher Instituts für Technologie (KIT).

Vielen Dank an Markus Kohm (http://www.komascript.de) für die hilfreiche
Unterstützung beim Erstellen dieser Vorlage.

Version
=======
Version: 1.0.0
Autor: Dr.-Ing. Erik Burger (burger@kit.edu)
mit Beiträgen von Joshua Gleitze

Siehe https://sdqweb.ipd.kit.edu/wiki/Dokumentvorlagen

Verwendung
==========
Das vorliegende Paket dient als Vorlage für eine Seminararbeit Sie können dazu
die bestehende Hauptdatei seminar.tex und die einzelnen Kapiteldateien im
Verzeichnis sections/ anpassen, indem Sie den Beispieltext entfernen und durch
eigene Inhalte entfernen. Bitte ändern Sie keine Layout-Parameter wie
Schriftgröße, Ränder, Zeilenabstände u.ä. an der Datei, damit die Ausarbeitungen
in einem einheitlichen Format erscheinen.

Sprache
-------
Die Sprache des Dokuments ist standardmäßig auf Englisch eingestellt.
Dies kann in der \documentclass-Anweisung am Anfang von seminar.tex auf Deutsch 
umgestellt werden.

Einseitig/doppelseitig
----------------------
Das Dokument ist standardmäßig auf doppelseitiges Layout eingestellt, kann aber
durch die Angabe von "oneside" in der \documentclass-Anweisung am Anfang von
seminar.tex auf einseitiges Layout umgestellt werden.

Draft-Modus
-----------
Standardmäßig ist der draft-Modus aktiv. Dieser kann ebenfalls in der
\documentclass-Anweisung am Anfang von seminar.tex auf "final" umgestellt werden,
um eine abgabefertige Version zu erzeugen. Im Draft-Modus werden 
todo-Notizen sowie Platzhalter für fehlende Abbildungen angezeigt, in der
Final-Version jedoch ausgeblendet.

LaTeX allgemein
---------------
Siehe https://sdqweb.ipd.kit.edu/wiki/LaTeX

Dateistruktur
============
seminar.tex
----------
Dies ist die Hauptdatei des LaTeX-Dokuments. Bitte tragen Sie dort Ihre
Daten ein. Benennen Sie dann die Datei am besten um, damit sie später von
Ihrem Betreuer von anderen leicht unterschieden werden kann
(z.B. in thesis_erik_burger.tex).

seminar.bib
----------
Dies ist eine BibTeX-Datei, in der Sie Ihre Literatur-Referenzen sammeln
können. Wir empfehlen die Verwendung von biblatex und biber statt BibTeX. 
Dies ist in der Ausarbeitungsvorlage bereits so voreingestellt. Für 
SDQ-relevante Publikationen können Sie die zentralen BibTeX-Dateien einbinden,
siehe https://sdqweb.ipd.kit.edu/wiki/BibTeX-Literaturlisten

sdqseminar.cls
-------------
Dies ist die Vorlage, die die Stil-Informationen für das Dokument enthält.
Im Sinne eines einheitlichen Ausarbeitungsstils soll diese Datei nicht
verändert werden.

images/
------
In diesem Verzeichnis befinden das das SDQ-Logo als PDF und EPS.

sections/
---------
In diesem Verzeichnis können Sie ihre Inhaltsabschnitte als einzelne
.tex-Dateien anlegen. Wir empfehlen Ihnen das Aufteilen der Dateien nach
Abschnitten.

README
------
Dieser Text.

English Version
===============
This is a template for student's seminar theses at the chair of Software Design
and Quality (SDQ) at the Institute of Program Structures and Data Organization
(IPD) at Karlsruhe Institute of Technology (KIT).

Many thanks to Markus Kohm (http://www.komascript.de) for his support in
creating the template.

Version
=======
Version: 1.0
Author: Dr.-Ing. Erik Burger (burger@kit.edu)

See https://sdqweb.ipd.kit.edu/wiki/Dokumentvorlagen

Usage
=====
This package is used as a template for student seminar theses. To use it, adapt
the main file seminar.tex and the files for the chapters in the directory
sections/ by removing the example text and replacing it with your own content.
Please do not change any layout parameters such as font size, margins, line
spacing etc., so that the theses appear in a uniform way.

Language
--------
The standard language of this document is English. You can change the
language in the \documentclass command at the beginning of seminar.tex.
German and English are available.

One-sided/two-sided layout
--------------------------
The standard format is two-sided layout. You can change this to one-sided
layout in the \documentclass command at the beginning of seminar.tex.

Draft mode
----------
The draft mode is activated by standard and can be switched to "final"
in the \documentclass command at the beginning of seminar.tex.
In draft mode, todo-notes and placeholders for missing graphics are displayed,
while they are omitted in the final mode.

LaTeX
-----
See https://sdqweb.ipd.kit.edu/wiki/LaTeX

File structure
==============
seminar.tex
----------
This is the main file of your LaTeX document. Please insert your data there.
It is recommended to rename the file so that your advisor can distinguish
different theses (e.g., in seminar_erik_burger.tex).

seminar.bib
----------
You can use this BibTeX file to collect your literature.
We recommend using biblatex and biber instead of BibTeX.
The template is already configured in this way.
You can include the SDQ literature database for SDQ-relevant publications,
see https://sdqweb.ipd.kit.edu/wiki/BibTeX-Literaturlisten

sdqseminar.cls
-------------
This is the style template for the document. Please do not modify this file,
so that all theses appear in the same style.

images/
------
This directory contains the SDQ logo in PDF and EPS.

sections/
---------
This directory contains your content sections, split in single .tex files.
We recommend splitting your sections into single files.

README
------
This text.

About


Languages

Language:TeX 99.3%Language:Shell 0.7%