docs: replace `:` with `*` (#74)

also fix some wording

Reviewed-on: #74
Co-authored-by: leonard.koenig <leonard.koenig@jdav-hd.merten.dev>
Co-committed-by: leonard.koenig <leonard.koenig@jdav-hd.merten.dev>
pull/75/head
leonard.koenig 1 year ago committed by Christian Merten
parent 308e4e31f5
commit 307884deb8

@ -3,7 +3,7 @@
Ausfahrten
==========
Neben der :ref:`Teilnehmer:innenverwaltung <members>` ist das Abwickeln von Ausfahrten
Neben der :ref:`Teilnehmer\*innenverwaltung <members>` ist das Abwickeln von Ausfahrten
die zweite wichtige Aufgabe des Kompass. Eine Ausfahrt für die eigene Jugendgruppe
anbieten ist neben der ganzen inhaltlichen Arbeit auch jede Menge bürokratischer Aufwand. Der Kompass
versucht dir von diesem Aufwand so viel wie möglich abzunehmen.
@ -20,11 +20,11 @@ Konkret hilft dir der Kompass dabei
Stammdaten
----------
Sobald du mit deinen Co-Jugendleiter:innen eine Ausfahrt angedacht hast, kannst du diese im Kompass `anlegen`_.
Sobald du mit deinen Co-Jugendleiter\*innen eine Ausfahrt angedacht hast, kannst du diese im Kompass `anlegen`_.
Die bekannten Informationen trägst du schon ein, die noch unbekannten lässt du leer oder trägst
vorläufige Daten ein.
Wenn du weißt wer mitkommt, trägst du im Tab *Teilnehmer:innen* alle ein, die zur Ausfahrt kommen.
Wenn du weißt wer mitkommt, trägst du im Tab *Teilnehmer\*innen* alle ein, die zur Ausfahrt kommen.
.. _crisis-intervention-list:
@ -32,7 +32,7 @@ Kriseninterventionsliste
------------------------
Bevor die Ausfahrt stattfindet, lässt du dir eine Kriseninterventionsliste mit allen Notfallkontakten der
Mitfahrer:innen erstellen und schickst sie an die Geschäftsstelle.
Mitfahrer\*innen erstellen und schickst sie an die Geschäftsstelle.
Landesjugendplanantrag
----------------------

@ -3,7 +3,7 @@ Finanzen
Auf dieser Seite wird das Einreichen, Bearbeiten und Abwickeln von Abrechnungen
erklärt. Diese Seite ist für Finanzbeauftragte der Sektion gedacht und daher
für die meisten Benutzer:innen des Kompass unwichtig.
für die meisten Benutzer\*innen des Kompass unwichtig.
.. warning::
Diese Seite ist noch im Aufbau.

@ -8,27 +8,27 @@ Seite der richtige Einstieg. Wir verfolgen in dieser Anleitung den Jugendleiter
Fritz Walter bei seinen ersten Schritten mit seinem Kompass. Fritz Walter leitet
die Gruppe *Kletterfüchse*.
Wie finde ich die Teilnehmer:innen meiner Jugendgruppe?
-------------------------------------------------------
Wie finde ich die Teilnehmer\*innen meiner Jugendgruppe?
--------------------------------------------------------
Auf der `Startseite`_ siehst du eine Auflistung der von dir geleiteten Jugendgruppen.
Klickst du auf eine der Gruppen landest du in der `Teilnehmer:innenanzeige`_.
Klickst du auf eine der Gruppen landest du in der `Teilnehmer\*innenanzeige`_.
.. image:: images/members_changelist_filters.png
Fritz hat die Gruppe *Kletterfüchse* ausgewählt, wie du oben rechts sehen kannst.
Versuche einmal dort bei dir eine andere Gruppe auszuwählen. Falls dir keine Teilnehmer:innen
Versuche einmal dort bei dir eine andere Gruppe auszuwählen. Falls dir keine Teilnehmer\*innen
angezeigt werden liegt das daran, dass deine *Zugriffsrechte* nicht ausreichen.
Wie ändere ich eine:n Teilnehmer:in meiner Jugendgruppe?
--------------------------------------------------------
Wie ändere ich eine\*n Teilnehmer\*in meiner Jugendgruppe?
----------------------------------------------------------
Fritz möchte das eingetragene Geburtsdatum von *Lisa Lotte* ändern. Dazu klickt
er auf den entsprechenden Eintrag, ändert das Geburtsdatum und klickt auf *Speichern*.
.. note::
Nicht alle Einträge in der `Teilnehmer:innenanzeige`_ sind klickbar. Das liegt daran,
dass du manche Teilnehmer:innen zwar sehen, aber nicht ihre Details einsehen kannst.
Nicht alle Einträge in der `Teilnehmer\*innenanzeige`_ sind klickbar. Das liegt daran,
dass du manche Teilnehmer\*innen zwar sehen, aber nicht ihre Details einsehen kannst.
Manche Einträge wiederum kannst du einsehen, aber nicht bearbeiten.
Probier doch einmal aus deinen eigenen Eintrag zu ändern. Sicherlich gibt es einige
@ -72,6 +72,6 @@ Nun hat Fritz den Bürokratiekram für heute erledigt. Du willst noch mehr wisse
geh zurück zum :ref:`index`.
.. _Startseite: https://jdav-hd.de/kompass
.. _Teilnehmer:innenanzeige: https://jdav-hd.de/kompassmembers/member/
.. _Teilnehmer\*innenanzeige: https://jdav-hd.de/kompassmembers/member/
.. _Nachricht verfassen: https://jdav-hd.de/kompassmailer/message/add/
.. _Ausfahrten: https://jdav-hd.de/kompassmembers/freizeit/

@ -16,7 +16,7 @@ Was ist der Kompass?
Der Kompass ist eine Verwaltungsplattform für die tägliche Jugendarbeit in der JDAV.
Die wichtigsten Funktionen sind
- Verwaltung von Teilnehmer:innen von Jugendgruppen
- Verwaltung von Teilnehmer\*innen von Jugendgruppen
- Organisation von Ausfahrten
- Abwicklung von Abrechnungen
- Senden von E-Mails

@ -3,16 +3,16 @@
Jugendgruppenverwaltung
=======================
Das wichtigste Objekt im Kompass ist ein:e Teilnehmer:in. Hier meint ein:e Teilnehmer:in ein im
Das wichtigste Objekt im Kompass ist ein\*e Teilnehmer\*in. Hier meint ein\*e Teilnehmer\*in ein im
Kompass hinterlegtes Mitglied der JDAV deiner Sektion, das heißt ob 5-jähriges Jugendgruppenkind,
langgediente:r Jugendleiter:in oder frischgebackene:r Jugendreferent:in, alle haben
einen Eintrag als Teilnehmer:in im Kompass. Insbesondere heißt das, dass auch du selbst hier einen
langgediente\*r Jugendleiter\*in oder frischgebackene\*r Jugendreferent\*in, alle haben
einen Eintrag als Teilnehmer\*in im Kompass. Insbesondere heißt das, dass auch du selbst hier einen
Eintrag hast.
Der Startpunkt der Teilnehmer:innenverwaltung ist der Abschnitt `Meine Jugendgruppe`_. Hier siehst du
Der Startpunkt der Teilnehmer\*innenverwaltung ist der Abschnitt `Meine Jugendgruppe`_. Hier siehst du
in der Regel zwei Menüpunkte:
- Teilnehmer:innen
- Teilnehmer\*innen
- Ausfahrten
In diesem Abschnitt geht es nur um den ersten Menüpunkt. Falls du etwas über den zweiten Menüpunkt
@ -23,10 +23,10 @@ lernen möchtest, kannst du zu :ref:`excursions` springen.
oder die Verwaltung der Warteliste zuständig ist, siehst du hier noch mehr Punkte. Mehr
Informationen dazu findest du unter :ref:`waitinglist`.
Teilnehmer:innen Übersicht
--------------------------
Teilnehmer\*innen Übersicht
---------------------------
Um eine Übersicht über alle Teilnehmer:innen zu bekommen, klicke auf `Teilnehmer:innen`_. Hier siehst du
Um eine Übersicht über alle Teilnehmer\*innen zu bekommen, klicke auf `Teilnehmer\*innen`_. Hier siehst du
nun alle Mitglieder, für die du die einfachen Anzeigeberechtigungen hast, das heißt deren Namen du sehen darfst.
Typischerweise sind das die Gruppenkinder deiner Jugendgruppe, aber vielleicht noch zusätzlich alle Mitglieder
des Jugendausschuss.
@ -34,7 +34,7 @@ des Jugendausschuss.
Wie sehe ich meine Gruppenkinder?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Oberhalb der großen Auflistung mit allen Teilnehmer:innen siehst du verschiedene Auswahlfelder.
Oberhalb der großen Auflistung mit allen Teilnehmer\*innen siehst du verschiedene Auswahlfelder.
Eines davon heißt *Nach Gruppe*. Wenn du dort drauf klickst, kannst du die Ansicht nach einer Gruppe
filtern.
@ -45,7 +45,7 @@ In der selben Zeile siehst du noch weitere Filtermöglichkeiten.
Ich möchte nach Alter sortieren, wie geht das?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Standardmäßig ist die Teilnehmer:innenanzeige nach Nachname sortiert, wie du im folgenden Bild an dem
Standardmäßig ist die Teilnehmer\*innenanzeige nach Nachname sortiert, wie du im folgenden Bild an dem
kleinen Pfeil erkennen kannst:
.. image:: images/members_changelist_sorting.png
@ -57,20 +57,20 @@ Wieso sehe ich nicht alle meine Gruppenkinder?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Hast du deine Gruppe ausgewählt und siehst trotzdem nicht alle deine Gruppenkinder auf einer Seite?
Dann liegt das vermutlich daran, dass deine Gruppe mehr als 25 Teilnehmer:innen hat. Chapeau!
Dann liegt das vermutlich daran, dass deine Gruppe mehr als 25 Teilnehmer\*innen hat. Chapeau!
In diesem Fall kannst du unten Rechts auf der Seite zwischen den verschiedenen Seiten auswählen oder
alle auf einmal anzeigen lassen:
.. image:: images/members_changelist_pages.png
.. _Meine Jugendgruppe: https://jdav-hd.de/kompassmembers
.. _Teilnehmer:innen: https://jdav-hd.de/kompassmembers/member/
.. _Teilnehmer\*innen: https://jdav-hd.de/kompassmembers/member/
Teilnehmer:in Detailansicht
---------------------------
Teilnehmer\*in Detailansicht
----------------------------
Möchtest du eine:n Teilnehmer:in im Detail ansehen, um zum Beispiel Personendaten, wie die Anschrift
Möchtest du eine\*n Teilnehmer\*in im Detail ansehen, um zum Beispiel Personendaten, wie die Anschrift
nachzuschauen oder eine Änderung an den Daten machen, klicke auf den entsprechenden Eintrag in der Liste.
Die nun folgende Seite kann auf den ersten Blick ein wenig erschlagen, daher dröseln wir hier die wichtigsten
@ -81,7 +81,7 @@ Punkte auf. Zunächst ist die Seite in mehrere Reiter unterteilt:
Diese sind
- Allgemein: wichtigste Informationen wie Name und E-Mail Adresse
- Kontaktinformationen: Anschrift, Kontodaten (für Jugendleiter:innen beim Abwickeln von Ausfahrten)
- Kontaktinformationen: Anschrift, Kontodaten (für Jugendleiter\*innen beim Abwickeln von Ausfahrten)
- Fähigkeiten: z.B. alpine Erfahrungen
- Sonstiges: z.B. medizinische Daten
- Notfallkontakte: Liste mit Namen und mindestens Telefonnummern. Mehr Informationen
@ -98,47 +98,47 @@ Wieso kann ich nicht alle Felder ändern?
Manche Felder werden dir nur angezeigt, sind aber nicht änderbar. Das sind entweder
- geschützte Felder, für die du besondere Berechtigungen benötigst um sie zu ändern
(z.B. das *Gruppe* Feld). Um diese Felder zu ändern, wende dich an deine:n Jugendreferent:in
(z.B. das *Gruppe* Feld). Um diese Felder zu ändern, wende dich an deine\*n Jugendreferent\*in
für Jugendkoordination. Oder,
- automatisch berechnete Felder wie zum Beispiel das *Rückgemeldet* Feld.
Wieso haben manche Einträge in der Teilnehmer:innenübersicht keinen Link?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Wieso haben manche Einträge in der Teilnehmer\*innenübersicht keinen Link?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Die Teilnehmer:innen die dir in der Übersicht angezeigt werden sind diejenigen für die du
einfache Ansichtberechtigungen hast. Um die Personendetails eines:einer Teilnehmer:in einzusehen,
Die Teilnehmer\*innen die dir in der Übersicht angezeigt werden sind diejenigen für die du
einfache Ansichtberechtigungen hast. Um die Personendetails eines\*einer Teilnehmer\*in einzusehen,
benötigst du normale Ansichtberechtigungen. Falls du diese nicht hast, wird anstatt des Links
in der Übersicht nur der Name angezeigt.
Falls du denkst, dass du eine:n Teilnehmer:in einsehen können solltest, aber es nicht kannst, melde
dich gerne bei deine:r Jugendreferent:in für Jugendkoordination.
Falls du denkst, dass du eine\*n Teilnehmer\*in einsehen können solltest, aber es nicht kannst, melde
dich gerne bei deine\*r Jugendreferent\*in für Jugendkoordination.
.. _echo:
Rückmeldung
-----------
Damit die Teilnehmer:innendaten im Kompass aktuell bleiben, kannst du jederzeit deine Gruppenkinder
zu einer Rückmeldung auffordern. Dazu wählst du in der Teilnehmer:innenübersicht alle
Teilnehmer:innen aus, die du zur Rückmeldung auffordern möchtest,
Damit die Teilnehmer\*innendaten im Kompass aktuell bleiben, kannst du jederzeit deine Gruppenkinder
zu einer Rückmeldung auffordern. Dazu wählst du in der Teilnehmer\*innenübersicht alle
Teilnehmer\*innen aus, die du zur Rückmeldung auffordern möchtest,
.. image:: images/members_changelist_action.png
und wählst dann im Menü unten links *Rückmeldungsaufforderungen an ausgewählte Teilnehmer:innen verschicken*
und wählst dann im Menü unten links *Rückmeldungsaufforderungen an ausgewählte Teilnehmer\*innen verschicken*
aus. Um die Aufforderungen zu verschicken, musst du dann nur noch auf *Ausführen* klicken.
Was passiert nach der Aufforderung zur Rückmeldung?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Der:die ausgewählte Teilnehmer:in erhält eine E-Mail mit einem Link. Dieser Link führt zu einem Formular,
in dem die Person ihr Geburtsdatum eingeben muss.
Der\*die ausgewählte Teilnehmer\*in erhält eine E-Mail mit einem Link. Dieser Link führt auf eine
Seite auf der die Person ihr Geburtsdatum eingeben muss.
.. note::
Das Geburtsdatumsformat ist Tag-Tag-Monat-Monat-Jahr-Jahr, also wenn Peter am
Das Geburtsdatumsformat ist TT.MM.JJJJ, also wenn Peter am
1.4.1999 geboren ist, müsste er *01.04.1999* eingeben.
Nach erfolgreich eingegebenem Geburtsdatum, wird die Person auf ein Formular mit ihren Daten weitergeleitet.
Dann einfach prüfen, gegebenenfalls aktualisieren und schließlich speichern. Der Link ist dann
Dann einfach prüfen, gegebenenfalls aktualisieren und schließlich speichern. Der Link ist
immer 30 Tage lang gültig und kann in dieser Zeit auch beliebig oft benutzt werden.
Klingt alles noch abstrakt? Dann fordere doch mal dich selbst zur Rückmeldung auf und probiere es aus.
@ -148,13 +148,13 @@ Klingt alles noch abstrakt? Dann fordere doch mal dich selbst zur Rückmeldung a
Notfallkontakte
---------------
Im Notfall helfen uns die Anschrift oder Telefonnummer einer:eines Teilnehmer:in nicht weiter. Stattdessen
Im Notfall helfen uns die Anschrift oder Telefonnummer einer\*eines Teilnehmer\*in nicht weiter. Stattdessen
benötigen wir Kontaktdaten von Personen, die wir im Notfall kontaktieren können. Diese können
im Reiter *Kontaktdaten* gepflegt werden. Bei der initialen Registrierung muss jede:r Teilnehmer:in
im Reiter *Notfallkontakte* gepflegt werden. Bei der initialen Registrierung muss jede\*r Teilnehmer\*in
mindestens einen Notfallkontakt angeben.
.. note::
Bei vielen Teilnehmer:innen sind keine Notfallkontakte eingetragen. Das liegt dann vermutlich daran,
Bei vielen Teilnehmer\*innen sind keine Notfallkontakte eingetragen. Das liegt dann vermutlich daran,
dass die aus einem anderen System migriert wurden und daher nicht verfügbar sind.
Bei der regelmäßigen :ref:`echo` werden die Notfallkontakte ebenfalls abgefragt. Falls
@ -166,5 +166,5 @@ Was bringen mir die Notfallkontakte im Kompass?
Passiert ein Notfall auf einer Ausfahrt, wirst du natürlich nicht immer die Möglichkeit
haben im Kompass die Notfallkontakte herauszusuchen. Daher kannst du dir zu jeder Ausfahrt
eine :ref:`crisis-intervention-list` generieren lassen, die zu allen Teilnehmer:innen deiner Ausfahrt
eine :ref:`crisis-intervention-list` generieren lassen, die zu allen Teilnehmer\*innen deiner Ausfahrt
auch alle Notfallkontakte auflistet.

@ -4,7 +4,7 @@ Warteliste und neue Mitglieder
==============================
Hier wird die Warteliste erklärt und verschiedene Möglichkeiten erläutert, wie
neue Teilnehmer:innen angelegt werden können.
neue Teilnehmer\*innen angelegt werden können.
.. warning::
Diese Seite ist noch im Aufbau.

Loading…
Cancel
Save