Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 140175

Summary: [migration guide] Add information on handling of simple IDs with "."
Product: [Eclipse Project] Platform Reporter: Oleg Besedin <ob1.eclipse>
Component: DocAssignee: Platform-Doc-Inbox <platform-doc-inbox>
Status: VERIFIED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: dj.houghton, jeffmcaffer
Version: 3.2   
Target Milestone: 3.2 RC4   
Hardware: PC   
OS: Windows XP   
Whiteboard:
Attachments:
Description Flags
Patch that adds the text above none

Description Oleg Besedin CLA 2006-05-04 11:08:50 EDT
I would like to add the following information to the Eclipse 3.2 Plug-in Migration FAQ (Platform Plug-in Developer Guide -> 3.2 Plug-in Migration Guide -> Migrating to Eclipse 3.2 from 3.1 -> FAQ). 

Please feel free to correct language and style:
----------------------------------------------------------------------

Clarification of the usage of IDs with dots (“.”) in Extension Points, Extensions, and Content Types

In the past, IDs specified for the extension points, extensions, and content types were expected to be “simple IDs” with no dots in them (e.g., “myPoint”, not “my.Point”, not “myPlugin.myPoint”).

In the release 3.2 we added processing of fully-qualified IDs (e.g., “org.eclipse.myPlugin.myPoint”). However, it turned out that some components used IDs with dots and the change broke the functionality provided by those components. To preserve backward compatibility for IDs of extension points and extensions, we added special processing based on the version of the XML file:

•	If XML file has tag <?eclipse version="3.0"?>, the runtime functionality remains the same as before (plug-in ID is added to the simple name)

•	If XML file has tag <?eclipse version="3.2"?>, the IDs with dots are treated as fully qualified names (no plug-in ID is added to the name)

Details can be found in the bug https://bugs.eclipse.org/bugs/show_bug.cgi?id=128866.

We recommend switching to the 3.2 format as the usage of IDs with dots was never intended to be supported in the 3.0 format. (Simply put, there is no guarantee that it really works today or that it will work the same tomorrow.)

The <?eclipse version>  tag applies to extension point IDs and extension IDs, but not to the content type IDs (see bug https://bugs.eclipse.org/bugs/show_bug.cgi?id=139491).
Comment 1 Oleg Besedin CLA 2006-05-08 15:37:44 EDT
Corrected text: 

Clarification of the usage of IDs with dots (“.”) in Extension Points, Extensions, and Content Types 

In the past, IDs specified for the extension points, extensions, and content types were expected to be “simple IDs” with no dots in them (e.g., “myPoint”, not “my.Point”, not “myPlugin.myPoint”). This rule was specified, but not enforced.
In the release 3.2 we added processing of fully-qualified IDs (e.g., “org.eclipse.myPlugin.myPoint”). However, it turned out that some components had previously used IDs with dots and the change broke the functionality provided by those components. To preserve backward compatibility for IDs of extension points and extensions, we added special processing based on the version of the XML file: 
• If the XML file has the tag <?eclipse version="3.0"?>, the runtime functionality remains the same as before (plug-in ID is added to the simple name) 
• If the XML file has the tag <?eclipse version="3.2"?>, the IDs with dots are treated as fully qualified names (no plug-in ID is added to the name). Details can be found in the bug https://bugs.eclipse.org/bugs/show_bug.cgi?id=128866. 

We recommend switching to the 3.2 format as the usage of IDs with dots was never intended to be supported in the 3.0 format. (Simply put, there is no guarantee that it works in all cases today or that it will work the same tomorrow.) 

The <?eclipse version> tag applies to extension point IDs and extension IDs, but not to the content type IDs (see bug https://bugs.eclipse.org/bugs/show_bug.cgi?id=139491). 
Comment 2 Oleg Besedin CLA 2006-05-09 11:35:32 EDT
Created attachment 40743 [details]
Patch that adds the text above
Comment 3 Oleg Besedin CLA 2006-05-09 11:37:01 EDT
Hi DJ,
Could you check this patch and commit it (it is in the org.eclipse.platform.doc.isv)?

Thanks!
Comment 4 DJ Houghton CLA 2006-05-09 12:46:39 EDT
Released.
Thanks.
Comment 5 Oleg Besedin CLA 2006-05-10 09:39:57 EDT
Verified in the build N20060510-0010.