From 1bc99e45ef2db91a307f81da40ab6ad73372a276 Mon Sep 17 00:00:00 2001
From: Markus Scheller <scheller_m@live.de>
Date: Sun, 11 Mar 2018 17:10:41 +0100
Subject: [PATCH] Reviewed syntax section about the keyword internal
protokollsystem/proto3#172
---
templates/documentation-syntax-internal.html | 63 +++++++++++++-------
1 file changed, 41 insertions(+), 22 deletions(-)
diff --git a/templates/documentation-syntax-internal.html b/templates/documentation-syntax-internal.html
index 31d0348..739ae34 100644
--- a/templates/documentation-syntax-internal.html
+++ b/templates/documentation-syntax-internal.html
@@ -1,27 +1,46 @@
{% extends "documentation-base.html" %}
{% set active_page = "internal_syntax_documentation" %}
+{% block title %}Syntax: Interne Abschnitte{% endblock %}
{% block documentation_content %}
- <h3>Interne Abschnitte</h3>
- {% if config.PRIVATE_KEYWORDS|length > 0 %}
- <h4 id="intern">Interne Abschnitte</h4>
- Wenn der Name einer Liste (bis auf Leerzeichen und einen optionalen <code>:</code>) eins aus
- {{config.PRIVATE_KEYWORDS|map("code")|join(" ")|safe}}
- ist, ist diese Liste intern.
- Daher wird sie nur in der internen Version des Protokolls angezeigt.
- In der öffentlichen Version steht stattdessen nur ein Hinweis auf diese interne Stelle.
- Es bietet sich beim Protokollieren an, wenn nach dem internen Bereich kurz dessen Inhalt zusammengefasst wird (natürlich nur sofern dies geht ohne die Interna zu verraten), oder begründet wird, warum dies intern ist.
-<pre>
-{TOP Tagesordnungspunkt
- Dieser Punkt ist öffentlich.
- {{config.PRIVATE_KEYWORDS[0]}}: {
- Dieser Punkt ist intern.
- Dieser auch, wir diskutieren Kritik an einem namentlich genannten Professor und seiner Vorlesung.
- Hier entwickeln wir eine Strategie.
- }
- Dieser ist wieder öffentlich.
- Es wurde die Krtik an einer Vorlesung kritsiert.
-}
-</pre>
-{% endif %}
+ <h3>Syntax: Interne Abschnitte</h3>
+ {% if config.PRIVATE_KEYWORDS|length > 0 %}
+ <p>
+ Das Protokollsystem unterstützt in einem öffentlichen Protokoll bestimmte Abschnitte als nicht-öffentlich/intern zu kennzeichnen. Diese internen Abschnitte werden nur Personen mit dem entsprechendem Recht angezeigt und auch nur in der internen pdf-Datei gedruckt. Die öffentliche Version des Protokolls enthält an dieser Stelle einen Hinweis, auf einen internen Abschnitt. Aus Gründen der Transparenz bietet es sich an vor oder nach dem internen Protokollieren dessen Inhalt zusammenzufassen.
+ </p>
+ <p>
+ Beschlüsse sind im Protokollsystem immer öffentlich, daher ergibt es keinen Sinn diese in einem internen Abschnitt zu protokollieren.
+ </p>
+ <p>
+ Der interne Abschnitt wird eingeleitet mit einem der folgenden Wörter ({{config.PRIVATE_KEYWORDS|map("code")|join(" ")|safe}}) gefolgt von den üblichen geschweiften Klammern <code>{ ... }</code>. Zwischen den Klammern wird wie gewöhnlich protokolliert.
+ </p>
+ <div class="panel panel-default">
+ <div class="panel-heading">
+ <h5 class="panel-title"><a data-toggle="collapse" href="#example_internal">Beispiel - Interner Bereich</a></h5>
+ </div>
+ <figure id="example_internal" class="panel-body panel-collapse collapse highlight">
+ <pre><code>{TOP Tagesordnungspunkt
+ Dieser Punkt ist öffentlich.
+ {{config.PRIVATE_KEYWORDS[0]}}: {
+ Dieser Punkt ist intern.
+ Dieser auch, wir diskutieren Kritik an einem namentlich genannten Professor und seiner Vorlesung.
+ Hier entwickeln wir eine Strategie.
+ }
+ Dieser ist wieder öffentlich.
+ Es wurde die Krtik an einer Vorlesung kritsiert.
+}</code></pre>
+ </figure>
+ </div>
+ {% else %}
+ <div class="panel panel-warning">
+ <div class="panel-heading">
+ <h5 class="panel-title">Nutzung nicht vorgesehen</h5>
+ </div>
+ <div class="panel-body ">
+ <p>
+ 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 Konfiguration durch sie entsprechend anpassen.
+ </p>
+ </div>
+ </div>
+ {% endif %}
{% endblock %}
--
GitLab