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

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

Hi Pierre,

My answers
below..

For future problem reports (i.e. tomorrow's
list :-)) may I suggest using bugzilla, our bug tracking system:
https://bugs.eclipse.org/bugs

Classification: Eclipse
Product: Platform
Component: User Assistance

As for general questions they are fine
here.

Thanks,
Curt

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

16/06/2006 07:42 AM

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

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

Hi Curtis,
thanks for clarifying the role of the IntroContent.exsd file: I wasn't
aware 
of that.

I have a few questions, though:
- why can't the PDE schema editor generate valid xml schemas?

It could, but users wouldn't really gain
anything by it because as far as they're concerned the file is opaque.
Note that this is not a general-purpose XML schema editor, it's an eclipse
extension point schema editor (so we are abusing it a little in that sense).
The schema is used for things like validation and content assistance when
adding new elements to extensions in the editor, and generating human readable
documentation for your extension points (which is what we use it for).

- why does the documentation (Plug-in Development Environment Guide >
Tools 
 > New File Creation Wizards > Extension Point Schema) say "An
extension 
point schema is a valid XML schema as defined by the W3C specification..."
even though it's inaccurate for the ones created by the PDE schema editor?

Good catch. I've opened a bug against PDE
for this:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=147449

- how are Eclipse intro content files authored? are they authored by 
developers or by non-developers?

Both from what I've seen. I've written
some for my previous project and I know ID folks are writing them as well.

Thank you for fixing most of the problems listed in the 2) section of my
previous mail.
Note that version 1.39 still doesn't allow text nodes inside a <text>
or 
<title> element.
http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ui.intro/schema/IntroContent.exsd?rev=1.39&content-type=text/vnd.viewcvs-markup

It's there in the HTML, just not in the
XML (PDE editor doesn't provide a way to specify this).

The new <group> definition says that a <group>
must contain at least one 
child element.
'page-links', 'action-links', 'extra-group1', 'content-header', 'top-left',
'top-right', 'content-divider', 'bottom-left' and 'bottom-right' <group>
elements in org.eclipse.ui.intro.universal/introContent.xml don't.

Fixed.

I found additional problems in the schema (or in the xml files?):
the <group> element in org.eclipse.platform/intro/whatsnewEx3.xml
uses a 
"filter" attribute. This attribute is not defined in the schema.

This is one of the special annotations
you can use in user assistance markup as part of dynamic content support.
Rather than add it to each and every element in every schema we state it
once for all. Have a look in Help under Platform Plug-in Developer's Guide
> Programmer's Guide > User assistance support > Dynamic content
for details.

a <group> element in org.eclipse.platform/intro/whatsnewEx2.xml
uses 
"expanded" and "expandable" attributes. These attributes
are not defined in 
the schema.

Added.


I also looked at the cheatsheets schemas found in the 
org.eclipse.ui.cheatsheets plugin and I found some problems:

1) contentFile.xsd
- the 'ActionKind' type is not defined in the schema.
- as this file doesn't look like it was generated the PDE schema editor,
would it be possible to change all occurences of <xsd:extension 
base="string"/> by <xsd:extension base="xsd:string"/>?
- according to the schema, the <description> element can only contain
text 
nodes.
Yet, <description> elements in 
org.eclipse.pde/cheatsheets/rcpapp/rcpapp-create.xml also contain any number
of <br> and <b> elements.
- the <b> and <br> elements mentioned above are not defined
in the schema.
- according to the schema, an <item> element can not contain one
(or more) 
<subitem> element if it contains a <description> element.
<item> elements in org.eclipse.pde/cheatsheets/rcpapp/rcpapp-create.xml
contain a <description> element and <subitem> elements.
- according to the schema, the "when" attribute of the <command>
element is 
required.
<command> elements in org.eclipse.pde/cheatsheets/rcpapp/rcpapp-create.xml
don't have a "when" attribute.
- according to the schema, the "kind" attribute of the <subitem>
element is 
required.
<subitem> elements in org.eclipse.pde/cheatsheets/rcpapp/rcpapp-create.xml
don't have a "kind" attribute.

2) compositeContentFile.exsd
- according the schema, an <intro> element can not be the first child
of a 
<taskGroup> element
the <taskGroup> element in org.eclipse.pde/cheatsheets/rcpapp-composite.xml
has an <intro> element as a first child.
- according to the schema, the <intro> element can only contain text
nodes.
the 1st <intro> element in org.eclipse.pde/cheatsheets/rcpapp-composite.xml
also contain a few <br> elements.
- the <br> element mentioned above is not defined in the schema.
- according to the schema, an <onCompletion> element must precede
any 
<param> element.
it's not the case in org.eclipse.pde/cheatsheets/rcpapp-composite.xml
- according to the schema, a <taskGroup> element can only contain
one <task> 
element.
the <taskGroup> element in org.eclipse.pde/cheatsheets/rcpapp-composite.xml
contain multiple <task> elements.

I'll let Chris take a look at these.. I've
opened the following bug to track:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=147463

Regards,
Pierre


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