Re: [platform-ua-dev] Intro content schema

["Curtis D'Entremont" <curtispd@xxxxxxxxxx>]

Hi Pierre,

Please see my comments
below.

Thanks,
Curt

"pierre _" <pican123@xxxxxxxxxxx>
Sent by: platform-ua-dev-bounces@xxxxxxxxxxx

15/06/2006 08:28 AM

Please respond to
"Eclipse Platform User Assistance component developers list." <platform-ua-dev@xxxxxxxxxxx>

To	platform-ua-dev@xxxxxxxxxxx
cc
Subject	[platform-ua-dev] Intro content schema

Hi,
while trying to author "intro content" files in an XML editor,
I ran into 
several problems with the IntroContent.exsd schema file found in the 
org.eclipse.ui.intro plugin.

N.B.: my comments are based on Eclipse 3.2 RC7. But looking at the revision
log, some of these problems date back to Eclipse 3.0.

1) the schema is not valid
- the <appInfo> element doesn't exist. <appinfo> does.
- the 'default' value is not allowed for the "use" attribute.
It should be 
replaced by the 'optional' value.
- the "value" attribute is not allowed in an <attribute>
element. It should 
be replaced by a "default" attribute.
- XML Schema elements should be in the XML Schema namespace.
- the 'string' and 'boolean' primitive data types should be in the XML
Schema namespace.
- if the elements declared in the target namespace remain unqualified,
then 
there should be a xmlns="org.eclipse.ui.intro" in the <schema>
root element.

You are correct in that the schema is not
a proper XML schema. We used the PDE schema editor to generate this "schema"
(it wasn't written by hand). Before I could open a bug on PDE I asked one
of the developers about it and he mentioned that this schema is not meant
to be externally visible, but instead is a way for the schema editor to
store data. The editor generates .exsd files that are specific to eclipse
and should only be viewed using the editor and from the generated html.
We follow the same rule; you should be viewing the html file contributed
to the docs about the intro content format (linked to from the extension
point schema for intro content). The schema file is just a means for us
to generate those docs.

2) either the schema is wrong or most, if not all, of the intro content
files in Eclipse are not valid:
- according to the schema, an <introContent> element must have at
least one 
<page> child.
the <introContent> element in org.eclipse.platform/intro/overviewEx.xml,
for 
instance, doesn't.

Fixed. The schema file was outdated.

- according to the schema, a <text> element is supposed to be empty.
Yet, 
its description is:
"a snippet of text that can optionally contain escaped HTML tags.
It can 
include b and li tags. It can also contain anchors for urls. If multiple
paragraphs are needed, then the text can be divided into multiple sections
each beginning and ending with the p tag."
<text> elements in org.eclipse.platform/intro/overviewEx.xml, for
instance, 
contain text nodes.

Fixed.

- the <title> element has a similar problem
<title> elements in org.eclipse.ui.intro.universal/introContent.xml
contain 
text nodes.

Fixed.

- according to the schema, the"id" attribute of an <img>
element is required
<img> elements in org.eclipse.ui.intro.universal/introContent.xml
don't have 
an "id" attribute.

Fixed.

- if I understand the definition of <group> and <page> elements
in the 
schema correctly, it means:
"should a <page> (or <group>) element contain more than
one child element, 
all children element must be of the same type".
<page> elements in org.eclipse.ui.intro.universal/introContent.xml
contain 
<anchor>, <title> and <group> elements.
the "page-content" <group> elements in 
org.eclipse.ui.intro.universal/introContent.xml contain <text> and
<group> 
elements.

Fixed.

Do you think there's time for these problems to be fixed before Eclipse
3.2 
is released at the end of June?

I'm afraid not. 3.2 development has finished
(all but the most severe stop-ship bugs). The fixes are in the 3.3 stream.

Regards,
Pierre


_______________________________________________
platform-ua-dev mailing list
platform-ua-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ua-dev