Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 232272 - [Examples] Don't use the XML Compare example for real XMLs
Summary: [Examples] Don't use the XML Compare example for real XMLs
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Compare (show other bugs)
Version: 3.4   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.4 RC2   Edit
Assignee: Tomasz Zarna CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-05-15 06:51 EDT by Tomasz Zarna CLA
Modified: 2008-06-02 09:24 EDT (History)
6 users (show)

See Also:
Szymon.Brandys: review+
Michael.Valenta: review+


Attachments
Change extension to compare_xml (757 bytes, patch)
2008-05-15 06:51 EDT, Tomasz Zarna CLA
no flags Details | Diff
Patch v2 (2.91 KB, patch)
2008-05-21 07:51 EDT, Tomasz Zarna CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Tomasz Zarna CLA 2008-05-15 06:51:21 EDT
Created attachment 100404 [details]
Change extension to compare_xml

Bug 221115 has risen an issue showing that we should reconsider if we want to use exemplary XML compare facility to work with real XML files. Given that the example is there to illustrate how to register a compare merge viewer and other viewers, not to provide an XML compare itself.

As suggested in bug 221115, comment 12 we've got two options here:
1) "change the file extension used by the example to a custom extension to avoid interfering with real file types"
2) create a custom content type that is a child of XML and only associate the compare viewer with that

I would go with the first one (custom extension). I wanted to change it to .cxml or .xmlc, where "c" stands for compare, but then I discover that they are already in use. "cxml" is used for commercial or constrained xmls and "xmlc" is used when working with so called xml compiler. So, using these extensions can lead to potential conflicts in the future, so I think the safest one would be "compare_xml" and this is my proposition.
Comment 1 Tomasz Zarna CLA 2008-05-15 07:01:14 EDT
It would be great if we could put it in 3.4.
Comment 2 Aaron Digulla CLA 2008-05-15 07:32:15 EDT
How about these?

.cmpxmlex
.cxe (compare xml example)
.cmpex
.compare
.cmp
Comment 3 Tomasz Zarna CLA 2008-05-20 11:59:18 EDT
Szymon, Michael, what are your types? Is "xml_compare" fine?

To make it for 3.4 RC2 I will need positive reviews from you guys.
Comment 4 Michael Valenta CLA 2008-05-20 12:10:20 EDT
I don't really like the use of an underscore in a file extensions. How about *.cml  or *.cxml? (just to add to the list of possibilities ;-)
Comment 5 Michael Valenta CLA 2008-05-20 12:13:14 EDT
Please take my last suggestion as my opinion and not a condition for approval. I am happy with whatever extension you choose. Just make sure that the documentation for the example is updated so users will know what extension they need to use.
Comment 6 Szymon Brandys CLA 2008-05-20 12:45:35 EDT
I vote for .cxml
Comment 7 Tomasz Zarna CLA 2008-05-21 07:51:25 EDT
Created attachment 101230 [details]
Patch v2

Patch that changes the extension to cxml (it's final) and updates docs.
Comment 8 Tomasz Zarna CLA 2008-05-21 07:54:25 EDT
The latest patch applied to CVS HEAD.
Comment 9 Tomasz Zarna CLA 2008-06-02 09:24:52 EDT
Verified in Example Plug-ins for 3.4 RC3.