/
testing.txt
31 lines (25 loc) · 3.8 KB
/
testing.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
Instructions on how and what to test
====================================
The development is being carried out on the 'dev' branch, as individual components reach the stage where they can be tested, they'll be brought into the master branch and added to the list below.
There are two ways to test:
1. Simply check out the master branch of this project, install it as a theme on your Moodle (I'm developing for 2.3 at the moment, but I'd be interested to hear about what works, or not, on older and newer versions). Most of the Moodle will be unfinished and/or semi-broken, which may be distracting but by referencing the list below you should be able to work out what is in a state where it can be tested and focus your attention on that.
2a. If you have access to a theme that uses Bootstrap.css, but doesn't have any renderers, you should be able to copy all the .php files (except lib.php and config.php) from the 'ready_for_testing' branch into the other theme folder. Make sure config.php has a line that says "$THEME->rendererfactory = 'theme_overridden_renderer_factory';" and then change any classnames in each *renderer.php file by replacing 'bootstrap_renderers' with 'your_theme_name' e.g. 'class theme_bootstrap_renderers_core_renderer' becomes 'class theme_example_core_renderer'. This testing is useful because it lets the creators of such themes know which renderer components are ready for their use, but if you find issues I'd ask you to recreate them via method 1 before reporting them. This establishes if it's a conflict with the particular theme or not.
2b. If there are already some renderers in use, you should be able to merge them together and take the best of both but that's more of a manual, tricky task best left to the individual theme creator. If the renderer functions are brought into the master branch then that's a sign that I'd be happy for people to pick them up and start using them in their themes (after a short period of testing).
core_renderer.php
public function doctype() { // should output an HTML5 doctype.
public function htmlattributes() { // shouldn't output xml:lang
public function home_link() { // mostly superficial, changes a Moodle logo image on the homepage to CSS label
public function block_controls($controls) { // should output bootstrap icons
public function block(block_contents $bc, $region) { // the outer block should look like a Bootstrap well
public function list_block_contents($icons, $items) { // list blocks e.g. activities should not have bullet points, should react to hover
public function action_icon($url, pix_icon $pixicon, component_action $action = null, array $attributes = null, $linktext=false) {
// various action icons, though not all e.g. duplicate or groups, should be replaced with Bootstrap equivalents e.g. icons next to course activites in edit mode
public function confirm($message, $continue, $cancel) { // try the purgecaches page
public function doc_link($path, $text = '') { // (?) help icon should be Bootstrapped sometimes
public function heading_with_help($text, $helpidentifier, $component = 'moodle', $icon = '', $iconalt = '') {
// at top of module setting pages skips the module icon and the help icon should look nice
public function spacer(array $attributes = null, $br = false) { // some spacer icons should no longer be img tags
public function error_text($message) { // various short, roughly single sentence length, messages e.g. "Invalid login, please try again"
public function notification($message, $classes = null) { various longer error messages, there's various in admin settings
protected function render_paging_bar(paging_bar $pagingbar) { // the site logs with 'all days' is a good place to test these, or long participants lists
public function navbar() { // What Bootstrap calls the breadcrumb trail