Moodle release 3.2rc2
[moodle.git] / theme / upgrade.txt
CommitLineData
0f704140
PS
1This files describes API changes in /theme/* themes,
2information provided here is intended especially for theme designer.
edb7d5ad 3
2258b4dc
FM
4=== 3.2 ===
5
4af34676
DP
6* mod_chat will not display the 'course theme' option for all themes (previously it was only displayed on
7 bootstrap2 based themes).
0f73f3ab 8* A new theme config 'undeletableblocktypes' allows a theme to define which blocks are deletable.
2258b4dc
FM
9* A new core setting now enables admins to upload the logos of their site. Using the
10 following methods, themers can instantly support branding logos without the need
11 to implement specific theme settings:
12 * $OUTPUT->get_logo_url($maxwidth, $maxheight);
13 * $OUTPUT->get_compact_logo_url($maxwidth, $maxheight);
644fcbb6
DW
14Removed themes:
15 * base, canvas
16 During the upgrade process the themes will be uninstalled and all their settings will be deleted.
17 If you wish to keep your theme and its settings, download it from moodle.org and put it back in
18 the theme/ directory BEFORE UPGRADING.
19 * CLI svgtool.php has moved from theme/base/cli to admin/cli and paths should be relative to the new location.
2ede86d7 20* Bootstrap 4 was added as part of a the new theme 'boost'.
d3c35f93 21* Themes can now automatically compile SCSS on the fly. This works the same way as it
41b973bc 22 does compiling LESS on the fly, effecitvely adding $THEME->scss to your config.
258143e3 23* Two new callbacks allow themes to inject SCSS code before and after the content provided
41b973bc
FM
24 by the SCSS file $THEME->scss. See $THEME->prescsscallback and $THEME->extrascsscallback.
25* $THEME->scss can also be a Closure which will return the main SCSS content.
d3c35f93
FM
26* Using .dir-rtl for RTL styling is deprecated and should not be used any more. From now
27 the styles are automatically flipped when the language is right-to-left. However,
28 as this is not always perfect, you can define exceptions. Please refer to the documentation
29 of the tool RTLCSS-PHP for more information: https://github.com/moodlehq/rtlcss-php
30* The class .dir-ltr should not be used any more. To force LTR styles use the directive
31 to remove the rule when the language is RTL. See RTLCSS-PHP for more information.
113efed5
FM
32* A new class .text-ltr may be used to force the direction to LTR. This is especially useful
33 for forms fields (numbers, emails, URLs must not be RTL'd), and for displaying code
34 snippets or configuration samples.
d3c35f93
FM
35* A new callback can be defined to post process the CSS using an object representation
36 of the CSS tree ($THEME->csstreepostprocess). This gives a lot more flexibility than a
2ede86d7 37 simplel find and replace. Refer to 'boost' for an example, and to PHP-CSS-Parser
d3c35f93 38 (https://github.com/sabberworm/PHP-CSS-Parser) for the API.
4f2378d9
FM
39* You may no longer override the following core_course_renderer methods.
40 See course/upgrade.txt for more information:
41 - course_modchooser_module_types
42 - course_modchooser_module
43 - course_modchooser_title
891750bc
FM
44* The question chooser now uses a renderable and a template, the following methods
45 have been deprecated in favour of core_question_bank_renderer::render_qbank_chooser().
46 - qbank_chooser
47 - qbank_chooser_types
48 - qbank_chooser_qtype
49 - qbank_chooser_title
d52ebf11
DP
50* The 'css optimiser' has been removed. Developers are encouraged to use tools such as stylelint
51 to help optimise their css. Some functions and classes in lib/csslib.php (which was not for public use)
52 have been deprecated:
53 - css_is_colour
54 - css_is_width
55 - css_sort_by_count
56 - class css_optimiser no longer does anything.
2258b4dc 57
4040c8b3
DM
58=== 3.1 ===
59
60* A new search box for global search has been added to bootstrap and clean layout files, if
61 your theme is overwriting columns1.php, columns2.php or columns3.php you will need to add a
62 call to core_renderer::search_box to display it.
24346803
AN
63* Notification templates have been renamed to better suit types of alert
64 rather than uses. The following changes have been made:
65 * notification_problem.mustache => notification_error.mustache
66 * notification_message => notification_info
67 * notification_redirect => notification_warning
f59f89b4
MG
68* Method core_course_renderer::course_section_cm_name() is split into two methods, custom themes that override
69 this method must be modified or otherwise editing functionality may become broken. This method is now also used by
70 social activities block and site menu block to display activities names.
4040c8b3 71
c7b73854 72=== 3.0 ===
73
74* The renderer function core_availability_renderer::multiple_messages was changed to
75 render_core_availability_multiple_messages, requiring a parameter of the new
76 \core_availability\multiple_messages type.
5e9a937b
JO
77* Meta description is now included in standard_head_html for homepage in bootstrapbase.
78 If your theme includes a meta description directly in a layout for the frontpage,
79 you will need to remove it or override the standard_head_html instead.
45cd3f60
DM
80* Themes Clean and More have been updated to use a new navbar_button function, which shows the
81 hamburguer icon (responsive menu) or not depending on custom and language menus settings;
82 themes extending bootstrapbase and overriding its layouts can call replace their "a.btn-navbar"
83 node for a call to this function.
c47f3803 84* Themes Clean and More page header logo only displays on front page and login page.
c08b52aa
DM
85* A new function navbar_home has been added to theme_clean and theme_more to display the navigation bar link
86 to the site home. Two new settings have been added to control if the link should be a small logo image, text
87 or both. It defaults to the current behaviour, only a text link.
c7b73854 88
c58891f1
ME
89=== 2.9 ===
90
73b425be
ME
91* Themes Bootstrapbase, Clean and More have undergone some changes for RTL layouts see - MDL-48160.
92
c58891f1 93* Themes Clean amd More page header background logo, if loaded, no longer links to the home page.
c36c3d07
AG
94* Themes Clean and More have been updated to use the renderer full_header(). This renderer (when in a user context) displays a message button
95 and consequently the link to message users have been removed from various pages. It is recommended that theme developers use this
96 renderer to ensure that they do not suffer from a reduction in access to this feature.
97* $OUTPUT->context_header() has been introduced to produce headers similar to what full_header() creates. This renderer is used for creating
98 subsequent headers in a page. If provided with user information, this render will also display a message button like full_header().
c58891f1 99
c10fa5da 100=== 2.8 ===
c58891f1 101
a2633964
ME
102* Themes Base and Canvas layout/embedded.php has changed.
103 The div id="content" has been changed to id="page-content" - see MDL-47915.
c10fa5da
DW
104* All mod_assign CSS selectors have been qualified with ".path-mod-assign". This means any custom CSS
105 rules for mod_assign in a theme may need to be updated.
ebdcb292
SH
106* The following render methods were renamed, if you have overridden any of these you will need to update your renderer:
107 - report_log_renderer::render_report_log_renderable => report_log_renderer::render_report_log
108 - report_loglive_renderer::render_report_loglive_renderable => report_loglive_renderer::render_report_log
a2a4ad89 109* On calendar view screen the course selector and new event button have been swapped, custom CSS for .path-calendar might be affected.
2f6a0e5f
MN
110* The functions search_listing() and search_pagination() in the core_course_management_renderer class take the searched string
111 as an extra parameter - see MDL-46902.
f2b4b2ad 112* Themes with non-fixed headers must have the .navbar class in their navbar in order for floating headers in the grader report to work - see MDL-46658.
6d8eba1a
JC
113* To accomodate the new gradebook, use of overflow: hidden or overflow-x: hidden CSS rules on DOM elements containing the
114 #user-grades table, visible at [Course administration -> Grades] is not recommended. Please use overflow: auto or
115 overflow: scroll instead, as this will handle medium to large courses with multiple activities better (more information available at https://docs.moodle.org/dev/Theme_upgrade_notes ).
116* The new user menu can be added to themes by calling $OUTPUT->user_menu(); we recommend doing so in a backwards-compatible way (see https://docs.moodle.org/dev/Theme_upgrade_notes for more information).
c10fa5da 117
6b216432
AA
118=== 2.7 ===
119
31f28b6a
120* CSS related functions in theme class and csslib.php were refactored, addons that are
121 using this private API need to be updated
ba55be91 122* Please update your css to use 'tr:nth-of-type(odd/even)' instead of '.r0/.r1' to apply tr specific css for various tables.
98396c23
SH
123 These classes are deprecated now and will be removed in Moodle 2.9. This has done to better support styling tables that will be altered by JavaScript.
124 Here is an example to update your css:
125 Old code:
126 table.generaltable .r0 {background-color: #F0F0F0;}
127 table.generaltable .r1 {background-color: #F0F0F0;}
128 New code:
98396c23 129 table.generaltable > tbody > tr:nth-of-type(even) {background-color: #F0F0F0;}
ba55be91 130 table.generaltable > tbody > tr:nth-of-type(odd) {background-color: #F0F0F0;}
6b216432 131
7a2dabcb
FM
132Removed themes:
133* afterburner, anomaly, arialist, binarius, boxxie, brick, formal_white, formfactor, fusion, leatherbound,
134 magazine, nimble, nonzero, overlay, serenity, sky_high, splash, standard and standardold have been removed.
135 During the upgrade process the themes will be uninstalled and all their settings will be deleted.
136 If you wish to keep your theme and its settings, download it from moodle.org and put it back in
137 the theme/ directory BEFORE UPGRADING.
6b216432 138
71715870
JC
139Notes:
140* z-index on #dock has been adjusted from 11000 to 5000 to prevent overlapping issues with fullscreen TinyMCE in Base theme.
141
699e2fd0 142=== 2.6 ===
3b42864d 143
7c2efc11
JM
144Removed themes:
145* "My Mobile" theme has been removed (see MDL-40874).
146 During the upgrade process "My Mobile" theme will be uninstalled and all its settings will be deleted.
147 "My Mobile" theme and its extending themes will fallback to the mobile friendly "Clean" theme.
148 If you wish to keep "My Mobile" theme and its settings, BEFORE UPGRADING you can copy the files from the
149 unmaintained plugin into theme/mymobile.
150 The unmaintained plugin can be downloaded at https://moodle.org/plugins/pluginversion.php?id=4563
699e2fd0 151Notes:
faf6010b 152* There have been several changes made to the classes used on headings throughout Moodle.
153 This was done as per the Moodle HTML guidelines. h1 and h2 elements should have no classes, h3 and lower headings
154 may have descriptive classes only (any classes must properly describe the relation between the header and its content).
699e2fd0 155* The parameters value for the following functions have been modified: core_renderer::heading() and core_renderer::heading_with_help().
3b42864d 156 This means that headings using the default options will no longer have the class "main" which was the previous default.
d61c96b6 157* The file picker and activity chooser have been converted to use M.core.dialogue. This means the styles
3b42864d
RW
158 for these elements have changed in the base and bootstrapbase themes and you will need to copy the new styles
159 if you are not inheriting from either one of these themes.
b4c6b42e 160* For the themes based on bootstrapbase please also read theme/bootstrapbase/upgrade.txt
e5de4933
SH
161* A new component action_menu is now used to display editing icons for courses and blocks within a drop down. If you have a theme that doesn't
162 extend base, canvas, or clean then you will need to style for this new component within your theme.
166ac0a3
SH
163* The maintenance layout now has a special renderer that extends the core_renderer in order to prevent some methods from interacting
164 with the database. Please be aware that for the maintenance layout some methods now always return an empty string.
165 This has been done because it is important that during maintenance routines we don't show any links, interact with the database,
166 or interact with caches as doing so may lead to errors,
167 Please see the maintenance renderer notes below for details on the functions affected.
e5de4933
SH
168
169Renderer changes:
170* core_course_renderer::course_section_cm_edit_actions has two new optional arguments and now uses and action_menu component.
171* core_course_renderer::course_section_cm has been altered to call core_course_renderer::course_section_cm_edit_actions with the two new arguments.
172* core_renderer::block_controls has a new optional argument (the block id) and has been altered to use the new action_menu component.
173* core_renderer::block_header has been altered to give core_renderer::block_controls the new second argument, the block id.
174* core_renderer::action_link has a new argument, and optional icon that can be rendererd into the link.
175
faf6010b 176Selector changes:
177* Changes to the classes given to the header produced when rendering a single section within a course.
178 .section-navigation.header.headingblock => .section-navigation.navigationtitle
179* Changes to the classes used when producing the course information box that lists courses.
180 The name (h3|div} of both courses and categories used to have .name, for courses in the list this was changed to .coursename and for categories in the list this was changed to .categoryname.
181* Classes ".header and .headingblock" were removed from all front page content headings.
182* Classes ".headingblock .header .tag-header" were removed from the tag index page
183
166ac0a3
SH
184Maintenance renderer notes:
185When the maintenance layout is being used $OUTPUT will be an instance of core_renderer_maintenance.
186This renderer mimics the core_renderer except that the following functions always return an empty string.
cf9f5a17 187* core_renderer_maintenance::block
188* core_renderer_maintenance::blocks
189* core_renderer_maintenance::blocks_for_regions
190* core_renderer_maintenance::course_header
191* core_renderer_maintenance::course_footer
192* core_renderer_maintenance::course_content_header
193* core_renderer_maintenance::course_content_footer
194* core_renderer_maintenance::custom_menu
195* core_renderer_maintenance::file_picker
196* core_renderer_maintenance::htmllize_file_tree
197* core_renderer_maintenance::lang_menu
198* core_renderer_maintenance::login_info
199* core_renderer_maintenance::user_picture
166ac0a3
SH
200
201If you have overridden methods of the core_renderer in your theme and want those changes to be shown during times of maintenance you
202will also need to override the core_renderer_maintenance and copy your customisations from the core_renderer to that.
203
90160639 204=== 2.5.1 ===
d3e5a21e
SH
205
206Notes:
207* Block drag and drop functionality has been improved so that it works regardless of what block regions you use
208 or how many block regions you have. In order to benefit from this improvement you must convert your calls from
209 $OUTPUT->blocks_for_region() to $OUTPUT->blocks.
210
211Optional changes:
212* Theme config can nominate block regions to swap if the user is using a rtl languages such as Hebrew.
213 $THEME->blockrtlmanipulations should be an associative array, the key is the original block region, and the
214 value should be where the blocks in that region should be displayed.
215* New $OUTPUT methods to replace code that was previously using $PAGE. Converting to these methods is optional
216 but highly recommended. Refer to the bootstrapbase layouts for examples.
217 - $OUTPUT->body_attributes() returns a string you can use for the body id and classes.
218 - $OUTPUT->blocks() returns HTML to display a block region and all of its blocks. This adds data attributes
219 that ensure drag and drop of blocks will work no matter what block regions or how many you have.
220 - $OUTPUT->page_heading() returns the page heading. Replaces $PAGE->heading.
221 - $OUTPUT->page_heading_button() returns the button to display with the heading. Replaces $page->button.
222 - $OUTPUT->page_doc_link() returns the link to moodle docs for the page. Replaces page_doc_link().
223 - $OUTPUT->page_heading_menu() returns the heading menu for the page. Replaces $PAGE->headingmenu.
224 - $OUTPUT->page_title() Returns the title to use for the head section.
225 - $OUTPUT->favicon() returns the URL to the favicon.
226
227Renderer changes:
228* core_renderer::navbar now returns an empty string if there are no navigation items to display.
229* core_renderer::custom_menu now adds a class "custom_menu" to the div that contains the HTML for the custom menu.
230
fc7defef
JF
231=== 2.5 ===
232
09ae7ee0
MG
233required changes:
234* Functions core_course_renderer::course_category_tree() and course_category_tree_category()
235 are deprecated
236* Significant changes in rendering of courses and categories listings, lots of CSS classes changed,
237 several functions such as print_courses(), print_whole_category_list(), print_category_info()
238 are moved to course renderer.
239 See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
240
fc7defef
JF
241DOM changes:
242* changed the h1 title in the help popup to a h2.
97dbc8f2 243* new setting $THEME->yuicssmodules = array('cssreset', 'cssfonts', 'cssgrids', 'cssbase'); which
12cb45f1 244 allows themes to use different CSS reset normalisers such as cssnormalize YUI module.
6e5d002e 245* Re-wrote the user profile views to definition lists.
12cb45f1
MN
246* Re-wrote the table for the course completion status block to use html_table - added some CSS classes to
247 the table in the process (see MDL-35608).
5581c618 248* Cancel buttons have the class btn-cancel.
12cb45f1
MN
249* Added a z-index for the div#dateselector-calendar-panel so that the calendar pop-up renders above
250 the filemanager when they overlap, ie. the course settings page (see MDL-39047).
9074e478
DM
251* Trivial change of CSS selectors used to display plugin status at the plugins overview
252 screen (#plugins-control-panel).
fc7defef 253
6671fa73
JF
254Renderer changes:
255* Mymobile theme changed to support more verbose move-block-here descriptions.
256
2d0e682d
MV
257=== 2.4 ===
258
52b1ed5e
MG
259required changes:
260* output course and course content header/footer that may be returned by course format (see MDL-36048)
e40bd746 261* span.completionprogress has been changed to a <div> and is not a float by default any more.
52b1ed5e 262
fbb207c5
FM
263deprecation:
264* i/roles: Use t/assignroles instead
0cddd851
FM
265* t/manual_item: Use i/manual_item instead
266* t/unlock_gray: Use t/locked instead
f2bba619 267* t/userblue: Previously used to unblock a user, use t/unblock.
5326675e
BR
268* c/course: Use i/courseevent instead
269* c/group: Use i/groupevent instead
270* c/site: Use i/siteevent instead
271* c/user: Use i/userevent instead
99938034 272* t/clear: Use t/check instead
c3847443
FM
273* i/cross_red_big: Use i/invalid or i/grade_incorrect
274* i/tick_green_big: Use i/valid or i/grade_correct
275* i/tick_amber_big: Use i/caution or i/grade_partiallycorrect
276* No more small versions of i/cross_red_small, i/tick_green_small and i/tick_amber_small, use their big equivalent.
501380a9 277* t/addgreen: Use t/add instead.
851d3b7a 278* i/approve: Use t/approve instead
fbb207c5 279
2d0e682d
MV
280optional changes:
281* new optional boolean parameter $withlinks for public function login_info() in lib/outputrenderers.php (MDL-31365)
282* new layout option "nologinlinks" and new page layout "secure" e.g. for safebrowser and securewindow (MDL-31365)
bb128107 283* new class 'iconlarge' for 24x24 icons.
fbb207c5
FM
284* new icons i/export and i/import (sized 16x16). Previously export and import actions used i/backup and i/restore.
285* new icon i/assignroles (sized 16x16), to prevent the use of i/roles which is 12x12.
286* new icon i/switchrole (sized 16x16), was previously using i/roles. Now is a copy of the new i/assignroles icon.
c42651d6
FM
287* new icons i/enrolusers and t/enrolusers, previsouly i/users was used.
288* new icon t/cohorts (sized 12x12), to prevent the use of i/cohorts which is 16x16.
06b7ed0a
FM
289* new icons t/sort_asc, t/sort_desc to use for ordering in table headers.
290* new class 'iconsort' for icons used for ordering in table headers.
fa9c0aab 291* new icons t/locked and t/unlocked (12x12) which should be used when there is no action associated to the icon.
0cddd851 292* new icons i/folder (16x16), monochrome equivalent to f/folder.
f2bba619
FM
293* new icons t/addcontact, t/removecontact and t/messages, previously t/addgreen, t/delete and t/log were used in messaging.
294* new icons t/unblock and i/twoway.
5326675e 295* new icons i/courseevent, i/groupevent, i/siteevent and i/userevent (16x16) instead of c/* for calendar events.
99938034
FM
296* new icon t/markasread (12x12) to replace t/clear used in forums.
297* new icon t/check (12x12) to replace t/clear which name does not reflect the icon meaning.
c22fbd38 298* 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.
c3847443
FM
299* new icons i/valid, i/caution and i/invalid for generic statuses.
300* new icons i/grade_correct, i/grade_partiallycorrect and i/grade_incorrect for grades.
851d3b7a 301* new icon t/approve (12x12).
0348468b 302* new icon t/contextmenu (12x12) for a monochrome version of i/menu.
ee362526 303
33d9f44b
PS
304=== 2.3 ===
305
306optional changes:
307* add new u/f3.png image when theme contains customised f1 and f2 default user images
308
0f704140
PS
309=== 2.2 ===
310
311required changes:
312* use new page content placeholder "echo $OUTPUT->main_content()" instead of "echo core_renderer::MAIN_CONTENT_TOKEN"
ee362526 313 see git commit: 3b3f302855d7621405a8b93e49bd399d67a998d7
2d0e682d 314* upgrade report selectors: search for "-course-report-" and replace with "-report-"