documentation-sessionmanagement-write.html 14.4 KB
Newer Older
1
2
{% extends "documentation-base.html" %}
{% set active_page = "write_sessionmanagement_documentation" %}
3
{% block title %}Sitzungsverwaltung: Protokollieren{% endblock %}
4
5

{% block documentation_content %}
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
    <h3>Sitzungsverwaltung: Protokollieren</h3>
	<p>
	Der wichtigeste Bestandteil des Protokollsystems ist sicherlich das Schreiben des Protokolls selbst. Ist eine Sitzung <a href="plan#prepare">fertig vorbereitet</a> und beginnt die Sitzung in wenigen Minuten so kann das benötigte <a href="plan#find">Protokoll ausgewählt</a> werden. Anschließend kann das Mitschreiben beginnen.
	</p>
	<p>
	Der folgende allgemeine Ablauf soll einen Überblick der Schritte geben, die beim Protokollieren im Protokollsystem vorgenommen werden. Dabei ist der Prozess in drei Phasen unterteilt:
	</p>
	<ul>
		<li><a href="#session_start">Mit Beginn einer Sitzung</a></li>
		<li><a href="#session_run">Während einer Sitzung</a></li>
		<li><a href="#session_end">Nach der Sitzung</a></li>
	</ul>	
	
	<h4 id="session_start">Mit Beginn einer Sitzung</h4>
	<p>
	Kurz bevor die Sitzung los geht oder mit dem Beginn der Sitzung wird das Protokoll erzeugt und die offenen <a href="/documentation/syntax/meta">Metadaten</a> ausgefüllt. Um dies zu erreichen werden die folgenden Schritte durchgeführt.
	</p>
	<ol>
		<li>Stelle sicher, dass alle mit dem Vorprotokollieren fertig sind.</li>
		{% if config.ETHERPAD_ACTIVE %}
		<li>Durch betätigen des Knopfes „Etherpad“ das Etherpad mit dem Protokoll öffnen. <i>Bitte beachte: Nur beim ersten Betätigen werden die TOPs und die vorprotokollierten Inhalte ins Etherpad übertragen.</i></li>
		{% else %}
		<li>Durch betätigen des Knopfes „Vorlage“ eine Textdatei mit der Protokollvorlage herunterladen.</li>
		{% endif %}
	</ol>
	<div class="panel panel-default">
        <div class="panel-heading">
            <h5 class="panel-title"><a data-toggle="collapse" href="#example_create_protocoll">Beispiel - Protokoll{% if config.ETHERPAD_ACTIVE %} ins Etherpad übertragen{% else %}vorlage herunterladen{% endif %}</a></h5>
        </div>
        <div id="example_create_protocoll" class="panel-body panel-collapse collapse">
			<div class="btn-group">
				{% if config.ETHERPAD_ACTIVE %}
				<a class="btn btn-primary" href="#example_create_protocoll">Aus Etherpad</a>
				{% endif %}
				<a class="btn btn-default" href="#example_create_protocoll">Editieren</a>
				{% if config.ETHERPAD_ACTIVE %}
				<a class="btn btn-primary" href="#example_create_protocoll" onclick="return confirm('Bist du dir sicher, dass du das Template bereits in das Etherpad kopieren willst? Die Sitzung ist erst einigen Tagen.');">Etherpad</a>
				{% endif %}
				<a class="btn btn-default" href="#example_create_protocoll">Vorlage</a>
				{% if config.MAIL_ACTIVE %}
				<a class="btn btn-default" href="#example_create_protocoll" onclick="return confirm('Bist du dir sicher, dass du manuell eine Einladung verschicken willst? Dies wird auch automatisch geschehen.');">Einladung versenden</a>
				{% endif %}
				<a class="btn btn-default" href="#example_create_protocoll">Typ</a>
			</div>
		</div>
	</div>
	
	<h4 id="session_run">Während einer Sitzung</h4>
	<p>
	Läuft eine Sitzung so gibt es neben der <a href="/documentation/syntax">Syntax</a> des Protokolls auch weitere Punkte zu beachten.
	</p>
	<ul>
		{% if config.ETHERPAD_ACTIVE %}
		<li>Schreibe das Protokoll im Etherpad.</li>
		{% endif %}
		<li>Fülle alle benötigten <a href="/documentation/syntax/meta">Metadatenfelder</a>.</li>
		<li>Falls <a href="/documentation/syntax/tags#todo">Todos</a> erledigt sind, markiere diese als erledigt.</li>
		<li>Erfasse Beschlüsse die während einer Sitzung getroffen werden mit dem <a href="/documentation/syntax/tags#decision">Beschluss-Tag</a>.</li>
		<li>Nutze auch die anderen <a href="/documentation/syntax/tags">Tags</a>, wo diese erforderlich sind.</li>
	</ul>
	<div class="panel panel-default">
        <div class="panel-heading">
            <h5 class="panel-title"><a data-toggle="collapse" href="#example_example_protocoll">Beispiel - Ausschnitt eines Protokolls</a></h5>
        </div>
70
71
72
73
74
75
76
77
78
        <figure id="example_example_protocoll" class="panel-body panel-collapse collapse">
			<pre class="highlight"><code><span class="nc">#Datum</span>;<span class="mi">14.03.2018</span>
<span class="nc">#Beginn</span>;<span class="mi">17:00</span>
<span class="nc">#Ende</span>;<span class="mi"></span>
<span class="cl">...</span>
<span class="nt">[todo</span>;<span class="s1">Diese Aufage ist noch offen</span>;<span class="kr">id</span> <span class="mi">5</span>;<span class="kt">erledigt</span><span class="nt">]</span>
<span class="cl">...</span>
<span class="nt">[beschluss</span>;<span class="s1">Die Sitzung genehmigt das Protokoll einstimmig</span><span class="nt">]</span></code></pre>
		</figure>
79
80
81
82
83
84
85
86
	</div>
	
	<h4 id="session_end">Nach der Sitzung</h4>
	<p>
	Ist die Sitzung zu Ende so kann die Protokoll-PDF-Datei erzeugt werden. Nicht immer klappt dies Reibungslos und gelegentlich schleichen sich Rechtschreibfehler ein, weshalb die folgenden Schritte dazu dienen Fehler so weit wie möglich zu entfernen.
	</p>
	<ol>
		{% if config.ETHERPAD_ACTIVE %}
87
		<li>Importiere das Protokoll am Ende der Sitzung mit „Aus Etherpad“.</li>
88
		{% else %}
89
		<li>Importiere das Protokoll am Ende der Sitzung über „Hochladen &rarr; Quellcode“.</li>
90
		{% endif %}
91
        <li>Falls Fehler beim Erstellen PDF-Date der auftreten, behebe diese und importiere das Protkoll erneut. Ein Auflistung wird dir nach dem Aktualisieren der Webseite oder auf der <a href="{{url_for("list_errors")}}">Fehlerübersichtsseite</a> angezeigt.</li>
92
	</ol>
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
	<div class="panel panel-default">
        <div class="panel-heading">
            <h5 class="panel-title"><a data-toggle="collapse" href="#example_import_protocoll">Beispiel - Protokoll importieren</a></h5>
        </div>
        <div id="example_import_protocoll" class="panel-body panel-collapse collapse">
			{% if config.ETHERPAD_ACTIVE %}
			<div class="btn-group">
				<a class="btn btn-primary" href="#example_import_protocoll">Aus Etherpad</a>
				<a class="btn btn-default" href="#example_import_protocoll">Editieren</a>
				<a class="btn btn-primary" href="#example_import_protocoll" onclick="return confirm('Bist du dir sicher, dass du das Template bereits in das Etherpad kopieren willst? Die Sitzung ist erst einigen Tagen.');">Etherpad</a>
				<a class="btn btn-default" href="#example_import_protocoll">Vorlage</a>
				{% if config.MAIL_ACTIVE %}
				<a class="btn btn-default" href="#example_import_protocoll" onclick="return confirm('Bist du dir sicher, dass du manuell eine Einladung verschicken willst? Dies wird auch automatisch geschehen.');">Einladung versenden</a>
				{% endif %}
				<a class="btn btn-default" href="#example_import_protocoll">Typ</a>
			</div>
			{% else %}
			<form role="form" class="">
				<div class="form-group  ">
					<label for="source" class="control-label"><label for="source">Quellcode</label></label>
					<input class="form-control" id="source" name="source" placeholder="Quellcode" title="" type="file">
				</div>
				<button type="button" class="btn btn-default">Hochladen</button>
			</form>
			{% endif %}
		</div>
	</div>
	
	<p>
	Nach dem das Sitzungsprotokoll vorläufig fertiggestellt ist, kann in den Korrekturprozess eingestiegen werden.
	</p>
	<ol>
		{% if config.MAIL_ACTIVE %}
        <li>Wenn keine Fehler mehr auftreten, verschicke das Protokoll mit „Intern versenden”.</li>
		{% else %}
		<li>Wenn keine Fehler mehr auftreten, gib den Sitzungsteilnehmern Bescheid, dass das Protkoll fertiggestellt ist. Das Protokoll kann mit „Download” heruntergeladen werden.</li>
		{% endif %}
        <li>Lasse das Protokoll korrekturlesen und korrigieren.</li>
		{% if config.ETHERPAD_ACTIVE %}
		<li>Importiere das Protokoll nach den Korrekturen erneut mit „Aus Etherpad“.</li>
		{% else %}
		<li>Importiere das Protokoll nach den Korrekturen erneut über „Hochladen &rarr; Quellcode“.</li>
		{% endif %}
	</ol>
	<div class="panel panel-default">
        <div class="panel-heading">
            <h5 class="panel-title"><a data-toggle="collapse" href="#example_corect_protocoll">Beispiel - Protokoll korrekturlesen</a></h5>
        </div>
        <div id="example_corect_protocoll" class="panel-body panel-collapse collapse">
			<div class="btn-group">
				{% if config.ETHERPAD_ACTIVE %}
				<a class="btn btn-default" href="#example_corect_protocoll">Aus Etherpad</a>
				{% endif %}
				<a class="btn btn-primary" href="#example_corect_protocoll">Quelltext</a>
				<a class="btn btn-success" href="#example_corect_protocoll">Editieren</a>
				{% if config.ETHERPAD_ACTIVE %}
				<a class="btn btn-primary" href="#example_corect_protocoll" onclick="return confirm('Bist du dir sicher, dass du das Template bereits in das Etherpad kopieren willst? Die Sitzung ist erst einigen Tagen.');">Etherpad</a>
				{% endif %}
				{% if config.MAIL_ACTIVE %}
                <a class="btn btn-default" href="#example_corect_protocoll">Intern versenden</a>
				{% endif %}
				<a class="btn btn-default" href="#example_corect_protocoll">Veröffentlichen</a>
				<a class="btn btn-default" href="#example_corect_protocoll">Typ</a>
				<a class="btn btn-success" href="#example_corect_protocoll">Download</a>
			</div>
		</div>
	</div>
	
	<p>
	Sind die Korrekturen abgeschlossen, so kann zur Veröffentlichung geschritten werden.
	</p>
	<ol>
        <li>Warte alle Korrekturen ab. Ggf. werden letzte Korrekturen mit einer etwaigen Genehmigung des Protokolls auf der nächsten Sitzung vorgenommen.</li>
		<li>Veröffentliche das Protkoll mit „Veröffentlichen“.</li>
		{% if config.MAIL_ACTIVE %}
		<li>Versende das Protkoll ggf. über den öffentenlichen Verteiler mit „Öffentlich versenden“.</li>
		{% endif %}
	</ol>
	<div class="panel panel-default">
        <div class="panel-heading">
            <h5 class="panel-title"><a data-toggle="collapse" href="#example_publish_protocoll">Beispiel - Protokoll veröffentlichen und versenden</a></h5>
        </div>
        <ul id="example_publish_protocoll" class="list-group panel-collapse collapse">
			<li class="list-group-item">
				<div class="btn-group">
					{% if config.ETHERPAD_ACTIVE %}
					<a class="btn btn-default" href="#example_publish_protocoll">Aus Etherpad</a>
					{% endif %}
					<a class="btn btn-primary" href="#example_publish_protocoll">Quelltext</a>
					<a class="btn btn-success" href="#example_publish_protocoll">Editieren</a>
					{% if config.ETHERPAD_ACTIVE %}
					<a class="btn btn-primary" href="#example_publish_protocoll" onclick="return confirm('Bist du dir sicher, dass du das Template bereits in das Etherpad kopieren willst? Die Sitzung ist erst einigen Tagen.');">Etherpad</a>
					{% endif %}
					{% if config.MAIL_ACTIVE %}
					<a class="btn btn-default" href="#example_publish_protocoll">Intern versenden</a>
					{% endif %}
					<a class="btn btn-default" href="#example_publish_protocoll">Veröffentlichen</a>
					<a class="btn btn-default" href="#example_publish_protocoll">Typ</a>
					<a class="btn btn-success" href="#example_publish_protocoll">Download</a>
				</div>
			</li>
			<li class="list-group-item">
				<div class="btn-group">
					<a class="btn btn-primary" href="#example_publish_protocoll">Quelltext</a>
					{% if config.MAIL_ACTIVE %}
					<a class="btn btn-default" href="#example_publish_protocoll">Intern versenden</a>
					<a class="btn btn-default" href="#example_publish_protocoll">Öffentlich versenden</a>
					{% endif %}
					<a class="btn btn-default" href="#example_publish_protocoll">Typ</a>
					<a class="btn btn-success" href="#example_publish_protocoll">Download</a>
				</div>
			</li>
		</ul>
	</div>
207
208
209
	
	{% if config.ETHERPAD_ACTIVE %}
	<h4>Bekannte Problem bei der Etherpadnutzung</h4>
210
211
	<h5><b>Leeres Etherpad</b></h5>
	<p>
212
	Wird mit „Etherpad“ ein Pad geöffnet und es ist leer bzw. beinhaltet nur den Standardtext, so sollte das Etherpad mit „Etherpad“ erneut geöffnet werden. Schlägt das ganze fehl, wende dich bitte an an die <a href="mailto:{{config.ADMIN_MAIL}}">Admins</a>.
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
	</p>
	<h5><b>Etherpad zu früh geöffnet</b></h5>
	<p>
	Wurde das Pad zu früh erstellt und es wurden noch nicht alle TOPs bzw. alle vorprotokollierten Teil in das Pad übernommen und es zu aufwendig ist diese manuell einzufügen, so lösche den Inhalt des Pad und öffne das Pad erneut mit „Etherpad“.
	</p>
	<h5><b>Höchst interne Protokolle</b></h5>
    <p>
	Falls das Protokoll Daten beinhaltet, die auf keinen Fall öffentlich sein sollten (z.B. personenbezogene Daten bei einem Sozialausschuss), kann anstelle des Editierens im Etherpad auch mit „Vorlage“ die leere Protokollvorlage heruntergeladen werden. Darin kann lokal mit einem beliebigen Texteditor die Sitzung protokolliert werden, um sie dann am Ende lokal zu speichern und mit „Quellcode hochladen“ hochzuladen.
	</p>
	<div class="panel panel-default">
        <div class="panel-heading">
            <h5 class="panel-title"><a data-toggle="collapse" href="#example_internal_protocoll">Beispiel - Höchst interne Protokolle</a></h5>
        </div>
        <ul id="example_internal_protocoll" class="list-group panel-collapse collapse">
			<li class="list-group-item">
				<div class="btn-group">
					{% if config.ETHERPAD_ACTIVE %}
					<a class="btn btn-primary" href="#example_internal_protocoll">Aus Etherpad</a>
					{% endif %}
					<a class="btn btn-default" href="#example_internal_protocoll">Editieren</a>
					{% if config.ETHERPAD_ACTIVE %}
					<a class="btn btn-primary" href="#example_internal_protocoll" onclick="return confirm('Bist du dir sicher, dass du das Template bereits in das Etherpad kopieren willst? Die Sitzung ist erst einigen Tagen.');">Etherpad</a>
					{% endif %}
					<a class="btn btn-default" href="#example_internal_protocoll">Vorlage</a>
					{% if config.MAIL_ACTIVE %}
					<a class="btn btn-default" href="#example_internal_protocoll" onclick="return confirm('Bist du dir sicher, dass du manuell eine Einladung verschicken willst? Dies wird auch automatisch geschehen.');">Einladung versenden</a>
					{% endif %}
					<a class="btn btn-default" href="#example_internal_protocoll">Typ</a>
				</div>
			</li>
			<li class="list-group-item">
				<form role="form" class="">
					<div class="form-group  ">
						<label for="source" class="control-label"><label for="source">Quellcode</label></label>
						<input class="form-control" id="source" name="source" placeholder="Quellcode" title="" type="file">
					</div>
					<button type="button" class="btn btn-default">Hochladen</button>
				</form>
			</li>
		</ul>
	</div>
254
	{% endif %}
255
{% endblock %}