Skip to content
GitLab
Commit ca2c4af6 authored by markus scheller's avatar markus scheller
Browse files

Make some corrections and add an example 

#172
parent 35d35a1b
Hide whitespace changes
Inline Side-by-side
templates/documentation-syntax-internal.html
View file @ ca2c4af6
......@@ -12,17 +12,19 @@
Beschlüsse sind im Protokollsystem immer öffentlich, daher ergibt es keinen Sinn diese in einem internen Abschnitt zu protokollieren.
</p>
<h4>Definition</h4>
<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">
<pre class="highlight"><code>{<span class="kr">TOP</span> <span class="sx">Tagesordnungspunkt</span>
<div class="row">
<div class="col-sm-9">
<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> einer Liste. Zwischen den Klammern wird wie gewöhnlich protokolliert.
</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>
<span class="nv">Dieser Punkt ist öffentlich.</span>
<span class="kr">{{config.PRIVATE_KEYWORDS[0]}}</span><span class="o">:</span> {
<span class="kr">{{config.PRIVATE_KEYWORDS[0]}}</span> {
<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>
......@@ -30,8 +32,22 @@
<span class="nv">Dieser ist wieder öffentlich.</span>
<span class="nv">Es wurde die Krtik an einer Vorlesung kritsiert.</span>
}</code></pre>
</figure>
</div>
</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>
{% else %}
<div class="panel panel-warning">
<div class="panel-heading">
......
templates/documentation-syntax-lists.html
View file @ ca2c4af6
......@@ -16,29 +16,57 @@
<p>
Die Liste ist im Protokoll das strukturierende Element. Es beginnt und endet mit einer geschweiften Klammer. Die Elemente der Liste werden durch das Zeilenende getrennt. Es ist möglich Listen beliebig ineinander zuschachteln. Zusätzlich kann eine Liste einen Titel haben, der vor der öffnenden Klammer <code>{</code> steht.
</p>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">Syntax einer Liste</h5>
</div>
<figure class="panel-body">
<pre class="highlight"><code><span class="sx">Titel der Liste</span> {
<span class="c1">Details zu diesem Punkt.</span>
<span class="c1">Mehr Details zu diesen Punkt in einer neuen Zeile.</span>
}</code></pre>
</figure>
</div>
</div>
<div class="col-sm-3 panel panel-warning">
<div class="panel-heading">
<h5 class="panel-title">Zu beachten</h5>
</div>
<div class="panel-body ">
<ul>
<li>Spezielle Listen weisen hinsichtlich des Titels ein anders Verhalten auf.</li>
<li>Listen in der höchsten Ebene müssen <a href="top">TOPs</a> sein.</li>
</ul>
<div class="col-sm-3">
<div class="panel panel-warning">
<div class="panel-heading">
<h5 class="panel-title">Zu beachten</h5>
</div>
<ul class="list-group">
<li class="list-group-item">Spezielle Listen weisen hinsichtlich des Titels ein anders Verhalten auf.</li>
<li class="list-group-item">Listen in der höchsten Ebene müssen <a href="top">TOPs</a> sein.</li>
</ul>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">Syntax einer Liste</a></h5>
</div>
<figure class="panel-body">
<pre class="highlight"><code><span class="sx">Titel der Liste</span>{
<span class="c1">Details zu diesem Punkt.</span>
<span class="c1">Mehr Details zu diesen Punkt in einer neuen Zeile.</span>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title"><a data-toggle="collapse" href="#example_lists">Beispiel - Verschachtelte Listen</a></h5>
</div>
<figure id="example_lists" class="panel-body panel-collapse collapse">
<pre class="highlight"><code>{<span class="kr">TOP</span> <span class="sx">Bericht</span>
Es wird über die Aktivitäten seit der letzten Sitzung berichtet.
<span class="sx">Erstsemesterarbeit</span>{
Die Vorbereitung für die nächste Erstsemesterwoche laufen. Ab dieser Woche werden auch wieder regelmäßige Planungstreffen stattfinden.
}
<span class="sx">Infrastruktur</span>{
Es fand ein Treffen statt auf dem aktuelle Projekte besprochen wurden.
<span class="sx">Wasserspender</span>{
Es wurden Vorschläge für Aufstellorte von weiteren Wasserspendern gemacht.
Weiteres wird geprüft.
}
<span class="sx">Luftpumpen</span>{
Es sollen Luftpumpen angeschafft werden.
Ein Angebot wird eingeholt
}
<span class="sx">Renovierung</span>{
Eine Renovierung ist geplant.
Anforderungen sollen gesammelt werden.
}
}
}</code></pre>
</figure>
</div>
</figure>
</div>
{% endblock %}
templates/documentation-syntax-top.html
View file @ ca2c4af6
......@@ -16,26 +16,28 @@
<p>
In Protokollsystax wird ein Tagesordnungspunkt stets von geschweiften Klammern eingeschlossen. An die öffnende Klammer schließt sich das Schlüsselwort <code>TOP</code> an. Abgesetzt mit einem Leerzeichen folgt der Titel des TOPs. Nach einem Zeilenumbruach als in einer neuen Zeile beginnt dann der Inhalt des Tagesordnungspunkts. Durch die Verwendung von sogenannten <a href="lists">Listen</a> kann die Mitschrift in einem Tagesordnungspunkt strukturiert werden.
</p>
</div>
<div class="col-sm-3 panel panel-warning">
<div class="panel-heading">
<h5 class="panel-title">Zu beachten</h5>
</div>
<div class="panel-body ">
<p>
Innerhalb eines Tagesordnungspunkts kann es keinen weiteren Tagesordnungspunkt geben.
</p>
</div>
</div>
</div>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">Syntax eines Tagesordnungspunkts</a></h5>
</div>
<figure class="panel-body">
<pre class="highlight"><code>{<span class="kr">TOP</span> <span class="sx">Titel des Tagesordnungspunkts</span>
<div class="panel panel-default">
<div class="panel-heading">
<h5 class="panel-title">Syntax eines Tagesordnungspunkts</a></h5>
</div>
<figure class="panel-body">
<pre class="highlight"><code>{<span class="kr">TOP</span> <span class="sx">Titel des Tagesordnungspunkts</span>
<span class="c1">Hier steht der Inhalt des Tagesordnungspunkts</span>
}</code></pre>
</figure>
</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>
Innerhalb eines Tagesordnungspunkts kann es keinen weiteren Tagesordnungspunkt geben.
</p>
</div>
</div>
</div>
</div>
{% endblock %}
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment