# HG changeset patch
# User Carnë Draug <address@hidden>
# Date 1304338056 -3600
# Node ID 34cb540c6735c5f03b3e712a4aff4cd83b591988
# Parent  fd367312095a1fb550a904801ba72fba3d40ebf0
Help text for operators changed to texinfo.

Added help text about block comments, line continuation and element by element left division.

Also added more functions on the seealso field of the operators help text.

diff -r fd367312095a -r 34cb540c6735 src/help.cc
--- a/src/help.cc	Tue Apr 05 11:15:50 2011 +0200
+++ b/src/help.cc	Mon May 02 13:07:36 2011 +0100
@@ -99,133 +99,331 @@
   return z;
 }
 
-// FIXME -- The descriptions could easily be in texinfo -- should they?
 const static pair_type operators[] =
 {
   pair_type ("!",
-    "Logical not operator.  See also `~'.\n"),
+    "-*- texinfo -*-\n\
address@hidden Operator !\n\
+Logical 'not' operator.\n\
address@hidden, not}\n\
address@hidden deffn"),
+
+  pair_type ("~",
+    "-*- texinfo -*-\n\
address@hidden Operator ~\n\
+Logical 'not' operator.\n\
address@hidden, not}\n\
address@hidden deffn"),
 
   pair_type ("!=",
-    "Logical not equals operator.  See also `~='.\n"),
+    "-*- texinfo -*-\n\
address@hidden Operator !=\n\
+Logical 'not equals' operator.\n\
address@hidden, ne}\n\
address@hidden deffn"),
+
+  pair_type ("~=",
+    "-*- texinfo -*-\n\
address@hidden Operator ~=\n\
+Logical 'not equals' operator.\n\
address@hidden, ne}\n\
address@hidden deffn"),
 
   pair_type ("\"",
-    "String delimiter.\n"),
+    "-*- texinfo -*-\n\
address@hidden Operator \"\n\
+String delimiter.\n\
address@hidden deffn"),
 
   pair_type ("#",
-    "Begin comment character.  See also `%'."),
+    "-*- texinfo -*-\n\
address@hidden Operator #\n\
+Begin comment character.\n\
address@hidden, address@hidden
address@hidden deffn"),
 
   pair_type ("%",
-    "Begin comment charcter.  See also `#'."),
+    "-*- texinfo -*-\n\
address@hidden Operator %\n\
+Begin comment character.\n\
address@hidden, address@hidden
address@hidden deffn"),
+
+  pair_type ("#{",
+    "-*- texinfo -*-\n\
address@hidden Operator address@hidden
+Begin block comment. There must be nothing else other than\n\
+whitespace in the line, both before and after @address@hidden Also,\n\
+it is possible to nest block comments.\n\
address@hidden, address@hidden, address@hidden
address@hidden deffn"),
+
+  pair_type ("%{",
+    "-*- texinfo -*-\n\
address@hidden Operator address@hidden
+Begin block comment. There must be nothing else other than\n\
+whitespace in the line, both before and after @address@hidden Also,\n\
+it is possible to nest block comments.\n\
address@hidden, address@hidden, address@hidden
address@hidden deffn"),
+
+  pair_type ("#}",
+    "-*- texinfo -*-\n\
address@hidden Operator address@hidden
+Close block comment. There must be nothing else other than\n\
+whitespace in the line, both before and after @address@hidden Also,\n\
+it is possible to nest block comments.\n\
address@hidden, address@hidden, address@hidden
address@hidden deffn"),
+
+  pair_type ("%}",
+    "-*- texinfo -*-\n\
address@hidden Operator address@hidden
+Close block comment. There must be nothing else other than\n\
+whitespace in the line, both before and after @address@hidden Also,\n\
+it is possible to nest block comments.\n\
address@hidden, address@hidden, address@hidden
address@hidden deffn"),
+
+  pair_type ("...",
+    "-*- texinfo -*-\n\
address@hidden Operator ...\n\
+Continuation marker. Joins current line with following line.\n\
address@hidden deffn"),
 
   pair_type ("&",
-    "Element by element logical and operator.  See also `&&'."),
+    "-*- texinfo -*-\n\
address@hidden Operator &\n\
+Element by element logical 'and' operator.\n\
address@hidden&&, and}\n\
address@hidden deffn"),
 
   pair_type ("&&",
-    "Logical and operator (with short-circuit evaluation).  See also `&'."),
+    "-*- texinfo -*-\n\
address@hidden Operator &&\n\
+Logical 'and' operator (with short-circuit evaluation).\n\
address@hidden&, and}\n\
address@hidden deffn"),
 
   pair_type ("'",
-    "Matrix transpose operator.  For complex matrices, computes the\n\
-complex conjugate (Hermitian) transpose.  See also `.''\n\
+    "-*- texinfo -*-\n\
address@hidden Operator '\n\
+Matrix transpose operator. For complex matrices, computes the\n\
+complex conjugate (Hermitian) transpose.\n\
 \n\
 The single quote character may also be used to delimit strings, but\n\
 it is better to use the double quote character, since that is never\n\
-ambiguous"),
+ambiguous\n\
address@hidden', transpose}\n\
address@hidden deffn"),
 
   pair_type ("(",
-    "Array index or function argument delimiter."),
+    "-*- texinfo -*-\n\
address@hidden Operator (\n\
+Array index or function argument delimiter.\n\
address@hidden deffn"),
 
   pair_type (")",
-    "Array index or function argument delimiter."),
+    "-*- texinfo -*-\n\
address@hidden Operator )\n\
+Array index or function argument delimiter.\n\
address@hidden deffn"),
 
   pair_type ("*",
-    "Multiplication operator.  See also `.*'"),
+    "-*- texinfo -*-\n\
address@hidden Operator *\n\
+Multiplication operator.\n\
address@hidden, times}\n\
address@hidden deffn"),
 
   pair_type ("**",
-    "Power operator.  See also `^', `.**', and `.^'"),
+    "-*- texinfo -*-\n\
address@hidden Operator **\n\
+Power operator.\n\
address@hidden, ^, .**, .^}\n\
address@hidden deffn"),
+
+  pair_type ("^",
+    "-*- texinfo -*-\n\
address@hidden Operator ^\n\
+Power operator.\n\
address@hidden, **, .^, .**}\n\
address@hidden deffn"),
 
   pair_type ("+",
-    "Addition operator."),
+    "-*- texinfo -*-\n\
address@hidden Operator +\n\
+Addition operator.\n\
address@hidden
address@hidden deffn"),
 
   pair_type ("++",
-    "Increment operator.  As in C, may be applied as a prefix or postfix\n\
-operator."),
+    "-*- texinfo -*-\n\
address@hidden Operator ++\n\
+Increment operator. As in C, may be applied as a prefix or postfix\n\
+operator.\n\
address@hidden
address@hidden deffn"),
 
   pair_type (",",
-    "Array index, function argument, or command separator."),
+    "-*- texinfo -*-\n\
address@hidden Operator ,\n\
+Array index, function argument, or command separator.\n\
address@hidden deffn"),
 
   pair_type ("-",
-    "Subtraction or unary negation operator."),
+    "-*- texinfo -*-\n\
address@hidden Operator -\n\
+Subtraction or unary negation operator.\n\
address@hidden
address@hidden deffn"),
 
   pair_type ("--",
-    "Decrement operator.  As in C, may be applied as a prefix or postfix\n\
-operator."),
+    "-*- texinfo -*-\n\
address@hidden Operator --\n\
+Decrement operator. As in C, may be applied as a prefix or postfix\n\
+operator.\n\
address@hidden
address@hidden deffn"),
 
   pair_type (".'",
-    "Matrix transpose operator.  For complex matrices, computes the\n\
-transpose, *not* the complex conjugate transpose.  See also `''."),
+    "-*- texinfo -*-\n\
address@hidden Operator .'\n\
+Matrix transpose operator. For complex matrices, computes the\n\
+transpose, @emph{not} the complex conjugate transpose.\n\
address@hidden', transpose}\n\
address@hidden deffn"),
 
   pair_type (".*",
-    "Element by element multiplication operator.  See also `*'."),
+    "-*- texinfo -*-\n\
address@hidden Operator .*\n\
+Element by element multiplication operator.\n\
address@hidden, times}\n\
address@hidden deffn"),
 
   pair_type (".**",
-    "Element by element power operator.  See also `**', `^', and `.^'."),
+    "-*- texinfo -*-\n\
address@hidden Operator .*\n\
+Element by element power operator.\n\
address@hidden, ^, .^, power}\n\
address@hidden deffn"),
+
+  pair_type (".^",
+    "-*- texinfo -*-\n\
address@hidden Operator .^\n\
+Element by element power operator.\n\
address@hidden, ^, **, power}\n\
address@hidden deffn"),
 
   pair_type ("./",
-    "Element by element division operator.  See also `/' and `\\'."),
-
-  pair_type (".^",
-    "Element by element power operator.  See also `**', `^', and `.^'."),
+    "-*- texinfo -*-\n\
address@hidden Operator ./\n\
+Element by element right division operator.\n\
address@hidden/, .\\, rdivide, mrdivide}\n\
address@hidden deffn"),
 
   pair_type ("/",
-    "Right division.  See also `\\' and `./'."),
+    "-*- texinfo -*-\n\
address@hidden Operator /\n\
+Right division operator.\n\
address@hidden/, \\, rdivide, mrdivide}\n\
address@hidden deffn"),
+
+  pair_type (".\\",
+    "-*- texinfo -*-\n\
address@hidden Operator .\\\n\
+Element by element left division operator.\n\
address@hidden, ./, rdivide, mrdivide}\n\
address@hidden deffn"),
+
+  pair_type ("\\",
+    "-*- texinfo -*-\n\
address@hidden Operator \\\n\
+Left division operator.\n\
address@hidden, /, ldivide, mldivide}\n\
address@hidden deffn"),
 
   pair_type (":",
-    "Select entire rows or columns of matrices."),
+    "-*- texinfo -*-\n\
address@hidden Operator :\n\
+Select entire rows or columns of matrices.\n\
address@hidden deffn"),
 
   pair_type (";",
-    "Array row or command separator.  See also `,'."),
+    "-*- texinfo -*-\n\
address@hidden Operator ;\n\
+Array row or command separator.\n\
address@hidden,}\n\
address@hidden deffn"),
 
   pair_type ("<",
-    "Less than operator."),
+    "-*- texinfo -*-\n\
address@hidden Operator <\n\
+'Less than' operator.\n\
address@hidden
address@hidden deffn"),
 
   pair_type ("<=",
-    "Less than or equals operator."),
+    "-*- texinfo -*-\n\
address@hidden Operator <=\n\
+'Less than' or 'equals' operator.\n\
address@hidden
address@hidden deffn"),
 
   pair_type ("=",
-    "Assignment operator."),
+    "-*- texinfo -*-\n\
address@hidden Operator =\n\
+Assignment operator.\n\
address@hidden deffn"),
 
   pair_type ("==",
-    "Equality test operator."),
+    "-*- texinfo -*-\n\
address@hidden Operator ==\n\
+Equality test operator.\n\
address@hidden
address@hidden deffn"),
 
   pair_type (">",
-    "Greater than operator."),
+    "-*- texinfo -*-\n\
address@hidden Operator >\n\
+'Greater than' operator.\n\
address@hidden
address@hidden deffn"),
 
   pair_type (">=",
-    "Greater than or equals operator."),
+    "-*- texinfo -*-\n\
address@hidden Operator >=\n\
+'Greater than' or 'equals' operator.\n\
address@hidden
address@hidden deffn"),
 
   pair_type ("[",
-    "Return list delimiter.  See also `]'."),
-
-  pair_type ("\\",
-    "Left division operator.  See also `/' and `./'."),
+    "-*- texinfo -*-\n\
address@hidden Operator [\n\
+Return list delimiter.\n\
address@hidden
address@hidden deffn"),
 
   pair_type ("]",
-    "Return list delimiter.  See also `['."),
-
-  pair_type ("^",
-    "Power operator.  See also `**', `.^', and `.**.'"),
+    "-*- texinfo -*-\n\
address@hidden Operator ]\n\
+Return list delimiter.\n\
address@hidden
address@hidden deffn"),
 
   pair_type ("|",
-    "Element by element logical or operator.  See also `||'."),
+    "-*- texinfo -*-\n\
address@hidden Operator |\n\
+Element by element logical 'or' operator.\n\
address@hidden||, or}\n\
address@hidden deffn"),
 
   pair_type ("||",
-    "Logical or operator (with short-circuit evaluation).  See also `|'."),
-
-  pair_type ("~",
-    "Logical not operator.  See also `!' and `~'."),
-
-  pair_type ("~=",
-    "Logical not equals operator.  See also `!='."),
+    "-*- texinfo -*-\n\
address@hidden Operator ||\n\
+Logical 'or' (with short-circuit evaluation) operator.\n\
address@hidden|, or}\n\
address@hidden deffn"),
 };
 
 const static pair_type keywords[] =