changeset 11573:6f8ffe2c6f76

Grammarcheck txi files for 3.4 release.
author Rik <octave@nomad.inbox5.com>
date Wed, 19 Jan 2011 20:29:11 -0800
parents 7d6d8c1e471f
children a83bad07f7e3
files doc/ChangeLog doc/interpreter/diagperm.txi doc/interpreter/dynamic.txi doc/interpreter/func.txi doc/interpreter/install.txi doc/interpreter/intro.txi doc/interpreter/numbers.txi doc/interpreter/oop.txi doc/interpreter/plot.txi doc/interpreter/sparse.txi doc/interpreter/stats.txi
diffstat 11 files changed, 58 insertions(+), 37 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Wed Jan 19 17:51:22 2011 -0800
+++ b/doc/ChangeLog	Wed Jan 19 20:29:11 2011 -0800
@@ -1,3 +1,12 @@
+2011-01-19  Rik  <octave@nomad.inbox5.com>
+
+	* doc/interpreter/diagperm.txi, doc/interpreter/dynamic.txi,
+	doc/interpreter/func.txi, doc/interpreter/install.txi,
+	doc/interpreter/intro.txi, doc/interpreter/numbers.txi,
+	doc/interpreter/oop.txi, doc/interpreter/plot.txi,
+	doc/interpreter/sparse.txi, doc/interpreter/stats.txi: Grammarcheck
+	txi files for 3.4 release.
+
 2011-01-17  Rik  <octave@nomad.inbox5.com>
 
 	* interpreter/quad.txi: Add quadcc to documentation.
--- a/doc/interpreter/diagperm.txi	Wed Jan 19 17:51:22 2011 -0800
+++ b/doc/interpreter/diagperm.txi	Wed Jan 19 20:29:11 2011 -0800
@@ -510,9 +510,9 @@
 all of these natural mathematical truths would be invalidated by treating
 assumed zeros as numerical ones.
 
-Note that @sc{Matlab} does not strictly follow this principle and converts
+Note that @sc{matlab} does not strictly follow this principle and converts
 assumed zeros to numerical zeros in certain cases, while not doing so in
-other cases. As of today, there are no intentions to mimic such behavior
+other cases.  As of today, there are no intentions to mimic such behavior
 in Octave.
 
 Examples of effects of assumed zeros vs. numerical zeros:
--- a/doc/interpreter/dynamic.txi	Wed Jan 19 17:51:22 2011 -0800
+++ b/doc/interpreter/dynamic.txi	Wed Jan 19 20:29:11 2011 -0800
@@ -1211,14 +1211,14 @@
 @cindex mex
 
 Octave includes an interface to allow legacy mex-files to be compiled
-and used with Octave. This interface can also be used to share code
-between Octave and @sc{Matlab} users. However, as mex-files expose the
-@sc{Matlab}'s internal API, and the internal structure of Octave is
+and used with Octave.  This interface can also be used to share code
+between Octave and @sc{matlab} users.  However, as mex-files expose the
+@sc{matlab}'s internal API, and the internal structure of Octave is
 different, a mex-file can never have the same performance in Octave as
-the equivalent oct-file. In particular to support the manner in which
+the equivalent oct-file.  In particular to support the manner in which
 mex-files access the variables passed to mex functions, there are a
 significant number of additional copies of memory when calling or
-returning from a mex function. For this reason, new code should be
+returning from a mex function.  For this reason, new code should be
 written using the oct-file interface discussed above if possible.
 
 @menu
@@ -1236,17 +1236,17 @@
 @subsection Getting Started with Mex-Files
 
 The basic command to build a mex-file is either @code{mkoctfile --mex}
-or @code{mex}. The first can either be used from within Octave or from
-the command line. However, to avoid issues with @sc{Matlab}'s own @code{mex}
+or @code{mex}.  The first can either be used from within Octave or from
+the command line.  However, to avoid issues with @sc{matlab}'s own @code{mex}
 command, the use of the command @code{mex} is limited to within Octave.
 
 @DOCSTRING(mex)
 
 @DOCSTRING(mexext)
 
-One important difference with the use of @code{mex} between @sc{Matlab} and
+One important difference with the use of @code{mex} between @sc{matlab} and
 Octave is that the header file "matrix.h" is implicitly included through
-the inclusion of "mex.h". This is to avoid a conflict with the Octave
+the inclusion of "mex.h".  This is to avoid a conflict with the Octave
 file "Matrix.h" with operating systems and compilers that don't
 distinguish between filenames in upper and lower case
 
@@ -1669,8 +1669,8 @@
 @section Standalone Programs
 
 The libraries Octave itself uses, can be utilized in standalone
-applications. These applications then have access, for example, to the
-array and matrix classes as well as to all the Octave algorithms. The
+applications.  These applications then have access, for example, to the
+array and matrix classes as well as to all the Octave algorithms.  The
 following C++ program, uses class Matrix from @file{liboctave.a} or
 @file{liboctave.so}.
 
--- a/doc/interpreter/func.txi	Wed Jan 19 17:51:22 2011 -0800
+++ b/doc/interpreter/func.txi	Wed Jan 19 20:29:11 2011 -0800
@@ -1219,6 +1219,7 @@
 
 Any regular function can be used as a command if it accepts string input
 arguments.  For example:
+
 @example
 @group
 toupper lower_case_arg
--- a/doc/interpreter/install.txi	Wed Jan 19 17:51:22 2011 -0800
+++ b/doc/interpreter/install.txi	Wed Jan 19 20:29:11 2011 -0800
@@ -335,10 +335,10 @@
 
 @itemize @bullet
 @item
-BLAS and LAPACK (@url{http://www.netlib.org/lapack})
+@sc{blas} and @sc{lapack} (@url{http://www.netlib.org/lapack})
 
 Reference versions for both libraries are included in the reference
-LAPACK 3.2.1 distribution from @url{netlib.org}.
+@sc{lapack} 3.2.1 distribution from @url{netlib.org}.
 
 @itemize @minus
 @item
@@ -349,11 +349,11 @@
 @item
 Once you have compiled this library make sure that you use it for
 compiling Suite Sparse and Octave.  In the following we assume that
-you installed the LAPACK library as $prefix64/lib/liblapack.a.
+you installed the @sc{lapack} library as $prefix64/lib/liblapack.a.
 @end itemize
 
 @item
-ARPACK (@url{http://www.caam.rice.edu/software/ARPACK})
+@sc{arpack} (@url{http://www.caam.rice.edu/software/ARPACK})
 
 @itemize @minus
 @item
@@ -361,7 +361,7 @@
 
 @example
 @group
-home=path to directory ARPACK
+home=path to directory @sc{arpack}
 FC=gfortran 
 FFLAGS=-fPIC -fdefault-integer-8
 MAKE=/usr/bin/make 
@@ -410,14 +410,14 @@
 
 @itemize @minus
 @item
-Add @option{-fdefault-integer-8} to @code{FFLAGS}.
+Add @option{-fdefault-integer-8} to @env{FFLAGS}.
 
 @item
-Adjust the BLAS and LAPACK variables as needed if your 64-bit aware BLAS
-and LAPACK libraries are in a non-standard location.
+Adjust the @sc{blas} and @sc{lapack} variables as needed if your 64-bit aware
+@sc{blas} and @sc{lapack} libraries are in a non-standard location.
 
 @item
-Set @code{PREFIX} to the top-level directory of your install tree.
+Set @env{PREFIX} to the top-level directory of your install tree.
 
 @item
 Run @code{make solib} to make a shared library.
@@ -432,7 +432,7 @@
 @itemize @minus
 @item
 In @file{UFconfig/UFconfig.mk} use the following options for
-@code{CFLAGS} and @code{F77FLAGS}:
+@env{CFLAGS} and @env{F77FLAGS}:
 
 @example
 @group
@@ -519,17 +519,18 @@
 done
 @end group
 @end example
+
 @end itemize
 
 @item
-ATLAS instead of reference BLAS and LAPACK
+ATLAS instead of reference @sc{blas} and @sc{lapack}
 
 Suggestions on how to compile ATLAS, will be most welcome.
 
 @item
-GLPK
+@sc{glpk}
 
-Suggestions on how to compile GLPK will be most welcome.
+Suggestions on how to compile @sc{glpk} will be most welcome.
 
 @item
 QHULL (@url{http://www.qhull.org})
@@ -555,7 +556,7 @@
 automatically set the Makefile variable @code{F77_INTEGER_8_FLAG} to 
 @option{-fdefault-integer-8}.  If you are using another compiler, you
 must set this variable yourself.  You should NOT set this flag in
-@code{FFLAGS}, otherwise the files in @file{libcruft/ranlib} will be
+@env{FFLAGS}, otherwise the files in @file{libcruft/ranlib} will be
 miscompiled.
 
 @item
@@ -567,14 +568,23 @@
 
 @itemize @minus
 @item pcre or regex
+
 @item zlib
+
 @item hdf5
+
 @item fftw3
+
 @item cURL
+
 @item GraphicsMagick++
+
 @item OpenGL
+
 @item freetype
+
 @item fontconfig
+
 @item fltk
 @end itemize
 
--- a/doc/interpreter/intro.txi	Wed Jan 19 17:51:22 2011 -0800
+++ b/doc/interpreter/intro.txi	Wed Jan 19 20:29:11 2011 -0800
@@ -633,7 +633,7 @@
 parentheses.  For example, here is the description for Octave's
 @code{cd} command:
 
-@deftypefn {Command} {} cd dir
+@deftypefn  {Command} {} cd dir
 @deftypefnx {Command} {} chdir dir
 Change the current working directory to @var{dir}.  For example,
 @kbd{cd ~/octave} changes the current working directory to
--- a/doc/interpreter/numbers.txi	Wed Jan 19 17:51:22 2011 -0800
+++ b/doc/interpreter/numbers.txi	Wed Jan 19 20:29:11 2011 -0800
@@ -394,13 +394,14 @@
 80,000 bytes of storage on a typical 32-bit workstation.
 
 A common example of when it does become necessary to convert ranges into
-vectors occurs when they appear within a vector (i.e. inside square
-brackets). For instance, whereas
+vectors occurs when they appear within a vector (i.e., inside square
+brackets).  For instance, whereas
 
 @example
 x = 0 : 0.1 : 1;
 @end example
 
+@noindent
 defines @var{x} to be a variable of type @code{range} and occupies 24
 bytes of memory, the expression
 
@@ -408,6 +409,7 @@
 y = [ 0 : 0.1 : 1];
 @end example
 
+@noindent
 defines @var{y} to be of type @code{matrix} and occupies 88 bytes of
 memory.
 
--- a/doc/interpreter/oop.txi	Wed Jan 19 17:51:22 2011 -0800
+++ b/doc/interpreter/oop.txi	Wed Jan 19 20:29:11 2011 -0800
@@ -421,7 +421,7 @@
 @node Function Overloading
 @subsection Function Overloading
 
-Any Octave function can be overloaded, and allows a object specific
+Any Octave function can be overloaded, and allows an object specific
 version of this function to be called as needed.  A pertinent example
 for our polynomial class might be to overload the @code{polyval} function
 like
--- a/doc/interpreter/plot.txi	Wed Jan 19 17:51:22 2011 -0800
+++ b/doc/interpreter/plot.txi	Wed Jan 19 20:29:11 2011 -0800
@@ -921,8 +921,8 @@
 @code{get (h, "")}.
 
 Thus, for example,
+
 @smallexample
-@group
 h = figure ();
 get (h, "type")
 ans = figure
@@ -947,7 +947,6 @@
 currentpoint           nextplot               selectionhighlight     xvisualmode
 currentaxes            numbertitle            selectiontype
 currentcharacter       paperorientation       tag
-@end group
 @end smallexample
 
 The root figure has index 0.  Its properties may be displayed by:
--- a/doc/interpreter/sparse.txi	Wed Jan 19 17:51:22 2011 -0800
+++ b/doc/interpreter/sparse.txi	Wed Jan 19 20:29:11 2011 -0800
@@ -781,7 +781,7 @@
 @item If the matrix is upper or lower triangular perform a sparse forward
 or backward substitution, and goto 8
 
-@item If the matrix is a upper triangular matrix with column permutations
+@item If the matrix is an upper triangular matrix with column permutations
 or lower triangular matrix with row permutations, perform a sparse forward 
 or backward substitution, and goto 8
 
@@ -933,7 +933,7 @@
 @end ifnottex
 into simplexes (triangles in 2D, pyramids in 3D).
 @ifset htmltex
-We take as an 3D example a cylindrical liquid filled tank with a small 
+We take as a 3-D example a cylindrical liquid filled tank with a small 
 non-conductive ball from the EIDORS project@footnote{EIDORS - Electrical 
 Impedance Tomography and Diffuse optical Tomography Reconstruction Software 
 @url{http://eidors3d.sourceforge.net}}.  This is model is designed to reflect
@@ -943,7 +943,7 @@
 vertices @code{nodes} and simplices @code{elems}.
 @end ifset
 
-The following example creates a simple rectangular 2D electrically
+The following example creates a simple rectangular 2-D electrically
 conductive medium with 10 V and 20 V imposed on opposite sides 
 (Dirichlet boundary conditions).  All other edges are electrically
 isolated.
--- a/doc/interpreter/stats.txi	Wed Jan 19 17:51:22 2011 -0800
+++ b/doc/interpreter/stats.txi	Wed Jan 19 20:29:11 2011 -0800
@@ -23,7 +23,7 @@
 basic descriptive statistics, probability distributions, statistical tests, 
 random number generation, and much more.
 
-The functions that analyze data all assume that multidimensional data
+The functions that analyze data all assume that multi-dimensional data
 is arranged in a matrix where each row is an observation, and each
 column is a variable.  Thus, the matrix defined by