hyperref

Do³±czenie pakietu umo¿liwia tworzenie dokumentów hipertekstowych za pomoc± LaTeX-a. Dokument mo¿na przetworzyæ PDFLateXem lub standardowym LaTeX-em i nastêpnie poddaæ dalszej obróbce np: dvips i Acrobat Distiller.

Je¿eli dokument jest napisany zgodnie z regu³ami sztuki, to nie s± wymagane inne zabiegi -- wszystkie odwo³ania do etykiet, bibliografii, numery stron w skorowidzu, pozycje w spisach stan± siê automatycznie odwo³aniami hipertekstowymi (lokalnymi). Oprócz tego mo¿emy umieszczaæ odwo³ania do dokumentów zewnêtrznych i definiowaæ etykiety globalne, na które mo¿na siê powo³aæ w innych dokumentach.

Odsy³acze, jak i miejsca etykietowane mog± byæ wyró¿nione kolorem lub obwódk±. Sposób oznaczania okre¶lamy za pomoc± parametrów steruj±cych (opcji). Nadawanie warto¶ci parametrom odbywa siê w nastêpuj±cy sposób:

\usepackage[opcja={warto¶æ},
opcja={warto¶æ},
...
opcja={warto¶æ}]{hyperref}

Mo¿emy równie¿ utworzyæ zbiór hyperref.cfg i umie¶ciæ w nim warto¶ci parametrów. W tym celu nale¿y utworzyæ poni¿sz± konstrukcjê:

\hypersetup{
opcja={warto¶æ}},
...
opcja={warto¶æ}}
}


Jak ³atwo siê domy¶leæ najpierw analizowany jest zbiór hyperref.cfg, a nastêpnie parametry podawane przy wywo³aniu pakietu.

Pakiet hyperref, w przypadku u¿ycia opcji colorlinks, do³±cza pakiet color (oczywi¶cie mo¿na pakiet ten do³±czyæ niezale¿nie). Do³±czany jest równie¿ pakiet url -- adresy prezentowane za pomoc± polecenia url staj± siê automatycznie po³±czeniami hipertekstowymi.

W przypadku do³±czenia pakietu xr (z pakietem hyperref dostarczana jest zmodyfikowana wersja tego pakietu) dostêpne jest polecenie \externaldocument. Ogólna postaæ wywo³ania wygl±da nastêpuj±co:

\externaldocument[prefix]{document}[URL]

gdzie:

prefix
w przypadku konfliktu etykiet w zbiorze zewnêtrznym i bie¿±cym mo¿na okre¶liæ prefix; wtedy na etykiety zewnêtrzne powo³ujemy siê jako: prefixetykieta (dokument na który siê powo³ujemy te¿ musi byæ kompilowany z do³±czonym pakietem hyperref; inna jest postaæ polecenia newlabel)
document
nazwa dokumentu zewnêtrznego -- w czasie kompilacji wczytywany jest zbiór dokument.aux, w celu pobrania definicji etykiet
URL
adres dokumentu1 (znaki specjalne (np. ~) pozostaj± nimi). Do nazwy zbioru dopisywany jest ci±g znaków zdefiniowany parametrem extension. W przypadku pominiêcia tego parametru zbiorem zewnêtrznym staje siê zbiór okre¶lony przez parametr document2

Polecenia

\Acrobatmenu{wywo³ywana funkcja}{tekst opisuj±cy}
polecenie tworzy menu które umo¿liwia wywo³anie funkcji przegl±darki; znane s± nastêpuj±ce funkcje:
kategoria nazwa funkcji
File Open, Close, Scan, Save, SaveAs, Optimizer:SaveAsOpt, Print, PageSetup, Quit
ImportImage, ImportNotes, AcroForm:ImportFDF
ExportNotes, AcroForm:ExportFDF
GeneralInfo, OpenInfo, FontsInfo, SecurityInfo, Weblink:Base, AutoIndex:DocInfo
GeneralPrefs, NotePrefs, FullScreenPrefs, Weblink:Prefs, AcroSearch:Preferences (Windows) lub AcroSearchPrefs (Mac), Cpt:Capture
Edit Undo, Cut, Copy, Paste, Clear, SelectAll, Ole:CopyFile, TouchUp:TextAttributes, TouchUp:FitTextToSelection, TouchUp:ShowLineMarkers, TouchUp:ShowCaptureSuspects, TouchUp:FindSuspect, Properties
AcroForm:Duplicate, AcroForm:TabOrder
Document Cpt:CapturePages, AcroForm:Actions, CropPages, RotatePages, InsertPages, ExtractPages, ReplacePages, DeletePages, NewBookmark, SetBookmarkDest, CreateAllThumbs, DeleteAllThumbs
View ActualSize, FitVisible, FitWidth, FitPage, ZoomTo, FullScreen, FirstPage, PrevPage, NextPage, LastPage, GoToPage, GoBack, GoForward, SinglePage, OneColumn, TwoColumns, ArticleThreads, PageOnly, ShowBookmarks, ShowThumbs
Tools Hand, ZoomIn, ZoomOut, SelectText, SelectGraphics, Note, Link, Thread, AcroForm:Tool, Acro_Movi:MoviePlayer, TouchUp:TextTool, Find, FindAgain, FindNextNote, CreateNotesFile
AcroSrch:Query, AcroSrch:Indexes, AcroSrch:Results, AcroSrch:Assist, AcroSrch:PrevDoc, AcroSrch:PrevHit, AcroSrch:NextHit, AcroSrch:NextDoc
Window ShowHideToolBar, ShowHideMenuBar, ShowHideClipboard, Cascade, TileHorizontal, TileVertical, CloseAll
Help HelpUserGuide, HelpTutorial, HelpExchange, HelpScan, HelpCapture, HelpPDFWriter, HelpDistiller, HelpSearch, HelpCatalog, HelpReader, Weblink:Home, About (Windows)
\pdfbookmark{tekst do zak³adki}{etykieta}
,,rêczne'' wstawienie pozycji do menu przegl±darki (zak³adka) (p. opcje: bookmark i bookmarksopen)
\href{URL}{tekst opisuj±cy odsy³acz}
tworzy odsy³acz do dokumentu w sieci internet (WWW)
\url{URL}
tworzy odsy³acz do dokumentu w sieci internet (WWW) (tekstem opisuj±cym jest sam adres; patrz opis pakietu url)
\hyperbaseurl{???}
-- patrz opcja baseurl
\hyperimage{URL}{tekst opisuj±cy odsy³acz}
tworzy odsy³acz do rysunku
\hypertarget{nazwa etykiety}{tekst opisu}
oznacza tekst opisu etykiet± lokaln± nazwa etykiety , na zdefiniowan± etykietê mo¿na siê powo³aæ poleceniem hyperlink; oznaczony tekst wy¶wietlany jest w kolorze okre¶lonym przez opcjê anchorlink
\hyperlink{nazwa etykiety}{obiekt opisuj±cy odsy³acz}
tworzy odsy³acz do innego miejsca (oznaczonego etykiet±; p. polecenie hypertarget) w bie¿±cym dokumencie; obiekt mo¿e byæ tekstem b±dŒ rysunkiem, np:
\hyperlink{etykieta}{\epsfig{figure=picture,height=1in}}

\hyperref{URL}{kategoria}{etykieta}{tekst opisuj±cy}
polecenie definiuje odsy³acz do innego dokumentu. Zostanie on wczytany zamiast bie¿±cego, zostanie pokazana strona zawieraj±ca etykietê o podanej nazwie i kategorii (tak naprawdê realizowane jest odwo³anie do etykiety w postaci: kategoria.etykieta (patrz hyperdef)
\hyperref{file:test2.pdf}{equation}{1}{hello}

\hyperref[lokalna etykieta]?????
powo³anie siê na odsy³acz zdefiniowany poleceniem hyperdef i nazwany etykiet± (etykieta lokalna) (nie uda³o mi siê uzyskaæ pozytywnych efektów)
\hyperdef{etykieta}{kategoria}{tekst opisuj±cy}
tekst opisuj±cy jest oznaczany etykiet±, do której mo¿na siê odwo³aæ z innego dokumentu (p. hyperref)
\hyperdef{equation}{1}{hello}

\hyperdef[lokalna etykieta]{etykieta}{kategoria}{tekst opisuj±cy}
tworzy równie¿ etykietê lokaln± na któr± mo¿na siê powo³aæ w poleceniu hyperref (nie uda³o mi siê uzyskaæ pozytywnych efektów)
\PDFOpen{????}
?????
\PDFNextPage{tekst}
tworzy odsy³acz hipertekstowy do nastêpnej strony
\PDFPreviousPage{tekst}
tworzy odsy³acz hipertekstowy do poprzedniej strony
\PDFPage{kwalifikator}{tekst}
tworzy odsy³acz hipertekstowy do strony okre¶lonej przez kwalifikator (nie znam listy mo¿liwych okre¶leñ)
\PDFPage{/Next}{nastêpna strona}

\htmlref{tekst opisuj±cy}{etykieta}
podobnie jak hyperref tyle, ¿e do dokumentu HTML (nie uda³o mi siê uzyskaæ pozytywnych efektów)
\hyperpageanchor
definicja etykiety hipertekstowej do strony bie¿±cej w postaci page.numer strony (kategoria ,,page'') numer strony jest reprezentowany w postaci liczby -- opcja plainpages (bez wzglêdu na sposób wizualizacji licznika strony) lub tak jak jest on okre¶lony przez makro thepage (tak jak wygl±da on w dokumennie)
\hyperpage{numer strony}
hiperodwo³anie siê do strony o podanym numerze (numer strony staje siê opisem odsy³acza) -- u¿ywane g³ównie w skorowidzu
\begin{NoHyper}
\end{NoHyper}
tworzy ¶rodowisko w którym nie s± tworzone hiperreferencje

Opcje g³ówne

Opcja Opis
4W³±czenie rozszerzeñ wersji 4 Acrobata??? (Acrobat 4.05 sygnalizuje b³±d przy wczytaniu dokumentu wygenerowanego przez pdflatexa)
draft wy³±cza wszystkie opcje hipertekstowe
debug daje informacje o hiperreferencjach
a4paper wyj¶ciowy format papieru (210x297 mm)
a5paper wyj¶ciowy format papieru (148x210 mm)
b5paper wyj¶ciowy format papieru (176x250 mm)
letterpaper wyj¶ciowy format papieru (8.5x11 in)
legalpaper wyj¶ciowy format papieru (8.5x14 in)
executivepaper wyj¶ciowy format papieru (7.25x10.5 in)

Opcje konfiguracyjne

Opcja (po = warto¶æ domy¶lna) Opis
raiselinks={false} dla niektórych driwerów ustawia sposób wyró¿nienia opisu odsy³acza -- kolor albo obni¿enie tekstu
breaklinks={false} w³±cza/wy³±cza mo¿liwo¶æ z³amania linii w tek¶cie opisuj±cym link (np. pozycja spisu tre¶ci)
pageanchor={true} w³±cza/wy³±cza automatyczne hiper etykietowanie stron etykiet± w postaci: page.numer strony; je¶li zostanie wy³±czona spis tre¶ci nie bêdzie realizowa³ hiperodwo³añ
plainpages={true} ustawia jak maj± byæ reprezentowane numery stron w etykietach hipertekstowych; zawsze jako liczba (bez wzglêdu na sposób wizualizacji) lub tak jak okre¶la to makro thepage
nesting={false} nie u¿ywana
hypertexnames={true} nazwami hiperodwo³añ s± nazwy LaTeXowe, a nie nazwy liczników -- bardzo elitarna opcja!!
bookmarkstype={toc} wprowadza do zbioru zak³adek listê obiektów wprowadzanych do danego zbioru (toc -- spis tre¶ci; nie uda³o mi siê osi±gn±æ pozytywnego efektu dla typów ró¿nych od toc (np: lof -- spis rysunków)
implicit={true} ????????
naturalnames={false} ????
frenchlinks={false} oprócz koloru, wyró¿nikiem hiperodwo³ania jest sk³ad z u¿yciem czcionki CapSmall ma to znaczenie wtedy, kiedy opis hiperwo³ania jest tekstem, w przypadku spisu tre¶ci zamiana na sk³ad czcionk± CapsSmall odbywa siê dopiero powy¿ej 1 poziomu (section)!?

Opcje zwi±zane z typem postprocesora przetwarzaj±cego zbiór .dvi

Opcja Program przetwarzaj±cy
pdftex pdftex'a
hyperref nic nie robi
tekstures
htex4ht htex4ht.def
dvipdf hdifpdf.def -- dla programu Lesenko
dvipdfm dla programu dvipdfm
nativepdf hdvips.def pdfmark.def -- dla dvips'a
pdfmark synonim do dvipsef
dvips dvips
hypertex xdvi, dvips (z opcj± -z) i OzTeX
dviwindo windowsowa przegl±darka Y&Y (w³±cza opcjê colorlinks)
latex2html skrypt perlowy latex2html
ps2pdf przetwarzanie Ghostscript-em
dvipsone dvipsone

Opcje zwi±zane z zakresem hiperodwo³añ

Opcja (po = warto¶æ domy¶lna) Opis
extension={???} ci±g znaków dodawany do nazwy zbioru okre¶lonego przez polecenie (zwi±zany z funkcj± pakietu xr -- znak . dodawany jest automatycznie)
hyperfigures={false} ???????? p. hyperimages
backref={false} je¿eli po ka¿dej pozycji bibliograficznej wyst±pi pusta linia to dodawana jest lista numerów sekcji (section) w których wystêpowa³o powo³anie siê tê pozycjê bibliograficzn± (opcje backref i pagebackref nie mog± byæ razem aktywne)
pagebackref{false} na koñcu ka¿dej pozycji bibliograficznej dodawana jest lista stron na których wyst±pi³o powo³anie siê na tê pozycjê (opcje backref i pagebackref nie mog± byæ razem aktywne)
linktocpage={false} odsy³aczem (polem aktywnym) w spisie staje siê numer strony, a nie tytu³
hyperindex={true} ????? w³±cza/wy³±cza realizacjê hiperodwo³añ dla pozycji skorowidza
colorlinks={false} w³±cza/wy³±cza kolorowanie odsy³aczy (je¶li true do³±czany jest pakiet color)
linkcolor={red} kolor czcionki wy¶wietlania normalnych odsy³aczy
anchorcolor={black} miejsca etykietowane s± wy¶wietlane czcionk± o tym kolorze
citecolor={green} kolor czcionki wy¶wietlania odsy³acza do bibliografii
filecolor={cyan} kolor czcionki dla odsy³acza do zbioru -- (polecenie href odwo³uj±ce siê do zbioru)
menucolor={red} kolor czcionki wy¶wietlania menu przegl±darki PDF-ów
pagecolor={red} nie zauwa¿y³em skutków dzia³ania -- wydaje siê byæ nieu¿ywana
urlcolor={magenta} kolor czcionki wy¶wietlania odsy³acza do dokumentu internetowego
bookmarks={true} jest generowany i do³±czany zbiór definiuj±cy zak³adki (je¿eli warto¶æ opcji jest false to nie jest on do³±czany mimo, ¿e ju¿ istnieje)
bookmarksopen={false} w³±cza/wy³±cza rozwijanie wszystkich poziomów zak³adek
bookmarksnumbered={false} w zak³adkach pojawi± siê równie¿ numery rozdzia³ów, a nie tylko tytu³y
bookmarksopenlevel={\maxdimen}???? okre¶la poziom rozwiniêcia zak³adek po za³adowaniu dokumentu; warto¶ci± parametru jest liczba (a nie d³ugo¶æ) okre¶laj±ca poziom i nie wiem dlaczego warto¶ci± domy¶ln± jest /maxdimen
pdfhighlight={/I} zmienia sposób stylizacji ,,przycisków'' przy ich ,,naci¶niêciu'' (/I -- inwersja, /N -- bez zmian, /O -- outline, /P -- pod¶wietlenie)
citebordercolor={0 1 0} kolor (RGB; nie mo¿e byæ u¿yta nazwa TeX-owa) ramki obejmuj±cej pozycjê cytowan± (aktywna je¶li wy³±czona jest opcja colorlinks)
filebordercolor={0 .5 .5} kolor (RGB; nie mo¿e byæ u¿yta nazwa TeX-owa) ramki obejmuj±cej opis odsy³acza do zbioru (aktywna je¶li wy³±czona jest opcja colorlinks)
linkbordercolor={1 0 0} kolor (RGB; nie mo¿e byæ u¿yta nazwa TeX-owa) ramki obejmuj±cej opis odsy³acza (aktywna je¶li wy³±czona jest opcja colorlinks)
menubordercolor={1 0 0} kolor (RGB; nie mo¿e byæ u¿yta nazwa TeX-owa) ramki obejmuj±cej opis menu definiowanego poleceniem AcrobatMenu (aktywna je¶li wy³±czona jest opcja colorlinks)
pagebordercolor={1 1 0} kolor (RGB; nie mo¿e byæ u¿yta nazwa TeX-owa) ramki opisu odsy³acza dla polecenia PDFPage (aktywna je¶li wy³±czona jest opcja colorlinks)
urlbordercolor={0 1 1} kolor (RGB; nie mo¿e byæ u¿yta nazwa TeX-owa) ramki obejmuj±cej opis odsy³acza do adresu definiowanego przez polecenie url (aktywna je¶li wy³±czona jest opcja colorlinks)
pdfborder={0 0 1} kolor ramki (RGB; nie mo¿e byæ u¿yta nazwa TeX-owa) otaczaj±cej opis odsy³acza dla poleceñ PDFNextPage, PDFPreviousPage i PDFPage (aktywna je¶li wy³±czona jest opcja colorlinks)

Opcje steruj±ce przegl±dark± pdf-ów

baseurl={???} nie zauwa¿y³em skutków dzia³ania
pdfpagemode={UseOutlines} ustawia tryb pracy przegl±darki; mo¿e przyjmowaæ nastêpuj±ce warto¶ci:
FullScreen
dokument zajmuje ca³± stronê okna przegl±darki
None
u¿ywane s± ustawienia standardowe przegl±darki
UseThumbs
pokazywane s± miniatury stron
UseOutlines
widoczne s± zak³adki
pdftitle={tytu³} tytu³ dokumentu -- pojawia siê w ,,document info'' przegl±darki PDF-ów
pdfauthor={autor} autor dokumentu -- pojawia siê w ,,document info'' przegl±darki PDF-ów
pdfsubject={opis} pojawia siê w ,,document info'' przegl±darki PDF-ów
pdfcreator={LaTeX with hyperref package}}
program za pomoc± którego zosta³ utworzony zbiór -- pojawia siê w ,,document info'' przegl±darki PDF-ów
pdfproducer={dvips + Distiller}}
program który wygenerowa³ PDF-a (mo¿e byæ inna warto¶æ; zale¿y to od u¿ytych deklaracji driverów) -- pojawia siê w ,,document info'' przegl±darki PDF-ów
pdfkeywords={s³owa kluczowe} lista s³ów kluczowych pojawia siê w ,,document info'' przegl±darki PDF-ów
pdfview={FitBH} ???
pdfstartpage={1} numer strony pocz±tkowej, pokazywanej przez przegl±darkê PDF-ów
pdfstartview={Fit} ???
pdfpagescrop={n n n n} ?????
pdfcenterwindow={False} strona dokumentu powinna byæ wycentrowana w oknie przegl±darki????
pdffitwindow={false} strona dokumentu jest skalowana tak, aby maksymalnie wype³niæ okno przegl±darki


1Wydaje mi siê, ¿e w tym miejscu mo¿e wyst±piæ jedynie nazwa zbioru lokalnego
2 Uwaga! b³±d. Standardowym rozszerzeniem jest .pdf -- dodawane jest równie¿ rozszerzenia okre¶lone przez parametr extension (domy¶lnie .pdf); tak wiêc u¿yta zostanie nazwa document.pdf.pdf
W³odzimierz Macewicz
Ostatnie zmiany: 05.05.2014.