Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

switch Makefile to WD-TAP-1.2 and add TAP-1.1 rec URL to doc #7

Merged
merged 7 commits into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
name: CI build of the standard

env:
doc_name: TAP

on:
pull_request:
types: [opened, synchronize, reopened]
Expand All @@ -10,23 +13,25 @@ jobs:
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
sudo apt install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended xsltproc latexmk cm-super

- name: Build the document
run: make role_diagram.pdf biblio forcetex
run: make

- name: Check the output
run: |
test -f TAP.pdf
test -f TAP.bbl
test -f ${{ env.doc_name }}.pdf
test -f ${{ env.doc_name }}.bbl

- uses: actions/upload-artifact@v1
- name: Keep the PDF artefact
uses: actions/upload-artifact@v4
with:
name: TAP.pdf Preview
path: TAP.pdf
path: ${{ env.doc_name }}.pdf
20 changes: 16 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
DOCNAME = TAP

# count up; you probably do not want to bother with versions <1.0
DOCVERSION = 1.1
DOCVERSION = 1.2

# Publication date, ISO format; update manually for "releases"
DOCDATE = 2019-09-27
DOCDATE = 2024-11-11

# What is it you're writing: NOTE, WD, PR, or REC
DOCTYPE = REC
DOCTYPE = WD

# Source files for the TeX document (but the main file must always
# be called $(DOCNAME).tex
Expand All @@ -22,4 +22,16 @@ FIGURES = role_diagram.pdf
# List of PDF figures (for vector graphics)
VECTORFIGURES =

include ivoatex/Makefile
# An e-mail address of the person doing the submission to the document
# repository (can be empty until a make upload is being made)
[email protected]

-include ivoatex/Makefile

ivoatex/Makefile:
@echo "*** ivoatex submodule not found. Initialising submodules."
@echo
git submodule update --init

test:
@echo "No tests defined yet"
23 changes: 12 additions & 11 deletions TAP.tex
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

\editor{Patrick Dowler}

\previousversion[https://www.ivoa.net/documents/TAP/20190927/]{TAP-1.1}
\previousversion[http://www.ivoa.net/Documents/TAP/20190826/]{PR-TAP-1.1-20190826}
\previousversion[http://www.ivoa.net/Documents/TAP/20190626/]{PR-TAP-1.1-20190626}
\previousversion[http://www.ivoa.net/Documents/TAP/20190420/]{PR-TAP-1.1-20190420}
Expand Down Expand Up @@ -93,7 +94,7 @@ \section{Introduction}
return the query response as another table, in accord with the relational model.
Queries may be submitted using various query languages and may execute
synchronously or asynchronously. Support for the Astronomical Data Query
Language ADQL \citep{2008ivoa.spec.1030O} is mandatory; support for other query languages is
Language ADQL \citep{2023ivoa.spec.1215M} is mandatory; support for other query languages is
supported
but optional.

Expand Down Expand Up @@ -132,7 +133,7 @@ \subsection{Role within the VO Architecture}
\end{figure}

Fig.~\ref{fig:archdiag} shows the role this document plays within the
IVOA architecture \citep{note:VOARCH}.
IVOA architecture \citep{2021ivoa.spec.1101D}.

TAP depends on the following other IVOA standards:

Expand All @@ -145,7 +146,7 @@ \subsection{Role within the VO Architecture}
UWS 1.1 can significantly streamline the communication, and
implementors of TAP 1.1 are encouraged to support UWS 1.1 or later.

\item[ADQL \citep{2008ivoa.spec.1030O}] A standards-compliant TAP
\item[ADQL \citep{2023ivoa.spec.1215M}] A standards-compliant TAP
service must support queries written in the Astronomical Data Query
Language.

Expand All @@ -156,7 +157,7 @@ \subsection{Role within the VO Architecture}
the VOSI-tables resource in VOSI 1.1 provides important usability features, and
implementors of TAP 1.1 are encouraged to support VOSI 1.1 or later.

\item[VOTable \citep{2013ivoa.spec.0920O}] All TAP services must be able
\item[VOTable \citep{2019ivoa.spec.1021O}] All TAP services must be able
to serve query results in the VOTable format. Note that while TAP 1.1 does not
require the use of any particular minor version of the VOTable standard, older
versions are missing features that are required and may be unusable in practice.
Expand All @@ -182,7 +183,7 @@ \subsection{Role within the VO Architecture}
facilitates the publication of metadata of observational data products.
TAP is used to access compliant metadata collections.

\item[RegTAP \citep{2014ivoa.spec.1208D}] The relational model for the
\item[RegTAP \citep{2019ivoa.spec.1011D}] The relational model for the
VO Registry provides a data model for publishing service metadata.
TAP is used to access compliant metadata collections.

Expand Down Expand Up @@ -236,7 +237,7 @@ \subsubsection{Query Standard Data Models}
\subsection{Query Languages}

\subsubsection{ADQL Queries}
The Astronomical Data Query Language ADQL \citep{2008ivoa.spec.1030O} is the standard
The Astronomical Data Query Language ADQL \citep{2023ivoa.spec.1215M} is the standard
query language for the IVOA. Support for ADQL queries is mandatory. ADQL can be
used to specify queries that access one or more tables provided by the TAP
service, including the standard metadata tables. In general, the client must
Expand Down Expand Up @@ -655,10 +656,10 @@ \subsubsection{UPLOAD}

The UPLOAD parameter is described in DALI. Services should support
the
upload of temporary tables in VOTable \citep{2013ivoa.spec.0920O} format via the standard
upload of temporary tables in VOTable \citep{2019ivoa.spec.1021O} format via the standard
UPLOAD
parameter. The table-name(s) must be legal table names as defined in
ADQL \citep{2008ivoa.spec.1030O} but restricted as described in section~\ref{sec:tap-schema-tables}.
ADQL \citep{2023ivoa.spec.1215M} but restricted as described in section~\ref{sec:tap-schema-tables}.
URIs may be simple URLs (e.g. with a URI scheme of http or https) or
URIs that must be resolved (e.g. with a URI scheme of vos or param) to give
the location of the table content.
Expand Down Expand Up @@ -718,7 +719,7 @@ \subsubsection{UPLOAD}
\section{Use of VOTable}
\label{sec:votable}

VOTable \citep{2013ivoa.spec.0920O} is the standard format for output (query
VOTable \citep{2019ivoa.spec.1021O} is the standard format for output (query
results) and input (table upload) in a TAP service so most of this section
deals with how VOTable is used. However, rules about serialising column values
also apply to other formats (e.g. CSV and TSV).
Expand Down Expand Up @@ -862,7 +863,7 @@ \section{Metadata: TAP\kern-3pt\_SCHEMA}
VOSI tables resource provides the same metadata as the \tapschema{}
but in a rigorously controlled format; the information in the
\tapschema{} is equivalent to that defined by VODataService
\citep{2010ivoa.spec.1202P}. Second, the client may specify a query of one or more
\citep{2021ivoa.spec.1102D}. Second, the client may specify a query of one or more
tables setting the
MAXREC parameter to 0 so that only the metadata regarding the requested fields
is returned. Use of MAXREC is described in section~\ref{sec:MAXREC}.
Expand Down Expand Up @@ -982,7 +983,7 @@ \subsection{Columns}
The type of a database column is described in the \tapschema.columns
table using three columns with an additional (deprecated) column from TAP-1.0
for backwards compatibility. The allowed values for datatype and the syntax for arraysize
are specified in VOTable \citep{2013ivoa.spec.0920O}. Values for xtype are not restricted per se but
are specified in VOTable \citep{2019ivoa.spec.1021O}. Values for xtype are not restricted per se but
implementors should use standard values such as those defined in DALI before
inventing new xtype(s).

Expand Down
Binary file added role_diagram.pdf
Binary file not shown.
Loading