Problem/Motivation

From #2664830-150: Add search capability to help topics (ambermatz): If a user has the search block enabled and placed in the default front-facing theme and they perform a search, the linked text "Search help" will appear near the form. See also this screenshot
Search result page

This text in this context means "Read some help documentation about searching on this site."

But now we have a search form on admin/help would could quite conceivably be titled "Search help". And in this context it would mean, "Search for help topics." Having these two meanings of "Search help" co-exist on a site could lead to confusion. (It certainly tripped me up when I was testing.)

Proposed resolution

Change the link text to "About searching". Also change the page title when you get to the page to "About searching".

Remaining tasks

Review the patch. Note that the Usability group has already approved the idea of calling the link "About searching" (see comment #14).

User interface changes

Less ambiguous link for getting help about searching.

API changes

Data model changes

None.

Release notes snippet

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jhodgdon created an issue. See original summary.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

jhodgdon’s picture

We still need to fix this...

I couldn't think of a good thing to change the link text to. So let's think about this a bit. If you click on the link, it takes you to a page that shows you the results of the getHelp() method on the applicable search page. The default (used by Node and Help search) is to return:

      'list' => [
        '#theme' => 'item_list',
        '#items' => [
          $this->t('Search looks for exact, case-insensitive keywords; keywords shorter than a minimum length are ignored.'),
          $this->t('Use upper-case OR to get more results. Example: cat OR dog (content contains either "cat" or "dog").'),
          $this->t('You can use upper-case AND to require all words, but this is the same as the default behavior. Example: cat AND dog (same as cat dog, content must contain both "cat" and "dog").'),
          $this->t('Use quotes to search for a phrase. Example: "the cat eats mice".'),
          $this->t('You can precede keywords by - to exclude them; you must still have at least one "positive" keyword. Example: cat -dog (content must contain cat and cannot contain dog).'),
        ],
     ]

and for User search, you get:

      'list' => [
        '#theme' => 'item_list',
        '#items' => [
          $this->t('User search looks for user names and partial user names. Example: mar would match usernames mar, delmar, and maryjane.'),
          $this->t('You can use * as a wildcard within your keyword. Example: m*r would match user names mar, delmar, and elementary.'),
        ],
      ],

So it is giving you help with the syntax of searching. How can we get this across in the link text, without using the phrase "Help search" (which makes us think we are searching for help)... Ideas:

a) Help with searching
b) How to search
c) Search syntax help
d) More about searching

Thoughts?

dww’s picture

Of the options in #4: I prefer:

b) How to search

1. Shortest option
2. Doesn't mention "Help", and avoids that confusion.
3. Doesn't mention "syntax" which is probably too technical.

2nd choice would be:

a) Help with searching

I'll keep pondering this and if I come up with any alternate proposals, I'll post them.

Thanks,
-Derek

mindbet’s picture

Search tips

Too colloquial?

jhodgdon’s picture

"Search tips" -- that's an interesting idea!

It made me think about the link for text format help, which I think used to be called "filter tips" a long time ago -- you see under a text-with-format field, such as the one in the Comment form on drupal.org. On drupal.org (which is Drupal 7), the link text is:

More information about text formats

and it has a help icon (looks like ?) after it.

In Drupal 8, it looks like the text is "About text formats" (it is added in core/modules/filter/srce/Element/TextFormat), and I'm not sure if it has the help icon or not.

So maybe we should use this text, for consistency:

About searching

and see if we can get that help icon displayed after it to indicate it is a help link?

andypost’s picture

From a11y POV it also needs review, looking at webform module ...as example it looks like tour or just a (i) icon around "search" button on the page

Like the "filter tops" in current state

jhodgdon’s picture

The ? icon is provided as a CSS background image, so I think it is most likely not accessible at all?

jyotimishra-developer’s picture

Hi all,
I will go with “how to search” because it is so simple and can be understood by all.
Thanks

jhodgdon’s picture

I'm not too sure about "How to search" actually (even though I suggested it)... The page it links to doesn't really tell you how to do a basic search (enter keywords and click the search button). It gives you some information about more advanced options (AND, OR, quotes, etc.). So I am not sure "how to search" is correct?

mohrerao’s picture

I would prefer 'More about search' as this page tells you about ways to use search.

jhodgdon’s picture

For reference, here is the page about standards for interface text in Drupal:
https://www.drupal.org/docs/develop/user-interface-standards/interface-text

jhodgdon’s picture

We discussed this in the Usability group meeting today
#3137865: Drupal Usability Meeting 2020-06-09

The consensus ideas:
- We should not start the link with the word "Search" because most of our links start with verbs, and that is the confusing part about this link when it is on the Search page.
- We want the link to be short.
- Putting the ? icon on the link would make the area busy -- the search button itself (in most themes) is already an icon
- The best link text is probably:

About searching

So, I think we can now make a patch!

jhodgdon’s picture

Issue summary: View changes
FileSize
2.81 KB

Here's a patch that changes the link text and the resulting page title to "About searching".

jhodgdon’s picture

Status: Active » Needs review
mohrerao’s picture

If we are going with 'About searching', Shouldn't we also re name the landing page and the breadcrumbs?
search help page

jhodgdon’s picture

I thought that the patch I made did rename the landing page. Not sure where the breadcrumbs come from...

mohrerao’s picture

@jhodgdon, I applied patch in #15 and checked. Page title still not updated.

jhodgdon’s picture

Status: Needs review » Needs work

That's odd. I thought that I searched the code for the string "Search help" and removed all instances. If not, the patch definitely needs work. Should figure out the breadcrumbs too, as they are weird to say the least.

mohrerao’s picture

My bad. That was from cache. I can see the title updated. Now need to update the breadcrumbs.

jhodgdon’s picture

I'm not actually sure where the breadcrumbs are coming from. I thought there was either a YML file or a class that would handle them, but I do not see either in the Search module. ???

mohrerao’s picture

Looks like 2 search links in breadcrumbs is a bug as they both link to the same page. Couldn’t find the source of them.

jhodgdon’s picture

Status: Needs work » Needs review
Related issues: +#3027108: Search breadcrumbs have duplicate entry for Search in them

Actually the breadcrumbs should be a separate issue. Not only that but the issue already exists:
#3027108: Search breadcrumbs have duplicate entry for Search in them

So, I'm going to set this back to Needs Review. The scope is only to change the title/link for the pages that give you help with searching. The breadcrumbs should be addressed on the other issue.

mohrerao’s picture

@jhodgdon, Agreed. This is no way related. I believe the breadcrumbs issue is also from breadcrumbs module as i did not find anything related to it in Search module.
+1 for RTBC

dww’s picture

Status: Needs review » Reviewed & tested by the community
Issue tags: +Bug Smash Initiative

I was going to point out some problems with the test in #15, but those are existing problems. This patch is only about the string change, and the patch correctly handles that. We don't need to perfect the tests here.

  • All tests are passing.
  • No CS warnings/errors.
  • Patch is clean and good.
  • Nothing (in scope) to complain about. ;)

Therefore, RTBC.

Thanks!
-Derek

alexpott’s picture

Status: Reviewed & tested by the community » Fixed
Issue tags: +String change in 9.1.0

Committed 240dcf7 and pushed to 9.1.x. Thanks!

  • alexpott committed 240dcf7 on 9.1.x
    Issue #3086795 by jhodgdon, mohrerao, dww: "Search help" link in search...
andypost’s picture

Filed follow-up to remove forgotten todo #3155221: Remove outdated todo and link to 3086795

Status: Fixed » Closed (fixed)

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

sambara323’s picture

Category: Bug report » Support request

Is it possible to override the "About searching" page to add some styling to it