Problem/Motivation

The UI text on the Search administration page refers to the "search engine" even though this wording is not used anywhere else.
This text needs to be updated to be more consistent with the wording used for the hook_help text, to make it clearer for administrators.

Proposed resolution

Update the UI text, using wording consistent with the hook_help text.

Remaining tasks

Update the UI text

User interface changes

This is a UI text change.

API changes

None.

Data model changes

None.

Comments

ifrik created an issue. See original summary.

duaelfr’s picture

Issue tags: +Novice
rumburak’s picture

Assigned: Unassigned » rumburak
rumburak’s picture

StatusFileSize
new26.7 KB

I did three changes in the admin UI.
- Replaced search engine with Search module
- Adapted the description for the number of items to run per cron job, replacing pass with run
- Improved the description for the minimum word length: "The minimum number of characters a word need to have in order to be indexed."

Please not use this patch, it seems something went wrong in generating it... I will prepare another.

rumburak’s picture

Status: Active » Needs review
StatusFileSize
new2.07 KB

Here is the clean update, considering the changes already comited to the git.
List of changes:
- Adapted the description for the number of items to run per cron job, replacing pass with run
- Improved the description for the minimum word length: "The minimum number of characters a word need to have in order to be indexed."

ehegedus’s picture

Status: Needs review » Reviewed & tested by the community

The last submitted patch, 4: update_the_ui_text_for-2572689-4.patch, failed testing.

The last submitted patch, 4: update_the_ui_text_for-2572689-4.patch, failed testing.

yoroy’s picture

Status: Reviewed & tested by the community » Needs work
+++ b/core/modules/search/src/SearchPageListBuilder.php
@@ -227,7 +227,7 @@ public function buildForm(array $form, FormStateInterface $form_state) {
+      '#description' => $this->t('The minimum number of characters a word need to have…

needS

jhodgdon’s picture

Also the issue summary says something about "search engine", but I don't see it in the patch?

ifrik’s picture

Yes, it still says "search engine" in the explanation text on the Search pages page. Replacing it with "Search module" as it was done in the first, failed patch would solve that, but the text still would be unnecessarily long.

Also, the administration page has a lot of configuration in the different sections. So how about leaving out any general explanation text here, and rather ensure that the individual descriptions are to the point?

At which point the only explanation worth adding would be under "Indexing process"
Any items that are <em>not</em> indexed, can not be found in the searches.

jhodgdon’s picture

Issue tags: +rc deadline

Apparently this needs to be "rc deadline" because it changes translatable UI text strings. See https://groups.drupal.org/node/484788

jhodgdon’s picture

Category: Plan » Task
Status: Needs work » Needs review
StatusFileSize
new4.3 KB
new94.1 KB

Here is a new patch, along with a screen shot of the search config page that results from it.

I took out the page-level help for the Search settings page, and moved all relevant explanations to the affected areas. Also, links to "cron" go to the Cron settings page, not the status report (we have done that all over Core hook_help(), but it wasn't done here previously except in search_help()).

See what you think... No interdiff, as it's the same size as the patch file.

bendev’s picture

StatusFileSize
new3.07 KB

I made the same patch but you posted 2 minutes earlier ;-)

tested #13 and works ok
also agree with the changes proposed.

@edit : sorry I didn't want to post the patch again. I didn't realize it was still there (- the field looked empty) and it seems I can't remove it now...

jhodgdon’s picture

StatusFileSize
new4.3 KB
new4.27 KB

Discussed this with Bojhan and longwave on IRC and we came up with a slightly better description for the minimum keyword field.
longwave++
Bojhan++

Bojhan’s picture

Status: Needs review » Reviewed & tested by the community

Slightly? Way better! :P

jhodgdon’s picture

bendev: thanks! Your patch is not quite the same. I think we want to go with my latest one -- it removes some text from search.module and modifies things differently in the other file. Thanks!

And sorry, the issue got confused about uploaded patches on that last comment. The patch we want is the one numbered "14".

bendev’s picture

no problem, I test it right away

bendev’s picture

patch #14 of comment #15 tested ok

  • xjm committed a6ecdda on 8.0.x
    Issue #2572689 by jhodgdon, rumburak, ifrik, yoroy, Bojhan, longwave:...

  • xjm committed 153e1b9 on 8.0.x
    Revert "Issue #2572689 by jhodgdon, rumburak, ifrik, yoroy, Bojhan,...
  • xjm committed 43f610c on 8.0.x
    Issue #2572689 by jhodgdon, rumburak, ifrik, yoroy, Bojhan, longwave,...
xjm’s picture

Assigned: rumburak » Unassigned
Status: Reviewed & tested by the community » Fixed

Adding longwave to the commit message per #15, though unfortunately I can't grant issue credit yet without a comment on the issue. Also reverted and re-committed to ensure bendev had credit for testing manually. Thanks all! Committed and pushed to 8.0.x.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.