Difference between revisions of "Commands with optional arguments"

From Wiki
Jump to navigation Jump to search
(added texcode and cmd markup)
m (added links to source)
Line 1: Line 1:
< [[Inside ConTeXt]]
+
< [[Inside ConTeXt]] | [[Commands with KeyVal arguments]] >
  
 
In LaTeX you define a new command with an optional argument with "newcommand":
 
In LaTeX you define a new command with an optional argument with "newcommand":
Line 9: Line 9:
 
</texcode>
 
</texcode>
  
In ConTeXt there is perhaps a way to do the same. Otherwise, the key value method is preferred, see [[Commands with KeyVal arguments]].
+
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 <cmd>dodoubleempty</cmd> (from [http://source.contextgarden.net/tex/context/base/syst-gen.tex 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.
 
 
 
 
<i>The following is my understanding of how to do this.  It's currently untested; someone please test this and integrate it with the above.  --[[User:Brooks|Brooks]]</i>
 
 
 
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 <cmd>dodoubleempty</cmd> (from <tt>syst-gen.tex</tt>) 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.
 
  
 
<texcode>
 
<texcode>
Line 34: Line 29:
 
Note that this makes both arguments optional -- something that is much more difficult to do in LaTeX ([http://www.tex.ac.uk/cgi-bin/texfaq2html?label=twooptarg 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.
 
Note that this makes both arguments optional -- something that is much more difficult to do in LaTeX ([http://www.tex.ac.uk/cgi-bin/texfaq2html?label=twooptarg 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 <tt>[]</tt> with appropriate handling for spaces (or line breaks) between the square brackets, use <cmd>dodoublearguments</cmd> instead of <cmd>dodoubleempty</cmd>.  There are of course versions for other numbers of arguments, found by replacing <tt>double</tt> with <tt>single</tt> through <tt>seventuple</tt>; see <tt>syst-gen.tex</tt> for the exact names.
+
If you ''don't'' want any optional arguments, but still want your arguments enclosed in <tt>[]</tt> with appropriate handling for spaces (or line breaks) between the square brackets, use <cmd>dodoublearguments</cmd> instead of <cmd>dodoubleempty</cmd>.  There are of course versions for other numbers of arguments, found by replacing <tt>double</tt> with <tt>single</tt> through <tt>seventuple</tt>; see [http://source.contextgarden.net/tex/context/base/syst-gen.tex syst-gen.tex] for the exact names.
  
 
----
 
----
Line 47: Line 42:
 
----
 
----
  
<i>Can someone test to see if <cmd>dosingleempty</cmd> and <cmd>dodoubleargument</cmd> can be chained, to get two square-bracketed arguments only one of which is optional?</i>
+
<i>Can someone test to see if <cmd>dosingleempty</cmd> and <cmd>dodoubleargument</cmd> can be chained, to get two square-bracketed arguments only one of which is optional?</i> --[[User:Brooks Brooks]]

Revision as of 18:59, 6 January 2005

< Inside ConTeXt | Commands with KeyVal arguments >

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, 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? --User:Brooks Brooks