Preparing for the release

Author: Savalle Renaud

Makefile

@@ -9,10 +9,10 @@ DOCNAME = StandardsRegExt
 DOCVERSION = 1.1
 
 # Publication date, ISO format; update manually for "releases"
-DOCDATE = 2024-01-25
+DOCDATE = 2025-10-31
 
 # What is it you're writing: NOTE, WD, PR, REC, PEN, or EN
-DOCTYPE = PR
+DOCTYPE = REC
 
 # An e-mail address of the person doing the submission to the document
 # repository (can be empty until a make upload is being made)

StandardsRegExt.tex

@@ -25,6 +25,7 @@
 
 \editor[http://www.ivoa.net/twiki/bin/view/IVOA/RenaudSavalle]{Renaud Savalle}
 
+\previousversion[https://ivoa.net/documents/StandardsRegExt/20240125]{PR-20240125}
 \previousversion[https://ivoa.net/documents/StandardsRegExt/20230921]{PR-20230921}
 \previousversion[https://ivoa.net/documents/StandardsRegExt/20120508/]{REC-1.0}
 \previousversion[http://www.ivoa.net/Documents/StandardsRegExt/20120217/]{
@@ -542,14 +543,10 @@ \subsubsection{Standard}
         \renewcommand*\descriptionlabel[1]{%
         \hbox to 5.5em{\emph{#1}\hfil}}\vspace{2ex}\noindent\textbf{\xmlel{vstd:Standard} Type Schema Documentation}
 
-\noindent{\small
-           a description of a standard specification.
-         \par}
+\noindent{\small{}a description of a standard specification.\par}
 
-\noindent{\small
-           This typically refers to an IVOA standard but is not
-           limited to such.
-         \par}
+\noindent{\small{}This typically refers to an IVOA standard but is not
+           limited to such.\par}
 
 \vspace{1ex}\noindent\textbf{\xmlel{vstd:Standard} Type Schema Definition}
 
@@ -577,53 +574,39 @@ \subsubsection{Standard}
 \begingroup\small\begin{bigdescription}\item[Element \xmlel{endorsedVersion}]
 \begin{description}
 \item[Type] a string with optional attributes
-\item[Meaning]
-                     the version of the standard that is recommended for use.
-
+\item[Meaning] the version of the standard that is recommended for use.
 \item[Occurrence] required; multiple occurrences allowed.
-\item[Comment]
-                     More than one version can be listed, indicating
+\item[Comment] More than one version can be listed, indicating
                      that any of these versions are recognized as
                      acceptable for use.
 
-
 \end{description}
 \item[Element \xmlel{schema}]
 \begin{description}
 \item[Type] composite: \xmlel{vstd:Schema}
-\item[Meaning]
-                     a description and pointer to a schema document
+\item[Meaning] a description and pointer to a schema document
                      defined by this standard.
-
 \item[Occurrence] optional; multiple occurrences allowed.
-\item[Comment]
-                     This is most typically an XML Schema, but it need
+\item[Comment] This is most typically an XML Schema, but it need
                      not be strictly.
 
-
 \end{description}
 \item[Element \xmlel{deprecated}]
 \begin{description}
 \item[Type] string: \xmlel{xs:token}
-\item[Meaning]
-                     when present, this element indicates that all
+\item[Meaning] when present, this element indicates that all
                      versions of the standard are considered
                      deprecated by the publisher.  The value is a
                      human-readable explanation for the designation.
-
 \item[Occurrence] optional
-\item[Comment]
-                     The explanation should indicate if another
+\item[Comment] The explanation should indicate if another
                      standard should be preferred.
 
-
 \end{description}
 \item[Element \xmlel{key}]
 \begin{description}
 \item[Type] composite: \xmlel{vstd:StandardKey}
-\item[Meaning]
-                     a defined key associated with this standard.
-
+\item[Meaning] a defined key associated with this standard.
 \item[Occurrence] optional; multiple occurrences allowed.
 
 \end{description}
@@ -697,64 +680,38 @@ \subsubsection{Standard}
 \item[status]
 \begin{description}
 \item[Type] string with controlled vocabulary
-\item[Meaning]
-                 the IVOA status level of this version of the standard.
-
+\item[Meaning] the IVOA status level of this version of the standard.
 \item[Occurrence] optional
 
-\item[Allowed Values]\hfil
-\begin{longtermsdescription}\item[rec]
-                            an IVOA Recommendation
-
-\item[pr]
-                            an IVOA Proposed Recommendation
-
-\item[wd]
-                            an IVOA Working Draft
-
-\item[iwd]
-                            an internal Working Draft of an IVOA Working Group
-
-\item[note]
-                            a published IVOA Note
-
-\item[pen]
-                            a Proposed Endorsed Note
-
-\item[en]
-                            an Endorsed Note
-
-\item[n/a]
-                            not an IVOA standard or protostandard at
+\item[Allowed Values\vrule width 0pt depth 5pt]\hfil
+           \begin{longtermsdescription}\item[rec]an IVOA Recommendation
+\item[pr]an IVOA Proposed Recommendation
+\item[wd]an IVOA Working Draft
+\item[iwd]an internal Working Draft of an IVOA Working Group
+\item[note]a published IVOA Note
+\item[pen]a Proposed Endorsed Note
+\item[en]an Endorsed Note
+\item[n/a]not an IVOA standard or protostandard at
                             this time.
-
 \end{longtermsdescription}
 \item[Default] n/a
-\item[Comment]
-                 For values of “rec”, “pr”, “wd”, “note”, “pen”, and “en” the
+\item[Comment] For values of “rec”, “pr”, “wd”, “note”, “pen”, and “en” the
                  record's referenceURL element should point to the
                  official specification document in the IVOA Document
                  Repository; if the document does not appear there,
                  these values should not be used.
-
 \end{description}
 \item[use]
 \begin{description}
 \item[Type] string with controlled vocabulary
-\item[Meaning]
-                 A designation of preference for the version compared
+\item[Meaning] A designation of preference for the version compared
                  to other versions in use.
-
 \item[Occurrence] optional
 
-\item[Allowed Values]\hfil
-\begin{longtermsdescription}\item[preferred]
-                            the most preferred version.
-
-\item[deprecated]
-                            a version whose use is now discouraged
+\item[Allowed Values\vrule width 0pt depth 5pt]\hfil
+           \begin{longtermsdescription}\item[preferred]the most preferred version.
+\item[deprecated]a version whose use is now discouraged
                             because a newer version is preferred.
-
 \end{longtermsdescription}
 \end{description}
 
@@ -799,9 +756,7 @@ \subsubsection{Standard}
         \renewcommand*\descriptionlabel[1]{%
         \hbox to 5.5em{\emph{#1}\hfil}}\vspace{2ex}\noindent\textbf{\xmlel{vstd:Schema} Type Schema Documentation}
 
-\noindent{\small
-           a description of a schema definition
-         \par}
+\noindent{\small{}a description of a schema definition\par}
 
 \vspace{1ex}\noindent\textbf{\xmlel{vstd:Schema} Type Schema Definition}
 
@@ -825,16 +780,12 @@ \subsubsection{Standard}
 \item[namespace]
 \begin{description}
 \item[Type] string: \xmlel{xs:token}
-\item[Meaning]
-               an identifier for the schema being described.  Each instance
+\item[Meaning] an identifier for the schema being described.  Each instance
                of this attribute must be unique within the resourse description.
-
 \item[Occurrence] required
-\item[Comment]
-               For XML schemas, this should be the schema's namespace URI.
+\item[Comment] For XML schemas, this should be the schema's namespace URI.
                Otherwise, it should be a unique label to distinguish it from
                other schemas described in the same resource description.
-
 \end{description}
 
 
@@ -847,47 +798,35 @@ \subsubsection{Standard}
 \begingroup\small\begin{bigdescription}\item[Element \xmlel{location}]
 \begin{description}
 \item[Type] a URI: \xmlel{xs:anyURI}
-\item[Meaning]
-                  A URL pointing to a document that formally defines
+\item[Meaning] A URL pointing to a document that formally defines
                   the schema.
-
 \item[Occurrence] required
-\item[Comment]
-                  The document should be in a machine-parsable format
+\item[Comment] The document should be in a machine-parsable format
                   when applicable.  For example, when refering to an
                   XML schema, the document should be an XML Schema or
                   similar document that can be used to validate an
                   instance document.
 
-
 \end{description}
 \item[Element \xmlel{description}]
 \begin{description}
 \item[Type] string: \xmlel{xs:token}
-\item[Meaning]
-                  A human-readable description of what the schema
+\item[Meaning] A human-readable description of what the schema
                   defines or is used for.
-
 \item[Occurrence] optional
-\item[Comment]
-                  A brief description--e.g. one statement--is
+\item[Comment] A brief description--e.g. one statement--is
                   recommended for display purposes.
 
-
 \end{description}
 \item[Element \xmlel{example}]
 \begin{description}
 \item[Type] a URI: \xmlel{xs:anyURI}
-\item[Meaning]
-                  A URL pointing to a sample document that illustrates
+\item[Meaning] A URL pointing to a sample document that illustrates
                   the use of the schema.
-
 \item[Occurrence] optional; multiple occurrences allowed.
-\item[Comment]
-                  When applicable (e.g. XML), the document should be
+\item[Comment] When applicable (e.g. XML), the document should be
                   in the format defined by the schema document.
 
-
 \end{description}
 
 
@@ -926,14 +865,10 @@ \subsubsection{ServiceStandard}
         \renewcommand*\descriptionlabel[1]{%
         \hbox to 5.5em{\emph{#1}\hfil}}\vspace{2ex}\noindent\textbf{\xmlel{vstd:ServiceStandard} Type Schema Documentation}
 
-\noindent{\small
-           a description of a standard service protocol.
-         \par}
+\noindent{\small{}a description of a standard service protocol.\par}
 
-\noindent{\small
-           This typically refers to an IVOA standard but is not
-           limited to such.
-         \par}
+\noindent{\small{}This typically refers to an IVOA standard but is not
+           limited to such.\par}
 
 \vspace{1ex}\noindent\textbf{\xmlel{vstd:ServiceStandard} Type Schema Definition}
 
@@ -955,20 +890,15 @@ \subsubsection{ServiceStandard}
 \begingroup\small\begin{bigdescription}\item[Element \xmlel{interface}]
 \begin{description}
 \item[Type] composite: \xmlel{vr:Interface}
-\item[Meaning]
-                      an abstract description of one of the interfaces defined
+\item[Meaning] an abstract description of one of the interfaces defined
                       by this service standard.
-
 \item[Occurrence] optional; multiple occurrences allowed.
-\item[Comment]
-                      This element can provide details about the interface
+\item[Comment] This element can provide details about the interface
                       that apply to all implementations.  Each interface
                       element should specify a role with a value starting
                       with {"}std:{"} or, if there is only one standard interface,
                       is equal to {"}std{"}.
-
-\item[Comment]
-                      Applications that, for example, wish to build a GUI
+\item[Comment] Applications that, for example, wish to build a GUI
                       to the service on-the-fly would first access this generic
                       description.  Site-specific variations, such
                       as supported optional arguments or site specific
@@ -977,17 +907,14 @@ \subsubsection{ServiceStandard}
                       found in this generic description.  This generic interface
                       description can be matched with the site-specific one
                       using the role attribute.
-
-\item[Comment]
-                      Even though the Interface type requires an
+\item[Comment] Even though the Interface type requires an
                       accessURL child element, this element is
                       intended to describe a service in the
                       abstract--i.e. without reference to a particular
                       installation of the service.  Consequently,
                       the accessURL may contain a bogus URL;
                       applications should not expect it to be resolvable.
 
-
 \end{description}
 
 
@@ -1089,21 +1016,15 @@ \subsection{Defining Keys: StandardKey and StandardKeyURI}
         \renewcommand*\descriptionlabel[1]{%
         \hbox to 5.5em{\emph{#1}\hfil}}\vspace{2ex}\noindent\textbf{\xmlel{vstd:StandardKey} Type Schema Documentation}
 
-\noindent{\small
-            The name and definition of a key--a named concept,
-            feature, or property.
-         \par}
+\noindent{\small{}The name and definition of a key--a named concept,
+            feature, or property.\par}
 
-\noindent{\small
-            This key can be identified via an IVOA identifier
+\noindent{\small{}This key can be identified via an IVOA identifier
             of the form ivo://authority/resource\#name where name is
-            the value of the child name element.
-         \par}
+            the value of the child name element.\par}
 
-\noindent{\small
-            This type can be extended if the key has
-            other metadata associated with it.
-         \par}
+\noindent{\small{}This type can be extended if the key has
+            other metadata associated with it.\par}
 
 \vspace{1ex}\noindent\textbf{\xmlel{vstd:StandardKey} Type Schema Definition}
 
@@ -1121,24 +1042,20 @@ \subsection{Defining Keys: StandardKey and StandardKeyURI}
 \begingroup\small\begin{bigdescription}\item[Element \xmlel{name}]
 \begin{description}
 \item[Type] string of the form: \emph{([A-Za-z0-9;/$\backslash$?:@\&=$\backslash$+\$,$\backslash$-\_$\backslash$.!~$\backslash$*'$\backslash$($\backslash$)]|\%[A-Fa-f0-9]\{2\})+}
-\item[Meaning]
-                  The property identifier which would appear as the
+\item[Meaning] The property identifier which would appear as the
                   fragment (string after the pound sign, \#) in an IVOA
                   identifier.
                   To facilitate comparisons of such keys given that
                   registry identifiers are case insensitive, all newly
                   created standard keys must not contain uppercase letters.
-
 \item[Occurrence] required
 
 
 \end{description}
 \item[Element \xmlel{description}]
 \begin{description}
 \item[Type] string: \xmlel{xs:token}
-\item[Meaning]
-                  A human-readable definition of this property.
-
+\item[Meaning] A human-readable definition of this property.
 \item[Occurrence] required
 
 \end{description}