| blob | e8cf734cdf9077db476b69a0dd4abcaf7e56cd42 |
1 ;;;; org.el --- Outline-based notes management and organize
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <dominik at science dot uva dot nl>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://www.astro.uva.nl/~dominik/Tools/org/
8 ;; Version: 4.60
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
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)
15 ;; any later version.
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., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
29 ;;
30 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
31 ;; project planning with a fast and effective plain-text system.
32 ;;
33 ;; Org-mode develops organizational tasks around NOTES files that contain
34 ;; information about projects as plain text. Org-mode is implemented on
35 ;; top of outline-mode, which makes it possible to keep the content of
36 ;; large files well structured. Visibility cycling and structure editing
37 ;; help to work with the tree. Tables are easily created with a built-in
38 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
39 ;; and scheduling. It dynamically compiles entries into an agenda that
40 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
41 ;; Plain text URL-like links connect to websites, emails, Usenet
42 ;; messages, BBDB entries, and any files related to the projects. For
43 ;; printing and sharing of notes, an Org-mode file can be exported as a
44 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
45 ;; iCalendar file. It can also serve as a publishing tool for a set of
46 ;; linked webpages.
47 ;;
48 ;; Installation and Activation
49 ;; ---------------------------
50 ;; See the corresponding sections in the manual at
51 ;;
52 ;; http://staff.science.uva.nl/~dominik/Tools/org/org.html#Installation
53 ;;
54 ;; Documentation
55 ;; -------------
56 ;; The documentation of Org-mode can be found in the TeXInfo file. The
57 ;; distribution also contains a PDF version of it. At the homepage of
58 ;; Org-mode, you can read the same text online as HTML. There is also an
59 ;; excellent reference card made by Philip Rooke. This card can be found
60 ;; in the etc/ directory of Emacs 22.
61 ;;
62 ;; Recent changes
63 ;; --------------
64 ;; Version 4.60
65 ;; - HTML export: inlining images, clickable images (manual 10.2.4).
66 ;; - Incremental search now shows proper context when exiting.
67 ;; - Tables calculation and Calc package.
68 ;; - Calc is no longer needed when using only elisp formulas.
69 ;; - Proper error messages when calc is needed and not available.
70 ;; - Tracking TODO state changes with time stamps and notes.
71 ;; - Empty entries go full circle.
72 ;; - Links in iCalendar export cleaned up.
73 ;; - Bug fixes.
74 ;;
75 ;; Version 4.59
76 ;; - Cleanup code, bug fixes.
77 ;;
78 ;; Version 4.58
79 ;; - Full undo support in the agenda buffer.
80 ;; - Listing stuck GTD projects (projects without any NEXT ACTIONS).
81 ;; Configure `org-stuck-projects' before using it.
82 ;; - C-c C-x b shows the current subtree in an indirect buffer, in
83 ;; another, dedicated frame.
84 ;; - Custom agenda commands take precedence over builtin commands.
85 ;; - auto-fill for comments works on the Emacs side, XEmacs not yet.
86 ;;
87 ;; Version 4.57
88 ;; - Sorting of outline items on same level.
89 ;; - Sorting tables automatically selects line range between hlines.
90 ;; - Changes in Agenda buffer
91 ;; - `C-c C-o' follows a link in the current line.
92 ;; - `C-c $' archives the subtree corresponding to the line.
93 ;; - Changing dates with S-left and S-right show new date in agenda,
94 ;; but still do not move the entry to the new date.
95 ;; - new option `org-agenda-skip-scheduled-if-done'.
96 ;; - Agenda and sparse tree construction using tag matches can now
97 ;; use regular expressions.
98 ;; - When prompted for a date/time, entering "+7" indicates a date
99 ;; 7 days from now - but only this is the only thing you give.
100 ;; - Custom time formats also apply to exported html and ascii.
101 ;; - Bug fixes.
102 ;;
103 ;; Version 4.56
104 ;; - `C-k' in agenda kills current line and corresponding subtree in file.
105 ;; - XEmacs compatibility issues fixed, in particular tag alignment.
106 ;; - M-left/right now in/outdents plain list items, no Shift needed.
107 ;; - Bug fixes.
108 ;;
109 ;;; Code:
111 ;;;; Require other packages
117 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
118 ;; the file noutline.el being loaded.
120 ;; We require noutline, which might be provided in outline.el
122 ;; Other stuff we need.
126 ;;;; Customization variables
128 ;;; Version
136 ;;; Compatibility constants
144 ;;; The custom variables
147 "Outline-based notes management and organizer."
154 "Options concerning startup of Org-mode."
159 "Non-nil means, entering Org-mode will switch to OVERVIEW.
160 This can also be configured on a per-file basis by adding one of
161 the following lines anywhere in the buffer:
163 #+STARTUP: fold
164 #+STARTUP: nofold
165 #+STARTUP: content"
173 "Non-nil means, entering Org-mode will set `truncate-lines'.
174 This is useful since some lines containing links can be very long and
175 uninteresting. Also tables look terrible when wrapped."
180 "Non-nil means, align all tables when visiting a file.
181 This is useful when the column width in tables is forced with <N> cookies
182 in table fields. Such tables will look correct only after the first re-align.
183 This can also be configured on a per-file basis by adding one of
184 the following lines anywhere in the buffer:
185 #+STARTUP: align
186 #+STARTUP: noalign"
191 "Non-nil means, entering Org-mode will run the deadline check.
192 This means, if you start editing an org file, you will get an
193 immediate reminder of any due deadlines.
194 This can also be configured on a per-file basis by adding one of
195 the following lines anywhere in the buffer:
196 #+STARTUP: dlcheck
197 #+STARTUP: nodlcheck"
202 "Non-nil means insert the first line setting Org-mode in empty files.
203 When the function `org-mode' is called interactively in an empty file, this
204 normally means that the file name does not automatically trigger Org-mode.
205 To ensure that the file will always be in Org-mode in the future, a
206 line enforcing Org-mode will be inserted into the buffer, if this option
207 has been set."
212 "Non-nil means use alternative key bindings for S-<cursor movement>.
213 Org-mode used S-<cursor movement> for changing timestamps and priorities.
214 S-<cursor movement> is also used for example by `CUA-mode' to select text.
215 If you want to use Org-mode together with `CUA-mode', Org-mode needs to use
216 alternative bindings. Setting this variable to t will replace the following
217 keys both in Org-mode and in the Org-agenda buffer.
219 S-RET -> C-S-RET
220 S-up -> M-p
221 S-down -> M-n
222 S-left -> M--
223 S-right -> M-+
225 If you do not like the alternative keys, take a look at the variable
226 `org-disputed-keys'.
228 This option is only relevant at load-time of Org-mode, and must be set
229 *before* org.el is loaded. Changing it requires a restart of Emacs to
230 become effective."
240 "Keys for which Org-mode and other modes compete.
241 This is an alist, cars are symbols for lookup, 1st element is the default key,
245 "Select a key according to `org-CUA-compatible'."
251 "The ellipsis to use in the Org-mode outline.
252 When nil, just use the standard three dots. When a string, use that instead,
253 and just in Org-mode (which will then use its own display table).
254 Changing this requires executing `M-x org-mode' in a buffer to become
255 effective."
264 "Keywords in Org-mode."
269 "String to mark deadline entries.
270 A deadline is this string, followed by a time stamp. Should be a word,
271 terminated by a colon. You can insert a schedule keyword and
273 Changes become only effective after restarting Emacs."
278 "String to mark scheduled TODO entries.
279 A schedule is this string, followed by a time stamp. Should be a word,
280 terminated by a colon. You can insert a schedule keyword and
282 Changes become only effective after restarting Emacs."
287 "String used as the prefix for timestamps logging closing a TODO entry."
292 "String used as prefix for timestamps clocking work hours on an item."
297 "Entries starting with this keyword will never be exported.
298 An entry can be toggled between COMMENT and normal with
300 Changes become only effective after restarting Emacs."
305 "Entries starting with this keyword will be exported in fixed-width font.
306 Quoting applies only to the text in the entry following the headline, and does
307 not extend beyond the next headline, even if that is lower level.
308 An entry can be toggled between QUOTE and normal with
314 "Regular expression for specifying repeated events.
318 "Options concerning the general structure of Org-mode files."
323 "Options about how to make context of a location visible."
328 "Non-nil means, show full hierarchy when revealing a location.
329 Org-mode often shows locations in an org-mode file which might have
330 been invisible before. When this is set, the hierarchy of headings
331 above the exposed location is shown.
332 Turning this off for example for sparse trees makes them very compact.
333 Instead of t, this can also be an alist specifying this option for different
334 contexts. Valid contexts are
335 agenda when exposing an entry from the agenda
336 org-goto when using the command `org-goto' on key C-c C-j
337 occur-tree when using the command `org-occur' on key C-c /
338 tags-tree when constructing a sparse tree based on tags matches
339 link-search when exposing search matches associated with a link
340 mark-goto when exposing the jump goal of a mark
341 bookmark-jump when exposing a bookmark location
342 isearch when exiting from an incremental search
343 default default for all contexts not set explicitly"
363 "Non-nil means, show following heading when revealing a location.
364 Org-mode often shows locations in an org-mode file which might have
365 been invisible before. When this is set, the heading following the
366 match is shown.
367 Turning this off for example for sparse trees makes them very compact,
368 but makes it harder to edit the location of the match. In such a case,
370 Instead of t, this can also be an alist specifying this option for different
371 contexts. See `org-show-hierarchy-above' for valid contexts."
391 "Non-nil means, show all sibling heading when revealing a location.
392 Org-mode often shows locations in an org-mode file which might have
393 been invisible before. When this is set, the sibling of the current entry
394 heading are all made visible. If `org-show-hierarchy-above' is t,
395 the same happens on each level of the hierarchy above the current entry.
397 By default this is on for the isearch context, off for all other contexts.
398 Turning this off for example for sparse trees makes them very compact,
399 but makes it harder to edit the location of the match. In such a case,
401 Instead of t, this can also be an alist specifying this option for different
402 contexts. See `org-show-hierarchy-above' for valid contexts."
422 "Options concerning visibility cycling in Org-mode."
427 "Cycle globally if cursor is at beginning of buffer and not at a headline.
428 This makes it possible to do global cycling without having to use S-TAB or
429 C-u TAB. For this special case to work, the first line of the buffer
430 must not be a headline - it may be empty ot some other text. When used in
431 this way, `org-cycle-hook' is disables temporarily, to make sure the
432 cursor stays at the beginning of the buffer.
433 When this option is nil, don't do anything special at the beginning
434 of the buffer."
439 "Where should `org-cycle' emulate TAB.
440 nil Never
441 white Only in completely white lines
442 whitestart Only at the beginning of lines, before the first non-white char.
443 t Everywhere except in headlines
444 If TAB is used in a place where it does not emulate TAB, the current subtree
445 visibility is cycled."
451 ))
454 org-optimize-window-after-visibility-change)
455 "Hook that is run after `org-cycle' has changed the buffer visibility.
456 The function(s) in this hook must accept a single argument which indicates
457 the new state that was set by the most recent `org-cycle' command. The
458 argument is a symbol. After a global state change, it can have the values
459 `overview', `content', or `all'. After a local state change, it can have
460 the values `folded', `children', or `subtree'."
466 "Options concerning structure editing in Org-mode."
471 "Non-nil means, skip even levels and only use odd levels for the outline.
472 This has the effect that two stars are being added/taken away in
473 promotion/demotion commands. It also influences how levels are
474 handled by the exporters.
475 Changing it requires restart of `font-lock-mode' to become effective
476 for fontification also in regions already fontified.
477 You may also set this on a per-file basis by adding one of the following
478 lines to the buffer:
480 #+STARTUP: odd
481 #+STARTUP: oddeven"
487 "Non-nil means, adapt indentation when promoting and demoting.
488 When this is set and the *entire* text in an entry is indented, the
489 indentation is increased by one space in a demotion command, and
490 decreased by one in a promotion command. If any line in the entry
491 body starts at column 0, indentation is not changed at all."
497 "Should `org-insert-heading' leave a blank line before new heading/item?
498 The value is an alist, with `heading' and `plain-list-item' as car,
499 and a boolean flag as cdr."
506 "Hook being run after inserting a new heading."
512 This currently only means, they are never auto-wrapped.
513 When nil, such lines will be treated like ordinary lines.
514 See also the QUOTE keyword."
519 "Options concerning sparse trees in Org-mode."
524 "Non-nil means, highlight all matches that define a sparse tree.
525 The highlights will automatically disappear the next time the buffer is
526 changed by an edit command."
531 "Non-nil means, any change to the buffer will remove temporary highlights.
532 Such highlights are created by `org-occur' and `org-clock-display'.
533 When nil, `C-c C-c needs to be used to get rid of the highlights.
534 The highlights created by `org-preview-latex-fragment' always need
535 `C-c C-c' to be removed."
542 "Hook that is run after `org-occur' has constructed a sparse tree.
543 This can be used to recenter the window to show as much of the structure
544 as possible."
549 "Options concerning plain lists in Org-mode."
554 "Non-nil means, include plain lists into visibility cycling.
555 This means that during cycling, plain list items will *temporarily* be
556 interpreted as outline headlines with a level given by 1000+i where i is the
557 indentation of the bullet. In all other operations, plain list items are
558 not seen as headlines. For example, you cannot assign a TODO keyword to
559 such an item."
564 "The character that makes a line with leading number an ordered list item.
565 Valid values are ?. and ?\). To get both terminators, use t. While
566 ?. may look nicer, it creates the danger that a line with leading
567 number may be incorrectly interpreted as an item. ?\) therefore is
568 the safe choice."
575 "Non-nil means, automatically renumber ordered plain lists.
576 Renumbering happens when the sequence have been changed with
583 "Non-nil means, update checkbox statistics after insert and toggle.
584 When this is set, checkbox statistics is updated each time you either insert
591 "Options concerning archiving in Org-mode."
596 "The tag that marks a subtree as archived.
597 An archived subtree does not open during visibility cycling, and does
598 not contribute to the agenda listings."
604 "Non-nil means, the agenda will skip any items located in archived trees.
605 An archived tree is a tree marked with the tag ARCHIVE."
611 "Non-nil means, `org-cycle' will open archived trees.
612 An archived tree is a tree marked with the tag ARCHIVE.
613 When nil, archived trees will stay folded. You can still open them with
614 normal outline commands like `show-all', but not with the cycling commands."
620 "Non-nil means sparse tree construction shows matches in archived trees.
621 When nil, matches in these trees are highlighted, but the trees are kept in
622 collapsed state."
628 "The location where subtrees should be archived.
629 This string consists of two parts, separated by a double-colon.
631 The first part is a file name - when omitted, archiving happens in the same
632 file. %s will be replaced by the current file name (without directory part).
633 Archiving to a different file is useful to keep archived entries from
634 contributing to the Org-mode Agenda.
636 The part after the double colon is a headline. The archived entries will be
637 filed under that headline. When omitted, the subtrees are simply filed away
638 at the end of the file, as top-level entries.
640 Here are a few examples:
642 If the current file is Projects.org, archive in file
643 Projects.org_archive, as top-level trees. This is the default.
646 Archive in the current file, under the top-level headline
650 Archive in file ~/org/archive.org (absolute path), as top-level trees.
653 Archive in file ./basement (relative path), as level 3 trees
656 You may set this option on a per-file basis by adding to the buffer a
657 line like
659 #+ARCHIVE: basement::** Finished Tasks"
664 "Non-nil means, mark entries as DONE when they are moved to the archive file."
669 "Non-nil means, add a time stamp to entries moved to an archive file.
670 The time stamp will be added directly after the TODO state keyword in the
671 first line, so it is probably best to use this in combinations with
672 `org-archive-mark-done'."
677 "Options concerning tables in Org-mode."
683 When nil, such lines will be treated like ordinary lines.
685 When equal to the symbol `optimized', the table editor will be optimized to
686 do the following:
687 - Automatic overwrite mode in front of whitespace in table fields.
688 This makes the structure of the table stay in tact as long as the edited
689 field does not exceed the column width.
690 - Minimize the number of realigns. Normally, the table is aligned each time
691 TAB or RET are pressed to move to another field. With optimization this
692 happens only if changes to a field might have changed the column width.
693 Optimization requires replacing the functions `self-insert-command',
694 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
695 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
696 very good at guessing when a re-align will be necessary, but you can always
699 If you would like to use the optimized version in Org-mode, but the
700 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
702 This variable can be used to turn on and off the table editor during a session,
703 but in order to toggle optimization, a restart is required.
705 See also the variable `org-table-auto-blank-field'."
713 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
714 In the optimized version, the table editor takes over all simple keys that
715 normally just insert a character. In tables, the characters are inserted
716 in a way to minimize disturbing the table structure (i.e. in overwrite mode
717 for empty fields). Outside tables, the correct binding of the keys is
718 restored.
720 The default for this option is t if the optimized version is also used in
721 Org-mode. See the variable `org-enable-table-editor' for details. Changing
722 this variable requires a restart of Emacs to become effective."
727 "Settings for tables in Org-mode."
732 "The default size for newly created tables, Columns x Rows."
738 "Regular expression for recognizing numbers in table columns.
739 If a table column contains mostly numbers, it will be aligned to the
740 right. If not, it will be aligned to the left.
742 The default value of this option is a regular expression which allows
743 anything which looks remotely like a number as used in scientific
744 context. For example, all of the following will be considered a
745 number:
746 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
748 Other options offered by the customize interface are more restrictive."
766 "Fraction of numbers in a column required to make the column align right.
767 In a column all non-white fields are considered. If at least this
768 fraction of fields is matched by `org-table-number-fraction',
769 alignment to the right border applies."
774 "Bahavior of tables during editing in Org-mode."
779 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
781 removal/insertion."
786 "Non-nil means, allow to limit the width of table columns with <N> fields."
791 "Non-nil means, automatically blank table field when starting to type into it.
792 This only happens when typing immediately after a field motion
793 command (TAB, S-TAB or RET).
794 Only relevant when `org-enable-table-editor' is equal to `optimized'."
799 "Non-nil means, tab in the last column of a table with jump over a hline.
800 If a horizontal separator line is following the current line,
801 `org-table-next-field' can either create a new row before that line, or jump
802 over the line. When this option is nil, a new line will be created before
803 this line."
808 "Non-nil means, TAB will automatically notice a table.el table.
809 When it sees such a table, it moves point into it and - if necessary -
810 calls `table-recognize-table'."
815 "Options concerning tables in Org-mode."
827 calc-angle-mode deg
828 calc-prefer-frac nil
829 calc-symbolic-mode nil
831 calc-display-working-message t
832 )
833 "List with Calc mode settings for use in calc-eval for table formulas.
834 The list must contain alternating symbols (Calc modes variables and values).
835 Don't remove any of the default settings, just change the values. Org-mode
836 relies on the variables to be present in the list."
841 "Non-nil means, TAB and RET evaluate a formula in current table field.
842 If the current field starts with an equal sign, it is assumed to be a formula
843 which should be evaluated as described in the manual and in the documentation
844 string of the command `org-table-eval-formula'. This feature requires the
845 Emacs calc package.
846 When this variable is nil, formula calculation is only available through
853 "Non-nil means, interpret constants in formulas in tables.
854 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
855 by the value given in `org-table-formula-constants', or by a value obtained
856 from the `constants.el' package."
861 "Alist with constant names and values, for use in table formulas.
862 The car of each element is a name of a constant, without the `$' before it.
863 The cdr is the value as a string. For example, if you'd like to use the
864 speed of light in a formula, you would configure
868 and then use it in an equation like `$1*$c'."
875 "Non-nil means, calculate only with numbers in table formulas.
876 Then all input fields will be converted to a number, and the result
877 must also be a number. When nil, calc's full potential is available
878 in table calculations, including symbolics etc."
883 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
884 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
889 "Options concerning links in Org-mode."
894 "buffer-local version of `org-link-abbrev-alist', which see.
899 "Alist of link abbreviations.
900 The car of each element is a string, to be replaced at the start of a link.
902 links in Org-mode buffers can have an optional tag after a double colon, e.g.
904 [[linkkey::tag][description]]
906 If REPLACE is a string, the tag will simply be appended to create the link.
908 also be a function that will be called with the tag as the only argument to
909 create the link. See the manual for examples."
914 "Non-nil means, hide link part and only show description of bracket links.
915 Bracket links are like [[link][descritpion]]. This variable sets the initial
916 state in new org-mode buffers. The setting can then be toggled on a
917 per-buffer basis from the Org->Hyperlinks menu."
923 Possible values are:
924 bracket [[link][description]]. This is recommended
932 "Default format for external, URL-like linkes in the buffer.
933 This is a format string for printf, %s will be replaced by the link text.
935 enclosing them in double brackets. If you prefer plain links (see variable
946 "How the path name in file links should be stored.
947 Valid values are:
949 relative relative to the current directory, i.e. the directory of the file
950 into which the link is being inserted.
951 absolute absolute path, if possible with ~ for home directory.
952 noabbrev absolute path, no abbreviation of home directory.
953 adaptive Use relative path for files in the current directory and sub-
954 directories of it. For other files, use an absolute path."
963 "Types of links that should be activated in Org-mode files.
964 This is a list of symbols, each leading to the activation of a certain link
965 type. In principle, it does not hurt to turn on most link types - there may
966 be a small gain when turning off unused link types. The types are:
968 bracket The recommended [[link][description]] or [[link]] links with hiding.
969 angular Links in angular brackes that may contain whitespace like
970 <bbdb:Carsten Dominik>.
971 plain Plain links in normal text, no whitespace, like http://google.com.
972 radio Text that is matched by a radio target, see manual for details.
973 tag Tag settings in a headline (link to tag search).
974 date Time stamps (link to calendar).
975 camel CamelCase words defining text searches.
977 Changing this variable requires a restart of Emacs to become effective."
988 "Options concerning storing links in Org-mode"
993 "Non-nil means, file links from `org-store-link' contain context.
994 A search string will be added to the file name with :: as separator and
995 used to find the context when the link is activated by the command
996 `org-open-at-point'.
998 negates this setting for the duration of the command."
1003 "Non-nil means, use CamelCase to store a search context in a file link.
1004 When nil, the search string simply consists of the words of the string.
1005 CamelCase is deprecated, and support for it may be dropped in the future."
1010 "Non-nil means, keep link in list for entire session.
1012 The command `org-store-link' adds a link pointing to the current
1013 location to an internal list. These links accumulate during a session.
1014 The command `org-insert-link' can be used to insert links into any
1015 Org-mode file (offering completion for all stored links). When this
1017 will be removed from the list, to make completing the unused links
1018 more efficient."
1023 "Non-nil means, `org-store-link' will create web links to Google groups.
1024 When nil, Gnus will be used for such links.
1026 negates this setting for the duration of the command."
1031 "Options concerning following links in Org-mode"
1036 "Non-nil means, on links TAB will follow the link.
1037 Needs to be set before org.el is loaded."
1042 "Non-nil means, on links RET will follow the link.
1043 Needs to be set before org.el is loaded."
1048 "Non-nil means, mouse-1 on a link will follow the link.
1049 A longer mouse click will still set point. Does not wortk on XEmacs.
1050 Needs to be set before org.el is loaded."
1055 "Number of different positions to be recorded in the ring
1056 Changing this requires a restart of Emacs to work correctly."
1064 "Setup the frame configuration for following links.
1065 When following a link with Emacs, it may often be useful to display
1066 this link in another window or frame. This variable can be used to
1067 set this up for the different types of links.
1068 For VM, use any of
1069 `vm-visit-folder'
1070 `vm-visit-folder-other-frame'
1071 For Gnus, use any of
1072 `gnus'
1073 `gnus-other-frame'
1074 For FILE, use any of
1075 `find-file'
1076 `find-file-other-window'
1077 `find-file-other-frame'
1078 For the calendar, use the variable `calendar-setup'.
1079 For BBDB, it is currently only possible to display the matches in
1080 another window."
1099 "Non-nil means, use indirect buffer to display infile links.
1100 Activating internal links (from one location in a file to another location
1101 in the same file) normally just jumps to the location. When the link is
1102 activated with a C-u prefix (or with mouse-3), the link is displayed in
1103 another window. When this option is set, the other window actually displays
1104 an indirect buffer clone of the current buffer, to avoid any visibility
1105 changes to the current buffer."
1111 "Non-nil means, `org-open-file' will open non-existing file.
1112 When nil, an error will be generated."
1117 "Function and arguments to call for following mailto links.
1118 This is a list with the first element being a lisp function, and the
1119 remaining elements being arguments to the function. In string arguments,
1120 %a will be replaced by the address, and %s will be replaced by the subject
1121 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1130 "Non-nil means, ask for confirmation before executing shell links.
1131 Shell links can be dangerous, just thing about a link
1133 [[shell:rm -rf ~/*][Google Search]]
1136 but really it would remove your entire home directory.
1137 Therefore I *definitely* advise against setting this variable to nil.
1138 Just change it to `y-or-n-p' of you want to confirm with a single key press
1147 "Non-nil means, ask for confirmation before executing elisp links.
1148 Elisp links can be dangerous, just think about a link
1153 but really it would remove your entire home directory.
1154 Therefore I *definitely* advise against setting this variable to nil.
1155 Just change it to `y-or-n-p' of you want to confirm with a single key press
1166 "Default file applications on a UNIX or GNU/Linux system.
1178 "Default file applications on a MacOS X system.
1180 for some files for which the OS does not have a good default.
1188 'mswindows-shell-execute
1191 "Default file applications on a Windows NT system.
1196 '(
1203 )
1204 "External applications for opening `file:path' items in a document.
1205 Org-mode uses system defaults for different file types, but
1206 you can use this variable to set the application for a given file
1207 extension. The entries in this list are cons cells where the car identifies
1208 files and the cdr the corresponding command. Possible values for the
1209 file identifier are
1211 `directory' Matches a directory
1212 `remote' Matches a remote file, accessible through tramp or efs.
1213 Remote files most likely should be visited through Emacs
1214 because external applications cannot handle such paths.
1215 t Default for all remaining files
1217 Possible values for the command are:
1218 `emacs' The file will be visited by the current Emacs process.
1219 `default' Use the default application for this file type.
1220 string A command to be executed by a shell; %s will be replaced
1221 by the path to the file.
1222 sexp A Lisp form which will be evaluated. The file path will
1223 be available in the Lisp variable `file'.
1224 For more examples, see the system specific constants
1225 `org-file-apps-defaults-macosx'
1226 `org-file-apps-defaults-windowsnt'
1227 `org-file-apps-defaults-gnu'."
1242 "Non-nil means, that the search for the mh-message will be extended to
1243 all folders if the message cannot be found in the folder given in the link.
1244 Searching all folders is very effective with one of the search engines
1245 supported by MH-E, but will be slow with pick."
1250 "Options concerning interaction with remember.el."
1255 "Directory with org files.
1256 This directory will be used as default to prompt for org files.
1257 Used by the hooks for remember.el."
1262 "Default target for storing notes.
1263 Used by the hooks for remember.el. This can be a string, or nil to mean
1264 the value of `remember-data-file'."
1268 file))
1271 "Templates for the creation of remember buffers.
1272 When nil, just let remember make the buffer.
1273 When not nil, this is a list of 3-element lists. In each entry, the first
1274 element is a character, a unique key to select this template.
1275 The second element is the template. The third element is optional and can
1276 specify a destination file for remember items created with this template.
1277 The default file is given by `org-default-notes-file'.
1279 The template specifies the structure of the remember buffer. It should have
1280 a first line starting with a star, to act as the org-mode headline.
1281 Furthermore, the following %-escapes will be replaced with content:
1282 %t time stamp, date only
1283 %T time stamp with date and time
1284 %u inactive time stamp, date only
1285 %U inactive time stamp with date and time
1286 %n user name
1287 %a annotation, normally the link created with org-store-link
1288 %i initial content, the region when remember is called with C-u.
1289 If %i is indented, the entire inserted text will be indented as well.
1290 %? This will be removed, and the cursor placed at this position."
1299 "Non-nil means, store new notes at the beginning of a file or entry.
1300 When nil, new notes will be filed to the end of a file or entry."
1309 "Options concerning TODO items in Org-mode."
1314 "Options concerning Progress logging in Org-mode."
1319 "List of TODO entry keywords.
1322 action is required, and will make the entry show up in todo lists, diaries
1323 etc.
1325 additional state where no keyword is present. For details about this
1326 cycling, see also the variable `org-todo-interpretation'
1327 Changes become only effective after restarting Emacs."
1333 "Controls how TODO keywords are interpreted.
1334 This variable is only relevant if `org-todo-keywords' contains more than two
1339 to state when executed several times in direct succession. Otherwise, it
1340 switches directly to DONE from any state.
1341 See the manual for more information."
1348 "Hook which is run after the state of a TODO item was changed.
1349 The new state (a string with a TODO keyword, or nil) is available in the
1350 Lisp variable `state'."
1355 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1356 When the state of an entry is changed from nothing to TODO, remove a previous
1357 closing date.
1359 This can also be a list of symbols indicating under which conditions
1360 the time stamp recording the action should be annotated with a short note.
1361 Valid members of this list are
1363 done Offer to record a note when marking entries done
1364 state Offer to record a note whenever changing the TODO state
1365 of an item. This is only relevant if TODO keywords are
1366 interpreted as sequence, see variable `org-todo-interpretation'.
1367 When `state' is set, this includes tracking `done'.
1368 clock-out Offer to record a note when clocking out of an item.
1370 A separate window will then pop up and allow you to type a note.
1371 After finishing with C-c C-c, the note will be added directly after the
1372 timestamp, as a plain list item. See also the variable
1373 `org-log-note-headings'.
1375 Logging can also be configured on a per-file basis by adding one of
1376 the following lines anywhere in the buffer:
1378 #+STARTUP: logdone
1379 #+STARTUP: nologging
1380 #+STARTUP: lognotedone
1381 #+STARTUP: lognotestate
1382 #+STARTUP: lognoteclock-out"
1397 "Headings for notes added when clocking out or closing TODO items.
1398 The value is an alist, with the car being a sympol indicating the note
1399 context, and the cdr is the heading to be used. The heading may also be the
1400 empty string.
1401 %t in the heading will be replaced by a time stamp.
1402 %s will be replaced by the new TODO state, in double quotes.
1403 %u will be replaced by the user name.
1404 %U will be replaced by the full user name."
1410 "Heading when changing todo state (todo sequence only)"
1415 "Priorities in Org-mode."
1420 "The default priority of TODO items.
1421 This is the priority an item get if no explicit priority is given."
1426 "The lowest priority of TODO items. A character like ?A, ?B etc."
1431 "Options concerning time stamps and deadlines in Org-mode."
1436 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1437 When nil, these labeled time stamps are forces into the second line of an
1438 entry, just after the headline. When scheduling from the global TODO list,
1439 the time stamp will always be forced into the second line."
1444 "Formats for `format-time-string' which are used for time stamps.
1448 "Number of minutes to round time stamps to upon insertion.
1449 When zero, insert the time unmodified. Useful rounding numbers
1450 should be factors of 60, so for example 5, 10, 15.
1451 When this is not zero, you can still force an exact time-stamp by using
1452 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1457 "Non-nil means, overlay custom formats over all time stamps.
1458 The formats are defined through the variable `org-time-stamp-custom-formats'.
1459 To turn this on on a per-file basis, insert anywhere in the file:
1460 #+STARTUP: customtime"
1468 "Custom formats for time stamps. See `format-time-string' for the syntax.
1469 These are overlayed over the default ISO format if the variable
1470 `org-display-custom-times' is set."
1475 "Get the right format for a time string."
1480 f)))
1483 "No. of days before expiration during which a deadline becomes active.
1484 This variable governs the display in sparse trees and in the agenda."
1489 "Non-nil means, pop up a calendar when prompting for a date.
1490 In the calendar, the date can be selected with mouse-1. However, the
1491 minibuffer will also be active, and you can simply enter the date as well.
1492 When nil, only the minibuffer will be available."
1497 "Non-nil means, make the calendar window follow timestamp changes.
1498 When a timestamp is modified and the calendar window is visible, it will be
1499 moved to the new date."
1504 "Options concerning tags in Org-mode."
1509 "List of tags allowed in Org-mode files.
1510 When this list is nil, Org-mode will base TAG input on what is already in the
1511 buffer.
1512 The value of this variable is an alist, the car may be (and should) be a
1513 character that is used to select that tag through the fast-tag-selection
1514 interface. See the manual for details."
1524 "Non-nil means, use fast tag selection scheme.
1525 This is a special interface to select and deselect tags with single keys.
1526 When nil, fast selection is never used.
1527 When the symbol `auto', fast selection is used if and only if selection
1528 characters for tags have been configured, either through the variable
1529 `org-tag-alist' or through a #+TAGS line in the buffer.
1530 When t, fast selection is always used and selection keys are assigned
1531 automatically if necessary."
1539 "Non-nil means, fast tag selection exits after first change.
1540 When nil, you have to press RET to exit it.
1541 During fast tag selection, you can toggle this flag with `C-c'."
1546 "The column to which tags should be indented in a headline.
1547 If this number is positive, it specifies the column. If it is negative,
1548 it means that the tags should be flushright to that column. For example,
1549 -79 works well for a normal 80 character screen."
1554 "Non-nil means, realign tags after pro/demotion of TODO state change.
1555 These operations change the length of a headline and therefore shift
1556 the tags around. With this options turned on, after each such operation
1557 the tags are again aligned to `org-tags-column'."
1562 "Non-nil means, tags in levels apply also for sublevels.
1563 When nil, only the tags directly given in a specific line apply there.
1564 If you turn off this option, you very likely want to turn on the
1565 companion option `org-tags-match-list-sublevels'."
1570 "Non-nil means list also sublevels of headlines matching tag search.
1571 Because of tag inheritance (see variable `org-use-tag-inheritance'),
1572 the sublevels of a headline matching a tag search often also match
1573 the same search. Listing all of them can create very long lists.
1574 Setting this variable to nil causes subtrees of a match to be skipped.
1575 This option is off by default, because inheritance in on. If you turn
1576 inheritance off, you very likely want to turn this option on.
1578 As a special case, if the tag search is restricted to TODO items, the
1579 value of this variable is ignored and sublevels are always checked, to
1580 make sure all corresponding TODO items find their way into the list."
1590 "Options concerning agenda views in Org-mode."
1595 "Variable used by org files to set a category for agenda display.
1596 Such files should use a file variable to set it, for example
1600 or contain a special line
1602 #+CATEGORY: ELisp
1604 If the file does not specify a category, then file's base name
1609 "The files to be used for agenda display.
1613 If the value of the variable is not a list but a single file name, then
1614 the list of agenda files is actually stored and maintained in that file, one
1615 agenda file per line."
1623 "When set, remote killing from the agenda buffer needs confirmation.
1624 When t, a confirmation is always needed. When a number N, confirmation is
1625 only needed when the text to be killed contains more than N non-white lines."
1633 "The key to be installed in `calendar-mode-map' for switching to the agenda.
1634 The command `org-calendar-goto-agenda' will be bound to this key. The
1635 default is the character `c' because then `c' can be used to switch back and
1636 forth between agenda and calendar."
1641 "Options concerning agenda views in Org-mode."
1646 "Custom commands for the agenda.
1647 These commands will be offered on the splash screen displayed by the
1650 (key type match options)
1652 key The key (a single char as a string) to be associated with the command.
1653 type The command type, any of the following symbols:
1654 todo Entries with a specific TODO keyword, in all agenda files.
1655 tags Tags match in all agenda files.
1656 tags-todo Tags match in all agenda files, TODO entries only.
1657 todo-tree Sparse tree of specific TODO keyword in *current* file.
1658 tags-tree Sparse tree with all tags matches in *current* file.
1659 occur-tree Occur sparse tree for *current* file.
1660 match What to search for:
1661 - a single keyword for TODO keyword searches
1662 - a tags match expression for tags searches
1663 - a regular expression for occur searches
1664 options A list of option setttings, similar to that in a let form, so like
1665 this: ((opt1 val1) (opt2 val2) ...)
1667 You can also define a set of commands, to create a composite agenda buffer.
1668 In this case, an entry looks like this:
1670 (key desc (cmd1 cmd2 ...) general-options)
1672 where
1674 desc A description string to be displayed in the dispatcher menu.
1675 cmd An agenda command, similar to the above. However, tree commands
1676 are no allowed, but instead you can get agenda and global todo list.
1677 So valid commands for a set are:
1678 (agenda)
1679 (alltodo)
1684 Each command can carry a list of options, and another set of options can be
1685 given for the whole set of commands. Individual command options take
1686 precedence over the general options."
1744 "How to identify stuck projects.
1745 This is a list of three items:
1746 1. A tags/todo matcher string that is used to identify a project.
1747 The entire tree below a headline matched by this is considered a project.
1748 2. A list of TODO keywords itentifying non-stuck projects.
1749 If the project subtree contains any headline with one of these todo
1750 keywords, the project is consitered to be not stuck.
1751 3. A list of tags identifying non-stuck projects.
1752 If the project subtree contains any headline with one of these tags,
1753 the project is consitered to be not stuck.
1756 or `C-c a #' to produce the list."
1760 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
1761 (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))))
1765 "Options concerning skipping parts of agenda files."
1770 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
1771 When nil, the sublevels of a TODO entry are not checked, resulting in
1772 potentially much shorter TODO lists."
1778 "Non-nil means, don't show scheduled entries in the global todo list.
1779 The idea behind this is that by scheduling it, you have already taken care
1780 of this item."
1786 "Non-nil means, don't show near deadline entries in the global todo list.
1787 Near means closer than `org-deadline-warning-days' days.
1788 The idea behind this is that such items will appear in the agenda anyway."
1794 "Non-nil means don't show scheduled items in agenda when they are done.
1795 This is relevant for the daily/weekly agenda, not for the TODO list."
1800 "Non-nil means, `org-timeline' also shows dates without an entry.
1801 When nil, only the days which actually have entries are shown.
1802 When t, all days between the first and the last date are shown.
1803 When an integer, show also empty dates, but if there is a gap of more than
1804 N days, just insert a special line indicating the size of the gap."
1813 "Options concerning initial settings in the Agenda in Org Mode."
1818 "Hook run just before displaying an agenda buffer."
1823 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
1824 A longer mouse click will still set point. Does not wortk on XEmacs.
1825 Needs to be set before org.el is loaded."
1830 "The initial value of follwo-mode in a newly created agenda window."
1835 "Options concerning the windows used by the Agenda in Org Mode."
1840 "How the agenda buffer should be displayed.
1841 Possible values for this option are:
1843 current-window Show agenda in the current window, keeping all other windows.
1844 other-frame Use `switch-to-buffer-other-frame' to display agenda.
1845 other-window Use `switch-to-buffer-other-window' to display agenda.
1846 reorganize-frame Show only two windows on the current frame, the current
1847 window and the agenda. Also, if the option
1848 `org-fit-agenda-window' is set, resize the agenda window to
1849 try to show as much as possible of the buffer content.
1850 See also the variable `org-agenda-restore-windows-after-quit'."
1859 "Non-nil means, restore window configuration open exiting agenda.
1860 Before the window configuration is changed for displaying the agenda,
1861 the current status is recorded. When the agenda is exited with
1862 `q' or `x' and this option is set, the old state is restored. If
1863 `org-agenda-window-setup' is `other-frame', the value of this
1864 option will be ignored.."
1868 ;; FIXME: I think this variable could be removed, default set to t
1870 "Non-nil means, after creating an agenda, move cursor into Agenda window.
1871 When nil, cursor will remain in the current window."
1875 ;; FIXME: I think this variable could be removed, default set to t
1877 "Non-nil means, change window size of agenda to fit content.
1878 This is only effective if `org-agenda-window-setup' is `reorganize-frame'."
1883 "How should indirect tree buffers be displayed?
1884 This applies to indirect buffers created with the commands
1886 Valid values are:
1887 current-window Display in the current window
1888 other-window Just display in another window.
1889 dedicated-frame Create one new frame, and re-use it each time.
1890 new-frame Make a new frame each time."
1900 "Options concerning the daily/weekly agenda."
1905 "Number of days to include in overview display.
1906 Should be 1 or 7."
1911 "Non-nil means, start the overview always on the specified weekday.
1912 0 denotes Sunday, 1 denotes Monday etc.
1913 When nil, always start on the current day."
1918 "Non-nil means, `org-agenda' shows every day in the selected range.
1919 When nil, only the days which actually have entries are shown."
1924 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
1928 ;; FIXME: This variable could be removed
1930 "Set means weekly/daily agenda will always contain all TODO entries.
1931 The TODO entries will be listed at the top of the agenda, before
1932 the entries for specific days."
1937 "Options concerning the time grid in the Org-mode Agenda."
1942 "Non-nil means, show a time grid in the agenda schedule.
1943 A time grid is a set of lines for specific times (like every two hours between
1944 8:00 and 20:00). The items scheduled for a day at specific times are
1945 sorted in between these lines.
1946 For details about when the grid will be shown, and what it will look like, see
1947 the variable `org-agenda-time-grid'."
1953 "----------------"
1956 "The settings for time grid for agenda display.
1957 This is a list of three items. The first item is again a list. It contains
1958 symbols specifying conditions when the grid should be displayed:
1960 daily if the agenda shows a single day
1961 weekly if the agenda shows an entire week
1962 today show grid on current date, independent of daily/weekly display
1963 require-timed show grid only if at least one item has a time specification
1965 The second item is a string which will be places behing the grid time.
1967 The third item is a list of integers, indicating the times that should have
1968 a grid line."
1970 :type
1977 require-timed)
1979 remove-match))
1984 "Options concerning sorting in the Org-mode Agenda."
1999 "Sorting structure for the agenda items of a single day.
2000 This is a list of symbols which will be used in sequence to determine
2001 if an entry should be listed before another entry. The following
2002 symbols are recognized:
2004 time-up Put entries with time-of-day indications first, early first
2005 time-down Put entries with time-of-day indications first, late first
2006 category-keep Keep the default order of categories, corresponding to the
2007 sequence in `org-agenda-files'.
2008 category-up Sort alphabetically by category, A-Z.
2009 category-down Sort alphabetically by category, Z-A.
2010 tag-up Sort alphabetically by last tag, A-Z.
2011 tag-down Sort alphabetically by last tag, Z-A.
2012 priority-up Sort numerically by priority, high priority last.
2013 priority-down Sort numerically by priority, high priority first.
2015 The different possibilities will be tried in sequence, and testing stops
2017 '(time-up category-keep priority-down)
2018 means: Pull out all entries having a specified time of day and sort them,
2019 in order to make a time schedule for the current day the first thing in the
2020 agenda listing for the day. Of the entries without a time indication, keep
2021 the grouped in categories, don't sort the categories, but keep them in
2022 the sequence given in `org-agenda-files'. Within each category sort by
2023 priority.
2025 Leaving out `category-keep' would mean that items will be sorted across
2026 categories by priority."
2039 "Non-nil means, items without time are considered late.
2040 This is only relevant for sorting. When t, items which have no explicit
2041 time like 15:30 will be considered as 99:01, i.e. later than any items which
2042 do have a time. When nil, the default time is before 0:00. You can use this
2043 option to decide if the schedule for today should come before or after timeless
2044 agenda entries."
2049 "Options concerning the entry prefix in the Org-mode agenda display."
2058 "Format specifications for the prefix of items in the agenda views.
2059 An alist with four entries, for the different agenda types. The keys to the
2060 sublists are `agenda', `timeline', `todo', and `tags'. The values
2061 are format strings.
2062 This format works similar to a printf format, with the following meaning:
2065 as given by the CATEGORY keyword or derived from the file name.
2066 %T the *last* tag of the item. Last because inherited tags come
2067 first in the list.
2068 %t the time-of-day specification if one applies to the entry, in the
2069 format HH:MM
2070 %s Scheduling/Deadline information, a short string
2072 All specifiers work basically like the standard `%s' of printf, but may
2073 contain two additional characters: A question mark just after the `%' and
2074 a whitespace/punctuation character just before the final letter.
2076 If the first character after `%' is a question mark, the entire field
2077 will only be included if the corresponding value applies to the
2078 current entry. This is useful for fields which should have fixed
2079 width when present, but zero width when absent. For example,
2081 day is specified, but will completely disappear in entries which do
2082 not contain a time.
2084 If there is punctuation or whitespace character just before the final
2085 format letter, this character will be appended to the field value if
2088 empty, no additional colon would be interted.
2091 - Indent the line with two space characters
2092 - Give the category in a 12 chars wide field, padded with whitespace on
2093 the right (because of `-'). Append a colon if there is a category
2094 (because of `:').
2095 - If there is a time-of-day, put it into a 12 chars wide field. If no
2096 time, don't put in an empty field, just skip it (because of '?').
2097 - Finally, put the scheduling information and append a whitespace.
2099 As another example, if you don't want the time-of-day of entries in
2100 the prefix, you could use:
2104 See also the variables `org-agenda-remove-times-when-in-prefix' and
2105 `org-agenda-remove-tags-when-in-prefix'."
2116 "The compiled version of the most recently used prefix format.
2120 "Non-nil means, remove duplicate time specifications in agenda items.
2121 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2122 time-of-day specification in a headline or diary entry is extracted and
2123 placed into the prefix. If this option is non-nil, the original specification
2124 \(a timestamp or -range, or just a plain time(range) specification like
2125 11:30-4pm) will be removed for agenda display. This makes the agenda less
2126 cluttered.
2127 The option can be t or nil. It may also be the symbol `beg', indicating
2128 that the time should only be removed what it is located at the beginning of
2129 the headline/diary entry."
2137 "Non-nil means, remove the tags from the headline copy in the agenda.
2138 When this is the symbol `prefix', only remove tags when
2139 `org-agenda-prefix-format' contains a `%T' specifier."
2147 "Shift tags in agenda items to this column."
2152 "Options for embedding LaTeX code into Org-mode"
2159 "Options for creating images from LaTeX fragments.
2160 This is a property list with the following properties:
2163 :scale a scaling factor for the size of the images
2164 :matchers a list indicating which matchers should be used to
2165 find LaTeX fragments. Valid members of this list are:
2175 "Options for exporting org-listings."
2180 "General options for exporting Org-mode files."
2185 "Path to the location where exported files should be located.
2186 This path may be relative to the directory where the Org-mode file lives.
2187 The default is to put them into the same directory as the Org-mode file.
2188 The variable may also be an alist with export types `:html', `:ascii',
2189 `:ical', or `:xoxo' and the corresponding directories. If a direcoty path
2190 is relative, it is interpreted relative to the directory where the exported
2191 Org-mode files lives."
2212 "Terms used in export text, translated to different languages.
2213 Use the variable `org-export-default-language' to set the language,
2214 or use the +OPTION lines for a per-file setting."
2224 "The default language of HTML export, as a string.
2225 This should have an association in `org-export-language-setup'."
2230 "The last level which is still exported as a headline.
2231 Inferior levels will produce itemize lists when exported.
2232 Note that a numeric prefix argument to an exporter function overrides
2233 this setting.
2240 "Non-nil means, add section numbers to headlines when exporting.
2247 "Non-nil means, create a table of contents in exported files.
2248 The TOC contains headlines with levels up to`org-export-headline-levels'.
2251 ASCII export, and with red color in HTML output.
2253 In HTML output, the TOC will be clickable.
2260 "Non-nil means, mark TOC lines that contain any open TODO items."
2265 "Non-nil means, preserve all line breaks when exporting.
2266 Normally, in HTML output paragraphs will be reformatted. In ASCII
2267 export, line breaks will always be preserved, regardless of this variable.
2274 "Whether subtrees with the ARCHIVE tag should be exported.
2275 This can have three different values
2276 nil Do not export, pretend this tree is not present
2277 t Do export the entire tree
2278 headline Only export the headline, but skip the tree below it."
2287 "If nil, do not export time stamps and associated keywords."
2292 "If nil, remove timestamps from the table of contents entries."
2297 "If nil, do not export tags, just remove them from headlines.
2298 If this is the symbol `not-in-toc', tags will be removed from table of
2299 contents entries, but still be shown in the headlines of the document."
2307 "Options for translating special ascii sequences for the export backends."
2312 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
2313 If the export target supports emphasizing text, the word will be
2314 typeset in bold, italic, or underlined, respectively. Works only for
2315 single words, but you can say: I *really* *mean* *this*.
2316 Not all export backends support this.
2324 When this option is turned on, you can use TeX-like syntax for sub- and
2326 considered as a single item - so grouping with {} is normally not
2327 needed. For example, the following things will be parsed as single
2328 sub- or superscripts.
2330 10^24 or 10^tau several digits will be considered 1 item.
2331 10^-12 or 10^-tau a leading sign with digits or a word
2332 x^2-y^3 will be read as x^2 - y^3, because items are
2333 terminated by almost any nonword/nondigit char.
2334 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
2336 Still, ambiguity is possible - so when in doubt use {} to enclose the
2337 sub/superscript.
2338 Not all export backends support this, but HTML does.
2345 "Non-nil means, interpret simple TeX-like macros when exporting.
2347 No only real TeX macros will work here, but the standard HTML entities
2348 for math can be used as macro names as well. For a list of supported
2349 names in HTML export, see the constant `org-html-entities'.
2350 Not all export backends support this.
2358 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
2360 the first non-white thing on a line. It will also find the math delimiters
2362 display math.
2371 This can be used to have pre-formatted text, fragments of code etc. For
2372 example:
2373 : ;; Some Lisp examples
2374 : (while (defc cnt)
2375 : (ding))
2376 will be looking just like this in also HTML. See also the QUOTE keyword.
2377 Not all export backends support this.
2384 "Number of stacked braces for sub/superscript matching.
2385 This has to be set before loading org.el to be effective."
2390 "Options for exporting tables in Org-mode."
2396 For example:
2398 | Name | Address | Birthday |
2399 |-------------+----------+-----------|
2400 | Arthur Dent | England | 29.2.2100 |
2402 Not all export backends support this.
2409 "Non-nil means, highlight the first table line.
2410 In HTML export, this means use <th> instead of <td>.
2411 In tables created with table.el, this applies to the first table line.
2412 In Org-mode tables, all lines before the first horizontal separator
2413 line will be formatted with <th> tags."
2418 "Remove special lines and marking characters in calculating tables.
2419 This removes the special marking character column from tables that are set
2420 up for spreadsheet calculations. It also removes the entire lines
2421 marked with `!', `_', or `^'. The lines with `$' are kept, because
2422 the values of constants may be useful to have."
2427 "Non-nil means, always export tables created with table.el natively.
2428 Natively means, use the HTML code generator in table.el.
2429 When nil, Org-mode's own HTML generator is used when possible (i.e. if
2430 the table does not use row- or column-spanning). This has the
2431 advantage, that the automatic HTML conversions for math symbols and
2432 sub/superscripts can be applied. Org-mode's HTML generator is also
2433 much faster."
2438 "Options specific for ASCII export of Org-mode files."
2443 "Characters for underlining headings in ASCII export.
2444 In the given sequence, these characters will be used for level 1, 2, ..."
2449 "Bullet characters for headlines converted to lists in ASCII export.
2450 The first character is is used for the first lest level generated in this
2451 way, and so on. If there are more levels than characters given here,
2452 the list will be repeated.
2453 Note that plain lists will keep the same bullets as the have in the
2454 Org-mode file."
2459 "Non-nil means, popup buffer containing the exported ASCII text.
2460 Otherwise the buffer will just be saved to a file and stay hidden."
2465 "Options specific for XML export of Org-mode files."
2470 "Options specific for HTML export of Org-mode files."
2476 html {
2477 font-family: Times, serif;
2478 font-size: 12pt;
2479 }
2480 .title { text-align: center; }
2481 .todo { color: red; }
2482 .done { color: green; }
2483 .timestamp { color: grey }
2484 .timestamp-kwd { color: CadetBlue }
2485 .tag { background-color:lightblue; font-weight:normal }
2486 .target { background-color: lavender; }
2487 pre {
2488 border: 1pt solid #AEBDCC;
2489 background-color: #F3F5F7;
2490 padding: 5pt;
2491 font-family: courier, monospace;
2492 }
2493 table { border-collapse: collapse; }
2494 td, th {
2495 vertical-align: top;
2496 border: 1pt solid #ADB9CC;
2497 }
2498 </style>"
2499 "The default style specification for exported HTML files.
2500 Since there are different ways of setting style information, this variable
2501 needs to contain the full HTML structure to provide a style, including the
2502 surrounding HTML tags. The style specifications should include definitions
2503 for new classes todo, done, title, and deadline. For example, legal values
2504 would be:
2507 p { font-weight: normal; color: gray; }
2508 h1 { color: black; }
2509 .title { text-align: center; }
2510 .todo, .deadline { color: red; }
2511 .done { color: green; }
2512 </style>
2514 or, if you want to keep the style in a file,
2518 As the value of this option simply gets inserted into the HTML <head> header,
2524 "Format for typesetting the document title in HTML export."
2529 "The <H> level for level 1 headings in HTML export."
2534 "Non-nil means, make file links to `file.org' point to `file.html'.
2535 When org-mode is exporting an org-mode file to HTML, links to
2536 non-html files are directly put into a href tag in HTML.
2537 However, links to other Org-mode files (recognized by the
2538 extension `.org.) should become links to the corresponding html
2539 file, assuming that the linked org-mode file will also be
2540 converted to HTML.
2541 When nil, the links still point to the plain `.org' file."
2546 "Non-nil means, inline images into exported HTML pages.
2547 This is done using an <img> tag. When nil, an anchor with href is used to
2548 link to the image. If this option is `maybe', then images in links with
2549 an empty description will be inlined, while images with a description will
2550 be linked only."
2557 "Non-nil means, for HTML export, treat @<...> as HTML tag.
2558 When nil, these tags will be exported as plain text and therefore
2559 not be interpreted by a browser.
2567 "The HTML tag used to start a table.
2568 This must be a <table> tag, but you may change the options like
2569 borders and spacing."
2574 "If non-nil, write `org-export-html-html-helper-timestamp'
2575 into the exported HTML text. Otherwise, the buffer will just be saved
2576 to a file."
2582 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
2587 "Non-nil means, popup buffer containing the exported html text.
2588 Otherwise, the buffer will just be saved to a file and stay hidden."
2593 "Options specific for iCalendar export of Org-mode files."
2598 "The file name for the iCalendar file covering all agenda files.
2600 The file name should be absolute."
2605 "Non-nil means, export to iCalendar files should also cover TODO items."
2610 "Calendar name for the combined iCalendar representing all agenda files."
2615 "Font-lock settings for highlighting in Org-mode."
2620 "Non-nil means fontify only the stars in each headline.
2621 When nil, the entire headline is fontified.
2622 Changing it requires restart of `font-lock-mode' to become effective
2623 also in regions already fontified."
2628 "Non-nil means, hide the first N-1 stars in a headline.
2629 This works by using the face `org-hide' for these stars. This
2630 face is white for a light background, and black for a dark
2631 background. You may have to customize the face `org-hide' to
2632 make this work.
2633 Changing it requires restart of `font-lock-mode' to become effective
2634 also in regions already fontified.
2635 You may also set this on a per-file basis by adding one of the following
2636 lines to the buffer:
2638 #+STARTUP: hidestars
2639 #+STARTUP: showstars"
2644 "Non-nil means, change the face of a headline if it is marked DONE.
2645 Normally, only the TODO/DONE keyword indicates the state of a headline.
2646 When this is non-nil, the headline after the keyword is set to the
2647 `org-headline-done' as an additional indication."
2652 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2653 Changing this variable requires a restart of Emacs to take effect."
2662 "Set variable and compute the emphasis regular expression."
2666 org-emphasis-alist org-emphasis-regexp-components)
2676 ;; make sure special characters appear at the right position in the class
2681 ; (while (>= (setq nl (1- nl)) 0) (setq body1 (concat body1 "\n?" body "*?")))
2682 ; (while (>= (setq nl (1- nl)) 0) (setq body1 (concat body1 "\\(?:\n?" body "*?\\)?")))
2686 ;; Make the regexp
2693 body1
2701 "Components used to build the reqular expression for emphasis.
2702 This is a list with 6 entries. Terminology: In an emphasis string
2706 specify what is allowed/forbidden in each part:
2708 pre Chars allowed as prematch. Beginning of line will be allowed too.
2709 post Chars allowed as postmatch. End of line will be allowed too.
2710 border The chars *forbidden* as border characters. In addition to the
2711 characters given here, all marker characters are forbidden too.
2713 non-shy groups here, and don't allow newline here.
2714 newline The maximum number of newlines allowed in an emphasis exp.
2715 stacked Non-nil means, allow stacked styles. This works only in HTML
2716 export. When this is set, all marker characters (as given in
2717 `org-emphasis-alist') will be allowed as pre/post, aiding
2718 inside-out matching.
2719 Use customize to modify this, or restart Emacs after changing it."
2736 )
2737 "Special syntax for emphasized text.
2738 Text starting and ending with a special character will be emphasized, for
2739 example *bold*, _underlined_ and /italic/. This variable sets the marker
2740 characters, the face to bbe used by font-lock for highlighting in Org-mode
2741 Emacs buffers, and the HTML tags to be used for this.
2742 Use customize to modify this, or restart Emacs after changing it."
2754 ;;; The faces
2757 "Faces in Org-mode."
2762 "Make a compatible face specification.
2763 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
2764 For them we convert a (min-colors 8) entry to a `tty' entry and move it
2765 to the top of the list. The `min-colors' attribute will be removed from
2766 any other entries, and any resulting duplicates will be removed entirely."
2780 specs))
2785 "Face used to hide leading stars in headlines.
2786 The forground color of this face should be equal to the background
2787 color of the frame."
2798 "Face used for level 1 headlines."
2808 "Face used for level 2 headlines."
2820 "Face used for level 3 headlines."
2832 "Face used for level 4 headlines."
2840 "Face used for level 5 headlines."
2848 "Face used for level 6 headlines."
2856 "Face used for level 7 headlines."
2864 "Face used for level 8 headlines."
2872 "Face used for special keywords."
2882 "Face for deadlines and TODO keywords."
2890 "Face used to indicate that a headline is DONE.
2891 This face is only used if `org-fontify-done-headline' is set."
2904 "Face for headline with the ARCHIVE tag."
2911 "Face for links."
2918 "Face for links."
2923 "Face for tags."
2933 "Face for TODO keywords."
2942 "Face used for DONE."
2953 "Face used for tables."
2963 "Face for formulas."
2972 "Face for items scheduled for a certain day."
2982 "Face for items scheduled previously, and not yet done."
2992 "Face for items scheduled previously, and not yet done."
3000 "Face used for time grids."
3005 org-level-5 org-level-6 org-level-7 org-level-8
3006 ))
3010 ;;; Variables for pre-computed regular expressions, all buffer local
3025 "Matches a headline and puts TODO state into group 2 if present.
3073 rear-nonsticky t mouse-map t)
3080 s)
3085 s)
3094 "Make VAR local in current buffer and set it to VALUE."
3098 "Check if the current buffer is in Org-mode."
3102 "Return the last element of LIST."
3112 ;; FIXME: document this, in particular the push argument.
3136 "Precompute regular expressions for current buffer."
3142 kwds int key value cat arch tags links)
3169 links)))
3172 l var val)
3186 )))
3201 tgs))
3209 ;; Compute the regular expressions and other local variables
3214 org-done-string
3216 org-todo-regexp
3219 org-not-done-regexp
3225 org-todo-line-regexp
3229 org-nl-done-regexp
3231 org-todo-line-tags-regexp
3237 org-deadline-time-regexp
3239 org-deadline-line-regexp
3241 org-scheduled-regexp
3243 org-scheduled-time-regexp
3245 org-closed-time-regexp
3247 org-keyword-time-regexp
3253 org-keyword-time-not-clock-regexp
3258 org-maybe-keyword-time-regexp
3268 ;;; Some variables ujsed in various places
3273 "Function to be called when `C-c C-c' is used.
3276 ;;; Foreign variables, to inform the compiler
3278 ;; XEmacs only
3283 ;; Emacs only
3286 ;; Packages that org-mode interacts with
3317 ;; FIXME: Occasionally check by commenting these, to make sure
3318 ;; no other functions uses these, forgetting to let-bind them.
3326 ;; Defined somewhere in this file, but used before definition.
3339 ;;;; Emacs/XEmacs compatibility
3341 ;; Overlay compatibility functions
3359 "Make overlay OVL display TEXT with face FACE."
3382 "Find all overlays specifying PROP at POS or point.
3383 If DELETE is non-nil, delete all those overlays."
3385 ov found)
3389 found))
3391 ;; Region compatibility
3394 "Add-hook, compatible with both Emacsen."
3403 "Is `transient-mark-mode' on and the region active?
3404 Works on both Emacs and XEmacs."
3406 nil
3411 ;; Invisibility compatibility
3414 "Add elements to `buffer-invisibility-spec'.
3415 See documentation for `buffer-invisibility-spec' for the kind of elements
3416 that can be added."
3427 "Remove elements from `buffer-invisibility-spec'."
3435 "Is ARG a member of `buffer-invisibility-spec'?"
3438 nil))
3440 ;;;; Define the Org-mode
3443 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or ugrade to newer allout, for example by switching to Emacs 22."))
3446 ;; We use a before-change function to check if a table might need
3447 ;; an update.
3449 "Indicates that a table might need an update.
3450 This variable is set by `org-before-change-function'.
3458 ;;;###autoload
3460 "Outline-based notes management and organizer, alias
3463 Org-mode develops organizational tasks around a NOTES file which
3464 contains information about projects as plain text. Org-mode is
3465 implemented on top of outline-mode, which is ideal to keep the content
3466 of large files well structured. It supports ToDo items, deadlines and
3467 time stamps, which magically appear in the diary listing of the Emacs
3468 calendar. Tables are easily created with a built-in table editor.
3469 Plain text URL-like links connect to websites, emails (VM), Usenet
3470 messages (Gnus), BBDB entries, and any files related to the project.
3471 For printing and sharing of notes, an Org-mode file (or a part of it)
3472 can be exported as a structured ASCII or HTML file.
3474 The following commands are available:
3478 ;; Get rid of Outline menus, they are not needed
3479 ;; Need to do this here because define-derived-mode sets up
3480 ;; the keymap so late. Still, it is a waste to call this each time
3481 ;; we switch another buffer into org-mode.
3484 ;; Assume this is Greg's port, it used easymenu
3500 ;;(setq outline-regexp "\\(?:\\*+\\|[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\) \\)")
3509 ;; Calc embedded
3515 ;; Activate before-change-function
3519 ;; Check for running clock before killing a buffer
3521 ;; Paragraphs and auto-filling
3524 ;; Make isearch reveal context
3527 ;; Emacs 21 and XEmacs make use of the hook
3529 ;; Emacs 22 deals with this through a special variable
3533 ;; If empty file that did not turn on org-mode automatically, make it to.
3554 "Call COMMAND interactively, but pretend prefix are was ARG."
3563 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
3573 "Add text properties to entire string, from beginning to end.
3574 PLIST may be a list of properties, PROPS are individual properties and values
3575 that will be added to PLIST. Returns the string that was modified."
3578 string)
3582 ;;;; Font-Lock stuff, including the activators
3587 (define-key org-mouse-map
3588 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
3589 (when org-mouse-1-follows-link
3590 (define-key org-mouse-map [follow-link] 'mouse-face))
3591 (when org-tab-follows-link
3592 (define-key org-mouse-map [(tab)] 'org-open-at-point)
3593 (define-key org-mouse-map "\C-i" 'org-open-at-point))
3594 (when org-return-follows-link
3595 (define-key org-mouse-map [(return)] 'org-open-at-point)
3596 (define-key org-mouse-map "\C-m" 'org-open-at-point))
3598 (require 'font-lock)
3601 (defconst org-link-types '("https?" "ftp" "mailto" "file" "news" "bbdb" "vm"
3602 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp"))
3603 (defconst org-link-re-with-space
3604 (concat
3607 "[^" org-non-link-chars "]*"
3609 "Matches a link with spaces, optional angular brackets around it.")
3611 (defconst org-link-re-with-space2
3612 (concat
3617 "Matches a link with spaces, optional angular brackets around it.")
3619 (defconst org-angle-link-re
3620 (concat
3623 "[^" org-non-link-chars "]*"
3625 "Matches link with angular brackets, spaces are allowed.")
3626 (defconst org-plain-link-re
3627 (concat
3630 "Matches plain link, without spaces.")
3632 (defconst org-bracket-link-regexp
3634 "Matches a link in double brackets.")
3636 (defconst org-bracket-link-analytic-regexp
3637 (concat
3644 ; 1: http:
3645 ; 2: http
3646 ; 3: path
3647 ; 4: [desc]
3648 ; 5: desc
3650 (defconst org-ts-lengths
3651 (cons (length (format-time-string (car org-time-stamp-formats)))
3652 (length (format-time-string (cdr org-time-stamp-formats))))
3653 "This holds the lengths of the two different time formats.")
3655 "Regular expression for fast time stamp matching.")
3657 "Regular expression for fast time stamp matching.")
3658 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
3659 "Regular expression matching time strings for analysis.")
3660 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 ">")
3661 "Regular expression matching time stamps, with groups.")
3662 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[]>]")
3663 "Regular expression matching time stamps (also [..]), with groups.")
3664 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
3665 "Regular expression matching a time stamp range.")
3666 (defconst org-tr-regexp-both
3667 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
3668 "Regular expression matching a time stamp range.")
3671 "Regular expression matching a time stamp or time stamp range.")
3674 "Regular expression matching a time stamp or time stamp range.
3675 The time stamps may be either active or inactive.")
3677 (defvar org-emph-face nil)
3679 (defun org-do-emphasis-faces (limit)
3680 "Run through the buffer and add overlays to links."
3681 (if (re-search-forward org-emph-re limit t)
3682 (progn
3683 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
3684 'face
3685 (nth 1 (assoc (match-string 3)
3686 org-emphasis-alist)))
3687 (add-text-properties (match-beginning 2) (match-end 2)
3688 '(font-lock-multiline t))
3689 (backward-char 1)
3690 t)))
3692 (defun org-activate-plain-links (limit)
3693 "Run through the buffer and add overlays to links."
3694 (if (re-search-forward org-plain-link-re limit t)
3695 (progn
3696 (add-text-properties (match-beginning 0) (match-end 0)
3697 (list 'mouse-face 'highlight
3698 'rear-nonsticky t
3699 'keymap org-mouse-map
3700 ))
3701 t)))
3703 (defun org-activate-angle-links (limit)
3704 "Run through the buffer and add overlays to links."
3705 (if (re-search-forward org-angle-link-re limit t)
3706 (progn
3707 (add-text-properties (match-beginning 0) (match-end 0)
3708 (list 'mouse-face 'highlight
3709 'rear-nonsticky t
3710 'keymap org-mouse-map
3711 ))
3712 t)))
3714 (defmacro org-maybe-intangible (props)
3715 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
3716 In emacs 21, invisible text is not avoided by the command loop, so the
3717 intangible property is needed to make sure point skips this text.
3718 In Emacs 22, this is not necessary. The intangible text property has
3719 led to problems with flyspell. These problems are fixed in flyspell.el,
3720 but we still avoid setting the property in Emacs 22 and later.
3721 We use a macro so that the test can happen at compilation time."
3722 (if (< emacs-major-version 22)
3723 `(append '(intangible t) ,props)
3724 props))
3726 (defun org-activate-bracket-links (limit)
3727 "Run through the buffer and add overlays to bracketed links."
3728 (if (re-search-forward org-bracket-link-regexp limit t)
3729 (let* ((help (concat "LINK: "
3730 (org-match-string-no-properties 1)))
3731 ;; FIXME: above we should remove the escapes.
3732 ;; but that requires another match, protecting match data,
3733 ;; a lot of overhead for font-lock.
3734 (ip (org-maybe-intangible
3735 (list 'invisible 'org-link 'rear-nonsticky t
3736 'keymap org-mouse-map 'mouse-face 'highlight
3737 'help-echo help)))
3738 (vp (list 'rear-nonsticky t
3739 'keymap org-mouse-map 'mouse-face 'highlight
3740 'help-echo help)))
3741 ;; We need to remove the invisible property here. Table narrowing
3742 ;; may have made some of this invisible.
3743 (remove-text-properties (match-beginning 0) (match-end 0)
3744 '(invisible nil))
3745 (if (match-end 3)
3746 (progn
3747 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
3748 (add-text-properties (match-beginning 3) (match-end 3) vp)
3749 (add-text-properties (match-end 3) (match-end 0) ip))
3750 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
3751 (add-text-properties (match-beginning 1) (match-end 1) vp)
3752 (add-text-properties (match-end 1) (match-end 0) ip))
3753 t)))
3755 (defun org-activate-dates (limit)
3756 "Run through the buffer and add overlays to dates."
3757 (if (re-search-forward org-tsr-regexp-both limit t)
3758 (progn
3759 (add-text-properties (match-beginning 0) (match-end 0)
3760 (list 'mouse-face 'highlight
3761 'rear-nonsticky t
3762 'keymap org-mouse-map))
3763 (when org-display-custom-times
3764 (if (match-end 3)
3765 (org-display-custom-time (match-beginning 3) (match-end 3)))
3766 (org-display-custom-time (match-beginning 1) (match-end 1)))
3767 t)))
3769 (defvar org-target-link-regexp nil
3770 "Regular expression matching radio targets in plain text.")
3772 "Regular expression matching a link target.")
3774 "Regular expression matching a link target.")
3776 (defun org-activate-target-links (limit)
3777 "Run through the buffer and add overlays to target matches."
3778 (when org-target-link-regexp
3779 (let ((case-fold-search t))
3780 (if (re-search-forward org-target-link-regexp limit t)
3781 (progn
3782 (add-text-properties (match-beginning 0) (match-end 0)
3783 (list 'mouse-face 'highlight
3784 'rear-nonsticky t
3785 'keymap org-mouse-map
3786 'help-echo "Radio target link"
3787 'org-linked-text t))
3788 t)))))
3790 (defun org-update-radio-target-regexp ()
3791 "Find all radio targets in this file and update the regular expression."
3792 (interactive)
3793 (when (memq 'radio org-activate-links)
3794 (setq org-target-link-regexp
3795 (org-make-target-link-regexp (org-all-targets 'radio)))
3796 (org-restart-font-lock)))
3798 (defun org-hide-wide-columns (limit)
3799 (let (s e)
3800 (setq s (text-property-any (point) (or limit (point-max))
3801 'org-cwidth t))
3802 (when s
3803 (setq e (next-single-property-change s 'org-cwidth))
3804 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
3805 (goto-char e)
3806 t)))
3808 (defun org-restart-font-lock ()
3809 "Restart font-lock-mode, to force refontification."
3810 (when (and (boundp 'font-lock-mode) font-lock-mode)
3811 (font-lock-mode -1)
3812 (font-lock-mode 1)))
3814 (defun org-all-targets (&optional radio)
3815 "Return a list of all targets in this file.
3816 With optional argument RADIO, only find radio targets."
3817 (let ((re (if radio org-radio-target-regexp org-target-regexp))
3818 rtn)
3819 (save-excursion
3820 (goto-char (point-min))
3821 (while (re-search-forward re nil t)
3822 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
3823 rtn)))
3825 (defun org-make-target-link-regexp (targets)
3826 "Make regular expression matching all strings in TARGETS.
3827 The regular expression finds the targets also if there is a line break
3828 between words."
3829 (and targets
3830 (concat
3832 (mapconcat
3833 (lambda (x)
3834 (while (string-match " +" x)
3836 x)
3837 targets
3842 "Matches CamelCase words, possibly with a star before it.")
3844 (defun org-activate-camels (limit)
3845 "Run through the buffer and add overlays to dates."
3846 (if (re-search-forward org-camel-regexp limit t)
3847 (progn
3848 (add-text-properties (match-beginning 0) (match-end 0)
3849 (list 'mouse-face 'highlight
3850 'rear-nonsticky t
3851 'keymap org-mouse-map))
3852 t)))
3854 (defun org-activate-tags (limit)
3856 (progn
3857 (add-text-properties (match-beginning 1) (match-end 1)
3858 (list 'mouse-face 'highlight
3859 'rear-nonsticky t
3860 'keymap org-mouse-map))
3861 t)))
3863 (defun org-font-lock-level ()
3864 (save-excursion
3865 (org-back-to-heading t)
3866 (- (match-end 0) (match-beginning 0))))
3868 (defun org-outline-level ()
3869 (save-excursion
3870 (looking-at outline-regexp)
3871 (if (match-beginning 1)
3872 (+ (org-get-string-indentation (match-string 1)) 1000)
3873 (- (match-end 0) (match-beginning 0)))))
3875 (defvar org-font-lock-keywords nil)
3877 (defun org-set-font-lock-defaults ()
3878 (let* ((em org-fontify-emphasized-text)
3879 (lk org-activate-links)
3880 (org-font-lock-extra-keywords
3881 ;; Headlines
3882 (list
3884 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
3886 (1 'org-table))
3887 ;; Links
3888 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
3889 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
3890 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
3891 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
3892 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
3893 (if (memq 'camel lk) '(org-activate-camels (0 'org-link t)))
3894 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
3895 (if org-table-limit-column-width
3896 '(org-hide-wide-columns (0 nil append)))
3897 ;; TODO lines
3899 '(1 'org-todo t))
3900 ;; Priorities
3902 ;; Special keywords
3903 (list org-repeat-re '(0 'org-special-keyword t))
3908 ;; Emphasis
3909 (if em
3910 (if (featurep 'xemacs)
3911 '(org-do-emphasis-faces (0 nil append))
3912 '(org-do-emphasis-faces)))
3913 ;; Checkboxes, similar to Frank Ruell's org-checklet.el
3915 2 'bold prepend)
3916 (if org-provide-checkbox-statistics
3918 (0 (org-get-checkbox-statistics-face) t)))
3919 ;; COMMENT
3922 '(1 'org-special-keyword t))
3923 '("^#.*" (0 'font-lock-comment-face t))
3924 ;; DONE
3925 (if org-fontify-done-headline
3927 '(1 'org-done t) '(2 'org-headline-done t))
3929 '(1 'org-done t)))
3930 ;; Table stuff
3934 (if org-format-transports-properties-p
3937 )))
3938 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
3939 ;; Now set the full font-lock-keywords
3940 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
3941 (org-set-local 'font-lock-defaults
3942 '(org-font-lock-keywords t nil nil backward-paragraph))
3943 (kill-local-variable 'font-lock-keywords) nil))
3945 (defvar org-m nil)
3946 (defvar org-l nil)
3947 (defvar org-f nil)
3948 (defun org-get-level-face (n)
3949 "Get the right face for match N in font-lock matching of healdines."
3950 (setq org-l (- (match-end 2) (match-beginning 1)))
3951 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
3952 ; (setq org-f (nth (1- (% org-l org-n-levels)) org-level-faces))
3953 (setq org-f (nth (% (1- org-l) org-n-levels) org-level-faces))
3954 (cond
3955 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
3956 ((eq n 2) org-f)
3957 (t (if org-level-color-stars-only nil org-f))))
3959 (defun org-unfontify-region (beg end &optional maybe_loudly)
3960 "Remove fontification and activation overlays from links."
3961 (font-lock-default-unfontify-region beg end)
3962 (let* ((buffer-undo-list t)
3963 (inhibit-read-only t) (inhibit-point-motion-hooks t)
3964 (inhibit-modification-hooks t)
3965 deactivate-mark buffer-file-name buffer-file-truename)
3966 (remove-text-properties beg end
3967 '(mouse-face t keymap t org-linked-text t
3968 rear-nonsticky t
3969 invisible t intangible t))))
3971 ;;;; Visibility cycling, including org-goto and indirect buffer
3973 ;;; Cycling
3975 (defvar org-cycle-global-status nil)
3976 (make-variable-buffer-local 'org-cycle-global-status)
3977 (defvar org-cycle-subtree-status nil)
3978 (make-variable-buffer-local 'org-cycle-subtree-status)
3980 ;;;###autoload
3981 (defun org-cycle (&optional arg)
3982 "Visibility cycling for Org-mode.
3984 - When this function is called with a prefix argument, rotate the entire
3985 buffer through 3 states (global cycling)
3986 1. OVERVIEW: Show only top-level headlines.
3987 2. CONTENTS: Show all headlines of all levels, but no body text.
3988 3. SHOW ALL: Show everything.
3990 - When point is at the beginning of a headline, rotate the subtree started
3991 by this line through 3 different states (local cycling)
3992 1. FOLDED: Only the main headline is shown.
3993 2. CHILDREN: The main headline and the direct children are shown.
3994 From this state, you can move to one of the children
3995 and zoom in further.
3996 3. SUBTREE: Show the entire subtree, including body text.
3998 - When there is a numeric prefix, go up to a heading with level ARG, do
3999 a `show-subtree' and return to the previous cursor position. If ARG
4000 is negative, go up that many levels.
4002 - When point is not at the beginning of a headline, execute
4003 `indent-relative', like TAB normally does. See the option
4004 `org-cycle-emulate-tab' for details.
4006 - Special case: if point is the the beginning of the buffer and there is
4007 no headline in line 1, this function will act as if called with prefix arg."
4008 (interactive "P")
4009 (let* ((outline-regexp
4010 (if (and (org-mode-p) org-cycle-include-plain-lists)
4012 outline-regexp))
4013 (bob-special (and org-cycle-global-at-bob (bobp)
4014 (not (looking-at outline-regexp))))
4015 (org-cycle-hook
4016 (if bob-special
4017 (delq 'org-optimize-window-after-visibility-change
4018 (copy-sequence org-cycle-hook))
4019 org-cycle-hook))
4020 (pos (point)))
4022 (if (or bob-special (equal arg '(4)))
4023 ;; special case: use global cycling
4024 (setq arg t))
4026 (cond
4028 ((org-at-table-p 'any)
4029 ;; Enter the table or move to the next field in the table
4030 (or (org-table-recognize-table.el)
4031 (progn
4032 (if arg (org-table-edit-field t)
4033 (org-table-justify-field-maybe)
4034 (call-interactively 'org-table-next-field)))))
4036 ((eq arg t) ;; Global cycling
4038 (cond
4039 ((and (eq last-command this-command)
4040 (eq org-cycle-global-status 'overview))
4041 ;; We just created the overview - now do table of contents
4042 ;; This can be slow in very large buffers, so indicate action
4043 (message "CONTENTS...")
4044 (org-content)
4045 (message "CONTENTS...done")
4046 (setq org-cycle-global-status 'contents)
4047 (run-hook-with-args 'org-cycle-hook 'contents))
4049 ((and (eq last-command this-command)
4050 (eq org-cycle-global-status 'contents))
4051 ;; We just showed the table of contents - now show everything
4052 (show-all)
4053 (message "SHOW ALL")
4054 (setq org-cycle-global-status 'all)
4055 (run-hook-with-args 'org-cycle-hook 'all))
4057 (t
4058 ;; Default action: go to overview
4059 (org-overview)
4060 (message "OVERVIEW")
4061 (setq org-cycle-global-status 'overview)
4062 (run-hook-with-args 'org-cycle-hook 'overview))))
4064 ((integerp arg)
4065 ;; Show-subtree, ARG levels up from here.
4066 (save-excursion
4067 (org-back-to-heading)
4068 (outline-up-heading (if (< arg 0) (- arg)
4069 (- (funcall outline-level) arg)))
4070 (org-show-subtree)))
4072 ((save-excursion (beginning-of-line 1) (looking-at outline-regexp))
4073 ;; At a heading: rotate between three different views
4074 (org-back-to-heading)
4075 (let ((goal-column 0) eoh eol eos)
4076 ;; First, some boundaries
4077 (save-excursion
4078 (org-back-to-heading)
4079 (save-excursion
4080 (beginning-of-line 2)
4081 (while (and (not (eobp)) ;; this is like `next-line'
4082 (get-char-property (1- (point)) 'invisible))
4083 (beginning-of-line 2)) (setq eol (point)))
4084 (outline-end-of-heading) (setq eoh (point))
4085 (org-end-of-subtree t)
4087 (setq eos (1- (point))))
4088 ;; Find out what to do next and set `this-command'
4089 (cond
4090 ((= eos eoh)
4091 ;; Nothing is hidden behind this heading
4092 (message "EMPTY ENTRY")
4093 (setq org-cycle-subtree-status nil))
4094 ((>= eol eos)
4095 ;; Entire subtree is hidden in one line: open it
4096 (org-show-entry)
4097 (show-children)
4098 (message "CHILDREN")
4099 (setq org-cycle-subtree-status 'children)
4100 (run-hook-with-args 'org-cycle-hook 'children))
4101 ((and (eq last-command this-command)
4102 (eq org-cycle-subtree-status 'children))
4103 ;; We just showed the children, now show everything.
4104 (org-show-subtree)
4105 (message "SUBTREE")
4106 (setq org-cycle-subtree-status 'subtree)
4107 (run-hook-with-args 'org-cycle-hook 'subtree))
4108 (t
4109 ;; Default action: hide the subtree.
4110 (hide-subtree)
4111 (message "FOLDED")
4112 (setq org-cycle-subtree-status 'folded)
4113 (run-hook-with-args 'org-cycle-hook 'folded)))))
4115 ;; TAB emulation
4116 (buffer-read-only (org-back-to-heading))
4118 ((org-try-cdlatex-tab))
4120 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
4122 (or (and (eq org-cycle-emulate-tab 'white)
4123 (= (match-end 0) (point-at-eol)))
4124 (and (eq org-cycle-emulate-tab 'whitestart)
4125 (>= (match-end 0) pos))))
4126 t
4127 (eq org-cycle-emulate-tab t))
4130 (point-at-bol) (point))))
4131 (progn
4132 (beginning-of-line 1)
4134 (indent-relative))
4136 (t (save-excursion
4137 (org-back-to-heading)
4138 (org-cycle))))))
4140 ;;;###autoload
4141 (defun org-global-cycle (&optional arg)
4142 "Cycle the global visibility. For details see `org-cycle'."
4143 (interactive "P")
4144 (let ((org-cycle-include-plain-lists
4145 (if (org-mode-p) org-cycle-include-plain-lists nil)))
4146 (if (integerp arg)
4147 (progn
4148 (show-all)
4149 (hide-sublevels arg)
4150 (setq org-cycle-global-status 'contents))
4151 (org-cycle '(4)))))
4153 (defun org-overview ()
4154 "Switch to overview mode, shoing only top-level headlines.
4155 Really, this shows all headlines with level equal or greater than the level
4156 of the first headline in the buffer. This is important, because if the
4157 first headline is not level one, then (hide-sublevels 1) gives confusing
4158 results."
4159 (interactive)
4160 (hide-sublevels (save-excursion
4161 (goto-char (point-min))
4162 (if (re-search-forward (concat "^" outline-regexp) nil t)
4163 (progn
4164 (goto-char (match-beginning 0))
4165 (funcall outline-level))
4166 1))))
4168 ;; FIXME: allow an argument to give a limiting level for this.
4169 (defun org-content ()
4170 "Show all headlines in the buffer, like a table of contents"
4171 (interactive)
4172 (save-excursion
4173 ;; Visit all headings and show their offspring
4174 (goto-char (point-max))
4175 (catch 'exit
4176 (while (and (progn (condition-case nil
4177 (outline-previous-visible-heading 1)
4178 (error (goto-char (point-min))))
4179 t)
4180 (looking-at outline-regexp))
4181 (show-branches)
4182 (if (bobp) (throw 'exit nil))))))
4185 (defun org-optimize-window-after-visibility-change (state)
4186 "Adjust the window after a change in outline visibility.
4187 This function is the default value of the hook `org-cycle-hook'."
4188 (when (get-buffer-window (current-buffer))
4189 (cond
4190 ((eq state 'overview) (org-first-headline-recenter 1))
4191 ((eq state 'content) nil)
4192 ((eq state 'all) nil)
4193 ((eq state 'folded) nil)
4194 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
4195 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
4197 (defun org-subtree-end-visible-p ()
4198 "Is the end of the current subtree visible?"
4199 (pos-visible-in-window-p
4200 (save-excursion (org-end-of-subtree t) (point))))
4202 (defun org-first-headline-recenter (&optional N)
4203 "Move cursor to the first headline and recenter the headline.
4204 Optional argument N means, put the headline into the Nth line of the window."
4205 (goto-char (point-min))
4207 (beginning-of-line)
4208 (recenter (prefix-numeric-value N))))
4210 ;;; Org-goto
4212 (defvar org-goto-window-configuration nil)
4213 (defvar org-goto-marker nil)
4214 (defvar org-goto-map (make-sparse-keymap))
4215 (let ((cmds '(isearch-forward isearch-backward)) cmd)
4216 (while (setq cmd (pop cmds))
4217 (substitute-key-definition cmd cmd org-goto-map global-map)))
4218 (define-key org-goto-map "\C-m" 'org-goto-ret)
4219 (define-key org-goto-map [(left)] 'org-goto-left)
4220 (define-key org-goto-map [(right)] 'org-goto-right)
4221 (define-key org-goto-map [(?q)] 'org-goto-quit)
4222 (define-key org-goto-map [(control ?g)] 'org-goto-quit)
4223 (define-key org-goto-map "\C-i" 'org-cycle)
4224 (define-key org-goto-map [(tab)] 'org-cycle)
4225 (define-key org-goto-map [(down)] 'outline-next-visible-heading)
4226 (define-key org-goto-map [(up)] 'outline-previous-visible-heading)
4227 (define-key org-goto-map "n" 'outline-next-visible-heading)
4228 (define-key org-goto-map "p" 'outline-previous-visible-heading)
4229 (define-key org-goto-map "f" 'outline-forward-same-level)
4230 (define-key org-goto-map "b" 'outline-backward-same-level)
4231 (define-key org-goto-map "u" 'outline-up-heading)
4232 (define-key org-goto-map "\C-c\C-n" 'outline-next-visible-heading)
4233 (define-key org-goto-map "\C-c\C-p" 'outline-previous-visible-heading)
4234 (define-key org-goto-map "\C-c\C-f" 'outline-forward-same-level)
4235 (define-key org-goto-map "\C-c\C-b" 'outline-backward-same-level)
4236 (define-key org-goto-map "\C-c\C-u" 'outline-up-heading)
4237 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
4238 (while l (define-key org-goto-map (int-to-string (pop l)) 'digit-argument)))
4240 (defconst org-goto-help
4241 "Select a location to jump to, press RET
4242 \[Up]/[Down]=next/prev headline TAB=cycle visibility RET=select [Q]uit")
4244 (defun org-goto ()
4245 "Go to a different location of the document, keeping current visibility.
4247 When you want to go to a different location in a document, the fastest way
4248 is often to fold the entire buffer and then dive into the tree. This
4249 method has the disadvantage, that the previous location will be folded,
4250 which may not be what you want.
4252 This command works around this by showing a copy of the current buffer in
4253 overview mode. You can dive into the tree in that copy, to find the
4254 location you want to reach. When pressing RET, the command returns to the
4255 original buffer in which the visibility is still unchanged. It then jumps
4256 to the new location, making it and the headline hierarchy above it visible."
4257 (interactive)
4258 (let* ((org-goto-start-pos (point))
4259 (selected-point
4260 (org-get-location (current-buffer) org-goto-help)))
4261 (if selected-point
4262 (progn
4263 (org-mark-ring-push org-goto-start-pos)
4264 (goto-char selected-point)
4265 (if (or (org-invisible-p) (org-invisible-p2))
4266 (org-show-context 'org-goto)))
4267 (error "Quit"))))
4269 (defvar org-selected-point nil) ; dynamically scoped parameter
4271 (defun org-get-location (buf help)
4272 "Let the user select a location in the Org-mode buffer BUF.
4273 This function uses a recursive edit. It returns the selected position
4274 or nil."
4275 (let (org-selected-point)
4276 (save-excursion
4277 (save-window-excursion
4278 (delete-other-windows)
4279 (switch-to-buffer (get-buffer-create "*org-goto*"))
4280 (with-output-to-temp-buffer "*Help*"
4281 (princ help))
4282 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
4283 (setq buffer-read-only nil)
4284 (erase-buffer)
4285 (insert-buffer-substring buf)
4286 (let ((org-startup-truncated t)
4287 (org-startup-folded t)
4288 (org-startup-align-all-tables nil)
4289 (org-startup-with-deadline-check nil))
4290 (org-mode))
4291 (setq buffer-read-only t)
4292 (if (boundp 'org-goto-start-pos)
4293 (goto-char org-goto-start-pos)
4294 (goto-char (point-min)))
4295 (org-beginning-of-line)
4296 (message "Select location and press RET")
4297 ;; now we make sure that during selection, ony very few keys work
4298 ;; and that it is impossible to switch to another window.
4299 (let ((gm (current-global-map))
4300 (overriding-local-map org-goto-map))
4301 (unwind-protect
4302 (progn
4303 (use-global-map org-goto-map)
4304 (recursive-edit))
4305 (use-global-map gm)))))
4306 (kill-buffer "*org-goto*")
4307 org-selected-point))
4309 (defun org-goto-ret (&optional arg)
4310 "Finish `org-goto' by going to the new location."
4311 (interactive "P")
4312 (setq org-selected-point (point)
4313 current-prefix-arg arg)
4314 (throw 'exit nil))
4316 (defun org-goto-left ()
4317 "Finish `org-goto' by going to the new location."
4318 (interactive)
4319 (if (org-on-heading-p)
4320 (progn
4321 (beginning-of-line 1)
4322 (setq org-selected-point (point)
4323 current-prefix-arg (- (match-end 0) (match-beginning 0)))
4324 (throw 'exit nil))
4325 (error "Not on a heading")))
4327 (defun org-goto-right ()
4328 "Finish `org-goto' by going to the new location."
4329 (interactive)
4330 (if (org-on-heading-p)
4331 (progn
4332 (outline-end-of-subtree)
4333 (or (eobp) (forward-char 1))
4334 (setq org-selected-point (point)
4335 current-prefix-arg (- (match-end 0) (match-beginning 0)))
4336 (throw 'exit nil))
4337 (error "Not on a heading")))
4339 (defun org-goto-quit ()
4340 "Finish `org-goto' without cursor motion."
4341 (interactive)
4342 (setq org-selected-point nil)
4343 (throw 'exit nil))
4345 ;;; Indirect buffer display of subtrees
4347 (defvar org-indirect-dedicated-frame nil
4348 "This is the frame being used for indirect tree display.")
4349 (defvar org-last-indirect-buffer nil)
4351 (defun org-tree-to-indirect-buffer (&optional arg)
4352 "Create indirect buffer and narrow it to current subtree.
4353 With numerical prefix ARG, go up to this level and then take that tree.
4354 If ARG is negative, go up that many levels.
4355 Normally this command removes the indirect buffer previously made
4356 with this command. However, when called with a C-u prefix, the last buffer
4357 is kept so that you can work with several indirect buffers at the same time.
4358 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
4359 requests that a new frame be made for the new buffer, so that the dedicated
4360 frame is not changed."
4361 (interactive "P")
4362 (let ((cbuf (current-buffer))
4363 (cwin (selected-window))
4364 (pos (point))
4365 (bname (buffer-name (current-buffer)))
4366 beg end level heading ibuf)
4367 (save-excursion
4368 (org-back-to-heading t)
4369 (when (numberp arg)
4370 (setq level (org-outline-level))
4371 (if (< arg 0) (setq arg (+ level arg)))
4372 (while (> (setq level (org-outline-level)) arg)
4373 (outline-up-heading 1 t)))
4374 (setq beg (point)
4375 heading (org-get-heading))
4376 (org-end-of-subtree t) (setq end (point)))
4377 (if (and (not arg)
4378 (buffer-live-p org-last-indirect-buffer))
4379 (kill-buffer org-last-indirect-buffer))
4380 (setq ibuf (org-get-indirect-buffer cbuf)
4381 org-last-indirect-buffer ibuf)
4382 (cond
4383 ((or (eq org-indirect-buffer-display 'new-frame)
4384 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
4385 (select-frame (make-frame))
4386 (delete-other-windows)
4387 (switch-to-buffer ibuf)
4388 (org-set-frame-title heading))
4389 ((eq org-indirect-buffer-display 'dedicated-frame)
4390 (raise-frame
4391 (select-frame (or (and org-indirect-dedicated-frame
4392 (frame-live-p org-indirect-dedicated-frame)
4393 org-indirect-dedicated-frame)
4394 (setq org-indirect-dedicated-frame (make-frame)))))
4395 (delete-other-windows)
4396 (switch-to-buffer ibuf)
4397 (org-set-frame-title (concat "Indirect: " heading)))
4398 ((eq org-indirect-buffer-display 'current-window)
4399 (switch-to-buffer ibuf))
4400 ((eq org-indirect-buffer-display 'other-window)
4401 (pop-to-buffer ibuf))
4402 (t (error "Invalid value.")))
4403 (if (featurep 'xemacs)
4404 (save-excursion (org-mode) (turn-on-font-lock)))
4405 (narrow-to-region beg end)
4406 (show-all)
4407 (goto-char pos)
4408 (and (window-live-p cwin) (select-window cwin))))
4410 (defun org-get-indirect-buffer (&optional buffer)
4411 (setq buffer (or buffer (current-buffer)))
4412 (let ((n 1) (base (buffer-name buffer)) bname)
4413 (while (buffer-live-p
4414 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
4415 (setq n (1+ n)))
4416 (condition-case nil
4417 (make-indirect-buffer buffer bname 'clone)
4418 (error (make-indirect-buffer buffer bname)))))
4420 (defun org-set-frame-title (title)
4421 "Set the title of the current frame to the string TITLE."
4422 ;; FIXME: how to name a single frame in XEmacs???
4423 (unless (featurep 'xemacs)
4424 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
4426 ;;;; Structure editing
4428 ;;; Inserting headlines
4430 (defun org-insert-heading (&optional force-heading)
4431 "Insert a new heading or item with same depth at point.
4432 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
4433 If point is at the beginning of a headline, insert a sibling before the
4434 current headline. If point is in the middle of a headline, split the headline
4435 at that position and make the rest of the headline part of the sibling below
4436 the current headline."
4437 (interactive "P")
4438 (if (= (buffer-size) 0)
4440 (when (or force-heading (not (org-insert-item)))
4441 (let* ((head (save-excursion
4442 (condition-case nil
4443 (progn
4444 (org-back-to-heading)
4445 (match-string 0))
4446 (error "*"))))
4447 (blank (cdr (assq 'heading org-blank-before-new-entry)))
4448 pos)
4449 (cond
4450 ((and (org-on-heading-p) (bolp)
4451 (save-excursion (backward-char 1) (not (org-invisible-p))))
4452 (open-line (if blank 2 1)))
4453 ((and (bolp) (save-excursion
4454 (backward-char 1) (not (org-invisible-p))))
4455 nil)
4456 (t (newline (if blank 2 1))))
4457 (insert head) (just-one-space)
4458 (setq pos (point))
4459 (end-of-line 1)
4460 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
4461 (run-hooks 'org-insert-heading-hook)))))
4464 (defun org-insert-todo-heading (arg)
4465 "Insert a new heading with the same level and TODO state as current heading.
4466 If the heading has no TODO state, or if the state is DONE, use the first
4467 state (TODO by default). Also with prefix arg, force first state."
4468 (interactive "P")
4469 (when (not (org-insert-item 'checkbox))
4470 (org-insert-heading)
4471 (save-excursion
4472 (org-back-to-heading)
4473 (outline-previous-heading)
4474 (looking-at org-todo-line-regexp))
4475 (if (or arg
4476 (not (match-beginning 2))
4477 (equal (match-string 2) org-done-string))
4478 (insert (car org-todo-keywords) " ")
4479 (insert (match-string 2) " "))))
4481 ;;; Promotion and Demotion
4483 (defun org-promote-subtree ()
4484 "Promote the entire subtree.
4485 See also `org-promote'."
4486 (interactive)
4487 (save-excursion
4488 (org-map-tree 'org-promote))
4489 (org-fix-position-after-promote))
4491 (defun org-demote-subtree ()
4492 "Demote the entire subtree. See `org-demote'.
4493 See also `org-promote'."
4494 (interactive)
4495 (save-excursion
4496 (org-map-tree 'org-demote))
4497 (org-fix-position-after-promote))
4500 (defun org-do-promote ()
4501 "Promote the current heading higher up the tree.
4502 If the region is active in `transient-mark-mode', promote all headings
4503 in the region."
4504 (interactive)
4505 (save-excursion
4506 (if (org-region-active-p)
4507 (org-map-region 'org-promote (region-beginning) (region-end))
4508 (org-promote)))
4509 (org-fix-position-after-promote))
4511 (defun org-do-demote ()
4512 "Demote the current heading lower down the tree.
4513 If the region is active in `transient-mark-mode', demote all headings
4514 in the region."
4515 (interactive)
4516 (save-excursion
4517 (if (org-region-active-p)
4518 (org-map-region 'org-demote (region-beginning) (region-end))
4519 (org-demote)))
4520 (org-fix-position-after-promote))
4522 (defun org-fix-position-after-promote ()
4523 "Make sure that after pro/demotion cursor position is right."
4525 (save-excursion
4526 (skip-chars-backward "a-zA-Z0-9_@")
4527 (looking-at org-todo-regexp)))
4528 (insert " "))
4529 (and (equal (char-after) ?\ )
4530 (equal (char-before) ?*)
4531 (forward-char 1)))
4533 (defun org-get-legal-level (level &optional change)
4534 "Rectify a level change under the influence of `org-odd-levels-only'
4535 LEVEL is a current level, CHANGE is by how much the level should be
4536 modified. Even if CHANGE is nil, LEVEL may be returned modified because
4537 even level numbers will become the next higher odd number."
4538 (if org-odd-levels-only
4539 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
4540 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
4541 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
4542 (max 1 (+ level change))))
4544 (defun org-promote ()
4545 "Promote the current heading higher up the tree.
4546 If the region is active in `transient-mark-mode', promote all headings
4547 in the region."
4548 (org-back-to-heading t)
4549 (let* ((level (save-match-data (funcall outline-level)))
4550 (up-head (make-string (org-get-legal-level level -1) ?*))
4551 (diff (abs (- level (length up-head)))))
4552 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
4553 (replace-match up-head nil t)
4554 ;; Fixup tag positioning
4555 (and org-auto-align-tags (org-set-tags nil t))
4556 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
4558 (defun org-demote ()
4559 "Demote the current heading lower down the tree.
4560 If the region is active in `transient-mark-mode', demote all headings
4561 in the region."
4562 (org-back-to-heading t)
4563 (let* ((level (save-match-data (funcall outline-level)))
4564 (down-head (make-string (org-get-legal-level level 1) ?*))
4565 (diff (abs (- level (length down-head)))))
4566 (replace-match down-head nil t)
4567 ;; Fixup tag positioning
4568 (and org-auto-align-tags (org-set-tags nil t))
4569 (if org-adapt-indentation (org-fixup-indentation diff))))
4571 (defun org-map-tree (fun)
4572 "Call FUN for every heading underneath the current one."
4573 (org-back-to-heading)
4574 (let ((level (funcall outline-level)))
4575 (save-excursion
4576 (funcall fun)
4577 (while (and (progn
4578 (outline-next-heading)
4579 (> (funcall outline-level) level))
4580 (not (eobp)))
4581 (funcall fun)))))
4583 (defun org-map-region (fun beg end)
4584 "Call FUN for every heading between BEG and END."
4585 (let ((org-ignore-region t))
4586 (save-excursion
4587 (setq end (copy-marker end))
4588 (goto-char beg)
4589 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
4590 (< (point) end))
4591 (funcall fun))
4592 (while (and (progn
4593 (outline-next-heading)
4594 (< (point) end))
4595 (not (eobp)))
4596 (funcall fun)))))
4598 (defun org-fixup-indentation (diff)
4599 "Change the indentation in the current entry by DIFF
4600 However, if any line in the current entry has no indentation, or if it
4601 would end up with no indentation after the change, nothing at all is done."
4602 (save-excursion
4603 (let ((end (save-excursion (outline-next-heading)
4604 (point-marker)))
4605 (prohibit (if (> diff 0)
4608 col)
4609 (unless (save-excursion (re-search-forward prohibit end t))
4611 (goto-char (match-end 0))
4612 (setq col (current-column))
4613 (if (< diff 0) (replace-match ""))
4614 (indent-to (+ diff col))))
4615 (move-marker end nil))))
4617 (defun org-convert-to-odd-levels ()
4618 "Convert an org-mode file with all levels allowed to one with odd levels.
4619 This will leave level 1 alone, convert level 2 to level 3, level 3 to
4620 level 5 etc."
4621 (interactive)
4622 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
4623 (let ((org-odd-levels-only nil) n)
4624 (save-excursion
4625 (goto-char (point-min))
4627 (setq n (1- (length (match-string 0))))
4628 (while (>= (setq n (1- n)) 0)
4629 (org-demote))
4630 (end-of-line 1))))))
4633 (defun org-convert-to-oddeven-levels ()
4634 "Convert an org-mode file with only odd levels to one with odd and even levels.
4635 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
4636 section with an even level, conversion would destroy the structure of the file. An error
4637 is signaled in this case."
4638 (interactive)
4639 (goto-char (point-min))
4640 ;; First check if there are no even levels
4642 (org-show-context t)
4643 (error "Not all levels are odd in this file. Conversion not possible."))
4644 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
4645 (let ((org-odd-levels-only nil) n)
4646 (save-excursion
4647 (goto-char (point-min))
4649 (setq n (/ (length (match-string 0)) 2))
4650 (while (>= (setq n (1- n)) 0)
4651 (org-promote))
4652 (end-of-line 1))))))
4654 (defun org-tr-level (n)
4655 "Make N odd if required."
4656 (if org-odd-levels-only (1+ (/ n 2)) n))
4658 ;;; Vertical tree motion, cutting and pasting of subtrees
4660 (defun org-move-subtree-up (&optional arg)
4661 "Move the current subtree up past ARG headlines of the same level."
4662 (interactive "p")
4663 (org-move-subtree-down (- (prefix-numeric-value arg))))
4665 (defun org-move-subtree-down (&optional arg)
4666 "Move the current subtree down past ARG headlines of the same level."
4667 (interactive "p")
4668 (setq arg (prefix-numeric-value arg))
4669 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
4670 'outline-get-last-sibling))
4671 (ins-point (make-marker))
4672 (cnt (abs arg))
4673 beg end txt folded)
4674 ;; Select the tree
4675 (org-back-to-heading)
4676 (setq beg (point))
4677 (save-match-data
4678 (save-excursion (outline-end-of-heading)
4679 (setq folded (org-invisible-p)))
4680 (outline-end-of-subtree))
4681 (outline-next-heading)
4682 (setq end (point))
4683 ;; Find insertion point, with error handling
4684 (goto-char beg)
4685 (while (> cnt 0)
4686 (or (and (funcall movfunc) (looking-at outline-regexp))
4687 (progn (goto-char beg)
4688 (error "Cannot move past superior level or buffer limit")))
4689 (setq cnt (1- cnt)))
4690 (if (> arg 0)
4691 ;; Moving forward - still need to move over subtree
4692 (progn (outline-end-of-subtree)
4693 (outline-next-heading)
4694 (if (not (or (looking-at (concat "^" outline-regexp))
4695 (bolp)))
4696 (newline))))
4697 (move-marker ins-point (point))
4698 (setq txt (buffer-substring beg end))
4699 (delete-region beg end)
4700 (insert txt)
4701 (goto-char ins-point)
4702 (if folded (hide-subtree))
4703 (move-marker ins-point nil)))
4705 (defvar org-subtree-clip ""
4706 "Clipboard for cut and paste of subtrees.
4707 This is actually only a copy of the kill, because we use the normal kill
4708 ring. We need it to check if the kill was created by `org-copy-subtree'.")
4710 (defvar org-subtree-clip-folded nil
4711 "Was the last copied subtree folded?
4712 This is used to fold the tree back after pasting.")
4714 (defun org-cut-subtree ()
4715 "Cut the current subtree into the clipboard.
4716 This is a short-hand for marking the subtree and then cutting it."
4717 (interactive)
4718 (org-copy-subtree 'cut))
4720 (defun org-copy-subtree (&optional cut)
4721 "Cut the current subtree into the clipboard.
4722 This is a short-hand for marking the subtree and then copying it.
4723 If CUT is non-nil, actually cut the subtree."
4724 (interactive)
4725 (let (beg end folded)
4726 (org-back-to-heading)
4727 (setq beg (point))
4728 (save-match-data
4729 (save-excursion (outline-end-of-heading)
4730 (setq folded (org-invisible-p)))
4731 (outline-end-of-subtree))
4733 (setq end (point))
4734 (goto-char beg)
4735 (when (> end beg)
4736 (setq org-subtree-clip-folded folded)
4737 (if cut (kill-region beg end) (copy-region-as-kill beg end))
4738 (setq org-subtree-clip (current-kill 0))
4739 (message "%s: Subtree with %d characters"
4740 (if cut "Cut" "Copied")
4741 (length org-subtree-clip)))))
4743 (defun org-paste-subtree (&optional level tree)
4744 "Paste the clipboard as a subtree, with modification of headline level.
4745 The entire subtree is promoted or demoted in order to match a new headline
4746 level. By default, the new level is derived from the visible headings
4747 before and after the insertion point, and taken to be the inferior headline
4748 level of the two. So if the previous visible heading is level 3 and the
4749 next is level 4 (or vice versa), level 4 will be used for insertion.
4750 This makes sure that the subtree remains an independent subtree and does
4751 not swallow low level entries.
4753 You can also force a different level, either by using a numeric prefix
4754 argument, or by inserting the heading marker by hand. For example, if the
4759 If optional TREE is given, use this text instead of the kill ring."
4760 (interactive "P")
4761 (unless (org-kill-is-subtree-p tree)
4762 (error
4763 (substitute-command-keys
4765 (let* ((txt (or tree (and kill-ring (current-kill 0))))
4770 (old-level (if (string-match ^re txt)
4771 (- (match-end 0) (match-beginning 0))
4772 -1))
4773 (force-level (cond (level (prefix-numeric-value level))
4774 ((string-match
4775 ^re_ (buffer-substring (point-at-bol) (point)))
4776 (- (match-end 0) (match-beginning 0)))
4777 (t nil)))
4778 (previous-level (save-excursion
4779 (condition-case nil
4780 (progn
4781 (outline-previous-visible-heading 1)
4782 (if (looking-at re)
4783 (- (match-end 0) (match-beginning 0))
4784 1))
4785 (error 1))))
4786 (next-level (save-excursion
4787 (condition-case nil
4788 (progn
4789 (outline-next-visible-heading 1)
4790 (if (looking-at re)
4791 (- (match-end 0) (match-beginning 0))
4792 1))
4793 (error 1))))
4794 (new-level (or force-level (max previous-level next-level)))
4795 (shift (if (or (= old-level -1)
4796 (= new-level -1)
4797 (= old-level new-level))
4798 0
4799 (- new-level old-level)))
4800 (shift1 shift)
4801 (delta (if (> shift 0) -1 1))
4802 (func (if (> shift 0) 'org-demote 'org-promote))
4803 (org-odd-levels-only nil)
4804 beg end)
4805 ;; Remove the forces level indicator
4806 (if force-level
4807 (delete-region (point-at-bol) (point)))
4808 ;; Make sure we start at the beginning of an empty line
4812 ;; Paste
4813 (setq beg (point))
4816 (insert txt)
4817 (setq end (point))
4820 (goto-char beg)
4821 ;; Shift if necessary
4822 (if (= shift 0)
4823 (message "Pasted at level %d, without shift" new-level)
4824 (save-restriction
4825 (narrow-to-region beg end)
4826 (while (not (= shift 0))
4827 (org-map-region func (point-min) (point-max))
4828 (setq shift (+ delta shift)))
4829 (goto-char (point-min))
4830 (message "Pasted at level %d, with shift by %d levels"
4831 new-level shift1)))
4832 (if (and kill-ring
4833 (eq org-subtree-clip (current-kill 0))
4834 org-subtree-clip-folded)
4835 ;; The tree was folded before it was killed/copied
4836 (hide-subtree))))
4838 (defun org-kill-is-subtree-p (&optional txt)
4839 "Check if the current kill is an outline subtree, or a set of trees.
4840 Returns nil if kill does not start with a headline, or if the first
4841 headline level is not the largest headline level in the tree.
4842 So this will actually accept several entries of equal levels as well,
4843 which is OK for `org-paste-subtree'.
4844 If optional TXT is given, check this string instead of the current kill."
4845 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
4846 (start-level (and kill
4848 (- (match-end 0) (match-beginning 0))))
4849 (re (concat "^" outline-regexp))
4850 (start 1))
4851 (if (not start-level)
4852 nil ;; does not even start with a heading
4853 (catch 'exit
4854 (while (setq start (string-match re kill (1+ start)))
4855 (if (< (- (match-end 0) (match-beginning 0)) start-level)
4856 (throw 'exit nil)))
4857 t))))
4859 (defun org-narrow-to-subtree ()
4860 "Narrow buffer to the current subtree."
4861 (interactive)
4862 (save-excursion
4863 (narrow-to-region
4864 (progn (org-back-to-heading) (point))
4865 (progn (org-end-of-subtree t) (point)))))
4868 ;;; Outline Sorting
4870 (defun org-sort (with-case)
4871 "Call `org-sort-entries' or `org-table-sort-lines', depending on context."
4872 (interactive "P")
4873 (if (org-at-table-p)
4874 (org-call-with-arg 'org-table-sort-lines with-case)
4875 (org-call-with-arg 'org-sort-entries with-case)))
4877 (defun org-sort-entries (&optional with-case sorting-type)
4878 "Sort entries on a certain level of an outline tree.
4879 If there is an active region, the entries in the region are sorted.
4880 If not, the children of the entry at point are sorted.
4882 Sorting can be alphabetically, numerically, and by date/time as given by
4883 the first time stamp in the entry. The command prompts for the sorting
4884 type unless it has been given to the function through the SORTING-TYPE
4885 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T).
4887 Comparing entries ignores case by default. However, with an optional argument
4888 WITH-CASE, the sorting considers case as well. With two prefix arguments
4889 `C-u C-u', sorting is case-sensitive and duplicate entries will be removed."
4890 (interactive "P")
4891 (let ((unique (equal with-case '(16)))
4892 start beg end entries stars re re2 p nentries (nremoved 0) last txt)
4894 ;; Find beginning and end of region to sort
4895 (if (org-region-active-p)
4896 (progn
4897 ;; we will sort the region
4898 (setq end (region-end))
4899 (goto-char (1- (setq start (region-beginning)))))
4900 ;; we will sort the children of the current headline
4901 (setq start (point) end (org-end-of-subtree))
4902 (goto-char start)
4903 (show-subtree))
4904 (outline-next-heading) ; this is the first heading to be included
4905 (setq beg (point))
4906 (if (>= (point) end) (error "Nothing to sort"))
4908 (setq stars (match-string 1)
4909 re (concat "^" (regexp-quote stars) " +")
4910 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
4911 txt (buffer-substring beg end))
4913 (if (string-match re2 txt)
4914 (error "Region to sort contains a level above the first entry"))
4915 ;; Make a list that can be sorted.
4916 ;; The car is the string for comparison, the cdr is the subtree
4917 (message "Sorting entries...")
4918 (setq entries
4919 (mapcar
4920 (lambda (x)
4922 (cons (match-string 0 x) x))
4923 (org-split-string txt re)))
4925 ;; Sort the list
4926 (setq entries (org-do-sort
4927 entries
4928 (if (org-region-active-p) "region" "children")
4929 with-case sorting-type))
4931 ;; Delete the old stuff
4932 (goto-char beg)
4933 (kill-region beg end)
4934 (setq nentries (length entries))
4935 ;; Insert the sorted entries, and remove duplicates if this is required
4936 (while (setq p (pop entries))
4937 (if (and unique (equal last (setq last (org-trim (cdr p)))))
4938 (setq nremoved (1+ nremoved)) ; same entry as before, skip it
4939 (insert stars " " (cdr p))))
4940 (goto-char start)
4941 (message "Sorting entries...done (%d entries%s)"
4942 nentries
4943 (if unique (format ", %d duplicates removed" nremoved) ""))))
4945 (defun org-do-sort (table what &optional with-case sorting-type)
4946 "Sort TABLE of WHAT according to SORTING-TYPE.
4947 The user will be prompted for the SORTING-TYPE if the call to this
4948 function does not specify it. WHAT is only for the prompt, to indicate
4949 what is being sorted. The sorting key will be extracted from
4950 the car of the elements of the table.
4951 If WITH-CASE is non-nil, the sorting will be case-sensitive."
4952 (unless sorting-type
4953 (message
4954 "Sort %s:[a]lphabetically [n]umerically [t]ime. A/N/T means reversed:"
4955 what)
4956 (setq sorting-type (read-char-exclusive)))
4957 (let ((dcst (downcase sorting-type))
4958 extractfun comparefun)
4959 ;; Define the appropriate functions
4960 (cond
4961 ((= dcst ?n)
4962 (setq extractfun 'string-to-number
4963 comparefun (if (= dcst sorting-type) '< '>)))
4964 ((= dcst ?a)
4965 (setq extractfun (if with-case 'identity 'downcase)
4966 comparefun (if (= dcst sorting-type)
4967 'string<
4968 (lambda (a b) (and (not (string< a b))
4969 (not (string= a b)))))))
4970 ((= dcst ?t)
4971 (setq extractfun
4972 (lambda (x)
4973 (if (string-match org-ts-regexp x)
4974 (time-to-seconds
4975 (org-time-string-to-time (match-string 0 x)))
4976 0))
4977 comparefun (if (= dcst sorting-type) '< '>)))
4978 (t (error "Invalid sorting type `%c'" sorting-type)))
4980 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
4981 table)
4982 (lambda (a b) (funcall comparefun (car a) (car b))))))
4984 ;;;; Plain list items, including checkboxes
4986 ;;; Plain list items
4988 (defun org-at-item-p ()
4989 "Is point in a line starting a hand-formatted item?"
4990 (let ((llt org-plain-list-ordered-item-terminator))
4991 (save-excursion
4992 (goto-char (point-at-bol))
4993 (looking-at
4994 (cond
4998 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
5001 (defun org-in-item-p ()
5002 "It the cursor inside a plain list item.
5003 Does not have to be the first line."
5004 (save-excursion
5005 (condition-case nil
5006 (progn
5007 (org-beginning-of-item)
5008 (org-at-item-p)
5009 t)
5010 (error nil))))
5012 (defun org-insert-item (&optional checkbox)
5013 "Insert a new item at the current level.
5014 Return t when things worked, nil when we are not in an item."
5015 (when (save-excursion
5016 (condition-case nil
5017 (progn
5018 (org-beginning-of-item)
5019 (org-at-item-p)
5020 (if (org-invisible-p) (error "Invisible item"))
5021 t)
5022 (error nil)))
5023 (let* ((bul (match-string 0))
5025 (match-end 0)))
5026 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
5027 pos)
5028 (cond
5029 ((and (org-at-item-p) (<= (point) eow))
5030 ;; before the bullet
5031 (beginning-of-line 1)
5032 (open-line (if blank 2 1)))
5033 ((<= (point) eow)
5034 (beginning-of-line 1))
5035 (t (newline (if blank 2 1))))
5036 (insert bul (if checkbox "[ ]" ""))
5037 (just-one-space)
5038 (setq pos (point))
5039 (end-of-line 1)
5040 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
5041 (org-maybe-renumber-ordered-list)
5042 (and checkbox (org-update-checkbox-count-maybe))
5043 t))
5045 ;;; Checkboxes
5047 (defun org-at-item-checkbox-p ()
5048 "Is point at a line starting a plain-list item with a checklet?"
5049 (and (org-at-item-p)
5050 (save-excursion
5051 (goto-char (match-end 0))
5055 (defun org-toggle-checkbox (&optional arg)
5056 "Toggle the checkbox in the current line."
5057 (interactive "P")
5058 (catch 'exit
5059 (let (beg end status (firstnew 'unknown))
5060 (cond
5061 ((org-region-active-p)
5062 (setq beg (region-beginning) end (region-end)))
5063 ((org-on-heading-p)
5064 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
5065 ((org-at-item-checkbox-p)
5066 (save-excursion
5067 (replace-match (if (equal (match-string 0) "[ ]") "[X]" "[ ]") t t))
5068 (throw 'exit t))
5069 (t (error "Not at a checkbox or heading, and no active region")))
5070 (save-excursion
5071 (goto-char beg)
5072 (while (< (point) end)
5073 (when (org-at-item-checkbox-p)
5074 (setq status (equal (match-string 0) "[X]"))
5075 (when (eq firstnew 'unknown)
5076 (setq firstnew (not status)))
5077 (replace-match
5078 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
5079 (beginning-of-line 2)))))
5080 (org-update-checkbox-count-maybe))
5082 (defun org-update-checkbox-count-maybe ()
5083 "Update checkbox statistics unless turned off by user."
5084 (when org-provide-checkbox-statistics
5085 (org-update-checkbox-count)))
5087 (defun org-update-checkbox-count (&optional all)
5088 "Update the checkbox statistics in the current section.
5089 This will find all statistic cookies like [57%] and [6/12] and update them
5090 with the current numbers. With optional prefix argument ALL, do this for
5091 the whole buffer."
5092 (interactive "P")
5093 (save-excursion
5094 (let* ((buffer-invisibility-spec nil) ; Emacs 21 compatibility
5095 (beg (progn (outline-back-to-heading) (point)))
5096 (end (move-marker (make-marker)
5097 (progn (outline-next-heading) (point))))
5100 b1 e1 f1 c-on c-off lim (cstat 0))
5101 (when all
5102 (goto-char (point-min))
5103 (outline-next-heading)
5104 (setq beg (point) end (point-max)))
5105 (goto-char beg)
5106 (while (re-search-forward re end t)
5107 (setq cstat (1+ cstat)
5108 b1 (match-beginning 0)
5109 e1 (match-end 0)
5110 f1 (match-beginning 1)
5111 lim (cond
5112 ((org-on-heading-p) (outline-next-heading) (point))
5113 ((org-at-item-p) (org-end-of-item) (point))
5114 (t nil))
5115 c-on 0 c-off 0)
5116 (goto-char e1)
5117 (when lim
5118 (while (re-search-forward re-box lim t)
5119 (if (equal (match-string 2) "[ ]")
5120 (setq c-off (1+ c-off))
5121 (setq c-on (1+ c-on))))
5122 (delete-region b1 e1)
5123 (goto-char b1)
5124 (insert (if f1
5125 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
5126 (format "[%d/%d]" c-on (+ c-on c-off))))))
5127 (when (interactive-p)
5128 (message "Checkbox satistics updated %s (%d places)"
5129 (if all "in entire file" "in current outline entry") cstat)))))
5131 (defun org-get-checkbox-statistics-face ()
5132 "Select the face for checkbox statistics.
5133 The face will be `org-done' when all relevant boxes are checked. Otherwise
5134 it will be `org-todo'."
5135 (if (match-end 1)
5136 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
5137 (if (and (> (match-end 2) (match-beginning 2))
5138 (equal (match-string 2) (match-string 3)))
5139 'org-done
5140 'org-todo)))
5142 (defun org-get-indentation (&optional line)
5143 "Get the indentation of the current line, interpreting tabs.
5144 When LINE is given, assume it represents a line and compute its indentation."
5145 (if line
5146 (if (string-match "^ *" (org-remove-tabs line))
5147 (match-end 0))
5148 (save-excursion
5149 (beginning-of-line 1)
5151 (current-column))))
5153 (defun org-remove-tabs (s &optional width)
5154 "Replace tabulators in S with spaces.
5155 Assumes that s is a single line, starting in column 0."
5156 (setq width (or width tab-width))
5158 (setq s (replace-match
5159 (make-string
5160 (- (* width (/ (+ (match-beginning 0) width) width))
5161 (match-beginning 0)) ?\ )
5162 t t s)))
5163 s)
5165 (defun org-fix-indentation (line ind)
5166 "Fix indentation in LINE.
5167 IND is a cons cell with target and minimum indentation.
5168 If the current indenation in LINE is smaller than the minimum,
5169 leave it alone. If it is larger than ind, set it to the target."
5170 (let* ((l (org-remove-tabs line))
5171 (i (org-get-indentation l))
5172 (i1 (car ind)) (i2 (cdr ind)))
5173 (if (>= i i2) (setq l (substring line i2)))
5174 (if (> i1 0)
5175 (concat (make-string i1 ?\ ) l)
5176 l)))
5178 (defun org-beginning-of-item ()
5179 "Go to the beginning of the current hand-formatted item.
5180 If the cursor is not in an item, throw an error."
5181 (interactive)
5182 (let ((pos (point))
5183 (limit (save-excursion (org-back-to-heading)
5184 (beginning-of-line 2) (point)))
5185 ind ind1)
5186 (if (org-at-item-p)
5187 (beginning-of-line 1)
5188 (beginning-of-line 1)
5190 (setq ind (current-column))
5191 (if (catch 'exit
5192 (while t
5193 (beginning-of-line 0)
5194 (if (< (point) limit) (throw 'exit nil))
5197 (setq ind1 (current-column))
5198 (if (< ind1 ind)
5199 (throw 'exit (org-at-item-p))))))
5200 nil
5201 (goto-char pos)
5202 (error "Not in an item")))))
5204 (defun org-end-of-item ()
5205 "Go to the end of the current hand-formatted item.
5206 If the cursor is not in an item, throw an error."
5207 (interactive)
5208 (let ((pos (point))
5209 (limit (save-excursion (outline-next-heading) (point)))
5210 (ind (save-excursion
5211 (org-beginning-of-item)
5213 (current-column)))
5214 ind1)
5215 (if (catch 'exit
5216 (while t
5217 (beginning-of-line 2)
5218 (if (>= (point) limit) (throw 'exit t))
5221 (setq ind1 (current-column))
5222 (if (<= ind1 ind) (throw 'exit t)))))
5223 (beginning-of-line 1)
5224 (goto-char pos)
5225 (error "Not in an item"))))
5227 (defun org-next-item ()
5228 "Move to the beginning of the next item in the current plain list.
5229 Error if not at a plain list, or if this is the last item in the list."
5230 (interactive)
5231 (let (ind ind1 (pos (point)))
5232 (org-beginning-of-item)
5233 (setq ind (org-get-indentation))
5234 (org-end-of-item)
5235 (setq ind1 (org-get-indentation))
5236 (unless (and (org-at-item-p) (= ind ind1))
5237 (goto-char pos)
5238 (error "On last item"))))
5240 (defun org-previous-item ()
5241 "Move to the beginning of the previous item in the current plain list.
5242 Error if not at a plain list, or if this is the last item in the list."
5243 (interactive)
5244 (let (beg ind (pos (point)))
5245 (org-beginning-of-item)
5246 (setq beg (point))
5247 (setq ind (org-get-indentation))
5248 (goto-char beg)
5249 (catch 'exit
5250 (while t
5251 (beginning-of-line 0)
5253 nil
5254 (if (<= (org-get-indentation) ind)
5255 (throw 'exit t)))))
5256 (condition-case nil
5257 (org-beginning-of-item)
5258 (error (goto-char pos)
5259 (error "On first item")))))
5261 (defun org-move-item-down ()
5262 "Move the plain list item at point down, i.e. swap with following item.
5263 Subitems (items with larger indentation) are considered part of the item,
5264 so this really moves item trees."
5265 (interactive)
5266 (let (beg end ind ind1 (pos (point)) txt)
5267 (org-beginning-of-item)
5268 (setq beg (point))
5269 (setq ind (org-get-indentation))
5270 (org-end-of-item)
5271 (setq end (point))
5272 (setq ind1 (org-get-indentation))
5273 (if (and (org-at-item-p) (= ind ind1))
5274 (progn
5275 (org-end-of-item)
5276 (setq txt (buffer-substring beg end))
5277 (save-excursion
5278 (delete-region beg end))
5279 (setq pos (point))
5280 (insert txt)
5281 (goto-char pos)
5282 (org-maybe-renumber-ordered-list))
5283 (goto-char pos)
5284 (error "Cannot move this item further down"))))
5286 (defun org-move-item-up (arg)
5287 "Move the plain list item at point up, i.e. swap with previous item.
5288 Subitems (items with larger indentation) are considered part of the item,
5289 so this really moves item trees."
5290 (interactive "p")
5291 (let (beg end ind ind1 (pos (point)) txt)
5292 (org-beginning-of-item)
5293 (setq beg (point))
5294 (setq ind (org-get-indentation))
5295 (org-end-of-item)
5296 (setq end (point))
5297 (goto-char beg)
5298 (catch 'exit
5299 (while t
5300 (beginning-of-line 0)
5302 nil
5303 (if (<= (setq ind1 (org-get-indentation)) ind)
5304 (throw 'exit t)))))
5305 (condition-case nil
5306 (org-beginning-of-item)
5307 (error (goto-char beg)
5308 (error "Cannot move this item further up")))
5309 (setq ind1 (org-get-indentation))
5310 (if (and (org-at-item-p) (= ind ind1))
5311 (progn
5312 (setq txt (buffer-substring beg end))
5313 (save-excursion
5314 (delete-region beg end))
5315 (setq pos (point))
5316 (insert txt)
5317 (goto-char pos)
5318 (org-maybe-renumber-ordered-list))
5319 (goto-char pos)
5320 (error "Cannot move this item further up"))))
5322 (defun org-maybe-renumber-ordered-list ()
5323 "Renumber the ordered list at point if setup allows it.
5324 This tests the user option `org-auto-renumber-ordered-lists' before
5325 doing the renumbering."
5326 (and org-auto-renumber-ordered-lists
5327 (org-at-item-p)
5328 (match-beginning 3)
5329 (org-renumber-ordered-list 1)))
5331 (defun org-get-string-indentation (s)
5332 "What indentation has S due to SPACE and TAB at the beginning of the string?"
5333 (let ((n -1) (i 0) (w tab-width) c)
5334 (catch 'exit
5335 (while (< (setq n (1+ n)) (length s))
5336 (setq c (aref s n))
5337 (cond ((= c ?\ ) (setq i (1+ i)))
5339 (t (throw 'exit t)))))
5340 i))
5342 (defun org-renumber-ordered-list (arg)
5343 "Renumber an ordered plain list.
5344 Cursor needs to be in the first line of an item, the line that starts
5346 (interactive "p")
5347 (unless (and (org-at-item-p)
5348 (match-beginning 3))
5349 (error "This is not an ordered list"))
5350 (let ((line (org-current-line))
5351 (col (current-column))
5352 (ind (org-get-string-indentation
5353 (buffer-substring (point-at-bol) (match-beginning 3))))
5354 ;; (term (substring (match-string 3) -1))
5355 ind1 (n (1- arg)))
5356 ;; find where this list begins
5357 (catch 'exit
5358 (while t
5359 (catch 'next
5360 (beginning-of-line 0)
5363 (if (or (< ind1 ind)
5364 (and (= ind1 ind)
5365 (not (org-at-item-p))))
5366 (throw 'exit t)))))
5367 ;; Walk forward and replace these numbers
5368 (catch 'exit
5369 (while t
5370 (catch 'next
5371 (beginning-of-line 2)
5372 (if (eobp) (throw 'exit nil))
5375 (if (> ind1 ind) (throw 'next t))
5376 (if (< ind1 ind) (throw 'exit t))
5377 (if (not (org-at-item-p)) (throw 'exit nil))
5378 (if (not (match-beginning 3))
5380 (delete-region (match-beginning 3) (1- (match-end 3)))
5381 (goto-char (match-beginning 3))
5382 (insert (format "%d" (setq n (1+ n)))))))
5383 (goto-line line)
5384 (move-to-column col)))
5386 (defvar org-last-indent-begin-marker (make-marker))
5387 (defvar org-last-indent-end-marker (make-marker))
5389 (defun org-outdent-item (arg)
5390 "Outdent a local list item."
5391 (interactive "p")
5392 (org-indent-item (- arg)))
5394 (defun org-indent-item (arg)
5395 "Indent a local list item."
5396 (interactive "p")
5397 (unless (org-at-item-p)
5398 (error "Not on an item"))
5399 (save-excursion
5400 (let (beg end ind ind1)
5401 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
5402 (setq beg org-last-indent-begin-marker
5403 end org-last-indent-end-marker)
5404 (org-beginning-of-item)
5405 (setq beg (move-marker org-last-indent-begin-marker (point)))
5406 (org-end-of-item)
5407 (setq end (move-marker org-last-indent-end-marker (point))))
5408 (goto-char beg)
5410 (if (< (+ arg ind) 0) (error "Cannot outdent beyond margin"))
5411 (while (< (point) end)
5412 (beginning-of-line 1)
5414 (delete-region (point-at-bol) (point))
5415 (indent-to-column (+ ind1 arg))
5416 (beginning-of-line 2)))))
5418 ;;;; Archiving
5420 (defun org-archive-subtree (&optional find-done)
5421 "Move the current subtree to the archive.
5422 The archive can be a certain top-level heading in the current file, or in
5423 a different file. The tree will be moved to that location, the subtree
5424 heading be marked DONE, and the current time will be added.
5426 When called with prefix argument FIND-DONE, find whole trees without any
5427 open TODO items and archive them (after getting confirmation from the user).
5428 If the cursor is not at a headline when this comand is called, try all level
5429 1 trees. If the cursor is on a headline, only try the direct children of
5430 this heading. "
5431 (interactive "P")
5432 (if find-done
5433 (org-archive-all-done)
5434 ;; Save all relevant TODO keyword-relatex variables
5436 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
5437 (tr-org-todo-keywords org-todo-keywords)
5438 (tr-org-todo-interpretation org-todo-interpretation)
5439 (tr-org-done-string org-done-string)
5440 (tr-org-todo-regexp org-todo-regexp)
5441 (tr-org-todo-line-regexp org-todo-line-regexp)
5442 (this-buffer (current-buffer))
5443 file heading buffer level newfile-p)
5445 (progn
5446 (setq file (format (match-string 1 org-archive-location)
5447 (file-name-nondirectory buffer-file-name))
5448 heading (match-string 2 org-archive-location)))
5449 (error "Invalid `org-archive-location'"))
5450 (if (> (length file) 0)
5451 (setq newfile-p (not (file-exists-p file))
5452 buffer (find-file-noselect file))
5453 (setq buffer (current-buffer)))
5454 (unless buffer
5456 (if (and (> (length heading) 0)
5458 (setq level (match-end 0))
5459 (setq heading nil level 0))
5460 (save-excursion
5461 ;; We first only copy, in case something goes wrong
5462 ;; we need to protect this-command, to avoid kill-region sets it,
5463 ;; which would lead to duplication of subtrees
5464 (let (this-command) (org-copy-subtree))
5465 (set-buffer buffer)
5466 ;; Enforce org-mode for the archive buffer
5467 (if (not (org-mode-p))
5468 ;; Force the mode for future visits.
5469 (let ((org-insert-mode-line-in-empty-file t))
5470 (call-interactively 'org-mode)))
5471 (when newfile-p
5472 (goto-char (point-max))
5474 (buffer-file-name this-buffer))))
5475 ;; Force the TODO keywords of the original buffer
5476 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
5477 (org-todo-keywords tr-org-todo-keywords)
5478 (org-todo-interpretation tr-org-todo-interpretation)
5479 (org-done-string tr-org-done-string)
5480 (org-todo-regexp tr-org-todo-regexp)
5481 (org-todo-line-regexp tr-org-todo-line-regexp))
5482 (goto-char (point-min))
5483 (if heading
5484 (progn
5485 (if (re-search-forward
5488 nil t)
5489 (goto-char (match-end 0))
5490 ;; Heading not found, just insert it at the end
5491 (goto-char (point-max))
5494 (end-of-line 0))
5495 ;; Make the subtree visible
5496 (show-subtree)
5497 (org-end-of-subtree t)
5501 ;; No specific heading, just go to end of file.
5503 ;; Paste
5504 (org-paste-subtree (1+ level))
5505 ;; Mark the entry as done, i.e. set to last work in org-todo-keywords
5506 (if org-archive-mark-done
5507 (let (org-log-done)
5508 (org-todo (length org-todo-keywords))))
5509 ;; Move cursor to right after the TODO keyword
5510 (when org-archive-stamp-time
5511 (beginning-of-line 1)
5512 (looking-at org-todo-line-regexp)
5513 (goto-char (or (match-end 2) (match-beginning 3)))
5514 (org-insert-time-stamp (org-current-time) t t "(" ")"))
5515 ;; Save the buffer, if it is not the same buffer.
5516 (if (not (eq this-buffer buffer)) (save-buffer))))
5517 ;; Here we are back in the original buffer. Everything seems to have
5518 ;; worked. So now cut the tree and finish up.
5519 (let (this-command) (org-cut-subtree))
5521 (message "Subtree archived %s"
5522 (if (eq this-buffer buffer)
5523 (concat "under heading: " heading)
5524 (concat "in file: " (abbreviate-file-name file)))))))
5526 (defun org-archive-all-done (&optional tag)
5527 "Archive sublevels of the current tree without open TODO items.
5528 If the cursor is not on a headline, try all level 1 trees. If
5529 it is on a headline, try all direct children.
5530 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
5532 (rea (concat ".*:" org-archive-tag ":"))
5533 (begm (make-marker))
5534 (endm (make-marker))
5535 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
5536 "Move subtree to archive (no open TODO items)? "))
5537 beg end (cntarch 0))
5538 (if (org-on-heading-p)
5539 (progn
5540 (setq re1 (concat "^" (regexp-quote
5541 (make-string
5542 (1+ (- (match-end 0) (match-beginning 0)))
5543 ?*))
5544 " "))
5545 (move-marker begm (point))
5546 (move-marker endm (org-end-of-subtree t)))
5547 (setq re1 "^* ")
5548 (move-marker begm (point-min))
5549 (move-marker endm (point-max)))
5550 (save-excursion
5551 (goto-char begm)
5552 (while (re-search-forward re1 endm t)
5553 (setq beg (match-beginning 0)
5554 end (save-excursion (org-end-of-subtree t) (point)))
5555 (goto-char beg)
5556 (if (re-search-forward re end t)
5557 (goto-char end)
5558 (goto-char beg)
5559 (if (and (or (not tag) (not (looking-at rea)))
5560 (y-or-n-p question))
5561 (progn
5562 (if tag
5563 (org-toggle-tag org-archive-tag 'on)
5564 (org-archive-subtree))
5565 (setq cntarch (1+ cntarch)))
5566 (goto-char end)))))
5567 (message "%d trees archived" cntarch)))
5569 (defun org-cycle-hide-archived-subtrees (state)
5570 "Re-hide all archived subtrees after a visibility state change."
5571 (when (and (not org-cycle-open-archived-trees)
5572 (not (memq state '(overview folded))))
5573 (save-excursion
5574 (let* ((globalp (memq state '(contents all)))
5575 (beg (if globalp (point-min) (point)))
5576 (end (if globalp (point-max) (org-end-of-subtree t))))
5577 (org-hide-archived-subtrees beg end)
5578 (goto-char beg)
5579 (if (looking-at (concat ".*:" org-archive-tag ":"))
5580 (message (substitute-command-keys
5581 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
5583 (defun org-force-cycle-archived ()
5584 "Cycle subtree even if it is archived."
5585 (interactive)
5586 (setq this-command 'org-cycle)
5587 (let ((org-cycle-open-archived-trees t))
5588 (call-interactively 'org-cycle)))
5590 (defun org-hide-archived-subtrees (beg end)
5591 "Re-hide all archived subtrees after a visibility state change."
5592 (save-excursion
5593 (let* ((re (concat ":" org-archive-tag ":")))
5594 (goto-char beg)
5595 (while (re-search-forward re end t)
5596 (and (org-on-heading-p) (hide-subtree))
5597 (org-end-of-subtree t)))))
5599 (defun org-toggle-tag (tag &optional onoff)
5600 "Toggle the tag TAG for the current line.
5601 If ONOFF is `on' or `off', don't toggle but set to this state."
5602 (unless (org-on-heading-p) (error "Not on headling"))
5603 (let (res current)
5604 (save-excursion
5605 (beginning-of-line)
5607 (point-at-eol) t)
5608 (progn
5609 (setq current (match-string 1))
5610 (replace-match ""))
5611 (setq current ""))
5612 (setq current (nreverse (org-split-string current ":")))
5613 (cond
5614 ((eq onoff 'on)
5615 (setq res t)
5616 (or (member tag current) (push tag current)))
5617 ((eq onoff 'off)
5618 (or (not (member tag current)) (setq current (delete tag current))))
5619 (t (if (member tag current)
5620 (setq current (delete tag current))
5621 (setq res t)
5622 (push tag current))))
5623 (end-of-line 1)
5624 (when current
5625 (insert " :" (mapconcat 'identity (nreverse current) ":") ":"))
5626 (org-set-tags nil t))
5627 res))
5629 (defun org-toggle-archive-tag (&optional arg)
5630 "Toggle the archive tag for the current headline.
5631 With prefix ARG, check all children of current headline and offer tagging
5632 the children that do not contain any open TODO items."
5633 (interactive "P")
5634 (if arg
5635 (org-archive-all-done 'tag)
5636 (let (set)
5637 (save-excursion
5638 (org-back-to-heading t)
5639 (setq set (org-toggle-tag org-archive-tag))
5640 (when set (hide-subtree)))
5641 (and set (beginning-of-line 1))
5642 (message "Subtree %s" (if set "archived" "unarchived")))))
5645 ;;;; Tables
5647 ;;; The table editor
5649 ;; Watch out: Here we are talking about two different kind of tables.
5650 ;; Most of the code is for the tables created with the Org-mode table editor.
5651 ;; Sometimes, we talk about tables created and edited with the table.el
5652 ;; Emacs package. We call the former org-type tables, and the latter
5653 ;; table.el-type tables.
5655 (defun org-before-change-function (beg end)
5656 "Every change indicates that a table might need an update."
5657 (setq org-table-may-need-update t))
5660 "Detects an org-type table line.")
5662 "Detects an org-type table line.")
5664 "Detects a table line marked for automatic recalculation.")
5666 "Detects a table line marked for automatic recalculation.")
5668 "Detects a table line marked for automatic recalculation.")
5670 "Detects an org-type table hline.")
5672 "Detects a table-type table hline.")
5674 "Detects an org-type or table-type table.")
5676 "Searching from within a table (any type) this finds the first line
5677 outside the table.")
5679 "Searching from within a table (any type) this finds the first line
5680 outside the table.")
5682 (defun org-table-create-with-table.el ()
5683 "Use the table.el package to insert a new table.
5684 If there is already a table at point, convert between Org-mode tables
5685 and table.el tables."
5686 (interactive)
5687 (require 'table)
5688 (cond
5689 ((org-at-table.el-p)
5690 (if (y-or-n-p "Convert table to Org-mode table? ")
5691 (org-table-convert)))
5692 ((org-at-table-p)
5693 (if (y-or-n-p "Convert table to table.el table? ")
5694 (org-table-convert)))
5695 (t (call-interactively 'table-insert))))
5697 (defun org-table-create-or-convert-from-region (arg)
5698 "Convert region to table, or create an empty table.
5699 If there is an active region, convert it to a table. If there is no such
5700 region, create an empty table."
5701 (interactive "P")
5702 (if (org-region-active-p)
5703 (org-table-convert-region (region-beginning) (region-end) arg)
5704 (org-table-create arg)))
5706 (defun org-table-create (&optional size)
5707 "Query for a size and insert a table skeleton.
5709 (interactive "P")
5710 (unless size
5711 (setq size (read-string
5712 (concat "Table size Columns x Rows [e.g. "
5713 org-table-default-size "]: ")
5714 "" nil org-table-default-size)))
5716 (let* ((pos (point))
5717 (indent (make-string (current-column) ?\ ))
5718 (split (org-split-string size " *x *"))
5719 (rows (string-to-number (nth 1 split)))
5720 (columns (string-to-number (car split)))
5721 (line (concat (apply 'concat indent "|" (make-list columns " |"))
5724 (point-at-bol) (point)))
5725 (beginning-of-line 1)
5726 (newline))
5727 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
5728 (dotimes (i rows) (insert line))
5729 (goto-char pos)
5730 (if (> rows 1)
5731 ;; Insert a hline after the first row.
5732 (progn
5733 (end-of-line 1)
5735 (goto-char pos)))
5736 (org-table-align)))
5738 (defun org-table-convert-region (beg0 end0 &optional nspace)
5739 "Convert region to a table.
5740 The region goes from BEG0 to END0, but these borders will be moved
5741 slightly, to make sure a beginning of line in the first line is included.
5742 When NSPACE is non-nil, it indicates the minimum number of spaces that
5743 separate columns (default: just one space)."
5744 (interactive "rP")
5745 (let* ((beg (min beg0 end0))
5746 (end (max beg0 end0))
5747 (tabsep t)
5748 re)
5749 (goto-char beg)
5750 (beginning-of-line 1)
5751 (setq beg (move-marker (make-marker) (point)))
5752 (goto-char end)
5753 (if (bolp) (backward-char 1) (end-of-line 1))
5754 (setq end (move-marker (make-marker) (point)))
5755 ;; Lets see if this is tab-separated material. If every nonempty line
5756 ;; contains a tab, we will assume that it is tab-separated material
5757 (if nspace
5758 (setq tabsep nil)
5759 (goto-char beg)
5761 (if nspace (setq tabsep nil))
5762 (if tabsep
5765 (max 1 (prefix-numeric-value nspace)))))
5766 (goto-char beg)
5767 (while (re-search-forward re end t)
5768 (replace-match "| " t t))
5769 (goto-char beg)
5770 (insert " ")
5771 (org-table-align)))
5773 (defun org-table-import (file arg)
5774 "Import FILE as a table.
5775 The file is assumed to be tab-separated. Such files can be produced by most
5776 spreadsheet and database applications. If no tabs (at least one per line)
5777 are found, lines will be split on whitespace into fields."
5779 (or (bolp) (newline))
5780 (let ((beg (point))
5781 (pm (point-max)))
5782 (insert-file-contents file)
5783 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
5785 (defun org-table-export ()
5786 "Export table as a tab-separated file.
5787 Such a file can be imported into a spreadsheet program like Excel."
5788 (interactive)
5789 (let* ((beg (org-table-begin))
5790 (end (org-table-end))
5791 (table (buffer-substring beg end))
5792 (file (read-file-name "Export table to: "))
5793 buf)
5794 (unless (or (not (file-exists-p file))
5795 (y-or-n-p (format "Overwrite file %s? " file)))
5796 (error "Abort"))
5797 (with-current-buffer (find-file-noselect file)
5798 (setq buf (current-buffer))
5799 (erase-buffer)
5800 (fundamental-mode)
5801 (insert table)
5802 (goto-char (point-min))
5804 (replace-match "" t t)
5805 (end-of-line 1))
5806 (goto-char (point-min))
5808 (replace-match "" t t)
5809 (goto-char (min (1+ (point)) (point-max))))
5810 (goto-char (point-min))
5811 (while (re-search-forward "^-[-+]*$" nil t)
5812 (replace-match "")
5814 (delete-char 1)))
5815 (goto-char (point-min))
5818 (save-buffer))
5819 (kill-buffer buf)))
5821 (defvar org-table-aligned-begin-marker (make-marker)
5822 "Marker at the beginning of the table last aligned.
5823 Used to check if cursor still is in that table, to minimize realignment.")
5824 (defvar org-table-aligned-end-marker (make-marker)
5825 "Marker at the end of the table last aligned.
5826 Used to check if cursor still is in that table, to minimize realignment.")
5827 (defvar org-table-last-alignment nil
5828 "List of flags for flushright alignment, from the last re-alignment.
5829 This is being used to correctly align a single field after TAB or RET.")
5830 (defvar org-table-last-column-widths nil
5831 "List of max width of fields in each column.
5832 This is being used to correctly align a single field after TAB or RET.")
5834 (defvar org-last-recalc-line nil)
5835 (defconst org-narrow-column-arrow "=>"
5836 "Used as display property in narrowed table columns.")
5838 (defun org-table-align ()
5839 "Align the table at point by aligning all vertical bars."
5840 (interactive)
5841 (let* (
5842 ;; Limits of table
5843 (beg (org-table-begin))
5844 (end (org-table-end))
5845 ;; Current cursor position
5846 (linepos (org-current-line))
5847 (colpos (org-table-current-column))
5848 (winstart (window-start))
5849 (winstartline (org-current-line (min winstart (1- (point-max)))))
5850 lines (new "") lengths l typenums ty fields maxfields i
5851 column
5852 (indent "") cnt frac
5853 rfmt hfmt
5854 (spaces '(1 . 1))
5855 (sp1 (car spaces))
5856 (sp2 (cdr spaces))
5857 (rfmt1 (concat
5858 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
5859 (hfmt1 (concat
5860 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
5861 emptystrings links dates narrow fmax f1 len c e)
5862 (untabify beg end)
5863 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
5864 ;; Check if we have links or dates
5865 (goto-char beg)
5866 (setq links (re-search-forward org-bracket-link-regexp end t))
5867 (goto-char beg)
5868 (setq dates (and org-display-custom-times
5869 (re-search-forward org-ts-regexp-both end t)))
5870 ;; Make sure the link properties are right
5871 (when links (goto-char beg) (while (org-activate-bracket-links end)))
5872 ;; Make sure the date properties are right
5873 (when dates (goto-char beg) (while (org-activate-dates end)))
5875 ;; Check if we are narrowing any columns
5876 (goto-char beg)
5877 (setq narrow (and org-format-transports-properties-p
5878 (re-search-forward "<[0-9]+>" end t)))
5879 ;; Get the rows
5880 (setq lines (org-split-string
5882 ;; Store the indentation of the first line
5883 (if (string-match "^ *" (car lines))
5884 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
5885 ;; Mark the hlines by setting the corresponding element to nil
5886 ;; At the same time, we remove trailing space.
5887 (setq lines (mapcar (lambda (l)
5888 (if (string-match "^ *|-" l)
5889 nil
5891 (substring l 0 (match-beginning 0))
5892 l)))
5893 lines))
5894 ;; Get the data fields by splitting the lines.
5895 (setq fields (mapcar
5896 (lambda (l)
5897 (org-split-string l " *| *"))
5898 (delq nil (copy-sequence lines))))
5899 ;; How many fields in the longest line?
5900 (condition-case nil
5901 (setq maxfields (apply 'max (mapcar 'length fields)))
5902 (error
5903 (kill-region beg end)
5904 (org-table-create org-table-default-size)
5905 (error "Empty table - created default table")))
5906 ;; A list of empty strings to fill any short rows on output
5907 (setq emptystrings (make-list maxfields ""))
5908 ;; Check for special formatting.
5909 (setq i -1)
5910 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
5911 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
5912 ;; Check if there is an explicit width specified
5913 (when (and org-table-limit-column-width narrow)
5914 (setq c column fmax nil)
5915 (while c
5916 (setq e (pop c))
5918 (setq fmax (string-to-number (match-string 1 e)) c nil)))
5919 ;; Find fields that are wider than fmax, and shorten them
5920 (when fmax
5921 (loop for xx in column do
5922 (when (and (stringp xx)
5923 (> (org-string-width xx) fmax))
5924 (org-add-props xx nil
5925 'help-echo
5926 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
5927 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
5928 (unless (> f1 1)
5930 (match-string 0 xx)))
5931 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
5932 (add-text-properties (- f1 2) f1
5933 (list 'display org-narrow-column-arrow)
5934 xx)))))
5935 ;; Get the maximum width for each column
5936 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
5937 ;; Get the fraction of numbers, to decide about alignment of the column
5938 (setq cnt 0 frac 0.0)
5939 (loop for x in column do
5940 (if (equal x "")
5941 nil
5942 (setq frac ( / (+ (* frac cnt)
5943 (if (string-match org-table-number-regexp x) 1 0))
5944 (setq cnt (1+ cnt))))))
5945 (push (>= frac org-table-number-fraction) typenums))
5946 (setq lengths (nreverse lengths) typenums (nreverse typenums))
5948 ;; Store the alignment of this table, for later editing of single fields
5949 (setq org-table-last-alignment typenums
5950 org-table-last-column-widths lengths)
5952 ;; With invisible characters, `format' does not get the field width right
5953 ;; So we need to make these fields wide by hand.
5954 (when links
5955 (loop for i from 0 upto (1- maxfields) do
5956 (setq len (nth i lengths))
5957 (loop for j from 0 upto (1- (length fields)) do
5958 (setq c (nthcdr i (car (nthcdr j fields))))
5959 (if (and (stringp (car c))
5960 (string-match org-bracket-link-regexp (car c))
5961 (< (org-string-width (car c)) len))
5962 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
5964 ;; Compute the formats needed for output of the table
5965 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
5966 (while (setq l (pop lengths))
5967 (setq ty (if (pop typenums) "" "-")) ; number types flushright
5968 (setq rfmt (concat rfmt (format rfmt1 ty l))
5969 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
5973 (setq new (mapconcat
5974 (lambda (l)
5975 (if l (apply 'format rfmt
5976 (append (pop fields) emptystrings))
5977 hfmt))
5978 lines ""))
5979 ;; Replace the old one
5980 (delete-region beg end)
5981 (move-marker end nil)
5982 (move-marker org-table-aligned-begin-marker (point))
5983 (insert new)
5984 (move-marker org-table-aligned-end-marker (point))
5985 (when (and orgtbl-mode (not (org-mode-p)))
5986 (goto-char org-table-aligned-begin-marker)
5987 (while (org-hide-wide-columns org-table-aligned-end-marker)))
5988 ;; Try to move to the old location
5989 (goto-line winstartline)
5990 (setq winstart (point-at-bol))
5991 (goto-line linepos)
5992 (set-window-start (selected-window) winstart 'noforce)
5993 (org-table-goto-column colpos)
5994 (setq org-table-may-need-update nil)
5995 ))
5997 (defun org-string-width (s)
5998 "Compute width of string, ignoring invisible characters.
5999 This ignores character with invisibility property `org-link', and also
6000 characters with property `org-cwidth', because these will become invisible
6001 upon the next fontification round."
6002 (let (b l)
6003 (when (or (eq t buffer-invisibility-spec)
6004 (assq 'org-link buffer-invisibility-spec))
6005 (while (setq b (text-property-any 0 (length s)
6006 'invisible 'org-link s))
6007 (setq s (concat (substring s 0 b)
6008 (substring s (or (next-single-property-change
6009 b 'invisible s) (length s)))))))
6010 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
6011 (setq s (concat (substring s 0 b)
6012 (substring s (or (next-single-property-change
6013 b 'org-cwidth s) (length s))))))
6014 (setq l (string-width s) b -1)
6015 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
6016 (setq l (- l (get-text-property b 'org-dwidth-n s))))
6017 l))
6019 (defun org-table-begin (&optional table-type)
6020 "Find the beginning of the table and return its position.
6021 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
6022 (save-excursion
6023 (if (not (re-search-backward
6024 (if table-type org-table-any-border-regexp
6025 org-table-border-regexp)
6026 nil t))
6027 (progn (goto-char (point-min)) (point))
6028 (goto-char (match-beginning 0))
6029 (beginning-of-line 2)
6030 (point))))
6032 (defun org-table-end (&optional table-type)
6033 "Find the end of the table and return its position.
6034 With argument TABLE-TYPE, go to the end of a table.el-type table."
6035 (save-excursion
6036 (if (not (re-search-forward
6037 (if table-type org-table-any-border-regexp
6038 org-table-border-regexp)
6039 nil t))
6040 (goto-char (point-max))
6041 (goto-char (match-beginning 0)))
6042 (point-marker)))
6044 (defun org-table-justify-field-maybe (&optional new)
6045 "Justify the current field, text to left, number to right.
6046 Optional argument NEW may specify text to replace the current field content."
6047 (cond
6048 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
6049 ((org-at-table-hline-p))
6050 ((and (not new)
6051 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
6052 (current-buffer)))
6053 (< (point) org-table-aligned-begin-marker)
6054 (>= (point) org-table-aligned-end-marker)))
6055 ;; This is not the same table, force a full re-align
6056 (setq org-table-may-need-update t))
6057 (t ;; realign the current field, based on previous full realign
6058 (let* ((pos (point)) s
6059 (col (org-table-current-column))
6060 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
6061 l f n o e)
6062 (when (> col 0)
6065 (progn
6066 (setq s (match-string 1)
6067 o (match-string 0)
6068 l (max 1 (- (match-end 0) (match-beginning 0) 3))
6069 e (not (= (match-beginning 2) (match-end 2))))
6070 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
6071 l (if e "|" (setq org-table-may-need-update t) ""))
6072 n (format f s))
6073 (if new
6074 (if (<= (length new) l) ;; FIXME: length -> str-width?
6075 (setq n (format f new))
6076 (setq n (concat new "|") org-table-may-need-update t)))
6077 (or (equal n o)
6078 (let (org-table-may-need-update)
6079 (replace-match n))))
6080 (setq org-table-may-need-update t))
6081 (goto-char pos))))))
6083 (defun org-table-next-field ()
6084 "Go to the next field in the current table, creating new lines as needed.
6085 Before doing so, re-align the table if necessary."
6086 (interactive)
6087 (org-table-maybe-eval-formula)
6088 (org-table-maybe-recalculate-line)
6089 (if (and org-table-automatic-realign
6090 org-table-may-need-update)
6091 (org-table-align))
6092 (let ((end (org-table-end)))
6093 (if (org-at-table-hline-p)
6094 (end-of-line 1))
6095 (condition-case nil
6096 (progn
6097 (re-search-forward "|" end)
6099 (re-search-forward "|" end))
6100 (if (and (looking-at "-")
6101 org-table-tab-jumps-over-hlines
6103 (goto-char (match-beginning 1)))
6104 (if (looking-at "-")
6105 (progn
6106 (beginning-of-line 0)
6107 (org-table-insert-row 'below))
6108 (if (looking-at " ") (forward-char 1))))
6109 (error
6110 (org-table-insert-row 'below)))))
6112 (defun org-table-previous-field ()
6113 "Go to the previous field in the table.
6114 Before doing so, re-align the table if necessary."
6115 (interactive)
6116 (org-table-justify-field-maybe)
6117 (org-table-maybe-recalculate-line)
6118 (if (and org-table-automatic-realign
6119 org-table-may-need-update)
6120 (org-table-align))
6121 (if (org-at-table-hline-p)
6122 (end-of-line 1))
6123 (re-search-backward "|" (org-table-begin))
6124 (re-search-backward "|" (org-table-begin))
6126 (re-search-backward "|" (org-table-begin)))
6127 (if (looking-at "| ?")
6128 (goto-char (match-end 0))))
6130 (defun org-table-next-row ()
6131 "Go to the next row (same column) in the current table.
6132 Before doing so, re-align the table if necessary."
6133 (interactive)
6134 (org-table-maybe-eval-formula)
6135 (org-table-maybe-recalculate-line)
6138 (newline)
6139 (if (and org-table-automatic-realign
6140 org-table-may-need-update)
6141 (org-table-align))
6142 (let ((col (org-table-current-column)))
6143 (beginning-of-line 2)
6144 (if (or (not (org-at-table-p))
6145 (org-at-table-hline-p))
6146 (progn
6147 (beginning-of-line 0)
6148 (org-table-insert-row 'below)))
6149 (org-table-goto-column col)
6151 (if (looking-at " ") (forward-char 1)))))
6153 (defun org-table-copy-down (n)
6154 "Copy a field down in the current column.
6155 If the field at the cursor is empty, copy into it the content of the nearest
6156 non-empty field above. With argument N, use the Nth non-empty field.
6157 If the current field is not empty, it is copied down to the next row, and
6158 the cursor is moved with it. Therefore, repeating this command causes the
6159 column to be filled row-by-row.
6160 If the variable `org-table-copy-increment' is non-nil and the field is an
6161 integer, it will be incremented while copying."
6162 (interactive "p")
6163 (let* ((colpos (org-table-current-column))
6164 (field (org-table-get-field))
6166 (beg (org-table-begin))
6167 txt)
6168 (org-table-check-inside-data-field)
6169 (if non-empty
6170 (progn
6171 (setq txt (org-trim field))
6172 (org-table-next-row)
6173 (org-table-blank-field))
6174 (save-excursion
6175 (setq txt
6176 (catch 'exit
6177 (while (progn (beginning-of-line 1)
6178 (re-search-backward org-table-dataline-regexp
6179 beg t))
6180 (org-table-goto-column colpos t)
6181 (if (and (looking-at
6183 (= (setq n (1- n)) 0))
6184 (throw 'exit (match-string 1))))))))
6185 (if txt
6186 (progn
6187 (if (and org-table-copy-increment
6188 (string-match "^[0-9]+$" txt))
6189 (setq txt (format "%d" (+ (string-to-number txt) 1))))
6190 (insert txt)
6191 (org-table-maybe-recalculate-line)
6192 (org-table-align))
6193 (error "No non-empty field found"))))
6195 (defun org-table-check-inside-data-field ()
6196 "Is point inside a table data field?
6197 I.e. not on a hline or before the first or after the last column?
6198 This actually throws an error, so it aborts the current command."
6199 (if (or (not (org-at-table-p))
6200 (= (org-table-current-column) 0)
6201 (org-at-table-hline-p)
6203 (error "Not in table data field")))
6205 (defvar org-table-clip nil
6206 "Clipboard for table regions.")
6208 (defun org-table-blank-field ()
6209 "Blank the current table field or active region."
6210 (interactive)
6211 (org-table-check-inside-data-field)
6212 (if (and (interactive-p) (org-region-active-p))
6213 (let (org-table-clip)
6214 (org-table-cut-region (region-beginning) (region-end)))
6215 (skip-chars-backward "^|")
6216 (backward-char 1)
6218 (let* ((pos (match-beginning 0))
6219 (match (match-string 0))
6220 (len (org-string-width match)))
6221 (replace-match (concat "|" (make-string (1- len) ?\ )))
6222 (goto-char (+ 2 pos))
6223 (substring match 1)))))
6225 (defun org-table-get-field (&optional n replace)
6226 "Return the value of the field in column N of current row.
6227 N defaults to current field.
6228 If REPLACE is a string, replace field with this value. The return value
6229 is always the old value."
6230 (and n (org-table-goto-column n))
6232 (backward-char 1)
6234 (let* ((pos (match-beginning 0))
6235 (val (buffer-substring (1+ pos) (match-end 0))))
6236 (if replace
6237 (replace-match (concat "|" replace)))
6238 (goto-char (min (point-at-eol) (+ 2 pos)))
6239 val)
6240 (forward-char 1) ""))
6242 (defun org-table-current-column ()
6243 "Find out which column we are in.
6244 When called interactively, column is also displayed in echo area."
6245 (interactive)
6246 (if (interactive-p) (org-table-check-inside-data-field))
6247 (save-excursion
6248 (let ((cnt 0) (pos (point)))
6249 (beginning-of-line 1)
6250 (while (search-forward "|" pos t)
6251 (setq cnt (1+ cnt)))
6252 (if (interactive-p) (message "This is table column %d" cnt))
6253 cnt)))
6255 (defun org-table-goto-column (n &optional on-delim force)
6256 "Move the cursor to the Nth column in the current table line.
6257 With optional argument ON-DELIM, stop with point before the left delimiter
6258 of the field.
6259 If there are less than N fields, just go to after the last delimiter.
6260 However, when FORCE is non-nil, create new columns if necessary."
6261 (interactive "p")
6262 (let ((pos (point-at-eol)))
6263 (beginning-of-line 1)
6264 (when (> n 0)
6265 (while (and (> (setq n (1- n)) -1)
6266 (or (search-forward "|" pos t)
6267 (and force
6268 (progn (end-of-line 1)
6269 (skip-chars-backward "^|")
6270 (insert " | "))))))
6271 ; (backward-char 2) t)))))
6272 (when (and force (not (looking-at ".*|")))
6273 (save-excursion (end-of-line 1) (insert " | ")))
6274 (if on-delim
6275 (backward-char 1)
6276 (if (looking-at " ") (forward-char 1))))))
6278 (defun org-at-table-p (&optional table-type)
6279 "Return t if the cursor is inside an org-type table.
6280 If TABLE-TYPE is non-nil, also check for table.el-type tables."
6281 (if org-enable-table-editor
6282 (save-excursion
6283 (beginning-of-line 1)
6284 (looking-at (if table-type org-table-any-line-regexp
6285 org-table-line-regexp)))
6286 nil))
6288 (defun org-at-table.el-p ()
6289 "Return t if and only if we are at a table.el table."
6290 (and (org-at-table-p 'any)
6291 (save-excursion
6292 (goto-char (org-table-begin 'any))
6293 (looking-at org-table1-hline-regexp))))
6295 (defun org-table-recognize-table.el ()
6296 "If there is a table.el table nearby, recognize it and move into it."
6297 (if org-table-tab-recognizes-table.el
6298 (if (org-at-table.el-p)
6299 (progn
6300 (beginning-of-line 1)
6301 (if (looking-at org-table-dataline-regexp)
6302 nil
6303 (if (looking-at org-table1-hline-regexp)
6304 (progn
6305 (beginning-of-line 2)
6306 (if (looking-at org-table-any-border-regexp)
6307 (beginning-of-line -1)))))
6308 (if (re-search-forward "|" (org-table-end t) t)
6309 (progn
6310 (require 'table)
6311 (if (table--at-cell-p (point))
6312 t
6313 (message "recognizing table.el table...")
6314 (table-recognize-table)
6315 (message "recognizing table.el table...done")))
6316 (error "This should not happen..."))
6317 t)
6318 nil)
6319 nil))
6321 (defun org-at-table-hline-p ()
6322 "Return t if the cursor is inside a hline in a table."
6323 (if org-enable-table-editor
6324 (save-excursion
6325 (beginning-of-line 1)
6326 (looking-at org-table-hline-regexp))
6327 nil))
6329 (defun org-table-insert-column ()
6330 "Insert a new column into the table."
6331 (interactive)
6332 (if (not (org-at-table-p))
6333 (error "Not at a table"))
6334 (org-table-find-dataline)
6335 (let* ((col (max 1 (org-table-current-column)))
6336 (beg (org-table-begin))
6337 (end (org-table-end))
6338 ;; Current cursor position
6339 (linepos (org-current-line))
6340 (colpos col))
6341 (goto-char beg)
6342 (while (< (point) end)
6343 (if (org-at-table-hline-p)
6344 nil
6345 (org-table-goto-column col t)
6346 (insert "| "))
6347 (beginning-of-line 2))
6348 (move-marker end nil)
6349 (goto-line linepos)
6350 (org-table-goto-column colpos)
6351 (org-table-align)
6352 (org-table-modify-formulas 'insert col)))
6354 (defun org-table-find-dataline ()
6355 "Find a dataline in the current table, which is needed for column commands."
6356 (if (and (org-at-table-p)
6357 (not (org-at-table-hline-p)))
6358 t
6359 (let ((col (current-column))
6360 (end (org-table-end)))
6361 (move-to-column col)
6362 (while (and (< (point) end)
6363 (or (not (= (current-column) col))
6364 (org-at-table-hline-p)))
6365 (beginning-of-line 2)
6366 (move-to-column col))
6367 (if (and (org-at-table-p)
6368 (not (org-at-table-hline-p)))
6369 t
6370 (error
6371 "Please position cursor in a data line for column operations")))))
6373 (defun org-table-delete-column ()
6374 "Delete a column from the table."
6375 (interactive)
6376 (if (not (org-at-table-p))
6377 (error "Not at a table"))
6378 (org-table-find-dataline)
6379 (org-table-check-inside-data-field)
6380 (let* ((col (org-table-current-column))
6381 (beg (org-table-begin))
6382 (end (org-table-end))
6383 ;; Current cursor position
6384 (linepos (org-current-line))
6385 (colpos col))
6386 (goto-char beg)
6387 (while (< (point) end)
6388 (if (org-at-table-hline-p)
6389 nil
6390 (org-table-goto-column col t)
6392 (replace-match "|")))
6393 (beginning-of-line 2))
6394 (move-marker end nil)
6395 (goto-line linepos)
6396 (org-table-goto-column colpos)
6397 (org-table-align)
6398 (org-table-modify-formulas 'remove col)))
6400 (defun org-table-move-column-right ()
6401 "Move column to the right."
6402 (interactive)
6403 (org-table-move-column nil))
6404 (defun org-table-move-column-left ()
6405 "Move column to the left."
6406 (interactive)
6407 (org-table-move-column 'left))
6409 (defun org-table-move-column (&optional left)
6410 "Move the current column to the right. With arg LEFT, move to the left."
6411 (interactive "P")
6412 (if (not (org-at-table-p))
6413 (error "Not at a table"))
6414 (org-table-find-dataline)
6415 (org-table-check-inside-data-field)
6416 (let* ((col (org-table-current-column))
6417 (col1 (if left (1- col) col))
6418 (beg (org-table-begin))
6419 (end (org-table-end))
6420 ;; Current cursor position
6421 (linepos (org-current-line))
6422 (colpos (if left (1- col) (1+ col))))
6423 (if (and left (= col 1))
6424 (error "Cannot move column further left"))
6426 (error "Cannot move column further right"))
6427 (goto-char beg)
6428 (while (< (point) end)
6429 (if (org-at-table-hline-p)
6430 nil
6431 (org-table-goto-column col1 t)
6434 (beginning-of-line 2))
6435 (move-marker end nil)
6436 (goto-line linepos)
6437 (org-table-goto-column colpos)
6438 (org-table-align)
6439 (org-table-modify-formulas 'swap col (if left (1- col) (1+ col)))))
6441 (defun org-table-move-row-down ()
6442 "Move table row down."
6443 (interactive)
6444 (org-table-move-row nil))
6445 (defun org-table-move-row-up ()
6446 "Move table row up."
6447 (interactive)
6448 (org-table-move-row 'up))
6450 (defun org-table-move-row (&optional up)
6451 "Move the current table line down. With arg UP, move it up."
6452 (interactive "P")
6453 (let ((col (current-column))
6454 (pos (point))
6455 (tonew (if up 0 2))
6456 txt)
6457 (beginning-of-line tonew)
6458 (if (not (org-at-table-p))
6459 (progn
6460 (goto-char pos)
6461 (error "Cannot move row further")))
6462 (goto-char pos)
6463 (beginning-of-line 1)
6464 (setq pos (point))
6465 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
6466 (delete-region (point) (1+ (point-at-eol)))
6467 (beginning-of-line tonew)
6468 (insert txt)
6469 (beginning-of-line 0)
6470 (move-to-column col)))
6472 (defun org-table-insert-row (&optional arg)
6473 "Insert a new row above the current line into the table.
6474 With prefix ARG, insert below the current line."
6475 (interactive "P")
6476 (if (not (org-at-table-p))
6477 (error "Not at a table"))
6478 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
6479 (new (org-table-clean-line line)))
6480 ;; Fix the first field if necessary
6482 (setq new (replace-match (match-string 0 line) t t new)))
6483 (beginning-of-line (if arg 2 1))
6485 (beginning-of-line 0)
6486 (re-search-forward "| ?" (point-at-eol) t)
6487 (and org-table-may-need-update (org-table-align))))
6489 (defun org-table-insert-hline (&optional arg)
6490 "Insert a horizontal-line below the current line into the table.
6491 With prefix ARG, insert above the current line."
6492 (interactive "P")
6493 (if (not (org-at-table-p))
6494 (error "Not at a table"))
6495 (let ((line (org-table-clean-line
6496 (buffer-substring (point-at-bol) (point-at-eol))))
6497 (col (current-column)))
6499 (setq line (replace-match
6500 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
6501 ?-) "|") t t line)))
6503 (beginning-of-line (if arg 1 2))
6505 (beginning-of-line (if arg 1 -1))
6506 (move-to-column col)))
6508 (defun org-table-clean-line (s)
6510 In particular, this does handle wide and invisible characters."
6512 ;; It's a hline, just map the characters
6513 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
6515 (setq s (replace-match
6516 (concat "|" (make-string (org-string-width (match-string 1 s))
6517 ?\ ) "|")
6518 t t s)))
6519 s))
6521 (defun org-table-kill-row ()
6522 "Delete the current row or horizontal line from the table."
6523 (interactive)
6524 (if (not (org-at-table-p))
6525 (error "Not at a table"))
6526 (let ((col (current-column)))
6527 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
6528 (if (not (org-at-table-p)) (beginning-of-line 0))
6529 (move-to-column col)))
6531 (defun org-table-sort-lines (with-case &optional sorting-type)
6532 "Sort table lines according to the column at point.
6534 The position of point indicates the column to be used for
6535 sorting, and the range of lines is the range between the nearest
6536 horizontal separator lines, or the entire table of no such lines
6537 exist. If point is before the first column, you will be prompted
6538 for the sorting column. If there is an active region, the mark
6539 specifies the first line and the sorting column, while point
6540 should be in the last line to be included into the sorting.
6542 The command then prompts for the sorting type which can be
6543 alphabetically, numerically, or by time (as given in a time stamp
6544 in the field). Sorting in reverse order is also possible.
6546 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
6548 If SORTING-TYPE is specified when this function is called from a Lisp
6549 program, no prompting will take place. SORTING-TYPE must be a character,
6550 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
6551 should be done in reverse order."
6552 (interactive "P")
6553 (let* ((thisline (org-current-line))
6554 (thiscol (org-table-current-column))
6555 beg end bcol ecol tend tbeg column lns pos)
6556 (when (equal thiscol 0)
6557 (if (interactive-p)
6558 (setq thiscol
6559 (string-to-number
6560 (read-string "Use column N for sorting: ")))
6561 (setq thiscol 1))
6562 (org-table-goto-column thiscol))
6563 (org-table-check-inside-data-field)
6564 (if (org-region-active-p)
6565 (progn
6566 (setq beg (region-beginning) end (region-end))
6567 (goto-char beg)
6568 (setq column (org-table-current-column)
6569 beg (point-at-bol))
6570 (goto-char end)
6571 (setq end (point-at-bol 2)))
6572 (setq column (org-table-current-column)
6573 pos (point)
6574 tbeg (org-table-begin)
6575 tend (org-table-end))
6576 (if (re-search-backward org-table-hline-regexp tbeg t)
6577 (setq beg (point-at-bol 2))
6578 (goto-char tbeg)
6579 (setq beg (point-at-bol 1)))
6580 (goto-char pos)
6581 (if (re-search-forward org-table-hline-regexp tend t)
6582 (setq beg (point-at-bol 0))
6583 (goto-char tend)
6584 (setq end (point-at-bol))))
6585 (setq beg (move-marker (make-marker) beg)
6586 end (move-marker (make-marker) end))
6587 (untabify beg end)
6588 (goto-char beg)
6589 (org-table-goto-column column)
6590 (skip-chars-backward "^|")
6591 (setq bcol (current-column))
6592 (org-table-goto-column (1+ column))
6593 (skip-chars-backward "^|")
6594 (setq ecol (1- (current-column)))
6595 (org-table-goto-column column)
6596 (setq lns (mapcar (lambda(x) (cons (org-trim (substring x bcol ecol)) x))
6598 (setq lns (org-do-sort lns "Table" with-case sorting-type))
6599 (delete-region beg end)
6600 (move-marker beg nil)
6601 (move-marker end nil)
6603 (goto-line thisline)
6604 (org-table-goto-column thiscol)
6605 (message "%d lines sorted, based on column %d" (length lns) column)))
6607 (defun org-table-cut-region (beg end)
6608 "Copy region in table to the clipboard and blank all relevant fields."
6609 (interactive "r")
6610 (org-table-copy-region beg end 'cut))
6612 (defun org-table-copy-region (beg end &optional cut)
6613 "Copy rectangular region in table to clipboard.
6614 A special clipboard is used which can only be accessed
6615 with `org-table-paste-rectangle'."
6616 (interactive "rP")
6617 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
6618 region cols
6619 (rpl (if cut " " nil)))
6620 (goto-char beg)
6621 (org-table-check-inside-data-field)
6622 (setq l01 (org-current-line)
6623 c01 (org-table-current-column))
6624 (goto-char end)
6625 (org-table-check-inside-data-field)
6626 (setq l02 (org-current-line)
6627 c02 (org-table-current-column))
6628 (setq l1 (min l01 l02) l2 (max l01 l02)
6629 c1 (min c01 c02) c2 (max c01 c02))
6630 (catch 'exit
6631 (while t
6632 (catch 'nextline
6633 (if (> l1 l2) (throw 'exit t))
6634 (goto-line l1)
6635 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
6636 (setq cols nil ic1 c1 ic2 c2)
6637 (while (< ic1 (1+ ic2))
6638 (push (org-table-get-field ic1 rpl) cols)
6639 (setq ic1 (1+ ic1)))
6640 (push (nreverse cols) region)
6641 (setq l1 (1+ l1)))))
6642 (setq org-table-clip (nreverse region))
6643 (if cut (org-table-align))
6644 org-table-clip))
6646 (defun org-table-paste-rectangle ()
6647 "Paste a rectangular region into a table.
6648 The upper right corner ends up in the current field. All involved fields
6649 will be overwritten. If the rectangle does not fit into the present table,
6650 the table is enlarged as needed. The process ignores horizontal separator
6651 lines."
6652 (interactive)
6653 (unless (and org-table-clip (listp org-table-clip))
6654 (error "First cut/copy a region to paste!"))
6655 (org-table-check-inside-data-field)
6656 (let* ((clip org-table-clip)
6657 (line (org-current-line))
6658 (col (org-table-current-column))
6659 (org-enable-table-editor t)
6660 (org-table-automatic-realign nil)
6661 c cols field)
6662 (while (setq cols (pop clip))
6663 (while (org-at-table-hline-p) (beginning-of-line 2))
6664 (if (not (org-at-table-p))
6665 (progn (end-of-line 0) (org-table-next-field)))
6666 (setq c col)
6667 (while (setq field (pop cols))
6668 (org-table-goto-column c nil 'force)
6669 (org-table-get-field nil field)
6670 (setq c (1+ c)))
6671 (beginning-of-line 2))
6672 (goto-line line)
6673 (org-table-goto-column col)
6674 (org-table-align)))
6676 (defun org-table-convert ()
6677 "Convert from `org-mode' table to table.el and back.
6678 Obviously, this only works within limits. When an Org-mode table is
6679 converted to table.el, all horizontal separator lines get lost, because
6680 table.el uses these as cell boundaries and has no notion of horizontal lines.
6681 A table.el table can be converted to an Org-mode table only if it does not
6682 do row or column spanning. Multiline cells will become multiple cells.
6683 Beware, Org-mode does not test if the table can be successfully converted - it
6684 blindly applies a recipe that works for simple tables."
6685 (interactive)
6686 (require 'table)
6687 (if (org-at-table.el-p)
6688 ;; convert to Org-mode table
6689 (let ((beg (move-marker (make-marker) (org-table-begin t)))
6690 (end (move-marker (make-marker) (org-table-end t))))
6691 (table-unrecognize-region beg end)
6692 (goto-char beg)
6694 (replace-match ""))
6695 (goto-char beg))
6696 (if (org-at-table-p)
6697 ;; convert to table.el table
6698 (let ((beg (move-marker (make-marker) (org-table-begin)))
6699 (end (move-marker (make-marker) (org-table-end))))
6700 ;; first, get rid of all horizontal lines
6701 (goto-char beg)
6703 (replace-match ""))
6704 ;; insert a hline before first
6705 (goto-char beg)
6706 (org-table-insert-hline 'above)
6707 (beginning-of-line -1)
6708 ;; insert a hline after each line
6709 (while (progn (beginning-of-line 3) (< (point) end))
6710 (org-table-insert-hline))
6711 (goto-char beg)
6712 (setq end (move-marker end (org-table-end)))
6713 ;; replace "+" at beginning and ending of hlines
6716 (goto-char beg)
6718 (replace-match "-+"))
6719 (goto-char beg)))))
6721 (defun org-table-wrap-region (arg)
6722 "Wrap several fields in a column like a paragraph.
6723 This is useful if you'd like to spread the contents of a field over several
6724 lines, in order to keep the table compact.
6726 If there is an active region, and both point and mark are in the same column,
6727 the text in the column is wrapped to minimum width for the given number of
6728 lines. Generally, this makes the table more compact. A prefix ARG may be
6730 formats the selected text to two lines. If the region was longer than two
6731 lines, the remaining lines remain empty. A negative prefix argument reduces
6732 the current number of lines by that amount. The wrapped text is pasted back
6733 into the table. If you formatted it to more lines than it was before, fields
6734 further down in the table get overwritten - so you might need to make space in
6735 the table first.
6737 If there is no region, the current field is split at the cursor position and
6738 the text fragment to the right of the cursor is prepended to the field one
6739 line down.
6741 If there is no region, but you specify a prefix ARG, the current field gets
6742 blank, and the content is appended to the field above."
6743 (interactive "P")
6744 (org-table-check-inside-data-field)
6745 (if (org-region-active-p)
6746 ;; There is a region: fill as a paragraph
6747 (let ((beg (region-beginning))
6748 nlines)
6749 (org-table-cut-region (region-beginning) (region-end))
6750 (if (> (length (car org-table-clip)) 1)
6751 (error "Region must be limited to single column"))
6752 (setq nlines (if arg
6753 (if (< arg 1)
6754 (+ (length org-table-clip) arg)
6755 arg)
6756 (length org-table-clip)))
6757 (setq org-table-clip
6758 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
6759 nil nlines)))
6760 (goto-char beg)
6761 (org-table-paste-rectangle))
6762 ;; No region, split the current field at point
6763 (if arg
6764 ;; combine with field above
6765 (let ((s (org-table-blank-field))
6766 (col (org-table-current-column)))
6767 (beginning-of-line 0)
6768 (while (org-at-table-hline-p) (beginning-of-line 0))
6769 (org-table-goto-column col)
6770 (skip-chars-forward "^|")
6771 (skip-chars-backward " ")
6772 (insert " " (org-trim s))
6773 (org-table-align))
6774 ;; split field
6776 (let ((s (match-string 1)))
6777 (replace-match " |")
6778 (goto-char (match-beginning 0))
6779 (org-table-next-row)
6780 (insert (org-trim s) " ")
6781 (org-table-align))))))
6783 (defvar org-field-marker nil)
6785 (defun org-table-edit-field (arg)
6786 "Edit table field in a different window.
6787 This is mainly useful for fields that contain hidden parts.
6789 it can be edited in place."
6790 (interactive "P")
6791 (if arg
6792 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
6794 (remove-text-properties b e '(org-cwidth t invisible t
6795 display t intangible t))
6796 (if (and (boundp 'font-lock-mode) font-lock-mode)
6797 (font-lock-fontify-block)))
6798 (let ((pos (move-marker (make-marker) (point)))
6799 (field (org-table-get-field))
6800 (cw (current-window-configuration))
6801 p)
6802 (switch-to-buffer-other-window "*Org tmp*")
6803 (erase-buffer)
6805 (org-mode)
6806 (goto-char (setq p (point-max)))
6807 (insert (org-trim field))
6808 (remove-text-properties p (point-max)
6809 '(invisible t org-cwidth t display t
6810 intangible t))
6811 (goto-char p)
6812 (org-set-local 'org-finish-function
6813 'org-table-finish-edit-field)
6814 (org-set-local 'org-window-configuration cw)
6815 (org-set-local 'org-field-marker pos)
6816 (message "Edit and finish with C-c C-c"))))
6818 (defun org-table-finish-edit-field ()
6819 "Finish editing a table data field.
6820 Remove all newline characters, insert the result into the table, realign
6821 the table and kill the editing buffer."
6822 (let ((pos org-field-marker)
6823 (cw org-window-configuration)
6824 (cb (current-buffer))
6825 text)
6826 (goto-char (point-min))
6829 (replace-match " "))
6830 (setq text (org-trim (buffer-string)))
6831 (set-window-configuration cw)
6832 (kill-buffer cb)
6833 (select-window (get-buffer-window (marker-buffer pos)))
6834 (goto-char pos)
6835 (move-marker pos nil)
6836 (org-table-check-inside-data-field)
6837 (org-table-get-field nil text)
6838 (org-table-align)
6839 (message "New field value inserted")))
6841 (defun org-trim (s)
6842 "Remove whitespace at beginning and end of string."
6845 s)
6847 (defun org-wrap (string &optional width lines)
6848 "Wrap string to either a number of lines, or a width in characters.
6849 If WIDTH is non-nil, the string is wrapped to that width, however many lines
6850 that costs. If there is a word longer than WIDTH, the text is actually
6851 wrapped to the length of that word.
6852 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
6853 many lines, whatever width that takes.
6854 The return value is a list of lines, without newlines at the end."
6856 (maxword (apply 'max (mapcar 'org-string-width words)))
6857 w ll)
6858 (cond (width
6859 (org-do-wrap words (max maxword width)))
6860 (lines
6861 (setq w maxword)
6862 (setq ll (org-do-wrap words maxword))
6863 (if (<= (length ll) lines)
6864 ll
6865 (setq ll words)
6866 (while (> (length ll) lines)
6867 (setq w (1+ w))
6868 (setq ll (org-do-wrap words w)))
6869 ll))
6870 (t (error "Cannot wrap this")))))
6873 (defun org-do-wrap (words width)
6874 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
6875 (let (lines line)
6876 (while words
6877 (setq line (pop words))
6878 (while (and words (< (+ (length line) (length (car words))) width))
6879 (setq line (concat line " " (pop words))))
6880 (setq lines (push line lines)))
6881 (nreverse lines)))
6883 (defun org-split-string (string &optional separators)
6884 "Splits STRING into substrings at SEPARATORS.
6885 No empty strings are returned if there are matches at the beginning
6886 and end of string."
6888 (start 0)
6889 notfirst
6890 (list nil))
6891 (while (and (string-match rexp string
6892 (if (and notfirst
6893 (= start (match-beginning 0))
6894 (< start (length string)))
6895 (1+ start) start))
6896 (< (match-beginning 0) (length string)))
6897 (setq notfirst t)
6898 (or (eq (match-beginning 0) 0)
6899 (and (eq (match-beginning 0) (match-end 0))
6900 (eq (match-beginning 0) start))
6901 (setq list
6902 (cons (substring string start (match-beginning 0))
6903 list)))
6904 (setq start (match-end 0)))
6905 (or (eq start (length string))
6906 (setq list
6907 (cons (substring string start)
6908 list)))
6909 (nreverse list)))
6911 (defun org-table-map-tables (function)
6912 "Apply FUNCTION to the start of all tables in the buffer."
6913 (save-excursion
6914 (save-restriction
6915 (widen)
6916 (goto-char (point-min))
6917 (while (re-search-forward org-table-any-line-regexp nil t)
6918 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
6919 (beginning-of-line 1)
6920 (if (looking-at org-table-line-regexp)
6921 (save-excursion (funcall function)))
6922 (re-search-forward org-table-any-border-regexp nil 1))))
6923 (message "Mapping tables: done"))
6925 (defvar org-timecnt) ; dynamically scoped parameter
6927 (defun org-table-sum (&optional beg end nlast)
6928 "Sum numbers in region of current table column.
6929 The result will be displayed in the echo area, and will be available
6932 If there is an active region, it is interpreted as a rectangle and all
6933 numbers in that rectangle will be summed. If there is no active
6934 region and point is located in a table column, sum all numbers in that
6935 column.
6937 If at least one number looks like a time HH:MM or HH:MM:SS, all other
6938 numbers are assumed to be times as well (in decimal hours) and the
6939 numbers are added as such.
6941 If NLAST is a number, only the NLAST fields will actually be summed."
6942 (interactive)
6943 (save-excursion
6944 (let (col (org-timecnt 0) diff h m s org-table-clip)
6945 (cond
6946 ((and beg end)) ; beg and end given explicitly
6947 ((org-region-active-p)
6948 (setq beg (region-beginning) end (region-end)))
6949 (t
6950 (setq col (org-table-current-column))
6951 (goto-char (org-table-begin))
6953 (error "No table data"))
6954 (org-table-goto-column col)
6955 ;not needed? (skip-chars-backward "^|")
6956 (setq beg (point))
6957 (goto-char (org-table-end))
6959 (error "No table data"))
6960 (org-table-goto-column col)
6961 ;not needed? (skip-chars-forward "^|")
6962 (setq end (point))))
6963 (let* ((items (apply 'append (org-table-copy-region beg end)))
6964 (items1 (cond ((not nlast) items)
6965 ((>= nlast (length items)) items)
6966 (t (setq items (reverse items))
6967 (setcdr (nthcdr (1- nlast) items) nil)
6968 (nreverse items))))
6969 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
6970 items1)))
6971 (res (apply '+ numbers))
6972 (sres (if (= org-timecnt 0)
6973 (format "%g" res)
6974 (setq diff (* 3600 res)
6975 h (floor (/ diff 3600)) diff (mod diff 3600)
6976 m (floor (/ diff 60)) diff (mod diff 60)
6977 s diff)
6978 (format "%d:%02d:%02d" h m s))))
6979 (kill-new sres)
6980 (if (interactive-p)
6981 (message "%s"
6982 (substitute-command-keys
6984 (length numbers) sres))))
6985 sres))))
6987 (defun org-table-get-number-for-summing (s)
6988 (let (n)
6989 (if (string-match "^ *|? *" s)
6990 (setq s (replace-match "" nil nil s)))
6991 (if (string-match " *|? *$" s)
6992 (setq s (replace-match "" nil nil s)))
6993 (setq n (string-to-number s))
6994 (cond
6995 ((and (string-match "0" s)
6999 (let ((h (string-to-number (or (match-string 1 s) "0")))
7000 (m (string-to-number (or (match-string 2 s) "0")))
7001 (s (string-to-number (or (match-string 4 s) "0"))))
7002 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
7003 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
7004 ((equal n 0) nil)
7005 (t n))))
7007 (defun org-table-get-vertical-vector (desc &optional tbeg col)
7008 "Get a calc vector from a column, accorting to descriptor DESC.
7009 Optional arguments TBEG and COL can give the beginning of the table and
7010 the current column, to avoid unnecessary parsing."
7011 (save-excursion
7012 (or tbeg (setq tbeg (org-table-begin)))
7013 (or col (setq col (org-table-current-column)))
7014 (let (beg end nn n n1 n2 l (thisline (org-current-line)) hline-list)
7015 (cond
7017 (setq n1 (- (match-end 1) (match-beginning 1)))
7018 (if (match-beginning 3)
7019 (setq n2 (- (match-end 2) (match-beginning 3))))
7020 (setq n (if n2 (max n1 n2) n1))
7021 (setq n1 (if n2 (min n1 n2)))
7022 (setq nn n)
7023 (while (and (> nn 0)
7024 (re-search-backward org-table-hline-regexp tbeg t))
7025 (push (org-current-line) hline-list)
7026 (setq nn (1- nn)))
7027 (setq hline-list (nreverse hline-list))
7028 (goto-line (nth (1- n) hline-list))
7029 (when (re-search-forward org-table-dataline-regexp)
7030 (org-table-goto-column col)
7031 (setq beg (point)))
7032 (goto-line (if n1 (nth (1- n1) hline-list) thisline))
7033 (when (re-search-backward org-table-dataline-regexp)
7034 (org-table-goto-column col)
7035 (setq end (point)))
7036 (setq l (apply 'append (org-table-copy-region beg end)))
7037 (concat "[" (mapconcat (lambda (x) (setq x (org-trim x))
7038 (if (equal x "") "0" x))
7039 l ",") "]"))
7041 (setq n1 (string-to-number (match-string 1 desc))
7042 n2 (string-to-number (match-string 2 desc)))
7043 (beginning-of-line 1)
7044 (save-excursion
7045 (when (re-search-backward org-table-dataline-regexp tbeg t n1)
7046 (org-table-goto-column col)
7047 (setq beg (point))))
7048 (when (re-search-backward org-table-dataline-regexp tbeg t n2)
7049 (org-table-goto-column col)
7050 (setq end (point)))
7051 (setq l (apply 'append (org-table-copy-region beg end)))
7052 (concat "[" (mapconcat
7053 (lambda (x) (setq x (org-trim x))
7054 (if (equal x "") "0" x))
7055 l ",") "]"))
7057 (beginning-of-line 1)
7058 (when (re-search-backward org-table-dataline-regexp tbeg t
7059 (string-to-number (match-string 0 desc)))
7060 (org-table-goto-column col)
7061 (org-trim (org-table-get-field))))))))
7063 (defvar org-table-formula-history nil)
7065 (defvar org-table-column-names nil
7066 "Alist with column names, derived from the `!' line.")
7067 (defvar org-table-column-name-regexp nil
7068 "Regular expression matching the current column names.")
7069 (defvar org-table-local-parameters nil
7070 "Alist with parameter names, derived from the `$' line.")
7071 (defvar org-table-named-field-locations nil
7072 "Alist with locations of named fields.")
7074 (defun org-table-get-formula (&optional equation named)
7075 "Read a formula from the minibuffer, offer stored formula as default."
7076 (let* ((name (car (rassoc (list (org-current-line)
7077 (org-table-current-column))
7078 org-table-named-field-locations)))
7079 (scol (if named
7080 (if name name
7081 (error "Not in a named field"))
7082 (int-to-string (org-table-current-column))))
7083 (dummy (and name (not named)
7084 (not (y-or-n-p "Replace named-field formula with column equation? " ))
7085 (error "Abort")))
7086 (org-table-may-need-update nil)
7087 (stored-list (org-table-get-stored-formulas))
7088 (stored (cdr (assoc scol stored-list)))
7089 (eq (cond
7090 ((and stored equation (string-match "^ *=? *$" equation))
7091 stored)
7092 ((stringp equation)
7093 equation)
7094 (t (read-string
7095 (format "%s formula $%s=" (if named "Field" "Column") scol)
7096 (or stored "") 'org-table-formula-history
7097 ;stored
7098 ))))
7099 mustsave)
7101 ;; remove formula
7102 (setq stored-list (delq (assoc scol stored-list) stored-list))
7103 (org-table-store-formulas stored-list)
7104 (error "Formula removed"))
7105 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
7106 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
7107 (if (and name (not named))
7108 ;; We set the column equation, delete the named one.
7109 (setq stored-list (delq (assoc name stored-list) stored-list)
7110 mustsave t))
7111 (if stored
7112 (setcdr (assoc scol stored-list) eq)
7113 (setq stored-list (cons (cons scol eq) stored-list)))
7114 (if (or mustsave (not (equal stored eq)))
7115 (org-table-store-formulas stored-list))
7116 eq))
7118 (defun org-table-store-formulas (alist)
7119 "Store the list of formulas below the current table."
7120 (setq alist (sort alist (lambda (a b) (string< (car a) (car b)))))
7121 (save-excursion
7122 (goto-char (org-table-end))
7124 (delete-region (point) (match-end 0)))
7125 (insert "#+TBLFM: "
7126 (mapconcat (lambda (x)
7127 (concat "$" (car x) "=" (cdr x)))
7128 alist "::")
7131 (defun org-table-get-stored-formulas ()
7132 "Return an alist with the stored formulas directly after current table."
7133 (interactive)
7134 (let (scol eq eq-alist strings string seen)
7135 (save-excursion
7136 (goto-char (org-table-end))
7138 (setq strings (org-split-string (match-string 2) " *:: *"))
7139 (while (setq string (pop strings))
7141 (setq scol (match-string 1 string)
7142 eq (match-string 2 string)
7143 eq-alist (cons (cons scol eq) eq-alist))
7144 (if (member scol seen)
7145 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
7146 (push scol seen))))))
7147 (nreverse eq-alist)))
7149 (defun org-table-modify-formulas (action &rest columns)
7150 "Modify the formulas stored below the current table.
7151 ACTION can be `remove', `insert', `swap'. For `swap', two column numbers are
7152 expected, for the other actions only a single column number is needed."
7153 (let ((list (org-table-get-stored-formulas))
7154 (nmax (length (org-split-string
7155 (buffer-substring (point-at-bol) (point-at-eol))
7156 "|")))
7157 col col1 col2 scol si sc1 sc2)
7158 (cond
7159 ((null list)) ; No action needed if there are no stored formulas
7160 ((eq action 'remove)
7161 (setq col (car columns)
7162 scol (int-to-string col))
7163 (org-table-replace-in-formulas list scol "INVALID")
7164 (if (assoc scol list) (setq list (delq (assoc scol list) list)))
7165 (loop for i from (1+ col) upto nmax by 1 do
7166 (setq si (int-to-string i))
7167 (org-table-replace-in-formulas list si (int-to-string (1- i)))
7168 (if (assoc si list) (setcar (assoc si list)
7169 (int-to-string (1- i))))))
7170 ((eq action 'insert)
7171 (setq col (car columns))
7172 (loop for i from nmax downto col by 1 do
7173 (setq si (int-to-string i))
7174 (org-table-replace-in-formulas list si (int-to-string (1+ i)))
7175 (if (assoc si list) (setcar (assoc si list)
7176 (int-to-string (1+ i))))))
7177 ((eq action 'swap)
7178 (setq col1 (car columns) col2 (nth 1 columns)
7179 sc1 (int-to-string col1) sc2 (int-to-string col2))
7180 ;; Hopefully, ZqZtZ will never be a name in a table
7181 (org-table-replace-in-formulas list sc1 "ZqZtZ")
7182 (org-table-replace-in-formulas list sc2 sc1)
7183 (org-table-replace-in-formulas list "ZqZtZ" sc2)
7184 (if (assoc sc1 list) (setcar (assoc sc1 list) "ZqZtZ"))
7185 (if (assoc sc2 list) (setcar (assoc sc2 list) sc1))
7186 (if (assoc "ZqZtZ" list) (setcar (assoc "ZqZtZ" list) sc2)))
7187 (t (error "Invalid action in `org-table-modify-formulas'")))
7188 (if list (org-table-store-formulas list))))
7190 (defun org-table-replace-in-formulas (list s1 s2)
7191 (let (elt re s)
7192 (setq s1 (concat "$" (if (integerp s1) (int-to-string s1) s1))
7193 s2 (concat "$" (if (integerp s2) (int-to-string s2) s2))
7195 (while (setq elt (pop list))
7196 (setq s (cdr elt))
7197 (while (string-match re s)
7198 (setq s (replace-match s2 t t s)))
7199 (setcdr elt s))))
7201 (defun org-table-get-specials ()
7202 "Get the column names and local parameters for this table."
7203 (save-excursion
7204 (let ((beg (org-table-begin)) (end (org-table-end))
7205 names name fields fields1 field cnt c v line col)
7206 (setq org-table-column-names nil
7207 org-table-local-parameters nil
7208 org-table-named-field-locations nil)
7209 (goto-char beg)
7211 (setq names (org-split-string (match-string 1) " *| *")
7212 cnt 1)
7213 (while (setq name (pop names))
7214 (setq cnt (1+ cnt))
7215 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
7216 (push (cons name (int-to-string cnt)) org-table-column-names))))
7217 (setq org-table-column-names (nreverse org-table-column-names))
7218 (setq org-table-column-name-regexp
7220 (goto-char beg)
7222 (setq fields (org-split-string (match-string 1) " *| *"))
7223 (while (setq field (pop fields))
7225 (push (cons (match-string 1 field) (match-string 2 field))
7226 org-table-local-parameters))))
7227 (goto-char beg)
7229 (setq c (match-string 1)
7230 fields (org-split-string (match-string 2) " *| *"))
7231 (save-excursion
7232 (beginning-of-line (if (equal c "_") 2 0))
7233 (setq line (org-current-line) col 1)
7235 (setq fields1 (org-split-string (match-string 1) " *| *"))))
7236 (while (and fields1 (setq field (pop fields)))
7237 (setq v (pop fields1) col (1+ col))
7238 (when (and (stringp field) (stringp v)
7239 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
7240 (push (cons field v) org-table-local-parameters)
7241 (push (list field line col) org-table-named-field-locations)))))))
7243 (defun org-this-word ()
7244 ;; Get the current word
7245 (save-excursion
7248 (buffer-substring-no-properties beg end))))
7250 (defun org-table-maybe-eval-formula ()
7252 If yes, store the formula and apply it."
7253 ;; We already know we are in a table. Get field will only return a formula
7254 ;; when appropriate. It might return a separator line, but no problem.
7255 (when org-table-formula-evaluate-inline
7256 (let* ((field (org-trim (or (org-table-get-field) "")))
7257 named eq)
7259 (setq named (equal (string-to-char field) ?:)
7260 eq (match-string 1 field))
7261 (if (or (fboundp 'calc-eval)
7262 (equal (substring eq 0 (min 2 (length eq))) "'("))
7263 (org-table-eval-formula (if named '(4) nil) eq)
7264 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
7266 (defvar org-recalc-commands nil
7267 "List of commands triggering the recalculation of a line.
7268 Will be filled automatically during use.")
7270 (defvar org-recalc-marks
7271 '((" " . "Unmarked: no special line, no automatic recalculation")
7272 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
7273 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
7274 ("!" . "Column name definition line. Reference in formula as $name.")
7275 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
7276 ("_" . "Names for values in row below this one.")
7277 ("^" . "Names for values in row above this one.")))
7279 (defun org-table-rotate-recalc-marks (&optional newchar)
7280 "Rotate the recalculation mark in the first column.
7281 If in any row, the first field is not consistent with a mark,
7282 insert a new column for the markers.
7283 When there is an active region, change all the lines in the region,
7284 after prompting for the marking character.
7285 After each change, a message will be displayed indicating the meaning
7286 of the new mark."
7287 (interactive)
7288 (unless (org-at-table-p) (error "Not at a table"))
7289 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
7290 (beg (org-table-begin))
7291 (end (org-table-end))
7292 (l (org-current-line))
7293 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
7294 (l2 (if (org-region-active-p) (org-current-line (region-end))))
7295 (have-col
7296 (save-excursion
7297 (goto-char beg)
7299 (col (org-table-current-column))
7300 (forcenew (car (assoc newchar org-recalc-marks)))
7301 epos new)
7302 (when l1
7303 (message "Change region to what mark? Type # * ! $ or SPC: ")
7304 (setq newchar (char-to-string (read-char-exclusive))
7305 forcenew (car (assoc newchar org-recalc-marks))))
7306 (if (and newchar (not forcenew))
7307 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
7308 newchar))
7309 (if l1 (goto-line l1))
7310 (save-excursion
7311 (beginning-of-line 1)
7312 (unless (looking-at org-table-dataline-regexp)
7313 (error "Not at a table data line")))
7314 (unless have-col
7315 (org-table-goto-column 1)
7316 (org-table-insert-column)
7317 (org-table-goto-column (1+ col)))
7318 (setq epos (point-at-eol))
7319 (save-excursion
7320 (beginning-of-line 1)
7321 (org-table-get-field
7323 (concat " "
7324 (setq new (or forcenew
7325 (cadr (member (match-string 1) marks))))
7326 " ")
7327 " # ")))
7328 (if (and l1 l2)
7329 (progn
7330 (goto-line l1)
7331 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
7332 (and (looking-at org-table-dataline-regexp)
7333 (org-table-get-field 1 (concat " " new " "))))
7334 (goto-line l1)))
7335 (if (not (= epos (point-at-eol))) (org-table-align))
7336 (goto-line l)
7337 (and (interactive-p) (message (cdr (assoc new org-recalc-marks))))))
7339 (defun org-table-maybe-recalculate-line ()
7340 "Recompute the current line if marked for it, and if we haven't just done it."
7341 (interactive)
7342 (and org-table-allow-automatic-line-recalculation
7343 (not (and (memq last-command org-recalc-commands)
7344 (equal org-last-recalc-line (org-current-line))))
7345 (save-excursion (beginning-of-line 1)
7346 (looking-at org-table-auto-recalculate-regexp))
7347 ;; (fboundp 'calc-eval) ;; FIXME: correct to remove this?
7348 (org-table-recalculate) t))
7350 (defvar org-table-formula-debug nil
7351 "Non-nil means, debug table formulas.
7354 (defvar modes)
7355 (defsubst org-set-calc-mode (var &optional value)
7356 (if (stringp var)
7357 (setq var (assoc var '(("D" calc-angle-mode deg)
7358 ("R" calc-angle-mode rad)
7359 ("F" calc-prefer-frac t)
7360 ("S" calc-symbolic-mode t)))
7361 value (nth 2 var) var (nth 1 var)))
7362 (if (memq var modes)
7363 (setcar (cdr (memq var modes)) value)
7364 (cons var (cons value modes)))
7365 modes)
7367 (defun org-table-eval-formula (&optional arg equation
7368 suppress-align suppress-const
7369 suppress-store)
7370 "Replace the table field value at the cursor by the result of a calculation.
7372 This function makes use of Dave Gillespie's Calc package, in my view the
7373 most exciting program ever written for GNU Emacs. So you need to have Calc
7374 installed in order to use this function.
7376 In a table, this command replaces the value in the current field with the
7378 formula, by storing it in a special line below the table. When called
7379 with a `C-u' prefix, the current field must ba a named field, and the
7380 formula is installed as valid in only this specific field.
7382 When called, the command first prompts for a formula, which is read in
7383 the minibuffer. Previously entered formulas are available through the
7384 history list, and the last used formula is offered as a default.
7385 These stored formulas are adapted correctly when moving, inserting, or
7386 deleting columns with the corresponding commands.
7388 The formula can be any algebraic expression understood by the Calc package.
7389 For details, see the Org-mode manual.
7391 This function can also be called from Lisp programs and offers
7392 additional arguments: EQUATION can be the formula to apply. If this
7393 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
7394 used to speed-up recursive calls by by-passing unnecessary aligns.
7395 SUPPRESS-CONST suppresses the interpretation of constants in the
7396 formula, assuming that this has been done already outside the function.
7397 SUPPRESS-STORE means the formula should not be stored, either because
7398 it is already stored, or because it is a modified equation that should
7399 not overwrite the stored one."
7400 (interactive "P")
7401 (org-table-check-inside-data-field)
7402 (org-table-get-specials)
7403 (let* (fields
7404 (ndown (if (integerp arg) arg 1))
7405 (org-table-automatic-realign nil)
7406 (case-fold-search nil)
7407 (down (> ndown 1))
7408 (formula (if (and equation suppress-store)
7409 equation
7410 (org-table-get-formula equation (equal arg '(4)))))
7411 (n0 (org-table-current-column))
7412 (modes (copy-sequence org-calc-default-modes))
7413 n form fmt x ev orig c lispp)
7414 ;; Parse the format string. Since we have a lot of modes, this is
7415 ;; a lot of work. However, I think calc still uses most of the time.
7416 (if (string-match ";" formula)
7417 (let ((tmp (org-split-string formula ";")))
7418 (setq formula (car tmp)
7419 fmt (concat (cdr (assoc "%" org-table-local-parameters))
7420 (nth 1 tmp)))
7422 (setq c (string-to-char (match-string 1 fmt))
7423 n (string-to-number (match-string 2 fmt)))
7424 (if (= c ?p)
7425 (setq modes (org-set-calc-mode 'calc-internal-prec n))
7426 (setq modes (org-set-calc-mode
7427 'calc-float-format
7428 (list (cdr (assoc c '((?n . float) (?f . fix)
7429 (?s . sci) (?e . eng))))
7430 n))))
7431 (setq fmt (replace-match "" t t fmt)))
7432 (while (string-match "[DRFS]" fmt)
7433 (setq modes (org-set-calc-mode (match-string 0 fmt)))
7434 (setq fmt (replace-match "" t t fmt)))
7436 (setq fmt nil))))
7437 (if (and (not suppress-const) org-table-formula-use-constants)
7438 (setq formula (org-table-formula-substitute-names formula)))
7439 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
7440 (while (> ndown 0)
7441 (setq fields (org-split-string
7442 (buffer-substring
7443 (point-at-bol) (point-at-eol)) " *| *"))
7444 (if org-table-formula-numbers-only
7445 (setq fields (mapcar
7446 (lambda (x) (number-to-string (string-to-number x)))
7447 fields)))
7448 (setq ndown (1- ndown))
7449 (setq form (copy-sequence formula)
7450 lispp (equal (substring form 0 2) "'("))
7451 ;; Insert the references to fields in same row
7453 (setq n (if (match-beginning 1)
7454 (string-to-number (match-string 1 form))
7455 n0)
7456 x (nth (1- n) fields))
7458 (match-string 0 form)))
7459 (if (equal x "") (setq x "0"))
7460 (setq form (replace-match
7461 (if lispp x (concat "(" x ")"))
7462 t t form)))
7463 ;; Insert ranges in current column
7465 (setq form (replace-match
7466 (save-match-data
7467 (org-table-get-vertical-vector (match-string 0 form)
7468 nil n0))
7469 t t form)))
7470 (if lispp
7471 (setq ev (eval (eval (read form)))
7472 ev (if (numberp ev) (number-to-string ev) ev))
7473 (or (fboundp 'calc-eval)
7474 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
7475 (setq ev (calc-eval (cons form modes)
7476 (if org-table-formula-numbers-only 'num))))
7478 (when org-table-formula-debug
7479 (with-output-to-temp-buffer "*Help*"
7480 (princ (format "Substitution history of formula
7481 Orig: %s
7482 $xyz-> %s
7484 (if (listp ev)
7486 (make-string (car ev) ?\-) (nth 1 ev)))
7488 ev (or fmt "NONE")
7489 (if fmt (format fmt (string-to-number ev)) ev)))))
7490 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
7491 (unless (and (interactive-p) (not ndown))
7492 (unless (let (inhibit-redisplay)
7493 (y-or-n-p "Debugging Formula. Continue to next? "))
7494 (org-table-align)
7495 (error "Abort"))
7496 (delete-window (get-buffer-window "*Help*"))
7497 (message "")))
7498 (if (listp ev) (setq fmt nil ev "#ERROR"))
7499 (org-table-justify-field-maybe
7500 (if fmt (format fmt (string-to-number ev)) ev))
7502 (call-interactively 'org-return)
7503 (setq ndown 0)))
7504 (and down (org-table-maybe-recalculate-line))
7505 (or suppress-align (and org-table-may-need-update
7506 (org-table-align)))))
7508 (defun org-table-recalculate (&optional all noalign)
7509 "Recalculate the current table line by applying all stored formulas.
7510 With prefix arg ALL, do this for all lines in the table."
7511 (interactive "P")
7512 (or (memq this-command org-recalc-commands)
7513 (setq org-recalc-commands (cons this-command org-recalc-commands)))
7514 (unless (org-at-table-p) (error "Not at a table"))
7515 (org-table-get-specials)
7516 (let* ((eqlist (sort (org-table-get-stored-formulas)
7517 (lambda (a b) (string< (car a) (car b)))))
7518 (inhibit-redisplay t)
7519 (line-re org-table-dataline-regexp)
7520 (thisline (org-current-line))
7521 (thiscol (org-table-current-column))
7522 beg end entry eqlnum eqlname eql (cnt 0) eq a name)
7523 ;; Insert constants in all formulas
7524 (setq eqlist
7525 (mapcar (lambda (x)
7526 (setcdr x (org-table-formula-substitute-names (cdr x)))
7527 x)
7528 eqlist))
7529 ;; Split the equation list
7530 (while (setq eq (pop eqlist))
7531 (if (<= (string-to-char (car eq)) ?9)
7532 (push eq eqlnum)
7533 (push eq eqlname)))
7534 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
7535 (if all
7536 (progn
7537 (setq end (move-marker (make-marker) (1+ (org-table-end))))
7538 (goto-char (setq beg (org-table-begin)))
7539 (if (re-search-forward org-table-calculate-mark-regexp end t)
7540 ;; This is a table with marked lines, only compute selected lines
7541 (setq line-re org-table-recalculate-regexp)
7542 ;; Move forward to the first non-header line
7543 (if (and (re-search-forward org-table-dataline-regexp end t)
7544 (re-search-forward org-table-hline-regexp end t)
7545 (re-search-forward org-table-dataline-regexp end t))
7546 (setq beg (match-beginning 0))
7547 nil))) ;; just leave beg where it is
7548 (setq beg (point-at-bol)
7549 end (move-marker (make-marker) (1+ (point-at-eol)))))
7550 (goto-char beg)
7551 (and all (message "Re-applying formulas to full table..."))
7552 (while (re-search-forward line-re end t)
7553 (unless (string-match "^ *[_^!$] *$" (org-table-get-field 1))
7554 ;; Unprotected line, recalculate
7555 (and all (message "Re-applying formulas to full table...(line %d)"
7556 (setq cnt (1+ cnt))))
7557 (setq org-last-recalc-line (org-current-line))
7558 (setq eql eqlnum)
7559 (while (setq entry (pop eql))
7560 (goto-line org-last-recalc-line)
7561 (org-table-goto-column (string-to-number (car entry)) nil 'force)
7562 (org-table-eval-formula nil (cdr entry) 'noalign 'nocst 'nostore))))
7563 (goto-line thisline)
7564 (org-table-goto-column thiscol)
7565 (or noalign (and org-table-may-need-update (org-table-align))
7566 (and all (message "Re-applying formulas to %d lines...done" cnt)))
7567 ;; Now do the names fields
7568 (while (setq eq (pop eqlname))
7569 (setq name (car eq)
7570 a (assoc name org-table-named-field-locations))
7571 (when a
7572 (message "Re-applying formula to named field: %s" name)
7573 (goto-line (nth 1 a))
7574 (org-table-goto-column (nth 2 a))
7575 (org-table-eval-formula nil (cdr eq) 'noalign 'nocst 'nostore)))
7576 ;; back to initial position
7577 (goto-line thisline)
7578 (org-table-goto-column thiscol)
7579 (or noalign (and org-table-may-need-update (org-table-align))
7580 (and all (message "Re-applying formulas...done")))))
7582 (defun org-table-formula-substitute-names (f)
7583 "Replace $const with values in string F."
7584 (let ((start 0) a n1 n2 nn1 nn2 s (f1 f))
7585 ;; First, check for column names
7586 (while (setq start (string-match org-table-column-name-regexp f start))
7587 (setq start (1+ start))
7588 (setq a (assoc (match-string 1 f) org-table-column-names))
7589 (setq f (replace-match (concat "$" (cdr a)) t t f)))
7590 ;; Expand ranges to vectors
7592 (setq n1 (string-to-number (match-string 1 f))
7593 n2 (string-to-number (match-string 2 f))
7594 nn1 (1+ (min n1 n2)) nn2 (max n1 n2)
7595 s (concat "[($" (number-to-string (1- nn1)) ")"))
7596 (loop for i from nn1 upto nn2 do
7597 (setq s (concat s ",($" (int-to-string i) ")")))
7598 (setq s (concat s "]"))
7599 (if (< n2 n1) (setq s (concat "rev(" s ")")))
7600 (setq f (replace-match s t t f)))
7601 ;; Parameters and constants
7602 (setq start 0)
7604 (setq start (1+ start))
7605 (if (setq a (save-match-data
7606 (org-table-get-constant (match-string 1 f))))
7607 (setq f (replace-match (concat "(" a ")") t t f))))
7608 (if org-table-formula-debug
7609 (put-text-property 0 (length f) :orig-formula f1 f))
7610 f))
7612 (defun org-table-get-constant (const)
7613 "Find the value for a parameter or constant in a formula.
7614 Parameters get priority."
7615 (or (cdr (assoc const org-table-local-parameters))
7616 (cdr (assoc const org-table-formula-constants))
7617 (and (fboundp 'constants-get) (constants-get const))
7618 "#UNDEFINED_NAME"))
7620 (defvar org-edit-formulas-map (make-sparse-keymap))
7621 (define-key org-edit-formulas-map "\C-c\C-c" 'org-finish-edit-formulas)
7622 (define-key org-edit-formulas-map "\C-c\C-q" 'org-abort-edit-formulas)
7623 (define-key org-edit-formulas-map "\C-c?" 'org-show-variable)
7625 (defvar org-pos)
7627 (defun org-table-edit-formulas ()
7628 "Edit the formulas of the current table in a separate buffer."
7629 (interactive)
7630 (unless (org-at-table-p)
7631 (error "Not at a table"))
7632 (org-table-get-specials)
7633 (let ((eql (org-table-get-stored-formulas))
7634 (pos (move-marker (make-marker) (point)))
7635 (wc (current-window-configuration))
7636 entry loc s)
7637 (switch-to-buffer-other-window "*Edit Formulas*")
7638 (erase-buffer)
7639 (fundamental-mode)
7640 (org-set-local 'org-pos pos)
7641 (org-set-local 'org-window-configuration wc)
7642 (use-local-map org-edit-formulas-map)
7643 (setq s "# Edit formulas and finish with `C-c C-c'.
7644 # Use `C-u C-c C-c' to also appy them immediately to the entire table.
7645 # Use `C-c ?' to get information about $name at point.
7647 (put-text-property 0 (length s) 'face 'font-lock-comment-face s)
7648 (insert s)
7649 (while (setq entry (pop eql))
7650 (when (setq loc (assoc (car entry) org-table-named-field-locations))
7652 (nth 2 loc) (nth 1 loc)))
7653 (put-text-property 0 (length s) 'face 'font-lock-comment-face s)
7654 (insert s))
7656 (remove-text-properties 0 (length s) '(face nil) s)
7657 (insert s))
7658 (goto-char (point-min))
7659 (message "Edit formulas and finish with `C-c C-c'.")))
7661 (defun org-show-variable ()
7662 "Show the location/value of the $ expression at point."
7663 (interactive)
7664 (let (var (pos org-pos) (win (selected-window)) e)
7665 (save-excursion
7668 (setq var (match-string 1))
7669 (error "No variable at point")))
7670 (cond
7671 ((setq e (assoc var org-table-named-field-locations))
7672 (switch-to-buffer-other-window (marker-buffer pos))
7673 (goto-line (nth 1 e))
7674 (org-table-goto-column (nth 2 e))
7675 (select-window win)
7676 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
7677 ((setq e (assoc var org-table-column-names))
7678 (switch-to-buffer-other-window (marker-buffer pos))
7679 (goto-char pos)
7680 (goto-char (org-table-begin))
7682 (org-table-end) t)
7683 (progn
7684 (goto-char (match-beginning 1))
7685 (message "Named column (column %s)" (cdr e)))
7686 (error "Column name not found"))
7687 (select-window win))
7688 ((string-match "^[0-9]$" var)
7689 ;; column number
7690 (switch-to-buffer-other-window (marker-buffer pos))
7691 (goto-char pos)
7692 (goto-char (org-table-begin))
7693 (recenter 1)
7694 (if (re-search-forward org-table-dataline-regexp
7695 (org-table-end) t)
7696 (progn
7697 (goto-char (match-beginning 0))
7698 (org-table-goto-column (string-to-number var))
7699 (message "Column %s" var))
7700 (error "Column name not found"))
7701 (select-window win))
7702 ((setq e (assoc var org-table-local-parameters))
7703 (switch-to-buffer-other-window (marker-buffer pos))
7704 (goto-char pos)
7705 (goto-char (org-table-begin))
7707 (progn
7708 (goto-char (match-beginning 1))
7709 (message "Local parameter."))
7710 (error "Parameter not found"))
7711 (select-window win))
7712 (t
7713 (cond
7714 ((setq e (assoc var org-table-formula-constants))
7715 (message "Constant: $%s=%s in `org-table-formula-constants'." var (cdr e)))
7716 ((setq e (and (fboundp 'constants-get) (constants-get var)))
7717 (message "Constant: $%s=%s, retrieved from `constants.el'." var e))
7718 (t (error "Undefined name $%s" var)))))))
7720 (defun org-finish-edit-formulas (&optional arg)
7721 "Parse the buffer for formula definitions and install them.
7722 With prefix ARG, apply the new formulas to the table."
7723 (interactive "P")
7724 (let ((pos org-pos) eql)
7725 (goto-char (point-min))
7727 (push (cons (match-string 1) (match-string 2)) eql))
7728 (set-window-configuration org-window-configuration)
7729 (select-window (get-buffer-window (marker-buffer pos)))
7730 (goto-char pos)
7731 (unless (org-at-table-p)
7732 (error "Lost table position - cannot install formulae"))
7733 (org-table-store-formulas eql)
7734 (move-marker pos nil)
7735 (kill-buffer "*Edit Formulas*")
7736 (if arg
7737 (org-table-recalculate 'all)
7738 (message "New formulas installed - press C-u C-c C-c to apply."))))
7740 (defun org-abort-edit-formulas ()
7741 "Abort editing formulas, without installing the changes."
7742 (interactive)
7743 (let ((pos org-pos))
7744 (set-window-configuration org-window-configuration)
7745 (select-window (get-buffer-window (marker-buffer pos)))
7746 (goto-char pos)
7747 (message "Formula editing aborted without installing changes")))
7749 ;;; The orgtbl minor mode
7751 ;; Define a minor mode which can be used in other modes in order to
7752 ;; integrate the org-mode table editor.
7754 ;; This is really a hack, because the org-mode table editor uses several
7755 ;; keys which normally belong to the major mode, for example the TAB and
7756 ;; RET keys. Here is how it works: The minor mode defines all the keys
7757 ;; necessary to operate the table editor, but wraps the commands into a
7758 ;; function which tests if the cursor is currently inside a table. If that
7759 ;; is the case, the table editor command is executed. However, when any of
7760 ;; those keys is used outside a table, the function uses `key-binding' to
7761 ;; look up if the key has an associated command in another currently active
7762 ;; keymap (minor modes, major mode, global), and executes that command.
7763 ;; There might be problems if any of the keys used by the table editor is
7764 ;; otherwise used as a prefix key.
7766 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7767 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7768 ;; addresses this by checking explicitly for both bindings.
7770 ;; The optimized version (see variable `orgtbl-optimized') takes over
7771 ;; all keys which are bound to `self-insert-command' in the *global map*.
7772 ;; Some modes bind other commands to simple characters, for example
7773 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
7774 ;; active, this binding is ignored inside tables and replaced with a
7775 ;; modified self-insert.
7777 (defvar orgtbl-mode nil
7778 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
7779 table editor in arbitrary modes.")
7780 (make-variable-buffer-local 'orgtbl-mode)
7782 (defvar orgtbl-mode-map (make-keymap)
7783 "Keymap for `orgtbl-mode'.")
7785 ;;;###autoload
7786 (defun turn-on-orgtbl ()
7787 "Unconditionally turn on `orgtbl-mode'."
7788 (orgtbl-mode 1))
7790 (defvar org-old-auto-fill-inhibit-regexp nil
7791 "Local variable used by `orgtbl-mode'")
7793 ;;;###autoload
7794 (defun orgtbl-mode (&optional arg)
7795 "The `org-mode' table editor as a minor mode for use in other modes."
7796 (interactive)
7797 (if (org-mode-p)
7798 ;; Exit without error, in case some hook functions calls this
7799 ;; by accident in org-mode.
7800 (message "Orgtbl-mode is not useful in org-mode, command ignored")
7801 (setq orgtbl-mode
7802 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
7803 (if orgtbl-mode
7804 (progn
7805 (and (orgtbl-setup) (defun orgtbl-setup () nil))
7806 ;; Make sure we are first in minor-mode-map-alist
7807 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
7808 (and c (setq minor-mode-map-alist
7809 (cons c (delq c minor-mode-map-alist)))))
7810 (org-set-local (quote org-table-may-need-update) t)
7811 (org-add-hook 'before-change-functions 'org-before-change-function
7812 nil 'local)
7813 (org-set-local 'org-old-auto-fill-inhibit-regexp
7814 auto-fill-inhibit-regexp)
7815 (org-set-local 'auto-fill-inhibit-regexp
7816 (if auto-fill-inhibit-regexp
7819 (org-add-to-invisibility-spec '(org-cwidth))
7820 (easy-menu-add orgtbl-mode-menu)
7821 (run-hooks 'orgtbl-mode-hook))
7822 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
7823 (org-cleanup-narrow-column-properties)
7824 (org-remove-from-invisibility-spec '(org-cwidth))
7825 (remove-hook 'before-change-functions 'org-before-change-function t)
7826 (easy-menu-remove orgtbl-mode-menu)
7827 (force-mode-line-update 'all))))
7829 (defun org-cleanup-narrow-column-properties ()
7830 "Remove all properties related to narrow-column invisibility."
7831 (let ((s 1))
7832 (while (setq s (text-property-any s (point-max)
7833 'display org-narrow-column-arrow))
7834 (remove-text-properties s (1+ s) '(display t)))
7835 (setq s 1)
7836 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
7837 (remove-text-properties s (1+ s) '(org-cwidth t)))
7838 (setq s 1)
7839 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
7840 (remove-text-properties s (1+ s) '(invisible t)))))
7842 ;; Install it as a minor mode.
7843 (put 'orgtbl-mode :included t)
7844 (put 'orgtbl-mode :menu-tag "Org Table Mode")
7845 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
7847 (defun orgtbl-make-binding (fun n &rest keys)
7848 "Create a function for binding in the table minor mode.
7849 FUN is the command to call inside a table. N is used to create a unique
7850 command name. KEYS are keys that should be checked in for a command
7851 to execute outside of tables."
7852 (eval
7853 (list 'defun
7854 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
7855 '(arg)
7857 "Outside of tables, run the binding of `"
7858 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7859 "'.")
7860 '(interactive "p")
7861 (list 'if
7862 '(org-at-table-p)
7863 (list 'call-interactively (list 'quote fun))
7864 (list 'let '(orgtbl-mode)
7865 (list 'call-interactively
7866 (append '(or)
7867 (mapcar (lambda (k)
7868 (list 'key-binding k))
7869 keys)
7870 '('orgtbl-error))))))))
7872 (defun orgtbl-error ()
7873 "Error when there is no default binding for a table key."
7874 (interactive)
7875 (error "This key is has no function outside tables"))
7877 (defun orgtbl-setup ()
7878 "Setup orgtbl keymaps."
7879 (let ((nfunc 0)
7880 (bindings
7881 (list
7882 '([(meta shift left)] org-table-delete-column)
7883 '([(meta left)] org-table-move-column-left)
7884 '([(meta right)] org-table-move-column-right)
7885 '([(meta shift right)] org-table-insert-column)
7886 '([(meta shift up)] org-table-kill-row)
7887 '([(meta shift down)] org-table-insert-row)
7888 '([(meta up)] org-table-move-row-up)
7889 '([(meta down)] org-table-move-row-down)
7890 '("\C-c\C-w" org-table-cut-region)
7891 '("\C-c\M-w" org-table-copy-region)
7892 '("\C-c\C-y" org-table-paste-rectangle)
7893 '("\C-c-" org-table-insert-hline)
7894 ; '([(shift tab)] org-table-previous-field)
7895 '("\C-m" org-table-next-row)
7896 (list (org-key 'S-return) 'org-table-copy-down)
7897 '([(meta return)] org-table-wrap-region)
7898 '("\C-c\C-q" org-table-wrap-region)
7899 '("\C-c?" org-table-current-column)
7900 '("\C-c " org-table-blank-field)
7901 '("\C-c+" org-table-sum)
7902 '("\C-c=" org-table-eval-formula)
7903 '("\C-c'" org-table-edit-formulas)
7904 '("\C-c`" org-table-edit-field)
7905 '("\C-c*" org-table-recalculate)
7906 '("\C-c|" org-table-create-or-convert-from-region)
7907 '("\C-c^" org-table-sort-lines)
7908 '([(control ?#)] org-table-rotate-recalc-marks)))
7909 elt key fun cmd)
7910 (while (setq elt (pop bindings))
7911 (setq nfunc (1+ nfunc))
7912 (setq key (car elt)
7913 fun (nth 1 elt)
7914 cmd (orgtbl-make-binding fun nfunc key))
7915 (define-key orgtbl-mode-map key cmd))
7916 ;; Special treatment needed for TAB and RET
7917 (define-key orgtbl-mode-map [(return)]
7918 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
7919 (define-key orgtbl-mode-map "\C-m"
7920 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
7921 (define-key orgtbl-mode-map [(tab)]
7922 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
7923 (define-key orgtbl-mode-map "\C-i"
7924 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)])))
7925 (define-key orgtbl-mode-map "\C-i"
7926 (orgtbl-make-binding 'orgtbl-tab 104 [(shift tab)]))
7927 (define-key orgtbl-mode-map "\C-c\C-c"
7928 (orgtbl-make-binding 'org-ctrl-c-ctrl-c 105 "\C-c\C-c"))
7929 (when orgtbl-optimized
7930 ;; If the user wants maximum table support, we need to hijack
7931 ;; some standard editing functions
7932 (org-remap orgtbl-mode-map
7933 'self-insert-command 'orgtbl-self-insert-command
7934 'delete-char 'org-delete-char
7935 'delete-backward-char 'org-delete-backward-char)
7936 (define-key orgtbl-mode-map "|" 'org-force-self-insert))
7937 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
7938 '("OrgTbl"
7939 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
7940 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
7941 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
7942 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
7943 "--"
7944 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
7945 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
7946 ["Copy Field from Above"
7947 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
7948 "--"
7949 ("Column"
7950 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
7951 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
7952 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
7953 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"]
7954 "--"
7955 ["Enable Narrowing" (setq org-table-limit-column-width (not org-table-limit-column-width)) :active (org-at-table-p) :selected org-table-limit-column-width :style toggle])
7956 ("Row"
7957 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
7958 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
7959 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
7960 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
7961 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
7962 "--"
7963 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
7964 ("Rectangle"
7965 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
7966 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
7967 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
7968 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
7969 "--"
7970 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
7971 ["Set Named Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
7972 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
7973 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
7974 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
7975 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
7976 ["Sum Column/Rectangle" org-table-sum
7977 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
7978 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
7979 ["Debug Formulas"
7980 (setq org-table-formula-debug (not org-table-formula-debug))
7981 :style toggle :selected org-table-formula-debug]
7982 ))
7983 t)
7985 (defun orgtbl-tab (arg)
7986 "Justification and field motion for `orgtbl-mode'."
7987 (interactive "P")
7988 (if arg (org-table-edit-field t)
7989 (org-table-justify-field-maybe)
7990 (org-table-next-field)))
7992 (defun orgtbl-ret ()
7993 "Justification and field motion for `orgtbl-mode'."
7994 (interactive)
7995 (org-table-justify-field-maybe)
7996 (org-table-next-row))
7998 (defun orgtbl-self-insert-command (N)
7999 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
8000 If the cursor is in a table looking at whitespace, the whitespace is
8001 overwritten, and the table is not marked as requiring realignment."
8002 (interactive "p")
8003 (if (and (org-at-table-p)
8004 (or
8005 (and org-table-auto-blank-field
8006 (member last-command
8007 '(orgtbl-hijacker-command-100
8008 orgtbl-hijacker-command-101
8009 orgtbl-hijacker-command-102
8010 orgtbl-hijacker-command-103
8011 orgtbl-hijacker-command-104
8012 orgtbl-hijacker-command-105))
8013 (org-table-blank-field))
8014 t)
8015 (eq N 1)
8017 (let (org-table-may-need-update)
8018 (goto-char (1- (match-end 0)))
8019 (delete-backward-char 1)
8020 (goto-char (match-beginning 0))
8021 (self-insert-command N))
8022 (setq org-table-may-need-update t)
8023 (let (orgtbl-mode)
8024 (call-interactively (key-binding (vector last-input-event))))))
8026 (defun org-force-self-insert (N)
8027 "Needed to enforce self-insert under remapping."
8028 (interactive "p")
8029 (self-insert-command N))
8031 ;;;; Link Stuff
8033 ;;; Link abbreviations
8035 (defun org-link-expand-abbrev (link)
8036 "Apply replacements as defined in `org-link-abbrev-alist."
8038 (let* ((key (match-string 1 link))
8039 (as (or (assoc key org-link-abbrev-alist-local)
8040 (assoc key org-link-abbrev-alist)))
8041 (tag (and (match-end 2) (match-string 3 link)))
8042 rpl)
8043 (if (not as)
8044 link
8045 (setq rpl (cdr as))
8046 (cond
8047 ((symbolp rpl) (funcall rpl tag))
8048 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8049 (t (concat rpl tag)))))
8050 link))
8052 ;;; Storing and inserting links
8054 (defvar org-insert-link-history nil
8055 "Minibuffer history for links inserted with `org-insert-link'.")
8057 (defvar org-stored-links nil
8058 "Contains the links stored with `org-store-link'.")
8060 ;;;###autoload
8061 (defun org-store-link (arg)
8063 This link can later be inserted into an org-buffer with
8065 For some link types, a prefix arg is interpreted:
8066 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
8067 For file links, arg negates `org-context-in-file-links'."
8068 (interactive "P")
8069 (let (link cpltxt desc description search txt (pos (point)))
8070 (cond
8072 ((eq major-mode 'bbdb-mode)
8073 (setq cpltxt (concat
8074 "bbdb:"
8075 (or (bbdb-record-name (bbdb-current-record))
8076 (bbdb-record-company (bbdb-current-record))))
8077 link (org-make-link cpltxt)))
8079 ((eq major-mode 'Info-mode)
8080 (setq link (org-make-link "info:"
8081 (file-name-nondirectory Info-current-file)
8082 ":" Info-current-node))
8083 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
8084 ":" Info-current-node)))
8086 ((eq major-mode 'calendar-mode)
8087 (let ((cd (calendar-cursor-to-date)))
8088 (setq link
8089 (format-time-string
8090 (car org-time-stamp-formats)
8091 (apply 'encode-time
8092 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8093 nil nil nil))))))
8095 ((or (eq major-mode 'vm-summary-mode)
8096 (eq major-mode 'vm-presentation-mode))
8097 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
8098 (vm-follow-summary-cursor)
8099 (save-excursion
8100 (vm-select-folder-buffer)
8101 (let* ((message (car vm-message-pointer))
8102 (folder buffer-file-name)
8103 (subject (vm-su-subject message))
8104 (author (vm-su-full-name message))
8105 (message-id (vm-su-message-id message)))
8106 (setq message-id (org-remove-angle-brackets message-id))
8107 (setq folder (abbreviate-file-name folder))
8108 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
8109 folder)
8110 (setq folder (replace-match "" t t folder)))
8111 (setq cpltxt (concat author " on: " subject))
8112 (setq link (org-make-link "vm:" folder "#" message-id)))))
8114 ((eq major-mode 'wl-summary-mode)
8115 (let* ((msgnum (wl-summary-message-number))
8116 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
8117 msgnum 'message-id))
8118 (wl-message-entity
8119 (if (fboundp 'elmo-message-entity)
8120 (elmo-message-entity
8121 wl-summary-buffer-elmo-folder msgnum)
8122 (elmo-msgdb-overview-get-entity
8123 msgnum (wl-summary-buffer-msgdb))))
8124 ;; FIXME: How to get author and subject in wl???
8125 (author (wl-summary-line-from)) ; ?
8126 (subject "???"))
8127 (setq message-id (org-remove-angle-brackets message-id))
8128 (setq cpltxt (concat author " on: " subject))
8129 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
8130 "#" message-id))))
8132 ((or (equal major-mode 'mh-folder-mode)
8133 (equal major-mode 'mh-show-mode))
8134 (let ((from-header (org-mhe-get-header "From:"))
8135 (to-header (org-mhe-get-header "To:"))
8136 (subject (org-mhe-get-header "Subject:")))
8137 (setq cpltxt (concat from-header " on: " subject))
8138 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
8139 (org-remove-angle-brackets
8140 (org-mhe-get-header "Message-Id:"))))))
8142 ((eq major-mode 'rmail-mode)
8143 (save-excursion
8144 (save-restriction
8145 (rmail-narrow-to-non-pruned-header)
8146 (let ((folder buffer-file-name)
8147 (message-id (mail-fetch-field "message-id"))
8148 (author (mail-fetch-field "from"))
8149 (subject (mail-fetch-field "subject")))
8150 (setq message-id (org-remove-angle-brackets message-id))
8151 (setq cpltxt (concat author " on: " subject))
8152 (setq link (org-make-link "rmail:" folder "#" message-id))))))
8154 ((eq major-mode 'gnus-group-mode)
8155 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
8156 (gnus-group-group-name)) ; version
8157 ((fboundp 'gnus-group-name)
8158 (gnus-group-name))
8159 (t "???"))))
8160 (setq cpltxt (concat
8161 (if (org-xor arg org-usenet-links-prefer-google)
8162 "http://groups.google.com/groups?group="
8163 "gnus:")
8164 group)
8165 link (org-make-link cpltxt))))
8167 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
8168 (require 'gnus-sum) ; FIXME: I don't think this is needed, actually
8169 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
8170 (gnus-summary-beginning-of-article)
8171 (let* ((group (car gnus-article-current))
8172 (article (cdr gnus-article-current))
8173 (header (gnus-summary-article-header article))
8174 (author (mail-header-from header))
8175 (message-id (mail-header-id header))
8176 (date (mail-header-date header))
8177 (subject (gnus-summary-subject-string)))
8178 (setq cpltxt (concat author " on: " subject))
8179 (if (org-xor arg org-usenet-links-prefer-google)
8180 (setq link
8181 (concat
8183 (format "http://groups.google.com/groups?as_umsgid=%s"
8184 (org-fixup-message-id-for-http message-id))))
8185 (setq link (org-make-link "gnus:" group
8186 "#" (number-to-string article))))))
8188 ((eq major-mode 'w3-mode)
8189 (setq cpltxt (url-view-url t)
8190 link (org-make-link cpltxt)))
8191 ((eq major-mode 'w3m-mode)
8192 (setq cpltxt (or w3m-current-title w3m-current-url)
8193 link (org-make-link w3m-current-url)))
8195 ((setq search (run-hook-with-args-until-success
8196 'org-create-file-search-functions))
8197 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8198 "::" search))
8199 (setq cpltxt (or description link)))
8201 ((eq major-mode 'image-mode)
8202 (setq cpltxt (concat "file:"
8203 (abbreviate-file-name buffer-file-name))
8204 link (org-make-link cpltxt)))
8206 ((eq major-mode 'dired-mode)
8207 ;; link to the file in the current line
8208 (setq cpltxt (concat "file:"
8209 (abbreviate-file-name
8210 (expand-file-name
8211 (dired-get-filename nil t))))
8212 link (org-make-link cpltxt)))
8214 ((and buffer-file-name (org-mode-p))
8215 ;; Just link to current headline
8216 (setq cpltxt (concat "file:"
8217 (abbreviate-file-name buffer-file-name)))
8218 ;; Add a context search string
8219 (when (org-xor org-context-in-file-links arg)
8220 ;; Check if we are on a target
8221 (if (save-excursion
8223 (and (re-search-backward "<<" nil t)
8225 (<= (match-beginning 0) pos)
8226 (>= (match-end 0) pos)))
8227 (setq cpltxt (concat cpltxt "::" (match-string 1)))
8228 (setq txt (cond
8229 ((org-on-heading-p) nil)
8230 ((org-region-active-p)
8231 (buffer-substring (region-beginning) (region-end)))
8232 (t (buffer-substring (point-at-bol) (point-at-eol)))))
8234 (setq cpltxt
8235 (concat cpltxt "::"
8236 (if org-file-link-context-use-camel-case
8237 (org-make-org-heading-camel txt)
8238 (org-make-org-heading-search-string txt)))
8239 desc "NONE"))))
8241 (setq cpltxt (substring cpltxt 0 -2)))
8242 (setq link (org-make-link cpltxt)))
8244 (buffer-file-name
8245 ;; Just link to this file here.
8246 (setq cpltxt (concat "file:"
8247 (abbreviate-file-name buffer-file-name)))
8248 ;; Add a context string
8249 (when (org-xor org-context-in-file-links arg)
8250 (setq txt (if (org-region-active-p)
8251 (buffer-substring (region-beginning) (region-end))
8252 (buffer-substring (point-at-bol) (point-at-eol))))
8253 ;; Only use search option if there is some text.
8255 (setq cpltxt
8256 (concat cpltxt "::"
8257 (if org-file-link-context-use-camel-case
8258 (org-make-org-heading-camel txt)
8259 (org-make-org-heading-search-string txt)))
8260 desc "NONE")))
8261 (setq link (org-make-link cpltxt)))
8263 ((interactive-p)
8264 (error "Cannot link to a buffer which is not visiting a file"))
8266 (t (setq link nil)))
8268 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8269 (setq link (or link cpltxt)
8270 desc (or desc cpltxt))
8271 (if (equal desc "NONE") (setq desc nil))
8273 (if (and (interactive-p) link)
8274 (progn
8275 (setq org-stored-links
8276 (cons (list cpltxt link desc) org-stored-links))
8277 (message "Stored: %s" (or cpltxt link)))
8278 (org-make-link-string link desc))))
8280 (defun org-make-org-heading-search-string (&optional string heading)
8281 "Make search string for STRING or current headline."
8282 (interactive)
8283 (let ((s (or string (org-get-heading))))
8284 (unless (and string (not heading))
8285 ;; We are using a headline, clean up garbage in there.
8286 (if (string-match org-todo-regexp s)
8287 (setq s (replace-match "" t t s)))
8289 (setq s (replace-match "" t t s)))
8290 (setq s (org-trim s))
8293 (setq s (replace-match "" t t s)))
8294 (while (string-match org-ts-regexp s)
8295 (setq s (replace-match "" t t s))))
8297 (setq s (replace-match " " t t s)))
8298 (or string (setq s (concat "*" s))) ; Add * for headlines
8301 (defun org-make-org-heading-camel (&optional string heading)
8302 "Make a CamelCase string for STRING or the current headline."
8303 (interactive)
8304 (let ((s (or string (org-get-heading))))
8305 (unless (and string (not heading))
8306 ;; We are using a headline, clean up garbage in there.
8307 (if (string-match org-todo-regexp s)
8308 (setq s (replace-match "" t t s)))
8310 (setq s (replace-match "" t t s)))
8311 (setq s (org-trim s))
8314 (setq s (replace-match "" t t s)))
8315 (while (string-match org-ts-regexp s)
8316 (setq s (replace-match "" t t s))))
8318 (setq s (replace-match " " t t s)))
8319 (or string (setq s (concat "*" s))) ; Add * for headlines
8322 (defun org-make-link (&rest strings)
8323 "Concatenate STRINGS, format resulting string with `org-link-format'."
8324 (format org-link-format (apply 'concat strings)))
8326 (defun org-make-link-string (link &optional description)
8327 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8328 (if (eq org-link-style 'plain)
8329 (if (equal description link)
8330 link
8332 (when (stringp description)
8333 ;; Remove brackets from the description, they are fatal.
8335 (setq description (replace-match "" t t description))))
8336 (when (equal (org-link-escape link) description)
8337 ;; No description needed, it is identical
8338 (setq description nil))
8339 (when (and (not description)
8340 (not (equal link (org-link-escape link))))
8341 (setq description link))
8342 (concat "[[" (org-link-escape link) "]"
8343 (if description (concat "[" description "]") "")
8344 "]")))
8346 (defconst org-link-escape-chars '(("[" . "%5B") ("]" . "%5D") (" " . "%20"))
8347 "Association list of escapes for some characters problematic in links.")
8349 (defun org-link-escape (text)
8350 "Escape charaters in TEXT that are problematic for links."
8351 (when text
8352 (let ((re (mapconcat (lambda (x) (regexp-quote (car x)))
8354 (while (string-match re text)
8355 (setq text
8356 (replace-match
8357 (cdr (assoc (match-string 0 text) org-link-escape-chars))
8358 t t text)))
8359 text)))
8361 (defun org-link-unescape (text)
8362 "Reverse the action of `org-link-escape'."
8363 (when text
8364 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
8366 (while (string-match re text)
8367 (setq text
8368 (replace-match
8369 (car (rassoc (match-string 0 text) org-link-escape-chars))
8370 t t text)))
8371 text)))
8373 (defun org-xor (a b)
8374 "Exclusive or."
8375 (if a (not b) b))
8377 (defun org-get-header (header)
8378 "Find a header field in the current buffer."
8379 (save-excursion
8380 (goto-char (point-min))
8381 (let ((case-fold-search t) s)
8382 (cond
8383 ((eq header 'from)
8385 (setq s (match-string 1)))
8387 (setq s (replace-match "" t t s)))
8388 (if (string-match "[<(].*" s)
8389 (setq s (replace-match "" t t s))))
8390 ((eq header 'message-id)
8392 (setq s (match-string 1))))
8393 ((eq header 'subject)
8395 (setq s (match-string 1)))))
8398 s)))
8401 (defun org-fixup-message-id-for-http (s)
8402 "Replace special characters in a message id, so it can be used in an http query."
8403 (while (string-match "<" s)
8404 (setq s (replace-match "%3C" t t s)))
8405 (while (string-match ">" s)
8406 (setq s (replace-match "%3E" t t s)))
8407 (while (string-match "@" s)
8408 (setq s (replace-match "%40" t t s)))
8409 s)
8411 (defun org-insert-link (&optional complete-file)
8412 "Insert a link. At the prompt, enter the link.
8414 Completion can be used to select a link previously stored with
8415 `org-store-link'. When the empty string is entered (i.e. if you just
8416 press RET at the prompt), the link defaults to the most recently
8417 stored link. As SPC triggers completion in the minibuffer, you need to
8418 use M-SPC or C-q SPC to force the insertion of a space character.
8420 You will also be prompted for a description, and if one is given, it will
8421 be displayed in the buffer instead of the link.
8423 If there is already a link at point, this command will allow you to edit link
8424 and description parts.
8427 selected using completion. The path to the file will be relative to
8428 the current directory if the file is in the current directory or a
8429 subdirectory. Otherwise, the link will be the absolute path as
8430 completed in the minibuffer (i.e. normally ~/path/to/file).
8433 is in the current directory or below.
8435 `org-keep-stored-link-after-insertion'."
8436 (interactive "P")
8437 (let (link desc entry remove file (pos (point)))
8438 (cond
8439 ((save-excursion
8442 (looking-at org-bracket-link-regexp)
8443 (<= (match-beginning 0) pos)
8444 (>= (match-end 0) pos)))
8445 ;; We do have a link at point, and we are going to edit it.
8446 (setq remove (list (match-beginning 0) (match-end 0)))
8447 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8448 (setq link (read-string "Link: "
8449 (org-link-unescape
8450 (org-match-string-no-properties 1)))))
8451 ((equal complete-file '(4))
8452 ;; Completing read for file names.
8453 (setq file (read-file-name "File: "))
8454 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8455 (pwd1 (file-name-as-directory (abbreviate-file-name
8456 (expand-file-name ".")))))
8457 (cond
8458 ((equal complete-file '(16))
8459 (setq link (org-make-link
8460 "file:"
8461 (abbreviate-file-name (expand-file-name file)))))
8463 (setq link (org-make-link "file:" (match-string 1 file))))
8465 (expand-file-name file))
8466 (setq link (org-make-link
8467 "file:" (match-string 1 (expand-file-name file)))))
8468 (t (setq link (org-make-link "file:" file))))))
8469 (t
8470 ;; Read link, with completion for stored links.
8471 (setq link (org-completing-read
8472 "Link: " org-stored-links nil nil nil
8473 org-insert-link-history
8474 (or (car (car org-stored-links)))))
8475 (setq entry (assoc link org-stored-links))
8476 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8477 (not org-keep-stored-link-after-insertion))
8478 (setq org-stored-links (delq (assoc link org-stored-links)
8479 org-stored-links)))
8480 (setq link (if entry (nth 1 entry) link)
8481 desc (or desc (nth 2 entry)))))
8483 (if (string-match org-plain-link-re link)
8484 ;; URL-like link, normalize the use of angular brackets.
8485 (setq link (org-make-link (org-remove-angle-brackets link))))
8487 ;; Check if we are linking to the current file with a search option
8488 ;; If yes, simplify the link by using only the search option.
8489 (when (and buffer-file-name
8491 (let* ((path (match-string 1 link))
8492 (case-fold-search nil)
8493 (search (match-string 2 link)))
8494 (save-match-data
8495 (if (equal (file-truename buffer-file-name) (file-truename path))
8496 ;; We are linking to this same file, with a search option
8497 (setq link search)))))
8499 ;; Check if we can/should use a relative path. If yes, simplify the link
8501 (let* ((path (match-string 1 link))
8502 (case-fold-search nil))
8503 (cond
8504 ((eq org-link-file-path-type 'absolute)
8505 (setq path (abbreviate-file-name (expand-file-name path))))
8506 ((eq org-link-file-path-type 'noabbrev)
8507 (setq path (expand-file-name path)))
8508 ((eq org-link-file-path-type 'relative)
8509 (setq path (file-relative-name path)))
8510 (t
8511 (save-match-data
8512 (if (string-match (concat "^" (regexp-quote
8513 (file-name-as-directory
8514 (expand-file-name "."))))
8515 (expand-file-name path))
8516 ;; We are linking a file with relative path name.
8517 (setq path (substring (expand-file-name path)
8518 (match-end 0)))))))
8519 (setq link (concat "file:" path))))
8521 (setq desc (read-string "Description: " desc))
8523 (if remove (apply 'delete-region remove))
8524 (insert (org-make-link-string link desc))))
8526 (defun org-completing-read (&rest args)
8527 (let ((minibuffer-local-completion-map
8528 (copy-keymap minibuffer-local-completion-map)))
8529 (define-key minibuffer-local-completion-map " " 'self-insert-command)
8530 (apply 'completing-read args)))
8532 ;;; Opening/following a link
8534 (defun org-find-file-at-mouse (ev)
8535 "Open file link or URL at mouse."
8536 (interactive "e")
8537 (mouse-set-point ev)
8538 (org-open-at-point 'in-emacs))
8540 (defun org-open-at-mouse (ev)
8541 "Open file link or URL at mouse."
8542 (interactive "e")
8543 (mouse-set-point ev)
8544 (org-open-at-point))
8546 (defvar org-window-config-before-follow-link nil
8547 "The window configuration before following a link.
8548 This is saved in case the need arises to restore it.")
8550 ;; FIXME: IN-EMACS is used for many purposes, maybe rename this argument???
8551 (defun org-open-at-point (&optional in-emacs)
8552 "Open link at or after point.
8553 If there is no link at point, this function will search forward up to
8554 the end of the current subtree.
8555 Normally, files will be opened by an appropriate application. If the
8556 optional argument IN-EMACS is non-nil, Emacs will visit the file."
8557 (interactive "P")
8558 (setq org-window-config-before-follow-link (current-window-configuration))
8559 (org-remove-occur-highlights nil nil t)
8560 (if (org-at-timestamp-p t)
8561 (org-follow-timestamp-link)
8562 (let (type path link line search (pos (point)))
8563 (catch 'match
8564 (save-excursion
8567 (looking-at org-bracket-link-regexp)
8568 (<= (match-beginning 0) pos)
8569 (>= (match-end 0) pos))
8570 (setq link (org-link-unescape (org-match-string-no-properties 1)))
8572 (setq link (replace-match " " t t link)))
8573 (setq link (org-link-expand-abbrev link))
8574 (if (string-match org-link-re-with-space2 link)
8575 (setq type (match-string 1 link)
8576 path (match-string 2 link))
8577 (setq type "thisfile"
8578 path link))
8579 (throw 'match t)))
8581 (when (get-text-property (point) 'org-linked-text)
8582 (setq type "thisfile"
8583 pos (if (get-text-property (1+ (point)) 'org-linked-text)
8584 (1+ (point)) (point))
8585 path (buffer-substring
8586 (previous-single-property-change pos 'org-linked-text)
8587 (next-single-property-change pos 'org-linked-text)))
8588 (throw 'match t))
8590 (save-excursion
8591 (skip-chars-backward (concat "^[]" org-non-link-chars " "))
8592 (if (equal (char-before) ?<) (backward-char 1))
8593 (when (or (looking-at org-angle-link-re)
8594 (looking-at org-plain-link-re)
8595 (and (or (re-search-forward org-angle-link-re (point-at-eol) t)
8596 (re-search-forward org-plain-link-re (point-at-eol) t))
8597 (<= (match-beginning 0) pos)
8598 (>= (match-end 0) pos)))
8599 (setq type (match-string 1)
8600 path (match-string 2))
8601 (throw 'match t)))
8602 (save-excursion
8605 (setq type "tags"
8606 path (match-string 1))
8607 (while (string-match ":" path)
8608 (setq path (replace-match "+" t t path)))
8609 (throw 'match t)))
8610 (save-excursion
8611 (skip-chars-backward "a-zA-Z_")
8612 (when (and (memq 'camel org-activate-links)
8613 (looking-at org-camel-regexp))
8614 (setq type "camel" path (match-string 0))
8615 (if (equal (char-before) ?*)
8616 (setq path (concat "*" path))))
8617 (throw 'match t)))
8618 (unless path
8619 (error "No link found"))
8620 ;; Remove any trailing spaces in path
8622 (setq path (replace-match "" t t path)))
8624 (cond
8626 ((equal type "mailto")
8627 (let ((cmd (car org-link-mailto-program))
8628 (args (cdr org-link-mailto-program)) args1
8629 (address path) (subject "") a)
8631 (setq address (match-string 1 path)
8632 subject (org-link-escape (match-string 2 path))))
8633 (while args
8634 (cond
8635 ((not (stringp (car args))) (push (pop args) args1))
8636 (t (setq a (pop args))
8637 (if (string-match "%a" a)
8638 (setq a (replace-match address t t a)))
8639 (if (string-match "%s" a)
8640 (setq a (replace-match subject t t a)))
8641 (push a args1))))
8642 (apply cmd (nreverse args1))))
8644 ((member type '("http" "https" "ftp" "news"))
8645 (browse-url (concat type ":" path)))
8647 ((string= type "tags")
8648 (org-tags-view in-emacs path))
8649 ((or (string= type "camel")
8650 (string= type "thisfile"))
8651 (if in-emacs
8652 (switch-to-buffer-other-window
8653 (org-get-buffer-for-internal-link (current-buffer)))
8654 (org-mark-ring-push))
8655 (org-link-search
8656 path
8657 (cond ((equal in-emacs '(4)) 'occur)
8658 ((equal in-emacs '(16)) 'org-occur)
8659 (t nil))))
8661 ((string= type "file")
8663 (setq line (string-to-number (match-string 1 path))
8664 path (substring path 0 (match-beginning 0)))
8666 (setq search (match-string 1 path)
8667 path (substring path 0 (match-beginning 0)))))
8668 (org-open-file path in-emacs line search))
8670 ((string= type "news")
8671 (org-follow-gnus-link path))
8673 ((string= type "bbdb")
8674 (org-follow-bbdb-link path))
8676 ((string= type "info")
8677 (org-follow-info-link path))
8679 ((string= type "gnus")
8680 (let (group article)
8682 (error "Error in Gnus link"))
8683 (setq group (match-string 1 path)
8684 article (match-string 3 path))
8685 (org-follow-gnus-link group article)))
8687 ((string= type "vm")
8688 (let (folder article)
8690 (error "Error in VM link"))
8691 (setq folder (match-string 1 path)
8692 article (match-string 3 path))
8693 ;; in-emacs is the prefix arg, will be interpreted as read-only
8694 (org-follow-vm-link folder article in-emacs)))
8696 ((string= type "wl")
8697 (let (folder article)
8699 (error "Error in Wanderlust link"))
8700 (setq folder (match-string 1 path)
8701 article (match-string 3 path))
8702 (org-follow-wl-link folder article)))
8704 ((string= type "mhe")
8705 (let (folder article)
8707 (error "Error in MHE link"))
8708 (setq folder (match-string 1 path)
8709 article (match-string 3 path))
8710 (org-follow-mhe-link folder article)))
8712 ((string= type "rmail")
8713 (let (folder article)
8715 (error "Error in RMAIL link"))
8716 (setq folder (match-string 1 path)
8717 article (match-string 3 path))
8718 (org-follow-rmail-link folder article)))
8720 ((string= type "shell")
8721 (let ((cmd path))
8722 ;; FIXME: the following is only for backward compatibility
8723 (while (string-match "@{" cmd) (setq cmd (replace-match "<" t t cmd)))
8724 (while (string-match "@}" cmd) (setq cmd (replace-match ">" t t cmd)))
8725 (if (or (not org-confirm-shell-link-function)
8726 (funcall org-confirm-shell-link-function
8728 (org-add-props cmd nil
8729 'face 'org-warning))))
8730 (progn
8731 (message "Executing %s" cmd)
8732 (shell-command cmd))
8733 (error "Abort"))))
8735 ((string= type "elisp")
8736 (let ((cmd path))
8737 (if (or (not org-confirm-elisp-link-function)
8738 (funcall org-confirm-elisp-link-function
8740 (org-add-props cmd nil
8741 'face 'org-warning))))
8742 (message "%s => %s" cmd (eval (read cmd)))
8743 (error "Abort"))))
8745 (t
8746 (browse-url-at-point))))))
8748 ;;; File search
8750 (defvar org-create-file-search-functions nil
8751 "List of functions to construct the right search string for a file link.
8752 These functions are called in turn with point at the location to
8753 which the link should point.
8755 A function in the hook should first test if it would like to
8756 handle this file type, for example by checking the major-mode or
8757 the file extension. If it decides not to handle this file, it
8758 should just return nil to give other functions a chance. If it
8759 does handle the file, it must return the search string to be used
8760 when following the link. The search string will be part of the
8761 file link, given after a double colon, and `org-open-at-point'
8762 will automatically search for it. If special measures must be
8763 taken to make the search successful, another function should be
8764 added to the companion hook `org-execute-file-search-functions',
8765 which see.
8767 A function in this hook may also use `setq' to set the variable
8768 `description' to provide a suggestion for the descriptive text to
8769 be used for this link when it gets inserted into an Org-mode
8772 (defvar org-execute-file-search-functions nil
8773 "List of functions to execute a file search triggered by a link.
8775 Functions added to this hook must accept a single argument, the
8776 search string that was part of the file link, the part after the
8777 double colon. The function must first check if it would like to
8778 handle this search, for example by checking the major-mode or the
8779 file extension. If it decides not to handle this search, it
8780 should just return nil to give other functions a chance. If it
8781 does handle the search, it must return a non-nil value to keep
8782 other functions from trying.
8784 Each function can access the current prefix argument through the
8785 variable `current-prefix-argument'. Note that a single prefix is
8786 used to force opening a link in Emacs, so it may be good to only
8787 use a numeric or double prefix to guide the search function.
8789 In case this is needed, a function in this hook can also restore
8790 the window configuration before `org-open-at-point' was called using:
8792 (set-window-configuration org-window-config-before-follow-link)")
8794 (defun org-link-search (s &optional type)
8795 "Search for a link search option.
8796 When S is a CamelCaseWord, search for a target, or for a sentence containing
8797 the words. If S is surrounded by forward slashes, it is interpreted as a
8798 regular expression. In org-mode files, this will create an `org-occur'
8799 sparse tree. In ordinary files, `occur' will be used to list matches.
8800 If the current buffer is in `dired-mode', grep will be used to search
8801 in all files."
8802 (let ((case-fold-search t)
8804 (pos (point))
8805 (pre "") (post "")
8806 words re0 re1 re2 re3 re4 re5 re2a reall camel)
8807 (cond
8808 ;; First check if there are any special
8809 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
8810 ;; Now try the builtin stuff
8811 ((save-excursion
8812 (goto-char (point-min))
8813 (and
8814 (re-search-forward
8815 (concat "<<" (regexp-quote s0) ">>") nil t)
8816 (setq pos (match-beginning 0))))
8817 ;; There is an exact target for this
8818 (goto-char pos))
8820 ;; A regular expression
8821 (cond
8822 ((org-mode-p)
8823 (org-occur (match-string 1 s)))
8824 ;;((eq major-mode 'dired-mode)
8825 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
8826 (t (org-do-occur (match-string 1 s)))))
8827 ((or (setq camel (string-match (concat "^" org-camel-regexp "$") s))
8828 t)
8829 ;; A camel or a normal search string
8830 (when (equal (string-to-char s) ?*)
8831 ;; Anchor on headlines, post may include tags.
8834 s (substring s 1)))
8835 (remove-text-properties
8836 0 (length s)
8837 '(face nil mouse-face nil keymap nil fontified nil) s)
8838 ;; Make a series of regular expressions to find a match
8839 (setq words
8840 (if camel
8841 (org-camel-to-words s)
8847 re1 (concat pre re2 post)
8848 re3 (concat pre re4 post)
8849 re5 (concat pre ".*" re4)
8850 re2 (concat pre re2)
8851 re2a (concat pre re2a)
8852 re4 (concat pre re4)
8856 ))
8857 (cond
8858 ((eq type 'org-occur) (org-occur reall))
8859 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
8860 (t (goto-char (point-min))
8861 (if (or (org-search-not-link re0 nil t)
8862 (org-search-not-link re1 nil t)
8863 (org-search-not-link re2 nil t)
8864 (org-search-not-link re2a nil t)
8865 (org-search-not-link re3 nil t)
8866 (org-search-not-link re4 nil t)
8867 (org-search-not-link re5 nil t)
8868 )
8869 (goto-char (match-beginning 1))
8870 (goto-char pos)
8871 (error "No match")))))
8872 (t
8873 ;; Normal string-search
8874 (goto-char (point-min))
8875 (if (search-forward s nil t)
8876 (goto-char (match-beginning 0))
8877 (error "No match"))))
8878 (and (org-mode-p) (org-show-context 'link-search))))
8880 (defun org-search-not-link (&rest args)
8881 "Execute `re-search-forward', but only accept matches that are not a link."
8882 (catch 'exit
8883 (let (p1)
8884 (while (apply 're-search-forward args)
8885 (setq p1 (point))
8886 (if (not (save-match-data
8888 (looking-at org-bracket-link-regexp)
8889 (<= (match-beginning 0) p1)
8890 (>= (match-end 0) p1))))
8891 (progn (goto-char (match-end 0))
8892 (throw 'exit (point)))
8893 (goto-char (match-end 0)))))))
8895 (defun org-get-buffer-for-internal-link (buffer)
8896 "Return a buffer to be used for displaying the link target of internal links."
8897 (cond
8898 ((not org-display-internal-link-with-indirect-buffer)
8899 buffer)
8900 ((string-match "(Clone)$" (buffer-name buffer))
8901 (message "Buffer is already a clone, not making another one")
8902 ;; we also do not modify visibility in this case
8903 buffer)
8904 (t ; make a new indirect buffer for displaying the link
8905 (let* ((bn (buffer-name buffer))
8906 (ibn (concat bn "(Clone)"))
8907 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
8908 (with-current-buffer ib (org-overview))
8909 ib))))
8911 (defun org-do-occur (regexp &optional cleanup)
8912 "Call the Emacs command `occur'.
8913 If CLEANUP is non-nil, remove the printout of the regular expression
8914 in the *Occur* buffer. This is useful if the regex is long and not useful
8915 to read."
8916 (occur regexp)
8917 (when cleanup
8918 (let ((cwin (selected-window)) win beg end)
8919 (when (setq win (get-buffer-window "*Occur*"))
8920 (select-window win))
8921 (goto-char (point-min))
8922 (when (re-search-forward "match[a-z]+" nil t)
8923 (setq beg (match-end 0))
8925 (setq end (1- (match-beginning 0)))))
8926 (and beg end (let ((buffer-read-only)) (delete-region beg end)))
8927 (goto-char (point-min))
8928 (select-window cwin))))
8930 ;;; The mark ring for links jumps
8932 (defvar org-mark-ring nil
8933 "Mark ring for positions before jumps in Org-mode.")
8934 (defvar org-mark-ring-last-goto nil
8935 "Last position in the mark ring used to go back.")
8936 ;; Fill and close the ring
8937 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
8938 (loop for i from 1 to org-mark-ring-length do
8939 (push (make-marker) org-mark-ring))
8940 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
8941 org-mark-ring)
8943 (defun org-mark-ring-push (&optional pos buffer)
8944 "Put the current position or POS into the mark ring and rotate it."
8945 (interactive)
8946 (setq pos (or pos (point)))
8947 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
8948 (move-marker (car org-mark-ring)
8949 (or pos (point))
8950 (or buffer (current-buffer)))
8951 (message
8952 (substitute-command-keys
8955 (defun org-mark-ring-goto (&optional n)
8956 "Jump to the previous position in the mark ring.
8957 With prefix arg N, jump back that many stored positions. When
8958 called several times in succession, walk through the entire ring.
8959 Org-mode commands jumping to a different position in the current file,
8960 or to another Org-mode file, automatically push the old position
8961 onto the ring."
8962 (interactive "p")
8963 (let (p m)
8964 (if (eq last-command this-command)
8965 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
8966 (setq p org-mark-ring))
8967 (setq org-mark-ring-last-goto p)
8968 (setq m (car p))
8969 (switch-to-buffer (marker-buffer m))
8970 (goto-char m)
8971 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
8973 (defun org-camel-to-words (s)
8975 (let ((case-fold-search nil)
8976 words)
8977 (while (string-match "[a-z][A-Z]" s)
8978 (push (substring s 0 (1+ (match-beginning 0))) words)
8979 (setq s (substring s (1+ (match-beginning 0)))))
8980 (nreverse (cons s words))))
8982 (defun org-remove-angle-brackets (s)
8983 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
8984 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
8985 s)
8986 (defun org-add-angle-brackets (s)
8987 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
8988 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
8989 s)
8991 ;;; Following specific links
8993 (defun org-follow-timestamp-link ()
8994 (cond
8995 ((org-at-date-range-p t)
8996 (let ((org-agenda-start-on-weekday)
8997 (t1 (match-string 1))
8998 (t2 (match-string 2)))
8999 (setq t1 (time-to-days (org-time-string-to-time t1))
9000 t2 (time-to-days (org-time-string-to-time t2)))
9001 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9002 ((org-at-timestamp-p t)
9003 (org-agenda-list nil (time-to-days (org-time-string-to-time
9004 (substring (match-string 1) 0 10)))
9005 1))
9006 (t (error "This should not happen"))))
9009 (defun org-follow-bbdb-link (name)
9010 "Follow a BBDB link to NAME."
9011 (require 'bbdb)
9012 (let ((inhibit-redisplay t)
9013 (bbdb-electric-p nil))
9014 (catch 'exit
9015 ;; Exact match on name
9017 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
9018 ;; Exact match on name
9020 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
9021 ;; Partial match on name
9022 (bbdb-name name nil)
9023 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
9024 ;; Partial match on company
9025 (bbdb-company name nil)
9026 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
9027 ;; General match including network address and notes
9028 (bbdb name nil)
9029 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
9030 (delete-window (get-buffer-window "*BBDB*"))
9031 (error "No matching BBDB record")))))
9033 (defun org-follow-info-link (name)
9034 "Follow an info file & node link to NAME."
9037 (progn
9038 (require 'info)
9039 (if (match-string 2 name) ; If there isn't a node, choose "Top"
9040 (Info-find-node (match-string 1 name) (match-string 2 name))
9041 (Info-find-node (match-string 1 name) "Top")))
9042 (message (concat "Could not open: " name))))
9044 (defun org-follow-gnus-link (&optional group article)
9045 "Follow a Gnus link to GROUP and ARTICLE."
9046 (require 'gnus)
9047 (funcall (cdr (assq 'gnus org-link-frame-setup)))
9048 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
9049 (if group (gnus-fetch-group group))
9050 (if article
9051 (or (gnus-summary-goto-article article nil 'force)
9052 (if (fboundp 'gnus-summary-insert-cached-articles)
9053 (progn
9054 (gnus-summary-insert-cached-articles)
9055 (gnus-summary-goto-article article nil 'force))
9056 (message "Message could not be found.")))))
9058 (defun org-follow-vm-link (&optional folder article readonly)
9059 "Follow a VM link to FOLDER and ARTICLE."
9060 (require 'vm)
9061 (setq article (org-add-angle-brackets article))
9063 ;; ange-ftp or efs or tramp access
9064 (let ((user (or (match-string 1 folder) (user-login-name)))
9065 (host (match-string 2 folder))
9066 (file (match-string 3 folder)))
9067 (cond
9068 ((featurep 'tramp)
9069 ;; use tramp to access the file
9070 (if (featurep 'xemacs)
9071 (setq folder (format "[%s@%s]%s" user host file))
9072 (setq folder (format "/%s@%s:%s" user host file))))
9073 (t
9074 ;; use ange-ftp or efs
9075 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
9076 (setq folder (format "/%s@%s:%s" user host file))))))
9077 (when folder
9078 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
9079 (sit-for 0.1)
9080 (when article
9081 (vm-select-folder-buffer)
9082 (widen)
9083 (let ((case-fold-search t))
9084 (goto-char (point-min))
9085 (if (not (re-search-forward
9086 (concat "^" "message-id: *" (regexp-quote article))))
9087 (error "Could not find the specified message in this folder"))
9088 (vm-isearch-update)
9089 (vm-isearch-narrow)
9090 (vm-beginning-of-message)
9091 (vm-summarize)))))
9093 (defun org-follow-wl-link (folder article)
9094 "Follow a Wanderlust link to FOLDER and ARTICLE."
9095 (setq article (org-add-angle-brackets article))
9096 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
9097 (if article (wl-summary-jump-to-msg-by-message-id article))
9098 (wl-summary-redisplay))
9100 (defun org-follow-rmail-link (folder article)
9101 "Follow an RMAIL link to FOLDER and ARTICLE."
9102 (setq article (org-add-angle-brackets article))
9103 (let (message-number)
9104 (save-excursion
9105 (save-window-excursion
9106 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
9107 (setq message-number
9108 (save-restriction
9109 (widen)
9110 (goto-char (point-max))
9111 (if (re-search-backward
9113 (or article "")))
9114 nil t)
9115 (rmail-what-message))))))
9116 (if message-number
9117 (progn
9118 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
9119 (rmail-show-message message-number)
9120 message-number)
9121 (error "Message not found"))))
9123 ;;; mh-e integration based on planner-mode
9124 (defun org-mhe-get-message-real-folder ()
9125 "Return the name of the current message real folder, so if you use
9126 sequences, it will now work."
9127 (save-excursion
9128 (let* ((folder
9129 (if (equal major-mode 'mh-folder-mode)
9130 mh-current-folder
9131 ;; Refer to the show buffer
9132 mh-show-folder-buffer))
9133 (end-index
9134 (if (boundp 'mh-index-folder)
9135 (min (length mh-index-folder) (length folder))))
9136 )
9137 ;; a simple test on mh-index-data does not work, because
9138 ;; mh-index-data is always nil in a show buffer.
9139 (if (and (boundp 'mh-index-folder)
9140 (string= mh-index-folder (substring folder 0 end-index)))
9141 (if (equal major-mode 'mh-show-mode)
9142 (save-window-excursion
9143 (when (buffer-live-p (get-buffer folder))
9144 (progn
9145 (pop-to-buffer folder)
9146 (org-mhe-get-message-folder-from-index)
9147 )
9148 ))
9149 (org-mhe-get-message-folder-from-index)
9150 )
9151 folder
9152 )
9153 )))
9155 (defun org-mhe-get-message-folder-from-index ()
9156 "Returns the name of the message folder in a index folder buffer."
9157 (save-excursion
9158 (mh-index-previous-folder)
9160 (message (match-string 1))))
9162 (defun org-mhe-get-message-folder ()
9163 "Return the name of the current message folder. Be careful if you
9164 use sequences."
9165 (save-excursion
9166 (if (equal major-mode 'mh-folder-mode)
9167 mh-current-folder
9168 ;; Refer to the show buffer
9169 mh-show-folder-buffer)))
9171 (defun org-mhe-get-message-num ()
9172 "Return the number of the current message. Be careful if you
9173 use sequences."
9174 (save-excursion
9175 (if (equal major-mode 'mh-folder-mode)
9176 (mh-get-msg-num nil)
9177 ;; Refer to the show buffer
9178 (mh-show-buffer-message-number))))
9180 (defun org-mhe-get-header (header)
9181 "Return a header of the message in folder mode. This will create a
9182 show buffer for the corresponding message. If you have a more clever
9183 idea..."
9184 (let* ((folder (org-mhe-get-message-folder))
9185 (num (org-mhe-get-message-num))
9186 (buffer (get-buffer-create (concat "show-" folder)))
9187 (header-field))
9188 (with-current-buffer buffer
9189 (mh-display-msg num folder)
9190 (if (equal major-mode 'mh-folder-mode)
9191 (mh-header-display)
9192 (mh-show-header-display))
9193 (set-buffer buffer)
9194 (setq header-field (mh-get-header-field header))
9195 (if (equal major-mode 'mh-folder-mode)
9196 (mh-show)
9197 (mh-show-show))
9198 header-field)))
9200 (defun org-follow-mhe-link (folder article)
9201 "Follow an MHE link to FOLDER and ARTICLE.
9202 If ARTICLE is nil FOLDER is shown. If the configuration variable
9203 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
9204 ARTICLE is searched in all folders. Indexed searches (swish++,
9205 namazu, and others supported by MH-E) will always search in all
9206 folders."
9207 (require 'mh-e)
9208 (require 'mh-search)
9209 (require 'mh-utils)
9210 (mh-find-path)
9211 (if (not article)
9212 (mh-visit-folder (mh-normalize-folder-name folder))
9213 (setq article (org-add-angle-brackets article))
9214 (mh-search-choose)
9215 (if (equal mh-searcher 'pick)
9216 (progn
9217 (mh-search folder (list "--message-id" article))
9218 (when (and org-mhe-search-all-folders
9219 (not (org-mhe-get-message-real-folder)))
9220 (kill-this-buffer)
9221 (mh-search "+" (list "--message-id" article))))
9222 (mh-search "+" article))
9223 (if (org-mhe-get-message-real-folder)
9224 (mh-show-msg 1)
9225 (kill-this-buffer)
9226 (error "Message not found"))))
9228 ;;; BibTeX links
9230 ;; Use the custom search meachnism to construct and use search strings for
9231 ;; file links to BibTeX database entries.
9233 (defun org-create-file-search-in-bibtex ()
9234 "Create the search string and description for a BibTeX database entry."
9235 (when (eq major-mode 'bibtex-mode)
9236 ;; yes, we want to construct this search string.
9237 ;; Make a good description for this entry, using names, year and the title
9238 ;; Put it into the `description' variable which is dynamically scoped.
9239 (let ((bibtex-autokey-names 1)
9240 (bibtex-autokey-names-stretch 1)
9241 (bibtex-autokey-name-case-convert-function 'identity)
9242 (bibtex-autokey-name-separator " & ")
9243 (bibtex-autokey-additional-names " et al.")
9244 (bibtex-autokey-year-length 4)
9245 (bibtex-autokey-name-year-separator " ")
9246 (bibtex-autokey-titlewords 3)
9247 (bibtex-autokey-titleword-separator " ")
9248 (bibtex-autokey-titleword-case-convert-function 'identity)
9249 (bibtex-autokey-titleword-length 'infty)
9250 (bibtex-autokey-year-title-separator ": "))
9251 (setq description (bibtex-generate-autokey)))
9252 ;; Now parse the entry, get the key and return it.
9253 (save-excursion
9254 (bibtex-beginning-of-entry)
9255 (cdr (assoc "=key=" (bibtex-parse-entry))))))
9257 (defun org-execute-file-search-in-bibtex (s)
9258 "Find the link search string S as a key for a database entry."
9259 (when (eq major-mode 'bibtex-mode)
9260 ;; Yes, we want to do the search in this file.
9261 ;; We construct a regexp that searches for "@entrytype{" followed by the key
9262 (goto-char (point-min))
9265 (goto-char (match-beginning 0)))
9266 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
9267 ;; Use double prefix to indicate that any web link should be browsed
9268 (let ((b (current-buffer)) (p (point)))
9269 ;; Restore the window configuration because we just use the web link
9270 (set-window-configuration org-window-config-before-follow-link)
9271 (save-excursion (set-buffer b) (goto-char p)
9272 (bibtex-url)))
9273 (recenter 0)) ; Move entry start to beginning of window
9274 ;; return t to indicate that the search is done.
9275 t))
9277 ;; Finally add the functions to the right hooks.
9278 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
9279 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
9281 ;; end of Bibtex link setup
9283 ;;; Following file links
9285 (defun org-open-file (path &optional in-emacs line search)
9286 "Open the file at PATH.
9287 First, this expands any special file name abbreviations. Then the
9288 configuration variable `org-file-apps' is checked if it contains an
9289 entry for this file type, and if yes, the corresponding command is launched.
9290 If no application is found, Emacs simply visits the file.
9291 With optional argument IN-EMACS, Emacs will visit the file.
9292 Optional LINE specifies a line to go to, optional SEARCH a string to
9293 search for. If LINE or SEARCH is given, the file will always be
9294 opened in Emacs.
9295 If the file does not exist, an error is thrown."
9296 (setq in-emacs (or in-emacs line search))
9297 (let* ((file (if (equal path "")
9298 buffer-file-name
9299 (substitute-in-file-name (expand-file-name path))))
9300 (apps (append org-file-apps (org-default-apps)))
9301 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9302 (dirp (if remp nil (file-directory-p file)))
9303 (dfile (downcase file))
9304 (old-buffer (current-buffer))
9305 (old-pos (point))
9306 (old-mode major-mode)
9307 ext cmd)
9309 (setq ext (match-string 1 dfile))
9311 (setq ext (match-string 1 dfile))))
9312 (if in-emacs
9313 (setq cmd 'emacs)
9314 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9315 (and dirp (cdr (assoc 'directory apps)))
9316 (cdr (assoc ext apps))
9317 (cdr (assoc t apps)))))
9318 (when (eq cmd 'mailcap)
9319 (require 'mailcap)
9320 (mailcap-parse-mailcaps)
9321 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9322 (command (mailcap-mime-info mime-type)))
9323 (if (stringp command)
9324 (setq cmd command)
9325 (setq cmd 'emacs))))
9326 (if (and (not (eq cmd 'emacs)) ; Emacs has not problems with non-ex files
9327 (not (file-exists-p file))
9328 (not org-open-non-existing-files))
9329 (error "No such file: %s" file))
9330 (cond
9332 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9334 (setq cmd (replace-match "%s" t t cmd)))
9335 (setq cmd (format cmd (shell-quote-argument file)))
9336 (save-window-excursion
9337 (shell-command (concat cmd " &"))))
9338 ((or (stringp cmd)
9339 (eq cmd 'emacs))
9340 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9341 (if line (goto-line line)
9342 (if search (org-link-search search))))
9343 ((consp cmd)
9344 (eval cmd))
9345 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9346 (and (org-mode-p) (eq old-mode 'org-mode)
9347 (or (not (equal old-buffer (current-buffer)))
9348 (not (equal old-pos (point))))
9349 (org-mark-ring-push old-pos old-buffer))))
9351 (defun org-default-apps ()
9352 "Return the default applications for this operating system."
9353 (cond
9354 ((eq system-type 'darwin)
9355 org-file-apps-defaults-macosx)
9356 ((eq system-type 'windows-nt)
9357 org-file-apps-defaults-windowsnt)
9358 (t org-file-apps-defaults-gnu)))
9360 (defun org-expand-file-name (path)
9361 "Replace special path abbreviations and expand the file name."
9362 (expand-file-name path))
9364 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9365 (defun org-file-remote-p (file)
9366 "Test whether FILE specifies a location on a remote system.
9367 Return non-nil if the location is indeed remote.
9371 (cond ((fboundp 'file-remote-p)
9372 (file-remote-p file))
9373 ((fboundp 'tramp-handle-file-remote-p)
9374 (tramp-handle-file-remote-p file))
9375 ((and (boundp 'ange-ftp-name-format)
9376 (string-match (car ange-ftp-name-format) file))
9377 t)
9378 (t nil)))
9381 ;;;; Hooks for remember.el
9383 ;;;###autoload
9384 (defun org-remember-annotation ()
9385 "Return a link to the current location as an annotation for remember.el.
9386 If you are using Org-mode files as target for data storage with
9387 remember.el, then the annotations should include a link compatible with the
9388 conventions in Org-mode. This function returns such a link."
9389 (org-store-link nil))
9391 (defconst org-remember-help
9392 "Select a destination location for the note.
9393 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
9394 RET at beg-of-buf -> Append to file as level 2 headline
9395 RET on headline -> Store as sublevel entry to current headline
9396 <left>/<right> -> before/after current headline, same headings level")
9398 ;;;###autoload
9399 (defun org-remember-apply-template ()
9400 "Initialize *remember* buffer with template, invoke `org-mode'.
9401 This function should be placed into `remember-mode-hook' and in fact requires
9402 to be run from that hook to fucntion properly."
9403 (if org-remember-templates
9405 (let* ((entry (if (= (length org-remember-templates) 1)
9406 (cdar org-remember-templates)
9407 (message "Select template: %s"
9408 (mapconcat
9409 (lambda (x) (char-to-string (car x)))
9410 org-remember-templates " "))
9411 (cdr (assoc (read-char-exclusive) org-remember-templates))))
9412 (tpl (car entry))
9413 (file (if (consp (cdr entry)) (nth 1 entry)))
9414 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
9415 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
9416 (v-u (concat "[" (substring v-t 1 -1) "]"))
9417 (v-U (concat "[" (substring v-T 1 -1) "]"))
9418 (v-a annotation) ; defined in `remember-mode'
9419 (v-i initial) ; defined in `remember-mode'
9420 (v-n user-full-name)
9421 )
9422 (unless tpl (setq tpl "") (message "No template") (ding))
9423 (insert tpl) (goto-char (point-min))
9425 (when (and initial (equal (match-string 0) "%i"))
9426 (save-match-data
9427 (let* ((lead (buffer-substring
9428 (point-at-bol) (match-beginning 0))))
9429 (setq v-i (mapconcat 'identity
9432 (replace-match
9433 (or (eval (intern (concat "v-" (match-string 1)))) "")
9434 t t))
9435 (let ((org-startup-folded nil)
9436 (org-startup-with-deadline-check nil))
9437 (org-mode))
9439 (org-set-local 'org-default-notes-file file))
9440 (goto-char (point-min))
9442 (let ((org-startup-folded nil)
9443 (org-startup-with-deadline-check nil))
9444 (org-mode)))
9445 (org-set-local 'org-finish-function 'remember-buffer))
9447 ;;;###autoload
9448 (defun org-remember-handler ()
9449 "Store stuff from remember.el into an org file.
9450 First prompts for an org file. If the user just presses return, the value
9451 of `org-default-notes-file' is used.
9452 Then the command offers the headings tree of the selected file in order to
9453 file the text at a specific location.
9454 You can either immediately press RET to get the note appended to the
9455 file, or you can use vertical cursor motion and visibility cycling (TAB) to
9456 find a better place. Then press RET or <left> or <right> in insert the note.
9458 Key Cursor position Note gets inserted
9459 -----------------------------------------------------------------------------
9460 RET buffer-start as level 2 heading at end of file
9461 RET on headline as sublevel of the heading at cursor
9462 RET no heading at cursor position, level taken from context.
9463 Or use prefix arg to specify level manually.
9464 <left> on headline as same level, before current heading
9465 <right> on headline as same level, after current heading
9467 So the fastest way to store the note is to press RET RET to append it to
9468 the default file. This way your current train of thought is not
9469 interrupted, in accordance with the principles of remember.el. But with
9470 little extra effort, you can push it directly to the correct location.
9472 Before being stored away, the function ensures that the text has a
9474 is constructed from the current date and some additional data.
9476 If the variable `org-adapt-indentation' is non-nil, the entire text is
9477 also indented so that it starts in the same column as the headline
9478 \(i.e. after the stars).
9480 See also the variable `org-reverse-note-order'."
9481 (catch 'quit
9482 (let* ((txt (buffer-substring (point-min) (point-max)))
9483 (fastp current-prefix-arg)
9484 (file (if fastp org-default-notes-file (org-get-org-file)))
9485 (visiting (find-buffer-visiting file))
9486 (org-startup-with-deadline-check nil)
9487 (org-startup-folded nil)
9488 (org-startup-align-all-tables nil)
9489 spos level indent reversed)
9490 ;; Modify text so that it becomes a nice subtree which can be inserted
9491 ;; into an org tree.
9493 first)
9494 ;; remove empty lines at the beginning
9496 (setq lines (cdr lines)))
9497 (setq first (car lines) lines (cdr lines))
9499 ;; Is already a headline
9500 (setq indent nil)
9501 ;; We need to add a headline: Use time and first buffer line
9502 (setq lines (cons first lines)
9503 first (concat "* " (current-time-string)
9504 " (" (remember-buffer-desc) ")")
9505 indent " "))
9506 (if (and org-adapt-indentation indent)
9507 (setq lines (mapcar (lambda (x) (concat indent x)) lines)))
9510 ;; Find the file
9511 (if (not visiting)
9512 (find-file-noselect file))
9513 (with-current-buffer (get-file-buffer file)
9514 (save-excursion (and (goto-char (point-min))
9517 (setq reversed (org-notes-order-reversed-p))
9518 (save-excursion
9519 (save-restriction
9520 (widen)
9521 ;; Ask the User for a location
9522 (setq spos (if fastp 1 (org-get-location
9523 (current-buffer)
9524 org-remember-help)))
9525 (if (not spos) (throw 'quit nil)) ; return nil to show we did
9526 ; not handle this note
9527 (goto-char spos)
9528 (cond ((and (bobp) (not reversed))
9529 ;; Put it at the end, as level 2
9530 (save-restriction
9531 (widen)
9532 (goto-char (point-max))
9533 (if (not (bolp)) (newline))
9534 (org-paste-subtree 2 txt)))
9535 ((and (bobp) reversed)
9536 ;; Put it at the start, as level 1
9537 (save-restriction
9538 (widen)
9539 (goto-char (point-min))
9541 (beginning-of-line 1)
9542 (org-paste-subtree 1 txt)))
9543 ((and (org-on-heading-p nil) (not current-prefix-arg))
9544 ;; Put it below this entry, at the beg/end of the subtree
9545 (org-back-to-heading)
9546 (setq level (funcall outline-level))
9547 (if reversed
9548 (outline-end-of-heading)
9549 (outline-end-of-subtree))
9550 (if (not (bolp)) (newline))
9551 (beginning-of-line 1)
9552 (org-paste-subtree (org-get-legal-level level 1) txt))
9553 (t
9554 ;; Put it right there, with automatic level determined by
9555 ;; org-paste-subtree or from prefix arg
9556 (org-paste-subtree current-prefix-arg txt)))
9557 (when remember-save-after-remembering
9558 (save-buffer)
9559 (if (not visiting) (kill-buffer (current-buffer)))))))))
9560 t) ;; return t to indicate that we took care of this note.
9562 (defun org-get-org-file ()
9563 "Read a filename, with default directory `org-directory'."
9564 (let ((default (or org-default-notes-file remember-data-file)))
9565 (read-file-name (format "File name [%s]: " default)
9566 (file-name-as-directory org-directory)
9567 default)))
9569 (defun org-notes-order-reversed-p ()
9570 "Check if the current file should receive notes in reversed order."
9571 (cond
9572 ((not org-reverse-note-order) nil)
9573 ((eq t org-reverse-note-order) t)
9574 ((not (listp org-reverse-note-order)) nil)
9575 (t (catch 'exit
9576 (let ((all org-reverse-note-order)
9577 entry)
9578 (while (setq entry (pop all))
9579 (if (string-match (car entry) buffer-file-name)
9580 (throw 'exit (cdr entry))))
9581 nil)))))
9583 ;;;; Dynamic blocks
9585 (defun org-find-dblock (name)
9586 "Find the first dynamic block with name NAME in the buffer.
9587 If not found, stay at current position and return nil."
9588 (let (pos)
9589 (save-excursion
9590 (goto-char (point-min))
9592 nil t)
9593 (match-beginning 0))))
9594 (if pos (goto-char pos))
9595 pos))
9597 (defconst org-dblock-start-re
9599 "Matches the startline of a dynamic block, with parameters.")
9602 "Matches the end of a dyhamic block.")
9604 (defun org-create-dblock (plist)
9605 "Create a dynamic block section, with parameters taken from PLIST.
9606 PLIST must containe a :name entry which is used as name of the block."
9607 (unless (bolp) (newline))
9608 (let ((name (plist-get plist :name)))
9609 (insert "#+BEGIN: " name)
9610 (while plist
9611 (if (eq (car plist) :name)
9612 (setq plist (cddr plist))
9613 (insert " " (prin1-to-string (pop plist)))))
9615 (beginning-of-line -2)))
9617 (defun org-prepare-dblock ()
9618 "Prepare dynamic block for refresh.
9619 This empties the block, puts the cursor at the insert position and returns
9620 the property list including an extra property :name with the block name."
9621 (unless (looking-at org-dblock-start-re)
9622 (error "Not at a dynamic block"))
9623 (let* ((begdel (1+ (match-end 0)))
9624 (name (match-string 1))
9625 (params (append (list :name name)
9626 (read (concat "(" (match-string 3) ")")))))
9627 (unless (re-search-forward org-dblock-end-re nil t)
9628 (error "Dynamic block not terminated"))
9629 (delete-region begdel (match-beginning 0))
9630 (goto-char begdel)
9631 (open-line 1)
9632 params))
9634 (defun org-map-dblocks (&optional command)
9635 "Apply COMMAND to all dynamic blocks in the current buffer.
9636 If COMMAND is not given, use `org-update-dblock'."
9637 (let ((cmd (or command 'org-update-dblock))
9638 pos)
9639 (save-excursion
9640 (goto-char (point-min))
9641 (while (re-search-forward org-dblock-start-re nil t)
9642 (goto-char (setq pos (match-beginning 0)))
9643 (condition-case nil
9644 (funcall cmd)
9645 (error (message "Error during update of dynamic block")))
9646 (goto-char pos)
9647 (unless (re-search-forward org-dblock-end-re nil t)
9648 (error "Dynamic block not terminated"))))))
9650 (defun org-dblock-update (&optional arg)
9651 "User command for updating dynamic blocks.
9652 Update the dynamic block at point. With prefix ARG, update all dynamic
9653 blocks in the buffer."
9654 (interactive "P")
9655 (if arg
9656 (org-update-all-dblocks)
9657 (or (looking-at org-dblock-start-re)
9658 (org-beginning-of-dblock))
9659 (org-update-dblock)))
9661 (defun org-update-dblock ()
9662 "Update the dynamic block at point
9663 This means to empty the block, parse for parameters and then call
9664 the correct writing function."
9665 (let* ((pos (point))
9666 (params (org-prepare-dblock))
9667 (name (plist-get params :name))
9668 (cmd (intern (concat "org-dblock-write:" name))))
9669 (funcall cmd params)
9670 (goto-char pos)))
9672 (defun org-beginning-of-dblock ()
9673 "Find the beginning of the dynamic block at point.
9674 Error if there is no scuh block at point."
9675 (let ((pos (point))
9676 beg)
9677 (end-of-line 1)
9678 (if (and (re-search-backward org-dblock-start-re nil t)
9679 (setq beg (match-beginning 0))
9680 (re-search-forward org-dblock-end-re nil t)
9681 (> (match-end 0) pos))
9682 (goto-char beg)
9683 (goto-char pos)
9684 (error "Not in a dynamic block"))))
9686 (defun org-update-all-dblocks ()
9687 "Update all dynamic blocks in the buffer.
9688 This function can be used in a hook."
9689 (when (org-mode-p)
9690 (org-map-dblocks 'org-update-dblock)))
9693 ;;;; Completion
9695 (defun org-complete (&optional arg)
9696 "Perform completion on word at point.
9697 At the beginning of a headline, this completes TODO keywords as given in
9698 `org-todo-keywords'.
9699 If the current word is preceded by a backslash, completes the TeX symbols
9700 that are supported for HTML support.
9702 setting file options.
9704 At all other locations, this simply calls `ispell-complete-word'."
9705 (interactive "P")
9706 (catch 'exit
9707 (let* ((end (point))
9708 (beg1 (save-excursion
9709 (skip-chars-backward "a-zA-Z_@0-9")
9710 (point)))
9711 (beg (save-excursion
9712 (skip-chars-backward "a-zA-Z0-9_:$")
9713 (point)))
9714 (confirm (lambda (x) (stringp (car x))))
9715 (camel (equal (char-before beg) ?*))
9716 (tag (equal (char-before beg1) ?:))
9718 (link (equal (char-before beg) ?\[))
9719 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
9720 beg)
9721 "#+"))
9723 (buffer-substring (point-at-bol) (point))))
9724 (completion-ignore-case opt)
9725 (type nil)
9726 (tbl nil)
9727 (table (cond
9728 (opt
9729 (setq type :opt)
9730 (mapcar (lambda (x)
9732 (cons (match-string 2 x) (match-string 1 x)))
9734 (startup
9735 (setq type :startup)
9736 org-startup-options)
9737 (link (append org-link-abbrev-alist-local
9738 org-link-abbrev-alist))
9739 (texp
9740 (setq type :tex)
9741 org-html-entities)
9743 (buffer-substring (point-at-bol) beg))
9744 (setq type :todo)
9745 (mapcar 'list org-todo-keywords))
9746 (camel
9747 (setq type :camel)
9748 (save-excursion
9749 (goto-char (point-min))
9750 (while (re-search-forward org-todo-line-regexp nil t)
9751 (push (list
9752 (if org-file-link-context-use-camel-case
9753 (org-make-org-heading-camel (match-string 3) t)
9754 (org-make-org-heading-search-string
9755 (match-string 3) t)))
9756 tbl)))
9757 tbl)
9758 (tag (setq type :tag beg beg1)
9759 (or org-tag-alist (org-get-buffer-tags)))
9760 (t (progn (ispell-complete-word arg) (throw 'exit nil)))))
9761 (pattern (buffer-substring-no-properties beg end))
9762 (completion (try-completion pattern table confirm)))
9763 (cond ((eq completion t)
9764 (if (equal type :opt)
9765 (insert (substring (cdr (assoc (upcase pattern) table))
9766 (length pattern)))
9767 (if (equal type :tag) (insert ":"))))
9768 ((null completion)
9770 (ding))
9771 ((not (string= pattern completion))
9772 (delete-region beg end)
9773 (if (string-match " +$" completion)
9774 (setq completion (replace-match "" t t completion)))
9775 (insert completion)
9776 (if (get-buffer-window "*Completions*")
9777 (delete-window (get-buffer-window "*Completions*")))
9778 (if (assoc completion table)
9779 (if (eq type :todo) (insert " ")
9780 (if (eq type :tag) (insert ":"))))
9781 (if (and (equal type :opt) (assoc completion table))
9782 (message "%s" (substitute-command-keys
9784 (t
9785 (message "Making completion list...")
9786 (let ((list (sort (all-completions pattern table confirm)
9787 'string<)))
9788 (with-output-to-temp-buffer "*Completions*"
9789 (condition-case nil
9790 ;; Protection needed for XEmacs and emacs 21
9791 (display-completion-list list pattern)
9792 (error (display-completion-list list)))))
9793 (message "Making completion list...%s" "done"))))))
9795 ;;;; TODO, DEADLINE, Comments
9797 (defun org-toggle-comment ()
9798 "Change the COMMENT state of an entry."
9799 (interactive)
9800 (save-excursion
9801 (org-back-to-heading)
9802 (if (looking-at (concat outline-regexp
9804 (replace-match "" t t nil 1)
9805 (if (looking-at outline-regexp)
9806 (progn
9807 (goto-char (match-end 0))
9808 (insert " " org-comment-string))))))
9810 (defvar org-last-todo-state-is-todo nil
9811 "This is non-nil when the last TODO state change led to a TODO state.
9812 If the last change removed the TODO tag or switched to DONE, then
9813 this is nil.")
9815 (defun org-todo (&optional arg)
9816 "Change the TODO state of an item.
9817 The state of an item is given by a keyword at the start of the heading,
9818 like
9819 *** TODO Write paper
9820 *** DONE Call mom
9822 The different keywords are specified in the variable `org-todo-keywords'.
9824 So for this example: when the item starts with TODO, it is changed to DONE.
9825 When it starts with DONE, the DONE is removed. And when neither TODO nor
9826 DONE are present, add TODO at the beginning of the heading.
9828 With C-u prefix arg, use completion to determine the new state.
9829 With numeric prefix arg, switch to that state.
9831 For calling through lisp, arg is also interpreted in the following way:
9832 'none -> empty state
9834 'done -> switch to DONE
9836 really is a member of `org-todo-keywords'."
9837 (interactive "P")
9838 (save-excursion
9839 (org-back-to-heading)
9840 (if (looking-at outline-regexp) (goto-char (match-end 0)))
9841 (or (looking-at (concat " +" org-todo-regexp " *"))
9842 (looking-at " *"))
9843 (let* ((this (match-string 1))
9844 (last-state (or this ""))
9845 (completion-ignore-case t)
9846 (member (member this org-todo-keywords))
9847 (tail (cdr member))
9848 (state (cond
9849 ((equal arg '(4))
9850 ;; Read a state with completion
9851 (completing-read "State: " (mapcar (lambda(x) (list x))
9852 org-todo-keywords)
9853 nil t))
9854 ((eq arg 'right)
9855 (if this
9856 (if tail (car tail) nil)
9857 (car org-todo-keywords)))
9858 ((eq arg 'left)
9859 (if (equal member org-todo-keywords)
9860 nil
9861 (if this
9862 (nth (- (length org-todo-keywords) (length tail) 2)
9863 org-todo-keywords)
9864 org-done-string)))
9865 (arg
9866 ;; user requests a specific state
9867 (cond
9868 ((equal arg "") nil)
9869 ((eq arg 'none) nil)
9870 ((eq arg 'done) (org-last org-todo-keywords))
9871 ((car (member arg org-todo-keywords)))
9872 ((nth (1- (prefix-numeric-value arg))
9873 org-todo-keywords))))
9874 ((null member) (car org-todo-keywords))
9875 ((null tail) nil) ;; -> first entry
9876 ((eq org-todo-interpretation 'sequence)
9877 (car tail))
9878 ((memq org-todo-interpretation '(type priority))
9879 (if (eq this-command last-command)
9880 (car tail)
9881 (if (> (length tail) 0) org-done-string nil)))
9882 (t nil)))
9883 (next (if state (concat " " state " ") " "))
9884 dostates)
9885 (replace-match next t t)
9886 (setq org-last-todo-state-is-todo
9887 (not (equal state org-done-string)))
9888 (when org-log-done
9889 (setq dostates (and (eq org-todo-interpretation 'sequence)
9890 (listp org-log-done) (memq 'state org-log-done)))
9891 (cond
9892 ((and state (not this))
9893 (org-add-planning-info nil nil 'closed)
9894 (and dostates (org-add-log-maybe 'state state 'findpos)))
9895 ((and state dostates)
9896 (org-add-log-maybe 'state state 'findpos))
9897 ((equal state org-done-string)
9898 ;; Planning info calls the note-setting command.
9899 (org-add-planning-info 'closed (org-current-time)
9900 (if (org-get-repeat) nil 'scheduled))
9901 (org-add-log-maybe 'done state 'findpos))))
9902 ;; Fixup tag positioning
9903 (and org-auto-align-tags (org-set-tags nil t))
9904 (run-hooks 'org-after-todo-state-change-hook)
9905 ;; (and (equal state org-done-string) (org-auto-repeat-maybe))
9906 ))
9907 ;; Fixup cursor location if close to the keyword
9908 (if (and (outline-on-heading-p)
9909 (not (bolp))
9910 (save-excursion (beginning-of-line 1)
9911 (looking-at org-todo-line-regexp))
9912 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
9913 (progn
9914 (goto-char (or (match-end 2) (match-end 1)))
9915 (just-one-space))))
9918 (defun org-get-repeat ()
9919 "Return the REPEAT statement of this entry."
9920 (save-match-data
9921 (save-excursion
9922 (org-back-to-heading t)
9923 (if (re-search-forward
9924 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
9925 (match-string 1)))))
9927 (defun org-show-todo-tree (arg)
9928 "Make a compact tree which shows all headlines marked with TODO.
9929 The tree will show the lines where the regexp matches, and all higher
9930 headlines above the match.
9932 With a numeric prefix N, construct a sparse tree for the Nth element
9933 of `org-todo-keywords'."
9934 (interactive "P")
9935 (let ((case-fold-search nil)
9936 (kwd-re
9937 (cond ((null arg) org-not-done-regexp)
9938 ((equal arg '(4)) org-todo-regexp)
9939 ((<= (prefix-numeric-value arg) (length org-todo-keywords))
9940 (regexp-quote (nth (1- (prefix-numeric-value arg))
9941 org-todo-keywords)))
9942 (t (error "Invalid prefix argument: %s" arg)))))
9943 (message "%d TODO entries found"
9944 (org-occur (concat "^" outline-regexp " +" kwd-re )))))
9946 (defun org-deadline ()
9947 "Insert the DEADLINE: string to make a deadline.
9949 to modify it to the correct date."
9950 (interactive)
9951 (org-add-planning-info 'deadline nil 'closed))
9953 (defun org-schedule ()
9954 "Insert the SCHEDULED: string to schedule a TODO item.
9956 to modify it to the correct date."
9957 (interactive)
9958 (org-add-planning-info 'scheduled nil 'closed))
9960 (defun org-add-planning-info (what &optional time &rest remove)
9961 "Insert new timestamp with keyword in the line directly after the headline.
9962 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
9963 If non is given, the user is prompted for a date.
9964 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
9965 be removed."
9966 (interactive)
9967 (when what (setq time (or time (org-read-date nil 'to-time))))
9968 (when (and org-insert-labeled-timestamps-at-point
9969 (member what '(scheduled deadline)))
9970 (insert
9971 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
9972 (org-insert-time-stamp time)
9973 (setq what nil))
9974 (save-excursion
9975 (save-restriction
9976 (let (col list elt ts buffer-invisibility-spec)
9977 (org-back-to-heading t)
9979 (goto-char (match-end 1))
9980 (setq col (current-column))
9981 (goto-char (1+ (match-end 0)))
9982 (if (and (not (looking-at outline-regexp))
9985 (not (equal (match-string 1) org-clock-string)))
9986 (narrow-to-region (match-beginning 0) (match-end 0))
9988 (backward-char 1)
9989 (narrow-to-region (point) (point))
9990 (indent-to-column col))
9991 ;; Check if we have to remove something.
9992 (setq list (cons what remove))
9993 (while list
9994 (setq elt (pop list))
9995 (goto-char (point-min))
9996 (when (or (and (eq elt 'scheduled)
9997 (re-search-forward org-scheduled-time-regexp nil t))
9998 (and (eq elt 'deadline)
9999 (re-search-forward org-deadline-time-regexp nil t))
10000 (and (eq elt 'closed)
10001 (re-search-forward org-closed-time-regexp nil t)))
10002 (replace-match "")
10003 (if (looking-at "--+<[^>]+>") (replace-match ""))
10004 (if (looking-at " +") (replace-match ""))))
10005 (goto-char (point-max))
10006 (when what
10007 (insert
10008 (if (not (equal (char-before) ?\ )) " " "")
10009 (cond ((eq what 'scheduled) org-scheduled-string)
10010 ((eq what 'deadline) org-deadline-string)
10011 ((eq what 'closed) org-closed-string))
10012 " ")
10013 (org-insert-time-stamp time nil (eq what 'closed))
10014 (end-of-line 1)
10015 ;;FIXME (and (eq what 'closed) (org-add-log-maybe 'done))
10016 )
10017 (goto-char (point-min))
10018 (widen)
10020 (replace-match ""))
10021 ts))))
10023 (defvar org-log-note-marker (make-marker))
10024 (defvar org-log-note-purpose nil)
10025 (defvar org-log-note-state nil)
10026 (defvar org-log-note-window-configuration nil)
10027 (defvar org-log-note-return-to (make-marker))
10029 (defun org-add-log-maybe (&optional purpose state findpos)
10030 (save-excursion
10031 (when (and (listp org-log-done)
10032 (memq purpose org-log-done))
10033 (when findpos
10034 (org-back-to-heading t)
10038 (goto-char (match-end 0)))
10039 (move-marker org-log-note-marker (point))
10040 (setq org-log-note-purpose purpose)
10041 (setq org-log-note-state state)
10042 (add-hook 'post-command-hook 'org-add-log-note 'append))))
10044 (defun org-add-log-note (&optional purpose)
10045 "Pop up a window for taking a note, and add this note later at point."
10046 (remove-hook 'post-command-hook 'org-add-log-note)
10047 (setq org-log-note-window-configuration (current-window-configuration))
10048 (delete-other-windows)
10049 (move-marker org-log-note-return-to (point))
10050 (switch-to-buffer (marker-buffer org-log-note-marker))
10051 (goto-char org-log-note-marker)
10052 (switch-to-buffer-other-window "*Org Note*")
10053 (erase-buffer)
10054 (org-mode)
10056 (cond
10057 ((eq org-log-note-purpose 'clock-out) "stopped clock")
10058 ((eq org-log-note-purpose 'done) "closed todo item")
10059 ((eq org-log-note-purpose 'state) "state change")
10060 (t (error "This should not happen")))))
10061 (org-set-local 'org-finish-function 'org-store-log-note))
10063 (defun org-store-log-note ()
10064 "Finish taking a log note, and insert it to where it belongs."
10065 (let ((txt (buffer-string))
10066 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
10067 lines ind)
10068 (kill-buffer (current-buffer))
10070 (setq txt (replace-match "" t t txt)))
10072 (setq txt (replace-match "" t t txt)))
10075 (setq note
10076 (org-replace-escapes
10077 note
10078 (list (cons "%u" (user-login-name))
10079 (cons "%U" user-full-name)
10080 (cons "%t" (format-time-string
10081 (org-time-stamp-format 'long 'inactive)
10082 (current-time)))
10083 (cons "%s" (if org-log-note-state
10085 "")))))
10087 (push note lines))
10088 (save-excursion
10089 (set-buffer (marker-buffer org-log-note-marker))
10090 (save-excursion
10091 (goto-char org-log-note-marker)
10092 (end-of-line 1)
10094 (setq ind (concat (buffer-substring (point-at-bol) (point)) " "))
10095 (insert " - " (pop lines))
10096 (while lines
10098 (set-window-configuration org-log-note-window-configuration)
10099 (with-current-buffer (marker-buffer org-log-note-return-to)
10100 (goto-char org-log-note-return-to)))
10102 (defvar org-occur-highlights nil)
10103 (make-variable-buffer-local 'org-occur-highlights)
10105 (defun org-occur (regexp &optional keep-previous callback)
10106 "Make a compact tree which shows all matches of REGEXP.
10107 The tree will show the lines where the regexp matches, and all higher
10108 headlines above the match. It will also show the heading after the match,
10109 to make sure editing the matching entry is easy.
10110 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
10111 call to `org-occur' will be kept, to allow stacking of calls to this
10112 command.
10113 If CALLBACK is non-nil, it is a function which is called to confirm
10114 that the match should indeed be shown."
10116 (or keep-previous (org-remove-occur-highlights nil nil t))
10117 (let ((cnt 0))
10118 (save-excursion
10119 (goto-char (point-min))
10120 (if (or (not keep-previous) ; do not want to keep
10121 (not org-occur-highlights)) ; no previous matches
10122 ;; hide everything
10123 (org-overview))
10124 (while (re-search-forward regexp nil t)
10125 (when (or (not callback)
10126 (save-match-data (funcall callback)))
10127 (setq cnt (1+ cnt))
10128 (org-highlight-new-match (match-beginning 0) (match-end 0))
10129 (org-show-context 'occur-tree))))
10130 (when org-remove-highlights-with-change
10131 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
10132 nil 'local))
10133 (unless org-sparse-tree-open-archived-trees
10134 (org-hide-archived-subtrees (point-min) (point-max)))
10135 (run-hooks 'org-occur-hook)
10136 (if (interactive-p)
10137 (message "%d match(es) for regexp %s" cnt regexp))
10138 cnt))
10140 ;; FIXME: Remove the siblings argument, or add args for the others too?
10141 (defun org-show-context (&optional key siblings)
10142 "Make sure point and context and visible.
10143 How much context is shown depends upon the variables
10144 `org-show-hierarchy-above' and `org-show-following-heading'.
10145 When SIBLINGS is non-nil, show all siblings on each hierarchy level."
10146 (let ((heading-p (org-on-heading-p t))
10147 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
10148 (following-p (org-get-alist-option org-show-following-heading key))
10149 (siblings-p (or siblings (org-get-alist-option org-show-siblings key))))
10150 (catch 'exit
10151 ;; Show heading or entry text
10152 (if heading-p
10153 (org-flag-heading nil) ; only show the heading
10154 (and (or (org-invisible-p) (org-invisible-p2))
10155 (org-show-hidden-entry))) ; show entire entry
10156 (when following-p
10157 ;; Show next sibling, or heading below text
10158 (save-excursion
10159 (and (if heading-p (org-goto-sibling) (outline-next-heading))
10160 (org-flag-heading nil))))
10161 (when siblings-p (org-show-siblings))
10162 (when hierarchy-p
10163 ;; show all higher headings, possibly with siblings
10164 (save-excursion
10165 (while (and (condition-case nil
10166 (progn (org-up-heading-all 1) t)
10167 (error nil))
10168 (not (bobp)))
10169 (org-flag-heading nil)
10170 (when siblings-p (org-show-siblings))))))))
10172 (defun org-reveal (&optional siblings)
10173 "Show current entry, hierarchy above it, and the following headline.
10174 This can be used to show a consistent set of context around locations
10175 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
10176 not t for the search context.
10178 With optional argument SIBLINGS, on each level of the hierarchy all
10179 siblings are shown. This repairs the tree structure to what it would
10180 look like when opened with hierarchical calls to `org-cycle'."
10181 (interactive "P")
10182 (let ((org-show-hierarchy-above t)
10183 (org-show-following-heading t))
10184 (org-show-context nil siblings)))
10186 (defun org-highlight-new-match (beg end)
10187 "Highlight from BEG to END and mark the highlight is an occur headline."
10188 (let ((ov (org-make-overlay beg end)))
10189 (org-overlay-put ov 'face 'secondary-selection)
10190 (push ov org-occur-highlights)))
10192 (defvar org-inhibit-highlight-removal nil)
10193 (defun org-remove-occur-highlights (&optional beg end noremove)
10194 "Remove the occur highlights from the buffer.
10195 BEG and END are ignored. If NOREMOVE is nil, remove this function
10196 from the `before-change-functions' in the current buffer."
10197 (interactive)
10198 (unless org-inhibit-highlight-removal
10199 (mapc 'org-delete-overlay org-occur-highlights)
10200 (setq org-occur-highlights nil)
10201 (unless noremove
10202 (remove-hook 'before-change-functions
10203 'org-remove-occur-highlights 'local))))
10205 ;;;; Priorities
10208 "Regular expression matching the priority indicator.")
10210 (defvar org-remove-priority-next-time nil)
10212 (defun org-priority-up ()
10213 "Increase the priority of the current item."
10214 (interactive)
10215 (org-priority 'up))
10217 (defun org-priority-down ()
10218 "Decrease the priority of the current item."
10219 (interactive)
10220 (org-priority 'down))
10222 (defun org-priority (&optional action)
10223 "Change the priority of an item by ARG.
10224 ACTION can be set, up, or down."
10225 (interactive)
10226 (setq action (or action 'set))
10227 (let (current new news have remove)
10228 (save-excursion
10229 (org-back-to-heading)
10230 (if (looking-at org-priority-regexp)
10231 (setq current (string-to-char (match-string 2))
10232 have t)
10233 (setq current org-default-priority))
10234 (cond
10235 ((eq action 'set)
10236 (message "Priority A-%c, SPC to remove: " org-lowest-priority)
10237 (setq new (read-char-exclusive))
10238 (cond ((equal new ?\ ) (setq remove t))
10239 ((or (< (upcase new) ?A) (> (upcase new) org-lowest-priority))
10240 (error "Priority must be between `%c' and `%c'"
10241 ?A org-lowest-priority))))
10242 ((eq action 'up)
10243 (setq new (1- current)))
10244 ((eq action 'down)
10245 (setq new (1+ current)))
10246 (t (error "Invalid action")))
10247 (setq new (min (max ?A (upcase new)) org-lowest-priority))
10248 (setq news (format "%c" new))
10249 (if have
10250 (if remove
10251 (replace-match "" t t nil 1)
10252 (replace-match news t t nil 2))
10253 (if remove
10254 (error "No priority cookie found in line")
10255 (looking-at org-todo-line-regexp)
10256 (if (match-end 2)
10257 (progn
10258 (goto-char (match-end 2))
10259 (insert " [#" news "]"))
10260 (goto-char (match-beginning 3))
10261 (insert "[#" news "] ")))))
10262 (if remove
10263 (message "Priority removed")
10264 (message "Priority of current item set to %s" news))))
10267 (defun org-get-priority (s)
10268 "Find priority cookie and return priority."
10269 (save-match-data
10270 (if (not (string-match org-priority-regexp s))
10271 (* 1000 (- org-lowest-priority org-default-priority))
10272 (* 1000 (- org-lowest-priority
10273 (string-to-char (match-string 2 s)))))))
10275 ;;;; Tags
10277 (defun org-scan-tags (action matcher &optional todo-only)
10278 "Scan headline tags with inheritance and produce output ACTION.
10279 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
10280 evaluated, testing if a given set of tags qualifies a headline for
10281 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
10282 are included in the output."
10284 (mapconcat 'regexp-quote
10285 (nreverse (cdr (reverse org-todo-keywords)))
10288 (props (list 'face nil
10289 'done-face 'org-done
10290 'undone-face nil
10291 'mouse-face 'highlight
10292 'org-not-done-regexp org-not-done-regexp
10293 'keymap org-agenda-keymap
10294 'help-echo
10295 (format "mouse-2 or RET jump to org file %s"
10296 (abbreviate-file-name buffer-file-name))))
10297 (case-fold-search nil)
10298 lspos
10299 tags tags-list tags-alist (llast 0) rtn level category i txt
10300 todo marker entry)
10301 (save-excursion
10302 (goto-char (point-min))
10303 (when (eq action 'sparse-tree) (org-overview))
10304 (while (re-search-forward re nil t)
10305 (catch :skip
10306 (and (eq action 'agenda) (org-agenda-skip))
10307 (setq todo (if (match-end 1) (match-string 2))
10308 tags (if (match-end 4) (match-string 4)))
10309 (goto-char (setq lspos (1+ (match-beginning 0))))
10310 (setq level (funcall outline-level)
10311 category (org-get-category))
10312 (setq i llast llast level)
10313 ;; remove tag lists from same and sublevels
10314 (while (>= i level)
10315 (when (setq entry (assoc i tags-alist))
10316 (setq tags-alist (delete entry tags-alist)))
10317 (setq i (1- i)))
10318 ;; add the nex tags
10319 (when tags
10320 (setq tags (mapcar 'downcase (org-split-string tags ":"))
10321 tags-alist
10322 (cons (cons level tags) tags-alist)))
10323 ;; compile tags for current headline
10324 (setq tags-list
10325 (if org-use-tag-inheritance
10326 (apply 'append (mapcar 'cdr tags-alist))
10327 tags))
10328 (when (and (or (not todo-only) todo)
10329 (eval matcher)
10330 (or (not org-agenda-skip-archived-trees)
10331 (not (member org-archive-tag tags-list))))
10332 ;; list this headline
10333 (if (eq action 'sparse-tree)
10334 (progn
10335 (org-show-context 'tags-tree))
10336 (setq txt (org-format-agenda-item
10337 ""
10338 (concat
10339 (if org-tags-match-list-sublevels
10340 (make-string (1- level) ?.) "")
10341 (org-get-heading))
10342 category tags-list))
10343 (goto-char lspos)
10344 (setq marker (org-agenda-new-marker))
10345 (org-add-props txt props
10346 'org-marker marker 'org-hd-marker marker 'category category)
10347 (push txt rtn))
10348 ;; if we are to skip sublevels, jump to end of subtree
10349 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
10350 (when (and (eq action 'sparse-tree)
10351 (not org-sparse-tree-open-archived-trees))
10352 (org-hide-archived-subtrees (point-min) (point-max)))
10353 (nreverse rtn)))
10355 (defvar todo-only) ;; dynamically scoped
10357 (defun org-tags-sparse-tree (&optional todo-only match)
10358 "Create a sparse tree according to tags string MATCH.
10359 MATCH can contain positive and negative selection of tags, like
10361 If optional argument TODO_ONLY is non-nil, only select lines that are
10362 also TODO lines."
10363 (interactive "P")
10364 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
10366 (defun org-make-tags-matcher (match)
10367 "Create the TAGS//TODO matcher form for the selection string MATCH."
10368 ;; todo-only is scoped dynamically into this function, and the function
10369 ;; may change it it the matcher asksk for it.
10370 (unless match
10371 ;; Get a new match request, with completion
10372 (setq org-last-tags-completion-table
10373 (or org-tag-alist
10374 org-last-tags-completion-table))
10375 (setq match (completing-read
10376 "Match: " 'org-tags-completion-function nil nil nil
10377 'org-tags-history))) ; FIXME: Separate history for this?
10379 ;; Parse the string and create a lisp form
10380 (let ((match0 match)
10382 minus tag mm
10383 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
10384 orterms term orlist re-p level-p)
10385 (if (string-match "/+" match)
10386 ;; match contains also a todo-matching request
10387 (progn
10388 (setq tagsmatch (substring match 0 (match-beginning 0))
10389 todomatch (substring match (match-end 0)))
10390 (if (string-match "^!" todomatch)
10391 (setq todo-only t todomatch (substring todomatch 1)))
10393 (setq todomatch nil)))
10394 ;; only matching tags
10395 (setq tagsmatch match todomatch nil))
10397 ;; Make the tags matcher
10399 (setq tagsmatcher t)
10400 (setq orterms (org-split-string tagsmatch "|") orlist nil)
10401 (while (setq term (pop orterms))
10403 (setq term (concat term "|" (pop orterms)))) ; repair bad split
10404 (while (string-match re term)
10405 (setq minus (and (match-end 1)
10406 (equal (match-string 1 term) "-"))
10407 tag (match-string 2 term)
10408 re-p (equal (string-to-char tag) ?{)
10409 level-p (match-end 3)
10410 mm (cond
10411 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
10412 (level-p `(= level ,(string-to-number
10413 (match-string 3 term))))
10414 (t `(member ,(downcase tag) tags-list)))
10415 mm (if minus (list 'not mm) mm)
10416 term (substring term (match-end 0)))
10417 (push mm tagsmatcher))
10418 (push (if (> (length tagsmatcher) 1)
10419 (cons 'and tagsmatcher)
10420 (car tagsmatcher))
10421 orlist)
10422 (setq tagsmatcher nil))
10423 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist))))
10425 ;; Make the todo matcher
10427 (setq todomatcher t)
10428 (setq orterms (org-split-string todomatch "|") orlist nil)
10429 (while (setq term (pop orterms))
10430 (while (string-match re term)
10431 (setq minus (and (match-end 1)
10432 (equal (match-string 1 term) "-"))
10433 kwd (match-string 2 term)
10434 re-p (equal (string-to-char kwd) ?{)
10435 term (substring term (match-end 0))
10436 mm (if re-p
10437 `(string-match ,(substring kwd 1 -1) todo)
10438 (list 'equal 'todo kwd))
10439 mm (if minus (list 'not mm) mm))
10440 (push mm todomatcher))
10441 (push (if (> (length todomatcher) 1)
10442 (cons 'and todomatcher)
10443 (car todomatcher))
10444 orlist)
10445 (setq todomatcher nil))
10446 (setq todomatcher (if (> (length orlist) 1)
10447 (cons 'or orlist) (car orlist))))
10449 ;; Return the string and lisp forms of the matcher
10450 (setq matcher (if todomatcher
10451 (list 'and tagsmatcher todomatcher)
10452 tagsmatcher))
10453 (cons match0 matcher)))
10455 (defun org-match-any-p (re list)
10456 "Does re match any element of list?"
10457 (setq list (mapcar (lambda (x) (string-match re x)) list))
10458 (delq nil list))
10460 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
10461 (defvar org-tags-overlay (org-make-overlay 1 1))
10462 (org-detach-overlay org-tags-overlay)
10464 (defun org-set-tags (&optional arg just-align)
10465 "Set the tags for the current headline.
10466 With prefix ARG, realign all tags in headings in the current buffer."
10467 (interactive "P")
10468 (let* ((re (concat "^" outline-regexp))
10469 (current (org-get-tags))
10470 table current-tags inherited-tags ; computed below when needed
10471 tags p0 c0 c1 rpl)
10472 (if arg
10473 (save-excursion
10474 (goto-char (point-min))
10475 (let (buffer-invisibility-spec) ; Emacs 21 compatibility
10476 (while (re-search-forward re nil t)
10477 (org-set-tags nil t)
10478 (end-of-line 1)))
10479 (message "All tags realigned to column %d" org-tags-column))
10480 (if just-align
10481 (setq tags current)
10482 ;; Get a new set of tags from the user
10483 (setq table (or org-tag-alist (org-get-buffer-tags))
10484 org-last-tags-completion-table table
10485 current-tags (org-split-string current ":")
10486 inherited-tags (nreverse
10487 (nthcdr (length current-tags)
10488 (nreverse (org-get-tags-at))))
10489 tags
10490 (if (or (eq t org-use-fast-tag-selection)
10491 (and org-use-fast-tag-selection
10492 (delq nil (mapcar 'cdr table))))
10493 (org-fast-tag-selection current-tags inherited-tags table)
10494 (let ((org-add-colon-after-tag-completion t))
10495 (org-trim
10496 (completing-read "Tags: " 'org-tags-completion-function
10497 nil nil current 'org-tags-history)))))
10498 (while (string-match "[-+&]+" tags)
10499 ;; No boolean logic, just a list
10500 (setq tags (replace-match ":" t t tags))))
10502 (setq tags "")
10503 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
10504 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
10506 ;; Insert new tags at the correct column
10507 (beginning-of-line 1)
10508 (if (re-search-forward
10510 (point-at-eol) t)
10511 (progn
10512 (if (equal tags "")
10513 (setq rpl "")
10514 (goto-char (match-beginning 0))
10515 (setq c0 (current-column) p0 (point)
10516 c1 (max (1+ c0) (if (> org-tags-column 0)
10517 org-tags-column
10518 (- (- org-tags-column) (length tags))))
10519 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
10520 (replace-match rpl)
10521 (and (not (featurep 'xemacs)) c0 (tabify p0 (point)))
10522 tags)
10523 (error "Tags alignment failed")))))
10525 (defun org-tags-completion-function (string predicate &optional flag)
10526 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
10527 (confirm (lambda (x) (stringp (car x)))))
10529 (setq s1 (match-string 1 string)
10530 s2 (match-string 2 string))
10531 (setq s1 "" s2 string))
10532 (cond
10533 ((eq flag nil)
10534 ;; try completion
10535 (setq rtn (try-completion s2 ctable confirm))
10536 (if (stringp rtn)
10537 (concat s1 s2 (substring rtn (length s2))
10538 (if (and org-add-colon-after-tag-completion
10539 (assoc rtn ctable))
10540 ":" "")))
10541 )
10542 ((eq flag t)
10543 ;; all-completions
10544 (all-completions s2 ctable confirm)
10545 )
10546 ((eq flag 'lambda)
10547 ;; exact match?
10548 (assoc s2 ctable)))
10549 ))
10551 (defun org-fast-tag-insert (kwd tags face &optional end)
10552 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
10553 (insert (format "%-12s" (concat kwd ":"))
10554 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
10555 (or end "")))
10557 (defun org-fast-tag-show-exit (flag)
10558 (save-excursion
10559 (goto-line 3)
10561 (replace-match ""))
10562 (when flag
10563 (end-of-line 1)
10564 (move-to-column (- (window-width) 19) t)
10565 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
10567 (defun org-set-current-tags-overlay (current prefix)
10568 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
10569 (if (featurep 'xemacs)
10570 (org-overlay-display org-tags-overlay (concat prefix s)
10571 'secondary-selection)
10572 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
10573 (org-overlay-display org-tags-overlay (concat prefix s)))))
10575 (defun org-fast-tag-selection (current inherited table)
10576 "Fast tag selection with single keys.
10577 CURRENT is the current list of tags in the headline, INHERITED is the
10578 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
10579 possibly with grouping information.
10580 If the keys are nil, a-z are automatically assigned.
10581 Returns the new tags string, or nil to not change the current settings."
10582 (let* ((maxlen (apply 'max (mapcar
10583 (lambda (x)
10584 (if (stringp (car x)) (string-width (car x)) 0))
10585 table)))
10586 (buf (current-buffer))
10587 (buffer-tags nil)
10588 (fwidth (+ maxlen 3 1 3))
10589 (ncol (/ (- (window-width) 4) fwidth))
10590 (i-face 'org-done)
10591 (c-face 'org-tag)
10592 tg cnt e c char c1 c2 ntable tbl rtn
10593 ov-start ov-end ov-prefix
10594 (exit-after-next org-fast-tag-selection-single-key)
10595 groups ingroup)
10596 (save-excursion
10597 (beginning-of-line 1)
10599 (setq ov-start (match-beginning 1)
10600 ov-end (match-end 1)
10601 ov-prefix "")
10602 (setq ov-start (1- (point-at-eol))
10603 ov-end (1+ ov-start))
10605 (setq ov-prefix
10606 (concat
10607 (buffer-substring (1- (point)) (point))
10608 (if (> (current-column) org-tags-column)
10609 " "
10610 (make-string (- org-tags-column (current-column)) ?\ ))))))
10611 (org-move-overlay org-tags-overlay ov-start ov-end)
10612 (save-window-excursion
10613 ;; FIXME: would it be better to keep the other windows?
10614 ;; How about fast tag selection keeping all windows? Expert mode?
10615 (delete-other-windows)
10616 (split-window-vertically)
10617 (switch-to-buffer-other-window (get-buffer-create " *Org tags*"))
10618 (erase-buffer)
10621 (org-fast-tag-show-exit exit-after-next)
10622 (org-set-current-tags-overlay current ov-prefix)
10623 (setq tbl table char ?a cnt 0)
10624 (while (setq e (pop tbl))
10625 (cond
10626 ((equal e '(:startgroup))
10627 (push '() groups) (setq ingroup t)
10628 (when (not (= cnt 0))
10629 (setq cnt 0)
10631 (insert "{ "))
10632 ((equal e '(:endgroup))
10633 (setq ingroup nil cnt 0)
10635 (t
10636 (setq tg (car e) c2 nil)
10637 (if (cdr e)
10638 (setq c (cdr e))
10639 ;; automatically assign a character.
10640 (setq c1 (string-to-char
10641 (downcase (substring
10642 tg (if (= (string-to-char tg) ?@) 1 0)))))
10643 (if (or (rassoc c1 ntable) (rassoc c1 table))
10644 (while (or (rassoc char ntable) (rassoc char table))
10645 (setq char (1+ char)))
10646 (setq c2 c1))
10647 (setq c (or c2 char)))
10648 (if ingroup (push tg (car groups)))
10649 (setq tg (org-add-props tg nil 'face
10650 (cond
10651 ((member tg current) c-face)
10652 ((member tg inherited) i-face)
10653 (t nil))))
10654 (if (and (= cnt 0) (not ingroup)) (insert " "))
10655 (insert "[" c "] " tg (make-string
10656 (- fwidth 4 (length tg)) ?\ ))
10657 (push (cons tg c) ntable)
10658 (when (= (setq cnt (1+ cnt)) ncol)
10660 (if ingroup (insert " "))
10661 (setq cnt 0)))))
10662 (setq ntable (nreverse ntable))
10664 (goto-char (point-min))
10665 (if (fboundp 'fit-window-to-buffer) (fit-window-to-buffer))
10666 (setq rtn
10667 (catch 'exit
10668 (while t
10669 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [C-c]: multi%s"
10670 (if groups " [!] no groups" ""))
10671 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
10672 (cond
10674 ((= c ?!)
10675 (setq groups nil)
10676 (goto-char (point-min))
10677 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
10678 ((= c ?\C-c)
10679 (org-fast-tag-show-exit
10680 (setq exit-after-next (not exit-after-next))))
10681 ((or (= c ?\C-g)
10682 (and (= c ?q) (not (rassoc c ntable))))
10683 (org-detach-overlay org-tags-overlay)
10684 (setq quit-flag t))
10685 ((= c ?\ )
10686 (setq current nil)
10687 (if exit-after-next (setq exit-after-next 'now)))
10689 (condition-case nil
10690 (setq tg (completing-read
10691 "Tag: "
10692 (or buffer-tags
10693 (with-current-buffer buf
10694 (org-get-buffer-tags)))))
10695 (quit (setq tg "")))
10697 (add-to-list 'buffer-tags (list tg))
10698 (if (member tg current)
10699 (setq current (delete tg current))
10700 (push tg current)))
10701 (if exit-after-next (setq exit-after-next 'now)))
10702 ((setq e (rassoc c ntable) tg (car e))
10703 (if (member tg current)
10704 (setq current (delete tg current))
10705 (loop for g in groups do
10706 (if (member tg g)
10707 (mapcar (lambda (x)
10708 (setq current (delete x current)))
10709 g)))
10710 (push tg current))
10711 (if exit-after-next (setq exit-after-next 'now))))
10713 ;; Create a sorted list
10714 (setq current
10715 (sort current
10716 (lambda (a b)
10717 (assoc b (cdr (memq (assoc a ntable) ntable))))))
10718 (if (eq exit-after-next 'now) (throw 'exit t))
10719 (goto-char (point-min))
10720 (beginning-of-line 2)
10721 (delete-region (point) (point-at-eol))
10722 (org-fast-tag-insert "Current" current c-face)
10723 (org-set-current-tags-overlay current ov-prefix)
10725 (setq tg (match-string 1))
10726 (add-text-properties (match-beginning 1) (match-end 1)
10727 (list 'face
10728 (cond
10729 ((member tg current) c-face)
10730 ((member tg inherited) i-face)
10731 (t nil)))))
10732 (goto-char (point-min)))))
10733 (org-detach-overlay org-tags-overlay)
10734 (if rtn
10735 (mapconcat 'identity current ":")
10736 nil))))
10738 (defun org-get-tags ()
10739 "Get the TAGS string in the current headline."
10740 (unless (org-on-heading-p t)
10741 (error "Not on a heading"))
10742 (save-excursion
10743 (beginning-of-line 1)
10745 (org-match-string-no-properties 1)
10746 "")))
10748 (defun org-get-buffer-tags ()
10749 "Get a table of all tags used in the buffer, for completion."
10750 (let (tags)
10751 (save-excursion
10752 (goto-char (point-min))
10754 (mapc (lambda (x) (add-to-list 'tags x))
10755 (org-split-string (org-match-string-no-properties 1) ":"))))
10756 (mapcar 'list tags)))
10758 ;;;; Timestamps
10760 (defvar org-last-changed-timestamp nil)
10761 (defvar org-time-was-given) ; dynamically scoped parameter
10762 (defvar org-ts-what) ; dynamically scoped parameter
10764 (defun org-time-stamp (arg)
10765 "Prompt for a date/time and insert a time stamp.
10766 If the user specifies a time like HH:MM, or if this command is called
10767 with a prefix argument, the time stamp will contain date and time.
10768 Otherwise, only the date will be included. All parts of a date not
10769 specified by the user will be filled in from the current date/time.
10770 So if you press just return without typing anything, the time stamp
10771 will represent the current date/time. If there is already a timestamp
10772 at the cursor, it will be modified."
10773 (interactive "P")
10774 (let (org-time-was-given time)
10775 (cond
10776 ((and (org-at-timestamp-p)
10777 (eq last-command 'org-time-stamp)
10778 (eq this-command 'org-time-stamp))
10779 (insert "--")
10780 (setq time (let ((this-command this-command))
10781 (org-read-date arg 'totime)))
10782 (org-insert-time-stamp time (or org-time-was-given arg)))
10783 ((org-at-timestamp-p)
10784 (setq time (let ((this-command this-command))
10785 (org-read-date arg 'totime)))
10786 (when (org-at-timestamp-p) ; just to get the match data
10787 (replace-match "")
10788 (setq org-last-changed-timestamp
10789 (org-insert-time-stamp time (or org-time-was-given arg))))
10790 (message "Timestamp updated"))
10791 (t
10792 (setq time (let ((this-command this-command))
10793 (org-read-date arg 'totime)))
10794 (org-insert-time-stamp time (or org-time-was-given arg))))))
10796 (defun org-time-stamp-inactive (&optional arg)
10797 "Insert an inactive time stamp.
10798 An inactive time stamp is enclosed in square brackets instead of angle
10799 brackets. It is inactive in the sense that it does not trigger agenda entries,
10800 does not link to the calendar and cannot be changed with the S-cursor keys.
10801 So these are more for recording a certain time/date."
10802 (interactive "P")
10803 (let (org-time-was-given time)
10804 (setq time (org-read-date arg 'totime))
10805 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive)))
10807 (defvar org-date-ovl (org-make-overlay 1 1))
10808 (org-overlay-put org-date-ovl 'face 'org-warning)
10809 (org-detach-overlay org-date-ovl)
10811 (defvar org-ans1) ; dynamically scoped parameter
10812 (defvar org-ans2) ; dynamically scoped parameter
10814 (defun org-read-date (&optional with-time to-time from-string)
10815 "Read a date and make things smooth for the user.
10816 The prompt will suggest to enter an ISO date, but you can also enter anything
10817 which will at least partially be understood by `parse-time-string'.
10818 Unrecognized parts of the date will default to the current day, month, year,
10819 hour and minute. For example,
10820 3-2-5 --> 2003-02-05
10821 feb 15 --> currentyear-02-15
10822 sep 12 9 --> 2009-09-12
10823 12:45 --> today 12:45
10824 22 sept 0:34 --> currentyear-09-22 0:34
10825 12 --> currentyear-currentmonth-12
10826 Fri --> nearest Friday (today or later)
10827 +4 --> four days from today (only if +N is the only thing given)
10828 etc.
10829 The function understands only English month and weekday abbreviations,
10830 but this can be configured with the variables `parse-time-months' and
10831 `parse-time-weekdays'.
10833 While prompting, a calendar is popped up - you can also select the
10834 date with the mouse (button 1). The calendar shows a period of three
10835 months. To scroll it to other months, use the keys `>' and `<'.
10836 If you don't like the calendar, turn it off with
10837 \(setq org-popup-calendar-for-date-prompt nil)
10839 With optional argument TO-TIME, the date will immediately be converted
10840 to an internal time.
10841 With an optional argument WITH-TIME, the prompt will suggest to also
10842 insert a time. Note that when WITH-TIME is not set, you can still
10843 enter a time, and this function will inform the calling routine about
10844 this change. The calling routine may then choose to change the format
10845 used to insert the time stamp into the buffer to include the time."
10846 (require 'parse-time)
10847 (let* ((org-time-stamp-rounding-minutes
10848 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
10849 (ct (org-current-time))
10850 (default-time
10851 ;; Default time is either today, or, when entering a range,
10852 ;; the range start.
10853 (if (save-excursion
10854 (re-search-backward
10856 (- (point) 20) t))
10857 (apply
10858 'encode-time
10859 (mapcar (lambda(x) (or x 0))
10860 (parse-time-string (match-string 1))))
10861 ct))
10862 (calendar-move-hook nil)
10863 (view-diary-entries-initially nil)
10864 (view-calendar-holidays-initially nil)
10865 (timestr (format-time-string
10866 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") default-time))
10867 (prompt (format "YYYY-MM-DD [%s]: " timestr))
10868 ans org-ans1 org-ans2 (deltadays 0)
10869 second minute hour day month year tl wday wday1)
10871 (cond
10872 (from-string (setq ans from-string))
10873 (org-popup-calendar-for-date-prompt
10874 (save-excursion
10875 (save-window-excursion
10876 (calendar)
10877 (calendar-forward-day (- (time-to-days default-time)
10878 (calendar-absolute-from-gregorian
10879 (calendar-current-date))))
10880 (org-eval-in-calendar nil)
10881 (let* ((old-map (current-local-map))
10882 (map (copy-keymap calendar-mode-map))
10883 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
10884 (define-key map (kbd "RET") 'org-calendar-select)
10885 (define-key map (if (featurep 'xemacs) [button1] [mouse-1])
10886 'org-calendar-select-mouse)
10937 t nil ans))))
10948 ;; Weekday was given, but no day, so pick that day in the week
10949 ;; on or after the derived date.
10964 "Eval FORM in the calendar window and return to current window.
10965 Also, store the cursor date in variable org-ans2."
10977 "Return to `org-read-date' with the date currently selected.
10978 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
10987 "Insert a date stamp for the date given by the internal TIME.
10988 WITH-HM means, use the stamp format that includes the time of the day.
10989 INACTIVE means use square brackets instead of angular ones, so that the
10990 stamp will not contribute to the agenda.
10991 PRE and POST are optional strings to be inserted before and after the
10992 stamp.
10993 The command returns the inserted time stamp."
10995 stamp)
11000 stamp))
11003 "Toggle the use of custom time stamp formats."
11024 "Overlay modified time stamp format over timestamp between BED and END."
11047 "Translate all timestamps in STRING to custom format.
11048 But do this only if the variable `org-display-custom-times' is set."
11053 t1 with-hm inactive tf time str beg end)
11062 org-time-stamp-custom-formats)
11071 string)
11074 "Set 0 instead of nil for the first 6 elements of time.
11075 Don't touch the rest."
11080 "Difference between TIMESTAMP-STRING and now in days."
11085 "Is the time in TIMESTAMP-STRING close to the current date?"
11091 "Return to `org-read-date' with the date currently selected.
11092 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
11102 "Check if there are any deadlines due or past due.
11103 A deadline is considered due if it happens within `org-deadline-warning-days'
11104 days from today's date. If the deadline appears in an entry marked DONE,
11105 it is not shown. The prefix arg NDAYS can be used to test that many
11120 org-warn-days)))
11123 "Evaluate a time range by computing the difference between start and end.
11124 Normally the result is just printed in the echo area, but with prefix arg
11125 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
11126 If the time range is actually in a table, the result is inserted into the
11127 next column.
11128 For time difference computation, a year is assumed to be exactly 365
11129 days in order to avoid rounding problems."
11149 ;; (ys (floor (* 365 24 60 60)))
11157 y d h m align)
11160 y 0
11165 y 0
11201 "Parse the standard Org-mode time string.
11202 This should be a lot faster than the normal `parse-time-string'.
11203 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
11204 hour and minute fields will be nil if not given."
11214 nil nil nil)
11218 "Increase the date item at the cursor by one.
11219 If the cursor is on the year, change the year. If it is on the month or
11220 the day, change that.
11221 With prefix ARG, change by that many units."
11226 "Decrease the date item at the cursor by one.
11227 If the cursor is on the year, change the year. If it is on the month or
11228 the day, change that.
11229 With prefix ARG, change by that many units."
11234 "Increase the date in the time stamp by one day.
11235 With prefix ARG, change that many days."
11243 "Decrease the date in the time stamp by one day.
11244 With prefix ARG, change that many days."
11257 "Determine if the cursor is in or at a timestamp."
11277 ans))
11280 "Change the date in the time stamp at point.
11281 The date will be changed by N times WHAT. WHAT can be `day', `month',
11282 `year', `minute', `second'. If WHAT is not given, the cursor position
11283 in the timestamp determines what will be changed."
11285 with-hm inactive
11286 org-ts-what
11287 ts time time0)
11291 org-display-custom-times
11330 ;; Try to recenter the calendar window, if any
11337 "If the calendar is visible, recenter it to DATE."
11348 "Go to the Emacs calendar at the current date.
11349 If there is a time stamp in the current line, go to that date.
11350 A prefix ARG can be used to force the current date."
11369 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
11370 If there is already a time stamp at the cursor position, update it."
11374 ;;; The clock for measuring work time.
11380 "Start the clock on the current item.
11381 If necessary, clock-out of the currently active clock."
11399 "Stop the currently running clock.
11400 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
11429 "Cancel the running clock be removing the start timestamp."
11444 "Sum the times for each subtree.
11445 Puts the resulting times in minutes as a text property on each headline."
11449 org-clock-string
11455 ts te dt
11456 time)
11462 ;; A time
11473 ;; A headline
11487 "Show subtree times in the entire buffer.
11488 If TOTAL-ONLY is non-nil, only show the total time for the entire file
11489 in the echo area."
11503 ;; Arrange to remove the overlays upon next change.
11513 "Put an overlays on the current line, displaying TIME.
11514 If LEVEL is given, prefix time with a corresponding number of stars.
11515 This creates a new overlay and stores it in `org-clock-overlays', so that it
11516 will be easy to remove."
11520 ov tx)
11539 "Remove the occur highlights from the buffer.
11540 BEG and END are ignored. If NOREMOVE is nil, remove this function
11541 from the `before-change-functions' in the current buffer."
11551 "Clock out if the current entry contains the running clock.
11552 This is used to stop the clock after a TODO entry is marked DONE."
11557 org-clock-marker))
11558 ;; Clock out, but don't accept a logging message for this.
11562 org-log-done)))
11569 "Check if the current buffer contains the running clock.
11570 If yes, offer to stop it and to save the buffer with the changes."
11579 "Create a table containing a report about clocked time.
11580 If the buffer contains lines
11581 #+BEGIN: clocktable :maxlevel 3 :emphasize nil
11583 #+END: clocktable
11584 then the table will be inserted between these lines, replacing whatever
11585 is was there before. If these lines are not in the buffer, the table
11586 is inserted at point, surrounded by the special lines.
11587 The BEGIN line can contain parameters. Allowed are:
11588 :maxlevel The maximum level to be included in the table. Default is 3.
11589 :emphasize t/nil, if levell 1 and level 2 should be bold/italic in the table."
11598 "If this is a CLOCK line, update it and return t.
11599 Otherwise, return nil."
11608 ts te h m s)
11610 nil
11624 t)))))
11627 "Return two times bordering a special time range.
11628 Key is a symbol specifying the range and can be one of `today', `yesterday',
11629 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
11630 A week starts Monday 0:00 and ends Sunday 24:00.
11631 The range is determined relative to TIME. TIME defaults to the current time.
11632 The return value is a cons cell with two internal times like the ones
11633 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
11634 the returned times will be formatted strings."
11639 s1 m1 h1 d1 month1 y1 diff ts te fm)
11669 "Write the standard clocktable."
11673 ipos time h m p level hlc hdl maxlevel
11674 ts te cc block)
11689 ;; FIXME: does not yet use org-insert-time-stamp
11694 "]."
11723 hlc
11725 hlc
11734 "Return an internal list with clocking information.
11735 This list has one entry for each CLOCK interval.
11736 FIXME: describe the elements."
11740 rtn beg end next cont level title total closedp leafp
11741 clockpos titlepos h m donep)
11766 total title titlepos level leafp)
11767 rtn)
11771 ;;;; Agenda, and Diary Integration
11773 ;;; Define the Org-agenda-mode
11787 "Mode for time-sorted view on action items in Org-mode files.
11789 The following commands are available:
11795 org-agenda-pending-undo-list nil)
11805 org-agenda-show-log nil))
11812 "Restricted to single file"
11824 org-agenda-mode-map global-map)
11907 "--"
11914 "--"
11918 "--"
11922 "--"
11929 "--"
11941 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
11945 "--"
11947 "--"
11953 "--"
11955 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
11959 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
11962 "--"
11964 "--"
11967 ))
11969 ;;; Agenda undo
11981 "Execute BODY while recording undo information in two buffers."
11989 _c1 _c2)
11990 ,@_body
11997 ;; make sure there are undo boundaries
12000 ;; remember which buffer to undo
12002 org-agenda-undo-list)))))
12005 "Undo a remote editing step in the agenda.
12006 This undoes changes both in the agenda buffer and in the remote buffer
12007 that have been changed along."
12013 org-agenda-pending-undo-list org-agenda-undo-list))
12017 buf line cmd rembuf)
12025 buffer-read-only)
12039 "Verify that a real change occurred between the undo lists L1 and L2."
12044 ;;; Agenda dispatch
12051 ;;;###autoload
12053 "Dispatch agenda commands to collect entries to the agenda buffer.
12054 Prompts for a character to select a command. Any prefix arg will be passed
12055 on to the selected command. The default selections are:
12056 g
12057 a Call `org-agenda-list' to display the agenda for current day or week.
12058 t Call `org-todo-list' to display the global todo list.
12059 T Call `org-todo-list' to display the global todo list, select only
12060 entries with a specific TODO keyword (the user gets a prompt).
12061 m Call `org-tags-view' to display headlines with tags matching
12062 a condition (the user is prompted for the condition).
12063 M Like `m', but select only TODO entries, no ordinary headlines.
12064 l Create a timeeline for the current buffer.
12066 More commands can be added by configuring the variable
12067 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
12068 searches can be pre-defined in this way.
12070 If the current buffer is in Org-mode and visiting a file, you can also
12071 first press `1' to indicate that the agenda should be temporarily (until the
12079 c entry key type match lprops header)
12080 ;; Turn off restriction
12085 ;; Remember where this call originated
12093 "Press key for an agenda command:
12094 -------------------------------- C Configure custom agenda commands
12095 a Agenda for current week or day
12096 t List of all TODO entries T Entries with special TODO kwd
12097 m Match a TAGS query M Like m, but only TODO entries
12098 L Timeline for current buffer # List stuck projects (!=configure)
12105 header)))
12126 (org-add-props "1 Restrict call to current buffer 0 Restrict call to region or subtree" nil 'face 'org-table)))
12160 ;; For example the todo list should not need it (but does...)
12203 ;; FIXME: what is the meaning of WINDOW?????
12211 match ;; The byte compiler incorrectly complains about this. Keep it!
12212 cmd type lprops)
12238 ;;;###autoload
12240 "Run an agenda command in batch mode, send result to STDOUT.
12241 CMD-KEY is a string that is also a key in `org-agenda-custom-commands'.
12242 Paramters are alternating variable names and values that will be bound
12243 before running the agenda command."
12253 "Inhibit read-only for BODY."
12257 "Make sure current buffer is in org-mode. Error if not."
12260 major-mode)))
12263 "Fit the window to the buffer size."
12270 ;;; Agenda file list
12273 "Get the list of agenda files.
12274 Optional UNRESTRICTED means return the full list even if a restriction
12275 is currently in place."
12283 "Edit the list of agenda files.
12284 Depending on setup, this either uses customize to edit the variable
12285 `org-agenda-files', or it visits the file that is holding the list. In the
12286 latter case, the buffer is set up in a way that saving it automatically kills
12287 the buffer and restores the previous window configuration."
12306 "Set new value for the agenda file list and save it correcly."
12317 "Read the list of agenda files from a file."
12324 ;;;###autoload
12326 "Cycle through the files in `org-agenda-files'.
12327 If the current buffer visits an agenda file, find the next one in the list.
12328 If the current buffer does not, find the first agenda file."
12333 file)
12344 "Move/add the current file to the end of the agenda file list.
12345 If the file is not present in the list, it is appended to the list. If it is
12346 present, it is moved there."
12351 "Move/add the current file to the top of the agenda file list.
12352 If the file is not present in the list, it is added to the front. If it is
12353 present, it is moved there. With optional argument TO-END, add/move to the
12354 end of the list."
12360 x had)
12373 "Remove current file from the list of files in variable `org-agenda-files'.
12374 These are the files which are being checked for agenda entries.
12375 Optional argument FILE means, use this file instead of the current."
12384 nil x))
12397 "Make sure FILE exists. If not, ask user what to do."
12408 ;;; Agenda prepare and finalize
12444 "Finishing touch for the agenda buffer, called just before displaying it."
12456 "Create buffers for all agenda files, protect archived trees and comments."
12462 bmp file re)
12484 "Function to be called at each match during agenda construction.
12485 If this function return nil, the current match should not be skipped.
12486 Otherwise, the function must return a position from where the search
12487 should be continued.
12488 Never set this variable using `setq' or so, because then it will apply
12489 to all future agenda commands. Instead, bind it with `let' to scope
12493 "Throw to `:skip' in places that should be skipped."
12516 "Return a new agenda marker.
12517 Org-mode keeps a list of these markers and resets them when they are
12518 no longer in use."
12522 m))
12525 "Reset markers created by `org-agenda'. But only if they are old enough."
12528 org-agenda-last-marker-time)
12537 "Get a buffer visiting FILE. If the buffer needs to be created, add
12538 it to the list of buffers which might be released later."
12541 buf ; just return it
12542 ;; Make a new buffer and remember it
12545 buf)))
12548 "Release all buffers in list, asking the user for confirmation when needed.
12549 When a buffer is unmodified, it is just killed. When modified, it is saved
12550 \(if the user agrees) and then killed."
12555 file
12562 "Get the table of categories and positions in current buffer."
12568 tbl))
12571 "Get the category applying to position POS."
12587 org-category-table))))))
12588 ;;; Agenda timeline
12591 "Show a time-sorted view of the entries in the current org file.
12592 Only entries with a time stamp of today or later will be listed. With
12594 under the current date.
12595 If the buffer contains an active region, only check the region for
12596 dates."
12611 t doclosed ; always include today
12612 org-timeline-show-empty-dates))
12615 args
12616 s e rtn d emptyp)
12622 ;; Remove past dates from the list of dates.
12625 day-numbers))))
12638 dopast
12639 past)
12647 entry date args)))
12670 "Return a list of all relevant day numbers from BEG to END buffer positions.
12671 If NO-RANGES is non-nil, include only the start and end dates of a range,
12672 not every single day in the range. If FORCE-TODAY is non-nil, make
12673 sure that TODAY is included in the list. If INACTIVE is non-nil, also
12674 inactive time stamps (those in square brackets) are included.
12675 When EMPTY is non-nil, also include days without any entries."
12677 dates dates1 date day day1 day2 ts1 ts2)
12707 dates)))
12709 ;;; Agenda Daily/Weekly
12718 ;;;###autoload
12720 "Produce a weekly view from all files in variable `org-agenda-files'.
12721 The view will be for the current week, but from the overview buffer you
12722 will be able to go to other weeks.
12724 also be shown, under the current date.
12726 on the days are also shown. See the variable `org-log-done' for how
12727 to turn on logging.
12728 START-DAY defaults to TODAY, or to the most recent match for the weekday
12729 given in `org-agenda-start-on-weekday'.
12730 NDAYS defaults to `org-agenda-ndays'."
12743 nil org-agenda-start-on-weekday))
12751 sd
12759 s e rtn rtnall file date d start-pos end-pos todayp nd)
12762 ;; Make the list of days
12764 nd ndays)
12775 rtnall nil)
12800 rtnall nil)
12806 file date
12809 file date
12831 rtnall nd todayp))
12851 ;;; Agenda TODO list
12856 ;;;###autoload
12858 "Show all TODO entries from all agenda file in a single list.
12859 The prefix arg can be used to select a specific TODO keyword and limit
12861 for a keyword. A numeric prefix directly selects the Nth keyword in
12862 `org-todo-keywords'."
12876 rtn rtnall files file pos)
12880 nil t)))
12888 rtnall nil)
12906 "Available with `N r': (0)ALL "
12922 ;;; Agenda tags match
12924 ;;;###autoload
12926 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
12927 The prefix arg TODO-ONLY limits the search to TODO entries."
12935 rtn rtnall files file pos matcher
12936 buffer)
12944 rtnall nil)
12952 ;; If file does not exist, merror message to agenda
12964 org-agenda-restrict-end)
12990 ;;; Agenda Finding stuck projects
12993 "Regular expression used in skipping subtrees for the agenda.
12994 This is basically a temporary global variable that can be set and then
13001 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
13002 If yes, it returns the end position of this tree, causing agenda commands
13003 to skip this subtree. This is a function that can be put into
13004 `org-agenda-skip-function' for the duration of a command."
13007 skip)
13013 "Create agenda view for projects that are stuck.
13014 Stuck projects are project that have no next actions. For the definitions
13015 of what a project is and how to check if it stuck, customize the variable
13016 `org-stuck-projects'.
13017 MATCH is being ignored."
13041 ;;; Diary integration
13046 "Get the (Emacs Calendar) diary entries for DATE."
13053 entries
13063 ;; No entries
13065 ;; Omit the date and other unnecessary stuff
13067 ;; Add prefix to each line and extend the text properties
13079 ;; Extend the text properties to the beginning of the line
13081 entries)))))
13084 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
13085 This gets rid of the date, the underline under the date, and
13086 the dummy entry installed by `org-mode' to ensure non-empty diary for each
13087 date. It also removes lines that contain only whitespace."
13104 ;; Make sure entries from the diary have the right text properties.
13107 ;; We can rely on the hook, nothing to do
13108 nil
13109 ;; Hook not avaiable, must use advice to make this work
13111 "Make the position visible."
13114 buffer-file-name)
13118 "Add text properties to string, allowing org-mode to act on it."
13121 'keymap org-agenda-keymap
13124 'org-agenda-diary-link t
13128 "Add a dummy entry to the diary.
13129 Needed to avoid empty dates which mess up holiday display."
13130 ;; Catch the error if dealing with the new add-to-diary-alist
13137 ;;;###autoload
13139 "Return diary information from org-files.
13141 It accesses org files and extracts information from those files to be
13142 listed in the diary. The function accepts arguments specifying what
13143 items should be listed. The following arguments are allowed:
13145 :timestamp List the headlines of items containing a date stamp or
13146 date range matching the selected date. Deadlines will
13147 also be listed, on the expiration day.
13149 :deadline List any deadlines past due, or due within
13150 `org-deadline-warning-days'. The listing occurs only
13151 in the diary for *today*, not at any other date. If
13152 an entry is marked DONE, it is no longer listed.
13154 :scheduled List all items which are scheduled for the given date.
13155 The diary for *today* also contains items which were
13156 scheduled earlier and are not yet marked DONE.
13158 :todo List all TODO items from the org-file. This may be a
13159 long list - so this is not turned on by default.
13160 Like deadlines, these entries only show up in the
13161 diary for *today*, not at any other date.
13163 The call in the diary file should look like this:
13165 &%%(org-diary) ~/path/to/some/orgfile.org
13167 Use a separate line for each org file to check. Or, if you omit the file name,
13168 all files listed in `org-agenda-files' will be checked automatically:
13170 &%%(org-diary)
13172 If you don't give any arguments (as in the example above), the default
13173 arguments (:deadline :scheduled :timestamp) are used. So the example above may
13174 also be written as
13176 &%%(org-diary :deadline :timestamp :scheduled)
13178 The function expects the lisp variables `entry' and `date' to be provided
13179 by the caller, because this is how the calendar works. Don't use this
13180 function from a program - use `org-agenda-get-day-entries' instead."
13188 file rtn results)
13189 ;; If this is called during org-agenda, don't return any entries to
13190 ;; the calendar. Org Agenda will list these entries itself.
13198 ;;; Agenda entry finders
13201 "Does the work for `org-diary' and `org-agenda'.
13202 FILE is the path to a file to be checked for entries. DATE is date like
13203 the one returned by `calendar-current-date'. ARGS are symbols indicating
13204 which kind of entries should be extracted. For details about these, see
13205 the documentation of `org-diary'."
13213 arg results rtn)
13215 ;; If file does not exist, make sure an error message ends up in diary
13226 org-agenda-restrict-end)
13228 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
13250 results))))
13253 "Is the current entry marked DONE?"
13259 "Is the cursor inside a date range?"
13274 nil)))
13277 "Return the TODO information for agenda display."
13280 'org-not-done-regexp org-not-done-regexp
13282 'keymap org-agenda-keymap
13283 'help-echo
13290 org-not-done-regexp)
13294 marker priority category tags
13295 ee txt)
13315 priority
13335 "Return the date stamp information for agenda display."
13337 'org-not-done-regexp org-not-done-regexp
13339 'keymap org-agenda-keymap
13340 'help-echo
13350 marker hdmarker deadlinep scheduledp donep tmp priority category
13351 ee txt timestr tags)
13361 org-ds-keyword-length))
13368 scheduledp donep
13371 ;; substring should only run to end of time stamp
13405 "Return the logged TODO entries for agenda display."
13407 'org-not-done-regexp org-not-done-regexp
13408 'keymap org-agenda-keymap
13409 'help-echo
13421 marker hdmarker priority category tags closedp
13422 ee txt timestr)
13431 ;; donep (org-entry-is-done-p)
13432 )
13434 ;; substring should only run to end of time stamp
13457 "Return the deadline information for agenda display."
13460 'org-not-done-regexp org-not-done-regexp
13461 'keymap org-agenda-keymap
13462 'help-echo
13468 d2 diff pos pos1 category tags
13469 ee txt head face)
13478 ;; When to show a deadline in the calendar:
13479 ;; If the expiration is within wdays warning time.
13480 ;; Past-due deadlines are only shown on the current date
13506 'category category
13509 ee))
13512 "Return the scheduled information for agenda display."
13514 'org-not-done-regexp org-not-done-regexp
13518 'keymap org-agenda-keymap
13519 'help-echo
13525 d2 diff pos pos1 category tags donep
13526 ee txt head)
13535 ;; When to show a scheduled item in the calendar:
13536 ;; If it is on or past the date.
13552 category tags))))
13561 ee))
13564 "Return the date-range information for agenda display."
13566 'org-not-done-regexp org-not-done-regexp
13568 'keymap org-agenda-keymap
13569 'help-echo
13574 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos)
13586 ;; Only allow days between the limits, because the normal
13587 ;; date stamps will catch the limits.
13608 ;; Sort the entries by expiration date.
13611 ;;; Agenda presentation and sorting
13613 ;; FIXME: should I allow spaces around the dash?
13622 "Regular expression to match a plain time or time range.
13623 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
13624 groups carry important information:
13625 0 the full match
13626 1 the first time, range or not
13635 "Regular expression to match a timestamp time or time range.
13636 After a match, the following groups carry important information:
13637 0 the full match
13638 1 date plus weekday, for backreferencing to make sure both times on same day
13639 2 the first time, range or not
13643 "A flag, set by `org-compile-prefix-format'.
13646 "A flag, set by `org-compile-prefix-format'.
13650 noprefix)
13651 "Format TXT to be inserted into the agenda buffer.
13652 In particular, it adds the prefix and corresponding text properties. EXTRA
13653 must be a string and replaces the `%s' specifier in the prefix format.
13654 CATEGORY (string, symbol or nil) may be used to overrule the default
13655 category taken from local variable or file name. It will replace the `%c'
13656 specifier in the format. DOTIME, when non-nil, indicates that a
13657 time-of-day should be extracted from TXT for sorting of this entry, and for
13658 the `%t' specifier in the format. When DOTIME is a string, this string is
13659 searched for a time before TXT is. NOPREFIX is a flag and indicates that
13660 only the correctly processes TXT should be returned - this is used by
13661 `org-agenda-change-all-lines'. TAGS can be the tags of the headline."
13663 ;; Diary entries sometimes have extra whitespace at the beginning
13666 org-category
13672 time ;; needed for the eval of the prefix format
13675 stamp plain s0 s1 s2 rtn)
13677 ;; Extract starting and ending time and move them to prefix
13684 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
13685 ;; them, we might want to remove them there to avoid duplication.
13686 ;; The user can turn this off with a variable.
13691 t))
13693 ;; Normalize the time(s) to 24 hour
13698 ;; Tags are in the string
13701 org-prefix-has-tag))
13706 t t txt))))
13708 ;; Create the final string
13711 ;; Prepare the variables needed in the eval of the compiled format
13717 ;; Evaluate the compiled format
13720 ;; And finally add the text properties
13724 'time-of-day time-of-day
13739 list)))
13744 new time)
13746 ;; don't show empty grid
13752 nil string "" nil
13754 new)
13762 "Compile the prefix format into a Lisp form that can be evaluated.
13763 The resulting form is returned and stored in the variable
13764 `org-prefix-format-compiled'."
13768 org-agenda-prefix-format)
13773 varform vars var e c f opt)
13775 s start)
13788 ""
13798 ;; the old format
13806 "Check string S for a time of day.
13807 If found, return it as a military time number between 0 and 2400.
13808 If not found, return nil.
13809 The optional STRING argument forces conversion into a 5 character wide string
13810 HH:MM."
13835 "Sort and concatenate the agenda items."
13838 list
13856 x)))
13859 "Compare the priorities of string A and B."
13867 "Compare the string values of categories of strings A and B."
13875 "Compare the string values of categories of strings A and B."
13885 "Compare the time-of-day values of strings A and B."
13894 "Predicate for sorting agenda entries."
13895 ;; The following variables will be used when the form is evaluated.
13909 ;;; Agenda commands
13912 "Check if agenda buffer is of allowed type.
13913 If ERROR is non-nil, throw an error, otherwise just return nil."
13915 t
13918 nil)))
13921 "Exit agenda by removing the window or the buffer."
13927 ;; Maybe restore the pre-agenda window configuration.
13930 org-pre-agenda-window-conf
13934 "Exit agenda by removing the window or the buffer.
13935 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
13936 Org-mode buffers visited directly by the user will not be touched."
13943 "Save all Org-mode buffers without user confirmation."
13950 "Rebuild Agenda.
13951 When this is the global TODO list, a prefix argument will be interpreted."
13959 org-agenda-pending-undo-list nil)
13965 "Go to today."
13985 "Go forward in time by `org-agenda-ndays' days.
13986 With prefix ARG, go forward that many times `org-agenda-ndays'."
13992 nil t)))
13997 "Go back in time by `org-agenda-ndays' days.
13998 With prefix ARG, go back that many times `org-agenda-ndays'."
14004 nil t)))
14009 "Switch to weekly view for agenda."
14018 org-starting-day)
14019 nil t)))
14026 "Switch to daily view for agenda."
14035 org-starting-day)
14036 nil t)))
14043 "Jump to the next line indicating a date in agenda buffer."
14055 "Jump to the previous line indicating a date in agenda buffer."
14062 ;; Initialize the highlight
14067 "Highlight a region with overlay."
14072 "Detach overlay INDEX."
14077 "Toggle follow mode in an agenda buffer."
14085 "Toggle log mode in an agenda buffer."
14095 "Toggle diary inclusion in an agenda buffer."
14105 "Toggle time grid in an agenda buffer."
14115 "Set the mode name to indicate all the small mode settings."
14134 "Show the priority of the current item.
14135 This priority is composed of the main priority given with the [#A] cookies,
14136 and by additional input from the age of a schedules or deadline entry."
14142 "Show the tags applicable to the current item."
14151 "Go to the Org-mode file which contains the item at point."
14168 "Kill the entry or subtree belonging to the current agenda entry."
14200 "Kill the entry or subtree belonging to the current agenda entry."
14207 dbeg dend txt n conf)
14219 "Remove all lines in the agenda that correspond to a given subtree.
14220 The subtree is the one in buffer BUF, starting at BEG and ending at END.
14221 If this information is not given, the function uses the tree at point."
14244 "Follow the link in the current line, if any."
14255 "Go to the Org-mode file which contains the item at point."
14272 "Go to the Org-mode file which contains the item at the mouse click."
14278 "Display the Org-mode file which contains the item at point."
14285 "Display the Org-mode file which contains the item at point and recenter."
14293 "Display the Org-mode file which contains the item at the mouse click."
14299 "Check if the entry is a diary link and abort if yes."
14307 "Show the subtree corresponding to the current entry in an indirect buffer.
14308 This calls the command `org-tree-to-indirect-buffer' from the original
14309 Org-mode buffer.
14310 With numerical prefix arg ARG, go up to this level and then take that tree.
14311 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
14312 dedicated frame)."
14325 "Marker pointing to the headline that last changed its TODO state
14329 "Cycle TODO state of line at point, also in Org-mode file.
14330 This changes the line at point, all other lines in the agenda referring to
14331 the same tree node, and the headline of the tree node in the Org-mode file."
14341 newhead)
14362 "Change all lines in the agenda buffer which match HDMARKER.
14363 The new content of the line will be NEWHEAD (as modified by
14364 `org-format-agenda-item'). HDMARKER is checked with
14365 `equal' against all `org-hd-marker' text properties in the file.
14366 If FIXFACE is non-nil, the face of each item is modified acording to
14367 the new TODO state."
14369 props m pl undone-face done-face finish new dotime cat tags)
14399 undone-face done-face))))
14407 "Align all tags in agenda items to `org-agenda-align-tags-to-column'."
14421 "Increase the priority of line at point, also in Org-mode file."
14426 "Decrease the priority of line at point, also in Org-mode file."
14431 "Set the priority of line at point, also in Org-mode file.
14432 This changes the line at point, all other lines in the agenda referring to
14433 the same tree node, and the headline of the tree node in the Org-mode file."
14442 newhead)
14458 "Get a list of all headline tags applicable at POS.
14459 POS defaults to point. If tags are inherited, the list contains
14460 the targets in the same sequence as the headlines appear, i.e.
14461 the tags of the current headline come last."
14473 tags)))
14477 tags))
14479 ;; FIXME: should fix the tags property of the agenda line.
14481 "Set tags for the current headline."
14490 newhead)
14506 "Toggle the archive tag for the current entry."
14515 newhead)
14531 "Change the date of this item to one day later."
14550 "Change the date of this item to one day earlier."
14555 "Show new date stamp via text properties."
14556 ;; We use text properties to make this undoable
14558 ovs ov)
14566 ;; Use `duplicable' property to trigger undo recording
14581 "Change the date of this item. Date is prompted for, with default today.
14582 The prefix ARG is passed to the `org-time-stamp' command and can therefore
14583 be used to request time specification in the time stamp."
14601 "Schedule the item at point."
14610 ts)
14619 "Schedule the item at point."
14628 ts)
14637 "Return the heading of the current entry, without the stars."
14646 "Start the clock on the currently selected item."
14659 "Stop the currently running clock."
14667 "Cancel the currently running clock."
14675 "Make a diary entry, like the `i' command from the calendar.
14676 All the standard commands work: block, weekly etc."
14692 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
14701 ;; We implement this by hacking the `calendar-cursor-to-date' function
14702 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
14718 "Execute a calendar command from the agenda, with the date associated to
14719 the cursor position."
14741 "Display the phases of the moon for the 3 months around the cursor date."
14746 "Display the holidays for the 3 months around the cursor date."
14751 "Display sunrise and sunset for the cursor date.
14752 Latitude and longitude can be specified with the variables
14753 `calendar-latitude' and `calendar-longitude'. When called with prefix
14754 argument, latitude and longitude will be prompted for."
14763 "Open the Emacs calendar with the date at the cursor."
14776 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
14777 This is a command that has to be installed in `calendar-mode-map'."
14781 nil))
14787 date s)
14812 ;;;; Embedded LaTeX
14827 "Toggle the minor `org-cdlatex-mode'.
14828 This mode supports entering LaTeX environment and math in LaTeX fragments
14829 in Org-mode.
14831 nil " OCDL" nil
14836 "Always return t in org-mode buffers.
14837 This is because we want to insert math symbols without dollars even outside
14838 the LaTeX math segments. If Orgmode thinks that point is actually inside
14839 en embedded LaTeX fragement, let texmathp do its job.
14856 "Unconditionally turn on `org-cdlatex-mode'."
14860 "Test if point is inside a LaTeX fragment.
14862 sequence appearing also before point.
14863 Even though the matchers for math are configurable, this function assumes
14865 delimiters are skipped when they have been removed by customization.
14866 The return value is nil, or a cons cell with the delimiter and
14867 and the position of this delimiter.
14869 This function does a reasonably good job, but can locally be fooled by
14870 for example currency specifications. For example it will assume being in
14872 fragments that are properly closed, but during editing, we have to live
14873 with the uncertainty caused by missing closing delimiters. This function
14874 looks only before point, not after."
14893 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
14897 ;; count $$
14905 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
14906 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
14907 - inside a LaTeX fragment, or
14908 - after the first word in a line, where an abbreviation expansion could
14909 insert a LaTeX environment."
14922 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
14923 Revert to the normal definition outside of these fragments."
14931 "Execute `cdlatex-math-modify' in LaTeX fragments.
14932 Revert to the normal definition outside of these fragments."
14944 "Remove all overlays with LaTeX fragment images in current buffer."
14949 "Preview the LaTeX fragment at point, or all locally or globally.
14950 If the cursor is in a LaTeX fragment, create the image and overlay
14951 it over the source code. If there is no fragment at point, display
14952 all fragments in the current text, from one headline to the next. With
14953 prefix SUBTREE, display all fragments in the current subtree. With a
14954 double prefix `C-u C-u', or when the cursor is before the first headline,
14955 display all fragments in the buffer.
14984 buffer-file-name)))
14990 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
14991 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
14992 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
14999 "Replace LaTeX fragments with links to an image, and produce images."
15008 m n block linkfile movefile ov)
15009 ;; Make sure the directory exists
15011 ;; Check if there are old images files with this prefix, and remove them
15013 todir 'full
15016 ;; Check the different regular expressions
15033 txt movefile opt)
15041 ov 'end-glyph
15044 ov 'display
15051 ;; This function borrows from Ganesh Swami's latex2png.el
15055 temporary-file-directory))
15059 ;(texfilebase (make-temp-file "orgtex"))
15060 ; (dummy (delete-file texfilebase))
15089 "-o" pngfile
15090 dvifile)
15093 ;; Use the requested file name and clean up
15097 pngfile))))
15099 ;;;; Exporting
15101 ;;; Variables, constants, and parameter plists
15146 "Return the property list with default settings for the export variables."
15150 rtn))
15153 "Return the property list with file-local settings for export."
15158 p key val text options)
15183 o)
15187 options)
15191 p)))
15194 "Create a single property list from all plists in PLISTS.
15195 The process starts by copying the last list, and then setting properties
15196 from the other lists. Settings in the first list are the most significant
15197 ones and overrule settings in the other lists."
15199 p v ls)
15205 rtn))
15211 val)))
15212 dir))
15215 "Remove all lines from LIST which are before the first headline."
15227 rtn line level)
15232 ;; Beginning of a COMMENT subtree. Skip it.
15238 ;; an ordinary comment line
15239 )
15245 ;; a special table line that should be removed
15246 )
15253 \[v] limit export to visible part of outline tree
15255 \[a] export as ASCII
15256 \[h] export as HTML
15257 \[b] export as HTML and browse immediately
15258 \[x] export as XOXO
15260 \[i] export current file as iCalendar file
15261 \[I] export all agenda files as iCalendar files
15262 \[c] export agenda files into combined iCalendar file
15264 \[F] publish current file
15265 \[P] publish current project
15266 \[X] publish... (project will be prompted for)
15282 r1 r2 ass)
15583 )
15584 "Entities for TeX->HTML translation.
15588 The list contains HTML entities for Latin-1, Greek and other symbols.
15589 It is supplemented by a number of commonly used TeX macros with appropriate
15592 ;;; General functions for all backends
15595 "Cleanup a buffer substring so that links can be created safely."
15602 rtn)
15610 ;; Get rid of archived trees
15621 ;; Find targets in comments and move them out of comments,
15622 ;; but mark them as targets that should be invisible
15627 ;; Remove comments
15632 ;; Find matches for radio targets and turn them into internal links
15638 ;; Find all links that contain a newline and put them into a single line
15640 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
15644 ;; Convert LaTeX fragments to images
15649 org-current-export-file)))
15653 ;; Normalize links: Convert angle and plain links into bracket links
15654 ;; Expand link abbreviations
15660 t t))
15666 t t))
15672 "]"
15677 t t))
15679 ;; Find multiline emphasis and put them into single line
15688 rtn))
15691 "Take link text and make a safe target out of it."
15695 'identity
15700 ;; Variable holding the vector with section numbers
15704 "Initialize the vector for the section numbers."
15721 "Return a string with the current section number.
15722 When LEVEL is non-nil, increase section numbers on that level."
15744 string))
15746 ;;; ASCII export
15753 "Export the outline as a pretty ASCII file.
15754 If there is an active region, export only the region.
15755 The prefix ARG specifies how many levels of the outline should become
15756 underlined headlines. The default is 3."
15810 ;; create local variables for all options, to make sure all called
15811 ;; functions get the correct information
15815 org-export-plist-vars)
15818 org-export-headline-levels))
15820 ;; File header
15839 line)
15840 ;; This is a headline
15845 todo
15849 org-done-string)))
15850 ; TODO, not DONE
15854 line lines level))))
15872 ))))
15873 lines)))
15877 ;; Remove the quoted HTML tags.
15879 ;; Remove targets
15882 ;; Replace internal links
15886 t nil line)))
15891 ;; a Headline
15899 ;; remove display and invisible chars
15915 "Search the subtree below LINE for any TODO entries."
15918 line lv todo)
15926 org-done-string))))
15927 ; TODO, not DONE
15932 "Handle quoted HTML for ASCII export."
15935 ;; We just remove the tags for now.
15937 line)
15940 "Insert the string S centered and underline it with character UNDERLINE."
15949 "Insert a new level in ASCII export."
15955 org-export-ascii-bullets))
15957 ;; find the indentation of the next non-empty line
15978 "Create a copy of the visible part of the current buffer, and export it.
15979 The copy is created in a temporary buffer and removed after use.
15980 TYPE is the final key (as a string) that also select the export command in
15981 the `C-c C-e' export dispatcher.
15982 As a special case, if the you type SPC at the prompt, the temporary
15983 org-mode file will not be removed but presented to you so that you can
15984 continue to use it. The prefix arg ARG is passed through to the exporting
15985 command."
15990 current-prefix-arg))
16003 s e)
16013 ;; Copy all comment lines to the end, to make sure #+ settings are
16014 ;; still available for the second export step. Kind of a hack, but
16015 ;; does do the trick.
16036 s))
16041 s))
16043 ;;; HTML export
16046 "Return a string with current options as keyword options.
16047 Does include HTML export options as well as TODO and CATEGORY stuff."
16049 "#+TITLE: %s
16050 #+AUTHOR: %s
16051 #+EMAIL: %s
16052 #+LANGUAGE: %s
16053 #+TEXT: Some descriptive text to be emitted. Several lines OK.
16055 #+CATEGORY: %s
16056 #+SEQ_TODO: %s
16057 #+TYP_TODO: %s
16058 #+STARTUP: %s %s %s %s %s %s
16059 #+TAGS: %s
16060 #+ARCHIVE: %s
16061 #+LINK: %s
16062 "
16064 org-export-headline-levels
16065 org-export-with-section-numbers
16066 org-export-with-toc
16067 org-export-preserve-breaks
16068 org-export-html-expand
16069 org-export-with-fixed-width
16070 org-export-with-tables
16071 org-export-with-sub-superscripts
16072 org-export-with-emphasize
16073 org-export-with-TeX-macros
16074 org-export-with-LaTeX-fragments
16100 org-archive-location
16101 "org file:~/org/%s.org"
16102 ))
16105 "Insert into the buffer a template with information for exporting."
16114 "Toggle the fixed-width export.
16115 If there is no active region, the QUOTE keyword at the current headline is
16116 inserted or removed. When present, it causes the text between this headline
16117 and the next to be exported as fixed-width text, and unmodified.
16118 If there is an active region, this command adds or removes a colon as the
16119 first character of this line. If the first character of a line is a colon,
16120 this line is also exported in fixed-width font."
16128 off)
16158 "Export the outline as HTML and immediately open it with a browser.
16159 If there is an active region, export only the region.
16160 The prefix ARG specifies how many levels of the outline should become
16161 headlines. The default is 3. Lower levels will become bulleted lists."
16167 "Call `org-export-as-html', may be used in batch processing as
16168 emacs --batch
16169 --load=$HOME/lib/emacs/org.el
16171 --visit=MyFile --funcall org-export-as-html-batch"
16175 "Export the outline as a pretty HTML file.
16176 If there is an active region, export only the region.
16177 The prefix ARG specifies how many levels of the outline should become
16178 headlines. The default is 3. Lower levels will become bulleted lists.
16179 When HIDDEN is non-nil, don't display the HTML buffer.
16180 EXT-PLIST is a property list with external parameters overriding
16181 org-mode's default settings, but still inferior to file-local settings."
16189 ext-plist
16194 valid
16201 ;; The following two are dynamically scoped into other
16202 ;; routines below.
16208 region :emph-multiline
16245 buffer-file-coding-system))
16251 table-open type
16252 table-buffer table-orig-buffer
16253 ind start-is-num starter
16254 rpl path desc descp desc1 desc2 link
16255 )
16261 ;; Get the language-dependent settings
16265 ;; Switch to the output buffer
16273 ;; create local variables for all options, to make sure all called
16274 ;; functions get the correct information
16278 org-export-plist-vars)
16280 org-export-headline-levels))
16282 ;; File header
16288 <head>
16289 <title>%s</title>
16294 %s
16295 </head><body>
16296 "
16298 date time author style))
16311 org-export-html-toplevel-hlevel
16313 org-export-html-toplevel-hlevel))
16318 ;; This is a headline
16326 todo
16330 org-done-string)))
16331 ; TODO, not DONE
16335 line lines level))))
16359 ;; Check for targets
16364 t t line))
16367 target-alist))
16375 head-count txt))
16378 )))
16379 line)
16380 lines))
16384 ))
16391 ;; end of quote section?
16395 ;; inside a quote section?
16400 ;; verbatim lines
16415 ;; make targets to anchors
16423 t t line)))
16427 ; (concat "@<i>" (match-string 1 line) "@</i> ")
16428 t t line)))
16434 t t line)))))
16438 ;; replace "&" by "&", "<" and ">" by "<" and ">"
16439 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
16440 ;; Also handle sub_superscripts and checkboxes
16443 ;; Format the links
16453 ;; Make an image out of the description if that is so wanted
16459 ;; FIXME: do we need to unescape here somewhere?
16468 ;; standard URL, just check if we need to inline an image
16476 ;; standard URL
16480 ;; FILE link
16483 thefile file-is-image-p search)
16491 t))
16500 ;; make sure this is can be used as target search
16524 ;; TODO items
16536 ;; This is a headline
16543 ;; Close any local lists before inserting a new header line
16549 in-local-list nil))
16552 head-count)
16553 ;; QUOTES
16561 ;; New table starts
16563 ;; Accumulate lines
16575 ;; Normal lines
16578 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
16579 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
16582 line)
16589 ;; empty line. Pretend indentation is large.
16603 ;; Start new (level of ) list
16610 ;; continue current list
16617 "<b>[X]</b>"
16619 t t line))))
16621 ;; Empty lines start a new paragraph. If hand-formatted lists
16622 ;; are not fully interpreted, lines starting with "-", "+", "*"
16623 ;; also start a new paragraph.
16626 ;; Check if the line break needs to be conserved
16635 ;; Properly close all local lists and other lists
16638 ;; Close any local lists before inserting a new header line
16644 in-local-list nil))
16647 head-count)
16667 ;; remove empty paragraphs and lists
16680 "Find out which HTML converter to use and return the HTML code."
16682 ;; A normal org table
16684 ;; Table made by table.el - test for spanning
16688 nil))
16689 lines)))
16695 hlines))))
16698 ;; We can use my own converter with HTML conversions
16700 ;; Need to use the code generator in table.el, with the original text.
16704 "Format a table into HTML."
16710 ;; Check if the table has a marking column. If yes remove the
16711 ;; column and the special lines
16719 lines)))))
16726 nil ; ignore this line
16730 lines))))))
16736 line fields html)
16743 ;; ignore this line
16745 ;; Break the line into fields
16748 html
16749 "<tr>"
16757 html))
16767 newstr))
16770 "Format a table generated by table.el into HTML.
16771 This conversion does *not* use `table-generate-source' from table.el.
16772 This has the advantage that Org-mode's HTML conversions can be used.
16773 But it has the disadvantage, that no cell- or row-spanning is allowed."
16776 fields html empty)
16786 html
16787 "<tr>"
16798 ;; Ignore this line
16800 ;; Break the line into fields and store the fields
16806 field-buffer))
16809 html))
16812 "Format a table into html, using `table-generate-source' from table.el.
16813 This has the advantage that cell- or row-spanning is allowed.
16814 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
16829 "Format time stamps in string S, or remove them."
16834 ;; never export CLOCK
16849 ;; Line break if line started and ended with time stamp stuff
16851 s
16855 r))))
16858 ;; convert & to &, < to < and > to >
16867 s)
16870 "Remove tags and time staps from lines going into the toc."
16876 s)
16879 "Prepare STRING for HTML export. Applies all active conversions.
16880 If there are links in the string, don't modify these."
16892 "Apply all active conversions to translate special ASCII to HTML."
16908 t t s))
16910 s)
16913 "Create a regular expression which will match a balanced sexp.
16914 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
16915 as single character strings.
16916 The regexp returned will match the entire expression including the
16917 delimiters. It will also define a single group which contains the
16918 match except for the outermost delimiters. The maximum depth of
16919 stacked delimiters is N. Escaping delimiters is not possible."
16941 "Convert sub- and superscripts in STRING to HTML."
16951 t t string)))
16954 string)
16957 "Apply emphasis."
16959 (setq string (replace-match (concat "\\1" (nth 2 (assoc (match-string 3 string) org-emphasis-alist)) "\\4" (nth 3 (assoc (match-string 3 string) org-emphasis-alist)) "\\5") t nil string)))
16960 string)
16964 "Insert <p>, but first close previous paragraph if any."
16969 "Close paragraph if there is one open."
16974 "Close <li> if necessary."
16977 ; (when (save-excursion
16978 ; (re-search-backward "</?\\(ul\\|ol\\|li\\|[hH][0-9]\\)>" nil t))
16979 ; (if (member (match-string 0) '("</ul>" "</ol>" "<li>"))
16980 ; (insert "</li>"))))
16983 "Insert a new level in HTML export.
16984 When TITLE is nil, just close all open levels."
16994 ;; If title is nil, this means this function is called to close
16995 ;; all levels, so the rest is done only if title is given
17007 t t title)))
17022 level head-count title level))
17027 "Terminate one level in HTML export."
17031 ;;; iCalendar export
17033 ;;;###autoload
17035 "Export current file as an iCalendar file.
17036 The iCalendar file will be located in the same directory as the Org-mode
17037 file, but with extension `.ics'."
17041 ;;;###autoload
17043 "Export all files in `org-agenda-files' to iCalendar .ics files.
17044 Each iCalendar file will be located in the same directory as the Org-mode
17045 file, but with extension `.ics'."
17049 ;;;###autoload
17051 "Export all files in `org-agenda-files' to a single combined iCalendar file.
17052 The file is stored under the name `org-combined-agenda-icalendar-file'."
17057 "Create iCalendar files for all elements of FILES.
17058 If COMBINE is non-nil, combine all calendar entries into a single large
17059 file and store it under the name `org-combined-agenda-icalendar-file'."
17063 org-export-publishing-directory)))
17064 file ical-file ical-buffer category started org-agenda-new-buffers)
17069 org-combined-agenda-icalendar-file
17102 "Hook run after an iCalendar file has been saved.
17103 The iCalendar buffer is still current when this hook is run.
17104 A good way to use this is to tell a desktop calenndar application to re-read
17108 ;; FIXME: Strip down the links
17110 "Print iCalendar entries for the current Org-mode file to `standard-output'.
17111 When COMBINE is non nil, add the category to each line."
17122 inc t
17131 pos)
17134 ;; donep (org-entry-is-done-p)
17135 ))
17142 t t hd)))
17146 %s
17147 %s
17148 SUMMARY:%s
17149 CATEGORIES:%s
17153 hd category)))
17169 %s
17170 SUMMARY:%s
17171 CATEGORIES:%s
17172 SEQUENCE:1
17173 PRIORITY:%d
17175 dts hd category pri))))))))
17178 "Start an iCalendar file by inserting the header."
17184 VERSION:2.0
17185 X-WR-CALNAME:%s
17186 PRODID:-//%s//Emacs with Org-mode//EN
17187 X-WR-TIMEZONE:%s
17191 "Finish an iCalendar file by inserting the END statement."
17195 "Take a time string S and convert it to iCalendar format.
17196 KEYWORD is added in front, to make a complete line like DTSTART....
17197 When INC is non-nil, increase the hour by two (if time string contains
17198 a time), or the day by one (if it does not contain a time)."
17200 t2 fmt have-time time)
17212 ;;; XOXO export
17220 "Export the org buffer as XOXO.
17221 The XOXO buffer is named *xoxo-<source buffer name>*"
17223 ;; A quickie abstraction
17225 ;; Output everything as XOXO
17238 ;; Check the output buffer is empty.
17240 ;; Kick off the output
17257 ;; Handle level rendering
17274 )
17278 ;; And output the new li
17284 ;; Finally finish off the ol
17290 ;; Finish the buffer off and clean it up.
17295 )))
17298 ;;;; Key bindings
17300 ;; - Bindings in Org-mode map are currently
17301 ;; 0123456789abcdefghijklmnopqrstuvwxyz!?@#$%^&-+*/=()_{}[]:;"|,.<>~`'\t the alphabet
17302 ;; abcd fgh j lmnopqrstuvwxyz!? #$ ^ -+*/= [] ; |,.<>~ '\t necessary bindings
17303 ;; e (?) useful from outline-mode
17304 ;; i k @ expendable from outline-mode
17305 ;; 0123456789 % & ()_{} " ` free
17307 ;; Make `C-c C-x' a prefix key
17310 ;; TAB key with modifiers
17316 ;; The following line is necessary under Suse GNU/Linux
17325 ;; Cursor keys with modifiers
17341 ;;; Extra keys for tty access.
17342 ;; We only set them when really needed because otherwise the
17343 ;; menus don't show the simple keys
17368 ;; All the other keys
17441 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17442 If the cursor is in a table looking at whitespace, the whitespace is
17443 overwritten, and the table is not marked as requiring realignment."
17447 ;; check if we blank the field, and if that triggers align
17452 ;; got extra space, this field does not determine column width
17454 ;; no extra space, this field may determine column width
17456 t)
17468 "Like `delete-backward-char', insert whitespace at field end in tables.
17469 When deleting backwards, in tables this function will insert whitespace in
17471 still be marked for re-alignment if the field did fill the entire column,
17472 because, in this case the deletion might narrow the column."
17485 ;; noalign: if there were two spaces at the end, this field
17486 ;; does not determine the width of the column.
17491 "Like `delete-char', but insert whitespace at field end in tables.
17492 When deleting characters, in tables this function will insert whitespace in
17494 still be marked for re-alignment if the field did fill the entire column,
17495 because, in this case the deletion might narrow the column."
17509 ;; noalign: if there were two spaces at the end, this field
17510 ;; does not determine the width of the column.
17515 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17521 ;; How to do this: Measure non-white length of current string
17522 ;; If equal to column width, we should realign.
17525 "In MAP, remap the functions given in COMMANDS.
17526 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17535 ;; If the user wants maximum table support, we need to hijack
17536 ;; some standard editing functions
17544 "Throw an error because Shift-Cursor command was applied in wrong context."
17548 "Global visibility cycling or move to previous table field.
17549 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17550 on context.
17551 See the individual commands for more information."
17558 "Promote subtree or delete table column.
17559 Calls `org-promote-subtree' or `org-table-delete-column', depending on context.
17560 See the individual commands for more information."
17569 "Demote subtree or insert table column.
17570 Calls `org-demote-subtree' or `org-table-insert-column', depending on context.
17571 See the individual commands for more information."
17580 "Move subtree up or kill table row.
17581 Calls `org-move-subtree-up' or `org-table-kill-row' or
17582 `org-move-item-up' depending on context. See the individual commands
17583 for more information."
17591 "Move subtree down or insert table row.
17592 Calls `org-move-subtree-down' or `org-table-insert-row' or
17593 `org-move-item-down', depending on context. See the individual
17594 commands for more information."
17603 "Promote heading or move table column to left.
17604 Calls `org-do-promote' or `org-table-move-column', depending on context.
17605 With no specific context, calls the Emacs default `backward-word'.
17606 See the individual commands for more information."
17616 "Demote subtree or move table column to right.
17617 Calls `org-do-demote' or `org-table-move-column', depending on context.
17618 With no specific context, calls the Emacs default `forward-word'.
17619 See the individual commands for more information."
17629 "Move subtree up or move table row up.
17630 Calls `org-move-subtree-up' or `org-table-move-row' or
17631 `org-move-item-up', depending on context. See the individual commands
17632 for more information."
17641 "Move subtree down or move table row down.
17642 Calls `org-move-subtree-down' or `org-table-move-row' or
17643 `org-move-item-down', depending on context. See the individual
17644 commands for more information."
17653 "Increase item in timestamp or increase priority of current headline.
17654 Calls `org-timestamp-up' or `org-priority-up', depending on context.
17655 See the individual commands for more information."
17664 "Decrease item in timestamp or decrease priority of current headline.
17665 Calls `org-timestamp-down' or `org-priority-down', depending on context.
17666 See the individual commands for more information."
17674 "Next TODO keyword or timestamp one day later, depending on context."
17682 "Previous TODO keyword or timestamp one day earlier, depending on context."
17690 "Copy region in table or copy current subtree.
17691 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17692 See the individual commands for more information."
17698 "Cut region in table or cut current subtree.
17699 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17700 See the individual commands for more information."
17706 "Paste rectangular region into table, or past subtree relative to level.
17707 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17708 See the individual commands for more information."
17715 "Set tags in headline, or update according to changed information at point.
17717 This command does many different things, depending on context:
17719 - If the cursor is in a headline, prompt for tags and insert them
17720 into the current line, aligned to `org-tags-column'. When called
17721 with prefix arg, realign all tags in the current buffer.
17723 - If the cursor is in one of the special #+KEYWORD lines, this
17724 triggers scanning the buffer for these lines and updating the
17725 information.
17727 - If the cursor is inside a table, realign the table. This command
17728 works even if the automatic table editor has been turned off.
17730 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17731 the entire table.
17733 - If the cursor is inside a table created by the table.el package,
17734 activate that table.
17736 - If the current buffer is a remember buffer, close note and file it.
17737 with a prefix argument, file it without further interaction to the default
17738 location.
17740 - If the cursor is on a <<<target>>>, update radio targets and corresponding
17741 links in this buffer.
17743 - If the cursor is on a numbered item in a plain list, renumber the
17744 ordered list."
17749 org-occur-highlights
17750 org-latex-fragment-image-overlays)
17778 ;; Recalculate the table before this line
17789 "Restart Org-mode, to scan again for special lines.
17790 Also updates the keyword regular expressions."
17796 "Goto next table row or insert a newline.
17797 Calls `org-table-next-row' or `newline', depending on context.
17798 See the individual commands for more information."
17807 "Insert a new heading or wrap a region in a table.
17808 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17809 See the individual commands for more information."
17816 ;;; Menu entries
17818 ;; Define the Org-mode menus
17825 "--"
17829 "--"
17835 "--"
17836 ["Enable Narrowing" (setq org-table-limit-column-width (not org-table-limit-column-width)) :active (org-at-table-p) :selected org-table-limit-column-width :style toggle])
17843 "--"
17850 "--"
17853 ["Set Named Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17855 "--"
17857 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17859 "--"
17866 "--"
17868 org-enable-table-editor)]
17872 "--"
17883 "--"
17885 "--"
17893 "--"
17898 "--"
17902 "--"
17907 "--"
17909 "--"
17926 "--"
17930 "--"
17939 "--"
17943 "--"
17944 ; ["Insert Checkbox" org-insert-todo-heading (org-in-item-p)]
17945 ; ["Toggle Checkbox" org-ctrl-c-ctrl-c (org-at-item-checkbox-p)]
17946 ; ["Insert [n/m] cookie" (progn (insert "[/]") (org-update-checkbox-count))
17947 ; (or (org-on-heading-p) (org-at-item-p))]
17948 ; ["Insert [%] cookie" (progn (insert "[%]") (org-update-checkbox-count))
17949 ; (or (org-on-heading-p) (org-at-item-p))]
17950 ; ["Update Statistics" org-update-checkbox-count t]
17951 )
17963 "--"
17966 "--"
17975 "--"
17979 org-done-string
17982 "--"
17990 "--"
17995 "--"
18003 "--"
18015 "--"
18021 "--"
18024 "--"
18026 ))
18038 "Read documentation for Org-mode in the info system.
18039 With optional NODE, go directly to that node."
18062 ;;;; Documentation
18065 "Call the customize function with org as argument."
18070 "Create a full customization menu for Org-mode, insert it into the menu."
18077 "--"
18087 ;;;; Miscellaneous stuff
18090 ;;; Generally useful functions
18093 "Return a list of contexts of the current cursor position.
18094 If several contexts apply, all are returned.
18095 Each context entry is a list with a symbol naming the context, and
18096 two positions indicating start and end of the context. Possible
18097 contexts are:
18099 :headline anywhere in a headline
18100 :headline-stars on the leading stars in a headline
18101 :todo-keyword on a TODO keyword (including DONE) in a headline
18102 :tags on the TAGS in a headline
18103 :priority on the priority cookie in a headline
18104 :item on the first line of a plain list item
18105 :item-bullet on the bullet/number of a plain list item
18106 :checkbox on the checkbox in a plain list item
18107 :table in an org-mode table
18108 :table-special on a special filed in a table
18109 :table-table in a table.el table
18110 :link on a hyperline
18111 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18112 :target on a <<target>>
18113 :radio-target on a <<<radio-target>>>
18114 :latex-fragment on a LaTeX fragment
18115 :latex-preview on a LaTeX fragment with overlayed preview image
18117 This function expects the position to be visible because it uses font-lock
18118 faces as a help to recognize the following contexts: :table-special, :link,
18119 and :keyword."
18123 ;; First the large context
18142 clist)
18156 ;; Now the small context
18184 ;; FIXME: positions wrong.
18188 clist))
18191 "Check if POINT is in match-group GROUP.
18192 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18193 match. If the match group does ot exist or point is not inside it,
18194 return nil."
18200 t)))
18203 "Move the current line down. With prefix argument, move it past ARG lines."
18206 beg end pos)
18216 "Move the current line up. With prefix argument, move it past ARG lines."
18219 beg end pos)
18229 ;; FIXME: document and make safer
18237 string))
18239 ;;; Paragraph filling stuff.
18240 ;; We want this to be just right, so use the full arsenal.
18241 ;; FIXME: configure filladapt for XEmacs
18245 ;; In the paragraph separator we include headlines, because filling
18246 ;; text in a line directly attached to a headline would otherwise
18247 ;; fill the headline as well.
18250 ;; The paragraph starter includes hand-formatted lists.
18253 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18254 ;; But only if the user has not turned off tables or fixed-width regions
18256 'auto-fill-inhibit-regexp
18265 ;; We use our own fill-paragraph function, to make sure that tables
18266 ;; and fixed-width regions are not wrapped. That function will pass
18267 ;; through to `fill-paragraph' when appropriate.
18269 ; Adaptive filling: To get full control, first make sure that
18270 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18276 "Re-align a table, pass through to fill-paragraph if no table."
18284 ;; For reference, this is the default value of adaptive-fill-regexp
18285 ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
18288 "Return a fill prefix for org-mode files.
18289 In particular, this makes sure hanging paragraphs for hand-formatted lists
18290 work correctly."
18299 "Return regexp matching the file names of images."
18307 image-file-name-extensions)
18308 image-file-name-extensions)
18309 t)
18313 "Return non-nil if FILE is an image."
18317 ;;;; Functions extending outline functionality
18319 ;; C-a should go to the beginning of a *visible* line, also in the
18320 ;; new outline.el. I guess this should be patched into Emacs?
18322 "Go to the beginning of the current line. If that is invisible, continue
18323 to a visible line beginning. This makes the function of C-a more intuitive."
18327 nil
18338 "Check if point is at a character currently not visible."
18339 ;; Early versions of noutline don't have `outline-invisible-p'.
18345 "Check if point is at a character currently not visible."
18348 ;; Early versions of noutline don't have `outline-invisible-p'.
18367 "Move to the heading line of which the present line is a subheading.
18368 This function considers both visible and invisible heading lines.
18369 With argument, move up ARG levels."
18375 "Goto the next sibling, even if it is invisible.
18376 When PREVIOUS is set, go to the previous sibling instead. Returns t
18377 when a sibling was found. When none is found, return nil and don't
18378 move point."
18382 level l)
18392 nil)))
18395 "Show all siblings of the current headline."
18403 "Show an entry where even the heading is hidden."
18408 "Flag the current heading. FLAG non-nil means make invisible.
18409 When ENTRY is non-nil, show the entire entry."
18412 ;; Check if we should show the entire entry
18421 flag))))
18424 ;; This is an exact copy of the original function, but it uses
18425 ;; `org-back-to-heading', to make it work also in invisible
18426 ;; trees. And is uses an invisible-OK argument.
18427 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
18437 ;; Go to end of line before heading
18440 ;; leave blank line before heading
18445 "Show everything after this heading at deeper levels."
18450 nil))
18453 "Show the body directly following this heading.
18454 Show the heading too, if it is currently invisible."
18463 nil)))
18466 "Make a regular expression for keyword lines."
18468 "^"
18474 ;; Make isearch reveal the necessary context
18476 "Reveal context after isearch exits."
18479 ;; Under XEmacs, the hook is run in the correct place,
18480 ;; we directly show the context.
18482 ;; In Emacs the hook runs *before* restoring the overlays.
18483 ;; So we have to use a one-time post-command-hook to do this.
18484 ;; (Emacs 22 has a special variable, see function `org-mode')
18486 isearch-mode-end-hook-quit)
18487 ;; Only when the isearch was not quitted.
18492 "Remove self from hook, and show context."
18496 ;;;; Repair problems with some other packages
18498 ;; Make `bookmark-jump' show the jump location if it was hidden.
18501 ;; We can use the hook
18503 ;; Hook not available, use advice
18505 "Make the position visible."
18509 "Unhide the current position, to show the bookmark location."
18516 ;; Make session.el ignore our circular variable
18520 ;;;; Experimental code
18523 "Check if the current headline contains a REPEAT key.
18524 If yes, set TODO state back to what it was and change any SCHEDULED
18525 or DEADLINE times the new date.
18526 This function should be run in the `org-after-todo-state-change-hook'."
18527 ;; last-state is dynamically scoped into this function
18532 re type n what start)
18535 last-state
18554 ;;;; Finish up
18560 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
18561 ;;; org.el ends here