Re: [platform-help-dev] Where to store common files, such as css, js, im

[Steve Woolley <SWOOLLEY@xxxxxxxxxx>]

Jason,

This mailing list is for discussions
pertaining to help system development, rather than help system implementation.
 These kinds of questions should be asked on the eclipse.platform
newsgroup.

However, since I think I can help I
will answer it here.

You were correct to bundle your common
resources in a plugin by itself - this is certainly the approach I would
take.  The reason that the contents frame of the help is displaying
the common plug-in to users is - I suspect - because you are calling the
org.eclipse.help.toc extension point and specifying the toc for that plugin
as primary="true".

You don't actually need to declare any
extension point in your common resources plug-in.  Providing the plug-in
has a unique and valid ID, you will still be able to draw upon the resources
contained in this plug-in by calling them using your common plug-in's ID.

Create a simple project to contain your
common resources.  You plugin.xml will look something like this:

<?xml version="1.0" encoding="UTF-8"?>

<plugin
    name = "Common Resources
Plug-in"
    id = "com.peregrine.common.doc"
    version = "1.0.0"
    provider-name = "Peregrine">

</plugin>

That's all you need.  You can then
organise your images, _javascript_, and so on, inside directories within
this plug-in.

Call the files in this plug-in by using
the following syntax:

<img src=""
align="right" alt="Image">

Obviously, the number of ../s will depend
upon how deep you are within the current plug-in.

Hope this helps,


Steve
_________________________________________________________________________

Stephen Woolley  ::  User
Centered Design Practitioner  ::  CICS Transaction Gateway
Mail Point 095 - IBM United Kingdom
Laboratories, Hursley Park, Winchester, SO21 3AW
_________________________________________________________________________

Jason Elliott <jason.elliott@xxxxxxxxxxxxx>
Sent by: platform-help-dev-admin@xxxxxxxxxxx

14/09/2004 01:03

Please respond to
platform-help-dev

To	"'platform-help-dev@xxxxxxxxxxx'" <platform-help-dev@xxxxxxxxxxx>
cc
Subject	[platform-help-dev] Where to store common files, such as css, js, images

Our help system contains about 25 plugins
and 3500 help files. This design requires us to store some CSS files, _javascript_
files and images in a "common" location.
Can someone close to eclipse suggest where
the best location for such files to exist?
 
Our first attempt was to store the "common"
files in a plugin by itself. However, the Contents frame of the Help presents
this "common" plugin to the Help users.
Another thought was to create a fragment
connected to "org.eclipse.help".
 
Any design advice you have is appreciated.
 
Thanks
Jason