mirror of
https://github.com/EGroupware/egroupware.git
synced 2025-02-16 10:21:23 +01:00
Updated EGroupware Customizing (markdown)
Birgit Becker
parent
e42a9587e5
commit
7236f59a3a
@ -1,4 +1,4 @@
|
||||
# EGroupware Customizing in general, custom translations, custom fields and/or custom etemplates
|
||||
# EGroupware Customizing in general, custom translations, custom fields and/or custom eTemplates
|
||||
## Customize-general
|
||||
**1. Upload Logos, favicon, background image and fonts for EGroupware**
|
||||
* Go to Admin -> App configuration -> Tab appearance
|
||||
@ -21,8 +21,8 @@ Please be aware that a custom font used in an email is not embedded in the sent
|
||||
|
||||
* 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"
|
||||
|
||||
* If the admin want to customize the registration form with more details, this can be done with a custom eTemplate "registration_form.xet"
|
||||
|
||||
|
||||
**4. Change login screen message** e.g. to add infos or imprint to the login page
|
||||
* Go to Admin-> Change login screen message
|
||||
@ -38,22 +38,22 @@ Please be aware that a custom font used in an email is not embedded in the sent
|
||||
|
||||
## Custom-fields
|
||||
**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" ...
|
||||
* 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" ...
|
||||
|
||||
* 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 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.**
|
||||
|
||||
**Example two: Infolog with lots of custom fields in several tabs and a custom etemplate with some custom buttons and logic**
|
||||
|
||||
* **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.**
|
||||
|
||||
**Example two: Infolog with lots of custom fields in several tabs and a custom eTemplate with some custom buttons and logic**
|
||||
|
||||
|
||||
**2. Details of custom fields and options**
|
||||
* Custom fields of type label or header are spanning all columns, while "regular custom fields" are displaying in 2 columns with label and value. If custom fields are having long labels and you want to change the width of the label column, this can be done by css in the etemplate using "styles" e.g.
|
||||
* Custom fields of the type "label" or "header" are spanning all columns, while "regular custom fields" are displayed in 2 columns with label and value. If custom fields have to display long labels and you want to change the width of the label column, this can be done by CSS in the eTemplate using "styles" e.g.
|
||||
```
|
||||
<styles>
|
||||
table.et2_customfield_list tr td:first-child {
|
||||
@ -63,31 +63,33 @@ After changing the permissions you need to clear the cache (Admin -> clear cache
|
||||
}
|
||||
</styles>
|
||||
```
|
||||
* Custom fields of type "selectbox" (or Radio button) can specify the values in options (splited by new line) e.g.
|
||||
* Custom fields of type "selectbox" (or radio button) can for example specify the values in options (splitted by a new line).
|
||||
```
|
||||
=select one
|
||||
english=english | Englisch
|
||||
french=french | Französisch
|
||||
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.
|
||||
The part before "=" specifies the value stored in the database, while the label behind "=" is what is displayed to the user.
|
||||
We recommend to avoid space and umlaute for the value and don't change it. The label can be adapted at any time as well as its possible to add new values to the select box options.
|
||||
* 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.
|
||||
With option "maxlength=2000" the allowed text length can be specified, so the 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/" the user can upload multiple files, while if just a name is given e.g. "Teamfoto" the single image gest uploaded and renamed accordingly. You have the possibilty to specify several options 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 automatically generate a number, starting from option "last" and optional using a filter criteria like "info_status=archived" or "invoiced", which sets the number only, if that status is set. See example below right side.
|
||||
|
||||
|
||||
## 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 the admin can mount eTemplates-Directory into filemanager** in Admin -> Applications -> Filemanager -> VFS mounts and versioning by simply clicking on the button:
|
||||
* This is NOT meant as a full introduction or manual for eTemplate usage, it's just a rough overview, especially about the modification with custom fields.
|
||||
* **Reference for widgets** (a full documentation is planned, but not yet done!): https://etemplate.egroupware.org/
|
||||
Additionally there is a dtd-file specified in the xet-files it self, which contains lots of specifications and attributes. The dtd can be read from typical developer tools like PhpStorm.
|
||||
* **IN EGroupware EPL version the admin can mount an eTemplates-Directory into filemanager** in Admin -> Applications -> Filemanager -> VFS mounts and versioning by simply clicking on the button:
|
||||
|
||||
"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 ...
|
||||
* **You can specify in the eTemplate also custom CSS** by adding at the end "styles" e.g.
|
||||
This eTemplate-directory is build in as an "overlay" allowing file uploads for customizing.
|
||||
"eTemplate customzing" in EGroupware community version is only possible by using a GIT-clone installation as regular docker-installation will overwrite eTemplate changes with the next update.
|
||||
* **In filemanager there is now directly the directory "/etemplates"** with subdirectories of the applications e.g. "Address Book" or "Infolog". In the app-directory another subdirectory can be found called "templates" with two other subs "default" and "mobile".
|
||||
* If you check for example /etemplates/addressbook/templates/default you'll find 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 Address Book contact list and can be adapted, if you want to display custom fields in separat columns for example. 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, it's also possible to change "edit.xet" only for a specific type** by using the same name as for the type. Simple example: You have an additional contact type "Organisation" and like to use there an other eTemplate there. 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 second time, you get the original files again, that we provide. So you can easily start customizing ...
|
||||
* **In the eTemplate you can also specify custom CSS** by adding "styles" at the end. See example bellow:
|
||||
```
|
||||
<styles>
|
||||
.my_heading { font-weight: bold; font-size: 115%; `
|
||||
@ -108,5 +110,5 @@ With option "maxlength=2000" the allowed text length can be specified, so user c
|
||||
};
|
||||
</script>
|
||||
```
|
||||
* **NEW**: **Customfields do not longer need a specific customfield tab** in the template and the et2-tabbox, they get generated automatically taking some general attributes/properties into account: `cfPrepend="history"` (the default is before history-tab or at the end, if there is no history, but you can specify also other tabs or leave it empty, so tabs get generated from the beginning!); `cfExclude="customfield-name"` (comma separated for multiple fields), `cfTypeFilter="@info_type"` (infolog) or `cfTypeFilter="$cont[tid]"` (addressbook) and `cfPrivateTab="!$cont[no_private_cfs]"` (Addressbook only, as app-config allows to get private custom fields in a separate tab)
|
||||
* **If you want to position a customfield e.g. "customer-number" in an other tab**, you specify in et2-tabbox `cfExclude="customer-number"` and in the tab where it should be displayed simply `<customfields id="#customer-number" span="2"/>`.
|
||||
* **NEW**: **Customfields do not longer need a specific customfield tab** in the template and the et2-tabbox, they get generated automatically taking some general attributes/properties into account: `cfPrepend="history"` (the default is before history-tab or at the end, if there is no history, but you can also specify other tabs or leave it empty, so the tabs get generated from the beginning!); `cfExclude="customfield-name"` (comma separated for multiple fields), `cfTypeFilter="@info_type"` (infolog) or `cfTypeFilter="$cont[tid]"` (addressbook) and `cfPrivateTab="!$cont[no_private_cfs]"` (Address Book only, as app-config allows to get private custom fields in a separate tab)
|
||||
* **If you want to position a customfield e.g. "customer-number" in another tab**, you specify in et2-tabbox `cfExclude="customer-number"` and in the tab where it should be displayed simply `<customfields id="#customer-number" span="2"/>`.
|
||||
Loading…
Reference in New Issue
Block a user