diff options
| author | Kevin J. Foley <kevin@kevinjfoley.me> | 2020-10-18 21:30:52 -0400 |
|---|---|---|
| committer | Kyle Meyer <kyle@kyleam.com> | 2020-10-20 00:35:10 -0400 |
| commit | 2d1e2606e7bad92655ad5ddd207fc14bbaed7e5d (patch) | |
| tree | 4a25df0b134b9fe65730b2912c2cba20c67bac2c | |
| parent | b1de0c8e4b2a6cf4c338d200df76d2e2df29412e (diff) | |
| download | org-mode-2d1e2606e7bad92655ad5ddd207fc14bbaed7e5d.tar.gz | |
org-refile.el (org-refile): Add description of RFLOC to docstring
* lisp/org-refile.el (org-refile): Document structure of RFLOC
parameter.
| -rw-r--r-- | lisp/org-refile.el | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/lisp/org-refile.el b/lisp/org-refile.el index 7eb0a96..2a3fad5 100644 --- a/lisp/org-refile.el +++ b/lisp/org-refile.el @@ -414,7 +414,16 @@ being set to t and copy to the target location, don't move it. Beware that keeping refiled entries may result in duplicated ID properties. -RFLOC can be a refile location obtained in a different way. +RFLOC can be a refile location obtained in a different way. It +should be a list with the following 4 elements: + +1. Name - an identifier for the refile location, typically the +headline text +2. File - the file the refile location is in +3. nil - used for generating refile location candidates, not +needed when passing RFLOC +4. Position - the position in the specified file of the +headline to refile under MSG is a string to replace \"Refile\" in the default prompt with another verb. E.g. `org-copy' sets this parameter to \"Copy\". |