Project

General

Profile

Roadmap

Doc_Tool_v1

about 20 months late (01/19/2018)

Prototyp der Bachelorarbeit

78%

9 issues   (7 closed2 open)

Benutzerhandbuch

Erstellen einer Dokumentationsvorlage

Eine neue Vorlage lässt sich über das Kontextmenü File > New document erstellen. Wurde diese Option gewählt muss man zunächst ein Ausgabeverzeichnis wählen.

ausgabeverzeichnis

Mit dem rot markierten Icon rechts oben kann man einen neuen Ordner Anlegen. Wurde ein Ausgabeverzeichnis gewählt, gelangt man durch einen Klick auf OK
zum Konfigurationsfenster für die Generationseinstellungen.

Folgende Einstellungen sind möglich:

Generation Settings

  • Add cover sheet: Gibt an ob ein Angabeblatt am Anfang der Dokumentation angefügt werden soll.
  • Add latex titlepage: Diese Option generiert wenn ausgewählt ein einfaches Deckblatt.
  • Add Table of content: Wenn angewählt wird ein Inhaltsverzeichnis generiert.
  • Table of content depth: Gibt an bis zu welcher Überschriftenhierachie die Überschriften in das Inhaltsverzeichnis aufgenommen werden sollen.

File Extension Settings

  • Header: Dateiendung für Headerdateien inklusive '.', wird zum Parsen der Headerdateien verwendet.
  • Source: Dateiendung für Quellcodedateien inklusive '.', wird zum Parsen der Quellcodedateien verwendet.

Document Settings

  • Subject Name: Wird in der Kopfzeile des Dokuments angezeigt.
  • Location: Verfassungsort des Dokuments, der hier eingetragene Text wird nur im Latex-Deckblatt angezeigt.

Dokumentation schreiben

Zunächst muss eine Vorlage über File > Open document template geladen werden.

Design anpassen