MDL-55445 files: Helper functions related to serving and caching
[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 === 3.1 ===
6 * A new search box for global search has been added to bootstrap and clean layout files, if
7   your theme is overwriting columns1.php, columns2.php or columns3.php you will need to add a
8   call to core_renderer::search_box to display it.
9 * Notification templates have been renamed to better suit types of alert
10   rather than uses. The following changes have been made:
11   * notification_problem.mustache => notification_error.mustache
12   * notification_message          => notification_info
13   * notification_redirect         => notification_warning
14 * Method core_course_renderer::course_section_cm_name() is split into two methods, custom themes that override
15   this method must be modified or otherwise editing functionality may become broken. This method is now also used by
16   social activities block and site menu block to display activities names.
18 === 3.0 ===
20 * The renderer function core_availability_renderer::multiple_messages was changed to
21   render_core_availability_multiple_messages, requiring a parameter of the new
22   \core_availability\multiple_messages type.
23 * Meta description is now included in standard_head_html for homepage in bootstrapbase.
24   If your theme includes a meta description directly in a layout for the frontpage,
25   you will need to remove it or override the standard_head_html instead.
26 * Themes Clean and More have been updated to use a new navbar_button function, which shows the
27   hamburguer icon (responsive menu) or not depending on custom and language menus settings;
28   themes extending bootstrapbase and overriding its layouts can call replace their "a.btn-navbar"
29   node for a call to this function.
30 * Themes Clean and More page header logo only displays on front page and login page.
31 * A new function navbar_home has been added to theme_clean and theme_more to display the navigation bar link
32   to the site home. Two new settings have been added to control if the link should be a small logo image, text
33   or both. It defaults to the current behaviour, only a text link.
35 === 2.9 ===
37 * Themes Bootstrapbase, Clean and More have undergone some changes for RTL layouts see - MDL-48160.
39 * Themes Clean amd More page header background logo, if loaded, no longer links to the home page.
40 * Themes Clean and More have been updated to use the renderer full_header(). This renderer (when in a user context) displays a message button
41   and consequently the link to message users have been removed from various pages. It is recommended that theme developers use this
42   renderer to ensure that they do not suffer from a reduction in access to this feature.
43 * $OUTPUT->context_header() has been introduced to produce headers similar to what full_header() creates. This renderer is used for creating
44   subsequent headers in a page. If provided with user information, this render will also display a message button like full_header().
46 === 2.8 ===
48 * Themes Base and Canvas layout/embedded.php has changed.
49   The div id="content" has been changed to id="page-content" - see MDL-47915.
50 * All mod_assign CSS selectors have been qualified with ".path-mod-assign". This means any custom CSS
51   rules for mod_assign in a theme may need to be updated.
52 * The following render methods were renamed, if you have overridden any of these you will need to update your renderer:
53   - report_log_renderer::render_report_log_renderable         => report_log_renderer::render_report_log
54   - report_loglive_renderer::render_report_loglive_renderable => report_loglive_renderer::render_report_log
55 * On calendar view screen the course selector and new event button have been swapped, custom CSS for .path-calendar might be affected.
56 * The functions search_listing() and search_pagination() in the core_course_management_renderer class take the searched string
57   as an extra parameter - see MDL-46902.
58 * 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.
59 * To accomodate the new gradebook, use of overflow: hidden or overflow-x: hidden CSS rules on DOM elements containing the
60   #user-grades table, visible at [Course administration -> Grades] is not recommended. Please use overflow: auto or
61   overflow: scroll instead, as this will handle medium to large courses with multiple activities better (more information available at ).
62 * The new user menu can be added to themes by calling $OUTPUT->user_menu(); we recommend doing so in a backwards-compatible way (see for more information).
64 === 2.7 ===
66 * CSS related functions in theme class and csslib.php were refactored, addons that are
67   using this private API need to be updated
68 * Please update your css to use 'tr:nth-of-type(odd/even)' instead of '.r0/.r1' to apply tr specific css for various tables.
69   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.
70   Here is an example to update your css:
71   Old code:
72     table.generaltable .r0 {background-color: #F0F0F0;}
73     table.generaltable .r1 {background-color: #F0F0F0;}
74   New code:
75     table.generaltable > tbody > tr:nth-of-type(even) {background-color: #F0F0F0;}
76     table.generaltable > tbody > tr:nth-of-type(odd) {background-color: #F0F0F0;}
78 Removed themes:
79 * afterburner, anomaly, arialist, binarius, boxxie, brick, formal_white, formfactor, fusion, leatherbound,
80   magazine, nimble, nonzero, overlay, serenity, sky_high, splash, standard and standardold have been removed.
81   During the upgrade process the themes will be uninstalled and all their settings will be deleted.
82   If you wish to keep your theme and its settings, download it from and put it back in
83   the theme/ directory BEFORE UPGRADING.
85 Notes:
86 * z-index on #dock has been adjusted from 11000 to 5000 to prevent overlapping issues with fullscreen TinyMCE in Base theme.
88 === 2.6 ===
90 Removed themes:
91 * "My Mobile" theme has been removed (see MDL-40874).
92   During the upgrade process "My Mobile" theme will be uninstalled and all its settings will be deleted.
93   "My Mobile" theme and its extending themes will fallback to the mobile friendly "Clean" theme.
94   If you wish to keep "My Mobile" theme and its settings, BEFORE UPGRADING you can copy the files from the
95   unmaintained plugin into theme/mymobile.
96   The unmaintained plugin can be downloaded at
97 Notes:
98 * There have been several changes made to the classes used on headings throughout Moodle.
99   This was done as per the Moodle HTML guidelines. h1 and h2 elements should have no classes, h3 and lower headings
100   may have descriptive classes only (any classes must properly describe the relation between the header and its content).
101 * The parameters value for the following functions have been modified: core_renderer::heading() and core_renderer::heading_with_help().
102   This means that headings using the default options will no longer have the class "main" which was the previous default.
103 * The file picker and activity chooser have been converted to use M.core.dialogue. This means the styles
104   for these elements have changed in the base and bootstrapbase themes and you will need to copy the new styles
105   if you are not inheriting from either one of these themes.
106 * For the themes based on bootstrapbase please also read theme/bootstrapbase/upgrade.txt
107 * 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
108   extend base, canvas, or clean then you will need to style for this new component within your theme.
109 * The maintenance layout now has a special renderer that extends the core_renderer in order to prevent some methods from interacting
110   with the database. Please be aware that for the maintenance layout some methods now always return an empty string.
111   This has been done because it is important that during maintenance routines we don't show any links, interact with the database,
112   or interact with caches as doing so may lead to errors,
113   Please see the maintenance renderer notes below for details on the functions affected.
115 Renderer changes:
116 * core_course_renderer::course_section_cm_edit_actions has two new optional arguments and now uses and action_menu component.
117 * core_course_renderer::course_section_cm has been altered to call core_course_renderer::course_section_cm_edit_actions with the two new arguments.
118 * core_renderer::block_controls has a new optional argument (the block id) and has been altered to use the new action_menu component.
119 * core_renderer::block_header has been altered to give core_renderer::block_controls the new second argument, the block id.
120 * core_renderer::action_link has a new argument, and optional icon that can be rendererd into the link.
122 Selector changes:
123 * Changes to the classes given to the header produced when rendering a single section within a course.
124   .section-navigation.header.headingblock => .section-navigation.navigationtitle
125 * Changes to the classes used when producing the course information box that lists courses.
126   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.
127 * Classes ".header and .headingblock" were removed from all front page content headings.
128 * Classes ".headingblock .header .tag-header" were removed from the tag index page
130 Maintenance renderer notes:
131 When the maintenance layout is being used $OUTPUT will be an instance of core_renderer_maintenance.
132 This renderer mimics the core_renderer except that the following functions always return an empty string.
133 * core_renderer_maintenance::block
134 * core_renderer_maintenance::blocks
135 * core_renderer_maintenance::blocks_for_regions
136 * core_renderer_maintenance::course_header
137 * core_renderer_maintenance::course_footer
138 * core_renderer_maintenance::course_content_header
139 * core_renderer_maintenance::course_content_footer
140 * core_renderer_maintenance::custom_menu
141 * core_renderer_maintenance::file_picker
142 * core_renderer_maintenance::htmllize_file_tree
143 * core_renderer_maintenance::lang_menu
144 * core_renderer_maintenance::login_info
145 * core_renderer_maintenance::user_picture
147 If you have overridden methods of the core_renderer in your theme and want those changes to be shown during times of maintenance you
148 will also need to override the core_renderer_maintenance and copy your customisations from the core_renderer to that.
150 === 2.5.1 ===
152 Notes:
153 * Block drag and drop functionality has been improved so that it works regardless of what block regions you use
154   or how many block regions you have. In order to benefit from this improvement you must convert your calls from
155   $OUTPUT->blocks_for_region() to $OUTPUT->blocks.
157 Optional changes:
158 * Theme config can nominate block regions to swap if the user is using a rtl languages such as Hebrew.
159   $THEME->blockrtlmanipulations should be an associative array, the key is the original block region, and the
160   value should be where the blocks in that region should be displayed.
161 * New $OUTPUT methods to replace code that was previously using $PAGE. Converting to these methods is optional
162   but highly recommended. Refer to the bootstrapbase layouts for examples.
163   - $OUTPUT->body_attributes() returns a string you can use for the body id and classes.
164   - $OUTPUT->blocks() returns HTML to display a block region and all of its blocks. This adds data attributes
165     that ensure drag and drop of blocks will work no matter what block regions or how many you have.
166   - $OUTPUT->page_heading() returns the page heading. Replaces $PAGE->heading.
167   - $OUTPUT->page_heading_button() returns the button to display with the heading. Replaces $page->button.
168   - $OUTPUT->page_doc_link() returns the link to moodle docs for the page. Replaces page_doc_link().
169   - $OUTPUT->page_heading_menu() returns the heading menu for the page. Replaces $PAGE->headingmenu.
170   - $OUTPUT->page_title() Returns the title to use for the head section.
171   - $OUTPUT->favicon() returns the URL to the favicon.
173 Renderer changes:
174 * core_renderer::navbar now returns an empty string if there are no navigation items to display.
175 * core_renderer::custom_menu now adds a class "custom_menu" to the div that contains the HTML for the custom menu.
177 === 2.5 ===
179 required changes:
180 * Functions core_course_renderer::course_category_tree() and course_category_tree_category()
181   are deprecated
182 * Significant changes in rendering of courses and categories listings, lots of CSS classes changed,
183   several functions such as print_courses(), print_whole_category_list(), print_category_info()
184   are moved to course renderer.
185   See
187 DOM changes:
188 * changed the h1 title in the help popup to a h2.
189 * new setting $THEME->yuicssmodules = array('cssreset', 'cssfonts', 'cssgrids', 'cssbase'); which
190   allows themes to use different CSS reset normalisers such as cssnormalize YUI module.
191 * Re-wrote the user profile views to definition lists.
192 * Re-wrote the table for the course completion status block to use html_table - added some CSS classes to
193   the table in the process (see MDL-35608).
194 * Cancel buttons have the class btn-cancel.
195 * Added a z-index for the div#dateselector-calendar-panel so that the calendar pop-up renders above
196   the filemanager when they overlap, ie. the course settings page (see MDL-39047).
197 * Trivial change of CSS selectors used to display plugin status at the plugins overview
198   screen (#plugins-control-panel).
200 Renderer changes:
201 * Mymobile theme changed to support more verbose move-block-here descriptions.
203 === 2.4 ===
205 required changes:
206 * output course and course content header/footer that may be returned by course format (see MDL-36048)
207 * span.completionprogress has been changed to a <div> and is not a float by default any more.
209 deprecation:
210 * i/roles: Use t/assignroles instead
211 * t/manual_item: Use i/manual_item instead
212 * t/unlock_gray: Use t/locked instead
213 * t/userblue: Previously used to unblock a user, use t/unblock.
214 * c/course: Use i/courseevent instead
215 * c/group: Use i/groupevent instead
216 * c/site: Use i/siteevent instead
217 * c/user: Use i/userevent instead
218 * t/clear: Use t/check instead
219 * i/cross_red_big: Use i/invalid or i/grade_incorrect
220 * i/tick_green_big: Use i/valid or i/grade_correct
221 * i/tick_amber_big: Use i/caution or i/grade_partiallycorrect
222 * No more small versions of i/cross_red_small, i/tick_green_small and i/tick_amber_small, use their big equivalent.
223 * t/addgreen: Use t/add instead.
224 * i/approve: Use t/approve instead
226 optional changes:
227 * new optional boolean parameter $withlinks for public function login_info() in lib/outputrenderers.php (MDL-31365)
228 * new layout option "nologinlinks" and new page layout "secure" e.g. for safebrowser and securewindow (MDL-31365)
229 * new class 'iconlarge' for 24x24 icons.
230 * new icons i/export and i/import (sized 16x16). Previously export and import actions used i/backup and i/restore.
231 * new icon i/assignroles (sized 16x16), to prevent the use of i/roles which is 12x12.
232 * new icon i/switchrole (sized 16x16), was previously using i/roles. Now is a copy of the new i/assignroles icon.
233 * new icons i/enrolusers and t/enrolusers, previsouly i/users was used.
234 * new icon t/cohorts (sized 12x12), to prevent the use of i/cohorts which is 16x16.
235 * new icons t/sort_asc, t/sort_desc to use for ordering in table headers.
236 * new class 'iconsort' for icons used for ordering in table headers.
237 * new icons t/locked and t/unlocked (12x12) which should be used when there is no action associated to the icon.
238 * new icons i/folder (16x16), monochrome equivalent to f/folder.
239 * new icons t/addcontact, t/removecontact and t/messages, previously t/addgreen, t/delete and t/log were used in messaging.
240 * new icons t/unblock and i/twoway.
241 * new icons i/courseevent, i/groupevent, i/siteevent and i/userevent (16x16) instead of c/* for calendar events.
242 * new icon t/markasread (12x12) to replace t/clear used in forums.
243 * new icon t/check (12x12) to replace t/clear which name does not reflect the icon meaning.
244 * 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.
245 * new icons i/valid, i/caution and i/invalid for generic statuses.
246 * new icons i/grade_correct, i/grade_partiallycorrect and i/grade_incorrect for grades.
247 * new icon t/approve (12x12).
248 * new icon t/contextmenu (12x12) for a monochrome version of i/menu.
250 === 2.3 ===
252 optional changes:
253 * add new u/f3.png image when theme contains customised f1 and f2 default user images
255 === 2.2 ===
257 required changes:
258 * use new page content placeholder "echo $OUTPUT->main_content()" instead of "echo core_renderer::MAIN_CONTENT_TOKEN"
259   see git commit: 3b3f302855d7621405a8b93e49bd399d67a998d7
260 * upgrade report selectors: search for "-course-report-" and replace with "-report-"