646788 - Add Help Topic for "Plugin Crashed" UI

Status: RESOLVED WONTFIX

(SeaMonkey :: Help Documentation, defect)

Description

[Philip Chee]

Bug 601493 added a link to in-application help
> openHelp("plugin-crashed", "chrome://communicator/locale/help/suitehelp.rdf");

We can steal some text from:
<http://support.mozilla.com/en-US/kb/Plugin crash reports?as=u>

Comment 1

[Stefan [:stefanh]]

Do we need built-in help when there's supposed to be a "Learn more" link to a web page (bug 646792)?

Comment 2

[Jens Hatlak (:InvisibleSmiley)]

(In reply to comment #1)
> Do we need built-in help when there's supposed to be a "Learn more" link to a
> web page (bug 646792)?

As Philip wrote in bug 601493 comment 39, Firefox actually goes to the SUMO page in both cases. I think we should be consistent, too, and not use two different destinations, but one.

Neil suggested in bug 646792 comment 1 to let Learn More also go to Help and possibly link from there.

Looking at the SUMO page, all is text except for two external links:
1. Mozilla Privacy Policy: http://www.mozilla.com/legal/privacy/firefox-en.html
2. Mozilla Plugin Check page: http://www.mozilla.com/plugincheck/

The contents on that page seem mostly static to me so there's no strong reason for using a web page (other than the fact that the caller will be a web page, too). On the contrary there's a good reason to use our built-in Help: l10n. Our web page is not localized (i.e. en-US only and only changeable by a very limited set of people), but Help is (or better: can be). So if your whole SeaMonkey is localized, including the plugin crashed UI, the web page would still be incomprehensible to you unless you understood English. In theory we could use some page external to www.seamonkey-project.org, but for the benefit of l10n someone would have to provide that, plus access control etc. This doesn't seem realistic to me in the short term, so I propose using Help + links.

Comment 3

[Ian Neal]

As Jens has said, I think it would be better use the built-in help.

Comment 4

[Philip Chee]

Jens, who would be a suitable mentor for this GFB?

Comment 5

[Jens Hatlak (:InvisibleSmiley)]

(In reply to Philip Chee from comment #4)
> Jens, who would be a suitable mentor for this GFB?

Well, it's a Help topic, so any Help reviewer should do (Ian, Stefan, me).

Comment 6

[vchinen]

Hello, I'm currently working on a project for my Software Engineer class. And I'm interested on working on this bug. Where can I start? Thank you!

Comment 7

[Philip Chee]

Hi vchinen!

Thank you for your offer. This bug is essentially adding some help text to our in-app help files which are written in xhtml. As suggested in comment 2 we can probably adapt the text at http://support.mozilla.org/en-US/kb/send-plugin-crash-reports-help-improve-firefox for our help file.

Our help files are found at:
http://mxr.mozilla.org/comm-central/source/suite/locales/en-US/chrome/common/help/

It also helps if you've set up a build environment on your computer and have successfully built SeaMonkey. Here is a useful link that will get you building SeaMonkey

https://developer.mozilla.org/en-US/docs/Simple_SeaMonkey_build

If you are working on a project for your Software Engineer class, this bug might be a bit too simple (no coding required here). Depending on the amount of time/effort you need for your project, you might want to look at other bugs.

In any case please join us on IRC so that we can discuss this further. We are on the Mozilla IRC server in the SeaMonkey channel (irc://moznet/seamonkey). On IRC you can start a private chat with me (RattyAway) if you want to discuss this with me privately, or just email me at my @gmail.com account.

Comment 8

[kunal bansal]

Since Vchinen is no longer working on this can i work on this as my startup bug?

Comment 9

[Philip Chee]

> Since Vchinen is no longer working on this can i work on this as my startup bug?
Hmm. We haven't heard back from Vchinen for a month. I'll assign this to you then.

Comment 10

[Stefan [:stefanh]]

(In reply to Philip Chee from comment #0)
> Bug 601493 added a link to in-application help
> > openHelp("plugin-crashed", "chrome://communicator/locale/help/suitehelp.rdf");
> 
> We can steal some text from:
> <http://support.mozilla.com/en-US/kb/Plugin crash reports?as=u>

Pleae note that, because of the license, we can't copy any text from sumo pages.

Comment 11

[Josh Matthews [:jdm]]

Kunal, can you confirm that you're still working on this?

Comment 12

[kunal bansal]

@stefan: So i need to workout an adapted version of the link
URL: http://support.mozilla.org/en-US/kb/Plugin%20crash%20reports?as=u

Comment 13

[Stefan [:stefanh]]

(In reply to kunal bansal from comment #12)
> @stefan: So i need to workout an adapted version of the link
> URL: http://support.mozilla.org/en-US/kb/Plugin%20crash%20reports?as=u

Yeah, see comment #10.

Comment 14

[kunal bansal]

Attachment: plugin_error file

This file is a help file for plugin crash reporting.
File must be run under comm-central/source/suite/locales/en-US/chrome/common/help/ for proper format.

Thank You

Comment 15

[Philip Chee]

Comment on attachment 751336 [details]
plugin_error file

Hi!

Thank you very much for working on this!

However, you need to submit it as a git type patch. Please read:
https://developer.mozilla.org/en-US/docs/Mercurial_FAQ#How_can_I_generate_a_patch_for_somebody_else_to_check-in_for_me.3F

The content of support.mozilla.org is licensed under Creative Commons Attribution Share-Alike (CC-SA) licenses. Whereas the help text in the SeaMonkey help module uses the MPLv2. Thus you can't simply copy and paste.

Also the file you attached still refers to "Firefox".

> ...restart the plugin.Besides...
Please use one space between sentences e.g.
...restart the plugin. Besides...

If you have any questions please join us on IRC:  irc://moznet/SeaMonkey  

Thanks.

Comment 16

[Stefan [:stefanh]]

Comment on attachment 751336 [details]
plugin_error file

What Philip said.

Comment 17

[Philip Chee]

Kunal has put up a Etherpad at https://etherpad.mozilla.org/kBX7YHIlvx in case anyone wants to make some editorial changes.

Comment 18

[Sylvestre Ledru [:Sylvestre]]

No assignee, updating the status.

Comment 19

[Sylvestre Ledru [:Sylvestre]]

No assignee, updating the status.

Comment 20

[Sylvestre Ledru [:Sylvestre]]

No assignee, updating the status.

Comment 21

[Sylvestre Ledru [:Sylvestre]]

No assignee, updating the status.

Comment 22

[Frank-Rainer Grahl (:frg)]

NPAPI plugins are no longer supported. and no others around.