a869d16a90ca2eb86de920273bf8088a8b422094
[moodle.git] / theme / upgrade.txt
1 This files describes API changes in /theme/* themes,
2 information provided here is intended especially for theme designer.
4 === 2.4 ===
6 required changes:
7 * output course and course content header/footer that may be returned by course format (see MDL-36048)
8 * span.completionprogress has been changed to a <div> and is not a float by default any more.
10 deprecation:
11 * i/roles: Use t/assignroles instead
12 * t/manual_item: Use i/manual_item instead
13 * t/unlock_gray: Use t/locked instead
14 * t/userblue: Previously used to unblock a user, use t/unblock.
15 * c/course: Use i/courseevent instead
16 * c/group: Use i/groupevent instead
17 * c/site: Use i/siteevent instead
18 * c/user: Use i/userevent instead
19 * t/clear: Use t/check instead
20 * i/cross_red_big: Use i/invalid or i/grade_incorrect
21 * i/tick_green_big: Use i/valid or i/grade_correct
22 * i/tick_amber_big: Use i/caution or i/grade_partiallycorrect
23 * No more small versions of i/cross_red_small, i/tick_green_small and i/tick_amber_small, use their big equivalent.
24 * t/addgreen: Use t/add instead.
25 * i/approve: Use t/approve instead
27 optional changes:
28 * new optional boolean parameter $withlinks for public function login_info() in lib/outputrenderers.php (MDL-31365)
29 * new layout option "nologinlinks" and new page layout "secure" e.g. for safebrowser and securewindow (MDL-31365)
30 * new class 'iconlarge' for 24x24 icons.
31 * new icons i/export and i/import (sized 16x16). Previously export and import actions used i/backup and i/restore.
32 * new icon i/assignroles (sized 16x16), to prevent the use of i/roles which is 12x12.
33 * new icon i/switchrole (sized 16x16), was previously using i/roles. Now is a copy of the new i/assignroles icon.
34 * new icons i/enrolusers and t/enrolusers, previsouly i/users was used.
35 * new icon t/cohorts (sized 12x12), to prevent the use of i/cohorts which is 16x16.
36 * new icons t/sort_asc, t/sort_desc to use for ordering in table headers.
37 * new class 'iconsort' for icons used for ordering in table headers.
38 * new icons t/locked and t/unlocked (12x12) which should be used when there is no action associated to the icon.
39 * new icons i/folder (16x16), monochrome equivalent to f/folder.
40 * new icons t/addcontact, t/removecontact and t/messages, previously t/addgreen, t/delete and t/log were used in messaging.
41 * new icons t/unblock and i/twoway.
42 * new icons i/courseevent, i/groupevent, i/siteevent and i/userevent (16x16) instead of c/* for calendar events.
43 * new icon t/markasread (12x12) to replace t/clear used in forums.
44 * new icon t/check (12x12) to replace t/clear which name does not reflect the icon meaning.
45 * new classes 'icon-pre' and 'icon-post' supposedly to be used when the icon is positioned before or after the text. This is not really used yet, but it's a start towards some standardisation of the icon selectors.
46 * new icons i/valid, i/caution and i/invalid for generic statuses.
47 * new icons i/grade_correct, i/grade_partiallycorrect and i/grade_incorrect for grades.
48 * new icon t/approve (12x12).
49 * new icon t/contextmenu (12x12) for a monochrome version of i/menu.
51 === 2.3 ===
53 optional changes:
54 * add new u/f3.png image when theme contains customised f1 and f2 default user images
56 === 2.2 ===
58 required changes:
59 * use new page content placeholder "echo $OUTPUT->main_content()" instead of "echo core_renderer::MAIN_CONTENT_TOKEN"
60   see git commit: 3b3f302855d7621405a8b93e49bd399d67a998d7
61 * upgrade report selectors: search for "-course-report-" and replace with "-report-"