From d80d53c4487d38b0a86ff616c0f23627f8b85852 Mon Sep 17 00:00:00 2001
From: Markus Scheller <scheller_m@live.de>
Date: Sun, 11 Mar 2018 19:58:52 +0100
Subject: [PATCH] Add general part to syntax documentation
protokollsystem/proto3#172
---
templates/documentation-syntax.html | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/templates/documentation-syntax.html b/templates/documentation-syntax.html
index 90ee39f..ae9e5c2 100644
--- a/templates/documentation-syntax.html
+++ b/templates/documentation-syntax.html
@@ -7,6 +7,15 @@
<p>
Das Herz des Protokollsystems ist der eigentliche Protokollsyntax, aus dem systemintern ein druckbares Dokument und menschenlesbaren Webseiteninhalt erstellt. Der Systax sieht eine Strukturierung des Prokolls vor. Ein Dokument beginn mit einigen Metadaten, danach kommen nacheinander die Tagesordnungspunkte, die strukturiert diskuiterte Punkte enthalten. Darüberhinaus gibt es Tags, mit denen unter anderem URLs, Beschlüsse oder ToDos markiert werden können.
</p>
+ <h4>Allgemeine Grundsätze</h4>
+ <p>
+ Hast du zum ersten Mal Kontakt mit dem Protokollsystem so sind sollten die folgenden Grundsätze beachtet werden, damit die erfolgreiche Erstellung eines Protokolls einfach gelingt.
+ </p>
+ <ul>
+ <li>Jede geschweifte oder eckige Klammer die aufgemacht wird, wird sofort wieder geschlossen und anschließend der Inhalt zwischen die Klammern geschrieben.</li>
+ <li>Jeder Zeilenumbruch erzeugt eine neue Zeile im Protokoll.</li>
+ <li>Beachte die geschützten Begriffe: <code class="highlight" style="color: inherit;"><span class="nc">#Datum</span></code> <code class="highlight" style="color: inherit;"><span class="nc">#Beginn</span></code> <code class="highlight" style="color: inherit;"><span class="nc">#Ende</span></code> <code class="highlight" style="color: inherit;"><span class="kr">TOP</span></code> <code class="highlight" style="color: inherit;"><span class="kr">private</span></code> <code class="highlight" style="color: inherit;"><span class="kr">todo</span></code> <code class="highlight" style="color: inherit;"><span class="kr">id</span></code> <code class="highlight" style="color: inherit;"><span class="kr">beschluss</span></code> <code class="highlight" style="color: inherit;"><span class="kr">url</span></code> <code class="highlight" style="color: inherit;"><span class="kr">footnote</span></code> <code class="highlight" style="color: inherit;"><span class="kr">sitzung</span></code></li>
+ </ul>
<h4>Der Syntax im Detail</h4>
<p>
Um die Funktionsweise und das Verhalten des Protokollsystems bei der Umwandlung eines Protokolls zu verstehen, wird auf den Unterseiten auf die einzelnen Elemente der Protokollsyntax näher beschrieben.
--
GitLab