[Rivet-svn] r2260 - trunk/doc

[blackhole at projects.hepforge.org]

Author: buckley
Date: Thu Feb 11 16:48:45 2010
New Revision: 2260

Log:
Manual tweaks and updates

Added:
   trunk/doc/warning.png   (contents, props changed)
Modified:
   trunk/doc/hepunits.sty   (props changed)
   trunk/doc/preamble.tex
   trunk/doc/rivet-manual.tex

Modified: trunk/doc/preamble.tex
==============================================================================
--- trunk/doc/preamble.tex	Thu Feb 11 16:15:20 2010	(r2259)
+++ trunk/doc/preamble.tex	Thu Feb 11 16:48:45 2010	(r2260)
@@ -42,6 +42,7 @@
 %\renewcommand\marginpar[1]{\-\oldmarginpar[\raggedleft\footnotesize \textit{#1}]%
 %{\raggedright\footnotesize \textit{#1}}}
 
+\newcommand{\warnimg}{\includegraphics[height=11mm]{warning}}
 \newcommand{\coneimg}{\includegraphics[height=11mm]{cone}}
 \newcommand{\bendimg}{\includegraphics[height=11mm]{bend}}
 \newcommand{\dblbendimg}{\bendimg\hspace{0.5mm}\bendimg}
@@ -50,35 +51,50 @@
 \setlength{\fboxsep}{5mm}
 \setlength{\linewidth}{5pt}
 
+\newenvironment{warning}{\begin{window}[0,l,{\warnimg},{}]}{\end{window}\ignorespacesafterend}
+\newenvironment{detail}{\begin{window}[0,l,{\bendimg},{}]}{\end{window}\ignorespacesafterend}
+\newenvironment{dbldetail}{\begin{window}[0,l,{\dblbendimg},{}]}{\end{window}\ignorespacesafterend}
+
 \newenvironment{change}%
 {\begin{Sbox}%
-      \begin{minipage}{0.9\textwidth}%
-        \begin{window}[0,l,{\coneimg},{}] \noindent\hspace{-0.8ex}}%
-        {\par\end{window}%
-      \end{minipage}%
+    \begin{minipage}{0.9\textwidth}%
+      \window[0,l,{\coneimg},{}] \noindent\hspace{-0.8ex}}
+    {\par\endwindow%
+    \end{minipage}%
   \end{Sbox}%
-  \vspace{5mm}%
+  \vspace{2mm}%
   \noindent%
   \begin{center}%
-    \fbox{\TheSbox}%
+    \cornersize{0.1}
+    \Ovalbox{\TheSbox}%
   \end{center}%
-  \vspace{5mm}%
+  \vspace{2mm}%
   \ignorespacesafterend}
 
-% \newenvironment{change}{%
-% \begin{window}[0,l,{\coneimg},{}] \noindent\hspace{-0.8ex}}{\par%
-% % \showthe\prevgraf%
-% % \showthe\prevdepth%
-% % \ifnum\prevgraf<2\rule{1pt}{1.2cm}\fi%
-% \end{window}\ignorespacesafterend}
-
 %% Make narrower and box (box must be able to break over pages)
-\newenvironment{philosophy}{\vspace{5mm}\hrule\nobreak\vspace{3mm}\begingroup%
-  \it\begin{window}[0,l,{\thinkimg},{}]
-  \setlength{\parindent}{0cm}\noindent}{%
-  \end{window}\endgroup\vspace{3mm}\nobreak\hrule\vspace{5mm}\ignorespacesafterend}
-\newenvironment{detail}{\begin{window}[0,l,{\bendimg},{}]}{\end{window}\ignorespacesafterend}
-\newenvironment{dbldetail}{\begin{window}[0,l,{\dblbendimg},{}]}{\end{window}\ignorespacesafterend}
+% \newenvironment{philosophy}{\vspace{5mm}\hrule\nobreak\vspace{3mm}\begingroup%
+%   \it\begin{window}[0,l,{\thinkimg},{}]
+%   \setlength{\parindent}{0cm}\noindent}{%
+%   \end{window}\endgroup\vspace{3mm}\nobreak\hrule\vspace{5mm}\ignorespacesafterend}
+
+\newenvironment{philosophy}%
+{\begin{Sbox}%
+    \begin{minipage}{0.9\textwidth}%
+      \it
+      \window[0,l,{\thinkimg},{}]
+      \setlength{\parindent}{0cm}\noindent\hspace{-0.8ex}}
+    {\par\endwindow%
+    \end{minipage}%
+  \end{Sbox}%
+  \vspace{2mm}%
+  \noindent%
+  \begin{center}%
+    \cornersize{0.01}
+    \Ovalbox{\TheSbox}%
+  \end{center}%
+  \vspace{2mm}%
+  \ignorespacesafterend}
+
 
 \newcommand{\pT}{\ensuremath{p_\perp}\xspace}
 \newcommand{\ET}{\ensuremath{E_\perp}\xspace}

Modified: trunk/doc/rivet-manual.tex
==============================================================================
--- trunk/doc/rivet-manual.tex	Thu Feb 11 16:15:20 2010	(r2259)
+++ trunk/doc/rivet-manual.tex	Thu Feb 11 16:48:45 2010	(r2260)
@@ -1068,6 +1068,23 @@
 (although chances are you will have to recompile, since the binary interface usually
 change between releases.)
 
+To load pluggable analyses you will need to set the \kbd{RIVET_ANALYSIS_PATH}
+environment variable: this is a standard colon-separated UNIX path, specifying
+directories in which analysis plugin libraries may be found. If it is
+unspecified, the Rivet loader system will assume that the only entry is the
+\kbd{lib} directory in the Rivet installation area -- specifying the variable
+will disable this standard location to allow you to override standard analyses
+with same-named variants of your own (provided they are loaded from different
+directories). 
+
+\begin{change}
+  Note that the search path behaviour has changed as of Rivet 1.2.0: previously
+  the standard library install directory was \emph{always} used, as were the
+  current directory and \kbd{./.libs}, if found. While the new system requires a
+  bit more setup if you are to use personal plugin analyses, it also solves many
+  niggling problems and areas for confusion!
+\end{change}
+
 You will find an example plugin analysis in the \kbd{plugindemo} directory in
 the Rivet source directory, with a corresponding \kbd{Makefile}. To understand
 the plugin system better, you should check out the documentation in the wiki on

Added: trunk/doc/warning.png
==============================================================================
Binary file. No diff available.