[Tex/LaTex] Making global footnotes inside a minipage with hyperref support

countersfootnoteshyperrefminipage

I would like to make footnotes inside a minipage that use the global footnote counters and the hyperref package.

I'm having trouble getting hyperref to make the correct references. I imagine I need to change the Hfootnote counter but I haven't had any luck with that and I'm not sure exactly what's going on. I tried adding a \addtocounter{Hfootnote}{-1} and \stepcounter{Hfootnote} but that didn't help.

Below is a minimal example.

\documentclass{article}
\usepackage{hyperref}
\begin{document}
\noindent\ldots{} main text\footnote{Before minipage} \ldots\par
\fbox{\begin{minipage}{.5\linewidth}
    A footnote to use global footnotes.\footnotemark
    A second global footnote.\footnotemark
\end{minipage}}
\addtocounter{footnote}{-1}
\footnotetext{First global footnote inside minipage}
\stepcounter{footnote}
\footnotetext{Second global footnote inside minipage}
\par
\noindent\ldots{} main text\footnote{After minipage} \ldots\par
\end{document}

Clicking on the first footnote inside the minipage does not yeild the expected result.

Best Answer

I finally figured it out! The short answer is that Hyperref sucks at footnotes.

Thanks to Gonzalo Medina's answer to a similar question I was able to adapt a workaround. I'm new to tex.stackechange so if I can give any more credit to Medina please let me know how.

Below is the working example.

\documentclass{article}
\usepackage{hyperref}
\begin{document}
\noindent\ldots{} main text\footnote{Before minipage} \ldots\par
\makeatletter
\fbox{\begin{minipage}{.5\linewidth}
    A footnote to use global footnotes.\footnotemark\global\let\saved@Href@A\Hy@footnote@currentHref
    A second global footnote.\footnotemark\global\let\saved@Href@B\Hy@footnote@currentHref
\end{minipage}}
\addtocounter{footnote}{-1}
\let\Hy@footnote@currentHref\saved@Href@A 
\footnotetext{First global footnote inside minipage}
\stepcounter{footnote}
\let\Hy@footnote@currentHref\saved@Href@B
\footnotetext{Second global footnote inside minipage}
\makeatother
\par
\noindent\ldots{} main text\footnote{After minipage} \ldots\par 
\end{document}

Related Solutions

[Tex/LaTex] \footnotemark and \footnotetext in minipage

Footnotes within minipage environments are printed with small letters. The definition in latex.ltx is

\def\thempfootnote{{\itshape\@alph\c@mpfootnote}}

You could redefine it. A quick way would be:

\let\thempfootnote\thefootnote

Afterwards the footnote symbols within a minipage will be an arabic number as well.

[Tex/LaTex] Making \footnote work in leftbar environment

A slightly longer code, which allows you to only type \footnote. The idea is to make each footnote append \footnotetext{#1} to a token list. This token list is then typeset at the right place. Some trickery is required to get nesting right, as well as hyperref support. Normally, this can be used for other (non-verbatim-ish) environments.

Comments in the code.

\documentclass{article}
\usepackage{etoolbox} % for "\pretocmd".
\makeatletter
%
% User command, see the end of the preamble for use.
% We redefine the environment by adding "\savefoot@begin" at 
% the beginning, and "\savefoot@end" at the end.
%
\newcommand{\DeclareSavefootEnvironment}[1]{%
  \expandafter\pretocmd\csname #1\endcsname
              {\savefoot@begin}{}{\savefoot@patch@error{#1}}%
  \expandafter\pretocmd\csname end#1\endcsname
              {\savefoot@end}{}{\savefoot@patch@error{#1}}%
}
\newcommand{\savefoot@patch@error}[1]{%
  \PackageError{savefoot}{etoolbox failed to patch the environment #1, sorry}{}}
%
% Register allocation.
%
\newcount\c@savefoot@depth
\newtoks\savefoot@toks
%
% "\savefoot@begin" starts an environment which saves footnotes.
% We only want to output footnotes outside any such environment,
% so we count how deep we are in this kind of environment using
% the count "\c@savefoot@depth", which pretends to be a LaTeX
% counter. 
%
% We will store all the "\footnotetext" into the toks 
% "\savefoot@toks". This is initialized _locally_ at the start
% of each "savefoot" environment.
% 
\newcommand{\savefoot@begin}{%
  \advance\c@savefoot@depth by 1\relax  
  \savefoot@toks={}}
%
% When ending a savefoot environment, we check if it was the 
% outermost one. In that case, "\@secondoftwo", we output the
% "\footnotetext" that we saved, after the end of the group.
% The "\endgroup" must be explicitly there; this is the case
% because of how "\end{...}" works in LaTeX2e.
% 
% Since the register "\savefoot@toks" is restored at the end 
% of the group, we need to expand it inside the group, then 
% send "\savefoot@append{<expanded \savefoot@toks>}" after the
% "\endgroup", hence the "\expandafter"s. Same thing when we 
% need to typeset.
% 
\newcommand{\savefoot@end}{%
  \ifnum\c@savefoot@depth>\@ne
  \expandafter\@firstoftwo
  \else
  \expandafter\@secondoftwo
  \fi
  {% Nested, don't output, save to the level above.
    \expandafter\do@after@explicit@endgroup\expandafter{%
      \expandafter\savefoot@append\expandafter{\the\savefoot@toks}}%
  }%
  {% Outside, output.
    \expandafter\do@after@explicit@endgroup\expandafter{%
      \the\savefoot@toks}%
  }%
}
%
% Appending to a toks is standard.
%
\newcommand{\savefoot@append}[1]{%
  \savefoot@toks\expandafter{\the\savefoot@toks#1}}%
%
% To put after "\endgroup", we need delimited parameters,
% hence the "\def". We first check that the command is new,
% just in case.
% 
\newcommand{\do@after@explicit@endgroup}{}
\def\do@after@explicit@endgroup#1#2\endgroup{#2\endgroup#1}
%
% Now the footnote command. We save the old definition, 
% used in the case where we are outside any savefoot
% environment. If we are inside a savefoot environment,
% place the "\footnotemark", and append 
% 
%    \savefoot@setcounter{<explicit number>}\footnotetext{<text>}
% 
% to our register. This will be typeset at the end. We cannot
% just do "\footnotetext[<explicit number>]{<text>}", because
% the hyperref package does not like that.
% 
\let\savefoot@old@footnote\footnote
\renewcommand{\footnote}[1]{%
  \ifnum\c@savefoot@depth>\z@
  \expandafter\@firstoftwo
  \else
  \expandafter\@secondoftwo
  \fi
  {% Inside a leftbar, save the text in the relevant toks.
    \footnotemark
    \savefoot@toks=\expandafter{%
      \the\expandafter\savefoot@toks
      \expandafter\savefoot@setcounter\expandafter{\the\c@footnote}%
      \footnotetext{#1}%
    }%
  }%
  {% Don't save, just typeset.
    \savefoot@old@footnote{#1}%
  }%
}
%
% When not using hyperref, just give the counter "footnote" 
% the right value (in that case, "\savefoot@hhyperref@support{#1}"
% will be defined to do nothing).
% 
\newcommand{\savefoot@setcounter}[1]{%
  \setcounter{footnote}{#1}%
  \savefoot@hyperref@support{#1}%
}
% 
% Getting "\footnotetext" and "\footnotemark" to work with hyperref
% is non-trivial, and I probably did something wrong. But at first
% sight it seems ok.
%
\newcommand{\savefoot@hyperref@support}[1]{%
  \setcounter{Hfootnote}{#1}%
  \global \let \Hy@saved@currentHlabel \@currentHlabel 
  \global \let \Hy@saved@currentHref \@currentHref 
  \hyper@makecurrent {Hfootnote}%
  \global \let \Hy@footnote@currentHlabel \@currentHlabel 
  \global \let \Hy@footnote@currentHref \@currentHref 
  \global \let \@currentHlabel \Hy@saved@currentHlabel 
  \global \let \@currentHref \Hy@saved@currentHref
}
%
% If hyperref is not loaded, we disable the hyperref support.
% We check at the "\begin{document}".
%   
\AtBeginDocument{%
  \@ifpackageloaded{hyperref}{}{\let\savefoot@hyperref@support\@gobble}%
}
\makeatother


% ============= Example =====================

\usepackage{framed}
\usepackage{hyperref}
\DeclareSavefootEnvironment{leftbar}

\begin{document}

Some text,\footnote{With a normal footnote.} in which 
footnotes are preserved.\footnote{Even when you put several 
  in a row.}\footnote{Like this.}

\begin{leftbar}
  Also true for the leftbar environment.\footnote{The relevant 
    commands are placed after the end of the environment.} 
  \begin{leftbar}
    And we check that nesting works.\footnote{That was the tricky part\ldots}
  \end{leftbar}
  Maybe it breaks after nesting?\footnote{Let's see.}
\end{leftbar} 

More footnotes.\footnote{Like this.}\footnote{And that.}

\begin{leftbar}
  And another leftbar environment to be sure.\footnote{Does it 
    work? I'll see soon, when I compile.}
\end{leftbar}

\end{document}

Best Answer

Related Solutions

[Tex/LaTex] \footnotemark and \footnotetext in minipage

[Tex/LaTex] Making \footnote work in leftbar environment

Related Question