Eclipse Community Forums: Platform - User Assistance (UA) » Why do Cheatsheets depend on the help system?

Help

Home

Home » Eclipse Projects » Platform - User Assistance (UA) » Why do Cheatsheets depend on the help system?

Show: Today's Messages :: Show Polls :: Message Navigator

Why do Cheatsheets depend on the help system? [message #475668]

Thu, 09 July 2009 16:26

Philipp Kursawe

Messages: 135
Registered: July 2009

Senior Member

Hello,

I wanted to include some cheatsheets with my RCP application but *not*
want to include the help system as it drags in webservers, ant, lucene
and what else. Is there a reason why cheatsheets must be searchable with
lucene and why they depend on help.base?

It would be nice if we could just integrate the sheets (they are form
based, nothing like the html help system). The lucene searchable code
should be in an extender bundle.

Any thoughts?
Phil

Report message to a moderator

Re: Why do Cheatsheets depend on the help system? [message #475679 is a reply to message #475668]

Wed, 15 July 2009 16:55

Chris Goldthorpe

Messages: 815
Registered: July 2009

Senior Member

The dependency is there because cheat sheets can open help topics or
context help. For example if you open the cheat sheet "Open a Hello
World Application" in the "Java Development" category you will see a (?)
at the right of each item which if clicked will open the help system.
The second reason is to allow cheat sheets to participate in search. It
would be possible I suppose to make the dependencies optional and add
code to disable creation of the (?) if the dependency has not been
satisfied. As far as I know you are the first person to request this.

Philipp Kursawe wrote:
> Hello,
>
> I wanted to include some cheatsheets with my RCP application but *not*
> want to include the help system as it drags in webservers, ant, lucene
> and what else. Is there a reason why cheatsheets must be searchable with
> lucene and why they depend on help.base?
>
> It would be nice if we could just integrate the sheets (they are form
> based, nothing like the html help system). The lucene searchable code
> should be in an extender bundle.
>
> Any thoughts?
> Phil

Report message to a moderator

Re: Why do Cheatsheets depend on the help system? [message #475691 is a reply to message #475679]

Fri, 17 July 2009 06:08

Philipp Kursawe

Messages: 135
Registered: July 2009

Senior Member

Chris Goldthorpe wrote:
> The dependency is there because cheat sheets can open help topics or
> context help. For example if you open the cheat sheet "Open a Hello
> World Application" in the "Java Development" category you will see a (?)
> at the right of each item which if clicked will open the help system.
> The second reason is to allow cheat sheets to participate in search. It
> would be possible I suppose to make the dependencies optional and add
> code to disable creation of the (?) if the dependency has not been
> satisfied. As far as I know you are the first person to request this.

Sounds reasonable to me. Would be nice if the dependencies would be
optional. I could provide a patch for that. Can you explain me why the
helpsystem needs the ant bundle? To create the index? I am requesting
this cause I do not want to bundle help (several MB) to my RCP that only
displays cheatsheets.

>
> Philipp Kursawe wrote:
>> Hello,
>>
>> I wanted to include some cheatsheets with my RCP application but *not*
>> want to include the help system as it drags in webservers, ant, lucene
>> and what else. Is there a reason why cheatsheets must be searchable
>> with lucene and why they depend on help.base?
>>
>> It would be nice if we could just integrate the sheets (they are form
>> based, nothing like the html help system). The lucene searchable code
>> should be in an extender bundle.
>>
>> Any thoughts?
>> Phil

Report message to a moderator