Closed Bug 472840 Opened 15 years ago Closed 15 years ago

Update history and location bar pref panel help for places prefs

Categories

(SeaMonkey :: Help Documentation, defect)

defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED
seamonkey2.0b1

People

(Reporter: kairo, Assigned: InvisibleSmiley)

References

Details

Attachments

(1 file, 2 obsolete files)

Bug 468326 updates the history and location bar pref panels for places, help needs updates for that as well.
Depends on: 473731
Depends on: 473734
No longer depends on: 473731
Attached patch proposed patch (obsolete) — Splinter Review
AFAIK stefanh is quite busy currently. KaiRo, since you made the changes that lead to this bug, can you please check for formal correctness (for instance I'm not sure I got "match word boundaries" right, I understood it means the beginning of words)?
Assignee: nobody → jh
Status: NEW → ASSIGNED
Attachment #378832 - Flags: review?(kairo)
Comment on attachment 378832 [details] [diff] [review]
proposed patch

>-<p>The History preferences panel allows you to configure three history settings
>+<p>The History preferences panel allows you to configure the history settings

ROTFL... Thanks for catching that error!

>+      <li><strong>Always remember visited pages for at least [__]
>+        days</strong>: Type the minimum number of days for which
>+        &brandShortName; should remember pages you have previously visited.
>+        Unless you manually delete entries from the history or the maximum
>+        number of visited pages (see below) has been reached, &brandShortName;
>+        will always remember visited pages for at least as many days as you
>+        specify here.</li>

That's wrong. "Always" means always here. We keep entries for that period, _even_ if that means storing over the number of entries specified below.
We only look at visits that are older than the specified minimum date and from those, delete those that are older than the cutoff in age of number of pages specified below.

The description for the other two settings is correct.

>+              <li><strong>Anywhere but preferring word boundaries</strong>: The
>+                autocomplete suggestions will include all websites where what
>+                you typed matches any part of the website&apos;s location or
>+                title but matches at word boundaries are preferred. This is the
>+                default setting.</li>
>+              <li><strong>Only on word boundaries</strong>: The autocomplete
>+                suggestions will include all websites where what you typed
>+                matches the beginning of any word contained in the
>+                website&apos;s location or title.</li>

I think you should explain the term "word boundary" in the first one as well.

sdwilsh, I hear you know that code, does "word boundary" mean matching only the start of a word or also its end?


r- for the wrong explanation of the minimum date. Please match the "word boundary" description to what sdwilsh tells us, and please have some native speaker (IanN?) check the text.
Attachment #378832 - Flags: review?(sdwilsh)
Attachment #378832 - Flags: review?(kairo)
Attachment #378832 - Flags: review-
Comment on attachment 378832 [details] [diff] [review]
proposed patch

(In reply to comment #4)
> sdwilsh, I hear you know that code, does "word boundary" mean matching only the
> start of a word or also its end?
It's more complicated than that.  The behavior is dictated by IsWordBoundary in nsNavHistoryAutoComplete.cpp:
http://mxr.mozilla.org/mozilla-central/source/toolkit/components/places/src/nsNavHistoryAutoComplete.cpp#250

There's a pretty good comment there, so I'll let you folks read it and come up with a more human-readable version.
Attachment #378832 - Flags: review?(sdwilsh)
Attached patch patch v2 (obsolete) — Splinter Review
(In reply to comment #4)
> That's wrong. "Always" means always here.

Thanks for the clarification, fixed.

> >+              <li><strong>Anywhere but preferring word boundaries</strong>: The
> >+                autocomplete suggestions will include all websites where what
> >+                you typed matches any part of the website&apos;s location or
> >+                title but matches at word boundaries are preferred. This is the
> >+                default setting.</li>
> >+              <li><strong>Only on word boundaries</strong>: The autocomplete
> >+                suggestions will include all websites where what you typed
> >+                matches the beginning of any word contained in the
> >+                website&apos;s location or title.</li>
> 
> I think you should explain the term "word boundary" in the first one as well.

I think we shouldn't repeat ourselves. Added a note pointing at the next point.

(In reply to comment #5)
> (From update of attachment 378832 [details] [diff] [review])
> (In reply to comment #4)
> > sdwilsh, I hear you know that code, does "word boundary" mean matching only the
> > start of a word or also its end?
> It's more complicated than that.

OK, I tried to express it in such a way that the user understands it, first explaining the typical exception (CamelCase) and then what word boundaries are. The latter is probably not 100% correct if you look at the code but the average user hardly wants to know about the specifics of Unicode character comparison.
Attachment #378832 - Attachment is obsolete: true
Attachment #379219 - Flags: review?(iann_bugzilla)
Comment on attachment 379219 [details] [diff] [review]
patch v2

>+      <li><strong>Clear History</strong>: Click this to delete the list of
>+        sites visited.</li>
>+      <li><strong>Always remember visited pages for at least [__]
>+        days</strong>: Type the minimum number of days for which
>+        &brandShortName; should remember pages you have previously visited.
>+        Unless you manually delete entries from the history, &brandShortName;
>+        will always remember visited pages for at least as many days as you
>+        specify here.</li>
I think you need to be even more explicit here that it overrides the settings below.

>+      <li><strong>Remember visited pages for up to [__] days</strong>: Type the
>+        maximum number of days you want &brandShortName; to keep track of the
>+        web pages you have previously visited. For example, if you set this
>+        number to 180 days, pages 180 days old or less will be kept in the
>+        history list unless you manually delete them from the history or the
>+        maximum number of visited pages (see next point) has been reached.</li>
>+      <li><strong>Remember up to [__] visited pages</strong>: Type the maximum
>+        number of visited pages &brandShortName; should remember. When the
>+        actual number of visited pages exceeds the number specified here,
>+        &brandShortName; will delete as many of the oldest history entries as
>+        needed to get down to that number again.</li>

Apart from that everything seems fine.
Attachment #379219 - Flags: review?(iann_bugzilla) → review-
Attachment #379219 - Attachment is obsolete: true
Attachment #383344 - Flags: review?(iann_bugzilla)
Attachment #383344 - Flags: review?(iann_bugzilla) → review+
Comment on attachment 383344 [details] [diff] [review]
patch v3
[Checkin: Comment 10]

Thanks for this r=me
Keywords: checkin-needed
Comment on attachment 383344 [details] [diff] [review]
patch v3
[Checkin: Comment 10]


http://hg.mozilla.org/comm-central/rev/c49f5cbc613f
Attachment #383344 - Attachment description: patch v3 → patch v3 [Checkin: Comment 10]
Status: ASSIGNED → RESOLVED
Closed: 15 years ago
Flags: in-testsuite-
Keywords: checkin-needed
Resolution: --- → FIXED
Target Milestone: --- → seamonkey2.0b1
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: