Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Platform - User Assistance (UA) » Not recognising helpdata.xml
Not recognising helpdata.xml [message #474305] Fri, 29 August 2008 09:26 Go to next message
Phill Perryman is currently offline Phill PerrymanFriend
Messages: 214
Registered: July 2009
Senior Member
This is a multipart message in MIME format.
--=_alternative 0033D293802574B4_=
Content-Type: text/plain; charset="US-ASCII"

I have added the following nodes in my RCP ApplicationWorkbenchAdvisor
class (see below). Welcome works fine but it is not recognising the
helpData. I don't use a plugin_customisation file so programmatically add
the nodes.

In the root of the project (which is the main rcp project plugin) I have a
helpData.xml file with the following contents. I want the main application
help contents to appear first followed by the other help tocs. The main
help toc is in the com.mitel.swb.help project called toc.xml and is marked
as primary and appears in the help index (fourth entry because of
alphabetic ordering).

I export the project and check the helpData.xml file is contained in the
jar which it is. I run the product and the entry is still fourth in the
list.

What am I doing wrong?

<extensions>
<tocOrder>
<toc id="/com.mitel.swb.help/toc.xml"/>
</tocOrder>
</extensions>

Preferences node = new DefaultScope().getNode("org.eclipse.help.base");
//$NON-NLS-1$
node.put("help_home", "/com.mitel.swb/content/welcome.html");
//$NON-NLS-1$ //$NON-NLS-2$

node = new DefaultScope().getNode("org.eclipse.help"); //$NON-NLS-1$
node.put("HELP_DATA", "/com.mitel.swb/helpData.xml"); //$NON-NLS-1$
//$NON-NLS-2$
--=_alternative 0033D293802574B4_=
Content-Type: text/html; charset="US-ASCII"


<br><font size=2 face="sans-serif">I have added the following nodes in
my RCP </font><font size=2 face="Courier New">ApplicationWorkbenchAdvisor</font><font size=2 face="sans-serif">
class (see below). Welcome works fine but it is not recognising the helpData.
I don't use a plugin_customisation file so programmatically add the nodes.</font>
<br>
<br><font size=2 face="sans-serif">In the root of the project (which is
the main rcp project plugin) I have a helpData.xml file with the following
contents. I want the main application help contents to appear first followed
by the other help tocs. The main help toc is in the com.mitel.swb.help
project called toc.xml and is marked as primary and appears in the help
index (fourth entry because of alphabetic ordering).</font>
<br>
<br><font size=2 face="sans-serif">I export the project and check the helpData.xml
file is contained in the jar which it is. I run the product and the entry
is still fourth in the list.</font>
<br>
<br><font size=2 face="sans-serif">What am I doing wrong?</font>
<br>
<br><font size=2 color=#008080 face="Courier New">&lt;</font><font size=2 color=#3f8080 face="Courier New">extensions</font><font size=2 color=#008080 face="Courier New">&gt;</font>
<br><font size=2 face="Courier New">&nbsp;</font><font size=2 color=#008080 face="Courier New">&lt;</font><font size=2 color=#3f8080 face="Courier New">tocOrder</font><font size=2 color=#008080 face="Courier New">&gt;</font>
<br><font size=2 face="Courier New">&nbsp; </font><font size=2 color=#008080 face="Courier New">&lt;</font><font size=2 color=#3f8080 face="Courier New">toc
</font><font size=2 color=#800080 face="Courier New">id</font><font size=2 face="Courier New">=</font><font size=2 color=#4200ff face="Courier New">&quot;/com.mitel.swb.help/toc.xml&quot;</font ><font size=2 color=#008080 face="Courier New">/&gt;</font>
<br><font size=2 face="Courier New">&nbsp;</font><font size=2 color=#008080 face="Courier New">&lt;/</font><font size=2 color=#3f8080 face="Courier New">tocOrder</font><font size=2 color=#008080 face="Courier New">&gt;</font>
<br><font size=2 color=#008080 face="Courier New">&lt;/</font><font size=2 color=#3f8080 face="Courier New">extensions</font><font size=2 color=#008080 face="Courier New">&gt;</font>
<br>
<br><font size=2 face="Courier New">Preferences node = </font><font size=2 color=#820040 face="Courier New"><b>new</b></font><font size=2 face="Courier New">
DefaultScope().getNode(</font><font size=2 color=#4200ff face="Courier New">&quot;org.eclipse.help.base&quot;</font><font size=2 face="Courier New">);
</font><font size=2 color=#3f8080 face="Courier New">//$NON-NLS-1$</font>
<br><font size=2 face="Courier New">node.put(</font><font size=2 color=#4200ff face="Courier New">&quot;help_home&quot;</font><font size=2 face="Courier New">,
</font><font size=2 color=#4200ff face="Courier New">&quot;/com.mitel.swb/content/welcome.html&quot; </font><font size=2 face="Courier New">);
</font><font size=2 color=#3f8080 face="Courier New">//$NON-NLS-1$ //$NON-NLS-2$</font>
<br>
<br><font size=2 face="Courier New">node = </font><font size=2 color=#820040 face="Courier New"><b>new</b></font><font size=2 face="Courier New">
DefaultScope().getNode(</font><font size=2 color=#4200ff face="Courier New">&quot;org.eclipse.help&quot;</font><font size=2 face="Courier New">);
</font><font size=2 color=#3f8080 face="Courier New">//$NON-NLS-1$</font>
<br><font size=2 face="Courier New">node.put(</font><font size=2 color=#4200ff face="Courier New">&quot;HELP_DATA&quot;</font><font size=2 face="Courier New">,
</font><font size=2 color=#4200ff face="Courier New">&quot;/com.mitel.swb/helpData.xml&quot;</font ><font size=2 face="Courier New">);
</font><font size=2 color=#3f8080 face="Courier New">//$NON-NLS-1$ //$NON-NLS-2$</font>
--=_alternative 0033D293802574B4_=--
Re: Not recognising helpdata.xml [message #474306 is a reply to message #474305] Fri, 29 August 2008 16:11 Go to previous messageGo to next message
Chris Goldthorpe is currently offline Chris GoldthorpeFriend
Messages: 815
Registered: July 2009
Senior Member
You need to add a plugin customization file with a HELP_DATA declaration
in it. When you say "Welcome works fine" do you mean "The help system
works fine"?

Phill_Perryman@Mitel.COM wrote:
>
> I have added the following nodes in my RCP ApplicationWorkbenchAdvisor
> class (see below). Welcome works fine but it is not recognising the
> helpData. I don't use a plugin_customisation file so programmatically
> add the nodes.
>
> In the root of the project (which is the main rcp project plugin) I have
> a helpData.xml file with the following contents. I want the main
> application help contents to appear first followed by the other help
> tocs. The main help toc is in the com.mitel.swb.help project called
> toc.xml and is marked as primary and appears in the help index (fourth
> entry because of alphabetic ordering).
>
> I export the project and check the helpData.xml file is contained in the
> jar which it is. I run the product and the entry is still fourth in the
> list.
>
> What am I doing wrong?
>
> <extensions>
> <tocOrder>
> <toc id="/com.mitel.swb.help/toc.xml"/>
> </tocOrder>
> </extensions>
>
> Preferences node = *new*
> DefaultScope().getNode("org.eclipse.help.base"); //$NON-NLS-1$
> node.put("help_home", "/com.mitel.swb/content/welcome.html");
> //$NON-NLS-1$ //$NON-NLS-2$
>
> node = *new* DefaultScope().getNode("org.eclipse.help"); //$NON-NLS-1$
> node.put("HELP_DATA", "/com.mitel.swb/helpData.xml"); //$NON-NLS-1$
> //$NON-NLS-2$
Re: Not recognising helpdata.xml [message #474322 is a reply to message #474306] Mon, 08 September 2008 07:59 Go to previous messageGo to next message
Phill Perryman is currently offline Phill PerrymanFriend
Messages: 214
Registered: July 2009
Senior Member
<br><font size=2 face="Arial">Sorry, been out. I don't use a plugin_customization
file and as we now have a lot of installed users using the update site
on 3.3 I don't see an easy way to introduce one now.</font>
<br>
<br><font size=2 face="Arial">Instead of this I set them programmatically.
The welcome page for instance is controlled by org.eclipse.help.base/help_home
and when I set that it functions as expected. However when I set the HELP_DATA
programatically I dont see any re-ordering of the toc when I open help.</font>
<br>
<br><tt><font size=2>You need to add a plugin customization file with a
HELP_DATA declaration <br>
in it. When you say &quot;Welcome works fine&quot; do you mean &quot;The
help system <br>
works fine&quot;?<br>
<br>
Phill_Perryman@Mitel.COM wrote:<br>
&gt; <br>
&gt; I have added the following nodes in my RCP ApplicationWorkbenchAdvisor
<br>
&gt; class (see below). Welcome works fine but it is not recognising the
<br>
&gt; helpData. I don't use a plugin_customisation file so programmatically
<br>
&gt; add the nodes.<br>
&gt; <br>
&gt; In the root of the project (which is the main rcp project plugin)
I have <br>
&gt; a helpData.xml file with the following contents. I want the main <br>
&gt; application help contents to appear first followed by the other help
<br>
&gt; tocs. The main help toc is in the com.mitel.swb.help project called
<br>
&gt; toc.xml and is marked as primary and appears in the help index (fourth
<br>
&gt; entry because of alphabetic ordering).<br>
&gt; <br>
&gt; I export the project and check the helpData.xml file is contained
in the <br>
&gt; jar which it is. I run the product and the entry is still fourth in
the <br>
&gt; list.<br>
&gt; <br>
&gt; What am I doing wrong?<br>
&gt; <br>
&gt; &lt;extensions&gt;<br>
&gt; &nbsp;&lt;tocOrder&gt;<br>
&gt; &nbsp; &lt;toc id=&quot;/com.mitel.swb.help/toc.xml&quot;/&gt;<br >
&gt; &nbsp;&lt;/tocOrder&gt;<br>
&gt; &lt;/extensions&gt;<br>
&gt; <br>
&gt; Preferences node = new <br>
&gt; DefaultScope().getNode(&quot;org.eclipse.help.base&q uot;); //$NON-NLS-1$<br>
&gt; node.put(&quot;help_home&quot;, &quot;/com.mitel.swb/content/welcome.html&quot;);
<br>
&gt; //$NON-NLS-1$ //$NON-NLS-2$<br>
&gt; <br>
&gt; node = new DefaultScope().getNode(&quot;org.eclipse.help&quot;) ; //$NON-NLS-1$<br>
&gt; node.put(&quot;HELP_DATA&quot;, &quot;/com.mitel.swb/helpData.xml&quot;);
//$NON-NLS-1$ <br>
&gt; //$NON-NLS-2$<br>
</font></tt>
Re: Not recognising helpdata.xml [message #474775 is a reply to message #474322] Wed, 12 November 2008 16:32 Go to previous messageGo to next message
Mike Melton is currently offline Mike MeltonFriend
Messages: 50
Registered: July 2009
Member
According to instructions published here, I've created a separate
customization plugin that sets the banner, CSSes used, Welcome page, and
nav tabs displayed, which all work just great. I'm really grateful for
that. However, ordering the TOC with helpData.xml doesn't seem to be
working as documented. Plug-ins are sorted alphabetically by the value of
plugin name.

Any suggestions?

Thanks!!
Re: Not recognising helpdata.xml [message #474778 is a reply to message #474775] Wed, 12 November 2008 19:12 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: nospam_kowalskilee.gmail.com

Hi Mike,

Would it be possible for you to post here the contents of:
your helpData.xml file
your plugin_customization.ini file

There might be some case-sensitive mix-up, or path issue that we could
see if you post the actual lines from those files.

--Lee Anne

Mike Melton wrote:
> According to instructions published here, I've created a separate
> customization plugin that sets the banner, CSSes used, Welcome page, and
> nav tabs displayed, which all work just great. I'm really grateful for
> that. However, ordering the TOC with helpData.xml doesn't seem to be
> working as documented. Plug-ins are sorted alphabetically by the value
> of plugin name.
>
> Any suggestions?
>
> Thanks!!
>
Re: Not recognising helpdata.xml [message #474780 is a reply to message #474778] Wed, 12 November 2008 22:09 Go to previous messageGo to next message
Mike Melton is currently offline Mike MeltonFriend
Messages: 50
Registered: July 2009
Member
Thanks, Lee Anne.

Here's the helpData.xml I'm using:

<?xml version="1.0" encoding="utf-8"?>
<extensions>
<tocOrder>
<toc id="/xenapp/xenapp-infocenter-demo.xml"/>
<toc
id="/passwordmanager/XenApp-Infocenter-Passord-Manager.xml"/ >
<toc id="/licensing/lic-eclipse.xml"/>
<toc id="/test/test-eclipse-help.xml"/>
</tocOrder>
</extensions>

Here's the plugin_customization.ini. I've tried a variety of combinations
for setting org.eclipse.help/HELP_DATA, but got the same results.

# plugin_customization.ini
# sets default values for plug-in-specific preferences
# keys are qualified by plug-in id
# e.g., org.eclipse.ui/RECENT_FILES=10
# java.io.Properties file (ISO 8859-1 with "\" escapes)
# "%key" are externalized strings defined in
plugin_customization.properties
# This file does not need to be translated.
# org.eclipse.ui/defaultPerspectiveId=org.eclipse.ui.resourceP erspective
# Do not add a prefix to text in the titlebar
org.eclipse.help.base/windowTitlePrefix=false
# Use the Citrix banner
org.eclipse.help.base/banner=/com.citrix.proddoc.ICbase/Bann er/banner.htm
org.eclipse.help.base/banner_height=60
# Turn off the keyword index and links view, which removes their tabs
org.eclipse.help.base/indexView=false
org.eclipse.help.base/linksView=false
# Order help books in table of contents
org.eclipse.help/HELP_DATA=PLUGINS_ROOT/com.citrix.proddoc.I Cbase/helpData.xml
# Use Citrix CSS
org.eclipse.help.base/topic_css=/com.citrix.proddoc.ICbase/C SS/book.css
org.eclipse.help.base/nav_css=/com.citrix.proddoc.ICbase/CSS /book.css
#
org.eclipse.help.base/disabled_css=/com.citrix.proddoc.ICbas e/CSS/book.css
# Use our Welcome page in stead of the Eclipse page
org.eclipse.help.base/help_home=/com.citrix.proddoc.ICbase/W elcome/welcome.html

Lee Anne wrote:

> Hi Mike,

> Would it be possible for you to post here the contents of:
> your helpData.xml file
> your plugin_customization.ini file

> There might be some case-sensitive mix-up, or path issue that we could
> see if you post the actual lines from those files.

> --Lee Anne
Re: Not recognising helpdata.xml [message #474782 is a reply to message #474780] Thu, 13 November 2008 14:51 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: nospam_kowalskilee.gmail.com

Hi Mike,

The portions of your toc ids in your helpData.xml file that are:
xenapp
passwordmanager
licensing
test

Are those the *plug-in* IDs that contain those toc xml files, or are
they the file directory names in which the xml toc files reside?

I have read the Eclipse help topic that describes the HELP_DATA format,
and I now think that those toc ids should have the plug-in ID also, and
not only file paths to the toc xml files.

Here is the help topic about HELP_DATA:
http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclips e.platform.doc.isv/guide/ua_help_setup_help_data.htm

Here is the paragraph about the toc id:
*id* - The unique identifier for this book. For XML file TOC
contributions, this is a path to the file in the form
"/<plugin_id>/<path>/<file>" (e.g.,
"/org.eclipse.platform.doc.user/toc.xml").

So that you would have both the plug-in ID beginning portion and then
the file path *if* the toc xml file was in a lower directory inside the
plug-in.

For example, if I have a plug-in set up like:
com.lak.test.doc directory contains:
plugin.xml
manifest/manifest.mf (contains Bundle-SymbolicName=com.lak.test.doc)
laktesttoc.xml

Then my helpData.xml line would be:
toc id="com.lak.test.doc/laktesttoc.xml"

If the toc xml file was in a subdirectory like:
com.lak.test.doc directory contains:
plugin.xml
manifest/manifest.mf (contains Bundle-SymbolicName=com.lak.test.doc)
toc/laktesttoc.xml

Then my helpData.xml line would be:
toc id="com.lak.test.doc/toc/laktesttoc.xml

I'm finding that in practice, the plug-in's filesystem directory is
typically the same name as its plug-in ID (Bundle-SymbolicName). This
can cause some confusion for humans, :-), because we read the name in
the examples in the Eclipse help and think that it means the file
directory names. But the file directory names do not have to match the
plug-in IDs that are specified in either plugin.xml or manifest.mf.
Eclipse cares about the plug-in ID in most situations. I could name my
Bundle-SymbolicName = goodlak, and then the plug-in ID would be goodlak,
to make the toc id="goodlak/laktesttoc.xml".

I stumbled on this paragraph in the help about this naming confusion
when I was reading about PLUGINS_ROOT:
"Note: When referencing content from another plug-in, be sure to use
the plug-in's id, as declared in its plugin.xml file, not its directory
name. While these are often the same in practice, it's important to
check that you are using the id and not the directory name."

That paragraph is found in this help topic, near the bottom of the topic:
http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclips e.platform.doc.isv/guide/ua_help_content_files.htm

Try including the plug-in IDs on those toc ids and see if it starts
working (restart clean, etc).

Hope this helps,
Lee Anne

Mike Melton wrote:
> Thanks, Lee Anne.
>
> Here's the helpData.xml I'm using:
>
> <?xml version="1.0" encoding="utf-8"?>
> <extensions>
> <tocOrder>
> <toc id="/xenapp/xenapp-infocenter-demo.xml"/>
> <toc
> id="/passwordmanager/XenApp-Infocenter-Passord-Manager.xml"/ >
> <toc id="/licensing/lic-eclipse.xml"/>
> <toc id="/test/test-eclipse-help.xml"/>
> </tocOrder>
> </extensions>
>
Re: Not recognising helpdata.xml [message #474783 is a reply to message #474782] Thu, 13 November 2008 14:53 Go to previous messageGo to next message
Eclipse UserFriend
Originally posted by: nospam_kowalskilee.gmail.com

One minor correction, should be:
META-INF/MANIFEST.MF
in my example below, and not manifest/manifest.mf

I haven't finished my morning coffee yet. :-)

--Lee Anne

Lee Anne wrote:
> Hi Mike,
>
> The portions of your toc ids in your helpData.xml file that are:
> xenapp
> passwordmanager
> licensing
> test
>
> Are those the *plug-in* IDs that contain those toc xml files, or are
> they the file directory names in which the xml toc files reside?
>
> I have read the Eclipse help topic that describes the HELP_DATA format,
> and I now think that those toc ids should have the plug-in ID also, and
> not only file paths to the toc xml files.
>
> Here is the help topic about HELP_DATA:
> http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclips e.platform.doc.isv/guide/ua_help_setup_help_data.htm
>
>
> Here is the paragraph about the toc id:
> *id* - The unique identifier for this book. For XML file TOC
> contributions, this is a path to the file in the form
> "/<plugin_id>/<path>/<file>" (e.g.,
> "/org.eclipse.platform.doc.user/toc.xml").
>
> So that you would have both the plug-in ID beginning portion and then
> the file path *if* the toc xml file was in a lower directory inside the
> plug-in.
>
> For example, if I have a plug-in set up like:
> com.lak.test.doc directory contains:
> plugin.xml
> manifest/manifest.mf (contains Bundle-SymbolicName=com.lak.test.doc)
> laktesttoc.xml
>
> Then my helpData.xml line would be:
> toc id="com.lak.test.doc/laktesttoc.xml"
>
> If the toc xml file was in a subdirectory like:
> com.lak.test.doc directory contains:
> plugin.xml
> manifest/manifest.mf (contains Bundle-SymbolicName=com.lak.test.doc)
> toc/laktesttoc.xml
>
> Then my helpData.xml line would be:
> toc id="com.lak.test.doc/toc/laktesttoc.xml
>
> I'm finding that in practice, the plug-in's filesystem directory is
> typically the same name as its plug-in ID (Bundle-SymbolicName). This
> can cause some confusion for humans, :-), because we read the name in
> the examples in the Eclipse help and think that it means the file
> directory names. But the file directory names do not have to match the
> plug-in IDs that are specified in either plugin.xml or manifest.mf.
> Eclipse cares about the plug-in ID in most situations. I could name my
> Bundle-SymbolicName = goodlak, and then the plug-in ID would be goodlak,
> to make the toc id="goodlak/laktesttoc.xml".
>
> I stumbled on this paragraph in the help about this naming confusion
> when I was reading about PLUGINS_ROOT:
> "Note: When referencing content from another plug-in, be sure to use
> the plug-in's id, as declared in its plugin.xml file, not its directory
> name. While these are often the same in practice, it's important to
> check that you are using the id and not the directory name."
>
> That paragraph is found in this help topic, near the bottom of the topic:
> http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclips e.platform.doc.isv/guide/ua_help_content_files.htm
>
>
> Try including the plug-in IDs on those toc ids and see if it starts
> working (restart clean, etc).
>
> Hope this helps,
> Lee Anne
>
> Mike Melton wrote:
>> Thanks, Lee Anne.
>>
>> Here's the helpData.xml I'm using:
>>
>> <?xml version="1.0" encoding="utf-8"?>
>> <extensions>
>> <tocOrder>
>> <toc id="/xenapp/xenapp-infocenter-demo.xml"/>
>> <toc
>> id="/passwordmanager/XenApp-Infocenter-Passord-Manager.xml"/ >
>> <toc id="/licensing/lic-eclipse.xml"/>
>> <toc id="/test/test-eclipse-help.xml"/>
>> </tocOrder>
>> </extensions>
>>
>
Re: Not recognising helpdata.xml [message #474895 is a reply to message #474783] Thu, 04 December 2008 22:22 Go to previous messageGo to next message
Mike Melton is currently offline Mike MeltonFriend
Messages: 50
Registered: July 2009
Member
Thanks for this, Lee Anne. My plugin IDs and directory names are the same.

I'll try some of the variations you suggested.

Sorry it took so long for me to respond. I was out of the office for a few
weeks.
Re: Not recognising helpdata.xml [message #474915 is a reply to message #474895] Wed, 17 December 2008 14:22 Go to previous message
Mike Melton is currently offline Mike MeltonFriend
Messages: 50
Registered: July 2009
Member
After installing a debug version of org.eclipse.help, I discovered that
there are problems with my implementation of Infocenter. (It's still
looking for old default help plug-ins I thought I had removed.)
helpData.xml works in the Infocenter implemented by our Web Services team
and available externally for customers.

After years of planning and work to get our content structured; choosing,
purchasing, and implememnting a content management system; and researching
Eclipse Help, our Infocenter beta finally went live today and looks great.
Thanks to all who responded to my questions over the past few months,
especially Lee Anne and Chris Goldthorpe.

Mike
Re: Not recognising helpdata.xml [message #619461 is a reply to message #474305] Fri, 29 August 2008 16:11 Go to previous message
Chris Goldthorpe is currently offline Chris GoldthorpeFriend
Messages: 815
Registered: July 2009
Senior Member
You need to add a plugin customization file with a HELP_DATA declaration
in it. When you say "Welcome works fine" do you mean "The help system
works fine"?

Phill_Perryman@Mitel.COM wrote:
>
> I have added the following nodes in my RCP ApplicationWorkbenchAdvisor
> class (see below). Welcome works fine but it is not recognising the
> helpData. I don't use a plugin_customisation file so programmatically
> add the nodes.
>
> In the root of the project (which is the main rcp project plugin) I have
> a helpData.xml file with the following contents. I want the main
> application help contents to appear first followed by the other help
> tocs. The main help toc is in the com.mitel.swb.help project called
> toc.xml and is marked as primary and appears in the help index (fourth
> entry because of alphabetic ordering).
>
> I export the project and check the helpData.xml file is contained in the
> jar which it is. I run the product and the entry is still fourth in the
> list.
>
> What am I doing wrong?
>
> <extensions>
> <tocOrder>
> <toc id="/com.mitel.swb.help/toc.xml"/>
> </tocOrder>
> </extensions>
>
> Preferences node = *new*
> DefaultScope().getNode("org.eclipse.help.base"); //$NON-NLS-1$
> node.put("help_home", "/com.mitel.swb/content/welcome.html");
> //$NON-NLS-1$ //$NON-NLS-2$
>
> node = *new* DefaultScope().getNode("org.eclipse.help"); //$NON-NLS-1$
> node.put("HELP_DATA", "/com.mitel.swb/helpData.xml"); //$NON-NLS-1$
> //$NON-NLS-2$
Re: Not recognising helpdata.xml [message #619850 is a reply to message #474306] Mon, 08 September 2008 07:59 Go to previous message
Phill Perryman is currently offline Phill PerrymanFriend
Messages: 214
Registered: July 2009
Senior Member
<br><font size=2 face="Arial">Sorry, been out. I don't use a plugin_customization
file and as we now have a lot of installed users using the update site
on 3.3 I don't see an easy way to introduce one now.</font>
<br>
<br><font size=2 face="Arial">Instead of this I set them programmatically.
The welcome page for instance is controlled by org.eclipse.help.base/help_home
and when I set that it functions as expected. However when I set the HELP_DATA
programatically I dont see any re-ordering of the toc when I open help.</font>
<br>
<br><tt><font size=2>You need to add a plugin customization file with a
HELP_DATA declaration <br>
in it. When you say &quot;Welcome works fine&quot; do you mean &quot;The
help system <br>
works fine&quot;?<br>
<br>
Phill_Perryman@Mitel.COM wrote:<br>
&gt; <br>
&gt; I have added the following nodes in my RCP ApplicationWorkbenchAdvisor
<br>
&gt; class (see below). Welcome works fine but it is not recognising the
<br>
&gt; helpData. I don't use a plugin_customisation file so programmatically
<br>
&gt; add the nodes.<br>
&gt; <br>
&gt; In the root of the project (which is the main rcp project plugin)
I have <br>
&gt; a helpData.xml file with the following contents. I want the main <br>
&gt; application help contents to appear first followed by the other help
<br>
&gt; tocs. The main help toc is in the com.mitel.swb.help project called
<br>
&gt; toc.xml and is marked as primary and appears in the help index (fourth
<br>
&gt; entry because of alphabetic ordering).<br>
&gt; <br>
&gt; I export the project and check the helpData.xml file is contained
in the <br>
&gt; jar which it is. I run the product and the entry is still fourth in
the <br>
&gt; list.<br>
&gt; <br>
&gt; What am I doing wrong?<br>
&gt; <br>
&gt; &lt;extensions&gt;<br>
&gt; &nbsp;&lt;tocOrder&gt;<br>
&gt; &nbsp; &lt;toc id=&quot;/com.mitel.swb.help/toc.xml&quot;/&gt;<br >
&gt; &nbsp;&lt;/tocOrder&gt;<br>
&gt; &lt;/extensions&gt;<br>
&gt; <br>
&gt; Preferences node = new <br>
&gt; DefaultScope().getNode(&quot;org.eclipse.help.base&q uot;); //$NON-NLS-1$<br>
&gt; node.put(&quot;help_home&quot;, &quot;/com.mitel.swb/content/welcome.html&quot;);
<br>
&gt; //$NON-NLS-1$ //$NON-NLS-2$<br>
&gt; <br>
&gt; node = new DefaultScope().getNode(&quot;org.eclipse.help&quot;) ; //$NON-NLS-1$<br>
&gt; node.put(&quot;HELP_DATA&quot;, &quot;/com.mitel.swb/helpData.xml&quot;);
//$NON-NLS-1$ <br>
&gt; //$NON-NLS-2$<br>
</font></tt>
Re: Not recognising helpdata.xml [message #621812 is a reply to message #474322] Wed, 12 November 2008 16:32 Go to previous message
Mike Melton is currently offline Mike MeltonFriend
Messages: 50
Registered: July 2009
Member
According to instructions published here, I've created a separate
customization plugin that sets the banner, CSSes used, Welcome page, and
nav tabs displayed, which all work just great. I'm really grateful for
that. However, ordering the TOC with helpData.xml doesn't seem to be
working as documented. Plug-ins are sorted alphabetically by the value of
plugin name.

Any suggestions?

Thanks!!
Re: Not recognising helpdata.xml [message #621815 is a reply to message #474775] Wed, 12 November 2008 19:12 Go to previous message
Eclipse UserFriend
Originally posted by: nospam_kowalskilee.gmail.com

Hi Mike,

Would it be possible for you to post here the contents of:
your helpData.xml file
your plugin_customization.ini file

There might be some case-sensitive mix-up, or path issue that we could
see if you post the actual lines from those files.

--Lee Anne

Mike Melton wrote:
> According to instructions published here, I've created a separate
> customization plugin that sets the banner, CSSes used, Welcome page, and
> nav tabs displayed, which all work just great. I'm really grateful for
> that. However, ordering the TOC with helpData.xml doesn't seem to be
> working as documented. Plug-ins are sorted alphabetically by the value
> of plugin name.
>
> Any suggestions?
>
> Thanks!!
>
Re: Not recognising helpdata.xml [message #621817 is a reply to message #474778] Wed, 12 November 2008 22:09 Go to previous message
Mike Melton is currently offline Mike MeltonFriend
Messages: 50
Registered: July 2009
Member
Thanks, Lee Anne.

Here's the helpData.xml I'm using:

<?xml version="1.0" encoding="utf-8"?>
<extensions>
<tocOrder>
<toc id="/xenapp/xenapp-infocenter-demo.xml"/>
<toc
id="/passwordmanager/XenApp-Infocenter-Passord-Manager.xml"/ >
<toc id="/licensing/lic-eclipse.xml"/>
<toc id="/test/test-eclipse-help.xml"/>
</tocOrder>
</extensions>

Here's the plugin_customization.ini. I've tried a variety of combinations
for setting org.eclipse.help/HELP_DATA, but got the same results.

# plugin_customization.ini
# sets default values for plug-in-specific preferences
# keys are qualified by plug-in id
# e.g., org.eclipse.ui/RECENT_FILES=10
# java.io.Properties file (ISO 8859-1 with "\" escapes)
# "%key" are externalized strings defined in
plugin_customization.properties
# This file does not need to be translated.
# org.eclipse.ui/defaultPerspectiveId=org.eclipse.ui.resourceP erspective
# Do not add a prefix to text in the titlebar
org.eclipse.help.base/windowTitlePrefix=false
# Use the Citrix banner
org.eclipse.help.base/banner=/com.citrix.proddoc.ICbase/Bann er/banner.htm
org.eclipse.help.base/banner_height=60
# Turn off the keyword index and links view, which removes their tabs
org.eclipse.help.base/indexView=false
org.eclipse.help.base/linksView=false
# Order help books in table of contents
org.eclipse.help/HELP_DATA=PLUGINS_ROOT/com.citrix.proddoc.I Cbase/helpData.xml
# Use Citrix CSS
org.eclipse.help.base/topic_css=/com.citrix.proddoc.ICbase/C SS/book.css
org.eclipse.help.base/nav_css=/com.citrix.proddoc.ICbase/CSS /book.css
#
org.eclipse.help.base/disabled_css=/com.citrix.proddoc.ICbas e/CSS/book.css
# Use our Welcome page in stead of the Eclipse page
org.eclipse.help.base/help_home=/com.citrix.proddoc.ICbase/W elcome/welcome.html

Lee Anne wrote:

> Hi Mike,

> Would it be possible for you to post here the contents of:
> your helpData.xml file
> your plugin_customization.ini file

> There might be some case-sensitive mix-up, or path issue that we could
> see if you post the actual lines from those files.

> --Lee Anne
Re: Not recognising helpdata.xml [message #621901 is a reply to message #474780] Thu, 13 November 2008 14:51 Go to previous message
Eclipse UserFriend
Originally posted by: nospam_kowalskilee.gmail.com

Hi Mike,

The portions of your toc ids in your helpData.xml file that are:
xenapp
passwordmanager
licensing
test

Are those the *plug-in* IDs that contain those toc xml files, or are
they the file directory names in which the xml toc files reside?

I have read the Eclipse help topic that describes the HELP_DATA format,
and I now think that those toc ids should have the plug-in ID also, and
not only file paths to the toc xml files.

Here is the help topic about HELP_DATA:
http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclips e.platform.doc.isv/guide/ua_help_setup_help_data.htm

Here is the paragraph about the toc id:
*id* - The unique identifier for this book. For XML file TOC
contributions, this is a path to the file in the form
"/<plugin_id>/<path>/<file>" (e.g.,
"/org.eclipse.platform.doc.user/toc.xml").

So that you would have both the plug-in ID beginning portion and then
the file path *if* the toc xml file was in a lower directory inside the
plug-in.

For example, if I have a plug-in set up like:
com.lak.test.doc directory contains:
plugin.xml
manifest/manifest.mf (contains Bundle-SymbolicName=com.lak.test.doc)
laktesttoc.xml

Then my helpData.xml line would be:
toc id="com.lak.test.doc/laktesttoc.xml"

If the toc xml file was in a subdirectory like:
com.lak.test.doc directory contains:
plugin.xml
manifest/manifest.mf (contains Bundle-SymbolicName=com.lak.test.doc)
toc/laktesttoc.xml

Then my helpData.xml line would be:
toc id="com.lak.test.doc/toc/laktesttoc.xml

I'm finding that in practice, the plug-in's filesystem directory is
typically the same name as its plug-in ID (Bundle-SymbolicName). This
can cause some confusion for humans, :-), because we read the name in
the examples in the Eclipse help and think that it means the file
directory names. But the file directory names do not have to match the
plug-in IDs that are specified in either plugin.xml or manifest.mf.
Eclipse cares about the plug-in ID in most situations. I could name my
Bundle-SymbolicName = goodlak, and then the plug-in ID would be goodlak,
to make the toc id="goodlak/laktesttoc.xml".

I stumbled on this paragraph in the help about this naming confusion
when I was reading about PLUGINS_ROOT:
"Note: When referencing content from another plug-in, be sure to use
the plug-in's id, as declared in its plugin.xml file, not its directory
name. While these are often the same in practice, it's important to
check that you are using the id and not the directory name."

That paragraph is found in this help topic, near the bottom of the topic:
http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclips e.platform.doc.isv/guide/ua_help_content_files.htm

Try including the plug-in IDs on those toc ids and see if it starts
working (restart clean, etc).

Hope this helps,
Lee Anne

Mike Melton wrote:
> Thanks, Lee Anne.
>
> Here's the helpData.xml I'm using:
>
> <?xml version="1.0" encoding="utf-8"?>
> <extensions>
> <tocOrder>
> <toc id="/xenapp/xenapp-infocenter-demo.xml"/>
> <toc
> id="/passwordmanager/XenApp-Infocenter-Passord-Manager.xml"/ >
> <toc id="/licensing/lic-eclipse.xml"/>
> <toc id="/test/test-eclipse-help.xml"/>
> </tocOrder>
> </extensions>
>
Re: Not recognising helpdata.xml [message #621902 is a reply to message #474782] Thu, 13 November 2008 14:53 Go to previous message
Eclipse UserFriend
Originally posted by: nospam_kowalskilee.gmail.com

One minor correction, should be:
META-INF/MANIFEST.MF
in my example below, and not manifest/manifest.mf

I haven't finished my morning coffee yet. :-)

--Lee Anne

Lee Anne wrote:
> Hi Mike,
>
> The portions of your toc ids in your helpData.xml file that are:
> xenapp
> passwordmanager
> licensing
> test
>
> Are those the *plug-in* IDs that contain those toc xml files, or are
> they the file directory names in which the xml toc files reside?
>
> I have read the Eclipse help topic that describes the HELP_DATA format,
> and I now think that those toc ids should have the plug-in ID also, and
> not only file paths to the toc xml files.
>
> Here is the help topic about HELP_DATA:
> http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclips e.platform.doc.isv/guide/ua_help_setup_help_data.htm
>
>
> Here is the paragraph about the toc id:
> *id* - The unique identifier for this book. For XML file TOC
> contributions, this is a path to the file in the form
> "/<plugin_id>/<path>/<file>" (e.g.,
> "/org.eclipse.platform.doc.user/toc.xml").
>
> So that you would have both the plug-in ID beginning portion and then
> the file path *if* the toc xml file was in a lower directory inside the
> plug-in.
>
> For example, if I have a plug-in set up like:
> com.lak.test.doc directory contains:
> plugin.xml
> manifest/manifest.mf (contains Bundle-SymbolicName=com.lak.test.doc)
> laktesttoc.xml
>
> Then my helpData.xml line would be:
> toc id="com.lak.test.doc/laktesttoc.xml"
>
> If the toc xml file was in a subdirectory like:
> com.lak.test.doc directory contains:
> plugin.xml
> manifest/manifest.mf (contains Bundle-SymbolicName=com.lak.test.doc)
> toc/laktesttoc.xml
>
> Then my helpData.xml line would be:
> toc id="com.lak.test.doc/toc/laktesttoc.xml
>
> I'm finding that in practice, the plug-in's filesystem directory is
> typically the same name as its plug-in ID (Bundle-SymbolicName). This
> can cause some confusion for humans, :-), because we read the name in
> the examples in the Eclipse help and think that it means the file
> directory names. But the file directory names do not have to match the
> plug-in IDs that are specified in either plugin.xml or manifest.mf.
> Eclipse cares about the plug-in ID in most situations. I could name my
> Bundle-SymbolicName = goodlak, and then the plug-in ID would be goodlak,
> to make the toc id="goodlak/laktesttoc.xml".
>
> I stumbled on this paragraph in the help about this naming confusion
> when I was reading about PLUGINS_ROOT:
> "Note: When referencing content from another plug-in, be sure to use
> the plug-in's id, as declared in its plugin.xml file, not its directory
> name. While these are often the same in practice, it's important to
> check that you are using the id and not the directory name."
>
> That paragraph is found in this help topic, near the bottom of the topic:
> http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclips e.platform.doc.isv/guide/ua_help_content_files.htm
>
>
> Try including the plug-in IDs on those toc ids and see if it starts
> working (restart clean, etc).
>
> Hope this helps,
> Lee Anne
>
> Mike Melton wrote:
>> Thanks, Lee Anne.
>>
>> Here's the helpData.xml I'm using:
>>
>> <?xml version="1.0" encoding="utf-8"?>
>> <extensions>
>> <tocOrder>
>> <toc id="/xenapp/xenapp-infocenter-demo.xml"/>
>> <toc
>> id="/passwordmanager/XenApp-Infocenter-Passord-Manager.xml"/ >
>> <toc id="/licensing/lic-eclipse.xml"/>
>> <toc id="/test/test-eclipse-help.xml"/>
>> </tocOrder>
>> </extensions>
>>
>
Re: Not recognising helpdata.xml [message #622626 is a reply to message #474783] Thu, 04 December 2008 22:22 Go to previous message
Mike Melton is currently offline Mike MeltonFriend
Messages: 50
Registered: July 2009
Member
Thanks for this, Lee Anne. My plugin IDs and directory names are the same.

I'll try some of the variations you suggested.

Sorry it took so long for me to respond. I was out of the office for a few
weeks.
Re: Not recognising helpdata.xml [message #622703 is a reply to message #474895] Wed, 17 December 2008 14:22 Go to previous message
Mike Melton is currently offline Mike MeltonFriend
Messages: 50
Registered: July 2009
Member
After installing a debug version of org.eclipse.help, I discovered that
there are problems with my implementation of Infocenter. (It's still
looking for old default help plug-ins I thought I had removed.)
helpData.xml works in the Infocenter implemented by our Web Services team
and available externally for customers.

After years of planning and work to get our content structured; choosing,
purchasing, and implememnting a content management system; and researching
Eclipse Help, our Infocenter beta finally went live today and looks great.
Thanks to all who responded to my questions over the past few months,
especially Lee Anne and Chris Goldthorpe.

Mike
Previous Topic:Internationalize RCP help
Next Topic:Is there a preference key to set "Link with Contents" to "yes"?
Goto Forum:
  


Current Time: Thu Nov 27 14:57:05 GMT 2014

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

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