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

mirror server hosted at Truenetwork, Russian Federation.