Differences

This shows you the differences between two versions of the page.

--- de:2.0:individueller_aufruf_der_module [2016/04/03 13:05] – [Links zu den Modulen:] henner
+++ de:2.0:individueller_aufruf_der_module [2024/12/08 19:01] (current) – [Welche Links und Parameter sind verfügbar?] greno
@@ Line 1: / Line 1: @@
 ====== Individueller Aufruf der Module ======
-Nachdem du Admidio erfolgreich installiert hast, kannst du verschiedene Module in Deine Homepage integrieren. Admidio liefert von Haus aus eine Reihe Module (Ankündigungen, Termine, Listen, Profile ...) mit. Diese kannst du alle auf der Übersichtsseite sehen.
+===== Welche Module kann ich aufrufen? =====
+Admidio läuft in der Regel als eigenständiges Programm, welches du über einen Link von deiner bestehenden Homepage aufrufen kannst. Vielleicht möchtest du aber auch einzelne Module oder Seiten von Admidio direkt verlinken. Eine Übersicht der möglichen Module liefert dir unser Menü. Daneben gibt es aber noch weitere Seiten welche du direkt einbinden und ggf. über weitere Parameter an deine Vorstellungen anpassen kannst.
-{{:de:2.0:moduluebersicht.png|}}
+{{:de:2.0:documentation:menu_sidebar_de.png?200|}}
-Dazu kommen noch verschiedene Administrationsdialoge, die ebenfalls auf der Übersichtsseite erscheinen, wenn du dich als Webmaster eingeloggt hast.
-{{:de:2.0:adminuebersicht.png|}}
 Jedes dieser Module funktioniert eigenständig. Das heißt, du kannst einen Link zu diesem Modul an jeder beliebigen Stelle von Deiner Homepage aus setzen. Sollte eine Benutzeranmeldung erforderlich sein, so wird die Loginseite automatisch aufgerufen. Ist der Benutzer einmal angemeldet, so kann er zwischen den Admidio-Modulen und Ihren eigenen Seiten beliebig navigieren und muss sich nicht noch einmal anmelden.
-Um die Sicherheit zu erhöhen sollten Sie aber einen Link zur Loginseite und zum Logout auf Ihrer Homepage einbauen.
+Um die Sicherheit zu erhöhen solltest du aber einen Link zur Loginseite und zum Logout auf deiner Homepage einbauen.
-===== Links zu den Modulen: =====
+===== Welche Links und Parameter sind verfügbar? =====
-Die folgenden Links zu den Modulen sind hier aus Platzgründen zweizeilig dargestellt. Sie müssen dann natürlich zusammengeschrieben verlinkt werden.
+Alle Parameter, die hier angegeben werden, sind optional. Jedes Modul kann ohne die jeweiligen Parameter aufgerufen werden. Du solltest diese nur übergeben, falls die gewünschte Änderung benötigt wird.
-Alle Parameter, die hier angegeben werden, sind optional. Jedes Modul kann ohne die jeweiligen Parameter aufgerufen werden. du solltest diese nur übergeben, falls die gewünschte Änderung benötigt wird.
+Die Parameter werden direkt an die URL angehangen. Du setzt einfach ein **?** hinter die URL und kannst dann den Parameternamen schreiben. Nach einem **=** folgt dann der Wert. Willst du mehr als einen Parameter anhängen, so werden die Parameter durch ein **&** voneinander getrennt.
-Die Parameter werden direkt an die URL angehangen. du setzt einfach ein **?** hinter die URL und kannst dann den Parameternamen schreiben. Nach einem **=** folgt dann der Wert. Willst du mehr als einen Parameter anhängen, so werden die Parameter durch ein **&** voneinander getrennt.
+''Beispiel: http://www.example.org/.../messages_write.php?role_uuid=550e8400-e29b-11d4-a716-446655440000&subject=Meine-erste-email''
-''Beispiel: http://www.example.org/.../mail.php?rolle=Webmaster&cat=Allgemein''
 **Hinweis:**
-In der kompletten URL dürfen kein Leerzeichen und Sonderzeichen vorkommen. Dies gilt auch für die Parameter. Falls Sie dennoch einen Wert mit Leerzeichen übergeben wollen, können Sie anstatt dem Leerzeichen einfach **%20** schreiben.
+In der kompletten URL dürfen keine Leerzeichen und Sonderzeichen vorkommen. Dies gilt auch für die Parameter. Falls du dennoch einen Wert mit Leerzeichen übergeben willst, kannst du anstatt dem Leerzeichen einfach **%20** schreiben.
-  * **Loginseite:** Aufruf der Loginseite mit Link zur Registrierung und Weiterleitung zu der in den Einstellungen festgelegten Seite.
+=== Loginseite ===
+Aufruf der Loginseite mit Link zur Registrierung und Weiterleitung zu der in den Einstellungen festgelegten Seite.\\ \\
 ''Link: http://www.example.org/admidio-ordner/adm_program/system/login.php''
-\\
+^ Parameter      ^ Wert              ^ Beschreibung ^
-  * **Logout:** Ausloggen des Benutzers mit Weiterleitung zu der in den Einstellungen festgelegten Seite.
+| organization_short_name      | Kurzname der Organisation       | Der Kurzname einer hinterlegten Organisation, welche auf der Loginseite vorausgewählt sein soll. (ab Version 4.3)  |
+=== Logout ===
+Ausloggen des Benutzers mit Weiterleitung zu der in den Einstellungen festgelegten Seite.\\ \\
 ''Link: http://www.example.org/admidio-ordner/adm_program/system/logout.php''
-\\
+\\ \\
-  * **Registrierung:** Neue Benutzer können sich über dieses Formular registrieren.
+=== Registrierung ===
-''Link: http://www.example.org/admidio-ordner/adm_program/system/registration.php''
+Neue Benutzer können sich über dieses Formular registrieren.\\ \\
-\\
+''Link: http://www.example.org/admidio-ordner/adm_program/modules/profile/profile_new.php''
-  * **Ankündigungen:** Liste mit allen erfassten Ankündigungen. Berechtige Benutzer haben hier die Möglichkeit Ankündigungen zu erfassen, editieren oder zu löschen.
+\\ \\
+=== Ankündigungen ===
+Liste mit allen erfassten Ankündigungen. Berechtige Benutzer haben hier die Möglichkeit Ankündigungen zu erfassen, zu editieren oder zu löschen.\\ \\
 ''Link: http://www.example.org/admidio-ordner/adm_program/modules/announcements/annnouncements.php''
 ^ Parameter ^ Wert        ^ Beschreibung ^
-| headline  | Bezeichnung  | Frei wählbare Bezeichnung für das Modul anstelle von Ankündigungen  |
+| date_from      | Format: Systemeinstellung  | Alle Ankündigungen ab diesem Datum anzeigen lassen.  |
-| date      | Format: YYYYMMDD  | Alle an diesem Datum erstellten Ankündigungen anzeigen lassen  |
+| date_to      | Format: Systemeinstellung  | Alle Ankündigungen bis zu diesem Datum anzeigen lassen.  |
-\\
+| cat_uuid      | UUID einer Kategorie  | Zeigt alle Ankündigungen dieser Kategorie an.  |
-  * **Downloads:** Auflisten von verschiedenen Dateidownloads in einer frei wählbaren Ordnerstruktur. Ordner können auch nur für bestimmte Nutzergruppen freigegeben werden.
+| ann_uuid      | UUID einer Ankündigung  | Zeigt nur diese eine Ankündigung an.  |
-''Link: http://www.example.org/admidio-ordner/adm_program/modules/downloads/downloads.php''
+=== Dokumente & Dateien ===
+Auflisten von verschiedenen Dokumenten oder Dateien in einer frei wählbaren Ordnerstruktur. Ordner können auch nur für bestimmte Nutzergruppen freigegeben werden.\\ \\
+''Link: http://www.example.org/admidio-ordner/adm_program/modules/documents-files/documents_files.php''
 ^ Parameter      ^ Wert              ^ Beschreibung ^
-| folder_id      | ID des Ordners       | Angabe der ID des Downloadordners, der angezeigt werden soll  |
+| folder_uuid      | UUID des Ordners       | Angabe der UUID des Dateiordners, der angezeigt werden soll.  |
-\\
-  * **E-Mail:** Verschicken von E-Mails an alle Mitglieder bestimmter Rollen. Ohne Parameter, kann der angemeldete Benutzer Rollen oder andere Benutzer über eine Auswahlbox auswählen.
+=== E-Mail ===
+Verschicken von E-Mails an alle Mitglieder bestimmter Rollen. Ohne Parameter, kann der angemeldete Benutzer Rollen oder andere Benutzer über eine Auswahlbox auswählen.\\ \\
 ''Link: http://www.example.org/admidio-ordner/adm_program/modules/messages/messages_write.php''
 ^ Parameter ^ Wert         ^ Beschreibung ^
-| rol_id     | Id der Rolle   | Id der Rolle, an deren Mitglieder eine E-Mail geschickt wird.  |
+| role_uuid     | UUID der Rolle   | UUID der Rolle, an deren Mitglieder eine E-Mail geschickt wird.  |
-| usr_id     | Id des Benutzer   | Id des Benutzers, an den eine E-Mail geschickt wird.  |
+| user_uuid     | UUID des Benutzer   | UUID des Benutzers, an den eine E-Mail geschickt wird.  |
 | subject    | Betreff      | Betreff der E-Mail kann hiermit vorbelegt werden.  |
 | carbon_copy  | 1\\ 0(default)  | Flag, ob eine Kopie an den Absender verschickt werden soll.  |
-\\
+| msg_type  | EMAIL (Default)\\ PM  | Angabe ob eine E-Mail oder eine private Nachricht erstellt werden soll.  |
-  * **Fotos:** Anzeige einer Fotogalerie. Berechtigte Benutzer können neue Alben anlegen, pflegen und löschen.
+=== Fotos ===
+Anzeige einer Fotogalerie. Berechtigte Benutzer können neue Alben anlegen, pflegen und löschen.\\ \\
 ''Link: http://www.example.org/admidio-ordner/adm_program/modules/photos/photos.php''
-\\
+^ Parameter ^ Wert        ^ Beschreibung ^
-   * **Grußkarten:** Durch Auswahl eines Bildes im Foto-Modul kann man dieses an einen oder mehrere Empfänger innerhalb der Organisation oder auch außenstehende mit einem beliebigen Text versehen senden.
+| photo_uuid      | UUID eines Albums  | Zeigt die Fotos dieses Albums an.  |
+=== Grußkarten ===
+Durch Auswahl eines Bildes im Foto-Modul kann man dieses an einen oder mehrere Empfänger innerhalb der Organisation oder auch außenstehende mit einem beliebigen Text versehen senden.\\ \\
 ''Link: http://www.example.org/admidio-ordner/adm_program/modules/ecards/ecard_form.php''
-\\
+^ Parameter ^ Wert        ^ Beschreibung ^
-  * **Gästebuch** Ein Gästebuch mit Kommentierfunktion für Mitglieder bestimmter Rollen.
+| photo_uuid      | UUID eines Albums  | UUID des Fotoalbums, dessen Bild du senden möchtest.  |
+| photo_nr      | Nummer eines Fotos  | Nummer des Fotos des gewählten Albums für das eine Grußkarte erstellt werden soll.  |
+| user_uuid      | UUID eines Mitglieds  | Angabe des Mitglieds, an den die Ecard versendet werden soll.  |
+=== Gästebuch ===
+Ein Gästebuch mit Kommentierfunktion für Mitglieder bestimmter Rollen.\\ \\
 ''Link: http://www.example.org/admidio-ordner/adm_program/modules/guestbook/guestbook.php''
 ^ Parameter ^ Wert        ^ Beschreibung ^
-| headline  | Bezeichnung  | Frei wählbare Bezeichnung für das Modul anstelle von Gästebuch  |
+| gbo_uuid      | UUID eines Eintrags  | Zeigt nur diesen Gästebucheintrag an.  |
-\\
-  * **Listen:** Übersicht über alle Rollen mit Aufruf verschiedener Mitgliederlisten zu jeder Rolle.
+=== Gruppen & Rollen ===
-''Link: http://www.example.org/admidio-ordner/adm_program/modules/lists/lists.php''
+Übersicht über alle Rollen mit Aufruf verschiedener Mitgliederlisten zu jeder Rolle.\\ \\
+''Link: http://www.example.org/admidio-ordner/adm_program/modules/groups-roles/groups-roles.php''
 ^ Parameter          ^ Wert            ^ Beschreibung ^
-| category           | Kategoriename   | Name der Kategorie deren Rollen direkt angezeigt werden sollen  |
+| cat_uuid           | UUID einer Kategorie   | UUID einer Kategorie deren Rollen angezeigt werden sollen.  |
-| category-selection  | yes(default)\\ no  | Bei **yes** wird eine Auswahlbox mit allen Kategorien angezeigt und der Benutzer kann die Rollenliste auf eine Kategorie filtern. Bei **no** wird keine Auswahlbox angezeigt.  |
+| role_type  | 0 \\ 1 (Default) \\ 2  | Nur inaktive Rollen\\ Alle aktive Rollen \\ Nur Terminteilnehmerrollen  |
-| active_role        | 1(default)\\ 0    | Bei 1 werden alle aktiven Rollen in der Kategorie anzeigt und bei 0 nur die inaktiven Rollen  |
+| show        | card (default)\\ permissions    | Alle Gruppen und Rollen in der Kartenansicht anzeigen. \\  Berechtigungen aller Gruppen und Rollen in der Listenansicht anzeigen.  |
-\\
-  * **Eigene Listen:** Hier kann eine individuelle Mitgliederliste zu einer Rolle erstellt werden. Spalten, Sortierung und Bedingungen sind frei wählbar.
+=== Eigene Listen ===
-''Link: http://www.example.org/admidio-ordner/adm_program/modules/lists/mylist.php''
+Hier kann eine individuelle Mitgliederliste zu einer Rolle erstellt werden. Spalten, Sortierung und Bedingungen sind frei wählbar.\\ \\
+''Link: http://www.example.org/admidio-ordner/adm_program/modules/groups-roles/mylist.php''
 ^ Parameter     ^ Wert         ^ Beschreibung ^
-| active_role   | 1(default)\\ 0  | Bei 1 werden alle aktiven Rollen der Organisation anzeigt und bei 0 nur die inaktiven Rollen  |
+| list_uuid           | UUID einer Liste   | UUID einer Liste die angezeigt werden sollen.  |
-| active_member  | 1(default)\\ 0  | Bei 1 werden alle aktiven Mitglieder der Rolle anzeigt und bei 0 nur die inaktiven Mitglieder  |
+| active_role   | 1 (default)\\ 0  | Alle aktive Rollen der Organisation\\  Nur die inaktiven Rollen der Organisation  |
-\\
+| show_members  | 0 (default) \\ 1 \\ 2   | Alle aktive Mitglieder\\ Alle ehemalige Mitglieder\\ Alle aktive und ehemalige Mitglieder  |
-  * **Profil:** Das Profil eines Benutzers. Es wird automatisch das Profil des aktuell eingeloggten Benutzers angezeigt.
+=== Profil ===
+Das Profil eines Benutzers. Es wird automatisch das Profil des aktuell eingeloggten Benutzers angezeigt.\\ \\
 ''Link: http://www.example.org/admidio-ordner/adm_program/modules/profile/profile.php''
-\\
+^ Parameter     ^ Wert         ^ Beschreibung ^
-  * **Termine:** Liste mit allen erfassten Terminen. Berechtige Benutzer haben hier die Möglichkeit Termine zu erfassen, editieren oder zu löschen.
+| user_uuid  | UUID eines Benutzers  | Wird dieser Parameter gesetzt, dann wird das Profil dieses Benutzers angezeigt. Ohne den Parameter wird immer das eigene Profil angezeigt.  |
-''Link: http://www.example.org/admidio-ordner/adm_program/modules/dates/dates.php''
+=== Veranstaltungen / Termine ===
+Liste mit allen erfassten Veranstaltungen. Berechtige Benutzer haben hier die Möglichkeit Veranstaltungen zu erfassen, zu editieren oder zu löschen.\\ \\
+''Link: http://www.example.org/admidio-ordner/adm_program/modules/events/events.php''
 ^ Parameter ^ Wert ^ Beschreibung ^
-| calendar-selection  | 1\\ \\ 0  | Eine Auswahlbox mit allen Kalendern angezeigen und der Benutzer kann die Terminliste auf einen Kalender filtern.\\ Keine Auswahlbox angezeigen.  |
+| date_from      | Format: Systemeinstellung  | Alle Veranstaltungen ab diesem Datum anzeigen lassen.  |
-| cat_id  | Id des Kalenders  | Alle Termine für den übergebenen Kalender anzeigen lassen  |
+| date_to      | Format: Systemeinstellung  | Alle Veranstaltungen bis zu diesem Datum anzeigen lassen.  |
-| date      | Format: YYYYMMDD  | Alle Termine für den übergebenen Tag anzeigen lassen   |
+| cat_uuid  | UUID des Kalenders  | Alle Veranstaltungen für den übergebenen Kalender anzeigen lassen.  |
-| headline  | Bezeichnung  | Frei wählbare Bezeichnung für das Modul anstelle von Termine  |
+| dat_uuid      | UUID einer Veranstaltung  | Zeigt nur diese eine Veranstaltung an.  |
-| id  | Id des Termins  | Nur den Termin aus der Id anzeigen.  |
+| mode      | actual(default)\\ old\\ all  | Alle kommenden Veranstaltungen anzeigen.\\ Nur die bereits vergangenen Veranstaltungen   anzeigen.\\ Alle kommenden und bereits vergangenen Veranstaltungen werden angezeigt.  |
-| mode      | actual(default)\\ old  | Alle kommenden Termine angezeigt.\\ Nur die bereits vergangenen Termine angezeigen.  |
+| show      | all(default)\\ maybe_participate\\ only_participate  | Alle Veranstaltungen anzeigen.\\ Nur Veranstaltungen anzeigen bei denen der aktuelle Benutzer angemeldet ist oder sich anmelden kann.\\ Nur Veranstaltungen anzeigen bei denen der aktuelle Benutzer angemeldet ist.  |
-| show      | all(default)\\ maybe_participate\\ \\ only_participate  | Alle Termine anzeigen.\\ Nur Termine anzeigen bei denen der aktuelle Benutzer angemeldet ist oder sich anmelden kann.\\ Nur Termine anzeigen bei denen der aktuelle Benutzer angemeldet ist.  |
+| view      | detail\\ compact\\ room\\ participants  | Ausführliche Standard-Html-Ansicht.  \\ Veranstaltungen werden in einer kompakten einzeiligen Liste dargestellt. \\ Veranstaltungen mit Raumzuordnung werden angezeigt. \\ Teilnehmer von Veranstaltungen werden in einer Liste mit angezeigt.  |
-| view      | detail\\ compact | Ausführliche Standard-html-Ansicht.\\ Termine werden in einer kompakten einzeiligen Liste dargestellt. |
+| view_mode      | html  \\ print  \\    | Ausführliche Standard-Html-Ansicht.\\ Veranstaltungen werden in einer kompakten Liste ohne unnötige grafische Elemente dargestellt.  |
-| view_mode      | html\\ print  | Ausführliche Standard-Html-Ansicht.\\ Termine werden in einer kompakten Liste ohne unnötige grafische Elemente dargestellt.  |
-\\
+=== Weblinks ===
-  * **Weblinks:** Liste aller eingetragenen Links. Berechtigte Benutzer können hier neue Links hinzufügen und Alte bearbeiten oder löschen.
+Liste aller eingetragenen Links. Berechtigte Benutzer können hier neue Links hinzufügen und alte Links bearbeiten oder löschen.\\ \\
 ''Link: http://www.example.org/admidio-ordner/adm_program/modules/links/links.php''
 ^ Parameter ^ Wert        ^ Beschreibung ^
-| headline  | Bezeichnung  | Frei wählbare Bezeichnung für das Modul anstelle von Weblinks  |
+| cat_uuid      | UUID einer Kategorie  | Zeigt alle Weblinks dieser Kategorie an.  |
-| category  | Kategoriename   | Name der Kategorie deren Links direkt angezeigt werden sollen  |
+| link_uuid      | UUID eines Weblinks  | Zeigt nur diesen einen Weblink an.  |
+===== Wie kann ich eine Seite in einem iFrame einbinden? =====
+Wenn du ein Modul oder eine beliebige Seite von Admidio in einem iFrame einbinden möchtest, dann kannst du das über einen der hier dokumentieren Links machen. In vielen Fällen möchtest du das Menü oder den Seitenkopf nicht anzeigen, sondern lediglich den eigentlichen Inhalt der Seite, so auf auf dem folgenden Screenshot:\\
+{{:de:2.0:documentation:iframe.png?600|Admidio-Seite mit reduziertem Inhalt}}
+Um dies zu erreichen kannst du ab der Version 4.3.6 bei jedem Seitenaufruf den Query-Parameter ''iframe'' mit dem Wert ''1'' anhängen.\\
+''Beispiel: http://www.example.org/admidio-ordner/adm_program/modules/announcements/annnouncements.php?iframe=1''\\
+Admidio merkt sich die gesetzte Einstellung. Klick ein Anwender nun auf dieser Seite auf einen Link, so wird die dann aufgerufene Seite ebenfalls mit dem reduzierten Inhalt dargestellt. Möchtest du einen anderen Link einbauen, bei dem du dann die vollständige Admidio-Seite anzeigen willst, dann setzt du den Query-Parameter ''iframe'' auf den Wert ''0''.