208

The hyperref documentation says: "Make sure it comes last of your loaded packages". The reason is that it redefines many LaTeX commands. It's a rule of thumb that helps to avoid errors.

However, there are exceptions, for instance the amsrefs user's guide notes that amsrefs has to be loaded after hyperref.

To avoid problems when adding hypertext functionality: do you know further such exceptions?

|improve this question

12 Answers 12

113
  • cleveref

Many others are documented in section 6 of the hyperref manual. Some are more complex than simply loading after hyperref. Here are some more common ones...

  • amsrefs
  • float before hyperref before algorithm
  • chappg
  • sidecap
  • linguex
|improve this answer
  • 2
    Thanks, also for pointing to the README. hyperref has an extensive README. Though, some packages like cleveref, breakurl and others mentioned here weren't listed there. I'll check and perhaps send a note to the author, perhaps he would like to add them. – Stefan Kottwitz♦ Aug 17 '10 at 10:56
  • Good idea to contact the author. Heiko is generally very responsive about this things. – Lev Bishop Aug 17 '10 at 16:56
  • Thanks for improving my answer by adding the packages with options! (I already gave +1 to your answer, thus I cannot "more-upvote" here.) – Stephen Feb 9 '12 at 18:50
  • 3
    As a note, sidecap no longer has to be loaded after hyperref (as of 2002/05/24 v1.5h according to the linked document.) – Canageek Mar 28 '12 at 22:41
  • 4
    I really think that this is an example of one of the weaknesses of LaTex. Very frustrating behavior. – Nicholas Hamilton Dec 9 '12 at 5:31
85

and probably also further packages with \RequirePackage{hyperref}. A quick search in TeX Live 2011 resulted in this list:

Packages with \RequirePackage[<some option(s)>]{hyperref}:

|improve this answer
  • 1
    According to texdoc geometry, it should read: With mag <> 1000... I have edited the reply. – krlmlr Mar 21 '12 at 13:19
  • @user946850: Yes, there is a "not equal" sign in the pdf which died during copy & paste. Thanks for the correction! – Stephen Mar 22 '12 at 19:11
  • 1
    This may not be necessary any more for showkeys, as hyperref now has support for showkeys. See pages 207-208 of hyperref.pdf. – Ari Brodsky Feb 26 '14 at 21:02
  • 2
    Well, I'm partly wrong. \bibitem doesn't show its key if showkeys is loaded before hyperref. On the other hand, \autopageref gets broken if showkeys comes after hyperref. What to do? Maybe a bug report. – Ari Brodsky Feb 26 '14 at 21:42
  • could you update this to texlive 2017, if there are any changes? – Jonas Stein Jul 3 '17 at 9:40
48

Other common ones include

  • bookmark
  • glossaries
|improve this answer
  • Thanks! glossaries isn't even mentioned in manual or README. bookmark is recommended in the manual though without telling the loading order. – Stefan Kottwitz♦ Aug 17 '10 at 11:02
  • 5
    Hi Stefan, although glossaries can be loaded before hyperref, you have to jump through extra hoops to make it work quite as well. Nicola isn't terribly explicit about this in her glossaries manual, although in her only coded snippet involving hyperref she loads glossaries 2nd of all (see p. 69). For me, I've achieved much better results with glossary autohyperlinks loading the two packages in this order too. – Geoffrey Jones Aug 17 '10 at 11:34
  • 7
    @Stefan: Actually, the glossaries manual has this to say: “If you load the hyperref or html packages prior to loading the glossaries package, commands such as \glslink and \gls […] will automatically have hyperlinks …” – Konrad Rudolph Aug 17 '10 at 12:02
18

I experienced problem with the package ellipsis when loaded before hyperref.

In addition, as Joseph Wright writes here, https://tex.stackexchange.com/a/64605/9632, cmap has to be loaded after hyperref.

|improve this answer
13

The tabularx package is definitely one of the candidates. Otherwise links to footnotes are prevented.

|improve this answer
  • 3
    tabularx should be loaded after or before hyperref? I'm loading it before and doesn't seem to give me any errors, and both documentations say nothing about it... – Mario S. E. Apr 24 '13 at 8:37
  • 3
    I doubt this is valid. Could you provide proof? – Werner Jul 25 '15 at 1:02
  • I can verify that tabularx, loaded before hyperref causes trouble when you use footnotes in tables that are put inside a minipage. – HATEthePLOT Oct 2 '17 at 18:22
9

cleveref is one.

|improve this answer
9

Although not mentioned in its manual,

  • footnotebackref

loads hyperref without options before beginning its work. On that account, it might make better sense in documents to load footnotebackref second of the two.

|improve this answer
8

minitoc

From the minitoc documentation (section 2.17 Using the hyperref package with minitoc; emphasis added):

Since version #31, minitoc works correctly with the powerful hyperref package [...] If you add the loading of the hyperref package to a document yet using minitoc, you will get error message about spurious closing braces. Just let finish the LaTeX run, then re-LaTeX the document. There will be no problem if you remove the loading of hyperref and add it again: the problem occurs only when upgrading from minitoc #30 to minitoc #31 (or higher) with a document already processed and adding hyperref at the same time! It seems better to process the document with minitoc #31 (or higher) without hyperref, then with hyperref, because some internal commands written into the auxiliary files have been modified. If used, the hyperref package must be loaded before minitoc.

|improve this answer
8

One more is

To quote its README:

Allows hyperref package and the natbib package with options numbers and sort&compress to work together. This means that multiple sequential citations (e.g [3,2,1]) will be compressed to [1-3], where the '1' and the '3' are (color-)linked to the bibliography.

|improve this answer
  • 11
    As far as I can tell, hypernat is obsolete. You shouldn't load it either after or before hyperref. With modern versions of natbib and hyperref the sort&compress works and is linked without loading any other packages. – Lev Bishop Aug 23 '10 at 9:03
  • You're right... that's one less package I can load now. – Simon Sep 1 '10 at 4:47
6

I had some funny behaviour with pgfpages until I moved it after hyperref, but I'm not sure exactly what the issue was. I'm trying to replicate it, but I can't seem to get it to work at all now!

|improve this answer
5

Another package is apacite.

See also http://promberger.info/linux/2009/03/18/latex-using-apacite-and-hyperref-in-the-same-document/

|improve this answer
4
  • ocgx2

Besides providing commands for the creation and manipulation of PDF Layers (officially named Optional Content Groups), this package re-implements hyperref's ocgcolorlinks option.

\usepackage{hyperref} % do NOT set [ocgcolorlinks] here!
\usepackage[ocgcolorlinks]{ocgx2}

This kind of coloured hyperlinks make use of PDF Layers in order to appear highlighted in the PDF viewer, but which are printed out on paper in the normal colour of the surrounding text, which is usually black.

As opposed to the original hyperref implementation, longer (ocg-)coloured links made with ocgx2 are allowed to wrap around line endings and page breaks.

|improve this answer

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.