Home » Eclipse Projects » Eclipse Platform » Newbie help topic plugin question
| Newbie help topic plugin question [message #327543] |
Thu, 24 April 2008 08:30  |
Eclipse User |
|
|
|
Originally posted by: msamet.gmail.com
Hi,
I'm having an issue with loading a new help plugin I just tried to create.
I'm running Eclipse 3.3 with PDE. I just created a new Plug-in project
following the "Plug-in with sample help content" template. Everything
seemed OK while creating it... I created a valid toc.xml and the
corresponding HTML files.
I didn't create an index - I figured that just for testing this thing, I
could live with indexing on the fly rather than pre-indexing.
When I exported the plugin to my eclipse install dir (inside plugins) and
restarted eclipse, I got the following error in my Error log:
Error reading help table of contents file /"com.mycompany/toc.xml"
(skipping file)
Upon getting the details of that error, it's rightly claiming that it's a
FileNotFound exception. This is true, it's supposed to be loading
"com.mycompany.myhelpexample/toc.xml"! It looks like it's not getting the
full plugin or path name to load the file. I looked around and couldn't
figure out what setting I might need to fix this.
Anyone have any idea?
Also, sorry if this isn't the correct group to post in -- let me know and
I can post in the proper place.
Thanks!
-Matt
|
|
|
| Re: Newbie help topic plugin question [message #327555 is a reply to message #327543] |
Thu, 24 April 2008 13:42  |
| Eclipse User |
|
|
|
Originally posted by: merks.ca.ibm.com
Matt,
Is it possible that you don't have the necessary files specified in your
build.properties so they aren't ending up in the actual deployed plugin?
Matt Samet wrote:
> Hi,
>
> I'm having an issue with loading a new help plugin I just tried to
> create.
>
> I'm running Eclipse 3.3 with PDE. I just created a new Plug-in
> project following the "Plug-in with sample help content" template.
> Everything seemed OK while creating it... I created a valid toc.xml
> and the corresponding HTML files.
>
> I didn't create an index - I figured that just for testing this thing,
> I could live with indexing on the fly rather than pre-indexing.
>
> When I exported the plugin to my eclipse install dir (inside plugins)
> and restarted eclipse, I got the following error in my Error log:
>
> Error reading help table of contents file /"com.mycompany/toc.xml"
> (skipping file)
>
> Upon getting the details of that error, it's rightly claiming that
> it's a FileNotFound exception. This is true, it's supposed to be
> loading "com.mycompany.myhelpexample/toc.xml"! It looks like it's not
> getting the full plugin or path name to load the file. I looked
> around and couldn't figure out what setting I might need to fix this.
>
> Anyone have any idea?
>
> Also, sorry if this isn't the correct group to post in -- let me know
> and I can post in the proper place.
>
> Thanks!
> -Matt
>
|
|
|
| Re: Newbie help topic plugin question [message #327559 is a reply to message #327555] |
Thu, 24 April 2008 16:55 |
| Eclipse User |
|
|
|
Originally posted by: msamet.gmail.com
Hi Ed,
Possibly... here's my build.properties:
bin.includes = plugin.xml,\
META-INF/,\
*.xml,\
build.properties,\
doc.zip
This was pretty much auto-generated. I originally tried having my whole
doc/ folder embedded in the plugin, but I got the same error, so I tried
zipping it up and putting it in there as doc.zip.
Here's my plugin.xml, hopefully it's something in here:
<?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.0"?>
<plugin>
<extension
id="com.mycompany.myhelpexample"
name="Help example"
point="org.eclipse.help.toc">
<toc
file="toc.xml"
primary="true">
</toc>
</extension>
</plugin>
And here's my MANIFEST.MF:
Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Help example
Bundle-SymbolicName: com.mycompany.myhelpexample; singleton:=true
Bundle-Version: 1.0.0
Bundle-Vendor: My company
Thanks,
-Matt
|
|
|
| Re: Newbie help topic plugin question [message #327561 is a reply to message #327559] |
Thu, 24 April 2008 17:11 |
| Eclipse User |
|
|
|
Originally posted by: merks.ca.ibm.com
Matt,
It looks like it should be okay. I don't see where it would get
com.mycompany without the myhelpexample part from, so I'm fresh out of
ideas... Maybe settings some breakpoints to see what the framework is
doing would help...
Matt Samet wrote:
> Hi Ed,
>
> Possibly... here's my build.properties:
>
> bin.includes = plugin.xml,\
> META-INF/,\
> *.xml,\
> build.properties,\
> doc.zip
>
> This was pretty much auto-generated. I originally tried having my
> whole doc/ folder embedded in the plugin, but I got the same error, so
> I tried zipping it up and putting it in there as doc.zip.
>
> Here's my plugin.xml, hopefully it's something in here:
>
> <?xml version="1.0" encoding="UTF-8"?>
> <?eclipse version="3.0"?>
> <plugin>
>
> <extension
> id="com.mycompany.myhelpexample"
> name="Help example"
> point="org.eclipse.help.toc">
> <toc
> file="toc.xml"
> primary="true">
> </toc>
> </extension>
>
> </plugin>
>
> And here's my MANIFEST.MF:
>
> Manifest-Version: 1.0
> Bundle-ManifestVersion: 2
> Bundle-Name: Help example
> Bundle-SymbolicName: com.mycompany.myhelpexample; singleton:=true
> Bundle-Version: 1.0.0
> Bundle-Vendor: My company
>
> Thanks,
> -Matt
>
|
|
| | |
| Re: Newbie help topic plugin question [message #327567 is a reply to message #327565] |
Thu, 24 April 2008 18:51 |
| Eclipse User |
|
|
|
Originally posted by: msamet.gmail.com
Ed,
Yeah, I understand what you're saying... I think I'm going to try that
method now and see how it's computing the path.
FYI, I'm still having the same problem after trying this fresh.
Here's what I did, from start to finish:
1) Downloaded the latest Eclipse Europa for J2EE developers (this includes
the PDE) and saved it to my desktop. I then unzipped the archive and ran
eclipse.exe.
2) Created new workspace: C:\tmpworkspace
3) Created new plugin project, project name "com.mycompany.myhelpexample";
un-check "Create a java project", click Next; click Next
a) Selected template "Plug-in with sample help content"; click Next
b) Un-checked "Generate a primary table of contents for testing";
click Finish
4) Didn't change anything in MANIFEST.MF, just exported the plugin and
moved the created .jar file to the running eclipse instance's plugins dir;
restarted eclipse.
Result:
The help topic doesn't show up at all in the help topics view. I didn't
even get an error in the Error Log about it failing to find the toc.xml
file.
Isn't this supposed to work out of the box? I'm not really doing anything
that crazy here...
I'm running Windows Vista, if that matters, next I suppose I'll try it on
XP.
Thanks
-Matt
|
|
|
| Re: Newbie help topic plugin question [message #327568 is a reply to message #327567] |
Thu, 24 April 2008 18:55 |
 Steve Blass
Messages: 276
Registered: July 2009 |
Senior Member |
|
|
Try it again but generate the table of contents.
Matt Samet wrote:
> Ed,
>
> Yeah, I understand what you're saying... I think I'm going to try that
> method now and see how it's computing the path.
> FYI, I'm still having the same problem after trying this fresh.
>
> Here's what I did, from start to finish:
>
> 1) Downloaded the latest Eclipse Europa for J2EE developers (this
> includes the PDE) and saved it to my desktop. I then unzipped the
> archive and ran eclipse.exe.
> 2) Created new workspace: C:\tmpworkspace
> 3) Created new plugin project, project name
> "com.mycompany.myhelpexample"; un-check "Create a java project", click
> Next; click Next
> a) Selected template "Plug-in with sample help content"; click Next
> b) Un-checked "Generate a primary table of contents for testing";
> click Finish
> 4) Didn't change anything in MANIFEST.MF, just exported the plugin and
> moved the created .jar file to the running eclipse instance's plugins
> dir; restarted eclipse.
>
> Result: The help topic doesn't show up at all in the help topics view.
> I didn't even get an error in the Error Log about it failing to find the
> toc.xml file.
>
> Isn't this supposed to work out of the box? I'm not really doing
> anything that crazy here...
>
> I'm running Windows Vista, if that matters, next I suppose I'll try it
> on XP.
>
> Thanks
> -Matt
>
|
|
|
| Re: Newbie help topic plugin question [message #327569 is a reply to message #327568] |
Thu, 24 April 2008 19:17 |
| Eclipse User |
|
|
|
Originally posted by: msamet.gmail.com
That worked! :)
Thanks...
I'm wondering why that worked though...
If you don't select that option, what other step(s) need to be done to get
the plugin working?
-Matt
Steve Blass wrote:
> Try it again but generate the table of contents.
> Matt Samet wrote:
>> Ed,
>>
>> Yeah, I understand what you're saying... I think I'm going to try that
>> method now and see how it's computing the path.
>> FYI, I'm still having the same problem after trying this fresh.
>>
>> Here's what I did, from start to finish:
>>
>> 1) Downloaded the latest Eclipse Europa for J2EE developers (this
>> includes the PDE) and saved it to my desktop. I then unzipped the
>> archive and ran eclipse.exe.
>> 2) Created new workspace: C:tmpworkspace
>> 3) Created new plugin project, project name
>> "com.mycompany.myhelpexample"; un-check "Create a java project", click
>> Next; click Next
>> a) Selected template "Plug-in with sample help content"; click Next
>> b) Un-checked "Generate a primary table of contents for testing";
>> click Finish
>> 4) Didn't change anything in MANIFEST.MF, just exported the plugin and
>> moved the created .jar file to the running eclipse instance's plugins
>> dir; restarted eclipse.
>>
>> Result: The help topic doesn't show up at all in the help topics view.
>> I didn't even get an error in the Error Log about it failing to find the
>> toc.xml file.
>>
>> Isn't this supposed to work out of the box? I'm not really doing
>> anything that crazy here...
>>
>> I'm running Windows Vista, if that matters, next I suppose I'll try it
>> on XP.
>>
>> Thanks
>> -Matt
>>
|
|
|
| Re: Newbie help topic plugin question [message #327731 is a reply to message #327569] |
Tue, 29 April 2008 16:37 |
Steve Blass
Messages: 276
Registered: July 2009 |
Senior Member |
|
|
The help content you create needs to be 'contributed' to the help
system. Constructing a primary table of contents provides scaffolding
to do that. The other approach is to contribute your help content to
some level of some existing help content. The docs on how the help
system works can explain it better than I.
-
Steve
Matt Samet wrote:
> That worked! :) Thanks...
>
> I'm wondering why that worked though...
> If you don't select that option, what other step(s) need to be done to
> get the plugin working?
> -Matt
>
> Steve Blass wrote:
>
>> Try it again but generate the table of contents.
>
>> Matt Samet wrote:
>>> Ed,
>>>
>>> Yeah, I understand what you're saying... I think I'm going to try
>>> that method now and see how it's computing the path. FYI, I'm still
>>> having the same problem after trying this fresh.
>>>
>>> Here's what I did, from start to finish:
>>>
>>> 1) Downloaded the latest Eclipse Europa for J2EE developers (this
>>> includes the PDE) and saved it to my desktop. I then unzipped the
>>> archive and ran eclipse.exe.
>>> 2) Created new workspace: C:tmpworkspace
>>> 3) Created new plugin project, project name
>>> "com.mycompany.myhelpexample"; un-check "Create a java project",
>>> click Next; click Next
>>> a) Selected template "Plug-in with sample help content"; click Next
>>> b) Un-checked "Generate a primary table of contents for testing";
>>> click Finish
>>> 4) Didn't change anything in MANIFEST.MF, just exported the plugin
>>> and moved the created .jar file to the running eclipse instance's
>>> plugins dir; restarted eclipse.
>>>
>>> Result: The help topic doesn't show up at all in the help topics
>>> view. I didn't even get an error in the Error Log about it failing
>>> to find the toc.xml file.
>>>
>>> Isn't this supposed to work out of the box? I'm not really doing
>>> anything that crazy here...
>>>
>>> I'm running Windows Vista, if that matters, next I suppose I'll try
>>> it on XP.
>>>
>>> Thanks
>>> -Matt
>>>
>
>
|
|
|
Goto Forum:
Current Time: Sat Jul 27 16:39:06 GMT 2024
Powered by FUDForum. Page generated in 0.04298 seconds |
] 
Search
Help
Register
Login
Home
