doc/misc/ses.texi

3 @setfilename ../../info/ses.info
32 * @acronym{SES}: (ses).                   Simple Emacs Spreadsheet.
112 First, visit a new file with the @file{.ses} extension.
172 An alternative is to use the special function @code{ses+} instead of
176 (ses+ A2 A3 A4 A5)
180 you can use the @code{ses-range} macro to refer to a range of cells by
184 (apply 'ses+ (ses-range A2 A5))
187 (The @code{apply} is necessary because @code{ses-range} produces a
190 Alternatively you can use the @code{!} modifier of @code{ses-range} to
192 @code{+} instead of @code{ses+}:
195 (apply '+ (ses-range A2 A5 !))
204 @findex ses-jump
205 @findex ses-mark-row
206 @findex ses-mark-column
207 @findex ses-mark-whole-buffer
212 with ".ses".  For example, @kbd{C-x C-f test.ses @key{RET}}.
223 Moves point to cell, specified by identifier (@code{ses-jump}).
242 Highlight current row (@code{ses-mark-row}).
245 Highlight current column (@code{ses-mark-column}).
248 Highlight all cells (@code{mark-whole-buffer}).
267 @findex ses-read-cell
268 @findex ses-read-symbol
269 @findex ses-edit-cell
270 @findex ses-recalculate-cell
271 @findex ses-recalculate-all
278 Self-insert a digit (@code{ses-read-cell}).
281 Self-insert a negative number (@code{ses-read-cell}).
284 Self-insert a fractional number (@code{ses-read-cell}).
288 is inserted for you (@code{ses-read-cell}).
292 (@code{ses-read-cell}).  To access another cell's value, just use its
300 to list the named cells symbols in a help buffer.
304 Enter a symbol (ses-read-symbol).  @acronym{SES} remembers all symbols that have
314 Edit the existing formula in the current cell (@code{ses-edit-cell}).
317 Force recalculation of the current cell or range (@code{ses-recalculate-cell}).
320 Recalculate the entire spreadsheet (@code{ses-recalculate-all}).
333 @findex ses-insert-row
334 @findex ses-insert-column
335 @findex ses-delete-row
336 @findex ses-delete-column
337 @findex ses-set-column-width
338 @findex ses-forward-or-insert
339 @findex ses-append-row-jump-first-column
346 (@code{ses-insert-row})
349 (@code{ses-insert-column})
352 (@code{ses-delete-row})
355 (@code{ses-delete-column})
358 (@code{ses-set-column-width})
363 (@code{ses-forward-or-insert}).
367 (@code{ses-append-row-jump-first-column}).
428      (t (ses-center-span x ?# 'ses-prin1))))
454 @findex ses-read-cell-printer
455 Enter a printer for current cell or range (@code{ses-read-cell-printer}).
458 @findex ses-read-column-printer
459 Enter a printer for the current column (@code{ses-read-column-printer}).
462 @findex ses-read-default-printer
464 (@code{ses-read-default-printer}).
467 The @code{ses-read-@var{xxx}-printer} allows the following commands during editing:
472 To browse history: the @code{ses-read-@var{xxx}-printer} commands have
480 To list the local printers in a help buffer.
488 Except for @code{ses-prin1}, the other standard printers are suitable
494 @item ses-center
497 @item ses-center-span
500 @item ses-dashfill
503 @item ses-dashfill-span
506 @item ses-tildefill-span
509 @item ses-prin1
517 @findex ses-define-local-printer
519 @code{ses-define-local-printer}.  For instance, define a printer
522 @code{ses-define-local-printer} on @samp{foo} to redefine it as
531 @code{3.10@dmn{}@euro{}}. To do so in any non read-only SES buffer,
535 (defun my-ses-mode-hook ()
536   (unless buffer-read-only
537     (ses-define-local-printer
543 	(t (ses-center-span x ?# 'ses-prin1)))))))
544 (add-hook 'ses-mode-hook 'my-ses-mode-hook)
547 If you replace command @code{ses-define-local-printer} by function
548 @code{ses-define-if-new-local-printer}
549 @findex ses-define-if-new-local-printer
565 @code{ses-define-local-printer}.
577       (t (ses-center-span val ?# 'ses-prin1))))
591 s-expression (using @code{ses-prin1}), centered and surrounded by
608    (t (ses-center x 0 ?=))))
611 Because @code{=fill} uses the standard printer @code{ses-center} without
612 explicitly passing any printer to it, @code{ses-center} will call the
623    ((stringp x) (ses-center x 0 ?= " %s "))
624    (t (ses-center-span x ?# 'ses-prin1))))
636 @findex ses-clear-cell-backward
637 @findex ses-clear-cell-forward
643 Clear cell and move left (@code{ses-clear-cell-backward}).
646 Clear cell and move right (@code{ses-clear-cell-forward}).
658 @findex ses-kill-override
663 @findex ses-yank-pop
687 and then clear (@code{ses-kill-override}).
695 When pasting cells that were cut from a @acronym{SES} buffer, the print text is
720 element from the kill ring (@code{ses-yank-pop}).  Unlike the standard
729 @vindex ses-mode-hook
736 can be customized.  Look in group ``ses''.
739 cell.  You can customize @code{ses-after-entry-functions} to move left or
743 @code{ses-mode-hook} is a normal mode hook (list of functions to
744 execute when starting @acronym{SES} mode for a buffer).
765 @findex ses-read-header-row
770 (@code{ses-set-header-row}).
771 @findex ses-set-header-row
782 @item M-x ses-rename-cell
783 @findex ses-rename-cell
786 @item M-x ses-repair-cell-reference-all
787 @findex ses-repair-cell-reference-all
791 repair that use function @code{ses-repair-cell-reference-all}
809 @findex ses-renarrow-buffer
810 @findex ses-reprint-all
813 buffer is narrowed to show only the print area.  The print area is
823 Show only print area (@code{ses-renarrow-buffer}).
828 (@code{ses-reprint-all}).
834 @findex ses-insert-range-click
835 @findex ses-insert-range
836 @findex ses-insert-ses-range-click
837 @findex ses-insert-ses-range
852 The macro @code{(ses-range @var{from} @var{to})} evaluates to a list of
855 (apply '+ (ses-range A1 A3))
859 (apply '+ (ses-range A1 A4))
870 Inserts "A1 B1 C1" @code{(ses-insert-range-click})
873 Keyboard version (@code{ses-insert-range}).
876 Inserts "(ses-range A1 C1)" (@code{ses-insert-ses-range-click}).
879 Keyboard version (@code{ses-insert-ses-range}).
884 the formula relocator will delete the ses-range from the formula.
890 Flags can be added to @code{ses-range} immediately after the @var{to}
896 or @code{*skip*}. For instance @code{(ses-range A1 A4 !)} will do the
902 instance @code{(ses-range A1 A4 _ "empty")} will do the same as
904 are empty. Similarly, @code{(ses-range A1 A4 _ )} will do the same as
940 @findex ses-sort-column
941 @findex ses-sort-column-click
946 (@code{ses-sort-column}).  The rows (or partial rows if the range
952 (@code{ses-sort-column-click}).
971 @findex ses-delete-blanks
972 @findex ses-average
973 @findex ses+
979 @item (ses-delete-blanks &rest @var{args})
982 that @code{ses-range} has a @code{!} modifier that allows to remove
985 (ses-range A1 A5 !)
989 (apply 'ses-delete-blanks (ses-range A1 A5 <))
992 @item (ses+ &rest @var{args})
995 @item (ses-average @var{list})
997 as a single argument, since you'll probably use it with @code{ses-range}.
1003 @findex ses-truncate-cell
1004 @findex ses-recalculate-cell
1027 Confine a cell to its own column (@code{ses-truncate-cell}).  This
1035 recalculation/reprinting (@code{ses-recalculate-cell}).  You can use
1040 @findex ses-prin1
1041 @code{ses-prin1} is substituted.  This is useful when your column printer
1053 @findex ses-export-tsv
1054 @findex ses-export-tsf
1058 Export a range of cells as tab-separated values (@code{ses-export-tsv}).
1060 Export a range of cells as tab-separated formulas (@code{ses-export-tsf}).
1064 another buffer.  Columns are separated by tabs, rows by newlines.
1104 details.  @acronym{SES} supports this organization via the @code{ses-select}
1108 @item (ses-select @var{fromrange} @var{test} @var{torange})
1116 (ses-average (ses-select (ses-range A1 A5) 'Smith (ses-range B1 B5)))
1126 File @file{etc/ses-example.el} in the Emacs distribution is an example of a
1170 Emacs will be scrolling the buffer after the end of a command, and
1186 by using @code{ses-rename-cell}.
1187 @findex ses-rename-cell
1191 formula contains some range @code{(ses-range @var{cell1} @var{cell2})}
1205 @code{ses-rename-cell} is most of the time preferable.
1210 (ses-cell-value row 0)
1219 @findex ses-reconstruct-all
1226 local variables (specifying @acronym{SES} mode for the buffer, etc.).
1239 structures that area stored in buffer-local variables.  If the data
1245 (@code{ses-reconstruct-all}).
1251 @cindex buffer-local variables
1252 @cindex variables, buffer-local
1258 You can override the variable @code{ses--symbolic-formulas} to be a list of
1263 For an example of this, see file @file{etc/ses-example.ses}.
1266 into variables, you must declare these variables as buffer-locals in
1299 a rectangle and attach each cell's formula and printer as 'ses
1304 as cells (if the yank text has 'ses properties), then as tab-separated