| blob | 60d63e10affc75903630360578bb1752db0f7867 |
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.46
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.46
65 ;; - Custom commands may produce an agenda which contains several blocks,
66 ;; each block created by a different agenda command.
67 ;; - Agenda commands can be restricted to the current file, region, subtree.
68 ;; - The timeline command must now be called through the agenda
69 ;; dispatcher (C-c a L). `C-c C-r' no longer works.
70 ;; - Agenda items can be sorted by tag. The *last* tag is used for this.
71 ;; - The prefix and the sorting strategy for agenda items can depend
72 ;; upon the agenda type.
73 ;; - The handling of `mailto:' links can be customized, see the new
74 ;; variable `org-link-mailto-program'.
75 ;; - `mailto' links can specify a subject after a double colon,
76 ;; like [[mailto:carsten@orgmode.org::Org-mode is buggy]].
77 ;; - In the #+STARTUP line, M-TAB completes valid keywords.
78 ;; - In the #+TAGS: line, M-TAB after ":" inserts all currently used tags.
79 ;; - Again full Emacs 21 support: Checkboxes and publishing are fixed.
80 ;; - More minor bug fixes.
81 ;;
82 ;; Version 4.45
83 ;; - Checkbox lists can show statistics about checked items.
84 ;; - C-TAB will cycle the visibility of archived subtrees.
85 ;;; - Documentation about checkboxes has been moved to chapter 5.
86 ;; - Bux fixes.
87 ;;
88 ;; Version 4.44
89 ;; - Clock table can be done for a limited time interval.
90 ;; - Obsolete support for the old outline mode has been removed.
91 ;; - Bug fixes and code cleaning.
92 ;;
93 ;; Version 4.43
94 ;; - Bug fixes
95 ;; - `s' key in the agenda saves all org-mode buffers.
96 ;;
97 ;; Version 4.41
98 ;; - Shift-curser keys can modify inactive time stamps (inactive time
99 ;; stamps are the ones in [...] brackets.
100 ;; - Toggle all checkboxes in a region/below a headline.
101 ;; - Bug fixes.
102 ;;
103 ;;; Code:
108 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
109 ;; the file noutline.el being loaded.
111 ;; We require noutline, which might be provided in outline.el
113 ;; Other stuff we need.
117 ;;; Customization variables
125 ;; Compatibility constants
134 "Outline-based notes management and organizer."
141 "Options concerning startup of Org-mode."
146 "Non-nil means, entering Org-mode will switch to OVERVIEW.
147 This can also be configured on a per-file basis by adding one of
148 the following lines anywhere in the buffer:
150 #+STARTUP: fold
151 #+STARTUP: nofold
152 #+STARTUP: content"
160 "Non-nil means, entering Org-mode will set `truncate-lines'.
161 This is useful since some lines containing links can be very long and
162 uninteresting. Also tables look terrible when wrapped."
167 "Non-nil means, align all tables when visiting a file.
168 This is useful when the column width in tables is forced with <N> cookies
169 in table fields. Such tables will look correct only after the first re-align.
170 This can also be configured on a per-file basis by adding one of
171 the following lines anywhere in the buffer:
172 #+STARTUP: align
173 #+STARTUP: noalign"
178 "Non-nil means, entering Org-mode will run the deadline check.
179 This means, if you start editing an org file, you will get an
180 immediate reminder of any due deadlines.
181 This can also be configured on a per-file basis by adding one of
182 the following lines anywhere in the buffer:
183 #+STARTUP: dlcheck
184 #+STARTUP: nodlcheck"
189 "Non-nil means insert the first line setting Org-mode in empty files.
190 When the function `org-mode' is called interactively in an empty file, this
191 normally means that the file name does not automatically trigger Org-mode.
192 To ensure that the file will always be in Org-mode in the future, a
193 line enforcing Org-mode will be inserted into the buffer, if this option
194 has been set."
199 "Non-nil means use alternative key bindings for S-<cursor movement>.
200 Org-mode used S-<cursor movement> for changing timestamps and priorities.
201 S-<cursor movement> is also used for example by `CUA-mode' to select text.
202 If you want to use Org-mode together with `CUA-mode', Org-mode needs to use
203 alternative bindings. Setting this variable to t will replace the following
204 keys both in Org-mode and in the Org-agenda buffer.
206 S-RET -> C-S-RET
207 S-up -> M-p
208 S-down -> M-n
209 S-left -> M--
210 S-right -> M-+
212 If you do not like the alternative keys, take a look at the variable
213 `org-disputed-keys'.
215 This option is only relevant at load-time of Org-mode. Changing it requires
216 a restart of Emacs to become effective."
226 "Keys for which Org-mode and other modes compete.
227 This is an alist, cars are symbols for lookup, 1st element is the default key,
231 "Select a key according to `org-CUA-compatible'."
237 "The ellipsis to use in the Org-mode outline.
238 When nil, just use the standard three dots. When a string, use that instead,
239 and just in Org-mode (which will then use its own display table).
240 Changing this requires executing `M-x org-mode' in a buffer to become
241 effective."
250 "Keywords in Org-mode."
255 "String to mark deadline entries.
256 A deadline is this string, followed by a time stamp. Should be a word,
257 terminated by a colon. You can insert a schedule keyword and
259 Changes become only effective after restarting Emacs."
264 "String to mark scheduled TODO entries.
265 A schedule is this string, followed by a time stamp. Should be a word,
266 terminated by a colon. You can insert a schedule keyword and
268 Changes become only effective after restarting Emacs."
273 "String used as the prefix for timestamps logging closing a TODO entry."
278 "String used as prefix for timestamps clocking work hours on an item."
283 "Entries starting with this keyword will never be exported.
284 An entry can be toggled between COMMENT and normal with
286 Changes become only effective after restarting Emacs."
291 "Entries starting with this keyword will be exported in fixed-width font.
292 Quoting applies only to the text in the entry following the headline, and does
293 not extend beyond the next headline, even if that is lower level.
294 An entry can be toggled between QUOTE and normal with
300 "Options concerning the general structure of Org-mode files."
305 "Options concerning visibility cycling in Org-mode."
310 "Cycle globally if cursor is at beginning of buffer and not at a headline.
311 This makes it possible to do global cycling without having to use S-TAB or
312 C-u TAB. For this special case to work, the first line of the buffer
313 must not be a headline - it may be empty ot some other text. When used in
314 this way, `org-cycle-hook' is disables temporarily, to make sure the
315 cursor stays at the beginning of the buffer.
316 When this option is nil, don't do anything special at the beginning
317 of the buffer."
322 "Where should `org-cycle' emulate TAB.
323 nil Never
324 white Only in completely white lines
325 whitestart Only at the beginning of lines, before the first non-white char.
326 t Everywhere except in headlines
327 If TAB is used in a place where it does not emulate TAB, the current subtree
328 visibility is cycled."
334 ))
337 org-optimize-window-after-visibility-change)
338 "Hook that is run after `org-cycle' has changed the buffer visibility.
339 The function(s) in this hook must accept a single argument which indicates
340 the new state that was set by the most recent `org-cycle' command. The
341 argument is a symbol. After a global state change, it can have the values
342 `overview', `content', or `all'. After a local state change, it can have
343 the values `folded', `children', or `subtree'."
348 "Options concerning structure editing in Org-mode."
353 "Non-nil means, skip even levels and only use odd levels for the outline.
354 This has the effect that two stars are being added/taken away in
355 promotion/demotion commands. It also influences how levels are
356 handled by the exporters.
357 Changing it requires restart of `font-lock-mode' to become effective
358 for fontification also in regions already fontified.
359 You may also set this on a per-file basis by adding one of the following
360 lines to the buffer:
362 #+STARTUP: odd
363 #+STARTUP: oddeven"
369 "Non-nil means, adapt indentation when promoting and demoting.
370 When this is set and the *entire* text in an entry is indented, the
371 indentation is increased by one space in a demotion command, and
372 decreased by one in a promotion command. If any line in the entry
373 body starts at column 0, indentation is not changed at all."
378 "Hook being run after inserting a new heading."
384 This currently only means, they are never auto-wrapped.
385 When nil, such lines will be treated like ordinary lines.
386 See also the QUOTE keyword."
391 "Options concerning sparse trees in Org-mode."
396 "Non-nil means, highlight all matches that define a sparse tree.
397 The highlights will automatically disappear the next time the buffer is
398 changed by an edit command."
403 "Non-nil means, show full hierarchy when showing a spot in the tree.
404 Turning this off makes sparse trees more compact, but also less clear."
409 "Non-nil means, show heading following match in `org-occur'.
410 When doing an `org-occur' it is useful to show the headline which
411 follows the match, even if they do not match the regexp. This makes it
412 easier to edit directly inside the sparse tree. However, if you use
413 `org-occur' mainly as an overview, the following headlines are
414 unnecessary clutter."
419 "Hook that is run after `org-occur' has constructed a sparse tree.
420 This can be used to recenter the window to show as much of the structure
421 as possible."
426 "Options concerning plain lists in Org-mode."
431 "Non-nil means, include plain lists into visibility cycling.
432 This means that during cycling, plain list items will *temporarily* be
433 interpreted as outline headlines with a level given by 1000+i where i is the
434 indentation of the bullet. In all other operations, plain list items are
435 not seen as headlines. For example, you cannot assign a TODO keyword to
436 such an item."
441 "The character that makes a line with leading number an ordered list item.
442 Valid values are ?. and ?\). To get both terminators, use t. While
443 ?. may look nicer, it creates the danger that a line with leading
444 number may be incorrectly interpreted as an item. ?\) therefore is
445 the safe choice."
452 "Non-nil means, automatically renumber ordered plain lists.
453 Renumbering happens when the sequence have been changed with
460 "Non-nil means, update checkbox statistics after insert and toggle.
461 When this is set, checkbox statistics is updated each time you either insert
468 "Options concerning archiving in Org-mode."
473 "The tag that marks a subtree as archived.
474 An archived subtree does not open during visibility cycling, and does
475 not contribute to the agenda listings."
481 "Non-nil means, the agenda will skip any items located in archived trees.
482 An archived tree is a tree marked with the tag ARCHIVE."
488 "Non-nil means, `org-cycle' will open archived trees.
489 An archived tree is a tree marked with the tag ARCHIVE.
490 When nil, archived trees will stay folded. You can still open them with
491 normal outline commands like `show-all', but not with the cycling commands."
497 "Non-nil means sparse tree construction shows matches in archived trees.
498 When nil, matches in these trees are highlighted, but the trees are kept in
499 collapsed state."
505 "The location where subtrees should be archived.
506 This string consists of two parts, separated by a double-colon.
508 The first part is a file name - when omitted, archiving happens in the same
509 file. %s will be replaced by the current file name (without directory part).
510 Archiving to a different file is useful to keep archived entries from
511 contributing to the Org-mode Agenda.
513 The part after the double colon is a headline. The archived entries will be
514 filed under that headline. When omitted, the subtrees are simply filed away
515 at the end of the file, as top-level entries.
517 Here are a few examples:
519 If the current file is Projects.org, archive in file
520 Projects.org_archive, as top-level trees. This is the default.
523 Archive in the current file, under the top-level headline
527 Archive in file ~/org/archive.org (absolute path), as top-level trees.
530 Archive in file ./basement (relative path), as level 3 trees
533 You may set this option on a per-file basis by adding to the buffer a
534 line like
536 #+ARCHIVE: basement::** Finished Tasks"
541 "Non-nil means, mark entries as DONE when they are moved to the archive file."
546 "Non-nil means, add a time stamp to entries moved to an archive file.
547 The time stamp will be added directly after the TODO state keyword in the
548 first line, so it is probably best to use this in combinations with
549 `org-archive-mark-done'."
554 "Options concerning tables in Org-mode."
560 When nil, such lines will be treated like ordinary lines.
562 When equal to the symbol `optimized', the table editor will be optimized to
563 do the following:
564 - Use automatic overwrite mode in front of whitespace in table fields.
565 This make the structure of the table stay in tact as long as the edited
566 field does not exceed the column width.
567 - Minimize the number of realigns. Normally, the table is aligned each time
568 TAB or RET are pressed to move to another field. With optimization this
569 happens only if changes to a field might have changed the column width.
570 Optimization requires replacing the functions `self-insert-command',
571 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
572 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
573 very good at guessing when a re-align will be necessary, but you can always
576 If you would like to use the optimized version in Org-mode, but the
577 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
579 This variable can be used to turn on and off the table editor during a session,
580 but in order to toggle optimization, a restart is required.
582 See also the variable `org-table-auto-blank-field'."
590 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
591 In the optimized version, the table editor takes over all simple keys that
592 normally just insert a character. In tables, the characters are inserted
593 in a way to minimize disturbing the table structure (i.e. in overwrite mode
594 for empty fields). Outside tables, the correct binding of the keys is
595 restored.
597 The default for this option is t if the optimized version is also used in
598 Org-mode. See the variable `org-enable-table-editor' for details. Changing
599 this variable requires a restart of Emacs to become effective."
604 "Settings for tables in Org-mode."
609 "The default size for newly created tables, Columns x Rows."
614 "Regular expression for recognizing numbers in table columns.
615 If a table column contains mostly numbers, it will be aligned to the
616 right. If not, it will be aligned to the left.
618 The default value of this option is a regular expression which allows
619 anything which looks remotely like a number as used in scientific
620 context. For example, all of the following will be considered a
621 number:
622 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
624 Other options offered by the customize interface are more restrictive."
642 "Fraction of numbers in a column required to make the column align right.
643 In a column all non-white fields are considered. If at least this
644 fraction of fields is matched by `org-table-number-fraction',
645 alignment to the right border applies."
650 "Bahavior of tables during editing in Org-mode."
655 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
657 removal/insertion."
662 "Non-nil means, allow to limit the width of table columns with <N> fields."
667 "Non-nil means, automatically blank table field when starting to type into it.
668 This only happens when typing immediately after a field motion
669 command (TAB, S-TAB or RET).
670 Only relevant when `org-enable-table-editor' is equal to `optimized'."
675 "Non-nil means, tab in the last column of a table with jump over a hline.
676 If a horizontal separator line is following the current line,
677 `org-table-next-field' can either create a new row before that line, or jump
678 over the line. When this option is nil, a new line will be created before
679 this line."
684 "Non-nil means, TAB will automatically notice a table.el table.
685 When it sees such a table, it moves point into it and - if necessary -
686 calls `table-recognize-table'."
691 "Options concerning tables in Org-mode."
703 calc-angle-mode deg
704 calc-prefer-frac nil
705 calc-symbolic-mode nil
707 calc-display-working-message t
708 )
709 "List with Calc mode settings for use in calc-eval for table formulas.
710 The list must contain alternating symbols (Calc modes variables and values).
711 Don't remove any of the default settings, just change the values. Org-mode
712 relies on the variables to be present in the list."
717 "Non-nil means, TAB and RET evaluate a formula in current table field.
718 If the current field starts with an equal sign, it is assumed to be a formula
719 which should be evaluated as described in the manual and in the documentation
720 string of the command `org-table-eval-formula'. This feature requires the
721 Emacs calc package.
722 When this variable is nil, formula calculation is only available through
729 "Non-nil means, interpret constants in formulas in tables.
730 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
731 by the value given in `org-table-formula-constants', or by a value obtained
732 from the `constants.el' package."
737 "Alist with constant names and values, for use in table formulas.
738 The car of each element is a name of a constant, without the `$' before it.
739 The cdr is the value as a string. For example, if you'd like to use the
740 speed of light in a formula, you would configure
744 and then use it in an equation like `$1*$c'."
751 "Non-nil means, calculate only with numbers in table formulas.
752 Then all input fields will be converted to a number, and the result
753 must also be a number. When nil, calc's full potential is available
754 in table calculations, including symbolics etc."
759 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
760 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
765 "Options concerning links in Org-mode."
770 "Non-nil means, hide link part and only show description of bracket links.
771 Bracket links are like [[link][descritpion]]. This variable sets the initial
772 state in new org-mode buffers. The setting can then be toggled on a
773 per-buffer basis from the Org->Hyperlinks menu."
779 Possible values are:
780 bracket [[link][description]]. This is recommended
788 "Default format for external, URL-like linkes in the buffer.
789 This is a format string for printf, %s will be replaced by the link text.
791 enclosing them in double brackets. If you prefer plain links (see variable
802 "How the path name in file links should be stored.
803 Valid values are:
805 relative relative to the current directory, i.e. the directory of the file
806 into which the link is being inserted.
807 absolute absolute path, if possible with ~ for home directory.
808 noabbrev absolute path, no abbreviation of home directory.
809 adaptive Use relative path for files in the current directory and sub-
810 directories of it. For other files, use an absolute path."
819 "Types of links that should be activated in Org-mode files.
820 This is a list of symbols, each leading to the activation of a certain link
821 type. In principle, it does not hurt to turn on most link types - there may
822 be a small gain when turning off unused link types. The types are:
824 bracket The recommended [[link][description]] or [[link]] links with hiding.
825 angular Links in angular brackes that may contain whitespace like
826 <bbdb:Carsten Dominik>.
827 plain Plain links in normal text, no whitespace, like http://google.com.
828 radio Text that is matched by a radio target, see manual for details.
829 tag Tag settings in a headline (link to tag search).
830 date Time stamps (link to calendar).
831 camel CamelCase words defining text searches.
833 Changing this variable requires a restart of Emacs to become effective."
844 "Options concerning storing links in Org-mode"
849 "Non-nil means, file links from `org-store-link' contain context.
850 A search string will be added to the file name with :: as separator and
851 used to find the context when the link is activated by the command
852 `org-open-at-point'.
854 negates this setting for the duration of the command."
859 "Non-nil means, use CamelCase to store a search context in a file link.
860 When nil, the search string simply consists of the words of the string.
861 CamelCase is deprecated, and support for it may be dropped in the future."
866 "Non-nil means, keep link in list for entire session.
868 The command `org-store-link' adds a link pointing to the current
869 location to an internal list. These links accumulate during a session.
870 The command `org-insert-link' can be used to insert links into any
871 Org-mode file (offering completion for all stored links). When this
873 will be removed from the list, to make completing the unused links
874 more efficient."
879 "Non-nil means, `org-store-link' will create web links to Google groups.
880 When nil, Gnus will be used for such links.
882 negates this setting for the duration of the command."
887 "Options concerning following links in Org-mode"
892 "Non-nil means, on links TAB will follow the link.
893 Needs to be set before org.el is loaded."
898 "Non-nil means, on links RET will follow the link.
899 Needs to be set before org.el is loaded."
904 "Non-nil means, mouse-1 on a link will follow the link.
905 A longer mouse click will still set point. Does not wortk on XEmacs.
906 Needs to be set before org.el is loaded."
911 "Number of different positions to be recorded in the ring
912 Changing this requires a restart of Emacs to work correctly."
920 "Setup the frame configuration for following links.
921 When following a link with Emacs, it may often be useful to display
922 this link in another window or frame. This variable can be used to
923 set this up for the different types of links.
924 For VM, use any of
925 `vm-visit-folder'
926 `vm-visit-folder-other-frame'
927 For Gnus, use any of
928 `gnus'
929 `gnus-other-frame'
930 For FILE, use any of
931 `find-file'
932 `find-file-other-window'
933 `find-file-other-frame'
934 For the calendar, use the variable `calendar-setup'.
935 For BBDB, it is currently only possible to display the matches in
936 another window."
955 "Non-nil means, `org-open-file' will open non-existing file.
956 When nil, an error will be generated."
961 "Function and arguments to call for following mailto links.
962 This is a list with the first element being a lisp function, and the
963 remaining elements being arguments to the function. In string arguments,
964 %a will be replaced by the address, and %s will be replaced by the subject
965 if one was given like in <mailto:arthur@galaxy.org::this subject>."
974 "Non-nil means, ask for confirmation before executing shell links.
975 Shell links can be dangerous, just thing about a link
977 [[shell:rm -rf ~/*][Google Search]]
980 but really it would remove your entire home directory.
981 Therefore I *definitely* advise against setting this variable to nil.
982 Just change it to `y-or-n-p' of you want to confirm with a single key press
991 "Non-nil means, ask for confirmation before executing elisp links.
992 Elisp links can be dangerous, just thing about a link
997 but really it would remove your entire home directory.
998 Therefore I *definitely* advise against setting this variable to nil.
999 Just change it to `y-or-n-p' of you want to confirm with a single key press
1010 "Default file applications on a UNIX or GNU/Linux system.
1022 "Default file applications on a MacOS X system.
1024 for some files for which the OS does not have a good default.
1032 'mswindows-shell-execute
1035 "Default file applications on a Windows NT system.
1040 '(
1047 )
1048 "External applications for opening `file:path' items in a document.
1049 Org-mode uses system defaults for different file types, but
1050 you can use this variable to set the application for a given file
1051 extension. The entries in this list are cons cells where the car identifies
1052 files and the cdr the corresponding command. Possible values for the
1053 file identifier are
1055 `directory' Matches a directory
1056 `remote' Matches a remote file, accessible through tramp or efs.
1057 Remote files most likely should be visited through emacs
1058 because external applications cannot handle such paths.
1059 t Default for all remaining files
1061 Possible values for the command are:
1062 `emacs' The file will be visited by the current Emacs process.
1063 `default' Use the default application for this file type.
1064 string A command to be executed by a shell; %s will be replaced
1065 by the path to the file.
1066 sexp A Lisp form which will be evaluated. The file path will
1067 be available in the Lisp variable `file'.
1068 For more examples, see the system specific constants
1069 `org-file-apps-defaults-macosx'
1070 `org-file-apps-defaults-windowsnt'
1071 `org-file-apps-defaults-gnu'."
1086 "Non-nil means, that the search for the mh-message will be extended to
1087 all folders if the message cannot be found in the folder given in the link.
1088 Searching all folders is very effective with one of the search engines
1089 supported by MH-E, but will be slow with pick."
1094 "Options concerning interaction with remember.el."
1099 "Directory with org files.
1100 This directory will be used as default to prompt for org files.
1101 Used by the hooks for remember.el."
1106 "Default target for storing notes.
1107 Used by the hooks for remember.el. This can be a string, or nil to mean
1108 the value of `remember-data-file'."
1112 file))
1115 "Templates for the creation of remember buffers.
1116 When nil, just let remember make the buffer.
1117 When not nil, this is a list of 3-element lists. In each entry, the first
1118 element is a character, a unique key to select this template.
1119 The second element is the template. The third element is optional and can
1120 specify a destination file for remember items created with this template.
1121 The default file is given by `org-default-notes-file'.
1123 The template specifies the structure of the remember buffer. It should have
1124 a first line starting with a star, to act as the org-mode headline.
1125 Furthermore, the following %-escapes will be replaced with content:
1126 %t time stamp, date only
1127 %T time stamp with date and time
1128 %u inactive time stamp, date only
1129 %U inactive time stamp with date and time
1130 %n user name
1131 %a annotation, normally the link created with org-store-link
1132 %i initial content, the region when remember is called with C-u.
1133 If %i is indented, the entire inserted text will be indented as well.
1134 %? This will be removed, and the cursor placed at this position."
1143 "Non-nil means, store new notes at the beginning of a file or entry.
1144 When nil, new notes will be filed to the end of a file or entry."
1153 "Options concerning TODO items in Org-mode."
1158 "List of TODO entry keywords.
1161 action is required, and will make the entry show up in todo lists, diaries
1162 etc.
1164 additional state where no keyword is present. For details about this
1165 cycling, see also the variable `org-todo-interpretation'
1166 Changes become only effective after restarting Emacs."
1172 "Controls how TODO keywords are interpreted.
1173 This variable is only relevant if `org-todo-keywords' contains more than two
1178 to state when executed several times in direct succession. Otherwise, it
1179 switches directly to DONE from any state.
1180 See the manual for more information."
1187 "Hook which is run after the state of a TODO item was changed.
1188 The new state (a string with a TODO keyword, or nil) is available in the
1189 Lisp variable `state'."
1194 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1195 When the state of an entry is changed from nothing to TODO, remove a previous
1196 closing date.
1197 This can also be configured on a per-file basis by adding one of
1198 the following lines anywhere in the buffer:
1200 #+STARTUP: logging
1201 #+STARTUP: nologging"
1206 "Priorities in Org-mode."
1211 "The default priority of TODO items.
1212 This is the priority an item get if no explicit priority is given."
1217 "The lowest priority of TODO items. A character like ?A, ?B etc."
1222 "Options concerning time stamps and deadlines in Org-mode."
1227 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1228 When nil, these labeled time stamps are forces into the second line of an
1229 entry, just after the headline. When scheduling from the global TODO list,
1230 the time stamp will always be forced into the second line."
1235 "Formats for `format-time-string' which are used for time stamps.
1239 "Number of minutes to round time stamps to upon insertion.
1240 When zero, insert the time unmodified. Useful rounding numbers
1241 should be factors of 60, so for example 5, 10, 15.
1242 When this is not zero, you can still force an exact time-stamp by using
1243 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1248 "No. of days before expiration during which a deadline becomes active.
1249 This variable governs the display in the org file."
1254 "Non-nil means, pop up a calendar when prompting for a date.
1255 In the calendar, the date can be selected with mouse-1. However, the
1256 minibuffer will also be active, and you can simply enter the date as well.
1257 When nil, only the minibuffer will be available."
1262 "Non-nil means, make the calendar window follow timestamp changes.
1263 When a timestamp is modified and the calendar window is visible, it will be
1264 moved to the new date."
1269 "Options concerning tags in Org-mode."
1274 "List of tags allowed in Org-mode files.
1275 When this list is nil, Org-mode will base TAG input on what is already in the
1276 buffer.
1277 The value of this variable is an alist, the car may be (and should) be a
1278 character that is used to select that tag through the fast-tag-selection
1279 interface. See the manual for details."
1289 "Non-nil means, use fast tag selection scheme.
1290 This is a special interface to select and deselect tags with single keys.
1291 When nil, fast selection is never used.
1292 When the symbol `auto', fast selection is used if and only if selection
1293 characters for tags have been configured, either through the variable
1294 `org-tag-alist' or through a #+TAGS line in the buffer.
1295 When t, fast selection is always used and selection keys are assigned
1296 automatically if necessary."
1304 "The column to which tags should be indented in a headline.
1305 If this number is positive, it specifies the column. If it is negative,
1306 it means that the tags should be flushright to that column. For example,
1307 -79 works well for a normal 80 character screen."
1312 "Non-nil means, realign tags after pro/demotion of TODO state change.
1313 These operations change the length of a headline and therefore shift
1314 the tags around. With this options turned on, after each such operation
1315 the tags are again aligned to `org-tags-column'."
1320 "Non-nil means, tags in levels apply also for sublevels.
1321 When nil, only the tags directly given in a specific line apply there.
1322 If you turn off this option, you very likely want to turn on the
1323 companion option `org-tags-match-list-sublevels'."
1328 "Non-nil means list also sublevels of headlines matching tag search.
1329 Because of tag inheritance (see variable `org-use-tag-inheritance'),
1330 the sublevels of a headline matching a tag search often also match
1331 the same search. Listing all of them can create very long lists.
1332 Setting this variable to nil causes subtrees of a match to be skipped.
1333 This option is off by default, because inheritance in on. If you turn
1334 inheritance off, you very likely want to turn this option on.
1336 As a special case, if the tag search is restricted to TODO items, the
1337 value of this variable is ignored and sublevels are always checked, to
1338 make sure all corresponding TODO items find their way into the list."
1348 "Options concerning agenda display Org-mode."
1353 "Variable used by org files to set a category for agenda display.
1354 Such files should use a file variable to set it, for example
1358 or contain a special line
1360 #+CATEGORY: ELisp
1362 If the file does not specify a category, then file's base name
1367 "The files to be used for agenda display.
1371 If the value of the variable is not a list but a single file name, then
1372 the list of agenda files is actually stored and maintained in that file, one
1373 agenda file per line."
1381 "Custom commands for the agenda.
1382 These commands will be offered on the splash screen displayed by the
1385 (key type match options)
1387 key The key (a single char as a string) to be associated with the command.
1388 type The command type, any of the following symbols:
1389 todo Entries with a specific TODO keyword, in all agenda files.
1390 tags Tags match in all agenda files.
1391 tags-todo Tags match in all agenda files, TODO entries only.
1392 todo-tree Sparse tree of specific TODO keyword in *current* file.
1393 tags-tree Sparse tree with all tags matches in *current* file.
1394 occur-tree Occur sparse tree for *current* file.
1395 match What to search for:
1396 - a single keyword for TODO keyword searches
1397 - a tags match expression for tags searches
1398 - a regular expression for occur searches
1399 options A list of option setttings, similar to that in a let form, so like
1400 this: ((opt1 val1) (opt2 val2) ...)
1402 You can also define a set of commands, to create a composite agenda buffer.
1403 In this case, an entry looks like this:
1405 (key desc (cmd1 cmd2 ...) general-options)
1407 where
1409 desc A description string to be displayed in the dispatcher menu.
1410 cmd An agenda command, similar to the above. However, tree commands
1411 are no allowed, but instead you can get agenda and global todo list.
1412 So valid commands for a set are:
1413 (agenda)
1414 (alltodo)
1419 Each command can carry a list of options, and another set of options can be
1420 given for the whole set of commands. Individual command options take
1421 precedence over the general options."
1469 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
1470 When nil, the sublevels of a TODO entry are not checked, resulting in
1471 potentially much shorter TODO lists."
1477 "Non-nil means, don't show scheduled entries in the global todo list.
1478 The idea behind this is that by scheduling it, you have already taken care
1479 of this item."
1485 "Non-nil means, `org-timeline' also shows dates without an entry.
1486 When nil, only the days which actually have entries are shown.
1487 When t, all days between the first and the last date are shown.
1488 When an integer, show also empty dates, but if there is a gap of more than
1489 N days, just insert a special line indicating the size of the gap."
1497 "Set means weekly/daily agenda will always contain all TODO entries.
1498 The TODO entries will be listed at the top of the agenda, before
1499 the entries for specific days."
1504 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
1509 "The key to be installed in `calendar-mode-map' for switching to the agenda.
1510 The command `org-calendar-goto-agenda' will be bound to this key. The
1511 default is the character `c' because then `c' can be used to switch back and
1512 forth between agenda and calendar."
1517 "Options concerning setting up the Agenda window in Org Mode."
1522 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
1523 A longer mouse click will still set point. Does not wortk on XEmacs.
1524 Needs to be set before org.el is loaded."
1529 "The initial value of follwo-mode in a newly created agenda window."
1534 "Non-nil means, after creating an agenda, move cursor into Agenda window.
1535 When nil, cursor will remain in the current window."
1540 "Non-nil means, change window size of agenda to fit content."
1545 "Options concerning what to display initially in Agenda."
1550 "Non-nil means, `org-agenda' shows every day in the selected range.
1551 When nil, only the days which actually have entries are shown."
1556 "Non-nil means, start the overview always on the specified weekday.
1557 0 denotes Sunday, 1 denotes Monday etc.
1558 When nil, always start on the current day."
1564 "Number of days to include in overview display.
1565 Should be 1 or 7."
1570 "Non-nil means, show a time grid in the agenda schedule.
1571 A time grid is a set of lines for specific times (like every two hours between
1572 8:00 and 20:00). The items scheduled for a day at specific times are
1573 sorted in between these lines.
1574 For details about when the grid will be shown, and what it will look like, see
1575 the variable `org-agenda-time-grid'."
1581 "----------------"
1584 "The settings for time grid for agenda display.
1585 This is a list of three items. The first item is again a list. It contains
1586 symbols specifying conditions when the grid should be displayed:
1588 daily if the agenda shows a single day
1589 weekly if the agenda shows an entire week
1590 today show grid on current date, independent of daily/weekly display
1591 require-timed show grid only if at least one item has a time specification
1593 The second item is a string which will be places behing the grid time.
1595 The third item is a list of integers, indicating the times that should have
1596 a grid line."
1598 :type
1605 require-timed)
1607 remove-match))
1622 "Sorting structure for the agenda items of a single day.
1623 This is a list of symbols which will be used in sequence to determine
1624 if an entry should be listed before another entry. The following
1625 symbols are recognized:
1627 time-up Put entries with time-of-day indications first, early first
1628 time-down Put entries with time-of-day indications first, late first
1629 category-keep Keep the default order of categories, corresponding to the
1630 sequence in `org-agenda-files'.
1631 category-up Sort alphabetically by category, A-Z.
1632 category-down Sort alphabetically by category, Z-A.
1633 tag-up Sort alphabetically by last tag, A-Z.
1634 tag-down Sort alphabetically by last tag, Z-A.
1635 priority-up Sort numerically by priority, high priority last.
1636 priority-down Sort numerically by priority, high priority first.
1638 The different possibilities will be tried in sequence, and testing stops
1640 '(time-up category-keep priority-down)
1641 means: Pull out all entries having a specified time of day and sort them,
1642 in order to make a time schedule for the current day the first thing in the
1643 agenda listing for the day. Of the entries without a time indication, keep
1644 the grouped in categories, don't sort the categories, but keep them in
1645 the sequence given in `org-agenda-files'. Within each category sort by
1646 priority.
1648 Leaving out `category-keep' would mean that items will be sorted across
1649 categories by priority."
1662 "Non-nil means, items without time are considered late.
1663 This is only relevant for sorting. When t, items which have no explicit
1664 time like 15:30 will be considered as 99:01, i.e. later than any items which
1665 do have a time. When nil, the default time is before 0:00. You can use this
1666 option to decide if the schedule for today should come before or after timeless
1667 agenda entries."
1673 "Options concerning the entry prefix in the Org-mode agenda display."
1682 "Format specifications for the prefix of items in the agenda views.
1683 An alist with four entries, for the different agenda types. The keys to the
1684 sublists are `agenda', `timeline', `todo', and `tags'. The values
1685 are format strings.
1686 This format works similar to a printf format, with the following meaning:
1689 as given by the CATEGORY keyword or derived from the file name.
1690 %T the *last* tag of the item. Last because inherited tags come
1691 first in the list.
1692 %t the time-of-day specification if one applies to the entry, in the
1693 format HH:MM
1694 %s Scheduling/Deadline information, a short string
1696 All specifiers work basically like the standard `%s' of printf, but may
1697 contain two additional characters: A question mark just after the `%' and
1698 a whitespace/punctuation character just before the final letter.
1700 If the first character after `%' is a question mark, the entire field
1701 will only be included if the corresponding value applies to the
1702 current entry. This is useful for fields which should have fixed
1703 width when present, but zero width when absent. For example,
1705 day is specified, but will completely disappear in entries which do
1706 not contain a time.
1708 If there is punctuation or whitespace character just before the final
1709 format letter, this character will be appended to the field value if
1712 empty, no additional colon would be interted.
1715 - Indent the line with two space characters
1716 - Give the category in a 12 chars wide field, padded with whitespace on
1717 the right (because of `-'). Append a colon if there is a category
1718 (because of `:').
1719 - If there is a time-of-day, put it into a 12 chars wide field. If no
1720 time, don't put in an empty field, just skip it (because of '?').
1721 - Finally, put the scheduling information and append a whitespace.
1723 As another example, if you don't want the time-of-day of entries in
1724 the prefix, you could use:
1728 See also the variables `org-agenda-remove-times-when-in-prefix' and
1729 `org-agenda-remove-tags-when-in-prefix'."
1740 "The compiled version of the most recently used prefix format.
1744 "Non-nil means, remove duplicate time specifications in agenda items.
1745 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1746 time-of-day specification in a headline or diary entry is extracted and
1747 placed into the prefix. If this option is non-nil, the original specification
1748 \(a timestamp or -range, or just a plain time(range) specification like
1749 11:30-4pm) will be removed for agenda display. This makes the agenda less
1750 cluttered.
1751 The option can be t or nil. It may also be the symbol `beg', indicating
1752 that the time should only be removed what it is located at the beginning of
1753 the headline/diary entry."
1761 "Non-nil means, remove the tags from the headline copy in the agenda.
1762 When this is the symbol `prefix', only remove tags when
1763 `org-agenda-prefix-format' contains a `%T' specifier."
1771 "Shift tags in agenda items to this column."
1776 "Options for embedding LaTeX code into Org-mode"
1783 "Options for creating images from LaTeX fragments.
1784 This is a property list with the following properties:
1787 :scale a scaling factor for the size of the images
1788 :matchers a list indicating which matchers should be used to
1789 find LaTeX fragments. Valid members of this list are:
1799 "Options for exporting org-listings."
1804 "General options for exporting Org-mode files."
1809 "Path to the location where exported files should be located.
1810 This path may be relative to the directory where the Org-mode file lives.
1811 The default is to put them into the same directory as the Org-mode file.
1812 The variable may also be an alist with export types `:html', `:ascii',
1813 `:ical', or `:xoxo' and the corresponding directories. If a direcoty path
1814 is relative, it is interpreted relative to the directory where the exported
1815 Org-mode files lives."
1836 "Terms used in export text, translated to different languages.
1837 Use the variable `org-export-default-language' to set the language,
1838 or use the +OPTION lines for a per-file setting."
1848 "The default language of HTML export, as a string.
1849 This should have an association in `org-export-language-setup'."
1854 "The last level which is still exported as a headline.
1855 Inferior levels will produce itemize lists when exported.
1856 Note that a numeric prefix argument to an exporter function overrides
1857 this setting.
1864 "Non-nil means, add section numbers to headlines when exporting.
1871 "Non-nil means, create a table of contents in exported files.
1872 The TOC contains headlines with levels up to`org-export-headline-levels'.
1875 ASCII export, and with red color in HTML output.
1877 In HTML output, the TOC will be clickable.
1884 "Non-nil means, mark TOC lines that contain any open TODO items."
1889 "Non-nil means, preserve all line breaks when exporting.
1890 Normally, in HTML output paragraphs will be reformatted. In ASCII
1891 export, line breaks will always be preserved, regardless of this variable.
1898 "Whether subtrees with the ARCHIVE tag should be exported.
1899 This can have three different values
1900 nil Do not export, pretend this tree is not present
1901 t Do export the entire tree
1902 headline Only export the headline, but skip the tree below it."
1911 "Nil means, do not export time stamps and associated keywords."
1916 "Nil means, remove timestamps from the table of contents entries."
1921 "Nil means, do not export tags, just remove them from headlines."
1926 "Options for translating special ascii sequences for the export backends."
1931 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
1932 If the export target supports emphasizing text, the word will be
1933 typeset in bold, italic, or underlined, respectively. Works only for
1934 single words, but you can say: I *really* *mean* *this*.
1935 Not all export backends support this.
1943 When this option is turned on, you can use TeX-like syntax for sub- and
1945 considered as a single item - so grouping with {} is normally not
1946 needed. For example, the following things will be parsed as single
1947 sub- or superscripts.
1949 10^24 or 10^tau several digits will be considered 1 item.
1950 10^-12 or 10^-tau a leading sign with digits or a word
1951 x^2-y^3 will be read as x^2 - y^3, because items are
1952 terminated by almost any nonword/nondigit char.
1953 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
1955 Still, ambiguity is possible - so when in doubt use {} to enclose the
1956 sub/superscript.
1957 Not all export backends support this, but HTML does.
1964 "Non-nil means, interpret simple TeX-like macros when exporting.
1966 No only real TeX macros will work here, but the standard HTML entities
1967 for math can be used as macro names as well. For a list of supported
1968 names in HTML export, see the constant `org-html-entities'.
1969 Not all export backends support this.
1977 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
1979 the first non-white thing on a line. It will also find the math delimiters
1981 display math.
1990 This can be used to have pre-formatted text, fragments of code etc. For
1991 example:
1992 : ;; Some Lisp examples
1993 : (while (defc cnt)
1994 : (ding))
1995 will be looking just like this in also HTML. See also the QUOTE keyword.
1996 Not all export backends support this.
2003 "Number of stacked braces for sub/superscript matching.
2004 This has to be set before loading org.el to be effective."
2009 "Options for exporting tables in Org-mode."
2015 For example:
2017 | Name | Address | Birthday |
2018 |-------------+----------+-----------|
2019 | Arthur Dent | England | 29.2.2100 |
2021 Not all export backends support this.
2028 "Non-nil means, highlight the first table line.
2029 In HTML export, this means use <th> instead of <td>.
2030 In tables created with table.el, this applies to the first table line.
2031 In Org-mode tables, all lines before the first horizontal separator
2032 line will be formatted with <th> tags."
2037 "Remove special lines and marking characters in calculating tables.
2038 This removes the special marking character column from tables that are set
2039 up for spreadsheet calculations. It also removes the entire lines
2040 marked with `!', `_', or `^'. The lines with `$' are kept, because
2041 the values of constants may be useful to have."
2046 "Non-nil means, always export tables created with table.el natively.
2047 Natively means, use the HTML code generator in table.el.
2048 When nil, Org-mode's own HTML generator is used when possible (i.e. if
2049 the table does not use row- or column-spanning). This has the
2050 advantage, that the automatic HTML conversions for math symbols and
2051 sub/superscripts can be applied. Org-mode's HTML generator is also
2052 much faster."
2057 "Options specific for ASCII export of Org-mode files."
2062 "Characters for underlining headings in ASCII export.
2063 In the given sequence, these characters will be used for level 1, 2, ..."
2068 "Bullet characters for headlines converted to lists in ASCII export.
2069 The first character is is used for the first lest level generated in this
2070 way, and so on. If there are more levels than characters given here,
2071 the list will be repeated.
2072 Note that plain lists will keep the same bullets as the have in the
2073 Org-mode file."
2078 "Non-nil means, popup buffer containing the exported ASCII text.
2079 Otherwise the buffer will just be saved to a file and stay hidden."
2084 "Options specific for XML export of Org-mode files."
2089 "Options specific for HTML export of Org-mode files."
2095 html {
2096 font-family: Times, serif;
2097 font-size: 12pt;
2098 }
2099 .title { text-align: center; }
2100 .todo { color: red; }
2101 .done { color: green; }
2102 .timestamp { color: grey }
2103 .timestamp-kwd { color: CadetBlue }
2104 .tag { background-color:lightblue; font-weight:normal }
2105 .target { background-color: lavender; }
2106 pre {
2107 border: 1pt solid #AEBDCC;
2108 background-color: #F3F5F7;
2109 padding: 5pt;
2110 font-family: courier, monospace;
2111 }
2112 table { border-collapse: collapse; }
2113 td, th {
2114 vertical-align: top;
2115 border: 1pt solid #ADB9CC;
2116 }
2117 </style>"
2118 "The default style specification for exported HTML files.
2119 Since there are different ways of setting style information, this variable
2120 needs to contain the full HTML structure to provide a style, including the
2121 surrounding HTML tags. The style specifications should include definitions
2122 for new classes todo, done, title, and deadline. For example, legal values
2123 would be:
2126 p { font-weight: normal; color: gray; }
2127 h1 { color: black; }
2128 .title { text-align: center; }
2129 .todo, .deadline { color: red; }
2130 .done { color: green; }
2131 </style>
2133 or, if you want to keep the style in a file,
2137 As the value of this option simply gets inserted into the HTML <head> header,
2143 "Format for typesetting the document title in HTML export."
2148 "The <H> level for level 1 headings in HTML export."
2153 "Non-nil means, make file links to `file.org' point to `file.html'.
2154 When org-mode is exporting an org-mode file to HTML, links to
2155 non-html files are directly put into a href tag in HTML.
2156 However, links to other Org-mode files (recognized by the
2157 extension `.org.) should become links to the corresponding html
2158 file, assuming that the linked org-mode file will also be
2159 converted to HTML.
2160 When nil, the links still point to the plain `.org' file."
2165 "Non-nil means, inline images into exported HTML pages.
2166 This is done using an <img> tag. When nil, an anchor with href is used to
2167 link to the image. If this option is `maybe', then images in links with
2168 an empty description will be inlined, while images with a description will
2169 be linked only."
2176 "Non-nil means, for HTML export, treat @<...> as HTML tag.
2177 When nil, these tags will be exported as plain text and therefore
2178 not be interpreted by a browser.
2186 "The HTML tag used to start a table.
2187 This must be a <table> tag, but you may change the options like
2188 borders and spacing."
2193 "If non-nil, write `org-export-html-html-helper-timestamp'
2194 into the exported HTML text. Otherwise, the buffer will just be saved
2195 to a file."
2201 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
2206 "Non-nil means, popup buffer containing the exported html text.
2207 Otherwise, the buffer will just be saved to a file and stay hidden."
2212 "Options specific for iCalendar export of Org-mode files."
2217 "The file name for the iCalendar file covering all agenda files.
2219 The file name should be absolute."
2224 "Non-nil means, export to iCalendar files should also cover TODO items."
2229 "Calendar name for the combined iCalendar representing all agenda files."
2234 "Font-lock settings for highlighting in Org-mode."
2239 "Non-nil means fontify only the stars in each headline.
2240 When nil, the entire headline is fontified.
2241 Changing it requires restart of `font-lock-mode' to become effective
2242 also in regions already fontified."
2247 "Non-nil means, hide the first N-1 stars in a headline.
2248 This works by using the face `org-hide' for these stars. This
2249 face is white for a light background, and black for a dark
2250 background. You may have to customize the face `org-hide' to
2251 make this work.
2252 Changing it requires restart of `font-lock-mode' to become effective
2253 also in regions already fontified.
2254 You may also set this on a per-file basis by adding one of the following
2255 lines to the buffer:
2257 #+STARTUP: hidestars
2258 #+STARTUP: showstars"
2263 "Non-nil means, change the face of a headline if it is marked DONE.
2264 Normally, only the TODO/DONE keyword indicates the state of a headline.
2265 When this is non-nil, the headline after the keyword is set to the
2266 `org-headline-done' as an additional indication."
2271 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2272 Changing this variable requires a restart of Emacs to take effect."
2281 "Set variable and compute the emphasis regular expression."
2285 org-emphasis-alist org-emphasis-regexp-components)
2295 ;; make sure special characters appear at the right position in the class
2301 ;; Make the regexp
2308 body1
2316 "Components used to build the reqular expression for emphasis.
2317 This is a list with 6 entries. Terminology: In an emphasis string
2321 specify what is allowed/forbidden in each part:
2323 pre Chars allowed as prematch. Beginning of line will be allowed too.
2324 post Chars allowed as postmatch. End of line will be allowed too.
2325 border The chars *forbidden* as border characters. In addition to the
2326 characters given here, all marker characters are forbidden too.
2328 non-shy groups here, and don't allow newline here.
2329 newline The maximum number of newlines allowed in an emphasis exp.
2330 stacked Non-nil means, allow stacked styles. This works only in HTML
2331 export. When this is set, all marker characters (as given in
2332 `org-emphasis-alist') will be allowed as pre/post, aiding
2333 inside-out matching.
2334 Use customize to modify this, or restart emacs after changing it."
2351 )
2352 "Special syntax for emphasised text.
2353 Text starting and ending with a special character will be emphasized, for
2354 example *bold*, _underlined_ and /italic/. This variable sets the marker
2355 characters, the face to bbe used by font-lock for highlighting in Org-mode
2356 emacs buffers, and the HTML tags to be used for this.
2357 Use customize to modify this, or restart emacs after changing it."
2370 "Faces in Org-mode."
2375 "Make a compatible face specification.
2376 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
2377 For them we convert a (min-colors 8) entry to a `tty' entry and move it
2378 to the top of the list. The `min-colors' attribute will be removed from
2379 any other entries, and any resulting duplicates will be removed entirely."
2393 specs))
2398 "Face used to hide leading stars in headlines.
2399 The forground color of this face should be equal to the background
2400 color of the frame."
2411 "Face used for level 1 headlines."
2421 "Face used for level 2 headlines."
2433 "Face used for level 3 headlines."
2445 "Face used for level 4 headlines."
2453 "Face used for level 5 headlines."
2461 "Face used for level 6 headlines."
2469 "Face used for level 7 headlines."
2477 "Face used for level 8 headlines."
2485 "Face used for special keywords."
2495 "Face for deadlines and TODO keywords."
2503 "Face used to indicate that a headline is DONE.
2504 This face is only used if `org-fontify-done-headline' is set."
2517 "Face for headline with the ARCHIVE tag."
2524 "Face for links."
2531 "Face for links."
2536 "Face for tags."
2546 "Face for TODO keywords."
2555 "Face used for DONE."
2566 "Face used for tables."
2576 "Face for formulas."
2585 "Face for items scheduled for a certain day."
2595 "Face for items scheduled previously, and not yet done."
2605 "Face for items scheduled previously, and not yet done."
2613 "Face used for time grids."
2618 org-level-5 org-level-6 org-level-7 org-level-8
2619 ))
2623 ;; Variables for pre-computed regular expressions, all buffer local
2637 "Matches a headline and puts TODO state into group 2 if present.
2682 mouse-map t)
2689 s)
2694 s)
2697 "Make VAR local in current buffer and set it to VALUE."
2701 "Check if the current buffer is in Org-mode."
2730 "Precompute regular expressions for current buffer."
2736 kwds int key value cat arch tags)
2761 l var val)
2770 )))
2784 tgs))
2792 ;; Compute the regular expressions and other local variables
2797 org-done-string
2799 org-todo-regexp
2802 org-not-done-regexp
2808 org-todo-line-regexp
2812 org-nl-done-regexp
2814 org-todo-line-tags-regexp
2820 org-deadline-time-regexp
2822 org-deadline-line-regexp
2824 org-scheduled-regexp
2826 org-scheduled-time-regexp
2828 org-closed-time-regexp
2830 org-keyword-time-regexp
2836 org-maybe-keyword-time-regexp
2845 ;; Tell the compiler about dynamically scoped variables,
2846 ;; and variables from other packages
2898 ;;; Define the mode
2902 (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.")
2910 ;; We use a before-change function to check if a table might need
2911 ;; an update.
2913 "Indicates that a table might need an update.
2914 This variable is set by `org-before-change-function'.
2921 ;;;###autoload
2923 "Outline-based notes management and organizer, alias
2926 Org-mode develops organizational tasks around a NOTES file which
2927 contains information about projects as plain text. Org-mode is
2928 implemented on top of outline-mode, which is ideal to keep the content
2929 of large files well structured. It supports ToDo items, deadlines and
2930 time stamps, which magically appear in the diary listing of the Emacs
2931 calendar. Tables are easily created with a built-in table editor.
2932 Plain text URL-like links connect to websites, emails (VM), Usenet
2933 messages (Gnus), BBDB entries, and any files related to the project.
2934 For printing and sharing of notes, an Org-mode file (or a part of it)
2935 can be exported as a structured ASCII or HTML file.
2937 The following commands are available:
2941 ;; Get rid of Outline menus, they are not needed
2942 ;; Need to do this here because define-derived-mode sets up
2943 ;; the keymap so late.
2946 ;; Assume this is Greg's port, it used easymenu
2962 ;;(setq outline-regexp "\\(?:\\*+\\|[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\) \\)")
2971 ;; Calc embedded
2977 ;; Activate before-change-function
2981 ;; Check for running clock before killing a buffer
2983 ;; Paragraphs and auto-filling
3007 "Call COMMAND interactively, but pretend prefix are was ARG."
3014 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
3024 "Add text properties to entire string, from beginning to end.
3025 PLIST may be a list of properties, PROPS are individual properties and values
3026 that will be added to PLIST. Returns the string that was modified."
3029 string)
3033 ;;; Font-Lock stuff
3038 (define-key org-mouse-map
3039 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
3040 (when org-mouse-1-follows-link
3041 (define-key org-mouse-map [follow-link] 'mouse-face))
3042 (when org-tab-follows-link
3043 (define-key org-mouse-map [(tab)] 'org-open-at-point)
3044 (define-key org-mouse-map "\C-i" 'org-open-at-point))
3045 (when org-return-follows-link
3046 (define-key org-mouse-map [(return)] 'org-open-at-point)
3047 (define-key org-mouse-map "\C-m" 'org-open-at-point))
3049 (require 'font-lock)
3052 (defconst org-link-types '("https?" "ftp" "mailto" "file" "news" "bbdb" "vm"
3053 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp"))
3054 (defconst org-link-re-with-space
3055 (concat
3058 "[^" org-non-link-chars "]*"
3060 "Matches a link with spaces, optional angular brackets around it.")
3062 (defconst org-link-re-with-space2
3063 (concat
3068 "Matches a link with spaces, optional angular brackets around it.")
3070 (defconst org-angle-link-re
3071 (concat
3074 "[^" org-non-link-chars "]*"
3076 "Matches link with angular brackets, spaces are allowed.")
3077 (defconst org-plain-link-re
3078 (concat
3081 "Matches plain link, without spaces.")
3083 (defconst org-bracket-link-regexp
3085 "Matches a link in double brackets.")
3087 (defconst org-bracket-link-analytic-regexp
3088 (concat
3095 ; 1: http:
3096 ; 2: http
3097 ; 3: path
3098 ; 4: [desc]
3099 ; 5: desc
3102 (defconst org-ts-lengths
3103 (cons (length (format-time-string (car org-time-stamp-formats)))
3104 (length (format-time-string (cdr org-time-stamp-formats))))
3105 "This holds the lengths of the two different time formats.")
3107 "Regular expression for fast time stamp matching.")
3109 "Regular expression for fast time stamp matching.")
3110 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
3111 "Regular expression matching time strings for analysis.")
3112 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 ">")
3113 "Regular expression matching time stamps, with groups.")
3114 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[]>]")
3115 "Regular expression matching time stamps (also [..]), with groups.")
3116 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
3117 "Regular expression matching a time stamp range.")
3120 "Regular expression matching a time stamp or time stamp range.")
3122 (defvar org-�§emph-face nil)
3124 (defun org-do-emphasis-faces (limit)
3125 "Run through the buffer and add overlays to links."
3126 (if (re-search-forward org-emph-re limit t)
3127 (progn
3128 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
3129 'face
3130 (nth 1 (assoc (match-string 3)
3131 org-emphasis-alist)))
3132 (add-text-properties (match-beginning 2) (match-end 2)
3133 '(font-lock-multiline t))
3134 (backward-char 1)
3135 t)))
3137 (defun org-activate-plain-links (limit)
3138 "Run through the buffer and add overlays to links."
3139 (if (re-search-forward org-plain-link-re limit t)
3140 (progn
3141 (add-text-properties (match-beginning 0) (match-end 0)
3142 (list 'mouse-face 'highlight
3143 'keymap org-mouse-map
3144 ))
3145 t)))
3147 (defun org-activate-angle-links (limit)
3148 "Run through the buffer and add overlays to links."
3149 (if (re-search-forward org-angle-link-re limit t)
3150 (progn
3151 (add-text-properties (match-beginning 0) (match-end 0)
3152 (list 'mouse-face 'highlight
3153 'keymap org-mouse-map
3154 ))
3155 t)))
3157 (defun org-activate-bracket-links (limit)
3158 "Run through the buffer and add overlays to bracketed links."
3159 (if (re-search-forward org-bracket-link-regexp limit t)
3160 (let* ((help (concat "LINK: "
3161 (org-match-string-no-properties 1)))
3162 ;; FIXME: above we should remove the escapes.
3163 ;; but that requires another match, protecting match data,
3164 ;; a lot of overhead for font-lock.
3165 (ip (list 'invisible 'org-link 'intangible t 'rear-nonsticky t
3166 'keymap org-mouse-map 'mouse-face 'highlight
3167 'help-echo help))
3168 (vp (list 'rear-nonsticky t
3169 'keymap org-mouse-map 'mouse-face 'highlight
3170 'help-echo help)))
3171 ;; We need to remove the invisible property here. Table narrowing
3172 ;; may have made some of this invisible.
3173 (remove-text-properties (match-beginning 0) (match-end 0)
3174 '(invisible nil))
3175 (if (match-end 3)
3176 (progn
3177 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
3178 (add-text-properties (match-beginning 3) (match-end 3) vp)
3179 (add-text-properties (match-end 3) (match-end 0) ip))
3180 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
3181 (add-text-properties (match-beginning 1) (match-end 1) vp)
3182 (add-text-properties (match-end 1) (match-end 0) ip))
3183 t)))
3185 (defun org-activate-dates (limit)
3186 "Run through the buffer and add overlays to dates."
3187 (if (re-search-forward org-tsr-regexp limit t)
3188 (progn
3189 (add-text-properties (match-beginning 0) (match-end 0)
3190 (list 'mouse-face 'highlight
3191 'keymap org-mouse-map))
3192 t)))
3194 (defvar org-target-link-regexp nil
3195 "Regular expression matching radio targets in plain text.")
3197 "Regular expression matching a link target.")
3199 "Regular expression matching a link target.")
3201 (defun org-activate-target-links (limit)
3202 "Run through the buffer and add overlays to target matches."
3203 (when org-target-link-regexp
3204 (let ((case-fold-search t))
3205 (if (re-search-forward org-target-link-regexp limit t)
3206 (progn
3207 (add-text-properties (match-beginning 0) (match-end 0)
3208 (list 'mouse-face 'highlight
3209 'keymap org-mouse-map
3210 'help-echo "Radio target link"
3211 'org-linked-text t))
3212 t)))))
3214 (defun org-update-radio-target-regexp ()
3215 "Find all radio targets in this file and update the regular expression."
3216 (interactive)
3217 (when (memq 'radio org-activate-links)
3218 (setq org-target-link-regexp
3219 (org-make-target-link-regexp (org-all-targets 'radio)))
3220 (org-restart-font-lock)))
3222 (defun org-hide-wide-columns (limit)
3223 (let (s e)
3224 (setq s (text-property-any (point) (or limit (point-max))
3225 'org-cwidth t))
3226 (when s
3227 (setq e (next-single-property-change s 'org-cwidth))
3228 (add-text-properties s e '(invisible org-cwidth intangible t))
3229 (goto-char e)
3230 t)))
3232 (defun org-restart-font-lock ()
3233 "Restart font-lock-mode, to force refontification."
3234 (when (and (boundp 'font-lock-mode) font-lock-mode)
3235 (font-lock-mode -1)
3236 (font-lock-mode 1)))
3238 (defun org-all-targets (&optional radio)
3239 "Return a list of all targets in this file.
3240 With optional argument RADIO, only find radio targets."
3241 (let ((re (if radio org-radio-target-regexp org-target-regexp))
3242 rtn)
3243 (save-excursion
3244 (goto-char (point-min))
3245 (while (re-search-forward re nil t)
3246 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
3247 rtn)))
3249 (defun org-make-target-link-regexp (targets)
3250 "Make regular expression matching all strings in TARGETS.
3251 The regular expression finds the targets also if there is a line break
3252 between words."
3253 (and targets
3254 (concat
3256 (mapconcat
3257 (lambda (x)
3258 (while (string-match " +" x)
3260 x)
3261 targets
3266 "Matches CamelCase words, possibly with a star before it.")
3268 (defun org-activate-camels (limit)
3269 "Run through the buffer and add overlays to dates."
3270 (if (re-search-forward org-camel-regexp limit t)
3271 (progn
3272 (add-text-properties (match-beginning 0) (match-end 0)
3273 (list 'mouse-face 'highlight
3274 'keymap org-mouse-map))
3275 t)))
3277 (defun org-activate-tags (limit)
3279 (progn
3280 (add-text-properties (match-beginning 1) (match-end 1)
3281 (list 'mouse-face 'highlight
3282 'keymap org-mouse-map))
3283 t)))
3285 (defun org-font-lock-level ()
3286 (save-excursion
3287 (org-back-to-heading t)
3288 (- (match-end 0) (match-beginning 0))))
3290 (defun org-outline-level ()
3291 (save-excursion
3292 (looking-at outline-regexp)
3293 (if (match-beginning 1)
3294 (+ (org-get-string-indentation (match-string 1)) 1000)
3295 (- (match-end 0) (match-beginning 0)))))
3297 (defvar org-font-lock-keywords nil)
3299 (defun org-set-font-lock-defaults ()
3300 (let* ((em org-fontify-emphasized-text)
3301 (lk org-activate-links)
3302 (org-font-lock-extra-keywords
3303 ;; Headlines
3304 (list
3306 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
3308 (1 'org-table))
3309 ;; Links
3310 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
3311 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
3312 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
3313 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
3314 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
3315 (if (memq 'camel lk) '(org-activate-camels (0 'org-link t)))
3316 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
3317 (if org-table-limit-column-width
3318 '(org-hide-wide-columns (0 nil append)))
3319 ;; TODO lines
3321 '(1 'org-todo t))
3322 ;; Priorities
3324 ;; Special keywords
3329 ;; Emphasis
3330 (if em '(org-do-emphasis-faces))
3331 ;; Checkboxes, similar to Frank Ruell's org-checklet.el
3333 2 'bold prepend)
3334 (if org-provide-checkbox-statistics
3336 (0 (org-get-checkbox-statistics-face) t)))
3337 ;; COMMENT
3340 '(1 'org-special-keyword t))
3341 '("^#.*" (0 'font-lock-comment-face t))
3342 ;; DONE
3343 (if org-fontify-done-headline
3345 '(1 'org-done t) '(2 'org-headline-done t))
3347 '(1 'org-done t)))
3348 ;; Table stuff
3352 (if org-format-transports-properties-p
3355 )))
3356 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
3357 ;; Now set the full font-lock-keywords
3358 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
3359 (org-set-local 'font-lock-defaults
3360 '(org-font-lock-keywords t nil nil backward-paragraph))
3361 (kill-local-variable 'font-lock-keywords) nil))
3363 (defvar org-m nil)
3364 (defvar org-l nil)
3365 (defvar org-f nil)
3366 (defun org-get-level-face (n)
3367 "Get the right face for match N in font-lock matching of healdines."
3368 (setq org-l (- (match-end 2) (match-beginning 1)))
3369 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
3370 ; (setq org-f (nth (1- (% org-l org-n-levels)) org-level-faces))
3371 (setq org-f (nth (% (1- org-l) org-n-levels) org-level-faces))
3372 (cond
3373 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
3374 ((eq n 2) org-f)
3375 (t (if org-level-color-stars-only nil org-f))))
3377 (defun org-unfontify-region (beg end &optional maybe_loudly)
3378 "Remove fontification and activation overlays from links."
3379 (font-lock-default-unfontify-region beg end)
3380 (let* ((buffer-undo-list t)
3381 (inhibit-read-only t) (inhibit-point-motion-hooks t)
3382 (inhibit-modification-hooks t)
3383 deactivate-mark buffer-file-name buffer-file-truename)
3384 (remove-text-properties beg end
3385 '(mouse-face nil keymap nil org-linked-text nil
3386 invisible nil intangible nil))))
3387 ;;; Visibility cycling
3389 (defvar org-cycle-global-status nil)
3390 (make-variable-buffer-local 'org-cycle-global-status)
3391 (defvar org-cycle-subtree-status nil)
3392 (make-variable-buffer-local 'org-cycle-subtree-status)
3394 ;;;###autoload
3395 (defun org-cycle (&optional arg)
3396 "Visibility cycling for Org-mode.
3398 - When this function is called with a prefix argument, rotate the entire
3399 buffer through 3 states (global cycling)
3400 1. OVERVIEW: Show only top-level headlines.
3401 2. CONTENTS: Show all headlines of all levels, but no body text.
3402 3. SHOW ALL: Show everything.
3404 - When point is at the beginning of a headline, rotate the subtree started
3405 by this line through 3 different states (local cycling)
3406 1. FOLDED: Only the main headline is shown.
3407 2. CHILDREN: The main headline and the direct children are shown.
3408 From this state, you can move to one of the children
3409 and zoom in further.
3410 3. SUBTREE: Show the entire subtree, including body text.
3412 - When there is a numeric prefix, go up to a heading with level ARG, do
3413 a `show-subtree' and return to the previous cursor position. If ARG
3414 is negative, go up that many levels.
3416 - When point is not at the beginning of a headline, execute
3417 `indent-relative', like TAB normally does. See the option
3418 `org-cycle-emulate-tab' for details.
3420 - Special case: if point is the the beginning of the buffer and there is
3421 no headline in line 1, this function will act as if called with prefix arg."
3422 (interactive "P")
3423 (let* ((outline-regexp
3424 (if org-cycle-include-plain-lists
3426 outline-regexp))
3427 (bob-special (and org-cycle-global-at-bob (bobp)
3428 (not (looking-at outline-regexp))))
3429 (org-cycle-hook
3430 (if bob-special
3431 (delq 'org-optimize-window-after-visibility-change
3432 (copy-sequence org-cycle-hook))
3433 org-cycle-hook))
3434 (pos (point)))
3436 (if (or bob-special (equal arg '(4)))
3437 ;; special case: use global cycling
3438 (setq arg t))
3440 (cond
3442 ((org-at-table-p 'any)
3443 ;; Enter the table or move to the next field in the table
3444 (or (org-table-recognize-table.el)
3445 (progn
3446 (if arg (org-table-edit-field t)
3447 (org-table-justify-field-maybe)
3448 (call-interactively 'org-table-next-field)))))
3450 ((eq arg t) ;; Global cycling
3452 (cond
3453 ((and (eq last-command this-command)
3454 (eq org-cycle-global-status 'overview))
3455 ;; We just created the overview - now do table of contents
3456 ;; This can be slow in very large buffers, so indicate action
3457 (message "CONTENTS...")
3458 (org-content)
3459 (message "CONTENTS...done")
3460 (setq org-cycle-global-status 'contents)
3461 (run-hook-with-args 'org-cycle-hook 'contents))
3463 ((and (eq last-command this-command)
3464 (eq org-cycle-global-status 'contents))
3465 ;; We just showed the table of contents - now show everything
3466 (show-all)
3467 (message "SHOW ALL")
3468 (setq org-cycle-global-status 'all)
3469 (run-hook-with-args 'org-cycle-hook 'all))
3471 (t
3472 ;; Default action: go to overview
3473 (org-overview)
3474 (message "OVERVIEW")
3475 (setq org-cycle-global-status 'overview)
3476 (run-hook-with-args 'org-cycle-hook 'overview))))
3478 ((integerp arg)
3479 ;; Show-subtree, ARG levels up from here.
3480 (save-excursion
3481 (org-back-to-heading)
3482 (outline-up-heading (if (< arg 0) (- arg)
3483 (- (funcall outline-level) arg)))
3484 (org-show-subtree)))
3486 ((save-excursion (beginning-of-line 1) (looking-at outline-regexp))
3487 ;; At a heading: rotate between three different views
3488 (org-back-to-heading)
3489 (let ((goal-column 0) eoh eol eos)
3490 ;; First, some boundaries
3491 (save-excursion
3492 (org-back-to-heading)
3493 (save-excursion
3494 (beginning-of-line 2)
3495 (while (and (not (eobp)) ;; this is like `next-line'
3496 (get-char-property (1- (point)) 'invisible))
3497 (beginning-of-line 2)) (setq eol (point)))
3498 (outline-end-of-heading) (setq eoh (point))
3499 (org-end-of-subtree t) (setq eos (point))
3500 (outline-next-heading))
3501 ;; Find out what to do next and set `this-command'
3502 (cond
3503 ((and (= eos eoh)
3504 ;; Nothing is hidden behind this heading
3505 (message "EMPTY ENTRY")
3506 (setq org-cycle-subtree-status nil)))
3507 ((>= eol eos)
3508 ;; Entire subtree is hidden in one line: open it
3509 (org-show-entry)
3510 (show-children)
3511 (message "CHILDREN")
3512 (setq org-cycle-subtree-status 'children)
3513 (run-hook-with-args 'org-cycle-hook 'children))
3514 ((and (eq last-command this-command)
3515 (eq org-cycle-subtree-status 'children))
3516 ;; We just showed the children, now show everything.
3517 (org-show-subtree)
3518 (message "SUBTREE")
3519 (setq org-cycle-subtree-status 'subtree)
3520 (run-hook-with-args 'org-cycle-hook 'subtree))
3521 (t
3522 ;; Default action: hide the subtree.
3523 (hide-subtree)
3524 (message "FOLDED")
3525 (setq org-cycle-subtree-status 'folded)
3526 (run-hook-with-args 'org-cycle-hook 'folded)))))
3528 ;; TAB emulation
3529 (buffer-read-only (org-back-to-heading))
3531 ((org-try-cdlatex-tab))
3533 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
3535 (or (and (eq org-cycle-emulate-tab 'white)
3536 (= (match-end 0) (point-at-eol)))
3537 (and (eq org-cycle-emulate-tab 'whitestart)
3538 (>= (match-end 0) pos))))
3539 t
3540 (eq org-cycle-emulate-tab t))
3543 (point-at-bol) (point))))
3544 (progn
3545 (beginning-of-line 1)
3547 (indent-relative))
3549 (t (save-excursion
3550 (org-back-to-heading)
3551 (org-cycle))))))
3553 ;;;###autoload
3554 (defun org-global-cycle (&optional arg)
3555 "Cycle the global visibility. For details see `org-cycle'."
3556 (interactive "P")
3557 (if (integerp arg)
3558 (progn
3559 (show-all)
3560 (hide-sublevels arg)
3561 (setq org-cycle-global-status 'contents))
3562 (org-cycle '(4))))
3564 (defun org-overview ()
3565 "Switch to overview mode, shoing only top-level headlines.
3566 Really, this shows all headlines with level equal or greater than the level
3567 of the first headline in the buffer. This is important, because if the
3568 first headline is not level one, then (hide-sublevels 1) gives confusing
3569 results."
3570 (interactive)
3571 (hide-sublevels (save-excursion
3572 (goto-char (point-min))
3573 (if (re-search-forward (concat "^" outline-regexp) nil t)
3574 (progn
3575 (goto-char (match-beginning 0))
3576 (funcall outline-level))
3577 1))))
3579 ;; FIXME: allow an argument to give a limiting level for this.
3580 (defun org-content ()
3581 "Show all headlines in the buffer, like a table of contents"
3582 (interactive)
3583 (save-excursion
3584 ;; Visit all headings and show their offspring
3585 (goto-char (point-max))
3586 (catch 'exit
3587 (while (and (progn (condition-case nil
3588 (outline-previous-visible-heading 1)
3589 (error (goto-char (point-min))))
3590 t)
3591 (looking-at outline-regexp))
3592 (show-branches)
3593 (if (bobp) (throw 'exit nil))))))
3596 (defun org-optimize-window-after-visibility-change (state)
3597 "Adjust the window after a change in outline visibility.
3598 This function is the default value of the hook `org-cycle-hook'."
3599 (when (get-buffer-window (current-buffer))
3600 (cond
3601 ((eq state 'overview) (org-first-headline-recenter 1))
3602 ((eq state 'content) nil)
3603 ((eq state 'all) nil)
3604 ((eq state 'folded) nil)
3605 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
3606 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
3608 (defun org-subtree-end-visible-p ()
3609 "Is the end of the current subtree visible?"
3610 (pos-visible-in-window-p
3611 (save-excursion (org-end-of-subtree t) (point))))
3613 (defun org-first-headline-recenter (&optional N)
3614 "Move cursor to the first headline and recenter the headline.
3615 Optional argument N means, put the headline into the Nth line of the window."
3616 (goto-char (point-min))
3618 (beginning-of-line)
3619 (recenter (prefix-numeric-value N))))
3621 (defvar org-goto-window-configuration nil)
3622 (defvar org-goto-marker nil)
3623 (defvar org-goto-map (make-sparse-keymap))
3624 (let ((cmds '(isearch-forward isearch-backward)) cmd)
3625 (while (setq cmd (pop cmds))
3626 (substitute-key-definition cmd cmd org-goto-map global-map)))
3627 (define-key org-goto-map "\C-m" 'org-goto-ret)
3628 (define-key org-goto-map [(left)] 'org-goto-left)
3629 (define-key org-goto-map [(right)] 'org-goto-right)
3630 (define-key org-goto-map [(?q)] 'org-goto-quit)
3631 (define-key org-goto-map [(control ?g)] 'org-goto-quit)
3632 (define-key org-goto-map "\C-i" 'org-cycle)
3633 (define-key org-goto-map [(tab)] 'org-cycle)
3634 (define-key org-goto-map [(down)] 'outline-next-visible-heading)
3635 (define-key org-goto-map [(up)] 'outline-previous-visible-heading)
3636 (define-key org-goto-map "n" 'outline-next-visible-heading)
3637 (define-key org-goto-map "p" 'outline-previous-visible-heading)
3638 (define-key org-goto-map "f" 'outline-forward-same-level)
3639 (define-key org-goto-map "b" 'outline-backward-same-level)
3640 (define-key org-goto-map "u" 'outline-up-heading)
3641 (define-key org-goto-map "\C-c\C-n" 'outline-next-visible-heading)
3642 (define-key org-goto-map "\C-c\C-p" 'outline-previous-visible-heading)
3643 (define-key org-goto-map "\C-c\C-f" 'outline-forward-same-level)
3644 (define-key org-goto-map "\C-c\C-b" 'outline-backward-same-level)
3645 (define-key org-goto-map "\C-c\C-u" 'outline-up-heading)
3646 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
3647 (while l (define-key org-goto-map (int-to-string (pop l)) 'digit-argument)))
3649 (defconst org-goto-help
3650 "Select a location to jump to, press RET
3651 \[Up]/[Down]=next/prev headline TAB=cycle visibility RET=select [Q]uit")
3653 (defun org-goto ()
3654 "Go to a different location of the document, keeping current visibility.
3656 When you want to go to a different location in a document, the fastest way
3657 is often to fold the entire buffer and then dive into the tree. This
3658 method has the disadvantage, that the previous location will be folded,
3659 which may not be what you want.
3661 This command works around this by showing a copy of the current buffer in
3662 overview mode. You can dive into the tree in that copy, to find the
3663 location you want to reach. When pressing RET, the command returns to the
3664 original buffer in which the visibility is still unchanged. It then jumps
3665 to the new location, making it and the headline hierarchy above it visible."
3666 (interactive)
3667 (let* ((org-goto-start-pos (point))
3668 (selected-point
3669 (org-get-location (current-buffer) org-goto-help)))
3670 (if selected-point
3671 (progn
3672 (org-mark-ring-push org-goto-start-pos)
3673 (goto-char selected-point)
3674 (if (or (org-invisible-p) (org-invisible-p2))
3675 (org-show-hierarchy-above)))
3676 (error "Quit"))))
3678 (defun org-get-location (buf help)
3679 "Let the user select a location in the Org-mode buffer BUF.
3680 This function uses a recursive edit. It returns the selected position
3681 or nil."
3682 (let (org-selected-point)
3683 (save-excursion
3684 (save-window-excursion
3685 (delete-other-windows)
3686 (switch-to-buffer (get-buffer-create "*org-goto*"))
3687 (with-output-to-temp-buffer "*Help*"
3688 (princ help))
3689 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
3690 (setq buffer-read-only nil)
3691 (erase-buffer)
3692 (insert-buffer-substring buf)
3693 (let ((org-startup-truncated t)
3694 (org-startup-folded t)
3695 (org-startup-align-all-tables nil)
3696 (org-startup-with-deadline-check nil))
3697 (org-mode))
3698 (setq buffer-read-only t)
3699 (if (boundp 'org-goto-start-pos)
3700 (goto-char org-goto-start-pos)
3701 (goto-char (point-min)))
3702 (org-beginning-of-line)
3703 (message "Select location and press RET")
3704 ;; now we make sure that during selection, ony very few keys work
3705 ;; and that it is impossible to switch to another window.
3706 (let ((gm (current-global-map))
3707 (overriding-local-map org-goto-map))
3708 (unwind-protect
3709 (progn
3710 (use-global-map org-goto-map)
3711 (recursive-edit))
3712 (use-global-map gm)))))
3713 (kill-buffer "*org-goto*")
3714 org-selected-point))
3716 (defun org-goto-ret (&optional arg)
3717 "Finish `org-goto' by going to the new location."
3718 (interactive "P")
3719 (setq org-selected-point (point)
3720 current-prefix-arg arg)
3721 (throw 'exit nil))
3723 (defun org-goto-left ()
3724 "Finish `org-goto' by going to the new location."
3725 (interactive)
3726 (if (org-on-heading-p)
3727 (progn
3728 (beginning-of-line 1)
3729 (setq org-selected-point (point)
3730 current-prefix-arg (- (match-end 0) (match-beginning 0)))
3731 (throw 'exit nil))
3732 (error "Not on a heading")))
3734 (defun org-goto-right ()
3735 "Finish `org-goto' by going to the new location."
3736 (interactive)
3737 (if (org-on-heading-p)
3738 (progn
3739 (outline-end-of-subtree)
3740 (or (eobp) (forward-char 1))
3741 (setq org-selected-point (point)
3742 current-prefix-arg (- (match-end 0) (match-beginning 0)))
3743 (throw 'exit nil))
3744 (error "Not on a heading")))
3746 (defun org-goto-quit ()
3747 "Finish `org-goto' without cursor motion."
3748 (interactive)
3749 (setq org-selected-point nil)
3750 (throw 'exit nil))
3752 ;;; Promotion, Demotion, Inserting new headlines
3754 (defvar org-ignore-region nil
3755 "To temporarily disable the active region.")
3757 (defun org-insert-heading (&optional force-heading)
3758 "Insert a new heading or item with same depth at point.
3759 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
3760 If point is at the beginning of a headline, insert a sibling before the
3761 current headline. If point is in the middle of a headline, split the headline
3762 at that position and make the rest of the headline part of the sibling below
3763 the current headline."
3764 (interactive "P")
3765 (if (= (buffer-size) 0)
3767 (when (or force-heading (not (org-insert-item)))
3768 (let* ((head (save-excursion
3769 (condition-case nil
3770 (progn
3771 (org-back-to-heading)
3772 (match-string 0))
3773 (error "*"))))
3774 pos)
3775 (cond
3776 ((and (org-on-heading-p) (bolp)
3777 (save-excursion (backward-char 1) (not (org-invisible-p))))
3778 (open-line 1))
3779 ((and (bolp) (save-excursion
3780 (backward-char 1) (not (org-invisible-p))))
3781 nil)
3782 (t (newline)))
3783 (insert head) (just-one-space)
3784 (setq pos (point))
3785 (end-of-line 1)
3786 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
3787 (run-hooks 'org-insert-heading-hook)))))
3789 (defun org-in-item-p ()
3790 "It the cursor inside a plain list item.
3791 Does not have to be the first line."
3792 (save-excursion
3793 (condition-case nil
3794 (progn
3795 (org-beginning-of-item)
3796 (org-at-item-p)
3797 t)
3798 (error nil))))
3800 (defun org-insert-item (&optional checkbox)
3801 "Insert a new item at the current level.
3802 Return t when things worked, nil when we are not in an item."
3803 (when (save-excursion
3804 (condition-case nil
3805 (progn
3806 (org-beginning-of-item)
3807 (org-at-item-p)
3808 t)
3809 (error nil)))
3810 (let* ((bul (match-string 0))
3812 (match-end 0)))
3813 pos)
3814 (cond
3815 ((and (org-at-item-p) (<= (point) eow))
3816 ;; before the bullet
3817 (beginning-of-line 1)
3818 (open-line 1))
3819 ((<= (point) eow)
3820 (beginning-of-line 1))
3821 (t (newline)))
3822 (insert bul (if checkbox "[ ]" ""))
3823 (just-one-space)
3824 (setq pos (point))
3825 (end-of-line 1)
3826 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
3827 (org-maybe-renumber-ordered-list)
3828 (and checkbox (org-update-checkbox-count-maybe))
3829 t))
3831 (defun org-insert-todo-heading (arg)
3832 "Insert a new heading with the same level and TODO state as current heading.
3833 If the heading has no TODO state, or if the state is DONE, use the first
3834 state (TODO by default). Also with prefix arg, force first state."
3835 (interactive "P")
3836 (when (not (org-insert-item 'checkbox))
3837 (org-insert-heading)
3838 (save-excursion
3839 (org-back-to-heading)
3840 (outline-previous-heading)
3841 (looking-at org-todo-line-regexp))
3842 (if (or arg
3843 (not (match-beginning 2))
3844 (equal (match-string 2) org-done-string))
3845 (insert (car org-todo-keywords) " ")
3846 (insert (match-string 2) " "))))
3848 (defun org-promote-subtree ()
3849 "Promote the entire subtree.
3850 See also `org-promote'."
3851 (interactive)
3852 (save-excursion
3853 (org-map-tree 'org-promote))
3854 (org-fix-position-after-promote))
3856 (defun org-demote-subtree ()
3857 "Demote the entire subtree. See `org-demote'.
3858 See also `org-promote'."
3859 (interactive)
3860 (save-excursion
3861 (org-map-tree 'org-demote))
3862 (org-fix-position-after-promote))
3865 (defun org-do-promote ()
3866 "Promote the current heading higher up the tree.
3867 If the region is active in `transient-mark-mode', promote all headings
3868 in the region."
3869 (interactive)
3870 (save-excursion
3871 (if (org-region-active-p)
3872 (org-map-region 'org-promote (region-beginning) (region-end))
3873 (org-promote)))
3874 (org-fix-position-after-promote))
3876 (defun org-do-demote ()
3877 "Demote the current heading lower down the tree.
3878 If the region is active in `transient-mark-mode', demote all headings
3879 in the region."
3880 (interactive)
3881 (save-excursion
3882 (if (org-region-active-p)
3883 (org-map-region 'org-demote (region-beginning) (region-end))
3884 (org-demote)))
3885 (org-fix-position-after-promote))
3887 (defun org-fix-position-after-promote ()
3888 "Make sure that after pro/demotion cursor position is right."
3890 (save-excursion
3891 (skip-chars-backward "a-zA-Z0-9_@")
3892 (looking-at org-todo-regexp)))
3893 (insert " "))
3894 (and (equal (char-after) ?\ )
3895 (equal (char-before) ?*)
3896 (forward-char 1)))
3898 (defun org-get-legal-level (level change)
3899 "Rectify a level change under the influence of `org-odd-levels-only'
3900 LEVEL is a current level, CHANGE is by how much the level should be
3901 modified. Even if CHANGE is nil, LEVEL may be returned modified because
3902 even level numbers will become the next higher odd number."
3903 (if org-odd-levels-only
3904 (cond ((not change) (1+ (* 2 (/ level 2))))
3905 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
3906 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
3907 (max 1 (+ level change))))
3909 (defun org-promote ()
3910 "Promote the current heading higher up the tree.
3911 If the region is active in `transient-mark-mode', promote all headings
3912 in the region."
3913 (org-back-to-heading t)
3914 (let* ((level (save-match-data (funcall outline-level)))
3915 (up-head (make-string (org-get-legal-level level -1) ?*))
3916 (diff (abs (- level (length up-head)))))
3917 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover"))
3918 (replace-match up-head nil t)
3919 ;; Fixup tag positioning
3920 (and org-auto-align-tags (org-set-tags nil t))
3921 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
3923 (defun org-demote ()
3924 "Demote the current heading lower down the tree.
3925 If the region is active in `transient-mark-mode', demote all headings
3926 in the region."
3927 (org-back-to-heading t)
3928 (let* ((level (save-match-data (funcall outline-level)))
3929 (down-head (make-string (org-get-legal-level level 1) ?*))
3930 (diff (abs (- level (length down-head)))))
3931 (replace-match down-head nil t)
3932 ;; Fixup tag positioning
3933 (and org-auto-align-tags (org-set-tags nil t))
3934 (if org-adapt-indentation (org-fixup-indentation diff))))
3936 (defun org-map-tree (fun)
3937 "Call FUN for every heading underneath the current one."
3938 (org-back-to-heading)
3939 (let ((level (funcall outline-level)))
3940 (save-excursion
3941 (funcall fun)
3942 (while (and (progn
3943 (outline-next-heading)
3944 (> (funcall outline-level) level))
3945 (not (eobp)))
3946 (funcall fun)))))
3948 (defun org-map-region (fun beg end)
3949 "Call FUN for every heading between BEG and END."
3950 (let ((org-ignore-region t))
3951 (save-excursion
3952 (setq end (copy-marker end))
3953 (goto-char beg)
3954 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
3955 (< (point) end))
3956 (funcall fun))
3957 (while (and (progn
3958 (outline-next-heading)
3959 (< (point) end))
3960 (not (eobp)))
3961 (funcall fun)))))
3963 (defun org-fixup-indentation (diff)
3964 "Change the indentation in the current entry by DIFF
3965 However, if any line in the current entry has no indentation, or if it
3966 would end up with no indentation after the change, nothing at all is done."
3967 (save-excursion
3968 (let ((end (save-excursion (outline-next-heading)
3969 (point-marker)))
3970 (prohibit (if (> diff 0)
3973 col)
3974 (unless (save-excursion (re-search-forward prohibit end t))
3976 (goto-char (match-end 0))
3977 (setq col (current-column))
3978 (if (< diff 0) (replace-match ""))
3979 (indent-to (+ diff col))))
3980 (move-marker end nil))))
3982 ;;; Vertical tree motion, cutting and pasting of subtrees
3984 (defun org-move-subtree-up (&optional arg)
3985 "Move the current subtree up past ARG headlines of the same level."
3986 (interactive "p")
3987 (org-move-subtree-down (- (prefix-numeric-value arg))))
3989 (defun org-move-subtree-down (&optional arg)
3990 "Move the current subtree down past ARG headlines of the same level."
3991 (interactive "p")
3992 (setq arg (prefix-numeric-value arg))
3993 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
3994 'outline-get-last-sibling))
3995 (ins-point (make-marker))
3996 (cnt (abs arg))
3997 beg end txt folded)
3998 ;; Select the tree
3999 (org-back-to-heading)
4000 (setq beg (point))
4001 (save-match-data
4002 (save-excursion (outline-end-of-heading)
4003 (setq folded (org-invisible-p)))
4004 (outline-end-of-subtree))
4005 (outline-next-heading)
4006 (setq end (point))
4007 ;; Find insertion point, with error handling
4008 (goto-char beg)
4009 (while (> cnt 0)
4010 (or (and (funcall movfunc) (looking-at outline-regexp))
4011 (progn (goto-char beg)
4012 (error "Cannot move past superior level or buffer limit")))
4013 (setq cnt (1- cnt)))
4014 (if (> arg 0)
4015 ;; Moving forward - still need to move over subtree
4016 (progn (outline-end-of-subtree)
4017 (outline-next-heading)
4018 (if (not (or (looking-at (concat "^" outline-regexp))
4019 (bolp)))
4020 (newline))))
4021 (move-marker ins-point (point))
4022 (setq txt (buffer-substring beg end))
4023 (delete-region beg end)
4024 (insert txt)
4025 (goto-char ins-point)
4026 (if folded (hide-subtree))
4027 (move-marker ins-point nil)))
4029 (defvar org-subtree-clip ""
4030 "Clipboard for cut and paste of subtrees.
4031 This is actually only a copy of the kill, because we use the normal kill
4032 ring. We need it to check if the kill was created by `org-copy-subtree'.")
4034 (defvar org-subtree-clip-folded nil
4035 "Was the last copied subtree folded?
4036 This is used to fold the tree back after pasting.")
4038 (defun org-cut-subtree ()
4039 "Cut the current subtree into the clipboard.
4040 This is a short-hand for marking the subtree and then cutting it."
4041 (interactive)
4042 (org-copy-subtree 'cut))
4044 (defun org-copy-subtree (&optional cut)
4045 "Cut the current subtree into the clipboard.
4046 This is a short-hand for marking the subtree and then copying it.
4047 If CUT is non nil, actually cut the subtree."
4048 (interactive)
4049 (let (beg end folded)
4050 (org-back-to-heading)
4051 (setq beg (point))
4052 (save-match-data
4053 (save-excursion (outline-end-of-heading)
4054 (setq folded (org-invisible-p)))
4055 (outline-end-of-subtree))
4057 (setq end (point))
4058 (goto-char beg)
4059 (when (> end beg)
4060 (setq org-subtree-clip-folded folded)
4061 (if cut (kill-region beg end) (copy-region-as-kill beg end))
4062 (setq org-subtree-clip (current-kill 0))
4063 (message "%s: Subtree with %d characters"
4064 (if cut "Cut" "Copied")
4065 (length org-subtree-clip)))))
4067 (defun org-paste-subtree (&optional level tree)
4068 "Paste the clipboard as a subtree, with modification of headline level.
4069 The entire subtree is promoted or demoted in order to match a new headline
4070 level. By default, the new level is derived from the visible headings
4071 before and after the insertion point, and taken to be the inferior headline
4072 level of the two. So if the previous visible heading is level 3 and the
4073 next is level 4 (or vice versa), level 4 will be used for insertion.
4074 This makes sure that the subtree remains an independent subtree and does
4075 not swallow low level entries.
4077 You can also force a different level, either by using a numeric prefix
4078 argument, or by inserting the heading marker by hand. For example, if the
4083 If optional TREE is given, use this text instead of the kill ring."
4084 (interactive "P")
4085 (unless (org-kill-is-subtree-p tree)
4086 (error
4087 (substitute-command-keys
4089 (let* ((txt (or tree (and kill-ring (current-kill 0))))
4094 (old-level (if (string-match ^re txt)
4095 (- (match-end 0) (match-beginning 0))
4096 -1))
4097 (force-level (cond (level (prefix-numeric-value level))
4098 ((string-match
4099 ^re_ (buffer-substring (point-at-bol) (point)))
4100 (- (match-end 0) (match-beginning 0)))
4101 (t nil)))
4102 (previous-level (save-excursion
4103 (condition-case nil
4104 (progn
4105 (outline-previous-visible-heading 1)
4106 (if (looking-at re)
4107 (- (match-end 0) (match-beginning 0))
4108 1))
4109 (error 1))))
4110 (next-level (save-excursion
4111 (condition-case nil
4112 (progn
4113 (outline-next-visible-heading 1)
4114 (if (looking-at re)
4115 (- (match-end 0) (match-beginning 0))
4116 1))
4117 (error 1))))
4118 (new-level (or force-level (max previous-level next-level)))
4119 (shift (if (or (= old-level -1)
4120 (= new-level -1)
4121 (= old-level new-level))
4122 0
4123 (- new-level old-level)))
4124 (shift1 shift)
4125 (delta (if (> shift 0) -1 1))
4126 (func (if (> shift 0) 'org-demote 'org-promote))
4127 (org-odd-levels-only nil)
4128 beg end)
4129 ;; Remove the forces level indicator
4130 (if force-level
4131 (delete-region (point-at-bol) (point)))
4132 ;; Make sure we start at the beginning of an empty line
4136 ;; Paste
4137 (setq beg (point))
4140 (insert txt)
4141 (setq end (point))
4144 (goto-char beg)
4145 ;; Shift if necessary
4146 (if (= shift 0)
4147 (message "Pasted at level %d, without shift" new-level)
4148 (save-restriction
4149 (narrow-to-region beg end)
4150 (while (not (= shift 0))
4151 (org-map-region func (point-min) (point-max))
4152 (setq shift (+ delta shift)))
4153 (goto-char (point-min))
4154 (message "Pasted at level %d, with shift by %d levels"
4155 new-level shift1)))
4156 (if (and kill-ring
4157 (eq org-subtree-clip (current-kill 0))
4158 org-subtree-clip-folded)
4159 ;; The tree was folded before it was killed/copied
4160 (hide-subtree))))
4162 (defun org-kill-is-subtree-p (&optional txt)
4163 "Check if the current kill is an outline subtree, or a set of trees.
4164 Returns nil if kill does not start with a headline, or if the first
4165 headline level is not the largest headline level in the tree.
4166 So this will actually accept several entries of equal levels as well,
4167 which is OK for `org-paste-subtree'.
4168 If optional TXT is given, check this string instead of the current kill."
4169 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
4170 (start-level (and kill
4172 (- (match-end 0) (match-beginning 0))))
4173 (re (concat "^" outline-regexp))
4174 (start 1))
4175 (if (not start-level)
4176 nil ;; does not even start with a heading
4177 (catch 'exit
4178 (while (setq start (string-match re kill (1+ start)))
4179 (if (< (- (match-end 0) (match-beginning 0)) start-level)
4180 (throw 'exit nil)))
4181 t))))
4183 (defun org-narrow-to-subtree ()
4184 "Narrow buffer to the current subtree."
4185 (interactive)
4186 (save-excursion
4187 (narrow-to-region
4188 (progn (org-back-to-heading) (point))
4189 (progn (org-end-of-subtree t) (point)))))
4191 ;;; Plain list items
4193 (defun org-at-item-p ()
4194 "Is point in a line starting a hand-formatted item?"
4195 (let ((llt org-plain-list-ordered-item-terminator))
4196 (save-excursion
4197 (goto-char (point-at-bol))
4198 (looking-at
4199 (cond
4203 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
4205 (defun org-at-item-checkbox-p ()
4206 "Is point at a line starting a plain-list item with a checklet?"
4207 (and (org-at-item-p)
4208 (save-excursion
4209 (goto-char (match-end 0))
4213 (defun org-toggle-checkbox (&optional arg)
4214 "Toggle the checkbox in the current line."
4215 (interactive "P")
4216 (catch 'exit
4217 (let (beg end status (firstnew 'unknown))
4218 (cond
4219 ((org-region-active-p)
4220 (setq beg (region-beginning) end (region-end)))
4221 ((org-on-heading-p)
4222 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
4223 ((org-at-item-checkbox-p)
4224 (save-excursion
4225 (replace-match (if (equal (match-string 0) "[ ]") "[X]" "[ ]") t t))
4226 (throw 'exit t))
4227 (t (error "Not at a checkbox or heading, and no active region")))
4228 (save-excursion
4229 (goto-char beg)
4230 (while (< (point) end)
4231 (when (org-at-item-checkbox-p)
4232 (setq status (equal (match-string 0) "[X]"))
4233 (when (eq firstnew 'unknown)
4234 (setq firstnew (not status)))
4235 (replace-match
4236 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
4237 (beginning-of-line 2)))))
4238 (org-update-checkbox-count-maybe))
4240 (defun org-update-checkbox-count-maybe ()
4241 "Update checkbox statistics unless turned off by user."
4242 (when org-provide-checkbox-statistics
4243 (org-update-checkbox-count)))
4245 (defun org-update-checkbox-count (&optional all)
4246 "Update the checkbox statistics in the current section.
4247 This will find all statistic cookies like [57%] and [6/12] and update them
4248 with the current numbers. With optional prefix argument ALL, do this for
4249 the whole buffer."
4250 (interactive "P")
4251 (save-excursion
4252 (let* ((buffer-invisibility-spec nil)
4253 (beg (progn (outline-back-to-heading) (point)))
4254 (end (move-marker (make-marker)
4255 (progn (outline-next-heading) (point))))
4258 b1 e1 f1 c-on c-off lim (cstat 0))
4259 (when all
4260 (goto-char (point-min))
4261 (outline-next-heading)
4262 (setq beg (point) end (point-max)))
4263 (goto-char beg)
4264 (while (re-search-forward re end t)
4265 (setq cstat (1+ cstat)
4266 b1 (match-beginning 0)
4267 e1 (match-end 0)
4268 f1 (match-beginning 1)
4269 lim (cond
4270 ((org-on-heading-p) (outline-next-heading) (point))
4271 ((org-at-item-p) (org-end-of-item) (point))
4272 (t nil))
4273 c-on 0 c-off 0)
4274 (goto-char e1)
4275 (when lim
4276 (while (re-search-forward re-box lim t)
4277 (if (equal (match-string 2) "[ ]")
4278 (setq c-off (1+ c-off))
4279 (setq c-on (1+ c-on))))
4280 (delete-region b1 e1)
4281 (goto-char b1)
4282 (insert (if f1
4283 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
4284 (format "[%d/%d]" c-on (+ c-on c-off))))))
4285 (when (interactive-p)
4286 (message "Checkbox satistics updated %s (%d places)"
4287 (if all "in entire file" "in current outline entry") cstat)))))
4289 (defun org-get-checkbox-statistics-face ()
4290 "Select the face for checkbox statistics.
4291 The face will be `org-done' when all relevant boxes are checked. Otherwise
4292 it will be `org-todo'."
4293 (if (match-end 1)
4294 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
4295 (if (and (> (match-end 2) (match-beginning 2))
4296 (equal (match-string 2) (match-string 3)))
4297 'org-done
4298 'org-todo)))
4300 (defun org-get-indentation (&optional line)
4301 "Get the indentation of the current line, interpreting tabs.
4302 When LINE is given, assume it represents a line and compute its indentation."
4303 (if line
4304 (if (string-match "^ *" (org-remove-tabs line))
4305 (match-end 0))
4306 (save-excursion
4307 (beginning-of-line 1)
4309 (current-column))))
4311 (defun org-remove-tabs (s &optional width)
4312 "Replace tabulators in S with spaces.
4313 Assumes that s is a single line, starting in column 0."
4314 (setq width (or width tab-width))
4316 (setq s (replace-match
4317 (make-string
4318 (- (* width (/ (+ (match-beginning 0) width) width))
4319 (match-beginning 0)) ?\ )
4320 t t s)))
4321 s)
4323 ;; FIXME: document properly.
4324 (defun org-fix-indentation (line ind)
4325 "If the current indenation is smaller than ind1, leave it alone.
4326 If it is larger than ind, reduce it by ind."
4327 (let* ((l (org-remove-tabs line))
4328 (i (org-get-indentation l))
4329 (i1 (car ind)) (i2 (cdr ind)))
4330 (if (>= i i2) (setq l (substring line i2)))
4331 (if (> i1 0)
4332 (concat (make-string i1 ?\ ) l)
4333 l)))
4335 (defun org-beginning-of-item ()
4336 "Go to the beginning of the current hand-formatted item.
4337 If the cursor is not in an item, throw an error."
4338 (interactive)
4339 (let ((pos (point))
4340 (limit (save-excursion (org-back-to-heading)
4341 (beginning-of-line 2) (point)))
4342 ind ind1)
4343 (if (org-at-item-p)
4344 (beginning-of-line 1)
4345 (beginning-of-line 1)
4347 (setq ind (current-column))
4348 (if (catch 'exit
4349 (while t
4350 (beginning-of-line 0)
4351 (if (< (point) limit) (throw 'exit nil))
4354 (setq ind1 (current-column))
4355 (if (< ind1 ind)
4356 (throw 'exit (org-at-item-p))))))
4357 nil
4358 (goto-char pos)
4359 (error "Not in an item")))))
4361 (defun org-end-of-item ()
4362 "Go to the end of the current hand-formatted item.
4363 If the cursor is not in an item, throw an error."
4364 (interactive)
4365 (let ((pos (point))
4366 (limit (save-excursion (outline-next-heading) (point)))
4367 (ind (save-excursion
4368 (org-beginning-of-item)
4370 (current-column)))
4371 ind1)
4372 (if (catch 'exit
4373 (while t
4374 (beginning-of-line 2)
4375 (if (>= (point) limit) (throw 'exit t))
4378 (setq ind1 (current-column))
4379 (if (<= ind1 ind) (throw 'exit t)))))
4380 (beginning-of-line 1)
4381 (goto-char pos)
4382 (error "Not in an item"))))
4384 (defun org-next-item ()
4385 "Move to the beginning of the next item in the current plain list.
4386 Error if not at a plain list, or if this is the last item in the list."
4387 (interactive)
4388 (let (ind ind1 (pos (point)))
4389 (org-beginning-of-item)
4390 (setq ind (org-get-indentation))
4391 (org-end-of-item)
4392 (setq ind1 (org-get-indentation))
4393 (unless (and (org-at-item-p) (= ind ind1))
4394 (goto-char pos)
4395 (error "On last item"))))
4397 (defun org-previous-item ()
4398 "Move to the beginning of the previous item in the current plain list.
4399 Error if not at a plain list, or if this is the last item in the list."
4400 (interactive)
4401 (let (beg ind (pos (point)))
4402 (org-beginning-of-item)
4403 (setq beg (point))
4404 (setq ind (org-get-indentation))
4405 (goto-char beg)
4406 (catch 'exit
4407 (while t
4408 (beginning-of-line 0)
4410 nil
4411 (if (<= (org-get-indentation) ind)
4412 (throw 'exit t)))))
4413 (condition-case nil
4414 (org-beginning-of-item)
4415 (error (goto-char pos)
4416 (error "On first item")))))
4418 (defun org-move-item-down ()
4419 "Move the plain list item at point down, i.e. swap with following item.
4420 Subitems (items with larger indentation) are considered part of the item,
4421 so this really moves item trees."
4422 (interactive)
4423 (let (beg end ind ind1 (pos (point)) txt)
4424 (org-beginning-of-item)
4425 (setq beg (point))
4426 (setq ind (org-get-indentation))
4427 (org-end-of-item)
4428 (setq end (point))
4429 (setq ind1 (org-get-indentation))
4430 (if (and (org-at-item-p) (= ind ind1))
4431 (progn
4432 (org-end-of-item)
4433 (setq txt (buffer-substring beg end))
4434 (save-excursion
4435 (delete-region beg end))
4436 (setq pos (point))
4437 (insert txt)
4438 (goto-char pos)
4439 (org-maybe-renumber-ordered-list))
4440 (goto-char pos)
4441 (error "Cannot move this item further down"))))
4443 (defun org-move-item-up (arg)
4444 "Move the plain list item at point up, i.e. swap with previous item.
4445 Subitems (items with larger indentation) are considered part of the item,
4446 so this really moves item trees."
4447 (interactive "p")
4448 (let (beg end ind ind1 (pos (point)) txt)
4449 (org-beginning-of-item)
4450 (setq beg (point))
4451 (setq ind (org-get-indentation))
4452 (org-end-of-item)
4453 (setq end (point))
4454 (goto-char beg)
4455 (catch 'exit
4456 (while t
4457 (beginning-of-line 0)
4459 nil
4460 (if (<= (setq ind1 (org-get-indentation)) ind)
4461 (throw 'exit t)))))
4462 (condition-case nil
4463 (org-beginning-of-item)
4464 (error (goto-char beg)
4465 (error "Cannot move this item further up")))
4466 (setq ind1 (org-get-indentation))
4467 (if (and (org-at-item-p) (= ind ind1))
4468 (progn
4469 (setq txt (buffer-substring beg end))
4470 (save-excursion
4471 (delete-region beg end))
4472 (setq pos (point))
4473 (insert txt)
4474 (goto-char pos)
4475 (org-maybe-renumber-ordered-list))
4476 (goto-char pos)
4477 (error "Cannot move this item further up"))))
4479 (defun org-maybe-renumber-ordered-list ()
4480 "Renumber the ordered list at point if setup allows it.
4481 This tests the user option `org-auto-renumber-ordered-lists' before
4482 doing the renumbering."
4483 (and org-auto-renumber-ordered-lists
4484 (org-at-item-p)
4485 (match-beginning 3)
4486 (org-renumber-ordered-list 1)))
4488 (defun org-get-string-indentation (s)
4489 "What indentation has S due to SPACE and TAB at the beginning of the string?"
4490 (let ((n -1) (i 0) (w tab-width) c)
4491 (catch 'exit
4492 (while (< (setq n (1+ n)) (length s))
4493 (setq c (aref s n))
4494 (cond ((= c ?\ ) (setq i (1+ i)))
4496 (t (throw 'exit t)))))
4497 i))
4499 (defun org-renumber-ordered-list (arg)
4500 "Renumber an ordered plain list.
4501 Cursor needs to be in the first line of an item, the line that starts
4503 (interactive "p")
4504 (unless (and (org-at-item-p)
4505 (match-beginning 3))
4506 (error "This is not an ordered list"))
4507 (let ((line (org-current-line))
4508 (col (current-column))
4509 (ind (org-get-string-indentation
4510 (buffer-substring (point-at-bol) (match-beginning 3))))
4511 ;; (term (substring (match-string 3) -1))
4512 ind1 (n (1- arg)))
4513 ;; find where this list begins
4514 (catch 'exit
4515 (while t
4516 (catch 'next
4517 (beginning-of-line 0)
4520 (if (or (< ind1 ind)
4521 (and (= ind1 ind)
4522 (not (org-at-item-p))))
4523 (throw 'exit t)))))
4524 ;; Walk forward and replace these numbers
4525 (catch 'exit
4526 (while t
4527 (catch 'next
4528 (beginning-of-line 2)
4529 (if (eobp) (throw 'exit nil))
4532 (if (> ind1 ind) (throw 'next t))
4533 (if (< ind1 ind) (throw 'exit t))
4534 (if (not (org-at-item-p)) (throw 'exit nil))
4535 (if (not (match-beginning 3))
4537 (delete-region (match-beginning 3) (1- (match-end 3)))
4538 (goto-char (match-beginning 3))
4539 (insert (format "%d" (setq n (1+ n)))))))
4540 (goto-line line)
4541 (move-to-column col)))
4543 (defvar org-last-indent-begin-marker (make-marker))
4544 (defvar org-last-indent-end-marker (make-marker))
4546 (defun org-outdent-item (arg)
4547 "Outdent a local list item."
4548 (interactive "p")
4549 (org-indent-item (- arg)))
4551 (defun org-indent-item (arg)
4552 "Indent a local list item."
4553 (interactive "p")
4554 (unless (org-at-item-p)
4555 (error "Not on an item"))
4556 (save-excursion
4557 (let (beg end ind ind1)
4558 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
4559 (setq beg org-last-indent-begin-marker
4560 end org-last-indent-end-marker)
4561 (org-beginning-of-item)
4562 (setq beg (move-marker org-last-indent-begin-marker (point)))
4563 (org-end-of-item)
4564 (setq end (move-marker org-last-indent-end-marker (point))))
4565 (goto-char beg)
4567 (if (< (+ arg ind) 0) (error "Cannot outdent beyond margin"))
4568 (while (< (point) end)
4569 (beginning-of-line 1)
4571 (delete-region (point-at-bol) (point))
4572 (indent-to-column (+ ind1 arg))
4573 (beginning-of-line 2)))))
4575 ;;; Archiving
4577 (defun org-archive-subtree (&optional find-done)
4578 "Move the current subtree to the archive.
4579 The archive can be a certain top-level heading in the current file, or in
4580 a different file. The tree will be moved to that location, the subtree
4581 heading be marked DONE, and the current time will be added.
4583 When called with prefix argument FIND-DONE, find whole trees without any
4584 open TODO items and archive them (after getting confirmation from the user).
4585 If the cursor is not at a headline when this comand is called, try all level
4586 1 trees. If the cursor is on a headline, only try the direct children of
4587 this heading. "
4588 (interactive "P")
4589 (if find-done
4590 (org-archive-all-done)
4591 ;; Save all relevant TODO keyword-relatex variables
4593 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
4594 (tr-org-todo-keywords org-todo-keywords)
4595 (tr-org-todo-interpretation org-todo-interpretation)
4596 (tr-org-done-string org-done-string)
4597 (tr-org-todo-regexp org-todo-regexp)
4598 (tr-org-todo-line-regexp org-todo-line-regexp)
4599 (this-buffer (current-buffer))
4600 file heading buffer level newfile-p)
4602 (progn
4603 (setq file (format (match-string 1 org-archive-location)
4604 (file-name-nondirectory buffer-file-name))
4605 heading (match-string 2 org-archive-location)))
4606 (error "Invalid `org-archive-location'"))
4607 (if (> (length file) 0)
4608 (setq newfile-p (not (file-exists-p file))
4609 buffer (find-file-noselect file))
4610 (setq buffer (current-buffer)))
4611 (unless buffer
4613 (if (and (> (length heading) 0)
4615 (setq level (match-end 0))
4616 (setq heading nil level 0))
4617 (save-excursion
4618 ;; We first only copy, in case something goes wrong
4619 ;; we need to protect this-command, to avoid kill-region sets it,
4620 ;; which would lead to duplication of subtrees
4621 (let (this-command) (org-copy-subtree))
4622 (set-buffer buffer)
4623 ;; Enforce org-mode for the archive buffer
4624 (if (not (org-mode-p))
4625 ;; Force the mode for future visits.
4626 (let ((org-insert-mode-line-in-empty-file t))
4627 (call-interactively 'org-mode)))
4628 (when newfile-p
4629 (goto-char (point-max))
4631 (buffer-file-name this-buffer))))
4632 ;; Force the TODO keywords of the original buffer
4633 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
4634 (org-todo-keywords tr-org-todo-keywords)
4635 (org-todo-interpretation tr-org-todo-interpretation)
4636 (org-done-string tr-org-done-string)
4637 (org-todo-regexp tr-org-todo-regexp)
4638 (org-todo-line-regexp tr-org-todo-line-regexp))
4639 (goto-char (point-min))
4640 (if heading
4641 (progn
4642 (if (re-search-forward
4645 nil t)
4646 (goto-char (match-end 0))
4647 ;; Heading not found, just insert it at the end
4648 (goto-char (point-max))
4651 (end-of-line 0))
4652 ;; Make the subtree visible
4653 (show-subtree)
4654 (org-end-of-subtree t)
4658 ;; No specific heading, just go to end of file.
4660 ;; Paste
4661 (org-paste-subtree (1+ level))
4662 ;; Mark the entry as done, i.e. set to last work in org-todo-keywords
4663 (if org-archive-mark-done
4664 (org-todo (length org-todo-keywords)))
4665 ;; Move cursor to right after the TODO keyword
4666 (when org-archive-stamp-time
4667 (beginning-of-line 1)
4668 (looking-at org-todo-line-regexp)
4669 (goto-char (or (match-end 2) (match-beginning 3)))
4670 (insert "(" (format-time-string (cdr org-time-stamp-formats)
4671 (org-current-time))
4672 ")"))
4673 ;; Save the buffer, if it is not the same buffer.
4674 (if (not (eq this-buffer buffer)) (save-buffer))))
4675 ;; Here we are back in the original buffer. Everything seems to have
4676 ;; worked. So now cut the tree and finish up.
4677 (let (this-command) (org-cut-subtree))
4679 (message "Subtree archived %s"
4680 (if (eq this-buffer buffer)
4681 (concat "under heading: " heading)
4682 (concat "in file: " (abbreviate-file-name file)))))))
4684 (defun org-archive-all-done (&optional tag)
4685 "Archive sublevels of the current tree without open TODO items.
4686 If the cursor is not on a headline, try all level 1 trees. If
4687 it is on a headline, try all direct children.
4688 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
4690 (rea (concat ".*:" org-archive-tag ":"))
4691 (begm (make-marker))
4692 (endm (make-marker))
4693 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
4694 "Move subtree to archive (no open TODO items)? "))
4695 beg end (cntarch 0))
4696 (if (org-on-heading-p)
4697 (progn
4698 (setq re1 (concat "^" (regexp-quote
4699 (make-string
4700 (1+ (- (match-end 0) (match-beginning 0)))
4701 ?*))
4702 " "))
4703 (move-marker begm (point))
4704 (move-marker endm (org-end-of-subtree)))
4705 (setq re1 "^* ")
4706 (move-marker begm (point-min))
4707 (move-marker endm (point-max)))
4708 (save-excursion
4709 (goto-char begm)
4710 (while (re-search-forward re1 endm t)
4711 (setq beg (match-beginning 0)
4712 end (save-excursion (org-end-of-subtree t) (point)))
4713 (goto-char beg)
4714 (if (re-search-forward re end t)
4715 (goto-char end)
4716 (goto-char beg)
4717 (if (and (or (not tag) (not (looking-at rea)))
4718 (y-or-n-p question))
4719 (progn
4720 (if tag
4721 (org-toggle-tag org-archive-tag 'on)
4722 (org-archive-subtree))
4723 (setq cntarch (1+ cntarch)))
4724 (goto-char end)))))
4725 (message "%d trees archived" cntarch)))
4727 (defun org-cycle-hide-archived-subtrees (state)
4728 "Re-hide all archived subtrees after a visibility state change."
4729 (when (and (not org-cycle-open-archived-trees)
4730 (not (memq state '(overview folded))))
4731 (save-excursion
4732 (let* ((globalp (memq state '(contents all)))
4733 (beg (if globalp (point-min) (point)))
4734 (end (if globalp (point-max) (org-end-of-subtree))))
4735 (org-hide-archived-subtrees beg end)
4736 (goto-char beg)
4737 (if (looking-at (concat ".*:" org-archive-tag ":"))
4738 (message (substitute-command-keys
4739 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4741 (defun org-force-cycle-archived ()
4742 "Cycle subtree even if it is archived."
4743 (interactive)
4744 (setq this-command 'org-cycle)
4745 (let ((org-cycle-open-archived-trees t))
4746 (call-interactively 'org-cycle)))
4748 (defun org-hide-archived-subtrees (beg end)
4749 "Re-hide all archived subtrees after a visibility state change."
4750 (save-excursion
4751 (let* ((re (concat ":" org-archive-tag ":")))
4752 (goto-char beg)
4753 (while (re-search-forward re end t)
4754 (and (org-on-heading-p) (hide-subtree))
4755 (org-end-of-subtree)))))
4757 (defun org-toggle-tag (tag &optional onoff)
4758 "Toggle the tag TAG for the current line.
4759 If ONOFF is `on' or `off', don't toggle but set to this state."
4760 (unless (org-on-heading-p) (error "Not on headling"))
4761 (let (res current)
4762 (save-excursion
4763 (beginning-of-line)
4765 (point-at-eol) t)
4766 (progn
4767 (setq current (match-string 1))
4768 (replace-match ""))
4769 (setq current ""))
4770 (setq current (nreverse (org-split-string current ":")))
4771 (cond
4772 ((eq onoff 'on)
4773 (setq res t)
4774 (or (member tag current) (push tag current)))
4775 ((eq onoff 'off)
4776 (or (not (member tag current)) (setq current (delete tag current))))
4777 (t (if (member tag current)
4778 (setq current (delete tag current))
4779 (setq res t)
4780 (push tag current))))
4781 (end-of-line 1)
4782 (when current
4783 (insert " :" (mapconcat 'identity (nreverse current) ":") ":"))
4784 (org-set-tags nil t))
4785 res))
4787 (defun org-toggle-archive-tag (&optional arg)
4788 "Toggle the archive tag for the current headline.
4789 With prefix ARG, check all children of current headline and offer tagging
4790 the children that do not contain any open TODO items."
4791 (interactive "P")
4792 (if arg
4793 (org-archive-all-done 'tag)
4794 (let (set)
4795 (save-excursion
4796 (org-back-to-heading t)
4797 (setq set (org-toggle-tag org-archive-tag))
4798 (when set (hide-subtree)))
4799 (and set (beginning-of-line 1))
4800 (message "Subtree %s" (if set "archived" "unarchived")))))
4802 (defvar org-agenda-multi nil) ; dynammically scoped
4803 (defvar org-agenda-buffer-name "*Org Agenda*")
4804 (defun org-prepare-agenda ()
4805 (if org-agenda-multi
4806 (progn
4807 (setq buffer-read-only nil)
4808 (goto-char (point-max))
4809 (unless (= (point) 1)
4811 (narrow-to-region (point) (point-max)))
4812 (org-agenda-maybe-reset-markers 'force)
4813 (org-prepare-agenda-buffers (org-agenda-files))
4814 (unless (equal (current-buffer) (get-buffer org-agenda-buffer-name))
4815 (delete-other-windows)
4816 (switch-to-buffer-other-window
4817 (get-buffer-create org-agenda-buffer-name)))
4818 (setq buffer-read-only nil)
4819 (erase-buffer)
4820 (org-agenda-mode))
4821 (setq buffer-read-only nil)) ;;; FIXME: do we need all these occasions????
4823 (defun org-prepare-agenda-buffers (files)
4824 "Create buffers for all agenda files, protect archived trees and comments."
4825 (interactive)
4826 (let ((pa '(:org-archived t))
4827 (pc '(:org-comment t))
4828 (pall '(:org-archived t :org-comment t))
4829 (rea (concat ":" org-archive-tag ":"))
4830 bmp file re)
4831 (save-excursion
4832 (while (setq file (pop files))
4833 (org-check-agenda-file file)
4834 (set-buffer (org-get-agenda-file-buffer file))
4835 (widen)
4836 (setq bmp (buffer-modified-p))
4837 (save-excursion
4838 (remove-text-properties (point-min) (point-max) pall)
4839 (when org-agenda-skip-archived-trees
4840 (goto-char (point-min))
4841 (while (re-search-forward rea nil t)
4842 (if (org-on-heading-p)
4843 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
4844 (goto-char (point-min))
4846 (while (re-search-forward re nil t)
4847 (add-text-properties
4848 (match-beginning 0) (org-end-of-subtree t) pc)))
4849 (set-buffer-modified-p bmp)))))
4851 (defun org-agenda-skip ()
4852 "Throw to `:skip' in places that should be skipped."
4853 (let ((p (point-at-bol)))
4854 (and org-agenda-skip-archived-trees
4855 (get-text-property p :org-archived)
4856 (org-end-of-subtree)
4857 (throw :skip t))
4858 (and (get-text-property p :org-comment)
4859 (org-end-of-subtree)
4860 (throw :skip t))
4861 (if (equal (char-after p) ?#) (throw :skip t))))
4863 (defun org-agenda-toggle-archive-tag ()
4864 "Toggle the archive tag for the current entry."
4865 (interactive)
4866 (org-agenda-check-no-diary)
4867 (org-agenda-show) ;;; FIXME This is a stupid hack and should not be needed
4868 (let* ((hdmarker (or (get-text-property (point) 'org-hd-marker)
4869 (org-agenda-error)))
4870 (buffer (marker-buffer hdmarker))
4871 (pos (marker-position hdmarker))
4872 (buffer-read-only nil)
4873 newhead)
4874 (with-current-buffer buffer
4875 (widen)
4876 (goto-char pos)
4877 (org-show-hidden-entry)
4878 (save-excursion
4879 (and (outline-next-heading)
4880 (org-flag-heading nil))) ; show the next heading
4881 (call-interactively 'org-toggle-archive-tag)
4882 (end-of-line 1)
4883 (setq newhead (org-get-heading)))
4884 (org-agenda-change-all-lines newhead hdmarker)
4885 (beginning-of-line 1)))
4887 ;;; Dynamic blocks
4889 (defun org-find-dblock (name)
4890 "Find the first dynamic block with name NAME in the buffer.
4891 If not found, stay at current position and return nil."
4892 (let (pos)
4893 (save-excursion
4894 (goto-char (point-min))
4896 nil t)
4897 (match-beginning 0))))
4898 (if pos (goto-char pos))
4899 pos))
4901 (defconst org-dblock-start-re
4903 "Matches the startline of a dynamic block, with parameters.")
4906 "Matches the end of a dyhamic block.")
4908 (defun org-create-dblock (plist)
4909 "Create a dynamic block section, with parameters taken from PLIST.
4910 PLIST must containe a :name entry which is used as name of the block."
4911 (unless (bolp) (newline))
4912 (let ((name (plist-get plist :name)))
4913 (insert "#+BEGIN: " name)
4914 (while plist
4915 (if (eq (car plist) :name)
4916 (setq plist (cddr plist))
4917 (insert " " (prin1-to-string (pop plist)))))
4919 (beginning-of-line -2)))
4921 (defun org-prepare-dblock ()
4922 "Prepare dynamic block for refresh.
4923 This empties the block, puts the cursor at the insert position and returns
4924 the property list including an extra property :name with the block name."
4925 (unless (looking-at org-dblock-start-re)
4926 (error "Not at a dynamic block"))
4927 (let* ((begdel (1+ (match-end 0)))
4928 (name (match-string 1))
4929 (params (append (list :name name)
4930 (read (concat "(" (match-string 3) ")")))))
4931 (unless (re-search-forward org-dblock-end-re nil t)
4932 (error "Dynamic block not terminated"))
4933 (delete-region begdel (match-beginning 0))
4934 (goto-char begdel)
4935 (open-line 1)
4936 params))
4938 (defun org-map-dblocks (&optional command)
4939 "Apply COMMAND to all dynamic blocks in the current buffer.
4940 If COMMAND is not given, use `org-update-dblock'."
4941 (let ((cmd (or command 'org-update-dblock))
4942 pos)
4943 (save-excursion
4944 (goto-char (point-min))
4945 (while (re-search-forward org-dblock-start-re nil t)
4946 (goto-char (setq pos (match-beginning 0)))
4947 (condition-case nil
4948 (funcall cmd)
4949 (error (message "Error during update of dynamic block")))
4950 (goto-char pos)
4951 (unless (re-search-forward org-dblock-end-re nil t)
4952 (error "Dynamic block not terminated"))))))
4954 (defun org-dblock-update (&optional arg)
4955 "User command for updating dynamic blocks.
4956 Update the dynamic block at point. With prefix ARG, update all dynamic
4957 blocks in the buffer."
4958 (interactive "P")
4959 (if arg
4960 (org-update-all-dblocks)
4961 (or (looking-at org-dblock-start-re)
4962 (org-beginning-of-dblock))
4963 (org-update-dblock)))
4965 (defun org-update-dblock ()
4966 "Update the dynamic block at point
4967 This means to empty the block, parse for parameters and then call
4968 the correct writing function."
4969 (let* ((pos (point))
4970 (params (org-prepare-dblock))
4971 (name (plist-get params :name))
4972 (cmd (intern (concat "org-dblock-write:" name))))
4973 (funcall cmd params)
4974 (goto-char pos)))
4976 (defun org-beginning-of-dblock ()
4977 "Find the beginning of the dynamic block at point.
4978 Error if there is no scuh block at point."
4979 (let ((pos (point))
4980 beg)
4981 (end-of-line 1)
4982 (if (and (re-search-backward org-dblock-start-re nil t)
4983 (setq beg (match-beginning 0))
4984 (re-search-forward org-dblock-end-re nil t)
4985 (> (match-end 0) pos))
4986 (goto-char beg)
4987 (goto-char pos)
4988 (error "Not in a dynamic block"))))
4990 (defun org-update-all-dblocks ()
4991 "Update all dynamic blocks in the buffer.
4992 This function can be used in a hook."
4993 (when (org-mode-p)
4994 (org-map-dblocks 'org-update-dblock)))
4997 ;;; Completion
4999 (defun org-complete (&optional arg)
5000 "Perform completion on word at point.
5001 At the beginning of a headline, this completes TODO keywords as given in
5002 `org-todo-keywords'.
5003 If the current word is preceded by a backslash, completes the TeX symbols
5004 that are supported for HTML support.
5006 setting file options.
5008 At all other locations, this simply calls `ispell-complete-word'."
5009 (interactive "P")
5010 (catch 'exit
5011 (let* ((end (point))
5012 (beg1 (save-excursion
5013 ;FIXME??? (if (equal (char-before (point)) ?\ ) (backward-char 1))
5014 (skip-chars-backward "a-zA-Z_@0-9")
5015 (point)))
5016 (beg (save-excursion
5017 ;FIXME??? (if (equal (char-before (point)) ?\ ) (backward-char 1))
5018 (skip-chars-backward "a-zA-Z0-9_:$")
5019 (point)))
5020 (confirm (lambda (x) (stringp (car x))))
5021 (camel (equal (char-before beg) ?*))
5022 (tag (equal (char-before beg1) ?:))
5024 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
5025 beg)
5026 "#+"))
5028 (buffer-substring (point-at-bol) (point))))
5029 (completion-ignore-case opt)
5030 (type nil)
5031 (tbl nil)
5032 (table (cond
5033 (opt
5034 (setq type :opt)
5035 (mapcar (lambda (x)
5037 (cons (match-string 2 x) (match-string 1 x)))
5039 (startup
5040 (setq type :startup)
5041 org-startup-options)
5042 (texp
5043 (setq type :tex)
5044 org-html-entities)
5046 (buffer-substring (point-at-bol) beg))
5047 (setq type :todo)
5048 (mapcar 'list org-todo-keywords))
5049 (camel
5050 (setq type :camel)
5051 (save-excursion
5052 (goto-char (point-min))
5053 (while (re-search-forward org-todo-line-regexp nil t)
5054 (push (list
5055 (if org-file-link-context-use-camel-case
5056 (org-make-org-heading-camel (match-string 3) t)
5057 (org-make-org-heading-search-string
5058 (match-string 3) t)))
5059 tbl)))
5060 tbl)
5061 (tag (setq type :tag beg beg1)
5062 (or org-tag-alist (org-get-buffer-tags)))
5063 (t (progn (ispell-complete-word arg) (throw 'exit nil)))))
5064 (pattern (buffer-substring-no-properties beg end))
5065 (completion (try-completion pattern table confirm)))
5066 (cond ((eq completion t)
5067 (if (equal type :opt)
5068 (insert (substring (cdr (assoc (upcase pattern) table))
5069 (length pattern)))))
5070 ((null completion)
5072 (ding))
5073 ((not (string= pattern completion))
5074 (delete-region beg end)
5075 (if (string-match " +$" completion)
5076 (setq completion (replace-match "" t t completion)))
5077 (insert completion)
5078 (if (get-buffer-window "*Completions*")
5079 (delete-window (get-buffer-window "*Completions*")))
5080 (if (assoc completion table)
5081 (if (eq type :todo) (insert " ")
5082 (if (eq type :tag) (insert ":"))))
5083 (if (and (equal type :opt) (assoc completion table))
5084 (message "%s" (substitute-command-keys
5086 (t
5087 (message "Making completion list...")
5088 (let ((list (sort (all-completions pattern table confirm)
5089 'string<)))
5090 (with-output-to-temp-buffer "*Completions*"
5091 (condition-case nil
5092 ;; Protection needed for XEmacs and emacs 21
5093 (display-completion-list list pattern)
5094 (error (display-completion-list list)))))
5095 (message "Making completion list...%s" "done"))))))
5097 ;;; Comments, TODO and DEADLINE
5099 (defun org-toggle-comment ()
5100 "Change the COMMENT state of an entry."
5101 (interactive)
5102 (save-excursion
5103 (org-back-to-heading)
5104 (if (looking-at (concat outline-regexp
5106 (replace-match "" t t nil 1)
5107 (if (looking-at outline-regexp)
5108 (progn
5109 (goto-char (match-end 0))
5110 (insert " " org-comment-string))))))
5112 (defvar org-last-todo-state-is-todo nil
5113 "This is non-nil when the last TODO state change led to a TODO state.
5114 If the last change removed the TODO tag or switched to DONE, then
5115 this is nil.")
5117 (defun org-todo (&optional arg)
5118 "Change the TODO state of an item.
5119 The state of an item is given by a keyword at the start of the heading,
5120 like
5121 *** TODO Write paper
5122 *** DONE Call mom
5124 The different keywords are specified in the variable `org-todo-keywords'.
5126 So for this example: when the item starts with TODO, it is changed to DONE.
5127 When it starts with DONE, the DONE is removed. And when neither TODO nor
5128 DONE are present, add TODO at the beginning of the heading.
5130 With prefix arg, use completion to determine the new state. With numeric
5131 prefix arg, switch to that state."
5132 (interactive "P")
5133 (save-excursion
5134 (org-back-to-heading)
5135 (if (looking-at outline-regexp) (goto-char (match-end 0)))
5136 (or (looking-at (concat " +" org-todo-regexp " *"))
5137 (looking-at " *"))
5138 (let* ((this (match-string 1))
5139 (completion-ignore-case t)
5140 (member (member this org-todo-keywords))
5141 (tail (cdr member))
5142 (state (cond
5143 ((equal arg '(4))
5144 ;; Read a state with completion
5145 (completing-read "State: " (mapcar (lambda(x) (list x))
5146 org-todo-keywords)
5147 nil t))
5148 ((eq arg 'right)
5149 (if this
5150 (if tail (car tail) nil)
5151 (car org-todo-keywords)))
5152 ((eq arg 'left)
5153 (if (equal member org-todo-keywords)
5154 nil
5155 (if this
5156 (nth (- (length org-todo-keywords) (length tail) 2)
5157 org-todo-keywords)
5158 org-done-string)))
5159 (arg
5160 ;; user requests a specific state
5161 (nth (1- (prefix-numeric-value arg))
5162 org-todo-keywords))
5163 ((null member) (car org-todo-keywords))
5164 ((null tail) nil) ;; -> first entry
5165 ((eq org-todo-interpretation 'sequence)
5166 (car tail))
5167 ((memq org-todo-interpretation '(type priority))
5168 (if (eq this-command last-command)
5169 (car tail)
5170 (if (> (length tail) 0) org-done-string nil)))
5171 (t nil)))
5172 (next (if state (concat " " state " ") " ")))
5173 (replace-match next t t)
5174 (setq org-last-todo-state-is-todo
5175 (not (equal state org-done-string)))
5176 (when org-log-done
5177 (if (equal state org-done-string)
5178 (org-add-planning-info 'closed (current-time) 'scheduled)
5179 (if (not this)
5180 (org-add-planning-info nil nil 'closed))))
5181 ;; Fixup tag positioning
5182 (and org-auto-align-tags (org-set-tags nil t))
5183 (run-hooks 'org-after-todo-state-change-hook)))
5184 ;; Fixup cursor location if close to the keyword
5185 (if (and (outline-on-heading-p)
5186 (not (bolp))
5187 (save-excursion (beginning-of-line 1)
5188 (looking-at org-todo-line-regexp))
5189 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
5190 (progn
5191 (goto-char (or (match-end 2) (match-end 1)))
5192 (just-one-space))))
5194 (defun org-log-done (&optional undone)
5195 "Add a time stamp logging that a TODO entry has been closed.
5196 When UNDONE is non-nil, remove such a time stamp again."
5197 (interactive)
5198 (let (beg end col)
5199 (save-excursion
5200 (org-back-to-heading t)
5201 (setq beg (point))
5202 (looking-at (concat outline-regexp " *"))
5203 (goto-char (match-end 0))
5204 (setq col (current-column))
5205 (outline-next-heading)
5206 (setq end (point))
5207 (goto-char beg)
5208 (when (re-search-forward (concat
5210 (regexp-quote org-closed-string)
5212 (delete-region (match-beginning 1) (match-end 1)))
5213 (unless undone
5214 (org-back-to-heading t)
5216 (goto-char (min (1+ (point)) (point-max)))
5219 (indent-to col)
5220 (insert org-closed-string " "
5221 (format-time-string
5222 (concat "[" (substring (cdr org-time-stamp-formats) 1 -1) "]")
5223 (org-current-time))
5226 (defun org-show-todo-tree (arg)
5227 "Make a compact tree which shows all headlines marked with TODO.
5228 The tree will show the lines where the regexp matches, and all higher
5229 headlines above the match.
5231 With a numeric prefix N, construct a sparse tree for the Nth element
5232 of `org-todo-keywords'."
5233 (interactive "P")
5234 (let ((case-fold-search nil)
5235 (kwd-re
5236 (cond ((null arg) org-not-done-regexp)
5237 ((equal arg '(4)) org-todo-regexp)
5238 ((<= (prefix-numeric-value arg) (length org-todo-keywords))
5239 (regexp-quote (nth (1- (prefix-numeric-value arg))
5240 org-todo-keywords)))
5241 (t (error "Invalid prefix argument: %s" arg)))))
5242 (message "%d TODO entries found"
5243 (org-occur (concat "^" outline-regexp " +" kwd-re )))))
5245 (defun org-deadline ()
5246 "Insert the DEADLINE: string to make a deadline.
5248 to modify it to the correct date."
5249 (interactive)
5250 (org-add-planning-info 'deadline nil 'closed))
5252 (defun org-schedule ()
5253 "Insert the SCHEDULED: string to schedule a TODO item.
5255 to modify it to the correct date."
5256 (interactive)
5257 (org-add-planning-info 'scheduled nil 'closed))
5259 (defun org-add-planning-info (what &optional time &rest remove)
5260 "Insert new timestamp with keyword in the line directly after the headline.
5261 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
5262 If non is given, the user is prompted for a date.
5263 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
5264 be removed."
5265 (interactive)
5266 (when what (setq time (or time (org-read-date nil 'to-time))))
5267 (when (and org-insert-labeled-timestamps-at-point
5268 (member what '(scheduled deadline)))
5269 (insert
5270 (if (eq what 'scheduled) org-scheduled-string org-deadline-string)
5271 " "
5272 (format-time-string (car org-time-stamp-formats) time))
5273 (setq what nil))
5274 (save-excursion
5275 (let (col list elt (buffer-invisibility-spec nil) ts)
5276 (org-back-to-heading t)
5278 (goto-char (match-end 1))
5279 (setq col (current-column))
5280 (goto-char (1+ (match-end 0)))
5281 (if (and (not (looking-at outline-regexp))
5284 (not (equal (match-string 1) org-clock-string)))
5285 (narrow-to-region (match-beginning 0) (match-end 0))
5287 (backward-char 1)
5288 (narrow-to-region (point) (point))
5289 (indent-to-column col))
5290 ;; Check if we have to remove something.
5291 (setq list (cons what remove))
5292 (while list
5293 (setq elt (pop list))
5294 (goto-char (point-min))
5295 (when (or (and (eq elt 'scheduled)
5296 (re-search-forward org-scheduled-time-regexp nil t))
5297 (and (eq elt 'deadline)
5298 (re-search-forward org-deadline-time-regexp nil t))
5299 (and (eq elt 'closed)
5300 (re-search-forward org-closed-time-regexp nil t)))
5301 (replace-match "")
5302 (if (looking-at " +") (replace-match ""))))
5303 (goto-char (point-max))
5304 (when what
5305 (insert
5306 (if (not (equal (char-before) ?\ )) " " "")
5307 (cond ((eq what 'scheduled) org-scheduled-string)
5308 ((eq what 'deadline) org-deadline-string)
5309 ((eq what 'closed) org-closed-string))
5310 " ")
5311 (insert
5312 (setq ts
5313 (format-time-string
5314 (if (eq what 'closed)
5315 (concat "[" (substring (cdr org-time-stamp-formats) 1 -1) "]")
5316 (car org-time-stamp-formats))
5317 time))))
5318 (goto-char (point-min))
5319 (widen)
5321 (replace-match ""))
5322 ts)))
5324 (defun org-occur (regexp &optional callback)
5325 "Make a compact tree which shows all matches of REGEXP.
5326 The tree will show the lines where the regexp matches, and all higher
5327 headlines above the match. It will also show the heading after the match,
5328 to make sure editing the matching entry is easy.
5329 If CALLBACK is non-nil, it is a function which is called to confirm
5330 that the match should indeed be shown."
5331 (interactive "sRegexp: ")
5332 (org-remove-occur-highlights nil nil t)
5333 (let ((cnt 0))
5334 (save-excursion
5335 (goto-char (point-min))
5336 (org-overview)
5337 (while (re-search-forward regexp nil t)
5338 (when (or (not callback)
5339 (save-match-data (funcall callback)))
5340 (setq cnt (1+ cnt))
5341 (org-highlight-new-match (match-beginning 0) (match-end 0))
5342 (org-show-hierarchy-above))))
5343 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
5344 nil 'local)
5345 (unless org-sparse-tree-open-archived-trees
5346 (org-hide-archived-subtrees (point-min) (point-max)))
5347 (run-hooks 'org-occur-hook)
5348 (if (interactive-p)
5349 (message "%d match(es) for regexp %s" cnt regexp))
5350 cnt))
5352 (defun org-show-hierarchy-above ()
5353 "Make sure point and the headings hierarchy above is visible."
5354 (catch 'exit
5355 (if (org-on-heading-p t)
5356 (org-flag-heading nil) ; only show the heading
5357 (and (or (org-invisible-p) (org-invisible-p2))
5358 (org-show-hidden-entry))) ; show entire entry
5359 (save-excursion
5360 (and org-show-following-heading
5361 (outline-next-heading)
5362 (org-flag-heading nil))) ; show the next heading
5363 (when org-show-hierarchy-above
5364 (save-excursion ; show all higher headings
5365 (while (and (condition-case nil
5366 (progn (org-up-heading-all 1) t)
5367 (error nil))
5368 (not (bobp)))
5369 (org-flag-heading nil))))))
5371 ;; Overlay compatibility functions
5372 (defun org-make-overlay (beg end &optional buffer)
5373 (if (featurep 'xemacs)
5374 (make-extent beg end buffer)
5375 (make-overlay beg end buffer)))
5376 (defun org-delete-overlay (ovl)
5377 (if (featurep 'xemacs) (delete-extent ovl) (delete-overlay ovl)))
5378 (defun org-detatch-overlay (ovl)
5379 (if (featurep 'xemacs) (detach-extent ovl) (delete-overlay ovl)))
5380 (defun org-move-overlay (ovl beg end &optional buffer)
5381 (if (featurep 'xemacs)
5382 (set-extent-endpoints ovl beg end buffer)
5383 (move-overlay ovl beg end buffer)))
5384 (defun org-overlay-put (ovl prop value)
5385 (if (featurep 'xemacs)
5386 (set-extent-property ovl prop value)
5387 (overlay-put ovl prop value)))
5388 (defun org-overlays-at (pos)
5389 (if (featurep 'xemacs) (extents-at pos) (overlays-at pos)))
5390 (defun org-overlay-start (o)
5391 (if (featurep 'xemacs) (extent-start-position o) (overlay-start o)))
5392 (defun org-overlay-end (o)
5393 (if (featurep 'xemacs) (extent-end-position o) (overlay-end o)))
5395 (defvar org-occur-highlights nil)
5396 (make-variable-buffer-local 'org-occur-highlights)
5397 (defun org-highlight-new-match (beg end)
5398 "Highlight from BEG to END and mark the highlight is an occur headline."
5399 (let ((ov (org-make-overlay beg end)))
5400 (org-overlay-put ov 'face 'secondary-selection)
5401 (push ov org-occur-highlights)))
5403 (defvar org-inhibit-highlight-removal nil)
5404 (defun org-remove-occur-highlights (&optional beg end noremove)
5405 "Remove the occur highlights from the buffer.
5406 BEG and END are ignored. If NOREMOVE is nil, remove this function
5407 from the `before-change-functions' in the current buffer."
5408 (interactive)
5409 (unless org-inhibit-highlight-removal
5410 (mapc 'org-delete-overlay org-occur-highlights)
5411 (setq org-occur-highlights nil)
5412 (unless noremove
5413 (remove-hook 'before-change-functions
5414 'org-remove-occur-highlights 'local))))
5416 ;;; Priorities
5419 "Regular expression matching the priority indicator.")
5421 (defvar org-remove-priority-next-time nil)
5423 (defun org-priority-up ()
5424 "Increase the priority of the current item."
5425 (interactive)
5426 (org-priority 'up))
5428 (defun org-priority-down ()
5429 "Decrease the priority of the current item."
5430 (interactive)
5431 (org-priority 'down))
5433 (defun org-priority (&optional action)
5434 "Change the priority of an item by ARG.
5435 ACTION can be set, up, or down."
5436 (interactive)
5437 (setq action (or action 'set))
5438 (let (current new news have remove)
5439 (save-excursion
5440 (org-back-to-heading)
5441 (if (looking-at org-priority-regexp)
5442 (setq current (string-to-char (match-string 2))
5443 have t)
5444 (setq current org-default-priority))
5445 (cond
5446 ((eq action 'set)
5447 (message "Priority A-%c, SPC to remove: " org-lowest-priority)
5448 (setq new (read-char-exclusive))
5449 (cond ((equal new ?\ ) (setq remove t))
5450 ((or (< (upcase new) ?A) (> (upcase new) org-lowest-priority))
5451 (error "Priority must be between `%c' and `%c'"
5452 ?A org-lowest-priority))))
5453 ((eq action 'up)
5454 (setq new (1- current)))
5455 ((eq action 'down)
5456 (setq new (1+ current)))
5457 (t (error "Invalid action")))
5458 (setq new (min (max ?A (upcase new)) org-lowest-priority))
5459 (setq news (format "%c" new))
5460 (if have
5461 (if remove
5462 (replace-match "" t t nil 1)
5463 (replace-match news t t nil 2))
5464 (if remove
5465 (error "No priority cookie found in line")
5466 (looking-at org-todo-line-regexp)
5467 (if (match-end 2)
5468 (progn
5469 (goto-char (match-end 2))
5470 (insert " [#" news "]"))
5471 (goto-char (match-beginning 3))
5472 (insert "[#" news "] ")))))
5473 (if remove
5474 (message "Priority removed")
5475 (message "Priority of current item set to %s" news))))
5478 (defun org-get-priority (s)
5479 "Find priority cookie and return priority."
5480 (save-match-data
5481 (if (not (string-match org-priority-regexp s))
5482 (* 1000 (- org-lowest-priority org-default-priority))
5483 (* 1000 (- org-lowest-priority
5484 (string-to-char (match-string 2 s)))))))
5486 ;;; Timestamps
5488 (defvar org-last-changed-timestamp nil)
5490 (defun org-time-stamp (arg)
5491 "Prompt for a date/time and insert a time stamp.
5492 If the user specifies a time like HH:MM, or if this command is called
5493 with a prefix argument, the time stamp will contain date and time.
5494 Otherwise, only the date will be included. All parts of a date not
5495 specified by the user will be filled in from the current date/time.
5496 So if you press just return without typing anything, the time stamp
5497 will represent the current date/time. If there is already a timestamp
5498 at the cursor, it will be modified."
5499 (interactive "P")
5500 (let ((fmt (if arg (cdr org-time-stamp-formats)
5501 (car org-time-stamp-formats)))
5502 (org-time-was-given nil)
5503 time)
5504 (cond
5505 ((and (org-at-timestamp-p)
5506 (eq last-command 'org-time-stamp)
5507 (eq this-command 'org-time-stamp))
5508 (insert "--")
5509 (setq time (let ((this-command this-command))
5510 (org-read-date arg 'totime)))
5511 (if org-time-was-given (setq fmt (cdr org-time-stamp-formats)))
5512 (insert (format-time-string fmt time)))
5513 ((org-at-timestamp-p)
5514 (setq time (let ((this-command this-command))
5515 (org-read-date arg 'totime)))
5516 (and (org-at-timestamp-p) (replace-match
5517 (setq org-last-changed-timestamp
5518 (format-time-string fmt time))
5519 t t))
5520 (message "Timestamp updated"))
5521 (t
5522 (setq time (let ((this-command this-command))
5523 (org-read-date arg 'totime)))
5524 (if org-time-was-given (setq fmt (cdr org-time-stamp-formats)))
5525 (insert (format-time-string fmt time))))))
5527 (defun org-time-stamp-inactive (&optional arg)
5528 "Insert an inactive time stamp.
5529 An inactive time stamp is enclosed in square brackets instead of angle
5530 brackets. It is inactive in the sense that it does not trigger agenda entries,
5531 does not link to the calendar and cannot be changed with the S-cursor keys.
5532 So these are more for recording a certain time/date."
5533 (interactive "P")
5534 (let ((fmt (if arg (cdr org-time-stamp-formats)
5535 (car org-time-stamp-formats)))
5536 (org-time-was-given nil)
5537 time)
5538 (setq time (org-read-date arg 'totime))
5539 (if org-time-was-given (setq fmt (cdr org-time-stamp-formats)))
5540 (setq fmt (concat "[" (substring fmt 1 -1) "]"))
5541 (insert (format-time-string fmt time))))
5543 (defvar org-date-ovl (org-make-overlay 1 1))
5544 (org-overlay-put org-date-ovl 'face 'org-warning)
5545 (org-detatch-overlay org-date-ovl)
5547 (defun org-read-date (&optional with-time to-time)
5548 "Read a date and make things smooth for the user.
5549 The prompt will suggest to enter an ISO date, but you can also enter anything
5550 which will at least partially be understood by `parse-time-string'.
5551 Unrecognized parts of the date will default to the current day, month, year,
5552 hour and minute. For example,
5553 3-2-5 --> 2003-02-05
5554 feb 15 --> currentyear-02-15
5555 sep 12 9 --> 2009-09-12
5556 12:45 --> today 12:45
5557 22 sept 0:34 --> currentyear-09-22 0:34
5558 12 --> currentyear-currentmonth-12
5559 Fri --> nearest Friday (today or later)
5560 etc.
5561 The function understands only English month and weekday abbreviations,
5562 but this can be configured with the variables `parse-time-months' and
5563 `parse-time-weekdays'.
5565 While prompting, a calendar is popped up - you can also select the
5566 date with the mouse (button 1). The calendar shows a period of three
5567 months. To scroll it to other months, use the keys `>' and `<'.
5568 If you don't like the calendar, turn it off with
5569 \(setq org-popup-calendar-for-date-prompt nil)
5571 With optional argument TO-TIME, the date will immediately be converted
5572 to an internal time.
5573 With an optional argument WITH-TIME, the prompt will suggest to also
5574 insert a time. Note that when WITH-TIME is not set, you can still
5575 enter a time, and this function will inform the calling routine about
5576 this change. The calling routine may then choose to change the format
5577 used to insert the time stamp into the buffer to include the time."
5578 (require 'parse-time)
5579 (let* ((org-time-stamp-rounding-minutes
5580 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
5581 (ct (org-current-time))
5582 (default-time
5583 ;; Default time is either today, or, when entering a range,
5584 ;; the range start.
5585 (if (save-excursion
5586 (re-search-backward
5588 (- (point) 20) t))
5589 (apply
5590 'encode-time
5591 (mapcar (lambda(x) (or x 0))
5592 (parse-time-string (match-string 1))))
5593 ct))
5594 (calendar-move-hook nil)
5595 (view-diary-entries-initially nil)
5596 (view-calendar-holidays-initially nil)
5597 (timestr (format-time-string
5598 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") default-time))
5599 (prompt (format "YYYY-MM-DD [%s]: " timestr))
5600 ans ans1 ans2
5601 second minute hour day month year tl wday wday1)
5603 (if org-popup-calendar-for-date-prompt
5604 (save-excursion
5605 (save-window-excursion
5606 (calendar)
5607 (calendar-forward-day (- (time-to-days default-time)
5608 (calendar-absolute-from-gregorian
5609 (calendar-current-date))))
5610 (org-eval-in-calendar nil)
5611 (let* ((old-map (current-local-map))
5612 (map (copy-keymap calendar-mode-map))
5613 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
5614 (define-key map (kbd "RET") 'org-calendar-select)
5615 (define-key map (if (featurep 'xemacs) [button1] [mouse-1])
5616 'org-calendar-select-mouse)
5650 ;; Naked prompt only
5664 t nil ans))))
5674 ;; Weekday was given, but no day, so pick that day in the week
5675 ;; on or after the derived date.
5690 "Eval FORM in the calendar window and return to current window.
5691 Also, store the cursor date in variable ans2."
5703 "Return to `org-read-date' with the date currently selected.
5704 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
5713 "Return to `org-read-date' with the date currently selected.
5714 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
5724 "Check if there are any deadlines due or past due.
5725 A deadline is considered due if it happens within `org-deadline-warning-days'
5726 days from today's date. If the deadline appears in an entry marked DONE,
5727 it is not shown. The prefix arg NDAYS can be used to test that many
5746 org-warn-days)))
5749 "Evaluate a time range by computing the difference between start and end.
5750 Normally the result is just printed in the echo area, but with prefix arg
5751 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
5752 If the time range is actually in a table, the result is inserted into the
5753 next column.
5754 For time difference computation, a year is assumed to be exactly 365
5755 days in order to avoid rounding problems."
5775 ;; (ys (floor (* 365 24 60 60)))
5783 y d h m align)
5786 y 0
5791 y 0
5827 "Parse the standard Org-mode time string.
5828 This should be a lot faster than the normal `parse-time-string'.
5829 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
5830 hour and minute fields will be nil if not given."
5840 nil nil nil)
5844 "Increase the date item at the cursor by one.
5845 If the cursor is on the year, change the year. If it is on the month or
5846 the day, change that.
5847 With prefix ARG, change by that many units."
5852 "Decrease the date item at the cursor by one.
5853 If the cursor is on the year, change the year. If it is on the month or
5854 the day, change that.
5855 With prefix ARG, change by that many units."
5860 "Increase the date in the time stamp by one day.
5861 With prefix ARG, change that many days."
5869 "Decrease the date in the time stamp by one day.
5870 With prefix ARG, change that many days."
5883 "Determine if the cursor is in or at a timestamp."
5903 ans))
5906 "Change the date in the time stamp at point.
5907 The date will be changed by N times WHAT. WHAT can be `day', `month',
5908 `year', `minute', `second'. If WHAT is not given, the cursor position
5909 in the timestamp determines what will be changed."
5911 org-ts-what
5913 ts time time0)
5953 ;; Try to recenter the calendar window, if any
5960 "If the calendar is visible, recenter it to DATE."
5971 "Go to the Emacs calendar at the current date.
5972 If there is a time stamp in the current line, go to that date.
5973 A prefix ARG can be used to force the current date."
5992 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
5993 If there is already a time stamp at the cursor position, update it."
5997 ;;; The clock for measuring work time.
6003 "Start the clock on the current item.
6004 If necessary, clock-out of the currently active clock."
6026 "Stop the currently running clock.
6027 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
6058 "Cancel the running clock be removing the start timestamp."
6073 "Sum the times for each subtree.
6074 Puts the resulting times in minutes as a text property on each headline."
6078 org-clock-string
6084 ts te dt
6085 time)
6091 ;; A time
6102 ;; A headline
6116 "Show subtree times in the entire buffer.
6117 If TOTAL-ONLY is non-nil, only show the total time for the entire file
6118 in the echo area."
6132 ;; Arrange to remove the overlays upon next change.
6141 "Put an overlays on the current line, displaying TIME.
6142 If LEVEL is given, prefix time with a corresponding number of stars.
6143 This creates a new overlay and stores it in `org-clock-overlays', so that it
6144 will be easy to remove."
6148 ov tx)
6164 "Remove the occur highlights from the buffer.
6165 BEG and END are ignored. If NOREMOVE is nil, remove this function
6166 from the `before-change-functions' in the current buffer."
6176 "Clock out if the current entry contains the running clock.
6177 This is used to stop the clock after a TODO entry is marked DONE."
6182 org-clock-marker))
6189 "Check if the current buffer contains the running clock.
6190 If yes, offer to stop it and to save the buffer with the changes."
6199 "Create a table containing a report about clocked time.
6200 If the buffer contains lines
6201 #+BEGIN: clocktable :maxlevel 3 :emphasize nil
6203 #+END: clocktable
6204 then the table will be inserted between these lines, replacing whatever
6205 is was there before. If these lines are not in the buffer, the table
6206 is inserted at point, surrounded by the special lines.
6207 The BEGIN line can contain parameters. Allowed are:
6208 :maxlevel The maximum level to be included in the table. Default is 3.
6209 :emphasize t/nil, if levell 1 and level 2 should be bold/italic in the table."
6218 "If this is a CLOCK line, update it and return t.
6219 Otherwise, return nil."
6228 ts te h m s)
6230 nil
6244 t)))))
6247 "Return two times bordering a special time range.
6248 Key is a symbol specifying the range and can be one of `today', `yesterday',
6249 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
6250 A week starts Monday 0:00 and ends Sunday 24:00.
6251 The range is determined relative to TIME. TIME defaults to the current time.
6252 The return value is a cons cell with two internal times like the ones
6253 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
6254 the returned times will be formatted strings."
6259 s1 m1 h1 d1 month1 y1 diff ts te fm)
6289 "Write the standard clocktable."
6293 ipos time h m p level hlc hdl maxlevel
6294 ts te cc block)
6313 "]."
6342 hlc
6344 hlc
6353 "Return an internal list with clocking information.
6354 This list has one entry for each CLOCK interval.
6355 FIXME: describe the elements."
6359 rtn beg end next cont level title total closedp leafp
6360 clockpos titlepos h m donep)
6385 total title titlepos level leafp)
6386 rtn)
6390 ;;; Agenda, and Diary Integration
6392 ;;; Define the mode
6406 "Mode for time-sorted view on action items in Org-mode files.
6408 The following commands are available:
6422 org-agenda-show-log nil))
6429 "Restricted to single file"
6516 "--"
6522 "--"
6530 "--"
6539 "--"
6540 ;; ["New agenda command" org-agenda t]
6543 "--"
6547 "--"
6552 "--"
6554 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
6559 "--"
6568 "--"
6571 ))
6578 ;;;###autoload
6580 "Dispatch agenda commands to collect entries to the agenda buffer.
6581 Prompts for a character to select a command. Any prefix arg will be passed
6582 on to the selected command. The default selections are:
6583 g
6584 a Call `org-agenda-list' to display the agenda for current day or week.
6585 t Call `org-todo-list' to display the global todo list.
6586 T Call `org-todo-list' to display the global todo list, select only
6587 entries with a specific TODO keyword (the user gets a prompt).
6588 m Call `org-tags-view' to display headlines with tags matching
6589 a condition (the user is prompted for the condition).
6590 M Like `m', but select only TODO entries, no ordinary headlines.
6591 l Create a timeeline for the current buffer.
6593 More commands can be added by configuring the variable
6594 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
6595 searches can be pre-defined in this way.
6597 If the current buffer is in Org-mode and visiting a file, you can also
6598 first press `1' to indicate that the agenda should be temporarily (until the
6606 c entry key type match lprops)
6607 ;; Turn off restriction
6612 ;; Remember where this call originated
6619 "Press key for an agenda command:
6620 --------------------------------
6621 a Agenda for current week or day
6622 t List of all TODO entries T Entries with special TODO kwd
6623 m Match a TAGS query M Like m, but only TODO entries
6628 key
6642 (org-add-props "1 Restrict call to current buffer 0 Restrict call to region or subtree" nil 'face 'org-table)))
6676 ;; For example the todo list should not need it (but does...)
6722 cmd type match lprops)
6745 "Make sure current buffer is in org-mode. Error if not."
6748 major-mode)))
6751 "Fit the window to the buffer size."
6758 "Get the list of agenda files.
6759 Optional UNRESTRICTED means return the full list even if a restriction
6760 is currently in place."
6770 "Edit the list of agenda files.
6771 Depending on setup, this either uses customize to edit the variable
6772 `org-agenda-files', or it visits the file that is holding the list. In the
6773 latter case, the buffer is set up in a way that saving it automatically kills
6774 the buffer and restores the previous window configuration."
6793 "Set new value for the agenda file list and save it correcly."
6804 "Read the list of agenda files from a file."
6816 "Return a new agenda marker.
6817 Org-mode keeps a list of these markers and resets them when they are
6818 no longer in use."
6822 m))
6825 "Reset markers created by `org-agenda'. But only if they are old enough."
6828 org-agenda-last-marker-time)
6837 "Get a buffer visiting FILE. If the buffer needs to be created, add
6838 it to the list of buffers which might be released later."
6841 buf ; just return it
6842 ;; Make a new buffer and remember it
6845 buf)))
6848 "Release all buffers in list, asking the user for confirmation when needed.
6849 When a buffer is unmodified, it is just killed. When modified, it is saved
6850 \(if the user agrees) and then killed."
6855 file
6861 "Show a time-sorted view of the entries in the current org file.
6862 Only entries with a time stamp of today or later will be listed. With
6864 under the current date.
6865 If the buffer contains an active region, only check the region for
6866 dates."
6882 t doclosed ; always include today
6883 org-timeline-show-empty-dates))
6886 args
6887 s e rtn d emptyp)
6893 ;; Remove past dates from the list of dates.
6896 day-numbers))))
6909 dopast
6910 past)
6918 entry date args)))
6945 ;;;###autoload
6947 "Produce a weekly view from all files in variable `org-agenda-files'.
6948 The view will be for the current week, but from the overview buffer you
6949 will be able to go to other weeks.
6951 also be shown, under the current date.
6953 on the days are also shown. See the variable `org-log-done' for how
6954 to turn on logging.
6955 START-DAY defaults to TODAY, or to the most recent match for the weekday
6956 given in `org-agenda-start-on-weekday'.
6957 NDAYS defaults to `org-agenda-ndays'."
6971 nil org-agenda-start-on-weekday))
6980 sd
6988 s e rtn rtnall file date d start-pos end-pos todayp nd)
6991 ;; Make the list of days
6993 nd ndays)
7004 rtnall nil)
7029 rtnall nil)
7035 file date
7038 file date
7060 rtnall nd todayp))
7082 ;;;###autoload
7084 "Show all TODO entries from all agenda file in a single list.
7085 The prefix arg can be used to select a specific TODO keyword and limit
7087 for a keyword. A numeric prefix directly selects the Nth keyword in
7088 `org-todo-keywords'."
7102 rtn rtnall files file pos)
7106 nil t)))
7114 rtnall nil)
7129 "Available with `N r': (0)ALL "
7146 "Make sure FILE exists. If not, ask user what to do."
7158 "Check if agenda buffer is of allowed type.
7159 If ERROR is non-nil, throw an error, otherwise just return nil."
7161 t
7164 nil)))
7167 "Exit agenda by removing the window or the buffer."
7175 "Exit agenda by removing the window or the buffer.
7176 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
7177 Org-mode buffers visited directly by the user will not be touched."
7183 ;; FIXME: move this function.
7185 "Save all Org-mode buffers without user confirmation."
7192 "Rebuild Agenda.
7193 When this is the global TODO list, a prefix argument will be interpreted."
7204 "Go to today."
7224 "Go forward in time by `org-agenda-ndays' days.
7225 With prefix ARG, go forward that many times `org-agenda-ndays'."
7231 nil t)))
7236 "Go back in time by `org-agenda-ndays' days.
7237 With prefix ARG, go back that many times `org-agenda-ndays'."
7243 nil t)))
7248 "Switch to weekly view for agenda."
7257 starting-day)
7258 nil t)))
7265 "Switch to daily view for agenda."
7274 starting-day)
7275 nil t)))
7282 "Jump to the next line indicating a date in agenda buffer."
7294 "Jump to the previous line indicating a date in agenda buffer."
7301 ;; Initialize the highlight
7306 "Highlight a region with overlay."
7311 "Detach overlay INDEX."
7316 "Toggle follow mode in an agenda buffer."
7324 "Toggle log mode in an agenda buffer."
7334 "Toggle diary inclusion in an agenda buffer."
7344 "Toggle time grid in an agenda buffer."
7354 "Set the mode name to indicate all the small mode settings."
7375 "Get the (Emacs Calendar) diary entries for DATE."
7382 entries
7392 ;; No entries
7394 ;; Omit the date and other unnecessary stuff
7396 ;; Add prefix to each line and extend the text properties
7408 ;; Extend the text properties to the beginning of the line
7410 entries)))))
7413 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
7414 This gets rid of the date, the underline under the date, and
7415 the dummy entry installed by `org-mode' to ensure non-empty diary for each
7416 date. It also removes lines that contain only whitespace."
7433 ;; Make sure entries from the diary have the right text properties.
7436 ;; We can rely on the hook, nothing to do
7437 nil
7438 ;; Hook not avaiable, must use advice to make this work
7440 "Make the position visible."
7443 buffer-file-name)
7447 "Add text properties to string, allowing org-mode to act on it."
7450 'keymap org-agenda-keymap
7453 'org-agenda-diary-link t
7457 "Add a dummy entry to the diary.
7458 Needed to avoid empty dates which mess up holiday display."
7459 ;; Catch the error if dealing with the new add-to-diary-alist
7467 "Cycle through the files in `org-agenda-files'.
7468 If the current buffer visits an agenda file, find the next one in the list.
7469 If the current buffer does not, find the first agenda file."
7474 file)
7485 "Move/add the current file to the end of the agenda file list.
7486 If the file is not present in the list, it is appended to the list. If it is
7487 present, it is moved there."
7492 "Move/add the current file to the top of the agenda file list.
7493 If the file is not present in the list, it is added to the front. If it is
7494 present, it is moved there. With optional argument TO-END, add/move to the
7495 end of the list."
7501 x had)
7514 "Remove current file from the list of files in variable `org-agenda-files'.
7515 These are the files which are being checked for agenda entries.
7516 Optional argument FILE means, use this file instead of the current."
7525 nil x))
7538 "Return a list of all relevant day numbers from BEG to END buffer positions.
7539 If NO-RANGES is non-nil, include only the start and end dates of a range,
7540 not every single day in the range. If FORCE-TODAY is non-nil, make
7541 sure that TODAY is included in the list. If INACTIVE is non-nil, also
7542 inactive time stamps (those in square brackets) are included.
7543 When EMPTY is non-nil, also include days without any entries."
7545 dates dates1 date day day1 day2 ts1 ts2)
7575 dates)))
7577 ;;;###autoload
7579 "Return diary information from org-files.
7581 It accesses org files and extracts information from those files to be
7582 listed in the diary. The function accepts arguments specifying what
7583 items should be listed. The following arguments are allowed:
7585 :timestamp List the headlines of items containing a date stamp or
7586 date range matching the selected date. Deadlines will
7587 also be listed, on the expiration day.
7589 :deadline List any deadlines past due, or due within
7590 `org-deadline-warning-days'. The listing occurs only
7591 in the diary for *today*, not at any other date. If
7592 an entry is marked DONE, it is no longer listed.
7594 :scheduled List all items which are scheduled for the given date.
7595 The diary for *today* also contains items which were
7596 scheduled earlier and are not yet marked DONE.
7598 :todo List all TODO items from the org-file. This may be a
7599 long list - so this is not turned on by default.
7600 Like deadlines, these entries only show up in the
7601 diary for *today*, not at any other date.
7603 The call in the diary file should look like this:
7605 &%%(org-diary) ~/path/to/some/orgfile.org
7607 Use a separate line for each org file to check. Or, if you omit the file name,
7608 all files listed in `org-agenda-files' will be checked automatically:
7610 &%%(org-diary)
7612 If you don't give any arguments (as in the example above), the default
7613 arguments (:deadline :scheduled :timestamp) are used. So the example above may
7614 also be written as
7616 &%%(org-diary :deadline :timestamp :scheduled)
7618 The function expects the lisp variables `entry' and `date' to be provided
7619 by the caller, because this is how the calendar works. Don't use this
7620 function from a program - use `org-agenda-get-day-entries' instead."
7628 file rtn results)
7629 ;; If this is called during org-agenda, don't return any entries to
7630 ;; the calendar. Org Agenda will list these entries itself.
7639 "Get the table of categories and positions in current buffer."
7645 tbl))
7647 "Get the category applying to position POS."
7663 org-category-table))))))
7666 "Does the work for `org-diary' and `org-agenda'.
7667 FILE is the path to a file to be checked for entries. DATE is date like
7668 the one returned by `calendar-current-date'. ARGS are symbols indicating
7669 which kind of entries should be extracted. For details about these, see
7670 the documentation of `org-diary'."
7678 arg results rtn)
7680 ;; If file does not exist, make sure an error message ends up in diary
7691 org-agenda-restrict-end)
7693 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
7715 results))))
7718 "Is the current entry marked DONE?"
7724 "Is the cursor inside a date range?"
7739 nil)))
7742 "Return the TODO information for agenda display."
7745 'org-not-done-regexp org-not-done-regexp
7747 'keymap org-agenda-keymap
7748 'help-echo
7755 org-not-done-regexp)
7758 marker priority category tags
7759 ee txt)
7765 ;; FIXME: the following test also happens below, but we need it here
7774 priority
7794 "Return the date stamp information for agenda display."
7796 'org-not-done-regexp org-not-done-regexp
7798 'keymap org-agenda-keymap
7799 'help-echo
7809 marker hdmarker deadlinep scheduledp donep tmp priority category
7810 ee txt timestr tags)
7820 org-ds-keyword-length))
7827 ;; substring should only run to end of time stamp
7861 "Return the logged TODO entries for agenda display."
7863 'org-not-done-regexp org-not-done-regexp
7864 'keymap org-agenda-keymap
7865 'help-echo
7877 marker hdmarker priority category tags closedp
7878 ee txt timestr)
7887 ;; donep (org-entry-is-done-p)
7888 )
7890 ;; substring should only run to end of time stamp
7913 "Return the deadline information for agenda display."
7916 'org-not-done-regexp org-not-done-regexp
7917 'keymap org-agenda-keymap
7918 'help-echo
7924 d2 diff pos pos1 category tags
7925 ee txt head face)
7934 ;; When to show a deadline in the calendar:
7935 ;; If the expiration is within wdays warning time.
7936 ;; Past-due deadlines are only shown on the current date
7962 'category category
7965 ee))
7968 "Return the scheduled information for agenda display."
7970 'org-not-done-regexp org-not-done-regexp
7974 'keymap org-agenda-keymap
7975 'help-echo
7981 d2 diff pos pos1 category tags
7982 ee txt head)
7991 ;; When to show a scheduled item in the calendar:
7992 ;; If it is on or past the date.
8008 category tags))))
8017 ee))
8020 "Return the date-range information for agenda display."
8022 'org-not-done-regexp org-not-done-regexp
8024 'keymap org-agenda-keymap
8025 'help-echo
8030 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos)
8042 ;; Only allow days between the limits, because the normal
8043 ;; date stamps will catch the limits.
8064 ; (outline-next-heading))) ;FIXME: correct to be removed??????
8065 ;; Sort the entries by expiration date.
8076 "Regular expression to match a plain time or time range.
8077 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
8078 groups carry important information:
8079 0 the full match
8080 1 the first time, range or not
8089 "Regular expression to match a timestamp time or time range.
8090 After a match, the following groups carry important information:
8091 0 the full match
8092 1 date plus weekday, for backreferencing to make sure both times on same day
8093 2 the first time, range or not
8097 "A flag, set by `org-compile-prefix-format'.
8100 "A flag, set by `org-compile-prefix-format'.
8104 noprefix)
8105 "Format TXT to be inserted into the agenda buffer.
8106 In particular, it adds the prefix and corresponding text properties. EXTRA
8107 must be a string and replaces the `%s' specifier in the prefix format.
8108 CATEGORY (string, symbol or nil) may be used to overrule the default
8109 category taken from local variable or file name. It will replace the `%c'
8110 specifier in the format. DOTIME, when non-nil, indicates that a
8111 time-of-day should be extracted from TXT for sorting of this entry, and for
8112 the `%t' specifier in the format. When DOTIME is a string, this string is
8113 searched for a time before TXT is. NOPREFIX is a flag and indicates that
8114 only the correctly processes TXT should be returned - this is used by
8115 `org-agenda-change-all-lines'. TAGS can be the tags of the headline."
8117 ;; Diary entries sometimes have extra whitespace at the beginning
8120 org-category
8126 time ;; needed for the eval of the prefix format
8129 stamp plain s0 s1 s2 rtn)
8131 ;; Extract starting and ending time and move them to prefix
8138 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
8139 ;; them, we might want to remove them there to avoid duplication.
8140 ;; The user can turn this off with a variable.
8145 t))
8147 ;; Normalize the time(s) to 24 hour
8152 ;; Tags are in the string
8155 org-prefix-has-tag))
8160 t t txt))))
8162 ;; Create the final string
8165 ;; Prepare the variables needed in the eval of the compiled format
8171 ;; Evaluate the compiled format
8174 ;; And finally add the text properties
8178 'time-of-day time-of-day
8193 list)))
8198 new time)
8200 ;; don't show empty grid
8206 nil string "" nil
8208 new)
8216 "Compile the prefix format into a Lisp form that can be evaluated.
8217 The resulting form is returned and stored in the variable
8218 `org-prefix-format-compiled'."
8222 org-agenda-prefix-format)
8227 varform vars var e c f opt)
8229 s start)
8242 ""
8252 ;; the old format
8260 "Check string S for a time of day.
8261 If found, return it as a military time number between 0 and 2400.
8262 If not found, return nil.
8263 The optional STRING argument forces conversion into a 5 character wide string
8264 HH:MM."
8289 "Sort and concatenate the agenda items."
8292 list
8310 x)))
8313 "Compare the priorities of string A and B."
8321 "Compare the string values of categories of strings A and B."
8329 "Compare the string values of categories of strings A and B."
8339 "Compare the time-of-day values of strings A and B."
8348 "Predicate for sorting agenda entries."
8349 ;; The following variables will be used when the form is evaluated.
8364 "Show the priority of the current item.
8365 This priority is composed of the main priority given with the [#A] cookies,
8366 and by additional input from the age of a schedules or deadline entry."
8372 "Show the tags applicable to the current item."
8381 "Go to the Org-mode file which contains the item at point."
8398 "Go to the Org-mode file which contains the item at point."
8415 "Go to the Org-mode file which contains the item at the mouse click."
8421 "Display the Org-mode file which contains the item at point."
8428 "Display the Org-mode file which contains the item at point and recenter."
8436 "Display the Org-mode file which contains the item at the mouse click."
8442 "Check if the entry is a diary link and abort if yes."
8450 "Marker pointing to the headline that last changed its TODO state
8454 "Cycle TODO state of line at point, also in Org-mode file.
8455 This changes the line at point, all other lines in the agenda referring to
8456 the same tree node, and the headline of the tree node in the Org-mode file."
8466 newhead)
8486 "Change all lines in the agenda buffer which match HDMARKER.
8487 The new content of the line will be NEWHEAD (as modified by
8488 `org-format-agenda-item'). HDMARKER is checked with
8489 `equal' against all `org-hd-marker' text properties in the file.
8490 If FIXFACE is non-nil, the face of each item is modified acording to
8491 the new TODO state."
8493 ; (setq newhead (org-format-agenda-item "x" newhead "x" nil 'noprefix))
8520 undone-face done-face)))
8528 "Align all tags in agenda items to `org-agenda-align-tags-to-column'."
8542 "Increase the priority of line at point, also in Org-mode file."
8547 "Decrease the priority of line at point, also in Org-mode file."
8552 "Set the priority of line at point, also in Org-mode file.
8553 This changes the line at point, all other lines in the agenda referring to
8554 the same tree node, and the headline of the tree node in the Org-mode file."
8563 newhead)
8578 "Get a list of all headline tags applicable at POS.
8579 POS defaults to point. If tags are inherited, the list contains
8580 the targets in the same sequence as the headlines appear, i.e.
8581 the tags of the current headline come last."
8593 tags)))
8597 tags))
8600 "Set tags for the current headline."
8609 newhead)
8624 "Change the date of this item to one day later."
8641 "Change the date of this item to one day earlier."
8646 "Change the date of this item. Date is prompted for, with default today.
8647 The prefix ARG is passed to the `org-time-stamp' command and can therefore
8648 be used to request time specification in the time stamp."
8665 "Schedule the item at point."
8674 ts)
8682 "Schedule the item at point."
8691 ts)
8699 "Return the heading of the current entry, without the stars."
8708 "Start the clock on the currently selected item."
8720 "Make a diary entry, like the `i' command from the calendar.
8721 All the standard commands work: block, weekly etc."
8745 ;; We implement this by hacking the `calendar-cursor-to-date' function
8746 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
8762 "Execute a calendar command from the agenda, with the date associated to
8763 the cursor position."
8785 "Display the phases of the moon for the 3 months around the cursor date."
8790 "Display the holidays for the 3 months around the cursor date."
8795 "Display sunrise and sunset for the cursor date.
8796 Latitude and longitude can be specified with the variables
8797 `calendar-latitude' and `calendar-longitude'. When called with prefix
8798 argument, latitude and longitude will be prompted for."
8807 "Open the Emacs calendar with the date at the cursor."
8820 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
8821 This is a command that has to be installed in `calendar-mode-map'."
8825 nil t))
8831 date s)
8855 ;;; Tags
8858 "Scan headline tags with inheritance and produce output ACTION.
8859 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
8860 evaluated, testing if a given set of tags qualifies a headline for
8861 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
8862 are included in the output."
8870 'undone-face nil
8872 'org-not-done-regexp org-not-done-regexp
8873 'keymap org-agenda-keymap
8874 'help-echo
8877 lspos
8879 todo marker)
8892 ;; remove tag lists from same and sublevels
8897 ;; add the nex tags
8900 tags-alist
8902 ;; compile tags for current headline
8906 tags))
8911 ;; list this headline
8916 ""
8921 category tags-list))
8927 ;; if we are to skip sublevels, jump to end of subtree
8936 "Create a sparse tree according to tags search string MATCH.
8937 MATCH can contain positive and negative selection of tags, like
8945 "Create the TAGS matcher form for the tags-selecting string MATCH."
8947 ;; Get a new match request, with completion
8950 org-last-tags-completion-table))
8954 ;; parse the string and create a lisp form
8967 orlist)
8970 ;; Return the string and lisp forms of the matcher
8973 ;;;###autoload
8975 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
8976 The prefix arg TODO-ONLY limits the search to TODO entries."
8985 rtn rtnall files file pos matcher
8986 buffer)
8994 rtnall nil)
9002 ;; If file does not exist, merror message to agenda
9014 org-agenda-restrict-end)
9039 "Set the tags for the current headline.
9040 With prefix ARG, realign all tags in headings in the current buffer."
9045 table current-tags inherited-tags ; computed below when needed
9046 tags hd empty invis)
9056 org-last-tags-completion-table table
9061 tags
9094 org-tags-column
9096 t)
9111 ;; try completion
9118 )
9120 ;; all-completions
9122 )
9124 ;; exact match?
9126 ))
9129 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
9135 "Fast tag selection with single keys.
9136 CURRENT is the current list of tags in the headline, INHERITED is the
9137 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
9138 possibly with grouping information.
9139 If the keys are nil, a-z are automatically assigned.
9140 Returns the new tags string, or nil to not change the current settings."
9144 table)))
9149 tg cnt e c char c1 c2 ntable tbl rtn
9150 groups ingroup)
9174 ;; automatically assign a character.
9224 g)))
9226 ;; Create a sorted list
9246 nil))))
9249 "Get the TAGS string in the current headline."
9259 "Get a table of all tags used in the buffer, for completion."
9268 ;;; Link Stuff
9271 "List of functions to construct the right search string for a file link.
9272 These functions are called in turn with point at the location to
9273 which the link should point.
9275 A function in the hook should first test if it would like to
9276 handle this file type, for example by checking the major-mode or
9277 the file extension. If it decides not to handle this file, it
9278 should just return nil to give other functions a chance. If it
9279 does handle the file, it must return the search string to be used
9280 when following the link. The search string will be part of the
9281 file link, given after a double colon, and `org-open-at-point'
9282 will automatically search for it. If special measures must be
9283 taken to make the search successful, another function should be
9284 added to the companion hook `org-execute-file-search-functions',
9285 which see.
9287 A function in this hook may also use `setq' to set the variable
9288 `description' to provide a suggestion for the descriptive text to
9289 be used for this link when it gets inserted into an Org-mode
9293 "List of functions to execute a file search triggered by a link.
9295 Functions added to this hook must accept a single argument, the
9296 search string that was part of the file link, the part after the
9297 double colon. The function must first check if it would like to
9298 handle this search, for example by checking the major-mode or the
9299 file extension. If it decides not to handle this search, it
9300 should just return nil to give other functions a chance. If it
9301 does handle the search, it must return a non-nil value to keep
9302 other functions from trying.
9304 Each function can access the current prefix argument through the
9305 variable `current-prefix-argument'. Note that a single prefix is
9306 used to force opening a link in Emacs, so it may be good to only
9307 use a numeric or double prefix to guide the search function.
9309 In case this is needed, a function in this hook can also restore
9310 the window configuration before `org-open-at-point' was called using:
9315 "Open file link or URL at mouse."
9321 "Open file link or URL at mouse."
9327 "The window configuration before following a link.
9331 "Open link at or after point.
9332 If there is no link at point, this function will search forward up to
9333 the end of the current subtree.
9334 Normally, files will be opened by an appropriate application. If the
9335 optional argument IN-EMACS is non-nil, Emacs will visit the file."
9358 path link))
9400 ;; Remove any trailing spaces in path
9433 path
9470 ;; in-emacs is the prefix arg, will be interpreted as read-only
9527 "Search for a link search option.
9528 When S is a CamelCaseWord, search for a target, or for a sentence containing
9529 the words. If S is surrounded by forward slashes, it is interpreted as a
9530 regular expression. In org-mode files, this will create an `org-occur'
9531 sparse tree. In ordinary files, `occur' will be used to list matches.
9532 If the current buffer is in `dired-mode', grep will be used to search
9533 in all files."
9538 words re0 re1 re2 re3 re4 re5 re2a reall camel)
9540 ;; First check if there are any special
9542 ;; Now try the builtin stuff
9549 ;; There is an exact target for this
9552 ;; A regular expression
9556 ;;((eq major-mode 'dired-mode)
9557 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9560 t)
9561 ;; A camel or a normal search string
9563 ;; Anchor on headlines, post may include tags.
9570 ;; Make a series of regular expressions to find a match
9588 ))
9600 )
9605 ;; Normal string-search
9613 "Execute `re-search-forward', but only accept matches that are not a link."
9628 "Call the Emacs command `occur'.
9629 If CLEANUP is non-nil, remove the printout of the regular expression
9630 in the *Occur* buffer. This is useful if the regex is long and not useful
9631 to read."
9650 ;; Fill and close the ring
9655 org-mark-ring)
9658 "Put the current position or POS into the mark ring and rotate it."
9670 "Jump to the previous position in the mark ring.
9671 With prefix arg N, jump back that many stored positions. When
9672 called several times in succession, walk through the entire ring.
9673 Org-mode commands jumping to a different position in the current file,
9674 or to another Org-mode file, automatically push the old position
9675 onto the ring."
9690 words)
9699 s)
9703 s)
9706 "Follow a BBDB link to NAME."
9711 ;; Exact match on name
9714 ;; Exact match on name
9717 ;; Partial match on name
9720 ;; Partial match on company
9723 ;; General match including network address and notes
9731 "Follow an info file & node link to NAME."
9742 "Follow a Gnus link to GROUP and ARTICLE."
9756 "Follow a VM link to FOLDER and ARTICLE."
9760 ;; ange-ftp or efs or tramp access
9766 ;; use tramp to access the file
9771 ;; use ange-ftp or efs
9791 "Follow a Wanderlust link to FOLDER and ARTICLE."
9798 "Follow an RMAIL link to FOLDER and ARTICLE."
9811 nil t)
9817 message-number)
9820 ;; mh-e integration based on planner-mode
9822 "Return the name of the current message real folder, so if you use
9823 sequences, it will now work."
9827 mh-current-folder
9828 ;; Refer to the show buffer
9829 mh-show-folder-buffer))
9833 )
9834 ;; a simple test on mh-index-data does not work, because
9835 ;; mh-index-data is always nil in a show buffer.
9844 )
9845 ))
9847 )
9848 folder
9849 )
9850 )))
9853 "Returns the name of the message folder in a index folder buffer."
9860 "Return the name of the current message folder. Be careful if you
9861 use sequences."
9864 mh-current-folder
9865 ;; Refer to the show buffer
9866 mh-show-folder-buffer)))
9869 "Return the number of the current message. Be careful if you
9870 use sequences."
9874 ;; Refer to the show buffer
9878 "Return a header of the message in folder mode. This will create a
9879 show buffer for the corresponding message. If you have a more clever
9880 idea..."
9895 header-field)))
9898 "Follow an MHE link to FOLDER and ARTICLE.
9899 If ARTICLE is nil FOLDER is shown. If the configuration variable
9900 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
9901 ARTICLE is searched in all folders. Indexed searches (swish++,
9902 namazu, and others supported by MH-E) will always search in all
9903 folders."
9925 ;; BibTeX links
9927 ;; Use the custom search meachnism to construct and use search strings for
9928 ;; file links to BibTeX database entries.
9931 "Create the search string and description for a BibTeX database entry."
9933 ;; yes, we want to construct this search string.
9934 ;; Make a good description for this entry, using names, year and the title
9935 ;; Put it into the `description' variable which is dynamically scoped.
9949 ;; Now parse the entry, get the key and return it.
9955 "Find the link search string S as a key for a database entry."
9957 ;; Yes, we want to do the search in this file.
9958 ;; We construct a regexp that searches for "@entrytype{" followed by the key
9964 ;; Use double prefix to indicate that any web link should be browsed
9966 ;; Restore the window configuration because we just use the web link
9971 ;; return t to indicate that the search is done.
9972 t))
9974 ;; Finally add the functions to the right hooks.
9978 ;; end of Bibtex link setup
9981 "Transfer old <...> style links to new [[...]] style links.
9982 With arg query-description, ask at each match for a description text to use
9983 for this link."
10003 "Open the file at PATH.
10004 First, this expands any special file name abbreviations. Then the
10005 configuration variable `org-file-apps' is checked if it contains an
10006 entry for this file type, and if yes, the corresponding command is launched.
10007 If no application is found, Emacs simply visits the file.
10008 With optional argument IN-EMACS, Emacs will visit the file.
10009 Optional LINE specifies a line to go to, optional SEARCH a string to
10010 search for. If LINE or SEARCH is given, the file will always be
10011 opened in Emacs.
10012 If the file does not exist, an error is thrown."
10015 buffer-file-name
10016 path))
10024 ext cmd)
10049 ;; Normalize use of quote, this can vary.
10057 ; (unless (equal (file-truename file) (file-truename (or buffer-file-name "")))
10058 ; (funcall (cdr (assq 'file org-link-frame-setup)) file))
10071 "Return the default applications for this operating system."
10074 org-file-apps-defaults-macosx)
10076 org-file-apps-defaults-windowsnt)
10080 "Replace special path abbreviations and expand the file name."
10084 "Test whether FILE specifies a location on a remote system.
10085 Return non-nil if the location is indeed remote.
10095 t)
10104 ;;;###autoload
10107 This link can later be inserted into an org-buffer with
10109 For some link types, a prefix arg is interpreted:
10110 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
10111 For file links, arg negates `org-context-in-file-links'."
10118 "bbdb:"
10137 nil nil nil))))))
10153 folder)
10201 "http://groups.google.com/groups?group="
10203 group)
10245 ;; Just link to current headline
10248 ;; Add a context search string
10250 ;; Check if we are on a target
10275 ;; Just link to this file here.
10278 ;; Add a context string
10283 ;; Only use search option if there is some text.
10311 "Make search string for STRING or current headline."
10315 ;; We are using a headline, clean up garbage in there.
10332 "Make a CamelCase string for STRING or the current headline."
10336 ;; We are using a headline, clean up garbage in there.
10353 "Concatenate STRINGS, format resulting string with `org-link-format'."
10357 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10360 link
10363 ;; Remove brackets from the description, they are fatal.
10367 ;; No description needed, it is identical
10380 "Escape charaters in TEXT that are problematic for links."
10388 t t text)))
10389 text)))
10392 "Reverse the action of `org-link-escape'."
10400 t t text)))
10401 text)))
10404 "Exclusive or."
10408 "Find a header field in the current buffer."
10428 s)))
10432 "Replace special characters in a message id, so it can be used in an http query."
10439 s)
10442 "Insert a link. At the prompt, enter the link.
10444 Completion can be used to select a link previously stored with
10445 `org-store-link'. When the empty string is entered (i.e. if you just
10446 press RET at the prompt), the link defaults to the most recently
10447 stored link. As SPC triggers completion in the minibuffer, you need to
10448 use M-SPC or C-q SPC to force the insertion of a space character.
10450 You will also be prompted for a description, and if one is given, it will
10451 be displayed in the buffer instead of the link.
10453 If there is already a link at point, this command will allow you to edit link
10454 and description parts.
10457 selected using completion. The path to the file will be relative to
10458 the current directory if the file is in the current directory or a
10459 subdirectory. Otherwise, the link will be the absolute path as
10460 completed in the minibuffer (i.e. normally ~/path/to/file).
10463 is in the current directory or below.
10465 `org-keep-stored-link-after-insertion'."
10475 ;; We do have a link at point, and we are going to edit it.
10482 ;; Completing read for file names.
10490 "file:"
10500 ;; Read link, with completion for stored links.
10502 "Link: " org-stored-links nil nil nil
10503 org-insert-link-history
10509 org-stored-links)))
10514 ;; URL-like link, normalize the use of angular brackets.
10517 ;; Check if we are linking to the current file with a search option
10518 ;; If yes, simplify the link by using only the search option.
10525 ;; We are linking to this same file, with a search option
10528 ;; Check if we can/should use a relative path. If yes, simplify the link
10545 ;; We are linking a file with relative path name.
10561 ;;; Hooks for remember.el
10565 ;;;###autoload
10567 "Return a link to the current location as an annotation for remember.el.
10568 If you are using Org-mode files as target for data storage with
10569 remember.el, then the annotations should include a link compatible with the
10570 conventions in Org-mode. This function returns such a link."
10574 "Select a destination location for the note.
10575 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
10576 RET at beg-of-buf -> Append to file as level 2 headline
10577 RET on headline -> Store as sublevel entry to current headline
10580 ;;;###autoload
10582 "Initialize *remember* buffer with template, invoke `org-mode'.
10583 This function should be placed into `remember-mode-hook' and in fact requires
10584 to be run from that hook to fucntion properly."
10603 )
10616 t t))
10629 ;;;###autoload
10631 "Store stuff from remember.el into an org file.
10632 First prompts for an org file. If the user just presses return, the value
10633 of `org-default-notes-file' is used.
10634 Then the command offers the headings tree of the selected file in order to
10635 file the text at a specific location.
10636 You can either immediately press RET to get the note appended to the
10637 file, or you can use vertical cursor motion and visibility cycling (TAB) to
10638 find a better place. Then press RET or <left> or <right> in insert the note.
10640 Key Cursor position Note gets inserted
10641 -----------------------------------------------------------------------------
10642 RET buffer-start as level 2 heading at end of file
10643 RET on headline as sublevel of the heading at cursor
10644 RET no heading at cursor position, level taken from context.
10645 Or use prefix arg to specify level manually.
10646 <left> on headline as same level, before current heading
10647 <right> on headline as same level, after current heading
10649 So the fastest way to store the note is to press RET RET to append it to
10650 the default file. This way your current train of thought is not
10651 interrupted, in accordance with the principles of remember.el. But with
10652 little extra effort, you can push it directly to the correct location.
10654 Before being stored away, the function ensures that the text has a
10656 is constructed from the current date and some additional data.
10658 If the variable `org-adapt-indentation' is non-nil, the entire text is
10659 also indented so that it starts in the same column as the headline
10660 \(i.e. after the stars).
10662 See also the variable `org-reverse-note-order'."
10671 spos level indent reversed)
10672 ;; Modify text so that it becomes a nice subtree which can be inserted
10673 ;; into an org tree.
10675 first)
10676 ;; remove empty lines at the beginning
10681 ;; Is already a headline
10683 ;; We need to add a headline: Use time and first buffer line
10692 ;; Find the file
10703 ;; Ask the User for a location
10706 org-remember-help)))
10708 ; not handle this note
10711 ;; Put it at the start or end, as level 2
10718 ;; Put it below this entry, at the beg/end of the subtree
10728 ;; Put it right there, with automatic level determined by
10729 ;; org-paste-subtree or from prefix arg
10737 "Read a filename, with default directory `org-directory'."
10741 default)))
10744 "Check if the current file should receive notes in reversed order."
10751 entry)
10755 nil)))))
10757 ;;; Tables
10759 ;; Watch out: Here we are talking about two different kind of tables.
10760 ;; Most of the code is for the tables created with the Org-mode table editor.
10761 ;; Sometimes, we talk about tables created and edited with the table.el
10762 ;; Emacs package. We call the former org-type tables, and the latter
10763 ;; table.el-type tables.
10767 "Every change indicates that a table might need an update."
10787 "Searching from within a table (any type) this finds the first line
10790 "Searching from within a table (any type) this finds the first line
10794 "Use the table.el package to insert a new table.
10795 If there is already a table at point, convert between Org-mode tables
10796 and table.el tables."
10809 "Convert region to table, or create an empty table.
10810 If there is an active region, convert it to a table. If there is no such
10811 region, create an empty table."
10818 "Query for a size and insert a table skeleton.
10838 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
10842 ;; Insert a hline after the first row.
10850 "Convert region to a table.
10851 The region goes from BEG0 to END0, but these borders will be moved
10852 slightly, to make sure a beginning of line in the first line is included.
10853 When NSPACE is non-nil, it indicates the minimum number of spaces that
10854 separate columns (default: just one space)."
10859 re)
10866 ;; Lets see if this is tab-separated material. If every nonempty line
10867 ;; contains a tab, we will assume that it is tab-separated material
10885 "Import FILE as a table.
10886 The file is assumed to be tab-separated. Such files can be produced by most
10887 spreadsheet and database applications. If no tabs (at least one per line)
10888 are found, lines will be split on whitespace into fields."
10897 "Export table as a tab-separated file.
10898 Such a file can be imported into a spreadsheet program like Excel."
10904 buf)
10933 "Marker at the beginning of the table last aligned.
10936 "Marker at the end of the table last aligned.
10939 "List of flags for flushright alignment, from the last re-alignment.
10942 "List of max width of fields in each column.
10950 "Align the table at point by aligning all vertical bars."
10953 ;; Limits of table
10956 ;; Current cursor position
10961 column
10963 rfmt hfmt
10971 emptystrings links narrow fmax f1 len c e)
10974 ;; Check if we have links
10977 ;; Make sure the link properties are right
10979 ;; Check if we are narrowing any columns
10983 ;; Get the rows
10986 ;; Store the indentation of the first line
10989 ;; Mark the hlines by setting the corresponding element to nil
10990 ;; At the same time, we remove trailing space.
10993 nil
10996 l)))
10997 lines))
10998 ;; Get the data fields by splitting the lines.
11003 ;; How many fields in the longest line?
11010 ;; A list of empty string to fill any short rows on output
11012 ;; Check for special formatting.
11016 ;; Check if there is an explicit width specified
11023 ;; Find fields that are wider than fmax, and shorten them
11029 'help-echo
11030 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
11038 xx)))))
11039 ;; Get the maximum width for each column
11041 ;; Get the fraction of numbers, to decide about alignment of the column
11045 nil
11052 ;; Store the alignment of this table, for later editing of single fields
11054 org-table-last-column-widths lengths)
11056 ;; With invisible characters, `format' does not get the field width right
11057 ;; So we need to make these fields wide by hand.
11068 ;; Compute the formats needed for output of the table
11081 hfmt))
11083 ;; Replace the old one
11092 ;; Try to move to the old location (approximately)
11097 ))
11100 "Compute width of string, ignoring invisible characters.
11101 This ignores character with invisibility property `org-link', and also
11102 characters with property `org-cwidth', because these will become invisible
11103 upon the next fontification round."
11119 "Find the beginning of the table and return its position.
11120 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
11124 org-table-border-regexp)
11125 nil t))
11132 "Find the end of the table and return its position.
11133 With argument TABLE-TYPE, go to the end of a table.el-type table."
11137 org-table-border-regexp)
11138 nil t))
11144 "Justify the current field, text to left, number to right.
11145 Optional argument NEW may specify text to replace the current field content."
11154 ;; This is not the same table, force a full re-align
11160 l f n o e)
11183 "Go to the next field in the current table, creating new lines as needed.
11184 Before doing so, re-align the table if necessary."
11189 org-table-may-need-update)
11200 org-table-tab-jumps-over-hlines
11212 "Go to the previous field in the table.
11213 Before doing so, re-align the table if necessary."
11218 org-table-may-need-update)
11230 "Go to the next row (same column) in the current table.
11231 Before doing so, re-align the table if necessary."
11239 org-table-may-need-update)
11253 "Copy a field down in the current column.
11254 If the field at the cursor is empty, copy into it the content of the nearest
11255 non-empty field above. With argument N, use the Nth non-empty field.
11256 If the current field is not empty, it is copied down to the next row, and
11257 the cursor is moved with it. Therefore, repeating this command causes the
11258 column to be filled row-by-row.
11259 If the variable `org-table-copy-increment' is non-nil and the field is an
11260 integer, it will be incremented while copying."
11266 txt)
11278 beg t))
11295 "Is point inside a table data field?
11296 I.e. not on a hline or before the first or after the last column?
11297 This actually throws an error, so it aborts the current command."
11308 "Blank the current table field or active region."
11325 "Return the value of the field in column N of current row.
11326 N defaults to current field.
11327 If REPLACE is a string, replace field with this value. The return value
11328 is always the old value."
11338 val)
11342 "Find out which column we are in.
11343 When called interactively, column is also displayed in echo area."
11352 cnt)))
11355 "Move the cursor to the Nth column in the current table line.
11356 With optional argument ON-DELIM, stop with point before the left delimiter
11357 of the field.
11358 If there are less than N fields, just go to after the last delimiter.
11359 However, when FORCE is non-nil, create new columns if necessary."
11370 ; (backward-char 2) t)))))
11378 "Return t if the cursor is inside an org-type table.
11379 If TABLE-TYPE is non-nil, also check for table.el-type tables."
11384 org-table-line-regexp)))
11385 nil))
11388 "Return t if and only if we are at a table.el table."
11395 "If there is a table.el table nearby, recognize it and move into it."
11401 nil
11411 t
11416 t)
11417 nil)
11418 nil))
11421 "Return t if the cursor is inside a hline in a table."
11426 nil))
11429 "Insert a new column into the table."
11437 ;; Current cursor position
11443 nil
11454 "Find a dataline in the current table, which is needed for column commands."
11457 t
11468 t
11473 "Delete a column from the table."
11482 ;; Current cursor position
11488 nil
11500 "Move column to the right."
11504 "Move column to the left."
11509 "Move the current column to the right. With arg LEFT, move to the left."
11519 ;; Current cursor position
11529 nil
11541 "Move table row down."
11545 "Move table row up."
11550 "Move the current table line down. With arg UP, move it up."
11555 txt)
11572 "Insert a new row above the current line into the table.
11573 With prefix ARG, insert below the current line."
11579 ;; Fix the first field if necessary
11589 "Insert a horizontal-line below the current line into the table.
11590 With prefix ARG, insert above the current line."
11609 In particular, this does handle wide and invisible characters."
11611 ;; It's a hline, just map the characters
11617 t t s)))
11618 s))
11621 "Delete the current row or horizontal line from the table."
11631 "Sort table lines in region.
11632 Point and mark define the first and last line to include. Both point and
11633 mark should be in the column that is used for sorting. For example, to
11634 sort according to column 3, put the mark in the first line to sort, in
11635 table column 3. Put point into the last line to be included in the sorting,
11636 also in table column 3. The command will prompt for the sorting method
11637 \(n for numerical, a for alphanumeric)."
11665 lns)))
11675 "Copy region in table to the clipboard and blank all relevant fields."
11680 "Copy rectangular region in table to clipboard.
11681 A special clipboard is used which can only be accessed
11682 with `org-table-paste-rectangle'."
11685 region cols
11711 org-table-clip))
11714 "Paste a rectangular region into a table.
11715 The upper right corner ends up in the current field. All involved fields
11716 will be overwritten. If the rectangle does not fit into the present table,
11717 the table is enlarged as needed. The process ignores horizontal separator
11718 lines."
11728 c cols field)
11744 "Convert from `org-mode' table to table.el and back.
11745 Obviously, this only works within limits. When an Org-mode table is
11746 converted to table.el, all horizontal separator lines get lost, because
11747 table.el uses these as cell boundaries and has no notion of horizontal lines.
11748 A table.el table can be converted to an Org-mode table only if it does not
11749 do row or column spanning. Multiline cells will become multiple cells.
11750 Beware, Org-mode does not test if the table can be successfully converted - it
11751 blindly applies a recipe that works for simple tables."
11755 ;; convert to Org-mode table
11764 ;; convert to table.el table
11767 ;; first, get rid of all horizontal lines
11771 ;; insert a hline before first
11775 ;; insert a hline after each line
11780 ;; replace "+" at beginning and ending of hlines
11789 "Wrap several fields in a column like a paragraph.
11790 This is useful if you'd like to spread the contents of a field over several
11791 lines, in order to keep the table compact.
11793 If there is an active region, and both point and mark are in the same column,
11794 the text in the column is wrapped to minimum width for the given number of
11795 lines. Generally, this makes the table more compact. A prefix ARG may be
11797 formats the selected text to two lines. If the region was longer than two
11798 lines, the remaining lines remain empty. A negative prefix argument reduces
11799 the current number of lines by that amount. The wrapped text is pasted back
11800 into the table. If you formatted it to more lines than it was before, fields
11801 further down in the table get overwritten - so you might need to make space in
11802 the table first.
11804 If there is no region, the current field is split at the cursor position and
11805 the text fragment to the right of the cursor is prepended to the field one
11806 line down.
11808 If there is no region, but you specify a prefix ARG, the current field gets
11809 blank, and the content is appended to the field above."
11813 ;; There is a region: fill as a paragraph
11815 nlines)
11822 arg)
11826 nil nlines)))
11829 ;; No region, split the current field at point
11831 ;; combine with field above
11841 ;; split field
11853 "Edit table field in a different window.
11854 This is mainly useful for fields that contain hidden parts.
11856 it can be edited in place."
11862 display t intangible t))
11868 p)
11877 intangible t))
11886 "Finish editing a table data field.
11887 Remove all newline characters, insert the result into the table, realign
11888 the table and kill the editing buffer."
11892 text)
11909 "Remove whitespace at beginning and end of string."
11912 s)
11915 "Wrap string to either a number of lines, or a width in characters.
11916 If WIDTH is non-nil, the string is wrapped to that width, however many lines
11917 that costs. If there is a word longer than WIDTH, the text is actually
11918 wrapped to the length of that word.
11919 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
11920 many lines, whatever width that takes.
11921 The return value is a list of lines, without newlines at the end."
11924 w ll)
11931 ll
11936 ll))
11941 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
11951 "Splits STRING into substrings at SEPARATORS.
11952 No empty strings are returned if there are matches at the beginning
11953 and end of string."
11956 notfirst
11970 list)))
11975 list)))
11979 "Apply FUNCTION to the start of all tables in the buffer."
11993 "Sum numbers in region of current table column.
11994 The result will be displayed in the echo area, and will be available
11997 If there is an active region, it is interpreted as a rectangle and all
11998 numbers in that rectangle will be summed. If there is no active
11999 region and point is located in a table column, sum all numbers in that
12000 column.
12002 If at least one number looks like a time HH:MM or HH:MM:SS, all other
12003 numbers are assumed to be times as well (in decimal hours) and the
12004 numbers are added as such.
12006 If NLAST is a number, only the NLAST fields will actually be summed."
12020 ;not needed? (skip-chars-backward "^|")
12026 ;not needed? (skip-chars-forward "^|")
12035 items1)))
12042 s diff)
12050 sres))))
12073 "Get a calc vector from a column, accorting to descriptor DESC.
12074 Optional arguments TBEG and COL can give the beginning of the table and
12075 the current column, to avoid unnecessary parsing."
12140 "Read a formula from the minibuffer, offer stored formula as default."
12143 org-table-named-field-locations)))
12156 stored)
12158 equation)
12162 ;stored
12163 ))))
12164 mustsave)
12166 ;; remove formula
12173 ;; We set the column equation, delete the named one.
12175 mustsave t))
12181 eq))
12184 "Store the list of formulas below the current table."
12197 "Return an alist with the stored formulas directly after current table."
12215 "Modify the formulas stored below the current table.
12216 ACTION can be `remove', `insert', `swap'. For `swap', two column numbers are
12217 expected, for the other actions only a single column number is needed."
12222 col col1 col2 scol si sc1 sc2)
12245 ;; Hopefully, ZqZtZ will never be a name in a table
12267 "Get the column names and local parameters for this table."
12270 names name fields fields1 field cnt c v line col)
12272 org-table-local-parameters nil
12273 org-table-named-field-locations nil)
12291 org-table-local-parameters))))
12309 ;; Get the current word
12317 If yes, store the formula and apply it."
12318 ;; We already know we are in a table. Get field will only return a formula
12319 ;; when appropriate. It might return a separator line, but no problem.
12322 named eq)
12330 "List of commands triggering the recalculation of a line.
12343 "Rotate the recalculation mark in the first column.
12344 If in any row, the first field is not consistent with a mark,
12345 insert a new column for the markers.
12346 When there is an active region, change all the lines in the region,
12347 after prompting for the marking character.
12348 After each change, a message will be displayed indicating the meaning
12349 of the new mark."
12364 epos new)
12371 newchar))
12403 "Recompute the current line if marked for it, and if we haven't just done it."
12414 "Non-nil means, debug table formulas.
12428 modes)
12431 suppress-align suppress-const
12432 suppress-store)
12433 "Replace the table field value at the cursor by the result of a calculation.
12435 This function makes use of Dave Gillespie's Calc package, in my view the
12436 most exciting program ever written for GNU Emacs. So you need to have Calc
12437 installed in order to use this function.
12439 In a table, this command replaces the value in the current field with the
12441 formula, by storing it in a special line below the table. When called
12442 with a `C-u' prefix, the current field must ba a named field, and the
12443 formula is installed as valid in only this specific field.
12445 When called, the command first prompts for a formula, which is read in
12446 the minibuffer. Previously entered formulas are available through the
12447 history list, and the last used formula is offered as a default.
12448 These stored formulas are adapted correctly when moving, inserting, or
12449 deleting columns with the corresponding commands.
12451 The formula can be any algebraic expression understood by the Calc package.
12452 For details, see the Org-mode manual.
12454 This function can also be called from Lisp programs and offers
12455 additional arguments: EQUATION can be the formula to apply. If this
12456 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
12457 used to speed-up recursive calls by by-passing unnecessary aligns.
12458 SUPPRESS-CONST suppresses the interpretation of constants in the
12459 formula, assuming that this has been done already outside the function.
12460 SUPPRESS-STORE means the formula should not be stored, either because
12461 it is already stored, or because it is a modified equation that should
12462 not overwrite the stored one."
12473 equation
12477 n form fmt x ev orig c lispp)
12478 ;; Parse the format string. Since we have a lot of modes, this is
12479 ;; a lot of work. However, I think calc still uses most of the time.
12491 'calc-float-format
12494 n))))
12511 fields)))
12515 ;; Insert the references to fields in same row
12519 n0)
12526 t t form)))
12527 ;; Insert ranges in current column
12532 nil n0))
12533 t t form)))
12543 Orig: %s
12544 $xyz-> %s
12571 "Recalculate the current table line by applying all stored formulas.
12572 With prefix arg ALL, do this for all lines in the table."
12585 ;; Insert constants in all formulas
12589 x)
12590 eqlist))
12591 ;; Split the equation list
12602 ;; This is a table with marked lines, only compute selected lines
12604 ;; Move forward to the first non-header line
12616 ;; Unprotected line, recalculate
12629 ;; Now do the names fields
12638 ;; back to initial position
12645 "Replace $const with values in string F."
12647 ;; First, check for column names
12652 ;; Expand ranges to vectors
12663 ;; Parameters and constants
12672 f))
12675 "Find the value for a parameter or constant in a formula.
12676 Parameters get priority."
12690 "Edit the formulas of the current table in a separate buffer."
12698 entry loc s)
12706 # Use `C-u C-c C-c' to also appy them immediately to the entire table.
12707 # Use `C-c ?' to get information about $name at point.
12724 "Show the location/value of the $ expression at point."
12751 ;; column number
12783 "Parse the buffer for formula definitions and install them.
12784 With prefix ARG, apply the new formulas to the table."
12803 "Abort editing formulas, without installing the changes."
12811 ;;; The orgtbl minor mode
12813 ;; Define a minor mode which can be used in other modes in order to
12814 ;; integrate the org-mode table editor.
12816 ;; This is really a hack, because the org-mode table editor uses several
12817 ;; keys which normally belong to the major mode, for example the TAB and
12818 ;; RET keys. Here is how it works: The minor mode defines all the keys
12819 ;; necessary to operate the table editor, but wraps the commands into a
12820 ;; function which tests if the cursor is currently inside a table. If that
12821 ;; is the case, the table editor command is executed. However, when any of
12822 ;; those keys is used outside a table, the function uses `key-binding' to
12823 ;; look up if the key has an associated command in another currently active
12824 ;; keymap (minor modes, major mode, global), and executes that command.
12825 ;; There might be problems if any of the keys used by the table editor is
12826 ;; otherwise used as a prefix key.
12828 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
12829 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
12830 ;; addresses this by checking explicitly for both bindings.
12832 ;; The optimized version (see variable `orgtbl-optimized') takes over
12833 ;; all keys which are bound to `self-insert-command' in the *global map*.
12834 ;; Some modes bind other commands to simple characters, for example
12835 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
12836 ;; active, this binding is ignored inside tables and replaced with a
12837 ;; modified self-insert.
12840 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
12847 ;;;###autoload
12849 "Unconditionally turn on `orgtbl-mode'."
12852 ;;;###autoload
12854 "The `org-mode' table editor as a minor mode for use in other modes."
12857 ;; Exit without error, in case some hook functions calls this
12858 ;; by accident in org-mode.
12865 ;; Make sure we are first in minor-mode-map-alist
12873 auto-fill-inhibit-regexp)
12889 "Remove all properties related to narrow-column invisibility."
12901 ;; Install it as a minor mode.
12907 "Create a function for binding in the table minor mode.
12908 FUN is the command to call inside a table. N is used to create a unique
12909 command name. KEYS are keys that should be checked in for a command
12910 to execute outside of tables."
12916 "Outside of tables, run the binding of `"
12928 keys)
12932 "Error when there is no default binding for a table key."
12937 "Setup orgtbl keymaps."
12953 ; '([(shift tab)] org-table-previous-field)
12968 elt key fun cmd)
12975 ;; Special treatment needed for TAB and RET
12989 ;; If the user wants maximum table support, we need to hijack
12990 ;; some standard editing functions
13002 "--"
13007 "--"
13013 "--"
13014 ["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])
13021 "--"
13028 "--"
13030 ["Set Named Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
13034 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
13041 ))
13042 t)
13045 "Justification and field motion for `orgtbl-mode'."
13052 "Justification and field motion for `orgtbl-mode'."
13058 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
13059 If the cursor is in a table looking at whitespace, the whitespace is
13060 overwritten, and the table is not marked as requiring realignment."
13067 orgtbl-hijacker-command-101
13068 orgtbl-hijacker-command-102
13069 orgtbl-hijacker-command-103
13070 orgtbl-hijacker-command-104
13071 orgtbl-hijacker-command-105))
13073 t)
13086 "Needed to enforce self-insert under remapping."
13090 ;;; Exporting
13131 "Return the property list with default settings for the export variables."
13135 rtn))
13138 "Return the property list with file-local settings for export."
13143 p key val text options)
13168 o)
13172 options)
13176 p)))
13179 "Create a single property list from all plists in PLISTS.
13180 The process starts by copying the last list, and then setting properties
13181 from the other lists. Settings in the first list are the most significant
13182 ones and overrule settings in the other lists."
13184 p v ls)
13190 rtn))
13196 val)))
13197 dir))
13200 "Remove all lines from LIST which are before the first headline."
13212 rtn line level)
13217 ;; Beginning of a COMMENT subtree. Skip it.
13223 ;; an ordinary comment line
13224 )
13230 ;; a special table line that should be removed
13231 )
13238 \[v] limit export to visible part of outline tree
13240 \[a] export as ASCII
13241 \[h] export as HTML
13242 \[b] export as HTML and browse immediately
13243 \[x] export as XOXO
13245 \[i] export current file as iCalendar file
13246 \[I] export all agenda files as iCalendar files
13247 \[c] export agenda files into combined iCalendar file
13249 \[F] publish current file
13250 \[P] publish current project
13251 \[X] publish... (project will be prompted for)
13267 r1 r2 ass)
13279 ;; ASCII
13570 )
13571 "Entities for TeX->HTML translation.
13575 The list contains HTML entities for Latin-1, Greek and other symbols.
13576 It is supplemented by a number of commonly used TeX macros with appropriate
13580 "Cleanup a buffer substring so that links can be created safely."
13587 rtn)
13594 ;; Get rid of archived trees
13605 ;; Find targets in comments and move them out of comments,
13606 ;; but mark them as targets that should be invisible
13611 ;; Find matches for radio targets and turn them into internal links
13617 ;; Find all links that contain a newline and put them into a single line
13619 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
13623 ;; Convert LaTeX fragments to images
13628 org-current-export-file)))
13632 ;; Normalize links: Convert angle and plain links into bracket links
13638 t t))
13644 t t))
13646 ;; Find multiline emphasis and put them into single line
13653 ;; Remove comments
13659 rtn))
13662 "Take link text and make a safe target out of it."
13666 'identity
13672 "Convert an org-mode file with all levels allowed to one with odd levels.
13673 This will leave level 1 alone, convert level 2 to level 3, level 3 to
13674 level 5 etc."
13688 "Convert an org-mode file with only odd levels to one with odd and even levels.
13689 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
13690 section with an even level, conversion would destroy the structure of the file. An error
13691 is signaled in this case."
13694 ;; First check if there are no even levels
13709 "Make N odd if required."
13716 "Export the outline as a pretty ASCII file.
13717 If there is an active region, export only the region.
13718 The prefix ARG specifies how many levels of the outline should become
13719 underlined headlines. The default is 3."
13770 ;; create local variables for all options, to make sure all called
13771 ;; functions get the correct information
13775 org-export-plist-vars)
13778 org-export-headline-levels))
13780 ;; File header
13799 line)
13800 ;; This is a headline
13805 todo
13809 org-done-string)))
13810 ; TODO, not DONE
13814 line lines level))))
13826 ))))
13827 lines)))
13831 ;; Remove the quoted HTML tags.
13833 ;; Remove targets
13836 ;; Replace internal links
13840 t nil line)))
13843 ;; a Headline
13851 ;; remove display and invisible chars
13867 "Search the subtree below LINE for any TODO entries."
13870 line lv todo)
13878 org-done-string))))
13879 ; TODO, not DONE
13884 "Handle quoted HTML for ASCII export."
13887 ;; We just remove the tags for now.
13889 line)
13892 "Insert the string S centered and underline it with character UNDERLINE."
13901 "Insert a new level in ASCII export."
13907 org-export-ascii-bullets))
13909 ;; find the indentation of the next non-empty line
13927 "Create a copy of the visible part of the current buffer, and export it.
13928 The copy is created in a temporary buffer and removed after use.
13929 TYPE is the final key (as a string) that also select the export command in
13930 the `C-c C-e' export dispatcher.
13931 As a special case, if the you type SPC at the prompt, the temporary
13932 org-mode file will not be removed but presented to you so that you can
13933 continue to use it. The prefix arg ARG is passed through to the exporting
13934 command."
13939 current-prefix-arg))
13952 s e)
13962 ;; Copy all comment lines to the end, to make sure #+ settings are
13963 ;; still available for the second export step. Kind of a hack, but
13964 ;; does do the trick.
13985 s))
13990 s))
13992 ;; HTML
13995 "Return a string with current options as keyword options.
13996 Does include HTML export options as well as TODO and CATEGORY stuff."
13998 "#+TITLE: %s
13999 #+AUTHOR: %s
14000 #+EMAIL: %s
14001 #+LANGUAGE: %s
14002 #+TEXT: Some descriptive text to be emitted. Several lines OK.
14004 #+CATEGORY: %s
14005 #+SEQ_TODO: %s
14006 #+TYP_TODO: %s
14007 #+STARTUP: %s %s %s %s %s %s
14008 #+TAGS: %s
14009 #+ARCHIVE: %s
14010 "
14012 org-export-headline-levels
14013 org-export-with-section-numbers
14014 org-export-with-toc
14015 org-export-preserve-breaks
14016 org-export-html-expand
14017 org-export-with-fixed-width
14018 org-export-with-tables
14019 org-export-with-sub-superscripts
14020 org-export-with-emphasize
14021 org-export-with-TeX-macros
14022 org-export-with-LaTeX-fragments
14044 org-archive-location
14045 ))
14048 "Insert into the buffer a template with information for exporting."
14057 "Toggle the fixed-width export.
14058 If there is no active region, the QUOTE keyword at the current headline is
14059 inserted or removed. When present, it causes the text between this headline
14060 and the next to be exported as fixed-width text, and unmodified.
14061 If there is an active region, this command adds or removes a colon as the
14062 first character of this line. If the first character of a line is a colon,
14063 this line is also exported in fixed-width font."
14071 off)
14101 "Export the outline as HTML and immediately open it with a browser.
14102 If there is an active region, export only the region.
14103 The prefix ARG specifies how many levels of the outline should become
14104 headlines. The default is 3. Lower levels will become bulleted lists."
14110 "Call `org-export-as-html', may be used in batch processing as
14111 emacs --batch
14112 --load=$HOME/lib/emacs/org.el
14114 --visit=MyFile --funcall org-export-as-html-batch"
14118 "Export the outline as a pretty HTML file.
14119 If there is an active region, export only the region.
14120 The prefix ARG specifies how many levels of the outline should become
14121 headlines. The default is 3. Lower levels will become bulleted lists.
14122 When HIDDEN is non-nil, don't display the HTML buffer.
14123 EXT-PLIST is a property list with external parameters overriding
14124 org-mode's default settings, but still inferior to file-local settings."
14131 ext-plist
14136 valid
14143 ;; The following two are dynamically scoped into other
14144 ;; routines below.
14150 region :emph-multiline
14187 buffer-file-coding-system))
14193 table-open type
14194 table-buffer table-orig-buffer
14195 ind start-is-num starter
14196 rpl path desc descp desc1 desc2 link
14197 )
14203 ;; Get the language-dependent settings
14207 ;; Switch to the output buffer
14215 ;; create local variables for all options, to make sure all called
14216 ;; functions get the correct information
14220 org-export-plist-vars)
14222 org-export-headline-levels))
14224 ;; File header
14230 <head>
14231 <title>%s</title>
14236 %s
14237 </head><body>
14238 "
14240 date time author style))
14253 org-export-html-toplevel-hlevel
14255 org-export-html-toplevel-hlevel))
14260 ;; This is a headline
14268 todo
14272 org-done-string)))
14273 ; TODO, not DONE
14277 line lines level))))
14296 ;; Check for targets
14301 t t line))
14304 target-alist))
14312 head-count txt))
14315 )))
14316 line)
14317 lines))
14321 ))
14328 ;; end of quote section?
14332 ;; inside a quote section?
14337 ;; verbatim lines
14352 ;; make targets to anchors
14360 t t line)))
14364 ; (concat "@<i>" (match-string 1 line) "@</i> ")
14365 t t line)))
14371 t t line)))))
14375 ;; replace "&" by "&", "<" and ">" by "<" and ">"
14376 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
14377 ;; Also handle sub_superscripts and checkboxes
14380 ;; Format the links
14390 ;; FIXME: do we need to unescape here somewhere?
14399 ;; standard URL
14403 ;; FILE link
14406 thefile file-is-image-p search)
14414 t))
14424 ;; make sure this is can be used as target search
14448 ;; TODO items
14460 ;; This is a headline
14467 ;; Close any local lists before inserting a new header line
14473 in-local-list nil))
14476 head-count)
14477 ;; QUOTES
14485 ;; New table starts
14487 ;; Accumulate lines
14499 ;; Normal lines
14502 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
14503 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
14506 line)
14513 ;; empty line. Pretend indentation is large.
14527 ;; Start new (level of ) list
14534 ;; continue current list
14541 "<b>[X]</b>"
14543 t t line))))
14545 ;; Empty lines start a new paragraph. If hand-formatted lists
14546 ;; are not fully interpreted, lines starting with "-", "+", "*"
14547 ;; also start a new paragraph.
14550 ;; Check if the line break needs to be conserved
14559 ;; Properly close all local lists and other lists
14562 ;; Close any local lists before inserting a new header line
14568 in-local-list nil))
14571 head-count)
14591 ;; remove empty paragraphs and lists
14604 "Find out which HTML converter to use and return the HTML code."
14606 ;; A normal org table
14608 ;; Table made by table.el - test for spanning
14612 nil))
14613 lines)))
14619 hlines))))
14622 ;; We can use my own converter with HTML conversions
14624 ;; Need to use the code generator in table.el, with the original text.
14628 "Format a table into HTML."
14634 ;; Check if the table has a marking column. If yes remove the
14635 ;; column and the special lines
14643 lines)))))
14650 nil ; ignore this line
14654 lines))))))
14660 line fields html)
14667 ;; ignore this line
14669 ;; Break the line into fields
14672 html
14673 "<tr>"
14681 html))
14691 newstr))
14694 "Format a table generated by table.el into HTML.
14695 This conversion does *not* use `table-generate-source' from table.el.
14696 This has the advantage that Org-mode's HTML conversions can be used.
14697 But it has the disadvantage, that no cell- or row-spanning is allowed."
14700 fields html empty)
14710 html
14711 "<tr>"
14722 ;; Ignore this line
14724 ;; Break the line into fields and store the fields
14730 field-buffer))
14733 html))
14736 "Format a table into html, using `table-generate-source' from table.el.
14737 This has the advantage that cell- or row-spanning is allowed.
14738 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
14753 "Format time stamps in string S, or remove them."
14757 ;; FIXME: is it good to never export CLOCK, or do we need control?
14772 ;; Line break if line started and ended with time stamp stuff
14774 s
14778 r))))
14781 ;; convert & to &, < to < and > to >
14790 s)
14793 "Remove tags and time staps from lines going into the toc."
14799 s)
14802 "Prepare STRING for HTML export. Applies all active conversions.
14803 If there are links in the string, don't modify these."
14815 "Apply all active conversions to translate special ASCII to HTML."
14831 t t s))
14833 s)
14836 "Create a regular expression which will match a balanced sexp.
14837 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
14838 as single character strings.
14839 The regexp returned will match the entire expression including the
14840 delimiters. It will also define a single group which contains the
14841 match except for the outermost delimiters. The maximum depth of
14842 stacked delimiters is N. Escaping delimiters is not possible."
14864 "Convert sub- and superscripts in STRING to HTML."
14874 t t string)))
14877 string)
14880 "Apply emphasis."
14882 (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)))
14883 string)
14887 "Insert <p>, but first close previous paragraph if any."
14892 "Close paragraph if there is one open."
14897 "Close <li> if necessary."
14900 ; (when (save-excursion
14901 ; (re-search-backward "</?\\(ul\\|ol\\|li\\|[hH][0-9]\\)>" nil t))
14902 ; (if (member (match-string 0) '("</ul>" "</ol>" "<li>"))
14903 ; (insert "</li>"))))
14906 "Insert a new level in HTML export.
14907 When TITLE is nil, just close all open levels."
14917 ;; If title is nil, this means this function is called to close
14918 ;; all levels, so the rest is done only if title is given
14930 t t title)))
14945 level head-count title level))
14950 "Terminate one level in HTML export."
14954 ;; Variable holding the vector with section numbers
14958 "Initialize the vector for the section numbers."
14975 "Return a string with the current section number.
14976 When LEVEL is non-nil, increase section numbers on that level."
14998 string))
15001 ;;;###autoload
15003 "Export current file as an iCalendar file.
15004 The iCalendar file will be located in the same directory as the Org-mode
15005 file, but with extension `.ics'."
15015 "Export the org buffer as XOXO.
15016 The XOXO buffer is named *xoxo-<source buffer name>*"
15018 ;; A quickie abstraction
15020 ;; Output everything as XOXO
15033 ;; Check the output buffer is empty.
15035 ;; Kick off the output
15052 ;; Handle level rendering
15069 )
15073 ;; And output the new li
15079 ;; Finally finish off the ol
15085 ;; Finish the buffer off and clean it up.
15090 )))
15092 ;;;###autoload
15094 "Export all files in `org-agenda-files' to iCalendar .ics files.
15095 Each iCalendar file will be located in the same directory as the Org-mode
15096 file, but with extension `.ics'."
15100 ;;;###autoload
15102 "Export all files in `org-agenda-files' to a single combined iCalendar file.
15103 The file is stored under the name `org-combined-agenda-icalendar-file'."
15108 "Create iCalendar files for all elements of FILES.
15109 If COMBINE is non-nil, combine all calendar entries into a single large
15110 file and store it under the name `org-combined-agenda-icalendar-file'."
15114 org-export-publishing-directory)))
15115 file ical-file ical-buffer category started org-agenda-new-buffers)
15120 org-combined-agenda-icalendar-file
15153 "Hook run after an iCalendar file has been saved.
15154 The iCalendar buffer is still current when this hook is run.
15155 A good way to use this is to tell a desktop calenndar application to re-read
15159 "Print iCalendar entries for the current Org-mode file to `standard-output'.
15160 When COMBINE is non nil, add the category to each line."
15171 inc t
15180 pos)
15183 ;; donep (org-entry-is-done-p)
15184 ))
15193 %s
15194 %s
15195 SUMMARY:%s
15199 hd)))
15215 %s
15216 SUMMARY:%s
15217 SEQUENCE:1
15218 PRIORITY:%d
15220 dts hd pri))))))))
15223 "Start an iCalendar file by inserting the header."
15229 VERSION:2.0
15230 X-WR-CALNAME:%s
15231 PRODID:-//%s//Emacs with Org-mode//EN
15232 X-WR-TIMEZONE:%s
15236 "Finish an iCalendar file by inserting the END statement."
15240 "Take a time string S and convert it to iCalendar format.
15241 KEYWORD is added in front, to make a complete line like DTSTART....
15242 When INC is non-nil, increase the hour by two (if time string contains
15243 a time), or the day by one (if it does not contain a time)."
15245 t2 fmt have-time time)
15257 ;;; LaTeX stuff
15272 "Toggle the minor `org-cdlatex-mode'.
15273 This mode supports entering LaTeX environment and math in LaTeX fragments
15274 in Org-mode.
15276 nil " OCDL" nil
15281 "Always return t in org-mode buffers.
15282 This is because we want to insert math symbols without dollars even outside
15283 the LaTeX math segments. If Orgmode thinks that point is actually inside
15284 en embedded LaTeX fragement, let texmathp do its job.
15301 "Unconditionally turn on `org-cdlatex-mode'."
15305 "Test if point is inside a LaTeX fragment.
15307 sequence appearing also before point.
15308 Even though the matchers for math are configurable, this function assumes
15310 delimiters are skipped when they have been removed by customization.
15311 The return value is nil, or a cons cell with the delimiter and
15312 and the position of this delimiter.
15314 This function does a reasonably good job, but can locally be fooled by
15315 for example currency specifications. For example it will assume being in
15317 fragments that are properly closed, but during editing, we have to live
15318 with the uncertainty caused by missing closing delimiters. This function
15319 looks only before point, not after."
15338 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15342 ;; count $$
15350 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15351 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15352 - inside a LaTeX fragment, or
15353 - after the first word in a line, where an abbreviation expansion could
15354 insert a LaTeX environment."
15355 ;; FIXME: This may still need refinement.
15368 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15369 Revert to the normal definition outside of these fragments."
15377 "Execute `cdlatex-math-modify' in LaTeX fragments.
15378 Revert to the normal definition outside of these fragments."
15390 "Remove all overlays with LaTeX fragment images in current buffer."
15395 "Preview the LaTeX fragment at point, or all locally or globally.
15396 If the cursor is in a LaTeX fragment, create the image and overlay
15397 it over the source code. If there is no fragment at point, display
15398 all fragments in the current text, from one headline to the next. With
15399 prefix SUBTREE, display all fragments in the current subtree. With a
15400 double prefix `C-u C-u', or when the cursor is before the first headline,
15401 display all fragments in the buffer.
15430 buffer-file-name)))
15436 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15437 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
15438 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
15445 "Replace LaTeX fragments with links to an image, and produce images."
15454 m n block linkfile movefile ov)
15455 ;; Make sure the directory exists
15457 ;; Check if there are old images files with this prefix, and remove them
15459 todir 'full
15462 ;; Check the different regular expressions
15479 txt movefile opt)
15487 ov 'end-glyph
15490 ov 'display
15497 ;; This function borrows from Ganesh Swami's latex2png.el
15501 temporary-file-directory))
15505 ;(texfilebase (make-temp-file "orgtex"))
15506 ; (dummy (delete-file texfilebase))
15535 "-o" pngfile
15536 dvifile)
15539 ;; Use the requested file name and clean up
15543 pngfile))))
15545 ;;; Key bindings
15547 ;; - Bindings in Org-mode map are currently
15548 ;; 0123456789abcdefghijklmnopqrstuvwxyz!?@#$%^&-+*/=()_{}[]:;"|,.<>~`'\t the alphabet
15549 ;; abcd fgh j lmnopqrstuvwxyz!? #$ ^ -+*/= [] ; |,.<>~ '\t necessary bindings
15550 ;; e (?) useful from outline-mode
15551 ;; i k @ expendable from outline-mode
15552 ;; 0123456789 % & ()_{} " ` free
15554 ;; Make `C-c C-x' a prefix key
15557 ;; TAB key with modifiers
15563 ;; The following line is necessary under Suse GNU/Linux
15576 ;; Cursor keys with modifiers
15607 ;; All the other keys
15677 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
15678 If the cursor is in a table looking at whitespace, the whitespace is
15679 overwritten, and the table is not marked as requiring realignment."
15683 ;; check if we blank the field, and if that triggers align
15688 ;; got extra space, this field does not determine column width
15690 ;; no extra space, this field may determine column width
15692 t)
15704 "Like `delete-backward-char', insert whitespace at field end in tables.
15705 When deleting backwards, in tables this function will insert whitespace in
15707 still be marked for re-alignment if the field did fill the entire column,
15708 because, in this case the deletion might narrow the column."
15721 ;; noalign: if there were two spaces at the end, this field
15722 ;; does not determine the width of the column.
15727 "Like `delete-char', but insert whitespace at field end in tables.
15728 When deleting characters, in tables this function will insert whitespace in
15730 still be marked for re-alignment if the field did fill the entire column,
15731 because, in this case the deletion might narrow the column."
15745 ;; noalign: if there were two spaces at the end, this field
15746 ;; does not determine the width of the column.
15751 ;; How to do this: Measure non-white length of current string
15752 ;; If equal to column width, we should realign.
15755 "In MAP, remap the functions given in COMMANDS.
15756 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
15765 ;; If the user wants maximum table support, we need to hijack
15766 ;; some standard editing functions
15774 "Throw an error because Shift-Cursor command was applied in wrong context."
15778 "Global visibility cycling or move to previous table field.
15779 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
15780 on context.
15781 See the individual commands for more information."
15788 "Promote subtree or delete table column.
15789 Calls `org-promote-subtree' or `org-table-delete-column', depending on context.
15790 See the individual commands for more information."
15799 "Demote subtree or insert table column.
15800 Calls `org-demote-subtree' or `org-table-insert-column', depending on context.
15801 See the individual commands for more information."
15810 "Move subtree up or kill table row.
15811 Calls `org-move-subtree-up' or `org-table-kill-row' or
15812 `org-move-item-up' depending on context. See the individual commands
15813 for more information."
15821 "Move subtree down or insert table row.
15822 Calls `org-move-subtree-down' or `org-table-insert-row' or
15823 `org-move-item-down', depending on context. See the individual
15824 commands for more information."
15833 "Promote heading or move table column to left.
15834 Calls `org-do-promote' or `org-table-move-column', depending on context.
15835 With no specific context, calls the Emacs default `backward-word'.
15836 See the individual commands for more information."
15845 "Demote subtree or move table column to right.
15846 Calls `org-do-demote' or `org-table-move-column', depending on context.
15847 With no specific context, calls the Emacs default `forward-word'.
15848 See the individual commands for more information."
15857 "Move subtree up or move table row up.
15858 Calls `org-move-subtree-up' or `org-table-move-row' or
15859 `org-move-item-up', depending on context. See the individual commands
15860 for more information."
15869 "Move subtree down or move table row down.
15870 Calls `org-move-subtree-down' or `org-table-move-row' or
15871 `org-move-item-down', depending on context. See the individual
15872 commands for more information."
15881 "Increase item in timestamp or increase priority of current headline.
15882 Calls `org-timestamp-up' or `org-priority-up', depending on context.
15883 See the individual commands for more information."
15892 "Decrease item in timestamp or decrease priority of current headline.
15893 Calls `org-timestamp-down' or `org-priority-down', depending on context.
15894 See the individual commands for more information."
15902 "Next TODO keyword or timestamp one day later, depending on context."
15910 "Previous TODO keyword or timestamp one day earlier, depending on context."
15918 "Copy region in table or copy current subtree.
15919 Calls `org-table-copy' or `org-copy-subtree', depending on context.
15920 See the individual commands for more information."
15926 "Cut region in table or cut current subtree.
15927 Calls `org-table-copy' or `org-cut-subtree', depending on context.
15928 See the individual commands for more information."
15934 "Paste rectangular region into table, or past subtree relative to level.
15935 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
15936 See the individual commands for more information."
15943 "Set tags in headline, or update according to changed information at point.
15945 This command does many different things, depending on context:
15947 - If the cursor is in a headline, prompt for tags and insert them
15948 into the current line, aligned to `org-tags-column'. When called
15949 with prefix arg, realign all tags in the current buffer.
15951 - If the cursor is in one of the special #+KEYWORD lines, this
15952 triggers scanning the buffer for these lines and updating the
15953 information.
15955 - If the cursor is inside a table, realign the table. This command
15956 works even if the automatic table editor has been turned off.
15958 - If the cursor is on a #+TBLFM line, re-apply the formulas to
15959 the entire table.
15961 - If the cursor is inside a table created by the table.el package,
15962 activate that table.
15964 - If the current buffer is a remember buffer, close note and file it.
15965 with a prefix argument, file it without further interaction to the default
15966 location.
15968 - If the cursor is on a <<<target>>>, update radio targets and corresponding
15969 links in this buffer.
15971 - If the cursor is on a numbered item in a plain list, renumber the
15972 ordered list."
15977 org-latex-fragment-image-overlays)
16005 ;; Recalculate the table before this line
16016 "Restart Org-mode, to scan again for special lines.
16017 Also updates the keyword regular expressions."
16023 "Goto next table row or insert a newline.
16024 Calls `org-table-next-row' or `newline', depending on context.
16025 See the individual commands for more information."
16034 "Insert a new heading or wrap a region in a table.
16035 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
16036 See the individual commands for more information."
16043 ;;; Menu entries
16045 ;; Define the Org-mode menus
16052 "--"
16056 "--"
16062 "--"
16063 ["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])
16070 "--"
16077 "--"
16080 ["Set Named Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
16082 "--"
16084 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
16086 "--"
16093 "--"
16095 org-enable-table-editor)]
16099 "--"
16108 "--"
16116 "--"
16121 "--"
16125 "--"
16130 "--"
16147 "--"
16151 "--"
16160 "--"
16164 "--"
16183 "--"
16192 "--"
16196 org-done-string
16199 "--"
16207 "--"
16212 "--"
16220 "--"
16224 "--"
16236 "--"
16242 "--"
16245 "--"
16247 ))
16250 "Read documentation for Org-mode in the info system.
16251 With optional NODE, go directly to that node."
16274 ;;; Documentation
16277 "Call the customize function with org as argument."
16282 "Create a full customization menu for Org-mode, insert it into the menu."
16289 "--"
16299 ;;; Miscellaneous stuff
16302 "Return a list of contexts of the current cursor position.
16303 If several contexts apply, all are returned.
16304 Each context entry is a list with a symbol naming the context, and
16305 two positions indicating start and end of the context. Possible
16306 contexts are:
16308 :headline anywhere in a headline
16309 :headline-stars on the leading stars in a headline
16310 :todo-keyword on a TODO keyword (including DONE) in a headline
16311 :tags on the TAGS in a headline
16312 :priority on the priority cookie in a headline
16313 :item on the first line of a plain list item
16314 :item-bullet on the bullet/number of a plain list item
16315 :checkbox on the checkbox in a plain list item
16316 :table in an org-mode table
16317 :table-special on a special filed in a table
16318 :table-table in a table.el table
16319 :link on a hyperline
16320 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
16321 :target on a <<target>>
16322 :radio-target on a <<<radio-target>>>
16323 :latex-fragment on a LaTeX fragment
16324 :latex-preview on a LaTeX fragment with overlayed preview image
16326 This function expects the position to be visible because it uses font-lock
16327 faces as a help to recognize the following contexts: :table-special, :link,
16328 and :keyword."
16332 ;; First the large context
16351 clist)
16365 ;; Now the small context
16393 ;; FIXME: positions wring.
16397 clist))
16400 "Check if POINT is in match-group GROUP.
16401 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
16402 match. If the match group does ot exist or point is not inside it,
16403 return nil."
16409 t)))
16412 "Move the current line down. With prefix argument, move it past ARG lines."
16415 beg end pos)
16425 "Move the current line up. With prefix argument, move it past ARG lines."
16428 beg end pos)
16437 ;; Paragraph filling stuff.
16438 ;; We want this to be just right, so use the full arsenal.
16442 ;; In the paragraph separator we include headlines, because filling
16443 ;; text in a line directly attached to a headline would otherwise
16444 ;; fill the headline as well.
16447 ;; The paragraph starter includes hand-formatted lists.
16450 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
16451 ;; But only if the user has not turned off tables or fixed-width regions
16453 'auto-fill-inhibit-regexp
16462 ;; We use our own fill-paragraph function, to make sure that tables
16463 ;; and fixed-width regions are not wrapped. That function will pass
16464 ;; through to `fill-paragraph' when appropriate.
16466 ; Adaptive filling: To get full control, first make sure that
16467 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
16473 "Re-align a table, pass through to fill-paragraph if no table."
16481 ;; For reference, this is the default value of adaptive-fill-regexp
16482 ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
16485 "Return a fill prefix for org-mode files.
16486 In particular, this makes sure hanging paragraphs for hand-formatted lists
16487 work correctly."
16491 ;; Functions needed for Emacs/XEmacs region compatibility
16494 "Add-hook, compatible with both Emacsen."
16500 "Is `transient-mark-mode' on and the region active?
16501 Works on both Emacs and XEmacs."
16503 nil
16509 "Add elements to `buffer-invisibility-spec'.
16510 See documentation for `buffer-invisibility-spec' for the kind of elements
16511 that can be added."
16522 "Remove elements from `buffer-invisibility-spec'."
16530 "Is ARG a member of `buffer-invisibility-spec'?"
16533 nil))
16536 "Return regexp matching the file names of images."
16544 image-file-name-extensions)
16545 image-file-name-extensions)
16546 t)
16549 ;; Functions extending outline functionality
16551 ;; C-a should go to the beginning of a *visible* line, also in the
16552 ;; new outline.el. I guess this should be patched into Emacs?
16554 "Go to the beginning of the current line. If that is invisible, continue
16555 to a visible line beginning. This makes the function of C-a more intuitive."
16559 nil
16570 "Check if point is at a character currently not visible."
16571 ;; Early versions of noutline don't have `outline-invisible-p'.
16577 "Check if point is at a character currently not visible."
16580 ;; Early versions of noutline don't have `outline-invisible-p'.
16599 "Move to the heading line of which the present line is a subheading.
16600 This function considers both visible and invisible heading lines.
16601 With argument, move up ARG levels."
16607 "Show an entry where even the heading is hidden."
16612 "Flag the current heading. FLAG non-nil means make invisible.
16613 When ENTRY is non-nil, show the entire entry."
16616 ;; Check if we should show the entire entry
16625 flag))))
16628 ;; This is an exact copy of the original function, but it uses
16629 ;; `org-back-to-heading', to make it work also in invisible
16630 ;; trees. And is uses an invisible-OK argument.
16631 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
16641 ;; Go to end of line before heading
16644 ;; leave blank line before heading
16649 "Show everything after this heading at deeper levels."
16654 nil))
16657 "Show the body directly following this heading.
16658 Show the heading too, if it is currently invisible."
16667 nil)))
16670 "Make a regular expression for keyword lines."
16672 "^"
16678 ;; Make `bookmark-jump' show the jump location if it was hidden.
16681 ;; We can use the hook
16683 ;; Hook not available, use advice
16685 "Make the position visible."
16689 "Unhide the current position, to show the bookmark location."
16696 ;;; Experimental code
16699 ;(add-hook 'org-load-hook
16700 ; (lambda ()
16701 ; (defun outline-show-heading ()
16702 ; "Show the current heading and move to its end."
16703 ; (outline-flag-region
16704 ; (- (point)
16705 ; (cond
16706 ; ((bobp) 0)
16707 ; ((equal (buffer-substring
16708 ; (max (point-min) (- (point) 3)) (point))
16709 ; "\n\n\n")
16710 ; 2)
16711 ; (t 1)))
16712 ; (progn (outline-end-of-heading) (point))
16713 ; nil))))
16715 ;;; Finish up
16721 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
16722 ;;; org.el ends here