[Wsplgen-commits] r71 - trunk/doc/Dokumentation

[scm-commit@wald.intevation.org]

Author: mrchip
Date: 2006-10-19 21:46:06 +0200 (Thu, 19 Oct 2006)
New Revision: 71

Modified:
   trunk/doc/Dokumentation/WSPLGEN-Dokumentation.tex
Log:
Dokumentation zu Version 1.0.0. Der Parameter ? wurde hinzugef?\195?\188gt.



Modified: trunk/doc/Dokumentation/WSPLGEN-Dokumentation.tex
===================================================================
--- trunk/doc/Dokumentation/WSPLGEN-Dokumentation.tex	2006-10-19 19:41:11 UTC (rev 70)
+++ trunk/doc/Dokumentation/WSPLGEN-Dokumentation.tex	2006-10-19 19:46:06 UTC (rev 71)
@@ -34,9 +34,9 @@
 \RCS$Id$
 \RCS$Revision$
 
-\newcommand{\documentdate}{16. Oktober 2006}
+\newcommand{\documentdate}{19. Oktober 2006}
 \newcommand{\documentrevision}{\RCSRevision}
-\newcommand{\documentversion}{0.9.18}
+\newcommand{\documentversion}{1.0.0}
 \newcommand{\documentID}{\RCSId}
 %----------------------------------------------
 
@@ -1098,6 +1098,34 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+\subsection{? (Versionsnummer)}\label{subsec:param-version}
+
+\begin{tabular}{p{2.4cm}p{2.5cm}p{2.5cm}p{2.5cm}p{3.0cm}}
+{\bf Kurzfassung} & \multicolumn{4}{l}{Ausgabe der Versionsnummer}\\
+{\bf Format}      & \multicolumn{4}{l}{?}\\
+{\bf Status}      & \multicolumn{4}{l}{optional}\\
+{\bf Argumente}   & \em Name & \em Typ & \em Einheit & \em Standardwert\\
+                  & - & - & - & - \\
+{\bf Beispiel}    & \multicolumn{4}{l}{?}\\
+\end{tabular}
+
+\vspace{1cm plus 0.5cm minus 0.5cm}
+
+Der Parameter \verb;?; ist ein besonderer Parameter. Er wird nur benötigt, damit
+andere Programme automatisch die Versionsnummer von WSPLGEN abfragen können.
+
+Er wird auch nicht mit einem Minuszeichen begonnen.
+
+WSPLGEN beendet sich sofort nach der Ausgabe der Versionsnummer auf die Standardausgabe wieder.
+
+Will man als Mensch die Versionsnummer von WSPLGEN erfahren, so erpfiehlt es sich das Programm
+ganz ohne Parameter zu starten, da es dann die Versionsnummer zusätzlich zu ein paar anderen
+Informationen in die Datei WSPLGEN.LOG schreibt.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \newpage
 \section{Zwingend erforderliche Eingabedateien}\label{sec:eingabe}
 
@@ -2367,6 +2395,11 @@
 Der Fall das es mehr als 2 nasse Ränder gibt, kann aber auch durch Nebengewässer oder Inseln im Gewässer
 verursacht werden. Diese Warnung ist also eher als Hinweis zu verstehen.
 
+\textbf{Rückgabewert: 3117}\\
+Warnung: Zwei Profile schneiden sich.\\
+Erklärung: Normalerweise sollten sich Profilspuren nicht schneiden, da dies zu einer nicht
+eindeutigen Zuordnung der Wasserstände zum DGM führt. WSPLGEN kann zwar mit dieser Situation
+weiter arbeiten, doch sind die Ergebnisse in den meisten Fällen nicht zufriedenstellend.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -2425,11 +2458,7 @@
 Erklärung: Dieser Fehler deutet auf einen Programmfehler hin, der nicht erwartet
 wurde. Der Anwender sollte sich mit den Programmierern in Verbindung setzen.
 
-\vspace{3cm plus 2 cm minus 2cm}
 
-Bemerkung: Die Liste der Fehler ist hiermit {\bf noch} nicht abschließend beschrieben.
-
-
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -2499,8 +2528,6 @@
 
 Abschnitt~\ref{sec:probleme}: Der Abschnitt wurde aktualisiert.
 
-Abschnitt~\ref{sec:verbesserungen}: Der Abschnitt wurde aktualisiert.
-
 {\bf Version: 0.9.15, Datum: 02.07.2006}
 
 Abschnitt~\ref{subsubsec:file-wsp-wst-format}: Das neue WST-Format wird jetzt auch beschrieben.
@@ -2548,8 +2575,7 @@
 Abschnitt~\ref{subsec:file-sperr}: Der noch fälschlicherweise verwendete alte Attributwert \verb;BRUCH; wurde durch den
 neuen korrekten Wert \verb;GRABEN; ersetzt.
 
-Anhang \ref{sec:fehlermeldungen}, Fehlercode 1225:
-Der Fehler wurde gelöscht.
+Anhang \ref{sec:fehlermeldungen}, Fehlercode 1225: Der Fehler wurde gelöscht.
 
 {\bf Version: 0.9.17, Datum: 07.09.2006}
 
@@ -2569,6 +2595,12 @@
 
 Es wurde diverse Tippfehler und kleine kosmetische Veränderungen durchgeführt.
 
+{\bf Version: 1.0.0, Datum: 19.10.2006}
+
+Abschnitt~\ref{subsec:param-version}:: Es wurde der Parameter \verb;?; aufgenommen.
+
+Anhang \ref{sec:fehlermeldungen}, Fehlercode 3117: Der Fehler wurde hinzugefügt.
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -2590,30 +2622,6 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-\newpage
-\section{Verbesserungsmöglichkeiten}\label{sec:verbesserungen}
-
-Hier werden Ideen gesammelt, die das Programm weiter verbessern würden:
-
-\begin{enumerate}
-
-\item Man könnte ganz ohne Elemente arbeiten. Sowhl die Triangulierung
-als auch die Einlesenroutinen könnten immer gleich Kanten generieren. 
-
-\item Das Programm könnte auch Netzte mit gemischten Drei- und Viereckselementen
-unterstützen, wie sie bei Finite-Elemente-Modellen benutzt werden
-(z.B. 2DM-Format von SMS).
-
-\item Sollten Profile nicht lang genug sein, so könnte sie das Programm
-automatisch verlängern.
-
-\end{enumerate}
-
-
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
 \end{appendix}