Merge pull request #1 from pdowler/master

import from volute, add ivoatex submodule, add CI workflow
ivoa-std · Sep 2, 2020 · 6a9d133 · 6a9d133
2 parents f94b320 + b979a27
commit 6a9d133
Show file tree

Hide file tree

Showing 10 changed files with 2,317 additions and 0 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,32 @@
+name: CI build of the standard
+
+on: 
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+      with:
+        submodules: true
+    - name: Setup dependencies
+      run: |
+        sudo apt update
+        sudo apt install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended xsltproc ghostscript cm-super librsvg2-bin inkscape
+      
+    - name: Build the document
+      run: make role_diagram.pdf biblio forcetex
+
+    - name: Check the output
+      run: |
+        test -f TAP.pdf
+        test -f TAP.bbl
+        
+    - uses: actions/upload-artifact@v1
+      with:
+        name: TAP.pdf Preview
+        path: TAP.pdf
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "ivoatex"]
+	path = ivoatex
+	url = https://github.com/ivoa-std/ivoatex
diff --git a/LICENSE b/LICENSE
diff --git a/Makefile b/Makefile
@@ -0,0 +1,25 @@
+# ivoatex Makefile.  The ivoatex/README for the targets available.
+
+# short name of your document (edit $DOCNAME.tex; would be like RegTAP)
+DOCNAME = TAP
+
+# count up; you probably do not want to bother with versions <1.0
+DOCVERSION = 1.1
+
+# Publication date, ISO format; update manually for "releases"
+DOCDATE = 2019-09-27
+
+# What is it you're writing: NOTE, WD, PR, or REC
+DOCTYPE = REC
+
+# Source files for the TeX document (but the main file must always
+# be called $(DOCNAME).tex
+SOURCES = $(DOCNAME).tex examples-sample.html sample-capability.xml
+
+# List of pixel image files to be included in submitted package 
+FIGURES = role_diagram.pdf
+
+# List of PDF figures (for vector graphics)
+VECTORFIGURES = 
+
+include ivoatex/Makefile
diff --git a/TAP.tex b/TAP.tex
diff --git a/archdiag.png b/archdiag.png
diff --git a/examples-sample.html b/examples-sample.html
@@ -0,0 +1,72 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.1//EN" 
+  "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" version="XHTML+RDFa 1.1">
+<head>
+  <title>An Example for /examples</title>
+</head>
+<body vocab="http://www.ivoa.net/rdf/examples#">
+  <h1>An Example for /examples</h1>
+
+  <p>This document illustrates how to write a DALI-compliant examples 
+  document using TAP's special table and query properties.  Apart from the 
+  actual examples blocks, you can add arbitrary additional material, for
+  instance, a table of contents:</p>
+
+  <ul id="toc">
+    <li>
+      <a href="#QueryforCALIFAobjectproperties"
+        >Query for CALIFA object properties</a>
+    </li>
+    <li>
+     <a href="#Queryagainstcoverage"
+       >Query against coverage</a>
+    </li>
+  </ul>
+
+  <p>Use the <a href="https://www.w3.org/2012/pyRdfa/Validator.html"
+  >W3C RDFa validator</a> to see what semantics your RDFa actually
+  conveys.</p>
+
+  <div typeof="example" 
+      id="QueryforCALIFAobjectproperties" 
+      resource="#QueryforCALIFAobjectproperties">
+    <h2 property="name">Query for CALIFA object properties</h2>
+    <p>This example shows how to combine the 
+    <a href="/tableinfo/califadr3.objects">&#x2197;</a
+    ><em property="table">califadr3.objects</em> table
+    of properties of CALIFA target galaxies with the 
+    <a href="/tableinfo/califadr3.cubes">&#x2197;</a
+    ><em class="dachs-ex-taptable" property="table">califadr3.cubes</em>
+    table of data cubes to select bright, early-type spirals:</p>
+    <pre class="dachs-ex-tapquery literal-block" property="query">
+SELECT target_name, accref, hubtyp, magg
+FROM califadr3.cubes
+  NATURAL JOIN califadr3.objects
+WHERE hubtyp in ('S d', 'S cd', 'S c')
+  AND magg&lt;13
+    </pre>
+  </div>
+
+  <div typeof="example" 
+      id="Queryagainstcoverage" 
+      resource="#Queryagainstcoverage">
+    <h2 property="name">Query against coverage</h2>
+    <p>When querying against geometric columns, in particular coverage, 
+    use ADQL's contains or intersect functions, like this:</p>
+    <pre class="dachs-ex-tapquery literal-block" property="query">
+SELECT accref, seeing
+  FROM cars.images
+      WHERE 1=INTERSECTS(coverage, circle('', 34, -4, 2))
+      ORDER BY seeing
+    </pre>
+    <p>Of course, this concerns all SIAP and SSAP tables 
+    (<a href="/tableinfo/cars.images">&#x2197;</a
+    ><em class="dachs-ex-taptable" property="table">cars.images</em> only
+    standing as an example here) as well as 
+    <a href="/tableinfo/ivoa.obscore">&#x2197;</a
+    ><em property="table">ivoa.obscore</em>
+    </p>
+  </div>
+</body>
+</html>
+
diff --git a/ivoatex b/ivoatex
diff --git a/role_diagram.xml b/role_diagram.xml
@@ -0,0 +1,91 @@
+<!--
+Document authors: 
+
+Remove all <rec> elements in there referring to standards not related
+to the current one, then say 
+
+make archdiag.pdf
+
+For the time being, please keep both archdiag.pdf and archdiag.svg as
+created by this in the VCS.  This helps document builds on machines
+with missing dependencies.
+-->
+
+<archdiag xmlns="http://ivoa.net/archdiag">
+	<!-- Registry: x=55, y=150..450 -->
+        <!--
+	<rec name="VOResource" x="55" y="155"/>
+	<rec name="RegTAP" x="55" y="180"/>
+	<rec name="RegistryInterface" x="55" y="205"/>
+	<rec name="Resource M.D." x="55" y="230"/>
+        -->
+	<rec name="TAPRegExt" x="55" y="255"/>
+	<rec name="VODataService" x="55" y="350"/>
+        <!--
+	<rec name="StandardsRegExt" x="55" y="375"/>
+	<rec name="SimpleDALR.E." x="55" y="400"/>
+        -->
+	<rec name="Identifiers" x="125" y="425"/>
+
+	<!-- Apps: all over the place -->
+	<rec name="VOTable" x="270" y="325"/>
+        <!--
+	<rec name="SAMP" x="170" y="110"/>
+	<rec name="MOC" x="430" y="400"/>
+	<rec name="HiPS" x="430" y="425"/>
+        -->
+
+	<!-- DAL: x=655, y=155..435 -->
+	<rec name="DALI" x="310" y="290"/>
+	<rec name="ADQL" x="250" y="160"/>
+        <!--
+	<rec name="SCS" x="655" y="155"/>
+	<rec name="SIAP" x="655" y="180"/>
+	<rec name="SSAP" x="655" y="230"/>
+	<rec name="SLAP" x="655" y="255"/>
+        -->
+	<rec name="TAP" x="655" y="325"/>
+        <!--
+	<rec name="SimDAL" x="655" y="350"/>
+	<rec name="VTP" x="655" y="375"/>
+	<rec name="DataLink" x="610" y="400"/>
+	<rec name="SODA" x="655" y="425"/>
+        -->
+
+	<!-- Data Models: x=430..580, y=250..400 -->
+	<!--
+        <prerec name="VODML" x="490" y="195"/>
+	<rec name="ObsCore" x="600" y="205"/>
+	<rec name="SimDM" x="450" y="230"/>
+	<rec name="STC" x="550" y="230"/>
+	<rec name="CharDM" x="450" y="255"/>
+	<rec name="SSLDM" x="550" y="255"/>
+	<rec name="SpectralDM" x="450" y="280"/>
+	<rec name="PhotDM" x="550" y="280"/>
+	<prerec name="DatasetDM" x="450" y="305"/>
+	<prerec name="CubeDM" x="550" y="305"/>
+	<prerec name="ProvDM" x="450" y="330"/>
+        -->
+
+	<!-- GWS: all over the place -->
+        <!--
+	<rec name="PDL" x="425" y="355"/>
+        -->
+	<rec name="SSO" x="270" y="120"/>
+        <!--
+	<rec name="VOSpace" x="155" y="455"/>
+        -->
+	<rec name="CDP" x="570" y="115"/>
+	<rec name="UWS" x="605" y="460"/>
+	<rec name="VOSI" x="540" y="435"/>
+
+	<!-- Semantics: x=160..250 y=250..400 -->
+	<rec name="VOUnits" x="200" y="250"/>
+	<rec name="UCD" x="160" y="310"/>
+	<rec name="Vocabularies" x="160" y="335"/>
+
+	<!-- TD -->
+        <!--
+	<rec name="VOEvent"  x="530" y="375"/>
+        -->
+</archdiag>
diff --git a/sample-capability.xml b/sample-capability.xml
@@ -0,0 +1,49 @@
+<vosi:capabilities
+   xmlns:vosi="http://www.ivoa.net/xml/VOSICapabilities/v1.0"
+   xmlns:vs="http://www.ivoa.net/xml/VODataService/v1.1"
+   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+   xsi:schemaLocation=
+    "http://www.ivoa.net/xml/VOSICapabilities/v1.0
+     http://www.ivoa.net/xml/VOSICapabilities/v1.0
+     http://www.ivoa.net/xml/VODataService/v1.1
+     http://www.ivoa.net/xml/VODataService/v1.1">
+
+  <!-- base URL for clients that apppend /async, /sync, etc -->
+  <capability standardID="ivo://ivoa.net/std/TAP">
+    <interface xsi:type="vs:ParamHTTP" role="std" version="1.1">
+      <accessURL use="base"> https://example.net/srv </accessURL>
+      <!-- anonymous or cookie or client certificate -->
+      <securityMethod/>
+      <securityMethod standardID="ivo://ivoa.net/sso#cookie"/>
+      <securityMethod standardID="ivo://ivoa.net/sso#tls-with-certificate"/>
+    </interface>
+  </capability>
+
+  <capability standardID="ivo://ivoa.net/std/VOSI#capabilities">
+  	<!-- VOSI capabilities endpoint as per VOSI 1.1 -->
+    <interface xsi:type="vs:ParamHTTP" role="std" version="1.0">
+      <accessURL use="full"> https://example.net/srv/capabilities </accessURL>
+      <!-- anonymous only -->
+    </interface>
+  </capability>
+
+  <capability standardID="ivo://ivoa.net/std/VOSI#availability">
+  	<!-- VOSI availability endpoint as per VOSI 1.1 -->
+    <interface xsi:type="vs:ParamHTTP" role="std" version="1.0">
+      <accessURL use="full"> https://example.net/srv/availability </accessURL>
+      <!-- anonymous only -->
+    </interface>
+  </capability>
+
+  <capability standardID="ivo://ivoa.net/std/VOSI#tables-1.1">
+  	<!-- VOSI table endpoint as per VOSI 1.1 -->
+    <interface xsi:type="vs:ParamHTTP" role="std" version="1.1">
+      <accessURL use="base"> https://example.net/srv/tables </accessURL>
+      <!-- anonymous or cookie or client certificate -->
+      <securityMethod/>
+      <securityMethod standardID="ivo://ivoa.net/sso#cookie"/>
+      <securityMethod standardID="ivo://ivoa.net/sso#tls-with-certificate"/>
+    </interface>
+  </capability>
+
+</vosi:capabilities>