From b3f3c47e661f192deab17e8b83fe086a4c0ac1c9 Mon Sep 17 00:00:00 2001
From: Markus Scheller <mscheller@asta.rwth-aachen.de>
Date: Wed, 14 Mar 2018 18:20:41 +0100
Subject: [PATCH] Reviewed documentation on syntax for TOP
protokollsystem/proto3#172
---
templates/documentation-syntax-top.html | 46 +++++++++++++++++++------
1 file changed, 36 insertions(+), 10 deletions(-)
diff --git a/templates/documentation-syntax-top.html b/templates/documentation-syntax-top.html
index 966fc84..f07825e 100644
--- a/templates/documentation-syntax-top.html
+++ b/templates/documentation-syntax-top.html
@@ -1,15 +1,41 @@
{% extends "documentation-base.html" %}
{% set active_page = "top_syntax_documentation" %}
+{% block title %}Syntax: Tagesordnungspunkte{% endblock %}
{% block documentation_content %}
- <h3>Tagesordnungspunkte</h3>
-
- <h4 id="tops">Tagesordnungspunkte</h4>
- Ein TOP besteht aus einem Titel und beliebigem Inhalt.
- Ein TOP ist eine besondere Liste (s.u.) und kann somit wie diese verwendet werden.
-<pre>
-{TOP Tagesordnungspunkt
- Inhalt:
-}
-</pre>
+ <h3>Syntax: Tagesordnungspunkte</h3>
+ <p>
+ Ein wichtiges Elements in jedem Protokoll sind Tagesordnungspunkte. Sie repräsentieren in einem Protokoll stehts die oberste Gliederungsebene. In den meisten Fällen werden stehen diese Punkte bereits vor Beginn der Sitzung fest und wurden entsprechend vorher <a href="/documentation/sessionmanagement/plan#prepare">eingeplegt</a>.
+ </p>
+ <p>
+ Beim Erstellen der Protokollvorlage durch das System werden die bereits <a href="/documentation/sessionmanagement/plan#prepare">angelegten TOPs</a> mit dem vorprotokollierten Inhalt in der Tagesordnung festgelegten Reihenfolge übertragen. Während des Schreibens des Protokolls können jeder Zeit Tagesordnungspunkte hinzugefügt oder entfernt werden.
+ </p>
+ <h4>Definition</h4>
+ <div class="row">
+ <div class="col-sm-9">
+ <p>
+ In Protokollsystax wird ein Tagesordnungspunkt stets von geschweiften Klammern eingeschlossen. An die öffnende Klammer schließt sich das Schlüsselwort <code>TOP</code> an. Abgesetzt mit einem Leerzeichen folgt der Titel des TOPs. Nach einem Zeilenumbruach als in einer neuen Zeile beginnt dann der Inhalt des Tagesordnungspunkts. Durch die Verwendung von sogenannten <a href="lists">Listen</a> kann die Mitschrift in einem Tagesordnungspunkt strukturiert werden.
+ </p>
+ </div>
+ <div class="col-sm-3 panel panel-warning">
+ <div class="panel-heading">
+ <h5 class="panel-title">Zu beachten</h5>
+ </div>
+ <div class="panel-body ">
+ <p>
+ Innerhalb eines Tagesordnungspunkts kann es keinen weiteren Tagesordnungspunkt geben.
+ </p>
+ </div>
+ </div>
+ </div>
+ <div class="panel panel-default">
+ <div class="panel-heading">
+ <h5 class="panel-title">Syntax eines Tagesordnungspunkts</a></h5>
+ </div>
+ <figure class="panel-body">
+ <pre class="highlight"><code>{<span class="kr">TOP</span> <span class="sx">Titel des Tagesordnungspunkts</span>
+ <span class="c1">Hier steht der Inhalt des Tagesordnungspunkts</span>
+}</code></pre>
+ </figure>
+ </div>
{% endblock %}
--
GitLab