{% extends "layout.html" %} {% from "macros.html" import render_table %} {% block title %}Dokumentation{% endblock %} {% block content %}

Protokollsystem

Das Protokollsystem dient der Planung von Sitzungen und Verwaltung von Protokollen. Die anstehenden Sitzungen der nächsten Woche sind auf der Startseite, alle Protokolle unter Protokolle zu finden.

Sitzungsplanung

Sollte das Protokoll noch nicht existieren:
  1. Gehe auf Neu
  2. Wähle bei „Typ“ den Typ der Sitzung aus.
  3. Gib das Datum der Sitzung ein.
  4. Anlegen
Wenn es existiert:
  1. Gehe auf Protokolle
  2. Wähle die Sitzung aus. Noch ausstehende Sitzungen sind ganz oben.
Auf der Seite der Sitzung siehst du die Tagesordnung.

Wie schreibe ich eine Protokoll?

  1. Protokoll auswählen (s.o.)
  2. mit „In Etherpad“ die Vorlage in das Etherpad schreiben.
  3. mit „Etherpad“ das Etherpad öffnen
  4. verlese Tagesordnung und Todos
  5. falls Todo erledigt, markiere als erledigt (Details siehe Todos
  6. schreibe das Protokoll im Etherpad
  7. Importiere das Protokoll am Ende mit „Aus Etherpad“
  8. Falls Fehler auftreten, behebe sie (siehe Fehler
  9. Wenn keine Fehler mehr auftreten, drucke das Protokoll mit „Löschen” (unten beim Anhang) aus.
  10. Korrekturlesen lassen und im Etherpad korrigieren, dann nochmal „aus Etherpad“
  11. drucken, abheften und per Mail versenden

Was, wenn etwas nicht funktioniert?

Todosystem

Das Protokollsystem verwaltet Todos über mehrere Protokolle hinweg. Offene Todos werden in die Protokollvorlage eingefügt.

Suche

Protokolle, Todos und Beschlüsse können durchsucht werden. Im Suchfeld können mehrere durch Leerzeichen getrennte Suchbegriffe angegeben werden: Begriff1 Begriff2. Angezeigt werden alle Ergebnisse, die jeden der Suchbegriffe (unabhängig von Groß- oder Kleinschreibung) enthalten. Wenn ein Suchbegriff ein Leerzeichen beinhaltet, muss er mit Anführungszeichen umrandet werden: "Begriff1 mit Leerzeichen" Begriff2.

Rechteverwaltung

Das Protkollsystem hat ein Konzept von Rechteverwaltung, dass auf den Benutzergruppen im LDAP basiert. Rechte werden pro Protokolltyp eingestellt. Die vorhandenen Rechtestufen sind „Darf öffentliche Version einsehen“, „Darf interne Version einsehen“ und „Darf Ändern“. Jedes Protokoll hat eine öffentliche Gruppe, eine interne Gruppe und eine Einstellung, ob es öffentlich ist.
Die öffentliche Version einsehen dürfen: Die interne Version einsehen dürfen: Das Protokoll bearbeiten dürfen alle, die die interne Version einsehen dürfen.
Vom Protokoll wird eine interne und eine öffentliche Version generiert, wenn es Inhalte gibt, die nur intern sind. Todos sind generell intern, Beschlüsse sind generell öffentlich (d.h. einsehbar, wenn man das Recht „Darf öffentliche Version sehen“ hat).

Syntax

Ein Dokument beginn mit einigen Metadaten, danach kommen nacheinander die Tagesordnungspunkte, die durch Listen strukturiert sind. Darüberhinaus gibt es Tags, mit denen URLs, Beschlüsse oder ToDos markiert werden können.

Metadaten

Die Syntax der Metadaten ist #Name;Wert und die einzelnen Einträge werden durch Zeilenumbrüche getrennt. Folgende Metadaten werden unterstützt und sollten angegeben werden:

Tagesordnungspunkte

Ein TOP besteht aus einem Titel und beliebigem Inhalt. Ein TOP ist eine besondere Liste und kann somit wie eine Liste verwendet werden.
{TOP Tagesordnungspunkt
    Inhalt;
}

Liste

Die Liste ist das einzige strukturierende Element. Liste können (quasi) beliebig geschachtelt werden (bis LaTeX nicht mehr will). Die Elemente der Liste werden durch Semikolons getrennt.
{TOP Tagesordnungspunkt
    Zeile mit Text drin;
    Hier eine geschachtelte Liste: {
        Details zu diesem Punkt.;
        Mehr Details zu diesen Punkt.;
    };
    Und ein anderer Punkt.;
};
Text, der vor der öffnenden Klammer { oder in derselben Zeile hinter der Klammer steht, wird als Name der Liste angesehen. Listen in der höchsten Ebene müssen TOPs sein. {% if config.PRIVATE_KEYWORDS|length > 0 %}

Interne Abschnitte

Wenn der Name einer Liste (bis auf Leerzeichen und einen optionalen :) eins aus {{config.PRIVATE_KEYWORDS|join(" ")}} ist, ist diese Liste intern. Daher wird sie nur in der internen Version des Protokolls angezeigt.
{TOP Tagesordnungspunkt
    Dieser Punkt ist öffentlich.;
    {{config.PRIVATE_KEYWORDS[0]}}: {
        Dieser Punkt ist intern.;
        Dieser auch.;
    };
    Dieser ist wieder öffentlich.;
}

Tags

Tags können Text besonders hervorheben oder bestimmte Aktionen ausführen. Die grundsätzliche Syntax ist [Name;Arg1;Arg2;…], wobei theoretisch beliebig viele Argumente angegeben werden können.;
URL-Tag
Mittel [url;https://protokolle.fsmpi.rwth-aachen.de ] kann ein entsprechend formatierter Link eingebunden werden. Das Leerzeichen am Ende ist nicht notwendig für das Protokollsystem, erleichtert aber das Anklicken im Etherpad.
Beschluss-Tag
[beschluss;Wir beschließen etwas tolles.] erzeugt einen Beschluss im Protokoll. Ein Beschluss wird zusätzlich am Anfang des Protokoll angezeigt. Die Beschlüsse sind online durchsuchbar.
Todo-Tag
In den Protokollen können Todos verwaltet werden. Ein neuer Todo wird mit [todo;Name;Aufgabe] angelegt. Dieser ist dasnn online und in den Mails sichtbar. Falls der Name einer Mail zugeordnet ist, wird diese Person (oder AG, AK, …) per Mail über ihre offenen Todos informiert. Mehrere Personen können durch Leerzeichen oder Kommata getrennt angegeben werden. Ein bereits bestehender Todo wird mit der zusätzlichen Option […;id 1338] in ein neues Protokoll eingefügt. Wird dieser Todo dann geändert, passiert das auch im Protokollsystem. Außerdem kann der Status des Todos, z.B. […;done;…] angegeben werden. {% endif %}
{% endblock %}