documentation-syntax.html 2.2 KB
Newer Older
1
2
{% extends "documentation-base.html" %}
{% set active_page = "syntax_documentation" %}
3
{% block title %}Syntax{% endblock %}
4
5
6

{% block documentation_content %}
    <h3>Syntax</h3>
7
    <p>
8
	Das Herz des Protokollsystems ist die eigentliche Protokollsyntax, aus dem systemintern ein druckbares Dokument und menschenlesbarer Webseiteninhalt erstellt wird. Die Systax sieht eine Strukturierung des Protokolls vor. Ein Dokument beginn mit einigen Metadaten, danach kommen nacheinander die Tagesordnungspunkte, die strukturiert diskutierte Punkte enthalten. Darüberhinaus gibt es Tags, mit denen unter anderem URLs, Beschlüsse oder ToDos markiert werden können.
9
	</p>
10
11
12
13
14
15
16
	<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>
17
18
19
20
21
22
23
24
25
26
27
		<li>Beachte die geschützten Begriffe:
    {% for term in ["#Datum", "#Beginn", "#Ende"] %}
      <code class="highlight" style="color: inherit;">
        <span class="nc">{{term}}</span>
      </code>
    {% endfor %}
    {% for term in ["TOP", "private", "todo", "id", "beschluss", "url", "footnote", "sitzung"] %}
      <code class="highlight" style="color: inherit;">
        <span class="kr">{{term}}</span>
      </code>
    {% endfor %}
28
	</ul>
29
30
	<h4>Der Syntax im Detail</h4>
	<p>
31
	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 eingegangen.
32
33
	</p>
	<ul>
34
35
36
37
38
		<li><a href="{{url_for("meta_syntax_documentation")}}">Metadaten</a></li>
		<li><a href="{{url_for("top_syntax_documentation")}}">Tagesordnungspunkte</a></li>
		<li><a href="{{url_for("lists_syntax_documentation")}}">Listen</a></li>
		<li><a href="{{url_for("internal_syntax_documentation")}}">Interne Abschnitte</a></li>
		<li><a href="{{url_for("tags_syntax_documentation")}}">Tags</a></li>
39
	</ul>
40
{% endblock %}