RE: Javadoc comments or equivalent in XSchema

Simon St.Laurent (SimonStL@classic.msn.com)
Sun, 26 Jul 98 13:08:27 UT

Peter Murray-Rust wrote:
>I think that IBTWSH was only ever meant to be a first step towards
>increasing the value of schemas. It is a necessary first step - attaching
>human-readable document to an XSC component in a way that is impossible
>with DTDs.
>
>My hope is that the current XSC project will prove the concept of schemas
>at the simplest level and this will provide a base to build on. Then, I
>think, we shall benefit from an open discussion about what the next set of
>components may be. Of course they may come from elsewhere (XML-data, RDF,
>XSL, etc.) but we may need to assemble other sets - I think it's too early
>to say.

I share those hopes quite completely, as well as the feeling that using HTML
tags for the documentation is a first step, and a first step only. (This is a
1.0, after all, however good we'd like it to be.)

Carl Hage:
>I would be willing to write up a proposal for a set of elements useful in
>documentation, though it will have to be a week from now. Without thinking
>about it, the kinds of documentation elements I've used are something like:

Peter:
>As with all these things, anyone who make a persuasive case, has the
>necessary e-charisma and is capable of putting in the effort has every
>chance of seeing a successful XML-DEV project get off the ground :-)

I'd welcome any proposals in this direction. Chris Maden has already
suggested creating a set of XSchema-specific documentation elements in
addition to the IBTWSH set. I'd also be willing to include someone else
documentation suggestions in the proposal, as we did IBTWSH, if additional
functionality is needed.

These projects are a lot of work, but it's awfully rewarding to put up new
drafts. Speaking of which, I have a bunch of questions for the group that we
need to resolve to complete section 2.0 of the XSchema spec. Coming shortly!

Simon St.Laurent
Dynamic HTML: A Primer / XML: A Primer / Cookies