documentation-syntax-meta.html 2.33 KB
Newer Older
1
2
{% extends "documentation-base.html" %}
{% set active_page = "meta_syntax_documentation" %}
3
{% block title %}Syntax: Metadaten{% endblock %}
4
5

{% block documentation_content %}
6
7
    <h3>Syntax: Metadaten</h3>
	<p>
8
	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.
9
10
11
12
13
14
15
16
17
18
	</p>
	<h4>Definition</h4>
	<p>
    Die Syntax der Metadaten ist <code class="highlight" style="color: inherit;"><span class="nc">#Name</span>;<span class="s1">Wert</span></code> und die einzelnen Felder und Einträge werden durch Zeilenumbrüche getrennt. Weiterhin darf auf das Semikolon kein Leerzeichen folgenden, da dies zu einem nicht kompilierbaren Protokoll führt. Auch müssen die folgende Metadaten immer in diesem Format angegeben werden, da eine Interpretation des Datums und der Uhrzeit sonst fehlschlägt.
    </p>
	<ul>
        <li><code class="highlight" style="color: inherit;"><span class="nc">#Datum</span>;<span class="mi">01.01.2017</span></code> Das Datum der Sitzung</li>
        <li><code class="highlight" style="color: inherit;"><span class="nc">#Beginn</span>;<span class="mi">19:00</span></code> Beginn der Sitzung</li>
        <li><code class="highlight" style="color: inherit;"><span class="nc">#Ende</span>;<span class="mi">21:42</span></code> Ende der Sitzung</li>
    </ul>
19
	<p>
20
	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.
21
	</p>
22
{% endblock %}