Differences

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

--- en:plugins:installation [2016/10/30 14:10] – created fasse
+++ en:plugins:installation [2021/09/22 11:09] (current) – fasse
@@ Line 6: / Line 6: @@
-===== How do I install plugins?=====
+===== How do I install plugins? =====
-Download the plugin from [[http://forum.admidio.org/viewforum.php?f=9 | Plugin Area]] and unpack the zip file. Copy the folder with the files in the folder ** adm_plugins ** in your Admidio folder.  If the folder adm_plugins  does not exist, it must first be created yet. This should be on the same level as adm_my_files.
+Download the plugin from [[en:plugins | our plugin area]] and unpack the zip file. Copy the folder with the files in the folder ** adm_plugins ** in your Admidio folder.  If the folder adm_plugins  does not exist, it must first be created yet. This should be on the same level as adm_my_files.
-Plugins are usually written in php and should integrate their content into an existing html or php page.
+==== Install plugin into an Admidio 4 page ====
-If you're looking to integrate the plugin in a pure html page, you should have the file extension of the first page of html to php renamed. Now you can use the module using PHP in your formerly pure html site integration. Add the plugin //(as an example, the plugin will login_form used)// using one of the following methods in your html code at the location where the output of the plugin should be displayed:
-. Do you use the plugin only within Admidio pages so, a simple call to:
+Check the installation instructions on the plugin page in the first step. Some Plugins supply their own installation script and integrate themselves thereby independently into our menu. In this case no further steps are necessary.
-<code php><?php
+Other plugins can be integrated with a small HTML script on the overview page. For this purpose the corresponding script must be included in the template file ''adm_themes/simple/templates/overview.tpl''.
-  include(SERVER_PATH. "/adm_plugins/birthday/birthday.php");
-?></code>
-. The plugin is used on pages that have nothing to do with Admidio, it must first have the // common.php // **at the very beginning** of the php file on the server location of these lines:
+Several DIV blocks are stored there and you have to add your new DIV block behind an existing DIV block. The DIV-blocks look like this:
+<code html><div class="col-sm-6 col-lg-4 col-xl-3">
+    <div class="card admidio-roles" id="role_details_panel_'.$rolId.'">
+        <div class="card-body" id="admRoleDetails'.$rolId.'">
+            {load_admidio_plugin plugin="plugin-name" file="plugin-file-name"}
+        </div>
+    </div>
+</div></code>
+In this DIV block replace **plugin-name** with the name of the folder of your plugin and replace **plugin-file-name** with the file name containing the html-script.
+If you want to include for example the Plugin ''adm_plugins/calendar/calendar.php'', then the code block looks afterwards like this
+<code html><div class="col-sm-6 col-lg-4 col-xl-3">
+    <div class="card admidio-roles" id="role_details_panel_'.$rolId.'">
+        <div class="card-body" id="admRoleDetails'.$rolId.'">
+            {load_admidio_plugin plugin="calendar" file="calendar.php"}
+        </div>
+    </div>
+</div></code>
+Then you can reload the overview page and your plugin should be visible.
+==== Install plugin into an Admidio 3 page ====
+The installation of a plugin within an Admidio page is really simple. Go to the file **adm_themes/modern/my_body_bottom.php** and add at the corresponding place the following code:
+<code php><?php include(ADMIDIO_PATH . FOLDER_PLUGINS . '/birthday/birthday.php'); ?></code>
+If you are within a PHP part of your page than you must only add:
+<code php>include(ADMIDIO_PATH . FOLDER_PLUGINS . '/birthday/birthday.php');</code>
+Now reload the Admidio page and the plugin should be shown.\\
+Since version 3.0 all css files of the plugins will be loaded automatically and must not be added separatly.
+==== Install plugins outside of an Admidio page ====
+You can also use the plugins outside of the Admidio pages and integrate them into your own HTML / PHP pages. However, a few additional steps are necessary.
+If you want to integrate the plugin into a pure html page, you should first rename the file extension of the page from html to php. Now you can integrate the plugin with help from PHP into your formerly pure HTML page. Now add the plugins // (as an example here the plugin login_form) // into your Html code at the point where the output of the plugin should be displayed by one of the following methods:
+. First the file //common.php// must be added **at the very beginning** of your PHP file via the server path:
 <code php><?php
-  include_once($_SERVER['DOCUMENT_ROOT']. "/Path-to-Admidio-folder /adm_program/system/common.php");
+  include_once($_SERVER['DOCUMENT_ROOT']. '/Path-to-Admidio-folder /adm_program/system/common.php');
 ?></code>
+The //Path-to-Admidio-folder// must contain the folder structure, which you have to go from the file in which you want to install the plugin, to the Admidio folder.
+**Example 1**
+  FTP file path in which the plugin should be installed:
+  homepage/index.php
+  FTP file path to Admidio folder
+  homepage/admidio/index.php
+  Include-Befehl:
+  include_once($_SERVER['DOCUMENT_ROOT']. '/admidio/adm_program/system/common.php');
+**Example 2**
+  FTP file path in which the plugin should be installed:
+  homepage/index.php
+  FTP file path to Admidio folder
+  admidio/index.php
+  Include-Befehl:
+  include_once($_SERVER['DOCUMENT_ROOT']. '/../admidio/adm_program/system/common.php');
+. Afterwards the plugins are installed in the desired places:
-After that, as at point 1, the installation of the plugins at the desired locations:
 <code php><?php
-  include($_SERVER['DOCUMENT_ROOT']. "/ Path-to-Admidio-folder /adm_plugins/login_form/login_form.php");
+  include($_SERVER['DOCUMENT_ROOT']. '/Path-to-Admidio-folder /adm_plugins/login_form/login_form.php');
 ?></code>
-. While previous versions not have been successful, you can link the plugins directly via an URL. However, in this variant the common.php is executed repeatedly for each plugin, which is not very useful, regarding the performance of the Web server.
+. If the previous variants have not led to success, you can also integrate the plugins directly via a URL. However, in this variant, the common.php for each plugin is repeatedly processed, which is not the best for the performance of the webserver.
 <code php><?php
-  include("http://www.example.org/ Path-to-Admidio /adm_plugins/login_form/login_form.php");
+  include('http://www.example.org/Path-to-Admidio-folder /adm_plugins/login_form/login_form.php');
 ?></code>
-. The plugin has a CSS file it must also be integrated into the website. This must be the once within Admidio's  **my_header.php**  of  the selected theme and in the header of your own pages if you also want to show the plugin there.
+. If the plugin has a CSS file, it must also integrate into the website. This must be done both within Admidio's ** my_header.php ** of the selected theme folder as well as in the header of your own pages, if you want to display the plugin there as well.
-<code html><link rel="stylesheet" type="text/css" href="http://www.example.org/ Path-to-Admidio /adm_plugins/login_form/login_form.css" /></code>
+<code html><link rel="stylesheet" type="text/css" href="http://www.example.org/Path-to-Admidio-folder /adm_plugins/login_form/login_form.css" /></code>
 ===== Where can I configure the plugins?=====
-You can configure most plugins via **config.php** file that is located in the same folder as the plugin. Here are some variables with default values available. This you can customize according to your needs.
+You can configure most plugins via a **config.php** file. For this purpose, a **config_sample.php** file is usually delivered, which should be located in the folder of the plugin. You can simply rename this file to **config.php**. Here are some variables with default values available. You can change them according to your needs.
-Does the plugin have a CSS file, it can be customized using the the layout of the plugin.
-Updating a plugin, these 2 files should not been necessarily overwritten. In case new settings or CSS settings are added by the update, then the new variable or CSS settings should be copied from the downloaded files into the existing files //(config.php and pluginname.css)// of the plugin and the desired values can be customized .
+If the plugin has its own CSS file, the layout of the plugin can be adjusted via this file.
+When updating the plugin, these two files need not and should not be overwritten. If new settings or CSS settings are added by the update, the new variables or CSS settings can be copied from the **config_sample.php** into the previous files //(config.php and pluginname.css)// of the plugin and the desired values can be inserted.
 An example of integration of multiple plugins in a sidebar you can see on this screenshot in the highlighted area:
@@ Line 48: / Line 106: @@
 ===== How do I update a plugin?=====
-If there is an update, because of a bug fix, a new feature, or due to an incompatibility with current Admidio version, usually only the PHP script of the plugin is to be replaced. Download the latest version from [[http://forum.admidio.org/viewforum.php?f=9|Plugin Area]]  and replace the existing PHP file with new ones. The plugin folder should //never// been replaced, because all settings are going to be lost then. Special features of the update are mentioned in the **readme.txt**  in the plugin folder.
+If there is an update, because of a bug fix, a new feature, or due to an incompatibility with current Admidio version, you can replace the plugin folder. Download the latest version from [[en:plugins:index|Plugin Area]]  and replace the existing plugin folder with the new folder of the downloaded zip-file. Special features of the update are mentioned in the **readme.txt**  in the plugin folder.