-;;; org.el --- Outline-based notes management and organizer
+;;; org.el --- Outline-based notes management and organize
;; Carstens outline-mode for keeping track of everything.
-;; Copyright (c) 2004, 2005 Free Software Foundation
+;; Copyright (C) 2004, 2005, 2006 Free Software Foundation, Inc.
;;
;; Author: Carsten Dominik <dominik at science dot uva dot nl>
-;; Keywords: outlines, hypermedia, calendar
+;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://www.astro.uva.nl/~dominik/Tools/org/
-;; Version: 3.16
+;; Version: 4.21
;;
;; This file is part of GNU Emacs.
;;
;; The documentation of Org-mode can be found in the TeXInfo file. The
;; distribution also contains a PDF version of it. At the homepage of
;; Org-mode, you can read the same text online as HTML. There is also an
-;; excellent reference card made by Philip Rooke.
+;; excellent reference card made by Philip Rooke. This card can be found
+;; in the etc/ directory of Emacs 22.
;;
-;; Changes:
-;; -------
-;; Version 3.16
-;; - In tables, directly after the field motion commands like TAB and RET,
-;; typing a character will blank the field. Can be turned off with
-;; variable `org-table-auto-blank-field'.
-;; - Inactive timestamps with `C-c !'. These do not trigger the agenda
-;; and are not linked to the calendar.
-;; - Additional key bindings to allow Org-mode to function on a tty emacs.
-;; - `C-c C-h' prefix key replaced by `C-c C-x', and `C-c C-x C-h' replaced
-;; by `C-c C-x b' (b=Browser). This was necessary to recover the
-;; standard meaning of C-h after a prefix key (show prefix bindings).
+;; Changes since version 4.00:
+;; ---------------------------
+;; Version 4.21
+;; - Bug fixes.
;;
-;; Version 3.15
-;; - QUOTE keyword at the beginning of an entry causes fixed-width export
-;; of unmodified entry text. `C-c :' toggles this keyword.
-;; - New face `org-special-keyword' which is used for COMMENT, QUOTE,
-;; DEADLINE and SCHEDULED, and priority cookies. Default is only a weak
-;; color, to reduce the amount of aggressive color in the buffer.
+;; Version 4.20
+;; - Links use now the [[link][description]] format by default.
+;; When inserting links, the user is prompted for a description.
+;; - If a link has a description, only the description is displayed
+;; the link part is hidden. Use C-c C-l to edit the link part.
+;; - TAGS are now bold, but in the same color as the headline.
+;; - The width of a table column can be limited by using a field "<N>".
+;; - New structure for the customization tree.
+;; - Bug fixes.
;;
-;; Version 3.14
-;; - Formulas for individual fields in table.
-;; - Automatic recalculation in calculating tables.
-;; - Named fields and columns in tables.
-;; - Fixed bug with calling `org-archive' several times in a row.
+;; Version 4.13
+;; - The list of agenda files can be maintainted in an external file.
+;; - Bug fixes.
;;
-;; Version 3.13
-;; - Efficiency improvements: Fewer table re-alignments needed.
-;; - New special lines in tables, for defining names for individual cells.
+;; Version 4.12
+;; - Templates for remember buffer. Note that the remember setup changes.
+;; To set up templates, see `org-remember-templates'.
+;; - The time in new time stamps can be rounded, see new option
+;; `org-time-stamp-rounding-minutes'.
+;; - Bug fixes (there are *always* more bugs).
;;
-;; Version 3.12
-;; - Tables can store formulas (one per column) and compute fields.
-;; Not quite like a full spreadsheet, but very powerful.
-;; - table.el keybinding is now `C-c ~'.
-;; - Numeric argument to org-cycle does `show-subtree' above on level ARG.
-;; - Small changes to keys in agenda buffer. Affected keys:
-;; [w] weekly view; [d] daily view; [D] toggle diary inclusion.
+;; Version 4.10
;; - Bug fixes.
;;
-;; Version 3.11
-;; - Links inserted with C-c C-l are now by default enclosed in angle
-;; brackets. See the new variable `org-link-format'.
-;; - ">" terminates a link, this is a way to have several links in a line.
-;; Both "<" and ">" are no longer allowed as characters in a link.
-;; - Archiving of finished tasks.
-;; - C-<up>/<down> bindings removed, to allow access to paragraph commands.
-;; - Compatibility with CUA-mode (see variable `org-CUA-compatible').
-;; - Compatibility problems with viper-mode fixed.
-;; - Improved html export of tables.
-;; - Various clean-up changes.
+;; Version 4.09
+;; - Bug fixes.
+;; - Small improvements to font-lock support.
+;; - MHE support finalized.
;;
-;; Version 3.10
-;; - Using `define-derived-mode' to derive `org-mode' from `outline-mode'.
+;; Version 4.08
+;; - Bug fixes.
+;; - Improved MHE support
;;
-;; Version 3.09
-;; - Time-of-day specifications in agenda are extracted and placed
-;; into the prefix. Timed entries can be placed into a time grid for
-;; day.
+;; Version 4.07
+;; - Bug fixes.
+;; - Leading stars in headlines can be hidden, so make the outline look
+;; cleaner.
+;; - Mouse-1 can be used to follow links.
;;
-;; Version 3.08
-;; - "|" no longer allowed as part of a link, to allow links in tables.
-;; - The prefix of items in the agenda buffer can be configured.
-;; - Cleanup.
+;; Version 4.06
+;; - HTML exporter treats targeted internal links.
+;; - Bug fixes.
;;
-;; Version 3.07
-;; - Some folding incinsistencies removed.
-;; - BBDB links to company-only entries.
-;; - Bug fixes and global cleanup.
+;; Version 4.05
+;; - Changes to internal link system (thanks to David Wainberg for ideas).
+;; - in-file links: [[Search String]] instead of <file:::Search String>
+;; - automatic links to "radio targets".
+;; - CamelCase not longer active by default, configure org-activate-camels
+;; if you want to turn it back on.
+;; - After following a link, `C-c &' jumps back to it.
+;; - MH-E link support (thanks to Thomas Baumann).
+;; - Special table lines are no longer exported.
+;; - Bug fixes and minor improvements.
;;
-;; Version 3.06
-;; - M-S-RET inserts a new TODO heading.
-;; - New startup option `content'.
-;; - Better visual response when TODO items in agenda change status.
-;; - Window positioning after visibility state changes optimized and made
-;; configurable. See `org-cycle-hook' and `org-occur-hook'.
+;; Version 4.04
+;; - Cleanup tags display in agenda.
+;; - Bug fixes.
;;
-;; Version 3.05
-;; - Agenda entries from the diary are linked to the diary file, so
-;; adding and editing diary entries can be done directly from the agenda.
-;; - Many calendar/diary commands available directly from agenda.
-;; - Field copying in tables with S-RET does increment.
-;; - C-c C-x C-v extracts the visible part of the buffer for printing.
-;; - Moving subtrees up and down preserves the whitespace at the tree end.
+;; Version 4.03
+;; - Table alignment fixed for use with wide characters.
+;; - `C-c -' leaves cursor in current table line.
+;; - The current TAG can be incorporated into the agenda prefix.
+;; See option `org-agenda-prefix-format' for details.
;;
-;; Version 3.04
-;; - Table editor optimized to need fewer realignments, and to keep
-;; table shape when typing in fields.
-;; - A new minor mode, orgtbl-mode, introduces the Org-mode table editor
-;; into arbitrary major modes.
-;; - Fixed bug with realignment in XEmacs.
-;; - Startup options can be set with special #+STARTUP line.
-;; - Heading following a match in org-occur can be suppressed.
+;; Version 4.02
+;; - Minor bug fixes and improvements around tag searches.
+;; - XEmacs compatibility fixes.
;;
-;; Version 3.03
-;; - Copyright transfer to the FSF.
-;; - Effect of C-u and C-u C-u in org-timeline swapped.
-;; - Timeline now always contains today, and `.' jumps to it.
-;; - Table editor:
-;; - cut and paste of rectangular regions in tables
-;; - command to convert org-mode table to table.el table and back
-;; - command to treat several cells like a paragraph and fill it
-;; - command to convert a buffer region to a table
-;; - import/export tables as tab-separated files (exchange with Excel)
-;; - Agenda:
-;; - Sorting mechanism for agenda items rewritten from scratch.
-;; - Sorting fully configurable.
-;; - Entries specifying a time are sorted together.
-;; - Completion also covers option keywords after `#-'.
-;; - Bug fixes.
+;; Version 4.01
+;; - Tags can also be set remotely from agenda buffer.
+;; - Boolean logic for tag searches.
+;; - Additional agenda commands can be configured through the variable
+;; `org-agenda-custom-commands'.
+;; - Minor bug fixes.
;;
-;; Version 3.01
-;; - New reference card, thanks to Philip Rooke for creating it.
-;; - Single file agenda renamed to "Timeline". It no longer shows
-;; warnings about upcoming deadlines/overdue scheduled items.
-;; That functionality is now limited to the (multifile) agenda.
-;; - When reading a date, the calendar can be manipulated with keys.
-;; - Link support for RMAIL and Wanderlust (from planner.el, untested).
-;; - Minor bug fixes and documentation improvements.
-
;;; Code:
-(eval-when-compile (require 'cl) (require 'calendar))
+(eval-when-compile
+ (require 'cl)
+ (require 'calendar))
(require 'outline)
(require 'time-date)
(require 'easymenu)
-(defvar calc-embedded-close-formula)
-(defvar calc-embedded-open-formula)
-(defvar font-lock-unfontify-region-function)
+(defvar calc-embedded-close-formula) ; defined by the calc package
+(defvar calc-embedded-open-formula) ; defined by the calc package
+(defvar font-lock-unfontify-region-function) ; defined by font-lock.el
;;; Customization variables
-(defvar org-version "3.16"
+(defvar org-version "4.21"
"The version number of the file org.el.")
(defun org-version ()
(interactive)
(message "Org-mode version %s" org-version))
-;; The following two constants are for compatibility with different Emacs
-;; versions (Emacs versus XEmacs) and with different versions of outline.el.
-;; The compatibility code in org.el is based on these two constants.
-(defconst org-xemacs-p (featurep 'xemacs)
- "Are we running xemacs?")
+;; The following constant is for compatibility with different versions
+;; of outline.el.
(defconst org-noutline-p (featurep 'noutline)
"Are we using the new outline mode?")
+(defconst org-xemacs-p (featurep 'xemacs))
+(defconst org-format-transports-properties-p
+ (let ((x "a"))
+ (add-text-properties 0 1 '(test t) x)
+ (get-text-property 0 'test (format "%s" x)))
+ "Does format transport text properties?")
(defgroup org nil
- "Outline-based notes management and organizer "
+ "Outline-based notes management and organizer."
:tag "Org"
:group 'outlines
:group 'hypermedia
:tag "Org Startup"
:group 'org)
-(defcustom org-CUA-compatible nil
- "Non-nil means use alternative key bindings for S-<cursor movement>.
-Org-mode used S-<cursor movement> for changing timestamps and priorities.
-S-<cursor movement> is also used for example by `CUA-mode' to select text.
-If you want to use Org-mode together with `CUA-mode', Org-mode needs to use
-alternative bindings. Setting this variable to t will replace the following
-keys both in Org-mode and in the Org-agenda buffer.
-
-S-RET -> C-S-RET
-S-up -> M-p
-S-down -> M-n
-S-left -> M--
-S-right -> M-+
-
-If you do not like the alternative keys, take a look at the variable
-`org-disputed-keys'.
-
-This option is only relevant at load-time of Org-mode. Changing it requires
-a restart of Emacs to become effective."
- :group 'org-startup
- :type 'boolean)
-
-(defvar org-disputed-keys
- '((S-up [(shift up)] [(meta ?p)])
- (S-down [(shift down)] [(meta ?n)])
- (S-left [(shift left)] [(meta ?-)])
- (S-right [(shift right)] [(meta ?+)])
- (S-return [(shift return)] [(control shift return)]))
- "Keys for which Org-mode and other modes compete.
-This is an alist, cars are symbols for lookup, 1st element is the default key,
-second element will be used when `org-CUA-compatible' is t.")
-
-(defun org-key (key)
- "Select a key according to `org-CUA-compatible'."
- (nth (if org-CUA-compatible 2 1)
- (or (assq key org-disputed-keys)
- (error "Invalid Key %s in `org-key'" key))))
-
(defcustom org-startup-folded t
"Non-nil means, entering Org-mode will switch to OVERVIEW.
This can also be configured on a per-file basis by adding one of
:group 'org-startup
:type 'boolean)
+(defcustom org-startup-align-all-tables nil
+ "Non-nil means, align all tables when visiting a file.
+This is useful when the column width in tables is forced with <N> cookies
+in table fields. Such tables will look correct only after the first re-align."
+ :group 'org-startup
+ :type 'boolean)
+
(defcustom org-startup-with-deadline-check nil
"Non-nil means, entering Org-mode will run the deadline check.
This means, if you start editing an org file, you will get an
:group 'org-startup
:type 'boolean)
-(defgroup org-keywords nil
- "Options concerning TODO items in Org-mode."
- :tag "Org Keywords"
- :group 'org)
+(defcustom org-CUA-compatible nil
+ "Non-nil means use alternative key bindings for S-<cursor movement>.
+Org-mode used S-<cursor movement> for changing timestamps and priorities.
+S-<cursor movement> is also used for example by `CUA-mode' to select text.
+If you want to use Org-mode together with `CUA-mode', Org-mode needs to use
+alternative bindings. Setting this variable to t will replace the following
+keys both in Org-mode and in the Org-agenda buffer.
-(defcustom org-todo-keywords '("TODO" "DONE")
- "List of TODO entry keywords.
-\\<org-mode-map>By default, this is '(\"TODO\" \"DONE\"). The last entry in the list is
-considered to mean that the entry is \"done\". All the other mean that
-action is required, and will make the entry show up in todo lists, diaries
-etc.
-The command \\[org-todo] cycles an entry through these states, and an
-additional state where no keyword is present. For details about this
-cycling, see also the variable `org-todo-interpretation'
-Changes become only effective after restarting Emacs."
- :group 'org-keywords
- :type '(repeat (string :tag "Keyword")))
+S-RET -> C-S-RET
+S-up -> M-p
+S-down -> M-n
+S-left -> M--
+S-right -> M-+
-(defcustom org-todo-interpretation 'sequence
- "Controls how TODO keywords are interpreted.
-\\<org-mode-map>Possible values are `sequence' and `type'.
-This variable is only relevant if `org-todo-keywords' contains more than two
-states. There are two ways how these keywords can be used:
-
-- As a sequence in the process of working on a TODO item, for example
- (setq org-todo-keywords '(\"TODO\" \"STARTED\" \"VERIFY\" \"DONE\")
- org-todo-interpretation 'sequence)
-
-- As different types of TODO items, for example
- (setq org-todo-keywords '(\"URGENT\" \"RELAXED\" \"REMIND\" \"FOR_TOM\" \"DONE\")
- org-todo-interpretation 'type)
-
-When the states are interpreted as a sequence, \\[org-todo] always cycles
-to the next state, in order to walk through all different states. So with
-\\[org-todo], you turn an empty entry into the state TODO. When you started
-working on the item, you use \\[org-todo] again to switch it to \"STARTED\",
-later to VERIFY and finally to DONE.
-
-When the states are interpreted as types, \\[org-todo] still cycles through
-when it is called several times in direct succession, in order to initially
-select the type. However, if not called immediately after a previous
-\\[org-todo], it switches from each type directly to DONE. So with the
-above example, you could use `\\[org-todo] \\[org-todo]' to label an entry
-RELAXED. If you later return to this entry and press \\[org-todo] again,
-RELAXED will not be changed REMIND, but directly to DONE.
-
-You can create a large number of types. To initially select a
-type, it is then best to use \\[universal-argument] \\[org-todo] in order to specify the
-type with completion. Of course, you can also type the keyword
-directly into the buffer. M-TAB completes TODO keywords at the
-beginning of a headline."
- :group 'org-keywords
- :type '(choice (const sequence)
- (const type)))
+If you do not like the alternative keys, take a look at the variable
+`org-disputed-keys'.
-(defcustom org-default-priority ?B
- "The default priority of TODO items.
-This is the priority an item get if no explicit priority is given."
- :group 'org-keywords
- :type 'character)
+This option is only relevant at load-time of Org-mode. Changing it requires
+a restart of Emacs to become effective."
+ :group 'org-startup
+ :type 'boolean)
-(defcustom org-lowest-priority ?C
- "The lowest priority of TODO items. A character like ?A, ?B etc."
- :group 'org-keywords
- :type 'character)
+(defvar org-disputed-keys
+ '((S-up [(shift up)] [(meta ?p)])
+ (S-down [(shift down)] [(meta ?n)])
+ (S-left [(shift left)] [(meta ?-)])
+ (S-right [(shift right)] [(meta ?+)])
+ (S-return [(shift return)] [(control shift return)]))
+ "Keys for which Org-mode and other modes compete.
+This is an alist, cars are symbols for lookup, 1st element is the default key,
+second element will be used when `org-CUA-compatible' is t.")
+
+(defun org-key (key)
+ "Select a key according to `org-CUA-compatible'."
+ (nth (if org-CUA-compatible 2 1)
+ (or (assq key org-disputed-keys)
+ (error "Invalid Key %s in `org-key'" key))))
+
+(defcustom org-ellipsis nil
+ "The ellipsis to use in the Org-mode outline.
+When nil, just use the standard three dots. When a string, use that instead,
+and just in Org-mode (which will then use its own display table).
+Changing this requires executing `M-x org-mode' in a buffer to become
+effective."
+ :group 'org-startup
+ :type '(choice (const :tag "Default" nil)
+ (string :tag "String" :value "...#")))
+
+(defvar org-display-table nil
+ "The display table for org-mode, in case `org-ellipsis' is non-nil.")
+
+(defgroup org-keywords nil
+ "Keywords in Org-mode."
+ :tag "Org Keywords"
+ :group 'org)
(defcustom org-deadline-string "DEADLINE:"
"String to mark deadline entries.
:group 'org-keywords
:type 'string)
+(defcustom org-closed-string "CLOSED:"
+ "String used as the prefix for timestamps logging closing a TODO entry."
+ :group 'org-keywords
+ :type 'string)
+
(defcustom org-comment-string "COMMENT"
"Entries starting with this keyword will never be exported.
An entry can be toggled between COMMENT and normal with
Quoting applies only to the text in the entry following the headline, and does
not extend beyond the next headline, even if that is lower level.
An entry can be toggled between QUOTE and normal with
-\\[org-toggle-fixed-width-section]"
+\\[org-toggle-fixed-width-section]."
:group 'org-keywords
:type 'string)
-(defcustom org-after-todo-state-change-hook nil
- "Hook which is run after the state of a TODO item was changed.
-The new state (a string with a todo keyword, or nil) is available in the
-Lisp variable `state'."
- :group 'org-keywords
+(defgroup org-structure nil
+ "Options concerning the general structure of Org-mode files."
+ :tag "Org Structure"
+ :group 'org)
+
+(defgroup org-cycle nil
+ "Options concerning visibility cycling in Org-mode."
+ :tag "Org Cycle"
+ :group 'org-structure)
+
+(defcustom org-cycle-emulate-tab t
+ "Where should `org-cycle' emulate TAB.
+nil Never
+white Only in completely white lines
+t Everywhere except in headlines"
+ :group 'org-cycle
+ :type '(choice (const :tag "Never" nil)
+ (const :tag "Only in completely white lines" white)
+ (const :tag "Everywhere except in headlines" t)
+ ))
+
+(defcustom org-cycle-hook '(org-optimize-window-after-visibility-change)
+ "Hook that is run after `org-cycle' has changed the buffer visibility.
+The function(s) in this hook must accept a single argument which indicates
+the new state that was set by the most recent `org-cycle' command. The
+argument is a symbol. After a global state change, it can have the values
+`overview', `content', or `all'. After a local state change, it can have
+the values `folded', `children', or `subtree'."
+ :group 'org-cycle
:type 'hook)
-;; Variables for pre-computed regular expressions, all buffer local
-(defvar org-todo-kwd-priority-p nil
- "Do TODO items have priorities?")
-(make-variable-buffer-local 'org-todo-kwd-priority-p)
-(defvar org-todo-kwd-max-priority nil
- "Maximum priority of TODO items.")
-(make-variable-buffer-local 'org-todo-kwd-max-priority)
-(defvar org-ds-keyword-length 12
- "Maximum length of the Deadline and SCHEDULED keywords.")
-(make-variable-buffer-local 'org-ds-keyword-length)
-(defvar org-done-string nil
- "The last string in `org-todo-keywords', indicating an item is DONE.")
-(make-variable-buffer-local 'org-done-string)
-(defvar org-todo-regexp nil
- "Matches any of the TODO state keywords.")
-(make-variable-buffer-local 'org-todo-regexp)
-(defvar org-not-done-regexp nil
- "Matches any of the TODO state keywords except the last one.")
-(make-variable-buffer-local 'org-not-done-regexp)
-(defvar org-todo-line-regexp nil
- "Matches a headline and puts TODO state into group 2 if present.")
-(make-variable-buffer-local 'org-todo-line-regexp)
-(defvar org-nl-done-regexp nil
- "Matches newline followed by a headline with the DONE keyword.")
-(make-variable-buffer-local 'org-nl-done-regexp)
-(defvar org-looking-at-done-regexp nil
- "Matches the DONE keyword a point.")
-(make-variable-buffer-local 'org-looking-at-done-regexp)
-(defvar org-deadline-regexp nil
- "Matches the DEADLINE keyword.")
-(make-variable-buffer-local 'org-deadline-regexp)
-(defvar org-deadline-time-regexp nil
- "Matches the DEADLINE keyword together with a time stamp.")
-(make-variable-buffer-local 'org-deadline-time-regexp)
-(defvar org-deadline-line-regexp nil
- "Matches the DEADLINE keyword and the rest of the line.")
-(make-variable-buffer-local 'org-deadline-line-regexp)
-(defvar org-scheduled-regexp nil
- "Matches the SCHEDULED keyword.")
-(make-variable-buffer-local 'org-scheduled-regexp)
-(defvar org-scheduled-time-regexp nil
- "Matches the SCHEDULED keyword together with a time stamp.")
-(make-variable-buffer-local 'org-scheduled-time-regexp)
+(defgroup org-edit-structure nil
+ "Options concerning structure editing in Org-mode."
+ :tag "Org Edit Structure"
+ :group 'org-structure)
+
+(defcustom org-odd-levels-only nil
+ "Non-nil means, skip even levels and only use odd levels for the outline.
+This has the effect that two stars are being added/taken away in
+promotion/demotion commands. It also influences how levels are
+handled by the exporters.
+Changing it requires restart of `font-lock-mode' to become effective
+for fontification also in regions already fontified."
+ :group 'org-edit-structure
+ :group 'org-font-lock
+ :type 'boolean)
-(defvar org-category nil
- "Variable used by org files to set a category for agenda display.
-Such files should use a file variable to set it, for example
+(defcustom org-adapt-indentation t
+ "Non-nil means, adapt indentation when promoting and demoting.
+When this is set and the *entire* text in an entry is indented, the
+indentation is increased by one space in a demotion command, and
+decreased by one in a promotion command. If any line in the entry
+body starts at column 0, indentation is not changed at all."
+ :group 'org-edit-structure
+ :type 'boolean)
- -*- mode: org; org-category: \"ELisp\"
+(defcustom org-enable-fixed-width-editor t
+ "Non-nil means, lines starting with \":\" are treated as fixed-width.
+This currently only means, they are never auto-wrapped.
+When nil, such lines will be treated like ordinary lines.
+See also the QUOTE keyword."
+ :group 'org-edit-structure
+ :type 'boolean)
-or contain a special line
+(defgroup org-sparse-trees nil
+ "Options concerning sparse trees in Org-mode."
+ :tag "Org Sparse Trees"
+ :group 'org-structure)
-#+CATEGORY: ELisp
+(defcustom org-highlight-sparse-tree-matches t
+ "Non-nil means, highlight all matches that define a sparse tree.
+The highlights will automatically disappear the next time the buffer is
+changed by an edit command."
+ :group 'org-sparse-trees
+ :type 'boolean)
-If the file does not specify a category, then file's base name
-is used instead.")
+(defcustom org-show-hierarchy-above t
+ "Non-nil means, show full hierarchy when showing a spot in the tree.
+Turning this off makes sparse trees more compact, but also less clear."
+ :group 'org-sparse-trees
+ :type 'boolean)
-(defun org-set-regexps-and-options ()
- "Precompute regular expressions for current buffer."
- (when (eq major-mode 'org-mode)
- (let ((re (org-make-options-regexp
- '("CATEGORY" "SEQ_TODO" "PRI_TODO" "TYP_TODO"
- "STARTUP" "ARCHIVE")))
- (splitre "[ \t]+")
- kwds int key value cat arch)
- (save-excursion
- (save-restriction
- (widen)
- (goto-char (point-min))
- (while (re-search-forward re nil t)
- (setq key (match-string 1) value (match-string 2))
- (cond
- ((equal key "CATEGORY")
- (if (string-match "[ \t]+$" value)
- (setq value (replace-match "" t t value)))
- (setq cat (intern value)))
- ((equal key "SEQ_TODO")
- (setq int 'sequence
- kwds (append kwds (org-split-string value splitre))))
- ((equal key "PRI_TODO")
- (setq int 'priority
- kwds (append kwds (org-split-string value splitre))))
- ((equal key "TYP_TODO")
- (setq int 'type
- kwds (append kwds (org-split-string value splitre))))
- ((equal key "STARTUP")
- (let ((opts (org-split-string value splitre))
- (set '(("fold" org-startup-folded t)
- ("nofold" org-startup-folded nil)
- ("content" org-startup-folded content)
- ("dlcheck" org-startup-with-deadline-check t)
- ("nodlcheck" org-startup-with-deadline-check nil)))
- l var val)
- (while (setq l (assoc (pop opts) set))
- (setq var (nth 1 l) val (nth 2 l))
- (set (make-local-variable var) val))))
- ((equal key "ARCHIVE")
- (string-match " *$" value)
- (setq arch (replace-match "" t t value))
- (remove-text-properties 0 (length arch)
- '(face t fontified t) arch)))
- )))
- (and cat (set (make-local-variable 'org-category) cat))
- (and kwds (set (make-local-variable 'org-todo-keywords) kwds))
- (and arch (set (make-local-variable 'org-archive-location) arch))
- (and int (set (make-local-variable 'org-todo-interpretation) int)))
- ;; Compute the regular expressions and other local variables
- (setq org-todo-kwd-priority-p (equal org-todo-interpretation 'priority)
- org-todo-kwd-max-priority (1- (length org-todo-keywords))
- org-ds-keyword-length (+ 2 (max (length org-deadline-string)
- (length org-scheduled-string)))
- org-done-string
- (nth (1- (length org-todo-keywords)) org-todo-keywords)
- org-todo-regexp
- (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords
- "\\|") "\\)\\>")
- org-not-done-regexp
- (concat "\\<\\("
- (mapconcat 'regexp-quote
- (nreverse (cdr (reverse org-todo-keywords)))
- "\\|")
- "\\)\\>")
- org-todo-line-regexp
- (concat "^\\(\\*+\\)[ \t]*\\("
- (mapconcat 'regexp-quote org-todo-keywords "\\|")
- "\\)? *\\(.*\\)")
- org-nl-done-regexp
- (concat "[\r\n]\\*+[ \t]+" org-done-string "\\>")
- org-looking-at-done-regexp (concat "^" org-done-string "\\>")
- org-deadline-regexp (concat "\\<" org-deadline-string)
- org-deadline-time-regexp
- (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
- org-deadline-line-regexp
- (concat "\\<\\(" org-deadline-string "\\).*")
- org-scheduled-regexp
- (concat "\\<" org-scheduled-string)
- org-scheduled-time-regexp
- (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
- (org-set-font-lock-defaults)))
+(defcustom org-show-following-heading t
+ "Non-nil means, show heading following match in `org-occur'.
+When doing an `org-occur' it is useful to show the headline which
+follows the match, even if they do not match the regexp. This makes it
+easier to edit directly inside the sparse tree. However, if you use
+`org-occur' mainly as an overview, the following headlines are
+unnecessary clutter."
+ :group 'org-sparse-trees
+ :type 'boolean)
-(defgroup org-time nil
- "Options concerning time stamps and deadlines in Org-mode."
- :tag "Org Time"
- :group 'org)
+(defcustom org-occur-hook '(org-first-headline-recenter)
+ "Hook that is run after `org-occur' has constructed a sparse tree.
+This can be used to recenter the window to show as much of the structure
+as possible."
+ :group 'org-sparse-trees
+ :type 'hook)
-(defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
- "Formats for `format-time-string' which are used for time stamps.
-It is not recommended to change this constant.")
+(defgroup org-plain-lists nil
+ "Options concerning plain lists in Org-mode."
+ :tag "Org Plain lists"
+ :group 'org-structure)
+
+(defcustom org-cycle-include-plain-lists nil
+ "Non-nil means, include plain lists into visibility cycling.
+This means that during cycling, plain list items will *temporarily* be
+interpreted as outline headlines with a level given by 1000+i where i is the
+indentation of the bullet. In all other operations, plain list items are
+not seen as headlines. For example, you cannot assign a TODO keyword to
+such an item."
+ :group 'org-plain-lists
+ :type 'boolean)
-(defcustom org-deadline-warning-days 30
- "No. of days before expiration during which a deadline becomes active.
-This variable governs the display in the org file."
- :group 'org-time
- :type 'number)
+(defcustom org-plain-list-ordered-item-terminator t
+ "The character that makes a line with leading number an ordered list item.
+Valid values are ?. and ?\). To get both terminators, use t. While
+?. may look nicer, it creates the danger that a line with leading
+number may be incorrectly interpreted as an item. ?\) therefore is
+the safe choice."
+ :group 'org-plain-lists
+ :type '(choice (const :tag "dot like in \"2.\"" ?.)
+ (const :tag "paren like in \"2)\"" ?\))
+ (const :tab "both" t)))
+
+(defcustom org-auto-renumber-ordered-lists t
+ "Non-nil means, automatically renumber ordered plain lists.
+Renumbering happens when the sequence have been changed with
+\\[org-shiftmetaup] or \\[org-shiftmetadown]. After other editing commands,
+use \\[org-ctrl-c-ctrl-c] to trigger renumbering."
+ :group 'org-plain-lists
+ :type 'boolean)
-(defcustom org-popup-calendar-for-date-prompt t
- "Non-nil means, pop up a calendar when prompting for a date.
-In the calendar, the date can be selected with mouse-1. However, the
-minibuffer will also be active, and you can simply enter the date as well.
-When nil, only the minibuffer will be available."
- :group 'org-time
- :type 'number)
+(defgroup org-archive nil
+ "Options concerning archiving in Org-mode."
+ :tag "Org Archive"
+ :group 'org-structure)
-(defcustom org-calendar-follow-timestamp-change t
- "Non-nil means, make the calendar window follow timestamp changes.
-When a timestamp is modified and the calendar window is visible, it will be
-moved to the new date."
- :group 'org-time
- :type 'boolean)
+(defcustom org-archive-location "%s_archive::"
+ "The location where subtrees should be archived.
+This string consists of two parts, separated by a double-colon.
-(defgroup org-agenda nil
- "Options concerning agenda display Org-mode."
- :tag "Org Agenda"
- :group 'org)
+The first part is a file name - when omitted, archiving happens in the same
+file. %s will be replaced by the current file name (without directory part).
+Archiving to a different file is useful to keep archived entries from
+contributing to the Org-mode Agenda.
-(defcustom org-agenda-files nil
- "A list of org files for agenda/diary display.
-Entries are added to this list with \\[org-add-file] and removed with
-\\[org-remove-file]. You can also use customize to edit the list."
- :group 'org-agenda
- :type '(repeat file))
+The part after the double colon is a headline. The archived entries will be
+filed under that headline. When omitted, the subtrees are simply filed away
+at the end of the file, as top-level entries.
-(defcustom org-select-timeline-window t
- "Non-nil means, after creating a timeline, move cursor into Timeline window.
-When nil, cursor will remain in the current window."
- :group 'org-agenda
- :type 'boolean)
+Here are a few examples:
+\"%s_archive::\"
+ If the current file is Projects.org, archive in file
+ Projects.org_archive, as top-level trees. This is the default.
-(defcustom org-select-agenda-window t
- "Non-nil means, after creating an agenda, move cursor into Agenda window.
-When nil, cursor will remain in the current window."
- :group 'org-agenda
- :type 'boolean)
+\"::* Archived Tasks\"
+ Archive in the current file, under the top-level headline
+ \"* Archived Tasks\".
-(defcustom org-fit-agenda-window t
- "Non-nil means, change window size of agenda to fit content."
- :group 'org-agenda
- :type 'boolean)
+\"~/org/archive.org::\"
+ Archive in file ~/org/archive.org (absolute path), as top-level trees.
-(defcustom org-agenda-show-all-dates t
- "Non-nil means, `org-agenda' shows every day in the selected range.
-When nil, only the days which actually have entries are shown."
- :group 'org-agenda
- :type 'boolean)
+\"basement::** Finished Tasks\"
+ Archive in file ./basement (relative path), as level 3 trees
+ below the level 2 heading \"** Finished Tasks\".
-;; FIXME: First day of month works only for current month because it would
-;; require a variable ndays treatment.
-(defcustom org-agenda-start-on-weekday 1
- "Non-nil means, start the overview always on the specified weekday.
-0 Denotes Sunday, 1 denotes Monday etc.
-When nil, always start on the current day."
- :group 'org-agenda
- :type '(choice (const :tag "Today" nil)
- (const :tag "First day of month" t)
- (number :tag "Weekday No.")))
+You may set this option on a per-file basis by adding to the buffer a
+line like
-(defcustom org-agenda-ndays 7
- "Number of days to include in overview display."
- :group 'org-agenda
- :type 'number)
+#+ARCHIVE: basement::** Finished Tasks"
+ :group 'org-archive
+ :type 'string)
-(defcustom org-agenda-include-all-todo t
- "Non-nil means, the agenda will always contain all TODO entries.
-When nil, date-less entries will only be shown if `org-agenda' is called
-with a prefix argument.
-When non-nil, the TODO entries will be listed at the top of the agenda, before
-the entries for specific days."
- :group 'org-agenda
+(defcustom org-archive-mark-done t
+ "Non-nil means, mark archived entries as DONE."
+ :group 'org-archive
:type 'boolean)
-(defcustom org-agenda-include-diary nil
- "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
- :group 'org-agenda
+(defcustom org-archive-stamp-time t
+ "Non-nil means, add a time stamp to archived entries.
+The time stamp will be added directly after the TODO state keyword in the
+first line, so it is probably best to use this in combinations with
+`org-archive-mark-done'."
+ :group 'org-archive
:type 'boolean)
-(defcustom org-calendar-to-agenda-key [?c]
- "The key to be installed in `calendar-mode-map' for switching to the agenda.
-The command `org-calendar-goto-agenda' will be bound to this key. The
-default is the character `c' because then`c' can be used to switch back and
-force between agenda and calendar."
- :group 'org-agenda
- :type 'sexp)
+(defgroup org-table nil
+ "Options concerning tables in Org-mode."
+ :tag "Org Table"
+ :group 'org)
-(defcustom org-agenda-sorting-strategy '(time-up category-keep priority-down)
- "Sorting structure for the agenda items of a single day.
-This is a list of symbols which will be used in sequence to determine
-if an entry should be listed before another entry. The following
-symbols are recognized.
+(defcustom org-enable-table-editor 'optimized
+ "Non-nil means, lines starting with \"|\" are handled by the table editor.
+When nil, such lines will be treated like ordinary lines.
-time-up Put entries with time-of-day indications first, early first
-time-down Put entries with time-of-day indications first, late first
-category-keep Keep the default order of categories, corresponding to the
- sequence in `org-agenda-files'.
-category-up Sort alphabetically by category, A-Z.
-category-down Sort alphabetically by category, Z-A.
-priority-up Sort numerically by priority, high priority last.
-priority-down Sort numerically by priority, high priority first.
+When equal to the symbol `optimized', the table editor will be optimized to
+do the following:
+- Use automatic overwrite mode in front of whitespace in table fields.
+ This make the structure of the table stay in tact as long as the edited
+ field does not exceed the column width.
+- Minimize the number of realigns. Normally, the table is aligned each time
+ TAB or RET are pressed to move to another field. With optimization this
+ happens only if changes to a field might have changed the column width.
+Optimization requires replacing the functions `self-insert-command',
+`delete-char', and `backward-delete-char' in Org-mode buffers, with a
+slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
+very good at guessing when a re-align will be necessary, but you can always
+force one with \\[org-ctrl-c-ctrl-c].
-The different possibilities will be tried in sequence, and testing stops
-if one comparison returns a \"not-equal\". For example, the default
- '(time-up category-keep priority-down)
-means: Pull out all entries having a specified time of day and sort them,
-in order to make a time schedule for the current day the first thing in the
-agenda listing for the day. Of the entries without a time indication, keep
-the grouped in categories, don't sort the categories, but keep them in
-the sequence given in `org-agenda-files'. Within each category sort by
-priority.
+If you would like to use the optimized version in Org-mode, but the
+un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
-Leaving out `category-keep' would mean that items will be sorted across
-categories by priority."
- :group 'org-agenda
- :type '(repeat
- (choice
- (const time-up)
- (const time-down)
- (const category-keep)
- (const category-up)
- (const category-down)
- (const priority-up)
- (const priority-down))))
+This variable can be used to turn on and off the table editor during a session,
+but in order to toggle optimization, a restart is required.
-(defcustom org-agenda-prefix-format " %-12:c%?-12t% s"
- "Format specification for the prefix of items in the agenda buffer.
-This format works similar to a printf format, with the following meaning:
+See also the variable `org-table-auto-blank-field'."
+ :group 'org-table
+ :type '(choice
+ (const :tag "off" nil)
+ (const :tag "on" t)
+ (const :tag "on, optimized" optimized)))
- %c the category of the item, \"Diary\" for entries from the diary, or
- as given by the CATEGORY keyword or derived from the file name.
- %t the time-of-day specification if one applies to the entry, in the
- format HH:MM
- %s Scheduling/Deadline information, a short string
+(defcustom orgtbl-optimized (eq org-enable-table-editor 'optimized)
+ "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
+In the optimized version, the table editor takes over all simple keys that
+normally just insert a character. In tables, the characters are inserted
+in a way to minimize disturbing the table structure (i.e. in overwrite mode
+for empty fields). Outside tables, the correct binding of the keys is
+restored.
-All specifiers work basically like the standard `%s' of printf, but may
-contain two additional characters: A question mark just after the `%' and
-a whitespace/punctuation character just before the final letter.
+The default for this option is t if the optimized version is also used in
+Org-mode. See the variable `org-enable-table-editor' for details. Changing
+this variable requires a restart of Emacs to become effective."
+ :group 'org-table
+ :type 'boolean)
-If the first character after `%' is a question mark, the entire field
-will only be included if the corresponding value applies to the
-current entry. This is useful for fields which should have fixed
-width when present, but zero width when absent. For example,
-\"%?-12t\" will result in a 12 character time field if a time of the
-day is specified, but will completely disappear in entries which do
-not contain a time.
+(defgroup org-table-settings nil
+ "Settings for tables in Org-mode."
+ :tag "Org Table Settings"
+ :group 'org-table)
-If there is punctuation or whitespace character just before the final
-format letter, this character will be appended to the field value if
-the value is not empty. For example, the format \"%-12:c\" leads to
-\"Diary: \" if the category is \"Diary\". If the category were be
-empty, no additional colon would be interted.
+(defcustom org-table-default-size "5x2"
+ "The default size for newly created tables, Columns x Rows."
+ :group 'org-table-settings
+ :type 'string)
-The default value of this option is \" %-12:c%?-12t% s\", meaning:
-- Indent the line with two space characters
-- Give the category in a 12 chars wide field, padded with whitespace on
- the right (because of `-'). Append a colon if there is a category
- (because of `:').
-- If there is a time-of-day, put it into a 12 chars wide field. If no
- time, don't put in an empty field, just skip it (because of '?').
-- Finally, put the scheduling information and append a whitespace.
+(defcustom org-table-number-regexp "^[<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*$"
+ "Regular expression for recognizing numbers in table columns.
+If a table column contains mostly numbers, it will be aligned to the
+right. If not, it will be aligned to the left.
-As another example, if you don't want the time-of-day of entries in
-the prefix, you could use:
+The default value of this option is a regular expression which allows
+anything which looks remotely like a number as used in scientific
+context. For example, all of the following will be considered a
+number:
+ 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
- (setq org-agenda-prefix-format \" %-11:c% s\")
+Other options offered by the customize interface are more restrictive."
+ :group 'org-table-settings
+ :type '(choice
+ (const :tag "Positive Integers"
+ "^[0-9]+$")
+ (const :tag "Integers"
+ "^[-+]?[0-9]+$")
+ (const :tag "Floating Point Numbers"
+ "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.[0-9]*\\)$")
+ (const :tag "Floating Point Number or Integer"
+ "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.?[0-9]*\\)$")
+ (const :tag "Exponential, Floating point, Integer"
+ "^[-+]?[0-9.]+\\([eEdD][-+0-9]+\\)?$")
+ (const :tag "Very General Number-Like"
+ "^[<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*$")
+ (string :tag "Regexp:")))
-See also the variable `org-agenda-remove-times-when-in-prefix'."
- :type 'string
- :group 'org-agenda)
+(defcustom org-table-number-fraction 0.5
+ "Fraction of numbers in a column required to make the column align right.
+In a column all non-white fields are considered. If at least this
+fraction of fields is matched by `org-table-number-fraction',
+alignment to the right border applies."
+ :group 'org-table-settings
+ :type 'number)
-(defcustom org-timeline-prefix-format " % s"
- "Like `org-agenda-prefix-format', but for the timeline of a single file."
- :type 'string
- :group 'org-agenda)
+(defgroup org-table-editing nil
+ "Bahavior of tables during editing in Org-mode."
+ :tag "Org Table Editing"
+ :group 'org-table)
-(defvar org-prefix-format-compiled nil
- "The compiled version of the most recently used prefix format.
-Depending on which command was used last, this may be the compiled version
-of `org-agenda-prefix-format' or `org-timeline-prefix-format'.")
+(defcustom org-table-automatic-realign t
+ "Non-nil means, automatically re-align table when pressing TAB or RETURN.
+When nil, aligning is only done with \\[org-table-align], or after column
+removal/insertion."
+ :group 'org-table-editing
+ :type 'boolean)
-(defcustom org-agenda-use-time-grid t
- "Non-nil means, show a time grid in the agenda schedule.
-A time grid is a set of lines for specific times (like every two hours between
-8:00 and 20:00. The items scheduled for a day at specific times are
-sorted in between these lines.
-For deails about when the grid will be shown, and what it will look like, see
-the variable `org-agenda-time-grid'."
- :group 'org-agenda
+(defcustom org-table-limit-column-width t ;kw
+ "Non-nil means, allow to limit the width of table columns with <N> fields."
+ :group 'org-table-editing
:type 'boolean)
-(defcustom org-agenda-time-grid
- '((daily today require-timed)
- "----------------"
- (800 1000 1200 1400 1600 1800 2000))
+(defcustom org-table-auto-blank-field t
+ "Non-nil means, automatically blank table field when starting to type into it.
+This only happens when typing immediately after a field motion
+command (TAB, S-TAB or RET).
+Only relevant when `org-enable-table-editor' is equal to `optimized'."
+ :group 'org-table-editing
+ :type 'boolean)
- "The settings for time grid for agenda display.
-This is a list of three items. The first item is again a list. It contains
-symbols specifying conditions when the grid should be displayed:
+(defcustom org-table-tab-jumps-over-hlines t
+ "Non-nil means, tab in the last column of a table with jump over a hline.
+If a horizontal separator line is following the current line,
+`org-table-next-field' can either create a new row before that line, or jump
+over the line. When this option is nil, a new line will be created before
+this line."
+ :group 'org-table-editing
+ :type 'boolean)
- daily if the agenda shows a single day
- weekly if the agenda shows an entire week
- today show grid on current date, independent of daily/weekly display
- require-timed show grid only if at least on item has a time specification
+(defcustom org-table-tab-recognizes-table.el t
+ "Non-nil means, TAB will automatically notice a table.el table.
+When it sees such a table, it moves point into it and - if necessary -
+calls `table-recognize-table'."
+ :group 'org-table-editing
+ :type 'boolean)
-The second item is a string which will be places behing the grid time.
+(defgroup org-table-calculation nil
+ "Options concerning tables in Org-mode."
+ :tag "Org Table Calculation"
+ :group 'org-table)
-The third item is a list of integers, indicating the times that should have
-a grid line."
- :group 'org-agenda
- :type
- '(list
- (set :greedy t :tag "Grid Display Options"
- (const :tag "Show grid in single day agenda display" daily)
- (const :tag "Show grid in weekly agenda display" weekly)
- (const :tag "Always show grid for today" today)
- (const :tag "Show grid only if any timed entries are present"
- require-timed)
- (const :tag "Skip grid times already present in an entry"
- remove-match))
- (string :tag "Grid String")
- (repeat :tag "Grid Times" (integer :tag "Time"))))
+(defcustom org-table-copy-increment t
+ "Non-nil means, increment when copying current field with \\[org-table-copy-down]."
+ :group 'org-table-calculation
+ :type 'boolean)
-(defcustom org-agenda-remove-times-when-in-prefix t
- "Non-nil means, remove duplicate time specifications in agenda items.
-When the format `org-agenda-prefix-format' contains a `%t' specifier, a
-time-of-day specification in a headline or diary entry is extracted and
-placed into the prefix. If this option is non-nil, the original specification
-\(a timestamp or -range, or just a plain time(range) specification like
-11:30-4pm) will be removed for agenda display. This makes the agenda less
-cluttered.
-The option can be t or nil. It may also be the symbol `beg', indicating
-that the time should only be removed what it is located at the beginning of
-the headline/diary entry."
- :group 'org-agenda
- :type '(choice
- (const :tag "Always" t)
- (const :tag "Never" nil)
- (const :tag "When at beginning of entry" beg)))
+(defcustom org-calc-default-modes
+ '(calc-internal-prec 12
+ calc-float-format (float 5)
+ calc-angle-mode deg
+ calc-prefer-frac nil
+ calc-symbolic-mode nil
+ calc-date-format (YYYY "-" MM "-" DD " " Www (" " HH ":" mm))
+ calc-display-working-message t
+ )
+ "List with Calc mode settings for use in calc-eval for table formulas.
+The list must contain alternating symbols (Calc modes variables and values).
+Don't remove any of the default settings, just change the values. Org-mode
+relies on the variables to be present in the list."
+ :group 'org-table-calculation
+ :type 'plist)
-(defcustom org-sort-agenda-notime-is-late t
- "Non-nil means, items without time are considered late.
-This is only relevant for sorting. When t, items which have no explicit
-time like 15:30 will be considered as 24:01, i.e. later than any items which
-do have a time. When nil, the default time is before 0:00. You can use this
-option to decide if the schedule for today should come before or after timeless
-agenda entries."
- :group 'org-agenda
+(defcustom org-table-formula-evaluate-inline t
+ "Non-nil means, TAB and RET evaluate a formula in current table field.
+If the current field starts with an equal sign, it is assumed to be a formula
+which should be evaluated as described in the manual and in the documentation
+string of the command `org-table-eval-formula'. This feature requires the
+Emacs calc package.
+When this variable is nil, formula calculation is only available through
+the command \\[org-table-eval-formula]."
+ :group 'org-table-calculation
:type 'boolean)
-(defgroup org-structure nil
- "Options concerning structure editing in Org-mode."
- :tag "Org Structure"
- :group 'org)
-(defcustom org-cycle-hook '(org-optimize-window-after-visibility-change)
- "Hook that is run after `org-cycle' has changed the buffer visibility.
-The function(s) in this hook must accept a single argument which indicates
-the new state that was set by the most recent `org-cycle' command. The
-argument is a symbol. After a global state change, it can have the values
-`overview', `content', or `all'. After a local state change, it can have
-the values `folded', `children', or `subtree'."
- :group 'org-structure
- :type 'hook)
+(defcustom org-table-formula-use-constants t
+ "Non-nil means, interpret constants in formulas in tables.
+A constant looks like `$c' or `$Grav' and will be replaced before evaluation
+by the value given in `org-table-formula-constants', or by a value obtained
+from the `constants.el' package."
+ :group 'org-table-calculation
+ :type 'boolean)
-(defcustom org-occur-hook '(org-first-headline-recenter)
- "Hook that is run after `org-occur' has constructed a sparse tree.
-This can be used to recenter the window to show as much of the structure
-as possible."
- :group 'org-structure
- :type 'hook)
+(defcustom org-table-formula-constants nil
+ "Alist with constant names and values, for use in table formulas.
+The car of each element is a name of a constant, without the `$' before it.
+The cdr is the value as a string. For example, if you'd like to use the
+speed of light in a formula, you would configure
-(defcustom org-level-color-stars-only nil
- "Non-nil means fontify only the stars in each headline.
-When nil, the entire headline is fontified.
-After changin this, requires restart of Emacs to become effective."
- :group 'org-structure
- :type 'boolean)
+ (setq org-table-formula-constants '((\"c\" . \"299792458.\")))
-(defcustom org-adapt-indentation t
- "Non-nil means, adapt indentation when promoting and demoting.
-When this is set and the *entire* text in an entry is indented, the
-indentation is increased by one space in a demotion command, and
-decreased by one in a promotion command. If any line in the entry
-body starts at column 0, indentation is not changed at all."
- :group 'org-structure
+and then use it in an equation like `$1*$c'."
+ :group 'org-table-calculation
+ :type '(repeat
+ (cons (string :tag "name")
+ (string :tag "value"))))
+
+(defcustom org-table-formula-numbers-only nil
+ "Non-nil means, calculate only with numbers in table formulas.
+Then all input fields will be converted to a number, and the result
+must also be a number. When nil, calc's full potential is available
+in table calculations, including symbolics etc."
+ :group 'org-table-calculation
:type 'boolean)
-(defcustom org-enable-fixed-width-editor t
- "Non-nil means, lines starting with \":\" are treated as fixed-width.
-This currently only means, they are never auto-wrapped.
-When nil, such lines will be treated like ordinary lines.
-See also the QUOTE keyword."
- :group 'org-structure
+(defcustom org-table-allow-automatic-line-recalculation t
+ "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
+Automatically means, when TAB or RET or C-c C-c are pressed in the line."
+ :group 'org-table-calculation
:type 'boolean)
-(defcustom org-cycle-emulate-tab t
- "Where should `org-cycle' emulate TAB.
-nil Never
-white Only in completely white lines
-t Everywhere except in headlines"
- :group 'org-structure
- :type '(choice (const :tag "Never" nil)
- (const :tag "Only in completely white lines" white)
- (const :tag "Everywhere except in headlines" t)
- ))
+(defgroup org-link nil
+ "Options concerning links in Org-mode."
+ :tag "Org Link"
+ :group 'org)
-(defcustom org-show-following-heading t
- "Non-nil means, show heading following match in `org-occur'.
-When doing an `org-occur' it is useful to show the headline which
-follows the match, even if they do not match the regexp. This makes it
-easier to edit directly inside the sparse tree. However, if you use
-org-occur mainly as an overview, the following headlines are
-unnecessary clutter."
- :group 'org-structure
+(defcustom org-descriptive-links t
+ "Non-nil means, hide link part and only show description of bracket links.
+Bracket links are like [[link][descritpion]]. This variable sets the initial
+state in new org-mode buffers. The setting can then be toggled on a
+per-buffer basis from the Org->Hyperlinks menu."
+ :group 'org-link
:type 'boolean)
-(defcustom org-archive-location "%s_archive::"
- "The location where subtrees should be archived.
-This string consists of two parts, separated by a double-colon.
-
-The first part is a file name - when omitted, archiving happens in the same
-file. %s will be replaced by the current file name (without directory part).
-Archiving to a different file is useful to keep archived entries from
-contributing to the Org-mode Agenda.
+(defcustom org-link-style 'bracket
+ "The style of links to be inserted with \\[org-insert-link].
+Possible values are:
+bracket [[link][description]]. This is recommended
+plain Description \\n link. The old way, no longer recommended."
+ :group 'org-link
+ :type '(choice
+ (const :tag "Bracket (recommended)" bracket)
+ (const :tag "Plain (no longer recommended)" plain)))
-The part after the double colon is a headline. The archived entries will be
-filed under that headline. When omitted, the subtrees are simply filed away
-at the end of the file, as top-level entries.
-
-Here are a few examples:
-\"%s_archive::\"
- If the current file is Projects.org, archive in file
- Projects.org_archive, as top-level trees. This is the default.
-
-\"::* Archived Tasks\"
- Archive in the current file, under the top-level headline
- \"* Archived Tasks\".
-
-\"~/org/archive.org::\"
- Archive in file ~/org/archive.org (absolute path), as top-level trees.
-
-\"basement::** Finished Tasks\"
- Archive in file ./basement (relative path), as level 3 trees
- below the level 2 heading \"** Finished Tasks\".
-
-You may set this option on a per-file basis by adding to the buffer a
-line like
-
-#+ARCHIVE: basement::** Finished Tasks"
- :group 'org-structure
- :type 'string)
-
-(defcustom org-archive-mark-done t
- "Non-nil means, mark archived entries as DONE."
- :group 'org-structure
- :type 'boolean)
-
-(defcustom org-archive-stamp-time t
- "Non-nil means, add a time stamp to archived entries.
-The time stamp will be added directly after the TODO state keyword in the
-first line, so it is probably best to use this in combinations with
-`org-archive-mark-done'."
- :group 'org-structure
- :type 'boolean)
-
-(defgroup org-link nil
- "Options concerning links in Org-mode."
- :tag "Org Link"
- :group 'org)
-
-(defcustom org-link-format "<%s>"
- "Default format for linkes in the buffer.
+(defcustom org-link-format "%s"
+ "Default format for external, URL-like linkes in the buffer.
This is a format string for printf, %s will be replaced by the link text.
-If you want to make sure that your link is always properly terminated,
-include angle brackets into this format, like \"<%s>\". Some people also
-recommend an additional URL: prefix, so the format would be \"<URL:%s>\"."
+The recommended value is just \"%s\", since links will be protected by
+enclosing them in double brackets. If you prefer plain links (see variable
+`org-link-style'), \"<%s>\" is useful. Some people also recommend an
+additional URL: prefix, so the format would be \"<URL:%s>\"."
:group 'org-link
:type '(choice
(const :tag "\"%s\" (e.g. http://www.there.com)" "%s")
(const :tag "\"<URL:%s>\" (e.g. <URL:http://www.there.com>)" "<URL:%s>")
(string :tag "Other" :value "<%s>")))
-(defcustom org-allow-space-in-links t
- "Non-nil means, file names in links may contain space characters.
-When nil, it becomes possible to put several links into a line.
-Note that in tables, a link never extends accross fields, so in a table
-it is always possible to put several links into a line.
-Changing this varable requires a re-launch of Emacs of become effective."
+(defcustom org-activate-links '(bracket angle plain radio tag date)
+ "Types of links that should be activated in Org-mode files.
+This is a list of symbols, each leading to the activation of a certain link
+type. In principle, it does not hurt to turn on most link types - there may
+be a small gain when turning off unused link types. The types are:
+
+bracket The recommended [[link][description]] or [[link]] links with hiding.
+angular Links in angular brackes that may contain whitespace like
+ <bbdb:Carsten Dominik>.
+plain Plain links in normal text, no whitespace, like http://google.com.
+radio Text that is matched by a radio target, see manual for details.
+tag Tag settings in a headline (link to tag search).
+date Time stamps (link to calendar).
+camel CamelCase words defining text searches.
+
+Changing this variable requires a restart of Emacs to become effective."
:group 'org-link
- :type 'boolean)
-
-(defcustom org-line-numbers-in-file-links t
- "Non-nil means, file links from `org-store-link' contain line numbers.
-The line number will be added to the file name with :NNN and interpreted
-by the command `org-open-at-point'.
+ :type '(set (const :tag "Double bracket links (new style)" bracket)
+ (const :tag "Angular bracket links (old style)" angular)
+ (const :tag "plain text links" plain)
+ (const :tag "Radio target matches" radio)
+ (const :tag "Tags" tag)
+ (const :tag "Timestamps" date)
+ (const :tag "CamelCase words" camel)))
+
+(defgroup org-link-store nil
+ "Options concerning storing links in Org-mode"
+ :tag "Org Store Link"
+ :group 'org-link)
+
+(defcustom org-context-in-file-links t
+ "Non-nil means, file links from `org-store-link' contain context.
+A search string will be added to the file name with :: as separator and
+used to find the context when the link is activated by the command
+`org-open-at-point'.
Using a prefix arg to the command \\[org-store-link] (`org-store-link')
negates this setting for the duration of the command."
- :group 'org-link
+ :group 'org-link-store
+ :type 'boolean)
+
+(defcustom org-file-link-context-use-camel-case nil
+ "Non-nil means, use CamelCase to store a search context in a file link.
+When nil, the search string simply consists of the words of the string.
+CamelCase is deprecated, and support for it may be dropped in the future."
+ :group 'org-link-store
:type 'boolean)
(defcustom org-keep-stored-link-after-insertion nil
option is nil, every link which has been inserted once using \\[org-insert-link]
will be removed from the list, to make completing the unused links
more efficient."
- :group 'org-link
+ :group 'org-link-store
+ :type 'boolean)
+
+(defcustom org-usenet-links-prefer-google nil
+ "Non-nil means, `org-store-link' will create web links to Google groups.
+When nil, Gnus will be used for such links.
+Using a prefix arg to the command \\[org-store-link] (`org-store-link')
+negates this setting for the duration of the command."
+ :group 'org-link-store
:type 'boolean)
+(defgroup org-link-follow nil
+ "Options concerning following links in Org-mode"
+ :tag "Org Follow Link"
+ :group 'org-link)
+
+(defcustom org-tab-follows-link nil
+ "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)
+
+(defcustom org-mark-ring-length 4
+ "Number of different positions to be recorded in the ring
+Changing this requires a restart of Emacs to work correctly."
+ :group 'org-link-follow
+ :type 'interger)
+
(defcustom org-link-frame-setup
'((vm . vm-visit-folder-other-frame)
(gnus . gnus-other-frame)
For the calendar, use the variable `calendar-setup'.
For BBDB, it is currently only possible to display the matches in
another window."
- :group 'org-link
+ :group 'org-link-follow
:type '(list
(cons (const vm)
(choice
(const find-file-other-window)
(const find-file-other-frame)))))
-(defcustom org-usenet-links-prefer-google nil
- "Non-nil means, `org-store-link' will create web links to google groups.
-When nil, Gnus will be used for such links.
-Using a prefix arg to the command \\[org-store-link] (`org-store-link')
-negates this setting for the duration of the command."
- :group 'org-link
- :type 'boolean)
-
(defcustom org-open-non-existing-files nil
"Non-nil means, `org-open-file' will open non-existing file.
When nil, an error will be generated."
- :group 'org-link
+ :group 'org-link-follow
:type 'boolean)
-(defcustom org-confirm-shell-links t
+(defcustom org-confirm-shell-links 'yes-or-no-p
"Non-nil means, ask for confirmation before executing shell links.
-The default is true, to keep new users from shooting into their own foot."
- :group 'org-link
- :type 'boolean)
+Shell links can be dangerous, just thing about a link
+
+ [[shell:rm -rf ~/*][Google Search]]
+
+This link would show up in your Org-mode document as \"Google Search\"
+but really it would remove your entire home directory. Dangerous indeed.
+Therefore I *definitely* advise agains setting this varaiable to nil.
+Just change it to `y-or-n-p' of you want to confirm with a single key press
+rather than having to type \"yes\"."
+ :group 'org-link-follow
+ :type '(choice
+ (const :tag "with yes-or-no (safer)" yes-or-no-p)
+ (const :tag "with y-or-n (faster)" y-or-n-p)
+ (const :tag "no confirmation (dangerous)" nil)))
(defconst org-file-apps-defaults-gnu
- '((t . emacs)
- ("jpg" . "xv %s")
- ("gif" . "xv %s")
- ("ppm" . "xv %s")
- ("pgm" . "xv %s")
- ("pbm" . "xv %s")
- ("tif" . "xv %s")
- ("png" . "xv %s")
- ("ps" . "gv %s")
- ("ps.gz" . "gv %s")
- ("eps" . "gv %s")
- ("eps.gz" . "gv %s")
- ("dvi" . "xdvi %s")
- ("mpeg" . "plaympeg %s")
- ("mp3" . "plaympeg %s")
- ("fig" . "xfig %s")
- ("pdf" . "acroread %s")
- ("doc" . "soffice %s")
- ("ppt" . "soffice %s")
- ("pps" . "soffice %s")
- ("html" . "netscape -remote openURL(%s,new-window)")
- ("htm" . "netscape -remote openURL(%s,new-window)")
- ("xs" . "soffice %s"))
- "Default file applications on a UNIX/LINUX system.
+ '((t . mailcap))
+ "Default file applications on a UNIX or GNU/Linux system.
See `org-file-apps'.")
(defconst org-file-apps-defaults-macosx
`org-file-apps-defaults-macosx'
`org-file-apps-defaults-windowsnt'
`org-file-apps-defaults-gnu'."
- :group 'org-link
+ :group 'org-link-follow
:type '(repeat
- (cons (string :tag "Extension")
+ (cons (choice :value ""
+ (string :tag "Extension")
+ (const :tag "Default for unrecognized files" t)
+ (const :tag "Links to a directory" directory))
(choice :value ""
- (const :tag "Visit with Emacs" 'emacs)
- (const :tag "Use system default" 'default)
- (string :tag "Command")
- (sexp :tag "Lisp form")))))
-
+ (const :tag "Visit with Emacs" emacs)
+ (const :tag "Use system default" default)
+ (string :tag "Command")
+ (sexp :tag "Lisp form")))))
+
+(defcustom org-mhe-search-all-folders nil
+ "Non-nil means, that the search for the mh-message will be extended to
+all folders if the message cannot be found in the folder given in the link.
+Searching all folders is very effective with one of the search engines
+supported by MH-E, but will be slow with pick."
+ :group 'org-link-follow
+ :type 'boolean)
(defgroup org-remember nil
"Options concerning interaction with remember.el."
(const :tag "Default from remember-data-file" nil)
file))
+(defcustom org-remember-templates nil
+ "Templates for the creation of remember buffers.
+When nil, just let remember make the buffer.
+When not nil, this is a list of 3-element lists. In each entry, the first
+element is a character, a unique key to select this template.
+The second element is the template. The third element is optional and can
+specify a destination file for remember items created with this template.
+The default file is given by `org-default-notes-file'.
+
+The template specifies the structure of the remember buffer. It should have
+a first line starting with a star, to act as the org-mode headline.
+Furthermore, the following %-escapes will be replaced with content:
+ %t time stamp, date only
+ %T time stamp with date and time
+ %u inactive time stamp, date only
+ %U inactive time stamp with date and time
+ %n user name
+ %a annotation, normally the link created with org-store-link
+ %i initial content, the region when remember is called with C-u.
+ If %i is indented, the entire inserted text will be indented as well.
+ %? This will be removed, and the cursor placed at this position."
+ :group 'org-remember
+ :type '(repeat :tag "enabled"
+ (list :value (?a "\n" nil)
+ (character :tag "Selection Key")
+ (string :tag "Template")
+ (file :tag "Destination file (optional)"))))
+
(defcustom org-reverse-note-order nil
"Non-nil means, store new notes at the beginning of a file or entry.
When nil, new notes will be filed to the end of a file or entry."
(repeat :tag "By file name regexp"
(cons regexp boolean))))
-(defgroup org-table nil
- "Options concerning tables in Org-mode."
- :tag "Org Table"
+(defgroup org-todo nil
+ "Options concerning TODO items in Org-mode."
+ :tag "Org TODO"
:group 'org)
-(defcustom org-enable-table-editor 'optimized
- "Non-nil means, lines starting with \"|\" are handled by the table editor.
-When nil, such lines will be treated like ordinary lines.
+(defcustom org-todo-keywords '("TODO" "DONE")
+ "List of TODO entry keywords.
+\\<org-mode-map>By default, this is '(\"TODO\" \"DONE\"). The last entry in the list is
+considered to mean that the entry is \"done\". All the other mean that
+action is required, and will make the entry show up in todo lists, diaries
+etc.
+The command \\[org-todo] cycles an entry through these states, and an
+additional state where no keyword is present. For details about this
+cycling, see also the variable `org-todo-interpretation'
+Changes become only effective after restarting Emacs."
+ :group 'org-todo
+ :group 'org-keywords
+ :type '(repeat (string :tag "Keyword")))
-When equal to the symbol `optimized', the table editor will be optimized to
-do the following
-- Use automatic overwrite mode in front of whitespace in table fields.
- This make the structure of the table stay in tact as long as the edited
- field does not exceed the column width.
-- Minimize the number of realigns. Normally, the table is aligned each time
- TAB or RET are pressed to move to another field. With optimization this
- happens only if changes to a field might have changed the column width.
-Optimization requires replacing the functions `self-insert-command',
-`delete-char', and `backward-delete-char' in Org-mode buffers, with a
-slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
-very good at guessing when a re-align will be necessary, but you can always
-force one with \\[org-ctrl-c-ctrl-c].
+(defcustom org-todo-interpretation 'sequence
+ "Controls how TODO keywords are interpreted.
+This variable is only relevant if `org-todo-keywords' contains more than two
+states. \\<org-mode-map>Possible values are `sequence' and `type'.
+
+When `sequence', \\[org-todo] will always switch to the next state in the
+`org-todo-keywords' list. When `type', \\[org-todo] only cycles from state
+to state when executed several times in direct succession. Otherwise, it
+switches directly to DONE from any state.
+See the manual for more information."
+ :group 'org-todo
+ :group 'org-keywords
+ :type '(choice (const sequence)
+ (const type)))
-If you would like to use the optimized version in Org-mode, but the
-un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
+(defcustom org-after-todo-state-change-hook nil
+ "Hook which is run after the state of a TODO item was changed.
+The new state (a string with a TODO keyword, or nil) is available in the
+Lisp variable `state'."
+ :group 'org-todo
+ :type 'hook)
-This variable can be used to turn on and off the table editor during a session,
-but in order to toggle optimization, a restart is required.
+(defcustom org-log-done nil
+ "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
+When the state of an entry is changed from nothing to TODO, remove a previous
+closing date."
+ :group 'org-todo
+ :type 'boolean)
-See also the variable `org-table-auto-blank-field'."
- :group 'org-table
- :type '(choice
- (const :tag "off" nil)
- (const :tag "on" t)
- (const :tag "on, optimized" optimized)))
+(defgroup org-priorities nil
+ "Keywords in Org-mode."
+ :tag "Org Priorities"
+ :group 'org-todo)
-(defcustom org-table-auto-blank-field t
- "Non-nil means, automatically blank table field when starting to type into it.
-This only happens when typing immediately after a field motion
-command (TAB, S-TAB or RET).
-Only relevant when `org-enable-table-editor' is equal to `optimized'."
- :group 'org-table
+(defcustom org-default-priority ?B
+ "The default priority of TODO items.
+This is the priority an item get if no explicit priority is given."
+ :group 'org-priorities
+ :type 'character)
+
+(defcustom org-lowest-priority ?C
+ "The lowest priority of TODO items. A character like ?A, ?B etc."
+ :group 'org-priorities
+ :type 'character)
+
+(defgroup org-time nil
+ "Options concerning time stamps and deadlines in Org-mode."
+ :tag "Org Time"
+ :group 'org)
+
+(defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
+ "Formats for `format-time-string' which are used for time stamps.
+It is not recommended to change this constant.")
+
+(defcustom org-time-stamp-rounding-minutes 0
+ "Number of minutes to round time stamps to upon insertion.
+When zero, insert the time unmodified. Useful rounding numbers
+should be factors of 60, so for example 5, 10, 15.
+When this is not zero, you can still force an exact time-stamp by using
+a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
+ :group 'org-time
+ :type 'integer)
+
+(defcustom org-deadline-warning-days 30
+ "No. of days before expiration during which a deadline becomes active.
+This variable governs the display in the org file."
+ :group 'org-time
+ :type 'number)
+
+(defcustom org-popup-calendar-for-date-prompt t
+ "Non-nil means, pop up a calendar when prompting for a date.
+In the calendar, the date can be selected with mouse-1. However, the
+minibuffer will also be active, and you can simply enter the date as well.
+When nil, only the minibuffer will be available."
+ :group 'org-time
:type 'boolean)
-(defcustom org-table-default-size "5x2"
- "The default size for newly created tables, Columns x Rows."
- :group 'org-table
- :type 'string)
+(defcustom org-calendar-follow-timestamp-change t
+ "Non-nil means, make the calendar window follow timestamp changes.
+When a timestamp is modified and the calendar window is visible, it will be
+moved to the new date."
+ :group 'org-time
+ :type 'boolean)
-(defcustom org-table-automatic-realign t
- "Non-nil means, automatically re-align table when pressing TAB or RETURN.
-When nil, aligning is only done with \\[org-table-align], or after column
-removal/insertion."
- :group 'org-table
+(defgroup org-tags nil
+ "Options concerning startup of Org-mode."
+ :tag "Org Tags"
+ :group 'org)
+
+(defcustom org-tags-column 48
+ "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,
+-79 works well for a normal 80 character screen."
+ :group 'org-tags
+ :type 'integer)
+
+(defcustom org-auto-align-tags t
+ "Non-nil means, realign tags after pro/demotion of TODO state change.
+These operations change the length of a headline and therefore shift
+the tags around. With this options turned on, after each such operation
+the tags are again aligned to `org-tags-column'."
+ :group 'org-tags
:type 'boolean)
-(defcustom org-table-spaces-around-separators '(1 . 1)
- "The number of spaces to be placed before and after separators."
- :group 'org-table
- :type '(cons (number :tag "Before \"|\"") (number :tag " After \"|\"")))
+(defcustom org-use-tag-inheritance t
+ "Non-nil means, tags in levels apply also for sublevels.
+When nil, only the tags directly given in a specific line apply there.
+If you turn off this option, you very likely want to turn on the
+companion option `org-tags-match-list-sublevels'."
+ :group 'org-tags
+ :type 'boolean)
-(defcustom org-table-spaces-around-invisible-separators '(1 . 2)
- "The number of spaces to be placed before and after separators.
-This option applies when the column separators have been made invisible."
- :group 'org-table
- :type '(cons (number :tag "Before \"|\"") (number :tag " After \"|\"")))
+(defcustom org-tags-match-list-sublevels nil
+ "Non-nil means list also sublevels of headlines matching tag search.
+Because of tag inheritance (see variable `org-use-tag-inheritance'),
+the sublevels of a headline matching a tag search often also match
+the same search. Listing all of them can create very long lists.
+Setting this variable to nil causes subtrees of a match to be skipped.
+This option is off by default, because inheritance in on. If you turn
+inheritance off, you very likely want to turn this option on.
+
+As a special case, if the tag search is restricted to TODO items, the
+value of this variable is ignored and sublevels are always checked, to
+make sure all corresponding TODO items find their way into the list."
+ :group 'org-tags
+ :type 'boolean)
-(defcustom org-table-number-regexp "^[<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*$"
- "Regular expression for recognizing numbers in table columns.
-If a table column contains mostly numbers, it will be aligned to the
-right. If not, it will be aligned to the left.
+(defvar org-tags-history nil
+ "History of minibuffer reads for tags.")
+(defvar org-last-tags-completion-table nil
+ "The last used completion table for tags.")
-The default value of this option is a regular expression which allows
-anything which looks remotely like a number as used in scientific
-context. For example, all of the following will be considered a
-number:
- 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
+(defgroup org-agenda nil
+ "Options concerning agenda display Org-mode."
+ :tag "Org Agenda"
+ :group 'org)
-Other options offered by the customize interface are more restrictive."
- :group 'org-table
+(defvar org-category nil
+ "Variable used by org files to set a category for agenda display.
+Such files should use a file variable to set it, for example
+
+ -*- mode: org; org-category: \"ELisp\"
+
+or contain a special line
+
+#+CATEGORY: ELisp
+
+If the file does not specify a category, then file's base name
+is used instead.")
+(make-variable-buffer-local 'org-category)
+
+(defcustom org-agenda-files nil
+ "The files to be used for agenda display.
+Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
+\\[org-remove-file]. You can also use customize to edit the list.
+
+If the value of the variable is not a list but a single file name, then
+the list of agenda files is actually stored and maintained in that file, one
+agenda file per line."
+ :group 'org-agenda
:type '(choice
- (const :tag "Positive Integers"
- "^[0-9]+$")
- (const :tag "Integers"
- "^[-+]?[0-9]+$")
- (const :tag "Floating Point Numbers"
- "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.[0-9]*\\)$")
- (const :tag "Floating Point Number or Integer"
- "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.?[0-9]*\\)$")
- (const :tag "Exponential, Floating point, Integer"
- "^[-+]?[0-9.]+\\([eEdD][-+0-9]+\\)?$")
- (const :tag "Very General Number-Like"
- "^[<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*$")
- (string :tag "Regexp:")))
+ (repeat :tag "List of files" file)
+ (file :tag "Store list in a file\n" :value "~/.agenda_files")))
+
+(defcustom org-agenda-custom-commands '(("w" todo "WAITING"))
+ "Custom commands for the agenda.
+These commands will be offered on the splash screen displayed by the
+agenda dispatcher \\[org-agenda]. Each entry is a list of 3 items:
+
+key The key (a single char as a string) to be associated with the command.
+type The command type, any of the following symbols:
+ todo Entries with a specific TODO keyword, in all agenda files.
+ tags Tags match in all agenda files.
+ todo-tree Sparse tree of specific TODO keyword in *current* file.
+ tags-tree Sparse tree with all tags matches in *current* file.
+ occur-tree Occur sparse tree for current file.
+match What to search for:
+ - a single keyword for TODO keyword searches
+ - a tags match expression for tags searches
+ - a regular expression for occur searches"
+ :group 'org-agenda
+ :type '(repeat
+ (list (string :tag "Key")
+ (choice :tag "Type"
+ (const :tag "Tags search in all agenda files" tags)
+ (const :tag "TODO keyword search in all agenda files" todo)
+ (const :tag "Tags sparse tree in current buffer" tags-tree)
+ (const :tag "TODO keyword tree in current buffer" todo-tree)
+ (const :tag "Occur tree in current buffer" occur-tree))
+ (string :tag "Match"))))
-(defcustom org-table-number-fraction 0.5
- "Fraction of numbers in a column required to make the column align right.
-In a column all non-white fields are considered. If at least this
-fraction of fields is matched by `org-table-number-fraction',
-alignment to the right border applies."
- :group 'org-table
- :type 'number)
+(defcustom org-agenda-include-all-todo t
+ "Non-nil means, the agenda will always contain all TODO entries.
+When nil, date-less entries will only be shown if `org-agenda' is called
+with a prefix argument.
+When non-nil, the TODO entries will be listed at the top of the agenda, before
+the entries for specific days."
+ :group 'org-agenda
+ :type 'boolean)
-(defcustom org-export-highlight-first-table-line t
- "Non-nil means, highlight the first table line.
-In HTML export, this means use <th> instead of <td>.
-In tables created with table.el, this applies to the first table line.
-In Org-mode tables, all lines before the first horizontal separator
-line will be formatted with <th> tags."
- :group 'org-table
+(defcustom org-agenda-include-diary nil
+ "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
+ :group 'org-agenda
:type 'boolean)
-(defcustom org-table-tab-recognizes-table.el t
- "Non-nil means, TAB will automatically notice a table.el table.
-When it sees such a table, it moves point into it and - if necessary -
-calls `table-recognize-table'."
- :group 'org-table
+(defcustom org-calendar-to-agenda-key [?c]
+ "The key to be installed in `calendar-mode-map' for switching to the agenda.
+The command `org-calendar-goto-agenda' will be bound to this key. The
+default is the character `c' because then `c' can be used to switch back and
+forth between agenda and calendar."
+ :group 'org-agenda
+ :type 'sexp)
+
+(defgroup org-agenda-window-setup nil
+ "Options concerning setting up the Agenda window in Org Mode."
+ :tag "Org Agenda Window Setup"
+ :group 'org-agenda)
+
+(defcustom org-select-timeline-window t
+ "Non-nil means, after creating a timeline, move cursor into Timeline window.
+When nil, cursor will remain in the current window."
+ :group 'org-agenda-window-setup
:type 'boolean)
-(defgroup org-table-calculation nil
- "Options concerning tables in Org-mode."
- :tag "Org Table Calculation"
- :group 'org)
+(defcustom org-select-agenda-window t
+ "Non-nil means, after creating an agenda, move cursor into Agenda window.
+When nil, cursor will remain in the current window."
+ :group 'org-agenda-window-setup
+ :type 'boolean)
-(defcustom org-table-copy-increment t
- "Non-nil means, increment when copying current field with \\[org-table-copy-down]."
- :group 'org-table-calculation
+(defcustom org-fit-agenda-window t
+ "Non-nil means, change window size of agenda to fit content."
+ :group 'org-agenda-window-setup
:type 'boolean)
-(defcustom org-calc-default-modes
- '(calc-internal-prec 12
- calc-float-format (float 5)
- calc-angle-mode deg
- calc-prefer-frac nil
- calc-symbolic-mode nil
- calc-date-format (YYYY "-" MM "-" DD " " Www (" " HH ":" mm))
- calc-display-working-message t
- )
- "List with Calc mode settings for use in calc-eval for table formulas.
-The list must contain alternating symbols (calc modes variables and values.
-Don't remove any of the default settings, just change the values. Org-mode
-relies on the variables to be present in the list."
- :group 'org-table-calculation
- :type 'plist)
+(defgroup org-agenda-display nil
+ "Options concerning what to display initially in Agenda."
+ :tag "Org Agenda Display"
+ :group 'org-agenda)
-(defcustom org-table-formula-evaluate-inline t
- "Non-nil means, TAB and RET evaluate a formula in current table field.
-If the current field starts with an equal sign, it is assumed to be a formula
-which should be evaluated as described in the manual and in the documentation
-string of the command `org-table-eval-formula'. This feature requires the
-Emacs calc package.
-When this variable is nil, formula calculation is only available through
-the command \\[org-table-eval-formula]."
- :group 'org-table-calculation
+(defcustom org-agenda-show-all-dates t
+ "Non-nil means, `org-agenda' shows every day in the selected range.
+When nil, only the days which actually have entries are shown."
+ :group 'org-agenda-display
:type 'boolean)
+(defcustom org-agenda-start-on-weekday 1
+ "Non-nil means, start the overview always on the specified weekday.
+0 denotes Sunday, 1 denotes Monday etc.
+When nil, always start on the current day."
+ :group 'org-agenda-display
+ :type '(choice (const :tag "Today" nil)
+ (number :tag "Weekday No.")))
-(defcustom org-table-formula-use-constants t
- "Non-nil means, interpret constants in formulas in tables.
-A constant looks like `$c' or `$Grav' and will be replaced before evaluation
-by the value given in `org-table-formula-constants', or by a value obtained
-from the `constants.el' package."
- :group 'org-table-calculation
+(defcustom org-agenda-ndays 7
+ "Number of days to include in overview display.
+Should be 1 or 7."
+ :group 'org-agenda-display
+ :type 'number)
+
+(defcustom org-agenda-use-time-grid t
+ "Non-nil means, show a time grid in the agenda schedule.
+A time grid is a set of lines for specific times (like every two hours between
+8:00 and 20:00). The items scheduled for a day at specific times are
+sorted in between these lines.
+For details about when the grid will be shown, and what it will look like, see
+the variable `org-agenda-time-grid'."
+ :group 'org-agenda-display
:type 'boolean)
-(defcustom org-table-formula-constants nil
- "Alist with constant names and values, for use in table formulas.
-The car of each element is a name of a constant, without the `$' before it.
-The cdr is the value as a string. For example, if you'd like to use the
-speed of light in a formula, you would configure
+(defcustom org-agenda-time-grid
+ '((daily today require-timed)
+ "----------------"
+ (800 1000 1200 1400 1600 1800 2000))
- (setq org-table-formula-constants '((\"c\" . \"299792458.\")))
+ "The settings for time grid for agenda display.
+This is a list of three items. The first item is again a list. It contains
+symbols specifying conditions when the grid should be displayed:
+
+ daily if the agenda shows a single day
+ weekly if the agenda shows an entire week
+ today show grid on current date, independent of daily/weekly display
+ require-timed show grid only if at least on item has a time specification
+
+The second item is a string which will be places behing the grid time.
+
+The third item is a list of integers, indicating the times that should have
+a grid line."
+ :group 'org-agenda-display
+ :type
+ '(list
+ (set :greedy t :tag "Grid Display Options"
+ (const :tag "Show grid in single day agenda display" daily)
+ (const :tag "Show grid in weekly agenda display" weekly)
+ (const :tag "Always show grid for today" today)
+ (const :tag "Show grid only if any timed entries are present"
+ require-timed)
+ (const :tag "Skip grid times already present in an entry"
+ remove-match))
+ (string :tag "Grid String")
+ (repeat :tag "Grid Times" (integer :tag "Time"))))
+
+(defcustom org-agenda-sorting-strategy '(time-up category-keep priority-down)
+ "Sorting structure for the agenda items of a single day.
+This is a list of symbols which will be used in sequence to determine
+if an entry should be listed before another entry. The following
+symbols are recognized:
+
+time-up Put entries with time-of-day indications first, early first
+time-down Put entries with time-of-day indications first, late first
+category-keep Keep the default order of categories, corresponding to the
+ sequence in `org-agenda-files'.
+category-up Sort alphabetically by category, A-Z.
+category-down Sort alphabetically by category, Z-A.
+priority-up Sort numerically by priority, high priority last.
+priority-down Sort numerically by priority, high priority first.
+
+The different possibilities will be tried in sequence, and testing stops
+if one comparison returns a \"not-equal\". For example, the default
+ '(time-up category-keep priority-down)
+means: Pull out all entries having a specified time of day and sort them,
+in order to make a time schedule for the current day the first thing in the
+agenda listing for the day. Of the entries without a time indication, keep
+the grouped in categories, don't sort the categories, but keep them in
+the sequence given in `org-agenda-files'. Within each category sort by
+priority.
+
+Leaving out `category-keep' would mean that items will be sorted across
+categories by priority."
+ :group 'org-agenda-display
+ :type '(repeat
+ (choice
+ (const time-up)
+ (const time-down)
+ (const category-keep)
+ (const category-up)
+ (const category-down)
+ (const priority-up)
+ (const priority-down))))
+
+(defcustom org-sort-agenda-notime-is-late t
+ "Non-nil means, items without time are considered late.
+This is only relevant for sorting. When t, items which have no explicit
+time like 15:30 will be considered as 24:01, i.e. later than any items which
+do have a time. When nil, the default time is before 0:00. You can use this
+option to decide if the schedule for today should come before or after timeless
+agenda entries."
+ :group 'org-agenda-display
+ :type 'boolean)
+
+
+(defgroup org-agenda-prefix nil
+ "Options concerning the entry prefix in the Org-mode agenda display."
+ :tag "Org Agenda Prefix"
+ :group 'org-agenda)
+
+(defcustom org-agenda-prefix-format " %-12:c%?-12t% s"
+ "Format specification for the prefix of items in the agenda buffer.
+This format works similar to a printf format, with the following meaning:
+
+ %c the category of the item, \"Diary\" for entries from the diary, or
+ as given by the CATEGORY keyword or derived from the file name.
+ %T the first tag of the item.
+ %t the time-of-day specification if one applies to the entry, in the
+ format HH:MM
+ %s Scheduling/Deadline information, a short string
+
+All specifiers work basically like the standard `%s' of printf, but may
+contain two additional characters: A question mark just after the `%' and
+a whitespace/punctuation character just before the final letter.
+
+If the first character after `%' is a question mark, the entire field
+will only be included if the corresponding value applies to the
+current entry. This is useful for fields which should have fixed
+width when present, but zero width when absent. For example,
+\"%?-12t\" will result in a 12 character time field if a time of the
+day is specified, but will completely disappear in entries which do
+not contain a time.
+
+If there is punctuation or whitespace character just before the final
+format letter, this character will be appended to the field value if
+the value is not empty. For example, the format \"%-12:c\" leads to
+\"Diary: \" if the category is \"Diary\". If the category were be
+empty, no additional colon would be interted.
+
+The default value of this option is \" %-12:c%?-12t% s\", meaning:
+- Indent the line with two space characters
+- Give the category in a 12 chars wide field, padded with whitespace on
+ the right (because of `-'). Append a colon if there is a category
+ (because of `:').
+- If there is a time-of-day, put it into a 12 chars wide field. If no
+ time, don't put in an empty field, just skip it (because of '?').
+- Finally, put the scheduling information and append a whitespace.
+
+As another example, if you don't want the time-of-day of entries in
+the prefix, you could use:
+
+ (setq org-agenda-prefix-format \" %-11:c% s\")
+
+See also the variables `org-agenda-remove-times-when-in-prefix' and
+`org-agenda-remove-tags-when-in-prefix'."
+ :type 'string
+ :group 'org-agenda-prefix)
+
+(defcustom org-timeline-prefix-format " % s"
+ "Like `org-agenda-prefix-format', but for the timeline of a single file."
+ :type 'string
+ :group 'org-agenda-prefix)
-and then use it in an equation like `$1*$c'."
- :group 'org-table-calculation
- :type '(repeat
- (cons (string :tag "name")
- (string :tag "value"))))
+(defvar org-prefix-format-compiled nil
+ "The compiled version of the most recently used prefix format.
+Depending on which command was used last, this may be the compiled version
+of `org-agenda-prefix-format' or `org-timeline-prefix-format'.")
-(defcustom org-table-formula-numbers-only nil
- "Non-nil means, calculate only with numbers in table formulas.
-Then all input fields will be converted to a number, and the result
-must also be a number. When nil, calc's full potential is available
-in table calculations, including symbolics etc."
- :group 'org-table-calculation
- :type 'boolean)
+;; FIXME: There seem to be situations where this does no work.
+(defcustom org-agenda-remove-times-when-in-prefix t
+ "Non-nil means, remove duplicate time specifications in agenda items.
+When the format `org-agenda-prefix-format' contains a `%t' specifier, a
+time-of-day specification in a headline or diary entry is extracted and
+placed into the prefix. If this option is non-nil, the original specification
+\(a timestamp or -range, or just a plain time(range) specification like
+11:30-4pm) will be removed for agenda display. This makes the agenda less
+cluttered.
+The option can be t or nil. It may also be the symbol `beg', indicating
+that the time should only be removed what it is located at the beginning of
+the headline/diary entry."
+ :group 'org-agenda-prefix
+ :type '(choice
+ (const :tag "Always" t)
+ (const :tag "Never" nil)
+ (const :tag "When at beginning of entry" beg)))
-(defcustom org-table-allow-automatic-line-recalculation t
- "Non-nil means, lines makred with |#| or |*| will be recomputed automatically.
-Automatically means, when TAB or RET or C-c C-c are pressed in the line."
- :group 'org-table-calculation
- :type 'boolean)
+(defcustom org-agenda-remove-tags-when-in-prefix nil
+ "Non-nil means, remove the tags from the headline copy in the agenda.
+When this is the symbol `prefix', only remove tags when
+`org-agenda-prefix-format' contains a `%T' specifier."
+ :group 'org-agenda-prefix
+ :type '(choice
+ (const :tag "Always" t)
+ (const :tag "Never" nil)
+ (const :tag "When prefix format contains %T" prefix)))
(defgroup org-export nil
"Options for exporting org-listings."
:tag "Org Export"
:group 'org)
+(defgroup org-export-general nil
+ "General options for exporting Org-mode files."
+ :tag "Org Export General"
+ :group 'org-export)
+
(defcustom org-export-language-setup
'(("en" "Author" "Date" "Table of Contents")
("da" "Ophavsmand" "Dato" "Indhold")
"Terms used in export text, translated to different languages.
Use the variable `org-export-default-language' to set the language,
or use the +OPTION lines for a per-file setting."
- :group 'org-export
+ :group 'org-export-general
:type '(repeat
(list
(string :tag "HTML language tag")
(defcustom org-export-default-language "en"
"The default language of HTML export, as a string.
-This should have an association in `org-export-language-setup'"
- :group 'org-export
+This should have an association in `org-export-language-setup'."
+ :group 'org-export-general
:type 'string)
(defcustom org-export-headline-levels 3
this setting.
This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
- :group 'org-export
+ :group 'org-export-general
:type 'number)
(defcustom org-export-with-section-numbers t
"Non-nil means, add section numbers to headlines when exporting.
This option can also be set with the +OPTIONS line, e.g. \"num:t\"."
- :group 'org-export
+ :group 'org-export-general
:type 'boolean)
(defcustom org-export-with-toc t
In HTML output, the TOC will be clickable.
This option can also be set with the +OPTIONS line, e.g. \"toc:nil\"."
- :group 'org-export
+ :group 'org-export-general
+ :type 'boolean)
+
+(defcustom org-export-mark-todo-in-toc nil
+ "Non-nil means, mark TOC lines that contain any open TODO items."
+ :group 'org-export-general
:type 'boolean)
(defcustom org-export-preserve-breaks nil
export, line breaks will always be preserved, regardless of this variable.
This option can also be set with the +OPTIONS line, e.g. \"\\n:t\"."
- :group 'org-export
+ :group 'org-export-general
:type 'boolean)
-(defcustom org-export-html-inline-images t
- "Non-nil means, inline images into exported HTML pages.
-The link will still be to the original location of the image file.
-So if you are moving the page, lets say to your public HTML site,
-you will have to move the image and maybe change the link."
- :group 'org-export
+(defgroup org-export-translation nil
+ "Options for translating special ascii sequences for the export backends."
+ :tag "Org Export Translation"
+ :group 'org-export)
+
+(defcustom org-export-with-emphasize t
+ "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
+If the export target supports emphasizing text, the word will be
+typeset in bold, italic, or underlined, respectively. Works only for
+single words, but you can say: I *really* *mean* *this*.
+Not all export backends support this.
+
+This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
+ :group 'org-export-translation
:type 'boolean)
-(defcustom org-export-html-expand t
- "Non-nil means, for HTML export, treat @<...> as HTML tag.
-When nil, these tags will be exported as plain text and therefore
-not be interpreted by a browser.
+(defcustom org-export-with-sub-superscripts t
+ "Non-nil means, interpret \"_\" and \"^\" for export.
+When this option is turned on, you can use TeX-like syntax for sub- and
+superscripts. Several characters after \"_\" or \"^\" will be
+considered as a single item - so grouping with {} is normally not
+needed. For example, the following things will be parsed as single
+sub- or superscripts.
-This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
- :group 'org-export
+ 10^24 or 10^tau several digits will be considered 1 item.
+ 10^-12 or 10^-tau a leading sign with digits or a word
+ x^2-y^3 will be read as x^2 - y^3, because items are
+ terminated by almost any nonword/nondigit char.
+ x_{i^2} or x^(2-i) braces or parenthesis do grouping.
+
+Still, ambiguity is possible - so when in doubt use {} to enclose the
+sub/superscript.
+Not all export backends support this, but HTML does.
+
+This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
+ :group 'org-export-translation
+ :type 'boolean)
+
+(defcustom org-export-with-TeX-macros t
+ "Non-nil means, interpret simple TeX-like macros when exporting.
+For example, HTML export converts \\alpha to α and \\AA to Å.
+No only real TeX macros will work here, but the standard HTML entities
+for math can be used as macro names as well. For a list of supported
+names in HTML export, see the constant `org-html-entities'.
+Not all export backends support this.
+
+This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
+ :group 'org-export-translation
:type 'boolean)
(defcustom org-export-with-fixed-width t
"Non-nil means, lines starting with \":\" will be in fixed width font.
This can be used to have pre-formatted text, fragments of code etc. For
-example
+example:
: ;; Some Lisp examples
: (while (defc cnt)
: (ding))
-will be looking just like this in also HTML. In ASCII export, this option
-has no effect.
+will be looking just like this in also HTML. See also the QUOTE keyword.
+Not all export backends support this.
This option can also be set with the +OPTIONS line, e.g. \"::nil\"."
- :group 'org-export
+ :group 'org-export-translation
:type 'boolean)
+(defcustom org-match-sexp-depth 3
+ "Number of stacked braces for sub/superscript matching.
+This has to be set before loading org.el to be effective."
+ :group 'org-export-translation
+ :type 'integer)
+
+(defgroup org-export-tables nil
+ "Options for exporting tables in Org-mode."
+ :tag "Org Export Tables"
+ :group 'org-export)
+
(defcustom org-export-with-tables t
"If non-nil, lines starting with \"|\" define a table.
For example:
|-------------+----------+-----------|
| Arthur Dent | England | 29.2.2100 |
-In ASCII export, this option has no effect.
+Not all export backends support this.
This option can also be set with the +OPTIONS line, e.g. \"|:nil\"."
- :group 'org-export
+ :group 'org-export-tables
+ :type 'boolean)
+
+(defcustom org-export-highlight-first-table-line t
+ "Non-nil means, highlight the first table line.
+In HTML export, this means use <th> instead of <td>.
+In tables created with table.el, this applies to the first table line.
+In Org-mode tables, all lines before the first horizontal separator
+line will be formatted with <th> tags."
+ :group 'org-export-tables
+ :type 'boolean)
+
+(defcustom org-export-table-remove-special-lines t
+ "Remove special lines and marking characters in calculating tables.
+This removes the special marking character column from tables that are set
+up for spreadsheet calculations. It also removes the entire lines
+marked with `!', `_', or `^'. The lines with `$' are kept, because
+the values of constants may be useful to have."
+ :group 'org-export-tables
:type 'boolean)
(defcustom org-export-prefer-native-exporter-for-tables nil
advantage, that the automatic HTML conversions for math symbols and
sub/superscripts can be applied. Org-mode's HTML generator is also
much faster."
- :group 'org-export
+ :group 'org-export-tables
:type 'boolean)
-(defcustom org-export-html-table-tag
- "<table border=1 cellspacing=0 cellpadding=6>"
- "The HTML tag used to start a table.
-This must be a <table> tag, but you may change the options like
-borders and spacing."
- :group 'org-export
- :type 'string)
-
-(defcustom org-export-with-emphasize t
- "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
-If the export target supports emphasizing text, the word will be
-typeset in bold, italic, or underlined, respectively. Works only for
-single words, but you can say: I *really* *mean* *this*.
-In ASCII export, this option has no effect.
+(defgroup org-export-ascii nil
+ "Options specific for ASCII export of Org-mode files."
+ :tag "Org Export ASCII"
+ :group 'org-export)
-This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
- :group 'org-export
+(defcustom org-export-ascii-show-new-buffer t
+ "Non-nil means, popup buffer containing the exported ASCII text.
+Otherwise the buffer will just be saved to a file and stay hidden."
+ :group 'org-export-ascii
:type 'boolean)
-(defcustom org-match-sexp-depth 3
- "Number of stacked braces for sub/superscript matching.
-This has to be set before loading org.el to be effective."
- :group 'org-export
- :type 'integer)
-
-;; FIXME: Should () parens be removed as well in sub/superscripts?
-(defcustom org-export-with-sub-superscripts t
- "Non-nil means, interpret \"_\" and \"^\" for export.
-When this option is turned on, you can use TeX-like syntax for sub- and
-superscripts. Several characters after \"_\" or \"^\" will be
-considered as a single item - so grouping with {} is normally not
-needed. For example, the following things will be parsed as single
-sub- or superscripts.
-
- 10^24 or 10^tau several digits will be considered 1 item
- 10^-12 or 10^-tau a leading sign with digits or a word
- x^2-y^3 will be read as x^2 - y^3, because items are
- terminated by almost any nonword/nondigit char.
- x_{i^2} or x^(2-i) braces or parenthesis do grouping.
+(defgroup org-export-xml nil
+ "Options specific for XML export of Org-mode files."
+ :tag "Org Export XML"
+ :group 'org-export)
-Still, ambiguity is possible - so when in doubt use {} to enclose the
-sub/superscript.
-In ASCII export, this option has no effect.
+(defcustom org-export-xml-type 'xoxo ;kw, if we have only one.
+ "The kind of XML to be produced by the XML exporter.
+Allowed values are:
+xoxo The XOXO exporter."
+ :group 'org-export-xml
+ :type '(choice
+ (const :tag "XOXO" xoxo)))
+
+(defgroup org-export-html nil
+ "Options specific for HTML export of Org-mode files."
+ :tag "Org Export HTML"
+ :group 'org-export)
+
+(defcustom org-export-html-style
+"<style type=\"text/css\">
+ html {
+ font-family: Times, serif;
+ font-size: 12pt;
+ }
+ .title { text-align: center; }
+ .todo, .deadline { color: red; }
+ .done { color: green; }
+ .target { background-color: lavender; }
+ pre {
+ border: 1pt solid #AEBDCC;
+ background-color: #F3F5F7;
+ padding: 5pt;
+ font-family: courier, monospace;
+ }
+ table { border-collapse: collapse; }
+ td, th {
+ vertical-align: top;
+ border: 1pt solid #ADB9CC;
+ }
+</style>"
+ "The default style specification for exported HTML files.
+Since there are different ways of setting style information, this variable
+needs to contain the full HTML structure to provide a style, including the
+surrounding HTML tags. The style specifications should include definitions
+for new classes todo, done, title, and deadline. For example, legal values
+would be:
+
+ <style type=\"text/css\">
+ p { font-weight: normal; color: gray; }
+ h1 { color: black; }
+ .title { text-align: center; }
+ .todo, .deadline { color: red; }
+ .done { color: green; }
+ </style>
+
+or, if you want to keep the style in a file,
+
+ <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
+
+As the value of this option simply gets inserted into the HTML <head> header,
+you can \"misuse\" it to add arbitrary text to the header."
+ :group 'org-export-html
+ :type 'string)
-This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
- :group 'org-export
+(defcustom org-export-html-inline-images t
+ "Non-nil means, inline images into exported HTML pages.
+The link will still be to the original location of the image file.
+So if you are moving the page, lets say to your public HTML site,
+you will have to move the image and maybe change the link."
+ :group 'org-export-html
:type 'boolean)
-(defcustom org-export-with-TeX-macros t
- "Non-nil means, interpret simple TeX-like macros when exporting.
-For example, HTML export converts \\alpha to α and \\AA to Å.
-No only real TeX macros will work here, but the standard HTML entities
-for math can be used as macro names as well. For a list of supported
-names in HTML export, see the constant `org-html-entities'.
-In ASCII export, this option has no effect.
+(defcustom org-export-html-expand t
+ "Non-nil means, for HTML export, treat @<...> as HTML tag.
+When nil, these tags will be exported as plain text and therefore
+not be interpreted by a browser.
-This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
- :group 'org-export
+This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
+ :group 'org-export-html
:type 'boolean)
+(defcustom org-export-html-table-tag
+ "<table border=1 cellspacing=0 cellpadding=6>"
+ "The HTML tag used to start a table.
+This must be a <table> tag, but you may change the options like
+borders and spacing."
+ :group 'org-export-html
+ :type 'string)
+
(defcustom org-export-html-with-timestamp nil
"If non-nil, write `org-export-html-html-helper-timestamp'
-into the exported html text. Otherwise, the buffer will just be saved
+into the exported HTML text. Otherwise, the buffer will just be saved
to a file."
- :group 'org-export
+ :group 'org-export-html
:type 'boolean)
(defcustom org-export-html-html-helper-timestamp
"<br><br><hr><p><!-- hhmts start --> <!-- hhmts end -->\n"
"The HTML tag used as timestamp delimiter for HTML-helper-mode."
- :group 'org-export
+ :group 'org-export-html
:type 'string)
-(defcustom org-export-ascii-show-new-buffer t
- "Non-nil means, popup buffer containing the exported ASCII text.
-Otherwise the buffer will just be saved to a file and stay hidden."
- :group 'org-export
- :type 'boolean)
-
(defcustom org-export-html-show-new-buffer nil
- "Non-nil means, popup buffer containing the exported html text.
+ "Non-nil means, popup buffer containing the exported html text.
Otherwise, the buffer will just be saved to a file and stay hidden."
- :group 'org-export
+ :group 'org-export-html
+ :type 'boolean)
+
+(defgroup org-export-icalendar nil
+ "Options specific for iCalendar export of Org-mode files."
+ :tag "Org Export iCalendar"
+ :group 'org-export)
+
+(defcustom org-combined-agenda-icalendar-file "~/org.ics"
+ "The file name for the iCalendar file covering all agenda files.
+This file is created with the command \\[org-export-icalendar-all-agenda-files]."
+ :group 'org-export-icalendar
+ :type 'file)
+
+(defcustom org-icalendar-include-todo nil
+ "Non-nil means, export to iCalendar files should also cover TODO items."
+ :group 'org-export-icalendar
+ :type 'boolean)
+
+(defcustom org-icalendar-combined-name "OrgMode"
+ "Calendar name for the combined iCalendar representing all agenda files."
+ :group 'org-export-icalendar
+ :type 'string)
+
+(defgroup org-font-lock nil
+ "Font-lock settings for highlighting in Org-mode."
+ :tag "Org Font Lock"
+ :group 'org)
+
+(defcustom org-level-color-stars-only nil
+ "Non-nil means fontify only the stars in each headline.
+When nil, the entire headline is fontified.
+Changing it requires restart of `font-lock-mode' to become effective
+also in regions already fontified."
+ :group 'org-font-lock
+ :type 'boolean)
+
+(defcustom org-hide-leading-stars nil
+ "Non-nil means, hide the first N-1 stars in a headline.
+This works by using the face `org-hide' for these stars. This
+face is white for a light background, and black for a dark
+background. You may have to customize the face `org-hide' to
+make this work.
+Changing it requires restart of `font-lock-mode' to become effective
+also in regions already fontified."
+ :group 'org-font-lock
+ :type 'boolean)
+
+(defcustom org-fontify-done-headline nil
+ "Non-nil means, change the face of a headline if it is marked DONE.
+Normally, only the TODO/DONE keyword indicates the state of a headline.
+When this is non-nil, the headline after the keyword is set to the
+`org-headline-done' as an additional indication."
+ :group 'org-font-lock
+ :type 'boolean)
+
+(defcustom org-fontify-emphasized-text t
+ "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
+Changing this variable requires a restart of Emacs to take effect."
+ :group 'org-font-lock
:type 'boolean)
(defgroup org-faces nil
- "Faces for highlighting in Org-mode."
+ "Faces in Org-mode."
:tag "Org Faces"
- :group 'org)
+ :group 'org-font-lock)
+
+(defface org-hide
+ '(
+ (((type tty) (class color)) (:foreground "white"))
+ (((class color) (background light)) (:foreground "white"))
+ (((class color) (background dark)) (:foreground "black"))
+ (t (:inverse-video nil)))
+ "Face used for level 1 headlines."
+ :group 'org-faces)
(defface org-level-1 ;; font-lock-function-name-face
'((((type tty) (class color)) (:foreground "blue" :weight bold))
(((class color) (background light)) (:foreground "RosyBrown"))
(((class color) (background dark)) (:foreground "LightSalmon"))
(t (:italic t)))
- "Face used for level 8 headlines."
+ "Face used for special keywords."
:group 'org-faces)
(defface org-warning ;; font-lock-warning-face
"Face for deadlines and TODO keywords."
:group 'org-faces)
-(defcustom org-fontify-done-headline nil
- "Non-nil means, change the face of a headline if it is marked DONE.
-Normally, only the TODO/DONE keyword indicates the state of a headline.
-When this is non-nil, the headline after the keyword is set to the
-`org-headline-done' as an additional indication."
- :group 'org-faces
- :type 'boolean)
-
(defface org-headline-done ;; font-lock-string-face
'((((type tty) (class color)) (:foreground "green"))
(((class color) (background light)) (:foreground "RosyBrown"))
`org-fontify-done-headline'."
:group 'org-faces)
-;; Inheritance does not yet work for xemacs. So we just copy...
+;; Inheritance does not work for xemacs. So we just copy...
(defface org-deadline-announce
'((((type tty) (class color)) (:foreground "blue" :weight bold))
(((class color) (background light)) (:foreground "Firebrick"))
(((class color) (background dark)) (:foreground "chocolate1"))
(t (:bold t :italic t)))
- "Face for items scheduled previously, and not yet done."
+ "Face for formulas."
:group 'org-faces)
(defface org-link
'((((type tty) (class color)) (:foreground "cyan" :weight bold))
- (((class color) (background light)) (:foreground "Purple"))
- (((class color) (background dark)) (:foreground "Cyan"))
+ (((class color) (background light)) (:foreground "Purple" :underline t))
+ (((class color) (background dark)) (:foreground "Cyan" :underline t))
(t (:bold t)))
"Face for links."
:group 'org-faces)
+(defface org-tag
+ '((((type tty) (class color)) (:weight bold))
+ (((class color) (background light)) (:weight bold))
+ (((class color) (background dark)) (:weight bold))
+ (t (:bold t)))
+ "Face for tags."
+ :group 'org-faces)
+
(defface org-done ;; font-lock-type-face
'((((type tty) (class color)) (:foreground "green"))
(((class color) (background light)) (:foreground "ForestGreen" :bold t))
(((class color) (background light)) (:foreground "DarkGoldenrod"))
(((class color) (background dark)) (:foreground "LightGoldenrod"))
(t (:bold t :italic t)))
- "Face used for level 2 headlines."
+ "Face used for time grids."
:group 'org-faces)
(defvar org-level-faces
- '(
- org-level-1
- org-level-2
- org-level-3
- org-level-4
- org-level-5
- org-level-6
- org-level-7
- org-level-8
+ '(org-level-1 org-level-2 org-level-3 org-level-4
+ org-level-5 org-level-6 org-level-7 org-level-8
))
(defvar org-n-levels (length org-level-faces))
+
+;; Variables for pre-computed regular expressions, all buffer local
+(defvar org-done-string nil
+ "The last string in `org-todo-keywords', indicating an item is DONE.")
+(make-variable-buffer-local 'org-done-string)
+(defvar org-todo-regexp nil
+ "Matches any of the TODO state keywords.")
+(make-variable-buffer-local 'org-todo-regexp)
+(defvar org-not-done-regexp nil
+ "Matches any of the TODO state keywords except the last one.")
+(make-variable-buffer-local 'org-not-done-regexp)
+(defvar org-todo-line-regexp nil
+ "Matches a headline and puts TODO state into group 2 if present.")
+(make-variable-buffer-local 'org-todo-line-regexp)
+(defvar org-nl-done-regexp nil
+ "Matches newline followed by a headline with the DONE keyword.")
+(make-variable-buffer-local 'org-nl-done-regexp)
+(defvar org-looking-at-done-regexp nil
+ "Matches the DONE keyword a point.")
+(make-variable-buffer-local 'org-looking-at-done-regexp)
+(defvar org-todo-kwd-priority-p nil
+ "Do TODO items have priorities?")
+(make-variable-buffer-local 'org-todo-kwd-priority-p)
+(defvar org-todo-kwd-max-priority nil
+ "Maximum priority of TODO items.")
+(make-variable-buffer-local 'org-todo-kwd-max-priority)
+(defvar org-ds-keyword-length 12
+ "Maximum length of the Deadline and SCHEDULED keywords.")
+(make-variable-buffer-local 'org-ds-keyword-length)
+(defvar org-deadline-regexp nil
+ "Matches the DEADLINE keyword.")
+(make-variable-buffer-local 'org-deadline-regexp)
+(defvar org-deadline-time-regexp nil
+ "Matches the DEADLINE keyword together with a time stamp.")
+(make-variable-buffer-local 'org-deadline-time-regexp)
+(defvar org-deadline-line-regexp nil
+ "Matches the DEADLINE keyword and the rest of the line.")
+(make-variable-buffer-local 'org-deadline-line-regexp)
+(defvar org-scheduled-regexp nil
+ "Matches the SCHEDULED keyword.")
+(make-variable-buffer-local 'org-scheduled-regexp)
+(defvar org-scheduled-time-regexp nil
+ "Matches the SCHEDULED keyword together with a time stamp.")
+(make-variable-buffer-local 'org-scheduled-time-regexp)
+
+(defun org-set-regexps-and-options ()
+ "Precompute regular expressions for current buffer."
+ (when (eq major-mode 'org-mode)
+ (let ((re (org-make-options-regexp
+ '("CATEGORY" "SEQ_TODO" "PRI_TODO" "TYP_TODO"
+ "STARTUP" "ARCHIVE")))
+ (splitre "[ \t]+")
+ kwds int key value cat arch)
+ (save-excursion
+ (save-restriction
+ (widen)
+ (goto-char (point-min))
+ (while (re-search-forward re nil t)
+ (setq key (match-string 1) value (match-string 2))
+ (cond
+ ((equal key "CATEGORY")
+ (if (string-match "[ \t]+$" value)
+ (setq value (replace-match "" t t value)))
+ (setq cat (intern value)))
+ ((equal key "SEQ_TODO")
+ (setq int 'sequence
+ kwds (append kwds (org-split-string value splitre))))
+ ((equal key "PRI_TODO")
+ (setq int 'priority
+ kwds (append kwds (org-split-string value splitre))))
+ ((equal key "TYP_TODO")
+ (setq int 'type
+ kwds (append kwds (org-split-string value splitre))))
+ ((equal key "STARTUP")
+ (let ((opts (org-split-string value splitre))
+ (set '(("fold" org-startup-folded t)
+ ("nofold" org-startup-folded nil)
+ ("content" org-startup-folded content)
+ ("hidestars" org-hide-leading-stars t)
+ ("showstars" org-hide-leading-stars nil)
+ ("odd" org-odd-levels-only t)
+ ("oddeven" org-odd-levels-only nil)
+ ("align" org-startup-align-all-tables t)
+ ("noalign" org-startup-align-all-tables nil)
+ ("dlcheck" org-startup-with-deadline-check t)
+ ("nodlcheck" org-startup-with-deadline-check nil)))
+ l var val)
+ (while (setq l (assoc (pop opts) set))
+ (setq var (nth 1 l) val (nth 2 l))
+ (set (make-local-variable var) val))))
+ ((equal key "ARCHIVE")
+ (string-match " *$" value)
+ (setq arch (replace-match "" t t value))
+ (remove-text-properties 0 (length arch)
+ '(face t fontified t) arch)))
+ )))
+ (and cat (set (make-local-variable 'org-category) cat))
+ (and kwds (set (make-local-variable 'org-todo-keywords) kwds))
+ (and arch (set (make-local-variable 'org-archive-location) arch))
+ (and int (set (make-local-variable 'org-todo-interpretation) int)))
+ ;; Compute the regular expressions and other local variables
+ (setq org-todo-kwd-priority-p (equal org-todo-interpretation 'priority)
+ org-todo-kwd-max-priority (1- (length org-todo-keywords))
+ org-ds-keyword-length (+ 2 (max (length org-deadline-string)
+ (length org-scheduled-string)))
+ org-done-string
+ (nth (1- (length org-todo-keywords)) org-todo-keywords)
+ org-todo-regexp
+ (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords
+ "\\|") "\\)\\>")
+ org-not-done-regexp
+ (concat "\\<\\("
+ (mapconcat 'regexp-quote
+ (nreverse (cdr (reverse org-todo-keywords)))
+ "\\|")
+ "\\)\\>")
+ org-todo-line-regexp
+ (concat "^\\(\\*+\\)[ \t]*\\("
+ (mapconcat 'regexp-quote org-todo-keywords "\\|")
+ "\\)? *\\(.*\\)")
+ org-nl-done-regexp
+ (concat "[\r\n]\\*+[ \t]+" org-done-string "\\>")
+ org-looking-at-done-regexp (concat "^" org-done-string "\\>")
+ org-deadline-regexp (concat "\\<" org-deadline-string)
+ org-deadline-time-regexp
+ (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
+ org-deadline-line-regexp
+ (concat "\\<\\(" org-deadline-string "\\).*")
+ org-scheduled-regexp
+ (concat "\\<" org-scheduled-string)
+ org-scheduled-time-regexp
+ (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
+ (org-set-font-lock-defaults)))
+
;; Tell the compiler about dynamically scoped variables,
;; and variables from other packages
-(eval-when-compile
- (defvar zmacs-regions)
- (defvar original-date)
- (defvar org-transient-mark-mode)
- (defvar org-old-auto-fill-inhibit-regexp)
- (defvar orgtbl-mode-menu)
- (defvar org-html-entities)
- (defvar org-goto-start-pos)
- (defvar org-cursor-color)
- (defvar org-time-was-given)
- (defvar org-ts-what)
- (defvar mark-active)
- (defvar timecnt)
- (defvar levels-open)
- (defvar title)
- (defvar author)
- (defvar email)
- (defvar text)
- (defvar entry)
- (defvar date)
- (defvar language)
- (defvar options)
- (defvar ans1)
- (defvar ans2)
- (defvar starting-day)
- (defvar include-all-loc)
- (defvar vm-message-pointer)
- (defvar vm-folder-directory)
- (defvar wl-summary-buffer-elmo-folder)
- (defvar wl-summary-buffer-folder-name)
- (defvar gnus-group-name)
- (defvar gnus-article-current)
- (defvar w3m-current-url)
- (defvar org-selected-point)
- (defvar calendar-mode-map)
- (defvar remember-save-after-remembering)
- (defvar remember-data-file))
-
-
+(defvar zmacs-regions) ; XEmacs regions
+(defvar original-date) ; dynamically scoped in calendar
+(defvar org-old-auto-fill-inhibit-regexp) ; local variable used by `orgtbl-mode'
+(defvar orgtbl-mode-menu) ; defined when orgtbl mode get initialized
+(defvar org-html-entities) ; defined later in this file
+(defvar org-goto-start-pos) ; dynamically scoped parameter
+(defvar org-time-was-given) ; dynamically scoped parameter
+(defvar org-ts-what) ; dynamically scoped parameter
+(defvar mark-active) ; Emacs only, not available in XEmacs.
+(defvar timecnt) ; dynamically scoped parameter
+(defvar levels-open) ; dynamically scoped parameter
+(defvar title) ; dynamically scoped parameter
+(defvar author) ; dynamically scoped parameter
+(defvar email) ; dynamically scoped parameter
+(defvar text) ; dynamically scoped parameter
+(defvar entry) ; dynamically scoped parameter
+(defvar date) ; dynamically scoped parameter
+(defvar language) ; dynamically scoped parameter
+(defvar options) ; dynamically scoped parameter
+(defvar ans1) ; dynamically scoped parameter
+(defvar ans2) ; dynamically scoped parameter
+(defvar starting-day) ; local variable
+(defvar include-all-loc) ; local variable
+(defvar vm-message-pointer) ; from vm
+(defvar vm-folder-directory) ; from vm
+(defvar wl-summary-buffer-elmo-folder) ; from wanderlust
+(defvar wl-summary-buffer-folder-name) ; from wanderlust
+(defvar gnus-group-name) ; from gnus
+(defvar gnus-article-current) ; from gnus
+(defvar w3m-current-url) ; from w3m
+(defvar mh-progs) ; from MH-E
+(defvar mh-current-folder) ; from MH-E
+(defvar mh-show-folder-buffer) ; from MH-E
+(defvar mh-index-folder) ; from MH-E
+(defvar mh-searcher) ; from MH-E
+(defvar org-selected-point) ; dynamically scoped parameter
+(defvar calendar-mode-map) ; from calendar.el
+(defvar last-arg) ; local variable
+(defvar remember-save-after-remembering) ; from remember.el
+(defvar remember-data-file) ; from remember.el
+(defvar annotation) ; from remember.el, dynamically scoped in `remember-mode'
+(defvar initial) ; from remember.el, dynamically scoped in `remember-mode'
+(defvar orgtbl-mode) ; defined later in this file
;;; Define the mode
(defvar org-mode-map (copy-keymap outline-mode-map)
"Keymap for Org-mode.")
-(defvar org-struct-menu)
-(defvar org-org-menu)
-(defvar org-tbl-menu)
+(defvar org-struct-menu) ; defined later in this file
+(defvar org-org-menu) ; defined later in this file
+(defvar org-tbl-menu) ; defined later in this file
;; We use a before-change function to check if a table might need
;; an update.
(defvar org-table-may-need-update t
- "Indicates of a table might need an update.
-This variable is set by `org-before-change-function'. `org-table-align'
-sets it back to nil.")
+ "Indicates that a table might need an update.
+This variable is set by `org-before-change-function'.
+`org-table-align' sets it back to nil.")
(defvar org-mode-hook nil)
(defvar org-inhibit-startup nil) ; Dynamically-scoped param.
+(defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
;;;###autoload
(define-derived-mode org-mode outline-mode "Org"
"Outline-based notes management and organizer, alias
-\"Carstens outline-mode for keeping track of everything.\"
+\"Carsten's outline-mode for keeping track of everything.\"
Org-mode develops organizational tasks around a NOTES file which
contains information about projects as plain text. Org-mode is
(easy-menu-add org-org-menu)
(easy-menu-add org-tbl-menu)
(org-install-agenda-files-menu)
+ (if org-descriptive-links (org-add-to-invisibility-spec '(org-link)))
+ (org-add-to-invisibility-spec '(org-cwidth))
(setq outline-regexp "\\*+")
- (if org-startup-truncated (setq truncate-lines t))
+ ;;(setq outline-regexp "\\(?:\\*+\\|[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\) \\)")
+ (setq outline-level 'org-outline-level)
+ (when (and org-ellipsis (stringp org-ellipsis))
+ (unless org-display-table
+ (setq org-display-table (make-display-table)))
+ (set-display-table-slot org-display-table
+ 4 (string-to-vector org-ellipsis))
+ (setq buffer-display-table org-display-table))
(org-set-regexps-and-options)
+ (if org-startup-truncated (setq truncate-lines t))
(set (make-local-variable 'font-lock-unfontify-region-function)
'org-unfontify-region)
;; Activate before-change-function
(set (make-local-variable 'org-table-may-need-update) t)
- (make-local-hook 'before-change-functions) ;; needed for XEmacs
- (add-hook 'before-change-functions 'org-before-change-function nil
- 'local)
- ;; Paragraph regular expressions
- (set (make-local-variable 'paragraph-separate) "\f\\|[ ]*$\\|\\([*\f]+\\)")
- (set (make-local-variable 'paragraph-start) "\f\\|[ ]*$\\|\\([*\f]+\\)")
- ;; Inhibit auto-fill for headers, tables and fixed-width lines.
- (set (make-local-variable 'auto-fill-inhibit-regexp)
- (concat "\\*\\|#"
- (if (or org-enable-table-editor org-enable-fixed-width-editor)
- (concat
- "\\|[ \t]*["
- (if org-enable-table-editor "|" "")
- (if org-enable-fixed-width-editor ":" "")
- "]"))))
- (set (make-local-variable 'fill-paragraph-function) 'org-fill-paragraph)
+ (org-add-hook 'before-change-functions 'org-before-change-function nil
+ 'local)
+ ;; Paragraphs and auto-filling
+ (org-set-autofill-regexps)
+ (org-update-radio-target-regexp)
;; Settings for Calc embedded mode
(set (make-local-variable 'calc-embedded-open-formula) "|\\|\n")
(set (make-local-variable 'calc-embedded-close-formula) "|\\|\n")
;; Get rid of Outline menus, they are not needed
;; Need to do this here because define-derived-mode sets up
;; the keymap so late.
- (if org-xemacs-p
+ (if (featurep 'xemacs)
(progn
(delete-menu-item '("Headings"))
(delete-menu-item '("Show"))
(define-key org-mode-map [menu-bar show] 'undefined))
(unless org-inhibit-startup
+ (if org-startup-align-all-tables
+ (org-table-map-tables 'org-table-align))
(if org-startup-with-deadline-check
(call-interactively 'org-check-deadlines)
(cond
(let ((this-command 'org-cycle) (last-command 'org-cycle))
(org-cycle '(4)) (org-cycle '(4))))))))
-(defun org-fill-paragraph (&optional justify)
- "Re-align a table, pass through to fill-paragraph if no table."
- (save-excursion
- (beginning-of-line 1)
- (looking-at "\\s-*\\(|\\|\\+-+\\)")))
-
(defsubst org-current-line (&optional pos)
(+ (if (bolp) 1 0) (count-lines (point-min) (or pos (point)))))
+(defconst org-rm-props '(invisible t face t keymap t intangible t mouse-face t
+ mouse-map t)
+ "Properties to remove when a string without properties is wanted.")
+
+(defsubst org-match-string-no-properties (num &optional string)
+ (if (featurep 'xemacs)
+ (let ((s (match-string num string)))
+ (remove-text-properties 0 (length s) org-rm-props s)
+ s)
+ (match-string-no-properties num string)))
+
+(defun org-current-time ()
+ "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
+ (if (> org-time-stamp-rounding-minutes 0)
+ (let ((r org-time-stamp-rounding-minutes)
+ (time (decode-time)))
+ (apply 'encode-time
+ (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
+ (nthcdr 2 time))))
+ (current-time)))
+
+(defun org-add-props (string plist &rest props)
+ "Add text properties to entire string, from beginning to end.
+PLIST may be a list of properties, PROPS are individual properties and values
+that will be added to PLIST. Returns the string that was modified."
+ (add-text-properties
+ 0 (length string) (if props (append plist props) plist) string)
+ string)
+(put 'org-add-props 'lisp-indent-function 2)
+
+
;;; Font-Lock stuff
(defvar org-mouse-map (make-sparse-keymap))
(define-key org-mouse-map
- (if org-xemacs-p [button2] [mouse-2]) 'org-open-at-mouse)
+ (if (featurep 'xemacs) [button2] [mouse-2]) 'org-open-at-mouse)
(define-key org-mouse-map
- (if org-xemacs-p [button3] [mouse-3]) 'org-find-file-at-mouse)
+ (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
+(define-key org-mouse-map [follow-link] 'mouse-face)
+(when org-tab-follows-link
+ (define-key org-mouse-map [(tab)] 'org-open-at-point)
+ (define-key org-mouse-map "\C-i" 'org-open-at-point))
+(when org-return-follows-link
+ (define-key org-mouse-map [(return)] 'org-open-at-point)
+ (define-key org-mouse-map "\C-m" 'org-open-at-point))
(require 'font-lock)
-(defconst org-non-link-chars "\t\n\r|<>\000")
-(defconst org-link-regexp
- (if org-allow-space-in-links
- (concat
- "\\(https?\\|ftp\\|mailto\\|file\\|news\\|bbdb\\|vm\\|wl\\|rmail\\|gnus\\|shell\\):\\([^" org-non-link-chars "]+[^ " org-non-link-chars "]\\)")
- (concat
- "\\(https?\\|ftp\\|mailto\\|file\\|news\\|bbdb\\|vm\\|wl\\|rmail\\|gnus\\|shell\\):\\([^ " org-non-link-chars "]+\\)")
- )
- "Regular expression for matching links.")
-(defconst org-link-maybe-angles-regexp
- (concat "<?\\(" org-link-regexp "\\)>?")
- "Matches a link and optionally surrounding angle brackets.")
-(defconst org-protected-link-regexp
- (concat "\000" org-link-regexp "\000")
- "Matches a link and optionally surrounding angle brackets.")
+(defconst org-non-link-chars "]\t\n\r<>")
+(defconst org-link-types '("https?" "ftp" "mailto" "file" "news" "bbdb" "vm"
+ "wl" "mhe" "rmail" "gnus" "shell"))
+(defconst org-link-re-with-space
+ (concat
+ "<?\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
+ "\\([^" org-non-link-chars " ]"
+ "[^" org-non-link-chars "]*"
+ "[^" org-non-link-chars " ]\\)>?")
+ "Matches a link with spaces, optional angular brackets around it.")
+
+(defconst org-link-re-with-space2
+ (concat
+ "<?\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
+ "\\([^" org-non-link-chars " ]"
+ "[^]\t\n\r]*"
+ "[^" org-non-link-chars " ]\\)>?")
+ "Matches a link with spaces, optional angular brackets around it.")
+
+(defconst org-angle-link-re
+ (concat
+ "<\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
+ "\\([^" org-non-link-chars " ]"
+ "[^" org-non-link-chars "]*"
+ "\\)>")
+ "Matches link with angular brackets, spaces are allowed.")
+(defconst org-plain-link-re
+ (concat
+ "\\(" (mapconcat 'identity org-link-types "\\|") "\\):"
+ "\\([^]\t\n\r<>,;() ]+\\)")
+ "Matches plain link, without spaces.")
+
+(defconst org-bracket-link-regexp
+ "\\[\\[\\([^]]+\\)\\]\\(\\[\\([^]]+\\)\\]\\)?\\]"
+ "Matches a link in double brackets.")
+
+(defconst org-bracket-link-analytic-regexp
+ (concat
+ "\\[\\["
+ "\\(\\(" (mapconcat 'identity org-link-types "\\|") "\\):\\)?"
+ "\\([^]]+\\)"
+ "\\]"
+ "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
+ "\\]"))
+; 1: http:
+; 2: http
+; 3: path
+; 4: [desc]
+; 5: desc
+
(defconst org-ts-lengths
(cons (length (format-time-string (car org-time-stamp-formats)))
(length (format-time-string (cdr org-time-stamp-formats))))
"This holds the lengths of the two different time formats.")
-(defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}[^\r\n>]*\\)>"
+(defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}[^\r\n>]*?\\)>"
+ "Regular expression for fast time stamp matching.")
+(defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}[^\r\n>]*?\\)[]>]"
"Regular expression for fast time stamp matching.")
(defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
"Regular expression matching time strings for analysis.")
org-ts-regexp "\\)?")
"Regular expression matching a time stamp or time stamp range.")
-(defun org-activate-links (limit)
+(defun org-activate-plain-links (limit)
"Run through the buffer and add overlays to links."
- (if (re-search-forward org-link-regexp limit t)
+ (if (re-search-forward org-plain-link-re limit t)
(progn
(add-text-properties (match-beginning 0) (match-end 0)
(list 'mouse-face 'highlight
- 'keymap org-mouse-map))
+ 'keymap org-mouse-map
+ ))
+ t)))
+
+(defun org-activate-angle-links (limit)
+ "Run through the buffer and add overlays to links."
+ (if (re-search-forward org-angle-link-re limit t)
+ (progn
+ (add-text-properties (match-beginning 0) (match-end 0)
+ (list 'mouse-face 'highlight
+ 'keymap org-mouse-map
+ ))
+ t)))
+
+(defun org-activate-bracket-links (limit)
+ "Run through the buffer and add overlays to bracketed links."
+ (if (re-search-forward org-bracket-link-regexp limit t)
+ (let* ((help (concat "LINK: " (org-match-string-no-properties 1)))
+ (ip (list 'invisible 'org-link 'intangible t 'rear-nonsticky t
+ 'keymap org-mouse-map 'mouse-face 'highlight
+ 'help-echo help))
+ (vp (list 'rear-nonsticky t
+ 'keymap org-mouse-map 'mouse-face 'highlight
+ 'help-echo help)))
+ ;; We need to remove the invisible property here. Table narrowing
+ ;; may have made some of this invisible.
+ (remove-text-properties (match-beginning 0) (match-end 0)
+ '(invisible nil))
+ (if (match-end 3)
+ (progn
+ (add-text-properties (match-beginning 0) (match-beginning 3) ip)
+ (add-text-properties (match-beginning 3) (match-end 3) vp)
+ (add-text-properties (match-end 3) (match-end 0) ip))
+ (add-text-properties (match-beginning 0) (match-beginning 1) ip)
+ (add-text-properties (match-beginning 1) (match-end 1) vp)
+ (add-text-properties (match-end 1) (match-end 0) ip))
t)))
(defun org-activate-dates (limit)
'keymap org-mouse-map))
t)))
+(defvar org-target-link-regexp nil
+ "Regular expression matching radio targets in plain text.")
+(defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
+ "Regular expression matching a link target.")
+(defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
+ "Regular expression matching a link target.")
+
+(defun org-activate-target-links (limit)
+ "Run through the buffer and add overlays to target matches."
+ (when org-target-link-regexp
+ (let ((case-fold-search t))
+ (if (re-search-forward org-target-link-regexp limit t)
+ (progn
+ (add-text-properties (match-beginning 0) (match-end 0)
+ (list 'mouse-face 'highlight
+ 'keymap org-mouse-map
+ 'help-echo "Radio target link"
+ 'org-linked-text t))
+ t)))))
+
+(defun org-update-radio-target-regexp ()
+ "Find all radio targets in this file and update the regular expression."
+ (interactive)
+ (when (memq 'radio org-activate-links)
+ (setq org-target-link-regexp
+ (org-make-target-link-regexp (org-all-targets 'radio)))
+ (org-restart-font-lock)))
+
+(defun org-hide-wide-columns (limit)
+ (let (s e)
+ (setq s (text-property-any (point) (or limit (point-max))
+ 'org-cwidth t))
+ (when s
+ (setq e (next-single-property-change s 'org-cwidth))
+ (add-text-properties s e '(invisible org-cwidth intangible t))
+ (goto-char e)
+ t)))
+
+(defun org-restart-font-lock ()
+ "Restart font-lock-mode, to force refontification."
+ (when (and (boundp 'font-lock-mode) font-lock-mode)
+ (font-lock-mode -1)
+ (font-lock-mode 1)))
+
+(defun org-all-targets (&optional radio)
+ "Return a list of all targets in this file.
+With optional argument RADIO, only find radio targets."
+ (let ((re (if radio org-radio-target-regexp org-target-regexp))
+ rtn)
+ (save-excursion
+ (goto-char (point-min))
+ (while (re-search-forward re nil t)
+ (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
+ rtn)))
+
+(defun org-make-target-link-regexp (targets)
+ "Make regular expression matching all strings in TARGETS.
+The regular expression finds the targets also if there is a line break
+between words."
+ (and targets
+ (concat
+ "\\<\\("
+ (mapconcat
+ (lambda (x)
+ (while (string-match " +" x)
+ (setq x (replace-match "\\s-+" t t x)))
+ x)
+ targets
+ "\\|")
+ "\\)\\>")))
+
+(defvar org-camel-regexp "\\*?\\<[A-Z]+[a-z]+[A-Z][a-zA-Z]*\\>"
+ "Matches CamelCase words, possibly with a star before it.")
+
+(defun org-activate-camels (limit)
+ "Run through the buffer and add overlays to dates."
+ (if (re-search-forward org-camel-regexp limit t)
+ (progn
+ (add-text-properties (match-beginning 0) (match-end 0)
+ (list 'mouse-face 'highlight
+ 'keymap org-mouse-map))
+ t)))
+
+(defun org-activate-tags (limit)
+ (if (re-search-forward "[ \t]\\(:[A-Za-z_@0-9:]+:\\)[ \r\n]" limit t)
+ (progn
+ (add-text-properties (match-beginning 1) (match-end 1)
+ (list 'mouse-face 'highlight
+ 'keymap org-mouse-map))
+ t)))
+
(defun org-font-lock-level ()
(save-excursion
(org-back-to-heading t)
(- (match-end 0) (match-beginning 0))))
+(defun org-outline-level ()
+ (save-excursion
+ (looking-at outline-regexp)
+ (if (match-beginning 1)
+ (+ (org-get-string-indentation (match-string 1)) 1000)
+ (- (match-end 0) (match-beginning 0)))))
+
(defvar org-font-lock-keywords nil)
(defun org-set-font-lock-defaults ()
- (let ((org-font-lock-extra-keywords
- (list
- '(org-activate-links (0 'org-link))
- '(org-activate-dates (0 'org-link))
- (list (concat "^\\*+[ \t]*" org-not-done-regexp)
- '(1 'org-warning t))
- (list (concat "\\[#[A-Z]\\]") '(0 'org-special-keyword t))
-; (list (concat "\\<" org-deadline-string) '(0 'org-warning t))
-; (list (concat "\\<" org-scheduled-string) '(0 'org-warning t))
- (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
- (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
- ;; '("\\(\\s-\\|^\\)\\(\\*\\([a-zA-Z]+\\)\\*\\)\\([^a-zA-Z*]\\|$\\)"
- ;; (3 'bold))
- ;; '("\\(\\s-\\|^\\)\\(/\\([a-zA-Z]+\\)/\\)\\([^a-zA-Z*]\\|$\\)"
- ;; (3 'italic))
- ;; '("\\(\\s-\\|^\\)\\(_\\([a-zA-Z]+\\)_\\)\\([^a-zA-Z*]\\|$\\)"
- ;; (3 'underline))
-; (list (concat "^\\*+[ \t]*\\<\\(" org-comment-string "\\)\\>")
-; '(1 'org-warning t))
- (list (concat "^\\*+[ \t]*\\<\\(" org-comment-string
- "\\|" org-quote-string "\\)\\>")
- '(1 'org-special-keyword t))
- '("^#.*" (0 'font-lock-comment-face t))
- (if org-fontify-done-headline
- (list (concat "^[*]+ +\\<\\(" org-done-string "\\)\\(.*\\)\\>")
- '(1 'org-done t) '(2 'org-headline-done t))
- (list (concat "^[*]+ +\\<\\(" org-done-string "\\)\\>")
- '(1 'org-done t)))
- '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
- (1 'org-table t))
- '("^[ \t]*\\(:.*\\)" (1 'org-table t))
- '("| *\\(:?=[^|\n]*\\)" (1 'org-formula t))
- '("^[ \t]*| *\\([#!$*_^]\\) *|" (1 'org-formula t))
- )))
+ (let* ((em org-fontify-emphasized-text)
+ (lk org-activate-links)
+ (org-font-lock-extra-keywords
+ (list
+ '("^\\(\\**\\)\\(\\*\\)\\(.*\\)" (1 (org-get-level-face 1))
+ (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
+ '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
+ (1 'org-table))
+ (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
+ (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
+ (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
+ (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
+ (if (memq 'date lk) '(org-activate-dates (0 'org-link t)))
+ (if (memq 'camel lk) '(org-activate-camels (0 'org-link t)))
+ (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
+ (if org-table-limit-column-width
+ '(org-hide-wide-columns (0 nil append)))
+ (list (concat "^\\*+[ \t]*" org-not-done-regexp)
+ '(1 'org-warning t))
+ (list (concat "\\[#[A-Z]\\]") '(0 'org-special-keyword t))
+ (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
+ (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
+ (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
+ (if em '("\\(\\W\\|^\\)\\(\\*\\w+\\*\\)\\(\\W\\|$\\)" 2 'bold prepend))
+ (if em '("\\(\\W\\|^\\)\\(/\\w+/\\)\\(\\W\\|$\\)" 2 'italic prepend))
+ (if em '("\\(\\W\\|^\\)\\(_\\w+_\\)\\(\\W\\|$\\)" 2 'underline prepend))
+ (list (concat "^\\*+[ \t]*\\<\\(" org-comment-string
+ "\\|" org-quote-string "\\)\\>")
+ '(1 'org-special-keyword t))
+ '("^#.*" (0 'font-lock-comment-face t))
+ (if org-fontify-done-headline
+ (list (concat "^[*]+ +\\<\\(" org-done-string "\\)\\(.*\\)\\>")
+ '(1 'org-done t) '(2 'org-headline-done t))
+ (list (concat "^[*]+ +\\<\\(" org-done-string "\\)\\>")
+ '(1 'org-done t)))
+ '("^[ \t]*\\(:.*\\)" (1 'org-table t))
+ '("| *\\(:?=[^|\n]*\\)" (1 'org-formula t))
+ '("^[ \t]*| *\\([#!$*_^]\\) *|" (1 'org-formula t))
+ (if org-format-transports-properties-p
+ '("| *\\(<[0-9]+>\\) *|" (1 'org-formula t)))
+ )))
+ (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
+ ;; Now set the full font-lock-keywords
(set (make-local-variable 'org-font-lock-keywords)
- (append
- (if org-noutline-p ; FIXME: I am not sure if eval will work
- ; on XEmacs if noutline is ever ported
- `((eval . (list "^\\(\\*+\\).*"
- ,(if org-level-color-stars-only 1 0)
- '(nth ;; FIXME: 1<->0 ????
- (% (- (match-end 1) (match-beginning 1) 1)
- org-n-levels)
- org-level-faces)
- nil t)))
- `(("^\\(\\(\\*+\\)[^\r\n]*\\)[\n\r]"
- (,(if org-level-color-stars-only 2 0)
- (nth (% (- (match-end 2) (match-beginning 2) 1)
- org-n-levels)
- org-level-faces)
- nil t))))
- org-font-lock-extra-keywords))
+ org-font-lock-extra-keywords)
(set (make-local-variable 'font-lock-defaults)
'(org-font-lock-keywords t nil nil backward-paragraph))
(kill-local-variable 'font-lock-keywords) nil))
+(defvar org-m nil)
+(defvar org-l nil)
+(defvar org-f nil)
+(defun org-get-level-face (n)
+ "Get the right face for match N in font-lock matching of healdines."
+ (setq org-l (- (match-end 2) (match-beginning 1)))
+ (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
+; (setq org-f (nth (1- (% org-l org-n-levels)) org-level-faces))
+ (setq org-f (nth (% (1- org-l) org-n-levels) org-level-faces))
+ (cond
+ ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
+ ((eq n 2) org-f)
+ (t (if org-level-color-stars-only nil org-f))))
+
(defun org-unfontify-region (beg end &optional maybe_loudly)
"Remove fontification and activation overlays from links."
(font-lock-default-unfontify-region beg end)
(inhibit-read-only t) (inhibit-point-motion-hooks t)
(inhibit-modification-hooks t)
deactivate-mark buffer-file-name buffer-file-truename)
- (remove-text-properties beg end '(mouse-face nil keymap nil))))
-
+ (remove-text-properties beg end
+ '(mouse-face nil keymap nil org-linked-text nil
+ invisible nil intangible nil))))
;;; Visibility cycling
(defvar org-cycle-global-status nil)
- When point is at the beginning of a headline, rotate the subtree started
by this line through 3 different states (local cycling)
1. FOLDED: Only the main headline is shown.
- 2. CHILDREN: The main headline and the direct children are shown. From
- this state, you can move to one of the children and
- zoom in further.
+ 2. CHILDREN: The main headline and the direct children are shown.
+ From this state, you can move to one of the children
+ and zoom in further.
3. SUBTREE: Show the entire subtree, including body text.
- When there is a numeric prefix, go up to a heading with level ARG, do
;; special case: use global cycling
(setq arg t))
- (cond
+ (let ((outline-regexp
+ (if org-cycle-include-plain-lists
+ "\\*+\\|\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) "
+ outline-regexp)))
- ((org-at-table-p 'any)
- ;; Enter the table or move to the next field in the table
- (or (org-table-recognize-table.el)
- (progn
- (org-table-justify-field-maybe)
- (org-table-next-field))))
+ (cond
- ((eq arg t) ;; Global cycling
+ ((org-at-table-p 'any)
+ ;; Enter the table or move to the next field in the table
+ (or (org-table-recognize-table.el)
+ (progn
+ (if arg (org-table-edit-field t)
+ (org-table-justify-field-maybe)
+ (org-table-next-field)))))
- (cond
- ((and (eq last-command this-command)
- (eq org-cycle-global-status 'overview))
- ;; We just created the overview - now do table of contents
- ;; This can be slow in very large buffers, so indicate action
- (message "CONTENTS...")
- (save-excursion
- ;; Visit all headings and show their offspring
- (goto-char (point-max))
- (catch 'exit
- (while (and (progn (condition-case nil
- (outline-previous-visible-heading 1)
- (error (goto-char (point-min))))
- t)
- (looking-at outline-regexp))
- (show-branches)
- (if (bobp) (throw 'exit nil))))
- (message "CONTENTS...done"))
- (setq org-cycle-global-status 'contents)
- (run-hook-with-args 'org-cycle-hook 'contents))
-
- ((and (eq last-command this-command)
- (eq org-cycle-global-status 'contents))
- ;; We just showed the table of contents - now show everything
- (show-all)
- (message "SHOW ALL")
- (setq org-cycle-global-status 'all)
- (run-hook-with-args 'org-cycle-hook 'all))
+ ((eq arg t) ;; Global cycling
- (t
- ;; Default action: go to overview
- (hide-sublevels 1)
- (message "OVERVIEW")
- (setq org-cycle-global-status 'overview)
- (run-hook-with-args 'org-cycle-hook 'overview))))
+ (cond
+ ((and (eq last-command this-command)
+ (eq org-cycle-global-status 'overview))
+ ;; We just created the overview - now do table of contents
+ ;; This can be slow in very large buffers, so indicate action
+ (message "CONTENTS...")
+ (save-excursion
+ ;; Visit all headings and show their offspring
+ (goto-char (point-max))
+ (catch 'exit
+ (while (and (progn (condition-case nil
+ (outline-previous-visible-heading 1)
+ (error (goto-char (point-min))))
+ t)
+ (looking-at outline-regexp))
+ (show-branches)
+ (if (bobp) (throw 'exit nil))))
+ (message "CONTENTS...done"))
+ (setq org-cycle-global-status 'contents)
+ (run-hook-with-args 'org-cycle-hook 'contents))
- ((integerp arg)
- ;; Show-subtree, ARG levels up from here.
- (save-excursion
- (org-back-to-heading)
- (outline-up-heading (if (< arg 0) (- arg)
- (- (outline-level) arg)))
- (org-show-subtree)))
+ ((and (eq last-command this-command)
+ (eq org-cycle-global-status 'contents))
+ ;; We just showed the table of contents - now show everything
+ (show-all)
+ (message "SHOW ALL")
+ (setq org-cycle-global-status 'all)
+ (run-hook-with-args 'org-cycle-hook 'all))
- ((save-excursion (beginning-of-line 1) (looking-at outline-regexp))
- ;; At a heading: rotate between three different views
- (org-back-to-heading)
- (let ((goal-column 0) eoh eol eos)
- ;; First, some boundaries
+ (t
+ ;; Default action: go to overview
+ (hide-sublevels 1)
+ (message "OVERVIEW")
+ (setq org-cycle-global-status 'overview)
+ (run-hook-with-args 'org-cycle-hook 'overview))))
+
+ ((integerp arg)
+ ;; Show-subtree, ARG levels up from here.
(save-excursion
(org-back-to-heading)
+ (outline-up-heading (if (< arg 0) (- arg)
+ (- (funcall outline-level) arg)))
+ (org-show-subtree)))
+
+ ((save-excursion (beginning-of-line 1) (looking-at outline-regexp))
+ ;; At a heading: rotate between three different views
+ (org-back-to-heading)
+ (let ((goal-column 0) eoh eol eos)
+ ;; First, some boundaries
(save-excursion
- (beginning-of-line 2)
- (while (and (not (eobp)) ;; this is like `next-line'
- (get-char-property (1- (point)) 'invisible))
- (beginning-of-line 2)) (setq eol (point)))
- (outline-end-of-heading) (setq eoh (point))
- (outline-end-of-subtree) (setq eos (point))
- (outline-next-heading))
- ;; Find out what to do next and set `this-command'
- (cond
- ((= eos eoh)
- ;; Nothing is hidden behind this heading
- (message "EMPTY ENTRY")
- (setq org-cycle-subtree-status nil))
- ((>= eol eos)
- ;; Entire subtree is hidden in one line: open it
- (org-show-entry)
- (show-children)
- (message "CHILDREN")
- (setq org-cycle-subtree-status 'children)
- (run-hook-with-args 'org-cycle-hook 'children))
- ((and (eq last-command this-command)
- (eq org-cycle-subtree-status 'children))
- ;; We just showed the children, now show everything.
- (org-show-subtree)
- (message "SUBTREE")
- (setq org-cycle-subtree-status 'subtree)
- (run-hook-with-args 'org-cycle-hook 'subtree))
- (t
- ;; Default action: hide the subtree.
- (hide-subtree)
- (message "FOLDED")
- (setq org-cycle-subtree-status 'folded)
- (run-hook-with-args 'org-cycle-hook 'folded)))))
-
- ;; TAB emulation
- (buffer-read-only (org-back-to-heading))
- ((if (and (eq org-cycle-emulate-tab 'white)
- (save-excursion (beginning-of-line 1) (looking-at "[ \t]+$")))
- t
- (eq org-cycle-emulate-tab t))
- (if (and (looking-at "[ \n\r\t]")
- (string-match "^[ \t]*$" (buffer-substring
- (point-at-bol) (point))))
- (progn
- (beginning-of-line 1)
- (and (looking-at "[ \t]+") (replace-match ""))))
- (indent-relative))
+ (org-back-to-heading)
+ (save-excursion
+ (beginning-of-line 2)
+ (while (and (not (eobp)) ;; this is like `next-line'
+ (get-char-property (1- (point)) 'invisible))
+ (beginning-of-line 2)) (setq eol (point)))
+ (outline-end-of-heading) (setq eoh (point))
+ (org-end-of-subtree t) (setq eos (point))
+ (outline-next-heading))
+ ;; Find out what to do next and set `this-command'
+ (cond
+ ((= eos eoh)
+ ;; Nothing is hidden behind this heading
+ (message "EMPTY ENTRY")
+ (setq org-cycle-subtree-status nil))
+ ((>= eol eos)
+ ;; Entire subtree is hidden in one line: open it
+ (org-show-entry)
+ (show-children)
+ (message "CHILDREN")
+ (setq org-cycle-subtree-status 'children)
+ (run-hook-with-args 'org-cycle-hook 'children))
+ ((and (eq last-command this-command)
+ (eq org-cycle-subtree-status 'children))
+ ;; We just showed the children, now show everything.
+ (org-show-subtree)
+ (message "SUBTREE")
+ (setq org-cycle-subtree-status 'subtree)
+ (run-hook-with-args 'org-cycle-hook 'subtree))
+ (t
+ ;; Default action: hide the subtree.
+ (hide-subtree)
+ (message "FOLDED")
+ (setq org-cycle-subtree-status 'folded)
+ (run-hook-with-args 'org-cycle-hook 'folded)))))
+
+ ;; TAB emulation
+ (buffer-read-only (org-back-to-heading))
+ ((if (and (eq org-cycle-emulate-tab 'white)
+ (save-excursion (beginning-of-line 1) (looking-at "[ \t]+$")))
+ t
+ (eq org-cycle-emulate-tab t))
+ (if (and (looking-at "[ \n\r\t]")
+ (string-match "^[ \t]*$" (buffer-substring
+ (point-at-bol) (point))))
+ (progn
+ (beginning-of-line 1)
+ (and (looking-at "[ \t]+") (replace-match ""))))
+ (indent-relative))
- (t (save-excursion
- (org-back-to-heading)
- (org-cycle)))))
+ (t (save-excursion
+ (org-back-to-heading)
+ (org-cycle))))))
(defun org-optimize-window-after-visibility-change (state)
"Adjust the window after a change in outline visibility.
This function is the default value of the hook `org-cycle-hook'."
- (cond
- ((eq state 'overview) (org-first-headline-recenter 1))
- ((eq state 'content) nil)
- ((eq state 'all) nil)
- ((eq state 'folded) nil)
- ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
- ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1)))))
+ (when (get-buffer-window (current-buffer))
+ (cond
+ ((eq state 'overview) (org-first-headline-recenter 1))
+ ((eq state 'content) nil)
+ ((eq state 'all) nil)
+ ((eq state 'folded) nil)
+ ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
+ ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
(defun org-subtree-end-visible-p ()
"Is the end of the current subtree visible?"
(pos-visible-in-window-p
- (save-excursion (outline-end-of-subtree) (point))))
+ (save-excursion (org-end-of-subtree t) (point))))
(defun org-first-headline-recenter (&optional N)
"Move cursor to the first headline and recenter the headline.
(define-key org-goto-map [(?q)] 'org-goto-quit)
(define-key org-goto-map [(control ?g)] 'org-goto-quit)
(define-key org-goto-map "\C-i" 'org-cycle)
+(define-key org-goto-map [(tab)] 'org-cycle)
(define-key org-goto-map [(down)] 'outline-next-visible-heading)
(define-key org-goto-map [(up)] 'outline-previous-visible-heading)
(define-key org-goto-map "n" 'outline-next-visible-heading)
(org-get-location (current-buffer) org-goto-help)))
(if selected-point
(progn
+ (org-mark-ring-push org-goto-start-pos)
(goto-char selected-point)
- (if (org-invisible-p) (org-show-hierarchy-above)))
+ (if (or (org-invisible-p) (org-invisible-p2))
+ (org-show-hierarchy-above)))
(error "Quit"))))
(defun org-get-location (buf help)
(insert-buffer-substring buf)
(let ((org-startup-truncated t)
(org-startup-folded t)
+ (org-startup-align-all-tables nil)
(org-startup-with-deadline-check nil))
(org-mode))
(setq buffer-read-only t)
;; FIXME: It may not be a good idea to temper with the prefix argument...
(defun org-goto-ret (&optional arg)
- "Finish org-goto by going to the new location."
+ "Finish `org-goto' by going to the new location."
(interactive "P")
(setq org-selected-point (point)
current-prefix-arg arg)
(throw 'exit nil))
(defun org-goto-left ()
- "Finish org-goto by going to the new location."
+ "Finish `org-goto' by going to the new location."
(interactive)
(if (org-on-heading-p)
(progn
(error "Not on a heading")))
(defun org-goto-right ()
- "Finish org-goto by going to the new location."
+ "Finish `org-goto' by going to the new location."
(interactive)
(if (org-on-heading-p)
(progn
(error "Not on a heading")))
(defun org-goto-quit ()
- "Finish org-goto without cursor motion."
+ "Finish `org-goto' without cursor motion."
(interactive)
(setq org-selected-point nil)
(throw 'exit nil))
(defvar org-ignore-region nil
"To temporarily disable the active region.")
-(defun org-insert-heading ()
- "Insert a new heading with same depth at point."
- (interactive)
- (let* ((head (save-excursion
- (condition-case nil
- (org-back-to-heading)
- (error (outline-next-heading)))
- (prog1 (match-string 0)
- (funcall outline-level)))))
+(defun org-insert-heading (&optional force-heading)
+ "Insert a new heading or item with same depth at point."
+ (interactive "P")
+ (when (or force-heading (not (org-insert-item)))
+ (let* ((head (save-excursion
+ (condition-case nil
+ (org-back-to-heading)
+ (error (outline-next-heading)))
+ (prog1 (match-string 0)
+ (funcall outline-level)))))
+ (unless (bolp) (newline))
+ (insert head)
+ (if (looking-at "[ \t]*")
+ (replace-match " "))
+ (run-hooks 'org-insert-heading-hook))))
+
+(defun org-insert-item ()
+ "Insert a new item at the current level.
+Return t when things worked, nil when we are not in an item."
+ (when (save-excursion
+ (condition-case nil
+ (progn
+ (org-beginning-of-item)
+ (org-at-item-p)
+ t)
+ (error nil)))
(unless (bolp) (newline))
- (insert head)
- (unless (eolp)
- (save-excursion (newline-and-indent)))
- (unless (equal (char-before) ?\ )
- (insert " "))
- (run-hooks 'org-insert-heading-hook)))
+ (insert (match-string 0))
+ (org-maybe-renumber-ordered-list)
+ t))
(defun org-insert-todo-heading (arg)
"Insert a new heading with the same level and TODO state as current heading.
(equal (char-before) ?*)
(forward-char 1)))
+(defun org-get-legal-level (level change)
+ "Rectify a level change under the influence of `org-odd-levels-only'
+LEVEL is a current level, CHANGE is by how much the level should be
+modified. Even if CHANGE is nil, LEVEL may be returned modified because
+even level numbers will become the next higher odd number."
+ (if org-odd-levels-only
+ (cond ((not change) (1+ (* 2 (/ level 2))))
+ ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
+ ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
+ (max 1 (+ level change))))
+
(defun org-promote ()
"Promote the current heading higher up the tree.
If the region is active in `transient-mark-mode', promote all headings
in the region."
(org-back-to-heading t)
(let* ((level (save-match-data (funcall outline-level)))
- (up-head (make-string (1- level) ?*)))
+ (up-head (make-string (org-get-legal-level level -1) ?*))
+ (diff (abs (- level (length up-head)))))
(if (= level 1) (error "Cannot promote to level 0. UNDO to recover"))
(replace-match up-head nil t)
+ ;; Fixup tag positioning
+ (and org-auto-align-tags (org-set-tags nil t))
(if org-adapt-indentation
- (org-fixup-indentation "^ " "" "^ ?\\S-"))))
+ (org-fixup-indentation (if (> diff 1) "^ " "^ ") ""
+ (if (> diff 1) "^ ? ?\\S-" "^ ?\\S-")))))
(defun org-demote ()
"Demote the current heading lower down the tree.
in the region."
(org-back-to-heading t)
(let* ((level (save-match-data (funcall outline-level)))
- (down-head (make-string (1+ level) ?*)))
+ (down-head (make-string (org-get-legal-level level 1) ?*))
+ (diff (abs (- level (length down-head)))))
(replace-match down-head nil t)
+ ;; Fixup tag positioning
+ (and org-auto-align-tags (org-set-tags nil t))
(if org-adapt-indentation
- (org-fixup-indentation "^ " " " "^\\S-"))))
+ (org-fixup-indentation "^ " (if (> diff 1) " " " ") "^\\S-"))))
(defun org-map-tree (fun)
"Call FUN for every heading underneath the current one."
(org-back-to-heading)
- (let ((level (outline-level)))
+ (let ((level (funcall outline-level)))
(save-excursion
(funcall fun)
(while (and (progn
(shift1 shift)
(delta (if (> shift 0) -1 1))
(func (if (> shift 0) 'org-demote 'org-promote))
+ (org-odd-levels-only nil)
beg end)
;; Remove the forces level indicator
(if force-level
(throw 'exit nil)))
t))))
+;;; Plain list items
+
+(defun org-at-item-p ()
+ "Is point in a line starting a hand-formatted item?"
+ (let ((llt org-plain-list-ordered-item-terminator))
+ (save-excursion
+ (goto-char (point-at-bol))
+ (looking-at
+ (cond
+ ((eq llt t) "\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)")
+ ((= llt ?.) "\\([ \t]*\\([-+]\\|\\([0-9]+\\.\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)")
+ ((= llt ?\)) "\\([ \t]*\\([-+]\\|\\([0-9]+)\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)")
+ (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
+
+(defun org-get-indentation ()
+ "Get the indentation of the current line, interpreting tabs."
+ (save-excursion
+ (beginning-of-line 1)
+ (skip-chars-forward " \t")
+ (current-column)))
+
+(defun org-beginning-of-item ()
+ "Go to the beginning of the current hand-formatted item.
+If the cursor is not in an item, throw an error."
+ (let ((pos (point))
+ (limit (save-excursion (org-back-to-heading)
+ (beginning-of-line 2) (point)))
+ ind ind1)
+ (if (org-at-item-p)
+ (beginning-of-line 1)
+ (beginning-of-line 1)
+ (skip-chars-forward " \t")
+ (setq ind (current-column))
+ (if (catch 'exit
+ (while t
+ (beginning-of-line 0)
+ (if (< (point) limit) (throw 'exit nil))
+ (unless (looking-at " \t]*$")
+ (skip-chars-forward " \t")
+ (setq ind1 (current-column))
+ (if (< ind1 ind)
+ (throw 'exit (org-at-item-p))))))
+ nil
+ (goto-char pos)
+ (error "Not in an item")))))
+
+(defun org-end-of-item ()
+ "Go to the end of the current hand-formatted item.
+If the cursor is not in an item, throw an error."
+ (let ((pos (point))
+ (limit (save-excursion (outline-next-heading) (point)))
+ (ind (save-excursion
+ (org-beginning-of-item)
+ (skip-chars-forward " \t")
+ (current-column)))
+ ind1)
+ (if (catch 'exit
+ (while t
+ (beginning-of-line 2)
+ (if (>= (point) limit) (throw 'exit t))
+ (unless (looking-at "[ \t]*$")
+ (skip-chars-forward " \t")
+ (setq ind1 (current-column))
+ (if (<= ind1 ind) (throw 'exit t)))))
+ (beginning-of-line 1)
+ (goto-char pos)
+ (error "Not in an item"))))
+
+(defun org-move-item-down (arg)
+ "Move the plain list item at point down, i.e. swap with following item.
+Subitems (items with larger indentation) are considered part of the item,
+so this really moves item trees."
+ (interactive "p")
+ (let (beg end ind ind1 (pos (point)) txt)
+ (org-beginning-of-item)
+ (setq beg (point))
+ (setq ind (org-get-indentation))
+ (org-end-of-item)
+ (setq end (point))
+ (setq ind1 (org-get-indentation))
+ (if (and (org-at-item-p) (= ind ind1))
+ (progn
+ (org-end-of-item)
+ (setq txt (buffer-substring beg end))
+ (save-excursion
+ (delete-region beg end))
+ (setq pos (point))
+ (insert txt)
+ (goto-char pos)
+ (org-maybe-renumber-ordered-list))
+ (goto-char pos)
+ (error "Cannot move this item further down"))))
+
+(defun org-move-item-up (arg)
+ "Move the plain list item at point up, i.e. swap with previous item.
+Subitems (items with larger indentation) are considered part of the item,
+so this really moves item trees."
+ (interactive "p")
+ (let (beg end ind ind1 (pos (point)) txt)
+ (org-beginning-of-item)
+ (setq beg (point))
+ (setq ind (org-get-indentation))
+ (org-end-of-item)
+ (setq end (point))
+ (goto-char beg)
+ (catch 'exit
+ (while t
+ (beginning-of-line 0)
+ (if (looking-at "[ \t]*$")
+ nil
+ (if (<= (setq ind1 (org-get-indentation)) ind)
+ (throw 'exit t)))))
+ (condition-case nil
+ (org-beginning-of-item)
+ (error (goto-char beg)
+ (error "Cannot move this item further up")))
+ (setq ind1 (org-get-indentation))
+ (if (and (org-at-item-p) (= ind ind1))
+ (progn
+ (setq txt (buffer-substring beg end))
+ (save-excursion
+ (delete-region beg end))
+ (setq pos (point))
+ (insert txt)
+ (goto-char pos)
+ (org-maybe-renumber-ordered-list))
+ (goto-char pos)
+ (error "Cannot move this item further up"))))
+
+(defun org-maybe-renumber-ordered-list ()
+ "Renumber the ordered list at point if setup allows it.
+This tests the user option `org-auto-renumber-ordered-lists' before
+doing the renumbering."
+ (and org-auto-renumber-ordered-lists
+ (org-at-item-p)
+ (match-beginning 3)
+ (org-renumber-ordered-list 1)))
+
+(defun org-get-string-indentation (s)
+ "What indentation has S due to SPACE and TAB at the beginning of the string?"
+ (let ((n -1) (i 0) (w tab-width) c)
+ (catch 'exit
+ (while (< (setq n (1+ n)) (length s))
+ (setq c (aref s n))
+ (cond ((= c ?\ ) (setq i (1+ i)))
+ ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
+ (t (throw 'exit t)))))
+ i))
+
+(defun org-renumber-ordered-list (arg)
+ "Renumber an ordered plain list.
+Cursor next to be in the first line of an item, the line that starts
+with something like \"1.\" or \"2)\"."
+ (interactive "p")
+ (unless (and (org-at-item-p)
+ (match-beginning 3))
+ (error "This is not an ordered list"))
+ (let ((line (org-current-line))
+ (col (current-column))
+ (ind (org-get-string-indentation
+ (buffer-substring (point-at-bol) (match-beginning 3))))
+ ;; (term (substring (match-string 3) -1))
+ ind1 (n (1- arg)))
+ ;; find where this list begins
+ (catch 'exit
+ (while t
+ (catch 'next
+ (beginning-of-line 0)
+ (if (looking-at "[ \t]*$") (throw 'next t))
+ (skip-chars-forward " \t") (setq ind1 (current-column))
+ (if (or (< ind1 ind)
+ (and (= ind1 ind)
+ (not (org-at-item-p))))
+ (throw 'exit t)))))
+ ;; Walk forward and replace these numbers
+ (catch 'exit
+ (while t
+ (catch 'next
+ (beginning-of-line 2)
+ (if (eobp) (throw 'exit nil))
+ (if (looking-at "[ \t]*$") (throw 'next nil))
+ (skip-chars-forward " \t") (setq ind1 (current-column))
+ (if (> ind1 ind) (throw 'next t))
+ (if (< ind1 ind) (throw 'exit t))
+ (if (not (org-at-item-p)) (throw 'exit nil))
+ (if (not (match-beginning 3))
+ (error "unordered bullet in ordered list. Press \\[undo] to recover"))
+ (delete-region (match-beginning 3) (1- (match-end 3)))
+ (goto-char (match-beginning 3))
+ (insert (format "%d" (setq n (1+ n)))))))
+ (goto-line line)
+ (move-to-column col)))
+
+(defvar org-last-indent-begin-marker (make-marker))
+(defvar org-last-indent-end-marker (make-marker))
+
+(defun org-outdent-item (arg)
+ "Outdent a local list item."
+ (interactive "p")
+ (org-indent-item (- arg)))
+
+(defun org-indent-item (arg)
+ "Indent a local list item."
+ (interactive "p")
+ (unless (org-at-item-p)
+ (error "Not on an item"))
+ (let (beg end ind ind1)
+ (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
+ (setq beg org-last-indent-begin-marker
+ end org-last-indent-end-marker)
+ (org-beginning-of-item)
+ (setq beg (move-marker org-last-indent-begin-marker (point)))
+ (org-end-of-item)
+ (setq end (move-marker org-last-indent-end-marker (point))))
+ (goto-char beg)
+ (skip-chars-forward " \t") (setq ind (current-column))
+ (if (< (+ arg ind) 0) (error "Cannot outdent beyond margin"))
+ (while (< (point) end)
+ (beginning-of-line 1)
+ (skip-chars-forward " \t") (setq ind1 (current-column))
+ (delete-region (point-at-bol) (point))
+ (indent-to-column (+ ind1 arg))
+ (beginning-of-line 2))
+ (goto-char beg)))
+
+;;; Archiving
+
(defun org-archive-subtree ()
"Move the current subtree to the archive.
The archive can be a certain top-level heading in the current file, or in
(if (string-match "\\(.*\\)::\\(.*\\)" org-archive-location)
(progn
(setq file (format (match-string 1 org-archive-location)
- (file-name-nondirectory (buffer-file-name)))
+ (file-name-nondirectory buffer-file-name))
heading (match-string 2 org-archive-location)))
(error "Invalid `org-archive-location'"))
(if (> (length file) 0)
(looking-at org-todo-line-regexp)
(goto-char (or (match-end 2) (match-beginning 3)))
(insert "(" (format-time-string (cdr org-time-stamp-formats)
- (current-time))
+ (org-current-time))
")"))
;; Save the buffer, if it is not the same buffer.
(if (not (eq this-buffer buffer)) (save-buffer))))
(interactive "P")
(catch 'exit
(let* ((end (point))
+ (beg1 (save-excursion
+ (if (equal (char-before (point)) ?\ ) (backward-char 1))
+ (skip-chars-backward "a-zA-Z_@0-9")
+ (point)))
(beg (save-excursion
(if (equal (char-before (point)) ?\ ) (backward-char 1))
(skip-chars-backward "a-zA-Z0-9_:$")
(point)))
+ (camel (equal (char-before beg) ?*))
+ (tag (equal (char-before beg1) ?:))
(texp (equal (char-before beg) ?\\))
(opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
beg)
"#+"))
- (pattern (buffer-substring-no-properties beg end))
(completion-ignore-case opt)
(type nil)
+ (tbl nil)
(table (cond
(opt
(setq type :opt)
(buffer-substring (point-at-bol) beg))
(setq type :todo)
(mapcar 'list org-todo-keywords))
+ (camel
+ (setq type :camel)
+ (save-excursion
+ (goto-char (point-min))
+ (while (re-search-forward org-todo-line-regexp nil t)
+ (push (list
+ (if org-file-link-context-use-camel-case
+ (org-make-org-heading-camel (match-string 3) t)
+ (org-make-org-heading-search-string
+ (match-string 3) t)))
+ tbl)))
+ tbl)
+ (tag (setq type :tag beg beg1)
+ (org-get-buffer-tags))
(t (progn (ispell-complete-word arg) (throw 'exit nil)))))
+ (pattern (buffer-substring-no-properties beg end))
(completion (try-completion pattern table)))
(cond ((eq completion t)
(if (equal type :opt)
(insert completion)
(if (get-buffer-window "*Completions*")
(delete-window (get-buffer-window "*Completions*")))
- (if (and (eq type :todo)
- (assoc completion table))
- (insert " "))
+ (if (assoc completion table)
+ (if (eq type :todo) (insert " ")
+ (if (eq type :tag) (insert ":"))))
(if (and (equal type :opt) (assoc completion table))
(message "%s" (substitute-command-keys
"Press \\[org-complete] again to insert example settings"))))
(message "Making completion list...")
(let ((list (sort (all-completions pattern table) 'string<)))
(with-output-to-temp-buffer "*Completions*"
- (display-completion-list list)))
+ (condition-case nil
+ ;; Protection needed for XEmacs and emacs 21
+ (display-completion-list list pattern)
+ (error (display-completion-list list)))))
(message "Making completion list...%s" "done"))))))
;;; Comments, TODO and DEADLINE
*** TODO Write paper
*** DONE Call mom
-The different keywords are specified in the variable `org-todo-keywords'. By
-default the available states are \"TODO\" and \"DONE\".
+The different keywords are specified in the variable `org-todo-keywords'.
+By default the available states are \"TODO\" and \"DONE\".
So for this example: when the item starts with TODO, it is changed to DONE.
When it starts with DONE, the DONE is removed. And when neither TODO nor
DONE are present, add TODO at the beginning of the heading.
-With prefix arg, use completion to determined the new state. With numeric
+With prefix arg, use completion to determine the new state. With numeric
prefix arg, switch to that state."
(interactive "P")
(save-excursion
(completing-read "State: " (mapcar (lambda(x) (list x))
org-todo-keywords)
nil t))
+ ((eq arg 'right)
+ (if this
+ (if tail (car tail) nil)
+ (car org-todo-keywords)))
+ ((eq arg 'left)
+ (if (equal member org-todo-keywords)
+ nil
+ (if this
+ (nth (- (length org-todo-keywords) (length tail) 2)
+ org-todo-keywords)
+ org-done-string)))
(arg
;; user requests a specific state
(nth (1- (prefix-numeric-value arg))
(replace-match next t t)
(setq org-last-todo-state-is-todo
(not (equal state org-done-string)))
+ (when org-log-done
+ (if (equal state org-done-string)
+ (org-log-done)
+ (if (not this)
+ (org-log-done t))))
+ ;; Fixup tag positioning
+ (and org-auto-align-tags (org-set-tags nil t))
(run-hooks 'org-after-todo-state-change-hook)))
;; Fixup cursor location if close to the keyword
(if (and (outline-on-heading-p)
(goto-char (or (match-end 2) (match-end 1)))
(just-one-space))))
+(defun org-log-done (&optional undone)
+ "Add a time stamp logging that a TODO entry has been closed.
+When UNDONE is non-nil, remove such a time stamp again."
+ (interactive)
+ (let (beg end col)
+ (save-excursion
+ (org-back-to-heading t)
+ (setq beg (point))
+ (looking-at (concat outline-regexp " *"))
+ (goto-char (match-end 0))
+ (setq col (current-column))
+ (outline-next-heading)
+ (setq end (point))
+ (goto-char beg)
+ (when (re-search-forward (concat
+ "[\r\n]\\([ \t]*"
+ (regexp-quote org-closed-string)
+ " *\\[.*?\\][^\n\r]*[\n\r]?\\)") end t)
+ (delete-region (match-beginning 1) (match-end 1)))
+ (unless undone
+ (org-back-to-heading t)
+ (skip-chars-forward "^\n\r")
+ (goto-char (min (1+ (point)) (point-max)))
+ (when (not (member (char-before) '(?\r ?\n)))
+ (insert "\n"))
+ (indent-to col)
+ (insert org-closed-string " "
+ (format-time-string
+ (concat "[" (substring (cdr org-time-stamp-formats) 1 -1) "]")
+ (org-current-time))
+ "\n")))))
+
(defun org-show-todo-tree (arg)
"Make a compact tree which shows all headlines marked with TODO.
The tree will show the lines where the regexp matches, and all higher
-headlines above the match."
+headlines above the match.
+With \\[universal-argument] prefix, also show the DONE entries.
+With a numeric prefix N, construct a sparse tree for the Nth element
+of `org-todo-keywords'."
(interactive "P")
(let ((case-fold-search nil)
- (kwd-re (if arg org-todo-regexp org-not-done-regexp)))
+ (kwd-re
+ (cond ((null arg) org-not-done-regexp)
+ ((equal arg '(4)) org-todo-regexp)
+ ((<= (prefix-numeric-value arg) (length org-todo-keywords))
+ (regexp-quote (nth (1- (prefix-numeric-value arg))
+ org-todo-keywords)))
+ (t (error "Invalid prefix argument: %s" arg)))))
(message "%d TODO entries found"
(org-occur (concat "^" outline-regexp " +" kwd-re )))))
The tree will show the lines where the regexp matches, and all higher
headlines above the match. It will also show the heading after the match,
to make sure editing the matching entry is easy.
-if CALLBACK is non-nil, it is a function which is called to confirm
+If CALLBACK is non-nil, it is a function which is called to confirm
that the match should indeed be shown."
(interactive "sRegexp: ")
+ (org-remove-occur-highlights nil nil t)
(setq regexp (org-check-occur-regexp regexp))
(let ((cnt 0))
(save-excursion
(hide-sublevels 1)
(while (re-search-forward regexp nil t)
(when (or (not callback)
- (funcall callback))
+ (save-match-data (funcall callback)))
(setq cnt (1+ cnt))
+ (org-highlight-new-match (match-beginning 0) (match-end 0))
(org-show-hierarchy-above))))
+ (org-add-hook 'before-change-functions 'org-remove-occur-highlights
+ nil 'local)
(run-hooks 'org-occur-hook)
(if (interactive-p)
(message "%d match(es) for regexp %s" cnt regexp))
(defun org-show-hierarchy-above ()
"Make sure point and the headings hierarchy above is visible."
- (if (org-on-heading-p t)
- (org-flag-heading nil) ; only show the heading
- (org-show-hidden-entry)) ; show entire entry
- (save-excursion
- (and org-show-following-heading
- (outline-next-heading)
- (org-flag-heading nil))) ; show the next heading
- (save-excursion ; show all higher headings
- (while (condition-case nil
- (progn (org-up-heading-all 1) t)
- (error nil))
- (org-flag-heading nil))))
+ (catch 'exit
+ (if (org-on-heading-p t)
+ (org-flag-heading nil) ; only show the heading
+ (and (or (org-invisible-p) (org-invisible-p2))
+ (org-show-hidden-entry))) ; show entire entry
+ (save-excursion
+ (and org-show-following-heading
+ (outline-next-heading)
+ (org-flag-heading nil))) ; show the next heading
+ (when org-show-hierarchy-above
+ (save-excursion ; show all higher headings
+ (while (and (condition-case nil
+ (progn (org-up-heading-all 1) t)
+ (error nil))
+ (not (bobp)))
+ (org-flag-heading nil))))))
+
+;; Overlay compatibility functions
+(defun org-make-overlay (beg end &optional buffer)
+ (if (featurep 'xemacs)
+ (make-extent beg end buffer)
+ (make-overlay beg end buffer)))
+(defun org-delete-overlay (ovl)
+ (if (featurep 'xemacs) (delete-extent ovl) (delete-overlay ovl)))
+(defun org-detatch-overlay (ovl)
+ (if (featurep 'xemacs) (detach-extent ovl) (delete-overlay ovl)))
+(defun org-move-overlay (ovl beg end &optional buffer)
+ (if (featurep 'xemacs)
+ (set-extent-endpoints ovl beg end buffer)
+ (move-overlay ovl beg end buffer)))
+(defun org-overlay-put (ovl prop value)
+ (if (featurep 'xemacs)
+ (set-extent-property ovl prop value)
+ (overlay-put ovl prop value)))
+
+(defvar org-occur-highlights nil)
+(defun org-highlight-new-match (beg end)
+ "Highlight from BEG to END and mark the highlight is an occur headline."
+ (let ((ov (org-make-overlay beg end)))
+ (org-overlay-put ov 'face 'secondary-selection)
+ (push ov org-occur-highlights)))
+
+(defun org-remove-occur-highlights (&optional beg end noremove)
+ "Remove the occur highlights from the buffer.
+BEG and END are ignored. If NOREMOVE is nil, remove this function
+from the `before-change-functions' in the current buffer."
+ (interactive)
+ (mapc 'org-delete-overlay org-occur-highlights)
+ (setq org-occur-highlights nil)
+ (unless noremove
+ (remove-hook 'before-change-functions
+ 'org-remove-occur-highlights 'local)))
;;; Priorities
"Insert an inactive time stamp.
An inactive time stamp is enclosed in square brackets instead of angle
brackets. It is inactive in the sense that it does not trigger agenda entries,
-does not link to the calendar and cannot be changed with the S-cursor keys."
+does not link to the calendar and cannot be changed with the S-cursor keys.
+So these are more for recording a certain time/date."
(interactive "P")
(let ((fmt (if arg (cdr org-time-stamp-formats)
(car org-time-stamp-formats)))
(setq fmt (concat "[" (substring fmt 1 -1) "]"))
(insert (format-time-string fmt time))))
-;;; FIXME: Make the function take "Fri" as "next friday"
+(defvar org-date-ovl (org-make-overlay 1 1))
+(org-overlay-put org-date-ovl 'face 'org-warning)
+(org-detatch-overlay org-date-ovl)
+
(defun org-read-date (&optional with-time to-time)
"Read a date and make things smooth for the user.
The prompt will suggest to enter an ISO date, but you can also enter anything
which will at least partially be understood by `parse-time-string'.
-Unrecognized parts of the date will default to the current day, month ,year,
+Unrecognized parts of the date will default to the current day, month, year,
hour and minute. For example,
3-2-5 --> 2003-02-05
feb 15 --> currentyear-02-15
12:45 --> today 12:45
22 sept 0:34 --> currentyear-09-22 0:34
12 --> currentyear-currentmonth-12
+ Fri --> nearest Friday (today or later)
etc.
The function understands only English month and weekday abbreviations,
but this can be configured with the variables `parse-time-months' and
While prompting, a calendar is popped up - you can also select the
date with the mouse (button 1). The calendar shows a period of three
-month. To scroll it to other months, use the keys `>' and `<'.
+months. To scroll it to other months, use the keys `>' and `<'.
If you don't like the calendar, turn it off with
- \(setq org-popup-calendar-for-date-prompt nil).
+ \(setq org-popup-calendar-for-date-prompt nil)
With optional argument TO-TIME, the date will immediately be converted
to an internal time.
enter a time, and this function will inform the calling routine about
this change. The calling routine may then choose to change the format
used to insert the time stamp into the buffer to include the time."
- (let* ((default-time
+ (require 'parse-time)
+ (let* ((org-time-stamp-rounding-minutes
+ (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
+ (ct (org-current-time))
+ (default-time
;; Default time is either today, or, when entering a range,
;; the range start.
(if (save-excursion
(- (point) 20) t))
(apply
'encode-time
- (mapcar (lambda(x) (or x 0)) ;; FIXME: Problem with timezone?
+ (mapcar (lambda(x) (or x 0))
(parse-time-string (match-string 1))))
- (current-time)))
+ ct))
+ (calendar-move-hook nil)
+ (view-diary-entries-initially nil)
(timestr (format-time-string
(if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") default-time))
(prompt (format "YYYY-MM-DD [%s]: " timestr))
ans ans1 ans2
- second minute hour day month year tl)
+ second minute hour day month year tl wday wday1)
(if org-popup-calendar-for-date-prompt
- ;; Also show a calendar for date selection
- ;; Copied (with modifications) from planner.el by John Wiegley
(save-excursion
(save-window-excursion
(calendar)
(calendar-forward-day (- (time-to-days default-time)
(calendar-absolute-from-gregorian
(calendar-current-date))))
+ (org-eval-in-calendar nil)
(let* ((old-map (current-local-map))
(map (copy-keymap calendar-mode-map))
(minibuffer-local-map (copy-keymap minibuffer-local-map)))
(define-key map (kbd "RET") 'org-calendar-select)
- (define-key map (if org-xemacs-p [button1] [mouse-1])
- 'org-calendar-select)
+ (define-key map (if (featurep 'xemacs) [button1] [mouse-1])
+ 'org-calendar-select-mouse)
+ (define-key map (if (featurep 'xemacs) [button2] [mouse-2])
+ 'org-calendar-select-mouse)
(define-key minibuffer-local-map [(meta shift left)]
(lambda () (interactive)
(org-eval-in-calendar '(calendar-backward-month 1))))
(progn
(use-local-map map)
(setq ans (read-string prompt "" nil nil))
- (setq ans (or ans1 ans2 ans)))
+ (if (not (string-match "\\S-" ans)) (setq ans nil))
+ (setq ans (or ans1 ans ans2)))
(use-local-map old-map)))))
;; Naked prompt only
(setq ans (read-string prompt "" nil timestr)))
+ (org-detatch-overlay org-date-ovl)
(if (string-match
"^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
month (string-to-number (match-string 3 ans))
day (string-to-number (match-string 4 ans)))
(if (< year 100) (setq year (+ 2000 year)))
- (setq ans (replace-match (format "%04d-%02d-%02d" year month day)
- t t ans))))
+ (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
+ t nil ans))))
(setq tl (parse-time-string ans)
- year (or (nth 5 tl) (string-to-number (format-time-string "%Y")))
- month (or (nth 4 tl) (string-to-number (format-time-string "%m")))
- day (or (nth 3 tl) (string-to-number (format-time-string "%d")))
- hour (or (nth 2 tl) (string-to-number (format-time-string "%H")))
- minute (or (nth 1 tl) (string-to-number (format-time-string "%M")))
- second (or (nth 0 tl) 0))
+ year (or (nth 5 tl) (string-to-number (format-time-string "%Y" ct)))
+ month (or (nth 4 tl) (string-to-number (format-time-string "%m" ct)))
+ day (or (nth 3 tl) (string-to-number (format-time-string "%d" ct)))
+ hour (or (nth 2 tl) (string-to-number (format-time-string "%H" ct)))
+ minute (or (nth 1 tl) (string-to-number (format-time-string "%M" ct)))
+ second (or (nth 0 tl) 0)
+ wday (nth 6 tl))
+ (when (and wday (not (nth 3 tl)))
+ ;; Weekday was given, but no day, so pick that day in the week
+ ;; on or after the derived date.
+ (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
+ (unless (equal wday wday1)
+ (setq day (+ day (% (- wday wday1 -7) 7)))))
(if (and (boundp 'org-time-was-given)
(nth 2 tl))
(setq org-time-was-given t))
(let* ((date (calendar-cursor-to-date))
(time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
(setq ans2 (format-time-string "%Y-%m-%d" time))))
+ (org-move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
(select-window sw)))
(defun org-calendar-select ()
(setq ans1 (format-time-string "%Y-%m-%d" time)))
(if (active-minibuffer-window) (exit-minibuffer))))
+(defun org-calendar-select-mouse (ev)
+ "Return to `org-read-date' with the date currently selected.
+This is used by `org-read-date' in a temporary keymap for the calendar buffer."
+ (interactive "e")
+ (mouse-set-point ev)
+ (when (calendar-cursor-to-date)
+ (let* ((date (calendar-cursor-to-date))
+ (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
+ (setq ans1 (format-time-string "%Y-%m-%d" time)))
+ (if (active-minibuffer-window) (exit-minibuffer))))
+
(defun org-check-deadlines (ndays)
"Check if there are any deadlines due or past due.
A deadline is considered due if it happens within `org-deadline-warning-days'
(fd1 "%dd")
(fh "%02d:%02d")
y d h m align)
- ;; FIXME: Should I re-introduce years, make year refer to same date?
- ;; This would be the only useful way to have years, actually.
(if havetime
(setq ; y (floor (/ diff ys)) diff (mod diff ys)
y 0
"Increase the date in the time stamp by one day.
With prefix ARG, change that many days."
(interactive "p")
- (org-timestamp-change (prefix-numeric-value arg) 'day))
+ (if (and (not (org-at-timestamp-p))
+ (org-on-heading-p))
+ (org-todo 'up)
+ (org-timestamp-change (prefix-numeric-value arg) 'day)))
(defun org-timestamp-down-day (&optional arg)
"Decrease the date in the time stamp by one day.
With prefix ARG, change that many days."
(interactive "p")
- (org-timestamp-change (- (prefix-numeric-value arg)) 'day))
+ (if (and (not (org-at-timestamp-p))
+ (org-on-heading-p))
+ (org-todo 'down)
+ (org-timestamp-change (- (prefix-numeric-value arg)) 'day)))
(defsubst org-pos-in-match-range (pos n)
(and (match-beginning n)
(>= (match-end n) pos)))
(defun org-at-timestamp-p ()
- "Determine if the cursor is or at a timestamp."
+ "Determine if the cursor is in or at a timestamp."
(interactive)
(let* ((tsr org-ts-regexp2)
(pos (point))
(defun org-recenter-calendar (date)
"If the calendar is visible, recenter it to DATE."
(let* ((win (selected-window))
- (cwin (get-buffer-window "*Calendar*" t)))
+ (cwin (get-buffer-window "*Calendar*" t))
+ (calendar-move-hook nil))
(when cwin
(select-window cwin)
(calendar-goto-date (if (listp date) date
(defun org-goto-calendar (&optional arg)
"Go to the Emacs calendar at the current date.
If there is a time stamp in the current line, go to that date.
-A prefix ARG can be used force the current date."
+A prefix ARG can be used to force the current date."
(interactive "P")
- (let ((tsr org-ts-regexp) diff)
+ (let ((tsr org-ts-regexp) diff
+ (calendar-move-hook nil)
+ (view-diary-entries-initially nil))
(if (or (org-at-timestamp-p)
(save-excursion
(beginning-of-line 1)
(defvar org-agenda-mode-map (make-sparse-keymap)
"Keymap for `org-agenda-mode'.")
-(defvar org-agenda-menu)
+(defvar org-agenda-menu) ; defined later in this file.
(defvar org-agenda-follow-mode nil)
+(defvar org-agenda-show-log nil)
(defvar org-agenda-buffer-name "*Org Agenda*")
(defvar org-agenda-redo-command nil)
(defvar org-agenda-mode-hook nil)
+(defvar org-agenda-type nil)
+(defvar org-agenda-force-single-file nil)
;;;###autoload
(defun org-agenda-mode ()
(use-local-map org-agenda-mode-map)
(easy-menu-add org-agenda-menu)
(if org-startup-truncated (setq truncate-lines t))
- (add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
- (add-hook 'pre-command-hook 'org-unhighlight nil 'local)
- (setq org-agenda-follow-mode nil)
+ (org-add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
+ (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
+ (unless org-agenda-keep-modes
+ (setq org-agenda-follow-mode nil
+ org-agenda-show-log nil))
(easy-menu-change
'("Agenda") "Agenda Files"
(append
(list
- ["Edit File List" (customize-variable 'org-agenda-files) t]
+ (vector
+ (if (get 'org-agenda-files 'org-restrict)
+ "Restricted to single file"
+ "Edit File List")
+ '(org-edit-agenda-file-list)
+ (not (get 'org-agenda-files 'org-restrict)))
"--")
- (mapcar 'org-file-menu-entry org-agenda-files)))
+ (mapcar 'org-file-menu-entry (org-agenda-files))))
(org-agenda-set-mode-name)
(apply
(if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
- org-agenda-mode-hook))
+ (list 'org-agenda-mode-hook)))
(define-key org-agenda-mode-map "\C-i" 'org-agenda-goto)
+(define-key org-agenda-mode-map [(tab)] 'org-agenda-goto)
(define-key org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
(define-key org-agenda-mode-map " " 'org-agenda-show)
(define-key org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
(define-key org-agenda-mode-map "o" 'delete-other-windows)
-(define-key org-agenda-mode-map "l" 'org-agenda-recenter)
+(define-key org-agenda-mode-map "L" 'org-agenda-recenter)
(define-key org-agenda-mode-map "t" 'org-agenda-todo)
+(define-key org-agenda-mode-map ":" 'org-agenda-set-tags)
(define-key org-agenda-mode-map "." 'org-agenda-goto-today)
(define-key org-agenda-mode-map "d" 'org-agenda-day-view)
(define-key org-agenda-mode-map "w" 'org-agenda-week-view)
(int-to-string (pop l)) 'digit-argument)))
(define-key org-agenda-mode-map "f" 'org-agenda-follow-mode)
+(define-key org-agenda-mode-map "l" 'org-agenda-log-mode)
(define-key org-agenda-mode-map "D" 'org-agenda-toggle-diary)
(define-key org-agenda-mode-map "g" 'org-agenda-toggle-time-grid)
(define-key org-agenda-mode-map "r" 'org-agenda-redo)
(define-key org-agenda-mode-map "q" 'org-agenda-quit)
(define-key org-agenda-mode-map "x" 'org-agenda-exit)
(define-key org-agenda-mode-map "P" 'org-agenda-show-priority)
+(define-key org-agenda-mode-map "T" 'org-agenda-show-tags)
(define-key org-agenda-mode-map "n" 'next-line)
(define-key org-agenda-mode-map "p" 'previous-line)
(define-key org-agenda-mode-map "\C-n" 'org-agenda-next-date-line)
(define-key org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
(define-key org-agenda-mode-map [(right)] 'org-agenda-later)
(define-key org-agenda-mode-map [(left)] 'org-agenda-earlier)
-
+(define-key org-agenda-mode-map "\C-c\C-x\C-c" 'org-export-icalendar-combine-agenda-files)
(defvar org-agenda-keymap (copy-keymap org-agenda-mode-map)
"Local keymap for agenda entries from Org-mode.")
(define-key org-agenda-keymap
- (if org-xemacs-p [(button2)] [(mouse-2)]) 'org-agenda-goto-mouse)
+ (if (featurep 'xemacs) [(button2)] [(mouse-2)]) 'org-agenda-goto-mouse)
(define-key org-agenda-keymap
- (if org-xemacs-p [(button3)] [(mouse-3)]) 'org-agenda-show-mouse)
-
+ (if (featurep 'xemacs) [(button3)] [(mouse-3)]) 'org-agenda-show-mouse)
+(define-key org-agenda-keymap [follow-link] 'mouse-face)
(easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
'("Agenda"
("Agenda Files")
:style toggle :selected org-agenda-follow-mode :active t]
"--"
["Cycle TODO" org-agenda-todo t]
+ ("Tags"
+ ["Show all Tags" org-agenda-show-tags t]
+ ["Set Tags" org-agenda-set-tags t])
("Reschedule"
- ["Reschedule +1 day" org-agenda-date-later t]
- ["Reschedule -1 day" org-agenda-date-earlier t]
+ ["Reschedule +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
+ ["Reschedule -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
"--"
- ["Reschedule to ..." org-agenda-date-prompt t])
+ ["Reschedule to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
("Priority"
["Set Priority" org-agenda-priority t]
["Increase Priority" org-agenda-priority-up t]
["Decrease Priority" org-agenda-priority-down t]
["Show Priority" org-agenda-show-priority t])
"--"
+ ;; ["New agenda command" org-agenda t]
["Rebuild buffer" org-agenda-redo t]
- ["Goto Today" org-agenda-goto-today t]
- ["Next Dates" org-agenda-later (local-variable-p 'starting-day)]
- ["Previous Dates" org-agenda-earlier (local-variable-p 'starting-day)]
"--"
- ["Day View" org-agenda-day-view :active (local-variable-p 'starting-day)
+ ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
+ ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
+ ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
+ "--"
+ ["Day View" org-agenda-day-view :active (org-agenda-check-type nil 'agenda)
:style radio :selected (equal org-agenda-ndays 1)]
- ["Week View" org-agenda-week-view :active (local-variable-p 'starting-day)
+ ["Week View" org-agenda-week-view :active (org-agenda-check-type nil 'agenda)
:style radio :selected (equal org-agenda-ndays 7)]
"--"
+ ["Show Logbook entries" org-agenda-log-mode
+ :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
["Include Diary" org-agenda-toggle-diary
- :style toggle :selected org-agenda-include-diary :active t]
+ :style toggle :selected org-agenda-include-diary :active (org-agenda-check-type nil 'agenda)]
["Use Time Grid" org-agenda-toggle-time-grid
- :style toggle :selected org-agenda-use-time-grid :active t]
+ :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)]
"--"
- ["New Diary Entry" org-agenda-diary-entry t]
+ ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
("Calendar Commands"
- ["Goto Calendar" org-agenda-goto-calendar t]
- ["Phases of the Moon" org-agenda-phases-of-moon t]
- ["Sunrise/Sunset" org-agenda-sunrise-sunset t]
- ["Holidays" org-agenda-holidays t]
- ["Convert" org-agenda-convert-date t])
+ ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
+ ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
+ ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
+ ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
+ ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)])
+ ["Create iCalendar file" org-export-icalendar-combine-agenda-files t]
"--"
["Quit" org-agenda-quit t]
["Exit and Release Buffers" org-agenda-exit t]
))
+;;;###autoload
+(defun org-agenda (arg)
+ "Dispatch agenda commands to collect entries to the agenda buffer.
+Prompts for a character to select a command. Any prefix arg will be passed
+on to the selected command. The default selections are:
+
+a Call `org-agenda' to display the agenda for the current day or week.
+t Call `org-todo-list' to display the global todo list.
+T Call `org-todo-list' to display the global todo list, select only
+ entries with a specific TODO keyword (the user gets a prompt).
+m Call `org-tags-view' to display headlines with tags matching
+ a condition (the user is prompted for the condition).
+M Like `m', but select only TODO entries, no ordinary headlines.
+
+More commands can be added by configuring the variable
+`org-agenda-custom-commands'. In particular, specific tags and TODO keyword
+searches can be pre-defined in this way.
+
+If the current buffer is in Org-mode and visiting a file, you can also
+first press `1' to indicate that the agenda should be temporarily (until the
+next use of \\[org-agenda]) restricted to the current file."
+ (interactive "P")
+ (catch 'exit
+ (let ((restrict-ok (and buffer-file-name (eq major-mode 'org-mode)))
+ (custom org-agenda-custom-commands)
+ c entry key type string)
+ (put 'org-agenda-files 'org-restrict nil)
+ (save-window-excursion
+ (delete-other-windows)
+ (switch-to-buffer-other-window " *Agenda Commands*")
+ (erase-buffer)
+ (insert
+ "Press key for an agenda command:
+--------------------------------
+a Agenda for current week or day
+t List of all TODO entries T Entries with special TODO kwd
+m Match a TAGS query M Like m, but only TODO entries
+C Configure your own agenda commands")
+ (while (setq entry (pop custom))
+ (setq key (car entry) type (nth 1 entry) string (nth 2 entry))
+ (insert (format "\n%-4s%-14s: %s"
+ key
+ (cond
+ ((eq type 'tags) "Tags query")
+ ((eq type 'todo) "TODO keyword")
+ ((eq type 'tags-tree) "Tags tree")
+ ((eq type 'todo-tree) "TODO kwd tree")
+ ((eq type 'occur-tree) "Occur tree")
+ (t "???"))
+ (org-add-props string nil 'face 'org-warning))))
+ (goto-char (point-min))
+ (if (fboundp 'fit-window-to-buffer) (fit-window-to-buffer))
+ (message "Press key for agenda command%s"
+ (if restrict-ok ", or [1] to restrict to current file" ""))
+ (setq c (read-char-exclusive))
+ (message "")
+ (when (equal c ?1)
+ (if restrict-ok
+ (put 'org-agenda-files 'org-restrict (list buffer-file-name))
+ (error "Cannot restrict agenda to current buffer"))
+ (message "Press key for agenda command%s"
+ (if restrict-ok " (restricted to current file)" ""))
+ (setq c (read-char-exclusive))
+ (message "")))
+ (require 'calendar) ; FIXME: can we avoid this for some commands?
+ ;; For example the todo list should not need it (but does...)
+ (cond
+ ((equal c ?C) (customize-variable 'org-agenda-custom-commands))
+ ((equal c ?a) (call-interactively 'org-agenda-list))
+ ((equal c ?t) (call-interactively 'org-todo-list))
+ ((equal c ?T)
+ (setq current-prefix-arg (or arg '(4)))
+ (call-interactively 'org-todo-list))
+ ((equal c ?m) (call-interactively 'org-tags-view))
+ ((equal c ?M)
+ (setq current-prefix-arg (or arg '(4)))
+ (call-interactively 'org-tags-view))
+ ((setq entry (assoc (char-to-string c) org-agenda-custom-commands))
+ (setq type (nth 1 entry) string (nth 2 entry))
+ (cond
+ ((eq type 'tags)
+ (org-tags-view current-prefix-arg string))
+ ((eq type 'todo)
+ (org-todo-list string))
+ ((eq type 'tags-tree)
+ (org-check-for-org-mode)
+ (org-tags-sparse-tree current-prefix-arg string))
+ ((eq type 'todo-tree)
+ (org-check-for-org-mode)
+ (org-occur (concat "^" outline-regexp "[ \t]*"
+ (regexp-quote string) "\\>")))
+ ((eq type 'occur-tree)
+ (org-check-for-org-mode)
+ (org-occur string))
+ (t (error "Invalid custom agenda command type %s" type))))
+ (t (error "Invalid key"))))))
+
+(defun org-check-for-org-mode ()
+ "Make sure current buffer is in org-mode. Error if not."
+ (or (eq major-mode 'org-mode)
+ (error "Cannot execute org-mode agenda command on buffer in %s."
+ major-mode)))
+
+(defun org-fit-agenda-window ()
+ "Fit the window to the buffer size."
+ (and org-fit-agenda-window
+ (fboundp 'fit-window-to-buffer)
+ (fit-window-to-buffer nil (/ (* (frame-height) 3) 4)
+ (/ (frame-height) 2))))
+
+(defun org-agenda-files (&optional unrestricted)
+ "Get the list of agenda files.
+Optional UNRESTRICTED means return the full list even if a restriction
+is currently in place."
+ (cond
+ ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
+ ((stringp org-agenda-files) (org-read-agenda-file-list))
+ ((listp org-agenda-files) org-agenda-files)
+ (t (error "Invalid value of `org-agenda-files'"))))
+
+(defvar org-window-configuration)
+
+(defun org-edit-agenda-file-list ()
+ "Edit the list of agenda files.
+Depending on setup, this either uses customize to edit the variable
+`org-agenda-files', or it visits the file that is holding the list. In the
+latter case, the buffer is set up in a way that saving it automatically kills
+the buffer and restores the previous window configuration."
+ (interactive)
+ (if (stringp org-agenda-files)
+ (let ((cw (current-window-configuration)))
+ (find-file org-agenda-files)
+ (set (make-local-variable 'org-window-configuration) cw)
+ (org-add-hook 'after-save-hook
+ (lambda ()
+ (set-window-configuration
+ (prog1 org-window-configuration
+ (kill-buffer (current-buffer))))
+ (org-install-agenda-files-menu)
+ (message "New agenda file list installed"))
+ nil 'local)
+ (message (substitute-command-keys
+ "Edit list and finish with \\[save-buffer]")))
+ (customize-variable 'org-agenda-files)))
+
+(defun org-store-new-agenda-file-list (list)
+ "Set new value for the agenda file list and save it correcly."
+ (if (stringp org-agenda-files)
+ (let ((f org-agenda-files) b)
+ (while (setq b (find-buffer-visiting f)) (kill-buffer b))
+ (with-temp-file f
+ (insert (mapconcat 'identity list "\n") "\n")))
+ (let ((org-mode-hook nil) (default-major-mode 'fundamental-mode))
+ (setq org-agenda-files list)
+ (customize-save-variable 'org-agenda-files org-agenda-files))))
+
+(defun org-read-agenda-file-list ()
+ "Read the list of agenda files from a file."
+ (when (stringp org-agenda-files)
+ (with-temp-buffer
+ (insert-file-contents org-agenda-files)
+ (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*"))))
+
(defvar org-agenda-markers nil
"List of all currently active markers created by `org-agenda'.")
(defvar org-agenda-last-marker-time (time-to-seconds (current-time))
(defvar org-respect-restriction nil) ; Dynamically-scoped param.
-(defun org-timeline (&optional include-all)
+(defun org-timeline (&optional include-all keep-modes)
"Show a time-sorted view of the entries in the current org file.
Only entries with a time stamp of today or later will be listed. With
-one \\[universal-argument] prefix argument, past entries will also be listed.
-With two \\[universal-argument] prefixes, all unfinished TODO items will also be shown,
+\\[universal-argument] prefix, all unfinished TODO items will also be shown,
under the current date.
If the buffer contains an active region, only check the region for
dates."
(require 'calendar)
(org-agenda-maybe-reset-markers 'force)
(org-compile-prefix-format org-timeline-prefix-format)
- (let* ((dopast include-all)
- (dotodo (equal include-all '(16)))
- (entry (buffer-file-name))
- (org-agenda-files (list (buffer-file-name)))
+ (let* ((dopast t)
+ (dotodo include-all)
+ (doclosed org-agenda-show-log)
+ (org-agenda-keep-modes keep-modes)
+ (entry buffer-file-name)
+ (org-agenda-files (list buffer-file-name))
(date (calendar-current-date))
(win (selected-window))
(pos1 (point))
(beg (if (org-region-active-p) (region-beginning) (point-min)))
(end (if (org-region-active-p) (region-end) (point-max)))
(day-numbers (org-get-all-dates beg end 'no-ranges
- t)) ; always include today
+ t doclosed)) ; always include today
(today (time-to-days (current-time)))
(org-respect-restriction t)
(past t)
+ args
s e rtn d)
(setq org-agenda-redo-command
(list 'progn
(list 'switch-to-buffer-other-window (current-buffer))
- (list 'org-timeline (list 'quote include-all))))
+ (list 'org-timeline (list 'quote include-all) t)))
(if (not dopast)
;; Remove past dates from the list of dates.
(setq day-numbers (delq nil (mapcar (lambda(x)
(setq buffer-read-only nil)
(erase-buffer)
(org-agenda-mode) (setq buffer-read-only nil)
+ (set (make-local-variable 'org-agenda-type) 'timeline)
+ (if doclosed (push :closed args))
+ (push :timestamp args)
+ (if dotodo (push :todo args))
(while (setq d (pop day-numbers))
(if (and (>= d today)
dopast
(insert (make-string 79 ?-) "\n")))
(setq date (calendar-gregorian-from-absolute d))
(setq s (point))
- (if dotodo
- (setq rtn (org-agenda-get-day-entries
- entry date :todo :timestamp))
- (setq rtn (org-agenda-get-day-entries entry date :timestamp)))
+ (setq rtn (apply 'org-agenda-get-day-entries
+ entry date args))
(if (or rtn (equal d today))
(progn
(insert (calendar-day-name date) " "
(calendar-month-name (extract-calendar-month date)) " "
(number-to-string (extract-calendar-year date)) "\n")
(put-text-property s (1- (point)) 'face
- 'org-link)
+ 'org-level-3)
(if (equal d today)
(put-text-property s (1- (point)) 'org-today t))
(insert (org-finalize-agenda-entries rtn) "\n")
(goto-char pos1))))
;;;###autoload
-(defun org-agenda (&optional include-all start-day ndays)
+(defun org-agenda-list (&optional include-all start-day ndays keep-modes)
"Produce a weekly view from all files in variable `org-agenda-files'.
The view will be for the current week, but from the overview buffer you
will be able to go to other weeks.
With one \\[universal-argument] prefix argument INCLUDE-ALL, all unfinished TODO items will
also be shown, under the current date.
+With two \\[universal-argument] prefix argument INCLUDE-ALL, all TODO entries marked DONE
+on the days are also shown. See the variable `org-log-done' for how
+to turn on logging.
START-DAY defaults to TODAY, or to the most recent match for the weekday
given in `org-agenda-start-on-weekday'.
NDAYS defaults to `org-agenda-ndays'."
(if (or (equal ndays 1)
(and (null ndays) (equal 1 org-agenda-ndays)))
nil org-agenda-start-on-weekday))
- (files (copy-sequence org-agenda-files))
+ (org-agenda-keep-modes keep-modes)
+ (thefiles (org-agenda-files))
+ (files thefiles)
(win (selected-window))
(today (time-to-days (current-time)))
(sd (or start-day today))
(d (- nt n1)))
(- sd (+ (if (< d 0) 7 0) d)))))
(day-numbers (list start))
- (inhibit-redisplay t)
+;FIXME (inhibit-redisplay t)
s e rtn rtnall file date d start-pos end-pos todayp nd)
(setq org-agenda-redo-command
- (list 'org-agenda (list 'quote include-all) start-day ndays))
+ (list 'org-agenda-list (list 'quote include-all) start-day ndays t))
;; Make the list of days
(setq ndays (or ndays org-agenda-ndays)
nd ndays)
(setq buffer-read-only nil)
(erase-buffer)
(org-agenda-mode) (setq buffer-read-only nil)
+ (set (make-local-variable 'org-agenda-type) 'agenda)
(set (make-local-variable 'starting-day) (car day-numbers))
(set (make-local-variable 'include-all-loc) include-all)
(when (and (or include-all org-agenda-include-all-todo)
(member today day-numbers))
- (setq files org-agenda-files
+ (setq files thefiles
rtnall nil)
(while (setq file (pop files))
(catch 'nextfile
(when rtnall
(insert "ALL CURRENTLY OPEN TODO ITEMS:\n")
(add-text-properties (point-min) (1- (point))
- (list 'face 'org-link))
+ (list 'face 'org-level-3))
(insert (org-finalize-agenda-entries rtnall) "\n")))
(while (setq d (pop day-numbers))
(setq date (calendar-gregorian-from-absolute d)
(setq start-pos (point))
(if (and start-pos (not end-pos))
(setq end-pos (point))))
- (setq files org-agenda-files
+ (setq files thefiles
rtnall nil)
(while (setq file (pop files))
(catch 'nextfile
(org-check-agenda-file file)
- (setq rtn (org-agenda-get-day-entries file date))
+ (if org-agenda-show-log
+ (setq rtn (org-agenda-get-day-entries
+ file date
+ :deadline :scheduled :timestamp :closed))
+ (setq rtn (org-agenda-get-day-entries
+ file date
+ :deadline :scheduled :timestamp)))
(setq rtnall (append rtnall rtn))))
(if org-agenda-include-diary
(progn
(calendar-month-name (extract-calendar-month date))
(extract-calendar-year date)))
(put-text-property s (1- (point)) 'face
- 'org-link)
+ 'org-level-3)
(if rtnall (insert
- (org-finalize-agenda-entries ;; FIXME: condition needed
+ (org-finalize-agenda-entries
(org-agenda-add-time-grid-maybe
rtnall nd todayp))
"\n"))
(put-text-property s (1- (point)) 'day d))))
(goto-char (point-min))
(setq buffer-read-only t)
- (if org-fit-agenda-window
- (fit-window-to-buffer nil (/ (* (frame-height) 3) 4)
- (/ (frame-height) 2)))
+ (org-fit-agenda-window)
(unless (and (pos-visible-in-window-p (point-min))
(pos-visible-in-window-p (point-max)))
(goto-char (1- (point-max)))
(if (not org-select-agenda-window) (select-window win))
(message "")))
+(defvar org-select-this-todo-keyword nil)
+
+;;;###autoload
+(defun org-todo-list (arg &optional keep-modes)
+ "Show all TODO entries from all agenda file in a single list.
+The prefix arg can be used to select a specific TODO keyword and limit
+the list to these. When using \\[universal-argument], you will be prompted
+for a keyword. A numeric prefix directly selects the Nth keyword in
+`org-todo-keywords'."
+ (interactive "P")
+ (org-agenda-maybe-reset-markers 'force)
+ (org-compile-prefix-format org-agenda-prefix-format)
+ (let* ((org-agenda-keep-modes keep-modes)
+ (today (time-to-days (current-time)))
+ (date (calendar-gregorian-from-absolute today))
+ (win (selected-window))
+ (kwds org-todo-keywords)
+ (completion-ignore-case t)
+ (org-select-this-todo-keyword
+ (if (stringp arg) arg
+ (and arg (integerp arg) (nth (1- arg) org-todo-keywords))))
+ rtn rtnall files file pos)
+ (when (equal arg '(4))
+ (setq org-select-this-todo-keyword
+ (completing-read "Keyword: " (mapcar 'list org-todo-keywords)
+ nil t)))
+ (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
+ (if (not (equal (current-buffer) (get-buffer org-agenda-buffer-name)))
+ (progn
+ (delete-other-windows)
+ (switch-to-buffer-other-window
+ (get-buffer-create org-agenda-buffer-name))))
+ (setq buffer-read-only nil)
+ (erase-buffer)
+ (org-agenda-mode) (setq buffer-read-only nil)
+ (set (make-local-variable 'org-agenda-type) 'todo)
+ (set (make-local-variable 'last-arg) arg)
+ (set (make-local-variable 'org-todo-keywords) kwds)
+ (set (make-local-variable 'org-agenda-redo-command)
+ '(org-todo-list (or current-prefix-arg last-arg) t))
+ (setq files (org-agenda-files)
+ rtnall nil)
+ (while (setq file (pop files))
+ (catch 'nextfile
+ (org-check-agenda-file file)
+ (setq rtn (org-agenda-get-day-entries file date :todo))
+ (setq rtnall (append rtnall rtn))))
+ (insert "Global list of TODO items of type: ")
+ (add-text-properties (point-min) (1- (point))
+ (list 'face 'org-level-3))
+ (setq pos (point))
+ (insert (or org-select-this-todo-keyword "ALL") "\n")
+ (add-text-properties pos (1- (point)) (list 'face 'org-warning))
+ (setq pos (point))
+ (insert
+ "Available with `N r': (0)ALL "
+ (let ((n 0))
+ (mapconcat (lambda (x)
+ (format "(%d)%s" (setq n (1+ n)) x))
+ org-todo-keywords " "))
+ "\n")
+ (add-text-properties pos (1- (point)) (list 'face 'org-level-3))
+ (when rtnall
+ (insert (org-finalize-agenda-entries rtnall) "\n"))
+ (goto-char (point-min))
+ (setq buffer-read-only t)
+ (org-fit-agenda-window)
+ (if (not org-select-agenda-window) (select-window win))))
+
(defun org-check-agenda-file (file)
"Make sure FILE exists. If not, ask user what to do."
- ;; FIXME: this does not correctly change the menus
- ;; Could probably be fixed by explicitly going to the buffer.
(when (not (file-exists-p file))
- (message "non-existent file %s. [R]emove from agenda-files or [A]bort?"
- file)
+ (message "non-existent file %s. [R]emove from list or [A]bort?"
+ (abbreviate-file-name file))
(let ((r (downcase (read-char-exclusive))))
(cond
((equal r ?r)
(throw 'nextfile t))
(t (error "Abort"))))))
+(defun org-agenda-check-type (error &rest types)
+ "Check if agenda buffer is of allowed type.
+If ERROR is non-nil, throw an error, otherwise just return nil."
+ (if (memq org-agenda-type types)
+ t
+ (if error
+ (error "Now allowed in %s-type agenda buffers" org-agenda-type)
+ nil)))
+
(defun org-agenda-quit ()
"Exit agenda by removing the window or the buffer."
(interactive)
(org-agenda-quit))
(defun org-agenda-redo ()
- "Rebuild Agenda."
+ "Rebuild Agenda.
+When this is the global TODO list, a prefix argument will be interpreted."
(interactive)
- (eval org-agenda-redo-command))
+ (message "Rebuilding agenda buffer...")
+ (eval org-agenda-redo-command)
+ (message "Rebuilding agenda buffer...done"))
(defun org-agenda-goto-today ()
"Go to today."
(interactive)
+ (org-agenda-check-type t 'timeline 'agenda)
(if (boundp 'starting-day)
(let ((cmd (car org-agenda-redo-command))
(iall (nth 1 org-agenda-redo-command))
- (nday (nth 3 org-agenda-redo-command)))
- (eval (list cmd iall nil nday)))
+ (nday (nth 3 org-agenda-redo-command))
+ (keep (nth 4 org-agenda-redo-command)))
+ (eval (list cmd iall nil nday keep)))
(goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
(point-min)))))
"Go forward in time by `org-agenda-ndays' days.
With prefix ARG, go forward that many times `org-agenda-ndays'."
(interactive "p")
- (unless (boundp 'starting-day)
- (error "Not allowed"))
- (org-agenda (if (boundp 'include-all-loc) include-all-loc nil)
- (+ starting-day (* arg org-agenda-ndays))))
+ (org-agenda-check-type t 'agenda)
+ (org-agenda-list (if (boundp 'include-all-loc) include-all-loc nil)
+ (+ starting-day (* arg org-agenda-ndays)) nil t))
(defun org-agenda-earlier (arg)
"Go back in time by `org-agenda-ndays' days.
With prefix ARG, go back that many times `org-agenda-ndays'."
(interactive "p")
- (unless (boundp 'starting-day)
- (error "Not allowed"))
- (org-agenda (if (boundp 'include-all-loc) include-all-loc nil)
- (- starting-day (* arg org-agenda-ndays))))
+ (org-agenda-check-type t 'agenda)
+ (org-agenda-list (if (boundp 'include-all-loc) include-all-loc nil)
+ (- starting-day (* arg org-agenda-ndays)) nil t))
(defun org-agenda-week-view ()
"Switch to weekly view for agenda."
(interactive)
- (unless (boundp 'starting-day)
- (error "Not allowed"))
+ (org-agenda-check-type t 'agenda)
(setq org-agenda-ndays 7)
- (org-agenda include-all-loc
- (or (get-text-property (point) 'day)
- starting-day))
+ (org-agenda-list include-all-loc
+ (or (get-text-property (point) 'day)
+ starting-day)
+ nil t)
(org-agenda-set-mode-name)
(message "Switched to week view"))
(defun org-agenda-day-view ()
- "Switch to weekly view for agenda."
+ "Switch to daily view for agenda."
(interactive)
- (unless (boundp 'starting-day)
- (error "Not allowed"))
+ (org-agenda-check-type t 'agenda)
(setq org-agenda-ndays 1)
- (org-agenda include-all-loc
- (or (get-text-property (point) 'day)
- starting-day))
+ (org-agenda-list include-all-loc
+ (or (get-text-property (point) 'day)
+ starting-day)
+ nil t)
(org-agenda-set-mode-name)
(message "Switched to day view"))
(defun org-agenda-next-date-line (&optional arg)
"Jump to the next line indicating a date in agenda buffer."
(interactive "p")
+ (org-agenda-check-type t 'agenda 'timeline)
(beginning-of-line 1)
(if (looking-at "^\\S-") (forward-char 1))
(if (not (re-search-forward "^\\S-" nil t arg))
(goto-char (match-beginning 0)))
(defun org-agenda-previous-date-line (&optional arg)
- "Jump to the next line indicating a date in agenda buffer."
+ "Jump to the previous line indicating a date in agenda buffer."
(interactive "p")
+ (org-agenda-check-type t 'agenda 'timeline)
(beginning-of-line 1)
(if (not (re-search-backward "^\\S-" nil t arg))
(error "No previous date before this line in this buffer")))
;; Initialize the highlight
-(defvar org-hl (funcall (if org-xemacs-p 'make-extent 'make-overlay) 1 1))
-(funcall (if org-xemacs-p 'set-extent-property 'overlay-put) org-hl
- 'face 'highlight)
+(defvar org-hl (org-make-overlay 1 1))
+(org-overlay-put org-hl 'face 'highlight)
(defun org-highlight (begin end &optional buffer)
"Highlight a region with overlay."
- (funcall (if org-xemacs-p 'set-extent-endpoints 'move-overlay)
+ (funcall (if (featurep 'xemacs) 'set-extent-endpoints 'move-overlay)
org-hl begin end (or buffer (current-buffer))))
(defun org-unhighlight ()
"Detach overlay INDEX."
- (funcall (if org-xemacs-p 'detach-extent 'delete-overlay) org-hl))
+ (funcall (if (featurep 'xemacs) 'detach-extent 'delete-overlay) org-hl))
(defun org-agenda-follow-mode ()
(message "Follow mode is %s"
(if org-agenda-follow-mode "on" "off")))
+(defun org-agenda-log-mode ()
+ "Toggle log mode in an agenda buffer."
+ (interactive)
+ (org-agenda-check-type t 'agenda 'timeline)
+ (setq org-agenda-show-log (not org-agenda-show-log))
+ (org-agenda-set-mode-name)
+ (org-agenda-redo)
+ (message "Log mode is %s"
+ (if org-agenda-show-log "on" "off")))
+
(defun org-agenda-toggle-diary ()
- "Toggle follow mode in an agenda buffer."
+ "Toggle diary inclusion in an agenda buffer."
(interactive)
+ (org-agenda-check-type t 'agenda)
(setq org-agenda-include-diary (not org-agenda-include-diary))
(org-agenda-redo)
(org-agenda-set-mode-name)
(if org-agenda-include-diary "on" "off")))
(defun org-agenda-toggle-time-grid ()
- "Toggle follow mode in an agenda buffer."
+ "Toggle time grid in an agenda buffer."
(interactive)
+ (org-agenda-check-type t 'agenda)
(setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
(org-agenda-redo)
(org-agenda-set-mode-name)
(if (equal org-agenda-ndays 7) " Week" "")
(if org-agenda-follow-mode " Follow" "")
(if org-agenda-include-diary " Diary" "")
- (if org-agenda-use-time-grid " Grid" "")))
+ (if org-agenda-use-time-grid " Grid" "")
+ (if org-agenda-show-log " Log" "")))
(force-mode-line-update))
(defun org-agenda-post-command-hook ()
(setq entries
(mapcar
(lambda (x)
- (setq x (org-format-agenda-item "" x "Diary" 'time))
+ (setq x (org-format-agenda-item "" x "Diary" nil 'time))
;; Extend the text properties to the beginning of the line
- (add-text-properties
- 0 (length x)
- (text-properties-at (1- (length x)) x)
- x)
- x)
+ (org-add-props x (text-properties-at (1- (length x)) x)))
entries)))))
(defun org-agenda-cleanup-fancy-diary ()
- "Remove unwanted stuff in buffer created by fancy-diary-display.
+ "Remove unwanted stuff in buffer created by `fancy-diary-display'.
This gets rid of the date, the underline under the date, and
the dummy entry installed by `org-mode' to ensure non-empty diary for each
-date. Itt also removes lines that contain only whitespace."
+date. It also removes lines that contain only whitespace."
(goto-char (point-min))
(if (looking-at ".*?:[ \t]*")
(progn
"Make the position visible."
(if (and org-disable-agenda-to-diary ;; called from org-agenda
(stringp string)
- (buffer-file-name))
+ buffer-file-name)
(setq string (org-modify-diary-entry-string string))))))
(defun org-modify-diary-entry-string (string)
"Add text properties to string, allowing org-mode to act on it."
- (add-text-properties
- 0 (length string)
- (list 'mouse-face 'highlight
- 'keymap org-agenda-keymap
- 'help-echo
- (format
- "mouse-2 or RET jump to diary file %s"
- (abbreviate-file-name (buffer-file-name)))
- 'org-agenda-diary-link t
- 'org-marker (org-agenda-new-marker (point-at-bol)))
- string)
- string)
+ (org-add-props string nil
+ 'mouse-face 'highlight
+ 'keymap org-agenda-keymap
+ 'help-echo (format "mouse-2 or RET jump to diary file %s"
+ (abbreviate-file-name buffer-file-name))
+ 'org-agenda-diary-link t
+ 'org-marker (org-agenda-new-marker (point-at-bol))))
(defun org-diary-default-entry ()
"Add a dummy entry to the diary.
(error
(add-to-diary-list original-date "Org-mode dummy" "" nil)))))
-(defun org-add-file (&optional file)
- "Add current file to the list of files in variable `org-agenda-files'.
-These are the files which are being checked for agenda entries.
-Optional argument FILE means, use this file instead of the current.
-It is possible (but not recommended) to add this function to the
-`org-mode-hook'."
+(defun org-cycle-agenda-files ()
+ "Cycle through the files in `org-agenda-files'.
+If the current buffer visits an agenda file, find the next one in the list.
+If the current buffer does not, find the first agenda file."
(interactive)
- (catch 'exit
- (let* ((file (or file (buffer-file-name)
- (if (interactive-p)
- (error "Buffer is not visiting a file")
- (throw 'exit nil))))
- (true-file (file-truename file))
- (afile (abbreviate-file-name file))
- (present (delq nil (mapcar
- (lambda (x)
- (equal true-file (file-truename x)))
- org-agenda-files))))
- (if (not present)
- (progn
- (setq org-agenda-files
- (cons afile org-agenda-files))
- ;; Make sure custom.el does not end up with Org-mode
- (let ((org-mode-hook nil) (default-major-mode 'fundamental-mode))
- (customize-save-variable 'org-agenda-files org-agenda-files))
- (org-install-agenda-files-menu)
- (message "Added file: %s" afile))
- (message "File was already in list: %s" afile)))))
+ (let* ((fs (org-agenda-files t))
+ (files (append fs (list (car fs))))
+ (tcf (if buffer-file-name (file-truename buffer-file-name)))
+ file)
+ (unless files (error "No agenda files"))
+ (catch 'exit
+ (while (setq file (pop files))
+ (if (equal (file-truename file) tcf)
+ (when (car files)
+ (find-file (car files))
+ (throw 'exit t))))
+ (find-file (car fs)))))
+
+(defun org-agenda-file-to-end ()
+ "Move/add the current file to the end of the agenda file list.
+If the file is not present in the list, it is appended to the list. If it is
+present, it is moved there."
+ (interactive)
+ (org-agenda-file-to-front 'to-end))
+
+(defun org-agenda-file-to-front (&optional to-end)
+ "Move/add the current file to the top of the agenda file list.
+If the file is not present in the list, it is added to the front. If it is
+present, it is moved there. With optional argument TO-END, add/move to the
+end of the list."
+ (interactive "P")
+ (let ((file-alist (mapcar (lambda (x)
+ (cons (file-truename x) x))
+ (org-agenda-files t)))
+ (ctf (file-truename buffer-file-name))
+ x had)
+ (setq x (assoc ctf file-alist) had x)
+
+ (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
+ (if to-end
+ (setq file-alist (append (delq x file-alist) (list x)))
+ (setq file-alist (cons x (delq x file-alist))))
+ (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
+ (org-install-agenda-files-menu)
+ (message "File %s to %s of agenda file list"
+ (if had "moved" "added") (if to-end "end" "front"))))
(defun org-remove-file (&optional file)
"Remove current file from the list of files in variable `org-agenda-files'.
These are the files which are being checked for agenda entries.
Optional argument FILE means, use this file instead of the current."
(interactive)
- (let* ((file (or file (buffer-file-name)))
+ (let* ((file (or file buffer-file-name))
(true-file (file-truename file))
(afile (abbreviate-file-name file))
(files (delq nil (mapcar
(if (equal true-file
(file-truename x))
nil x))
- org-agenda-files))))
- (if (not (= (length files) (length org-agenda-files)))
+ (org-agenda-files t)))))
+ (if (not (= (length files) (length (org-agenda-files t))))
(progn
- (setq org-agenda-files files)
- (customize-save-variable 'org-agenda-files org-agenda-files)
+ (org-store-new-agenda-file-list files)
(org-install-agenda-files-menu)
(message "Removed file: %s" afile))
(message "File was not in list: %s" afile))))
(defun org-file-menu-entry (file)
(vector file (list 'find-file file) t))
-(defun org-get-all-dates (beg end &optional no-ranges force-today)
+(defun org-get-all-dates (beg end &optional no-ranges force-today inactive)
"Return a list of all relevant day numbers from BEG to END buffer positions.
If NO-RANGES is non-nil, include only the start and end dates of a range,
not every single day in the range. If FORCE-TODAY is non-nil, make
-sure that TODAY is included in the list."
- (let (dates date day day1 day2 ts1 ts2)
+sure that TODAY is included in the list. If INACTIVE is non-nil, also
+inactive time stamps (those in square brackets) are included."
+ (let ((re (if inactive org-ts-regexp-both org-ts-regexp))
+ dates date day day1 day2 ts1 ts2)
(if force-today
(setq dates (list (time-to-days (current-time)))))
(save-excursion
(goto-char beg)
- (while (re-search-forward org-ts-regexp end t)
+ (while (re-search-forward re end t)
(setq day (time-to-days (org-time-string-to-time
(substring (match-string 1) 0 10))))
(or (memq day dates) (push day dates)))
(setq args (or args '(:deadline :scheduled :timestamp)))
(let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
(list entry)
- org-agenda-files))
+ (org-agenda-files t)))
file rtn results)
;; If this is called during org-agenda, don't return any entries to
;; the calendar. Org Agenda will list these entries itself.
(setq results (append results rtn)))
(if results
(concat (org-finalize-agenda-entries results) "\n"))))
+(defvar org-category-table nil)
+(defun org-get-category-table ()
+ "Get the table of categories and positions in current buffer."
+ (let (tbl)
+ (save-excursion
+ (goto-char (point-min))
+ (while (re-search-forward "\\(^\\|\r\\)#\\+CATEGORY:[ \t]*\\(.*\\)" nil t)
+ (push (cons (point) (org-trim (match-string 2))) tbl)))
+ tbl))
+(defun org-get-category (&optional pos)
+ "Get the category applying to position POS."
+ (if (not org-category-table)
+ (cond
+ ((null org-category)
+ (setq org-category
+ (if buffer-file-name
+ (file-name-sans-extension
+ (file-name-nondirectory buffer-file-name))
+ "???")))
+ ((symbolp org-category) (symbol-name org-category))
+ (t org-category))
+ (let ((tbl org-category-table)
+ (pos (or pos (point))))
+ (while (and tbl (> (caar tbl) pos))
+ (pop tbl))
+ (or (cdar tbl) (cdr (nth (1- (length org-category-table))
+ org-category-table))))))
(defun org-agenda-get-day-entries (file date &rest args)
"Does the work for `org-diary' and `org-agenda'.
(setq args (or args '(:deadline :scheduled :timestamp)))
(let* ((org-startup-with-deadline-check nil)
(org-startup-folded nil)
+ (org-startup-align-all-tables nil)
(buffer (if (file-exists-p file)
(org-get-agenda-file-buffer file)
(error "No such file %s" file)))
(with-current-buffer buffer
(unless (eq major-mode 'org-mode)
(error "Agenda file %s is not in `org-mode'" file))
+ (setq org-category-table (org-get-category-table))
(let ((case-fold-search nil))
(save-excursion
(save-restriction
((eq arg :scheduled)
(setq rtn (org-agenda-get-scheduled))
(setq results (append results rtn)))
+ ((eq arg :closed)
+ (setq rtn (org-agenda-get-closed))
+ (setq results (append results rtn)))
((and (eq arg :deadline)
(equal date (calendar-current-date)))
(setq rtn (org-agenda-get-deadlines))
'keymap org-agenda-keymap
'help-echo
(format "mouse-2 or RET jump to org file %s"
- (abbreviate-file-name (buffer-file-name)))))
- (regexp (concat "[\n\r]\\*+ *\\(" org-not-done-regexp
+ (abbreviate-file-name buffer-file-name))))
+ (regexp (concat "[\n\r]\\*+ *\\("
+ (if org-select-this-todo-keyword
+ (concat "\\<\\(" org-select-this-todo-keyword
+ "\\)\\>")
+ org-not-done-regexp)
"[^\n\r]*\\)"))
- marker priority
+ marker priority category tags
ee txt)
(goto-char (point-min))
(while (re-search-forward regexp nil t)
(goto-char (match-beginning 1))
- (setq marker (org-agenda-new-marker (point-at-bol))
- txt (org-format-agenda-item "" (match-string 1))
+ (setq marker (org-agenda-new-marker (1+ (match-beginning 0)))
+ category (org-get-category)
+ tags (org-get-tags-at (point))
+ txt (org-format-agenda-item "" (match-string 1) category tags)
priority
(+ (org-get-priority txt)
(if org-todo-kwd-priority-p
- (- org-todo-kwd-max-priority -2
- (length
- (member (match-string 2) org-todo-keywords)))
- 1)))
- (add-text-properties
- 0 (length txt) (append (list 'org-marker marker 'org-hd-marker marker
- 'priority priority)
- props)
- txt)
+ (- org-todo-kwd-max-priority -2
+ (length
+ (member (match-string 2) org-todo-keywords)))
+ 1)))
+ (org-add-props txt props
+ 'org-marker marker 'org-hd-marker marker
+ 'priority priority 'category category)
(push txt ee)
(goto-char (match-end 1)))
(nreverse ee)))
(defconst org-agenda-no-heading-message
- "No heading for this item in buffer or region")
+ "No heading for this item in buffer or region.")
(defun org-agenda-get-timestamps ()
"Return the date stamp information for agenda display."
'keymap org-agenda-keymap
'help-echo
(format "mouse-2 or RET jump to org file %s"
- (abbreviate-file-name (buffer-file-name)))))
+ (abbreviate-file-name buffer-file-name))))
(regexp (regexp-quote
(substring
(format-time-string
(apply 'encode-time ; DATE bound by calendar
(list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
0 11)))
- marker hdmarker deadlinep scheduledp donep tmp priority
- ee txt timestr)
+ marker hdmarker deadlinep scheduledp donep tmp priority category
+ ee txt timestr tags)
(goto-char (point-min))
(while (re-search-forward regexp nil t)
(if (not (save-match-data (org-at-date-range-p)))
(progn
(setq marker (org-agenda-new-marker (match-beginning 0))
+ category (org-get-category (match-beginning 0))
tmp (buffer-substring (max (point-min)
(- (match-beginning 0)
org-ds-keyword-length))
(if (re-search-backward "\\(^\\|\r\\)\\*+" nil t)
(progn
(goto-char (match-end 1))
- (setq hdmarker (org-agenda-new-marker))
+ (setq hdmarker (org-agenda-new-marker)
+ tags (org-get-tags-at))
(looking-at "\\*+[ \t]*\\([^\r\n]+\\)")
(setq txt (org-format-agenda-item
(format "%s%s"
(if deadlinep "Deadline: " "")
(if scheduledp "Scheduled: " ""))
- (match-string 1) nil timestr)))
+ (match-string 1) category tags timestr)))
(setq txt org-agenda-no-heading-message))
(setq priority (org-get-priority txt))
- (add-text-properties
- 0 (length txt) (append (list 'org-marker marker
- 'org-hd-marker hdmarker) props)
- txt)
+ (org-add-props txt props
+ 'org-marker marker 'org-hd-marker hdmarker)
(if deadlinep
- (add-text-properties
- 0 (length txt)
- (list 'face
- (if donep 'org-done 'org-warning)
- 'undone-face 'org-warning
- 'done-face 'org-done
- 'priority (+ 100 priority))
- txt)
+ (org-add-props txt nil
+ 'face (if donep 'org-done 'org-warning)
+ 'undone-face 'org-warning 'done-face 'org-done
+ 'category category 'priority (+ 100 priority))
(if scheduledp
- (add-text-properties
- 0 (length txt)
- (list 'face 'org-scheduled-today
- 'undone-face 'org-scheduled-today
- 'done-face 'org-done
- priority (+ 99 priority))
- txt)
- (add-text-properties
- 0 (length txt)
- (list 'priority priority) txt)))
+ (org-add-props txt nil
+ 'face 'org-scheduled-today
+ 'undone-face 'org-scheduled-today 'done-face 'org-done
+ 'category category priority (+ 99 priority))
+ (org-add-props txt nil 'priority priority 'category category)))
+ (push txt ee))
+ (outline-next-heading))))
+ (nreverse ee)))
+
+(defun org-agenda-get-closed ()
+ "Return the logged TODO entries for agenda display."
+ (let* ((props (list 'mouse-face 'highlight
+ 'keymap org-agenda-keymap
+ 'help-echo
+ (format "mouse-2 or RET jump to org file %s"
+ (abbreviate-file-name buffer-file-name))))
+ (regexp (concat
+ "\\<" org-closed-string " *\\["
+ (regexp-quote
+ (substring
+ (format-time-string
+ (car org-time-stamp-formats)
+ (apply 'encode-time ; DATE bound by calendar
+ (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
+ 1 11))))
+ marker hdmarker priority category tags
+ ee txt timestr)
+ (goto-char (point-min))
+ (while (re-search-forward regexp nil t)
+ (if (not (save-match-data (org-at-date-range-p)))
+ (progn
+ (setq marker (org-agenda-new-marker (match-beginning 0))
+ category (org-get-category (match-beginning 0))
+ timestr (buffer-substring (match-beginning 0) (point-at-eol))
+ ;; donep (org-entry-is-done-p)
+ )
+ (if (string-match "\\]" timestr)
+ ;; substring should only run to end of time stamp
+ (setq timestr (substring timestr 0 (match-end 0))))
+ (save-excursion
+ (if (re-search-backward "\\(^\\|\r\\)\\*+" nil t)
+ (progn
+ (goto-char (match-end 1))
+ (setq hdmarker (org-agenda-new-marker)
+ tags (org-get-tags-at))
+ (looking-at "\\*+[ \t]*\\([^\r\n]+\\)")
+ (setq txt (org-format-agenda-item
+ "Closed: "
+ (match-string 1) category tags timestr)))
+ (setq txt org-agenda-no-heading-message))
+ (setq priority 100000)
+ (org-add-props txt props
+ 'org-marker marker 'org-hd-marker hdmarker 'face 'org-done
+ 'priority priority 'category category
+ 'undone-face 'org-warning 'done-face 'org-done)
(push txt ee))
(outline-next-heading))))
(nreverse ee)))
'keymap org-agenda-keymap
'help-echo
(format "mouse-2 or RET jump to org file %s"
- (abbreviate-file-name (buffer-file-name)))))
+ (abbreviate-file-name buffer-file-name))))
(regexp org-deadline-time-regexp)
(todayp (equal date (calendar-current-date))) ; DATE bound by calendar
(d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
- d2 diff pos pos1
+ d2 diff pos pos1 category tags
ee txt head)
(goto-char (point-min))
(while (re-search-forward regexp nil t)
;; Past-due deadlines are only shown on the current date
(if (and (< diff wdays) todayp (not (= diff 0)))
(save-excursion
+ (setq category (org-get-category))
(if (re-search-backward "\\(^\\|\r\\)\\*+[ \t]*" nil t)
(progn
(goto-char (match-end 0))
(setq pos1 (match-end 1))
+ (setq tags (org-get-tags-at pos1))
(setq head (buffer-substring-no-properties
(point)
(progn (skip-chars-forward "^\r\n")
(if (string-match org-looking-at-done-regexp head)
(setq txt nil)
(setq txt (org-format-agenda-item
- (format "In %3d d.: " diff) head))))
+ (format "In %3d d.: " diff) head category tags))))
(setq txt org-agenda-no-heading-message))
(when txt
- (add-text-properties
- 0 (length txt)
- (append
- (list 'org-marker (org-agenda-new-marker pos)
- 'org-hd-marker (org-agenda-new-marker pos1)
- 'priority (+ (- 10 diff) (org-get-priority txt))
- 'face (cond ((<= diff 0) 'org-warning)
- ((<= diff 5) 'org-scheduled-previously)
- (t nil))
- 'undone-face (cond
- ((<= diff 0) 'org-warning)
- ((<= diff 5) 'org-scheduled-previously)
- (t nil))
- 'done-face 'org-done)
- props)
- txt)
+ (org-add-props txt props
+ 'org-marker (org-agenda-new-marker pos)
+ 'org-hd-marker (org-agenda-new-marker pos1)
+ 'priority (+ (- 10 diff) (org-get-priority txt))
+ 'category category
+ 'face (cond ((<= diff 0) 'org-warning)
+ ((<= diff 5) 'org-scheduled-previously)
+ (t nil))
+ 'undone-face (cond
+ ((<= diff 0) 'org-warning)
+ ((<= diff 5) 'org-scheduled-previously)
+ (t nil))
+ 'done-face 'org-done)
(push txt ee)))))
ee))
'keymap org-agenda-keymap
'help-echo
(format "mouse-2 or RET jump to org file %s"
- (abbreviate-file-name (buffer-file-name)))))
+ (abbreviate-file-name buffer-file-name))))
(regexp org-scheduled-time-regexp)
(todayp (equal date (calendar-current-date))) ; DATE bound by calendar
(d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
- d2 diff pos pos1
+ d2 diff pos pos1 category tags
ee txt head)
(goto-char (point-min))
(while (re-search-forward regexp nil t)
;; If it is on or past the date.
(if (and (< diff 0) todayp)
(save-excursion
+ (setq category (org-get-category))
(if (re-search-backward "\\(^\\|\r\\)\\*+[ \t]*" nil t)
(progn
(goto-char (match-end 0))
(setq pos1 (match-end 1))
+ (setq tags (org-get-tags-at))
(setq head (buffer-substring-no-properties
(point)
(progn (skip-chars-forward "^\r\n") (point))))
(if (string-match org-looking-at-done-regexp head)
(setq txt nil)
(setq txt (org-format-agenda-item
- (format "Sched.%2dx: " (- 1 diff)) head))))
+ (format "Sched.%2dx: " (- 1 diff)) head
+ category tags))))
(setq txt org-agenda-no-heading-message))
(when txt
- (add-text-properties
- 0 (length txt)
- (append (list 'org-marker (org-agenda-new-marker pos)
- 'org-hd-marker (org-agenda-new-marker pos1)
- 'priority (+ (- 5 diff) (org-get-priority txt)))
- props) txt)
+ (org-add-props txt props
+ 'org-marker (org-agenda-new-marker pos)
+ 'org-hd-marker (org-agenda-new-marker pos1)
+ 'priority (+ (- 5 diff) (org-get-priority txt))
+ 'category category)
(push txt ee)))))
ee))
'keymap org-agenda-keymap
'help-echo
(format "mouse-2 or RET jump to org file %s"
- (abbreviate-file-name (buffer-file-name)))))
+ (abbreviate-file-name buffer-file-name))))
(regexp org-tr-regexp)
(d0 (calendar-absolute-from-gregorian date))
- marker hdmarker ee txt d1 d2 s1 s2 timestr)
+ marker hdmarker ee txt d1 d2 s1 s2 timestr category tags)
(goto-char (point-min))
(while (re-search-forward regexp nil t)
(setq timestr (match-string 0)
;; date stamps will catch the limits.
(save-excursion
(setq marker (org-agenda-new-marker (point)))
+ (setq category (org-get-category))
(if (re-search-backward "\\(^\\|\r\\)\\*+" nil t)
(progn
(setq hdmarker (org-agenda-new-marker (match-end 1)))
(goto-char (match-end 1))
+ (setq tags (org-get-tags-at))
(looking-at "\\*+[ \t]*\\([^\r\n]+\\)")
(setq txt (org-format-agenda-item
(format (if (= d1 d2) "" "(%d/%d): ")
(1+ (- d0 d1)) (1+ (- d2 d1)))
- (match-string 1) nil (if (= d0 d1) timestr))))
+ (match-string 1) category tags
+ (if (= d0 d1) timestr))))
(setq txt org-agenda-no-heading-message))
- (add-text-properties
- 0 (length txt) (append (list 'org-marker marker
- 'org-hd-marker hdmarker
- 'priority (org-get-priority txt))
- props)
- txt)
+ (org-add-props txt props
+ 'org-marker marker 'org-hd-marker hdmarker
+ 'priority (org-get-priority txt) 'category category)
(push txt ee)))
(outline-next-heading))
;; Sort the entries by expiration date.
(nreverse ee)))
-
-
(defconst org-plain-time-of-day-regexp
(concat
"\\(\\<[012]?[0-9]"
(defvar org-prefix-has-time nil
"A flag, set by `org-compile-prefix-format'.
The flag is set if the currently compiled format contains a `%t'.")
+(defvar org-prefix-has-tag nil
+ "A flag, set by `org-compile-prefix-format'.
+The flag is set if the currently compiled format contains a `%T'.")
-(defun org-format-agenda-item (extra txt &optional category dotime noprefix)
+(defun org-format-agenda-item (extra txt &optional category tags dotime noprefix)
"Format TXT to be inserted into the agenda buffer.
In particular, it adds the prefix and corresponding text properties. EXTRA
must be a string and replaces the `%s' specifier in the prefix format.
-CATEGORY (string, symbol or nil) may be used to overule the default
-category taken from local variable or file name. It will replace the `%c'
+CATEGORY (string, symbol or nil) may be used to overrule the default
+category taken from local variable or file name. It will replace the `%c'
specifier in the format. DOTIME, when non-nil, indicates that a
time-of-day should be extracted from TXT for sorting of this entry, and for
the `%t' specifier in the format. When DOTIME is a string, this string is
searched for a time before TXT is. NOPREFIX is a flag and indicates that
only the correctly processes TXT should be returned - this is used by
-`org-agenda-change-all-lines'."
+`org-agenda-change-all-lines'. TAG can be the tag of the headline."
(save-match-data
;; Diary entries sometimes have extra whitespace at the beginning
(if (string-match "^ +" txt) (setq txt (replace-match "" nil nil txt)))
(let* ((category (or category
org-category
- (if (buffer-file-name)
+ (if buffer-file-name
(file-name-sans-extension
- (file-name-nondirectory (buffer-file-name)))
+ (file-name-nondirectory buffer-file-name))
"")))
+ (tag (or (nth (1- (or (length tags) 0)) tags) ""))
time ;; needed for the eval of the prefix format
(ts (if dotime (concat (if (stringp dotime) dotime "") txt)))
(time-of-day (and dotime (org-get-time-of-day ts)))
(if s1 (setq s1 (org-get-time-of-day s1 'string)))
(if s2 (setq s2 (org-get-time-of-day s2 'string))))
+ (when (and (or (eq org-agenda-remove-tags-when-in-prefix t)
+ (and org-agenda-remove-tags-when-in-prefix
+ org-prefix-has-tag))
+ (string-match ":[a-zA-Z_@0-9:]+:[ \t]*$" txt))
+ (setq txt (replace-match "" t t txt)))
+
;; Create the final string
(if noprefix
(setq rtn txt)
(setq rtn (concat (eval org-prefix-format-compiled) txt)))
;; And finally add the text properties
- (add-text-properties
- 0 (length rtn) (list 'category (downcase category)
- 'prefix-length (- (length rtn) (length txt))
- 'time-of-day time-of-day
- 'dotime dotime)
- rtn)
- rtn)))
+ (org-add-props rtn nil
+ 'category (downcase category) 'tags tags
+ 'prefix-length (- (length rtn) (length txt))
+ 'time-of-day time-of-day
+ 'dotime dotime))))
(defun org-agenda-add-time-grid-maybe (list ndays todayp)
(catch 'exit
(unless (and remove (member time have))
(setq time (int-to-string time))
(push (org-format-agenda-item
- nil string "" ;; FIXME: put a category?
+ nil string "" nil
(concat (substring time 0 -2) ":" (substring time -2)))
new)
(put-text-property
"Compile the prefix format into a Lisp form that can be evaluated.
The resulting form is returned and stored in the variable
`org-prefix-format-compiled'."
- (setq org-prefix-has-time nil)
- (let ((start 0) varform vars var (s format) c f opt)
+ (setq org-prefix-has-time nil org-prefix-has-tag nil)
+ (let ((start 0) varform vars var (s format)e c f opt)
(while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cts]\\)"
s start)
(setq var (cdr (assoc (match-string 4 s)
- '(("c" . category) ("t" . time) ("s" . extra))))
+ '(("c" . category) ("t" . time) ("s" . extra)
+ ("T" . tag))))
c (or (match-string 3 s) "")
opt (match-beginning 1)
start (1+ (match-beginning 0)))
(if (equal var 'time) (setq org-prefix-has-time t))
+ (if (equal var 'tag) (setq org-prefix-has-tag t))
(setq f (concat "%" (match-string 2 s) "s"))
(if opt
(setq varform
(if (match-beginning 3)
(string-to-number (match-string 3 s))
0)))
- (t1 (concat " " (int-to-string t0))))
+ (t1 (concat " "
+ (if (< t0 100) "0" "") (if (< t0 10) "0" "")
+ (int-to-string t0))))
(if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
(defun org-finalize-agenda-entries (list)
(mapconcat 'identity (sort list 'org-entries-lessp) "\n"))
(defsubst org-cmp-priority (a b)
- "Compare the priorities of string a and b."
+ "Compare the priorities of string A and B."
(let ((pa (or (get-text-property 1 'priority a) 0))
(pb (or (get-text-property 1 'priority b) 0)))
(cond ((> pa pb) +1)
(t nil))))
(defsubst org-cmp-category (a b)
- "Compare the string values of categories of strings a and b."
+ "Compare the string values of categories of strings A and B."
(let ((ca (or (get-text-property 1 'category a) ""))
(cb (or (get-text-property 1 'category b) "")))
(cond ((string-lessp ca cb) -1)
(t nil))))
(defsubst org-cmp-time (a b)
- "Compare the time-of-day values of strings a and b."
+ "Compare the time-of-day values of strings A and B."
(let* ((def (if org-sort-agenda-notime-is-late 2401 -1))
(ta (or (get-text-property 1 'time-of-day a) def))
(tb (or (get-text-property 1 'time-of-day b) def)))
(priority-down (if priority-up (- priority-up) nil))
(category-up (org-cmp-category a b))
(category-down (if category-up (- category-up) nil))
- (category-keep (if category-up +1 nil))) ; FIXME +1 or -1?
+ (category-keep (if category-up +1 nil)))
(cdr (assoc
(eval (cons 'or org-agenda-sorting-strategy))
'((-1 . t) (1 . nil) (nil . nil))))))
(let* ((pri (get-text-property (point-at-bol) 'priority)))
(message "Priority is %d" (if pri pri -1000))))
+(defun org-agenda-show-tags ()
+ "Show the tags applicable to the current item."
+ (interactive)
+ (let* ((tags (get-text-property (point-at-bol) 'tags)))
+ (if tags
+ (message "Tags are :%s:" (mapconcat 'identity tags ":"))
+ (message "No tags associated with this line"))))
+
(defun org-agenda-goto (&optional highlight)
"Go to the Org-mode file which contains the item at point."
(interactive)
"Marker pointing to the headline that last changed its TODO state
by a remote command from the agenda.")
-(defun org-agenda-todo ()
+(defun org-agenda-todo (&optional arg)
"Cycle TODO state of line at point, also in Org-mode file.
This changes the line at point, all other lines in the agenda referring to
the same tree node, and the headline of the tree node in the Org-mode file."
- (interactive)
+ (interactive "P")
(org-agenda-check-no-diary)
(let* ((col (current-column))
(marker (or (get-text-property (point) 'org-marker)
(save-excursion
(and (outline-next-heading)
(org-flag-heading nil))) ; show the next heading
- (org-todo)
+ (org-todo arg)
(forward-char 1)
(setq newhead (org-get-heading))
(save-excursion
(move-to-column col)))
(defun org-agenda-change-all-lines (newhead hdmarker &optional fixface)
- "Change all lines in the agenda buffer which match hdmarker.
+ "Change all lines in the agenda buffer which match HDMARKER.
The new content of the line will be NEWHEAD (as modified by
`org-format-agenda-item'). HDMARKER is checked with
`equal' against all `org-hd-marker' text properties in the file.
If FIXFACE is non-nil, the face of each item is modified acording to
the new TODO state."
- (let* (props m pl undone-face done-face finish new dotime)
+ (let* (props m pl undone-face done-face finish new dotime cat tags)
; (setq newhead (org-format-agenda-item "x" newhead "x" nil 'noprefix))
(save-excursion
(goto-char (point-max))
(equal m hdmarker))
(setq props (text-properties-at (point))
dotime (get-text-property (point) 'dotime)
- new (org-format-agenda-item "x" newhead "x" dotime 'noprefix)
+ cat (get-text-property (point) 'category)
+ tags (get-text-property (point) 'tags)
+ new (org-format-agenda-item "x" newhead cat tags dotime 'noprefix)
pl (get-text-property (point) 'prefix-length)
undone-face (get-text-property (point) 'undone-face)
done-face (get-text-property (point) 'done-face))
(org-agenda-change-all-lines newhead hdmarker)
(beginning-of-line 1)))
+(defun org-get-tags-at (&optional pos)
+ "Get a list of all headline targs applicable at POS.
+POS defaults to point. If tags are inherited, the list contains
+the targets in the same sequence as the headlines appear, i.e.
+the tags of the current headline come last."
+ (interactive)
+ (let (tags)
+ (save-excursion
+ (goto-char (or pos (point)))
+ (save-match-data
+ (org-back-to-heading t)
+ (condition-case nil
+ (while t
+ (if (looking-at "[^\r\n]+?:\\([a-zA-Z_@0-9:]+\\):[ \t]*\\([\n\r]\\|\\'\\)")
+ (setq tags (append (org-split-string (match-string 1) ":") tags)))
+ (or org-use-tag-inheritance (error ""))
+ (org-up-heading-all 1))
+ (error nil))))
+ (message "%s" tags)
+ tags))
+
+(defun org-agenda-set-tags ()
+ "Set tags for the current headline."
+ (interactive)
+ (org-agenda-check-no-diary)
+ (org-agenda-show) ;;; FIXME This is a stupid hack and should not be needed
+ (let* ((hdmarker (or (get-text-property (point) 'org-hd-marker)
+ (org-agenda-error)))
+ (buffer (marker-buffer hdmarker))
+ (pos (marker-position hdmarker))
+ (buffer-read-only nil)
+ newhead)
+ (with-current-buffer buffer
+ (widen)
+ (goto-char pos)
+ (org-show-hidden-entry)
+ (save-excursion
+ (and (outline-next-heading)
+ (org-flag-heading nil))) ; show the next heading
+ (call-interactively 'org-set-tags)
+ (end-of-line 1)
+ (setq newhead (org-get-heading)))
+ (org-agenda-change-all-lines newhead hdmarker)
+ (beginning-of-line 1)))
+
(defun org-agenda-date-later (arg &optional what)
"Change the date of this item to one day later."
(interactive "p")
+ (org-agenda-check-type t 'agenda 'timeline)
(org-agenda-check-no-diary)
(let* ((marker (or (get-text-property (point) 'org-marker)
(org-agenda-error)))
The prefix ARG is passed to the `org-time-stamp' command and can therefore
be used to request time specification in the time stamp."
(interactive "P")
+ (org-agenda-check-type t 'agenda 'timeline)
(org-agenda-check-no-diary)
(let* ((marker (or (get-text-property (point) 'org-marker)
(org-agenda-error)))
(defun org-get-heading ()
"Return the heading of the current entry, without the stars."
(save-excursion
+ (and (memq (char-before) '(?\n ?\r)) (skip-chars-forward "^\n\r"))
(if (and (re-search-backward "[\r\n]\\*" nil t)
- (looking-at "[\r\n]\\*+[ \t]+\\(.*\\)"))
+ (looking-at "[\r\n]\\*+[ \t]+\\([^\r\n]*\\)"))
(match-string 1)
"")))
(defun org-agenda-diary-entry ()
"Make a diary entry, like the `i' command from the calendar.
-All the standard commands work: block, weekly etc"
+All the standard commands work: block, weekly etc."
(interactive)
+ (org-agenda-check-type t 'agenda 'timeline)
(require 'diary-lib)
(let* ((char (progn
(message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
(defun org-agenda-execute-calendar-command (cmd)
"Execute a calendar command from the agenda, with the date associated to
the cursor position."
+ (org-agenda-check-type t 'agenda 'timeline)
(require 'diary-lib)
(unless (get-text-property (point) 'day)
(error "Don't know which date to use for calendar command"))
(defun org-agenda-goto-calendar ()
"Open the Emacs calendar with the date at the cursor."
(interactive)
+ (org-agenda-check-type t 'agenda 'timeline)
(let* ((day (or (get-text-property (point) 'day)
(error "Don't know which date to open in calendar")))
- (date (calendar-gregorian-from-absolute day)))
+ (date (calendar-gregorian-from-absolute day))
+ (calendar-move-hook nil)
+ (view-diary-entries-initially nil))
(calendar)
(calendar-goto-date date)))
"Compute the Org-mode agenda for the calendar date displayed at the cursor.
This is a command that has to be installed in `calendar-mode-map'."
(interactive)
- (org-agenda nil (calendar-absolute-from-gregorian
- (calendar-cursor-to-date))))
+ (org-agenda-list nil (calendar-absolute-from-gregorian
+ (calendar-cursor-to-date))
+ nil t))
(defun org-agenda-convert-date ()
(interactive)
+ (org-agenda-check-type t 'agenda 'timeline)
(let ((day (get-text-property (point) 'day))
date s)
(unless day
"Chinese: " (calendar-chinese-date-string date) "\n"))
(with-output-to-temp-buffer "*Dates*"
(princ s))
- (fit-window-to-buffer (get-buffer-window "*Dates*"))))
+ (if (fboundp 'fit-window-to-buffer)
+ (fit-window-to-buffer (get-buffer-window "*Dates*")))))
+
+;;; Tags
+
+(defun org-scan-tags (action matcher &optional todo-only)
+ "Scan headline tags with inheritance and produce output ACTION.
+ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
+evaluated, testing if a given set of tags qualifies a headline for
+inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
+are included in the output."
+ (let* ((re (concat "[\n\r]" outline-regexp " *\\(\\<\\("
+ (mapconcat 'regexp-quote
+ (nreverse (cdr (reverse org-todo-keywords)))
+ "\\|")
+ "\\>\\)\\)? *\\(.*?\\)\\(:[A-Za-z_@0-9:]+:\\)?[ \t]*[\n\r]"))
+ (props (list 'face nil
+ 'done-face 'org-done
+ 'undone-face nil
+ 'mouse-face 'highlight
+ 'keymap org-agenda-keymap
+ 'help-echo
+ (format "mouse-2 or RET jump to org file %s"
+ (abbreviate-file-name buffer-file-name))))
+ lspos
+ tags tags-list tags-alist (llast 0) rtn level category i txt
+ todo marker)
+
+ (save-excursion
+ (goto-char (point-min))
+ (when (eq action 'sparse-tree) (hide-sublevels 1))
+ (while (re-search-forward re nil t)
+ (setq todo (if (match-end 1) (match-string 2))
+ tags (if (match-end 4) (match-string 4)))
+ (goto-char (setq lspos (1+ (match-beginning 0))))
+ (setq level (funcall outline-level)
+ category (org-get-category))
+ (setq i llast llast level)
+ ;; remove tag lists from same and sublevels
+ (while (>= i level)
+ (when (setq entry (assoc i tags-alist))
+ (setq tags-alist (delete entry tags-alist)))
+ (setq i (1- i)))
+ ;; add the nex tags
+ (when tags
+ (setq tags (mapcar 'downcase (org-split-string tags ":"))
+ tags-alist
+ (cons (cons level tags) tags-alist)))
+ ;; compile tags for current headline
+ (setq tags-list
+ (if org-use-tag-inheritance
+ (apply 'append (mapcar 'cdr tags-alist))
+ tags))
+ (when (and (or (not todo-only) todo)
+ (eval matcher))
+ ;; list this headline
+ (if (eq action 'sparse-tree)
+ (progn
+ (org-show-hierarchy-above))
+ (setq txt (org-format-agenda-item
+ ""
+ (concat
+ (if org-tags-match-list-sublevels
+ (make-string (1- level) ?.) "")
+ (org-get-heading))
+ category tags-list))
+ (goto-char lspos)
+ (setq marker (org-agenda-new-marker))
+ (org-add-props txt props
+ 'org-marker marker 'org-hd-marker marker 'category category)
+ (push txt rtn))
+ ;; if we are to skip sublevels, jump to end of subtree
+ (point)
+ (or org-tags-match-list-sublevels (org-end-of-subtree)))))
+ (nreverse rtn)))
+
+(defun org-tags-sparse-tree (&optional arg match)
+ "Create a sparse tree according to tags search string MATCH.
+MATCH can contain positive and negative selection of tags, like
+\"+WORK+URGENT-WITHBOSS\"."
+ (interactive "P")
+ (let ((org-show-following-heading nil)
+ (org-show-hierarchy-above nil))
+ (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)))))
+
+(defun org-make-tags-matcher (match)
+ "Create the TAGS matcher form for the tags-selecting string MATCH."
+ (unless match
+ ;; Get a new match request, with completion
+ (setq org-last-tags-completion-table
+ (or (org-get-buffer-tags)
+ org-last-tags-completion-table))
+ (setq match (completing-read
+ "Tags: " 'org-tags-completion-function nil nil nil
+ 'org-tags-history)))
+ ;; parse the string and create a lisp form
+ (let ((match0 match) minus tag mm matcher orterms term orlist)
+ (setq orterms (org-split-string match "|"))
+ (while (setq term (pop orterms))
+ (while (string-match "^&?\\([-+:]\\)?\\([A-Za-z_@0-9]+\\)" term)
+ (setq minus (and (match-end 1)
+ (equal (match-string 1 term) "-"))
+ tag (match-string 2 term)
+ term (substring term (match-end 0))
+ mm (list 'member (downcase tag) 'tags-list)
+ mm (if minus (list 'not mm) mm))
+ (push mm matcher))
+ (push (if (> (length matcher) 1) (cons 'and matcher) (car matcher))
+ orlist)
+ (setq matcher nil))
+ (setq matcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
+ ;; Return the string and lisp forms of the matcher
+ (cons match0 matcher)))
+
+;;;###autoload
+(defun org-tags-view (&optional todo-only match keep-modes)
+ "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
+The prefix arg TODO-ONLY limits the search to TODO entries."
+ (interactive "P")
+ (org-agenda-maybe-reset-markers 'force)
+ (org-compile-prefix-format org-agenda-prefix-format)
+ (let* ((org-agenda-keep-modes keep-modes)
+ (org-tags-match-list-sublevels
+ (if todo-only t org-tags-match-list-sublevels))
+ (win (selected-window))
+ (completion-ignore-case t)
+ rtn rtnall files file pos matcher
+ buffer)
+ (setq matcher (org-make-tags-matcher match)
+ match (car matcher) matcher (cdr matcher))
+ (if (not (equal (current-buffer) (get-buffer org-agenda-buffer-name)))
+ (progn
+ (delete-other-windows)
+ (switch-to-buffer-other-window
+ (get-buffer-create org-agenda-buffer-name))))
+ (setq buffer-read-only nil)
+ (erase-buffer)
+ (org-agenda-mode) (setq buffer-read-only nil)
+ (set (make-local-variable 'org-agenda-type) 'tags)
+ (set (make-local-variable 'org-agenda-redo-command)
+ (list 'org-tags-view (list 'quote todo-only)
+ (list 'if 'current-prefix-arg nil match) t))
+ (setq files (org-agenda-files)
+ rtnall nil)
+ (while (setq file (pop files))
+ (catch 'nextfile
+ (org-check-agenda-file file)
+ (setq buffer (if (file-exists-p file)
+ (org-get-agenda-file-buffer file)
+ (error "No such file %s" file)))
+ (if (not buffer)
+ ;; If file does not exist, merror message to agenda
+ (setq rtn (list
+ (format "ORG-AGENDA-ERROR: No such org-file %s" file))
+ rtnall (append rtnall rtn))
+ (with-current-buffer buffer
+ (unless (eq major-mode 'org-mode)
+ (error "Agenda file %s is not in `org-mode'" file))
+ (save-excursion
+ (save-restriction
+ (if org-respect-restriction
+ (if (org-region-active-p)
+ ;; Respect a region to restrict search
+ (narrow-to-region (region-beginning) (region-end)))
+ ;; If we work for the calendar or many files,
+ ;; get rid of any restriction
+ (widen))
+ (setq rtn (org-scan-tags 'agenda matcher todo-only))
+ (setq rtnall (append rtnall rtn))))))))
+ (insert "Headlines with TAGS match: ")
+ (add-text-properties (point-min) (1- (point))
+ (list 'face 'org-level-3))
+ (setq pos (point))
+ (insert match "\n")
+ (add-text-properties pos (1- (point)) (list 'face 'org-warning))
+ (setq pos (point))
+ (insert "Press `C-u r' to search again with new search string\n")
+ (add-text-properties pos (1- (point)) (list 'face 'org-level-3))
+ (when rtnall
+ (insert (mapconcat 'identity rtnall "\n")))
+ (goto-char (point-min))
+ (setq buffer-read-only t)
+ (org-fit-agenda-window)
+ (if (not org-select-agenda-window) (select-window win))))
+
+(defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
+(defun org-set-tags (&optional arg just-align)
+ "Set the tags for the current headline.
+With prefix ARG, realign all tags in headings in the current buffer."
+ (interactive)
+ (let* (;(inherit (org-get-inherited-tags))
+ (re (concat "^" outline-regexp))
+ (col (current-column))
+ (current (org-get-tags))
+ tags hd empty invis)
+ (if arg
+ (save-excursion
+ (goto-char (point-min))
+ (while (re-search-forward re nil t)
+ (org-set-tags nil t))
+ (message "All tags realigned to column %d" org-tags-column))
+ (if just-align
+ (setq tags current)
+ (setq org-last-tags-completion-table
+ (or (org-get-buffer-tags)
+ org-last-tags-completion-table))
+ (setq tags
+ (let ((org-add-colon-after-tag-completion t))
+ (completing-read "Tags: " 'org-tags-completion-function
+ nil nil current 'org-tags-history)))
+ (while (string-match "[-+&]+" tags)
+ (setq tags (replace-match ":" t t tags))))
+ ;; FIXME: still optimize this by not checking when JUST-ALIGN?
+ (unless (setq empty (string-match "\\`[\t ]*\\'" tags))
+ (unless (string-match ":$" tags) (setq tags (concat tags ":")))
+ (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
+ (if (equal current "")
+ (progn
+ (end-of-line 1)
+ (or empty (insert-before-markers " ")))
+ (beginning-of-line 1)
+ (setq invis (org-invisible-p))
+ (looking-at (concat "\\(.*\\)\\(" (regexp-quote current) "\\)[ \t]*"))
+ (setq hd (match-string 1))
+ (delete-region (match-beginning 0) (match-end 0))
+ (insert-before-markers (org-trim hd) (if empty "" " ")))
+ (unless (equal tags "")
+ (move-to-column (max (current-column)
+ (if (> org-tags-column 0)
+ org-tags-column
+ (- (- org-tags-column) (length tags))))
+ t)
+ (insert-before-markers tags)
+ (if (and (not invis) (org-invisible-p))
+ (outline-flag-region (point-at-bol) (point) nil)))
+ (move-to-column col))))
+
+(defun org-tags-completion-function (string predicate &optional flag)
+ (let (s1 s2 rtn (ctable org-last-tags-completion-table))
+ (if (string-match "^\\(.*[-+:&|]\\)\\([^-+:&|]*\\)$" string)
+ (setq s1 (match-string 1 string)
+ s2 (match-string 2 string))
+ (setq s1 "" s2 string))
+ (cond
+ ((eq flag nil)
+ ;; try completion
+ (setq rtn (try-completion s2 ctable))
+ (if (stringp rtn)
+ (concat s1 s2 (substring rtn (length s2))
+ (if (and org-add-colon-after-tag-completion
+ (assoc rtn ctable))
+ ":" "")))
+ )
+ ((eq flag t)
+ ;; all-completions
+ (all-completions s2 ctable)
+ )
+ ((eq flag 'lambda)
+ ;; exact match?
+ (assoc s2 ctable)))
+ ))
+
+(defun org-get-tags ()
+ "Get the TAGS string in the current headline."
+ (unless (org-on-heading-p)
+ (error "Not on a heading"))
+ (save-excursion
+ (beginning-of-line 1)
+ (if (looking-at ".*[ \t]\\(:[A-Za-z_@0-9:]+:\\)[ \t]*\\(\r\\|$\\)")
+ (org-match-string-no-properties 1)
+ "")))
+
+(defun org-get-buffer-tags ()
+ "Get a table of all tags used in the buffer, for completion."
+ (let (tags)
+ (save-excursion
+ (goto-char (point-min))
+ (while (re-search-forward "[ \t]:\\([A-Za-z_@0-9:]+\\):[ \t\r\n]" nil t)
+ (mapc (lambda (x) (add-to-list 'tags x))
+ (org-split-string (org-match-string-no-properties 1) ":"))))
+ (mapcar 'list tags)))
;;; Link Stuff
Normally, files will be opened by an appropriate application. If the
optional argument IN-EMACS is non-nil, Emacs will visit the file."
(interactive "P")
+ (org-remove-occur-highlights nil nil t)
(if (org-at-timestamp-p)
- (org-agenda nil (time-to-days (org-time-string-to-time
- (substring (match-string 1) 0 10)))
- 1)
- (let (type path line (pos (point)))
- (save-excursion
- (skip-chars-backward
- (concat (if org-allow-space-in-links "^" "^ ")
- org-non-link-chars))
- (if (re-search-forward
- org-link-regexp
- (save-excursion
- (condition-case nil
- (progn (outline-end-of-subtree) (max pos (point)))
- (error (end-of-line 1) (point))))
- t)
+ (org-agenda-list nil (time-to-days (org-time-string-to-time
+ (substring (match-string 1) 0 10)))
+ 1)
+ (let (type path link line search (pos (point)))
+ (catch 'match
+ (save-excursion
+ (skip-chars-forward "^]\n\r")
+ (when (and (re-search-backward "\\[\\[" nil t)
+ (looking-at org-bracket-link-regexp)
+ (<= (match-beginning 0) pos)
+ (>= (match-end 0) pos))
+ (setq link (org-link-unescape (org-match-string-no-properties 1)))
+ (while (string-match " *\n *" link)
+ (setq link (replace-match " " t t link)))
+ (if (string-match org-link-re-with-space2 link)
+ (setq type (match-string 1 link)
+ path (match-string 2 link))
+ (setq type "thisfile"
+ path link))
+ (throw 'match t)))
+
+ (when (get-text-property (point) 'org-linked-text)
+ (setq type "thisfile"
+ pos (if (get-text-property (1+ (point)) 'org-linked-text)
+ (1+ (point)) (point))
+ path (buffer-substring
+ (previous-single-property-change pos 'org-linked-text)
+ (next-single-property-change pos 'org-linked-text)))
+ (throw 'match t))
+
+ (save-excursion
+ (skip-chars-backward (concat "^[]" org-non-link-chars " "))
+ (if (equal (char-before) ?<) (backward-char 1))
+ (when (or (looking-at org-angle-link-re)
+ (looking-at org-plain-link-re)
+ (and (or (re-search-forward org-angle-link-re (point-at-eol) t)
+ (re-search-forward org-plain-link-re (point-at-eol) t))
+ (<= (match-beginning 0) pos)
+ (>= (match-end 0) pos)))
(setq type (match-string 1)
- path (match-string 2)))
- (unless path
- (error "No link found"))
- ;; Remove any trailing spaces in path
- (if (string-match " +\\'" path)
- (setq path (replace-match "" t t path)))
+ path (match-string 2))
+ (throw 'match t)))
+ (save-excursion
+ (skip-chars-backward "^ \t\n\r")
+ (when (looking-at "\\(:[A-Za-z_@0-9:]+\\):[ \t\r\n]")
+ (setq type "tags"
+ path (match-string 1))
+ (while (string-match ":" path)
+ (setq path (replace-match "+" t t path)))
+ (throw 'match t)))
+ (save-excursion
+ (skip-chars-backward "a-zA-Z_")
+ (when (and (memq 'camel org-activate-links)
+ (looking-at org-camel-regexp))
+ (setq type "camel" path (match-string 0))
+ (if (equal (char-before) ?*)
+ (setq path (concat "*" path))))
+ (throw 'match t)))
+ (unless path
+ (error "No link found"))
+ ;; Remove any trailing spaces in path
+ (if (string-match " +\\'" path)
+ (setq path (replace-match "" t t path)))
- (cond
+ (cond
- ((string= type "file")
- (if (string-match ":\\([0-9]+\\)\\'" path)
- (setq line (string-to-number (match-string 1 path))
- path (substring path 0 (match-beginning 0))))
- (org-open-file path in-emacs line))
-
- ((string= type "news")
- (org-follow-gnus-link path))
-
- ((string= type "bbdb")
- (org-follow-bbdb-link path))
-
- ((string= type "gnus")
- (let (group article)
- (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
- (error "Error in Gnus link"))
- (setq group (match-string 1 path)
- article (match-string 3 path))
- (org-follow-gnus-link group article)))
-
- ((string= type "vm")
- (let (folder article)
- (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
- (error "Error in VM link"))
- (setq folder (match-string 1 path)
- article (match-string 3 path))
- ;; in-emacs is the prefix arg, will be interpreted as read-only
- (org-follow-vm-link folder article in-emacs)))
-
- ((string= type "wl")
- (let (folder article)
- (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
- (error "Error in Wanderlust link"))
- (setq folder (match-string 1 path)
- article (match-string 3 path))
- (org-follow-wl-link folder article)))
-
- ((string= type "rmail")
- (let (folder article)
- (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
- (error "Error in RMAIL link"))
- (setq folder (match-string 1 path)
- article (match-string 3 path))
- (org-follow-rmail-link folder article)))
-
- ((string= type "shell")
- (let ((cmd path))
- (while (string-match "@{" cmd)
- (setq cmd (replace-match "<" t t cmd)))
- (while (string-match "@}" cmd)
- (setq cmd (replace-match ">" t t cmd)))
- (if (or (not org-confirm-shell-links)
- (yes-or-no-p (format "Execute \"%s\" in the shell? " cmd)))
- (shell-command cmd)
- (error "Abort"))))
+ ((member type '("http" "https" "ftp" "mailto" "news"))
+ (browse-url (concat type ":" path)))
+
+ ((string= type "tags")
+ (org-tags-view in-emacs path))
+ ((or (string= type "camel")
+ (string= type "thisfile"))
+ (org-mark-ring-push)
+ (org-link-search
+ path
+ (cond ((equal in-emacs '(4)) 'occur)
+ ((equal in-emacs '(16)) 'org-occur)
+ (t nil))))
+
+ ((string= type "file")
+ (if (string-match "::?\\([0-9]+\\)\\'" path) ;; second : optional
+ (setq line (string-to-number (match-string 1 path))
+ path (substring path 0 (match-beginning 0)))
+ (if (string-match "::\\(.+\\)\\'" path)
+ (setq search (match-string 1 path)
+ path (substring path 0 (match-beginning 0)))))
+ (org-open-file path in-emacs line search))
+
+ ((string= type "news")
+ (org-follow-gnus-link path))
+
+ ((string= type "bbdb")
+ (org-follow-bbdb-link path))
+
+ ((string= type "gnus")
+ (let (group article)
+ (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
+ (error "Error in Gnus link"))
+ (setq group (match-string 1 path)
+ article (match-string 3 path))
+ (org-follow-gnus-link group article)))
+
+ ((string= type "vm")
+ (let (folder article)
+ (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
+ (error "Error in VM link"))
+ (setq folder (match-string 1 path)
+ article (match-string 3 path))
+ ;; in-emacs is the prefix arg, will be interpreted as read-only
+ (org-follow-vm-link folder article in-emacs)))
+
+ ((string= type "wl")
+ (let (folder article)
+ (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
+ (error "Error in Wanderlust link"))
+ (setq folder (match-string 1 path)
+ article (match-string 3 path))
+ (org-follow-wl-link folder article)))
+
+ ((string= type "mhe")
+ (let (folder article)
+ (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
+ (error "Error in MHE link"))
+ (setq folder (match-string 1 path)
+ article (match-string 3 path))
+ (org-follow-mhe-link folder article)))
+
+ ((string= type "rmail")
+ (let (folder article)
+ (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
+ (error "Error in RMAIL link"))
+ (setq folder (match-string 1 path)
+ article (match-string 3 path))
+ (org-follow-rmail-link folder article)))
+
+ ((string= type "shell")
+ (let ((cmd path))
+ (while (string-match "@{" cmd)
+ (setq cmd (replace-match "<" t t cmd)))
+ (while (string-match "@}" cmd)
+ (setq cmd (replace-match ">" t t cmd)))
+ (if (or (not org-confirm-shell-links)
+ (funcall org-confirm-shell-links
+ (format "Execute \"%s\" in shell? "
+ (org-add-props cmd nil
+ 'face 'org-warning))))
+ (shell-command cmd)
+ (error "Abort"))))
- (t
- (browse-url-at-point)))))))
+ (t
+ (browse-url-at-point))))))
+
+(defun org-link-search (s &optional type)
+ "Search for a link search option.
+When S is a CamelCaseWord, search for a target, or for a sentence containing
+the words. If S is surrounded by forward slashes, it is interpreted as a
+regular expression. In org-mode files, this will create an `org-occur'
+sparse tree. In ordinary files, `occur' will be used to list matches.
+If the current buffer is in `dired-mode', grep will be used to search
+in all files."
+ (let ((case-fold-search t)
+ (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
+ (pos (point))
+ (pre "") (post "")
+ words re0 re1 re2 re3 re4 re5 re2a reall camel)
+ (cond ((save-excursion
+ (goto-char (point-min))
+ (and
+ (re-search-forward
+ (concat "<<" (regexp-quote s0) ">>") nil t)
+ (setq pos (match-beginning 0))))
+ ;; There is an exact target for this
+ (goto-char pos))
+ ((string-match "^/\\(.*\\)/$" s)
+ ;; A regular expression
+ (cond
+ ((eq major-mode 'org-mode)
+ (org-occur (match-string 1 s)))
+ ;;((eq major-mode 'dired-mode)
+ ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
+ (t (org-do-occur (match-string 1 s)))))
+ ((or (setq camel (string-match (concat "^" org-camel-regexp "$") s))
+ t)
+ ;; A camel or a normal search string
+ (when (equal (string-to-char s) ?*)
+ ;; Anchor on headlines, post may include tags.
+ (setq pre "^\\*+[ \t]*\\(\\sw+\\)?[ \t]*"
+ post "[ \t]*\\([ \t]+:[a-zA-Z_@0-9:+]:[ \t]*\\)?$"
+ s (substring s 1)))
+ (remove-text-properties
+ 0 (length s)
+ '(face nil mouse-face nil keymap nil fontified nil) s)
+ ;; Make a series of regular expressions to find a match
+ (setq words
+ (if camel
+ (org-camel-to-words s)
+ (org-split-string s "[ \n\r\t]+"))
+ re0 (concat "<<" (regexp-quote s0) ">>")
+ re2 (concat "\\<" (mapconcat 'downcase words "[ \t]+") "\\>")
+ re2a (concat "\\<" (mapconcat 'downcase words "[ \t\r\n]+") "\\>")
+ re4 (concat "\\<" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\>")
+ re1 (concat pre re2 post)
+ re3 (concat pre re4 post)
+ re5 (concat pre ".*" re4)
+ re2 (concat pre re2)
+ re2a (concat pre re2a)
+ re4 (concat pre re4)
+ reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
+ "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
+ re5 "\\)"
+ ))
+ (cond
+ ((eq type 'org-occur) (org-occur reall))
+ ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
+ (t (goto-char (point-min))
+ (if (or (org-search-not-link re0 nil t)
+ (org-search-not-link re1 nil t)
+ (org-search-not-link re2 nil t)
+ (org-search-not-link re2a nil t)
+ (org-search-not-link re3 nil t)
+ (org-search-not-link re4 nil t)
+ (org-search-not-link re5 nil t)
+ )
+ (goto-char (match-beginning 0))
+ (goto-char pos)
+ (error "No match")))))
+ (t
+ ;; Normal string-search
+ (goto-char (point-min))
+ (if (search-forward s nil t)
+ (goto-char (match-beginning 0))
+ (error "No match"))))
+ (and (eq major-mode 'org-mode) (org-show-hierarchy-above))))
+
+(defun org-search-not-link (&rest args)
+ "Execute `re-search-forward', but only accept matches that are not a link."
+ (catch 'exit
+ (let ((pos (point)) p1)
+ (while (apply 're-search-forward args)
+ (setq p1 (point))
+ (if (not (save-match-data
+ (and (re-search-backward "\\[\\[" nil t)
+ (looking-at org-bracket-link-regexp)
+ (<= (match-beginning 0) p1)
+ (>= (match-end 0) p1))))
+ (progn (goto-char (match-end 0))
+ (throw 'exit (point)))
+ (goto-char (match-end 0)))))))
+
+(defun org-do-occur (regexp &optional cleanup)
+ "Call the Emacs command `occur'.
+If CLEANUP is non-nil, remove the printout of the regular expression
+in the *Occur* buffer. This is useful if the regex is long and not useful
+to read."
+ (occur regexp)
+ (when cleanup
+ (let ((cwin (selected-window)) win beg end)
+ (when (setq win (get-buffer-window "*Occur*"))
+ (select-window win))
+ (goto-char (point-min))
+ (when (re-search-forward "match[a-z]+" nil t)
+ (setq beg (match-end 0))
+ (if (re-search-forward "^[ \t]*[0-9]+" nil t)
+ (setq end (1- (match-beginning 0)))))
+ (and beg end (let ((buffer-read-only)) (delete-region beg end)))
+ (goto-char (point-min))
+ (select-window cwin))))
+
+(defvar org-mark-ring nil
+ "Mark ring for positions before jumps in Org-mode.")
+(defvar org-mark-ring-last-goto nil
+ "Last position in the mark ring used to go back.")
+;; Fill and close the ring
+(setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
+(loop for i from 1 to org-mark-ring-length do
+ (push (make-marker) org-mark-ring))
+(setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
+ org-mark-ring)
+
+(defun org-mark-ring-push (&optional pos buffer)
+ "Put the current position or POS into the mark ring and rotate it."
+ (interactive)
+ (setq pos (or pos (point)))
+ (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
+ (move-marker (car org-mark-ring)
+ (or pos (point))
+ (or buffer (current-buffer)))
+ (message
+ (substitute-command-keys
+ "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
+
+(defun org-mark-ring-goto (&optional n)
+ "Jump to the previous position in the mark ring.
+With prefix arg N, jump back that many stored positions. When
+called several times in succession, walk through the entire ring.
+Org-mode commands jumping to a different position in the current file,
+or to another Org-mode file, automatically push the old position
+onto the ring."
+ (interactive "p")
+ (let (p m)
+ (if (eq last-command this-command)
+ (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
+ (setq p org-mark-ring))
+ (setq org-mark-ring-last-goto p)
+ (setq m (car p))
+ (switch-to-buffer (marker-buffer m))
+ (goto-char m)
+ (if (or (org-invisible-p) (org-invisible-p2)) (org-show-hierarchy-above))))
+
+(defun org-camel-to-words (s)
+ "Split \"CamelCaseWords\" to (\"Camel\" \"Case\" \"Words\")."
+ (let ((case-fold-search nil)
+ words)
+ (while (string-match "[a-z][A-Z]" s)
+ (push (substring s 0 (1+ (match-beginning 0))) words)
+ (setq s (substring s (1+ (match-beginning 0)))))
+ (nreverse (cons s words))))
+
+(defun org-remove-angle-brackets (s)
+ (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
+ (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
+ s)
+(defun org-add-angle-brackets (s)
+ (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
+ (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
+ s)
(defun org-follow-bbdb-link (name)
"Follow a BBDB link to NAME."
(require 'bbdb)
- (let ((inhibit-redisplay t))
+ (let ((inhibit-redisplay t)
+ (bbdb-electric-p nil))
(catch 'exit
;; Exact match on name
(bbdb-name (concat "\\`" name "\\'") nil)
(defun org-follow-vm-link (&optional folder article readonly)
"Follow a VM link to FOLDER and ARTICLE."
(require 'vm)
+ (setq article (org-add-angle-brackets article))
(if (string-match "^//\\([a-zA-Z]+@\\)?\\([^:]+\\):\\(.*\\)" folder)
;; ange-ftp or efs or tramp access
(let ((user (or (match-string 1 folder) (user-login-name)))
(cond
((featurep 'tramp)
;; use tramp to access the file
- (if org-xemacs-p
+ (if (featurep 'xemacs)
(setq folder (format "[%s@%s]%s" user host file))
(setq folder (format "/%s@%s:%s" user host file))))
(t
;; use ange-ftp or efs
- (require (if org-xemacs-p 'efs 'ange-ftp))
+ (require (if (featurep 'xemacs) 'efs 'ange-ftp))
(setq folder (format "/%s@%s:%s" user host file))))))
(when folder
(funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
(defun org-follow-wl-link (folder article)
"Follow a Wanderlust link to FOLDER and ARTICLE."
+ (setq article (org-add-angle-brackets article))
(wl-summary-goto-folder-subr folder 'no-sync t nil t)
- (if article (wl-summary-jump-to-msg-by-message-id article))
+ (if article (wl-summary-jump-to-msg-by-message-id article ">"))
(wl-summary-redisplay))
(defun org-follow-rmail-link (folder article)
"Follow an RMAIL link to FOLDER and ARTICLE."
+ (setq article (org-add-angle-brackets article))
(let (message-number)
(save-excursion
(save-window-excursion
message-number)
(error "Message not found"))))
-(defun org-open-file (path &optional in-emacs line)
+;; mh-e integration based on planner-mode
+(defun org-mhe-get-message-real-folder ()
+ "Return the name of the current message real folder, so if you use
+sequences, it will now work."
+ (save-excursion
+ (let* ((folder
+ (if (equal major-mode 'mh-folder-mode)
+ mh-current-folder
+ ;; Refer to the show buffer
+ mh-show-folder-buffer))
+ (end-index
+ (if (boundp 'mh-index-folder)
+ (min (length mh-index-folder) (length folder))))
+ )
+ ;; a simple test on mh-index-data does not work, because
+ ;; mh-index-data is always nil in a show buffer.
+ (if (and (boundp 'mh-index-folder)
+ (string= mh-index-folder (substring folder 0 end-index)))
+ (if (equal major-mode 'mh-show-mode)
+ (save-window-excursion
+ (when (buffer-live-p (get-buffer folder))
+ (progn
+ (pop-to-buffer folder)
+ (org-mhe-get-message-folder-from-index)
+ )
+ ))
+ (org-mhe-get-message-folder-from-index)
+ )
+ folder
+ )
+ )))
+
+(defun org-mhe-get-message-folder-from-index ()
+ "Returns the name of the message folder in a index folder buffer."
+ (save-excursion
+ (mh-index-previous-folder)
+ (re-search-forward "^\\(+.*\\)$" nil t)
+ (message (match-string 1))))
+
+(defun org-mhe-get-message-folder ()
+ "Return the name of the current message folder. Be careful if you
+use sequences."
+ (save-excursion
+ (if (equal major-mode 'mh-folder-mode)
+ mh-current-folder
+ ;; Refer to the show buffer
+ mh-show-folder-buffer)))
+
+(defun org-mhe-get-message-num ()
+ "Return the number of the current message. Be careful if you
+use sequences."
+ (save-excursion
+ (if (equal major-mode 'mh-folder-mode)
+ (mh-get-msg-num nil)
+ ;; Refer to the show buffer
+ (mh-show-buffer-message-number))))
+
+(defun org-mhe-get-header (header)
+ "Return a header of the message in folder mode. This will create a
+show buffer for the corresponding message. If you have a more clever
+idea..."
+ (let* ((folder (org-mhe-get-message-folder))
+ (num (org-mhe-get-message-num))
+ (buffer (get-buffer-create (concat "show-" folder)))
+ (header-field))
+ (with-current-buffer buffer
+ (mh-display-msg num folder)
+ (if (equal major-mode 'mh-folder-mode)
+ (mh-header-display)
+ (mh-show-header-display))
+ (set-buffer buffer)
+ (setq header-field (mh-get-header-field header))
+ (if (equal major-mode 'mh-folder-mode)
+ (mh-show)
+ (mh-show-show))
+ header-field)))
+
+(defun org-follow-mhe-link (folder article)
+ "Follow an MHE link to FOLDER and ARTICLE.
+If ARTICLE is nil FOLDER is shown. If the configuration variable
+`org-mhe-search-all-folders' is t and `mh-searcher' is pick,
+ARTICLE is searched in all folders. Indexed searches (swish++,
+namazu, and others supported by MH-E) will always search in all
+folders."
+ (require 'mh-e)
+ (require 'mh-search)
+ (require 'mh-utils)
+ (mh-find-path)
+ (if (not article)
+ (mh-visit-folder (mh-normalize-folder-name folder))
+ (setq article (org-add-angle-brackets article))
+ (mh-search-choose)
+ (if (equal mh-searcher 'pick)
+ (progn
+ (mh-search folder (list "--message-id" article))
+ (when (and org-mhe-search-all-folders
+ (not (org-mhe-get-message-real-folder)))
+ (kill-this-buffer)
+ (mh-search "+" (list "--message-id" article))))
+ (mh-search "+" article))
+ (if (org-mhe-get-message-real-folder)
+ (mh-show-msg 1)
+ (kill-this-buffer)
+ (error "Message not found"))))
+
+(defun org-open-file (path &optional in-emacs line search)
"Open the file at PATH.
First, this expands any special file name abbreviations. Then the
configuration variable `org-file-apps' is checked if it contains an
entry for this file type, and if yes, the corresponding command is launched.
If no application is found, Emacs simply visits the file.
With optional argument IN-EMACS, Emacs will visit the file.
+Optional LINE specifies a line to go to, optional SEARCH a string to
+search for. If LINE or SEARCH is given, the file will always be
+opened in Emacs.
If the file does not exist, an error is thrown."
- (let* ((file (convert-standard-filename (org-expand-file-name path)))
+ (setq in-emacs (or in-emacs line search))
+ (let* ((file (if (equal path "")
+ buffer-file-name
+ (convert-standard-filename (org-expand-file-name path))))
+ (dirp (file-directory-p file))
(dfile (downcase file))
+ (old-buffer (current-buffer))
+ (old-pos (point))
+ (old-mode major-mode)
ext cmd apps)
(if (and (not (file-exists-p file))
(not org-open-non-existing-files))
(setq apps (append org-file-apps (org-default-apps)))
(if in-emacs
(setq cmd 'emacs)
- (setq cmd (or (cdr (assoc ext apps))
+ (setq cmd (or (and dirp (cdr (assoc 'directory apps)))
+ (cdr (assoc ext apps))
(cdr (assoc t apps)))))
+ (when (eq cmd 'mailcap)
+ (require 'mailcap)
+ (mailcap-parse-mailcaps)
+ (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
+ (command (mailcap-mime-info mime-type)))
+ (if (stringp command)
+ (setq cmd command)
+ (setq cmd 'emacs))))
(cond
((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
(setq cmd (format cmd (concat "\"" file "\"")))
(save-window-excursion
- (shell-command (concat cmd " & &"))))
+ (shell-command (concat cmd " &"))))
((or (stringp cmd)
(eq cmd 'emacs))
- (funcall (cdr (assq 'file org-link-frame-setup)) file)
- (if line (goto-line line)))
+ (unless (equal (file-truename file) (file-truename (or buffer-file-name "")))
+ (funcall (cdr (assq 'file org-link-frame-setup)) file))
+ (if line (goto-line line)
+ (if search (org-link-search search))))
((consp cmd)
(eval cmd))
- (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))))
+ (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
+ (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
+ (or (not (equal old-buffer (current-buffer)))
+ (not (equal old-pos (point))))
+ (org-mark-ring-push old-pos old-buffer))))
(defun org-default-apps ()
"Return the default applications for this operating system."
\\[org-insert-link].
For some link types, a prefix arg is interpreted:
For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
-For file links, arg negates `org-line-numbers-in-file-links'."
+For file links, arg negates `org-context-in-file-links'."
(interactive "P")
- (let (link cpltxt)
+ (let (link cpltxt desc txt (pos (point)))
(cond
((eq major-mode 'bbdb-mode)
(save-excursion
(vm-select-folder-buffer)
(let* ((message (car vm-message-pointer))
- (folder (buffer-file-name))
+ (folder buffer-file-name)
(subject (vm-su-subject message))
(author (vm-su-full-name message))
(message-id (vm-su-message-id message)))
+ (setq message-id (org-remove-angle-brackets message-id))
(setq folder (abbreviate-file-name folder))
(if (string-match (concat "^" (regexp-quote vm-folder-directory))
folder)
(setq folder (replace-match "" t t folder)))
(setq cpltxt (concat author " on: " subject))
- (setq link (concat cpltxt "\n "
- (org-make-link
- "vm:" folder "#" message-id))))))
+ (setq link (org-make-link "vm:" folder "#" message-id)))))
((eq major-mode 'wl-summary-mode)
(let* ((msgnum (wl-summary-message-number))
msgnum 'message-id))
(wl-message-entity (elmo-msgdb-overview-get-entity
msgnum (wl-summary-buffer-msgdb)))
- (author (wl-summary-line-from)) ; FIXME: how to get author name?
- (subject "???")) ; FIXME: How to get subject of email?
+ (author (wl-summary-line-from)) ; FIXME: correct?
+ (subject "???")) ; FIXME:
+ (setq message-id (org-remove-angle-brackets message-id))
(setq cpltxt (concat author " on: " subject))
- (setq link (concat cpltxt "\n "
- (org-make-link
- "wl:" wl-summary-buffer-folder-name
- "#" message-id)))))
+ (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
+ "#" message-id))))
+
+ ((or (equal major-mode 'mh-folder-mode)
+ (equal major-mode 'mh-show-mode))
+ (let ((from-header (org-mhe-get-header "From:"))
+ (to-header (org-mhe-get-header "To:"))
+ (subject (org-mhe-get-header "Subject:")))
+ (setq cpltxt (concat from-header " on: " subject))
+ (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
+ (org-remove-angle-brackets
+ (org-mhe-get-header "Message-Id:"))))))
((eq major-mode 'rmail-mode)
(save-excursion
(save-restriction
(rmail-narrow-to-non-pruned-header)
- (let ((folder (buffer-file-name))
+ (let ((folder buffer-file-name)
(message-id (mail-fetch-field "message-id"))
(author (mail-fetch-field "from"))
(subject (mail-fetch-field "subject")))
+ (setq message-id (org-remove-angle-brackets message-id))
(setq cpltxt (concat author " on: " subject))
- (setq link (concat cpltxt "\n "
- (org-make-link
- "rmail:" folder "#" message-id)))))))
+ (setq link (org-make-link "rmail:" folder "#" message-id))))))
((eq major-mode 'gnus-group-mode)
(let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
cpltxt "\n "
(format "http://groups.google.com/groups?as_umsgid=%s"
(org-fixup-message-id-for-http message-id))))
- (setq link (concat cpltxt "\n"
- (org-make-link
- "gnus:" group
- "#" (number-to-string article)))))))
+ (setq link (org-make-link "gnus:" group
+ "#" (number-to-string article))))))
((eq major-mode 'w3-mode)
(setq cpltxt (url-view-url t)
(setq cpltxt w3m-current-url
link (org-make-link cpltxt)))
- ((buffer-file-name)
- ;; Just link to this file here.
+ ((eq major-mode 'org-mode)
+ ;; Just link to current headline
(setq cpltxt (concat "file:"
- (abbreviate-file-name (buffer-file-name))))
- ;; Add the line number?
- (if (org-xor org-line-numbers-in-file-links arg)
+ (abbreviate-file-name buffer-file-name)))
+ ;; Add a context search string
+ (when (org-xor org-context-in-file-links arg)
+ ;; Check if we are on a target
+ (if (save-excursion
+ (skip-chars-forward "^>\n\r")
+ (and (re-search-backward "<<" nil t)
+ (looking-at "<<\\(.*?\\)>>")
+ (<= (match-beginning 0) pos)
+ (>= (match-end 0) pos)))
+ (setq cpltxt (concat cpltxt "::" (match-string 1)))
+ (setq txt (cond
+ ((org-on-heading-p) nil)
+ ((org-region-active-p)
+ (buffer-substring (region-beginning) (region-end)))
+ (t (buffer-substring (point-at-bol) (point-at-eol)))))
(setq cpltxt
- (concat cpltxt
- ":" (int-to-string
- (+ (if (bolp) 1 0) (count-lines
- (point-min) (point)))))))
+ (concat cpltxt "::"
+ (if org-file-link-context-use-camel-case
+ (org-make-org-heading-camel txt)
+ (org-make-org-heading-search-string txt)))
+ desc "NONE")))
+ (if (string-match "::\\'" cpltxt)
+ (setq cpltxt (substring cpltxt 0 -2)))
+ (setq link (org-make-link cpltxt)))
+
+ (buffer-file-name
+ ;; Just link to this file here.
+ (setq cpltxt (concat "file:"
+ (abbreviate-file-name buffer-file-name)))
+ ;; Add a context string
+ (when (org-xor org-context-in-file-links arg)
+ (setq txt (if (org-region-active-p)
+ (buffer-substring (region-beginning) (region-end))
+ (buffer-substring (point-at-bol) (point-at-eol))))
+ (setq cpltxt
+ (concat cpltxt "::"
+ (if org-file-link-context-use-camel-case
+ (org-make-org-heading-camel txt)
+ (org-make-org-heading-search-string txt)))
+ desc "NONE"))
(setq link (org-make-link cpltxt)))
((interactive-p)
(t (setq link nil)))
+ (if (consp link) (setq cpltxt (car link) link (cdr link)))
+ (setq link (or link cpltxt)
+ desc (or desc cpltxt))
+ (if (equal desc "NONE") (setq desc nil))
+
(if (and (interactive-p) link)
(progn
(setq org-stored-links
- (cons (cons (or cpltxt link) link) org-stored-links))
+ (cons (list cpltxt link desc) org-stored-links))
(message "Stored: %s" (or cpltxt link)))
- link)))
+ (org-make-link-string link desc))))
+
+(defun org-make-org-heading-search-string (&optional string heading)
+ "Make search string for STRING or current headline."
+ (interactive)
+ (let ((s (or string (org-get-heading))))
+ (unless (and string (not heading))
+ ;; We are using a headline, clean up garbage in there.
+ (if (string-match org-todo-regexp s)
+ (setq s (replace-match "" t t s)))
+ (if (string-match ":[a-zA-Z_@0-9:]+:[ \t]*$" s)
+ (setq s (replace-match "" t t s)))
+ (setq s (org-trim s))
+ (if (string-match (concat "^\\(" org-quote-string "\\|"
+ org-comment-string "\\)") s)
+ (setq s (replace-match "" t t s)))
+ (while (string-match org-ts-regexp s)
+ (setq s (replace-match "" t t s))))
+ (while (string-match "[^a-zA-Z_0-9 \t]+" s)
+ (setq s (replace-match " " t t s)))
+ (or string (setq s (concat "*" s))) ; Add * for headlines
+ (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
+
+(defun org-make-org-heading-camel (&optional string heading)
+ "Make a CamelCase string for STRING or the current headline."
+ (interactive)
+ (let ((s (or string (org-get-heading))))
+ (unless (and string (not heading))
+ ;; We are using a headline, clean up garbage in there.
+ (if (string-match org-todo-regexp s)
+ (setq s (replace-match "" t t s)))
+ (if (string-match ":[a-zA-Z_@0-9:]+:[ \t]*$" s)
+ (setq s (replace-match "" t t s)))
+ (setq s (org-trim s))
+ (if (string-match (concat "^\\(" org-quote-string "\\|"
+ org-comment-string "\\)") s)
+ (setq s (replace-match "" t t s)))
+ (while (string-match org-ts-regexp s)
+ (setq s (replace-match "" t t s))))
+ (while (string-match "[^a-zA-Z_ \t]+" s)
+ (setq s (replace-match " " t t s)))
+ (or string (setq s (concat "*" s))) ; Add * for headlines
+ (mapconcat 'capitalize (org-split-string s "[ \t]+") "")))
(defun org-make-link (&rest strings)
"Concatenate STRINGS, format resulting string with `org-link-format'."
(format org-link-format (apply 'concat strings)))
+(defun org-make-link-string (link &optional description)
+ "Make a link with brackets, consisting of LINK and DESCRIPTION."
+ (if (eq org-link-style 'plain)
+ (if (equal description link)
+ link
+ (concat description "\n" link))
+ (when (stringp description)
+ ;; Remove brackets from the description, they are fatal.
+ (while (string-match "\\[\\|\\]" description)
+ (setq description (replace-match "" t t description))))
+ (when (equal (org-link-escape link) description)
+ ;; No description needed, it is identical
+ (setq description nil))
+ (when (and (not description)
+ (not (equal link (org-link-escape link))))
+ (setq description link))
+ (concat "[[" (org-link-escape link) "]"
+ (if description (concat "[" description "]") "")
+ "]")))
+
+(defconst org-link-escape-chars '(("[" . "%5B") ("]" . "%5D") (" " . "%20"))
+ "Association list of escapes for some characters problematic in links.")
+
+(defun org-link-escape (text)
+ "Escape charaters in TEXT that are problematic for links."
+ (when text
+ (let ((re (mapconcat (lambda (x) (regexp-quote (car x)))
+ org-link-escape-chars "\\|")))
+ (while (string-match re text)
+ (setq text
+ (replace-match
+ (cdr (assoc (match-string 0 text) org-link-escape-chars))
+ t t text)))
+ text)))
+
+(defun org-link-unescape (text)
+ "Reverse the action of `org-link-escape'."
+ (when text
+ (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
+ org-link-escape-chars "\\|")))
+ (while (string-match re text)
+ (setq text
+ (replace-match
+ (car (rassoc (match-string 0 text) org-link-escape-chars))
+ t t text)))
+ text)))
+
(defun org-xor (a b)
"Exclusive or."
(if a (not b) b))
stored link. As SPC triggers completion in the minibuffer, you need to
use M-SPC or C-q SPC to force the insertion of a space character.
+You will also be prompted for a description, and if one is given, it will
+be displayed in the buffer instead of the link.
+
+If there is already a link at point, this command will allow you to edit link
+and description parts.
+
With a \\[universal-argument] prefix, prompts for a file to link to. The file name can be
selected using completion. The path to the file will be relative to
the current directory if the file is in the current directory or a
With two \\[universal-argument] prefixes, enforce an absolute path even if the file
is in the current directory or below."
(interactive "P")
- (let ((link (if complete-file
- (read-file-name "File: ")
- (completing-read
- "Link: " org-stored-links nil nil nil
- org-insert-link-history
- (or (car (car org-stored-links))))))
- linktxt matched)
- (if (or (not link) (equal link ""))
- (error "No links available"))
- (if complete-file
- (let ((pwd (file-name-as-directory (expand-file-name "."))))
- (cond
- ((equal complete-file '(16))
- (insert
- (org-make-link
- "file:" (abbreviate-file-name (expand-file-name link)))))
- ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
- (expand-file-name link))
- (insert
- (org-make-link
- "file:" (match-string 1 (expand-file-name link)))))
- (t (insert (org-make-link "file:" link)))))
- (setq linktxt (cdr (assoc link org-stored-links)))
+ (let (link desc entry remove file (pos (point)))
+ (cond
+ ((save-excursion
+ (skip-chars-forward "^]\n\r")
+ (and (re-search-backward "\\[\\[" nil t)
+ (looking-at org-bracket-link-regexp)
+ (<= (match-beginning 0) pos)
+ (>= (match-end 0) pos)))
+ ;; We do have a link at point, and we are going to edit it.
+ (setq remove (list (match-beginning 0) (match-end 0)))
+ (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
+ (setq link (read-string "Link: "
+ (org-link-unescape
+ (org-match-string-no-properties 1)))))
+ (complete-file
+ ;; Completing read for file names.
+ (setq file (read-file-name "File: "))
+ (let ((pwd (file-name-as-directory (expand-file-name "."))))
+ (cond
+ ((equal complete-file '(16))
+ (setq link (org-make-link
+ "file:"
+ (abbreviate-file-name (expand-file-name file)))))
+ ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
+ (expand-file-name file))
+ (setq link (org-make-link
+ "file:" (match-string 1 (expand-file-name file)))))
+ (t (setq link (org-make-link "file:" file))))))
+ (t
+ ;; Read link, with completion for stored links.
+ (setq link (org-completing-read
+ "Link: " org-stored-links nil nil nil
+ org-insert-link-history
+ (or (car (car org-stored-links)))))
+ (setq entry (assoc link org-stored-links))
(if (not org-keep-stored-link-after-insertion)
(setq org-stored-links (delq (assoc link org-stored-links)
org-stored-links)))
- (if (not linktxt) (setq link (org-make-link link)))
- (let ((lines (org-split-string (or linktxt link) "\n")))
- (insert (car lines))
- (setq matched (string-match org-link-regexp (car lines)))
- (setq lines (cdr lines))
- (while lines
- (insert "\n")
- (if (save-excursion
- (beginning-of-line 0)
- (looking-at "[ \t]+\\S-"))
- (indent-relative))
- (setq matched (or matched
- (string-match org-link-regexp (car lines))))
- (insert (car lines))
- (setq lines (cdr lines))))
- (unless matched
- (error "Add link type: http(s),ftp,mailto,file,news,bbdb,vm,wl,rmail,gnus, or shell")))))
+ (setq link (if entry (nth 1 entry) link)
+ desc (or desc (nth 2 entry)))))
+
+ (if (string-match org-plain-link-re link)
+ ;; URL-like link, normalize the use of angular brackets.
+ (setq link (org-make-link (org-remove-angle-brackets link))))
+
+ ;; Check if we are linking to the current file. If yes, simplify the link.
+ (when (string-match "\\<file:\\(.+?\\)::\\([^>]+\\)" link)
+ (let* ((path (match-string 1 link))
+ (case-fold-search nil)
+ (search (match-string 2 link)))
+ (when (save-match-data
+ (equal (file-truename buffer-file-name)
+ (file-truename path)))
+ ;; We are linking to this same file, with a search option
+ (setq link search))))
+ (setq desc (read-string "Description: " desc))
+ (unless (string-match "\\S-" desc) (setq desc nil))
+ (if remove (apply 'delete-region remove))
+ (insert (org-make-link-string link desc))))
+
+(defun org-completing-read (&rest args)
+ (let ((minibuffer-local-completion-map
+ (copy-keymap minibuffer-local-completion-map)))
+ (define-key minibuffer-local-completion-map " " 'self-insert-command)
+ (apply 'completing-read args)))
;;; Hooks for remember.el
+
+(defvar org-finish-function nil)
+
;;;###autoload
(defun org-remember-annotation ()
"Return a link to the current location as an annotation for remember.el.
RET on headline -> Store as sublevel entry to current headline
<left>/<right> -> before/after current headline, same headings level")
+;;;###autoload
+(defun org-remember-apply-template ()
+ "Initialize *remember* buffer with template, invode `org-mode'.
+This function should be placed into `remember-mode-hook' and in fact requires
+to be run from that hook to fucntion properly."
+ (when org-remember-templates
+ (let* ((entry (if (= (length org-remember-templates) 1)
+ (cdar org-remember-templates)
+ (message "Select template: %s"
+ (mapconcat
+ (lambda (x) (char-to-string (car x)))
+ org-remember-templates " "))
+ (cdr (assoc (read-char-exclusive) org-remember-templates))))
+ (tpl (if (consp (cdr entry)) (cadr entry) (cdr entry)))
+ (file (if (consp (cdr entry)) (nth 2 entry)))
+ (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
+ (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
+ (v-u (concat "[" (substring v-t 1 -1) "]"))
+ (v-U (concat "[" (substring v-T 1 -1) "]"))
+ (v-a annotation) ; defined in `remember-mode'
+ (v-i initial) ; defined in `remember-mode'
+ (v-n user-full-name)
+ )
+ (unless tpl (setq tpl "") (message "No template") (ding))
+ (insert tpl) (goto-char (point-min))
+ (while (re-search-forward "%\\([tTuTai]\\)" nil t)
+ (when (and initial (equal (match-string 0) "%i"))
+ (save-match-data
+ (let* ((lead (buffer-substring
+ (point-at-bol) (match-beginning 0))))
+ (setq v-i (mapconcat 'identity
+ (org-split-string initial "\n")
+ (concat "\n" lead))))))
+ (replace-match
+ (or (eval (intern (concat "v-" (match-string 1)))) "")
+ t t))
+ (let ((org-startup-folded nil)
+ (org-startup-with-deadline-check nil))
+ (org-mode))
+ (if (and file (string-match "\\S-" file) (not (file-directory-p file)))
+ (set (make-local-variable 'org-default-notes-file) file))
+ (goto-char (point-min))
+ (if (re-search-forward "%\\?" nil t) (replace-match ""))
+ (set (make-local-variable 'org-finish-function) 'remember-buffer))))
+
;;;###autoload
(defun org-remember-handler ()
"Store stuff from remember.el into an org file.
Then the command offers the headings tree of the selected file in order to
file the text at a specific location.
You can either immediately press RET to get the note appended to the
-file. Or you can use vertical cursor motion and visibility cycling (TAB) to
+file, or you can use vertical cursor motion and visibility cycling (TAB) to
find a better place. Then press RET or <left> or <right> in insert the note.
Key Cursor position Note gets inserted
(visiting (find-buffer-visiting file))
(org-startup-with-deadline-check nil)
(org-startup-folded nil)
+ (org-startup-align-all-tables nil)
spos level indent reversed)
;; Modify text so that it becomes a nice subtree which can be inserted
;; into an org tree.
(let* ((lines (split-string txt "\n"))
- (first (car lines))
- (lines (cdr lines)))
+ first)
+ ;; remove empty lines at the beginning
+ (while (and lines (string-match "^[ \t]*\n" (car lines)))
+ (setq lines (cdr lines)))
+ (setq first (car lines) lines (cdr lines))
(if (string-match "^\\*+" first)
;; Is already a headline
- (setq indent (make-string (- (match-end 0) (match-beginning 0)
- -1) ?\ ))
+ (setq indent nil)
;; We need to add a headline: Use time and first buffer line
(setq lines (cons first lines)
first (concat "* " (current-time-string)
" (" (remember-buffer-desc) ")")
indent " "))
- (if org-adapt-indentation
+ (if (and org-adapt-indentation indent)
(setq lines (mapcar (lambda (x) (concat indent x)) lines)))
(setq txt (concat first "\n"
(mapconcat 'identity lines "\n"))))
(widen)
(goto-char (if reversed (point-min) (point-max)))
(if (not (bolp)) (newline))
- (org-paste-subtree (or current-prefix-arg 2) txt)))
+ (org-paste-subtree 2 txt)))
((and (org-on-heading-p nil) (not current-prefix-arg))
;; Put it below this entry, at the beg/end of the subtree
(org-back-to-heading)
- (setq level (outline-level))
+ (setq level (funcall outline-level))
(if reversed
(outline-end-of-heading)
(outline-end-of-subtree))
(let ((all org-reverse-note-order)
entry)
(while (setq entry (pop all))
- (if (string-match (car entry) (buffer-file-name))
+ (if (string-match (car entry) buffer-file-name)
(throw 'exit (cdr entry))))
nil)))))
(org-table-convert)))
(t (call-interactively 'table-insert))))
+(defun org-table-create-or-convert-from-region (arg)
+ "Convert region to table, or create an empty table.
+If there is an active region, convert it to a table. If there is no such
+region, create an empty table."
+ (interactive "P")
+ (if (org-region-active-p)
+ (org-table-convert-region (region-beginning) (region-end) arg)
+ (org-table-create arg)))
+
(defun org-table-create (&optional size)
"Query for a size and insert a table skeleton.
SIZE is a string Columns x Rows like for example \"3x2\"."
(goto-char pos)))
(org-table-align)))
-(defun org-table-convert-region (beg0 end0 nspace)
+(defun org-table-convert-region (beg0 end0 &optional nspace)
"Convert region to a table.
The region goes from BEG0 to END0, but these borders will be moved
slightly, to make sure a beginning of line in the first line is included.
When NSPACE is non-nil, it indicates the minimum number of spaces that
-separate columns (default: just one space)"
+separate columns (default: just one space)."
+ (interactive "rP")
(let* ((beg (min beg0 end0))
(end (max beg0 end0))
(tabsep t)
(defvar org-table-last-alignment nil
"List of flags for flushright alignment, from the last re-alignment.
This is being used to correctly align a single field after TAB or RET.")
-;; FIXME: The following is currently not used.
(defvar org-table-last-column-widths nil
"List of max width of fields in each column.
This is being used to correctly align a single field after TAB or RET.")
(defvar org-last-recalc-line nil)
+(defconst org-narrow-column-arrow "=>"
+ "Used as display property in narrowed table columns.")
(defun org-table-align ()
"Align the table at point by aligning all vertical bars."
(interactive)
- ;; (message "align") (sit-for 2)
(let* (
;; Limits of table
(beg (org-table-begin))
column
(indent "") cnt frac
rfmt hfmt
- (spaces (if (org-in-invisibility-spec-p '(org-table))
- org-table-spaces-around-invisible-separators
- org-table-spaces-around-separators))
+ (spaces '(1 . 1))
(sp1 (car spaces))
(sp2 (cdr spaces))
(rfmt1 (concat
(make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
(hfmt1 (concat
(make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
- emptystrings)
+ emptystrings xx links narrow fmax fmin f1 len c e)
(untabify beg end)
- ;; (message "Aligning table...")
+ (remove-text-properties beg end '(org-cwidth t display t))
+ ;; Check if we have links
+ (goto-char beg)
+ (setq links (re-search-forward org-bracket-link-regexp end t))
+ ;; Make sure the link properties are right FIXME: Can this be optimized????
+ (when links (goto-char beg) (while (org-activate-bracket-links end)))
+ ;; Check if we are narrowing any columns
+ (goto-char beg)
+ (setq narrow (and org-format-transports-properties-p
+ (re-search-forward "<[0-9]+>" end t)))
;; Get the rows
(setq lines (org-split-string
- (buffer-substring-no-properties beg end) "\n"))
+ (buffer-substring beg end) "\n"))
;; Store the indentation of the first line
(if (string-match "^ *" (car lines))
(setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
- ;; Mark the hlines
+ ;; Mark the hlines by setting the corresponding element to nil
+ ;; At the same time, we remove trailing space.
(setq lines (mapcar (lambda (l)
(if (string-match "^ *|-" l)
nil
(substring l 0 (match-beginning 0))
l)))
lines))
- ;; Get the data fields
+ ;; Get the data fields by splitting the lines.
(setq fields (mapcar
(lambda (l)
(org-split-string l " *| *"))
(error "Empty table - created default table")))
;; A list of empty string to fill any short rows on output
(setq emptystrings (make-list maxfields ""))
- ;; Get the maximum length of a field and the most common datatype
- ;; for each column
+ ;; Check for special formatting.
(setq i -1)
(while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
(setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
- ;; maximum length
- (push (apply 'max 1 (mapcar 'length column)) lengths)
- ;; compute the fraction stepwise, ignoring empty fields
+ ;; Check if there is an explicit width specified
+ (when (and org-table-limit-column-width narrow)
+ (setq c column fmax nil)
+ (while c
+ (setq e (pop c))
+ (if (and (stringp e) (string-match "^<\\([0-9]+\\)>$" e))
+ (setq fmax (string-to-number (match-string 1 e)) c nil)))
+ ;; Find fields that are wider than fmax, and shorten them
+ (when fmax
+ (loop for xx in column do
+ (when (and (stringp xx)
+ (> (org-string-width xx) fmax))
+ (org-add-props xx nil
+ 'help-echo
+ (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (copy-sequence xx)))
+ (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
+ (unless (> f1 1)
+ (error "Cannot narrow field starting with wide link \"%s\""
+ (match-string 0 xx)))
+ (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
+ (add-text-properties (- f1 2) f1
+ (list 'display org-narrow-column-arrow)
+ xx)))))
+ ;; Get the maximum width for each column
+ (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
+ ;; Get the fraction of numbers, to decide about alignment of the column
(setq cnt 0 frac 0.0)
- (mapcar
- (lambda (x)
- (if (equal x "")
- nil
- (setq frac ( / (+ (* frac cnt)
- (if (string-match org-table-number-regexp x) 1 0))
- (setq cnt (1+ cnt))))))
- column)
+ (loop for x in column do
+ (if (equal x "")
+ nil
+ (setq frac ( / (+ (* frac cnt)
+ (if (string-match org-table-number-regexp x) 1 0))
+ (setq cnt (1+ cnt))))))
(push (>= frac org-table-number-fraction) typenums))
- (setq lengths (nreverse lengths)
- typenums (nreverse typenums))
+ (setq lengths (nreverse lengths) typenums (nreverse typenums))
+
+ ;; Store the alignment of this table, for later editing of single fields
(setq org-table-last-alignment typenums
org-table-last-column-widths lengths)
+
+ ;; With invisible characters, `format' does not get the field width right
+ ;; So we need to make these fields wide by hand.
+ (when links
+ (loop for i from 0 upto (1- maxfields) do
+ (setq len (nth i lengths))
+ (loop for j from 0 upto (1- (length fields)) do
+ (setq c (nthcdr i (car (nthcdr j fields))))
+ (if (and (stringp (car c))
+ (string-match org-bracket-link-regexp (car c))
+ (< (org-string-width (car c)) len))
+ (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
+
;; Compute the formats needed for output of the table
(setq rfmt (concat indent "|") hfmt (concat indent "|"))
(while (setq l (pop lengths))
hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
(setq rfmt (concat rfmt "\n")
hfmt (concat (substring hfmt 0 -1) "|\n"))
- ;; Produce the new table
- ;;(while lines
- ;; (setq l (pop lines))
- ;; (if l
- ;; (setq new (concat new (apply 'format rfmt
- ;; (append (pop fields) emptystrings))))
- ;; (setq new (concat new hfmt))))
+
(setq new (mapconcat
(lambda (l)
(if l (apply 'format rfmt
(move-marker org-table-aligned-begin-marker (point))
(insert new)
(move-marker org-table-aligned-end-marker (point))
+ (when (and orgtbl-mode (not (eq major-mode 'org-mode)))
+ (goto-char org-table-aligned-begin-marker)
+ (while (org-hide-wide-columns org-table-aligned-end-marker)))
;; Try to move to the old location (approximately)
(goto-line linepos)
(set-window-start (selected-window) winstart 'noforce)
(org-table-goto-column colpos)
(setq org-table-may-need-update nil)
- (if (org-in-invisibility-spec-p '(org-table))
- (org-table-add-invisible-to-vertical-lines))
))
+(defun org-string-width (s)
+ "Compute width of string, ignoring invisible characters.
+This ignores character with invisibility property `org-link', and also
+characters with property `org-cwidth', because these will become invisible
+upon the next fontification round."
+ (let (b)
+ (when (or (eq t buffer-invisibility-spec)
+ (assq 'org-link buffer-invisibility-spec))
+ (while (setq b (text-property-any 0 (length s)
+ 'invisible 'org-link s))
+ (setq s (concat (substring s 0 b)
+ (substring s (or (next-single-property-change
+ b 'invisible s) (length s)))))))
+ (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
+ (setq s (concat (substring s 0 b)
+ (substring s (or (next-single-property-change
+ b 'org-cwidth s) (length s))))))
+ (string-width s)))
+
(defun org-table-begin (&optional table-type)
"Find the beginning of the table and return its position.
With argument TABLE-TYPE, go to the beginning of a table.el-type table."
Optional argument NEW may specify text to replace the current field content."
(cond
((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
- ((org-at-table-hline-p)
- ;; FIXME: I used to enforce realign here, but I think this is not needed.
- ;; (setq org-table-may-need-update t)
- )
+ ((org-at-table-hline-p))
((and (not new)
(or (not (equal (marker-buffer org-table-aligned-begin-marker)
(current-buffer)))
(t ;; realign the current field, based on previous full realign
(let* ((pos (point)) s
(col (org-table-current-column))
- (num (nth (1- col) org-table-last-alignment))
+ (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
l f n o e)
(when (> col 0)
(skip-chars-backward "^|\n")
(goto-char pos))))))
(defun org-table-next-field ()
- "Go to the next field in the current table.
+ "Go to the next field in the current table, creating new lines as needed.
Before doing so, re-align the table if necessary."
(interactive)
(org-table-maybe-eval-formula)
(if (and org-table-automatic-realign
org-table-may-need-update)
(org-table-align))
- (if (org-at-table-hline-p)
- (end-of-line 1))
- (condition-case nil
- (progn
- (re-search-forward "|" (org-table-end))
- (if (looking-at "[ \t]*$")
- (re-search-forward "|" (org-table-end)))
- (if (looking-at "-")
- (progn
- (beginning-of-line 0)
- (org-table-insert-row 'below))
- (if (looking-at " ") (forward-char 1))))
- (error
- (org-table-insert-row 'below))))
+ (let ((end (org-table-end)))
+ (if (org-at-table-hline-p)
+ (end-of-line 1))
+ (condition-case nil
+ (progn
+ (re-search-forward "|" end)
+ (if (looking-at "[ \t]*$")
+ (re-search-forward "|" end))
+ (if (and (looking-at "-")
+ org-table-tab-jumps-over-hlines
+ (re-search-forward "^[ \t]*|\\([^-]\\)" end t))
+ (goto-char (match-beginning 1)))
+ (if (looking-at "-")
+ (progn
+ (beginning-of-line 0)
+ (org-table-insert-row 'below))
+ (if (looking-at " ") (forward-char 1))))
+ (error
+ (org-table-insert-row 'below)))))
(defun org-table-previous-field ()
"Go to the previous field in the table.
(if (looking-at "|[^|\n]+")
(let* ((pos (match-beginning 0))
(match (match-string 0))
- (len (length match)))
+ (len (org-string-width match)))
(replace-match (concat "|" (make-string (1- len) ?\ )))
(goto-char (+ 2 pos))
(substring match 1)))))
of the field.
If there are less than N fields, just go to after the last delimiter.
However, when FORCE is non-nil, create new columns if necessary."
+ (interactive "p")
(let ((pos (point-at-eol)))
(beginning-of-line 1)
(when (> n 0)
(defun org-at-table-p (&optional table-type)
"Return t if the cursor is inside an org-type table.
-If TABLE-TYPE is non-nil, also chack for table.el-type tables."
+If TABLE-TYPE is non-nil, also check for table.el-type tables."
(if org-enable-table-editor
(save-excursion
(beginning-of-line 1)
org-table-line-regexp)))
nil))
+(defun org-at-table.el-p ()
+ "Return t if and only if we are at a table.el table."
+ (and (org-at-table-p 'any)
+ (save-excursion
+ (goto-char (org-table-begin 'any))
+ (looking-at org-table1-hline-regexp))))
+
(defun org-table-recognize-table.el ()
"If there is a table.el table nearby, recognize it and move into it."
(if org-table-tab-recognizes-table.el
nil)
nil))
-(defun org-at-table.el-p ()
- "Return t if the cursor is inside a table.el-type table."
- (save-excursion
- (if (org-at-table-p 'any)
- (progn
- (goto-char (org-table-begin 'any))
- (looking-at org-table1-hline-regexp))
- nil)))
-
(defun org-at-table-hline-p ()
"Return t if the cursor is inside a hline in a table."
(if org-enable-table-editor
(org-table-modify-formulas 'swap col (if left (1- col) (1+ col)))))
(defun org-table-move-row-down ()
- "move table row down."
+ "Move table row down."
(interactive)
(org-table-move-row nil))
(defun org-table-move-row-up ()
- "move table row up."
+ "Move table row up."
(interactive)
(org-table-move-row 'up))
(interactive "P")
(if (not (org-at-table-p))
(error "Not at a table"))
- (let* ((line (buffer-substring-no-properties (point-at-bol) (point-at-eol)))
- new)
- (if (string-match "^[ \t]*|-" line)
- (setq new (mapcar (lambda (x) (if (member x '(?| ?+)) ?| ?\ )) line))
- (setq new (mapcar (lambda (x) (if (equal x ?|) ?| ?\ )) line)))
+ (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
+ (new (org-table-clean-line line)))
;; Fix the first field if necessary
- (setq new (concat new))
(if (string-match "^[ \t]*| *[#$] *|" line)
(setq new (replace-match (match-string 0 line) t t new)))
(beginning-of-line (if arg 2 1))
- (let (org-table-may-need-update)
- (insert-before-markers new)
- (insert-before-markers "\n"))
+ (let (org-table-may-need-update) (insert-before-markers new "\n"))
(beginning-of-line 0)
(re-search-forward "| ?" (point-at-eol) t)
(and org-table-may-need-update (org-table-align))))
(interactive "P")
(if (not (org-at-table-p))
(error "Not at a table"))
- (let ((line (buffer-substring-no-properties (point-at-bol) (point-at-eol)))
- (col (current-column))
- start)
- (if (string-match "^[ \t]*|-" line)
- (setq line
- (mapcar (lambda (x) (if (member x '(?| ?+))
- (prog1 (if start ?+ ?|) (setq start t))
- (if start ?- ?\ )))
- line))
- (setq line
- (mapcar (lambda (x) (if (equal x ?|)
- (prog1 (if start ?+ ?|) (setq start t))
- (if start ?- ?\ )))
- line)))
+ (let ((line (org-table-clean-line
+ (buffer-substring (point-at-bol) (point-at-eol))))
+ (col (current-column)))
+ (while (string-match "|\\( +\\)|" line)
+ (setq line (replace-match
+ (concat "+" (make-string (- (match-end 1) (match-beginning 1))
+ ?-) "|") t t line)))
+ (and (string-match "\\+" line) (setq line (replace-match "|" t t line)))
(beginning-of-line (if arg 1 2))
- (apply 'insert line)
- (if (equal (char-before (point)) ?+)
- (progn (backward-delete-char 1) (insert "|")))
- (insert "\n")
- (beginning-of-line 0)
+ (insert line "\n")
+ (beginning-of-line (if arg 1 -1))
(move-to-column col)))
+(defun org-table-clean-line (s)
+ "Convert a table line S into a string with only \"|\" and space.
+In particular, this does handle wide and invisible characters."
+ (if (string-match "^[ \t]*|-" s)
+ ;; It's a hline, just map the characters
+ (setq s (mapcar (lambda (x) (if (member x '(?| ?+)) ?| ?\ )) s))
+ (while (string-match "|\\([ \t]*?[^ \t\r\n|][^\r\n|]*\\)|" s)
+ (setq s (replace-match
+ (concat "|" (make-string (org-string-width (match-string 1 s))
+ ?\ ) "|")
+ t t s)))
+ s))
+
(defun org-table-kill-row ()
"Delete the current row or horizontal line from the table."
(interactive)
(if (not (org-at-table-p)) (beginning-of-line 0))
(move-to-column col)))
+(defun org-table-sort-lines (beg end numericp)
+ "Sort table lines in region.
+Point and mark define the first and last line to include. Both point and
+mark should be in the column that is used for sorting. For example, to
+sort according to column 3, put the mark in the first line to sort, in
+table column 3. Put point into the last line to be included in the sorting,
+also in table column 3. The command will prompt for the sorting method
+\(n for numerical, a for alphanumeric)."
+ (interactive "r\nsSorting method: [n]=numeric [a]=alpha: ")
+ (setq numericp (string-match "[nN]" numericp))
+ (org-table-align) ;; Just to be safe
+ (let* (bcol ecol cmp column lns)
+ (goto-char beg)
+ (org-table-check-inside-data-field)
+ (setq column (org-table-current-column)
+ beg (move-marker (make-marker) (point-at-bol)))
+ (goto-char end)
+ (org-table-check-inside-data-field)
+ (setq end (move-marker (make-marker) (1+ (point-at-eol))))
+ (untabify beg end)
+ (goto-char beg)
+ (org-table-goto-column column)
+ (skip-chars-backward "^|")
+ (setq bcol (current-column))
+ (org-table-goto-column (1+ column))
+ (skip-chars-backward "^|")
+ (setq ecol (1- (current-column)))
+ (setq cmp (if numericp
+ (lambda (a b) (< (car a) (car b)))
+ (lambda (a b) (string< (car a) (car b)))))
+ (setq lns (mapcar (lambda(x) (cons (org-trim (substring x bcol ecol)) x))
+ (split-string (buffer-substring beg end) "\n")))
+ (if numericp
+ (setq lns (mapcar (lambda(x)
+ (cons (string-to-number (car x)) (cdr x)))
+ lns)))
+ (delete-region beg end)
+ (move-marker beg nil)
+ (move-marker end nil)
+ (insert (mapconcat 'cdr (setq lns (sort lns cmp)) "\n") "\n")
+ (message "%d lines sorted %s based on column %d"
+ (length lns)
+ (if numericp "numerically" "alphabetically") column)))
(defun org-table-cut-region (beg end)
"Copy region in table to the clipboard and blank all relevant fields."
(defun org-table-copy-region (beg end &optional cut)
"Copy rectangular region in table to clipboard.
A special clipboard is used which can only be accessed
-with `org-table-paste-rectangle'"
+with `org-table-paste-rectangle'."
(interactive "rP")
(let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
region cols
;; insert a hline before first
(goto-char beg)
(org-table-insert-hline 'above)
+ (beginning-of-line -1)
;; insert a hline after each line
- (while (progn (beginning-of-line 2) (< (point) end))
+ (while (progn (beginning-of-line 3) (< (point) end))
(org-table-insert-hline))
(goto-char beg)
(setq end (move-marker end (org-table-end)))
the text in the column is wrapped to minimum width for the given number of
lines. Generally, this makes the table more compact. A prefix ARG may be
used to change the number of desired lines. For example, `C-2 \\[org-table-wrap]'
-formats the selected text to two lines. If the region was longer than 2
+formats the selected text to two lines. If the region was longer than two
lines, the remaining lines remain empty. A negative prefix argument reduces
the current number of lines by that amount. The wrapped text is pasted back
into the table. If you formatted it to more lines than it was before, fields
(insert (org-trim s) " ")
(org-table-align))))))
+(defvar org-field-marker nil)
+
+(defun org-table-edit-field (arg)
+ "Edit table field in a different window.
+This is mainly useful for fields that contain hidden parts.
+When called with a \\[universal-argument] prefix, just make the full field visible so that
+it can be edited in place."
+ (interactive "P")
+ (if arg
+ (let ((b (save-excursion (skip-chars-backward "^|") (point)))
+ (e (save-excursion (skip-chars-forward "^|\r\n") (point))))
+ (remove-text-properties b e '(org-cwidth t invisible t
+ display t intangible t))
+ (if (and (boundp 'font-lock-mode) font-lock-mode)
+ (font-lock-fontify-block)))
+ (let ((pos (move-marker (make-marker) (point)))
+ (field (org-table-get-field))
+ (cw (current-window-configuration))
+ p)
+ (switch-to-buffer-other-window "*Org tmp*")
+ (erase-buffer)
+ (insert "#\n# Edit field and finish with C-c C-c\n#\n")
+ (org-mode)
+ (goto-char (setq p (point-max)))
+ (insert (org-trim field))
+ (remove-text-properties p (point-max)
+ '(invisible t org-cwidth t display t
+ intangible t))
+ (goto-char p)
+ (set (make-local-variable 'org-finish-function)
+ 'org-table-finish-edit-field)
+ (set (make-local-variable 'org-window-configuration) cw)
+ (set (make-local-variable 'org-field-marker) pos)
+ (message "Edit and finish with C-c C-c"))))
+
+(defun org-table-finish-edit-field ()
+ "Finish editing a table data field.
+Remove all newline characters, insert the result into the table, realign
+the table and kill the editing buffer."
+ (let ((pos org-field-marker)
+ (cw org-window-configuration)
+ (cb (current-buffer))
+ text)
+ (goto-char (point-min))
+ (while (re-search-forward "^#.*\n?" nil t) (replace-match ""))
+ (while (re-search-forward "\\([ \t]*\n[ \t]*\\)+" nil t)
+ (replace-match " "))
+ (setq text (org-trim (buffer-string)))
+ (set-window-configuration cw)
+ (kill-buffer cb)
+ (select-window (get-buffer-window (marker-buffer pos)))
+ (goto-char pos)
+ (move-marker pos nil)
+ (org-table-check-inside-data-field)
+ (org-table-get-field nil text)
+ (org-table-align)
+ (message "New field value inserted")))
+
(defun org-trim (s)
"Remove whitespace at beginning and end of string."
(if (string-match "^[ \t]+" s) (setq s (replace-match "" t t s)))
many lines, whatever width that takes.
The return value is a list of lines, without newlines at the end."
(let* ((words (org-split-string string "[ \t\n]+"))
- (maxword (apply 'max (mapcar 'length words)))
+ (maxword (apply 'max (mapcar 'org-string-width words)))
w ll)
(cond (width
(org-do-wrap words (max maxword width)))
(setq lines (push line lines)))
(nreverse lines)))
-;; FIXME: I think I can make this more efficient
(defun org-split-string (string &optional separators)
"Splits STRING into substrings at SEPARATORS.
No empty strings are returned if there are matches at the beginning
list)))
(nreverse list)))
-(defun org-table-add-invisible-to-vertical-lines ()
- "Add an `invisible' property to vertical lines of current table."
- (interactive)
- (let* ((beg (org-table-begin))
- (end (org-table-end))
- (end1))
- (save-excursion
- (goto-char beg)
- (while (< (point) end)
- (setq end1 (point-at-eol))
- (if (looking-at org-table-dataline-regexp)
- (while (re-search-forward "|" end1 t)
- (add-text-properties (1- (point)) (point)
- '(invisible org-table)))
- (while (re-search-forward "[+|]" end1 t)
- (add-text-properties (1- (point)) (point)
- '(invisible org-table))))
- (beginning-of-line 2)))))
-
-(defun org-table-toggle-vline-visibility (&optional arg)
- "Toggle the visibility of table vertical lines.
-The effect is immediate and on all tables in the file.
-With prefix ARG, make lines invisible when ARG is positive, make lines
-visible when ARG is not positive"
- (interactive "P")
- (let ((action (cond
- ((and arg (> (prefix-numeric-value arg) 0)) 'on)
- ((and arg (< (prefix-numeric-value arg) 1)) 'off)
- (t (if (org-in-invisibility-spec-p '(org-table))
- 'off
- 'on)))))
- (if (eq action 'off)
- (progn
- (org-remove-from-invisibility-spec '(org-table))
- (org-table-map-tables 'org-table-align)
- (message "Vertical table lines visible")
- (if (org-at-table-p)
- (org-table-align)))
- (org-add-to-invisibility-spec '(org-table))
- (org-table-map-tables 'org-table-align)
- (message "Vertical table lines invisible"))
- (redraw-frame (selected-frame))))
-
(defun org-table-map-tables (function)
"Apply FUNCTION to the start of all tables in the buffer."
(save-excursion
(beginning-of-line 1)
(if (looking-at org-table-line-regexp)
(save-excursion (funcall function)))
- (re-search-forward org-table-any-border-regexp nil 1)))))
+ (re-search-forward org-table-any-border-regexp nil 1))))
+ (message "Mapping tables: done"))
(defun org-table-sum (&optional beg end nlast)
"Sum numbers in region of current table column.
(format "%d:%02d:%02d" h m s))))
(kill-new sres)
(if (interactive-p)
- (message "s"
+ (message "%s"
(substitute-command-keys
(format "Sum of %d items: %-20s (\\[yank] will insert result into buffer)"
(length numbers) sres))))
(t n))))
(defun org-table-get-vertical-vector (desc &optional tbeg col)
- "Get a calc vector from a column, accorting to desctiptor DESC.
+ "Get a calc vector from a column, accorting to descriptor DESC.
Optional arguments TBEG and COL can give the beginning of the table and
the current column, to avoid unnecessary parsing."
(save-excursion
(defun org-table-modify-formulas (action &rest columns)
"Modify the formulas stored below the current table.
ACTION can be `remove', `insert', `swap'. For `swap', two column numbers are
-expected, for the other action only a single column number is needed."
+expected, for the other actions only a single column number is needed."
(let ((list (org-table-get-stored-formulas))
(nmax (length (org-split-string
(buffer-substring (point-at-bol) (point-at-eol))
((eq action 'swap)
(setq col1 (car columns) col2 (nth 1 columns)
sc1 (int-to-string col1) sc2 (int-to-string col2))
- ;; Hopefully, ZqZ will never be a name in a table... FIXME:
- (org-table-replace-in-formulas list sc1 "ZqZ")
+ ;; Hopefully, ZqZtZ will never be a name in a table
+ (org-table-replace-in-formulas list sc1 "ZqZtZ")
(org-table-replace-in-formulas list sc2 sc1)
- (org-table-replace-in-formulas list "ZqZ" sc2)
- (if (assoc sc1 list) (setcar (assoc sc1 list) "ZqZ"))
+ (org-table-replace-in-formulas list "ZqZtZ" sc2)
+ (if (assoc sc1 list) (setcar (assoc sc1 list) "ZqZtZ"))
(if (assoc sc2 list) (setcar (assoc sc2 list) sc1))
- (if (assoc "ZqZ" list) (setcar (assoc "ZqZ" list) sc2)))
+ (if (assoc "ZqZtZ" list) (setcar (assoc "ZqZtZ" list) sc2)))
(t (error "Invalid action in `org-table-modify-formulas'")))
(if list (org-table-store-formulas list))))
(setcdr elt s))))
(defun org-table-get-specials ()
- "Get the column nmaes and local parameters for this table."
+ "Get the column names and local parameters for this table."
(save-excursion
(let ((beg (org-table-begin)) (end (org-table-end))
names name fields fields1 field cnt c v line col)
(org-table-eval-formula (if named '(4) nil) eq))))))
(defvar org-recalc-commands nil
- "List of commands triggering the reccalculation of a line.
+ "List of commands triggering the recalculation of a line.
Will be filled automatically during use.")
(defvar org-recalc-marks
(defun org-table-rotate-recalc-marks (&optional newchar)
"Rotate the recalculation mark in the first column.
If in any row, the first field is not consistent with a mark,
-insert a new column for the makers.
+insert a new column for the markers.
When there is an active region, change all the lines in the region,
after prompting for the marking character.
-After each change, a message will be displayed indication the meaning
+After each change, a message will be displayed indicating the meaning
of the new mark."
(interactive)
(unless (org-at-table-p) (error "Not at a table"))
suppress-store)
"Replace the table field value at the cursor by the result of a calculation.
-This function makes use of Dave Gillespie's calc package, in my view the
-most exciting program ever written for GNU Emacs. So you need to have calc
+This function makes use of Dave Gillespie's Calc package, in my view the
+most exciting program ever written for GNU Emacs. So you need to have Calc
installed in order to use this function.
In a table, this command replaces the value in the current field with the
-result of a formula. It also installes the formula as the \"current\" column
+result of a formula. It also installs the formula as the \"current\" column
formula, by storing it in a special line below the table. When called
with a `C-u' prefix, the current field must ba a named field, and the
formula is installed as valid in only this specific field.
These stored formulas are adapted correctly when moving, inserting, or
deleting columns with the corresponding commands.
-The formula can be any algebraic expression understood by the calc package.
+The formula can be any algebraic expression understood by the Calc package.
For details, see the Org-mode manual.
This function can also be called from Lisp programs and offers
-additional Arguments: EQUATION can be the formula to apply. If this
+additional arguments: EQUATION can be the formula to apply. If this
argument is given, the user will not be prompted. SUPPRESS-ALIGN is
used to speed-up recursive calls by by-passing unnecessary aligns.
SUPPRESS-CONST suppresses the interpretation of constants in the
-formula, assuming that this has been done already outside the fuction.
+formula, assuming that this has been done already outside the function.
SUPPRESS-STORE means the formula should not be stored, either because
it is already stored, or because it is a modified equation that should
not overwrite the stored one."
(if (= c ?p) (setq modes (org-set-calc-mode 'calc-internal-prec n))
(setq modes (org-set-calc-mode
'calc-float-format
- (list (cdr (assoc c '((?n. float) (?f. fix)
- (?s. sci) (?e. eng))))
+ (list (cdr (assoc c '((?n . float) (?f . fix)
+ (?s . sci) (?e . eng))))
n))))
(setq fmt (replace-match "" t t fmt)))
(while (string-match "[DRFS]" fmt)
(define-key org-edit-formulas-map "\C-c?" 'org-show-variable)
(defvar org-pos)
-(defvar org-window-configuration)
(defun org-table-edit-formulas ()
"Edit the formulas of the current table in a separate buffer."
;; active, this binding is ignored inside tables and replaced with a
;; modified self-insert.
-(defcustom orgtbl-optimized (eq org-enable-table-editor 'optimized)
- "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
-In the optimized version, the table editor takes over all simple keys that
-normally just insert a character. In tables, the characters are inserted
-in a way to minimize disturbing the table structure (i.e. in overwrite mode
-for empty fields). Outside tables, the correct binding of the keys is
-restored.
-
-The default for this option is t if the optimized version is also used in
-Org-mode. See the variable `org-enable-table-editor' for details. Changing
-this variable requires a restart of Emacs to become effective."
- :group 'org-table
- :type 'boolean)
-
(defvar orgtbl-mode nil
"Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
table editor in arbitrary modes.")
(make-variable-buffer-local 'orgtbl-mode)
-(defvar orgtbl-mode-map (make-sparse-keymap)
+(defvar orgtbl-mode-map (make-keymap)
"Keymap for `orgtbl-mode'.")
;;;###autoload
(and c (setq minor-mode-map-alist
(cons c (delq c minor-mode-map-alist)))))
(set (make-local-variable (quote org-table-may-need-update)) t)
- (make-local-hook (quote before-change-functions)) ; needed for XEmacs
- (add-hook 'before-change-functions 'org-before-change-function
- nil 'local)
+ (org-add-hook 'before-change-functions 'org-before-change-function
+ nil 'local)
(set (make-local-variable 'org-old-auto-fill-inhibit-regexp)
auto-fill-inhibit-regexp)
(set (make-local-variable 'auto-fill-inhibit-regexp)
(if auto-fill-inhibit-regexp
(concat "\\([ \t]*|\\|" auto-fill-inhibit-regexp)
"[ \t]*|"))
+ (org-add-to-invisibility-spec '(org-cwidth))
(easy-menu-add orgtbl-mode-menu)
(run-hooks 'orgtbl-mode-hook))
(setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
+ (org-cleanup-narrow-column-properties)
+ (org-remove-from-invisibility-spec '(org-cwidth))
(remove-hook 'before-change-functions 'org-before-change-function t)
(easy-menu-remove orgtbl-mode-menu)
(force-mode-line-update 'all))))
+(defun org-cleanup-narrow-column-properties ()
+ "Remove all properties related to narrow-column invisibility."
+ (let ((s 1))
+ (while (setq s (text-property-any s (point-max)
+ 'display org-narrow-column-arrow))
+ (remove-text-properties s (1+ s) '(display t)))
+ (setq s 1)
+ (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
+ (remove-text-properties s (1+ s) '(org-cwidth t)))
+ (setq s 1)
+ (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
+ (remove-text-properties s (1+ s) '(invisible t)))))
+
;; Install it as a minor mode.
(put 'orgtbl-mode :included t)
(put 'orgtbl-mode :menu-tag "Org Table Mode")
(defun orgtbl-make-binding (fun n &rest keys)
"Create a function for binding in the table minor mode.
-FUN is the command to call inside a table. N is used to create a unique
-command name. KEYS are keys that should be checked in for a command
+FUN is the command to call inside a table. N is used to create a unique
+command name. KEYS are keys that should be checked in for a command
to execute outside of tables."
(eval
(list 'defun
'("\C-c?" org-table-current-column)
'("\C-c " org-table-blank-field)
'("\C-c+" org-table-sum)
- '("\C-c|" org-table-toggle-vline-visibility)
'("\C-c=" org-table-eval-formula)
'("\C-c'" org-table-edit-formulas)
+ '("\C-c`" org-table-edit-field)
'("\C-c*" org-table-recalculate)
+ '("\C-c|" org-table-create-or-convert-from-region)
+ '("\C-c^" org-table-sort-lines)
'([(control ?#)] org-table-rotate-recalc-marks)))
elt key fun cmd)
(while (setq elt (pop bindings))
;; some standard editing functions
(org-remap orgtbl-mode-map
'self-insert-command 'orgtbl-self-insert-command
- 'delete-char 'orgtbl-delete-char
- 'delete-backward-char 'orgtbl-delete-backward-char)
+ 'delete-char 'org-delete-char
+ 'delete-backward-char 'org-delete-backward-char)
(define-key orgtbl-mode-map "|" 'org-force-self-insert))
(easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
'("OrgTbl"
["Next Row" org-return :active (org-at-table-p) :keys "RET"]
"--"
["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
+ ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
["Copy Field from Above"
org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
"--"
["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
- ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
+ ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"]
+ "--"
+ ["Enable Narrowing" (setq org-table-limit-column-width (not org-table-limit-column-width)) :active (org-at-table-p) :selected org-table-limit-column-width :style toggle])
("Row"
["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
+ ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
"--"
["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
("Rectangle"
- ["Copy Rectangle" org-copy-special :active (org-at-table-p) :keys "C-c C-x M-w"]
- ["Cut Rectangle" org-cut-special :active (org-at-table-p) :keys "C-c C-x C-w"]
- ["Paste Rectangle" org-paste-special :active (org-at-table-p) :keys "C-c C-x C-y"]
- ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p) :keys "C-c C-q"])
+ ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
+ ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
+ ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
+ ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
"--"
["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
["Set Named Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
))
t)
-(defun orgtbl-tab ()
+(defun orgtbl-tab (arg)
"Justification and field motion for `orgtbl-mode'."
- (interactive)
- (org-table-justify-field-maybe)
- (org-table-next-field))
+ (interactive "P")
+ (if arg (org-table-edit-field t)
+ (org-table-justify-field-maybe)
+ (org-table-next-field)))
(defun orgtbl-ret ()
"Justification and field motion for `orgtbl-mode'."
(interactive "p")
(self-insert-command N))
-(defun orgtbl-delete-backward-char (N)
- "Like `delete-backward-char', insert whitespace at field end in tables.
-When deleting backwards, in tables this function will insert whitespace in
-front of the next \"|\" separator, to keep the table aligned. The table will
-still be marked for re-alignment, because a narrow field may lead to a
-reduced column width."
- (interactive "p")
- (if (and (org-at-table-p)
- (eq N 1)
- (string-match "|" (buffer-substring (point-at-bol) (point)))
- (looking-at ".*?|"))
- (let ((pos (point)))
- (backward-delete-char N)
- (skip-chars-forward "^|")
- (insert " ")
- (goto-char (1- pos)))
- (delete-backward-char N)))
-
-(defun orgtbl-delete-char (N)
- "Like `delete-char', but insert whitespace at field end in tables.
-When deleting characters, in tables this function will insert whitespace in
-front of the next \"|\" separator, to keep the table aligned. The table
-will still be marked for re-alignment, because a narrow field may lead to
-a reduced column width."
- (interactive "p")
- (if (and (org-at-table-p)
- (not (bolp))
- (not (= (char-after) ?|))
- (eq N 1))
- (if (looking-at ".*?|")
- (let ((pos (point)))
- (replace-match (concat
- (substring (match-string 0) 1 -1)
- " |"))
- (goto-char pos)))
- (delete-char N)))
-
;;; Exporting
(defconst org-level-max 20)
((string-match "^#" line)
;; an ordinary comment line
)
+ ((and org-export-table-remove-special-lines
+ (string-match "^[ \t]*| *[!_^] *|" line))
+ ;; a special table line that should be removed
+ )
(t (setq rtn (cons line rtn)))))
(nreverse rtn)))
It is supplemented by a number of commonly used TeX macros with appropriate
translations. There is currently no way for users to extend this.")
+(defun org-cleaned-string-for-export (string)
+ "Cleanup a buffer substring so that links can be created safely."
+ (interactive)
+ (let* ((cb (current-buffer))
+ (re-radio (and org-target-link-regexp
+ (concat "\\([^<]\\)\\(" org-target-link-regexp "\\)")))
+ (re-plain-link (concat "\\([^[<]\\)" org-plain-link-re))
+ (re-angle-link (concat "\\([^[]\\)" org-angle-link-re))
+ rtn)
+ (save-excursion
+ (set-buffer (get-buffer-create " org-mode-tmp"))
+ (erase-buffer)
+ (insert string)
+ (org-mode)
+ ;; Find targets in comments and move them out of comments,
+ ;; but mark them as targets that should be invisible
+ (goto-char (point-min))
+ (while (re-search-forward "^#.*?\\(<<<?[^>\r\n]+>>>?\\).*" nil t)
+ (replace-match "\\1(INVISIBLE)"))
+ ;; Find matches for radio targets and turn them into internal links
+ (goto-char (point-min))
+ (when re-radio
+ (while (re-search-forward re-radio nil t)
+ (replace-match "\\1[[\\2]]")))
+ ;; Find all links that contain a newline and put them into a single line
+ (goto-char (point-min))
+ (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
+ (replace-match "\\1 \\3")
+ (goto-char (match-beginning 0)))
+ ;; Normalize links: Convert angle and plain links into bracket links
+ (goto-char (point-min))
+ (while (re-search-forward re-plain-link nil t)
+ (replace-match
+ (concat
+ (match-string 1) "[[" (match-string 2) ":" (match-string 3) "]]")
+ t t))
+ (goto-char (point-min))
+ (while (re-search-forward re-angle-link nil t)
+ (replace-match
+ (concat
+ (match-string 1) "[[" (match-string 2) ":" (match-string 3) "]]")
+ t t))
+
+ ;; Remove comments
+ (goto-char (point-min))
+ (while (re-search-forward "^#.*\n?" nil t)
+ (replace-match ""))
+ (setq rtn (buffer-string)))
+ (kill-buffer " org-mode-tmp")
+ rtn))
+
+(defun org-solidify-link-text (s &optional alist)
+ "Take link text and make a safe target out of it."
+ (save-match-data
+ (let* ((rtn
+ (mapconcat
+ 'identity
+ (org-split-string s "[ \t\r\n]+") "--"))
+ (a (assoc rtn alist)))
+ (or (cdr a) rtn))))
+
+(defun org-convert-to-odd-levels ()
+ "Convert an org-mode file with all levels allowed to one with odd levels.
+This will leave level 1 alone, convert level 2 to level 3, level 3 to
+level 5 etc."
+ (interactive)
+ (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
+ (let ((org-odd-levels-only nil) n)
+ (save-excursion
+ (goto-char (point-min))
+ (while (re-search-forward "^\\*\\*+" nil t)
+ (setq n (1- (length (match-string 0))))
+ (while (>= (setq n (1- n)) 0)
+ (org-demote))
+ (end-of-line 1))))))
+
+
+(defun org-convert-to-oddeven-levels ()
+ "Convert an org-mode file with only odd levels to one with odd and even levels.
+This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
+section with an even level, conversion would destroy the structure of the file. An error
+is signaled in this case."
+ (interactive)
+ (goto-char (point-min))
+ ;; First check if there are no even levels
+ (when (re-search-forward "^\\(\\*\\*\\)+[^*]" nil t)
+ (org-show-hierarchy-above)
+ (error "Not all levels are odd in this file. Conversion not possible."))
+ (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
+ (let ((org-odd-levels-only nil) n)
+ (save-excursion
+ (goto-char (point-min))
+ (while (re-search-forward "^\\*\\*+" nil t)
+ (setq n (/ (length (match-string 0)) 2))
+ (while (>= (setq n (1- n)) 0)
+ (org-promote))
+ (end-of-line 1))))))
+
+(defun org-tr-level (n)
+ "Make N odd if required."
+ (if org-odd-levels-only (1+ (/ n 2)) n))
+
(defvar org-last-level nil) ; dynamically scoped variable
(defun org-export-as-ascii (arg)
(if (org-region-active-p) (region-beginning) (point-min))
(if (org-region-active-p) (region-end) (point-max))))
(lines (org-export-find-first-heading-line
- (org-skip-comments (org-split-string region "[\r\n]"))))
+ (org-skip-comments
+ (org-split-string
+ (org-cleaned-string-for-export region)
+ "[\r\n]"))))
(org-startup-with-deadline-check nil)
(level 0) line txt
(umax nil)
(case-fold-search nil)
- (filename (concat (file-name-sans-extension (buffer-file-name))
+ (filename (concat (file-name-sans-extension buffer-file-name)
".txt"))
(buffer (find-file-noselect filename))
(levels-open (make-vector org-level-max nil))
(date (format-time-string "%Y/%m/%d" (current-time)))
- (time (format-time-string "%X" (current-time)))
+ (time (format-time-string "%X" (org-current-time)))
(author user-full-name)
(title (buffer-name))
(options nil)
;; This is a headline
(progn
(setq level (- (match-end 1) (match-beginning 1))
+ level (org-tr-level level)
txt (match-string 3 line)
todo
(or (and (match-beginning 2)
(not (equal (match-string 2 line)
org-done-string)))
; TODO, not DONE
- (and (= level umax)
+ (and org-export-mark-todo-in-toc
+ (= level umax)
(org-search-todo-below
line lines level))))
(setq txt (org-html-expand-for-ascii txt))
(while (setq line (pop lines))
;; Remove the quoted HTML tags.
(setq line (org-html-expand-for-ascii line))
+ ;; Remove targets
+ (while (string-match "<<<?[^<>]*>>>?[ \t]*\n?" line)
+ (setq line (replace-match "" t t line)))
+ ;; Replace internal links
+ (while (string-match org-bracket-link-regexp line)
+ (setq line (replace-match
+ (if (match-end 3) "[\\3]" "[\\1]")
+ t nil line)))
(cond
((string-match "^\\(\\*+\\)[ \t]*\\(.*\\)" line)
;; a Headline
- (setq level (- (match-end 1) (match-beginning 1))
+ (setq level (org-tr-level (- (match-end 1) (match-beginning 1)))
txt (match-string 2 line))
(org-ascii-level-start level txt umax))
(t (insert line "\n"))))
(if todo (throw 'exit t))))))))
;; FIXME: Try to handle <b> and <i> as faces via text properties.
-;; FIXME: Can I implement *bold*,/italic/ and _underline_ for ASCII export?
+;; We could also implement *bold*,/italic/ and _underline_ for ASCII export
(defun org-html-expand-for-ascii (line)
"Handle quoted HTML for ASCII export."
(if org-export-html-expand
(defun org-insert-centered (s &optional underline)
"Insert the string S centered and underline it with character UNDERLINE."
- (let ((ind (max (/ (- 80 (length s)) 2) 0)))
+ (let ((ind (max (/ (- 80 (string-width s)) 2) 0)))
(insert (make-string ind ?\ ) s "\n")
(if underline
(insert (make-string ind ?\ )
- (make-string (length s) underline)
+ (make-string (string-width s) underline)
"\n"))))
(defun org-ascii-level-start (level title umax)
Also removes the first line of the buffer if it specifies a mode,
and all options lines."
(interactive)
- (let* ((filename (concat (file-name-sans-extension (buffer-file-name))
+ (let* ((filename (concat (file-name-sans-extension buffer-file-name)
".txt"))
(buffer (find-file-noselect filename))
(ore (concat
#+CATEGORY: %s
#+SEQ_TODO: %s
#+TYP_TODO: %s
-#+STARTUP: %s %s
+#+STARTUP: %s %s %s %s %s
#+ARCHIVE: %s
"
(buffer-name) (user-full-name) user-mail-address org-export-default-language
org-export-with-sub-superscripts
org-export-with-emphasize
org-export-with-TeX-macros
- (file-name-nondirectory (buffer-file-name))
+ (file-name-nondirectory buffer-file-name)
(if (equal org-todo-interpretation 'sequence)
(mapconcat 'identity org-todo-keywords " ")
"TODO FEEDBACK VERIFY DONE")
(cdr (assoc org-startup-folded
'((nil . "nofold")(t . "fold")(content . "content"))))
(if org-startup-with-deadline-check "dlcheck" "nodlcheck")
+ (if org-odd-levels-only "odd" "oddeven")
+ (if org-hide-leading-stars "hidestars" "showstars")
+ (if org-startup-align-all-tables "align" "noalign")
org-archive-location
))
headlines. The default is 3. Lower levels will become bulleted lists."
(interactive "P")
(org-export-as-html arg 'hidden)
- (org-open-file (buffer-file-name)))
+ (org-open-file buffer-file-name))
(defun org-export-as-html-batch ()
"Call `org-export-as-html', may be used in batch processing as
(setq-default org-todo-line-regexp org-todo-line-regexp)
(setq-default org-deadline-line-regexp org-deadline-line-regexp)
(setq-default org-done-string org-done-string)
- (let* ((region-p (org-region-active-p))
+ (let* ((style org-export-html-style)
+ (odd org-odd-levels-only)
+ (region-p (org-region-active-p))
(region
(buffer-substring
(if region-p (region-beginning) (point-min))
(if region-p (region-end) (point-max))))
(all_lines
- (org-skip-comments (org-split-string region "[\r\n]")))
+ (org-skip-comments (org-split-string
+ (org-cleaned-string-for-export region)
+ "[\r\n]")))
(lines (org-export-find-first-heading-line all_lines))
(level 0) (line "") (origline "") txt todo
(umax nil)
- (filename (concat (file-name-sans-extension (buffer-file-name))
+ (filename (concat (file-name-sans-extension buffer-file-name)
".html"))
(buffer (find-file-noselect filename))
(levels-open (make-vector org-level-max nil))
(date (format-time-string "%Y/%m/%d" (current-time)))
- (time (format-time-string "%X" (current-time)))
+ (time (format-time-string "%X" (org-current-time)))
(author user-full-name)
(title (buffer-name))
(options nil)
(quote-re (concat "^\\*+[ \t]*" org-quote-string "\\>"))
(inquote nil)
+ (infixed nil)
+ (in-local-list nil)
+ (local-list-num nil)
+ (local-list-indent nil)
+ (llt org-plain-list-ordered-item-terminator)
(email user-mail-address)
(language org-export-default-language)
(text nil)
(lang-words nil)
+ (target-alist nil) tg
(head-count 0) cnt
(start 0)
+ ;; FIXME: The following returns always nil under XEmacs
+ (coding-system (and (fboundp 'coding-system-get)
+ (boundp 'buffer-file-coding-system)
+ buffer-file-coding-system))
+ (coding-system-for-write (or coding-system coding-system-for-write))
+ (save-buffer-coding-system (or coding-system save-buffer-coding-system))
+ (charset (and coding-system
+ (coding-system-get coding-system 'mime-charset)))
table-open type
table-buffer table-orig-buffer
+ ind start-is-num starter
+ rpl path desc desc1 desc2 link
)
(message "Exporting...")
(switch-to-buffer-other-window buffer))
(erase-buffer)
(fundamental-mode)
- (let ((case-fold-search nil))
+ (let ((case-fold-search nil)
+ (org-odd-levels-only odd))
(if options (org-parse-export-options options))
(setq umax (if arg (prefix-numeric-value arg)
org-export-headline-levels))
;; File header
(insert (format
- "<html lang=\"%s\"><head>
+ "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\"
+ \"http://www.w3.org/TR/REC-html40/loose.dtd\">
+<html lang=\"%s\"><head>
<title>%s</title>
-<meta http-equiv=\"Content-Type\" content=\"text/html\">
+<meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\">
<meta name=generator content=\"Org-mode\">
<meta name=generated content=\"%s %s\">
<meta name=author content=\"%s\">
+%s
</head><body>
"
- language (org-html-expand title) date time author))
- (if title (insert (concat "<H1 align=\"center\">"
+ language (org-html-expand title) (or charset "iso-8859-1")
+ date time author style))
+ (if title (insert (concat "<H1 class=\"title\">"
(org-html-expand title) "</H1>\n")))
(if author (insert (concat (nth 1 lang-words) ": " author "\n")))
(if email (insert (concat "<a href=\"mailto:" email "\"><"
(progn
(insert (format "<H2>%s</H2>\n" (nth 3 lang-words)))
(insert "<ul>\n")
+ (setq lines
(mapcar '(lambda (line)
(if (string-match org-todo-line-regexp line)
;; This is a headline
(progn
(setq level (- (match-end 1) (match-beginning 1))
+ level (org-tr-level level)
txt (save-match-data
(org-html-expand
(match-string 3 line)))
(not (equal (match-string 2 line)
org-done-string)))
; TODO, not DONE
- (and (= level umax)
+ (and org-export-mark-todo-in-toc
+ (= level umax)
(org-search-todo-below
line lines level))))
(if org-export-with-section-numbers
(while (>= (setq cnt (1- cnt)) 0)
(insert "</ul>"))
(insert "\n")))
+ ;; Check for targets
+ (while (string-match org-target-regexp line)
+ (setq tg (match-string 1 line)
+ line (replace-match
+ (concat "@<span class=\"target\">" tg "@</span> ")
+ t t line))
+ (push (cons (org-solidify-link-text tg)
+ (format "sec-%d" head-count))
+ target-alist))
+ (while (string-match "<\\(<\\)+\\|>\\(>\\)+" txt)
+ (setq txt (replace-match "" t t txt)))
(insert
(format
(if todo
- "<li><a href=\"#sec-%d\"><span style='color:red'>%s</span></a></li>\n"
- "<li><a href=\"#sec-%d\">%s</a></li>\n")
+ "<li><a href=\"#sec-%d\"><span class=\"todo\">%s</span></a>\n"
+ "<li><a href=\"#sec-%d\">%s</a>\n")
head-count txt))
+
(setq org-last-level level))
- ))))
- lines)
+ )))
+ line)
+ lines))
(while (> org-last-level 0)
(setq org-last-level (1- org-last-level))
(insert "</ul>\n"))
(org-init-section-numbers)
(while (setq line (pop lines) origline line)
- ;; end of quote?
- (when (and inquote (string-match "^\\*+" line))
- (insert "</pre>\n")
- (setq inquote nil))
- ;; inquote
- (if inquote
- (progn
- (insert line "\n")
- (setq line (org-html-expand line))) ;;????? FIXME: not needed?
+ (catch 'nextline
- ;; Protect the links
- (setq start 0)
- (while (string-match org-link-maybe-angles-regexp line start)
- (setq start (match-end 0))
- (setq line (replace-match
- (concat "\000" (match-string 1 line) "\000")
- t t line)))
+ ;; end of quote section?
+ (when (and inquote (string-match "^\\*+" line))
+ (insert "</pre>\n")
+ (setq inquote nil))
+ ;; inside a quote section?
+ (when inquote
+ (insert (org-html-protect line) "\n")
+ (throw 'nextline nil))
+
+ ;; verbatim lines
+ (when (and org-export-with-fixed-width
+ (string-match "^[ \t]*:\\(.*\\)" line))
+ (when (not infixed)
+ (setq infixed t)
+ (insert "<pre>\n"))
+ (insert (org-html-protect (match-string 1 line)) "\n")
+ (when (and lines
+ (not (string-match "^[ \t]*\\(:.*\\)"
+ (car lines))))
+ (setq infixed nil)
+ (insert "</pre>\n"))
+ (throw 'nextline nil))
+
+
+ ;; make targets to anchors
+ (while (string-match "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line)
+ (cond
+ ((match-end 2)
+ (setq line (replace-match
+ (concat "@<a name=\""
+ (org-solidify-link-text (match-string 1 line))
+ "\">\\nbsp@</a>")
+ t t line)))
+ ((and org-export-with-toc (equal (string-to-char line) ?*))
+ (setq line (replace-match
+ (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
+; (concat "@<i>" (match-string 1 line) "@</i> ")
+ t t line)))
+ (t
+ (setq line (replace-match
+ (concat "@<a name=\""
+ (org-solidify-link-text (match-string 1 line))
+ "\" class=\"target\">" (match-string 1 line) "@</a> ")
+ t t line)))))
- ;; replace "<" and ">" by "<" and ">"
+ ;; replace "&" by "&", "<" and ">" by "<" and ">"
;; handle @<..> HTML tags (replace "@>..<" by "<..>")
(setq line (org-html-expand line))
- ;; Verbatim lines
- (if (and org-export-with-fixed-width
- (string-match "^[ \t]*:\\(.*\\)" line))
- (progn
- (let ((l (match-string 1 line)))
- (while (string-match " " l)
- (setq l (replace-match " " t t l)))
- (insert "\n<span style='font-family:Courier'>"
- l "</span>"
- (if (and lines
- (not (string-match "^[ \t]+\\(:.*\\)"
- (car lines))))
- "<br>\n" "\n"))))
-
- (setq start 0)
- (while (string-match org-protected-link-regexp line start)
- (setq start (- (match-end 0) 2))
- (setq type (match-string 1 line))
- (cond
- ((member type '("http" "https" "ftp" "mailto" "news"))
- ;; standard URL
- (setq line (replace-match
- ; "<a href=\"\\1:\\2\"><\\1:\\2></a>"
- "<a href=\"\\1:\\2\">\\1:\\2</a>"
- nil nil line)))
- ((string= type "file")
- ;; FILE link
- (let* ((filename (match-string 2 line))
- (abs-p (file-name-absolute-p filename))
- (thefile (if abs-p (expand-file-name filename) filename))
- (thefile (save-match-data
- (if (string-match ":[0-9]+$" thefile)
- (replace-match "" t t thefile)
- thefile)))
- (file-is-image-p
- (save-match-data
- (string-match (org-image-file-name-regexp) thefile))))
+ ;; Format the links
+ (setq start 0)
+ (while (string-match org-bracket-link-analytic-regexp line start)
+ (setq start (match-beginning 0))
+ (setq type (if (match-end 2) (match-string 2 line) "internal"))
+ (setq path (match-string 3 line))
+ (setq desc1 (if (match-end 5) (match-string 5 line))
+ desc2 (if (match-end 2) (concat type ":" path) path)
+ desc (or desc1 desc2))
+ (cond
+ ((equal type "internal")
+ (setq rpl
+ (concat
+ "<a href=\"#"
+ (org-solidify-link-text path target-alist)
+ "\">" desc "</a>")))
+ ((member type '("http" "https" "ftp" "mailto" "news"))
+ ;; standard URL
+ (setq link (concat type ":" path))
+ (setq rpl (concat "<a href=\"" link "\">" desc "</a>")))
+ ((string= type "file")
+ ;; FILE link
+ (let* ((filename path)
+ (abs-p (file-name-absolute-p filename))
+ (thefile (if abs-p (expand-file-name filename) filename))
+ (thefile (save-match-data
+ (if (string-match ":[0-9]+$" thefile)
+ (replace-match "" t t thefile)
+ thefile)))
+ (file-is-image-p
+ (save-match-data
+ (string-match (org-image-file-name-regexp) thefile))))
+ (setq rpl (if (and org-export-html-inline-images
+ file-is-image-p)
+ (concat "<img src=\"" thefile "\"/>")
+ (concat "<a href=\"" thefile "\">" desc "</a>")))))
+ ((member type '("bbdb" "vm" "wl" "mhe" "rmail" "gnus" "shell"))
+ (setq rpl (concat "<i><" type ":" path "></i>"))))
+ ;; FIXME: We get to see the escaped links!!!!!
+ (setq line (replace-match rpl t t line)
+ start (+ start (length rpl))))
+ ;; TODO items
+ (if (and (string-match org-todo-line-regexp line)
+ (match-beginning 2))
+ (if (equal (match-string 2 line) org-done-string)
(setq line (replace-match
- (if (and org-export-html-inline-images
- file-is-image-p)
- (concat "<img src=\"" thefile "\"/>")
- (concat "<a href=\"" thefile "\">\\1:\\2</a>"))
- nil nil line))))
-
- ((member type '("bbdb" "vm" "wl" "rmail" "gnus" "shell"))
- (setq line (replace-match
- "<i><\\1:\\2></i>" nil nil line)))))
-
- ;; TODO items
- (if (and (string-match org-todo-line-regexp line)
- (match-beginning 2))
- (if (equal (match-string 2 line) org-done-string)
- (setq line (replace-match
- "<span style='color:green'>\\2</span>"
- nil nil line 2))
- (setq line (replace-match "<span style='color:red'>\\2</span>"
- nil nil line 2))))
-
- ;; DEADLINES
- (if (string-match org-deadline-line-regexp line)
- (progn
- (if (save-match-data
- (string-match "<a href"
- (substring line 0 (match-beginning 0))))
- nil ; Don't do the replacement - it is inside a link
- (setq line (replace-match "<span style='color:red'>\\&</span>"
- nil nil line 1)))))
-
+ "<span class=\"done\">\\2</span>"
+ nil nil line 2))
+ (setq line (replace-match "<span class=\"todo\">\\2</span>"
+ nil nil line 2))))
- (cond
- ((string-match "^\\(\\*+\\)[ \t]*\\(.*\\)" line)
- ;; This is a headline
- (setq level (- (match-end 1) (match-beginning 1))
- txt (match-string 2 line))
- (if (<= level umax) (setq head-count (+ head-count 1)))
- (org-html-level-start level txt umax
- (and org-export-with-toc (<= level umax))
- head-count)
- ;; QUOTES
- (when (string-match quote-re line)
- (insert "<pre>")
- (setq inquote t)))
-
- ((and org-export-with-tables
- (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
- (if (not table-open)
- ;; New table starts
- (setq table-open t table-buffer nil table-orig-buffer nil))
- ;; Accumulate lines
- (setq table-buffer (cons line table-buffer)
- table-orig-buffer (cons origline table-orig-buffer))
- (when (or (not lines)
- (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
- (car lines))))
- (setq table-open nil
- table-buffer (nreverse table-buffer)
- table-orig-buffer (nreverse table-orig-buffer))
- (insert (org-format-table-html table-buffer table-orig-buffer))))
- (t
- ;; Normal lines
- ;; Lines starting with "-", and empty lines make new paragraph.
- ;; FIXME: Should we add + and *?
- (if (string-match "^ *-\\|^[ \t]*$" line) (insert "<p>"))
- (insert line (if org-export-preserve-breaks "<br>\n" "\n"))))
- )))
- (if org-export-html-with-timestamp
- (insert org-export-html-html-helper-timestamp))
- (insert "</body>\n</html>\n")
- (normal-mode)
- (save-buffer)
- (goto-char (point-min)))))
+ ;; DEADLINES
+ (if (string-match org-deadline-line-regexp line)
+ (progn
+ (if (save-match-data
+ (string-match "<a href"
+ (substring line 0 (match-beginning 0))))
+ nil ; Don't do the replacement - it is inside a link
+ (setq line (replace-match "<span class=\"deadline\">\\&</span>"
+ nil nil line 1)))))
+ (cond
+ ((string-match "^\\(\\*+\\)[ \t]*\\(.*\\)" line)
+ ;; This is a headline
+ (setq level (org-tr-level (- (match-end 1) (match-beginning 1)))
+ txt (match-string 2 line))
+ (if (<= level umax) (setq head-count (+ head-count 1)))
+ (when in-local-list
+ ;; Close any local lists before inserting a new header line
+ (while local-list-num
+ (insert (if (car local-list-num) "</ol>\n" "</ul>"))
+ (pop local-list-num))
+ (setq local-list-indent nil
+ in-local-list nil))
+ (org-html-level-start level txt umax
+ (and org-export-with-toc (<= level umax))
+ head-count)
+ ;; QUOTES
+ (when (string-match quote-re line)
+ (insert "<pre>")
+ (setq inquote t)))
+
+ ((and org-export-with-tables
+ (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
+ (if (not table-open)
+ ;; New table starts
+ (setq table-open t table-buffer nil table-orig-buffer nil))
+ ;; Accumulate lines
+ (setq table-buffer (cons line table-buffer)
+ table-orig-buffer (cons origline table-orig-buffer))
+ (when (or (not lines)
+ (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
+ (car lines))))
+ (setq table-open nil
+ table-buffer (nreverse table-buffer)
+ table-orig-buffer (nreverse table-orig-buffer))
+ (insert (org-format-table-html table-buffer table-orig-buffer))))
+ (t
+ ;; Normal lines
+ (when (and (string-match
+ (cond
+ ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*]\\)\\|\\([0-9]+[.)]\\)\\)?\\( +[^ \t\n\r]\\|[ \t]*$\\)")
+ ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*]\\)\\|\\([0-9]+\\.\\)\\)?\\( +[^ \t\n\r]\\|[ \t]*$\\)")
+ ((= llt ?\)) "^\\( \t]*\\)\\(\\([-+*]\\)\\|\\([0-9]+)\\)\\)?\\( +[^ \t\n\r]\\|[ \t]*$\\)")
+ (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))
+ line))
+ (setq ind (org-get-string-indentation line)
+ start-is-num (match-beginning 4)
+ starter (if (match-beginning 2) (match-string 2 line))
+ line (substring line (match-beginning 5)))
+ (unless (string-match "[^ \t]" line)
+ ;; empty line. Pretend indentation is large.
+ (setq ind (1+ (or (car local-list-indent) 1))))
+ (while (and in-local-list
+ (or (and (= ind (car local-list-indent))
+ (not starter))
+ (< ind (car local-list-indent))))
+ (insert (if (car local-list-num) "</ol>\n" "</ul>"))
+ (pop local-list-num) (pop local-list-indent)
+ (setq in-local-list local-list-indent))
+ (cond
+ ((and starter
+ (or (not in-local-list)
+ (> ind (car local-list-indent))))
+ ;; Start new (level of ) list
+ (insert (if start-is-num "<ol>\n<li>\n" "<ul>\n<li>\n"))
+ (push start-is-num local-list-num)
+ (push ind local-list-indent)
+ (setq in-local-list t))
+ (starter
+ ;; continue current list
+ (insert "<li>\n"))))
+ ;; Empty lines start a new paragraph. If hand-formatted lists
+ ;; are not fully interpreted, lines starting with "-", "+", "*"
+ ;; also start a new paragraph.
+ (if (string-match "^ [-+*]-\\|^[ \t]*$" line) (insert "<p>"))
+ (insert line (if org-export-preserve-breaks "<br>\n" "\n"))))
+ ))
+ (if org-export-html-with-timestamp
+ (insert org-export-html-html-helper-timestamp))
+ (insert "</body>\n</html>\n")
+ (normal-mode)
+ (save-buffer)
+ (goto-char (point-min)))))
(defun org-format-table-html (lines olines)
"Find out which HTML converter to use and return the HTML code."
(org-format-table-table-html-using-table-generate-source olines)))))
(defun org-format-org-table-html (lines)
- "Format a table into html."
+ "Format a table into HTML."
(if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
(setq lines (nreverse lines))
(if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
(setq lines (nreverse lines))
+ (when org-export-table-remove-special-lines
+ ;; Check if the table has a marking column. If yes remove the
+ ;; column and the special lines
+ (let* ((special
+ (not
+ (memq nil
+ (mapcar
+ (lambda (x)
+ (or (string-match "^[ \t]*|-" x)
+ (string-match "^[ \t]*| *\\([#!$*_^ ]\\) *|" x)))
+ lines)))))
+ (if special
+ (setq lines
+ (delq nil
+ (mapcar
+ (lambda (x)
+ (if (string-match "^[ \t]*| *[!_^] *|" x)
+ nil ; ignore this line
+ (and (or (string-match "^[ \t]*|-+\\+" x)
+ (string-match "^[ \t]*|[^|]*|" x))
+ (replace-match "|" t t x))))
+ lines))))))
+
(let ((head (and org-export-highlight-first-table-line
(delq nil (mapcar
(lambda (x) (string-match "^[ \t]*|-" x))
(mapconcat (lambda (x)
(if head
(concat "<th>" x "</th>")
- (concat "<td valign=\"top\">" x "</td>")))
+ (concat "<td>" x "</td>")))
fields "")
"</tr>\n"))))
(setq html (concat html "</table>\n"))
newstr))
(defun org-format-table-table-html (lines)
- "Format a table generated by table.el into html.
+ "Format a table generated by table.el into HTML.
This conversion does *not* use `table-generate-source' from table.el.
This has the advantage that Org-mode's HTML conversions can be used.
But it has the disadvantage, that no cell- or row-spanning is allowed."
(lambda (x)
(if (equal x "") (setq x empty))
(if head
- (concat "<th valign=\"top\">" x
- "</th>\n")
- (concat "<td valign=\"top\">" x
- "</td>\n")))
+ (concat "<th>" x "</th>\n")
+ (concat "<td>" x "</td>\n")))
field-buffer "\n")
"</tr>\n"))
(setq head nil)
(set-buffer " org-tmp2 ")
(buffer-substring (point-min) (point-max))))
-(defun org-html-expand (string)
- "Prepare STRING for HTML export. Applies all active conversions."
- ;; First check if there is a link in the line - if yes, apply conversions
- ;; only before the start of the link.
- (let* ((m (string-match org-link-regexp string))
- (s (if m (substring string 0 m) string))
- (r (if m (substring string m) "")))
- ;; convert < to < and > to >
+(defun org-html-protect (s)
+ ;; convert & to &, < to < and > to >
+ (let ((start 0))
+ (while (string-match "&" s start)
+ (setq s (replace-match "&" t t s)
+ start (1+ (match-beginning 0))))
(while (string-match "<" s)
(setq s (replace-match "<" t t s)))
(while (string-match ">" s)
- (setq s (replace-match ">" t t s)))
- (if org-export-html-expand
- (while (string-match "@<\\([^&]*\\)>" s)
- (setq s (replace-match "<\\1>" nil nil s))))
- (if org-export-with-emphasize
- (setq s (org-export-html-convert-emphasize s)))
- (if org-export-with-sub-superscripts
- (setq s (org-export-html-convert-sub-super s)))
- (if org-export-with-TeX-macros
- (let ((start 0) wd ass)
- (while (setq start (string-match "\\\\\\([a-zA-Z]+\\)" s start))
- (setq wd (match-string 1 s))
- (if (setq ass (assoc wd org-html-entities))
- (setq s (replace-match (or (cdr ass)
- (concat "&" (car ass) ";"))
- t t s))
- (setq start (+ start (length wd)))))))
- (concat s r)))
+ (setq s (replace-match ">" t t s))))
+ s)
+
+(defun org-html-expand (string)
+ "Prepare STRING for HTML export. Applies all active conversions.
+If there are links in the string, don't modify these."
+ (let* (m s l res)
+ (while (setq m (string-match org-bracket-link-regexp string))
+ (setq s (substring string 0 m)
+ l (match-string 0 string)
+ string (substring string (match-end 0)))
+ (push (org-html-do-expand s) res)
+ (push l res))
+ (push (org-html-do-expand string) res)
+ (apply 'concat (nreverse res))))
+
+(defun org-html-do-expand (s)
+ "Apply all active conversions to translate special ASCII to HTML."
+ (setq s (org-html-protect s))
+ (if org-export-html-expand
+ (while (string-match "@<\\([^&]*\\)>" s)
+ (setq s (replace-match "<\\1>" nil nil s))))
+ (if org-export-with-emphasize
+ (setq s (org-export-html-convert-emphasize s)))
+ (if org-export-with-sub-superscripts
+ (setq s (org-export-html-convert-sub-super s)))
+ (if org-export-with-TeX-macros
+ (let ((start 0) wd ass)
+ (while (setq start (string-match "\\\\\\([a-zA-Z]+\\)" s start))
+ (setq wd (match-string 1 s))
+ (if (setq ass (assoc wd org-html-entities))
+ (setq s (replace-match (or (cdr ass)
+ (concat "&" (car ass) ";"))
+ t t s))
+ (setq start (+ start (length wd)))))))
+ s)
(defun org-create-multibrace-regexp (left right n)
"Create a regular expression which will match a balanced sexp.
string)
(defun org-export-html-convert-emphasize (string)
- (while (string-match
- "\\(\\s-\\|^\\)\\(\\*\\([a-zA-Z]+\\)\\*\\)\\([^a-zA-Z*]\\|$\\)"
- string)
- (setq string (replace-match
- (concat "<b>" (match-string 3 string) "</b>")
- t t string 2)))
- (while (string-match
- "\\(\\s-\\|^\\)\\(/\\([a-zA-Z]+\\)/\\)\\([^a-zA-Z*]\\|$\\)"
- string)
- (setq string (replace-match
- (concat "<i>" (match-string 3 string) "</i>")
- t t string 2)))
- (while (string-match
- "\\(\\s-\\|^\\)\\(_\\([a-zA-Z]+\\)_\\)\\([^a-zA-Z*]\\|$\\)"
- string)
- (setq string (replace-match
- (concat "<u>" (match-string 3 string) "</u>")
- t t string 2)))
- string)
+ (let (c (s 0))
+ (while (string-match "\\(\\W\\|^\\)\\([*/_]\\)\\(\\w+\\)\\2\\(\\W\\|$\\)" string s)
+ (setq c (cdr (assoc (match-string 2 string)
+ '(("*" . "b") ("/" . "i") ("_" . "u"))))
+ s (+ (match-end 0) 3)
+ string (replace-match
+ (concat "\\1<" c ">\\3</" c ">\\4") t nil string)))
+ string))
(defun org-parse-key-lines ()
"Find the special key lines with the information for exporters."
"Terminate one level in HTML export."
(insert "</ul>"))
-
;; Variable holding the vector with section numbers
(defvar org-section-numbers (make-vector org-level-max 0))
string))
+(defun org-export-icalendar-this-file ()
+ "Export current file as an iCalendar file.
+The iCalendar file will be located in the same directory as the Org-mode
+file, but with extension `.ics'."
+ (interactive)
+ (org-export-icalendar nil buffer-file-name))
+
+;;;###autoload
+(defun org-export-icalendar-all-agenda-files ()
+ "Export all files in `org-agenda-files' to iCalendar .ics files.
+Each iCalendar file will be located in the same directory as the Org-mode
+file, but with extension `.ics'."
+ (interactive)
+ (apply 'org-export-icalendar nil (org-agenda-files t)))
+
+;;;###autoload
+(defun org-export-icalendar-combine-agenda-files ()
+ "Export all files in `org-agenda-files' to a single combined iCalendar file.
+The file is stored under the name `org-combined-agenda-icalendar-file'."
+ (interactive)
+ (apply 'org-export-icalendar t (org-agenda-files t)))
+
+(defun org-export-icalendar (combine &rest files)
+ "Create iCalendar files for all elements of FILES.
+If COMBINE is non-nil, combine all calendar entries into a single large
+file and store it under the name `org-combined-agenda-icalendar-file'."
+ (save-excursion
+ (let* (file ical-file ical-buffer category started org-agenda-new-buffers)
+ (when combine
+ (setq ical-file org-combined-agenda-icalendar-file
+ ical-buffer (org-get-agenda-file-buffer ical-file))
+ (set-buffer ical-buffer) (erase-buffer))
+ (while (setq file (pop files))
+ (catch 'nextfile
+ (org-check-agenda-file file)
+ (unless combine
+ (setq ical-file (concat (file-name-sans-extension file) ".ics"))
+ (setq ical-buffer (org-get-agenda-file-buffer ical-file))
+ (set-buffer ical-buffer) (erase-buffer))
+ (set-buffer (org-get-agenda-file-buffer file))
+ (setq category (or org-category
+ (file-name-sans-extension
+ (file-name-nondirectory buffer-file-name))))
+ (if (symbolp category) (setq category (symbol-name category)))
+ (let ((standard-output ical-buffer))
+ (if combine
+ (and (not started) (setq started t)
+ (org-start-icalendar-file org-icalendar-combined-name))
+ (org-start-icalendar-file category))
+ (org-print-icalendar-entries combine category)
+ (when (or (and combine (not files)) (not combine))
+ (org-finish-icalendar-file)
+ (set-buffer ical-buffer)
+ (save-buffer)
+ (run-hooks 'org-after-save-iCalendar-file-hook)))))
+ (org-release-buffers org-agenda-new-buffers))))
+
+(defvar org-after-save-iCalendar-file-hook nil
+ "Hook run after an iCalendar file has been saved.
+The iCalendar buffer is still current when this hook is run.
+A good way to use this is to tell a desktop calenndar application to re-read
+the iCalendar file.")
+
+(defun org-print-icalendar-entries (&optional combine category)
+ "Print iCalendar entries for the current Org-mode file to `standard-output'.
+When COMBINE is non nil, add the category to each line."
+ (let ((re2 (concat "--?-?\\(" org-ts-regexp "\\)"))
+ (dts (org-ical-ts-to-string
+ (format-time-string (cdr org-time-stamp-formats) (current-time))
+ "DTSTART"))
+ hd ts ts2 state (inc t) pos scheduledp deadlinep tmp pri)
+ (save-excursion
+ (goto-char (point-min))
+ (while (re-search-forward org-ts-regexp nil t)
+ (setq pos (match-beginning 0)
+ ts (match-string 0)
+ inc t
+ hd (org-get-heading))
+ (if (looking-at re2)
+ (progn
+ (goto-char (match-end 0))
+ (setq ts2 (match-string 1) inc nil))
+ (setq ts2 ts
+ tmp (buffer-substring (max (point-min)
+ (- pos org-ds-keyword-length))
+ pos)
+ deadlinep (string-match org-deadline-regexp tmp)
+ scheduledp (string-match org-scheduled-regexp tmp)
+ ;; donep (org-entry-is-done-p)
+ ))
+ (if (or (string-match org-tr-regexp hd)
+ (string-match org-ts-regexp hd))
+ (setq hd (replace-match "" t t hd)))
+ (if combine
+ (setq hd (concat hd " (category " category ")")))
+ (if deadlinep (setq hd (concat "DL: " hd " This is a deadline")))
+ (if scheduledp (setq hd (concat "S: " hd " Scheduled for this date")))
+ (princ (format "BEGIN:VEVENT
+%s
+%s
+SUMMARY:%s
+END:VEVENT\n"
+ (org-ical-ts-to-string ts "DTSTART")
+ (org-ical-ts-to-string ts2 "DTEND" inc)
+ hd)))
+ (when org-icalendar-include-todo
+ (goto-char (point-min))
+ (while (re-search-forward org-todo-line-regexp nil t)
+ (setq state (match-string 1))
+ (unless (equal state org-done-string)
+ (setq hd (match-string 3))
+ (if (string-match org-priority-regexp hd)
+ (setq pri (string-to-char (match-string 2 hd))
+ hd (concat (substring hd 0 (match-beginning 1))
+ (substring hd (- (match-end 1)))))
+ (setq pri org-default-priority))
+ (setq pri (floor (1+ (* 8. (/ (float (- org-lowest-priority pri))
+ (- org-lowest-priority ?A))))))
+
+ (princ (format "BEGIN:VTODO
+%s
+SUMMARY:%s
+SEQUENCE:1
+PRIORITY:%d
+END:VTODO\n"
+ dts hd pri))))))))
+
+(defun org-start-icalendar-file (name)
+ "Start an iCalendar file by inserting the header."
+ (let ((user user-full-name)
+ (name (or name "unknown"))
+ (timezone (cadr (current-time-zone))))
+ (princ
+ (format "BEGIN:VCALENDAR
+VERSION:2.0
+X-WR-CALNAME:%s
+PRODID:-//%s//Emacs with Org-mode//EN
+X-WR-TIMEZONE:%s
+CALSCALE:GREGORIAN\n" name user timezone))))
+
+(defun org-finish-icalendar-file ()
+ "Finish an iCalendar file by inserting the END statement."
+ (princ "END:VCALENDAR\n"))
+
+(defun org-ical-ts-to-string (s keyword &optional inc)
+ "Take a time string S and convert it to iCalendar format.
+KEYWORD is added in front, to make a complete line like DTSTART....
+When INC is non-nil, increase the hour by two (if time string contains
+a time), or the day by one (if it does not contain a time)."
+ (let ((t1 (org-parse-time-string s 'nodefault))
+ t2 fmt have-time time)
+ (if (and (car t1) (nth 1 t1) (nth 2 t1))
+ (setq t2 t1 have-time t)
+ (setq t2 (org-parse-time-string s)))
+ (let ((s (car t2)) (mi (nth 1 t2)) (h (nth 2 t2))
+ (d (nth 3 t2)) (m (nth 4 t2)) (y (nth 5 t2)))
+ (when inc
+ (if have-time (setq h (+ 2 h)) (setq d (1+ d))))
+ (setq time (encode-time s mi h d m y)))
+ (setq fmt (if have-time ":%Y%m%dT%H%M%S" ";VALUE=DATE:%Y%m%d"))
+ (concat keyword (format-time-string fmt time))))
+
+
;;; Key bindings
;; - Bindings in Org-mode map are currently
;; 0123456789abcdefghijklmnopqrstuvwxyz!?@#$%^&-+*/=()_{}[]:;"|,.<>~`'\t the alphabet
-;; abcd fgh j lmnopqrstuvwxyz ? #$ -+*/= [] ; |,.<>~ \t necessary bindings
+;; abcd fgh j lmnopqrstuvwxyz!? #$ ^ -+*/= [] ; |,.<>~ '\t necessary bindings
;; e (?) useful from outline-mode
;; i k @ expendable from outline-mode
-;; 0123456789 ! %^& ()_{} " `' free
+;; 0123456789 % & ()_{} " ` free
+
+;; Make `C-c C-x' a prefix key
+(define-key org-mode-map "\C-c\C-x" (make-sparse-keymap))
;; TAB key with modifiers
(define-key org-mode-map "\C-i" 'org-cycle)
+(define-key org-mode-map [(tab)] 'org-cycle)
(define-key org-mode-map [(meta tab)] 'org-complete)
(define-key org-mode-map "\M-\C-i" 'org-complete) ; for tty emacs
;; The following line is necessary under Suse GNU/Linux
-(unless org-xemacs-p
+(unless (featurep 'xemacs)
(define-key org-mode-map [S-iso-lefttab] 'org-shifttab))
(define-key org-mode-map [(shift tab)] 'org-shifttab)
(define-key org-mode-map [?\C-c ?\C-x (up)] 'org-shiftup)
(define-key org-mode-map (org-key 'S-down) 'org-shiftdown)
(define-key org-mode-map [?\C-c ?\C-x (down)] 'org-shiftdown)
-(define-key org-mode-map (org-key 'S-left) 'org-timestamp-down-day)
-(define-key org-mode-map [?\C-c ?\C-x (left)] 'org-timestamp-down-day)
-(define-key org-mode-map (org-key 'S-right) 'org-timestamp-up-day)
-(define-key org-mode-map [?\C-c ?\C-x (right)] 'org-timestamp-up-day)
+(define-key org-mode-map (org-key 'S-left) 'org-shiftleft)
+(define-key org-mode-map [?\C-c ?\C-x (left)] 'org-shiftleft)
+(define-key org-mode-map (org-key 'S-right) 'org-shiftright)
+(define-key org-mode-map [?\C-c ?\C-x (right)] 'org-shiftright)
;; All the other keys
(define-key org-mode-map "\C-c$" 'org-archive-subtree)
(define-key org-mode-map "\C-c\C-v" 'org-show-todo-tree)
(define-key org-mode-map "\C-c\C-w" 'org-check-deadlines)
(define-key org-mode-map "\C-c/" 'org-occur) ; Minor-mode reserved
+(define-key org-mode-map "\C-c\\" 'org-tags-sparse-tree) ; Minor-mode res.
(define-key org-mode-map "\C-c\C-m" 'org-insert-heading)
(define-key org-mode-map "\M-\C-m" 'org-insert-heading)
(define-key org-mode-map "\C-c\C-l" 'org-insert-link)
(define-key org-mode-map "\C-c\C-o" 'org-open-at-point)
+(define-key org-mode-map "\C-c%" 'org-mark-ring-push)
+(define-key org-mode-map "\C-c&" 'org-mark-ring-goto)
(define-key org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
(define-key org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
(define-key org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
(define-key org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
(define-key org-mode-map "\C-c>" 'org-goto-calendar)
(define-key org-mode-map "\C-c<" 'org-date-from-calendar)
-(define-key org-mode-map "\C-c[" 'org-add-file)
+(define-key org-mode-map [(control ?,)] 'org-cycle-agenda-files)
+(define-key org-mode-map "\C-c[" 'org-agenda-file-to-front)
(define-key org-mode-map "\C-c]" 'org-remove-file)
(define-key org-mode-map "\C-c\C-r" 'org-timeline)
(define-key org-mode-map "\C-c-" 'org-table-insert-hline)
+(define-key org-mode-map "\C-c^" 'org-table-sort-lines)
(define-key org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
(define-key org-mode-map "\C-m" 'org-return)
(define-key org-mode-map "\C-c?" 'org-table-current-column)
(define-key org-mode-map "\C-c " 'org-table-blank-field)
(define-key org-mode-map "\C-c+" 'org-table-sum)
-(define-key org-mode-map "\C-c|" 'org-table-toggle-vline-visibility)
(define-key org-mode-map "\C-c=" 'org-table-eval-formula)
(define-key org-mode-map "\C-c'" 'org-table-edit-formulas)
+(define-key org-mode-map "\C-c`" 'org-table-edit-field)
+(define-key org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
(define-key org-mode-map "\C-c*" 'org-table-recalculate)
(define-key org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
(define-key org-mode-map "\C-c~" 'org-table-create-with-table.el)
(define-key org-mode-map "\C-c\C-x\C-a" 'org-export-as-ascii)
(define-key org-mode-map "\C-c\C-xv" 'org-export-copy-visible)
(define-key org-mode-map "\C-c\C-x\C-v" 'org-export-copy-visible)
-;; OPML support is only planned
+;; OPML support is only an option for the future
;(define-key org-mode-map "\C-c\C-xo" 'org-export-as-opml)
;(define-key org-mode-map "\C-c\C-x\C-o" 'org-export-as-opml)
+(define-key org-mode-map "\C-c\C-xi" 'org-export-icalendar-this-file)
+(define-key org-mode-map "\C-c\C-x\C-i" 'org-export-icalendar-all-agenda-files)
+(define-key org-mode-map "\C-c\C-xc" 'org-export-icalendar-combine-agenda-files)
+(define-key org-mode-map "\C-c\C-x\C-c" 'org-export-icalendar-combine-agenda-files)
(define-key org-mode-map "\C-c\C-xt" 'org-insert-export-options-template)
(define-key org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
(define-key org-mode-map "\C-c\C-xh" 'org-export-as-html)
+(define-key org-mode-map "\C-c\C-xx" 'org-export-as-xml)
+(define-key org-mode-map "\C-c\C-x\C-x" 'org-export-as-xml)
(define-key org-mode-map "\C-c\C-xb" 'org-export-as-html-and-open)
(define-key org-mode-map "\C-c\C-x\C-b" 'org-export-as-html-and-open)
+(define-key org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
(define-key org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
(define-key org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
(define-key org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
overwritten, and the table is not marked as requiring realignment."
(interactive "p")
(if (and (org-table-p)
- (or
- (and org-table-auto-blank-field
- (member last-command
- '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
- (org-table-blank-field))
- t)
+ (progn
+ ;; check if we blank the field, and if that triggers align
+ (and org-table-auto-blank-field
+ (member last-command
+ '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
+ (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
+ ;; got extra space, this field does not determine column width
+ (let (org-table-may-need-update) (org-table-blank-field))
+ ;; no extra space, this field may determine column width
+ (org-table-blank-field)))
+ t)
(eq N 1)
- (looking-at "[^|\n]* +|"))
+ (looking-at "[^|\n]* |"))
(let (org-table-may-need-update)
(goto-char (1- (match-end 0)))
(delete-backward-char 1)
(setq org-table-may-need-update t)
(self-insert-command N)))
-;; FIXME:
-;; The following two functions might still be optimized to trigger
-;; re-alignment less frequently.
-
(defun org-delete-backward-char (N)
"Like `delete-backward-char', insert whitespace at field end in tables.
When deleting backwards, in tables this function will insert whitespace in
front of the next \"|\" separator, to keep the table aligned. The table will
-still be marked for re-alignment, because a narrow field may lead to a
-reduced column width."
+still be marked for re-alignment if the field did fill the entire column,
+because, in this case the deletion might narrow the column."
(interactive "p")
(if (and (org-table-p)
(eq N 1)
(string-match "|" (buffer-substring (point-at-bol) (point)))
(looking-at ".*?|"))
- (let ((pos (point)))
+ (let ((pos (point))
+ (noalign (looking-at "[^|\n\r]* |"))
+ (c org-table-may-need-update))
(backward-delete-char N)
(skip-chars-forward "^|")
(insert " ")
- (goto-char (1- pos)))
+ (goto-char (1- pos))
+ ;; noalign: if there were two spaces at the end, this field
+ ;; does not determine the width of the column.
+ (if noalign (setq org-table-may-need-update c)))
(backward-delete-char N)))
(defun org-delete-char (N)
"Like `delete-char', but insert whitespace at field end in tables.
When deleting characters, in tables this function will insert whitespace in
-front of the next \"|\" separator, to keep the table aligned. The table
-will still be marked for re-alignment, because a narrow field may lead to
-a reduced column width."
+front of the next \"|\" separator, to keep the table aligned. The table will
+still be marked for re-alignment if the field did fill the entire column,
+because, in this case the deletion might narrow the column."
(interactive "p")
(if (and (org-table-p)
(not (bolp))
(not (= (char-after) ?|))
(eq N 1))
(if (looking-at ".*?|")
- (let ((pos (point)))
+ (let ((pos (point))
+ (noalign (looking-at "[^|\n\r]* |"))
+ (c org-table-may-need-update))
(replace-match (concat
(substring (match-string 0) 1 -1)
" |"))
- (goto-char pos)))
+ (goto-char pos)
+ ;; noalign: if there were two spaces at the end, this field
+ ;; does not determine the width of the column.
+ (if noalign (setq org-table-may-need-update c))))
(delete-char N)))
;; How to do this: Measure non-white length of current string
(if (fboundp 'command-remapping)
(define-key map (vector 'remap old) new)
(substitute-key-definition old new map global-map)))))
-
+
(when (eq org-enable-table-editor 'optimized)
;; If the user wants maximum table support, we need to hijack
;; some standard editing functions
(defun org-shiftcursor-error ()
"Throw an error because Shift-Cursor command was applied in wrong context."
- (error "This command is only active in tables and on headlines"))
+ (error "This command is active in special context like tables, headlines or timestamps"))
(defun org-shifttab ()
"Global visibility cycling or move to previous table field.
(cond
((org-at-table-p) (org-table-delete-column))
((org-on-heading-p) (org-promote-subtree))
+ ((org-at-item-p) (call-interactively 'org-outdent-item))
(t (org-shiftcursor-error))))
(defun org-shiftmetaright ()
(cond
((org-at-table-p) (org-table-insert-column))
((org-on-heading-p) (org-demote-subtree))
+ ((org-at-item-p) (call-interactively 'org-indent-item))
(t (org-shiftcursor-error))))
(defun org-shiftmetaup (&optional arg)
"Move subtree up or kill table row.
-Calls `org-move-subtree-up' or `org-table-kill-row', depending on context.
-See the individual commands for more information."
+Calls `org-move-subtree-up' or `org-table-kill-row' or
+`org-move-item-up' depending on context. See the individual commands
+for more information."
(interactive "P")
(cond
((org-at-table-p) (org-table-kill-row))
((org-on-heading-p) (org-move-subtree-up arg))
+ ((org-at-item-p) (org-move-item-up arg))
(t (org-shiftcursor-error))))
(defun org-shiftmetadown (&optional arg)
"Move subtree down or insert table row.
-Calls `org-move-subtree-down' or `org-table-insert-row', depending on context.
-See the individual commands for more information."
+Calls `org-move-subtree-down' or `org-table-insert-row' or
+`org-move-item-down', depending on context. See the individual
+commands for more information."
(interactive "P")
(cond
((org-at-table-p) (org-table-insert-row arg))
((org-on-heading-p) (org-move-subtree-down arg))
+ ((org-at-item-p) (org-move-item-down arg))
(t (org-shiftcursor-error))))
(defun org-metaleft (&optional arg)
"Promote heading or move table column to left.
Calls `org-do-promote' or `org-table-move-column', depending on context.
+With no specific context, calls the Emacs default `backward-word'.
See the individual commands for more information."
(interactive "P")
(cond
(defun org-metaright (&optional arg)
"Demote subtree or move table column to right.
Calls `org-do-demote' or `org-table-move-column', depending on context.
+With no specific context, calls the Emacs default `forward-word'.
See the individual commands for more information."
(interactive "P")
(cond
(defun org-metaup (&optional arg)
"Move subtree up or move table row up.
-Calls `org-move-subtree-up' or `org-table-move-row', depending on context.
-See the individual commands for more information."
+Calls `org-move-subtree-up' or `org-table-move-row' or
+`org-move-item-up', depending on context. See the individual commands
+for more information."
(interactive "P")
(cond
((org-at-table-p) (org-table-move-row 'up))
((org-on-heading-p) (org-move-subtree-up arg))
+ ((org-at-item-p) (org-move-item-up arg))
(t (org-shiftcursor-error))))
(defun org-metadown (&optional arg)
"Move subtree down or move table row down.
-Calls `org-move-subtree-down' or `org-table-move-row', depending on context.
-See the individual commands for more information."
+Calls `org-move-subtree-down' or `org-table-move-row' or
+`org-move-item-down', depending on context. See the individual
+commands for more information."
(interactive "P")
(cond
((org-at-table-p) (org-table-move-row nil))
((org-on-heading-p) (org-move-subtree-down arg))
+ ((org-at-item-p) (org-move-item-down arg))
(t (org-shiftcursor-error))))
(defun org-shiftup (&optional arg)
((org-at-timestamp-p) (org-timestamp-down arg))
(t (org-priority-down))))
+(defun org-shiftright ()
+ "Next TODO keyword or timestamp one day later, depending on context."
+ (interactive)
+ (cond
+ ((org-at-timestamp-p) (org-timestamp-up-day))
+ ((org-on-heading-p) (org-todo 'right))
+ (t (org-shiftcursor-error))))
+
+(defun org-shiftleft ()
+ "Previous TODO keyword or timestamp one day earlier, depending on context."
+ (interactive)
+ (cond
+ ((org-at-timestamp-p) (org-timestamp-down-day))
+ ((org-on-heading-p) (org-todo 'left))
+ (t (org-shiftcursor-error))))
+
(defun org-copy-special ()
"Copy region in table or copy current subtree.
Calls `org-table-copy' or `org-copy-subtree', depending on context.
activate that table. Otherwise, if the cursor is at a normal table
created with org.el, re-align that table. This command works even if
the automatic table editor has been turned off.
+
+If the cursor is in a headline, prompt for tags and insert them into
+the current line, aligned to `org-tags-column'. When in a headline and
+called with prefix arg, realign all tags in the current buffer.
+
If the cursor is in one of the special #+KEYWORD lines, this triggers
scanning the buffer for these lines and updating the information.
If the cursor is on a #+TBLFM line, re-apply the formulae to the table."
(interactive "P")
(let ((org-enable-table-editor t))
(cond
+ ((and (local-variable-p 'org-finish-function (current-buffer))
+ (fboundp org-finish-function))
+ (funcall org-finish-function))
+ ((org-on-target-p) (org-update-radio-target-regexp))
+ ((org-on-heading-p) (org-set-tags arg))
((org-at-table.el-p)
(require 'table)
(beginning-of-line 1)
(org-table-recalculate t)
(org-table-maybe-recalculate-line))
(org-table-align))
+ ((org-at-item-p)
+ (org-renumber-ordered-list (prefix-numeric-value arg)))
((save-excursion (beginning-of-line 1) (looking-at "#\\+\\([A-Z]+\\)"))
(cond
((equal (match-string 1) "TBLFM")
(if (org-at-table-p) (org-table-recalculate t))))
(t
(org-mode-restart))))
- ((org-region-active-p)
- (org-table-convert-region (region-beginning) (region-end) arg))
- ((and (region-beginning) (region-end))
- (if (y-or-n-p "Convert inactive region to table? ")
- (org-table-convert-region (region-beginning) (region-end) arg)
- (error "Abort")))
- (t (error "No table at point, and no region to make one")))))
+ (t (error "C-c C-c can do nothing useful at this location.")))))
(defun org-mode-restart ()
"Restart Org-mode, to scan again for special lines.
(cond
((org-at-table-p)
(org-table-wrap-region arg))
- (t (org-insert-heading))))
+ (t (org-insert-heading arg))))
;;; Menu entries
["Next Row" org-return (org-at-table-p)]
"--"
["Blank Field" org-table-blank-field (org-at-table-p)]
+ ["Edit Field" org-table-edit-field (org-at-table-p)]
["Copy Field from Above" org-table-copy-down (org-at-table-p)]
"--"
("Column"
["Move Column Left" org-metaleft (org-at-table-p)]
["Move Column Right" org-metaright (org-at-table-p)]
["Delete Column" org-shiftmetaleft (org-at-table-p)]
- ["Insert Column" org-shiftmetaright (org-at-table-p)])
+ ["Insert Column" org-shiftmetaright (org-at-table-p)]
+ "--"
+ ["Enable Narrowing" (setq org-table-limit-column-width (not org-table-limit-column-width)) :active (org-at-table-p) :selected org-table-limit-column-width :style toggle])
("Row"
["Move Row Up" org-metaup (org-at-table-p)]
["Move Row Down" org-metadown (org-at-table-p)]
["Delete Row" org-shiftmetaup (org-at-table-p)]
["Insert Row" org-shiftmetadown (org-at-table-p)]
+ ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
"--"
["Insert Hline" org-table-insert-hline (org-at-table-p)])
("Rectangle"
(setq org-table-formula-debug (not org-table-formula-debug))
:style toggle :selected org-table-formula-debug]
"--"
- ["Invisible Vlines" org-table-toggle-vline-visibility
- :style toggle :selected (org-in-invisibility-spec-p '(org-table))]
- "--"
["Create" org-table-create (and (not (org-at-table-p))
org-enable-table-editor)]
- ["Convert Region" org-ctrl-c-ctrl-c (not (org-at-table-p 'any))]
+ ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
["Import from File" org-table-import (not (org-at-table-p))]
["Export to File" org-table-export (org-at-table-p)]
"--"
["Demote Heading" org-metaright (not (org-at-table-p))]
["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
"--"
- ["Archive Subtree" org-archive-subtree t])
+ ["Archive Subtree" org-archive-subtree t]
+ "--"
+ ["Convert to odd levels" org-convert-to-odd-levels t]
+ ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
"--"
("TODO Lists"
["TODO/DONE/-" org-todo t]
["Show TODO Tree" org-show-todo-tree t]
+ ["Global TODO list" org-todo-list t]
"--"
["Set Priority" org-priority t]
["Priority Up" org-shiftup t]
["Goto Calendar" org-goto-calendar t]
["Date from Calendar" org-date-from-calendar t])
"--"
- ("Timeline/Agenda"
- ["Show TODO Tree this File" org-show-todo-tree t]
- ["Check Deadlines this File" org-check-deadlines t]
- ["Timeline Current File" org-timeline t]
- "--"
- ["Agenda" org-agenda t])
+ ["Agenda Command" org-agenda t]
("File List for Agenda")
+ ("Special views current file"
+ ["TODO Tree" org-show-todo-tree t]
+ ["Check Deadlines" org-check-deadlines t]
+ ["Timeline" org-timeline t]
+ ["Tags Tree" org-tags-sparse-tree t])
"--"
("Hyperlinks"
["Store Link (Global)" org-store-link t]
["Insert Link" org-insert-link t]
- ["Follow Link" org-open-at-point t])
+ ["Follow Link" org-open-at-point t]
+ "--"
+ ["Descriptive Links"
+ (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
+ :style radio :selected (member '(org-link) buffer-invisibility-spec)]
+ ["Literal Links"
+ (progn
+ (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
+ :style radio :selected (not (member '(org-link) buffer-invisibility-spec))]
+ "--"
+ ["Upgrade all <link> to [[link][desc]]" org-upgrade-old-links
+ (save-excursion (goto-char (point-min))
+ (re-search-forward "<[a-z]+:" nil t))])
"--"
("Export"
["ASCII" org-export-as-ascii t]
["Extract Visible Text" org-export-copy-visible t]
["HTML" org-export-as-html t]
["HTML and Open" org-export-as-html-and-open t]
-; ["OPML" org-export-as-opml nil]
+ ["XML (XOXO)" org-export-as-xml t]
+ "--"
+ ["iCalendar this file" org-export-icalendar-this-file t]
+ ["iCalendar all agenda files" org-export-icalendar-all-agenda-files
+ :active t :keys "C-c C-x C-i"]
+ ["iCalendar combined" org-export-icalendar-combine-agenda-files t]
"--"
["Option Template" org-insert-export-options-template t]
["Toggle Fixed Width" org-toggle-fixed-width-section t])
("Customize"
["Browse Org Group" org-customize t]
"--"
- ["Build Full Customize Menu" org-create-customize-menu
+ ["Expand This Menu" org-create-customize-menu
(fboundp 'customize-menu-create)])
"--"
["Refresh setup" org-mode-restart t]
(Info-goto-node (format "(org)%s" (or node ""))))
(defun org-install-agenda-files-menu ()
- (easy-menu-change
- '("Org") "File List for Agenda"
- (append
- (list
- ["Edit File List" (customize-variable 'org-agenda-files) t]
- ["Add Current File to List" org-add-file t]
- ["Remove Current File from List" org-remove-file t]
- "--")
- (mapcar 'org-file-menu-entry org-agenda-files))))
+ (let ((bl (buffer-list)))
+ (save-excursion
+ (while bl
+ (set-buffer (pop bl))
+ (if (eq major-mode 'org-mode) (setq bl nil)))
+ (when (eq major-mode 'org-mode)
+ (easy-menu-change
+ '("Org") "File List for Agenda"
+ (append
+ (list
+ ["Edit File List" (org-edit-agenda-file-list) t]
+ ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
+ ["Remove Current File from List" org-remove-file t]
+ ["Cycle through agenda files" org-cycle-agenda-files t]
+ "--")
+ (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
;;; Documentation
(goto-char pos)
(move-to-column col)))
+;; Paragraph filling stuff.
+;; We want this to be just right, so use the full arsenal.
+;; FIXME: This very likely does not work correctly for XEmacs, because the
+;; filladapt package works slightly differently.
+
+(defun org-set-autofill-regexps ()
+ (interactive)
+ ;; In the paragraph separator we include headlines, because filling
+ ;; text in a line directly attached to a headline would otherwise
+ ;; fill the headline as well.
+ (set (make-local-variable 'paragraph-separate) "\f\\|\\*\\|[ ]*$\\|[ \t]*[:|]")
+ ;; The paragraph starter includes hand-formatted lists.
+ (set (make-local-variable 'paragraph-start)
+ "\f\\|[ ]*$\\|\\([*\f]+\\)\\|[ \t]*\\([-+*]\\|[0-9]+[.)][ \t]+\\)\\|[ \t]*[:|]")
+ ;; Inhibit auto-fill for headers, tables and fixed-width lines.
+ ;; But only if the user has not turned off tables or fixed-width regions
+ (set (make-local-variable 'auto-fill-inhibit-regexp)
+ (concat "\\*\\|#"
+ (if (or org-enable-table-editor org-enable-fixed-width-editor)
+ (concat
+ "\\|[ \t]*["
+ (if org-enable-table-editor "|" "")
+ (if org-enable-fixed-width-editor ":" "")
+ "]"))))
+ ;; We use our own fill-paragraph function, to make sure that tables
+ ;; and fixed-width regions are not wrapped. That function will pass
+ ;; through to `fill-paragraph' when appropriate.
+ (set (make-local-variable 'fill-paragraph-function) 'org-fill-paragraph)
+ ;; Adaptive filling: To get full control, first make sure that
+ ;; `adaptive-fill-regexp' never matches. Then install our won matcher.
+ (setq adaptive-fill-regexp "\000")
+ (setq adaptive-fill-function 'org-adaptive-fill-function))
+
+(defun org-fill-paragraph (&optional justify)
+ "Re-align a table, pass through to fill-paragraph if no table."
+ (let ((table-p (org-at-table-p))
+ (table.el-p (org-at-table.el-p)))
+ (cond ((equal (char-after (point-at-bol)) ?*) t) ; skip headlines
+ (table.el-p t) ; skip table.el tables
+ (table-p (org-table-align) t) ; align org-mode tables
+ (t nil)))) ; call paragraph-fill
+
+;; For reference, this is the default value of adaptive-fill-regexp
+;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
+
+(defun org-adaptive-fill-function ()
+ "Return a fill prefix for org-mode files.
+In particular, this makes sure hanging paragraphs for hand-formatted lists
+work correctly."
+ (if (looking-at " *\\([-*+] \\|[0-9]+[.)] \\)?")
+ (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
+
;; Functions needed for Emacs/XEmacs region compatibility
+(defun org-add-hook (hook function &optional append local)
+ "Add-hook, compatible with both Emacsen."
+ (if (and local (featurep 'xemacs))
+ (add-local-hook hook function append)
+ (add-hook hook function append local)))
+
(defun org-region-active-p ()
"Is `transient-mark-mode' on and the region active?
Works on both Emacs and XEmacs."
(if org-ignore-region
nil
- (if org-xemacs-p
+ (if (featurep 'xemacs)
(and zmacs-regions (region-active-p))
(and transient-mark-mode mark-active))))
(delete arg buffer-invisibility-spec)))))
(defun org-in-invisibility-spec-p (arg)
- "Is ARG a member of `buffer-invisibility-spec'?."
+ "Is ARG a member of `buffer-invisibility-spec'?"
(if (consp buffer-invisibility-spec)
(member arg buffer-invisibility-spec)
nil))
t)
"\\'"))))
-;; Functions needed for compatibility with old outline.el
+;; Functions needed for compatibility with old outline.el.
+
+;; Programming for the old outline.el (that uses selective display
+;; instead of `invisible' text properties) is a nightmare, mostly
+;; because regular expressions can no longer be anchored at
+;; beginning/end of line. Therefore a number of function need special
+;; treatment when the old outline.el is being used.
;; The following functions capture almost the entire compatibility code
-;; between the different versions of outline-mode. The only other place
-;; where this is important are the font-lock-keywords. Search for
-;; `org-noutline-p' to find it.
+;; between the different versions of outline-mode. The only other
+;; places where this is important are the font-lock-keywords, and in
+;; `org-export-copy-visible'. Search for `org-noutline-p' to find them.
;; C-a should go to the beginning of a *visible* line, also in the
;; new outline.el. I guess this should be patched into Emacs?
(backward-char 1)
(beginning-of-line 1))
(forward-char 1))))
+
(when org-noutline-p
(define-key org-mode-map "\C-a" 'org-beginning-of-line))
+;; FIXME: should I use substitute-key-definition to reach other bindings
+;; of beginning-of-line?
(defun org-invisible-p ()
"Check if point is at a character currently not visible."
(skip-chars-backward "^\r\n")
(equal (char-before) ?\r))))
+(defun org-invisible-p2 ()
+ "Check if point is at a character currently not visible."
+ (save-excursion
+ (if org-noutline-p
+ (progn
+ (if (and (eolp) (not (bobp))) (backward-char 1))
+ ;; Early versions of noutline don't have `outline-invisible-p'.
+ (if (fboundp 'outline-invisible-p)
+ (outline-invisible-p)
+ (get-char-property (point) 'invisible)))
+ (skip-chars-backward "^\r\n")
+ (equal (char-before) ?\r))))
+
(defun org-back-to-heading (&optional invisible-ok)
"Move to previous heading line, or beg of this line if it's a heading.
Only visible heading lines are considered, unless INVISIBLE-OK is non-nil."
(if org-noutline-p
(outline-back-to-heading invisible-ok)
- (if (looking-at outline-regexp)
+ (if (and (memq (char-before) '(?\n ?\r))
+ (looking-at outline-regexp))
t
(if (re-search-backward (concat (if invisible-ok "\\([\r\n]\\|^\\)" "^")
outline-regexp)
(bobp)
(equal (char-before) ?\n))))))
+(defun org-on-target-p ()
+ (let ((pos (point)))
+ (save-excursion
+ (skip-chars-forward "<")
+ (and (re-search-backward "<<" nil t)
+ (or (looking-at org-radio-target-regexp)
+ (looking-at org-target-regexp))
+ (<= (match-beginning 0) pos)
+ (>= (1+ (match-end 0)) pos)))))
+
(defun org-up-heading-all (arg)
"Move to the heading line of which the present line is a subheading.
This function considers both visible and invisible heading lines.
flag
(if flag ?\r ?\n))))))
+(defun org-end-of-subtree (&optional invisible-OK)
+ ;; This is an exact copy of the original function, but it uses
+ ;; `org-back-to-heading', to make it work also in invisible
+ ;; trees. And is uses an invisible-OK argument.
+ ;; Under Emacs this is not needed, but the old outline.el needs this fix.
+ (org-back-to-heading invisible-OK)
+ (let ((first t)
+ (level (funcall outline-level)))
+ (while (and (not (eobp))
+ (or first (> (funcall outline-level) level)))
+ (setq first nil)
+ (outline-next-heading))
+ (if (memq (preceding-char) '(?\n ?\^M))
+ (progn
+ ;; Go to end of line before heading
+ (forward-char -1)
+ (if (memq (preceding-char) '(?\n ?\^M))
+ ;; leave blank line before heading
+ (forward-char -1))))))
+
(defun org-show-subtree ()
"Show everything after this heading at deeper levels."
(outline-flag-region
(run-hooks 'org-load-hook)
+;; Experimental code
+;; FIXME: Move this code when it is ready.
+
+(defun org-upgrade-old-links (&optional query-description)
+ "Transfer old <...> style links to new [[...]] style links.
+With arg query-description, ask at each match for a description text to use
+for this link."
+ (interactive (list (y-or-n-p "Would you like to be queried for a description at each link?")))
+ (save-excursion
+ (goto-char (point-min))
+ (let ((re (concat "\\([^[]\\)<\\("
+ "\\(" (mapconcat 'identity org-link-types "\\|")
+ "\\):"
+ "[^" org-non-link-chars "]+\\)>"))
+ l1 l2 (cnt 0))
+ (while (re-search-forward re nil t)
+ (setq cnt (1+ cnt)
+ l1 (org-match-string-no-properties 2)
+ l2 (save-match-data (org-link-escape l1)))
+ (when query-description (setq l1 (read-string "Desc: " l1)))
+ (if (equal l1 l2)
+ (replace-match (concat (match-string 1) "[[" l1 "]]") t t)
+ (replace-match (concat (match-string 1) "[[" l2 "][" l1 "]]") t t)))
+ (message "%d matches have beed treated" cnt))))
+
+(defun org-export-as-xml ()
+ "Export current buffer as XOXO XML buffer."
+ (interactive)
+ (cond ((eq org-export-xml-type 'xoxo)
+ (org-export-as-xoxo (current-buffer)))))
+
+(defun org-export-as-xoxo-insert-into (buffer &rest output)
+ (with-current-buffer buffer
+ (apply 'insert output)))
+
+(defun org-export-as-xoxo (&optional buffer)
+ "Export the org buffer as XOXO.
+The XOXO buffer is named *xoxo-<source buffer name>*"
+ (interactive (list (current-buffer)))
+ ;; A quickie abstraction
+
+ ;; Output everything as XOXO
+ (with-current-buffer (get-buffer buffer)
+ (goto-char (point-min)) ;; CD: beginning-of-buffer is not allowed.
+ (let* ((filename (concat (file-name-sans-extension buffer-file-name)
+ ".xml"))
+ (out (find-file-noselect filename))
+ (last-level 1)
+ (hanging-li nil))
+ ;; Check the output buffer is empty.
+ (with-current-buffer out (erase-buffer))
+ ;; Kick off the output
+ (org-export-as-xoxo-insert-into out "<ol class='xoxo'>\n")
+ (while (re-search-forward "^\\(\\*+\\) \\(.+\\)" (point-max) 't)
+ (let* ((hd (match-string-no-properties 1))
+ (level (length hd))
+ (text (concat
+ (match-string-no-properties 2)
+ (save-excursion
+ (goto-char (match-end 0))
+ (let ((str ""))
+ (catch 'loop
+ (while 't
+ (forward-line)
+ (if (looking-at "^[ \t]\\(.*\\)")
+ (setq str (concat str (match-string-no-properties 1)))
+ (throw 'loop str)))))))))
+
+ ;; Handle level rendering
+ (cond
+ ((> level last-level)
+ (org-export-as-xoxo-insert-into out "\n<ol>\n"))
+
+ ((< level last-level)
+ (dotimes (- (- last-level level) 1)
+ (if hanging-li
+ (org-export-as-xoxo-insert-into out "</li>\n"))
+ (org-export-as-xoxo-insert-into out "</ol>\n"))
+ (when hanging-li
+ (org-export-as-xoxo-insert-into out "</li>\n")
+ (setq hanging-li nil)))
+
+ ((equal level last-level)
+ (if hanging-li
+ (org-export-as-xoxo-insert-into out "</li>\n")))
+ )
+
+ (setq last-level level)
+
+ ;; And output the new li
+ (setq hanging-li 't)
+ (if (equal ?+ (elt text 0))
+ (org-export-as-xoxo-insert-into out "<li class='" (substring text 1) "'>")
+ (org-export-as-xoxo-insert-into out "<li>" text))))
+
+ ;; Finally finish off the ol
+ (dotimes (- last-level 1)
+ (if hanging-li
+ (org-export-as-xoxo-insert-into out "</li>\n"))
+ (org-export-as-xoxo-insert-into out "</ol>\n"))
+
+ ;; Finish the buffer off and clean it up.
+ (switch-to-buffer-other-window out)
+ (indent-region (point-min) (point-max) nil)
+ (save-buffer)
+ (goto-char (point-min))
+ )))
+
;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
;;; org.el ends here
+