Eclipse Community Forums: Platform - User Assistance (UA)

Help

Home

Home » Eclipse Projects » Platform - User Assistance (UA) » Move toc.xml into subfolders

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

Move toc.xml into subfolders [message #661420]

Thu, 24 March 2011 15:27

Jonathan Dumont

Messages: 58
Registered: March 2011
Location: Laval

Member

Hi,

I'm creating a Eclipse RCP application from scratch. I've been able to add a plugin which will contain only my help content from the templates, and I wanted to change where all the statics files are stored.

By default, my toc.xml file is at the root of my plugin, this works fine and I can access to my help content from the menu. I have moved all the secondary toc files (toctask.xml, tocsample.xml, etc.) and the html files under a subfolder (src/main/statics), and this works too.

However, if I try to move my primary toc.xml file under the same subfolder, my help countent is not found ! I really don't know why because it's rightly referenced in my plugin.xml :

<plugin>
   <extension
         point="org.eclipse.help.toc">
      <toc
            file="src/main/statics/toc.xml"
            primary="true">
      </toc>
      <toc
            file="src/main/statics/tocconcepts.xml">
      </toc>
      <toc
            file="src/main/statics/tocgettingstarted.xml">
      </toc>
      <toc
            file="src/main/statics/tocreference.xml">
      </toc>
      <toc
            file="src/main/statics/tocsamples.xml">
      </toc>
      <toc
            file="src/main/statics/toctasks.xml">
      </toc>
   </extension>
</plugin>

Here is the content of my toc.xml file :

<toc label="Table of Contents" topic="src/main/statics/html/toc.html">
   <topic label="Getting Started">
      <anchor id="gettingstarted"/>
   </topic>
   <topic label="Concepts">
      <anchor id="concepts"/>
   </topic>
   <topic label="Tasks">
      <anchor id="tasks"/>
   </topic>
   <topic label="Reference">
      <anchor id="reference"/>
   </topic>
   <topic label="Samples">
      <anchor id="samples"/>
   </topic>
</toc>

Is it a limitation ? Or have I made a mistake ?

Report message to a moderator

Re: Move toc.xml into subfolders [message #661486 is a reply to message #661420]

Thu, 24 March 2011 21:48

Chris Goldthorpe

Messages: 815
Registered: July 2009

Senior Member

It's not a limitation, you can place the toc files in subdirectories. Most likely there is a path somewhere that needs to be fixed.

What I think is happening in your case is that the child tocs are not getting included, the root toc ends up having no topics and the help system does not display tocs with no topics.

Try adding a topic to the root toc and see if it appears again. The link_to attributes in the child tocs needs to be fixed up to point to the new location of the master toc as in

<toc label="Concepts" link_to="src/main/static/toc.xml#concepts">

Report message to a moderator