Solver: return Hessian as a GnmMatrix.
[gnumeric.git] / README
blob3984ea5818eb6c57d86f3adf6d36271e1c24cf70
1 Gnumeric -- The GNOME spreadsheet
2 Jody Goldberg <jody@gnome.org>
4 The project aims to become a drop in replacement for proprietary spreadsheets.
5 If you are interested in contributing to its development please send us some
6 email, there are lots of projects available.
8 To report Gnumeric bugs, please visit bugzilla.gnome.org.
10 Gnumeric is licensed under the terms of the GNU GPL included in the
11 file COPYING.
13 Requirements
14 ------------
16 You need:                               Debian package name
17         glib            >= 2.38.0       libglib2.0-dev
18         gtk+            >= 3.8.7        libgtk3.0-dev
19         libgsf          >= 1.14.24      libgsf-1-dev
20         libgoffice      >= 0.10.9       libgoffice-0-8-dev
21         gnome-xml       >= 2.4.12       libxml2-dev
22         pango           >= 1.24.0       libpango1.0-dev
23         NOTE: gnome-xml is also known as libxml
25 Optionally:
26         python          >= 2.0          python-dev
27         pygobject       >= 3.0.0        python-gi-dev
29         The GDA plugin, for accessing databases
30         gda             >= 1.3.0        libgda2-dev
31         libgnomedb      >= 1.3.0        libgnomedb2-dev
33 Currently disabled:
34         guile           >= 1.5  (no maintainer)
36 Runtime suggestions:
37         'yelp' for help
39 Mailing lists
40 -------------
42    There is a mailing list used to discuss Gnumeric, to subscribe
43 send a mail to:
45         gnumeric-list-request@gnome.org
47    And in the body of the message write "subscribe"
49    An archive of the mailing lists is available in:
51         http://mail.gnome.org/archives/gnumeric-list/
54 Random notes:
55 -------------
57 This is a partial list of Features implemented in Gnumeric, we need
58 documentation for these:
60         - Autofill
61                 Number autofill (computes delta, autofills from that).
62                 String autofill (daynames, months are built in).
63                 String+Number combo integer autofill.
64                 Formula autofill.
66         - Drag and drop selection
67                 Select an area and use the border to drag the
68                 contents (shift/control/alt are modifiers to copy
69                 or move)
71         - Selection
72                 - Multiple selections are supported, hold down control
73                   key to augment the existing selection (they can be
74                   discontinuous).
76                 - Walking selection.
77                   Use return/tab and shift-return/shift-tab to capture 
78                   information in a selection.
80                 - Fill quickly a region with the same text: just enter
81                   the text in a selection and press control-enter.
83         - Number formatting
84                 - The formatting of numbers is very powerful, we
85                   emulate the Excel number formatting specification.
87                 - Format rules: you can use rules to specify which
88                   format to use.
90                 - Format colors: you can specify a color to format
91                   with in the format.
93                 - Conditional colours and format strings.
95         - Column/Row resizing
96                 - Drag the column/row division to adjust the column
97                   and row dimensions.
99                 - To make changes to various columns/rows
100                   simultaneously, select the columns and then change
101                   the dimension of one of them.  
103         - Content
104                 - Merged Cells
105                 - Array formulas
107         - Filters
108                 - MS OfficeOpenXML      Read/Write
109                 - MS Excel (95 -> 2003) Read/Write
110                 - MS Excel (v2 -> v4)   Read
111                 - Applix (v4 & v5)      Read
112                 - Quattro Pro (v1-v3)   Read
113                 - Planperfect           Read
114                 - Lotus (wk1)           Read
115                 - OpenOffice.org/ODF    Read/Write
116                 - html (3.2 & 4.0)      Read
117                 - html (4.0, xhtml)     Write
118                 - Latex                 Write
119                 - Troff                 Write
120                 - DIF                   Read
121                 - SYLK                  Read/Write
122                 - Oleo                  Read
123                 - SC                    Read
124                 - MPS Optimizer files   Read
125                 - XBase db              Read
126                 - Text files            Read/Write
127                 - CSV, TSV              Read/Write
128                 - PSION                 Read
130         - To edit the contents of a cell that already has a value,
131           press F2 key.
133         - When typing a formula, you can use the cursor keys to select
134           a cell or a cell range in the expression.  This will only
135           work if a cell name is valid at the cursor point.
137           To specify a cell range, just move to the start of the cell
138           range and then hold down the shift key while making the size
139           of the selection cursor bigger.
141         - An expression is evaluated constantly on top of the current
142           selection.  There is a number of pre-defined auto-compute
143           expressions, you can change this by right clicking on this
144           expression (it is on the bottom right corner).
146         - If you drag a selection with button 3 instead of button one
147           there is no default action, rather, a menu pops up with 
148           a list of possible options on actions to perform.
150         - Gnumeric distinguishes regular text from formulas by preceding
151           formulas with an equal sign.  So to enter an expression you have      
152           to enter for example: =1+2.
154         - Control-A selects all.
155         - Alt-Space selects the row.
156         - Control-Space selects a column.
158         - Selection-keys + control extend the selection to boundary of
159           worksheet.
161         - Shift-Backspace:  Collapses selection to active cell.
163         - Home: move to the beginning of the row.
164         
165         - Control-Home: move to the cell A1
167         - Control-Enter: copies current edit text to the selected range.
169         - Control-Shift-Enter: If there is a single range selected and the
170           current edit text is a formula, the formula is made into an
171           'array-formula'.
173         - Control-Pg{Up,Down}: Switch to the previous/next worksheet.
174         - Alt-Pg{Up,Down}: Page left and right.
175         - Mouse-Wheel : scroll up/down
176         - Alt-Mouse-Wheel : scroll left-right
177         - Arrow+ScrollLock
179      o Frozen Panes (including Horizontal or Vertical only)
181      o Auto-convert-on-input features: When you enter text in Gnumeric
182        it is now matched against the known formats of Gnumeric and if
183        possible, converted to a (number, format) pair.  This works
184        when you enter a formula and when you type in text.
186        This means you can use now dates and times in expressions, like
187        this: ="10-Jan"+45.  However, just because you can does not
188        mean you should!  If you send a spreadsheet like this to someone
189        else whose computer is set to a different locale, then there
190        is no guarantee that the string will be interpreted in the
191        same way.
193        Autofill will also work on this.