govCMS / GovCMS

Current Drupal release of the main GovCMS distribution, with releases mirrored at https://www.drupal.org/project/govcms
GNU General Public License v2.0
138 stars 40 forks source link

Add search api spell checker module to GovCMS #489

Open fjoxide opened 2 years ago

fjoxide commented 2 years ago

** What value does this module/package add to GovCMS?

It adds additional functionality to enhance the user experience Results show:

Did you mean: [some suggestion]?. like in Google. Spellcheck keyword variations: [some suggestion] [some suggestion]

** Please provide a brief outline of what this module does.

It works with any Search API backend that declares itself to support the "search_api_spellcheck" feature. At the moment automatic tests are only performed by the Search API Solr backend only.

Additional configuration is added to views to output this content in either a header or a footer.

** Who does this module benefit:

This module will assist the end users to more effectively find the content they are looking for.

** How could you provide/replicate the functionality of this module using alternative methods, eg in your theme?

Currently there is no way to replicate this functionality, even via the theme layer.

** If this module styles or alters HTML or JavaScript output, can the functionality be provided via the theme? What alternatives have you considered.

This module provides two theme templates that can be used to style the theme.

** What is the maintenance and support status of the module. Describe the issue queue activity.

It has a stable release and currently being used by 4180 websites. It has minimal bugs and heavily supported by the community.

** What permissions are needed to utilise the module (and are any new permissions provided by the module)?

no permission are provided by this module. Views provides the permissions.

** Does the module modify the database structure and/or store additional metadata on nodes or other entities? If so, why? What are the risks for future updates?

Currently there is no way to replicate this functionality, even via the theme layer. It uses already indexed data via apache solr.

** Is the module designed to capture anonymous user data? It does not capture anonymous data.

** Is the output of the module typically fully cacheable? Would the inclusion of this module potentially render pages uncacheable.

This module is cacheable through the views module, as it is only a plugin that you can use for views.

** What is your assessment of the quality of this module, the contribution history of the module's maintainers, and the uptake of the module within the Drupal community?

It has a stable release and currently being used by 4180 websites. It has minimal bugs and heavily supported by the community.

** Additional information

I plea that this module is installed and enabled as part of the GovCMS 9 SaaS distribution, as it provides additional functionality to the already search Api, Search API Solr. It will enhance the user experience with is a must with government websites. Having worked with government websites for the last 17 years, i truely believe this will assist agencies and users find content more accurately.

thisisalistairsaccount commented 2 years ago

Closing as information on issue can be found in #490

fjoxide commented 2 years ago

Hi @thisisalistairsaccount - wondering why this issue has been closed?

thisisalistairsaccount commented 2 years ago

Apologies @fjoxide I misread this at the time. Reopening. Broadly, more related to Search API than the Autocomplete in #490

thisisalistairsaccount commented 2 years ago

Module - https://www.drupal.org/project/search_api_spellcheck

fjoxide commented 2 years ago

@thisisalistairsaccount Thanks for reopening.

thisisalistairsaccount commented 2 years ago

Does anyone else in the community require this / find this a challenge with search results on their site?

We will leave this open to consider but will not progress in the meantime until we can see more interest

silverham commented 2 years ago

+1 to this.

StephenOllman commented 7 months ago

Im trying to understand the main intent for this module. Does it kick in once results have been rendered, or as the the user is typing their search keywords.

Is it looking at keywords and offering alternate suggestions based on spelling, tokeniser (spilts text) or stemming (talking to talk)?

I do find that Search API can be very strict in its keyword matching, so do see some value in this module functionality.

brett-sargeant commented 3 months ago

Could be useful for some sites, one painful one in particular.

dibs commented 1 month ago

+1, surprised it's not in already

thisisalistairsaccount commented 1 month ago

Hi All,

We're going to take a look at this and any equivalent type of functionality. There is some overlap with spell checking and synonyms.

In positive news, it's already Drupal 11 ready for when we think about those upgrades in 2025.