(r9) VOResourceV010 < IVOA

IVOA Web>IvoaResReg>IVOARegWp03>RWP03Specs>VOResourceV010 (revision 9) (raw view)~~EditAttach~~

<small>Jumps:  IvoaResReg :: [[http://www.ivoa.net/forum/registry/][registry mail archive]] :: ResourceMetadata :: [[RWP03RefBack]] :: [[RWP03Disc]] </small>

---++!! Registry Working Group WP3 (Metadata Specifications)
---+!! VOResource v0.10 and its Standard Extensions

   * Download all schemas and examples together [[#DownloadAll][below]]
   * [[VOResourceV010Disc]]: Discussion of this release

__Contents__
%TOC%
---

---++ The Schemas

VOResource, in general, refers to a family of schemas that includes the core schema (VOResource-v0.10) and a set of standard extensions.
These schemas are have been released from the official [[http://www.ivoa.net/xml/][IVOA schema distribution area]].  To validate documents compliant with this release you need each of the following schemas:

|*Schema* | *Description* | *Documentation* |
|[[http://www.ivoa.net/xml/VOResource/VOResource-v0.10.xsd][VOResource-v0.10.xsd]] requires  [[http://www.ivoa.net/xml/VOResource/VOResourceRelType-v0.10.xsd][VOResourceRelType-v0.10.xsd]]| core resource metadata | coming soon |
|[[http://www.ivoa.net/xml/VORegistry/VORegistry-v0.3.xsd][VORegistry-v0.3.xsd]] | extension for describing registries and naming authorities | coming soon |
|[[http://www.ivoa.net/xml/VODataService/VODataService-v0.5.xsd][VODataService-v0.5.xsd]] requires [[http://www.ivoa.net/xml/VODataService/VODataServiceCoverage-v0.5.xsd][VODataServiceCoverage-v0.5.xsd]] | extension for describing data and services | coming soon |

The following two extensions are extensions that define specific, standard <em>tabular sky services</em>.  

|[[http://www.ivoa.net/xml/ConeSearch/ConeSearch-v0.3.xsd][ConeSearch-v0.3.xsd]] | extension for describing Cone Search Services | [[http://www.us-vo.org/pubs/files/conesearch.html][service spec.]], <br> schema docs: coming soon |
|[[http://www.ivoa.net/xml/SIA/SIA-v0.7.xsd][SIA-v0.7.xsd]] | extension for describing Simple Image Access Services | [[http://www.us-vo.org/pubs/files/ACF8DE.pdf][service spec.]], <br> schema docs: coming soon |

#DownloadAll You can download all the schemas (with the examples) in a single bundle.  Two versions are available.  When these packages are unpacked, all of the files are put in the current directory.  

   VOResource-v0.10&nbsp;([[%ATTACHURL%/VOResource-v0.10.tar.gz][tar.gz]],&nbsp;[[%ATTACHURL%/VOResource-v0.10.zip][zip]]): the official schemas from the table above.

   VOResource-v0.10-local&nbsp;([[%ATTACHURL%/VOResource-v0.10-local.tar.gz][tar.gz]],&nbsp;[[%ATTACHURL%/VOResource-v0.10-local.zip][zip]]): the official schemas with "schemaLocation" set to look for imports on local disk.  This version enables a verifier to look for schemas in the current directory instead from the IVOA site.  Use this version when developing off-line or with tools that have trouble finding imported schemas.  
   

---++ Example documents

   [[%ATTACHURL%/organisation.xml][organisation.xml]]: o&nbsp; a simple description of an organisation <br/>  o&nbsp; uses only the core VOResource schema 

   [[%ATTACHURL%/collection.xml][collection.xml]]:  o&nbsp; a description of a data collection <br/>  o&nbsp; uses VOResource and <nop>VODataService <br/>  o&nbsp; includes a simple coverage description 

   [[%ATTACHURL%/webform.xml][webform.xml]]:  o&nbsp; a description of an archive search page used interactively with a browser <br/>  o&nbsp; described as a resource of type _<nop>SkyService_ <br/>  o&nbsp; illustrates the use of the "service-for" relationship <br/>  o&nbsp; uses VOResource and <nop>VODataService 

   [[%ATTACHURL%conesearch.xml][conesearch.xml]]:  o&nbsp; a description of a [[http://www.us-vo.org/pubs/files/conesearch.html][Cone Search]] service  <br/> o&nbsp; interface description includes the supported input parameters <br/> o&nbsp; includes a description of the returned output table  <br/> o&nbsp; uses VOResource, <nop>VODataService, and  <nop>ConeSearch  

   [[%ATTACHURL%/sia.xml][sia.xml]]:  o&nbsp; a description of a [[http://www.us-vo.org/pubs/files/ACF8DE.pdf][Simple Image Access]] service  <br/> o&nbsp; interface description includes the supported input parameters <br/> o&nbsp; includes a description of the returned output table  <br/> o&nbsp; uses VOResource, <nop>VODataService, and  SIA  

   [[%ATTACHURL%/registry.xml][registry.xml]]:  o&nbsp; a description of a registry (as a service).  <br/> o&nbsp; uses VOResource, <nop>VODataService, and VORegistry

   [[%ATTACHURL%/authority.xml][authority.xml]]:  o&nbsp; a description of a naming authority <br/>  o&nbsp; used to register authority names in a registry. <br/>  o&nbsp; uses uses VOResource and VORegistry

---++ What's New in this Release

The primary change is the way extensions are handled: we have dropped the use of substitution groups and replaced them with the use of xsi:type.  What looked like this in release v0.9...

<verbatim>
&lt;!-- the old way --&gt;
&lt;VOResource xmlns="..." &gt;
   &lt;vs:SkyService&gt;
      ...
</verbatim>

...now looks like this...

<verbatim>
&lt;!-- the new way --&gt;
&lt;resource xsi:type="vs:SkyService" xmlns="..." &gt;
      ...
</verbatim>

That is, you now see both specific type (<nop>SkyService) and the base concept it extends (resource) in the same element.  

Here's an abridged list of changes made.  (A more complete description can be found [[http://nvo.ncsa.uiuc.edu/VO/VOResource-v0.10-proposed/][here]].)

   * only global types are defined (anonymous types are avoided).
   * no global elements are defined; an application that uses VOResource can define its own global element(s) to use as a root element as necessary.  
   * references to other resources has been simplified
   * the logical ID element has been dropped
   * the generic Capabilities element has been dropped; specific standard services (e.g. <nop>ConeSearch, <nop>SimpleImageAccess) define these in their extensions.  

---+++ About the root element

As mentioned above, VOResource defines no global elements.  The proper root element is expected to be defined by the application, as necessary, via its own _application schema_.  For example, a particular application might define the following schema:

<verbatim>
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;xs:schema targetNamespace="http://astroservices.org/ResourceApplication"
           xmlns:xs="http://www.w3.org/2001/XMLSchema" 
           xmlns:vr="http://www.ivoa.net/xml/VOResource/v0.10" 
           xmlns:ra="http://astroservices.org/ResourceApplication" 
           elementFormDefault="qualified"
           attributeFormDefault="unqualified"
           version="0.10"&gt;

   &lt;xs:annotation&gt;
      &lt;xs:documenation&gt; application schema using VOResource &lt;/xs:documenation&gt;
   &lt;/xs:annotation&gt;

   &lt;xs:import namespace="http://www.ivoa.net/xml/VOResource/v0.10" /&gt;

   &lt;xs:element name="ResourceDescription" type="vr:Resource"/&gt;

   &lt;xs:element name="Resources"&gt;
      &lt;xs:complexType&gt;
         &lt;xs:sequence&gt;
            &lt;xs:element ref="ra:ResourceDescription" maxOccurs="unbounded" /&gt;
         &lt;/xs:sequence&gt;
      &lt;/xs:complexType&gt;
   &lt;/xs:element&gt;

&lt;/xs:schema&gt;
</verbatim>

In this example, two global elements have been defined, either which can be used as a root element.  The application would use this simple schema to verify its documents.  

Note that in the [[#Example_documents][example instance documents listed above]], an application schema is not needed.  That's because the root element in each case specifies its type using an =xsi:type= attribute.  According to the XML Schema standard, this is sufficient to verify the document.  

It is expected that *registry applications will use "resource" as the root element*, just like in the [[#Example_documents][examples listed above]].

---++ Useful Tools

---+++ Conversion Stylesheets

   * XSL Stylesheets for converting between v0.9 and v0.10
      * [[%ATTACHURL%/VOResource-v0.9-v0.10.xsl][VOResource-v0.9-v0.10.xsl]]: v0.9 to v0.10
      * [[%ATTACHURL%/VOResource-v0.10-v0.9.xsl][VOResource-v0.10-v0.9.xsl]]: v0.10 to v0.9

---++ Background Materials

   * IVOA Note: [[http://www.ivoa.net/Documents/latest/RMExp.html]["Lessons Learned Using VOResource v0.9 in the NVO"]] (Plante et al. 2004)

   * [[VOResource010RevNotes]]: Revision Notes and presentations 

   * The [[http://nvo.ncsa.uiuc.edu/VO/VOResource-v0.10-proposed/][Internal Release Page]] enumerated the main changes from v0.9.

---++ What's Ahead in Future Versions

   * If no fundemental problems are found with this release, it is expected that:
      * the next release of VOResource will be v1.0
      * each of the extensions will begin to evolve separately.
   * VORegistry will likely be updated as the standard Registry Interface is refined.  

<br><br><br>
<!--
      * Set ALLOWTOPICRENAME = %MAINWEB%.TWikiAdminGroup
-->

Attachments

Topic attachments
I	Attachment	History	Action	Size	Date	Who	Comment
gz	VOResource-v0.10-local.tar.gz	r1	manage	20.4 K	2004-07-16 - 04:17	RayPlante	Alll schemas & examples, for local disk access
zip	VOResource-v0.10-local.zip	r1	manage	28.4 K	2004-07-16 - 04:20	RayPlante	All schemas & examples, for local disk access
xsl	VOResource-v0.10-v0.9.xsl	r1	manage	58.3 K	2004-07-14 - 20:16	RayPlante	Converts v0.10 VOResource documents to v0.9
gz	VOResource-v0.10.tar.gz	r1	manage	20.4 K	2004-07-16 - 04:13	RayPlante	All schemas and examples in the v0.10 release
zip	VOResource-v0.10.zip	r1	manage	28.2 K	2004-07-16 - 04:15	RayPlante	All schemas and examples in the v0.10 release
xsl	VOResource-v0.9-v0.10.xsl	r2 r1	manage	55.6 K	2004-10-13 - 22:43	RayPlante	Converts v0.9 VOResource documents to v0.10

Topic revision: r9 - 2004-10-13 - RayPlante

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

Committees

Stds&Procs

www.ivoa.net
Documents
Events
Members
XML Schema