From 488dc12f360cce18e9a822071ba2b5a1bfb91683 Mon Sep 17 00:00:00 2001
From: Markus Scheller <scheller_m@live.de>
Date: Sun, 11 Mar 2018 19:33:12 +0100
Subject: [PATCH] Reviewed Metadata syntax description
protokollsystem/proto3#172
---
templates/documentation-syntax-meta.html | 24 ++++++++++++++----------
1 file changed, 14 insertions(+), 10 deletions(-)
diff --git a/templates/documentation-syntax-meta.html b/templates/documentation-syntax-meta.html
index b264582..d8ecb71 100644
--- a/templates/documentation-syntax-meta.html
+++ b/templates/documentation-syntax-meta.html
@@ -1,15 +1,19 @@
{% extends "documentation-base.html" %}
{% set active_page = "meta_syntax_documentation" %}
+{% block title %}Syntax: Metadaten{% endblock %}
{% block documentation_content %}
- <h3>Metadaten</h3>
-
- <h4 id="metadaten">Metadaten</h4>
- Die Syntax der Metadaten ist <code>#Name;Wert</code> und die einzelnen Einträge werden durch Zeilenumbrüche getrennt. Folgende Metadaten müssen immer in diesem Format angegeben werden:
- <ul>
- <li><code>#Datum;01.01.2017</code> Das Datum der Sitzung</li>
- <li><code>#Beginn;19:00</code> Beginn der Sitzung</li>
- <li><code>#Ende;21:42</code> Ende der Sitzung</li>
- </ul>
- 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.
+ <h3>Syntax: Metadaten</h3>
+ <p>
+ 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 Metadatenfelder, wie beispielsweise der Ort, die anwesenden Teilnehmer oder die Protokollführung. Alle Metadatenfelder 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.
+ </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>
{% endblock %}
--
GitLab