doc/plugin-architecture/local-macros.tex
changeset 0 2b3e5ec03512
equal deleted inserted replaced
-1:000000000000 0:2b3e5ec03512
       
     1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
       
     2 % spindle2 specific latex macros
       
     3 % 2006/08/10
       
     4 
       
     5 %% Requirements
       
     6 
       
     7 \newcommand{\refreq}[1]{Requirement~\ref{#1}}
       
     8 
       
     9 \newtheorem{reqBlock}{REQ}[section]
       
    10 
       
    11 \newcommand{\reqlabel}[1]{\mbox{\textsc{#1:}}\hfil}
       
    12 \newenvironment{reqlist}[1]{%
       
    13   \begin{list}{}{%
       
    14       \renewcommand{\makelabel}{\reqlabel}%
       
    15       \settowidth{\labelwidth}{\mbox{\textsc{#1:}}}%
       
    16       \setlength{\leftmargin}{\labelwidth+\labelsep}%
       
    17     }\itemsep=0pt\parsep=0pt\parskip=0pt}{%
       
    18   \end{list}%
       
    19 }
       
    20 \newcommand{\req}[2]{%
       
    21   \begin{reqBlock}
       
    22     #1%
       
    23 \ifx#2\empty\else%
       
    24 \begin{reqlist}{Description}
       
    25   #2
       
    26 \end{reqlist}
       
    27 \fi
       
    28 \end{reqBlock}
       
    29 }
       
    30 \newcommand{\reqSrc}{\item[Source]}
       
    31 \newcommand{\reqQuote}{\item[Quote]}
       
    32 \newcommand{\reqYear}{\item[Year]}
       
    33 \newcommand{\reqWhen}{\item[When]}
       
    34 
       
    35 \newcommand{\phase}[1]{\textbf{$\mathbf{[}$\textsc{Phase #1}$\mathbf{]}$}}
       
    36 
       
    37 % Macros for interface message/primitive definitions. Originally from
       
    38 % ADROIT, fixed by clivadas
       
    39 
       
    40 \newcommand{\metlabel}[1]{\mbox{\textsc{#1}}\hfill}
       
    41 \newcommand{\metP}{\item[Parameters]}
       
    42 \newcommand{\metD}{\item[Description]}
       
    43 \newcommand{\metM}{\item[DTN2 $\Delta$]}
       
    44 \newcommand{\metR}{\item[Related]}
       
    45 
       
    46 \newcommand{\method}[2]{%
       
    47 \noindent
       
    48 \textbf{#1}
       
    49 \begin{list}{}%
       
    50   {\renewcommand{\makelabel}{\metlabel}%
       
    51     \settowidth{\labelwidth}{\mbox{\textsc{OutputXXXXX}}}%
       
    52     \setlength{\leftmargin}{\labelwidth}%
       
    53     \addtolength{\leftmargin}{\labelsep}%
       
    54   }
       
    55   #2
       
    56 \end{list}
       
    57 \vspace{0.15in}
       
    58 }