/[volute]/trunk/projects/edu/edumatters/edumatters.tex
ViewVC logotype

Diff of /trunk/projects/edu/edumatters/edumatters.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 4009 by msdemlei, Fri Apr 21 16:30:55 2017 UTC revision 4010 by msdemlei, Thu May 4 09:44:07 2017 UTC
# Line 338  Line 338 
338    
339  \begin{itemize}  \begin{itemize}
340    
341  \item EURO-VO AIDA WP5 - \url{http://wwwas.oats.inaf.it/aidawp5/eng_download.html}  \item EURO-VO AIDA WP5 -- \url{http://wwwas.oats.inaf.it/aidawp5/eng_download.html}
342    
343  \item EURO-VO Scientific Tutorials - \url{http://www.euro-vo.org/?q=science/scientific-tutorials}  \item EURO-VO Scientific Tutorials -- \url{http://www.euro-vo.org/?q=science/scientific-tutorials}
344    
345  \item VAO for Education - \url{http://virtualobservatory.org/education/}  \item GAVO tutorials --
346    \url{http://www.g-vo.org/pmwiki/Documents/Tutorials}
347    
348    \item CDS tutorials -- \url{http://cdsweb.u-strasbg.fr/tutorials/}
349  \end{itemize}  \end{itemize}
350    
351    
352  To date, such material has been collected informally by the various  To date, such material has been collected informally by the various
353  projects on plain web pages.  It is, in consequence, hard to find, with  projects on plain web pages.  It is, in consequence, hard to find, with
354  knowledge of it often passed on antecdotically. In order to improve upon  knowledge of its existence often passed on antecdotically. In order to improve upon
355  this situation, we  this situation, we
356  propose to keep record of educational material in the registry.  propose to keep record of educational material in the VO Registry.
357    
358  The VO already has a registry extension for standards, which of  The VO already has a registry extension for standards, which of
359  course are also text-like, StandardsRegExt \citep{2012ivoa.spec.0508H}.  This extension,  course are also text-like, StandardsRegExt \citep{2012ivoa.spec.0508H}.  This extension,
# Line 360  Line 362 
362  material.  Conversely, it is not concerned with document language (which  material.  Conversely, it is not concerned with document language (which
363  can safely be assumed to be English for standards), and it disregards  can safely be assumed to be English for standards), and it disregards
364  the issue of locating formatted and source versions, which for educational  the issue of locating formatted and source versions, which for educational
365  material is important.  We therefore propose a simple registry extension  material is important.  
366  covering text-like material, dubbed DocRegExt.  
367    Therefore, we believe text-like material should be described in a
368    registry extension of its own: DocRegExt.
369    
370    
371  \subsection{Use Cases}  \subsection{Use Cases}
# Line 380  Line 384 
384  \item Is there a tutorial covering working with X-Ray data? (Standard  \item Is there a tutorial covering working with X-Ray data? (Standard
385  VOResource is sufficient){}  VOResource is sufficient){}
386    
387  \item Is there a tutorial dealing with Planets suitable for school use?  \item Is there a tutorial dealing with planets suitable for school use?
388  (Standard VOResource is sufficient){}  (Standard VOResource is sufficient){}
389    
390  \item Is there a tutorial dealing with Planets suitable for school use in  \item Is there a tutorial dealing with planets suitable for school use in
391  Italian? (That requires the declaration of the document language){}  Italian? (That requires the declaration of the document language){}
392    
393  \item What are the subjects of maintained (in the sense of: probably  \item What are the subjects of maintained (in the sense of: probably
# Line 418  Line 422 
422  \end{itemize}  \end{itemize}
423    
424  An important additional use case is enabling an attractive, browsable  An important additional use case is enabling an attractive, browsable
425  ``roster'' of registred educational material.  A first attempt at such a  list of registred educational material.  A first attempt at such a
426  service is GAVO's VO Text Treasures (VOTT)  service is GAVO's VO Text Treasures (VOTT)
427  service\footnote{\url{http://dc.g-vo.org/VOTT}}.  It was found that one  service\footnote{\url{http://dc.g-vo.org/VOTT}}.  It was found that one
428  requirement resulting from this use case is direct access to formatted  requirement resulting from this use case is direct access to formatted
# Line 433  Line 437 
437    
438  \subsection{A Document Registry Extension}  \subsection{A Document Registry Extension}
439    
440    %% NOTE: When you change the schema, make Markus run a
441    %% make install-schema
442    %% to update the current "canonical" schema location.
443    
444  \label{sect:regext-ext}  \label{sect:regext-ext}
445    
446  To satisfy the requirements derived above, we have designed a registry extension with  To satisfy the requirements derived above, we have designed a registry extension with
447  two definitions. First, we re-use the \vorent{vs:CatalogService} type  two definitions.
448    To avoid unnecessary incompatibilities when migrating to a proper IVOA
449    standard, we use the namespace URI
450    
451    $$\hbox{\nolinkurl{http://www.ivoa.net/xml/DocRegExt-1.xsd}}$$
452    
453    for DocRegExt even while the schema cannot actually retrieved from
454    there.  The canonical schema location until the extension is endorsed by
455    the IVOA is \url{http://docs.g-vo.org/xml/DocRegExt-1.xsd}.
456    
457    The recommended schema prefix for DocRegExt is \texttt{doc}.
458    
459    To let authors define comprehensive metadata, the schema
460    re-uses the \vorent{vs:CatalogService} type
461  from VODataService 1.1 \citep{2010ivoa.spec.1202P} to construct  from VODataService 1.1 \citep{2010ivoa.spec.1202P} to construct
462  the \texttt{doc:Document} resource type.    the \vorent{doc:Document} resource type.
463    
464  While the schema does not limit what kinds of capabilities a  While the schema does not limit what kinds of capabilities a
465  \vorent{doc:Document} record has -- it is conceivable that tailored  \vorent{doc:Document} record has -- it is conceivable that tailored
# Line 450  Line 471 
471  furthermore allows a complete representation of the metadata in RegTAP  furthermore allows a complete representation of the metadata in RegTAP
472  without any extra tables (cf.~sect.~\ref{sect:docregext-regtap}).  without any extra tables (cf.~sect.~\ref{sect:docregext-regtap}).
473    
 For reference, Appendix \ref{app:schema} contains a rendering of the  
 extension schema as of the publication of the note.    
   
474  The resource-level reference URL in \vorent{doc:Document} records should  The resource-level reference URL in \vorent{doc:Document} records should
475  be some sort of landing page with an abstract of the text and links to  be some sort of landing page with an abstract of the text and links to
476  the full texts and perhaps the document source(s).  When using the  the full texts and perhaps the document source(s).  When using the
# Line 490  Line 508 
508          \hbox to 5.5em{\emph{#1}\hfil}}\vspace{2ex}\noindent\textbf{\xmlel{doc:Edition} Type Schema Documentation}          \hbox to 5.5em{\emph{#1}\hfil}}\vspace{2ex}\noindent\textbf{\xmlel{doc:Edition} Type Schema Documentation}
509    
510  \noindent{\small  \noindent{\small
511          An "edition" (typically: translation) of the document.          An “edition” (typically: translation) of the document.
512        \par}        \par}
513    
514  \noindent{\small  \noindent{\small
515          Although for a while, multiple editions of the document in one language          Although for a while, multiple editions of the document in one language
516          may be given (corresponding perhaps to two "major versions), in          may be given (corresponding perhaps to two “major” versions), in
517          general, only the latest version of the document per language should be          general, only the latest version of the document per language should be
518          given.          given.
519    
# Line 616  Line 634 
634  \end{lstlisting}  \end{lstlisting}
635    
636    
637  Here is a (slightly abridged) example record (TBD: update this):  Here is a (slightly abridged) example record\todo{Update this to the new
638    schema}:
639    
640  \lstinputlisting[language=XML,basicstyle=\footnotesize]{m1distance-example.xml}  \lstinputlisting[language=XML,basicstyle=\footnotesize]{m1distance-example.xml}
641    
# Line 628  Line 647 
647  and similar  and similar
648  material through standard registry interfaces, but keeping  material through standard registry interfaces, but keeping
649  tutorials up to date, in their master form and also in their translated  tutorials up to date, in their master form and also in their translated
650  versions, is another important issue to allow proficient use.  versions, is an obviously important management issue not really
651  A versioned repository (using subversion as the version control system)  addressed by the Registry.
652    
653    For tracking changes and versions, the standard tool is a version
654    control system.  Therefore,
655    a versioned repository (using subversion as the version control system)
656  has been set up at GAVO data  has been set up at GAVO data
657  center\footnote{\url{http://svn.ari.uni-heidelberg.de/svn/edu/}}  center\footnote{\url{http://svn.ari.uni-heidelberg.de/svn/edu/}}.
658  and collects part of the  It collects part of the
659  already existing VO tutorials with the goal of preserve them and let users  already existing VO tutorials with the goal of preserving them and
660    letting users
661  update and translate them.  update and translate them.
662  The repository has an internal structure that takes care for:  
663    The repository has an internal structure designed to enable:
664    
665  \begin{itemize}  \begin{itemize}
666    
# Line 743  Line 768 
768  \emph{education} level (up to  \emph{education} level (up to
769  \emph{university}).  \emph{university}).
770    
   
 \section{The proposed DocRegExt Schema}  
   
 \label{app:schema}  
   
 The following XML schema is given here for reference and convenience.  
 It should not be used in software development.  As long as the schema is  
 not formally endorsed by the IVOA, the authoritative version is the one  
 on  
 Volute\footnote{\url{https://volute.g-vo.org/svn/trunk/projects/edu/edumatters/DocRegExt-1.xsd}}.  
 We intend to have it endorsed by the IVOA, after which the canonical  
 source will be the IVOA schema repository.  
   
 \lstinputlisting[language=XML]{DocRegExt-1.xsd}  
   
771  \bibliography{ivoatex/ivoabib,ivoatex/docrepo}  \bibliography{ivoatex/ivoabib,ivoatex/docrepo}
772    
773  \end{document}  \end{document}

Legend:
Removed from v.4009  
changed lines
  Added in v.4010

msdemlei@ari.uni-heidelberg.de
ViewVC Help
Powered by ViewVC 1.1.26