Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Platform - User Assistance (UA) » Does the infocenter provides a remote API to get context hep
Does the infocenter provides a remote API to get context hep [message #474175] Tue, 12 August 2008 13:07 Go to next message
David Beaurpere is currently offline David Beaurpere
Messages: 15
Registered: July 2009
Junior Member
hi,

we are using the infocenter as a standalone app to provide help support
for a web project that has nothing to do with eclipse.

It works great as far as running it our web server but now we would like
to add support for context help on our web app.

So, does the infocenter provide a remote API to get the context help
content as set up in the context.xml?

the only documentation i could find about was for the JAVA APIs which are
no good to me.

i noticed that the context.xml is directly available from the root URL of
the infocenter so i guess our app could just fetch it, parse it and then
render itself the contexts desc and links as appropriate but if the
infocenter is providing this already we might as well make use of it

rgds,
d.
Re: Does the infocenter provides a remote API to get context hep [message #474223 is a reply to message #474175] Tue, 12 August 2008 17:37 Go to previous messageGo to next message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
There is a context servlet which is used for remote help support which
returns context information in xml format. For example

http://help.eclipse.org/ganymede/context?id=org.eclipse.ui.w orkbench_window_context

results in

<?xml version="1.0" encoding="UTF-8" ?>
- <context>
<description>Each workbench window contains one or more perspectives,
which are made up of various views and editors.</description>
<topic label="Workbench"
href="/org.eclipse.platform.doc.user/concepts/concepts-2.htm " />
<topic label="Perspectives"
href="/org.eclipse.platform.doc.user/concepts/concepts-4.htm " />
<topic label="Customizing the Workbench"
href="/org.eclipse.platform.doc.user/tasks/tasks-1.htm" />
</context>
Re: Does the infocenter provides a remote API to get context hep [message #474224 is a reply to message #474175] Tue, 12 August 2008 21:26 Go to previous messageGo to next message
Eric Roberts is currently offline Eric Roberts
Messages: 24
Registered: July 2009
Junior Member
We have a requirement for this as well. We have non-Eclipse products that
use context sensitive help. A Java API would be great.

Eric
"david beaurpere" <david.beaurpere@iona.com> wrote in message
news:8278964709ecf016d2593bf0f49fbc29$1@www.eclipse.org...
>
> hi,
>
> we are using the infocenter as a standalone app to provide help support
> for a web project that has nothing to do with eclipse.
> It works great as far as running it our web server but now we would like
> to add support for context help on our web app.
>
> So, does the infocenter provide a remote API to get the context help
> content as set up in the context.xml?
> the only documentation i could find about was for the JAVA APIs which are
> no good to me.
>
> i noticed that the context.xml is directly available from the root URL of
> the infocenter so i guess our app could just fetch it, parse it and then
> render itself the contexts desc and links as appropriate but if the
> infocenter is providing this already we might as well make use of it
>
> rgds,
> d.
>
>
Re: Does the infocenter provides a remote API to get context hep [message #474226 is a reply to message #474223] Tue, 12 August 2008 21:35 Go to previous messageGo to next message
Eric Roberts is currently offline Eric Roberts
Messages: 24
Registered: July 2009
Junior Member
Is there any documentation about this? What's the formula for the id
paramter?

Eric
"Chris Goldthorpe" <cgold@us.ibm.com> wrote in message
news:g7shon$q3o$1@build.eclipse.org...
> There is a context servlet which is used for remote help support which
> returns context information in xml format. For example
>
> http://help.eclipse.org/ganymede/context?id=org.eclipse.ui.w orkbench_window_context
>
> results in
>
> <?xml version="1.0" encoding="UTF-8" ?>
> - <context>
> <description>Each workbench window contains one or more perspectives,
> which are made up of various views and editors.</description>
> <topic label="Workbench"
> href="/org.eclipse.platform.doc.user/concepts/concepts-2.htm " />
> <topic label="Perspectives"
> href="/org.eclipse.platform.doc.user/concepts/concepts-4.htm " />
> <topic label="Customizing the Workbench"
> href="/org.eclipse.platform.doc.user/tasks/tasks-1.htm" />
> </context>
>
Re: Does the infocenter provides a remote API to get context hep [message #474228 is a reply to message #474226] Tue, 12 August 2008 23:24 Go to previous messageGo to next message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
There is not any documentation because it is an internal mechanism, and
not API. You are welcome to use it but it is one of those hidden
features that comes without documentation or warranty. If you would like
to see it become a supported feature then you should file a bug report
to request that.
Re: Does the infocenter provides a remote API to get context hep [message #474229 is a reply to message #474226] Tue, 12 August 2008 23:26 Go to previous message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
.... and the formula for the id parameter is <plugin_name>.<context_id>
Re: Does the infocenter provides a remote API to get context hep [message #619376 is a reply to message #474175] Tue, 12 August 2008 17:37 Go to previous message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
There is a context servlet which is used for remote help support which
returns context information in xml format. For example

http://help.eclipse.org/ganymede/context?id=org.eclipse.ui.w orkbench_window_context

results in

<?xml version="1.0" encoding="UTF-8" ?>
- <context>
<description>Each workbench window contains one or more perspectives,
which are made up of various views and editors.</description>
<topic label="Workbench"
href="/org.eclipse.platform.doc.user/concepts/concepts-2.htm " />
<topic label="Perspectives"
href="/org.eclipse.platform.doc.user/concepts/concepts-4.htm " />
<topic label="Customizing the Workbench"
href="/org.eclipse.platform.doc.user/tasks/tasks-1.htm" />
</context>
Re: Does the infocenter provides a remote API to get context hep [message #619377 is a reply to message #474175] Tue, 12 August 2008 21:26 Go to previous message
Eric Roberts is currently offline Eric Roberts
Messages: 24
Registered: July 2009
Junior Member
We have a requirement for this as well. We have non-Eclipse products that
use context sensitive help. A Java API would be great.

Eric
"david beaurpere" <david.beaurpere@iona.com> wrote in message
news:8278964709ecf016d2593bf0f49fbc29$1@www.eclipse.org...
>
> hi,
>
> we are using the infocenter as a standalone app to provide help support
> for a web project that has nothing to do with eclipse.
> It works great as far as running it our web server but now we would like
> to add support for context help on our web app.
>
> So, does the infocenter provide a remote API to get the context help
> content as set up in the context.xml?
> the only documentation i could find about was for the JAVA APIs which are
> no good to me.
>
> i noticed that the context.xml is directly available from the root URL of
> the infocenter so i guess our app could just fetch it, parse it and then
> render itself the contexts desc and links as appropriate but if the
> infocenter is providing this already we might as well make use of it
>
> rgds,
> d.
>
>
Re: Does the infocenter provides a remote API to get context hep [message #619378 is a reply to message #474223] Tue, 12 August 2008 21:35 Go to previous message
Eric Roberts is currently offline Eric Roberts
Messages: 24
Registered: July 2009
Junior Member
Is there any documentation about this? What's the formula for the id
paramter?

Eric
"Chris Goldthorpe" <cgold@us.ibm.com> wrote in message
news:g7shon$q3o$1@build.eclipse.org...
> There is a context servlet which is used for remote help support which
> returns context information in xml format. For example
>
> http://help.eclipse.org/ganymede/context?id=org.eclipse.ui.w orkbench_window_context
>
> results in
>
> <?xml version="1.0" encoding="UTF-8" ?>
> - <context>
> <description>Each workbench window contains one or more perspectives,
> which are made up of various views and editors.</description>
> <topic label="Workbench"
> href="/org.eclipse.platform.doc.user/concepts/concepts-2.htm " />
> <topic label="Perspectives"
> href="/org.eclipse.platform.doc.user/concepts/concepts-4.htm " />
> <topic label="Customizing the Workbench"
> href="/org.eclipse.platform.doc.user/tasks/tasks-1.htm" />
> </context>
>
Re: Does the infocenter provides a remote API to get context hep [message #619380 is a reply to message #474226] Tue, 12 August 2008 23:24 Go to previous message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
There is not any documentation because it is an internal mechanism, and
not API. You are welcome to use it but it is one of those hidden
features that comes without documentation or warranty. If you would like
to see it become a supported feature then you should file a bug report
to request that.
Re: Does the infocenter provides a remote API to get context hep [message #619382 is a reply to message #474226] Tue, 12 August 2008 23:26 Go to previous message
Chris Goldthorpe is currently offline Chris Goldthorpe
Messages: 815
Registered: July 2009
Senior Member
.... and the formula for the id parameter is <plugin_name>.<context_id>
Previous Topic:Does the infocenter provides a remote API to get context hep
Next Topic:What could limiting help search.
Goto Forum:
  


Current Time: Wed Oct 01 08:13:14 GMT 2014

Powered by FUDForum. Page generated in 0.03660 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software