298 |
The concise descriptions of macros in this documentation typically |
The concise descriptions of macros in this documentation typically |
299 |
look like this: |
look like this: |
300 |
<blockquote> |
<blockquote> |
301 |
Macro: <strong>NAME</strong> <nobr>arguments<wbr> |
Macro: <strong>NAME</strong> <nobr>arguments</nobr> |
302 |
</blockquote> |
</blockquote> |
303 |
<nobr>arguments<wbr> lists the macro's arguments using conventions that |
<var>arguments</var> lists the macro's arguments using conventions that |
304 |
should be familiar to anyone who has ever read a manpage. Briefly: |
should be familiar to anyone who has ever read a manpage. Briefly: |
305 |
<p> |
<p> |
306 |
<ol> |
<ol> |
329 |
Since these macros toggle things on and off, the argument list |
Since these macros toggle things on and off, the argument list |
330 |
simply reads |
simply reads |
331 |
<blockquote> |
<blockquote> |
332 |
<nobr>toggle<wbr> |
<nobr>toggle</nobr> |
333 |
</blockquote> |
</blockquote> |
334 |
<br> |
<br> |
335 |
<hr> |
<hr> |
336 |
|
|
337 |
<h3>Example 1: an argument requiring double-quotes</h3> |
<h3>Example 1: an argument requiring double-quotes</h3> |
338 |
<blockquote> |
<blockquote> |
339 |
Macro: <strong>TITLE</strong> <nobr>"<title of document>"<wbr> |
Macro: <strong>TITLE</strong> <nobr>"<title of document>"</nobr> |
340 |
</blockquote> |
</blockquote> |
341 |
<p> |
<p> |
342 |
The required argument to <strong>TITLE</strong> is the title of your |
The required argument to <strong>TITLE</strong> is the title of your |
349 |
|
|
350 |
<h3>Example 2: a macro with required and optional arguments</h3> |
<h3>Example 2: a macro with required and optional arguments</h3> |
351 |
<blockquote> |
<blockquote> |
352 |
Macro: <strong>TAB_SET</strong> <nobr><tab #> <indent> <length> [ L | R | C | J [ QUAD ] ]<wbr> |
Macro: <strong>TAB_SET</strong> <nobr><tab #> <indent> <length> [ L | R | C | J [ QUAD ] ]</nobr> |
353 |
</blockquote> |
</blockquote> |
354 |
<p> |
<p> |
355 |
The first required argument is a number that identifies the tab (say, |
The first required argument is a number that identifies the tab (say, |
377 |
<a name="TOGGLE_EXAMPLE"></a> |
<a name="TOGGLE_EXAMPLE"></a> |
378 |
<h3>Example 3: a sample toggle macro:</h3> |
<h3>Example 3: a sample toggle macro:</h3> |
379 |
<blockquote> |
<blockquote> |
380 |
Macro: <strong>QUOTE</strong> <nobr>toggle<wbr> |
Macro: <strong>QUOTE</strong> <nobr>toggle</nobr> |
381 |
</blockquote> |
</blockquote> |
382 |
<p> |
<p> |
383 |
<strong>QUOTE</strong> begins a section of quoted text in a document |
<strong>QUOTE</strong> begins a section of quoted text in a document |