File indexing completed on 2024-11-24 04:34:43
0001 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 0002 <html> 0003 <!-- This document is an unofficial reference manual for LaTeX, a 0004 document preparation system, version of November 2018. 0005 0006 This manual was originally translated from LATEX.HLP v1.0a in the 0007 VMS Help Library. The pre-translation version was written by 0008 George D. Greenwade of Sam Houston State University. The 0009 LaTeX 2.09 version was written by Stephen Gilmore. The 0010 LaTeX2e version was adapted from this by Torsten Martinsen. Karl 0011 Berry made further updates and additions, and gratefully acknowledges 0012 using Hypertext Help with LaTeX, by Sheldon Green, and 0013 LaTeX Command Summary (for LaTeX 2.09) by 0014 L. Botway and C. Biemesderfer (published by the TeX Users 0015 Group as TeXniques number 10), as reference material. We also 0016 gratefully acknowledge additional material appearing in 0017 latex2e-reference by Martin Herbert Dietze. (From these references no 0018 text was directly copied.) 0019 0020 Copyright 2007, 2008, 2009, 2010, 2011, 2012, 2013, 0021 2014, 2015, 2016, 2017, 2018 Karl Berry. 0022 0023 Copyright 1988, 1994, 2007 Stephen Gilmore. 0024 0025 Copyright 1994, 1995, 1996 Torsten Martinsen. 0026 0027 Permission is granted to make and distribute verbatim copies of 0028 this manual provided the copyright notice and this permission notice 0029 are preserved on all copies. 0030 0031 0032 Permission is granted to copy and distribute modified versions of this 0033 manual under the conditions for verbatim copying, provided that the entire 0034 resulting derived work is distributed under the terms of a permission 0035 notice identical to this one. 0036 0037 Permission is granted to copy and distribute translations of this manual 0038 into another language, under the above conditions for modified versions. --> 0039 <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ --> 0040 <head> 0041 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 0042 <title>\DeclareTextCommand & \ProvideTextCommand (LaTeX2e unofficial reference manual (November 2018))</title> 0043 0044 <meta name="description" content="\DeclareTextCommand & \ProvideTextCommand (LaTeX2e unofficial reference manual (November 2018))"> 0045 <meta name="keywords" content="\DeclareTextCommand & \ProvideTextCommand (LaTeX2e unofficial reference manual (November 2018))"> 0046 <meta name="resource-type" content="document"> 0047 <meta name="distribution" content="global"> 0048 <meta name="Generator" content="makeinfo"> 0049 <link href="index.html#Top" rel="start" title="Top"> 0050 <link href="IndexDocument.html#Index" rel="index" title="Index"> 0051 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> 0052 <link href="fontenc-package.html#fontenc-package" rel="up" title="fontenc package"> 0053 <link href="_005cDeclareTextCommandDefault-_0026-_005cProvideTextCommandDefault.html#g_t_005cDeclareTextCommandDefault-_0026-_005cProvideTextCommandDefault" rel="next" title="\DeclareTextCommandDefault & \ProvideTextCommandDefault"> 0054 <link href="_005cDeclareTextAccentDefault.html#g_t_005cDeclareTextAccentDefault" rel="prev" title="\DeclareTextAccentDefault"> 0055 <style type="text/css"> 0056 <!-- 0057 /* $Id: latex2e.css 690 2018-09-15 15:20:19Z jimhefferon $ 0058 Minor css for latexrefman. Public domain. 0059 Originally written by Jim Hefferon and Karl Berry, 2018. */ 0060 0061 /* So you can style for yourself */ 0062 @import url("/css/latexreflocal.css"); 0063 0064 0065 0066 a.summary-letter {text-decoration: none} 0067 blockquote.indentedblock {margin-right: 0em} 0068 blockquote.smallindentedblock {margin-right: 0em; font-size: smaller} 0069 blockquote.smallquotation {font-size: smaller} 0070 div.display {margin-left: 3.2em} 0071 div.example {margin-left: 3.2em} 0072 div.lisp {margin-left: 3.2em} 0073 div.smalldisplay {margin-left: 3.2em} 0074 div.smallexample {margin-left: 3.2em} 0075 div.smalllisp {margin-left: 3.2em} 0076 kbd {font-style: oblique} 0077 pre.display {font-family: inherit} 0078 pre.format {font-family: inherit} 0079 pre.menu-comment {font-family: serif} 0080 pre.menu-preformatted {font-family: serif} 0081 pre.smalldisplay {font-family: inherit; font-size: smaller} 0082 pre.smallexample {font-size: smaller} 0083 pre.smallformat {font-family: inherit; font-size: smaller} 0084 pre.smalllisp {font-size: smaller} 0085 span.nolinebreak {white-space: nowrap} 0086 span.roman {font-family: initial; font-weight: normal} 0087 span.sansserif {font-family: sans-serif; font-weight: normal} 0088 ul.no-bullet {list-style: none} 0089 BODY { 0090 margin-top: 1em; 0091 margin-left: 1em; /* auto results in two-digit <ol> lost off left */ 0092 margin-right: 1em; 0093 margin-bottom: 1em; 0094 /* the idea is to use the whole window, unless it is ridiculously 0095 wide, probably with too-small fonts, too. */ 0096 max-width: 64em; 0097 } 0098 0099 /* Because we want @math{... @code ...} to be upright, not slanted, 0100 and Texinfo won't fix it. */ 0101 code {font-style:normal; font-family:monospace; } 0102 0103 /* We put a link to our own home page at the bottom. */ 0104 div.referenceinfo {font-size:small;} 0105 0106 --> 0107 </style> 0108 0109 0110 </head> 0111 0112 <body lang="en"> 0113 <a name="g_t_005cDeclareTextCommand-_0026-_005cProvideTextCommand"></a> 0114 <div class="header"> 0115 <p> 0116 Next: <a href="_005cDeclareTextCommandDefault-_0026-_005cProvideTextCommandDefault.html#g_t_005cDeclareTextCommandDefault-_0026-_005cProvideTextCommandDefault" accesskey="n" rel="next">\DeclareTextCommandDefault & \ProvideTextCommandDefault</a>, Previous: <a href="_005cDeclareTextAccentDefault.html#g_t_005cDeclareTextAccentDefault" accesskey="p" rel="prev">\DeclareTextAccentDefault</a>, Up: <a href="fontenc-package.html#fontenc-package" accesskey="u" rel="up">fontenc package</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="IndexDocument.html#Index" title="Index" rel="index">Index</a>]</p> 0117 </div> 0118 <hr> 0119 <a name="g_t_005cDeclareTextCommand-_0026-_005cProvideTextCommand-1"></a> 0120 <h4 class="subsection">4.1.4 <code>\DeclareTextCommand</code> & <code>\ProvideTextCommand</code></h4> 0121 0122 <a name="index-Font-encoding-4"></a> 0123 <a name="index-_005cDeclareTextCommand"></a> 0124 <a name="index-_005cDeclareTextCommandDefault"></a> 0125 <a name="index-_005cProvideTextCommand"></a> 0126 0127 <p>Synopsis, one of: 0128 </p> 0129 <div class="example"> 0130 <pre class="example">\DeclareTextCommand{<var>cmd</var>}{<var>encoding</var>}{<var>defn</var>} 0131 \DeclareTextCommand{<var>cmd</var>}{<var>encoding</var>}[<var>nargs</var>]{<var>defn}</var> 0132 \DeclareTextCommand{<var>cmd</var>}{<var>encoding</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} 0133 </pre></div> 0134 0135 <p>or one of: 0136 </p> 0137 <div class="example"> 0138 <pre class="example">\ProvideTextCommand{<var>cmd</var>}{<var>encoding</var>}{<var>defn</var>} 0139 \ProvideTextCommand{<var>cmd</var>}{<var>encoding</var>}[<var>nargs</var>]{<var>defn</var>} 0140 \ProvideTextCommand{<var>cmd</var>}{<var>encoding</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} 0141 </pre></div> 0142 0143 <p>Define the command <var>cmd</var>, which will be specific to one encoding. 0144 The command name <var>cmd</var> must begin with a backslash, \. These 0145 commands can only appear in the preamble. Redefining <code>cmd</code> does 0146 not cause an error. The defined command will be robust even if the code 0147 in <var>defn</var> is fragile (see <a href="_005cprotect.html#g_t_005cprotect">\protect</a>). 0148 </p> 0149 <p>For example, the file <samp>t1enc.def</samp> contains this line. 0150 </p> 0151 <div class="example"> 0152 <pre class="example">\DeclareTextCommand{\textperthousand}{T1}{\%\char 24 } 0153 </pre></div> 0154 0155 <p>With that, you can express parts per thousand. 0156 </p> 0157 <div class="example"> 0158 <pre class="example">\usepackage[T1]{fontenc} % in preamble 0159 ... 0160 Legal limit is \( 0.8 \)\textperthousand. 0161 </pre></div> 0162 0163 <p>If you change the font encoding to <code>OT1</code> then you get an error like 0164 ‘<samp>LaTeX Error: Command \textperthousand unavailable in encoding 0165 OT1</samp>’. 0166 </p> 0167 <p>The <code>\ProvideTextCommand</code> variant does the same, except that it 0168 does nothing if <var>cmd</var> is already defined. The 0169 <code>\DeclareTextSymbol</code> command is faster than this one for simple 0170 slot-to-glyph association (see <a href="_005cDeclareTextSymbol.html#g_t_005cDeclareTextSymbol">\DeclareTextSymbol</a>) 0171 </p> 0172 <p>The optional <var>nargs</var> and <var>optargsdefault</var> arguments play the 0173 same role here as in <code>\newcommand</code> (see <a href="_005cnewcommand-_0026-_005crenewcommand.html#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a>). Briefly, <var>nargs</var> is an integer from 0 to 9 0174 specifying the number of arguments that the defined command <code>cmd</code> 0175 takes. This number includes any optional argument. Omitting this 0176 argument is the same as specifying 0, meaning that <var>cmd</var> will have 0177 no arguments. And, if <var>optargsdefault</var> is present then the first 0178 argument of <code>\<var>cmd</var></code> is optional, with default value 0179 <var>optargdefault</var> (which may be the empty string). If 0180 <var>optargsdefault</var> is not present then <code>\<var>cmd</var></code> does not take 0181 an optional argument. 0182 </p> 0183 0184 0185 0186 <hr/><div class='referenceinfo'> <a href='https://latexref.xyz/'> <i>Unofficial LaTeX2e reference manual</i></a></div> 0187 </body> 0188 </html>