Commit 0e7df93b authored by Andreas J. Guelzow 's avatar Andreas J. Guelzow

update documentation

2011-11-30  Andreas J. Guelzow <aguelzow@pyrshep.ca>

	* doc/C/files-formats.xml: update
	* func.defs: update
	* functions.xml: update
parent e109f1db
......@@ -5,8 +5,6 @@ issues that need to be addressed. Divided into, things that will prevent
release, and longer term bugs.
-------------------------------------------------------------------------------
For 1.10
- Bump libgsf version req and de-conditionalize xlsx pivot import.
Release Critical
----------------
......@@ -511,8 +509,6 @@ Architecture Changes
36) OpenDocument (ODF)
36.2) Import
36.2.1) We fail to do proper white space handling on import, see
5.1.1 of the OpenDocument Standard.
36.2.4) col/row manual vs auto
36.5) See 12.6 (Input Messages)
36.7) See 22.13 (Validation)
......
2011-11-30 Andreas J. Guelzow <aguelzow@pyrshep.ca>
* doc/C/files-formats.xml: update
* func.defs: update
* functions.xml: update
2011-11-27 Morten Welinder <terra@gnome.org>
* Release 1.11.1
......
......@@ -114,7 +114,7 @@
<entry><link linkend="file-format-excel-moox">Microsoft Office Open SpreadsheetML (MOOX/ECMA376/ISO29500)</link></entry>
<entry><literal>.xlsx</literal></entry>
<entry>YES</entry>
<entry>YES (incomplete)</entry>
<entry>YES</entry>
<entry>application/vnd.ms-excel</entry>
</row>
<row>
......@@ -126,10 +126,10 @@
<entry>application/vnd.sun.xml.calc</entry>
</row>
<row>
<entry><link linkend="file-format-odf">OpenOffice.Org / StarOffice (OASIS ODF/IS26300)</link></entry>
<entry><link linkend="file-format-odf">OpenDocument Format (OASIS ODF and ISO/IEC 26300:2006)</link></entry>
<entry><literal>.ods</literal> / <literal>.odt</literal> / <literal>.sxc</literal> / <literal>.stc</literal></entry>
<entry>YES</entry>
<entry>YES (incomplete)</entry>
<entry>YES</entry>
<entry>application/vnd.oasis.opendocument.spreadsheet</entry>
</row>
<row>
......@@ -2197,7 +2197,7 @@ Columns: 2-3 5-12 15-22 25-36 40-47 50-61
<sect2 id="file-format-odf">
<title>OpenOffice.org XML File Format (aka ODF or OASIS)</title>
<title>OpenDocument Format (OASIS ODF and ISO/IEC 26300:2006)</title>
<para>
The OpenOffice.org XML file format is zip archive including
......@@ -2205,9 +2205,10 @@ Columns: 2-3 5-12 15-22 25-36 40-47 50-61
markup in the eXtensible Markup Language (XML).
</para>
<para>
&gnum; can both open and save files in this format and plans to
continue to support this format in the future.
<para>&gnum; reads version 1.0, 1.1 and 1.2 of ODF spreadsheet files and writes version 1.2 files
with or without foreign elements. Foreign elements are an extension mechanism defined in ODF and
allow features to be saved in ODF files that are not specifically standardized by ODF.
&gnum; plans to continue to support this format in the future.
</para>
<informaltable frame='all'>
......@@ -2217,7 +2218,7 @@ Columns: 2-3 5-12 15-22 25-36 40-47 50-61
<entry>
<emphasis role="bold">Name:</emphasis>
</entry>
<entry>ODF, OASIS XML, OpenOffice.org XML, StarOffice</entry>
<entry>Open Document Format, ODF</entry>
</row>
<row>
<entry>
......@@ -2230,6 +2231,8 @@ Columns: 2-3 5-12 15-22 25-36 40-47 50-61
<emphasis role="bold">Compatible Programs:</emphasis>
</entry>
<entry><application>OpenOffice.org Calc</application>,
<application>LibreOffice Calc</application>,
<application>KSpread</application>,
<application>StarCalc</application></entry>
</row>
<row>
......@@ -2261,7 +2264,7 @@ Columns: 2-3 5-12 15-22 25-36 40-47 50-61
</term>
<listitem>
<para>
Supported by the 'OpenCalc/StarCalc' plugin.
Supported by the 'Open Document Format' plugin.
</para>
</listitem>
</varlistentry>
......@@ -2298,6 +2301,12 @@ Columns: 2-3 5-12 15-22 25-36 40-47 50-61
File Format</ulink> web page, part of the OpenOffice.org
project.
</para>
<para>
Version 1.0 of ODF was adopted as an international standard by ISO/IEC as
ISO/IEC 26300:2006.
</para>
</listitem>
</varlistentry>
......@@ -2307,19 +2316,14 @@ Columns: 2-3 5-12 15-22 25-36 40-47 50-61
</term>
<listitem>
<para>
Files in this format can be imported and modified by the
<application>OpenOffice.org Calc</application> spreadsheet
Files in this format can be imported and modified by many
different programs including the
<application>OpenOffice.org Calc</application> and
<application>LibreOffice Calc</application> spreadsheets
or may be modified through XML processing.
</para>
<para>
Other software
supports ODF, e.g. KOffice, although some portions of the
specification have yet to be standardized and/or ratified
and can therefore lead to incompatibilities.
</para>
</listitem>
</varlistentry>
</variablelist>
......@@ -2390,7 +2394,7 @@ Columns: 2-3 5-12 15-22 25-36 40-47 50-61
</term>
<listitem>
<para>
Supported by the 'OpenCalc/StarCalc' plugin.
Supported by the 'Open Document Format' plugin.
</para>
</listitem>
</varlistentry>
......
......@@ -6135,3 +6135,70 @@ The distinction between half-width and full-width characters is described in htt
@EXCEL=This function is Excel compatible.
@SEEALSO=DOLLAR,FIXED,TEXT
@CATEGORY=Time Series Analysis
@FUNCTION=FOURIER
@SHORTDESC=Fourier or inverse Fourier transform
@SYNTAX=FOURIER(Sequence,Inverse,Separate)
@ARGUMENTDESCRIPTION=@{Sequence}: the data sequence to be transformed
@{Inverse}: if true, the inverse Fourier transform is calculated, defaults to false
@{Separate}: if true, the real and imaginary parts are given separately, defaults to false
@DESCRIPTION=This array function returns the Fourier or inverse Fourier transform of the given data sequence.
The output consists of one column of complex numbers if @{Separate} is false and of two columns of real numbers if @{Separate} is true.
If @{Separate} is true the first output column contains the real parts and the second column the imaginary parts.
@NOTE=If @{Sequence} is neither an n by 1 nor 1 by n array, this function returns #VALUE!
@CATEGORY=Time Series Analysis
@FUNCTION=HPFILTER
@SHORTDESC=Hodrick Prescott Filter
@SYNTAX=HPFILTER(Sequence,λ)
@ARGUMENTDESCRIPTION=@{Sequence}: the data sequence to be transformed
@{λ}: filter parameter λ, defaults to 1600
@DESCRIPTION=This array function returns the trend and cyclical components obtained by applying the Hodrick Prescott Filter with parameter @{λ} to the given data sequence.
The output consists of two columns of numbers, the first containing the trend component, the second the cyclical component.
@NOTE=If @{Sequence} is neither an n by 1 nor 1 by n array, this function returns #VALUE! If @{Sequence} contians less than 6 numerical values, this function returns #VALUE!
@CATEGORY=Time Series Analysis
@FUNCTION=INTERPOLATION
@SHORTDESC=interpolated values corresponding to the given abscissa targets
@SYNTAX=INTERPOLATION(abscissae,ordinates,targets,interpolation)
@ARGUMENTDESCRIPTION=@{abscissae}: ordered abscissae of the given data points
@{ordinates}: ordinates of the given data points
@{targets}: abscissae of the interpolated data
@{interpolation}: method of interpolation, defaults to 0 ('linear')
@DESCRIPTION=The output consists always of one column of numbers.
Possible interpolation methods are:
0: linear;
1: linear with averaging;
2: staircase;
3: staircase with averaging;
4: natural cubic spline;
5: natural cubic spline with averaging.
@NOTE=The @{abscissae} must be given in increasing order. If any of interpolation methods 1 ('linear with averaging'), 3 ('staircase with averaging'), and 5 ('natural cubic spline with averaging') is used, the number of returned values is one less than the number of targets and the targets values must be given in increasing order. Strings and empty cells in @{abscissae} and @{ordinates} are ignored. If several target data are provided they must be in the same column in consecutive cells.
@SEEALSO=PERIODOGRAM
@CATEGORY=Time Series Analysis
@FUNCTION=PERIODOGRAM
@SHORTDESC=periodogram of the given data
@SYNTAX=PERIODOGRAM(ordinates,filter,abscissae,interpolation,number)
@ARGUMENTDESCRIPTION=@{ordinates}: ordinates of the given data
@{filter}: windowing function to be used, defaults to no filter
@{abscissae}: abscissae of the given data, defaults to regularly spaced abscissae
@{interpolation}: method of interpolation, defaults to none
@{number}: number of interpolated data points
@DESCRIPTION=If an interpolation method is used, the number of returned values is one less than the number of targets and the targets values must be given in increasing order.
The output consists always of one column of numbers.
Possible interpolation methods are:
0: linear;
1: linear with averaging;
2: staircase;
3: staircase with averaging;
4: natural cubic spline;
5: natural cubic spline with averaging.
Possible window functions are:
0: no filter (rectangular window)
1: Bartlett (triangular window)
2: Hahn (cosine window)
3: Welch (parabolic window)
@NOTE=Strings and empty cells in @{abscissae} and @{ordinates} are ignored. If several target data are provided they must be in the same column in consecutive cells.
@SEEALSO=INTERPOLATION
......@@ -21144,4 +21144,170 @@
</refsect1>
</refentry>
</sect1>
<sect1 id="CATEGORY_Time_Series_Analysis">
<title>Time Series Analysis</title>
<refentry id="gnumeric-function-FOURIER">
<refmeta>
<refentrytitle>
<function>FOURIER</function>
</refentrytitle>
</refmeta>
<refnamediv>
<refname>
<function>FOURIER</function>
</refname>
<refpurpose>
Fourier or inverse Fourier transform
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><function>FOURIER</function>(<parameter>Sequence</parameter>,<parameter>Inverse</parameter>,<parameter>Separate</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Arguments</title>
<para><parameter>Sequence</parameter>: the data sequence to be transformed</para>
<para><parameter>Inverse</parameter>: if true, the inverse Fourier transform is calculated, defaults to false</para>
<para><parameter>Separate</parameter>: if true, the real and imaginary parts are given separately, defaults to false</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>This array function returns the Fourier or inverse Fourier transform of the given data sequence.</para>
<para>The output consists of one column of complex numbers if <parameter>Separate</parameter> is false and of two columns of real numbers if <parameter>Separate</parameter> is true.</para>
<para>If <parameter>Separate</parameter> is true the first output column contains the real parts and the second column the imaginary parts.</para>
</refsect1>
<refsect1>
<title>Note</title>
<para>If <parameter>Sequence</parameter> is neither an n by 1 nor 1 by n array, this function returns #VALUE!</para>
</refsect1>
</refentry>
<refentry id="gnumeric-function-HPFILTER">
<refmeta>
<refentrytitle>
<function>HPFILTER</function>
</refentrytitle>
</refmeta>
<refnamediv>
<refname>
<function>HPFILTER</function>
</refname>
<refpurpose>
Hodrick Prescott Filter
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><function>HPFILTER</function>(<parameter>Sequence</parameter>,<parameter/>λ)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Arguments</title>
<para><parameter>Sequence</parameter>: the data sequence to be transformed</para>
<para><parameter>λ</parameter>: filter parameter λ, defaults to 1600</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>This array function returns the trend and cyclical components obtained by applying the Hodrick Prescott Filter with parameter <parameter>λ</parameter> to the given data sequence.</para>
<para>The output consists of two columns of numbers, the first containing the trend component, the second the cyclical component.</para>
</refsect1>
<refsect1>
<title>Note</title>
<para>If <parameter>Sequence</parameter> is neither an n by 1 nor 1 by n array, this function returns #VALUE! If <parameter>Sequence</parameter> contians less than 6 numerical values, this function returns #VALUE!</para>
</refsect1>
</refentry>
<refentry id="gnumeric-function-INTERPOLATION">
<refmeta>
<refentrytitle>
<function>INTERPOLATION</function>
</refentrytitle>
</refmeta>
<refnamediv>
<refname>
<function>INTERPOLATION</function>
</refname>
<refpurpose>
interpolated values corresponding to the given abscissa targets
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><function>INTERPOLATION</function>(<parameter>abscissae</parameter>,<parameter>ordinates</parameter>,<parameter>targets</parameter>,<parameter>interpolation</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Arguments</title>
<para><parameter>abscissae</parameter>: ordered abscissae of the given data points</para>
<para><parameter>ordinates</parameter>: ordinates of the given data points</para>
<para><parameter>targets</parameter>: abscissae of the interpolated data</para>
<para><parameter>interpolation</parameter>: method of interpolation, defaults to 0 ('linear')</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>The output consists always of one column of numbers.</para>
<para>Possible interpolation methods are:</para>
<para>0: linear;</para>
<para>1: linear with averaging;</para>
<para>2: staircase;</para>
<para>3: staircase with averaging;</para>
<para>4: natural cubic spline;</para>
<para>5: natural cubic spline with averaging.</para>
</refsect1>
<refsect1>
<title>Note</title>
<para>The <parameter>abscissae</parameter> must be given in increasing order. If any of interpolation methods 1 ('linear with averaging'), 3 ('staircase with averaging'), and 5 ('natural cubic spline with averaging') is used, the number of returned values is one less than the number of targets and the targets values must be given in increasing order. Strings and empty cells in <parameter>abscissae</parameter> and <parameter>ordinates</parameter> are ignored. If several target data are provided they must be in the same column in consecutive cells.</para>
</refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-function-PERIODOGRAM"><function>PERIODOGRAM</function></link>.
</para>
</refsect1>
</refentry>
<refentry id="gnumeric-function-PERIODOGRAM">
<refmeta>
<refentrytitle>
<function>PERIODOGRAM</function>
</refentrytitle>
</refmeta>
<refnamediv>
<refname>
<function>PERIODOGRAM</function>
</refname>
<refpurpose>
periodogram of the given data
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis><function>PERIODOGRAM</function>(<parameter>ordinates</parameter>,<parameter>filter</parameter>,<parameter>abscissae</parameter>,<parameter>interpolation</parameter>,<parameter>number</parameter>)</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Arguments</title>
<para><parameter>ordinates</parameter>: ordinates of the given data</para>
<para><parameter>filter</parameter>: windowing function to be used, defaults to no filter</para>
<para><parameter>abscissae</parameter>: abscissae of the given data, defaults to regularly spaced abscissae</para>
<para><parameter>interpolation</parameter>: method of interpolation, defaults to none</para>
<para><parameter>number</parameter>: number of interpolated data points</para>
</refsect1>
<refsect1>
<title>Description</title>
<para>If an interpolation method is used, the number of returned values is one less than the number of targets and the targets values must be given in increasing order.</para>
<para>The output consists always of one column of numbers.</para>
<para>Possible interpolation methods are:</para>
<para>0: linear;</para>
<para>1: linear with averaging;</para>
<para>2: staircase;</para>
<para>3: staircase with averaging;</para>
<para>4: natural cubic spline;</para>
<para>5: natural cubic spline with averaging.</para>
<para>Possible window functions are:</para>
<para>0: no filter (rectangular window)</para>
<para>1: Bartlett (triangular window)</para>
<para>2: Hahn (cosine window)</para>
<para>3: Welch (parabolic window)</para>
</refsect1>
<refsect1>
<title>Note</title>
<para>Strings and empty cells in <parameter>abscissae</parameter> and <parameter>ordinates</parameter> are ignored. If several target data are provided they must be in the same column in consecutive cells.</para>
</refsect1>
<refsect1>
<title>See also</title>
<para><link linkend="gnumeric-function-INTERPOLATION"><function>INTERPOLATION</function></link>.
</para>
</refsect1>
</refentry>
</sect1>
</appendix>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment