(r8) StandardsRegExt10RFC < IVOA

IVOA Web>StandardsRegExt10RFC (revision 8) (raw view)~~EditAttach~~
---+ Request for Comment:  StandardsRegExt v1.0

This document serves as the RFC center for the Proposed Recommendation entitled "StandardsRegExt: a VOResource Schema Extension for Describing IVOA Standards, Version 1.0".   The specification can be found at http://www.ivoa.net/Documents/StandardsRegExt/20110316/PR-StandardsRegExt-1.0-20110323.html.

RFC Review period: 14 Apr 2011 -- 14 May 2011.

In order to add a comment to the document, please edit this page and add your comment to the list below in the format used for the example (include your !WikiName so that authors can contact you for further information). When the author(s) of the document have considered the comment, they will provide a response after the comment.

Additional discussion about any of the comments or responses can be conducted on the Resource Registry mailing list, registry@ivoa.net. However, please be sure to enter your initial comments here for full consideration in any future revisions of this document

---++ Notes on Implementations and Validaters

The StandardsRegExt page includes three compliant sample VOResource instances that use the StandardsRegExt extension. Instances can be validated with an XML Schema validater such as the one provided with [[http://trac.us-vo.org/project/nvo/wiki/Junx][Junx]] (which is based on Xerxes).

---++ Comments from the community
   * Sample comment by TWiki.WikiName
      * Response (by TWiki.WikiName)

---+++ Comments from IVOA.MarkTaylor

This document looks mostly good, and the !StandardKeyEnumeration element in particular is a useful tool.  I have a few comments and corrections:
   1. The schema presented in Appendix A appears to be badly-formed XML.  If I attempt to parse it, it chokes on ampersands in a couple of the regular expressions.  They need to be escaped ("&amp;" -> "&amp;amp;").  The presence of this fundamental error suggests that no testing (e.g. attempted validation of actual !StandardsRegExt instances) has been done on this version of the schema -- is that the case?
      * _it is just a transcription error in copying the schema text to a html representation - the schema itself at http://www.ivoa.net/xml/StandardsRegExt/v1.0 does not have this problem IVOA.PaulHarrison_
      * _[[RayPlante]]: Note also that the posted schema has been tested against the examples given on the StandardsRegExt page._
   1. Section 2.3: I think there's a typo somewhere in the phrase "...IVOA identifier given by &lt;identifier&gt;ivo://ivoa.net/std/QueryProtocol&lt;identifier&gt;", but perhaps I'm just misunderstanding it
      * _[[RayPlante]]: While I believe this is grammatically correct it's not necessarily understandable.  I'll attempt a rewrite for clarification._
   1. Section 3.1.1: the example at the end of this section has an endorsedVersion element with status="pr".  According to the list of allowed values, it should have the value "prop" instead.  However, it might be better to change the list of allowed values to rec/pr/wd rather than rec/prop/wd, for consistency and to match usual IVOA usage.
      * _[[RayPlante]]: I agree that we should change the schema to match the IVOA usage._
   1. The !StandardKey/description element is declared with type xs:token, which as I understand it means that it can't contain line breaks etc.  That's OK, but probably the documentation should point out that it's for a short description so people know that a multi-paragraph entry is not appropriate.  Or, define it as some other data type (xs:string) suitable for longer descriptions.
      * _[[RayPlante]]:  Just to be clear, the xs:token type does not recommend or imply anything about the length of the value.  (And when it comes to documentation, IMHO, more is usually better than less. ;-) )  It was chosen so that (a) authors would not worry about superfluous spacing, and (b) consumers would feel free to re-format the content in a manner appropriate to the presentation.  That said, multi-paragraph entries would not be appropriate because any use of space to discriminate paragraphs would be obliterated under xs:token processing._
   1. Miscellaneous typos:
      * "The Virtual Observatory (VO) is general term..."
      * "...standards would represented via..."
      * "...schema call StandardsRegExt which allows..."
      * "complient"
      * "...onto IVOA identifier associated with..."
      * "...VOResource standard the defines extra..."
      * "...a controlled sets of..."
      * "...is that growing list of allowed names..." (-> growing the list?)
      * "...it is the practice VOResource..."
      * "...as a resource available via an IVOA-compliant registry..." (-> a resource is available?)
      * "... if there is only one standard ce, role..."
      * "An applications can..."
      * "...dereferencing in not necessary..."
         * corrected in latest draft IVOA.PaulHarrison
   2. Document processing: the section numbers appear twice in section headings (e.g. "3.1.2. 3.1.2. !ServiceStandard")
      * there was some javascript that was auto-numbering as well - this has been removed in latest draft IVOA.PaulHarrison
-- IVOA.MarkTaylor - 28 Apr 2011
<br/>

---+++ Comments from IVOA.TheresaDower
A meta-comment, perhaps. Are there and should there be plans for an IVOA-maintained RegistryOfRegistries-included publishing registry for physically storing these standards resources as they are written? I can see some benefit in various registries' pretty-print resource views being able to display these as linked from the resources of the standards types they describe.

-- IVOA.TheresaDower - 12 May 2011

<!--
      * Set ALLOWTOPICRENAME = %MAINWEB%.TWikiAdminGroup
-->
Topic revision: r8 - 2011-05-12 - TheresaDower
IVOA
Log in or Register
IVOA.net
Wiki Home
WebChanges
WebTopicList
WebStatistics
Twiki Meta & Help
IVOA
Know
Main
Sandbox
TWiki
TWiki intro
TWiki tutorial
User registration
Notify me
Working Groups
Interest Groups
Time Domain
Committees
Stds&Procs
www.ivoa.net
Documents
Events
Members
XML Schema