changeset 12470:36a9006609c3 octave-forge

Update texinfo headers for gnumeric support
author prnienhuis
date Thu, 01 May 2014 21:14:09 +0000
parents 85c6ea0f9dcf
children e028b3cdf4cb
files main/io/inst/odsopen.m main/io/inst/odswrite.m main/io/inst/xlsopen.m main/io/inst/xlsread.m main/io/inst/xlswrite.m
diffstat 5 files changed, 15 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/main/io/inst/odsopen.m	Thu May 01 21:03:03 2014 +0000
+++ b/main/io/inst/odsopen.m	Thu May 01 21:14:09 2014 +0000
@@ -24,7 +24,7 @@
 ## Calling odsopen without specifying a return argument is fairly useless!
 ##
 ## Octave links to external software for read/write support of spreadsheets;
-## these links are "interfaces". For I/O from/to ODS 1.2 and reading Gnumeric
+## these links are "interfaces". For I/O from/to ODS 1.2 and Gnumeric
 ## XML, in principle no external SW is required, this "interface" is called
 ## 'OCT'. For more flexibility and better performance, you need a Java JRE
 ## or JDK plus one or more of (ODFtoolkit (version 0.7.5 or 0.8.6 - 0.8.8) &
@@ -49,8 +49,8 @@
 ## Optional input argument @var{reqintf} can be used to override the ODS
 ## interface automatically selected by odsopen. Currently implemented
 ## interfaces are 'OTK' (Java/ODF Toolkit), 'JOD' (Java/jOpenDocument), 'UNO'
-## (Java/OpenOffice.org UNO bridge), and 'OCT' (native Octave, for Gnumeric
-## only reading). In most situations this parameter is unneeded as odsopen
+## (Java/OpenOffice.org UNO bridge), and 'OCT' (native Octave, for Gnumeric.
+## In most situations this parameter is unneeded as odsopen
 ## automatically selects the most useful interface present ("default
 ## interface"). Depending on file type, odsopen.m can invoke other detected
 ## interfaces than the default one.
--- a/main/io/inst/odswrite.m	Thu May 01 21:03:03 2014 +0000
+++ b/main/io/inst/odswrite.m	Thu May 01 21:14:09 2014 +0000
@@ -19,7 +19,8 @@
 ## @deftypefnx {Function File} @var{rstatus} = odswrite (@var{filename}, @var{arr}, @var{wsh}, @var{range})
 ## @deftypefnx {Function File} @var{rstatus} = odswrite (@var{filename}, @var{arr}, @var{wsh}, @var{range}, @var{reqintf})
 ## Add data in 1D/2D array @var{arr} into sheet @var{wsh} in
-## OpenOffice_org Calc spreadsheet file @var{filename} in cell range @var{range}.
+## OpenOffice_org Calc spreadsheet file @var{filename} in cell range
+## @var{range}. Gnumeric files can also be written.
 ##
 ## @var{rstatus} returns 1 if write succeeded, 0 otherwise.
 ##
@@ -59,7 +60,9 @@
 ## The optional last argument @var{reqintf} can be used to override 
 ## the automatic selection by odswrite of one interface out of the
 ## supported ones: Java/ODFtooolkit ('OTK'), Java/jOpenDocument ('JOD'),
-## Java/OpenOffice.org ('UNO'), or native Octave ('OCT').
+## Java/OpenOffice.org ('UNO'), or native Octave ('OCT'). For writing
+## gnumeric, the OCT interface is automatically selected and need not
+## be specified.
 ##
 ## odswrite is a mere wrapper for various scripts which find out what
 ## ODS interface to use (ODF toolkit, jOpenDocument, Open/LibreOffice or
--- a/main/io/inst/xlsopen.m	Thu May 01 21:03:03 2014 +0000
+++ b/main/io/inst/xlsopen.m	Thu May 01 21:14:09 2014 +0000
@@ -25,7 +25,7 @@
 ## Calling xlsopen without specifying a return argument is fairly useless!
 ##
 ## xlsopen works with interfaces, which are links to external software.
-## For I/O from OOXML (Excel 2007 and up), ODS 1.2 and Gnumeric, no
+## For I/O from/to OOXML (Excel 2007 and up), ODS 1.2 and Gnumeric, no
 ## additional software is required when the OCT interface is used (see below).
 ## For all other spreadsheet formats, you need one or more of MS-Excel
 ## (95 - 2013), or a Java JRE plus Apache POI >= 3.5 and/or JExcelAPI
--- a/main/io/inst/xlsread.m	Thu May 01 21:03:03 2014 +0000
+++ b/main/io/inst/xlsread.m	Thu May 01 21:14:09 2014 +0000
@@ -21,7 +21,8 @@
 ## @deftypefnx {Function File} [@var{numarr}, @var{txtarr}, @var{rawarr}, @var{limits}] = xlsread (@var{filename}, @var{wsh}, @var{range}, @var{reqintf})
 ##
 ## Read data contained in range @var{range} from worksheet @var{wsh}
-## in Excel spreadsheet file @var{filename}.
+## in Excel spreadsheet file @var{filename}. Gnumeric files can also
+## be read.
 ## Return argument @var{numarr} contains the numeric data, optional
 ## return arguments @var{txtarr} and @var{rawarr} contain text strings
 ## and the raw spreadsheet cell data, respectively. Return argument
--- a/main/io/inst/xlswrite.m	Thu May 01 21:03:03 2014 +0000
+++ b/main/io/inst/xlswrite.m	Thu May 01 21:14:09 2014 +0000
@@ -19,7 +19,8 @@
 ## @deftypefnx {Function File} @var{rstatus} = xlswrite (@var{filename}, @var{arr}, @var{wsh}, @var{range})
 ## @deftypefnx {Function File} @var{rstatus} = xlswrite (@var{filename}, @var{arr}, @var{wsh}, @var{range}, @var{reqintf})
 ## Add data in 1D/2D array @var{arr} to worksheet @var{wsh} in Excel
-## spreadsheet file @var{filename} in cell range @var{range}.
+## spreadsheet file @var{filename} in cell range @var{range}. Gnumeric
+## files can also be written.
 ##
 ## @var{rstatus} returns 1 if write succeeded, 0 otherwise.
 ##
@@ -72,7 +73,8 @@
 ## (.xlsx) a value of 'com', 'poi', 'uno', or 'oct' must
 ## be specified for @var{reqintf}. The value of @var{reqintf} is
 ## case-insensitive. Multiple interfaces can be selected if entered as
-## a cell array of strings.
+## a cell array of strings. Writing gnumeric files can only be done
+## with the OCT interface, selected automatically for those files.
 ##
 ## xlswrite is a mere wrapper for various scripts which find out what
 ## Excel interface to use (COM, POI, etc) plus code to mimic the other