Differences

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

--- en:2.0:admidio_customization [2020/10/20 20:12] – created fasse
+++ en:2.0:admidio_customization [2024/01/12 21:31] (current) – [Use texts from language files] fasse
@@ Line 1: / Line 1: @@
 ====== Layout adjustments ======
-===== General =====
+===== How do I create my own theme? =====
 Admidio is delivered with a contemporary layout. Of course you can also use it for your website. But in many cases you might want to adapt the layout of Admidio to the layout of your website. This can range from simple color changes up to an own header and footer of the page. Some of you might even want to change the layout and adjust the content in forms or lists.
 This page describes the options you have to customize the given layout. The adjustments described here refer to Admidio 4.0 or a more recent version. Many things are possible, but unfortunately not everything. Admidio has historically a close connection between layout and logic. We try to separate these more and more. The relevant layout files are stored in the folder **adm_themes**. There is a subfolder for each theme. If you only want to change small things, you can do this in the existing **Simple** theme. For bigger changes we recommend to create a copy of **Simple** with a new name, e.g. **myNewTheme**. You can create as many themes as you like. The desired theme can be selected later in the settings under //Settings > General > Admidio-Theme//.\\
-{{:en:themes:theme_change.png?400|Select Theme}}}
+{{:en:2.0:documentation:layout:theme_change.png?400|Select Theme}}
-===== Adjustments via CSS =====
+===== How do I customize the layout with CSS? =====
-Many layout adjustments can already be implemented via CSS. For this you can use the **admidio.css** file in the theme folder //adm_themes/simple/css//. There you can change existing adjustments to classes or id's or add new ones. This file will be included in every page as the last CSS file and overwrites all previous set values.\\
+Many layout adjustments can already be implemented via CSS. To do this, you can use the following file in the theme folder ''adm_themes/simple/css/admidio.css''. There you can change existing adjustments to classes or id's or add new ones. This file will be included in every page as the last CSS file and overwrites all previous set values.\\
 Mark your changes in the CSS file with a unique identifier. This will help you later, if you want to save your changes in admidio.css after an update.
@@ Line 25: / Line 25: @@
 /* my code end */</code>\\
-The Admidio Layout is based on [[https://getbootstrap.com/|Bootstrap]], which defines the basic layout elements. For Bootstrap there are already many ready-made alternative layouts. You can exchange the integrated Bootstrap CSS and Javascript files. Just open the file //adm_themes/simple/templates/js_css_files.tpl// and replace the url of the following lines on your new bootstrap files.
+The Admidio Layout is based on [[https://getbootstrap.com/|Bootstrap]], which defines the basic layout elements. For Bootstrap there are already many ready-made alternative layouts. You can exchange the integrated Bootstrap CSS and Javascript files. Just open the file ''adm_themes/simple/templates/js_css_files.tpl'' and replace the url of the following lines on your new bootstrap files.
 <code html>  <script type="text/javascript" src="{$urlAdmidio}/adm_program/libs/client/bootstrap/js/bootstrap.bundle.min.js">
   <link rel="stylesheet" type="text/css" href="{$urlAdmidio}/adm_program/libs/client/bootstrap/css/bootstrap.min.css" />
@@ Line 32: / Line 32: @@
 Make sure that the files are included 2x slightly modified. Once in $debug mode in full length and once as minified files for productive use. You should exchange the files at both places.
-===== Customization with the Template Engine Smarty =====
+===== How do I edit the layout with the Template Engine? =====
 Admidio uses the [[https://www.smarty.net/|Smarty Template Engine]] to display the Html page. With it we create the general layout elements like the page header with the menu and the page footer. The actual content, the dialogs or lists are currently still generated from the individual scripts and cannot be changed using special template files. But take a look at what is already possible via the main page.
-You will find the template files in the folder //adm_themes/simple/templates// and can customize them there. Enclosed you will find a short overview of the content of each file:
+You will find the template files in the folder ''adm_themes/simple/templates'' and can customize them there. Enclosed you will find a short overview of the content of each file:
 ^ Template file      ^ Description         ^
-| cookie_note.tpl    | Stellt das Script für das Cookie-Popup bereit und sollte nur angepasst werden, wenn ihr das Verhalten oder Aussehen von diesem kleinen Popup ändern wollt. Schaut euch dazu den dazugehörigen [[https://www.osano.com/cookieconsent/download/|Script-Konfigurator]] an.         |
+| cookie_note.tpl    | Provides the script for the cookie popup and should only be adjusted if you want to change the behavior or appearance of this little popup. Have a look at the corresponding [[https://www.osano.com/cookieconsent/download/|Script-Configurator]].         |
-| index_reduced.tpl    | Stark Layout reduzierte Seite, welche nur den Seitentitel, einen Zurück-Button und den eigentlichen Inhalt anzeigt. Seitenkopf, das Navigationsmenü und der Seitenfuß werden nicht angezeigt. Diese Seite wird z.B. bei der Druckvorschau genutzt. |
+| index_reduced.tpl    | Strongly reduced layout page, which only shows the page title, a back button and the actual content. Page header, the navigation menu and the page footer are not displayed. This page is used e.g. for the print preview. |
-| **index.tpl**    | Die Hauptseite Layout Seite von Admidio, welche den Seitenkopf, das Navigationmenü, sowie den Seitenfuß darstellt und den eigentlichen Seiteninhalt einbettet. In diese Seite könnt ihr euren Seitenaufbau einbauen.        |
+| **index.tpl**    | The main page layout page of Admidio, which displays the page header, the navigation menu, the page footer and embeds the actual page content. In this page you can embed your page layout.        |
-| js_css_files.tpl    | Diese Seite integriert alle CSS oder Javascript-Dateien und sollte nur angepasst werden, falls ihr z.B. für [[https://getbootstrap.com/|Bootstrap]] ein anderes Layout einbinden wollt. |
+| js_css_files.tpl    | This page integrates all CSS or Javascript files and should only be adjusted if you want to use a different layout for [[https://getbootstrap.com/|Bootstrap]]. |
-| message_modal.tpl   | Seiteninhalt für eine Admidio-Nachricht in einem modalen Dialog z.B. bei der E-Card-Vorschau oder beim Löschen von Inhalten. |
+| message_modal.tpl   | Page content for an Admidio message in a modal dialog, e.g. during e-card preview or when deleting content. |
-| message.tpl    | Seiteninhalt für eine Admidio-Nachricht z.B. "Daten wurden gespeichert" oder "Feld ist nicht gefüllt". |
+| message.tpl    | Page content for an Admidio message e.g. "Data was saved" or "Field is not filled". |
-| overview.tpl    | Seiteninhalt der Startseite von Admidio mit dem Überblick über den Inhalt aller Module. Auf dieser Seite werden verschiedene Plugins eingebunden. Falls bestimmte Module oder Plugins nicht genutzt werden sollen, können diese hier entfernt werden. Es können auch weitere Plugins hinzugefügt werden. |
+| overview.tpl    | Page content of the Admidio homepage with an overview of the content of all modules. On this page different plugins are integrated. If certain modules or plugins should not be used, they can be removed here. You can also add more plugins. |
 The syntax of Smarty is actually very easy to learn and is usually already apparent when looking at our delivered template files. Additionally, there is [[https://www.smarty.net/docs/en/|a documentation]] which describes the many possibilities of Smarty. Some important points for us are described in the following.
@@ Line 54: / Line 54: @@
 The following variables are available on every Admidio page and can be used by you in the template files if you want to redesign them:
 ^ Variable      ^ Example content         ^ Description         ^
-| {$id} | admidio-announcements    | Id der Html-Seite, welche für jede Seite separat erstellt wird und im <body> als id hinterlegt wird. |
+| {$additionalHeaderData} | <meta charset="utf-8">    | More html tags for the page header. |
-| {$title} | Demo-Organisation - Meine Beispielseite    | Titel der Html-Seite für das Tag <title>. |
+| {$content} | <html>...    | The actual content of the called page e.g. a dialog or a list. |
-| {$headline} | Meine Beispielseite    | Überschrift für die Seite. |
+| {$currentUser} | Smith    | Object of the logged-in user. All profile data can be queried via this object. ([[en:2.0:admidio_customization#use_data_of_the_logged-in_user|Detailed documentation]]) //(from version 4.3)//|
-| {$urlPreviousPage} | https://www.admidio.org/demo/adm_program/overview.php    | URL der zuletzt aufgerufen Admidio-Seite. |
+| {$debug} | false    | Normally //false// unless debug mode has been turned on in config.php |
-| {$organizationName} | Demo-Organisation   | Name eurer Organisation aus den Einstellungen. |
+| {$hasPreviousUrl} | true    | Indicates whether there is a URL from which this page was called. In the default theme, a back button is then displayed. |
-| {$urlAdmidio} | https://www.admidio.org/demo    | URL der Admidio-Installation. |
+| {$headline} | My Sample Page    | Headline for the page. |
-| {$urlTheme} | https://www.admidio.org/demo/adm_themes/simple    | URL zum verwendeten Theme der Admidio-Installation. |
+| {$id} | admidio-announcements    | Id of the html page, which is created separately for each page and stored as id in the <body>. |
-| {$userId} | 4711    | Id des angemeldeten Benutzers. |
+| {$javascriptContent} | if(javascript = 1) {}    | Additional Javascript code of the respective page. |
-| {$validLogin} | true    | Bei gültiger Anmeldung in Admidio //true//, ansonsten //false//. |
+| {$javascriptContentExecuteAtPageLoad} | if(javascript = 1) {}     | Additional Javascript code of the respective page to be executed when the page is called up. |
-| {$debug} | false    | Normalerweise //false// außer der Debug-Modus wurde in der config.php angeschaltet. |
+| {$languageIsoCode} | en    | ISO code of the current selected language e.g. 'de' or 'en'. //(from version 4.1.6)// |
-| {$registrationEnabled} | true    | Bei aktivierter Registrierung //true//, ansonsten //false//. |
+| {$l10n} | All language texts     | Object to access all language texts from Admidio.  ([[en:2.0:admidio_customization#use_texts_from_language_files|Detailed documentation]]) |
-| {$printView} | false    | Bei einer Druckvorschau //true//, ansonsten //false//. |
+| {$menuSidebar} | <html>...    | Html code for the navigation menu. |
-| {$urlImprint} | https://www.admidio.org/imprint.php    | URL zum Impressum, welche in den Einstellungen hinterlegt wurde. |
+| {$organizationName} | Demo-Organization   | Name of your organization from the settings. |
-| {$urlDataProtection} | https://www.admidio.org/data_protection.php    | URL zum Datenschutz, welche in den Einstellungen hinterlegt wurde. |
+| {$printView} | false    | For a print preview //true//, otherwise //false//. |
-| {$content} | <html>...    | Der eigentliche Inhalt der aufgerufenen Seite z.B. ein Dialog oder eine Liste. |
+| {$registrationEnabled} | true    | If registration is enabled //true//, otherwise //false//. |
-| {$templateFile} | message.tpl    | Eine andere Template-Datei, welche in der aktuellen Template-Datei eingebunden werden soll. |
+| {$templateFile} | message.tpl    | Another template file to be included in the current template file. |
-| {$menuSidebar} | <html>...    | Html-Code für das Navigationsmenü. |
+| {$title} | Demo Organization - My Sample Page    | Title of the html page for the tag <title>. |
-| {$additionalHeaderData} | <meta charset="utf-8">    | Weitere Html-Tags für den Seitenkopf. |
+| {$urlAdmidio} | https://www.admidio.org/demo    | URL of the Admidio installation. |
-| {$javascriptContent} | if(javascript = 1) {}    | Weiterer Javascript-Code der jeweiligen Seite. |
+| {$urlDataProtection} | https://www.admidio.org/data_protection.php    | URL for data protection, which is stored in the settings. |
-| {$javascriptContentExecuteAtPageLoad} | if(javascript = 1) {}     | Weiterer Javascript-Code der jeweiligen Seite, der beim Seitenaufruf ausgeführt werden soll. |
+| {$urlImprint} | https://www.admidio.org/imprint.php    | URL to the imprint, which is stored in the settings. |
+| {$urlTheme} | https://www.admidio.org/demo/adm_themes/simple    | URL to the used theme of the Admidio installation. |
+| {$userId} | 4711    | Id of the logged in user. **(deprecated, is no longer available as of version 4.2)** |
+| {$userUuid} | 97f8346c-ca53-40de-857a-459d26d9df40    | Uuid of the logged in user. **(obsolete, from version 4.3 please use {$currentUser->getValue('usr_uuid')})** |
+| {$validLogin} | true    | With valid registration in Admidio //true//, otherwise //false//. |
+==== Use data of the logged-in user ====
+With Smarty you have access to all profile data and the UUID of the logged-in user in the template files. The ''currentUser'' object is available for this purpose, which you can integrate anywhere. For the profile data, you need the internal name of the profile field, which you can find in the settings of the respective profile field in Admidio. If you now want to display the first and last name of the user, for example, you can do this as follows:<code html>{$currentUser->getValue('FIRST_NAME')} {$currentUser->getValue('LAST_NAME')}</code> You can output the UUID with the following code:<code html>{$currentUser->getValue('usr_uuid')}</code> You can output the login name with this code:<code html>{$currentUser->getValue('usr_login_name')}</code>
 ==== Use texts from language files ====
-With Smarty you also have access to the texts from the language files (adm_program/languages) in the template files and can integrate them at any place. For this purpose you need the individual abbreviation of the text e.g. SYS_FILE_EXTENSION_INVALID and you can integrate it into the html code using the following syntax:
+With Smarty you also have access to the texts from the language files (adm_program/languages) in the template files and can integrate these at any point. The ''l10n'' object is available for this purpose. All you need is the individual abbreviation of the text, e.g. SYS_FILE_EXTENSION_INVALID, and you can then integrate this into the HTML code using the following syntax:
 <code html><b>{$l10n->get('SYS_FILE_EXTENSION_INVALID')}</b></code>
 The curly brackets with the l10n->get, as well as the normal brackets with the quotation marks must always be deposited. In between there is the text abbreviation, which is replaced by the text in the selected language when the page is displayed.
@@ Line 82: / Line 89: @@
 The example above looks like this:\\
 **Files of this file type are not allowed on the server.**
+===== How do I change icons ? =====
+Admidio uses the font library [[https://fontawesome.com/|Font Awesome]], more precisely the [[https://fontawesome.com/icons?d=gallery&s=solid&m=free|free Solid Theme]] of this library to display icons. You can integrate the icons quite easily. Search for your desired icon on the website mentioned above, remember the name and include the following code snippet: <code html><i class="fas fa-chevron-circle-down"></i></code> In this example, the icon is called //chevron-circle-down//. You have to put a //fa-// in front of it.\\
+You can easily change all built-in icons using CSS. You only have to address the class //fas// via CSS and can apply all font attributes there: <code css>.fas {
+   color: #0000ff;
+   font-size: 120%;
+}</code>
+===== How can I customize the overview page ? =====
+Admidio normally displays an overview page with various plugins when called and after a successful login, such as the latest announcements, the latest files and documents or upcoming birthdays.\\
+{{:en:2.0:documentation:layout:overview.png?400|Admidio overview page}}\\
+If you don't want to see some of the already stored plugins or if you want to add more, you can do this in the corresponding template file. This is located at ''http://www.your-webpage.com/admidio/adm_themes/simple/templates/overview.tpl''. In this file you find now different HTML blocks, which have the following structure: <code html><div class="admidio-overview-plugin col-sm-6 col-lg-4 col-xl-3" id="admidio-plugin-birthday">
+    <div class="card admidio-card">
+        <div class="card-body">
+            {load_admidio_plugin plugin="birthday" file="birthday.php"}
+        </div>
+    </div>
+</div></code> Search there for your no longer wanted plugin ''plugin="birthday"'' and then remove this block completely.\\ \\
+If you want to add another plugin, you can duplicate such a block and deposit the plugin. We now create a simple HTML page that should be included in the overview. For this we create a new subfolder **test** in the folder **adm_plugins**. In this subfolder we now create a file ''output.html'' with the following content: <code html><h3>Test</h3>
+This is the content of <b>any html file</b> from a subfolder of adm_plugins.</code> You can now integrate the content of this file as another block in the overview with the following code:
+<code html><div class="admidio-overview-plugin col-sm-6 col-lg-4 col-xl-3" id="admidio-card-plugin-test">
+    <div class="card admidio-card">
+        <div class="card-body">
+            {load_admidio_plugin plugin="test" file="output.html"}
+        </div>
+    </div>
+</div></code> The result together with a few plugins that have been removed may then look like this:\\
+{{:en:2.0:documentation:layout:overview_customized.png?400|Customized overview}}