Provide basic info (instead of footnote) at top of the Colvars chapter 08/4608/1
authorGiacomo Fiorin <giacomo.fiorin@gmail.com>
Sun, 23 Sep 2018 21:30:30 +0000 (17:30 -0400)
committerGiacomo Fiorin <giacomo.fiorin@gmail.com>
Sun, 23 Sep 2018 21:30:30 +0000 (17:30 -0400)
Change-Id: I7825160e3948285a14ebb424c7dcb29190a63868

ug/ug_colvars.tex
ug/ug_colvars_macros.tex

index f997265..44fa045 100644 (file)
@@ -6,18 +6,40 @@
 % Colvars repository at GitHub.
 
 \cvnamdugonly{
-\section{Collective Variable-based Calculations (Colvars)\footnote{The features described in this section were contributed by Giacomo Fiorin (ICMS, Temple University, Philadelphia, PA, USA) and J\'er\^ome H\'enin (IBPC, CNRS, Paris, France). Please send feedback and suggestions to the NAMD mailing list.}}
+\section{Collective Variable-based Calculations (Colvars)}
 \label{section:colvars}
-\emph{This chapter can also be downloaded as a separate manual (PDF and HTML) at the webpage:\\\url{http://colvars.github.io}}
+
+The features described in this section were originally contributed to NAMD by Giacomo Fiorin (NIH) and J\'er\^ome H\'enin (CNRS, France) and are currently developed at this external repository:\\
+\cvurl{https://github.com/Colvars/colvars}\\
+An updated version of this section can also be downloaded as a separate manual: \\
+HTML: \cvurl{https://colvars.github.io/colvars-refman-namd/colvars-refman-namd.html} \\
+PDF: \cvurl{https://colvars.github.io/pdf/colvars-refman-namd.pdf}\\
+
+See section~\ref{sec:colvars_config_changes} for specific changes that affect compatibility between versions.
+Please ask any usage questions through the NAMD mailing list, and development questions through GitHub.
+
+\subsection*{Overview}
 }
 
 \cvvmdugonly{
 \chapter{Collective Variables Interface (Colvars)}
 \label{section:colvars}
+
+The features described in this section were originally contributed to VMD by Giacomo Fiorin (NIH) and J\'er\^ome H\'enin (CNRS, France) and are currently developed at this external repository:\\
+\cvurl{https://github.com/Colvars/colvars}\\
+An updated version of this section can also be downloaded as a separate manual: \\
+HTML: \cvurl{https://colvars.github.io/colvars-refman-vmd/colvars-refman-vmd.html} \\
+PDF: \cvurl{https://colvars.github.io/pdf/colvars-refman-vmd.pdf}\\
+
+See section~\ref{sec:colvars_config_changes} for specific changes that affect compatibility between versions.
+Please ask any usage questions through the VMD mailing list, and development questions through GitHub.
+
+\subsection*{Overview}
 }
 \cvrefmanonly{
-\cvsec{Introduction}{sec:colvars_intro}
+\cvsec{Overview}{sec:colvars_intro}
 }
+
 In molecular dynamics simulations, it is often useful to reduce the large number of degrees of freedom of a physical system into few parameters whose statistical distributions can be analyzed individually, or used to define biasing potentials to alter the dynamics of the system in a controlled manner.
 These have been called `order parameters', `collective variables', `(surrogate) reaction coordinates', and many other terms.
 
@@ -518,6 +540,7 @@ Only the options \texttt{name}, \texttt{width}, \texttt{lowerBoundary} and \text
 }
 
 \item %
+  \labelkey{colvar|upperBoundary} %
   \key
     {upperBoundary}{%
     \texttt{colvar}}{%
@@ -546,7 +569,7 @@ See Section~\ref{sec:cvc} for the physical ranges of values of each component.}
     Analogous to \texttt{hardLowerBoundary}.}
 
 \item %
-  \labelkey{expandBoundaries}{colvar|expandBoundaries} %
+  \labelkey{colvar|expandBoundaries} %
   \keydef
     {expandBoundaries}{%
     \texttt{colvar}}{%
@@ -4677,12 +4700,12 @@ The following is a list of syntax changes in Colvars since its first release.
 Many of the older keywords are still recognized by the current code: the primary purpose of this list is to make you aware of improvements that affect old configuration files.
 
 The syntax of the latest version of Colvars can always be accessed at:\\
-\cvnamdonly{\url{https://colvars.github.io/colvars-refman-namd/colvars-refman-namd.html}}
-\cvlammpsonly{\url{https://colvars.github.io/colvars-refman-lammps/colvars-refman-lammps.html}}
-\cvvmdonly{\url{https://colvars.github.io/colvars-refman-vmd/colvars-refman-vmd.html}}
+\cvnamdonly{\cvurl{https://colvars.github.io/colvars-refman-namd/colvars-refman-namd.html}}
+\cvlammpsonly{\cvurl{https://colvars.github.io/colvars-refman-lammps/colvars-refman-lammps.html}}
+\cvvmdonly{\cvurl{https://colvars.github.io/colvars-refman-vmd/colvars-refman-vmd.html}}
 
 If you are using any of the NAMD and VMD tutorials:\\
-\url{https://www.ks.uiuc.edu/Training/Tutorials/}\\
+\cvurl{https://www.ks.uiuc.edu/Training/Tutorials/}\\
 please be aware that \emph{several of these tutorials are not actively maintained}: for those cases, the following list will help you reconcile any inconsistencies.
 
 \begin{itemize}
@@ -4693,7 +4716,7 @@ please be aware that \emph{several of these tutorials are not actively maintaine
 \item \textbf{Colvars version 2016-08-10 or later \cvnamdonly{(NAMD version 2.12b1 or later)}\cvvmdonly{(VMD version 1.9.3 or later)}\cvlammpsonly{(LAMMPS version 15Sep2016 or later)}.}\\
   ``System forces'' have been replaced by ``total forces'' (see for example \refkey{outputTotalForce}{colvar|outputTotalForce}).
   See the following page for more information:\\
-  \url{https://colvars.github.io/README-totalforce.html}
+  \cvurl{https://colvars.github.io/README-totalforce.html}
 
 \item \textbf{Colvars version 2017-01-09 or later \cvnamdonly{(NAMD version 2.13b1 or later)}\cvvmdonly{(VMD version 1.9.4 or later)}\cvlammpsonly{(LAMMPS version 10Mar2017 or later)}.}\\
   A new type of restraint, \texttt{harmonicWalls} (see~\ref{sec:colvarbias_harmonic_walls}), replaces and improves upon the legacy keywords \texttt{lowerWall} and \texttt{upperWall}: these are still supported as short-hands.
index 83abfc4..c46a50f 100644 (file)
@@ -20,6 +20,7 @@
 \newcommand{\cvscriptonly}[1]{#1}
 \newcommand{\cvleptononly}[1]{#1}
 \newcommand{\cvcommand}{cv}
+\newcommand{\cvurl}[1]{\url{#1}}
 
 % use the NAMD UG macros to document keywords
 \newcommand{\key}[5]{\NAMDCOLVARCONF{#1}{#2}{#3}{#4}{#5}}