Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
RE: [platform-ua-dev] Help on help development

I think I'll go with your option 3. I'll go round and speak to the owner of the other plugin to tell them I need to put a file in their source.
 
Right now, for backwards compatibility with 3.0, we're not using jars for our plugins, but that point is well taken.
 
I'm sure my problem is just that I don't know how to get hold of that content in a clean and supported way. The HTML files are generated in the build process of the other plugin, so they are not statically available to me. I just need to find a half day to sit down and read some Eclipse documentation in a structured way.
 
Thanks again,
Jane.


From: platform-ua-dev-bounces@xxxxxxxxxxx [mailto:platform-ua-dev-bounces@xxxxxxxxxxx] On Behalf Of Curtis D'Entremont
Sent: Thursday, January 12, 2006 2:27 PM
To: Eclipse Platform User Assistance component developers list.
Subject: RE: [platform-ua-dev] Help on help development


Hi Jane,

You're correct, the current implementation only looks inside the plugin from which this is declared and its fragments. I have opened a bug to clarify this in the API (see https://bugs.eclipse.org/bugs/show_bug.cgi?id=123686).

I would like to understand the reason for doing this.. because it can be problematic; for example, the plugins could be distributed as jars, the versions will change, the plugins could be in separate install sites, etc. I would suggest trying one of the following:

1) Moving those docs to the plugin that declares the extraDir.
2) Moving the docs to a new fragment that has the declaring plugin as its parent.
3) Declare a dummy TOC in the other plugin where the docs are and use the extraDir attribute to point to them.

Or, if you have a good reason for needing this outside-the-bundle extraDir support, you can open a feature to request it.

Thanks,
Curtis d'Entremont
Eclipse User Assistance
IBM Toronto Lab

Phone: (905) 413-5754
E-Mail: curtispd@xxxxxxxxxx




"Jane Tatchell" <jtatchell@xxxxxxxxxxx>
Sent by: platform-ua-dev-bounces@xxxxxxxxxxx

12/01/2006 12:39 AM

Please respond to
"Eclipse Platform User Assistance component developers list."

To
"Eclipse Platform User Assistance component developers list." <platform-ua-dev@xxxxxxxxxxx>
cc
Subject
RE: [platform-ua-dev] Help on help development





Thanks, I know that. Here is my exact problem:

I'm trying to link my online help TOC to some files external to my help
plugin. I found the documentation for the extradir attribute of the toc
element in plugin.xml and thought that would do the trick because it
accepts a relative path:
extradir - specifies relative directory name of containing additional
documents that are associated with the table of contents. All help
documents in this directory, and all subdirectories, will be indexed,
and accessible through the documentation search, even if topic elements
in the TOC file do not refer to these documents.

However, relative only appears to work within the current plugin, i.e. I
can use extradir="doc/rom" and it picks up my toc entry with an
href="" like a charm. The problem is that the external
directory resides in another plugin. This is the problem. If I use
extradir="../full_other_plugin_name_with_version_no/doc/rom" then my toc
entry with an
href="" gives
me the standard "you goofed" page.

Have you ever tried this? And got it to work?

Thanks very much for any assistance you can give.

-----Original Message-----
From: platform-ua-dev-bounces@xxxxxxxxxxx
[mailto:platform-ua-dev-bounces@xxxxxxxxxxx] On Behalf Of Dejan Glozic
Sent: Wednesday, January 11, 2006 6:29 PM
To: Eclipse Platform User Assistance component developers list.
Cc: platform-ua-dev@xxxxxxxxxxx; platform-ua-dev-bounces@xxxxxxxxxxx
Subject: Re: [platform-ua-dev] Help on help development

Jane, 'extradir' is used to include documents that will be indexed and
thus be searchable without exposing them in the table of contents.
Documents listed in the table of contents are automatically searchable.

Regards,

Dejan Glozic, Ph.D.
Manager, Eclipse Development 1A
D1/R0Q/8200/MKM
IBM Canada Ltd.
Tel. 905 413-2745  T/L 969-2745
Fax. 905 413-4850





            "Jane Tatchell"

            <jtatchell@actuat

            e.com>
To
            Sent by:                  <platform-ua-dev@xxxxxxxxxxx>

            platform-ua-dev-b
cc
            ounces@xxxxxxxxxx

            g
Subject
                                      [platform-ua-dev] Help on help

                                      development

            01/11/2006 07:18

            PM





            Please respond to

            "Eclipse Platform

             User Assistance

                component

            developers list."









I have a query about the use of the extradir attribute in the toc
element in a help plugin. Although I'm sure this mailing list is not the
appropriate place, and I'm normally first in line with the "don't bother
the developers" responses when newsgroup questions get posted in mailing
lists, I can't see any mailing list that looks appropriate. I've
searched the archives too...


Please tell me: Where should I post my question?


Jane Tatchell, Actuate Corporation
_______________________________________________
platform-ua-dev mailing list
platform-ua-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ua-dev




_______________________________________________
platform-ua-dev mailing list
platform-ua-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ua-dev
_______________________________________________
platform-ua-dev mailing list
platform-ua-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ua-dev


Back to the top