Skip to content

miscellaneous small tweaks to the WD 1.1 #85

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.

Sign up for GitHub

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

Draft
pahjbo wants to merge 5 commits into
base: 20-update-vo-dml-standard-document
Choose a base branch
from
Draft

miscellaneous small tweaks to the WD 1.1 #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
55a90ed
remove path reference from figure
pahjbo Oct 23, 2025
53802ac
copy over changes from head
pahjbo Oct 24, 2025
c5d7acc
point at ivoatex markdown version
pahjbo Jun 13, 2026
eb94edf
appendix numbering
pahjbo Jun 15, 2026
26f58ea
added one "proper" citation
pahjbo Jun 15, 2026
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
3 changes: 2 additions & 1 deletion .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[submodule "doc/std/ivoatex"]
path = doc/std/ivoatex
url = https://github.com/ivoa-std/ivoatex
url = git@github.com:pahjbo/ivoatex.git
branch = markdown
14 changes: 9 additions & 5 deletions doc/std/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ DOCNAME = VO-DML
DOCVERSION = 1.1

# Publication date, ISO format; update manually for "releases"
DOCDATE = 2018-09-05
DOCDATE = 2025-12-31

# What is it you're writing: NOTE, WD, PR, REC, PEN, or EN
DOCTYPE = WD
Expand All @@ -31,8 +31,12 @@ VECTORFIGURES =
# Additional files to distribute (e.g., CSS, schema files, examples...)
AUX_FILES =

$(DOCNAME).html: $(DOCNAME).md template.html
pandoc VO-DML.md -s --css=https://www.ivoa.net/misc/ivoa_wd.css --template=template.html --toc -N -o VO-DML.html
$(DOCNAME).html: $(DOCNAME).md ivoatex/pandoc/template.html
pandoc VO-DML.md -s --css=https://www.ivoa.net/misc/ivoa_wd.css --css=ivoatex/pandoc/page.css --template=ivoatex/pandoc/template.html \
--citeproc --bibliography=ivoatex/docrepo.bib --bibliography=ivoatex/ivoabib.bib --metadata link-citations=true \
--lua-filter=ivoatex/pandoc/number-sections.lua --toc -o VO-DML.html

$(DOCNAME).pdf: $(DOCNAME).md template.html
pandoc VO-DML.md -s --css=https://www.ivoa.net/misc/ivoa_wd.css --template=template.html --to html --toc -N -o VO-DML.pdf
$(DOCNAME).pdf: $(DOCNAME).md ivoatex/pandoc/template.html
pandoc VO-DML.md -s --css=https://www.ivoa.net/misc/ivoa_wd.css --css=ivoatex/pandoc/page.css --template=ivoatex/pandoc/template.html \
--citeproc --bibliography=ivoatex/docrepo.bib --bibliography=ivoatex/ivoabib.bib --metadata link-citations=true \
--lua-filter=ivoatex/pandoc/number-sections.lua --to html --pdf-engine weasyprint --pdf-engine-opt="-u ." --toc -o VO-DML.pdf
13 changes: 10 additions & 3 deletions doc/std/VO-DML.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ standardized terms is through *annotations*. Data sets are represented
in some standardized format that includes hooks for associating terms
from a standardized source of semantic information. In the IVOA the main
representations that allow this are the metadata annotation elements in
VOTable \[4\] and the TAP_SCHEMA[^6] in the TAP specification \[5\].
VOTable \[4\] and the TAP_SCHEMA[^6] in the TAP specification [@{2019ivoa.spec.0927D}].
Each of these contains hooks for linking certain data components to the
UCD semantic vocabulary (see \[6\] and \[7\]). Associating a term from
that controlled list to say a FIELD (VOTable) or column (TAP) indicates
Expand Down Expand Up @@ -2660,7 +2660,7 @@ Note, the vodml-id of all types exactly follow the generation rules in
Appendix C. E.g. to refer to the \'string\' type one should always use
the vodml-ref \'ivoa:string\'

![C:\\Users\\Gerar\\AppData\\Local\\Microsoft\\Windows\\INetCache\\Content.Word\\IVOA_UML.PNG](media/image23.png){width="6.0in"
![](media/image23.png){width="6.0in"
height="3.0695647419072616in"}

Figure VO-UML diagram with the types from the basic \'ivoa\' data model.
Expand Down Expand Up @@ -2916,7 +2916,11 @@ Sometimes, in application contexts: derive one or more physical
representations. Use as much as possible standard, if possible automated
derivation methods of VO-DML to target representation.

# References

::: {#refs}
:::

# References (manual)

1. Abiteboul etal 2011 *Web Data Management*\
Online version at <http://webdam.inria.fr/Jorge/files/wdm.pdf> )
Expand Down Expand Up @@ -3008,6 +3012,9 @@ derivation methods of VO-DML to target representation.
Standards Version 1.0\
*<http://www.ivoa.net/documents/StandardsRegExt/>


# Appendices

# Relation to UML {#relation-to-uml .Appendix-A}

The following table summarizes the relation between VO-DML and UML. It
Expand Down
2 changes: 1 addition & 1 deletion doc/std/ivoatex
Open in desktop
Submodule ivoatex updated 17 files
+3 −1 Makefile
+4 −3 archdiag-full.xml
+22 −0 docrepo.bib
+2 −2 fetch_from_ads.py
+1 −1 github_workflow_build.yml.template
+3 −2 github_workflow_preview.yml.template
+11 −0 ivoa.cls
+24 −0 pandoc/README.rst
+62 −0 pandoc/include-code-files.lua
+121 −0 pandoc/latex.template
+137 −0 pandoc/number-sections.lua
+14 −0 pandoc/page.css
+99 −0 pandoc/template.html
+2 −2 regressiontest/run-regression.py
+12 −3 schemadoc.xslt
+3 −0 tthdefs.tex
+1 −1 update_generated.py
99 changes: 0 additions & 99 deletions doc/std/template.html
View file
Open in desktop

This file was deleted.

39 changes: 19 additions & 20 deletions xsd/vo-dml-v1.0.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,7 @@
targetNamespace="http://www.ivoa.net/xml/VODML/v1"
attributeFormDefault="unqualified" elementFormDefault="unqualified"
version="1.1-WD">
<!--
2017-09-23:
- added version attribute in schema
- removed minor version from targetNamespace and default xmlns declaration
-->

<xsd:annotation>
<xsd:documentation>

Expand Down Expand Up @@ -311,7 +307,9 @@ TBD continue based on VO-DML specification document.
</xsd:sequence>
<xsd:attribute name="vodmlVersion" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>the actual version of vodml that this model uses</xsd:documentation>
<xsd:documentation>the version of VO-DML metamodel that the model uses - this is distinct from the version of the model itself
which is denoted by the version element child of the model
</xsd:documentation>
</xsd:annotation></xsd:attribute>
</xsd:complexType>
<xsd:complexType name="ModelImport">
Expand All @@ -324,11 +322,9 @@ TBD continue based on VO-DML specification document.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="name" type="ModelName" minOccurs="0" maxOccurs="1">
<xsd:element name="name" type="ModelName" minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
DEPRECATED - this just repeats information in the referenced model document

Name by which imported model is used in the current model and its documentation.
This name MUST be the same as the 'name' of the model definition in that remote document.
For all utypes pointing to elements in the imported model MUST use this name as prefix.
Expand All @@ -346,7 +342,7 @@ TBD continue based on VO-DML specification document.
<xsd:element name="version" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Version of the imported model.
Version of the imported model - Note that this is important to specify for minor versions to ensure compatibility.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
Expand Down Expand Up @@ -498,29 +494,29 @@ TBD continue based on VO-DML specification document.
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="Type">
<xsd:sequence>
<xsd:element name="attribute" type="Attribute" minOccurs="0" maxOccurs="unbounded">
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element name="attribute" type="Attribute" minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
TODO
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="composition" type="Composition" minOccurs="0" maxOccurs="unbounded">
<xsd:element name="composition" type="Composition" minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
TODO
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="reference" type="Reference" minOccurs="0" maxOccurs="unbounded">
<xsd:element name="reference" type="Reference" minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
TODO
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:choice>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
Expand Down Expand Up @@ -556,22 +552,22 @@ TBD continue based on VO-DML specification document.
<xsd:complexType name="DataType">
<xsd:complexContent>
<xsd:extension base="ValueType">
<xsd:sequence>
<xsd:element name="attribute" type="Attribute" minOccurs="0" maxOccurs="unbounded">
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element name="attribute" type="Attribute" minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
TODO
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="reference" type="Reference" minOccurs="0" maxOccurs="unbounded">
<xsd:element name="reference" type="Reference" minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
TODO
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:choice>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
Expand Down Expand Up @@ -681,6 +677,7 @@ TBD continue based on VO-DML specification document.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="UCD" type="xsd:string" minOccurs="0" maxOccurs="1"></xsd:element>
<xsd:element name="constraint" type="Constraint" minOccurs="0" maxOccurs="1"></xsd:element><!-- TODO - allow more than one constraint? -->
</xsd:sequence>
</xsd:extension>
Expand Down Expand Up @@ -913,12 +910,14 @@ TBD continue based on VO-DML specification document.
This constraint is used to indicate that an attribute is a natural key for its owning ObjectType, meaning that the
attribute value should be globally unique. This may be applied multiple times to indicate that only a composition
of several attributes make the globally unique key.

If the value is 0 then the primary key is made out of the natural keys of the containing types.
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="Constraint">
<xsd:sequence>
<xsd:element name="position" type="xsd:positiveInteger">
<xsd:element name="position" type="xsd:nonNegativeInteger">
<xsd:annotation>
<xsd:documentation>In the case where multiple attribute values make up the natural key, this
value indicates the ordinal number of this particular key in the compound key.</xsd:documentation>
Expand Down