Eclipse Community Forums - RDF feed
https://www.eclipse.org/forums/
Eclipse Community ForumsGenerating a ToC at run-time
https://www.eclipse.org/forums/index.php/mv/msg/151207/475694/#msg_475694
I am displaying a set of external HTML help files from a local filesystem
within
the Eclipse help system as follows:
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?
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
>]]>Chris Goldthorpe2009-07-20T17:20:08-00:00Re: Generating a ToC at run-time
https://www.eclipse.org/forums/index.php/mv/msg/151207/623441/#msg_623441
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
>]]>Chris Goldthorpe2009-07-20T17:20:08-00:00Re: Generating a ToC at run-time
https://www.eclipse.org/forums/index.php/mv/msg/151207/475699/#msg_475699
> 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.
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.
I note that other developers have also struggled with this. Does anyone
have
an example for Galileo based on the AbstractTocProvider class?
Peter Saunders]]>Peter Saunders2009-07-21T14:18:10-00:00Re: Generating a ToC at run-time
https://www.eclipse.org/forums/index.php/mv/msg/151207/623455/#msg_623455
> 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.]]>Chris Goldthorpe2009-08-10T23:31:14-00:00Re: Generating a ToC at run-time
https://www.eclipse.org/forums/index.php/mv/msg/151207/479420/#msg_479420
> I note that other developers have also struggled with this. Does anyone
> have
> an example for Galileo based on the AbstractTocProvider class?
>
> Peter Saunders
>