numbas / Numbas

A completely browser-based e-assessment/e-learning system, with an emphasis on mathematics
http://www.numbas.org.uk
Apache License 2.0
199 stars 118 forks source link

When Numbas ends due to an error, show a link to a relevant bit of the documentation. #933

Open christianp opened 2 years ago

christianp commented 2 years ago

Some errors need more explanation than a one-line error message can convey.

It would be nice to have a dictionary of links corresponding to error messages, to show on the error screen.

The one I'm thinking about at the moment is jme.subvars.html inserted twice - when it's triggered by an MCQ expected answer field, an author would have to know a lot about how things work internally to work out why it was triggered. But we can't easily detect that case at the point in the code where the error was thrown, so I think a note in the documentation saying "this might be the cause" would be good.

The base URL for the documentation should be passed as a parameter to the compiler.