weekly release 2.6dev
[moodle.git] / theme / upgrade.txt
1This files describes API changes in /theme/* themes,
2information provided here is intended especially for theme designer.
edb7d5ad 3
699e2fd0 4=== 2.6 ===
3b42864d 5
699e2fd0 6Notes:
faf6010b 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).
699e2fd0 10* The parameters value for the following functions have been modified: core_renderer::heading() and core_renderer::heading_with_help().
3b42864d 11 This means that headings using the default options will no longer have the class "main" which was the previous default.
d61c96b6 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.
b4c6b42e 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.
19Renderer changes:
20* core_course_renderer::course_section_cm_edit_actions has two new optional arguments and now uses and action_menu component.
21* core_course_renderer::course_section_cm has been altered to call core_course_renderer::course_section_cm_edit_actions with the two new arguments.
22* core_renderer::block_controls has a new optional argument (the block id) and has been altered to use the new action_menu component.
23* core_renderer::block_header has been altered to give core_renderer::block_controls the new second argument, the block id.
24* core_renderer::action_link has a new argument, and optional icon that can be rendererd into the link.
faf6010b 26Selector changes:
27* Changes to the classes given to the header produced when rendering a single section within a course.
28 .section-navigation.header.headingblock => .section-navigation.navigationtitle
29* Changes to the classes used when producing the course information box that lists courses.
30 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.
31* Classes ".header and .headingblock" were removed from all front page content headings.
32* Classes ".headingblock .header .tag-header" were removed from the tag index page
90160639 34=== 2.5.1 ===
37* Block drag and drop functionality has been improved so that it works regardless of what block regions you use
38 or how many block regions you have. In order to benefit from this improvement you must convert your calls from
39 $OUTPUT->blocks_for_region() to $OUTPUT->blocks.
41Optional changes:
42* Theme config can nominate block regions to swap if the user is using a rtl languages such as Hebrew.
43 $THEME->blockrtlmanipulations should be an associative array, the key is the original block region, and the
44 value should be where the blocks in that region should be displayed.
45* New $OUTPUT methods to replace code that was previously using $PAGE. Converting to these methods is optional
46 but highly recommended. Refer to the bootstrapbase layouts for examples.
47 - $OUTPUT->body_attributes() returns a string you can use for the body id and classes.
48 - $OUTPUT->blocks() returns HTML to display a block region and all of its blocks. This adds data attributes
49 that ensure drag and drop of blocks will work no matter what block regions or how many you have.
50 - $OUTPUT->page_heading() returns the page heading. Replaces $PAGE->heading.
51 - $OUTPUT->page_heading_button() returns the button to display with the heading. Replaces $page->button.
52 - $OUTPUT->page_doc_link() returns the link to moodle docs for the page. Replaces page_doc_link().
53 - $OUTPUT->page_heading_menu() returns the heading menu for the page. Replaces $PAGE->headingmenu.
54 - $OUTPUT->page_title() Returns the title to use for the head section.
55 - $OUTPUT->favicon() returns the URL to the favicon.
57Renderer changes:
58* core_renderer::navbar now returns an empty string if there are no navigation items to display.
59* core_renderer::custom_menu now adds a class "custom_menu" to the div that contains the HTML for the custom menu.
61=== 2.5 ===
63required changes:
64* Functions core_course_renderer::course_category_tree() and course_category_tree_category()
65 are deprecated
66* Significant changes in rendering of courses and categories listings, lots of CSS classes changed,
67 several functions such as print_courses(), print_whole_category_list(), print_category_info()
68 are moved to course renderer.
69 See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
71DOM changes:
72* changed the h1 title in the help popup to a h2.
97dbc8f2 73* new setting $THEME->yuicssmodules = array('cssreset', 'cssfonts', 'cssgrids', 'cssbase'); which
12cb45f1 74 allows themes to use different CSS reset normalisers such as cssnormalize YUI module.
6e5d002e 75* Re-wrote the user profile views to definition lists.
76* Re-wrote the table for the course completion status block to use html_table - added some CSS classes to
77 the table in the process (see MDL-35608).
5581c618 78* Cancel buttons have the class btn-cancel.
79* Added a z-index for the div#dateselector-calendar-panel so that the calendar pop-up renders above
80 the filemanager when they overlap, ie. the course settings page (see MDL-39047).
81* Trivial change of CSS selectors used to display plugin status at the plugins overview
82 screen (#plugins-control-panel).
fc7defef 83
84Renderer changes:
85* Mymobile theme changed to support more verbose move-block-here descriptions.
87=== 2.4 ===
89required changes:
90* output course and course content header/footer that may be returned by course format (see MDL-36048)
e40bd746 91* span.completionprogress has been changed to a <div> and is not a float by default any more.
52b1ed5e 92
94* i/roles: Use t/assignroles instead
95* t/manual_item: Use i/manual_item instead
96* t/unlock_gray: Use t/locked instead
f2bba619 97* t/userblue: Previously used to unblock a user, use t/unblock.
98* c/course: Use i/courseevent instead
99* c/group: Use i/groupevent instead
100* c/site: Use i/siteevent instead
101* c/user: Use i/userevent instead
99938034 102* t/clear: Use t/check instead
103* i/cross_red_big: Use i/invalid or i/grade_incorrect
104* i/tick_green_big: Use i/valid or i/grade_correct
105* i/tick_amber_big: Use i/caution or i/grade_partiallycorrect
106* No more small versions of i/cross_red_small, i/tick_green_small and i/tick_amber_small, use their big equivalent.
501380a9 107* t/addgreen: Use t/add instead.
851d3b7a 108* i/approve: Use t/approve instead
fbb207c5 109
110optional changes:
111* new optional boolean parameter $withlinks for public function login_info() in lib/outputrenderers.php (MDL-31365)
112* new layout option "nologinlinks" and new page layout "secure" e.g. for safebrowser and securewindow (MDL-31365)
bb128107 113* new class 'iconlarge' for 24x24 icons.
114* new icons i/export and i/import (sized 16x16). Previously export and import actions used i/backup and i/restore.
115* new icon i/assignroles (sized 16x16), to prevent the use of i/roles which is 12x12.
116* new icon i/switchrole (sized 16x16), was previously using i/roles. Now is a copy of the new i/assignroles icon.
117* new icons i/enrolusers and t/enrolusers, previsouly i/users was used.
118* new icon t/cohorts (sized 12x12), to prevent the use of i/cohorts which is 16x16.
119* new icons t/sort_asc, t/sort_desc to use for ordering in table headers.
120* new class 'iconsort' for icons used for ordering in table headers.
fa9c0aab 121* new icons t/locked and t/unlocked (12x12) which should be used when there is no action associated to the icon.
0cddd851 122* new icons i/folder (16x16), monochrome equivalent to f/folder.
123* new icons t/addcontact, t/removecontact and t/messages, previously t/addgreen, t/delete and t/log were used in messaging.
124* new icons t/unblock and i/twoway.
5326675e 125* new icons i/courseevent, i/groupevent, i/siteevent and i/userevent (16x16) instead of c/* for calendar events.
126* new icon t/markasread (12x12) to replace t/clear used in forums.
127* new icon t/check (12x12) to replace t/clear which name does not reflect the icon meaning.
c22fbd38 128* 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.
129* new icons i/valid, i/caution and i/invalid for generic statuses.
130* new icons i/grade_correct, i/grade_partiallycorrect and i/grade_incorrect for grades.
851d3b7a 131* new icon t/approve (12x12).
0348468b 132* new icon t/contextmenu (12x12) for a monochrome version of i/menu.
ee362526 133
134=== 2.3 ===
136optional changes:
137* add new u/f3.png image when theme contains customised f1 and f2 default user images
139=== 2.2 ===
141required changes:
142* use new page content placeholder "echo $OUTPUT->main_content()" instead of "echo core_renderer::MAIN_CONTENT_TOKEN"
ee362526 143 see git commit: 3b3f302855d7621405a8b93e49bd399d67a998d7
2d0e682d 144* upgrade report selectors: search for "-course-report-" and replace with "-report-"