{% extends "documentation-base.html" %} {% set active_page = "tags_syntax_documentation" %} {% block title %}Syntax: Tags{% endblock %} {% block documentation_content %}
Sollen in einem Protokoll Texte hervorgehoben oder in einer anderen Art und Weise formatiert werden, so bietet das Protokollsystem sogenannte Tags. Jeder Tag steht dabei stets in einer eigenen Zeile des Protokolls. Mit diesen Tags können neben einer veränderten Ausgabe des Textes auch bestimmte Aktionen im Protokollsystem ausgeführt werden.
Grundsätzlich wird jeder Tag in eckige Klammern eingeschlossen. Eingeleitet wird ein Tag nach der öffnenden eckigen Klammer [
mit dem Namen des Tags. Mit Semikolons getrennt, folgen theoretisch beliebig viele Argumente, wobei je nach Tag-Typ nur endlich viele Argumente eine Bedeutung haben. Jeder Tag wird als einzelnes Element einer Liste interpretiert.
[Typ;Argument 1;Argument 2;…]
Sollen URLs oder Hyperlinks in einem Protokoll dargestellt werden, so kann und sollte der Tag vom Typ url
genutzt werden. Als einziges Argument wird im Tag die URL angegeben.{% if config.ETHERPAD_ACTIVE %} Ein Leerzeichen am Ende des Arguments ist nicht notwendig für das Protokollsystem, erleichtert aber das Anklicken im Etherpad.{% endif %}
[url;https://protokolle.fsmpi.rwth-aachen.de ]
Werden in einer Sitzung Beschlüsse gefasst, so bietet sich die Nutzung des Tags beschluss
an. Ein Beschluss wird so im Protokoll zum einen als Beschluss gekennzeichnet und zum andern zusätzlich am Anfang des Protokolls angezeigt. Auch werden die Beschlüsse in der Beschlussdatenbank gespeichert und sind online durchsuchbar{% if config.PRINTING_ACTIVE %} sowie einzeln ausdruckbar{% endif %}.
[beschluss;Beschlusstext;Beschlusskategorie 1;Beschlusskategorie 2;…]
Ein Beschluss kann mit Beschlusskategorien versehen werden, um Beschlüsse zu einzelnen Themen zusammenfassen zu können. Des Versehen mit Kategorien ist jedoch kein muss. Kategorien 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. […;finanzwirksam;…]
.
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]
Soll in einer Sitzung die Vergabe einer Aufgabe an eine oder mehrere Personen (oder AG, AK, …) festgehalten werden, so kann mittels des Tags todo
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 Todo-Übersicht und nur im internen Protokoll einsehbar.
[todo;Name;Aufgabe;Argument 1;Argument 2;…]
{% if config.MAIL_ACTIVE %}Wurde der Name einer Mail zugeordnet, so wird diese Person (oder AG, AK, …) per Mail über ihre offenen Todos nach einer Sitzung informiert. {% endif %}Bei der Angabe mehrerer Personen können diese durch Leerzeichen oder Kommata voneinander getrennt angegeben werden.
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: […;id 1338]
. Wird dieser Todo dann während des Protokollierens geändert, passiert das auch im Protokollsystem.
In einem weiteren optionalen Argument kann außerdem der Status einer Aufgabe, z.B. […;done;…]
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: […;dd.mm.yyyy;…]
. 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.
Status | Benötigt Datum | Verwendbare Status-Begriffe |
---|---|---|
{{state.get_name()}} | {{possibilities|map("code_key")|join(", ")|safe}} |
[todo;mmustermann;Planung für die ESA beginnen;ab;01.03.2018]
[todo;mmustermann;Mit der Fakultät treffen]
[todo;kmusterfrau;Organisiation des nächsten Events;in Bearbeitung;id 1]
Ist es erforderlich, dass Informationen als Fußnote im Protokoll aufgeführt werden sollen, so können diese im Protokoll mit dem Tag des Types footnote
geschrieben werden. Als einziges Argument wird der Inhalt der Fußnote übergeben.
[footnote;Inhalt]
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 sitzung
genutzt. Als Argument muss mindestens das Datum übergeben werden und es hat die Form: […;dd.mm.yyyy;…]
. Optional kann zusätzlich eine Uhrzeit in folgender Form angegeben werden: […;h:mm]
.
[sitzung;Datum;Uhrzeit]