Fix Colvars user guide documentation
[namd.git] / ug / ug_colvars_macros.tex
1 % This file is part of the Collective Variables module (Colvars).
2 % The original version of Colvars and its updates are located at:
3 % https://github.com/colvars/colvars
4 % Please update all Colvars source files before making any changes.
5 % If you wish to distribute your changes, please submit them to the
6 % Colvars repository at GitHub.
7
8
9 % compiling the NAMD User's Guide
10
11 % define missing macros
12 \newcommand{\MDENGINE}{NAMD}
13 \newcommand{\cvrefmanonly}[1]{}
14 \newcommand{\cvvmdonly}[1]{}
15 \newcommand{\cvvmdugonly}[1]{}
16 \newcommand{\cvnamdonly}[1]{#1}
17 \newcommand{\cvnamdugonly}[1]{#1}
18 \newcommand{\cvnamebasedonly}[1]{#1}
19 \newcommand{\cvlammpsonly}[1]{}
20 \newcommand{\cvscriptonly}[1]{#1}
21 \newcommand{\cvleptononly}[1]{#1}
22 \newcommand{\cvcommand}{cv}
23
24 % use the NAMD UG macros to document keywords
25 \newcommand{\key}[5]{\NAMDCOLVARCONF{#1}{#2}{#3}{#4}{#5}}
26 \newcommand{\keydef}[6]{\NAMDCOLVARCONFWDEF{#1}{#2}{#3}{#4}{#5}{#6}}
27 \newcommand{\labelkey}[1]{}
28 \newcommand{\refkey}[2]{\texttt{#1}}
29 \newcommand{\dupkey}[4]{%
30   {\bf \large \tt #1:} see definition of \texttt{#1} (#4)%
31 }
32 \newcommand{\simkey}[3]{%
33   {\bf \large \tt #1:} analogous to \texttt{#3}%
34 }
35
36 \newcommand{\cvsec}[2]{\subsection{#1}\label{#2}}
37 \newcommand{\cvsubsec}[2]{\subsubsection{#1}\label{#2}}
38 \newcommand{\cvsubsubsec}[2]{\paragraph*{#1}\label{#2}}
39
40 \newcommand{\outputName}{\emph{outputName}}
41 \newcommand{\restartName}{\emph{restartName}}
42 \newcommand{\inputName}{\emph{inputName}}
43
44