mirrors/org-mode
0
0
Fork 1
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-09-30 04:37:57 +00:00
Code Releases Activity

org-refile.el (org-refile): Add description of RFLOC to docstring

Browse source 
* lisp/org-refile.el (org-refile): Document structure of RFLOC
parameter.
This commit is contained in:
Kevin J. Foley 2020-10-18 21:30:52 -04:00 committed by Kyle Meyer
parent b1de0c8e4b
commit 2d1e2606e7
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
lisp/org-refile.el
View file

@ -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 Beware that keeping refiled entries may result in duplicated ID
properties. 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 MSG is a string to replace \"Refile\" in the default prompt with
another verb. E.g. `org-copy' sets this parameter to \"Copy\". another verb. E.g. `org-copy' sets this parameter to \"Copy\".