| Branding the Help Index Page [message #449123] |
Wed, 10 May 2006 14:48  |
Eclipse User |
|
|
|
Hi all,
I got a simple RCP app working[1] and now I want to add documentation.
When I select the Help Contents action, the help browser appears correctly,
but the first page shown is "Using the Eclipse help system" and contains
eclipse graphics, etc. This conflicts with my branding, so I want to
replace it. I see that I can simply replace help_home.html in the help
plugin, but is there an alternative "clean" way to do this, perhaps via an
extension point? If so, howto? If not, is there a bug I can track for
this? Thanks for all the work at making getting started with RCP easy --
templates, tutorials, product configuration editor, etc!
[1] Eclipse 3.1.2
- Matt
|
|
|
|
| Re: Branding the Help Index Page [message #449610 is a reply to message #449438] |
Tue, 16 May 2006 12:08  |
| Eclipse User |
|
|
|
Roman,
Thanks. It is not clear how to set these properties so that they override
the defaults. I have tried several things and nothing seems to work. Can
you tell me specifically what files I need to modify to make this work? Are
there any examples of code that overrides this property?
- Matt
"Roman Mukhin" <ramses_ru@hotmail.com> wrote in message
news:e47416$57p$1@utils.eclipse.org...
> Hi Matt
>
> Your Answer is described at Eclipse Help:
> Platform Plug-in Developer Guide > Reference > Other reference information
> > Help System Preferences:
>
> You need to assign your home page with overriding property
> org.eclipse.help.base/help_home=/pluginId/path/to/home.html.
>
> There are more interesting propertied that could be overritten in order to
> brand your help system.
>
> best regards
> Ram
>
>
> Matt Munz wrote:
>> Hi all,
>>
>> I got a simple RCP app working[1] and now I want to add documentation.
>> When I select the Help Contents action, the help browser appears
>> correctly, but the first page shown is "Using the Eclipse help system"
>> and contains eclipse graphics, etc. This conflicts with my branding, so
>> I want to replace it. I see that I can simply replace help_home.html in
>> the help plugin, but is there an alternative "clean" way to do this,
>> perhaps via an extension point? If so, howto? If not, is there a bug I
>> can track for this? Thanks for all the work at making getting started
>> with RCP easy -- templates, tutorials, product configuration editor,
>> etc!
>>
>> [1] Eclipse 3.1.2
>>
>> - Matt
|
|
|
| Re: Branding the Help Index Page [message #449612 is a reply to message #449610] |
Tue, 16 May 2006 12:22 |
| Eclipse User |
|
|
|
OK, I just figured it out. I needed to create a file
plugin_customization.ini, and add the following to plugin.xml.
<product><property name="preferenceCustomization"
value="plugin_customization.ini"/></product>
Finally, I had to put the following in the new ini file.
org.eclipse.help.base/help_home=/myPlugin/html/help_home.htm l
- Matt
"Matt Munz" <mmunz@apelon.com> wrote in message
news:e4ctdr$sd8$1@utils.eclipse.org...
> Roman,
>
> Thanks. It is not clear how to set these properties so that they
> override the defaults. I have tried several things and nothing seems to
> work. Can you tell me specifically what files I need to modify to make
> this work? Are there any examples of code that overrides this property?
>
> - Matt
>
> "Roman Mukhin" <ramses_ru@hotmail.com> wrote in message
> news:e47416$57p$1@utils.eclipse.org...
>> Hi Matt
>>
>> Your Answer is described at Eclipse Help:
>> Platform Plug-in Developer Guide > Reference > Other reference
>> information > Help System Preferences:
>>
>> You need to assign your home page with overriding property
>> org.eclipse.help.base/help_home=/pluginId/path/to/home.html.
>>
>> There are more interesting propertied that could be overritten in order
>> to brand your help system.
>>
>> best regards
>> Ram
>>
>>
>> Matt Munz wrote:
>>> Hi all,
>>>
>>> I got a simple RCP app working[1] and now I want to add documentation.
>>> When I select the Help Contents action, the help browser appears
>>> correctly, but the first page shown is "Using the Eclipse help system"
>>> and contains eclipse graphics, etc. This conflicts with my branding, so
>>> I want to replace it. I see that I can simply replace help_home.html in
>>> the help plugin, but is there an alternative "clean" way to do this,
>>> perhaps via an extension point? If so, howto? If not, is there a bug I
>>> can track for this? Thanks for all the work at making getting started
>>> with RCP easy -- templates, tutorials, product configuration editor,
>>> etc!
>>>
>>> [1] Eclipse 3.1.2
>>>
>>> - Matt
>
>
|
|
|
|
Powered by
FUDForum. Page generated in 0.04212 seconds
Home