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:
- Gehe auf Neu
- Wähle bei „Typ“ den Typ der Sitzung aus.
- Gib das Datum der Sitzung ein.
- Anlegen
Wenn es existiert:
- Gehe auf Protokolle
- Wähle die Sitzung aus. Noch ausstehende Sitzungen sind ganz oben.
Auf der Seite der Sitzung siehst du die Tagesordnung.
- Die ersten und letztes TOPs sind Standard-TOPs, die jede Sitzung hat. Die kannst du nur über beim Protokolltyp ändern, nicht beim Protokoll selbst.
- Die mittleren TOPs gehören nur zu dieser Sitzung. Du kannst welche hinzufügen oder sie umsortieren.
- Solltest du die TOPs nicht bearbeiten können, handelt es sich um ein Protokoll, das du lesen, aber nicht bearbeiten kannst. Mehr dazu bei Rechteverwaltung.
Wie schreibe ich eine Protokoll?
- Protokoll auswählen (s.o.)
- mit „In Etherpad“ die Vorlage in das Etherpad schreiben.
- mit „Etherpad“ das Etherpad öffnen
- verlese Tagesordnung und Todos
- falls Todo erledigt, markiere als erledigt (Details siehe Todos
- schreibe das Protokoll im Etherpad
- Importiere das Protokoll am Ende mit „Aus Etherpad“
- Falls Fehler auftreten, behebe sie (siehe Fehler
- Wenn keine Fehler mehr auftreten, drucke das Protokoll mit „Löschen” (unten beim Anhang) aus.
- Korrekturlesen lassen und im Etherpad korrigieren, dann nochmal „aus Etherpad“
- drucken, abheften, per Mail versenden und veröffentlichen
Was, wenn etwas nicht funktioniert?
- Typische Web-Fehler (404, 500, etc.) sollten nicht auftreten. Wenn sie es doch tun, wende dich bitte an die Admins
- Wenn beim Parsen, Kompilieren, versenden, hochladen, … Fehler auftreten, werden sie aufgelistet. Die Fehler aller Protokolle findest du unter Fehler. Bei sehr langen Beschreibungen (z.B. LaTeX-Kompilierfehlern) solltest du den einzelnen Fehler anklicken, um die ganze Beschreibung zu erhalten.
- Wenn die Fehlerbeschreibung dir nicht ausreicht, um den Fehler zu beheben, wende dich an jemand erfahreneren und lass dir helfen.
Todosystem
Das Protokollsystem verwaltet Todos über mehrere Protokolle hinweg. Offene Todos werden in die Protokollvorlage eingefügt.
- Jedes Todo hat eine (oder durch Kommata oder Leerzeichen getrennt mehrere) Personen, die es erledigen sollen.
- Todos haben auch einen Zustand, in dem sie sich befinden. Es gibt:
- offen: Das Todo muss noch erledigt werden
- wartet auf Rückmeldung: Jemand kümmert sich um das Todo, wartet allerdings gerade darauf, dass jemand anderes (intern oder extern) sich zurückmeldet.
- in Bearbeitung: Jemand kümmert sich gerade um das Todo.
- ab: Das Todo wird erst ab dem Datum relevant.
- vor: Das Todo muss vor dem Datum erledigt werden.
- verwaist: Das Todo hat niemanden, der es erledigen wird.
- erledigt: Das Todo ist erledigt.
- abgewiesen: Das Todo ist nicht und wird nicht mehr erledigt.
- obsolet: Das Todo wurde nicht erledigt und nun ist es zu spät, das noch zu tun.
- Alle Todos findest du unter Todos.
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:
-
Nicht authentifizierte Nutzer, wenn der Protokolltyp „Öffentlich“ eingestellt ist.
- Die Tagesordnung und Metadaten sind auch vor Veröffentlichung einsehbar.
- Authentifizierte Nutzer auch dann, wenn es nicht „Öffentlich“ eingestellt ist, aber sie die „Öffentliche Gruppe“ oder die „Interne Gruppe” des Protokolltyps haben. Wenn keine Gruppe eingestellt ist, kann auch kein Nutzer diese haben.
Die interne Version einsehen dürfen:
- Authentifizierte Nutzer, wenn sie die „Interne Gruppe” des Protokolls haben.
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.
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:
#Datum;01.01.2017
Das Datum der Sitzung
#Anwesende;Gustav, Geier
Alle anwesenden Personen
#Beginn;19:00
Beginn der Sitzung
#Ende;21:42
Ende der Sitzung
#Autor;Gustav
Autor (oder Autoren) des Protokolls
#Ort;Fachschaft
Ort der Sitzung
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|map("code")|join(" ")|safe}}
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.
Wenn der Status ein Datum benötigt
({{todostates|select("needs_date")|map("todo_get_name")|join(", ")}})
muss dies als
[…;dd.mm.yyyy;…]
angegeben werden.
Folgende Begriffe werden vom Protkollsystem verstanden (Groß- und Kleinschreibung spielt keine Rolle):
{% for name in name_to_state %}
{% set state = name_to_state[name] %}
{{name}}{% if state.needs_date() %};dd.mm.yyyy{% endif %}
: {{state.get_name()}}
{% endfor %}
{% endif %}