caption

Pakiet (v.3.0 -- znacznie zmodyfikowany) zmienia definicje standardowego polecenia \caption tworzďż˝cego opisy obiektďż˝w ruchomych (standardowo: figure i table). Zdefiniowano polecenia pozwalajďż˝ce na tworzenie wzorcďż˝w lub bezpoďż˝rednie ksztaďż˝towanie podpisďż˝w. Za jego pomocďż˝ moďż˝emy zdefiniowaďż˝ sposďż˝b opisu nowych obiektďż˝w tworzonych za poleceniami pakietu float, wspďż˝pracuje rďż˝wnieďż˝ z pakietami subfig (ktďż˝ry jest swego rodzaju nakďż˝adkďż˝) i~starszym od niego subfigure.

Opis polecenia \caption

Polecenie s�u�y do tworzenia podpis�w pod obiektami ruchomymi (a tak�e �rodowiska longtable), mo�a je wywo�a� na kilka sposob�w:
\caption{opis}
posta� najcz�ciej spotykana; tekst opisu jest identyczny w spisie (o ile taki jest tworzony) i w obiekcie, podpis jest opatrzony etykiet� (o ile nie zadysponowano inaczej)

\caption[wersja opisu do spisu obiekt�w]{opis}
posta� u�ywana je�li opis w spisie objekt�w ma by� inny ni� w obiekcie; podpis jest opatrzony etykiet� (o ile nie zadysponowano inaczej)

\caption*{opis}
opis nie jest wstawiany do spisu obiekt�w i nie jest opatrywany etykiet�

\caption[]{opis}
opis nie jest wstawiany do spisu obiekt�w, ale jest on opatrywany etykiet�

\caption*[]{opis}
opis nie jest wstawiany do spisu obiekt�w i nie jest opatrywany etykiet�

Polecenie \caption zawsze inkrementuje licznik obiekt�w.

Zdefiniowano te� polecenie \captionof s�uz�ce do sformatowania tekstu, analogicznie jak obiekt ruchomy:
\captionof{typ obiektu}{tekst opisu}
\captionof{typ obiektu}[tekst do spisu]{tekst opisu}
\captionof{typ obiektu}[]{tekst opisu}
\captionof{typ obiektu}*[]{tekst opisu}
\captionof{typ obiektu}*{tekst opisu}
gdzie typ obiektu jest zdefiniowanym obiektem ruchomym -- polecenie inkrementuje licznik skojarzony z tym typem (patrz teďż˝ pakiet capt-of).

Dodatkowo zdefiniowano polecenie \ContinuedFloat, kt�re powoduje �e nie jest inkrementowany licznik obiekt�w (powinno ono by� u�yte przed poleceniem \caption). Wszystkie inne aspekty formatowania i etykietowania s� zachowane.

Formatowanie opisu

W nowej wersji pakietu unowocze�niono spos�b okre�lania parametr�w sk�adu podpis�w z modyfikacji kodu na parametryczny (dla kompatybilno�ci pozostawiono r�wnie� stary spos�b). Parametrom mo�na nadawa� warto�ci w dwu momentach: przy poleceniu �adowania pakiet�w np.:

\usepackage[margin=10pt, font={small,it}, labelfont=bf]{caption}

\usepackage{caption}
\captionsetup{margin=10pt, font={small,it}, labelfont=bf}

Wartoďż˝ciďż˝ parametru moďż˝e byďż˝ pojedyncza warto�� lub lista wartoďż˝ci (ujďż˝ta w nawiasy {}, wartoďż˝ci oddzielone przecinkiem, w przypadku wartoďż˝ci bďż˝dďż˝cych w sprzecznoďż˝ci brana jest warto�� ostatnia na liďż˝cie) -- w przypadku parametru w ktďż˝rym nie przewidziano wartoďż˝ci (warto�� logiczna) nie jest sprawdzana poprawno��, a w pozostaďż˝ych przypadkach warto�� jest sprawdzana dopiero w momencie uďż˝ycia polecenia \caption.

Parametry, kt�rym mo�na nada� warto�� tylko przy wywo�aniu pakietu

Poni�sze parametry mog� przyjmowa� warto�ci logiczne on lub off i deklaruj� wsp�dzia�anie (lub nie) z dodatkowymi pakietami. Powinny one by� za�adowane przed pakietem caption. Ustawienie warto�ci na off mo�e spowodowa�, �e definicja makroinstrukcji \caption nie zostanie redefiniowana (mechanizmy pakietu caption nie zadzia�aj�).

Parametr	Opis
float	wsp�praca z pakietem float
longtable	wsp�praca z pakietem longtable
rotating	wsp�praca z pakietem rotating
sidecap	wsp�praca z pakietem sidecap
supertabular	wsp�praca z pakietem supertabular

Pozosta�e parametry

\DeclareCaptionFormat{default}{#1#2#3\par}

\DeclareCaptionLabelFormat{simple}{\bothIfFirst{#1}{\nobreakspace}#2}

\DeclareCaptionLabelSeparator{default}{: }

\DeclareCaptionJustification{centering}{\centering}

\DeclareCaptionStyle{default}[justification=centering]{}

Zosta�y r�wnie� zdefiniowane polecenia \clearcaptionsetup{typ obiektu}, s�u��ce do przywr�cenia domy�lnych warto�ci i \showcaptionsetup{typ obiektu}, s�u��ce do wy�wietlenia (w zbiorze *.log) warto�ci ustawianych poleceniem \captionsetup.

Parametry i polecenia pozostawione dla kompatybilno�ci� z poprzenimi wersjami

Poni�ej wymienione polecenia odnios� skutek, je�li nie b�d� u�ywane ich nowozdefiniowane odpowiedniki.

Polecenie	opis
\captionsize	Okre�la wielko�� czcionki, u�ywanej do sk�adu podpisu; np: \renewcommand{\captionsize}{\scriptsize}
\captionlabelfont	okre�la rodzaj czcionki; mo�na u�ywa� wszystkich polece� zmiany atrybut�w przyj�tych w LaTeX2e; np: \renewcommand{\captionlabelfont}{\bfseries}
\captionmargin	okre�la wielko�� lewego i prawego marginesu w tek�cie opisu; np: \setlength{\captionmargin}{2cm}

Poni�sze parametry mog� by� u�ywane wy��cznie przy wywo�aniu pakietu caption.

Parametr	opis
normal	Je�li podpis sk�ada si� z jodnej linii to jest centrowany w przeciwnym wypadku, sk�adany jest w pude�ko o pe�nej szeroko�ci (bez wyr�niania nazwy obiektu) -- jest to domy�lny spos�b sk�adu.
hang
isu	podpis sk�adany jest tak jak �rodowisko description; kolejne linie s� ,,wci�te'' na szeroko�� nazwy obiektu
center	tekst opisu jest centrowany
centerlast	ostatnia linia opisu jest centrowana
anne
Ustalenie standardowej wielko�ci czcionki1
scriptsize	czcionka scriptsize
footnotesize	czcionka footnotesize
small	czcionka small
normalsize	czcionka normalsize
large	czcionka large
Large	czcionka Large
Ustalenie atrybut�w czcionki
up	upshape
it	itshape
sl	slshape
sc	scshape
md	mdseries
bf	bfseries
rm	rmfamily
sf	sffamily
tt	ttfamily
ruled	je�li u�ywany jest pakiet float (patrz. float) i u�yte by�o polecenie \floatstyle{ruled} to opcja ruled spowoduje �e nazwa obiektu b�dzie sk�adana czcionk� okre�lon� w opcji lub poleceniem \captionlabelfont, a nie tak� jaka wynika z definicji pakietu float

Pakiet jest dost�pny pod adresem:
ftp://ftp.gust.org.pl/TeX/macros/latex/contrib/caption/caption.tar