I also like the idea of including some documentation in LLRPdef.xml.
The <annotation>, et al, conventions were borrowed from those
of XSD. It would be good to stay aligned with and adopt further
techniques and conventions from XSD. For example, I think (not
sure) there is some attribute= to know what kind of <documentation>
the text is. That might be used instead of <documentationRef>.
It might also be the sort of info code/IDE generators need.
Provided XHTML is in harmony with XSD documentation methods,
I think it is a good idea.
Only two concerns: 1) Is the LLRP spec copyright OK with this; and
2) It could be a bear to keep things in sync as the spec evolves.
Provide (1) is OK, I'm not overly concerned about (2). The spec
should be fairly static for years. There likely will be errata.
It would even be nice to fold the errata into LLRPdef.xml.
Is there somebody who might take this on?
Regards,
-gww
-----Original Message-----
From: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED] On Behalf Of
John R. Hogerhuis
Sent: Friday, July 20, 2007 1:12 PM
To: LLRP Toolkit Development List
Subject: Re: [ltk-d] Extended Documentation in LLRPdef.xml? [heur]
On 7/20/07, Christian Floerkemeier <[EMAIL PROTECTED]> wrote:
>
> Pro:
> - we can generate code and the appropriate documentation from
the
> XML description
>
> Con:
> - LLRPdef.xml might become a bit overloaded with
documentation.
> - Might not be useful for all implementations (I think it
would at
> least help for an c# and java impl)
>
> Not sure whether this was already considered earlier and rejected.
>
> - Christian
>
>
I for one would welcome such a patch :-) This would be a big help in
the Perl documented-oriented approach interactively generating
instances of LLRP.xsd . Good XML editors will reveal this text in
useful contexts.
Do you know if XML editors typically support XHTML markup in
annotations? If so that is probably what we should use for specifying
emphasis, line breaks, etc.
-- John.
------------------------------------------------------------------------
-
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
llrp-toolkit-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/llrp-toolkit-devel
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
llrp-toolkit-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/llrp-toolkit-devel
