doc/pplmanual.tex

   1 %%% Commonly Needed packages
   2 \usepackage{graphicx,color,calc}
   3 \usepackage{fancyvrb}
   4 \usepackage{makeidx}
   5 \usepackage{alltt}
   6 \usepackage{html}
   7 \usepackage{hyphenat}
   8 \usepackage{listings}
   9 \usepackage{xspace} %<- creates problems with other hyperlink packages like "html"
  10 \usepackage{hyperref}
  11 \hypersetup{
  12     colorlinks,%
  13     citecolor=black,%
  14     filecolor=black,%
  15     linkcolor=black,%
  16     urlcolor=magenta
  17 }
  18
  19
  20 %%% Commands for uniform looks of C++, Charm++, and Projections
  21 \newcommand{\CC}{C\hbox{++}\xspace}
  22 \newcommand{\emCC}{C\hbox{\em++}\xspace}
  23 \newcommand{\charmpp}{Charm++\xspace}
  24 \newcommand{\charm}{Charm++\xspace}
  25 \newcommand{\charmc}{\texttt{charmc}\xspace}
  26 \newcommand{\projections}{\textrm{Projections}\xspace}
  27 \newcommand{\converse}{Converse\xspace}
  28 \newcommand{\ampi}{\textup{AMPI}\xspace}
  29 \newcommand{\tempo}{\textsc{TeMPO}\xspace}
  30 \newcommand{\irecv}{\textsl{iRecv}\xspace}
  31 \newcommand{\sdag}{\textsl{Structured Dagger}\xspace}
  32 \newcommand{\jade}{Jade\xspace}
  33 \newcommand{\ci}{\emph{ci}\xspace}
  34
  35 %%% Commands to produce margin symbols
  36 \newcommand{\new}{\marginpar{\fbox{\bf$\mathcal{NEW}$}}}
  37 \newcommand{\important}{\marginpar{\fbox{\bf\Huge !}}}
  38 \newcommand{\experimental}{\marginpar{\fbox{\bf\Huge $\beta$}}}
  39
  40 %%% Commands for manual elements
  41 \newcommand{\zap}[1]{ }
  42 \newcommand{\function}[1]{{\noindent{\textsf{#1}}\\}}
  43 \newcommand{\cmd}[1]{{\noindent{\textsf{#1}}\\}}
  44 \newcommand{\args}[1]{\hspace*{2em}{\texttt{#1}}\\}
  45 \newcommand{\prototype}[1]{\vspace{0.2in}\index{#1}}
  46 \newcommand{\param}[1]{{\texttt{#1}}}
  47 \newcommand{\kw}[1]{{\nohyphens{\textsf{#1}}\index{#1}}}
  48 \newcommand{\uw}[1]{#1}
  49 \newcommand{\desc}[1]{\indent{#1}}
  50 \newcommand{\note}[1]{(\textbf{Note:} #1)}
  51 \newcommand{\term}[1]{{\bf #1}\index{#1}}
  52
  53 % Explicitly state that part numbering uses uppercase roman numerals
  54 % This is just to keep latex2html from barfing and causing a filename
  55 % collision between part II and chapter 2 etc. This will work as long
  56 % as we don't have an appendix section 9 (which would be alphabetized
  57 % to I (and again conflict with part 1).
  58 \renewcommand{\thepart}{\Roman{part}}
  59
  60 \newcommand{\gitweb}[2]{http://charm.cs.illinois.edu/cgi-bin/gitweb2.cgi?p=charm.git;hb=HEAD;a=#1;f=#2}
  61
  62 \newcommand{\gitwebref}[3]{\href{\gitweb{#1}{#2/charm\%2B\%2B/#3}}{\tt #2/charm++/#3}}
  63 \newcommand{\examplereffile}[1]{\gitwebref{blob}{examples}{#1}}
  64 \newcommand{\examplerefdir}[1]{\gitwebref{tree}{examples}{#1}}
  65 \newcommand{\testreffile}[1]{\gitwebref{blob}{tests}{#1}}
  66 \newcommand{\testrefdir}[1]{\gitwebref{tree}{tests}{#1}}
  67
  68 \begin{htmlonly}
  69 \renewcommand{\examplereffile}[1]{\texttt{\emph{examples/charm++/#1}}}
  70 \renewcommand{\examplerefdir}[1]{\texttt{examples/charm++/#1}}
  71 \renewcommand{\testreffile}[1]{\texttt{\emph{tests/charm++/#1}}}
  72 \renewcommand{\testrefdir}[1]{\texttt{tests/charm++/#1}}
  73 \end{htmlonly}
  74 \makeindex