Differences

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

--- en:plugins:installation [2016/12/27 11:10] – [Install plugin into an Admidio page] fasse
+++ en:plugins:installation [2021/09/22 11:09] (current) – fasse
@@ Line 6: / Line 6: @@
 ===== How do I install plugins? =====
 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.
-==== Install plugin into an Admidio page ====
+==== Install plugin into an Admidio 4 page ====
+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.
+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''.
+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 . '/adm_plugins/birthday/birthday.php'); ?></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 . '/adm_plugins/birthday/birthday.php');</code>
+<code php>include(ADMIDIO_PATH . FOLDER_PLUGINS . '/birthday/birthday.php');</code>
 Now reload the Admidio page and the plugin should be shown.\\
@@ Line 69: / Line 96: @@
 ===== 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 77: / 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.