macroSplit-docs.patch

   1 Subject: documentation for the macroSplit patch
   2
   3 ---
   4
   5  doc/help.etx |   13 ++++++++++++-
   6  1 file changed, 12 insertions(+), 1 deletion(-)
   7
   8 diff --quilt old/doc/help.etx new/doc/help.etx
   9 --- old/doc/help.etx
  10 +++ new/doc/help.etx
  11 @@ -2699,10 +2699,21 @@ Macro Subroutines
  12    exit status is returned in the global variable $shell_cmd_status. If the
  13    input_string is ommited or is "" the shell command get no input.
  14
  15 -**split(string, separation_string [, search_type])**
  16 +**split( string, separation_string [, search_type] [, count] [, "lastnotnull"] )**
  17    Splits a string using the separator specified. Optionally the search_type
  18    argument can specify how the separation_string is interpreted. The default
  19    is "literal". The returned value is an array with keys beginning at 0.
  20 +  count: maximum number of pieces in the returned array (default is
  21 +         infinite, must be greater than zero); if smaller than or equal to
  22 +         the number of separators found in string, the last piece will
  23 +         contain the remainder of the string to split (a count of 1 produces
  24 +         a single result in the returned array, equal to the original
  25 +         string).
  26 +  "lastnotnull": if present, this stops an empty string being
  27 +         returned in the last entry of the array if the string to split ends
  28 +         with the separator. This has the effect of returning an empty array
  29 +         if the string to split is originally empty. Otherwise, the returned
  30 +         array will always contain at least one element.
  31
  32  **string_dialog( message, btn_1_label, btn_2_label, ... )**
  33    Pops up a dialog prompting the user to enter information. The first argument