Skip to content

Commit 5d8f5a0

Browse files
committed
Add uninstall instructions to Readme.md
1 parent 76aa561 commit 5d8f5a0

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

Readme.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ unusual question type.
2626
- [Setting the quiz review options](#setting-the-quiz-review-options)
2727
- [Sandbox Configuration](#sandbox-configuration)
2828
- [Running the unit tests](#running-the-unit-tests)
29+
- [Uninstalling CodeRunner](#uninstalling-coderunner)
2930
- [The Architecture of CodeRunner](#the-architecture-of-coderunner)
3031
- [Question types](#question-types)
3132
- [An example question type](#an-example-question-type)
@@ -414,6 +415,40 @@ tell you if you need be at all worried.
414415
Feel free to [email the principal developer](mailto:[email protected]) if you have problems
415416
with the installation.
416417

418+
## Uninstalling CodeRunner
419+
420+
Like any question-type plugin, CodeRunner can be uninstalled using the *Uninstall*
421+
link in the Moodle *Manage plugins* page. BUT in order for that link to be
422+
present (for any question type), the system checks to see if there are any questions
423+
of that type present. If so, the link is silently not displayed.
424+
425+
So, you need to do the following before the Uninstall link is displayed:
426+
427+
1. Backup your server.
428+
429+
2. Find any quizzes that use CodeRunner questions and either delete them or
430+
remove the CodeRunner questions from them. If you don't do this, then when
431+
you try to delete the questions from the question bank (step 2) they will simply be
432+
hidden rather than properly deleted.
433+
434+
3. Remove all the user-defined CodeRunner questions.
435+
436+
4. Delete all the CodeRunner prototypes (which define the set of available
437+
question types) from the System > Top for System > CR_PROTOTYPES category.
438+
This requires Moodle administrator level privileges.
439+
440+
You should then find the Uninstall link showing for CodeRunner in the Manage plugins page.
441+
If not, you must still have some CodeRunner questions hidden away somewhere. If you
442+
have admin rights, you should be able to find them with the SQL command:
443+
444+
select id, category, name from mdl_question where qtype='coderunner';
445+
446+
If you have a lot of coderunner questions you *may* be able to just delete all the coderunner
447+
questions SQL but I'd be very reluctant to do that myself as it will break
448+
the database integrity and I'm not sure that the subsequent plugin deletion
449+
will clean up the mess. Certainly any quizzes referring to deleted questions
450+
will break (but of course they're going to break anyway if you uninstall CodeRunner).
451+
417452
## The Architecture of CodeRunner
418453

419454
Although it's straightforward to write simple questions using the

0 commit comments

Comments
 (0)