Home » Eclipse Projects » Platform - User Assistance (UA) » Minimal required components for SA Help
| Minimal required components for SA Help [message #472531] |
Thu, 17 April 2008 11:21  |
Eclipse User |
|
|
|
Hi -
I'm in the process of sorting out the best way to deliver Stand Alone help
for a non-Eclipse application. The content and documentation plug-ins are
being developed using DITA and the DOTA OTK.
I have a few implementation questions, if anyone's willing.
One of the requirements we have is to keep the footprint as small as
possible. Is there a definitive list of the bare minimum required plug-ins
to allow Eclipse UA to run as a stand alone system?
I'm also wondering if there's conventional wisdom on whether it's
preferable to use the platform runtime binary or RCP binary.
Finally, does anyone have recommendations on packaging the help system
(plug ins and binarys) for distribution?
Thanks!
Rob Kimm
Medtronic
|
|
|
| Re: Minimal required components for SA Help [message #473585 is a reply to message #472531] |
Wed, 23 April 2008 12:40  |
| Eclipse User |
|
|
|
Originally posted by: nospam_kowalskilee.gmail.com
Hi Rob,
What version level of Eclipse are you planning on using?
Your response will go to determining the list of the bare minimum
required plug-ins for a stand alone system. For example, the list for
Eclipse 3.4 is slightly different than the list for version 3.3, etc.
Be aware that the Eclipse help system will need a JRE to run, because it
is a Java-based app. While you can tell your users that a JRE is a
pre-requisite, some teams choose to include the JRE to make it easier
for their users and the JRE itself will increase the footprint. Of
course, if your non-Eclipse application already requires a JRE, then it
is not a special requirement for the help system per se.
My personal preference is to use the Platform binary instead of the RCP
binary, because I believe that gives me more control: I start with a
superset of everything I'd need and pare it down to the minimum. In the
past, when I started with the RCP binary, I'd have to add in jars from
the Platform binary anyway to get to the minimum needed for stand alone
help. If I was going to need something from the Platform binary anyway,
I figure to just start with that.
However, new with Eclipse 3.4, there is a Help Feature that you can add
to the RCP binary to give you what's needed to have an RCP application
plus online help. I haven't tested for whether doing it that way (RCP
binary + Help Feature) gives you more than the minimum for stand alone
help. (That is, if it brings along a bunch of stuff needed for an RCP
app that isn't needed for stand alone help).
Best regards,
Lee Anne
Rob Kimm wrote:
> Hi -
> I'm in the process of sorting out the best way to deliver Stand Alone
> help for a non-Eclipse application. The content and documentation
> plug-ins are being developed using DITA and the DOTA OTK.
> I have a few implementation questions, if anyone's willing.
>
> One of the requirements we have is to keep the footprint as small as
> possible. Is there a definitive list of the bare minimum required
> plug-ins to allow Eclipse UA to run as a stand alone system?
> I'm also wondering if there's conventional wisdom on whether it's
> preferable to use the platform runtime binary or RCP binary.
>
> Finally, does anyone have recommendations on packaging the help system
> (plug ins and binarys) for distribution?
> Thanks!
> Rob Kimm
> Medtronic
|
|
| | |
| Re: Minimal required components for SA Help [message #473747 is a reply to message #473746] |
Wed, 14 May 2008 10:21 |
| Eclipse User |
|
|
|
Originally posted by: nospam_kowalskilee.gmail.com
Pierre Candela wrote:
> Lee Anne wrote:
>
>> What version level of Eclipse are you planning on using?
>> Your response will go to determining the list of the bare minimum
>> required plug-ins for a stand alone system. For example, the list for
>> Eclipse 3.4 is slightly different than the list for version 3.3, etc.
>
> Hi Lee Anne,
> in what way is the list different between 3.3 and 3.4?
> The list we came up with for Eclipse 3.3 in Bug #197510 is still valid
> for Eclipse 3.4 M6:
> https://bugs.eclipse.org/bugs/show_bug.cgi?id=197510
>
> I haven't had the time to verify it against M7, though.
>
> Regards,
> Pierre
Hi Pierre,
Thanks for pointing this out. I see that I misspoke ("mistyped") when I
posted that the list for Eclipse 3.4 is slightly different. When I
responded to Rob's post, while I was thinking of that same Bugzilla
entry, I mistakenly assumed that we had been talking about 3.4 at that
time also. I have had 3.4 on the brain in the intervening months. :-)
Best regards,
Lee Anne
|
|
| | |
| Re: Minimal required components for SA Help [message #612018 is a reply to message #472531] |
Wed, 23 April 2008 12:40 |
| Eclipse User |
|
|
|
Originally posted by: nospam_kowalskilee.gmail.com
Hi Rob,
What version level of Eclipse are you planning on using?
Your response will go to determining the list of the bare minimum
required plug-ins for a stand alone system. For example, the list for
Eclipse 3.4 is slightly different than the list for version 3.3, etc.
Be aware that the Eclipse help system will need a JRE to run, because it
is a Java-based app. While you can tell your users that a JRE is a
pre-requisite, some teams choose to include the JRE to make it easier
for their users and the JRE itself will increase the footprint. Of
course, if your non-Eclipse application already requires a JRE, then it
is not a special requirement for the help system per se.
My personal preference is to use the Platform binary instead of the RCP
binary, because I believe that gives me more control: I start with a
superset of everything I'd need and pare it down to the minimum. In the
past, when I started with the RCP binary, I'd have to add in jars from
the Platform binary anyway to get to the minimum needed for stand alone
help. If I was going to need something from the Platform binary anyway,
I figure to just start with that.
However, new with Eclipse 3.4, there is a Help Feature that you can add
to the RCP binary to give you what's needed to have an RCP application
plus online help. I haven't tested for whether doing it that way (RCP
binary + Help Feature) gives you more than the minimum for stand alone
help. (That is, if it brings along a bunch of stuff needed for an RCP
app that isn't needed for stand alone help).
Best regards,
Lee Anne
Rob Kimm wrote:
> Hi -
> I'm in the process of sorting out the best way to deliver Stand Alone
> help for a non-Eclipse application. The content and documentation
> plug-ins are being developed using DITA and the DOTA OTK.
> I have a few implementation questions, if anyone's willing.
>
> One of the requirements we have is to keep the footprint as small as
> possible. Is there a definitive list of the bare minimum required
> plug-ins to allow Eclipse UA to run as a stand alone system?
> I'm also wondering if there's conventional wisdom on whether it's
> preferable to use the platform runtime binary or RCP binary.
>
> Finally, does anyone have recommendations on packaging the help system
> (plug ins and binarys) for distribution?
> Thanks!
> Rob Kimm
> Medtronic
|
|
| | |
| Re: Minimal required components for SA Help [message #614220 is a reply to message #473746] |
Wed, 14 May 2008 10:21 |
| Eclipse User |
|
|
|
Originally posted by: nospam_kowalskilee.gmail.com
Pierre Candela wrote:
> Lee Anne wrote:
>
>> What version level of Eclipse are you planning on using?
>> Your response will go to determining the list of the bare minimum
>> required plug-ins for a stand alone system. For example, the list for
>> Eclipse 3.4 is slightly different than the list for version 3.3, etc.
>
> Hi Lee Anne,
> in what way is the list different between 3.3 and 3.4?
> The list we came up with for Eclipse 3.3 in Bug #197510 is still valid
> for Eclipse 3.4 M6:
> https://bugs.eclipse.org/bugs/show_bug.cgi?id=197510
>
> I haven't had the time to verify it against M7, though.
>
> Regards,
> Pierre
Hi Pierre,
Thanks for pointing this out. I see that I misspoke ("mistyped") when I
posted that the list for Eclipse 3.4 is slightly different. When I
responded to Rob's post, while I was thinking of that same Bugzilla
entry, I mistakenly assumed that we had been talking about 3.4 at that
time also. I have had 3.4 on the brain in the intervening months. :-)
Best regards,
Lee Anne
|
|
| |
| Re: Minimal required components for SA Help [message #623816 is a reply to message #504914] |
Wed, 23 December 2009 15:36 |
| Eclipse User |
|
|
|
I can't help noticing that almost the exact same message regarding a commercial product has been posted as a reply to five different threads. I don't think that it is appropriate to be spamming the forum by posting the same content on multiple threads and I don't want to set a precedent by letting this pass without comment.
Please cooperate in keeping the signal to noise ratio high. It would be a shame if we had to moderate incoming messages before they appeared.
|
|
|
Goto Forum:
Current Time: Fri May 16 08:13:04 EDT 2025
Powered by FUDForum. Page generated in 0.15491 seconds |
Home