519332 - Update help for new download manager preferences

Status: RESOLVED FIXED

(SeaMonkey :: Help Documentation, defect)

Description

[Benoît]

Now that bug#487675 has been fixed, Help should be updated with an explanation of the preference and its possible values.

Comment 1

[rsx11m]

Looking at the Help content for the Download preferences, this looks rather outdated in other aspects as well. The "When saving a file" descriptions does not reflect the changes made in bug 490464, and it still contains the "When a download completes" section which is disabled until bug 490467 is done.

Are there bugs pending for either of those Help updates already? If not, it might be the easiest to extend the scope of this bug to cover those changes in a single patch.

Comment 2

[rsx11m]

Unless Benoît wants to take this himself, I can get a patch done later today.

Comment 3

[Ian Neal]

(In reply to comment #2)
> Unless Benoît wants to take this himself, I can get a patch done later today.

I'm fine with that, I would have done it myself but I've no time really this evening for coding.

Comment 4

[rsx11m]

Attachment: Proposed patch

This patch updates basically all groups in the "Download" preferences:

 - When starting a download: I've added a description of the new checkbox
   to "flash" the DM when it's already open and to put focus on it. The
   following description of the radiobuttons was shortened respectively.
   Note that I didn't introduce a second "otherwise:" list item nor indented
   the three radiobutton options, this looks a bit odd as they have quite a
   bit of text each.

 - When saving a file: This was substantially simplified after bug 490464 has
   landed, leaving just two choices of the former (confusing) set of options.

 - Download retention: The labels introduced in bug 487675 are not very
   descriptive, thus I added some more text into an introductory paragraph.
   Though it should be obvious that the downloaded files themselves are not
   removed by either option, only their reference in the DM listing, I've
   added a respective clause to make that unambiguous.

 - When a download completes: Assuming bug 490467 not introducing a sound
   feedback in time for SM 2.0, I've commented that out in analogy to the
   respective XUL code. It can be reinserted later, once that option is
   available again (hence the dependency).

Comment 5

[Ian Neal]

Comment on attachment 403516 [details] [diff] [review]
Proposed patch

> <ul>
>+  <li><strong>Download retention</strong>:
>+    <ul>
>+      <li><strong>Remove downloads</strong> determines when a completed task
>+        is removed from the Download Manager listing (this will <em>not</em>
>+        affect the downloaded file):
>+        <ul>
>+          <li><strong>When they have completed</strong> removes the entry
>+            immediately once the download was successfully completed.</li>
>+          <li><strong>When quitting &brandShortName;</strong> retains all
>+            entries until closing the program, the list will be empty upon
>+            restarting &brandShortName;.</li>
>+          <li><strong>Never</strong> does not remove <em>any</em> entry
>+            automatically, even after &brandShortName; was restarted.
>+            You can removed them manually in the Download Manager.</li>
>+        </ul>
>+      </li>
>+    </ul>
>+  </li>
> </ul>
The format should be "<strong>option description</strong>: This....", so the first one would be something like:
<li><strong>Remove downloads</strong>: This determines when a completed task is removed...
Though I'm not too happy with the word "task", perhaps "entry" or "download entry".

Only r- as I want to review the revised patch.

Comment 6

[rsx11m]

Attachment: Proposed patch (v2)

The new patch adjusts the style for the download retention settings to match
those of the other preference groups. I've picked "entry" to replace "task" as there are already quite a few "download" around. Also rephrased "(this will <em>not</em>..." to avoid an accumulation of too many "this" now.

Everything else is unchanged.

Comment 7

[Ian Neal]

Comment on attachment 403620 [details] [diff] [review]
Proposed patch (v2)

>+  <li><strong>Download retention</strong>:
>+    <ul>
>+      <li><strong>Remove downloads</strong>: This determines when a completed
>+        entry is removed from the Download Manager listing (the downloaded
>+        file will <em>not</em> be affected):
>+        <ul>
>+          <li><strong>When they have completed</strong>: Select this to
>+            remove an entry immediately once the download was successfully
"is" instead of "was"
>+            completed.</li>
>+          <li><strong>When quitting &brandShortName;</strong>: Select this
>+            to retain all entries until closing the program, the list will
>+            be empty upon restarting &brandShortName;.</li>
>+          <li><strong>Never</strong>: Select this to not remove <em>any</em>
>+            entry automatically, even after &brandShortName; was restarted.
"is" instead of "was"
>+            You can remove them manually in the Download Manager.</li>
>+        </ul>
>+      </li>
>+    </ul>
>+  </li>

Comment 8

[rsx11m]

Attachment: Proposed patch (v3) [Checkin: Comment 9]

> (comment #7) "is" instead of "was"
Corrected, both instances.

Help content update only, no risk.

Comment 9

[Ian Neal]

Comment on attachment 403637 [details] [diff] [review]
Proposed patch (v3) [Checkin: Comment 9]

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

Comment 10

[rsx11m]

Thanks.