mirror/org-mode
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-11-26 07:33:39 +00:00
Code

Improve docstring of `orgtbl-radio-table-templates'

Browse Source 
* lisp/org-table.el (orgtbl-radio-table-templates): Improve docstring.
This commit is contained in:
Carsten Dominik 2013-09-02 11:33:54 +02:00
parent 09bcbc4228
commit 3f10db731c
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
lisp/org-table.el
View File

@ -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