(r3) WriteAStandardsRecord < IVOA

IVOA Web>IvoaResReg>WriteAStandardsRecord (revision 3) (raw view)~~EditAttach~~

---++ Writing Registry Records for IVOA Standards

Authors of IVOA standards which use IVOIDs (for instance, to reference capability identifiers) must submit registry records for their documents, and authors of IVOA standards without IVOIDS should as well. This page tries to guide you through this process.

!StandardarsRegExt allows the tracking of the IVOA documents process, including notes, working drafts and proposed recommendations. In practice, at this point we rely on the web-based IVOA document repository for this, and the Registry is (almost) exclusively concerned with finished recommendations.

---+++ Starting a Record from Scratch

The format of the registry record is prescribed by [[http://ivoa.net/documents/StandardsRegExt/][StandardsRegExt]], but trying to work through that document and all the prerequisites just to write a record for your standard would be overkill.

Rather, start from a [[http://volute.g-vo.org/svn/trunk/projects/ivoapub/ivoatex/stdrec-template.xml][template]] that is provided as part of the [[http://ivoatex.g-vo.org][ivoatex]] authoring system. The template can of course also be used on its own without ivoatex.

A filled-out example (albeit a bit artificial, since ivoatexDoc is just a Note) is [[http://volute.g-vo.org/svn/trunk/projects/ivoapub/ivoatexDoc][part of ivoatexDoc]], as a file with extension .vor.

If working with ivoatex in the recommended way, authors should thus automatically have their standards record under version control. It is recommended to use svn to access the volute repository for the ivoatex system, and say:

<verbatim>
	svn copy ivoatex/stdrec-template.xml ExampleStandard.vor
</verbatim>

and then edit !ExampleStandard.vor to suit your standard.

---+++ Validating the Record

You should validate the record you have written before submitting it. The template contains all the declarations that should allow an XML schema validator to work.

If you do not have a working XML schema validator locally, we recommend just using an online service. At the time of writing, https://www.corefiling.com/opensource/schemaValidate.html seems to work nicely. You do not have to select an XML Schema, just upload your file as XML Instance (privacy-conscious users are advised that they need to enable referrer sending for that site).

XML schema is not a great standard, and so the error messages may be a bit cryptic. If you need help, ask over on registry@ivoa.net.

---+++ Submitting the Record

Send the finished record in an email attachment to ivoa-rofr@cfa.harvard.edu

---+++ Updating the record

On updating, please make sure that you have updated:

   * Resource/@updated
   * creator if there are new/different authors/editors (by IVOA convention, editors should be at the start of the author list)
   * curation/date[@role="update"]
   * the abstract
   * endorsedVersion, including its status.
<!--
      * Set ALLOWTOPICRENAME = IVOA.TWikiAdminGroup
-->

Topic revision: r3 - 2016-06-09 - 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