Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Platform - User Assistance (UA) » Generating a ToC at run-time
Generating a ToC at run-time [message #475694] Mon, 20 July 2009 12:26 Go to next message
Peter Saunders is currently offline Peter Saunders
Messages: 30
Registered: July 2009
Member
Hi

I am displaying a set of external HTML help files from a local filesystem
within
the Eclipse help system as follows:

docDir = getDocDirPreference();
href = "file:" + docDir + "/myhelp.html";
PlatformUI.getWorkbench().getHelpSystem().displayHelpResourc e(href);

The location of the directory containing the external help files is
configurable at run-time and this may affect the precise set of help files
available so I am unable to provide a static Table of Contents file when I
build my plug-in.

If I generated a ToC programatically at run-time, how could I add this to
the help system? Is there an API for this?

Thanks

Peter Saunders

Report message to a moderator

Re: Generating a ToC at run-time [message #475695 is a reply to message #475694] Mon, 20 July 2009 13:20 Go to previous messageGo to next message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
Yes, there is an API, see the tocProvider element in the extension point
org.eclipse.help.toc - see
http://help.eclipse.org/galileo/topic/org.eclipse.platform.d oc.isv/reference/extension-points/org_eclipse_help_toc.html

You will probably also want to use the org.eclipse.help.contentProducer
extension point to read the content.

Peter Saunders wrote:
> Hi
>
> I am displaying a set of external HTML help files from a local
> filesystem within
> the Eclipse help system as follows:
>
> docDir = getDocDirPreference();
> href = "file:" + docDir + "/myhelp.html";
> PlatformUI.getWorkbench().getHelpSystem().displayHelpResourc e(href);
>
> The location of the directory containing the external help files is
> configurable at run-time and this may affect the precise set of help
> files available so I am unable to provide a static Table of Contents
> file when I build my plug-in.
>
> If I generated a ToC programatically at run-time, how could I add this
> to the help system? Is there an API for this?
>
> Thanks
>
> Peter Saunders
>

Report message to a moderator

Re: Generating a ToC at run-time [message #475699 is a reply to message #475695] Tue, 21 July 2009 06:03 Go to previous messageGo to next message
Peter Saunders is currently offline Peter Saunders
Messages: 30
Registered: July 2009
Member
Chris Goldthorpe wrote:

> Yes, there is an API, see the tocProvider element in the extension point
> org.eclipse.help.toc - see
>
http://help.eclipse.org/galileo/topic/org.eclipse.platform.d oc.isv/reference/extension-points/org_eclipse_help_toc.html

The AbstractTocProvider class looks useful. Thanks for the pointer.

> You will probably also want to use the org.eclipse.help.contentProducer
> extension point to read the content.

I tried this earlier but the getInputStream() method in my
IHelpContentProducer implementation was never called. Perhaps it is only
called when the plug-in provides corresponding ToC entries.

Peter Saunders

Report message to a moderator

Re: Generating a ToC at run-time [message #475701 is a reply to message #475695] Tue, 21 July 2009 10:18 Go to previous messageGo to next message
Peter Saunders is currently offline Peter Saunders
Messages: 30
Registered: July 2009
Member
Chris Goldthorpe wrote:

> Yes, there is an API, see the tocProvider element in the extension point
> org.eclipse.help.toc - see
>
http://help.eclipse.org/galileo/topic/org.eclipse.platform.d oc.isv/reference/extension-points/org_eclipse_help_toc.html

I've tried implementing a tocProvider based on the example code at:

http://www.eclipse.org/eclipse/platform-ua/documents/provide rs_api.html

but this code does not build for Galileo without modification. When I add
the
missing methods, the "Hello World" ToC contribution does not appear.

I've also looked at the adapting code from the RoboHelp ToC contributor at:

http://tinyurl.com/mws4cn

but that doesn't build for Galileo either.

I note that other developers have also struggled with this. Does anyone
have
an example for Galileo based on the AbstractTocProvider class?

Peter Saunders

Report message to a moderator

Re: Generating a ToC at run-time [message #479420 is a reply to message #475701] Mon, 10 August 2009 19:31 Go to previous message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
>
> I note that other developers have also struggled with this. Does anyone
> have
> an example for Galileo based on the AbstractTocProvider class?
>
> Peter Saunders
>

There is an attachment to
https://bugs.eclipse.org/bugs/show_bug.cgi?id=272850 which is a plug-in
which generates a toc.

Report message to a moderator

Re: Generating a ToC at run-time [message #623441 is a reply to message #475694] Mon, 20 July 2009 13:20 Go to previous message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
Yes, there is an API, see the tocProvider element in the extension point
org.eclipse.help.toc - see
http://help.eclipse.org/galileo/topic/org.eclipse.platform.d oc.isv/reference/extension-points/org_eclipse_help_toc.html

You will probably also want to use the org.eclipse.help.contentProducer
extension point to read the content.

Peter Saunders wrote:
> Hi
>
> I am displaying a set of external HTML help files from a local
> filesystem within
> the Eclipse help system as follows:
>
> docDir = getDocDirPreference();
> href = "file:" + docDir + "/myhelp.html";
> PlatformUI.getWorkbench().getHelpSystem().displayHelpResourc e(href);
>
> The location of the directory containing the external help files is
> configurable at run-time and this may affect the precise set of help
> files available so I am unable to provide a static Table of Contents
> file when I build my plug-in.
>
> If I generated a ToC programatically at run-time, how could I add this
> to the help system? Is there an API for this?
>
> Thanks
>
> Peter Saunders
>

Report message to a moderator

Re: Generating a ToC at run-time [message #623443 is a reply to message #475695] Tue, 21 July 2009 06:03 Go to previous message
Peter Saunders is currently offline Peter Saunders
Messages: 30
Registered: July 2009
Member
Chris Goldthorpe wrote:

> Yes, there is an API, see the tocProvider element in the extension point
> org.eclipse.help.toc - see
>
http://help.eclipse.org/galileo/topic/org.eclipse.platform.d oc.isv/reference/extension-points/org_eclipse_help_toc.html

The AbstractTocProvider class looks useful. Thanks for the pointer.

> You will probably also want to use the org.eclipse.help.contentProducer
> extension point to read the content.

I tried this earlier but the getInputStream() method in my
IHelpContentProducer implementation was never called. Perhaps it is only
called when the plug-in provides corresponding ToC entries.

Peter Saunders

Report message to a moderator

Re: Generating a ToC at run-time [message #623444 is a reply to message #475695] Tue, 21 July 2009 10:18 Go to previous message
Peter Saunders is currently offline Peter Saunders
Messages: 30
Registered: July 2009
Member
Chris Goldthorpe wrote:

> Yes, there is an API, see the tocProvider element in the extension point
> org.eclipse.help.toc - see
>
http://help.eclipse.org/galileo/topic/org.eclipse.platform.d oc.isv/reference/extension-points/org_eclipse_help_toc.html

I've tried implementing a tocProvider based on the example code at:

http://www.eclipse.org/eclipse/platform-ua/documents/provide rs_api.html

but this code does not build for Galileo without modification. When I add
the
missing methods, the "Hello World" ToC contribution does not appear.

I've also looked at the adapting code from the RoboHelp ToC contributor at:

http://tinyurl.com/mws4cn

but that doesn't build for Galileo either.

I note that other developers have also struggled with this. Does anyone
have
an example for Galileo based on the AbstractTocProvider class?

Peter Saunders

Report message to a moderator

Re: Generating a ToC at run-time [message #623455 is a reply to message #475701] Mon, 10 August 2009 19:31 Go to previous message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
>
> I note that other developers have also struggled with this. Does anyone
> have
> an example for Galileo based on the AbstractTocProvider class?
>
> Peter Saunders
>

There is an attachment to
https://bugs.eclipse.org/bugs/show_bug.cgi?id=272850 which is a plug-in
which generates a toc.

Report message to a moderator

Previous Topic:Help System on Mac OS X - Cocoa (Eclipse 3.5)
Next Topic:Localizing Intro Contributions
Goto Forum:
  

[ Syndicate this forum (XML) ] [ RSS ]

Current Time: Fri May 24 04:09:20 EDT 2013

Powered by FUDForum. Page generated in 0.01891 seconds