XMM-Newton Science Analysis System


hello (hello-1.17.2) [xmmsas_20070308_1802-6.6.0]

Meta Index / Home Page / Macro reference / SAS Latex Environments

taskparameters

A SAS specific LaTeX Environment

synopsis

\begin{taskparameters}
\end{taskparameters}

description

Parameters, whether mandatory or optional, are described here. Please use the macros supplied, that guarantee uniformity of look. Here's how the next three parameter descriptions appear in the source. Note that the parameters are described in a special environment. This is why these comments seem to be at the wrong place. Refer to the documentation of the param package for a list of allowed types.

See also mandparm, optparm.

example

\begin{taskparameters}

  \mandparm{mandatoryparam}{default value}{type}{constraints}{
    description for mandatory parameter
    }
  \optparm{optionalparam}{default value}{type}{constraints}{
    description for optional parameter
    }
  \optparm{set}{set.ds}{set}{}{
    the value of this parameter is printed out}
\end{taskparameters}