From bf03dc3f07fbb71c6b53212c9bc9696eb5af4dc0 Mon Sep 17 00:00:00 2001 From: Markus Scheller <scheller_m@live.de> Date: Wed, 30 May 2018 09:45:41 +0200 Subject: [PATCH] Added corrections to the documentation files protokollsystem/proto3#172 protokollsystem/proto3!11 --- .../documentation-configuration-settings.html | 8 +++--- ...documentation-configuration-todomails.html | 4 +-- .../documentation-configuration-types.html | 2 +- .../documentation-sessionmanagement-plan.html | 2 +- ...documentation-sessionmanagement-write.html | 2 +- .../documentation-sessionmanagement.html | 6 ++--- templates/documentation-syntax-internal.html | 4 +-- templates/documentation-syntax-lists.html | 2 +- templates/documentation-syntax-meta.html | 4 +-- templates/documentation-syntax-tags.html | 26 +++++-------------- templates/documentation-syntax-top.html | 2 +- templates/documentation-syntax.html | 4 +-- templates/documentation.html | 2 +- 13 files changed, 27 insertions(+), 41 deletions(-) diff --git a/templates/documentation-configuration-settings.html b/templates/documentation-configuration-settings.html index 799ad89..ee7f5e4 100644 --- a/templates/documentation-configuration-settings.html +++ b/templates/documentation-configuration-settings.html @@ -5,7 +5,7 @@ {% block documentation_content %} <h3>Einrichtung: Systemeinstellungen</h3> <p> - Einige Features des Protokollsystem müssen bei der Installation und Einrichtung durch die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a> aktiviert werden. Eine Übersicht über die mit diesen Systemeinstellungen verbundenen Features soll hier gegeben werden. Sollten einige der angegeben Funktionalitäten aktiviert werden, so wende dich an die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a>. Bedenke vor deiner Anfrage, dass einige Features eventuell aus wichtigen Gründen bisher noch nicht aktiviert wurden. + Einige Features des Protokollsystems müssen bei der Installation und Einrichtung durch die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a> aktiviert werden. Dies ist eine Übersicht über die mit diesen Systemeinstellungen verbundenen Features. Sollten einige der angegeben Funktionalitäten aktiviert werden, so wende dich an die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a>. Bedenke vor deiner Anfrage, dass einige Features eventuell aus wichtigen Gründen bisher noch nicht aktiviert wurden. </p> <table class="table table-striped"> <thead> @@ -19,7 +19,7 @@ <tr> <td>E-Mailversand</td> <td><span class="glyphicon glyphicon-{% if config.MAIL_ACTIVE %}ok{% else %}remove{% endif %}" aria-hidden="true"></span></td> - <td>Das System kann selbstständig E-Mails versenden, um über nächste Sitzungen, neue Protokolle oder Todos zu informieren.</td> + <td>Das System kann selbstständig E-Mails versenden, um über anstehende Sitzungen, neue Protokolle oder Todos zu informieren.</td> </tr> <tr> <td>Druckeranbindung</td> @@ -49,12 +49,12 @@ <tr> <td>Angepasste Standardvorlage</td> <td><span class="glyphicon glyphicon-{% if (config.LATEX_LOCAL_TEMPLATES and config.LATEX_LOGO_TEMPLATE) or config.LATEX_GEOMETRY or config.LATEX_PAGESTYLE or config.LATEX_ADDITIONAL_PACKAGES or config.LATEX_HEADER_FOOTER %}ok{% else %}remove{% endif %}" aria-hidden="true"></span></td> - <td>Das System nutzt die Standardprotokollvorlage in einer angepassten Form.</td> + <td>Das System nutzt die Standardprotokollvorlage in einer angepassten Form - ggf. mit Logo, Kopf-/Fußzeile oder anderen Seitenformaten bzw. -abständen</td> </tr> <tr> <td>Individuelle Protokollvorlagen</td> <td><span class="glyphicon glyphicon-{% if config.LATEX_LOCAL_TEMPLATES and config.LATEX_TEMPLATES %}ok{% else %}remove{% endif %}" aria-hidden="true"></span></td> - <td>Das System stellt zusätzlich zur Standardvorlage individuelle Protokollvorlagen zur Verfügung.</td> + <td>Das System stellt zusätzlich zur Standardvorlage individuelle Protokollvorlagen zur Verfügung, die zuvor erstellt und durch die Administratoren eingespielt wurden.</td> </tr> </tbody> </table> diff --git a/templates/documentation-configuration-todomails.html b/templates/documentation-configuration-todomails.html index 15c498f..8f26601 100644 --- a/templates/documentation-configuration-todomails.html +++ b/templates/documentation-configuration-todomails.html @@ -6,7 +6,7 @@ <h3>Einrichtung: Todo Mails</h3> {% if config.MAIL_ACTIVE %} <p> - Werden im Protokollsystem im Rahmen einer Sitzung Aufgaben verwaltet, so kann es ermöglicht werden, dass die mit der Aufgabe betraute Person eine Benachrichtigung erhält. Damit diese Personen eine Benachrichtigung erhalten kann, sollten zu jedem genutzten Personenkürzel eine E-Mailadresse hinterlegt werden. Diese Konfiguration erfolgt zentral auf der Übersicht der <a href="{{url_for('list_todomails')}}">Todo-Mail-Zuordnungen</a>. + Werden im Protokollsystem im Rahmen einer Sitzung Aufgaben verwaltet, so kann eingestellt werden, dass die mit der Aufgabe betrauten Personen eine Benachrichtigung erhalten können. Damit diese Personen eine Benachrichtigung erhalten kann, sollten zu jedem genutzten Personenkürzel eine E-Mailadresse hinterlegt werden. Diese Konfiguration erfolgt zentral auf der Übersicht der <a href="{{url_for('list_todomails')}}">Todo-Mail-Zuordnungen</a>. </p> <div class="panel panel-default"> <div class="panel-heading"> @@ -38,7 +38,7 @@ </div> </div> <p> - Auf der <a href="{{url_for('list_todomails')}}">Zuordnungsübersicht</a> kann über die Schaltfläche „neu“ eine entsprechende Todo-Mail-Zuordnungen angelegt werden. Bereits bestehende Zuordnungen können jederzeit angepasst oder gelöscht werden. Beim Anlegen bzw. der Bearbeitung einer Zuordnungen müssen stets das genutzten Personenkürzel (Name) sowie die korresspondierende E-Mailadresse angegeben werden. + Auf der <a href="{{url_for('list_todomails')}}">Übersicht</a> kann über die Schaltfläche „neu“ eine entsprechende Todo-Mail-Zuordnungen angelegt werden. Bereits bestehende Belegungen können jederzeit angepasst oder gelöscht werden. Beim Anlegen bzw. der Bearbeitung müssen stets das genutzten Personenkürzel (Name) sowie die korresspondierende E-Mailadresse angegeben werden. </p> <div class="panel panel-default"> <div class="panel-heading"> diff --git a/templates/documentation-configuration-types.html b/templates/documentation-configuration-types.html index e310726..693d3da 100644 --- a/templates/documentation-configuration-types.html +++ b/templates/documentation-configuration-types.html @@ -494,7 +494,7 @@ <h4 id="decision_categories">Beschlusskategorien</h4> <p> - Um Beschlüsse zu einzelnen Themen bzw. Kategorien zusammenfassen zu können, werden je Protokolltyp die benötigten Beschlusskategorien angelegt und verwaltet. Die verfügbaren Kategorien lassen sich im Beschluss-Tag verwenden. Fehlende Kategorien lassen sich jeder Zeit durch Angabe des Kategorienames ergänzen. Bisher nicht verwendete Kategorien können gefahrlos gelöscht. + Um Beschlüsse zu einzelnen Themen bzw. Kategorien zusammenfassen zu können, werden je Protokolltyp die benötigten Beschlusskategorien angelegt und verwaltet. Die verfügbaren Kategorien lassen sich im Beschluss-Tag verwenden. Fehlende Kategorien lassen sich jeder Zeit durch Angabe des Kategorienames ergänzen. Bisher nicht verwendete Kategorien können gefahrlos gelöscht werden. </p> <div class="panel panel-default"> <div class="panel-heading"> diff --git a/templates/documentation-sessionmanagement-plan.html b/templates/documentation-sessionmanagement-plan.html index aee3583..eabc083 100644 --- a/templates/documentation-sessionmanagement-plan.html +++ b/templates/documentation-sessionmanagement-plan.html @@ -245,7 +245,7 @@ <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 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).</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> <div class="panel panel-default"> diff --git a/templates/documentation-sessionmanagement-write.html b/templates/documentation-sessionmanagement-write.html index 78ad4ab..f329d1c 100644 --- a/templates/documentation-sessionmanagement-write.html +++ b/templates/documentation-sessionmanagement-write.html @@ -209,7 +209,7 @@ <h4>Bekannte Problem bei der Etherpadnutzung</h4> <h5><b>Leeres Etherpad</b></h5> <p> - Wird mit „Etherpad“ ein Pad geöffnet und es ist leer bzw. beinhaltet nur den Standardtext, so sollte das Etherpad mit „Etherpad“ erneut geöffnet werden. Schlägt das ganze wende dich bitte an an die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a>. + Wird mit „Etherpad“ ein Pad geöffnet und es ist leer bzw. beinhaltet nur den Standardtext, so sollte das Etherpad mit „Etherpad“ erneut geöffnet werden. Schlägt das ganze fehl, wende dich bitte an an die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a>. </p> <h5><b>Etherpad zu früh geöffnet</b></h5> <p> diff --git a/templates/documentation-sessionmanagement.html b/templates/documentation-sessionmanagement.html index 6ccbd6d..3509388 100644 --- a/templates/documentation-sessionmanagement.html +++ b/templates/documentation-sessionmanagement.html @@ -5,11 +5,11 @@ {% 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. + 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. </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. + 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> @@ -17,7 +17,7 @@ <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. + 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. </p> <h4 id="suche">Suche</h4> diff --git a/templates/documentation-syntax-internal.html b/templates/documentation-syntax-internal.html index 59dd254..eca91c5 100644 --- a/templates/documentation-syntax-internal.html +++ b/templates/documentation-syntax-internal.html @@ -6,7 +6,7 @@ <h3>Syntax: Interne Abschnitte</h3> {% if config.PRIVATE_KEYWORDS %} <p> - Das Protokollsystem unterstützt in einem öffentlichen Protokoll bestimmte Abschnitte als nicht-öffentlich/intern zu kennzeichnen. Diese internen Abschnitte werden nur Personen mit dem entsprechendem Recht angezeigt und auch nur in der internen pdf-Datei gedruckt. Die öffentliche Version des Protokolls enthält an dieser Stelle einen Hinweis, auf einen internen Abschnitt. Aus Gründen der Transparenz bietet es sich an vor oder nach dem internen Protokollieren dessen Inhalt zusammenzufassen. + Das Protokollsystem ermöglicht es, in einem Protokoll bestimmte Abschnitte als nicht-öffentlich/intern zu kennzeichnen. Diese Abschnitte werden nur in der internen pdf-Datei gedruckt und nur internen Personen angezeigt - wer das ist lässt sich im System explizit festlegen. Die öffentliche Version des Protokolls enthält dann an betroffenen Stellen einen Hinweis, dass es hier einen internen Abschnitt gibt. Aus Gründen der Transparenz bietet es sich an, vor oder nach dem internen Protokollieren dessen Inhalt zusammenzufassen. </p> <p> Beschlüsse sind im Protokollsystem immer öffentlich, daher ergibt es keinen Sinn diese in einem internen Abschnitt zu protokollieren. @@ -30,7 +30,7 @@ <span class="nv">Hier entwickeln wir eine Strategie.</span> } <span class="nv">Dieser ist wieder öffentlich.</span> - <span class="nv">Es wurde die Krtik an einer Vorlesung kritsiert.</span> + <span class="nv">Es wurde die Kritik an einer Vorlesung kritisiert.</span> }</code></pre> </figure> </div> diff --git a/templates/documentation-syntax-lists.html b/templates/documentation-syntax-lists.html index 4fe74af..9f1d1d7 100644 --- a/templates/documentation-syntax-lists.html +++ b/templates/documentation-syntax-lists.html @@ -5,7 +5,7 @@ {% block documentation_content %} <h3>Syntax: Listen</h3> <p> - Das Protokollsystem sieht vor, dass Diskussionen in einem Tagesordnungspunkt strukturiert und in Unterpunkte aufgeteilt werden können. Dies wird durch sogenannte Listen umgesetzt. Mit jedem Zeilenumbruch erzeugt das Protokollsystem beim Kompilieren (Übersetzten des Syntax in ein PDF oder die Webseitenanzeige) einen neue Zeile im fertigen Protokoll, welchem ggf. ein Auszählungszeichen besitzt. + Das Protokollsystem sieht vor, dass Diskussionen in einem Tagesordnungspunkt strukturiert und in Unterpunkte aufgeteilt werden können. Dies wird durch sogenannte Listen umgesetzt. Mit jedem Zeilenumbruch erzeugt das Protokollsystem beim Kompilieren (Übersetzten des Syntax in ein PDF oder die Webseitenanzeige) einen neue Zeile im fertigen Protokoll und setzt ggf. ein Auszählungszeichen an den Anfang der Zeile. </p> <p> Zusätzlich gibt es im Protokollsystem spezielle Listen, die es ermöglichen hinsichtlich der Ausgabe oder des Titels Unterscheidungen vornehmen zu können. {% if config.PRIVATE_KEYWORDS|length > 0 %}Diese Listen sind{% else %}Eine solche Liste ist{% endif %} der <a href="top">Tagesordnungspunkt</a>{% if config.PRIVATE_KEYWORDS|length > 0 %} und der <a href="internal">interne Abschnitt</a>{% endif %}. diff --git a/templates/documentation-syntax-meta.html b/templates/documentation-syntax-meta.html index 94ccd18..b69b512 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 Teilnehmer 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="/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. </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 auf Groß- und Kleinschreibung geachtet werden. + 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. </p> {% endblock %} diff --git a/templates/documentation-syntax-tags.html b/templates/documentation-syntax-tags.html index df6f43b..4e0b41c 100644 --- a/templates/documentation-syntax-tags.html +++ b/templates/documentation-syntax-tags.html @@ -140,24 +140,10 @@ </figure> <h4 id="session">Sitzungs-Tag</h4> - <div class="row"> - <div class="col-sm-9"> - <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>. - </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> - </figure> - </div> - <div class="col-sm-3"> - <div class="panel panel-danger"> - <div class="panel-heading"> - <h5 class="panel-title">Experimentell</h5> - </div> - <div class="panel-body">Dieser Tag legt der Zeit bei jeder Neuerstellung des Protokolls den angegeben Termin neu an.</div> - </div> - </div> - </div> - - + <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>. + </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> + </figure> {% endblock %} diff --git a/templates/documentation-syntax-top.html b/templates/documentation-syntax-top.html index e64b2c6..f94a09f 100644 --- a/templates/documentation-syntax-top.html +++ b/templates/documentation-syntax-top.html @@ -5,7 +5,7 @@ {% block documentation_content %} <h3>Syntax: Tagesordnungspunkte</h3> <p> - Ein wichtiges Elements in jedem Protokoll sind Tagesordnungspunkte. Sie repräsentieren in einem Protokoll stehts die oberste Gliederungsebene. In den meisten Fällen werden stehen diese Punkte bereits vor Beginn der Sitzung fest und wurden entsprechend vorher <a href="/documentation/sessionmanagement/plan#prepare">eingeplegt</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="/documentation/sessionmanagement/plan#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. diff --git a/templates/documentation-syntax.html b/templates/documentation-syntax.html index ae9e5c2..5a15a45 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 der eigentliche Protokollsyntax, aus dem systemintern ein druckbares Dokument und menschenlesbaren Webseiteninhalt erstellt. Der 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 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. </p> <h4>Allgemeine Grundsätze</h4> <p> @@ -18,7 +18,7 @@ </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 beschrieben. + 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> diff --git a/templates/documentation.html b/templates/documentation.html index 48a58cd..488e584 100644 --- a/templates/documentation.html +++ b/templates/documentation.html @@ -8,7 +8,7 @@ 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. + 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: -- GitLab