308933 - Docs for download manager say `show' it is `open'

Status: RESOLVED FIXED

(Firefox Graveyard :: Help Documentation, defect)

Description

[Hendrik Maryns]

In download_manager.xhtml, it says: 
<dt>Show File Location</dt>
  <dd>When a download has finished, the <strong>Show</strong> link will appear
by the
    file entry.  Use it to open the folder where &brandShortName; saved the
file.</dd>

This should be something like 
<dt>Open the File</dt>
  <dd>When a download has finished, the <strong>Open</strong> link will appear
by the file
    entry. Use it to open the file.</dd>

Comment 1

[Hendrik Maryns]

Attachment: makes the proposed change, fixes some other minor lay-out oddities as well

I've been so free as to add myself to the contributors, feel free to remove my
name again :-(

Anyway, makes the proposed change, also adds en <em> tag, removes a superfluous
</br> and some newlines.

Comment 2

[Steffen Wilberg]

Comment on attachment 196415 [details] [diff] [review]
makes the proposed change, fixes some other minor lay-out oddities as well

Please drop the unrelated changes. We're trying to reduce the work of the
localization teams. We can make other changes in the trunk after 1.5 has been
released.

>Index: chrome/help/download_manager.xhtml
>+  Hendrik Maryns <[e-mail]>
You should probably add "(replaced one word, and removed a couple of other
words)". ;-)

All we need is this part:
>-  <dt>Show File Location</dt>
>-  <dd>When a download has finished, the <strong>Show</strong> link will appear by the
>-    file entry.  Use it to open the folder where &brandShortName; saved the file.</dd>
>+  <dt>Open the File</dt>
>+  <dd>When a download has finished, the <strong>Open</strong> link will appear by the file
>+    entry. Use it to open the file.</dd>

Comment 3

[Hendrik Maryns]

Attachment: removed my `additional changes'

Ok then.

Though I think the other changes would be useful as well.  I don't really see
what the problem would be to only remove empty lines.  Don't the localised
repositories get updated automatically for that kind of stuff?	I thought
additional lines were added automatically?

<rant> It's a real pain in the ass to have to open a new bug for every minor
omitted <em> tag one notices: thinking of a good description, choosing the
right component...  I'd rather prefer some general bug titled `minor
optimalisations in the help docs' or `optimising the locales' or something like
that, where one could submit patches and some authority looks at them and
decides whether they should be applied or no.  Also, that way discussion with
others would be possible in the bug. </rant>

As for adding my name: I can't help it, I'm vain :-p

Comment 4

[Steffen Wilberg]

Comment on attachment 198229 [details] [diff] [review]
removed my `additional changes'

Thanks, r=me.

Comment 5

[Steffen Wilberg]

Localization of help docs is entirely manual. Localizers need to look at every
single change and update their localized docs by hand.

I'm not against general cleanup bugs, but that should happen after Firefox 1.5
has been released, because we try to keep branch and trunk docs in sync to make
our life easier.

Comment 6

[Hendrik Maryns]

(In reply to comment #5)
> Localization of help docs is entirely manual. Localizers need to look at every
> single change and update their localized docs by hand.
> 
> I'm not against general cleanup bugs, but that should happen after Firefox 1.5
> has been released, because we try to keep branch and trunk docs in sync to make
> our life easier.

Thanks, I'll save them up for later then.

Btw, I have no cvs acces, so please somebody else check this in (how does this
work usually?)

Comment 7

[Scott MacGregor]

Comment on attachment 198229 [details] [diff] [review]
removed my `additional changes'

approving help documentation change.

please check in asap though or this approval may go away.

Comment 8

[Steffen Wilberg]

See http://www.mozilla.org/hacking/getting-cvs-write-access.html

Checking in mozilla/browser/locales/en-US/chrome/help/download_manager.xhtml;
/cvsroot/mozilla/browser/locales/en-US/chrome/help/download_manager.xhtml,v  <--
 download_manager.xhtml
new revision: 1.17.4.1; previous revision: 1.17
done

Checking in mozilla/browser/locales/en-US/chrome/help/download_manager.xhtml;
/cvsroot/mozilla/browser/locales/en-US/chrome/help/download_manager.xhtml,v  <--
 download_manager.xhtml
new revision: 1.18; previous revision: 1.17
done

Comment 9

[Ronny Perinke]

What about the 'Show File Location' entry in the context menu when you do a
right click on the file entry after it's download is finished?

Now, with this bugfix it's not documentent anymore. It should be something like
this:

<dt>Show File Location</dt>
  <dd>When a download has finished, <span class="noMac">right-click</span><span
class="mac">press &ctrlKey; and click</span> on the file entry and select <span
class="menuPath">Show File Location</span>. Use it to open the folder where
&brandShortName; saved the file.</dd>

Comment 10

[Hendrik Maryns]

(In reply to comment #9)
> What about the 'Show File Location' entry in the context menu when you do a
> right click on the file entry after it's download is finished?

Indeed, but I don't know whether it should be mentioned at all.  The main
purpose of the document is to describe the visible features, if one were to
document each possible context menu, it would be a lot of work.  And the entry
says enough for itself, I think.  Maybe something like `You can right-click
(Cmdkey and click) on a file to get more options' (as there is also another
entry Properties which isn't documented yet.

Comment 11

[Steffen Wilberg]

We haven't yet documented the "All files downloaded to:" button though. I guess
we should do that since the button is hard to discover since it doesn't look
like a button. I just filed bug 310907 about that.