Skip to content

Commit 44ecfd0

Browse files
marvin-matuschekmjansenDatabay
authored andcommitted
adds documentation for email customizing
1 parent c3299d2 commit 44ecfd0

1 file changed

Lines changed: 38 additions & 3 deletions

File tree

templates/Readme.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,42 @@ or
121121

122122
for a minified CSS version.
123123

124-
#### Step 4: Add Icons (Optional)
124+
#### Step 4: Mail styling
125+
ILIAS 12 features a new, modern email design.
126+
This can also be customized using a custom system style.
127+
Both the styling and the layout can be changed as follows:
128+
129+
##### Step 4.1: Sass
130+
The file `templates/default/mail.scss` provides the CSS for the mail template.
131+
This can be overwritten in the custom system style.
132+
To do this, the following file must exist in the custom system style:
133+
`public/Customizing/skin/<myskin>/mail.scss` or `public/Customizing/skin/<myskin>/<mystyle>/mail.scss`.
134+
135+
Please note: this must be compiled separately into `mail.css`.
136+
By copying and compiling the file from `templates/default/mail.scss` to the custom system style, variables such as the text color and link color are automatically used for the mail styling.
137+
138+
##### Step 4.2: Template
139+
The file `components/ILIAS/UI/src/templates/default/Layout/tpl.mailpage.html` forms the HTML framework for the email and can be overwritten in the same way as all other templates via the path `public/Customizing/skin/<myskin>/<mystyle>/UI/Layout/tpl.mailpage.html`.
140+
141+
##### Step 4.3: Logo
142+
When a custom system style is enabled, a logo is searched for along the following paths and in the given sequence:
143+
1. `public/Customizing/skin/<myskin>/images/logo/Logo.svg`
144+
2. `public/Customizing/skin/<myskin>/images/logo/HeaderIcon.svg`
145+
3. `public/Customizing/skin/<myskin>/<mystyle>/images/logo/Logo.svg`
146+
4. `public/Customizing/skin/<myskin>/<mystyle>/images/logo/HeaderIcon.svg`
147+
5. The first compatible file in `public/Customizing/skin/<myskin>/images/logo/`
148+
6. The first compatible file in `public/Customizing/skin/<myskin>/<mystyle>/images/logo/`
149+
7. The ILIAS standard logo
150+
151+
The first match will be used as the logo for the email.
152+
In addition to .svg, the following formats are also supported for the logo:
153+
- jpg
154+
- jpeg
155+
- gif
156+
- png
157+
158+
159+
#### Step 5: Add Icons (Optional)
125160

126161
If you want to replace the default icons coming with ILIAS, you can add new
127162
representations of them to your skin. They must be stored in a subdirectory
@@ -139,7 +174,7 @@ all of them via the ILIAS administration:
139174

140175
Administration / Repository and Objects / Files / File Objects: Suffix-Specific Icons
141176

142-
#### Step 5: Change Layout (Optional)
177+
#### Step 6: Change Layout (Optional)
143178

144179
The layout is specified in HTML template files. Some standard default template
145180
files can be found in directory `templates/default`. Other template files are
@@ -182,7 +217,7 @@ Also checkout the breadcrumb scss variables.
182217
* Startup Screens (Login, Registration, ...): `components/ILIAS/Init/templates/default/tpl .startup_screen.html`
183218

184219

185-
#### Step 6: Change the ILIAS Icon
220+
#### Step 7: Change the ILIAS Icon
186221

187222
The main ILIAS icon is stored in the images Directory as `logo/HeaderIcon.svg`. You
188223
can replace this easyly by your own Icon in svg format. As long as your Icon is

0 commit comments

Comments
 (0)