[Tex/LaTex] How to add a hyperlink to the table of contents

hyperreftable of contents

I am trying to add a hyperlink under the section line in the toc, but I get a compilation error when I try. The code below will not compile if the commented line is uncommented. Is there a solution to this?

\documentclass{article}
\usepackage{hyperref, color}

\def\animal{zebra}
\def\mylabel{zzz}

\begin{document}

\tableofcontents

\section{Zoo}
%\addtocontents{toc}{\hyperlink{\mylabel}{\textcolor{blue}{\animal}}}
\addtocontents{toc}{\textcolor{blue}{\animal}}

\hypertarget{\mylabel}{\noindent Here is a zebra.} \\
Go to \hyperlink{\mylabel}{\textcolor{blue}{\animal}}.

\end{document}

Best Answer

In your case you need to add \protect before \hyperlink:

\addtocontents{toc}{\protect\hyperlink{\mylabel}{\textcolor{blue}{\animal}}}
%                   ^^^^^^^^

With the following MWE

\documentclass{article}
\usepackage{color}
\usepackage{hyperref} % <================= should be last called package

\def\animal{zebra}
\def\mylabel{zzz}


\begin{document}

\tableofcontents

\section{Zoo}
\addtocontents{toc}{\protect\hyperlink{\mylabel}{\textcolor{blue}{\animal}}}
%\addtocontents{toc}{\textcolor{blue}{\animal}}

\hypertarget{\mylabel}{\noindent Here is a zebra.} \\
Go to \hyperlink{\mylabel}{\textcolor{blue}{\animal}}.

\end{document}

you get the wished result:

Related Solutions

[Tex/LaTex] How to make a hyperlink cover the whole line in table of contents including the dots

Hyperlinks in the table of contents (TOC) are generated by the \contentsline command defined in hyperref.sty. The linktoc=all option setting makes \contentsline add separate links to the title and page number. A third link can be applied to the leader between the title and page number by patching the appropriate leader-generating command locally using etoolbox. Enclosing the whole TOC entry in a hyperlink would be much tidier, but this is a relatively difficult problem.

For TOCs formatted by latex internals, the leader is generated by the command \@dottedtocline defined in latex.ltx. The following patch simply encloses the leader in a hyperlink pointing to the current TOC entry's location, which is passed as the fourth argument to \contentsline.

\documentclass{report}
\usepackage[linktoc=all]{hyperref}
\usepackage{etoolbox}

\makeatletter
\pretocmd{\contentsline}
  {\patchcmd{\@dottedtocline}
     {\leaders}
     {\hyper@linkstart{link}{#4}\leaders}
     {}
     {}%
   \patchcmd{\@dottedtocline}
     {\hfill}
     {\hfill\hyper@linkend}
     {}
     {}}
  {}
  {}
\makeatother

\begin{document}
\tableofcontents
\chapter{First Chapter} \pagebreak
\section{First Section} \pagebreak
\subsection{First Subsection}
\chapter{Second Chapter} \pagebreak
\section{Second Section} \pagebreak
\subsection{Second Subsection}
\end{document}

The result looks terrible with link borders, but not so bad with colorlinks=true. enter image description here

This patch is general enough to work with TOCs formatted via package-defined user commands so long as the leader is generated by \@dottedtocline. KOMA-Script's tocstyle is one example of such a package - it redefines \@dottedtocline.

tocloft and memoir issue the command \cftdotfill instead of \@dottedtocline. The code below demonstrates a patch that will work for both the tocloft package and the memoir document class.

\documentclass{memoir}
\usepackage[linktoc=all]{hyperref}
\usepackage{etoolbox}

\makeatletter
\pretocmd{\contentsline}
  {\patchcmd{\cftdotfill}
     {\leaders}
     {\hyper@linkstart{link}{#4}\leaders}
     {}
     {}%
   \patchcmd{\cftdotfill}
     {\hfill}
     {\hfill\hyper@linkend}
     {}
     {}}
  {}
  {}
\makeatother

\setcounter{tocdepth}{2}
\renewcommand*{\cftdot}{\ensuremath{\ast}}
\renewcommand*{\cftsectionfont}{\itshape}
\renewcommand*{\cftsectionleader}{\cftdotfill{\cftsectiondotsep}}
\renewcommand*{\cftsubsectionfont}{\scshape}
\renewcommand*{\cftsubsectiondotsep}{9}
\renewcommand*{\cftsubsectionleader}{\cftdotfill{\cftsubsectiondotsep}}

\begin{document}
\tableofcontents
\chapter{First Chapter} \pagebreak
\section{First Section} \pagebreak
\subsection{First Subsection}
\chapter{Second Chapter} \pagebreak
\section{Second Section} \pagebreak
\subsection{Second Subsection}
\end{document}

enter image description here

[Tex/LaTex] Page number on the left with book class

Here's a solution that uses the titletoc package; the important part of the code is

% chapter formatting in toc
\titlecontents{chapter}
[0.0cm]             % left margin
{}                  % above code
{%                  % numbered format
{\llap{\thecontentspage\hspace{.5cm}}\thecontentslabel~}%
}%
{}         % unnumbered format
{}         % filler-page-format, e.g dots

screenshot

Here's a complete MWE to play with.

% arara: pdflatex
% arara: pdflatex
\documentclass{book}
\usepackage{lipsum}
\usepackage{titlesec}
\usepackage{titletoc}

% chapter formatting in toc
\titlecontents{chapter}
[0.0cm]             % left margin
{}                  % above code
{%                  % numbered format
{\llap{\thecontentspage\hspace{.5cm}}\thecontentslabel~}%
}%
{}         % unnumbered format
{}         % filler-page-format, e.g dots

\begin{document}
\tableofcontents

\chapter{mychapter} 
\section{mysection}
\subsection{mysubsection}
\section{mysection}
\subsection{mysubsection}
\subsection{mysubsection}
\subsection{mysubsection}
\subsection{mysubsection}
\subsection{mysubsection}
\chapter{mychapter} 
\section{mysection}
\subsection{mysubsection}
\section{mysection}
\subsection{mysubsection}
\subsection{mysubsection}
\subsection{mysubsection}
\subsection{mysubsection}
\subsection{mysubsection}
\chapter{mychapter} 
\end{document}

Best Answer

Related Solutions

[Tex/LaTex] How to make a hyperlink cover the whole line in table of contents including the dots

[Tex/LaTex] Page number on the left with book class

Related Question