Zref package Label (\zlabel) at label key in tabularray

[SimonidesProject]

I use the packages zref and hyperref to make my references in LaTeX. These packages are independents and have their own schema of reference, so I need to use the commands \zlabel and \label to work with them.

I was searching the source code of tabularray and did not find any options to work with zref package. But, working on the code I got one solution. I went to the command \__tblr_build_table_label_entry: definition:

\cs_new_protected:Npn \__tblr_build_table_label_entry:
  {
    \tl_set:Nx \l_tmpa_tl { \InsertTblrText { label } }
    \tl_if_eq:NnTF \l_tmpa_tl { none }
      {
        \SetTblrTemplate { caption-tag }{ empty }
        \SetTblrTemplate { caption-sep }{ empty }
      }
      {
        \refstepcounter { table }
        \tl_if_empty:NF \l_tmpa_tl { \exp_args:NV \label \l_tmpa_tl }
      }
    \tl_set:Nx \l_tmpb_tl { \InsertTblrText { entry } }
    \tl_if_eq:NnF \l_tmpb_tl { none }
      { \UseTblrTemplate { caption-lot } { default } }
  }

And added the line \tl_if_empty:NF \l_tmpa_tl { \exp_args:NV \zlabel \l_tmpa_tl } just after the line \tl_if_empty:NF \l_tmpa_tl { \exp_args:NV \label \l_tmpa_tl } so I got the two labels working very well with this code:

\cs_new_protected:Npn \__tblr_build_table_label_entry:
  {
    \tl_set:Nx \l_tmpa_tl { \InsertTblrText { label } }
    \tl_if_eq:NnTF \l_tmpa_tl { none }
      {
        \SetTblrTemplate { caption-tag }{ empty }
        \SetTblrTemplate { caption-sep }{ empty }
      }
      {
        \refstepcounter { table }
        \tl_if_empty:NF \l_tmpa_tl { \exp_args:NV \label \l_tmpa_tl }
        \tl_if_empty:NF \l_tmpa_tl { \exp_args:NV \zlabel \l_tmpa_tl }
      }
    \tl_set:Nx \l_tmpb_tl { \InsertTblrText { entry } }
    \tl_if_eq:NnF \l_tmpb_tl { none }
      { \UseTblrTemplate { caption-lot } { default } }
  }

The problem is that I am not expert in LaTeX 3 syntax and when I compiled for the first time this solution I got the error The Command \__tblr_build_table_label_entry: already defined, so, for this working solution I downloaded the tabularray.sty renamed and modified it in my document folder.

Is there possible to add this solution to the source code? Maybe with a zref key-option on the package specification?

[lvjr]

Sorry, I haven't used \zlabel before. Please post a minimal example showing how you use \zlabel and \label together. Then I will see whether it is a job of tabularray or zref or both of them.

PS: you don't need to modify tabularray.sty. Instead you only need to add the following code after \usepackage{tabularray} before this problem is solved:

\ExplSyntaxOn
\cs_set_protected:Npn \__tblr_build_table_label_entry:
  {
    \tl_set:Nx \l_tmpa_tl { \InsertTblrText { label } }
    \tl_if_eq:NnTF \l_tmpa_tl { none }
      {
        \SetTblrTemplate { caption-tag }{ empty }
        \SetTblrTemplate { caption-sep }{ empty }
      }
      {
        \refstepcounter { table }
        \tl_if_empty:NF \l_tmpa_tl { \exp_args:NV \label \l_tmpa_tl }
        \tl_if_empty:NF \l_tmpa_tl { \exp_args:NV \zlabel \l_tmpa_tl }
      }
    \tl_set:Nx \l_tmpb_tl { \InsertTblrText { entry } }
    \tl_if_eq:NnF \l_tmpb_tl { none }
      { \UseTblrTemplate { caption-lot } { default } }
  }
\ExplSyntaxOff

[SimonidesProject]

The advantages of the zref package are that you can get from one label all counters in the document and that you can define expandable commands to create very custom references system. I use in this way, I put the \zlabel to show the number information (here I made a very simple \subsecref to test where the table is) and I use the command \hyperref to create the link. So, the basic schema is \hyperref[label]{\zref[property]{zlabel}}. To get the things working, I need to add the property 'table' to the list of commands:
the command \zref@newprop{table}{\arabic{table}} creates the property and the command \zref@addprop{main}{table} adds it to the list for the \zlabel search.

My MWE:

\documentclass{scrbook}

\usepackage{tabularray}
\usepackage{etoolbox}

\usepackage[titleref, user, abspage]{zref}
\usepackage[colorlinks=true]{hyperref}


% \zref  property declaration
\makeatletter
\zref@newprop{table}{\arabic{table}} % \zref@newprop{property name}{Counter to be memorized}
\zref@addprop{main}{table} % Add 'table' property in the list main. 
% \zref@extractdefault{label}{property name}{default value (to put in the place of the reference, before it has been defined)} - extract the value of the property - expandable command.
% \zref[property name]{label} - gets the value of the property - not expandable 
\zref@newprop{chapter}{\arabic{chapter}}
\zref@newprop{section}{\arabic{section}}
\zref@newprop{subsection}{\arabic{subsection}}
\zref@addprop{main}{chapter}
\zref@addprop{main}{section}
\zref@addprop{main}{subsection}
%%%%%%%%%%%%%%%% - Reference Command
\NewDocumentCommand{\subsecref}{m}{%
\ifnumequal{\zref@extractdefault{#1}{subsection}{0}}{0}{%
\ifnumequal{\zref@extractdefault{#1}{section}{0}}{0}{%
chapter \zref[chapter]{#1}}{section \zref[chapter]{#1}-\zref[section]{#1}}}{%
subsection \zref[chapter]{#1}-\zref[section]{#1}-\zref[subsection]{#1}}}
%%%%%%%%%%%%%% - Table full reference.
\NewDocumentCommand{\tableref}{m}{table \hyperref[#1]{\zref[table]{#1}} in \subsecref{#1} on page \zref[page]{#1}}
\makeatother 

% Put zlabel inside label key
\ExplSyntaxOn 
\cs_set_protected:Npn \__tblr_build_table_label_entry:
  {
    \tl_set:Nx \l_tmpa_tl { \InsertTblrText { label } }
    \tl_if_eq:NnTF \l_tmpa_tl { none }
      {
        \SetTblrTemplate { caption-tag }{ empty }
        \SetTblrTemplate { caption-sep }{ empty }
      }
      {
        \refstepcounter { table }
        \tl_if_empty:NF \l_tmpa_tl { \exp_args:NV \label \l_tmpa_tl }
        \tl_if_empty:NF \l_tmpa_tl { \exp_args:NV \zlabel \l_tmpa_tl }
      }
    \tl_set:Nx \l_tmpb_tl { \InsertTblrText { entry } }
    \tl_if_eq:NnF \l_tmpb_tl { none }
      { \UseTblrTemplate { caption-lot } { default } }
  }
\ExplSyntaxOff



\begin{document}

\chapter{Chapter 1}

\begin{longtblr}[label={tab1}]{lccr}
    \hline
     Alpha   & Beta  & Gamma  & Delta \\
    \hline
     Epsilon & Zeta  & Eta    & Theta \\
    \hline
     Iota    & Kappa & Lambda & Mu    \\
    \hline
    \end{longtblr}

\section{Section 1}

\begin{longtblr}[label={tab2}]{lccr}
    \hline
     Alpha   & Beta  & Gamma  & Delta \\
    \hline
     Epsilon & Zeta  & Eta    & Theta \\
    \hline
     Iota    & Kappa & Lambda & Mu    \\
    \hline
    \end{longtblr}

\subsection{Subsection 1}


\begin{longtblr}[label={tab3}]{lccr}
    \hline
     Alpha   & Beta  & Gamma  & Delta \\
    \hline
     Epsilon & Zeta  & Eta    & Theta \\
    \hline
     Iota    & Kappa & Lambda & Mu    \\
    \hline
    \end{longtblr}


\par\tableref{tab1}
\par\tableref{tab2}
\par\tableref{tab3}

\end{document}

My output:

file.pdf

PS: Thank you for your tip!

[lvjr]

@SimonidesProject I have added zref library to tabularray package. See #256 .