summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/keycommand/README
blob: b41e8b81b01a25a2f024dee6ff3979b40fa36156 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
% keycommand is a package providing an easy way to define commands
% with keys in LaTeX. The code is based on kvsetkeys by Heiko
% Oberdiek. It does not rely on keyval.
%
% This work consists of the main source file keycommand.dtx
% and the derived files
%    keycommand.sty, keycommand.pdf, keycommand.ins,
%    keycommand-example.tex
%
% Unpacking:
%    (a) If keycommand.ins is present:
%           etex keycommand.ins
%    (b) Without keycommand.ins:
%           etex keycommand.dtx
%    (c) If you insist on using LaTeX
%           latex \let\install=y\input{keycommand.dtx}
%        (quote the arguments according to the demands of your shell)
%
% Documentation:
%           (pdf)latex keycommand.dtx
%
% -----------------------------------------------------------------
% Typical example:
%
% \newkeycommand+[\|]\myFigure[
%            caption={\textcolor{red}{<no caption given>},
%            placement=h}][OtherKeys][1]{%
%     |\begin{figure}|[\commandkey{placement}]
%         |\includegraphics|[\commandkey{OtherKeys}]{#1}
%         |\caption|{\commandkey{caption}}}
% Usage :
%
% \myFigure[caption=small image,page=12,viewport=20 50 136 95,clip]{image.pdf}
% -----------------------------------------------------------------