> For the complete documentation index, see [llms.txt](https://overleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://overleaf-pro.ayaka.space/latex/document-structure/09-hyperlinks.md). # Hyperlinks LaTeX is a great tool for printable professional-looking documents, but can be also used to generate PDF files with excellent navigation tools. This article describes how to create hyperlinks in your document, and how to set up LaTeX documents to be viewed with a PDF-reader. ## Introduction Let's start with a minimal working example, by simply importing the **hyperref** package all [cross-referenced elements](/latex/document-structure/03-cross-referencing-sections-equations-and-floats.md) become hyperlinked. ```latex \documentclass{book} \usepackage{blindtext} \usepackage{hyperref} \title{Example of Hyperlinks} \author{Overleaf} \begin{document} \frontmatter \tableofcontents \clearpage \addcontentsline{toc}{chapter}{Foreword} {\huge {\bf Foreword}} \Blindtext \clearpage \addcontentsline{toc}{chapter}{Dummy entry} {\huge {\bf Dummy entry}} \Blindtext \mainmatter \chapter{First Chapter} This will be an empty chapter \begin{equation} \label{eq:1} \sum_{i=0}^{\infty} a_i x^i \end{equation} The equation \ref{eq:1} shows a sum that is divergent. This formula will be used later on page \pageref{second}. \Blindtext \clearpage \section{Second section} \label{second} \blindtext \Blinddocument \end{document} ``` [Open this `hyperref` example in Overleaf](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Basic+hyperref+example\&snip=%5Cdocumentclass%7Bbook%7D%0A%5Cusepackage%7Bblindtext%7D%0A%5Cusepackage%7Bhyperref%7D%0A%0A%5Ctitle%7BExample+of+Hyperlinks%7D%0A%5Cauthor%7BOverleaf%7D%0A%0A%5Cbegin%7Bdocument%7D%0A%0A%5Cfrontmatter%0A%5Ctableofcontents%0A%5Cclearpage%0A%0A%5Caddcontentsline%7Btoc%7D%7Bchapter%7D%7BForeword%7D%0A%7B%5Chuge+%7B%5Cbf+Foreword%7D%7D%0A%0A%5CBlindtext%0A%5Cclearpage%0A%0A%5Caddcontentsline%7Btoc%7D%7Bchapter%7D%7BDummy+entry%7D%0A%7B%5Chuge+%7B%5Cbf+Dummy+entry%7D%7D%0A%0A%5CBlindtext%0A%5Cmainmatter%0A%0A%5Cchapter%7BFirst+Chapter%7D%0A%0AThis+will+be+an+empty+chapter%0A%0A%5Cbegin%7Bequation%7D%0A%5Clabel%7Beq%3A1%7D%0A%5Csum_%7Bi%3D0%7D%5E%7B%5Cinfty%7D+a_i+x%5Ei%0A%5Cend%7Bequation%7D%0A%0AThe+equation+%5Cref%7Beq%3A1%7D+shows+a+sum+that+is+divergent.+This+formula+will+be+used+later+on+page+%5Cpageref%7Bsecond%7D.%0A%0A%5CBlindtext%0A%5Cclearpage%0A%0A%5Csection%7BSecond+section%7D+%5Clabel%7Bsecond%7D%0A%0A%5Cblindtext%0A%5CBlinddocument%0A%5Cend%7Bdocument%7D) ![Example hyerref document](/files/cOCFR1dktpov5bNPifh2) The lines in the table of contents become links to the corresponding pages in the document by simply adding in the preamble of the document the line ```latex \usepackage{hyperref} ``` One must be careful when importing `hyperref`: usually, it has to be the last package to be imported—but there might be some exceptions to this rule. ## Styles and colours The default formatting for links can be changed so the information in your documents is more clearly presented. Below you can see an example: ```latex \documentclass{book} \usepackage{hyperref} \hypersetup{ colorlinks=true, linkcolor=blue, filecolor=magenta, urlcolor=cyan, pdftitle={Overleaf Example}, pdfpagemode=FullScreen, } \urlstyle{same} \begin{document} \tableofcontents \chapter{First Chapter} This will be an empty chapter and I will put some text here \begin{equation} \label{eq:1} \sum_{i=0}^{\infty} a_i x^i \end{equation} The equation \ref{eq:1} shows a sum that is divergent. This formula will later be used in the page \pageref{second}. For further references see \href{http://www.overleaf.com}{Something Linky} or go to the next url: \url{http://www.overleaf.com} or open the next file \href{run:./file.txt}{File.txt} It's also possible to link directly any word or \hyperlink{thesentence}{any sentence} in your document. \end{document} ``` [Open an example of the `hyperref` package in Overleaf](https://www.overleaf.com/project/new/template/19606?id=64789057\&templateName=Another+hyperref+example\&latexEngine=pdflatex\&texImage=texlive-full%3A2020.1\&mainFile=main.tex) ![HyperrefEx2OverleafVa.png](/files/mrNXOvDyoPht8CwcjCGN) ![HyperrefEx2OverleafVb.png](/files/kBnGWhETcU0OMmjprRrp) This is a complete example, it will be fully explained in the rest of the article. Below is a description of the commands related to the colour and styling of the links. **\hypersetup{ ... }** This will set the options to configure the behaviour of the links within the document. Every parameter must be comma-separated and the syntax must be in the format parameter=value. **colorlinks=true** Links will be coloured, the default colour is red. **linkcolor=blue** Internal links, those generated by cross-referenced elements, are displayed in blue. **filecolor=magenta** Links to local files will be shown in magenta colour (see linking local files). **urlcolor=cyan** Links to web sites are set to cyan colour (see linking web addresses). **urlstyle{same}** Default settings print links in mono-style spaced fonts, this command changes that and displays the links in the same style as the rest of the text. ## Linking web addresses Links to a web address or email can added to a LaTeX file using the `\url` command to display the actual link or `\href` to use a hidden link and show a word/sentence instead. ```latex For further references see \href{http://www.overleaf.com}{Something Linky} or go to the next url: \url{http://www.overleaf.com} ``` ![HyperlinkExampleUpdatedMore.png](/files/vBHiwysJolJqEaBx0n9N) There are two commands in the example that generate a link in the final document: **\href{ Linky}** There are two parameters passed to this command, the first one is the url to the link, in this case, and the second one is the clickable text to be shown, Something Linky. **\url{** This command will show the url passed as parameter and make it into a link, useful if you will print the document. [Open an example of the hyperref package in Overleaf](https://www.overleaf.com/project/new/template/19606?id=64789057\&templateName=Hyperref+Example+2\&latexEngine=pdflatex\&texImage=texlive-full%3A2020.1\&mainFile=main.tex) ## Linking local files The commands `\href` and `\url` presented in the previous section can be used to open local files ```latex For further references see \href{http://www.overleaf.com}{Something Linky} or go to the next url: \url{http://www.overleaf.com} or open the next file \href{run:./file.txt}{File.txt} ``` ![HyperlinkExampleUpdatedMoreNext.png](/files/zJz1v3RibFsf2jrRdPpa) The command `\href{run:./file.txt}{File.txt}` prints the text `File.txt` that links to a local file called `file.txt` located in the current working directory. Notice the text `run:` before the path to the file. The file path follows the conventions of UNIX systems, using `.` to refer the current directory and `..` for the previous directory. The command `\url{}` can also be used, with the same syntax described for the path, but it's reported to have some problems. [Open an example of the hyperref package in Overleaf](https://www.overleaf.com/project/new/template/19606?id=64789057\&templateName=Hyperref+Example+2\&latexEngine=pdflatex\&texImage=texlive-full%3A2020.1\&mainFile=main.tex) ## Inserting links manually It was mentioned before that all cross-referenced elements become links once **hyperref** is imported, thus we can use `\label` anywhere in the document and refer later those labels to create links. This is not the only manner to insert hyperlinks manually. ```latex It's also possible to link directly any word or \hyperlink{thesentence}{any sentence} in you document. If you read this text, you will get no information. Really? Is there no information? For instance \hypertarget{thesentence}{this sentence}. ``` ![HyperlinkExampleUpdatedMoreNextAgain.png](/files/tfWtLroPM4vURkCg1gKg) There are two commands to create user-defined links. **\hypertarget{thesentence}{this sentence}** The first parameter passed inside braces to this command is a unique identifier for this sentence. The second parameter is the text "this sentence", and will be printed normally (depending on the value of anchorcolor, see the reference guide), but when a link pointing to the identifier "thesentence" is clicked the PDF file will scroll to this point. **\hyperlink{thesentence}{any sentence}** This command prints the text "any sentence" as a clickable element that redirects to the point whose identifier is "thesentence". [Open an example of the hyperref package in Overleaf](https://www.overleaf.com/project/new/template/19606?id=64789057\&templateName=Hyperref+Example+2\&latexEngine=pdflatex\&texImage=\&mainFile=main.tex) ## PDF-specific options Links in a document are created having in mind a document that will be read in PDF format. The PDF file can be further personalized to add additional information and change the way the PDF viewer displays it. Below an example: ```latex \hypersetup{ colorlinks=true, linkcolor=blue, filecolor=magenta, urlcolor=cyan, pdftitle={Overleaf Example}, pdfpagemode=FullScreen, } ``` ![Pdftitle.png](/files/HLlwwIxKuVvJ5G1ASnOb) Using the command `\hypersetup`, described in the section [styles and colours](#styles-and-colours), accepts extra parameters to set up the final PDF file. **pdftitle={Overleaf Example}** Is the title of the PDF output file, to be displayed in the title bar of the window. In the example is "Overleaf Example". **pdfpagemode=FullScreen** The document will be opened in full screen mode by the PDF reader. See the [reference guide](#reference-guide) for a full list of options that can be passed to `\hypersetup`. [Open an example of the hyperref package in Overleaf](https://www.overleaf.com/project/new/template/19606?id=64789057\&templateName=Hyperref+Example+2\&latexEngine=pdflatex\&texImage=texlive-full%3A2020.1\&mainFile=main.tex) ## Reference guide **Linking style options** | Option | Default value | Description | | ------------- | ------------- | ---------------------------------------------------------------------------------------- | | `hyperindex` | true | Makes the page numbers of index entries into hyperlinks | | `linktocpage` | false | Makes the page numbers instead of the text to be link in the Table of contents. | | `breaklinks` | false | Allows links to be broken into multiple lines. | | `colorlinks` | false | Colours the text for links and anchors, these colours will appear in the printed version | | `linkcolor` | red | Colour for normal internal links | | `anchorcolor` | black | Colour for anchor (target) text | | `citecolor` | green | Colour for bibliographical citations | | `filecolor` | cyan | Colour for links that open local files | | `urlcolor` | magenta | Colour for linked URLs | | `frenchlinks` | false | Use small caps instead of colours for links | **PDF-specific options** | Option | Default value | Description | | ----------------- | ------------- | -------------------------------------------------------------------------------------------------------------------- | | `bookmarks` | true | Acrobat bookmarks are written, similar to the table of contents. | | `bookmarksopen` | false | Bookmarks are shown with all sub-trees expanded. | | `citebordercolor` | 0 1 0 | Colour of the box around citations in RGB format. | | `filebordercolor` | 0 .5 .5 | Colour of the box around links to files in RGB format. | | `linkbordercolor` | 1 0 0 | Colour of the box around normal links in RGB format. | | `menubordercolor` | 1 0 0 | Colour of the box around menu links in RGB format. | | `urlbordercolor` | 0 1 1 | Colour of the box around links to URLs in RGB format. | | `pdfpagemode` | empty | Determines how the file is opened. Possibilities are UseThumbs (Thumbnails), UseOutlines (Bookmarks) and FullScreen. | | `pdftitle` | | Sets the document title. | | `pdfauthor` | | Sets the document Author. | | `pdfstartpage` | 1 | Determines on which page the PDF file is opened. | ## Further reading For more information see * [Table of contents](/latex/document-structure/02-table-of-contents.md) * [Sections and chapters](/latex/document-structure/01-sections-and-chapters.md) * [Cross referencing sections and equations](/latex/document-structure/03-cross-referencing-sections-equations-and-floats.md) * [Using colours in LaTeX](/latex/formatting/13-using-colors-in-latex.md) * [Management in a large project](/latex/document-structure/07-management-in-a-large-project.md) * [Hyperref manual](http://repositorios.cpai.unb.br/ctan/macros/latex/contrib/hyperref/doc/manual.pdf) * [Hyperlinks article on wikibooks](http://en.wikibooks.org/wiki/LaTeX/Hyperlinks) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://overleaf-pro.ayaka.space/latex/document-structure/09-hyperlinks.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.