Merge from origin/emacs-24

[gnu-emacs] / lisp / org / org-archive.el

diff --git a/lisp/org/org-archive.el b/lisp/org/org-archive.el
index 29b883824ef6ba1a50a7cf96c6b1919de75e0a20..2637623abba7eb115277fd73d9be367cbaee4ed0 100644 (file)
--- a/lisp/org/org-archive.el
+++ b/lisp/org/org-archive.el
@@ -1,6 +1,6 @@
 ;;; org-archive.el --- Archiving for Org-mode
 
-;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
+;; Copyright (C) 2004-2015 Free Software Foundation, Inc.
 
 ;; Author: Carsten Dominik <carsten at orgmode dot org>
 ;; Keywords: outlines, hypermedia, calendar, wp
@@ -71,6 +71,15 @@ This variable is obsolete and has no effect anymore, instead add or remove
   :group 'org-archive
   :type 'boolean)
 
+(defcustom org-archive-file-header-format "\nArchived entries from file %s\n\n"
+  "The header format string for newly created archive files.
+When nil, no header will be inserted.
+When a string, a %s formatter will be replaced by the file name."
+  :group 'org-archive
+  :version "24.4"
+  :package-version '(Org . "8.0")
+  :type 'string)
+
 (defcustom org-archive-subtree-add-inherited-tags 'infile
   "Non-nil means append inherited tags when archiving a subtree."
   :group 'org-archive
@@ -126,6 +135,7 @@ information."
          (match-string 1))
         (t org-archive-location))))))
 
+;;;###autoload
 (defun org-add-archive-files (files)
   "Splice the archive files into the list of files.
 This implies visiting all these files and finding out what the
@@ -181,6 +191,7 @@ if LOCATION is not given, the value of `org-archive-location' is used."
              (file-name-nondirectory
               (buffer-file-name (buffer-base-buffer))))))
 
+;;;###autoload
 (defun org-archive-subtree (&optional find-done)
   "Move the current subtree to the archive.
 The archive can be a certain top-level heading in the current file, or in
@@ -220,8 +231,7 @@ this heading."
                       (error "No file associated to buffer"))))
            (olpath (mapconcat 'identity (org-get-outline-path) "/"))
            (time (format-time-string
-                  (substring (cdr org-time-stamp-formats) 1 -1)
-                  (current-time)))
+                  (substring (cdr org-time-stamp-formats) 1 -1)))
            category todo priority ltags itags atags
            ;; end of variables that will be used for saving context
            location afile heading buffer level newfile-p infile-p visiting
@@ -277,9 +287,9 @@ this heading."
              (let ((org-insert-mode-line-in-empty-file t)
                    (org-inhibit-startup t))
                (call-interactively 'org-mode)))
-         (when newfile-p
+         (when (and newfile-p org-archive-file-header-format)
            (goto-char (point-max))
-           (insert (format "\nArchived entries from file %s\n\n"
+           (insert (format org-archive-file-header-format
                            (buffer-file-name this-buffer))))
          (when datetree-date
            (require 'org-datetree)
@@ -369,6 +379,7 @@ this heading."
     (if (looking-at "^[ \t]*$")
        (outline-next-visible-heading 1))))
 
+;;;###autoload
 (defun org-archive-to-archive-sibling ()
   "Archive the current heading by moving it under the archive sibling.
 The archive sibling is a sibling of the heading with the heading name
@@ -429,8 +440,7 @@ sibling does not exist, it will be created at the end of the subtree."
        (org-set-property
         "ARCHIVE_TIME"
         (format-time-string
-         (substring (cdr org-time-stamp-formats) 1 -1)
-         (current-time)))
+         (substring (cdr org-time-stamp-formats) 1 -1)))
        (outline-up-heading 1 t)
        (hide-subtree)
        (org-cycle-show-empty-lines 'folded)
@@ -483,6 +493,7 @@ When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
            (goto-char end)))))
     (message "%d trees archived" cntarch)))
 
+;;;###autoload
 (defun org-toggle-archive-tag (&optional find-done)
   "Toggle the archive tag for the current headline.
 With prefix ARG, check all children of current headline and offer tagging
@@ -537,4 +548,8 @@ This command is set with the variable `org-archive-default-command'."
 
 (provide 'org-archive)
 
+;; Local variables:
+;; generated-autoload-file: "org-loaddefs.el"
+;; End:
+
 ;;; org-archive.el ends here