Commands with optional arguments

From Wiki
Revision as of 11:38, 2 September 2004 by Hraban (talk | contribs) (added texcode and cmd markup)
Jump to navigation Jump to search

< Inside ConTeXt

In LaTeX you define a new command with an optional argument with "newcommand":

\newcommand{\MyCommand}[2][World]{{#2Hello #1!}}
\MyCommand{\bfseries}
\MyCommand[Hans]{\scshape}

In ConTeXt there is perhaps a way to do the same. Otherwise, the key value method is preferred, see Commands with KeyVal arguments.


The following is my understanding of how to do this. It's currently untested; someone please test this and integrate it with the above. --Brooks

In ConTeXt, the optional argument processing is handled as a two-step process. First, we write the command for the end-user as a wrapper command, which calls \dodoubleempty (from syst-gen.tex) to handle the arguments properly -- including the optional ones -- and then calls a "private" command that contains the internals of the macro. Note that this function call does not explicitly refer to the arguments at all.

\def\MyCommand{\dodoubleempty\doMyCommand}

We then create the "private" macro (\doMacroName is the traditional ConTeXt name for these), with all the arguments defined as nonoptional. Default values for the arguments need to be handled somewhat more explicitly than with LaTeX; macros such as \ifsecondargument are used to determine whether the given argument was specified, as follows:

 \def\doMyCommand[#1][#2]{#1Hello
    \ifsecondargument
       #2%
    \else
       World%
    \fi
    !}

Note that this makes both arguments optional -- something that is much more difficult to do in LaTeX (but can be done). This also means that we should reverse the order of arguments, since if the user specifies only one argument it will be treated as the first argument.

If you don't want any optional arguments, but still want your arguments enclosed in [] with appropriate handling for spaces (or line breaks) between the square brackets, use \dodoublearguments instead of \dodoubleempty. There are of course versions for other numbers of arguments, found by replacing double with single through seventuple; see syst-gen.tex for the exact names.


To define \mycommand[.1.][.2.]{.3.}, i.e., with curly braces around a non-optional third argument, you just define

\def\mycommand{\dodoubleempty\doMycommand}
\def\doMycommand[#1][#2]#3{whatever}

Can someone test to see if \dosingleempty and \dodoubleargument can be chained, to get two square-bracketed arguments only one of which is optional?