First web gui prototype

webgui/manual.php

@@ -0,0 +1,106 @@
+<?php
+/******************************************************************************
+ * YMS - Yacht Management Software
+ * Copyright (C) 2024 Thomas Hooge
+ * 
+ * SPDX-License-Identifier: WTFPL
+ ******************************************************************************/
+
+require 'globals.inc';
+$pagetitle=_('Manual');
+
+require 'header.php';
+?>
+
+<h1>Yacht Management System</h1>
+<h2>Integriertes Handbuch</h2>
+
+<p>Es können mehrere Yachten mit dem Programm verwaltet werden.
+Die Umschaltung erfolgt über eine Auswahlliste auf der Übersichtsseite.</p>
+<p>Die Yachtdaten können nur mit de Berechtigungsebene <em>captain</em>
+verändert werden.</p> 
+
+<p>Bei Neuanlage eines Datensatzes werden nur die wichtigsten Felder 
+angezeigt. Weitere Felder können im Anschluß über die Bearbeiten-Funktion
+ausgefüllt werden.</p>
+
+<h3>Stauraum</h3>
+<p>Der Stauraum teilt sich in verschiedene Bereiche auf. 
+Diese sind über eine fixe Position an Bord einstellbar.</p>
+
+<p>Zusätzlich zum festen Stauraum können auch Kisten definiert werden.
+Eine Kiste kann in einen Stauraum gelegt werden. Da sie beweglich ist,
+kann sie auch als Ganzes auf eine andere Yacht übergeben werden.</p>
+
+<p>Es existiert ein Koordinatensystem. Die Einheit ist Millimeter (mm). 
+Der Ursprung ist achtern Mittschiffs. Die X-Achse verläuft in Längsrichtung
+der Yacht. Die Y-Achse verläuft zur Querrichtung, Koorinaten auf der Backbordseite
+sind negativ, auf der Steuerbordseite positiv.
+Die Z-Achse geht in Richtung Mastspitze. Der Nullpunkt liegt auf Höhe der 
+Wasserlinie.</p>
+
+<h3>Ausrüstung</h3>
+<p>Ausrüstung ist zumeist fest mit der Yacht verbunden, jeder Ausrüstungsgegenstand
+existiert nur ein mal und kann eine Seriennummer besitzen.</p>
+<p>Ausrüstung kann gewartet werden.</p>
+
+<h3>Inventar</h3>
+<p>Unter Inventar sind bewegliche Dinge zusammengefaßt.
+Ein Inventargegenstand kann auch mehrfach vorkommen.
+Beispiel: <em>Winschkurbel, Anzahl: 3</em></p>
+<p>Inventar kann in einem Stauraum abgelegt werden oder aber in einer 
+Kiste.</p>
+
+<h3>Proviant</h3>
+<p>Proviant ist verderblich. 
+Es wird das Einlagerungsdatum erfaßt und das Haltbarkeitsdatum</p>
+
+<h3>Wartung</h3>
+<p>Es können einmalige und wiederkehrende Wartungen erfaßt werden</p>
+<p>Eine wiederkehrende Wartung kann aufgrund Zeit, z.B. 1x jährlich,
+oder nach Betriebsstunden definiert werden.</p>
+
+<h3>Projekte</h3>
+<p>Einem Projekt werden Aufgaben zugeordnet, es hat einen Status wie
+z.B. <em>neu</em>, <em>laufend</em> oder <em>erledigt</em>.</p>
+
+<h3>Firmen</h3>
+<p>Es können verschiedene Arten von Firmen hinterlegt werden, wie
+beispielsweise Hersteller, Lieferanten oder Dienstleister.</p>
+
+<h3>Dokumente</h3>
+<p>Ein Dokument kann mehrfach zugeordnet werden. Z.B. einem 
+Ausrüstungsgegenstand und gleichzeitig einem Projekt oder einer Aufgabe.</p>
+<p>Es stehen verschiedene Dokumentarten zur Verfügung:</p>
+<ul>
+  <li>Fotos bzw. Bilder als png- oder jpg-Dateien</li>
+  <li>Zeichnungen als svg-Dateien</li>
+  <li>Dokumente als pdf-Dateien</li>
+</ul>
+
+<h3>Checklisten</h3>
+<p>Es ist eine Historie vorgesehen.</p>
+
+<h3>Ersatzteile</h3>
+<p>Die Verwaltung von Ersatzteilen erfolgt normalerweise über das Inventar.</p>
+
+<h3>Maße / Messungen</h3>
+<p>Messungen können hier dokumentiert werden. Eine Zuordnung zur Ausrüstung
+ist vorgesehen.</p>
+<p>In einer Messung können ein bis drei Werte gespeichert werden. Damit
+ist es möglich Flächen <span style="white-space:nowrap">(L x B)</span> oder 
+Volumen <span style="white-space:nowrap">(L x B x H)</span> zusammenhängend
+zu erfassen.</p>
+
+<h3>Benutzer</h3>
+<p>Benutzer können nicht über die Web-GUI eingerichtet werden.</p>
+<p>Es gibt die Berechtigungsebenen <em>Kapitän (captain)</em>, 
+<em>Steuermann (helmsman)</em> und <em>Matrose (sailor)</em>. 
+
+<h3>Stammdaten</h3>
+<p>Diese Daten ändern sich nicht sehr häufig, sind aber für den Betrieb
+essentiell. Stanndaten sind beispielsweise Firmen, Auswahllisten oder
+auch der Stauraum.</p>
+
+<?php
+include 'footer.php';