Consider how to automatically number table footnotes

[yarakos95]

Currently, note and \TblrNote provided by tabularray require manual tagging. However, specifying tags manually is tedious, and it would be much easier if the tags were numbered automatically.

Requirement

• Automatic closs-referencing of table footnote tags
• Do not interfere with table footnote tags in different tables
• Duplicate table footnote tag
• Automatic sorting of notes

Is there anything else we should implement?

Example of table code

\begin{talltblr}[
    caption = {First table},
    note{a} = {The first table footnote},
    note{b} = {The second table footnote},
    note{X} = {Refer to table footnotes in other tables},
    note{dup} = {Duplicate table footnote},
  ]{
    colspec = {XXX}, width = 0.5\linewidth, hlines,
  }
  Alpha   & Beta  & Gamma                \\
  Epsilon & Zeta  & Eta \TblrNote{a}     \\
  Iota    & Kappa & Lambda \TblrNote{b}  \\
  Mu      & Nu    & Omega                \\
  Omicron & Phi   & Pi \TblrNote{dup}    \\
  Psi     & Rho   & Sigma \TblrNote{dup} \\
  Tau     & Theta & Upsilon              \\
  Xi      & Zeta  & \TblrNote{dup}       \\
\end{talltblr}

Help

Please give me any ideas or specific implementation examples regarding automatic numbering of table footnotes like this.

[yarakos95]

I was able to create an implementation example that solved the above two requests.

• Automatic closs-referencing of table footnote tags
  • Use \label and \ref
• Do not interfere with table footnote tags in different tables
  • Unique label name for each table using \g__tblr_table_count_int
• Duplicate table footnote tag
• Sort note

Implementation

\newcounter{countTblrNote}
\newcommand{\countStyle}[1]{\arabic{#1}}
\renewcommand{\thecountTblrNote}{\countStyle{countTblrNote}}

\ExplSyntaxOn
\NewDocumentCommand \newTblrNote { m }
{
  \cs_if_exist:NT \hypersetup { \ExpTblrTemplate { note-border }{ normal } }
  {
    \refstepcounter{countTblrNote}
    \label{tblrnote\int_to_arabic:n {\g__tblr_table_count_int}:#1}
    \TblrOverlap
    {
      \__tblr_hyper_link:nn {#1}
      {
        \textsuperscript {
          \UseTblrFont { note-tag }
          \textasteriskcentered
          \countStyle{countTblrNote}
        }
      }
    }
  }
}
\DefTblrTemplate{note-tag}{clossReference}
{
  \textsuperscript{
    \UseTblrFont{note-tag}
    \textasteriskcentered
    \ref{tblrnote\int_to_arabic:n {\g__tblr_table_count_int}:\InsertTblrNoteTag}
  }
}
\ExplSyntaxOff

\SetTblrTemplate{note-tag}{clossReference}
\DefTblrTemplate{lastfoot}{clossReference}{
  \UseTblrTemplate{note}{default}
  \UseTblrTemplate{remark}{default}
  \setcounter{countTblrNote}{0}
}
\SetTblrTemplate{lastfoot}{clossReference}
\SetTblrStyle{note-tag}{ font = \sffamily }
\SetTblrStyle{note}{ hang = 2em, font = \footnotesize }

By using this, table footnotes can be automatically numbered for the following tables.

\begin{talltblr}[
    caption = {First table},
    note{X} = {It is the first footnote in the first table},
    note{a} = {It is the second footnote in the first table},
  ]{
    colspec = {XXX}, width = 0.5\linewidth, hlines,
  }
  Alpha   & Beta  & Gamma                     \\
  Epsilon & Zeta  & Eta\newTblrNote{X}        \\
  Iota    & Kappa & Lambda\newTblrNote{a}     \\
\end{talltblr}

\vspace{0.5em}
\rule{0.8\linewidth}{0.5pt}
\vspace{0.5em}

\begin{talltblr}[
    caption = {When referring to tags in the first table},
    note{a} = {Same label name as the first table footnote, but refers to the table footnote for the second table},
    note{X} = {The first table footnote cannot be closs-referenced},
  ]{
    colspec = {XXX}, width = 0.5\linewidth, hlines,
  }
  Alpha   & Beta  & Gamma              \\
  Epsilon & Zeta  & Eta\newTblrNote{a} \\
  Iota    & Kappa & Lambda             \\
\end{talltblr}

Duplicate table footnote tags

This implementation can not handle duplicate table footnotes such as the following:

\begin{talltblr}[
    caption = {When tags are duplicated},
    note{Dup} = {Duplicate table footnotes do not have the same footnote number},
  ]{
    colspec = {XXX}, width = 0.5\linewidth, hlines,
  }
  Alpha   & Beta  & Gamma                   \\
  Epsilon & Zeta  & Eta\newTblrNote{Dup}    \\
  Iota    & Kappa & Lambda\newTblrNote{Dup} \\
\end{talltblr}

To avoid this, I considered rewriting \newTblrNote as follows.

\newcounter{countTblrNote}
\newcommand{\countStyle}[1]{\arabic{#1}}
\renewcommand{\thecountTblrNote}{\countStyle{countTblrNote}}

\ExplSyntaxOn
\NewDocumentCommand \newTblrNote { s m }
{
  \cs_if_exist:NT \hypersetup { \ExpTblrTemplate { note-border }{ normal } }
  \IfBooleanTF { #1 }
  {
    \TblrOverlap
    {
      \__tblr_hyper_link:nn {#2}
      {
        \textsuperscript {
          \UseTblrFont { note-tag } \textasteriskcentered
          \ref{tblrnote\int_to_arabic:n {\g__tblr_table_count_int}:#2}
        }
      }
    }
  }
  {
    \refstepcounter{countTblrNote}
    \label{tblrnote\int_to_arabic:n {\g__tblr_table_count_int}:#2}
    \TblrOverlap
    {
      \__tblr_hyper_link:nn {#2}
      {
        \textsuperscript {
          \UseTblrFont { note-tag }
          \textasteriskcentered
          \countStyle{countTblrNote}
        }
      }
    }
  }
}
\ExplSyntaxOff

Now, you can give * to the second and subsequent \newTableNote to get the desired result.

\begin{talltblr}[
    caption = {When tags are duplicated},
    note{Dup} = {This implementation can handle duplicate tags},
  ]{
    colspec = {XXX}, width = 0.5\linewidth, hlines,
  }
  Alpha   & Beta  & Gamma                    \\
  Epsilon & Zeta  & Eta\newTblrNote{Dup}     \\
  Iota    & Kappa & Lambda\newTblrNote*{Dup} \\
\end{talltblr}

However, considering the possibility of rearranging etc. later, this workaround is not practical. This is an ad hoc workaround.

Automatic sorting of note

I don't have any meaningful ideas about sorting note...

[yarakos95]

In order to handle duplicate tags, I tried to resolve them using a property list as follows.

\ExplSyntaxOn
\prop_new:N \g_tblrnote_label_prop

\NewDocumentCommand \newTblrNote { m }
{
  \cs_if_exist:NT \hypersetup { \ExpTblrTemplate { note-border }{ normal } }
  %%%%%
  \exp_args:NNf \prop_if_in:NnTF \g_tblrnote_label_prop {\g__tblr_table_count_int #1}
  { %% Second and subsequent duplicate tags
      \TblrOverlap
      {
        \__tblr_hyper_link:nn {#1}
        {
          \textsuperscript { \UseTblrFont { note-tag }
          \textdagger \ref{tblrnote\int_to_arabic:n {\g__tblr_table_count_int}:#1}
          }
        }
      }
  }
  { %% Only one tag in the table or the first duplicate tag
    \exp_args:NNf \prop_gput_if_new:Nnn \g_tblrnote_label_prop {\int_use:N \g__tblr_table_count_int #1} {#1}
    \refstepcounter{countTblrNote}
    \label{tblrnote\int_to_arabic:n {\g__tblr_table_count_int}:#1}
    \TblrOverlap
    {
      \__tblr_hyper_link:nn {#1}
      {
        \textsuperscript {
          \UseTblrFont { note-tag } \textasteriskcentered
          \countStyle{countTblrNote}
        }
      }
    }
  }
  %%%%%
}
\ExplSyntaxOff

However, since the tabularray table is evaluated more than once, it was not possible to process it well.