documentation-syntax-internal.html 3.05 KB
Newer Older
1
2
{% extends "documentation-base.html" %}
{% set active_page = "internal_syntax_documentation" %}
3
{% block title %}Syntax: Interne Abschnitte{% endblock %}
4
5

{% block documentation_content %}
6
    <h3>Syntax: Interne Abschnitte</h3>
7
	{% if config.PRIVATE_KEYWORDS %}
8
	<p>
9
	Das Protokollsystem ermöglicht es, in einem Protokoll bestimmte Abschnitte als nicht-öffentlich/intern zu kennzeichnen. Diese Abschnitte werden nur in der internen pdf-Datei gedruckt und nur internen Personen angezeigt - wer das ist lässt sich im System explizit festlegen. Die öffentliche Version des Protokolls enthält dann an betroffenen Stellen einen Hinweis, dass es hier einen internen Abschnitt gibt. Aus Gründen der Transparenz bietet es sich an, vor oder nach dem internen Protokollieren dessen Inhalt zusammenzufassen.
10
11
12
13
	</p>
	<p>
	Beschlüsse sind im Protokollsystem immer öffentlich, daher ergibt es keinen Sinn diese in einem internen Abschnitt zu protokollieren.
	</p>
markus scheller's avatar
markus scheller committed
14
	<h4>Definition</h4>
15
16
17
	<div class="row">
        <div class="col-sm-9">
			<p>
18
			Der interne Abschnitt wird eingeleitet mit einem der folgenden Wörter ({{config.PRIVATE_KEYWORDS|map("code_key")|join(" ")|safe}}) gefolgt von den üblichen geschweiften Klammern <code>{ ... }</code> einer Liste. Zwischen den Klammern wird wie gewöhnlich protokolliert.
19
20
21
22
23
24
25
			</p>
			<div class="panel panel-default">
				<div class="panel-heading">
					<h5 class="panel-title">Beispiel - Interner Bereich</h5>
				</div>
				<figure id="example_internal" class="panel-body">
					<pre class="highlight"><code>{<span class="kr">TOP</span> <span class="sx">Tagesordnungspunkt</span>
26
	<span class="nv">Dieser Punkt ist öffentlich.</span>
27
	<span class="kr">{{config.PRIVATE_KEYWORDS[0]}}</span> {
28
29
30
		<span class="nv">Dieser Punkt ist intern.</span>
		<span class="nv">Dieser auch, wir diskutieren Kritik an einem namentlich genannten Professor und seiner Vorlesung.</span>
		<span class="nv">Hier entwickeln wir eine Strategie.</span>
31
	}
32
	<span class="nv">Dieser ist wieder öffentlich.</span>
33
	<span class="nv">Es wurde die Kritik an einer Vorlesung kritisiert.</span>
34
}</code></pre>
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
				</figure>
			</div>
		</div>
        <div class="col-sm-3">
			<div class="panel panel-warning">
				<div class="panel-heading">
					<h5 class="panel-title">Zu beachten</h5>
				</div>
				<div class="panel-body ">
					<p>
					Ein interner Abschnitt kann keinen Titel haben. Stattdessen wird der Titel durch das entsprechende Schlüsselwort ersetzt.
					</p>
				</div>
            </div>
        </div>
    </div>
51
52
53
54
55
56
57
	{% else %}
	<div class="panel panel-warning">
        <div class="panel-heading">
            <h5 class="panel-title">Nutzung nicht vorgesehen</h5>
        </div>
        <div class="panel-body ">
			<p>
58
			Die Verwendung von internen Abschnitte ist hier bisher noch nicht vorgesehen. Um interne Abschnitte nutzen zu können, wende dich bitte an die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a> und lasse die <a href="{{url_for("settings_configuration_documentation")}}">Konfiguration</a> durch sie entsprechend anpassen.
59
60
61
62
			</p>
		</div>
	</div>
	{% endif %}
63
{% endblock %}