Skip to content

Incorporate HTML help in the Web UI #1365

@lupino3

Description

@lupino3

Context

Currently, the web UI has no built-in help. The Swing UI, by contrast, embeds the user documentation and allows the user to browse it during the execution.

This was not a problem when the Web UI was consumed only online, as users could just navigate to readthedocs and peruse the documentation.

However, we are packaging the Web UI via Electron for use in contexts without internet connection (such as university exams)

Task

Build into the web application the ability to consult the help within the application. This means that the help static files (HTML/CSS/etc.) will need to be bundled within the web app, possibly as static files, and there should be a way for the user to read it with no internet connection.

This should work in the Electron version as well.

All languages should be available in the help.

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions