Closed Bug 638816 Opened 12 years ago Closed 12 years ago

Update Help for FAYT changes

Categories

(SeaMonkey :: Help Documentation, defect)

defect
Not set
normal

Tracking

(seamonkey2.3 fixed, seamonkey2.4 fixed)

RESOLVED FIXED
seamonkey2.4
Tracking Status
seamonkey2.3 --- fixed
seamonkey2.4 --- fixed

People

(Reporter: InvisibleSmiley, Assigned: ewong)

References

Details

Attachments

(1 file, 3 obsolete files)

From bug 623903 comment 10:
"Searching Within a Page" and "Using Find-as-you-type" needs an update
See nav_help.xhtml#578 and nav_help.xhtml#614
Assignee: nobody → ewong
Status: NEW → ASSIGNED
For clarification: This bug is about fixing the contents of the two Help sections mentioned above. They still refer to the old Find dialog (and the elements in there) rather than the new find bar. In the end the Help contents of these two sections must match current SeaMonkey behavior and UI.
Attachment #539514 - Flags: review?(jh)
Comment on attachment 539514 [details] [diff] [review]
Updated Help for the FAYT changes.

Review of attachment 539514 [details] [diff] [review]:
-----------------------------------------------------------------

r- for now for there are quite some things that still need to be done. I tried to be a bit more verbose so that I don't completely drive you away/insane. ;-) Thanks for tackling this!

::: suite/locales/en-US/chrome/common/help/nav_help.xhtml
@@ +581,5 @@
>  
>  <ol>
>    <li>Open the Edit menu and choose <q>Find in This Page</q>. If the page
>      you are viewing contains frames, you may need to click within a frame
> +    before you begin your search. You see the <q>Find Bar</q>.</li>

"Find Bar" is OK, but for posterity: The only place in the UI that uses this term right now is the close button on the find bar, which reads "Close Find bar" (with a lowercase B), while the file which contains the definition, mozilla/toolkit/en-US/chrome/global/findbar.dtd, mentions "Find Bar" (with an uppercase B) in the l10n note. Poor Toolkit guys, no capable reviewers there it seems. :-(

@@ +592,3 @@
>      </ul>
>    </li>
> +  <li>Click Next to begin the search from the insertion point forwards

Hmm, I like the old formulation (under the removed "Wrap") better, since it refers to the cursor position rather than an "insertion point".

Note that Find still wraps the search so we should mention that (and maybe that the Find Bar tells you when that happens), even though you cannot configure that behavior anymore.

Also, since we're down to only one option left we should not use an unordered list for that anymore. Instead, please just describe the UI elements in order, i.e. first the search field (an that pressing Enter on it will do a forward search), then Next and Previous, then "Highlight all" (which you haven't documented yet), then "Match case".

@@ +592,5 @@
>      </ul>
>    </li>
> +  <li>Click Next to begin the search from the insertion point forwards
> +      to the bottom of the page.</li>
> +  <li>Click Previous to begin the search from the insertion point

When you change the formulation for Next, please change Previous accordingly.

@@ +599,5 @@
>  
>  <p>To find the same word or phrase again:</p>
>  
>  <ul>
>    <li>Open the Edit menu and choose Find Again.</li>

Alternatively one can either keep hitting Enter while focus is on the search field, or use the Find Again shortcuts (cf. the "Using Find-as-you-type" section below) when the focus is on the page. In both cases, a forward search will be invoked, no matter whether the Previous button was pressed the last time.

@@ +604,5 @@
>  </ul>
>  
>  <p>[<a href="#searching_the_web">Return to beginning of section</a>]</p>
>  
>  <h2 id="using_find_as_you_type">Using Find-as-you-type</h2>

The Using Find-as-you-type section needs checking and adjustments, too. Example:

"3. The status bar (at the bottom of your browser window) displays your
    search string and whether or not the search is successful."

This is still true, but only if the "Show the find toolbar during find as you type" checkbox in Preferences/Advanced/Find As You Type is not selected. If the checkbox is selected (which is true by default), the Find Bar is used instead of changing the status bar text.

Note that MailNews does not support the Find Bar (in fact it still uses the old Find dialog, plus the status bar FAYT) but this Help section appears in the context of Browsing the Web, so you may ignore that special case here.
Attachment #539514 - Flags: review?(jh) → review-
Attachment #539514 - Attachment is obsolete: true
Attachment #540300 - Flags: review?(jh)
Comment on attachment 540300 [details] [diff] [review]
Updated Help for the FAYT changes. (v2)

Review of attachment 540300 [details] [diff] [review]:
-----------------------------------------------------------------

OK, bear with me; it looks like more than there is to it. ;-)
r- again for the moment since this needs a new patch.

As I said, we should document the wrap behavior. I suggest putting that directly after the ordered list. Draft:

"<p>If the search hits to bottom (or top) of the page, it will continue from the other end and indicate on the Find bar that it wrapped.</p>"

::: suite/locales/en-US/chrome/common/help/nav_help.xhtml
@@ +586,2 @@
>    <li>Type the text you want to find.</li>
> +  <li>Click Next to begin the search from the cursor is forwards

Either "from where the cursor is" (like before) or "from the cursor".

@@ +587,5 @@
> +  <li>Click Next to begin the search from the cursor is forwards
> +    to the bottom of the page.</li>
> +  <li>Click Previous to begin the search from the cursor backwards to 
> +    the top of the page.</li>
> +  <li>With <strong>Highlight all</strong>, all the matched word or

"all the matched word" doesn't sound right to me. Maybe "all words or phrases that matched"?

@@ +589,5 @@
> +  <li>Click Previous to begin the search from the cursor backwards to 
> +    the top of the page.</li>
> +  <li>With <strong>Highlight all</strong>, all the matched word or
> +    phrases are highlighted on the page.</li>
> +  <li>You can use <strong>Match case</strong> to search for a word or

Simply write "Use" instead of "You can use" here, and consider using "to limit the search to" instead of "to search for".

@@ +590,5 @@
> +    the top of the page.</li>
> +  <li>With <strong>Highlight all</strong>, all the matched word or
> +    phrases are highlighted on the page.</li>
> +  <li>You can use <strong>Match case</strong> to search for a word or
> +    phrase that matches the word or phrase you typed exactly (including

Two times "word or phrase" in a row looks and sounds strange. Let's go with "words or phrases that exactly match what you typed" or similar. Also, I'd prefer something like "(taking case into account)" over "(including upper and lowercase letters)".

@@ +596,5 @@
>  </ol>
>  
> +<p>To find the same word or phrase again, keep pressing Enter while the
> +  focus is on the search field, or use the Find Again shortcuts (see
> +  the <q>Using Find-as-you-type</q> section below when the focus

Missing closing bracket after "below".

@@ +597,5 @@
>  
> +<p>To find the same word or phrase again, keep pressing Enter while the
> +  focus is on the search field, or use the Find Again shortcuts (see
> +  the <q>Using Find-as-you-type</q> section below when the focus
> +  is on the page.  In both cases, a forward search will be invoked,

Double space.

@@ +598,5 @@
> +<p>To find the same word or phrase again, keep pressing Enter while the
> +  focus is on the search field, or use the Find Again shortcuts (see
> +  the <q>Using Find-as-you-type</q> section below when the focus
> +  is on the page.  In both cases, a forward search will be invoked,
> +  no matter whether the Previous button was pressed the last time.</p>

I'd prefer "used" over "pressed" here.

@@ +626,5 @@
>    <li>To search for all text (normal text and linked text), type <kbd>/</kbd>
>      before your search string. For example, type <q><kbd>/hello</kbd></q> to
>      search any text containing the string <q>hello</q>.</li>
>    <li>The status bar (at the bottom of your browser window) displays your
> +    search string and whether or not the search is successful.  Please note

"was successful"; double space.

@@ +628,5 @@
>      search any text containing the string <q>hello</q>.</li>
>    <li>The status bar (at the bottom of your browser window) displays your
> +    search string and whether or not the search is successful.  Please note
> +    that this happens only if the <q>Show the find toolbar during find as you
> +    type</q> checkbox in <q>Preferences/Advanced/Find As You Type</q> is not 

I think we should refer to this as "on the Find As You Type preferences panel" here (without the <q>) and make "Find ... panel" a link to the corresponding Help section.

@@ +629,5 @@
>    <li>The status bar (at the bottom of your browser window) displays your
> +    search string and whether or not the search is successful.  Please note
> +    that this happens only if the <q>Show the find toolbar during find as you
> +    type</q> checkbox in <q>Preferences/Advanced/Find As You Type</q> is not 
> +    selected.  If the checkbox is selected, then the <q>Find bar</q> is used

Double space.

@@ +630,5 @@
> +    search string and whether or not the search is successful.  Please note
> +    that this happens only if the <q>Show the find toolbar during find as you
> +    type</q> checkbox in <q>Preferences/Advanced/Find As You Type</q> is not 
> +    selected.  If the checkbox is selected, then the <q>Find bar</q> is used
> +    insted of changing the status bar text.</li>

"instead", and I think "text" is superfluous here.
Attachment #540300 - Flags: review?(jh) → review-
Attachment #540300 - Attachment is obsolete: true
Attachment #541043 - Flags: review?(jh)
Comment on attachment 541043 [details] [diff] [review]
Updated Help for the FAYT changes. (v3)

Review of attachment 541043 [details] [diff] [review]:
-----------------------------------------------------------------

r=me with the last set of review comments addressed. Thanks! :-)

::: suite/locales/en-US/chrome/common/help/nav_help.xhtml
@@ +586,4 @@
>    <li>Type the text you want to find.</li>
> +  <li>Click Next to begin the search from where the cursor is forwards
> +    to the bottom of the page.</li>
> +  <li>Click Previous to begin the search from the cursor backwards to 

space at end of line

@@ +587,5 @@
> +  <li>Click Next to begin the search from where the cursor is forwards
> +    to the bottom of the page.</li>
> +  <li>Click Previous to begin the search from the cursor backwards to 
> +    the top of the page.</li>
> +  <li>With <strong>Highlight all</strong>, all words or phrases are 

space at end of line

@@ +588,5 @@
> +    to the bottom of the page.</li>
> +  <li>Click Previous to begin the search from the cursor backwards to 
> +    the top of the page.</li>
> +  <li>With <strong>Highlight all</strong>, all words or phrases are 
> +   that matched are highlighted on the page.</li>

"all words or phrases that matched" (remove the first "are")

@@ +590,5 @@
> +    the top of the page.</li>
> +  <li>With <strong>Highlight all</strong>, all words or phrases are 
> +   that matched are highlighted on the page.</li>
> +  <li>Use <strong>Match case</strong> to limit the search to words or
> +    phrases that exactly matches what you typed (taking case into 

"that exactly match" ("words or phrases" is plural); space at end of line

@@ +596,4 @@
>  </ol>
>  
> +<p>If the search hits the bottom (or top) of the page, it will continue
> +from the other end and indicate on the Find bar that it wrapped.</p>

need to indent the second line

@@ +630,5 @@
>      search any text containing the string <q>hello</q>.</li>
>    <li>The status bar (at the bottom of your browser window) displays your
> +    search string and whether or not the search was successful. Please note
> +    that this happens only if the <q>Show the find toolbar during find as you
> +    type</q> checkbox in <a href="#using_find_as_you_type">Find As You Type preferences panel</a> is not selected.

"on the" instead of "in"; missing line break after "Type" (with the change probably after "You")
Attachment #541043 - Flags: review?(jh) → review+
Attachment #541043 - Attachment is obsolete: true
Attachment #541667 - Flags: review?(jh)
Attachment #541667 - Flags: review?(jh) → review+
Keywords: checkin-needed
Comment on attachment 541667 [details] [diff] [review]
Updated Help for the FAYT changes. (v4) [Checkin: comments 9 and 10]

http://hg.mozilla.org/comm-central/rev/be997f247a37

You may wish to have this landed on Aurora, too. For Beta it might be too late.
Attachment #541667 - Attachment description: Updated Help for the FAYT changes. (v4) → Updated Help for the FAYT changes. (v4) [Checkin: comment 9]
Status: ASSIGNED → RESOLVED
Closed: 12 years ago
Keywords: checkin-needed
Resolution: --- → FIXED
Target Milestone: --- → seamonkey2.4
Attachment #541667 - Flags: approval-comm-aurora?
Attachment #541667 - Flags: approval-comm-aurora? → approval-comm-aurora+
Comment on attachment 541667 [details] [diff] [review]
Updated Help for the FAYT changes. (v4) [Checkin: comments 9 and 10]

http://hg.mozilla.org/releases/comm-aurora/rev/406211d8a2dd
Attachment #541667 - Attachment description: Updated Help for the FAYT changes. (v4) [Checkin: comment 9] → Updated Help for the FAYT changes. (v4) [Checkin: comments 9 and 10]
Target Milestone: seamonkey2.4 → seamonkey2.3
Target Milestone: seamonkey2.3 → seamonkey2.4
You need to log in before you can comment on or make changes to this bug.