diff options
author | Carsten Dominik <carsten.dominik@gmail.com> | 2013-09-02 11:33:54 +0200 |
---|---|---|
committer | Carsten Dominik <carsten.dominik@gmail.com> | 2013-09-02 11:33:54 +0200 |
commit | 3f10db731c81944536cc592b62ba15796af6a3df (patch) | |
tree | f1d37eba499b9c01c3b655d46f936f9a10524553 | |
parent | 09bcbc42283060fadde4c2d4e6c1b262e6748a4d (diff) | |
download | org-mode-3f10db731c81944536cc592b62ba15796af6a3df.tar.gz |
Improve docstring of `orgtbl-radio-table-templates'
* lisp/org-table.el (orgtbl-radio-table-templates): Improve docstring.
-rw-r--r-- | lisp/org-table.el | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/lisp/org-table.el b/lisp/org-table.el index 8b68300..a5e1751 100644 --- a/lisp/org-table.el +++ b/lisp/org-table.el @@ -94,6 +94,22 @@ this variable requires a restart of Emacs to become effective." | | | ")) "Templates for radio tables in different major modes. +Each template must define lines that will be treated as a comment and that +must contain the \"BEGIN RECEIVE ORGTBL %n\" and \"END RECEIVE ORGTBL\" +lines where \"%n\" will be replaced with the name of the table during +insertion of the tempate. The transformet table will later be inserted +between these lines. + +The template should also contain a minimal table in a multiline comment. +If multiline comments are not possible in the buffer language, +you can pack it into a string that will not be used when the code +is compiled or executed. Above the table will you need a line with +the fixed string \"#+ORGTBL: SEND\", followed by instruction on how to +convert the table into a data structure useful in the +language of the buffer. Check the manual for the section on +\"Translator functions\", and more generally check out +http://orgmode.org/manual/Tables-in-arbitrary-syntax.html#Tables-in-arbitrary-syntax + All occurrences of %n in a template will be replaced with the name of the table, obtained by prompting the user." :group 'org-table |