TeX - LaTeX Stack Exchange is a question and answer site for users of TeX, LaTeX, ConTeXt, and related typesetting systems. It only takes a minute to sign up.
Sign up to join this community
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?
cleverefMany others are documented in section 9 of the hyperref manual. Some are more complex than simply loading after hyperref. Here are some more common ones...
amsrefsfloat before hyperref before algorithmchappgsidecaplinguex
geometry: From the User manual:
With
mag <> 1000, notruedimenandhyperref,hyperrefshould be loaded beforegeometry. Otherwise the resulted PDF size will become wrong.
showframe, showidx (which disables the \hrefs in the index but in this loading order at least documents compile at all)
and probably also further packages with \RequirePackage{hyperref}. A quick search in TeX Live 2011 resulted in this list:
amsrefsattachfile2bugtracker (part of pgfplots)classicthesisdoidtx-style (part of thuthesis)eformsexerquizhypgotoeinsdljsltxdockitopcitprerexrec-thytdclocktoptesiydoc-code and ydoc-desc (both part of ydoc; note, that ydoc-doc contains \hypersetup without loading hyperref)
)Packages with \RequirePackage[<some option(s)>]{hyperref}:
texdoc geometry, it should read: With mag <> 1000... I have edited the reply.
showkeys, as hyperref now has support for showkeys. See pages 207-208 of hyperref.pdf.
Feb 26, 2014 at 21:02
\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.
Feb 26, 2014 at 21:42
Other common ones include
bookmarkglossaries
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.
Aug 17, 2010 at 11:34
\glslink and \gls […] will automatically have hyperlinks …”
Aug 17, 2010 at 12:02
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.
The tabularx package is definitely one of the candidates. Otherwise links to footnotes are prevented.
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...
Apr 24, 2013 at 8:37
tabularx, loaded before hyperref causes trouble when you use footnotes in tables that are put inside a minipage.
Oct 2, 2017 at 18:22
tabularx/xltabular after hyperref the warning "pdfTeX warning (ext4): destination with the same identifier (name{table.X.X}) has been already used" is gone, too.
cleveref is one.
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.
From the minitoc documentation (section 2.17 Using the hyperref package with minitoc; emphasis added):
Since version #31,
minitocworks correctly with the powerfulhyperrefpackage [...] If you add the loading of thehyperrefpackage to a document yet usingminitoc, 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 ofhyperrefand add it again: the problem occurs only when upgrading fromminitoc#30 tominitoc#31 (or higher) with a document already processed and addinghyperrefat the same time! It seems better to process the document withminitoc#31 (or higher) withouthyperref, then withhyperref, because some internal commands written into the auxiliary files have been modified. If used, thehyperrefpackage must be loaded beforeminitoc.
One more is
To quote its README:
Allows
hyperrefpackage and the natbib package with optionsnumbersandsort&compressto 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.
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!
Another package is apacite.
See also http://promberger.info/linux/2009/03/18/latex-using-apacite-and-hyperref-in-the-same-document/
ocgx2Besides 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.
It may be late answer (more a tip), but it cost me a lot to find out, so let me add a tip for other Brazilian users which for some documents must use the regional standard package abntex2cite.
abntex2cite must always be after hyperref. If abntex2cite is placed before hyperref, then the .bbl file will have errors and the references won't be properly written. The references are the main (if not only) reason to use abntex2cite.
\usepackage{hyperref}
\usepackage[alf]{abntex2cite} % Normas ABNT - Always after hyperref
abntex2cite is unsupported and deprecated for years. the way to go now is biblatex-abnt.
abntex2cite is unsupported and old and so on. I've tested biblatex with abnt of my own, It works fine and is the way to go ... The real problem is I just don't know how to convence people like my advisor to use biblatex instead of bibtex AND at the same time correctly use the regional standard. Although he insists to use natbib, but natbib just doesn't write references and citations properly for all (many useless) cases. And in 2018 there was a huge update at the norms, which means more potential issues to deal.
abntex2cite and abntex-alf.bst, but you will need to edit them in order to achieve the standard given by ABNT NBR 6023:2018 and ABNT NBR 10520:2002.
abntex2cite, you may ask me for files and/or details of implementation
If hyperref comes before titlesec it produces the warning "The anchor of a bookmark and its parent's must not be the same" at \subsection and \subsubsection when using overleaf
\ExecuteAfterPackagesequences. Although I have to check with all the packages meantioned here!pkgloaderpackage: i’ve only speed-read the docs, but it looks a good step towards automation for the job. (i assume it’s a never-ending process, keeping it up-to-date, but it's looking good.)