[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
RE: [platform-help-dev] extradir(s)?
|
Christal,
The TOC with extradir must be correctly linked into the navigation. If TOC
is not included into the navigation, the topics from extra directory will
not be indexed either.
When linking up to another TOC you must specify an anchor, so instead of
using
link_to="topics_apiRef.xml"
you need to use
link_to="topics_apiRef.xml#myanchor"
The topics_apiRef.xml file will need to define this anchor somewhere using
<anchor id="myanchor" />
An easy way to test if TOC are linked correctly is to temporary add some
topics to the TOC and see if they appear in the tree.
Konrad Kolosowski
Eclipse Help System
"Pomeroy, Christal"
<cpomeroy@xxxxxxxxxxxx> To: "'platform-help-dev@xxxxxxxxxxx'" <platform-help-dev@xxxxxxxxxxx>
Sent by: cc:
platform-help-dev-admin@ Subject: RE: [platform-help-dev] extradir(s)?
eclipse.org
07/15/2002 08:17 PM
Please respond to
platform-help-dev
Hi Konrad,
Thanks for this earlier suggestion but I can't seem to get my second
and third extradirs to be added to my search. I added a "more menus"
TOC entry to bring the IRSMenu directory into the search, and I
expanded the Prog Guide entry with an extradir extension. While the
first extradir declared in the plugin (IRSGuid) still works fine,
these two new ones do not.
Relevant excerpts from the updated help files in my Eclipse 2.0
simple help prototype are include below. Should this work?
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Extension points in plugin.xml:
===============================
<!--
============================================================================
= -->
<!-- Define primary TOC
-->
<!--
============================================================================
= -->
<extension point="org.eclipse.help.toc">
<toc file="toc.xml" primary="true" />
</extension>
<!--
============================================================================
= -->
<!-- Define nested TOC hierarchies
-->
<!--
============================================================================
= -->
<extension point="org.eclipse.help.toc">
<toc file="topics_apiRef.xml" extradir="RM/IRSGuid" />
<toc file="topics_extraFiles_IRSMenu.xml" extradir="RM/IRSMenu" />
<toc file="topics_progGuide.xml" extradir="PG/CmdAdditions" />
</extension>
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
topics_moreFiles_IRSMenu.xml:
=============================
<toc label="Add IRSMenu dir to search, but not TOC (THIS LABEL NOT USED)"
link_to="topics_apiRef.xml">
</toc>
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
topics_progGuide.xml:
=====================
<toc label="Programmer's Guide (NOT USED)">
<topic label="Introduction" href
="PG/CmdAddins/main_menu.html"/>
<topic label="Examples" href
="PG/CmdExamples/command_examples.html">
</topic>
</toc>
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Thanks a million.
Christal
-----Original Message-----
From: konradk@xxxxxxxxxx [mailto:konradk@xxxxxxxxxx]
Sent: Tuesday, May 21, 2002 6:05 PM
To: platform-help-dev@xxxxxxxxxxx
Subject: Re: [platform-help-dev] extradir(s)?
Christal,
There is only one "extradir" attribute per TOC, and it can contain name of
one directory only. It requires minimal effort from the documentation team
to cause extra directory to be indexed, but does not prevent more complex
scenarios to be accomplished.
Help includes documents from extradir and all subdirectories in search.
You can take advantage of it and specify extradir="RM", which will cause
both RM/IRSGuid and RM/IRSMenu directories to be indexed and searchable.
Another, even more flexible, solution is to specify additional TOCs in your
plugin.xml. These TOCs do not need to contain any topics to include in the
navigation.
You can add a line
<toc file="IRSMenuFiles.xml" extradir="RM/IRSMenu" />
in your plugin.xml, and create a file IRSMenuFiles.xml that will contain
only link to your existing TOC:
<toc label="IRSMenu Files" link_to="topics_apiRef.xml" ></toc>
You basically can link the TOC with extradir attached like any other TOC.
Regards,
Konrad Kolosowski
Eclipse Help System
"Pomeroy, Christal"
<cpomeroy@xxxxxxxxxxxx> To:
"'platform-help-dev@xxxxxxxxxxx'" <platform-help-dev@xxxxxxxxxxx>
Sent by: cc:
platform-help-dev-admin@e Subject:
[platform-help-dev] extradir(s)?
clipse.org
05/21/2002 04:59 PM
Please respond to
platform-help-dev
I'm prototyping with the new 'extradir' feature now (see Eclipse defect
#10088 for adding topics to search that aren't linked into the TOC). I have
it working for one extra directory, but is it possible to include more than
one extra directory for this purpose? If so, what is the syntax?
I have tried these alternatives, but neither works:
<toc file="topics_apiRef.xml" extradir="RM/IRSGuid RM/IRSMenu" />
(Second entry not processed)
<toc file="topics_apiRef.xml" extradir="RM/IRSGuid"
extradir="RM/IRSMenu" /> (XML fails)
Thanks,
Christal
Christal Pomeroy
Technical Documentation Mgr., RSG-Ottawa
R a t i O n a l
the software development company
770 Palladium Drive
Kanata, Ontario K2V 1C8
www.rational.com
Office': 613.591.7944
Cell': 613.282.6417
Fax: 613.591.7020
-- Someone who thinks logically provides
> a nice contrast to the real world. --
>
>
_______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-help-dev
_______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-help-dev
_______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-help-dev
