note that you can't use \-continuation in a parameter file :( :(

git-svn-id: http://svn.einsteintoolkit.org/cactus/EinsteinAnalysis/AHFinderDirect/trunk@1181 f88db872-0e4f-0410-b76b-b9085cfa78c5

1 files changed, 39 insertions, 32 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index ca62035..3d74028 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -2,42 +2,42 @@
 %  Cactus Thorn template for ThornGuide documentation
 %  Author: Ian Kelley
 %  Date: Sun Jun 02, 2002
-%  $Header$                                                             
+%  $Header$
 %
-%  Thorn documentation in the latex file doc/documentation.tex 
+%  Thorn documentation in the latex file doc/documentation.tex
 %  will be included in ThornGuides built with the Cactus make system.
-%  The scripts employed by the make system automatically include 
-%  pages about variables, parameters and scheduling parsed from the 
+%  The scripts employed by the make system automatically include
+%  pages about variables, parameters and scheduling parsed from the
 %  relevent thorn CCL files.
-%  
-%  This template contains guidelines which help to assure that your     
-%  documentation will be correctly added to ThornGuides. More 
+%
+%  This template contains guidelines which help to assure that your
+%  documentation will be correctly added to ThornGuides. More
 %  information is available in the Cactus UsersGuide.
-%                                                    
+%
 %  Guidelines:
 %   - Do not change anything before the line
 %       % BEGIN CACTUS THORNGUIDE",
 %     except for filling in the title, author, date etc. fields.
 %   - You can define your own macros are OK, but they must appear after
-%     the BEGIN CACTUS THORNGUIDE line, and do not redefine standard 
+%     the BEGIN CACTUS THORNGUIDE line, and do not redefine standard
 %     latex commands.
-%   - To avoid name clashes with other thorns, 'labels', 'citations', 
-%     'references', and 'image' names should conform to the following 
-%     convention:          
+%   - To avoid name clashes with other thorns, 'labels', 'citations',
+%     'references', and 'image' names should conform to the following
+%     convention:
 %       ARRANGEMENT_THORN_LABEL
-%     For example, an image wave.eps in the arrangement CactusWave and 
+%     For example, an image wave.eps in the arrangement CactusWave and
 %     thorn WaveToyC should be renamed to CactusWave_WaveToyC_wave.eps
-%   - Graphics should only be included using the graphix package. 
+%   - Graphics should only be included using the graphix package.
 %     More specifically, with the "includegraphics" command. Do
-%     not specify any graphic file extensions in your .tex file. This 
+%     not specify any graphic file extensions in your .tex file. This
 %     will allow us (later) to create a PDF version of the ThornGuide
 %     via pdflatex. |
-%   - References should be included with the latex "bibitem" command.  
-%   - For the benefit of our Perl scripts, and for future extensions, 
-%     please use simple latex.     
+%   - References should be included with the latex "bibitem" command.
+%   - For the benefit of our Perl scripts, and for future extensions,
+%     please use simple latex.
+%
+% *======================================================================*
 %
-% *======================================================================* 
-% 
 % Example of including a graphic image:
 %    \begin{figure}[ht]
 % 	\begin{center}
@@ -55,10 +55,10 @@
 %
 % Example of including a reference
 %   \bibitem{MyArrangement_MyThorn_Author99}
-%   {J. Author, {\em The Title of the Book, Journal, or periodical}, 1 (1999), 
+%   {J. Author, {\em The Title of the Book, Journal, or periodical}, 1 (1999),
 %   1--16. {\tt http://www.nowhere.com/}}
 %
-% *======================================================================* 
+% *======================================================================*
 
 % If you are using CVS use this line to give version information
 % $Header$
@@ -67,7 +67,7 @@
 \bibliographystyle{alpha}
 
 % Use the Cactus ThornGuide style file
-% (Automatically used from Cactus distribution, if you have a 
+% (Automatically used from Cactus distribution, if you have a
 %  thorn without the Cactus Flesh download this from the Cactus
 %  homepage at www.cactuscode.org)
 \usepackage{../../../../doc/ThornGuide/cactus}
@@ -82,7 +82,7 @@
 % The title of the document (not necessarily the name of the Thorn)
 \title{Thorn Guide for the {\bf AHFinderDirect} Thorn}
 
-% the date your document was last changed, if your document is in CVS, 
+% the date your document was last changed, if your document is in CVS,
 % please us:
 %    \date{$ $Date$ $}
 \date{$ $Date$ $}
@@ -92,7 +92,7 @@
 % Do not delete next line
 % START CACTUS THORNGUIDE
 
-% Add all definitions used in this documentation here 
+% Add all definitions used in this documentation here
 %   \def\mydef etc
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -541,7 +541,7 @@ $^,$%%%
 	\begin{description}
 	\item[\code{"read from file"}]
 	\mbox{}\\
-		This reads the initial-guess $h(\text{angle})$ function 
+		This reads the initial-guess $h(\text{angle})$ function
 		from a data file.  The file format is currently hard-wired
 		to be that written with \verb|file_format = "ASCII (gnuplot)"|
 		(see below).
@@ -696,7 +696,7 @@ to data files:
 			for each Cactus time step and for each apparent
 			horizon found.  By default these are all written
 			in the starting directory of the Cactus run.
-			(I plan to change this at some point to use the 
+			(I plan to change this at some point to use the
 			\verb|IOUtil::out_dir| directory.)
 		\item	The time step number and the apparent horizon number
 			are both encoded in the file name; the actual
@@ -766,7 +766,7 @@ to data files:
 	This specifies the directory in which the $h$ data files
 	are to be written.  If it doesn't already exist, this directory
 	is created before writing the data files.  This parameter
-	defaults to the value of the \verb|IO::out_dir| parameter.  
+	defaults to the value of the \verb|IO::out_dir| parameter.
 
 \item[\code{h\_base\_file\_name}]
 \mbox{}\\
@@ -856,7 +856,7 @@ controlled by the following parameters:
 	This specifies the directory in which the black hole diagnostics
 	data files are to be written.  If it doesn't already exist, this
 	directory is created before writing the data files.  This parameter
-	defaults to the value of the \verb|IO::out_dir| parameter.  
+	defaults to the value of the \verb|IO::out_dir| parameter.
 
 \item[\code{BH\_diagnostics\_base\_file\_name}]
 \mbox{}\\
@@ -933,7 +933,7 @@ r_\text{inner}
 		\,\,+\,\, \verb|mask_radius_offset| \times \Delta x
 									\\
 r_\text{outer}
-	& = &	r_\text{inner} 
+	& = &	r_\text{inner}
 		\,\,+\,\, \verb|mask_buffer_thickness| \times \Delta x
 									%%%\\
 \end{array}
@@ -1130,7 +1130,14 @@ each time that apparent horizon is found:
 
 	If you want to get very high accuracy from \thorn{AHFinderDirect},
 	then you should use a cubic Hermite geometry interpolator, by
-	setting
+	setting%%%
+\footnote{%%%
+	 Note that Cactus currently doesn't allow
+	 ``backslash'' line continuation in a
+	 parameter file, so the whole string should
+	 be on a single (very long) line in your
+	 parameter file!
+	 }%%%
 	\begin{verbatim}
 	AHFinderDirect::geometry_interpolator_pars = \
  "order=3 \
@@ -1546,7 +1553,7 @@ and postdoctoral fellowships programs for financial support.
 
 % make LaTeX read in ahfinderdirect.bbl produced by bibtex
 % run 'make bib' in this directory to update this
-\bibliography{ahfinderdirect}      
+\bibliography{ahfinderdirect}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%