Merge branch '42057-26' of git://github.com/samhemelryk/moodle
[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.6 ===
6 Notes:
7 * There have been several changes made to the classes used on headings throughout Moodle.
8   This was done as per the Moodle HTML guidelines. h1 and h2 elements should have no classes, h3 and lower headings
9   may have descriptive classes only (any classes must properly describe the relation between the header and its content).
10 * The parameters value for the following functions have been modified: core_renderer::heading() and core_renderer::heading_with_help().
11   This means that headings using the default options will no longer have the class "main" which was the previous default.
12 * The file picker and activity chooser have been converted to use M.core.dialogue. This means the styles
13   for these elements have changed in the base and bootstrapbase themes and you will need to copy the new styles
14   if you are not inheriting from either one of these themes.
15 * For the themes based on bootstrapbase please also read theme/bootstrapbase/upgrade.txt
16 * 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
17   extend base, canvas, or clean then you will need to style for this new component within your theme.
18 * The maintenance layout now has a special renderer that extends the core_renderer in order to prevent some methods from interacting
19   with the database. Please be aware that for the maintenance layout some methods now always return an empty string.
20   This has been done because it is important that during maintenance routines we don't show any links, interact with the database,
21   or interact with caches as doing so may lead to errors,
22   Please see the maintenance renderer notes below for details on the functions affected.
24 Renderer changes:
25 * core_course_renderer::course_section_cm_edit_actions has two new optional arguments and now uses and action_menu component.
26 * core_course_renderer::course_section_cm has been altered to call core_course_renderer::course_section_cm_edit_actions with the two new arguments.
27 * core_renderer::block_controls has a new optional argument (the block id) and has been altered to use the new action_menu component.
28 * core_renderer::block_header has been altered to give core_renderer::block_controls the new second argument, the block id.
29 * core_renderer::action_link has a new argument, and optional icon that can be rendererd into the link.
31 Selector changes:
32 * Changes to the classes given to the header produced when rendering a single section within a course.
33   .section-navigation.header.headingblock => .section-navigation.navigationtitle
34 * Changes to the classes used when producing the course information box that lists courses.
35   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.
36 * Classes ".header and .headingblock" were removed from all front page content headings.
37 * Classes ".headingblock .header .tag-header" were removed from the tag index page
39 Maintenance renderer notes:
40 When the maintenance layout is being used $OUTPUT will be an instance of core_renderer_maintenance.
41 This renderer mimics the core_renderer except that the following functions always return an empty string.
42 * core_maintenance_renderer::block
43 * core_maintenance_renderer::blocks
44 * core_maintenance_renderer::blocks_for_regions
45 * core_maintenance_renderer::course_header
46 * core_maintenance_renderer::course_footer
47 * core_maintenance_renderer::course_content_header
48 * core_maintenance_renderer::course_content_footer
49 * core_maintenance_renderer::custom_menu
50 * core_maintenance_renderer::file_picker
51 * core_maintenance_renderer::htmllize_file_tree
52 * core_maintenance_renderer::lang_menu
53 * core_maintenance_renderer::login_info
54 * core_maintenance_renderer::user_picture
56 If you have overridden methods of the core_renderer in your theme and want those changes to be shown during times of maintenance you
57 will also need to override the core_renderer_maintenance and copy your customisations from the core_renderer to that.
59 === 2.5.1 ===
61 Notes:
62 * Block drag and drop functionality has been improved so that it works regardless of what block regions you use
63   or how many block regions you have. In order to benefit from this improvement you must convert your calls from
64   $OUTPUT->blocks_for_region() to $OUTPUT->blocks.
66 Optional changes:
67 * Theme config can nominate block regions to swap if the user is using a rtl languages such as Hebrew.
68   $THEME->blockrtlmanipulations should be an associative array, the key is the original block region, and the
69   value should be where the blocks in that region should be displayed.
70 * New $OUTPUT methods to replace code that was previously using $PAGE. Converting to these methods is optional
71   but highly recommended. Refer to the bootstrapbase layouts for examples.
72   - $OUTPUT->body_attributes() returns a string you can use for the body id and classes.
73   - $OUTPUT->blocks() returns HTML to display a block region and all of its blocks. This adds data attributes
74     that ensure drag and drop of blocks will work no matter what block regions or how many you have.
75   - $OUTPUT->page_heading() returns the page heading. Replaces $PAGE->heading.
76   - $OUTPUT->page_heading_button() returns the button to display with the heading. Replaces $page->button.
77   - $OUTPUT->page_doc_link() returns the link to moodle docs for the page. Replaces page_doc_link().
78   - $OUTPUT->page_heading_menu() returns the heading menu for the page. Replaces $PAGE->headingmenu.
79   - $OUTPUT->page_title() Returns the title to use for the head section.
80   - $OUTPUT->favicon() returns the URL to the favicon.
82 Renderer changes:
83 * core_renderer::navbar now returns an empty string if there are no navigation items to display.
84 * core_renderer::custom_menu now adds a class "custom_menu" to the div that contains the HTML for the custom menu.
86 === 2.5 ===
88 required changes:
89 * Functions core_course_renderer::course_category_tree() and course_category_tree_category()
90   are deprecated
91 * Significant changes in rendering of courses and categories listings, lots of CSS classes changed,
92   several functions such as print_courses(), print_whole_category_list(), print_category_info()
93   are moved to course renderer.
94   See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
96 DOM changes:
97 * changed the h1 title in the help popup to a h2.
98 * new setting $THEME->yuicssmodules = array('cssreset', 'cssfonts', 'cssgrids', 'cssbase'); which
99   allows themes to use different CSS reset normalisers such as cssnormalize YUI module.
100 * Re-wrote the user profile views to definition lists.
101 * Re-wrote the table for the course completion status block to use html_table - added some CSS classes to
102   the table in the process (see MDL-35608).
103 * Cancel buttons have the class btn-cancel.
104 * Added a z-index for the div#dateselector-calendar-panel so that the calendar pop-up renders above
105   the filemanager when they overlap, ie. the course settings page (see MDL-39047).
106 * Trivial change of CSS selectors used to display plugin status at the plugins overview
107   screen (#plugins-control-panel).
109 Renderer changes:
110 * Mymobile theme changed to support more verbose move-block-here descriptions.
112 === 2.4 ===
114 required changes:
115 * output course and course content header/footer that may be returned by course format (see MDL-36048)
116 * span.completionprogress has been changed to a <div> and is not a float by default any more.
118 deprecation:
119 * i/roles: Use t/assignroles instead
120 * t/manual_item: Use i/manual_item instead
121 * t/unlock_gray: Use t/locked instead
122 * t/userblue: Previously used to unblock a user, use t/unblock.
123 * c/course: Use i/courseevent instead
124 * c/group: Use i/groupevent instead
125 * c/site: Use i/siteevent instead
126 * c/user: Use i/userevent instead
127 * t/clear: Use t/check instead
128 * i/cross_red_big: Use i/invalid or i/grade_incorrect
129 * i/tick_green_big: Use i/valid or i/grade_correct
130 * i/tick_amber_big: Use i/caution or i/grade_partiallycorrect
131 * No more small versions of i/cross_red_small, i/tick_green_small and i/tick_amber_small, use their big equivalent.
132 * t/addgreen: Use t/add instead.
133 * i/approve: Use t/approve instead
135 optional changes:
136 * new optional boolean parameter $withlinks for public function login_info() in lib/outputrenderers.php (MDL-31365)
137 * new layout option "nologinlinks" and new page layout "secure" e.g. for safebrowser and securewindow (MDL-31365)
138 * new class 'iconlarge' for 24x24 icons.
139 * new icons i/export and i/import (sized 16x16). Previously export and import actions used i/backup and i/restore.
140 * new icon i/assignroles (sized 16x16), to prevent the use of i/roles which is 12x12.
141 * new icon i/switchrole (sized 16x16), was previously using i/roles. Now is a copy of the new i/assignroles icon.
142 * new icons i/enrolusers and t/enrolusers, previsouly i/users was used.
143 * new icon t/cohorts (sized 12x12), to prevent the use of i/cohorts which is 16x16.
144 * new icons t/sort_asc, t/sort_desc to use for ordering in table headers.
145 * new class 'iconsort' for icons used for ordering in table headers.
146 * new icons t/locked and t/unlocked (12x12) which should be used when there is no action associated to the icon.
147 * new icons i/folder (16x16), monochrome equivalent to f/folder.
148 * new icons t/addcontact, t/removecontact and t/messages, previously t/addgreen, t/delete and t/log were used in messaging.
149 * new icons t/unblock and i/twoway.
150 * new icons i/courseevent, i/groupevent, i/siteevent and i/userevent (16x16) instead of c/* for calendar events.
151 * new icon t/markasread (12x12) to replace t/clear used in forums.
152 * new icon t/check (12x12) to replace t/clear which name does not reflect the icon meaning.
153 * 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.
154 * new icons i/valid, i/caution and i/invalid for generic statuses.
155 * new icons i/grade_correct, i/grade_partiallycorrect and i/grade_incorrect for grades.
156 * new icon t/approve (12x12).
157 * new icon t/contextmenu (12x12) for a monochrome version of i/menu.
159 === 2.3 ===
161 optional changes:
162 * add new u/f3.png image when theme contains customised f1 and f2 default user images
164 === 2.2 ===
166 required changes:
167 * use new page content placeholder "echo $OUTPUT->main_content()" instead of "echo core_renderer::MAIN_CONTENT_TOKEN"
168   see git commit: 3b3f302855d7621405a8b93e49bd399d67a998d7
169 * upgrade report selectors: search for "-course-report-" and replace with "-report-"