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.