comparison lisp/org/org.el @ 101757:6d71fc980cde

2009-02-02 Carsten Dominik <[e-mail]> * org.el (org-mode): Make dependence stuff work more reliably. (org-update-parent-todo-statistics): Fix bug with updating statistics cookie. (org-yank-adjusted-subtrees, org-return-follows-link) (org-use-fast-todo-selection, org-tags-column): New default setting for variables. * org-export-latex.el (org-export-latex-emphasis-alist): Use = and ~ as verbatim delimiters, to avoid table bug. (org-export-latex-classes): Remove the a4paper option from the default styles. * org-exp.el (org-export-html-format-image): New argument PAR-OPEN, to fix XHTM validation bug. (org-export-as-html): Pass par-open to `org-export-html-format-image'. (org-export-html-footnotes-section): Use a more consistent id for footnotes. * org-agenda.el (org-agenda-sorting-strategy) (org-agenda-tags-column): New default setting for variables, based on a poll what typical uses use. (org-agenda-dim-blocked-tasks): Keep dimming blocked entries from setting the blocked tag.

101756:5f840f1a34d4

;;   Free Software Foundation, Inc.
;;
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
;; Version: 6.20h
;;
;; 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

;;;; Customization variables

;;; Version

(defconst org-version "6.20h"
  "The version number of the file org.el.")

(defun org-version (&optional here)
  "Show the org-mode version in the echo area.
With prefix arg HERE, insert it at point."

or siblings, then fold all the subtrees.  However, do this only if no
text after the yank would be swallowed into a folded tree by this action."
  :group 'org-edit-structure
  :type 'boolean)

(defcustom org-yank-adjusted-subtrees t
  "Non-nil means, when yanking subtrees, adjust the level.
With this setting, `org-paste-subtree' is used to insert the subtree, see
this function for details."
  :group 'org-edit-structure
  :type 'boolean)

  "Non-nil means, on links TAB will follow the link.
Needs to be set before org.el is loaded."
  :group 'org-link-follow
  :type 'boolean)

(defcustom org-return-follows-link nil
  "Non-nil means, on links RET will follow the link.
Needs to be set before org.el is loaded."
  :group 'org-link-follow
  :type 'boolean)

  :group 'org-todo
  :group 'org-keywords
  :type '(choice (const sequence)
		 (const type)))

(defcustom org-use-fast-todo-selection 'prefix
  "Non-nil means, use the fast todo selection scheme with C-c C-t.
This variable describes if and under what circumstances the cycling
mechanism for TODO keywords will be replaced by a single-key, direct
selection scheme.

(defcustom org-enforce-todo-dependencies nil
  "Non-nil means, undone TODO entries will block switching the parent to DONE.
Also, if a parent has an :ORDERED: property, switching an entry to DONE will
be blocked if any prior sibling is not yet done.
You need to set this variable through the customize interface, or to
restart emacs after changing the value."
  :set (lambda (var val)
	 (set var val)
	 (if val
	     (add-hook 'org-blocker-hook
		       'org-block-todo-from-children-or-siblings)

(defcustom org-enforce-todo-checkbox-dependencies nil
  "Non-nil means, unchecked boxes will block switching the parent to DONE.
When this is nil, checkboxes have no influence on switching TODO states.
When non-nil, you first need to check off all check boxes before the TODO
entry can be switched to DONE.
You need to set this variable through the customize interface, or to
restart emacs after changing the value."
  :set (lambda (var val)
	 (set var val)
	 (if val
	     (add-hook 'org-blocker-hook
		       'org-block-todo-from-checkboxes)

(defvar org-fast-tag-selection-include-todo nil
  "Non-nil means, fast tags selection interface will also offer TODO states.
This is an undocumented feature, you should not rely on it.")

(defcustom org-tags-column (if (featurep 'xemacs) -79 -80)
  "The column to which tags should be indented in a headline.
If this number is positive, it specifies the column.  If it is negative,
it means that the tags should be flushright to that column.  For example,
-80 works well for a normal 80 character screen."
  :group 'org-tags

  (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  ;; Paragraphs and auto-filling
  (org-set-autofill-regexps)
  (setq indent-line-function 'org-indent-line-function)
  (org-update-radio-target-regexp)

  ;; Comment characters
;  (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
  (org-set-local 'comment-padding " ")

(defun org-update-parent-todo-statistics ()
  "Update any statistics cookie in the parent of the current headline."
  (interactive)
  (let ((box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
	level (cnt-all 0) (cnt-done 0) is-percent kwd)
    (catch 'exit
      (save-excursion
	(setq level (org-up-heading-safe))
	(unless level
	  (throw 'exit nil))
	(while (re-search-forward box-re (point-at-eol) t)
	  (setq is-percent (match-end 2))
	  (save-match-data
	    (unless (outline-next-heading) (throw 'exit nil))
	    (while (looking-at org-todo-line-regexp)
	      (setq kwd (match-string 2))

		(error (end-of-line 1)))))
	  (replace-match
	   (if is-percent
	       (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
	     (format "[%d/%d]" cnt-done cnt-all))))
	(run-hook-with-args 'org-after-todo-statistics-hook
			    cnt-done (- cnt-all cnt-done))))))

(defvar org-after-todo-statistics-hook nil
  "Hook that is called after a TODO statistics cookie has been updated.
Each function is called with two arguments: the number of not-done entries
and the number of done entries.

101757:6d71fc980cde

;;   Free Software Foundation, Inc.
;;
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
;; Version: 6.21b
;;
;; 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

;;;; Customization variables

;;; Version

(defconst org-version "6.21b"
  "The version number of the file org.el.")

(defun org-version (&optional here)
  "Show the org-mode version in the echo area.
With prefix arg HERE, insert it at point."

or siblings, then fold all the subtrees.  However, do this only if no
text after the yank would be swallowed into a folded tree by this action."
  :group 'org-edit-structure
  :type 'boolean)

(defcustom org-yank-adjusted-subtrees nil
  "Non-nil means, when yanking subtrees, adjust the level.
With this setting, `org-paste-subtree' is used to insert the subtree, see
this function for details."
  :group 'org-edit-structure
  :type 'boolean)

  "Non-nil means, on links TAB will follow the link.
Needs to be set before org.el is loaded."
  :group 'org-link-follow
  :type 'boolean)

(defcustom org-return-follows-link t
  "Non-nil means, on links RET will follow the link.
Needs to be set before org.el is loaded."
  :group 'org-link-follow
  :type 'boolean)

  :group 'org-todo
  :group 'org-keywords
  :type '(choice (const sequence)
		 (const type)))

(defcustom org-use-fast-todo-selection t
  "Non-nil means, use the fast todo selection scheme with C-c C-t.
This variable describes if and under what circumstances the cycling
mechanism for TODO keywords will be replaced by a single-key, direct
selection scheme.

(defcustom org-enforce-todo-dependencies nil
  "Non-nil means, undone TODO entries will block switching the parent to DONE.
Also, if a parent has an :ORDERED: property, switching an entry to DONE will
be blocked if any prior sibling is not yet done.
This variable needs to be set before org.el is loaded, and you need to
restart Emacs after a change to make the change effective.  The only way
to change is while Emacs is running is through the customize interface."
  :set (lambda (var val)
	 (set var val)
	 (if val
	     (add-hook 'org-blocker-hook
		       'org-block-todo-from-children-or-siblings)

(defcustom org-enforce-todo-checkbox-dependencies nil
  "Non-nil means, unchecked boxes will block switching the parent to DONE.
When this is nil, checkboxes have no influence on switching TODO states.
When non-nil, you first need to check off all check boxes before the TODO
entry can be switched to DONE.
This variable needs to be set before org.el is loaded, and you need to
restart Emacs after a change to make the change effective.  The only way
to change is while Emacs is running is through the customize interface."
  :set (lambda (var val)
	 (set var val)
	 (if val
	     (add-hook 'org-blocker-hook
		       'org-block-todo-from-checkboxes)

(defvar org-fast-tag-selection-include-todo nil
  "Non-nil means, fast tags selection interface will also offer TODO states.
This is an undocumented feature, you should not rely on it.")

(defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  "The column to which tags should be indented in a headline.
If this number is positive, it specifies the column.  If it is negative,
it means that the tags should be flushright to that column.  For example,
-80 works well for a normal 80 character screen."
  :group 'org-tags

  (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  ;; Paragraphs and auto-filling
  (org-set-autofill-regexps)
  (setq indent-line-function 'org-indent-line-function)
  (org-update-radio-target-regexp)
  ;; Make sure dependence stuff works reliably, even for users who set it
  ;; too late :-(
  (if org-enforce-todo-dependencies
      (add-hook 'org-blocker-hook
		'org-block-todo-from-children-or-siblings)
    (remove-hook 'org-blocker-hook
		 'org-block-todo-from-children-or-siblings))
  (if org-enforce-todo-checkbox-dependencies
      (add-hook 'org-blocker-hook
		'org-block-todo-from-checkboxes)
    (remove-hook 'org-blocker-hook
		 'org-block-todo-from-checkboxes))

  ;; Comment characters
;  (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
  (org-set-local 'comment-padding " ")

(defun org-update-parent-todo-statistics ()
  "Update any statistics cookie in the parent of the current headline."
  (interactive)
  (let ((box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
	level (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
    (catch 'exit
      (save-excursion
	(setq level (org-up-heading-safe))
	(unless level
	  (throw 'exit nil))
	(while (re-search-forward box-re (point-at-eol) t)
	  (setq cnt-all 0 cnt-done 0 cookie-present t)
	  (setq is-percent (match-end 2))
	  (save-match-data
	    (unless (outline-next-heading) (throw 'exit nil))
	    (while (looking-at org-todo-line-regexp)
	      (setq kwd (match-string 2))

		(error (end-of-line 1)))))
	  (replace-match
	   (if is-percent
	       (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
	     (format "[%d/%d]" cnt-done cnt-all))))
	(when cookie-present
	  (run-hook-with-args 'org-after-todo-statistics-hook
			      cnt-done (- cnt-all cnt-done)))))))

(defvar org-after-todo-statistics-hook nil
  "Hook that is called after a TODO statistics cookie has been updated.
Each function is called with two arguments: the number of not-done entries
and the number of done entries.