{% 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?

Die folgenden Schritte werden erst ein paar Minuten vor der Sitzung ausgeführt. Vorher werden Inhalte und TOPs wie oben beschrieben vorprotokolliert.
  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 und abheften
  12. Intern per Mail versenden
  13. Korrekturen abwarten (z.B. die Genehmigung auf der nächsten Sitzung)
  14. Veröffentlichen (und ggf. öffentlich versenden)
Höchst interne Protokolle
Falls das Protokoll Daten beinhaltet, die auf keinen Fall öffentlich sein sollten (z.B. personenbezogene Daten bei einem Sozialausschuss), kann anstelle des Editierens im Etherpad auch mit „Vorlage“ die leere Protokollvorlage heruntergeladen werden. Darin kann lokal mit einem beliebigen Texteditor die Sitzung protokolliert werden, um sie dann am Ende lokal zu speichern und mit „Quellcode hochladen“ hochzuladen.

Was, wenn etwas nicht funktioniert?

Todosystem

Das Protokollsystem verwaltet Todos über mehrere Protokolle hinweg. Offene Todos werden in die Protokollvorlage eingefügt, falls diese einen TOP „Todos“ beinhaltet.

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 Protokollsystem 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“, „Darf Ändern“ und „Darf Protokolltyp bearbeiten“. Jedes Protokoll hat eine öffentliche Gruppe, eine interne Gruppe, eine Bearbeitungsgruppe, eine Verwaltungsgruppe und eine Einstellung, ob es öffentlich ist.
Die öffentliche Version einsehen dürfen: Die interne Version einsehen dürfen: Das Protokoll bearbeiten dürfen: Die Einstellungen des Protokolltyps bearbeiten und das Protokoll veröffentlichen dürfen: Vom Protokoll wird eine interne und eine öffentliche Version generiert, falls 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). Daher dürfen Beschlüsse nicht in einem internen Teil des Protokolls sein.

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 müssen immer in diesem Format angegeben werden: Zusätzlich können pro Protokolltyp weitere Metadatenfelder konfiguriert werden, beispielsweise der Ort, die Anwesenden Teilnehmer, die Protokollführung, …. Diese haben als Wert beliebigen Text.

Tagesordnungspunkte

Ein TOP besteht aus einem Titel und beliebigem Inhalt. Ein TOP ist eine besondere Liste (s.u.) und kann somit wie diese verwendet werden.
{TOP Tagesordnungspunkt
    Inhalt:
}

Liste

Die Liste ist das einzige strukturierende Element. Listen können beliebig geschachtelt werden. Die Elemente der Liste werden durch das Zeilenende getrennt.
{TOP Tagesordnungspunkt
    Zeile mit Text drin
    Hier eine geschachtelte Liste: {
        Details zu diesem Punkt.
        Mehr Details zu diesen Punkt.
    }
}
Text, der vor der öffnenden Klammer { steht, wird als Name der Liste angesehen, nur TOPs können Text hinter der öffnenden Klammer haben. 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. In der öffentlichen Version steht stattdessen nur ein Hinweis auf diese interne Stelle. Es bietet sich beim Protokollieren an, wenn nach dem internen Bereich kurz dessen Inhalt zusammengefasst wird (natürlich nur sofern dies geht ohne die Interna zu verraten), oder begründet wird, warum dies intern ist.
{TOP Tagesordnungspunkt
    Dieser Punkt ist öffentlich.
    {{config.PRIVATE_KEYWORDS[0]}}: {
        Dieser Punkt ist intern.
        Dieser auch, wir diskutieren Kritik an einem namentlich genannten Professor und seiner Vorlesung.
        Hier entwickeln wir eine Strategie.
    }
    Dieser ist wieder öffentlich.
    Es wurde die Krtik an einer Vorlesung kritsiert.
}

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, allerdings je nach Typ nur endlich viele eine Bedeutung haben.
URL-Tag
Mittels [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. Beschluss-Tags dürfen nicht in internen Abschnitten stehen. Falls für den Protokolltyp Beschlusskategorien definiert sind, können Beschlüsse mit […;finanzwirksam;…] diesen zugeordnet werden. Beschlüsse können nach Beschlusskategorien gefiltert werden. 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. [beschluss;Wir beschaffen für bis zu 100,00 € einen Stuhl.(9/1/3);finanzwirksam;Inventar]
Todo-Tag
In den Protokollen können Todos verwaltet werden. Ein neuer Todo wird mit [todo;Name;Aufgabe] angelegt. Dieser ist dann 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, falls es den TOP „Todos“ beinhaltet.. 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 Protokollsystem verstanden (Groß- und Kleinschreibung spielt keine Rolle):
Fußnoten-Tag
Fußnoten können im Protokoll mit [footnote;Inhalt] geschrieben werden.
Sitzungs-Tag
Aus dem Protokoll können neue Sitzungen desselben Typs mit dem Tag [sitzung;Datum], z.B. [sitzung;24.12.2017] angelegt werden. Optional kann zusätzlich eine Uhrzeit angegeben werden: [sitzung;Datum;Uhrzeit] (z.B. [sitzung;01.01.2018;9:00]). {% endif %} {% if git_revision %}

Version

Dieses Protokollsystem nutzt die Software „Protokollsystem 3“ in der Version vom {{git_revision.date|datify}}. Alle Änderungen, die seitdem hinzugekommen sind, kannst du hier sehen. {% endif %}
{% endblock %}