Add hyperref package into user guide 04/4604/1
authorDavid <dhardy@ks.uiuc.edu>
Fri, 21 Sep 2018 21:38:56 +0000 (16:38 -0500)
committerDavid <dhardy@ks.uiuc.edu>
Fri, 21 Sep 2018 21:38:56 +0000 (16:38 -0500)
Create hyper links in PDF version of user guide.  With the hyperref
package, the \contentsline command needs 5 arguments instead of 3.
Using Giacomo's recommended parameters to hyperref that includes
citations linked in blue and page back references from bibliography.
Changed all URLs to use \url command to link the web pages.

Change-Id: I11062adc051399d0f0deb4f7cb8b936307c2da09

ug/namd_copyright.tex
ug/ug.tex
ug/ug_accel.tex
ug/ug_avail.tex
ug/ug_colvars.tex
ug/ug_forcefield.tex
ug/ug_go.tex
ug/ug_intro.tex
ug/ug_io.tex
ug/ug_runit.tex

index 99ff655..a0bd86f 100644 (file)
@@ -28,7 +28,7 @@ Group (``TCBG'') at Illinois' Beckman Institute available free of charge for
 non-commercial use by individuals, academic or research institutions and
 corporations for in-house business purposes only, upon completion and
 submission of the online registration form presented when attempting to
-download NAMD at the web site {\tt http://www.ks.uiuc.edu/Research/namd/}.
+download NAMD at the web site \url{http://www.ks.uiuc.edu/Research/namd/}.
 
 Commercial use of the NAMD software, or derivative works based thereon,
 REQUIRES A COMMERCIAL LICENSE. Commercial use includes: 
@@ -153,7 +153,7 @@ Any published work which utilizes NAMD shall include the following reference:
 Electronic documents will include a direct link to the official NAMD page:
 
 \begin{quote}
-{\tt http://www.ks.uiuc.edu/Research/namd/}
+\url{http://www.ks.uiuc.edu/Research/namd/}
 \end{quote}
 
 One copy of each publication or report will be supplied to Illinois 
index d29efae..39befb4 100644 (file)
--- a/ug/ug.tex
+++ b/ug/ug.tex
@@ -14,7 +14,7 @@
 \usepackage{verbatim}
 \usepackage{comment}
 \usepackage[stable]{footmisc}
-%\usepackage{hyperref}  % links in table of contents
+\usepackage[pagebackref,colorlinks,citecolor=blue,hyperfootnotes=false]{hyperref}  % links in table of contents
 %\usepackage{tocloft}
 \makeindex
 
 \newpage
 \input{ug_avail}
 
+% NOTE: with hyperref package, \contentsline needs 5 arguments, not 3.
+% https://tex.stackexchange.com/questions/168013/redefining-contentsline-with-hyperref-loaded
 \newpage
-%\phantomsection
-%\label{References}
-\addtocontents{toc}{\protect \contentsline {section}{References}{\thepage}} 
-%\addcontentsline{toc}{\protect \contentsline {section}{References}{\thepage}} %\addtocontents{toc}{section}{Bibliography} 
-
+\addtocontents{toc}{\protect\contentsline{section}{References}{\thepage}{}{}} 
 \bibliographystyle{abbrv}
 \bibliography{ug,ug_colvars,ug_eabf}
 
 \newpage
-\addtocontents{toc}{\protect \contentsline {section}{Index}{\thepage}}
-%\addcontentsline{toc}{section}{Index}
+\addtocontents{toc}{\protect\contentsline{section}{Index}{\thepage}{}{}}
 \printindex
 
 % that's all, folks
index cc0b765..72f038b 100644 (file)
@@ -161,7 +161,7 @@ GaMD enhances conformational sampling of biomolecules by adding a harmonic boost
   \centering
   \includegraphics[width=7cm]{figures/GaMD-scheme.jpg}
   \caption{Schematic illustration of GaMD. When the threshold energy $E$ is set to the maximum potential ($iE=1$ mode), the system's potential energy surface is smoothened by adding a harmonic boost potential that follows a Gaussian distribution. The coefficient $k_0$, which falls in the range of $0 - 1.0$, determines the magnitude of the applied boost potential.}
-  \label{fig:amd_schematic}
+  \label{fig:gamd_schematic}
 \end{figure}
 
 Consider a system with $N$ atoms at positions ${\bf r} = \big\{{\bf r}_1,\cdots,{\bf r}_N \}$. 
@@ -821,6 +821,6 @@ Optional parameter settings with a default. Depending on your simulation system,
 Note: 
 In the current RAMD implementation, combined RAMD-MD simulations, where RAMD blocks alternate with standard MD blocks are not available. In case you are are interested in this feature, please contact the RAMD developers at mcmsoft@h-its.org
 
-Scripts for using RAMD in the $\tau$RAMD procedure for computing residence times are available at: https://www.h-its.org/downloads/ramd/
+Scripts for using RAMD in the $\tau$RAMD procedure for computing residence times are available at: \url{https://www.h-its.org/downloads/ramd/}.
  
 
index c1c73a1..b779d89 100644 (file)
 
 \NAMD\ is distributed freely for non-profit use.
 \NAMD\ \NAMDVER\ is based on the Charm++ messaging system and the
-Converse communication layer ({\tt http://charm.cs.uiuc.edu/})
+Converse communication layer (\url{http://charm.cs.uiuc.edu/})
 which have been ported to a wide variety of parallel platforms.
 This section describes how to obtain and install \NAMD\ \NAMDVER.
 
 \subsection{How to obtain \NAMD}
 
-\NAMD\ may be downloaded from {\tt http://www.ks.uiuc.edu/Research/namd/}.
+\NAMD\ may be downloaded from \url{http://www.ks.uiuc.edu/Research/namd/}.
 You will be required to provide minimal registration information and
 agree to a license before receiving access to the software.
 Both source and binary distributions are available.
@@ -66,12 +66,12 @@ that takes advantage of special networking hardware.
 
 Directions for compiling NAMD are contained in the release notes,
 which are available from the NAMD web site
-{\tt http://www.ks.uiuc.edu/Research/namd/}
+\url{http://www.ks.uiuc.edu/Research/namd/}
 and are included in all distributions.
 
 \subsection{Documentation}
 
 All available \NAMD\ documentation is available for download without
 registration via the \NAMD\ web site
-{\tt http://www.ks.uiuc.edu/Research/namd/}.
+\url{http://www.ks.uiuc.edu/Research/namd/}.
 
index ffb27d0..f997265 100644 (file)
@@ -8,7 +8,7 @@
 \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.}}
 \label{section:colvars}
-\emph{This chapter can also be downloaded as a separate manual (PDF and HTML) at the webpage:\\{\tt http://colvars.github.io}}
+\emph{This chapter can also be downloaded as a separate manual (PDF and HTML) at the webpage:\\\url{http://colvars.github.io}}
 }
 
 \cvvmdugonly{
@@ -4677,14 +4677,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}}
-\cvnamdonly{{\tt https://colvars.github.io/colvars-refman-namd/colvars-refman-namd.html}}
+\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}}
 
 If you are using any of the NAMD and VMD tutorials:\\
-%\url{https://www.ks.uiuc.edu/Training/Tutorials/}\\
-{\tt https://www.ks.uiuc.edu/Training/Tutorials/}\\
+\url{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}
@@ -4695,8 +4693,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}
-  {\tt https://colvars.github.io/README-totalforce.html}
+  \url{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 d73a3b0..735281a 100644 (file)
@@ -543,7 +543,7 @@ or non-periodic boundaries, in which the simulation is
 performed in a vacuum. 
 Also, better parallel scaling has been observed with MSM 
 when scaling a sufficiently large system to a large number of processors. 
-See the MSM research web page (http://www.ks.uiuc.edu/Research/msm/
+See the MSM research web page (\url{http://www.ks.uiuc.edu/Research/msm/}
 for more information. 
 
 In order to use the MSM, 
@@ -917,7 +917,7 @@ the position of the LP is updated based on the three guide atoms,
 along with additional geometry parameters that give displacement 
 and in-plane and out-of-plane angles.  
 See our research web page
-({\tt http://www.ks.uiuc.edu/Research/Drude/})
+(\url{http://www.ks.uiuc.edu/Research/Drude/})
 for additional details and parallel performance results.  
 
 
index 7490841..e233bde 100644 (file)
@@ -118,7 +118,7 @@ It is recommended that individual pairwise potential be separated by a blank lin
 \subsubsection{SMOG model considerations}
 
 \NAMD\ supports the SMOG model from published from Onuchic's lab~\cite{Whitford2009aaa,Whitford2009nhf}.
-The input files for SMOG can be generated from the SMOG website (http://smog-server.org)~\cite{Noel2010ssd}.
+The input files for SMOG can be generated from the SMOG website (\url{http://smog-server.org})~\cite{Noel2010ssd}.
 It is recommended to run these simulations with 1-4 exclusions (as opposed to scaled 1-4), a 0.5fs timestep,
 and with a 0.5fs timestep (as described in~\cite{Whitford2009aaa,Whitford2009nhf}).  
 
index c2a4245..62db210 100644 (file)
@@ -144,7 +144,7 @@ you are encouraged to contact the developers for guidance.
 A system undergoing simulation in \NAMD\ may be viewed and
 altered with \VMD; for instance, forces can be applied to a set of atoms
 to alter or rearrange part of the molecular structure.  For more information
-on \VMD, see {\tt http://www.ks.uiuc.edu/Research/vmd/}.  
+on \VMD, see \url{http://www.ks.uiuc.edu/Research/vmd/}.  
 
 \item{\bf Load Balancing}\\
 An important factor in parallel applications is the equal distribution
index 038c74e..ba0b2f8 100644 (file)
@@ -34,7 +34,7 @@ being read or written by NAMD.
 This is the standard format for coordinate data
 for most other molecular dynamics programs as well, including X-PLOR and CHARMM.
 A full description of this file format can be obtained from the PDB web site
-at {\tt http://www.rcsb.org/pdb/}.
+at \url{http://www.rcsb.org/pdb/}.
 Positions in PDB files are stored in \AA.
 Velocities in PDB files are stored in \AA/ps and may be
 \index{units used for output}
index 012b45c..bd0276b 100644 (file)
@@ -176,7 +176,7 @@ you must add a ``++pathfix'' option to your nodelist file.  For example:
 
 There are many other options to charmrun and for the nodelist file.
 These are documented at in the Charm++ Installation and Usage Manual
-available at http://charm.cs.uiuc.edu/manuals/ and a list of available
+available at \url{http://charm.cs.uiuc.edu/manuals/} and a list of available
 charmrun options is available by running charmrun without arguments.
 
 If your workstation cluster is controlled by a queueing system you
@@ -514,7 +514,7 @@ default is ``pairlistMinProcs 1'').  This is a per-simulation rather than
 a compile time option because memory usage is molecule-dependent.
 
 Additional information on reducing memory usage may be found at
-http://www.ks.uiuc.edu/Research/namd/wiki/index.cgi?NamdMemoryReduction
+\url{http://www.ks.uiuc.edu/Research/namd/wiki/index.cgi?NamdMemoryReduction}
 
 \subsection{Improving Parallel Scaling}
 
@@ -569,5 +569,5 @@ has the unique advantage of also improving the scalability of PME.)
 \index{twoAwayX} \index{twoAwayY} \index{twoAwayZ}
 
 Additional performance tuning suggestions and options are described
-at http://www.ks.uiuc.edu/Research/namd/wiki/?NamdPerformanceTuning
+at \url{http://www.ks.uiuc.edu/Research/namd/wiki/?NamdPerformanceTuning}