[Volute] r4925 - trunk/projects/ivoapub/ivoatexDoc

Volute commit messages volutecommits at g-vo.org
Tue Apr 17 12:15:17 CEST 2018

Author: msdemlei
Date: Tue Apr 17 12:15:16 2018
New Revision: 4925

ivoatexDoc: Adding a bit about standardsRegExt records.

      - copied, changed from r4621, trunk/projects/ivoapub/ivoatex/stdrec-template.xml

Modified: trunk/projects/ivoapub/ivoatexDoc/ivoatexDoc.tex
--- trunk/projects/ivoapub/ivoatexDoc/ivoatexDoc.tex	Mon Apr 16 18:47:18 2018	(r4924)
+++ trunk/projects/ivoapub/ivoatexDoc/ivoatexDoc.tex	Tue Apr 17 12:15:16 2018	(r4925)
@@ -381,7 +381,7 @@
 stand-in will be built if your system lacks the software to do this
 conversion.  It should be fine to use common vector graphic tools like
 inkscape to perform the conversion in that case.
-As long as the tooling situation regarding \LaTeX and SVG is as
+As long as the tooling situation regarding \LaTeX~and SVG is as
 unsatisfactory as it is, please commit both \texttt{archdiag.svg} and
 \texttt{archdiag.pdf} to the version control system.
@@ -914,6 +914,48 @@
 identical to the document author, and the makefile can already contain
 arbitrary commands that would be executed on the calling user's behalf.
+\subsection{The Standards Record}
+IVOA recommendations and endorsed notes must be registered using the
+schema from StandardsRegExt \citep{2012ivoa.spec.0508H}.  A major use
+case for this is to allow references to standards from other registry
+records. The prototypcial example for this is the \xmlel{standardID}
+attribute of VOResource \xmlel{capability} elements that contains
+identifiers (and possibly standard keys as fragment identifiers)
+declaring ``this service works as specificed by that standard''.
+Registration of IVOA-approved standards happens through the registry of
+registries (RofR, authority ivoa.net).  The preparation of the registry
+records, however, is up to the document editor.  It is strongly
+recommended to keep and maintain the registry record in version control
+alongside with the document source.
+To do that, create a standards record from ivoatex's template (assuming
+operation within an svn checkout):
+$ svn copy ivoatex/stdrec-template.xml stdrec.xml
+In the resulting file, the items one has to change are marked with four
+hash marks; the elements \xmlel{schema} and \xmlel{key} can be removed
+or repeated as required by a particular standard, all other elements
+present should be given at least once.  Please remove the explanatory
+comments as you go. 
+A sample record filled out for this document is kept in the subversion
+repository (but not uploaded into the Registry, as Notes do not usually
+require registration).
+Most of the metadata to be filled in actually already is available in
+structured form in \ivoatex.  Contributions that help automating
+creation and maintenance of stdrec.xml exploiting this are welcome.
+With the upload of a proposed recommendation to the document repository,
+the editor should send the standards record to the registry of
+registries by e-mail\footnote{See \url{http://rofr.ivoa.net/} for
+contact information.} and then re-submit the record with each upload.
 \section{Customisation and Development}

Copied and modified: trunk/projects/ivoapub/ivoatexDoc/stdrec.xml (from r4621, trunk/projects/ivoapub/ivoatex/stdrec-template.xml)
--- trunk/projects/ivoapub/ivoatex/stdrec-template.xml	Fri Dec 15 10:09:11 2017	(r4621, copy source)
+++ trunk/projects/ivoapub/ivoatexDoc/stdrec.xml	Tue Apr 17 12:15:16 2018	(r4925)
@@ -1,20 +1,11 @@
-<!-- A template for a registry record for a standard.
+<!-- This standards record is intended as an example for ivoatex.
+It has *not* been uploaded into the RofR and should not be, as ivoatexDoc
+is just a Note and we don't want to clutter the registry. -->
-See http://wiki.ivoa.net/twiki/bin/view/IVOA/WriteAStandardsRecord
-for the why and what of this.
-It is hoped that the embedded comments will guide you to producing
-a correct and semantically useful registry record.
-You will need to change everything marked with ####
-<!-- initially, set created and updated to (roughly) UTC of now.
-change updated whenever you re-upload this record. -->
-	created="####" 
-	updated="####"
+	created="2018-04-17T08:58:00Z" 
+	updated="2018-04-17T08:58:00Z" 
@@ -27,68 +18,49 @@
-  <title>####</title> <!-- title as given on the standard's title page -->
-  <shortName>####</shortName> <!-- this should be your DOCNAME -->
-	<!-- put the "short name" of your standard after std/: -->
-  <identifier>ivo://ivoa.net/std/####</identifier> 
+  <title>The ivoaTeX Document Preparation System</title>
+  <shortName>ivoatexDoc</shortName>
+  <identifier>ivo://ivoa.net/std/ivoatexDocidentifier> 
-    <!-- author name(s), preferably in Last, I. form; one creator
-    element per author -->
-      <name>####</name>
+      <name>Demleitner, M.</name>
+    </creator>
+    <creator>
+      <name>Taylor, M.</name>
-      <name>####</name>
+      <name>Harrison, P.</name>
+    </creator>
+    <creator>
+      <name>Molinaro, M.</name>
-		<!-- this should be the date of the last recommendation -->
-    <date role="update">####</date>
-    <version>####</version> <!-- the document version -->
+    <date role="update">2016-04-30</date>
+    <version>1.1</version>
-      <name>####</name> <!-- typcially, the name of the main WG/IG-->
-      <email>####</email> <!-- typically, the mailing list address -->
+      <name>IVOA Committee on Standards and Processes</name>
+      <email>stdproc at ivoa.net</email>
     <subject>Virtual observatory</subject>
-    <!-- you can give further keywords, one per subject element;
-    use the IVOA thesaurus if possible:
-    http://www.ivoa.net/rdf/Vocabularies/vocabularies-20091007/IVOAT/IVOAT.html
-    -->
-    <subject>####</subject>
+    <subject>Pubication tools</subject>
-    	#### (your abstract; no markup here, please)
+    	This note describes the IVOATeX document preparation system for IVOA
+    	standards and notes. IVOATeX supports the production of PDF and HTML
+    	renderings of the documents with sources in plain text suitable for
+    	version control, as is desirable for normative texts. This note contains
+    	a user guide as well as a discussion of IVOATeX's dependencies and its
+    	implementation. It refers to version 1.0 of the software.
-    <referenceURL>#### (the generic landing page URL, e.g.
-    	http://ivoa.net/documents/SAMP/)</referenceURL>
+    <referenceURL
+    	>http://ivoa.net/documents/notes/ivoatex/index.html</referenceURL>
-  <!-- Version(s) of the standard that should be used.  In general,
-  	you'll only have exactly one endorsedVersion with status="rec",
-  	but situations are imaginable where you have multiple endorsed
-  	versions, perhaps even with non-rec status (though you should probably
-  	ask the TCG before going there). -->
-  <endorsedVersion status="rec">####</endorsedVersion>
-	<!-- If your standard provides schema file(s), list their canonical
-		URL(s) here.  Only list the most recent versions. Otherwise, just
-		delete this element. -->
-	<schema>####</schema>
-	<!-- You can furthermore have as many key-value pairs as you want.
-		Service standard authors will need this to comply with Identifier 2.0's
-		recommendation for standardId 
-		(http://www.ivoa.net/documents/IVOAIdentifiers/20150709/PR-Identifiers-2.0-20150709.html#tth_sEc4.2) -->
-	<key>
-		<name>####</name>
-		<description>####
-		</description>
-	</key>
+  <endorsedVersion status="note">1.1</endorsedVersion>

More information about the Volutecommits mailing list