document the new Search Engine Manager

RESOLVED FIXED in Firefox 2 beta1

Status

defect
RESOLVED FIXED
13 years ago
3 years ago

People

(Reporter: steffen.wilberg, Assigned: steffen.wilberg)

Tracking

({fixed1.8.1})

2.0 Branch
Firefox 2 beta1
Dependency tree / graph
Bug Flags:
blocking-firefox2 +

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment, 1 obsolete attachment)

v2
4.28 KB, patch
jwalden+fxhelp
: review+
steffen.wilberg
: approval-branch-1.8.1+
Details | Diff | Splinter Review
(Assignee)

Description

13 years ago
Bug 232272 introduced a new Search Engine Manager.

At the very least we need to change this sentence in Using Firefox - Searching - Searching the Web: "Select Add Engines... to install additional Search Engines" since "Add Engines..." has been replaced by "Manage Search Engines...".

Updated

13 years ago
Flags: blocking-firefox2?
(Assignee)

Comment 1

13 years ago
Also, bug 317107 changed the "search for selected words" context menu command from using the default search engine to using to current engine.
Depends on: 317107
(Assignee)

Comment 2

13 years ago
Posted patch patch (obsolete) — Splinter Review
I've added new sections "Selecting the Search Engine to use" and "Manage Search Engines". I've also addressed the new "search for selected words" behavior.
Assignee: nobody → steffen.wilberg
Status: NEW → ASSIGNED
Attachment #220254 - Flags: review?(jwalden+fxhelp)
(Assignee)

Comment 3

13 years ago
Would be nice to have for a2, but that's only a few days ahead.
Target Milestone: --- → Firefox 2 alpha2

Comment 4

13 years ago
Gavin, is this ready for documentation, or should we wait for things like
"reset defaults"? I don't have your buglist, but this one looks like a candidate.
I don't expect the current manager functions to change. Additions may be made (e.g. drag and drop, "restore defaults"), but I don't think those make any of the documentation already submitted by Steffen incorrect.
(Assignee)

Updated

13 years ago
Target Milestone: Firefox 2 alpha2 → Firefox 2 beta1
Comment on attachment 220254 [details] [diff] [review]
patch

> <p>Searching for web pages on a particular topic is as easy as typing a few
>   words into &brandShortName;'s Search Bar as pictured below:<br/>
>-<img src="&images.baseURL;/searchbar.png" alt=""
>-     width="134" height="30"/></p>
>+  <img src="&images.baseURL;/searchbar.png" alt="" width="134" height="30"/></p>

If images are turned off, "as pictured below" makes no sense, particularly since there's no alternate text.  Since the image is mostly superfluous, let's replace " as pictured below:" with a period and either keep or remove the image.  I don't think there's any real harm in leaving the image in place, but I don't see how it really helps, either.


>+<h4 id="selecting_the_search_engine">Selecting the Search Engine to use</h4>

"to use" seems unnecessary here.


>+<p>You can click on the Search Engine icon to choose another Search Engine.

This should refer to the arrow next to the icon, not to the icon itself.


>+  You can also switch between installed Search Engines by pressing
>+  &accelKey;+<kbd>Up Arrow</kbd> and &accelKey;+<kbd>Down Arrow</kbd>.

I don't think we want this sentence here since we're planning to de-emphasize that shortcut in bug 339485, but I don't think we want to replace it with an F4/Alt+Up/Down sentence.  Tell me if I'm wrong about this, tho.


>   There are Search Engines which search the whole web like Google; others only
>-  search specific sites like Amazon.com. Select <em>Add Engines...</em>
>-  to install additional Search Engines.</p>
>+  search specific sites like Amazon.com.</p>

This sentence (specifically the "there are" construct) is weak.  How about:

Some Search Engines, like Google, search the whole web; others, like Amazon.com, only search specific sites.


>+  <p>Select <em>Manage Search Engines...</em> to add, reorder, or remove Search

Nit: un-indent this.


>+  Engines. Select a Search Engine and click the respective button to move it up
>+  or down, or remove it.

The phrasing of the last bit of this and the single comma are a bit strange.  How about "...to move it around within the list or remove it."?  Also, I think "appropriate" is a slightly better choice of word than "respective".


> Click the <em>Get more search engines...</em>link to
>+  visit a site which offers a range of additional Search Engines.</p>

"a site which offers a range of additional Search Engines"?  There has to be a better way to write this sentence, but I'm having trouble thinking of one right now.


Anyway, there are still a few loose ends to wrap up here, so r- until we can wrap them up.
Attachment #220254 - Flags: review?(jwalden+fxhelp) → review-
Flags: blocking-firefox2? → blocking-firefox2+
(Assignee)

Comment 7

13 years ago
Posted patch v2Splinter Review
> If images are turned off, "as pictured below" makes no sense, particularly
> since there's no alternate text.  Since the image is mostly superfluous, let's
> replace " as pictured below:" with a period and either keep
fixed.

> or remove the image. I don't think there's any real harm in leaving the image in place, but
> I don't see how it really helps, either.
The image is useful because people might confuse the search bar with e.g. the find bar. It needs to be updated to the new UI, but that has to wait until changes to that UI are complete.

>> +<h4 id="selecting_the_search_engine">Selecting the Search Engine to use</h4>
> "to use" seems unnecessary here.
fixed.

>> +<p>You can click on the arrow next to the Search Engine icon to choose another Search Engine.
> This should refer to the arrow next to the icon, not to the icon itself.
Indeed. So how about "You can click on the arrow next to the magnifying glass"?

>> +  You can also switch between installed Search Engines by pressing
>> +  &accelKey;+<kbd>Up Arrow</kbd> and &accelKey;+<kbd>Down Arrow</kbd>.
> I don't think we want this sentence here since we're planning to de-emphasize
> that shortcut in bug 339485, but I don't think we want to replace it with an
> F4/Alt+Up/Down sentence.  Tell me if I'm wrong about this, tho.
Yeah, let's remove it. It's not really comfortable having to press CTRL+k and then ALT+up/down to open the engine selection menu.

> This sentence (specifically the "there are" construct) is weak.  How about:
> Some Search Engines, like Google, search the whole web; others, like
> Amazon.com, only search specific sites.
sure, fixed.

>> +  <p>Select <em>Manage Search Engines...</em> to add, reorder, or remove it
> Nit: un-indent this.
fixed.

>> +  Engines. Select a Search Engine and click the respective button to move it
>> +  up or down, or remove it.
> The phrasing of the last bit of this and the single comma are a bit strange. 
> How about "...to move it around within the list or remove it."?  Also, I think
> "appropriate" is a slightly better choice of word than "respective".
both fixed.

>> Click the <em>Get more search engines...</em>link to
>> visit a site which offers a range of additional Search Engines.</p>
> "a site which offers a range of additional Search Engines"?  There has to be a
> better way to write this sentence, but I'm having trouble thinking of one right
> now.
How about "You can install additional search engines from the [link] Firefox Add-ons web site."? That's like we do it for add-ons.
Attachment #220254 - Attachment is obsolete: true
Attachment #224239 - Flags: review?(jwalden+fxhelp)
Comment on attachment 224239 [details] [diff] [review]
v2

(In reply to comment #7)
> >> +<p>You can click on the arrow next to the Search Engine icon to choose another Search Engine.
> > This should refer to the arrow next to the icon, not to the icon itself.
> Indeed. So how about "You can click on the arrow next to the magnifying glass"?

Per IRC,

"...click on the arrow at the end of the Search Bar to choose..."

> How about "You can install additional search engines from the [link] Firefox
> Add-ons web site."? That's like we do it for add-ons.

It sort of sticks to see, "Bon Echo Add-ons", but I do think we want to use the &brandShortName; entity instead of directly referencing Firefox in text.  Also, don't bother with "the" or "web site" -- just do "...from [&brandShortName; Add-ons]".
Attachment #224239 - Flags: review?(jwalden+fxhelp) → review+
(Assignee)

Updated

13 years ago
Attachment #224239 - Flags: approval-branch-1.8.1+
(Assignee)

Comment 9

13 years ago
Checked in trunk & branch, with comments addressed.
Status: ASSIGNED → RESOLVED
Last Resolved: 13 years ago
Keywords: fixed1.8.1
Resolution: --- → FIXED
Product: Firefox → Firefox Graveyard
You need to log in before you can comment on or make changes to this bug.