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
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
Comment | File | Size | Author |
---|---|---|---|
#17 | Screenshot 2020-06-09 at 11.26.20 PM.png | 166.23 KB | mohrerao |
#15 | 3086795-15.patch | 2.81 KB | jhodgdon |
Comments
Comment #4
jhodgdonWe 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:
and for User search, you get:
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?
Comment #5
dwwOf the options in #4: I prefer:
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:
I'll keep pondering this and if I come up with any alternate proposals, I'll post them.
Thanks,
-Derek
Comment #6
mindbet CreditAttribution: mindbet as a volunteer commentedSearch tips
Too colloquial?
Comment #7
jhodgdon"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?
Comment #8
andypostFrom 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
Comment #9
jhodgdonThe ? icon is provided as a CSS background image, so I think it is most likely not accessible at all?
Comment #10
jyotimishra-developer CreditAttribution: jyotimishra-developer at Srijan | A Material+ Company for Drupal India Association commentedHi all,
I will go with “how to search” because it is so simple and can be understood by all.
Thanks
Comment #11
jhodgdonI'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?
Comment #12
mohrerao CreditAttribution: mohrerao as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedI would prefer 'More about search' as this page tells you about ways to use search.
Comment #13
jhodgdonFor reference, here is the page about standards for interface text in Drupal:
https://www.drupal.org/docs/develop/user-interface-standards/interface-text
Comment #14
jhodgdonWe 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!
Comment #15
jhodgdonHere's a patch that changes the link text and the resulting page title to "About searching".
Comment #16
jhodgdonComment #17
mohrerao CreditAttribution: mohrerao as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedIf we are going with 'About searching', Shouldn't we also re name the landing page and the breadcrumbs?
Comment #18
jhodgdonI thought that the patch I made did rename the landing page. Not sure where the breadcrumbs come from...
Comment #19
mohrerao CreditAttribution: mohrerao as a volunteer and at Srijan | A Material+ Company for Drupal India Association commented@jhodgdon, I applied patch in #15 and checked. Page title still not updated.
Comment #20
jhodgdonThat'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.
Comment #21
mohrerao CreditAttribution: mohrerao as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedMy bad. That was from cache. I can see the title updated. Now need to update the breadcrumbs.
Comment #22
jhodgdonI'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. ???
Comment #23
mohrerao CreditAttribution: mohrerao as a volunteer and at Srijan | A Material+ Company for Drupal India Association commentedLooks like 2 search links in breadcrumbs is a bug as they both link to the same page. Couldn’t find the source of them.
Comment #24
jhodgdonActually 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.
Comment #25
mohrerao CreditAttribution: mohrerao as a volunteer and at Srijan | A Material+ Company for Drupal India Association commented@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
Comment #26
dwwI 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.
Therefore, RTBC.
Thanks!
-Derek
Comment #27
alexpottCommitted 240dcf7 and pushed to 9.1.x. Thanks!
Comment #29
andypostFiled follow-up to remove forgotten todo #3155221: Remove outdated todo and link to 3086795
Comment #31
sambara323 CreditAttribution: sambara323 commentedIs it possible to override the "About searching" page to add some styling to it