From ac3395fedc5c55c06451aa36fab2d897b8daf2dd Mon Sep 17 00:00:00 2001 From: Chris Sangwin <C.J.Sangwin@ed.ac.uk> Date: Tue, 28 Nov 2023 09:26:28 +0000 Subject: [PATCH] Update the adminui pages and documentation. --- adminui/index.php | 12 ++++++------ doc/en/Maintaining/index.md | 18 +++++++++++++----- lang/en/qtype_stack.php | 4 ++-- settings.php | 19 ++++++++++--------- 4 files changed, 31 insertions(+), 22 deletions(-) diff --git a/adminui/index.php b/adminui/index.php index d95d8fb1b..6a87bb0e2 100644 --- a/adminui/index.php +++ b/adminui/index.php @@ -37,16 +37,16 @@ $links = array( array('link' => (string) new moodle_url('/question/type/stack/doc/doc.php/'))), get_string('chat_desc', 'qtype_stack', array('link' => (string) new moodle_url('/question/type/stack/adminui/caschat.php'))), - get_string('stackInstall_testsuite_title_desc', 'qtype_stack', - array('link' => (string) new moodle_url('/question/type/stack/adminui/answertests.php'))), - get_string('stackInstall_input_title_desc', 'qtype_stack', - array('link' => (string) new moodle_url('/question/type/stack/adminui/studentinputs.php'))), get_string('bulktestindexintro_desc', 'qtype_stack', - array('link' => (string) new moodle_url('/question/type/stack/adminui/bulktestindex.php'))), + array('link' => (string) new moodle_url('/question/type/stack/adminui/bulktestindex.php'))), get_string('dependenciesintro_desc', 'qtype_stack', array('link' => (string) new moodle_url('/question/type/stack/adminui/dependencies.php'))), get_string('stackInstall_replace_dollars_desc', 'qtype_stack', - array('link' => (string) new moodle_url('/question/type/stack/adminui/replacedollarsindex.php'))), + array('link' => (string) new moodle_url('/question/type/stack/adminui/replacedollarsindex.php'))), + get_string('stackInstall_testsuite_title_desc', 'qtype_stack', + array('link' => (string) new moodle_url('/question/type/stack/adminui/answertests.php'))), + get_string('stackInstall_input_title_desc', 'qtype_stack', + array('link' => (string) new moodle_url('/question/type/stack/adminui/studentinputs.php'))), ); // Set up the page object. diff --git a/doc/en/Maintaining/index.md b/doc/en/Maintaining/index.md index 9d448d597..1df1bf288 100644 --- a/doc/en/Maintaining/index.md +++ b/doc/en/Maintaining/index.md @@ -1,10 +1,16 @@ # Maintaining questions and question banks -This section of the documentation provides information on testing questions and maintaining question banks for the long term. Many functions related to maintaining STACK questions are available from the question setting page or from the "adminui" page +This section of the documentation provides information on testing questions and maintaining question banks for the long term. Access to functions related to maintaining STACK questions is through the "adminui" page [...]/question/type/stack/adminui/index.php -To make use of these tools (in Moodle) users require the capability `qtype/stack:usediagnostictools` via Moodle's capability system. If your institution restricts site admin status, then this capability will allow a subset of users to access these functions. If that is also not possible, you might be able to convince your site administrators to run the tests themselves and give you the results. +(or available from the qtype_stack plugin setting page). To make use of these tools (in Moodle) users require the capability `qtype/stack:usediagnostictools` via Moodle's capability system. We stronly recommend anyone who regularly writes STACK questions across more than one Moodle course be given this capability. It enables the following: + +* Bulk testing of questions. +* Identifying STACK questions using particular blocks, e.g. the "todo" block, or includes. +* Bulk change of the default settings. + +If your institution restricts site admin status, then this capability will allow a subset of users to access these functions. If it is not possible to get this capability, then Moodle site administrators will need to run the tests themselves and give you the results. When you upgrade, or before you upgrade, please check the [release notes](../Developer/Development_history.md) carefully. @@ -26,13 +32,13 @@ You can bulk test all question tests on all variants of all question by using th STACK questions store the version of the STACK plug-in _last used_ to edit the question. The bulk tester runs all question tests, and also checks for changes with the current STACK plug-in version. -It is possible to [bulk test materials on other sites](Running_question_tests_other_site.md). +It is possible to [bulk test materials on other sites](Running_question_tests_other_site.md). (Site admins will have the option to bulk test all materials, and there is also a command line bulk test option.) ## Identifying STACK questions using particular blocks -It is possible to identify questions for dependencies, such as use of JSXGraph or inclusion of external maxima code. +It is possible to identify questions for dependencies, such as use of JSXGraph, inclusion of external maxima code, or "todo" blocks. -This is available from the question setting page or from the "adminui" page +The dependency checker is available from the question setting page or from the "adminui" page [...]/question/type/stack/adminui/index.php @@ -42,4 +48,6 @@ See also the notes on [local usage](Local_Usage.md) of STACK questions on your s You may need to [upgrade question defaults](UpgradeDefaults.md) over a range of questions. +## Import and replace questions +The STACK community developed an [import question as new version](https://github.com/maths/moodle-qbank_importasversion) plugin for Moodle. This plugin allows you to import a question from a Moodle XML file as a new version of an existing question. This is useful when a question is fixed/updated on an external site. diff --git a/lang/en/qtype_stack.php b/lang/en/qtype_stack.php index db97d6429..50dd9b05d 100644 --- a/lang/en/qtype_stack.php +++ b/lang/en/qtype_stack.php @@ -83,7 +83,7 @@ $string['autosimplifyprt_link'] = '%%WWWROOT%%/question/type/stack/doc/doc.php/C $string['boxsize'] = 'Input box size'; $string['boxsize_help'] = 'Width of the html formfield.'; $string['boxsize_link'] = '%%WWWROOT%%/question/type/stack/doc/doc.php/Authoring/Inputs.md#Box_Size'; -$string['bulktestindexintro_desc'] = 'The <a href="{$a->link}">run the question tests in bulk script</a> lets you easily run all the STACK questions in a given context. Not only does this test the questions. It is also a good way to re-populate the CAS cache after it has been cleared.'; +$string['bulktestindexintro_desc'] = 'The <a href="{$a->link}">bulk test script</a> lets you easily run all the STACK question tests in a given context. Not only does this test the questions. It is also a good way to re-populate the CAS cache after it has been cleared.'; $string['dependenciesintro_desc'] = 'The <a href="{$a->link}">dependencies</a>, checker finds questions with dependencies such as JSXGraph or inclusion of external maxima code.'; $string['checkanswertype'] = 'Check the type of the response'; $string['checkanswertype_help'] = 'If yes, answers which are of a different "type" (e.g. expression, equation, matrix, list, set) are rejected as invalid.'; @@ -1107,7 +1107,7 @@ $string['Interval_illegal_entries'] = 'The following should not appe // Documentation strings. $string['stackDoc_404'] = 'Error 404'; $string['stackDoc_docs'] = 'STACK Documentation'; -$string['stackDoc_docs_desc'] = '<a href="{$a->link}">Documentation for STACK</a>: a local static wiki documenting the code you actually have running on your server.'; +$string['stackDoc_docs_desc'] = 'The <a href="{$a->link}">documentation for STACK</a>: a local static wiki documenting the code you actually have running on your server.'; $string['stackDoc_home'] = 'Documentation home'; $string['stackDoc_index'] = 'Category index'; $string['stackDoc_siteMap'] = 'Site map'; diff --git a/settings.php b/settings.php index 449dc6684..b9fd2331a 100644 --- a/settings.php +++ b/settings.php @@ -31,22 +31,23 @@ require_once(__DIR__ . '/stack/prt.class.php'); // Useful links. $links = array( get_string('stackDoc_docs_desc', 'qtype_stack', - array('link' => (string) new moodle_url('/question/type/stack/doc/doc.php/'))), + array('link' => (string) new moodle_url('/question/type/stack/doc/doc.php/'))), get_string('healthcheck_desc', 'qtype_stack', - array('link' => (string) new moodle_url('/question/type/stack/adminui/healthcheck.php'))), + array('link' => (string) new moodle_url('/question/type/stack/adminui/healthcheck.php'))), get_string('chat_desc', 'qtype_stack', - array('link' => (string) new moodle_url('/question/type/stack/adminui/caschat.php'))), - get_string('stackInstall_testsuite_title_desc', 'qtype_stack', - array('link' => (string) new moodle_url('/question/type/stack/adminui/answertests.php'))), - get_string('stackInstall_input_title_desc', 'qtype_stack', - array('link' => (string) new moodle_url('/question/type/stack/adminui/studentinputs.php'))), + array('link' => (string) new moodle_url('/question/type/stack/adminui/caschat.php'))), get_string('bulktestindexintro_desc', 'qtype_stack', - array('link' => (string) new moodle_url('/question/type/stack/adminui/bulktestindex.php'))), + array('link' => (string) new moodle_url('/question/type/stack/adminui/bulktestindex.php'))), get_string('dependenciesintro_desc', 'qtype_stack', array('link' => (string) new moodle_url('/question/type/stack/adminui/dependencies.php'))), get_string('stackInstall_replace_dollars_desc', 'qtype_stack', - array('link' => (string) new moodle_url('/question/type/stack/adminui/replacedollarsindex.php'))), + array('link' => (string) new moodle_url('/question/type/stack/adminui/replacedollarsindex.php'))), + get_string('stackInstall_testsuite_title_desc', 'qtype_stack', + array('link' => (string) new moodle_url('/question/type/stack/adminui/answertests.php'))), + get_string('stackInstall_input_title_desc', 'qtype_stack', + array('link' => (string) new moodle_url('/question/type/stack/adminui/studentinputs.php'))), ); + $settings->add(new admin_setting_heading('docs', get_string('settingusefullinks', 'qtype_stack'), '* ' . implode("\n* ", $links))); -- GitLab