diff options
author | Nicolas Goaziou <mail@nicolasgoaziou.fr> | 2018-01-03 15:25:33 +0100 |
---|---|---|
committer | Nicolas Goaziou <mail@nicolasgoaziou.fr> | 2018-01-03 15:25:33 +0100 |
commit | 7e8e12be21e3fca4351748c3780b486e4daedf16 (patch) | |
tree | 2f57a951baaff70efbd1fd605ac7f3b00903ed96 | |
parent | 16c7ae7996a95f8091eb80a61dd85db817ca5d90 (diff) | |
download | org-mode-a2721a0e8ae5ef4fd2e335835324d3e424aa057e.tar.gz |
org-table: Improve a docstringrelease_9.1.6
* lisp/org-table.el (org-table-import): Improve docstring.
Fixes: 22597
-rw-r--r-- | lisp/org-table.el | 25 |
1 files changed, 19 insertions, 6 deletions
diff --git a/lisp/org-table.el b/lisp/org-table.el index d12731c..2aa8be5 100644 --- a/lisp/org-table.el +++ b/lisp/org-table.el @@ -644,17 +644,30 @@ nil When nil, the command tries to be smart and figure out the (org-table-align)))) ;;;###autoload -(defun org-table-import (file arg) +(defun org-table-import (file separator) "Import FILE as a table. -The file is assumed to be tab-separated. Such files can be produced by most -spreadsheet and database applications. If no tabs (at least one per line) -are found, lines will be split on whitespace into fields." + +The command tries to be smart and figure out the separator in the +following way: + + - when each line contains a TAB, assume TAB-separated material + - when each line contains a comma, assume CSV material + - else, assume one or more SPACE characters as separator. + +When non-nil, SEPARATOR specifies the field separator in the +lines. It can have the following values: + +(4) Use the comma as a field separator +(16) Use a TAB as field separator +(64) Prompt for a regular expression as field separator +integer When a number, use that many spaces, or a TAB, as field separator +regexp When a regular expression, use it to match the separator." (interactive "f\nP") - (or (bolp) (newline)) + (unless (bolp) (insert "\n")) (let ((beg (point)) (pm (point-max))) (insert-file-contents file) - (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg))) + (org-table-convert-region beg (+ (point) (- (point-max) pm)) separator))) ;;;###autoload |