Text.LaTeX.Packages.Hyperref

Hyperref package

hyperref :: PackageName

The hyperref package.

usepackage [] hyperref

Hyperref commands

data HRefOption

Constructors

PDFRemoteStartView

PDFNewWindow

HRefPage Int

Instances

Show HRefOption

Defined in Text.LaTeX.Packages.Hyperref

Methods

showsPrec :: Int -> HRefOption -> ShowS

show :: HRefOption -> String

showList :: [HRefOption] -> ShowS

Render HRefOption

Defined in Text.LaTeX.Packages.Hyperref

Methods

render :: HRefOption -> Text

data URL

Instances

Show URL

Defined in Text.LaTeX.Packages.Hyperref

Methods

showsPrec :: Int -> URL -> ShowS

show :: URL -> String

showList :: [URL] -> ShowS

IsString URL

fromString = createURL.

Defined in Text.LaTeX.Packages.Hyperref

Methods

fromString :: String -> URL

Render URL

Defined in Text.LaTeX.Packages.Hyperref

Methods

render :: URL -> Text

createURL :: String -> URL

href :: LaTeXC l => [HRefOption] -> URL -> l -> l

Reference to an URL.

url :: LaTeXC l => URL -> l

Write an URL hyperlinked.

nolinkurl :: LaTeXC l => URL -> l

Write an URL without creating a hyperlink.

hyperbaseurl :: LaTeXC l => URL -> l

Establish a base URL.

hyperimage :: LaTeXC l => URL -> l -> l

hyperimage imgURL t: The link to the image referenced by the imgURL is inserted, using t as the anchor.

autoref :: LaTeXC l => Label -> l

This is a replacement for the usual ref command that places a contextual label in front of the reference.

nameref :: LaTeXC l => Label -> l

Similar to autoref, but inserts text corresponding to the section name. Note that this command comes from the nameref package, but it's automatically included when importing hyperref.

Package options

pdftex :: LaTeXC l => l

This package option selects the pdfTeX backend for the Hyperref package.

pdftitle :: LaTeXC l => l -> l

This package option sets the document information Title field.

pdfauthor :: LaTeXC l => l -> l

This package option sets the document information Author field.

pdfsubject :: LaTeXC l => l -> l

This package option sets the document information Subject field.

pdfcreator :: LaTeXC l => l -> l

This package option sets the document information Creator field.

pdfproducer :: LaTeXC l => l -> l

This package option sets the document information Producer field.

pdfkeywords :: LaTeXC l => l -> l

This package option sets the document information Keywords field.

pdftrapped :: LaTeXC l => Maybe Bool -> l

This package option sets the document information Trapped entry. An Nothing value means, the entry is not set.

pdfstartpage :: LaTeXC l => l -> l

This package option determines on which page the PDF file is opened.

pdfpagelayout :: LaTeXC l => PdfPageLayout -> l

This package option sets the layout of PDF pages.

data PdfPageLayout

Specification for how pages of a PDF should be displayed.

Constructors

SinglePage

Displays a single page; advancing flips the page.

OneColumn

Displays a single page; advancing flips the page.

TwoColumnLeft

Displays the document in two columns, odd-numbered pages to the left.

TwoColumnRight

Displays the document in two columns, odd-numbered pages to the right.

TwoPageLeft

Displays two pages, odd-numbered pages to the left (since PDF 1.5).

TwoPageRight

Displays two pages, odd-numbered pages to the right (since PDF 1.5).

Instances

Eq PdfPageLayout

Defined in Text.LaTeX.Packages.Hyperref

Methods

(==) :: PdfPageLayout -> PdfPageLayout -> Bool

(/=) :: PdfPageLayout -> PdfPageLayout -> Bool

Ord PdfPageLayout

Defined in Text.LaTeX.Packages.Hyperref

Methods

compare :: PdfPageLayout -> PdfPageLayout -> Ordering

(<) :: PdfPageLayout -> PdfPageLayout -> Bool

(<=) :: PdfPageLayout -> PdfPageLayout -> Bool

(>) :: PdfPageLayout -> PdfPageLayout -> Bool

(>=) :: PdfPageLayout -> PdfPageLayout -> Bool

max :: PdfPageLayout -> PdfPageLayout -> PdfPageLayout

min :: PdfPageLayout -> PdfPageLayout -> PdfPageLayout

Read PdfPageLayout

Defined in Text.LaTeX.Packages.Hyperref

Methods

readsPrec :: Int -> ReadS PdfPageLayout

readList :: ReadS [PdfPageLayout]

readPrec :: ReadPrec PdfPageLayout

readListPrec :: ReadPrec [PdfPageLayout]

Show PdfPageLayout

Defined in Text.LaTeX.Packages.Hyperref

Methods

showsPrec :: Int -> PdfPageLayout -> ShowS

show :: PdfPageLayout -> String

showList :: [PdfPageLayout] -> ShowS