| Next revision | Previous revision |
| en:2.0:individueller_aufruf_der_module [2015/10/09 23:39] – created thomas-rcv | en:2.0:individueller_aufruf_der_module [2024/03/10 12:44] (current) – fasse |
|---|
| ====== Individual call of modules ====== | ====== Individual call of the modules ====== |
| After you have successfully installed Admidio, you can integrate different modules in your website. Admidio provides innately a series modules (announcements, events, lists, profiles ...). This you can see all on the overview page. | ===== Which modules can I call? ===== |
| | Admidio usually runs as a standalone program, which you can access via a link from your existing homepage. But maybe you want to link single modules or pages of Admidio directly. An overview of the possible modules can be found in our menu. In addition, there are other pages which you can integrate directly and, if necessary, adapt to your ideas via further parameters. |
| |
| {{:de:2.0:moduluebersicht.png|}} | {{:en:2.0:documentation:menu_sidebar_en.png?200|}} |
| |
| In addition various administration dialogues, which also appear on the summary page when you have logged in as webmaster are shown. | Each of these modules works independently. That means you can put a link to this module anywhere from your homepage. If a user login is required, the login page will be called automatically. Once the user is logged in, he can navigate between the Admidio modules and your own pages at will and does not need to log in again. |
| {{:de:2.0:adminuebersicht.png|}} | |
| |
| Each of these modules work independently. That is, you can put on your home page a link to this module at any point. If a user login is required, the Login page is automatically called. If the user is logged in once, he can navigate freely between the Admidio modules and your own pages and does not have to sign up again. | However, to increase security you should include a link to the login page and logout on your homepage. |
| To increase the security you should however use a special link to the login page and logout on your website. | |
| |
| ===== Links to the modules: ===== | ===== What links and parameters are available? ===== |
| The following links to the modules are shown on two lines here due to space reasons. Ofcourse it must be linked together. | All parameters given here are optional. Each module can be called without the respective parameters. you should only pass them if the desired change is needed. |
| |
| All parameters that are given here, are optional. Each module can be accessed without the respective parameters. You should pass it only a desired change is needed. | The parameters are appended directly to the URL. you simply put a **?** after the URL and then you can write the parameter name. After a **=** then follows the value. If you want to append more than one parameter, the parameters are separated by a **&**. |
| |
| The parameters are appended directly to the URL. you put just a **?** after the URL, and then can write the parameter name. After a **=** followed by the value. Want to attach more than one parameter, the parameter by an **&** are separated. | ''Example: http://www.example.org/.../messages_write.php?role_uuid=550e8400-e29b-11d4-a716-446655440000&subject=My-private-email'' |
| |
| ''Example: http://www.example.org/.../mail.php?role=Webmaster&cat=Common'' | **Note:** |
| | There must be no spaces or special characters in the complete URL. This also applies to the parameters. If you still want to pass a value with a space, you can simply write **%20** instead of the space. |
| |
| **Notice:** | === Login page === |
| In the complete URL no spaces or special characters may occur. This also applies to the parameters. If you still want to pass a value with blanks, you can easily **%20** write instead of the spaces. | Calling the login page with link to registration and redirection to the page specified in the settings.\\ \\ |
| | ''Link: http://www.example.org/admidio-folder/adm_program/system/login.php'' |
| | ^ Parameter ^ Value ^ Description ^ |
| | | organization_short_name | Shortname of organization | The short name of a stored organization that should be preselected on the login page. (from version 4.3) | |
| |
| * **Login Page:** call of login page with the link for registration and forwarding to the level specified in the settings page. | === Logout === |
| ''Link: http://www.example.org/admidio-ordner/adm_program/system/login.php'' | Logout of the user with redirection to the page specified in the settings.\\ \\ |
| \\ | ''Link: http://www.example.org/admidio-folder/adm_program/system/logout.php'' |
| * **Logout:** Logout of the user with forwarding to the level specified in the settings page. | \\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/system/logout.php'' | === Registration === |
| \\ | New users can register using this form.\\ \\ |
| * **Registration:** New users can register using this form. | ''Link: http://www.example.org/admidio-folder/adm_program/system/registration.php'' |
| ''Link: http://www.example.org/admidio-ordner/adm_program/system/registration.php'' | \\ \\ |
| \\ | === Announcements === |
| * **Announcements:** List with all recorded announcements. Authorized Users have the option to create, edit, or delete announcements. | List with all recorded announcements. Authorized users have the possibility to enter, edit or delete announcements here.\\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/announcements/annnouncements.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/announcements/annnouncements.php'' |
| ^ Parameter ^ Value ^ Description ^ | ^ Parameter ^ Value ^ Description ^ |
| | headline | Term | Freely selectable name for the module instead of announcements | | | date_from | Format: System setting | View all announcements as of this date. | |
| | date | Format: YYYYMMDD | Show All announcements created on this date | | | date_to | Format: System setting | View all announcements up to this date. | |
| \\ | | cat_uuid | UUID of a category | Displays all announcements of this category. | |
| * **Downloads:** Collection of various file downloads in a freely selectable folder structure. Folders can also be enabled only for certain user groups. | | ann_uuid | UUID of an announcement | Displays only this one announcement. | |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/downloads/downloads.php'' | |
| ^ Parameter ^ Value ^ Description ^ | === Documents & Files === |
| | folder_id | ID of the folder | Specifying the ID of the download folder is to be displayed | | Listing of various documents or files in a freely selectable folder structure. Folders can also be shared only with specific user groups.\\ \\ |
| \\ | ''Link: http://www.example.org/admidio-folder/adm_program/modules/documents-files/documents_files.php'' |
| * **E-Mail:** Send emails to all members of certain roles. Without parameters, the user can choose the role of a combo box. | ^ Parameter ^ Value ^ Description ^ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/mail/mail.php'' | | folder_uuid | Folder UUID | Specifying the UUID of the file folder to be displayed. | |
| ^ Parameter ^ Value ^ Description ^ | |
| | role | Rolename | Name of the role to its members, an email is sent. | | === E-mail === |
| | cat | Category | Name of the category the role is defined. The category must be passed, if the parameter roel is used. | | Sending e-mails to all members of specific roles. Without parameters, the logged-in user can select roles or other users via a selection box.\\ \\ |
| | subject | Subject | Subject of the e-mail can be preassigned. | | ''Link: http://www.example.org/admidio-folder/adm_program/modules/messages/messages_write.php'' |
| | body | Text | Content of e-mail can be preassigned. | | ^ Parameter ^ Value ^ Description ^ |
| | copy | 1(default)\\ 0 | Flag whether a copy to the sender to be sent. | | | role_uuid | UUID of the role | UUID of the role to whose members an e-mail is sent. | |
| \\ | | user_uuid | UUID of the user | UUID of the user to whom an e-mail is sent. | |
| * **Photos:** Display a gallery. Authorized users can create, maintain and delete new albums. | | subject | Subject | Subject of the e-mail can be preset with this. | |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/photos/photos.php'' | | carbon_copy | 1\\ 0 (default) | Flag whether a copy should be sent to the sender. | |
| \\ | | msg_type | EMAIL (Default)\\ PM | Specify whether to create an e-mail or a private message. | |
| * **Greeting cards:** By selecting an image in the photo module you can send it to one or multiple recipients provided within the organization or outsiders with any text. | |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/ecards/ecard_form.php'' | === Photos === |
| \\ | Display of a photo gallery. Authorized users can create, maintain and delete new albums.\\ \\ |
| * **Guestbook** A book with a comment function for members of certain roles. | ''Link: http://www.example.org/admidio-folder/adm_program/modules/photos/photos.php'' |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/guestbook/guestbook.php'' | ^ Parameter ^ Value ^ Description ^ |
| ^ Parameter ^ Value ^ Description ^ | | pho_uuid | UUID of an album | Displays the photos of this album. | |
| | headline | Term | Freely selectable name for the module instead of Guestbook | | |
| \\ | === E-cards === |
| * **Lists:** Overview of all roles with various members call lists for each role. | By selecting an image in the photo module, you can send it to one or more recipients within the organization, or to external recipients with any text.\\ \\ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/lists/lists.php'' | ''Link: http://www.example.org/admidio-folder/adm_program/modules/ecards/ecard_form.php'' |
| ^ Parameter ^ Value ^ Description ^ | ^ Parameter ^ Value ^ Description ^ |
| | category | Category name | Name of the category whose roles are to be displayed directly | | | photo_uuid | UUID of an album | UUID of the photo album whose image you want to send. | |
| | category-selection | yes(default)\\ no | If **yes** a selection box will appear with all the categories and the user can filter the list of roles on a category. if **no** no selection is displayed. | | | photo_nr | Number of a photo | Number of the photo of the selected album for which a greeting card is to be created. | |
| | active_role | 1(default)\\ 0 | At 1 all active roles in the category are indicate and at 0, only the inactive rolls | | | user_uuid | UUID of a member | UUID of the member to whom the ecard should be sent. | |
| \\ | |
| * **Own lists:** Here, an individual Member list of a role can be drawn. Columns, sorting and conditions can be chosen freely. | === Guestbook === |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/lists/mylist.php'' | A guestbook with commenting function for members of certain roles.\\ \\ |
| ^ Parameter ^ Value ^ Description ^ | ''Link: http://www.example.org/admidio-folder/adm_program/modules/guestbook/guestbook.php'' |
| | active_role | 1(default)\\ 0 | For 1, all active roles of the organization are displayed and for 0, only the inactive roles | | ^ Parameter ^ Value ^ Description ^ |
| | active_member | 1(default)\\ 0 | For 1, all active members of the role are displayed and for 0, only the inactive members | | | gbo_uuid | UUID of an entry | Displays only this guestbook entry. | |
| \\ | |
| * **Profile:** A user's profile. It is automatically displayed the profile of the current user. | === Groups & Roles === |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/profile/profile.php'' | Overview of all roles with call of different member lists for each group or role.\\ \\ |
| \\ | ''Link: http://www.example.org/admidio-folder/adm_program/modules/groups-roles/groups-roles.php'' |
| * **Dates:** List of all recorded meetings. Authorized Users have the option to record, edit or delete appointments. | ^ Parameter ^ Value ^ Description ^ |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/dates/dates.php'' | | cat_uuid | UUID of a category | UUID of a category whose roles should be displayed. | |
| ^ Parameter ^ Value ^ Description ^ | | role_type | 0 \\ 1 (Default) \\ 2 | inactive roles only \\ all active roles \\ appointment participant roles only | |
| | calendar-selection | 1\\ \\ 0 | View a selection box with all the calendars and the user can filter the list of appointments on a calendar.\\ no selection box. | | | show | card (default)\\ permissions | Show all groups and roles in map view \\ Show permissions of all groups and roles in list view. | |
| | cat_id | Id of calendar | Show all dates for the given calendar | | |
| | date | Format: YYYYMMDD | Show all dates for the given calendar | | === Own lists === |
| | headline | Description | Freely selectable name for the module instead of dates | | Here you can create an individual member list for a role. Columns, sorting and conditions are freely selectable.\\ \\ |
| | id | Id of the date | Show only the date from the Id. | | ''Link: http://www.example.org/admidio-folder/adm_program/modules/groups-roles/mylist.php'' |
| | mode | actual(default)\\ old | All upcoming events are shown.\\ Display only the dates in the past. | | ^ Parameter ^ Value ^ Description ^ |
| | show | all(default)\\ maybe_participate\\ \\ only_participate | Show all dates.\\ Show only dates where partcipation is possible.\\ Show only events in which the current user is assigned.| | | list_uuid | UUID of a list | UUID of a list to be displayed. | |
| | view_mode | html\\ compact\\ print | Detailed standard HTML view.\\ Matches are displayed in a compact one-line list.\\ Matches are displayed in a compact list without unnecessary graphic elements.| | | active_role | 1 (default)\\ 0 | All active roles of the organization\\ Only the inactive roles of the organization | |
| \\ | | show_members | 0 (default) \\ 1 \\ 2 | All active members\\ All former members\\ All active and former members | |
| * **Weblinks:** List of all registered links. Authorized users can add new links here and edit or delete old. | |
| ''Link: http://www.example.org/admidio-ordner/adm_program/modules/links/links.php'' | === Profile === |
| ^ Parameter ^ Value ^ Description ^ | The profile of a user. The profile of the currently logged in user is automatically displayed.\\ \\ |
| | headline | Description | Freely selectable name for the module instead of links | | ''Link: http://www.example.org/admidio-folder/adm_program/modules/profile/profile.php'' |
| | category | Category name | Name of the category whose links should be displayed | | ^ Parameter ^ Value ^ Description ^ |
| | | user_uuid | UUID of a user | If this parameter is set, then the profile of this user is displayed. Without the parameter, the own profile is always displayed. | |
| | |
| | === Events === |
| | List with all recorded events. Authorized users have the possibility to enter, edit or delete events here.\\ \\ |
| | ''Link: http://www.example.org/admidio-folder/adm_program/modules/dates/dates.php'' |
| | ^ Parameter ^ Value ^ Description ^ |
| | | date_from | Format: System setting | Show all events from this date. | |
| | | date_to | Format: System setting | Display all events up to this date. | |
| | | cat_uuid | Calendar UUID | Display all events for the passed calendar. | |
| | | dat_uuid | UUID of an event | Displays only this one event. | |
| | | mode | actual(default)\\ old\\ all | All upcoming events displayed.\\ Only show the already past events.\\ All upcoming and already past events are displayed. | |
| | | show | all(default)\\ maybe_participate\\ only_participate | Show all events.\\ Show only events where the current user is logged in or can log in.\\ Show only events where the current user is logged in. | |
| | | view | detail\\ compact\\ room\\ participants | Detailed standard html view.\\ Events are displayed in a compact one-line list.\\ Events with room assignment are displayed.\\ Participants of events are displayed in a list with. | |
| | | view_mode | html \\ print \\ | Detailed standard html view.\\ Events are presented in a compact list without unnecessary graphical elements. | |
| | |
| | === Web links === |
| | List of all registered links. Authorized users can add new links here and edit or delete old ones.\\ \\ |
| | ''Link: http://www.example.org/admidio-folder/adm_program/modules/links/links.php'' |
| | ^ Parameter ^ Value ^ Description ^ |
| | | cat_uuid | UUID of a category | Displays all web links of this category. | |
| | | link_uuid | UUID of a web link | Displays only this one web link. | |
| | |
| | ===== How can I embed a page in an iFrame? ===== |
| | If you want to embed a module or any Admidio page in an iFrame, you can do this using one of the links documented here. In many cases, you do not want to display the menu or the page header, but only the actual content of the page, as shown in the following screenshot:\\ |
| | {{:en:2.0:documentation:iframe.png?600|Admidio page with reduced content}} |
| | |
| | To achieve this, from version 4.3.6 you can append the query parameter ''iframe'' with the value ''1'' to every page call.\\ |
| | ''Example: http://www.example.org/admidio-ordner/adm_program/modules/announcements/annnouncements.php?iframe=1''\\ |
| | Admidio remembers the setting. If a user now clicks on a link on this page, the page that is then called up is also displayed with the reduced content. If you want to insert another link where you want to display the full Admidio page, set the query parameter ''iframe'' to the value ''0''. |
