Author: bugman
Date: Sun Aug 4 23:40:15 2013
New Revision: 20532
URL: http://svn.gna.org/viewcvs/relax?rev=20532&view=rev
Log:
Better indexing in the relax user manual.
The imakeidx LaTeX package is now used instead of makeidx, and the
hyphenation has been improved.
Modified:
trunk/docs/latex/hyphenation.tex
trunk/docs/latex/intro.tex
trunk/docs/latex/relax.tex
Modified: trunk/docs/latex/hyphenation.tex
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/latex/hyphenation.tex?rev=20532&r1=20531&r2=20532&view=diff
==============================================================================
--- trunk/docs/latex/hyphenation.tex (original)
+++ trunk/docs/latex/hyphenation.tex Sun Aug 4 23:40:15 2013
@@ -6,5 +6,8 @@
\hyphenation{in-equ-al-i-t-ies}
\hyphenation{in-equ-al-i-ty}
+\hyphenation{iso-trop-ic}
\hyphenation{mol-e-c-ule}
+
+\hyphenation{sph-er-oid}
Modified: trunk/docs/latex/intro.tex
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/latex/intro.tex?rev=20532&r1=20531&r2=20532&view=diff
==============================================================================
--- trunk/docs/latex/intro.tex (original)
+++ trunk/docs/latex/intro.tex Sun Aug 4 23:40:15 2013
@@ -215,7 +215,7 @@
relax> state.save('save', force=True)
\end{lstlisting}
-Two types of arguments exist in Python\index{Python|textbf} -- standard
arguments\index{argument} and keyword arguments\index{keyword
argument}\index{argument!keyword}. The majority of arguments you will
encounter within relax are keyword arguments however you may, in rare cases,
encounter a non-keyword argument. For these standard arguments just type the
values in, although they must be in the correct order. Keyword arguments
consist of two parts -- the key and the value. For example the key may be
\prompt{file} and the value you would like to supply is
\promptstring{R1.out}. Various methods exist for supplying this argument.
Firstly you could simply type \promptstring{R1.out} into the correct position
in the argument list. Secondly you can type \prompt{file=`R1.out'}. The
power of this second option is that argument order is unimportant. Therefore
if you would like to change the default value of the very last argument, you
don't have to supply values for all other arguments. The only catch is that
standard arguments must come before the keyword arguments.
+Two types of arguments exist in Python\index{Python|textbf} -- standard
arguments\index{argument} and keyword arguments\index{argument!keyword}. The
majority of arguments you will encounter within relax are keyword arguments
however you may, in rare cases, encounter a non-keyword argument. For these
standard arguments just type the values in, although they must be in the
correct order. Keyword arguments consist of two parts -- the key and the
value. For example the key may be \prompt{file} and the value you would like
to supply is \promptstring{R1.out}. Various methods exist for supplying this
argument. Firstly you could simply type \promptstring{R1.out} into the
correct position in the argument list. Secondly you can type
\prompt{file=`R1.out'}. The power of this second option is that argument
order is unimportant. Therefore if you would like to change the default
value of the very last argument, you don't have to supply values for all
other arguments. The only catch is that standard arguments must come before
the keyword arguments.
% Script screenshot
Modified: trunk/docs/latex/relax.tex
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/latex/relax.tex?rev=20532&r1=20531&r2=20532&view=diff
==============================================================================
--- trunk/docs/latex/relax.tex (original)
+++ trunk/docs/latex/relax.tex Sun Aug 4 23:40:15 2013
@@ -7,7 +7,7 @@
\usepackage{natbib}
% The index.
-\usepackage{makeidx}
+\usepackage{imakeidx}
% Good looking tables.
\usepackage{booktabs}
@@ -372,7 +372,7 @@
\index{ellipsoidal diffusion|see{diffusion, ellipsoid (asymmetric)}}
\index{Fletcher-Reeves|see{optimisation, algorithm, Fletcher-Reeves}}
\index{Frequentist model selection|see{model selection, Frequentist}}
-\index{GNU/Linux|see{Operating system, GNU/Linux}}
+\index{GNU/Linux|see{Operating system, GNU/\ Lin\-ux}}
\index{Grace|see{software, Grace}}
\index{GUI|see{User interface, GUI}}
\index{gzip|see{compression, gzip}}
@@ -382,7 +382,7 @@
\index{keyword argument|see{argument, keyword}}
\index{Kullback-Leibler discrepancy|see{discrepancy, Kullback-Leibler}}
\index{Levenberg-Marquardt|see{optimisation, algorithm, Levenberg-Marquardt}}
-\index{Linux|see{Operating system, GNU/Linux}}
+\index{Linux|see{Operating system, GNU/\-Lin\-ux}}
\index{Logarithmic barrier|see{optimisation, constraint algorithm,
Logarithmic barrier}}
\index{longitudinal relaxation|see{relaxation rate, spin-lattice}}
\index{Mac OS X|see{Operating system, Mac OS X}}
@@ -394,7 +394,7 @@
\index{Nelder-Mead simplex|see{optimisation, algorithm, Nelder-Mead simplex}}
\index{Newton|see{optimisation, algorithm, Newton}}
\index{Newton-Raphson|see{optimisation, algorithm, Newton}}
-\index{Newton-CG|see{optimisation, algorithm, Newton-CG}}
+\index{Newton-CG|see{optimisation, algorithm, New\-ton-CG}}
\index{NMRView|see{software, NMRView}}
\index{OpenDX|see{software, OpenDX}}
\index{OpenMPI|see{MPI, OpenMPI}}
@@ -402,6 +402,8 @@
\index{Polak-Ribiere|see{optimisation, algorithm, Polak-Ribi\`ere}}
\index{Polak-Ribiere +|see{optimisation, algorithm, Polak-Ribi\`ere +}}
\index{PyMOL|see{software, PyMOL}}
+\index{R1@$\Rone$|see{relaxation rate, spin-lattice}}
+\index{R2@$\Rtwo$|see{relaxation rate, spin-spin}}
\index{relax|see{software, relax}}
\index{simplex algorithm|see{optimisation, algorithm, Nelder-Mead simplex}}
\index{Sparky|see{software, Sparky}}
r20532 - in /trunk/docs/latex: hyphenation.tex intro.tex relax.tex