emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Eric Abrahamsen <eric@ericabrahamsen.net>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH RFC] subtree archive hook?
Date: Mon, 13 Oct 2014 18:13:20 +0200	[thread overview]
Message-ID: <87r3ycne1r.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <87vbnp2wix.fsf@ericabrahamsen.net> (Eric Abrahamsen's message of "Sun, 12 Oct 2014 22:27:34 +0800")

Hello,

Eric Abrahamsen <eric@ericabrahamsen.net> writes:

> I think it would be useful to have a hook that runs before archiving a
> subtree. I'm attaching two patches: one that includes a hook in the
> archive process, and another (by way of an example) that adds a function
> to that hook for the org-attach library. You can set the option
> `org-attach-archive-delete' to a non-nil value to have org-attach delete
> a subtree's attachments when you archive it.
>
> Let me know what you think!

Thanks for the patch. I think it could be useful. Some comments follow.

> +(defvar org-archive-hook nil
> +  "Hook run after successfully archiving a subtree.
> +
> +Hook functions are called with point on the subtree in the
> +original file. At this stage, the subtree has been added to the

You need two spaces after full stop.

> * lisp/org-attach.el (org-attach-archive-delete): New option
>   controlling what to do with attachments when archiving.
>   (org-attach-archive-delete-maybe): New function that runs as a hook
>   on org-attach-hook. Checks the value of org-attach-archive-delete,

Two spaces are needed.

>   and behaves accordingly.
> ---
>  lisp/org-attach.el | 32 ++++++++++++++++++++++++++++++++
>  1 file changed, 32 insertions(+)
>
> diff --git a/lisp/org-attach.el b/lisp/org-attach.el
> index 5c341a5..cc077c4 100644
> --- a/lisp/org-attach.el
> +++ b/lisp/org-attach.el
> @@ -120,6 +120,18 @@ lns   create a symbol link.  Note that this is not supported
>  	  (const :tag "Link to origin location" t)
>  	  (const :tag "Link to the attach-dir location" attached)))
>  
> +(defcustom org-attach-archive-delete nil
> +  "If a subtree is archived, should its attachments be deleted?

  Non-nil means attachments are deleted upon archiving a subtree.

> +Set to nil to never delete attachments, t to always delete
> +attachments, and the symbol query to ask."

I think you only need to document the `query' symbol, e.g.,

  When set to `query', ask the user instead.

> +  :group 'org-attach
> +  :version "24.1"
> +  :type '(choice
> +	  (const :tag "Never delete attachments" nil)
> +	  (const :tag "Always delete attachments" t)
> +	  (const :tag "Query the user" query)))

You need :package-version and :version is "25.1".

>  ;;;###autoload
>  (defun org-attach ()
>    "The dispatcher for attachment commands.
> @@ -475,6 +487,26 @@ Basically, this adds the path to the attachment directory, and a \"file:\"
>  prefix."
>    (concat "file:" (org-attach-expand file)))
>  
> +(defun org-attach-archive-delete-maybe ()
> +  "Maybe delete subtree attachments when archiving.
> +
> +This function is called by `org-archive-hook'. The option

Two spaces.

> +`org-attach-archive-delete' controls its behavior."
> +  (let (delete-p)
> +    (setq delete-p
> +	  (cond
> +	   ((eq org-attach-archive-delete 'query)
> +	    (y-or-n-p "Delete all attachments?"))
> +	   ((null org-attach-archive-delete)
> +	    nil)
> +	   (org-attach-archive-delete
> +	    t)
> +	   (t nil)))
> +    (when delete-p
> +      (org-attach-delete-all t))))

  (defun org-attach-archive-delete-maybe ()
    (when (if (eq org-attach-archive-delete 'query)
              (yes-or-no-p "Delete all attachments? ")
            org-attach-archive-delete)
      (org-attach-delete-all t)))


Regards,

-- 
Nicolas Goaziou

  parent reply	other threads:[~2014-10-13 16:12 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-10-12 14:27 [PATCH RFC] subtree archive hook? Eric Abrahamsen
2014-10-12 15:22 ` Aaron Ecay
2014-10-12 16:10   ` Eric Abrahamsen
2014-10-12 18:13     ` Aaron Ecay
2014-10-12 18:45       ` Eric Abrahamsen
2014-10-13 16:13 ` Nicolas Goaziou [this message]
2014-10-14  1:55   ` Eric Abrahamsen
2014-10-16 17:03     ` Nicolas Goaziou

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87r3ycne1r.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --cc=emacs-orgmode@gnu.org \
    --cc=eric@ericabrahamsen.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).