Prev Next syntax

Specifying Command or Function Syntax

Syntax
$syntax%code1%italic1%...%codeN%italicN%$$

See Also
codep , italic

Deprecated 2015-10-11
This command has been deprecated, use the codei and icode commands in its place.

Description
Display text that alternates between code and italic font .

%
code1%italic1%...%codeN%italicN%
is a delimiter sequence and % can be any character that is not a letter. The characters in code1, ..., codeN are output in code font. The characters in italic1, ..., italicN are output in italic font.

All white space characters are preserved in the code entries. Thus new lines in code1, ..., codeN will correspond to new lines in the output.

Leading and trailing white space in the italic entries is ignored (and can be used to space the OMhelp input).

Example
The input
 
     $syntax%f(%x%) = g(%x%, %y%)%$$
produces the following output
     f(
x) = g(xy)
The input
 
     $syntax%f(%x%) =
          g(%x%, %y%)%$$
produces the following output
     f(
x) =
          g(
xy)
The input
 
     $syntax%f(%x%) = %
          %g(%x%, %y%)%$$
produces the following output
     f(
x) = g(xy)

Input File: syntax.omh