Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [platform-help-dev] hrefs in HTML files

Peter, the javadoc is correct, BUT just because you have multiple versions
of the same plugin in the file system DOES NOT mean the runtime will pick
all of these up. The rules around plugin registry loading say that multiple
concurrent versions of a plugin will be allowed to be used (ie. will be
loaded into the registry) only if the plugins do not define extension
points or contribute extension. That is, only plugins that are used to
deliver multiple versions of the same runtime will be allowed to be active
concurrently. Help plugins do not fall into this category because they
contribute extensions (the help). So the runtime will bind only one of the
plugins based on its resolution algorithm (considers prereqs, versions,
matching rules).




                                                                                                                              
                    Peter                                                                                                     
                    Manahan/Toronto/IBM@IBMCA       To:     platform-help-dev@xxxxxxxxxxx                                     
                    Sent by:                        cc:                                                                       
                    platform-help-dev-admin@e       Subject:     Re: [platform-help-dev] hrefs in HTML files                  
                    clipse.org                                                                                                
                                                                                                                              
                                                                                                                              
                    05/08/2002 11:18 PM                                                                                       
                    Please respond to                                                                                         
                    platform-help-dev                                                                                         
                                                                                                                              
                                                                                                                              




Hmm,
     This is the javadoc for IPluginRegistry.getPluginDescriptor
----------------------------------------------------------
/**
 * Returns the plug-in descriptor with the given plug-in identifier
 * in this plug-in registry, or <code>null</code> if there is no such
 * plug-in.  If there are multiple versions of the identified plug-in,
 * one will be non-deterministically choosen and returned.
 *
 * @param pluginId the unique identifier of the plug-in
 *        (e.g. <code>"com.example.acme"</code>).
 * @return the plug-in descriptor, or <code>null</code>
 */
public IPluginDescriptor getPluginDescriptor(String pluginId);

----------------------------------------------------------

Unless I am mistaken  non-deterministic is very similar to  "random".  So
if I update my code plugins through a  feature for example and I have
updated doc plugins to go with it then whether the old docs or the new docs
get pulled in is random.

Houston we have a problem.

Docs are usually associated with plugin/feature function. As that function
changes usually there are new docs.  Rules on which function gets loaded
are laid out and the right plugins get loaded at runtime. It seems the docs
have no rules like other plugins. Since the doc "plugins" are not behaving
in the same manner as code plugins there is a disconnect.

This is very serious problem for us. Basically we cannot use the update
manager to update our docs correctly as there is no guarentee our updated
docs would get loaded in favour of the obsolete docs.


Have  I misunderstood the way it works?


Thanks,

-----------------------------------
Peter Manahan
WebSphere Tools
Build/Install and
Product Architecture
------------------------------------
manahan@xxxxxxxxxx



                    Konrad

                    Kolosowski/Toronto/IBM@IB       To:
platform-help-dev@xxxxxxxxxxx
                    MCA                             cc:
platform-help-dev@xxxxxxxxxxx, platform-help-dev-admin@xxxxxxxxxxx
                    Sent by:                        Subject:     Re:
[platform-help-dev] hrefs in HTML files
                    platform-help-dev-admin@e

                    clipse.org



                    08/05/2002 07:16 PM

                    Please respond to

                    platform-help-dev







There is no problem if your plugins are scattered.  Help uses Eclipse APIs
to determine plugin location, so there should not be any problem as long as
Eclipse knows about these plugins.

Documentation is entirely contributed through extension points.  Help does
not activate the plugins that contribute documentation, and is not aware
plug-in requires.  When resolving links help uses
Platform.getPluginRegistry().getPluginDescriptor(pluginID) to obtain
plug-in from which a document like pluginID/path/file.html will be loaded.
If the above call obtains a IPluginDescriptor, the corresponding plug-in
and its fragments will be used to load the document from.

Konrad Kolosowski
Eclipse Help System




                    Peter

                    Manahan/Toronto/IBM@IBMCA       To:
platform-help-dev@xxxxxxxxxxx
                    Sent by:                        cc:

                    platform-help-dev-admin@e       Subject:     Re:
[platform-help-dev] hrefs in HTML files
                    clipse.org



                    05/08/2002 05:18 PM

                    Please respond to

                    platform-help-dev






Does it  work this way even if the plugins are scattered among different
local directories.
e:\myproduct\plugins
f:\extension\plugins
All threaded together with a platform.cfg?

It may be the ../../ throwing me off. It is too much like a directory name
:-)


The basic concern is that it is possible for the documentation plugins to
act like other plugins. In that they can prereq other plugins and have
version numbers etc. Can be part of a feature and be updated by the update
manager. Are loaded by version with the same rules as the other plugins
are.



Thanks,

-----------------------------------
Peter Manahan
WebSphere Tools
Build/Install and
Product Architecture
------------------------------------
manahan@xxxxxxxxxx



                    Konrad

                    Kolosowski/Toronto/IBM@IB       To:
platform-help-dev@xxxxxxxxxxx
                    MCA                             cc:

                    Sent by:                        Subject:     Re:
[platform-help-dev] hrefs in HTML files
                    platform-help-dev-admin@e

                    clipse.org



                    08/05/2002 04:33 PM

                    Please respond to

                    platform-help-dev







Janette,

The supported way to refer to a file in a different plug-in is <a href
="../../plugin_ID/file.html">.  Note that you need to use plug-in ID, not
the directory name in the above path.
The latest integration builds did not have org.eclipse.platform.isv.doc
plugin included in the build.  This might be the reason why the link did
not work.  If you had the link coded correctly,
org.eclipse.platform.isv.doc plug-in exists in your installation, and you
see a problem, please open a defect.

Regards,

Konrad Kolosowski
Eclipse Help System




                    Jeanette

                    Deupree/Raleigh/IBM@IBMUS       To:
platform-help-dev@xxxxxxxxxxx
                    Sent by:                        cc:

                    platform-help-dev-admin@e       Subject:
[platform-help-dev] hrefs in HTML files
                    clipse.org



                    05/08/2002 04:09 PM

                    Please respond to

                    platform-help-dev






How are hrefs between HTML files in different plug-ins supposed to be
coded? In Eclipse V1, they were coded <a href="/pluginID/file.html" >. In
earlier V2 drivers, we had to update our hrefs to HTML files that exist in
a different plug-in to be <a href="../../plugin_directory_name/file.html"
>. In the current drivers where the version number is being appended at the
end of the plug-in directory name, these links no longer work. For an
example, see the PDE Guide topic "Configuring the PDE". Just above the
screen capture there is a link to the topic "Running the Platform" which is
in the org.eclipse.platform.isv.doc plug-in.

Can the hrefs in HTML files use the plug-in ID (independent of version)
instead of physical path and directory?

Thanks, Jeanette

-------------------------------------------------------------------------------------






Jeanette Deupree
WebSphere Studio Tools Information Lead & Manager
 RTP NC
919-254-1149 (tieline 444-1149)
deupree@xxxxxxxxxx

_______________________________________________
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




_______________________________________________
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






Back to the top