[PATCH] org-refile.el: Add org-refile-reverse which toggles org-reverse-note-order

[PATCH] org-refile.el: Add org-refile-reverse which toggles org-reverse-note-order

[Adam Spiers]

This is useful for prepending to the start of the target headline
instead of appending to the end, or vice-versa depending on
org-reverse-note-order.
---
 doc/org-manual.org | 10 ++++++++++
 etc/ORG-NEWS       |  9 +++++++++
 lisp/org-keys.el   |  1 +
 lisp/org-refile.el | 11 +++++++++++
 4 files changed, 31 insertions(+)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 3eb745b5d..e499367b7 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -7190,6 +7190,16 @@ special command:
   Copying works like refiling, except that the original note is not
   deleted.
 
+- {{{kbd(C-c C-M-w)}}} (~org-refile-reverse~) ::
+
+  #+kindex: C-c C-M-w
+  #+findex: org-refile-reverse
+  Works like refiling, except that it temporarily toggles how the
+  value of ~org-reverse-note-order~ applies to the current buffer.  So
+  if ~org-refile~ would append the entry as the last entry under the
+  target header, ~org-refile-reverse~ will prepend it as the first
+  entry, and vice-versa.
+
 ** Archiving
 :PROPERTIES:
 :DESCRIPTION: What to do with finished products.
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 10658a970..a3c8397fc 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -267,6 +267,15 @@ Source code block header argument =:file-mode= can set file
 permissions if =:file= argument is provided.
 
 ** New commands
+*** ~org-refile-reverse~
+
+Use default keybinding =<C-c C-M-w>= to run command
+~org-refile-reverse~.  It is almost identical to ~org-refile~, except
+that it temporarily toggles how ~org-reverse-note-order~ applies to
+the current buffer.  So if ~org-refile~ would append the entry as the
+last entry under the target heading, ~org-refile-reverse~ will prepend
+it as the first entry, and vice-versa.
+
 *** ~org-table-header-line-mode~
 
 Turn on a minor mode to display the first data row of the table at
diff --git a/lisp/org-keys.el b/lisp/org-keys.el
index 37df29983..902651175 100644
--- a/lisp/org-keys.el
+++ b/lisp/org-keys.el
@@ -582,6 +582,7 @@ (define-key org-mode-map (kbd "<backtab>") #'org-shifttab)
 (org-defkey org-mode-map (kbd "C-c ;") #'org-toggle-comment)
 (org-defkey org-mode-map (kbd "C-c C-w") #'org-refile)
 (org-defkey org-mode-map (kbd "C-c M-w") #'org-refile-copy)
+(org-defkey org-mode-map (kbd "C-c C-M-w") #'org-refile-reverse)
 (org-defkey org-mode-map (kbd "C-c /") #'org-sparse-tree) ;minor-mode reserved
 (org-defkey org-mode-map (kbd "C-c \\") #'org-match-sparse-tree) ;minor-mode r.
 (org-defkey org-mode-map (kbd "C-c RET") #'org-ctrl-c-ret)
diff --git a/lisp/org-refile.el b/lisp/org-refile.el
index 7eb0a9643..c6ff35535 100644
--- a/lisp/org-refile.el
+++ b/lisp/org-refile.el
@@ -384,6 +384,17 @@ (defun org-refile-copy ()
 
 (defvar org-capture-last-stored-marker)
 
+;;;###autoload
+(defun org-refile-reverse (&optional arg default-buffer rfloc msg)
+  "Invoke `org-refile', but temporarily toggling how
+~org-reverse-note-order~ applies to the current buffer.  So if
+`org-refile' would append the entry as the last entry under the
+target heading, ~org-refile-reverse~ will prepend it as the first
+entry, and vice-versa."
+  (interactive "P")
+  (let ((org-reverse-note-order (not (org-notes-order-reversed-p))))
+    (org-refile arg default-buffer rfloc msg)))
+
 ;;;###autoload
 (defun org-refile (&optional arg default-buffer rfloc msg)
   "Move the entry or entries at point to another heading.
-- 
2.27.0

Re: [PATCH] org-refile.el: Add org-refile-reverse which toggles org-reverse-note-order

[Bastien]

Hi Adam,

Adam Spiers <orgmode@adamspiers.org> writes:

> This is useful for prepending to the start of the target headline
> instead of appending to the end, or vice-versa depending on
> org-reverse-note-order.

I think this would be useful.  What others think?

I'm storing this for after 9.4 since we are in feature freeze.

Thanks,

-- 
 Bastien

Re: [PATCH] org-refile.el: Add org-refile-reverse which toggles org-reverse-note-order

[Amin Bandali]

[-- Attachment #1: Type: text/plain, Size: 357 bytes --]

Bastien writes:

> Hi Adam,
>
> Adam Spiers <orgmode@adamspiers.org> writes:
>
>> This is useful for prepending to the start of the target headline
>> instead of appending to the end, or vice-versa depending on
>> org-reverse-note-order.
>
> I think this would be useful.  What others think?
>
[...]

+1; sounds quite useful to me as well.

Thank you both.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 857 bytes --]

Re: [PATCH] org-refile.el: Add org-refile-reverse which toggles org-reverse-note-order

[Adam Spiers]

On Sun, Sep 06, 2020 at 02:10:09AM -0400, Amin Bandali wrote:
>Bastien writes:
>
>> Hi Adam,
>>
>> Adam Spiers <orgmode@adamspiers.org> writes:
>>
>>> This is useful for prepending to the start of the target headline
>>> instead of appending to the end, or vice-versa depending on
>>> org-reverse-note-order.
>>
>> I think this would be useful.  What others think?
>>
>[...]
>
>+1; sounds quite useful to me as well.
>
>Thank you both.

Is it time to revisit this yet?

Thanks!

Re: [PATCH] org-refile.el: Add org-refile-reverse which toggles org-reverse-note-order

[Kyle Meyer]

Thanks for the patch.

Adam Spiers writes:

> This is useful for prepending to the start of the target headline
> instead of appending to the end, or vice-versa depending on
> org-reverse-note-order.

It sounds like Bastien and Amin would also find this useful.  I would
have liked to see a few more people chime in because I'm lukewarm on it
myself, as I tend to think things like this are better suited for
personal customization.

In any case, I think we should go forward with it.  Could you add a
changelog entry to the commit message?

> diff --git a/doc/org-manual.org b/doc/org-manual.org
> index 3eb745b5d..e499367b7 100644
> --- a/doc/org-manual.org
> +++ b/doc/org-manual.org
> @@ -7190,6 +7190,16 @@ special command:
>    Copying works like refiling, except that the original note is not
>    deleted.
>  
> +- {{{kbd(C-c C-M-w)}}} (~org-refile-reverse~) ::
> +
> +  #+kindex: C-c C-M-w
> +  #+findex: org-refile-reverse
> +  Works like refiling, except that it temporarily toggles how the

It seems a bit odd to say it "works like refiling" when it _is_
refiling.  Perhaps "Works like ~org-refile~ ..." or the common "Like X
but ..." pattern?

> +  value of ~org-reverse-note-order~ applies to the current buffer.  So

I think the "applies to the current buffer" (here and in other spots)
doesn't add anything while possibly confusing the reader into thinking
that the toggling isn't in effect when refiling an entry to another
buffer.

[...]
> +;;;###autoload
> +(defun org-refile-reverse (&optional arg default-buffer rfloc msg)
> +  "Invoke `org-refile', but temporarily toggling how
> +~org-reverse-note-order~ applies to the current buffer.  So if

s/~org-reverse-note-order~/`org-reverse-note-order'/

The first line of the docstring should be self-contained for apropos and
friends.  Perhaps

  Invoke `org-refile' with `org-reverse-note-order' inverted.

However, there's also the question of what toggling means for users that
have configured org-reverse-note-order to a set of regular expressions.
I think it's worth noting in the docstring that this case is treated the
same as t (i.e. any non-nil value is mapped to nil).

> +`org-refile' would append the entry as the last entry under the
> +target heading, ~org-refile-reverse~ will prepend it as the first
> +entry, and vice-versa."

s/~org-refile-reverse~/`org-refile-reverse'/

> +  (interactive "P")
> +  (let ((org-reverse-note-order (not (org-notes-order-reversed-p))))
> +    (org-refile arg default-buffer rfloc msg)))
> +
>  ;;;###autoload
>  (defun org-refile (&optional arg default-buffer rfloc msg)
>    "Move the entry or entries at point to another heading.
> -- 
> 2.27.0

Re: [PATCH] org-refile.el: Add org-refile-reverse which toggles org-reverse-note-order

[Bastien]

Hi Adam,

Kyle Meyer <kyle@kyleam.com> writes:

> Thanks for the patch.
>
> Adam Spiers writes:
>
>> This is useful for prepending to the start of the target headline
>> instead of appending to the end, or vice-versa depending on
>> org-reverse-note-order.
>
> It sounds like Bastien and Amin would also find this useful.  I would
> have liked to see a few more people chime in because I'm lukewarm on it
> myself, as I tend to think things like this are better suited for
> personal customization.
>
> In any case, I think we should go forward with it.  Could you add a
> changelog entry to the commit message?

Sorry if I miss latest Adam's patch, with a changelog entry and a
commit message -- Adam, would you mind resending it?

Thanks

Re: [PATCH] org-refile.el: Add org-refile-reverse which toggles org-reverse-note-order

[Bastien]

Hi Adam,

Adam Spiers <orgmode@adamspiers.org> writes:

> This is useful for prepending to the start of the target headline
> instead of appending to the end, or vice-versa depending on
> org-reverse-note-order.

Applied in master as 9e127a720, thanks.

-- 
 Bastien

Re: [PATCH] org-refile.el: Add org-refile-reverse which toggles org-reverse-note-order

[Samuel Wales]

sounds good to decouple those, but i interpret org-refile-reverse to
mean "refile in reverse".  from a to b -> from b to a.  fwiw.  thus,
you could be on a and goto b and then do a reverse refile.  that would
be a useful operation.  so i suggest org-refile-reverse-order or so.

On 5/15/21, Bastien <bzg@gnu.org> wrote:
> Hi Adam,
>
> Adam Spiers <orgmode@adamspiers.org> writes:
>
>> This is useful for prepending to the start of the target headline
>> instead of appending to the end, or vice-versa depending on
>> org-reverse-note-order.
>
> Applied in master as 9e127a720, thanks.
>
> --
>  Bastien
>
>


-- 
The Kafka Pandemic

Please learn what misopathy is.
https://thekafkapandemic.blogspot.com/2013/10/why-some-diseases-are-wronged.html