LaTeX可选参数

时间:2009-11-28 10:46:15

标签: latex optional-arguments

如何在LaTeX中使用可选参数创建命令? 类似的东西:

\newcommand{\sec}[2][]{
    \section*{#1
        \ifsecondargument
            and #2
        \fi}
    }
}

然后,我可以称之为

\sec{Hello}
%Output: Hello
\sec{Hello}{Hi}
%Output: Hello and Hi

6 个答案:

答案 0 :(得分:146)

guide的示例:

\newcommand{\example}[2][YYY]{Mandatory arg: #2;
                                 Optional arg: #1.}

This defines \example to be a command with two arguments, 
referred to as #1 and #2 in the {<definition>}--nothing new so far. 
But by adding a second optional argument to this \newcommand 
(the [YYY]) the first argument (#1) of the newly defined 
command \example is made optional with its default value being YYY.

Thus the usage of \example is either:

   \example{BBB}
which prints:
Mandatory arg: BBB; Optional arg: YYY.
or:
   \example[XXX]{AAA}
which prints:
Mandatory arg: AAA; Optional arg: XXX.

答案 1 :(得分:23)

创建“可选参数”背后的一般思想是首先定义一个中间命令,该命令向前扫描以检测令牌流中接下来要出现的字符,然后插入相关的宏来处理即将出现的参数。适当。使用通用TeX编程可能非常繁琐(尽管并不困难)。 LaTeX的\@ifnextchar对这些事情非常有用。

您问题的最佳答案是使用新的xparse包。它是LaTeX3编程套件的一部分,包含用于定义具有完全任意可选参数的命令的广泛功能。

在您的示例中,您有一个\sec宏,它可以使用一个或两个支撑参数。这将使用xparse实现,具有以下内容:

\documentclass{article}
\usepackage{xparse}
\begin{document}
\DeclareDocumentCommand\sec{ m g }{%
    {#1%
        \IfNoValueF {#2} { and #2}%
    }%
}
(\sec{Hello})
(\sec{Hello}{Hi})
\end{document}

参数{ m g }定义\sec的参数; m表示“强制参数”,g表示“可选的支撑参数”。然后可以使用\IfNoValue(T)(F)来检查第二个参数是否确实存在。请参阅文档以了解允许的其他类型的可选参数。

答案 2 :(得分:22)

以上所有内容都表明它可以在LaTeX中制作一个漂亮,灵活(或禁止重载)的功能! (TeX代码对我来说似乎是希腊语)

好吧,只是为了添加我最近的(尽管不是那么灵活)开发,这是我最近在论文doc中使用的内容,

\usepackage{ifthen}  % provides conditonals...

启动命令,默认情况下将“optional”命令设置为空白:

\newcommand {\figHoriz} [4] []  {

然后我将宏设置为临时变量\ temp {},具体取决于可选参数是否为空。这可以扩展到任何传递的参数。

\ifthenelse { \equal {#1} {} }  %if short caption not specified, use long caption (no slant)
    { \def\temp {\caption[#4]{\textsl{#4}}} }   % if #1 == blank
    { \def\temp {\caption[#1]{\textsl{#4}}} }   % else (not blank)

然后我使用\ temp {}变量为这两种情况运行宏。 (如果没有用户指定,它只是将短标题设置为等于长标题。)

\begin{figure}[!]
    \begin{center}
        \includegraphics[width=350 pt]{#3}
        \temp   %see above for caption etc.
        \label{#2}
    \end{center}
\end{figure}
}

在这种情况下,我只检查\ newcommand {}提供的单个“可选”参数。如果你要为3个“可选”的args设置它,你仍然需要发送3个空白的args ......例如。

\MyCommand {first arg} {} {} {}

这是非常愚蠢的,我知道,但这就是我要和LaTeX一起使用 - 一旦我开始查看TeX代码就没那么敏感......我确实喜欢Robertson先生的xparse方法,也许我会尝试一下......

答案 3 :(得分:13)

您只需要以下内容:

\makeatletter
\def\sec#1{\def\tempa{#1}\futurelet\next\sec@i}% Save first argument
\def\sec@i{\ifx\next\bgroup\expandafter\sec@ii\else\expandafter\sec@end\fi}%Check brace
\def\sec@ii#1{\section*{\tempa\ and #1}}%Two args
\def\sec@end{\section*{\tempa}}%Single args
\makeatother

\sec{Hello}
%Output: Hello
\sec{Hello}{Hi}
%Output: Hello and Hi

答案 4 :(得分:4)

我有一个类似的问题,当我想创建一个命令\dx时,缩写\;\mathrm{d}x(即在积分的微分之前放一个额外的空格并且有&#34; d& #34;也是直立的)。但是我还想让它足够灵活,将整合变量作为可选参数包含在内。我在序言中加入了以下代码。

\usepackage{ifthen}

\newcommand{\dx}[1][]{%
   \ifthenelse{ \equal{#1}{} }
      {\ensuremath{\;\mathrm{d}x}}
      {\ensuremath{\;\mathrm{d}#1}}
}

然后

\begin{document}
   $$\int x\dx$$
   $$\int t\dx[t]$$
\end{document}

给出\dx with optional argument

答案 5 :(得分:-1)

这是我的尝试,但它并不完全符合您的规格。没有经过充分测试,所以要小心。

\newcount\seccount

\def\sec{%
    \seccount0%
    \let\go\secnext\go
}

\def\secnext#1{%
    \def\last{#1}%
    \futurelet\next\secparse
}

\def\secparse{%
    \ifx\next\bgroup
        \let\go\secparseii
    \else
        \let\go\seclast
    \fi
    \go
}

\def\secparseii#1{%
    \ifnum\seccount>0, \fi
    \advance\seccount1\relax
    \last
    \def\last{#1}%
    \futurelet\next\secparse
}

\def\seclast{\ifnum\seccount>0{} and \fi\last}%

\sec{a}{b}{c}{d}{e}
% outputs "a, b, c, d and e"

\sec{a}
% outputs "a"

\sec{a}{b}
% outputs "a and b"