[jbossseam-issues] [JBoss JIRA] Commented: (JBSEAM-1531) Document pages.xsd and maybe other .xsds with xsd:documentation

[Norman Richards (JIRA)]

    [ http://jira.jboss.com/jira/browse/JBSEAM-1531?page=comments#action_12410355 ] 
            
Norman Richards commented on JBSEAM-1531:
-----------------------------------------

I've finished a good bit of the cleanup with a first round of setting attribute types and adding basic documentation.  I'm hesitant to add too much documentation because of the increased documentation burden.  But, we should probably have more than even what we have now.  It would be really nice if we had some way to pull text from the main documentation to put in the XSDs.  (or pull text from the XSDs for the main documentation)



We now have the following base types:
 
components:expressionType - an EL expression or a @property@ value
components:string - any string value
components:int - a positive integer (or expresion value)
components:boolean - a boolean (or expression value)
components:componentName - a seam component name or java class (or expression value)

That's been enough for most everything.  There are no finer grained types for collection types.   We shouldn't hesitate to add more types if they make sense.

A few of the XSDs now refer to components.xsd by HTTP URL.  This means that those schemas can be removed from src/main/org/jboss/seam to any other directory.  The down side is that they cannot then refer to the current master components.xsd.  If they use unpublished features of components.xsd, you'll need to change the schemaLocation to point to the local file while editing.  Yes, this is a HUGE pain, but I can find no way around this.    Id recommend we only use this approach for XSDs that we don't want in src/main and all the core seam XSDs stay where they are. 




> Document pages.xsd and maybe other .xsds with xsd:documentation
> ---------------------------------------------------------------
>
>                 Key: JBSEAM-1531
>                 URL: http://jira.jboss.com/jira/browse/JBSEAM-1531
>             Project: Seam
>          Issue Type: Feature Request
>          Components: Core
>    Affects Versions: 1.3.0.ALPHA
>            Reporter: Michael Youngstrom
>         Assigned To: Norman Richards
>            Priority: Minor
>             Fix For: 2.1.0.GA
>
>
> The pages.xsd is fairly vast.  It could benefit greatly by some <xsd:documentation> elements.  XML editors such as Eclipse WTP will pick up these xsd:documentation elements and provide context help.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira