blob: 70d2a66d8c11f08bed0989faf8e75a648cdbc12c (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
|
\chapter{Aufbau dieses Handbuchs}
\label{aufbau}
\index{Aufbau} \index{Bedienungsanleitung} \index{Entwicklerdokumentation}
Das Handbuch ist in drei Teile gegliedert, wobei der erste Teil mit diesen Erläuterungen bereits abgeschlossen wird. Der zweite Teil wendet sich an die Endanwender dieses Projekts und versteht sich als Bedienungsanleitung mit dem Fokus auf den Überblick zum Funktionsumfang und zur Konfiguration. Der dritte Teil umfasst die Entwicklerdokumentation. Dabei werden die einzelnen Komponenten und das Kommunikationsprotokoll detaillierter aus technischer Sicht dargestellt.
\section{Heraushebungen und Formatierungen}
\index{Schreibweise} \index{Kommando} \index{Quelltext} \index{Konfiguration}
\index{Formatierung} \index{Verzeichnis} \index{Dateiname}
Zur besseren Lesbarkeit gibt es einige Konventionen zur Formatierung von einfachen Kommandos, Kommandozeilen oder Verzeichnis- und Dateinamen. Ebenso sind Skripte oder Auszüge aus C++-Quelltexten zur Heraushebung anders gesetzt.
Hierbei gelten folgende Regelungen: Ein einfaches Kommando wird \textbf{fett} gesetzt, wie beispielsweise \textbf{pvsmgr}. Dieses lässt sich in einem Terminalfenster absetzen oder über die Ausführenoption der grafischen Desktops. Kommandos mit Optionen und bei Bedarf Parametern werden so wie Skripten und Quelltexte in \texttt{Schreibmaschinenschrift} gesetzt aber nicht aus dem allgemeinen Textsatz herausgehoben. Solche Heraushebungen werden jedoch ab zwei Druckzeilen aufwärts sinnvoll. Verzeichnis- und Dateinamen, wobei es bei letzteren dann nicht um den Programmnamen, sondern Quelltexte, Konfigurationen etc. geht, werden \textit{kursiv} gedruckt, wie beispielsweise \textit{/etc/pvs}.
|
