From 8fd188af3a3882f38f1e09ffc73a88065f1295a0 Mon Sep 17 00:00:00 2001 From: PMKuipers Date: Mon, 3 Jul 2023 23:28:46 +0200 Subject: [PATCH] Finished documentation --- doc/advanced.htm | 2 +- doc/configuration.htm | 96 ++++++++++++++++++++++++++++++++++++++++++- settings.php | 10 +---- 3 files changed, 97 insertions(+), 11 deletions(-) diff --git a/doc/advanced.htm b/doc/advanced.htm index 0ad0888..1ee33c8 100644 --- a/doc/advanced.htm +++ b/doc/advanced.htm @@ -47,7 +47,7 @@ Under Course display name you can select if you want to use shortname, ID field or any other previously configured custom course field

-

Grade & Scale interpretation

+

Grade & Scale interpretation
NOTE:

The information in this category is mostly applicable to manual aggregation methods for study plans. If Moodle course completion is used, it is especially important to always configure grade to pass

diff --git a/doc/configuration.htm b/doc/configuration.htm index 232e532..90902db 100644 --- a/doc/configuration.htm +++ b/doc/configuration.htm @@ -8,8 +8,102 @@
  • Advanced topics
  • Configuration
    • -

    About studyplan

    +

    Overview of configuration parameters

    +

    Studyplan settings

    +

    Basic configuration options for the studyplan plug-in

    + +

    Manage study plans

    +

    This option is a direct link to the manage studyplans page. It may be useful for administrators.

    + +

    Studyplan cohort sync

    +

    Here you can configure automatic cohort syncing. This syncronizes the cohorts and students linked with a study plan to enrolment + within the courses in the study plan

    +

    Cohort syncing is done by creating a cohort sync enrolment method in each course, while students are synced by adding a manual enrolment

    + + +

    Configure grade & scale interpretation

    +

    See the Advanced / Grade & Scale interpretation section for more details on this configuration page

    + + +

    Theming guide

    +

    A number of colors in the studyplan plugin are based on the colors you define in your theme for + primary (brand color), + secondary, + success, + info, + warning and + danger +

    +

    You may be able to define them in your theme's configuration. If not, follow the instructions below for tweaking other colors + and use the following code as a starting point. (The values are the default boost theme colors)

    + 
    +:root {
+    --primary: #023C78;
+    --secondary: #6c757d;
+    --success: #28a745;
+    --info: #17a2b8;
+    --warning: #ffc107;
+    --danger: #dc3545;
+    --light: #f8f9fa;
+    --dark: #343a40;
+    }
    + +

    Tweaking other colors

    +

    Other variables that are used are color variables provided in bootstrap. To tweak them, use the Advanced settings -> Raw SCSS configuration + option in your theme's configuration.

    +

    Fore example, in the Boost theme the option is found in Appearance -> (Themes) -> Boost -> Advanced settings -> Raw SCSS +

    There, use code like the following to change the color variables. (Note that those colors will be changed throughout the site.)

    + 
    +:root {
+    --blue: #007bff;
+    --indigo: #6610f2;
+    --purple: #6f42c1;
+    --red: #dc3545;
+    --green: #28a745;
+    --gray: #6c757d;
+    }
    \ No newline at end of file diff --git a/settings.php b/settings.php index 687a4a6..36adc80 100644 --- a/settings.php +++ b/settings.php @@ -57,7 +57,7 @@ if ($hassiteconfig) { $page->add(new admin_setting_configselect('local_treestudyplan/aggregation_mode', get_string('setting_aggregation_mode', 'local_treestudyplan'), get_string('settingdesc_aggregation_mode', 'local_treestudyplan'), - "bistate", + "core", $aggregators )); @@ -113,20 +113,12 @@ if ($hassiteconfig) { PARAM_INT )); - $page->add(new admin_setting_configcheckbox('local_treestudyplan/bistate_support_failed', get_string('setting_bistate_support_failed', 'local_treestudyplan'), get_string('settingdesc_bistate_support_failed', 'local_treestudyplan'), True, )); - $page->add(new admin_setting_configtext('local_treestudyplan/bistate_thresh_progress', - get_string('setting_bistate_thresh_progress', 'local_treestudyplan'), - get_string('settingdesc_bistate_thresh_progress', 'local_treestudyplan'), - "33", - PARAM_INT - )); - $page->add(new admin_setting_configcheckbox('local_treestudyplan/bistate_accept_pending_submitted', get_string('setting_bistate_accept_pending_submitted', 'local_treestudyplan'), get_string('settingdesc_bistate_accept_pending_submitted', 'local_treestudyplan'),