Commit 20908596 authored by Carsten Dominik's avatar Carsten Dominik
Browse files

2008-04-27 Carsten Dominik <dominik@science.uva.nl>

	* org/org.el (org-html-level-start): Always have id's in HTML
	(org-export-as-html): Use `org-link-protocols' to
	retrieve the export form of the link.
	(org-add-link-type): Final parameter renamed from PUBLISH.  Better
	documentation of how it is to be used.  Avoid double entries for
	the same link type.
	(org-add-link-props): New function.
	(org-modules-loaded): New variable.
	(org-load-modules-maybe, org-set-modules): New function.
	(org-modules): New option.
	(org-mode, org-cycle, orgstruct-mode, org-run-like-in-org-mode)
	(orgtbl-mode, org-store-link, org-insert-link-global)
	(org-open-at-point): Call `org-load-modules-maybe'.
	(org-search-view): Add more text properties.
	(org-agenda-schedule, org-agenda-deadline): Allow also in
	search-type agendas.
	(org-search-view): Order of arguments has been changed.
	Interpret prefix-arg as TODO-ONLY.
	(org-agenda, org-run-agenda-series, org-agenda-manipulate-query):
	Take new argument order of `org-search-view' into account.
	(org-todo-only): New variable.
	(org-search-syntax-table): New variable and function.
	(org-search-view): Do the search with the special syntax table.
	(define-obsolete-function-alias): Make work with XEmacs.
	(org-add-planning-info): Use old date as default when modifying an
	existing deadline or scheduled item.
	(org-agenda-compute-time-span): Make argument N optional.
	(org-agenda-format-date-aligned): Require `cal-iso'.
	(org-agenda-list): Include week into into agenda heading, don't
	list it at each date (only on Mondays).
	(org-read-date-analyze): Define local variable `iso-date'.
	(org-agenda-format-date-aligned): Remove dependency on
	`calendar-time-from-absolute'.
	(org-remember-apply-template, org-go-to-remember-target):
	Interpret filenames relative to `org-directory'.
	(org-complete): Silently fail when trying to complete
	keywords that don't have a default value.
	(org-get-current-options): Added a #+DATE: option.
	(org-additional-option-like-keywords): Removed "DATE:" from the
	list of additional keywords.
	(org-export-as-html): Removed (current-time) as unnecessary second
	argument of `format-time-string'.
	(org-clock-find-position): Handle special case at end of
	buffer.
	(org-agenda-day-view): New argument DAY-OF-YEAR, pass it on to
	`org-agenda-change-time-span'.
	(org-agenda-week-view): New argument ISO-WEEK, pass it on to
	`org-agenda-change-time-span'.
	(org-agenda-month-view): New argument MONTH, pass it on to
	`org-agenda-change-time-span'.
	(org-agenda-year-view):  New argument YEAR, pass it on to
	`org-agenda-change-time-span'.
	(org-agenda-change-time-span): New optional argument N, pass it on
	to `org-agenda-compute-time-span'.
	(org-agenda-compute-time-span): New argument N, interpret it by
	changing the starting day.
	(org-small-year-to-year): New function.
	(org-scheduled-past-days): Respect
	`org-scheduled-past-days'.
	(org-auto-repeat-maybe): Make sure that repeating
	dates are pushed into the future, and that the shift is at least
	one interval, never 0.
	(org-update-checkbox-count): Fix bug with checkbox
	counting.
	(org-add-note): New command.
	(org-add-log-setup): Renamed from `org-add-log-maybe'.
	(org-log-note-headings): New entry for plain notes (i.e. notes not
	related to state changes or clocking).
	(org-get-org-file): Check for availability of
	`remember-data-file'.
	(org-cached-entry-get): Allow a regexp value for
	`org-use-property-inheritance'.
	(org-use-property-inheritance): Allow regexp value.  Fix bug in
	customization type.
	(org-use-tag-inheritance): Allow a list and a regexp value for
	this variable.
	(org-scan-tags, org-get-tags-at): Implement selective tag
	inheritance.
	(org-entry-get): Respect value `selective' for the INHERIT
	argument.
	(org-tag-inherit-p, org-property-inherit-p): New functions.
	(org-agenda-format-date-aligned): Allow 10 characters for
	weekday, to acomodate German locale.
	(org-add-archive-files): New function.
	(org-agenda-files): New argument `ext', to
	get archive files as well.
	(org-tbl-menu): Protect the use of variables that
	are only available when org-table.el gets loaded.
	(org-read-agenda-file-list): Error if `org-agenda-files' is a
	single directory.
	(org-open-file): Allow a batch process to trigger
	waiting after executing a system command.
	(org-store-link): Link to headline when there is not
	target and no region in an org-mode buffer when creating a link.
	(org-link-types-re): New variable.
	(org-make-link-regexps): Compute `org-link-types-re'.
	(org-make-link-description-function): New option.
	(org-agenda-date, org-agenda-date-weekend): New faces.
	(org-archive-sibling-heading): New option.
	(org-archive-to-archive-sibling): New function.
	(org-iswitchb): New command.
	(org-buffer-list): New function.
	(org-agenda-columns): Also try the #+COLUMNS line in
	the buffer associated with the entry at point (or with the first
	entry in the agenda view).
	(org-modules): Add entry for org-bibtex.el.
	(org-completion-fallback-command): Moved into `org-completion'
	group.
	(org-clock-heading-function): Moved to `org-progress' group.
	(org-auto-repeat-maybe): Make sure that a note can
	be enforces if `org-log-repeat' is `note'.
	(org-modules): Allow additional symbols for external
	packages.
	(org-ctrl-c-ctrl-c): Allow for `org-clock-overlays' to be
	undefined.
	(org-clock-goto): Hide drawers after showing an
	entry with `org-clock-goto.'
	(org-shiftup, org-shiftdown, org-shiftright, org-shiftleft): Try
	also a clocktable block shift.
	(org-clocktable-try-shift): New function.
	(org-columns-hscoll-title): New function.
	(org-columns-previous-hscroll): New variable.
	(org-columns-full-header-line-format): New variable.
	(org-columns-display-here-title, org-columns-remove-overlays):
	Install `org-columns-hscoll-title' in post-command-hook.

	* org/org.el: Split into many small files.

	* org/org-agenda.el: New file, split off from org.el.

	* org/org-archive.el: New file, split off from org.el.

	* org/org-bbdb.el: New file.

	* org/org-bibtex.el: New file, split off from org.el.

	* org/org-clock.el: New file, split off from org.el.

	* org/org-colview.el: New file, split off from org.el.

	* org/org-compat.el: New file, split off from org.el.

	* org/org-exp.el: New file, split off from org.el.

	* org/org-faces.el: New file, split off from org.el.

	* org/org-gnus.el: New file, split off from org.el.

	* org/org-info.el: New file, split off from org.el.

	* org/org-infojs.el: New file.

	* org/org-irc.el: New file.

	* org/org-macs.el: New file, split off from org.el.

	* org/org-mew.el: New file.

	* org/org-mhe.el: New file, split off from org.el.

	* org/org-publish.el: New file, split off from org.el.

	* org/org-remember.el: New file, split off from org.el.

	* org/org-rmail.el: New file, split off from org.el.

	* org/org-table.el: New file, split off from org.el.

	* org/org-vm.el: New file, split off from org.el.

	* org/org-wl.el: New file, split off from org.el.

2008-04-27  Jason Riedy  <jason@acm.org>

	* lisp/org-table.el (orgtbl-to-generic): Add a :remove-nil-lines
	parameter that supresses lines that evaluate to NIL.
	(orgtbl-get-fmt): New inline function for
	picking apart formats that may be lists.
	(orgtbl-apply-fmt): New inline function for applying formats that
	may be functions.
	(orgtbl-eval-str): New inline function for strings that may be
	functions.
	(orgtbl-format-line, orgtbl-to-generic): Use and document.
	(orgtbl-to-latex, orgtbl-to-texinfo): Document.
	(*orgtbl-llfmt*, *orgtbl-llstart*)
	(*orgtbl-llend*): Dynamic variables for last-line formatting.
	(orgtbl-format-section): Shift formatting to support detecting the
	last line and formatting it specially.
	(orgtbl-to-generic): Document :ll* formats.  Set to the non-ll
	formats unless overridden.
	(orgtbl-to-latex): Suggest using :llend to suppress the final \\.
	(*orgtbl-table*, *orgtbl-rtn*): Dynamically
	bound variables to hold the input collection of lines and output
	formatted text.
	(*orgtbl-hline*, *orgtbl-sep*, *orgtbl-fmt*, *orgtbl-efmt*,
	(*orgtbl-lfmt*, *orgtbl-lstart*, *orgtbl-lend*): Dynamically bound
	format parameters.
	(orgtbl-format-line): New function encapsulating formatting for a
	single line.
	(orgtbl-format-section): Similar for each section.  Rebinding the
	dynamic vars customizes the formatting for each section.
	(orgtbl-to-generic): Use orgtbl-format-line and
	orgtbl-format-section.
	(org-get-param): Now unused, so delete.
	(orgtbl-gather-send-defs): New function to
	gather all the SEND definitions before a table.
	(orgtbl-send-replace-tbl): New function to find the RECEIVE
	corresponding to the current name.
	(orgtbl-send-table): Use the previous two functions and implement
	multiple destinations for each table.

	* doc/org.texi (A LaTeX example): Note that fmt may be a
	one-argument function, and efmt may be a two-argument function.
	(Radio tables): Document multiple destinations.

2008-04-27  Carsten Dominik  <dominik@science.uva.nl>

	* org/org-agenda.el (org-add-to-diary-list): New function.
	(org-prefix-has-effort): New variable.
	(org-sort-agenda-noeffort-is-high): New option.
	(org-agenda-columns-show-summaries)
	(org-agenda-columns-compute-summary-properties): New options.
	(org-format-agenda-item): Compute the duration of the item.
	(org-agenda-weekend-days): New variable.
	(org-agenda-list, org-timeline): Use the proper faces for dates in
	the agenda and timeline buffers.
	(org-agenda-archive-to-archive-sibling): New command.
	(org-agenda-start-with-clockreport-mode): New option.
	(org-agenda-clockreport-parameter-plist): New option.
	(org-agenda-clocktable-mode): New variable.
	(org-agenda-deadline-leaders): Allow a function value for the
	deadline leader.
	(org-agenda-get-deadlines): Deal with new function value.

	* lisp/org-clock.el (org-clock): New customization group.
	(org-clock-into-drawer, org-clock-out-when-done)
	(org-clock-in-switch-to-state, org-clock-heading-function): Moved
	into the new group.
	(org-clock-out-remove-zero-time-clocks): New option.
	(org-clock-out): Use `org-clock-out-remove-zero-time-clocks'.
	(org-dblock-write:clocktable): Allow a Lisp form for the scope
	parameter.
	(org-dblock-write:clocktable): Fixed bug with total time
	calculation.
	(org-dblock-write:clocktable): Request the unrestricted list of
	files.
	(org-get-clocktable): New function.
	(org-dblock-write:clocktable): Make sure :tstart and :tend can not
	only be strings but also integers (an absolute day number) and
	lists (m d y).

	* org/org-colview.el (org-columns-next-allowed-value)
	(org-columns-edit-value): Limit the effort for updatig in the
	agenda to recomputing a single file.
	(org-columns-compute): Only write property value if it has
	changed.  This avoids raising the buffer-change-flag
	unnecessarily.
	(org-agenda-colview-summarize)
	(org-agenda-colview-compute): New functions.
	(org-agenda-columns): Call `org-agenda-colview-summarize'.

	* org/org-exp.el (org-export-run-in-background): New option.
	(org-export-icalendar): Allow a batch process to trigger waiting
	after executing a system command.
	(org-export-preprocess-string): Renamed-from
	`org-cleaned-string-for-export'.
	(org-export-html-style): Made target class look like normal text.
	(org-export-as-html): Make use of the better proprocessing in
	`org-cleaned-string-for-export'.
	(org-cleaned-string-for-export): Better treatment of heuristic
	targets, many more internal links will now work in HTML export.
	(org-get-current-options): Incorporate LINK_UP, LINK_HOME, and
	INFOJS.
	(org-export-inbuffer-options-extra): New variable.
	(org-export-options-filters): New hook.
	(org-infile-export-plist): Find also the settings keywords in
	`org-export-inbuffer-options-extra'.
	(org-infile-export-plist): Allow multiple #+OPTIONS lines and
	multiple #+INFOJS_OPT lines.
	(org-export-html-handle-js-options): New function.
	(org-export-html-infojs-setup): New option.
	(org-export-as-html): Call `org-export-html-handle-js-options'.
	Add autoload to all entry points.
	(org-skip-comments): Function removed.

	* org/org-table.el (org-table-make-reference): Extra parenthesis
	around single fields, to make sure that algebraic formulas get
	correctly interpreted by calc.
	(org-table-current-column): No longer interactive.

	* org/org-export-latex.el (org-export-latex-preprocess): Renamed
	from `org-export-latex-cleaned-string'.

2008-04-27  Bastien Guerry  <bzg@altern.org>

	* org/org-publish.el (org-publish-get-base-files-1): New function.
	(org-publish-get-base-files): Use it.
	(org-publish-temp-files): New variable.
	Don't require 'dired-aux anymore.
	(org-publish-initial-buffer): New variable.
	(org-publish-org-to, org-publish): Use it.
	(org-publish-get-base-files-1): Bug fix: get
	the proper list of files when recursing thru a directory.
	(org-publish-get-base-files): Use the :exclude property to skip
	both files and directories.
parent 176b6c03
This diff is collapsed.
;;; org-archive.el --- Archiving for Org-mode
;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
;; Version: 6.02b
;;
;; This file is part of GNU Emacs.
;;
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;;; Commentary:
;; This file contains the face definitons for Org.
;;; Code:
(require 'org)
(defcustom org-archive-sibling-heading "Archive"
"Name of the local archive sibling that is used to archive entries locally.
Locally means: in the tree, under a sibling.
See `org-archive-to-archive-sibling' for more information."
:group 'org-archive
:type 'string)
(defcustom org-archive-mark-done t
"Non-nil means, mark entries as DONE when they are moved to the archive file.
This can be a string to set the keyword to use. When t, Org-mode will
use the first keyword in its list that means done."
:group 'org-archive
:type '(choice
(const :tag "No" nil)
(const :tag "Yes" t)
(string :tag "Use this keyword")))
(defcustom org-archive-stamp-time t
"Non-nil means, add a time stamp to entries moved to an archive file.
This variable is obsolete and has no effect anymore, instead add ot remove
`time' from the variablle `org-archive-save-context-info'."
:group 'org-archive
:type 'boolean)
(defcustom org-archive-save-context-info '(time file olpath category todo itags)
"Parts of context info that should be stored as properties when archiving.
When a subtree is moved to an archive file, it looses information given by
context, like inherited tags, the category, and possibly also the TODO
state (depending on the variable `org-archive-mark-done').
This variable can be a list of any of the following symbols:
time The time of archiving.
file The file where the entry originates.
itags The local tags, in the headline of the subtree.
ltags The tags the subtree inherits from further up the hierarchy.
todo The pre-archive TODO state.
category The category, taken from file name or #+CATEGORY lines.
olpath The outline path to the item. These are all headlines above
the current item, separated by /, like a file path.
For each symbol present in the list, a property will be created in
the archived entry, with a prefix \"PRE_ARCHIVE_\", to remember this
information."
:group 'org-archive
:type '(set :greedy t
(const :tag "Time" time)
(const :tag "File" file)
(const :tag "Category" category)
(const :tag "TODO state" todo)
(const :tag "TODO state" priority)
(const :tag "Inherited tags" itags)
(const :tag "Outline path" olpath)
(const :tag "Local tags" ltags)))
(defun org-get-local-archive-location ()
"Get the archive location applicable at point."
(let ((re "^#\\+ARCHIVE:[ \t]+\\(\\S-.*\\S-\\)[ \t]*$")
prop)
(save-excursion
(save-restriction
(widen)
(setq prop (org-entry-get nil "ARCHIVE" 'inherit))
(cond
((and prop (string-match "\\S-" prop))
prop)
((or (re-search-backward re nil t)
(re-search-forward re nil t))
(match-string 1))
(t org-archive-location (match-string 1)))))))
(defun org-add-archive-files (files)
"Splice the archive files into the list f files.
This implies visiting all these files and finding out what the
archive file is."
(apply
'append
(mapcar
(lambda (f)
(if (not (file-exists-p f))
nil
(with-current-buffer (org-get-agenda-file-buffer f)
(cons f (org-all-archive-files)))))
files)))
(defun org-all-archive-files ()
"Get a list of all archive files used in the current buffer."
(let (file files)
(save-excursion
(save-restriction
(goto-char (point-min))
(while (re-search-forward
"^\\(#\\+\\|[ \t]*:\\)ARCHIVE:[ \t]+\\(.*\\)"
nil t)
(setq file (org-extract-archive-file
(org-match-string-no-properties 2)))
(and file (> (length file) 0) (file-exists-p file)
(add-to-list 'files file)))))
(setq files (nreverse files))
(setq file (org-extract-archive-file))
(and file (> (length file) 0) (file-exists-p file)
(add-to-list 'files file))
files))
(defun org-extract-archive-file (&optional location)
(setq location (or location org-archive-location))
(if (string-match "\\(.*\\)::\\(.*\\)" location)
(if (= (match-beginning 1) (match-end 1))
(buffer-file-name)
(expand-file-name
(format (match-string 1 location) buffer-file-name)))))
(defun org-extract-archive-heading (&optional location)
(setq location (or location org-archive-location))
(if (string-match "\\(.*\\)::\\(.*\\)" location)
(match-string 2 location)))
(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
a different file. The tree will be moved to that location, the subtree
heading be marked DONE, and the current time will be added.
When called with prefix argument FIND-DONE, find whole trees without any
open TODO items and archive them (after getting confirmation from the user).
If the cursor is not at a headline when this comand is called, try all level
1 trees. If the cursor is on a headline, only try the direct children of
this heading."
(interactive "P")
(if find-done
(org-archive-all-done)
;; Save all relevant TODO keyword-relatex variables
(let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
(tr-org-todo-keywords-1 org-todo-keywords-1)
(tr-org-todo-kwd-alist org-todo-kwd-alist)
(tr-org-done-keywords org-done-keywords)
(tr-org-todo-regexp org-todo-regexp)
(tr-org-todo-line-regexp org-todo-line-regexp)
(tr-org-odd-levels-only org-odd-levels-only)
(this-buffer (current-buffer))
;; start of variables that will be used for saving context
;; The compiler complains about them - keep them anyway!
(file (abbreviate-file-name (buffer-file-name)))
(olpath (mapconcat 'identity (org-get-outline-path) "/"))
(time (format-time-string
(substring (cdr org-time-stamp-formats) 1 -1)
(current-time)))
category todo priority ltags itags
;; end of variables that will be used for saving context
location afile heading buffer level newfile-p)
;; Find the local archive location
(setq location (org-get-local-archive-location)
afile (org-extract-archive-file location)
heading (org-extract-archive-heading location))
(unless afile
(error "Invalid `org-archive-location'"))
(if (> (length afile) 0)
(setq newfile-p (not (file-exists-p afile))
buffer (find-file-noselect afile))
(setq buffer (current-buffer)))
(unless buffer
(error "Cannot access file \"%s\"" afile))
(if (and (> (length heading) 0)
(string-match "^\\*+" heading))
(setq level (match-end 0))
(setq heading nil level 0))
(save-excursion
(org-back-to-heading t)
;; Get context information that will be lost by moving the tree
(org-refresh-category-properties)
(setq category (org-get-category)
todo (and (looking-at org-todo-line-regexp)
(match-string 2))
priority (org-get-priority
(if (match-end 3) (match-string 3) ""))
ltags (org-get-tags)
itags (org-delete-all ltags (org-get-tags-at)))
(setq ltags (mapconcat 'identity ltags " ")
itags (mapconcat 'identity itags " "))
;; We first only copy, in case something goes wrong
;; we need to protect this-command, to avoid kill-region sets it,
;; which would lead to duplication of subtrees
(let (this-command) (org-copy-subtree))
(set-buffer buffer)
;; Enforce org-mode for the archive buffer
(if (not (org-mode-p))
;; Force the mode for future visits.
(let ((org-insert-mode-line-in-empty-file t)
(org-inhibit-startup t))
(call-interactively 'org-mode)))
(when newfile-p
(goto-char (point-max))
(insert (format "\nArchived entries from file %s\n\n"
(buffer-file-name this-buffer))))
;; Force the TODO keywords of the original buffer
(let ((org-todo-line-regexp tr-org-todo-line-regexp)
(org-todo-keywords-1 tr-org-todo-keywords-1)
(org-todo-kwd-alist tr-org-todo-kwd-alist)
(org-done-keywords tr-org-done-keywords)
(org-todo-regexp tr-org-todo-regexp)
(org-todo-line-regexp tr-org-todo-line-regexp)
(org-odd-levels-only
(if (local-variable-p 'org-odd-levels-only (current-buffer))
org-odd-levels-only
tr-org-odd-levels-only)))
(goto-char (point-min))
(show-all)
(if heading
(progn
(if (re-search-forward
(concat "^" (regexp-quote heading)
(org-re "[ \t]*\\(:[[:alnum:]_@:]+:\\)?[ \t]*\\($\\|\r\\)"))
nil t)
(goto-char (match-end 0))
;; Heading not found, just insert it at the end
(goto-char (point-max))
(or (bolp) (insert "\n"))
(insert "\n" heading "\n")
(end-of-line 0))
;; Make the subtree visible
(show-subtree)
(org-end-of-subtree t)
(skip-chars-backward " \t\r\n")
(and (looking-at "[ \t\r\n]*")
(replace-match "\n\n")))
;; No specific heading, just go to end of file.
(goto-char (point-max)) (insert "\n"))
;; Paste
(org-paste-subtree (org-get-valid-level level 1))
;; Mark the entry as done
(when (and org-archive-mark-done
(looking-at org-todo-line-regexp)
(or (not (match-end 2))
(not (member (match-string 2) org-done-keywords))))
(let (org-log-done org-todo-log-states)
(org-todo
(car (or (member org-archive-mark-done org-done-keywords)
org-done-keywords)))))
;; Add the context info
(when org-archive-save-context-info
(let ((l org-archive-save-context-info) e n v)
(while (setq e (pop l))
(when (and (setq v (symbol-value e))
(stringp v) (string-match "\\S-" v))
(setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
(org-entry-put (point) n v)))))
;; Save and kill the buffer, if it is not the same buffer.
(if (not (eq this-buffer buffer))
(progn (save-buffer) (kill-buffer buffer)))))
;; Here we are back in the original buffer. Everything seems to have
;; worked. So now cut the tree and finish up.
(let (this-command) (org-cut-subtree))
(if (and (not (eobp)) (looking-at "[ \t]*$")) (kill-line))
(message "Subtree archived %s"
(if (eq this-buffer buffer)
(concat "under heading: " heading)
(concat "in file: " (abbreviate-file-name afile)))))))
(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
`org-archive-sibling-heading' and an `org-archive-tag' tag. If this
sibling does not exist, it will be created at the end of the subtree."
(interactive)
(save-restriction
(widen)
(let (b e pos leader level)
(org-back-to-heading t)
(looking-at outline-regexp)
(setq leader (match-string 0)
level (funcall outline-level))
(setq pos (point))
(condition-case nil
(outline-up-heading 1 t)
(error (goto-char (point-min))))
(setq b (point))
(condition-case nil
(org-end-of-subtree t t)
(error (goto-char (point-max))))
(setq e (point))
(goto-char b)
(unless (re-search-forward
(concat "^" (regexp-quote leader)
"[ \t]*"
org-archive-sibling-heading
"[ \t]*:"
org-archive-tag ":") e t)
(goto-char e)
(or (bolp) (newline))
(insert leader org-archive-sibling-heading "\n")
(beginning-of-line 0)
(org-toggle-tag org-archive-tag 'on))
(beginning-of-line 1)
(org-end-of-subtree t t)
(save-excursion
(goto-char pos)
(org-cut-subtree))
(org-paste-subtree (org-get-valid-level level 1))
(org-set-property
"ARCHIVE_TIME"
(format-time-string
(substring (cdr org-time-stamp-formats) 1 -1)
(current-time)))
(outline-up-heading 1 t)
(hide-subtree)
(goto-char pos))))
(defun org-archive-all-done (&optional tag)
"Archive sublevels of the current tree without open TODO items.
If the cursor is not on a headline, try all level 1 trees. If
it is on a headline, try all direct children.
When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
(let ((re (concat "^\\*+ +" org-not-done-regexp)) re1
(rea (concat ".*:" org-archive-tag ":"))
(begm (make-marker))
(endm (make-marker))
(question (if tag "Set ARCHIVE tag (no open TODO items)? "
"Move subtree to archive (no open TODO items)? "))
beg end (cntarch 0))
(if (org-on-heading-p)
(progn
(setq re1 (concat "^" (regexp-quote
(make-string
(1+ (- (match-end 0) (match-beginning 0) 1))
?*))
" "))
(move-marker begm (point))
(move-marker endm (org-end-of-subtree t)))
(setq re1 "^* ")
(move-marker begm (point-min))
(move-marker endm (point-max)))
(save-excursion
(goto-char begm)
(while (re-search-forward re1 endm t)
(setq beg (match-beginning 0)
end (save-excursion (org-end-of-subtree t) (point)))
(goto-char beg)
(if (re-search-forward re end t)
(goto-char end)
(goto-char beg)
(if (and (or (not tag) (not (looking-at rea)))
(y-or-n-p question))
(progn
(if tag
(org-toggle-tag org-archive-tag 'on)
(org-archive-subtree))
(setq cntarch (1+ cntarch)))
(goto-char end)))))
(message "%d trees archived" cntarch)))
(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
the children that do not contain any open TODO items."
(interactive "P")
(if find-done
(org-archive-all-done 'tag)
(let (set)
(save-excursion
(org-back-to-heading t)
(setq set (org-toggle-tag org-archive-tag))
(when set (hide-subtree)))
(and set (beginning-of-line 1))
(message "Subtree %s" (if set "archived" "unarchived")))))
(provide 'org-archive)
;;; org-archive.el ends here
;;; org-bbdb.el --- Support for links to BBDB entries from within Org-mode
;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
;; Author: Carsten Dominik <carsten at orgmode dot org>,
;; Thomas Baumann <thomas dot baumann at ch dot tum dot de>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
;; Version: 6.02b
;;
;; This file is part of GNU Emacs.
;;
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;;; Commentary:
;; This file implements links to BBDB database entries from within Org-mode.
;; Org-mode loads this module by default - if this is not what you want,
;; configure the variable `org-modules'.
;; It also implements an interface (based on Ivar Rummelhoff's
;; bbdb-anniv.el) for those org-mode users, who do not use the diary
;; but who do want to include the anniversaries stored in the BBDB
;; into the org-agenda. If you already include the `diary' into the
;; agenda, you might want to prefer to include the anniversaries in
;; the diary using bbdb-anniv.el.
;;
;; Put the following in /somewhere/at/home/diary.org and make sure
;; that this file is in `org-agenda-files`
;;
;; %%(org-bbdb-anniversaries)
;;
;; For example my diary.org looks like:
;; * Anniversaries
;; #+CATEGORY: Anniv
;; %%(org-bbdb-anniversaries)
;;
;;
;; The anniversaries are stored in BBDB in the field `anniversary'
;; in the format
;;
;; YYYY-MM-DD{ CLASS-OR-FORMAT-STRING}*
;; {\nYYYY-MM-DD CLASS-OR-FORMAT-STRING}*
;;
;; CLASS-OR-FORMAT-STRING is one of two things:
;;
;; * an identifier for a class of anniversaries (eg. birthday or
;; wedding) from `org-bbdb-anniversary-format-alist'.
;; * the (format) string displayed in the diary.
;;
;; It defaults to the value of `org-bbdb-default-anniversary-format'
;; ("birthday" by default).
;;
;; The substitutions in the format string are (in order):
;; * the name of the record containing this anniversary
;; * the number of years
;; * an ordinal suffix (st, nd, rd, th) for the year
;;
;; See the documentation of `org-bbdb-anniversary-format-alist' for
;; further options.
;;
;; Example
;;
;; 1973-06-22
;; 20??-??-?? wedding
;; 1998-03-12 %s created bbdb-anniv.el %d years ago
;;; Code:
(require 'org)
(eval-when-compile
(require 'cl))
;; Declare external functions and variables
(declare-function bbdb "ext:bbdb-com" (string elidep))
(declare-function bbdb-company "ext:bbdb-com" (string elidep))
(declare-function bbdb-current-record "ext:bbdb-com"
(&optional planning-on-modifying))
(declare-function bbdb-name "ext:bbdb-com" (string elidep))
(declare-function bbdb-record-getprop "ext:bbdb" (record property))
(declare-function bbdb-record-name "ext:bbdb" (record))
(declare-function bbdb-records "ext:bbdb"
(&optional dont-check-disk already-in-db-buffer))
(declare-function bbdb-split "ext:bbdb" (string separators))
(declare-function bbdb-string-trim "ext:bbdb" (string))
(declare-function calendar-leap-year-p "calendar" (year))
(declare-function diary-ordinal-suffix "diary-lib" (n))
(defvar date)
;; Customization
(defgroup org-bbdb-anniversaries nil
"Customizations for including anniversaries from BBDB into Agenda."
:group 'org-bbdb)
(defcustom org-bbdb-default-anniversary-format "birthday"
"Default anniversary class."
:type 'string
:group 'org-bbdb-anniversaries
:require 'bbdb)
(defcustom org-bbdb-anniversary-format-alist
'( ("birthday" . "Birthday: %s (%d%s)")
("wedding" . "%s's %d%s wedding anniversary") )
"How different types of anniversaries should be formatted.
An alist of elements (STRING . FORMAT) where STRING is the name of an
anniversary class and format is either:
1) A format string with the following substitutions (in order):
* the name of the record containing this anniversary
* the number of years
* an ordinal suffix (st, nd, rd, th) for the year
2) A function to be called with three arguments: NAME YEARS SUFFIX
(string int string) returning a string for the diary or nil.
3) An Emacs Lisp form that should evaluate to a string (or nil) in the
scope of variables NAME, YEARS and SUFFIX (among others)."
:type 'sexp
:group 'org-bbdb-anniversaries
:require 'bbdb)
(defcustom org-bbdb-anniversary-field 'anniversary
"The BBDB field which contains anniversaries.
The anniversaries are stored in the following format
YYYY-MM-DD Class-or-Format-String
where class is one of the customized classes for anniversaries;
birthday and wedding are predefined. Format-String can take three
substitutions 1) the name of the record containing this
anniversary, 2) the number of years, and 3) an ordinal suffix for
the year.
Multiple anniversaries can be separated by \\n"
:type 'symbol
:group 'org-bbdb-anniversaries
:require 'bbdb)
(defcustom org-bbdb-extract-date-fun 'org-bbdb-anniv-extract-date
"How to retrieve `month date year' from the anniversary field.
Customize if you have already filled your bbdb with dates
different from YYYY-MM-DD. The function must return a list (month
date year)"
:type 'function
:group 'org-bbdb-anniversaries
:require 'bbdb)
;; Install the link type
(org-add-link-type "bbdb" 'org-bbdb-open 'org-bbdb-export)
(add-hook 'org-store-link-functions 'org-bbdb-store-link)
;; Implementation
(defun org-bbdb-store-link ()
"Store a link to a BBDB database entry."
(when (eq major-mode 'bbdb-mode)
;; This is BBDB, we make this link!
(let* ((name (bbdb-record-name (bbdb-current-record)))
(company (bbdb-record-getprop (bbdb-current-record) 'company))
(link (org-make-link "bbdb:" name)))
(org-store-link-props :type "bbdb" :name name :company company
:link link :description name)
link)))
(defun org-bbdb-export (path desc format)
"Create the export version of a BBDB link specified by PATH or DESC.
If exporting to either HTML or LaTeX FORMAT the link will be
italicised, in all other cases it is left unchanged."
"Create the exprt verison of a bbdb link."
(cond
((eq format 'html) (format "<i>%s</i>" (or desc path)))
((eq format 'latex) (format "\\textit{%s}" (or desc path)))
(t (or desc path))))
(defun org-bbdb-open (name)
"Follow a BBDB link to NAME."
(require 'bbdb)