ivoa-std / ivoatex Goto Github PK

I've been going through the process of setting up the TransformDM repo in GitHub.
I could see these workflow files in the other repository, but couldn't figure out where they came from.
It would help if the template files had some comment text at the top to indicate where they came from and maybe a pointer to the instructions for installing them in your repository.

eg:
"# This file generated from a template file maintained in the ivoatex repository."
"# See <link> for instructions on how to create and install it into a project repository."

In DataLink, The Makefile has
SOURCES = $(DOCNAME).tex role_diagram.pdf
If I remove role_diagram.pdf and role_diagram.svg they can be regenerated with
make role_diagram.pdf
but a regular build like:
make biblio forcetex
does not generate them (from role_diagram.xml) automatically. Should it? Or should I really do
make role_diagram.pdf biblio forcetex

The HTML output of UCDList has an unexpected output at line 249 of current HTML version:

<ol type="a">[label*=*.]

The string [label*=*.] shows up in the HTML output.

I've SVN-committed an updated version of submission.py, which works with python3 (it is currently broken). Can you update it from there or shall I do a PR?

As is, any poor soul will see that include ivoatex/Makefile fails to load.... Could the template contain the solution, e.g. a comment line

     #   git clone --recurse-submodules https://github.com/ivoa-std/ivoatex

But this requires somebody to read the Makefile. And who does?

Even better, you could change the tail end of the template to:

  -include ivoatex/Makefile
  ivoatex/Makefile:
          git clone --recurse-submodules https://github.com/ivoa-std/ivoatex

this way the "make" command would make the pdf, downloading the rrequired.

When processing a document including a bibliography, with TeXLive 2022, BibTeX fails:

[...]
[40] [41] (./VOUnits.bbl
Runaway argument?
\parindent \z@ \bibpreamble \bibfont \list {\@biblabel {\the \c@NAT@ctr \ETC.
! Paragraph ended before \HD@@guesstoclevel was complete.
<to be read again> 
\par 
l.1 \begin{thebibliography}
                         {xx}
? ^D
! Emergency stop.

However a slightly earlier TeXLive release works OK, using

pdflatex --version 
pdfTeX 3.141592653-2.6-1.40.23 (TeX Live 2022/dev)
kpathsea version 6.3.4/dev

(despite the banner, this is from TeXLive 2021).

To reproduce (I believe), this is when running make in ivoa-std/VOUnits with VOUnits repository revision 1250c9ff74d0b7484cfbb. Running that starts

github/VOUnits> make
/bin/echo -n '\vcsrevision{' > gitmeta.tex
/bin/echo -n "b10aee5" >> gitmeta.tex
if [ ! -z "" ]; then /bin/echo -n -dirty >> gitmeta.tex; fi
/bin/echo } >> gitmeta.tex
/bin/echo '\vcsdate{' 2023-01-20 11:48:40 +0000 '}' >>gitmeta.tex
latexmk -pdf VOUnits
Rc files read:
  NONE
Latexmk: This is Latexmk, John Collins, 17 Mar. 2022. Version 4.77, version: 4.77.
Latexmk: applying rule 'pdflatex'...
Rule 'pdflatex': File changes, etc:
   Changed files, or newly in use since previous run(s):
  gitmeta.tex
Rule 'pdflatex': The following rules & subrules became out-of-date:
  pdflatex
------------
Run number 1 of rule 'pdflatex'
------------
------------
Running 'pdflatex  -recorder  "VOUnits.tex"'
------------
This is pdfTeX, Version 3.141592653-2.6-1.40.24 (TeX Live 2022) (preloaded format=pdflatex)
 restricted \write18 enabled.
entering extended mode
(./VOUnits.tex
LaTeX2e <2022-06-01> patch level 4
L3 programming layer <2022-07-01> (ivoatex/ivoa.cls
Document Class: ivoa 
[... and eventually the error as above]

I'm running this on macOS, but I'd be surprised if it's sensitive to the platform.

When LaTeX escapes (such as \'{e} for an acute-accented é) are used in author or editor values, the characters are not rendered correctly in the resulting html.

Accented characters in the abstract or generic sections seem to be rendered correctly in the html. Rendering in output pdf appears correct regardless of where the characters are in the document. UTF-8 characters in the source code appear to render correctly in all versions, but I don't know if that is dependent on local versions of LaTeX.

One can observe these behaviors in the html and pdf files generated from this basic example:

\documentclass[11pt,a4paper]{ivoa}
\input tthdefs

\title{Dessert Choice}
\ivoagroup{Applications}

\author{Crème Brûlée}
\author{Cr\`{e}me Br\^{u}l\'{e}e}

\editor{Schwarzwälder Kirschtorte}
\editor{Schwarzw\"{a}lder Kirschtorte}

\begin{document}
\begin{abstract}
La crème brûlée ou Schwarzwälder Kirschtorte?

La cr\`{e}me br\^{u}l\'{e}e ou Schwarzw\"{a}lder Kirschtorte?
\end{abstract}

\section{Introduction}
Préférez-vous la crème brûlée ou Schwarzwälder Kirschtorte?

Pr\'{e}f\'{e}rez-vous la cr\`{e}me br\^{u}l\'{e}e ou Schwarzw\"{a}lder Kirschtorte?
\end{document}

The std:RegTAP entry in ivoabib.bib is referring to an old WD version, not to the current REC 1.1.

Since its version 2.0, tth tries to interpret the ancient German TeX
sequences with the double quote as an active character ("`, "', "a, "s,
etc). In our context, that is nothing but trouble. We should probably
patch that out or perhaps get an upstream option to switch it off.

[all the while: Don't have ASCII double quotes in running text. Use ``
'' instead. It's of course ok to have them in \verb and listing
environments]

The part of the ivoatex script which produces the html version of the document is not setting up the correct up-left-side banner for an IVOA Endorsed Note, it actually selects the IVOA Note banner.

You can check this in the fresh EN-UCDList-v1.4: https://ivoa.net/documents/UCD1+/20210616/EN-UCDlist-1.4-20210616.html
(whereas the main EN page for the document has the correct banner: https://ivoa.net/documents/UCD1+/20210616/index.html)

This issue doesn't seem to be new, since it is also there for the other Endorsed Notes

• https://ivoa.net/documents/Notes/XMLVers/20180529/
• https://ivoa.net/documents/udf-catalogue/20210310/EN-udf-catalogue-1.0-20210310.html
• https://ivoa.net/documents/uat-as-upstream/20201117/PEN-uat-as-upstream-1.0-20201117.html

At the IVOA session today we discussed the problem of the standards documents not building sufficient times to sort out references. I think that latexmk is part of texlive so should be available to everyone that uses latex these days (unless they have a minimal subset). MacTex for example comes with it and it looks like ubuntu includes it with texlive-bibtex-extra.

When the reference below was added to localrefs.bib, it resulted in this error in building the document:

[31] (./VOTable.bbl [32]
! Undefined control sequence.
l.90 ...d relative dimension in space}', {\em \aap
                                                  } {\bf 574},~A36,
? )

New reference:

@ARTICLE{2015A&A...574A..36R,
       author = {{Rots}, Arnold H. and {Bunclark}, Peter S. and {Calabretta}, Mark R. and {Allen}, Steven L. and {Manchester}, Richard N. and {Thompson}, William T.},
        title = "{Representations of time coordinates in FITS. Time and relative dimension in space}",
      journal = {\aap},
     keywords = {time, standards, methods: data analysis, techniques: miscellaneous, astronomical databases: miscellaneous, reference systems, Astrophysics - Instrumentation and Methods for Astrophysics},
         year = 2015,
        month = feb,
       volume = {574},
          eid = {A36},
        pages = {A36},
          doi = {10.1051/0004-6361/201424653},
archivePrefix = {arXiv},
       eprint = {1409.7583},
 primaryClass = {astro-ph.IM},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2015A&A...574A..36R},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

Thanks to @msdemlei for identifying the issue as ivoatex not yet knowing about some journal macros used by ADS (including \aap), and for the workaround for VOTable which is to insert the following line right after right after
\usepackage{verbatim} in VOTable.tex:

\newcommand{\aap}{Astronomy and Astrophysics}

On that discussion I found the following code which could used to automatically include the LICENSE file in our repositories.

curl https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt > LICENSE &&
  git add LICENSE && git commit --amend --no-edit && git push -f

The UCD1+ version 1.10 recommendation is the document defining the UCD1+ standard. All further version documents are referred to as UCD List documents (starting from version 1.11)

In the docrepo.bib file, there is no reference available to cite the UCD1+ version 1.10 recommendation document, which is cited by all subsequent UCD List document versions.

The pipe character is transformed into <tt> - </tt> instead of <tt> | </tt> when preparing the html version of a document.

Looking at the Tth rendering of DALI.html I see for instance the following:

• LaTeX source: ... VOTable (\xmlel{FIELD}) ...
• Generated HTML: ... VOTable ( <span class="xmlel">FIELD</span>)
• Rendered HTML: ... VOTable ( FIELD) ...

i.e. unwanted whitespace is introduced before the output of the \xmlel macro if it is not itself preceded by whitespace. A quick look at tthdefs.tex suggests that the \specialterm command is at fault, but I don't know how hard it would be to fix that.

The \ivoaBaseURL command works well in the general case, when the IVOA document repository URL uses the same name as the $DOCNAME. For some reason (historical, I guess), this is not the case for the latest UCD documents, which is not available at:

• https://www.ivoa.net/documents/UCDlist/20210616/EN-UCDlist-1.4-20210616.html
  but at:
• https://www.ivoa.net/documents/UCD1+/20210616/EN-UCDlist-1.4-20210616.html

As a consequence, the previous version links, and the \auxiliaryurl commands are not setting up the correct URLs.

I have setup a dirty fix in the latest UCDlist document:

\renewcommand{\ivoaBaseURL}{https://www.ivoa.net/documents/UCD1+}
\renewcommand\currentDocURL % 
	{\ivoaBaseURL/\ivoaDocdatecode}
\renewcommand\currentDocRef % formatted reference to this document's landing page
	{\href{\currentDocURL}{\currentDocURL}}
\renewcommand\latestDocRef 
	% formatted reference to a potential successor to the document's landing page
	{\href{\ivoaBaseURL}{\ivoaBaseURL}}
\renewcommand{\auxiliaryurl}[1]{\href{\currentDocURL/#1}{\currentDocURL/#1}}

Any idea to try and do this in a cleaner way ?