1178164 - customize_help.xhtml: Mention "Firefox & Thunderbird Add-on Converter for SeaMonkey"

Status: RESOLVED FIXED

(SeaMonkey :: Help Documentation, defect)

Description

[Rainer Bielefeld]

Until we will have the fix for "Bug 1145026 - AMO Add-On-Descriptions: Add link function leading to SeaMonkey add-on-converter and filling URL input pane" the possibility of converting add-ons for SeaMonkey should be mentioned in Help. On <http://addonconverter.fotokraina.com/> there is a short description how to use the converter, so I think in SM help it is sufficient to mention that the converter does exist.

Suggested Location in Help: Installing Add-ons > Notes

Suggested Text:

Firefox & Thunderbird Add-on Converter for SeaMonkey
----------------------------------------------------
Many add-ons what have been created for Thunderbird and Firefox also can be used with SeaMonkey after a conversion by the converter <http://addonconverter.fotokraina.com/> before qou install the add-on. You find compatibility hints at mozillaZINE <http://forums.mozillazine.org/viewtopic.php?f=40&t=2834855> and in the SeaMonkey wiki <https://wiki.mozilla.org/SeaMonkey/AddonCompat#Converted_Version_Compatible>.

Comment 1

[rsx11m]

Well, modifying the Help text isn't a "short" solution, especially if it contains links to external sites which may change over time (and I'm certain you will find some dead links in the Help content somewhere which have disappeared or been moved since that text was written).

I'd prefer the suggestion quoted in bug 1145026 comment #31 to use the carousel in the "Get Add-ons" page of the Add-ons Manager, which /should/ be easier to maintain on a short term if links or content change, provided that we get access to that carousel content. Once that is done, a generic text can be added to this Help section, mentioning that add-ons may become compatible with SeaMonkey after applying a converter as offered in the discovery pane.

Comment 2

[Rainer Bielefeld]

(In reply to rsx11m from comment #1)
Of course we should avoid unnecessary work. But I do not believe that there will be a quick solution for Bug 1145026 or "Bug 1151227 - Add-on Manager discovery pane: add Banner with link to Add-on-converter"

Comment 3

[Rainer Bielefeld]

No doubt, this one is a valid RFE

Comment 4

[Rainer Bielefeld]

This one blocks "Bug 1268037 (meta) Help cleanup 2016"

Comment 5

[Rainer Bielefeld]

I'll create the help text

Comment 6

[Rainer Bielefeld]

Attachment: customize_help_AOC002.xhtml

The attached edited version of "customize_help.xhtml" contains a text suggestion under heading "Using the Add-on-Converter" and a completed table of contents below heading "Add-ons".

That document has been edited using SeaMonkey HTML Editor, it might contain horrible bad xhtml, it's only a contents suggestion, not a patch

Comment 7

[Rainer Bielefeld]

Someone Else will have to make a patch from this suggestion.
This one needs localization and also help index should be adapted

Comment 8

[Rainer Bielefeld]

@Isaac:
can you help?

Comment 9

[Isaac Schemm]

How about this? Works in [brackets] would be links.

"The [Add-on Converter] has been created to convert Firefox and Thunderbird extensions for use in SeaMonkey. You can try to convert any extension by uploading it from your computer or by pasting the download URL from [addons.mozilla.org] (AMO) into the appropriate input line on the Add-on Converter start page. Experts can adjust options in the Advanced Options area.

Not all Firefox and Thunderbird extensions will work in SeaMonkey. Most extensions will install successfully, but some may not work properly once installed. The [compatibility list] will help you to anticipate how well a converted extension will work.

The easiest way to use the Add-on Converter is to install the [AMO Browsing for SeaMonkey] extension, which will overlay additional information and links onto the Add-on pages at addons.mozilla.org. If the Add-on is not already compatibile with SeaMonkey, a link will be added to the Add-on Converter, which will select appropriate conversion parameters automatically."

If that works, I can create a patch.

Comment 10

[Rainer Bielefeld]

(In reply to Isaac Schemm from comment #9)
I agree, the chance that users will really use the Browsing Add-On and the Converter might be better with some more detailed description in Help. For me your text looks fine.

Comment 11

[Rainer Bielefeld]

(In reply to Isaac Schemm from comment #9)

I missed a typo:
wrong:   compatibile   
correct: compatible

Comment 12

[Isaac Schemm]

Attachment: addon-converter-help.patch

Here's a patch to add my above text to Help (typo fix included.)

Comment 13

[Ian Neal]

Comment on attachment 8771800 [details] [diff] [review]
addon-converter-help.patch

>+++ b/suite/locales/en-US/chrome/common/help/customize_help.xhtml

>+<p>The <a href="http://addonconverter.fotokraina.com/">Add-on Converter</a>
>+  has been created to convert Firefox and Thunderbird extensions for use in
>+  &brandShortName;. You can try to convert any extension by uploading it from
>+  your computer or by pasting the download URL from
>+  <a href="https://addons.mozilla.org">addons.mozilla.org</a> (AMO) into the
>+  appropriate input line on the Add-on Converter start page. Experts can
>+  adjust options in the Advanced Options area.</p>
For the last sentence, it could be read as someone other than the user, so maybe something like "If you are an expert user you can make adjustments in the Advanced Options area."
>+
>+<p>Not all Firefox and Thunderbird extensions will work in &brandShortName;.
>+Most extensions will install successfully, but some may not work properly once
>+installed. The <a href="http://addonconverter.fotokraina.com/compatibility/">
Nit: indentation incorrect for the two lines above.
>+  compatibility list</a> will help you to anticipate how well a converted
>+  extension will work.</p>

r=me with those addressed.

Comment 14

[Isaac Schemm]

Attachment: 1178164-addon-converter-help-v2.patch

Comment 15

[Ian Neal]

Comment on attachment 8775147 [details] [diff] [review]
1178164-addon-converter-help-v2.patch

r/a=me

Comment 16

[rsx11m]

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