Using ocgx2 instead of ocg-p: \AddToShipoutPictureBG not recognized

Question

I want to use the ocgx2 package under luatex.
In the past, I used the ocg-p package but the ocg-p package does not work with luatex, see ocg-p: Optional Content Groups in LuaTeX.
My (apparently wrong) understanding is, that the ocgx2 package is code-compatible with the ocg-p package.
Problem: The below code works fine with the ocg-p package under pdflatex but does not work with the ocgx2 package under luatex.

l.19 \AddToShipoutPictureBG
The control sequence at the end of the top line
of your error message was never \def'ed. If you have
misspelled it (e.g., \hobx'), typeI' and the correct
spelling (e.g., `I\hbox'). Otherwise just continue,
and I'll forget about whatever was undefined.

\documentclass[]{article}
\usepackage[a6paper]{geometry}
\usepackage{fontawesome5}
\usepackage{tikz}
\usepackage{hyperref}
%\usepackage{ocgx2} % Works not fine under luatex
\usepackage{ocg-p} % Works fine under pdflatex
%https://tex.stackexchange.com/questions/276532
\AddToShipoutPictureBG
{\begin{ocg}[printocg = never]{PDF Navigation Elements}{oc1}{1}
    \begin{tikzpicture}[remember picture, overlay]
    \node [anchor = west, font = \large, align = left] () at (current page.west){\Acrobatmenu{GoBack}{\faArrowAltCircleLeft}\\Acrobatmenu{GoForward}{\faArrowAltCircleRight}};

    \end{tikzpicture}

 \end{ocg}%
 }
\begin{document}
Test
\end{document}

\AddToShipoutPictureBG is defined in pkg eso-pic which seems to be a dependency of ocg-p. I would use the hook facilities built into the LaTeX kernel instead. See below. — AlexG, Feb 24 '23 at 11:00

AlexG · Accepted Answer · 2023-02-24T09:01:37.217

4

If you use the Kernel-builtin hook facilities (available since 1/10/2020), everything works fine across all engines:

\documentclass[]{article} 
\usepackage[a6paper]{geometry}
\usepackage{fontawesome5}
\usepackage{hyperref} 
\usepackage{ocgx2} 
\usepackage{tikz}
\AddToHook{shipout/background}{% 
  \setlength\unitlength{\paperheight}% 
  \begin{ocg}[printocg=never]{PDF Navigation Elements}{oc1}{on} 
  \hypersetup{pdfborder=0 0 0}% 
  \large% 
  \put(0,-0.5){% 
    \tikz\node[inner sep=2pt]{\Acrobatmenu{GoBack}{\faArrowAltCircleLeft}}; 
  }% 
  \put(0,-0.5){% 
    \raisebox{-\height}{\tikz\node[inner sep=2pt]{\Acrobatmenu{GoForward}{\faArrowAltCircleRight}};} 
  }% 
  \end{ocg}% 
}
\begin{document} 
Test 
\end{document}

The spacing between the buttons can be adjusted with the node's inner sepoption.

edited Feb 24 '23 at 09:01

answered Feb 24 '23 at 07:22

AlexG

54,894

Great! (1) How are the elements positioned in your code, I do not see remember picture etc? (2) Do you know if there is an overview of the available hooks somewhere? For example, if there is a shipout/foreground? – Dr. Manuel Kuehner Feb 24 '23 at 14:24
1

With \put all absolute positioning is made and (0,0) is the top-left page corner. texdoc ltshipout should take you to the documentation. The whole hook management is introduced in texdoc lthooks. – AlexG Feb 24 '23 at 15:06
Thanks a lot, very helpful. – Dr. Manuel Kuehner Feb 24 '23 at 16:50

Using ocgx2 instead of ocg-p: \AddToShipoutPictureBG not recognized

1 Answers1

Linked