Skip to main content


Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Platform - User Assistance (UA) » nesting documentation
nesting documentation [message #474057] Thu, 12 June 2008 23:45 Go to next message
Robert Lauriston is currently offline Robert LauristonFriend
Messages: 31
Registered: July 2009
Member
I'm trying to nest some documentation following the instructions in:

http://help.eclipse.org/stable/index.jsp?topic=/org.eclipse. platform.doc.isv/guide/ua_help_content_nested.htm

Neither the top-down nor bottom-up approach seems to work. Am I doing
something wrong? Note that the HTML files are in doc.zip archives.
Everything works fine when the sets of docs are not nested.

*** Top-down ***

Added this to com.embarcadero.talon.help<version>/toc.xml where I wanted
to include the second TOC:

<toc label="Tuning SQL statements"
topic="../com.embarcadero.sqltuner.help/02_01a_Tuner.html">
<link toc="../com.embarcadero.sqltuner.help/toc.xml" />
</toc>

*** Bottom-up ***

Added this to com.embarcadero.talon.help<version>/toc.xml where I wanted
to include the second TOC:

<toc label="Tuning SQL Statements"
topic="../com.embarcadero.sqltuner.help/02_01a_Tuner.html">
<topic label="Tuning">
<link toc="../com.embarcadero.sqltuner.help/toc.xml" />
<anchor id="postTuning" />
</topic>
</toc>

Put this at the top of com.embarcadero.sqltuner.help<version>/toc.xml:

<toc link_to="../com.embarcadero.talon.help/toc.xml#postTuning"
label="Tuning SQL Statements">

Report message to a moderator

Re: nesting documentation [message #474060 is a reply to message #474057] Fri, 13 June 2008 19:39 Go to previous messageGo to next message
Chris Goldthorpe is currently offline Chris GoldthorpeFriend
Messages: 815
Registered: July 2009
Senior Member
If you use the PDE wizard to create a project with help content it will
create tmultiple toc files, and depending on your settings it will link
the tocs either using an anchor or a link. Here are the steps

File/New/Project
Select Plug-in Project
Give it a name and hit next
On the templates page select Plug-in with sample help content, hit next

At this stage you will see some check boxes, if you select the defaults
it will build the tocs top down, if you check the box titled "Primary"
it will build a bottom up structure.

If you are using Eclipse 3.4 you will be able to take advantage of the
fabulous toc editor, which will allow you to generate the tocs quicker.

Report message to a moderator

Re: nesting documentation [message #474062 is a reply to message #474060] Fri, 13 June 2008 22:20 Go to previous message
Robert Lauriston is currently offline Robert LauristonFriend
Messages: 31
Registered: July 2009
Member
We use FrameMaker and MIF2Go.

Adding a tag like the following to the parent toc.xml where I want the
child to be imported does the trick:

<link toc="../com.embarcadero.sqltuner.help/toc.xml" />

Chris Goldthorpe wrote:
> If you use the PDE wizard to create a project ...

Report message to a moderator

Re: nesting documentation [message #615236 is a reply to message #474057] Fri, 13 June 2008 19:39 Go to previous message
Chris Goldthorpe is currently offline Chris GoldthorpeFriend
Messages: 815
Registered: July 2009
Senior Member
If you use the PDE wizard to create a project with help content it will
create tmultiple toc files, and depending on your settings it will link
the tocs either using an anchor or a link. Here are the steps

File/New/Project
Select Plug-in Project
Give it a name and hit next
On the templates page select Plug-in with sample help content, hit next

At this stage you will see some check boxes, if you select the defaults
it will build the tocs top down, if you check the box titled "Primary"
it will build a bottom up structure.

If you are using Eclipse 3.4 you will be able to take advantage of the
fabulous toc editor, which will allow you to generate the tocs quicker.

Report message to a moderator

Re: nesting documentation [message #615246 is a reply to message #474060] Fri, 13 June 2008 22:20 Go to previous message
Robert Lauriston is currently offline Robert LauristonFriend
Messages: 31
Registered: July 2009
Member
We use FrameMaker and MIF2Go.

Adding a tag like the following to the parent toc.xml where I want the
child to be imported does the trick:

<link toc="../com.embarcadero.sqltuner.help/toc.xml" />

Chris Goldthorpe wrote:
> If you use the PDE wizard to create a project ...

Report message to a moderator

Previous Topic:Eclipse 3.4 - .war deployment of a standalone help system
Next Topic:What's the right format for "link" path if toc file is in another plug-in?
Goto Forum:
  

[ Syndicate this forum (XML) ] [ RSS ]

Current Time: Fri May 10 06:24:09 GMT 2024

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

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

Back to the top

Sign up to our Newsletter

A fresh new issue delivered monthly