extern/egroupware_official
1
0
Fork 0
mirror of https://github.com/EGroupware/egroupware.git synced 2025-08-09 07:15:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated EGroupware Customizing (markdown)

Birgit Becker
2024-04-18 14:28:17 +02:00
parent 348671a1d7
commit 0b37448d4b
1 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
EGroupware-Customizing.md

@ -1,54 +1,54 @@
# EGroupware Customizing in general, custom translations, custom fields and/or custom etemplates
## Customize-general
**1. Upload Logs, favicon, Background image and fonts for EGroupware**
* Go to Admin -> App configuration -> tab Appearance
* Admin can upload a logo, which is used for login page and in EGroupware Header or two different ones e.g. different background color or format, in general its possible to use SVG, JPG or PNG - recommendation is SVG!
* Admin can upload one or several back ground images for the login page, they are used by chance on any reload of the page.
* Admin can also add some titles and links e.g. to your website
**1. Upload Logos, favicon, background image and fonts for EGroupware**
* Go to Admin -> App configuration -> Tab appearance
* The admin can upload a logo, which is used for the login page and in EGroupware header or two different ones e.g. the different background color or format. In general it's possible to use SVG, JPG or PNG - our recommendation is SVG!
* The admin can upload one or several background images for the login page, they are used by chance on any reload of the page.
* The admin can also add some titles and links e.g. to your website
![Admin - App configuration - Appearance](https://www.egroupware.org/wp-content/uploads/App-configuration.png)
* **NEW**: Admin can upload 2 different fonts, called "EGroupware" and "EGroupware Bold", EGroupware is used instead of the default font in whole EGroupware. EGroupware and EGroupware Bold are also available in the Text editor (at the bottom of all fonts).
Please be aware that a custom font used in email is not included in the sent mail and therefore the display can be different for the recipient!
* **NEW**: The admin can upload 2 different fonts, called "EGroupware" and "EGroupware Bold". EGroupware is used instead of the default font in whole EGroupware. EGroupware and EGroupware Bold are also available in the text editor (at the bottom of all fonts).
Please be aware that a custom font used in an email is not embedded in the sent mail and therefore the displayed font can be different for the recipient!
![Upload max two fonts for EGroupware](https://www.egroupware.org/wp-content/uploads/App-configuration-upload-fonts.png)
**2. Adapt login box e.g. remove "remember me" or add/remove language selector**
* Go to Admin -> App configuration -> tab Security: 2-Factor Authentication and remember me token
**2. Adapt the login box e.g. remove "remember me" or add/remove language selector**
* Go to Admin -> App configuration -> Tab security: 2-factor authentication and remember me token
![configure 2FA & Remember me token ](https://www.egroupware.org/wp-content/uploads/disable-remember-me.png)
* Go to Admin -> App configuration -> tab General: Show language select box on login page?
* Go to Admin -> App configuration -> Tab general: Show language select box on login page?
![Admin - App configuration - General](https://www.egroupware.org/wp-content/uploads/language-selector.png)
**3. Configure registration of users or lost password links using registration app**
**3. Configure the registration of users or lost password links using the registration app**
* Go to Admin -> Applications -> Registration -> App configuration
![Admin - Applications - Registration - App configuration](https://www.egroupware.org/wp-content/uploads/registration.png)
* Admin can configure which fields should be displayed for registration of new users, messages and several other options, see screenshot above
* Admin can configure what is displayed in the login box e.g. only lost password link or also registration
* If Admin want to customize more detailed the registration form, this can be done with a custom etemplate "registration_form.xet"
* The admin can configure which fields should be displayed for the registration of new users, messages and several other options (see screenshot above).
* The admin can configure what should be displayed in the login box, e.g. only a lost password link or also the registration.
* If the admin want to customize the registration form with more details, this can be done with a custom etemplate "registration_form.xet"
![Registration with a custom etemplate including headerimage and font](https://www.egroupware.org/wp-content/uploads/registrierung.png)
**4. Change login screen message** e.g. to add infos or imprint to the login page
* Go to Admin-> Change login screen message
* There are 2 options for "login screen" and "home screen" and Admin can choose or set it per language (english is the default and will be used, if there is no specific language set)
* The text editor allows to add text, set color in html or change the font (including EGroupware fonts). Additionally Admin can specify css to e.g. position imprint or address top left/right. Or hide EGroupware icons of login box or on the bottom of the page.
* There are 2 options for "login screen" and "home screen" and the admin can choose or set it for each language (english is the default and will be used, if there is no specific language set)
* The text editor allows to add text, set color in html or change the font (including EGroupware fonts). Additionally the admin can specify CSS to e.g. position imprint or address top left/right. Or hide the EGroupware icons in the login box or on the bottom of the page.
![Admin - Change login screen message](https://www.egroupware.org/wp-content/uploads/login-screen-message.png)
## Custom-translations
* Admin -> custom translation
* Admin needs to add the english phrase and a translation for it. The custom translation is used in all languages and has the highest priority
* It can be used to translate an app e.g. Infolog into "Task management" (or "meine Bewerbungen") or a specific phrase e.g. "private" to "confidential" or "startdate" to "Eingangsdatum"
* The admin needs to add the english phrase and a translation for it. The custom translation is used in all languages and has the highest priority.
* It can be used to translate an app e.g. Infolog into "Task management" (or "meine Bewerbungen") or a specific phrase e.g. "private" to "confidential" or "startdate" to "Eingangsdatum".
![Admin - Custom translation](https://www.egroupware.org/wp-content/uploads/custom-translation.png)
## Custom-fields
**1. General**
* EGroupware has lots of different custom field types like "text", "select box", "link to adressbook, Infolog, project" ...
![Admin - Application - Address book -custom fields](https://www.egroupware.org/wp-content/uploads/custom-fields.png)
* If app supports types (e.g. infolog, tracker, adressbook), admin can select for which type the custom field should show up, by selecting the types or empty for all.
* If "Required" is set, entry of that type can't be saved, when the field is not set!
* If Admin specify attribute "Private", the custom field is only displayed to this users or groups!
After changing permissions you need to clear cache (Admin -> clear cache" as permissions are cached!
* Order can be changed by inserting a number between 2 customfields
* Custom field name can't be changed as the name is used in the database! But Admin can change the label which is displayed to the users. We recommend to avoid space and umlaute in the custom field name. While it can be used easily in the custom field label!
* **NEW**: **Admin can specify a tab name for each custom field, the tabs are generated automatically in the order of the first appearance**. By default all custom field tabs are showing up before history tab, but it can be changed in eTemplate by attribute cfPrepend. **See also examples below from Adress book using custom fields in different tabs**
* If an app supports types (e.g. infolog, tracker, adress book), the admin can select for which types the custom field should show up, by selecting the types or empty for all.
* If "Required" is set, an entry of that type can't be saved, as long as the field is not set!
* If the admin specifies the attribute "Private", the custom field is only displayed to this users or groups!
After changing the permissions you need to clear the cache (Admin -> clear cache" as permissions are cached!
* The order can be changed by inserting a number between 2 custom fields
* the custom field name can't be changed as the name is used in the database! But the admin can change the label which is displayed to the users. We recommend to avoid space and umlaute in the custom fields name. They can still be used easily in the custom fields label.
* **NEW**: **The admin can specify a tab name for each custom field. The tabs are generated automatically in the order of the first appearance**. By default all custom field tabs are showing up before the history tab, but this can be changed in the eTemplate by attribute cfPrepend. **Please also look at the examples below, from address book, using custom fields in different tabs.**
![Custom Adressbook etemplate with automatic custom tabs](https://www.egroupware.org/wp-content/uploads/Bewerberdaten.png)
**Example two infolog with lots of custom fields in several tabs and a custom etemplate with some custom buttons and logic**
**Example two: Infolog with lots of custom fields in several tabs and a custom etemplate with some custom buttons and logic**
![Custom Infolog etemplate with automatic customs tabs and buttons](https://www.egroupware.org/wp-content/uploads/Bewerbung.png)
**2. Details of custom fields and options**