| blob | b9dbc6a0fe9c329a620f4b41b9c911f23c519e8c |
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.48
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.48
65 ;; - Agenda views can be made in batch mode from the command line.
66 ;; - `org-store-link' does the right thing in dired-mode.
67 ;; - File links can contain environment variables (thanks to Ed Hirgelt).
68 ;; - Full Emacs 21 compatibility has been restored.
69 ;; - Bug fixes.
70 ;;
71 ;; Version 4.47
72 ;; - Custom commands may produce an agenda which contains several blocks,
73 ;; each block created by a different agenda command.
74 ;; - Agenda commands can be restricted to the current file, region, subtree.
75 ;; - The timeline command must now be called through the agenda
76 ;; dispatcher (C-c a L). `C-c C-r' no longer works.
77 ;; - Agenda items can be sorted by tag. The *last* tag is used for this.
78 ;; - The prefix and the sorting strategy for agenda items can depend
79 ;; upon the agenda type.
80 ;; - The handling of `mailto:' links can be customized, see the new
81 ;; variable `org-link-mailto-program'.
82 ;; - `mailto' links can specify a subject after a double colon,
83 ;; like [[mailto:carsten@orgmode.org::Org-mode is buggy]].
84 ;; - In the #+STARTUP line, M-TAB completes valid keywords.
85 ;; - In the #+TAGS: line, M-TAB after ":" inserts all currently used tags.
86 ;; - Again full Emacs 21 support: Checkboxes and publishing are fixed.
87 ;; - More minor bug fixes.
88 ;;
89 ;; Version 4.45
90 ;; - Checkbox lists can show statistics about checked items.
91 ;; - C-TAB will cycle the visibility of archived subtrees.
92 ;;; - Documentation about checkboxes has been moved to chapter 5.
93 ;; - Bux fixes.
94 ;;
95 ;; Version 4.44
96 ;; - Clock table can be done for a limited time interval.
97 ;; - Obsolete support for the old outline mode has been removed.
98 ;; - Bug fixes and code cleaning.
99 ;;
100 ;; Version 4.43
101 ;; - Bug fixes
102 ;; - `s' key in the agenda saves all org-mode buffers.
103 ;;
104 ;; Version 4.41
105 ;; - Shift-curser keys can modify inactive time stamps (inactive time
106 ;; stamps are the ones in [...] brackets.
107 ;; - Toggle all checkboxes in a region/below a headline.
108 ;; - Bug fixes.
109 ;;
110 ;;; Code:
115 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
116 ;; the file noutline.el being loaded.
118 ;; We require noutline, which might be provided in outline.el
120 ;; Other stuff we need.
124 ;;; Customization variables
132 ;; Compatibility constants
141 "Outline-based notes management and organizer."
148 "Options concerning startup of Org-mode."
153 "Non-nil means, entering Org-mode will switch to OVERVIEW.
154 This can also be configured on a per-file basis by adding one of
155 the following lines anywhere in the buffer:
157 #+STARTUP: fold
158 #+STARTUP: nofold
159 #+STARTUP: content"
167 "Non-nil means, entering Org-mode will set `truncate-lines'.
168 This is useful since some lines containing links can be very long and
169 uninteresting. Also tables look terrible when wrapped."
174 "Non-nil means, align all tables when visiting a file.
175 This is useful when the column width in tables is forced with <N> cookies
176 in table fields. Such tables will look correct only after the first re-align.
177 This can also be configured on a per-file basis by adding one of
178 the following lines anywhere in the buffer:
179 #+STARTUP: align
180 #+STARTUP: noalign"
185 "Non-nil means, entering Org-mode will run the deadline check.
186 This means, if you start editing an org file, you will get an
187 immediate reminder of any due deadlines.
188 This can also be configured on a per-file basis by adding one of
189 the following lines anywhere in the buffer:
190 #+STARTUP: dlcheck
191 #+STARTUP: nodlcheck"
196 "Non-nil means insert the first line setting Org-mode in empty files.
197 When the function `org-mode' is called interactively in an empty file, this
198 normally means that the file name does not automatically trigger Org-mode.
199 To ensure that the file will always be in Org-mode in the future, a
200 line enforcing Org-mode will be inserted into the buffer, if this option
201 has been set."
206 "Non-nil means use alternative key bindings for S-<cursor movement>.
207 Org-mode used S-<cursor movement> for changing timestamps and priorities.
208 S-<cursor movement> is also used for example by `CUA-mode' to select text.
209 If you want to use Org-mode together with `CUA-mode', Org-mode needs to use
210 alternative bindings. Setting this variable to t will replace the following
211 keys both in Org-mode and in the Org-agenda buffer.
213 S-RET -> C-S-RET
214 S-up -> M-p
215 S-down -> M-n
216 S-left -> M--
217 S-right -> M-+
219 If you do not like the alternative keys, take a look at the variable
220 `org-disputed-keys'.
222 This option is only relevant at load-time of Org-mode. Changing it requires
223 a restart of Emacs to become effective."
233 "Keys for which Org-mode and other modes compete.
234 This is an alist, cars are symbols for lookup, 1st element is the default key,
238 "Select a key according to `org-CUA-compatible'."
244 "The ellipsis to use in the Org-mode outline.
245 When nil, just use the standard three dots. When a string, use that instead,
246 and just in Org-mode (which will then use its own display table).
247 Changing this requires executing `M-x org-mode' in a buffer to become
248 effective."
257 "Keywords in Org-mode."
262 "String to mark deadline entries.
263 A deadline is this string, followed by a time stamp. Should be a word,
264 terminated by a colon. You can insert a schedule keyword and
266 Changes become only effective after restarting Emacs."
271 "String to mark scheduled TODO entries.
272 A schedule is this string, followed by a time stamp. Should be a word,
273 terminated by a colon. You can insert a schedule keyword and
275 Changes become only effective after restarting Emacs."
280 "String used as the prefix for timestamps logging closing a TODO entry."
285 "String used as prefix for timestamps clocking work hours on an item."
290 "Entries starting with this keyword will never be exported.
291 An entry can be toggled between COMMENT and normal with
293 Changes become only effective after restarting Emacs."
298 "Entries starting with this keyword will be exported in fixed-width font.
299 Quoting applies only to the text in the entry following the headline, and does
300 not extend beyond the next headline, even if that is lower level.
301 An entry can be toggled between QUOTE and normal with
307 "Options concerning the general structure of Org-mode files."
312 "Options concerning visibility cycling in Org-mode."
317 "Cycle globally if cursor is at beginning of buffer and not at a headline.
318 This makes it possible to do global cycling without having to use S-TAB or
319 C-u TAB. For this special case to work, the first line of the buffer
320 must not be a headline - it may be empty ot some other text. When used in
321 this way, `org-cycle-hook' is disables temporarily, to make sure the
322 cursor stays at the beginning of the buffer.
323 When this option is nil, don't do anything special at the beginning
324 of the buffer."
329 "Where should `org-cycle' emulate TAB.
330 nil Never
331 white Only in completely white lines
332 whitestart Only at the beginning of lines, before the first non-white char.
333 t Everywhere except in headlines
334 If TAB is used in a place where it does not emulate TAB, the current subtree
335 visibility is cycled."
341 ))
344 org-optimize-window-after-visibility-change)
345 "Hook that is run after `org-cycle' has changed the buffer visibility.
346 The function(s) in this hook must accept a single argument which indicates
347 the new state that was set by the most recent `org-cycle' command. The
348 argument is a symbol. After a global state change, it can have the values
349 `overview', `content', or `all'. After a local state change, it can have
350 the values `folded', `children', or `subtree'."
355 "Options concerning structure editing in Org-mode."
360 "Non-nil means, skip even levels and only use odd levels for the outline.
361 This has the effect that two stars are being added/taken away in
362 promotion/demotion commands. It also influences how levels are
363 handled by the exporters.
364 Changing it requires restart of `font-lock-mode' to become effective
365 for fontification also in regions already fontified.
366 You may also set this on a per-file basis by adding one of the following
367 lines to the buffer:
369 #+STARTUP: odd
370 #+STARTUP: oddeven"
376 "Non-nil means, adapt indentation when promoting and demoting.
377 When this is set and the *entire* text in an entry is indented, the
378 indentation is increased by one space in a demotion command, and
379 decreased by one in a promotion command. If any line in the entry
380 body starts at column 0, indentation is not changed at all."
385 "Hook being run after inserting a new heading."
391 This currently only means, they are never auto-wrapped.
392 When nil, such lines will be treated like ordinary lines.
393 See also the QUOTE keyword."
398 "Options concerning sparse trees in Org-mode."
403 "Non-nil means, highlight all matches that define a sparse tree.
404 The highlights will automatically disappear the next time the buffer is
405 changed by an edit command."
410 "Non-nil means, show full hierarchy when showing a spot in the tree.
411 Turning this off makes sparse trees more compact, but also less clear."
416 "Non-nil means, show heading following match in `org-occur'.
417 When doing an `org-occur' it is useful to show the headline which
418 follows the match, even if they do not match the regexp. This makes it
419 easier to edit directly inside the sparse tree. However, if you use
420 `org-occur' mainly as an overview, the following headlines are
421 unnecessary clutter."
426 "Hook that is run after `org-occur' has constructed a sparse tree.
427 This can be used to recenter the window to show as much of the structure
428 as possible."
433 "Options concerning plain lists in Org-mode."
438 "Non-nil means, include plain lists into visibility cycling.
439 This means that during cycling, plain list items will *temporarily* be
440 interpreted as outline headlines with a level given by 1000+i where i is the
441 indentation of the bullet. In all other operations, plain list items are
442 not seen as headlines. For example, you cannot assign a TODO keyword to
443 such an item."
448 "The character that makes a line with leading number an ordered list item.
449 Valid values are ?. and ?\). To get both terminators, use t. While
450 ?. may look nicer, it creates the danger that a line with leading
451 number may be incorrectly interpreted as an item. ?\) therefore is
452 the safe choice."
459 "Non-nil means, automatically renumber ordered plain lists.
460 Renumbering happens when the sequence have been changed with
467 "Non-nil means, update checkbox statistics after insert and toggle.
468 When this is set, checkbox statistics is updated each time you either insert
475 "Options concerning archiving in Org-mode."
480 "The tag that marks a subtree as archived.
481 An archived subtree does not open during visibility cycling, and does
482 not contribute to the agenda listings."
488 "Non-nil means, the agenda will skip any items located in archived trees.
489 An archived tree is a tree marked with the tag ARCHIVE."
495 "Non-nil means, `org-cycle' will open archived trees.
496 An archived tree is a tree marked with the tag ARCHIVE.
497 When nil, archived trees will stay folded. You can still open them with
498 normal outline commands like `show-all', but not with the cycling commands."
504 "Non-nil means sparse tree construction shows matches in archived trees.
505 When nil, matches in these trees are highlighted, but the trees are kept in
506 collapsed state."
512 "The location where subtrees should be archived.
513 This string consists of two parts, separated by a double-colon.
515 The first part is a file name - when omitted, archiving happens in the same
516 file. %s will be replaced by the current file name (without directory part).
517 Archiving to a different file is useful to keep archived entries from
518 contributing to the Org-mode Agenda.
520 The part after the double colon is a headline. The archived entries will be
521 filed under that headline. When omitted, the subtrees are simply filed away
522 at the end of the file, as top-level entries.
524 Here are a few examples:
526 If the current file is Projects.org, archive in file
527 Projects.org_archive, as top-level trees. This is the default.
530 Archive in the current file, under the top-level headline
534 Archive in file ~/org/archive.org (absolute path), as top-level trees.
537 Archive in file ./basement (relative path), as level 3 trees
540 You may set this option on a per-file basis by adding to the buffer a
541 line like
543 #+ARCHIVE: basement::** Finished Tasks"
548 "Non-nil means, mark entries as DONE when they are moved to the archive file."
553 "Non-nil means, add a time stamp to entries moved to an archive file.
554 The time stamp will be added directly after the TODO state keyword in the
555 first line, so it is probably best to use this in combinations with
556 `org-archive-mark-done'."
561 "Options concerning tables in Org-mode."
567 When nil, such lines will be treated like ordinary lines.
569 When equal to the symbol `optimized', the table editor will be optimized to
570 do the following:
571 - Use automatic overwrite mode in front of whitespace in table fields.
572 This make the structure of the table stay in tact as long as the edited
573 field does not exceed the column width.
574 - Minimize the number of realigns. Normally, the table is aligned each time
575 TAB or RET are pressed to move to another field. With optimization this
576 happens only if changes to a field might have changed the column width.
577 Optimization requires replacing the functions `self-insert-command',
578 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
579 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
580 very good at guessing when a re-align will be necessary, but you can always
583 If you would like to use the optimized version in Org-mode, but the
584 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
586 This variable can be used to turn on and off the table editor during a session,
587 but in order to toggle optimization, a restart is required.
589 See also the variable `org-table-auto-blank-field'."
597 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
598 In the optimized version, the table editor takes over all simple keys that
599 normally just insert a character. In tables, the characters are inserted
600 in a way to minimize disturbing the table structure (i.e. in overwrite mode
601 for empty fields). Outside tables, the correct binding of the keys is
602 restored.
604 The default for this option is t if the optimized version is also used in
605 Org-mode. See the variable `org-enable-table-editor' for details. Changing
606 this variable requires a restart of Emacs to become effective."
611 "Settings for tables in Org-mode."
616 "The default size for newly created tables, Columns x Rows."
621 "Regular expression for recognizing numbers in table columns.
622 If a table column contains mostly numbers, it will be aligned to the
623 right. If not, it will be aligned to the left.
625 The default value of this option is a regular expression which allows
626 anything which looks remotely like a number as used in scientific
627 context. For example, all of the following will be considered a
628 number:
629 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
631 Other options offered by the customize interface are more restrictive."
649 "Fraction of numbers in a column required to make the column align right.
650 In a column all non-white fields are considered. If at least this
651 fraction of fields is matched by `org-table-number-fraction',
652 alignment to the right border applies."
657 "Bahavior of tables during editing in Org-mode."
662 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
664 removal/insertion."
669 "Non-nil means, allow to limit the width of table columns with <N> fields."
674 "Non-nil means, automatically blank table field when starting to type into it.
675 This only happens when typing immediately after a field motion
676 command (TAB, S-TAB or RET).
677 Only relevant when `org-enable-table-editor' is equal to `optimized'."
682 "Non-nil means, tab in the last column of a table with jump over a hline.
683 If a horizontal separator line is following the current line,
684 `org-table-next-field' can either create a new row before that line, or jump
685 over the line. When this option is nil, a new line will be created before
686 this line."
691 "Non-nil means, TAB will automatically notice a table.el table.
692 When it sees such a table, it moves point into it and - if necessary -
693 calls `table-recognize-table'."
698 "Options concerning tables in Org-mode."
710 calc-angle-mode deg
711 calc-prefer-frac nil
712 calc-symbolic-mode nil
714 calc-display-working-message t
715 )
716 "List with Calc mode settings for use in calc-eval for table formulas.
717 The list must contain alternating symbols (Calc modes variables and values).
718 Don't remove any of the default settings, just change the values. Org-mode
719 relies on the variables to be present in the list."
724 "Non-nil means, TAB and RET evaluate a formula in current table field.
725 If the current field starts with an equal sign, it is assumed to be a formula
726 which should be evaluated as described in the manual and in the documentation
727 string of the command `org-table-eval-formula'. This feature requires the
728 Emacs calc package.
729 When this variable is nil, formula calculation is only available through
736 "Non-nil means, interpret constants in formulas in tables.
737 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
738 by the value given in `org-table-formula-constants', or by a value obtained
739 from the `constants.el' package."
744 "Alist with constant names and values, for use in table formulas.
745 The car of each element is a name of a constant, without the `$' before it.
746 The cdr is the value as a string. For example, if you'd like to use the
747 speed of light in a formula, you would configure
751 and then use it in an equation like `$1*$c'."
758 "Non-nil means, calculate only with numbers in table formulas.
759 Then all input fields will be converted to a number, and the result
760 must also be a number. When nil, calc's full potential is available
761 in table calculations, including symbolics etc."
766 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
767 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
772 "Options concerning links in Org-mode."
777 "Non-nil means, hide link part and only show description of bracket links.
778 Bracket links are like [[link][descritpion]]. This variable sets the initial
779 state in new org-mode buffers. The setting can then be toggled on a
780 per-buffer basis from the Org->Hyperlinks menu."
786 Possible values are:
787 bracket [[link][description]]. This is recommended
795 "Default format for external, URL-like linkes in the buffer.
796 This is a format string for printf, %s will be replaced by the link text.
798 enclosing them in double brackets. If you prefer plain links (see variable
809 "How the path name in file links should be stored.
810 Valid values are:
812 relative relative to the current directory, i.e. the directory of the file
813 into which the link is being inserted.
814 absolute absolute path, if possible with ~ for home directory.
815 noabbrev absolute path, no abbreviation of home directory.
816 adaptive Use relative path for files in the current directory and sub-
817 directories of it. For other files, use an absolute path."
826 "Types of links that should be activated in Org-mode files.
827 This is a list of symbols, each leading to the activation of a certain link
828 type. In principle, it does not hurt to turn on most link types - there may
829 be a small gain when turning off unused link types. The types are:
831 bracket The recommended [[link][description]] or [[link]] links with hiding.
832 angular Links in angular brackes that may contain whitespace like
833 <bbdb:Carsten Dominik>.
834 plain Plain links in normal text, no whitespace, like http://google.com.
835 radio Text that is matched by a radio target, see manual for details.
836 tag Tag settings in a headline (link to tag search).
837 date Time stamps (link to calendar).
838 camel CamelCase words defining text searches.
840 Changing this variable requires a restart of Emacs to become effective."
851 "Options concerning storing links in Org-mode"
856 "Non-nil means, file links from `org-store-link' contain context.
857 A search string will be added to the file name with :: as separator and
858 used to find the context when the link is activated by the command
859 `org-open-at-point'.
861 negates this setting for the duration of the command."
866 "Non-nil means, use CamelCase to store a search context in a file link.
867 When nil, the search string simply consists of the words of the string.
868 CamelCase is deprecated, and support for it may be dropped in the future."
873 "Non-nil means, keep link in list for entire session.
875 The command `org-store-link' adds a link pointing to the current
876 location to an internal list. These links accumulate during a session.
877 The command `org-insert-link' can be used to insert links into any
878 Org-mode file (offering completion for all stored links). When this
880 will be removed from the list, to make completing the unused links
881 more efficient."
886 "Non-nil means, `org-store-link' will create web links to Google groups.
887 When nil, Gnus will be used for such links.
889 negates this setting for the duration of the command."
894 "Options concerning following links in Org-mode"
899 "Non-nil means, on links TAB will follow the link.
900 Needs to be set before org.el is loaded."
905 "Non-nil means, on links RET will follow the link.
906 Needs to be set before org.el is loaded."
911 "Non-nil means, mouse-1 on a link will follow the link.
912 A longer mouse click will still set point. Does not wortk on XEmacs.
913 Needs to be set before org.el is loaded."
918 "Number of different positions to be recorded in the ring
919 Changing this requires a restart of Emacs to work correctly."
927 "Setup the frame configuration for following links.
928 When following a link with Emacs, it may often be useful to display
929 this link in another window or frame. This variable can be used to
930 set this up for the different types of links.
931 For VM, use any of
932 `vm-visit-folder'
933 `vm-visit-folder-other-frame'
934 For Gnus, use any of
935 `gnus'
936 `gnus-other-frame'
937 For FILE, use any of
938 `find-file'
939 `find-file-other-window'
940 `find-file-other-frame'
941 For the calendar, use the variable `calendar-setup'.
942 For BBDB, it is currently only possible to display the matches in
943 another window."
962 "Non-nil means, `org-open-file' will open non-existing file.
963 When nil, an error will be generated."
968 "Function and arguments to call for following mailto links.
969 This is a list with the first element being a lisp function, and the
970 remaining elements being arguments to the function. In string arguments,
971 %a will be replaced by the address, and %s will be replaced by the subject
972 if one was given like in <mailto:arthur@galaxy.org::this subject>."
981 "Non-nil means, ask for confirmation before executing shell links.
982 Shell links can be dangerous, just thing about a link
984 [[shell:rm -rf ~/*][Google Search]]
987 but really it would remove your entire home directory.
988 Therefore I *definitely* advise against setting this variable to nil.
989 Just change it to `y-or-n-p' of you want to confirm with a single key press
998 "Non-nil means, ask for confirmation before executing elisp links.
999 Elisp links can be dangerous, just thing about a link
1004 but really it would remove your entire home directory.
1005 Therefore I *definitely* advise against setting this variable to nil.
1006 Just change it to `y-or-n-p' of you want to confirm with a single key press
1017 "Default file applications on a UNIX or GNU/Linux system.
1029 "Default file applications on a MacOS X system.
1031 for some files for which the OS does not have a good default.
1039 'mswindows-shell-execute
1042 "Default file applications on a Windows NT system.
1047 '(
1054 )
1055 "External applications for opening `file:path' items in a document.
1056 Org-mode uses system defaults for different file types, but
1057 you can use this variable to set the application for a given file
1058 extension. The entries in this list are cons cells where the car identifies
1059 files and the cdr the corresponding command. Possible values for the
1060 file identifier are
1062 `directory' Matches a directory
1063 `remote' Matches a remote file, accessible through tramp or efs.
1064 Remote files most likely should be visited through emacs
1065 because external applications cannot handle such paths.
1066 t Default for all remaining files
1068 Possible values for the command are:
1069 `emacs' The file will be visited by the current Emacs process.
1070 `default' Use the default application for this file type.
1071 string A command to be executed by a shell; %s will be replaced
1072 by the path to the file.
1073 sexp A Lisp form which will be evaluated. The file path will
1074 be available in the Lisp variable `file'.
1075 For more examples, see the system specific constants
1076 `org-file-apps-defaults-macosx'
1077 `org-file-apps-defaults-windowsnt'
1078 `org-file-apps-defaults-gnu'."
1093 "Non-nil means, that the search for the mh-message will be extended to
1094 all folders if the message cannot be found in the folder given in the link.
1095 Searching all folders is very effective with one of the search engines
1096 supported by MH-E, but will be slow with pick."
1101 "Options concerning interaction with remember.el."
1106 "Directory with org files.
1107 This directory will be used as default to prompt for org files.
1108 Used by the hooks for remember.el."
1113 "Default target for storing notes.
1114 Used by the hooks for remember.el. This can be a string, or nil to mean
1115 the value of `remember-data-file'."
1119 file))
1122 "Templates for the creation of remember buffers.
1123 When nil, just let remember make the buffer.
1124 When not nil, this is a list of 3-element lists. In each entry, the first
1125 element is a character, a unique key to select this template.
1126 The second element is the template. The third element is optional and can
1127 specify a destination file for remember items created with this template.
1128 The default file is given by `org-default-notes-file'.
1130 The template specifies the structure of the remember buffer. It should have
1131 a first line starting with a star, to act as the org-mode headline.
1132 Furthermore, the following %-escapes will be replaced with content:
1133 %t time stamp, date only
1134 %T time stamp with date and time
1135 %u inactive time stamp, date only
1136 %U inactive time stamp with date and time
1137 %n user name
1138 %a annotation, normally the link created with org-store-link
1139 %i initial content, the region when remember is called with C-u.
1140 If %i is indented, the entire inserted text will be indented as well.
1141 %? This will be removed, and the cursor placed at this position."
1150 "Non-nil means, store new notes at the beginning of a file or entry.
1151 When nil, new notes will be filed to the end of a file or entry."
1160 "Options concerning TODO items in Org-mode."
1165 "List of TODO entry keywords.
1168 action is required, and will make the entry show up in todo lists, diaries
1169 etc.
1171 additional state where no keyword is present. For details about this
1172 cycling, see also the variable `org-todo-interpretation'
1173 Changes become only effective after restarting Emacs."
1179 "Controls how TODO keywords are interpreted.
1180 This variable is only relevant if `org-todo-keywords' contains more than two
1185 to state when executed several times in direct succession. Otherwise, it
1186 switches directly to DONE from any state.
1187 See the manual for more information."
1194 "Hook which is run after the state of a TODO item was changed.
1195 The new state (a string with a TODO keyword, or nil) is available in the
1196 Lisp variable `state'."
1201 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1202 When the state of an entry is changed from nothing to TODO, remove a previous
1203 closing date.
1204 This can also be configured on a per-file basis by adding one of
1205 the following lines anywhere in the buffer:
1207 #+STARTUP: logging
1208 #+STARTUP: nologging"
1213 "Priorities in Org-mode."
1218 "The default priority of TODO items.
1219 This is the priority an item get if no explicit priority is given."
1224 "The lowest priority of TODO items. A character like ?A, ?B etc."
1229 "Options concerning time stamps and deadlines in Org-mode."
1234 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1235 When nil, these labeled time stamps are forces into the second line of an
1236 entry, just after the headline. When scheduling from the global TODO list,
1237 the time stamp will always be forced into the second line."
1242 "Formats for `format-time-string' which are used for time stamps.
1246 "Number of minutes to round time stamps to upon insertion.
1247 When zero, insert the time unmodified. Useful rounding numbers
1248 should be factors of 60, so for example 5, 10, 15.
1249 When this is not zero, you can still force an exact time-stamp by using
1250 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1255 "No. of days before expiration during which a deadline becomes active.
1256 This variable governs the display in the org file."
1261 "Non-nil means, pop up a calendar when prompting for a date.
1262 In the calendar, the date can be selected with mouse-1. However, the
1263 minibuffer will also be active, and you can simply enter the date as well.
1264 When nil, only the minibuffer will be available."
1269 "Non-nil means, make the calendar window follow timestamp changes.
1270 When a timestamp is modified and the calendar window is visible, it will be
1271 moved to the new date."
1276 "Options concerning tags in Org-mode."
1281 "List of tags allowed in Org-mode files.
1282 When this list is nil, Org-mode will base TAG input on what is already in the
1283 buffer.
1284 The value of this variable is an alist, the car may be (and should) be a
1285 character that is used to select that tag through the fast-tag-selection
1286 interface. See the manual for details."
1296 "Non-nil means, use fast tag selection scheme.
1297 This is a special interface to select and deselect tags with single keys.
1298 When nil, fast selection is never used.
1299 When the symbol `auto', fast selection is used if and only if selection
1300 characters for tags have been configured, either through the variable
1301 `org-tag-alist' or through a #+TAGS line in the buffer.
1302 When t, fast selection is always used and selection keys are assigned
1303 automatically if necessary."
1311 "The column to which tags should be indented in a headline.
1312 If this number is positive, it specifies the column. If it is negative,
1313 it means that the tags should be flushright to that column. For example,
1314 -79 works well for a normal 80 character screen."
1319 "Non-nil means, realign tags after pro/demotion of TODO state change.
1320 These operations change the length of a headline and therefore shift
1321 the tags around. With this options turned on, after each such operation
1322 the tags are again aligned to `org-tags-column'."
1327 "Non-nil means, tags in levels apply also for sublevels.
1328 When nil, only the tags directly given in a specific line apply there.
1329 If you turn off this option, you very likely want to turn on the
1330 companion option `org-tags-match-list-sublevels'."
1335 "Non-nil means list also sublevels of headlines matching tag search.
1336 Because of tag inheritance (see variable `org-use-tag-inheritance'),
1337 the sublevels of a headline matching a tag search often also match
1338 the same search. Listing all of them can create very long lists.
1339 Setting this variable to nil causes subtrees of a match to be skipped.
1340 This option is off by default, because inheritance in on. If you turn
1341 inheritance off, you very likely want to turn this option on.
1343 As a special case, if the tag search is restricted to TODO items, the
1344 value of this variable is ignored and sublevels are always checked, to
1345 make sure all corresponding TODO items find their way into the list."
1355 "Options concerning agenda display Org-mode."
1360 "Variable used by org files to set a category for agenda display.
1361 Such files should use a file variable to set it, for example
1365 or contain a special line
1367 #+CATEGORY: ELisp
1369 If the file does not specify a category, then file's base name
1374 "The files to be used for agenda display.
1378 If the value of the variable is not a list but a single file name, then
1379 the list of agenda files is actually stored and maintained in that file, one
1380 agenda file per line."
1388 "Custom commands for the agenda.
1389 These commands will be offered on the splash screen displayed by the
1392 (key type match options)
1394 key The key (a single char as a string) to be associated with the command.
1395 type The command type, any of the following symbols:
1396 todo Entries with a specific TODO keyword, in all agenda files.
1397 tags Tags match in all agenda files.
1398 tags-todo Tags match in all agenda files, TODO entries only.
1399 todo-tree Sparse tree of specific TODO keyword in *current* file.
1400 tags-tree Sparse tree with all tags matches in *current* file.
1401 occur-tree Occur sparse tree for *current* file.
1402 match What to search for:
1403 - a single keyword for TODO keyword searches
1404 - a tags match expression for tags searches
1405 - a regular expression for occur searches
1406 options A list of option setttings, similar to that in a let form, so like
1407 this: ((opt1 val1) (opt2 val2) ...)
1409 You can also define a set of commands, to create a composite agenda buffer.
1410 In this case, an entry looks like this:
1412 (key desc (cmd1 cmd2 ...) general-options)
1414 where
1416 desc A description string to be displayed in the dispatcher menu.
1417 cmd An agenda command, similar to the above. However, tree commands
1418 are no allowed, but instead you can get agenda and global todo list.
1419 So valid commands for a set are:
1420 (agenda)
1421 (alltodo)
1426 Each command can carry a list of options, and another set of options can be
1427 given for the whole set of commands. Individual command options take
1428 precedence over the general options."
1476 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
1477 When nil, the sublevels of a TODO entry are not checked, resulting in
1478 potentially much shorter TODO lists."
1484 "Non-nil means, don't show scheduled entries in the global todo list.
1485 The idea behind this is that by scheduling it, you have already taken care
1486 of this item."
1492 "Non-nil means, `org-timeline' also shows dates without an entry.
1493 When nil, only the days which actually have entries are shown.
1494 When t, all days between the first and the last date are shown.
1495 When an integer, show also empty dates, but if there is a gap of more than
1496 N days, just insert a special line indicating the size of the gap."
1504 "Set means weekly/daily agenda will always contain all TODO entries.
1505 The TODO entries will be listed at the top of the agenda, before
1506 the entries for specific days."
1511 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
1516 "The key to be installed in `calendar-mode-map' for switching to the agenda.
1517 The command `org-calendar-goto-agenda' will be bound to this key. The
1518 default is the character `c' because then `c' can be used to switch back and
1519 forth between agenda and calendar."
1524 "Options concerning setting up the Agenda window in Org Mode."
1529 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
1530 A longer mouse click will still set point. Does not wortk on XEmacs.
1531 Needs to be set before org.el is loaded."
1536 "The initial value of follwo-mode in a newly created agenda window."
1541 "Non-nil means, after creating an agenda, move cursor into Agenda window.
1542 When nil, cursor will remain in the current window."
1547 "Non-nil means, change window size of agenda to fit content."
1552 "Options concerning what to display initially in Agenda."
1557 "Non-nil means, `org-agenda' shows every day in the selected range.
1558 When nil, only the days which actually have entries are shown."
1563 "Non-nil means, start the overview always on the specified weekday.
1564 0 denotes Sunday, 1 denotes Monday etc.
1565 When nil, always start on the current day."
1571 "Number of days to include in overview display.
1572 Should be 1 or 7."
1577 "Non-nil means, show a time grid in the agenda schedule.
1578 A time grid is a set of lines for specific times (like every two hours between
1579 8:00 and 20:00). The items scheduled for a day at specific times are
1580 sorted in between these lines.
1581 For details about when the grid will be shown, and what it will look like, see
1582 the variable `org-agenda-time-grid'."
1588 "----------------"
1591 "The settings for time grid for agenda display.
1592 This is a list of three items. The first item is again a list. It contains
1593 symbols specifying conditions when the grid should be displayed:
1595 daily if the agenda shows a single day
1596 weekly if the agenda shows an entire week
1597 today show grid on current date, independent of daily/weekly display
1598 require-timed show grid only if at least one item has a time specification
1600 The second item is a string which will be places behing the grid time.
1602 The third item is a list of integers, indicating the times that should have
1603 a grid line."
1605 :type
1612 require-timed)
1614 remove-match))
1629 "Sorting structure for the agenda items of a single day.
1630 This is a list of symbols which will be used in sequence to determine
1631 if an entry should be listed before another entry. The following
1632 symbols are recognized:
1634 time-up Put entries with time-of-day indications first, early first
1635 time-down Put entries with time-of-day indications first, late first
1636 category-keep Keep the default order of categories, corresponding to the
1637 sequence in `org-agenda-files'.
1638 category-up Sort alphabetically by category, A-Z.
1639 category-down Sort alphabetically by category, Z-A.
1640 tag-up Sort alphabetically by last tag, A-Z.
1641 tag-down Sort alphabetically by last tag, Z-A.
1642 priority-up Sort numerically by priority, high priority last.
1643 priority-down Sort numerically by priority, high priority first.
1645 The different possibilities will be tried in sequence, and testing stops
1647 '(time-up category-keep priority-down)
1648 means: Pull out all entries having a specified time of day and sort them,
1649 in order to make a time schedule for the current day the first thing in the
1650 agenda listing for the day. Of the entries without a time indication, keep
1651 the grouped in categories, don't sort the categories, but keep them in
1652 the sequence given in `org-agenda-files'. Within each category sort by
1653 priority.
1655 Leaving out `category-keep' would mean that items will be sorted across
1656 categories by priority."
1669 "Non-nil means, items without time are considered late.
1670 This is only relevant for sorting. When t, items which have no explicit
1671 time like 15:30 will be considered as 99:01, i.e. later than any items which
1672 do have a time. When nil, the default time is before 0:00. You can use this
1673 option to decide if the schedule for today should come before or after timeless
1674 agenda entries."
1680 "Options concerning the entry prefix in the Org-mode agenda display."
1689 "Format specifications for the prefix of items in the agenda views.
1690 An alist with four entries, for the different agenda types. The keys to the
1691 sublists are `agenda', `timeline', `todo', and `tags'. The values
1692 are format strings.
1693 This format works similar to a printf format, with the following meaning:
1696 as given by the CATEGORY keyword or derived from the file name.
1697 %T the *last* tag of the item. Last because inherited tags come
1698 first in the list.
1699 %t the time-of-day specification if one applies to the entry, in the
1700 format HH:MM
1701 %s Scheduling/Deadline information, a short string
1703 All specifiers work basically like the standard `%s' of printf, but may
1704 contain two additional characters: A question mark just after the `%' and
1705 a whitespace/punctuation character just before the final letter.
1707 If the first character after `%' is a question mark, the entire field
1708 will only be included if the corresponding value applies to the
1709 current entry. This is useful for fields which should have fixed
1710 width when present, but zero width when absent. For example,
1712 day is specified, but will completely disappear in entries which do
1713 not contain a time.
1715 If there is punctuation or whitespace character just before the final
1716 format letter, this character will be appended to the field value if
1719 empty, no additional colon would be interted.
1722 - Indent the line with two space characters
1723 - Give the category in a 12 chars wide field, padded with whitespace on
1724 the right (because of `-'). Append a colon if there is a category
1725 (because of `:').
1726 - If there is a time-of-day, put it into a 12 chars wide field. If no
1727 time, don't put in an empty field, just skip it (because of '?').
1728 - Finally, put the scheduling information and append a whitespace.
1730 As another example, if you don't want the time-of-day of entries in
1731 the prefix, you could use:
1735 See also the variables `org-agenda-remove-times-when-in-prefix' and
1736 `org-agenda-remove-tags-when-in-prefix'."
1747 "The compiled version of the most recently used prefix format.
1751 "Non-nil means, remove duplicate time specifications in agenda items.
1752 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1753 time-of-day specification in a headline or diary entry is extracted and
1754 placed into the prefix. If this option is non-nil, the original specification
1755 \(a timestamp or -range, or just a plain time(range) specification like
1756 11:30-4pm) will be removed for agenda display. This makes the agenda less
1757 cluttered.
1758 The option can be t or nil. It may also be the symbol `beg', indicating
1759 that the time should only be removed what it is located at the beginning of
1760 the headline/diary entry."
1768 "Non-nil means, remove the tags from the headline copy in the agenda.
1769 When this is the symbol `prefix', only remove tags when
1770 `org-agenda-prefix-format' contains a `%T' specifier."
1778 "Shift tags in agenda items to this column."
1783 "Options for embedding LaTeX code into Org-mode"
1790 "Options for creating images from LaTeX fragments.
1791 This is a property list with the following properties:
1794 :scale a scaling factor for the size of the images
1795 :matchers a list indicating which matchers should be used to
1796 find LaTeX fragments. Valid members of this list are:
1806 "Options for exporting org-listings."
1811 "General options for exporting Org-mode files."
1816 "Path to the location where exported files should be located.
1817 This path may be relative to the directory where the Org-mode file lives.
1818 The default is to put them into the same directory as the Org-mode file.
1819 The variable may also be an alist with export types `:html', `:ascii',
1820 `:ical', or `:xoxo' and the corresponding directories. If a direcoty path
1821 is relative, it is interpreted relative to the directory where the exported
1822 Org-mode files lives."
1843 "Terms used in export text, translated to different languages.
1844 Use the variable `org-export-default-language' to set the language,
1845 or use the +OPTION lines for a per-file setting."
1855 "The default language of HTML export, as a string.
1856 This should have an association in `org-export-language-setup'."
1861 "The last level which is still exported as a headline.
1862 Inferior levels will produce itemize lists when exported.
1863 Note that a numeric prefix argument to an exporter function overrides
1864 this setting.
1871 "Non-nil means, add section numbers to headlines when exporting.
1878 "Non-nil means, create a table of contents in exported files.
1879 The TOC contains headlines with levels up to`org-export-headline-levels'.
1882 ASCII export, and with red color in HTML output.
1884 In HTML output, the TOC will be clickable.
1891 "Non-nil means, mark TOC lines that contain any open TODO items."
1896 "Non-nil means, preserve all line breaks when exporting.
1897 Normally, in HTML output paragraphs will be reformatted. In ASCII
1898 export, line breaks will always be preserved, regardless of this variable.
1905 "Whether subtrees with the ARCHIVE tag should be exported.
1906 This can have three different values
1907 nil Do not export, pretend this tree is not present
1908 t Do export the entire tree
1909 headline Only export the headline, but skip the tree below it."
1918 "Nil means, do not export time stamps and associated keywords."
1923 "Nil means, remove timestamps from the table of contents entries."
1928 "Nil means, do not export tags, just remove them from headlines.
1929 If this is the sysmbol `not-in-toc', tags will be removed from table of
1930 contents entries, but still be shown in the headlines of the document."
1938 "Options for translating special ascii sequences for the export backends."
1943 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
1944 If the export target supports emphasizing text, the word will be
1945 typeset in bold, italic, or underlined, respectively. Works only for
1946 single words, but you can say: I *really* *mean* *this*.
1947 Not all export backends support this.
1955 When this option is turned on, you can use TeX-like syntax for sub- and
1957 considered as a single item - so grouping with {} is normally not
1958 needed. For example, the following things will be parsed as single
1959 sub- or superscripts.
1961 10^24 or 10^tau several digits will be considered 1 item.
1962 10^-12 or 10^-tau a leading sign with digits or a word
1963 x^2-y^3 will be read as x^2 - y^3, because items are
1964 terminated by almost any nonword/nondigit char.
1965 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
1967 Still, ambiguity is possible - so when in doubt use {} to enclose the
1968 sub/superscript.
1969 Not all export backends support this, but HTML does.
1976 "Non-nil means, interpret simple TeX-like macros when exporting.
1978 No only real TeX macros will work here, but the standard HTML entities
1979 for math can be used as macro names as well. For a list of supported
1980 names in HTML export, see the constant `org-html-entities'.
1981 Not all export backends support this.
1989 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
1991 the first non-white thing on a line. It will also find the math delimiters
1993 display math.
2002 This can be used to have pre-formatted text, fragments of code etc. For
2003 example:
2004 : ;; Some Lisp examples
2005 : (while (defc cnt)
2006 : (ding))
2007 will be looking just like this in also HTML. See also the QUOTE keyword.
2008 Not all export backends support this.
2015 "Number of stacked braces for sub/superscript matching.
2016 This has to be set before loading org.el to be effective."
2021 "Options for exporting tables in Org-mode."
2027 For example:
2029 | Name | Address | Birthday |
2030 |-------------+----------+-----------|
2031 | Arthur Dent | England | 29.2.2100 |
2033 Not all export backends support this.
2040 "Non-nil means, highlight the first table line.
2041 In HTML export, this means use <th> instead of <td>.
2042 In tables created with table.el, this applies to the first table line.
2043 In Org-mode tables, all lines before the first horizontal separator
2044 line will be formatted with <th> tags."
2049 "Remove special lines and marking characters in calculating tables.
2050 This removes the special marking character column from tables that are set
2051 up for spreadsheet calculations. It also removes the entire lines
2052 marked with `!', `_', or `^'. The lines with `$' are kept, because
2053 the values of constants may be useful to have."
2058 "Non-nil means, always export tables created with table.el natively.
2059 Natively means, use the HTML code generator in table.el.
2060 When nil, Org-mode's own HTML generator is used when possible (i.e. if
2061 the table does not use row- or column-spanning). This has the
2062 advantage, that the automatic HTML conversions for math symbols and
2063 sub/superscripts can be applied. Org-mode's HTML generator is also
2064 much faster."
2069 "Options specific for ASCII export of Org-mode files."
2074 "Characters for underlining headings in ASCII export.
2075 In the given sequence, these characters will be used for level 1, 2, ..."
2080 "Bullet characters for headlines converted to lists in ASCII export.
2081 The first character is is used for the first lest level generated in this
2082 way, and so on. If there are more levels than characters given here,
2083 the list will be repeated.
2084 Note that plain lists will keep the same bullets as the have in the
2085 Org-mode file."
2090 "Non-nil means, popup buffer containing the exported ASCII text.
2091 Otherwise the buffer will just be saved to a file and stay hidden."
2096 "Options specific for XML export of Org-mode files."
2101 "Options specific for HTML export of Org-mode files."
2107 html {
2108 font-family: Times, serif;
2109 font-size: 12pt;
2110 }
2111 .title { text-align: center; }
2112 .todo { color: red; }
2113 .done { color: green; }
2114 .timestamp { color: grey }
2115 .timestamp-kwd { color: CadetBlue }
2116 .tag { background-color:lightblue; font-weight:normal }
2117 .target { background-color: lavender; }
2118 pre {
2119 border: 1pt solid #AEBDCC;
2120 background-color: #F3F5F7;
2121 padding: 5pt;
2122 font-family: courier, monospace;
2123 }
2124 table { border-collapse: collapse; }
2125 td, th {
2126 vertical-align: top;
2127 border: 1pt solid #ADB9CC;
2128 }
2129 </style>"
2130 "The default style specification for exported HTML files.
2131 Since there are different ways of setting style information, this variable
2132 needs to contain the full HTML structure to provide a style, including the
2133 surrounding HTML tags. The style specifications should include definitions
2134 for new classes todo, done, title, and deadline. For example, legal values
2135 would be:
2138 p { font-weight: normal; color: gray; }
2139 h1 { color: black; }
2140 .title { text-align: center; }
2141 .todo, .deadline { color: red; }
2142 .done { color: green; }
2143 </style>
2145 or, if you want to keep the style in a file,
2149 As the value of this option simply gets inserted into the HTML <head> header,
2155 "Format for typesetting the document title in HTML export."
2160 "The <H> level for level 1 headings in HTML export."
2165 "Non-nil means, make file links to `file.org' point to `file.html'.
2166 When org-mode is exporting an org-mode file to HTML, links to
2167 non-html files are directly put into a href tag in HTML.
2168 However, links to other Org-mode files (recognized by the
2169 extension `.org.) should become links to the corresponding html
2170 file, assuming that the linked org-mode file will also be
2171 converted to HTML.
2172 When nil, the links still point to the plain `.org' file."
2177 "Non-nil means, inline images into exported HTML pages.
2178 This is done using an <img> tag. When nil, an anchor with href is used to
2179 link to the image. If this option is `maybe', then images in links with
2180 an empty description will be inlined, while images with a description will
2181 be linked only."
2188 "Non-nil means, for HTML export, treat @<...> as HTML tag.
2189 When nil, these tags will be exported as plain text and therefore
2190 not be interpreted by a browser.
2198 "The HTML tag used to start a table.
2199 This must be a <table> tag, but you may change the options like
2200 borders and spacing."
2205 "If non-nil, write `org-export-html-html-helper-timestamp'
2206 into the exported HTML text. Otherwise, the buffer will just be saved
2207 to a file."
2213 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
2218 "Non-nil means, popup buffer containing the exported html text.
2219 Otherwise, the buffer will just be saved to a file and stay hidden."
2224 "Options specific for iCalendar export of Org-mode files."
2229 "The file name for the iCalendar file covering all agenda files.
2231 The file name should be absolute."
2236 "Non-nil means, export to iCalendar files should also cover TODO items."
2241 "Calendar name for the combined iCalendar representing all agenda files."
2246 "Font-lock settings for highlighting in Org-mode."
2251 "Non-nil means fontify only the stars in each headline.
2252 When nil, the entire headline is fontified.
2253 Changing it requires restart of `font-lock-mode' to become effective
2254 also in regions already fontified."
2259 "Non-nil means, hide the first N-1 stars in a headline.
2260 This works by using the face `org-hide' for these stars. This
2261 face is white for a light background, and black for a dark
2262 background. You may have to customize the face `org-hide' to
2263 make this work.
2264 Changing it requires restart of `font-lock-mode' to become effective
2265 also in regions already fontified.
2266 You may also set this on a per-file basis by adding one of the following
2267 lines to the buffer:
2269 #+STARTUP: hidestars
2270 #+STARTUP: showstars"
2275 "Non-nil means, change the face of a headline if it is marked DONE.
2276 Normally, only the TODO/DONE keyword indicates the state of a headline.
2277 When this is non-nil, the headline after the keyword is set to the
2278 `org-headline-done' as an additional indication."
2283 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2284 Changing this variable requires a restart of Emacs to take effect."
2293 "Set variable and compute the emphasis regular expression."
2297 org-emphasis-alist org-emphasis-regexp-components)
2307 ;; make sure special characters appear at the right position in the class
2313 ;; Make the regexp
2320 body1
2328 "Components used to build the reqular expression for emphasis.
2329 This is a list with 6 entries. Terminology: In an emphasis string
2333 specify what is allowed/forbidden in each part:
2335 pre Chars allowed as prematch. Beginning of line will be allowed too.
2336 post Chars allowed as postmatch. End of line will be allowed too.
2337 border The chars *forbidden* as border characters. In addition to the
2338 characters given here, all marker characters are forbidden too.
2340 non-shy groups here, and don't allow newline here.
2341 newline The maximum number of newlines allowed in an emphasis exp.
2342 stacked Non-nil means, allow stacked styles. This works only in HTML
2343 export. When this is set, all marker characters (as given in
2344 `org-emphasis-alist') will be allowed as pre/post, aiding
2345 inside-out matching.
2346 Use customize to modify this, or restart emacs after changing it."
2363 )
2364 "Special syntax for emphasised text.
2365 Text starting and ending with a special character will be emphasized, for
2366 example *bold*, _underlined_ and /italic/. This variable sets the marker
2367 characters, the face to bbe used by font-lock for highlighting in Org-mode
2368 emacs buffers, and the HTML tags to be used for this.
2369 Use customize to modify this, or restart emacs after changing it."
2382 "Faces in Org-mode."
2387 "Make a compatible face specification.
2388 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
2389 For them we convert a (min-colors 8) entry to a `tty' entry and move it
2390 to the top of the list. The `min-colors' attribute will be removed from
2391 any other entries, and any resulting duplicates will be removed entirely."
2405 specs))
2410 "Face used to hide leading stars in headlines.
2411 The forground color of this face should be equal to the background
2412 color of the frame."
2423 "Face used for level 1 headlines."
2433 "Face used for level 2 headlines."
2445 "Face used for level 3 headlines."
2457 "Face used for level 4 headlines."
2465 "Face used for level 5 headlines."
2473 "Face used for level 6 headlines."
2481 "Face used for level 7 headlines."
2489 "Face used for level 8 headlines."
2497 "Face used for special keywords."
2507 "Face for deadlines and TODO keywords."
2515 "Face used to indicate that a headline is DONE.
2516 This face is only used if `org-fontify-done-headline' is set."
2529 "Face for headline with the ARCHIVE tag."
2536 "Face for links."
2543 "Face for links."
2548 "Face for tags."
2558 "Face for TODO keywords."
2567 "Face used for DONE."
2578 "Face used for tables."
2588 "Face for formulas."
2597 "Face for items scheduled for a certain day."
2607 "Face for items scheduled previously, and not yet done."
2617 "Face for items scheduled previously, and not yet done."
2625 "Face used for time grids."
2630 org-level-5 org-level-6 org-level-7 org-level-8
2631 ))
2635 ;; Variables for pre-computed regular expressions, all buffer local
2649 "Matches a headline and puts TODO state into group 2 if present.
2694 mouse-map t)
2701 s)
2706 s)
2709 "Make VAR local in current buffer and set it to VALUE."
2713 "Check if the current buffer is in Org-mode."
2717 "Return the last element of LIST."
2746 "Precompute regular expressions for current buffer."
2752 kwds int key value cat arch tags)
2777 l var val)
2786 )))
2800 tgs))
2808 ;; Compute the regular expressions and other local variables
2813 org-done-string
2815 org-todo-regexp
2818 org-not-done-regexp
2824 org-todo-line-regexp
2828 org-nl-done-regexp
2830 org-todo-line-tags-regexp
2836 org-deadline-time-regexp
2838 org-deadline-line-regexp
2840 org-scheduled-regexp
2842 org-scheduled-time-regexp
2844 org-closed-time-regexp
2846 org-keyword-time-regexp
2852 org-maybe-keyword-time-regexp
2861 ;; Tell the compiler about dynamically scoped variables,
2862 ;; and variables from other packages
2914 ;;; Define the mode
2918 (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.")
2926 ;; We use a before-change function to check if a table might need
2927 ;; an update.
2929 "Indicates that a table might need an update.
2930 This variable is set by `org-before-change-function'.
2937 ;;;###autoload
2939 "Outline-based notes management and organizer, alias
2942 Org-mode develops organizational tasks around a NOTES file which
2943 contains information about projects as plain text. Org-mode is
2944 implemented on top of outline-mode, which is ideal to keep the content
2945 of large files well structured. It supports ToDo items, deadlines and
2946 time stamps, which magically appear in the diary listing of the Emacs
2947 calendar. Tables are easily created with a built-in table editor.
2948 Plain text URL-like links connect to websites, emails (VM), Usenet
2949 messages (Gnus), BBDB entries, and any files related to the project.
2950 For printing and sharing of notes, an Org-mode file (or a part of it)
2951 can be exported as a structured ASCII or HTML file.
2953 The following commands are available:
2957 ;; Get rid of Outline menus, they are not needed
2958 ;; Need to do this here because define-derived-mode sets up
2959 ;; the keymap so late.
2962 ;; Assume this is Greg's port, it used easymenu
2978 ;;(setq outline-regexp "\\(?:\\*+\\|[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\) \\)")
2987 ;; Calc embedded
2993 ;; Activate before-change-function
2997 ;; Check for running clock before killing a buffer
2999 ;; Paragraphs and auto-filling
3023 "Call COMMAND interactively, but pretend prefix are was ARG."
3030 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
3040 "Add text properties to entire string, from beginning to end.
3041 PLIST may be a list of properties, PROPS are individual properties and values
3042 that will be added to PLIST. Returns the string that was modified."
3045 string)
3049 ;;; Font-Lock stuff
3054 (define-key org-mouse-map
3055 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
3056 (when org-mouse-1-follows-link
3057 (define-key org-mouse-map [follow-link] 'mouse-face))
3058 (when org-tab-follows-link
3059 (define-key org-mouse-map [(tab)] 'org-open-at-point)
3060 (define-key org-mouse-map "\C-i" 'org-open-at-point))
3061 (when org-return-follows-link
3062 (define-key org-mouse-map [(return)] 'org-open-at-point)
3063 (define-key org-mouse-map "\C-m" 'org-open-at-point))
3065 (require 'font-lock)
3068 (defconst org-link-types '("https?" "ftp" "mailto" "file" "news" "bbdb" "vm"
3069 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp"))
3070 (defconst org-link-re-with-space
3071 (concat
3074 "[^" org-non-link-chars "]*"
3076 "Matches a link with spaces, optional angular brackets around it.")
3078 (defconst org-link-re-with-space2
3079 (concat
3084 "Matches a link with spaces, optional angular brackets around it.")
3086 (defconst org-angle-link-re
3087 (concat
3090 "[^" org-non-link-chars "]*"
3092 "Matches link with angular brackets, spaces are allowed.")
3093 (defconst org-plain-link-re
3094 (concat
3097 "Matches plain link, without spaces.")
3099 (defconst org-bracket-link-regexp
3101 "Matches a link in double brackets.")
3103 (defconst org-bracket-link-analytic-regexp
3104 (concat
3111 ; 1: http:
3112 ; 2: http
3113 ; 3: path
3114 ; 4: [desc]
3115 ; 5: desc
3118 (defconst org-ts-lengths
3119 (cons (length (format-time-string (car org-time-stamp-formats)))
3120 (length (format-time-string (cdr org-time-stamp-formats))))
3121 "This holds the lengths of the two different time formats.")
3123 "Regular expression for fast time stamp matching.")
3125 "Regular expression for fast time stamp matching.")
3126 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
3127 "Regular expression matching time strings for analysis.")
3128 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 ">")
3129 "Regular expression matching time stamps, with groups.")
3130 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[]>]")
3131 "Regular expression matching time stamps (also [..]), with groups.")
3132 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
3133 "Regular expression matching a time stamp range.")
3136 "Regular expression matching a time stamp or time stamp range.")
3138 (defvar org-�§emph-face nil)
3140 (defun org-do-emphasis-faces (limit)
3141 "Run through the buffer and add overlays to links."
3142 (if (re-search-forward org-emph-re limit t)
3143 (progn
3144 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
3145 'face
3146 (nth 1 (assoc (match-string 3)
3147 org-emphasis-alist)))
3148 (add-text-properties (match-beginning 2) (match-end 2)
3149 '(font-lock-multiline t))
3150 (backward-char 1)
3151 t)))
3153 (defun org-activate-plain-links (limit)
3154 "Run through the buffer and add overlays to links."
3155 (if (re-search-forward org-plain-link-re limit t)
3156 (progn
3157 (add-text-properties (match-beginning 0) (match-end 0)
3158 (list 'mouse-face 'highlight
3159 'keymap org-mouse-map
3160 ))
3161 t)))
3163 (defun org-activate-angle-links (limit)
3164 "Run through the buffer and add overlays to links."
3165 (if (re-search-forward org-angle-link-re limit t)
3166 (progn
3167 (add-text-properties (match-beginning 0) (match-end 0)
3168 (list 'mouse-face 'highlight
3169 'keymap org-mouse-map
3170 ))
3171 t)))
3173 (defun org-activate-bracket-links (limit)
3174 "Run through the buffer and add overlays to bracketed links."
3175 (if (re-search-forward org-bracket-link-regexp limit t)
3176 (let* ((help (concat "LINK: "
3177 (org-match-string-no-properties 1)))
3178 ;; FIXME: above we should remove the escapes.
3179 ;; but that requires another match, protecting match data,
3180 ;; a lot of overhead for font-lock.
3181 (ip (list 'invisible 'org-link 'intangible t 'rear-nonsticky t
3182 'keymap org-mouse-map 'mouse-face 'highlight
3183 'help-echo help))
3184 (vp (list 'rear-nonsticky t
3185 'keymap org-mouse-map 'mouse-face 'highlight
3186 'help-echo help)))
3187 ;; We need to remove the invisible property here. Table narrowing
3188 ;; may have made some of this invisible.
3189 (remove-text-properties (match-beginning 0) (match-end 0)
3190 '(invisible nil))
3191 (if (match-end 3)
3192 (progn
3193 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
3194 (add-text-properties (match-beginning 3) (match-end 3) vp)
3195 (add-text-properties (match-end 3) (match-end 0) ip))
3196 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
3197 (add-text-properties (match-beginning 1) (match-end 1) vp)
3198 (add-text-properties (match-end 1) (match-end 0) ip))
3199 t)))
3201 (defun org-activate-dates (limit)
3202 "Run through the buffer and add overlays to dates."
3203 (if (re-search-forward org-tsr-regexp limit t)
3204 (progn
3205 (add-text-properties (match-beginning 0) (match-end 0)
3206 (list 'mouse-face 'highlight
3207 'keymap org-mouse-map))
3208 t)))
3210 (defvar org-target-link-regexp nil
3211 "Regular expression matching radio targets in plain text.")
3213 "Regular expression matching a link target.")
3215 "Regular expression matching a link target.")
3217 (defun org-activate-target-links (limit)
3218 "Run through the buffer and add overlays to target matches."
3219 (when org-target-link-regexp
3220 (let ((case-fold-search t))
3221 (if (re-search-forward org-target-link-regexp limit t)
3222 (progn
3223 (add-text-properties (match-beginning 0) (match-end 0)
3224 (list 'mouse-face 'highlight
3225 'keymap org-mouse-map
3226 'help-echo "Radio target link"
3227 'org-linked-text t))
3228 t)))))
3230 (defun org-update-radio-target-regexp ()
3231 "Find all radio targets in this file and update the regular expression."
3232 (interactive)
3233 (when (memq 'radio org-activate-links)
3234 (setq org-target-link-regexp
3235 (org-make-target-link-regexp (org-all-targets 'radio)))
3236 (org-restart-font-lock)))
3238 (defun org-hide-wide-columns (limit)
3239 (let (s e)
3240 (setq s (text-property-any (point) (or limit (point-max))
3241 'org-cwidth t))
3242 (when s
3243 (setq e (next-single-property-change s 'org-cwidth))
3244 (add-text-properties s e '(invisible org-cwidth intangible t))
3245 (goto-char e)
3246 t)))
3248 (defun org-restart-font-lock ()
3249 "Restart font-lock-mode, to force refontification."
3250 (when (and (boundp 'font-lock-mode) font-lock-mode)
3251 (font-lock-mode -1)
3252 (font-lock-mode 1)))
3254 (defun org-all-targets (&optional radio)
3255 "Return a list of all targets in this file.
3256 With optional argument RADIO, only find radio targets."
3257 (let ((re (if radio org-radio-target-regexp org-target-regexp))
3258 rtn)
3259 (save-excursion
3260 (goto-char (point-min))
3261 (while (re-search-forward re nil t)
3262 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
3263 rtn)))
3265 (defun org-make-target-link-regexp (targets)
3266 "Make regular expression matching all strings in TARGETS.
3267 The regular expression finds the targets also if there is a line break
3268 between words."
3269 (and targets
3270 (concat
3272 (mapconcat
3273 (lambda (x)
3274 (while (string-match " +" x)
3276 x)
3277 targets
3282 "Matches CamelCase words, possibly with a star before it.")
3284 (defun org-activate-camels (limit)
3285 "Run through the buffer and add overlays to dates."
3286 (if (re-search-forward org-camel-regexp limit t)
3287 (progn
3288 (add-text-properties (match-beginning 0) (match-end 0)
3289 (list 'mouse-face 'highlight
3290 'keymap org-mouse-map))
3291 t)))
3293 (defun org-activate-tags (limit)
3295 (progn
3296 (add-text-properties (match-beginning 1) (match-end 1)
3297 (list 'mouse-face 'highlight
3298 'keymap org-mouse-map))
3299 t)))
3301 (defun org-font-lock-level ()
3302 (save-excursion
3303 (org-back-to-heading t)
3304 (- (match-end 0) (match-beginning 0))))
3306 (defun org-outline-level ()
3307 (save-excursion
3308 (looking-at outline-regexp)
3309 (if (match-beginning 1)
3310 (+ (org-get-string-indentation (match-string 1)) 1000)
3311 (- (match-end 0) (match-beginning 0)))))
3313 (defvar org-font-lock-keywords nil)
3315 (defun org-set-font-lock-defaults ()
3316 (let* ((em org-fontify-emphasized-text)
3317 (lk org-activate-links)
3318 (org-font-lock-extra-keywords
3319 ;; Headlines
3320 (list
3322 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
3324 (1 'org-table))
3325 ;; Links
3326 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
3327 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
3328 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
3329 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
3330 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
3331 (if (memq 'camel lk) '(org-activate-camels (0 'org-link t)))
3332 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
3333 (if org-table-limit-column-width
3334 '(org-hide-wide-columns (0 nil append)))
3335 ;; TODO lines
3337 '(1 'org-todo t))
3338 ;; Priorities
3340 ;; Special keywords
3345 ;; Emphasis
3346 (if em '(org-do-emphasis-faces))
3347 ;; Checkboxes, similar to Frank Ruell's org-checklet.el
3349 2 'bold prepend)
3350 (if org-provide-checkbox-statistics
3352 (0 (org-get-checkbox-statistics-face) t)))
3353 ;; COMMENT
3356 '(1 'org-special-keyword t))
3357 '("^#.*" (0 'font-lock-comment-face t))
3358 ;; DONE
3359 (if org-fontify-done-headline
3361 '(1 'org-done t) '(2 'org-headline-done t))
3363 '(1 'org-done t)))
3364 ;; Table stuff
3368 (if org-format-transports-properties-p
3371 )))
3372 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
3373 ;; Now set the full font-lock-keywords
3374 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
3375 (org-set-local 'font-lock-defaults
3376 '(org-font-lock-keywords t nil nil backward-paragraph))
3377 (kill-local-variable 'font-lock-keywords) nil))
3379 (defvar org-m nil)
3380 (defvar org-l nil)
3381 (defvar org-f nil)
3382 (defun org-get-level-face (n)
3383 "Get the right face for match N in font-lock matching of healdines."
3384 (setq org-l (- (match-end 2) (match-beginning 1)))
3385 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
3386 ; (setq org-f (nth (1- (% org-l org-n-levels)) org-level-faces))
3387 (setq org-f (nth (% (1- org-l) org-n-levels) org-level-faces))
3388 (cond
3389 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
3390 ((eq n 2) org-f)
3391 (t (if org-level-color-stars-only nil org-f))))
3393 (defun org-unfontify-region (beg end &optional maybe_loudly)
3394 "Remove fontification and activation overlays from links."
3395 (font-lock-default-unfontify-region beg end)
3396 (let* ((buffer-undo-list t)
3397 (inhibit-read-only t) (inhibit-point-motion-hooks t)
3398 (inhibit-modification-hooks t)
3399 deactivate-mark buffer-file-name buffer-file-truename)
3400 (remove-text-properties beg end
3401 '(mouse-face nil keymap nil org-linked-text nil
3402 invisible nil intangible nil))))
3403 ;;; Visibility cycling
3405 (defvar org-cycle-global-status nil)
3406 (make-variable-buffer-local 'org-cycle-global-status)
3407 (defvar org-cycle-subtree-status nil)
3408 (make-variable-buffer-local 'org-cycle-subtree-status)
3410 ;;;###autoload
3411 (defun org-cycle (&optional arg)
3412 "Visibility cycling for Org-mode.
3414 - When this function is called with a prefix argument, rotate the entire
3415 buffer through 3 states (global cycling)
3416 1. OVERVIEW: Show only top-level headlines.
3417 2. CONTENTS: Show all headlines of all levels, but no body text.
3418 3. SHOW ALL: Show everything.
3420 - When point is at the beginning of a headline, rotate the subtree started
3421 by this line through 3 different states (local cycling)
3422 1. FOLDED: Only the main headline is shown.
3423 2. CHILDREN: The main headline and the direct children are shown.
3424 From this state, you can move to one of the children
3425 and zoom in further.
3426 3. SUBTREE: Show the entire subtree, including body text.
3428 - When there is a numeric prefix, go up to a heading with level ARG, do
3429 a `show-subtree' and return to the previous cursor position. If ARG
3430 is negative, go up that many levels.
3432 - When point is not at the beginning of a headline, execute
3433 `indent-relative', like TAB normally does. See the option
3434 `org-cycle-emulate-tab' for details.
3436 - Special case: if point is the the beginning of the buffer and there is
3437 no headline in line 1, this function will act as if called with prefix arg."
3438 (interactive "P")
3439 (let* ((outline-regexp
3440 (if org-cycle-include-plain-lists
3442 outline-regexp))
3443 (bob-special (and org-cycle-global-at-bob (bobp)
3444 (not (looking-at outline-regexp))))
3445 (org-cycle-hook
3446 (if bob-special
3447 (delq 'org-optimize-window-after-visibility-change
3448 (copy-sequence org-cycle-hook))
3449 org-cycle-hook))
3450 (pos (point)))
3452 (if (or bob-special (equal arg '(4)))
3453 ;; special case: use global cycling
3454 (setq arg t))
3456 (cond
3458 ((org-at-table-p 'any)
3459 ;; Enter the table or move to the next field in the table
3460 (or (org-table-recognize-table.el)
3461 (progn
3462 (if arg (org-table-edit-field t)
3463 (org-table-justify-field-maybe)
3464 (call-interactively 'org-table-next-field)))))
3466 ((eq arg t) ;; Global cycling
3468 (cond
3469 ((and (eq last-command this-command)
3470 (eq org-cycle-global-status 'overview))
3471 ;; We just created the overview - now do table of contents
3472 ;; This can be slow in very large buffers, so indicate action
3473 (message "CONTENTS...")
3474 (org-content)
3475 (message "CONTENTS...done")
3476 (setq org-cycle-global-status 'contents)
3477 (run-hook-with-args 'org-cycle-hook 'contents))
3479 ((and (eq last-command this-command)
3480 (eq org-cycle-global-status 'contents))
3481 ;; We just showed the table of contents - now show everything
3482 (show-all)
3483 (message "SHOW ALL")
3484 (setq org-cycle-global-status 'all)
3485 (run-hook-with-args 'org-cycle-hook 'all))
3487 (t
3488 ;; Default action: go to overview
3489 (org-overview)
3490 (message "OVERVIEW")
3491 (setq org-cycle-global-status 'overview)
3492 (run-hook-with-args 'org-cycle-hook 'overview))))
3494 ((integerp arg)
3495 ;; Show-subtree, ARG levels up from here.
3496 (save-excursion
3497 (org-back-to-heading)
3498 (outline-up-heading (if (< arg 0) (- arg)
3499 (- (funcall outline-level) arg)))
3500 (org-show-subtree)))
3502 ((save-excursion (beginning-of-line 1) (looking-at outline-regexp))
3503 ;; At a heading: rotate between three different views
3504 (org-back-to-heading)
3505 (let ((goal-column 0) eoh eol eos)
3506 ;; First, some boundaries
3507 (save-excursion
3508 (org-back-to-heading)
3509 (save-excursion
3510 (beginning-of-line 2)
3511 (while (and (not (eobp)) ;; this is like `next-line'
3512 (get-char-property (1- (point)) 'invisible))
3513 (beginning-of-line 2)) (setq eol (point)))
3514 (outline-end-of-heading) (setq eoh (point))
3515 (org-end-of-subtree t) (setq eos (point))
3516 (outline-next-heading))
3517 ;; Find out what to do next and set `this-command'
3518 (cond
3519 ((and (= eos eoh)
3520 ;; Nothing is hidden behind this heading
3521 (message "EMPTY ENTRY")
3522 (setq org-cycle-subtree-status nil)))
3523 ((>= eol eos)
3524 ;; Entire subtree is hidden in one line: open it
3525 (org-show-entry)
3526 (show-children)
3527 (message "CHILDREN")
3528 (setq org-cycle-subtree-status 'children)
3529 (run-hook-with-args 'org-cycle-hook 'children))
3530 ((and (eq last-command this-command)
3531 (eq org-cycle-subtree-status 'children))
3532 ;; We just showed the children, now show everything.
3533 (org-show-subtree)
3534 (message "SUBTREE")
3535 (setq org-cycle-subtree-status 'subtree)
3536 (run-hook-with-args 'org-cycle-hook 'subtree))
3537 (t
3538 ;; Default action: hide the subtree.
3539 (hide-subtree)
3540 (message "FOLDED")
3541 (setq org-cycle-subtree-status 'folded)
3542 (run-hook-with-args 'org-cycle-hook 'folded)))))
3544 ;; TAB emulation
3545 (buffer-read-only (org-back-to-heading))
3547 ((org-try-cdlatex-tab))
3549 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
3551 (or (and (eq org-cycle-emulate-tab 'white)
3552 (= (match-end 0) (point-at-eol)))
3553 (and (eq org-cycle-emulate-tab 'whitestart)
3554 (>= (match-end 0) pos))))
3555 t
3556 (eq org-cycle-emulate-tab t))
3559 (point-at-bol) (point))))
3560 (progn
3561 (beginning-of-line 1)
3563 (indent-relative))
3565 (t (save-excursion
3566 (org-back-to-heading)
3567 (org-cycle))))))
3569 ;;;###autoload
3570 (defun org-global-cycle (&optional arg)
3571 "Cycle the global visibility. For details see `org-cycle'."
3572 (interactive "P")
3573 (if (integerp arg)
3574 (progn
3575 (show-all)
3576 (hide-sublevels arg)
3577 (setq org-cycle-global-status 'contents))
3578 (org-cycle '(4))))
3580 (defun org-overview ()
3581 "Switch to overview mode, shoing only top-level headlines.
3582 Really, this shows all headlines with level equal or greater than the level
3583 of the first headline in the buffer. This is important, because if the
3584 first headline is not level one, then (hide-sublevels 1) gives confusing
3585 results."
3586 (interactive)
3587 (hide-sublevels (save-excursion
3588 (goto-char (point-min))
3589 (if (re-search-forward (concat "^" outline-regexp) nil t)
3590 (progn
3591 (goto-char (match-beginning 0))
3592 (funcall outline-level))
3593 1))))
3595 ;; FIXME: allow an argument to give a limiting level for this.
3596 (defun org-content ()
3597 "Show all headlines in the buffer, like a table of contents"
3598 (interactive)
3599 (save-excursion
3600 ;; Visit all headings and show their offspring
3601 (goto-char (point-max))
3602 (catch 'exit
3603 (while (and (progn (condition-case nil
3604 (outline-previous-visible-heading 1)
3605 (error (goto-char (point-min))))
3606 t)
3607 (looking-at outline-regexp))
3608 (show-branches)
3609 (if (bobp) (throw 'exit nil))))))
3612 (defun org-optimize-window-after-visibility-change (state)
3613 "Adjust the window after a change in outline visibility.
3614 This function is the default value of the hook `org-cycle-hook'."
3615 (when (get-buffer-window (current-buffer))
3616 (cond
3617 ((eq state 'overview) (org-first-headline-recenter 1))
3618 ((eq state 'content) nil)
3619 ((eq state 'all) nil)
3620 ((eq state 'folded) nil)
3621 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
3622 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
3624 (defun org-subtree-end-visible-p ()
3625 "Is the end of the current subtree visible?"
3626 (pos-visible-in-window-p
3627 (save-excursion (org-end-of-subtree t) (point))))
3629 (defun org-first-headline-recenter (&optional N)
3630 "Move cursor to the first headline and recenter the headline.
3631 Optional argument N means, put the headline into the Nth line of the window."
3632 (goto-char (point-min))
3634 (beginning-of-line)
3635 (recenter (prefix-numeric-value N))))
3637 (defvar org-goto-window-configuration nil)
3638 (defvar org-goto-marker nil)
3639 (defvar org-goto-map (make-sparse-keymap))
3640 (let ((cmds '(isearch-forward isearch-backward)) cmd)
3641 (while (setq cmd (pop cmds))
3642 (substitute-key-definition cmd cmd org-goto-map global-map)))
3643 (define-key org-goto-map "\C-m" 'org-goto-ret)
3644 (define-key org-goto-map [(left)] 'org-goto-left)
3645 (define-key org-goto-map [(right)] 'org-goto-right)
3646 (define-key org-goto-map [(?q)] 'org-goto-quit)
3647 (define-key org-goto-map [(control ?g)] 'org-goto-quit)
3648 (define-key org-goto-map "\C-i" 'org-cycle)
3649 (define-key org-goto-map [(tab)] 'org-cycle)
3650 (define-key org-goto-map [(down)] 'outline-next-visible-heading)
3651 (define-key org-goto-map [(up)] 'outline-previous-visible-heading)
3652 (define-key org-goto-map "n" 'outline-next-visible-heading)
3653 (define-key org-goto-map "p" 'outline-previous-visible-heading)
3654 (define-key org-goto-map "f" 'outline-forward-same-level)
3655 (define-key org-goto-map "b" 'outline-backward-same-level)
3656 (define-key org-goto-map "u" 'outline-up-heading)
3657 (define-key org-goto-map "\C-c\C-n" 'outline-next-visible-heading)
3658 (define-key org-goto-map "\C-c\C-p" 'outline-previous-visible-heading)
3659 (define-key org-goto-map "\C-c\C-f" 'outline-forward-same-level)
3660 (define-key org-goto-map "\C-c\C-b" 'outline-backward-same-level)
3661 (define-key org-goto-map "\C-c\C-u" 'outline-up-heading)
3662 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
3663 (while l (define-key org-goto-map (int-to-string (pop l)) 'digit-argument)))
3665 (defconst org-goto-help
3666 "Select a location to jump to, press RET
3667 \[Up]/[Down]=next/prev headline TAB=cycle visibility RET=select [Q]uit")
3669 (defun org-goto ()
3670 "Go to a different location of the document, keeping current visibility.
3672 When you want to go to a different location in a document, the fastest way
3673 is often to fold the entire buffer and then dive into the tree. This
3674 method has the disadvantage, that the previous location will be folded,
3675 which may not be what you want.
3677 This command works around this by showing a copy of the current buffer in
3678 overview mode. You can dive into the tree in that copy, to find the
3679 location you want to reach. When pressing RET, the command returns to the
3680 original buffer in which the visibility is still unchanged. It then jumps
3681 to the new location, making it and the headline hierarchy above it visible."
3682 (interactive)
3683 (let* ((org-goto-start-pos (point))
3684 (selected-point
3685 (org-get-location (current-buffer) org-goto-help)))
3686 (if selected-point
3687 (progn
3688 (org-mark-ring-push org-goto-start-pos)
3689 (goto-char selected-point)
3690 (if (or (org-invisible-p) (org-invisible-p2))
3691 (org-show-hierarchy-above)))
3692 (error "Quit"))))
3694 (defun org-get-location (buf help)
3695 "Let the user select a location in the Org-mode buffer BUF.
3696 This function uses a recursive edit. It returns the selected position
3697 or nil."
3698 (let (org-selected-point)
3699 (save-excursion
3700 (save-window-excursion
3701 (delete-other-windows)
3702 (switch-to-buffer (get-buffer-create "*org-goto*"))
3703 (with-output-to-temp-buffer "*Help*"
3704 (princ help))
3705 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
3706 (setq buffer-read-only nil)
3707 (erase-buffer)
3708 (insert-buffer-substring buf)
3709 (let ((org-startup-truncated t)
3710 (org-startup-folded t)
3711 (org-startup-align-all-tables nil)
3712 (org-startup-with-deadline-check nil))
3713 (org-mode))
3714 (setq buffer-read-only t)
3715 (if (boundp 'org-goto-start-pos)
3716 (goto-char org-goto-start-pos)
3717 (goto-char (point-min)))
3718 (org-beginning-of-line)
3719 (message "Select location and press RET")
3720 ;; now we make sure that during selection, ony very few keys work
3721 ;; and that it is impossible to switch to another window.
3722 (let ((gm (current-global-map))
3723 (overriding-local-map org-goto-map))
3724 (unwind-protect
3725 (progn
3726 (use-global-map org-goto-map)
3727 (recursive-edit))
3728 (use-global-map gm)))))
3729 (kill-buffer "*org-goto*")
3730 org-selected-point))
3732 (defun org-goto-ret (&optional arg)
3733 "Finish `org-goto' by going to the new location."
3734 (interactive "P")
3735 (setq org-selected-point (point)
3736 current-prefix-arg arg)
3737 (throw 'exit nil))
3739 (defun org-goto-left ()
3740 "Finish `org-goto' by going to the new location."
3741 (interactive)
3742 (if (org-on-heading-p)
3743 (progn
3744 (beginning-of-line 1)
3745 (setq org-selected-point (point)
3746 current-prefix-arg (- (match-end 0) (match-beginning 0)))
3747 (throw 'exit nil))
3748 (error "Not on a heading")))
3750 (defun org-goto-right ()
3751 "Finish `org-goto' by going to the new location."
3752 (interactive)
3753 (if (org-on-heading-p)
3754 (progn
3755 (outline-end-of-subtree)
3756 (or (eobp) (forward-char 1))
3757 (setq org-selected-point (point)
3758 current-prefix-arg (- (match-end 0) (match-beginning 0)))
3759 (throw 'exit nil))
3760 (error "Not on a heading")))
3762 (defun org-goto-quit ()
3763 "Finish `org-goto' without cursor motion."
3764 (interactive)
3765 (setq org-selected-point nil)
3766 (throw 'exit nil))
3768 ;;; Promotion, Demotion, Inserting new headlines
3770 (defvar org-ignore-region nil
3771 "To temporarily disable the active region.")
3773 (defun org-insert-heading (&optional force-heading)
3774 "Insert a new heading or item with same depth at point.
3775 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
3776 If point is at the beginning of a headline, insert a sibling before the
3777 current headline. If point is in the middle of a headline, split the headline
3778 at that position and make the rest of the headline part of the sibling below
3779 the current headline."
3780 (interactive "P")
3781 (if (= (buffer-size) 0)
3783 (when (or force-heading (not (org-insert-item)))
3784 (let* ((head (save-excursion
3785 (condition-case nil
3786 (progn
3787 (org-back-to-heading)
3788 (match-string 0))
3789 (error "*"))))
3790 pos)
3791 (cond
3792 ((and (org-on-heading-p) (bolp)
3793 (save-excursion (backward-char 1) (not (org-invisible-p))))
3794 (open-line 1))
3795 ((and (bolp) (save-excursion
3796 (backward-char 1) (not (org-invisible-p))))
3797 nil)
3798 (t (newline)))
3799 (insert head) (just-one-space)
3800 (setq pos (point))
3801 (end-of-line 1)
3802 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
3803 (run-hooks 'org-insert-heading-hook)))))
3805 (defun org-in-item-p ()
3806 "It the cursor inside a plain list item.
3807 Does not have to be the first line."
3808 (save-excursion
3809 (condition-case nil
3810 (progn
3811 (org-beginning-of-item)
3812 (org-at-item-p)
3813 t)
3814 (error nil))))
3816 (defun org-insert-item (&optional checkbox)
3817 "Insert a new item at the current level.
3818 Return t when things worked, nil when we are not in an item."
3819 (when (save-excursion
3820 (condition-case nil
3821 (progn
3822 (org-beginning-of-item)
3823 (org-at-item-p)
3824 t)
3825 (error nil)))
3826 (let* ((bul (match-string 0))
3828 (match-end 0)))
3829 pos)
3830 (cond
3831 ((and (org-at-item-p) (<= (point) eow))
3832 ;; before the bullet
3833 (beginning-of-line 1)
3834 (open-line 1))
3835 ((<= (point) eow)
3836 (beginning-of-line 1))
3837 (t (newline)))
3838 (insert bul (if checkbox "[ ]" ""))
3839 (just-one-space)
3840 (setq pos (point))
3841 (end-of-line 1)
3842 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
3843 (org-maybe-renumber-ordered-list)
3844 (and checkbox (org-update-checkbox-count-maybe))
3845 t))
3847 (defun org-insert-todo-heading (arg)
3848 "Insert a new heading with the same level and TODO state as current heading.
3849 If the heading has no TODO state, or if the state is DONE, use the first
3850 state (TODO by default). Also with prefix arg, force first state."
3851 (interactive "P")
3852 (when (not (org-insert-item 'checkbox))
3853 (org-insert-heading)
3854 (save-excursion
3855 (org-back-to-heading)
3856 (outline-previous-heading)
3857 (looking-at org-todo-line-regexp))
3858 (if (or arg
3859 (not (match-beginning 2))
3860 (equal (match-string 2) org-done-string))
3861 (insert (car org-todo-keywords) " ")
3862 (insert (match-string 2) " "))))
3864 (defun org-promote-subtree ()
3865 "Promote the entire subtree.
3866 See also `org-promote'."
3867 (interactive)
3868 (save-excursion
3869 (org-map-tree 'org-promote))
3870 (org-fix-position-after-promote))
3872 (defun org-demote-subtree ()
3873 "Demote the entire subtree. See `org-demote'.
3874 See also `org-promote'."
3875 (interactive)
3876 (save-excursion
3877 (org-map-tree 'org-demote))
3878 (org-fix-position-after-promote))
3881 (defun org-do-promote ()
3882 "Promote the current heading higher up the tree.
3883 If the region is active in `transient-mark-mode', promote all headings
3884 in the region."
3885 (interactive)
3886 (save-excursion
3887 (if (org-region-active-p)
3888 (org-map-region 'org-promote (region-beginning) (region-end))
3889 (org-promote)))
3890 (org-fix-position-after-promote))
3892 (defun org-do-demote ()
3893 "Demote the current heading lower down the tree.
3894 If the region is active in `transient-mark-mode', demote all headings
3895 in the region."
3896 (interactive)
3897 (save-excursion
3898 (if (org-region-active-p)
3899 (org-map-region 'org-demote (region-beginning) (region-end))
3900 (org-demote)))
3901 (org-fix-position-after-promote))
3903 (defun org-fix-position-after-promote ()
3904 "Make sure that after pro/demotion cursor position is right."
3906 (save-excursion
3907 (skip-chars-backward "a-zA-Z0-9_@")
3908 (looking-at org-todo-regexp)))
3909 (insert " "))
3910 (and (equal (char-after) ?\ )
3911 (equal (char-before) ?*)
3912 (forward-char 1)))
3914 (defun org-get-legal-level (level change)
3915 "Rectify a level change under the influence of `org-odd-levels-only'
3916 LEVEL is a current level, CHANGE is by how much the level should be
3917 modified. Even if CHANGE is nil, LEVEL may be returned modified because
3918 even level numbers will become the next higher odd number."
3919 (if org-odd-levels-only
3920 (cond ((not change) (1+ (* 2 (/ level 2))))
3921 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
3922 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
3923 (max 1 (+ level change))))
3925 (defun org-promote ()
3926 "Promote the current heading higher up the tree.
3927 If the region is active in `transient-mark-mode', promote all headings
3928 in the region."
3929 (org-back-to-heading t)
3930 (let* ((level (save-match-data (funcall outline-level)))
3931 (up-head (make-string (org-get-legal-level level -1) ?*))
3932 (diff (abs (- level (length up-head)))))
3933 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover"))
3934 (replace-match up-head nil t)
3935 ;; Fixup tag positioning
3936 (and org-auto-align-tags (org-set-tags nil t))
3937 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
3939 (defun org-demote ()
3940 "Demote the current heading lower down the tree.
3941 If the region is active in `transient-mark-mode', demote all headings
3942 in the region."
3943 (org-back-to-heading t)
3944 (let* ((level (save-match-data (funcall outline-level)))
3945 (down-head (make-string (org-get-legal-level level 1) ?*))
3946 (diff (abs (- level (length down-head)))))
3947 (replace-match down-head nil t)
3948 ;; Fixup tag positioning
3949 (and org-auto-align-tags (org-set-tags nil t))
3950 (if org-adapt-indentation (org-fixup-indentation diff))))
3952 (defun org-map-tree (fun)
3953 "Call FUN for every heading underneath the current one."
3954 (org-back-to-heading)
3955 (let ((level (funcall outline-level)))
3956 (save-excursion
3957 (funcall fun)
3958 (while (and (progn
3959 (outline-next-heading)
3960 (> (funcall outline-level) level))
3961 (not (eobp)))
3962 (funcall fun)))))
3964 (defun org-map-region (fun beg end)
3965 "Call FUN for every heading between BEG and END."
3966 (let ((org-ignore-region t))
3967 (save-excursion
3968 (setq end (copy-marker end))
3969 (goto-char beg)
3970 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
3971 (< (point) end))
3972 (funcall fun))
3973 (while (and (progn
3974 (outline-next-heading)
3975 (< (point) end))
3976 (not (eobp)))
3977 (funcall fun)))))
3979 (defun org-fixup-indentation (diff)
3980 "Change the indentation in the current entry by DIFF
3981 However, if any line in the current entry has no indentation, or if it
3982 would end up with no indentation after the change, nothing at all is done."
3983 (save-excursion
3984 (let ((end (save-excursion (outline-next-heading)
3985 (point-marker)))
3986 (prohibit (if (> diff 0)
3989 col)
3990 (unless (save-excursion (re-search-forward prohibit end t))
3992 (goto-char (match-end 0))
3993 (setq col (current-column))
3994 (if (< diff 0) (replace-match ""))
3995 (indent-to (+ diff col))))
3996 (move-marker end nil))))
3998 ;;; Vertical tree motion, cutting and pasting of subtrees
4000 (defun org-move-subtree-up (&optional arg)
4001 "Move the current subtree up past ARG headlines of the same level."
4002 (interactive "p")
4003 (org-move-subtree-down (- (prefix-numeric-value arg))))
4005 (defun org-move-subtree-down (&optional arg)
4006 "Move the current subtree down past ARG headlines of the same level."
4007 (interactive "p")
4008 (setq arg (prefix-numeric-value arg))
4009 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
4010 'outline-get-last-sibling))
4011 (ins-point (make-marker))
4012 (cnt (abs arg))
4013 beg end txt folded)
4014 ;; Select the tree
4015 (org-back-to-heading)
4016 (setq beg (point))
4017 (save-match-data
4018 (save-excursion (outline-end-of-heading)
4019 (setq folded (org-invisible-p)))
4020 (outline-end-of-subtree))
4021 (outline-next-heading)
4022 (setq end (point))
4023 ;; Find insertion point, with error handling
4024 (goto-char beg)
4025 (while (> cnt 0)
4026 (or (and (funcall movfunc) (looking-at outline-regexp))
4027 (progn (goto-char beg)
4028 (error "Cannot move past superior level or buffer limit")))
4029 (setq cnt (1- cnt)))
4030 (if (> arg 0)
4031 ;; Moving forward - still need to move over subtree
4032 (progn (outline-end-of-subtree)
4033 (outline-next-heading)
4034 (if (not (or (looking-at (concat "^" outline-regexp))
4035 (bolp)))
4036 (newline))))
4037 (move-marker ins-point (point))
4038 (setq txt (buffer-substring beg end))
4039 (delete-region beg end)
4040 (insert txt)
4041 (goto-char ins-point)
4042 (if folded (hide-subtree))
4043 (move-marker ins-point nil)))
4045 (defvar org-subtree-clip ""
4046 "Clipboard for cut and paste of subtrees.
4047 This is actually only a copy of the kill, because we use the normal kill
4048 ring. We need it to check if the kill was created by `org-copy-subtree'.")
4050 (defvar org-subtree-clip-folded nil
4051 "Was the last copied subtree folded?
4052 This is used to fold the tree back after pasting.")
4054 (defun org-cut-subtree ()
4055 "Cut the current subtree into the clipboard.
4056 This is a short-hand for marking the subtree and then cutting it."
4057 (interactive)
4058 (org-copy-subtree 'cut))
4060 (defun org-copy-subtree (&optional cut)
4061 "Cut the current subtree into the clipboard.
4062 This is a short-hand for marking the subtree and then copying it.
4063 If CUT is non nil, actually cut the subtree."
4064 (interactive)
4065 (let (beg end folded)
4066 (org-back-to-heading)
4067 (setq beg (point))
4068 (save-match-data
4069 (save-excursion (outline-end-of-heading)
4070 (setq folded (org-invisible-p)))
4071 (outline-end-of-subtree))
4073 (setq end (point))
4074 (goto-char beg)
4075 (when (> end beg)
4076 (setq org-subtree-clip-folded folded)
4077 (if cut (kill-region beg end) (copy-region-as-kill beg end))
4078 (setq org-subtree-clip (current-kill 0))
4079 (message "%s: Subtree with %d characters"
4080 (if cut "Cut" "Copied")
4081 (length org-subtree-clip)))))
4083 (defun org-paste-subtree (&optional level tree)
4084 "Paste the clipboard as a subtree, with modification of headline level.
4085 The entire subtree is promoted or demoted in order to match a new headline
4086 level. By default, the new level is derived from the visible headings
4087 before and after the insertion point, and taken to be the inferior headline
4088 level of the two. So if the previous visible heading is level 3 and the
4089 next is level 4 (or vice versa), level 4 will be used for insertion.
4090 This makes sure that the subtree remains an independent subtree and does
4091 not swallow low level entries.
4093 You can also force a different level, either by using a numeric prefix
4094 argument, or by inserting the heading marker by hand. For example, if the
4099 If optional TREE is given, use this text instead of the kill ring."
4100 (interactive "P")
4101 (unless (org-kill-is-subtree-p tree)
4102 (error
4103 (substitute-command-keys
4105 (let* ((txt (or tree (and kill-ring (current-kill 0))))
4110 (old-level (if (string-match ^re txt)
4111 (- (match-end 0) (match-beginning 0))
4112 -1))
4113 (force-level (cond (level (prefix-numeric-value level))
4114 ((string-match
4115 ^re_ (buffer-substring (point-at-bol) (point)))
4116 (- (match-end 0) (match-beginning 0)))
4117 (t nil)))
4118 (previous-level (save-excursion
4119 (condition-case nil
4120 (progn
4121 (outline-previous-visible-heading 1)
4122 (if (looking-at re)
4123 (- (match-end 0) (match-beginning 0))
4124 1))
4125 (error 1))))
4126 (next-level (save-excursion
4127 (condition-case nil
4128 (progn
4129 (outline-next-visible-heading 1)
4130 (if (looking-at re)
4131 (- (match-end 0) (match-beginning 0))
4132 1))
4133 (error 1))))
4134 (new-level (or force-level (max previous-level next-level)))
4135 (shift (if (or (= old-level -1)
4136 (= new-level -1)
4137 (= old-level new-level))
4138 0
4139 (- new-level old-level)))
4140 (shift1 shift)
4141 (delta (if (> shift 0) -1 1))
4142 (func (if (> shift 0) 'org-demote 'org-promote))
4143 (org-odd-levels-only nil)
4144 beg end)
4145 ;; Remove the forces level indicator
4146 (if force-level
4147 (delete-region (point-at-bol) (point)))
4148 ;; Make sure we start at the beginning of an empty line
4152 ;; Paste
4153 (setq beg (point))
4156 (insert txt)
4157 (setq end (point))
4160 (goto-char beg)
4161 ;; Shift if necessary
4162 (if (= shift 0)
4163 (message "Pasted at level %d, without shift" new-level)
4164 (save-restriction
4165 (narrow-to-region beg end)
4166 (while (not (= shift 0))
4167 (org-map-region func (point-min) (point-max))
4168 (setq shift (+ delta shift)))
4169 (goto-char (point-min))
4170 (message "Pasted at level %d, with shift by %d levels"
4171 new-level shift1)))
4172 (if (and kill-ring
4173 (eq org-subtree-clip (current-kill 0))
4174 org-subtree-clip-folded)
4175 ;; The tree was folded before it was killed/copied
4176 (hide-subtree))))
4178 (defun org-kill-is-subtree-p (&optional txt)
4179 "Check if the current kill is an outline subtree, or a set of trees.
4180 Returns nil if kill does not start with a headline, or if the first
4181 headline level is not the largest headline level in the tree.
4182 So this will actually accept several entries of equal levels as well,
4183 which is OK for `org-paste-subtree'.
4184 If optional TXT is given, check this string instead of the current kill."
4185 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
4186 (start-level (and kill
4188 (- (match-end 0) (match-beginning 0))))
4189 (re (concat "^" outline-regexp))
4190 (start 1))
4191 (if (not start-level)
4192 nil ;; does not even start with a heading
4193 (catch 'exit
4194 (while (setq start (string-match re kill (1+ start)))
4195 (if (< (- (match-end 0) (match-beginning 0)) start-level)
4196 (throw 'exit nil)))
4197 t))))
4199 (defun org-narrow-to-subtree ()
4200 "Narrow buffer to the current subtree."
4201 (interactive)
4202 (save-excursion
4203 (narrow-to-region
4204 (progn (org-back-to-heading) (point))
4205 (progn (org-end-of-subtree t) (point)))))
4207 ;;; Plain list items
4209 (defun org-at-item-p ()
4210 "Is point in a line starting a hand-formatted item?"
4211 (let ((llt org-plain-list-ordered-item-terminator))
4212 (save-excursion
4213 (goto-char (point-at-bol))
4214 (looking-at
4215 (cond
4219 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
4221 (defun org-at-item-checkbox-p ()
4222 "Is point at a line starting a plain-list item with a checklet?"
4223 (and (org-at-item-p)
4224 (save-excursion
4225 (goto-char (match-end 0))
4229 (defun org-toggle-checkbox (&optional arg)
4230 "Toggle the checkbox in the current line."
4231 (interactive "P")
4232 (catch 'exit
4233 (let (beg end status (firstnew 'unknown))
4234 (cond
4235 ((org-region-active-p)
4236 (setq beg (region-beginning) end (region-end)))
4237 ((org-on-heading-p)
4238 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
4239 ((org-at-item-checkbox-p)
4240 (save-excursion
4241 (replace-match (if (equal (match-string 0) "[ ]") "[X]" "[ ]") t t))
4242 (throw 'exit t))
4243 (t (error "Not at a checkbox or heading, and no active region")))
4244 (save-excursion
4245 (goto-char beg)
4246 (while (< (point) end)
4247 (when (org-at-item-checkbox-p)
4248 (setq status (equal (match-string 0) "[X]"))
4249 (when (eq firstnew 'unknown)
4250 (setq firstnew (not status)))
4251 (replace-match
4252 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
4253 (beginning-of-line 2)))))
4254 (org-update-checkbox-count-maybe))
4256 (defun org-update-checkbox-count-maybe ()
4257 "Update checkbox statistics unless turned off by user."
4258 (when org-provide-checkbox-statistics
4259 (org-update-checkbox-count)))
4261 (defun org-update-checkbox-count (&optional all)
4262 "Update the checkbox statistics in the current section.
4263 This will find all statistic cookies like [57%] and [6/12] and update them
4264 with the current numbers. With optional prefix argument ALL, do this for
4265 the whole buffer."
4266 (interactive "P")
4267 (save-excursion
4268 (let* ((buffer-invisibility-spec nil)
4269 (beg (progn (outline-back-to-heading) (point)))
4270 (end (move-marker (make-marker)
4271 (progn (outline-next-heading) (point))))
4274 b1 e1 f1 c-on c-off lim (cstat 0))
4275 (when all
4276 (goto-char (point-min))
4277 (outline-next-heading)
4278 (setq beg (point) end (point-max)))
4279 (goto-char beg)
4280 (while (re-search-forward re end t)
4281 (setq cstat (1+ cstat)
4282 b1 (match-beginning 0)
4283 e1 (match-end 0)
4284 f1 (match-beginning 1)
4285 lim (cond
4286 ((org-on-heading-p) (outline-next-heading) (point))
4287 ((org-at-item-p) (org-end-of-item) (point))
4288 (t nil))
4289 c-on 0 c-off 0)
4290 (goto-char e1)
4291 (when lim
4292 (while (re-search-forward re-box lim t)
4293 (if (equal (match-string 2) "[ ]")
4294 (setq c-off (1+ c-off))
4295 (setq c-on (1+ c-on))))
4296 (delete-region b1 e1)
4297 (goto-char b1)
4298 (insert (if f1
4299 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
4300 (format "[%d/%d]" c-on (+ c-on c-off))))))
4301 (when (interactive-p)
4302 (message "Checkbox satistics updated %s (%d places)"
4303 (if all "in entire file" "in current outline entry") cstat)))))
4305 (defun org-get-checkbox-statistics-face ()
4306 "Select the face for checkbox statistics.
4307 The face will be `org-done' when all relevant boxes are checked. Otherwise
4308 it will be `org-todo'."
4309 (if (match-end 1)
4310 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
4311 (if (and (> (match-end 2) (match-beginning 2))
4312 (equal (match-string 2) (match-string 3)))
4313 'org-done
4314 'org-todo)))
4316 (defun org-get-indentation (&optional line)
4317 "Get the indentation of the current line, interpreting tabs.
4318 When LINE is given, assume it represents a line and compute its indentation."
4319 (if line
4320 (if (string-match "^ *" (org-remove-tabs line))
4321 (match-end 0))
4322 (save-excursion
4323 (beginning-of-line 1)
4325 (current-column))))
4327 (defun org-remove-tabs (s &optional width)
4328 "Replace tabulators in S with spaces.
4329 Assumes that s is a single line, starting in column 0."
4330 (setq width (or width tab-width))
4332 (setq s (replace-match
4333 (make-string
4334 (- (* width (/ (+ (match-beginning 0) width) width))
4335 (match-beginning 0)) ?\ )
4336 t t s)))
4337 s)
4339 ;; FIXME: document properly.
4340 (defun org-fix-indentation (line ind)
4341 "If the current indenation is smaller than ind1, leave it alone.
4342 If it is larger than ind, reduce it by ind."
4343 (let* ((l (org-remove-tabs line))
4344 (i (org-get-indentation l))
4345 (i1 (car ind)) (i2 (cdr ind)))
4346 (if (>= i i2) (setq l (substring line i2)))
4347 (if (> i1 0)
4348 (concat (make-string i1 ?\ ) l)
4349 l)))
4351 (defun org-beginning-of-item ()
4352 "Go to the beginning of the current hand-formatted item.
4353 If the cursor is not in an item, throw an error."
4354 (interactive)
4355 (let ((pos (point))
4356 (limit (save-excursion (org-back-to-heading)
4357 (beginning-of-line 2) (point)))
4358 ind ind1)
4359 (if (org-at-item-p)
4360 (beginning-of-line 1)
4361 (beginning-of-line 1)
4363 (setq ind (current-column))
4364 (if (catch 'exit
4365 (while t
4366 (beginning-of-line 0)
4367 (if (< (point) limit) (throw 'exit nil))
4370 (setq ind1 (current-column))
4371 (if (< ind1 ind)
4372 (throw 'exit (org-at-item-p))))))
4373 nil
4374 (goto-char pos)
4375 (error "Not in an item")))))
4377 (defun org-end-of-item ()
4378 "Go to the end of the current hand-formatted item.
4379 If the cursor is not in an item, throw an error."
4380 (interactive)
4381 (let ((pos (point))
4382 (limit (save-excursion (outline-next-heading) (point)))
4383 (ind (save-excursion
4384 (org-beginning-of-item)
4386 (current-column)))
4387 ind1)
4388 (if (catch 'exit
4389 (while t
4390 (beginning-of-line 2)
4391 (if (>= (point) limit) (throw 'exit t))
4394 (setq ind1 (current-column))
4395 (if (<= ind1 ind) (throw 'exit t)))))
4396 (beginning-of-line 1)
4397 (goto-char pos)
4398 (error "Not in an item"))))
4400 (defun org-next-item ()
4401 "Move to the beginning of the next item in the current plain list.
4402 Error if not at a plain list, or if this is the last item in the list."
4403 (interactive)
4404 (let (ind ind1 (pos (point)))
4405 (org-beginning-of-item)
4406 (setq ind (org-get-indentation))
4407 (org-end-of-item)
4408 (setq ind1 (org-get-indentation))
4409 (unless (and (org-at-item-p) (= ind ind1))
4410 (goto-char pos)
4411 (error "On last item"))))
4413 (defun org-previous-item ()
4414 "Move to the beginning of the previous item in the current plain list.
4415 Error if not at a plain list, or if this is the last item in the list."
4416 (interactive)
4417 (let (beg ind (pos (point)))
4418 (org-beginning-of-item)
4419 (setq beg (point))
4420 (setq ind (org-get-indentation))
4421 (goto-char beg)
4422 (catch 'exit
4423 (while t
4424 (beginning-of-line 0)
4426 nil
4427 (if (<= (org-get-indentation) ind)
4428 (throw 'exit t)))))
4429 (condition-case nil
4430 (org-beginning-of-item)
4431 (error (goto-char pos)
4432 (error "On first item")))))
4434 (defun org-move-item-down ()
4435 "Move the plain list item at point down, i.e. swap with following item.
4436 Subitems (items with larger indentation) are considered part of the item,
4437 so this really moves item trees."
4438 (interactive)
4439 (let (beg end ind ind1 (pos (point)) txt)
4440 (org-beginning-of-item)
4441 (setq beg (point))
4442 (setq ind (org-get-indentation))
4443 (org-end-of-item)
4444 (setq end (point))
4445 (setq ind1 (org-get-indentation))
4446 (if (and (org-at-item-p) (= ind ind1))
4447 (progn
4448 (org-end-of-item)
4449 (setq txt (buffer-substring beg end))
4450 (save-excursion
4451 (delete-region beg end))
4452 (setq pos (point))
4453 (insert txt)
4454 (goto-char pos)
4455 (org-maybe-renumber-ordered-list))
4456 (goto-char pos)
4457 (error "Cannot move this item further down"))))
4459 (defun org-move-item-up (arg)
4460 "Move the plain list item at point up, i.e. swap with previous item.
4461 Subitems (items with larger indentation) are considered part of the item,
4462 so this really moves item trees."
4463 (interactive "p")
4464 (let (beg end ind ind1 (pos (point)) txt)
4465 (org-beginning-of-item)
4466 (setq beg (point))
4467 (setq ind (org-get-indentation))
4468 (org-end-of-item)
4469 (setq end (point))
4470 (goto-char beg)
4471 (catch 'exit
4472 (while t
4473 (beginning-of-line 0)
4475 nil
4476 (if (<= (setq ind1 (org-get-indentation)) ind)
4477 (throw 'exit t)))))
4478 (condition-case nil
4479 (org-beginning-of-item)
4480 (error (goto-char beg)
4481 (error "Cannot move this item further up")))
4482 (setq ind1 (org-get-indentation))
4483 (if (and (org-at-item-p) (= ind ind1))
4484 (progn
4485 (setq txt (buffer-substring beg end))
4486 (save-excursion
4487 (delete-region beg end))
4488 (setq pos (point))
4489 (insert txt)
4490 (goto-char pos)
4491 (org-maybe-renumber-ordered-list))
4492 (goto-char pos)
4493 (error "Cannot move this item further up"))))
4495 (defun org-maybe-renumber-ordered-list ()
4496 "Renumber the ordered list at point if setup allows it.
4497 This tests the user option `org-auto-renumber-ordered-lists' before
4498 doing the renumbering."
4499 (and org-auto-renumber-ordered-lists
4500 (org-at-item-p)
4501 (match-beginning 3)
4502 (org-renumber-ordered-list 1)))
4504 (defun org-get-string-indentation (s)
4505 "What indentation has S due to SPACE and TAB at the beginning of the string?"
4506 (let ((n -1) (i 0) (w tab-width) c)
4507 (catch 'exit
4508 (while (< (setq n (1+ n)) (length s))
4509 (setq c (aref s n))
4510 (cond ((= c ?\ ) (setq i (1+ i)))
4512 (t (throw 'exit t)))))
4513 i))
4515 (defun org-renumber-ordered-list (arg)
4516 "Renumber an ordered plain list.
4517 Cursor needs to be in the first line of an item, the line that starts
4519 (interactive "p")
4520 (unless (and (org-at-item-p)
4521 (match-beginning 3))
4522 (error "This is not an ordered list"))
4523 (let ((line (org-current-line))
4524 (col (current-column))
4525 (ind (org-get-string-indentation
4526 (buffer-substring (point-at-bol) (match-beginning 3))))
4527 ;; (term (substring (match-string 3) -1))
4528 ind1 (n (1- arg)))
4529 ;; find where this list begins
4530 (catch 'exit
4531 (while t
4532 (catch 'next
4533 (beginning-of-line 0)
4536 (if (or (< ind1 ind)
4537 (and (= ind1 ind)
4538 (not (org-at-item-p))))
4539 (throw 'exit t)))))
4540 ;; Walk forward and replace these numbers
4541 (catch 'exit
4542 (while t
4543 (catch 'next
4544 (beginning-of-line 2)
4545 (if (eobp) (throw 'exit nil))
4548 (if (> ind1 ind) (throw 'next t))
4549 (if (< ind1 ind) (throw 'exit t))
4550 (if (not (org-at-item-p)) (throw 'exit nil))
4551 (if (not (match-beginning 3))
4553 (delete-region (match-beginning 3) (1- (match-end 3)))
4554 (goto-char (match-beginning 3))
4555 (insert (format "%d" (setq n (1+ n)))))))
4556 (goto-line line)
4557 (move-to-column col)))
4559 (defvar org-last-indent-begin-marker (make-marker))
4560 (defvar org-last-indent-end-marker (make-marker))
4562 (defun org-outdent-item (arg)
4563 "Outdent a local list item."
4564 (interactive "p")
4565 (org-indent-item (- arg)))
4567 (defun org-indent-item (arg)
4568 "Indent a local list item."
4569 (interactive "p")
4570 (unless (org-at-item-p)
4571 (error "Not on an item"))
4572 (save-excursion
4573 (let (beg end ind ind1)
4574 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
4575 (setq beg org-last-indent-begin-marker
4576 end org-last-indent-end-marker)
4577 (org-beginning-of-item)
4578 (setq beg (move-marker org-last-indent-begin-marker (point)))
4579 (org-end-of-item)
4580 (setq end (move-marker org-last-indent-end-marker (point))))
4581 (goto-char beg)
4583 (if (< (+ arg ind) 0) (error "Cannot outdent beyond margin"))
4584 (while (< (point) end)
4585 (beginning-of-line 1)
4587 (delete-region (point-at-bol) (point))
4588 (indent-to-column (+ ind1 arg))
4589 (beginning-of-line 2)))))
4591 ;;; Archiving
4593 (defun org-archive-subtree (&optional find-done)
4594 "Move the current subtree to the archive.
4595 The archive can be a certain top-level heading in the current file, or in
4596 a different file. The tree will be moved to that location, the subtree
4597 heading be marked DONE, and the current time will be added.
4599 When called with prefix argument FIND-DONE, find whole trees without any
4600 open TODO items and archive them (after getting confirmation from the user).
4601 If the cursor is not at a headline when this comand is called, try all level
4602 1 trees. If the cursor is on a headline, only try the direct children of
4603 this heading. "
4604 (interactive "P")
4605 (if find-done
4606 (org-archive-all-done)
4607 ;; Save all relevant TODO keyword-relatex variables
4609 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
4610 (tr-org-todo-keywords org-todo-keywords)
4611 (tr-org-todo-interpretation org-todo-interpretation)
4612 (tr-org-done-string org-done-string)
4613 (tr-org-todo-regexp org-todo-regexp)
4614 (tr-org-todo-line-regexp org-todo-line-regexp)
4615 (this-buffer (current-buffer))
4616 file heading buffer level newfile-p)
4618 (progn
4619 (setq file (format (match-string 1 org-archive-location)
4620 (file-name-nondirectory buffer-file-name))
4621 heading (match-string 2 org-archive-location)))
4622 (error "Invalid `org-archive-location'"))
4623 (if (> (length file) 0)
4624 (setq newfile-p (not (file-exists-p file))
4625 buffer (find-file-noselect file))
4626 (setq buffer (current-buffer)))
4627 (unless buffer
4629 (if (and (> (length heading) 0)
4631 (setq level (match-end 0))
4632 (setq heading nil level 0))
4633 (save-excursion
4634 ;; We first only copy, in case something goes wrong
4635 ;; we need to protect this-command, to avoid kill-region sets it,
4636 ;; which would lead to duplication of subtrees
4637 (let (this-command) (org-copy-subtree))
4638 (set-buffer buffer)
4639 ;; Enforce org-mode for the archive buffer
4640 (if (not (org-mode-p))
4641 ;; Force the mode for future visits.
4642 (let ((org-insert-mode-line-in-empty-file t))
4643 (call-interactively 'org-mode)))
4644 (when newfile-p
4645 (goto-char (point-max))
4647 (buffer-file-name this-buffer))))
4648 ;; Force the TODO keywords of the original buffer
4649 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
4650 (org-todo-keywords tr-org-todo-keywords)
4651 (org-todo-interpretation tr-org-todo-interpretation)
4652 (org-done-string tr-org-done-string)
4653 (org-todo-regexp tr-org-todo-regexp)
4654 (org-todo-line-regexp tr-org-todo-line-regexp))
4655 (goto-char (point-min))
4656 (if heading
4657 (progn
4658 (if (re-search-forward
4661 nil t)
4662 (goto-char (match-end 0))
4663 ;; Heading not found, just insert it at the end
4664 (goto-char (point-max))
4667 (end-of-line 0))
4668 ;; Make the subtree visible
4669 (show-subtree)
4670 (org-end-of-subtree t)
4674 ;; No specific heading, just go to end of file.
4676 ;; Paste
4677 (org-paste-subtree (1+ level))
4678 ;; Mark the entry as done, i.e. set to last work in org-todo-keywords
4679 (if org-archive-mark-done
4680 (org-todo (length org-todo-keywords)))
4681 ;; Move cursor to right after the TODO keyword
4682 (when org-archive-stamp-time
4683 (beginning-of-line 1)
4684 (looking-at org-todo-line-regexp)
4685 (goto-char (or (match-end 2) (match-beginning 3)))
4686 (insert "(" (format-time-string (cdr org-time-stamp-formats)
4687 (org-current-time))
4688 ")"))
4689 ;; Save the buffer, if it is not the same buffer.
4690 (if (not (eq this-buffer buffer)) (save-buffer))))
4691 ;; Here we are back in the original buffer. Everything seems to have
4692 ;; worked. So now cut the tree and finish up.
4693 (let (this-command) (org-cut-subtree))
4695 (message "Subtree archived %s"
4696 (if (eq this-buffer buffer)
4697 (concat "under heading: " heading)
4698 (concat "in file: " (abbreviate-file-name file)))))))
4700 (defun org-archive-all-done (&optional tag)
4701 "Archive sublevels of the current tree without open TODO items.
4702 If the cursor is not on a headline, try all level 1 trees. If
4703 it is on a headline, try all direct children.
4704 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
4706 (rea (concat ".*:" org-archive-tag ":"))
4707 (begm (make-marker))
4708 (endm (make-marker))
4709 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
4710 "Move subtree to archive (no open TODO items)? "))
4711 beg end (cntarch 0))
4712 (if (org-on-heading-p)
4713 (progn
4714 (setq re1 (concat "^" (regexp-quote
4715 (make-string
4716 (1+ (- (match-end 0) (match-beginning 0)))
4717 ?*))
4718 " "))
4719 (move-marker begm (point))
4720 (move-marker endm (org-end-of-subtree)))
4721 (setq re1 "^* ")
4722 (move-marker begm (point-min))
4723 (move-marker endm (point-max)))
4724 (save-excursion
4725 (goto-char begm)
4726 (while (re-search-forward re1 endm t)
4727 (setq beg (match-beginning 0)
4728 end (save-excursion (org-end-of-subtree t) (point)))
4729 (goto-char beg)
4730 (if (re-search-forward re end t)
4731 (goto-char end)
4732 (goto-char beg)
4733 (if (and (or (not tag) (not (looking-at rea)))
4734 (y-or-n-p question))
4735 (progn
4736 (if tag
4737 (org-toggle-tag org-archive-tag 'on)
4738 (org-archive-subtree))
4739 (setq cntarch (1+ cntarch)))
4740 (goto-char end)))))
4741 (message "%d trees archived" cntarch)))
4743 (defun org-cycle-hide-archived-subtrees (state)
4744 "Re-hide all archived subtrees after a visibility state change."
4745 (when (and (not org-cycle-open-archived-trees)
4746 (not (memq state '(overview folded))))
4747 (save-excursion
4748 (let* ((globalp (memq state '(contents all)))
4749 (beg (if globalp (point-min) (point)))
4750 (end (if globalp (point-max) (org-end-of-subtree))))
4751 (org-hide-archived-subtrees beg end)
4752 (goto-char beg)
4753 (if (looking-at (concat ".*:" org-archive-tag ":"))
4754 (message (substitute-command-keys
4755 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4757 (defun org-force-cycle-archived ()
4758 "Cycle subtree even if it is archived."
4759 (interactive)
4760 (setq this-command 'org-cycle)
4761 (let ((org-cycle-open-archived-trees t))
4762 (call-interactively 'org-cycle)))
4764 (defun org-hide-archived-subtrees (beg end)
4765 "Re-hide all archived subtrees after a visibility state change."
4766 (save-excursion
4767 (let* ((re (concat ":" org-archive-tag ":")))
4768 (goto-char beg)
4769 (while (re-search-forward re end t)
4770 (and (org-on-heading-p) (hide-subtree))
4771 (org-end-of-subtree)))))
4773 (defun org-toggle-tag (tag &optional onoff)
4774 "Toggle the tag TAG for the current line.
4775 If ONOFF is `on' or `off', don't toggle but set to this state."
4776 (unless (org-on-heading-p) (error "Not on headling"))
4777 (let (res current)
4778 (save-excursion
4779 (beginning-of-line)
4781 (point-at-eol) t)
4782 (progn
4783 (setq current (match-string 1))
4784 (replace-match ""))
4785 (setq current ""))
4786 (setq current (nreverse (org-split-string current ":")))
4787 (cond
4788 ((eq onoff 'on)
4789 (setq res t)
4790 (or (member tag current) (push tag current)))
4791 ((eq onoff 'off)
4792 (or (not (member tag current)) (setq current (delete tag current))))
4793 (t (if (member tag current)
4794 (setq current (delete tag current))
4795 (setq res t)
4796 (push tag current))))
4797 (end-of-line 1)
4798 (when current
4799 (insert " :" (mapconcat 'identity (nreverse current) ":") ":"))
4800 (org-set-tags nil t))
4801 res))
4803 (defun org-toggle-archive-tag (&optional arg)
4804 "Toggle the archive tag for the current headline.
4805 With prefix ARG, check all children of current headline and offer tagging
4806 the children that do not contain any open TODO items."
4807 (interactive "P")
4808 (if arg
4809 (org-archive-all-done 'tag)
4810 (let (set)
4811 (save-excursion
4812 (org-back-to-heading t)
4813 (setq set (org-toggle-tag org-archive-tag))
4814 (when set (hide-subtree)))
4815 (and set (beginning-of-line 1))
4816 (message "Subtree %s" (if set "archived" "unarchived")))))
4818 (defvar org-agenda-multi nil) ; dynammically scoped
4819 (defvar org-agenda-buffer-name "*Org Agenda*")
4820 (defun org-prepare-agenda ()
4821 (if org-agenda-multi
4822 (progn
4823 (setq buffer-read-only nil)
4824 (goto-char (point-max))
4825 (unless (= (point) 1)
4827 (narrow-to-region (point) (point-max)))
4828 (org-agenda-maybe-reset-markers 'force)
4829 (org-prepare-agenda-buffers (org-agenda-files))
4830 (unless (equal (current-buffer) (get-buffer org-agenda-buffer-name))
4831 (delete-other-windows)
4832 (switch-to-buffer-other-window
4833 (get-buffer-create org-agenda-buffer-name)))
4834 (setq buffer-read-only nil)
4835 (erase-buffer)
4836 (org-agenda-mode))
4837 (setq buffer-read-only nil)) ;;; FIXME: do we need all these occasions????
4839 (defun org-prepare-agenda-buffers (files)
4840 "Create buffers for all agenda files, protect archived trees and comments."
4841 (interactive)
4842 (let ((pa '(:org-archived t))
4843 (pc '(:org-comment t))
4844 (pall '(:org-archived t :org-comment t))
4845 (rea (concat ":" org-archive-tag ":"))
4846 bmp file re)
4847 (save-excursion
4848 (while (setq file (pop files))
4849 (org-check-agenda-file file)
4850 (set-buffer (org-get-agenda-file-buffer file))
4851 (widen)
4852 (setq bmp (buffer-modified-p))
4853 (save-excursion
4854 (remove-text-properties (point-min) (point-max) pall)
4855 (when org-agenda-skip-archived-trees
4856 (goto-char (point-min))
4857 (while (re-search-forward rea nil t)
4858 (if (org-on-heading-p)
4859 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
4860 (goto-char (point-min))
4862 (while (re-search-forward re nil t)
4863 (add-text-properties
4864 (match-beginning 0) (org-end-of-subtree t) pc)))
4865 (set-buffer-modified-p bmp)))))
4867 (defun org-agenda-skip ()
4868 "Throw to `:skip' in places that should be skipped."
4869 (let ((p (point-at-bol)))
4870 (and org-agenda-skip-archived-trees
4871 (get-text-property p :org-archived)
4872 (org-end-of-subtree)
4873 (throw :skip t))
4874 (and (get-text-property p :org-comment)
4875 (org-end-of-subtree)
4876 (throw :skip t))
4877 (if (equal (char-after p) ?#) (throw :skip t))))
4879 (defun org-agenda-toggle-archive-tag ()
4880 "Toggle the archive tag for the current entry."
4881 (interactive)
4882 (org-agenda-check-no-diary)
4883 (org-agenda-show) ;;; FIXME This is a stupid hack and should not be needed
4884 (let* ((hdmarker (or (get-text-property (point) 'org-hd-marker)
4885 (org-agenda-error)))
4886 (buffer (marker-buffer hdmarker))
4887 (pos (marker-position hdmarker))
4888 (buffer-read-only nil)
4889 newhead)
4890 (with-current-buffer buffer
4891 (widen)
4892 (goto-char pos)
4893 (org-show-hidden-entry)
4894 (save-excursion
4895 (and (outline-next-heading)
4896 (org-flag-heading nil))) ; show the next heading
4897 (call-interactively 'org-toggle-archive-tag)
4898 (end-of-line 1)
4899 (setq newhead (org-get-heading)))
4900 (org-agenda-change-all-lines newhead hdmarker)
4901 (beginning-of-line 1)))
4903 ;;; Dynamic blocks
4905 (defun org-find-dblock (name)
4906 "Find the first dynamic block with name NAME in the buffer.
4907 If not found, stay at current position and return nil."
4908 (let (pos)
4909 (save-excursion
4910 (goto-char (point-min))
4912 nil t)
4913 (match-beginning 0))))
4914 (if pos (goto-char pos))
4915 pos))
4917 (defconst org-dblock-start-re
4919 "Matches the startline of a dynamic block, with parameters.")
4922 "Matches the end of a dyhamic block.")
4924 (defun org-create-dblock (plist)
4925 "Create a dynamic block section, with parameters taken from PLIST.
4926 PLIST must containe a :name entry which is used as name of the block."
4927 (unless (bolp) (newline))
4928 (let ((name (plist-get plist :name)))
4929 (insert "#+BEGIN: " name)
4930 (while plist
4931 (if (eq (car plist) :name)
4932 (setq plist (cddr plist))
4933 (insert " " (prin1-to-string (pop plist)))))
4935 (beginning-of-line -2)))
4937 (defun org-prepare-dblock ()
4938 "Prepare dynamic block for refresh.
4939 This empties the block, puts the cursor at the insert position and returns
4940 the property list including an extra property :name with the block name."
4941 (unless (looking-at org-dblock-start-re)
4942 (error "Not at a dynamic block"))
4943 (let* ((begdel (1+ (match-end 0)))
4944 (name (match-string 1))
4945 (params (append (list :name name)
4946 (read (concat "(" (match-string 3) ")")))))
4947 (unless (re-search-forward org-dblock-end-re nil t)
4948 (error "Dynamic block not terminated"))
4949 (delete-region begdel (match-beginning 0))
4950 (goto-char begdel)
4951 (open-line 1)
4952 params))
4954 (defun org-map-dblocks (&optional command)
4955 "Apply COMMAND to all dynamic blocks in the current buffer.
4956 If COMMAND is not given, use `org-update-dblock'."
4957 (let ((cmd (or command 'org-update-dblock))
4958 pos)
4959 (save-excursion
4960 (goto-char (point-min))
4961 (while (re-search-forward org-dblock-start-re nil t)
4962 (goto-char (setq pos (match-beginning 0)))
4963 (condition-case nil
4964 (funcall cmd)
4965 (error (message "Error during update of dynamic block")))
4966 (goto-char pos)
4967 (unless (re-search-forward org-dblock-end-re nil t)
4968 (error "Dynamic block not terminated"))))))
4970 (defun org-dblock-update (&optional arg)
4971 "User command for updating dynamic blocks.
4972 Update the dynamic block at point. With prefix ARG, update all dynamic
4973 blocks in the buffer."
4974 (interactive "P")
4975 (if arg
4976 (org-update-all-dblocks)
4977 (or (looking-at org-dblock-start-re)
4978 (org-beginning-of-dblock))
4979 (org-update-dblock)))
4981 (defun org-update-dblock ()
4982 "Update the dynamic block at point
4983 This means to empty the block, parse for parameters and then call
4984 the correct writing function."
4985 (let* ((pos (point))
4986 (params (org-prepare-dblock))
4987 (name (plist-get params :name))
4988 (cmd (intern (concat "org-dblock-write:" name))))
4989 (funcall cmd params)
4990 (goto-char pos)))
4992 (defun org-beginning-of-dblock ()
4993 "Find the beginning of the dynamic block at point.
4994 Error if there is no scuh block at point."
4995 (let ((pos (point))
4996 beg)
4997 (end-of-line 1)
4998 (if (and (re-search-backward org-dblock-start-re nil t)
4999 (setq beg (match-beginning 0))
5000 (re-search-forward org-dblock-end-re nil t)
5001 (> (match-end 0) pos))
5002 (goto-char beg)
5003 (goto-char pos)
5004 (error "Not in a dynamic block"))))
5006 (defun org-update-all-dblocks ()
5007 "Update all dynamic blocks in the buffer.
5008 This function can be used in a hook."
5009 (when (org-mode-p)
5010 (org-map-dblocks 'org-update-dblock)))
5013 ;;; Completion
5015 (defun org-complete (&optional arg)
5016 "Perform completion on word at point.
5017 At the beginning of a headline, this completes TODO keywords as given in
5018 `org-todo-keywords'.
5019 If the current word is preceded by a backslash, completes the TeX symbols
5020 that are supported for HTML support.
5022 setting file options.
5024 At all other locations, this simply calls `ispell-complete-word'."
5025 (interactive "P")
5026 (catch 'exit
5027 (let* ((end (point))
5028 (beg1 (save-excursion
5029 ;FIXME??? (if (equal (char-before (point)) ?\ ) (backward-char 1))
5030 (skip-chars-backward "a-zA-Z_@0-9")
5031 (point)))
5032 (beg (save-excursion
5033 ;FIXME??? (if (equal (char-before (point)) ?\ ) (backward-char 1))
5034 (skip-chars-backward "a-zA-Z0-9_:$")
5035 (point)))
5036 (confirm (lambda (x) (stringp (car x))))
5037 (camel (equal (char-before beg) ?*))
5038 (tag (equal (char-before beg1) ?:))
5040 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
5041 beg)
5042 "#+"))
5044 (buffer-substring (point-at-bol) (point))))
5045 (completion-ignore-case opt)
5046 (type nil)
5047 (tbl nil)
5048 (table (cond
5049 (opt
5050 (setq type :opt)
5051 (mapcar (lambda (x)
5053 (cons (match-string 2 x) (match-string 1 x)))
5055 (startup
5056 (setq type :startup)
5057 org-startup-options)
5058 (texp
5059 (setq type :tex)
5060 org-html-entities)
5062 (buffer-substring (point-at-bol) beg))
5063 (setq type :todo)
5064 (mapcar 'list org-todo-keywords))
5065 (camel
5066 (setq type :camel)
5067 (save-excursion
5068 (goto-char (point-min))
5069 (while (re-search-forward org-todo-line-regexp nil t)
5070 (push (list
5071 (if org-file-link-context-use-camel-case
5072 (org-make-org-heading-camel (match-string 3) t)
5073 (org-make-org-heading-search-string
5074 (match-string 3) t)))
5075 tbl)))
5076 tbl)
5077 (tag (setq type :tag beg beg1)
5078 (or org-tag-alist (org-get-buffer-tags)))
5079 (t (progn (ispell-complete-word arg) (throw 'exit nil)))))
5080 (pattern (buffer-substring-no-properties beg end))
5081 (completion (try-completion pattern table confirm)))
5082 (cond ((eq completion t)
5083 (if (equal type :opt)
5084 (insert (substring (cdr (assoc (upcase pattern) table))
5085 (length pattern)))))
5086 ((null completion)
5088 (ding))
5089 ((not (string= pattern completion))
5090 (delete-region beg end)
5091 (if (string-match " +$" completion)
5092 (setq completion (replace-match "" t t completion)))
5093 (insert completion)
5094 (if (get-buffer-window "*Completions*")
5095 (delete-window (get-buffer-window "*Completions*")))
5096 (if (assoc completion table)
5097 (if (eq type :todo) (insert " ")
5098 (if (eq type :tag) (insert ":"))))
5099 (if (and (equal type :opt) (assoc completion table))
5100 (message "%s" (substitute-command-keys
5102 (t
5103 (message "Making completion list...")
5104 (let ((list (sort (all-completions pattern table confirm)
5105 'string<)))
5106 (with-output-to-temp-buffer "*Completions*"
5107 (condition-case nil
5108 ;; Protection needed for XEmacs and emacs 21
5109 (display-completion-list list pattern)
5110 (error (display-completion-list list)))))
5111 (message "Making completion list...%s" "done"))))))
5113 ;;; Comments, TODO and DEADLINE
5115 (defun org-toggle-comment ()
5116 "Change the COMMENT state of an entry."
5117 (interactive)
5118 (save-excursion
5119 (org-back-to-heading)
5120 (if (looking-at (concat outline-regexp
5122 (replace-match "" t t nil 1)
5123 (if (looking-at outline-regexp)
5124 (progn
5125 (goto-char (match-end 0))
5126 (insert " " org-comment-string))))))
5128 (defvar org-last-todo-state-is-todo nil
5129 "This is non-nil when the last TODO state change led to a TODO state.
5130 If the last change removed the TODO tag or switched to DONE, then
5131 this is nil.")
5133 (defun org-todo (&optional arg)
5134 "Change the TODO state of an item.
5135 The state of an item is given by a keyword at the start of the heading,
5136 like
5137 *** TODO Write paper
5138 *** DONE Call mom
5140 The different keywords are specified in the variable `org-todo-keywords'.
5142 So for this example: when the item starts with TODO, it is changed to DONE.
5143 When it starts with DONE, the DONE is removed. And when neither TODO nor
5144 DONE are present, add TODO at the beginning of the heading.
5146 With prefix arg, use completion to determine the new state. With numeric
5147 prefix arg, switch to that state."
5148 (interactive "P")
5149 (save-excursion
5150 (org-back-to-heading)
5151 (if (looking-at outline-regexp) (goto-char (match-end 0)))
5152 (or (looking-at (concat " +" org-todo-regexp " *"))
5153 (looking-at " *"))
5154 (let* ((this (match-string 1))
5155 (completion-ignore-case t)
5156 (member (member this org-todo-keywords))
5157 (tail (cdr member))
5158 (state (cond
5159 ((equal arg '(4))
5160 ;; Read a state with completion
5161 (completing-read "State: " (mapcar (lambda(x) (list x))
5162 org-todo-keywords)
5163 nil t))
5164 ((eq arg 'right)
5165 (if this
5166 (if tail (car tail) nil)
5167 (car org-todo-keywords)))
5168 ((eq arg 'left)
5169 (if (equal member org-todo-keywords)
5170 nil
5171 (if this
5172 (nth (- (length org-todo-keywords) (length tail) 2)
5173 org-todo-keywords)
5174 org-done-string)))
5175 (arg
5176 ;; user requests a specific state
5177 (nth (1- (prefix-numeric-value arg))
5178 org-todo-keywords))
5179 ((null member) (car org-todo-keywords))
5180 ((null tail) nil) ;; -> first entry
5181 ((eq org-todo-interpretation 'sequence)
5182 (car tail))
5183 ((memq org-todo-interpretation '(type priority))
5184 (if (eq this-command last-command)
5185 (car tail)
5186 (if (> (length tail) 0) org-done-string nil)))
5187 (t nil)))
5188 (next (if state (concat " " state " ") " ")))
5189 (replace-match next t t)
5190 (setq org-last-todo-state-is-todo
5191 (not (equal state org-done-string)))
5192 (when org-log-done
5193 (if (equal state org-done-string)
5194 (org-add-planning-info 'closed (current-time) 'scheduled)
5195 (if (not this)
5196 (org-add-planning-info nil nil 'closed))))
5197 ;; Fixup tag positioning
5198 (and org-auto-align-tags (org-set-tags nil t))
5199 (run-hooks 'org-after-todo-state-change-hook)))
5200 ;; Fixup cursor location if close to the keyword
5201 (if (and (outline-on-heading-p)
5202 (not (bolp))
5203 (save-excursion (beginning-of-line 1)
5204 (looking-at org-todo-line-regexp))
5205 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
5206 (progn
5207 (goto-char (or (match-end 2) (match-end 1)))
5208 (just-one-space))))
5210 (defun org-log-done (&optional undone)
5211 "Add a time stamp logging that a TODO entry has been closed.
5212 When UNDONE is non-nil, remove such a time stamp again."
5213 (interactive)
5214 (let (beg end col)
5215 (save-excursion
5216 (org-back-to-heading t)
5217 (setq beg (point))
5218 (looking-at (concat outline-regexp " *"))
5219 (goto-char (match-end 0))
5220 (setq col (current-column))
5221 (outline-next-heading)
5222 (setq end (point))
5223 (goto-char beg)
5224 (when (re-search-forward (concat
5226 (regexp-quote org-closed-string)
5228 (delete-region (match-beginning 1) (match-end 1)))
5229 (unless undone
5230 (org-back-to-heading t)
5232 (goto-char (min (1+ (point)) (point-max)))
5235 (indent-to col)
5236 (insert org-closed-string " "
5237 (format-time-string
5238 (concat "[" (substring (cdr org-time-stamp-formats) 1 -1) "]")
5239 (org-current-time))
5242 (defun org-show-todo-tree (arg)
5243 "Make a compact tree which shows all headlines marked with TODO.
5244 The tree will show the lines where the regexp matches, and all higher
5245 headlines above the match.
5247 With a numeric prefix N, construct a sparse tree for the Nth element
5248 of `org-todo-keywords'."
5249 (interactive "P")
5250 (let ((case-fold-search nil)
5251 (kwd-re
5252 (cond ((null arg) org-not-done-regexp)
5253 ((equal arg '(4)) org-todo-regexp)
5254 ((<= (prefix-numeric-value arg) (length org-todo-keywords))
5255 (regexp-quote (nth (1- (prefix-numeric-value arg))
5256 org-todo-keywords)))
5257 (t (error "Invalid prefix argument: %s" arg)))))
5258 (message "%d TODO entries found"
5259 (org-occur (concat "^" outline-regexp " +" kwd-re )))))
5261 (defun org-deadline ()
5262 "Insert the DEADLINE: string to make a deadline.
5264 to modify it to the correct date."
5265 (interactive)
5266 (org-add-planning-info 'deadline nil 'closed))
5268 (defun org-schedule ()
5269 "Insert the SCHEDULED: string to schedule a TODO item.
5271 to modify it to the correct date."
5272 (interactive)
5273 (org-add-planning-info 'scheduled nil 'closed))
5275 (defun org-add-planning-info (what &optional time &rest remove)
5276 "Insert new timestamp with keyword in the line directly after the headline.
5277 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
5278 If non is given, the user is prompted for a date.
5279 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
5280 be removed."
5281 (interactive)
5282 (when what (setq time (or time (org-read-date nil 'to-time))))
5283 (when (and org-insert-labeled-timestamps-at-point
5284 (member what '(scheduled deadline)))
5285 (insert
5286 (if (eq what 'scheduled) org-scheduled-string org-deadline-string)
5287 " "
5288 (format-time-string (car org-time-stamp-formats) time))
5289 (setq what nil))
5290 (save-excursion
5291 (let (col list elt (buffer-invisibility-spec nil) ts)
5292 (org-back-to-heading t)
5294 (goto-char (match-end 1))
5295 (setq col (current-column))
5296 (goto-char (1+ (match-end 0)))
5297 (if (and (not (looking-at outline-regexp))
5300 (not (equal (match-string 1) org-clock-string)))
5301 (narrow-to-region (match-beginning 0) (match-end 0))
5303 (backward-char 1)
5304 (narrow-to-region (point) (point))
5305 (indent-to-column col))
5306 ;; Check if we have to remove something.
5307 (setq list (cons what remove))
5308 (while list
5309 (setq elt (pop list))
5310 (goto-char (point-min))
5311 (when (or (and (eq elt 'scheduled)
5312 (re-search-forward org-scheduled-time-regexp nil t))
5313 (and (eq elt 'deadline)
5314 (re-search-forward org-deadline-time-regexp nil t))
5315 (and (eq elt 'closed)
5316 (re-search-forward org-closed-time-regexp nil t)))
5317 (replace-match "")
5318 (if (looking-at " +") (replace-match ""))))
5319 (goto-char (point-max))
5320 (when what
5321 (insert
5322 (if (not (equal (char-before) ?\ )) " " "")
5323 (cond ((eq what 'scheduled) org-scheduled-string)
5324 ((eq what 'deadline) org-deadline-string)
5325 ((eq what 'closed) org-closed-string))
5326 " ")
5327 (insert
5328 (setq ts
5329 (format-time-string
5330 (if (eq what 'closed)
5331 (concat "[" (substring (cdr org-time-stamp-formats) 1 -1) "]")
5332 (car org-time-stamp-formats))
5333 time))))
5334 (goto-char (point-min))
5335 (widen)
5337 (replace-match ""))
5338 ts)))
5340 (defun org-occur (regexp &optional callback)
5341 "Make a compact tree which shows all matches of REGEXP.
5342 The tree will show the lines where the regexp matches, and all higher
5343 headlines above the match. It will also show the heading after the match,
5344 to make sure editing the matching entry is easy.
5345 If CALLBACK is non-nil, it is a function which is called to confirm
5346 that the match should indeed be shown."
5347 (interactive "sRegexp: ")
5348 (org-remove-occur-highlights nil nil t)
5349 (let ((cnt 0))
5350 (save-excursion
5351 (goto-char (point-min))
5352 (org-overview)
5353 (while (re-search-forward regexp nil t)
5354 (when (or (not callback)
5355 (save-match-data (funcall callback)))
5356 (setq cnt (1+ cnt))
5357 (org-highlight-new-match (match-beginning 0) (match-end 0))
5358 (org-show-hierarchy-above))))
5359 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
5360 nil 'local)
5361 (unless org-sparse-tree-open-archived-trees
5362 (org-hide-archived-subtrees (point-min) (point-max)))
5363 (run-hooks 'org-occur-hook)
5364 (if (interactive-p)
5365 (message "%d match(es) for regexp %s" cnt regexp))
5366 cnt))
5368 (defun org-show-hierarchy-above ()
5369 "Make sure point and the headings hierarchy above is visible."
5370 (catch 'exit
5371 (if (org-on-heading-p t)
5372 (org-flag-heading nil) ; only show the heading
5373 (and (or (org-invisible-p) (org-invisible-p2))
5374 (org-show-hidden-entry))) ; show entire entry
5375 (save-excursion
5376 (and org-show-following-heading
5377 (outline-next-heading)
5378 (org-flag-heading nil))) ; show the next heading
5379 (when org-show-hierarchy-above
5380 (save-excursion ; show all higher headings
5381 (while (and (condition-case nil
5382 (progn (org-up-heading-all 1) t)
5383 (error nil))
5384 (not (bobp)))
5385 (org-flag-heading nil))))))
5387 ;; Overlay compatibility functions
5388 (defun org-make-overlay (beg end &optional buffer)
5389 (if (featurep 'xemacs)
5390 (make-extent beg end buffer)
5391 (make-overlay beg end buffer)))
5392 (defun org-delete-overlay (ovl)
5393 (if (featurep 'xemacs) (delete-extent ovl) (delete-overlay ovl)))
5394 (defun org-detatch-overlay (ovl)
5395 (if (featurep 'xemacs) (detach-extent ovl) (delete-overlay ovl)))
5396 (defun org-move-overlay (ovl beg end &optional buffer)
5397 (if (featurep 'xemacs)
5398 (set-extent-endpoints ovl beg end buffer)
5399 (move-overlay ovl beg end buffer)))
5400 (defun org-overlay-put (ovl prop value)
5401 (if (featurep 'xemacs)
5402 (set-extent-property ovl prop value)
5403 (overlay-put ovl prop value)))
5404 (defun org-overlays-at (pos)
5405 (if (featurep 'xemacs) (extents-at pos) (overlays-at pos)))
5406 (defun org-overlay-start (o)
5407 (if (featurep 'xemacs) (extent-start-position o) (overlay-start o)))
5408 (defun org-overlay-end (o)
5409 (if (featurep 'xemacs) (extent-end-position o) (overlay-end o)))
5411 (defvar org-occur-highlights nil)
5412 (make-variable-buffer-local 'org-occur-highlights)
5413 (defun org-highlight-new-match (beg end)
5414 "Highlight from BEG to END and mark the highlight is an occur headline."
5415 (let ((ov (org-make-overlay beg end)))
5416 (org-overlay-put ov 'face 'secondary-selection)
5417 (push ov org-occur-highlights)))
5419 (defvar org-inhibit-highlight-removal nil)
5420 (defun org-remove-occur-highlights (&optional beg end noremove)
5421 "Remove the occur highlights from the buffer.
5422 BEG and END are ignored. If NOREMOVE is nil, remove this function
5423 from the `before-change-functions' in the current buffer."
5424 (interactive)
5425 (unless org-inhibit-highlight-removal
5426 (mapc 'org-delete-overlay org-occur-highlights)
5427 (setq org-occur-highlights nil)
5428 (unless noremove
5429 (remove-hook 'before-change-functions
5430 'org-remove-occur-highlights 'local))))
5432 ;;; Priorities
5435 "Regular expression matching the priority indicator.")
5437 (defvar org-remove-priority-next-time nil)
5439 (defun org-priority-up ()
5440 "Increase the priority of the current item."
5441 (interactive)
5442 (org-priority 'up))
5444 (defun org-priority-down ()
5445 "Decrease the priority of the current item."
5446 (interactive)
5447 (org-priority 'down))
5449 (defun org-priority (&optional action)
5450 "Change the priority of an item by ARG.
5451 ACTION can be set, up, or down."
5452 (interactive)
5453 (setq action (or action 'set))
5454 (let (current new news have remove)
5455 (save-excursion
5456 (org-back-to-heading)
5457 (if (looking-at org-priority-regexp)
5458 (setq current (string-to-char (match-string 2))
5459 have t)
5460 (setq current org-default-priority))
5461 (cond
5462 ((eq action 'set)
5463 (message "Priority A-%c, SPC to remove: " org-lowest-priority)
5464 (setq new (read-char-exclusive))
5465 (cond ((equal new ?\ ) (setq remove t))
5466 ((or (< (upcase new) ?A) (> (upcase new) org-lowest-priority))
5467 (error "Priority must be between `%c' and `%c'"
5468 ?A org-lowest-priority))))
5469 ((eq action 'up)
5470 (setq new (1- current)))
5471 ((eq action 'down)
5472 (setq new (1+ current)))
5473 (t (error "Invalid action")))
5474 (setq new (min (max ?A (upcase new)) org-lowest-priority))
5475 (setq news (format "%c" new))
5476 (if have
5477 (if remove
5478 (replace-match "" t t nil 1)
5479 (replace-match news t t nil 2))
5480 (if remove
5481 (error "No priority cookie found in line")
5482 (looking-at org-todo-line-regexp)
5483 (if (match-end 2)
5484 (progn
5485 (goto-char (match-end 2))
5486 (insert " [#" news "]"))
5487 (goto-char (match-beginning 3))
5488 (insert "[#" news "] ")))))
5489 (if remove
5490 (message "Priority removed")
5491 (message "Priority of current item set to %s" news))))
5494 (defun org-get-priority (s)
5495 "Find priority cookie and return priority."
5496 (save-match-data
5497 (if (not (string-match org-priority-regexp s))
5498 (* 1000 (- org-lowest-priority org-default-priority))
5499 (* 1000 (- org-lowest-priority
5500 (string-to-char (match-string 2 s)))))))
5502 ;;; Timestamps
5504 (defvar org-last-changed-timestamp nil)
5506 (defun org-time-stamp (arg)
5507 "Prompt for a date/time and insert a time stamp.
5508 If the user specifies a time like HH:MM, or if this command is called
5509 with a prefix argument, the time stamp will contain date and time.
5510 Otherwise, only the date will be included. All parts of a date not
5511 specified by the user will be filled in from the current date/time.
5512 So if you press just return without typing anything, the time stamp
5513 will represent the current date/time. If there is already a timestamp
5514 at the cursor, it will be modified."
5515 (interactive "P")
5516 (let ((fmt (if arg (cdr org-time-stamp-formats)
5517 (car org-time-stamp-formats)))
5518 (org-time-was-given nil)
5519 time)
5520 (cond
5521 ((and (org-at-timestamp-p)
5522 (eq last-command 'org-time-stamp)
5523 (eq this-command 'org-time-stamp))
5524 (insert "--")
5525 (setq time (let ((this-command this-command))
5526 (org-read-date arg 'totime)))
5527 (if org-time-was-given (setq fmt (cdr org-time-stamp-formats)))
5528 (insert (format-time-string fmt time)))
5529 ((org-at-timestamp-p)
5530 (setq time (let ((this-command this-command))
5531 (org-read-date arg 'totime)))
5532 (and (org-at-timestamp-p) (replace-match
5533 (setq org-last-changed-timestamp
5534 (format-time-string fmt time))
5535 t t))
5536 (message "Timestamp updated"))
5537 (t
5538 (setq time (let ((this-command this-command))
5539 (org-read-date arg 'totime)))
5540 (if org-time-was-given (setq fmt (cdr org-time-stamp-formats)))
5541 (insert (format-time-string fmt time))))))
5543 (defun org-time-stamp-inactive (&optional arg)
5544 "Insert an inactive time stamp.
5545 An inactive time stamp is enclosed in square brackets instead of angle
5546 brackets. It is inactive in the sense that it does not trigger agenda entries,
5547 does not link to the calendar and cannot be changed with the S-cursor keys.
5548 So these are more for recording a certain time/date."
5549 (interactive "P")
5550 (let ((fmt (if arg (cdr org-time-stamp-formats)
5551 (car org-time-stamp-formats)))
5552 (org-time-was-given nil)
5553 time)
5554 (setq time (org-read-date arg 'totime))
5555 (if org-time-was-given (setq fmt (cdr org-time-stamp-formats)))
5556 (setq fmt (concat "[" (substring fmt 1 -1) "]"))
5557 (insert (format-time-string fmt time))))
5559 (defvar org-date-ovl (org-make-overlay 1 1))
5560 (org-overlay-put org-date-ovl 'face 'org-warning)
5561 (org-detatch-overlay org-date-ovl)
5563 (defun org-read-date (&optional with-time to-time)
5564 "Read a date and make things smooth for the user.
5565 The prompt will suggest to enter an ISO date, but you can also enter anything
5566 which will at least partially be understood by `parse-time-string'.
5567 Unrecognized parts of the date will default to the current day, month, year,
5568 hour and minute. For example,
5569 3-2-5 --> 2003-02-05
5570 feb 15 --> currentyear-02-15
5571 sep 12 9 --> 2009-09-12
5572 12:45 --> today 12:45
5573 22 sept 0:34 --> currentyear-09-22 0:34
5574 12 --> currentyear-currentmonth-12
5575 Fri --> nearest Friday (today or later)
5576 etc.
5577 The function understands only English month and weekday abbreviations,
5578 but this can be configured with the variables `parse-time-months' and
5579 `parse-time-weekdays'.
5581 While prompting, a calendar is popped up - you can also select the
5582 date with the mouse (button 1). The calendar shows a period of three
5583 months. To scroll it to other months, use the keys `>' and `<'.
5584 If you don't like the calendar, turn it off with
5585 \(setq org-popup-calendar-for-date-prompt nil)
5587 With optional argument TO-TIME, the date will immediately be converted
5588 to an internal time.
5589 With an optional argument WITH-TIME, the prompt will suggest to also
5590 insert a time. Note that when WITH-TIME is not set, you can still
5591 enter a time, and this function will inform the calling routine about
5592 this change. The calling routine may then choose to change the format
5593 used to insert the time stamp into the buffer to include the time."
5594 (require 'parse-time)
5595 (let* ((org-time-stamp-rounding-minutes
5596 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
5597 (ct (org-current-time))
5598 (default-time
5599 ;; Default time is either today, or, when entering a range,
5600 ;; the range start.
5601 (if (save-excursion
5602 (re-search-backward
5604 (- (point) 20) t))
5605 (apply
5606 'encode-time
5607 (mapcar (lambda(x) (or x 0))
5608 (parse-time-string (match-string 1))))
5609 ct))
5610 (calendar-move-hook nil)
5611 (view-diary-entries-initially nil)
5612 (view-calendar-holidays-initially nil)
5613 (timestr (format-time-string
5614 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") default-time))
5615 (prompt (format "YYYY-MM-DD [%s]: " timestr))
5616 ans ans1 ans2
5617 second minute hour day month year tl wday wday1)
5619 (if org-popup-calendar-for-date-prompt
5620 (save-excursion
5621 (save-window-excursion
5622 (calendar)
5623 (calendar-forward-day (- (time-to-days default-time)
5624 (calendar-absolute-from-gregorian
5625 (calendar-current-date))))
5626 (org-eval-in-calendar nil)
5627 (let* ((old-map (current-local-map))
5628 (map (copy-keymap calendar-mode-map))
5629 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
5630 (define-key map (kbd "RET") 'org-calendar-select)
5631 (define-key map (if (featurep 'xemacs) [button1] [mouse-1])
5632 'org-calendar-select-mouse)
5666 ;; Naked prompt only
5680 t nil ans))))
5690 ;; Weekday was given, but no day, so pick that day in the week
5691 ;; on or after the derived date.
5706 "Eval FORM in the calendar window and return to current window.
5707 Also, store the cursor date in variable ans2."
5719 "Return to `org-read-date' with the date currently selected.
5720 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
5729 "Return to `org-read-date' with the date currently selected.
5730 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
5740 "Check if there are any deadlines due or past due.
5741 A deadline is considered due if it happens within `org-deadline-warning-days'
5742 days from today's date. If the deadline appears in an entry marked DONE,
5743 it is not shown. The prefix arg NDAYS can be used to test that many
5762 org-warn-days)))
5765 "Evaluate a time range by computing the difference between start and end.
5766 Normally the result is just printed in the echo area, but with prefix arg
5767 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
5768 If the time range is actually in a table, the result is inserted into the
5769 next column.
5770 For time difference computation, a year is assumed to be exactly 365
5771 days in order to avoid rounding problems."
5791 ;; (ys (floor (* 365 24 60 60)))
5799 y d h m align)
5802 y 0
5807 y 0
5843 "Parse the standard Org-mode time string.
5844 This should be a lot faster than the normal `parse-time-string'.
5845 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
5846 hour and minute fields will be nil if not given."
5856 nil nil nil)
5860 "Increase the date item at the cursor by one.
5861 If the cursor is on the year, change the year. If it is on the month or
5862 the day, change that.
5863 With prefix ARG, change by that many units."
5868 "Decrease the date item at the cursor by one.
5869 If the cursor is on the year, change the year. If it is on the month or
5870 the day, change that.
5871 With prefix ARG, change by that many units."
5876 "Increase the date in the time stamp by one day.
5877 With prefix ARG, change that many days."
5885 "Decrease the date in the time stamp by one day.
5886 With prefix ARG, change that many days."
5899 "Determine if the cursor is in or at a timestamp."
5919 ans))
5922 "Change the date in the time stamp at point.
5923 The date will be changed by N times WHAT. WHAT can be `day', `month',
5924 `year', `minute', `second'. If WHAT is not given, the cursor position
5925 in the timestamp determines what will be changed."
5927 org-ts-what
5929 ts time time0)
5969 ;; Try to recenter the calendar window, if any
5976 "If the calendar is visible, recenter it to DATE."
5987 "Go to the Emacs calendar at the current date.
5988 If there is a time stamp in the current line, go to that date.
5989 A prefix ARG can be used to force the current date."
6008 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
6009 If there is already a time stamp at the cursor position, update it."
6013 ;;; The clock for measuring work time.
6019 "Start the clock on the current item.
6020 If necessary, clock-out of the currently active clock."
6042 "Stop the currently running clock.
6043 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
6074 "Cancel the running clock be removing the start timestamp."
6089 "Sum the times for each subtree.
6090 Puts the resulting times in minutes as a text property on each headline."
6094 org-clock-string
6100 ts te dt
6101 time)
6107 ;; A time
6118 ;; A headline
6132 "Show subtree times in the entire buffer.
6133 If TOTAL-ONLY is non-nil, only show the total time for the entire file
6134 in the echo area."
6148 ;; Arrange to remove the overlays upon next change.
6157 "Put an overlays on the current line, displaying TIME.
6158 If LEVEL is given, prefix time with a corresponding number of stars.
6159 This creates a new overlay and stores it in `org-clock-overlays', so that it
6160 will be easy to remove."
6164 ov tx)
6180 "Remove the occur highlights from the buffer.
6181 BEG and END are ignored. If NOREMOVE is nil, remove this function
6182 from the `before-change-functions' in the current buffer."
6192 "Clock out if the current entry contains the running clock.
6193 This is used to stop the clock after a TODO entry is marked DONE."
6198 org-clock-marker))
6205 "Check if the current buffer contains the running clock.
6206 If yes, offer to stop it and to save the buffer with the changes."
6215 "Create a table containing a report about clocked time.
6216 If the buffer contains lines
6217 #+BEGIN: clocktable :maxlevel 3 :emphasize nil
6219 #+END: clocktable
6220 then the table will be inserted between these lines, replacing whatever
6221 is was there before. If these lines are not in the buffer, the table
6222 is inserted at point, surrounded by the special lines.
6223 The BEGIN line can contain parameters. Allowed are:
6224 :maxlevel The maximum level to be included in the table. Default is 3.
6225 :emphasize t/nil, if levell 1 and level 2 should be bold/italic in the table."
6234 "If this is a CLOCK line, update it and return t.
6235 Otherwise, return nil."
6244 ts te h m s)
6246 nil
6260 t)))))
6263 "Return two times bordering a special time range.
6264 Key is a symbol specifying the range and can be one of `today', `yesterday',
6265 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
6266 A week starts Monday 0:00 and ends Sunday 24:00.
6267 The range is determined relative to TIME. TIME defaults to the current time.
6268 The return value is a cons cell with two internal times like the ones
6269 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
6270 the returned times will be formatted strings."
6275 s1 m1 h1 d1 month1 y1 diff ts te fm)
6305 "Write the standard clocktable."
6309 ipos time h m p level hlc hdl maxlevel
6310 ts te cc block)
6329 "]."
6358 hlc
6360 hlc
6369 "Return an internal list with clocking information.
6370 This list has one entry for each CLOCK interval.
6371 FIXME: describe the elements."
6375 rtn beg end next cont level title total closedp leafp
6376 clockpos titlepos h m donep)
6401 total title titlepos level leafp)
6402 rtn)
6406 ;;; Agenda, and Diary Integration
6408 ;;; Define the mode
6422 "Mode for time-sorted view on action items in Org-mode files.
6424 The following commands are available:
6438 org-agenda-show-log nil))
6445 "Restricted to single file"
6532 "--"
6538 "--"
6546 "--"
6555 "--"
6556 ;; ["New agenda command" org-agenda t]
6559 "--"
6563 "--"
6568 "--"
6570 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
6575 "--"
6584 "--"
6587 ))
6594 ;;;###autoload
6596 "Dispatch agenda commands to collect entries to the agenda buffer.
6597 Prompts for a character to select a command. Any prefix arg will be passed
6598 on to the selected command. The default selections are:
6599 g
6600 a Call `org-agenda-list' to display the agenda for current day or week.
6601 t Call `org-todo-list' to display the global todo list.
6602 T Call `org-todo-list' to display the global todo list, select only
6603 entries with a specific TODO keyword (the user gets a prompt).
6604 m Call `org-tags-view' to display headlines with tags matching
6605 a condition (the user is prompted for the condition).
6606 M Like `m', but select only TODO entries, no ordinary headlines.
6607 l Create a timeeline for the current buffer.
6609 More commands can be added by configuring the variable
6610 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
6611 searches can be pre-defined in this way.
6613 If the current buffer is in Org-mode and visiting a file, you can also
6614 first press `1' to indicate that the agenda should be temporarily (until the
6622 c entry key type match lprops)
6623 ;; Turn off restriction
6628 ;; Remember where this call originated
6635 "Press key for an agenda command:
6636 --------------------------------
6637 a Agenda for current week or day
6638 t List of all TODO entries T Entries with special TODO kwd
6639 m Match a TAGS query M Like m, but only TODO entries
6644 key
6658 (org-add-props "1 Restrict call to current buffer 0 Restrict call to region or subtree" nil 'face 'org-table)))
6692 ;; For example the todo list should not need it (but does...)
6738 cmd type match lprops)
6760 ;;;###autoload
6762 "Run an agenda command in batch mode, send result to STDOUT.
6763 CMD-KEY is a string that is also a key in `org-agenda-custom-commands'.
6764 Paramters are alternating variable names and values that will be bound
6765 before running the agenda command."
6775 "Make sure current buffer is in org-mode. Error if not."
6778 major-mode)))
6781 "Fit the window to the buffer size."
6788 "Get the list of agenda files.
6789 Optional UNRESTRICTED means return the full list even if a restriction
6790 is currently in place."
6800 "Edit the list of agenda files.
6801 Depending on setup, this either uses customize to edit the variable
6802 `org-agenda-files', or it visits the file that is holding the list. In the
6803 latter case, the buffer is set up in a way that saving it automatically kills
6804 the buffer and restores the previous window configuration."
6823 "Set new value for the agenda file list and save it correcly."
6834 "Read the list of agenda files from a file."
6846 "Return a new agenda marker.
6847 Org-mode keeps a list of these markers and resets them when they are
6848 no longer in use."
6852 m))
6855 "Reset markers created by `org-agenda'. But only if they are old enough."
6858 org-agenda-last-marker-time)
6867 "Get a buffer visiting FILE. If the buffer needs to be created, add
6868 it to the list of buffers which might be released later."
6871 buf ; just return it
6872 ;; Make a new buffer and remember it
6875 buf)))
6878 "Release all buffers in list, asking the user for confirmation when needed.
6879 When a buffer is unmodified, it is just killed. When modified, it is saved
6880 \(if the user agrees) and then killed."
6885 file
6891 "Show a time-sorted view of the entries in the current org file.
6892 Only entries with a time stamp of today or later will be listed. With
6894 under the current date.
6895 If the buffer contains an active region, only check the region for
6896 dates."
6912 t doclosed ; always include today
6913 org-timeline-show-empty-dates))
6916 args
6917 s e rtn d emptyp)
6923 ;; Remove past dates from the list of dates.
6926 day-numbers))))
6939 dopast
6940 past)
6948 entry date args)))
6975 ;;;###autoload
6977 "Produce a weekly view from all files in variable `org-agenda-files'.
6978 The view will be for the current week, but from the overview buffer you
6979 will be able to go to other weeks.
6981 also be shown, under the current date.
6983 on the days are also shown. See the variable `org-log-done' for how
6984 to turn on logging.
6985 START-DAY defaults to TODAY, or to the most recent match for the weekday
6986 given in `org-agenda-start-on-weekday'.
6987 NDAYS defaults to `org-agenda-ndays'."
7001 nil org-agenda-start-on-weekday))
7010 sd
7018 s e rtn rtnall file date d start-pos end-pos todayp nd)
7021 ;; Make the list of days
7023 nd ndays)
7034 rtnall nil)
7059 rtnall nil)
7065 file date
7068 file date
7090 rtnall nd todayp))
7112 ;;;###autoload
7114 "Show all TODO entries from all agenda file in a single list.
7115 The prefix arg can be used to select a specific TODO keyword and limit
7117 for a keyword. A numeric prefix directly selects the Nth keyword in
7118 `org-todo-keywords'."
7132 rtn rtnall files file pos)
7136 nil t)))
7144 rtnall nil)
7159 "Available with `N r': (0)ALL "
7176 "Make sure FILE exists. If not, ask user what to do."
7188 "Check if agenda buffer is of allowed type.
7189 If ERROR is non-nil, throw an error, otherwise just return nil."
7191 t
7194 nil)))
7197 "Exit agenda by removing the window or the buffer."
7205 "Exit agenda by removing the window or the buffer.
7206 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
7207 Org-mode buffers visited directly by the user will not be touched."
7213 ;; FIXME: move this function.
7215 "Save all Org-mode buffers without user confirmation."
7222 "Rebuild Agenda.
7223 When this is the global TODO list, a prefix argument will be interpreted."
7234 "Go to today."
7254 "Go forward in time by `org-agenda-ndays' days.
7255 With prefix ARG, go forward that many times `org-agenda-ndays'."
7261 nil t)))
7266 "Go back in time by `org-agenda-ndays' days.
7267 With prefix ARG, go back that many times `org-agenda-ndays'."
7273 nil t)))
7278 "Switch to weekly view for agenda."
7287 starting-day)
7288 nil t)))
7295 "Switch to daily view for agenda."
7304 starting-day)
7305 nil t)))
7312 "Jump to the next line indicating a date in agenda buffer."
7324 "Jump to the previous line indicating a date in agenda buffer."
7331 ;; Initialize the highlight
7336 "Highlight a region with overlay."
7341 "Detach overlay INDEX."
7346 "Toggle follow mode in an agenda buffer."
7354 "Toggle log mode in an agenda buffer."
7364 "Toggle diary inclusion in an agenda buffer."
7374 "Toggle time grid in an agenda buffer."
7384 "Set the mode name to indicate all the small mode settings."
7405 "Get the (Emacs Calendar) diary entries for DATE."
7412 entries
7422 ;; No entries
7424 ;; Omit the date and other unnecessary stuff
7426 ;; Add prefix to each line and extend the text properties
7438 ;; Extend the text properties to the beginning of the line
7440 entries)))))
7443 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
7444 This gets rid of the date, the underline under the date, and
7445 the dummy entry installed by `org-mode' to ensure non-empty diary for each
7446 date. It also removes lines that contain only whitespace."
7463 ;; Make sure entries from the diary have the right text properties.
7466 ;; We can rely on the hook, nothing to do
7467 nil
7468 ;; Hook not avaiable, must use advice to make this work
7470 "Make the position visible."
7473 buffer-file-name)
7477 "Add text properties to string, allowing org-mode to act on it."
7480 'keymap org-agenda-keymap
7483 'org-agenda-diary-link t
7487 "Add a dummy entry to the diary.
7488 Needed to avoid empty dates which mess up holiday display."
7489 ;; Catch the error if dealing with the new add-to-diary-alist
7497 "Cycle through the files in `org-agenda-files'.
7498 If the current buffer visits an agenda file, find the next one in the list.
7499 If the current buffer does not, find the first agenda file."
7504 file)
7515 "Move/add the current file to the end of the agenda file list.
7516 If the file is not present in the list, it is appended to the list. If it is
7517 present, it is moved there."
7522 "Move/add the current file to the top of the agenda file list.
7523 If the file is not present in the list, it is added to the front. If it is
7524 present, it is moved there. With optional argument TO-END, add/move to the
7525 end of the list."
7531 x had)
7544 "Remove current file from the list of files in variable `org-agenda-files'.
7545 These are the files which are being checked for agenda entries.
7546 Optional argument FILE means, use this file instead of the current."
7555 nil x))
7568 "Return a list of all relevant day numbers from BEG to END buffer positions.
7569 If NO-RANGES is non-nil, include only the start and end dates of a range,
7570 not every single day in the range. If FORCE-TODAY is non-nil, make
7571 sure that TODAY is included in the list. If INACTIVE is non-nil, also
7572 inactive time stamps (those in square brackets) are included.
7573 When EMPTY is non-nil, also include days without any entries."
7575 dates dates1 date day day1 day2 ts1 ts2)
7605 dates)))
7607 ;;;###autoload
7609 "Return diary information from org-files.
7611 It accesses org files and extracts information from those files to be
7612 listed in the diary. The function accepts arguments specifying what
7613 items should be listed. The following arguments are allowed:
7615 :timestamp List the headlines of items containing a date stamp or
7616 date range matching the selected date. Deadlines will
7617 also be listed, on the expiration day.
7619 :deadline List any deadlines past due, or due within
7620 `org-deadline-warning-days'. The listing occurs only
7621 in the diary for *today*, not at any other date. If
7622 an entry is marked DONE, it is no longer listed.
7624 :scheduled List all items which are scheduled for the given date.
7625 The diary for *today* also contains items which were
7626 scheduled earlier and are not yet marked DONE.
7628 :todo List all TODO items from the org-file. This may be a
7629 long list - so this is not turned on by default.
7630 Like deadlines, these entries only show up in the
7631 diary for *today*, not at any other date.
7633 The call in the diary file should look like this:
7635 &%%(org-diary) ~/path/to/some/orgfile.org
7637 Use a separate line for each org file to check. Or, if you omit the file name,
7638 all files listed in `org-agenda-files' will be checked automatically:
7640 &%%(org-diary)
7642 If you don't give any arguments (as in the example above), the default
7643 arguments (:deadline :scheduled :timestamp) are used. So the example above may
7644 also be written as
7646 &%%(org-diary :deadline :timestamp :scheduled)
7648 The function expects the lisp variables `entry' and `date' to be provided
7649 by the caller, because this is how the calendar works. Don't use this
7650 function from a program - use `org-agenda-get-day-entries' instead."
7658 file rtn results)
7659 ;; If this is called during org-agenda, don't return any entries to
7660 ;; the calendar. Org Agenda will list these entries itself.
7669 "Get the table of categories and positions in current buffer."
7675 tbl))
7677 "Get the category applying to position POS."
7693 org-category-table))))))
7696 "Does the work for `org-diary' and `org-agenda'.
7697 FILE is the path to a file to be checked for entries. DATE is date like
7698 the one returned by `calendar-current-date'. ARGS are symbols indicating
7699 which kind of entries should be extracted. For details about these, see
7700 the documentation of `org-diary'."
7708 arg results rtn)
7710 ;; If file does not exist, make sure an error message ends up in diary
7721 org-agenda-restrict-end)
7723 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
7745 results))))
7748 "Is the current entry marked DONE?"
7754 "Is the cursor inside a date range?"
7769 nil)))
7772 "Return the TODO information for agenda display."
7775 'org-not-done-regexp org-not-done-regexp
7777 'keymap org-agenda-keymap
7778 'help-echo
7785 org-not-done-regexp)
7788 marker priority category tags
7789 ee txt)
7795 ;; FIXME: the following test also happens below, but we need it here
7804 priority
7824 "Return the date stamp information for agenda display."
7826 'org-not-done-regexp org-not-done-regexp
7828 'keymap org-agenda-keymap
7829 'help-echo
7839 marker hdmarker deadlinep scheduledp donep tmp priority category
7840 ee txt timestr tags)
7850 org-ds-keyword-length))
7857 ;; substring should only run to end of time stamp
7891 "Return the logged TODO entries for agenda display."
7893 'org-not-done-regexp org-not-done-regexp
7894 'keymap org-agenda-keymap
7895 'help-echo
7907 marker hdmarker priority category tags closedp
7908 ee txt timestr)
7917 ;; donep (org-entry-is-done-p)
7918 )
7920 ;; substring should only run to end of time stamp
7943 "Return the deadline information for agenda display."
7946 'org-not-done-regexp org-not-done-regexp
7947 'keymap org-agenda-keymap
7948 'help-echo
7954 d2 diff pos pos1 category tags
7955 ee txt head face)
7964 ;; When to show a deadline in the calendar:
7965 ;; If the expiration is within wdays warning time.
7966 ;; Past-due deadlines are only shown on the current date
7992 'category category
7995 ee))
7998 "Return the scheduled information for agenda display."
8000 'org-not-done-regexp org-not-done-regexp
8004 'keymap org-agenda-keymap
8005 'help-echo
8011 d2 diff pos pos1 category tags
8012 ee txt head)
8021 ;; When to show a scheduled item in the calendar:
8022 ;; If it is on or past the date.
8038 category tags))))
8047 ee))
8050 "Return the date-range information for agenda display."
8052 'org-not-done-regexp org-not-done-regexp
8054 'keymap org-agenda-keymap
8055 'help-echo
8060 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos)
8072 ;; Only allow days between the limits, because the normal
8073 ;; date stamps will catch the limits.
8094 ; (outline-next-heading))) ;FIXME: correct to be removed??????
8095 ;; Sort the entries by expiration date.
8106 "Regular expression to match a plain time or time range.
8107 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
8108 groups carry important information:
8109 0 the full match
8110 1 the first time, range or not
8119 "Regular expression to match a timestamp time or time range.
8120 After a match, the following groups carry important information:
8121 0 the full match
8122 1 date plus weekday, for backreferencing to make sure both times on same day
8123 2 the first time, range or not
8127 "A flag, set by `org-compile-prefix-format'.
8130 "A flag, set by `org-compile-prefix-format'.
8134 noprefix)
8135 "Format TXT to be inserted into the agenda buffer.
8136 In particular, it adds the prefix and corresponding text properties. EXTRA
8137 must be a string and replaces the `%s' specifier in the prefix format.
8138 CATEGORY (string, symbol or nil) may be used to overrule the default
8139 category taken from local variable or file name. It will replace the `%c'
8140 specifier in the format. DOTIME, when non-nil, indicates that a
8141 time-of-day should be extracted from TXT for sorting of this entry, and for
8142 the `%t' specifier in the format. When DOTIME is a string, this string is
8143 searched for a time before TXT is. NOPREFIX is a flag and indicates that
8144 only the correctly processes TXT should be returned - this is used by
8145 `org-agenda-change-all-lines'. TAGS can be the tags of the headline."
8147 ;; Diary entries sometimes have extra whitespace at the beginning
8150 org-category
8156 time ;; needed for the eval of the prefix format
8159 stamp plain s0 s1 s2 rtn)
8161 ;; Extract starting and ending time and move them to prefix
8168 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
8169 ;; them, we might want to remove them there to avoid duplication.
8170 ;; The user can turn this off with a variable.
8175 t))
8177 ;; Normalize the time(s) to 24 hour
8182 ;; Tags are in the string
8185 org-prefix-has-tag))
8190 t t txt))))
8192 ;; Create the final string
8195 ;; Prepare the variables needed in the eval of the compiled format
8201 ;; Evaluate the compiled format
8204 ;; And finally add the text properties
8208 'time-of-day time-of-day
8223 list)))
8228 new time)
8230 ;; don't show empty grid
8236 nil string "" nil
8238 new)
8246 "Compile the prefix format into a Lisp form that can be evaluated.
8247 The resulting form is returned and stored in the variable
8248 `org-prefix-format-compiled'."
8252 org-agenda-prefix-format)
8257 varform vars var e c f opt)
8259 s start)
8272 ""
8282 ;; the old format
8290 "Check string S for a time of day.
8291 If found, return it as a military time number between 0 and 2400.
8292 If not found, return nil.
8293 The optional STRING argument forces conversion into a 5 character wide string
8294 HH:MM."
8319 "Sort and concatenate the agenda items."
8322 list
8340 x)))
8343 "Compare the priorities of string A and B."
8351 "Compare the string values of categories of strings A and B."
8359 "Compare the string values of categories of strings A and B."
8369 "Compare the time-of-day values of strings A and B."
8378 "Predicate for sorting agenda entries."
8379 ;; The following variables will be used when the form is evaluated.
8394 "Show the priority of the current item.
8395 This priority is composed of the main priority given with the [#A] cookies,
8396 and by additional input from the age of a schedules or deadline entry."
8402 "Show the tags applicable to the current item."
8411 "Go to the Org-mode file which contains the item at point."
8428 "Go to the Org-mode file which contains the item at point."
8445 "Go to the Org-mode file which contains the item at the mouse click."
8451 "Display the Org-mode file which contains the item at point."
8458 "Display the Org-mode file which contains the item at point and recenter."
8466 "Display the Org-mode file which contains the item at the mouse click."
8472 "Check if the entry is a diary link and abort if yes."
8480 "Marker pointing to the headline that last changed its TODO state
8484 "Cycle TODO state of line at point, also in Org-mode file.
8485 This changes the line at point, all other lines in the agenda referring to
8486 the same tree node, and the headline of the tree node in the Org-mode file."
8496 newhead)
8516 "Change all lines in the agenda buffer which match HDMARKER.
8517 The new content of the line will be NEWHEAD (as modified by
8518 `org-format-agenda-item'). HDMARKER is checked with
8519 `equal' against all `org-hd-marker' text properties in the file.
8520 If FIXFACE is non-nil, the face of each item is modified acording to
8521 the new TODO state."
8523 ; (setq newhead (org-format-agenda-item "x" newhead "x" nil 'noprefix))
8550 undone-face done-face)))
8558 "Align all tags in agenda items to `org-agenda-align-tags-to-column'."
8572 "Increase the priority of line at point, also in Org-mode file."
8577 "Decrease the priority of line at point, also in Org-mode file."
8582 "Set the priority of line at point, also in Org-mode file.
8583 This changes the line at point, all other lines in the agenda referring to
8584 the same tree node, and the headline of the tree node in the Org-mode file."
8593 newhead)
8608 "Get a list of all headline tags applicable at POS.
8609 POS defaults to point. If tags are inherited, the list contains
8610 the targets in the same sequence as the headlines appear, i.e.
8611 the tags of the current headline come last."
8623 tags)))
8627 tags))
8630 "Set tags for the current headline."
8639 newhead)
8654 "Change the date of this item to one day later."
8671 "Change the date of this item to one day earlier."
8676 "Change the date of this item. Date is prompted for, with default today.
8677 The prefix ARG is passed to the `org-time-stamp' command and can therefore
8678 be used to request time specification in the time stamp."
8695 "Schedule the item at point."
8704 ts)
8712 "Schedule the item at point."
8721 ts)
8729 "Return the heading of the current entry, without the stars."
8738 "Start the clock on the currently selected item."
8750 "Make a diary entry, like the `i' command from the calendar.
8751 All the standard commands work: block, weekly etc."
8775 ;; We implement this by hacking the `calendar-cursor-to-date' function
8776 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
8792 "Execute a calendar command from the agenda, with the date associated to
8793 the cursor position."
8815 "Display the phases of the moon for the 3 months around the cursor date."
8820 "Display the holidays for the 3 months around the cursor date."
8825 "Display sunrise and sunset for the cursor date.
8826 Latitude and longitude can be specified with the variables
8827 `calendar-latitude' and `calendar-longitude'. When called with prefix
8828 argument, latitude and longitude will be prompted for."
8837 "Open the Emacs calendar with the date at the cursor."
8850 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
8851 This is a command that has to be installed in `calendar-mode-map'."
8855 nil t))
8861 date s)
8885 ;;; Tags
8888 "Scan headline tags with inheritance and produce output ACTION.
8889 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
8890 evaluated, testing if a given set of tags qualifies a headline for
8891 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
8892 are included in the output."
8900 'undone-face nil
8902 'org-not-done-regexp org-not-done-regexp
8903 'keymap org-agenda-keymap
8904 'help-echo
8907 lspos
8909 todo marker)
8922 ;; remove tag lists from same and sublevels
8927 ;; add the nex tags
8930 tags-alist
8932 ;; compile tags for current headline
8936 tags))
8941 ;; list this headline
8946 ""
8951 category tags-list))
8957 ;; if we are to skip sublevels, jump to end of subtree
8966 "Create a sparse tree according to tags search string MATCH.
8967 MATCH can contain positive and negative selection of tags, like
8975 "Create the TAGS matcher form for the tags-selecting string MATCH."
8977 ;; Get a new match request, with completion
8980 org-last-tags-completion-table))
8984 ;; parse the string and create a lisp form
8997 orlist)
9000 ;; Return the string and lisp forms of the matcher
9003 ;;;###autoload
9005 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
9006 The prefix arg TODO-ONLY limits the search to TODO entries."
9015 rtn rtnall files file pos matcher
9016 buffer)
9024 rtnall nil)
9032 ;; If file does not exist, merror message to agenda
9044 org-agenda-restrict-end)
9069 "Set the tags for the current headline.
9070 With prefix ARG, realign all tags in headings in the current buffer."
9075 table current-tags inherited-tags ; computed below when needed
9076 tags hd empty invis)
9086 org-last-tags-completion-table table
9091 tags
9124 org-tags-column
9126 t)
9141 ;; try completion
9148 )
9150 ;; all-completions
9152 )
9154 ;; exact match?
9156 ))
9159 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
9165 "Fast tag selection with single keys.
9166 CURRENT is the current list of tags in the headline, INHERITED is the
9167 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
9168 possibly with grouping information.
9169 If the keys are nil, a-z are automatically assigned.
9170 Returns the new tags string, or nil to not change the current settings."
9174 table)))
9179 tg cnt e c char c1 c2 ntable tbl rtn
9180 groups ingroup)
9204 ;; automatically assign a character.
9254 g)))
9256 ;; Create a sorted list
9276 nil))))
9279 "Get the TAGS string in the current headline."
9289 "Get a table of all tags used in the buffer, for completion."
9298 ;;; Link Stuff
9301 "List of functions to construct the right search string for a file link.
9302 These functions are called in turn with point at the location to
9303 which the link should point.
9305 A function in the hook should first test if it would like to
9306 handle this file type, for example by checking the major-mode or
9307 the file extension. If it decides not to handle this file, it
9308 should just return nil to give other functions a chance. If it
9309 does handle the file, it must return the search string to be used
9310 when following the link. The search string will be part of the
9311 file link, given after a double colon, and `org-open-at-point'
9312 will automatically search for it. If special measures must be
9313 taken to make the search successful, another function should be
9314 added to the companion hook `org-execute-file-search-functions',
9315 which see.
9317 A function in this hook may also use `setq' to set the variable
9318 `description' to provide a suggestion for the descriptive text to
9319 be used for this link when it gets inserted into an Org-mode
9323 "List of functions to execute a file search triggered by a link.
9325 Functions added to this hook must accept a single argument, the
9326 search string that was part of the file link, the part after the
9327 double colon. The function must first check if it would like to
9328 handle this search, for example by checking the major-mode or the
9329 file extension. If it decides not to handle this search, it
9330 should just return nil to give other functions a chance. If it
9331 does handle the search, it must return a non-nil value to keep
9332 other functions from trying.
9334 Each function can access the current prefix argument through the
9335 variable `current-prefix-argument'. Note that a single prefix is
9336 used to force opening a link in Emacs, so it may be good to only
9337 use a numeric or double prefix to guide the search function.
9339 In case this is needed, a function in this hook can also restore
9340 the window configuration before `org-open-at-point' was called using:
9345 "Open file link or URL at mouse."
9351 "Open file link or URL at mouse."
9357 "The window configuration before following a link.
9361 "Open link at or after point.
9362 If there is no link at point, this function will search forward up to
9363 the end of the current subtree.
9364 Normally, files will be opened by an appropriate application. If the
9365 optional argument IN-EMACS is non-nil, Emacs will visit the file."
9388 path link))
9430 ;; Remove any trailing spaces in path
9463 path
9500 ;; in-emacs is the prefix arg, will be interpreted as read-only
9557 "Search for a link search option.
9558 When S is a CamelCaseWord, search for a target, or for a sentence containing
9559 the words. If S is surrounded by forward slashes, it is interpreted as a
9560 regular expression. In org-mode files, this will create an `org-occur'
9561 sparse tree. In ordinary files, `occur' will be used to list matches.
9562 If the current buffer is in `dired-mode', grep will be used to search
9563 in all files."
9568 words re0 re1 re2 re3 re4 re5 re2a reall camel)
9570 ;; First check if there are any special
9572 ;; Now try the builtin stuff
9579 ;; There is an exact target for this
9582 ;; A regular expression
9586 ;;((eq major-mode 'dired-mode)
9587 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9590 t)
9591 ;; A camel or a normal search string
9593 ;; Anchor on headlines, post may include tags.
9600 ;; Make a series of regular expressions to find a match
9618 ))
9630 )
9635 ;; Normal string-search
9643 "Execute `re-search-forward', but only accept matches that are not a link."
9658 "Call the Emacs command `occur'.
9659 If CLEANUP is non-nil, remove the printout of the regular expression
9660 in the *Occur* buffer. This is useful if the regex is long and not useful
9661 to read."
9680 ;; Fill and close the ring
9685 org-mark-ring)
9688 "Put the current position or POS into the mark ring and rotate it."
9700 "Jump to the previous position in the mark ring.
9701 With prefix arg N, jump back that many stored positions. When
9702 called several times in succession, walk through the entire ring.
9703 Org-mode commands jumping to a different position in the current file,
9704 or to another Org-mode file, automatically push the old position
9705 onto the ring."
9720 words)
9729 s)
9733 s)
9736 "Follow a BBDB link to NAME."
9741 ;; Exact match on name
9744 ;; Exact match on name
9747 ;; Partial match on name
9750 ;; Partial match on company
9753 ;; General match including network address and notes
9761 "Follow an info file & node link to NAME."
9772 "Follow a Gnus link to GROUP and ARTICLE."
9786 "Follow a VM link to FOLDER and ARTICLE."
9790 ;; ange-ftp or efs or tramp access
9796 ;; use tramp to access the file
9801 ;; use ange-ftp or efs
9821 "Follow a Wanderlust link to FOLDER and ARTICLE."
9828 "Follow an RMAIL link to FOLDER and ARTICLE."
9841 nil t)
9847 message-number)
9850 ;; mh-e integration based on planner-mode
9852 "Return the name of the current message real folder, so if you use
9853 sequences, it will now work."
9857 mh-current-folder
9858 ;; Refer to the show buffer
9859 mh-show-folder-buffer))
9863 )
9864 ;; a simple test on mh-index-data does not work, because
9865 ;; mh-index-data is always nil in a show buffer.
9874 )
9875 ))
9877 )
9878 folder
9879 )
9880 )))
9883 "Returns the name of the message folder in a index folder buffer."
9890 "Return the name of the current message folder. Be careful if you
9891 use sequences."
9894 mh-current-folder
9895 ;; Refer to the show buffer
9896 mh-show-folder-buffer)))
9899 "Return the number of the current message. Be careful if you
9900 use sequences."
9904 ;; Refer to the show buffer
9908 "Return a header of the message in folder mode. This will create a
9909 show buffer for the corresponding message. If you have a more clever
9910 idea..."
9925 header-field)))
9928 "Follow an MHE link to FOLDER and ARTICLE.
9929 If ARTICLE is nil FOLDER is shown. If the configuration variable
9930 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
9931 ARTICLE is searched in all folders. Indexed searches (swish++,
9932 namazu, and others supported by MH-E) will always search in all
9933 folders."
9955 ;; BibTeX links
9957 ;; Use the custom search meachnism to construct and use search strings for
9958 ;; file links to BibTeX database entries.
9961 "Create the search string and description for a BibTeX database entry."
9963 ;; yes, we want to construct this search string.
9964 ;; Make a good description for this entry, using names, year and the title
9965 ;; Put it into the `description' variable which is dynamically scoped.
9979 ;; Now parse the entry, get the key and return it.
9985 "Find the link search string S as a key for a database entry."
9987 ;; Yes, we want to do the search in this file.
9988 ;; We construct a regexp that searches for "@entrytype{" followed by the key
9994 ;; Use double prefix to indicate that any web link should be browsed
9996 ;; Restore the window configuration because we just use the web link
10001 ;; return t to indicate that the search is done.
10002 t))
10004 ;; Finally add the functions to the right hooks.
10008 ;; end of Bibtex link setup
10011 "Transfer old <...> style links to new [[...]] style links.
10012 With arg query-description, ask at each match for a description text to use
10013 for this link."
10014 (interactive (list (y-or-n-p "Would you like to be queried for a description at each link?")))
10033 "Open the file at PATH.
10034 First, this expands any special file name abbreviations. Then the
10035 configuration variable `org-file-apps' is checked if it contains an
10036 entry for this file type, and if yes, the corresponding command is launched.
10037 If no application is found, Emacs simply visits the file.
10038 With optional argument IN-EMACS, Emacs will visit the file.
10039 Optional LINE specifies a line to go to, optional SEARCH a string to
10040 search for. If LINE or SEARCH is given, the file will always be
10041 opened in Emacs.
10042 If the file does not exist, an error is thrown."
10045 buffer-file-name
10054 ext cmd)
10079 ;; Normalize use of quote, this can vary.
10087 ; (unless (equal (file-truename file) (file-truename (or buffer-file-name "")))
10088 ; (funcall (cdr (assq 'file org-link-frame-setup)) file))
10101 "Return the default applications for this operating system."
10104 org-file-apps-defaults-macosx)
10106 org-file-apps-defaults-windowsnt)
10110 "Replace special path abbreviations and expand the file name."
10114 "Test whether FILE specifies a location on a remote system.
10115 Return non-nil if the location is indeed remote.
10125 t)
10134 ;;;###autoload
10137 This link can later be inserted into an org-buffer with
10139 For some link types, a prefix arg is interpreted:
10140 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
10141 For file links, arg negates `org-context-in-file-links'."
10148 "bbdb:"
10167 nil nil nil))))))
10183 folder)
10231 "http://groups.google.com/groups?group="
10233 group)
10275 ;; link to the file in the current line
10283 ;; Just link to current headline
10286 ;; Add a context search string
10288 ;; Check if we are on a target
10313 ;; Just link to this file here.
10316 ;; Add a context string
10321 ;; Only use search option if there is some text.
10349 "Make search string for STRING or current headline."
10353 ;; We are using a headline, clean up garbage in there.
10370 "Make a CamelCase string for STRING or the current headline."
10374 ;; We are using a headline, clean up garbage in there.
10391 "Concatenate STRINGS, format resulting string with `org-link-format'."
10395 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10398 link
10401 ;; Remove brackets from the description, they are fatal.
10405 ;; No description needed, it is identical
10418 "Escape charaters in TEXT that are problematic for links."
10426 t t text)))
10427 text)))
10430 "Reverse the action of `org-link-escape'."
10438 t t text)))
10439 text)))
10442 "Exclusive or."
10446 "Find a header field in the current buffer."
10466 s)))
10470 "Replace special characters in a message id, so it can be used in an http query."
10477 s)
10480 "Insert a link. At the prompt, enter the link.
10482 Completion can be used to select a link previously stored with
10483 `org-store-link'. When the empty string is entered (i.e. if you just
10484 press RET at the prompt), the link defaults to the most recently
10485 stored link. As SPC triggers completion in the minibuffer, you need to
10486 use M-SPC or C-q SPC to force the insertion of a space character.
10488 You will also be prompted for a description, and if one is given, it will
10489 be displayed in the buffer instead of the link.
10491 If there is already a link at point, this command will allow you to edit link
10492 and description parts.
10495 selected using completion. The path to the file will be relative to
10496 the current directory if the file is in the current directory or a
10497 subdirectory. Otherwise, the link will be the absolute path as
10498 completed in the minibuffer (i.e. normally ~/path/to/file).
10501 is in the current directory or below.
10503 `org-keep-stored-link-after-insertion'."
10513 ;; We do have a link at point, and we are going to edit it.
10520 ;; Completing read for file names.
10528 "file:"
10538 ;; Read link, with completion for stored links.
10540 "Link: " org-stored-links nil nil nil
10541 org-insert-link-history
10547 org-stored-links)))
10552 ;; URL-like link, normalize the use of angular brackets.
10555 ;; Check if we are linking to the current file with a search option
10556 ;; If yes, simplify the link by using only the search option.
10563 ;; We are linking to this same file, with a search option
10566 ;; Check if we can/should use a relative path. If yes, simplify the link
10583 ;; We are linking a file with relative path name.
10599 ;;; Hooks for remember.el
10603 ;;;###autoload
10605 "Return a link to the current location as an annotation for remember.el.
10606 If you are using Org-mode files as target for data storage with
10607 remember.el, then the annotations should include a link compatible with the
10608 conventions in Org-mode. This function returns such a link."
10612 "Select a destination location for the note.
10613 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
10614 RET at beg-of-buf -> Append to file as level 2 headline
10615 RET on headline -> Store as sublevel entry to current headline
10618 ;;;###autoload
10620 "Initialize *remember* buffer with template, invoke `org-mode'.
10621 This function should be placed into `remember-mode-hook' and in fact requires
10622 to be run from that hook to fucntion properly."
10641 )
10654 t t))
10667 ;;;###autoload
10669 "Store stuff from remember.el into an org file.
10670 First prompts for an org file. If the user just presses return, the value
10671 of `org-default-notes-file' is used.
10672 Then the command offers the headings tree of the selected file in order to
10673 file the text at a specific location.
10674 You can either immediately press RET to get the note appended to the
10675 file, or you can use vertical cursor motion and visibility cycling (TAB) to
10676 find a better place. Then press RET or <left> or <right> in insert the note.
10678 Key Cursor position Note gets inserted
10679 -----------------------------------------------------------------------------
10680 RET buffer-start as level 2 heading at end of file
10681 RET on headline as sublevel of the heading at cursor
10682 RET no heading at cursor position, level taken from context.
10683 Or use prefix arg to specify level manually.
10684 <left> on headline as same level, before current heading
10685 <right> on headline as same level, after current heading
10687 So the fastest way to store the note is to press RET RET to append it to
10688 the default file. This way your current train of thought is not
10689 interrupted, in accordance with the principles of remember.el. But with
10690 little extra effort, you can push it directly to the correct location.
10692 Before being stored away, the function ensures that the text has a
10694 is constructed from the current date and some additional data.
10696 If the variable `org-adapt-indentation' is non-nil, the entire text is
10697 also indented so that it starts in the same column as the headline
10698 \(i.e. after the stars).
10700 See also the variable `org-reverse-note-order'."
10709 spos level indent reversed)
10710 ;; Modify text so that it becomes a nice subtree which can be inserted
10711 ;; into an org tree.
10713 first)
10714 ;; remove empty lines at the beginning
10719 ;; Is already a headline
10721 ;; We need to add a headline: Use time and first buffer line
10730 ;; Find the file
10741 ;; Ask the User for a location
10744 org-remember-help)))
10746 ; not handle this note
10749 ;; Put it at the start or end, as level 2
10756 ;; Put it below this entry, at the beg/end of the subtree
10766 ;; Put it right there, with automatic level determined by
10767 ;; org-paste-subtree or from prefix arg
10775 "Read a filename, with default directory `org-directory'."
10779 default)))
10782 "Check if the current file should receive notes in reversed order."
10789 entry)
10793 nil)))))
10795 ;;; Tables
10797 ;; Watch out: Here we are talking about two different kind of tables.
10798 ;; Most of the code is for the tables created with the Org-mode table editor.
10799 ;; Sometimes, we talk about tables created and edited with the table.el
10800 ;; Emacs package. We call the former org-type tables, and the latter
10801 ;; table.el-type tables.
10805 "Every change indicates that a table might need an update."
10825 "Searching from within a table (any type) this finds the first line
10828 "Searching from within a table (any type) this finds the first line
10832 "Use the table.el package to insert a new table.
10833 If there is already a table at point, convert between Org-mode tables
10834 and table.el tables."
10847 "Convert region to table, or create an empty table.
10848 If there is an active region, convert it to a table. If there is no such
10849 region, create an empty table."
10856 "Query for a size and insert a table skeleton.
10876 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
10880 ;; Insert a hline after the first row.
10888 "Convert region to a table.
10889 The region goes from BEG0 to END0, but these borders will be moved
10890 slightly, to make sure a beginning of line in the first line is included.
10891 When NSPACE is non-nil, it indicates the minimum number of spaces that
10892 separate columns (default: just one space)."
10897 re)
10904 ;; Lets see if this is tab-separated material. If every nonempty line
10905 ;; contains a tab, we will assume that it is tab-separated material
10923 "Import FILE as a table.
10924 The file is assumed to be tab-separated. Such files can be produced by most
10925 spreadsheet and database applications. If no tabs (at least one per line)
10926 are found, lines will be split on whitespace into fields."
10935 "Export table as a tab-separated file.
10936 Such a file can be imported into a spreadsheet program like Excel."
10942 buf)
10971 "Marker at the beginning of the table last aligned.
10974 "Marker at the end of the table last aligned.
10977 "List of flags for flushright alignment, from the last re-alignment.
10980 "List of max width of fields in each column.
10988 "Align the table at point by aligning all vertical bars."
10991 ;; Limits of table
10994 ;; Current cursor position
10999 column
11001 rfmt hfmt
11009 emptystrings links narrow fmax f1 len c e)
11012 ;; Check if we have links
11015 ;; Make sure the link properties are right
11017 ;; Check if we are narrowing any columns
11021 ;; Get the rows
11024 ;; Store the indentation of the first line
11027 ;; Mark the hlines by setting the corresponding element to nil
11028 ;; At the same time, we remove trailing space.
11031 nil
11034 l)))
11035 lines))
11036 ;; Get the data fields by splitting the lines.
11041 ;; How many fields in the longest line?
11048 ;; A list of empty string to fill any short rows on output
11050 ;; Check for special formatting.
11054 ;; Check if there is an explicit width specified
11061 ;; Find fields that are wider than fmax, and shorten them
11067 'help-echo
11068 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
11076 xx)))))
11077 ;; Get the maximum width for each column
11079 ;; Get the fraction of numbers, to decide about alignment of the column
11083 nil
11090 ;; Store the alignment of this table, for later editing of single fields
11092 org-table-last-column-widths lengths)
11094 ;; With invisible characters, `format' does not get the field width right
11095 ;; So we need to make these fields wide by hand.
11106 ;; Compute the formats needed for output of the table
11119 hfmt))
11121 ;; Replace the old one
11130 ;; Try to move to the old location (approximately)
11135 ))
11138 "Compute width of string, ignoring invisible characters.
11139 This ignores character with invisibility property `org-link', and also
11140 characters with property `org-cwidth', because these will become invisible
11141 upon the next fontification round."
11157 "Find the beginning of the table and return its position.
11158 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
11162 org-table-border-regexp)
11163 nil t))
11170 "Find the end of the table and return its position.
11171 With argument TABLE-TYPE, go to the end of a table.el-type table."
11175 org-table-border-regexp)
11176 nil t))
11182 "Justify the current field, text to left, number to right.
11183 Optional argument NEW may specify text to replace the current field content."
11192 ;; This is not the same table, force a full re-align
11198 l f n o e)
11221 "Go to the next field in the current table, creating new lines as needed.
11222 Before doing so, re-align the table if necessary."
11227 org-table-may-need-update)
11238 org-table-tab-jumps-over-hlines
11250 "Go to the previous field in the table.
11251 Before doing so, re-align the table if necessary."
11256 org-table-may-need-update)
11268 "Go to the next row (same column) in the current table.
11269 Before doing so, re-align the table if necessary."
11277 org-table-may-need-update)
11291 "Copy a field down in the current column.
11292 If the field at the cursor is empty, copy into it the content of the nearest
11293 non-empty field above. With argument N, use the Nth non-empty field.
11294 If the current field is not empty, it is copied down to the next row, and
11295 the cursor is moved with it. Therefore, repeating this command causes the
11296 column to be filled row-by-row.
11297 If the variable `org-table-copy-increment' is non-nil and the field is an
11298 integer, it will be incremented while copying."
11304 txt)
11316 beg t))
11333 "Is point inside a table data field?
11334 I.e. not on a hline or before the first or after the last column?
11335 This actually throws an error, so it aborts the current command."
11346 "Blank the current table field or active region."
11363 "Return the value of the field in column N of current row.
11364 N defaults to current field.
11365 If REPLACE is a string, replace field with this value. The return value
11366 is always the old value."
11376 val)
11380 "Find out which column we are in.
11381 When called interactively, column is also displayed in echo area."
11390 cnt)))
11393 "Move the cursor to the Nth column in the current table line.
11394 With optional argument ON-DELIM, stop with point before the left delimiter
11395 of the field.
11396 If there are less than N fields, just go to after the last delimiter.
11397 However, when FORCE is non-nil, create new columns if necessary."
11408 ; (backward-char 2) t)))))
11416 "Return t if the cursor is inside an org-type table.
11417 If TABLE-TYPE is non-nil, also check for table.el-type tables."
11422 org-table-line-regexp)))
11423 nil))
11426 "Return t if and only if we are at a table.el table."
11433 "If there is a table.el table nearby, recognize it and move into it."
11439 nil
11449 t
11454 t)
11455 nil)
11456 nil))
11459 "Return t if the cursor is inside a hline in a table."
11464 nil))
11467 "Insert a new column into the table."
11475 ;; Current cursor position
11481 nil
11492 "Find a dataline in the current table, which is needed for column commands."
11495 t
11506 t
11511 "Delete a column from the table."
11520 ;; Current cursor position
11526 nil
11538 "Move column to the right."
11542 "Move column to the left."
11547 "Move the current column to the right. With arg LEFT, move to the left."
11557 ;; Current cursor position
11567 nil
11579 "Move table row down."
11583 "Move table row up."
11588 "Move the current table line down. With arg UP, move it up."
11593 txt)
11610 "Insert a new row above the current line into the table.
11611 With prefix ARG, insert below the current line."
11617 ;; Fix the first field if necessary
11627 "Insert a horizontal-line below the current line into the table.
11628 With prefix ARG, insert above the current line."
11647 In particular, this does handle wide and invisible characters."
11649 ;; It's a hline, just map the characters
11655 t t s)))
11656 s))
11659 "Delete the current row or horizontal line from the table."
11669 "Sort table lines in region.
11670 Point and mark define the first and last line to include. Both point and
11671 mark should be in the column that is used for sorting. For example, to
11672 sort according to column 3, put the mark in the first line to sort, in
11673 table column 3. Put point into the last line to be included in the sorting,
11674 also in table column 3. The command will prompt for the sorting method
11675 \(n for numerical, a for alphanumeric)."
11703 lns)))
11713 "Copy region in table to the clipboard and blank all relevant fields."
11718 "Copy rectangular region in table to clipboard.
11719 A special clipboard is used which can only be accessed
11720 with `org-table-paste-rectangle'."
11723 region cols
11749 org-table-clip))
11752 "Paste a rectangular region into a table.
11753 The upper right corner ends up in the current field. All involved fields
11754 will be overwritten. If the rectangle does not fit into the present table,
11755 the table is enlarged as needed. The process ignores horizontal separator
11756 lines."
11766 c cols field)
11782 "Convert from `org-mode' table to table.el and back.
11783 Obviously, this only works within limits. When an Org-mode table is
11784 converted to table.el, all horizontal separator lines get lost, because
11785 table.el uses these as cell boundaries and has no notion of horizontal lines.
11786 A table.el table can be converted to an Org-mode table only if it does not
11787 do row or column spanning. Multiline cells will become multiple cells.
11788 Beware, Org-mode does not test if the table can be successfully converted - it
11789 blindly applies a recipe that works for simple tables."
11793 ;; convert to Org-mode table
11802 ;; convert to table.el table
11805 ;; first, get rid of all horizontal lines
11809 ;; insert a hline before first
11813 ;; insert a hline after each line
11818 ;; replace "+" at beginning and ending of hlines
11827 "Wrap several fields in a column like a paragraph.
11828 This is useful if you'd like to spread the contents of a field over several
11829 lines, in order to keep the table compact.
11831 If there is an active region, and both point and mark are in the same column,
11832 the text in the column is wrapped to minimum width for the given number of
11833 lines. Generally, this makes the table more compact. A prefix ARG may be
11835 formats the selected text to two lines. If the region was longer than two
11836 lines, the remaining lines remain empty. A negative prefix argument reduces
11837 the current number of lines by that amount. The wrapped text is pasted back
11838 into the table. If you formatted it to more lines than it was before, fields
11839 further down in the table get overwritten - so you might need to make space in
11840 the table first.
11842 If there is no region, the current field is split at the cursor position and
11843 the text fragment to the right of the cursor is prepended to the field one
11844 line down.
11846 If there is no region, but you specify a prefix ARG, the current field gets
11847 blank, and the content is appended to the field above."
11851 ;; There is a region: fill as a paragraph
11853 nlines)
11860 arg)
11864 nil nlines)))
11867 ;; No region, split the current field at point
11869 ;; combine with field above
11879 ;; split field
11891 "Edit table field in a different window.
11892 This is mainly useful for fields that contain hidden parts.
11894 it can be edited in place."
11900 display t intangible t))
11906 p)
11915 intangible t))
11924 "Finish editing a table data field.
11925 Remove all newline characters, insert the result into the table, realign
11926 the table and kill the editing buffer."
11930 text)
11947 "Remove whitespace at beginning and end of string."
11950 s)
11953 "Wrap string to either a number of lines, or a width in characters.
11954 If WIDTH is non-nil, the string is wrapped to that width, however many lines
11955 that costs. If there is a word longer than WIDTH, the text is actually
11956 wrapped to the length of that word.
11957 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
11958 many lines, whatever width that takes.
11959 The return value is a list of lines, without newlines at the end."
11962 w ll)
11969 ll
11974 ll))
11979 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
11989 "Splits STRING into substrings at SEPARATORS.
11990 No empty strings are returned if there are matches at the beginning
11991 and end of string."
11994 notfirst
12008 list)))
12013 list)))
12017 "Apply FUNCTION to the start of all tables in the buffer."
12031 "Sum numbers in region of current table column.
12032 The result will be displayed in the echo area, and will be available
12035 If there is an active region, it is interpreted as a rectangle and all
12036 numbers in that rectangle will be summed. If there is no active
12037 region and point is located in a table column, sum all numbers in that
12038 column.
12040 If at least one number looks like a time HH:MM or HH:MM:SS, all other
12041 numbers are assumed to be times as well (in decimal hours) and the
12042 numbers are added as such.
12044 If NLAST is a number, only the NLAST fields will actually be summed."
12058 ;not needed? (skip-chars-backward "^|")
12064 ;not needed? (skip-chars-forward "^|")
12073 items1)))
12080 s diff)
12088 sres))))
12111 "Get a calc vector from a column, accorting to descriptor DESC.
12112 Optional arguments TBEG and COL can give the beginning of the table and
12113 the current column, to avoid unnecessary parsing."
12178 "Read a formula from the minibuffer, offer stored formula as default."
12181 org-table-named-field-locations)))
12194 stored)
12196 equation)
12200 ;stored
12201 ))))
12202 mustsave)
12204 ;; remove formula
12211 ;; We set the column equation, delete the named one.
12213 mustsave t))
12219 eq))
12222 "Store the list of formulas below the current table."
12235 "Return an alist with the stored formulas directly after current table."
12253 "Modify the formulas stored below the current table.
12254 ACTION can be `remove', `insert', `swap'. For `swap', two column numbers are
12255 expected, for the other actions only a single column number is needed."
12260 col col1 col2 scol si sc1 sc2)
12283 ;; Hopefully, ZqZtZ will never be a name in a table
12305 "Get the column names and local parameters for this table."
12308 names name fields fields1 field cnt c v line col)
12310 org-table-local-parameters nil
12311 org-table-named-field-locations nil)
12329 org-table-local-parameters))))
12347 ;; Get the current word
12355 If yes, store the formula and apply it."
12356 ;; We already know we are in a table. Get field will only return a formula
12357 ;; when appropriate. It might return a separator line, but no problem.
12360 named eq)
12368 "List of commands triggering the recalculation of a line.
12381 "Rotate the recalculation mark in the first column.
12382 If in any row, the first field is not consistent with a mark,
12383 insert a new column for the markers.
12384 When there is an active region, change all the lines in the region,
12385 after prompting for the marking character.
12386 After each change, a message will be displayed indicating the meaning
12387 of the new mark."
12402 epos new)
12409 newchar))
12441 "Recompute the current line if marked for it, and if we haven't just done it."
12452 "Non-nil means, debug table formulas.
12466 modes)
12469 suppress-align suppress-const
12470 suppress-store)
12471 "Replace the table field value at the cursor by the result of a calculation.
12473 This function makes use of Dave Gillespie's Calc package, in my view the
12474 most exciting program ever written for GNU Emacs. So you need to have Calc
12475 installed in order to use this function.
12477 In a table, this command replaces the value in the current field with the
12479 formula, by storing it in a special line below the table. When called
12480 with a `C-u' prefix, the current field must ba a named field, and the
12481 formula is installed as valid in only this specific field.
12483 When called, the command first prompts for a formula, which is read in
12484 the minibuffer. Previously entered formulas are available through the
12485 history list, and the last used formula is offered as a default.
12486 These stored formulas are adapted correctly when moving, inserting, or
12487 deleting columns with the corresponding commands.
12489 The formula can be any algebraic expression understood by the Calc package.
12490 For details, see the Org-mode manual.
12492 This function can also be called from Lisp programs and offers
12493 additional arguments: EQUATION can be the formula to apply. If this
12494 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
12495 used to speed-up recursive calls by by-passing unnecessary aligns.
12496 SUPPRESS-CONST suppresses the interpretation of constants in the
12497 formula, assuming that this has been done already outside the function.
12498 SUPPRESS-STORE means the formula should not be stored, either because
12499 it is already stored, or because it is a modified equation that should
12500 not overwrite the stored one."
12511 equation
12515 n form fmt x ev orig c lispp)
12516 ;; Parse the format string. Since we have a lot of modes, this is
12517 ;; a lot of work. However, I think calc still uses most of the time.
12529 'calc-float-format
12532 n))))
12549 fields)))
12553 ;; Insert the references to fields in same row
12557 n0)
12564 t t form)))
12565 ;; Insert ranges in current column
12570 nil n0))
12571 t t form)))
12581 Orig: %s
12582 $xyz-> %s
12609 "Recalculate the current table line by applying all stored formulas.
12610 With prefix arg ALL, do this for all lines in the table."
12623 ;; Insert constants in all formulas
12627 x)
12628 eqlist))
12629 ;; Split the equation list
12640 ;; This is a table with marked lines, only compute selected lines
12642 ;; Move forward to the first non-header line
12654 ;; Unprotected line, recalculate
12667 ;; Now do the names fields
12676 ;; back to initial position
12683 "Replace $const with values in string F."
12685 ;; First, check for column names
12690 ;; Expand ranges to vectors
12701 ;; Parameters and constants
12710 f))
12713 "Find the value for a parameter or constant in a formula.
12714 Parameters get priority."
12728 "Edit the formulas of the current table in a separate buffer."
12736 entry loc s)
12744 # Use `C-u C-c C-c' to also appy them immediately to the entire table.
12745 # Use `C-c ?' to get information about $name at point.
12762 "Show the location/value of the $ expression at point."
12789 ;; column number
12821 "Parse the buffer for formula definitions and install them.
12822 With prefix ARG, apply the new formulas to the table."
12841 "Abort editing formulas, without installing the changes."
12849 ;;; The orgtbl minor mode
12851 ;; Define a minor mode which can be used in other modes in order to
12852 ;; integrate the org-mode table editor.
12854 ;; This is really a hack, because the org-mode table editor uses several
12855 ;; keys which normally belong to the major mode, for example the TAB and
12856 ;; RET keys. Here is how it works: The minor mode defines all the keys
12857 ;; necessary to operate the table editor, but wraps the commands into a
12858 ;; function which tests if the cursor is currently inside a table. If that
12859 ;; is the case, the table editor command is executed. However, when any of
12860 ;; those keys is used outside a table, the function uses `key-binding' to
12861 ;; look up if the key has an associated command in another currently active
12862 ;; keymap (minor modes, major mode, global), and executes that command.
12863 ;; There might be problems if any of the keys used by the table editor is
12864 ;; otherwise used as a prefix key.
12866 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
12867 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
12868 ;; addresses this by checking explicitly for both bindings.
12870 ;; The optimized version (see variable `orgtbl-optimized') takes over
12871 ;; all keys which are bound to `self-insert-command' in the *global map*.
12872 ;; Some modes bind other commands to simple characters, for example
12873 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
12874 ;; active, this binding is ignored inside tables and replaced with a
12875 ;; modified self-insert.
12878 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
12885 ;;;###autoload
12887 "Unconditionally turn on `orgtbl-mode'."
12890 ;;;###autoload
12892 "The `org-mode' table editor as a minor mode for use in other modes."
12895 ;; Exit without error, in case some hook functions calls this
12896 ;; by accident in org-mode.
12903 ;; Make sure we are first in minor-mode-map-alist
12911 auto-fill-inhibit-regexp)
12927 "Remove all properties related to narrow-column invisibility."
12939 ;; Install it as a minor mode.
12945 "Create a function for binding in the table minor mode.
12946 FUN is the command to call inside a table. N is used to create a unique
12947 command name. KEYS are keys that should be checked in for a command
12948 to execute outside of tables."
12954 "Outside of tables, run the binding of `"
12966 keys)
12970 "Error when there is no default binding for a table key."
12975 "Setup orgtbl keymaps."
12991 ; '([(shift tab)] org-table-previous-field)
13006 elt key fun cmd)
13013 ;; Special treatment needed for TAB and RET
13027 ;; If the user wants maximum table support, we need to hijack
13028 ;; some standard editing functions
13040 "--"
13045 "--"
13051 "--"
13052 ["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])
13059 "--"
13066 "--"
13068 ["Set Named Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
13072 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
13079 ))
13080 t)
13083 "Justification and field motion for `orgtbl-mode'."
13090 "Justification and field motion for `orgtbl-mode'."
13096 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
13097 If the cursor is in a table looking at whitespace, the whitespace is
13098 overwritten, and the table is not marked as requiring realignment."
13105 orgtbl-hijacker-command-101
13106 orgtbl-hijacker-command-102
13107 orgtbl-hijacker-command-103
13108 orgtbl-hijacker-command-104
13109 orgtbl-hijacker-command-105))
13111 t)
13124 "Needed to enforce self-insert under remapping."
13128 ;;; Exporting
13169 "Return the property list with default settings for the export variables."
13173 rtn))
13176 "Return the property list with file-local settings for export."
13181 p key val text options)
13206 o)
13210 options)
13214 p)))
13217 "Create a single property list from all plists in PLISTS.
13218 The process starts by copying the last list, and then setting properties
13219 from the other lists. Settings in the first list are the most significant
13220 ones and overrule settings in the other lists."
13222 p v ls)
13228 rtn))
13234 val)))
13235 dir))
13238 "Remove all lines from LIST which are before the first headline."
13250 rtn line level)
13255 ;; Beginning of a COMMENT subtree. Skip it.
13261 ;; an ordinary comment line
13262 )
13268 ;; a special table line that should be removed
13269 )
13276 \[v] limit export to visible part of outline tree
13278 \[a] export as ASCII
13279 \[h] export as HTML
13280 \[b] export as HTML and browse immediately
13281 \[x] export as XOXO
13283 \[i] export current file as iCalendar file
13284 \[I] export all agenda files as iCalendar files
13285 \[c] export agenda files into combined iCalendar file
13287 \[F] publish current file
13288 \[P] publish current project
13289 \[X] publish... (project will be prompted for)
13305 r1 r2 ass)
13317 ;; ASCII
13608 )
13609 "Entities for TeX->HTML translation.
13613 The list contains HTML entities for Latin-1, Greek and other symbols.
13614 It is supplemented by a number of commonly used TeX macros with appropriate
13618 "Cleanup a buffer substring so that links can be created safely."
13625 rtn)
13632 ;; Get rid of archived trees
13643 ;; Find targets in comments and move them out of comments,
13644 ;; but mark them as targets that should be invisible
13649 ;; Find matches for radio targets and turn them into internal links
13655 ;; Find all links that contain a newline and put them into a single line
13657 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
13661 ;; Convert LaTeX fragments to images
13666 org-current-export-file)))
13670 ;; Normalize links: Convert angle and plain links into bracket links
13676 t t))
13682 t t))
13684 ;; Find multiline emphasis and put them into single line
13691 ;; Remove comments
13697 rtn))
13700 "Take link text and make a safe target out of it."
13704 'identity
13710 "Convert an org-mode file with all levels allowed to one with odd levels.
13711 This will leave level 1 alone, convert level 2 to level 3, level 3 to
13712 level 5 etc."
13726 "Convert an org-mode file with only odd levels to one with odd and even levels.
13727 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
13728 section with an even level, conversion would destroy the structure of the file. An error
13729 is signaled in this case."
13732 ;; First check if there are no even levels
13747 "Make N odd if required."
13754 "Export the outline as a pretty ASCII file.
13755 If there is an active region, export only the region.
13756 The prefix ARG specifies how many levels of the outline should become
13757 underlined headlines. The default is 3."
13810 ;; create local variables for all options, to make sure all called
13811 ;; functions get the correct information
13815 org-export-plist-vars)
13818 org-export-headline-levels))
13820 ;; File header
13839 line)
13840 ;; This is a headline
13845 todo
13849 org-done-string)))
13850 ; TODO, not DONE
13854 line lines level))))
13872 ))))
13873 lines)))
13877 ;; Remove the quoted HTML tags.
13879 ;; Remove targets
13882 ;; Replace internal links
13886 t nil line)))
13889 ;; a Headline
13897 ;; remove display and invisible chars
13913 "Search the subtree below LINE for any TODO entries."
13916 line lv todo)
13924 org-done-string))))
13925 ; TODO, not DONE
13930 "Handle quoted HTML for ASCII export."
13933 ;; We just remove the tags for now.
13935 line)
13938 "Insert the string S centered and underline it with character UNDERLINE."
13947 "Insert a new level in ASCII export."
13953 org-export-ascii-bullets))
13955 ;; find the indentation of the next non-empty line
13976 "Create a copy of the visible part of the current buffer, and export it.
13977 The copy is created in a temporary buffer and removed after use.
13978 TYPE is the final key (as a string) that also select the export command in
13979 the `C-c C-e' export dispatcher.
13980 As a special case, if the you type SPC at the prompt, the temporary
13981 org-mode file will not be removed but presented to you so that you can
13982 continue to use it. The prefix arg ARG is passed through to the exporting
13983 command."
13988 current-prefix-arg))
14001 s e)
14011 ;; Copy all comment lines to the end, to make sure #+ settings are
14012 ;; still available for the second export step. Kind of a hack, but
14013 ;; does do the trick.
14034 s))
14039 s))
14041 ;; HTML
14044 "Return a string with current options as keyword options.
14045 Does include HTML export options as well as TODO and CATEGORY stuff."
14047 "#+TITLE: %s
14048 #+AUTHOR: %s
14049 #+EMAIL: %s
14050 #+LANGUAGE: %s
14051 #+TEXT: Some descriptive text to be emitted. Several lines OK.
14053 #+CATEGORY: %s
14054 #+SEQ_TODO: %s
14055 #+TYP_TODO: %s
14056 #+STARTUP: %s %s %s %s %s %s
14057 #+TAGS: %s
14058 #+ARCHIVE: %s
14059 "
14061 org-export-headline-levels
14062 org-export-with-section-numbers
14063 org-export-with-toc
14064 org-export-preserve-breaks
14065 org-export-html-expand
14066 org-export-with-fixed-width
14067 org-export-with-tables
14068 org-export-with-sub-superscripts
14069 org-export-with-emphasize
14070 org-export-with-TeX-macros
14071 org-export-with-LaTeX-fragments
14093 org-archive-location
14094 ))
14097 "Insert into the buffer a template with information for exporting."
14106 "Toggle the fixed-width export.
14107 If there is no active region, the QUOTE keyword at the current headline is
14108 inserted or removed. When present, it causes the text between this headline
14109 and the next to be exported as fixed-width text, and unmodified.
14110 If there is an active region, this command adds or removes a colon as the
14111 first character of this line. If the first character of a line is a colon,
14112 this line is also exported in fixed-width font."
14120 off)
14150 "Export the outline as HTML and immediately open it with a browser.
14151 If there is an active region, export only the region.
14152 The prefix ARG specifies how many levels of the outline should become
14153 headlines. The default is 3. Lower levels will become bulleted lists."
14159 "Call `org-export-as-html', may be used in batch processing as
14160 emacs --batch
14161 --load=$HOME/lib/emacs/org.el
14163 --visit=MyFile --funcall org-export-as-html-batch"
14167 "Export the outline as a pretty HTML file.
14168 If there is an active region, export only the region.
14169 The prefix ARG specifies how many levels of the outline should become
14170 headlines. The default is 3. Lower levels will become bulleted lists.
14171 When HIDDEN is non-nil, don't display the HTML buffer.
14172 EXT-PLIST is a property list with external parameters overriding
14173 org-mode's default settings, but still inferior to file-local settings."
14180 ext-plist
14185 valid
14192 ;; The following two are dynamically scoped into other
14193 ;; routines below.
14199 region :emph-multiline
14236 buffer-file-coding-system))
14242 table-open type
14243 table-buffer table-orig-buffer
14244 ind start-is-num starter
14245 rpl path desc descp desc1 desc2 link
14246 )
14252 ;; Get the language-dependent settings
14256 ;; Switch to the output buffer
14264 ;; create local variables for all options, to make sure all called
14265 ;; functions get the correct information
14269 org-export-plist-vars)
14271 org-export-headline-levels))
14273 ;; File header
14279 <head>
14280 <title>%s</title>
14285 %s
14286 </head><body>
14287 "
14289 date time author style))
14302 org-export-html-toplevel-hlevel
14304 org-export-html-toplevel-hlevel))
14309 ;; This is a headline
14317 todo
14321 org-done-string)))
14322 ; TODO, not DONE
14326 line lines level))))
14350 ;; Check for targets
14355 t t line))
14358 target-alist))
14366 head-count txt))
14369 )))
14370 line)
14371 lines))
14375 ))
14382 ;; end of quote section?
14386 ;; inside a quote section?
14391 ;; verbatim lines
14406 ;; make targets to anchors
14414 t t line)))
14418 ; (concat "@<i>" (match-string 1 line) "@</i> ")
14419 t t line)))
14425 t t line)))))
14429 ;; replace "&" by "&", "<" and ">" by "<" and ">"
14430 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
14431 ;; Also handle sub_superscripts and checkboxes
14434 ;; Format the links
14444 ;; FIXME: do we need to unescape here somewhere?
14453 ;; standard URL
14457 ;; FILE link
14460 thefile file-is-image-p search)
14468 t))
14478 ;; make sure this is can be used as target search
14502 ;; TODO items
14514 ;; This is a headline
14521 ;; Close any local lists before inserting a new header line
14527 in-local-list nil))
14530 head-count)
14531 ;; QUOTES
14539 ;; New table starts
14541 ;; Accumulate lines
14553 ;; Normal lines
14556 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
14557 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
14560 line)
14567 ;; empty line. Pretend indentation is large.
14581 ;; Start new (level of ) list
14588 ;; continue current list
14595 "<b>[X]</b>"
14597 t t line))))
14599 ;; Empty lines start a new paragraph. If hand-formatted lists
14600 ;; are not fully interpreted, lines starting with "-", "+", "*"
14601 ;; also start a new paragraph.
14604 ;; Check if the line break needs to be conserved
14613 ;; Properly close all local lists and other lists
14616 ;; Close any local lists before inserting a new header line
14622 in-local-list nil))
14625 head-count)
14645 ;; remove empty paragraphs and lists
14658 "Find out which HTML converter to use and return the HTML code."
14660 ;; A normal org table
14662 ;; Table made by table.el - test for spanning
14666 nil))
14667 lines)))
14673 hlines))))
14676 ;; We can use my own converter with HTML conversions
14678 ;; Need to use the code generator in table.el, with the original text.
14682 "Format a table into HTML."
14688 ;; Check if the table has a marking column. If yes remove the
14689 ;; column and the special lines
14697 lines)))))
14704 nil ; ignore this line
14708 lines))))))
14714 line fields html)
14721 ;; ignore this line
14723 ;; Break the line into fields
14726 html
14727 "<tr>"
14735 html))
14745 newstr))
14748 "Format a table generated by table.el into HTML.
14749 This conversion does *not* use `table-generate-source' from table.el.
14750 This has the advantage that Org-mode's HTML conversions can be used.
14751 But it has the disadvantage, that no cell- or row-spanning is allowed."
14754 fields html empty)
14764 html
14765 "<tr>"
14776 ;; Ignore this line
14778 ;; Break the line into fields and store the fields
14784 field-buffer))
14787 html))
14790 "Format a table into html, using `table-generate-source' from table.el.
14791 This has the advantage that cell- or row-spanning is allowed.
14792 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
14807 "Format time stamps in string S, or remove them."
14811 ;; FIXME: is it good to never export CLOCK, or do we need control?
14826 ;; Line break if line started and ended with time stamp stuff
14828 s
14832 r))))
14835 ;; convert & to &, < to < and > to >
14844 s)
14847 "Remove tags and time staps from lines going into the toc."
14853 s)
14856 "Prepare STRING for HTML export. Applies all active conversions.
14857 If there are links in the string, don't modify these."
14869 "Apply all active conversions to translate special ASCII to HTML."
14885 t t s))
14887 s)
14890 "Create a regular expression which will match a balanced sexp.
14891 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
14892 as single character strings.
14893 The regexp returned will match the entire expression including the
14894 delimiters. It will also define a single group which contains the
14895 match except for the outermost delimiters. The maximum depth of
14896 stacked delimiters is N. Escaping delimiters is not possible."
14918 "Convert sub- and superscripts in STRING to HTML."
14928 t t string)))
14931 string)
14934 "Apply emphasis."
14936 (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)))
14937 string)
14941 "Insert <p>, but first close previous paragraph if any."
14946 "Close paragraph if there is one open."
14951 "Close <li> if necessary."
14954 ; (when (save-excursion
14955 ; (re-search-backward "</?\\(ul\\|ol\\|li\\|[hH][0-9]\\)>" nil t))
14956 ; (if (member (match-string 0) '("</ul>" "</ol>" "<li>"))
14957 ; (insert "</li>"))))
14960 "Insert a new level in HTML export.
14961 When TITLE is nil, just close all open levels."
14971 ;; If title is nil, this means this function is called to close
14972 ;; all levels, so the rest is done only if title is given
14984 t t title)))
14999 level head-count title level))
15004 "Terminate one level in HTML export."
15008 ;; Variable holding the vector with section numbers
15012 "Initialize the vector for the section numbers."
15029 "Return a string with the current section number.
15030 When LEVEL is non-nil, increase section numbers on that level."
15052 string))
15055 ;;;###autoload
15057 "Export current file as an iCalendar file.
15058 The iCalendar file will be located in the same directory as the Org-mode
15059 file, but with extension `.ics'."
15069 "Export the org buffer as XOXO.
15070 The XOXO buffer is named *xoxo-<source buffer name>*"
15072 ;; A quickie abstraction
15074 ;; Output everything as XOXO
15087 ;; Check the output buffer is empty.
15089 ;; Kick off the output
15106 ;; Handle level rendering
15123 )
15127 ;; And output the new li
15133 ;; Finally finish off the ol
15139 ;; Finish the buffer off and clean it up.
15144 )))
15146 ;;;###autoload
15148 "Export all files in `org-agenda-files' to iCalendar .ics files.
15149 Each iCalendar file will be located in the same directory as the Org-mode
15150 file, but with extension `.ics'."
15154 ;;;###autoload
15156 "Export all files in `org-agenda-files' to a single combined iCalendar file.
15157 The file is stored under the name `org-combined-agenda-icalendar-file'."
15162 "Create iCalendar files for all elements of FILES.
15163 If COMBINE is non-nil, combine all calendar entries into a single large
15164 file and store it under the name `org-combined-agenda-icalendar-file'."
15168 org-export-publishing-directory)))
15169 file ical-file ical-buffer category started org-agenda-new-buffers)
15174 org-combined-agenda-icalendar-file
15207 "Hook run after an iCalendar file has been saved.
15208 The iCalendar buffer is still current when this hook is run.
15209 A good way to use this is to tell a desktop calenndar application to re-read
15213 "Print iCalendar entries for the current Org-mode file to `standard-output'.
15214 When COMBINE is non nil, add the category to each line."
15225 inc t
15234 pos)
15237 ;; donep (org-entry-is-done-p)
15238 ))
15247 %s
15248 %s
15249 SUMMARY:%s
15253 hd)))
15269 %s
15270 SUMMARY:%s
15271 SEQUENCE:1
15272 PRIORITY:%d
15274 dts hd pri))))))))
15277 "Start an iCalendar file by inserting the header."
15283 VERSION:2.0
15284 X-WR-CALNAME:%s
15285 PRODID:-//%s//Emacs with Org-mode//EN
15286 X-WR-TIMEZONE:%s
15290 "Finish an iCalendar file by inserting the END statement."
15294 "Take a time string S and convert it to iCalendar format.
15295 KEYWORD is added in front, to make a complete line like DTSTART....
15296 When INC is non-nil, increase the hour by two (if time string contains
15297 a time), or the day by one (if it does not contain a time)."
15299 t2 fmt have-time time)
15311 ;;; LaTeX stuff
15326 "Toggle the minor `org-cdlatex-mode'.
15327 This mode supports entering LaTeX environment and math in LaTeX fragments
15328 in Org-mode.
15330 nil " OCDL" nil
15335 "Always return t in org-mode buffers.
15336 This is because we want to insert math symbols without dollars even outside
15337 the LaTeX math segments. If Orgmode thinks that point is actually inside
15338 en embedded LaTeX fragement, let texmathp do its job.
15355 "Unconditionally turn on `org-cdlatex-mode'."
15359 "Test if point is inside a LaTeX fragment.
15361 sequence appearing also before point.
15362 Even though the matchers for math are configurable, this function assumes
15364 delimiters are skipped when they have been removed by customization.
15365 The return value is nil, or a cons cell with the delimiter and
15366 and the position of this delimiter.
15368 This function does a reasonably good job, but can locally be fooled by
15369 for example currency specifications. For example it will assume being in
15371 fragments that are properly closed, but during editing, we have to live
15372 with the uncertainty caused by missing closing delimiters. This function
15373 looks only before point, not after."
15392 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15396 ;; count $$
15404 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15405 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15406 - inside a LaTeX fragment, or
15407 - after the first word in a line, where an abbreviation expansion could
15408 insert a LaTeX environment."
15409 ;; FIXME: This may still need refinement.
15422 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15423 Revert to the normal definition outside of these fragments."
15431 "Execute `cdlatex-math-modify' in LaTeX fragments.
15432 Revert to the normal definition outside of these fragments."
15444 "Remove all overlays with LaTeX fragment images in current buffer."
15449 "Preview the LaTeX fragment at point, or all locally or globally.
15450 If the cursor is in a LaTeX fragment, create the image and overlay
15451 it over the source code. If there is no fragment at point, display
15452 all fragments in the current text, from one headline to the next. With
15453 prefix SUBTREE, display all fragments in the current subtree. With a
15454 double prefix `C-u C-u', or when the cursor is before the first headline,
15455 display all fragments in the buffer.
15484 buffer-file-name)))
15490 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15491 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
15492 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
15499 "Replace LaTeX fragments with links to an image, and produce images."
15508 m n block linkfile movefile ov)
15509 ;; Make sure the directory exists
15511 ;; Check if there are old images files with this prefix, and remove them
15513 todir 'full
15516 ;; Check the different regular expressions
15533 txt movefile opt)
15541 ov 'end-glyph
15544 ov 'display
15551 ;; This function borrows from Ganesh Swami's latex2png.el
15555 temporary-file-directory))
15559 ;(texfilebase (make-temp-file "orgtex"))
15560 ; (dummy (delete-file texfilebase))
15589 "-o" pngfile
15590 dvifile)
15593 ;; Use the requested file name and clean up
15597 pngfile))))
15599 ;;; Key bindings
15601 ;; - Bindings in Org-mode map are currently
15602 ;; 0123456789abcdefghijklmnopqrstuvwxyz!?@#$%^&-+*/=()_{}[]:;"|,.<>~`'\t the alphabet
15603 ;; abcd fgh j lmnopqrstuvwxyz!? #$ ^ -+*/= [] ; |,.<>~ '\t necessary bindings
15604 ;; e (?) useful from outline-mode
15605 ;; i k @ expendable from outline-mode
15606 ;; 0123456789 % & ()_{} " ` free
15608 ;; Make `C-c C-x' a prefix key
15611 ;; TAB key with modifiers
15617 ;; The following line is necessary under Suse GNU/Linux
15630 ;; Cursor keys with modifiers
15661 ;; All the other keys
15731 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
15732 If the cursor is in a table looking at whitespace, the whitespace is
15733 overwritten, and the table is not marked as requiring realignment."
15737 ;; check if we blank the field, and if that triggers align
15742 ;; got extra space, this field does not determine column width
15744 ;; no extra space, this field may determine column width
15746 t)
15758 "Like `delete-backward-char', insert whitespace at field end in tables.
15759 When deleting backwards, in tables this function will insert whitespace in
15761 still be marked for re-alignment if the field did fill the entire column,
15762 because, in this case the deletion might narrow the column."
15775 ;; noalign: if there were two spaces at the end, this field
15776 ;; does not determine the width of the column.
15781 "Like `delete-char', but insert whitespace at field end in tables.
15782 When deleting characters, in tables this function will insert whitespace in
15784 still be marked for re-alignment if the field did fill the entire column,
15785 because, in this case the deletion might narrow the column."
15799 ;; noalign: if there were two spaces at the end, this field
15800 ;; does not determine the width of the column.
15805 ;; How to do this: Measure non-white length of current string
15806 ;; If equal to column width, we should realign.
15809 "In MAP, remap the functions given in COMMANDS.
15810 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
15819 ;; If the user wants maximum table support, we need to hijack
15820 ;; some standard editing functions
15828 "Throw an error because Shift-Cursor command was applied in wrong context."
15832 "Global visibility cycling or move to previous table field.
15833 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
15834 on context.
15835 See the individual commands for more information."
15842 "Promote subtree or delete table column.
15843 Calls `org-promote-subtree' or `org-table-delete-column', depending on context.
15844 See the individual commands for more information."
15853 "Demote subtree or insert table column.
15854 Calls `org-demote-subtree' or `org-table-insert-column', depending on context.
15855 See the individual commands for more information."
15864 "Move subtree up or kill table row.
15865 Calls `org-move-subtree-up' or `org-table-kill-row' or
15866 `org-move-item-up' depending on context. See the individual commands
15867 for more information."
15875 "Move subtree down or insert table row.
15876 Calls `org-move-subtree-down' or `org-table-insert-row' or
15877 `org-move-item-down', depending on context. See the individual
15878 commands for more information."
15887 "Promote heading or move table column to left.
15888 Calls `org-do-promote' or `org-table-move-column', depending on context.
15889 With no specific context, calls the Emacs default `backward-word'.
15890 See the individual commands for more information."
15899 "Demote subtree or move table column to right.
15900 Calls `org-do-demote' or `org-table-move-column', depending on context.
15901 With no specific context, calls the Emacs default `forward-word'.
15902 See the individual commands for more information."
15911 "Move subtree up or move table row up.
15912 Calls `org-move-subtree-up' or `org-table-move-row' or
15913 `org-move-item-up', depending on context. See the individual commands
15914 for more information."
15923 "Move subtree down or move table row down.
15924 Calls `org-move-subtree-down' or `org-table-move-row' or
15925 `org-move-item-down', depending on context. See the individual
15926 commands for more information."
15935 "Increase item in timestamp or increase priority of current headline.
15936 Calls `org-timestamp-up' or `org-priority-up', depending on context.
15937 See the individual commands for more information."
15946 "Decrease item in timestamp or decrease priority of current headline.
15947 Calls `org-timestamp-down' or `org-priority-down', depending on context.
15948 See the individual commands for more information."
15956 "Next TODO keyword or timestamp one day later, depending on context."
15964 "Previous TODO keyword or timestamp one day earlier, depending on context."
15972 "Copy region in table or copy current subtree.
15973 Calls `org-table-copy' or `org-copy-subtree', depending on context.
15974 See the individual commands for more information."
15980 "Cut region in table or cut current subtree.
15981 Calls `org-table-copy' or `org-cut-subtree', depending on context.
15982 See the individual commands for more information."
15988 "Paste rectangular region into table, or past subtree relative to level.
15989 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
15990 See the individual commands for more information."
15997 "Set tags in headline, or update according to changed information at point.
15999 This command does many different things, depending on context:
16001 - If the cursor is in a headline, prompt for tags and insert them
16002 into the current line, aligned to `org-tags-column'. When called
16003 with prefix arg, realign all tags in the current buffer.
16005 - If the cursor is in one of the special #+KEYWORD lines, this
16006 triggers scanning the buffer for these lines and updating the
16007 information.
16009 - If the cursor is inside a table, realign the table. This command
16010 works even if the automatic table editor has been turned off.
16012 - If the cursor is on a #+TBLFM line, re-apply the formulas to
16013 the entire table.
16015 - If the cursor is inside a table created by the table.el package,
16016 activate that table.
16018 - If the current buffer is a remember buffer, close note and file it.
16019 with a prefix argument, file it without further interaction to the default
16020 location.
16022 - If the cursor is on a <<<target>>>, update radio targets and corresponding
16023 links in this buffer.
16025 - If the cursor is on a numbered item in a plain list, renumber the
16026 ordered list."
16031 org-latex-fragment-image-overlays)
16059 ;; Recalculate the table before this line
16070 "Restart Org-mode, to scan again for special lines.
16071 Also updates the keyword regular expressions."
16077 "Goto next table row or insert a newline.
16078 Calls `org-table-next-row' or `newline', depending on context.
16079 See the individual commands for more information."
16088 "Insert a new heading or wrap a region in a table.
16089 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
16090 See the individual commands for more information."
16097 ;;; Menu entries
16099 ;; Define the Org-mode menus
16106 "--"
16110 "--"
16116 "--"
16117 ["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])
16124 "--"
16131 "--"
16134 ["Set Named Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
16136 "--"
16138 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
16140 "--"
16147 "--"
16149 org-enable-table-editor)]
16153 "--"
16162 "--"
16170 "--"
16175 "--"
16179 "--"
16184 "--"
16201 "--"
16205 "--"
16214 "--"
16218 "--"
16219 ; ["Insert Checkbox" org-insert-todo-heading (org-in-item-p)]
16220 ; ["Toggle Checkbox" org-ctrl-c-ctrl-c (org-at-item-checkbox-p)]
16221 ; ["Insert [n/m] cookie" (progn (insert "[/]") (org-update-checkbox-count))
16222 ; (or (org-on-heading-p) (org-at-item-p))]
16223 ; ["Insert [%] cookie" (progn (insert "[%]") (org-update-checkbox-count))
16224 ; (or (org-on-heading-p) (org-at-item-p))]
16225 ; ["Update Statistics" org-update-checkbox-count t]
16226 )
16238 "--"
16247 "--"
16251 org-done-string
16254 "--"
16262 "--"
16267 "--"
16275 "--"
16279 "--"
16291 "--"
16297 "--"
16300 "--"
16302 ))
16305 "Read documentation for Org-mode in the info system.
16306 With optional NODE, go directly to that node."
16329 ;;; Documentation
16332 "Call the customize function with org as argument."
16337 "Create a full customization menu for Org-mode, insert it into the menu."
16344 "--"
16354 ;;; Miscellaneous stuff
16357 "Return a list of contexts of the current cursor position.
16358 If several contexts apply, all are returned.
16359 Each context entry is a list with a symbol naming the context, and
16360 two positions indicating start and end of the context. Possible
16361 contexts are:
16363 :headline anywhere in a headline
16364 :headline-stars on the leading stars in a headline
16365 :todo-keyword on a TODO keyword (including DONE) in a headline
16366 :tags on the TAGS in a headline
16367 :priority on the priority cookie in a headline
16368 :item on the first line of a plain list item
16369 :item-bullet on the bullet/number of a plain list item
16370 :checkbox on the checkbox in a plain list item
16371 :table in an org-mode table
16372 :table-special on a special filed in a table
16373 :table-table in a table.el table
16374 :link on a hyperline
16375 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
16376 :target on a <<target>>
16377 :radio-target on a <<<radio-target>>>
16378 :latex-fragment on a LaTeX fragment
16379 :latex-preview on a LaTeX fragment with overlayed preview image
16381 This function expects the position to be visible because it uses font-lock
16382 faces as a help to recognize the following contexts: :table-special, :link,
16383 and :keyword."
16387 ;; First the large context
16406 clist)
16420 ;; Now the small context
16448 ;; FIXME: positions wring.
16452 clist))
16455 "Check if POINT is in match-group GROUP.
16456 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
16457 match. If the match group does ot exist or point is not inside it,
16458 return nil."
16464 t)))
16467 "Move the current line down. With prefix argument, move it past ARG lines."
16470 beg end pos)
16480 "Move the current line up. With prefix argument, move it past ARG lines."
16483 beg end pos)
16492 ;; Paragraph filling stuff.
16493 ;; We want this to be just right, so use the full arsenal.
16497 ;; In the paragraph separator we include headlines, because filling
16498 ;; text in a line directly attached to a headline would otherwise
16499 ;; fill the headline as well.
16502 ;; The paragraph starter includes hand-formatted lists.
16505 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
16506 ;; But only if the user has not turned off tables or fixed-width regions
16508 'auto-fill-inhibit-regexp
16517 ;; We use our own fill-paragraph function, to make sure that tables
16518 ;; and fixed-width regions are not wrapped. That function will pass
16519 ;; through to `fill-paragraph' when appropriate.
16521 ; Adaptive filling: To get full control, first make sure that
16522 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
16528 "Re-align a table, pass through to fill-paragraph if no table."
16536 ;; For reference, this is the default value of adaptive-fill-regexp
16537 ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
16540 "Return a fill prefix for org-mode files.
16541 In particular, this makes sure hanging paragraphs for hand-formatted lists
16542 work correctly."
16546 ;; Functions needed for Emacs/XEmacs region compatibility
16549 "Add-hook, compatible with both Emacsen."
16555 "Is `transient-mark-mode' on and the region active?
16556 Works on both Emacs and XEmacs."
16558 nil
16564 "Add elements to `buffer-invisibility-spec'.
16565 See documentation for `buffer-invisibility-spec' for the kind of elements
16566 that can be added."
16577 "Remove elements from `buffer-invisibility-spec'."
16585 "Is ARG a member of `buffer-invisibility-spec'?"
16588 nil))
16591 "Return regexp matching the file names of images."
16599 image-file-name-extensions)
16600 image-file-name-extensions)
16601 t)
16604 ;; Functions extending outline functionality
16606 ;; C-a should go to the beginning of a *visible* line, also in the
16607 ;; new outline.el. I guess this should be patched into Emacs?
16609 "Go to the beginning of the current line. If that is invisible, continue
16610 to a visible line beginning. This makes the function of C-a more intuitive."
16614 nil
16625 "Check if point is at a character currently not visible."
16626 ;; Early versions of noutline don't have `outline-invisible-p'.
16632 "Check if point is at a character currently not visible."
16635 ;; Early versions of noutline don't have `outline-invisible-p'.
16654 "Move to the heading line of which the present line is a subheading.
16655 This function considers both visible and invisible heading lines.
16656 With argument, move up ARG levels."
16662 "Show an entry where even the heading is hidden."
16667 "Flag the current heading. FLAG non-nil means make invisible.
16668 When ENTRY is non-nil, show the entire entry."
16671 ;; Check if we should show the entire entry
16680 flag))))
16683 ;; This is an exact copy of the original function, but it uses
16684 ;; `org-back-to-heading', to make it work also in invisible
16685 ;; trees. And is uses an invisible-OK argument.
16686 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
16696 ;; Go to end of line before heading
16699 ;; leave blank line before heading
16704 "Show everything after this heading at deeper levels."
16709 nil))
16712 "Show the body directly following this heading.
16713 Show the heading too, if it is currently invisible."
16722 nil)))
16725 "Make a regular expression for keyword lines."
16727 "^"
16733 ;; Make `bookmark-jump' show the jump location if it was hidden.
16736 ;; We can use the hook
16738 ;; Hook not available, use advice
16740 "Make the position visible."
16744 "Unhide the current position, to show the bookmark location."
16751 ;;; Experimental code
16754 ;(add-hook 'org-load-hook
16755 ; (lambda ()
16756 ; (defun outline-show-heading ()
16757 ; "Show the current heading and move to its end."
16758 ; (outline-flag-region
16759 ; (- (point)
16760 ; (cond
16761 ; ((bobp) 0)
16762 ; ((equal (buffer-substring
16763 ; (max (point-min) (- (point) 3)) (point))
16764 ; "\n\n\n")
16765 ; 2)
16766 ; (t 1)))
16767 ; (progn (outline-end-of-heading) (point))
16768 ; nil))))
16770 ;;; Finish up
16776 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
16777 ;;; org.el ends here