From b9ec68dce61b001ff2ea98c95506fc04c65f5bcb Mon Sep 17 00:00:00 2001
From: Robin Sonnabend <robin@fsmpi.rwth-aachen.de>
Date: Wed, 30 May 2018 16:19:48 +0200
Subject: [PATCH] Use url_for in documentation templates
---
...documentation-configuration-todomails.html | 2 +-
.../documentation-configuration-types.html | 4 +-
templates/documentation-configuration.html | 6 +-
.../documentation-sessionmanagement-plan.html | 252 +++++++++---------
...umentation-sessionmanagement-tracking.html | 8 +-
...documentation-sessionmanagement-write.html | 10 +-
.../documentation-sessionmanagement.html | 8 +-
templates/documentation-syntax-internal.html | 2 +-
templates/documentation-syntax-meta.html | 4 +-
templates/documentation-syntax-tags.html | 12 +-
templates/documentation-syntax-top.html | 6 +-
templates/documentation-syntax.html | 24 +-
templates/documentation.html | 64 ++---
13 files changed, 206 insertions(+), 196 deletions(-)
diff --git a/templates/documentation-configuration-todomails.html b/templates/documentation-configuration-todomails.html
index 8f26601..c862393 100644
--- a/templates/documentation-configuration-todomails.html
+++ b/templates/documentation-configuration-todomails.html
@@ -65,7 +65,7 @@
</div>
<div class="panel-body ">
<p>
- Das Versenden von E-Mails zu offenen Aufgaben ist hier bisher noch nicht vorgesehen. Um den automatischen E-Mailversand nutzen zu können, wende dich bitte an die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a> und lasse die <a href="/documentation/configuration/settings">Konfiguration</a> durch sie entsprechend anpassen.
+ Das Versenden von E-Mails zu offenen Aufgaben ist hier bisher noch nicht vorgesehen. Um den automatischen E-Mailversand nutzen zu können, wende dich bitte an die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a> und lasse die <a href="{{url_for("settings_configuration_documentation")}}">Konfiguration</a> durch sie entsprechend anpassen.
</p>
</div>
</div>
diff --git a/templates/documentation-configuration-types.html b/templates/documentation-configuration-types.html
index 693d3da..aefef37 100644
--- a/templates/documentation-configuration-types.html
+++ b/templates/documentation-configuration-types.html
@@ -5,7 +5,7 @@
{% block documentation_content %}
<h3>Einrichtung: Typen</h3>
<p>
- Damit Protokolle im Protokollsystem überhaupt <a href="/documentation/sessionmanagement/write">geschrieben</a> und <a href="/documentation/sessionmanagement/plan">Sitzungen verwaltet</a> werden können, ist es unerlässlich entsprechende Protokolltypen anzulegen. Auf der <a href="{{url_for('list_types')}}">Protokolltypen-Übersichtsseite</a> werden die Typen aufgelistet, wobei nur die Typen angezeigt werden, deren Protokolle man sehen darf (weiteres hierzu unter <a href="#rechte">Rechtekonfiguration</a>).
+ Damit Protokolle im Protokollsystem überhaupt <a href="{{url_for("write_sessionmanagement_documentation")}}">geschrieben</a> und <a href="{{url_for("plan_sessionmanagement_documentation")}}">Sitzungen verwaltet</a> werden können, ist es unerlässlich entsprechende Protokolltypen anzulegen. Auf der <a href="{{url_for('list_types')}}">Protokolltypen-Übersichtsseite</a> werden die Typen aufgelistet, wobei nur die Typen angezeigt werden, deren Protokolle man sehen darf (weiteres hierzu unter <a href="#rechte">Rechtekonfiguration</a>).
</p>
<div class="panel panel-default">
<div class="panel-heading">
@@ -455,7 +455,7 @@
</div>
</div>
<p>
- Die Konfiguration eines Metadatenfeldes beinhaltet immer den Anzeigenamen (Name) und den beim <a href="/documentation/syntax/meta">Protokollieren zu verwendenden Namen</a> des Feldes (Key). Des weiteren ist es möglich einen Standardwert für das Metadatenfelder zu hinterlegen, welcher beim Erstellen einer neuen Sitzung in das Feld geschrieben wird, so fern es als Planungsrelevant (vorher) markiert wurde. Zudem ist es möglich Metadaten nur in der internen Version eines Protokolls anzuzeigen, wenn das entsprechende Feld als intern festgelegt wurde.
+ Die Konfiguration eines Metadatenfeldes beinhaltet immer den Anzeigenamen (Name) und den beim <a href="{{url_for("meta_syntax_documentation")}}">Protokollieren zu verwendenden Namen</a> des Feldes (Key). Des weiteren ist es möglich einen Standardwert für das Metadatenfelder zu hinterlegen, welcher beim Erstellen einer neuen Sitzung in das Feld geschrieben wird, so fern es als Planungsrelevant (vorher) markiert wurde. Zudem ist es möglich Metadaten nur in der internen Version eines Protokolls anzuzeigen, wenn das entsprechende Feld als intern festgelegt wurde.
</p>
<div class="panel panel-default">
<div class="panel-heading">
diff --git a/templates/documentation-configuration.html b/templates/documentation-configuration.html
index 4de6fb2..32ec79e 100644
--- a/templates/documentation-configuration.html
+++ b/templates/documentation-configuration.html
@@ -8,10 +8,10 @@
Eine wichtige Eigenschaft des Protokollsystems ist die Konfigurierbarkeit. Das System lässt sich individuell auf die Bedürfnisse der eigenen Organisationseinheit anpassen. Einige Einstellungen können direkt über die Weboberfläche vorgenommen werden und stehen allen Benutzern zur Verfügung. Dazu gehören:
</p>
<ul>
- <li><a href="configuration/types">Protokolltypen</a></li>
- <li><a href="configuration/todomails">Todo-Mails</a></li>
+ <li><a href="{{url_for("types_configuration_documentation")}}">Protokolltypen</a></li>
+ <li><a href="{{url_for("todomails_configuration_documentation")}}">Todo-Mails</a></li>
</ul>
<p>
- Andere Einstellungen werden direkt bei der Installation und Einrichtung des Protokollsystems durch die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a> vorgenommen. Zu diesen <a href="configuration/settings">Systemeinstellungen</a> zählen unter anderem Features wie das automatische Versenden von E-Mails oder die Nutzung eines Etherpads zum Schreiben von Protokollen.
+ Andere Einstellungen werden direkt bei der Installation und Einrichtung des Protokollsystems durch die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a> vorgenommen. Zu diesen <a href="{{url_for("settings_configuration_documentation")}}">Systemeinstellungen</a> zählen unter anderem Features wie das automatische Versenden von E-Mails oder die Nutzung eines Etherpads zum Schreiben von Protokollen.
</p>
{% endblock %}
diff --git a/templates/documentation-sessionmanagement-plan.html b/templates/documentation-sessionmanagement-plan.html
index eabc083..78ec216 100644
--- a/templates/documentation-sessionmanagement-plan.html
+++ b/templates/documentation-sessionmanagement-plan.html
@@ -4,17 +4,17 @@
{% block documentation_content %}
<h3>Sitzungsverwaltung: Planung</h3>
- <p>
- Im Vorfeld einer Sitzung sollten verschiedene Tätigkeiten vorgenommen werden. Hierbei ist zu unterscheiden ob zu einem geplanten Sitzungstermin bereits ein Protokoll existiert oder nicht. Zu bereits existierenden und noch nicht geschriebenen Protokollen kann die Tagesordnung verwaltet werden.
- </p>
-
- <h4>Nicht existierendes Protokoll</h4>
- <p>
+ <p>
+ Im Vorfeld einer Sitzung sollten verschiedene Tätigkeiten vorgenommen werden. Hierbei ist zu unterscheiden ob zu einem geplanten Sitzungstermin bereits ein Protokoll existiert oder nicht. Zu bereits existierenden und noch nicht geschriebenen Protokollen kann die Tagesordnung verwaltet werden.
+ </p>
+
+ <h4>Nicht existierendes Protokoll</h4>
+ <p>
Versichere dich zuerst auf der <a href="{{url_for("list_protocols")}}">Protokollübersichtsseite</a>, dass das Protokoll nicht bereits existiert. Sollte das Protokoll noch nicht existieren, so führe die folgenden Schritte aus um es anzulegen.
- </p>
+ </p>
<ol>
<li>Gehe auf <a href="{{url_for("new_protocol")}}">Neues Protokoll</a>.</li>
- <li>Wähle bei „Typ“ den <a href="/documentation/configuration/types">Typ der Sitzung</a> aus.</li>
+ <li>Wähle bei „Typ“ den <a href="{{url_for("types_configuration_documentation")}}">Typ der Sitzung</a> aus.</li>
<li>Gib das Datum der Sitzung und ggf. einen Startzeitpunkt ein.</li>
<li>Klicke auf Anlegen.</li>
</ol>
@@ -45,13 +45,13 @@
</form>
</div>
</div>
-
- <h4 id="find">Existierendes Protokoll finden</h4>
+
+ <h4 id="find">Existierendes Protokoll finden</h4>
<p>
- Ist das Protokoll bereits angelegt, so kann es auf zwei verschiedenen Wegen gefunden werden. Zum einen über die Übersicht der nächsten Sitzungen auf der Startseite und zum anderen auf der Protokollübersichtsseite.
- <br/>
- Um ein Protokoll auf der Protokollübersichtsseite zu finden:
- </p>
+ Ist das Protokoll bereits angelegt, so kann es auf zwei verschiedenen Wegen gefunden werden. Zum einen über die Übersicht der nächsten Sitzungen auf der Startseite und zum anderen auf der Protokollübersichtsseite.
+ <br/>
+ Um ein Protokoll auf der Protokollübersichtsseite zu finden:
+ </p>
<ol>
<li>Gehe auf <a href="{{url_for("list_protocols")}}">Protokolle</a>,</li>
<li>Wähle die Sitzung aus - noch ausstehende Sitzungen sind ganz oben.</a>
@@ -99,155 +99,155 @@
<td class="hidden-sm hidden-md hidden-lg"><a href="#">Versammlung</a><br>11. März 2018</td>
<td class="hidden-xs"><a href="#example_protocoll_overview">Versammlung</a></td>
<td class="hidden-xs">11. März 2018</td>
- <td class="hidden-sm hidden-md hidden-lg"><span class="glyphicon glyphicon-pencil"></span></td>
+ <td class="hidden-sm hidden-md hidden-lg"><span class="glyphicon glyphicon-pencil"></span></td>
<td class="hidden-xs"><span class="glyphicon glyphicon-pencil"></span> Geplant</td>
<td class="">
- <div class="btn-group btn-group-xs">
- </div>
- </td>
+ <div class="btn-group btn-group-xs">
+ </div>
+ </td>
</tr>
<tr>
<td class="hidden-sm hidden-md hidden-lg"><a href="#">Sitzung</a><br>08. März 2018</td>
<td class="hidden-xs"><a href="#example_protocoll_overview">Sitzung</a></td>
<td class="hidden-xs">08. März 2018</td>
- <td class="hidden-sm hidden-md hidden-lg"><span class="glyphicon glyphicon-pencil"></span></td>
+ <td class="hidden-sm hidden-md hidden-lg"><span class="glyphicon glyphicon-pencil"></span></td>
<td class="hidden-xs"><span class="glyphicon glyphicon-pencil"></span> Geplant</td>
<td class="">
- <div class="btn-group btn-group-xs">
- </div>
- </td>
+ <div class="btn-group btn-group-xs">
+ </div>
+ </td>
</tr>
<tr>
<td class="hidden-sm hidden-md hidden-lg"><a href="#">Arbeitsgruppe</a><br>02. März 2018</td>
<td class="hidden-xs"><a href="#example_protocoll_overview">Arbeitsgruppe</a></td>
<td class="hidden-xs">02. März 2018</td>
<td class="hidden-sm hidden-md hidden-lg"><span class="glyphicon glyphicon-unchecked"></span></td>
- <td class="hidden-xs"><span class="glyphicon glyphicon-unchecked"></span> Fertig</td>
+ <td class="hidden-xs"><span class="glyphicon glyphicon-unchecked"></span> Fertig</td>
<td class="">
- <div class="btn-group btn-group-xs">
- <a href="#example_protocoll_overview" class="btn btn-success"><span class="glyphicon glyphicon-download"></span></a>
- </div>
- </td>
+ <div class="btn-group btn-group-xs">
+ <a href="#example_protocoll_overview" class="btn btn-success"><span class="glyphicon glyphicon-download"></span></a>
+ </div>
+ </td>
</tr>
<tr>
<td class="hidden-sm hidden-md hidden-lg"><a href="#">Sitzung</a><br>01. März 2018</td>
<td class="hidden-xs"><a href="#example_protocoll_overview">Sitzung</a></td>
<td class="hidden-xs">01. März 2018</td>
<td class="hidden-sm hidden-md hidden-lg"><span class="glyphicon glyphicon-unchecked"></span></td>
- <td class="hidden-xs"><span class="glyphicon glyphicon-unchecked"></span> Fertig</td>
+ <td class="hidden-xs"><span class="glyphicon glyphicon-unchecked"></span> Fertig</td>
<td class="">
- <div class="btn-group btn-group-xs">
- <a href="#example_protocoll_overview" class="btn btn-success"><span class="glyphicon glyphicon-download"></span></a>
- </div>
- </td>
+ <div class="btn-group btn-group-xs">
+ <a href="#example_protocoll_overview" class="btn btn-success"><span class="glyphicon glyphicon-download"></span></a>
+ </div>
+ </td>
</tr>
<tr>
<td class="hidden-sm hidden-md hidden-lg"><a href="#">Sitzung</a><br>22. Februar 2018</td>
<td class="hidden-xs"><a href="#example_protocoll_overview">Sitzung</a></td>
<td class="hidden-xs">22. Februar 2018</td>
<td class="hidden-sm hidden-md hidden-lg"><span class="glyphicon glyphicon-check"></span></td>
- <td class="hidden-xs"><span class="glyphicon glyphicon-check"></span> Veröffentlicht</td>
+ <td class="hidden-xs"><span class="glyphicon glyphicon-check"></span> Veröffentlicht</td>
<td class="">
- <div class="btn-group btn-group-xs">
- <a href="#example_protocoll_overview" class="btn btn-success"><span class="glyphicon glyphicon-download"></span></a>
- </div>
- </td>
+ <div class="btn-group btn-group-xs">
+ <a href="#example_protocoll_overview" class="btn btn-success"><span class="glyphicon glyphicon-download"></span></a>
+ </div>
+ </td>
</tr>
<tr>
<td class="hidden-sm hidden-md hidden-lg"><a href="#">Arbeitsgruppe</a><br>15. Februar 2018</td>
<td class="hidden-xs"><a href="#example_protocoll_overview">Arbeitsgruppe</a></td>
<td class="hidden-xs">15. Februar 2018</td>
<td class="hidden-sm hidden-md hidden-lg"><span class="glyphicon glyphicon-check"></span></td>
- <td class="hidden-xs"><span class="glyphicon glyphicon-check"></span> Veröffentlicht</td>
+ <td class="hidden-xs"><span class="glyphicon glyphicon-check"></span> Veröffentlicht</td>
<td class="">
- <div class="btn-group btn-group-xs">
- <a href="#example_protocoll_overview" class="btn btn-success"><span class="glyphicon glyphicon-download"></span></a>
- </div>
- </td>
+ <div class="btn-group btn-group-xs">
+ <a href="#example_protocoll_overview" class="btn btn-success"><span class="glyphicon glyphicon-download"></span></a>
+ </div>
+ </td>
</tr>
</tbody>
</table>
- <div align="center">
- <span class="glyphicon glyphicon-pencil"></span> Geplant,
- <span class="glyphicon glyphicon-unchecked"></span> Fertig,
- <span class="glyphicon glyphicon-check"></span> Veröffentlicht
- </div>
+ <div align="center">
+ <span class="glyphicon glyphicon-pencil"></span> Geplant,
+ <span class="glyphicon glyphicon-unchecked"></span> Fertig,
+ <span class="glyphicon glyphicon-check"></span> Veröffentlicht
+ </div>
</div>
</div>
-
- <h4 id="prepare">Existierendes Protokoll vorbereiten</h4>
- <p>
- Soll ein bereits existierendes Protokoll für die Sitzung vorbereitet oder angepasst werden, so ist das Protokoll entsprechend wie <a href="#find">oben</a> dargestellt aufzurufen. Auf der Seite der Sitzung werden neben verschiedenen sogenannten <a href="/documentation/configuration/types#meta">Metadaten</a>, wie Datum und Uhrzeit der Sitzung, auch die Tagesordnung dargestellt.
- <br/>
- Haben sich in den für die Sitzung angegebenen Metadaten Fehler eingeschlichen oder soll die Sitzung beispielsweise verschoben werden, so können diese Protokolldaten wie folgt bearbeitet und aktualisiert werden.
- </p>
- <ol>
+
+ <h4 id="prepare">Existierendes Protokoll vorbereiten</h4>
+ <p>
+ Soll ein bereits existierendes Protokoll für die Sitzung vorbereitet oder angepasst werden, so ist das Protokoll entsprechend wie <a href="#find">oben</a> dargestellt aufzurufen. Auf der Seite der Sitzung werden neben verschiedenen sogenannten <a href="{{url_for("types_configuration_documentation")}}#meta">Metadaten</a>, wie Datum und Uhrzeit der Sitzung, auch die Tagesordnung dargestellt.
+ <br/>
+ Haben sich in den für die Sitzung angegebenen Metadaten Fehler eingeschlichen oder soll die Sitzung beispielsweise verschoben werden, so können diese Protokolldaten wie folgt bearbeitet und aktualisiert werden.
+ </p>
+ <ol>
<li>Klicke auf Editieren.</li>
<li>Passe die Daten auf der neu geladenen Seite entsprechend an.</li>
<li>Speichere die Ändernungen durch das Klicken auf Ändern.</li>
</ol>
- <div class="panel panel-default">
+ <div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title"><a data-toggle="collapse" href="#example_update_protocoll">Beispiel - Protokolldaten aktualisieren</a></h5>
</div>
<ul id="example_update_protocoll" class="list-group panel-collapse collapse">
<li class="list-group-item">
- <div class="btn-group">
- {% if config.ETHERPAD_ACTIVE %}
- <a class="btn btn-primary" href="#example_update_protocoll">Aus Etherpad</a>
- {% endif %}
- <a class="btn btn-default" href="#example_update_protocoll">Editieren</a>
- {% if config.ETHERPAD_ACTIVE %}
- <a class="btn btn-primary" href="#example_update_protocoll" onclick="return confirm('Bist du dir sicher, dass du das Template bereits in das Etherpad kopieren willst? Die Sitzung ist erst einigen Tagen.');">Etherpad</a>
- {% endif %}
- <a class="btn btn-default" href="#example_update_protocoll">Vorlage</a>
- {% if config.MAIL_ACTIVE %}
- <a class="btn btn-default" href="#example_update_protocoll" onclick="return confirm('Bist du dir sicher, dass du manuell eine Einladung verschicken willst? Dies wird auch automatisch geschehen.');">Einladung versenden</a>
- {% endif %}
- <a class="btn btn-default" href="#example_update_protocoll">Typ</a>
- </div>
- </li>
- <li class="list-group-item">
- <form role="form" class="">
- <div class="form-group ">
- <label for="date" class="control-label"><label for="date">Datum</label></label>
- <input class="form-control" id="date" name="date" placeholder="Datum" title="" value="2018-03-14" type="date">
- </div>
- <div class="form-group ">
- <label for="start_time" class="control-label"><label for="start_time">Beginn (%H:%M)</label></label>
- <input class="form-control" id="start_time" name="start_time" placeholder="Beginn (%H:%M)" title="" value="17:00" type="text">
- </div>
- <div class="form-group ">
- <label for="end_time" class="control-label"><label for="end_time">Ende (%H:%M)</label></label>
- <input class="form-control" id="end_time" name="end_time" placeholder="Ende (%H:%M)" title="" value="" type="text">
- </div>
- <div class="checkbox ">
- <label>
- <input id="done" name="done" value="y" type="checkbox"> <label for="done">Fertig</label>
- </label>
- </div>
- <div id="done-description" style="display:none" class="field-description"></div>
- <div class="checkbox ">
- <label>
- <input id="public" name="public" value="y" type="checkbox"> <label for="public">Veröffentlicht</label>
- </label>
- </div>
- <div id="public-description" style="display:none" class="field-description"></div>
- <button type="button" class="btn btn-default">Ändern</button>
- </form>
- </li>
+ <div class="btn-group">
+ {% if config.ETHERPAD_ACTIVE %}
+ <a class="btn btn-primary" href="#example_update_protocoll">Aus Etherpad</a>
+ {% endif %}
+ <a class="btn btn-default" href="#example_update_protocoll">Editieren</a>
+ {% if config.ETHERPAD_ACTIVE %}
+ <a class="btn btn-primary" href="#example_update_protocoll" onclick="return confirm('Bist du dir sicher, dass du das Template bereits in das Etherpad kopieren willst? Die Sitzung ist erst einigen Tagen.');">Etherpad</a>
+ {% endif %}
+ <a class="btn btn-default" href="#example_update_protocoll">Vorlage</a>
+ {% if config.MAIL_ACTIVE %}
+ <a class="btn btn-default" href="#example_update_protocoll" onclick="return confirm('Bist du dir sicher, dass du manuell eine Einladung verschicken willst? Dies wird auch automatisch geschehen.');">Einladung versenden</a>
+ {% endif %}
+ <a class="btn btn-default" href="#example_update_protocoll">Typ</a>
+ </div>
+ </li>
+ <li class="list-group-item">
+ <form role="form" class="">
+ <div class="form-group ">
+ <label for="date" class="control-label"><label for="date">Datum</label></label>
+ <input class="form-control" id="date" name="date" placeholder="Datum" title="" value="2018-03-14" type="date">
+ </div>
+ <div class="form-group ">
+ <label for="start_time" class="control-label"><label for="start_time">Beginn (%H:%M)</label></label>
+ <input class="form-control" id="start_time" name="start_time" placeholder="Beginn (%H:%M)" title="" value="17:00" type="text">
+ </div>
+ <div class="form-group ">
+ <label for="end_time" class="control-label"><label for="end_time">Ende (%H:%M)</label></label>
+ <input class="form-control" id="end_time" name="end_time" placeholder="Ende (%H:%M)" title="" value="" type="text">
+ </div>
+ <div class="checkbox ">
+ <label>
+ <input id="done" name="done" value="y" type="checkbox"> <label for="done">Fertig</label>
+ </label>
+ </div>
+ <div id="done-description" style="display:none" class="field-description"></div>
+ <div class="checkbox ">
+ <label>
+ <input id="public" name="public" value="y" type="checkbox"> <label for="public">Veröffentlicht</label>
+ </label>
+ </div>
+ <div id="public-description" style="display:none" class="field-description"></div>
+ <button type="button" class="btn btn-default">Ändern</button>
+ </form>
+ </li>
</ul>
</div>
- <p>
- Für jede Sitzung kann auch die Tagesordnung individuell angepasst werden. Zwar gibt es einige Tagesordnungspunkte, die bereits durch den <a href="/documentation/configuration/types">Sitzungstyp</a> vorgegeben sind (sogenannte <a href="/documentation/configuration/types#tops">Standard-TOPs</a>), weitere Punkte können aber jeder Zeit hinzugefügt werden. Des weiteren besteht für jeden TOP die Möglichkeit durch sogenanntes Vorprotokollieren bereits bekannte Informationen zum TOP vor der Sitzung hinzuzufügen, wie bswp. einen schriftlichen Bericht.
- <br/>
- Bitte beachte weiterhin die folgenden Punkte beim Umgang mit Tagesordnungspunkten:</p>
+ <p>
+ Für jede Sitzung kann auch die Tagesordnung individuell angepasst werden. Zwar gibt es einige Tagesordnungspunkte, die bereits durch den <a href="{{url_for("types_configuration_documentation")}}">Sitzungstyp</a> vorgegeben sind (sogenannte <a href="{{url_for("types_configuration_documentation")}}#tops">Standard-TOPs</a>), weitere Punkte können aber jeder Zeit hinzugefügt werden. Des weiteren besteht für jeden TOP die Möglichkeit durch sogenanntes Vorprotokollieren bereits bekannte Informationen zum TOP vor der Sitzung hinzuzufügen, wie bswp. einen schriftlichen Bericht.
+ <br/>
+ Bitte beachte weiterhin die folgenden Punkte beim Umgang mit Tagesordnungspunkten:</p>
<ul>
- <li>Die ersten TOPs und ggf. die letztes TOPs sind <a href="/documentation/configuration/types#tops">Standard-TOPs</a> und daran zu erkennen, dass sie kursiv dargestellt sind. Diese werden durch den entsprechenden <a href="/documentation/configuration/types">Protokolltyp</a> definiert und sind bei jedem neu erstellten Protokoll automatisch vorhanden.</li>
+ <li>Die ersten TOPs und ggf. die letztes TOPs sind <a href="{{url_for("types_configuration_documentation")}}#tops">Standard-TOPs</a> und daran zu erkennen, dass sie kursiv dargestellt sind. Diese werden durch den entsprechenden <a href="{{url_for("types_configuration_documentation")}}">Protokolltyp</a> definiert und sind bei jedem neu erstellten Protokoll automatisch vorhanden.</li>
<li>Die anderen, nicht kursiv dargestellten TOPs gehören nur zu dieser Sitzung. Du kannst diese Punkte hinzufügen oder sie umsortieren.</li>
<li>Möchtest du zu einem TOP vorprotokollieren, so klicke auf ändern und füge unter "Beschreibung" deinen Inhalt ein (hier gilt die gleiche Syntax, wie im normalen Protokoll). Bitte beachte, dass das Vorprotokollieren nicht mehr möglich ist, wenn das Protokoll bereits {% if config.ETHERPAD_ACTIVE %}in ein Etherpad übertragen wurde{% else %}lokal geführt wird{% endif %}.</li>
- <li>Solltest du die TOPs nicht bearbeiten können, handelt es sich um ein Protokoll, das du lesen, aber nicht bearbeiten darfst. Mehr dazu findet sich im Abschnitt zur <a href="/documentation/configuration/types#rechte">Rechteverwaltung</a>.</li>
- </ul>
+ <li>Solltest du die TOPs nicht bearbeiten können, handelt es sich um ein Protokoll, das du lesen, aber nicht bearbeiten darfst. Mehr dazu findet sich im Abschnitt zur <a href="{{url_for("types_configuration_documentation")}}#rechte">Rechteverwaltung</a>.</li>
+ </ul>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title"><a data-toggle="collapse" href="#example_top_overview">Beispiel - Übersicht der Tagesordnung</a></h5>
@@ -299,26 +299,26 @@
<div id="example_edit_top" class="panel-body panel-collapse collapse">
<form role="form" class="">
<div class="form-group ">
- <label for="name" class="control-label"><label for="name">TOP</label></label>
- <input class="form-control" id="name" name="name" placeholder="TOP" title="" value="Änderungsbedarf" type="text">
- </div>
- <div class="form-group ">
- <label for="number" class="control-label"><label for="number">Sortierung</label></label>
- <input class="form-control" id="number" name="number" placeholder="Sortierung" title="" value="0" type="text">
- </div>
- <div class="form-group ">
- <label for="description" class="control-label"><label for="description">Beschreibung</label></label>
- <textarea class="form-control" id="description" name="description" placeholder="Beschreibung" textarea_rows="5" title="" style="min-height: 69px; overflow: hidden;">Hier steht der vorprotokolliert Text, der später beim ersten Erzeugen ins Protokoll übernommen aber beim Schreiben während der Sitzung noch angepasst werden kann.</textarea>
- </div>
- <button type="button" class="btn btn-default">Anlegen oder Ändern</button>
- </form>
+ <label for="name" class="control-label"><label for="name">TOP</label></label>
+ <input class="form-control" id="name" name="name" placeholder="TOP" title="" value="Änderungsbedarf" type="text">
+ </div>
+ <div class="form-group ">
+ <label for="number" class="control-label"><label for="number">Sortierung</label></label>
+ <input class="form-control" id="number" name="number" placeholder="Sortierung" title="" value="0" type="text">
+ </div>
+ <div class="form-group ">
+ <label for="description" class="control-label"><label for="description">Beschreibung</label></label>
+ <textarea class="form-control" id="description" name="description" placeholder="Beschreibung" textarea_rows="5" title="" style="min-height: 69px; overflow: hidden;">Hier steht der vorprotokolliert Text, der später beim ersten Erzeugen ins Protokoll übernommen aber beim Schreiben während der Sitzung noch angepasst werden kann.</textarea>
+ </div>
+ <button type="button" class="btn btn-default">Anlegen oder Ändern</button>
+ </form>
</div>
</div>
- <p>
- Im Einsatz des Protokollsystem hat sich bereits gezeigt, dass die folgenden Ratschläge dazubeitragen können, bereits aus der Tagesordnung zu erkennen, was behandelt werden soll.
- </p>
- <ul>
- <li>Jedes selbstständige Thema oder jeder Antrag sollte in einen eigenen TOP geschrieben werden. Sammel-TOPs, oder TOPs mit allen finanzwirksamen Anträgen sorgen für wenig Übersichtlichkeit.</li>
- <li>Es ist wünschenswert, dass TOPs so früh wie möglich auf die Tagesordnung geschrieben werden und unter "Beschreibung" kurz erläutert wird, worum es gehen soll. Sollte es in dem TOP darum gehen, dass Geld beantragt wird, sollte der TOP im Namen entsprechend gekennzeichnet werden.</li>
+ <p>
+ Im Einsatz des Protokollsystem hat sich bereits gezeigt, dass die folgenden Ratschläge dazubeitragen können, bereits aus der Tagesordnung zu erkennen, was behandelt werden soll.
+ </p>
+ <ul>
+ <li>Jedes selbstständige Thema oder jeder Antrag sollte in einen eigenen TOP geschrieben werden. Sammel-TOPs, oder TOPs mit allen finanzwirksamen Anträgen sorgen für wenig Übersichtlichkeit.</li>
+ <li>Es ist wünschenswert, dass TOPs so früh wie möglich auf die Tagesordnung geschrieben werden und unter „Beschreibung“ kurz erläutert wird, worum es gehen soll. Sollte es in dem TOP darum gehen, dass Geld beantragt wird, sollte der TOP im Namen entsprechend gekennzeichnet werden.</li>
</ul>
{% endblock %}
diff --git a/templates/documentation-sessionmanagement-tracking.html b/templates/documentation-sessionmanagement-tracking.html
index f553391..1247ebd 100644
--- a/templates/documentation-sessionmanagement-tracking.html
+++ b/templates/documentation-sessionmanagement-tracking.html
@@ -10,11 +10,11 @@
<h4 id="decisions">Beschlüsse</h4>
<p>
- Alle in den Protollen festgehaltenen Beschlüsse werden in der <a href="{{url_for('list_decisions')}}">Beschlussübersicht</a> angezeigt. Neben dem Beschlusstext beinhaltet die Übersicht die zu den Beschlüssen gehörenden Protokoll sowie die <a href="/documentation/configuration/types#decision_categories">Beschlusskategorie</a>. In den einzelnen Protokollen werdend die Beschlüsse ebenfalls zusammengefasst dargestellt, um einen Überbrlick über alle Beschlüsse der betrefenden Sitzung zu erhalten.
+ Alle in den Protollen festgehaltenen Beschlüsse werden in der <a href="{{url_for('list_decisions')}}">Beschlussübersicht</a> angezeigt. Neben dem Beschlusstext beinhaltet die Übersicht die zu den Beschlüssen gehörenden Protokoll sowie die <a href="{{url_for("types_configuration_documentation")}}#decision_categories">Beschlusskategorie</a>. In den einzelnen Protokollen werdend die Beschlüsse ebenfalls zusammengefasst dargestellt, um einen Überbrlick über alle Beschlüsse der betrefenden Sitzung zu erhalten.
</p>
{% if config.PRINTING_ACTIVE %}
<p>
- Beschlüsse können direkt aus dem Protokollsystem an den im <a href="/documentation/configuration/types">Protokolltyp</a> hinterlegten Drucker durch klicken auf „Drucken“ zum Drucken gesendet werden, so dass gedruckte Beschlüsse beispielsweise mit Kassenanweisungen abgeheftet werden können.
+ Beschlüsse können direkt aus dem Protokollsystem an den im <a href="{{url_for("types_configuration_documentation")}}">Protokolltyp</a> hinterlegten Drucker durch klicken auf „Drucken“ zum Drucken gesendet werden, so dass gedruckte Beschlüsse beispielsweise mit Kassenanweisungen abgeheftet werden können.
</p>
{% endif %}
<div class="panel panel-default">
@@ -79,7 +79,7 @@
<h4 id="todos">Aufgaben (Todos)</h4>
<p>
- Einzelne Aufgaben, die während oder außerhalb einer Sitzung vergeben werden, können mit dem Protokollsystem über mehrere Protokolle hinweg verwaltet werden. Offene Todos werden dabei automatisch in die Protokollvorlage eingefügt, falls diese einen <a href="/documentation/configuration/types">Standard-TOP</a> „Todos“ beinhaltet. Darüberhinaus können alle Todos auf der entsprechenden <a href="{{url_for('list_todos')}}">Übersichtsseite</a> eingesehen werden.
+ Einzelne Aufgaben, die während oder außerhalb einer Sitzung vergeben werden, können mit dem Protokollsystem über mehrere Protokolle hinweg verwaltet werden. Offene Todos werden dabei automatisch in die Protokollvorlage eingefügt, falls diese einen <a href="{{url_for("types_configuration_documentation")}}">Standard-TOP</a> „Todos“ beinhaltet. Darüberhinaus können alle Todos auf der entsprechenden <a href="{{url_for('list_todos')}}">Übersichtsseite</a> eingesehen werden.
</p>
<div class="panel panel-default">
<div class="panel-heading">
@@ -144,7 +144,7 @@
</div>
</div>
<p>
- Aufgaben können im Protokollsystem auch außerhalb eines Protokolls direkt auf der <a href="{{url_for('list_todos')}}">Übersichtsseite</a> über die Schaltfläche „neu“ angelegt werden. Zu jeder Aufgabe sollte mindestens eine Person zugeordnet werden, die das Todo erledigt. Werden mehrere Personen angegeben, so sind diese durch Kommata oder Leerzeichen zu trennen. In aller Regel wird für jede Person ein internes Personenkürzel für die Zuweisung einer Aufgabe genutzt. Damit diese Personen eine Benachrichtigung über das neue Todo erhalten, sollten zu jedem internen Personenkürzel eine <a href="/documentation/configuration/todomails">E-Mailadresse</a> hinterlegt werden.
+ Aufgaben können im Protokollsystem auch außerhalb eines Protokolls direkt auf der <a href="{{url_for('list_todos')}}">Übersichtsseite</a> über die Schaltfläche „neu“ angelegt werden. Zu jeder Aufgabe sollte mindestens eine Person zugeordnet werden, die das Todo erledigt. Werden mehrere Personen angegeben, so sind diese durch Kommata oder Leerzeichen zu trennen. In aller Regel wird für jede Person ein internes Personenkürzel für die Zuweisung einer Aufgabe genutzt. Damit diese Personen eine Benachrichtigung über das neue Todo erhalten, sollten zu jedem internen Personenkürzel eine <a href="{{url_for("todomails_configuration_documentation")}}">E-Mailadresse</a> hinterlegt werden.
</p>
<div class="panel panel-default">
<div class="panel-heading">
diff --git a/templates/documentation-sessionmanagement-write.html b/templates/documentation-sessionmanagement-write.html
index f329d1c..dcd781e 100644
--- a/templates/documentation-sessionmanagement-write.html
+++ b/templates/documentation-sessionmanagement-write.html
@@ -18,7 +18,7 @@
<h4 id="session_start">Mit Beginn einer Sitzung</h4>
<p>
- Kurz bevor die Sitzung los geht oder mit dem Beginn der Sitzung wird das Protokoll erzeugt und die offenen <a href="/documentation/syntax/meta">Metadaten</a> ausgefüllt. Um dies zu erreichen werden die folgenden Schritte durchgeführt.
+ Kurz bevor die Sitzung los geht oder mit dem Beginn der Sitzung wird das Protokoll erzeugt und die offenen <a href="{{url_for("meta_syntax_documentation")}}">Metadaten</a> ausgefüllt. Um dies zu erreichen werden die folgenden Schritte durchgeführt.
</p>
<ol>
<li>Stelle sicher, dass alle mit dem Vorprotokollieren fertig sind.</li>
@@ -58,10 +58,10 @@
{% if config.ETHERPAD_ACTIVE %}
<li>Schreibe das Protokoll im Etherpad.</li>
{% endif %}
- <li>Fülle alle benötigten <a href="/documentation/syntax/meta">Metadatenfelder</a>.</li>
- <li>Falls <a href="/documentation/syntax/tags#todo">Todos</a> erledigt sind, markiere diese als erledigt.</li>
- <li>Erfasse Beschlüsse die während einer Sitzung getroffen werden mit dem <a href="/documentation/syntax/tags#decision">Beschluss-Tag</a>.</li>
- <li>Nutze auch die anderen <a href="/documentation/syntax/tags">Tags</a>, wo diese erforderlich sind.</li>
+ <li>Fülle alle benötigten <a href="{{url_for("meta_syntax_documentation")}}">Metadatenfelder</a>.</li>
+ <li>Falls <a href="{{url_for("tags_syntax_documentation")}}#todo">Todos</a> erledigt sind, markiere diese als erledigt.</li>
+ <li>Erfasse Beschlüsse die während einer Sitzung getroffen werden mit dem <a href="{{url_for("tags_syntax_documentation")}}#decision">Beschluss-Tag</a>.</li>
+ <li>Nutze auch die anderen <a href="{{url_for("tags_syntax_documentation")}}">Tags</a>, wo diese erforderlich sind.</li>
</ul>
<div class="panel panel-default">
<div class="panel-heading">
diff --git a/templates/documentation-sessionmanagement.html b/templates/documentation-sessionmanagement.html
index 3509388..880f60c 100644
--- a/templates/documentation-sessionmanagement.html
+++ b/templates/documentation-sessionmanagement.html
@@ -5,16 +5,16 @@
{% 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> von Ergebnissen ist im System in Form von Beschlüssen und Todos möglich.
+ Ein wesentlicher Bestandteil des Protokollsystems ist das Sitzungsmanagement. Neben dem <a href="{{url_for("plan_sessionmanagement_documentation")}}">Planen und Anlegen</a> verschiedener Sitzungstermine kann zu jeder Sitzung ein <a href="{{url_for("write_sessionmanagement_documentation")}}">Protokoll</a> verfasst und anschließend durch das System ausgegeben werden. Die <a href="{{url_for("tracking_sessionmanagement_documentation")}}">Nachverfolgung</a> von Ergebnissen ist im System in Form von Beschlüssen und Todos möglich.
</p>
<h4>Verwaltung im Detail</h4>
<p>
Die einzelnen Funktionen des Sitzungsmanagements werden jeweils auf Unterseiten erläutert. 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>
+ <li><a href="{{url_for("plan_sessionmanagement_documentation")}}">Planung</a></li>
+ <li><a href="{{url_for("write_sessionmanagement_documentation")}}">Protokollieren</a></li>
+ <li><a href="{{url_for("tracking_sessionmanagement_documentation")}}">Nachverfolgung</a></li>
</ul>
<p>
Sollten die genannten Arbeitsabläufe nicht nachvollziehbar oder fehlerhaft sein, dann kontaktiere bitte das Entwicklungsteam der Software. Als Tipp: Je genauer du ein Problem beschreiben kannst, desto einfacher machst du es den betroffenen Personen selbiges zu fixen und desto schneller hast du eine Lösung.
diff --git a/templates/documentation-syntax-internal.html b/templates/documentation-syntax-internal.html
index eca91c5..ea2a11e 100644
--- a/templates/documentation-syntax-internal.html
+++ b/templates/documentation-syntax-internal.html
@@ -55,7 +55,7 @@
</div>
<div class="panel-body ">
<p>
- Die Verwendung von internen Abschnitte ist hier bisher noch nicht vorgesehen. Um interne Abschnitte nutzen zu können, wende dich bitte an die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a> und lasse die <a href="/documentation/configuration/settings">Konfiguration</a> durch sie entsprechend anpassen.
+ Die Verwendung von internen Abschnitte ist hier bisher noch nicht vorgesehen. Um interne Abschnitte nutzen zu können, wende dich bitte an die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a> und lasse die <a href="{{url_for("settings_configuration_documentation")}}">Konfiguration</a> durch sie entsprechend anpassen.
</p>
</div>
</div>
diff --git a/templates/documentation-syntax-meta.html b/templates/documentation-syntax-meta.html
index b69b512..a710e1a 100644
--- a/templates/documentation-syntax-meta.html
+++ b/templates/documentation-syntax-meta.html
@@ -5,7 +5,7 @@
{% block documentation_content %}
<h3>Syntax: Metadaten</h3>
<p>
- In einem Protokoll repräsentieren die Metadaten allgemeine Informationen rund um eine Sitzung. Die Metadaten stehen immer am Anfang eines Protokolls. Zu den Metadaten zählen das Datum der Sitzung, der Beginn und das Ende sowie weitere pro <a href="/documentation/configuration/types">Protokolltyp</a> konfigurierte <a href="/documentation/configuration/types#meta">Metadatenfelder</a>, wie beispielsweise der Ort, die Anwesenden oder die Protokollführung. Alle <a href="/documentation/configuration/types#meta">Metadatenfelder</a> werden beim Erzeugen der Protokollvorlage durch das System automatisch in das Protokoll übertragen. Dies schließt auch den Inhalt der Felder ein, so weit dieser vor <a href="/documentation/sessionmanagement/plan">Beginn der Sitzung</a> eingegeben wurde.
+ In einem Protokoll repräsentieren die Metadaten allgemeine Informationen rund um eine Sitzung. Die Metadaten stehen immer am Anfang eines Protokolls. Zu den Metadaten zählen das Datum der Sitzung, der Beginn und das Ende sowie weitere pro <a href="{{url_for("types_configuration_documentation")}}">Protokolltyp</a> konfigurierte <a href="{{url_for("types_configuration_documentation")}}#meta">Metadatenfelder</a>, wie beispielsweise der Ort, die Anwesenden oder die Protokollführung. Alle <a href="{{url_for("types_configuration_documentation")}}#meta">Metadatenfelder</a> werden beim Erzeugen der Protokollvorlage durch das System automatisch in das Protokoll übertragen. Dies schließt auch den Inhalt der Felder ein, so weit dieser vor <a href="{{url_for("plan_sessionmanagement_documentation")}}">Beginn der Sitzung</a> eingegeben wurde.
</p>
<h4>Definition</h4>
<p>
@@ -17,6 +17,6 @@
<li><code class="highlight" style="color: inherit;"><span class="nc">#Ende</span>;<span class="mi">21:42</span></code> Ende der Sitzung</li>
</ul>
<p>
- Wurden <a href="/documentation/configuration/types#meta">Metadatenfelder</a> im <a href="/documentation/configuration/types">Protokolltyp</a> konfigurierte so muss als <code class="highlight" style="color: inherit;"><span class="nc">Name</span></code> der festgelegte Key verwendet werden. Dabei muss die Groß- und Kleinschreibung beachtet werden.
+ Wurden <a href="{{url_for("types_configuration_documentation")}}#meta">Metadatenfelder</a> im <a href="{{url_for("types_configuration_documentation")}}">Protokolltyp</a> konfigurierte so muss als <code class="highlight" style="color: inherit;"><span class="nc">Name</span></code> der festgelegte Key verwendet werden. Dabei muss die Groß- und Kleinschreibung beachtet werden.
</p>
{% endblock %}
diff --git a/templates/documentation-syntax-tags.html b/templates/documentation-syntax-tags.html
index 4e0b41c..2d82715 100644
--- a/templates/documentation-syntax-tags.html
+++ b/templates/documentation-syntax-tags.html
@@ -72,7 +72,7 @@
</div>
{% endif %}
<p>
- Ein Beschluss kann mit <a href="/documentation/configuration/types#decision_categories">Beschlusskategorien</a> versehen werden, um Beschlüsse zu einzelnen Themen zusammenfassen zu können. Des Versehen mit Kategorien ist jedoch kein muss. <a href="/documentation/configuration/types#decision_categories">Kategorien</a> müssen vor der Verwendung in den Einstellungen des Protokolltyps definiert werden. Danach können Beschlüsse durch die Angabe der Kategorie entsprechend zugeordnet werden, z.B. <code class="highlight" style="color: inherit;"><span class="nt">[</span>…;<span class="sx">finanzwirksam</span>;…<span class="nt">]</span></code>.
+ Ein Beschluss kann mit <a href="{{url_for("types_configuration_documentation")}}#decision_categories">Beschlusskategorien</a> versehen werden, um Beschlüsse zu einzelnen Themen zusammenfassen zu können. Des Versehen mit Kategorien ist jedoch kein muss. <a href="{{url_for("types_configuration_documentation")}}#decision_categories">Kategorien</a> müssen vor der Verwendung in den Einstellungen des Protokolltyps definiert werden. Danach können Beschlüsse durch die Angabe der Kategorie entsprechend zugeordnet werden, z.B. <code class="highlight" style="color: inherit;"><span class="nt">[</span>…;<span class="sx">finanzwirksam</span>;…<span class="nt">]</span></code>.
</p>
<p>
Es empfiehlt sich Beschlüsse klar, einfach, eindeutig und auch kontextlos verständlich zu formulieren. Sind die Beschlüsse im Rahmen einer Abstimmung ergangen, so empfiehlt es sich das Abstimmungsergebnis am Ende des Beschlusses in der Form (Ja/Nein/Enthaltung) anzugeben.
@@ -88,7 +88,7 @@
<h4 id="todo">Todo-Tag</h4>
<p>
- Soll in einer Sitzung die Vergebene einer <a href="/documentation/sessionmanagement/tracking#todos">Aufgabe</a> an eine oder mehrere Personen (oder AG, AK, …) festgehalten werden, so kann mittels des Tags <code class="highlight" style="color: inherit;"><span class="nt">todo</span></code> diese Aufgabe im Protokoll festgehalten werden. Neben dem Namen der Person, welche die Aufgabe erledigen möchte, wird die Aufgabe innerhalb des Tags festgehalten. Die Aufgabe ist nach der Sitzung in der <a href="{{url_for('list_todos')}}">Todo-Übersicht</a> und nur im internen Protokoll einsehbar.
+ Soll in einer Sitzung die Vergabe einer <a href="{{url_for("tracking_sessionmanagement_documentation")}}#todos">Aufgabe</a> an eine oder mehrere Personen (oder AG, AK, …) festgehalten werden, so kann mittels des Tags <code class="highlight" style="color: inherit;"><span class="nt">todo</span></code> diese Aufgabe im Protokoll festgehalten werden. Neben dem Namen der Person, welche die Aufgabe erledigen möchte, wird die Aufgabe innerhalb des Tags festgehalten. Die Aufgabe ist nach der Sitzung in der <a href="{{url_for('list_todos')}}">Todo-Übersicht</a> und nur im internen Protokoll einsehbar.
</p>
<figure>
<pre class="highlight"><code><span class="nt">[todo</span>;<span class="sx">Name</span>;<span class="sx">Aufgabe</span>;<span class="sx">Argument 1</span>;<span class="sx">Argument 2</span>;…<span class="nt">]</span></code></pre>
@@ -100,7 +100,7 @@
Eine bereits bestehende und noch offene Aufgabe wird automatisch in ein neues Protokoll eingefügt, wenn der TOP „Todos“ auf der Tagesordnung steht (der TOP also im Protokoll enthalten ist). Zusätzlich erhält die Aufgabe dann als optionales Argument eine ID: <code class="highlight" style="color: inherit;"><span class="nt">[</span>…;<span class="kr">id</span> <span class="mi">1338</span><span class="nt">]</span></code>. Wird dieser Todo dann während des Protokollierens geändert, passiert das auch im Protokollsystem.
</p>
<p>
- In einem weiteren optionalen Argument kann außerdem der Status einer Aufgabe, z.B. <code class="highlight" style="color: inherit;"><span class="nt">[</span>…;<span class="kr">done</span>;…<span class="nt">]</span></code> angegeben werden. Die Groß- und Kleinschreibung spielen bei der Verwendung keine Rolle. Wenn der Status ein Datum benötigt, muss dieser immer mit angegeben und hat die Form: <code class="highlight" style="color: inherit;"><span class="nt">[</span>…;<span class="mi">dd.mm.yyyy</span>;…<span class="nt">]</span></code>. Bei der Angabe des Datums ist es unerheblich, an welcher Stelle innerhalb des Tags es auftacht. Eine Auflistung der verwendbaren Status-Begriffe und ob Status ein Datum benötigt, ist in der folgenden Tabelle angegeben.
+ In einem weiteren optionalen Argument kann außerdem der Status einer Aufgabe, z.B. <code class="highlight" style="color: inherit;"><span class="nt">[</span>…;<span class="kr">done</span>;…<span class="nt">]</span></code> angegeben werden. Die Groß- und Kleinschreibung spielen bei der Verwendung keine Rolle. Wenn der Status ein Datum benötigt, muss dieses immer mit angegeben werden und hat die Form: <code class="highlight" style="color: inherit;"><span class="nt">[</span>…;<span class="mi">dd.mm.yyyy</span>;…<span class="nt">]</span></code>. Bei der Angabe des Datums ist es unerheblich, an welcher Stelle innerhalb des Tags es auftaucht. Eine Auflistung der verwendbaren Status-Begriffe und ob Status ein Datum benötigt, ist in der folgenden Tabelle angegeben.
</p>
<table class="table table-striped">
<thead>
@@ -111,11 +111,11 @@
</tr>
</thead>
<tbody>
- {% for state, posibilities in states.items() %}
+ {% for state, possibilities in states.items() %}
<tr>
<td>{{state.get_name()}}</td>
<td><span class="glyphicon glyphicon-{% if state.needs_date() %}ok{% else %}remove{% endif %}" aria-hidden="true"></span></td>
- <td>{{posibilities|map("code_key")|join(", ")|safe}}</td>
+ <td>{{possibilities|map("code_key")|join(", ")|safe}}</td>
</tr>
{% endfor %}
</tbody>
@@ -141,7 +141,7 @@
<h4 id="session">Sitzungs-Tag</h4>
<p>
- Werden während einer Sitzung bereits Termine für zukünfigt Sitzungen desselben Typs festgelegt, so können diese direkt aus dem Protokoll heraus angelegt und im Protokoll entsprechend hervorgehoben werden. Es wird der Tag des Types <code class="highlight" style="color: inherit;"><span class="nt">sitzung</span></code> genutzt. Als Argument muss mindestens das Datum übergeben werden und es hat die Form: <code class="highlight" style="color: inherit;"><span class="nt">[</span>…;<span class="mi">dd.mm.yyyy</span>;…<span class="nt">]</span></code>. Optional kann zusätzlich eine Uhrzeit in folgender Form angegeben werden: <code class="highlight" style="color: inherit;"><span class="nt">[</span>…;<span class="mi">h:mm</span><span class="nt">]</span></code>.
+ Werden während einer Sitzung bereits Termine für zukünfige Sitzungen desselben Typs festgelegt, so können diese direkt aus dem Protokoll heraus angelegt und im Protokoll entsprechend hervorgehoben werden. Es wird der Tag des Types <code class="highlight" style="color: inherit;"><span class="nt">sitzung</span></code> genutzt. Als Argument muss mindestens das Datum übergeben werden und es hat die Form: <code class="highlight" style="color: inherit;"><span class="nt">[</span>…;<span class="mi">dd.mm.yyyy</span>;…<span class="nt">]</span></code>. Optional kann zusätzlich eine Uhrzeit in folgender Form angegeben werden: <code class="highlight" style="color: inherit;"><span class="nt">[</span>…;<span class="mi">h:mm</span><span class="nt">]</span></code>.
</p>
<figure>
<pre class="highlight"><code><span class="nt">[sitzung</span>;<span class="mi">Datum</span>;<span class="mi">Uhrzeit</span><span class="nt">]</span></code></pre>
diff --git a/templates/documentation-syntax-top.html b/templates/documentation-syntax-top.html
index f94a09f..90a5a20 100644
--- a/templates/documentation-syntax-top.html
+++ b/templates/documentation-syntax-top.html
@@ -5,16 +5,16 @@
{% block documentation_content %}
<h3>Syntax: Tagesordnungspunkte</h3>
<p>
- Ein wichtiges Elements in jedem Protokoll sind Tagesordnungspunkte. Sie sind in einem Protokoll stehts die oberste Gliederungsebene. In den meisten Fällen stehen diese Punkte bereits vor Beginn der Sitzung fest und wurden entsprechend vorher <a href="/documentation/sessionmanagement/plan#prepare">eingepflegt</a>.
+ Ein wichtiges Elements in jedem Protokoll sind Tagesordnungspunkte. Sie sind in einem Protokoll stehts die oberste Gliederungsebene. In den meisten Fällen stehen diese Punkte bereits vor Beginn der Sitzung fest und wurden entsprechend vorher <a href="{{url_for("plan_sessionmanagement_documentation")}}#prepare">eingepflegt</a>.
</p>
<p>
- Beim Erstellen der Protokollvorlage durch das System werden die bereits <a href="/documentation/sessionmanagement/plan#prepare">angelegten TOPs</a> mit dem vorprotokollierten Inhalt in der Tagesordnung festgelegten Reihenfolge übertragen. Während des Schreibens des Protokolls können jeder Zeit Tagesordnungspunkte hinzugefügt oder entfernt werden.
+ Beim Erstellen der Protokollvorlage durch das System werden die bereits <a href="{{url_for("plan_sessionmanagement_documentation")}}#prepare">angelegten TOPs</a> mit dem vorprotokollierten Inhalt in der Tagesordnung festgelegten Reihenfolge übertragen. Während des Schreibens des Protokolls können jeder Zeit Tagesordnungspunkte hinzugefügt oder entfernt werden.
</p>
<h4>Definition</h4>
<div class="row">
<div class="col-sm-9">
<p>
- In Protokollsystax wird ein Tagesordnungspunkt stets von geschweiften Klammern eingeschlossen. An die öffnende Klammer schließt sich das Schlüsselwort <code>TOP</code> an. Abgesetzt mit einem Leerzeichen folgt der Titel des TOPs. Nach einem Zeilenumbruach als in einer neuen Zeile beginnt dann der Inhalt des Tagesordnungspunkts. Durch die Verwendung von sogenannten <a href="lists">Listen</a> kann die Mitschrift in einem Tagesordnungspunkt strukturiert werden.
+ In Protokollsystax wird ein Tagesordnungspunkt stets von geschweiften Klammern eingeschlossen. An die öffnende Klammer schließt sich das Schlüsselwort <code>TOP</code> an. Abgesetzt mit einem Leerzeichen folgt der Titel des TOPs. Nach einem Zeilenumbruch als in einer neuen Zeile beginnt dann der Inhalt des Tagesordnungspunkts. Durch die Verwendung von sogenannten <a href="lists">Listen</a> kann die Mitschrift in einem Tagesordnungspunkt strukturiert werden.
</p>
<div class="panel panel-default">
<div class="panel-heading">
diff --git a/templates/documentation-syntax.html b/templates/documentation-syntax.html
index 5a15a45..e4b5700 100644
--- a/templates/documentation-syntax.html
+++ b/templates/documentation-syntax.html
@@ -5,7 +5,7 @@
{% block documentation_content %}
<h3>Syntax</h3>
<p>
- Das Herz des Protokollsystems ist die eigentliche Protokollsyntax, aus dem systemintern ein druckbares Dokument und menschenlesbarer Webseiteninhalt erstellt wird. Die Systax sieht eine Strukturierung des Prokolls vor. Ein Dokument beginn mit einigen Metadaten, danach kommen nacheinander die Tagesordnungspunkte, die strukturiert diskuiterte Punkte enthalten. Darüberhinaus gibt es Tags, mit denen unter anderem URLs, Beschlüsse oder ToDos markiert werden können.
+ Das Herz des Protokollsystems ist die eigentliche Protokollsyntax, aus dem systemintern ein druckbares Dokument und menschenlesbarer Webseiteninhalt erstellt wird. Die Systax sieht eine Strukturierung des Protokolls vor. Ein Dokument beginn mit einigen Metadaten, danach kommen nacheinander die Tagesordnungspunkte, die strukturiert diskutierte Punkte enthalten. Darüberhinaus gibt es Tags, mit denen unter anderem URLs, Beschlüsse oder ToDos markiert werden können.
</p>
<h4>Allgemeine Grundsätze</h4>
<p>
@@ -14,17 +14,27 @@
<ul>
<li>Jede geschweifte oder eckige Klammer die aufgemacht wird, wird sofort wieder geschlossen und anschließend der Inhalt zwischen die Klammern geschrieben.</li>
<li>Jeder Zeilenumbruch erzeugt eine neue Zeile im Protokoll.</li>
- <li>Beachte die geschützten Begriffe: <code class="highlight" style="color: inherit;"><span class="nc">#Datum</span></code> <code class="highlight" style="color: inherit;"><span class="nc">#Beginn</span></code> <code class="highlight" style="color: inherit;"><span class="nc">#Ende</span></code> <code class="highlight" style="color: inherit;"><span class="kr">TOP</span></code> <code class="highlight" style="color: inherit;"><span class="kr">private</span></code> <code class="highlight" style="color: inherit;"><span class="kr">todo</span></code> <code class="highlight" style="color: inherit;"><span class="kr">id</span></code> <code class="highlight" style="color: inherit;"><span class="kr">beschluss</span></code> <code class="highlight" style="color: inherit;"><span class="kr">url</span></code> <code class="highlight" style="color: inherit;"><span class="kr">footnote</span></code> <code class="highlight" style="color: inherit;"><span class="kr">sitzung</span></code></li>
+ <li>Beachte die geschützten Begriffe:
+ {% for term in ["#Datum", "#Beginn", "#Ende"] %}
+ <code class="highlight" style="color: inherit;">
+ <span class="nc">{{term}}</span>
+ </code>
+ {% endfor %}
+ {% for term in ["TOP", "private", "todo", "id", "beschluss", "url", "footnote", "sitzung"] %}
+ <code class="highlight" style="color: inherit;">
+ <span class="kr">{{term}}</span>
+ </code>
+ {% endfor %}
</ul>
<h4>Der Syntax im Detail</h4>
<p>
Um die Funktionsweise und das Verhalten des Protokollsystems bei der Umwandlung eines Protokolls zu verstehen, wird auf den Unterseiten auf die einzelnen Elemente der Protokollsyntax näher eingegangen.
</p>
<ul>
- <li><a href="/documentation/syntax/meta">Metadaten</a></li>
- <li><a href="/documentation/syntax/top">Tagesordnungspunkte</a></li>
- <li><a href="/documentation/syntax/lists">Listen</a></li>
- <li><a href="/documentation/syntax/internal">Interne Abschnitte</a></li>
- <li><a href="/documentation/syntax/tags">Tags</a></li>
+ <li><a href="{{url_for("meta_syntax_documentation")}}">Metadaten</a></li>
+ <li><a href="{{url_for("top_syntax_documentation")}}">Tagesordnungspunkte</a></li>
+ <li><a href="{{url_for("lists_syntax_documentation")}}">Listen</a></li>
+ <li><a href="{{url_for("internal_syntax_documentation")}}">Interne Abschnitte</a></li>
+ <li><a href="{{url_for("tags_syntax_documentation")}}">Tags</a></li>
</ul>
{% endblock %}
diff --git a/templates/documentation.html b/templates/documentation.html
index 488e584..88de26b 100644
--- a/templates/documentation.html
+++ b/templates/documentation.html
@@ -3,37 +3,37 @@
{% block title %}Dokumentation{% endblock %}
{% block documentation_content %}
- <h3>Protokollsystem 3 - Das Protokollsystem</h3>
- <p>
+ <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 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>.
- </p>
- <h3>Dokumentation</h3>
- Dieser Dokumentation können Beschreibungen zu nahezu allen wichtigen Systemfunktionen entnommen werden. Gegliedert sind die Themen wie folgt:
- <ul>
- <li><a href="/documentation/sessionmanagement">Sitzungsverwaltung</a><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></li>
- <li><a href="/documentation/syntax">Syntax</a><ul>
- <li><a href="/documentation/syntax/meta">Metadaten</a></li>
- <li><a href="/documentation/syntax/top">Tagesordnungspunkte</a></li>
- <li><a href="/documentation/syntax/lists">Listen</a></li>
- <li><a href="/documentation/syntax/internal">Interne Abschnitte</a></li>
- <li><a href="/documentation/syntax/tags">Tags</a></li>
- </ul></li>
- <li><a href="/documentation/configuration">Einrichtung</a><ul>
- <li><a href="/documentation/configuration/types">Typen</a></li>
- <li><a href="/documentation/configuration/todomails">Todo Mails</a></li>
- <li><a href="/documentation/configuration/settings">Systemeinstellungen</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>
+ </p>
+ <p>
+ Des weiteren 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>.
+ </p>
+ <h3>Dokumentation</h3>
+ Dieser Dokumentation können Beschreibungen zu nahezu allen wichtigen Systemfunktionen entnommen werden. Gegliedert sind die Themen wie folgt:
+ <ul>
+ <li><a href="{{url_for("sessionmanagement_documentation")}}">Sitzungsverwaltung</a><ul>
+ <li><a href="{{url_for("plan_sessionmanagement_documentation")}}">Planung</a></li>
+ <li><a href="{{url_for("write_sessionmanagement_documentation")}}">Protokollieren</a></li>
+ <li><a href="{{url_for("tracking_sessionmanagement_documentation")}}">Nachverfolgung</a></li>
+ </ul></li>
+ <li><a href="{{url_for("syntax_documentation")}}">Syntax</a><ul>
+ <li><a href="{{url_for("meta_syntax_documentation")}}">Metadaten</a></li>
+ <li><a href="{{url_for("top_syntax_documentation")}}">Tagesordnungspunkte</a></li>
+ <li><a href="{{url_for("lists_syntax_documentation")}}">Listen</a></li>
+ <li><a href="{{url_for("internal_syntax_documentation")}}">Interne Abschnitte</a></li>
+ <li><a href="{{url_for("tags_syntax_documentation")}}">Tags</a></li>
+ </ul></li>
+ <li><a href="{{url_for("configuration_documentation")}}">Einrichtung</a><ul>
+ <li><a href="{{url_for("types_configuration_documentation")}}">Typen</a></li>
+ <li><a href="{{url_for("todomails_configuration_documentation")}}">Todo Mails</a></li>
+ <li><a href="{{url_for("settings_configuration_documentation")}}">Systemeinstellungen</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>
@@ -43,9 +43,9 @@
{% if git_revision %}
<h3 id="version">Version</h4>
- <p>
+ <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>
+ </p>
{% endif %}
{% endblock %}
--
GitLab