Home » Eclipse Projects » Platform - User Assistance (UA) » Not recognising helpdata.xml
| | | |
Re: Not recognising helpdata.xml [message #474778 is a reply to message #474775] |
Wed, 12 November 2008 19:12 |
Eclipse User |
|
|
|
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 #474782 is a reply to message #474780] |
Thu, 13 November 2008 14:51 |
Eclipse User |
|
|
|
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 |
Eclipse User |
|
|
|
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 #621815 is a reply to message #474775] |
Wed, 12 November 2008 19:12 |
Eclipse User |
|
|
|
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 #621901 is a reply to message #474780] |
Thu, 13 November 2008 14:51 |
Eclipse User |
|
|
|
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 |
Eclipse User |
|
|
|
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>
>>
>
|
|
| | |
Goto Forum:
Current Time: Mon Sep 23 15:54:42 GMT 2024
Powered by FUDForum. Page generated in 0.04600 seconds
|