Difference between revisions of "Command/define"

From Wiki
Jump to navigation Jump to search
 
(19 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
|attributes=
 
|attributes=
 
}}
 
}}
 +
 +
== [[Help:Reference|Syntax]] (autogenerated) ==
 +
<syntax>define</syntax>
  
 
== [[Help:Reference|Syntax]] ==
 
== [[Help:Reference|Syntax]] ==
Line 15: Line 18:
 
   <tr valign="top" class="third">
 
   <tr valign="top" class="third">
 
     <td class="cmd">{...}</td>
 
     <td class="cmd">{...}</td>
     <td><i>text</i> </td>
+
     <td>''macro contents''</td>
 
   </tr>
 
   </tr>
 
</table>
 
</table>
Line 21: Line 24:
  
 
== Description ==  
 
== Description ==  
<code>\define</code> is like the TeX primitive <code>\def</code>: it defines a new TeX macro.
 
 
=== define vs def ===
 
Unlike <code>\def</code>, it will '''not allow you to redefine''' an already defined command.
 
  
The optional (bracketed) argument denotes the number of parameters you can give  
+
* In MkII, {{cmd|define}} is like the TeX primitive {{tex|def}}: it defines a new TeX macro.
to your command. "text" is the result when the macro gets expanded.  
+
* In MkIV {{cmd|define}} is like {{tex|unexpanded}}{{tex|def}}
 +
: and \defineexpandable is like {{tex|def}}.
 +
The optional bracketed argument denotes the number of parameters you can give  
 +
to your command. ''macro contents'' is the result when the macro gets expanded.  
  
== pitfalls ==
+
== Pitfalls ==
<code>\define</code> does not use <code>\long</code>, that means in MkII
+
<code>\define</code> does not use {{tex|long}}; that means that in MkII
multiple paragraphs (e.g. through <code>\par</code> or <code>\endgraf</code>)
+
multiple paragraphs (e.g. through {{tex|par}} or <tt>\endgraf</tt>)
 
inside arguments will not work.
 
inside arguments will not work.
  
 
The name of the new command may not include numbers.
 
The name of the new command may not include numbers.
  
 +
== Example ==
  
 +
<context mode=mkiv source="yes">
 +
% wiki mode=mkiv
  
== Example ==
+
\define\hello{Good morning}
 
 
<context source="yes">
 
\define[1]\hello{Good morning, #1!}
 
  
 
% You may not use numbers
 
% You may not use numbers
% \define[1]\mp3{The ID3 Tag of the MP3 file is, #1!}
+
% \define[1]\mp3{The ID3 Tag of the MP3 file is: #1}
 
% but this will work:
 
% but this will work:
\define[1]\mpThree{The ID3 Tag of the MP3 file is, #1!}
+
\define[1]\mpThree{The ID3 Tag of the MP3 file is: #1}
  
% You may not use umlauts in mkii, but in mkiv  
+
% You can use non-ASCII characters in MkIV, but not in MkII.
% \define[1]\KüFst{Küstenfunkstelle, #1!}
+
% This example is compiled using mkiv.
 +
\define[1]\KüFst{Küstenfunkstelle, #1!}
  
 
\starttext
 
\starttext
\hello{mom}
+
\hello
 +
 
 +
\KüFst{12}
 +
 
 
\stoptext
 
\stoptext
 
</context>
 
</context>
  
 
== See also ==
 
== See also ==
[http://en.wikibooks.org/wiki/TeX/def http://en.wikibooks.org/wiki/TeX/def]
+
* {{tex|def}}
  
<!-- something like [[cmd:goto|\goto]] -->
+
== Help from ConTeXt-Mailinglist/Forum ==
 +
All issues with:
 +
{{Forum|{{SUBPAGENAME}}}}
  
[[Category:Reference/en|define]]
+
[[Category:Command/Internals|define]]

Latest revision as of 16:22, 11 November 2019

\define

Syntax (autogenerated)

\define[...]\command{...}
[...]number
\commandcsname
{...}content


Syntax

\define[...]\command{...}
[...] number
{...} macro contents


Description

and \defineexpandable is like \def.

The optional bracketed argument denotes the number of parameters you can give to your command. macro contents is the result when the macro gets expanded.

Pitfalls

\define does not use \long; that means that in MkII multiple paragraphs (e.g. through \par or \endgraf) inside arguments will not work.

The name of the new command may not include numbers.

Example

% wiki mode=mkiv

\define\hello{Good morning}

% You may not use numbers
% \define[1]\mp3{The ID3 Tag of the MP3 file is: #1}
% but this will work:
\define[1]\mpThree{The ID3 Tag of the MP3 file is: #1}

% You can use non-ASCII characters in MkIV, but not in MkII.
% This example is compiled using mkiv.
\define[1]\KüFst{Küstenfunkstelle, #1!}

\starttext
\hello

\KüFst{12}

\stoptext

See also

Help from ConTeXt-Mailinglist/Forum

All issues with: