Difference: WriteAStandardsRecord (1 vs. 4)

Revision 42018-05-07 - MarkusDemleitner

 
META TOPICPARENT name="IvoaResReg"

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 StandardsRegExt, but trying to work through that document and all the prerequisites just to write a record for your standard would be overkill.

Changed:
<
<
Rather, start from a template that is provided as part of the ivoatex authoring system. The template can of course also be used on its own without ivoatex.
>
>
Rather, start from a template that is provided as part of the ivoatex authoring system.
  A filled-out example (albeit a bit artificial, since ivoatexDoc is just a Note) is part of ivoatexDoc, as a file with extension .vor.
Changed:
<
<
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:
>
>
If working with ivoatex in the recommended way, authors should thus
Added:
>
>
automatically have their standards record under version control (see the ivoatex documentation for details). Even if you don't use ivoatex for authoring, you can still start from the template given there by saying:
 
Changed:
<
<
svn copy ivoatex/stdrec-template.xml ExampleStandard.vor
>
>
9svn copy ivoatex/stdrec-template.xml ExampleStandard.vor
 
Deleted:
<
<
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.
<--  
-->

Revision 32016-06-09 - TheresaDower

 
META TOPICPARENT name="IvoaResReg"

Writing Registry Records for IVOA Standards

Changed:
<
<
Standard authors using IVOIDs in their standards (for instance, to give capability identifiers) must, others should submit registry records for their documents. This page tries to guide you through this process.
>
>
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.
 
Changed:
<
<
StandardarsRegExt would allow 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.
>
>
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 StandardsRegExt, but trying to work through that document and all the prerequisites just to write a record for your standard would be overkill.

Changed:
<
<
Rather, start from a template that is provided as part of the ivoatex authoring system; of course, it can be used without ivoatex, too.
>
>
Rather, start from a template that is provided as part of the ivoatex authoring system. The template can of course also be used on its own without ivoatex.
 
Changed:
<
<
A filled-out example (albeit a bit artificial, since ivoatexDoc is just a Note)
>
>
A filled-out example (albeit a bit artificial, since ivoatexDoc is just a Note) is part of ivoatexDoc, as a file with extension .vor.
Deleted:
<
<
is part of ivoatexDoc.
 
Changed:
<
<
If working with ivoatex in the recommended way, authors should have their standards record under version control, too. It is recommended to say
>
>
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:
 
   svn copy ivoatex/stdrec-template.xml ExampleStandard.vor
Changed:
<
<
and edit ExampleStandard.vor.
>
>
and then edit ExampleStandard.vor to suit your standard.
 

Validating the Record

Changed:
<
<
You should validate the record you have written before submitting it. The template has all the declarations that should allow an XML schema validator to work.
>
>
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

Changed:
<
<
Send the finished record in an attachment to ivoa-rofr@cfa.harvard.edu
>
>
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.
<--  
-->

Revision 22016-06-08 - MarkusDemleitner

 
META TOPICPARENT name="IvoaResReg"

Writing Registry Records for IVOA Standards

Changed:
<
<
Standard authors using IVOIDs in their standards (for instance, to give
>
>
Standard authors using IVOIDs in their standards (for instance, to give capability identifiers) must, others should submit registry records for their documents. This page tries to guide you through this process.
Deleted:
<
<
capability identifiers) must, others should submit registry records for their documents. This page tries to guide you through this process.
 
Changed:
<
<

Starting a record from scratch

>
>
StandardarsRegExt would allow 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.
 
Changed:
<
<
The format of the registry record is prescribed by
>
>

Starting a Record from Scratch

Deleted:
<
<
StandardsRegExt, but trying to work through that document and all the prerequisites just to write a record for your standard would be overkill.
 
Changed:
<
<
Rather, start from a
>
>
The format of the registry record is prescribed by StandardsRegExt, but trying to work through that document and all the prerequisites just to write a record for your standard would be overkill.
Deleted:
<
<
template that is provided as part of the ivoatex authoring system; of course, it can be used without ivoatex, too.
 
Changed:
<
<
If working with ivoatex in the recommended way, authors should have
>
>
Rather, start from a template that is provided as part of the ivoatex authoring system; of course, it can be used without ivoatex, too.
Deleted:
<
<
their standards record under version control, too. It is recommended to say
 
Added:
>
>
A filled-out example (albeit a bit artificial, since ivoatexDoc is just a Note) is part of ivoatexDoc.

If working with ivoatex in the recommended way, authors should have their standards record under version control, too. It is recommended to say

 
   svn copy ivoatex/stdrec-template.xml ExampleStandard.vor
Changed:
<
<
and edit ExampleStandard.vor.
>
>
and edit ExampleStandard.vor.
 
Changed:
<
<

Revision 12016-06-08 - MarkusDemleitner

 
META TOPICPARENT name="IvoaResReg"

Writing Registry Records for IVOA Standards

Standard authors using IVOIDs in their standards (for instance, to give capability identifiers) must, others should submit registry records for their documents. This page tries to guide you through this process.

Starting a record from scratch

The format of the registry record is prescribed by 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 template that is provided as part of the ivoatex authoring system; of course, it can be used without ivoatex, too.

If working with ivoatex in the recommended way, authors should have their standards record under version control, too. It is recommended to say

   svn copy ivoatex/stdrec-template.xml ExampleStandard.vor

and edit ExampleStandard.vor.


<--  
-->
 
This site is powered by the TWiki collaboration platform Powered by Perl This site is powered by the TWiki collaboration platformCopyright © 2008-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback