Skip to content

Commit

Permalink
Update the help pages
Browse files Browse the repository at this point in the history
  • Loading branch information
CatoTH committed Jun 20, 2021
1 parent 5b1217d commit 51f5b01
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 31 deletions.
37 changes: 23 additions & 14 deletions plugins/antragsgruen_sites/views/manager/help_de.php
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@
Textentwürfe, Bewerbungen einschließlich Fotos, Satzungen usw. verwaltet werden.</p>
<p>Änderungsanträge beziehen sich unmittelbar auf einen Antrag (bzw. andere eingestellte Texte) und haben den Zweck,
diesen zu verändern. Antragsgrün will vor allem die Handhabung vieler Änderungsanträge pro Antrag vereinfachen
und formalisiert diese daher stark: beim Einreichen eines Änderungsantrags muss explizit angegeben werden, die
und formalisiert diese daher stark: beim Einreichen eines Änderungsantrags muss explizit angegeben werden, wie
der Antrag nach der beantragten Änderung aussehen soll. Antragsgrün kann so automatisch die tatsächlichen
Änderungen feststellen, den ursprünglichen Antrag so annotieren, dass leicht ersichtlich ist, zu welchen
Passagen es Alternativvorschläge gibt, und auf Wunsch die Änderungen in den ursprünglichen Antrag
Expand All @@ -154,7 +154,7 @@
werden soll.</p>
<!-- @TODO: Verzeichnis -->

<h3 id="antragstypen">Antragstypen / Motion Type</h3>
<h3 id="antragstypen">Antragstypen</h3>
<p>Innerhalb einer Veranstaltung kann es verschieden strukturierte Dokumente geben – oder Dokumente, die
unterschiedlichen Regelungen unterliegen, z.B. was Antragsfristen oder Berechtigungen zum Anlegen angeht.
Beispielsweise benötigen Bewerbungen andere Angaben (Name, Selbstvorstellung, Foto, weitere Angaben, …) als
Expand All @@ -177,7 +177,7 @@
eine Vorstandswahl könnte es beispielsweise für die Wahl eines jeden Vorstandsposten einen Tagesordnungspunkt
geben, jeder mit dem Antragstyp „Bewerbung“; so können dann Bewerbungen gezielt für einen bestimmten Posten
eingereicht werden.</p>
<p>Um Tagesordnungen zu aktivieren: Erst unter „Einstellungen“ in der Unterseite „Diese Veranstaltung“ bei
<p>Um Tagesordnungen zu aktivieren: Erst unter „Einstellungen“ in der Unterseite „Aussehen und Bestandteile der Seite“ bei
„Startseiten-Design“ einen der beiden Tagesordnungspunkt-Punkte auswählen. Dann kann man auf der Startseite neue
Tagesordnungspunkte anlegen.</p>
<!-- @TODO: Genauere Erklärung zur Nummerierung von Tagesordnungspunkten -->
Expand Down Expand Up @@ -240,8 +240,8 @@
Benutzer*innen das Login erlauben“ aktiviert werden. Anschließend erscheint weiter unten der Punkt
„Benutzer*innen-Accounts“, in dem neue Mitglieder eingeladen werden können.</p>
<p>Wenn Antragsgrün in Organisationen verwendet werden soll, die eine Single-Sign-On-Lösung verwenden, lässt sich
die Authentifizierung auf weitere Mechanismen ausweiten; produktiv kamen Bereits OpenID- sowie SAML-Konnektoren
zum Einsatz. Für weitere Informationen schreiben Sie uns bitte einfach an.</p>
die Authentifizierung auf weitere Mechanismen ausweiten; produktiv kamen Bereits OpenID- und SAML-Konnektoren
sowie Integrationen in CRM-Systeme (z.B. CiviCRM) zum Einsatz. Für weitere Informationen schreiben Sie uns bitte einfach an.</p>

<h3 id="antragsschluss">Antragsschluss</h3>
<p>Wenn das Einreichen von Anträgen oder Änderungsanträgen nur bis zu einem bestimmten Zeitpunkt möglich sein soll,
Expand Down Expand Up @@ -392,7 +392,8 @@
OpenSlides angepasst ist. Anträge und Änderungsanträge, die im Vorfeld einer Tagung in Antragsgrün eingereicht
und vorbereitet wurden, können so kurz vor der Tagung leicht in einen bestehenden Openslides-Ablauf integriert
werden.</p>
<p>Den Export gibt es für Admins der Veranstaltung im Menüpunkt „Antragsliste“.</p>
<p>Den Export gibt es für Admins der Veranstaltung im Menüpunkt „Antragsliste“, nachdem der Export einmalig auf dieser Seite
unter „Funktionen” → „Openslides-Export” aktiviert wurde.</p>

<h3 id="export_weitere">HTML, Plain Text, RSS, Weitere Formate</h3>
<p>Generell ist es recht leicht, weitere Formate zu unterstützen. Ein paar weitere Formate werden daher bereits
Expand All @@ -403,11 +404,14 @@
<h2 id="weitere_funktionen">Weitere Funktionen</h2>
<h3 id="layout">Layout-Anpassbarkeit</h3>
<p>Verschiedene Aspekte des Layouts von Antragsgrün lassen sich über das Administrationsinterface anpassen – die
meisten davon unter „Einstellungen“ → „Diese Veranstaltung“ → „Aussehen“.</p>
meisten davon unter „Einstellungen“ → „Aussehen und Bestandteile der Seite“.</p>
<p>Am stärksten wirkt sich die „Layout“-Einstellung aus: sie verändert das komplette Aussehen der Seite und wird
genutzt, um eine entwickelte Anpassung an ein Corporate Design zu aktivieren. Neben dem
„Antragsgrün-Standard“-Layout gibt es derzeit Layouts, die teils für den Deutschen Bundesjugendring, teils für
Bündnis 90 / Die Grünen entwickelt wurden. Weitere grundlegend andere Layouts können entweder von halbwegs
Bündnis 90 / Die Grünen entwickelt wurden. Unter „Eigenes Farbschema anlegen” lassen sich auch Farben,
Schriftgrößen und einige weitere Aspekte des Layouts (wie Schattierungen oder Abrundungen) an die eigene
Corporate Identity anpassen.</p>
<p>Weitere grundlegend andere Layouts können entweder von halbwegs
versierten Web-Entwickler*innen selbst entwickelt werden (siehe „<a
href="https://github.com/CatoTH/antragsgruen">Developing custom themes</a>“), oder bei uns in Auftrag
gegeben werden.</p>
Expand Down Expand Up @@ -461,16 +465,16 @@
</li>
</ul>

<h3 id="themen">Themen / Tags</h3>
<h3 id="themen">Themen / Schlagworte</h3>
<p>Anträge lassen sich auf der Startseite nicht nur streng hierarchisch in einer Tagesordnung darstellen, sondern
auch nach nach vorgegebenen Schlagworten gliedern. Der wichtigste Unterschied dabei ist, dass ein Antrag auch
mehrere Themen / Schlagworte gleichzeitig haben kann (auf der Startseite also z.B. sowohl unter „Verkehr“ als
auch „Umwelt“ auftauchen kann). Welche Themen zur Auswahl stehen, kann von der Leitung der Veranstaltung
vorgegeben werden. Antragsteller*innen können beim Einreichen eines Antrags Themen auswählen.</p>
<p>Man aktiviert diese Darstellung unter „Einstellungen“ → „Diese Veranstaltung“, indem man zuerst bei
Startseiten-Design“ den Punkt „Themen / Schlagworte“ wählt und weiter unten bei „Anträge“ die verschiedenen
Themen anlegt, die zur Auswahl stehen sollen. Im allgemeinen wird auch die Einstellung „Mehrere Themen pro
Antrag möglich“ gleich darunter empfehlenswert sein.</p>
<p>Man aktiviert diese Darstellung unter „Einstellungen“ → „Aussehen und Bestandteile der Seite“, indem man zuerst bei
Startseite & Tagesordnung“ den Punkt „Themen / Schlagworte als Liste“ wählt und unter
„Einstellungen” -> „Diese Veranstaltung” bei „Anträge“ die verschiedenen Themen anlegt, die zur Auswahl stehen sollen.
Im allgemeinen wird auch die Einstellung „Mehrere Themen pro Antrag möglich“ gleich darunter empfehlenswert sein.</p>

<h3 id="kommentare">Kommentare</h3>
<p>Sowohl Anträge als auch Änderungsanträge können kommentiert werden, sofern dies von der Veranstaltungsleitung
Expand Down Expand Up @@ -501,7 +505,7 @@
sammeln“-Phase verwendet, die weiter oben beschrieben wurde)</p>

<h3 id="uebersetzen">Übersetzung der Seite / Anpassungen des Wordings</h3>
<p>Antragsgrün unterstützt drei Stufen der sprachlichen Anpassung:</p>
<p>Antragsgrün unterstützt mehrere Stufen der sprachlichen Anpassung:</p>
<ul>
<li>Pro Veranstaltung lassen sich sämtliche Texte auf der Oberfläche von Antragsgrün über die
Administrations-Oberfläche anpassen, unter „Einstellungen“ → „Sprache anpassen“. Diese Möglichkeit lässt
Expand All @@ -525,6 +529,11 @@
Welche Sprachvariante verwendet werden soll, kann pro Veranstaltung unter „Einstellungen“ → „Sprache
anpassen“ → „Basis-Sprachversion“ ausgewählt werden.
</li>
<li>
Einige sprachliche Anpassungen können auch pro Antragstyp festgelegt werden - beispielsweise die Einleitung der
Bestätigungsmail beim Einreichen von Anträgen oder Bewerbungen, oder die einleitende Erklärung beim Einreichen.
Diese kann man beim jeweilgen Antragstyp unter „Antragstyp-spezifische Texte / Übersetzungen” eingeben.
</li>
</ul>

</div>
34 changes: 17 additions & 17 deletions plugins/antragsgruen_sites/views/manager/help_en.php
Original file line number Diff line number Diff line change
Expand Up @@ -159,11 +159,10 @@
different posts to be elected. The latter ones would get the motion type “Application”, making it possible to
apply specifically for, say, treasurer or chairwoman.</p>
<p>Using the agenda feature has to be explicitly activated, either while initializing the site using the initial
questionnaire, or afterwards by going to “Settings” → “This consultation” and choosing one of the two
“Agenda”-Styles from the “Homepage style” drop-down. After that, the agenda can be created on the home page of
questionnaire, or afterwards by going to “Settings” → “Appearance and components of this site” and choosing one of the two
“Agenda”-Styles from the “Homepage / Agenda” drop-down. After that, the agenda can be created on the home page of
the consultation.</p>


<h2 id="workflow">Workflow: Submission, screening, permissions</h2>

<h3 id="proposers">Proposers, Supporters</h3>
Expand Down Expand Up @@ -222,7 +221,7 @@
section “User accounts” appears, allowing to invite new users by entering their name and e-mail-address.</p>
<p>If Antragsgrün is supposed to leverage an existing Single-Sign-On-Solution, it is possible to include other log
in mechanisms. For example, Antragsgrün has been successfully deployed in environments providing OpenID- and
SAML-based SSO. If you are interested in that topic, please contact us.</p>
SAML-based SSO as well as integration into CRM-systems (e.g. CiviCRM). If you are interested in that topic, please contact us.</p>

<h3 id="deadlines">Deadlines</h3>

Expand Down Expand Up @@ -360,13 +359,6 @@ functional impact on Antragsgrün, this is helpful for users to get a quick over
OpenOffice of LibreOffice.</p>
<p>This export is available for administrators in the motion list (“Motions” at the very top).</p>

<h3 id="openslides">OpenSlides / CSV</h3>

<p>Several organizations using Antragsgrün to prepare all motions and amendments are using OpenSlides to as a
presentation system for their assemblies. Therefore, Antragsgrün also supports a CSV-Export that is specifically
aimed to be imported by both major versions of OpenSlides.</p>
<p>This export is available for administrators in the motion list (“Motions” at the very top).</p>

<h3 id="export_misc">HTML, Plain Text, RSS, further formats</h3>

<p>It’s pretty easy to add further export formats. There are several already: for example, an export to plain HTML,
Expand All @@ -380,9 +372,11 @@ functional impact on Antragsgrün, this is helpful for users to get a quick over
→ “This consultation” → “Appearance”.</p>
<p>The “Layout”-setting has the biggest impact: it completely changes the design of the whole site and is used to
activate adaptions to other corporate designs. Aside from the default layout, two themes are included that have
been developed for the German Federal Youth Council and the German Green Party. If you want to develop your own
custom theme, we have put some instructions on how to do so on our <a
href="https://github.com/CatoTH/antragsgruen">Github page (“Developing custom themes”)</a>.</p>
been developed for the German Federal Youth Council and the German Green Party. However, using the
“Create custom theme” page it is possible to change colors, font sizes and several other aspects of the layout
according to your Corporate Identity using the web interface.</p>
<p>If that flexibility is not enough and it is necessary to modify the theme in a more structural way, we have put
some instructions on how to do so on our <a href="https://github.com/CatoTH/antragsgruen">Github page (“Developing custom themes”)</a>.</p>
<p>For the home page of a consultation, there are several variants available (“Homepage style” in the settings),
targeted towards different use cases. This setting is necessary to activate the agenda on the homepage or to
enable the tagging feature (see further below).</p>
Expand Down Expand Up @@ -440,8 +434,9 @@ functional impact on Antragsgrün, this is helpful for users to get a quick over
that multiple tags can be assigned to each motion, instead of only one agenda item. For example, one motion can
be assigned both the tags “Environment” and “Traffic”. The administrators of a consultation can specify the list
of available tags. Users can then choose fitting tags when submitting a motion.</p>
<p>The tagging system can be activated at “Settings” → “This consultation”, by choosing “Tags” at the “Homepage
style”. The list of available tags can then be set further below on the same page in the “Motion”-Section at
<p>The tagging system can be activated at “Settings” → “Appearance and components of this site”,
by choosing “Tags / categories” at the “Homepage / Agenda” selection.
The list of available tags can be specified at “Settings” → “This consultation” in the “Motion”-Section at
“Available tags”.</p>

<h3 id="comments">Comments</h3>
Expand Down Expand Up @@ -471,7 +466,7 @@ functional impact on Antragsgrün, this is helpful for users to get a quick over
case, but is used for the “Call for supporter”-phase described above)</p>

<h3 id="translation">Translations / Changing the wording</h3>
<p>Antragsgrün supports three ways of change and internationalize the user interface and the wording:</p>
<p>Antragsgrün supports several ways of change and internationalize the user interface and the wording:</p>
<ul>
<li>For each consultation, it is possible to change all strings of the user interface using the web interface.
This can be done at “Settings” → “Edit the language”. This can be used to change a few words, change the
Expand All @@ -488,5 +483,10 @@ functional impact on Antragsgrün, this is helpful for users to get a quick over
difference of this method compared to using the web interface as described in point 1 is that translations
created like this can be used by other consultations as well.
</li>
<li>
Some changes can be made to the wording regarding specific motion types. For example, the confirmatin e-mail
or explanation could be different when submitting a motion and an application. These specific texts can be
entered at the repective motion type at “Motion type specific texts / translations”.
</li>
</ul>
</div>

0 comments on commit 51f5b01

Please sign in to comment.