Text in admin/help/search
and Text in admin/config regarding search

NB: this is a bug and feature request.

Fixed missing "." full stop at end of sentence, spelling errors, and simplified text in a few places. See screenshots, please.

Link issues: When "cron maintenance task" is referred to it links to the Status page. This is misleading to the user who may infer this is a link to either a page to configure cron maintenance, or a page referring specifically to cron only. I would like to remove the second instance and replace it with a link to the handbook page on this topic.

Depending on the user's need: to check status, or to find out more from handbook, two links should be offered. I have changed these links, and the text to be 'actionable'.

Screenshot attached showing changes in text on the two pages.

CommentFileSizeAuthor
#2 searchuitext.patch5.11 KBheather
searchsettings.png29.67 KBheather
searchuitext.patch5.12 KBheather
searcgui.png79.85 KBheather

Comments

sun’s picture

sun
Primary language German
Location Karlsruhe
commented
Issue tags: -ui-text usability +Needs usability review, +ui-text 
+++ modules/search/search.module	6 Sep 2009 22:59:06 -0000
@@ -97,12 +97,11 @@
+      $output = '<p>' . t('Note: By default, the search module only supports exact keyword matching. You can modify this behavior by installing a language-specific stemming module for your language, which allows words such as walk, walking, and walked all to match each other. Another approach is to install an n-gram module, which breaks words down into small, overlapping chunks and finds words with a high degree of overlap, so that words like earthquake and quake can match each other. A third approach is to use a third-party search technology with features like this built in; there are modules available for several of these, such as Apache Solr and Sphinx.') . '</p>';

I don't think we do "Note: " stuff in Drupal, and actually for me, as a non-native speaker (also considering translations), that entire construct looks strange. Why don't we simply drop that "Note: "?

This review is powered by Dreditor.

heather’s picture

heather commented
StatusFileSize
new searchuitext.patch5.11 KB

Thank you, sun.

I was changing a line which seemed long. But I see that is not clear. Perhaps:

It is important to note that by default... => By default...

Simply by inclusion, it calls attention to the reader, so no need to say "it is important, etc"

Fixed! Thank you.

heather’s picture

heather commented

Sun advised my introductory text was unclear. Also this could have been 2 patches, instead of one. Outline:

Problem: Typos, unclear text, and links.

Text in admin/help/search
and Text in admin/config regarding search
and admin/config/search/settings (link to cron)

Goal

To make text more legible and links suggest tasks.
To assist novice user in setting up search, and familiarising with cron.

Details

Depending on the user's need: to check status, or to find out more from handbook, two links should be offered. I have changed these links, and the text to be 'actionable'.

When "cron maintenance task" is referred to it links to the Status page. This is misleading to the user who may infer this is a link to either a page to configure cron maintenance, or a page referring specifically to cron only. I removed the second instance and replaced it with a link to the handbook page on this topic.

Procedure

1) "It is important to note that by default" = > "By default" (importance is inferred by inclusion)

2) "Configure relevance settings for search and other indexing options" => "Configure site search and indexing."

3) Change links to cron handbook page, or status page to check status of cron, depending on context.

Notes

Screenshots of changes above.

heather’s picture

heather commented
Issue tags: +D7UX

Status: Needs review » Needs work

The last submitted patch failed testing.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs work » Fixed

The search module help page has been completely revised since this issue was last looked at. Please check and see if you think there are still issues with the wording and/or links. I think all of what you brought up was addressed. So I'll mark this fixed for now. If you think there are still issues, please feel free to re-open.

Status: Fixed » Closed (fixed)
Issue tags: -Needs usability review, -ui-text, -D7UX

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

Issue tags: +Needs usability review, +ui-text, +D7UX

Restoring issue tags, see #2125755: System messages removed all issue tags during D7 upgrade.