Commit | Line | Data |
---|---|---|
4009494e GM |
1 | \input texinfo @c -*-texinfo-*- |
2 | @c %**start of header | |
db78a8cb | 3 | @setfilename ../../info/ses |
4009494e GM |
4 | @settitle SES: Simple Emacs Spreadsheet |
5 | @setchapternewpage off | |
6 | @syncodeindex fn cp | |
7 | @syncodeindex vr cp | |
8 | @syncodeindex ky cp | |
9 | @c %**end of header | |
10 | ||
11 | @copying | |
12 | This file documents SES: the Simple Emacs Spreadsheet. | |
13 | ||
3f548a7c | 14 | Copyright @copyright{} 2002, 2003, 2004, 2005, 2006, 2007, 2008 |
4009494e GM |
15 | Free Software Foundation, Inc. |
16 | ||
17 | @quotation | |
18 | Permission is granted to copy, distribute and/or modify this document | |
19 | under the terms of the GNU Free Documentation License, Version 1.2 or | |
20 | any later version published by the Free Software Foundation; with no | |
debf4439 GM |
21 | Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' |
22 | and with the Back-Cover Texts as in (a) below. A copy of the license | |
23 | is included in the section entitled ``GNU Free Documentation License.'' | |
4009494e | 24 | |
6f093307 GM |
25 | (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and |
26 | modify this GNU manual. Buying copies from the FSF supports it in | |
27 | developing GNU and promoting software freedom.'' | |
4009494e GM |
28 | @end quotation |
29 | @end copying | |
30 | ||
31 | @dircategory Emacs | |
32 | @direntry | |
33 | * SES: (ses). Simple Emacs Spreadsheet | |
34 | @end direntry | |
35 | ||
36 | @finalout | |
37 | ||
38 | @titlepage | |
39 | @title SES | |
40 | @subtitle Simple Emacs Spreadsheet | |
41 | @author Jonathan A. Yavner | |
42 | @author @email{jyavner@@member.fsf.org} | |
43 | ||
44 | @page | |
45 | @vskip 0pt plus 1filll | |
46 | @insertcopying | |
47 | @end titlepage | |
48 | ||
49 | @contents | |
50 | ||
51 | @c =================================================================== | |
52 | ||
53 | @ifnottex | |
54 | @node Top, Sales Pitch, (dir), (dir) | |
55 | @comment node-name, next, previous, up | |
56 | @top SES: Simple Emacs Spreadsheet | |
57 | ||
58 | @display | |
59 | SES is a major mode for GNU Emacs to edit spreadsheet files, which | |
60 | contain a rectangular grid of cells. The cells' values are specified | |
61 | by formulas that can refer to the values of other cells. | |
62 | @end display | |
63 | @end ifnottex | |
64 | ||
65 | To report bugs, send email to @email{jyavner@@member.fsf.org}. | |
66 | ||
67 | @menu | |
68 | * Sales Pitch:: Why use SES? | |
69 | * The Basics:: Basic spreadsheet commands | |
70 | * Advanced Features:: Want to know more? | |
71 | * For Gurus:: Want to know @emph{even more}? | |
72 | * Index:: Concept, Function and Variable Index | |
73 | * Acknowledgements:: Acknowledgements | |
74 | * GNU Free Documentation License:: The license for this documentation. | |
75 | @end menu | |
76 | ||
77 | @c =================================================================== | |
78 | ||
79 | @node Sales Pitch, The Basics, Top, Top | |
80 | @comment node-name, next, previous, up | |
81 | @chapter Sales Pitch | |
82 | @cindex features | |
83 | ||
84 | @itemize @bullet | |
85 | @item Create and edit simple spreadsheets with a minimum of fuss. | |
86 | @item Full undo/redo/autosave. | |
87 | @item Immune to viruses in spreadsheet files. | |
88 | @item Cell formulas are straight Emacs Lisp. | |
89 | @item Printer functions for control of cell appearance. | |
90 | @item Intuitive keystroke commands: C-o = insert row, M-o = insert column, etc. | |
91 | @item ``Spillover'' of lengthy cell values into following blank cells. | |
92 | @item Header line shows column letters or a selected row. | |
93 | @item Completing-read for entering symbols as cell values. | |
94 | @item Cut, copy, and paste can transfer formulas and printer functions. | |
95 | @item Import and export of tab-separated values or tab-separated formulas. | |
96 | @item Plaintext, easily-hacked file format. | |
97 | @end itemize | |
98 | ||
99 | @c =================================================================== | |
100 | ||
101 | @node The Basics, Advanced Features, Sales Pitch, Top | |
102 | @comment node-name, next, previous, up | |
103 | @chapter The Basics | |
104 | @cindex basic commands | |
105 | @findex ses-jump | |
106 | @findex ses-mark-row | |
107 | @findex ses-mark-column | |
108 | @findex ses-mark-whole-buffer | |
109 | @findex set-mark-command | |
110 | @findex keyboard-quit | |
111 | ||
a9afba20 JY |
112 | To create a new spreadsheet, visit a nonexistent file whose name ends |
113 | with ".ses". For example, @kbd{C-x C-f test.ses RET}. | |
114 | ||
115 | ||
4009494e GM |
116 | A @dfn{cell identifier} is a symbol with a column letter and a row |
117 | number. Cell B7 is the 2nd column of the 7th row. For very wide | |
118 | spreadsheets, there are two column letters: cell AB7 is the 28th | |
a9afba20 | 119 | column of the 7th row. Super wide spreadsheets get AAA1, etc. |
4009494e GM |
120 | |
121 | @table @kbd | |
122 | @item j | |
123 | Moves point to cell, specified by identifier (@code{ses-jump}). | |
124 | @end table | |
125 | ||
126 | Point is always at the left edge of a cell, or at the empty endline. | |
127 | When mark is inactive, the current cell is underlined. When mark is | |
128 | active, the range is the highlighted rectangle of cells (SES always | |
129 | uses transient mark mode). Drag the mouse from A1 to A3 to create the | |
130 | range A1-A2. Many SES commands operate only on single cells, not | |
131 | ranges. | |
132 | ||
133 | @table @kbd | |
134 | @item C-SPC | |
135 | @itemx C-@@ | |
136 | Set mark at point (@code{set-mark-command}). | |
137 | ||
138 | @item C-g | |
139 | Turn off the mark (@code{keyboard-quit}). | |
140 | ||
141 | @item M-h | |
142 | Highlight current row (@code{ses-mark-row}). | |
143 | ||
144 | @item S-M-h | |
145 | Highlight current column (@code{ses-mark-column}). | |
146 | ||
147 | @item C-x h | |
148 | Highlight all cells (@code{mark-whole-buffer}). | |
149 | @end table | |
150 | ||
151 | @menu | |
152 | * Formulas:: | |
153 | * Resizing:: | |
154 | * Printer functions:: | |
155 | * Clearing cells:: | |
156 | * Copy/cut/paste:: | |
157 | * Customizing SES:: | |
158 | @end menu | |
159 | ||
160 | @node Formulas, Resizing, The Basics, The Basics | |
161 | @section Cell formulas | |
162 | @cindex formulas | |
163 | @cindex formulas, entering | |
164 | @findex ses-read-cell | |
165 | @findex ses-read-symbol | |
166 | @findex ses-edit-cell | |
167 | @findex ses-recalculate-cell | |
168 | @findex ses-recalculate-all | |
169 | ||
170 | To enter a number into the current cell, just start typing: | |
171 | ||
172 | @table @kbd | |
173 | @item 0..9 | |
174 | Self-insert a digit (@code{ses-read-cell}). | |
175 | ||
176 | @item - | |
177 | Self-insert a negative number (@code{ses-read-cell}). | |
178 | ||
179 | @item . | |
180 | Self-insert a fractional number (@code{ses-read-cell}). | |
181 | ||
182 | @item " | |
183 | Self-insert a quoted string. The ending double-quote | |
184 | is inserted for you (@code{ses-read-cell}). | |
185 | ||
186 | @item ( | |
187 | Self-insert an expression. The right-parenthesis is inserted for you | |
188 | (@code{ses-read-cell}). To access another cell's value, just use its | |
189 | identifier in your expression. Whenever the other cell is changed, | |
190 | this cell's formula will be reevaluated. While typing in the | |
191 | expression, you can use @kbd{M-@key{TAB}} to complete symbol names. | |
192 | ||
193 | @item ' @r{(apostrophe)} | |
194 | Enter a symbol (ses-read-symbol). SES remembers all symbols that have | |
195 | been used as formulas, so you can type just the beginning of a symbol | |
196 | and use @kbd{@key{SPC}}, @kbd{@key{TAB}}, and @kbd{?} to complete it. | |
197 | @end table | |
198 | ||
199 | To enter something else (e.g., a vector), begin with a digit, then | |
200 | erase the digit and type whatever you want. | |
201 | ||
202 | @table @kbd | |
203 | @item RET | |
204 | Edit the existing formula in the current cell (@code{ses-edit-cell}). | |
205 | ||
206 | @item C-c C-c | |
207 | Force recalculation of the current cell or range (@code{ses-recalculate-cell}). | |
208 | ||
209 | @item C-c C-l | |
210 | Recalculate the entire spreadsheet (@code{ses-recalculate-all}). | |
211 | @end table | |
212 | ||
213 | @node Resizing, Printer functions, Formulas, The Basics | |
214 | @section Resizing the spreadsheet | |
215 | @cindex resizing spreadsheets | |
216 | @findex ses-insert-row | |
217 | @findex ses-insert-column | |
218 | @findex ses-delete-row | |
219 | @findex ses-delete-column | |
220 | @findex ses-set-column-width | |
221 | @findex ses-forward-or-insert | |
222 | @findex ses-append-row-jump-first-column | |
223 | ||
224 | ||
225 | Basic commands: | |
226 | ||
227 | @table @kbd | |
228 | @item C-o | |
229 | (@code{ses-insert-row}) | |
230 | ||
231 | @item M-o | |
232 | (@code{ses-insert-column}) | |
233 | ||
234 | @item C-k | |
235 | (@code{ses-delete-row}) | |
236 | ||
237 | @item M-k | |
238 | (@code{ses-delete-column}) | |
239 | ||
240 | @item w | |
241 | (@code{ses-set-column-width}) | |
242 | ||
243 | @item TAB | |
244 | Moves point to the next rightward cell, or inserts a new column if | |
245 | already at last cell on line, or inserts a new row if at endline | |
246 | (@code{ses-forward-or-insert}). | |
247 | ||
248 | @item C-j | |
249 | Linefeed inserts below the current row and moves to column A | |
250 | (@code{ses-append-row-jump-first-column}). | |
251 | @end table | |
252 | ||
253 | Resizing the spreadsheet (unless you're just changing a column width) | |
254 | relocates all the cell-references in formulas so they still refer to | |
255 | the same cells. If a formula mentioned B1 and you insert a new first | |
256 | row, the formula will now mention B2. | |
257 | ||
258 | If you delete a cell that a formula refers to, the cell-symbol is | |
259 | deleted from the formula, so @code{(+ A1 B1 C1)} after deleting the third | |
260 | column becomes @code{(+ A1 B1)}. In case this is not what you wanted: | |
261 | ||
262 | @table @kbd | |
263 | @item C-_ | |
264 | @itemx C-x u | |
265 | Undo previous action (@code{(undo)}). | |
266 | @end table | |
267 | ||
268 | ||
269 | @node Printer functions, Clearing cells, Resizing, The Basics | |
270 | @section Printer functions | |
271 | @cindex printer functions | |
272 | @findex ses-read-cell-printer | |
273 | @findex ses-read-column-printer | |
274 | @findex ses-read-default-printer | |
275 | @findex ses-center | |
276 | @findex ses-center-span | |
277 | @findex ses-dashfill | |
278 | @findex ses-dashfill-span | |
279 | @findex ses-tildefill-span | |
280 | ||
281 | ||
282 | Printer functions convert binary cell values into the print forms that | |
283 | Emacs will display on the screen. | |
284 | ||
285 | A printer can be a format string, like @samp{"$%.2f"}. The result | |
286 | string is right-aligned within the print cell. To get left-alignment, | |
287 | use parentheses: @samp{("$%.2f")}. A printer can also be a | |
288 | one-argument function (a symbol or a lambda), whose result is a string | |
289 | (right-aligned) or list of one string (left-aligned). While typing in | |
290 | a lambda, you can use @kbd{M-@key{TAB}} to complete the names of symbols. | |
291 | ||
292 | Each cell has a printer. If @code{nil}, the column-printer for the cell's | |
293 | column is used. If that is also @code{nil}, the default-printer for the | |
294 | spreadsheet is used. | |
295 | ||
296 | @table @kbd | |
297 | @item p | |
298 | Enter a printer for current cell or range (@code{ses-read-cell-printer}). | |
299 | ||
300 | @item M-p | |
301 | Enter a printer for the current column (@code{ses-read-column-printer}). | |
302 | ||
303 | @item C-c C-p | |
304 | Enter the default printer for the spreadsheet | |
305 | (@code{ses-read-default-printer}). | |
306 | @end table | |
307 | ||
308 | The @code{ses-read-@r{XXX}-printer} commands have their own minibuffer | |
309 | history, which is preloaded with the set of all printers used in this | |
310 | spreadsheet, plus the standard printers. | |
311 | ||
312 | The standard printers are suitable only for cells, not columns or | |
313 | default, because they format the value using the column-printer (or | |
314 | default-printer if @code{nil}) and then center the result: | |
315 | ||
316 | @table @code | |
317 | @item ses-center | |
318 | Just centering. | |
319 | ||
320 | @item ses-center-span | |
321 | Centering with spill-over to following blank cells. | |
322 | ||
323 | @item ses-dashfill | |
324 | Centering using dashes (-) instead of spaces. | |
325 | ||
326 | @item ses-dashfill-span | |
327 | Centering with dashes and spill-over. | |
328 | ||
329 | @item ses-tildefill-span | |
330 | Centering with tildes (~) and spill-over. | |
331 | @end table | |
332 | ||
333 | ||
334 | @node Clearing cells, Copy/cut/paste, Printer functions, The Basics | |
335 | @section Clearing cells | |
336 | @cindex clearing commands | |
337 | @findex ses-clear-cell-backward | |
338 | @findex ses-clear-cell-forward | |
339 | ||
340 | These commands set both formula and printer to @code{nil}: | |
341 | ||
342 | @table @kbd | |
343 | @item DEL | |
344 | Clear cell and move left (@code{ses-clear-cell-backward}). | |
345 | ||
346 | @item C-d | |
347 | Clear cell and move right (@code{ses-clear-cell-forward}). | |
348 | @end table | |
349 | ||
350 | ||
351 | @node Copy/cut/paste, Customizing SES, Clearing cells, The Basics | |
352 | @section Copy, cut, and paste | |
353 | @cindex copy | |
354 | @cindex cut | |
355 | @cindex paste | |
356 | @findex kill-ring-save | |
357 | @findex mouse-set-region | |
358 | @findex mouse-set-secondary | |
359 | @findex ses-kill-override | |
360 | @findex yank | |
361 | @findex clipboard-yank | |
362 | @findex mouse-yank-at-click | |
363 | @findex mouse-yank-at-secondary | |
364 | @findex ses-yank-pop | |
365 | ||
366 | The copy functions work on rectangular regions of cells. You can paste the | |
367 | copies into non-SES buffers to export the print text. | |
368 | ||
369 | @table @kbd | |
370 | @item M-w | |
371 | @itemx [copy] | |
372 | @itemx [C-insert] | |
373 | Copy the highlighted cells to kill ring and primary clipboard | |
374 | (@code{kill-ring-save}). | |
375 | ||
376 | @item [drag-mouse-1] | |
377 | Mark a region and copy it to kill ring and primary clipboard | |
378 | (@code{mouse-set-region}). | |
379 | ||
380 | @item [M-drag-mouse-1] | |
381 | Mark a region and copy it to kill ring and secondary clipboard | |
382 | (@code{mouse-set-secondary}). | |
383 | ||
384 | @item C-w | |
385 | @itemx [cut] | |
386 | @itemx [S-delete] | |
387 | The cut functions do not actually delete rows or columns---they copy | |
388 | and then clear (@code{ses-kill-override}). | |
389 | ||
390 | @item C-y | |
391 | @itemx [S-insert] | |
392 | Paste from kill ring (@code{yank}). The paste functions behave | |
393 | differently depending on the format of the text being inserted: | |
394 | @itemize @bullet | |
395 | @item | |
396 | When pasting cells that were cut from a SES buffer, the print text is | |
397 | ignored and only the attached formula and printer are inserted; cell | |
398 | references in the formula are relocated unless you use @kbd{C-u}. | |
399 | @item | |
400 | The pasted text overwrites a rectangle of cells whose top left corner | |
401 | is the current cell. If part of the rectangle is beyond the edges of | |
402 | the spreadsheet, you must confirm the increase in spreadsheet size. | |
403 | @item | |
404 | Non-SES text is usually inserted as a replacement formula for the | |
405 | current cell. If the formula would be a symbol, it's treated as a | |
406 | string unless you use @kbd{C-u}. Pasted formulas with syntax errors | |
407 | are always treated as strings. | |
408 | @end itemize | |
409 | ||
410 | @item [paste] | |
411 | Paste from primary clipboard or kill ring (@code{clipboard-yank}). | |
412 | ||
413 | @item [mouse-2] | |
414 | Set point and paste from primary clipboard (@code{mouse-yank-at-click}). | |
415 | ||
416 | @item [M-mouse-2] | |
417 | Set point and paste from secondary clipboard (@code{mouse-yank-secondary}). | |
418 | ||
419 | @item M-y | |
420 | Immediately after a paste, you can replace the text with a preceding | |
421 | element from the kill ring (@code{ses-yank-pop}). Unlike the standard | |
422 | Emacs yank-pop, the SES version uses @code{undo} to delete the old | |
423 | yank. This doesn't make any difference? | |
424 | @end table | |
425 | ||
426 | @node Customizing SES, , Copy/cut/paste, The Basics | |
427 | @section Customizing SES | |
428 | @cindex customizing | |
429 | @vindex enable-local-eval | |
430 | @vindex ses-mode-hook | |
431 | @vindex safe-functions | |
432 | @vindex enable-local-eval | |
433 | ||
434 | ||
435 | By default, a newly-created spreadsheet has 1 row and 1 column. The | |
436 | column width is 7 and the default printer is @samp{"%.7g"}. Each of these | |
437 | can be customized. Look in group ``ses''. | |
438 | ||
439 | After entering a cell value, point normally moves right to the next | |
440 | cell. You can customize @code{ses-after-entry-functions} to move left or | |
441 | up or down. For diagonal movement, select two functions from the | |
442 | list. | |
443 | ||
444 | @code{ses-mode-hook} is a normal mode hook (list of functions to | |
445 | execute when starting SES mode for a buffer). | |
446 | ||
447 | The variable @code{safe-functions} is a list of possibly-unsafe | |
448 | functions to be treated as safe when analysing formulas and printers. | |
449 | @xref{Virus protection}. Before customizing @code{safe-functions}, | |
450 | think about how much you trust the person who's suggesting this | |
451 | change. The value @code{t} turns off all anti-virus protection. A | |
452 | list-of-functions value might enable a ``gee whiz'' spreadsheet, but it | |
453 | also creates trapdoors in your anti-virus armor. In order for virus | |
454 | protection to work, you must always press @kbd{n} when presented with | |
455 | a virus warning, unless you understand what the questionable code is | |
456 | trying to do. Do not listen to those who tell you to customize | |
457 | @code{enable-local-eval}---this variable is for people who don't wear | |
458 | safety belts! | |
459 | ||
460 | ||
461 | @c =================================================================== | |
462 | ||
463 | @node Advanced Features, For Gurus, The Basics, Top | |
464 | @chapter Advanced Features | |
465 | @cindex advanced features | |
466 | @findex ses-read-header-row | |
467 | ||
468 | ||
469 | @table @kbd | |
470 | @item C-c M-C-h | |
471 | (@code{ses-set-header-row}). The header line at the top of the SES | |
472 | window normally shows the column letter for each column. You can set | |
473 | it to show a copy of some row, such as a row of column titles, so that | |
474 | row will always be visible. Default is to set the current row as the | |
475 | header; use C-u to prompt for header row. Set the header to row 0 to | |
476 | show column letters again. | |
477 | @item [header-line mouse-3] | |
478 | Pops up a menu to set the current row as the header, or revert to | |
479 | column letters. | |
480 | @end table | |
481 | ||
482 | @menu | |
483 | * The print area:: | |
484 | * Ranges in formulas:: | |
485 | * Sorting by column:: | |
486 | * Standard formula functions:: | |
487 | * More on cell printing:: | |
488 | * Import and export:: | |
489 | * Virus protection:: | |
490 | * Spreadsheets with details and summary:: | |
491 | @end menu | |
492 | ||
493 | @node The print area, Ranges in formulas, Advanced Features, Advanced Features | |
494 | @section The print area | |
495 | @cindex print area | |
496 | @findex widen | |
497 | @findex ses-renarrow-buffer | |
498 | @findex ses-reprint-all | |
499 | ||
500 | A SES file consists of a print area and a data area. Normally the | |
501 | buffer is narrowed to show only the print area. The print area is | |
502 | read-only except for special SES commands; it contains cell values | |
503 | formatted by printer functions. The data area records the formula and | |
504 | printer functions, etc. | |
505 | ||
506 | @table @kbd | |
507 | @item C-x n w | |
508 | Show print and data areas (@code{widen}). | |
509 | ||
510 | @item C-c C-n | |
511 | Show only print area (@code{ses-renarrow-buffer}). | |
512 | ||
513 | @item S-C-l | |
514 | @itemx M-C-l | |
515 | Recreate print area by reevaluating printer functions for all cells | |
516 | (@code{ses-reprint-all}). | |
517 | @end table | |
518 | ||
519 | @node Ranges in formulas, Sorting by column, The print area, Advanced Features | |
520 | @section Ranges in formulas | |
521 | @cindex ranges | |
522 | @findex ses-insert-range-click | |
523 | @findex ses-insert-range | |
524 | @findex ses-insert-ses-range-click | |
525 | @findex ses-insert-ses-range | |
526 | @vindex from | |
527 | @vindex to | |
528 | ||
529 | A formula like | |
530 | @lisp | |
531 | (+ A1 A2 A3) | |
532 | @end lisp | |
533 | is the sum of three specific cells. If you insert a new second row, | |
534 | the formula becomes | |
535 | @lisp | |
536 | (+ A1 A3 A4) | |
537 | @end lisp | |
538 | and the new row is not included in the sum. | |
539 | ||
540 | The macro @code{(ses-range @var{from} @var{to})} evaluates to a list of | |
541 | the values in a rectangle of cells. If your formula is | |
542 | @lisp | |
543 | (apply '+ (ses-range A1 A3)) | |
544 | @end lisp | |
545 | and you insert a new second row, it becomes | |
546 | @lisp | |
547 | (apply '+ (ses-range A1 A4)) | |
548 | @end lisp | |
549 | and the new row is included in the sum. | |
550 | ||
551 | While entering or editing a formula in the minibuffer, you can select | |
552 | a range in the spreadsheet (using mouse or keyboard), then paste a | |
553 | representation of that range into your formula. Suppose you select | |
554 | A1-C1: | |
555 | ||
556 | @table @kbd | |
557 | @item [S-mouse-3] | |
558 | Inserts "A1 B1 C1" @code{(ses-insert-range-click}) | |
559 | ||
560 | @item C-c C-r | |
561 | Keyboard version (@code{ses-insert-range}). | |
562 | ||
563 | @item [C-S-mouse-3] | |
564 | Inserts "(ses-range A1 C1)" (@code{ses-insert-ses-range-click}). | |
565 | ||
566 | @item C-c C-s | |
567 | Keyboard version (@code{ses-insert-ses-range}). | |
568 | @end table | |
569 | ||
570 | If you delete the @var{from} or @var{to} cell for a range, the nearest | |
571 | still-existing cell is used instead. If you delete the entire range, | |
572 | the formula relocator will delete the ses-range from the formula. | |
573 | ||
574 | If you insert a new row just beyond the end of a one-column range, or | |
575 | a new column just beyond a one-row range, the new cell is included in | |
576 | the range. New cells inserted just before a range are not included. | |
577 | ||
578 | ||
579 | @node Sorting by column, Standard formula functions, Ranges in formulas, Advanced Features | |
580 | @section Sorting by column | |
581 | @cindex sorting | |
582 | @findex ses-sort-column | |
583 | @findex ses-sort-column-click | |
584 | ||
585 | @table @kbd | |
586 | @item C-c M-C-s | |
587 | Sort the cells of a range using one of the columns | |
588 | (@code{ses-sort-column}). The rows (or partial rows if the range | |
589 | doesn't include all columns) are rearranged so the chosen column will | |
590 | be in order. | |
591 | ||
592 | @item [header-line mouse-2] | |
593 | The easiest way to sort is to click mouse-2 on the chosen column's header row | |
594 | (@code{ses-sort-column-click}). | |
595 | @end table | |
596 | ||
597 | The sort comparison uses @code{string<}, which works well for | |
598 | right-justified numbers and left-justified strings. | |
599 | ||
600 | With prefix arg, sort is in descending order. | |
601 | ||
602 | Rows are moved one at a time, with relocation of formulas. This works | |
603 | well if formulas refer to other cells in their row, not so well for | |
604 | formulas that refer to other rows in the range or to cells outside the | |
605 | range. | |
606 | ||
607 | ||
608 | @node Standard formula functions, More on cell printing, Sorting by column, Advanced Features | |
609 | @section Standard formula functions | |
610 | @cindex standard formula functions | |
611 | @cindex *skip* | |
612 | @cindex *error* | |
613 | @findex ses-delete-blanks | |
614 | @findex ses-average | |
615 | @findex ses+ | |
616 | ||
617 | Oftentimes you want a calculation to exclude the blank cells. Here | |
618 | are some useful functions to call from your formulas: | |
619 | ||
620 | @table @code | |
621 | @item (ses-delete-blanks &rest @var{args}) | |
622 | Returns a list from which all blank cells (value is either @code{nil} or | |
623 | '*skip*) have been deleted. | |
624 | ||
625 | @item (ses+ &rest @var{args}) | |
626 | Sum of non-blank arguments. | |
627 | ||
628 | @item (ses-average @var{list}) | |
629 | Average of non-blank elements in @var{list}. Here the list is passed | |
630 | as a single argument, since you'll probably use it with @code{ses-range}. | |
631 | @end table | |
632 | ||
633 | @node More on cell printing, Import and export, Standard formula functions, Advanced Features | |
634 | @section More on cell printing | |
635 | @cindex cell printing, more | |
636 | @findex ses-truncate-cell | |
637 | @findex ses-recalculate-cell | |
638 | ||
639 | Special cell values: | |
640 | @itemize | |
641 | @item nil prints the same as "", but allows previous cell to spill over. | |
642 | @item '*skip* replaces nil when the previous cell actually does spill over; | |
643 | nothing is printed for it. | |
644 | @item '*error* indicates that the formula signaled an error instead of | |
645 | producing a value: the print cell is filled with hash marks (#). | |
646 | @end itemize | |
647 | ||
648 | If the result from the printer function is too wide for the cell and | |
649 | the following cell is @code{nil}, the result will spill over into the | |
650 | following cell. Very wide results can spill over several cells. If | |
651 | the result is too wide for the available space (up to the end of the | |
652 | row or the next non-@code{nil} cell), the result is truncated if the cell's | |
653 | value is a string, or replaced with hash marks otherwise. | |
654 | ||
655 | SES could get confused by printer results that contain newlines or | |
656 | tabs, so these are replaced with question marks. | |
657 | ||
658 | @table @kbd | |
a9afba20 | 659 | @item t |
4009494e GM |
660 | Confine a cell to its own column (@code{ses-truncate-cell}). This |
661 | allows you to move point to a rightward cell that would otherwise be | |
662 | covered by a spill-over. If you don't change the rightward cell, the | |
663 | confined cell will spill over again the next time it is reprinted. | |
664 | ||
a9afba20 JY |
665 | @item c |
666 | When applied to a single cell, this command displays in the echo area | |
667 | any formula error or printer error that occurred during | |
668 | recalculation/reprinting (@code{ses-recalculate-cell}). You can use | |
669 | this to undo the effect of @kbd{t}. | |
4009494e GM |
670 | @end table |
671 | ||
a9afba20 | 672 | When a printer function signals an error, the fallback printer |
4009494e | 673 | @samp{"%s"} is substituted. This is useful when your column printer |
a9afba20 JY |
674 | is numeric-only and you use a string as a cell value. Note that the |
675 | standard default printer is ``%.7g'' which is numeric-only, so cells | |
676 | that are empty of contain strings will use the fallback printer. | |
677 | @kbd{c} on such cells will display ``Format specifier doesn't match | |
678 | argument type''. | |
4009494e GM |
679 | |
680 | ||
681 | @node Import and export, Virus protection, More on cell printing, Advanced Features | |
682 | @section Import and export | |
683 | @cindex import and export | |
684 | @cindex export, and import | |
685 | @findex ses-export-tsv | |
686 | @findex ses-export-tsf | |
687 | ||
688 | @table @kbd | |
689 | @item x t | |
690 | Export a range of cells as tab-separated values (@code{ses-export-tsv}). | |
691 | @item x T | |
692 | Export a range of cells as tab-separated formulas (@code{ses-export-tsf}). | |
693 | @end table | |
694 | ||
695 | The exported text goes to the kill ring --- you can paste it into | |
696 | another buffer. Columns are separated by tabs, rows by newlines. | |
697 | ||
698 | To import text, use any of the yank commands where the text to paste | |
699 | contains tabs and/or newlines. Imported formulas are not relocated. | |
700 | ||
701 | @node Virus protection, Spreadsheets with details and summary, Import and export, Advanced Features | |
702 | @section Virus protection | |
703 | @cindex virus protection | |
704 | ||
705 | Whenever a formula or printer is read from a file or is pasted into | |
706 | the spreadsheet, it receives a ``needs safety check'' marking. Later, | |
707 | when the formula or printer is evaluated for the first time, it is | |
708 | checked for safety using the @code{unsafep} predicate; if found to be | |
709 | ``possibly unsafe'', the questionable formula or printer is displayed | |
710 | and you must press Y to approve it or N to use a substitute. The | |
711 | substitute always signals an error. | |
712 | ||
713 | Formulas or printers that you type in are checked immediately for | |
714 | safety. If found to be possibly unsafe and you press N to disapprove, | |
715 | the action is canceled and the old formula or printer will remain. | |
716 | ||
717 | Besides viruses (which try to copy themselves to other files), | |
718 | @code{unsafep} can also detect all other kinds of Trojan horses, such as | |
719 | spreadsheets that delete files, send email, flood Web sites, alter | |
720 | your Emacs settings, etc. | |
721 | ||
722 | Generally, spreadsheet formulas and printers are simple things that | |
723 | don't need to do any fancy computing, so all potentially-dangerous | |
724 | parts of the Emacs Lisp environment can be excluded without cramping | |
725 | your style as a formula-writer. See the documentation in @file{unsafep.el} | |
726 | for more info on how Lisp forms are classified as safe or unsafe. | |
727 | ||
728 | @node Spreadsheets with details and summary, , Virus protection, Advanced Features | |
729 | @section Spreadsheets with details and summary | |
730 | @cindex details and summary | |
731 | @cindex summary, and details | |
732 | ||
733 | A common organization for spreadsheets is to have a bunch of ``detail'' | |
734 | rows, each perhaps describing a transaction, and then a set of | |
735 | ``summary'' rows that each show reduced data for some subset of the | |
736 | details. SES supports this organization via the @code{ses-select} | |
737 | function. | |
738 | ||
739 | @table @code | |
740 | @item (ses-select @var{fromrange} @var{test} @var{torange}) | |
741 | Returns a subset of @var{torange}. For each member in @var{fromrange} | |
742 | that is equal to @var{test}, the corresponding member of @var{torange} | |
743 | is included in the result. | |
744 | @end table | |
745 | ||
746 | Example of use: | |
747 | @lisp | |
748 | (ses-average (ses-select (ses-range A1 A5) 'Smith (ses-range B1 B5))) | |
749 | @end lisp | |
750 | This computes the average of the B column values for those rows whose | |
751 | A column value is the symbol 'Smith. | |
752 | ||
753 | Arguably one could specify only @var{fromrange} plus | |
754 | @var{to-row-offset} and @var{to-column-offset}. The @var{torange} is | |
755 | stated explicitly to ensure that the formula will be recalculated if | |
756 | any cell in either range is changed. | |
757 | ||
758 | File @file{etc/ses-example.el} in the Emacs distribution is an example of a | |
759 | details-and-summary spreadsheet. | |
760 | ||
761 | ||
762 | @c =================================================================== | |
763 | ||
764 | @node For Gurus, Index, Advanced Features, Top | |
765 | @chapter For Gurus | |
766 | @cindex advanced features | |
767 | ||
768 | @menu | |
769 | * Deferred updates:: | |
770 | * Nonrelocatable references:: | |
771 | * The data area:: | |
772 | * Buffer-local variables in spreadsheets:: | |
773 | * Uses of defadvice in SES:: | |
774 | @end menu | |
775 | ||
776 | @node Deferred updates, Nonrelocatable references, For Gurus, For Gurus | |
777 | @section Deferred updates | |
778 | @cindex deferred updates | |
779 | @cindex updates, deferred | |
780 | @vindex run-with-idle-timer | |
781 | ||
782 | To save time by avoiding redundant computations, cells that need | |
783 | recalculation due to changes in other cells are added to a set. At | |
784 | the end of the command, each cell in the set is recalculated once. | |
785 | This can create a new set of cells that need recalculation. The | |
786 | process is repeated until either the set is empty or it stops changing | |
787 | (due to circular references among the cells). In extreme cases, you | |
788 | might see progress messages of the form ``Recalculating... (@var{nnn} | |
789 | cells left)''. If you interrupt the calculation using @kbd{C-g}, the | |
790 | spreadsheet will be left in an inconsistent state, so use @kbd{C-_} or | |
791 | @kbd{C-c C-l} to fix it. | |
792 | ||
793 | To save even more time by avoiding redundant writes, cells that have | |
794 | changes are added to a set instead of being written immediately to the | |
795 | data area. Each cell in the set is written once, at the end of the | |
796 | command. If you change vast quantities of cells, you might see a | |
797 | progress message of the form ``Writing... (@var{nnn} cells left)''. | |
798 | These deferred cell-writes cannot be interrupted by @kbd{C-g}, so | |
799 | you'll just have to wait. | |
800 | ||
801 | SES uses @code{run-with-idle-timer} to move the cell underline when | |
802 | Emacs will be scrolling the buffer after the end of a command, and | |
803 | also to narrow and underline after @kbd{C-x C-v}. This is visible as | |
804 | a momentary glitch after C-x C-v and certain scrolling commands. You | |
805 | can type ahead without worrying about the glitch. | |
806 | ||
807 | ||
808 | @node Nonrelocatable references, The data area, Deferred updates, For Gurus | |
809 | @section Nonrelocatable references | |
810 | @cindex nonrelocatable references | |
811 | @cindex references, nonrelocatable | |
812 | ||
813 | @kbd{C-y} relocates all cell-references in a pasted formula, while | |
814 | @kbd{C-u C-y} relocates none of the cell-references. What about mixed | |
815 | cases? | |
816 | ||
817 | You can use | |
818 | @lisp | |
819 | (symbol-value 'B3) | |
820 | @end lisp | |
821 | to make an @dfn{absolute reference}. The formula relocator skips over | |
822 | quoted things, so this will not be relocated when pasted or when | |
823 | rows/columns are inserted/deleted. However, B3 will not be recorded | |
824 | as a dependency of this cell, so this cell will not be updated | |
825 | automatically when B3 is changed. | |
826 | ||
827 | The variables @code{row} and @code{col} are dynamically bound while a | |
828 | cell formula is being evaluated. You can use | |
829 | @lisp | |
830 | (ses-cell-value row 0) | |
831 | @end lisp | |
832 | to get the value from the leftmost column in the current row. This | |
833 | kind of dependency is also not recorded. | |
834 | ||
835 | ||
836 | @node The data area, Buffer-local variables in spreadsheets, Nonrelocatable references, For Gurus | |
837 | @section The data area | |
838 | @cindex data area | |
839 | @findex ses-reconstruct-all | |
840 | ||
841 | Begins with an 014 character, followed by sets of cell-definition | |
842 | macros for each row, followed by column-widths, column-printers, | |
843 | default-printer, and header-row. Then there's the global parameters | |
844 | (file-format ID, numrows, numcols) and the local variables (specifying | |
845 | SES mode for the buffer, etc.) | |
846 | ||
847 | When a SES file is loaded, first the numrows and numcols values are | |
848 | loaded, then the entire data area is @code{eval}ed, and finally the local | |
849 | variables are processed. | |
850 | ||
851 | You can edit the data area, but don't insert or delete any newlines | |
852 | except in the local-variables part, since SES locates things by | |
853 | counting newlines. Use @kbd{C-x C-e} at the end of a line to install | |
854 | your edits into the spreadsheet data structures (this does not update | |
855 | the print area, use e.g. @kbd{C-c C-l} for that). | |
856 | ||
857 | The data area is maintained as an image of spreadsheet data | |
858 | structures that area stored in buffer-local variables. If the data | |
859 | area gets messed up, you can try reconstructing the data area from the | |
860 | data structures: | |
861 | ||
862 | @table @kbd | |
863 | @item C-c M-C-l | |
864 | (@code{ses-reconstruct-all}). | |
865 | @end table | |
866 | ||
867 | ||
868 | @node Buffer-local variables in spreadsheets, Uses of defadvice in SES, The data area, For Gurus | |
869 | @section Buffer-local variables in spreadsheets | |
870 | @cindex buffer-local variables | |
871 | @cindex variables, buffer-local | |
872 | ||
873 | You can add additional local variables to the list at the bottom of | |
874 | the data area, such as hidden constants you want to refer to in your | |
875 | formulas. | |
876 | ||
a9afba20 | 877 | You can override the variable @code{ses--symbolic-formulas} to be a list of |
4009494e GM |
878 | symbols (as parenthesized strings) to show as completions for the ' |
879 | command. This initial completions list is used instead of the actual | |
880 | set of symbols-as-formulas in the spreadsheet. | |
881 | ||
a9afba20 | 882 | For an example of this, see file @file{etc/ses-example.ses}. |
4009494e GM |
883 | |
884 | If (for some reason) you want your formulas or printers to save data | |
885 | into variables, you must declare these variables as buffer-locals in | |
886 | order to avoid a virus warning. | |
887 | ||
888 | You can define functions by making them values for the fake local | |
889 | variable @code{eval}. Such functions can then be used in your | |
890 | formulas and printers, but usually each @code{eval} is presented to | |
891 | the user during file loading as a potential virus --- this can get | |
892 | annoying. | |
893 | ||
894 | You can define functions in your @file{.emacs} file. Other people can | |
895 | still read the print area of your spreadsheet, but they won't be able | |
896 | to recalculate or reprint anything that depends on your functions. To | |
897 | avoid virus warnings, each function used in a formula needs | |
898 | @lisp | |
899 | (put 'your-function-name 'safe-function t) | |
900 | @end lisp | |
901 | ||
902 | @node Uses of defadvice in SES, , Buffer-local variables in spreadsheets, For Gurus | |
903 | @section Uses of defadvice in SES | |
904 | @cindex defadvice | |
905 | @cindex undo-more | |
906 | @cindex copy-region-as-kill | |
907 | @cindex yank | |
908 | ||
909 | @table @code | |
910 | @item undo-more | |
911 | Defines a new undo element format (@var{fun} . @var{args}), which | |
912 | means ``undo by applying @var{fun} to @var{args}''. For spreadsheet | |
913 | buffers, it allows undos in the data area even though that's outside | |
914 | the narrowing. | |
915 | ||
916 | @item copy-region-as-kill | |
917 | When copying from the print area of a spreadsheet, treat the region as | |
918 | a rectangle and attach each cell's formula and printer as 'ses | |
919 | properties. | |
920 | ||
921 | @item yank | |
922 | When yanking into the print area of a spreadsheet, first try to yank | |
923 | as cells (if the yank text has 'ses properties), then as tab-separated | |
924 | formulas, then (if all else fails) as a single formula for the current | |
925 | cell. | |
926 | @end table | |
927 | ||
928 | @c =================================================================== | |
929 | @node Index, Acknowledgements, For Gurus, Top | |
930 | @unnumbered Index | |
931 | ||
932 | @printindex cp | |
933 | ||
934 | @c =================================================================== | |
935 | ||
936 | @node Acknowledgements, GNU Free Documentation License, Index, Top | |
937 | @chapter Acknowledgements | |
938 | ||
939 | Coding by: | |
940 | @quotation | |
941 | Jonathan Yavner @email{jyavner@@member.fsf.org}@* | |
67525fb9 JY |
942 | Stefan Monnier @email{monnier@@gnu.org}@* |
943 | Shigeru Fukaya @email{shigeru.fukaya@@gmail.com} | |
4009494e GM |
944 | @end quotation |
945 | ||
946 | @noindent | |
947 | Texinfo manual by: | |
948 | @quotation | |
949 | Jonathan Yavner @email{jyavner@@member.fsf.org}@* | |
950 | Brad Collins <brad@@chenla.org> | |
951 | @end quotation | |
952 | ||
953 | @noindent | |
954 | Ideas from: | |
955 | @quotation | |
956 | Christoph Conrad @email{christoph.conrad@@gmx.de}@* | |
957 | CyberBob @email{cyberbob@@redneck.gacracker.org}@* | |
958 | Syver Enstad @email{syver-en@@online.no}@* | |
959 | Ami Fischman @email{fischman@@zion.bpnetworks.com}@* | |
960 | Thomas Gehrlein @email{Thomas.Gehrlein@@t-online.de}@* | |
961 | Chris F.A. Johnson @email{c.f.a.johnson@@rogers.com}@* | |
962 | Yusong Li @email{lyusong@@hotmail.com}@* | |
963 | Juri Linkov @email{juri@@jurta.org}@* | |
964 | Harald Maier @email{maierh@@myself.com}@* | |
965 | Alan Nash @email{anash@@san.rr.com}@* | |
966 |