From 0a4bac2df624835264a7a48de65e224d7557fa41 Mon Sep 17 00:00:00 2001
From: Markus Scheller <scheller_m@live.de>
Date: Sun, 18 Mar 2018 11:38:52 +0100
Subject: [PATCH] Added internal parts to configuration documentation
protokollsystem/proto3#172
---
templates/documentation-configuration-settings.html | 6 ++++++
templates/documentation-syntax-internal.html | 4 ++--
2 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/templates/documentation-configuration-settings.html b/templates/documentation-configuration-settings.html
index c115ee6..799ad89 100644
--- a/templates/documentation-configuration-settings.html
+++ b/templates/documentation-configuration-settings.html
@@ -41,6 +41,11 @@
<td><span class="glyphicon glyphicon-{% if config.CALENDAR_ACTIVE %}ok{% else %}remove{% endif %}" aria-hidden="true"></span></td>
<td>Das System kann eingetragene Sitzungstermine in einen Kalender übertragen.</td>
</tr>
+ <tr>
+ <td>Nutzung interner Abschnitte</td>
+ <td><span class="glyphicon glyphicon-{% if config.PRIVATE_KEYWORDS %}ok{% else %}remove{% endif %}" aria-hidden="true"></span></td>
+ <td>Das System bietet die Möglichkeit bestimmte Abschnitte als nicht-öffentlich/intern zu kennzeichnen.</td>
+ </tr>
<tr>
<td>Angepasste Standardvorlage</td>
<td><span class="glyphicon glyphicon-{% if (config.LATEX_LOCAL_TEMPLATES and config.LATEX_LOGO_TEMPLATE) or config.LATEX_GEOMETRY or config.LATEX_PAGESTYLE or config.LATEX_ADDITIONAL_PACKAGES or config.LATEX_HEADER_FOOTER %}ok{% else %}remove{% endif %}" aria-hidden="true"></span></td>
@@ -54,6 +59,7 @@
</tbody>
</table>
{% if system_administrator and git_revision %}
+ <h4>Hinweise für Administratoren</h4>
<p>
Eine Beschreibung der Einrichtung des einzelnen Features kann der Projektseite der Software <a href="{{git_revision.url}}">„Protokollsystem 3“</a> entnommen werden. Bitte lies dir die <code>README.md</code> aufmerksam durch und entnimm bei Bedarf Konfigurationsbeispiele aus <code>config.py.example</code>. Bei schwerwiegenden Problemen kontaktiere die <a href="{{git_revision.url}}/project_members">Entwickler</a>.
</p>
diff --git a/templates/documentation-syntax-internal.html b/templates/documentation-syntax-internal.html
index 3902e46..59dd254 100644
--- a/templates/documentation-syntax-internal.html
+++ b/templates/documentation-syntax-internal.html
@@ -4,7 +4,7 @@
{% block documentation_content %}
<h3>Syntax: Interne Abschnitte</h3>
- {% if config.PRIVATE_KEYWORDS|length > 0 %}
+ {% if config.PRIVATE_KEYWORDS %}
<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>
@@ -55,7 +55,7 @@
</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.
+ 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="/documentation/configuration/settings">Konfiguration</a> durch sie entsprechend anpassen.
</p>
</div>
</div>
--
GitLab