Subcaption issues

[clason]

I noticed two small issues with parsing subcaption labels in document symbols (and completion) only:

1. If I have subfigures, the containing figure incorrectly gets the label from the first subfigure (i.e., Figure 1a instead of Figure 1). The problem is that the figure label is not the first label in the containing environment (since captions are usually below figures); if the caption is moved to the top of the environment, it is picked up correctly. Note that this is an issue in parsing the aux file; the caption is still correctly linked to the figure environment, e.g., in the LocationLink of GotoDefinition.

2. subtables do not seem to be supported (the environment isn't autocompleted, and they don't appear in the symbol list). EDIT: This is an easy fix, see Subcaption fix #89

Brief example, in case it's useful:

\documentclass{article}
\usepackage{subcaption}

\begin{document}

\begin{figure}
    \begin{subfigure}{0.4\textwidth}
        \caption{A subfigure}
        \label{fig1a}
    \end{subfigure}
    \begin{subfigure}{0.4\textwidth}
        \caption{Another subfigure}
        \label{fig1b}
    \end{subfigure}
    \caption{A figure}
    \label{fig1}
\end{figure}

\begin{table}
    \begin{subtable}{0.4\textwidth}
        \caption{A subtable}
        \label{tab1a}
    \end{subtable}
    \begin{subtable}{0.4\textwidth}
        \caption{Another subtable}
        \label{tab1b}
    \end{subtable}
    \caption{A table}
    \label{tab1}
\end{table}

\end{document}

Aux file:

\relax
\providecommand\hyper@newdestlabel[2]{}
\providecommand\HyperFirstAtBeginDocument{\AtBeginDocument}
\HyperFirstAtBeginDocument{\ifx\hyper@anchor\@undefined
\global\let\oldcontentsline\contentsline
\gdef\contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}}
\global\let\oldnewlabel\newlabel
\gdef\newlabel#1#2{\newlabelxx{#1}#2}
\gdef\newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}}
\AtEndDocument{\ifx\hyper@anchor\@undefined
\let\contentsline\oldcontentsline
\let\newlabel\oldnewlabel
\fi}
\fi}
\global\let\hyper@last\relax
\gdef\HyperFirstAtBeginDocument#1{#1}
\providecommand\HyField@AuxAddToFields[1]{}
\providecommand\HyField@AuxAddToCoFields[2]{}
\providecommand*\caption@xref[2]{\@setref\relax\@undefined{#1}}
\newlabel{fig1a}{{1a}{1}{A subfigure\relax }{figure.caption.1}{}}
\newlabel{sub@fig1a}{{a}{1}{A subfigure\relax }{figure.caption.1}{}}
\newlabel{fig1b}{{1b}{1}{Another subfigure\relax }{figure.caption.1}{}}
\newlabel{sub@fig1b}{{b}{1}{Another subfigure\relax }{figure.caption.1}{}}
\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces A figure\relax }}{1}{figure.caption.    1}\protected@file@percent }
\newlabel{fig1}{{1}{1}{A figure\relax }{figure.caption.1}{}}
\newlabel{tab1a}{{1a}{1}{A subtable\relax }{table.caption.2}{}}
\newlabel{sub@tab1a}{{a}{1}{A subtable\relax }{table.caption.2}{}}
\newlabel{tab1b}{{1b}{1}{Another subtable\relax }{table.caption.2}{}}
\newlabel{sub@tab1b}{{b}{1}{Another subtable\relax }{table.caption.2}{}}
\@writefile{lot}{\contentsline {table}{\numberline {1}{\ignorespaces A table\relax }}{1}{table.caption.       2}\protected@file@percent }
\newlabel{tab1}{{1}{1}{A table\relax }{table.caption.2}{}}

[pfoerster]

If I have subfigures, the containing figure incorrectly gets the label from the first subfigure (i.e., Figure 1a instead of Figure 1). The problem is that the figure label is not the first label in the containing environment (since captions are usually below figures); if the caption is moved to the top of the environment, it is picked up correctly. Note that this is an issue in parsing the aux file; the caption is still correctly linked to the figure environment, e.g., in the LocationLink of GotoDefinition.

@clason Can you try the latest commit on the master branch? 484332b and 72acbc9 should fix the issue.

the environment isn't autocompleted

@efoerster needs to have a look at this one.

[clason]

@clason Can you try the latest commit on the master branch? 484332b and 72acbc9 should fix the issue.

I already have, and they do! 👍

@efoerster needs to have a look at this one.

Probably just missing an entry in data.json.

[pfoerster]

Probably just missing an entry in data.json.

Yes, there is definitely missing an entry in data.json, which is automatically generated by a script.

[clason]

Ah, that's where they went. I remember looking at them in the texlab repo a while ago.

The subfigure/subfloat environments are a bit weird in how they are defined by subcaption; I'm surprised a script could extract them from the style files at all... (But I don't see how subfigure made it and subtable didn't -- maybe the script is picking the first up from some other package?)

[efoerster]

The subfigure/subfloat environments are a bit weird in how they are defined by subcaption; I'm surprised a script could extract them from the style files at all... (But I don't see how subfigure made it and subtable didn't -- maybe the script is picking the first up from some other package?)

The script is not picking it up because subtable does not appear in the source code files of the subcaption package. We scan the source code and check the command candidates with the TeX engine afterwards. However, I just added it manually for now. It should now work with d8264a2.

[clason]

The script is not picking it up because subtable does not appear in the source code files of the subcaption package.

Yeah, it's a bit weird. It also doesn't define subfigure, but that one does appear in another style file in the same directory (which is an old, deprecated, version of caption that is still distributed for compatibility).

However, I just added it manually for now. It should now work with d8264a2.

So it does, thank you!