summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/keycommand/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/keycommand/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/keycommand/README')
-rw-r--r--macros/latex/contrib/keycommand/README37
1 files changed, 37 insertions, 0 deletions
diff --git a/macros/latex/contrib/keycommand/README b/macros/latex/contrib/keycommand/README
new file mode 100644
index 0000000000..b41e8b81b0
--- /dev/null
+++ b/macros/latex/contrib/keycommand/README
@@ -0,0 +1,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}
+% -----------------------------------------------------------------
+
+
+