diff --git a/templates/documentation-sessionmanagement.html b/templates/documentation-sessionmanagement.html index 267abb202c9d4d0f7021ec2bb0512984b4ed0594..6ccbd6d936072bce3d702ae04065a0971b550514 100644 --- a/templates/documentation-sessionmanagement.html +++ b/templates/documentation-sessionmanagement.html @@ -4,21 +4,29 @@ {% block documentation_content %} <h3>Sitzungsverwaltung</h3> + <p> Ein wesentlicher Bestandteil des Protokollsystems ist das Sitzungsmanagement. Neben dem <a href="/documentation/sessionmanagement/plan">Planen und Anlegen</a> verschiedener Sitzungstermine kann zu jeder Sitzung ein <a href="/documentation/sessionmanagement/write">Protokoll</a> verfasst und anschließend durch das System ausgegeben werden. Die <a href="/documentation/sessionmanagement/tracking">Nachverfolgung</a> der Ergebnisse im System aus einer Sitzung ist zu Beschlüssen und Todos möglich. - + </p> <h4>Verwaltung im Detail</h4> + <p> Um die Funktionen der Sitzungsverwaltung zu verstehen, wird auf den Unterseiten auf die einzelnen Abschnitte des Managements eingegangen. Auch werden die Arbeitsabläufe, wie sie im System vorgesehen sind, vorgestellt. + </p> <ul> <li><a href="/documentation/sessionmanagement/plan">Planung</a></li> <li><a href="/documentation/sessionmanagement/write">Protokollieren</a></li> <li><a href="/documentation/sessionmanagement/tracking">Nachverfolgung</a></li> </ul> + <p> Sollten die genannten Arbeitsabläufe nicht nachvollziehbar oder fehlerhaft sein, lasse die Entwickler der Software zur Behebung kontaktieren. + </p> <h4 id="suche">Suche</h4> - Einige Elemente der Sitzungsverwaltung sind durchsuchbar - dazu zählen <a href="{{url_for("list_protocols")}}">Protokolle</a>, <a href="{{url_for("list_todos")}}">Todos</a> und <a href="{{url_for("list_decisions")}}">Beschlüsse</a>. Auf jeder der Übersichtsseiten wird ein Suchfeld vorgehalten, das zur Eingabe genutzt werden kann. - - Im Suchfeld können mehrere durch Leerzeichen getrennte Suchbegriffe angegeben werden: <code>Begriff1 Begriff2</code>. - Angezeigt werden alle Ergebnisse, die jeden der Suchbegriffe (unabhängig von Groß- oder Kleinschreibung) enthalten. + <p> + Einige Elemente der Sitzungsverwaltung sind durchsuchbar - dazu zählen <a href="{{url_for("list_protocols")}}">Protokolle</a>, <a href="{{url_for("list_todos")}}">Todos</a> und <a href="{{url_for("list_decisions")}}">Beschlüsse</a>. Auf jeder der Übersichtsseiten wird ein Suchfeld vorgehalten, das zur Eingabe genutzt werden kann. + </p> + <p> + Im Suchfeld können mehrere durch Leerzeichen getrennte Suchbegriffe angegeben werden: <code>Begriff1 Begriff2</code>.<br/> + Angezeigt werden alle Ergebnisse, die jeden der Suchbegriffe (unabhängig von Groß- oder Kleinschreibung) enthalten.<br/> Wenn ein Suchbegriff ein Leerzeichen beinhaltet, muss er mit Anführungszeichen umrandet werden: <code>"Begriff1 mit Leerzeichen" Begriff2</code>. + </p> {% endblock %} diff --git a/templates/documentation.html b/templates/documentation.html index ebc20f4146d9036d9450e9442d7d1768281d4316..8c3d9695b762120aaf05983cb57ac8b9c3737874 100644 --- a/templates/documentation.html +++ b/templates/documentation.html @@ -4,10 +4,12 @@ {% block documentation_content %} <h3>Protokollsystem 3 - Das Protokollsystem</h3> + <p> Das Protokollsystem dient der Planung von Sitzungen und Verwaltung von Protokollen. Die anstehenden Sitzungen der nächsten Woche sind auf der <a href="{{url_for("index")}}">Startseite</a>, alle Protokolle unter <a href="{{url_for("list_protocols")}}">Protokolle</a> zu finden. - + </p> + <p> Des weiteren wird können die Sitzungen mittels Todos und einer Beschlussdatenbank nach verfolgt werden. Die eigenen offenen Todos werden auf der <a href="{{url_for("index")}}">Startseite</a> angezeigt, alle Todos sind unter <a href="{{url_for("list_todos")}}">Todos</a> zu finden. Die Beschlüsse finden sich in der <a href="{{url_for("list_decisions")}}">Beschlussdatenbank</a> zu finden. - + </p> <h3>Dokumentation</h3> Dieser Dokumentation können Beschreibungen zu nahezu allen wichtigen Systemfunktionen entnommen werden. Gegliedert sind die Themen wie folgt: <ul> @@ -28,9 +30,9 @@ <li><a href="/documentation/configuration/todomails">Todo Mails</a></li> </ul></li> </ul> - + <p> Sollten deine Fragen nach dem Studium der Dokumentation noch offen sein, wende dich an jemand erfahreneren oder die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a>. Offene Punkte innerhalb der Dokumentation können dann durch die Admins zur Behebung auch an die Entwickler der Software weitergegeben werden. - + </p> <h3 id="fehler">Fehlerbehandlung</h3> <ul> <li>Typische Web-Fehler (404, 500, etc.) sollten nicht auftreten. Wenn sie es doch tun, wende dich bitte an die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a></li> @@ -40,7 +42,9 @@ {% if git_revision %} <h3 id="version">Version</h4> - Dieses Protokollsystem nutzt die Software <a href="{{git_revision.url}}">„Protokollsystem 3“</a> in der Version vom <a href="{{git_revision.url}}/commit/{{git_revision.hash}}">{{git_revision.date|datify}}</a>. + <p> + Dieses Protokollsystem nutzt die Software <a href="{{git_revision.url}}">„Protokollsystem 3“</a> in der Version vom <a href="{{git_revision.url}}/commit/{{git_revision.hash}}">{{git_revision.date|datify}}</a>.<br/> Alle Änderungen, die seitdem hinzugekommen sind, kannst du <a href="{{git_revision.url}}/compare/{{git_revision.hash}}...master">hier</a> sehen. + </p> {% endif %} {% endblock %}