Eclipse Community Forums: Platform - User Assistance (UA) » Problem with helpData.xml in Infocenter

Search

Help

Login

Home » Eclipse Projects » Platform - User Assistance (UA) » Problem with helpData.xml in Infocenter

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

Switch to threaded view of this topic

Create a new topic

Submit Reply

Problem with helpData.xml in Infocenter [message #470146]

Fri, 19 October 2007 14:03

Daniel Walter is currently offline

Friend

Messages: 10
Registered: July 2009

Junior Member

I'm trying to set up a Infocenter that contains several JARs with
documentation.

Using the deprecated method in the plugin_customization.ini works fine
like e.g.:

org.eclipse.help/ignoredTOCS=/pluginId/path/to/toc.xml

But when trying to use the helpData.xml it doesnt show any effect at all.

That's what the files look like (of course with correct ID):

plugin_customization.ini:
org.eclipse.help.HELP_DATA=/home/eclipse/helpData.xml

/home/eclipse/helpData.xml:
<extensions>
<hidden>
<toc id="/pluginId/path/to/toc.xml"/>
</hidden>
</extensions>

Is there any obvious reason why this doesn't work?

Thanks for your help!
Daniel

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #470150 is a reply to message #470146]

Fri, 19 October 2007 16:57

Chris Goldthorpe is currently offline

Chris Goldthorpe

Friend

Messages: 815
Registered: July 2009

Senior Member

I think that the help system is treating "pluginId" as part of a file
path rather than a plugin. Try "../pluginId/path/to/toc.xml"

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #470152 is a reply to message #470150]

Mon, 22 October 2007 08:22

Daniel Walter is currently offline

Friend

Messages: 10
Registered: July 2009

Junior Member

Thanks for your reply but this didn't work either.
Where should I put the helpData.xml file that I referenced in the
plugin_customization.ini? Is it ok to use absolute file system path
there? Or is there any preferred place to put that file?

The fact that the old-styled configuration works is quite confusing to
me. How can I be sure the helpData.xml is being found? Nothing in the
debug output about that.

Chris Goldthorpe wrote:
> I think that the help system is treating "pluginId" as part of a file
> path rather than a plugin. Try "../pluginId/path/to/toc.xml"

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #470156 is a reply to message #470152]

Mon, 22 October 2007 21:45

Chris Goldthorpe is currently offline

Chris Goldthorpe

Friend

Messages: 815
Registered: July 2009

Senior Member

The path in HELP_DATA is resolved relative to the product plugin. I was
able to get the relative path to work when I tested this but that was
probably because the product plugin and plugin containing help data were
both in my workspace. I would also have expected
PLUGINS_ROOT/pluginId/path/to/toc.xml to work but it does not seem to
work. I would consider that to be a bug because there should be an easy
way to reference

I'm not sure that an absolute path would work but you could try it.

Daniel Walter wrote:
> Thanks for your reply but this didn't work either.
> Where should I put the helpData.xml file that I referenced in the
> plugin_customization.ini? Is it ok to use absolute file system path
> there? Or is there any preferred place to put that file?
>
> The fact that the old-styled configuration works is quite confusing to
> me. How can I be sure the helpData.xml is being found? Nothing in the
> debug output about that.
>
> Chris Goldthorpe wrote:
>> I think that the help system is treating "pluginId" as part of a file
>> path rather than a plugin. Try "../pluginId/path/to/toc.xml"

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #470556 is a reply to message #470146]

Mon, 29 October 2007 16:08

Jabier is currently offline

Friend

Messages: 10
Registered: July 2009

Junior Member

I didn't have that problem.
I am developing a RCP application with my own helpToc.xml but when I run
it I have another toc that comes from a dependency (org.eclipse.ocl.doc)
of my plug-in. I manage to hide it. Both plugin_customization and
helpData.xml are in the root of my plug-in, and, of course, in the
extensions of org.eclipse.core.runtime.products there is a property called
preferenceCustomization that has plugin_customization.ini as value.

plugin_customization.ini:
org.eclipse.help/HELP_DATA = helpData.xml

helpData.xml:
<extensions>
<hidden>
<toc id="/org.eclipse.ocl.doc/toc.xml"/>
</hidden>
</extensions>

Jabi

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #471285 is a reply to message #470156]

Tue, 11 December 2007 12:46

Daniel Walter is currently offline

Friend

Messages: 10
Registered: July 2009

Junior Member

Unfortunately this issue came back to me without me having a solution yet.

I try to outline what I try to achieve a litte bit more just to be sure
that I am on the right path:

Several JARs, each containing a single book, will be added to the
infocenter time over time by an automated process. These JARs are being
put in a folder that is was added by using the "addSite" command.

My first question: Is it really so, that you have to restart the whole
IC when adding or removing documentation JARs? I first assumed that it
would be possible to do this in runtime by using the "install" command
but it turned out to be something different. But restarting the IC is
not a real problem as it can be easily achieved.

So after a restart of the IC all the books that are contained in my
documentation JARs are listed in the IC's contents pane as expected.
The books are sorted by time of addition.

So now how to sort these books in the contents pane alphabetically?
I can easily create an XML with the right order from within my application.
This is my current approach:

#ECLIPSE_HOME/plugins/plugin_customization.ini
org.eclipse.help/HELP_DATA=../helpData.xml

#ECLIPSE_HOME/plugins/helpData.xml
<extensions>
<tocOrder>
<toc id="../com.example.doc2/toc.xml"/>
<toc id="../com.example.doc1/toc.xml"/>
<toc id="../com.example.doc3/toc.xml"/>
</tocOrder>
</extensions>

The IC is then being started by using:
C:\eclipse>java -cp plugins\org.eclipse.help.base_3.3.0.v20070606.jar
org.eclipse.help.standalone.Infocenter -command start
-plugincustomization plugins\plugin_customization.ini

It doesn't matter if the JARs containing the documentations are stored
in the location added by "addSite" or directly in ECLIPSE_HOME/plugins.
The items will not be sorted. I can see that the
plugin_customization.ini file is loaded corretly as when I add seomthing
like "org.eclipse.help.base/banner_height=60" I can see the effects.

How can I get these things sorted correctly?

Chris Goldthorpe wrote:
> The path in HELP_DATA is resolved relative to the product plugin. I was
> able to get the relative path to work when I tested this but that was
> probably because the product plugin and plugin containing help data were
> both in my workspace. I would also have expected
> PLUGINS_ROOT/pluginId/path/to/toc.xml to work but it does not seem to
> work. I would consider that to be a bug because there should be an easy
> way to reference
>
> I'm not sure that an absolute path would work but you could try it.
>
>
> Daniel Walter wrote:
>> Thanks for your reply but this didn't work either.
>> Where should I put the helpData.xml file that I referenced in the
>> plugin_customization.ini? Is it ok to use absolute file system path
>> there? Or is there any preferred place to put that file?
>>
>> The fact that the old-styled configuration works is quite confusing
>> to me. How can I be sure the helpData.xml is being found? Nothing in
>> the debug output about that.
>>
>> Chris Goldthorpe wrote:
>>> I think that the help system is treating "pluginId" as part of a file
>>> path rather than a plugin. Try "../pluginId/path/to/toc.xml"

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #471286 is a reply to message #471285]

Tue, 11 December 2007 23:29

Chris Goldthorpe is currently offline

Chris Goldthorpe

Friend

Messages: 815
Registered: July 2009

Senior Member

In answer to question 1, I'm pretty sure that you need to restart the
infocenter.

Regarding the TOC ordering Eclipse 3.4 will put any TOCs which are at
the specified in HELP_DATA at the top and any unspecified books arew
then sorted alphabetically. This feature was not in Eclipse 3.3 so if
you are in a position to pick up the latest Eclipse 3.4 milestone build
you may find that you automatically get the alphabetic ordering you want.

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #471537 is a reply to message #470146]

Tue, 22 January 2008 23:28

Chris Goldthorpe is currently offline

Chris Goldthorpe

Friend

Messages: 815
Registered: July 2009

Senior Member

I just fixed Bug 216170 – [Help] can't have the helpData.xml in another
plugin from the plugin_customization.ini file. This should solve the
problem of not being able to include help data from the plugin of your
choice.

Daniel Walter wrote:
> I'm trying to set up a Infocenter that contains several JARs with
> documentation.
>
> Using the deprecated method in the plugin_customization.ini works fine
> like e.g.:
>
> org.eclipse.help/ignoredTOCS=/pluginId/path/to/toc.xml
>
> But when trying to use the helpData.xml it doesnt show any effect at all.
>
> That's what the files look like (of course with correct ID):
>
> plugin_customization.ini:
> org.eclipse.help.HELP_DATA=/home/eclipse/helpData.xml
>
> /home/eclipse/helpData.xml:
> <extensions>
> <hidden>
> <toc id="/pluginId/path/to/toc.xml"/>
> </hidden>
> </extensions>
>
> Is there any obvious reason why this doesn't work?
>
> Thanks for your help!
> Daniel

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #588997 is a reply to message #470146]

Fri, 19 October 2007 16:57

Chris Goldthorpe is currently offline

Chris Goldthorpe

Friend

Messages: 815
Registered: July 2009

Senior Member

I think that the help system is treating "pluginId" as part of a file
path rather than a plugin. Try "../pluginId/path/to/toc.xml"

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #589015 is a reply to message #470150]

Mon, 22 October 2007 08:22

Daniel Walter is currently offline

Friend

Messages: 10
Registered: July 2009

Junior Member

Thanks for your reply but this didn't work either.
Where should I put the helpData.xml file that I referenced in the
plugin_customization.ini? Is it ok to use absolute file system path
there? Or is there any preferred place to put that file?

The fact that the old-styled configuration works is quite confusing to
me. How can I be sure the helpData.xml is being found? Nothing in the
debug output about that.

Chris Goldthorpe wrote:
> I think that the help system is treating "pluginId" as part of a file
> path rather than a plugin. Try "../pluginId/path/to/toc.xml"

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #589035 is a reply to message #470152]

Mon, 22 October 2007 21:45

Chris Goldthorpe is currently offline

Chris Goldthorpe

Friend

Messages: 815
Registered: July 2009

Senior Member

The path in HELP_DATA is resolved relative to the product plugin. I was
able to get the relative path to work when I tested this but that was
probably because the product plugin and plugin containing help data were
both in my workspace. I would also have expected
PLUGINS_ROOT/pluginId/path/to/toc.xml to work but it does not seem to
work. I would consider that to be a bug because there should be an easy
way to reference

I'm not sure that an absolute path would work but you could try it.

Daniel Walter wrote:
> Thanks for your reply but this didn't work either.
> Where should I put the helpData.xml file that I referenced in the
> plugin_customization.ini? Is it ok to use absolute file system path
> there? Or is there any preferred place to put that file?
>
> The fact that the old-styled configuration works is quite confusing to
> me. How can I be sure the helpData.xml is being found? Nothing in the
> debug output about that.
>
> Chris Goldthorpe wrote:
>> I think that the help system is treating "pluginId" as part of a file
>> path rather than a plugin. Try "../pluginId/path/to/toc.xml"

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #592634 is a reply to message #470146]

Mon, 29 October 2007 16:08

Jabier is currently offline

Friend

Messages: 10
Registered: July 2009

Junior Member

I didn't have that problem.
I am developing a RCP application with my own helpToc.xml but when I run
it I have another toc that comes from a dependency (org.eclipse.ocl.doc)
of my plug-in. I manage to hide it. Both plugin_customization and
helpData.xml are in the root of my plug-in, and, of course, in the
extensions of org.eclipse.core.runtime.products there is a property called
preferenceCustomization that has plugin_customization.ini as value.

plugin_customization.ini:
org.eclipse.help/HELP_DATA = helpData.xml

helpData.xml:
<extensions>
<hidden>
<toc id="/org.eclipse.ocl.doc/toc.xml"/>
</hidden>
</extensions>

Jabi

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #605373 is a reply to message #470156]

Tue, 11 December 2007 12:46

Daniel Walter is currently offline

Friend

Messages: 10
Registered: July 2009

Junior Member

Unfortunately this issue came back to me without me having a solution yet.

I try to outline what I try to achieve a litte bit more just to be sure
that I am on the right path:

Several JARs, each containing a single book, will be added to the
infocenter time over time by an automated process. These JARs are being
put in a folder that is was added by using the "addSite" command.

My first question: Is it really so, that you have to restart the whole
IC when adding or removing documentation JARs? I first assumed that it
would be possible to do this in runtime by using the "install" command
but it turned out to be something different. But restarting the IC is
not a real problem as it can be easily achieved.

So after a restart of the IC all the books that are contained in my
documentation JARs are listed in the IC's contents pane as expected.
The books are sorted by time of addition.

So now how to sort these books in the contents pane alphabetically?
I can easily create an XML with the right order from within my application.
This is my current approach:

#ECLIPSE_HOME/plugins/plugin_customization.ini
org.eclipse.help/HELP_DATA=../helpData.xml

#ECLIPSE_HOME/plugins/helpData.xml
<extensions>
<tocOrder>
<toc id="../com.example.doc2/toc.xml"/>
<toc id="../com.example.doc1/toc.xml"/>
<toc id="../com.example.doc3/toc.xml"/>
</tocOrder>
</extensions>

The IC is then being started by using:
C:\eclipse>java -cp plugins\org.eclipse.help.base_3.3.0.v20070606.jar
org.eclipse.help.standalone.Infocenter -command start
-plugincustomization plugins\plugin_customization.ini

It doesn't matter if the JARs containing the documentations are stored
in the location added by "addSite" or directly in ECLIPSE_HOME/plugins.
The items will not be sorted. I can see that the
plugin_customization.ini file is loaded corretly as when I add seomthing
like "org.eclipse.help.base/banner_height=60" I can see the effects.

How can I get these things sorted correctly?

Chris Goldthorpe wrote:
> The path in HELP_DATA is resolved relative to the product plugin. I was
> able to get the relative path to work when I tested this but that was
> probably because the product plugin and plugin containing help data were
> both in my workspace. I would also have expected
> PLUGINS_ROOT/pluginId/path/to/toc.xml to work but it does not seem to
> work. I would consider that to be a bug because there should be an easy
> way to reference
>
> I'm not sure that an absolute path would work but you could try it.
>
>
> Daniel Walter wrote:
>> Thanks for your reply but this didn't work either.
>> Where should I put the helpData.xml file that I referenced in the
>> plugin_customization.ini? Is it ok to use absolute file system path
>> there? Or is there any preferred place to put that file?
>>
>> The fact that the old-styled configuration works is quite confusing
>> to me. How can I be sure the helpData.xml is being found? Nothing in
>> the debug output about that.
>>
>> Chris Goldthorpe wrote:
>>> I think that the help system is treating "pluginId" as part of a file
>>> path rather than a plugin. Try "../pluginId/path/to/toc.xml"

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #605379 is a reply to message #471285]

Tue, 11 December 2007 23:29

Chris Goldthorpe is currently offline

Chris Goldthorpe

Friend

Messages: 815
Registered: July 2009

Senior Member

In answer to question 1, I'm pretty sure that you need to restart the
infocenter.

Regarding the TOC ordering Eclipse 3.4 will put any TOCs which are at
the specified in HELP_DATA at the top and any unspecified books arew
then sorted alphabetically. This feature was not in Eclipse 3.3 so if
you are in a position to pick up the latest Eclipse 3.4 milestone build
you may find that you automatically get the alphabetic ordering you want.

Report message to a moderator

Re: Problem with helpData.xml in Infocenter [message #607682 is a reply to message #470146]

Tue, 22 January 2008 23:28

Chris Goldthorpe is currently offline

Chris Goldthorpe

Friend

Messages: 815
Registered: July 2009

Senior Member

I just fixed Bug 216170 – [Help] can't have the helpData.xml in another
plugin from the plugin_customization.ini file. This should solve the
problem of not being able to include help data from the plugin of your
choice.

Daniel Walter wrote:
> I'm trying to set up a Infocenter that contains several JARs with
> documentation.
>
> Using the deprecated method in the plugin_customization.ini works fine
> like e.g.:
>
> org.eclipse.help/ignoredTOCS=/pluginId/path/to/toc.xml
>
> But when trying to use the helpData.xml it doesnt show any effect at all.
>
> That's what the files look like (of course with correct ID):
>
> plugin_customization.ini:
> org.eclipse.help.HELP_DATA=/home/eclipse/helpData.xml
>
> /home/eclipse/helpData.xml:
> <extensions>
> <hidden>
> <toc id="/pluginId/path/to/toc.xml"/>
> </hidden>
> </extensions>
>
> Is there any obvious reason why this doesn't work?
>
> Thanks for your help!
> Daniel

Report message to a moderator

Switch to threaded view of this topic

Create a new topic

Submit Reply

Previous Topic:	RCP application with remote help content only - can it avoid including jetty/jasper ?
Next Topic:	Help on Eclipse Help System

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

]

Current Time: Tue Apr 16 16:26:36 GMT 2024

Powered by FUDForum. Page generated in 0.46783 seconds

.:: Contact :: Home ::.

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

Back to the top