Anwenderdokumentation/search/search_index.json

{"config":{"lang":["de"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Startseite","text":"<p>In dieser Anwenderdokumentation finden Sie Informationen zur Bedienung der Software. Die Dokumentation ist in verschiedene Abschnitte unterteilt, die sich mit unterschiedlichen Modulen des Programms besch\u00e4ftigen. Die Abschnitte sind in der linken Navigationsleiste aufgelistet.</p>"},{"location":"#inhaltsverzeichnis","title":"Inhaltsverzeichnis","text":"<ol> <li>Startseite</li> <li>Allgemeines<ol> <li>\u00dcber das Projekt</li> <li>Dokumentation erweitern</li> <li>Entwicklung und Schnittstellen</li> </ol> </li> <li>Funktionen und Module<ol> <li>Startseite</li> <li>Dashboard</li> <li>Dokumentation<ol> <li>Routes</li> <li>Touren</li> </ol> </li> <li>Account</li> </ol> </li> <li>Weitere Informationen<ol> <li>Installation als App</li> </ol> </li> </ol>"},{"location":"1_general/1_about/","title":"\u00dcber das Projekt","text":"<p>Herzlich Willkommen zur Anwenderdokumentation f\u00fcr das Projekt \"Streckenkunde Digital\". Diese Dokumentation soll Ihnen als Anwender helfen, sich in der Software zurechtzufinden und die Funktionen zu verstehen. Die Software wurde speziell f\u00fcr Triebfahrzeugf\u00fchrer entwickelt, um die Dokumentation der Streckenkunde zu vereinfachen und zu digitalisieren. Bei Fragen oder Problemen k\u00f6nnen Sie sich gerne an den Support wenden. Die Kontaktdaten finden Sie am Ende dieser Seite.</p>"},{"location":"1_general/1_about/#kontakt-zum-support","title":"Kontakt zum Support","text":"<p>Der Support und die Weiterentwicklung des Projekts erfolgt durch folgenden Dienstleister:</p> <p>Dennis Heinrich Veer\u00dfer Stra\u00dfe 86 29525 Uelzen</p> <p>Support-Mail: kontakt@streckenkunde.digital Internetseite: dennis-heinri.ch</p>"},{"location":"1_general/2_changes/","title":"Dokumentation erweitern","text":""},{"location":"1_general/2_changes/#vorschlag-zur-dokumentation-einreichen","title":"Vorschlag zur Dokumentation einreichen","text":"<p>Um einen Vorschlag zur Dokumentation einzureichen, erstellen Sie bitte ein Issue auf GitHub im Projekt zur Anwenderdokumentation. Dort k\u00f6nnen Sie die gew\u00fcnschte \u00c4nderung oder eine Erg\u00e4nzung mitteilen.</p> <p>Hier k\u00f6nnen Sie einen Vorschlag einreichen</p>"},{"location":"1_general/2_changes/#beitragen-an-der-dokumentation","title":"Beitragen an der Dokumentation","text":"<p>Wenn Sie an der Dokumentation mitarbeiten m\u00f6chten, k\u00f6nnen Sie ihre \u00c4nderungen selbst in das Repository einpflegen. Dazu k\u00f6nnen Sie das Repository klonen und die \u00c4nderungen lokal vornehmen. Anschlie\u00dfend k\u00f6nnen Sie die \u00c4nderungen \u00fcber einen Pull-Request einreichen und werden diese nach einer Pr\u00fcfung in die Dokumentation \u00fcberf\u00fchren.</p> <p>Mehr Informationen zum Beitragen finden Sie in dem Repository.</p>"},{"location":"1_general/2_changes/#voraussetzungen-an-den-beitragenden","title":"Voraussetzungen an den Beitragenden","text":"<p>Zum Beitragen an der Dokumentation sind folgende Voraussetzungen notwendig:</p> <ul> <li>Docker um die Dokumentation zu kompilieren und zu starten</li> <li>Das Tool Just, es ist ein Management-Tool f\u00fcr das Ausf\u00fchren von Befehlen</li> <li>Erfahrung im Umgang mit Markdown-Dateien und der Versionsverwaltung Git</li> </ul>"},{"location":"1_general/3_development/","title":"Entwicklung und Schnittstellen","text":"<p>Die Software bietet eine spezielle Webseite (API), die es erm\u00f6glicht, Nutzerdaten zu bearbeiten. Diese Webseite ist \u00fcber die Adresse <code>/api</code> erreichbar.</p> <ul> <li>OpenAPI-Spezifikation: Es gibt eine Anleitung, wie man die API benutzt, die unter <code>/api/openapi.json</code> abrufbar ist.</li> <li>Interaktive Dokumentation: Eine benutzerfreundlichere Version der Dokumentation findest du unter <code>/api/docs</code>.</li> </ul>"},{"location":"1_general/3_development/#authentifizierung","title":"Authentifizierung","text":"<p>Um sicherzugehen, dass nur berechtigte Personen Zugang haben, nutzt die Software JWT-Token:</p> <ul> <li>Nach dem Einloggen erh\u00e4ltst du einen JWT-Token von der Adresse <code>/api/login_check</code>.</li> <li>Diesen Token musst du bei jeder Anfrage im <code>Authorization</code>-Bereich deiner Internetanfrage als Bearer-Token mitschicken.</li> </ul>"},{"location":"2_modules/1_welcome/","title":"Startseite","text":"<p>Jeder Nutzer ohne eine g\u00fcltige Anmeldung wird auf der Willkommensseite begr\u00fc\u00dft. Hier kann sich der Nutzer entweder anmelden oder ein neues Benutzerkonto registrieren. Au\u00dferdem gibt es die M\u00f6glichkeit, ein neues Passwort anzufordern, falls der Nutzer sein Passwort vergessen hat.</p> <p></p>"},{"location":"2_modules/1_welcome/#anmeldung-mit-vorhandenem-benutzerkonto","title":"Anmeldung mit vorhandenem Benutzerkonto","text":"<p>Jeder Nutzer kann sich auf der Plattform registrieren und anmelden. Dazu wird ein Benutzername und ein Passwort ben\u00f6tigt. Die Anmeldung erfolgt \u00fcber die Webseite und ist f\u00fcr jeden Nutzer zug\u00e4nglich. Der Benutzername ist die E-Mail-Adresse, die bei der Registrierung angegeben wurde. Das Passwort wird bei der Registrierung festgelegt und kann jederzeit durch die Passwort-Vergessen Funktion ge\u00e4ndert werden.</p> <p></p>"},{"location":"2_modules/1_welcome/#registrierung-eines-neuen-benutzerkontos","title":"Registrierung eines neuen Benutzerkontos","text":"<p>Um ein neues Benutzerkonto zu registrieren, muss der Nutzer auf der Webseite die Registrierungsfunktion aufrufen. Dazu wird ein Benutzername (E-Mail), der vollst\u00e4ndige Name des Anwenders und ein Passwort ben\u00f6tigt.</p> <p></p>"},{"location":"2_modules/1_welcome/#passwort-vergessen","title":"Passwort vergessen","text":"<p>Wenn ein Nutzer sein Passwort vergessen hat, kann er \u00fcber die Webseite ein neues Passwort anfordern. Dazu wird die E-Mail-Adresse ben\u00f6tigt, die bei der Registrierung angegeben wurde. Der Nutzer erh\u00e4lt dann eine E-Mail mit einem neuen Passwort zur vorr\u00fcbergehenden Anmeldung.</p> <p></p>"},{"location":"2_modules/2_dashboard/","title":"Dashboard","text":"<p>Auf dem Dashboard sieht der Nutzer eine \u00dcbersicht zum Verfall seiner dokumentierten Streckenkunden, allgemeine Informationen zu seinem Benutzerkonto und eine kleine Statistik \u00fcber die Anzahl der von ihm eingepflegten Strecken und Touren.</p> <p></p>"},{"location":"2_modules/2_dashboard/#verfallsubersicht","title":"Verfalls\u00fcbersicht","text":"<p>In diesem Modul hat der Nutzer die M\u00f6glichkeit, sich einen \u00dcberblick \u00fcber den Verfall seiner Streckenkunden zu verschaffen. Hier werden alle Streckenkunden aufgelistet, die in seinem festgelegten Zeitraum (Auswahl der Tage) ablaufen werden. Der Nutzer kann zudem die Strecken rausfiltern, die er noch nie dokumentiert hat. Daf\u00fcr kann er die Checkbox \"Nur aufgezeichnete Strecken\" verwenden.</p>"},{"location":"2_modules/2_dashboard/#nur-aufgezeichnete-strecken","title":"Nur aufgezeichnete Strecken","text":"<p>Es werden nur die Strecken angezeigt, die bereits in der Vergangenheit dokumentiert wurden und in dem angebenen Zeitraum der Tage ablaufen werden und somit ein Verfallsdatum haben. Abgelaufene Strecken werden immer angezeigt, unabh\u00e4ngig der Filter.</p> <p></p>"},{"location":"2_modules/2_dashboard/#alle-strecken-anzeigen","title":"Alle Strecken anzeigen","text":"<p>Alle Strecken werden angezeigt, unabh\u00e4ngig davon, ob sie bereits dokumentiert wurden oder nicht. In diesem Fall wird unter der Strecke \"Keine Aufzeichnung\" dargestellt und alle Strecken die unter dieses Kriterium fallen, werden ganz oben in der Liste dargestellt. Abgelaufene Strecken werden immer angezeigt, unabh\u00e4ngig der Filter.</p> <p></p>"},{"location":"2_modules/3_documentation/","title":"Dokumentation","text":"<p>Auf dieser Seite hat der Nutzer die M\u00f6glichkeit:</p> <ol> <li>Seine Streckenkunden zu dokumentieren</li> <li>Strecken anzuzeigen oder zu erstellen</li> <li>Touren anzuzeigen oder zu erstellen</li> </ol> <p></p>"},{"location":"2_modules/3_documentation/#strecken","title":"Strecken","text":"<p>Eine Strecke ist ein Abschnitt im Schienennetz, der von einem Start- zu einem Endpunkt f\u00fchrt. Die Strecke besteht immer aus einem Namen, zwei Punkten (Start und Endpunkt) und optional einem Namen, der Unternehmensintern verwendet wird. Die Strecke kann auch in einer Tour inbegriffen sein, um die Dokumentation mehrerer Strecken zu vereinfachen.</p>"},{"location":"2_modules/3_documentation/#touren","title":"Touren","text":"<p>Eine Tour enth\u00e4lt mehrere Strecken. Eine Tour kann beispielsweise eine Fahrt von Hamburg nach Berlin sein. In diesem Fall w\u00fcrde die Tour alle Strecken enthalten, die auf dieser Fahrt zur\u00fcckgelegt werden. Somit k\u00f6nnen auf oft befahrenen Abschnitten oder vorgefertigten Touren die Strecken mit einem einzelnen Klick in die Dokumentation \u00fcbernommen werden, statt diese alle vereinzelt zu markieren.</p>"},{"location":"2_modules/3_documentation/#dokumentieren","title":"Dokumentieren","text":"<p>Die Dokumentation einer Streckenkunde erfolgt \u00fcber die Markierung der gefahrenen Touren oder einzelner Strecken. Die Markierung erfolgt mit dem Lesezeichen-Symbol. \u00dcber erneuten Klick kann die Markierung wieder entfernt werden.</p> <p>Wenn mindestens ein Element markiert wurde, erscheint das Modul zur Dokumentation der Streckenkunde. Hier kann der Nutzer ein Datum festlegen, an dem die Streckenkunde erworben wurde. Standardm\u00e4\u00dfig ist immer das aktuelle Datum vorausgew\u00e4hlt. Der Ablauf der Streckenkunde wird automatisch berechnet und f\u00fcr ein Jahr festgelegt (364 Tage nach Erwerbsdatum).</p> <p></p>"},{"location":"2_modules/3_documentation/1_routes/","title":"Strecken","text":"<p>Eine Strecke ist ein Abschnitt im Schienennetz, der von einem Start- zu einem Endpunkt f\u00fchrt. Die Strecke besteht immer aus einem Namen, zwei Punkten (Start und Endpunkt) und optional einem Namen, der Unternehmensintern verwendet wird. Die Strecke kann auch in einer Tour inbegriffen sein, um die Dokumentation mehrerer Strecken zu vereinfachen.</p>"},{"location":"2_modules/3_documentation/1_routes/#erstellen","title":"Erstellen","text":"<p>Um eine neue Strecke zu erstellen, klicke auf den Button \"Strecke erstellen\" auf der Seite Dokumentation. Es \u00f6ffnet sich ein Dialog, in dem du die notwendigen Informationen eingeben kannst.</p> <ul> <li>Name: Der Name der Strecke.</li> <li>Unternehmens-K\u00fcrzel: (optional) Bezeichner f\u00fcr die Strecke.</li> <li>Start der Strecke: Der Startpunkt der Strecke.</li> <li>Ende der Strecke: Der Endpunkt der Strecke.</li> <li>Zuletzt gefahren am: (optional) Das Datum, an dem die Strecke zuletzt befahren wurde.<ul> <li>Standardm\u00e4\u00dfig wird kein Datum angegeben.</li> <li>Mit Eintrag wird die Strecke zur Erstellung mit der Streckenkunde vermerkt.</li> </ul> </li> </ul> <p></p>"},{"location":"2_modules/3_documentation/1_routes/#ansehen","title":"Ansehen","text":"<p>Um eine Strecke anzusehen, klicke auf den Namen der Strecke an einem beliebigen Punkt innerhalb der Anwendung. Es \u00f6ffnet sich ein Dialog, in dem du die Informationen zur Strecke einsehen kannst. Die Strecke kann z.B. \u00fcber die Suche der Dokumentation gefunden werden. Es werden alle Daten, sowie die G\u00fcltigkeit der Streckenkunde angezeigt.</p> <p></p> <p>Hat die Strecke keine dokumentierte Streckenkunde, wird dies mit \"Nicht erfasst\" gekennzeichnet</p> <p></p>"},{"location":"2_modules/3_documentation/1_routes/#bearbeiten","title":"Bearbeiten","text":"<p>Um eine Strecke zu bearbeiten, klicke auf den Namen der Strecke an einem beliebigen Punkt innerhalb der Anwendung um die Strecke anzusehen. Anschlie\u00dfend klicke auf den Button \"Strecke bearbeiten\". Es \u00f6ffnet sich ein Dialog, in dem du die notwendigen Informationen \u00e4ndern oder die Strecke komplett l\u00f6schen kannst. Die Strecke kann z.B. \u00fcber die Suche der Dokumentation gefunden werden.</p> <p></p>"},{"location":"2_modules/3_documentation/2_tours/","title":"Touren","text":"<p>Eine Tour ist z.B. eine Fahrt von Hamburg nach Berlin, welche viele Strecken beinhaltet. Somit k\u00f6nnen auf oft befahrenen Abschnitten oder vorgefertigten Touren die Strecken mit einem einzelnen Klick in der Dokumentation \u00fcbernommen werden, statt alle Strecken vereinzelt zu markieren.</p>"},{"location":"2_modules/3_documentation/2_tours/#erstellen","title":"Erstellen","text":"<p>Die Erstellung einer Tour erfolgt \u00fcber den Button \"Tour erstellen\" auf der Seite Dokumentation. Die Tour ben\u00f6tigt einen Namen und mindestens zwei Strecken, um erstellt werden zu k\u00f6nnen. Die Strecken k\u00f6nnen \u00fcber die Suchfunktion ausgew\u00e4hlt werden, und wie bei der Dokumentation markiert werden. Alle markierten Strecken sind dann Bestandteil der Tour.</p> <p></p>"},{"location":"2_modules/3_documentation/2_tours/#ansehen","title":"Ansehen","text":"<p>Um eine Tour anzusehen, klicke auf den Namen einer Tour an einem beliebigen Punkt innerhalb der Anwendung. Es \u00f6ffnet sich ein Dialog, in dem die Informationen, sowie die beinhalteten Strecken einer Tour eingesehen werden k\u00f6nnen. Eine Tour kann z.B. \u00fcber die Suche der Dokumentation gefunden werden. \u00dcber einen Klick auf eine der Strecken in der Tour gelangst du zur Einzelansicht dieser.</p> <p></p>"},{"location":"2_modules/3_documentation/2_tours/#bearbeiten","title":"Bearbeiten","text":"<p>Um eine Tour zu bearbeiten, klicke auf den Namen einer Tour an einem beliebigen Punkt innerhalb der Anwendung um die Tour anzusehen. Anschlie\u00dfend klicke auf den Button \"Tour bearbeiten\". Es \u00f6ffnet sich ein Dialog, in dem du die notwendigen Informationen, sowie die beinhalteten Strecken \u00e4ndern oder die Tour g\u00e4nzlich l\u00f6schen kannst. </p> <p>Wenn die Auswahl der beinhalteten Strecken ge\u00e4ndert werden, sind diese erst nach dem Speichern aktiv. Die Anwendung merkt sich dennoch die vorherige Auswahl, z.B. um Strecken zwischenzeitlich zu \u00f6ffnen oder zu bearbeiten. Kehrt man zur Bearbeitung zur\u00fcck, sind die Strecken wieder markiert. Die Auswahl der ge\u00e4nderten Strecken ohne Speichern wird verworfen, wenn auf \"Zur\u00fcck zur Ansicht\" geklickt wird.</p> <p></p>"},{"location":"2_modules/4_account/","title":"\u00dcbersicht","text":"<p>Das Modul \"Account\" bietet dem Nutzer die M\u00f6glichkeit, seine pers\u00f6nlichen Daten anzuzeigen. Eine Bearbeitung der Daten ist zum  derzeitigen Stand der Anwendung nicht m\u00f6glich.</p> <p></p>"},{"location":"3_extras/","title":"\u00dcbersicht","text":""},{"location":"3_extras/1_app/","title":"Installation als App","text":""},{"location":"3_extras/1_app/#desktop","title":"Desktop","text":""},{"location":"3_extras/1_app/#google-chrome","title":"Google Chrome","text":"<p>Die Seite kann als App (PWA) auf dem Desktop installiert werden. Dazu wird die Seite im Browser ge\u00f6ffnet und die Option \"Installieren\" neben der URL-Eingabe ausgew\u00e4hlt.</p> <p></p> <p>Es \u00f6ffnet sich ein Dialog, in dem die Installation best\u00e4tigt werden muss.</p> <p></p> <p>Anschlie\u00dfend wird die App als Icon und auf dem Desktop abgelegt.</p> <p></p> <p>Nach dem Start der App wird die Anwendung in einem eigenen Fenster ge\u00f6ffnet.</p> <p></p>"},{"location":"3_extras/1_app/#smartphone","title":"Smartphone","text":""},{"location":"3_extras/1_app/#android-mit-google-chrome","title":"Android mit Google Chrome","text":"<p>Die Seite kann als App (PWA) auf dem Smartphone installiert werden. Dazu wird die Seite im Browser ge\u00f6ffnet und die Option \"App Installieren\" in den Einstellungen (Drei-Punkte-Icon) des Chrome-Browsers ausgew\u00e4hlt. Dann wird die Installation best\u00e4tigt.</p> <p></p> <p>Anschlie\u00dfend wird die App als Icon auf dem Startbildschirm abgelegt und kann dort als App gestartet werden.</p> <p></p> <p>Die App ist auch \u00fcber die App-\u00dcbersicht erreichbar, wo sie als eigenst\u00e4ndige App angezeigt wird und auch deinstalliert werden kann.</p> <p></p>"},{"location":"3_extras/1_app/#apple-ios","title":"Apple / iOS","text":"<p>Auf iOS-Ger\u00e4ten kann die App nicht installiert werden, da Apple keine PWAs unterst\u00fctzt. Die Seite kann jedoch als Startbildschirm-Lesezeichen \u00fcber Safari hinzugef\u00fcgt werden, um sie schneller zu \u00f6ffnen. Daf\u00fcr wird die Seite im Safari-Browser ge\u00f6ffnet und die Option \"Zum Home-Bildschirm\" in den Einstellungen (Teilen-Icon) ausgew\u00e4hlt.</p> <p></p> <p>Anschlie\u00dfend wird die Installation mit der Vergabe eines Namens best\u00e4tigt.</p> <p></p> <p>Die Anwendung wird als Icon auf dem Startbildschirm abgelegt und kann dort als Lesezeichen gestartet werden.</p>"}]}