Merge branch 'main' of github.com:moodle-an-hochschulen/moodle-theme_boost_union into css_snippets

Author: Menrath

CHANGES.md

@@ -8,6 +8,35 @@ Changes
 
 * 2024-09-04 - Feature: Add first version of CSS snippets feature, credits go to all members of the MoodleMootDACH dev camp team 22.
 
+### v4.5-r5
+
+* 2024-12-31 - Child theme support: Fully replicate Boost Union's extra SCSS if a Boost Union Child theme is the current theme, resolves #718, resolves theme_boost_union_child/#5.
+* 2024-12-31 - Bugfix / Child theme support: The theme_boost_union_get_pre_scss() and theme_boost_union_get_extra_scss() function used $theme->settings although they should not do that anymore, resolves #791
+* 2024-12-31 - Tests: Increase the test coverage for the background image setting, helps to resolve theme_boost_union_child/#5
+* 2024-12-31 - Bugfix: In flavours, not setting the brand color / bootstrap colors in a flavour did not result in the global brand color / bootstrap colors being served properly, resolves #790.
+* 2024-12-30 - Improvement: Add more flavour settings (Activity icon colors, navbar color, background image position), resolves #789.
+* 2024-12-25 - Documentation: Explain the SCSS stack order in the README.
+* 2024-12-25 - Bugfix: Fix the order in which all the pre SCSS assets are added to the SCSS stack, resolves #788.
+* 2024-12-22 - Feature: Allow overwriting of brand colors and the usage of SCSS (instead of pure CSS) in flavours, resolves #155.
+               Child theme support: If you are running a Boost Union Child theme, please make sure to adapt your child theme to our latest boilerplate.
+* 2024-12-15 - Feature: Add declaration of accessibility page and accessibility support page, resolves #567.
+
+### v4.5-r4
+
+* 2024-12-06 - Tests: Add several Behat optimisations to bring down the test suite run time, resolves #765.
+* 2024-12-06 - Upstream change: Adopt changes from MDL-83759 ('System notification navbar popover is misplaced in Moodle 4.4 and 4.5')
+* 2024-12-06 - Upstream change: Adopt changes from MDL-75610 ('Quiz activity name no longer being displayed in quiz landing page when using Safe Exam Browser'), resolves #766.
+
+### v4.5-r3
+
+* 2024-11-19 - Bugfix: The starred courses popover showed a JavaScript error in the browser JS console, resolves #759.
+* 2024-11-19 - Bugfix: The starred courses popover in the navbar must only be shown if Boost Union or Boost Union child is active, resolves #759.
+* 2024-11-18 - Improvement: Add the possibility to restrict smart menus and smart menu items to site admins and non-site admins only, resolves #421.
+* 2024-11-18 - Bugfix: Footer displacement on pages with minimal content, resolves #655.
+* 2024-11-18 - Upstream change: Adopt changes from MDL-77732 ('Custom menu items do not receive active behaviour'), resolves #436 #620 #384 #715.
+* 2024-11-13 - Upstream change: Adopt changes from MDL-78999 ('Site logo does not appear in mobile view'), resolves #753.
+* 2024-11-11 - Release: Add ssystems GmbH to the list of maintainers in README.md.
+
 ### v4.5-r2
 
 * 2024-10-31 - Bugfix: Fix possible site failure when a cohort or role used as restriction of a smart menu item is deleted, resolves #737.
@@ -78,7 +107,7 @@ Changes
 * 2024-07-04 - Upgrade: Fix Behat tests which broke due to the introduction of section pages in Moodle core.
 * 2024-07-04 - Upgrade: Adopt changes in boostnavbar.php from Boost core.
 * 2024-07-04 - Upgrade: Fix Behat tests which broke due to changes in the section naming in Moodle core.
-* 2024-07-04 - Upgrade: Adapt a Behat test as planned regarding the new theme selector in Moodle core. 
+* 2024-07-04 - Upgrade: Adapt a Behat test as planned regarding the new theme selector in Moodle core.
 * 2024-07-04 - Upgrade: Fix Behat tests which broke due to changes on the MyCourses page in Moodle core.
 * 2024-06-25 - Upgrade: Adopt and handle core changes for the footersuppressstandardfooter_* settings, moving from callback functions to hooks.
 * 2024-06-19 - Upgrade: Adopt changes in event-list-item.mustache from block_timeline in core.
@@ -87,15 +116,15 @@ Changes
 * 2024-06-19 - Upgrade: Adopt changes in navbar.mustache from Boost core.
 * 2024-06-01 - Prepare compatibility for Moodle 4.4.
 
-### v4.3-r15 
+### v4.3-r15
 
 * 2024-07-11 - Bugfix: Allow external SCSS to use SCSS variables by disabling the SCSS validation, resolves #683.
 * 2024-06-23 - Upstream change: Adopt change in view-chards.mustache from MDL-70829.
 * 2024-06-18 - Release: Let codechecker ignore some sniffs in the language pack.
 * 2024-06-13 - Cleanup: Change @codingStandardsIgnore tags to phpcs:disable, resolves #676.
 * 2024-06-12 - Cleanup: Fix CSS warnings in external SCSS tests, resolves #674.
 
-### v4.3-r14 
+### v4.3-r14
 
 * 2024-06-10 - Cleanup: Introduce a dedicated Behat step to deactivate and activate debugging, resolves #670.
 * 2024-05-05 - Cleanup: Fix 'Implicitly marking a parameter as nullable is deprecated since PHP 8.4' codechecker warning, resolves #667.

README.md

@@ -559,6 +559,18 @@ With these settings, you can add rich text content which will be shown on a gene
 
 With these settings, you can add rich text content which will be shown on a generic page 3.
 
+#### Tab "Accessibility"
+
+In this tab there are the following settings:
+
+#### Declaration of accessibility
+
+With these settings, you can add rich text content which will be shown on a declaration of accessibility page.
+
+#### Accessibility support page
+
+With these settings, you can enable the accessibility support page which provides a contact form for accessibility issues.
+
 #### Tab "Information banners"
 
 In this tab, you can enable and configure multiple information banners to be shown on selected pages.
@@ -730,6 +742,63 @@ https://github.com/moodle-an-hochschulen/moodle-theme_boost_union_child
 While Boost Union Child will surely help you to realize all your local Boost Union dreams, please do yourself and the whole community a favour and verify that your planned features are indeed not interesting as a pull request or feature request for the whole Boost Union community and could be contributed to Boost Union directly instead.
 
 
+SCSS stack order
+----------------
+
+Within Boost Union, you have multiple possibilities to add your own SCSS code to the Moodle page. And many of the Boost Union settings add SCSS code as well to realize the particular setting's goal. However, as you know, in SCSS the order of the instructions is key.
+
+The following list should give you an insight in which order all the SCSS code is added to the CSS stack which is shipped to the browser in the end.
+To fully understand this list, you have to be aware of two terms in Moodle theming:
+
+* _Pre SCSS_ or _Raw Initial SCSS_:\
+  This SCSS code is used only to initialize SCSS variables and not to write real SCSS code directly.
+* _Post SCSS_ or _Raw SCSS_:\
+  This SCSS code is the real SCSS code which is compiled to CSS for the browser and which might consume the SCSS variables which have been set in the Pre SCSS.
+
+Having said that, here's the order how all the SCSS code is added to the SCSS stack:
+
+1. All plugins' `styles.css` files:\
+   Each Moodle plugin can ship with a `styles.css` file which contains CSS code (not SCSS code!) for the plugin. These files are added at the very beginning in the order of the plugin names and types.
+
+2. `theme_boost` > `get_pre_scss()`:
+   * Adds the Boost Union Pre SCSS from the theme settings\
+     (which is set on `/admin/settings.php?section=theme_boost_union_look#theme_boost_union_look_scss`).\
+     Note: In fact, this function adds the _active theme's_ Pre SCSS which becomes important if you use a Boost Union Child theme.
+
+3. `theme_boost_union` > `get_pre_scss()`:
+   * Adds the Boost Union Pre SCSS from disk\
+     (which is located on `/theme/boost_union/scss/boost_union/pre.scss` and which is empty currently)
+   * Sets several SCSS variables based on Boost Union or Boost Union flavour settings
+   * Adds the Boost Union external Pre SCSS\
+     (which is set on `/admin/settings.php?section=theme_boost_union_look#theme_boost_union_look_scss`)
+   * Adds the Boost Union flavour Pre SCSS\
+     (which is set within the active flavour on `/theme/boost_union/flavours/overview.php`)
+
+4. `theme_boost_union` > `get_main_scss()`:
+   * Calls the `theme_boost` > `get_main_scss()` function
+     * Adds the Boost Core Preset\
+       (which is set on `/admin/settings.php?section=themesettingboost` and defaults to the `/theme/boost/scss/preset/default.scss` file).
+       With this preset, the FontAwesome library, the Bootstrap library and all the Moodle core stylings are added which means that this preset is the place where all the Moodle core style is added.
+   * Adds the Boost Union Post SCSS from disk\
+     (which is located on `/theme/boost_union/scss/boost_union/post.scss`)
+     This file holds all the Boost Union specific SCSS code which can be added to the stack without being dependent on specific configurations like configured colors or sizes.
+   * Add the Boost Union external SCSS\
+     (which is set on `/admin/settings.php?section=theme_boost_union_look#theme_boost_union_look_scss`)
+
+5. `theme_boost` > `get_extra_scss()`:
+   * Adds the Boost Union Post SCSS from the theme settings\
+     (which is set on `/admin/settings.php?section=theme_boost_union_look#theme_boost_union_look_scss`).\
+     Note: In fact, this function adds the _active theme's_ Post SCSS which becomes important if you use a Boost Union Child theme.
+   * Adds the page background image and login page background image
+
+6. `theme_boost_union` > `get_extra_scss()`:
+   * Overrides / enhances the background images which have been set before
+   * Adds the Boost Union flavour Post SCSS\
+     (which is set within the active flavour on `/theme/boost_union/flavours/overview.php`)
+   * Adds the Boost Union features' SCSS.
+     This is the Boost Union specific SCSS code which has to be added to the stack based on specific configurations, for example for changing the activity icon purposes or for changing the login form order.
+
+
 Plugin repositories
 -------------------
 
@@ -802,11 +871,14 @@ The plugin is maintained by\
 Moodle an Hochschulen e.V.
 
 in cooperation with\
-lern.link GmbH
+ssystems GmbH
 
 together with\
 bdecent GmbH
 
+and\
+lern.link GmbH
+
 
 Copyright
 ---------
@@ -844,6 +916,7 @@ Moodle an Hochschulen e.V. would like to thank these main contributors (in alpha
 * lern.link GmbH, Alexander Bias: Code, Peer Review, Ideating, Funding
 * lern.link GmbH, Lukas MuLu Müller: Code
 * lern.link GmbH, Beata Waloszczyk: Code
+* Lutheran University of Applied Sciences Nuremberg: Funding
 * Moodle.NRW / Ruhr University Bochum, Annika Lambert: Code
 * Moodle.NRW / Ruhr University Bochum, Matthias Buttgereit: Code, Ideating
 * Moodle.NRW / Ruhr University Bochum, Tim Trappen: Code, Ideating
@@ -853,9 +926,11 @@ Moodle an Hochschulen e.V. would like to thank these main contributors (in alpha
 * RWTH Aachen, Amrita Deb Dutta: Code
 * RWTH Aachen, Josha Bartsch: Code
 * Solent University, Mark Sharp: Code
+* ssystems GmbH, Alexander Bias: Code, Peer Review, Ideating, Funding
 * Technische Universität Berlin, Lars Bonczek: Code
+* University of Bayreuth, Nikolai Jahreis: Code
 * University of Graz, André Menrath: Code
 * University of Lübeck, Christian Wolters: Code, Peer Review, Ideating
-* Zurich University of Applied Sciences (ZHAW): Funding, Ideating
+* Zurich University of Applied Sciences (ZHAW): Code, Funding, Ideating
 
 Additionally, we thank all other contributors who contributed ideas, feedback and code snippets within the Github issues and pull requests as well as all contributors who contributed additional translations in AMOS, the Moodle translation tool.

accessibility/declaration.php

@@ -0,0 +1,74 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Theme Boost Union - Declaration of accessibility page.
+ *
+ * @package    theme_boost_union
+ * @copyright  2024 Katalin Lukacs Toth, ZHAW Zurich University of Applied Sciences <[email protected]>
+ * @copyright  2024 Simon Schoenenberger, ZHAW Zurich University of Applied Sciences <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+// Include config.php.
+// Let codechecker ignore the next line because otherwise it would complain about a missing login check
+// after requiring config.php which is really not needed.
+require(__DIR__ . '/../../../config.php'); // phpcs:disable moodle.Files.RequireLogin.Missing
+
+// Require the necessary libraries.
+require_once($CFG->dirroot.'/theme/boost_union/lib.php');
+require_once($CFG->dirroot.'/theme/boost_union/locallib.php');
+
+// Set page URL.
+$PAGE->set_url('/theme/boost_union/accessibility/declaration.php');
+
+// Set page layout.
+$PAGE->set_pagelayout('standard');
+
+// Set page context.
+$PAGE->set_context(context_system::instance());
+
+// Add page name as body class.
+$PAGE->add_body_class('theme_boost_union-accessibilitydeclaration');
+
+// Get theme config.
+$config = get_config('theme_boost_union');
+
+// If the declaration of accessibility page is disabled, we just show a short friendly warning page and are done.
+if ($config->enableaccessibilitydeclaration != THEME_BOOST_UNION_SETTING_SELECT_YES) {
+    echo $OUTPUT->header();
+    $notification = new \core\output\notification(get_string('accessibilitydeclarationdisabled', 'theme_boost_union'),
+        \core\output\notification::NOTIFY_INFO);
+    $notification->set_show_closebutton(false);
+    echo $OUTPUT->render($notification);
+    echo $OUTPUT->footer();
+    die;
+}
+
+// Set page title.
+$PAGE->set_title(theme_boost_union_get_accessibility_pagetitle('declaration'));
+
+// Start page output.
+echo $OUTPUT->header();
+
+// Show page heading.
+echo $OUTPUT->heading(theme_boost_union_get_accessibility_pagetitle('declaration'));
+
+// Output declaration of accessibility page content.
+echo format_text($config->accessibilitydeclarationcontent, FORMAT_MOODLE, ['trusted' => true, 'noclean' => true]);
+
+// Finish page.
+echo $OUTPUT->footer();