changeset 9153:5247e89688e1

Eliminate most overfull errors when running texi2pdf for generating pdf documentation Use @smallexample when necessary to reduce font for long lines. Reword variables or phrases so that Tex can break them at a better spot.
author Rik <rdrider0-list@yahoo.com>
date Fri, 24 Apr 2009 12:29:01 -0700
parents 4c9aff0c9a61
children 761fc0d3d980
files doc/ChangeLog doc/interpreter/basics.txi doc/interpreter/expr.txi scripts/general/cplxpair.m scripts/miscellaneous/edit.m scripts/miscellaneous/intwarning.m scripts/optimization/fsolve.m scripts/pkg/pkg.m scripts/plot/pareto.m scripts/polynomial/compan.m scripts/signal/arch_rnd.m src/DLD-FUNCTIONS/betainc.cc src/DLD-FUNCTIONS/filter.cc src/error.cc src/load-save.cc src/mappers.cc src/variables.cc
diffstat 17 files changed, 33 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Thu Apr 23 20:04:29 2009 -0400
+++ b/doc/ChangeLog	Fri Apr 24 12:29:01 2009 -0700
@@ -1,3 +1,10 @@
+2009-04-24  Rik  <rdrider0-list@yahoo.com>
+	* interpreter/octave.pdf: 
+	Eliminate most overfull errors when running texi2pdf for generating 
+	pdf documentation.
+	Use @smallexample when necessary to reduce font for long lines.
+	Reword variables or phrases so that Tex can break them at a better spot.
+
 2009-04-21  Rik  <rdrider0-list@yahoo.com>
 	* interpreter/octave.pdf: Eliminate 'unbalanced parentheses in @def...'
 	error during texi2pdf.  Fixed four .m files incorrectly using @deftypefn 
--- a/doc/interpreter/basics.txi	Thu Apr 23 20:04:29 2009 -0400
+++ b/doc/interpreter/basics.txi	Fri Apr 24 12:29:01 2009 -0700
@@ -818,14 +818,13 @@
 @noindent
 Octave will respond with
 
-@c Using 'smallexample' to make text fit on page when creating smallbook.
-@smallexample
+@example
 @group
 error: `x' undefined near line 1 column 24
 error: called from:
 error:   f at line 1, column 22
 @end group
-@end smallexample
+@end example
 
 @noindent
 This error message has several parts, and gives quite a bit of
--- a/doc/interpreter/expr.txi	Thu Apr 23 20:04:29 2009 -0400
+++ b/doc/interpreter/expr.txi	Fri Apr 24 12:29:01 2009 -0700
@@ -939,11 +939,10 @@
 not exceed the number of values on the right side.  For example, the
 following will produce an error.
 
-@c Using 'smallexample' to make text fit on page when creating smallbook.
-@smallexample
+@example
 [a, b, c, d] = [u, s, v] = svd (a);
 @print{} error: element number 4 undefined in return list
-@end smallexample
+@end example
 
 @opindex +=
 A very common programming pattern is to increment an existing variable
--- a/scripts/general/cplxpair.m	Thu Apr 23 20:04:29 2009 -0400
+++ b/scripts/general/cplxpair.m	Fri Apr 24 12:29:01 2009 -0700
@@ -37,7 +37,7 @@
 ## error.  Note that there are no guarantees on the order of the returned
 ## pairs with identical real parts but differing imaginary parts.
 ##
-## @c Using 'smallexample' to make text fit in page when using 'smallbook'
+## @c Set example in small font to prevent overfull line
 ## @smallexample
 ## cplxpair (exp(2i*pi*[0:4]'/5)) == exp(2i*pi*[3; 2; 4; 1; 0]/5)
 ## @end smallexample
--- a/scripts/miscellaneous/edit.m	Thu Apr 23 20:04:29 2009 -0400
+++ b/scripts/miscellaneous/edit.m	Fri Apr 24 12:29:01 2009 -0700
@@ -87,9 +87,10 @@
 ## 
 ## On Cygwin, you will need to convert the Cygwin path to a Windows
 ## path if you are using a native Windows editor.  For example
-## @example
+## @c Set example in small font to prevent overfull line
+## @smallexample
 ## '"C:/Program Files/Good Editor/Editor.exe" "$(cygpath -wa %s)"'
-## @end example
+## @end smallexample
 ##
 ## @item home
 ## This is the location of user local m-files.  Be be sure it is in your
--- a/scripts/miscellaneous/intwarning.m	Thu Apr 23 20:04:29 2009 -0400
+++ b/scripts/miscellaneous/intwarning.m	Fri Apr 24 12:29:01 2009 -0700
@@ -30,6 +30,7 @@
 ## Otherwise it is returned in a structure with the fields "identifier"
 ## and "state".
 ##
+## @c Set example in small font to prevent overfull line
 ## @smallexample
 ## @group
 ## intwarning ("query")
--- a/scripts/optimization/fsolve.m	Thu Apr 23 20:04:29 2009 -0400
+++ b/scripts/optimization/fsolve.m	Fri Apr 24 12:29:01 2009 -0700
@@ -92,7 +92,7 @@
 ##
 ## @example
 ## @group
-## function [fvec, fjac] = my_optim_func (x, optimvalues, state)
+## function [fvec, fjac] = user_func (x, optimvalues, state)
 ## persistent sav = [], sav0 = [];
 ## if (nargin == 1)
 ##   ## evaluation call
@@ -113,7 +113,7 @@
 ##
 ## ## @dots{}.
 ## 
-## fsolve (@@my_optim_func, x0, optimset ("OutputFcn", @@my_optim_func, @dots{}))
+## fsolve (@@user_func, x0, optimset ("OutputFcn", @@user_func, @dots{}))
 ## @end group
 ## @end example
 ###
--- a/scripts/pkg/pkg.m	Thu Apr 23 20:04:29 2009 -0400
+++ b/scripts/pkg/pkg.m	Fri Apr 24 12:29:01 2009 -0700
@@ -143,7 +143,7 @@
 ## independent specified with an addition argument.  For example
 ##
 ## @example
-## pkg prefix ~/my_octave_packages ~/my_octave_packages_for_my_pc
+## pkg prefix ~/my_octave_packages ~/my_arch_dep_pkgs
 ## @end example
 ## @item local_list
 ## Set the file in which to look for information on the locally
--- a/scripts/plot/pareto.m	Thu Apr 23 20:04:29 2009 -0400
+++ b/scripts/plot/pareto.m	Fri Apr 24 12:29:01 2009 -0700
@@ -45,8 +45,8 @@
 ##
 ## @example
 ## @group
-## Cheese = @{"Cheddar", "Swiss", "Camembert", "Munster", "Stilton", @dots{}
-##    "Blue"@};
+## Cheese = @{"Cheddar", "Swiss", "Camembert", ...
+##           "Munster", "Stilton", "Blue"@};
 ## Sold = [105, 30, 70, 10, 15, 20];
 ## pareto(Sold, Cheese);
 ## @end group
--- a/scripts/polynomial/compan.m	Thu Apr 23 20:04:29 2009 -0400
+++ b/scripts/polynomial/compan.m	Fri Apr 24 12:29:01 2009 -0700
@@ -37,6 +37,7 @@
 ## @end iftex
 ## @ifnottex
 ##
+## @c Set example in small font to prevent overfull line
 ## @smallexample
 ##      _                                                        _
 ##     |  -c(2)/c(1)   -c(3)/c(1)  @dots{}  -c(N)/c(1)  -c(N+1)/c(1)  |
--- a/scripts/signal/arch_rnd.m	Thu Apr 23 20:04:29 2009 -0400
+++ b/scripts/signal/arch_rnd.m	Fri Apr 24 12:29:01 2009 -0700
@@ -23,6 +23,7 @@
 ## coefficients @var{b} and CH coefficients @var{a}.  I.e., the result
 ## @math{y(t)} follows the model
 ##
+## @c Set example in small font to prevent overfull line
 ## @smallexample
 ## y(t) = b(1) + b(2) * y(t-1) + @dots{} + b(lb) * y(t-lb+1) + e(t),
 ## @end smallexample
@@ -31,6 +32,7 @@
 ## where @math{e(t)}, given @var{y} up to time @math{t-1}, is
 ## @math{N(0, h(t))}, with
 ##
+## @c Set example in small font to prevent overfull line
 ## @smallexample
 ## h(t) = a(1) + a(2) * e(t-1)^2 + @dots{} + a(la) * e(t-la+1)^2
 ## @end smallexample
--- a/src/DLD-FUNCTIONS/betainc.cc	Thu Apr 23 20:04:29 2009 -0400
+++ b/src/DLD-FUNCTIONS/betainc.cc	Fri Apr 24 12:29:01 2009 -0700
@@ -46,6 +46,7 @@
 @end iftex\n\
 @ifnottex\n\
 \n\
+@c Set example in small font to prevent overfull line\n\
 @smallexample\n\
                                       x\n\
                                      /\n\
--- a/src/DLD-FUNCTIONS/filter.cc	Thu Apr 23 20:04:29 2009 -0400
+++ b/src/DLD-FUNCTIONS/filter.cc	Fri Apr 24 12:29:01 2009 -0700
@@ -296,6 +296,7 @@
 @end iftex\n\
 @ifnottex\n\
 \n\
+@c Set example in small font to prevent overfull line\n\
 @smallexample\n\
    N                   M\n\
   SUM a(k+1) y(n-k) = SUM b(k+1) x(n-k)      for 1<=n<=length(x)\n\
@@ -325,6 +326,7 @@
 @end iftex\n\
 @ifnottex\n\
 \n\
+@c Set example in small font to prevent overfull line\n\
 @smallexample\n\
             N                   M\n\
   y(n) = - SUM c(k+1) y(n-k) + SUM d(k+1) x(n-k)  for 1<=n<=length(x)\n\
--- a/src/error.cc	Thu Apr 23 20:04:29 2009 -0400
+++ b/src/error.cc	Fri Apr 24 12:29:01 2009 -0700
@@ -940,7 +940,7 @@
 calling the function @code{f} will result in a list of messages that\n\
 can help you to quickly locate the exact location of the error:\n\
 \n\
-@smallexample\n\
+@example\n\
 @group\n\
 f ()\n\
 error: nargin != 1\n\
@@ -950,7 +950,7 @@
 error:   g at line 1, column 15\n\
 error:   f at line 1, column 15\n\
 @end group\n\
-@end smallexample\n\
+@end example\n\
 \n\
 If the error message ends in a new line character, Octave will print the\n\
 message but will not display any traceback messages as it returns\n\
--- a/src/load-save.cc	Thu Apr 23 20:04:29 2009 -0400
+++ b/src/load-save.cc	Fri Apr 24 12:29:01 2009 -0700
@@ -1821,6 +1821,7 @@
 the header comment is omitted from text-format data files.  The\n\
 default value is\n\
 \n\
+@c Set example in small font to prevent overfull line\n\
 @smallexample\n\
 \"# Created by Octave VERSION, %a %b %d %H:%M:%S %Y %Z <USER@@HOST>\"\n\
 @end smallexample\n\
--- a/src/mappers.cc	Thu Apr 23 20:04:29 2009 -0400
+++ b/src/mappers.cc	Fri Apr 24 12:29:01 2009 -0700
@@ -509,13 +509,13 @@
 @end iftex\n\
 @ifnottex\n\
 \n\
-@smallexample\n\
+@example\n\
                          z\n\
                         /\n\
 erf (z) = (2/sqrt (pi)) | e^(-t^2) dt\n\
                         /\n\
                      t=0\n\
-@end smallexample\n\
+@end example\n\
 @end ifnottex\n\
 @seealso{erfc, erfinv}\n\
 @end deftypefn")
--- a/src/variables.cc	Thu Apr 23 20:04:29 2009 -0400
+++ b/src/variables.cc	Fri Apr 24 12:29:01 2009 -0700
@@ -2226,6 +2226,7 @@
 \n\
 A command is composed like this:\n\
 \n\
+@c Set example in small font to prevent overfull line\n\
 @smallexample\n\
 %[modifier]<command>[:size_of_parameter[:center-specific[:balance]]];\n\
 @end smallexample\n\