Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Platform - User Assistance (UA) » Re: Problem with Help system in Eclipse 3.3.1.1
Re: Problem with Help system in Eclipse 3.3.1.1 [message #471460] Sun, 20 January 2008 05:06 Go to next message
Eclipse UserFriend
Originally posted by: nospam_kowalskilee.gmail.com

Anand Narasimhan wrote:
> Hi,
>
> I am seeing a strange problem in the help system in 3.3.1.1. In our RCP
> application, we have online help. If I click on a topic in the contents
> window, the help for the wrong topic is shown. For example if I have the
> following topics
>
> Main Topic
> - Sub Topic 1
> - Sub Topic 2
> - Sub Topic 3
> - Sub Topic 4
>
> If I click on Sub Topic 1, I see a document with just a title that says
> "What's New"
>
> If I click on Sub Topic 3, I see the contents for Sub Topic 1
> If I click on Sub Topic 4, I see the contents for Sub Topic 2
>
> and so on.
>
> The same help plug-ins seems to work fine in 3.2 and 3.4.
> Is there a bug in 3.3 in the help system that would cause this problem?
>
> Thanks
> Anand
>

I'm adding the eclipse.platform.ua newsgroup to this thread, as that
newsgroup covers the help system.

Anand, can you provide here the portion of your toc.xml file that has
the contents that is related to the "Main Topic" and "Sub Topics" that
are showing this behavior?

I'm not aware of any bug in 3.3 that would cause this particular
problem. Do you have a document with a title that is "What's New"? Did
the toc.xml file get changed somehow without shutting down and
restarting the application? Are you starting up with the the osgi
parameter -clean to refresh the Eclipse configuration state between
startups/shutdowns?

--Lee Anne
Re: Problem with Help system in Eclipse 3.3.1.1 [message #471462 is a reply to message #471460] Sun, 20 January 2008 18:53 Go to previous messageGo to next message
Anand Narasimhan is currently offline Anand NarasimhanFriend
Messages: 104
Registered: July 2009
Senior Member
Hi Lee Anne,

Thanks for the reply. The documentation plugins are written by another
team. I am trying to debug for them. I am still trying to understand the
problem myself.

Here is the information you wanted.

There are two plugins where the contents are distributed. The base
plugins defines primary TOC like this.

<?xml version="1.0"?>

<plugin
name = "%pluginName"
id = "com.cisco.nm.cmp.client.doc.base"
version = "1.0.0"
provider-name="%providerName">

<!-- ============================================== -->
<!-- Define the main book -->
<!-- ============================================== -->

<extension point="org.eclipse.help.toc">
<toc file="book.xml" primary="true" />
</extension>

<!-- =============================================== -->
<!-- Link the sections into the book -->
<!-- =============================================== -->

<extension point="org.eclipse.help.toc">
<toc file="book-isdk.xml" />
<toc file="book-vsdk.xml" />
</extension>

</plugin>


The book.xml has the following:

<toc label="Cisco Active Network Abstraction (ANA) Help" topic="book.html">


<!-- *************************** -->
<!-- What's New -->

<topic label="What's New">
<anchor id="Base-new" />
<anchor id="anchor-new" />
</topic>


<!-- *************************** -->
<!-- Overview -->

<topic label="Overview">
<anchor id="Base-over" />
<anchor id="anchor-over" />
</topic>

<!-- *************************** -->
<!-- Getting Started -->

<topic label="Getting Started">
<anchor id="Base-getstart" />
<anchor id="anchor-getstart" />
</topic>

<!-- *************************** -->
<!-- Device and Network Management -->

<topic label="Device and Network Management">
<anchor id="Base-devmgmt" />
<anchor id="anchor-devmgmt" />
</topic>

<!-- *************************** -->
<!-- Configuration Management -->

<topic label="Configuration Management">
<anchor id="Base-config" />
<anchor id="anchor-config" />
</topic>

</toc>

They don't have the "What's new" and "Getting Started" contents yet.
According to the documentation team, if a topic listed in the book.xml
is not installed, eclipse 3.2 or 3.4, would ignore those, but in 3.3 it
seems work differently.

In this case, since "What's new" is not installed, clicking on
"Overview" seems to be looking for "What's New" topic.

Thanks
Anand

Lee Anne wrote:
> Anand Narasimhan wrote:
>> Hi,
>>
>> I am seeing a strange problem in the help system in 3.3.1.1. In our
>> RCP application, we have online help. If I click on a topic in the
>> contents window, the help for the wrong topic is shown. For example if
>> I have the following topics
>>
>> Main Topic
>> - Sub Topic 1
>> - Sub Topic 2
>> - Sub Topic 3
>> - Sub Topic 4
>>
>> If I click on Sub Topic 1, I see a document with just a title that
>> says "What's New"
>>
>> If I click on Sub Topic 3, I see the contents for Sub Topic 1
>> If I click on Sub Topic 4, I see the contents for Sub Topic 2
>>
>> and so on.
>>
>> The same help plug-ins seems to work fine in 3.2 and 3.4.
>> Is there a bug in 3.3 in the help system that would cause this problem?
>>
>> Thanks
>> Anand
>>
>
> I'm adding the eclipse.platform.ua newsgroup to this thread, as that
> newsgroup covers the help system.
>
> Anand, can you provide here the portion of your toc.xml file that has
> the contents that is related to the "Main Topic" and "Sub Topics" that
> are showing this behavior?
>
> I'm not aware of any bug in 3.3 that would cause this particular
> problem. Do you have a document with a title that is "What's New"? Did
> the toc.xml file get changed somehow without shutting down and
> restarting the application? Are you starting up with the the osgi
> parameter -clean to refresh the Eclipse configuration state between
> startups/shutdowns?
>
> --Lee Anne


--
____________________________________________________________ _____________________

Anand Narasimhan
anandn@cisco.com
Re: Problem with Help system in Eclipse 3.3.1.1 [message #471522 is a reply to message #471460] Mon, 21 January 2008 17:17 Go to previous messageGo to next message
Chris Goldthorpe is currently offline Chris GoldthorpeFriend
Messages: 815
Registered: July 2009
Senior Member
This might be the same problem as was described in Bug 205189. If you
can download the latest 3.3 maintenance build you will be able to see if
it is fixed.
Re: Problem with Help system in Eclipse 3.3.1.1 [message #471525 is a reply to message #471522] Mon, 21 January 2008 20:20 Go to previous messageGo to next message
Anand Narasimhan is currently offline Anand NarasimhanFriend
Messages: 104
Registered: July 2009
Senior Member
Chris,

Thanks. The reply. The description of the bug seems to be like the
problem I am having. Is 3.3.1.1 a maintenance stream. The bug talks
about being fixed in a 3.3 maintenance stream (just like you said) and
also in 3.3.2.

I am using 3.3.1.1

Thanks
Anand

Chris Goldthorpe wrote:
> This might be the same problem as was described in Bug 205189. If you
> can download the latest 3.3 maintenance build you will be able to see if
> it is fixed.


--
____________________________________________________________ _____________________

Anand Narasimhan
anandn@cisco.com
Re: Problem with Help system in Eclipse 3.3.1.1 [message #471526 is a reply to message #471525] Mon, 21 January 2008 20:43 Go to previous messageGo to next message
Anand Narasimhan is currently offline Anand NarasimhanFriend
Messages: 104
Registered: July 2009
Senior Member
I applied the patch mentioned in this bug to the 3.3.1.1 source. It did
not fix the problem.

BTW: Can I attach screen shots to this posting, so it is easy to see the
problem I am seeing.

Thanks
Anand

Anand Narasimhan wrote:
> Chris,
>
> Thanks. The reply. The description of the bug seems to be like the
> problem I am having. Is 3.3.1.1 a maintenance stream. The bug talks
> about being fixed in a 3.3 maintenance stream (just like you said) and
> also in 3.3.2.
>
> I am using 3.3.1.1
>
> Thanks
> Anand
>
> Chris Goldthorpe wrote:
>> This might be the same problem as was described in Bug 205189. If you
>> can download the latest 3.3 maintenance build you will be able to see
>> if it is fixed.
>
>


--
____________________________________________________________ _____________________

Anand Narasimhan
anandn@cisco.com
Re: Problem with Help system in Eclipse 3.3.1.1 [message #471527 is a reply to message #471526] Mon, 21 January 2008 20:53 Go to previous messageGo to next message
Anand Narasimhan is currently offline Anand NarasimhanFriend
Messages: 104
Registered: July 2009
Senior Member
One more thing. I tried to run it thru debugger.
The call ITopic[] subtopics = topic.getSubtopics(); in NavServlet is
returning an empty array, so the the loop that contains the patched code
is not even executed.


Anand

Anand Narasimhan wrote:
> I applied the patch mentioned in this bug to the 3.3.1.1 source. It did
> not fix the problem.
>
> BTW: Can I attach screen shots to this posting, so it is easy to see the
> problem I am seeing.
>
> Thanks
> Anand
>
> Anand Narasimhan wrote:
>> Chris,
>>
>> Thanks. The reply. The description of the bug seems to be like the
>> problem I am having. Is 3.3.1.1 a maintenance stream. The bug talks
>> about being fixed in a 3.3 maintenance stream (just like you said) and
>> also in 3.3.2.
>>
>> I am using 3.3.1.1
>>
>> Thanks
>> Anand
>>
>> Chris Goldthorpe wrote:
>>> This might be the same problem as was described in Bug 205189. If you
>>> can download the latest 3.3 maintenance build you will be able to see
>>> if it is fixed.
>>
>>
>
>


--
____________________________________________________________ _____________________

Anand Narasimhan
anandn@cisco.com
Re: Problem with Help system in Eclipse 3.3.1.1 [message #471528 is a reply to message #471527] Mon, 21 January 2008 22:14 Go to previous messageGo to next message
Chris Goldthorpe is currently offline Chris GoldthorpeFriend
Messages: 815
Registered: July 2009
Senior Member
In that case can you file a bug report and attach a plugin which shows
the problem?
Re: Problem with Help system in Eclipse 3.3.1.1 [message #471529 is a reply to message #471528] Mon, 21 January 2008 23:53 Go to previous messageGo to next message
Anand Narasimhan is currently offline Anand NarasimhanFriend
Messages: 104
Registered: July 2009
Senior Member
Filed a bug agains UA. Bug ID: 216064
https://bugs.eclipse.org/bugs/show_bug.cgi?id=216064

Anand

Chris Goldthorpe wrote:
> In that case can you file a bug report and attach a plugin which shows
> the problem?


--
____________________________________________________________ _____________________

Anand Narasimhan
anandn@cisco.com
Re: Problem with Help system in Eclipse 3.3.1.1 [message #471530 is a reply to message #471529] Tue, 22 January 2008 03:12 Go to previous message
Anand Narasimhan is currently offline Anand NarasimhanFriend
Messages: 104
Registered: July 2009
Senior Member
The problem seems to be in TocFragmentServlet.Serializer class.
In serializeChildTopics the href is being constructed using the index of
the child topic in the topics array.

In 3.3 the child topics returned is only the enabled topics (ITopic[]
subtopics = EnabledTopicUtils.getEnabled(topic.getSubtopics());)

So this already returns the only the enabled topic, so the child topic
index is wrong.

In 3.4, child topics are obtained using topic.getSubTopics and in the
loop, if a child topic is not enabled, it is skipped. so the index in
addSuffix method is correct.


This is a critical problem for us. We cannot migrate to 3.4 yet. Is
there a way to get a patch fix for this problem?

Thanks
Anand


Anand Narasimhan wrote:
> Filed a bug agains UA. Bug ID: 216064
> https://bugs.eclipse.org/bugs/show_bug.cgi?id=216064
>
> Anand
>
> Chris Goldthorpe wrote:
>> In that case can you file a bug report and attach a plugin which shows
>> the problem?
>
>


--
____________________________________________________________ _____________________

Anand Narasimhan
anandn@cisco.com
Re: Problem with Help system in Eclipse 3.3.1.1 [message #606955 is a reply to message #471460] Sun, 20 January 2008 18:53 Go to previous message
Anand Narasimhan is currently offline Anand NarasimhanFriend
Messages: 104
Registered: July 2009
Senior Member
Hi Lee Anne,

Thanks for the reply. The documentation plugins are written by another
team. I am trying to debug for them. I am still trying to understand the
problem myself.

Here is the information you wanted.

There are two plugins where the contents are distributed. The base
plugins defines primary TOC like this.

<?xml version="1.0"?>

<plugin
name = "%pluginName"
id = "com.cisco.nm.cmp.client.doc.base"
version = "1.0.0"
provider-name="%providerName">

<!-- ============================================== -->
<!-- Define the main book -->
<!-- ============================================== -->

<extension point="org.eclipse.help.toc">
<toc file="book.xml" primary="true" />
</extension>

<!-- =============================================== -->
<!-- Link the sections into the book -->
<!-- =============================================== -->

<extension point="org.eclipse.help.toc">
<toc file="book-isdk.xml" />
<toc file="book-vsdk.xml" />
</extension>

</plugin>


The book.xml has the following:

<toc label="Cisco Active Network Abstraction (ANA) Help" topic="book.html">


<!-- *************************** -->
<!-- What's New -->

<topic label="What's New">
<anchor id="Base-new" />
<anchor id="anchor-new" />
</topic>


<!-- *************************** -->
<!-- Overview -->

<topic label="Overview">
<anchor id="Base-over" />
<anchor id="anchor-over" />
</topic>

<!-- *************************** -->
<!-- Getting Started -->

<topic label="Getting Started">
<anchor id="Base-getstart" />
<anchor id="anchor-getstart" />
</topic>

<!-- *************************** -->
<!-- Device and Network Management -->

<topic label="Device and Network Management">
<anchor id="Base-devmgmt" />
<anchor id="anchor-devmgmt" />
</topic>

<!-- *************************** -->
<!-- Configuration Management -->

<topic label="Configuration Management">
<anchor id="Base-config" />
<anchor id="anchor-config" />
</topic>

</toc>

They don't have the "What's new" and "Getting Started" contents yet.
According to the documentation team, if a topic listed in the book.xml
is not installed, eclipse 3.2 or 3.4, would ignore those, but in 3.3 it
seems work differently.

In this case, since "What's new" is not installed, clicking on
"Overview" seems to be looking for "What's New" topic.

Thanks
Anand

Lee Anne wrote:
> Anand Narasimhan wrote:
>> Hi,
>>
>> I am seeing a strange problem in the help system in 3.3.1.1. In our
>> RCP application, we have online help. If I click on a topic in the
>> contents window, the help for the wrong topic is shown. For example if
>> I have the following topics
>>
>> Main Topic
>> - Sub Topic 1
>> - Sub Topic 2
>> - Sub Topic 3
>> - Sub Topic 4
>>
>> If I click on Sub Topic 1, I see a document with just a title that
>> says "What's New"
>>
>> If I click on Sub Topic 3, I see the contents for Sub Topic 1
>> If I click on Sub Topic 4, I see the contents for Sub Topic 2
>>
>> and so on.
>>
>> The same help plug-ins seems to work fine in 3.2 and 3.4.
>> Is there a bug in 3.3 in the help system that would cause this problem?
>>
>> Thanks
>> Anand
>>
>
> I'm adding the eclipse.platform.ua newsgroup to this thread, as that
> newsgroup covers the help system.
>
> Anand, can you provide here the portion of your toc.xml file that has
> the contents that is related to the "Main Topic" and "Sub Topics" that
> are showing this behavior?
>
> I'm not aware of any bug in 3.3 that would cause this particular
> problem. Do you have a document with a title that is "What's New"? Did
> the toc.xml file get changed somehow without shutting down and
> restarting the application? Are you starting up with the the osgi
> parameter -clean to refresh the Eclipse configuration state between
> startups/shutdowns?
>
> --Lee Anne


--
____________________________________________________________ _____________________

Anand Narasimhan
anandn@cisco.com
Re: Problem with Help system in Eclipse 3.3.1.1 [message #607652 is a reply to message #471460] Mon, 21 January 2008 17:17 Go to previous message
Chris Goldthorpe is currently offline Chris GoldthorpeFriend
Messages: 815
Registered: July 2009
Senior Member
This might be the same problem as was described in Bug 205189. If you
can download the latest 3.3 maintenance build you will be able to see if
it is fixed.
Re: Problem with Help system in Eclipse 3.3.1.1 [message #607657 is a reply to message #471522] Mon, 21 January 2008 20:20 Go to previous message
Anand Narasimhan is currently offline Anand NarasimhanFriend
Messages: 104
Registered: July 2009
Senior Member
Chris,

Thanks. The reply. The description of the bug seems to be like the
problem I am having. Is 3.3.1.1 a maintenance stream. The bug talks
about being fixed in a 3.3 maintenance stream (just like you said) and
also in 3.3.2.

I am using 3.3.1.1

Thanks
Anand

Chris Goldthorpe wrote:
> This might be the same problem as was described in Bug 205189. If you
> can download the latest 3.3 maintenance build you will be able to see if
> it is fixed.


--
____________________________________________________________ _____________________

Anand Narasimhan
anandn@cisco.com
Re: Problem with Help system in Eclipse 3.3.1.1 [message #607659 is a reply to message #471525] Mon, 21 January 2008 20:43 Go to previous message
Anand Narasimhan is currently offline Anand NarasimhanFriend
Messages: 104
Registered: July 2009
Senior Member
I applied the patch mentioned in this bug to the 3.3.1.1 source. It did
not fix the problem.

BTW: Can I attach screen shots to this posting, so it is easy to see the
problem I am seeing.

Thanks
Anand

Anand Narasimhan wrote:
> Chris,
>
> Thanks. The reply. The description of the bug seems to be like the
> problem I am having. Is 3.3.1.1 a maintenance stream. The bug talks
> about being fixed in a 3.3 maintenance stream (just like you said) and
> also in 3.3.2.
>
> I am using 3.3.1.1
>
> Thanks
> Anand
>
> Chris Goldthorpe wrote:
>> This might be the same problem as was described in Bug 205189. If you
>> can download the latest 3.3 maintenance build you will be able to see
>> if it is fixed.
>
>


--
____________________________________________________________ _____________________

Anand Narasimhan
anandn@cisco.com
Re: Problem with Help system in Eclipse 3.3.1.1 [message #607660 is a reply to message #471526] Mon, 21 January 2008 20:53 Go to previous message
Anand Narasimhan is currently offline Anand NarasimhanFriend
Messages: 104
Registered: July 2009
Senior Member
One more thing. I tried to run it thru debugger.
The call ITopic[] subtopics = topic.getSubtopics(); in NavServlet is
returning an empty array, so the the loop that contains the patched code
is not even executed.


Anand

Anand Narasimhan wrote:
> I applied the patch mentioned in this bug to the 3.3.1.1 source. It did
> not fix the problem.
>
> BTW: Can I attach screen shots to this posting, so it is easy to see the
> problem I am seeing.
>
> Thanks
> Anand
>
> Anand Narasimhan wrote:
>> Chris,
>>
>> Thanks. The reply. The description of the bug seems to be like the
>> problem I am having. Is 3.3.1.1 a maintenance stream. The bug talks
>> about being fixed in a 3.3 maintenance stream (just like you said) and
>> also in 3.3.2.
>>
>> I am using 3.3.1.1
>>
>> Thanks
>> Anand
>>
>> Chris Goldthorpe wrote:
>>> This might be the same problem as was described in Bug 205189. If you
>>> can download the latest 3.3 maintenance build you will be able to see
>>> if it is fixed.
>>
>>
>
>


--
____________________________________________________________ _____________________

Anand Narasimhan
anandn@cisco.com
Re: Problem with Help system in Eclipse 3.3.1.1 [message #607662 is a reply to message #471527] Mon, 21 January 2008 22:14 Go to previous message
Chris Goldthorpe is currently offline Chris GoldthorpeFriend
Messages: 815
Registered: July 2009
Senior Member
In that case can you file a bug report and attach a plugin which shows
the problem?
Re: Problem with Help system in Eclipse 3.3.1.1 [message #607665 is a reply to message #471528] Mon, 21 January 2008 23:53 Go to previous message
Anand Narasimhan is currently offline Anand NarasimhanFriend
Messages: 104
Registered: July 2009
Senior Member
Filed a bug agains UA. Bug ID: 216064
https://bugs.eclipse.org/bugs/show_bug.cgi?id=216064

Anand

Chris Goldthorpe wrote:
> In that case can you file a bug report and attach a plugin which shows
> the problem?


--
____________________________________________________________ _____________________

Anand Narasimhan
anandn@cisco.com
Re: Problem with Help system in Eclipse 3.3.1.1 [message #607667 is a reply to message #471529] Tue, 22 January 2008 03:12 Go to previous message
Anand Narasimhan is currently offline Anand NarasimhanFriend
Messages: 104
Registered: July 2009
Senior Member
The problem seems to be in TocFragmentServlet.Serializer class.
In serializeChildTopics the href is being constructed using the index of
the child topic in the topics array.

In 3.3 the child topics returned is only the enabled topics (ITopic[]
subtopics = EnabledTopicUtils.getEnabled(topic.getSubtopics());)

So this already returns the only the enabled topic, so the child topic
index is wrong.

In 3.4, child topics are obtained using topic.getSubTopics and in the
loop, if a child topic is not enabled, it is skipped. so the index in
addSuffix method is correct.


This is a critical problem for us. We cannot migrate to 3.4 yet. Is
there a way to get a patch fix for this problem?

Thanks
Anand


Anand Narasimhan wrote:
> Filed a bug agains UA. Bug ID: 216064
> https://bugs.eclipse.org/bugs/show_bug.cgi?id=216064
>
> Anand
>
> Chris Goldthorpe wrote:
>> In that case can you file a bug report and attach a plugin which shows
>> the problem?
>
>


--
____________________________________________________________ _____________________

Anand Narasimhan
anandn@cisco.com
Previous Topic:Context help editor
Next Topic:F1 is not opening the help content
Goto Forum:
  


Current Time: Wed Nov 26 17:44:23 GMT 2014

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

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