Skip to content
Snippets Groups Projects
Commit ca2c4af6 authored by markus scheller's avatar markus scheller
Browse files

Make some corrections and add an example

parent 35d35a1b
No related branches found
No related tags found
1 merge request!11Resolve "Dokumentation überarbeiten"
...@@ -12,17 +12,19 @@ ...@@ -12,17 +12,19 @@
Beschlüsse sind im Protokollsystem immer öffentlich, daher ergibt es keinen Sinn diese in einem internen Abschnitt zu protokollieren. Beschlüsse sind im Protokollsystem immer öffentlich, daher ergibt es keinen Sinn diese in einem internen Abschnitt zu protokollieren.
</p> </p>
<h4>Definition</h4> <h4>Definition</h4>
<div class="row">
<div class="col-sm-9">
<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. 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> </p>
<div class="panel panel-default"> <div class="panel panel-default">
<div class="panel-heading"> <div class="panel-heading">
<h5 class="panel-title"><a data-toggle="collapse" href="#example_internal">Beispiel - Interner Bereich</a></h5> <h5 class="panel-title">Beispiel - Interner Bereich</h5>
</div> </div>
<figure id="example_internal" class="panel-body panel-collapse collapse"> <figure id="example_internal" class="panel-body">
<pre class="highlight"><code>{<span class="kr">TOP</span> <span class="sx">Tagesordnungspunkt</span> <pre class="highlight"><code>{<span class="kr">TOP</span> <span class="sx">Tagesordnungspunkt</span>
<span class="nv">Dieser Punkt ist öffentlich.</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 Punkt ist intern.</span>
<span class="nv">Dieser auch, wir diskutieren Kritik an einem namentlich genannten Professor und seiner Vorlesung.</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> <span class="nv">Hier entwickeln wir eine Strategie.</span>
...@@ -32,6 +34,20 @@ ...@@ -32,6 +34,20 @@
}</code></pre> }</code></pre>
</figure> </figure>
</div> </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 %} {% else %}
<div class="panel panel-warning"> <div class="panel panel-warning">
<div class="panel-heading"> <div class="panel-heading">
......
...@@ -16,27 +16,55 @@ ...@@ -16,27 +16,55 @@
<p> <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. 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> </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>
<div class="col-sm-3">
<div class="panel panel-warning">
<div class="panel-heading"> <div class="panel-heading">
<h5 class="panel-title">Zu beachten</h5> <h5 class="panel-title">Zu beachten</h5>
</div> </div>
<div class="panel-body "> <ul class="list-group">
<ul> <li class="list-group-item">Spezielle Listen weisen hinsichtlich des Titels ein anders Verhalten auf.</li>
<li>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>
<li>Listen in der höchsten Ebene müssen <a href="top">TOPs</a> sein.</li>
</ul> </ul>
</div> </div>
</div> </div>
</div> </div>
<div class="panel panel-default"> <div class="panel panel-default">
<div class="panel-heading"> <div class="panel-heading">
<h5 class="panel-title">Syntax einer Liste</a></h5> <h5 class="panel-title"><a data-toggle="collapse" href="#example_lists">Beispiel - Verschachtelte Listen</a></h5>
</div> </div>
<figure class="panel-body"> <figure id="example_lists" class="panel-body panel-collapse collapse">
<pre class="highlight"><code><span class="sx">Titel der Liste</span>{ <pre class="highlight"><code>{<span class="kr">TOP</span> <span class="sx">Bericht</span>
<span class="c1">Details zu diesem Punkt.</span> Es wird über die Aktivitäten seit der letzten Sitzung berichtet.
<span class="c1">Mehr Details zu diesen Punkt in einer neuen Zeile.</span> <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> }</code></pre>
</figure> </figure>
</div> </div>
......
...@@ -16,8 +16,19 @@ ...@@ -16,8 +16,19 @@
<p> <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. 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> </p>
<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>
</div>
</div> </div>
<div class="col-sm-3 panel panel-warning"> <div class="col-sm-3">
<div class="panel panel-warning">
<div class="panel-heading"> <div class="panel-heading">
<h5 class="panel-title">Zu beachten</h5> <h5 class="panel-title">Zu beachten</h5>
</div> </div>
...@@ -28,14 +39,5 @@ ...@@ -28,14 +39,5 @@
</div> </div>
</div> </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>
<span class="c1">Hier steht der Inhalt des Tagesordnungspunkts</span>
}</code></pre>
</figure>
</div> </div>
{% endblock %} {% endblock %}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment