Theme checklist: Difference between revisions
No edit summary |
No edit summary |
||
Line 23: | Line 23: | ||
== Dependencies == | == Dependencies == | ||
Have you specified the correct dependencies for both parent themes and Moodle in the 'version.php' file? | Have you specified the correct dependencies for both parent themes and Moodle in the '[https://docs.moodle.org/dev/version.php version.php]' file? | ||
== Fake blocks == | == Fake blocks == | ||
Line 40: | Line 40: | ||
Is all code GPLv3 (or compatible) licensed? | Is all code GPLv3 (or compatible) licensed? | ||
== Maturity == | |||
Have you correctly stated the maturity of the theme in the '[https://docs.moodle.org/dev/version.php version.php]' file? This gives users and idea of how stable the code is. | |||
== Quiz 'secure' pop-up == | == Quiz 'secure' pop-up == |
Revision as of 16:11, 1 February 2014
So, you think your theme is finished? Well, Moodle is a big complex beast, and there are lots of obscure corners, that you might not know about. This page lists lots of things that you might have missed when working on your theme. To be sure your theme is really complete, you need to check these out.
Accessible colours
Are the colours you have chosen accessible? Is there a reasonable contrast difference between them?
All the different forms of the front page
Depending on how many courses there are in your Moodle site, and how many of them the current user is enrolled in, the front page looks different. Have you tested all the different ways it can look?
Big report tables
The grader report, and other similar reports like the quiz reports, are very big tables that don't fit on one screen. How does your theme cope. Is it easy for the teacher to scroll sideways to see all the data?
Clean install
Have you installed and un-installed the theme on a 'pure' installation? That is an installation with no other contributed plugins. This allows you to check for unintentional dependencies.
Code checker
Code checker checks your code against the Moodle coding standards. It is a useful tool for spotting issues and making your code readable to all who are familiar with the core code. Do not take all messages literally, use your common sense and make changes that are sensible.
Dependencies
Have you specified the correct dependencies for both parent themes and Moodle in the 'version.php' file?
Fake blocks
While you are looking at the quiz, pay attention to the Quiz navigation block. This is not a normal block that teachers or admins can add or remove, it is a 'Fake block' that looks like any other block but is part of the Moodle UI. Are you happy with where it appears, and how it looks?
Other parts of Moodle that use fake blocks are the Lesson activity and the calendar UI.
Fake blocks are attached to the first region or the 'defaultregion' in the 'regions' array for the 'layout' in the 'layouts' array in the 'config.php' file. So if the order is ('side-pre', 'side-post') and you want fake blocks to be in 'side-post' change the 'defaultregion' to 'side-post' and the 'regions' array to ('side-post', 'side-pre').
Instructions
Have you provided a 'readme' file containing: Install instructions, un-install instructions, version history and contact details for when things go wrong.
License
Is all code GPLv3 (or compatible) licensed?
Maturity
Have you correctly stated the maturity of the theme in the 'version.php' file? This gives users and idea of how stable the code is.
Quiz 'secure' pop-up
When a quiz set to Full screen pop-up with some JavaScript security then the page uses a special 'secure' layout template that should have minimal headers or links.
Readable fonts
Are the fonts you have chosen readable? Will they be difficult to read on small devices?
Right-to-left languages
In languages like Hebrew or Farsi, lots of things that you made left-aligned probably need to be right-aligned instead. Moodle adds .dir-rtl or .dir-ltr class to the body element, which you can use in CSS rules.
Responsive
Have you tested your theme for responsiveness on small devices? Try resizing the browser window and see how it reacts.
Theme developer mode
When 'Theme developer mode' is 'on', all of the CSS files are sent individually. When it is 'off', they are all combined together. This can lead to some issues. Check that your theme works with 'Theme designer mode off'.