Add Search to Online and Offline Help

[Delphinus8821]

Prerequisites

• Reviewed the checklist

• Reviewed feedback from the "Sonar Cloud" bot. Note that you have to wait
  for the "CI / Unit Tests") to complete first. Failed Unit tests can be
  debugged by adding the label "verbose logging" to the GitHub PR.

Description of the Change

Added the functionality from the MiniSearch project to add a search into online and offline help. This allows for users to search the help documentation from within the help webserver instead of having to navigate the table of contents or search from within Constellation.

This search stores the names of all of the help pages and which category they belong in according to the table of contents. E.g. searching the word 'analytics' will show all of the help pages for the analytics in the Analytic View. Searching 'view' will return help pages for the views.

Example of search suggestions:

Example of the results of a search:

To include the search for online help, a json file is required to hold all of the searchable data as the website for online help isn't able to generate this data like the application can. This will mean when new help pages are added, the search.json file will need to be updated manually, the same way the toc.md file currently is.

The online help search will not work until this PR, and a PR in the github.io repo have been merged and the documentation update script has been run,

As part of this PR, as the HTML used for creating the offline help pages needed to be edited and added to for adding in the search functionality, the HTML has been moved to a template to make the code easier to manage.

Also removed some of the scripts that were used when originally writing online and offline help that are no longer used.

Alternate Designs

The way that MiniSearch has been setup allows for Constellation to read the content from the table of contents file (toc.md) to create the json data required for the search. As the toc.md file only contains the title of each help page, the category they are part of and the link to the page, this is all of the data that the search currently has access to.

MiniSearch would be capable of storing and searching all of the data if we decided to include the content from every help page, but this would require having to read in every help page whenever offline help is run. Currently we don't have a way to access all of these help pages from within the code as the toc.md file only needs to access the toc.xml files for each module to be created. This could potentially be something to look into in the future.

Why Should This Be In Core?

Allows users to search for help pages from within the help webserver.

Benefits

Gives users an alternative way of navigating help. Makes help pages easier to find.

Possible Drawbacks

Creating the search data whenever Constellation opens the offline help documentation could potentially slow down the process of opening the offline help webserver but at this stage I have not noticed any performance issues.

Verification Process

Open Constellation and open a help page using offline help.
Type something into the search bar and observe both suggestions and results being shown (Use example above with the word 'analytics').
Click on one of the results and confirm the result loads the corresponding help page.

Applicable Issues

#1643
#1473

[Quasar985]

Tested it out and it works, just a few code smells from sonar

[antares1470]

A couple of other changes:

1. Could you please add a whatsnew entry for this?
2. Could you update ATTRIBUTION.md so that to minisearch use is appropriately attributed

[antares1470]

could we possibly get a comment at the beginning of the file here just to outline what needs to be done to update this file (noting from your PR description that this would now need to be updated manually)

[Delphinus8821]

There is a comment in ConstellationHelpDisplayer.createSearchDocument() explaining how this is updated as that's where the file is created

[sonarqubecloud]

Quality Gate failed

Failed conditions
6.6% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

[mimosa2]

Looks good. A minor suggestion. Is it possible to make the the search box a a bit shorter?

[Delphinus8821]

Looks good. A minor suggestion. Is it possible to make the the search box a a bit shorter?

I had a look at changing this but the suggestions list is hard to make the same width, so it looks weird having the search box shorter and the suggestions list being the full width