[Tex/LaTex] Getting those %#!^& signs in the footnote!

footnoteshyperrefverbatim

This is basically an expanded version of part of Control command arguments . The original questioner there wants to redefine \href so that all the links end up in foonotes (rather than in the main document) so my suggestion was the old \let\oldcmd=\cmd \def\cmd{reimplement \cmd in some fancy way} trick. Turned out that that didn't solve the problem. But what broke this solution isn't really about the solution, it's about those @&*@%y$#@ characters in URLs and … *sigh* … footnotes.

Not being an expert on hyperref, I appeal to the community to help. (And half an hour gazing at the documentation and source of hyperref has not brought enlightenment either.) I've tried the solutions at Getting percent sign into an URL in a footnote and Is there a reliable footnote command? to no avail (though perhaps I'm doing them wrong … sorry, incorrectly). Also, note that How display the href link in the footnote? is the wrong way around for this: the questioner wants the clickable link in the footnote.

Here's the URL that the questioner presented me with, embedded in a MWE:

\documentclass{article}
\usepackage{hyperref}

\begin{document}
Hello\footnote{\href{http://www.google.com/#sclient=psy&hl=en&site=&source=hp&q=numbers&aq=f&aqi=&aql=&oq=&pbx=1&fp=d5033c56880e0199}{b}} world.

\end{document}

This produces the error:

! Illegal parameter number in definition of \Hy@tempa.
<to be read again> 
                   s
l.9 ...qi=&aql=&oq=&pbx=1&fp=d5033c56880e0199}{b}}
                                                   world.

which makes me think that it is the # that is causing the problem.

Best Answer

The url package (used by hyperref) gives you the \Url@HyperHook hook, which is also used in \urldef (see Getting percent sign into an URL in a footnote). The original URL string is located in \Url@String (expandable) and the already formatted string in \Url@FormatString (not expandable).

This can be used to implement your own \url like macros. The code below then creates the wanted \footnote with an \href. A second macro is required to read the second argument of \href after the URL. This is a little tricky because the rest of the internal code of \url most be jumped over first and then reinserted.

\documentclass{article}

\usepackage{hyperref}

\makeatletter

\def\hreffootnote{%
    %\unskip % maybe required
    \begingroup
    \def\Url@HyperHook ##1\endgroup{%
        \let\Url@HyperHook\relax
        \href@footnote
    }%
    \url
}

\let\realhref\href
\def\href@footnote#1\endgroup#2{%
   \footnote{\expandafter\realhref\expandafter{\Url@String}{#2}}%
   \endgroup\endgroup#1\endgroup%  #1 is some internal `\url` code
}


\begin{document}

Text\hreffootnote{http://foobar.com/~test/%^&*$_##/test}{there} after

Text \href{http://foobar.com/~test/%^&*$_##/test}{there} after

\let\href\hreffootnote
Text \href{http://foobar.com/~test/%^&*$_##/test}{there} after

Hello\hreffootnote{http://www.google.com/#sclient=psy&hl=en&site=&source=hp&q=numbers&aq=f&aqi=&aql=&oq=&pbx=1&fp=d5033c56880e0199}{b} world.


\end{document}

Alternatively a home made solution which reads the first argument verbatim (except { } characters):

\documentclass{article}

\usepackage{hyperref}

\makeatletter

\def\hreffootnote{%
    %\unskip
    \begingroup
    \let\do\@makeother
    \dospecials
    \catcode`\{=1\relax
    \catcode`\}=2\relax
    \href@footnote
}
\def\href@footnote#1{%
    \endgroup
    \href@@footnote{#1}%
}
\let\realhref\href
\def\href@@footnote#1#2{%
    \footnote{\realhref{#1}{#2}}%
}

\begin{document}

Text\hreffootnote{http://foobar.com/~test/%^&*$_##/test}{there} after

Text \href{http://foobar.com/~test/%^&*$_##/test}{there} after

\let\href\hreffootnote
Text \href{http://foobar.com/~test/%^&*$_##/test}{there} after

Hello\hreffootnote{http://www.google.com/#sclient=psy&hl=en&site=&source=hp&q=numbers&aq=f&aqi=&aql=&oq=&pbx=1&fp=d5033c56880e0199}{b} world.

\end{document}

Update 2011-07-27:

I now published a new version of newverbs which provides \collectverb and \Collectverb to collect verbatim arguments easily. For the sake of completeness here again the full solution based on this package. (It is also an answer to Changing href's to footnotes).

\documentclass{article}

\usepackage{hyperref}
\usepackage{newverbs}[2011/07/24]

\let\orighref\href
\renewcommand{\href}{\Collectverb{\hrefii}}
\newcommand\hrefii[2]{\footnote{\orighref{#1}{#2}}}

\usepackage{lipsum}% Dummy text
\begin{document}

\lipsum*[1]\href{http://test.com/%$^£$%^_@~}{Test URL}

% With other argument separators as { }:
\lipsum*[2]\href|http://test.com/%$^£$}{%^_@~|{Test URL}

% If a real \href is wanted (also used for comparison here)
\lipsum*[3]\orighref{http://test.com/%$^£$%^_@~}{Test URL}

\end{document}

Related Solutions

[Tex/LaTex] Footnote link stubbornly jumps to the title page

Similary to my answer to Why are all of my footnotes hyperlinked to the titlepage? this is a matter of package loading order. (One could argue this is a duplicate.) setspace is your bad boy here… What you need to be aware of is that arsclassica loads classicthesis which loads hyperref. This means you need to load setspace before arsclassica.

However, both arsclassica and classicthesis at least nowadays try loading hyperref with the option hyperfootnotes=false which made it tricky to reproduce the MWE. We also need to load hyperref before arsclassica to get them activated again.

classicthesis also loads footmisc which is not terribly compatible with hyperref. As can be seen in my linked answer it must be loaded before hyperref, too. this means we need this loading order:

\usepackage{setspace}
\usepackage{footmisc}
\usepackage{hyperref}
\usepackage{arsclassica}

Actually classicthesis does not load footmisc if it finds the command \deffootnote. The latter is a KOMA-Script command and available in KOMA-Script classes. What the maintainer of classicthesis didn't seem to be aware is that one can load the package scrextend for \deffootnote as well. So lets exchange footmisc and scrextend to be on the safer side:

\usepackage{setspace}
\usepackage{scrextend}
\usepackage{hyperref}
\usepackage{arsclassica}

When we apply this to the MWE we get correctly hyperlinked footnotes (as of today 2021/01/04). I didn't use an external file book_structure.tex but simply included the code in the preamble and re-ordered:

\documentclass[11pt, a4paper, oneside, headinclude,footinclude]{book}

\usepackage[T1, T2A]{fontenc} 
\usepackage[english, russian]{babel}

\usepackage[margin = 1.5cm]{geometry} 
\usepackage{setspace} % making 1.5 line spacing 
\onehalfspacing

\usepackage{scrextend}
\usepackage[hyperfootnotes]{hyperref}
\usepackage{arsclassica}
\usepackage{amsfonts}
\renewcommand*\rmdefault{iwona} 

\newcommand*{\titleTH}{%
  \begingroup
    \raggedleft 
    \vspace*{\baselineskip} 
    {\LARGE\bfseries Some book title}\\[\baselineskip]
    {\Large Version x.x.x}\par
  \endgroup
}

\begin{document}

\titleTH
\thispagestyle{empty}
\newpage

\chapter{System requirements}

\textbf{Supported operating systems:} Unix OS family (e.g. Mac OS X, Linux,
FreeBSD) and Microsoft Windows OS family (e.g. 2000, 2003, XP, Vista, Seven,
8/8.1, 10).

\textbf{CPU architectures:} x86 (x86-32, x86-64), ARMv7.

\textbf{CPU model:}\footnote{see our white paper on selection of hardware for
  LPR} selected individually (in accordance to number of recognition threads
to be used on the server, video framerate and resolution). When adding one or
more recognition threads, CPU load increases linearly.

\end{document}

[Tex/LaTex] Two references to the same footnote

To get the footnote number as superscript use \textsuperscript{\ref{<label>}}. The link box provided by hyperref is not easy to tweak with, but in Adjust box around hyperref footnote links there is a solution to make all boxes fit the number tightly.

Resulting in:

MWE

\documentclass[11pt, a4paper, oneside]{article}
\usepackage{hyperref}

%% Code from https://tex.stackexchange.com/a/45656/81905
\usepackage{ltxcmds}
\makeatletter
\renewcommand{\footnote}[2][\empty]{%
  \nolinebreak%
  \addtocounter{footnote}{+1}%
  \xdef\sfootnote@number{\arabic{footnote}}%
  \ltx@ifpackageloaded{hyperref}{% hyperref loaded
    \ifHy@hyperfootnotes% option hyperfootnotes=true
      \addtocounter{Hfootnote}{+1}%
      % Code from the hyperref package
        \global\let\Hy@saved@currentHref\@currentHref%
        \hyper@makecurrent{Hfootnote}%
        \global\let\Hy@footnote@currentHref\@currentHref%
        \global\let\@currentHref\Hy@saved@currentHref%
      % End of code form the hyperref package
    \fi%
   }{% hyperref not loaded, nothing to be done here
   }%
  \xdef\sfootnote@opt{#1}% contains the optional argument
  \xdef\sfootnote@arabic{\arabic{footnote}}% is the Arabic footnotenumber
  \edef\sfootnote@formated{\thefootnote}% could also be * or dagger
  \ifx\sfootnote@opt\empty% i.e. no optional argument used
    \footnotetext{\label{fnr:\sfootnote@arabic}#2}%
  \else%
    \ltx@ifpackageloaded{hyperref}{% hyperref loaded
      \footnotetext[#1]{\phantomsection\label{fnr:\sfootnote@arabic}#2}%
     }{% hyperref not loaded
      \footnotetext[#1]{\label{fnr:\sfootnote@arabic}#2}%
     }%
  \fi%
  \ltx@ifpackageloaded{hyperref}{% hyperref package loaded
    \ifHy@hyperfootnotes% option hyperfootnotes=true
      \hbox {\@textsuperscript {\normalfont \ref{fnr:\sfootnote@arabic}}}%
    \else% option hyperfootnotes=false
      \hbox {\@textsuperscript {\normalfont \ref*{fnr:\sfootnote@arabic}}}%
    \fi%
  }{% hyperref package not loaded
    \hbox {\@textsuperscript {\normalfont \ref{fnr:\sfootnote@arabic}}}%
   }%
}
\makeatother
%% End of code

\begin{document}
\noindent Textoç~\footnote{TextFootnote\label{ftn:X}} \\
TextB~\textsuperscript{\ref{ftn:X}}
\end{document}

Best Answer

Update 2011-07-27:

Related Solutions

[Tex/LaTex] Footnote link stubbornly jumps to the title page

[Tex/LaTex] Two references to the same footnote

MWE

Related Question