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-19 11:34:38 +02:00
parent 0b37448d4b
commit e42a9587e5
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
EGroupware-Customizing.md

@ -37,9 +37,10 @@ Please be aware that a custom font used in an email is not embedded in the sent
![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)
**1. General Information**
* Custom fields are available in mostly all EGroupware apps (except email) and can be found in Admin -> Applications -> app name -> custom fields or in Admin Side menu bar. All EGroupware updates are taking custom fields into account to not break customizing.
* EGroupware has lots of different custom field types like "text", "select box", "link to Adress book, Infolog, Projectmanager" ...
![Admin - Application - Address book - custom fields](https://www.egroupware.org/wp-content/uploads/custom-fields.png)
* 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!
@ -71,7 +72,7 @@ german=german | Deutsch
```
The part before "=" specifies the value stored in the database, while the label behind "=" is what gets displayed to the user.
We recommend to avoid space and umlaute for the value and don't change it. Label can be adapted at any time as well as adding new values to the select box options.
* Admin can specify multiple rows (for text fields or select boxes),to get a textbox with X rows or a multi-selection.
* The admin can specify multiple rows (for text fields or select boxes),to get a textbox with X rows or a multi-selection.
With option "maxlength=2000" the allowed text length can be specified, so user can't add more characters.
* "Select entry - Filemanager" allows to select files from local or filemanager. If you specify a directory in the name e.g. "invoice/" user can upload multiple files, while if just a name is given e.g. "Teamfoto" the single image get uploaded and renamed accordingly. There can be several options specified like mime-type, accepted formats. max_file_size or options to hide Filemanager selection - see example below left side.
* "Serial number" can be used to generate automatically a number starting from option "last" and optional using a filter criteria like "info_status=archived" or "invoiced", which sets the number only, when that status is set. See example below right side.
@ -80,8 +81,9 @@ With option "maxlength=2000" the allowed text length can be specified, so user c
## Custom-eTemplates
* This is NOT meant as a full introduction or manual for eTemplate usage, its just a rough overview especially about modification with customfields
* **Reference for widgets** (a full documentation is planned, but not yet done!): https://etemplate.egroupware.org/
* **IN EGroupware EPL version Admin can mount eTemplates-Directory into filemanager** in Admin -> Applications -> Filemanager -> VFS mounts and versioning by simply clicking on the button:
* **IN EGroupware EPL version the admin can mount eTemplates-Directory into filemanager** in Admin -> Applications -> Filemanager -> VFS mounts and versioning by simply clicking on the button:
![Admin - Applications - Filemanager - VFS mounts and versioning](https://www.egroupware.org/wp-content/uploads/Mount-etemplates.png)
"eTemplate customzing" in EGroupware community version is only possible by using a GIT-clone installation as regular docker-installlation will overwrite eTemplate changes with the next update.
* **In filemanager there is now directly the directory "/etemplates"** with subdirectories of the applications e.g. "addressbook" or "infolog". In the app-directory is another subdirectory called "templates" with two other subs "default" and "mobile".
* If you check for example /etemplates/addressbook/templates/default you see files like "edit.xet", "display.xet" and "index.xet". "display.xet" is used in CRM-view, so if you want to show there additional information of an organization e.g. a customer-number this can be added there. "index.xet" is used for the addressbook contact list and can be adapted, if you e.g. want to display custom fields in separat columns. If you modify "edit-xet" this will be used for the editing (or read only) of contacts.
* **If you have different contact or infolog types, its also possible to change "edit.xet" only for a specific type** by using the same name like the type. Simple example you have an additional contact type "Organisation" and like to use there an other etemplate. You name it "edit.Organisation.xet" and upload it to filemanager. As soon as you reload EGroupware the new etemplate is used instead of the original "edit.xet" for the contact of type "Organisation". If you change "edit.xet", upload it and reload the browser its used instead for all contact types. As soon as you delete the added file and reload an other time, you get again the original files we provide. So you can easily start and customizing ...