1 ;; org.el --- Outline-based notes management and organizer
3 ;; Copyright (c) 2003, 2004 Free Software Foundation
5 ;; Author: Carsten Dominik <dominik at science dot uva dot nl>
6 ;; Keywords: outlines, hypermedia, calendar
7 ;; Homepage: http://www.astro.uva.nl/~dominik/Tools/org/
8 ;; Version: 3.03 (internal CVS version is $Revision: 1.104 $)
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
28 ;; Carsten's outline-mode for keeping track of everything.
32 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
33 ;; project planning with a fast and effective plain-text system.
35 ;; Org-mode develops organizational tasks around a NOTES file that contains
36 ;; information about projects as plain text. Org-mode is implemented on
37 ;; top of outline-mode - ideal to keep the content of large files well
38 ;; structured. It supports ToDo items, deadlines and time stamps, which
39 ;; magically appear in the diary listing of the Emacs calendar. Tables are
40 ;; easily created with a built-in table editor. Plain text URL-like links
41 ;; connect to websites, emails (VM,RMAIL,WANDERLUST), Usenet messages (Gnus),
42 ;; BBDB entries, and any files related to the projects. For printing and
43 ;; sharing of notes, an Org-mode file (or a part of it) can be exported as
44 ;; a structured ASCII file, or as HTML.
48 ;; The instruction below assume that you have downloaded Org-mode from the
49 ;; web. If Org-mode is part of the Emacs distribution or an XEmacs package,
50 ;; you only need to add to .emacs the last three lines of Lisp code listed
51 ;; below, i.e. the `auto-mode-alist' modification and the global key bindings.
53 ;; Byte-compile org.el and put it on your load path. Then copy the
54 ;; following lines into .emacs. The last two lines define *global*
55 ;; keys for the commands `org-store-link' and `org-agenda' - please
56 ;; choose suitable keys yourself.
58 ;; (autoload 'org-mode "org" "Org mode" t)
59 ;; (autoload 'org-diary "org" "Diary entries from Org mode")
60 ;; (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t)
61 ;; (autoload 'org-store-link "org" "Store a link to the current location" t)
62 ;; (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
63 ;; (define-key global-map "\C-cl" 'org-store-link)
64 ;; (define-key global-map "\C-ca" 'org-agenda)
66 ;; This will put all files with extension ".org" into Org-mode. As an
67 ;; alternative, make the first line of a file look like this:
69 ;; MY PROJECTS -*- mode: org; -*-
71 ;; which will select Org-mode for this buffer no matter what the file's
76 ;; The documentation of Org-mode can be found in the TeXInfo file.
77 ;; This distribution also contains a PDF version of it. At the homepage
78 ;; of Org-mode, you can find and read online the same text as HTML.
83 ;; - Copyright transfer to the FSF.
84 ;; - Effect of C-u and C-u C-u in org-timeline interchanged.
85 ;; - Timeline now always contains today, and `.' jumps to it.
87 ;; - cut and paste of regtangular regions in tables
88 ;; - command to convert org-mode table to table.el table and back
89 ;; - command to treat several cells like a paragraph and fill it
90 ;; - command to convert a buffer region to a table
91 ;; - import/export tables as tab-separated files (exchange with Excel)
93 ;; - Sorting mechanism for agenda items rewritten from scratch.
94 ;; - Sorting fully configurable.
95 ;; - Entries specifying a time are sorted together.
96 ;; - Completion also covers option keywords after `#-'.
100 ;; - New reference card, thanks to Philip Rooke for creating it.
101 ;; - Single file agenda renamed to "Timeline". It no longer shows
102 ;; warnings about upcoming deadlines/overdue scheduled items.
103 ;; That functionality is now limited to the (multifile) agenda.
104 ;; - When reading a date, the calendar can be manipulated with keys.
105 ;; - Link support for RMAIL and Wanderlust (from planner.el, untested)
106 ;; - Minor bug fixes and documentation improvements.
109 ;; - Multifile Agenda shows current entries from many different files.
110 ;; - TeXInfo documentation (thanks to Christian Egli for the conversion).
111 ;; - Additional applications for TODO keywords, see documentation.
112 ;; Different files may have different TODO keywords etc.
113 ;; - Priorities for TODO items.
114 ;; - The browser mode used by `org-remember-handler' is improved.
115 ;; - Images get inlined in HTML export (thanks to Carsten Wimmer).
116 ;; - File links can contain line numbers, like file:/usr/etc/config:255
117 ;; - Minor bug fixes.
120 ;; - TODO entries can have additional states besides TODO and DONE.
121 ;; See new variable `org-todo-keywords'.
122 ;; - TODO keywords can be interpreted as categories. See variable
123 ;; `org-todo-interpretation'.
124 ;; - M-TAB completion on TODO keywords, TeX symbols, and normal words.
125 ;; - All keywords (like TODO, DEADLINE etc) are configurable.
126 ;; - Cursor positioning optimized after pro/demotion and TODO cycling.
127 ;; - Emphasizing in HTML works now for *bold*, /italic/ and _underline_.
128 ;; - New commands to kill, copy and yank entire subtrees. Yanking
129 ;; modifies the level of the tree before insertion.
130 ;; - New command `org-goto' (C-c C-j) to quickly move to other locations
131 ;; in the buffer without affecting outline visibility.
132 ;; - Hooks for John Wiegley's remember.el.
133 ;; - `org-read-date' pops up calendar for date selection with the mouse.
134 ;; See variable `org-popup-calendar-for-date-prompt'.
137 ;; - TODO items can be SCHEDULED to a certain date.
138 ;; - Expired DEADLINEs are ignored if in an entry marked DONE.
139 ;; - From the diary or time-sorted view (C-c C-r), C-c C-t can be used to
140 ;; change the TODO state of an item remotely.
141 ;; - Horizontal computations in table editor. See `org-table-eval-formula'.
142 ;; - Fixed bug with summing tables (command `org-table-sum', `C-c +').
143 ;; - Calendar window follows the timestamp when a timestamp is changed.
144 ;; New variable `org-calendar-follow-timestamp-change'.
145 ;; - Time-sorted view (`org-diary-view', C-c C-r) now uses the prefix
146 ;; argument to force inclusion of unscheduled TODO items.
147 ;; - New variable `org-confirm-shell-links' to turn of safety query.
148 ;; - New variable `org-open-non-existing-files'.
151 ;; - A time-sorted view on all time stamps can be created with C-c C-r.
152 ;; - Timestamps and Deadlines can be shown in the Emacs diary.
153 ;; - Date ranges introduced.
154 ;; - Time-string formats are no longer configurable.
155 ;; - Vertical lines in tables can be made invisible with `C-c |'.
156 ;; - New "link" type to execute shell commands, like "shell:ls *.org"
157 ;; - Upon export, "myfile.org" becomes "myfile.html" or "myfile.txt",
158 ;; instead of "myfile.org.html" or "myfile.org.txt".
159 ;; - When the cursor is in the white space at the beginning of a line,
160 ;; TAB removes the whitespace before indenting again.
163 ;; - Windows (NT/2000) support.
164 ;; - Works with both Emacs and XEmacs.
165 ;; - Fully automatic table editor.
166 ;; - New link types into Gnus, VM and BBDB.
167 ;; - Other link system changes
168 ;; - Time stamps are treated as links to the calendar.
169 ;; - Easy creation of links with global command `org-store-link'.
170 ;; - Insertion of links with `C-c C-l' works differently now.
171 ;; - Space characters allowed as part of a link.
172 ;; - Options in `org-file-apps' extended. The command may now be
173 ;; symbol 'emacs', or a lisp form.
174 ;; Please re-read the manual section about links.
175 ;; - Timestamp changes
176 ;; - `org-deadline' now prompts for a date.
177 ;; - A line can now contain several timestamps. Updating of a
178 ;; timestamp only happens if the cursor is at the timestamp.
179 ;; - Changed the time-stamp-format to ISO, to make sure it will
180 ;; always work (non-English month names had caused problems
181 ;; with `parse-time-string'.). Changing the time stamp format
182 ;; is not recommended.
183 ;; - Picture mode enhancements have been removed from org.el
186 ;; - Some option name changes, not backward compatible.
187 ;; - ASCII exporter upgrade: Table of contents.
188 ;; - HTML exporter upgrade: fixed-width regions, better
189 ;; sub/superscripts, many TeX symbols supported.
190 ;; - Calendar support.
193 ;; - HTML exporter upgrade, in particular table of contents
200 (eval-when-compile (require 'cl))
205 ;;; Customization variables
207 (defvar org-version "3.03"
208 "The version number of the file org.el.")
209 (defun org-version (arg)
211 (message "Org-mode version %s" org-version))
213 ;; The following two constants are for compatibility with different
214 ;; Emacs versions (Emacs versus XEmacs) and with different versions of
215 ;; outline.el. All the compatibility code in org.el is based on these two
217 (defconst org-xemacs-p (featurep 'xemacs)
218 "Are we running xemacs?")
219 (defconst org-noutline-p (featurep 'noutline)
220 "Are we using the new outline mode?")
223 "Outline-based notes management and organizer "
229 (defgroup org-startup nil
230 "Options concerning startup of Org-mode."
234 (defcustom org-startup-folded t
235 "Non-nil means, entering Org-mode will switch to OVERVIEW."
239 (defcustom org-startup-truncated t
240 "Non-nil means, entering Org-mode will set `truncate-lines'.
241 This is useful since some lines containing links can be very long and
242 uninteresting. Also tables look terrible when wrapped."
246 (defcustom org-startup-with-deadline-check nil
247 "Non-nil means, entering Org-mode will run the deadline check.
248 This means, if you start editing an org file, you will get an
249 immediate reminder of any due deadlines."
253 (defcustom org-insert-mode-line-in-empty-file t
254 "Non-nil means insert the first line setting Org-mode in empty files.
255 When the function `org-mode' is called interactively in an empty, this
256 normally means that the file name does not automatically trigger Org-mode.
257 To ensure that the file will always be in Org-mode in the future, a
258 line enforcing Org-mode can be inserted into the buffer."
262 (defgroup org-keywords nil
263 "Options concerning TODO items in Org-mode."
267 (defcustom org-todo-keywords '("TODO" "DONE")
268 "List of TODO entry keywords.\\<org-mode-map>
269 By default, this is '(\"TODO\" \"DONE\"). The last entry in the list is
270 considered to mean that the entry is \"done\". All the other mean that
271 action is required, and will make the entry show up in todo lists, diaries
273 The command \\[org-todo] cycles an entry through these states, and an
274 additional state where no keyword is present. For details about this
275 cycling, see also the variable `org-todo-interpretation'
276 Changes become only effective after restarting Emacs."
278 :type '(repeat (string :tag "Keyword")))
280 (defcustom org-todo-interpretation 'sequence
281 "Controls how TODO keywords are interpreted.\\<org-mode-map>
282 Possible values are `sequence' and `type'.
283 This variable is only relevant if `org-todo-keywords' contains more than two
284 states. There are two ways how these keywords can be used:
286 - As a sequence in the process of working on a TODO item, for example
287 (setq org-todo-keywords '(\"TODO\" \"STARTED\" \"VERIFY\" \"DONE\")
288 org-todo-interpretation 'sequence)
290 - As different types of TODO items, for example
291 (setq org-todo-keywords '(\"URGENT\" \"RELAXED\" \"REMIND\" \"FOR_TOM\" \"DONE\")
292 org-todo-interpretation 'type)
294 When the states are interpreted as a sequence, \\[org-todo] always cycles
295 to the next state, in order to walk through all different states. So with
296 \\[org-todo], you turn an empty entry into the state TODO. When you started
297 working on the item, you use \\[org-todo] again to switch it to \"STARTED\",
298 later to VERIFY and finally to DONE.
300 When the states are interpreted as types, \\[org-todo] still cycles through
301 when it is called several times in direct succession, in order to initially
302 select the type. However, if not called immediately after a previous
303 \\[org-todo], it switches from each type directly to DONE. So with the
304 above example, you could use `\\[org-todo] \\[org-todo]' to label an entry
305 RELAXED. If you later return to this entry and press \\[org-todo] again,
306 RELAXED will not be changed REMIND, but directly to DONE.
308 You can create a large number of types. To initially select a
309 type, it is then best to use C-u \\[org-todo] in order to specify the
310 type with completion. Of course, you can also type the keyword
311 directly into the buffer. M-TAB completes TODO keywords at the
312 beginning of a headline."
314 :type '(choice (const sequence)
317 (defcustom org-default-priority ?B
318 "The default priority of TODO items.
319 This is the priority an item get if no explicit priority is given."
323 (defcustom org-lowest-priority ?C
324 "The lowest priority of TODO items. A character like ?A, ?B etc."
328 (defcustom org-deadline-string "DEADLINE:"
329 "String to mark deadline entries.
330 A deadline is this string, followed by a time stamp. Should be a word,
331 terminated by a colon. You can insert a schedule keyword and
332 a timestamp with \\[org-deadline].
333 Changes become only effective after restarting Emacs."
337 (defcustom org-scheduled-string "SCHEDULED:"
338 "String to mark scheduled TODO entries.
339 A schedule is this string, followed by a time stamp. Should be a word,
340 terminated by a colon. You can insert a schedule keyword and
341 a timestamp with \\[org-schedule].
342 Changes become only effective after restarting Emacs."
346 (defcustom org-comment-string "COMMENT"
347 "Entries starting with this keyword will never be exported.
348 An entry can be toggled between COMMENT and normal with
349 \\[org-toggle-comment].
350 Changes become only effective after restarting Emacs."
354 (defcustom org-after-todo-state-change-hook nil
355 "Hook which is run after the state of a TODO item was changed.
356 The new state (a string with a todo keyword, or nil) is available in the
357 lisp variable `state'."
361 ;; Variables for pre-computed regular expressions, all buffer local
362 (defvar org-todo-kwd-priority-p nil
363 "Do TODO items have priorities?")
364 (make-variable-buffer-local 'org-todo-kwd-priority-p)
365 (defvar org-todo-kwd-max-priority nil
366 "Maximum priority of TODO items")
367 (make-variable-buffer-local 'org-todo-kwd-max-priority)
368 (defvar org-ds-keyword-length 12
369 "Maximum length of the Deadline and SCHEDULED keywords.")
370 (make-variable-buffer-local 'org-ds-keyword-length)
371 (defvar org-done-string nil
372 "The last string in `org-todo-keywords', indicating an item is DONE.")
373 (make-variable-buffer-local 'org-done-string)
374 (defvar org-todo-regexp nil
375 "Matches any of the TODO state keywords.")
376 (make-variable-buffer-local 'org-todo-regexp)
377 (defvar org-not-done-regexp nil
378 "Matches any of the TODO state keywords except the last one.")
379 (make-variable-buffer-local 'org-not-done-regexp)
380 (defvar org-todo-line-regexp nil
381 "Matches a headline and puts TODO state into group 2 if present.")
382 (make-variable-buffer-local 'org-todo-line-regexp)
383 (defvar orb-nl-done-regexp nil
384 "Matches newline followed by a headline with the DONE keyword.")
385 (make-variable-buffer-local 'orb-nl-done-regexp)
386 (defvar org-looking-at-done-regexp nil
387 "Matches the DONE keyword a point.")
388 (make-variable-buffer-local 'org-looking-at-done-regexp)
389 (defvar org-deadline-regexp nil
390 "Matches the DEADLINE keyword.")
391 (make-variable-buffer-local 'org-deadline-regexp)
392 (defvar org-deadline-time-regexp nil
393 "Matches the DEADLINE keyword together with a time stamp.")
394 (make-variable-buffer-local 'org-deadline-time-regexp)
395 (defvar org-deadline-line-regexp nil
396 "Matches the DEADLINE keyword and the rest of the line.")
397 (make-variable-buffer-local 'org-deadline-line-regexp)
398 (defvar org-scheduled-regexp nil
399 "Matches the SCHEDULED keyword.")
400 (make-variable-buffer-local 'org-scheduled-regexp)
401 (defvar org-scheduled-time-regexp nil
402 "Matches the SCHEDULED keyword together with a time stamp.")
403 (make-variable-buffer-local 'org-scheduled-time-regexp)
405 (defun org-set-regexps ()
406 "Precompute regular expressions for current buffer."
407 (when (eq major-mode 'org-mode)
408 (let ((re (org-make-options-regexp
409 '("CATEGORY" "SEQ_TODO" "PRI_TODO" "TYP_TODO")))
411 kwds int key value cat)
415 (goto-char (point-min))
416 (while (re-search-forward re nil t)
417 (setq key (match-string 1) value (match-string 2))
419 ((equal key "CATEGORY")
420 (setq cat (intern (car (org-split-string value splitre)))))
421 ((equal key "SEQ_TODO")
423 kwds (append kwds (org-split-string value splitre))))
424 ((equal key "PRI_TODO")
426 kwds (append kwds (org-split-string value splitre))))
427 ((equal key "TYP_TODO")
429 kwds (append kwds (org-split-string value splitre)))))
431 (and cat (set (make-local-variable 'org-category) cat))
432 (and kwds (set (make-local-variable 'org-todo-keywords) kwds))
433 (and int (set (make-local-variable 'org-todo-interpretation) int)))
434 ;; Compute the regular expressions and other local variables
435 (setq org-todo-kwd-priority-p (equal org-todo-interpretation 'priority)
436 org-todo-kwd-max-priority (1- (length org-todo-keywords))
437 org-ds-keyword-length (+ 2 (max (length org-deadline-string)
438 (length org-scheduled-string)))
440 (nth (1- (length org-todo-keywords)) org-todo-keywords)
442 (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords
446 (mapconcat 'regexp-quote
447 (nreverse (cdr (reverse org-todo-keywords)))
451 (concat "^\\(\\*+\\)[ \t]*\\("
452 (mapconcat 'regexp-quote org-todo-keywords "\\|")
455 (concat "[\r\n]\\*+[ \t]+" org-done-string "\\>")
456 org-looking-at-done-regexp (concat "^" org-done-string "\\>")
457 org-deadline-regexp (concat "\\<" org-deadline-string)
458 org-deadline-time-regexp
459 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
460 org-deadline-line-regexp
461 (concat "\\<\\(" org-deadline-string "\\).*")
463 (concat "\\<" org-scheduled-string)
464 org-scheduled-time-regexp
465 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
466 (org-set-font-lock-defaults)))
468 ;(add-hook 'hack-local-variables-hook 'org-set-regexps)
470 (defgroup org-time nil
471 "Options concerning time stamps and deadlines in Org-mode."
475 (defcustom org-deadline-warning-days 30
476 "No. of days before expiration during which a deadline becomes active.
477 This variable governs the display in the org file."
481 (defcustom org-popup-calendar-for-date-prompt t
482 "Non-nil means, pop up a calendar when prompting for a date.
483 In the calendar, the date can be selected with mouse-1. However, the
484 minibuffer will also be active, and you can simply enter the date as well.
485 When nil, only the minibuffer will be available."
489 (defcustom org-calendar-follow-timestamp-change t
490 "Non-nil means, make the calendar window follow timestamp changes.
491 When a timestamp is modified and the calendar window is visible, it will be
492 moved to the new date."
496 (defgroup org-agenda nil
497 "Options concerning agenda display Org-mode."
501 (defcustom org-agenda-files nil
502 "A list of org files for agenda/diary display.
503 Entries are added to this list with \\[org-add-file] and removed with
504 \\[org-remove-file]. You can also use customize to edit the list."
506 :type '(repeat file))
508 (defcustom org-select-timeline-window t
509 "Non-nil means, after creating a timeline, move cursor into Timeline window.
510 When nil, cursor will remain in the current window."
514 (defcustom org-select-agenda-window t
515 "Non-nil means, after creating an agenda, move cursor into Agenda window.
516 When nil, cursor will remain in the current window."
520 (defcustom org-agenda-show-all-dates t
521 "Non-nil means, `org-agenda' shows every day in the selected range.
522 When nil, only the days which actually have entries are shown."
526 ;; FIXME: First day of month works only for current month because it would
527 ;; require a variable ndays treatment.
528 (defcustom org-agenda-start-on-weekday 1
529 "Non-nil means, start the overview always on the specified weekday.
530 0 Denotes Sunday, 1 denotes Monday etc.
531 When nil, always start on the current day."
533 :type '(choice (const :tag "Today" nil)
534 (const :tag "First day of month" t)
535 (number :tag "Weekday No.")))
537 (defcustom org-agenda-ndays 7
538 "Number of days to include in overview display."
542 (defcustom org-agenda-include-all-todo t
543 "Non-nil means, the multifile agenda will always contain alm TODO entries.
544 When nil, date-less entries will only be shown if `org-agenda' is called
545 with a prefix argument.
546 When non-nil, the TODO entries will be listed at the top of the agenda, before
547 the entries for specific days."
551 (defcustom org-agenda-include-diary nil
552 "Non-nil means, when preparing the agenda, also get the
553 entries from the emacs calendars diary."
558 (defcustom org-agenda-sorting-strategy '(time-up category-keep priority-down)
559 "Sorting structure for the agenda items of a single day.
560 This is a list of symbols which will be used in sequence to determine
561 if an entry should be listed before another entry. The following
562 symbols are recognized.
564 time-up Put entries with time-of-day indications first, early first
565 time-down Put entries with time-of-day indications first, late first
566 category-keep Keep the default order of categories, corresponding to the
567 sequence in `org-agenda-files'.
568 category-up Sort alphabetically by category, A-Z.
569 category-down Sort alphabetically by category, Z-A.
570 priority-up Sort numerically by priority, high priority last.
571 priority-down Sort numerically by priority, high priority first.
573 The different possibilities will be tried in sequence, and testing stops
574 if one comparison returns a \"not-equal\". For example, the default
575 '(time-up category-keep priority-down)
576 means: Pull out all entries having a specified time of day and sort them,
577 in order to make a time schedule for the current day the first thing in the
578 agenda listing for the day. Of the entries without a time indication, keep
579 the grouped in categories, don't sort the categories, but keep them in
580 the sequence given in `org-agenda-files'. Within each category sort by
583 Leaving out the `category-keep' would mean that items will be sorted across
584 categories by priority."
590 (const category-keep)
592 (const category-down)
594 (const priority-down))))
596 (defcustom org-sort-agenda-notime-is-late t
597 "Non-nil means, items without time are considered late.
598 This is only relevant for sorting. When t, items which have no explicit
599 time like 15:30 will be considered as 24:01, i.e. later than any items which
600 do have a time. When nil, the default time is before 0:00."
604 (defvar org-category nil
605 "Variable used by org files to set a category for agenda display.
606 Such files should use a file variable to set it, for example
608 -*- mode: org; org-category: \"ELisp\"
610 If the file does not specify a category, the file's base name
613 (defgroup org-structure nil
614 "Options concerning structure editing in Org-mode."
618 (defcustom org-adapt-indentation t
619 "Non-nil means, adapt indentation when promoting and demoting.
620 When this is set and the *entire* text in an entry is indented, the
621 indentation is increased by one space in a demotion command, and
622 decreased by one in a promotion command. If any line in the entry
623 body starts at column 0, indentation is not changed at all."
624 :group 'org-structure
627 (defcustom org-cycle-emulate-tab t
628 "Where should `org-cycle' emulate TAB.
630 white Only in completely white lines
631 t Everywhere except in headlines"
632 :group 'org-structure
633 :type '(choice (const :tag "Never" nil)
634 (const :tag "Only in completely white lines" white)
635 (const :tag "Everywhere except in headlines" t)
638 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
639 "Formats for `format-time-string' which are used for time stamps.
640 It is not recommended to change this constant.")
642 (defgroup org-link nil
643 "Options concerning links in Org-mode."
647 (defcustom org-allow-space-in-links t
648 "Non-nil means, file names in links may contain space characters.
649 When nil, it becomes possible to put several links into a line."
653 (defcustom org-line-numbers-in-file-links t
654 "Non-nil means, file links from `org-store-link' contain line numbers.
655 The line number will be added to the file name with :NNN and interpreted
656 by the command `org-open-at-point'.
657 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
658 negates this setting for the duration of the command."
662 (defcustom org-keep-stored-link-after-insertion nil
663 "Non-nil means, keep link in list for entire session.
665 The command `org-store-link' adds a link pointing to the current
666 location to an internal list. These links accumulate during a session.
667 The command `org-insert-link' can be used to insert links into any
668 Org-mode file (offering completion for all stored links). When this
669 option is nil, every link which has been inserted once using `C-c C-l'
670 will be removed from the list, to make completing the unused links
675 (defcustom org-link-frame-setup
676 '((vm . vm-visit-folder-other-frame)
677 (gnus . gnus-other-frame)
678 (file . find-file-other-window))
679 "Setup the frame configuration for following links.
680 When following a link with Emacs, it may often be useful to display
681 this link in another window or frame. This variable can be used to
682 set this up for the different types of links.
685 vm-visit-folder-other-frame
691 find-file-other-window
692 find-file-other-frame
693 For the calendar, use the variable `calendar-setup'.
694 For BBDB, it is currently only possible to display the matches in
700 (const vm-visit-folder)
701 (const vm-visit-folder-other-window)
702 (const vm-visit-folder-other-frame)))
706 (const gnus-other-frame)))
710 (const find-file-other-window)
711 (const find-file-other-frame)))))
713 (defcustom org-usenet-links-prefer-google nil
714 "Non-nil means, `org-store-link' will create web links to google groups.
715 When nil, Gnus will be used for such links.
716 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
717 negates this setting for the duration of the command."
721 (defcustom org-open-non-existing-files nil
722 "Non-nil means, `org-open-file' will open non-existing file.
723 When nil, an error will be generated."
727 (defcustom org-confirm-shell-links t
728 "Non-nil means, ask for confirmation before executing shell links.
729 The default is true, to keep new users from shooting into their own foot."
733 (defconst org-file-apps-defaults-linux
747 ("mpeg" . "plaympeg %s")
748 ("mp3" . "plaympeg %s")
750 ("pdf" . "acroread %s")
751 ("doc" . "soffice %s")
752 ("ppt" . "soffice %s")
753 ("pps" . "soffice %s")
754 ("html" . "netscape -remote openURL(%s,new-window)")
755 ("htm" . "netscape -remote openURL(%s,new-window)")
756 ("xs" . "soffice %s"))
757 "Default file applications on a UNIX/LINUX system.
758 See `org-file-apps'.")
760 (defconst org-file-apps-defaults-macosx
768 "Default file applications on a MacOS X system.
769 The system \"open\" is known as a default, but we use X11 applications
770 for some files for which the OS does not have a good default.
771 See `org-file-apps'.")
773 (defconst org-file-apps-defaults-windowsnt
774 '((t . (w32-shell-execute "open" file)))
775 "Default file applications on a Windows NT system.
776 The system \"open\" is used for most files.
777 See `org-file-apps'.")
779 (defcustom org-file-apps
787 "External applications for opening `file:path' items in a document.
788 Org-mode uses system defaults for different file types, but
789 you can use this variable to set the application for a given file
790 extension. The entries in this list are cons cells with a file extension
791 and the corresponding command. Possible values for the command are:
792 `emacs' The file will be visited by the current Emacs process.
793 `default' Use the default application for this file type.
794 string A command to be executed by a shell. %s will be replaced
795 by the path to the file.
796 sexp A lisp form which will be evaluated. The file path will
797 be available in the lisp variable `file'.
798 For more examples, see the system specific constants
799 `org-file-apps-defaults-macosx'
800 `org-file-apps-defaults-windowsnt'
801 `org-file-apps-defaults-linux'."
804 (cons (string :tag "Extension")
806 (const :tag "Visit with Emacs" 'emacs)
807 (const :tag "Use system default" 'default)
808 (string :tag "Command")
809 (sexp :tag "Lisp form")))))
812 (defgroup org-remember nil
813 "Options concerning interaction with remember.el."
817 (defcustom org-directory "~/org"
818 "Directory with org files.
819 This directory will be used as default to prompt for org files.
820 Used by the hooks for remember.el."
824 (defcustom org-default-notes-file "~/.notes"
825 "Default target for storing notes.
826 Used by the hooks for remember.el. This can be a string, or nil to mean
827 the value of `remember-data-file'."
830 (const :tag "Default from remember-data-file" nil)
833 (defcustom org-reverse-note-order nil
834 "Non-nil means, store new notes at the beginning of a file or entry.
835 When nil, new notes will be filed to the end of a file or entry."
838 (const :tag "Reverse always" t)
839 (const :tag "Reverse never" nil)
840 (repeat :tag "By file name regexp"
841 (cons regexp boolean))))
843 (defgroup org-table nil
844 "Options concerning tables in Org-mode."
848 (defcustom org-enable-table-editor t
849 "Non-nil means, lines starting with \"|\" are handled by the table editor.
850 When nil, such lines will be treated like ordinary lines."
854 (defcustom org-table-default-size "5x2"
855 "The default size for newly created tables, Columns x Rows."
859 (defcustom org-table-automatic-realign t
860 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
861 When nil, aligning is only done with \\[org-table-align], or after column
866 (defcustom org-table-spaces-around-separators '(1 . 1)
867 "The number of spaces to be placed before and after separators."
869 :type '(cons (number :tag "Before \"|\"") (number :tag " After \"|\"")))
871 (defcustom org-table-spaces-around-invisible-separators '(1 . 2)
872 "The number of spaces to be placed before and after separators.
873 This option applies when the column separators have been made invisible."
875 :type '(cons (number :tag "Before \"|\"") (number :tag " After \"|\"")))
877 (defcustom org-table-number-regexp "^[<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*$"
878 "Regular expression for recognizing numbers in table columns.
879 If a table column contains mostly numbers, it will be aligned to the
880 right. If not, it will be aligned to the left.
882 The default value of this option is a regular expression which allows
883 anything which looks remotely like a number as used in scientific
884 context. For example, all of the following will be considered a
886 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
888 Other options offered by the customize interface are more restrictive."
891 (const :tag "Positive Integers"
893 (const :tag "Integers"
895 (const :tag "Floating Point Numbers"
896 "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.[0-9]*\\)$")
897 (const :tag "Floating Point Number or Integer"
898 "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.?[0-9]*\\)$")
899 (const :tag "Exponential, Floating point, Integer"
900 "^[-+]?[0-9.]+\\([eEdD][-+0-9]+\\)?$")
901 (const :tag "Very General Number-Like"
902 "^[<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*$")
903 (string :tag "Regexp:")))
905 (defcustom org-table-number-fraction 0.5
906 "Fraction of numbers in a column required to make the column align right.
907 In a column all non-white fields are considered. If at least this
908 fraction of fields is matched by `org-table-number-fraction',
909 alignment to the right border applies."
913 (defcustom org-export-highlight-first-table-line t
914 "Non-nil means, highlight the first table line.
915 In HTML export, this means use <th> instead of <td>.
916 In tables created with table.el, this applies to the first table line.
917 In Org-mode tables, all lines before the first horizontal separator
918 line will be formatted with <th> tags."
922 (defcustom org-table-tab-recognizes-table.el t
923 "Non-nil means, TAB will automatically notice a table.el table.
924 When it sees such a table, it moves point into it and - if necessary -
925 calls `table-recognize-table'."
929 (defcustom org-export-prefer-native-exporter-for-tables nil
930 "Non-nil means, always export tables created with table.el natively.
931 Natively means, use the HTML code generator in table.el.
932 When nil, Org-mode's own HTML generator is used when possible (i.e. if
933 the table does not use row- or column-spanning). This has the
934 advantage, that the automatic HTML conversions for math symbols and
935 sub/superscripts can be applied. Org-mode's HTML generator is also
940 (defcustom org-enable-fixed-width-editor t
941 "Non-nil means, lines starting with \":\" are treated as fixed-width.
942 This currently only means, they are never auto-wrapped.
943 When nil, such lines will be treated like ordinary lines."
947 (defgroup org-export nil
948 "Options for exporting org-listings."
952 (defcustom org-export-language-setup
953 '(("en" "Author" "Date" "Table of Contents")
954 ("da" "Ophavsmand" "Dato" "Indhold")
955 ("de" "Autor" "Datum" "Inhaltsverzeichnis")
956 ("es" "Autor" "Fecha" "\xccndice")
957 ("fr" "Auteur" "Date" "Table des Mati\xe8res")
958 ("it" "Autore" "Data" "Indice")
959 ("nl" "Auteur" "Datum" "Inhoudsopgave")
960 ("nn" "Forfattar" "Dato" "Innhold") ;; nn = Norsk (nynorsk)
961 ("sv" "F\xf6rfattarens" "Datum" "Inneh\xe5ll"))
962 "Terms used in export text, translated to different languages.
963 Use the variable `org-export-default-language' to set the language,
964 or use the +OPTION lines for a per-file setting."
968 (string :tag "HTML language tag")
969 (string :tag "Author")
971 (string :tag "Table of Contents"))))
973 (defcustom org-export-default-language "en"
974 "The default language of HTML export, as a string.
975 This should have an association in `org-export-language-setup'"
979 (defcustom org-export-headline-levels 3
980 "The last level which is still exported as a headline.
981 Inferior levels will produce itemize lists when exported.
982 Note that a numeric prefix argument to an exporter function overrides
985 This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
989 (defcustom org-export-with-section-numbers t
990 "Non-nil means, add section numbers to headlines when exporting.
992 This option can also be set with the +OPTIONS line, e.g. \"num:t\"."
996 (defcustom org-export-with-toc t
997 "Non-nil means, create a table of contents in exported files.
998 The TOC contains headlines with levels up to`org-export-headline-levels'.
1000 Headlines which contain any TODO items will be marked with \"(*)\" in
1001 ASCII export, and with red color in HTML output.
1003 In HTML output, the TOC will be clickable.
1005 This option can also be set with the +OPTIONS line, e.g. \"toc:nil\"."
1009 (defcustom org-export-preserve-breaks nil
1010 "Non-nil means, preserve all line breaks when exporting.
1011 Normally, in HTML output paragraphs will be reformatted. In ASCII
1012 export, line breaks will always be preserved, regardless of this variable.
1014 This option can also be set with the +OPTIONS line, e.g. \"\\n:t\"."
1018 (defcustom org-export-html-inline-images t
1019 "Non-nil means, inline images into exported HTML pages.
1020 The link will still be to the original location of the image file.
1021 So if you are moving the page, lets say to your public HTML site,
1022 you will have to move the image and maybe change the link."
1026 (defcustom org-export-html-expand t
1027 "Non-nil means, for HTML export, treat @<...> as HTML tag.
1028 When nil, these tags will be exported as plain text and therefore
1029 not be interpreted by a browser.
1031 This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
1035 (defcustom org-export-with-fixed-width t
1036 "Non-nil means, lines starting with \":\" will be in fixed width font.
1037 This can be used to have preformatted text, fragments of code etc. For
1039 : ;; Some Lisp examples
1042 will be looking just like this in also HTML. In ASCII export, this option
1045 This option can also be set with the +OPTIONS line, e.g. \"::nil\"."
1049 (defcustom org-export-with-tables t
1050 "Non-nil means, lines starting with \"|\" define a table
1053 | Name | Address | Birthday |
1054 |-------------+----------+-----------|
1055 | Arthur Dent | England | 29.2.2100 |
1057 In ASCII export, this option has no effect.
1059 This option can also be set with the +OPTIONS line, e.g. \"|:nil\"."
1063 (defcustom org-export-html-table-tag
1064 "<table border=1 cellspacing=0 cellpadding=6>"
1065 "The HTML tag used to start a table.
1066 This must be a <table> tag, but you may change the options like
1067 borders and spacing."
1071 (defcustom org-export-with-emphasize t
1072 "Non-nil means, interprete *word*, /word/, and _word_ as emphasized text.
1073 If the export target supports emphasizing text, the word will be
1074 typeset in bold, italic, or underlined, respectively. Works only for
1075 single words, but you can say: I *really* *mean* *this*.
1076 In ASCII export, this option has no effect.
1078 This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
1082 (defcustom org-match-sexp-depth 3
1083 "Number of stacked braces for sub/superscript matching.
1084 This has to be set before loading org.el to be effective."
1088 ;; FIXME: Should () parens be removed as well in sub/superscripts?
1089 (defcustom org-export-with-sub-superscripts t
1090 "Non-nil means, interprete \"_\" and \"^\" for export.
1091 When this option is turned on, you can use TeX-like syntax for sub- and
1092 superscripts. Several characters after \"_\" or \"^\" will be
1093 considered as a single item - so grouping with {} is normally not
1094 needed. For example, the following things will be parsed as single
1095 sub- or superscripts.
1097 10^24 or 10^tau several digits will be considered 1 item
1098 10^-12 or 10^-tau a leading sign with digits or a word
1099 x^2-y^3 will be read as x^2 - y^3, because items are
1100 terminated by almost any nonword/nondigit char.
1101 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
1103 Still, ambiguity is possible - so when in doubt use {} to enclose the
1105 In ASCII export, this option has no effect.
1107 This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
1111 (defcustom org-export-with-TeX-macros t
1112 "Non-nil means, interprete simple TeX-like macros when exporting.
1113 For example, HTML export converts \\alpha to α and \\AA to Å.
1114 No only real TeX macros will work here, but the standard HTML entities
1115 for math can be used as macro names as well. For a list of supported
1116 names in HTML export, see the constant `org-html-entities'.
1117 In ASCII export, this option has no effect.
1119 This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
1123 (defcustom org-export-html-with-timestamp nil
1124 "Non-nil means, write `org-export-html-html-helper-timestamp'
1125 into the exported html text. Otherwise, the buffer will just be saved
1130 (defcustom org-export-html-html-helper-timestamp
1131 "<br><br><hr><p><!-- hhmts start --> <!-- hhmts end -->\n"
1132 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
1136 (defcustom org-export-ascii-show-new-buffer t
1137 "Non-nil means, popup buffer containing the exported ASCII text.
1138 Otherwise the buffer will just be saved to a file and stay hidden."
1142 (defcustom org-export-html-show-new-buffer nil
1143 "Non-nil means, popup buffer containing the exported html text.
1144 Otherwise, the buffer will just be saved to a file and stay hidden."
1149 (defgroup org-faces nil
1150 "Faces for highlighting in Org-mode."
1154 (defface org-level-1-face ;; font-lock-function-name-face
1155 '((((type tty) (class color)) (:foreground "blue" :weight bold))
1156 (((class color) (background light)) (:foreground "Blue"))
1157 (((class color) (background dark)) (:foreground "LightSkyBlue"))
1158 (t (:inverse-video t :bold t)))
1159 "Face used for level 1 headlines."
1162 (defface org-level-2-face ;; font-lock-variable-name-face
1163 '((((type tty) (class color)) (:foreground "yellow" :weight light))
1164 (((class color) (background light)) (:foreground "DarkGoldenrod"))
1165 (((class color) (background dark)) (:foreground "LightGoldenrod"))
1166 (t (:bold t :italic t)))
1167 "Face used for level 2 headlines."
1170 (defface org-level-3-face ;; font-lock-keyword-face
1171 '((((type tty) (class color)) (:foreground "cyan" :weight bold))
1172 (((class color) (background light)) (:foreground "Purple"))
1173 (((class color) (background dark)) (:foreground "Cyan"))
1175 "Face used for level 3 headlines."
1178 (defface org-level-4-face ;; font-lock-comment-face
1179 '((((type tty pc) (class color) (background light)) (:foreground "red"))
1180 (((type tty pc) (class color) (background dark)) (:foreground "red1"))
1181 (((class color) (background light)) (:foreground "Firebrick"))
1182 (((class color) (background dark)) (:foreground "chocolate1"))
1183 (t (:bold t :italic t)))
1184 "Face used for level 4 headlines."
1187 (defface org-level-5-face ;; font-lock-type-face
1188 '((((type tty) (class color)) (:foreground "green"))
1189 (((class color) (background light)) (:foreground "ForestGreen"))
1190 (((class color) (background dark)) (:foreground "PaleGreen"))
1191 (t (:bold t :underline t)))
1192 "Face used for level 5 headlines."
1195 (defface org-level-6-face ;; font-lock-constant-face
1196 '((((type tty) (class color)) (:foreground "magenta"))
1197 (((class color) (background light)) (:foreground "CadetBlue"))
1198 (((class color) (background dark)) (:foreground "Aquamarine"))
1199 (t (:bold t :underline t)))
1200 "Face used for level 6 headlines."
1203 (defface org-level-7-face ;; font-lock-builtin-face
1204 '((((type tty) (class color)) (:foreground "blue" :weight light))
1205 (((class color) (background light)) (:foreground "Orchid"))
1206 (((class color) (background dark)) (:foreground "LightSteelBlue"))
1208 "Face used for level 7 headlines."
1211 (defface org-level-8-face ;;font-lock-string-face
1212 '((((type tty) (class color)) (:foreground "green"))
1213 (((class color) (background light)) (:foreground "RosyBrown"))
1214 (((class color) (background dark)) (:foreground "LightSalmon"))
1216 "Face used for level 8 headlines."
1219 (defface org-warning-face ;; font-lock-warning-face
1220 '((((type tty) (class color)) (:foreground "red"))
1221 (((class color) (background light)) (:foreground "Red" :bold t))
1222 (((class color) (background dark)) (:foreground "Pink" :bold t))
1223 (t (:inverse-video t :bold t)))
1224 "Face for deadlines and TODO keyords."
1227 ;; Inheritance does not work for xemacs, unfortunately.
1228 ;; We just copy the definitions and waste some space....
1230 (defface org-deadline-announce-face
1231 '((((type tty) (class color)) (:foreground "blue" :weight bold))
1232 (((class color) (background light)) (:foreground "Blue"))
1233 (((class color) (background dark)) (:foreground "LightSkyBlue"))
1234 (t (:inverse-video t :bold t)))
1235 "Face for upcoming deadlines."
1238 (defface org-scheduled-today-face
1239 '((((type tty) (class color)) (:foreground "green"))
1240 (((class color) (background light)) (:foreground "DarkGreen"))
1241 (((class color) (background dark)) (:foreground "PaleGreen"))
1242 (t (:bold t :underline t)))
1243 "Face for items scheduled for a certain day."
1246 (defface org-scheduled-previously-face
1247 '((((type tty pc) (class color) (background light)) (:foreground "red"))
1248 (((type tty pc) (class color) (background dark)) (:foreground "red1"))
1249 (((class color) (background light)) (:foreground "Firebrick"))
1250 (((class color) (background dark)) (:foreground "chocolate1"))
1251 (t (:bold t :italic t)))
1252 "Face for items scheduled previously, and not yet done."
1255 (defface org-link-face
1256 '((((type tty) (class color)) (:foreground "cyan" :weight bold))
1257 (((class color) (background light)) (:foreground "Purple"))
1258 (((class color) (background dark)) (:foreground "Cyan"))
1263 (defface org-done-face ;; font-lock-type-face
1264 '((((type tty) (class color)) (:foreground "green"))
1265 (((class color) (background light)) (:foreground "ForestGreen" :bold t))
1266 (((class color) (background dark)) (:foreground "PaleGreen" :bold t))
1267 (t (:bold t :underline t)))
1268 "Face used for DONE."
1271 (defface org-table-face ;; font-lock-function-name-face
1272 '((((type tty) (class color)) (:foreground "blue" :weight bold))
1273 (((class color) (background light)) (:foreground "Blue"))
1274 (((class color) (background dark)) (:foreground "LightSkyBlue"))
1275 (t (:inverse-video t :bold t)))
1276 "Face used for tables."
1279 (defvar org-level-faces
1290 (defvar org-n-levels (length org-level-faces))
1293 ;; Tell the compiler about dynamically scoped variables,
1294 ;; and variables from other packages
1296 (defvar zmacs-regions)
1297 (defvar org-transient-mark-mode)
1298 (defvar org-html-entities)
1299 (defvar org-goto-start-pos)
1300 (defvar org-cursor-color)
1301 (defvar org-time-was-given)
1302 (defvar org-ts-what)
1304 (defvar levels-open)
1315 (defvar starting-day)
1316 (defvar include-all-loc)
1317 (defvar vm-message-pointer)
1318 (defvar vm-folder-directory)
1319 (defvar wl-summary-buffer-elmo-folder)
1320 (defvar wl-summary-buffer-folder-name)
1321 (defvar gnus-group-name)
1322 (defvar gnus-article-current)
1323 (defvar w3m-current-url)
1324 (defvar org-selected-point)
1325 (defvar calendar-mode-map)
1326 (defvar remember-save-after-remembering)
1327 (defvar remember-data-file))
1332 (defvar org-mode-map (copy-keymap outline-mode-map)
1333 "Keymap for Org-mode.")
1335 (defvar org-struct-menu)
1336 (defvar org-org-menu)
1339 (defun org-mode (&optional arg)
1340 "Outline-based notes management and organizer, alias
1341 \"Carstens outline-mode for keeping track of everything.\"
1343 Org-mode develops organizational tasks around a NOTES file which
1344 contains information about projects as plain text. Org-mode is
1345 implemented on top of outline-mode, which is ideal to keep the content
1346 of large files well structured. It supports ToDo items, deadlines and
1347 time stamps, which magically appear in the diary listing of the Emacs
1348 calendar. Tables are easily created with a built-in table editor.
1349 Plain text URL-like links connect to websites, emails (VM), Usenet
1350 messages (Gnus), BBDB entries, and any files related to the project.
1351 For printing and sharing of notes, an Org-mode file (or a part of it)
1352 can be exported as a well-structured ASCII or HTML file.
1354 + The following commands are available:
1359 (setq major-mode 'org-mode)
1360 (setq mode-name "Org")
1361 (use-local-map org-mode-map)
1362 (easy-menu-add org-org-menu)
1363 (org-install-agenda-files-menu)
1364 (setq outline-regexp "\\*+")
1365 (if org-startup-truncated (setq truncate-lines t))
1367 (set (make-local-variable 'font-lock-unfontify-region-function)
1368 'org-unfontify-region)
1369 ;; Activate before-change-function
1370 (add-hook 'before-change-functions 'org-before-change-function nil
1372 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
1373 (set (make-local-variable 'auto-fill-inhibit-regexp)
1375 (if (or org-enable-table-editor org-enable-fixed-width-editor)
1378 (if org-enable-table-editor "|" "")
1379 (if org-enable-fixed-width-editor ":" "")
1381 ;; Hook, and startup actions
1383 (and org-insert-mode-line-in-empty-file
1384 (= (point-min) (point-max))))
1386 (goto-char (point-min))
1387 (insert " -*- mode: org -*-\n\n")))
1388 (run-hooks 'org-mode-hook)
1389 (if org-startup-with-deadline-check
1390 (call-interactively 'org-check-deadlines)
1391 (if org-startup-folded (org-cycle t))))
1395 (defvar org-mouse-map (make-sparse-keymap))
1396 (define-key org-mouse-map
1397 (if org-xemacs-p [button2] [mouse-2]) 'org-open-at-mouse)
1398 (define-key org-mouse-map
1399 (if org-xemacs-p [button3] [mouse-3]) 'org-find-file-at-mouse)
1401 (require 'font-lock)
1403 (defconst org-link-regexp
1404 (if org-allow-space-in-links
1405 "\\(https?\\|ftp\\|mailto\\|file\\|news\\|bbdb\\|vm\\|wl\\|rmail\\|gnus\\|shell\\):\\([^\t\n\r]+[^ \t\n\r]\\)"
1406 "\\(https?\\|ftp\\|mailto\\|file\\|news\\|bbdb\\|vm\\|wl\\|rmail\\|gnus\\|shell\\):\\([^ \t\n\r]+\\)"
1408 "Regular expression for matching links.")
1409 (defconst org-ts-lengths
1410 (cons (length (format-time-string (car org-time-stamp-formats)))
1411 (length (format-time-string (cdr org-time-stamp-formats))))
1412 "This holds the lengths of the two different time formats.")
1413 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}[^\r\n>]*\\)>"
1414 "Regular expression for fast time stamp matching.")
1415 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
1416 "Regular expression matching time strings for analysis.")
1417 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 ">")
1418 "Regular expression matching time stamps, with groups.")
1419 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
1420 "Regular expression matching a time stamp range.")
1421 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
1422 org-ts-regexp "\\)?")
1423 "Regular expression matching a time stamp or time stamp range.")
1425 (defun org-activate-links (limit)
1426 "Run through the buffer and add overlays to links."
1427 (if (re-search-forward org-link-regexp limit t)
1429 (add-text-properties (match-beginning 0) (match-end 0)
1430 (list 'mouse-face 'highlight
1431 'keymap org-mouse-map))
1434 (defun org-activate-dates (limit)
1435 "Run through the buffer and add overlays to links."
1436 (if (re-search-forward org-tsr-regexp limit t)
1438 (add-text-properties (match-beginning 0) (match-end 0)
1439 (list 'mouse-face 'highlight
1440 'keymap org-mouse-map))
1444 (defun org-font-lock-level ()
1446 (org-back-to-heading t)
1447 (- (match-end 0) (match-beginning 0))))
1449 (defun org-set-font-lock-defaults ()
1450 (let ((org-font-lock-extra-keywords
1452 '(org-activate-links (0 'org-link-face))
1453 '(org-activate-dates (0 'org-link-face))
1454 (list (concat "^\\*+[ \t]*" org-not-done-regexp) '(1 'org-warning-face t))
1455 (list (concat "\\[#[A-Z]\\]") '(0 'org-warning-face t))
1456 (list (concat "\\<" org-deadline-string) '(0 'org-warning-face t))
1457 (list (concat "\\<" org-scheduled-string) '(0 'org-warning-face t))
1458 ;; '("\\(\\s-\\|^\\)\\(\\*\\([a-zA-Z]+\\)\\*\\)\\([^a-zA-Z*]\\|$\\)"
1460 ;; '("\\(\\s-\\|^\\)\\(/\\([a-zA-Z]+\\)/\\)\\([^a-zA-Z*]\\|$\\)"
1462 ;; '("\\(\\s-\\|^\\)\\(_\\([a-zA-Z]+\\)_\\)\\([^a-zA-Z*]\\|$\\)"
1464 '("\\<FIXME\\>" (0 'org-warning-face t))
1465 (list (concat "^\\*+[ \t]*\\<\\(" org-comment-string "\\)\\>")
1466 '(1 'org-warning-face t))
1467 '("^#.*" (0 'font-lock-comment-face t))
1468 (list (concat "^[*]+ +\\<\\(" org-done-string "\\)\\>")
1469 '(1 'org-done-face t))
1470 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
1471 (1 'org-table-face t))
1472 '("^[ \t]*\\(:.*\\)" (1 'org-table-face t)))))
1473 (set (make-local-variable 'org-font-lock-keywords)
1475 (if org-noutline-p ; FIXME: I am not sure if eval will work
1476 ; on XEmacs if noutline is ever ported
1477 '((eval . (list "^\\(\\*+\\).*"
1479 (% (- (match-end 1) (match-beginning 1) 1)
1483 '(("^\\(\\(\\*+\\)[^\r\n]*\\)[\n\r]"
1484 (1 (nth (% (- (match-end 2) (match-beginning 2) 1)
1488 org-font-lock-extra-keywords))
1489 (set (make-local-variable 'font-lock-defaults)
1490 '(org-font-lock-keywords t nil nil backward-paragraph))
1491 (kill-local-variable 'font-lock-keywords) nil))
1493 (defvar org-font-lock-keywords nil)
1495 (defun org-unfontify-region (beg end &optional maybe_loudly)
1496 "Remove fontification and activation overlays from links."
1497 (font-lock-default-unfontify-region beg end)
1498 (let* ((modified (buffer-modified-p)) ;; FIXME: Why did I add this???
1499 (buffer-undo-list t)
1500 (inhibit-read-only t) (inhibit-point-motion-hooks t)
1501 (inhibit-modification-hooks t)
1502 deactivate-mark buffer-file-name buffer-file-truename)
1503 (remove-text-properties beg end '(mouse-face nil keymap nil))))
1505 ;;; Visibility cycling
1507 (defvar org-cycle-global-status nil)
1508 (defvar org-cycle-subtree-status nil)
1509 (defun org-cycle (&optional arg)
1510 "Visibility cycling for outline(-minor)-mode.
1512 - When this function is called with a prefix argument, rotate the entire
1513 buffer through 3 states (global cycling)
1514 1. OVERVIEW: Show only top-level headlines.
1515 2. CONTENTS: Show all headlines of all levels, but no body text.
1516 3. SHOW ALL: Show everything.
1518 - When point is at the beginning of a headline, rotate the subtree started
1519 by this line through 3 different states (local cycling)
1520 1. FOLDED: Only the main headline is shown.
1521 2. CHILDREN: The main headline and the direct children are shown. From
1522 this state, you can move to one of the children and
1524 3. SUBTREE: Show the entire subtree, including body text.
1526 - When point is not at the beginning of a headline, execute
1527 `indent-relative', like TAB normally does. See the option
1528 `org-cycle-emulate-tab' for details.
1530 - Special case: if point is the the beginning of the buffer and there is
1531 no headline in line 1, this function will act as if called with prefix arg."
1534 (if (and (bobp) (not (looking-at outline-regexp)))
1535 ; special case: use global cycling
1540 ((org-at-table-p 'any)
1541 ;; Enter the table or move to the next field in the table
1542 (or (org-table-recognize-table.el)
1543 (org-table-next-field)))
1545 (arg ;; Global cycling
1548 ((and (eq last-command this-command)
1549 (eq org-cycle-global-status 'overview))
1550 ;; We just created the overview - now do table of contents
1551 ;; This can be slow in very large buffers, so indicate action
1552 (message "CONTENTS...")
1554 ;; Visit all headings and show their offspring
1555 (goto-char (point-max))
1557 (while (and (progn (condition-case nil
1558 (outline-previous-visible-heading 1)
1559 (error (goto-char (point-min))))
1561 (looking-at outline-regexp))
1563 (if (bobp) (throw 'exit nil))))
1564 (message "CONTENTS...done"))
1565 (setq org-cycle-global-status 'contents))
1566 ((and (eq last-command this-command)
1567 (eq org-cycle-global-status 'contents))
1568 ;; We just showed the table of contents - now show everything
1570 (message "SHOW ALL")
1571 (setq org-cycle-global-status 'all))
1573 ;; Default action: go to overview
1575 (message "OVERVIEW")
1576 (setq org-cycle-global-status 'overview))))
1578 ((save-excursion (beginning-of-line 1) (looking-at outline-regexp))
1579 ;; At a heading: rotate between three different views
1580 (org-back-to-heading)
1581 (let ((goal-column 0) beg eoh eol eos nxh)
1582 ;; First, some boundaries
1584 (org-back-to-heading) (setq beg (point))
1586 (beginning-of-line 2)
1587 (while (and (not (eobp)) ;; this is like `next-line'
1588 (get-char-property (1- (point)) 'invisible))
1589 (beginning-of-line 2)) (setq eol (point)))
1590 (outline-end-of-heading) (setq eoh (point))
1591 (outline-end-of-subtree) (setq eos (point))
1592 (outline-next-heading) (setq nxh (point)))
1593 ;; Find out what to do next and set `this-command'
1596 ;; Nothing is hidden behind this heading
1597 (message "EMPTY ENTRY")
1598 (setq org-cycle-subtree-status nil))
1600 ;; Entire subtree is hidden in one line: open it
1603 (message "CHILDREN")
1604 (setq org-cycle-subtree-status 'children))
1605 ((and (eq last-command this-command)
1606 (eq org-cycle-subtree-status 'children))
1607 ;; We just showed the children, now show everything.
1610 (setq org-cycle-subtree-status 'subtree))
1612 ;; Default action: hide the subtree.
1615 (setq org-cycle-subtree-status 'folded)))))
1618 (buffer-read-only (org-back-to-heading))
1619 ((if (and (eq org-cycle-emulate-tab 'white)
1620 (save-excursion (beginning-of-line 1) (looking-at "[ \t]+$")))
1622 (eq org-cycle-emulate-tab t))
1623 (if (and (looking-at "[ \n\r\t]")
1624 (string-match "^[ \t]*$" (buffer-substring
1625 (point-at-bol) (point))))
1627 (beginning-of-line 1)
1628 (and (looking-at "[ \t]+") (replace-match ""))))
1632 (org-back-to-heading)
1635 (defvar org-goto-window-configuration nil)
1636 (defvar org-goto-marker nil)
1637 (defvar org-goto-map (make-sparse-keymap))
1638 (let ((cmds '(isearch-forward isearch-backward)) cmd)
1639 (while (setq cmd (pop cmds))
1640 (substitute-key-definition cmd cmd org-goto-map global-map)))
1641 (define-key org-goto-map [(return)] 'org-goto-ret)
1642 (define-key org-goto-map [(left)] 'org-goto-left)
1643 (define-key org-goto-map [(right)] 'org-goto-right)
1644 (define-key org-goto-map [(?q)] 'org-goto-quit)
1645 (define-key org-goto-map [(control ?g)] 'org-goto-quit)
1646 (define-key org-goto-map [(tab)] 'org-cycle)
1647 (define-key org-goto-map [(down)] 'outline-next-visible-heading)
1648 (define-key org-goto-map [(up)] 'outline-previous-visible-heading)
1649 (define-key org-goto-map "n" 'outline-next-visible-heading)
1650 (define-key org-goto-map "p" 'outline-previous-visible-heading)
1651 (define-key org-goto-map "f" 'outline-forward-same-level)
1652 (define-key org-goto-map "b" 'outline-backward-same-level)
1653 (define-key org-goto-map "u" 'outline-up-heading)
1654 (define-key org-goto-map "\C-c\C-n" 'outline-next-visible-heading)
1655 (define-key org-goto-map "\C-c\C-p" 'outline-previous-visible-heading)
1656 (define-key org-goto-map "\C-c\C-f" 'outline-forward-same-level)
1657 (define-key org-goto-map "\C-c\C-b" 'outline-backward-same-level)
1658 (define-key org-goto-map "\C-c\C-u" 'outline-up-heading)
1659 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
1660 (while l (define-key org-goto-map (int-to-string (pop l)) 'digit-argument)))
1662 (defconst org-goto-help
1663 "Select a location to jump to, press RET
1664 \[Up]/[Down]=next/prev headline TAB=cycle visibility RET=select [Q]uit")
1667 "Go to a different location of the document, keeping current visibility.
1669 When you want to go to a different location in a document, the fastest way
1670 is often to fold the entire buffer and then dive into the tree. This
1671 method has the disadvantage, than the previous location will be folded, and
1672 that can be unwanted.
1674 This command works around this by showing a copy of the current buffer in
1675 overview mode. You can dive into the tree in that copy, to find the
1676 location you want to reach. When pressing RET, the command returns to the
1677 original buffer in which the visibility is still unchanged. It then jumps
1678 to the new location, making it and the headline hierarchy above it visible."
1680 (let* ((org-goto-start-pos (point))
1682 (org-get-location (current-buffer) org-goto-help)))
1685 (goto-char selected-point)
1686 (if (org-invisible-p) (org-show-hierarchy-above)))
1689 (defun org-get-location (buf help)
1690 "Let the user select a location in the Org-mode buffer BUF.
1691 This function uses a recursive edit. It returns the selected position
1693 (let (org-selected-point)
1695 (save-window-excursion
1696 (delete-other-windows)
1697 (switch-to-buffer (get-buffer-create "*org-goto*"))
1698 (with-output-to-temp-buffer "*Help*"
1700 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
1701 (setq buffer-read-only nil)
1704 (let ((org-startup-truncated t)
1705 (org-startup-folded t)
1706 (org-startup-with-deadline-check nil))
1708 (setq buffer-read-only t)
1709 (if (boundp 'org-goto-start-pos)
1710 (goto-char org-goto-start-pos)
1711 (goto-char (point-min)))
1712 (org-beginning-of-line)
1713 (message "Select location and press RET")
1714 ;; now we make sure that during selection, ony very few keys work
1715 ;; and that it is impossible to switch to another window.
1716 (let ((gm (current-global-map))
1717 (overriding-local-map org-goto-map))
1720 (use-global-map org-goto-map)
1722 (use-global-map gm)))))
1723 (kill-buffer "*org-goto*")
1724 org-selected-point))
1726 ;; FIXME: It may not be a good idea to temper with the prefix argument...
1727 (defun org-goto-ret (&optional arg)
1728 "Finish org-goto by going to the new location."
1730 (setq org-selected-point (point)
1731 current-prefix-arg arg)
1734 (defun org-goto-left (&optional arg)
1735 "Finish org-goto by going to the new location."
1737 (if (org-on-heading-p)
1739 (beginning-of-line 1)
1740 (setq org-selected-point (point)
1741 current-prefix-arg (- (match-end 0) (match-beginning 0)))
1743 (error "Not on a heading")))
1745 (defun org-goto-right (&optional arg)
1746 "Finish org-goto by going to the new location."
1748 (if (org-on-heading-p)
1750 (outline-end-of-subtree)
1751 (or (eobp) (forward-char 1))
1752 (setq org-selected-point (point)
1753 current-prefix-arg (- (match-end 0) (match-beginning 0)))
1755 (error "Not on a heading")))
1757 (defun org-goto-quit ()
1758 "Finish org-goto without cursor motion."
1760 (setq org-selected-point nil)
1763 ;;; Promotion, Demotion, Inserting new headlines
1765 (defvar org-ignore-region nil
1766 "To temporary disable the active region.")
1768 (defun org-insert-heading ()
1769 "Insert a new heading with same depth at point."
1771 (let* ((head (save-excursion
1773 (org-back-to-heading)
1774 (error (outline-next-heading)))
1775 (prog1 (match-string 0)
1776 (funcall outline-level)))))
1777 (unless (bolp) (newline))
1780 (save-excursion (newline-and-indent)))
1781 (unless (equal (char-before) ?\ )
1783 (run-hooks 'org-insert-heading-hook)))
1785 (defun org-promote-subtree (&optional arg)
1786 "Promote the entire subtree.
1787 See also `org-promote'."
1789 (org-map-tree 'org-promote))
1791 (defun org-demote-subtree (&optional arg)
1792 "Demote the entire subtree. See `org-demote'.
1793 See also `org-promote'."
1795 (org-map-tree 'org-demote))
1797 (defun org-do-promote (&optional arg)
1798 "Promote the current heading higher up the tree.
1799 If the region is active in transient-mark-mode, promote all headings
1803 (if (org-region-active-p)
1804 (org-map-region 'org-promote (region-beginning) (region-end))
1806 (org-fix-position-after-promote))
1808 (defun org-do-demote (&optional arg)
1809 "Demote the current heading lower down the tree.
1810 If the region is active in transient-mark-mode, demote all headings
1814 (if (org-region-active-p)
1815 (org-map-region 'org-demote (region-beginning) (region-end))
1817 (org-fix-position-after-promote))
1819 (defun org-fix-position-after-promote ()
1820 "Make sure that after pro/demotion cursor position is right."
1821 (and (equal (char-after) ?\ )
1822 (equal (char-before) ?*)
1825 (defun org-promote ()
1826 "Promote the current heading higher up the tree.
1827 If the region is active in transient-mark-mode, promote all headings
1829 (org-back-to-heading t)
1830 (let* ((level (save-match-data (funcall outline-level)))
1831 (up-head (make-string (1- level) ?*)))
1832 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover."))
1833 (replace-match up-head nil t)
1834 (if org-adapt-indentation
1835 (org-fixup-indentation "^ " "" "^ ?\\S-"))))
1837 (defun org-demote ()
1838 "Demote the current heading lower down the tree.
1839 If the region is active in transient-mark-mode, demote all headings
1841 (org-back-to-heading t)
1842 (let* ((level (save-match-data (funcall outline-level)))
1843 (down-head (make-string (1+ level) ?*)))
1844 (replace-match down-head nil t)
1845 (if org-adapt-indentation
1846 (org-fixup-indentation "^ " " " "^\\S-"))))
1848 (defun org-map-tree (fun)
1849 "Call FUN for every heading underneath the current one."
1850 (org-back-to-heading)
1851 (let ((level (outline-level)))
1855 (outline-next-heading)
1856 (> (funcall outline-level) level))
1860 (defun org-map-region (fun beg end)
1861 "Call FUN for every heading between BEG and END."
1862 (let ((org-ignore-region t))
1864 (setq end (copy-marker end))
1866 ;; (if (fboundp 'deactivate-mark) (deactivate-mark))
1867 ;; (if (fboundp 'zmacs-deactivate-region) (zmacs-deactivate-region))
1868 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
1872 (outline-next-heading)
1877 (defun org-fixup-indentation (from to prohibit)
1878 "Change the indentation in the current entry by re-replacing FROM with TO.
1879 However, if the regexp PROHIBIT matches at all, don't do anything.
1880 This is being used to change indentation along with the length of the
1881 heading marker. But if there are any lines which are not indented, nothing
1884 (let ((end (save-excursion (outline-next-heading)
1886 (unless (save-excursion (re-search-forward prohibit end t))
1887 (while (re-search-forward from end t)
1889 (beginning-of-line 2)))
1890 (move-marker end nil))))
1892 ;;; Vertical tree motion, cutting and pasting of subtrees
1894 (defun org-move-subtree-up (&optional arg)
1895 "Move the current subtree up past ARG headlines of the same level."
1897 (org-move-subtree-down (- (prefix-numeric-value arg))))
1899 (defun org-move-subtree-down (&optional arg)
1900 "Move the current subtree down past ARG headlines of the same level."
1902 (setq arg (prefix-numeric-value arg))
1903 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
1904 'outline-get-last-sibling))
1905 (ins-point (make-marker))
1909 (org-back-to-heading)
1912 (save-excursion (outline-end-of-heading)
1913 (setq folded (org-invisible-p)))
1914 (outline-end-of-subtree))
1915 (if (equal (char-after) ?\n) (forward-char 1))
1917 ;; Find insertion point, with error handling
1920 (or (and (funcall movfunc) (looking-at outline-regexp))
1921 (progn (goto-char beg)
1922 (error "Cannot move past superior level or buffer limit")))
1923 (setq cnt (1- cnt)))
1925 ;; Moving forward - still need to move over subtree
1926 (progn (outline-end-of-subtree)
1927 (if (equal (char-after) ?\n) (forward-char 1))))
1928 (move-marker ins-point (point))
1929 (setq txt (buffer-substring beg end))
1930 (delete-region beg end)
1932 (goto-char ins-point)
1933 (if folded (hide-subtree))
1934 (move-marker ins-point nil)))
1936 (defvar org-subtree-clip ""
1937 "Clipboard for cut and paste of subtrees.
1938 This is actually only a cpoy of the kill, because we use the normal kill
1939 ring. We need it to check if the kill was created by `org-copy-subtree'.")
1941 (defvar org-subtree-clip-folded nil
1942 "Was the last copied suptree folded?
1943 This is used to fold the tree back after pasting.")
1945 (defun org-cut-subtree (&optional arg)
1946 "Cut the current subtree into the clipboard.
1947 This is a short-hand for marking the subtree and then cutting it."
1949 (org-copy-subtree arg 'cut))
1951 (defun org-copy-subtree (&optional arg cut)
1952 "Cut the current subtree into the clipboard.
1953 This is a short-hand for marking the subtree and then copying it.
1954 If CUT is non nil, actually cur the subtree."
1956 (let (beg end folded)
1957 (org-back-to-heading)
1960 (save-excursion (outline-end-of-heading)
1961 (setq folded (org-invisible-p)))
1962 (outline-end-of-subtree))
1963 (if (equal (char-after) ?\n) (forward-char 1))
1967 (setq org-subtree-clip-folded folded)
1968 (if cut (kill-region beg end) (copy-region-as-kill beg end))
1969 (setq org-subtree-clip (current-kill 0))
1970 (message "%s: Subtree with %d characters"
1971 (if cut "Cut" "Copied")
1972 (length org-subtree-clip)))))
1974 (defun org-paste-subtree (&optional level tree)
1975 "Paste the clipboard as a subtree, with modification of headline level.
1976 The entire subtree is promoted or demoted in order to match a new headline
1977 level. By default, the new level is derived from the visible headings
1978 before and after the insertion point, and taken to be the inferior headline
1979 level of the two. So if the previous visible heading is level 3 and the
1980 next is level 4 (or vice versa), level 4 will be used for insertion.
1981 This makes sure that the subtree remains an independent subtree and does
1982 not swallow low level entries.
1984 You can also force a different level, either by using a numeric prefix
1985 argument, or by inserting the heading marker by hand. For example, if the
1986 cursor is after \"*****\", then the tree will be shifted to level 5.
1988 If you want to insert the tree as is, just use \\[yank].
1990 If optional TREE is given, use this text instead of the kill ring."
1992 (unless (org-kill-is-subtree-p tree)
1994 (substitute-command-keys
1995 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
1996 (let* ((txt (or tree (current-kill 0)))
1997 (^re (concat "^\\(" outline-regexp "\\)"))
1998 (re (concat "\\(" outline-regexp "\\)"))
1999 (^re_ (concat "\\(" outline-regexp "\\)[ \t]*"))
2001 (old-level (if (string-match ^re txt)
2002 (- (match-end 0) (match-beginning 0))
2004 (force-level (cond (level (prefix-numeric-value level))
2006 ^re_ (buffer-substring (point-at-bol) (point)))
2007 (- (match-end 0) (match-beginning 0)))
2009 (prevous-level (save-excursion
2010 (outline-previous-visible-heading 1)
2012 (- (match-end 0) (match-beginning 0))
2014 (next-level (save-excursion
2015 (outline-next-visible-heading 1)
2017 (- (match-end 0) (match-beginning 0))
2019 (new-level (or force-level (max prevous-level next-level)))
2020 (shift (if (or (= old-level -1)
2022 (= old-level new-level))
2024 (- new-level old-level)))
2026 (delta (if (> shift 0) -1 1))
2027 (func (if (> shift 0) 'org-demote 'org-promote))
2029 ;; Remove the forces level indicator
2031 (delete-region (point-at-bol) (point)))
2032 ;; Make sure we start at the beginning of an empty line
2033 (if (not (bolp)) (insert "\n"))
2034 (if (not (looking-at "[ \t]*$"))
2035 (progn (insert "\n") (backward-char 1)))
2041 ;; Shift if necessary
2043 (message "Pasted at level %d, without shift" new-level)
2045 (narrow-to-region beg end)
2046 (while (not (= shift 0))
2047 (org-map-region func (point-min) (point-max))
2048 (setq shift (+ delta shift)))
2049 (goto-char (point-min))
2050 (message "Pasted at level %d, with shift by %d levels"
2052 (if (and (eq org-subtree-clip (current-kill 0))
2053 org-subtree-clip-folded)
2054 ;; The tree was folded before it was killed/copied
2057 (defun org-kill-is-subtree-p (&optional txt)
2058 "Check if the current kill is an outline subtree, or a set of trees.
2059 Returns nil if kill does not start with a headline, or if the first
2060 headline level is not the largest headline level in the tree.
2061 So this will actually acceept several entries of equal levels as well,
2062 which is OK for `org-paste-subtree'.
2063 If optional TXT is given, check this string instead of the current kill."
2064 (let* ((kill (or txt (current-kill 0) ""))
2065 (start-level (and (string-match (concat "\\`" outline-regexp) kill)
2066 (- (match-end 0) (match-beginning 0))))
2067 (re (concat "^" outline-regexp))
2069 (if (not start-level)
2070 nil ;; does not even start with a heading
2072 (while (setq start (string-match re kill (1+ start)))
2073 (if (< (- (match-end 0) (match-beginning 0)) start-level)
2079 (defun org-complete (&optional arg)
2080 "Perform completion on word at point.
2081 At the beginning of a headline, this completes TODO keywords as given in
2082 `org-todo-keywords'.
2083 If the current word is preceeded by a backslash, completes the TeX symbols
2084 that are supported for HTML support.
2085 If the current word is preceeded by \"#+\", completes special words for
2086 setting file options.
2087 At all other locations, this simply calls `ispell-complete-word'."
2090 (let* ((end (point))
2091 (beg (save-excursion
2092 (if (equal (char-before (point)) ?\ ) (backward-char 1))
2093 (skip-chars-backward "a-zA-Z0-9_:")
2095 (texp (equal (char-before beg) ?\\))
2096 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
2099 (pattern (buffer-substring-no-properties beg end))
2100 (completion-ignore-case opt)
2106 (string-match "^#\\+\\(\\([A-Z_]+:?\\).*\\)" x)
2107 (cons (match-string 2 x) (match-string 1 x)))
2108 (org-split-string (org-get-current-options) "\n")))
2112 ((string-match "\\`\\*+[ \t]*\\'"
2113 (buffer-substring (point-at-bol) beg))
2115 (mapcar 'list org-todo-keywords))
2116 (t (progn (ispell-complete-word arg) (throw 'exit nil)))))
2117 (completion (try-completion pattern table)))
2118 (cond ((eq completion t)
2119 (if (equal type :opt)
2120 (insert (substring (cdr (assoc (upcase pattern) table))
2121 (length pattern)))))
2123 (message "Can't find completion for \"%s\"" pattern)
2125 ((not (string= pattern completion))
2126 (delete-region beg end)
2127 (if (string-match " +$" completion)
2128 (setq completion (replace-match "" t t completion)))
2130 (if (get-buffer-window "*Completions*")
2131 (delete-window (get-buffer-window "*Completions*")))
2132 (if (and (eq type :todo)
2133 (assoc completion table))
2135 (if (and (equal type :opt) (assoc completion table))
2136 (message (substitute-command-keys
2137 "Press \\[org-complete] again to insert example settings"))))
2139 (message "Making completion list...")
2140 (let ((list (sort (all-completions pattern table) 'string<)))
2141 (with-output-to-temp-buffer "*Completions*"
2142 (display-completion-list list)))
2143 (message "Making completion list...%s" "done"))))))
2145 ;;; Comments, TODO and DEADLINE
2147 (defun org-toggle-comment ()
2148 "Change the COMMENT state of an entry."
2151 (org-back-to-heading)
2152 (if (looking-at (concat outline-regexp
2153 "\\( +\\<" org-comment-string "\\>\\)"))
2154 (replace-match "" t t nil 1)
2155 (if (looking-at outline-regexp)
2157 (goto-char (match-end 0))
2158 (insert " " org-comment-string))))))
2160 (defun org-todo (&optional arg)
2161 "Change the TODO state of an item.
2162 The state of an item is given by a keyword at the start of the heading,
2164 *** TODO Write paper
2167 The different keywords are specified in the variable `org-todo-keywords'. By
2168 default the available states are \"TODO\" and \"DONE\".
2169 So for this example: when the item starts with TODO, it is changed to DONE.
2170 When it starts with DONE, the DONE is removed. And when neither TODO nor
2171 DONE are present, add TODO at the beginning of the heading.
2173 With prefix arg, use completion to determined the new state. With numeric
2174 prefix arg, switch to that state."
2177 (org-back-to-heading)
2178 (if (looking-at outline-regexp) (goto-char (match-end 0)))
2179 (or (looking-at (concat " +" org-todo-regexp " *"))
2181 (let* ((this (match-string 1))
2182 (completion-ignore-case t)
2183 (member (member this org-todo-keywords))
2187 ;; Read a state with completion
2188 (completing-read "State: " (mapcar (lambda(x) (list x))
2192 ;; user requests a specific state
2193 (nth (1- (prefix-numeric-value arg))
2195 ((null member) (car org-todo-keywords))
2196 ((null tail) nil) ;; -> first entry
2197 ((eq org-todo-interpretation 'sequence)
2199 ((memq org-todo-interpretation '(type priority))
2200 (if (eq this-command last-command)
2202 (if (> (length tail) 0) org-done-string nil)))
2204 (next (if state (concat " " state " ") " ")))
2205 (replace-match next t t)
2206 (run-hooks 'org-after-todo-state-change-hook)))
2207 ;; Fixup cursor location if close to the keyword
2208 (if (and (outline-on-heading-p)
2210 (save-excursion (goto-char (point-at-bol))
2211 (looking-at org-todo-line-regexp))
2212 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
2214 (goto-char (or (match-end 2) (match-end 1)))
2217 (defun org-show-todo-tree (arg)
2218 "Make a compact tree which shows all headlines marked with TODO.
2219 The tree will show the lines where the regexp matches, and all higher
2220 headlines above the match."
2222 (let ((case-fold-search nil)
2223 (kwd-re (if arg org-todo-regexp org-not-done-regexp)))
2224 (message "%d TODO entries found"
2225 (org-occur (concat "^" outline-regexp " +" kwd-re )))))
2227 (defun org-deadline ()
2228 "Insert the DEADLINE: string to make a deadline.
2229 A timestamp is also inserted - use \\[org-timestamp-up] and \\[org-timestamp-down]
2230 to modify it to the correct date."
2233 org-deadline-string " "
2234 (format-time-string (car org-time-stamp-formats)
2235 (org-read-date nil 'to-time)))
2236 (message (substitute-command-keys
2237 "Use \\[org-timestamp-up-day] and \\[org-timestamp-down-day] to change the date.")))
2239 (defun org-schedule ()
2240 "Insert the SCHEDULED: string to schedule a TODO item.
2241 A timestamp is also inserted - use \\[org-timestamp-up] and \\[org-timestamp-down]
2242 to modify it to the correct date."
2245 org-scheduled-string " "
2246 (format-time-string (car org-time-stamp-formats)
2247 (org-read-date nil 'to-time)))
2248 (message (substitute-command-keys
2249 "Use \\[org-timestamp-up-day] and \\[org-timestamp-down-day] to change the date.")))
2252 (defun org-occur (regexp &optional callback)
2253 "Make a compact tree which shows all matches of REGEXP.
2254 The tree will show the lines where the regexp matches, and all higher
2255 headlines above the match. It will also show the heading after the match,
2256 to make sure editing the matching entry is easy.
2257 if CALLBACK is non-nil, it is a function which is called to confirm
2258 that the match should indeed be shown."
2259 (interactive "sRegexp: ")
2260 (setq regexp (org-check-occur-regexp regexp))
2263 (goto-char (point-min))
2265 (while (re-search-forward regexp nil t)
2266 (when (or (not callback)
2269 (org-show-hierarchy-above))))
2271 (message "%d match(es) for regexp %s" cnt regexp))
2275 (defun org-show-hierarchy-above ()
2276 "Make sure point and the headings hierarchy above is visible."
2277 (if (org-on-heading-p t)
2278 (org-flag-heading nil) ; only show the heading
2279 (org-show-hidden-entry)) ; show entire entry
2281 (and (outline-next-heading)
2282 (org-flag-heading nil))) ; show the next heading
2283 (save-excursion ; show all higher headings
2284 (while (condition-case nil
2285 (progn (org-up-heading-all 1) t)
2287 (org-flag-heading nil))))
2291 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z]\\)\\] ?\\)"
2292 "Regular expression matching the priority indicator.")
2294 (defun org-priority-up ()
2295 "Increase the priority of the current item."
2299 (defun org-priority-down ()
2300 "Decrease the priority of the current item."
2302 (org-priority 'down))
2304 (defun org-priority (&optional action)
2305 "Change the priority of an item by ARG.
2306 ACTION can be set, up, or down."
2308 (setq action (or action 'set))
2309 (let (current new news have remove)
2311 (org-back-to-heading)
2312 (if (looking-at org-priority-regexp)
2313 (setq current (string-to-char (match-string 2))
2315 (setq current org-default-priority))
2318 (message (format "Priority A-%c, SPC to remove: " org-lowest-priority))
2319 (setq new (read-char-exclusive))
2320 (if (equal new ?\ ) (setq remove t)))
2322 (setq new (1- current)))
2324 (setq new (1+ current)))
2325 (t (error "Illegal ection")))
2326 (setq new (min (max ?A (upcase new)) org-lowest-priority))
2327 (setq news (format "%c" new))
2330 (replace-match "" t t nil 1)
2331 (replace-match news t t nil 2))
2332 (looking-at org-todo-line-regexp)
2335 (goto-char (match-end 2))
2336 (insert " [#" news "]"))
2337 (goto-char (match-beginning 3))
2338 (insert "[#" news "] "))))
2340 (message "Priority removed")
2341 (message "Priority of current item set to %s" news))))
2344 (defun org-get-priority (s)
2345 "Find priority cookie and return priority."
2347 (if (not (string-match org-priority-regexp s))
2348 (* 1000 (- org-lowest-priority org-default-priority))
2349 (* 1000 (- org-lowest-priority
2350 (string-to-char (match-string 2 s)))))))
2354 (defvar org-last-changed-timestamp nil)
2356 (defun org-time-stamp (arg)
2357 "Prompt for a date/time and insert a time stamp.
2358 If the user specifies a time like HH:MM, or if this command is called
2359 with a prefix argument, the time stamp will contain date and time.
2360 Otherwise, only the date will be included. All parts of a date not
2361 specified by the user will be filled in from the current date/time.
2362 So if you press just return without typing anything, the time stamp
2363 will represent the current date/time. If there is already a timestamp
2364 at the cursoe, it will be modified."
2366 (let ((fmt (if arg (cdr org-time-stamp-formats)
2367 (car org-time-stamp-formats)))
2368 (org-time-was-given nil)
2371 ((and (org-at-timestamp-p)
2372 (eq last-command 'org-time-stamp)
2373 (eq this-command 'org-time-stamp))
2375 (setq time (let ((this-command this-command))
2376 (org-read-date arg 'totime)))
2377 (if org-time-was-given (setq fmt (cdr org-time-stamp-formats)))
2378 (insert (format-time-string fmt time)))
2379 ((org-at-timestamp-p)
2380 (setq time (let ((this-command this-command))
2381 (org-read-date arg 'totime)))
2382 (and (org-at-timestamp-p) (replace-match
2383 (setq org-last-changed-timestamp
2384 (format-time-string fmt time))
2386 (message "Timestamp updated"))
2388 (setq time (let ((this-command this-command))
2389 (org-read-date arg 'totime)))
2390 (if org-time-was-given (setq fmt (cdr org-time-stamp-formats)))
2391 (insert (format-time-string fmt time))))))
2393 ;;; FIXME: Make the function take "Fri" as "next friday"
2394 (defun org-read-date (&optional with-time to-time)
2395 "Read a date and make things smooth for the user.
2396 The prompt will suggest to enter an ISO date, but you can also enter anything
2397 which will at least partially be understood by `parse-time-string'.
2398 Unrecognized parts of the date will default to the current day, month ,year,
2399 hour and minute. For example,
2400 3-2-5 --> 2003-02-05
2401 feb 15 --> currentyear-02-15
2402 sep 12 9 --> 2009-09-12
2403 12:45 --> today 12:45
2404 22 sept 0:34 --> currentyear-09-22 0:34
2405 12 --> currentyear-currentmonth-12
2407 The function understands only English month and weekday abbreviations,
2408 but this can be configured with the variables `parse-time-months' and
2409 `parse-time-weekdays'.
2411 While prompting, a calendar is popped up - you can also select the
2412 date with the mouse (button 1). The calendar shows a period of three
2413 month. To scroll it to other months, use the keys `>' and `<'.
2414 If you don't like the calendar, turn it off with
2415 \(setq org-popup-calendar-for-date-prompt nil).
2417 With optional argument TO-TIME, the date will immediately be converted
2418 to an internal time.
2419 With an optional argument WITH-TIME, the prompt will suggest to also
2420 insert a time. Note that when WITH-TIME is not set, you can still
2421 enter a time, and this function will inform the calling routine about
2422 this change. The calling routine may then choose to change the format
2423 used to insert the time stamp into the buffer to include the time."
2424 (let* ((default-time
2425 ;; Default time is either today, or, when entering a range,
2429 (concat org-ts-regexp "--\\=")
2433 (mapcar (lambda(x) (or x 0)) ;; FIXME: Problem with timezone?
2434 (parse-time-string (match-string 1))))
2436 (timestr (format-time-string
2437 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") default-time))
2438 (prompt (format "YYYY-MM-DD [%s]: " timestr))
2440 second minute hour day month year tl)
2442 (if org-popup-calendar-for-date-prompt
2443 ;; Also show a calendar for date selection
2444 ;; Copied (with modifications) from planner.el by John Wiegley
2446 (save-window-excursion
2448 (calendar-forward-day (- (time-to-days default-time)
2449 (calendar-absolute-from-gregorian
2450 (calendar-current-date))))
2451 (let* ((old-map (current-local-map))
2452 (map (copy-keymap calendar-mode-map))
2453 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
2454 (define-key map (kbd "RET") 'org-calendar-select)
2455 (define-key map (if org-xemacs-p [button1] [mouse-1])
2456 'org-calendar-select)
2457 (define-key minibuffer-local-map [(meta shift left)]
2458 (lambda () (interactive)
2459 (org-eval-in-calendar '(calendar-backward-month 1))))
2460 (define-key minibuffer-local-map [(meta shift right)]
2461 (lambda () (interactive)
2462 (org-eval-in-calendar '(calendar-forward-month 1))))
2463 (define-key minibuffer-local-map [(shift up)]
2464 (lambda () (interactive)
2465 (org-eval-in-calendar '(calendar-backward-week 1))))
2466 (define-key minibuffer-local-map [(shift down)]
2467 (lambda () (interactive)
2468 (org-eval-in-calendar '(calendar-forward-week 1))))
2469 (define-key minibuffer-local-map [(shift left)]
2470 (lambda () (interactive)
2471 (org-eval-in-calendar '(calendar-backward-day 1))))
2472 (define-key minibuffer-local-map [(shift right)]
2473 (lambda () (interactive)
2474 (org-eval-in-calendar '(calendar-forward-day 1))))
2475 (define-key minibuffer-local-map ">"
2476 (lambda () (interactive)
2477 (org-eval-in-calendar '(scroll-calendar-left 1))))
2478 (define-key minibuffer-local-map "<"
2479 (lambda () (interactive)
2480 (org-eval-in-calendar '(scroll-calendar-right 1))))
2484 (setq ans (read-string prompt "" nil nil))
2485 (setq ans (or ans1 ans2 ans)))
2486 (use-local-map old-map)))))
2487 ;; Naked prompt only
2488 (setq ans (read-string prompt "" nil timestr)))
2491 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
2493 (setq year (if (match-end 2)
2494 (string-to-number (match-string 2 ans))
2495 (string-to-number (format-time-string "%Y")))
2496 month (string-to-number (match-string 3 ans))
2497 day (string-to-number (match-string 4 ans)))
2498 (if (< year 100) (setq year (+ 2000 year)))
2499 (setq ans (replace-match (format "%04d-%02d-%02d" year month day)
2501 (setq tl (parse-time-string ans)
2502 year (or (nth 5 tl) (string-to-number (format-time-string "%Y")))
2503 month (or (nth 4 tl) (string-to-number (format-time-string "%m")))
2504 day (or (nth 3 tl) (string-to-number (format-time-string "%d")))
2505 hour (or (nth 2 tl) (string-to-number (format-time-string "%H")))
2506 minute (or (nth 1 tl) (string-to-number (format-time-string "%M")))
2507 second (or (nth 0 tl) 0))
2508 (if (and (boundp 'org-time-was-given)
2510 (setq org-time-was-given t))
2511 (if (< year 100) (setq year (+ 2000 year)))
2513 (encode-time second minute hour day month year)
2514 (if (or (nth 1 tl) (nth 2 tl))
2515 (format "%04d-%02d-%02d %02d:%02d" year month day hour minute)
2516 (format "%04d-%02d-%02d" year month day)))))
2518 (defun org-eval-in-calendar (form)
2519 "Eval FORM in the calendar window and return to current window.
2520 Also, store the cursor date in variable ans2."
2521 (let ((sw (selected-window)))
2522 (select-window (get-buffer-window "*Calendar*"))
2524 (when (calendar-cursor-to-date)
2525 (let* ((date (calendar-cursor-to-date))
2526 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
2527 (setq ans2 (format-time-string "%Y-%m-%d" time))))
2528 (select-window sw)))
2530 (defun org-calendar-select ()
2531 "Return to `org-read-date' with the date currently selected.
2532 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
2534 (when (calendar-cursor-to-date)
2535 (let* ((date (calendar-cursor-to-date))
2536 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
2537 (setq ans1 (format-time-string "%Y-%m-%d" time)))
2538 (if (active-minibuffer-window) (exit-minibuffer))))
2540 (defun org-check-deadlines (ndays)
2541 "Check if there are any deadlines due or past due.
2542 A deadline is considered due if it happens within `org-deadline-warning-days'
2543 days from todays date. If the deadline appears in an entry marked DONE,
2544 it is not shown. The prefix arg NDAYS can be used to test that many
2545 days. If the prefix are is a raw C-u prefix, all deadlines are shown."
2547 (let* ((org-warn-days
2549 ((equal ndays '(4)) 100000)
2550 (ndays (prefix-numeric-value ndays))
2551 (t org-deadline-warning-days)))
2552 (case-fold-search nil)
2553 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
2556 (and (let ((d1 (time-to-days (current-time)))
2558 (org-time-string-to-time (match-string 1)))))
2559 (< (- d2 d1) org-warn-days))
2560 (not (org-entry-is-done-p))))))
2561 (message "%d deadlines past-due or due within %d days"
2562 (org-occur regexp callback)
2565 (defun org-evaluate-time-range (&optional to-buffer)
2566 "Evaluate a time range by computing the difference between start and end.
2567 Normally the result is just printed in the echo area, but with prefix arg
2568 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
2569 If the time range is actually in a table, the result is inserted into the
2571 For time difference computation, a year is assumed to be exactly 365
2572 days in order to avoid rounding problems."
2575 (unless (org-at-date-range-p)
2576 (goto-char (point-at-bol))
2577 (re-search-forward org-tr-regexp (point-at-eol) t))
2578 (if (not (org-at-date-range-p))
2579 (error "Not at a time-stamp range, and none found in current line.")))
2580 (let* ((ts1 (match-string 1))
2581 (ts2 (match-string 2))
2582 (match-end (match-end 0))
2583 (time1 (org-time-string-to-time ts1))
2584 (time2 (org-time-string-to-time ts2))
2585 (t1 (time-to-seconds time1))
2586 (t2 (time-to-seconds time2))
2587 (diff (abs (- t2 t1)))
2588 (negative (< (- t2 t1) 0))
2589 (ys (floor (* 365 24 60 60)))
2592 (fy "%dy %dd %02d:%02d")
2593 (fd "%dd %02d:%02d")
2596 (setq y (floor (/ diff ys)) diff (mod diff ys)
2597 d (floor (/ diff ds)) diff (mod diff ds)
2598 h (floor (/ diff hs)) diff (mod diff hs)
2599 m (floor (/ diff 60)))
2602 (goto-char match-end)
2603 (when (and (org-at-table-p) (looking-at " *|"))
2605 (goto-char (match-end 0)))
2607 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
2609 (if negative (insert " -"))
2610 (if (> y 0) (insert " " (format fy y d h m))
2611 (if (> d 0) (insert " " (format fd d h m))
2612 (insert " " (format fh h m))))
2613 (if align (org-table-align))
2614 (message "Time difference inserted"))
2615 (message (org-make-tdiff-string y d h m)))))
2617 (defun org-make-tdiff-string (y d h m)
2620 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
2622 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
2624 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
2626 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
2628 (apply 'format fmt (nreverse l))))
2630 (defun org-time-string-to-time (s)
2631 (apply 'encode-time (org-parse-time-string s)))
2633 (defun org-parse-time-string (s)
2634 "Parse the standard Org-mode time string.
2635 This should be a lot faster than the normal parse-time-string."
2636 (if (string-match org-ts-regexp1 s)
2638 (string-to-number (or (match-string 8 s) "0"))
2639 (string-to-number (or (match-string 7 s) "0"))
2640 (string-to-number (match-string 4 s))
2641 (string-to-number (match-string 3 s))
2642 (string-to-number (match-string 2 s))
2646 (defun org-timestamp-up (&optional arg)
2647 "Increase the date item at the cursor by one.
2648 If the cursor is on the year, change the year. If it is on the month or
2649 the day, change that.
2650 With prefix ARG, change by that many units."
2652 (org-timestamp-change (prefix-numeric-value arg)))
2654 (defun org-timestamp-down (&optional arg)
2655 "Decrease the date item at the cursor by one.
2656 If the cursor is on the year, change the year. If it is on the month or
2657 the day, change that.
2658 With prefix ARG, change by that many units."
2660 (org-timestamp-change (- (prefix-numeric-value arg))))
2662 (defun org-timestamp-up-day (&optional arg)
2663 "Increase the date in the time stamp by one day.
2664 With prefix ARG, change that many days."
2666 (org-timestamp-change (prefix-numeric-value arg) 'day))
2668 (defun org-timestamp-down-day (&optional arg)
2669 "Increase the date in the time stamp by one day.
2670 With prefix ARG, change that many days."
2672 (org-timestamp-change (- (prefix-numeric-value arg)) 'day))
2674 (defsubst org-pos-in-match-range (pos n)
2675 (and (match-beginning n)
2676 (<= (match-beginning n) pos)
2677 (>= (match-end n) pos)))
2679 (defun org-at-timestamp-p ()
2680 "Determine if the the cursor is in or at a timestamp."
2682 (let* ((tsr org-ts-regexp2)
2684 (ans (or (looking-at tsr)
2686 (skip-chars-backward "^<\n\r\t")
2687 (if (> (point) 1) (backward-char 1))
2688 (and (looking-at tsr)
2689 (> (- (match-end 0) pos) -1))))))
2690 (and (boundp 'org-ts-what)
2693 ((org-pos-in-match-range pos 2) 'year)
2694 ((org-pos-in-match-range pos 3) 'month)
2695 ((org-pos-in-match-range pos 7) 'hour)
2696 ((org-pos-in-match-range pos 8) 'minute)
2697 ((or (org-pos-in-match-range pos 4)
2698 (org-pos-in-match-range pos 5)) 'day)
2702 (defun org-timestamp-change (n &optional what)
2703 "Change the date in the time stamp at point.
2704 The date will be changed by N times WHAT. WHAT can be `day', `month',
2705 `year', `minute', `second'. If WHAT is not given, the cursor position
2706 in the timestamp determines what will be changed."
2707 (let ((fmt (car org-time-stamp-formats))
2711 (if (not (org-at-timestamp-p))
2712 (error "Not at a timestamp"))
2713 (setq org-ts-what (or what org-ts-what))
2714 (setq fmt (if (<= (abs (- (cdr org-ts-lengths)
2715 (- (match-end 0) (match-beginning 0))))
2717 (cdr org-time-stamp-formats)
2718 (car org-time-stamp-formats)))
2719 (setq ts (match-string 0))
2721 (setq time0 (org-parse-time-string ts))
2725 (list (or (car time0) 0))
2726 (list (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0)))
2727 (list (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0)))
2728 (list (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0)))
2729 (list (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0)))
2730 (list (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0)))
2732 (if (eq what 'calendar)
2736 (set-buffer "*Calendar*")
2737 (calendar-cursor-to-date)))))
2738 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
2739 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
2740 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
2741 (setcar time0 (or (car time0) 0))
2742 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
2743 (setcar (nthcdr 2 time0) (or (nth 1 time0) 0))
2744 (setq time (apply 'encode-time time0))))
2745 (insert (setq org-last-changed-timestamp (format-time-string fmt time)))
2747 ;; Try to recenter the calendar window, if any
2748 (if (and org-calendar-follow-timestamp-change
2749 (get-buffer-window "*Calendar*" t)
2750 (memq org-ts-what '(day month year)))
2751 (org-recenter-calendar (time-to-days time)))))
2753 (defun org-recenter-calendar (date)
2754 "If the calendar is visible, recenter it to DATE."
2755 (let* ((win (selected-window))
2756 (cwin (get-buffer-window "*Calendar*" t)))
2758 (select-window cwin)
2759 (calendar-goto-date (if (listp date) date
2760 (calendar-gregorian-from-absolute date)))
2761 (select-window win))))
2763 (defun org-goto-calendar (&optional arg)
2764 "Go to the Emacs calendar at the current date.
2765 If there is a time stamp in the current line, go to that date.
2766 A prefix ARG can be used force the current date."
2768 (let ((tsr org-ts-regexp) diff)
2769 (if (or (org-at-timestamp-p)
2771 (beginning-of-line 1)
2772 (looking-at (concat ".*" tsr))))
2773 (let ((d1 (time-to-days (current-time)))
2775 (org-time-string-to-time (match-string 1)))))
2776 (setq diff (- d2 d1))))
2778 (calendar-goto-today)
2779 (if (and diff (not arg)) (calendar-forward-day diff))))
2781 (defun org-date-from-calendar ()
2782 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
2783 If there is already a time stamp at the cursor position, update it."
2785 (org-timestamp-change 0 'calendar))
2787 ;;; Agenda, and Diary Integration
2791 (defvar org-agenda-mode-map (make-sparse-keymap)
2792 "Keymap for org-agenda-mode.")
2794 (defvar org-agenda-menu)
2795 (defvar org-agenda-follow-mode nil)
2796 (defvar org-agenda-buffer-name "*Org Agenda*")
2797 (defvar org-agenda-redo-command nil)
2800 (defun org-agenda-mode ()
2801 "Mode for time-sorted view on action items in Org-mode files."
2803 (kill-all-local-variables)
2804 (setq major-mode 'org-agenda-mode)
2805 (setq mode-name "Org-Agenda")
2806 (use-local-map org-agenda-mode-map)
2807 (easy-menu-add org-agenda-menu)
2808 (if org-startup-truncated (setq truncate-lines t))
2809 (add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
2810 (setq org-agenda-follow-mode nil)
2812 '("Agenda") "Agenda Files"
2815 ["Edit file list" (customize-variable 'org-agenda-files) t]
2817 (mapcar 'org-file-menu-entry org-agenda-files)))
2818 (org-agenda-set-mode-name)
2819 (run-hooks 'org-agenda-mode-hook))
2821 (define-key org-agenda-mode-map [(tab)] 'org-agenda-goto)
2822 (define-key org-agenda-mode-map [(return)] 'org-agenda-switch-to)
2823 (define-key org-agenda-mode-map " " 'org-agenda-show)
2824 (define-key org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2825 (define-key org-agenda-mode-map "o" 'delete-other-windows)
2826 (define-key org-agenda-mode-map "l" 'org-agenda-recenter)
2827 (define-key org-agenda-mode-map "t" 'org-agenda-todo)
2828 (define-key org-agenda-mode-map "." 'org-agenda-goto-today)
2829 (define-key org-agenda-mode-map "w" 'org-agenda-week-view)
2830 (define-key org-agenda-mode-map [(shift right)] 'org-agenda-date-later)
2831 (define-key org-agenda-mode-map [(shift left)] 'org-agenda-date-earlier)
2833 (define-key org-agenda-mode-map ">" 'org-agenda-date-today)
2834 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2835 (while l (define-key org-agenda-mode-map
2836 (int-to-string (pop l)) 'digit-argument)))
2838 (define-key org-agenda-mode-map "f" 'org-agenda-follow-mode)
2839 (define-key org-agenda-mode-map "d" 'org-agenda-toggle-diary)
2840 (define-key org-agenda-mode-map "r" 'org-agenda-redo)
2841 (define-key org-agenda-mode-map "q" 'org-agenda-quit)
2842 (define-key org-agenda-mode-map "x" 'org-agenda-exit)
2843 (define-key org-agenda-mode-map "P" 'org-agenda-show-priority)
2844 (define-key org-agenda-mode-map "p" 'org-agenda-priority)
2845 (define-key org-agenda-mode-map "," 'org-agenda-priority)
2846 (define-key org-agenda-mode-map "i" 'org-agenda-diary-entry)
2847 (define-key org-agenda-mode-map "+" 'org-agenda-priority-up)
2848 (define-key org-agenda-mode-map "-" 'org-agenda-priority-down)
2849 (define-key org-agenda-mode-map [(right)] 'org-agenda-later)
2850 (define-key org-agenda-mode-map [(left)] 'org-agenda-earlier)
2852 (defvar org-agenda-keymap (copy-keymap org-agenda-mode-map)
2853 "Local keymap for agenda entries from Org-mode.")
2855 (define-key org-agenda-keymap
2856 (if org-xemacs-p [(button2)] [(mouse-2)]) 'org-agenda-goto-mouse)
2857 (define-key org-agenda-keymap
2858 (if org-xemacs-p [(button3)] [(mouse-3)]) 'org-agenda-show-mouse)
2860 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2864 ["Show" org-agenda-show t]
2865 ["Go To (other window)" org-agenda-goto t]
2866 ["Go To (one window)" org-agenda-switch-to t]
2867 ["Follow Mode" org-agenda-follow-mode
2868 :style toggle :selected org-agenda-follow-mode :active t]
2870 ["Cycle TODO" org-agenda-todo t]
2872 ["Reschedule +1 day" org-agenda-date-later t]
2873 ["Reschedule -1 day" org-agenda-date-earlier t]
2875 ["Reschedule to today" org-agenda-date-today t])
2877 ["Set Priority" org-agenda-priority t]
2878 ["Increase Priority" org-agenda-priority-up t]
2879 ["Decrease Priority" org-agenda-priority-down t]
2880 ["Show Priority" org-agenda-show-priority t])
2882 ["Rebuild" org-agenda-redo t]
2883 ["Goto Today" org-agenda-goto-today t]
2884 ["Next Dates" org-agenda-later (local-variable-p 'starting-day)]
2885 ["Previous Dates" org-agenda-earlier (local-variable-p 'starting-day)]
2887 ["Week/Day View" org-agenda-week-view (local-variable-p 'starting-day)]
2888 ["Include Diary" org-agenda-toggle-diary
2889 :style toggle :selected org-agenda-include-diary :active t]
2891 ["New Diary Entry" org-agenda-diary-entry t]
2893 ["Quit" org-agenda-quit t]
2894 ["Exit and Release Buffers" org-agenda-exit t]
2897 (defvar org-agenda-markers nil
2898 "List of all currently active markers created by org-agenda")
2899 (defvar org-agenda-last-marker-time (time-to-seconds (current-time))
2900 "Creation time of the last agenda marker.")
2902 (defun org-agenda-new-marker (pos)
2903 "Return a new agenda marker.
2904 Org-mode keeps a list of these markers and resets them when they are
2906 (let ((m (copy-marker pos)))
2907 (setq org-agenda-last-marker-time (time-to-seconds (current-time)))
2908 (push m org-agenda-markers)
2911 (defun org-agenda-maybe-reset-markers (&optional force)
2912 "Reset markers created by org-agenda. But only if they are old enough."
2914 (> (- (time-to-seconds (current-time))
2915 org-agenda-last-marker-time)
2917 (while org-agenda-markers
2918 (move-marker (pop org-agenda-markers) nil))))
2920 (defvar org-agenda-new-buffers nil
2921 "Buffers created to visit agenda files.")
2923 (defun org-get-agenda-file-buffer (file)
2924 "Get a buffer visiting FILE. If the buffer needs to be created, add
2925 it to the list of buffers which might be released later."
2926 (let ((buf (find-buffer-visiting file)))
2928 buf ; just return it
2929 ;; Make a new buffer and remember it
2930 (setq buf (find-file-noselect file))
2931 (if buf (push buf org-agenda-new-buffers))
2934 (defun org-release-buffers (blist)
2935 "Release all buffers in list, asking the user for confirmation when needed.
2936 When a buffer is unmodified, it is just killed. When modified, it is saved
2937 \(if the user agrees) and then killed."
2939 (while (setq buf (pop blist))
2940 (setq file (buffer-file-name buf))
2941 (when (and (buffer-modified-p buf)
2943 (y-or-n-p (format "Save file %s? " file)))
2945 (set-buffer buf) (save-buffer)))
2946 (kill-buffer buf))))
2948 (defun org-timeline (&optional include-all)
2949 "Show a time-sorted view of the entries in the current org file.
2950 Only entries with a time stamp of today or later will be listed. With
2951 one C-u prefix argument, also past entries will be listed.
2952 With two C-u prefixes, all unfinished TODO items will also be shown,
2953 under the current date.
2954 If the buffer contains an active region, only check the region for
2958 (org-agenda-maybe-reset-markers 'force)
2959 (let* ((dopast include-all)
2960 (dotodo (equal include-all '(16)))
2961 (entry (buffer-file-name))
2962 (org-agenda-files (list (buffer-file-name)))
2963 (date (calendar-current-date))
2964 (win (selected-window))
2966 (beg (if (org-region-active-p) (region-beginning) (point-min)))
2967 (end (if (org-region-active-p) (region-end) (point-max)))
2968 (day-numbers (org-get-all-dates beg end 'no-ranges
2969 t)) ; always include today
2970 (today (time-to-days (current-time)))
2971 (org-respect-restriction t)
2974 (setq org-agenda-redo-command
2976 (list 'switch-to-buffer-other-window (current-buffer))
2977 (list 'org-timeline include-all)))
2979 ;; Remove past dates from the list of dates.
2980 (setq day-numbers (delq nil (mapcar (lambda(x)
2981 (if (>= x today) x nil))
2983 (switch-to-buffer-other-window
2984 (get-buffer-create org-agenda-buffer-name))
2985 (setq buffer-read-only nil)
2987 (org-agenda-mode) (setq buffer-read-only nil)
2988 (while (setq d (pop day-numbers))
2989 (if (and (>= d today)
2994 (insert (make-string 79 ?-) "\n")))
2995 (setq date (calendar-gregorian-from-absolute d))
2998 (setq rtn (org-agenda-get-day-entries
2999 entry date :todo :timestamp))
3000 (setq rtn (org-agenda-get-day-entries entry date :timestamp)))
3001 (if (or rtn (equal d today))
3003 (insert (calendar-day-name date) " "
3004 (number-to-string (extract-calendar-day date)) " "
3005 (calendar-month-name (extract-calendar-month date)) " "
3006 (number-to-string (extract-calendar-year date)) "\n")
3007 (put-text-property s (1- (point)) 'face
3010 (put-text-property s (1- (point)) 'org-today t))
3011 (insert (org-finalize-agenda-entries rtn) "\n")
3012 (put-text-property s (1- (point)) 'day d))))
3013 (goto-char (point-min))
3014 (setq buffer-read-only t)
3015 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
3017 (when (not org-select-timeline-window)
3022 (defun org-agenda (&optional include-all start-day ndays)
3023 "Produce a weekly view from all files in variable `org-agenda-files'.
3024 The view will be for the current week, but from the overview buffer you
3025 will be able to go to other weeks.
3026 With one C-u prefix argument INCLUDE-ALL, all unfinished TODO items will
3027 also be shown, under the current date.
3028 START-DAY defaults to TODAY, or to the most recent match for the weekday
3029 given in `org-agenda-start-on-weekday'.
3030 NDAYS defaults to `org-agenda-ndays'."
3032 (org-agenda-maybe-reset-markers 'force)
3034 (let* ((org-agenda-start-on-weekday
3035 (if (or (equal ndays 1)
3036 (and (null ndays) (equal 1 org-agenda-ndays)))
3037 nil org-agenda-start-on-weekday))
3038 (files (copy-sequence org-agenda-files))
3039 (win (selected-window))
3040 (today (time-to-days (current-time)))
3041 (sd (or start-day today))
3042 (start (if (or (null org-agenda-start-on-weekday)
3043 (< org-agenda-ndays 7))
3045 (let* ((nt (calendar-day-of-week
3046 (calendar-gregorian-from-absolute sd)))
3047 (n1 org-agenda-start-on-weekday)
3049 (- sd (+ (if (< d 0) 7 0) d)))))
3050 (day-numbers (list start))
3051 s e rtn rtnall file date d start-pos)
3052 (setq org-agenda-redo-command
3053 (list 'org-agenda include-all start-day ndays))
3054 ;; Make the list of days
3055 (setq ndays (or ndays org-agenda-ndays))
3057 (push (1+ (car day-numbers)) day-numbers)
3058 (setq ndays (1- ndays)))
3059 (setq day-numbers (nreverse day-numbers))
3060 (if (not (equal (current-buffer) (get-buffer org-agenda-buffer-name)))
3062 (delete-other-windows)
3063 (switch-to-buffer-other-window
3064 (get-buffer-create org-agenda-buffer-name))))
3065 (setq buffer-read-only nil)
3067 (org-agenda-mode) (setq buffer-read-only nil)
3068 (set (make-local-variable 'starting-day) (car day-numbers))
3069 (set (make-local-variable 'include-all-loc) include-all)
3070 (when (and (or include-all org-agenda-include-all-todo)
3071 (member today day-numbers))
3072 (setq files org-agenda-files
3074 (while (setq file (pop files))
3076 (org-check-agenda-file file)
3077 (setq date (calendar-gregorian-from-absolute today)
3078 rtn (org-agenda-get-day-entries
3080 (setq rtnall (append rtnall rtn))))
3081 (if rtnall (insert (org-finalize-agenda-entries rtnall) "\n")))
3082 (while (setq d (pop day-numbers))
3083 (setq date (calendar-gregorian-from-absolute d)
3086 (and (not start-pos) (= d sd)))
3087 (setq start-pos (point)))
3088 (setq files org-agenda-files
3090 (while (setq file (pop files))
3092 (org-check-agenda-file file)
3093 (setq rtn (org-agenda-get-day-entries file date))
3094 (setq rtnall (append rtnall rtn))))
3095 (if org-agenda-include-diary
3098 (require 'diary-lib)
3099 (setq rtn (org-get-entries-from-diary date))
3100 (setq rtnall (append rtnall rtn))))
3101 (if (or rtnall org-agenda-show-all-dates)
3103 (insert (format "%-9s %2d %-9s %4d\n"
3104 (calendar-day-name date)
3105 (extract-calendar-day date)
3106 (calendar-month-name (extract-calendar-month date))
3107 (extract-calendar-year date)))
3108 (put-text-property s (1- (point)) 'face
3110 (if rtnall (insert (org-finalize-agenda-entries rtnall) "\n"))
3111 (put-text-property s (1- (point)) 'day d))))
3112 (goto-char (point-min))
3113 (setq buffer-read-only t)
3114 (goto-char (or start-pos 1))
3115 (if (not org-select-agenda-window) (select-window win))
3118 (defun org-check-agenda-file (file)
3119 "Make sure FILE exists. If not, ask user what to do."
3120 ;; FIXME: this does not correctly change the menus
3121 ;; Could be fixed by explicitly going to the buffer, maybe.
3122 (when (not (file-exists-p file))
3123 (message "non-existent file %s. [R]emove from agenda-files or [A]bort?"
3125 (let ((r (downcase (read-char-exclusive))))
3128 (org-remove-file file)
3129 (throw 'nextfile t))
3130 (t (error "Abort"))))))
3132 (defun org-agenda-quit (arg)
3133 "Exit agenda by removing the window or the buffer."
3135 (let ((buf (current-buffer)))
3136 (if (not (one-window-p)) (delete-window))
3138 (org-agenda-maybe-reset-markers 'force)))
3140 (defun org-agenda-exit (arg)
3141 "Exit agenda by removing the window or the buffer.
3142 Also kill all Org-mode buffers which have be loaded by `org-agenda'.
3143 Org-mode buffers visitied directly by the user will no be touched."
3145 (org-release-buffers org-agenda-new-buffers)
3146 (setq org-agenda-new-buffers nil)
3147 (org-agenda-quit arg))
3149 (defun org-agenda-redo (&optional arg)
3152 (eval org-agenda-redo-command))
3154 (defun org-agenda-goto-today (arg)
3157 (if (boundp 'starting-day)
3158 (let ((cmd (car org-agenda-redo-command))
3159 (iall (nth 1 org-agenda-redo-command))
3160 (nday (nth 3 org-agenda-redo-command)))
3161 (eval (list cmd iall nil nday)))
3162 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
3165 (defun org-agenda-later (arg)
3166 "Go forward in time by `org-agenda-ndays' days.
3167 With prefix ARG, go forward that many times `org-agenda-ndays'."
3169 (unless (boundp 'starting-day)
3170 (error "Not allowed"))
3171 (org-agenda (if (boundp 'include-all-loc) include-all-loc nil)
3172 (+ starting-day (* arg org-agenda-ndays))))
3174 (defun org-agenda-earlier (arg)
3175 "Go back in time by `org-agenda-ndays' days.
3176 With prefix ARG, go back that many times `org-agenda-ndays'."
3178 (unless (boundp 'starting-day)
3179 (error "Not allowed"))
3180 (org-agenda (if (boundp 'include-all-loc) include-all-loc nil)
3181 (- starting-day (* arg org-agenda-ndays))))
3183 (defun org-agenda-day-view (arg)
3184 "Switch agenda to single day view."
3186 (unless (boundp 'starting-day)
3187 (error "Not allowed"))
3188 (setq org-agenda-ndays 1)
3189 (org-agenda include-all-loc starting-day 1))
3191 (defun org-agenda-week-view (arg)
3192 "Switch agenda to week view."
3194 (unless (boundp 'starting-day)
3195 (error "Not allowed"))
3196 (setq org-agenda-ndays
3197 (if (equal org-agenda-ndays 1) 7 1))
3198 (org-agenda include-all-loc
3199 (or (get-text-property (point) 'day)
3201 (org-agenda-set-mode-name)
3202 (message "Switched to %s view"
3203 (if (equal org-agenda-ndays 1) "day" "week")))
3205 (defun org-agenda-follow-mode ()
3206 "Toggle follow mode in an agenda buffer."
3208 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
3209 (org-agenda-set-mode-name)
3210 (message "Follow mode is %s"
3211 (if org-agenda-follow-mode "on" "off")))
3213 (defun org-agenda-toggle-diary ()
3214 "Toggle follow mode in an agenda buffer."
3216 (setq org-agenda-include-diary (not org-agenda-include-diary))
3218 (org-agenda-set-mode-name)
3219 (message "Diary inclusion turned %s"
3220 (if org-agenda-include-diary "on" "off")))
3222 (defun org-agenda-set-mode-name ()
3223 "Set the mode name to indicate all the small mode seetings."
3225 (concat "Org-Agenda"
3226 (if (equal org-agenda-ndays 1) " Day" "")
3227 (if (equal org-agenda-ndays 7) " Week" "")
3228 (if org-agenda-follow-mode " Follow" "")
3229 (if org-agenda-include-diary " Diary" "")))
3230 (force-mode-line-update))
3232 (defun org-agenda-post-command-hook ()
3233 (if (and org-agenda-follow-mode
3234 (get-text-property (point) 'org-marker))
3237 (defun org-get-entries-from-diary (date)
3238 "Get the (emacs calendar) diary entries for DATE."
3239 (let* ((fancy-diary-buffer "*temporary-fancy-diary-buffer*")
3240 (diary-display-hook '(sort-diary-entries fancy-diary-display))
3242 (disable-org-agenda t))
3244 (save-window-excursion
3245 (list-diary-entries date 1)))
3246 (if (not (get-buffer fancy-diary-buffer))
3249 (set-buffer fancy-diary-buffer)
3250 (setq buffer-read-only nil)
3251 (if (= (point-max) 1)
3255 (beginning-of-line 3)
3256 (delete-region (point-min) (point))
3257 (while (and (re-search-forward "^" nil t) (not (eobp)))
3258 (replace-match " Diary: "))
3259 (setq entries (buffer-substring (point-min) (- (point-max) 1))))
3260 (set-buffer-modified-p nil)
3261 (kill-buffer fancy-diary-buffer)))
3263 (setq entries (org-split-string entries "\n"))
3267 (if (string-match "\\<\\([012][0-9]\\):\\([0-6][0-9]\\)" x)
3268 (add-text-properties
3271 (+ (* 100 (string-to-number
3272 (match-string 1 x)))
3273 (string-to-number (match-string 2 x))))
3278 (defun org-add-file (&optional file)
3279 "Add current file to the list of files in variable `org-agenda-files'.
3280 These are the files which are being checked for agenda entries.
3281 Optional argument FILE means, use this file instead of the current.
3282 It is possible (but not recommended) to add this function to the
3286 (let* ((file (or file (buffer-file-name)
3288 (error "Buffer is not visiting a file")
3289 (throw 'exit nil))))
3290 (true-file (file-truename file))
3291 (afile (abbreviate-file-name file))
3292 (present (delq nil (mapcar
3294 (equal true-file (file-truename x)))
3295 org-agenda-files))))
3298 (setq org-agenda-files
3299 (cons afile org-agenda-files))
3300 ;; Make sure custom.el does not end up with Org-mode
3301 (let ((org-mode-hook nil) (default-major-mode 'fundamental-mode))
3302 (customize-save-variable 'org-agenda-files org-agenda-files))
3303 (org-install-agenda-files-menu)
3304 (message "Added file: %s" afile))
3305 (message "File was already in list: %s" afile)))))
3307 (defun org-remove-file (&optional file)
3308 "Remove current file from the list of files in variable `org-agenda-files'.
3309 These are the files which are being checked for agenda entries.
3310 Optional argument FILE means, use this file instead of the current."
3312 (let* ((file (or file (buffer-file-name)))
3313 (true-file (file-truename file))
3314 (afile (abbreviate-file-name file))
3315 (files (delq nil (mapcar
3317 (if (equal true-file
3320 org-agenda-files))))
3321 (if (not (= (length files) (length org-agenda-files)))
3323 (setq org-agenda-files files)
3324 (customize-save-variable 'org-agenda-files org-agenda-files)
3325 (org-install-agenda-files-menu)
3326 (message "Removed file: %s" afile))
3327 (message "File was not in list: %s" afile))))
3329 (defun org-file-menu-entry (file)
3330 (vector file (list 'find-file file) t))
3332 (defun org-get-all-dates (beg end &optional no-ranges force-today)
3333 "Return a list of all relevant day numbers from BEG to END buffer positions.
3334 If NO-RANGES is non-nil, include only the start and end dates of a range,
3335 not every single day in the range. If FORCE-TODAY is non-nil, make
3336 sure that TODAY is included in the list."
3337 (let (dates date day day1 day2 ts1 ts2)
3339 (setq dates (list (time-to-days (current-time)))))
3342 (while (re-search-forward org-ts-regexp end t)
3343 (setq day (time-to-days (org-time-string-to-time
3344 (substring (match-string 1) 0 10))))
3345 (or (memq day dates) (push day dates)))
3348 (while (re-search-forward org-tr-regexp end t)
3349 (setq ts1 (substring (match-string 1) 0 10)
3350 ts2 (substring (match-string 2) 0 10)
3351 day1 (time-to-days (org-time-string-to-time ts1))
3352 day2 (time-to-days (org-time-string-to-time ts2)))
3353 (while (< (setq day1 (1+ day1)) day2)
3354 (or (memq day1 dates) (push day1 dates)))))
3358 (defun org-diary (&rest args)
3359 "Returns diary information from org-files.
3360 This function can be used in an \"sexp\" diary entry in the Emacs calendar.
3361 It accesses org files and extracts information from those files to be
3362 listed in the diary. The function accepts arguments specifying what
3363 items should be listed. The following arguments are allowed:
3365 :timestamp List the headlines of items containing a date stamp or
3366 date range matching the selected date. Deadlines will
3367 also be listed, on the expiration day.
3369 :deadline List any deadlines past due, or due within
3370 `org-deadline-warning-days'. The listing occurs only
3371 in the diary for *today*, not at any other date. If
3372 an entry is marked DONE, it is no longer listed.
3374 :scheduled List all items which are scheduled for the given date.
3375 The diary for *today* also contains items which were
3376 scheduled earlier and are not yet marked DONE.
3378 :todo List all TODO items from the org-file. This may be a
3379 long list - so this is not turned on by default.
3380 Like deadlines, these entires only show up in the
3381 diary for *today*, not at any other date.
3383 The call in the diary file should look like this:
3385 &%%(org-diary) ~/path/to/some/orgfile.org
3387 Use a separate line for each org file to check. Or, if you omit the file name,
3388 all files listed in `org-agenda-files' will be checked automatically:
3392 If you don't give any arguments (as in the example above), the default
3393 arguments (:deadline :scheduled :timestamp) are used. So the example above may
3396 &%%(org-diary :deadline :timestamp :scheduled)
3398 The function expects the lisp variables `entry' and `date' to be provided
3399 by the caller, because this is how the calendar works. Don't use this
3400 function from a program - use `org-agenda-get-day-entries' instead."
3401 (org-agenda-maybe-reset-markers)
3402 (setq args (or args '(:deadline :scheduled :timestamp)))
3403 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
3407 ;; If this is called during org-agenda, don't return any entries to
3408 ;; the calendar. Org Agenda will list these entries itself.
3409 (if (boundp 'disable-org-agenda) (setq files nil))
3410 (while (setq file (pop files))
3411 (setq rtn (apply 'org-agenda-get-day-entries file date args))
3412 (setq results (append results rtn)))
3413 (concat (org-finalize-agenda-entries results) "\n")))
3415 (defun org-agenda-get-day-entries (file date &rest args)
3416 "Does the work for `org-diary' and `org-agenda'
3417 FILE is the path to a file to be checked for entries. DATE is date like
3418 the one returned by `calendar-current-date'. ARGS are symbols indicating
3419 which kind of entries should be extracted. For details about these, see
3420 the documentation of `org-diary'."
3421 (setq args (or args '(:deadline :scheduled :timestamp)))
3422 (let* ((org-startup-with-deadline-check nil)
3423 (org-startup-folded nil)
3424 (buffer (if (file-exists-p file)
3425 ; (find-file-noselect file)
3426 (org-get-agenda-file-buffer file)
3427 (error "No such file %s" file)))
3428 (respect-narrow-p (boundp 'org-respect-restriction))
3431 ;; If file does not exist, make sure an error message ends up in diary
3432 (format "ORG-AGENDA-ERROR: No such org-file %s" file)
3435 (let ((case-fold-search nil))
3438 (if respect-narrow-p
3439 (if (org-region-active-p)
3440 ;; Respect a region to restrict search
3441 (narrow-to-region (region-beginning) (region-end)))
3442 ;; If we work for the calendar or many files,
3443 ;; get rid of any restriction
3445 (while (setq arg (pop args))
3447 ((and (eq arg :todo)
3448 (equal date (calendar-current-date)))
3449 (setq rtn (org-agenda-get-todos))
3450 (setq results (append results rtn)))
3451 ((eq arg :timestamp)
3452 (setq rtn (org-agenda-get-blocks))
3453 (setq results (append results rtn))
3454 (setq rtn (org-agenda-get-timestamps))
3455 (setq results (append results rtn)))
3456 ((eq arg :scheduled)
3457 (setq rtn (org-agenda-get-scheduled))
3458 (setq results (append results rtn)))
3459 ((and (eq arg :deadline)
3460 (equal date (calendar-current-date)))
3461 (setq rtn (org-agenda-get-deadlines))
3462 (setq results (append results rtn))))))))))
3465 (defun org-entry-is-done-p ()
3466 "Is the current entry marked DONE?"
3468 (and (re-search-backward "[\r\n]\\*" nil t)
3469 (looking-at orb-nl-done-regexp))))
3471 (defun org-at-date-range-p ()
3472 "It the cursor inside a date range?"
3476 (let ((pos (point)))
3477 (skip-chars-backward "^<\r\n")
3478 (skip-chars-backward "<")
3479 (and (looking-at org-tr-regexp)
3480 (>= (match-end 0) pos)
3482 (skip-chars-backward "^<\r\n")
3483 (skip-chars-backward "<")
3484 (and (looking-at org-tr-regexp)
3485 (>= (match-end 0) pos)
3489 (defun org-agenda-get-todos ()
3490 "Return the TODO information for agenda display."
3491 (let* ((props (list 'face nil
3492 'mouse-face 'highlight
3493 'keymap org-agenda-keymap
3495 (format "mouse-2 or RET jump to org file %s"
3496 (abbreviate-file-name (buffer-file-name)))))
3497 (regexp (concat "[\n\r]\\*+ *\\(" org-not-done-regexp
3501 (goto-char (point-min))
3502 (while (re-search-forward regexp nil t)
3503 (goto-char (match-beginning 1))
3504 (setq marker (org-agenda-new-marker (point))
3505 txt (org-format-agenda-item "" (match-string 1))
3507 (+ (org-get-priority txt)
3508 (if org-todo-kwd-priority-p
3509 (- org-todo-kwd-max-priority -2
3511 (member (match-string 2) org-todo-keywords)))
3513 (add-text-properties
3514 0 (length txt) (append (list 'org-marker marker 'priority priority)
3518 (goto-char (match-end 1)))
3521 (defconst org-agenda-no-heading-message
3522 "No heading for this item in buffer or region")
3524 (defun org-agenda-get-timestamps ()
3525 "Return the date stamp information for agenda display."
3526 (let* ((props (list 'face nil
3527 'mouse-face 'highlight
3528 'keymap org-agenda-keymap
3530 (format "mouse-2 or RET jump to org file %s"
3531 (abbreviate-file-name (buffer-file-name)))))
3532 (regexp (regexp-quote
3535 (car org-time-stamp-formats)
3536 (apply 'encode-time ; DATE bound by calendar
3537 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
3539 marker deadlinep scheduledp tmp priority
3541 (goto-char (point-min))
3542 (while (re-search-forward regexp nil t)
3543 (if (not (save-match-data (org-at-date-range-p)))
3545 (setq marker (org-agenda-new-marker (point))
3546 tmp (buffer-substring (max (point-min)
3547 (- (match-beginning 0)
3548 org-ds-keyword-length))
3549 (match-beginning 0))
3550 deadlinep (string-match org-deadline-regexp tmp)
3551 scheduledp (string-match org-scheduled-regexp tmp))
3553 (if (re-search-backward "\\(^\\|\r\\)\\*+" nil t)
3555 (goto-char (match-end 1))
3556 (looking-at "\\*+[ \t]*\\([^\r\n]+\\)")
3557 (setq txt (org-format-agenda-item
3559 (if deadlinep "Deadline: " "")
3560 (if scheduledp "Scheduled: " ""))
3562 (setq txt org-agenda-no-heading-message))
3563 (setq priority (org-get-priority txt))
3564 (add-text-properties
3565 0 (length txt) (append (list 'org-marker marker) props)
3568 (add-text-properties
3570 (list 'face 'org-warning-face
3571 'priority (+ 100 priority))
3574 (add-text-properties
3576 (list 'face 'org-scheduled-today-face
3577 priority (+ 99 priority))
3579 (add-text-properties
3581 (list 'priority priority) txt)))
3583 (outline-next-heading))))
3586 (defun org-agenda-get-deadlines ()
3587 "Return the deadline information for agenda display."
3588 (let* ((wdays org-deadline-warning-days)
3589 (props (list 'face nil
3590 'mouse-face 'highlight
3591 'keymap org-agenda-keymap
3593 (format "mouse-2 or RET jump to org file %s"
3594 (abbreviate-file-name (buffer-file-name)))))
3595 (regexp org-deadline-time-regexp)
3596 (todayp (equal date (calendar-current-date))) ; DATE bound by calendar
3597 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
3600 (goto-char (point-min))
3601 (while (re-search-forward regexp nil t)
3602 (setq d2 (time-to-days
3603 (org-time-string-to-time (match-string 1)))
3606 ;; When to show a deadline in the calendar:
3607 ;; If the expiration is within wdays warning time.
3608 ;; Past-due deadlines are only shown on the current date
3609 (if (and (< diff wdays) todayp (not (= diff 0)))
3611 (if (re-search-backward "\\(^\\|\r\\)\\*+[ \t]*" nil t)
3613 (goto-char (match-end 0))
3614 (setq head (buffer-substring-no-properties
3616 (progn (skip-chars-forward "^\r\n")
3618 (if (string-match org-looking-at-done-regexp head)
3620 (setq txt (org-format-agenda-item
3621 (format "In %3d d.: " diff) head))))
3622 (setq txt org-agenda-no-heading-message))
3624 (add-text-properties
3627 (list 'org-marker (org-agenda-new-marker pos)
3628 'priority (+ (- 10 diff) (org-get-priority txt))
3629 'face (cond ((<= diff 0) 'org-warning-face)
3630 ((<= diff 5) 'font-lock-function-name-face)
3637 (defun org-agenda-get-scheduled ()
3638 "Return the scheduled information for agenda display."
3639 (let* ((props (list 'face 'org-scheduled-previously-face
3640 'mouse-face 'highlight
3641 'keymap org-agenda-keymap
3643 (format "mouse-2 or RET jump to org file %s"
3644 (abbreviate-file-name (buffer-file-name)))))
3645 (regexp org-scheduled-time-regexp)
3646 (todayp (equal date (calendar-current-date))) ; DATE bound by calendar
3647 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
3650 (goto-char (point-min))
3651 (while (re-search-forward regexp nil t)
3652 (setq d2 (time-to-days
3653 (org-time-string-to-time (match-string 1)))
3656 ;; When to show a scheduled item in the calendar:
3657 ;; If it is on or past the date.
3658 (if (and (< diff 0) todayp)
3660 (if (re-search-backward "\\(^\\|\r\\)\\*+[ \t]*" nil t)
3662 (goto-char (match-end 0))
3663 (setq head (buffer-substring-no-properties
3665 (progn (skip-chars-forward "^\r\n") (point))))
3666 (if (string-match org-looking-at-done-regexp head)
3668 (setq txt (org-format-agenda-item
3669 (format "Sched.%2dx: " (- 1 diff)) head))))
3670 (setq txt org-agenda-no-heading-message))
3672 (setq marker (org-agenda-new-marker pos))
3673 (add-text-properties
3675 (append (list 'org-marker marker
3676 'priority (+ (- 5 diff) (org-get-priority txt)))
3681 (defun org-agenda-get-blocks ()
3682 "Return the date-range information for agenda display."
3683 (let* ((props (list 'face nil
3684 'mouse-face 'highlight
3685 'keymap org-agenda-keymap
3687 (format "mouse-2 or RET jump to org file %s"
3688 (abbreviate-file-name (buffer-file-name)))))
3689 (regexp org-tr-regexp)
3690 (d0 (calendar-absolute-from-gregorian date))
3691 marker ee txt d1 d2 s1 s2)
3692 (goto-char (point-min))
3693 (while (re-search-forward regexp nil t)
3694 (setq s1 (match-string 1)
3696 d1 (time-to-days (org-time-string-to-time s1))
3697 d2 (time-to-days (org-time-string-to-time s2)))
3698 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
3699 ;; Only allow days between the limits, because the normal
3700 ;; date stamps will catch the limits.
3702 (setq marker (org-agenda-new-marker (point)))
3703 (if (re-search-backward "\\(^\\|\r\\)\\*+" nil t)
3705 (goto-char (match-end 1))
3706 (looking-at "\\*+[ \t]*\\([^\r\n]+\\)")
3707 (setq txt (org-format-agenda-item
3709 (1+ (- d0 d1)) (1+ (- d2 d1)))
3711 (setq txt org-agenda-no-heading-message))
3712 (add-text-properties
3713 0 (length txt) (append (list 'org-marker marker
3714 'priority (org-get-priority txt))
3718 (outline-next-heading))
3719 ;; Sort the entries by expiration date.
3723 (defun org-format-agenda-item (prefix txt)
3724 "Format TXT to be inserted into the agenda buffer.
3725 In particular, this indents the lins and adds a category."
3726 (let ((cat (or org-category
3727 (file-name-sans-extension
3728 (file-name-nondirectory (buffer-file-name)))))
3730 (if (symbolp cat) (setq cat (symbol-name cat)))
3731 (setq rtn (format " %-10s %s%s" (concat cat ":") prefix txt))
3732 (add-text-properties
3733 0 2 (list 'category (downcase cat)
3734 'prefix-length (- (length rtn) (length txt))
3735 'time-of-day (org-get-time-of-day rtn))
3739 ;; FIXME: Should this be restricted to beginning of string?
3740 (defun org-get-time-of-day (s)
3741 "Check string S for a time of day."
3745 "\\<\\([012][0-9]\\)\\(:\\([0-6][0-9]\\)\\)?\\([AaPp][Mm]\\)?\\>" s)
3746 (or (match-beginning 2) (match-beginning 4)))
3747 (+ (* 100 (+ (string-to-number (match-string 1 s))
3748 (if (and (match-beginning 4)
3749 (equal (downcase (match-string 4 s)) "pm"))
3751 (if (match-beginning 3)
3752 (string-to-number (match-string 3 s))
3755 (defun org-finalize-agenda-entries (list)
3756 "Sort and concatenate the agenda items."
3757 (mapconcat 'identity (sort list 'org-entries-lessp) "\n"))
3759 (defsubst org-cmp-priority (a b)
3760 "Compare the priorities of string a and b."
3761 (let ((pa (or (get-text-property 1 'priority a) 0))
3762 (pb (or (get-text-property 1 'priority b) 0)))
3763 (cond ((> pa pb) +1)
3767 (defsubst org-cmp-category (a b)
3768 "Compare the string values of categories of strings a and b."
3769 (let ((ca (or (get-text-property 1 'category a) ""))
3770 (cb (or (get-text-property 1 'category b) "")))
3771 (cond ((string-lessp ca cb) -1)
3772 ((string-lessp cb ca) +1)
3775 (defsubst org-cmp-time (a b)
3776 "Compare the time-of-day values of strings a and b."
3777 (let* ((def (if org-sort-agenda-notime-is-late 2401 -1))
3778 (ta (or (get-text-property 1 'time-of-day a) def))
3779 (tb (or (get-text-property 1 'time-of-day b) def)))
3780 (cond ((< ta tb) -1)
3784 (defun org-entries-lessp (a b)
3785 "Predicate for sorting agenda entries."
3786 (let* ((time-up (org-cmp-time a b))
3787 (time-down (if time-up (- time-up) nil))
3788 (priority-up (org-cmp-priority a b))
3789 (priority-down (if priority-up (- priority-up) nil))
3790 (category-up (org-cmp-category a b))
3791 (category-down (if category-up (- category-up) nil))
3792 (category-keep (if category-up +1 nil))) ; FIXME +1 or -1?
3794 (eval (cons 'or org-agenda-sorting-strategy))
3795 '((-1 . t) (1 . nil) (nil . nil))))))
3797 (defun org-agenda-show-priority ()
3798 "Show the priority of the current item.
3799 This priority is composed of the main priority given with the [#A] cookies,
3800 and by additional input from the age of a schedules or deadline entry."
3802 (let* ((pri (get-text-property (point-at-bol) 'priority)))
3803 (message "Priority is %d" (if pri pri -1000))))
3806 (defun org-agenda-goto ()
3807 "Go to the Org-mode file which contains the item at point."
3809 (let* ((marker (or (get-text-property (point) 'org-marker)
3810 (org-agenda-error)))
3811 (buffer (marker-buffer marker))
3812 (pos (marker-position marker)))
3813 (switch-to-buffer-other-window buffer)
3816 (org-show-hidden-entry)
3818 (and (outline-next-heading)
3819 (org-flag-heading nil))))) ; show the next heading
3821 (defun org-agenda-switch-to ()
3822 "Go to the Org-mode file which contains the item at point."
3824 (let* ((marker (or (get-text-property (point) 'org-marker)
3825 (org-agenda-error)))
3826 (buffer (marker-buffer marker))
3827 (pos (marker-position marker)))
3828 (switch-to-buffer buffer)
3829 (delete-other-windows)
3832 (org-show-hidden-entry)
3834 (and (outline-next-heading)
3835 (org-flag-heading nil))))) ; show the next heading
3837 (defun org-agenda-goto-mouse (ev)
3838 "Go to the Org-mode file which contains the deadline at the mouse click."
3840 (mouse-set-point ev)
3843 (defun org-agenda-show ()
3844 "Display the Org-mode file which contains the item at point."
3846 (let ((win (selected-window)))
3848 (select-window win)))
3850 (defun org-agenda-recenter (arg)
3851 "Display the Org-mode file which contains the item at point and recenter."
3853 (let ((win (selected-window)))
3856 (select-window win)))
3858 (defun org-agenda-show-mouse (ev)
3859 "Display the Org-mode file which contains the deadline at the mouse click."
3861 (mouse-set-point ev)
3864 (defun org-agenda-error ()
3865 (error "Command not allowed in this line."))
3867 (defun org-agenda-todo ()
3868 "Cycle TODO state of line at point, also in Org-mode file."
3870 (let* ((props (text-properties-at (point)))
3871 (col (current-column))
3872 (marker (or (get-text-property (point) 'org-marker)
3873 (org-agenda-error)))
3874 (pl (get-text-property (point-at-bol) 'prefix-length))
3875 (buffer (marker-buffer marker))
3876 (pos (marker-position marker))
3877 (buffer-read-only nil)
3883 (org-show-hidden-entry)
3885 (and (outline-next-heading)
3886 (org-flag-heading nil))) ; show the next heading
3888 (setq newhead (org-get-heading)))
3889 (beginning-of-line 1)
3891 (if (looking-at ".*")
3893 (replace-match newhead t t)
3894 (move-to-column col)
3895 (add-text-properties (point-at-bol) (point-at-eol) props)
3896 (beginning-of-line 1))
3897 (error "Line update did not work"))))
3899 (defun org-agenda-priority-up ()
3900 "Increase the priority of line at point, also in Org-mode file."
3902 (org-agenda-priority 'up))
3904 (defun org-agenda-priority-down ()
3905 "Decrease the priority of line at point, also in Org-mode file."
3907 (org-agenda-priority 'down))
3909 (defun org-agenda-priority (&optional force-direction)
3910 "Set the priority of line at point, also in Org-mode file."
3912 (let* ((props (text-properties-at (point)))
3913 (col (current-column))
3914 (marker (or (get-text-property (point) 'org-marker)
3915 (org-agenda-error)))
3916 (pl (get-text-property (point-at-bol) 'prefix-length))
3917 (buffer (marker-buffer marker))
3918 (pos (marker-position marker))
3919 (buffer-read-only nil)
3925 (org-show-hidden-entry)
3927 (and (outline-next-heading)
3928 (org-flag-heading nil))) ; show the next heading
3929 (funcall 'org-priority force-direction)
3930 (setq newhead (org-get-heading)))
3931 (beginning-of-line 1)
3933 (if (looking-at ".*")
3935 (replace-match (concat newhead) t t)
3936 (move-to-column col)
3937 (add-text-properties (point-at-bol) (point-at-eol) props)
3938 (beginning-of-line 1))
3939 (error "Line update did not work"))))
3941 (defun org-agenda-date-later (arg &optional what)
3942 "Change the date of this item to one day later."
3944 (let* ((marker (or (get-text-property (point) 'org-marker)
3945 (org-agenda-error)))
3946 (buffer (marker-buffer marker))
3947 (pos (marker-position marker)))
3952 (if (not (org-at-timestamp-p))
3953 (error "Cannot find time stamp"))
3954 (org-timestamp-change arg (or what 'day))
3955 (message "Time stamp changed to %s" org-last-changed-timestamp))))
3957 (defun org-agenda-date-earlier (arg &optional what)
3958 "Change the date of this item to one day earlier."
3960 (org-agenda-date-later (- arg) what))
3962 (defun org-agenda-date-today (arg)
3963 "Change the date of this item to one day later."
3965 (let* ((marker (or (get-text-property (point) 'org-marker)
3966 (org-agenda-error)))
3967 (buffer (marker-buffer marker))
3968 (pos (marker-position marker)))
3973 (if (not (org-at-timestamp-p))
3974 (error "Cannot find time stamp"))
3975 (org-time-stamp nil)
3976 (message "Time stamp changed to %s" org-last-changed-timestamp))))
3978 (defun org-get-heading ()
3979 "Return the heading of the current entry, without the stars."
3981 (if (and (re-search-backward "[\r\n]\\*" nil t)
3982 (looking-at "[\r\n]\\*+[ \t]+\\(.*\\)"))
3986 (defun org-agenda-diary-entry (arg)
3987 "Make a diary entry, like the `i' command from the calendar.
3988 All the standard commands work: block, weekly etc"
3990 (require 'diary-lib)
3992 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
3993 (read-char-exclusive)))
3994 (cmd (cdr (assoc char
3995 '((?d . insert-diary-entry)
3996 (?w . insert-weekly-diary-entry)
3997 (?m . insert-monthly-diary-entry)
3998 (?y . insert-yearly-diary-entry)
3999 (?a . insert-anniversary-diary-entry)
4000 (?b . insert-block-diary-entry)
4001 (?c . insert-cyclic-diary-entry)))))
4002 (oldf (symbol-function 'calendar-cursor-to-date))
4004 (mark (or (mark t) (point))))
4006 (error "No command associated with <%c>" char))
4007 (unless (and (get-text-property point 'day)
4008 (or (not (equal ?b char))
4009 (get-text-property mark 'day)))
4010 (error "Don't know which date to use for diary entry"))
4011 ;; We implememnt this by hacking the `calendar-cursor-to-date' function
4012 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
4013 (let ((calendar-mark-ring
4014 (list (calendar-gregorian-from-absolute
4015 (or (get-text-property mark 'day)
4016 (get-text-property point 'day))))))
4019 (fset 'calendar-cursor-to-date
4020 (lambda (&optional error)
4021 (calendar-gregorian-from-absolute
4022 (get-text-property point 'day))))
4023 (call-interactively cmd))
4024 (fset 'calendar-cursor-to-date oldf)))))
4028 (defun org-find-file-at-mouse (ev)
4029 "Open file link or URL at mouse."
4031 (mouse-set-point ev)
4032 (org-open-at-point 'in-emacs))
4034 (defun org-open-at-mouse (ev)
4035 "Open file link or URL at mouse."
4037 (mouse-set-point ev)
4038 (org-open-at-point))
4040 (defun org-open-at-point (&optional in-emacs)
4041 "Open link at or after point.
4042 If there is no link at point, this function will search forward up to
4043 the end of the current subtree.
4044 Normally, files will be opened by an appropriate application. If the
4045 optional argument IN-EMACS is non-nil, Emacs will visit the file."
4047 (if (org-at-timestamp-p)
4048 (org-agenda nil (time-to-days (org-time-string-to-time
4049 (substring (match-string 1) 0 10)))
4051 (let (type path line (pos (point)))
4053 (skip-chars-backward
4054 (if org-allow-space-in-links "^\t\n\r" "^ \t\n\r"))
4055 (if (re-search-forward
4059 (progn (outline-end-of-subtree) (max pos (point)))
4060 (error (end-of-line 1) (point))))
4062 (setq type (match-string 1)
4063 path (match-string 2)))
4065 (error "No link found."))
4066 ;; Remove any trailing spaces in path
4067 (if (string-match " +\\'" path)
4068 (setq path (replace-match "" t t path)))
4072 ((string= type "file")
4073 (if (string-match ":\\([0-9]+\\)\\'" path)
4074 (setq line (string-to-number (match-string 1 path))
4075 path (substring path 0 (match-beginning 0))))
4076 (org-open-file path in-emacs line))
4078 ((string= type "news")
4079 (org-follow-gnus-link path))
4081 ((string= type "bbdb")
4082 (org-follow-bbdb-link path))
4084 ((string= type "gnus")
4085 (let (group article)
4086 (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
4087 (error "Error in Gnus link"))
4088 (setq group (match-string 1 path)
4089 article (match-string 3 path))
4090 (org-follow-gnus-link group article)))
4092 ((string= type "vm")
4093 (let (folder article)
4094 (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
4095 (error "Error in VM link"))
4096 (setq folder (match-string 1 path)
4097 article (match-string 3 path))
4098 ;; in-emacs is the prefix arg, will be interpreted as read-only
4099 (org-follow-vm-link folder article in-emacs)))
4101 ((string= type "wl")
4102 (let (folder article)
4103 (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
4104 (error "Error in Wanderlust link"))
4105 (setq folder (match-string 1 path)
4106 article (match-string 3 path))
4107 (org-follow-wl-link folder article)))
4109 ((string= type "rmail")
4110 (let (folder article)
4111 (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
4112 (error "Error in RMAIL link"))
4113 (setq folder (match-string 1 path)
4114 article (match-string 3 path))
4115 (org-follow-rmail-link folder article)))
4117 ((string= type "shell")
4119 (if (or (not org-confirm-shell-links)
4120 (yes-or-no-p (format "Execute \"%s\" in the shell? " cmd)))
4125 (browse-url-at-point)))))))
4127 (defun org-follow-bbdb-link (name)
4128 "Follow a BBDB link to NAME."
4130 ;; First try an exact match
4131 (bbdb-name (concat "\\`" name "\\'") nil)
4132 (if (= 0 (buffer-size (get-buffer "*BBDB*")))
4133 ;; No exact match - try partial match
4134 (bbdb-name name nil)))
4136 (defun org-follow-gnus-link (&optional group article)
4137 "Follow a Gnus link to GROUP and ARTICLE."
4139 (funcall (cdr (assq 'gnus org-link-frame-setup)))
4140 (if group (gnus-fetch-group group))
4142 (or (gnus-summary-goto-article article nil 'force)
4143 (if (fboundp 'gnus-summary-insert-cached-articles)
4145 (gnus-summary-insert-cached-articles)
4146 (gnus-summary-goto-article article nil 'force))
4147 (message "Message could not be found.")))))
4148 ;; (if article (gnus-summary-goto-article article nil 'force)))
4150 (defun org-follow-vm-link (&optional folder article readonly)
4151 "Follow a VM link to FOLDER and ARTICLE."
4153 (if (string-match "^//\\([a-zA-Z]+@\\)?\\([^:]+\\):\\(.*\\)" folder)
4154 ;; ange-ftp or efs or tramp access
4155 (let ((user (or (match-string 1 folder) (user-login-name)))
4156 (host (match-string 2 folder))
4157 (file (match-string 3 folder)))
4160 ;; use tramp to access the file
4162 (setq folder (format "[%s@%s]%s" user host file))
4163 (setq folder (format "/%s@%s:%s" user host file))))
4165 ;; use ange-ftp or efs
4166 (require (if org-xemacs-p 'efs 'ange-ftp))
4167 (setq folder (format "/%s@%s:%s" user host file))))))
4169 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
4172 (vm-select-folder-buffer)
4174 (let ((case-fold-search t))
4175 (goto-char (point-min))
4176 (if (not (re-search-forward
4177 (concat "^" "message-id: *" (regexp-quote article))))
4178 (error "Could not find the specified message in this folder"))
4181 (vm-beginning-of-message)
4184 (defun org-follow-wl-link (folder article)
4185 "Follow a Wanderlust link to FOLDER and ARTICLE."
4186 (wl-summary-goto-folder-subr folder 'no-sync t nil t)
4187 (if article (wl-summary-jump-to-msg-by-message-id article))
4188 (wl-summary-redisplay))
4190 (defun org-follow-rmail-link (folder article)
4191 "Follow an RMAIL link to FOLDER and ARTICLE."
4192 (let (message-number)
4194 (save-window-excursion
4195 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
4196 (setq message-number
4199 (goto-char (point-max))
4200 (if (re-search-backward
4201 (concat "^Message-ID:\\s-+" (regexp-quote
4204 (rmail-what-message))))))
4207 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
4208 (rmail-show-message message-number)
4210 (error "Message not found"))))
4212 (defun org-open-file (path &optional in-emacs line)
4213 "Open the file at PATH.
4214 First, this expands any special file name abbreviations. Then the
4215 configuration variable `org-file-apps' is checked if it contains an
4216 entry for this file type, and if yes, the corresponding command is launched.
4217 If no application is found, Emacs simply visits the file.
4218 With optional argument IN-EMACS, Emacs will visit the file.
4219 If the file does not exist, an error is thrown."
4220 (let* ((file (convert-standard-filename (org-expand-file-name path)))
4221 (dfile (downcase file))
4223 (if (and (not (file-exists-p file))
4224 (not org-open-non-existing-files))
4225 (error "No such file: %s" file))
4226 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
4227 (setq ext (match-string 1 dfile))
4228 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
4229 (setq ext (match-string 1 dfile))))
4230 (setq apps (append org-file-apps (org-default-apps)))
4233 (setq cmd (or (cdr (assoc ext apps))
4234 (cdr (assoc t apps)))))
4236 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
4237 (setq cmd (format cmd file))
4238 (save-window-excursion
4239 (shell-command (concat cmd " & &"))))
4242 (funcall (cdr (assq 'file org-link-frame-setup)) file)
4243 (if line (goto-line line)))
4246 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))))
4248 (defun org-default-apps ()
4249 "Return the default applications for this operating system."
4251 ((eq system-type 'darwin)
4252 org-file-apps-defaults-macosx)
4253 ((eq system-type 'windows-nt)
4254 org-file-apps-defaults-windowsnt)
4255 ((eq system-type 'linux)
4256 org-file-apps-defaults-linux)
4257 (t org-file-apps-defaults-linux)))
4259 (defun org-expand-file-name (path)
4260 "Replace special path abbreviations and expand the file name."
4261 (expand-file-name path))
4264 (defvar org-insert-link-history nil
4265 "Minibuffer history for links inserted with `org-insert-link'.")
4267 (defvar org-stored-links nil
4268 "Contains the links stored with `org-store-link'.")
4271 (defun org-store-link (arg)
4272 "\\<org-mode-map>Store an org-link to the current location.
4273 This link can later be inserted into an org-buffer with
4274 \\[org-insert-link].
4275 For some link types, a prefix arg is interpreted:
4276 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
4277 For file links, arg negates `org-line-numbers-in-file-links'."
4282 ((eq major-mode 'bbdb-mode)
4283 (setq link (concat "bbdb:"
4284 (bbdb-record-name (bbdb-current-record)))))
4286 ((eq major-mode 'calendar-mode)
4287 (let ((cd (calendar-cursor-to-date)))
4290 (car org-time-stamp-formats)
4292 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
4295 ((or (eq major-mode 'vm-summary-mode)
4296 (eq major-mode 'vm-presentation-mode))
4297 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
4298 (vm-follow-summary-cursor)
4300 (vm-select-folder-buffer)
4301 (let* ((message (car vm-message-pointer))
4302 (folder (buffer-file-name))
4303 (subject (vm-su-subject message))
4304 (author (vm-su-full-name message))
4305 (address (vm-su-from message))
4306 (message-id (vm-su-message-id message)))
4307 (setq folder (abbreviate-file-name folder))
4308 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
4310 (setq folder (replace-match "" t t folder)))
4311 (setq cpltxt (concat author " on: " subject))
4312 (setq link (concat cpltxt "\n " "vm:" folder
4315 ((eq major-mode 'wl-summary-mode)
4316 (let* ((msgnum (wl-summary-message-number))
4317 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
4318 msgnum 'message-id))
4319 (wl-message-entity (elmo-msgdb-overview-get-entity
4320 msgnum (wl-summary-buffer-msgdb)))
4321 (author (wl-summary-line-from)) ; FIXME: how to get author name?
4322 (subject "???")) ; FIXME: How to get subject of email?
4323 (setq cpltxt (concat author " on: " subject))
4324 (setq link (concat cpltxt "\n " "wl:" wl-summary-buffer-folder-name
4327 ((eq major-mode 'rmail-mode)
4330 (rmail-narrow-to-non-pruned-header)
4331 (let ((folder (buffer-file-name))
4332 (message-id (mail-fetch-field "message-id"))
4333 (author (mail-fetch-field "from"))
4334 (subject (mail-fetch-field "subject")))
4335 (setq cpltxt (concat author " on: " subject))
4336 (setq link (concat cpltxt "\n " "rmail:" folder
4337 "#" message-id))))))
4339 ((eq major-mode 'gnus-group-mode)
4340 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
4341 (gnus-group-group-name)) ; version
4342 ((fboundp 'gnus-group-name)
4345 (if (org-xor arg org-usenet-links-prefer-google)
4346 (setq link (format "http://groups.google.com/groups?group=%s"
4348 (setq link (concat "gnus:" group)))))
4350 ((or (eq major-mode 'gnus-summary-mode)
4351 (eq major-mode 'gnus-article-mode))
4352 (gnus-article-show-summary)
4353 (gnus-summary-beginning-of-article)
4354 (let* ((group (car gnus-article-current))
4355 (article (cdr gnus-article-current))
4356 (header (gnus-summary-article-header article))
4357 (author (mail-header-from header))
4358 (message-id (mail-header-id header))
4359 (date (mail-header-date header))
4360 (subject (gnus-summary-subject-string)))
4361 (setq cpltxt (concat author " on: " subject))
4362 (if (org-xor arg org-usenet-links-prefer-google)
4366 (format "http://groups.google.com/groups?as_umsgid=%s"
4367 (org-fixup-message-id-for-http message-id))))
4368 (setq link (concat cpltxt "\n" "gnus:" group
4369 "#" (number-to-string article))))))
4371 ((eq major-mode 'w3-mode)
4372 (setq link (url-view-url t)))
4373 ((eq major-mode 'w3m-mode)
4374 (setq link w3m-current-url))
4377 ;; Just link to this file here.
4378 (setq link (concat "file:"
4379 (abbreviate-file-name (buffer-file-name))))
4380 ;; Add the line number?
4381 (if (org-xor org-line-numbers-in-file-links arg)
4385 (+ (if (bolp) 1 0) (count-lines
4386 (point-min) (point))))))))
4388 (error "Cannot link to a buffer which is not visiting a file"))
4389 (t (setq link nil)))
4391 (if (and (interactive-p) link)
4393 (setq org-stored-links
4394 (cons (cons (or cpltxt link) link) org-stored-links))
4395 (message "Stored: %s" (or cpltxt link)))
4398 (defun org-xor (a b)
4403 (defun org-get-header (header)
4404 "Find a header field in the current buffer."
4406 (goto-char (point-min))
4407 (let ((case-fold-search t) s)
4410 (if (re-search-forward "^From:\\s-+\\(.*\\)" nil t)
4411 (setq s (match-string 1)))
4412 (while (string-match "\"" s)
4413 (setq s (replace-match "" t t s)))
4414 (if (string-match "[<(].*" s)
4415 (setq s (replace-match "" t t s))))
4416 ((eq header 'message-id)
4417 (if (re-search-forward "^message-id:\\s-+\\(.*\\)" nil t)
4418 (setq s (match-string 1))))
4419 ((eq header 'subject)
4420 (if (re-search-forward "^subject:\\s-+\\(.*\\)" nil t)
4421 (setq s (match-string 1)))))
4422 (if (string-match "\\`[ \t\]+" s) (setq s (replace-match "" t t s)))
4423 (if (string-match "[ \t\]+\\'" s) (setq s (replace-match "" t t s)))
4427 (defun org-fixup-message-id-for-http (s)
4428 "Replace special characters in a message id, so that it can be used
4430 (while (string-match "<" s)
4431 (setq s (replace-match "%3C" t t s)))
4432 (while (string-match ">" s)
4433 (setq s (replace-match "%3E" t t s)))
4434 (while (string-match "@" s)
4435 (setq s (replace-match "%40" t t s)))
4438 (defun org-insert-link (&optional complete-file)
4439 "Insert a link. At the prompt, enter the link.
4441 Completion can be used to select a link previously stored with
4442 `org-store-link'. When the empty string is entered (i.e. if you just
4443 press RET at the prompt), the link defaults to the most recently
4446 With a C-u prefix, prompts for a file to link to. The file name can be
4447 selected using completion. The path to the file will be relative to
4448 the current directory if the file is in the current directory or a
4449 subdirectory. Otherwise, the link will be the absolute path as
4450 completed in the minibuffer (i.e. normally ~/path/to/file).
4452 With two C-u prefixes, enforce an absolute path even if the file
4453 is in the current directory or below."
4455 (let ((link (if complete-file
4456 (read-file-name "File: ")
4458 "Link: " org-stored-links nil nil nil
4459 org-insert-link-history
4460 (or (car (car org-stored-links))))))
4462 (if (or (not link) (equal link ""))
4463 (error "No links available"))
4465 (let ((pwd (file-name-as-directory (expand-file-name "."))))
4467 ((equal complete-file '(16))
4468 (insert "file:" (abbreviate-file-name (expand-file-name link))))
4469 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
4470 (expand-file-name link))
4471 (insert "file:" (match-string 1 (expand-file-name link))))
4472 (t (insert "file:" link))))
4473 (setq linktxt (cdr (assoc link org-stored-links)))
4474 (if (not org-keep-stored-link-after-insertion)
4475 (setq org-stored-links (delq (assoc link org-stored-links)
4477 (let ((lines (org-split-string (or linktxt link) "\n")))
4478 (insert (car lines))
4479 (setq matched (string-match org-link-regexp (car lines)))
4480 (setq lines (cdr lines))
4484 (beginning-of-line 0)
4485 (looking-at "[ \t]+\\S-"))
4487 (setq matched (or matched
4488 (string-match org-link-regexp (car lines))))
4489 (insert (car lines))
4490 (setq lines (cdr lines))))
4492 (error "Add link type: http(s),ftp,mailto,file,news,bbdb,vm,wl,rmail,gnus, or shell")))))
4494 ;;; Hooks for remember.el
4496 (defun org-remember-annotation ()
4497 "Return a link to the current location as an annotation for remember.el.
4498 If you are using Org-mode files as target for data storage with
4499 remember.el, then the annotations should include a link compatible with the
4500 conventions in Org-mode. This function returns such a link."
4501 (org-store-link nil))
4503 (defconst org-remember-help
4504 "Select a destination location for the note.
4505 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
4506 RET at beg-of-buf -> Append to file as level 2 headline
4507 RET on headline -> Store as sublevel entry to current headline
4508 <left>/<right> -> before/after current headline, same headings level")
4510 ;; FIXME: Document C-u C-c C-c
4512 (defun org-remember-handler ()
4513 "Store stuff from remember.el into an org file.
4514 First prompts for an org file. If the user just presses return, the value
4515 of `org-default-notes-file' is used.
4516 Then the command offers the headings tree of the selected file in order to
4517 file the text at a specific location.
4518 You can either immediately press RET to get the note appended to the
4519 file. Or you can use vertical cursor motion and visibility cycling (TAB) to
4520 find a better place. Then press RET or <left> or <right> in insert the note.
4522 Key Cursor position Note gets inserted
4523 -----------------------------------------------------------------------------
4524 RET buffer-start as level 2 heading at end of file
4525 RET on headline as sublevel of the heading at cursor
4526 RET no heading at cursor position, level taken from context.
4527 Or use prefix arg to specify level manually.
4528 <left> on headline as same level, before current heading
4529 <right> on headline as same level, after current heading
4531 So the fastest way to store the note is to press RET RET to append it to
4532 the default file. This way your current train of thought is not
4533 interrupted, in accordance with the principles of remember.el. But with
4534 little extra effort, you can push it directly to the correct location.
4536 Before being stored away, the function ensures that the text has a
4537 headline, i.e. a first line that starts with a \"*\". If not, a headline
4538 is constructed from the current date and some additional data.
4540 If the variable `org-adapt-indentation' is non-nil, the entire text is
4541 also indented so that it starts in the same column as the headline
4542 \(i.e. after the stars).
4544 See also the variable `org-reverse-note-order'."
4546 (let* ((txt (buffer-substring (point-min) (point-max)))
4547 (fastp current-prefix-arg)
4548 (file (if fastp org-default-notes-file (org-get-org-file)))
4549 (visiting (find-buffer-visiting file))
4550 (org-startup-with-deadline-check nil)
4551 (org-startup-folded nil)
4552 spos level indent reversed)
4553 ;; Modify text so that it becomes a nice subtree which can be inserted
4554 ;; into an org tree.
4555 (let* ((lines (split-string txt "\n"))
4557 (lines (cdr lines)))
4558 (if (string-match "^\\*+" first)
4559 ;; Is already a headline
4560 (setq indent (make-string (- (match-end 0) (match-beginning 0)
4562 ;; We need to add a headline: Use time and first buffer line
4563 (setq lines (cons first lines)
4564 first (concat "* " (current-time-string)
4565 " (" (remember-buffer-desc) ")")
4567 (if org-adapt-indentation
4568 (setq lines (mapcar (lambda (x) (concat indent x)) lines)))
4569 (setq txt (concat first "\n"
4570 (mapconcat 'identity lines "\n"))))
4573 (find-file-noselect file))
4575 (set-buffer (get-file-buffer file))
4576 (setq reversed (org-notes-order-reversed-p))
4580 ;; Ask the User for a location
4581 (setq spos (if fastp 1 (org-get-location
4583 org-remember-help)))
4584 (if (not spos) (throw 'quit nil)) ; return nil to show we did
4585 ; not handle this note
4588 ;; Put it at the start or end, as level 2
4591 (goto-char (if reversed (point-min) (point-max)))
4592 (if (not (bolp)) (newline))
4593 (org-paste-subtree (or current-prefix-arg 2) txt)))
4594 ((and (org-on-heading-p nil) (not current-prefix-arg))
4595 ;; Put it below this entry, at the beg/end of the subtree
4596 (org-back-to-heading)
4597 (setq level (outline-level))
4599 (outline-end-of-heading)
4600 (outline-end-of-subtree))
4601 (if (not (bolp)) (newline))
4602 (beginning-of-line 1)
4603 (org-paste-subtree (1+ level) txt))
4605 ;; Put it right there, with automatic level determined by
4606 ;; org-paste-subtree or from prefix arg
4607 (org-paste-subtree current-prefix-arg txt)))
4608 (when remember-save-after-remembering
4610 (if (not visiting) (kill-buffer (current-buffer)))))))))
4611 t) ;; return t to indicate that we took care of this note.
4613 (defun org-get-org-file ()
4614 "Read a filename, with default directory `org-directory'."
4615 (let ((default (or org-default-notes-file remember-data-file)))
4616 (read-file-name (format "File name [%s]: " default)
4617 (file-name-as-directory org-directory)
4620 (defun org-notes-order-reversed-p ()
4621 "Check if the current file should receive notes in reversed order."
4623 ((not org-reverse-note-order) nil)
4624 ((eq t org-reverse-note-order) t)
4625 ((not (listp org-reverse-note-order)) nil)
4627 (let ((all org-reverse-note-order)
4629 (while (setq entry (pop all))
4630 (if (string-match (car entry) (buffer-file-name))
4631 (throw 'exit (cdr entry))))
4636 ;; Watch out: Here we are talking about two different kind of tables.
4637 ;; Most of the code is for the tables created with the Org-mode table editor.
4638 ;; Sometimes, we talk about tables created and edited with the table.el
4639 ;; Emacs package. We call the former org-type tables, and the latter
4640 ;; table.el-type tables.
4642 ;; We use a before-change function to check if a table might need
4644 (defvar org-table-may-need-update t
4645 "Indicates of a table might need an update.
4646 This variable is set by `org-before-change-function'. `org-table-align'
4647 sets it back to nil.")
4649 (defun org-before-change-function (beg end)
4650 "Every change indicates that a table might need an update."
4651 (setq org-table-may-need-update t))
4653 (defconst org-table-line-regexp "^[ \t]*|"
4654 "Detects an org-type table line.")
4655 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
4656 "Detects an org-type table line.")
4657 (defconst org-table-hline-regexp "^[ \t]*|-"
4658 "Detects an org-type table hline.")
4659 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
4660 "Detects a table-type table hline.")
4661 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
4662 "Detects an org-type or table-type table")
4663 (defconst org-table-border-regexp "^[ \t]*[^| \t]"
4664 "Searching from within a table (any type) this finds the first line
4665 outside the table.")
4666 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
4667 "Searching from within a table (any type) this finds the first line
4668 outside the table.")
4670 (defun org-table-create-with-table.el ()
4671 "Use the table.el package to insert a new table.
4672 If there is already a table at point, convert between Org-mode tables
4673 and table.el tables."
4677 ((org-at-table.el-p)
4678 (if (y-or-n-p "Convert table to Org-mode table? ")
4679 (org-table-convert)))
4681 (if (y-or-n-p "Convert table to table.el table? ")
4682 (org-table-convert)))
4683 (t (call-interactively 'table-insert))))
4685 (defun org-table-create (&optional size)
4686 "Query for a size and insert a table skeleton.
4687 SIZE is a string Columns x Rows like for example \"3x2\"."
4690 (setq size (read-string
4691 (concat "Table size Columns x Rows [e.g. "
4692 org-table-default-size "]: ")
4693 "" nil org-table-default-size)))
4695 (let* ((pos (point))
4696 (indent (make-string (current-column) ?\ ))
4697 (split (org-split-string size " *x *"))
4698 (rows (string-to-number (nth 1 split)))
4699 (columns (string-to-number (car split)))
4700 (line (concat (apply 'concat indent "|" (make-list columns " |"))
4702 (if (string-match "^[ \t]*$" (buffer-substring-no-properties
4703 (point-at-bol) (point)))
4704 (beginning-of-line 1)
4706 (mapcar (lambda (x) (insert line)) (make-list rows t))
4709 ;; Insert a hline after the first row.
4716 (defun org-table-convert-region (beg0 end0 nspace)
4717 "Convert region to a table.
4718 The region goes from BEG0 to END0, but these borders will be moved
4719 slightly, to make sure a beginning of line in the first line is included.
4720 When NSPACE is non-nil, it indicates the minimum number of spaces that
4721 separate columns (default: just one space)"
4722 (let* ((beg (min beg0 end0))
4723 (end (max beg0 end0))
4727 (beginning-of-line 1)
4728 (setq beg (move-marker (make-marker) (point)))
4730 (if (bolp) (backward-char 1) (end-of-line 1))
4731 (setq end (move-marker (make-marker) (point)))
4732 ;; Lets see if this is tab-separated material. If every nonempty line
4733 ;; contains a tab, we will assume that it is tab-separated material
4737 (and (re-search-forward "^[^\n\t]+$" end t) (setq tabsep nil)))
4738 (if nspace (setq tabsep nil))
4741 (setq re (format "^ *\\| *\t *\\| \\{%d,\\}"
4742 (max 1 (prefix-numeric-value nspace)))))
4744 (while (re-search-forward re end t)
4745 (replace-match "|" t t))
4750 (defun org-table-import (file arg)
4751 "Import FILE as a table.
4752 The file is assumed to be tab-separated. Such files can be produced by most
4753 spreadsheet and database applications. If no tabs (at least one per line)
4754 are found, lines will be split on whitespace into fields."
4755 (interactive "f\nP")
4756 (or (bolp) (newline))
4759 (insert-file-contents file)
4760 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
4762 (defun org-table-export ()
4763 "Export table as a tab-separated file.
4764 Such a file can be imported into a spreadsheet program like Excel."
4766 (let* ((beg (org-table-begin))
4767 (end (org-table-end))
4768 (table (buffer-substring beg end))
4769 (file (read-file-name "Export table to: "))
4771 (unless (or (not (file-exists-p file))
4772 (y-or-n-p (format "Overwrite file %s? " file)))
4776 (setq buf (current-buffer))
4780 (goto-char (point-min))
4781 (while (re-search-forward "^[ \t]*|[ \t]*" nil t)
4782 (replace-match "" t t)
4784 (goto-char (point-min))
4785 (while (re-search-forward "[ \t]*|[ \t]*$" nil t)
4786 (replace-match "" t t)
4787 (goto-char (min (1+ (point)) (point-max))))
4788 (goto-char (point-min))
4789 (while (re-search-forward "^-[-+]*$" nil t)
4791 (if (looking-at "\n")
4793 (goto-char (point-min))
4794 (while (re-search-forward "[ \t]*|[ \t]*" nil t)
4795 (replace-match "\t" t t))
4799 (defun org-table-align (&optional arg)
4800 "Align the table at point by aligning all vertical bars."
4804 (beg (org-table-begin))
4805 (end (org-table-end))
4806 ;; Current cursor position
4807 (linepos (+ (if (bolp) 1 0) (count-lines (point-min) (point))))
4808 (colpos (org-table-current-column))
4809 (winstart (window-start))
4810 text lines (new "") lengths l typenums ty fields maxfields i
4812 (indent "") cnt frac
4814 (spaces (if (org-in-invisibility-spec-p '(org-table))
4815 org-table-spaces-around-invisible-separators
4816 org-table-spaces-around-separators))
4820 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
4822 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
4825 ;; (message "Aligning table...")
4827 (setq lines (org-split-string
4828 (buffer-substring-no-properties beg end) "\n"))
4829 ;; Store the indentation of the first line
4830 (if (string-match "^ *" (car lines))
4831 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
4833 (setq lines (mapcar (lambda (l) (if (string-match "^ *|-" l) nil l))
4835 ;; Get the data fields
4836 (setq fields (mapcar
4838 (org-split-string l " *| *"))
4839 (delq nil (copy-sequence lines))))
4840 ;; How many fields in the longest line?
4842 (setq maxfields (apply 'max (mapcar 'length fields)))
4844 (kill-region beg end)
4845 (org-table-create org-table-default-size)
4846 (error "Empty table - created default table")))
4847 ;; A list of empty string to fill any short rows on output
4848 (setq emptystrings (make-list maxfields ""))
4849 ;; Get the maximum length of a field and the most common datatype
4852 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
4853 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
4855 (push (apply 'max 1 (mapcar 'length column)) lengths)
4856 ;; compute the fraction stepwise, ignoring empty fields
4857 (setq cnt 0 frac 0.0)
4862 (setq frac ( / (+ (* frac cnt)
4863 (if (string-match org-table-number-regexp x) 1 0))
4864 (setq cnt (1+ cnt))))))
4866 (push (>= frac org-table-number-fraction) typenums))
4867 (setq lengths (nreverse lengths)
4868 typenums (nreverse typenums))
4869 ;; Compute the formats needed for output of the table
4870 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
4871 (while (setq l (pop lengths))
4872 (setq ty (if (pop typenums) "" "-")) ; number types flushright
4873 (setq rfmt (concat rfmt (format rfmt1 ty l))
4874 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
4875 (setq rfmt (concat rfmt "\n")
4876 hfmt (concat (substring hfmt 0 -1) "|\n"))
4877 ;; Produce the new table
4879 (setq l (pop lines))
4881 (setq new (concat new (apply 'format rfmt
4882 (append (pop fields) emptystrings))))
4883 (setq new (concat new hfmt))))
4884 ;; Replace the old one
4885 (delete-region beg end)
4886 (move-marker end nil)
4888 ;; Try to move to the old location (approximately)
4890 (set-window-start (selected-window) winstart 'noforce)
4891 (org-table-goto-column colpos)
4892 (setq org-table-may-need-update nil)
4893 ;; (message "Aligning table...done")
4894 (if (org-in-invisibility-spec-p '(org-table))
4895 (org-table-add-invisible-to-vertical-lines))
4898 (defun org-table-begin (&optional table-type)
4899 "Find the beginning of the table and return its position.
4900 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
4902 (if (not (re-search-backward
4903 (if table-type org-table-any-border-regexp
4904 org-table-border-regexp)
4906 (error "Can't find beginning of table")
4907 (goto-char (match-beginning 0))
4908 (beginning-of-line 2)
4911 (defun org-table-end (&optional table-type)
4912 "Find the end of the table and return its position.
4913 With argument TABLE-TYPE, go to the end of a table.el-type table."
4915 (if (not (re-search-forward
4916 (if table-type org-table-any-border-regexp
4917 org-table-border-regexp)
4919 (goto-char (point-max))
4920 (goto-char (match-beginning 0)))
4923 (defun org-table-next-field (&optional arg)
4924 "Go to the next field in the current table.
4925 Before doing so, re-align the table if necessary."
4927 (if (and org-table-automatic-realign
4928 org-table-may-need-update)
4930 (if (org-at-table-hline-p)
4934 (re-search-forward "|" (org-table-end))
4935 (if (looking-at "[ \t]*$")
4936 (re-search-forward "|" (org-table-end)))
4937 (if (looking-at "-")
4939 (beginning-of-line 0)
4940 (org-table-insert-row 'below))
4941 (if (looking-at " ") (forward-char 1))))
4943 (org-table-insert-row 'below))))
4945 (defun org-table-previous-field (&optional arg)
4946 "Go to the previous field in the table.
4947 Before doing so, re-align the table if necessary."
4949 (if (and org-table-automatic-realign
4950 org-table-may-need-update)
4952 (if (org-at-table-hline-p)
4954 (re-search-backward "|" (org-table-begin))
4955 (re-search-backward "|" (org-table-begin))
4956 (while (looking-at "|\\(-\\|[ \t]*$\\)")
4957 (re-search-backward "|" (org-table-begin)))
4958 (if (looking-at "| ?")
4959 (goto-char (match-end 0))))
4961 (defun org-table-next-row (&optional arg)
4962 "Go to the next row (same column) in the current table.
4963 Before doing so, re-align the table if necessary."
4965 (if (or (looking-at "[ \t]*$")
4966 (save-excursion (skip-chars-backward " \t") (bolp)))
4968 (if (and org-table-automatic-realign
4969 org-table-may-need-update)
4971 (let ((col (org-table-current-column)))
4972 (beginning-of-line 2)
4973 (if (or (not (org-at-table-p))
4974 (org-at-table-hline-p))
4976 (beginning-of-line 0)
4977 (org-table-insert-row 'below)))
4978 (org-table-goto-column col)
4979 (skip-chars-backward "^|\n\r")
4980 (if (looking-at " ") (forward-char 1)))))
4982 (defun org-table-copy-from-above (n)
4983 "Copy into the current column the nearest non-empty field from above.
4984 With prefix argument N, take the Nth non-empty field."
4986 (let ((colpos (org-table-current-column))
4987 (beg (org-table-begin))
4989 (org-table-check-inside-data-field)
4993 (while (progn (beginning-of-line 1)
4994 (re-search-backward org-table-dataline-regexp
4996 (org-table-goto-column colpos t)
4997 (if (and (looking-at
4998 "|[ \t]*\\([^| \t][^|]*[^| \t]\\)[ \t]*|")
4999 (= (setq n (1- n)) 0))
5000 (throw 'exit (match-string 1)))))))
5004 (error "No non-empty field found"))))
5006 (defun org-table-check-inside-data-field ()
5007 "Is point inside a table data field?
5008 I.e. not on a hline or before the first or after the last column?"
5009 (if (or (not (org-at-table-p))
5010 (= (org-table-current-column) 0)
5011 (org-at-table-hline-p)
5012 (looking-at "[ \t]*$"))
5013 (error "Not in table data field")))
5015 (defun org-table-blank-field ()
5016 "Blank the current table field."
5018 (org-table-check-inside-data-field)
5019 (skip-chars-backward "^|")
5021 (if (looking-at "|[^|]+")
5022 (let* ((pos (match-beginning 0))
5023 (match (match-string 0))
5024 (len (length match)))
5025 (replace-match (concat "|" (make-string (1- len) ?\ )))
5026 (goto-char (+ 2 pos))
5027 (substring match 1))))
5029 (defun org-table-get-field (&optional n replace)
5030 "Return the value of the field in column N of current row.
5031 N defaults to current field.
5032 If REPLACE is a string, replace field with this value. The return value
5033 is always the old value."
5034 (and n (org-table-goto-column n))
5035 (skip-chars-backward "^|")
5037 (if (looking-at "|[^|\r\n]*")
5038 (let* ((pos (match-beginning 0))
5039 (len (length (match-string 0)))
5040 (val (buffer-substring (1+ pos) (match-end 0))))
5042 (replace-match (concat "|" replace)))
5043 (goto-char (+ 2 pos))
5046 (defun org-table-current-column ()
5047 "Find out which column we are in.
5048 When called interactively, column is also displayed in echo area."
5050 (if (interactive-p) (org-table-check-inside-data-field))
5052 (let ((cnt 0) (pos (point)))
5053 (beginning-of-line 1)
5054 (while (search-forward "|" pos t)
5055 (setq cnt (1+ cnt)))
5056 (if (interactive-p) (message "This is table column %d" cnt))
5059 (defun org-table-goto-column (n &optional on-delim force)
5060 "Move the cursor to the Nth column in the current table line.
5061 With optional argument ON-DELIM, stop with point before the left delimiter
5063 If there are less than N fields, just go to after the last delimiter.
5064 However, when FORCE is non-nil, create new columns if necessary."
5065 (let ((pos (point-at-eol)))
5066 (beginning-of-line 1)
5068 (while (and (> (setq n (1- n)) -1)
5069 (or (search-forward "|" pos t)
5071 (progn (end-of-line 1)
5072 (skip-chars-backward "^|")
5074 (bachward-char 2) t)))))
5075 (when (and force (not (looking-at ".*|")))
5076 (save-excursion (end-of-line 1) (insert "|")))
5079 (if (looking-at " ") (forward-char 1))))))
5081 (defun org-at-table-p (&optional table-type)
5082 "Return t if the cursor is inside an org-type table."
5083 (if org-enable-table-editor
5085 (beginning-of-line 1)
5086 (looking-at (if table-type org-table-any-line-regexp
5087 org-table-line-regexp)))
5090 (defun org-table-recognize-table.el ()
5091 "If there is a table.el table nearby, recognize it and move into it."
5092 (if org-table-tab-recognizes-table.el
5093 (if (org-at-table.el-p)
5095 (beginning-of-line 1)
5096 (if (looking-at org-table-dataline-regexp)
5098 (if (looking-at org-table1-hline-regexp)
5100 (beginning-of-line 2)
5101 (if (looking-at org-table-any-border-regexp)
5102 (beginning-of-line -1)))))
5103 (if (re-search-forward "|" (org-table-end t) t)
5106 (if (table--at-cell-p (point))
5108 (message "recognizing table.el table...")
5109 (table-recognize-table)
5110 (message "recognizing table.el table...done")))
5111 (error "This should not happen..."))
5116 (defun org-at-table.el-p ()
5117 "Return t if the cursor is inside a table.el-type table."
5119 (if (org-at-table-p 'any)
5121 (goto-char (org-table-begin 'any))
5122 (looking-at org-table1-hline-regexp))
5125 (defun org-at-table-hline-p ()
5126 "Return t if the cursor is inside a hline in a table."
5127 (if org-enable-table-editor
5129 (beginning-of-line 1)
5130 (looking-at org-table-hline-regexp))
5133 (defun org-table-insert-column (&optional arg)
5134 "Insert a new column into the table."
5136 (if (not (org-at-table-p))
5137 (error "Not at a table"))
5138 (org-table-find-dataline)
5139 (let* ((col (max 1 (org-table-current-column)))
5140 (beg (org-table-begin))
5141 (end (org-table-end))
5142 ;; Current cursor position
5143 (linepos (+ (if (bolp) 1 0) (count-lines (point-min) (point))))
5146 (while (< (point) end)
5147 (if (org-at-table-hline-p)
5149 (org-table-goto-column col t)
5151 (beginning-of-line 2))
5152 (move-marker end nil)
5154 (org-table-goto-column colpos))
5157 (defun org-table-find-dataline ()
5158 "Find a dataline in the current table, which is needed for column commands."
5159 (if (and (org-at-table-p)
5160 (not (org-at-table-hline-p)))
5162 (let ((col (current-column))
5163 (end (org-table-end)))
5164 (move-to-column col)
5165 (while (and (< (point) end)
5166 (or (not (= (current-column) col))
5167 (org-at-table-hline-p)))
5168 (beginning-of-line 2)
5169 (move-to-column col))
5170 (if (and (org-at-table-p)
5171 (not (org-at-table-hline-p)))
5174 "Please position cursor in a data line for column operations")))))
5176 (defun org-table-delete-column (&optional arg)
5177 "Insert a new column into the table."
5179 (if (not (org-at-table-p))
5180 (error "Not at a table"))
5181 (org-table-find-dataline)
5182 (org-table-check-inside-data-field)
5183 (let* ((col (org-table-current-column))
5184 (beg (org-table-begin))
5185 (end (org-table-end))
5186 ;; Current cursor position
5187 (linepos (+ (if (bolp) 1 0) (count-lines (point-min) (point))))
5190 (while (< (point) end)
5191 (if (org-at-table-hline-p)
5193 (org-table-goto-column col t)
5194 (and (looking-at "|[^|\n]+|")
5195 (replace-match "|")))
5196 (beginning-of-line 2))
5197 (move-marker end nil)
5199 (org-table-goto-column colpos))
5202 (defun org-table-move-column (&optional left)
5203 "Move the current column to the right. With arg LEFT, move to the left."
5205 (if (not (org-at-table-p))
5206 (error "Not at a table"))
5207 (org-table-find-dataline)
5208 (org-table-check-inside-data-field)
5209 (let* ((col (org-table-current-column))
5210 (col1 (if left (1- col) col))
5211 (beg (org-table-begin))
5212 (end (org-table-end))
5213 ;; Current cursor position
5214 (linepos (+ (if (bolp) 1 0) (count-lines (point-min) (point))))
5215 (colpos (if left (1- col) (1+ col))))
5216 (if (and left (= col 1))
5217 (error "Cannot move column further left"))
5218 (if (and (not left) (looking-at "[^|\n]*|[^|\n]*$"))
5219 (error "Cannot move column further right"))
5221 (while (< (point) end)
5222 (if (org-at-table-hline-p)
5224 (org-table-goto-column col1 t)
5225 (and (looking-at "|\\([^|\n]+\\)|\\([^|\n]+\\)|")
5226 (replace-match "|\\2|\\1|")))
5227 (beginning-of-line 2))
5228 (move-marker end nil)
5230 (org-table-goto-column colpos))
5233 (defun org-table-move-row (&optional up)
5234 "Move the current table line down. With arg UP, move it up."
5236 (let ((col (current-column))
5240 (beginning-of-line tonew)
5241 (if (not (org-at-table-p))
5244 (error "Cannot move row further.")))
5246 (beginning-of-line 1)
5248 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
5249 (delete-region (point) (1+ (point-at-eol)))
5250 (beginning-of-line tonew)
5252 (beginning-of-line 0)
5253 (move-to-column col)))
5255 (defun org-table-insert-row (&optional arg)
5256 "Insert a new row above the current line into the table.
5257 With prefix ARG, insert below the current line."
5259 (if (not (org-at-table-p))
5260 (error "Not at a table"))
5261 (let ((line (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
5262 (if (string-match "^[ \t]*|-" line)
5263 (setq line (mapcar (lambda (x) (if (member x '(?| ?+)) ?| ?\ )) line))
5264 (setq line (mapcar (lambda (x) (if (equal x ?|) ?| ?\ )) line)))
5265 (beginning-of-line (if arg 2 1))
5266 (apply 'insert line)
5268 (beginning-of-line 0)
5269 (re-search-forward "| ?" (point-at-eol) t)
5272 (defun org-table-insert-hline (&optional arg)
5273 "Insert a horizontal-line below the current line into the table.
5274 With prefix ARG, insert above the current line."
5276 (if (not (org-at-table-p))
5277 (error "Not at a table"))
5278 (let ((line (buffer-substring-no-properties (point-at-bol) (point-at-eol)))
5279 (col (current-column))
5281 (if (string-match "^[ \t]*|-" line)
5283 (mapcar (lambda (x) (if (member x '(?| ?+))
5284 (prog1 (if start ?+ ?|) (setq start t))
5288 (mapcar (lambda (x) (if (equal x ?|)
5289 (prog1 (if start ?+ ?|) (setq start t))
5292 (beginning-of-line (if arg 1 2))
5293 (apply 'insert line)
5294 (if (equal (char-before (point)) ?+)
5295 (progn (backward-delete-char 1) (insert "|")))
5297 (beginning-of-line 0)
5298 (move-to-column col)))
5300 (defun org-table-kill-row (&optional arg)
5301 "Delete the current row or horizontal line from the table."
5303 (if (not (org-at-table-p))
5304 (error "Not at a table"))
5305 (let ((col (current-column)))
5306 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
5307 (if (not (org-at-table-p)) (beginning-of-line 0))
5308 (move-to-column col)))
5311 (defun org-table-cut-region (&optional arg)
5312 "Copy region in table to the clipboard and blank all relevant fields."
5314 (org-table-copy-region 'cut))
5316 (defvar org-table-clip nil
5317 "Clipboard for table regions")
5319 (defun org-table-copy-region (&optional cut)
5320 "Copy rectangular region in table to clipboard.
5321 A special clibbooard is used which can only be accessed
5322 with `org-table-paste-rectangle'"
5324 (unless (org-region-active-p) (error "No active region"))
5325 (let* ((beg (region-beginning))
5327 l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
5329 (rpl (if cut " " nil)))
5331 (org-table-check-inside-data-field)
5332 (setq l01 (count-lines (point-min) (point))
5333 c01 (org-table-current-column))
5335 (org-table-check-inside-data-field)
5336 (setq l02 (count-lines (point-min) (point))
5337 c02 (org-table-current-column))
5338 (setq l1 (min l01 l02) l2 (max l01 l02)
5339 c1 (min c01 c02) c2 (max c01 c02))
5343 (if (> l1 l2) (throw 'exit t))
5345 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
5346 (setq cols nil ic1 c1 ic2 c2)
5347 (while (< ic1 (1+ ic2))
5348 (push (org-table-get-field ic1 rpl) cols)
5349 (setq ic1 (1+ ic1)))
5350 (push (nreverse cols) region)
5351 (setq l1 (1+ l1)))))
5352 (setq org-table-clip (nreverse region))
5353 (if cut (org-table-align))))
5355 (defun org-table-paste-rectangle (&optional arg)
5356 "Paste a rectangluar region into a table.
5357 The upper right corner ends up in the current field. All involved fields
5358 will be overwritten. If the rectangle does not fit into the present table,
5359 the table is enlarged as needed. The process ignores horizontal separator
5362 (unless (and org-table-clip (listp org-table-clip))
5363 (error "First cut/copy a region to paste!"))
5364 (org-table-check-inside-data-field)
5365 (let* ((clip org-table-clip)
5366 (line (count-lines (point-min) (point)))
5367 (col (org-table-current-column))
5369 (org-enable-table-editor t)
5370 (org-table-automatic-realign nil)
5372 (while (setq cols (pop clip))
5373 (while (org-at-table-hline-p) (beginning-of-line 2))
5374 (if (not (org-at-table-p))
5375 (progn (end-of-line 0) (org-table-next-field)))
5377 (while (setq field (pop cols))
5378 (org-table-goto-column c nil 'force)
5379 (org-table-get-field nil field)
5381 (beginning-of-line 2))
5383 (org-table-goto-column col)
5386 (defun org-table-convert ()
5387 "Convert from org-mode table to table.el and back.
5388 Obviously, this only works within limits. When an Org-mode table is
5389 converted to table.el, all horizontal separator lines get lost, because
5390 table.el uses these as cell boundaries and has no notion of horizontal lines.
5391 A table.el table can be converted to an Org-mode table only if it does not
5392 do row or column spanning. Multiline cells will become multiple cells.
5393 Beware, Org-mode does not test if the table can be successfully converted - it
5394 blindly applies a recipe that works for simple tables."
5397 (if (org-at-table.el-p)
5398 ;; convert to Org-mode table
5399 (let ((beg (move-marker (make-marker) (org-table-begin t)))
5400 (end (move-marker (make-marker) (org-table-end t))))
5401 (table-unrecognize-region beg end)
5403 (while (re-search-forward "^\\([ \t]*\\)\\+-.*\n" end t)
5406 (if (org-at-table-p)
5407 ;; convert to table.el table
5408 (let ((beg (move-marker (make-marker) (org-table-begin)))
5409 (end (move-marker (make-marker) (org-table-end))))
5410 ;; first, get rid of all horizontal lines
5412 (while (re-search-forward "^\\([ \t]*\\)|-.*\n" end t)
5414 ;; insert a hline before first
5416 (org-table-insert-hline 'above)
5417 ;; insert a hline after each line
5418 (while (progn (beginning-of-line 2) (< (point) end))
5419 (org-table-insert-hline))
5421 (setq end (move-marker end (org-table-end)))
5422 ;; replace "+" at beginning and ending of hlines
5423 (while (re-search-forward "^\\([ \t]*\\)|-" end t)
5424 (replace-match "\\1+-"))
5426 (while (re-search-forward "-|[ \t]*$" end t)
5427 (replace-match "-+"))
5430 (defun org-table-wrap-region (arg)
5431 "Wrap several fields in a column like a paragraph.
5432 This is useful if you'd like to spread the contents of a field over several
5433 lines, in order to keep the table compact.
5435 If there is an active region, and both point and mark are in the same column,
5436 the text in the column is wrapped to minimum width for the given number of
5437 lines. Generally, this makes the table more compact. A prefix ARG may be
5438 used to change the number of desired lines. For example, `C-2 C-c C-q'
5439 formats the selected text to two lines. If the region was longer than 2
5440 lines, the remaining lines remain empty. A negative prefix argument reduces
5441 the current number of lines by that amount. The wrapped text is pasted back
5442 into the table. If you formatted it to more lines than it was before, fields
5443 further down in the table get overwritten - so you might need to make space in
5446 If there is no region, the current field is split at the cursor position and
5447 the text fragment to the right of the cursor is prepended to the field one
5450 If there is no region, but you specify a prefix ARG, the current field gets
5451 blank, and the content is appended to the field above."
5453 (org-table-check-inside-data-field)
5454 (if (org-region-active-p)
5455 ;; There is a region: fill as a paragraph
5456 (let ((beg (region-beginning))
5458 (org-table-cut-region)
5459 (if (> (length (car org-table-clip)) 1)
5460 (error "Region must be limited to single columm"))
5461 (setq nlines (if arg
5463 (+ (length org-table-clip) arg)
5465 (length org-table-clip)))
5466 (setq org-table-clip
5467 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
5470 (org-table-paste-rectangle))
5471 ;; No region, split the current field at point
5473 ;; combine with field above
5474 (let ((s (org-table-blank-field))
5475 (col (org-table-current-column)))
5476 (beginning-of-line 0)
5477 (while (org-at-table-hline-p) (beginning-of-line 0))
5478 (org-table-goto-column col)
5479 (skip-chars-forward "^|")
5480 (skip-chars-backward " ")
5481 (insert " " (org-trim s))
5484 (when (looking-at "\\([^|]+\\)+|")
5485 (let ((s (match-string 1)))
5486 (replace-match " |")
5487 (goto-char (match-beginning 0))
5488 (org-table-next-row)
5489 (insert (org-trim s) " ")
5490 (org-table-align))))))
5493 "Remove whitespace at beginning and end of string."
5494 (if (string-match "^[ \t]+" s) (setq s (replace-match "" t t s)))
5495 (if (string-match "[ \t]+$" s) (setq s (replace-match "" t t s))))
5497 (defun org-wrap (string &optional width lines)
5498 "Wrap string to either a number of lines, or a with in characters.
5499 If WIDTH is non-nil, the string is wrapped to that width, however many lines
5500 that costs. If there is a work longer than WIDTH, the text is actually
5501 wrapped to the length of that word.
5502 IF WIDTH is nil and LINES is non-nil, the string is forced into at mot that
5503 many lines, whatever width that takes.
5504 The return value is a list of lines, without newlines at the end."
5505 (let* ((words (org-split-string string "[ \t\n]+"))
5506 (maxword (apply 'max (mapcar 'length words)))
5507 (black (apply '+ (mapcar 'length words)))
5508 (total (+ black (length words)))
5511 (org-do-wrap words (max maxword width)))
5514 (setq ll (org-do-wrap words maxword))
5515 (if (<= (length ll) lines)
5518 (while (> (length ll) lines)
5520 (setq ll (org-do-wrap words w)))
5522 (t (error "Cannot wrap this")))))
5525 (defun org-do-wrap (words width)
5526 "Creates lines of maximum width WIDTH (in characters) from word list WORDS."
5529 (setq line (pop words))
5530 (while (and words (< (+ (length line) (length (car words))) width))
5531 (setq line (concat line " " (pop words))))
5532 (setq lines (push line lines)))
5535 ;; FIXME: I think I can make this more efficient
5536 (defun org-split-string (string &optional separators)
5537 "Splits STRING into substrings at SEPARATORS.
5538 No empty strings are returned if there are matches at the beginning
5540 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
5544 (while (and (string-match rexp string
5546 (= start (match-beginning 0))
5547 (< start (length string)))
5549 (< (match-beginning 0) (length string)))
5551 (or (eq (match-beginning 0) 0)
5552 (and (eq (match-beginning 0) (match-end 0))
5553 (eq (match-beginning 0) start))
5555 (cons (substring string start (match-beginning 0))
5557 (setq start (match-end 0)))
5558 (or (eq start (length string))
5560 (cons (substring string start)
5564 (defun org-table-add-invisible-to-vertical-lines ()
5565 "Add an `invisible' property to vertical lines of current table."
5567 (let* ((beg (org-table-begin))
5568 (end (org-table-end))
5572 (while (< (point) end)
5573 (setq end1 (point-at-eol))
5574 (if (looking-at org-table-dataline-regexp)
5575 (while (re-search-forward "|" end1 t)
5576 (add-text-properties (1- (point)) (point)
5577 '(invisible org-table)))
5578 (while (re-search-forward "[+|]" end1 t)
5579 (add-text-properties (1- (point)) (point)
5580 '(invisible org-table))))
5581 (beginning-of-line 2)))))
5583 (defun org-table-toggle-vline-visibility (&optional arg)
5584 "Toggle the visibility of table vertical lines.
5585 The effect is immediate and on all tables in the file.
5586 With prefix ARG, make lines invisible when ARG if positive, make lines
5587 visible when ARG is not positive"
5590 ((and arg (> (prefix-numeric-value arg) 0)) 'on)
5591 ((and arg (< (prefix-numeric-value arg) 1)) 'off)
5592 (t (if (org-in-invisibility-spec-p '(org-table))
5595 (if (eq action 'off)
5597 (org-remove-from-invisibility-spec '(org-table))
5598 (org-table-map-tables 'org-table-align)
5599 (message "Vertical table lines visible")
5600 (if (org-at-table-p)
5602 (org-add-to-invisibility-spec '(org-table))
5603 (org-table-map-tables 'org-table-align)
5604 (message "Vertical table lines invisible"))
5605 (redraw-frame (selected-frame))))
5607 (defun org-table-map-tables (function)
5608 "Apply FUNCTION to the start of all tables in the buffer."
5612 (goto-char (point-min))
5613 (while (re-search-forward org-table-any-line-regexp nil t)
5614 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
5615 (beginning-of-line 1)
5616 (if (looking-at org-table-line-regexp)
5617 (save-excursion (funcall function)))
5618 (re-search-forward org-table-any-border-regexp nil 1)))))
5620 (defun org-table-sum ()
5621 "Sum numbers in region of current table column.
5622 The result will be displayed in the echo area, and will be available
5623 as kill to be inserted with \\[yank].
5625 If there is an active region, it is interpreted as a rectangle and all
5626 numbers in that rectangle will be summed. If there is no active
5627 region and point is located in a table column, sum all numbers in that
5630 If at least on number looks like a time HH:MM or HH:MM:SS, all other
5631 numbers are assumed to be times as well (in decimal hours) and the
5632 numbers are added as such."
5635 (let (beg end col (timecnt 0) diff h m s)
5636 (if (org-region-active-p)
5637 (setq beg (region-beginning) end (region-end))
5638 (setq col (org-table-current-column))
5639 (goto-char (org-table-begin))
5640 (unless (re-search-forward "^[ \t]*|[^-]" nil t)
5641 (error "No table data"))
5642 (org-table-goto-column col)
5643 (skip-chars-backward "^|")
5645 (goto-char (org-table-end))
5646 (unless (re-search-backward "^[ \t]*|[^-]" nil t)
5647 (error "No table data"))
5648 (org-table-goto-column col)
5649 (skip-chars-forward "^|")
5651 (let* ((l1 (progn (goto-char beg)
5652 (+ (if (bolp) 1 0) (count-lines (point-min) (point)))))
5653 (l2 (progn (goto-char end)
5654 (+ (if (bolp) 1 0) (count-lines (point-min) (point)))))
5655 (items (if (= l1 l2)
5656 (split-string (buffer-substring beg end))
5658 (mapconcat 'identity (extract-rectangle beg end) " "))))
5659 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
5661 (res (apply '+ numbers))
5662 (sres (if (= timecnt 0)
5664 (setq diff (* 3600 res)
5665 h (floor (/ diff 3600)) diff (mod diff 3600)
5666 m (floor (/ diff 60)) diff (mod diff 60)
5668 (format "%d:%02d:%02d" h m s))))
5670 (message (substitute-command-keys
5671 (format "Sum of %d items: %-20s (\\[yank] will insert result into buffer)"
5672 (length numbers) sres)))))))
5674 (defun org-table-get-number-for-summing (s)
5676 (if (string-match "^ *|? *" s)
5677 (setq s (replace-match "" nil nil s)))
5678 (if (string-match " *|? *$" s)
5679 (setq s (replace-match "" nil nil s)))
5680 (setq n (string-to-number s))
5682 ((and (string-match "0" s)
5683 (string-match "\\`[-+ \t0.edED]+\\'" s)) 0)
5684 ((string-match "\\`[ \t]+\\'" s) nil)
5685 ((string-match "\\`\\([0-9]+\\):\\([0-9]+\\)\\(:\\([0-9]+\\)\\)?\\'" s)
5686 (let ((h (string-to-number (or (match-string 1 s) "0")))
5687 (m (string-to-number (or (match-string 2 s) "0")))
5688 (s (string-to-number (or (match-string 4 s) "0"))))
5689 (if (boundp 'timecnt) (setq timecnt (1+ timecnt)))
5690 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
5694 (defvar org-table-current-formula nil)
5695 (defvar org-table-formula-history nil)
5696 (defun org-table-get-formula (current)
5697 (if (and current (not (equal "" org-table-current-formula)))
5698 org-table-current-formula
5699 (setq org-table-current-formula
5701 "Formula [last]: " "" 'org-table-formula-history
5702 org-table-current-formula))))
5704 (defun org-this-word ()
5705 ;; Get the current word
5707 (let ((beg (progn (skip-chars-backward "^ \t\n") (point)))
5708 (end (progn (skip-chars-forward "^ \t\n") (point))))
5709 (buffer-substring-no-properties beg end))))
5711 (defun org-table-eval-formula (&optional ndown)
5712 "Replace the table field value at the cursor by the result of a calculation.
5714 This function makes use of Dave Gillespie's calc package, arguably the most
5715 exciting program ever written for GNU Emacs. So you need to have calc
5716 installed in order to use this function.
5718 In a table, this command replaces the value in the current field with the
5719 result of a formula. While nowhere near the computation options of a
5720 spreadsheet program, this is still very useful. Note that there is no
5721 automatic updating of a calculated field, nor will the field remember the
5722 formula. The command needs to be applied again after changing input
5725 When called, the command first prompts for a formula, which is read in the
5726 minibuffer. Previously entered formulae are available through the history
5727 list, and the last used formula is the default, reachable by simply
5730 The formula can be any algebraic expression understood by the calc package.
5731 Before evaluation, variable substitution takes place: \"$\" is replaced by
5732 the field the cursor is currently in, and $1..$n reference the fields in
5733 the current row. Values from a *different* row can *not* be referenced
5734 here, so the command supports only horizontal computing. The formula can
5735 contain an optional printf format specifier after a semicolon, to reformat
5738 A few examples for formulae:
5739 $1+$2 Sum of first and second field
5740 $1+$2;%f.2 Same, and format result to two digits after dec.point
5741 exp($2)+exp($1) Math functions can be used
5742 $;%f.1 Reformat current cell to 1 digit after dec.point
5743 ($3-32)*5/9 degrees F -> C conversion
5745 When called with a raw C-u prefix, the formula is applied to the current
5746 field, and to the same same column in all following rows, until reaching a
5747 horizontal line or the end of the table. When the command is called with a
5748 numeric prefix argument (like M-3 or C-7 or C-u 24), the formula is applied
5749 to the current row, and to the following n-1 rows (but not beyond a
5752 (setq ndown (if (equal ndown '(4)) 10000 (prefix-numeric-value ndown)))
5754 (org-table-check-inside-data-field)
5756 (org-table-automatic-realign nil)
5758 (formula (org-table-get-formula nil))
5759 (n0 (org-table-current-column))
5761 (if (string-match ";" formula)
5762 (let ((tmp (org-split-string formula ";")))
5763 (setq formula (car tmp) fmt (nth 1 tmp))))
5765 (setq fields (org-split-string
5766 (concat " " (buffer-substring
5767 (point-at-bol) (point-at-eol))) "|"))
5768 (setq ndown (1- ndown))
5769 (setq form (copy-sequence formula))
5770 (while (string-match "\\$\\([0-9]+\\)?" form)
5771 (setq n (if (match-beginning 1)
5772 (string-to-int (match-string 1 form))
5775 (unless x (error "Illegal field specifier \"%s\""
5776 (match-string 0 form)))
5777 (if (equal (string-to-number x) 0) (setq x "0"))
5778 (setq form (replace-match x t t form)))
5779 (setq ev (calc-eval (list form) 'num))
5781 (error "Illegal expression: %s (%s at %d)" form (nth 1 ev) (car ev)))
5782 (org-table-blank-field)
5784 (insert (format fmt (string-to-number ev)))
5786 (if (and down (> ndown 0) (looking-at ".*\n[ \t]*|[^-]"))
5787 (call-interactively 'org-return)
5793 (defconst org-level-max 20)
5795 (defun org-export-find-first-heading-line (list)
5796 "Remove all lines from LIST which are before the first headline."
5797 (let ((orig-list list)
5798 (re (concat "^" outline-regexp)))
5800 (not (string-match re (car list))))
5802 (or list orig-list)))
5804 (defun org-skip-comments (lines)
5805 "Skip lines starting with \"#\" and subtrees starting with COMMENT."
5806 (let ((re1 (concat "^\\(\\*+\\)[ \t]+" org-comment-string))
5807 (re2 "^\\(\\*+\\)[ \t\n\r]")
5809 (while (setq line (pop lines))
5811 ((and (string-match re1 line)
5812 (setq level (- (match-end 1) (match-beginning 1))))
5813 ;; Beginning of a COMMENT subtree. Skip it.
5814 (while (and (setq line (pop lines))
5815 (or (not (string-match re2 line))
5816 (> (- (match-end 1) (match-beginning 1)) level))))
5817 (setq lines (cons line lines)))
5818 ((string-match "^#" line)
5819 ;; an ordinary comment line
5821 (t (setq rtn (cons line rtn)))))
5826 (defconst org-ascii-underline '(?\$ ?\# ?^ ?\~ ?\= ?\-)
5827 "Characters for underlining headings in ASCII export.")
5829 (defconst org-html-entities
5869 ("Aring") ("AA"."Å")
5958 ("varepsilon"."ε")
5971 ("sigmaf") ("varsigma"."ς")
5979 ("thetasym") ("vartheta"."ϑ")
5982 ("bull") ("bullet"."•")
5983 ("hellip") ("dots"."…")
5993 ("larr") ("leftarrow"."←") ("gets"."←")
5994 ("uarr") ("uparrow"."↑")
5995 ("rarr") ("to"."→") ("rightarrow"."→")
5996 ("darr")("downarrow"."↓")
5997 ("harr") ("leftrightarrow"."↔")
5998 ("crarr") ("hookleftarrow"."↵") ; has round hook, not quite CR
5999 ("lArr") ("Leftarrow"."⇐")
6000 ("uArr") ("Uparrow"."⇑")
6001 ("rArr") ("Rightarrow"."⇒")
6002 ("dArr") ("Downarrow"."⇓")
6003 ("hArr") ("Leftrightarrow"."⇔")
6005 ("part") ("partial"."∂")
6006 ("exist") ("exists"."∃")
6007 ("empty") ("emptyset"."∅")
6009 ("isin") ("in"."∈")
6015 ("lowast") ("ast"."∗")
6017 ("prop") ("proptp"."∝")
6018 ("infin") ("infty"."∞")
6019 ("ang") ("angle"."∠")
6020 ("and") ("vee"."∧")
6021 ("or") ("wedge"."∨")
6027 ("cong") ("simeq"."≅")
6028 ("asymp")("approx"."≈")
6029 ("ne") ("neq"."≠")
6033 ("sub") ("subset"."⊂")
6034 ("sup") ("supset"."⊃")
6041 ("sdot") ("cdot"."⋅")
6048 ("loz") ("Diamond"."◊")
6049 ("spades") ("spadesuit"."♠")
6050 ("clubs") ("clubsuit"."♣")
6051 ("hearts") ("diamondsuit"."♥")
6052 ("diams") ("diamondsuit"."♦")
6119 "Entities for TeX->HTML translation.
6120 Entries can be like (\"ent\"), in which case \"\\ent\" will be translated to
6121 \"&ent;\". An entry can also be a dotted pair like (\"ent\".\"&other;\").
6122 In that case, \"\\ent\" will be translated to \"&other;\".
6123 The list contains HTML entities for Latin-1, Greek and other symbols.
6124 It is supplemented by a number of commonly used TeX macros with appropriate
6127 (defun org-export-as-ascii (arg)
6128 "Export the outline as a pretty ASCII file.
6129 If there is an active region, export only the region.
6130 The prefix ARG specifies how many levels of the outline should become
6131 underlined headlines. The default is 3."
6133 (setq-default org-todo-line-regexp org-todo-line-regexp)
6136 (if (org-region-active-p) (region-beginning) (point-min))
6137 (if (org-region-active-p) (region-end) (point-max))))
6138 (lines (org-export-find-first-heading-line
6139 (org-skip-comments (org-split-string region "[\r\n]"))))
6140 (org-startup-with-deadline-check nil)
6143 (case-fold-search nil)
6144 (filename (concat (file-name-sans-extension (buffer-file-name))
6146 (buffer (find-file-noselect filename))
6147 (levels-open (make-vector org-level-max nil))
6148 (date (format-time-string "%Y/%m/%d" (current-time)))
6149 (time (format-time-string "%X" (current-time)))
6150 (author user-full-name)
6151 (title (buffer-name))
6153 (email user-mail-address)
6154 (language org-export-default-language)
6160 (org-init-section-numbers)
6162 (find-file-noselect filename)
6164 ;; Search for the export key lines
6165 (org-parse-key-lines)
6167 (setq lang-words (or (assoc language org-export-language-setup)
6168 (assoc "en" org-export-language-setup)))
6169 (if org-export-ascii-show-new-buffer
6170 (switch-to-buffer-other-window buffer)
6171 (set-buffer buffer))
6174 (if options (org-parse-export-options options))
6175 (setq umax (if arg (prefix-numeric-value arg)
6176 org-export-headline-levels))
6179 (if title (org-insert-centered title ?=))
6181 (if (or author email)
6182 (insert (concat (nth 1 lang-words) ": " (or author "")
6183 (if email (concat " <" email ">") "")
6186 (insert (concat (nth 2 lang-words) ": " date " " time "\n")))
6187 (if text (insert (concat (org-html-expand-for-ascii text) "\n\n")))
6191 (if org-export-with-toc
6193 (insert (nth 3 lang-words) "\n"
6194 (make-string (length (nth 3 lang-words)) ?=) "\n")
6195 (mapcar '(lambda (line)
6196 (if (string-match org-todo-line-regexp
6198 ;; This is a headline
6200 (setq level (- (match-end 1) (match-beginning 1))
6201 txt (match-string 3 line)
6203 (or (and (match-beginning 2)
6204 (not (equal (match-string 2 line)
6208 (org-search-todo-below
6209 line lines level))))
6210 (setq txt (org-html-expand-for-ascii txt))
6212 (if org-export-with-section-numbers
6213 (setq txt (concat (org-section-number level)
6218 (make-string (* (1- level) 4) ?\ )
6219 (format (if todo "%s (*)\n" "%s\n") txt))
6220 (setq last-level level))
6224 (org-init-section-numbers)
6225 (while (setq line (pop lines))
6226 ;; Remove the quoted HTML tags.
6227 (setq line (org-html-expand-for-ascii line))
6229 ((string-match "^\\(\\*+\\)[ \t]*\\(.*\\)" line)
6231 (setq level (- (match-end 1) (match-beginning 1))
6232 txt (match-string 2 line))
6233 (org-ascii-level-start level txt umax))
6234 (t (insert line "\n"))))
6237 (goto-char (point-min))))
6239 (defun org-search-todo-below (line lines level)
6240 "Search the subtree below LINE for any TODO entries."
6241 (let ((rest (cdr (memq line lines)))
6242 (re org-todo-line-regexp)
6245 (while (setq line (pop rest))
6246 (if (string-match re line)
6248 (setq lv (- (match-end 1) (match-beginning 1))
6249 todo (and (match-beginning 2)
6250 (not (equal (match-string 2 line)
6253 (if (<= lv level) (throw 'exit nil))
6254 (if todo (throw 'exit t))))))))
6256 ;; FIXME: Try to handle <b> and <i> as faces via text properties.
6257 ;; FIXME: Can I implement *bold*,/italic/ and _underline_ for AXCII export?
6258 (defun org-html-expand-for-ascii (line)
6259 "Handle quoted HTML for ASCII export."
6260 (if org-export-html-expand
6261 (while (string-match "@<[^<>\n]*>" line)
6262 ;; We just remove the tags for now.
6263 (setq line (replace-match "" nil nil line))))
6266 (defun org-insert-centered (s &optional underline)
6267 "Insert the string S centered and underline it with character UNDERLINE."
6268 (let ((ind (max (/ (- 80 (length s)) 2) 0)))
6269 (insert (make-string ind ?\ ) s "\n")
6271 (insert (make-string ind ?\ )
6272 (make-string (length s) underline)
6275 (defun org-ascii-level-start (level title umax)
6276 "Insert a new level in ASCII export."
6279 (insert (make-string (* 2 (- level umax 1)) ?\ ) "* " title "\n")
6280 (if (or (not (equal (char-before) ?\n))
6281 (not (equal (char-before (1- (point))) ?\n)))
6283 (setq char (nth (- umax level) (reverse org-ascii-underline)))
6284 (if org-export-with-section-numbers
6285 (setq title (concat (org-section-number level) " " title)))
6286 (insert title "\n" (make-string (length title) char) "\n"))))
6290 (defun org-get-current-options ()
6291 "Return a string with current options as keyword options.
6292 Does include HTML export options as well as TODO and CATEGORY stuff."
6298 #+TEXT: Some descriptive text to be emitted. Several lines OK.
6299 #+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s *:%s TeX:%s
6304 (buffer-name) (user-full-name) user-mail-address org-export-default-language
6305 org-export-headline-levels
6306 org-export-with-section-numbers
6308 org-export-preserve-breaks
6309 org-export-html-expand
6310 org-export-with-fixed-width
6311 org-export-with-tables
6312 org-export-with-sub-superscripts
6313 org-export-with-emphasize
6314 org-export-with-TeX-macros
6315 (file-name-nondirectory (buffer-file-name))
6316 (if (equal org-todo-interpretation 'sequence)
6317 (mapconcat 'identity org-todo-keywords " ")
6318 "TODO FEEDBACK VERIFY DONE")
6319 (if (equal org-todo-interpretation 'type)
6320 (mapconcat 'identity org-todo-keywords " ")
6321 "Me Jason Marie DONE")))
6323 (defun org-insert-export-options-template ()
6324 "Insert into the buffer a template with information for exporting."
6326 (if (not (bolp)) (newline))
6327 (let ((s (org-get-current-options)))
6328 (and (string-match "#\\+CATEGORY" s)
6329 (setq s (substring s 0 (match-beginning 0))))
6332 (defun org-toggle-fixed-width-section (arg)
6333 "Toggle the fixed-width indicator at the beginning of lines in the region.
6334 If there is no active region, only acts on the current line.
6335 If the first non-white character in the first line of the region is a
6336 vertical bar \"|\", then the command removes the bar from all lines in
6337 the region. If the first character is not a bar, the command adds a
6338 bar to all lines, in the column given by the beginning of the region.
6340 If there is a numerical prefix ARG, create ARG new lines starting with \"|\"."
6343 (regionp (org-region-active-p))
6344 (beg (if regionp (region-beginning) (point)))
6345 (end (if regionp (region-end)))
6346 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
6347 (re "[ \t]*\\(:\\)")
6351 (setq cc (current-column))
6352 (beginning-of-line 1)
6353 (setq off (looking-at re))
6355 (setq nlines (1- nlines))
6356 (beginning-of-line 1)
6359 (move-to-column cc t)
6362 ((and off (looking-at re))
6363 (replace-match "" t t nil 1))
6364 ((not off) (move-to-column cc t) (insert ":")))
6365 (forward-line 1)))))
6367 (defun org-export-as-html-and-open (arg)
6368 "Export the outline as HTML and immediately open it with a browser.
6369 If there is an active region, export only the region.
6370 The prefix ARG specifies how many levels of the outline should become
6371 headlines. The default is 3. Lower levels will become bulleted lists."
6373 (org-export-as-html arg 'hidden)
6374 (org-open-file (buffer-file-name)))
6376 (defun org-export-as-html-batch ()
6377 "Call org-export-as-html, may be used in batch processing as
6379 --load=$HOME/lib/emacs/org.el
6380 --eval \"(setq org-export-headline-levels 2)\"
6381 --visit=MyFile --funcall org-export-as-html-batch"
6382 (org-export-as-html org-export-headline-levels 'hidden))
6384 (defun org-export-as-html (arg &optional hidden)
6385 "Export the outline as a pretty HTML file.
6386 If there is an active region, export only the region.
6387 The prefix ARG specifies how many levels of the outline should become
6388 headlines. The default is 3. Lower levels will become bulleted lists."
6390 (setq-default org-todo-line-regexp org-todo-line-regexp)
6391 (setq-default org-deadline-line-regexp org-deadline-line-regexp)
6392 (setq-default org-done-string org-done-string)
6393 (let* ((region-p (org-region-active-p))
6396 (if region-p (region-beginning) (point-min))
6397 (if region-p (region-end) (point-max))))
6399 (org-skip-comments (org-split-string region "[\r\n]")))
6400 (lines (org-export-find-first-heading-line all_lines))
6401 (level 0) (line "") (origline "") txt todo
6404 (filename (concat (file-name-sans-extension (buffer-file-name))
6406 (buffer (find-file-noselect filename))
6407 (levels-open (make-vector org-level-max nil))
6408 (date (format-time-string "%Y/%m/%d" (current-time)))
6409 (time (format-time-string "%X" (current-time)))
6410 (author user-full-name)
6411 (title (buffer-name))
6413 (email user-mail-address)
6414 (language org-export-default-language)
6419 table-buffer table-orig-buffer
6421 (message "Exporting...")
6423 (org-init-section-numbers)
6425 ;; Search for the export key lines
6426 (org-parse-key-lines)
6427 (setq lang-words (or (assoc language org-export-language-setup)
6428 (assoc "en" org-export-language-setup)))
6430 ;; Switch to the output buffer
6431 (if (or hidden (not org-export-html-show-new-buffer))
6433 (switch-to-buffer-other-window buffer))
6436 (let ((case-fold-search nil))
6437 (if options (org-parse-export-options options))
6438 (setq umax (if arg (prefix-numeric-value arg)
6439 org-export-headline-levels))
6443 "<html lang=\"%s\"><head>
6445 <meta http-equiv=\"Content-Type\" content=\"text/html\">
6446 <meta name=generator content=\"Org-mode\">
6447 <meta name=generated content=\"%s %s\">
6448 <meta name=author content=\"%s\">
6451 language (org-html-expand title) date time author))
6452 (if title (insert (concat "<H1 align=\"center\">"
6453 (org-html-expand title) "</H1>\n")))
6454 (if author (insert (concat (nth 1 lang-words) ": " author "\n")))
6455 (if email (insert (concat "<a href=\"mailto:" email "\"><"
6456 email "></a>\n")))
6457 (if (or author email) (insert "<br>\n"))
6458 (if (and date time) (insert (concat (nth 2 lang-words) ": "
6459 date " " time "<br>\n")))
6460 (if text (insert (concat "<p>\n" (org-html-expand text))))
6461 (if org-export-with-toc
6463 (insert (format "<H2>%s</H2>\n" (nth 3 lang-words)))
6465 (mapcar '(lambda (line)
6466 (if (string-match org-todo-line-regexp line)
6467 ;; This is a headline
6469 (setq level (- (match-end 1) (match-beginning 1))
6470 txt (save-match-data
6472 (match-string 3 line)))
6474 (or (and (match-beginning 2)
6475 (not (equal (match-string 2 line)
6479 (org-search-todo-below
6480 line lines level))))
6481 (if org-export-with-section-numbers
6482 (setq txt (concat (org-section-number level)
6486 (setq head-count (+ head-count 1))
6487 (if (> level last-level)
6489 (setq cnt (- level last-level))
6490 (while (>= (setq cnt (1- cnt)) 0)
6493 (if (< level last-level)
6495 (setq cnt (- last-level level))
6496 (while (>= (setq cnt (1- cnt)) 0)
6502 "<li><a href=\"#sec-%d\"><span style='color:red'>%s</span></a></li>\n"
6503 "<li><a href=\"#sec-%d\">%s</a></li>\n")
6505 (setq last-level level))
6508 (while (> last-level 0)
6509 (setq last-level (1- last-level))
6513 (org-init-section-numbers)
6515 (while (setq line (pop lines) origline line)
6516 ;; replace "<" and ">" by "<" and ">"
6517 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
6518 (setq line (org-html-expand line))
6521 (if (and org-export-with-fixed-width
6522 (string-match "^[ \t]*:\\(.*\\)" line))
6524 (let ((l (match-string 1 line)))
6525 (while (string-match " " l)
6526 (setq l (replace-match " " t t l)))
6527 (insert "\n<span style='font-family:Courier'>"
6530 (not (string-match "^[ \t]+\\(:.*\\)"
6534 (when (string-match org-link-regexp line)
6535 (setq type (match-string 1 line))
6537 ((member type '("http" "https" "ftp" "mailto" "news"))
6539 (setq line (replace-match
6540 "<a href=\"\\1:\\2\"><\\1:\\2></a>"
6542 ((string= type "file")
6545 (let* ((filename (match-string 2 line))
6548 (string-match (org-image-file-name-regexp) filename))))
6549 (setq line (replace-match
6550 (if (and org-export-html-inline-images
6552 "<img src=\"\\2\"/>"
6553 "<a href=\"\\2\">\\1:\\2</a>")
6556 ((member type '("bbdb" "vm" "wl" "rmail" "gnus" "shell"))
6557 (setq line (replace-match
6558 "<i><\\1:\\2></i>" nil nil line)))))
6561 (if (and (string-match org-todo-line-regexp line)
6562 (match-beginning 2))
6563 (if (equal (match-string 2 line) org-done-string)
6564 (setq line (replace-match
6565 "<span style='color:green'>\\2</span>"
6567 (setq line (replace-match "<span style='color:red'>\\2</span>"
6571 (if (string-match org-deadline-line-regexp line)
6573 (if (save-match-data
6574 (string-match "<a href"
6575 (substring line 0 (match-beginning 0))))
6576 nil ; Don't do the replacement - it is inside a link
6577 (setq line (replace-match "<span style='color:red'>\\&</span>"
6581 ((string-match "^\\(\\*+\\)[ \t]*\\(.*\\)" line)
6582 ;; This is a headline
6583 (setq level (- (match-end 1) (match-beginning 1))
6584 txt (match-string 2 line))
6585 (if (<= level umax) (setq head-count (+ head-count 1)))
6586 (org-html-level-start level txt umax
6587 (and org-export-with-toc (<= level umax))
6590 ((and org-export-with-tables
6591 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
6592 (if (not table-open)
6594 (setq table-open t table-buffer nil table-orig-buffer nil))
6596 (setq table-buffer (cons line table-buffer)
6597 table-orig-buffer (cons origline table-orig-buffer))
6598 (when (or (not lines)
6599 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
6601 (setq table-open nil
6602 table-buffer (nreverse table-buffer)
6603 table-orig-buffer (nreverse table-orig-buffer))
6604 (insert (org-format-table-html table-buffer table-orig-buffer))))
6607 ;; Lines starting with "-", and empty lines make new paragraph.
6608 (if (string-match "^ *-\\|^[ \t]*$" line) (insert "<p>"))
6609 (insert line (if org-export-preserve-breaks "<br>\n" "\n"))))
6611 (if org-export-html-with-timestamp
6612 (insert org-export-html-html-helper-timestamp))
6613 (insert "</body>\n</html>\n")
6616 (goto-char (point-min)))))
6618 (defun org-format-table-html (lines olines)
6619 "Find out which HTML converter to use and return the HTML code."
6620 (if (string-match "^[ \t]*|" (car lines))
6621 ;; A normal org table
6622 (org-format-org-table-html lines)
6623 ;; Table made by table.el - test for spanning
6624 (let* ((hlines (delq nil (mapcar
6626 (if (string-match "^[ \t]*\\+-" x) x
6629 (first (car hlines))
6630 (ll (and (string-match "\\S-+" first)
6631 (match-string 0 first)))
6632 (re (concat "^[ \t]*" (regexp-quote ll)))
6633 (spanning (delq nil (mapcar (lambda (x) (not (string-match re x)))
6635 (if (and (not spanning)
6636 (not org-export-prefer-native-exporter-for-tables))
6637 ;; We can use my own converter with HTML conversions
6638 (org-format-table-table-html lines)
6639 ;; Need to use the code generator in table.el, with the original text.
6640 (org-format-table-table-html-using-table-generate-source olines)))))
6642 (defun org-format-org-table-html (lines)
6643 "Format a table into html."
6644 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
6645 (setq lines (nreverse lines))
6646 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
6647 (setq lines (nreverse lines))
6648 (let ((head (and org-export-highlight-first-table-line
6650 (lambda (x) (string-match "^[ \t]*|-" x))
6652 lastline line fields html empty)
6653 (setq html (concat org-export-html-table-tag "\n"))
6654 (while (setq lastline line
6656 (setq empty " ")
6658 (if (string-match "^[ \t]*|-" line)
6660 ;; A hline: simulate an empty table row instead.
6661 (setq line (org-fake-empty-table-line lastline)
6665 (throw 'next-line t)))
6666 ;; Break the line into fields
6667 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
6671 (mapconcat (lambda (x)
6672 (if (equal x "") (setq x empty))
6674 (concat "<th>" x "</th>")
6675 (concat "<td valign=\"top\">" x "</td>")))
6678 (setq html (concat html "</table>\n"))
6681 (defun org-fake-empty-table-line (line)
6682 "Replace everything except \"|\" with spaces."
6683 (let ((i (length line))
6684 (newstr (copy-sequence line)))
6687 (if (not (eq (aref newstr i) ?|))
6688 (aset newstr i ?\ )))
6691 (defun org-format-table-table-html (lines)
6692 "Format a table generated by table.el into html.
6693 This conversion does *not* use `table-generate-source' from table.el.
6694 This has the advantage that Org-mode's HTML conversions can be used.
6695 But it has the disadvantage, that no cell- or row-spanning is allowed."
6696 (let (line field-buffer
6697 (head org-export-highlight-first-table-line)
6699 (setq html (concat org-export-html-table-tag "\n"))
6700 (while (setq line (pop lines))
6701 (setq empty " ")
6703 (if (string-match "^[ \t]*\\+-" line)
6712 (if (equal x "") (setq x empty))
6714 (concat "<th valign=\"top\">" x
6716 (concat "<td valign=\"top\">" x
6721 (setq field-buffer nil)))
6723 (throw 'next-line t)))
6724 ;; Break the line into fields and store the fields
6725 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
6727 (setq field-buffer (mapcar
6729 (concat x "<br>" (pop fields)))
6731 (setq field-buffer fields))))
6732 (setq html (concat html "</table>\n"))
6735 (defun org-format-table-table-html-using-table-generate-source (lines)
6736 "Format a table into html, using `table-generate-source' from table.el.
6737 This has the advantage that cell- or row-spanning is allowed.
6738 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
6741 (set-buffer (get-buffer-create " org-tmp1 "))
6743 (insert (mapconcat 'identity lines "\n"))
6744 (goto-char (point-min))
6745 (if (not (re-search-forward "|[^+]" nil t))
6746 (error "Error processing table."))
6747 (table-recognize-table)
6749 (set-buffer (get-buffer-create " org-tmp2 "))
6751 (table-generate-source 'html " org-tmp2 ")
6752 (set-buffer " org-tmp2 ")
6753 (buffer-substring (point-min) (point-max))))
6755 (defun org-html-expand (string)
6756 "Prepare STRING for HTML export. Applies all active conversions."
6757 ;; First check if there is a link in the line - if yes, apply conversions
6758 ;; only before the start of the link.
6759 (let* ((m (string-match org-link-regexp string))
6760 (s (if m (substring string 0 m) string))
6761 (r (if m (substring string m) "")))
6762 ;; convert < to < and > to >
6763 (while (string-match "<" s)
6764 (setq s (replace-match "<" nil nil s)))
6765 (while (string-match ">" s)
6766 (setq s (replace-match ">" nil nil s)))
6767 (if org-export-html-expand
6768 (while (string-match "@<\\([^&]*\\)>" s)
6769 (setq s (replace-match "<\\1>" nil nil s))))
6770 (if org-export-with-emphasize
6771 (setq s (org-export-html-convert-emphasize s)))
6772 (if org-export-with-sub-superscripts
6773 (setq s (org-export-html-convert-sub-super s)))
6774 (if org-export-with-TeX-macros
6775 (let ((start 0) wd ass)
6776 (while (setq start (string-match "\\\\\\([a-zA-Z]+\\)" s start))
6777 (setq wd (match-string 1 s))
6778 (if (setq ass (assoc wd org-html-entities))
6779 (setq s (replace-match (or (cdr ass)
6780 (concat "&" (car ass) ";"))
6782 (setq start (+ start (length wd)))))))
6785 (defun org-create-multibrace-regexp (left right n)
6786 "Create a regular expression which will match a balanced sexp.
6787 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
6788 as single character strings.
6789 The regexp returned will match the entire expression including the
6790 delimiters. It will also define a single group which contains the
6791 match except for the outermost delimiters. The maximum depth of
6792 stacked delimiters is N. Escaping delimiters is not possible."
6793 (let* ((nothing (concat "[^" "\\" left "\\" right "]*?"))
6796 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
6799 re (concat re or next)
6800 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
6801 (concat left "\\(" re "\\)" right)))
6803 (defvar org-match-substring-regexp
6805 "\\([^\\]\\)\\([_^]\\)\\("
6806 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
6808 "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
6810 "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
6811 "The regular expression matching a sub- or superscript.")
6813 (defun org-export-html-convert-sub-super (string)
6814 "Convert sub- and superscripts in STRING to HTML."
6816 (while (string-match org-match-substring-regexp string)
6817 (setq key (if (string= (match-string 2 string) "_") "sub" "sup"))
6818 (setq c (or (match-string 8 string)
6819 (match-string 6 string)
6820 (match-string 5 string)))
6821 (setq string (replace-match
6822 (concat (match-string 1 string)
6823 "<" key ">" c "</" key ">")
6825 (while (string-match "\\\\\\([_^]\\)" string)
6826 (setq string (replace-match (match-string 1 string) t t string))))
6829 (defun org-export-html-convert-emphasize (string)
6830 (while (string-match
6831 "\\(\\s-\\|^\\)\\(\\*\\([a-zA-Z]+\\)\\*\\)\\([^a-zA-Z*]\\|$\\)"
6833 (setq string (replace-match
6834 (concat "<b>" (match-string 3 string) "</b>")
6836 (while (string-match
6837 "\\(\\s-\\|^\\)\\(/\\([a-zA-Z]+\\)/\\)\\([^a-zA-Z*]\\|$\\)"
6839 (setq string (replace-match
6840 (concat "<i>" (match-string 3 string) "</i>")
6842 (while (string-match
6843 "\\(\\s-\\|^\\)\\(_\\([a-zA-Z]+\\)_\\)\\([^a-zA-Z*]\\|$\\)"
6845 (setq string (replace-match
6846 (concat "<u>" (match-string 3 string) "</u>")
6850 (defun org-parse-key-lines ()
6851 "Find the special key lines with the information for exporters."
6854 (let ((re (org-make-options-regexp
6855 '("TITLE" "AUTHOR" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE")))
6857 (while (re-search-forward re nil t)
6858 (setq key (match-string 1))
6859 (cond ((string-equal key "TITLE")
6860 (setq title (match-string 2)))
6861 ((string-equal key "AUTHOR")
6862 (setq author (match-string 2)))
6863 ((string-equal key "EMAIL")
6864 (setq email (match-string 2)))
6865 ((string-equal key "LANGUAGE")
6866 (setq language (match-string 2)))
6867 ((string-equal key "TEXT")
6868 (setq text (concat text "\n" (match-string 2))))
6869 ((string-equal key "OPTIONS")
6870 (setq options (match-string 2))))))))
6872 (defun org-parse-export-options (s)
6873 "Parse the export options line."
6874 (let ((op '(("H" . org-export-headline-levels)
6875 ("num" . org-export-with-section-numbers)
6876 ("toc" . org-export-with-toc)
6877 ("\\n" . org-export-preserve-breaks)
6878 ("@" . org-export-html-expand)
6879 (":" . org-export-with-fixed-width)
6880 ("|" . org-export-with-tables)
6881 ("^" . org-export-with-sub-superscripts)
6882 ("*" . org-export-with-emphasize)
6883 ("TeX" . org-export-with-TeX-macros)))
6885 (while (setq o (pop op))
6886 (if (string-match (concat (regexp-quote (car o)) ":\\([^ \t\n\r;,.]*\\)")
6888 (set (make-local-variable (cdr o))
6889 (car (read-from-string (match-string 1 s))))))))
6891 (defun org-html-level-start (level title umax with-toc head-count)
6892 "Insert a new level in HTML export."
6893 (let ((l (1+ (max level umax))))
6894 (while (<= l org-level-max)
6895 (if (aref levels-open (1- l))
6897 (org-html-level-close l)
6898 (aset levels-open (1- l) nil)))
6902 (if (aref levels-open (1- level))
6903 (insert "<li>" title "<p>\n")
6904 (aset levels-open (1- level) t)
6905 (insert "<ul><li>" title "<p>\n")))
6906 (if org-export-with-section-numbers
6907 (setq title (concat (org-section-number level) " " title)))
6908 (setq level (+ level 1))
6910 (insert (format "\n<H%d><a name=\"sec-%d\">%s</a></H%d>\n"
6911 level head-count title level))
6912 (insert (format "\n<H%d>%s</H%d>\n" level title level))))))
6914 (defun org-html-level-close (level)
6915 "Terminate one level in HTML export."
6919 ;; Variable holding the vector with section numbers
6920 (defvar org-section-numbers (make-vector org-level-max 0))
6922 (defun org-init-section-numbers ()
6923 "Initialize the vector for the section numbers."
6925 (numbers (nreverse (org-split-string "" "\\.")))
6926 (depth (1- (length org-section-numbers)))
6927 (i depth) number-string)
6930 (aset org-section-numbers i 0)
6931 (setq number-string (or (car numbers) "0"))
6932 (if (string-match "\\`[A-Z]\\'" number-string)
6933 (aset org-section-numbers i
6934 (- (string-to-char number-string) ?A -1))
6935 (aset org-section-numbers i (string-to-int number-string)))
6939 (defun org-section-number (&optional level)
6940 "Return a string with the current section number.
6941 When LEVEL is non-nil, increase section numbers on that level."
6942 (let* ((depth (1- (length org-section-numbers))) idx n (string ""))
6945 (aset org-section-numbers
6946 level (1+ (aref org-section-numbers level))))
6947 (setq idx (1+ level))
6948 (while (<= idx depth)
6950 (aset org-section-numbers idx 0))
6951 (setq idx (1+ idx))))
6953 (while (<= idx depth)
6954 (setq n (aref org-section-numbers idx))
6955 (setq string (concat string (if (not (string= string "")) "." "")
6957 (setq idx (1+ idx)))
6959 (if (string-match "\\`\\([@0]\\.\\)+" string)
6960 (setq string (replace-match "" nil nil string)))
6961 (if (string-match "\\(\\.0\\)+\\'" string)
6962 (setq string (replace-match "" nil nil string))))
6968 ;; - Bindings in Org-mode map are currently
6969 ;; 0123456789abcdefghijklmnopqrstuvwxyz!?@#$%^&-+*/=()_{}[]:;"|,.<>~`'\t the alphabet
6970 ;; abcd fgh j lmnopqrstuvwxyz ? # -+ /= [] ; |,.<> \t necessary bindings
6971 ;; e (?) useful from outline-mode
6972 ;; i k @ expendable from outline-mode
6973 ;; 0123456789 ! $%^& * ()_{} " ~`' free
6975 (define-key org-mode-map [(tab)] 'org-cycle)
6976 (define-key org-mode-map "\C-i" 'org-cycle)
6977 (define-key org-mode-map [(meta tab)] 'org-complete)
6978 (define-key org-mode-map "\M-\C-i" 'org-complete)
6979 (define-key org-mode-map [(meta shift left)] 'org-shiftmetaleft)
6980 (define-key org-mode-map [(meta left)] 'org-metaleft)
6981 (define-key org-mode-map [(meta shift right)] 'org-shiftmetaright)
6982 (define-key org-mode-map [(meta shift up)] 'org-shiftmetaup)
6983 (define-key org-mode-map [(meta shift down)] 'org-shiftmetadown)
6984 (define-key org-mode-map [(meta right)] 'org-metaright)
6985 (define-key org-mode-map [(meta up)] 'org-metaup)
6986 (define-key org-mode-map [(meta down)] 'org-metadown)
6987 ;(define-key org-mode-map "\C-c\C-h\C-w" 'org-cut-subtree)
6988 ;(define-key org-mode-map "\C-c\C-h\M-w" 'org-copy-subtree)
6989 ;(define-key org-mode-map "\C-c\C-h\C-y" 'org-paste-subtree)
6990 (define-key org-mode-map "\C-c\C-h\C-w" 'org-cut-special)
6991 (define-key org-mode-map "\C-c\C-h\M-w" 'org-copy-special)
6992 (define-key org-mode-map "\C-c\C-h\C-y" 'org-paste-special)
6993 (define-key org-mode-map "\C-c\C-j" 'org-goto)
6994 (define-key org-mode-map "\C-c\C-t" 'org-todo)
6995 (define-key org-mode-map "\C-c\C-s" 'org-schedule)
6996 (define-key org-mode-map "\C-c\C-d" 'org-deadline)
6997 (define-key org-mode-map "\C-c;" 'org-toggle-comment)
6998 (define-key org-mode-map "\C-c\C-v" 'org-show-todo-tree)
6999 (define-key org-mode-map "\C-c\C-w" 'org-check-deadlines)
7000 (define-key org-mode-map "\C-c/" 'org-occur) ; Minor-mode reserved
7001 (define-key org-mode-map "\C-c\C-m" 'org-insert-heading)
7002 (define-key org-mode-map "\M-\C-m" 'org-insert-heading)
7003 (define-key org-mode-map "\C-c\C-l" 'org-insert-link)
7004 (define-key org-mode-map "\C-c\C-o" 'org-open-at-point)
7005 (define-key org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
7006 (define-key org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
7007 (define-key org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
7008 (define-key org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
7009 (define-key org-mode-map "\C-c>" 'org-goto-calendar)
7010 (define-key org-mode-map "\C-c<" 'org-date-from-calendar)
7011 (define-key org-mode-map "\C-c[" 'org-add-file)
7012 (define-key org-mode-map "\C-c]" 'org-remove-file)
7013 (define-key org-mode-map "\C-c\C-r" 'org-timeline)
7014 ;(define-key org-mode-map [(shift up)] 'org-timestamp-up)
7015 ;(define-key org-mode-map [(shift down)] 'org-timestamp-down)
7016 (define-key org-mode-map [(shift up)] 'org-shiftup)
7017 (define-key org-mode-map [(shift down)] 'org-shiftdown)
7018 (define-key org-mode-map [(shift left)] 'org-timestamp-down-day)
7019 (define-key org-mode-map [(shift right)] 'org-timestamp-up-day)
7020 (define-key org-mode-map "\C-c-" 'org-table-insert-hline)
7021 ;; The following line is e.g. necessary for German keyboards under Suse Linux
7022 (unless org-xemacs-p
7023 (define-key org-mode-map [S-iso-lefttab] 'org-shifttab))
7024 (define-key org-mode-map [(shift tab)] 'org-shifttab)
7025 (define-key org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
7026 (define-key org-mode-map [(return)] 'org-return)
7027 (define-key org-mode-map [(shift return)] 'org-table-copy-from-above)
7028 (define-key org-mode-map [(control up)] 'org-move-line-up)
7029 (define-key org-mode-map [(control down)] 'org-move-line-down)
7030 (define-key org-mode-map "\C-c?" 'org-table-current-column)
7031 (define-key org-mode-map "\C-c " 'org-table-blank-field)
7032 (define-key org-mode-map "\C-c+" 'org-table-sum)
7033 (define-key org-mode-map "\C-c|" 'org-table-toggle-vline-visibility)
7034 (define-key org-mode-map "\C-c=" 'org-table-eval-formula)
7035 (define-key org-mode-map "\C-c#" 'org-table-create-with-table.el)
7036 (define-key org-mode-map "\C-c\C-q" 'org-table-wrap-region)
7037 (define-key org-mode-map "\C-c\C-xa" 'org-export-as-ascii)
7038 (define-key org-mode-map "\C-c\C-x\C-a" 'org-export-as-ascii)
7039 (define-key org-mode-map "\C-c\C-xt" 'org-insert-export-options-template)
7040 (define-key org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
7041 (define-key org-mode-map "\C-c\C-xh" 'org-export-as-html)
7042 (define-key org-mode-map "\C-c\C-x\C-h" 'org-export-as-html-and-open)
7044 (defun org-shiftcursor-error ()
7045 "Throw an error because Shift-Cursor command was applied in wrong context."
7046 (error "This command is only active in tables and on headlines."))
7048 (defun org-shifttab ()
7049 "Call `(org-cycle t)' or `org-table-previous-field'."
7052 ((org-at-table-p) (org-table-previous-field))
7053 (t (org-cycle '(4)))))
7055 (defun org-shiftmetaleft (&optional arg)
7056 "Call `org-promote-subtree' or `org-table-delete-column'."
7059 ((org-at-table-p) (org-table-delete-column arg))
7060 ((org-on-heading-p) (org-promote-subtree arg))
7061 (t (org-shiftcursor-error))))
7062 (defun org-shiftmetaright (&optional arg)
7063 "Call `org-demote-subtree' or `org-table-insert-column'."
7066 ((org-at-table-p) (org-table-insert-column arg))
7067 ((org-on-heading-p) (org-demote-subtree arg))
7068 (t (org-shiftcursor-error))))
7069 (defun org-shiftmetaup (&optional arg)
7070 "Call `org-move-subtree-up' or `org-table-kill-row'."
7073 ((org-at-table-p) (org-table-kill-row arg))
7074 ((org-on-heading-p) (org-move-subtree-up arg))
7075 (t (org-shiftcursor-error))))
7076 (defun org-shiftmetadown (&optional arg)
7077 "Call `org-move-subtree-down' or `org-table-insert-row'."
7080 ((org-at-table-p) (org-table-insert-row arg))
7081 ((org-on-heading-p) (org-move-subtree-down arg))
7082 (t (org-shiftcursor-error))))
7084 (defun org-metaleft (&optional arg)
7085 "Call `org-do-promote' or `org-table-move-column' to left."
7088 ((org-at-table-p) (org-table-move-column 'left))
7089 ((or (org-on-heading-p) (org-region-active-p)) (org-do-promote arg))
7090 (t (backward-word (prefix-numeric-value arg)))))
7091 (defun org-metaright (&optional arg)
7092 "Call `org-do-demote' or `org-table-move-column' to right."
7095 ((org-at-table-p) (org-table-move-column nil))
7096 ((or (org-on-heading-p) (org-region-active-p)) (org-do-demote arg))
7097 (t (forward-word (prefix-numeric-value arg)))))
7098 (defun org-metaup (&optional arg)
7099 "Call `org-move-subtree-up' or `org-table-move-row' up."
7102 ((org-at-table-p) (org-table-move-row 'up))
7103 ((org-on-heading-p) (org-move-subtree-up arg))
7104 (t (org-shiftcursor-error))))
7105 (defun org-metadown (&optional arg)
7106 "Call `org-move-subtree-down' or `org-table-move-row' down."
7109 ((org-at-table-p) (org-table-move-row nil))
7110 ((org-on-heading-p) (org-move-subtree-down arg))
7111 (t (org-shiftcursor-error))))
7113 (defun org-shiftup (&optional arg)
7114 "Call `org-timestamp-up' or `org-priority-up'."
7117 ((org-at-timestamp-p) (org-timestamp-up arg))
7118 (t (org-priority-up))))
7120 (defun org-shiftdown (&optional arg)
7121 "Call `org-timestamp-down' or `org-priority-down'."
7124 ((org-at-timestamp-p) (org-timestamp-down arg))
7125 (t (org-priority-down))))
7127 (defun org-copy-special (arg)
7128 "Call either `org-table-copy' or `org-copy-subtree'."
7130 (if (org-at-table-p)
7131 (org-table-copy-region arg)
7132 (org-copy-subtree arg)))
7134 (defun org-cut-special (arg)
7135 "Call either `org-table-copy' or `org-copy-subtree'."
7137 (if (org-at-table-p)
7138 (org-table-cut-region arg)
7139 (org-cut-subtree arg)))
7141 (defun org-paste-special (arg)
7142 "Call either `org-table-paste-rectangle' or `org-paste-subtree'."
7144 (if (org-at-table-p)
7145 (org-table-paste-rectangle arg)
7146 (org-paste-subtree arg)))
7148 (defun org-ctrl-c-ctrl-c (&optional arg)
7149 "Call realign table, or recognize a table.el table.
7150 When the cursor is inside a table created by the table.el package,
7151 activate that table. Otherwise, if the cursor is at a normal table
7152 created with org.el, re-align that table. This command works even if
7153 the automatic table editor has been turned off."
7155 (let ((org-enable-table-editor t))
7157 ((org-at-table.el-p)
7159 (beginning-of-line 1)
7160 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
7161 (table-recognize-table))
7164 ((org-region-active-p)
7165 (org-table-convert-region (region-beginning) (region-end) arg))
7166 ((and (region-beginning) (region-end))
7167 (if (y-or-n-p "Convert inactive region to table? ")
7168 (org-table-convert-region (region-beginning) (region-end) arg)
7170 (t (error "No table at point, and no region to make one.")))))
7172 (defun org-return (&optional arg)
7173 "Call `org-table-next-row' or `newline'."
7176 ((org-at-table-p) (org-table-next-row))
7182 ;; First, remove the outline menus.
7184 (add-hook 'org-mode-hook
7186 (delete-menu-item '("Headings"))
7187 (delete-menu-item '("Show"))
7188 (delete-menu-item '("Hide"))
7189 (set-menubar-dirty-flag)))
7190 (setq org-mode-map (delq (assoc 'menu-bar (cdr org-mode-map))
7193 ;; Define the Org-mode menus
7194 (easy-menu-define org-org-menu org-mode-map "Org menu"
7196 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
7197 ["Sparse Tree" org-occur t]
7198 ["Show All" show-all t]
7200 ["New Heading" org-insert-heading t]
7201 ("Navigate Headings"
7202 ["Up" outline-up-heading t]
7203 ["Next" outline-next-visible-heading t]
7204 ["Previous" outline-previous-visible-heading t]
7205 ["Next Same Level" outline-forward-same-level t]
7206 ["Previous Same Level" outline-backward-same-level t]
7208 ["Jump" org-goto t])
7210 ["Move subtree up" org-shiftmetaup (not (org-at-table-p))]
7211 ["Move subtree down" org-shiftmetadown (not (org-at-table-p))]
7213 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
7214 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
7215 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
7217 ["Promote Heading" org-metaleft (not (org-at-table-p))]
7218 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
7219 ["Demote Heading" org-metaright (not (org-at-table-p))]
7220 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))])
7223 ["TODO/DONE/-" org-todo t]
7224 ["Show TODO Tree" org-show-todo-tree t]
7226 ["Set priority" org-priority t]
7227 ["Priority up" org-shiftup t]
7228 ["Priority down" org-shiftdown t])
7229 ("Dates and Scheduling"
7230 ["Timestamp" org-time-stamp t]
7232 ["1 day later" org-timestamp-up-day t]
7233 ["1 day earlier" org-timestamp-down-day t]
7234 ["1 ... later" org-shiftup t]
7235 ["1 ... earlier" org-shiftdown t])
7236 ["Compute Time Range" org-evaluate-time-range t]
7237 ["Schedule Item" org-schedule t]
7238 ["Deadline" org-deadline t]
7240 ["Goto Calendar" org-goto-calendar t]
7241 ["Date from Calendar" org-date-from-calendar t])
7244 ["Show TODO Tree this file" org-show-todo-tree t]
7245 ["Check Deadlines this file" org-check-deadlines t]
7246 ["Timeline current file" org-timeline t]
7248 ["Adenda (multifile)" org-agenda-overview t])
7249 ("File List for Agenda")
7252 ["Store Link (global)" org-store-link t]
7253 ["Insert Link" org-insert-link t]
7254 ["Follow Link" org-open-at-point t])
7255 ;; ["BBDB" org-bbdb-name t]
7258 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
7259 ["Next field" org-cycle (org-at-table-p)]
7260 ["Previous Field" org-shifttab (org-at-table-p)]
7261 ["Next row" org-return (org-at-table-p)]
7263 ["Blank field" org-table-blank-field (org-at-table-p)]
7264 ["Copy field from above" org-table-copy-from-above (org-at-table-p)]
7267 ["Move column left" org-metaleft (org-at-table-p)]
7268 ["Move column right" org-metaright (org-at-table-p)]
7269 ["Delete column" org-shiftmetaleft (org-at-table-p)]
7270 ["Insert column" org-shiftmetaright (org-at-table-p)])
7272 ["Move row up" org-metaup (org-at-table-p)]
7273 ["Move row down" org-metadown (org-at-table-p)]
7274 ["Delete row" org-shiftmetaup (org-at-table-p)]
7275 ["Insert row" org-shiftmetadown (org-at-table-p)]
7277 ["Insert hline" org-table-insert-hline (org-at-table-p)])
7279 ["Copy rectangle" org-copy-special (org-at-table-p)]
7280 ["Cut rectangle" org-cut-special (org-at-table-p)]
7281 ["Paste rectangle" org-paste-special (org-at-table-p)]
7282 ["Fill rectangle" org-table-wrap-region (org-at-table-p)])
7284 ["Which column?" org-table-current-column (org-at-table-p)]
7285 ["Sum column/rectangle" org-table-sum
7286 (or (org-at-table-p) (org-region-active-p))]
7287 ["Eval formula" org-table-eval-formula (org-at-table-p)]
7289 ["Invisible Vlines" org-table-toggle-vline-visibility
7290 :style toggle :selected (org-in-invisibility-spec-p '(org-table))]
7292 ["Create" org-table-create (and (not (org-at-table-p))
7293 org-enable-table-editor)]
7294 ["Convert region" org-ctrl-c-ctrl-c (not (org-at-table-p 'any))]
7295 ["Import from file" org-table-import (not (org-at-table-p))]
7296 ["Export to file" org-table-export (org-at-table-p)]
7298 ["Create/convert from/to table.el" org-table-create-with-table.el t])
7301 ["ASCII" org-export-as-ascii t]
7302 ["HTML" org-export-as-html t]
7303 ["HTML, and open" org-export-as-html-and-open t]
7305 ["Option template" org-insert-export-options-template t]
7306 ["Toggle fixed width" org-toggle-fixed-width-section t])
7309 ["Show Version" org-version t]
7310 ["Info Documentation" org-info t])
7312 ["Browse Org Group" org-customize t]
7314 ["Build Full Customize Menu" org-create-customize-menu
7315 (fboundp 'customize-menu-create)])
7319 (defun org-info (&optional node)
7320 "Read documentation for Org-mode in the info system.
7321 With optional NODE, go directly to that node."
7324 (Info-goto-node (format "(org)%s" (or node ""))))
7327 (defun org-install-agenda-files-menu ()
7329 '("Org") "File List for Agenda"
7332 ["Edit file list" (customize-variable 'org-agenda-files) t]
7333 ["Add current file to list" org-add-file t]
7334 ["Remove current file from list" org-remove-file t]
7336 (mapcar 'org-file-menu-entry org-agenda-files))))
7340 (defun org-customize ()
7341 "Call the customize function with org as argument."
7343 (customize-browse 'org))
7345 (defun org-create-customize-menu ()
7346 "Create a full customization menu for Org-mode, insert it into the menu."
7348 (if (fboundp 'customize-menu-create)
7351 '("Org") "Customize"
7352 `(["Browse Org group" org-customize t]
7354 ,(customize-menu-create 'org)
7355 ["Set" Custom-set t]
7356 ["Save" Custom-save t]
7357 ["Reset to Current" Custom-reset-current t]
7358 ["Reset to Saved" Custom-reset-saved t]
7359 ["Reset to Standard Settings" Custom-reset-standard t]))
7360 (message "\"Org\"-menu now contains full customization menu"))
7361 (error "Cannot expand menu (outdated version of cus-edit.el)")))
7363 ;;; Miscellaneous stuff
7365 (defun org-move-line-down (arg)
7366 "Move the current line up."
7368 (let ((col (current-column))
7370 (beginning-of-line 1) (setq beg (point))
7371 (beginning-of-line 2) (setq end (point))
7372 (beginning-of-line (+ 1 arg))
7373 (setq pos (move-marker (make-marker) (point)))
7374 (insert (delete-and-extract-region beg end))
7376 (move-to-column col)))
7378 (defun org-move-line-up (arg)
7379 "Move the current line up."
7381 (let ((col (current-column))
7383 (beginning-of-line 1) (setq beg (point))
7384 (beginning-of-line 2) (setq end (point))
7385 (beginning-of-line (+ -2 arg))
7386 (setq pos (move-marker (make-marker) (point)))
7387 (insert (delete-and-extract-region beg end))
7389 (move-to-column col)))
7391 ;; Functions needed for Emacs/XEmacs region compatibility
7393 (defun org-region-active-p ()
7394 "Is transient-mark-mode on and the region active?
7395 Works on both Emacs and XEmacs."
7396 (if org-ignore-region
7399 (and zmacs-regions (region-active-p))
7400 (and transient-mark-mode mark-active))))
7402 (defun org-add-to-invisibility-spec (arg)
7403 "Add elements to `buffer-invisibility-spec'.
7404 See documentation for `buffer-invisibility-spec' for the kind of elements
7407 ((fboundp 'add-to-invisibility-spec)
7408 (add-to-invisibility-spec arg))
7409 ((or (null buffer-invisibility-spec) (eq buffer-invisibility-spec t))
7410 (setq buffer-invisibility-spec (list arg)))
7412 (setq buffer-invisibility-spec
7413 (cons arg buffer-invisibility-spec)))))
7415 (defun org-remove-from-invisibility-spec (arg)
7416 "Remove elements from `buffer-invisibility-spec'."
7417 (if (fboundp 'remove-from-invisibility-spec)
7418 (remove-from-invisibility-spec arg)
7419 (if (consp buffer-invisibility-spec)
7420 (setq buffer-invisibility-spec
7421 (delete arg buffer-invisibility-spec)))))
7423 (defun org-in-invisibility-spec-p (arg)
7424 "Is ARG a member of `buffer-invisibility-spec'?."
7425 (if (consp buffer-invisibility-spec)
7426 (member arg buffer-invisibility-spec)
7429 (defun org-image-file-name-regexp ()
7430 "Return regexp matching the file names of images."
7431 (if (fboundp 'image-file-name-regexp)
7432 (image-file-name-regexp)
7433 (let ((image-file-name-extensions
7434 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
7435 "xbm" "xpm" "pbm" "pgm" "ppm")))
7437 (regexp-opt (nconc (mapcar 'upcase
7438 image-file-name-extensions)
7439 image-file-name-extensions)
7443 ;; Functions needed for compatibility with old outline.el
7445 ;; The following functions capture almost the entire compatibility code
7446 ;; between the different versions of outline-mode. The only other place
7447 ;; where this is important are the font-lock-keywords. Search for
7448 ;; `org-noutline-p' to find it.
7450 ;; C-a should go to the beginning of a *visible* line, also in the
7451 ;; new outline.el. I guess this should be patched into Emacs?
7452 (defun org-beginning-of-line ()
7453 "Go to the beginning of the current line. If that is invisible, continue
7454 to a visible line beginning. This makes the function of C-a more intuitive."
7456 (beginning-of-line 1)
7460 (if (org-invisible-p)
7461 (while (and (not (bobp)) (org-invisible-p))
7463 (beginning-of-line 1))
7465 (when org-noutline-p
7466 (define-key org-mode-map "\C-a" 'org-beginning-of-line))
7468 (defun org-invisible-p ()
7469 "Check if point is at a character currently not visible."
7471 ;; Early versions of noutline don't have `outline-invisible-p'.
7472 (if (fboundp 'outline-invisible-p)
7473 (outline-invisible-p)
7474 (get-char-property (point) 'invisible))
7476 (skip-chars-backward "^\r\n")
7479 (equal (char-before) ?\r)))))
7481 (defun org-back-to-heading (&optional invisible-ok)
7482 "Move to previous heading line, or beg of this line if it's a heading.
7483 Only visible heading lines are considered, unless INVISIBLE-OK is non-nil."
7485 (outline-back-to-heading invisible-ok)
7486 (if (looking-at outline-regexp)
7488 (if (re-search-backward (concat (if invisible-ok "[\r\n]" "^")
7492 (progn (forward-char 1)
7493 (looking-at outline-regexp)))
7494 (error "Before first heading")))))
7496 (defun org-on-heading-p (&optional invisible-ok)
7497 "Return t if point is on a (visible) heading line.
7498 If INVISIBLE-OK is non-nil, an invisible heading line is ok too."
7500 (outline-on-heading-p 'invisible-ok)
7502 (skip-chars-backward "^\n\r")
7503 (and (looking-at outline-regexp)
7506 (equal (char-before) ?\n))))))
7508 (defun org-up-heading-all (arg)
7509 "Move to the heading line of which the present line is a subheading.
7510 This function considers both visible and invisible heading lines.
7511 With argument, move up ARG levels."
7513 (outline-up-heading-all arg)
7514 (org-back-to-heading t)
7515 (looking-at outline-regexp)
7516 (if (<= (- (match-end 0) (match-beginning 0)) arg)
7517 (error "Cannot move up %d levels" arg)
7519 (concat "[\n\r]" (regexp-quote
7520 (make-string (- (match-end 0) (match-beginning 0) arg)
7525 (defun org-show-hidden-entry ()
7526 "Show an entry where even the heading is hidden."
7528 (if (not org-noutline-p)
7530 (org-back-to-heading t)
7531 (org-flag-heading nil)))
7534 (defun org-check-occur-regexp (regexp)
7535 "If REGEXP starts with \"^\", modify it to check for \\r as well.
7536 Of course, only for the old outline mode."
7539 (if (string-match "^\\^" regexp)
7540 (concat "[\n\r]" (substring regexp 1))
7543 (defun org-flag-heading (flag &optional entry)
7544 "Flag the current heading. FLAG non-nil means make invisible.
7545 When ENTRY is non-nil, show the entire entry."
7547 (org-back-to-heading t)
7548 (if (not org-noutline-p)
7549 ;; Make the current headline visible
7550 (outline-flag-region (max 1 (1- (point))) (point) (if flag ?\r ?\n)))
7551 ;; Check if we should show the entire entry
7555 (save-excursion ;; FIXME: Is this the fix for points in the -|
7556 ;; middle of text? |
7557 (and (outline-next-heading) ;; |
7558 (org-flag-heading nil)))) ; show the next heading _|
7559 (outline-flag-region (max 1 (1- (point)))
7560 (save-excursion (outline-end-of-heading) (point))
7563 (if flag ?\r ?\n))))))
7565 (defun org-make-options-regexp (kwds)
7566 "Make a regular expression for keyword lines."
7568 (if org-noutline-p "^" "[\n\r]")
7570 (mapconcat 'regexp-quote kwds "\\|")
7572 (if org-noutline-p "\\(.+\\)" "\\([^\n\r]+\\)")))
7574 ;; Advise the bookmark-jump function to make jump position visible
7575 ;; Wrapped into eval-after-load to avoid loading advice unnecessarily
7576 (eval-after-load "bookmark"
7577 '(defadvice bookmark-jump (after org-make-visible activate)
7578 "Make the position visible."
7579 (and (eq major-mode 'org-mode)
7581 (org-show-hierarchy-above))))
7587 (run-hooks 'org-load-hook)
7589 ;;; org.el ends here