Bug 129451 - site DTD in documentation has 2 obvious errors
Summary: site DTD in documentation has 2 obvious errors
Status: RESOLVED WONTFIX
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Update (deprecated - use Eclipse>Equinox>p2) (show other bugs)
Version: 3.2   Edit
Hardware: PC Windows XP
: P3 minor (vote)
Target Milestone: ---   Edit
Assignee: Platform-Update-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2006-02-25 09:52 EST by David Williams CLA
Modified: 2009-06-18 17:11 EDT (History)
0 users

See Also:


Attachments
DTD containing suggested fixes (1.47 KB, text/plain)
2006-02-25 09:55 EST, David Williams CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description David Williams CLA 2006-02-25 09:52:31 EST
I'm going by 
http://help.eclipse.org/help31/index.jsp?topic=/org.eclipse.platform.doc.isv/reference/misc/update_sitemap.html

was same in version 3.0. 

Plus, I'll make 4 enhancement suggestions. Even though some would, technically speaking, be API breaking change if anyone considers the documented DTD as API. 



1. To be considered valid, I suggest a site.xml needs to have at least 1 feature  ... so, 'feature+', instead of 'feature*'.

2. I suggest the order be spec'd as having category-def come before the features and archives, instead of being spec'd to come last 
(put's things in order of most general, to most specific, conceptually, and makes it easier to find in large site.xml files).

3. the patch attribte default value, "false", must be quoted.

4. the ws attribue really is not required, so should say #IMPLIED instead of #REQUIRED

5. Oh, and I also suggest it "say" its encoded in UTF-8, instead of ISO-8859-1, as being more customary (and ... if non ascii characters were ever used, you'd probably want UTF-8). 

6. Would be helpful if a "well known, standard eclipse" publicId was assigned to all such DTD's in Eclipse's spec's. And, also literally "hosted" somewhere on Eclipse so XML validators could work (more easily) with instance documents. See bug 116615 for related information (or, at least, sort of a similar case). 
For example, 

<!DOCTYPE site PUBLIC "-//Eclipse.org//DTD Eclipse Update 3.2.001 Compiler//EN" "http://www.eclipse.org/update/core/site.dtd">.
Comment 1 David Williams CLA 2006-02-25 09:55:14 EST
Created attachment 35354 [details]
DTD containing suggested fixes

BTW, if there *was* ever a push to have "DTD's on Eclipse.org" in a more wide spread way ... you might consider moving to schema's at the same time :)
Comment 2 John Arthorne CLA 2009-06-18 17:11:01 EDT
This is a mass update of Platform Update bugs that have had no activity in three years. Platform Update was replaced in Eclipse 3.4 (2008) by a new provisioning system called Equinox p2. If this bug or enhancement is not already addressed in p2 please enter a new bug report against p2 (RT > Equinox > p2). If you still want to see this bug addressed in the deprecated Platform Update component, please reopen this bug. Patches welcome.