Manual - Revision history

Bugman: Added an intro sentence, and increased the depth of the sectioning.

2015-10-19T17:29:53Z

Added an intro sentence, and increased the depth of the sectioning.

Bugman: /* Find the manual */ Small English fix.

2014-09-09T17:29:46Z

Find the manual: Small English fix.

Troels Emtekær Linnet: /* Latex requirements */

2014-08-02T09:43:10Z

Latex requirements

Troels Emtekær Linnet: /* See */

2014-05-22T16:03:05Z

See

Troels Emtekær Linnet: /* Build manual */

2014-05-22T16:02:39Z

Build manual

Troels Emtekær Linnet: /* Write to the mail lists to get personal help */

2014-05-22T16:02:25Z

Write to the mail lists to get personal help

Troels Emtekær Linnet: /* Get help */

2014-05-22T16:02:14Z

Get help

Troels Emtekær Linnet: /* Get help */

2014-05-22T15:59:20Z

Get help

Troels Emtekær Linnet: /* See */

2014-05-22T15:58:41Z

See

Tlinnet: /* Latex requirements */

2013-08-20T23:37:59Z

Latex requirements

@@ Line 1: / Line 1: @@
-= Find the manual =
+The following is information about the relax manual.
 The homepage manual
 * html http://www.nmr-relax.com/manual/index.html
@@ Line 5: / Line 7: @@
 * Latest built manual http://download.gna.org/relax/manual
-= Get help =
+== Get help ==
 The help section in relax is the best you can get !
@@ Line 37: / Line 39: @@
 </source>
-= Write to the mail lists to get personal help =
+== Write to the mail lists to get personal help ==
 See the wiki page [[Mailing_archives | Mailing archives]], to read how to sign up and write to the mail archives.
-= Build the manual =
+== Build the manual ==
-== Latex requirements ==
+=== Latex requirements ===
 The '''html.sty''' is needed from the latex package [http://www.ctan.org/pkg/latex2html latex2html].
@@ Line 82: / Line 84: @@
 </source>
-== Build pdf manual ==
+=== Build pdf manual ===
 The manual ends up in '''docs/relax.pdf'''
@@ Line 93: / Line 95: @@
   scons user_manual_pdf_nofetch
-== Build html manual ==
+=== Build html manual ===
 This needs quite some time to figure out to install and run latex2html.
@@ Line 102: / Line 104: @@
   scons user_manual_html_nofetch
-= Build API (Application programming interface) documentation  =
+== Build API (Application programming interface) documentation ==
 The html documentation ends up in '''docs/api/'''
-== Epydoc python package installation ==
+=== Epydoc python package installation ===
-=== Windows epydoc ===
+==== Windows epydoc ====
 First: Download this packages, do not unpack them yet.
 * epydoc http://www.lfd.uci.edu/~gohlke/pythonlibs/#epydoc
@@ Line 119: / Line 121: @@
 </source>
-=== Linux ===
+==== Linux ====
   sudo yum install epydoc
   sudo yum install graphviz-python
-== Build API ==
+=== Build API ===
 The API ends up in docs/api/index.html
@@ Line 132: / Line 134: @@
   scons api_manual_html
-== Regarding error messages ==
+=== Regarding error messages ===
 The "No documentation available!" errors are normal as these are for non-python files which are not part of relax.  It's safe to ignore these.
@@ Line 140: / Line 142: @@
 Windows binaries are available though (http://www.graphviz.org).
-= See also =
+== See also ==
 [[Category:FAQ]]

@@ Line 3: / Line 3: @@
 * html http://www.nmr-relax.com/manual/index.html
 * pdf http://download.gna.org/relax/manual/relax.pdf
-* Latest builded manual http://download.gna.org/relax/manual
+* Latest built manual http://download.gna.org/relax/manual
 = Get help =

@@ Line 50: / Line 50: @@
 <source lang="bash">
 cd $HOME/Downloads ;
-wget http://www.latex2html.org/~latex2ht/current/latex2html-2008.tar.gz ;
+wget http://mirrors.ctan.org/support/latex2html/latex2html-2012.tgz ;
-tar -xzf latex2html-2008.tar.gz ;
+tar -xzf latex2html-2012.tgz ;
-rm latex2html-2008.tar.gz ;
+rm latex2html-2012.tgz ;
 cd `where latex | xargs dirname`
@@ Line 59: / Line 59: @@
 cd ../../texmf-dist/tex/latex
-cp -r /$HOME/Downloads/latex2html-2008/texinputs latex2html
+cp -r /$HOME/Downloads/latex2html-2012/texinputs latex2html
 # Then update latex index
 texhash
@@ Line 70: / Line 70: @@
 cd $HOME/Downloads ;
-wget http://www.latex2html.org/~latex2ht/current/latex2html-2008.tar.gz ;
+wget http://www.latex2html.org/~latex2ht/current/latex2html-2012.tar.gz ;
-tar -xzf latex2html-2008.tar.gz ;
+tar -xzf latex2html-2012.tar.gz ;
-rm latex2html-2008.tar.gz ;
+rm latex2html-2012.tar.gz ;
-cd latex2html-2008 ;
+cd latex2html-2012 ;
 mkdir build ;
 ./configure --help

@@ Line 1: / Line 1: @@
-= See =
+= Find the manual =
 The homepage manual
 * html http://www.nmr-relax.com/manual/index.html

@@ Line 40: / Line 40: @@
 See the wiki page [[Mailing_archives | Mailing archives]], to read how to sign up and write to the mail archives.
-= Build manual =
+= Build the manual =
 == Latex requirements ==
 The '''html.sty''' is needed from the latex package [http://www.ctan.org/pkg/latex2html latex2html].

@@ Line 21: / Line 21: @@
 # You may want to read:
-help(relax_disp.exp_type)
+relax> help(relax_disp.exp_type)
-help(spectrum)
+relax> help(spectrum)
-help(spectrum.replicated)
+relax> help(spectrum.replicated)
-help(spectrum.baseplane_rmsd)
+relax> help(spectrum.baseplane_rmsd)
-help(spectrometer)
+relax> help(spectrometer)
 # This a very very fast an useful method to quickly understand the functions.
@@ Line 34: / Line 34: @@
 # For example.
-help(grid_search)
+relax> help(grid_search)
 </source>