[Rivet-svn] r2754 - trunk/doc

[blackhole at projects.hepforge.org]

Author: fsiegert
Date: Tue Nov 16 10:22:55 2010
New Revision: 2754

Log:
Update plotting section of manual and add hint of what to do in case of TeX memory exceeded.

Modified:
   trunk/doc/rivet-manual.tex

Modified: trunk/doc/rivet-manual.tex
==============================================================================
--- trunk/doc/rivet-manual.tex	Thu Nov 11 16:33:43 2010	(r2753)
+++ trunk/doc/rivet-manual.tex	Tue Nov 16 10:22:55 2010	(r2754)
@@ -495,13 +495,14 @@
 
 The high level program \kbd{rivet-mkhtml} will automatically create a plot
 webpage from the given AIDA files. It searches for reference data automatically
-and uses the other two commands internally. Example:
-\inp{rivet-mkhtml withUE.aida:'With UE' withoutUE:'Without UE'}
-The strings after the ":" are specifying ID strings to
-appear in the plot legends.
+and uses the other two commands internally. Example:\\
+\inp{rivet-mkhtml withUE.aida:'Title=With UE' withoutUE.aida:'LineColor=blue'}\\
+Run \kbd{rivet-mkhtml --help} to find out about all features and options.
 
-You can also run the other two commands separately.
-\kbd{compare-histos} will accept a number of AIDA files as input (ending in
+You can also run the other two commands separately:
+
+\begin{itemize}
+\item \kbd{compare-histos} will accept a number of AIDA files as input (ending in
 \kbd{.aida}), identify which plots are available in them, and combine the MC
 and reference plots appropriately into a set of plot data files ending with
 \kbd{.dat}. More options are described by running \kbd{compare-histos --help}.
@@ -511,12 +512,19 @@
 can find the location of this by using the \kbd{rivet-config} command:\\
 \inp{rivet-config --datadir}
 
-\noindent
-You can plot the created data files using the make-plots command:\\
+\item You can plot the created data files using the make-plots command:\\
 \inp{make-plots --pdf *.dat}\\
 The \kbd{--pdf} flag makes the output plots in PDF format: by default the output
 is in PostScript (\kbd{.ps}), and flags for conversion to EPS and PNG are also
 available.
+\end{itemize}
+
+Note that the plotting tools internally use Latex for drawing, and for very
+complex plots it might sometimes fail with an error message like
+``TeX memory exceeded'' (or ``DVI file can't be opened''). In such
+a case it is recommended to increase the allowed TeX memory size as described
+e.g. in the \href{http://pgfplots.sourceforge.net/pgfplots.pdf}{pgfplots manual}
+in Section 6.2.